WorldFirst DocsWorldFirst DocsDOCS

inquiryAvailableCalendar

POST: /amsin/api/v1/business/fund/inquiryAvailableCalendar

需要签名验签

在创建远期外汇交易前，集成商需调用此接口查询可以进行远期交易的窗口期。

接口结构

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

请求参数

字段名

数据类型

是否为必填字段

描述

currencyList

列表<字符串>

是

集成商查询的币种列表，为 ISO 4217 标准规定的三位字母货币代码。

beginDate

字符串

是

查询远期外汇交易开始时间。格式：yyyyMMdd

endDate

字符串

是

查询远期外汇交易结束时间。格式：yyyyMMdd

forwardType

字符串

否（有条件）

远期外汇交易的汇率类型。当 exchangeTradeType = UNFUNDED_FORWARD 时，此字段为必填。可选值如下：

  • FIXED：固定日期
  • WINDOWED：窗口模式
  • FLEXIBLE：灵活日期

关于字段枚举值，详见：forwardType

exchangeTradeType

字符串

否

外汇交易类型。可选值如下：

  • UNFUNDED_FORWARD: 指该笔外汇交易的类型为资金不充足的远期交易。
  • UNFUNDED_SPOT: 指该笔外汇交易的类型为资金不充足的即期交易。

如果该字段未赋值，则默认为UNFUNDED_FORWARD。

响应参数

字段名

数据类型

是否为必填字段

描述

result

Result 对象

是

代表接口调用结果

responseId

字符串

是

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

  • 字段最大长度：32

availableDates

列表<字符串>

否

可用于远期外汇交易的日期列表。格式：yyyyMMdd

响应处理

集成商调用接口后，万里汇返回集成商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

处理建议

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.

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

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

result.resultCode: 业务结果码

resultCode

resultStatus

resultMessage

处理建议

UN_SUPPORT_BUSINESS

F

Unsupported business.

包含无效参数（如货币代码错误），使用正确的参数重试

范例

请求

请求体范例

copy
{
    "currencyList": [
        "EUR",
        "USD"
    ],
    "beginDate": "20220811",
    "endDate": "20220911"
}

请求代码范例

