Skip to main content
POST /v1/payments/void Voids a paid order before the payment is captured or the order confirmed, returning funds to the payer. Supports partial or full void operations.

Request Parameters

voidRequestId
string
required
Merchant-generated unique ID for this void request. Used for idempotence control.Max length: 64 characters
paymentId
string
required
Payment ID of the original authorization to be voided.Max length: 64 characters
voidAmount
object
Specific void payment amount. Defaults to full void if omitted. See Amount.
extendInfo
string
Extension information.Max length: 4096 characters

Response Parameters

result
object
required
Standard result object with resultCode, resultStatus, resultMessage
voidRequestId
string
Merchant’s void request ID.Max length: 64 characters
voidId
string
Wallet-generated unique void ID.Max length: 64 characters

Result Codes