跳到主要内容

查询提现 MED 列表

使用此端点查询提现 MED,可按期间、状态以及被争议提现的信息筛选。

可用环境​

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

端点​

  • 方法:GET
  • 端点:/med/withdrawal
  • 认证方式:Bearer token

查询参数​

ℹ️ 使用 ISO 日期

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

示例:

  • 2026-03-06T12:00:00.000Z
名称类型必填说明校验规则
startDatestring否筛选的起始日期必须为带时间的 ISO date string
endDatestring否筛选的结束日期必须为带时间的 ISO date string
statusstring[] (enum) - PENDING, APPEALED, APPROVED, REJECTED否用于筛选的状态列表必须为非空且不含重复项的数组
idstring (UUID)否MED 的标识必须为有效的 UUID
withdrawalIdstring (UUID)否被争议提现的标识必须为有效的 UUID
endToEndstring否提现的 end-to-end 标识长度须在 8 到 255 个字符之间
amountnumber否MED 金额(整数,以分为单位)必须为以分为单位的整数;最小 1(R$0.01),最大 10000000(R$100,000.00)
paymentMethodstring (enum) - PIX否支付方式必须为有效的枚举值

请求示例​

curl --request GET \
--url "https://api.gateway.com.br/core/med/withdrawal?startDate=2026-03-01T00:00:00.000Z&endDate=2026-03-24T23:59:59.999Z&status=PENDING" \
--header 'Authorization: Bearer your-jwt-token'

成功响应​

字段类型必填说明
totalPagesnumber是总页数
currentPagenumber是当前页
perPagenumber是每页条数
dataarray是提现 MED 列表

data 中每一项的字段​

每一项的结构与查询提现 MED 相同,包含 AccountHolder、UserVo 与 StatusHistory 子对象。

响应示例​

数据脱敏

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

{
"totalPages": 1,
"currentPage": 1,
"perPage": 20,
"data": [
{
"id": "553e8400-e29b-41d4-a716-436251480000",
"acquirer": "ACQUIRER_EXEMPLO",
"endToEnd": "E12345678202603061249abcdef0123",
"notificationId": null,
"withdrawalId": "553e8400-e29b-41d4-a716-436251480001",
"status": "PENDING",
"origin": "USER",
"reason": "OPERATIONAL_ERROR",
"amount": 10000,
"paymentMethod": "PIX",
"payer": null,
"receiver": null,
"message": "Saque enviado para a chave errada",
"user": {
"name": "Usuário Exemplo",
"email": "usuario@exemplo.com",
"createdAt": "2026-01-15T10:00:00.000Z"
},
"statusHistory": [
{
"status": "PENDING",
"date": "2026-03-06T12:49:04.681Z",
"durationInMilliseconds": 1000
}
],
"medDate": "2026-03-06T12:49:04.681Z",
"createdAt": "2026-03-06T12:49:04.681Z",
"updatedAt": "2026-03-06T12:49:04.681Z"
}
]
}

可能的错误​

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