Manage Customers
about Customers in Tango Card,,,
Use Case
(use case here,,,)
Get a List of all Customers
Use GET {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
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 use POST {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",
"displayName": "string"
}
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 26 days ago