Sign in

v1

latestOpenAPI 3.0.12026-07-245303882.5 MB
Settlement

Inclusão da baixa do boleto.

post/settlement

Request body

requestIdstring required

Propriedade RequestId Guid identificador da solicitação de baixa.

billIdstring required

Propriedade BillId Identificador único do boleto.

settlementType'SOLICITACAO_CEDENTE' | 'SOLICITACAO_DESTINATARIA' required

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>

bankNumberinteger required

Propriedade BankNumber Indentificador do boleto que a baixa será realizada.

Example request

{
  "requestId": "401943ae-b9d8-4e35-9816-eeecc1678357",
  "billId": "666cb7834d673f9983cbe3e1",
  "settlementType": "SOLICITACAO_CEDENTE",
  "bankNumber": 143,
  "tags": [
    {
      "key": "IDSAP",
      "value": "125262"
    }
  ]
}

Response

Created

idstring

Propriedade Id Identificador único gerado automaticamente.

requestIdstring 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>

billIdstring

Propriedade Id Identificador único do boleto.

billNumberinteger nullable

Propriedade BillNumber Código indentificador do boleto na JD.

barcodestring nullable

Propriedade Barcode Código de barras.

settlementNumberinteger nullable

Propriedade SettlementNumber Código indentificador da baixa na JD.

settlementReferenceNumberinteger 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>

issuerISPBinteger

Propriedade IssuerISPB.

receiverISPBinteger

Propriedade ReceiverISPB.

valuenumber double nullable

Propriedade Value Valor da baixa.

receivableScheduleDelayinteger

Propriedade ReceivableScheduleDelay Atraso do agendamento do recebimento.

receivableScheduleDatestring date-time nullable

Propriedade ReceivableScheduleDate Data do agendamento do recebimento.

createdstring date-time

Propriedade Created Data de inclusão.

updatedstring date-time nullable

Propriedade Updated Data de alteração.

Example response

{
  "id": "66144a44ae0569aaf2d67b73",
  "requestId": "0000000002-240517-000000000000000001",
  "settlementOrigin": "INTERBANCARIA",
  "settlementType": "SOLICITACAO_CEDENTE",
  "billId": "66144a44ae0569aaf2d67b73",
  "billNumber": 20221215000000000000,
  "barcode": "07799707771500000100000029170110202309261131",
  "settlementNumber": 20221215000000000000,
  "settlementReferenceNumber": 3024061305151269000,
  "status": "PROCESSAMENTO",
  "issuerISPB": 13935893,
  "receiverISPB": 13935893,
  "value": 145.2,
  "tags": [
    {
      "key": "IDSAP",
      "value": "125262"
    }
  ]
}