Get Refund

Retrieve the details of a specific refund by its ID.

GET /pg/refunds/{refund_id}

Try it

Get Refund

cURL

curl --request GET \
  --url https://api-staging.eximpe.com/pg/refunds/{refund_id} \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>'

200

{
  "success": true,
  "message": "Refund details retrieved successfully",
  "data": {
    "refund_id": "RF1481534012",
    "refund_amount": 12,
    "refund_status": "INITIATED",
    "refunded_at": null,
    "message": "No action status found",
    "payment_id": "PR3828502708"
  }
}

Authorizations

X-Client-ID · string · header · required

Client app ID. You can find your app id in the merchant dashboard.

X-Client-Secret · string · header · required

Client secret key. You can find your secret in the merchant dashboard.

Path Parameters

refund_id · string · required

The ID of the refund to retrieve.

Response

200

application/json

The details of the refund.

success · boolean · required

Indicates if the request was successful

message · string · required

Response message

data · object · required

Show child attributes

data. refund_id · string

Unique identifier for the refund.

data. payment_id · string

The ID of the payment that was refunded.

data. refund_status · string

The status of the refund.

data. message · string | null

A message providing more detail about the refund status.

data. bank_ref_num · string | null

The bank reference number for the refund.

data. refund_amount · number<float>

The refunded amount.

data. refunded_at · string<date-time> | null

The timestamp of when the refund was completed.