---
title: "Get bank account"
method: GET
path: "/v2/accounts/{accountId}/bank-accounts/{schemeName}"
tags: ["Bank accounts"]
---

# Get bank account

`GET /v2/accounts/{accountId}/bank-accounts/{schemeName}`

Get a bank account given its Pismo account ID and scheme name in the path.

To read about Pismo's banking offerings, see [Banking overview](https://developers.pismo.io/pismo-docs/docs/banking-overview).

## Path parameters

- `accountId` string, required
- `schemeName` 'IBAN' | 'UK-SCAN' | 'BRAZIL' | 'BBAN' | 'ACH' | 'FEDWIRE' | 'CLABE', required

## Headers

- `Authorization` string, required

## Response `200`

Response

- IntlbankaccountsIntlBankAccountExternal
  - `account_id` integer — Account ID
  - `creation_datetime` string, date-time — Account creation date time displayed in ISO 8601 format `2023-04-12T23:20:50.52Z`.
  - `updated_datetime` string, date-time — Updated date time. A RFC 3339 value, i.e., "2023-04-12T23:20:50.52Z".
  - `metadata` Metadata — A set of key-value pairs used to store custom data or additional information.<br> **Note**: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to [Get started with Pismo APIs](https://developers.pismo.io/pismo-docs/reference/get-started-with-pismo-apis).
  - `scheme` union
    - IntlbankaccountsIbanScheme
      - `iban` string, required — International Bank Account Number (IBAN). IBAN structure varies by country, but typically includes a 2 letter country code, two check digits for error detection, a bank identifier and an account number.
    - IntlbankaccountsUkScanScheme
      - `account_number` string, required — Account number
      - `sort_code` string, required — In UK banking, a sort code is a unique identifier used to route money transfers between banks and financial institutions. Similar to a routing number in the US. It is a six-digit number that identifies both the bank and the specific branch office. Each bank branch office has its own unique sort code. The first two digits identity the bank and the remaining 4 digits identify the branch.
    - IntlbankaccountsBrazilScheme
      - `bank` string, required — <a href="https://bank.codes/numero-do-banco/bank/banco-central-do-brasil/" target="_blank">ISPB (Identificador do Sistema de Pagamento Brazil)</a> - the Brazilian payment system bank ID, the value is eight alphanumeric characters.
      - `branch` string, required — Branch code, a four-digit value. Values under four digits are left-padded with zeroes.
      - `account_number` string, required — Account number. Cannot contain leading zeroes.
      - `supplementary_data` IntlbankaccountsBrazilSupplementaryData, required
        - `account_type` 'CACC' | 'SLRY' | 'SVGS' | 'TRAN', required — Account type: `CACC` - Checking/current account. Known as "conta corrente" in Portuguese, this is a bank account type designed for everyday financial transactions and is the most common type individuals and businesses use for day-to-day banking. `SVGS` - Savings account `TRAN` - Payment account. Payment institutions offer payment accounts to move funds and make payments, while banks offer checking accounts that include full financial services such as credit and investments. `SLRY` - Salary account. Employer deposits a fixed amount every month.
    - IntlbankaccountsBbanScheme
      - `bban` string, required — Basic Bank Account Number (BBAN). BBAN is a bank account numbering system used in many countries, especially in Europe.
    - IntlbankaccountsAchScheme
      - `account_number` string, required — Account number
      - `routing_number` string, required — A routing number is a nine-digit number used to identify a financial institution in the United States. It is also known as an ABA (American Bankers Association) number.
    - IntlbankaccountsFedWireScheme
      - `account_number` string, required — Account number
      - `routing_number` string, required — A routing number is a nine-digit number used to identify a financial institution in the United States. It is also known as an ABA (American Bankers Association) number.
    - IntlbankaccountsClabeScheme
      - `clabe` string, required — The Clave Bancaria Estandarizada (CLABE) is an 18-digit standardized bank code used for identifying bank accounts in Mexico.

## Other responses

- `400` — Bad
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/pismo/apis/platform-authentication.md) · [All operations](https://skmtc.net/pismo/apis/platform-authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pismo/platform-authentication/revisions/935b62e16de4/schema)