查询提现 MED

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

可用环境

生产环境

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

端点

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

路径参数

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

请求示例

cURL

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

JavaScript

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

成功响应

字段	类型	必填	说明
id	string	是	MED 的标识
acquirer	string	是	MED 所属的收单机构
endToEnd	string	是	被争议提现的 end-to-end 标识
notificationId	string	否	关联通知的标识
withdrawalId	string (UUID)	是	被争议提现的标识
status	string (enum) - PENDING, APPEALED, APPROVED, REJECTED	是	MED 的状态
origin	string (enum) - USER, ADMIN	是	发起来源：USER 表示由您发起，ADMIN 表示由运营团队发起
reason	string (enum) - SCAM, FRAUDULENT_ACCESS, OPERATIONAL_ERROR, OTHER	是	MED 的原因
amount	number	是	MED 金额（整数，以分为单位）
paymentMethod	string (enum) - PIX	是	支付方式
payer	object	否	付款方信息（参见子对象 AccountHolder）
receiver	object	否	收款方信息（参见子对象 AccountHolder）
message	string	否	发起时填写的说明
user	object	是	用户信息（参见子对象 UserVo）
statusHistory	array	是	状态历史（参见子对象 StatusHistory）
medDate	string (ISO)	是	MED 的日期
createdAt	string (ISO)	是	创建时间
updatedAt	string (ISO)	是	最后更新时间

子对象

StatusHistory（列表项）

字段	类型	必填	说明
status	string (enum) - PENDING, APPEALED, APPROVED, REJECTED	是	历史中记录的 MED 状态
date	string (ISO)	是	该状态的时间
durationInMilliseconds	number	是	该状态的持续时长，单位为毫秒

UserVo

字段	类型	必填	说明
name	string	是	用户名称
email	string	是	用户邮箱
createdAt	string (ISO)	是	用户的创建时间

AccountHolder

字段	类型	必填	说明
type	string (enum) - PF, PJ	是	持有人类型
name	string	是	持有人姓名
document	string	是	持有人证件号码
bankAccount	object	是	银行信息（参见子对象 BankAccount）
pix	object	是	持有人的 PIX 密钥（参见子对象 PixKeyVo）

BankAccount

字段	类型	必填	说明
type	string	是	账户类型
digit	string	是	账户校验位
ispb	string	是	银行的 ISPB

PixKeyVo

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

响应示例

数据脱敏

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

{
  "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": {
    "type": "PJ",
    "name": "Empresa Exemplo LTDA",
    "document": "12345678000199",
    "bankAccount": {
      "type": "CHECKING",
      "digit": "0",
      "ispb": "12345678"
    },
    "pix": {
      "key": "contato@exemplo.com",
      "type": "EMAIL"
    }
  },
  "receiver": {
    "type": "PF",
    "name": "Fulano de Tal",
    "document": "***456789**",
    "bankAccount": {
      "type": "CHECKING",
      "digit": "7",
      "ispb": "12345678"
    },
    "pix": {
      "key": "12345678910",
      "type": "CPF"
    }
  },
  "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	无权限或未授权	请联系技术支持
404	未找到记录	请检查传入的 id
422	数据无效或缺失	请检查数据格式
422	校验失败	请联系技术支持
500	内部错误	请联系技术支持