API endpoint overview
Tango API has numerous endpoints to help you perform a variety of activities in your Tango platform. See the list of endpoints below. For detailed information and use cases, refer to their related article in this guide.
Notes:
- Tango API v2 is a RESTful JSON API.
- Tango API authentication is handled via HTTP Basic Auth or OAuth 2.0
- Sandbox URI: https://integration-api.tangocard.com/raas/v2
- Production URI: https://api.tangocard.com/raas/v2
Customers
Use the following endpoints to create and view customers (groups) on the platform. You can manage customers (groups) on your platform. A group is a collection of accounts to hold funds and place orders.
| Endpoints | Description |
|---|---|
GET {URI}/customers | Get a list of all customers on this platform. |
POST {URI}/customers | Create a new customer on this platform. |
GET {URI}/customers/{customerIdentifier} | Get details for a specific customer on this platform. |
For details, refer to our document on Manage customers.
Low balance alerts
Use the following endpoints to set , view, update and delete low balance alerts:
| Endpoints | Description |
|---|---|
POST {URI}/customers/{customerIdentifier}/accounts/ {accountIdentifier}/lowbalance | Set a low balance alert on my account. |
GET {URI}/customers/{customerIdentifier}/accounts/ {accountIdentifier}/lowbalance | Get a list of all low balance alerts for a specific account. |
GET {URI}/customers/{customerIdentifier}/accounts/ {accountIdentifier}/lowbalance/{balanceAlertID} | Get a low balance alert for a specific account under a Customer. |
PATCH {URI} customers/{customerIdentifier}/accounts/ {accountIdentifier}/lowbalance/{balanceAlertID} | Update a low balance alert for a specific account under a Customer. |
DELETE {URI}/customers/{customerIdentifier}/accounts/ {accountIdentifier}/lowbalance/{balanceAlertID} | Delete a low balance alert for a specific account under a Customer. |
For details, refer to our document on Manage low balance alerts.
Accounts
Use the following endpoints to get detailed information, such as balance, for the accounts in your platform. Accounts are nested within groups in Tango and they contain funds.
| Endpoints | Description |
|---|---|
GET {URI}/accounts | Get a list of accounts created on this platform. |
GET {URI}/customers/{customerIdentifier}/accounts | Get a list of all accounts created for a specific customer on this platform. |
GET {URI}/accounts/{accountIdentifier} | Get details for a specific account on this platform. |
POST {URI}/customers/{customerIdentifier}/accounts | Create an account under a specific customer on this platform. |
PATCH {URI}/customers/{customerIdentifier}/accounts/{accountIdentifier} | Update an account under a specific customer on this platform. |
For details, refer to our document on Manage accounts.
Fund
Use the following endpoints to register, fund, and un-register credit cards. Funds are needed to send rewards to the recipients.
| Endpoints | Description |
|---|---|
POST {URI}/creditCardDeposits | Fund an account. |
GET {URI}/creditCardDeposits/{depositId} | Get details for a specific credit card deposit. |
POST {URI}/creditCardUnregisters | Unregister a credit card. |
GET {URI}/creditCards | List all credit cards registered on this platform. |
POST {URI}/creditCards | Register a new credit card. |
GET {URI}/creditCards/{token} | Get details for a specific credit card. |
GET {URI}/transferFunds | Transfer funds. |
For details, refer to our document on Fund your account.
Get exchange rates
Use the following endpoint for exchange rates:
| Endpoint | Description |
|---|---|
GET {URI}/exchangerates | Get a list of exchange rates available for this platform. |
For details, refer to our document Get exchange rates.
Manage catalog
Use the following endpoint to get catalog items:
| Endpoint | Description |
|---|---|
GET {URI}/catalogs | Get all items in the platform's catalog. |
For details, refer to our document in Manage catalog.
Manage Choice products
Use the following endpoint to manage Choice Products such as: Reward Link® (RL), Promo Link ™(PL), and Disbursement Link (DL).
| Endpoint | Description |
|---|---|
GET {URI}/choiceProducts | Get all available Choice products. |
GET {URI}/choiceProducts/{choiceProductUtid}/catalog | Get catalog for a specific Choice product UTID. |
GET {URI}/choiceProducts/{utid} | Get details for a specific Choice product. |
For details, refer to our document Manage Choice products.
Get brand categories
Use the following endpoint to filter a catalog by category such as grocery, beauty, health and wellness, etc. Categories have a Universal Unique Identifier (UUID).
| Endpoint | Description |
|---|---|
GET {URI}/brandCategories | Get all brand categories. |
For details, refer to our document Get brand categories.
Manage countries and currencies
Use the following endpoints to get a list of countries and their preferred currency:
| Endpoint | Description |
|---|---|
GET {URI}/rewardCountries | Get a list of countries in your catalog. |
For details, refer to our document Manage countries and currencies.
Manage digital templates
Use the following endpoints to create, view, update and delete digital templates for reward delivery.
| Endpoints | Description |
|---|---|
GET {URI}/digitalTemplates | Get a list of all digital templates on this platform (email and text messaging). |
POST {URI}/digitalTemplates | Create a new digital template on this platform. |
GET {URI}/digitalTemplates/{etid} | Get details for a specific digital template on this platform. |
DELETE {URI}/digitalTemplates/{etid} | Delete a specific digital template on this platform. |
PATCH \{URI}/digitalTemplates/{etid} | Update details for a specific digital template on this platform. |
For details, refer to our document on Manage digital templates.
Manage orders
Use the following endpoints to create, view, and resend orders.
| Endpoints | Description |
|---|---|
GET {URI}/orders | Get a list of orders placed under this platform. |
POST {URI}/orders | Create an order under a specific account. |
GET {URI}/orders/{referenceOrderID} | Get details for a specific order. |
POST \{URI}/orders/\{referenceOrderID}/resends | Resend a specific order. |
For details. refer to our document on Manage orders.
Manage line items
Orders consist of one or more line items. Each line item represents a single gift card, reward, disbursement, or promotional link and has its unique reference number, customer's first name, last name, email address, dollar amount, etc. Each line item can be managed separately when a request fails due to an undeliverable email or a misspelled recipient's name, for example.
Use the following endpoints to page through or filter a list of line items, including their non-sensitive details and reward status. You can also view details for a specific line item, including sensitive details, reward history, reward redemption, or resend a specific line item.
| Endpoints | Description |
|---|---|
GET {URI}/lineItems | Get a list of line items placed on this platform. |
GET {URI}/lineItems/reasonCodes | Get all reason codes for the reward action (freeze, unfreeze, cancel, and reissue) on this platform. |
GET {URI}/lineItems/{referenceLineItemId} | Get details for a specific line item on this platform. |
PATCH {URI}/lineItems/{referenceLineItemID} | Update a line item on this platform. |
POST {URI}/lineitems/{referenceLineItemID}/cancel | Cancel a line item on this platform. |
POST {URI}/lineitems/{referenceLineItemid}/freeze | Freeze a line item on this platform. |
POST {URI}/lineitems/{referenceLineItemID}/unfreeze | Unfreeze a line item on this platform. |
POST {URI}/lineItems/{referenceLineItemID}/reissue | Reissue a line item on this platform. |
POST {URI}/lineItems/{referenceLineItemId}/resends | Resend a specific line item on this platform. |
For details, refer to our document on Manage line items.
Credential types
Use GET {URI}/credentialtypes to get a list of credential types. There is no parameters for this endpoint.
| Endpoint | Description |
|---|---|
GET {URI}/credentialtypes | Get a list of credential types. |
For details, refer to our document on Get credential types.
Webhooks
We support webhooks in or API. Check out Webhook endpoints for the latest.
Error messages
See Tango Response classes and error messages for more information.
Updated 8 days ago
