.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
Retrieve a Bank Account
Retrieve a single bank account by ID, including its status, account details, and address.
Request example
{
"path": {
"bankAccountId": "bank_account_123"
}
}
# 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/bank_account_123/" \
--header "Authorization: Bearer <signed JWT>" \
--header "Api-Key: <API key>" \
--header "Accept: application/json"
getBankAccountById(bankAccountId: string): Promise<BankAccount>
{
"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"
}
GET
/api/external/bank_accounts/{bankAccountId}/
Returns one bank account by its identifier. Use this to read the current status and exact account fields for a previously created bank account.
Bank-account data is sensitive. Avoid logging full account and routing numbers, and preserve the organization or sub-org scope returned by the API.
Path parameters
string
required
The bank account ID.
Response
{
"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"
}
JavaScript SDK
getBankAccountById(bankAccountId: string): Promise<BankAccount>
Request example
{
"path": {
"bankAccountId": "bank_account_123"
}
}
# 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/bank_account_123/" \
--header "Authorization: Bearer <signed JWT>" \
--header "Api-Key: <API key>" \
--header "Accept: application/json"
getBankAccountById(bankAccountId: string): Promise<BankAccount>
{
"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"
}
⌘I
Request example
{
"path": {
"bankAccountId": "bank_account_123"
}
}
# 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/bank_account_123/" \
--header "Authorization: Bearer <signed JWT>" \
--header "Api-Key: <API key>" \
--header "Accept: application/json"
getBankAccountById(bankAccountId: string): Promise<BankAccount>
{
"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"
}