GuidesAPI ReferenceCommunity
GuidesCommunityLog In

Consultar status do Boleto

Usado para

  • Verificar o estado de um Boleto único emitido por um Beneficiário específico;
  • Verificar uma lista de Boletos emitidos por um Beneficiário específico;
  • Listar todos Boletos emitidos por um beneficiário;

Máquina de estados

statusstatus

status

estado

descrição

pending_registration

  • Boleto criado

pending_payment

  • Boleto registrado na CIP e aguardando o pagamento na Instituição Financeira

processing_payment

  • Boleto pago na IF

paid

  • Executa baixa operacional

executed

  • Executa baixa efetiva

expired

  • Boleto com data de expiração ultrapassado

Consultar status de um boleto

Request

GET {{BASE_URL}}/emission/beneficiary/{{CNPJ_BENEFICIARIO}}/boleto/{{BOLETO_ID}}
curl --location -g --request GET '{{BASE_URL}}/emission/beneficiary/{{TAXID_BENEFICIARIO}}/boleto/{{BOLETO_ID}}'

Consultar uma lista de Boletos emitidos de um Beneficiário

GET {{BASE_URL}}/emission/beneficiary/{{CNPJ_BENEFICIARIO}}/boleto
curl --location -g --request GET '{{BASE_URL}}/emission/beneficiary/{{TAXID_BENEFICIARIO}}/boleto'

Configurando taxas e descontos

📘

Importante!

Para que um Boleto esteja apto para o pagamento em uma Instituição Financeira, é obrigatoriamente necessário que o Boleto esteja no estado pending_payment

Pagamento de Boletos com data expirada

Para Boletos que tenham data de expiração ultrapassado, o pagamento deste devem seguir as regras:

  • O boleto expirado deve ter a permissão para ser pago após a data de sua expiração. Caso contrário não é possível o seu pagamento.
  • O boleto expirado deve ter seu valor atualizado pelo endpoint de validação de boleto para atualizar seu valor com as taxas aplicáveis;

Did this page help you?