Gestão de Baixa de Boletos

Essa funcionalidade permite que o cliente inclua uma baixa de um boleto específico, fazendo com que ele fique impossibilitado de receber pagamentos.

Pré requisitos para implementação:

Possuir uma chave api da Celcoin, para mais informações acessar esse link
Ter familiaridade com o padrão REST usando o protocolo OAuth 2.0.
Ter o produto/solução contratado e habilitado em produção.
- Caso queira usar a funcionalidade em ambiente produtivo, por favor entre em contato com a nossa equipe comercial através do e-mail [email protected]. Para dúvidas técnicas, basta entrar em contato com o suporte através do link.
Possuir uma conta no BaaS da Celcoin (Conta essa responsável por receber o valor da cobrança)

Passos para Integrar

Realizar autenticação na API - [API Reference]
Inclusão de Baixa (Cancelamento) [API Reference]

Caso seja necessário você pode consultar a baixa manualmente.

Consultar Baixa- [API Reference]

2. Inclusão de Baixa (Cancelamento)

Para solicitar a inclusão de uma baixa, você deve informar um identificador para a baixa, especificar o boleto que será cancelado e o tipo de baixa. Veja o exemplo a seguir:

cURL da chamada

curl --request POST \
     --url https://sandbox.openfinance.celcoin.dev/billissuance/v1/settlement \
     --header 'accept: application/json' \
     --header 'content-type: application/*+json' \
     --data '
{
  "settlementType": "SOLICITACAO_CEDENTE",
  "tags": [
    {
      "key": "IDSAP",
      "value": "125262"
    }
  ],
  "requestId": "401943ae-b9d8-4e35-9816-eeecc1678357",
  "billId": "666cb7834d673f9983cbe3e1",
  "bankNumber": 143
}
'

Descrição dos campos

Campo	Descrição	Tipo Campo
requestId	Identificador da solicitação de baixa.	string
billId	Identificador único do boleto.	string
settlementType	Tipo de baixa. Valores aceitos: SOLICITACAO_CEDENTE - Baixa Solicitação Cedente. SOLICITACAO_DESTINATARIA* *- Baixa Solicitação Destinataria.	string
bankNumber	Indentificador do boleto que a baixa será realizada.
tags	Valores: Keyand Value	array of objects \| null

Exemplo de retorno

👍
Sucesso 201

{
  "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,
  "receivableScheduleDelay": 0,
  "receivableScheduleDate": "2025-10-22T16:54:37.028Z",
  "tags": [
    {
      "key": "IDSAP",
      "value": "125262"
    }
  ],
  "created": "2025-10-22T16:54:37.028Z",
  "updated": "2025-10-22T16:54:37.028Z"
}

Descrição dos campos

Campo	Descrição	Tipo Campo
id	Identificador único gerado automaticamente.	string
requestId	Identificador único da requisição.	string
settlementOrigin	Tipo de origem da baixa. Valores Retornados: INTERBANCARIA - Origem interbancaria. INTRABANCARIA* *- Origem intrabancaria.	string
settlementType	Tipo de baixa. Valores Retornados: SOLICITACAO_CEDENTE - Baixa Solicitação Cedente. SOLICITACAO_DESTINATARIA* *- Baixa Solicitação Destinataria.	string
billId	Identificador único do boleto.	string
billNumber	Código indentificador do boleto na JD.	int64
barcode	Código de barras.	string
settlementNumber	Código indentificador da baixa na JD.	int64
settlementReferenceNumber	Número Referência Atual Cadastro da Baixa.	int64
status	Situação da baixa. Valores Retornados: PROCESSAMENTO - Processamento. REJEITADA* - Rejeitada. REGISTRADA* - Registrada. CANCELADA* - Cancelada. DISTRIBUIDA* - Distribuida. OCORRENCIA* *- Ocorrência	string
issuerISPB		int32
receiverISPB		int32
value	Valor da baixa.	double
receivableScheduleDelay	Atraso do agendamento do recebimento.	int32
receivableScheduleDate	Data do agendamento do recebimento.	date-time
tags		array of objects \| null
created	Data de inclusão.	date-time
updated	Data de alteração.	date-time

❗
Error 400

{
  "version": "1.0.0",
  "status": "ERROR",
  "error": {
    "errorCode": "CBE001",
    "message": "Ocorreu um erro interno durante a chamada da api."
  }
}

Para validar os cenários de erro dessa API, acesse atabela de erros