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.
`items[][discount]`	`number`	Discount value.
`items[][subsidy]`	`number`	Amount paid by the Sponsor.
`items[][fileBase64]`	`string`	XML or PDF from invoice in Base64.

Webhook payload example

{
  "_links": {
    "seller": {
      "href": "https://dev-zuul.monkeyecx.com/v2/buyers/540897447/sellers/1614639276",
      "type": "GET"
    },
    "sponsor": {
      "href": "https://dev-zuul.monkeyecx.com/v2/buyers/540897447/sponsors/4026534",
      "type": "GET"
    },
    "purchases": {
      "href": "https://dev-zuul.monkeyecx.com/v2/buyers/540897447/purchases",
      "type": "GET"
    },
    "signature": {
      "href": "https://dev-zuul.monkeyecx.com/v2/buyers/540897447/signatures/X1Gl6y6qhc",
      "type": "GET"
    },
    "purchase": {
      "href": "https://dev-zuul.monkeyecx.com/v2/buyers/540897447/purchases/X1Gl6y6qhc",
      "type": "GET"
    }
  },
  "id": "X1Gl6y6qhc",
  "status": "WAITING_CUSTODY",
  "tax": 1.8,
  "days": 6,
  "paymentDate": 1600916400000,
  "grossPaymentValue": 199.89,
  "netPaymentValue": 199.18,
  "feeAmount": 8500,
  "discount": 8500,
  "subsidy": 8500,
  "netPaymentValueWithoutFee": 189.18,
  "totalEffectiveCost": 2.71,
  "buyerId": 540897447,
  "buyerName": "JALLES MACHADO S.A.",
  "buyerGovernmentId": "02635522000195",
  "sponsorId": 4026534,
  "sponsorName": "JALLES MACHADO S.A.",
  "sponsorPersonType": "LEGAL_PERSON",
  "sponsorGovernmentId": "02635522000195",
  "sponsorExternalCode": null,
  "sponsorAddress": "ROD. GO 080 KM 75,1",
  "sponsorAddressNumber": "S/N",
  "sponsorAddressComplement": "",
  "sponsorNeighborhood": "CENTRO",
  "sponsorCity": "GOIANESIA",
  "sponsorState": "SC",
  "sponsorCountry": "Brasil",
  "sponsorZipCode": "76380000",
  "sponsorBank": "035",
  "sponsorAgency": "0003",
  "sponsorAccount": "48526",
  "sponsorAccountDigit": "3",
  "sponsorAccountKey": "6758567567",
  "sellerId": 1614639276,
  "sellerName": "AGRIMIX INDUSTRIA E COMERCIO DE PECAS LTDA",
  "sellerPersonType": "LEGAL_PERSON",
  "sellerGovernmentId": "12292693000112",
  "sellerAddress": "Rua Adelina Cardim Bigal",
  "sellerAddressNumber": "235",
  "sellerAddressComplement": "",
  "sellerNeighborhood": "Jardim do Trevo",
  "sellerCity": "Ribeirão Preto",
  "sellerState": "SP",
  "sellerCountry": "Brasil",
  "sellerZipCode": "14092370",
  "sellerBank": "341",
  "sellerAgency": "2222",
  "sellerAgencyDigit": "0",
  "sellerAccount": "122233",
  "sellerAccountDigit": "2",
  "sellerAccountKey": "234235232",
  "coobrigation": false,
  "createdAt": 1600870010095,
  "eventType": "PurchaseIntegratedEvent",
  "items": [
    {
      "id": "Se4VTCTuac",
      "receivableUuid": "0DdiYruAHH",
      "externalId": "MU4IE8cR1i",
      "assetType": "DUPLICATA_MERCANTIL",
      "performed": true,
      "operationType": "PRE",
      "invoiceType": "NOTA_FISCAL_ELETRONICA",
      "invoiceDate": null,
      "invoiceNumber": "2wXXDlFasw",
      "invoiceKey": "",
      "installment": 1,
      "totalInstallment": 1,
      "paymentValue": 199.89,
      "paymentDate": 1601434800000,
      "status": "WAITING_CUSTODY",
      "tax": 1.8,
      "sellerPaymentValue": 199.18,
      "sellerPaymentValueWithoutFee": 189.18,
      "sponsorTax": 0.0,
      "sponsorPaymentValue": 0.00,
      "penaltyBill": 0.0,
      "interestLatePayment": 0.0,
      "feeRate": 2.71,
      "feeAmount": 10.00,
      "discount": 0.71,
      "subsidy": 0
    }
  ]
}