Listar pagamentos aprovados

Fala, desenvolvedor! Desta vez vou mostrar pra você como você lista as iniciações de pagamento aprovadas por meio da API de pagamentos do BTG Pactual Empresas!

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:

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 ou do seu empregador direto.

Iniciando

Para listar as instâncias de pagamentos aprovados, 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:
GetApproved-1

Após isso, receberemo como response um array de objetos data extenso contendo

  • O status do pagamento;
  • A quantia do pagamento do lote amount
  • A data de criação createdAt;
  • A última data de atualização updatedAt;
  • Um array items de objetos;
  • E as tags contendo alguns Ids.
GetApproved-2

Em items nós encontraremos os objetos referente aos pagamentos realizados no lote. O campo amount de todos os objetos dentro de items será equivalente ao do objeto em data:

GetApproved-3

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