AgoraPay offers 2 methods to easily onboard your new merchants by automating the sending of the necessary supporting documents via the configuration of the AgoraPay APIs or by Selfcare.
The SelfCare can be triggered either via the AgoraPay portal or via a dedicated API /selfCare/init. This API will be available soon.
It's up to you to decide what's best for you and your merchants, knowing that SelfCare is a solution where the merchant does all the enrollment work.
The Selfcare enrollment process is triggered directly on the AgoraPay Portal : Vendeurs > Invitations > Inviter un vendeur
Some information is requested in order to address the email to the merchant so that he enrolls independently on the Selfcare AgoraPay workflow.
To enroll by API, follow these steps to get onboarded :
Step 1. Onboard a vendor
To enroll a merchant, the AccountHolder/Register API triggers the merchant enrollment process. Different informations is to be communicated concerning the merchant's company: information on the company, the people who make it up, including the main contact, etc.
The legal information of the company will define the mandatory documents required in step 2.
API response you receive the request ID and for each expected supporting document an ID is assigned (id requirements), the AccountNumber (an internal AgoraPay account number of the merchant), Registration identification number of the natural or legal person, and paymentmethodAlias are returned and will be useful for breakdown and API PayOut.
See more: https://www.agorapay.com/en/documentation/v100/home/platform/vendors-onboarding/create-or-modify-a-vendor/
KYC procedure : https://www.agorapay.com/en/documentation/v100/home/platform/vendors-onboarding/kyc-procedure/
Step 2. Upload documents
To transfer each document by specifying the RequestId (Id of the initial request) and the Id of the expected document.
Each document must be sent in UploadDocument API request: it is not possible to send all the documents in a single API request.
Also, each download is checked by a virus scanner.
Once all the documents have been received and the account agreement signed by the merchant, they are analyzed and then validated (or rejected).
See more: https://www.agorapay.com/en/documentation/v100/home/platform/vendors-onboarding/validate-a-vendor-payment-account/
Step 3. Check Enrollment Status
Although each change in the status of the request gives rise to the sending of a webhook, using RegistrationDetails API request makes it possible to know the status of a request at any time (missing documents, rejected documents to be resupplied, status of the request, number internal account, ...)
This API allows you to retrieve information relating to an enrollment request, by indicating the requestId as an input parameter.
Method used: GET
Step 4. Manage vendor’s funds
When a customer makes a payment on your marketplace, you can split it to as many accounts as you want.
To split funds, you can send the breakdownList array via the payment API (or adjustPayment API). For each split, you will need to provide the following informations : Amount, commission, label, sellerAccountNumber
If you need to cancel a current request, you can use the Unregister API.
If you want to update or correct a request, you can use the Update API.
The Update API does not allow you to modify the legal form of the merchant, if it is a question of correcting the legal form, you will have to cancel the request (Cancel API) and create a new enrollment request.
With sellerAccountNumber you can transfer funds from one of your accounts to another.
If you use One-off Payout on a bank account via the /payout/create API, sellerAccountNumber and paymentmethodAlias allows you to make the PayOut to the merchant bank account.