付款批次查询
按创建时提供的 external_id 返回一个付款批次。可用于跟踪批次状态,或在创建返回重复(SET000009)时使用。
适用范围
| 角色 | 主机 | 所需权限 |
|---|---|---|
| 管理人 | manager-api | 读取 |
| 顾问 | consultant-api | View Batches |
| 转让方 | assignor-api | 读取 |
各主机的 Base URL:环境(主机)。
Request
ENDPOINT
/settlement/fund_class/{fund_class_key}/payment_batch/{external_id}MÉTODO
GETPath params
| 参数 | 类型 | 描述 |
|---|---|---|
fund_class_key | string | 基金的 key(UUID)。 |
external_id | string | 创建批次时提供的 external_id。也接受 QI Tech 返回的 payment_batch_key。 |
Response
STATUS
200响应会回显创建批次时发送的字段(例如 account、source_document_number、end_to_end_id),并附加以下数据。
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"
}
]
}
响应属性
| 字段 | 类型 | 描述 |
|---|---|---|
external_id | string | 合作伙伴提供的批次外部 key。 |
description | string | 批次描述。创建时未提供的,按 Lote de Pagamento - {reference_date} - {external_id} 生成。 |
fund_class | object | 基金数据:name、manager(name、manager_key、document_number)、fund_class_key、document_number、accounting_date(基金当前的会计日期)和 payment_batch_automatic_discard。 |
payment_batch_key | string | QI Tech 生成 的批次唯一标识(UUID)。 |
status | string | 批次当前状态。见下文。 |
reference_date | string | 批次的参考日期,格式为 YYYY-MM-DD。 |
account_key | string | 与批次关联的账户 key(UUID)。 |
total_value | number | 批次总金额。总额核算完成后返回。 |
settlement_expenses | array | 创建时提供的清算费用,包含 settlement_expense_key、amount、status、description 和 type。仅在有费用时返回。 |
批次状态
| 状态 | 含义 |
|---|---|
pending_settlements_insertion | 批次已创建,可接受清算。 |
pending_validation | 批次已关闭,有清算正在由 QI Tech 审核。审核结束后进入 pending_payment。 |
pending_payment | 批次已关闭,等待付款确认。 |
paid | 付款已确认;清算处理中。 |
completed | 所有清算均已达到 settled 或 discarded。最终状态。 |
pending_discard / pending_discard_on_cash_account | 已申请废弃,处理中。 |
discarded | 批次已废弃。最终状态。 |