get https://api.stage.cora.com.br/v2/invoices/
Verifique mais informações sobre determinado boleto através desta API
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 | Tipo | Descrição |
---|---|---|
invoice_id obrigatório | String | Identificador da fatura na Cora. Esse id poderá ser usado para consultar os detalhes da fatura |
Parâmetros da resposta
Parâmetro | Tipo | Descrição |
---|---|---|
id obrigatório | String | Identificador da fatura na Cora. Esse id poderá ser usado para consultar os detalhes da fatura |
status obrigatório | String | Indica qual é o estado da fatura. Os status possíveis estão na Tabela de status da fatura Tabela de status da fatura |
created_at obrigatório | String | Data de criação da fatura |
total_amount obrigatório | Int | Valor total em centavos da fatura. Esse valor é a soma dos valores informados no parâmetro services |
total_paid obrigatório | Int | Valor total pago (em centavos), caso a fatura ainda não tenha sido pago, ele será zerado. |
occurrence_date opcional | String | Data que o cliente efetuou o pagamento do boleto junto ao banco. |
code obrigatório | String | Código definido por você, pode ser um id do recurso no seu sistema. Nós iremos retornar esse código sempre que você consultar uma fatura |
customer obrigatório | Customer | Objeto Customer |
services obrigatório | Lista de Services | Lista de objetos Services |
payment_terms obrigatório | PaymentTerms | Objeto PaymentTerms |
payment_options obrigatório | PaymentOptions | Objeto PaymentOptions |
payments obrigatório | Payments | Lista de objetos Payments. Caso o pagamento ainda não tenha sido feito o array será vazio |
pix obrigatório | Pix | Objeto Pix |
Dicas de implementação
Premissas
Para garantir a segurança e privacidade das suas informações pessoais e financeiras, a consulta detalhada de boletos só será possível se você utilizar o identificador de boletos gerados através do seu token de acesso.Erros Comuns
Código de erro | Descriçã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) | Requisição mal formatada. Alguns exemplos comuns: - O identificador do boleto não está de acordo com o padrão inv_... |
404 (Not Found) | A consulta do boleto com o identificador informado não pôde ser realizada. Isso pode ser devido a duas razões: o boleto não existe ou a consulta foi afetada pelas restrições de privacidade do token utilizado, que permitem apenas a consulta de boletos gerados por você. |
Tipos de Enumeradores
Estados dos boletos
Parâmetro | Descrição |
---|---|
CANCELLED | Boletos cancelados |
DRAFT | Boletos em rascunho, um estado intermediário entre criação e registro |
IN_PAYMENT | Boletos em processo de pagamento |
INITIATED | Boletos iniciados, aguardando a atualização dos próximos passos do fluxo |
LATE | Boletos com pagamento em atraso, ou seja, após a data de vencimento |
OPEN | Boletos registrados, mas ainda não pagos |
PAID | Boletos que foram pagos com sucesso |
RECURRENCE_DRAFT | Boletos criados com recorrência que nos quais o usuário não deu andamento à criação da cobrança |
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 mais uma etapa de sua integração