Contexto
É possível simular um pagamento de boleto em ambiente de homologação utilizando dados disponíveis na massa de testes do nosso fornecedor.
Para isso, é necessário utilizar os dados disponíveis na tabela oficial de boletos de testes, que podem ser acessados através do seguinte link:
Pagamento de boletos via API
O fluxo de pagamento de boletos em ambiente de homologação é composto por duas etapas principais:
1. Consulta do boleto
Nesta etapa, você realiza a consulta dos dados do boleto a partir da linha digitável ou código de barras.
Endpoint:
{{url}}/v3/bills?document={{document}}
- document: representa a linha digitável ou o código de barras do boleto, conforme disponibilizado na massa de testes.
- A resposta irá conter os dados do boleto, como valor, data de vencimento, beneficiário e demais informações necessárias para a etapa de pagamento.
2. Pagamento do boleto
Após consultar o boleto, utilize os dados retornados para efetuar o pagamento com o endpoint de withdraw.
Endpoint:
{{url}}/v1/accounts/{{accountId}}/withdraw
É permitido o pagamento de boletos bancários e boletos de concessionárias (Utilities) através da API:
Pagamento de boleto bancário:
Exemplo de payload para pagamento de boleto bancário:
{
"externalIdentifier": "{{UUID}}",
"totalAmount": "{{TotalAmount}}",
"currency": "BRL",
"withdrawInfo": {
"withdrawType": "Boleto",
"boleto": {
"typeableLine": "{{document}}",
"dueDate": "2020-03-23"
},
"senderComment": "Comentario Pagamento de Boleto"
}
}
Pagamento de contas (Utilities):
Para simular o pagamento de contas de concessionárias (como água, luz, gás, etc.), o processo é similar ao do boleto bancário, mudando apenas o tipo de withdrawType.
Exemplo de payload para pagamento de Utilities:
{
"externalIdentifier": "{{UUID}}",
"totalAmount": "{{TotalAmount}}",
"currency": "BRL",
"withdrawInfo": {
"withdrawType": "Utilities",
"utilities": {
"typeableLine": "{{document}}",
"dueDate": "2019-12-10"
},
"senderComment": "Comentario Pagamento de Utilities"
}
}
Suporte
Para dúvidas ou acompanhamento de chamados, acesse: Portal de Suporte