Manual do Dev
InstitucionalBlogService DeskStatus Page

Boletos

Confira os eventos relativos a boletos.

beta

Suggest Edits

Os eventos de boletos disparam mensagens que comunicam ao destinatário o recebimento de cash-in (valores provenientes de pagamentos de boletos).

Como esses eventos chegam ao recebedor via webhook, é preciso realizar previamente a sua configuração.

Contexto e nome do evento

Nos eventos de boleto, o campo context sempre informará “Boleto”, enquanto o campo name poderá variar de acordo com a transação, conforme a tabela a seguir:

Nome do evento (name)Descrição
BOLETO_CASH_IN_WAS_RECEIVEDO valor foi recebido no core bancário Bankly.
BOLETO_CASH_IN_WAS_CLEAREDO valor foi liberado na conta destino.

Exemplos de eventos

{
   "entityId": "9e88593f-eb9b-4530-b6b2-14c5272587dc",
   "companyKey": "companyKey",
   "idempotencyKey": "f4c4895a-3657-4516-bbd9-fe380f0a24aa",
   "context": "Boleto",
   "name": "BOLETO_CASH_IN_WAS_RECEIVED",
   "timestamp": "2022-02-18T11:26:07.7585316Z",
   "correlationId": "d71dcf71-c0c3-5d82-6f03-a7b5c7016347",
   "data": {
      "authenticationCode": "9e88593f-eb9b-4530-b6b2-14c5272587dc",
      "amount": {
         "value": 10.02,
         "currency": "BRL"
      },
      "recipient": {
         "document": {
            "value": "12345678900",
            "type": "CPF"
         },
         "type": "Customer",
         "name": "customerName",
         "account": {
            "branch": "0000",
            "number": "12345678",
            "bank": {
               "ispb": "13140088",
               "code": "332",
               "name": "Acesso Soluções de Pagamento S.A."
            }
         }
      },
      "channel": {
         "name": "Boleto",
         "ourNumber": "32989927106"
      },
      "createdAt": "2022-02-18T11:26:07.6512572Z"
   }
}

{
   "entityId": "f116987a-cf69-4d21-b5d0-b5bf898a5624",
   "companyKey": "companyKey",
   "idempotencyKey": "2a061050-418c-4dd7-bb84-24599a17335d",
   "context": "Boleto",
   "name": "BOLETO_CASH_IN_WAS_CLEARED",
   "timestamp": "2022-02-18T11:26:23.4635218Z",
   "correlationId": "39b2d0f6-692f-128f-2dbc-816ec8295430",
   "data": {
      "authenticationCode": "f116987a-cf69-4d21-b5d0-b5bf898a5624",
      "amount": {
         "value": 5,
         "currency": "BRL"
      },
      "recipient": {
         "document": {
            "value": "12345678900",
            "type": "CPF"
         },
         "type": "Customer",
         "name": "custumerName",
         "account": {
            "branch": "0000",
            "number": "12345678",
            "bank": {
               "ispb": "13140088",
               "code": "332",
               "name": "Acesso Soluções de Pagamento S.A."
            }
         }
      },
      "channel": {
         "name": "Boleto",
         "ourNumber": "64258310141"
      },
      "createdAt": "2022-02-18T11:26:01.6215343Z"
   }
}

🚧

Importante

Para conhecer a estrutura básica dos eventos com os campos que chegarão à sua API, consulte nossa documentação específica de Eventos.

Objeto data nos eventos de boleto

O objeto data traz detalhes específicos do contexto em que o evento ocorre. No caso de eventos de boleto, esse objeto trará os seguintes campos:

  • entityId: informação duplicada do authenticationCode, que serve como chave de identificação do evento;
  • authenticationCode: código identificador que também é recebido no retorno da emissão de um boleto;
  • amount: objeto contendo o valor da transação e a moeda utilizada;
  • recipient: objeto contendo os dados do recebedor, como nome, documento, tipo e dados de sua conta;
  • channel: objeto contendo os dados do canal de pagamento, além da identificação da transação e dos dados do pagador:
    • name: nome do canal de pagamento;
    • ourNumber: número que relaciona o boleto ao seu emissor;
  • createdAt: retorna a data de criação da transação.

Updated 11 months ago