Get Account List

Retrieves a paginated list of counterparty accounts with comprehensive filtering options.

Endpoint

GET/v2/counterparty/account

Link

Gateway APIstagep.tst-apidmndelss.com

This endpoint allows you to search and filter accounts by various criteria including counterparty details, customer information, account status, and more.

---

Request

Query Parameters

All parameters are optional. Use them to filter the account list.

Parameter	Type	Description	Example
accountId	string	Filter by specific account ID.	"acc_12345"
counterpartyId	string	Filter by counterparty ID.	"cp_67890"
counterpartyName	string	Filter by counterparty name.	"Tech Supplies"
currencyCode	string	Filter by currency code.	"USD"
customerId	string	Filter by customer ID.	"cust_12345"
customerName	string	Filter by customer name.	"John Doe"
fromCreatedAt	string	Filter from creation date (ISO 8601).	"2024-01-01T00:00:00Z"
toCreatedAt	string	Filter to creation date (ISO 8601).	"2024-12-31T23:59:59Z"
name	string	Filter by account name.	"Business Checking"
number	string	Filter by account number.	"123456789"
search	string	General search across multiple fields.	"Chase"
status	string	Filter by account status.	"ACCEPT"
meta.page	integer	Page number (starts from 0).	0
meta.pageSize	integer	Items per page.	20

Headers

Key	Value	Required
Authorization	123	Yes
Accept	application/json	Yes

---

Response (200 OK)

Returns a paginated list of accounts with complete details including counterparty and customer information.

Response Fields

1. Meta (Pagination)

Field	Type	Description	Example
pageSize	integer	Items per page.	20
page	integer	Current page (0-indexed).	0
total	string	Total items count.	"150"

2. Items (Account Array)

Field	Type	Description	Example
accountId	string	Unique account identifier.	"acc_12345"
name	string	Account name/description.	"Business Checking Account"
number	string	Account number.	"123456789"
currencyCode	string	Currency code (ISO 4217).	"USD"
type	string	Account type.	"CHECKING"
status	string	Account status.	"ACCEPT"
bankName	string	Bank/financial institution name.	"Chase Bank"
createdAt	string	Creation timestamp.	"2024-01-15T10:30:00Z"
updatedAt	string	Last update timestamp.	"2024-05-20T14:45:00Z"
supportedRails	array	Supported payment rails.	["ACH", "FEDWIRE"]

3. Counterparty Object

Field	Type	Description	Example
id	string	Counterparty ID.	"cp_67890"
name	string	Counterparty name.	"Tech Supplies Corp"
phone	string	Counterparty phone.	"[phone]"
email	string	Counterparty email.	"[email protected]"

4. Customer Object

Field	Type	Description	Example
id	string	Customer ID.	"cust_12345"
name	string	Customer name.	"John Doe"
phone	string	Customer phone.	"[phone]"
email	string	Customer email.	"[email protected]"
status	string	Customer status.	"ACCEPT"

5. BankAddress Object

Field	Type	Description	Example
addressLine1	string	Primary address.	"456 Bank Street"
addressLine2	string	Suite/floor.	"Floor 15"
addressLine3	string	Additional info.	"Main Office"
city	string	City.	"New York"
stateIso	string	State code.	"NY"
countryIso	string	Country code.	"US"
postalCode	string	Postal code.	"10002"
unitNumber	string	Unit number.	"1501"

Example Response:

json

{
  "meta": {
    "pageSize": 20,
    "page": 0,
    "total": "85"
  },
  "items": [
    {
      "accountId": "acc_12345",
      "name": "Business Checking Account",
      "number": "123456789",
      "currencyCode": "USD",
      "type": "CHECKING",
      "counterparty": {
        "id": "cp_67890",
        "name": "Tech Supplies Corp",
        "phone": "[phone]",
        "email": "[email protected]"
      },
      "customer": {
        "id": "cust_12345",
        "name": "John Doe",
        "phone": "[phone]",
        "email": "[email protected]",
        "status": "ACCEPT"
      },
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-05-20T14:45:00Z",
      "status": "ACCEPT",
      "bankName": "Chase Bank",
      "bankAddress": {
        "addressLine1": "456 Bank Street",
        "addressLine2": "Floor 15",
        "city": "New York",
        "stateIso": "NY",
        "countryIso": "US",
        "postalCode": "10002"
      },
      "supportedRails": ["ACH", "FEDWIRE"]
    }
  ]
}

