Onboard Merchant
The following endpoints help you manage the merchant onboarding process, from creating a merchant application to submitting it for review and approval.
The following steps help to onboard a merchant:
Create merchant profile
Submit a request to the Create Merchant Application endpoint using your assigned portfolio MID. This MID is a unique 16-digit identifier provided during integration setup and represents your merchant portfolio.
In the request:
Set the
MerchantIdHTTP header to your portfolio’s MID.Include the
HierarchyNodeKeyin the request body to define where the new merchant belongs in the hierarchy.
The response returns a new 16-digit MID. Use this MID in all subsequent onboarding API requests.
Create merchant application
Use the Create Merchant Application endpoint to create the merchant application using the assigned MID. This step collects required onboarding details such as business name and hierarchy placement before submitting the application for underwriting and setup.
Provide merchant demographic and business details
Collect and submit merchant demographic and business information through Merchant Demographics APIs. This process ensures that the merchant account includes all required information for verification and underwriting.
Once a merchant is initially created, the system pre-generates empty demographic records such as mailing address, physical address, taxpayer information, and sales profiles. Update these records using the related PUT endpoints.
Configure pricing plan
Use the Pricing Plan API to create or update merchant pricing plans during onboarding. This helps to configure the transaction fees, service charges, and other cost-related configurations that align with each merchant’s business needs.
Customizable pricing plans are flexible pricing structure based on your business requirements. Each plan can include specific fee types, rates, and service charges.
Configure pricing using predefined templates or customize plans to match individual business requirements.
Add equipment, documents, and compliance data
Complete equipment survey to order equipment using Equipment Order API. It helps to streamline the process of configuring and ordering devices required for payment processing.
You can select the supported devices, such as POS terminals or card readers and payment hardware devices. Once submitted, the system provisions the hardware and links it to the corresponding Merchant ID (MID).
To configure equipment:
Retrieve available equipment products.
Retrieve the equipment configuration survey for the selected device.
Complete and submit the required survey configuration.
Submit the equipment order.
After submission, the system provisions the hardware and associates it with the merchant MID.
Submit application signature
Merchant consent is collected through signature submission to complete the onboarding application.
You can submit signatures electronically or through uploaded signed documents.
Electronic signature submission
To submit electronic signatures:
Mark at least one business contact as a signer.
Present the legal terms and conditions to the signer for review.
Provide a method for the signer to accept the agreement (for example, a checkbox).
Submit the signature using the Submit Signatures endpoint.
Signature submission via document upload
Merchants preferring physical signatures can print, sign, and then upload the signed documents for submission using below process:
Mark at least one business contact as a signer.
Allow the merchant to upload the signed documents through your application.
Submit the uploaded document using the Upload Document endpoint.
Submit the signature confirmation using the Submit Signatures endpoint.
Once a merchant submit the signature, the system validates the submitted information and if any errors are found, they are returned in the response. If the data is valid, the signatures are accepted, and the submission is complete.
After a successful submission, no further changes can be made to the merchant through the Merchant Onboarding API. This process ensures Xplor Pay receives the required authorization while supporting flexible signature submission options.
Submit application for review and approval
Submit the application for processing after all required onboarding data and signatures are completed.
After submission, Xplor Pay validates the onboarding information, including business contacts, banking information, and compliance details and performs automated underwriting and compliance review.
Underwriting review – The submitted data is reviewed for compliance and risk evaluation.
Equipment activation – Provisions configured payment hardware.
This step transitions the merchant from onboarding to operational status.
After successful review and approval, the response returns HTTP 200 OK with confirmation that the merchant application is approved. The merchant account is activated and ready to process payments.
After onboarding is complete, proceed to Payment Processing.
Last updated
Was this helpful?