Create an account under a specific customer

The POST {URI}/customers/{customerIdentifier}/accounts endpoint allows you to create an account under a a specific customer. In Tango API each customer can have one or more accounts to manage different reward programs, budgets, or departments. Creating an account under a specific customer allows for better organization, tracking, and control of reward distribution. This is especially useful for platforms managing multiple clients or internal teams, as it enables separate funding, reporting, and alert configurations for each account.

Use case

Acme Wellness has a customer, Zanzibar Health Group, that wants to launch a new rewards initiative for their employee wellness program. To manage this program separately from their other initiatives, Acme needs to create a new account under the existing customer profile. Each account can represent a different budget, department, or rewards program.

Use the following endpoint to create an account under a specific customer:

EndpointPurpose
POST {URI}/customers/{customerIdentifier}/accountsCreate an account under a specific customer on this platform.

The following path parameters are used with this endpoint. customerIdentifier is a string used to identify the Group (Customer) that contains the account you are transacting from:

Path paramsData typeDescription
customerIdentifierstringA unique identifier for the customer under which you are creating a new account. The string must have 5-100 characters.

The following body parameters are used with this endpoint. accountIdentifier is a string used to identify the account you are transacting from:

Body paramsData typeDescription
accountIdentifierstringA unique identifier for this account. It must be between 5-100 characters and accepts the following: -0-9a-zA-Z in any sequence.
displayNamestringA friendly name for this account. The string must be between 5-100 characters. Emojis are not accepted for displayName or any text entry.
contactEmailstringAn email address for a designated representative for this account. The string may have up to 100 characters.
currencyCodestringThe only currency accepted for deposits/withdraws is AUD, CAD, EUR, GBP, or USD. Only one currency can be specified. Currency can never be changed. The currency defaults to USD if no currency is specified.
fundingNotificationarrays of objectSend funding notification emails to the address(es).
- emailAddressstring(Optional) The email address used to send funding notifications to for this account.

The following payload is an example for when you use POST {URI}/customers/{customerIdentifier}/accounts . The account identifier must be lowercase:

{
  "accountIdentifier": "string", (5-100 chars)
  "displayName": "string", (100 chars)
  "contactEmail": "string", (100 chars)
  "currencyCode": "USD", (3 chars)
  "fundingNotification": [
    {
      "emailAddress": "string"
    }
  ]
}

Here's an example payload for when you receive an error:

{
  "timestamp": "2025-02-21T23:23:13.930Z",
  "requestId": "string",
  "path": "string",
  "httpCode": 0,
  "httpPhrase": "string",
  "i18nKey": "string",
  "message": "The error message will show here for error codes ",
  "errors": [
    {}
  ]
}

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

Response codeMeaning
201New resource has been successfully created as a result of the request.
400The server could not understand the request due to invalid syntax.
401Authentication is required and has either not been provided or failed.
403The server understood the request but refuses to authorize it.
409The request could not be completed because it would cause a conflict with the current state of the resource.
500Something went wrong on the server, but the server cannot be more specific about what the exact problem is.
503The server is currently unable to handle the request due to temporary overload or maintenance.

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