Purchase Completed

When a purchase is completed, we send this event containing information about the person who made the transaction, the amounts to be paid, and the payment dates.

You can use the _links to navigate related resources for this event.

Path: /purchase

Webhook payload object

Key	Type	Description
`id`	`string`	Purchase identifier.
`status`	`string`	Purchase status. Possible values: `WAITING_CUSTODY` - Awaiting custody
`tax`	`number`	Rate assigned to the purchase.
`days`	`integer`	Advance term in days.
`paymentDate`	`long`	Purchase payment date.
`grossPaymentValue`	`number`	Gross payment value.
`netPaymentValue`	`number`	Net payment value.
`buyerId`	`integer`	Investor identifier.
`buyerName`	`string`	Name of the investor.
`buyerGovernmentId`	`string`	Investor's EIN.
`sponsorId`	`integer`	Anchor identifier.
`sponsorName`	`string`	Name of the anchor.
`sponsorPersonType`	`string`	Type of entity of the anchor. Possible values: `LEGAL_PERSON` - Legal entity `NATURAL_PERSON` - Individual
`sponsorGovernmentId`	`string`	Anchor’s EIN.
`sponsorExternalCode`	`string`	External code of the anchor.
`sponsorAddress`	`string`	EAnchor’s address line 1.
`sponsorAddressNumber`	`string`	Anchor’s address number.
`sponsorAddressComplement`	`string`	Anchor’s address line 2.
`sponsorNeighborhood`	`string`	Anchor’s neighborhood.
`sponsorCity`	`string`	Anchor’s city.
`sponsorState`	`string`	Anchor’s state.
`sponsorCountry`	`string`	Anchor’s country.
`sponsorZipCode`	`string`	Anchor’s zip code.
`sponsorBank`	`string`	Anchor’s bank routing number.
`sponsorAgency`	`string`	Bank agency code of the anchor (without digit).
`sponsorAccount`	`string`	Anchor’s bank account.
`sponsorAccountDigit`	`string`	Digit of the anchor’s bank account.
`sellerId`	`integer`	Supplier’s identifier.
`sellerName`	`string`	Name of the supplier.
`sellerPersonType`	`string`	Type of entity of the supplier. Possible values: `LEGAL_PERSON` - Legal entity `NATURAL_PERSON` - Individual
`sellerGovernmentId`	`string`	Supplier’s EIN.
`sellerAddress`	`string`	Supplier’s address line 1.
`sellerAddressNumber`	`string`	Supplier’s address number.
`sellerAddressComplement`	`string`	Supplier’s address line 2.
`sellerNeighborhood`	`string`	Supplier’s neighborhood.
`sellerCity`	`string`	Supplier’s city.
`sellerState`	`string`	Supplier’s state.
`sellerCountry`	`string`	Supplier’s country.
`sellerZipCode`	`string`	Supplier’s zip code.
`sellerBank`	`string`	Supplier’s bank routing number.
`sellerAgency`	`string`	Bank agency code of the supplier. (without digit).
`sellerAgencyDigit`	`string`	Digit of the supplier’s bank agency.
`sellerAccount`	`string`	Supplier’s bank account.
`sellerAccountDigit`	`string`	Digit of the supplier’s bank account.
`coobrigation`	`boolean`	Co-obligation.
`createdAt`	`long`	Resource creation date.
`items`	`array`	Array containing the items of this purchase.
`items[][id]`	`string`	Item identifier.
`items[][receivableUuid]`	`string`	Invoice identifier on the platform.
`items[][externalId]`	`string`	External invoice identifier. `(Up to 255 characters)`
`items[][assetType]`	`string`	Asset type. Possible values: `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
`items[][performed]`	`boolean`	Performed.
`items[][operationType]`	`string`	Transaction type. Possible values: `PRE` - Fixed `POS` - Floating `PRE_POS` - Fixed/Floating.
`items[][invoiceType]`	`string`	Invoice type. Possible values: `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
`items[][invoiceDate]`	`long`	Invoice date.
`items[][invoiceNumber]`	`string`	Invoice number. `(Up to 255 characters)`
`items[][invoiceKey]`	`string`	Invoice key. `(Up to 255 characters)`
`items[][installment]`	`integer`	Installment related to the invoice. Used only when the invoice is paid in installments. When paid in full, the default value is 1.
`items[][totalInstallment]`	`integer`	Total installments related to the invoice. Used only when the invoice is paid in installments. When paid in full, the default value is 1.
`items[][paymentValue]`	`number`	Invoice amount.
`items[][paymentDate]`	`long`	Invoice due date.
`items[][status]`	`string`	Purchase status. Possible values: `WAITING_CUSTODY` - custody pending.
`items[][tax]`	`number`	Rate applied to purchase item.
`items[][sellerPaymentValue]`	`number`	Amount paid to supplier.
`items[][sponsorTax]`	`number`	Rate of rebate to anchor attributed to the purchase item.
`items[][sponsorPaymentValue]`	`number`	Amount payable to anchor.
`items[][penaltyBill]`	`number`	Penalty fee.
`items[][interestLatePayment]`	`number`	Late payment interest.
`_links`	`object`	Resources available through HATEOAS. More informartion here. Available resources are: `seller` - supplier data list `sponsor` - anchor data list `purchase` - list this purchase `purchases` -list all purchases of the investor `signature` - list the sign off of the purchase.

