Store gift card
Stores a gift card.
Vaulting a gift card stores and validate it against the active gift card service.
It is only possible to store a gift card against a buyer if the same card is not already stored on the buyer and the gift card has not expired yet.
Buyers by default can only have a maximum limit of 10 gift cards stored against
them. Please contact our team to change this limit. To clear out any expired or
empty gift cards, you can call the GET /buyers/gift-cards endpoint which will
automatically archive any of those cards and allow new cards to be stored.
This endpoint requires the gift-cards.write scope.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The gift card details to store.
The 16-19 digit number for this gift card.
16 - 19The PIN for this gift card.
The ID of the buyer to associate this gift card to. If this field is
provided then the buyer_external_identifier field needs to be unset.
The external_identifier of the buyer to associate this gift card
to. If this field is provided then the buyer_id field
needs to be unset.
Response
A gift card stored for a buyer, or used in a transaction.
The type of this resource.
gift-card The ID of this gift card.
The unique ID for a merchant account.
An configured gift card service.
The first 6 digits of the full gift card number.
The 3 digits after the bin of the full gift card number.
The last 4 digits for the gift card.
The date and time when this gift card expires. This is a full date/time and may be more accurate than the actual expiry date received by the gift card service.
The optional buyer for which this payment method has been stored.
The date and time when this gift card was created in our system.
The date and time when this gift card was last updated in our system.
Was this page helpful?