Atualizar Boleto

A funcionalidade permite alterar as instruções de um boleto já emitido e registrado, sem a necessidade de cancelamento e reemissão do título. Por meio de uma única chamada de API, o cliente pode ajustar informações operacionais comuns do ciclo de cobrança: data de vencimento, dias de pagamento após o vencimento, valor, parâmetros de desconto e o campo de informações do boleto, enquanto o boleto ainda não estiver liquidado.

A alteração é aplicada no registro do boleto e refletida diretamente no layout final do título. Quando o boleto possuir QR Code Pix, o QR Code é atualizado automaticamente para manter a consistência com os novos dados. A linha digitável e o código de barras não são alterados, o que preserva a validade do título já distribuído ao pagador.

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)

• Possuir um boleto previamente emitido e registrado via BaaSPay – Emissão 509, com o respectivo transactionId da cobrança.

• Ter a funcionalidade de alteração de boleto habilitada para o seu cadastro.

Passos para Integrar

1. Realizar autenticação na API - [API Reference]
2. Alterar o Boleto - [API Reference]
3. Consultar a cobrança para confirmar os dados atualizados - [API Reference]

Alterar Boleto

Para alterar um boleto já emitido, informe o transactionId da cobrança na API de "Atualizar Boleto"e envie no corpo da requisição os campos que deseja atualizar.

cURL da chamada

curl --request PATCH \
     --url https://sandbox.openfinance.celcoin.dev/baas/v2/charge/transactionId \
     --header 'accept: application/json' \
     --header 'content-type: application/json-patch+json' \
     --data '
{
  "instructions": {
    "discount": {
      "amount": 3,
      "modality": "fixed",
      "limitDate": "2026-09-25T00:00:00.0000000"
    },
    "discountTwo": {
      "amount": 2,
      "modality": "fixed",
      "limitDate": "2026-09-20T00:00:00.0000000"
    },
    "discountThree": {
      "amount": 1,
      "modality": "fixed",
      "limitDate": "2026-09-29T00:00:00.0000000"
    }
  },
  "externalId": "externalId1",
  "duedate": "2026-09-30T00:00:00.0000000",
  "amount": 300,
  "expirationAfterPayment": 59,
  "informations": [
    "Emita na Celcoin seu Boleto."
  ]
}

Descrição dos campos

Exemplo de retorno

{
  "version": "1.0.0",
  "status": "SUCCESS",
  "body": {
    "transactionId": "string",
    "externalId": "string",
    "duedate": "2026-09-30T00:00:00.000Z",
    "amount": 0,
    "expirationAfterPayment": 0,
    "instructions": {
      "fine": 0,
      "interest": 0,
      "discount": {
        "amount": 0,
        "modality": "string",
        "limitDate": "2026-09-25T00:00:00.000Z"
      },
      "discountTwo": {
        "amount": 0,
        "modality": "string",
        "limitDate": "2026-09-28T00:00:00.000Z"
      },
      "discountThree": {
        "amount": 0,
        "modality": "string",
        "limitDate": "2026-09-29T00:00:00.000Z"
      }
    },
    "informations": [
      "string"
    ]
  }
}

{
  "version": "1.2.0",
  "status": "ERROR",
  "error": {
    "body": {
      "errorCode": "CBE005",
      "message": "A data de vencimento precisa ser maior ou igual a data atual."
    }
  }
}

Tabela de errorCode

Consultar o Boleto Alterado

A alteração de boleto não gera evento de webhook. Para validar que a alteração foi aplicada e conferir os dados vigentes do título: incluindo instruções, boleto e QR Code Pix atualizados, realize a consulta da cobrança na API.

Para mais detalhes de como utilizar essa API, acesse a documentação.