Skip to main content
GET
Contas de uma entidade

Visão geral

As contas são recursos filhos de entidades pessoa e empresa. Elas permitem cadastrar várias contas por cliente, inclusive em moedas diferentes. Cada conta possui um externalId definido pelo cliente, uma currency ISO 4217 e pelo menos um identificador de pagamento. Os dados ficam isolados na organização atual.

Endpoints

O mesmo CRUD existe para três buscas de entidade, no mesmo padrão de atualizar por external ID e PATCH /entities/by-tax-id/{taxId}: {accountId} é sempre o UUID Gu1 da conta (o de create/list). Busca por tax ID ignora pontuação e maiúsculas (CUIT 20-12345678-9 casa com 20123456789). Usa a mesma chave alfanumérica da unicidade de tax ID no nível da organização (idx_entities_org_norm_tax_id). Codifique o segmento de path se o valor tiver caracteres reservados. A leitura requer entities:read. As alterações requerem entities:edit, com fallback legacy entities:write.

Campos da conta

Tipos de conta aceitos

accountType aceita exclusivamente um destes valores:
  • Genéricos: bank_account, personal, business, other
  • Depósitos bancários: checking, savings, business_checking, business_savings, payroll, pension, money_market, fixed_deposit
  • Investimento e custódia: investment, brokerage, custody, escrow
  • Pagamentos e fundos digitais: payment, wallet, virtual_account, prepaid, merchant
  • Crédito: credit, loan
  • Operação institucional: correspondent, settlement, clearing, cash_management
Use bank_account quando souber que é uma conta bancária, mas não conhecer o produto, e other somente quando nenhuma categoria representar a conta. checking corresponde a conta corrente e savings a conta poupança. Um valor fora do enum retorna 400 VALIDATION_ERROR. Ao criar uma conta, pelo menos um destes campos é obrigatório: accountNumber, cbu, cvu, iban ou alias.

Exemplo de criação

Criar com o seu externalId em vez do UUID da Gu1:
Criar por tax ID (a pontuação é opcional):
Ao enviar isPrimary: true, a API remove a marca principal das outras contas da mesma entidade e moeda.

Erros