Create payment

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

Creates a new payment using any of the available payment methods.

Handling card payments

For payments with credit card information (e.g., card number, expiration date, CVV), use https://api.dlocal.com/secure_payments.
For card payments with a card_id or token, use https://api.dlocal.com/payments.

Body Params

amount

float

required

Transaction amount (in the currency specified in the currency field).
Decimals may vary by country.

Length: 10,2 (e.g., 99999999.99).

currency

string

required

Three-letter ISO-4217 currency code, in uppercase.

payment_method_id

string

Payment method code chosen to make the payment, or the keyword CARD. Required for DIRECT payment method flow.

Length: 4. For example: CARD, VI, VD, MC.

payment_method_flow

string

required

Payment method flow, can DIRECT or REDIRECT.

country

string

required

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

payer

object

required

card

object

Required only for CARD payment type.

order_id

string

required

ID given by the merchant in their system.

Length: 125.

original_order_id

string

For payment retries. ID given by the merchant in their system for the original transaction that was rejected and needs to be retried.

Length: 125.

description

string

Payment description.

Length: 200.

notification_url

string

URL where dlocal will send notifications associated to changes to this payment.

Length: 200.

callback_url

string

URL where dLocal does the final redirect. Required only for REDIRECT payment flow.

Length: 200.

additional_risk_data

object

Additional information for fraud prevention, see Fraud Prevention - Additional Risk Data Object documentation.

splits

array of objects

Allows to split a transaction between one or more accounts.

splits

Response

Language

Credentials

Request


xxxxxxxxxx
31
    "notification_url": "http://merchant.com/notifications"
1
{
2
    "amount": 120.00,
3
    "currency" : "USD",
4
    "country": "BR",
5
    "payment_method_id" : "CARD",
6
    "payment_method_flow" : "DIRECT",
7
    "payer":{
8
        "name" : "Thiago Gabriel",
9
        "email" : "thiago@example.com",
10
        "document" : "53033315550",
11
        "user_reference": "12345",
12
        "address": {
13
            "state"  : "Rio de Janeiro",
14
            "city" : "Volta Redonda",
15
            "zip_code" : "27275-595",
16
            "street" : "Servidao B-1",
17
            "number" : "1106"
18
        },
19
        "ip" : "2001:0db8:0000:0000:0000:ff00:0042:8329",
20
        "device_id" : "2fg3d4gf234"
21
    },
22
    "card":{
23
        "holder_name" : "Thiago Gabriel",
24
        "number" : "4111111111111111",
25
        "cvv" : "123",
26
        "expiration_month" : 10,
27
        "expiration_year" : 2040
28
    },
29
    "order_id": "657434343",

Choose an example:

application/json

Handling card payments

200200