v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
TOKENS

Create a gift card token

Prerequisite: Generate an Ecommerce API key (PAKMS key).

Description: Activates a <<glossary:physical gift card>>. Also, creates and activates a <<glossary:virtual gift card>> with a promotional code.

Tutorial: Create a gift card token.

Next steps: Use the gift card token to create a charge or pay for an order and with the Gift Card API endpoints.

post/v1/tokens

Headers

apikeystring uuid required

Public Ecommerce API key associated with a specific merchant and developer app. Use Retrieve an Ecommerce API key or PAKMS key to generate this key.

User-Agentstring required

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

Request body

Response

Successful response. Gift card token generated.

idstring

Unique identifier of the gift card.

tokenstring

Clover token to perform gift card transactions.