Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Bank accounts

Search bank account

Search for a bank account using various account schemes.

post/v3/bank-accounts/{schemeName}/search

Path parameters

schemeName'IBAN' | 'UK-SCAN' | 'BRAZIL' | 'BBAN' | 'ACH' | 'FEDWIRE' | 'CLABE' required

Bank account's scheme (account type): IBAN - International Bank Account Number
UK-SCAN - UK bank account - sort code + account number (SCAN) BRAZIL - Brazilian bank account BBAN - Basic Bank Account Number ACH - Automated Clearing House for US Account FEDWIRE - US Account scheme CLABE - Mexico bank account scheme

Request body

Example request

{
  "scheme": {
    "iban": "GB29NWBK60161331926819"
  }
}

Response

Success

account_idinteger

Account ID

creation_datetimestring date-time

Account creation date time displayed in ISO 8601 format 2023-04-12T23:20:50.52Z.

updated_datetimestring date-time

Updated date time. A RFC 3339 value, i.e., "2023-04-12T23:20:50.52Z".

metadataMetadata

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.

Example response

{
  "account_id": 78123456,
  "creation_datetime": "2023-04-12T23:20:50.52Z",
  "updated_datetime": "2023-04-12T23:20:50.52Z",
  "scheme": {
    "iban": "GB29NWBK60161331926819"
  }
}