TIDC v1 API

API de cessão de crédito e liquidação de recebíveis para originadores e parceiros.

Warning

Todas as requisições devem ser assinadas com RSA-SHA256. Veja a seção de autenticação abaixo.

Autenticação

A API TIDC v1 usa assinatura digital RSA-SHA256 para autenticar cada requisição. Você recebe um client_id e deve gerar um par de chaves RSA (2048 bits). A chave pública é cadastrada na Liqi.

Headers obrigatórios

Name	Type	Required	Description
`X-Client-Id`	string	Required	Seu identificador de cliente fornecido pela Liqi.
`X-Timestamp`	string	Required	Unix timestamp em segundos. Deve estar dentro de uma janela de 5 minutos.
`X-Signature`	string	Required	Assinatura RSA-SHA256 do body da requisição, codificada em Base64.

Cessão de Crédito (Credit Batches)

Lotes de cessão agrupam contratos de crédito para transferência ao patrimônio separado. O fluxo é: criar lote (DRAFT), adicionar contratos, submeter (SUBMITTED), e aguardar processamento (PROCESSED).

POST/tidc/v1/credit-batches

Cria um novo lote de cessão de crédito com contratos.

Body Parameters

Name	Type	Required	Description
`patrimonyId`	uuid	Required	ID do patrimônio separado que receberá os créditos.
`contracts`	array	Required	Lista de contratos de crédito para cessão.
`contracts[].externalId`	string	Required	Identificador único do contrato no sistema do originador.
`contracts[].debtorDocument`	string	Required	CPF ou CNPJ do devedor (apenas números).
`contracts[].faceValue`	number	Required	Valor nominal do contrato em BRL.
`contracts[].dueDate`	date	Required	Data de vencimento do contrato (YYYY-MM-DD).

GET/tidc/v1/credit-batches

Lista todos os lotes de cessão do cliente autenticado.

Name	Type	Required	Description
`status`	string	Optional	Filtrar por status: DRAFT, SUBMITTED, PROCESSING, PROCESSED, REJECTED.
`page`	number	Optional	Número da página.(default: `1`)
`limit`	number	Optional	Itens por página.(default: `20`)

GET/tidc/v1/credit-batches/:id

Retorna os detalhes de um lote de cessão específico.

POST/tidc/v1/credit-batches/:id/submit

Submete o lote para processamento. O status muda de DRAFT para SUBMITTED.

POST/tidc/v1/credit-batches/:id/cancel

Cancela um lote em status DRAFT ou SUBMITTED.

Baixas (Settlement Batches)

Lotes de baixa registram pagamentos recebidos de devedores. Quando um contrato cedido e pago, o originador notifica a Liqi via settlement batch.

POST/tidc/v1/settlement-batches

Cria um novo lote de baixa com liquidações de contratos.

Body Parameters

Name	Type	Required	Description
`creditBatchId`	uuid	Required	ID do lote de cessão original.
`settlements`	array	Required	Lista de liquidações de contratos.
`settlements[].contractId`	uuid	Required	ID do contrato sendo liquidado.
`settlements[].settledAmount`	number	Required	Valor efetivamente recebido em BRL.
`settlements[].settledDate`	date	Required	Data do pagamento (YYYY-MM-DD).

GET/tidc/v1/settlement-batches

Lista todos os lotes de baixa.

GET/tidc/v1/settlement-batches/:id

Retorna detalhes de um lote de baixa.

Webhooks

A Liqi envia notificações via webhook quando eventos relevantes acontecem (ex: lote processado, contrato rejeitado). Configure a URL de webhook no painel de parceiro.

Eventos disponíveis

Evento	Descrição
`credit_batch.processed`	Lote de cessão processado com sucesso.
`credit_batch.rejected`	Lote de cessão rejeitado (veja reason).
`settlement_batch.processed`	Lote de baixa processado.
`contract.status_changed`	Status de contrato individual alterado.

Info

Os webhooks incluem um header X-Webhook-Signature com assinatura HMAC-SHA256 para verificação.

Autenticação RSA-SHA256

Assinatura RSA-SHA256

// 1. Assine o body com sua chave privada RSA
const crypto = require("crypto");

const body = JSON.stringify(payload);
const timestamp = Math.floor(Date.now() / 1000).toString();

const sign = crypto.createSign("RSA-SHA256");
sign.update(body);
const signature = sign.sign(privateKey, "base64");

// 2. Envie nos headers
const headers = {
  "Content-Type": "application/json",
  "X-Client-Id": "your-client-id",
  "X-Timestamp": timestamp,
  "X-Signature": signature,
};

Criar lote de cessão

cURL - Criar lote

curl -X POST https://api.liqi.com.br/tidc/v1/credit-batches \
  -H "Content-Type: application/json" \
  -H "X-Client-Id: your-client-id" \
  -H "X-Timestamp: 1708531200" \
  -H "X-Signature: base64-signature..." \
  -d '{
    "patrimonyId": "uuid-do-patrimonio",
    "contracts": [
      {
        "externalId": "CNTR-001",
        "debtorDocument": "12345678000199",
        "debtorName": "Empresa ABC",
        "faceValue": 50000.00,
        "dueDate": "2026-06-15",
        "interestRate": 1.5
      }
    ]
  }'

Response - Lote criado

201Success

{
  "id": "batch-uuid-001",
  "patrimonyId": "uuid-do-patrimonio",
  "status": "DRAFT",
  "contractCount": 1,
  "totalFaceValue": "50000.00",
  "createdAt": "2026-02-21T10:30:00Z",
  "contracts": [
    {
      "id": "contract-uuid-001",
      "externalId": "CNTR-001",
      "debtorDocument": "12345678000199",
      "debtorName": "Empresa ABC",
      "faceValue": "50000.00",
      "dueDate": "2026-06-15",
      "status": "PENDING"
    }
  ]
}

Registrar baixa

cURL - Registrar baixa

curl -X POST https://api.liqi.com.br/tidc/v1/settlement-batches \
  -H "Content-Type: application/json" \
  -H "X-Client-Id: your-client-id" \
  -H "X-Timestamp: 1708531200" \
  -H "X-Signature: base64-signature..." \
  -d '{
    "creditBatchId": "batch-uuid-001",
    "settlements": [
      {
        "contractId": "contract-uuid-001",
        "settledAmount": 50000.00,
        "settledDate": "2026-02-20",
        "paymentMethod": "PIX"
      }
    ]
  }'