Sign in

v1

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

Register Brazilian bank account

Register a new bank account with Brazilian bank + branch + account number scheme.

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/brazil

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": {
    "bank": "76523A28",
    "branch": "0186",
    "account_number": "1773065291",
    "supplementary_data": {
      "account_type": "TRAN"
    }
  }
}

Response

Register Brazilian bank account response body

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": {
    "bank": "76523A28",
    "branch": "0186",
    "account_number": "1773065291",
    "supplementary_data": {
      "account_type": "TRAN"
    }
  }
}