Quick Start Guide (RaaS API-v2)
Try it yourself!
You can check our new Sandbox Test Console and get right to the code!
The old Test Console can still be used but does not include the latest endpoints released after September 2022.
Welcome to Tango Card, Inc! At Tango Card, we provide Rewards as a Service (RaaS®) API for our customers who want to provide powerful rewards and incentives, using digital gift cards, in your apps and platforms. With (RaaS®) API, you can easily integrate a reward catalog and automate reward delivery. The most used (RaaS®) API methods include posting accounts and funds, getting a verbose catalog, and posting orders.
This quick start guide is intended for our users to access all the information they need quickly and at one glance. For more detailed information, refer to our complete User Guide: Tango Card RaaS API-v2.
Get Started
To get started, you need to:
- Set up a Tango Card Account
- Set up Work Environment
- Authenticate with API
- Determine Your Organizational Model
- Use API Functions
- Check our Sample API
- Ask for Assistance
Set up Tango Card Account
To get started, you need an account with Tango Card to generate an API key. If you don't already have an account, create one here on our website. For more details, see our content: Set up a Tango Card Account.
Set up Work Environment
We provide you with a sandbox test account and a production account. Tango Card’s sandbox is a fully functional mirror of Tango Card’s production API with a notable exception that account funds, reward codes, etc. are not real. Our Sandbox allows you to test comprehensively and risk-free prior to production deployment. Please note sandbox testing is not a replacement for production testing.
- Sandbox URI: https://integration-api.tangocard.com/raas/v2
- Production URI: https://api.tangocard.com/raas/v2
For details, see Set up Work Environment. Check out our Sandbox Test Console and get right to the code!
Authenticate with API
All communication with Tango Card’s RaaS API must be authenticated. For details, see Authenticate with API.
Determine Your Organization Model and Platform
Our API can support both enterprise structures with multiple reward budgets and simple structures involving just one account. We'll set up your platform and provide you with the access credentials. Once you have your credentials, you can use the API to create Customers and Accounts according to your desired platform configuration.
For reference, see Determine Your Organizational Model.
Note:
To sign up for system alerts, upcoming maintenance, item outages, etc., or view current system status, visit our Status Page.
Use API Functions
Tango Card offers the following API functions and endpoints. For more details, see the table below:
| Function | Purpose | EndPoints |
|---|---|---|
| Manage Customers | To get the list of customers (Groups), create a new customer, get details for a specific customer, get list of all accounts created for a customer, and create an account for a customer. | GET {URI}/customers POST {URI}/customers GET {URI}/customers/{customerIdentifier}/accounts POST {URI}/customers/{customerIdentifier}/accounts GET {URI}/customers/{customerIdentifier} |
| Manage Accounts | To get a list of accounts and the details for a specific account, such as balance, created on your platform. | GET {URI}/accounts GET {URI}/accounts/{identifier} |
| Fund Your Account | To register credit cards for production and sandbox, receive email receipts, fund your account and get deposit details, unregister a credit card, and more. | GET {URI}/creditCards POST {URI}/creditCards POST {URI}/creditCardUnregisters POST {URI}/creditCardDeposits GET {URI}/creditCards/{token} GET {URI}/creditCardDeposits/{depositId} |
| View Catalog | To view the items in your catalog. | GET {URI}/catalogs |
| Manage Orders | An order is sending rewards to recipients. With Rewards Genius, orders can send multiple rewards to multiple recipients. Using the API, however, an order can only send one reward to one recipient. Order endpoints pertain to creating, viewing, and resending orders. | GET {URI}/orders POST {URI}/orders POST {URI}/orders/{referenceOrderID}/resends GET {URI}/orders/{referenceOrderID} |
| Manage Line Items | Orders consist of one or more line items. Each line item represents a single gift card, reward, disbursement, or promotional link | GET {URI}/lineItems GET {URI}/lineItems/{referenceLineItemId} POST {URI}/lineItems/{referenceLineItemId}/resends |
| Manage Email Templates | Calls pertaining to creating, viewing, updating and deleting email templates for reward delivery. | GET {URI}/emailTemplates POST {URI}/emailTemplates GET {URI}/emailTemplates/{etid} DELETE {URI}/emailTemplates/{etid} PATCH {URI}/emailTemplates/{etid} |
| Get Exchange Rates | Additionally, via Tango Card's API, you can find out the exchange rate for international rewards, or determine the health of the system. Exchange rates provides a list of exchange rates currently set in the Tango Card system. Can be used for calculating the cost of international rewards. | GET {URI}/exchangerates |
| Get Credential Types | Get a list of credential types | GET {URI}/credentialtypes |
Check Our Sample API
For more work samples, Check out Sample API.
Ask for Assistance
Reach out to our Customer Success Manager or email [email protected] and include the X-REQUEST-ID response header for the transaction in question, when applicable, along with the details of your concern.
Sensitive Information
Do not send us sensitive information such as platform credentials, reward credentials, code, etc. via email. We look up the necessary details using the X-REQUEST-ID. If needed, we will contact you for additional information.
Updated 14 days ago