Receive cardholder status notification需要签名验签
WorldFirst will call this API to notify the integrator of the cardholder status.
After receiving the notification, the integrator must send a response correctly. If no response is sent to WorldFirst, WorldFirst will resend the request notification up to seven times. For details, see the Response Handling section.
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 request.
More information:
- Maximum length: 32 characters
cardholderId String
Unique Identifier for cardholder.
When the auditStatus is
APPROVED, this field is required.
auditStatus String REQUIRED
Status of the audit.
Valid values are:
APPROVEDPENDINGREJECTED
failCode String
The code that identifies the request is failing/unsuccessful.
This field is only returned when the value of auditStatus is
REJECTED.
failMessage String
The message that further explains the unsuccessful request.
This field is only returned when the value of auditStatus is
REJECTED.
userId String
User ID.
Response parameters
result Result REQUIRED
The result of the API call.
Request
Response
Result processing logic
After receiving the result notification, you must send a response to acknowledge receipt.
Note: You must sign the message before making the response. For more information, see Sign a request and validate the signature and the 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, 1 h, 2 h, 6 h, and 15 h.
result.resultCode: Result Codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | |
| PARAM_ILLEGAL | F | Illegal parameters exist. For example, a non-numeric input, or an invalid date. | Refer to the API documentation page to verify that the request headers and parameters are correct. |
| SYSTEM_ERROR | F | System error. | Do not retry. Contact WorldFirst technical support for details. |
| SERVICE_NOT_ALLOWED | F | Service not allowed. | Retry with the correct information. If the issue persists, contact WorldFirst technical support for assistance. |
| UNKNOWN_EXCEPTION | U | API failed due to unknown reason. | Server error. If the issue persists after retrying later, contact WorldFirst technical support for assistance. |
| REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. | Retry. If the issue persists, contact WorldFirst technical support. |
| OAUTH_FAIL | F | OAuth process failed. | Contact WorldFirst technical support for details. |
| INVALID_API | F | The called API is invalid or not active. | Verify that 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. | Verify that the request is correctly signed. |
| METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTP method. | Verify that the HTTP request method is POST. |
| CONTRACT_CHECK_FAIL | F | The contract check has failed. | Contact WorldFirst technical support to check the contract status before retrying. |