Gift cards
Verify and get gift card balances
Verify gift cards are enrolled and fetch their balances.
This verifies a list of gift cards are enrolled for your gift card programme, if this feature is available via your gift card service. It then also fetches each card’s current balance.
Duplicated gift card numbers are not supported. This includes both stored gift cards, as well as those directly provided via the request.
POST
/
gift-cards
/
balances
This endpoint requires the gift-cards.read
scope.
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
items
object[]
One or more gift cards to check balances for, up to a default limit of 10 gift cards. Please contact our team to change this limit.
Response
200 - application/json
items
object[]
A list of stored gift cards.
Was this page helpful?