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
`discount`	`number`	Valor do desconto.
`subsidy`	`number`	Valor custeado pelo sacado.
`_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

{
  "_links": {
    "purchases": {
      "href": "https://dev-zuul.monkeyecx.com/v2/buyers/540897447/purchases",
      "type": "GET"
    },
    "purchase": {
      "href": "https://dev-zuul.monkeyecx.com/v2/buyers/540897447/purchases/QNRuYVoi5u",
      "type": "GET"
    },
    "buyer": {
      "href": "https://dev-zuul.monkeyecx.com/v2/buyers/540897447",
      "type": "GET"
    }
  },
  "payableUuid": "fPRrSqyfBd",
  "detail": "Payment received",
  "status": "PAID",
  "externalId": "MU4IE8cR1i",
  "invoiceNumber": "2wXXDlFasw",
  "installment": 1,
  "totalInstallment": 1,
  "paymentDate": 1604545200000,
  "paymentValue": 11.00,
  "liquidationDate": 1605668400000,
  "liquidationValue": 11.00,
  "discount": 0.71,
  "subsidy": 0,
  "settlementType": "BANK_TRANSFER",
  "sponsorId": 37580985,
  "buyerId": 540897447,
  "sellerId": 1648193719,
  "sponsorName": "Testes PJ Sponsor",
  "sponsorGovernmentId": "78592346000113",
  "sponsorPersonType": "LEGAL_PERSON",
  "sellerName": "Testes PJ Seller",
  "sellerGovernmentId": "46753867000119",
  "sellerPersonType": "LEGAL_PERSON",
  "buyerName": "BANCO MERCANTIL DO BRASIL SA",
  "buyerGovernmentId": "17184037000110",
  "buyerAddress": "Rua Rio de Janeiro 654",
  "buyerAddressNumber": "654",
  "buyerAddressComplement": "",
  "buyerNeighborhood": "Centro",
  "buyerCity": "Belo Horizonte",
  "buyerState": "MG",
  "buyerCountry": "Brasil",
  "buyerZipCode": "30160912",
  "buyerReceivementBank": "389",
  "buyerReceivementAgency": "4130",
  "buyerReceivementAccount": "80103",
  "buyerReceivementAccountDigit": "8",
  "buyerReceivementAccountKey": "15354652342",
  "invoiceType": "NOTA_FISCAL_ELETRONICA",
  "assetType": "DUPLICATA_MERCANTIL"
}