查询 MED 列表
GET /api/med
GET https://api.avista.global/api/med返回与已认证账户关联的 MED 列表,支持分页和筛选。
认证
需要在 Authorization 请求头中提供 Bearer token。
查询参数
| 参数 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
status | string | 否 | 按状态筛选: OPEN、RECEIVED、CANCELLED、ANALYZED |
isReconciled | boolean | 否 | 按对账状态筛选(true/false) |
startDate | string | 否 | 起始日期(ISO 8601)。例: 2026-01-01T00:00:00.000Z |
endDate | string | 否 | 结束日期(ISO 8601)。例: 2026-01-31T23:59:59.999Z |
page | number | 否 | 页码(从 1 开始)。默认: 1 |
pageSize | number | 否 | 每页项数(1–100)。默认: 20 |
请求示例
curl -X GET "https://api.avista.global/api/med" \
-H "Authorization: Bearer $AVISTA_TOKEN"只列出状态为 RECEIVED(分析中)的 MED:
curl -X GET "https://api.avista.global/api/med?status=RECEIVED" \
-H "Authorization: Bearer $AVISTA_TOKEN"列出 2026 年 1 月创建的 MED,第 1 页共 50 项:
curl -X GET "https://api.avista.global/api/med?startDate=2026-01-01T00:00:00.000Z&endDate=2026-01-31T23:59:59.999Z&page=1&pageSize=50" \
-H "Authorization: Bearer $AVISTA_TOKEN"列出未自动关联到本地交易的 MED:
curl -X GET "https://api.avista.global/api/med?isReconciled=false" \
-H "Authorization: Bearer $AVISTA_TOKEN"响应 (200)
| 字段 | 类型 | 描述 |
|---|---|---|
data | array | MED 对象列表 |
data[].id | number | MED 唯一标识 |
data[].endToEnd | string | 原始 PIX 交易的 end-to-end ID |
data[].status | string | 状态: OPEN、RECEIVED、CANCELLED、ANALYZED |
data[].reason | string | 原因: REFUND_REQUEST 或 REFUND_CANCELLATION |
data[].cause | string | null | 原因代码(UNAUTHORIZED_TRANSACTION、SOCIAL_ENGINEERING 等),否则为 null |
data[].description | string | null | 有关请求的补充详情 |
data[].analysisResult | string | null | 分析结果: APPROVED、REJECTED(仍在分析时为 null) |
data[].analysisDetails | string | null | 分析结果的理由 |
data[].requestingBank | object | 开启 MED 的银行 |
data[].requestingBank.ispb | string | 银行 ISPB 代码 |
data[].requestingBank.name | string | 银行名称 |
data[].contestedBank | object | 被申请银行(贵机构) |
data[].contestedBank.ispb | string | 银行 ISPB 代码 |
data[].contestedBank.name | string | 银行名称 |
data[].originalTransaction | object | null | 原始 PIX 交易的数据 |
data[].originalTransaction.amount | number | 金额(BRL) |
data[].originalTransaction.type | string | 类型(例如 "PIX") |
data[].originalTransaction.transactionType | string | 交易类型(例如 "CASH_IN") |
data[].originalTransaction.name | string | 对方姓名 |
data[].originalTransaction.document | string | 对方证件号(已脱敏) |
data[].originalTransaction.dateTime | string | 原始交易日期/时间(ISO 8601) |
data[].isReconciled | boolean | 该 MED 是否已关联到本地交易 |
data[].originalTransactionId | number | null | 本地交易 ID(如已对账) |
data[].createdAt | string | MED 创建日期(ISO 8601) |
data[].updatedAt | string | 最后更新日期(ISO 8601) |
metadata | object | 分页信息 |
metadata.total | number | 记录总数 |
metadata.page | number | 当前页码 |
metadata.pageSize | number | 每页项数 |
metadata.totalPages | number | 总页数 |
{
"data": [
{
"id": 42,
"endToEnd": "E12345678202604101030abcdef123456",
"status": "ANALYZED",
"reason": "REFUND_REQUEST",
"cause": "UNAUTHORIZED_TRANSACTION",
"description": "Customer claims not to have performed the transaction",
"analysisResult": "APPROVED",
"analysisDetails": "Refund approved by operator - amount refunded",
"requestingBank": {
"ispb": "00000000",
"name": "BCO DO BRASIL S.A."
},
"contestedBank": {
"ispb": "13140088",
"name": "ACESSO SOLUÇÕES DE PAGAMENTO"
},
"originalTransaction": {
"amount": 1500.00,
"type": "PIX",
"transactionType": "CASH_IN",
"name": "João da Silva",
"document": "***456789**",
"dateTime": "2026-04-05T14:30:00.000Z"
},
"isReconciled": true,
"originalTransactionId": 78432,
"createdAt": "2026-04-10T10:00:00.000Z",
"updatedAt": "2026-04-12T15:30:00.000Z"
}
],
"metadata": {
"total": 1,
"page": 1,
"pageSize": 20,
"totalPages": 1
}
}错误
| 状态码 | 描述 |
|---|---|
| 400 | 参数无效（status 不在枚举内、日期格式错误、page < 1、pageSize 不在 1–100 范围内） |
| 401 | Token 缺失或无效 |
| 429 | 请求过多 — 请等待几秒后再试 |
| 500 | 查询 MED 时发生内部错误 |
400 错误示例：
{
"statusCode": 400,
"message": "status must be one of: OPEN, RECEIVED, CANCELLED, ANALYZED",
"error": "Bad Request"
}401 错误示例：
{
"statusCode": 401,
"message": "Unauthorized",
"error": "Unauthorized"
}要了解状态和原因的生命周期,请参阅 MED 概览。