Notify download result
After you download the file successfully, WorldFirst notifies you of the result. You must process this notification and acknowledge receipt by sending a response to WorldFirst.
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
requestId String REQUIRED
The unique ID assigned by the partner to identify the download request.
More information:
- This field is an API idempotency field.
- Maximum length: 64 characters
downloadBizType String REQUIRED
The type of download.
Valid value is:
DOWNLOAD_STATEMENT_DETAIL_PDF: indicates downloading a statement in PDF format.
downloadStatementPDFDetail DownloadStatementPDFDetail REQUIRED
The statement details.
downloadResult DownloadResult REQUIRED
The download result.
fileDownloadUrl String
The URL used to download the file.
notifyUrl String
The URL to receive the file download result.
Response parameters
result Result REQUIRED
The result code, result status and result message that the Partner sends to WorldFirst to acknowledge the receipt of the download result.
Request
Response
Result processing logic
WorldFirst sends the download result using the downloadResult.result parameter in the request. For details, see the downloadResult.resultCode section. After receiving the result notification, you must send a response to acknowledge receipt.
Note: You must sign the message before sending the response. For more information, see the Sign a request and validate the signature and Response header.
If you do not acknowledge receipt, WorldFirst will retry sending the result according to the following rules:
- WorldFirst retries sending the notification up to 7 times.
- Intervals between notifications: 2 min, 10 min, 10 min, 1h, 2 h, 6 h, and 15 h.
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. Contact our Technical Support Team to resolve the issue. |
| UNKNOWN_EXCEPTION | U | API failed due to unknown reason. | The service might be down, please retry later. If the issue persists, contact our Technical Support Team. |
downloadResult.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. Contact our Technical Support Team to resolve the issue. |
| USER_ACCOUNT_ABNORMAL | F | The user account status is abnormal. | Retry with a different user. If the issue persists, contact our Technical Support Team for more details. |
| ORDER_NOT_EXIST | F | The order does not exist. | Check if the order is valid and retry. |