---
updatedAt: 2026-06-17T21:00:13.000Z
agentTools:
  projectIndex: https://docs.clover.com/dev/llms.txt
---

# Redeem a gift card

[block:html]
{
  "html": "<!--2024.Apr.8: Added RegionIcon-US-CAN reusable content to replace long form html -cd\n<!--2024.Jul.2: DS-6674 changed paramer label from \"card_number\" to \"number\" -cd-->\n<!--2024-Sept-20: Created new standalone topic.-->"
}
[/block]

[block:html]
{
  "html": "<div class=\"container-top\"> \n  <!--North America-US and Canada-->\n  <div class=\"container-reg\">\n    <div class=\"pill-reg\">\n      <div class=\"label-reg\">North America—United States and Canada</div>\n    </div>\n  </div>\n</div>\n<!--syles in global css-->"
}
[/block]

[block:html]
{
  "html": "<div>\n <div class=\"top-container\">\n    <div class=\"topnav\">\n      <a href=\"https://docs.clover.com/dev/docs/generate-ecommerce-api-key-or-pakms-key\">Generate an Ecommerce API key (PAKMS key)</a>\n      <a href=\"https://docs.clover.com/dev/docs/create-a-gift-card-token\">Create a gift card token</a>\n      <a href=\"https://docs.clover.com/dev/docs/gift-card-api\">Use the Ecommerce Gift Card API</a>\n    </div>\n  </div>\n</div>\n\n<!--css-->\n<style>\n/* Add a background color to the top navigation */\n.topnav {\n  font-family: 'Graphik-Regular', sans-serif;\n  background-color: #5D5D5D;\n  overflow: hidden;\n}\n\n/* Style the links inside the navigation bar */\n.topnav a {\n  font-family: 'Graphik-Regular', sans-serif;\n  float: left;\n  color: #f2f2f2;\n  text-align: center;\n  padding: 10px 12px;\n  text-decoration: none;\n  font-size: 12px;\n}\n\n/* Change the color of links on hover */\n.topnav a:hover {\n  background-color: #D8D8D8;\n  color: black;\n}\n\n/* Add a color to the active/current link */\n.topnav a.active {\n  background-color: #5D5D5D;\n  color: white;\n}\n</style>"
}
[/block]

# Overview

A gift card is a prepaid payment card used for purchases at participating restaurants, stores, or online retailers, available in various denominations. Depending on the issuer’s terms, you can redeem these cards for services, merchandise, or cash.

Clover native gift cards managed through the Fiserv payment gateway, are integrated into the Clover point of sale (POS) system for seamless transactions. Physical gift cards have a 4-8 digit security card value (SCV), while virtual gift cards use a promo code.

