Sign in

v1

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

Register UK bank account

Register a new bank account with UK's sort code + account number (SCAN) scheme.

In UK banking, a sort code is a unique identifier used to route money transfers between banks and financial institutions. Its similar to a routing number in the US. It is a six-digit number that identifies both the bank and the specific branch. Each bank and branch has its own unique sort code. The first two digits identify the bank and the remaining 4 digits identify the branch.

To read about Pismo's banking offerings, see Banking overview.

This endpoint generates a <a href="https://developers.pismo.io/events/docs/intl-bankaccounts-intl-bankaccount-register-1">Bank account registered</a> event.

post/v2/accounts/{accountId}/bank-accounts/uk-scan

Path parameters

accountIdstring required

Pismo account ID

Headers

Authorizationstring required

Account token - token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a <b>401 Unauthorized</b> message

Request body

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 request

{
  "scheme": {
    "sort_code": "123456"
  }
}

Response

Response

account_idinteger

Account ID

creation_datetimestring date-time

Account creation date time displayed in ISO 8601 format 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",
  "scheme": {
    "sort_code": "123456"
  }
}