GET///
Returns a paginated list of deposit accounts associated with the specified user.
URL path parameters
| Fields | Description |
|---|---|
| user_token string Required | Unique identifier of the user associated with the deposit accounts to retrieve. Allowable Values: 36 char max |
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | Number of deposit accounts to retrieve. Allowable Values: Any integer |
| start_index integer Optional | Index of the first result in the returned array. Use for pagination. Allowable Values: Any integer |
| sort_by string Optional | Field on which to sort. Prefix with - for descending order.Allowable Values: createdTime, lastModifiedTime, or any field in the resource model |
| status string Optional | Status of the deposit accounts to retrieve. Allowable Values: ACTIVE, SUSPENDED, TERMINATED, PENDING, FAILED |
Response body
| Fields | Description |
|---|---|
| count integer Conditionally returned | Number of deposit account resources returned. Allowable Values: Any integer |
| data array of objects Conditionally returned | Array of deposit account objects. Allowable Values: Valid array of one or more deposit account objects |
| data[].token string Returned | Unique identifier of the deposit account. Allowable Values: 36 char max |
| data[].name string Conditionally returned | Name of the deposit account. Allowable Values: 255 char max |
| data[].user_token string Conditionally returned | Unique identifier of the user associated with the deposit account. Allowable Values: 36 char max |
| data[].business_token string Conditionally returned | Unique identifier of the business associated with the deposit account. Allowable Values: 36 char max |
| data[].status string Returned | Current status of the deposit account. Allowable Values: ACTIVE, SUSPENDED, TERMINATED, PENDING, FAILED |
| data[].reason string Conditionally returned | Explanation of the current status of the deposit account. Allowable Values: 255 char max |
| data[].type string Conditionally returned | Type of the deposit account. Allowable Values: CHECKING, SAVINGS, WALLET, DEPOSIT_ACCOUNT |
| data[].account_number string Conditionally returned | Bank account number associated with the deposit account. Allowable Values: A valid bank account number |
| data[].routing_number string Conditionally returned | Bank routing number used for US automated clearing house (ACH) transactions, or a local clearing code for other regions. Allowable Values: A valid bank routing number |
| data[].sort_code string Conditionally returned | Sort code that identifies the bank and branch, primarily used in the United Kingdom. Allowable Values: 6 digit code |
| data[].ibans array of strings Conditionally returned | Array of International Bank Account Numbers (IBANs) for cross-border transfers. Allowable Values: Up to 34 char max per IBAN, depending on the country |
| data[].bic string Conditionally returned | Bank Identifier Code used for international identification of banks. Allowable Values: 8 char max. See the SWIFT BIC standard |
| data[].interest_tier_token string Conditionally returned | Unique identifier of the interest tier applied to the deposit account. Allowable Values: 36 char max |
| data[].current_tier_rate string Conditionally returned | Current interest rate applied to the deposit account, as a percentage ranging from 0 to 100. Do not include a percent sign (%). Allowable Values: 0–100 |
| data[].created_time datetime Returned | Date and time when the deposit account was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| data[].last_modified_time datetime Returned | Date and time when the deposit account was last updated, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| start_index integer Conditionally returned | Sort order index of the first resource in the returned array. Allowable Values: Any integer |
| end_index integer Conditionally returned | Sort order index of the last resource in the returned array. Allowable Values: Any integer |
| is_more boolean Conditionally returned | A value of true indicates that more unreturned resources exist.Allowable Values: true, false |
Sample response body
JSON
{
"count": 2,
"start_index": 0,
"end_index": 1,
"is_more": false,
"data": [
{
"token": "b27f2c40-3a2e-4d8f-a93b-7c6e1f5d8b21",
"name": "My Checking Account",
"user_token": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "ACTIVE",
"type": "CHECKING",
"account_number": "9873654102",
"routing_number": "021000021",
"created_time": "2026-01-08T17:56:06Z",
"last_modified_time": "2026-01-08T17:56:06Z"
},
{
"token": "c38a3d51-4b3f-5e9a-b04c-8d7a70c9d321",
"name": "My Savings Account",
"user_token": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "ACTIVE",
"type": "SAVINGS",
"account_number": "8762543091",
"routing_number": "021000021",
"created_time": "2026-01-06T09:20:00Z",
"last_modified_time": "2026-01-06T09:20:00Z"
}
]
}