You can use the complete or partial value on an active gift card for a transaction. If the requested charge amount to use or redeem is greater than the gift card account balance, the account balance is reduced to zero (0). In this case, the gift card account may be closed, and a split tender payment may be requested. A split tender request prompts the customer to pay the difference between the [gift card account balance](https://docs.clover.com/dev/docs/ecomm-check-and-use-gift-card-balance) and the requested amount.

***

# Prerequisites

1. Merchant selects the **Gift card payments** checkbox under Ecommerce Payments on the Merchant Dashboard. See Clover Merchant Help.
2. [Generate a merchant-specific API token](https://docs.clover.com/dev/docs/create-ecommerce-api-tokens).
3. Tokenize the gift card. See [Create a gift card token](https://docs.clover.com/dev/docs/create-a-gift-card-token).

# Steps

1. Send a POST request to the `/v1/charges` endpoint to redeem the gift card value.
2. Enter the required parameters in the request based on whether it is a <<glossary:denominated gift card>> or a <<glossary:non-denominated gift card>>.

[block:parameters]
{
  "data": {
    "h-0": "Field",
    "h-1": "Type",
    "h-2": "Description",
    "h-3": "Required/Optional",
    "0-0": "`source`",
    "0-1": "string",
    "0-2": "Single-pay Clover gift card token (token) indicating the gift card details and metadata.",
    "0-3": "Required.",
    "1-0": "`amount`",
    "1-1": "integer",
    "1-2": "Amount to redeem on the gift card.",
    "1-3": "Required.",
    "2-0": "`currency`",
    "2-1": "string",
    "2-2": "Three-letter <a href=\"https://www.iso.org/iso-4217-currency-codes.html\" target=\"_blank\">ISO 4217 currency code</a>.  \nFormat: Lowercase  \nLength: Maximum 3 characters",
    "2-3": "Required.",
    "3-0": "`capture`",
    "3-1": "boolean",
    "3-2": "Set as **True** to immediately capture the amount to redeem on the gift card.",
    "3-3": "Optional.",
    "4-0": "`partial_redemption`",
    "4-1": "boolean",
    "4-2": "Set as:  \n  \n- **True** to redeem a partial amount on the gift card balance.\n- **False** to redeem the complete gift card balance.",
    "4-3": "Optional."
  },
  "cols": 4,
  "rows": 5,
  "align": [
    "left",
    "left",
    "left",
    "left"
  ]
}
[/block]

# Request and Response examples

## Redeem gift card with sufficient balance

```curl Request:
curl --request POST \
--url 'https://scl-sandbox.dev.clover.com/v1/charges' \
--header 'authorization: Bearer <authToken>' \
--header 'content-Type: application/json' \
--data-raw '{
   "source": "clv_1TSxxxxxx2S71ECrva7",
   "amount": 100,
   "currency": "usd",
   "capture": "true",
   "partial_redemption": "true",
   }
```
```json Response
{
   "id": "ABC123DE45F6G",
   "amount": 100,
   "payment_method_details": "giftCard",
   "amount_refunded": 0,
   "captured": true,
   "ref_num": "308196",
   "outcome": {
       "network_status": "approved_by_network",
       "type": "authorized"
   },
   "paid": true,
   "status": "succeeded",
   "source": {
       "id": "clv_1TSxxxxxx2S71ECrva7",
       "last4": "5003"
   },
   "partial_auth": true,
   "gift_card": {
       "expiration_date": "2030-01-01",
       "previous_balance": 500,
       "new_balance": 400
   }
}
```

## Redeem gift card with insufficient balance or non-sufficient funds (NSF)

If the value of a gift card is less than the charge amount, you can request partial approval to redeem the available amount on an active gift card. The request is not declined for insufficient balance, but the account is reduced to 0 (zero) and may be closed.

```curl Request
curl --request POST \
--url 'https://scl-sandbox.dev.clover.com/v1/charges' \
--header 'authorization: Bearer <authToken>' \
--header 'content-Type: application/json' \
--data-raw '{
   "source": "clv_1TSxxxxxx2S71ECrva7",
   "amount": 100,
   "currency": "usd",
   "capture": "true",
   "partial_redemption": "false",
}
```
```json Response
{
   "id": "CKK5GVZBHB1GA",
   "amount": 10,
   "payment_method_details": "giftCard",
   "amount_refunded": 0,
   "currency": "usd",
   "created": 1681705896145,
   "captured": true,
   "ref_num": "308942",
   "auth_code": "445869",
   "warning_message": "partial_redemption should be true for gift card",
   "outcome": {
       "network_status": "approved_by_network",
       "type": "authorized"
   },
   "paid": true,
   "status": "succeeded",
   "source": {
       "id": "clv_1TSxxxxxx2S71ECrva7",
       "last4": "5003"
   },
   "gift_card": {
       "expiration_date": "2030-01-01",
       "previous_balance": 500,
       "new_balance": 400
   }
}
```

***

# Related topics

* [Use the Ecommerce Gift Card API](https://docs.clover.com/dev/docs/gift-card-api)
* [Create a gift card token](https://docs.clover.com/dev/docs/create-a-gift-card-token) tutorial
* [Activate a gift card](https://docs.clover.com/dev/docs/ecomm-activate-a-gift-card) tutorial
* [Check gift card balance](https://docs.clover.com/dev/docs/ecomm-check-and-use-gift-card-balance) tutorial
* [Create a charge](https://docs.clover.com/dev/reference/createcharge) endpoint