跳到主要内容

查询 MED

使用此端点按 id 查询指定 MED 的详细信息。

可用环境​

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

端点​

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

路径参数​

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

请求示例​

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

成功响应​

字段类型必填说明
idstring是MED 的标识
acquirerstring是MED 所属的收单机构
transactionIdstring是交易的标识
endToEndstring是end-to-end 标识
notificationIdstring否关联通知的标识
statusstring (enum) - PENDING, APPEALED, APPROVED, REJECTED是MED 的状态
originstring (enum) - ACQUIRER, ADMIN是MED 的来源
reasonstring (enum) - SCAM, FRAUDULENT_ACCESS, OPERATIONAL_ERROR, OTHER是MED 的原因
amountnumber是MED 金额(整数,以分为单位)
paymentMethodstring (enum) - PIX是支付方式
payerobject否付款方信息(参见子对象 AccountHolder)
customerMessagestring否客户留言
userobject是用户信息(UserVo)
decisionMessagestring否处理结论说明
refundStatusstring (enum) - FULL_REFUND, PARTIAL_REFUND, INSUFFICIENT_FUNDS否退款状态
appealContentobject否申诉内容(AppealContent)
refundAmountnumber否退款金额(整数,以分为单位)
statusHistoryarray是状态历史(参见子对象 StatusHistory)
medDatestring (ISO)是MED 的日期
createdAtstring (ISO)是创建时间
updatedAtstring (ISO)是最后更新时间

子对象​

UserVo​

字段类型必填说明
namestring是用户名称
emailstring是用户邮箱
createdAtstring (ISO)是用户的创建时间

AccountHolder​

字段类型必填说明
typestring (enum) - PF, PJ是持有人类型
namestring是持有人姓名
documentstring是持有人证件号码
bankAccountobject是银行信息(参见子对象 BankAccount)
pixobject是持有人的 PIX 密钥(参见子对象 PixKeyVo)

BankAccount​

字段类型必填说明
typestring是账户类型
digitstring是账户校验位
ispbstring是银行的 ISPB

PixKeyVo​

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

StatusHistory(列表项)​

字段类型必填说明
statusstring (enum) - PENDING, APPEALED, APPROVED, REJECTED是历史中记录的 MED 状态
datestring (ISO)是状态变更的时间
durationInMillisecondsnumber否该状态的持续时长,单位为毫秒

AppealContent​

字段类型必填说明
messagestring否申诉说明
evidencesarray否申诉证据(参见子对象 FileVo)

FileVo(evidences 的列表项)​

字段类型必填说明
keystring是文件的键
isPrivateboolean是标识文件是否为私有
expirationDatestring (ISO)否文件的过期时间
urlstring否文件的签名地址

响应示例​

{
"id": "553e8400-e29b-41d4-a716-436251480000",
"acquirer": "ACQUIRER_EXEMPLO",
"transactionId": "553e8400-e29b-41d4-a716-446655440000",
"endToEnd": "E2E12345678",
"notificationId": null,
"status": "APPEALED",
"origin": "ACQUIRER",
"reason": "FRAUDULENT_ACCESS",
"amount": 1000,
"paymentMethod": "PIX",
"payer": {
"type": "PF",
"name": "Fulano de Tal",
"document": "***456789**",
"bankAccount": {
"type": "CHECKING",
"digit": "7",
"ispb": "12345678"
},
"pix": {
"key": "12345678910",
"type": "CPF"
}
},
"customerMessage": "Cliente informou não reconhecer a cobrança.",
"user": {
"name": "Loja Exemplo",
"email": "contato@lojaexemplo.com",
"createdAt": "2026-03-01T09:00:00.000Z"
},
"decisionMessage": "Defesa recebida e em análise.",
"refundStatus": "FULL_REFUND",
"appealContent": {
"message": "Anexamos comprovante de entrega.",
"evidences": [
{
"key": "med/evidence-1.pdf",
"isPrivate": true,
"expirationDate": "2026-03-25T10:00:00.000Z",
"url": null
}
]
},
"refundAmount": 1000,
"statusHistory": [
{
"status": "PENDING",
"date": "2026-03-24T10:00:00.000Z",
"durationInMilliseconds": 3600000
},
{
"status": "APPEALED",
"date": "2026-03-24T11:00:00.000Z",
"durationInMilliseconds": 1800000
},
{
"status": "APPROVED",
"date": "2026-03-24T11:30:00.000Z",
"durationInMilliseconds": null
}
],
"medDate": "2026-03-24T10:00:00.000Z",
"createdAt": "2026-03-24T10:00:00.000Z",
"updatedAt": "2026-03-24T11:30:00.000Z"
}

可能的错误​

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