Update cardSignature required
Partners can call this API to update World Card information.
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 request.
More information:
- This field is an API idempotency field. For details about API idempotency, see the Idempotency chapter.
- Maximum length: 32 characters
assetId String REQUIRED
The unique identifier of a card.
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.
metadata Object
Business metadata.
cardHodlerId String
The unique ID assigned by WorldFirst to identify a business contact.
If unspecified, the value of this parameter defaults to the current user ID.
email String
Email address of the cardholder.
This info will be used for 3DS authentication.
More information:
- Maximum length: 32 characters
mobileNumber String
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
billAddress Object
The billing address.
This field is returned only when the value of result.resultStatus is
S.
Response parameters
result Result REQUIRED
The result of the API call.
requestId String REQUIRED
The unique ID assigned by the partner to identify the customer request.
This field is returned only when the value of result.resultStatus is
S.
More information:
- Maximum length: 32 characters
assetId String REQUIRED
The unique identifier of a card.
accountId String REQUIRED
The unique ID assigned by WorldFirst to identify a customer account.
More information:
- Maximum length: 64 characters
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 returned only when the value of result.resultStatus is
S.
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. |
System-related 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 confirm whether the request header and parameters are correct. |
| SYSTEM_ERROR | F | System error. | Do not retry. Contact WorldFirst Technical Support for more information. |
| SERVICE_NOT_ALLOWED | F | Service not allowed. | Retry with 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 more information. |
| INVALID_API | F | The called API is invalid or not active. | Confirm whether the correct API is called. |
| INVALID_CLIENT | F | The client is invalid. | The 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 check the contract status and retry. |
Business-related Result Codes
| Code | Value | Message | Further action |
|---|---|---|---|
| REPEAT_REQUEST | U | repeat request | Replace requestId and initiate retry |
| CONTRACT_NOT_EXIST | F | The contract check has failed. | Ensure the Partner has already signed a contract and the input is correct. |
| ACCESS_TOKEN_EXPIRED | F | The access token expired. | Refresh the 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. |