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 reload an active gift card with a specified amount.

Prerequisites

1. Merchant selects the Gift card payments checkbox under Ecommerce Payments on the Merchant Dashboard. See Clover Merchant Help.
2. Tokenize the gift card. See Create a gift card token.
3. Generate an Ecommerce API key or apiAccessKey to use as the Authorization header: Bearer token.

Steps

1. Send a POST request to the /v1/reload endpoint to reload an amount to an active gift card.
2. Enter the required parameters in the request based on whether it is a denominated gift card or a non-denominated gift card.

Request and Response example—Reload a gift card

curl --request POST \
  --url 'https://scl-sandbox.dev.clover.com/v1/reload' \
  --header 'authorization: Bearer <authToken>' \
  --header 'content-type: application/json' \
  --data-raw '{
    "source": "clv_1TSxxxxxx2S71ECrva7",
    "amount": 500,
    "currency": "usd"
  }'

{
  "id": "ABC123DE45F6G",
  "amount": 500,
  "ref_num": "151415",
  "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": 92,
    "new_balance": 592
  }
}

Related topics

• Use the Ecommerce Gift Card API
• Create a gift card token tutorial
• Activate a gift card endpoint
• Reload gift card endpoint