Emitir Boleto/Cobrança

Essa funcionalidade permite que os clientes da Celcoin consigam criar cobranças para seus clientes, essas cobranças são em Boleto Registrado e em Pix Cobrança (Bolepix)

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]
Criar uma Cobrança - [API Reference]
Receber o Webhook com dados da Cobrança

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

Consultar Cobrança - [API Reference]

cURL da chamada

curl --location 'https://sandbox.openfinance.celcoin.dev/baas/v2/Charge' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--data '{
  "externalId": "TesteSandbox_123",
  "merchantCatagoryCode": "0000",  
  "expirationAfterPayment": 1,
  "dueDate":"2023-12-30",
  "amount": 10,
  "key":"[email protected]",
  "debtor": {
    "number": "123",
    "neighborhood": "Alphaville Residencial Um",
    "name": "Erick Augusto Farias",
    "document": "42318970858",
    "city": "Barueri",
    "publicArea": "Alameda Holanda",
    "state": "SP",
    "postalCode": "06474320"
  },
  "receiver": {
    "account" : "300543550143",
    "document": "46532252573"
  },
  "instructions": {
    "fine": 10,
    "interest": 5,
    "discount": {
      "amount": 1,
      "modality": "fixed",
      "limitDate": "2023-12-20T00:00:00.0000000"
    }
  }
}'

JSON de exemplo

{
  "externalId": "TesteSandbox_123",
  "merchantCatagoryCode": "0000",  
  "expirationAfterPayment": 1,
  "dueDate":"2023-12-30",
  "amount": 10,
  "key":"[email protected]",
  "debtor": {
    "number": "123",
    "neighborhood": "Alphaville Residencial Um",
    "name": "Erick Augusto Farias",
    "document": "42318970858",
    "city": "Barueri",
    "publicArea": "Alameda Holanda",
    "state": "SP",
    "postalCode": "06474320"
  },
  "receiver": {
    "account" : "300543550143",
    "document": "46532252573"
  },
  "instructions": {
    "fine": 10,
    "interest": 5,
    "discount": {
      "amount": 1,
      "modality": "fixed",
      "limitDate": "2023-12-20T00:00:00.0000000"
    }
  }
}

Descrição dos campos

Campo	Descrição	Tipo Campo
externalId	Identificador do cliente.	string
merchantCatagoryCode	Categoria do estabelecimento.	string
expirationAfterPayment	Define o período adicional permitido para pagamento após o vencimento da cobrança. Precisa ser entre 0 a 59. Não enviando o parâmetro, como default, assumirá o valor 0. Nota:_ Apesar do nome sugerir que o período ocorre após o pagamento, este campo define a janela de tolerância para pagamento após o vencimento. Caso o pagamento não seja efetuado dentro deste prazo, a cobrança será automaticamente cancelada.	string
duedate	Data de vencimento da cobrança.	string($date-time) example: 2023-12-30T00:00:00.0000000 (UTC-3 - Horário de Brasília)
amount	Valor da cobrança.	number
key	Chave pix da conta BaaS.	string
debtor.name	Nome do Pagador.	string
debtor.document	CNPJ ou CPF do pagador.	string
debtor.city	Cidade do pagador.	string
debtor.publicArea	Nome da rua do pagador.	string
debtor.state	Estado do pagador.	string
debtor.postalCode	CEP do pagador.	string
debtor.number	Número da Residência	string
debtor.complement	Complemento	string
debtor.neighborhood	Bairro	string
receiver.document	CNPJ ou CPF do beneficiário.	string
receiver.account	Número da conta BaaS do beneficiário.	string
instructions.fine	Multa aplicada após o vencimento - formato decimal (Porcentagem)	number example: 10 Valores aceitos: 0,1 a 100
instructions.interest	Juros aplicado após o vencimento - formato decimal (Porcentagem)	number example: 5 Valores aceitos: 0,1 a 100
discount.modality	fixed ou percent fixed para dar um desconto em valor ex: R$ 2,50 percent para dar um desconto em porcentagem ex: 10.00%	string
discount.amount	O valor do desconto	number
discount.limitDate	Data máxima para aplicação do desconto, ex: vencimento da cobrança dia 25 e desconto até o dia 20	string($date-time) example: 2023-12-20T00:00:00.0000000

