Testando pagamento de contas
O ambiente Sandbox permite homologar integrações relacionadas ao pagamento de contas sem necessidade de utilizar boletos reais ou realizar movimentações financeiras efetivas.
Para realizar os testes, utilize a linha digitável de um boleto gerado na sua própria conta Asaas em ambiente Sandbox.
Esse fluxo permite validar a criação de pagamentos, o processamento da operação e o comportamento da aplicação antes da utilização em produção.
Quando utilizar
Este cenário é recomendado para integrações que precisam:
- realizar pagamentos de contas via API;
- validar fluxos financeiros automatizados;
- homologar processos de contas a pagar;
- testar regras de negócio relacionadas a pagamentos;
- validar respostas da API e tratamento de erros.
Pré-requisitos
Antes de iniciar os testes, é necessário:
- Possuir uma conta Sandbox.
- Possuir saldo disponível para testes na conta.
- Gerar um boleto em ambiente Sandbox.
- Obter a linha digitável desse boleto.
- Utilizar o endpoint de pagamento de contas.
Caso ainda não possua saldo disponível para testes, consulte o guia de adição de saldo no Sandbox.
Como funciona o teste
O pagamento é realizado utilizando a linha digitável de um boleto criado na própria conta Sandbox.
Fluxo simplificado:
Gerar boleto
em Sandbox
↓
Obter linha digitável
↓
Criar pagamento
via API
↓
Processar pagamento
↓
Validar resultado
da integraçãoDessa forma, é possível homologar o fluxo completo sem depender de boletos externos ou operações bancárias reais.
Campos importantes da operação
Ao criar um pagamento de conta, alguns dados possuem papel fundamental no fluxo:
| Campo | Finalidade |
|---|---|
| identificationField | Linha digitável do boleto |
| scheduleDate | Data prevista para pagamento |
| description | Identificação interna da operação |
| value | Valor a ser pago |
ImportanteOs parâmetros completos da requisição estão disponíveis na documentação do endpoint.
Esta página tem como objetivo demonstrar como realizar a homologação da funcionalidade em Sandbox.
Exemplo de homologação
Um cenário comum consiste em:
- Criar uma cobrança em Sandbox.
- Copiar a linha digitável gerada.
- Utilizar essa linha digitável na requisição de pagamento de contas.
- Validar a resposta da API.
- Confirmar que sua aplicação processou corretamente o resultado da operação.
Esse fluxo permite validar a integração ponta a ponta antes da utilização em ambiente produtivo.
Comportamento esperado
Durante os testes em Sandbox:
- nenhum valor real é movimentado;
- nenhuma instituição financeira é acionada;
- o processamento ocorre apenas para fins de homologação;
- os resultados servem para validação da integração.
O objetivo é permitir que a aplicação teste seus fluxos financeiros sem riscos operacionais.
Diferenças entre Sandbox e Produção
| Sandbox | Produção |
|---|---|
| Utiliza dados simulados | Utiliza boletos reais |
| Não movimenta recursos financeiros | Movimenta recursos financeiros reais |
| Não depende de processamento bancário real | Depende de instituições financeiras |
| Possui finalidade exclusiva de homologação | Possui efeitos financeiros reais |
Por esse motivo, recomenda-se validar cuidadosamente o comportamento da aplicação antes da entrada em produção.
Possíveis dificuldades
Caso o pagamento não seja processado conforme esperado, verifique:
- se a linha digitável foi copiada corretamente;
- se o boleto utilizado foi criado em Sandbox;
- se existe saldo disponível para o teste;
- se os campos obrigatórios da requisição foram informados corretamente;
- se a autenticação está sendo realizada com uma API Key de Sandbox.
Boas práticas
Recomendado
- Utilize boletos gerados na própria conta Sandbox.
- Valide os cenários de sucesso e erro durante a homologação.
- Registre e monitore as respostas da API durante os testes.
- Teste o comportamento da aplicação diante de falhas de processamento.
- Não utilize dados de produção durante os testes.
Impactos operacionais
A homologação do pagamento de contas permite validar antecipadamente:
- regras de contas a pagar;
- automações financeiras;
- integrações com sistemas ERP;
- tratamento de respostas da API;
- fluxos internos da aplicação.
Uma validação adequada reduz falhas operacionais após a entrada em produção.
Referência da API
Veja a chamada para realizar um pagamento de contas:
