Skip to main content
POST

Headers

string
default:"1.2"
required
The API version to use. Supported versions are 1.1 and 1.2.
string
A unique key so a retried request is not processed twice.

Path Parameters

string
required
Credit note number (e.g. CN-8466) or unique ID from which balance is refunded.

Request Body Parameters

number
required
The amount to refund to customer. Cannot exceed remainingAmount.
string
required
Audit reason for issuing the refund (e.g. Customer requested refund for unused service).

Response Body

boolean
Status flag (true on success).
string
Confirmation message (Credit note refund processed successfully).
string
Updated state: PARTIALLY_REFUNDED or REFUNDED.
string
Total cumulative amount refunded to customer.
string
Remaining credit balance available.
array
List of allocations including the newly recorded Airwallex refund allocation entry.
string
Payment gateway refund reference ID (e.g. rfd_sgpvwpnw7hmk2c9sx5s_pihj7h).
string
Gateway status (e.g. RECEIVED).

Response Codes

Last modified on November 10, 2026