🚧
Atenção!

Cálculo de Juros: A aplicação dos juros é calculada com base no valor total (em percentual) dividido por 30 dias (prática adotada pelo mercado, vide diretrizes do Banco Central):

Ex: Cobrança de R$150 com multa de 1%. O cálculo do juros seria R$150 * (1 / 100 / 30), resultando em R$0,05 de juros por dia.

Para clientes que utilizam a emissão de cobrança própria da Celcoin (509):

Permitido emitir cobranças de até 250 mil reais;

A taxa de juros aplicada não poderá ultrapassar 60% do valor total da cobrança;

Para Emissões do tipo "Aporte", os dados do Pagador (Debtor) e do Beneficiário Final (Receiver) devem ser os mesmos, sendo eles:

Nome

Documento (CPF ou CNPJ)

Cenários de Pagamento e Cancelamento:

Pagamento via QRCode (Pix): A baixa do código de barras (BarCode) do boleto ocorre automaticamente, evitando que o cliente final realize um pagamento duplicado;

Pagamento via BarCode (Código de Barras do Boleto): A baixa do QR Code ocorre no momento da identificação do pagamento do BarCode, de acordo com as janelas de liquidação.

*Obs.: Caso ocorra um pagamento duplicado, onde o cliente final pague primeiro via BarCode e, antes da identificação desse pagamento, também efetue o pagamento via QR Code, a responsabilidade pela devolução do valor ficará a cargo do próprio cliente Celcoin.

Para clientes que NÃO utilizam a emissão de cobrança própria da Celcoin:

Permitido emitir cobranças de até 50 milhões de reais. Entretanto, existem limites internos estabelecidos que podem variar de cliente para cliente. Em caso de dúvidas, entre em contato com o nosso time de Suporte através do link.

⚠️
Chave PIX na geração do boleto
A chave PIX é obrigatória no fluxo de geração do boleto, pois o tipo do boleto gerado é BOLEPIX.

👍
Importante
O valor mínimo para geração do boleto é R$5,00.

👍
Observação
Para boletos do tipo aporte/depósito, onde o pagador e o recebedor são a mesma pessoa, é obrigatório que o campo debtor.name seja exatamente igual ao nome informado no registro da conta.

Exemplo de retorno

👍
Sucesso 201

{
    "body": {
        "transactionId": "fab2c9c0-3bfa-4cc1-b999-4e191a893387"
    },
    "version": "1.0.0",
    "status": 201
}

❗
Error 400

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

Tabela de errorCode

