Create an Order under a specific Account.

post

https://integration-api.tangocard.com/raas/v2/orders

Body Params

externalRefID

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.

customerIdentifier

string

required

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

accountIdentifier

string

required

Specify the account this order will be deducted from

utid

string

required

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

deliveryMethod

string

enum

required

Defaults to EMAIL

Specify delivery method for the order

Allowed:

amount

number

required

≥ 0

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

ptid

string

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.

emailSubject

string

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

message

string

Optional gift message

sendEmail

boolean

deprecated

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

etid

string

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.

campaign

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.

purchaseOrderNumber

string

The Purchase Order Number associated with this order.

notes

string

Optional order notes (up to 150 characters)

expirationDate

date-time

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

Responses

200OK / Existing order found for given external ref ID

201Created

400Bad Request

401Unauthorized

402Insufficient Funds

403Forbidden

409Conflict; Duplicate Exists

422Unprocessable Entity

429Exceeded the allowable TPS rate limit

503Service Unavailable