Cancele a iniciação de um pagamento previamente iniciado através de API

154
Importante para Integração Direta Para você conseguir efetuar essa integração é obrigatória a leitura sobre "Utilização das APIs" e recomendada a leitura sobre "Instruções Iniciais" e "Client Credentials e Client ID"

Quais são requisitos para a utilização desta API?

  • Token: possuir um token de acesso válido é essencial. Caso ainda não tenha gerado um, temos um guia detalhado disponível no tópico Fluxos de Autorização e Autenticação.
  • Pagamento: para que a resposta da API seja preenchida, é recomendável que o pagamento de um boleto tenha sido iniciado ou agendado anteriormente, porém que não tenha sido aprovado ou reprovado pelo cliente através do aplicativo.
  • Escopo: para a modalidade Parceria Cora, é necessário ter ativado o escopo correto ao solicitar autorização e gerar token de acesso para que sua aplicação possa acessar e interagir com as informações da conta de forma segura e autorizada. É possível consultar mais detalhes sobre o escopo e autorização no tópico Redirecionamento.
Nome do escopoDescrição
paymentAPIs de iniciação de pagamento

Bora pro código?

383

Parâmetros da requisição

ParâmetroTipoDescrição
id
obrigatório
StringIdentificador do pagamento iniciado.

Dicas de implementação

188

Premissas

Por questões de privacidade e segurança, só é possível cancelar pagamentos iniciados pelo detentor do token de acesso utilizado, por isso, é necessário atenção ao token utilizado.

Erros Comuns

Código de erroDescrição
401 (Unauthorized)O token de acesso está inválido ou expirado. Erro comum no momento de trocas de ambientes (Stage/Production).
400 (Bad Request)O pagamento já foi recusado/aprovado ou ainda não foi iniciado.
500 (Internal Server Error)O id informado na requisição não existe ou não foi criado pelo mesmo usuário autenticado que está tentando cancelá-lo.

Integração Direta e Testes

Esta plataforma de documentação, atualmente, não permite o upload de informações importantes como certificados e private keys. Por isso, não recomendamos o uso dela para testes da modalidade de Integração Direta.

Para fazer os testes que incluam essas informações sensíveis pedimos que use um sistema de sua escolha.
Imagem
Opa, agora é hora do lanche! Sim, finalizamos a etapa de pagamentos
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!