Gerar Recibo

Fala, desenvolvedor. Neste tutorial vou mostrar como você pode gerar o recibo de um pagamento já efetuado.

Importante

  • A API de pagamentos não transfere dinheiro imediatamente entre contas.
  • Visite O que são os pagamentos? para conhecer o ciclo de vida dos pagamentos
  • Operamos por meio da criação de uma instância de pagamento que necessita ser aprovada manualmente na conta.
  • Para ver mais informações sobre pagamentos, visite nossa página na documentação: Pagamentos.

Escopos

Para acessar os produtos desta API, é necessário que sejam enviados os seguintes escopos no fluxo de autorização:

EscoposDescrição
openidConsultar perfil do usuário
empresas.btgpactual.com/paymentsPermite criar e consultar pagamentos.

Fluxo autorização

Essa API utiliza o Access Token obtido através do Auth Code Flow. Temos um tutorial de como você gera esse código e gera um Access Token com ele Aqui

Endpoint

Campo companyId

Esse dado é o CNPJ da conta que deseja operar. Muito provavelmente é sua conto ou do seu empregador.

Campo paymentId

O paymentId é um parâmetro obtido por meio da listagem de pagamentos pendentes de aprovação e representa uma única iniciação de pagamento.

Iniciando

Para gerarmos o recibo, basta:

  • Configurar a autorização para bearer token e passar nosso Access Token válido;
  • Realizar uma requisição GET para o endpoint passando o companyId correto e um paymentId válido;
GetReceipt-1

Após isso, você receberá como response um PDF em base 64:

GetReceipt-2

Com isso, basta decodifica-lo e você terá o recibo do pagamento referente ao paymentId que foi passado.


Postman

Temos uma collection do postman com todas as requests mais utilizadas e demandadas pelos nossos clientes. Para encontra-lá basta visitar nossa página Postman Collections