Streamline your platform's growth with PayMongo Seeds' Onboarding API. This functionality empowers you (the Parent Merchant) to automate the Know Your Customer (KYC) information and document submission process for your Child Merchants, expediting their activation and access to PayMongo's payment and wallet features.
Who is Onboarding via API for?
These represent the account types supported by Onboarding API.
Parent Merchant: Your business, the primary account holder with PayMongo Seeds. PayMongo will directly communicate with you regarding account management and transactions.
Child: Sub-accounts created under your Parent Merchant account and onboarded onto PayMongo. Child accounts can be categorized as:
Child Merchant: A business operating within your platform, selling goods or services and accepting payments.
Consumer: Individuals who transact on your platform with their personal PayMongo Wallet. Some consumers may have business documents (e.g., freelancers, delivery riders) while others may not.
What documents do I need to submit?
To get started with collecting the necessary KYC documents from your Child Merchants, you can refer to this helpful article.
For a complete list of required information and documents specific to your industry and business type, please contact our support team at [email protected]. Our team is happy to assist you in ensuring a smooth onboarding experience for your Child Merchants.
Getting started with PayMongo Seeds
Account Configuration
The Onboarding Child Accounts via API feature is currently in beta. To utilize this functionality, please contact our support team at [email protected].
Once your account is configured, your developers can leverage our Onboarding API or Hosted Onboarding to effortlessly onboard child accounts. You can view all your child accounts and their account statuses under the "Seeds" page of your dashboard.
API Reference:
How do I use Onboarding API?
Access your secret live key under the Developer page of your PayMongo dashboard.
Onboarding API consists of the following elements:
Initiate the onboarding
This is where you first call the Onboarding API with the Create a Child Merchant or Consumer endpoint. Based on your Child account's business type and applied features, these endpoints will require certain fields and values as specified in this appendix.
Get requirements
With the Retrieve a Child Merchant Requirement endpoint, you can view the list of requirements needed by your Child account's business type and features. Providing these requirements will enable your Child Merchant to be activated with their applied features.
Send details
This step enables you to update and provide the requirements needed for your Child account with the Update a Child Merchant endpoint.
Upload files
Upload the necessary files by calling the following endpoints:
Create a File Record for a Child Merchant
List File Records for a Child Merchant
Delete a File Record for a Child Merchant
Submit for review
Once you have provided the complete, updated, and correct documents, submit your Child account application for review via the Submit a Child Merchant for Review endpoint.
Please give our onboarding team up to 14 days to review your application. You can monitor the status of your child's application in the "Child accounts" tab of your dashboard or by subscribing to our Seeds Webhook. This webhook will also include the API keys of your activated Child account.
For a complete overview, you may refer to the developer documentation outlined here.
That's it! Once your Child account has been activated, you can start enjoying other Seeds features such as accepting and distributing payments, as well as Wallets and other financial services.
Additional Resources
While this article focuses on Onboarding via API, you may want to check out our other PayMongo Seeds products, including:
Payment Splitting: Explore the APIs for managing split payments between you and your Child Merchants: [Link to Split Payments HC Article]
Hosted Onboarding: If you're looking for a no code onboarding solution, this feature allows you to generate unique KYC forms with customizable onboarding links, streamlining document collection and ensuring secure access.