Check an FX forward deal status

2022-11-15 07:14

POST: /amsin/api/v1/business/fund/inquiryDeal Signature required

The Partner can use this API to inquire about a forward deal.

Structure

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see:

Request parameters

Field

Data type

Required

Description

dealRequestId

String

Yes

The unique ID that is assigned by the Partner to identify a deal request.

More information:

Maximum length: 64 characters

Response parameters

Field	Data type	Required	Description
result	Result object	Yes	Indicates whether this API is called successfully.
responseId	String	Yes	The unique ID that is assigned by WorldFirst to identify a response. More information: Maximum length: 32 characters
deal	Deal object	Yes	Transaction details of forward deal.
dealResult	Result object	Yes	Indicates the result of the forward deal.

Result processing logic

After calling the API, a response is returned with two result codes, result.resultStatus and dealResult.resultStatus.

result.resultStatus indicates the result of the inquiry.
dealResult.resultStatus indicates the deal result. For more details, refer to the result codes section.

After calling the API, a response is returned. The possible responses for result.resultStatus are:

Result status	Description
S	This indicates the API call succeeded.
F	This indicates the API call failed. For more information on why the call failed, see `result.resultCode`.
U	This indicates the API call result is unknown. Partner can make a query when the returned status is `UNKNOWN`. Use the following query strategy: A Partner can make 7 queries at maximum. Intervals between queries: 5m, 10m, 20m, 40m, 80m, 160m, and 320m. If none of the queries is successful, contact our Technical Support Team.

Result codes

`dealResult.resultCode`

resultCode	resultStatus	resultMessage	Further action
SUCCESS	S	The forward deal is successful.
PROCESSING	S	The forward deal is being processed.
CANCELLED	F	The forward deal is canceled.
FAIL	F	The forward deal has failed.

`result.resultCode`

System-related result codes

resultCode	resultStatus	resultMessage	Further action
SUCCESS	S	Success
PARAM_ILLEGAL	F	Illegal parameters exist. For example, a non-numeric input, or an invalid date.	Check and verify whether the request fields, including the header fields and body fields, are correct and valid. For details on the fields of each API, see the specific API Structure section.
PROCESS_FAIL	F	A general business failure occurred. Do not retry.	Human intervention is usually needed. It is recommended that you contact our Technical Support Team to resolve the issue.
UNKNOWN_EXCEPTION	U	API failed due to unknown reason.	The service might be down, retry later. If the issue persists, contact our Technical Support Team.
REQUEST_TRAFFIC_EXCEED_LIMIT	U	The request traffic exceeds the limit.	Call the interface again to resolve the issue. If the issue persists, contact our Technical Support Team.
INVALID_API	F	The called API is invalid or not active.	Check whether the correct API is being called.
INVALID_CLIENT	F	The client is invalid.	The Client ID does not exist or is invalid.
INVALID_SIGNATURE	F	The signature is invalid.	Make sure the request is properly signed with a valid signature.
METHOD_NOT_SUPPORTED	F	The server does not implement the requested HTTP method.	Ensure the HTTP method is `POST`.

Business-related result codes

resultCode	resultStatus	resultMessage	Further action
UN_SUPPORT_BUSINESS	F	Unsupported business.	Invalid parameters are used e.g. currency is incorrect. Retry with the correct information.
INVALID_ACCESS_TOKEN	F	Invalid access token	Check whether the accessToken is correct.
CONTRACT_CHECK_FAIL	F	The contract check has failed.	Check the contract status before retrying.

Samples

Request

Request body sample

copy
{
    "dealRequestId": "*****"
}

Request calling samples

copy
var jsonStr="{"dealRequestId":"*****"}";
var client = new RestClient("http://{domain_name}.com/amsin/api/v1/business/fund/inquiryDeal");
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/inquiryDeal"
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 = {"dealRequestId":"*****"}
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/inquiryDeal");
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("{\"dealRequestId\":\"*****\"}");
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/inquiryDeal",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("{\"dealRequestId\":\"*****\"}");  

Response

Response body sample

copy
{
    "deal": {
        "buy": {
            "currency": "EUR",
            "value": 588
        },
        "cancelCost": {
            "currency": "USD",
            "value": 416
        },
        "cancelTime": "2022-07-26T09:58:22Z",
        "creditLine": {
            "currency": "USD",
            "value": 0
        },
        "creditLineBase": {
            "currency": "GBP",
            "value": 0
        },
        "dealId": "*****",
        "dealRequestId": "*****",
        "expiredTime": "20220819",
        "forwardType": "WINDOWED",
        "margin": {
            "currency": "USD",
            "value": 50
        },
        "quote": {
            "quoteCurrencyPair": "EUR/USD",
            "quoteExpiryTime": "2022-07-26T11:32:22Z",
            "quoteId": "*****",
            "quotePrice": "1.7",
            "quoteStartTime": "2022-07-26T09:32:22Z"
        },
        "sell": {
            "currency": "USD",
            "value": 1000
        },
        "unSettledBuy": {
            "currency": "EUR",
            "value": 588
        },
        "unSettledSell": {
            "currency": "USD",
            "value": 1000
        },
        "windowStartTime": "20220801"
    },
    "dealResult": {
        "resultCode": "ORDER_IS_CANCELED",
        "resultMessage": "Order is canceled.",
        "resultStatus": "F"
    },
    "responseId": "*****",
    "result": {
        "resultCode": "SUCCESS",
        "resultMessage": "success",
        "resultStatus": "S"
    }
}