WorldFirst DocsWorldFirst DocsDOCS

Query statement detailSignature required

POST /amsin/api/v1/business/account/inquiryStatementDetail

Call this API to query the detailed information of a statement.

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

Required when a partner manages a customer's account.

Access-Token

Conditional

Access-Token: ******

Attention

Required for OAuth Authorization.


Request parameters

accountingBizNo String  REQUIRED

The unique ID used to identify a change in WorldFirst balance. This ID relates to a specific transaction.

To obtain this value, call the inquiryStatementList API.

Response parameters

result Result  REQUIRED

Indicates whether the API call is successful.

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:

  • Maximum length: 32 characters

transactionId String  REQUIRED

The unique ID assigned by WorldFirst to identify a transaction. A transaction ID might have multiple related balance change IDs.

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

This field is required when the value of transactionType is one of the following values:

  • TRANSFER
  • TRANSFER_REFUND
  • WITHDRAWAL
  • WITHDRAWAL_REFUND
  • CONVERSION
  • CONVERSION_DEAL
  • CHARGE
  • CHARGE_REFUND
  • DEDUCTION
  • FUND_COLLECTION

More information:

  • Maximum length: 64 characters

extTransactionId String  

The unique ID assigned by the Partner to identify a transaction.

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

More information:

  • Maximum length: 256 characters

transactionStatus String  REQUIRED

The status of the balance change.

Valid values are:

  • INIT: The order has been initiated.
  • PROCESSING: The order is being processed.
  • PENDING: The order is pending.
  • SUCCESS: The order has been processed successfully.
  • FAIL: The order processing failed.
  • REFUNDED: The order has been refunded.

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

transactionTime DateTime  REQUIRED

The time when the WorldFirst balance change occurs.

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

More information:

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

transactionType String  REQUIRED

The type of the balance change.

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

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

transactionAmount Amount  REQUIRED

 The amount of the balance change.

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

Show child parameters

originalTransactionAmount Amount  REQUIRED

The transaction amount originally submitted.

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

Show child parameters

feeAmount Amount  REQUIRED

The amount of the service fee.

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

This field is conditionally optional when the value of transactionType is one of the following:

  • TRANSFER
  • TRANSFER_REFUND
  • WITHDRAWAL
  • WITHDRAWAL_REFUND
  • CONVERSION
  • CONVERSION_DEAL
  • CHARGE
  • CHARGE_REFUND
  • DEDUCTION
  • FUND_COLLECTION
Show child parameters

netAmount Amount  REQUIRED

The net amount received after deducting the fees handled by WorldFirst during the transaction.

Formula: netAmount=originalTransactionAmount-feeAmount

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

This field is required when transactionType is one of the following:

  • TRANSFER
  • CHARGE
  • PAYMENT
  • CASH_BACK
Show child parameters

receiveAmount Amount  REQUIRED

The final amount received after currency conversion. 

Formula: receiveAmount=netAmount*foreignExchangeQuote.quotePrice

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

This field is required when transactionType is one of the following:

  • TRANSFER
  • CHARGE
  • PAYMENT
  • CASH_BACK
Show child parameters

accountBalance Amount  REQUIRED

The account balance in real time after the transaction.

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

Show child parameters

fundMoveDetail FundMoveDetail  REQUIRED

The fund flow details, such as the payer and beneficiary information.

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

Show child parameters

foreignExchangeQuote Quote  

Information about quotes for transfer.

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

This field is optional when the value of transactionType is one of the following:

  • TRANSFER
  • WITHDRAWAL
  • CONVERSION
  • CONVERSION_DEAL
  • CHARGE
Show child parameters

refundForeignExchangeQuote Quote  CONDITIONAL

Information about quotes for transfer refunds.

This field is optional when the value of transactionType is one of the following:

  • TRANSFER_REFUND
  • WITHDRAWAL_REFUND
  • CHARGE_REFUND
Show child parameters

balanceType 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 same-name funds.

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

When unspecified, this parameter defaults to ​NORMAL_BALANCE​.

accountingBizNo String  REQUIRED

The unique ID used to identify a change in WorldFirst balance. This ID is also related to a specific transaction.

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

failReason Result  CONDITIONAL

The failure reason.

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

This parameter is returned when transactionStatus is ​FAIL​.

Show child parameters

combinedTransactionList RelatedStatement  REQUIRED

The information of the related transactions. This parameter may return multiple balance changes that share the same transaction ID or multiple transactions that have different transaction IDs.

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

Show child parameters

operatorInfo OperatorInfo  CONDITIONAL

Information of the person who initiates the transactions.

This parameter is only returned when the transaction is initiated on the WF portal. 

Show child parameters

goodsName String  

The goods name. 

goodsAmount Amount  

The goods amount. 

Show child parameters

platformFeeAmount Amount  

The fee charged by the third-party platform. 

Show child parameters
API Explorer

Request

URL
Request Body

Response

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. The partner can make a query when the returned status is UNKNOWN. Use the following query strategy:

  • A partner can make up to 7 queries.
  • Intervals between queries: 5 min, 10 min, 20 min, 40 min, 80 min, 160 min, and 320 min.

If none of the queries are successful, contact WorldFirst Technical Support.

result.resultCode

CodeValueMessageFurther action
SUCCESSSSuccess
PARAM_ILLEGALFIllegal 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_FAILFA 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_EXCEPTIONUAPI failed due to unknown reason.

The service might be down, retry later. If the issue persists, contact our Technical Support Team.

REQUEST_TRAFFIC_EXCEED_LIMITUThe request traffic exceeds the limit.

Call the interface again to resolve the issue. If the issue persists, contact our Technical Support Team.

OAUTH_FAILFOAuth process failed.

Contact our Technical Support Team for detailed reasons.

INVALID_APIFThe called API is invalid or not active.

Check whether the correct API is being called.

INVALID_CLIENTFThe client is invalid.

The Client ID does not exist or is invalid.

INVALID_SIGNATUREFThe signature is invalid.

Make sure the request is properly signed with a valid signature.

METHOD_NOT_SUPPORTEDFThe server does not implement the requested HTTP method.

Ensure the HTTP method is ​POST​.

USER_NOT_EXISTFThe user does not exist.

Retry with the correct user information.

SYSTEM_ERRORFSystem error.

Do not retry, and contact our Technical Support Team for more details.

SERVICE_NOT_ALLOWEDFService not allowed

Retry with the correct information. If the issue persists, contact our Technical Support Team.

CURRENCY_NOT_SUPPORTFThe currency is not supported.

Make sure the currency input is correct and try again.

CONTRACT_CHECK_FAILFThe contract check has failed.

Check the contract status before retrying.

AUTHORIZATION_NOT_EXISTFThe 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_EXPIREDFThe access token expired.

Refresh token to get a new access token or contact out Technical Support Team.

failReason.resultCode

CodeValueMessageFurther action
CURRENCY_NOT_SUPPORTFThe currency is not supported.

Make sure the currency is correct and retry.

CARD_INFO_NOT_MATCHFThe card information does not match.

Retry with the correct card information.

ORDER_IS_REVERSEDFThe order is reversed.

Retry with another transfer order.

ORDER_IS_CLOSEDFThe order is closed.

Retry with another transfer order.

AMOUNT_EXCEED_LIMITFThe amount exceeds the limit.

Make sure the amount submitted is correct and retry.

RISK_REJECTFThe transfer is rejected for risk control reasons.

Prompt the user that the request is rejected because the risk control failed.

BALANCE_NOT_ENOUGHFBalance is not enough.

Make sure the balance is sufficient and retry.

@2024 WorldFirst