Receive payment result notification
After the the trade order has been paid successfully, WorldTrade calls this API to notify the Partners of the payment result.
Structure
Messages consist of a header and body. The following sections focus on the body structure. For the header structure, see:
Request parameters
tradeId String REQUIRED
The unique trade ID assigned by WorldTrade.
More information:
- Maximum length: 64 characters
requestId String REQUIRED
The unique external order ID that corresponds to the requestId of the order uploaded by Partners.
paymentPhase String REQUIRED
Current payment phase. Valid values are:
ADVANCE_PAYMENT: indicates the advance payment is collected.BALANCE_PAYMENT: indicates the balance payment is collected.FULL_PAYMENT: indicates the full payment is collected.
Response parameters
result Result REQUIRED
The result of the API call.
Request
Response
Result processing logic
After receiving the notification, you need to send a response message to acknowledge the receipt 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:
If WorldTrade does not receive an acknowledgment, it will resend the notification with the following schedule:
- Total retries: 7
- Retry intervals: 2 min, 10 min, 10 min, 1 h, 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. It is recommended that you contact our Technical Support Team to resolve the issue. |
| 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. |