Code	Message
CBE001	O identificador externo é obrigatório.
CBE002	Informar os dias de pagamento permitidos após o vencimento é obrigatório.
CBE003	Tempo de expiração após vencimento deve ser entre 0 e 59.
CBE004	A data de vencimento é obrigatória.
CBE005	A data de vencimento precisa ser maior ou igual a data atual
CBE006	O valor é obrigatório.
CBE007	O valor precisa ser maior que 5.
CBE008	Valor para recebimento parcial deve ser menor ou igual ao valor com desconto aplicado.
CBE009	Valor para recebimento parcial deve ser menor ou igual ao valor original.
CBE010	Não pode haver contas iguais para recebedores parciais.
CBE011	Máximo de 5 recebedores parciais por cobrança.
CBE012	É obrigatório informar a cidade do pagador.
CBE013	É obrigatório informar o CPF ou CNPJ do pagador.
CBE014	É obrigatório informar o nome do pagador.
CBE015	É obrigatório informar o CEP do pagador.
CBE016	O Cep informado não é válido.
CBE017	É obrigatório informar o logradouro do pagador.
CBE018	É obrigatório informar o Número do endereço do pagador.
CBE019	É obrigatório informar o Bairro do pagador.
CBE020	É obrigatório informar o Estado do pagador.
CBE021	É obrigatório informar o número da conta do recebedor.
CBE022	É obrigatório informar o CPF ou CNPJ do recebedor.
CBE023	Máximo de 20 caracteres permitido.
CBE024	Máximo de 100 caracteres permitido.
CBE025	Mínimo de 11 e máximo de 14 caracteres permitido.
CBE026	Apenas 2 caracteres permitido.
CBE027	Apenas 8 caracteres permitido.
CBE028	Máximo de 200 caracteres permitido.
CBE029	Documento recebedor não é válido.
CBE030	Documento pagador não é válido.
CBE031	O valor da multa deve estar entre 0.1 e 100.
CBE032	O valor dos juros deve estar entre 0.1 e 100.
CBE033	O valor de desconto precisa ser maior que 0.
CBE034	O valor total, após o desconto por pagamento antecipado, não pode ser inferior a R$ 5,00.
CBE035	É necessário informar a modalidade do desconto.
CBE036	A modalidade do desconto deve ser fixed ou percent.
CBE037	É necessário informar a data limite do desconto.
CBE038	A data limite do desconto não pode ser menor que a data atual.
CBE039	É obrigatório informar o número da conta de todos os recebedores parciais.
CBE040	É obrigatório informar o número de documento de todos os recebedores parciais.
CBE041	Porcentagem e valor devem ser preenchidos para caso de pagamento agregado.
CBE042	Apenas um dos campos de porcentagem ou valor deve estar preenchido.
CBE043	Quando valor é nulo, porcentagem deve ser preenchida.
CBE044	A porcentagem deve estar entre 0.1 e 100.
CBE045	Quando porcentagem é nula, valor deve ser preenchido.
CBE046	A quantidade deve ser maior que 0.
CBE047	Account não localizada para um dos recebedores parciais.
CBE048	Obrigatório o preenchimento do documento para todos os recebedores parciais.
CBE049	A data limite de desconto precisa ser menor ou igual a data de vencimento e não deve ultrapassar 20 dias.
CBE050	Número da conta do recebedor não localizada ou inativa.
CBE051	Chave pix não localizada para a conta informada.
CBE052	Obrigatório o preenchimento dos dados do pagador.
CBE053	Obrigatório o preenchimento dos dados do recebedor.
CBE054	Serviço de consulta a chave pix está indisponível no momento. Tente mais tarde.
CBE055	Serviço de consulta de contas está indisponível no momento. Tente mais tarde.
CBE056	Só é permitido atribuir um valor de até 2 casas decimais ao juros.
CBE057	Só é permitido atribuir um valor de até 2 casas decimais a multa.
CBE058	Só é permitido atribuir um valor de até 2 casas decimais ao desconto.
CBE059	Transação não foi localizada.
CBE060	Não foi possível criar transação.
CBE061	Cliente BaaS não localizado.
CBE062	Não foi possível realizar crédito em Conta Pagamento Proprietária.
CBE063	Não foi possível localizar o recurso de lançamento.
CBE064	Não foi encontrado registro para o identificador informado.
CBE065	Podem ser gerados PDF apenas de cobranças com status PENDING.
CBE066	Template não encontrado para a geração de PDF.
CBE067	Sessão ServiceBus de SessionId expirada.
CBE068	Não foi possivel realizar essa operação.
CBE069	Erro em lançamento para conta beneficiária.
CBE070	Erro em cancelamento de boleto.
CBE071	Erro em cancelamento de pix.
CBE072	Não foi possível identificar o evento.
CBE073	O hash de confirmação é obrigatório.
CBE074	Não foi possível validar o hash de confirmação.
CBE075	Transação é obrigatório.
CBE076	Status de transação é obrigatório.
CBE077	Não foi possível identificar o status.
CBE078	O evento é obrigatório.
CBE099	Máximo de 200 caracteres permitido para o logradouro.
CBE100	Inclusão ou alteração de split não permitida para Virtual BaaS.
CBE102	Erro tratado em cel_cash
CBE101	Falha durante geração de boleto
CBE103	Nome do pagador só deve conter caracteres válidos.
CBE104	Invoice number só deve conter caracteres válidos.
CBE106	Boleto não foi criado.
CBE107	Número de casas decimais não deve ser maior do que 2.
CBE999	Falha em geração de boleto, favor tente novamente.

