Payout Copy section link Copied!

Payout to vendors can be done only when the funds are received and the payment split has been validated.


You can use two different payout methods:

Implementing the Payout API is optional. AgoraPay can trigger automatic and periodic payout operations. Please contact your implementation manager to set up this option.

One-off payout Copy section link Copied!

To make a one-off payout, invoke the /payout/create request specifying:

Parameter Name
Required
Type
Description
endToEndId
string
Use to identify transaction in SEPA transfer. Autorized characters are alpha numeric, - and /. Characters / and space are authorized but not in first and last position. Also, two // are not allowed.
payoutAmount
check
object
amount information
paymentMethodAlias
check
string
Alias identifying a previously registered payment method.
accountNumber
check
string
A string representing the account number.
commission
object
Commission information
metaData
object
JSON data for the marketplace. This data is not used by payment systems.
reason
string
Operation label transmitted in payment system. Maximum length of 140 characters.

Example Copy section link Copied!

JSON
Copy
Copied
{
"accountNumber": "1300600000EUR01006110",
"reason": "test",
"endToEndId": "ETEID-20210203142803584",
"paymentMethodAlias": "PM2021011300GLR1100",
"metaData": {
"Metadata3": "donn\u00e9e3",
"Metadata4": "donnee4"
},
"payoutAmount": {
"value": "200",
"currency": "EUR"
},
"commission": {
"amount": "1.00",
"account": "1300600000EUR60002411"
}
}
Copy
Copied

Here is a JSON payload for an example request:

Retrieving the result Copy section link Copied!

If the request is successful, you will receive a registerReponse object, containing the following information:

Parameter Name
Type
Description
resultCode
string
resultCodeMessage
string
transactionId
string
transactionStatus
string

Example Copy section link Copied!

Here is a successful request example payload:

JSON
Copy
Copied
{
"resultCode": "0",
"transactionId": "1289921"
}
Copy
Copied

Error handling Copy section link Copied!

If you encounter any error, you can check API error codes page for troubleshooting.

Recurring payout Copy section link Copied!

A recurring payout allows you to schedule payouts with a specific amount on weekly or monthly basis.


To create a recurring payout, invoke the /paymentAccount/payoutAuto request specifying:

Parameter Name
Required
Type
Description
accountNumber
string
A string representing the account number.
amount
check
string
Recharge amount
frequency
check
string
0: deactivate 1: once a day 2: once a week 3: once a month
dayOfWeek
string
Selected day of the week. Between 0 and 6 If frequency is set to 2, dayOfWeek is a mandatory field. 0: Sunday 1: Monday 2: Tuesday 3: Wednesday 4: Thursday 5: Friday 6: Saturday
dayOfMonth
string
Selected day of the month. Between 1 and 31. If frequency is set to 3, dayOfMonth is a mandatory field
paymentMethodAlias
string
Alias identifying a previously registered payment method.

Example Copy section link Copied!

Here is an example request JSON payload:

JSON
Copy
Copied
{
"accountNumber": "1300600000EUR01005110",
"amount": "200.00",
"frequency": "2",
"dayOfWeek": "1",
"paymentMethodAlias": "PM2021011300GLR1100"
}
Copy
Copied

Retrieving the result Copy section link Copied!

If the request is successful, you will receive a paymentAccountPayautoResponse object, containing the following information:

Parameter Name
Type
Description
resultCode
string
resultCodeMessage
string

Example Copy section link Copied!

Here is a successful JSON payload response example:

JSON
Copy
Copied
1
2
3
4
{
"resultCode": "0",
"transactionId": "1289921"
}
Copy
Copied

Error handling Copy section link Copied!

If you encounter any error, you can check API error codes page for troubleshooting.