---
title: "Consulta da baixa do boleto."
method: GET
path: "/settlement/{id}"
tags: ["Settlement"]
---

# Consulta da baixa do boleto.

`GET /settlement/{id}`

## Path parameters

- `id` string, required

## Response `200`

Success

- Settlement — Classe `Settlement` Modelo de baixa.
  - `id` string — Propriedade `Id` Identificador único gerado automaticamente.
  - `requestId` string, nullable — Propriedade `RequestId` Identificador único da requisição.
  - `settlementOrigin` 'INTERBANCARIA' | 'INTRABANCARIA' — Valores `SettlementOrigin` Tipo de origem da baixa.<p>Values:</p><ul><li><i>INTERBANCARIA</i> - Origem interbancaria.</li><li><i>INTRABANCARIA</i> - Origem intrabancaria.</li></ul>
  - `settlementType` 'SOLICITACAO_CEDENTE' | 'SOLICITACAO_DESTINATARIA' — Valores `SettlementType` Tipo de baixa.<p>Values:</p><ul><li><i>SOLICITACAO_CEDENTE</i> - Baixa Solicitação Cedente.</li><li><i>SOLICITACAO_DESTINATARIA</i> - Baixa Solicitação Destinataria.</li></ul>
  - `billId` string — Propriedade `Id` Identificador único do boleto.
  - `billNumber` integer, nullable — Propriedade `BillNumber` Código indentificador do boleto na JD.
  - `barcode` string, nullable — Propriedade `Barcode` Código de barras.
  - `settlementNumber` integer, nullable — Propriedade `SettlementNumber` Código indentificador da baixa na JD.
  - `settlementReferenceNumber` integer, nullable — Propriedade `SettlementReferenceNumber` Número Referência Atual Cadastro da Baixa.
  - `status` 'PROCESSAMENTO' | 'REJEITADA' | 'REGISTRADA' | 'CANCELADA' | 'DISTRIBUIDA' | 'OCORRENCIA' — Valores `SettlementStatus` Situação da baixa.<p>Values:</p><ul><li><i>PROCESSAMENTO</i> - Processamento.</li><li><i>REJEITADA</i> - Rejeitada.</li><li><i>REGISTRADA</i> - Registrada.</li><li><i>CANCELADA</i> - Cancelada.</li><li><i>DISTRIBUIDA</i> - Distribuida.</li><li><i>OCORRENCIA</i> - Ocorrência.</li></ul>
  - `issuerISPB` integer — Propriedade `IssuerISPB`.
  - `receiverISPB` integer — Propriedade `ReceiverISPB`.
  - `value` number, double, nullable — Propriedade `Value` Valor da baixa.
  - `receivableScheduleDelay` integer — Propriedade `ReceivableScheduleDelay` Atraso do agendamento do recebimento.
  - `receivableScheduleDate` string, date-time, nullable — Propriedade `ReceivableScheduleDate` Data do agendamento do recebimento.
  - `tags` Tag[], nullable — Propriedade `Tags` Lista de tags da baixa do boleto.
    - `key` string, nullable — Propriedade `Name` Chave da tag.
    - `value` string, nullable — Propriedade `Name` Valor da tag.
  - `created` string, date-time — Propriedade `Created` Data de inclusão.
  - `updated` string, date-time, nullable — Propriedade `Updated` Data de alteração.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found
- `500` — Server Error

---

[API](https://skmtc.net/celcoin/apis/api-para-transa-es.md) · [All operations](https://skmtc.net/celcoin/apis/api-para-transa-es/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/celcoin/api-para-transa-es/revisions/85dd6188a37b/schema)