Webhook payload example

{
   "id":"VLbxGglIct",
   "status":"WAITING_CUSTODY",
   "tax":2.02,
   "days":288,
   "paymentDate":1550023200000,
   "grossPaymentValue":232199.89,
   "netPaymentValue":190804.21,
   "buyerId":78676,
   "buyerName":"INVESTIDOR",
   "buyerGovernmentId":"02638882000895",
   "sponsorId":4026534,
   "sponsorName":"SACADO",
   "sponsorPersonType":"LEGAL_PERSON",
   "sponsorGovernmentId":"02135252000189",
   "sponsorExternalCode":"100",
   "sponsorAddress":"ROD. SP 080 KM 75,1",
   "sponsorAddressNumber":"S/N",
   "sponsorAddressComplement":"",
   "sponsorNeighborhood":"CENTRO",
   "sponsorCity":"São Paulo",
   "sponsorState":"SP",
   "sponsorCountry":"Brasil",
   "sponsorZipCode":"26380000",
   "sponsorBank": "033",
   "sponsorAgency":"1234",
   "sponsorAccount":"98765",
   "sponsorAccountDigit":"9",
   "sellerId":1614639272,
   "sellerName":"CEDENTE",
   "sellerPersonType":"LEGAL_PERSON",
   "sellerGovernmentId":"02890352000103",
   "sellerAddress":"Rua Monte Aprazável",
   "sellerAddressNumber":"109",
   "sellerAddressComplement":"",
   "sellerNeighborhood":"Centro",
   "sellerCity":"São Paulo",
   "sellerState":"SP",
   "sellerCountry":"Brasil",
   "sellerZipCode":"04512030",
   "sellerBank":"341",
   "sellerAgency":"9122",
   "sellerAgencyDigit":"0",
   "sellerAccount":"02603",
   "sellerAccountDigit":"1",
   "coobrigation":false,
   "createdAt":1553609535336,
   "items":[
      {
         "id":"SFgA83Edw4",
         "receivableUuid":"S8jTcn7GeW",
         "externalId":"CFIiMIxfFZ",
         "assetType":"DUPLICATA_MERCANTIL",
         "performed":true,
         "operationType":"PRE",
         "invoiceType":"NOTA_FISCAL_ELETRONICA",
         "invoiceDate":1574906400000,
         "invoiceNumber":"rn0iSyHbCf",
         "installment":1,
         "totalInstallment":1,
         "paymentValue":232199.89,
         "paymentDate":1574906400000,
         "status":"WAITING_CUSTODY",
         "tax":1.7999999523162842,
         "sellerPaymentValue":190804.21,
         "sponsorTax":0.2199999988079071,
         "sponsorPaymentValue":4847.36,
         "penaltyBill":0.0,
         "interestLatePayment":0.0
      }
   ],
   "_links":{
      "seller":{
         "href":"https://zuul.monkey.exchange/v2/buyers/78676/sellers/1614639272",
         "type":"GET"
      },
      "sponsor":{
         "href":"https://zuul.monkey.exchange/v2/buyers/78676/sponsors/4026534",
         "type":"GET"
      },
      "purchase":{
         "href":"https://zuul.monkey.exchange/v2/buyers/78676/purchases/VLbxGglIct",
         "type":"GET"
      },
      "purchases":{
         "href":"https://zuul.monkey.exchange/v2/buyers/78676/purchases",
         "type":"GET"
      },
      "signature":{
         "href":"https://zuul.monkey.exchange/v2/buyers/78676/signatures/VLbxGglIct",
         "type":"GET"
      }
   }
}