Receive account balance notificationSignature required
After you have successfully prefunded your WF account, WorldFirst uses notifyVostro to notify you of the prefunding 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
fundingId String REQUIRED
The unique ID that is assigned by WorldFirst to identify a prefunding request.
More information:
- This field is an API idempotency field.You can use this parameter to perform idempotency control. For details about API idempotency, see the Idempotency chapter.
- Maximum length: 128 characters
balanceResult Result REQUIRED
Indicates whether the prefunding process is successful.
payerBankAccount PayerBankAccount REQUIRED
Indicates the payer's bank account information.
beneficiaryAccount BeneficiaryBankAccount REQUIRED
Indicates the beneficiary's WorldFirst virtual account information.
balanceChangeAmount Amount REQUIRED
Indicates the changes in the account balance, namely the amount of money added to your balance account.
balanceChangeTime DateTime
Indicates the time when the account balance changes, namely the time when you top up your account balance.
More information:
- The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".
remitInfo String
Additional information related to the prefunding request.
More information:
- Maximum length: 530 characters
Response parameters
result Result REQUIRED
Indicates whether this API is called successfully.
Request
Response
Result processing logic
WorldFirst sends you the result of the prefunding process by specifying the balanceResult.result parameter in the request. For details, see the following balanceResult.resultCode section.
After receiving the result notification, you need to send a response to acknowledge the reception of the notification.
Make sure you properly sign the message before sending the response. For details, refer to the Sign a request and validate the signature chapter.
For more details on the response header, refer to the API overview chapter.
The response body has the following fixed value:
In the absense of an ackowledgement reponse from the Partner, 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.
balanceResult.resultCode
| Code | Value | Message |
|---|---|---|
| SUCCESS | S | Success |
| REFUND | S | Refund success |
result.resultCode
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | |
| 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. |