Submit a payout
post
https://api.dlocal.com/api_curl/cashout_api
/request_cashout
Requesting a payout
Depending on each country's bank compliance requirements, some additional fields might be mandatory when sending payouts.
Response
If the status is 0 then the payout was ok submitted.
1
http code:200
2
{
3
"status":0,
4
"desc":"OK",
5
"cashout_id":206766
6
}
Copied!
If the status is 1 the payout could not be created.
Example 1:
1
http code:200
2
{
3
"status":1,
4
"desc":"External ID already used",
5
"error_code":"511",
6
"cashout_id":206766
7
}
Copied!
Example 2:
1
http code:200
2
{
3
"status":1,
4
"desc":"Empty param login"
5
"error_code":"301"
6
}
Copied!
If the status is 3 the payout could not be created as it is a card and we do not process cards in that market
1
http code: 200
2
{
3
"status":3,
4
"desc":"Invalid param bank_account - The account number provided appears to be a card number, which is not currently supported.",
5
"error_code":"300"
6
}
Copied!
​
Country requirements
Please see each country below for specific country requirements and example requests:
For fields 'login' & 'pass':
x_login and x_trans_key are your credentials. Remember to find them in the Merchant Panel, under the Integration > Credentials & Settings section.
Notifications
Once the transfer is confirmed by the bank, dLocal will send a notification to your merchant notification URL informing you of the result code of the transaction. This URL can be overridden using the
notification parameter for individual payout requests, however note this new URL will only be active for that particular payout.Purpose codes
Some countries' compliance regulations require you to specify each payment's purpose. For details on the purpose codes check the API codes section.
Last modified 24d ago