delete https://api.stage.cora.com.br/invoices/
Cancele os boletos gerados que ainda não foram pagos
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.
Parâmetros da requisição
Parâmetro | Formato | Descrição |
---|---|---|
id obrigatório | inv_rMS993vSMQJWqH290qO99Mccg | ID da fatura na Cora. Esse ID é criando quando a fatura é gerada. |
Parâmetros da resposta
Status | Status Code | Corpo |
---|---|---|
Sucesso | 204 | - |
Erro | 422 | { code: "REC-XXXX", message: "message" } |
Dicas de implementação
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 startDescrição dos códigos de erro
Código de erro | Descrição |
---|---|
REC - 0002 | - |
REC - 0006 | O 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.
Opa, agora é hora do lanche!
Sim, finalizamos a etapa de integração