Pular para o conteúdo

Obter PDF do boleto

GEThttps://api.sandbox.cefispay.com.br/api/v1/payment/{uuid}/invoice

Retorna o PDF do boleto correspondente ao pagamento especificado pelo UUID especificado. Atenção: deve ser o UUID do pagamento, não o ID. Apenas para pagamentos que tenham boleto como método habilitado e ainda não estejam pagos.

Parâmetros de path

  • uuidstringobrigatório

    O UUID do pagamento para o qual o boleto será gerado. Para obter o UUID, consulte a documentação de detalhes do pagamento.

Respostas

200O boleto em PDF.

Corpo da resposta

application/pdf

  • file

Exemplo

string
404Pagamento não encontrado

Sem corpo de resposta.

500Erro inesperado

Corpo da resposta

application/json

  • codestring

    O código do erro. Ex.: VALIDATION_ERROR, FORBIDDEN_ERROR, UNEXPECTED_ERROR.

  • messagestring

    A mensagem do erro.

  • errorsobject

    Os erros de cada campo, quando o code é VALIDATION_ERROR.

  • timestampstringdate-time

    A data e hora do erro, em UTC.

  • request_idstring

    Um identificador único gerado para esta resposta de erro.

  • documentation_urlstring

    O endereço desta documentação.

  • suggestionstring

    Uma sugestão de como resolver o erro.

Exemplo

{
  "code": "UNEXPECTED_ERROR",
  "message": "Houve um erro inesperado.",
  "timestamp": "2026-10-22T12:04:46+00:00",
  "request_id": "868443d3-38fd-4c92-8ea8-7cccbbce4308",
  "documentation_url": "https://docs.ninepay.com.br",
  "suggestion": "Verifique todos os parâmetros da requisição. Se o erro persistir, entre em contato com nossa equipe em ti@ninepay.com.br."
}

Linguagem

curl --request GET \
     --url https://api.sandbox.cefispay.com.br/api/v1/payment/uuid/invoice \
     --header 'accept: application/pdf'

Resposta

Clique em Try It! para enviar uma requisição e ver a resposta aqui

Ou escolha um exemplo:

application/pdf