Retrieve statement lists
POST: /amsin/api/v1/business/account/inquiryStatementList
The Partner can use this API to obtain information with regard to statements.
Structure
A message consists of a header and body. For details, see the following sections.
Request header
Field | Required | Sample | Description |
Client-Id | Yes |
| For more information about these request header fields, see Request header. |
Signature | Yes |
| |
Content-Type | Yes |
| |
Request-Time | Yes |
| |
Connected-CustomerId | Conditional |
| Required when a partner manages a customer's account. |
Request parameters
Field | Data type | Required | Description |
startTime | Datetime object | Yes | Indicates the starting time of the transaction record. Note:
|
endTime | Datetime object | Yes | Indicates the ending time of the transaction record. Note:
|
transactionTypeList | Array<String> | No | Indicates the type of transaction that this API requests. Note:
Possible values include:
For the full list, refer to the transactionType. |
currencyList | Array<String> | No | A list containing 3-character ISO-4217 currency codes representing the currency that the Partner queries. Currently supported currencies: Note:
|
pageSize | Integer | Yes | Defines the number of items on each page. |
pageNumber | Integer | Yes | Defines the page index that contains statement information. Format: 1,2,3,... |
Response parameters
Result processing logic
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 |
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:
If none of the queries is successful, contact WorldFirst Technical Support. |
Result codes
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. |
OAUTH_FAIL | F | OAuth process failed. | Contact our Technical Support Team for detailed reasons. |
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 |
Business-related result codes
resultCode | resultStatus | resultMessage | Further action |
INVALID_ACCESS_TOKEN | F | Invalid access token | Check whether the accessToken is correct. |
USER_NOT_EXIST | F | The user does not exist. | Retry with the correct user information. |
SYSTEM_ERROR | F | System error. | Do not retry, and contact our Technical Support Team for more details. |
SERVICE_NOT_ALLOWED | F | Service not allowed | Retry with the correct information. If the issue persists, contact our Technical Support Team. |
CURRENCY_NOT_SUPPORT | F | The currency is not supported. | Make sure the currency input is correct and try again. |
CONTRACT_CHECK_FAIL | F | The contract check has failed. | Check the contract status before retrying. |
Samples
Request
Request body sample
copy
{
"startTime": "2022-01-01T00:00:00Z",
"endTime": "2022-01-01T00:00:00Z",
"pageSize" : 20,
"pageNumber": 1,
"transactionTypeList":["TRANSFER_REFUND", "WITHDRAWAL_REFUND"],
"currencyList": ["HKD", "USD", "EUR"]
}Request calling samples
copy
var jsonStr="{\"startTime\":\"2022-01-01T00:00:00Z\",\"endTime\":\"2022-01-01T00:00:00Z\",\"pageSize\":20,\"pageNumber\":1,\"transactionTypeList\":[\"TRANSFER_REFUND\",\"WITHDRAWAL_REFUND\"],\"currencyList\":[\"HKD\",\"USD\",\"EUR\"]}";
var client = new RestClient("http://{domain_name}.com/amsin/api/v1/business/account/inquiryStatementList");
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...*****");
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/account/inquiryStatementList"
headers = {
"client-id": "*****",
"request-time": "2022-05-17T11:19:20+08:00",
"Content-Type": "application/json",
"signature": "algorithm=RSA256,keyVersion=1,signature=RckSOIrxy...*****"
}
datas ={"startTime":"2022-01-01T00:00:00Z","endTime":"2022-01-01T00:00:00Z","pageSize":20,"pageNumber":1,"transactionTypeList":["TRANSFER_REFUND","WITHDRAWAL_REFUND"],"currencyList":["HKD","USD","EUR"]}
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/account/inquiryStatementList");
httpPost.addHeader("client-id", "*****");
httpPost.addHeader("request-time", "2022-05-17T11:19:20+08:00");
httpPost.addHeader("signature","algorithm=RSA256,keyVersion=1,signature=RckSOIrxy...*****" );
httpPost.addHeader("Content-Type","application/json");
StringEntity entity = new StringEntity("{\"startTime\":\"2022-01-01T00:00:00Z\",\"endTime\":\"2022-01-01T00:00:00Z\",\"pageSize\":20,\"pageNumber\":1,\"transactionTypeList\":[\"TRANSFER_REFUND\",\"WITHDRAWAL_REFUND\"],\"currencyList\":[\"HKD\",\"USD\",\"EUR\"]}");
httpPost.setEntity(entity);
CloseableHttpResponse response = client.execute(httpPost);copy
var xhr = new XMLHttpRequest;
xhr.open("POST","http://{domain_name}.com/amsin/api/v1/business/account/inquiryStatementList";,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...*****");
xhr.send"{\"startTime\":\"2022-01-01T00:00:00Z\",\"endTime\":\"2022-01-01T00:00:00Z\",\"pageSize\":20,\"pageNumber\":1,\"transactionTypeList\":[\"TRANSFER_REFUND\",\"WITHDRAWAL_REFUND\"],\"currencyList\":[\"HKD\",\"USD\",\"EUR\"]}";Response
Response body sample
When the value of transactionType is COLLECTION
copy
{
"currentPageNumber": 1,
"responseId": "****",
"result": {
"resultCode": "SUCCESS",
"resultMessage": "success",
"resultStatus": "S"
},
"statementList": [
{
"accountBalance": {
"currency": "GBP",
"value": 999983820016
},
"fundMoveDetail": {
"beneficiaryAccountNo": "****@****.***",
"beneficiaryAccountType": "WORLDFIRST",
"beneficiaryBankName": "****",
"payerAccountNo": "****",
"payerAccountType": "BANK_CARD",
"payerName": "****",
"receiveAccount": "****",
"remarks": "****"
},
"originalTransactionAmount": {
"currency": "GBP",
"value": 2999
},
"transactionAmount": {
"currency": "GBP",
"value": 2999
},
"transactionId": "****",
"transactionStatus": "SUCCESS",
"transactionTime": "2022-10-18T06:36:35Z",
"transactionType": "COLLECTION"
},
{
"accountBalance": {
"currency": "USD",
"value": 999999
},
"fundMoveDetail": {
"beneficiaryAccountNo": "****@****.***",
"beneficiaryAccountType": "WORLDFIRST",
"beneficiaryBankName": "****",
"payerAccountNo": "****",
"payerAccountType": "BANK_CARD",
"payerName": "",
"receiveAccount": "****",
"remarks": "****"
},
"originalTransactionAmount": {
"currency": "USD",
"value": 2999
},
"transactionAmount": {
"currency": "USD",
"value": 2999
},
"transactionId": "****",
"transactionStatus": "SUCCESS",
"transactionTime": "2022-10-18T06:22:03Z",
"transactionType": "COLLECTION"
}
],
"totalCount": 3219,
"totalPageNumber": 1610
}When the value of transactionType is TRANSFER
copy
{
"currentPageNumber": 1,
"responseId": "****",
"result": {
"resultCode": "SUCCESS",
"resultMessage": "success",
"resultStatus": "S"
},
"statementList": [
{
"accountBalance": {
"currency": "GBP",
"value": 999999
},
"extTransactionId": "****",
"feeAmount": {
"currency": "GBP",
"value": 93
},
"foreignExchangeQuote": {
"quotePrice": "1.33707",
"transferFromCurrency": "GBP",
"transferToCurrency": "USD"
},
"fundMoveDetail": {
"beneficiaryAccountNo": "****",
"beneficiaryAccountType": "BANK_CARD",
"beneficiaryBankCountry": "US",
"beneficiaryBankName": "BANK OF ***",
"beneficiaryName": "****",
"payerAccountNo": "****",
"payerAccountType": "WORLDFIRST"
},
"originalTransactionAmount": {
"currency": "GBP",
"value": 205
},
"transactionAmount": {
"currency": "GBP",
"value": -112
},
"transactionId": "****",
"transactionStatus": "SUCCESS",
"transactionTime": "2022-10-17T15:45:10Z",
"transactionType": "TRANSFER"
},
{
"accountBalance": {
"currency": "USD",
"value": 999999999
},
"extTransactionId": "****",
"feeAmount": {
"currency": "USD",
"value": 125
},
"foreignExchangeQuote": {
"quotePrice": "1",
"transferFromCurrency": "USD",
"transferToCurrency": "USD"
},
"fundMoveDetail": {
"beneficiaryAccountNo": "****",
"beneficiaryAccountType": "BANK_CARD",
"beneficiaryBankCountry": "HK",
"beneficiaryBankName": "*** BANKING CORPORATION LIMITED",
"beneficiaryName": "****",
"payerAccountNo": "****",
"payerAccountType": "WORLDFIRST"
},
"originalTransactionAmount": {
"currency": "USD",
"value": 10000
},
"transactionAmount": {
"currency": "USD",
"value": -9875
},
"transactionId": "****",
"transactionStatus": "SUCCESS",
"transactionTime": "2022-10-17T15:45:10Z",
"transactionType": "TRANSFER"
}
],
"totalCount": 517,
"totalPageNumber": 259
}For other transactionType values
copy
{
"currentPageNumber": 1,
"responseId": "*****",
"result": {
"resultCode": "SUCCESS",
"resultMessage": "success.",
"resultStatus": "S"
},
"statementList": [
{
"accountBalance": {
"currency": "HKD",
"value": 698450
},
"extTransactionId": "*****",
"feeAmount": {
"currency": "EUR",
"value": 0
},
"fundMoveDetail": {
"beneficiaryAccountNo": "*****",
"beneficiaryAccountType": "ALIPAY",
"beneficiaryBankCountry": "",
"beneficiaryName": "",
"payerAccountType": "ALIPAY",
"payerName": ""
},
"originalTransactionAmount": {
"currency": "HKD",
"value": 112226
},
"refundForeignExchangeQuote": {
"quotePrice": "1",
"transferFromCurrency": "HKD",
"transferToCurrency": "HKD"
},
"transactionAmount": {
"currency": "HKD",
"value": 112226
},
"transactionId": "*****",
"transactionStatus": "SUCCESS",
"transactionTime": "2022-01-01T00:00:00Z",
"transactionType": "TRANSFER_REFUND"
},
{
"accountBalance": {
"currency": "HKD",
"value": 586224
},
"extTransactionId": "*****",
"feeAmount": {
"currency": "EUR",
"value": 0
},
"fundMoveDetail": {
"beneficiaryAccountNo": "*****",
"beneficiaryAccountType": "ALIPAY",
"beneficiaryBankCountry": "",
"beneficiaryName": "",
"payerAccountType": "ALIPAY",
"payerName": ""
},
"originalTransactionAmount": {
"currency": "HKD",
"value": 112226
},
"refundForeignExchangeQuote": {
"quotePrice": "1",
"transferFromCurrency": "HKD",
"transferToCurrency": "HKD"
},
"transactionAmount": {
"currency": "HKD",
"value": 112226
},
"transactionId": "*****",
"transactionStatus": "SUCCESS",
"transactionTime": "2022-01-01T00:00:00Z",
"transactionType": "TRANSFER_REFUND"
},
{
"accountBalance": {
"currency": "HKD",
"value": 473998
},
"extTransactionId": "*****",
"feeAmount": {
"currency": "EUR",
"value": 0
},
"fundMoveDetail": {
"beneficiaryAccountNo": "*****",
"beneficiaryAccountType": "ALIPAY",
"beneficiaryBankCountry": "",
"beneficiaryName": "",
"payerAccountType": "ALIPAY",
"payerName": ""
},
"originalTransactionAmount": {
"currency": "HKD",
"value": 120859
},
"refundForeignExchangeQuote": {
"quotePrice": "1",
"transferFromCurrency": "HKD",
"transferToCurrency": "HKD"
},
"transactionAmount": {
"currency": "HKD",
"value": 120859
},
"transactionId": "*****",
"transactionStatus": "SUCCESS",
"transactionTime": "2022-01-01T00:00:00Z",
"transactionType": "TRANSFER_REFUND"
},
{
"accountBalance": {
"currency": "HKD",
"value": 353139
},
"extTransactionId": "*****",
"feeAmount": {
"currency": "EUR",
"value": 0
},
"fundMoveDetail": {
"beneficiaryAccountNo": "*****",
"beneficiaryAccountType": "ALIPAY",
"beneficiaryBankCountry": "",
"beneficiaryName": "",
"payerAccountType": "ALIPAY",
"payerName": ""
},
"originalTransactionAmount": {
"currency": "HKD",
"value": 103594
},
"refundForeignExchangeQuote": {
"quotePrice": "1",
"transferFromCurrency": "HKD",
"transferToCurrency": "HKD"
},
"transactionAmount": {
"currency": "HKD",
"value": 103594
},
"transactionId": "*****",
"transactionStatus": "SUCCESS",
"transactionTime": "2022-01-01T00:00:00Z",
"transactionType": "TRANSFER_REFUND"
},
{
"accountBalance": {
"currency": "USD",
"value": 289633970
},
"extTransactionId": "*****",
"feeAmount": {
"currency": "EUR",
"value": 0
},
"fundMoveDetail": {
"beneficiaryAccountNo": "*****",
"beneficiaryAccountType": "ALIPAY",
"beneficiaryBankCountry": "",
"beneficiaryName": "",
"payerAccountType": "ALIPAY",
"payerName": ""
},
"originalTransactionAmount": {
"currency": "USD",
"value": 133056
},
"refundForeignExchangeQuote": {
"quotePrice": "1",
"transferFromCurrency": "USD",
"transferToCurrency": "USD"
},
"transactionAmount": {
"currency": "USD",
"value": 133056
},
"transactionId": "*****",
"transactionStatus": "SUCCESS",
"transactionTime": "2022-01-01T00:00:00Z",
"transactionType": "TRANSFER_REFUND"
},
{
"accountBalance": {
"currency": "HKD",
"value": 249545
},
"extTransactionId": "*****",
"feeAmount": {
"currency": "USD",
"value": 0
},
"fundMoveDetail": {
"beneficiaryAccountNo": "*****",
"beneficiaryAccountType": "ALIPAY",
"beneficiaryBankCountry": "",
"beneficiaryName": "",
"payerAccountType": "ALIPAY",
"payerName": ""
},
"originalTransactionAmount": {
"currency": "HKD",
"value": 131400
},
"refundForeignExchangeQuote": {
"quotePrice": "1",
"transferFromCurrency": "HKD",
"transferToCurrency": "HKD"
},
"transactionAmount": {
"currency": "HKD",
"value": 131400
},
"transactionId": "*****",
"transactionStatus": "SUCCESS",
"transactionTime": "2022-01-01T00:00:00Z",
"transactionType": "TRANSFER_REFUND"
},
{
"accountBalance": {
"currency": "HKD",
"value": 118145
},
"extTransactionId": "*****",
"feeAmount": {
"currency": "CNH",
"value": 0
},
"fundMoveDetail": {
"beneficiaryAccountNo": "*****",
"beneficiaryAccountType": "ALIPAY",
"beneficiaryBankCountry": "",
"beneficiaryName": "",
"payerAccountType": "ALIPAY",
"payerName": ""
},
"originalTransactionAmount": {
"currency": "HKD",
"value": 1102
},
"refundForeignExchangeQuote": {
"quotePrice": "1",
"transferFromCurrency": "HKD",
"transferToCurrency": "HKD"
},
"transactionAmount": {
"currency": "HKD",
"value": 1102
},
"transactionId": "*****",
"transactionStatus": "SUCCESS",
"transactionTime": "2022-01-01T00:00:00Z",
"transactionType": "TRANSFER_REFUND"
},
{
"accountBalance": {
"currency": "HKD",
"value": 117043
},
"extTransactionId": "*****",
"feeAmount": {
"currency": "CNH",
"value": 0
},
"fundMoveDetail": {
"beneficiaryAccountNo": "*****",
"beneficiaryAccountType": "ALIPAY",
"beneficiaryBankCountry": "",
"beneficiaryName": "",
"payerAccountType": "ALIPAY",
"payerName": ""
},
"originalTransactionAmount": {
"currency": "HKD",
"value": 1102
},
"refundForeignExchangeQuote": {
"quotePrice": "1",
"transferFromCurrency": "HKD",
"transferToCurrency": "HKD"
},
"transactionAmount": {
"currency": "HKD",
"value": 1102
},
"transactionId": "*****",
"transactionStatus": "SUCCESS",
"transactionTime": "2022-01-01T00:00:00Z",
"transactionType": "TRANSFER_REFUND"
},
{
"accountBalance": {
"currency": "USD",
"value": 289517914
},
"extTransactionId": "*****",
"feeAmount": {
"currency": "EUR",
"value": 0
},
"fundMoveDetail": {
"beneficiaryAccountNo": "*****",
"beneficiaryAccountType": "ALIPAY",
"beneficiaryBankCountry": "",
"beneficiaryName": "",
"payerAccountType": "ALIPAY",
"payerName": ""
},
"originalTransactionAmount": {
"currency": "USD",
"value": 121968
},
"refundForeignExchangeQuote": {
"quotePrice": "1",
"transferFromCurrency": "USD",
"transferToCurrency": "USD"
},
"transactionAmount": {
"currency": "USD",
"value": 121968
},
"transactionId": "*****",
"transactionStatus": "SUCCESS",
"transactionTime": "2022-01-01T00:00:00Z",
"transactionType": "TRANSFER_REFUND"
},
{
"accountBalance": {
"currency": "HKD",
"value": 115941
},
"extTransactionId": "*****",
"feeAmount": {
"currency": "USD",
"value": 0
},
"fundMoveDetail": {
"beneficiaryAccountNo": "*****",
"beneficiaryAccountType": "ALIPAY",
"beneficiaryBankCountry": "",
"beneficiaryName": "",
"payerAccountType": "ALIPAY",
"payerName": ""
},
"originalTransactionAmount": {
"currency": "HKD",
"value": 115941
},
"refundForeignExchangeQuote": {
"quotePrice": "1",
"transferFromCurrency": "HKD",
"transferToCurrency": "HKD"
},
"transactionAmount": {
"currency": "HKD",
"value": 115941
},
"transactionId": "*****",
"transactionStatus": "SUCCESS",
"transactionTime": "2022-01-01T00:00:00Z",
"transactionType": "TRANSFER_REFUND"
},
{
"accountBalance": {
"currency": "EUR",
"value": 330033371
},
"extTransactionId": "*****",
"feeAmount": {
"currency": "EUR",
"value": 2706
},
"fundMoveDetail": {
"beneficiaryAccountNo": "*****",
"beneficiaryAccountType": "BANK_CARD",
"beneficiaryBankCountry": "HK",
"beneficiaryName": "x***y",
"payerAccountNo": "*****",
"payerAccountType": "ALIPAY",
"payerName": "",
"remarks": "Memo_for_the_transfer"
},
"originalTransactionAmount": {
"currency": "EUR",
"value": 125000
},
"refundForeignExchangeQuote": {
"quotePrice": "1",
"transferFromCurrency": "EUR",
"transferToCurrency": "EUR"
},
"transactionAmount": {
"currency": "EUR",
"value": 122294
},
"transactionId": "*****",
"transactionStatus": "SUCCESS",
"transactionTime": "2022-01-01T00:00:00Z",
"transactionType": "TRANSFER_REFUND"
},
{
"accountBalance": {
"currency": "USD",
"value": 289748446
},
"extTransactionId": "*****",
"feeAmount": {
"currency": "USD",
"value": 3000
},
"fundMoveDetail": {
"beneficiaryAccountNo": "******",
"beneficiaryAccountType": "BANK_CARD",
"beneficiaryBankCountry": "HK",
"beneficiaryName": "x***y",
"payerAccountNo": "*****",
"payerAccountType": "ALIPAY",
"payerName": "",
"remarks": "Memo_for_the_transfer"
},
"originalTransactionAmount": {
"currency": "USD",
"value": 33000
},
"refundForeignExchangeQuote": {
"quotePrice": "1",
"transferFromCurrency": "USD",
"transferToCurrency": "USD"
},
"transactionAmount": {
"currency": "USD",
"value": 30000
},
"transactionId": "*****",
"transactionStatus": "SUCCESS",
"transactionTime": "2022-01-01T00:00:00Z",
"transactionType": "TRANSFER_REFUND"
},
{
"accountBalance": {
"currency": "USD",
"value": 289751446
},
"extTransactionId": "*****",
"feeAmount": {
"currency": "USD",
"value": 3000
},
"fundMoveDetail": {
"beneficiaryAccountNo": "*****",
"beneficiaryAccountType": "BANK_CARD",
"beneficiaryBankCountry": "HK",
"beneficiaryName": "x***y",
"payerAccountNo": "*****",
"payerAccountType": "ALIPAY",
"payerName": "",
"remarks": "Memo_for_the_transfer"
},
"originalTransactionAmount": {
"currency": "USD",
"value": 33000
},
"refundForeignExchangeQuote": {
"quotePrice": "1",
"transferFromCurrency": "USD",
"transferToCurrency": "USD"
},
"transactionAmount": {
"currency": "USD",
"value": 30000
},
"transactionId": "*****",
"transactionStatus": "SUCCESS",
"transactionTime": "2022-01-01T00:00:00Z",
"transactionType": "TRANSFER_REFUND"
},
{
"accountBalance": {
"currency": "USD",
"value": 289751446
},
"extTransactionId": "*****",
"feeAmount": {
"currency": "USD",
"value": 3000
},
"fundMoveDetail": {
"beneficiaryAccountNo": "*****",
"beneficiaryAccountType": "BANK_CARD",
"beneficiaryBankCountry": "HK",
"beneficiaryName": "ABC_name",
"payerAccountNo": "*****",
"payerAccountType": "ALIPAY",
"payerName": "",
"remarks": "Memo_for_the_transfer"
},
"originalTransactionAmount": {
"currency": "USD",
"value": 23000
},
"refundForeignExchangeQuote": {
"quotePrice": "1",
"transferFromCurrency": "USD",
"transferToCurrency": "USD"
},
"transactionAmount": {
"currency": "USD",
"value": 20000
},
"transactionId": "*****",
"transactionStatus": "SUCCESS",
"transactionTime": "2022-01-01T00:00:00Z",
"transactionType": "TRANSFER_REFUND"
}
],
"totalCount": 14,
"totalPageNumber": 1
}