For the complete documentation index, see llms.txt. This page is also available as Markdown.
Onboarding
Onboarding refers to the process of bringing a new merchant or business onto a payment processing platform or network. It typically involves gathering information about the merchant such as Business name, Client type, Entity type, Address, Bank details and so on. With the help of onboarding , we can conclude whether the merchants are legitimate, financially stable, and pose an acceptable level of risk to the payment platform. Only the Mandatory fields are provided in the sample post parameters , Rest of the fields in the sample post parameters will be provided in the relevant menu ( KYC , Web Crawling , AML , NDI )
It should be unique. It helps to identify the new customer that comes from which client.
source_from
String
Yes
It can contain one of the following values: APP, DIRECT, WEBSITE, or RESELLER.
reseller_ref_id
String
Optional
If source_from is RESELLER, then reseller_ref_id is mandatory.
email
String
Yes
Customer's registered email address.
phone
String
Yes
Customer's mobile number.
entity_type
Object
Yes
Unique identifier representing the legal entity type of the business
kyc_checks
Object
Yes
Defines the level of KYC verification to be performed for the merchant. Supported values depend on the configured verification profiles such as simplified, standard, or exception.
mcc
Object
No
Contains the Merchant Category Code (MCC) details used to classify the merchant's business category
business.name
String
Yes
Official registered name of the business
business.trade_name
String
Yes
Commercial or trading name under which the merchant operates.
business.deliveryMode
String
Optional
Delivery mode for the business. Allowed values are:
• online
• offline
business.authorized
Array of Objects
Optional
List of authorized individuals associated with the business (e.g., signatories, directors, ).
business.authorized[].name
String
Optional
Full name of the authorized individual (Signatory/Director). Must be alphabetic and valid.
business.authorized[].authorizer_type
String
Optional
Type of authorization for the person. Must be one of the following:
• signatory – Individual authorized to sign documents
• director – Individual who serves as a director
• signatory_director – Individual who is both Signatory and Director
mandatory if the signatory/director name is provided.
business.authorized[].panNumber
String
Optional
PAN number of the authorized individual (Signatory/Director). Must be a valid 10-character alphanumeric value and is mandatory if the signatory/director name is provided.
business.authorized[].dateOfBirth
String
Optional
Date of birth of the authorized individual (Signatory/Director). Must be a valid date in DD-MM-YYYY format.
business.authorized[].fathersName
String
Optional
Father’s name of the authorized individual (Signatory/Director). Must contain valid alphabetic characters.
business.authorized[].address
String
Optional
Residential address of the authorized individual (Signatory/Director).
business.authorized[].kycType
Object
Optional
Must be selected from the supported document types:
Voter ID (ind_voter_id)
Aadhaar Card (ind_aadhaar)
Driving License (ind_driving_license)
Passport (ind_passport)
business.authorized[].kycNumber
String
Optional
Unique identification number from the selected KYC type
client_type
Object
Optional
contactPerson.name
String
Optional
Name of the contact person (CPV Name). Must be alphabetic, properly formatted, and not exceed 100 characters.
contactPerson.mobileNumber
String
Optional
Contact person's mobile number. Must be a valid mobile format as per system validation rules
