Skip to main content
GET
/
pg
/
refunds
List Refunds
curl --request GET \
  --url https://api-pacb-uat.eximpe.com/pg/refunds/ \
  --header 'X-API-Version: <api-key>' \
  --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 Application ID - Your unique application identifier used to authenticate API requests. You can find your Client ID in the Developer Settings section of the merchant dashboard.

X-Client-Secret
string
header
required

Client Secret Key - Your secret key used alongside the Client ID for secure authentication. Keep this confidential and never expose it in client-side code. Available in the Developer Settings section of the merchant dashboard.

X-API-Version
string
header
required

API Version - Specifies which version of the API to use (e.g., '1.X.X' or '2.X.X'). This header allows you to control which API version your integration uses. Default version information is available in the Developer Settings.

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.

count
integer
required

Total number of refunds

page
integer
required

Current page number

page_size
integer
required

Number of refunds per page

next
string | null
required

URL for the next page of results

previous
string | null
required

URL for the previous page of results

results
object[]
required