Webhooks de Cobranças

Evento	Descrição
charge-create	Após uma cobrança ser registrada, você receberá esse evento com os detalhes da cobrança
charge-paid	Quando o pagamento de uma cobrança é confirmado pela instituição pagadora. Este webhook se refere ao momento em que a Celcoin é notificada pela Nuclea que ocorreu a baixa operacional de um boleto
charge-in	Quando uma cobrança é paga e o repasse dos valores foi creditado na conta individualizada
charge-canceled.	Quando uma cobrança é cancelada
charge-expired	Quando uma cobrança é gerada e não é paga
charge-occurrence	Quando o pagamento de uma cobrança é recusado por valores divergentes

Cadastre os eventos no Gerenciador de webhooks do BaaS .

charge-create

{
   "body":{
      "transactionId":"e7302f6b-7188-4379-8316-6c537d288596",
      "externalId":"EXT00001",
      "amount":10,
      "duedate":"2023-07-20 00:00:00",
      "status":"PENDING",
      "debtor":{
         "name":"Josea Joaquina veira",
         "document":"1234568909",
         "postalCode":"15000000",
         "publicArea":"Rua Cinco",
         "number":"123",
         "complement":"",
         "neighborhood":"Centro",
         "city":"São Paulo",
         "state":"SP"
      },
      "receiver":{
         "name":"Monue Krajcik",
         "document":"1234568909",
         "postalCode":"08827434",
         "publicArea":"Rua Nove",
         "city":"São Paulo",
         "state":"SP",
         "account":"30053913745629"
      },
      "instructions":{
         "fine":10.0,
         "interest":1.0,
         "discount":{
            "amount":3.1,
            "modality":"fixed",
            "limitDate":"2023-07-15T03:00:00Z"
         }
      },
      "boleto":{
         "transactionId":"31881",
         "status":"PENDING",
         "bankEmissor":"santander",
         "bankNumber":"4000176322",
         "bankAgency":"1004",
         "bankAccount":"0220060",
         "barCode":"03393941700000010009022006000040001763220101",
         "bankLine":"03399022070600004000317632201012394170000001000",
         "bankAssignor":"CELCOIN INSTITUIÇÃO DE PAGAMENTO - SA"
      },
      "pix":{
         "transactionId":"816145081",
         "transactionIdentification":"kk6g232xel65a0daee4dd13kk816145081",
         "status":"PENDING",
         "key":"[email protected]",
         "emv":"00020101021226980014br.gov.bcb.pix2576api-h.developer.btgpactual.com/pc/p/v2/cobv/bf53a874ef9d4a0cb2e1226b5c2d5ed05204000053039865802BR5915Monique Krajcik6015West Marianabor61080882743462070503***630441FF"
      }
   }
}

🚧
Importante

O recebimento do webhook de charge-create é enviado após o registro na Núclea que ocorre em média até 30 segundos ou em casos de exceção pode levar até 60 minutos.

📘
No charge-create retornam três IDs
body.transactionId → ID da cobrança
body.boleto.transactionId → ID do boleto.
body.pix.transactionId → ID da cobrança Pix.

📘
Após a emissão da cobrança, você pode consultar os boletos emitidos e com isso obter o status atualizado da cobrança. Abaixo segue a tabela com os status possíveis da cobrança:

Status Descrição
ERROR Indica que ocorreu um erro durante a geração da cobrança.
PENDING A cobrança foi gerada com sucesso e está aguardando o pagamento.
PROCESSING A cobrança está em fase de processamento, ou seja, está sendo gerada.
CONFIRMED Indica que a cobrança foi paga com sucesso. Esse status é atualizado quando o crédito na conta foi realizado
CANCELED Indica que a cobrança foi cancelada

Status	Descrição
ERROR	Indica que ocorreu um erro durante a geração da cobrança.
PENDING	A cobrança foi gerada com sucesso e está aguardando o pagamento.
PROCESSING	A cobrança está em fase de processamento, ou seja, está sendo gerada.
CONFIRMED	Indica que a cobrança foi paga com sucesso. Esse status é atualizado quando o crédito na conta foi realizado
CANCELED	Indica que a cobrança foi cancelada

