Check transfer resultSignature required

2024-11-21 06:55

POST /amsin/api/v1/business/fund/inquiryTransfer

Call this API to query the fund transfer result.

You need to set up a timeout mechanism to stop the polling process, in case no conclusive transfer result is reached.
If you do not receive any notification from WorldFirst two hours after you call the createTransfer API; and meanwhile, if you call the inquiryTransfer API and get UNKNOWN in the transferResult.resultCode, contact our Technical Support Team for help.

Structure

A message consists of a header and body.

Request header parameters

Field	Required	Sample	Description
Client-Id	Yes	`Client-Id: *****`	For detailed field descriptions, see API Overview.
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	No (Conditional)	`Connected-CustomerId: ******`	Attention Required when a partner manages a customer's account.

Request parameters

transferRequestId String REQUIRED

The unique ID assigned by the Partner to identify a transfer request.

More information:

This field is an API idempotency field.For details about API idempotency, see the Idempotency chapter.
Maximum length: 64 characters

Response parameters

result Result REQUIRED

Indicates whether this API is called successfully.

Show child parameters

transferRequestId String REQUIRED

The unique ID assigned by the Partner to identify a transfer request.

This field is returned as needed only when result.resultStatus =S.

More information:

This field is an API idempotency field.For details about API idempotency, see the Idempotency chapter.
Maximum length: 64 characters

transferId String REQUIRED

The unique ID assigned by WorldFirst to identify a transfer.

This field is returned as needed only when result.resultStatus =S.

More information:

Maximum length: 64 characters

businessSceneCode String REQUIRED

The code that represents the transfer business scenario.

Valid values:

MULTI_ACCOUNT_TRANSFER：transfer between your primary account and subaccounts.
ATOMIC_TRANSFER：transfer between WF accounts

transferResult TransferResult REQUIRED

Indicates the result of the transfer request.

This field is returned as needed only when result.resultStatus =S.

Show child parameters

transferFinishTime DateTime

Indicates the finishing time of a transfer.

This field is returned as needed only when result.resultStatus =S.

WorldFirst only returns this field when the Partner makes duplicated transfer requests, indicating the actual finishing time of the transfer.

More information:

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

transferFromDetail TransferFromDetail REQUIRED

Transfer details submitted by the payer.

This field is returned as needed only when result.resultStatus =S.

Show child parameters

transferToDetail TransferToDetail REQUIRED

Transfer details for the beneficiary.

This field is returned as needed only when result.resultStatus =S.

Show child parameters

API Explorer

Request

URL

Request Body

Response

Case

Transfer between WF accounts

Response Body

Result processing logic

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

result.resultStatus indicates the result of the inquiry.
transferResult.resultStatus indicates the result of the transfer.

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 specific reasons, see the result.resultCode table. For other values, refer to the result codes section. If the issue is not resolved, contact our Technical Support Team.
`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.

The possible responses for transferResult.resultStatus are:

result.resultCode: System-realted 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.
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`.

transferResult.resultCode: System-related result codes

Code	Value	Message	Further action
SUCCESS	S	Success
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	Unknown exception	The service might be down, retry later. If the issue persists, contact our Technical Support Team.

transferResult.resultCode: Business-related result codes

Code	Value	Message	Further action
USER_NOT_EXIST	F	The user does not exist.	Retry with the correct user information.
USER_ACCOUNT_ABNORMAL	F	The user account status is abnormal.	Retry with a different user. If the issue persists, contact our Technical Support Team for more details.
AMOUNT_EXCEED_LIMIT	F	The amount exceeds the limit.	Make sure the amount submitted is correct and retry.
RISK_REJECT	F	The transfer is rejected for risk control reasons.	Prompt the user that the request is rejected because the risk control failed.
TRANSFER_IN_PROCESS	U	The transfer is in process.	Try again later.
ORDER_IS_CLOSED	F	The order is closed.	Retry with another transfer order.
ORDER_IS_REVERSED	F	The order is reversed.	Retry with another transfer order.
BALANCE_NOT_ENOUGH	F	Balance is not enough.	Make sure the balance is sufficient and retry.
ORDER_NOT_FOUND	U	Order not found.	Retry with correct order information.

Result status	Description
`S`	This indicates the transfer succeeded. If result.resultStatus is `S`, and transferResult.resultCode is `PROCESSING`, the transfer is being processed.
`F`	This indicates the transfer failed. For more information on why the transfer failed, see the transferResult.resultCode table.
`U`	This indicates the transfer result is unknown. Call the interface again. If the issue is not resolved, contact our Technical Support Team.