POST

Get Membership Voidability


Developer Preview

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

Retrieves whether a membership charge can be voided.

Wix calls this method before attempting to reverse a charge, for example when an order is about to be canceled or refunded.

Wix uses the response to decide whether to offer the reversal.

Reporting a charge as not voidable doesn't guarantee that no reversal follows: the refund and rollback paths call Void Membership Charge directly. Implement that method to answer for a charge you'd report here as not voidable, rather than assuming it can't arrive.

Your implementation should: Report whether the charge identified by transactionId can still be reversed, and when it can't, give a reason suitable for showing to the person deciding.

Error handling: Report an unrecognized transactionId as TRANSACTION_NOT_FOUND. A charge that exists but can't be reversed isn't an error: return voidable as false with a reason.

Endpoint
POST
{DEPLOYMENT-URI}/v1/get-voidability
Errors
TransactionNotFoundobjectstatus code: 404
Did this help?