Skip to main content
POST
/
pg
/
refunds
Create Refund
curl --request POST \
  --url https://api-pacb-uat.eximpe.com/pg/refunds/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Version: <api-key>' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '
{
  "payment_id": "PR2024120567891",
  "refund_amount": "2250.00"
}
'
{
  "success": true,
  "message": "Refund request processed successfully",
  "data": {
    "refund_id": "RF5622596094",
    "payment_id": "PR2099558561",
    "refund_status": "initiated",
    "message": "Refund Request Queued",
    "transaction_id": "138605980",
    "bank_ref_num": null,
    "refund_amount": "1000"
  }
}

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.

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

Refund created successfully

success
boolean
required

Indicates if the request was successful

message
string
required

Response message

data
object
required