查询定期提现

使用此端点按 id 查询指定的定期提现。

可用环境

生产环境

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

端点

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

路径参数

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

请求示例

cURL

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

JavaScript

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

成功响应

字段	类型	必填	说明
id	string (UUID)	是	定期提现的唯一标识
pixKey	object	是	目标 PIX 密钥（参见子对象 PixKeyVo）
amount	number	是	每次提现的金额（整数，以分为单位）
status	string (enum) - ACTIVE, CANCELLED	是	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)	是	最后更新时间
totalAmountWithdrawn	number	否	已处理排期中累计提出的金额（整数，以分为单位）

子对象

PixKeyVo

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

响应示例

数据脱敏

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

{
  "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",
  "totalAmountWithdrawn": 30000
}

可能的错误

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