Cancelar um pagamento agendado

Fala, desenvolvedor! Neste tutorial vou te ensinar como cancelar iniciação de pagamento que já foi aprovada e agora se encontra agendada.

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:

Escopos	Descrição
`openid`	Consultar perfil do usuário
`empresas.btgpactual.com/payments`	Permite 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

Endpoint sandbox	Endpoint produção
https://api.sandbox.empresas.btgpactual.com/30306294000145/banking/payments/{{paymentId}}	https://api.empresas.btgpactual.com/{{companyId}}/banking/payments/{{paymentId}}

Campo `companyId`

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

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 iniciarmos o cancelamento, basta:

Configurar a autorizaçã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 paymentId válido;

Como response você obterá um 204 sinalizando que o cancelamento foi bem sucedido

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