inquiryAccount

2023-11-23 07:54

POST: /amsin/api/v1/business/account/inquiryAccount
需要签名验签

调用此接口查询账户信息，如：账户类型，账号，是否激活，币种等。

报文结构

万里汇接口报文结构包括：请求头，请求体。关于头信息，详见：

请求参数

字段名	数据类型	是否必填	描述
referenceCustomerId	字符串	是（有条件）	集成商分配给注册用户的唯一用户ID。注：当accountType取值为`RECEIVE_ACCOUNT`或`ALIPAY_WALLET`时，该字段为必传。更多信息：字符串最大值：64字符
customerId	字符串	是（有条件）	由万里汇定义、用于唯一标识某万里汇账户。更多信息：字符串最大值：64字符
accessToken	字符串	是（有条件）	用于OAuth校验的访问令牌。注：当accountType取值为`VIRTUAL_ACCOUNT`时，该字段为必传。更多信息：字符串最大值：64字符
accountType	字符串	是	查询账户类型。可取值为： `RECEIVE_ACCOUNT` 万里汇收款账户（RA） `VIRTUAL_ACCOUNT` 万里汇虚拟账户（VA） `ALIPAY_WALLET` 支付宝钱包

响应参数

字段名	数据类型	是否必填	描述
result	Result 类型	是	代表本接口调用的结果。
responseId	字符串	是	由万里汇定义，用于唯一标识某次响应的ID。更多信息：字段最大长度：32字符
customerId	字符串	有条件返回	由万里汇定义，用于唯一标识某万里汇账户。注：当accountType取值为`RECEIVE_ACCOUNT`或`VIRTUAL_ACCOUNT`时，该字段为必传。更多信息：字符串最大值：64字符
accountInfos	数组<AccountInfo>对象	有条件返回	账户信息。注：当accountType取值为`RECEIVE_ACCOUNT`或`VIRTUAL_ACCOUNT`时，该字段为必传。
customer	Customer 类型	是	客户信息，包括公司名称、营业执照编号等。

响应处理

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

result.resultStatus	描述
S	API请求成功。
F	API请求失败。失败原因参见结果码（即`result.resultCode`和`result.resultMessage`）
U	API响应结果为`UNKNOWN`（未知）时，需重试API请求。重试策略：重试次数上限：7次重试时间间隔：5分钟、10分钟、20分钟、40分钟、80分钟、160分钟、320分钟如果问题依旧，请联系万里汇技术支持。

结果码

`result.resultCode`

系统结果码

resultCode	resultStatus	resultMessage	Further action
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请求方法为`POST`

Business related result codes

resultCode	resultStatus	resultMessage	Further action
ACCESS_TOKEN_EXPIRED	F	The access token has expired.	刷新token接口以重新获取访问令牌（access token），或联系万里汇技术支持以解决问题
KEY_NOT_FOUND	F	The key is not found.	检查Client ID是否正确或生成密钥对是否正确
ACCESS_DENIED	F	The access is denied.	联系万里汇技术支持了解详情
MEDIA_TYPE_NOT_ACCEPTABLE	F	The server does not implement the media type that is acceptable to the client.	使用正确媒体类型重试
REPEAT_REQ_INCONSISTENT	F	Repeated requests are inconsistent.	重试请求不一致。需保证所有请求参数均相同
UN_SUPPORT_BUSINESS	F	Unsupported business.	使用正确的参数重试
ACCOUNT_NOT_EXIST	F	Account does not exist.	账户不存在，使用其他账户重试
AUTHORIZATION_NOT_EXIST	F	OAUTH does not exist.	当前token授权关系不存在，请联系万里汇技术支持检查token授权关系

示例代码

请求

请求体范例

copy
{
  "accountType":"RECEIVE_ACCOUNT",
  "referenceCustomerId":"*****"
}

响应

响应体范例

copy
{
  "accountInformation":[
    {
      "accountNo":"*****",
      "accountStatus":"ACTIVE",
      "accountType":"RECEIVE_ACCOUNT",
      "currencyList":[
        "EUR"
      ]
    },
    {
      "accountNo":"*****",
      "accountStatus":"ACTIVE",
      "accountType":"RECEIVE_ACCOUNT",
      "currencyList":[
        "JPY"
      ]
    },
    {
      "accountNo":"*****",
      "accountStatus":"ACTIVE",
      "accountType":"RECEIVE_ACCOUNT",
      "currencyList":[
        "USD"
      ]
    }
  ],
  "customer":{
    "certificateList":[
      {
        "certificateNo":"*****",
        "certificateType":"ENTERPRISE_REGISTRATION"
      }
    ],
    "customerCompanyName":"QWER***",
    "customerId":"*****"
  },
  "customerId":"*****",
  "responseId":"*****",
  "result":{
    "resultStatus": "S",
    "resultCode": "SUCCESS",
    "resultMessage": "success."
  }
}