Retrieve statement listsSignature required

2024-04-28 06:07

POST /amsin/api/v1/business/account/inquiryStatementList

Call this API to obtain transaction 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	`Client-Id: *****`	For more information about these request header fields, see Request header.
Signature	Yes	`Signature: algorithm=RSA256, keyVersion=2, signature=*****`
Content-Type	Yes	`Content-Type: application/json; charset=UTF-8`
Request-Time	Yes	`Request-Time: 2019-04-04T12:08:56+08:00`
Connected-CustomerId	Conditional	`Connected-CustomerId: *****`	Attention to this field Required when a partner manages a customer's account.
Access-Token	Conditional	`Access-Token: ******`	Attention to this field Required for OAUTH authorization.

Request parameters

startTime Datetime REQUIRED

The starting time of the queried transaction records.

The time interval between startTime and endTime cannot be more than 3 months (equivalent to 100 days).

More information about this field

The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".

endTime Datetime REQUIRED

The ending time of the queried transaction records.

The time interval between startTime and endTime cannot be more than 3 months (equivalent to 100 days).

More information about this field

The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".

transactionTypeList Array<String>

Indicates the type of transaction that this API requests.

For example: TRANSFER, COLLECTION, and etc. For the full list, refer to the transactionType.

When you do not use this field, WorldFirst returns all available types of transactions.

currencyList Array<String>

A list containing 3-character ISO-4217 currency codes representing the currency that the Partner queries. Supported currencies: USD, EUR, GBP, CAD, JPY, AUD, HKD, SGD, NZD, CNY, CHF, AED, SEK, PLN, CZK, MXN.

When you do not use this parameter, WorldFirst returns transactions in all currencies.

balanceTypes Array<String>

Indicates different balance types.

Customers can use different types of balances to manage their funds separately to meet specific business needs and achieve better risk control.

Valid values are:

NORMAL_BALANCE: indicates the e-commerce balance.
SAME_NAME_TOP_UP_BALANCE: indicates the samename funds.

NORMAL_BALANCE is the default value when this parameter is not specified.

pageSize Integer REQUIRED

Indicates the number of items on each page.

More information about this field

Value range: 10 (fixed value)

pageNumber Integer REQUIRED

Indicates the current page index that contains statement information. Format: 1,2,3,...

More information about this field

Value range: 0-50 (inclusive)

Response parameters

result Result object REQUIRED

Indicates whether this API is called successfully.

Show child parameters

responseId String REQUIRED

The unique ID that is assigned by WorldFirst to identify a response.

This field is returned only when the value of result.resultStatus is S.

More information about this field

Maximum length: 32 characters

statementList Array<Statement> object REQUIRED

List of statements.

This field is returned only when the value of result.resultStatus is S.

Show child parameters

totalCount Integer REQUIRED

The total number of items in the query.

This field is returned only when the value of result.resultStatus is S.

totalPageNumber Integer REQUIRED

Number of the pages in total.

This field is returned only when the value of result.resultStatus is S.

currentPageNumber Integer REQUIRED

The currency page index number.

This field is returned only when the value of result.resultStatus is S.

API Explorer

Request

URL

Request Body

Response

Case

When transactionTypeList is COLLECTION

Response Body

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 `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 WorldFirst Technical Support.

System-related result codes

Code	Value	Message	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 `POST`.

Business-related result codes

Code	Value	Message	Further action
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.
AUTHORIZATION_NOT_EXIST	F	The authorization does not exist.	Make sure that the input is correct. If the issue persists, contact our Technical Support Team to verify the authorization status.
ACCESS_TOKEN_EXPIRED	F	The access token expired.	Refresh token to get a new access token or contact out Technical Support Team to address it.