Payment Batch Retrieval

Returns a payment batch by the external_id provided at creation. Use it to track the batch status or when the creation returns a duplicate (SET000009).

Available on

Profile	Host	Required permission
Manager	manager-api	Read
Consultant	consultant-api	View Batches
Assignor	assignor-api	Read

Base URL for each host: Environments (Hosts).

Request

ENDPOINT

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

METHOD

GET

Path params

Parameter	Type	Description
fund_class_key	string	Fund key (UUID).
external_id	string	The external_id provided at the batch creation. Also accepts the payment_batch_key returned by QI Tech.

Response

STATUS

200

The response echoes the fields sent at batch creation (for example account, source_document_number, end_to_end_id) and adds the data below.

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

Response attributes

Field	Type	Description
external_id	string	External key of the batch provided by the partner.
description	string	Batch description. When not provided at creation, it is generated as Lote de Pagamento - {reference_date} - {external_id}.
fund_class	object	Fund data: name, manager (name, manager_key, document_number), fund_class_key, document_number, accounting_date (the fund's current accounting date) and payment_batch_automatic_discard.
payment_batch_key	string	Unique batch identifier generated by QI Tech (UUID).
status	string	Current batch status. See below.
reference_date	string	Reference date of the batch, in YYYY-MM-DD format.
account_key	string	Key of the account associated with the batch (UUID).
total_value	number	Total value of the batch. Present once the total has been computed.
settlement_expenses	array	Settlement expenses provided at creation, with settlement_expense_key, amount, status, description and type. Present only when there are expenses.

Batch status

Status	Meaning
pending_settlements_insertion	Batch created, accepting settlements.
pending_validation	Batch closed with settlements under review by QI Tech. At the end of the review, it moves to pending_payment.
pending_payment	Batch closed, awaiting payment confirmation.
paid	Payment confirmed; the settlements are being processed.
completed	All settlements reached settled or discarded. Final status.
pending_discard / pending_discard_on_cash_account	Discard requested, in progress.
discarded	Batch discarded. Final status.

Errors

Status	Code	When it happens
404	SET000010	There is no batch with this external_id (nor with this payment_batch_key) in the fund.
404	SET000005	The fund_class_key does not exist.
403	SET000028	The fund does not belong to your profile (the fund's manager, a linked consultant or an associated assignor).

Authentication, permission and host errors: see API Errors.