Consulta de Liquidação

Retorna uma liquidação de um lote de pagamento pelo external_id informado na inserção. Use para conferir o status da liquidação ou quando a inserção devolve duplicidade (SET000013).

Disponível em

Perfil	Host	Permissão exigida
Gestora	manager-api	Leitura
Consultoria	consultant-api	Visualizar Lotes
Cedente	assignor-api	Leitura

URL base de cada host: Ambientes (Hosts).

Request

ENDPOINT

/settlement/fund_class/{fund_class_key}/payment_batch/{external_id}/settlement/{settlement_external_id}

MÉTODO

GET

Path params

Parâmetro	Tipo	Descrição
fund_class_key	string	Chave do fundo (UUID).
external_id	string	O external_id do lote de pagamento.
settlement_external_id	string	O external_id da liquidação, informado no corpo da inserção.

Response

STATUS

200

O objeto é o mesmo devolvido na inserção da liquidação: os campos enviados no corpo da inserção mais os dados calculados pela QI Tech, com o status atual.

Response Body

{
    "asset_type": "ccb",
    "total_value": 130.50,
    "external_id": "931e9437-d025-41ab-bb53-6b94e10fd361",
    "settlement_type": "installment_settlement",
    "contract_number": "0123456789/ABC",
    "installment_number": 1,
    "collection_date": "2025-01-01",
    "collection_origin_type": "borrower",
    "asset_external_id": "CCB-0001",
    "assignor_document_number": "33.444.555/0001-81",
    "borrower_document_number": "969.698.790-03",
    "status": "settled",
    "type": "installment_settlement",
    "settlement_key": "b2c3d4e5-f6a7-8901-abcd-ef1234567890",
    "total_number_of_units": 1,
    "settlement_result": 0.0,
    "next_execution_datetime": "2025-01-01 13:00:00.000000",
    "counter_party_document_number": "969.698.790-03",
    "assets": [
        {
            "asset_key": "f34e9437-d025-41ab-bb53-6b94e10fd361",
            "number_of_units": 1,
            "present_value": 1250.00,
            "installment_face_value": 130.50
        }
    ]
}

Status da liquidação

Status	Significado
validated	Inserida e aprovada; aguarda o pagamento do lote.
pending_validation	Valor pago fora da tolerância; aguarda revisão da QI Tech.
waiting_send_to_queue / on_queue	Lote pago; liquidação em processamento na carteira do fundo.
settled	Concluída e conciliada na carteira. Status final.
discarded	Descartada, sem movimentação financeira. Status final. O campo denial_reason traz o motivo, quando houver.
inconsistent_asset	A carteira recusou o pagamento por inconsistência no ativo. A QI Tech trata o caso; o lote não chega a completed enquanto houver liquidação neste status.

O mapa completo, com os status que geram webhook, está em Webhooks de liquidação.

Erros

Status	Código	Quando acontece
404	SET000011	Não existe liquidação com este settlement_external_id no lote informado (ou o lote não existe neste fundo).
404	SET000005	A fund_class_key não existe.
403	SET000028	O fundo não pertence ao seu perfil (gestora do fundo, consultoria vinculada ou cedente associado).

Erros de autenticação, permissão e host: veja Erros da API.