Onboarding
The primary method for onboarding new sub-merchants is through our Referral Signup Link.
Once your platform is eligible, your account manager will provide a unique URL. You should present this link to the clients you wish to onboard as sub-merchants.
When your client uses this link, the form will:
The form is mobile-responsive and can be embedded directly into your platform using an iframe for a seamless user experience.
Matching Submerchants with your system
To easily track and match a new sub-merchant with the corresponding user in your own system, you can add a query parameter to the referral URL.
Append the externalSubMerchantId parameter to the end of the URL you received, using your internal identifier for that user.
Format:
&externalSubMerchantId={YourUniqueSubMerchantID}
Example: If your referral URL is https://example.onekeypayments.com/referral?id=XYZ123 and your internal user ID is user-9876, the final URL would be:
https://example.onekeypayments.com/referral?id=XYZ123&externalSubMerchantId=user-9876
Onboarding confirmation
After a submerchant successfully completes the signup form, you will receive a webhook Notification confirming that their account has been created.
Last updated
Was this helpful?