Deactivate a gift card
Deactivates the gift card and every card merged into it. The call is idempotent: deactivating a card that is already deactivated returns a successful response.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
Response
Gift card deactivated.
A prepaid balance a shopper spends at the register. It can be digital, tied to a shopper, or backed by one or more physical cards. A gift card belongs to the banner rather than to any one store, and can be sold, redeemed, or reloaded at any of its registers.
Unique identifier for the record.
Current balance on the gift card.
^-?[0-9]+(\.[0-9]+)?$"199.99"
Barcodes on the physical cards backing this gift card, across the card and any cards merged into it.
When the record was created.
When the gift card was deactivated, or null when it is active.
ID of the API credential that deactivated the gift card, or null when it is active or was deactivated by a person.
ID of the employee who deactivated the gift card, or null when it is active or was deactivated by another actor.
ID of the back-office user who deactivated the gift card, or null when it is active or was deactivated by another actor.
Reason recorded when the gift card was deactivated, or null when it is active.
When the gift card was last used in a sale or refund, or null when it has not been used yet.
Account numbers encoded on the magnetic stripe of the physical cards.
ID of the shopper who owns the gift card, or null when it has no owner.
Account numbers printed on the physical cards.
ID of the shopper who purchased the gift card, or null when unknown.
Short human-readable ID for the gift card, shown to shoppers on receipts and messages.
Whether the gift card is active and can be used, or has been deactivated.
active, deactivated When the record was last changed.