---
title: "Request gift card balance"
method: POST
path: "/v1/balance_inquiry"
tags: ["ECOMMGIFTCARD"]
---

# Request gift card balance

`POST /v1/balance_inquiry`

Retrieves the current balance on an active gift card. For more information, see [Use the gift card API](https://docs.clover.com/docs/gift-card-api).

**Note:** To view detailed information about the Gift Cards Dashboard, including activation, balance, and liability reports, see [Clover Help](https://www.clover.com/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.

## Headers

- `User-Agent` string, required

## Request body

- object
  - `source` string, required — Single-pay Clover gift card token (cToken) indicating the gift card details and metadata.

## Response `200`

Successful response. Returns the gift card balance.

- EcommGiftCardResponse — Gift card data.
  - `status` string — Indicates the transaction response.
  - `gift_card` EcommGiftCardResponseExtra — Indicates meta data of the gift card.
    - `previous_balance` integer — Indicates the previous balance before the transaction was initiated.
    - `new_balance` integer — Indicates the updated balance after the transaction is completed.
    - `lock_amount` integer — Indicates the value on the card that was locked due to a balance lock transaction.
    - `expiration_date` string — Indicates the account expiration date.
    - `lock_id` integer — Unique lock number identifier for each balance lock record. The `lock_id` helps capture the authorized amount and is applicable for pre-auth and capture flow.
    - `number` string — Embossed card number on the gift card or the ift card number. Only applicable for virtual gift card activation.
    - `security_card_value` string — Gift card security code. Only applicable for virtual gift card activation.

## Other responses

- `400` — Bad request.
- `default` — Error response.

---

[API](https://skmtc.net/clover/apis/platform-api.md) · [All operations](https://skmtc.net/clover/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/clover/platform-api/revisions/08da265101a3/schema)