WorldFirst DocsWorldFirst DocsDOCS

inquiryAvailableQuota需要签名验签

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

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

报文结构

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

入参

quotaAccumulationMethod String  REQUIRED

结汇额度的累计方式。

可取值如下：

  • USER_ID ：根据申报主体UID（即已入驻万里汇的用户ID）累积申报额度。
  • RECEIVING_ACCOUNT ：根据收款账户（RA）累计申报额度。
  • VIRTUAL_ACCOUNT：根据虚拟账户（VA）累计申报额度。
  • BENEFICIARY：根据收款人（即未入驻万里汇的外部平台用户）累计申报额度。

quotaAccumulationId String  REQUIRED

结汇额度累计方式的标识。可取值如下：

  • quotaAccumulationMethod = USER_ID 时，传入交易卖家的用户ID
  • quotaAccumulationMethod = RECEIVING_ACCOUNT 时，传入交易卖家的收款账户（RA）号
  • quotaAccumulationMethod = VIRTUAL_ACCOUNT 时，传入交易卖家的虚拟账户（VA）号
  • quotaAccumulationMethod = BENEFICIARY 时，传入外部平台的用户ID

currency String  REQUIRED

结汇额度的币种。 币种必须满足ISO 4217标准，比如"USD"。

tradeType String  CONDITIONAL

贸易类型。

可取值如下：

  • GOODS：货物贸易
  • SERVICE：服务贸易

当 quotaAccumulationMethod = BENEFICIARY时，此字段为必传。

出参

result Result  REQUIRED

代表API调用结果。

Show child parameters

quotaAccumulationMethod String  REQUIRED

结汇额度的累计方式。

可取值如下：

  • USER_ID ：根据申报主体UID（即已入驻万里汇的用户ID）累积申报额度。
  • RECEIVING_ACCOUNT ：根据收款账户（RA）累计申报额度。
  • VIRTUAL_ACCOUNT：根据虚拟账户（VA）累计申报额度。
  • BENEFICIARY：根据收款人（即未入驻万里汇的外部平台用户）累计申报额度。

quotaAccumulationId String  REQUIRED

结汇额度累计方式的标识。可取值如下：

  • quotaAccumulationMethod = USER_ID 时，传入交易卖家的用户ID
  • quotaAccumulationMethod = RECEIVING_ACCOUNT 时，传入交易卖家的收款账户（RA）号
  • quotaAccumulationMethod = VIRTUAL_ACCOUNT 时，传入交易卖家的虚拟账户（VA）号
  • quotaAccumulationMethod = BENEFICIARY 时，传入外部平台的用户ID

availableQuota Amount  REQUIRED

可申报的结汇额度。

Show child parameters

tradeType String  CONDITIONAL

贸易类型。

可取值如下：

  • GOODS：货物贸易
  • SERVICE：服务贸易

当 quotaAccumulationMethod = BENEFICIARY时，此字段为必传。

API Explorer

请求

URL
Case
When quotoAccumulationMethod is USER_ID
请求体

响应

Case
When quotoAccumulationMethod is USER_ID
响应体

响应处理

集成商调用接口后，万里汇通过 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分钟

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

结果码

结果码值结果码信息行动建议
SUCCESSSSuccess
UNKNOWN_EXCEPTIONUThe API call is failed, which is caused by unknown reasons.

无需更换requestId，发起重试

PARAM_ILLEGALFIllegal parameters exist. For example, a non-numeric input, or an invalid date.

修改订单信息、更换requestId，发起重试

CONTRACT_CHECK_FAILFThe contract check failed.

检查您与万里汇的合同状态后重试

ACCOUNT_NOT_EXISTFThe account does not exist.

确认账户有效后重试

@2024 WorldFirst