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 your platform.
Endpoint | Purpose |
---|---|
GET {URI}/customers/{customerIdentifier}/accounts | Get a list of all accounts created for a specific customer on this platform. |
The following path parameters are used when you use GET {URI}/customers/{customerIdentifier}/accounts
:
Path parameter | Data type | Description |
---|---|---|
customerIdentifier | string | A unique identifier for the customer under which you are seeking details. The string must have 5-100 characters. |
The following query parameters are used when you use GET {URI}/customers/{customerIdentifier}/accounts
:
Query parameter | Data type | Description |
---|---|---|
paginate | boolean | Whether to paginate the results or not. Defaults to false. |
prevCursor | string | The cursor to use for the previous page of results. This will be ignored if paginate is false. |
nextCursor | string | The cursor to use for the next page of results. This will be ignored if paginate is false. |
maxResults | int32 | The maximum number of results to return. The default is 10, and the maximum is 200. This will be ignored if paginate is false. |
accountNumber | string | Specify the account number to be queried. |
displayName | string | Specify the account display name to be queried. |
status | string | Specify the status to be queried. |
-ACTIVE | string | Show active accounts. When the account is active, you can conduct normal processing, fund, and place orders. |
-INACTIVE | string | Show inactive accounts. You cannot fund or place orders. Unlike disabled accounts, you cannot change the inactive status. |
-DISABLED | string | Show disabled accounts. You can set your account to Disable without any assistance from Tango. Once your account is disabled, no transactions are allowed. |
-FROZEN | string | Show the frozen accounts. With frozen accounts, your account has reached the velocity threshold. No transaction can be done until the freeze is lifted by Tango. Contact your Customer Success Manager (CSM) at [email protected] for questions or help. |
-DELETED | string | Show the deleted accounts. When an account is deleted, it doesn't exist anymore. |
contactEmail | string | Specify the contact email address to be queried. |
currencyCode | array of strings | Specify the currency code(s) to be queried. |
minBalance | number | Specify the minimum currentBalance to be queried. |
maxBalance | number | Specify the maximum currentBalance to be queried. |
minDateCreatedAt | date-time | Specify the earliest createdAt date to be queried. |
maxDateCreatedAt | date-time | Specify the latest createdAt date to be queried. |
fundingNotificationEmail | array of strings | Specify the funding notification email(s) to be queried. |
The following example shows the response for when you use GET {URI}/customers/{customerIdentifier}/accounts
:
[
{
"currentBalance": 0,
"contactEmail": "string",
"fundingNotification": [
{
"emailAddress": "string"
}
],
"accountIdentifier": "string",
"accountNumber": "string",
"displayName": "string",
"createdAt": "2024-03-14T16:18:41.061Z",
"status": "string",
"currencyCode": "string"
}
]
The response message for this endpoint is:
- 200 OK
- 400 Bad request
- 401 Unauthorized
- 403 Forbidden
Updated 3 days ago