Submit a payout

post

https://api.dlocal.com/payouts/v3

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.

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

Body Params

external_id

string

required

Payout identification at the merchant's end.

payment_method_id

string

enum

required

Payment method.

Allowed:

flow_type

string

enum

required

Payout flow type.

Allowed:

country

string

required

Country where the payout will be processed and where the beneficiary's account exists.

quote_id

string

Quote ID (only when previously created).

currency

string

required

Payout currency. Each country accepts USD and local currency.

currency_to_pay

string

Currency in which the payment has to be paid. Local currency assumed if not informed.

amount

number

required

Payout amount (in the currency set in the currency_to_pay field).

purpose

enum

required

Payout purpose code.

statement_descriptor

string

The text to be shown on the user payment statement.

description

string

Payout description or comments.

on_hold

boolean

Set to true to create the payout without processing it. The merchant can later request the payout to be processed (release) or canceled (cancel).

notification_url

string

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

beneficiary

object

required

Beneficiary's information.

remitter

object

Remitter information.

Responses

Country requirements

200Payout created

400Bad Request

403Forbidden