Onboarding de recebedores

Etapas no painel

1. Cadastro e e-mail. A pessoa responsável cria o acesso e confirma o e-mail (o login fica bloqueado até a confirmação).
2. Titular e termos. Pessoa física ou jurídica (CPF ou CNPJ com dígitos verificadores), dados comerciais e aceite dos termos versionados. A conta no provedor é criada a partir daqui, como operação assíncrona.
3. Documentos. Conforme o provedor pedir: pelo link de envio do próprio provedor ou por upload no painel (PDF, JPG ou PNG).
4. Análise. O provedor avalia quatro frentes: dados comerciais, documentação, conta bancária e situação geral. A conta fica ativa com a aprovação geral, e então a chave Pix da conta é criada.
5. Confirmação anual. Os dados comerciais vencem e precisam ser confirmados no painel; vencidos, novas cobranças ficam restritas até a confirmação.

O que a integração consulta

{
  "id": "acc_01JDY7Q2M3N4P5R6S7T8V9W0XB",
  "environment": "sandbox",
  "kind": "SUBACCOUNT",
  "displayName": "Loja Exemplo",
  "status": "ACTIVE",
  "onboarding": {
    "general": "APPROVED",
    "documentation": "APPROVED",
    "commercialInfo": "APPROVED",
    "bankAccountInfo": "APPROVED"
  },
  "localSuspension": {
    "suspended": false,
    "reason": null
  }
}

{
  "accountId": "acc_01JDY7Q2M3N4P5R6S7T8V9W0XB",
  "environment": "sandbox",
  "asOf": "2026-11-13T13:00:00.000Z",
  "enabled": [
    "PAYMENTS",
    "PIX",
    "BOLETO",
    "CARD_TRANSPARENT"
  ],
  "restrictions": [
    {
      "code": "CONTRACT_PENDING",
      "capability": "PIX_FINANCED",
      "message": "Pix financiado indisponível: sem provedor de crédito."
    }
  ]
}

Consulte antes de oferecer um meio de pagamento e trate a recusa como estado normal: cobrança numa conta que ainda não pode vender responde 422 com o código da restrição; conta suspensa responde 403 ACCOUNT_SUSPENDED para novas operações.

const caps = await eclipta.getCapabilities();
if (!caps.enabled.includes("PIX")) {
  const motivo = caps.restrictions.find((r) => r.capability === "PIX" || r.capability === null);
  mostrarIndisponivel(motivo?.message ?? "Pix indisponível para esta conta.");
}

Produtos próprios e coprodutores

• Cada produto ou sistema integrado usa a própria chave de API, com os mesmos controles de um integrador externo. O pedido fica atribuído ao produto da chave, e a referência externa do pedido é única por produto.
• Os produtos da Xpertech (Educators, Órbita e Agenda Expert) vendem na conta do verdadeiro titular da venda. A ativação real depende do titular e do CNPJ de cada produto e da liberação de vendas próprias na conta raiz (BLK-12): até lá, só Sandbox com dados sintéticos.
• Split para coprodutores exige recebedores previamente cadastrados e autorizados (nunca uma carteira informada pelo pagador). Esse cadastro ainda não existe na API pública: cobranças com coprodutor ficam bloqueadas (BLK-S3-06).

Rotas