Bill Registered

When the investor registers the bank slip in the Direct Debit Authorization (DDA) system, this event is triggered.

EventType: BillRegisteredEvent

Path: /bill

Webhook payload object

KeyTypeDescription

sponsorId


integer

Anchor identifier.

sponsorGovernmentId


string

EIN of the anchor.

sponsorName


string

Name of the anchor.

sellerId


integer

Supplier identifier.

sellerGovernmentId


string

EIN of the supplier.

sellerName


string

Name of the supplier.

buyerId


integer

Investor identifier.

purchaseId


string

Purchase identifier.

externalId


string

External identifier of the invoice.

invoiceNumber


string

Invoice number.

installment


integer

Installment related to the invoice. Used only when the invoice is paid in installments.


totalInstallment


integer

Total installments related to the invoice. Used only when the invoice is paid in installments.


paymentDate


long

Due date of the invoice.

paymentValue


number

Invoice amount.

line


string

Scannable line of the bill (payment slip).

url


string

URL for accessing the bill.

ourNumber


string

Our number (Unique identifier of the bill).

eventType


string

Event type.

_links


object

Resources available through HATEOAS.
More informartion here.

Available resources are:
buyer - List investor information.
purchase - List purchase information
bill - List bill information.

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":"BillRegisteredEvent",
   "_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"
      }
   }
}

Did this page help you?