Gift Cards

1.00
REST API
Retailing Solutions

Gift Cards APIs

Target Audience
Retailing Solutions
API Version
1.00
Authentication
Security Credentials

The Gift Cards APIs allow developers to manage gift cards for campaigns, stores, departments, client, operators, and users.

 

What is it?

The Gift Cards v1 and v3 API versions are both active and available to use. The v3 API enhances and extends the API options. You can use the v1 and v3 endpoints to manage gift cards in the following ways:

  • Create, update, and delete gift cards.
  • Perform transactions (credit, debit, top up) on gift cards.
  • Create, update, and delete Transaction reasons.
  • Create, update, and delete Campaigns.
  • Create, update, and delete Clients.
  • Create, update, and delete Stores.
  • Create, update, and delete Departments.
  • Create, update, and delete Operators.
  • Generate reports.

 

How to use

Use the following links to download the Gift Cards v1 and v3 API specifications (in YAML format), which explain how to use all of the endpoints: