按 Requester 查询付款批次

请求

ENDPOINT

/payment_order_conciliation_batches

方法

GET

Query Params

字段	类型	描述	是否必填
payment_order_conciliation_batch_status	enumerator	按对账批次状态筛选。	否
payment_order_conciliation_batch_type	enumerator	按对账批次类型筛选。	否
page	integer	分页页码（默认：1）。	否
page_size	integer	分页每页大小（默认：25）。	否
from_date	string	筛选开始日期（ISO 8601 格式，如 "2025-06-01"）。	否
to_date	string	筛选结束日期（ISO 8601 格式，如 "2025-06-30"）。	否

响应

STATUS

200

Response Body

{
    "payment_order_conciliation_batches": [
        {
            "payment_order_conciliation_batch_key": "98fc62fd-b0a0-4604-9bea-475e91a9dc82",
            "payment_order_conciliation_batch_status": "closed",
            "payment_order_conciliation_batch_type": "fixed_amount",
            "account_key": "9b9ae7b0-7292-4b0d-9131-0167525ab067",
            "total_amount": 1200,
            "conciliated_amount": 1200,
            "total_payment_orders": 12,
            "conciliated_payment_orders": 12,
            "reference_date": "2025-06-13",
            "created_at": "2025-06-10T20:30:23.459Z"
        },
        {
            "payment_order_conciliation_batch_key": "98fc62fd-b0a0-4604-9bea-475e91a9dc82",
            "payment_order_conciliation_batch_status": "closed",
            "payment_order_conciliation_batch_type": "variable_amount",
            "account_key": "9b9ae7b0-7292-4b0d-9131-0167525ab067",
            "total_amount": 700,
            "conciliated_amount": 600,
            "total_payment_orders": 7,
            "conciliated_payment_orders": 6,
            "reference_date": "2025-06-13",
            "created_at": "2025-06-10T20:30:23.459Z"
        },
        {
            "payment_order_conciliation_batch_key": "98fc62fd-b0a0-4604-9bea-475e91a9dc82",
            "payment_order_conciliation_batch_status": "open",
            "payment_order_conciliation_batch_type": "variable_amount",
            "account_key": "9b9ae7b0-7292-4b0d-9131-0167525ab067",
            "total_amount": 900,
            "conciliated_amount": 700,
            "total_payment_orders": 9,
            "conciliated_payment_orders": 7,
            "reference_date": "2025-06-17",
            "created_at": "2025-06-10T20:30:23.459Z"
        },
        {
            "payment_order_conciliation_batch_key": "98fc62fd-b0a0-4604-9bea-475e91a9dc82",
            "payment_order_conciliation_batch_status": "closed",
            "payment_order_conciliation_batch_type": "fixed_amount",
            "account_key": "c24a0ac4-792c-494e-b887-6185e07a33a3",
            "total_amount": 800,
            "conciliated_amount": 800,
            "total_payment_orders": 8,
            "conciliated_payment_orders": 8,
            "reference_date": "2025-06-13",
            "created_at": "2025-06-10T20:30:23.459Z"
        },
        {
            "payment_order_conciliation_batch_key": "98fc62fd-b0a0-4604-9bea-475e91a9dc82",
            "payment_order_conciliation_batch_status": "open",
            "payment_order_conciliation_batch_type": "variable_amount",
            "account_key": "c24a0ac4-792c-494e-b887-6185e07a33a3",
            "total_amount": 1000,
            "conciliated_amount": 500,
            "total_payment_orders": 10,
            "conciliated_payment_orders": 5,
            "reference_date": "2025-06-17",
            "created_at": "2025-06-10T20:30:23.459Z"
        }
    ],
    "pagination": {
        "page": 1,
        "page_size": 25,
        "number_of_pages": 1
    }
}

Response Body Params

字段	类型	描述	字符数
payment_order_conciliation_batches	array	付款订单对账批次列表。	Array payment_order_conciliation_batches
pagination	object	查询分页信息。	Objeto pagination

Array payment_order_conciliation_batches

字段	类型	描述	字符数
payment_order_conciliation_batch_key	uuidv4	对账批次的唯一标识符。	36
payment_order_conciliation_batch_status	enumerator	付款订单对账批次状态。	Enumeradores payment_order_conciliation_batch_status
payment_order_conciliation_batch_type	enumerator	付款订单对账批次类型。	Enumeradores payment_order_conciliation_batch_type
account_key	uuidv4	账户的唯一标识键。	36
total_amount	number	对账批次的总金额（巴西雷亚尔 R$）。	-
conciliated_amount	number	批次中已对账的金额（巴西雷亚尔 R$）。	-
total_payment_orders	integer	批次中付款订单的总数。	-
conciliated_payment_orders	integer	批次中已对账的付款订单数量。	-
reference_date	string	批次参考日期（ISO 8601 格式，如 "2025-06-13"）。	10
created_at	string	批次创建日期和时间（ISO 8601 格式）。	-

Objeto pagination

字段	类型	描述	字符数
page	integer	当前查询页码。	-
page_size	integer	每页大小（每页项目数量）。	-
number_of_pages	integer	可用的总页数。	-

Enumeradores payment_order_conciliation_batch_status

枚举值	描述
open	对账批次已开放
closed	对账批次已关闭
processing	对账批次处理中
completed	对账批次已完成
cancelled	对账批次已取消

Enumeradores payment_order_conciliation_batch_type

枚举值	描述
fixed_amount	固定金额对账批次
variable_amount	可变金额对账批次

STATUS

4XX

Response Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em português",
  "code": "codigo"
}

HTTP 状态码	QI 代码 code	标题 title	描述（英文） description	描述（葡文） translation
400	QIT000002	Bad Request	Invalid request schema.	Erro no esquema da requisição.
404	APX000003	Conciliation Batch Not Found	Conciliation batch not found.	Lote de conciliação não encontrado.