inquiryAvailableQuota

2023-11-13 07:58

POST: /amsin/api/v1/business/account/inquiryAvailableQuota

需要签名验签

集成商可使用此接口请求万里汇查询可用于申报的结汇额度。

接口结构

万里汇接口的报文结构包括：请求头、请求体、响应头和响应体。该章节主要介绍请求体和响应体的结构。关于请求头和响应头的更多信息，参见：

请求参数

字段名	数据类型	是否必填	描述
quotaAccumulationMethod	字符串	是	结汇额度的累计方式。可取值如下： `USER_ID` ：根据申报主体UID（即已入驻万里汇的用户ID）累积申报额度。 `RECEIVING_ACCOUNT` ：根据收款账户（RA）累计申报额度。 `VIRTUAL_ACCOUNT`：根据虚拟账户（VA）累计申报额度。 `BENEFICIARY`：根据收款人（即未入驻万里汇的外部平台用户）累计申报额度。
quotaAccumulationId	字符串	是	结汇额度累计方式的标识。此字段的赋值规则如下： quotaAccumulationMethod = `USER_ID` 时，传入交易卖家的用户ID quotaAccumulationMethod = `RECEIVING_ACCOUNT` 时，传入交易卖家的收款账户（RA）号 quotaAccumulationMethod = `VIRTUAL_ACCOUNT` 时，传入交易卖家的虚拟账户（VA）号 quotaAccumulationMethod = `BENEFICIARY` 时，传入外部平台的用户ID
currency	字符串	是	结汇额度的币种。币种必须满足ISO 4217标准，比如"USD"。
tradeType	字符串	有使用条件	贸易类型。当 quotaAccumulationMethod = `BENEFICIARY` 时，此字段为必填。可取值如下： `GOODS`：货物贸易 `SERVICE`：服务贸易

响应参数

字段名	数据类型	是否必填	描述
result	Result 对象	是	API 调用结果。
quotaAccumulationMethod	字符串	是	结汇额度的累计方式。可取值如下： `USER_ID` ：根据申报主体UID（即已入驻万里汇的用户ID）累积申报额度。 `RECEIVING_ACCOUNT` ：根据收款账户（RA）累计申报额度。 `VIRTUAL_ACCOUNT`：根据虚拟账户（VA）累计申报额度。 `BENEFICIARY`：根据收款人（即未入驻万里汇的外部平台用户）累计申报额度。
quotaAccumulationId	字符串	是	结汇额度累计方式的标识。此字段的赋值规则如下： quotaAccumulationMethod = `USER_ID` 时，传入交易卖家的用户ID quotaAccumulationMethod = `RECEIVING_ACCOUNT` 时，传入交易卖家的收款账户（RA）号 quotaAccumulationMethod = `VIRTUAL_ACCOUNT` 时，传入交易卖家的虚拟账户（VA）号 quotaAccumulationMethod = `BENEFICIARY` 时，传入外部平台的用户ID
availableQuota	Amount 对象	是	可申报结汇额度。
tradeType	字符串	有使用条件	贸易类型。当 quotaAccumulationMethod = `BENEFICIARY` 时，此字段为必填。可取值如下： `GOODS`：货物贸易 `SERVICE`：服务贸易

响应处理

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

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

结果码

resultCode	resultStatus	resultMessage	resultMessage 中文含义	处理建议
SUCCESS	S	Success	成功
UNKNOWN_EXCEPTION	U	The API call is failed, which is caused by unknown reasons.	未知错误	无需更换requestId，发起重试
PARAM_ILLEGAL	F	Illegal parameters exist. For example, a non-numeric input, or an invalid date.	参数异常	修改订单信息、更换requestId，发起重试
CONTRACT_CHECK_FAIL	F	The contract check failed.	合同校验失败	检查您与万里汇的合同状态后重试
ACCOUNT_NOT_EXIST	F	The account does not exist.	账户不存在	确认账户有效后重试

代码示例

示例1：当 quotaAccumulationMethod = `USER_ID` 时

请求体

copy
{
    "quotaAccumulationMethod":"USER_ID",
    "quotaAccumulationId":"21201200039*****",
    "currency":"USD"
}

响应体

copy
{
    "quotaAccumulationMethod":"USER_ID",
    "quotaAccumulationId":"21201200039*****",
    "availableQuota":{
        "currency":"USD",
        "value":"500"
    }
}

示例2：当 quotaAccumulationMethod = `BENEFICAIRY` 时

请求体

copy
{
    "quotaAccumulationMethod":"BENEFICIARY",
    "quotaAccumulationId":"7239821*****",
    "currency":"USD",
    "tradeType":"SERVICE"
}

响应体

copy
{
    "quotaAccumulationMethod":"BENEFICIARY",
    "quotaAccumulationId":"7239821*****",
    "availableQuota":{
        "currency":"USD",
        "value":"500"
    },
    "tradeType":"SERVICE"
}