⌘K

Comprovante Pix (PDF)

Obtenha o comprovante de um pagamento Pix liquidado como documento PDF codificado em base64.

GET/api/v2/pix/payments/receipt/{endToEndId}

Retorna o comprovante legal do pagamento Pix liquidado em formato PDF, codificado em string base64. Requer o escopo pix.read.

Base URL: https://pagamentos.basspago.com.br

Headers

Header	Valor	Descricao
`Authorization`	Bearer {access_token}	Token de acesso obtido via OAuth2

Parametros de Rota

Nome	Tipo	Descricao
`endToEndId`	string	Identificador único (endToEndId) da operação Pix da qual deseja extrair o comprovante

Exemplo de Response

{
  "data": {
    "pdf": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCg=="
  }
}

Exemplos de Codigo

curl -X GET \
  https://pagamentos.basspago.com.br/api/v2/pix/payments/receipt/E12345678202606112115s0987654321 \
  --cert ./client.crt \
  --key ./client.key \
  -H 'Authorization: Bearer {access_token}'

O campo data.pdf contém o documento em base64. Decodifique o conteúdo e salve com a extensão .pdf para obter o comprovante. O endToEndId é retornado na criação do pagamento e nas notificações de webhook.

Erros

Status	Descrição
`401`	Token de autenticação inválido ou expirado
`403`	Credencial sem permissão para acessar este recurso
`404`	Nenhuma transação Pix localizada com o endToEndId informado
`500`	Erro inesperado ao gerar o comprovante PDF