Release NotesAnnouncementsBlogFAQSupport
API Reference

Create and activate physical and virtual gift card

post
https://scl-sandbox.dev.clover.com/v1/activate

Activates a physical or virtual 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Single-pay Clover gift card token (cToken) indicating the gift card details and metadata.
Note: The source parameter is not required for virtual gift cards.

integer
required

The amount to activate on the gift card in the local currency.

string
required

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

string

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

Headers
string
required

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

Responses

Updated 3 months ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago