Get a list of accounts created

Are you interested in getting a list of all accounts created on your platform? Accounts in a platform contain funds. Use the following endpoint to get a list of accounts created on your platform:

FunctionPurpose
GET {URI}/accountsGet a list of Accounts created on this Platform.

The following query parameters are available with this endpoint. Use the query parameters to provide additional information to the server regarding your request:

Query params

Data type

Description

paginate

boolean

Whether to paginate the results or not. Defaults to false.
-true:paginates the results
-false:doesn't paginate the results

prevCursor

string

A provided base64 token that represents the cursor for the previous page of results. Use this token to retrieve the previous set of items. This will be ignored if paginate is false.

nextCursor

string

A provided base64 token that represents the cursor for the next page of results. Use this token to retrieve the next set of items. This will be ignored if paginate is false.

maxResults

int32

The maximum number of results to return. The default value 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. See Account status for more information.

  • ACTIVE
    -INACTIVE
    -DISABLED
    -FROZEN
    -DELETED

contactEmail

string

Specify the contact email address to be queried.

currencyCode

array of strings

Specify the currency code(s) to be queried.
We accept AUD, CAD, EUR, GBP, or USD currency. Only one currency can be specified. Currency can never be changed. The currency defaults to USD if no currency is specified.

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 according to RFC 3339, such as "2025-01-01" or "2025-01-01T00:00:00Z". See https://www.ietf.org/rfc/rfc3339.txt

maxDateCreatedAt

date-time

Specify the latest createdAt date to be queried according to RFC 3339, such as "2025-01-01" or "2025-01-01T00:00:00Z". See https://www.ietf.org/rfc/rfc3339.txt

fundingNotificationEmail

array of strings

Specify the funding notification email(s) to be queried.

The following payload is an example for when you use GET {URI}/accounts:

[
  {
    "currentBalance": 0,
    "contactEmail": "string",
    "fundingNotification": [
      {
        "emailAddress": "string"
      }
    ],
    "accountIdentifier": "string",
    "accountNumber": "string",
    "displayName": "string",
    "createdAt": "2024-03-13T23:25:59.600Z",
    "status": "string",
    "currencyCode": "string"
  }
]

Account balance

Tango API allows you to check the account balance at any time with GET {URI}/accounts, but it does not show the low balance alerts. We recommend building in a balance check and alert system if you anticipate the need to re-fund accounts on a regular basis.

The following payload example helps you observe your adjusted balance. Perform a GET {URI}/accounts or GET {URI}/accounts{accountName} call to see the adjusted balance of your account following the order. The paginate boolean in the query parameter is set to true for this example:

{
  "prevCursor": "string",
  "nextCursor": "string",
  "prevPageAvailable": boolean,
  "nextPageAvailable": boolean,
  "maxResults": int32,
  "items": 
  {
    "accountIdentifier": "string", (5-100 chars)
    "accountNumber": "string", (5-100 chars)
    "displayName": "string", (100 chars)
    "currencyCode": "string", (3 chars)
    "currentBalance": 0,
    "createdAt": "2023-05-10T18:40:03.899Z",
    "status": "string",
    "contactEmail": "string" (255 chars)
  }
}

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:

  • 200 OK
  • 400 Bad request
  • 401 Unauthorized
  • 403 Forbidden

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