notifyVostroAccountSignature required

2022-04-29 12:00

WorldFirst uses the notifyVostroAccount API to notify the Partner once WorldFirst receives the prefunding deposits and credits the Customer.

When WorldFirst receives the prefunding deposits from banking institutions, it takes less than 30 minutes to process the prefunding deposits. The Partner can either query the result with the inquiryBalance API or wait for notifications about the result.

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

balanceResult Result REQUIRED

Indicates whether the prefunding process is successful.

Show child parameters

payerAccount Account

The payer's account information.

Show child parameters

beneficiaryAccount Account

The beneficiary's account information.

Show child parameters

balanceChangeAmount Amount REQUIRED

The changed amount of the prefunding balance.

Show child parameters

balanceChangeTime DateTime object

Indicate the time that WorldFirst receives the prefunding deposit.

More information:

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

fundingId String REQUIRED

The unique ID assigned by WorldFirst to identify a prefunding 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

API Explorer

Request

URL

Request Body

Response

Response Body

Result processing logic

In the request message:

The transferResult.resultCode field indicates the result of the prefunding process. For more information, refer to the Result codes section.

After receiving the notification from WorldFirst, the Partner needs to send WorldFirst a response message to acknowledge the receipt of the notification.

The Partner needs to properly sign the message before making the response. For details, refer to the Sign a request and validate the signature chapter.

The response header observes the following structure:

Signature: Required. Example: Signature: algorithm=RSA256, keyVersion=2, signature=****
Content-Type: Required. Example: Content-Type: application/json; charset=UTF-8
Client-Id: Required. Example: Client-Id: ****
Response-Time: Required. Example: Response-Time: 2019-04-04T12:08:56+08:00

Sample response header:

Sample Code

For more details about the response message, refer to the API overview chapter.

The response body has the following fixed value:

Sample Code

If the Partner does not respond to WorldFirst that the notification has been received successfully, WorldFirst will resend the result.

The following policy represents how WorldFirst makes retry attempts:

WorldFirst retries notifications 7 times.
Intervals between notifications: 2m, 10m, 10m, 1h, 2h, 6h, and 15h.

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`.

balanceResult.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.