Manage Customers (Groups)
A Group is the second level under your company's platform, a collection of accounts to hold funds and place orders. Each platform contains one or more group, only one of which may have the same name as the platform. Groups cannot be deleted or disabled once created.
Coming soon
Note: Customers are also known as Groups in Tango. We are planning to update our API endpoints in our V3.0 release to replace Customers with Groups.
Use cases
- Enterprises: In ABC enterprise, all departments or divisions have their own groups. The manager of each department or division has control over all accounts in their department. They can create multiple accounts for teams, projects, budgets, or anything that needs funds tracked separately. They can also create groups for accounts that require a controlled access; for example, team A has a separate group than team B since the two teams do not need access to each other's account.
- Small Companies: In an small company, groups are set up by:
- Accounts such as Internal programs, sales initiatives, and employee moral.
- Customer programs such as loyalty accounts, or referral accounts.
- Platform customer with sub customers. In platform customers, each customer has their own group; sub customers can have multiple projects or budgets with the platform customer depending on their budget needs.
Get a list of all Customers
UseGET {URI}/customers
endpoint to get a list of all customers on this platform. There is no parameters for this endpoint.
Endpoint | Purpose |
---|---|
GET {URI}/customers | Get a list of all Customers on this Platform. |
The response message for this endpoint is:
- 200 OK
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
The following example shows GET {URI}/customers\
.
{
"customerIdentifier": "extole-1626785354",
"displayName": "extole-1626785354",
"status": "active",
"createdAt": "2018-04-05T02:33:23.752Z",
"accounts": [
{
"accountIdentifier": "1626785354-account-1",
"accountNumber": "A51721736",
"displayName": "1626785354-account-1",
"createdAt": "2018-04-05T02:33:24.159Z",
"status": "ACTIVE"
}
]
Create a new Customer on this Platform
You can use POST {URI}/customers
endpoint to create a new customer on this platform.
Endpoint | Purpose |
---|---|
POST {URI}/customers | Create a new Customer on this Platform. |
Here are a list of query parameters for when you usePOST {URI}/customers
to create a new customer on this platform.
Parameter | Data Type | Description |
---|---|---|
customerIdentifier | string | A unique identifier for this Customer. Must be between 5-100 characters and accepts the following: -0-9a-zA-Z in any sequence. |
displayName | string | A friendly name for this Customer |
The response message for this endpoint is:
- 201 Created
- 400 Bad request
- 401 Unauthorized
- 403 Forbidden
- 409 Conflict, duplicate Exists
The following example shows how to create a new customer using POST {URI}/customers
on this platform.
{
"customerIdentifier": "string", (5-100 chars)
"displayName": "string", (100 chars)
}
Get details for a specific Customer
You can use GET {URI}/customers/{customerIdentifier}
endpoint to get details for a specific customer on this platform.
Endpoint | Purpose |
---|---|
GET {URI}/customers/{customerIdentifier} | Get details for a specific Customer on this Platform. |
Here is a parameter for when you use GET {URI}/customers/{customerIdentifier}
to get details for a specific customer on this platform.
Parameter | Data Type | Description |
---|---|---|
customerIdentifier | string | The customerIdentifier for the Customer under which you are seeking details. |
The response message for this endpoint is:
- 200 OK
- 400 Bad request
- 401 Unauthorized
- 403 Forbidden
- 404 Not Found
Get a list of all Accounts created for a specific Customer
Use GET {URI}/customers/{customerIdentifier}/accounts
endpoint to get a list of all accounts created for a specific customer on this platform.
Endpoint | Purpose |
---|---|
GET {URI}/customers/{customerIdentifier}/accounts | Get a list of all Accounts created for a specific Customer on this Platform. |
Here is a parameter for when you use GET {URI}/customers/{customerIdentifier}/accounts
to get a list of all accounts created for a specific customer on this platform.
Parameter | Data Type | Description |
---|---|---|
customerIdentifier | string | The customerIdentifier for the Customer under which you are seeking details. |
The response message for this endpoint is:
- 200 OK
- 400 Bad request
- 401 Unauthorized
- 403 Forbidden
Create an Account under a specific Customer
Use the POST {URI}/customers/{customerIdentifier}/accounts
endpoint to create an account under a specific customer on this platform.
Endpoint | Purpose |
---|---|
POST {URI}/customers/{customerIdentifier}/accounts | Create an Account under a specific Customer on this platform. |
Here are the list of parameters for when you use POST {URI}/customers/{customerIdentifier}/accounts
to create an account under specific customer on this platform:
Parameter | Data Type | Description |
---|---|---|
customerIdentifier | String | The customerIdentifier for the Customer under which you are creating a new account. |
accountIdentifier | string | A unique identifier for this account. Must be between 5-100 characters and accepts the following: -0-9a-zA-Z in any sequence. |
displayName | String | A friendly name for this account. |
contactEmail | String | An email address for a designated representative for this account. |
The response message for this endpoint is:
- 201 Created
- 400 Bad request
- 401 Unauthorized
- 403 Forbidden
- 409 Conflict, Duplicate Exist
The following example shows how to create an account identifier and use POST {URI}/customers/{customerIdentifier}/accounts
to create an account under specific customer on this platform. The account identifier must be lowercase.
{
"accountIdentifier": "string",
"contactEmail": "string",
"displayName": "string"
}
Updated 21 days ago