inquiryTransferSignature required

2022-04-29 12:00

POST /aps/api/business/transfer/inquiryTransfer

The Partner can use the inquiryTransfer API to query the result of a transfer.

For transfer requests, if the Partner is unable to retrieve the transfer result or does not receive any result in 10 seconds, the Partner can use the inquiryTransfer to make active inquiries. The recommended polling frequency is 2-3 seconds per request 10 to 20 times.
If the Partner receives no notification from the notifyTransferResult API for 2 hours, while the inquiryTransfer API returns transferResult.resultCode as UNKONWN, contact WorldFirst Technical Support Team for help.

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

transferRequestId String REQUIRED

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

More information:

This field is an API idempotency field.

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.

More information:

This field is an API idempotency field.

transferId String REQUIRED

The unique ID assigned by WorldFirst to identify the status of the transfer.

More information:

This field is an API idempotency field.

transferResult Result REQUIRED

Indicates the status of the transfer made by the transfer API.

Show child parameters

transferFinishTime DateTime object REQUIRED

Indicates the finishing time of a transfer.

More information:

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

transferFromDetail transferFromDetail REQUIRED

The transfer amount submitted by the payer.

Show child parameters

transferToDetail transferToDetail REQUIRED

The transfer details for the beneficiary, such as the transfer amount collected by the beneficiary.

Show child parameters

transferFactor TransferFactor REQUIRED

Indicates different scenarios for the transfer, such as transfer to a WorldFirst Account or a WorldFirst Virtual Account.

Show child parameters

API Explorer

Request

URL

Request Body

Response

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 API calling result.
transferResult.resultStatus indicates the transfer result.

The possible responses for result.resultStatus are:

S: This indicates the API call succeeded.
F: This indicates the API call failed. For more information on specific reasons, see result.resultCode.

For example, if the value of resultCode is ORDER_NOT_EXIST, it means that the transfer is not yet accepted and can be treated as a transfer failure.
For other values, refer to the result codes section. If the issue is not resolved, contact WorldFirst Technical Support.

U: This indicates the API call result is unknown.

If result.resultCode is TRANSFER_IN_PROCESS, the transfer is being processed. Please wait for the transfer result notification from the notifyTransferResult API.
If result.resultCode is COMPLIANCE_PENDING the transfer is pending due to compliance issues. WorldFirst Technical Support will contact the Partner soon.
The Partner can make another API call with 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.

The possible responses for transferResult.resultStatus are:

S: This indicates the transfer succeeded.
F: This indicates the transfer failed. For more information on specific reasons, see result.resultCode.
U: This indicates the transfer result is unknown.

If result.resultStatus is S, and transferResult.resultCode is TRANSFER_IN_PROCESS, the transfer is being processed. Please wait for the transfer result notification from the notifyTransferResult API.
If resultStatusresult. is S, and transferResult.resultCode is COMPLIANCE_PENDING the transfer is pending due to compliance issues. WorldFirst Technical Support will contact the Partner soon.

result.resultCode

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 WorldFirst Technical Support to resolve the issue.
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.
UNKNOWN_EXCEPTION	U	The API call is failed, which is caused by unknown reasons.	The service might be down, retry later. If the issue persists, contact WorldFirst Technical Support.
REQUEST_TRAFFIC_EXCEED_LIMIT	U	Call the interface again to resolve the issue. If not resolved, contact Alipay Technical Support.	Call the interface again to resolve the issue. If not resolved, contact Alipay Technical Support.
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. For more details, refer to the following chapter: The signature field in a request header. How to calculate a signature.
METHOD_NOT_SUPPORTED	F	The server does not implement the requested HTTP method.	Ensure the HTTP method is `POST`.
ORDER_NOT_EXIST	F	The order does not exist.	Retry with another transfer order.

transferResult.resultCode

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 WorldFirst Technical Support to resolve the issue.
USER_NOT_EXIST	F	The user does not exist.	Human intervention is usually needed. It is recommended that you contact WorldFirst Technical Support to resolve the issue.
USER_ACCOUNT_ABNORMAL	F	User account status abnormal.	Retry with a different user. If the issue persists, contact WorldFirst Technical Support 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.	Query the transfer result with the inquiryTransfer API.
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.
CARD_INFO_NOT_MATCH	F	The card information does not match.	Retry with the correct card information.
UNKNOWN_EXCEPTION	U	Unknown exception.	The service might be down, retry later. If the issue persists, contact WorldFirst Technical Support.
BALANCE_NOT_ENOUGH	F	Balance is not enough.	Make sure the balance is sufficient and retry.