Receive balance change notification
WorldFirst uses the notifyBalanceChange API to notify you of all balance account changes whenever a transaction occurs in your WF balance account.
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
notifySequence Integer REQUIRED
The cumulative sequence number of notifications you receive from WorldFirst.
balanceChangeLogs Array<BalanceChangeLog> REQUIRED
The change logs of the account balance.
Response parameters
result Result REQUIRED
Indicates whether this API is called successfully.
Request
Response
Result processing logic
After receiving the result notification, you need to send a response to acknowledge receipt of the notification.
Note: You must sign the message before sending the response. For details, see Sign a request and validate the signature and Response header.
If you do not send the acknowledgment back to WorldFirst, WorldFirst retries to send the result by complying with the following rules:
- WorldFirst retries notifications 7 times at most.
- Intervals between notifications: 2m, 10m, 10m, 1h, 2h, 6h, and 15h.
result.resultCode
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | |
| UNKNOWN_EXCEPTION | U | The API call is failed, which is caused by unknown reasons. | The service might be down, please retry later. If the issue persists, contact our Technical Support Team. |
| SYSTEM_ERROR | F | System error. | Do not retry, and contact our Technical Support Team for more details. |