inquiryStatementList需要签名验签
集成商可调用此接口获取交易账单。
报文结构
万里汇接口报文结构包括:请求头、请求体、响应体。
请求头
字段名 | 是否必传 | 范例 | 说明 |
Client-Id | 是 |
| 关于这些参数的解释说明,详见:请求头。 |
Signature | 是 |
| |
Content-Type | 是 |
| |
Request-Time | 是 |
| |
Connected-CustomerId | 否(有条件要求) |
| 当平台客户操作商户账户时需要传递 |
Access-Token | 有条件要求 |
| 当用 OAUTH 授权时需要传递 |
入参
startTime DateTime REQUIRED
查询交易记录的开始时间。
fuzzyName字段取值为空时,startTime 和 endTime 计算的账单时长不得超过3个月(100天)。
更多信息:
- 值遵循 ISO 8601 标准格式。例如,“2019-11-27T12:01:01+08:00”。
endTime DateTime REQUIRED
查询交易记录的结束时间。
fuzzyName字段取值为空时,startTime 和 endTime 计算的账单时长不得超过3个月(100天)。
更多信息:
- 值遵循 ISO 8601 标准格式。例如,“2019-11-27T12:01:01+08:00”。
transactionTypeList Array<String>
账单的交易类型。
取值包括:TRANSFER
转账,COLLECTION
收款等。完整取值详见:transactionType。
- 在不同的地区和业务场景下,transactionTypeList 的取值也将有所不同。请根据WorldFirst门户页面所显示的交易类型进行查询。
- 若集成商未使用本字段,万里汇则响应包含全部交易类型的账单。
currencyList Array<String>
集成商查询的币种列表,为 ISO-4217 标准规定的三位字母货币代码。
现阶段支持的币种有:USD
, EUR
, GBP
, CAD
, JPY
, AUD
, HKD
, SGD
, NZD
, CNY
, CHF
, AED
, SEK
, PLN
, CZK
, MXN
.
若未传本字段,万里汇则响应所有币种的交易账单。
balanceTypes Array<String>
该字段表示客户拥有的不同余额类型。
客户在不同业务场景下,可使用不同的余额类型对资金余额做分隔管理,作用是为了风险管控。
此字段的可取值为:
NORMAL_BALANCE
: 普通余额类型(即电商余额类型)。(默认)SAME_NAME_TOP_UP_BALANCE
: 同名充值余额类型。
当该字段为空时,
NORMAL_BALANCE
为默认取值。
pageSize Integer REQUIRED
每页包含的条目数。该字段取值固定为10。
更多信息:
- 值范围: 10(固定值)
pageNumber Integer REQUIRED
当前页码。该字段取值最大为50。
格式:1、2、3……
更多信息:
- 值范围: 0 - 50 (包含0和50)
fuzzyName String
模糊检索字段。
出参
result Result REQUIRED
代表接口调用结果。
responseId String REQUIRED
由万里汇定义,用于唯一标识某次响应的ID。
此字段只有当 result.resultStatus =
S
时才会按需返回。
更多信息:
- 最大长度:32 字符
statementList Array<Statement> REQUIRED
对账单列表。
此字段只有当 result.resultStatus =
S
时才会按需返回。
totalCount Integer REQUIRED
本次查询结果的总条目数。
此字段只有当 result.resultStatus =
S
时才会按需返回。
totalPageNumber Integer REQUIRED
查询结果的总页数。
此字段只有当 result.resultStatus =
S
时才会按需返回。
currentPageNumber Integer REQUIRED
当前页码。
此字段只有当 result.resultStatus =
S
时才会按需返回。
请求
响应
响应信息处理
集成商调用接口后,万里汇返回集成商API调用结果。result.resultStatus 字段取值范围为:
result.resultCode:系统结果码
结果码 | 值 | 结果码信息 | 行动建议 |
---|---|---|---|
SUCCESS | S | Success | |
PARAM_ILLEGAL | F | Illegal parameters exist. For example, a non-numeric input, or an invalid date. | 参考API文档页面,确认请求头和传参是否正确 |
PROCESS_FAIL | F | A general business failure occurred. Do not retry. | 需要人工介入,联系万里汇技术支持以解决此问题 |
UNKNOWN_EXCEPTION | U | API failed due to unknown reason. | 服务器错误,若稍后重试问题依旧,联系万里汇技术支持以解决问题 |
REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. | 重试,若问题依旧,联系万里汇技术支持 |
OAUTH_FAIL | F | OAuth process failed. | 联系万里汇技术支持了解详情 |
INVALID_API | F | The called API is invalid or not active. | 确认是否调用正确的API |
INVALID_CLIENT | F | The client is invalid. | Client ID不存在或无效 |
INVALID_SIGNATURE | F | The signature is invalid. | 确认请求正确加签 |
METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTP method. | 确认HTTP请求方法为 |
result.resultCode:业务结果码
结果码 | 值 | 结果码信息 | 行动建议 |
---|---|---|---|
USER_NOT_EXIST | F | The user does not exist. | 使用正确的用户信息重试 |
SYSTEM_ERROR | F | System error. | 请勿重试,联系万里汇技术支持了解详情 |
SERVICE_NOT_ALLOWED | F | Service not allowed | 使用正确的信息重试,若问题依旧,联系万里汇技术支持以解决问题 |
CURRENCY_NOT_SUPPORT | F | The currency is not supported. | 暂不支持该币种 |
CONTRACT_CHECK_FAIL | F | The contract check has failed. | 检查合约状态后重试 |
ACCESS_TOKEN_EXPIRED | F | The access token expired. | 刷新token接口以重新获取访问令牌(access token),或联系万里汇技术支持以解决问题 |
AUTHORIZATION_NOT_EXIST | F | The authorization does not exist. | 当前授权关系不存在,请联系万里汇技术支持检查授权关系 |