v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB

Gift Cards

Void gift card

Void the given gift card.

🔒 Requires: gift_cards:write:issue scope

delete/gift_cards/{number}

Path parameters

numberstring required

The number of the gift card to be voided.

Response

Gift card successfully voided.

balancestring

The balance of the gift card, represented as a string for precision.

created_atstring

The creation timestamp in UTC.

expires_atstring nullable

The expiry timestamp in UTC.

idstring

Auto-generated object ID.

numberstring

The gift card number.

sale_idstring nullable

The ID of the sale associated with the gift card creation, if it was created through a register sale. Null if the gift card was created directly via the API.

sale_sourcestring

The source system where the gift card was created (e.g. x-series, e-series).

status'ACTIVE' | 'INACTIVE' | 'REDEEMED' | 'VOIDED' | 'EXPIRED'

The gift card status.

total_redeemedstring

The amount redeemed with this gift card, represented as a string for precision.

total_soldstring

The amount loaded onto this gift card during activation or reloading, represented as a string for precision.