Apply for cardSignature required
You are viewing the latest API version. If you are using V1, please refer to the legacy documentation.
Partners can call this interface to apply for a World Card.
Structure
A message consists of a header and body. For details, see the following sections.
Request header
Field | Required | Sample | Description |
Client-Id | Yes |
|
|
Signature | Yes |
| |
Content-Type | Yes |
| |
Request-Time | Yes |
| |
Connected-AccountId | Conditional |
| Attention Required when a partner manages a customer's account. |
Access-Token | Conditional |
| Attention Required for OAUTH authorization. Refer to applyToken. |
Request parameters
requestId String REQUIRED
The unique ID assigned by the partner to identify the card application request.
More information:
- This field is an API idempotency field. For details about API idempotency, see the Idempotency chapter.
- Maximum length: 32 characters
cardHolderId String REQUIRED
The unique ID assigned by WorldFirst to identify a business contact.
cardNickName String
The nickname of the World Card. This parameter is useful for managing multiple cards.
More information:
- Maximum length: 120 characters
note String
Note regarding this card activation request.
More information:
- Maximum length: 512 characters
authorizationControl Object
Authorization Control Rules.
email String REQUIRED
Email address of the cardholder.
This info will be used for 3DS authentication.
More information:
- Maximum length: 32 characters
mobileNumber String REQUIRED
Mobile number of the cardholder.
For example: +6512345678 (where +65 is the Singapore country code).
This info will be used for 3DS authentication.
More information:
- Maximum length: 32 characters
metadata Object
Business Metadata.
billAddress Object REQUIRED
The billing address.
This field is only returned when result.resultStatus = S.
Response parameters
result Result REQUIRED
The result of the API call.
status String REQUIRED
The status of the application to open a World Card.
Valid values are:
-
PROCESSING: indicates the application is being processed. -
SUCCESS: indicates the application is successful. -
FAIL: indicates the application has failed.
This field is only returned when result.resultStatus = S.
requestId String REQUIRED
The unique ID assigned by the partner to identify the card application request.
This field is only returned when result.resultStatus = S.
More information:
- Maximum length: 32 characters
accountId String REQUIRED
The unique ID assigned by WorldFirst to identify a customer account.
More information:
- Maximum length: 64 characters
Request
Response
Result processing logic
After calling the API, a response is returned. Possible values for result.resultStatus are:
Result status | Description |
| Indicates that the API call succeeded. |
| Indicates that the API call failed. For additional information on the failure, refer to result.resultCode. |
| Indicates that the API call result is unknown. If this status is returned, the Partner may make a query. The querying strategy is as follows:
If no queries succeed, contact our Technical Support Team. |
result.resultCode: System 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 and confirm whether 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. |
| UNKNOWN_EXCEPTION | U | API failed due to unknown reason. | Server error. If retrying later does not resolve the issue, contact WorldFirst technical support. |
| 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. | Confirm whether the correct API is being called. |
| INVALID_CLIENT | F | The client is invalid. | Client ID does not exist or is invalid. |
| INVALID_SIGNATURE | F | The signature is invalid. | Confirm that the request is correctly signed. |
| METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTP method. | Confirm that the HTTP request method is POST. |
| CONTRACT_CHECK_FAIL | F | The contract check has failed. | Contact WorldFirst technical support to understand the contract status before retrying. |
result.resultCode: Business Result Codes
| Code | Value | Message | Further action |
|---|---|---|---|
| REPEAT_REQUEST | U | Repeat request. | Change the requestId and retry calling this API. |
| USER_NOT_EXIST | F | The user does not exist. | Retry with the correct user information. |
| USER_INFORMATION_INCOMPLETE | F | The user's English name information cannot be empty. | User information is incomplete. Please provide the complete user information and retry. If the call fails again, please reach out to our Technical Support Team. |
| CONTACT_ENTITY_ID_MATCH_MULTIPLE | F | Matches multiple contactentityids. You need to enter a specified contactEntityId. | Matches multiple contactentityids. You need to enter a specified contactEntityId and initiate a retry. |
| APPLY_CARD_NUMBER_LIMIT | F | Apply card number limit. | Please contact our Technical Support Team for help. |
| RISK_REJECT | F | Request rejected due to risk concerns. | Please contact our Technical Support Team for help. |
| ACCESS_TOKEN_EXPIRED | F | The access token expired. | Refresh token to get a new access token or contact our Technical Support Team to address it. |
| AUTHORIZATION_NOT_EXIST | F | The authorization does not exist. | Make sure that the input is correct. If the issue persists, contact our Technical Support Team to verify the authorization status. |