Refund a settled payment

Refund part or all of a settled payment that belongs to the authenticated merchant.
Send the bearer token from POST /api/public/authorization. Do not send the raw API key.

Generate a new Idempotency-Key for each refund attempt, for example a UUID.
Sending the same key again for this payment returns the original refund and does not pay the customer again, even if amount is different.
A second partial refund needs a new key. Using the same key on a different payment returns 409.
A failed refund stays tied to that key. To try again, send a new key.

The payment must already be settled. acsc with settled: false is not refundable yet.
The payer must still have a saved BSB or PayID. Inbound PayID, destination, bookkeeper, settlement, and redeem rows are refused.

Developer credits are checked only outside production, and only for a developer merchant when credit limits are configured.
One credit is taken after a new Ok or Pending result. A replay and a Failed result do not take a credit.

Error Codes

CodeStatusReasonWhat to do
GN-0000422Idempotency-Key is missingSend a client-generated key, such as a UUID.
GN-0000404Payment initiation not found for this merchantUse a payment_initiation_id owned by the token's merchant.
PI-0003422Amount is zero or negativeSend a positive dollar amount.
PI-0002422Payment cannot be refunded, or the amount is above the remainderConfirm the payment is settled, has no destination, and the payer still has an account. Lower the amount to the remainder.
GN-0000422Already refundedThe full payment amount is already reserved by Ok and Pending refunds.
GN-0000422Refund wallet not foundThe merchant ledger wallet is missing.
GN-0000422Not enough balance to refundRetry later. The platform balance does not cover this amount.
GN-0000409This key was already used for a different paymentSend a new Idempotency-Key.
GN-0000402Developer credits exhaustedNon-production only. Top up credits and retry with the same key only if no refund row was created.
Provider code422The scheme rejected the refundRead message and error_code. Retry only with a new Idempotency-Key.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
payment_initiation
object
required
Headers
string
required

Client-generated label for this refund attempt. A UUID is suitable.
The same value on the same payment returns the stored refund and does not send money again.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json