Orders
Payments can include an order_id which is the ID of the payment given by the merchant in their system. Merchants can retrieve payments based on this ID.

The Order Object

The Order Object
Order Object Example
Property
Type
Description
order_id
String
ID given by the merchant in their system.
payment_id
String
The payment id at dLocal.
amount
Positive Float
Transaction amount (in the currency entered in the field “currency”).
currency
String
Three-letter ISO currency code, in uppercase.
created_date
Date (ISO_8601)
Payment’s creation date.
approved_date
Date (ISO_8601)
Payment’s approval date.
status
String
status_code
String
The payment status code.
status_detail
String
Payment status detail.
1
{
2
"order_id": "LDMYZ5mtmsCa",
3
"payment_id": "D-4-f77392b1-4ff0-477c-749ac9a237b5",
4
"currency": "USD",
5
"amount": 382.00,
6
"created_date": "2018-07-12T15:20:02.000+0000",
7
"approved_date": "2018-07-12T15:20:02.000+0000",
8
"status": "AUTHORIZED",
9
"status_code": "600",
10
"status_detail": "The payment was authorized."
11
}
Copied!
get
https://api.dlocal.com/orders/
{order_id}
Retrieve an Order

Example Request

1
$ curl \
2
-H 'X-Date: 2018-02-20T15:44:42.310Z' \
3
-H 'X-Login: sak223k2wdksdl2' \
4
-H 'X-Trans-Key: fm12O7G9' \
5
-H 'X-Version: 2.1' \
6
-H 'User-Agent: MerchantTest / 1.0 ' \
7
-H 'Authorization: V2-HMAC-SHA256, Signature: 1bd227f9d892a7f4581b998c21e353b1686a6bdad5940e7bb6aa596c96e0a6ec' \
8
https://api.dlocal.com/orders/43343463432
Copied!
Last modified 1yr ago