Make a payout

This API loads funds into beneficiary accounts. You can submit an array of accounts in one API call. We suggest not to use more than 1000 accounts in one API call. With this API, if one record fails to load, then all the records in the API also will fail. You will need to resubmit all records in the API again once you fixed the failed record.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 100

It is a parameter that is used to group all loads into one batch. You may call this endpoint multiple times, and as long as the PartnerBatchID is the same the payouts will be added to the same batch. Please note that PartnerBatchID is used as a batch name in the management console.

string | null

Payout pool/level/tier. If you do not use pools, just leave it blank. This field is just for reference.

boolean
required

Specifies whether to allow duplicate transactions in this batch. Duplicates are identified by username. Thus, if true, multiple payouts can be made to the same username within this batch.

boolean
required

If set to TRUE - automatically approve and load payout into eWallets. A batch will be automatically closed, and no other loads can be added into this batch.

string
required
length ≤ 3

Payout currency code

arrAccounts
array of objects
required

An array of load transactions.

arrAccounts*
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json