查询排期列表

使用此端点查询某个定期提现生成的排期（schedulings）。

每个定期提现会按创建时指定的频率与持续次数，为每一次预计执行生成一条排期。

可用环境

生产环境

https://api.gateway.com.br/core

端点

方法：GET
端点：/recurring-withdrawal/{id}/schedulings
认证方式：Bearer token

路径参数

名称	类型	必填	说明	校验规则
`id`	string (UUID)	是	定期提现的标识	必须为有效的 UUID

查询参数

ℹ️ snapshot 分页

snapshot 不是指向“下一页”的指针：它是分页会话的固定标识，与 page（仍需照常传入并递增）配合使用，即使在翻页过程中产生了新记录，也能保持结果一致。

请从第一次响应中取得 snapshot 的值（第一次请求不传 snapshot），并在后续页面的请求中原样重新传回该值，同时保持与最初请求相同的筛选条件和相同的 perPage。如果在重新传回旧的 snapshot 时其中任一值发生变化，接口会返回错误。

名称	类型	必填	说明	校验规则
`snapshot`	string	否	分页会话的标识（取自第一次响应的 `snapshot` 字段）；后续页面请随 `page` 一起原样传回	必须与最初请求的筛选条件和 `perPage` 一致

请求示例

cURL
JavaScript

curl --request GET \
--url https://api.gateway.com.br/core/recurring-withdrawal/553e8400-e29b-41d4-a716-436251480000/schedulings \
--header 'Authorization: Bearer your-jwt-token'

const response = await fetch('https://api.gateway.com.br/core/recurring-withdrawal/553e8400-e29b-41d4-a716-436251480000/schedulings', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer your-jwt-token'
  }
});
const data = await response.json();

成功响应

字段	类型	必填	说明
`totalPages`	number	是	总页数
`currentPage`	number	是	当前页
`perPage`	number	是	每页条数
`snapshot`	string	否	分页会话的标识；后续页面请原样传回
`data`	array	是	排期列表

`data` 中每一项的字段

字段	类型	必填	说明
`id`	string (UUID)	是	排期的唯一标识
`status`	string (enum) - `SCHEDULED`, `PROCESSED`, `FAILED`, `CANCELED`	是	SCHEDULED：等待预计的执行日期 PROCESSED：提现已成功处理 FAILED：处理提现时出错 CANCELED：排期已取消（例如定期提现被取消）
`amount`	number	是	提现金额（整数，以分为单位）
`description`	string	是	提现的说明
`scheduledDate`	string (ISO)	是	预计的执行日期

响应示例

{
  "totalPages": 1,
  "currentPage": 1,
  "perPage": 15,
  "snapshot": "b3BhcXVlLXNuYXBzaG90LXRva2Vu",
  "data": [
    {
      "id": "663e8400-e29b-41d4-a716-446655440001",
      "status": "SCHEDULED",
      "amount": 10000,
      "description": "Repasse mensal para fornecedor",
      "scheduledDate": "2027-02-05T12:00:00.000Z"
    }
  ]
}

可能的错误

状态码	说明	处理方式
401	凭据无效	请检查您的凭据
403	无权限或未授权	请联系技术支持
404	未找到记录	请检查传入的 `id`
422	数据无效或缺失	请检查数据格式
500	内部错误	请联系技术支持

可用环境​

端点​

路径参数​

查询参数​

请求示例​

成功响应​

data 中每一项的字段​

响应示例​

可能的错误​