Skip to main content
POST /v1/payments/void Voids a paid (authorized) order before the payment is captured or the order is confirmed by the merchant or payer, returning the money to the payer. Two types are supported:
  • Partial void: returns part of the payment amount to the payer without changing the order status. A timeout applies to the remaining amount; when it expires, the remaining amount is voided or confirmed automatically.
  • Full void: closes the order automatically.

Request Parameters

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

Response Parameters

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

Result Handling

Result Codes

Sample

Request

Response