Compra Realizada

Quando uma compra é realizada enviamos este evento onde temos as informações a respeito de quem realizou a operação, valores a serem pagos e as datas para os pagamentos.

Você pode utilizar os _links para navegar nos recursos relacionados a este evento.

Path: /purchase

Webhook payload object

Chave	Tipo	Descrição
`id`	`string`	Identificador da compra.
`status`	`string`	Situação da compra. Valores possíveis são: `WAITING_CUSTODY` - Aguardando custódia
`tax`	`number`	Taxa atribuída à compra.
`days`	`integer`	Prazo de adiantamento em dias.
`paymentDate`	`long`	Data de pagamento da compra.
`grossPaymentValue`	`number`	Valor bruto da compra.
`netPaymentValue`	`number`	Valor líquido da compra descontado IOF.
`netPaymentValueWithoutFee`	`number`	Valor líquido da compra sem desconto de IOF.
`feeAmount`	`number`	Valor Total IOF.
`totalEffectiveCost`	`number`	Custo Efetivo Total.
`buyerId`	`integer`	Identificador do investidor.
`buyerName`	`string`	Razão Social ou Nome do investidor.
`buyerGovernmentId`	`string`	CNPJ ou CPF do investidor.
`sponsorId`	`integer`	Identificador do sacado.
`sponsorName`	`string`	Razão Social ou Nome do sacado.
`sponsorPersonType`	`string`	Tipo de entidade do sacado. Valores possíveis são: `LEGAL_PERSON` - Pessoa jurídica `NATURAL_PERSON` - Pessoa física
`sponsorGovernmentId`	`string`	CNPJ ou CPF do sacado.
`sponsorExternalCode`	`string`	Código externo do sacado.
`sponsorAddress`	`string`	Endereço do sacado.
`sponsorAddressNumber`	`string`	Número do endereço do sacado.
`sponsorAddressComplement`	`string`	Complemento do endereço do sacado.
`sponsorNeighborhood`	`string`	Bairro do sacado.
`sponsorCity`	`string`	Cidade do sacado.
`sponsorState`	`string`	Estado do sacado.
`sponsorCountry`	`string`	País do sacado.
`sponsorZipCode`	`string`	CEP do sacado.
`sponsorBank`	`string`	Código do banco do sacado.
`sponsorAgency`	`string`	Código da agência bancária do sacado (Sem o dígito).
`sponsorAccount`	`string`	Conta corrente do sacado (Sem o dígito).
`sponsorAccountDigit`	`string`	Dígito da conta corrente do sacado.
`sellerId`	`integer`	Identificador do cedente.
`sellerName`	`string`	Razão Social ou Nome do cedente.
`sellerPersonType`	`string`	Tipo de entidade do cedente. Valores possíveis são: `LEGAL_PERSON` - Pessoa jurídica `NATURAL_PERSON` - Pessoa física
`sellerGovernmentId`	`string`	CNPJ ou CPF do cedente.
`sellerAddress`	`string`	Endereço do cedente.
`sellerAddressNumber`	`string`	Número do endereço do cedente.
`sellerAddressComplement`	`string`	Complemento do endereço do cedente.
`sellerNeighborhood`	`string`	Bairro do cedente.
`sellerCity`	`string`	Cidade do cedente.
`sellerState`	`string`	Estado do cedente.
`sellerCountry`	`string`	País do cedente.
`sellerZipCode`	`string`	CEP do cedente.
`sellerBank`	`string`	Código do banco do cedente.
`sellerAgency`	`string`	Código da agência bancária do cedente (Sem o dígito).
`sellerAgencyDigit`	`string`	Dígito da agência do cedente.
`sellerAccount`	`string`	Conta corrente do cedente (Sem o dígito).
`sellerAccountDigit`	`string`	Dígito da conta corrente do cedente.
`coobrigation`	`boolean`	Coobrigação.
`createdAt`	`long`	Data de criação do recurso.
`discount`	`number`	Valor do desconto.
`subsidy`	`number`	Valor custeado pelo sacado.
`items`	`array`	Array contendo os itens desta compra.
`items[][id]`	`string`	Identificador do item.
`items[][receivableUuid]`	`string`	Identificador do título na plataforma.
`items[][externalId]`	`string`	Identificador externo do título. `(Até 255 Caracteres)`
`items[][assetType]`	`string`	Tipo do ativo. Valores possíveis são: `DUPLICATA_MERCANTIL` - Duplicata mercantil `CHEQUE` - Cheque `CONTRATOS` - Contratos `CONTRATO_FISICO` - Contrato físico `MULTIPLOS` - Múltiplos `NOTA_SERVICO` - Nota Fiscal de Serviço `CARTAO_CREDITO` - Cartão de Crédito `DIREITOS_CREDITORIOS` - Direitos Creditórios
`items[][performed]`	`boolean`	Realizado.
`items[][operationType]`	`string`	Tipo de operação. Valores possíveis são: `PRE` - Pré `POS` - Pós `PRE_POS` - Pré/Pós.
`items[][invoiceType]`	`string`	Tipo do título. Valores possíveis são: `NOTA_FISCAL_ELETRONICA` - NFe (Nota Fiscal Eletrônica) `NOTA_FISCAL_CONSUMIDOR_ELETRONICA` - Nota Fiscal de Consumidor Eletrônica `NOTA_FISCAL_SERVICOS_ELETRONICA` - NFSe (Nota Fiscal de Serviços Eletrônica) `CONHECIMENTO_TRANSPORTE_ELETRONICO` - CTe (Conhecimento de Transporte Eletrônico) `MEIOS_PAGAMENTO_ELETRONICO` - Outros meios de pagamento eletrônico `CONTRATOS` - Contratos
`items[][invoiceDate]`	`long`	Data do título.
`items[][invoiceNumber]`	`string`	Número do título. `(Até 255 Caracteres)`
`items[][invoiceKey]`	`string`	Chave eletrônica do título. `(Até 255 Caracteres)`
`items[][installment]`	`integer`	Parcela referente ao título. Utilizado apenas quando o título é pago de forma parcelada. Quando é pago de forma à vista o valor default é 1.
`items[][totalInstallment]`	`integer`	Total de parcelas referente ao título. Utilizado apenas quando o título é pago de forma parcelada. Quando é pago de forma à vista o valor default é 1.
`items[][paymentValue]`	`number`	Valor do título.
`items[][paymentDate]`	`long`	Data de vencimento do título.
`items[][status]`	`string`	Situação da compra. Valores possíveis são: `WAITING_CUSTODY` - Aguardando custódia
`items[][tax]`	`number`	Taxa atribuída ao item da compra.
`items[][sellerPaymentValue]`	`number`	Valor cedido ao cedente descontado IOF.
`items[][sellerPaymentValueWithoutFee]`	`number`	Valor total destinado ao cedente antes do desconto de IOF.
`items[][sponsorTax]`	`number`	Taxa de rebate do sacado atribuído ao item da compra.
`items[][sponsorPaymentValue]`	`number`	Valor à pagar ao sacado.
`items[][penaltyBill]`	`number`	Multa.
`items[][interestLatePayment]`	`number`	Juros de mora.
`items[][feeRate]`	`number`	Taxa de IOF ao mês.
`items[][feeAmount]`	`number`	Valor do IOF.
`items[][discount]`	`number`	Valor do desconto.
`items[][subsidy]`	`number`	Valor custeado pelo sacado.
`items[][fileBase64]`	`string`	XML ou PDF da nota em Base64.
`_links`	`object`	Recursos disponíveis através de HATEOAS. Para saber mais clique aqui. Recursos disponíveis são: `seller` - Listar dados do cedente. `sponsor` - Listar dados do sacado. `purchase` - Listar esta compra. `purchases` - Listar todas as compras do investidor. `signature` - Listar a assinatura de uma compra.

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,
			"fileBase64": "string base64"
    }
  ]
}