GET
/
pg
/
refunds
List Refunds
curl --request GET \
  --url https://api-staging.eximpe.com/pg/refunds \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>'
{
  "count": 4,
  "page": 1,
  "page_size": 250,
  "next": null,
  "previous": null,
  "results": [
    {
      "refund_id": "RF8380989720",
      "refund_amount": 11,
      "refund_status": "INITIATED",
      "refunded_at": null,
      "message": "Refund Request Queued",
      "payment_id": "PR8867819681"
    },
    {
      "refund_id": "RF8370660295",
      "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.

Query Parameters

​
payment_id
string

Filter by payment ID.

​
reference_id
string

Filter by order reference ID.

​
from_date
string<date>

Filter refunds created from this date. Format: YYYY-MM-DD.

​
to_date
string<date>

Filter refunds created up to this date. Format: YYYY-MM-DD.

​
merchant_id
string

Filter refunds by merchant ID.

Response

200 - application/json

A paginated list of refunds.

The response is of type object.