Descrição dos Campos

Campo	Descrição	Tipo Campo
body.duedate	Data de Vencimento do Boleto	date-time
body.transactionId	Identificador da transação	string
body.externalId	Identificador do cliente.	string
body.status	Status do Boleto	string
body.amout	Valor do Boleto	number
debtor.name	Nome do Pagador	string
debtor.document	CNPJ ou CPF do pagador.	string
debtor.postalCode	CEP do pagador.	string
debtor.publicArea	Nome da rua do pagador.	string
debtor.number	Número da Residência	string
debtor.complement	Complemento	string
debtor.neighborhood	Bairro	string
debtor.city	Cidade do recebedor	string
debtor.state	Estado do recebedor	string
receiver.name	Nome do recebedor	string
receiver.document	CNPJ ou CPF dorecebedor	string
receiver.postalCode	CEP do recebedor	string
receiver.publicArea	Nome da rua do recebedor	string
receiver.city	Cidade do recebedor	string
receiver.state	Estado do recebedor	string
receiver.accout	Conta do recebedor	string
instructions.fine	Multa aplicada após o vencimento - formato decimal (Porcentagem)	number
instructions.interest	Juros aplicado após o vencimento - formato decimal (Porcentagem)	number
discount.modality	fixed ou percent fixed para dar um desconto em valor ex: R$ 2,50 percent para dar um desconto em porcentagem ex: 10.00%	string
discount.amount	O valor do desconto	number
discount.limitDate	Data máxima para aplicação do desconto, ex: vencimento da cobrança dia 25 e desconto até o dia 20	date-time
boleto.transactionId	Identificador do Boleto	string
boleto.status	Status do Boleto	string
boleto.bankEmissor	Banco Emissor	string
boleto.bankNumber	Número do Banco	string
boleto.bankAgency	Agência	string
boleto.bankAccount	Conta	string
boleto.barCode	Código de Barras	string
boleto.bankLine	Linha Digitável	string
boleto.bankAssignor	Banco Cedente	string
pix.transactionId	Identificador do Pix	string
pix.transactionIdentification	Indentificar da transação Pix no Bacen	string
pix.status	Status do Pix	string
pix.key	Chave do Pix	string
pix.emv	Sequencia para o Pix Copia e Cola	string

charge-paid

 {
    "entity": "charge-paid",
    "createTimestamp": "2025-10-24T20:40:36",
    "status": "PAID",
    "body": {
        "bankLine": "50990000010100000000800000017780712590000048712",
        "barCode": "50997125900000487120000001000000000000001778",
        "duedate": "2025-11-08T00:00:00",
        "transactionId": "bed334cb-5713-4d42-bf87-0cfc05349206",
        "externalId": "024a581e-e91c-4021-8713-d23ae5475c37",
        "status": "Baixado",
        "paymentReleaseDate": "2025-10-24T07:28:36",
        "liquidationDate": "2025-10-24T19:30:00",
        "paymentInterestAmout": 0.0,
        "paymentFineAmount": 0.0,
        "paymentDiscountAmount": 0.0,
        "paymentAmount": 487.12,
        "paymentType": "Boleto",
        "creditParty": {
            "taxId": "17476020278",
            "account": "30053913747534"
        }
    }
}

🚧
Não utilize esse webhook como comprovação de pagamento. É bem raro, porém, devoluções e recusas ainda podem ocorrer antes da baixa definitiva do boleto bancário e crédito na conta do beneficiário.

Descrição dos Campos

