Account management Copy section link Copied!

Link an IBAN to an account Copy section link Copied!

IBAN linking applies to both vendors and to your marketplace payment account.

Linking an IBAN to a Vendor payment account Copy section link Copied!

Payouts are possible once your vendor has:

Validated the KYC and has a functional vendor payment account (see Validate a vendor payment account and KYC procedure)
Provided and validated at least one bank account

A Vendor payment account can have only one active IBAN. Providing a new IBAN automatically implies disabling of the current IBAN.

Linking an IBAN to a Vendor payment account requires following these 2 steps:

Use the /paymentAccount/setIBAN API request to link the IBAN to the Vendor payment account
Once AgoraPay has validated the IBAN, the Vendor needs to manually validate the linking within 24 h in their AgoraPay account to make it work

Linking an IBAN to a seller account requires several steps:

1) Request from the marketplace to link an IBAN to a seller account, sent to CAPS: This request /paymentAccount/setIBAN must be justified by providing at least one supporting document (RIB) indicating the account number and account holder.

2) CAPS verifies the request: CAPS verifies that the IBAN and RIB provided are consistent. They validate or reject the link request.

3) Merchant validation of the validity of the IBAN link request. The seller is informed of a request to link an IBAN to their AgoraPay account. They must validate (or reject) the request for it to be operational.

4) Validation by the merchant activates the received IBAN. It deactivates any IBAN (payment method) previously linked to the account, used for payout purposes.

Set up commission account Copy section link Copied!

AgoraPay provides several sub-accounts, including the commission account, from which AgoraPay commissions and fees are deducted.

Therefore, we recommend topping up this commission account with commissions charged by the marketplace to ensure the account does not go into overdraft.

The marketplace can collect commissions in four different ways:

- at PayIn

- account-to-account transfer

- at PayOut

- outside of AgoraPay

Check the Manage funds page for more information.

1 - At PayIn Copy section link Copied!

In the payment request settings (PayIn), to manage the distribution of funds from the breakdown list, the "Account" and "Amount" fields must be filled in with the commission account number used to collect commissions and the amount.

Please complete these fields and test the process when implementing the solution.

Example Of A €40 Order With A €1 Commission

Copy

Copied

{"paymentAccount":"1737800001EUR1234567",
"orderReference":"commande1",
"orderCountryCode":"FRA",
"urlRedirect":"https://marketplacefr.com/commande/?key=commande=iframe&status=state",
"capture":"1","registerAlias":"0","payer":{"reference":"clientx"},
"transactionAmount":{"value":"40.00","currency":"EUR"},"transPaymentMethod":{"id":"1"},
"breakdownList":
[
 {"label":"Ventilation_Vendeur_01","sellerAccountNumber":"1737800001EUR2345678",
"amount":
  {"value":"39.00","currency":"EUR"},
"commission":
  {"amount":"1.0","account":"1737800000EUR6123456"}}
]}

Copy

Copied

Example of a €40 order with a €1 marketplace commission sent to the commission account 1737800000EUR6123456 and €39 to the vendor account.

More informations provide-split-information

2 - Account-to-account transfer Copy section link Copied!

It is possible to allocate all funds to the seller's account during PayIn.

Before PayOut is triggered, it is possible to make a transfer from the seller's account to the commission account, using the Transfer/create API (or perform the action punctually on the AgoraPay portal).

Transfer Commision

Copy

Copied

{
  "accountNumber": "1300600000EUR01004110",
  "accountCptNumber": "1300600000EUR61006110",
  "orderRef": "commissionMKPcmd1",
  "reason": "commission1e",
  "transferAmount": {
    "value": "1.00",
    "currency": "EUR"
  }
}

Copy

Copied

At PayOut Copy section link Copied!

The PayOut/create API allows funds to be disbursed to the merchant's bank account.

The request allows you to specify the commission amount to be charged, along with the commission account number.

The merchant will receive a transfer of the full amount less the commission taken.

If Amount PayIn is €570.70, so : value":"570.70"

"commission":"amount":"8.56",

Amount in marchant Bank account : 662.14€

Commission & Payout

Copy

Copied

{
"accountNumber":"1737800001EUR12345678",
"paymentMethodAlias":"PM2021011300GLR1100",
"endToEndId":"ETEID-20210203142803584",
"reason":"Payout to marchandx",
"payoutAmount":{"value":"570.70","currency":"EUR"},
"commission":{"amount":"8.56","account":"1737800001EUR61234567"}}

Copy

Copied