Retrieve a Bank Account

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"

Response example

{
  "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"
}

interface BankAccount {
  id: string;
  orgId: string;
  subOrgId?: string;
  orgEntityId: string;
  createdById: string;
  createdAt: string;
  updatedAt: string;
  isDeleted: boolean;
  status: BankAccountStatus;
  accountNumber?: string;
  accountName?: string;
  routingNumber?: string;
  clientBankAccountId?: string;
  paymentMethod?: string;
  bankName?: string;
  streetLine?: string;
  city?: string;
  state?: string;
  postalCode?: string;
  country?: string;
}

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

Returns a BankAccount.

string

Bank account ID.

string

Organization that owns the bank account.

string

Sub-org that owns the bank account, if any.

string

Organization entity that owns the account.

string

User or API user that created the bank account.

string

Creation timestamp (ISO 8601).

string

Last update timestamp (ISO 8601).

boolean

Whether the bank account is deleted.

BankAccountStatus

PENDING, APPROVED, or DECLINED. A new bank account stays PENDING until it’s approved. See BankAccountStatus.

string

Bank account number.

string

Account-holder name.

string

Domestic routing identifier where applicable.

string

Client-controlled bank-account reference.

string

Payment rail, for example US_ACH, US_WIRE, SEPA, SWIFT, or BANK_TRANSFER.

string

Bank name.

string

Street address line for the bank or beneficiary.

string

City for the bank or beneficiary address.

string

State or province for the bank or beneficiary address.

string

Postal code for the bank or beneficiary address.

string

Country code for the bank or beneficiary 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"

Response example

{
  "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"
}

interface BankAccount {
  id: string;
  orgId: string;
  subOrgId?: string;
  orgEntityId: string;
  createdById: string;
  createdAt: string;
  updatedAt: string;
  isDeleted: boolean;
  status: BankAccountStatus;
  accountNumber?: string;
  accountName?: string;
  routingNumber?: string;
  clientBankAccountId?: string;
  paymentMethod?: string;
  bankName?: string;
  streetLine?: string;
  city?: string;
  state?: string;
  postalCode?: string;
  country?: string;
}

⌘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"

Response example

{
  "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"
}

interface BankAccount {
  id: string;
  orgId: string;
  subOrgId?: string;
  orgEntityId: string;
  createdById: string;
  createdAt: string;
  updatedAt: string;
  isDeleted: boolean;
  status: BankAccountStatus;
  accountNumber?: string;
  accountName?: string;
  routingNumber?: string;
  clientBankAccountId?: string;
  paymentMethod?: string;
  bankName?: string;
  streetLine?: string;
  city?: string;
  state?: string;
  postalCode?: string;
  country?: string;
}

API Basics

Approvals

Vaults

Blockchain Contacts

Bank Accounts

Assets and Chains

Sub-Orgs

Transactions

Retrieve a Bank Account

Path parameters

Response

​Path parameters

​Response

Path parameters

Response