Testando pagamento de contas
Utilize a linha digitável de um boleto criado no Sandbox para homologar o pagamento de contas sem movimentar valores reais.
Ao concluir este guia, você terá criado um pagamento de conta e validado o processamento da operação no Sandbox.
Quando utilizar
Use este fluxo para testar:
- pagamentos de contas pela API;
- automações de contas a pagar;
- integrações com sistemas ERP;
- validações de saldo;
- tratamento das respostas da API;
- cenários de sucesso e erro.
Antes de começar
Você precisa:
- Ter uma conta e uma chave de API de Sandbox.
- Possuir saldo disponível para o teste.
- Criar uma cobrança por boleto no Sandbox.
- Obter a linha digitável do boleto.
- Utilizar o endpoint de pagamento de contas.
Caso a conta não tenha saldo, consulte Adicione saldo à sua conta Sandbox.
Como funciona
Criar uma cobrança
por boleto
↓
Obter a linha digitável
↓
Criar o pagamento
pela API
↓
Acompanhar o processamento
↓
Validar o resultado1. Crie um boleto no Sandbox
Crie uma cobrança por boleto na mesma conta Sandbox utilizada para realizar o pagamento.
Após a criação, copie a linha digitável gerada.
Utilize somente boletos criados no Sandbox.
Boletos externos ou de Produção não devem ser usados nesse fluxo de homologação.
2. Crie o pagamento de conta
Utilize a linha digitável no endpoint de pagamento de contas.
Os principais campos são:
| Campo | Finalidade |
|---|---|
identificationField | Linha digitável do boleto |
scheduleDate | Data programada para o pagamento |
description | Identificação interna da operação |
value | Valor do pagamento |
Consulte Criar um pagamento de conta para conhecer todos os parâmetros e regras do endpoint.
3. Valide o resultado
Após enviar a requisição:
- confira o status HTTP e o corpo da resposta;
- armazene o ID do pagamento;
- acompanhe o status da operação;
- confirme se sua aplicação processou o resultado corretamente;
- registre possíveis falhas para análise.
O processamento ocorre somente para homologação.
Nenhuma instituição financeira é acionada e nenhum valor real é movimentado.
Caso o pagamento não seja criado
Verifique se:
- a linha digitável foi copiada corretamente;
- o boleto foi criado no Sandbox;
- a conta possui saldo suficiente;
- a URL utilizada pertence ao Sandbox;
- a chave de API pertence ao mesmo ambiente;
- os campos obrigatórios foram enviados corretamente;
- a data programada é válida.
Diferenças entre Sandbox e Produção
| Sandbox | Produção |
|---|---|
| Utiliza boletos criados para teste | Utiliza boletos reais |
| Não movimenta valores reais | Movimenta recursos financeiros |
| Não depende do processamento bancário | Depende das instituições envolvidas |
| Serve para homologar a integração | Produz efeitos financeiros reais |
O sucesso do teste no Sandbox não garante o processamento de qualquer boleto em Produção, pois o ambiente produtivo possui validações e dependências externas.
Checklist de homologação
Antes de considerar o fluxo homologado, confirme se sua aplicação:
- valida o saldo antes da operação;
- trata respostas de sucesso e erro;
- armazena o ID do pagamento;
- acompanha alterações de status;
- impede pagamentos duplicados;
- registra logs suficientes para investigação;
- diferencia corretamente Sandbox e Produção;
- não utiliza dados produtivos nos testes.
Próximos passos
Updated 18 days ago