Liquidação de Títulos

Quando a compra/antecipação de um título é liquidada pelo sacado, nós disparamos um evento para indicar a conclusão dessa operação.

Neste evento enviamos as informações sobre qual cedente realizou a antecipação (Razão Social e CNPJ), sacado responsável pela liquidação (Razão Social e CNPJ), bem como, os dados do investidor (Razão Social, CNPJ, endereço e dados bancários).

Esse evento também contém os IDs (PayableUuid, ExternalId e InvoiceNumber) que são utilizados para que você identifique o título no seu sistema.

No momento do envio dos títulos, tanto via API, quanto via arquivo, é definido o layout e você irá optar por enviar um dos três identificadores acima. E você deve utilizar o mesmo identificador quando receber a requisição do Hook.

Path: /liquidations

Webhook payload object

Chave	Tipo	Descrição
`sponsorId`	`string`	Identificador do sacado.
`payableUuid`	`string`	Identificador do título na plataforma.
`status`	`string`	Situação da compra. Valores possíveis são: `PAID` - Título Pago
`detail`	`number`	Detalhes do item.
`externalId`	`string`	Identificador externo do título.
`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
`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
`invoiceNumber`	`integer`	Número da nota fiscal.
`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.
`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.
`paymentValue`	`integer`	Valor do título.
`paymentDate`	`integer`	Data de vencimento do título.
`sponsorName`	`integer`	Razão Social ou Nome do sacado.
`sponsorPersonType`	`integer`	Tipo de entidade do sacado. Valores possíveis são: `LEGAL_PERSON` - Pessoa jurídica `NATURAL_PERSON` - Pessoa física
`sponsorGovernmentId`	`integer`	CNPJ ou CPF do sacado.
`sellerId`	`integer`	Identificador do cedente.
`sellerName`	`integer`	Razão Social ou Nome do cedente.
`sellerPersonType`	`integer`	Tipo de entidade do cedente. Valores possíveis são: `LEGAL_PERSON` - Pessoa jurídica `NATURAL_PERSON` - Pessoa física
`sellerGovernmentId`	`integer`	CNPJ ou CPF do cedente.
`buyerId`	`integer`	Identificador do investidor.
`buyerName`	`integer`	Razão Social ou Nome do investidor.
`buyerGovernmentId`	`integer`	CNPJ ou CPF do investidor.
`buyerAddress`	`string`	Endereço do investidor.
`buyerAddressNumber`	`string`	Número do endereço do investidor.
`buyerAddressComplement`	`string`	Complemento do endereço do investidor.
`buyerAddressNeighborhood`	`string`	Bairro do investidor.
`buyerCity`	`string`	Cidade do investidor.
`buyerState`	`string`	Estado do investidor.
`buyerCountry`	`string`	País do investidor.
`buyerZipCode`	`string`	CEP do investidor.
`buyerReceivementBank`	`string`	Código do banco de recebimento do investidor.
`buyerReceivementAgency`	`string`	Código da agência bancária de recebimento do investidor.
`buyerReceivementAccount`	`string`	Conta corrente de recebimento do investidor. (Sem o dígito)
`buyerReceivementAccountDigit`	`string`	Dígito da conta corrente de recebimento do investidor.
`liquidationDate`	`string`	Data em que o pagamento foi realizado.
`liquidationValue`	`string`	Valor pago.
`settlementType`	`integer`	Tipo de pagamento. Valores possíveis são: `BILL` - Pagamento em boleto `BANK_TRANSFER` - Transferência bancária
`_links`	`object`	Recursos disponíveis através de HATEOAS. Para saber mais clique aqui. Recursos disponíveis são: `buyer` - Listar dados do investidor. `purchase` - Listar esta compra. `purchases` - Listar todas as compras do investidor.

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"
      }
   }
}