Skip to main content

​
Campos

CampoTipoDescrição
bankAccountIdUUIDIdentificador único
organizationIdUUIDReferência à organização da empresa
companyIdUUIDReferência à empresa dona da conta
externalProviderStringNome do provedor externo
externalProviderIdStringID da conta no provedor externo
bankCodeStringCódigo do banco
bankNameStringNome do banco
agencyNumberStringNúmero da agência
accountNumberStringNúmero da conta
accountTypeBankAccountTypeTipo da conta
holderNameStringNome do titular
holderDocumentStringDocumento do titular (normalizado e validado)
holderDocumentTypeDocumentTypeTipo do documento do titular
statusBankAccountStatusStatus da conta bancária
createdByUUID?Usuário que criou o registro, quando aplicável
createdAtDateTimeData de criação
updatedByUUID?Usuário que fez a última atualização, quando aplicável
updatedAtDateTimeData da última atualização

​
Relacionamentos

​
Regras de Negócio

  • Cada empresa possui no máximo uma conta bancária.
  • Obrigatória para que a empresa possa realizar saques.
  • bankCode, agencyNumber, accountNumber e holderDocument são normalizados e validados na entrada.
  • status tem default ACTIVE.

​
Enums

​
BankAccountStatus

ValorDescrição
ACTIVEConta bancária ativa
INACTIVEConta bancária inativa

​
BankAccountType

ValorDescrição
CHECKINGConta corrente
SAVINGSConta poupança

​
DocumentType

ValorDescrição
CPFPessoa física
CNPJPessoa jurídica
RGRegistro geral

​
Example

{
  "bankAccountId": "0197a817-f0e7-7c45-bcf2-5b6e967c2b2a",
  "organizationId": "0197a801-1690-7590-b3cf-19599b9be3e4",
  "companyId": "0197a801-6a42-79aa-9e56-d3c85148c0fa",
  "externalProvider": "billing_interface",
  "externalProviderId": "ba_5ad708e2",
  "bankCode": "001",
  "bankName": "Banco do Brasil",
  "agencyNumber": "1234",
  "accountNumber": "567890",
  "accountType": "CHECKING",
  "holderName": "Transportes Brasil Ltda",
  "holderDocument": "98765432000110",
  "holderDocumentType": "CNPJ",
  "status": "ACTIVE",
  "createdBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "createdAt": "2026-07-03T14:40:00.000Z",
  "updatedBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "updatedAt": "2026-07-03T14:40:00.000Z"
}