Create Outbound Bank Account

Create Outbound Bank Account

POST {{Environment_URL}}/customers/v1/partner/physical/:cpf/accounts/outbound/:currency

This route creates a new outbound bank account record for a client, which is necessary for certain types of remittance operations. The specific validation rules for the account depend on the destination country and currency.

Body Object

Attribute
Description
Type
Required

bankName

The name of the bank. Must be alphanumeric and may include: ()&`’" -,. and spaces. Must be encoded using encodeURI.

String

Yes

number

The bank account number. - Euro Zone: Alphanumeric, may include \ or /. Min 4, Max 50 chars. - USA: Numeric only. Min 4, Max 50 chars. Must be encoded using encodeURI.

String

Yes

iban

The IBAN code. Required and validated only for remittances to the Euro Zone (currency = EUR).

String

-

bankCountry

The country of the bank in ISO 3166-1 alpha-3 format. Must be from the list of available countries. (use Get Avaiable Countries route.)

String

Yes

bankCode

The bank code. Alphanumeric, 3 characters. Required only for currency = CAD.

String

Yes

currency

The currency of the account in ISO 4217 alpha-3 format.

String

No

code

An object containing the routing code information. See Code object below.

Object

Yes

beneficiaryDocument

An object containingthe beneficiary document. See beneficiaryDocument below.

Object

No

We recommend the use of the following lib to validate the Iban code: https://www.npmjs.com/package/iban

The iban is required only when currency equals to EUR.

The bankCode is required only when currency equals to CAD.

When the currency isn't informed, the default value is USD for when the bankCountry equals to USA, or EUR for any other case.

Code Object

Attribute
Description
Type
Required

option

The type of routing code. Must be one of: ACH, SWIFT_BIC, SORT_CODE, TRANSIT, BSB_CODE.

String

Yes

value

The value of the routing code. See validation rules below.

String

Yes

Important Notes & Validation Rules

Read more about ACH validation

Default Behavior

  • If currency is not provided, it defaults to:

    • USD if bankCountry is USA.

    • EUR for any other country.

Currency-Specific Validations

The system applies different validation logic based on the currency field.

Currency

Required code.option

code.value Validation

Additional Requirements

USD

ACH

Numeric, 9 characters.

-

EUR

SWIFT_BIC

Uppercase alphanumeric, 8 or 11 characters. Must start with letters.

iban is required.

GBP

SORT_CODE

Numeric, 6 characters.

-

CAD

TRANSIT

Numeric, 5 characters.

bankCode is required.

AUD

BSB_CODE

Numeric, 6 characters.

-

Tip: Always ensure the provided code.option and code.value are appropriate for the account's currency to avoid validation errors.

Headers

Name
Value
Description

Authorization

Bearer <token>

Bearer Token obtained via sign-in

client-key

123ABCD456

Client authentication key, obtained via webhook.

Path Params

Key
Description
Required
Data Type
Example

cpf

CPF in format 00000000000

true

String

12345678900

currency

Currency Code

true

String

USD

Request Body

Response

PreviousBank Accounts - Physical PersonNextList Outbound Bank Accounts