查询定期提现列表

使用此端点按筛选条件查询定期提现列表。

可用环境

生产环境

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

端点

• 方法：GET
• 端点：/recurring-withdrawal
• 认证方式：Bearer token

查询参数

ℹ️ 使用 ISO 日期

startDate 和 endDate 必须以带时间的 ISO date string 格式传入。

示例：

• 2026-03-06T12:00:00.000Z

ℹ️ snapshot 分页

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

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

名称	类型	必填	说明	校验规则
snapshot	string	否	分页会话的标识（取自第一次响应的 snapshot 字段）；后续页面请随 page 一起原样传回	必须与最初请求的筛选条件和 perPage 一致
startDate	string	否	筛选的起始日期（createdAt）	必须为带时间的 ISO date string
endDate	string	否	筛选的结束日期（createdAt）	必须为带时间的 ISO date string
status	string[] (enum) - ACTIVE, CANCELLED	否	用于筛选的状态列表	必须为非空且不含重复项的数组
pixKey	string	否	目标 PIX 密钥
description	string	否	定期提现的说明

请求示例

cURL

curl --request GET \
--url https://api.gateway.com.br/core/recurring-withdrawal?status=ACTIVE \
--header 'Authorization: Bearer your-jwt-token'

JavaScript

const params = new URLSearchParams({});
params.append('status', 'ACTIVE');

const response = await fetch(`https://api.gateway.com.br/core/recurring-withdrawal?${params}`, {
  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)	是	定期提现的唯一标识
pixKey	object	是	目标 PIX 密钥（参见子对象 PixKeyVo）
amount	number	是	每次提现的金额（整数，以分为单位）
status	string (enum) - ACTIVE, CANCELLED	是	定期提现的状态
frequencyType	string (enum) - REPEAT_EVERY, FIXED_DAY	是	频率类型
frequencyUnit	string (enum) - DAYS, MONTHS	是	频率单位
frequencyValue	number	是	间隔（REPEAT_EVERY 时）或每月的第几天（FIXED_DAY 时）
duration	number	是	已排期的执行次数
description	string	是	定期提现的说明
lastScheduledDate	string (ISO)	是	最近一次生成排期的日期
createdAt	string (ISO)	是	创建时间
updatedAt	string (ISO)	是	最后更新时间

子对象

PixKeyVo

字段	类型	必填	说明
key	string	是	PIX 密钥
type	string (enum) - CPF, CNPJ, EMAIL, PHONE, EVP	是	PIX 密钥的类型

响应示例

数据脱敏

敏感信息可能以 *** 脱敏显示。

{
  "totalPages": 1,
  "currentPage": 1,
  "perPage": 15,
  "snapshot": "b3BhcXVlLXNuYXBzaG90LXRva2Vu",
  "data": [
    {
      "id": "553e8400-e29b-41d4-a716-436251480000",
      "pixKey": {
        "key": "12345678910",
        "type": "CPF"
      },
      "amount": 10000,
      "status": "ACTIVE",
      "frequencyType": "FIXED_DAY",
      "frequencyUnit": "MONTHS",
      "frequencyValue": 5,
      "duration": 12,
      "description": "Repasse mensal para fornecedor",
      "lastScheduledDate": "2027-02-05T12:00:00.000Z",
      "createdAt": "2026-03-06T12:49:04.681Z",
      "updatedAt": "2026-03-06T12:49:04.681Z"
    }
  ]
}

可能的错误

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