Orders

Retrieve an Order

Changed on

Retrieve information about an existing order.

get/orders/{order_id}

Request

  • Base URL
    https://api.dlocal.com
  • URL
    https://api.dlocal.com/orders/{order_id}
  • Auth
    API key in header X-Date and API key in header X-Login and API key in header X-Trans-Key and API key in header Content-Type and API key in header X-Version and API key in header User-Agent and API key in header Authorization

Path parameters

order_idstring required

ID given by the merchant in their system.

Response

200

payment_idstring
order_idstring
amountinteger
currencystring
approved_datestring
created_datestring
statusstring
status_codestring
status_detailstring

Example response

{
  "payment_id": "D-4-f77392b1-4ff0-477c-749ac9a237b5",
  "order_id": "LDMYZ5mtmsCa",
  "amount": 382,
  "currency": "USD",
  "approved_date": "2018-07-11T19:55:56.348Z",
  "created_date": "2018-07-11T19:55:56.348Z",
  "status": "PENDING",
  "status_code": "100",
  "status_detail": "The payment is pending"
}

Changes