---
title: "Register Brazilian bank account"
method: POST
path: "/v2/accounts/{accountId}/bank-accounts/brazil"
tags: ["Bank accounts"]
---

# Register Brazilian bank account

`POST /v2/accounts/{accountId}/bank-accounts/brazil`

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

To read about Pismo's banking offerings, see [Banking overview](https://developers.pismo.io/pismo-docs/docs/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.

## Path parameters

- `accountId` string, required

## Headers

- `Authorization` string, required

## Request body

- IntlbankaccountsIntlBankAccountBrazilRequest
  - `scheme` IntlbankaccountsBrazilScheme, required
    - `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.
  - `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).

## Response `201`

Register Brazilian bank account response body

- IntlbankaccountsIntlBankAccountBrazilResponse
  - `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`.
  - `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` IntlbankaccountsBrazilScheme, required
    - `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.

## Other responses

- `400` — Bad
- `403` — Forbidden
- `404` — Not Found
- `409` — Conflict
- `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)