Transaction Settlement

When the purchase/advance of an invoice is settled by the anchor, we trigger an event to indicate the completion of this transaction.

In this event, we send information about the seller who initiated the advance (Legal Name and EIN), the anchor responsible for the settlement (Legal Name and EIN), as well as investor details (Legal Name, EIN, address, and bank details).

This event also includes IDs (PayableUuid, ExternalId, and InvoiceNumber) used to identify the title in your system.

When sending invoices, either via API or file, you define the layout and choose one of these three identifiers. You should use the same identifier when receiving the webhook request.

Path: /liquidations

Webhook payload object

Key	Type	Description
`sponsorId`	`string`	Anchor identifier.
`payableUuid`	`string`	Identifier of the invoice on the platform.
`status`	`string`	Purchase status. Possible values: `PAID` - Invoice Paid
`detail`	`number`	Item details.
`externalId`	`string`	External identifier of the invoice.
`assetType`	`string`	Type of asset. Possible values include: `DUPLICATA_MERCANTIL` - Commercial invoice `CHEQUE` - Check `CONTRATOS` - Contracts `CONTRATO_FISICO` - Physical contract `MULTIPLOS` - Multiple `NOTA_SERVICO` - Service invoice `CARTAO_CREDITO` - Credit card `DIREITOS_CREDITORIOS` - Credit rights
`invoiceType`	`string`	Type of invoice. Possible values include: `NOTA_FISCAL_ELETRONICA` - Digital invoice `NOTA_FISCAL_CONSUMIDOR_ELETRONICA` - Digial retail invoice `NOTA_FISCAL_SERVICOS_ELETRONICA` - Digital service invoice `CONHECIMENTO_TRANSPORTE_ELETRONICO` - Digital transportation invoice `MEIOS_PAGAMENTO_ELETRONICO` - Other digital payment method `CONTRATOS` - Contracts
`invoiceNumber`	`integer`	Invoice number.
`installment`	`integer`	Installment related to the invoice. Default is 1 when paid in full.
`totalInstallment`	`integer`	Total installments related to the invoice. Default is 1 when paid in full.
`paymentValue`	`integer`	Invoice amount.
`paymentDate`	`integer`	Due date of the invoice.
`sponsorName`	`integer`	Name of the anchor.
`sponsorPersonType`	`integer`	Type of entity of the anchor. Possible values: `LEGAL_PERSON` - Legal entity `NATURAL_PERSON` - Individual
`sponsorGovernmentId`	`integer`	EIN of the anchor.
`sellerId`	`integer`	Supplier identifier.
`sellerName`	`integer`	Name of the supplier.
`sellerPersonType`	`integer`	Type of entity of the supplier. Possible values: `LEGAL_PERSON` -Legal entity `NATURAL_PERSON` - Individual
`sellerGovernmentId`	`integer`	EIN of the supplier.
`buyerId`	`integer`	Investor identifier.
`buyerName`	`integer`	Name of the investor.
`buyerGovernmentId`	`integer`	EIN of the investor.
`buyerAddress`	`string`	Address line 1 of the investor.
`buyerAddressNumber`	`string`	Address number of the investor.
`buyerAddressComplement`	`string`	Address line 2 of the investor.
`buyerAddressNeighborhood`	`string`	Neighborhood of the investor.
`buyerCity`	`string`	City of the investor.
`buyerState`	`string`	State of the investor.
`buyerCountry`	`string`	Country of the investor.
`buyerZipCode`	`string`	ZIP code of the investor.
`buyerReceivementBank`	`string`	Bank routing number for receiving payments by the investor.
`buyerReceivementAgency`	`string`	Bank agency code for receiving payments by the investor.
`buyerReceivementAccount`	`string`	Checking account for receiving payments by the investor (without digit).
`buyerReceivementAccountDigit`	`string`	Digit of the checking account for receiving payments by the investor.
`liquidationDate`	`string`	Settlement date.
`liquidationValue`	`string`	Amount paid.
`settlementType`	`integer`	Type of payment. Possible values: `BILL` - Bill. `BANK_TRANSFER` - Bank transfer
`_links`	`object`	Resources available through HATEOAS. More Informartion here. Available resources are: `buyer` - List investor information. `purchase` - List this purchase. `purchases` - List all purchases of the investor.

Webhook payload example

{
   "sponsorId":111111,
   "payableUuid":"hBslrLUoL1",
   "status":"PAID",
   "detail":"",
   "externalId":"J5ld4VMNF3",
   "assetType":"DUPLICATA_MERCANTIL",
   "invoiceType":"NOTA_FISCAL_ELETRONICA",
   "invoiceNumber":"wIIQTB1fwm",
   "installment":1,
   "totalInstallment":1,
   "paymentValue":92199.89,
   "paymentDate":1553137200000,
   "sponsorName":"SACADO",
   "sponsorPersonType":"LEGAL_PERSON",
   "sponsorGovernmentId":"02635522000195",
   "sellerId":222222,
   "sellerName":"CEDENTE",
   "sellerPersonType":"LEGAL_PERSON",
   "sellerGovernmentId":"05890359000103",
   "buyerId":123,
   "buyerName":"INVESTIDOR",
   "buyerGovernmentId":"02635522000195",
   "buyerAddress":"ROD. GO 080 KM 75,1",
   "buyerAddressNumber":"S/N",
   "buyerAddressComplement":"",
   "buyerNeighborhood":"centro",
   "buyerCity":"GOIANESIA",
   "buyerState":"GO",
   "buyerCountry":"Brasil",
   "buyerZipCode":"76380000",
   "buyerReceivementBank":"756",
   "buyerReceivementAgency":"030555",
   "buyerReceivementAccount":"000000021416",
   "buyerReceivementAccountDigit":"7",
   "liquidationDate":1553137200000,
   "liquidationValue":92199.89,
   "settlementType":"BILL",
   "_links":{
      "buyer":{
         "href":"https://zuul.monkey.exchange/v1/buyers/123",
         "type":"GET"
      },
      "purchase":{
         "href":"https://zuul.monkey.exchange/v1/buyers/123/purchases",
         "type":"GET"
      },
      "purchases":{
         "href":"https://zuul.monkey.exchange/v1/buyers/123/purchases/QGWBHm5LtF",
         "type":"GET"
      }
   }
}