Gift card balance inquiry

Displays the current balance of an existing virtual gift card:

If a currency code is specified, the current balance displays in that currency and the base currency if they are different.
If no currency code is specified, the current balance displays in the base currency.

Important: Information for Gift Card Holders
This page contains technical API documentation for software developers. It cannot be used to check your gift card balance.

To check your gift card balance, please download and use the Gyft app.

For merchant-facing information about Gift Cards reporting, see the Clover Help site.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
<!--DS-7160: Hide this ednpoint as suggested by SME (Ipsita Hota)-->
Body Params

Displays the meta data of gift card.

string
required

Single-pay Clover gift card token (cToken) indicating the gift card details and metadata.

integer

Transaction amount in local currency. Gift card amount.

string

Three-letter ISO 4217 currency code.
Format: Lower case
Length: Maximum 3

string

Virtual promotional code of the gift card.
Note: Applicable only for gift card virtual activation, if the promo code is not already configured.

Headers
string
required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <product> / <product-version> <comment>

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json