Make a refund

post https://api.dlocal.com/refunds

This service allows you to create and read refunds of an existing payment.

Body Params

payment_id

string

required

The payment ID.

Length: 50.

notification_url

string

required

If a refund is pending, the refund confirmation is sent asynchronously to this URL.

Length: 200.

custom_merchant_name

string

Custom merchant's name. Recommended if you need to define a different name to show on a payout link request. It's included in the email subject sent to the user as well.

Length: 100.

amount

float

The refund amount, always in local currency. If no amount is specified, the total payment amount will be refunded by default. Required if currency is present.
This is mandatory for refunds with splits.

Length: 16,2. Example 9999999999999999.99

currency

string

Currency of the Amount. Required if amount is present.

Length: 3.

description

string

Description of the refund.

Length: 200.

order_refund_id

string

ID given by the merchant in their system.

Length: 125.

beneficiary_name

string

User's first name. Recommended if the type of the payment is TICKET or BANK_TRANSFER.

Length: 50.

beneficiary_lastname

string

User's last name. Recommended if the type of the payment is TICKET or BANK_TRANSFER.

Length: 50.

bank

string

User's bank name. Recommended if the type of the payment is TICKET or BANK_TRANSFER.

Length: 40.

bank_code

string

User's bank code. Recommended if the type of the payment is TICKET or BANK_TRANSFER.

Length: 45.

bank_account

string

User's bank account number. Recommended if the type of the payment is TICKET or BANK_TRANSFER.

Length: 45.

bank_account_type

string

Type of bank account. C: for Current accounts; S: for Savings accounts; I: International accounts. Recommended if the type of the payment is TICKET or BANK_TRANSFER.

Length: 40.

bank_branch

string

User's bank branch code. Recommended if the type of the payment is TICKET or BANK_TRANSFER.

Length: 45.

bank_branch_name

string

User's bank branch name. Recommended if the type of the payment is TICKET or BANK_TRANSFER.

Length: 40.

document_type

string

User's document type. Recommended if the type of the payment is TICKET or BANK_TRANSFER.

Length: 10.

document_id

string

User's document id. Recommended if the type of the payment is TICKET or BANK_TRANSFER.

Length: 40.

phone

string

User's phone. Recommended if the type of the payment is TICKET or BANK_TRANSFER.

Length: 20.

string

User's email. Recommended if the type of the payment is TICKET or BANK_TRANSFER.

Length: 100.

address

string

User's address. Recommended if the type of the payment is TICKET or BANK_TRANSFER.

Length: 200.

city

string

User's city. Recommended if the type of the payment is TICKET or BANK_TRANSFER.

Length: 100.

splits

array of objects

Allows to split a transaction between one or more accounts.
This is mandatory for captures and sales with splits.

splits

Response

Language

Credentials

Request


xxxxxxxxxx
1
{
2
    "payment_id": "PAY4334346343",
3
    "custom_merchant_name": "Custom name by the merchant",  
4
    "amount": 100.00,
5
    "currency": "USD",
6
    "notification_url": "http://some.url",  
7
}

Choose an example:

application/json

200200