v1

latestOpenAPI 3.1.02026-07-245361280.3 KB

Retrieve an order

Retrieve information about an existing refund order.

get/orders/refunds/{order_refund_id}

Path parameters

order_refund_idstring required

ID given by the merchant in their system.

Response

200

idstring

payment_idstring

statusstring

currencystring

created_datestring

amountnumber

descriptionstring

status_codeinteger

status_detailstring

notification_urlstring

amount_refundednumber

refund_idstring

Example response

{
  "id": "LDMYZ5mtmsRef",
  "payment_id": "D-4-f77392b1-4ff0-477c-749ac9a237b5",
  "status": "SUCCESS",
  "currency": "BRL",
  "created_date": "2018-09-06T22:03:03.000+0000",
  "amount": 803.04,
  "description": "refund description",
  "status_code": 200,
  "status_detail": "The refund was paid.",
  "notification_url": "http://merchantsite.com/notification/new",
  "amount_refunded": 803.04,
  "refund_id": "REF-4-8b885de9-5cbc-436f-9d67-5d97315bd230"
}