---

Field Details

Account Status Values

Status	Description
NEW	Account newly created, pending verification
AWAIT	Awaiting additional information/documentation
MODERATION	Under review by compliance team
ACCEPT	Approved and active for transactions
REJECT	Rejected during verification
BANNED	Permanently blocked from transactions
VERIFICATION	In verification process

Supported Payment Rails

Rail	Description
ACH	Automated Clearing House (US)
FEDWIRE	Federal Wire Transfer (US)
SWIFT	International wire transfers
SEPA_CT	SEPA Credit Transfer (EU)
FPS	Faster Payments (UK)
IMPS	Immediate Payment Service (India)
EFT	Electronic Funds Transfer
CRYPTO	Cryptocurrency transfers
NFT	Non-fungible token transfers
UP	Unified Payments (Various)

---

Examples

Request

bash

curl -X GET 'https://stagep.tst-apidmndelss.com/v2/counterparty/account?currencyCode=USD&status=ACCEPT&meta.page=0&meta.pageSize=10' \
  -H 'Authorization: 123' \
  -H 'Accept: application/json'

UK Bank Account Example

Response:

json

{
  "meta": {
    "pageSize": 10,
    "page": 0,
    "total": "23"
  },
  "items": [
    {
      "accountId": "acc_67890",
      "name": "Sterling Business Account",
      "number": "98765432",
      "currencyCode": "GBP",
      "type": "CHECKING",
      "counterparty": {
        "id": "cp_11111",
        "name": "London Consulting Ltd",
        "phone": "[phone]",
        "email": "[email protected]"
      },
      "customer": {
        "id": "cust_22222",
        "name": "Sarah Wilson",
        "phone": "[phone]",
        "email": "[email protected]",
        "status": "ACCEPT"
      },
      "createdAt": "2024-03-10T14:20:00Z",
      "updatedAt": "2024-04-15T09:30:00Z",
      "status": "ACCEPT",
      "bankName": "Barclays Bank",
      "bankAddress": {
        "addressLine1": "1 Churchill Place",
        "city": "London",
        "countryIso": "GB",
        "postalCode": "E14 5HP"
      },
      "supportedRails": ["FPS", "SWIFT", "SEPA_CT"]
    }
  ]
}

Crypto Account Example

Response:

json

{
  "meta": {
    "pageSize": 10,
    "page": 0,
    "total": "12"
  },
  "items": [
    {
      "accountId": "acc_99999",
      "name": "Bitcoin Wallet",
      "number": "0x742d35Cc6634C0532925a3b8D6B3985f8e091be1",
      "currencyCode": "BTC",
      "type": "CRYPTO_WALLET",
      "counterparty": {
        "id": "cp_33333",
        "name": "Crypto Ventures LLC",
        "phone": "[phone]",
        "email": "[email protected]"
      },
      "customer": {
        "id": "cust_44444",
        "name": "Michael Chen",
        "phone": "[phone]",
        "email": "[email protected]",
        "status": "ACCEPT"
      },
      "createdAt": "2024-02-28T11:15:00Z",
      "updatedAt": "2024-05-10T16:45:00Z",
      "status": "ACCEPT",
      "bankName": "Digital Asset Platform",
      "supportedRails": ["CRYPTO", "NFT"]
    }
  ]
}

Account Under Moderation Example

Response:

json

