Listar boleto completo

Sandbox

https://horizon-api-sb.app.rpe.tech

GET

/api/v1/servicos-bancarios/fatura/{idFatura}/boletos/ficha-compensacao

Use este endpoint para receber o boleto do portador via arquivo .pdf.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Path

Parâmetros Query

Parâmetros Header

Respostas

🟢200OK

application/pdf

Operação bem sucedida retorna um arquivo contendo a ficha de compensação com as informações necessárias para a efetivação do pagamento.

Body

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://horizon-api-sb.app.rpe.tech/api/v1/servicos-bancarios/fatura//boletos/ficha-compensacao?idContaBancaria' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'

Response Example

400 - idContaBancaria ausente

{
    "timestamp": "2024-08-02T09:20:45.446659174",
    "statusCode": 400,
    "message": "Campo obrigatório não enviado.",
    "path": "/api/v1/servicos-bancarios/fatura/2001/boletos/ficha-compensacao",
    "fieldErrors": [
        {
            "field": "idContaBancaria",
            "message": "Parametro de requisição obrigatório"
        }
    ]
}

Página anterior

Listar pagamentos

Próxima página

Listar contas habilitadas