Consult expected transfer resultSignature required

POST /amsin/api/v1/business/fund/consultTransfer

Use this API to inquire about the expected transfer results before initiating a transfer.

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

transferFromDetail TransferFromDetail  REQUIRED

Transfer details submitted by the payer.

Show child parameters

transferToDetail TransferToDetail  REQUIRED

Transfer details for the beneficiary.

Show child parameters

Response parameters

result Result  REQUIRED

Indicates whether this API is called successfully.

Show child parameters

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

Response Body

Result processing logic

After making an API request, WorldFirst responds to the Partner with the result of the API call. 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 table.

U

This indicates the API call result is unknown. The partner can call this API again.

result.resultCode: System-related result codes

CodeValueMessageFurther action
SUCCESSSSuccess
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.

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.

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.

result.resultCode: Business-related result codes

CodeValueMessageFurther action
UN_SUPPORT_BUSINESSFUnsupported business.

Invalid parameters are used. Retry with the correct information.

USER_NO_PERMISSIONFUser does not have permission.

Retry with another user information.

CURRENCY_NOT_SUPPORTFThe currency is not supported.

Make sure the currency input is correct and try again.

USER_NOT_EXISTFThe user does not exist.

Retry with the correct user information.

USER_ACCOUNT_ABNORMALFThe user account status is abnormal.

Retry with a different user. If the issue persists, contact our Technical Support Team for more details.

USER_STATUS_ABNORMALFThe status of the user is abnormal. Retry with another card.

The status of the user is abnormal. Retry with another transfer order.

CONTRACT_CHECK_FAILFThe contract check has failed.

Ensure the Partner has already signed a contract and the input is correct.

@2024 WorldFirst