POST

Void Transaction


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

This endpoint is used to send requests to void transactions to a Payment Service Provider (PSP).

Wix calls this endpoint to void a transaction. Learn more about implementing this endpoint.

Body Params
wixTransactionIdstringRequiredformat GUID

Wix transaction ID.


pluginTransactionIdstringRequiredminLength 1maxLength 200

PSP transaction ID.


voidAmountintegerRequired

Total amount to void in a currency’s minor units. This must be the same as the authorized amount. Learn more about currencies.


merchantCredentialsMap <string, string>Requiredformat map

Credentials that the PSP provided when the merchant connected their account.

Response Object
reasonCodeinteger

Wix reason code indicating a failed request.


errorCodestringmaxLength 50

PSP-specific error code.


errorMessagestringmaxLength 300

PSP-specific error message.

Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?