Cancele os boletos gerados que ainda não foram pagos

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 os 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.
  • Boleto: para que a resposta da API seja preenchida, é recomendável que um boleto tenha sido gerado anteriormente.

Bora pro código?

383

Parâmetros da requisição

ParâmetroFormatoDescrição
id
obrigatório
inv_rMS993vSMQJWqH290qO99MccgID da fatura na Cora. Esse ID é criando quando a fatura é gerada.

Parâmetros da resposta

StatusStatus CodeCorpo
Sucesso204-
Erro422{ code: "REC-XXXX", message: "message" }

Dicas de implementação

188

Premissas

O parâmetro start e o parâmetro end são usados para especificar o intervalo de tempo desejado na consulta. É importante notar que as datas inseridas no parâmetro end devem ser maiores que as datas informadas no parâmetro start

Descrição dos códigos de erro

Código de erroDescrição
REC - 0002-
REC - 0006O boleto já foi pago

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 integração
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!