.svg?fit=max&auto=format&n=IA3LwxdwplQ2w-t1&q=85&s=b292e78038d8c39788a4b2fa0c31ff8e)
.svg?fit=max&auto=format&n=IA3LwxdwplQ2w-t1&q=85&s=935bf5f31a64df6f5d9fed108e9fba67)
Bank Accounts
List Bank Accounts
Retrieve a paginated list of your saved bank accounts.
Request example
{
"query": {
"limit": 20,
"cursor": null
}
}
# Sample only. Generate a new signed token for each request
# (see Authentication). Tokens expire after 120 seconds.
curl --request GET \
--url "https://api.primevault.com/api/external/bank_accounts/?limit=20" \
--header "Authorization: Bearer <signed JWT>" \
--header "Api-Key: <API key>" \
--header "Accept: application/json"
getBankAccounts(
params?: Record<string, string>,
limit?: number,
cursor?: string | null,
): Promise<BankAccountListResponse>
{
"results": [
{
"id": "bank_account_123",
"orgId": "org_456",
"subOrgId": "sub_org_123",
"orgEntityId": "org_entity_123",
"createdById": "api_user_123",
"createdAt": "2026-08-04T10:30:00Z",
"updatedAt": "2026-08-04T10:30:00Z",
"isDeleted": false,
"status": "PENDING",
"accountNumber": "111222333",
"accountName": "Acme Corp",
"routingNumber": "021000021",
"clientBankAccountId": "erp-bank-001",
"paymentMethod": "US_ACH",
"bankName": "Chase",
"streetLine": "270 Park Avenue",
"city": "New York",
"state": "NY",
"postalCode": "10017",
"country": "US"
}
],
"nextCursor": "eyJpZCI6ImJhbmtfYWNjb3VudF8xMjMifQ==",
"hasNext": true
}
GET
/api/external/bank_accounts/?limit={limit}&cursor={cursor}&{filters}
Lists the bank accounts available to the API user’s organization. Use cursor pagination to walk through large sets, and apply filters to narrow results.
Bank-account data is sensitive. Avoid logging full account and routing numbers, and preserve the organization or sub-org scope returned by the API.
Query parameters
number
Requested page size. SDK default: 20.
string | null
Cursor for the next page. First page: null or empty.
Record<string, string>
Bank-account filters accepted by the endpoint.
Response
interface BankAccountListResponse {
results: BankAccount[];
nextCursor?: string | null;
hasNext?: boolean;
}
JavaScript SDK
getBankAccounts(
params?: Record<string, string>,
limit?: number,
cursor?: string | null,
): Promise<BankAccountListResponse>
Request example
{
"query": {
"limit": 20,
"cursor": null
}
}
# Sample only. Generate a new signed token for each request
# (see Authentication). Tokens expire after 120 seconds.
curl --request GET \
--url "https://api.primevault.com/api/external/bank_accounts/?limit=20" \
--header "Authorization: Bearer <signed JWT>" \
--header "Api-Key: <API key>" \
--header "Accept: application/json"
getBankAccounts(
params?: Record<string, string>,
limit?: number,
cursor?: string | null,
): Promise<BankAccountListResponse>
{
"results": [
{
"id": "bank_account_123",
"orgId": "org_456",
"subOrgId": "sub_org_123",
"orgEntityId": "org_entity_123",
"createdById": "api_user_123",
"createdAt": "2026-08-04T10:30:00Z",
"updatedAt": "2026-08-04T10:30:00Z",
"isDeleted": false,
"status": "PENDING",
"accountNumber": "111222333",
"accountName": "Acme Corp",
"routingNumber": "021000021",
"clientBankAccountId": "erp-bank-001",
"paymentMethod": "US_ACH",
"bankName": "Chase",
"streetLine": "270 Park Avenue",
"city": "New York",
"state": "NY",
"postalCode": "10017",
"country": "US"
}
],
"nextCursor": "eyJpZCI6ImJhbmtfYWNjb3VudF8xMjMifQ==",
"hasNext": true
}
⌘I
Request example
{
"query": {
"limit": 20,
"cursor": null
}
}
# Sample only. Generate a new signed token for each request
# (see Authentication). Tokens expire after 120 seconds.
curl --request GET \
--url "https://api.primevault.com/api/external/bank_accounts/?limit=20" \
--header "Authorization: Bearer <signed JWT>" \
--header "Api-Key: <API key>" \
--header "Accept: application/json"
getBankAccounts(
params?: Record<string, string>,
limit?: number,
cursor?: string | null,
): Promise<BankAccountListResponse>
{
"results": [
{
"id": "bank_account_123",
"orgId": "org_456",
"subOrgId": "sub_org_123",
"orgEntityId": "org_entity_123",
"createdById": "api_user_123",
"createdAt": "2026-08-04T10:30:00Z",
"updatedAt": "2026-08-04T10:30:00Z",
"isDeleted": false,
"status": "PENDING",
"accountNumber": "111222333",
"accountName": "Acme Corp",
"routingNumber": "021000021",
"clientBankAccountId": "erp-bank-001",
"paymentMethod": "US_ACH",
"bankName": "Chase",
"streetLine": "270 Park Avenue",
"city": "New York",
"state": "NY",
"postalCode": "10017",
"country": "US"
}
],
"nextCursor": "eyJpZCI6ImJhbmtfYWNjb3VudF8xMjMifQ==",
"hasNext": true
}