v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
ECOMMGIFTCARD

Request gift card balance

Retrieves the current balance on an active gift card. For more information, see Use the gift card API.

Note: To view detailed information about the Gift Cards Dashboard, including activation, balance, and liability reports, see Clover Help. Gift Card customers can also download and use the Gyft app to manage their digital gift cards and check their gift card balances conveniently.

post/v1/balance_inquiry

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

Request body

sourcestring required

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

Response

Successful response. Returns the gift card balance.

statusstring

Indicates the transaction response.