WorldFirst DocsWorldFirst DocsDOCS

Check payout resultSignature required

POST /amsin/api/v1/business/fund/inquiryPayout

Use this API to query the fund payout 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 createPayout API; and meanwhile, if you call the inquiryPayout 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  CONDITIONAL

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

Use either transferRequestId or transferId. 

More information:

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

transferId String  CONDITIONAL

The unique ID returned by WorldFirst to identify a payout request. 

Use either transferRequestId or transferId.  

Response parameters

result Result  REQUIRED

Indicates whether this API is called successfully.

Show child parameters

transferResult Result  REQUIRED

Indicates the result of the payout request.

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

Show child parameters

transferRequestId String  REQUIRED

The unique ID assigned by the Partner to identify a payout 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 payout.

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

More information:

  • Maximum length: 64 characters

transferFinishTime DateTime  

Indicates the finishing time of a payout.

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

More information:

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

transferFromDetail TransferFromDetail  REQUIRED

Payout details submitted by the payer.

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

Show child parameters

transferToDetail TransferToDetail  REQUIRED

Payout 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 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 payout.

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 result.resultCode table.

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 status

Description

S

This indicates the payout succeeded.

  • If result.resultStatus is S, and transferResult.resultCode is PROCESSING, the payout is being processed.

F

This indicates the payout failed.

For more information on why the payout failed, see transferResult.resultCode table.

U

This indicates the payout result is unknown. Call the interface again. If the issue is not resolved, contact our Technical Support Team.

result.resultCode

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.

transferResult.resultCode

CodeValueMessageFurther action
SUCCESSSSuccess
PROCESSINGSThe transfer is in process.

Try again later.

ORDER_NOT_FOUNDUOrder not found.

Retry with correct order information.

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.

ORDER_IS_REVERSEDFThe order is reversed.

Retry with another payout order.

USER_NOT_EXIST FThe 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.

Retry with a different user.

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.

CARD_INFO_NOT_MATCHFThe card information does not match.

Retry with the correct card information.

BALANCE_NOT_ENOUGHFBalance is not enough.

Make sure the balance is sufficient and retry.

CURRENCY_NOT_SUPPORTFThe currency is not supported.

Make sure the currency is correct and retry.

ORDER_NOT_EXISTFThe order does not exist.

Retry with another order.

UN_SUPPORT_BUSINESSFUnsupported business.

Retry with correct parameters.

USER_NO_PERMISSIONFUser does not have permission.

Check user permission and retry.

ORDER_IS_CLOSEDFThe order is closed.

Retry with another payout order.

@2024 WorldFirst