mutation

customerOnboard

Initiate the onboarding process for payment services, providing personal, business, and device information, along with marketplace details, to enable customer registration and credit availability.
Arguments
customerOnboardingRequestInput
CustomerOnboardingRequestInput
Customer Onboarding Request Schema.
Response
Required
Onboard Summary Schema.
success
Boolean!
Required
Status updated or not.
Mutation
1mutation customerOnboard(
2 $customerOnboardingRequestInput: CustomerOnboardingRequestInput
3) {
4 customerOnboard(
5 customerOnboardingRequestInput: $customerOnboardingRequestInput
6 ) {
7 data {
8 redirect_url
9 session
10 status
11 status_remark
12 is_eligible_for_txn
13 merchant_customer_ref_id
14 activation_url
15 }
16 success
17 }
18}
Try it
Input Variables
1{
2 "customerOnboardingRequestInput": {
3 "aggregator": "aggregator",
4 "business_info": {
5 "address": {
6 "addressline1": "addressline1",
7 "addressline2": "addressline2",
8 "city": "Montreal",
9 "land_mark": "land_mark",
10 "ownership_type": "ownership_type",
11 "pincode": "pincode",
12 "state": "Quebec"
13 },
14 "business_ownership_type": "business_ownership_type",
15 "business_type": "business_type",
16 "entity_type": "entity_type",
17 "fda": "fda",
18 "fssai": "fssai",
19 "gstin": "gstin",
20 "name": "A name",
21 "pan": "pan",
22 "shop_and_establishment": {},
23 "vintage": "vintage"
24 },
25 "device": {
26 "device_make": "device_make",
27 "device_model": "device_model",
28 "device_type": "device_type",
29 "identification_number": "identification_number",
30 "identifier_type": "identifier_type",
31 "os": "os",
32 "os_version": "os_version"
33 },
34 "marketplace_info": {
35 "date_of_joining": "date_of_joining",
36 "membership_id": "membership_id",
37 "name": "A name"
38 },
39 "mcc": "mcc",
40 "personal_info": {
41 "address_as_per_id": {
42 "addressline1": "addressline1",
43 "addressline2": "addressline2",
44 "city": "Montreal",
45 "land_mark": "land_mark",
46 "ownership_type": "ownership_type",
47 "pincode": "pincode",
48 "state": "Quebec"
49 },
50 "dob": "dob",
51 "driving_license": "driving_license",
52 "email": "test-email@yourcompany.com",
53 "email_verified": true,
54 "fathers_name": "fathers_name",
55 "first_name": "first_name",
56 "gender": "gender",
57 "last_name": "last_name",
58 "middle_name": "middle_name",
59 "mobile_verified": true,
60 "mothers_name": "mothers_name",
61 "pan": "pan",
62 "passport": "passport",
63 "phone": "1+ 418-323-4236",
64 "voter_id": "voter_id"
65 },
66 "source": "source"
67 }
68}
Response
1{
2 "customerOnboard": {
3 "data": {
4 "redirect_url": "redirect_url",
5 "session": {},
6 "status": true,
7 "status_remark": "status_remark",
8 "is_eligible_for_txn": true,
9 "merchant_customer_ref_id": "merchant_customer_ref_id",
10 "activation_url": "activation_url"
11 },
12 "success": true
13 }
14}