Para realizar o download do arquivo de retorno, é necessário utilizar o ID retornado na rota "Consulta arquivo de retorno por período".
GET
Homologação:
https://homologacao.plugboleto.com.br/api/v1/boletos/retornos/id
Produção:
https://plugboleto.com.br/api/v1/boletos/retornos/id
*Deve ser informado o id do retorno que deseja realizar o download na URL da requisição. É o mesmo ID retornado na rotina de "Consulta arquivo de retorno por período". Ex: 1234567
Headers
| Nome | Descrição | Exemplo |
| Content-Type | Indica o tipo de arquivo | application/json |
| cnpj-sh | CNPJ ou CPF da Software House | 01001001000113 |
| token-sh | Token da Software House | f22b97c0c9a3d41ac0a3875aba69e5aa |
| cnpj-cedente | CNPJ ou CPF do Cedente | 01001001000113 |
Headers (Opcional)
Utilizar esses headers em caso de autenticação direto com as credenciais do cedente:
| Nome | Descrição | Exemplo |
| Content-Type | Indica o tipo de arquivo | application/json |
| cnpj-cedente | CNPJ do Cedente | 01001001000113 |
| token-cedente | Token do Cedente | f22b97c0c9a3d41ac0a3875aba69e5aa1 |
Retorno
Ao realizar a requisição será retornado um link para download do arquivo de retorno.
Exemplo de retorno:
{
"_status": "sucesso",
"_dados": {
"link": "https://plugboleto-retorno-production.s3.amazonaws.com/5e127e957c54b3?AWSAccessKeyId=&Expires=1598912683&Signature=FK3YDJ9O3oSqmvvNwTiw%3D&response-content-disposition=attachment%3Bfilename%3D%22retorno.ret%22"
}
}
Exemplo de retorno com erro:
{
"_status": "erro",
"_mensagem": "Acesso não autorizado.",
"_dados": [
{
"_erro": "Cedente não encontrado."
}
]
}
Comentários
0 comentário
Por favor, entre para comentar.