Campo	Descrição	Tipo Campo
entity	Evento do Webhook recebido	string
createTimestamp	Data de Envio do Webhook	date-time
status	Status da Cobrança	string
body.bankLine	Linha Digitável do Boleto	string
body.barCode	Código de Barras do Boleto	string
body.duedate	Data de Vencimento do Boleto	string
body.transactionId	Identificador da transação	string
body.externalId	Identificador do cliente.	string
body.status	Status do Boleto	string
body.PaymentReleaseDate	Data e Dora da baixa na núclea	date-time
body.liquidationDate	Data e Hora prevista para o lançamento em carteira	date-time
body.paymentInterestAmout	Valor do Juros do Boleto	number
body.paymentFineAmount	Valor da Multa do Boleto	number
body.paymentDiscountAmount	Valor do Desconto do Boleto	number
body.paymentAmount	Valor Pago do Boleto	number
body.paymentType	Como este webhook é referente a baixa operacional de um boleto bancário, sempre que receber este campo, será retornado com o preenchimento “boleto”	string
creditParty.taxId	Documento do beneficiário principal	string
creditParty.account	Conta do beneficiário principal	string

charge-in


{
  "body": {
    "dataPagamento": "2025-10-07 19:30:01",
    “dataBaixaPagamento”: "2025-10-07 13:00:00",
    "dataVencimento": "2023-06-30 00:00:00",
    "externalId": "TesteSandbox_43",
    "status": "Pago",
    "tipoPagamento": "Pix",
    "transactionId": "e77adbbf-66ea-4749-987f-a5eb165fda94",
    "valorOriginal": 5,
    "valorPago": 5,
    "currentBalance": 290.04,
    "oldBalance": 275.04,
    "creditParty": {
      "taxId": "46085258000139",
      "account": "45401"
    }
  },
  "createTimestamp": "2023-06-20T14:57:19.1007119",
  "entity": "charge-in",
  "error": null,
  "status": "CONFIRMED"
}

📘
No charge-in retorna um transactionId no body
que será o mesmo transactionId retornado no charge-create → se refere ao ID geral da cobrança.
O tipo de pagamento é diferenciado pelo campo tipoPagamento ("Pix" ou "Boleto").

Descrição dos Campos

Campo	Descrição	Tipo Campo
entity	Evento do Webhook recebido	string
createTimestamp	Data de Envio do Webhook	date-time
status	Status da Cobrança	string
body.dataPagamento	Data em que ocorreu o repasse para conta individualizada	date-time
body.dataBaixaPagamento	Data em que ocorreu a confirmação do pagamento e baixa operacional do Boleto na Nuclea	date-time
body.dataVencimento	Data de Vencimento da Cobrança	date-time
body.transactionId	Identificador da transação	string
body.externalId	Identificador do cliente.	string
body.status	Status do Boleto	string
body.tipoPagamento	Meio em que a Cobrança foi paga. Boleto ou Pix	string
body.valorOriginal	Valor Original da Cobrança	number
body.valorPago	Valor que foi pago da Cobrança	number
body.currentBalance	Saldo atual da Conta	number
body.oldBalance	Saldo anterior da Conta	number
creditParty.taxId	Documento do beneficiário principal	string
creditParty.account	Conta do beneficiário principal	string

charge-canceled

{
 "entity": "charge-canceled",
 "createTimestamp": "2024-01-18T12:43:04.7091436",
 "status": "CANCELED",
 "body": {
     "amount": 140,
     "boleto": {
         "bankAccount": "12345",
         "bankAgency": "123",
         "bankAssignor": "CELCOIN INSTITUIÇÃO DE PAGAMENTO - SA",
         "bankEmissor": "BancoTeste",
         "bankLine": "",
         "bankNumber": "1234",
         "barCode": "",
         "status": "CANCELED",
         "transactionId": "1234"
     },
     "debtor": {
         "city": "Blumenau",
         "document": "123456789",
         "name": "Fulano de Tal",
         "neighborhood": "Garcia",
         "number": "123",
         "postalCode": "123456789",
         "publicArea": "Rua Por ai",
         "state": "SP"
     },
     "duedate": "2024-01-11 00:00:00",
     "externalId": "12345678External",
     "pix": {
         "emv": "",
         "key": "",
         "status": "CANCELED",
         "transactionId": "12345",
         "transactionIdentification": "abcdefghijklmnopqrstuvwxyz"
     },
     "reasonCancellation": "Cancelado.",
     "receiver": {
         "account": "123456",
         "city": "Blumenau",
         "document": "123456789",
         "name": "Teste",
         "postalCode": "123456781",
         "publicArea": "Rua",
         "state": "SP"
     },
     "status": "CANCELED",
     "transactionId": "2asdg604a-0124-4poic-95f7-6b12345a3995"
 }
}

