v1

latestOpenAPI 3.1.02026-07-245361280.3 KB

Retrieve a refund

Retrieve information about a refund.

get/refunds/{refund_id}

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
}