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. |
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ídicaNATURAL_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ídicaNATURAL_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. |
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 mercantilCHEQUE - ChequeCONTRATOS - ContratosCONTRATO_FISICO - Contrato físicoMULTIPLOS - MúltiplosNOTA_SERVICO - Nota Fiscal de ServiçoCARTAO_CREDITO - Cartão de CréditoDIREITOS_CREDITORIOS - Direitos Creditórios |
items[][performed] | boolean | Realizado. |
items[][operationType] | string | Tipo de operação. Valores possíveis são: PRE - PréPOS - PósPRE_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ônicaNOTA_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ônicoCONTRATOS - 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. |
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. |
_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
{
"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"
}
}
}
Updated over 2 years ago