Skip to main content
POST
Verify and check gift card balances
This endpoint requires the gift-cards.read scope.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

A request to check the balance for a set of stored and non-stored gift cards.

items
(Gift Card Balance (New) · object | Gift Card Balance (Stored) · 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.

Minimum array length: 1

Check the balance for a non-stored gift card.

Response

Returns the balances for each of the gift cards. Balances are returned in the same order they are requested.

A list of gift cards in a short format including the latest balance.

items
A stored gift card (summary) · object[]

A list of stored gift cards.