queryMerchantTransactionRules需要签名验签
集成商可调用此接口查询当前客户或指定卡片已配置的商户名黑白名单规则。
报文结构
万里汇接口报文结构包括:请求头、请求体、响应体。
请求头
字段名 | 是否必传 | 范例 | 说明 |
Client-Id | 是 |
| |
Signature | 是 |
| |
Content-Type | 是 |
| |
Request-Time | 是 |
| |
Connected-AccountId | 否(有条件要求) |
| 注意此字段 当平台客户操作商户账户时需要传递 |
Access-Token | 否(有条件要求) |
| 注意此字段 当用 OAUTH 授权时需要传递。参考 applyToken。 |
入参
targetType String REQUIRED
查询维度,区分大小写。可取值范围:
MID:查询客户全局规则。CARD:查询卡维度规则。
assetId String
卡资产 ID。
注意:
- 当 targetType 字段取值为
MID时,无需传入此字段。- 当 targetType 字段取值为
CARD时:
- 指定 assetId ,则查询指定卡片。
- 若未指定 assetId,则默认分页查询卡规则。
pageNumber Integer
页码。该字段默认取值为1。
格式:1、2、3……
当 targetType 字段取值为
CARD,且未指定 assetId 时,可按需传入本字段。
pageSize Integer
每页包含的条目数。该字段默认取值为10。
当 targetType 字段取值为
CARD,且未指定 assetId 时,可按需传入本字段。
更多信息:
- 值范围: 1 - 100 (包含1和100)
出参
result Result REQUIRED
代表接口调用结果。
hasMore Boolean
是否还有下一页。可取值范围:
true:还有下一页。false:当前为最后一页。
此字段只有当 result.resultStatus = S 时才会按需返回。
此字段在以下场景将返回
false值:
- 当 targetType 字段取值为
MID 时;或- 当 targetType 字段取值为
CARD 且 指定 assetId 时。
transactionRuleList Array<MerchantTransactionRule>
商户名规则数组。
此字段只有当 result.resultStatus = S 时才会按需返回。
注意:
- 当 targetType 字段取值为
MID,或 targetType 字段取值为CARD且指定 assetId 时,该字段返回 0 或 1 条;- 当 targetType 字段取值为
CARD但未指定 assetId 时,返回当前页规则。
请求
响应
响应处理
集成商调用接口后,万里汇返回集成商API调用结果。result.resultStatus 字段取值范围为:
result.resultStatus | 描述 |
S | API请求成功。 |
F | API请求失败。 失败原因参见结果码(即 result.resultCode 和 result.resultMessage ) |
U | API响应结果为 重试策略:
如果问题依旧,请联系万里汇技术支持。 |
result.resultCode
| 结果码 | 值 | 结果码信息 | 行动建议 |
|---|---|---|---|
| SUCCESS | S | Success | |
| UNKNOWN_EXCEPTION | U | API failed due to unknown reason. | 服务器错误,若稍后重试问题依旧,联系万里汇技术支持以解决问题。 |
| PARAM_ILLEGAL | F | Illegal parameters exist. For example, a non-numeric input, or an invalid date. | 参考API文档页面,确认请求头和传参是否正确。 |
| SYSTEM_ERROR | F | System error. | 请勿重试,联系万里汇技术支持了解详情。 |
| USER_NOT_EXIST | F | The user does not exist. | 使用正确的用户信息重试。 |