API Reference

Create an Order under a specific Account.

post
https://integration-api.tangocard.com/raas/v2/orders
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
length between 0 and 100

Optional. Idempotent field that can be used for client-side order cross reference and prevent accidental order duplication. Will be returned in order response, order details, and order history.

string
required
^[-a-zA-Z0-9]{5,100}$

Specify the customer associated with the order. Must be the customer the accountIdentifier is associated with.

string
required
^[-a-zA-Z0-9]{5,100}$

Specify the account this order will be deducted from

string
required
^[uU][\d]+$

The unique identifier for the reward you are sending as provided in the Get Catalog call

string
enum
required
Defaults to EMAIL

Specify delivery method for the order

Allowed:
number
required
≥ 0

Specify the face value of of the reward. Always required, including for fixed value items.

string
^[pP][\d]+$

Only required for Printed Reward Links, the unique identifier for the Printed Reward Link Template provided in the Tango Portal on the Printed Template page.

sender
object

Optional. Use to set the sender’s name and email address if different than the default platform setting.

recipient
object

Required if deliveryMethod is EMAIL, PHONE, or ADDRESS. May be required for some UTIDs. Use to set and store the recipient’s contact information. When deliveryMethod is NONE or EMBEDDED, setting these parameters will allow the platform to store this information for reporting, auditing, and reconciliation.

string

Optional. Used with deliveryMethod is EMAIL. The ETID email subject will be used for the specified reward if not specified.

string

Optional gift message

boolean
deprecated

Deprecated Oct 1, 2025. Should Tango Card send the email to the recipient?

string
^[eE][\d]{6}$

Optional. Used with deliveryMethod of EMAIL or PHONE. The unique identifier for the electronic template you would like to use. If not specified, the system will use the default etid.

string
length between 0 and 1024

Optional. Campaign that may be used to administratively categorize a specific order. Must be between 0 and 1024 characters in length.

string

The Purchase Order Number associated with this order.

string
length between 0 and 1024

Optional order notes. Must be between 0 and 1024 characters in length.

string

Optional for Promo Links, the exact calendar date the Promo Link will expire.

customFields
object

Optional. A map of custom field key-value pairs configured at the account level for your platform. Only fields that have been configured for the account are accepted — any fields passed that are not configured will be silently ignored. Fields marked as required in the configuration must be provided; omitting a required field will result in a validation error. Fields marked as optional may be omitted. If no custom fields have been configured for the account, this property can be omitted entirely.

Responses

Updated 3 months ago

Language
Credentials
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

© 2026 Tango API are provided by Tango, a division of BHN, Inc.