Submit a payout

post

https://api.dlocal.com/api_curl/cashout_api/request_cashout

Learn how to start making payouts.

This is the base method used to request a payout. Please note each country may have its own additional requirements and will have their own payment schedules.

You need to complete the fields login and pass with yourx_login and x_trans_key credentials. Find them in the Merchant Dashboard, under the Settings > Integration section.

❗
Country requirements
Depending on each country's bank compliance requirements, some additional fields might be mandatory when sending payouts.

Body Params

string

required

Your merchant ID in dLocal platform.

Length 32 chars.

pass

string

required

Your merchant password in dLocal.

Length 32 chars.

external_id

string

required

Payout identification (at the merchant site).

Max. 100 chars.

metadata

string

Payouts metadata in JSON format.

Length 500 chars.

document_id

string

Beneficiary's personal identification number.

Max. 40 chars.

document_type

string

Beneficiary's personal identification type.

Max. 10 chars.

beneficiary_name

string

required

Beneficiary's name or company.

Max. 50 chars.

beneficiary_lastname

string

Beneficiary's surname.

Max. 50 chars.

country

string

required

Payment processing country code. ISO 3166-1 alpha-2 code.

Length: 2 chars.

bank_code

string

Beneficiary's bank code.

bank_name

string

Beneficiary's bank name. See bank names.

Max. 40 chars.

bank_province

string

Beneficiary's bank province name.

Max. 40 chars.

bank_city

string

Beneficiary's bank city name.

Max. 40 chars.

bank_branch_name

string

Beneficiary's bank branch name.

Max. 100 chars.

bank_branch

string

Beneficiary's bank branch number.

Max. 45 chars.

bank_account

string

required

Bank account number.

Max. 45 chars.

account_type

string

The type of the account.
C for checking accounts, S for savings accounts. Check specific country docs for other valid values.

Max. 40 chars.

amount

string

required

Payout amount (in the currency entered in the field currency).

Max. 2 decimal numbers.

control

string

Control string. It should be used only if using API version < 2.

address

string

Address of the beneficiary.

Max. 200 chars.

bdate

string

Beneficiary's birth date.

Format: YYYYMMDD.

city

string

City of the beneficiary.

Max. 100 chars.

comments

string

A commentary for this payout.

Max. 200 chars.

currency

string

required

Defaults to USD

Each country accepts USD and local currency.

Length: 3 chars.

string

Email of the beneficiary.

Max. 100 chars.

phone

string

Phone number of the beneficiary.

Max. 20 chars.

extra_info

string

Extra info of the beneficiary in JSON format.

Max. 500 chars.

notification_url

string

To be provided if the notification URL is different from the notification URL defined by default. See the Notifications section.

Max. 100 chars.

on_hold

boolean

Defaults to false

If the merchant wants to hold the payout and set it to process later through the Merchant Dashboard. This functionality is not available for instant payouts flow such as Nigeria.

Boolean: 1 or 0 (true/false).

postal_code

string

Postal code of the beneficiary.

Max. 20 chars.

nationality

string

Beneficiary's nationality. ISO 3166-1 alpha-2 code.

Length: 2 chars.

purpose

string

Payout purpose code. See the Purpose codes section.

Length: 6 chars.

flow_type

string

Either B2C, B2B, or P2P.

Max. 3 chars.

remitter_address

string

Remitter's address.

Max. 200 chars.

remitter_bank_account

string

Remitter's bank account.

Max. 45 chars.

remitter_full_name

string

Remitter's full name.

Max. 200 chars.

remitter_document

string

Remitter's document.

Max. 45 chars.

remitter_document_type

string

Remitter's personal identification type.

Max 10 chars.

remitter_city

string

Remitter's bank city name.

Max. 40 chars.

remitter_country

string

Remitter's country. ISO 3166-1 alpha-2 code.

Length: 2 chars.

remitter_postal_code

string

Postal code of the remitter.

Max. 20 chars.

remitter_birth_date

string

Remitter's birthdate.

Format: YYYYMMDD.

remitter_nationality

string

Remitter's nationality. ISO 3166-1 alpha-2 code.

Length: 2 chars.

submerchant_name

string

Submerchant's business name (only for PSPs).

Max. 100 chars.

submerchant_website

string

Submerchant's website url (only for PSPs).

Max. 100 chars.

submerchant_document

string

Submerchant's document id (only for PSPs).

Max. 45 chars.

submerchant_country

string

Submerchant's country (only for PSPs). ISO 3166-1 alpha-2 code.

Length: 2 chars.

submerchant_registration_date

string

Submerchant's registration date (only for PSPs).

Format: YYYYMMDD.

Response

Country requirements

200200