Create Refund

Create a new refund for a previously successful payment.

POST /pg/refunds

Create Refund

cURL

curl --request POST \
  --url https://api-staging.eximpe.com/pg/refunds \
  --header 'Content-Type: application/json' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '
{
  "payment_id": "PR8867819681",
  "refund_amount": "11"
}
'

200

{
  "success": true,
  "message": "Refund request processed successfully",
  "data": {
    "refund_id": "RF8380989720",
    "payment_id": "PR8867819681",
    "refund_status": "INITIATED",
    "message": "Refund Request Queued",
    "transaction_id": "138287318",
    "bank_ref_num": null,
    "refund_amount": "11"
  }
}

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.

Body

application/json

Refund creation request

payment_id · string · required

The ID of the payment to refund.

refund_amount · string · required

The amount to be refunded. Can be a partial amount.

Response

200

application/json

Refund created successfully

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.