Sign in

v1

latestOpenAPI 3.1.02026-07-2663312285.4 KB
Refund Endpoints

Create refund

Refund all or part of an authorization on a payment charge that has been captured.

post/v1/payment-charges/{paymentChargeId}/refunds

Path parameters

paymentChargeIdstring required

Headers

Merchant-Idstring required

The merchant identifier.

Request-Referencestring

Unique request reference to facilitate debugging.

Request-Idempotency-Keystring

Optional Idempotency Key for the request. Sending duplicate requests will result in 409 HTTP status code.

Request body

merchantRefundReferencestring

The merchant provided refund reference.

amountinteger required

The refund amount in the payment charge currency's smallest unit.

refundDescriptorstring

The refund descriptor (arbitrary string). To provide consumer's bank account details

refundReason'RETURN' | 'DUPLICATE' | 'FRAUD' | 'CUSTOMER_REQUEST' | 'PRE_DISPUTE' | 'OTHER'

The reason for the refund request.

labelsobject

Custom labels associated with the refund.

Example request

{
  "merchantRefundReference": "5c019979-0751-469e-96e0-b67f1d95c577",
  "amount": 1000,
  "refundDescriptor": "Name: Jamie Shopper CPF:12345678909 Bank Name: Scotland Bank Agency Number: 1234 Account Number: 123456789"
}

Response

OK