Verifique mais informações sobre determinado boleto através desta 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 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âmetroTipoDescrição
id
obrigatório
StringIdentificador da fatura na Cora. Esse id poderá ser usado para consultar os detalhes da fatura

Parâmetros da resposta

ParâmetroTipoDescrição
id
obrigatório
StringIdentificador da fatura na Cora. Esse id poderá ser usado para consultar os detalhes da fatura
status
obrigatório
StringIndica 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
StringData de criação da fatura
total_amount
obrigatório
IntValor total em centavos da fatura. Esse valor é a soma dos valores informados no parâmetro services
total_paid
obrigatório
IntValor total pago (em centavos), caso a fatura ainda não tenha sido pago, ele será zerado.
occurrence_date
opcional
StringData que o cliente efetuou o pagamento do boleto junto ao banco.
code
obrigatório
StringCó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
CustomerObjeto Customer
services
obrigatório
Lista de ServicesLista de objetos Services
payment_terms
obrigatório
PaymentTermsObjeto PaymentTerms
payment_options
obrigatório
PaymentOptionsObjeto PaymentOptions
payments
obrigatório
PaymentsLista de objetos Payments. Caso o pagamento ainda não tenha sido feito o array será vazio
pix
obrigatório
PixObjeto Pix

Dicas de implementação

188

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 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)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âmetroDescrição
CANCELLEDBoletos cancelados
DRAFTBoletos em rascunho, um estado intermediário entre criação e registro
IN_PAYMENTBoletos em processo de pagamento
INITIATEDBoletos iniciados, aguardando a atualização dos próximos passos do fluxo
LATEBoletos com pagamento em atraso, ou seja, após a data de vencimento
OPENBoletos registrados, mas ainda não pagos
PAIDBoletos que foram pagos com sucesso
RECURRENCE_DRAFTBoletos 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.
Símbolo na cor rosa ao fundo com um pão de forma e ovo frito em cima
Opa, agora é hora do lanche! Sim, finalizamos mais uma etapa de sua integração

Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!