This endpoint requires the gift-cards.read or embed scope.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Filters the results to only the items for which the buyer has an
id that matches this value.
buyer_external_identifier
Filters the results to only the items for which the buyer has an
external_identifier that matches this value.
A list of gift cards in a short format including the latest balance.
A list of stored gift cards.
The type of this resource.
Available options:
gift-card
The ID of this gift card.
items. merchant_account_id
The unique ID for a merchant account.
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 amount remaining on the balance for this gift card according to the
gift card service. This may be null if the balance could not be fetched.
Required range: 0 < x < 99999999
The ISO-4217 currency code that this gift card has a balance for.
If the last balance update failed, this will contain the
internal code for this error.
Available options:
expired_card,
inactive_card,
incorrect_currency,
insufficient_funds,
invalid_amount,
invalid_gift_card,
invalid_service_configuration,
invalid_service_credentials,
operation_canceled,
service_error,
service_network_error,
unknown_error
items. balance_raw_error_code
If the last balance update failed, this will contain the
the raw error code received from the gift card provider.
items. balance_raw_error_message
If the last balance update failed, this will contain the
the raw error message received from the gift card provider.
