Sign in

v1

latestOpenAPI 3.1.02026-07-245361280.3 KB
Manage payouts

Submit a payout

Learn how to start making payouts.

post/payouts/v3

Request body

external_idstring required

Payout identification at the merchant's end.

payment_method_id'BANK_TRANSFER' | 'INSTANT_PAYMENT' | 'CARD' | 'CASH_PICK_UP' required

Payment method.

flow_type'B2C' | 'B2B' | 'P2P' required

Payout flow type.

countrystring required

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

quote_idstring

Quote ID (only when previously created).

currencystring required

Payout currency. Each country accepts USD and local currency.

currency_to_paystring

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

amountnumber required

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

purpose'FAMILY_MAINTENANCE' | 'MEDICAL_CARE' | 'TUITION_COSTS' | 'CHARITY_DONATION' | 'PROPERTY_PURCHASE' | 'SHARES' | 'INVESTMENT' | 'UTILITY_PROVIDER' | 'TAXES' | 'TOURISM_EXPENSE' | 'TRAVEL' | 'SAVINGS_RETIREMENT' | 'PENSION' | 'PAYROLL' | 'PHYSICAL_GOODS' | 'DIGITAL_GOODS' | 'SUPPLIER' | 'OTHER_SERVICES' | 'CAPITAL_CONTRIBUTION' | 'PROPERTY_RENTAL' | 'LOGISTICS' | 'INVESTMENT_INTEREST' | 'AVAILABILITY' | 'DISPONIBILIDADES' | 'INSURANCE' | 'REWARDS' | 'ENTERTAINMENT' | 'PUBLIC_SERVICES' | 'AFFILIATION_PROGRAMS' | 'REMITTANCES' required

Payout purpose code.

statement_descriptorstring

The text to be shown on the user payment statement.

descriptionstring

Payout description or comments.

on_holdboolean

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_urlstring

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

Example request

{
  "external_id": "ex_id8910",
  "payment_method_id": "BANK_TRANSFER",
  "flow_type": "P2P",
  "country": "BR",
  "quote_id": "39b09aad-7e25-4d56-92aa-cf30a19e5b99",
  "currency": "BRL",
  "currency_to_pay": "BRL",
  "amount": 50000.19,
  "statement_descriptor": "ABC remittance provider",
  "description": "ABC - Remittance - gift",
  "notification_url": "https://samplenotificationurl.com/notification",
  "beneficiary": {
    "first_name": "John",
    "last_name": "Doe",
    "phone": "+5511971111111",
    "email": "john.doe@gmail.com",
    "bank_account": {
      "code": "341",
      "branch": "0167",
      "type": "SAVINGS",
      "account": "12345-1"
    },
    "document": {
      "type": "CPF"
    },
    "birth_info": {
      "date": "1980-06-23",
      "country": "BR",
      "city": "Sao Paulo"
    },
    "address": {
      "street": "Avenida Paulista",
      "number": "123",
      "city": "Sao Paulo",
      "state": "Sao Paulo",
      "country": "BR",
      "postal_code": "05319-000"
    },
    "cash_pick_up": {
      "location": "Agent Address"
    },
    "instant_payment": {
      "type": "PIX_email",
      "id": "chichi@mail.com"
    },
    "card": {
      "number": "12343567890123456"
    }
  },
  "remitter": {
    "first_name": "Ashley",
    "last_name": "Peterson",
    "nationality": "US",
    "phone": "+12021111111",
    "email": "akshrey@gmail.com",
    "funds_source": "SALARY",
    "document": {
      "type": "PASS",
      "issue_date": "2020-01-01",
      "expiration_date": "2030-01-01"
    },
    "birth_info": {
      "date": "1981-06-23",
      "country": "US",
      "city": "Washington DC"
    },
    "address": {
      "street": "4400 ABC Ave NW",
      "number": "123 ",
      "city": "Washington DC",
      "state": "District of Columbia",
      "country": "US"
    }
  }
}

Response

Payout created

idstring

Payout ID generated by dLocal

external_idstring

External ID provided by the merchant

statusstring

Status of the payout (e.g., PENDING, CANCELLED)

status_codestring

Status code of the payout

status_detailstring

Detailed status message

created_datestring date-time

Creation date of the payout

last_updatedstring date-time

Last update date of the payout

payment_method_idstring

Payout method

flow_typestring

Indicates payout flow

countrystring

Country code of the payout

currencystring

Currency in which the FX conversion was based on

currency_to_paystring

Currency in which the payment was paid

amountnumber

Amount paid out

purposestring

Purpose of the payout

statement_descriptorstring

Statement descriptor

descriptionstring

Payment description

on_holdboolean

Indicates if the payout is on hold

notification_urlstring

Notification callback URL

Example response

{
  "id": "PO-4-39b09aad-7e25-4d56-92aa-cf30a19e5b99",
  "external_id": "ex_id8910",
  "status": "PENDING",
  "status_code": "100",
  "status_detail": "The payout is pending",
  "created_date": "2023-11-16T00:00:07.00Z",
  "last_updated": "2023-11-16T00:00:07.00Z",
  "payment_method_id": "BANK_TRANSFER",
  "flow_type": "P2P",
  "country": "BR",
  "currency": "BRL",
  "currency_to_pay": "BRL",
  "amount": 50000.19,
  "purpose": "REMITTANCES",
  "statement_descriptor": "ABC remittance provider",
  "description": "ABC - Remittance - gift",
  "notification_url": "https://samplenotificationurl.com/notification",
  "amount_details": {
    "amount_to_pay": 50000.19,
    "exchange": {
      "source_amount": 50000.19,
      "source_currency": "BRL",
      "destination_amount": 9746.81,
      "destination_currency": "USD",
      "exchange_rate": 5.1299
    },
    "fees": {
      "amount": 1.6,
      "currency": "USD"
    },
    "taxes": {
      "amount": 0.09,
      "currency": "USD"
    },
    "debit": {
      "amount": 101.69,
      "currency": "USD"
    }
  },
  "beneficiary": {
    "first_name": "John",
    "last_name": "Doe",
    "phone": "+5511971111111",
    "email": "john.doe@gmail.com",
    "bank_account": {
      "code": "341",
      "branch": "0167",
      "type": "SAVINGS",
      "account": "12345-1"
    },
    "document": {
      "type": "CPF"
    },
    "birth_info": {
      "date": "1980-06-23",
      "country": "BR",
      "city": "Sao Paulo"
    },
    "address": {
      "street": "Avenida Paulista",
      "number": "123",
      "city": "Sao Paulo",
      "state": "Sao Paulo",
      "country": "BR",
      "postal_code": "05319-000"
    }
  },
  "remitter": {
    "first_name": "Ashley",
    "last_name": "Peterson",
    "nationality": "US",
    "phone": "+12021111111",
    "email": "akshrey@gmail.com",
    "funds_source": "SALARY",
    "document": {
      "type": "PASS",
      "issue_date": "2020-01-01",
      "expiration_date": "2030-01-01"
    },
    "birth_info": {
      "date": "1981-06-23",
      "country": "US",
      "city": "Washington DC"
    },
    "address": {
      "street": "4400 ABC Ave NW",
      "number": "123 ",
      "city": "Washington DC",
      "state": "District of Columbia",
      "country": "US"
    }
  }
}