Get account list

This command is to retrieve a list of accounts (payment wallets) for a specific partner or customer. It can be needed to check overall accounts’ balances and statuses for a particular client.

Endpoint

GET/v2/account

Link

Gateway APIstagep.tst-apidmndelss.com

Request Parameters

Query Parameters

Parameter	Type	Description & Values	Default
associateType	string	Filter by account association type: - NOT_ASSOCIATE: Standalone account - POOL: Part of a pooled account - COMMISSION: Commission-related account	ASSOCIATE_TYPE_NOT_SET
balance	string	Filter by balance status: - POSITIVE: Balance > 0 - NEGATIVE: Balance < 0 - ZERO: Balance = 0	NOTSET (no filter)
currencyIso	string	Currency code (ISO 4217, e.g., USD, EUR). Filters accounts by currency.	–
customerId	string	Customer ID (e.g., DqCsgSE-4e95-ViYbNI7mudVE). Filters accounts by customer.	–
customerName	string	Customer name (partial match, e.g., Test Company). Filters accounts by client name.	–
fromCreatedAt	string	Start date (e.g., 2024-08-11). Filters accounts created starting from this timestamp.	–
id	string	Account ID (e.g., UhcPVBEpjmtR). Filters by specific account.	–
meta.page	integer	Page number (starts at 1). Used for pagination.	0
meta.pageSize	integer	Items per page (e.g., 15). Max number of accounts returned per request.	–
name	string	Account name (full match, e.g., Savings). Filters accounts by name.	–
number	string	(non mandatory)	–
search	string	(non mandatory)	–
status	string	Account status: - NEW: Newly created - PRE_MODERATION: Pending review - MODERATION: Under review - ACCEPTED: Approved - REJECTED: Denied - BANNED: Blocked - PROCESSING: Mid-moderation	ACCOUNT_STATUS_NOTSET
toCreatedAt	string	End date (ISO 8601, e.g., 2024-12-31). Filters accounts created before this timestamp.	–
withCommission	boolean	Commission flag: - true: Only accounts with commissions - false: Exclude accounts with commissions	–

---

Response Fields

Success (200 OK)

Returns an application/json object with:

1. Account Object (items[])

Field	Type	Description & Values	Example
id	string	Unique account identifier.	"EBzClby3LdDc"
customer	object	Customer details: - id: Customer ID (e.g., cust_123) - name: Full name - email: Contact email - phone: Phone number - status: Customer status (NEW, MODERATED, etc.)	{ "id": "DqCsgSE-4e95-ViYbNI7m", "name": "Test Company", "status": "ACCEPT" }
isDefault	boolean	Whether this is the user’s default account (true/false).	true
name	string	Account name (e.g., "Business Account").	"Savings Account"
status	string	Current account status (same values as status filter above).	"ACCEPTED"
balance	object	Balance details: - balance: Available funds - hold: Restricted funds (see Money Object below)	–
currencyIso	string	Account currency code (ISO 4217, e.g., USD).	"EUR"
requisites	array	Bank/payment details (e.g., IBAN, SWIFT): - title: Section title (e.g., "Bank Account") - items[]: Key-value pairs (e.g., { "key": "iban", "value": "DE89370400440532013000" })	See Requisites Example here
createdAt	string	Creation timestamp (ISO 8601).	"2024-01-15"
updatedAt	string	Last update timestamp (ISO 8601).	"2024-01-20"

2. Money Object

Nested under balance and hold:

Field	Type	Description	Example
currencyCode	string	3-letter ISO currency code (e.g., USD, GBP).	"USD"
units	string	Whole units (e.g., dollars). Negative values indicate debts.	"100" (= $100)
nanos	integer	Fractional units (1 nano = 10^-9 units). Use for cents/micro-currencies.	500000000 (= $0.50)

3. Meta Object

Pagination details:

Field	Type	Description	Example
pageSize	integer	Items per page.	10
page	integer	Current page (0-indexed).	0
total	string	Total accounts available (unfiltered).	"150"

Notes

1. Money Handling:

   • Combine units + nanos for precise amounts (e.g., units=-1 + nanos=-750000000 = -$1.75).
   • nanos must align with units (e.g., negative units → negative nanos).
2. Dates: Use ISO 8601 format (YYYY-MM-DD).
3. Pagination:

   • First page = 1.
   • Omit meta.pageSize to use the server default.
4. Empty Fields: Unset fields (e.g., hold) may be omitted or return null.

Examples

Real request

Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOjE2NCwiZXhwIjoxNzYxNTYyMDMyLCJrZXkiOiI1Y2ZiOGZjN2RmYjk4ZjVkYmIyZTgwNTVkZWFhN2U2Zjk4MzEyYmE3Iiwib3RwX3ZlcmlmaWVkIjpmYWxzZX0.Ic6JVIMx0HpNeqUrgbeRV17hRZEBW_zEdjYctALGcqA
accountId: UnTtUmiTlATg
associateType: Not SetASSOCIATE_TYPE_NOT_SETNOT_ASSOCIATEPOOLCOMMISSION

select an option
balance: Not SetNOTSETNEGATIVEPOSITIVEZERO

select an option
currencyCode: string

Real response example

200 OK

{
  "items": [
    {
      "accountId": "UnTtUmiTlATg",
      "customer": {
        "id": "Dt4zZnj-x14s-q6eYgIBDpa4D",
        "name": "sdfsdfsd sdfsdf sdfsdf",
        "email": "[email protected]",
        "phone": "[phone]",
        "status": "NEW"
      },
      "isDefault": true,
      "name": "",
      "status": "MODERATION",
      "balance": {
        "balance": {
          "money": {
            "currencyCode": "USDT_TRC20",
            "units": "0",
            "nanos": 0
          },
          "default": {
            "currencyCode": "USD",
            "units": "0",
            "nanos": 0
          }
        },
        "hold": {
          "money": {
            "currencyCode": "USDT_TRC20",
            "units": "0",
            "nanos": 0
          },
          "default": {
            "currencyCode": "USD",
            "units": "0",
            "nanos": 0
          }
        }
      },
      "currencyCode": "USDT_TRC20",
      "requisites": [],
      "createdAt": "2025-10-22T08:35:26Z",
      "updatedAt": "2025-10-22T08:35:26Z"
    }
  ],
  "meta": {
    "pageSize": 1,
    "page": 0,
    "total": "1"
  }
}