📘
O payload é idêntico ao charge-create, mudando apenas os campos referentes a status, onde eles assumirão o valor de cancelado. E foi adicionado o campo reasonCancellation: "Cancelado", esse campo sempre assume o valor de "Cancelado"

📘
O Evento charge-canceled é enviado somente quando solicitado pelo cliente na API "Cancelar Boleto Emitido"

charge-expired

{
	"entity": "charge-expired",
	"createTimestamp": "2025-10-07T14:36:57.676242",
	"status": "EXPIRED",
	"body": {
		"transactionId": "9b7cdabe-ad7d-464f-9fcf-a80d240bc112",
		"externalId": "9f3fd57b-3df8-45fa-81f9-dc5d37270784",
		"barCode": "50997125100000009560000001000000000000001725",
		"bankLine": "50990000010100000000800000017251712510000000956",
		"dueDate": "2025-10-31 00:00:00",
		"expirationAfterPayment": 59,
		"amount": 9.56,
		"creditParty": {
			"taxId": "12349123000189",
			"account": "123817361"
		}
	}
}

Descrição dos Campos

Campo	Descrição	Tipo Campo
entity	Evento do Webhook recebido	string
createTimestamp	Data de Envio do Webhook	date-time
status	Status da Cobrança	string
body.bankLine	Linha Digitável do Boleto	string
body.barCode	Código de Barras do Boleto	string
body.duedate	Data de Vencimento do Boleto	string
body.transactionId	Identificador da transação	string
body.externalId	Identificador do cliente.	string
body.expirationAfterPayment	Período adicional permitido para pagamento após o vencimento da cobrança.	number
body.amout	Valor do Boleto	number
creditParty.taxId	Documento do beneficiário principal	string
creditParty.account	Conta do beneficiário principal	string

📘
O Evento charge-expired é enviado quando o boleto é baixado por decurso de prazo ou seja, quando não foi realizado o pagamento dentro do prazo definido.

charge-occurrence

{
	"entity": "charge-occurrence",
	"createTimestamp": "2025-11-05T18:23:10.017",
	"status": "PENDING",
	"body": {
		"transactionId": "42c054d0-0d51-486a-9fe3-a49beba0a570",
		"externalId": "92614974-1b04-47d8-b5e4-c3031ecbb946",
		"reason": "VALOR_DIVERGENTE",
		"barCode": "50994126100000021760000001000000000000001860",
		"bankLine": "50990000010100000000800000018606412610000002176",
		"dueDate": "2025-11-10T00:00:00",
		"expirationAfterPayment": 22,
		"amount": 21.76,
		"creditParty": {
			"taxId": "86345738263",
			"account": "30053913783406"
		}
	}
}

Descrição dos Campos

Campo	Descrição	Tipo Campo
entity	Evento do Webhook recebido	string
createTimestamp	Data de Envio do Webhook	date-time
status	Status da Cobrança	string
body.bankLine	Linha Digitável do Boleto	string
body.barCode	Código de Barras do Boleto	string
body.duedate	Data de Vencimento do Boleto	string
body.transactionId	Identificador da transação	string
body.externalId	Identificador do cliente.	string
body.reason	Motivo pela recusa do pagamento. No momento o única motivo será: "Valor Divergente"	string
body.expirationAfterPayment	Período adicional permitido para pagamento após o vencimento da cobrança.	number
body.amout	Valor do Boleto	number
creditParty.taxId	Documento do beneficiário principal	string
creditParty.account	Conta do beneficiário principal	string

🚧
Essa notificação pode ser enviada em alguns cenários, como: Pagamento enviado pela instituição pagadora sem considerar juros e multa ou até mesmo a confirmação do pagamento ocorreu após data de vencimento.

Updated about 18 hours ago