queryCardList需要签名验签

POST /amsin/api/v1/business/worldcard/queryCardList

申请万里付卡片后,集成商可调用此接口查询持有的所有万里付卡片。

报文结构

万里汇接口报文结构包括:请求头、请求体、响应体。

请求头

字段名

是否必传

范例

说明

Client-Id

Client-Id: *****

关于这些参数的解释说明,详见:请求头

Signature

Signature: algorithm=RSA256, keyVersion=2, signature=*****

Content-Type

Content-Type: application/json; charset=UTF-8

Request-Time

Request-Time: 2019-04-04T12:08:56+08:00

Connected-CustomerId

否(有条件要求)

Connected-CustomerId: *****

注意此字段

当平台客户操作商户账户时需要传递

Access-Token

有条件要求

Access-Token: ****** 

注意此字段

当用 OAUTH 授权时需要传递


入参

cardStatus String  

卡片状态。可取值范围:

  • ACTIVE:卡片可正常使用
  • FROZEN:卡片已冻结
  • CANCEL:卡片已注销

cardNickName String  

由用户定义的卡昵称,可以帮助用户更方便地管理多张万里付卡片。

更多信息:

  • 最大长度:120 字符

cardNoLast4 String  

卡号后四位数字。

更多信息:

  • 最大长度:4 字符

pageSize Integer  REQUIRED

每页包含的条目数。

更多信息:

  • 最大长度:50 字符

pageNumber Integer  REQUIRED

页码。

格式:1、2、3……

出参

result Result  REQUIRED

代表API 接口的调用结果。

Show child parameters

cardList Array <CardList>  REQUIRED

万里付卡片列表。

此字段只有当 result.resultStatus = S 时才会按需返回。

Show child parameters

totalCount Integer  REQUIRED

本次查询结果的总条目数。

此字段只有当 result.resultStatus = S 时才会按需返回。

totalPageNumber Integer  REQUIRED

查询结果的总页数。

此字段只有当 result.resultStatus = S 时才会按需返回。

currentPageNumber Integer  REQUIRED

当前页码。

此字段只有当 result.resultStatus = S 时才会按需返回。

API Explorer

请求

URL
请求体

响应

响应体

响应处理

集成商调用接口后,万里汇返回集成商API调用结果。result.resultStatus 字段取值范围为:

Result status

描述

S

接口调用成功

F

接口调用失败,具体失败原因见result.resultCode

U

调用结果未知,需重试API请求。若问题依旧,联系万里汇技术支持。

result.resultCode

结果码结果码信息行动建议
SUCCESSSSuccess
PARAM_ILLEGALFIllegal parameters exist. For example, a non-numeric input, or an invalid date.

参考API文档页面,确认请求头和传参是否正确。

UNKNOWN_EXCEPTIONUAPI failed due to unknown reason.

服务器错误,若稍后重试问题依旧,联系万里汇技术支持以解决问题。

SYSTEM_ERRORFSystem error.

请勿重试,联系万里汇技术支持了解详情。

USER_NOT_EXISTFThe user does not exist.

使用正确的用户信息重试。

CONTRACT_NOT_EXISTFThe contract check has failed.

联系万里汇技术支持了解合约状态后重试。

ACCESS_TOKEN_EXPIREDFThe access token expired.

刷新token接口以重新获取访问令牌(access token),或联系万里汇技术支持以解决问题。

AUTHORIZATION_NOT_EXISTFThe authorization does not exist.

当前授权关系不存在,请联系万里汇技术支持检查授权关系。