Create cardholder需要签名验签
Call this API to create a World Card cardholder.
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 defined by the Partner to identify the request, which ensures idempotency.
cardholderInfo Object REQUIRED
The information of the card holder.
cardholderType String REQUIRED
Cardholder type. Valid values are:
INDIVIDUALEMPLOYEESHAREHOLDER
Response parameters
result Result REQUIRED
The result of the API call.
auditStatus String REQUIRED
The risk audit status.
Valid values:
APPROVED: ApprovedPENDING: PendingREJECTED: Rejected
availableStatus String REQUIRED
Indicates the card status.
Valid values:
T: AvailableF: Unavailable
failCode String
The result code indicating why the card status is unavailable.
This field is returned only when availableStatus is
F.
failMessage String
Detailed information about why the card status is unavailable.
This field is returned only when availableStatus is
F.
orderId String REQUIRED
Order ID.
cardholderId String
Cardholder ID.
This field is returned only when auditStatus is
APPROVED.
Request
Response
Response Handling
After the integrator calls the API, WorldFirst returns the API call result. The result.resultStatus field has the following values:
result.resultStatus | Description |
|---|---|
S | The API request is successful. |
F | The API request failed. For the failure reason, see the result code (result.resultCode and result.resultMessage). |
U | When the API response result is |
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 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. |
result.resultCode: Business Result Codes
| Code | Value | Message | Further action |
|---|---|---|---|
| RISK_REJECT | F | Request rejected due to risk concerns. | Please contact our Technical Support Team for help. |
| 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. |
| REPEAT_REQUEST | U | Repeat request | Change the requestId and retry calling this API. |