Skip to main content

BR Bank account

Brazil Bank account

Required Fields:

  • accountNumber
  • branchCode
  • bankCodeId
  • accountType
idstring

The instrument id

customerIdstring

The customer to which this instrument belongs.

Example: 5435323362
instrumentTypeInstrumentType (string)required

Represents the type of the instrument.

ValueDescription
SEPA_BANK_ACCOUNTSEPA Bank account
UK_BANK_ACCOUNTUK Bank account
US_BANK_ACCOUNTUS Bank account
CCI_BANK_ACCOUNTCCI Bank account
BR_BANK_ACCOUNTBR Bank account
PH_BANK_ACCOUNTPH Bank account
CLABE_BANK_ACCOUNTCLABE Bank account
CARDCard
QR_CODEQR Code

Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT, CCI_BANK_ACCOUNT, BR_BANK_ACCOUNT, PH_BANK_ACCOUNT, CLABE_BANK_ACCOUNT, CARD, QR_CODE]

Example: CARD
externallyVerifiedboolean

Is the instrument externally verified.

Default value: false
statusstring

The instrument status.

Possible values: [VERIFIED, UNVERIFIED, VERIFICATION_REQUIRED, REJECTED]

creationTimestring<date-time>

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z
accountNumberstringrequired

The bank account number.

Possible values: >= 2 characters and <= 12 characters

branchCodestringrequired

The code of the bank branch.

Possible values: >= 4 characters and <= 7 characters

bankCodeIdstringrequired

The Bank code id. Represents the id by which the bank code is recognized in EW.

accountTypestringrequired

Type of bank account

Possible values: [CHECKING, SAVINGS]

BR Bank account
{
  "id": "string",
  "customerId": "5435323362",
  "instrumentType": "CARD",
  "externallyVerified": false,
  "status": "VERIFIED",
  "creationTime": "2021-07-15T17:54:12Z",
  "accountNumber": "string",
  "branchCode": "string",
  "bankCodeId": "string",
  "accountType": "CHECKING"
}