POST /api/v1/accounts/onboarding/bank-account

Associa uma conta bancária ao seller de uma organização para liquidação Zoop

Cria e associa uma conta bancária ao seller de uma organização no gateway de pagamentos Zoop e a salva no banco de dados. A conta bancária é usada pela Zoop para liquidar automaticamente os valores do seller.

​

Autenticação

Requer autenticação via Supabase JWT (usuário autenticado).

​

Corpo da Requisição

organization_id · string · required

ID da organização cujo seller receberá a conta bancária.

holder_name · string · required

Nome completo do titular da conta bancária.

bank_code · string · required

Código do banco (COMPE). Ex: 001 para Banco do Brasil, 341 para Itaú.

routing_number · string · required

Número da agência (sem dígito verificador).

account_number · string · required

Número da conta com dígito verificador (ex: 12345-6).

taxpayer_id · string · required

CPF (Pessoa Física) ou CNPJ (Pessoa Jurídica) do titular da conta (sem formatação).

account_type · string · required

Tipo da conta: checking (corrente) ou savings (poupança).

​

Resposta

success · boolean

true quando a conta bancária foi cadastrada com sucesso.

bank_account · object

Dados da conta bancária criada.

Show Propriedades

id · string

ID interno da conta bancária no banco de dados

bank_code · string

Código do banco

bank_name · string

Nome do banco

routing_number · string

Número da agência

account_number_last4 · string

Últimos 4 dígitos do número da conta

account_type · string

Tipo da conta: checking ou savings

is_verified · boolean

Indica se a conta foi verificada pelo gateway

​

Exemplo

cURL

curl -X POST "https://api.chargefy.io/api/v1/accounts/onboarding/bank-account" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "organization_id": "org_xyz456",
    "holder_name": "João da Silva",
    "bank_code": "341",
    "routing_number": "1234",
    "account_number": "12345-6",
    "taxpayer_id": "12345678901",
    "account_type": "checking"
  }'

​

Resposta de Exemplo

{
  "success": true,
  "bank_account": {
    "id": "ba_internal_789",
    "bank_code": "341",
    "bank_name": "Itaú Unibanco",
    "routing_number": "1234",
    "account_number_last4": "2345",
    "account_type": "checking",
    "is_verified": false
  }
}

​

Erros

Status	Descrição
400	Campos obrigatórios ausentes
401	Token ausente ou inválido
404	Seller não encontrado para esta organização
500	Falha ao criar conta bancária no gateway ou ao salvar no banco de dados