WorldFirst DocsWorldFirst Docs

inquiryStatementList需要签名验签

POST /amsin/api/v1/business/account/inquiryStatementList

集成商可调用此接口获取交易账单。

报文结构

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

请求头

字段名

是否必传

范例

说明

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-AccountId

否(有条件要求)

Connected-AccountId: *****

注意此字段

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

Access-Token

有条件要求

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: 同名充值余额类型。
  • ​BUDGET_BALANCE​:预算账户余额类型。

当该字段为空时,NORMAL_BALANCE为默认取值。

budgetAccountIds Array<String>  

预算账户ID列表。

pageSize Integer  REQUIRED

每页包含的条目数。该字段取值固定为10。

更多信息:

  • 值范围: 10(固定值)

pageNumber Integer  REQUIRED

当前页码。该字段取值最大为50。

格式:1、2、3……

更多信息:

  • 值范围: 0 - 50 (包含0和50)

fuzzyName String  

模糊检索字段。

出参

result Result  REQUIRED

代表接口调用结果。

Show child parameters

responseId String  REQUIRED

由万里汇定义,用于唯一标识某次响应的ID。

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

更多信息:

  • 最大长度:32 字符

feeItemType String  

账单费用类型。可取值范围:

  • OBO_SERVICE_FEE:OBO服务费
  • REMIT_SERVICE_FEE:基础服务费

statementList Array<Statement>  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.resultStatus

描述

S

接口调用成功

F

接口调用失败。

失败原因参见结果码(即result.resultCode 和result.resultMessage)

U

API响应结果为UNKNOWN(未知)时,需重试API请求。

重试策略:

  • 重试次数上限:7次
  • 重试时间间隔:5分钟、10分钟、20分钟、40分钟、80分钟、160分钟、320分钟

如果问题依旧,请联系万里汇技术支持。


result.resultCode:系统结果码

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

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

PROCESS_FAILFA general business failure occurred. Do not retry.

需要人工介入,联系万里汇技术支持以解决此问题

UNKNOWN_EXCEPTIONUAPI failed due to unknown reason.

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

REQUEST_TRAFFIC_EXCEED_LIMITUThe request traffic exceeds the limit.

重试,若问题依旧,联系万里汇技术支持

OAUTH_FAILFOAuth process failed.

联系万里汇技术支持了解详情

INVALID_APIFThe called API is invalid or not active.

确认是否调用正确的API

INVALID_CLIENTFThe client is invalid.

Client ID不存在或无效

INVALID_SIGNATUREFThe signature is invalid.

确认请求正确加签

METHOD_NOT_SUPPORTEDFThe server does not implement the requested HTTP method.

确认HTTP请求方法为POST

result.resultCode:业务结果码

结果码值结果码信息行动建议
USER_NOT_EXISTFThe user does not exist.

使用正确的用户信息重试

SYSTEM_ERRORFSystem error.

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

SERVICE_NOT_ALLOWEDFService not allowed

使用正确的信息重试,若问题依旧,联系万里汇技术支持以解决问题

CURRENCY_NOT_SUPPORTFThe currency is not supported.

暂不支持该币种

CONTRACT_CHECK_FAILFThe contract check has failed.

检查合约状态后重试

ACCESS_TOKEN_EXPIREDFThe access token expired.

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

AUTHORIZATION_NOT_EXISTFThe authorization does not exist.

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