Documentation

Create an order under a specific account

Suggest Edits

Use the following endpoint to create an order under a specific account.

EndpointPurpose
POST {URI}/ordersCreate an Order under a specific Account.

The POST {URI}/orders endpoint has a 1 TPS rate limit. If you receive an error when placing an order, wait for 1 second and try again with the same externalRefID.

📘

Note:

  • (🚧 Coming soon) This endpoint will soon be modified to include deliveryMethod and recipient's mobileNumber as body parameters. Once released, you can deliver rewards to your recipients using delivery methods such as PHONE, ADDRESS, and EMBEDDED as well as EMAIL.
  • (🚧 Coming soon) Currently, digital orders do not require a shipping address. If an address is included with a digital order, it will trigger a validation error. However, this behavior is changing soon. You will be able to submit any recipient contact information—such as email, phone number, or physical address—regardless of the delivery method. The system uses the deliveryMethod to determine how the orders should be delivered. If deliveryMethod is not provided, but a recipient address is present, the API sets the deliveryMethod=ADDRESS before processing the order. Some digital cash options may still require a physical address. If deliveryMethod is ADDRESS, then the system expects a valid physical address to fulfill the order.
  • Order requests receiving a 5XX error may occasionally process after a network connection is lost. We strongly recommend you use the externalRefID idempotent parameter to ensures duplicate orders are not created when you retry a failed order. See our Best practices topic regarding External Reference ID idempotent parameter.

Here is a list of body parameters to help you create an order under a specific account. The recipient address object is required for physical rewards only. For digital orders, the recipient address must be excluded or set to null.

Body paramsData typeRequirementDescription
externalRefIDstringoptionalAn idempotent field that can be used for your order cross-reference and to prevent accidental order duplication. This value is returned in order response, order details, and order history. The string has a maximum of 100 alphanumeric characters.
customerIdentifierstringrequiredSpecify the customer associated with the Order. Must be the customerIdentifier the accountIdentifier is associated with.
The string must have 5-100 characters.
accountIdentifierstringrequiredSpecify the account this order will be deducted from.
The string must have 5-100 characters.
utidstringrequiredThe unique identifier for the reward you are sending as provided in the GET {URI}/catalogs endpoint. The UTID must be in your platform catalog (and not just in a Tango Choice product catalog) to place the order.
ptidstring*requiredOnly required for Printed Reward Links. PTID is a unique identifier for the Printed Reward Link Template provided in the Tango portal on the Printed Template page.
amountdoublerequiredSpecify the face value of the reward. Always required, including for fixed-value items. The amount is stored as a double-precision floating point number.
senderobjectoptionalUse to set the sender’s name and email address if different than the default platform setting. This information is for tracking purposes only and doesn’t change the email address the reward is sent from when sendEmail: true. You cannot use < or > or / in the name.
-firstNamestringoptionalalways optional, string, 100 characters max
-lastNamestringoptional always optional, string, 100 characters max
-emailstringoptionalalways optional, string
recipientobject*requiredRequired if sendEmail is true. Use to set and store the recipient name and email address. When sendEmail is false, setting these parameters will allow the platform to store this information for reporting, auditing, and reconciliation.
-firstNamestring*requiredRequired if sendEmail is true, or when ordering physical rewards. The recipientFirstName may have up to 100 characters for digital rewards.
You cannot use < or > or / in the name.
If a physical reward, it may have up to 25 characters, cannot be blank, no mustache tag is allowed. Can use digits (0-9), alphabet (a-z, A-Z), space, period (.), comma (,), ampersand (&), and hyphen (-).
-lastNamestring*requiredRequired for physical gift card, otherwise optional. The recipientLastName may have up to 100 characters for digital rewards.
You cannot use < or > or / in the name.
If a physical reward, it may have up to 25 characters, cannot be blank, no mustache tag is allowed. Can use digits (0-9), alphabet (a-z, A-Z), space, period (.), comma (,), ampersand (&), and hyphen (-).
-emailstring*requiredRequired if sendEmail is true, or deliveryMethod is EMAIL. The email address is up to 100 characters max.
-mobileNumber
(🚧 Coming soon)		string*requiredRequired if deliveryMethod is PHONE. The following validation rules apply to mobile numbers for SMS delivery:

-Country code: Must be included.
-Format: +CCCPPPPPPPPPPPP (where C is the country code, 1-3 digits, and P is the phone number, up to 12 digits).
-Initial release: Only accepts US phone numbers (Country code = +1) and 10 digits for the phone number.
-Standard: Follows ITU E.164, allowing (+) and up to 15 digits for the combined country code and phone number.
-addressobject*requiredRequired for physical rewards. The following validation rules apply to addresses:

