Simulação de Monitoramento Cadastral

Para facilitar a homologação das integrações, a Celcoin disponibiliza um endpoint de simulação (Playground) em ambiente Sandbox.
Por meio desse recurso, o parceiro poderá simular eventos de monitoramento cadastral sem depender de alterações reais na Receita Federal.

Por meio dele, será possível testar:

• alterações de situação cadastral;
• alterações de nome;
• alteração de razão social;
• alteração de nome fantasia;
• recebimentos de webhooks;
• validar as mudanças automáticas de status da conta.

O que acontece após a simulação?

A simulação executa o mesmo fluxo que seria acionado em uma alteração real recebida da Receita Federal. Dependendo do cenário informado, poderão ocorrer:

• Alteração do status da conta;
• Atualização dos dados cadastrais;
• Exclusão de chaves Pix;
• Transferências internas relacionadas ao encerramento;
• Envio dos webhooks correspondentes ao parceiro.

Passos para Integrar

1. Realizar autenticação na API - [API Reference]
2. Realizar o lançamento na conta [API Reference]

Como funciona o simulador

O cliente poderá informar um CPF ou CNPJ já existente em sua base no ambiente Sandbox e simular diferentes cenários cadastrais.

Após a simulação:

• o evento será processado;
• os webhooks correspondentes serão enviados;
• as alterações poderão ser visualizadas.

Payload — Pessoa Física (PF)

Exemplo

{
  "documentNumber": "06239629502",
  "status": "pendente de regularizacao",
  "name": "João da Silva", 
  "socialName":"Teste"
}

{
  "documentNumber": "06239629502",
  "status": "pendente de regularizacao",
  "name": "João da Silva", 
  "socialName":"Teste"
}

Cenários disponíveis para teste

Payload — Pessoa Jurídica (PJ)

Exemplo

{
  "documentNumber": "08290441000106",
  "status": "BAIXADA",
  "businessName": "Celcoin Instituição de Pagamento S.A.",
  "tradingName": "Celcoin"
}

Cenários disponíveis para teste

Exemplo de retorno

{
    "version": "1.0.0",
    "status": "SUCCESS"
}

{
    "error": {
        "errorCode": "OBE157",
        "message": "O campo status precisa conter um valor válido."
    },
}