---
title: "Get bank account"
method: GET
path: "/api/demographics/v1/BankAccounts/{merchantNumber}"
tags: ["Bank Account"]
---

# Get bank account

`GET /api/demographics/v1/BankAccounts/{merchantNumber}`

## Request

- The document declares no server URL.
- Auth: none declared
- TypeScript: <https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow/docs/api/demographics/v1/BankAccounts/:merchantNumber/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve all bank accounts associated with the specified merchant.
            
Note: The response includes details for all types of bank accounts present for the merchant.

## Path parameters

- `merchantNumber` string, required

## Query parameters

- `encryptedAccountNumber` boolean
- `lastFourAccountNumber` boolean
- `effectiveAccount` boolean

## Response `200`

Returns a list of bank accounts successfully.

- MerchantDemographicsApiModelsBankAccountCollection
  - `content` MerchantDemographicsApiModelsBankAccount[], nullable: A list of bank account details.
    - `bankAccountID` string, nullable: Unique identifier for the bank account.
    - `bankName` string, required: Name of the bank associated with the account.
    - `nameOnAccount` string, nullable: The name on the bank account.
    - `accountHolderFirstName` string, nullable: The first name of the account holder.
    - `accountHolderLastName` string, nullable: The last name of the account holder.
    - `bankAccountTypeID` string, required: Type of bank account. Possible values: 1 - Checking 2 - Savings
    - `bankAccountNameTypeID` integer, required: Name type ID for the bank account.
    - `aba` string, required: The routing number associated with the bank account. In different regions, this may represent BIC (EU) or Sort Code (UK). Mandatory for US and UK; optional for EU.
    - `accountNumber` string, required: The account number associated with the bank account.
    - `lastFourAccountNumber` string, nullable: The last four digits of the bank account number.
    - `encryptedAccountNumber` string, byte, nullable: Encrypted version of the bank account number.
    - `voidedCheckDocumentID` string, uuid: Document ID for the voided check linked to the bank account.
    - `hasFees` boolean, required: Indicates if the account has fees associated with it.
    - `hasFunds` boolean, required: Indicates if the account has available funds.
    - `hasChargebacks` boolean, required: Indicates if the account has a history of chargebacks.
    - `isNameSameAsLegalOrDBAName` string, nullable: Indicates if the account name is the same as the legal or DBA name.
    - `currency` string, nullable: The account currency in ISO 4217 code
    - `purpose` 'Settlement' | 'Invoicing' | 'Direct'
    - `lastUpdatedUtc` string, nullable: UTC date and time when the account was last updated.

## Other responses

- `400`: Bad Request: Returns when merchantNumber null or empty.
- `401`: Unauthorized: User does not have the required role or access.
- `403`: Forbidden: The user does not have the necessary permissions to access this resource.
- `404`: Not Found: Bank accounts not found.
- `500`: Internal Server Error: This could be due to system errors. Please contact support for assistance.

---

[API](https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow.md) - [All operations](https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow/llms.txt) - [OpenAPI document](https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow/revisions/f37077c24b66?raw)