[POST] /payment/:id/generate-pdf

Solicita a URL do PDF do boleto

Essa funcionalidade permite que os clientes da Fire Banking consigam gerar o PDF de um boleto.

Endpoint de produção

Método POST

https://api-gateway.firebanking.com.br/bank-slip/v1/payment/:id/generate-pdf

Requisição

Headers

Campo	Valor	Tipo	Descrição
Content-Type	application/json	string	Define o conteúdo como JSON
x-api-key	123	string	Sua chave de API

Parâmetros da rota

Campo	Obrigatório	Descrição
id	Sim	ID retornado no momento da criação do boleto ou external ID enviado no body da criação do boleto

Curl:

curl --request POST \
  --url 'https://api-gateway.firebanking.com.br/bank-slip/v1/payment/<id>/generate-pdf' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <sua-chave-api>'

Exemplo de resposta

HTTP Status 200 - Sucesso

{
  "pdfAccessUrl": "https://s3.us-east-1.amazonaws.com/dev.documents.pagamentos/boletos/abcdefg1234567890/abcdefg1234567890abcdefg.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAZJHA22DGETYU5IUT%2F20250412%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250412T121530Z&X-Amz-Expires=604800&X-Amz-Signature=6a7b543fb6f49f0f9b5b216e2a1238b4faed3485291f625957c22369de5b59f&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject",
}

HTTP Status 404 - Not found

{
    "message": "Payment with id 3f73ad66-04cb-4c2d-9520-e41e41c576cd not found",
    "error": "Not Found",
    "statusCode": 404
}

HTTP Status 400 - Bad request

{
    "message": [
        "Can not generate PDF for this payment"
    ],
    "error": "Bad Request",
    "statusCode": 400
}