ECOMMGIFTCARD

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.

post/scl/v1/balance_inquiry

Request

Base URL
https://scl-sandbox.dev.clover.com
URL
https://scl-sandbox.dev.clover.com/scl/v1/balance_inquiry
Auth
OAuth 2
Authorization code: https://sandbox.dev.clover.com/oauth/authorize
Token URL: https://sandbox.dev.clover.com/oauth/token

Headers

User-Agentstring required

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

Request body

sourcestring required

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

amountinteger

Transaction amount in local currency. Gift card amount.

currencystring

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

promotion_codestring

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

Response

Gift card balance inquiry is successful.

statusstring

Indicates the transaction response.

Changes

No recorded changes to this operation across all 1 revision of this API.