跳到主要内容

列出归集

商户路由已确认。 查看适用范围。

对象与完整字段 · 认证、金额与错误 · 接入指南

GET /v1/settlements

查询当前商户的归集任务,按创建时间倒序排列,创建时间相同时按 ID 倒序排列。默认返回全部状态,多个筛选条件同时生效。

Attributes​

属性位置类型必填说明
statusquerystring否preparing、requires_action、processing、succeeded、failed
chainqueryinteger否按网络编号筛选
currencyquerystring否按稳定币筛选:usdc、usdt
page_sizequeryinteger否每页数量,默认 20,范围 1–100
page_tokenquerystring否上一页返回的 next_page_token;第一页不传

无需 Idempotency-Key,无请求体。翻页时保持筛选条件不变。

请求示例​

GET /v1/settlements?status=succeeded&page_size=20
Authorization: Bearer inv_test_...

返回示例​

200 OK,data 中的每一项均为完整的 Settlement 对象。

{
"data": [
{
"id": "st_example",
"status": "succeeded",
"item_ids": ["si_example"],
"amount": "12.5",
"currency": "usdc",
"chain": 8453,
"recipient_address": "0x1234567890abcdef1234567890abcdef12345678",
"next_action": null,
"transaction_hash": "0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"last_execution_error": null,
"created_at": "2026-10-27T08:00:00Z",
"updated_at": "2026-10-27T08:10:00Z",
"settled_at": "2026-10-27T08:10:00Z"
}
],
"next_page_token": ""
}

没有匹配记录时返回 {"data":[],"next_page_token":""}。

业务错误码