-Physical rewards: Address is required.
-Digital orders: Address field must be excluded or set to null. Providing an address for digital orders will result in validation failure.
-❗️Disclaimer: When ordering a physical gift card, ensure the physical address of your reward recipients is validated before sending it to Tango. Tango does not accept responsibility for incorrect addresses.
-NOTE: Do not pass an address object when the reward is digital.
-streetLine1string*required for physical rewards not applicable for digital rewardsThe following validation rules apply:
-Physical Rewards: Address is required.
-Digital rewards: Address is not applicable.
-Character limit: Address may have up to 35 characters.
-Content: Address cannot be blank and can include digits (0-9), alphabet (a-z, A-Z), space, period, comma, hyphen, forward slash (/), ampersand (&), percent (%), pound (#), at (@), and apostrophe (').
-streetLine2string*optional for physical rewards not applicable for digital rewardsThe following validation rules apply:
-Physical rewards: Address is optional.
-Digital rewards: Address is not applicable.
-Character limit: Address may have up to 35 characters.
-Content: Address cannot be blank and can include digits (0-9), alphabet (a-z, A-Z), space, period, comma, hyphen, forward slash (/), ampersand (&), percent (%), pound (#), at (@), and apostrophe (').
-citystring*required for physical rewards not applicable for digital rewardsThe following validation rules apply:
-Physical rewards: Address is required.
-Digital rewards: Address is not applicable.
-Character limit: Address may have up to 30 characters.
-Content: Address cannot be blank and can include digits (0-9), alphabet (a-z, A-Z), space, period, hyphen, ampersand (&), and apostrophe (').
-stateOrProvincestring*required for physical rewards not applicable for digital rewardsThe following validation rules apply:
-Physical rewards: Address is required.
-Digital rewards: Address is not applicable.
-Address region: Must be a valid 2-character uppercase abbreviation for a US state, territory, or military base, a Canadian province, or contain an international region less than 36 characters.
-postalCodestring*required for physical rewards not applicable for digital rewardsThe following validation rules apply:
-Physical rewards: Address is required.
-Digital rewards: Address is not applicable.
-Content: Address cannot be blank and may include digits (0-9) and alphabet (a-z, A-Z).
-US addresses: Must include the five-digit US ZIP Code only.
-countrystring*required for physical rewards not applicable for digital rewards-Physical rewards: Country is required.
-Digital rewards: Country is not applicable.
-Country: Must be a valid 2-character abbreviation
emailSubjectstringoptionalIf not specified, a default email subject will be used for the specified reward.
messagestringoptionalGift message. The string may have up to 1024 characters.
sendEmailboolean-Specify whether sendEmail is set to true or false—in other words, will Tango send the email to recipients?
-Tango does not deliver the reward email when sendEmail=false. When placing orders, you are responsible for delivering rewards if sendEmail=false.
-🚧 Coming soon: sendEmail will be deprecated soon. It will only appear in the payload once the deliveryMethod parameter is released.
deliveryMethod
(🚧 Coming soon)		stringrequiredSpecify delivery method for the order. We have introduced various ways of reward delivery to your recipients through deliveryMethod:
-NONE: You are responsible to deliver the rewards to your recipient. This option is similar to sendEmail=false.
-EMAIL: Tango sends email to deliver the rewards to your recipient. This option is similar to sendEmail=true.
-PHONE: Tango sends SMS to deliver the rewards to your recipient.
-ADDRESS: Tango delivers the physical rewards via carriers such as the post office, FexEx, UPS, etc.
-EMBEDDED: You will embed Tango's lading page into your application.
etidstringoptionalETID is the unique identifier for the email template you would like to use. Only applicable if sendEmail=true.
campaignstringoptionalCampaign that may be used to group orders under a particular campaign. The maximum length is 1024 characters including the special characters such as @, #, %, etc.
purchaseOrderNumberstring-The Purchase Order Number associated with this order. The string may have up to 100 characters.
notesstringoptionalOrder notes.
The string may have up to 150 characters.
expirationDatedate-time*optionalThis is optional for Promo Links, the exact calendar date the Promo Link will expire. See the Promo Link acceptance criteria.

*See the description for more information.

We use credentailList instead of credentials . credentailList is a set of attributes that is returned on an order specifying how to access the purchased reward. credentailList contains credential type, label, value, and other stable parameters. See how to Get credential type.

📘

Note:

credentials is deprecated and should no longer be used. Use credentialList instead.

The following example shows the payload for when you use this endpoint and its body parameters. Perform a call to order one of the UTIDs that's returned in your GET {URI}/catalogs call.

{
  "referenceOrderID": "string",
  "externalRefID": "string",
  "customerIdentifier": "string",
  "accountIdentifier": "string",
  "amountCharged": {
    "value": 0,
    "currencyCode": "string",
    "exchangeRate": 0,
    "fee": 0,
    "total": 0
  },
  "denomination": {
    "value": 0,
    "currencyCode": "string",
    "exchangeRate": 0,
    "fee": 0,
    "total": 0
  },
  "utid": "string",
  "ptid": "string",
  "rewardName": "string",
  "reward": {
    "credentials": {
      "additionalProp": "string"
    },
    "credentialList": [
      {
        "label": "string",
        "value": "string",
        "type": "string",
        "credentialType": "string"
      }
    ],
    "redemptionInstructions": "string"
  },
  "sender": {
    "firstName": "string",
    "lastName": "string",
    "email": "string"
  },
  "recipient": {
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "address": {
      "streetLine1": "string",
      "streetLine2": "string",
      "city": "string",
      "stateOrProvince": "string",
      "postalCode": "string",
      "country": "string"
    }
  },
  "emailSubject": "string",
  "message": "string",
  "sendEmail": true,
  "status": "string",
  "campaign": "string",
  "purchaseOrderNumber": "string",
  "createdAt": "2025-07-29T00:33:41.306Z",
  "redemptionInstructions": "string"
}

Here is a payload example for when you use POST {URI}/orders to create an order with Promo link. You can set expiration date for Promo Link at the time of the order:

📘

Note:

Expiration date only applies to Promo Links.

{
  "referenceOrderID": "string",
  "externalRefID": "string", (100 chars)
  "customerIdentifier": "string", (5-100 chars)
  "accountIdentifier": "string", (5-100 chars)
  "accountNumber": "string", (5-100 chars)
  "amountCharged": {
    "value": 10.00,
    "currencyCode": "USD",
    "total": 10.0
  },
  "denomination": {
    "value": 10.0,
    "currencyCode": "USD"
  },
  "utid": "string",
  "rewardName": "Promo Link",
  "sender": {
    "firstName": "string",
    "lastName": "string",
    "email": "string"
  },
  "recipient": {
    "email": "string",
    "firstName": "string", (100 chars)
    "lastName": "string", (100 chars)
    "address": null
  },
  "sendEmail": false,
  "status": "COMPLETE",
  "createdAt": "2023-10-11T23:10:55.284Z",
  "reward": {
    "credentials": {
      "redemptionUrl": "https://gamma.rewardlink.io/r/1/Cl4e2dX_qz3zyUbSTb4dZgrbQta9qg-oBd6sPkywiIk",
      "expirationDate": "2024-12-31T06:59:59Z"
    },
    "credentialList": [
      {
        "label": "redemptionUrl",
        "value": "https://gamma.rewardlink.io/r/1/Cl4e2dX_qz3zyUbSTb4dZgrbQta9qg-oBd6sPkywiIk",
        "type": "url",
        "credentialType": "redemptionUrl"
      },
      {
        "label": "expirationDate",
        "value": "2024-12-31T06:59:59Z",
        "type": "date",
        "credentialType": "expirationDate"
      }
    ],
    "redemptionInstructions": "string"
  }
}

Here's a payload example for 422 (Unprocessable entity) response, including i18nkey for internationalization. The 422 response is returned when you try to place an order with a frozen account. 

{
  “timestamp”: “2025-01-15T19:12:42.059287141Z”,
  “requestId”: “08f50da4-aa93-40ba-968d-375b76085af6",
  “path”: “/raas/v2/orders”,
  “httpCode”: 422,
  “httpPhrase”: “Unprocessable Entity”,
  “errors”: [
    {
      “code”: 422001,
      “i18nKey”: “404.142”,
      “message”: “Account has been frozen, please contact your Tango CSM or email [email protected]”
    }
  ]
}

📘

Note:

An account may be frozen when detecting a fraudulent activity. Reach out to [email protected] or dial 1 (855)-257-2581 should you notice any fraudulent activity on your account.


The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages:

  • 200 Ok
  • 201 Created
  • 400 Bad Request
  • 401 Unauthorized
  • 402 Insufficient Funds
  • 403 Forbidden
  • 422 Unprocessable entity
  • 429 Exceeded the allowable TPS rate limit (Wait 1 second and try again)
  • 503 Service Unavailable

Updated 4 days ago

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