API endpoint overview

Tango API has numerous endpoints to help you perform a variety of activities in your Tango platform. These endpoints are presented here at an overview level. For detailed information on each endpoint, refer to their related article in this guide.

πŸ“˜

Notes:

Customers

Use the following endpoints to create and view customers (groups) on the platform. These calls include details for all customers and accounts under a platform but not the balance and contact information for the accounts.

EndpointsDescription
GET {URI}/customersGet a list of all Customers on this Platform.
POST {URI}/customersCreate a new Customer on this Platform.
GET {URI}/customers/{customerIdentifier}/accountsGet a list of all Accounts created for a specific Customer on this Platform.
POST{URI}/customers/{customerIdentifier}/accountsCreate an Account under a specific 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.

Accounts

Use the following endpoints to get detailed information, such as balance, for the accounts in your platform.

EndpointsDescription
GET {URI}/accountsGet a list of Accounts created on this Platform.
GET {URI}/accounts/{identifier}Get details for a specific Account 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.

EndpointsDescription
GET {URI}/creditCardsList all credit cards registered on this Platform.
POST {URI}/creditCardsRegister a new Credit Card.
POST {URI}/creditCardUnregistersUnregister a Credit Card.
POST {URI}/creditCardDepositsFund an Account.
GET {URI}/creditCards/{token}Get details for a specific Credit Card.
GET {URI}/creditCardDeposits/{depositId}Get details for a specific Credit Card Deposit.

For details, refer to our document on Fund your account.

Catalogs

Use the following endpoint to view the items in your catalog, along with the details to order items and display the item information.

πŸ“˜

Note:

UTID is Unique Tango ID {{utid}} for the item being ordered such as Gift Cards or NPO or nonprofit donations.

EndpointDescription
GET {URI}/catalogsGet all items in the platform's catalog.

For details, refer to our document on View catalog.

Orders

Use the following endpoints to create, view, and resend orders.

EndpointsDescription
GET {URI}/ordersGet a list of Orders placed under this Platform.
POST {URI}/ordersCreate an Order under a specific Account.
POST {URI}/orders/{referenceOrderID}/resendsResend a specific Order.
GET {URI}/orders/{referenceOrderID}Get details for a specific Order.

For details. refer to our document on Manage orders.

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.

EndpointsDescription
GET {URI}/lineItemsGet a paged list of line items.
GET {URI}/lineItems/{referenceLineItemId}Get details for a specific line item.
POST {URI}/lineItems/{referenceLineItemId}/resendsResend a specific line item.

For details, refer to our document on Manage line items.

Email templates

Use the following endpoints to create, view, update and delete email templates for reward delivery.

EndpointsDescription
GET {URI}/emailTemplatesGet a list of all Email Templates on this Platform.
POST {URI}/emailTemplatesCreate a new Email Template.
GET {URI}/emailTemplates/{etid}Get details for a specific Email Template on this Platform.
DELETE {URI}/emailTemplates/{etid}Delete a specific Email Template on this Platform.
PATCH {URI}/emailTemplates/{etid}Update details for a specific Email Template on this Platform.

For details, refer to our document on Manage email templates.

Exchange rates

Use GET {URI}/exchangerates endpoint tp provide a list of exchange rates currently set in the Tango system. Use the following endpoint to calculate the cost of international rewards.

EndpointDescription
GET {URI}/exchangeratesGet a list of exchange rates.

For details, refer to our document on Get exchange rates.

Credential types

Use GET {URI}/credentialtypes to get a list of credential types. There is no parameters for this endpoint.

EndpointDescription
GET {URI}/credentialtypesGet a List of Credential Types

For details, refer to our document on Get credential types.

Response code

For the health check of above functions, use '/pulse' endpoint to determine whether the system is healthy or not. When the response is 200, for example, the system is OK.

ResponseDescription
200OK
400Bad request
401Unauthorized
403Forbidden