Void an instrument
Cancels the instrument addressed by the path id, whatever balance remains on it — a supervisor-level, IRREVERSIBLE destruction of a customer’s stored value with no un-void verb. The request takes no body. Reach for it only for a lost, fraudulent or mis-issued card; to consume value against a sale, redeem instead. 404s on an unknown id; 422s when the instrument is already void.
Authorizations
Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.
Path Parameters
1Response
The instrument at status void; its balance is no longer redeemable.
The instrument at status void; its balance is no longer redeemable.
1gift_card, credit_note, store_credit 130 <= x <= 90071992547409910 <= x <= 9007199254740991active, depleted, void 1^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
