Create or modify a Merchant Copy section link Copied!

How it works Copy section link Copied!

New Merchant (register) Copy section link Copied!

The /accountHolder/register API allows you to initiate the creation of a Merchant account.

Various information (information sheet) must be provided in the request, such as company information, the people who make it up, including the Primary Contact, etc.

The company's legal information will define the documents required to be uploaded for registration.

Some informations on this API Copy section link Copied!

TurnOver : company turnover
RegulatedSociety : Publicly traded company or not
Email & phonenumber : mandatory for the Merchant's main representative, who will receive the account agreement signature email and must enter the validation OTP
Account : account holder information including IBAN and account footer if desired
CP : There can only be one Primary Contact per Merchant

API Response Copy section link Copied!

RequestId unique identifier of this request, is returned and will be used for each API call linked to this enrollment request.
AccountNumber and paymentmethodAlias are returned and will be useful for API breakdown and PayOut
Questionnaire pays is provided in base64, which will be completed by the merchant before being returned by API UploadDocument

For each expected supporting document, an identifier is assigned (id requirements).

Go to UploadDocument section

Cinematic Copy section link Copied!

You want to enroll a merchant :

1 - You use the Register API with the expected compliant information : the request moves to Pending status and returns the statuscode 9.

2 - You use the UploadDocument API to upload each required document. Once all required documents are uploaded, the request moves to Completed status and returns statuscode 7.

3 - After analysis, the request moves to Validated (2), Rejected (3), or Pending (9) status if a document is invalid and needs to be resubmitted.

4 - In the case where the request goes back to Pending (9) status, use the RegistrationDetails API to identify which document needs to be resubmitted, and then send it using the UploadDocument API.

Request Status codes Copy section link Copied!

Status code

Label

Description

Pending

The request is being initialized & analyzed - awaiting documents

Completed

The request has been completed

Validated

The request has been validated by AgoraPay

Rejected

The request has been rejected by AgoraPay

Canceled

The request has been canceled

Expired

The request has been has been expired

To check

The request is pending document validation by AgoraPay following the detection of errors or alerts

These status codes are present in API returns but also in enrollment webhooks.

Example Of A Completed Request But No Document Yet (Pending Step) :

Copy

Copied

{"accountNumber":"1737800001EUR13684221","eventCode":"Account_Holder_Registration",
"paymentMethodAlias":"PM202307250VNPP1100","requestId":"CAPS202307250SNWJ1",
"requestStatus":"9","thirdPartyName":"Reg_T4 socialReason","thirdPartyRef":"CAPS2307250VNWR1",
"updateUDateTime":"20230725165808421","versionNumber":"1.0"
}

Copy

Copied

Note on the webhook generated for the "pending" status:

This webhook now contains the account number and the payment method alias. These two pieces of information are present in the API return and also in the webhooks for the following statuses.

We advise you to record these two informations only when the enrollment request has been validated (Status Code 2)

Update Copy section link Copied!

The /accountHolder/update is similar to the Register API, is useful for completing a request in progress (pending step).

For example, if you need to add a physical person, a mobile number, an account footer, etc.

This API can only be used if all the required documents have not yet been sent, in other words, only if the request is in "pending" status.

If any of the provided elements are incorrect, the request will return to "pending" status so that the marketplace can provide the required elements using the Update or UploadDocument API, if a supporting document already uploaded has been rejected.

The rejection must be justified.

The legal form of the company cannot be changed. In these cases, you should cancel the registration request (unregister API) and submit a new one.
For any change of Primary Contact (PC) role from one individual to another, you must contact us.

The Update API does not allow these change.

Details Registration step Copy section link Copied!

/accountHolder/registrationDetails API allows you to retrieve information related to an enrollment request.

How to use : specifying the requestId as an input parameter.

Method used: GET

Each change in the status of the request results in a webhook being sent. Using /registrationDetails API allows you to know the status of a request at any time (missing documents, rejected documents to be resubmitted, status of the request, internal account number, etc.).