Skip to main content
POST
Create Refund

Implementation Notes

  • Retry with a reference_id. If a call times out, send it again with the same reference_id, payment_id and refund_amount. You get the original refund back, not a second one. The same reference_id with a different amount is refused.
  • Refunds cannot add up to more than the payment. Refunds that have not failed count toward the payment amount. Two requests sent at once cannot both succeed if together they pass it; the second is refused.
  • A successful call returns 201. The body carries the refund_id and the reference_id. The refund’s outcome follows in its status and by webhook.

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', '2.X.X', or '3.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.

reference_id
string

Your own reference for this refund: letters, numbers and hyphens, up to 255 characters. Send the same value to retry safely: a repeat with the same payment and amount returns the original refund instead of creating a second one. A repeat with a different amount is refused. Generated for you when omitted.

callback_url
string<uri>

URL that receives refund status updates for this refund.

Response

Refund created

success
boolean
required

Indicates if the request was successful

message
string
required

Response message

data
object
required