Boleto Gerado

Quando a compra/antecipação de um título é concluída e o comprador irá receber através de boleto, nós enviamos um evento de boleto gerado em até 2 dias após a aprovação da compra.

Atenção: Esse evento não garante o registro do boleto no DDA, para isso veja o evento de Boleto Registrado.

EventType: BillGeneratedEvent

Path: /bill

Webhook payload object

ChaveTipoDescrição

sponsorId


integer

Identificador do sacado.

sponsorGovernmentId


string

CNPJ ou CPF do sacado.

sponsorName


string

Razão Social ou Nome do sacado.

sellerId


integer

Identificador do cedente.

sellerGovernmentId


string

CNPJ ou CPF do cedente.

sellerName


string

Razão Social ou Nome do cedente.

buyerId


integer

Identificador do investidor.

purchaseId


string

Identificador da compra.

externalId


string

Identificador externo do título.

invoiceNumber


string

Número do título.

installment


integer

Parcela referente ao título. Utilizado apenas quando o título é pago de forma parcelada.


totalInstallment


integer

Total de parcelas referente ao título. Utilizado apenas quando o título é pago de forma parcela.


paymentDate


long

Data de vencimento do título.

paymentValue


number

Valor do título.

line


string

Linha digitável do boleto.

url


string

URL de acesso ao boleto.

ourNumber


string

Nosso número (Identificador único do boleto).

eventType


string

Identificador do evento.

_links


object

Recursos disponíveis através de HATEOAS.
Para saber mais clique aqui.

Recursos disponíveis são:
buyer - Listar dados do investidor.
purchase - Listar dados da compra.
bill - Listar dados do boleto.

Webhook payload example

{
   "sponsorId":4026534,
   "sponsorGovernmentId":"01635511000135",
   "sponsorName":"SACADO",
   "sellerId":1614639276,
   "sellerGovernmentId":"12192393000101",
   "sellerName":"CEDENTE",
   "buyerId":540897447,
   "purchaseId":"0CJNSctiuK",
   "externalId":"U3moLb34X9",
   "invoiceNumber":"9huh9EqhIb",
   "installment":1,
   "totalInstallment":1,
   "paymentDate":1574906400000,
   "paymentValue":199.89,	
   "line":"34191.04009 00000.480004 10000.250000 2 80870000019989",
   "url":"https://bole.to/3/bdjrvb",
   "ourNumber":"104/00000003-0",
   "eventType":"BillGeneratedEvent",
   "_links":{
      "buyer":{
         "href":"https://zuul.monkey.exchange/v1/buyers/540897447",
         "type":"GET"
      },
      "purchase":{
         "href":"https://zuul.monkey.exchange/v2/buyers/540897447/purchases/0CJNSctiuK",
         "type":"GET"
      },
      "bill":{
         "href":"https://bole.to/3/bdjrvb",
         "type":"GET"
      }
   }
}