copy
var jsonStr="{"currencyList":["EUR","USD"],"beginDate":"20220811","endDate":"20220911"}";
var client = new RestClient("http://{domain_name}.com/amsin/api/v1/business/fund/inquiryAvailableCalendar");
var request = new RestRequest(Method.POST);
request.AddHeader("client-id","*****");
request.AddHeader("request-time","2022-05-17T11:19:20+08:00");
request.AddHeader("Content-Type","application/json");
request.AddHeader("signature","algorithm=RSA256,keyVersion=1,signature=RckSOIrxy%2FKqC%2FZQOO0t74U9U4TFVYKmW%2FZflFRut7W1hipos3NLBGdpzbulcc5Q7XwZP1t3qgTZMFrC%2FlzOQCOsBhUgelvEAuACu49PEGiAus8sU%2FFJa1HOIUmst3oWjLT%2BDqY083mR7jVwc5O2JYP08wNCLu55PFZtXHBUfwEAYoZInhgRoLtQTr%2F7Bphd7L9cS3xD3tluxbgkcaFr7NQVrfWJuQKp%2BFrabo6xZr%2FRHZRd%2FijALuUYYjXH92n4VFwSXSO%2B%2BUBVPoGyWWz1q3QJ2tHNVU7wpc3wtCwwB76pNfGTbJit%2BdylGU8O5UkW3TwSkNnpzepRABM8bBQpgQ%*****");
request.AddParameter("application/json; charset=utf-8", jsonStr, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
copy
url = "http://{domain_name}.com/amsin/api/v1/business/fund/inquiryAvailableCalendar"
headers = {
        "client-id": "*****",
        "request-time": "2022-05-17T11:19:20+08:00",
        "Content-Type": "application/json",
        "signature": "algorithm=RSA256,keyVersion=1,signature=RckSOIrxy%2FKqC%2FZQOO0t74U9U4TFVYKmW%2FZflFRut7W1hipos3NLBGdpzbulcc5Q7XwZP1t3qgTZMFrC%2FlzOQCOsBhUgelvEAuACu49PEGiAus8sU%2FFJa1HOIUmst3oWjLT%2BDqY083mR7jVwc5O2JYP08wNCLu55PFZtXHBUfwEAYoZInhgRoLtQTr%2F7Bphd7L9cS3xD3tluxbgkcaFr7NQVrfWJuQKp%2BFrabo6xZr%2FRHZRd%2FijALuUYYjXH92n4VFwSXSO%2B%2BUBVPoGyWWz1q3QJ2tHNVU7wpc3wtCwwB76pNfGTbJit%2BdylGU8O5UkW3TwSkNnpzepRABM8bBQpgQ%*****"
    }
datas = {"currencyList":["EUR","USD"],"beginDate":"20220811","endDate":"20220911"}
res = requests.post(url=url, data=json.dumps(datas), headers=headers)
copy
CloseableHttpClient client = HttpClientBuilder.create().build();
HttpPost httpPost = new HttpPost("http://{domain_name}.com/amsin/api/v1/business/fund/inquiryAvailableCalendar");
httpPost.addHeader("client-id", "******");
httpPost.addHeader("request-time", "2022-05-17T11:19:20+08:00");
httpPost.addHeader("signature","algorithm=RSA256,keyVersion=1,signature=RckSOIrxy%2FKqC%2FZQOO0t74U9U4TFVYKmW%2FZflFRut7W1hipos3NLBGdpzbulcc5Q7XwZP1t3qgTZMFrC%2FlzOQCOsBhUgelvEAuACu49PEGiAus8sU%2FFJa1HOIUmst3oWjLT%2BDqY083mR7jVwc5O2JYP08wNCLu55PFZtXHBUfwEAYoZInhgRoLtQTr%2F7Bphd7L9cS3xD3tluxbgkcaFr7NQVrfWJuQKp%2BFrabo6xZr%2FRHZRd%2FijALuUYYjXH92n4VFwSXSO%2B%2BUBVPoGyWWz1q3QJ2tHNVU7wpc3wtCwwB76pNfGTbJit%2BdylGU8O5UkW3TwSkNnpzepRABM8bBQpgQ%*****" );
httpPost.addHeader("Content-Type","application/json");
StringEntity entity = new StringEntity("{\"currencyList\":[\"EUR\",\"USD\"],\"beginDate\":\"20220811\",\"endDate\":\"20220911\"}");
httpPost.setEntity(entity);
CloseableHttpResponse response = client.execute(httpPost);
copy
var xhr = new XMLHttpRequest;
xhr.open("POST","http://{domain_name}.com/amsin/api/v1/business/fund/inquiryAvailableCalendar",true)
xhr.setRequestHeader("client-id","*****");
xhr.setRequestHeader("request-time","2022-05-17T11:19:20+08:00");
xhr.setRequestHeader("Content-Type","application/json");
xhr.setRequestHeader("signature","algorithm=RSA256,keyVersion=1,signature=RckSOIrxy%2FKqC%2FZQOO0t74U9U4TFVYKmW%2FZflFRut7W1hipos3NLBGdpzbulcc5Q7XwZP1t3qgTZMFrC%2FlzOQCOsBhUgelvEAuACu49PEGiAus8sU%2FFJa1HOIUmst3oWjLT%2BDqY083mR7jVwc5O2JYP08wNCLu55PFZtXHBUfwEAYoZInhgRoLtQTr%2F7Bphd7L9cS3xD3tluxbgkcaFr7NQVrfWJuQKp%2BFrabo6xZr%2FRHZRd%2FijALuUYYjXH92n4VFwSXSO%2B%2BUBVPoGyWWz1q3QJ2tHNVU7wpc3wtCwwB76pNfGTbJit%2BdylGU8O5UkW3TwSkNnpzepRABM8bBQpgQ%*****");
xhr.send("{\"currencyList\":[\"EUR\",\"USD\"],\"beginDate\":\"20220811\",\"endDate\":\"20220911\"}");

响应

响应体范例

copy
{
    "availableDates": [
        "20230411",
        "20230412",
        "20230413"
    ],
    "responseId": "06030b7a1681129441527187221786",
    "result": {
        "resultStatus": "S",
        "resultCode": "SUCCESS",
        "resultMessage": "success."
    }
}

@2024 WorldFirst