BankAccount

As contas bancárias são formas de receber uma transferência em objetos do tipo Customer ou Company.

accountHolderNamestringrequired

O nome da pessoa ou empresa que possui a conta bancária. Este campo é obrigatório ao anexar a conta bancária a um objeto Customer ou Company.

accountHolderTypestringrequired

O tipo de entidade que detém a conta. Pode ser pessoa física ou empresa. Este campo é obrigatório ao anexar a conta bancária a um objeto Customer ou Company.

Possible values: [individual, company]

accountHolderDocumentstringrequired

O documento da entidade que detém a conta. Pode ser CPF ou CNPJ. Este campo é obrigatório ao anexar a conta bancária a um objeto Customer ou Company.

bankCodestringrequired

Código COMPE da Instituição Financeira.

bankNamestring

Nome do banco associado.

branchstringrequired

A agência da conta bancária.

numberstringrequired

O número da conta bancária. Deve ser uma conta corrente ou conta poupança.

digitstringrequired

accountTypestringrequired

Possible values: [current, savings]

createdAtdate-time

BankAccount

{
  "accountHolderName": "string",
  "accountHolderType": "individual",
  "accountHolderDocument": "string",
  "bankCode": "string",
  "bankName": "string",
  "branch": "string",
  "number": "string",
  "digit": "string",
  "accountType": "current",
  "createdAt": "2024-07-29T15:51:28.071Z"
}