Consulta de Lote de Pagamento

Retorna um lote de pagamento pelo external_id informado na criação. Use para acompanhar o status do lote ou quando a criação devolve duplicidade (SET000009).

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}

MÉTODO

GET

Path params

Parâmetro	Tipo	Descrição
fund_class_key	string	Chave do fundo (UUID).
external_id	string	O external_id informado na criação do lote. Também aceita o payment_batch_key devolvido pela QI Tech.

Response

STATUS

200

A resposta ecoa os campos enviados na criação do lote (por exemplo account, source_document_number, end_to_end_id) e acrescenta os dados abaixo.

Response Body

{
    "external_id": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
    "description": "PAGAMENTOS - ABC - 2025-01-01",
    "account": {
        "account_number": "123456",
        "account_digit": "0",
        "account_branch": "0001",
        "financial_institution_code": "329"
    },
    "fund_class": {
        "name": "FUNDO DE INVESTIMENTO EM DIREITOS CREDITÓRIOS EXEMPLO",
        "manager": {
            "name": "EXEMPLO CAPITAL",
            "manager_key": "a7498c6c-1893-42ec-a8f3-bc6ad0c6b52c",
            "document_number": "22.333.444/0001-81"
        },
        "fund_class_key": "4b8377d0-58ec-479f-8ee9-9f963d5c47ad",
        "document_number": "11.222.333/0001-81",
        "accounting_date": "2025-01-01",
        "payment_batch_automatic_discard": false
    },
    "payment_batch_key": "63f0dbec-e9c4-4943-929e-1d47b9edbb0b",
    "status": "pending_payment",
    "reference_date": "2025-01-01",
    "account_key": "5e621ba2-b4ac-4ddd-9893-82d220e1577e",
    "total_value": 4520.75,
    "settlement_expenses": [
        {
            "settlement_expense_key": "0b6f3c1e-8f0a-4c55-9a4e-2f1d7c9e3b10",
            "amount": 15.00,
            "status": "pending_submission",
            "description": "Despesa de Liquidação - Despesa Bancária",
            "type": "bank_account"
        }
    ]
}

Atributos da resposta

Campo	Tipo	Descrição
external_id	string	Chave externa do lote fornecida pelo parceiro.
description	string	Descrição do lote. Quando não informada na criação, é gerada como Lote de Pagamento - {reference_date} - {external_id}.
fund_class	object	Dados do fundo: name, manager (name, manager_key, document_number), fund_class_key, document_number, accounting_date (data contábil atual do fundo) e payment_batch_automatic_discard.
payment_batch_key	string	Identificador único do lote gerado pela QI Tech (UUID).
status	string	Status atual do lote. Veja abaixo.
reference_date	string	Data de referência do lote, no formato YYYY-MM-DD.
account_key	string	Chave da conta associada ao lote (UUID).
total_value	number	Valor total do lote. Presente depois que o total é apurado.
settlement_expenses	array	Despesas de liquidação informadas na criação, com settlement_expense_key, amount, status, description e type. Presente apenas quando há despesas.

Status do lote

Status	Significado
pending_settlements_insertion	Lote criado, aceitando liquidações.
pending_validation	Lote encerrado com liquidações em revisão pela QI Tech. Ao fim da revisão, segue para pending_payment.
pending_payment	Lote encerrado, aguardando a confirmação do pagamento.
paid	Pagamento confirmado; as liquidações estão sendo processadas.
completed	Todas as liquidações chegaram a settled ou discarded. Status final.
pending_discard / pending_discard_on_cash_account	Descarte solicitado, em processamento.
discarded	Lote descartado. Status final.

Erros

Status	Código	Quando acontece
404	SET000010	Não existe lote com este external_id (nem com este payment_batch_key) no 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.