Cancelar um pagamento pendente de aprovação

Fala, desenvolvedor. Neste tutorial vou te mostrar como cancelar uma iniciação de pagamento que ainda não foi aprovada.

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.

Para acessar os produtos desta API, é necessário que sejam enviados os seguintes escopos:

Escopos	Descrição
`openid`	Consultar perfil do usuário
`empresas.btgpactual.com/payments`	Permite criar e consultar pagamentos.

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 sandbox	Endpoint produção
https://api.sandbox.empresas.btgpactual.com/30306294000145/banking/payments/approvals/{{paymentId}}	https://api.empresas.btgpactual.com/30306294000145/banking/payments/approvals/{{paymentId}}

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

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

Para iniciarmos o cancelamento, basta:

Configurar a authorização para bearer token e passar nosso Access Token válido;
Realizar uma requisição DELETE para o endpoint passando o companyId correto e um approvalId válido;

Como response você receberá um 204 indicando que o cancelamento foi um sucesso.