DLdlocal
Refunds

Retrieve a refund

Changed on

Retrieve information about a refund.

get/refunds/{refund_id}

Request

  • Base URL
    https://api.dlocal.com
  • URL
    https://api.dlocal.com/refunds/{refund_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

refund_idstring required

The refund ID.

Response

200

idstring
payment_idstring
notification_urlstring
amountnumber
currencystring
statusstring
status_codeinteger
status_detailstring
created_datestring
amount_refundednumber

Example response

{
  "id": "REF42342",
  "payment_id": "PAY4334346343",
  "notification_url": "http://some.url",
  "amount": 803.04,
  "currency": "BRL",
  "status": "SUCCESS",
  "status_code": 200,
  "status_detail": "The refund was paid",
  "created_date": "2018-09-06T22:03:03.000+0000",
  "amount_refunded": 803.04
}

Changes