{
  "meta": {
    "pageSize": 10,
    "page": 0,
    "total": "5"
  },
  "items": [
    {
      "accountId": "acc_55555",
      "name": "New Supplier Account",
      "number": "555666777",
      "currencyCode": "EUR",
      "type": "CHECKING",
      "counterparty": {
        "id": "cp_66666",
        "name": "Berlin Manufacturing GmbH",
        "phone": "[phone]",
        "email": "[email protected]"
      },
      "customer": {
        "id": "cust_77777",
        "name": "Global Imports Inc",
        "phone": "[phone]",
        "email": "[email protected]",
        "status": "ACCEPT"
      },
      "createdAt": "2024-05-01T09:00:00Z",
      "updatedAt": "2024-05-18T14:20:00Z",
      "status": "MODERATION",
      "bankName": "Deutsche Bank",
      "bankAddress": {
        "addressLine1": "Taunusanlage 12",
        "city": "Frankfurt",
        "countryIso": "DE",
        "postalCode": "60325"
      },
      "supportedRails": ["SEPA_CT", "SWIFT"]
    }
  ]
}

---

Error Responses

1. Unauthorized:

   json

   { "error": "Unauthorized" }

2. Invalid Parameters:

   json

   { "error": "Invalid status value: INVALID_STATUS" }

---

Notes

• Search Functionality: The search parameter searches across account name, number, counterparty name, and customer name
• Status Filtering: Use status to find accounts in specific verification states
• Currency Support: Filter by specific currencies or view all multi-currency accounts
• Pagination: Essential for large datasets - always check meta.total for result count
• Real-time Status: Account status reflects current verification state

Common Use Cases:

• Compliance auditing and verification tracking
• Payment processing eligibility checks
• Customer relationship management
• Multi-currency account overview

Real request:

Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOjE2NCwiZXhwIjoxNzYxNzI4OTg5LCJrZXkiOiI1Y2ZiOGZjN2RmYjk4ZjVkYmIyZTgwNTVkZWFhN2U2Zjk4MzEyYmE3Iiwib3RwX3ZlcmlmaWVkIjpmYWxzZX0.Txpfgr99OZ8vSeLU6o7YF6-rZBo81puftG8Gcp2rJ5c
accountId: string
counterpartyId: DkCSHAN-B9nW-HoakBCwCq36I
counterpartyName: string
currencyCode: string
customerId: Dnewcvn-euuI-vG0FZCRDjLXS
customerName: string
fromCreatedAt: string
meta.page: integer
meta.pageSize: integer
name: string
number: string
search: string
status: Not Set NEW AWAIT MODERATION ACCEPT REJECT BANNED VERIFICATION
select an option
toCreatedAt: string

Real response:

200 OK

{
  "meta": {
    "pageSize": 1,
    "page": 0,
    "total": "1"
  },
  "items": [
    {
      "accountId": "UDHW6vxOePli",
      "name": "Test Eugen USD",
      "number": "Test Eugen USD",
      "currencyCode": "USD",
      "type": "Fiat",
      "counterparty": {
        "id": "DkCSHAN-B9nW-HoakBCwCq36I",
        "name": "Test Eugen USD",
        "phone": "111",
        "email": "Test Eugen USD"
      },
      "customer": {
        "id": "Dnewcvn-euuI-vG0FZCRDjLXS",
        "name": "Test Eugen Test Eugen",
        "phone": "",
        "email": "",
        "status": "NEW"
      },
      "createdAt": "2025-01-28T09:20:30Z",
      "updatedAt": "2025-02-21T12:57:19Z",
      "status": "ACCEPT",
      "bankName": "Test Eugen USD",
      "bankAddress": {
        "addressLine1": "Test Eugen USD",
        "addressLine2": "",
        "addressLine3": "",
        "city": "Test Eugen USD",
        "stateIso": "Test Eugen USD",
        "countryIso": "Test Eugen USD",
        "postalCode": "Test Eugen USD",
        "unitNumber": "Test Eugen USD"
      },
      "supportedRails": [
        "SWIFT"
      ]
    }
  ]
}