Onerway
POST

Create cardholder

View as Markdown
Use this endpoint to create a cardholder before card creation.

Request

ApiKeystringrequired
Issuing API key request header assigned by Onerway.
Example:replace_with_issuing_api_key
merchantNointegerrequired
Merchant number assigned by Onerway.
Example:88888
clientRequestIdstringrequired
Idempotent request ID.
Example:REQ_CH_20260101_001
firstNamestringrequired
Cardholder first name.
lastNamestringrequired
Cardholder last name.
emailstringrequired
Cardholder email address.
Constraints
Rule
Must be a valid email address.
mobilestringoptional
Cardholder mobile number.
Example:13800138000
mobileAreaCodestringoptional
Mobile area code.
Example:+86
birthDaystringoptional
Date of birth.
Example:1990-01-01
nationalitystringoptional
Nationality as an ISO 3166-1 alpha-2 code.
Example:CN
addressRegionCodestringoptional
Address country or region code.
addressStateCodestringoptional
State or province code.
addressCityCodestringoptional
City code.
addressDetailLine1stringoptional
Address line 1.
addressDetailLine2stringoptional
Address line 2.
addressPostalCodestringoptional
Postal code.
remarkstringoptional
Remark.
Example:example remark

Request example

curl -X POST 'https://sandbox-api.onerway.com/api/v1/merchant/cardholder/createCardholder' \
  -H 'ApiKey: replace_with_issuing_api_key' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "addressCityCode": "SZ",
  "addressDetailLine1": "Example address line 1",
  "addressPostalCode": "518000",
  "addressRegionCode": "CN",
  "addressStateCode": "GD",
  "birthDay": "1990-01-01",
  "clientRequestId": "REQ_CH_20260101_001",
  "email": "example_cardholder@example.com",
  "firstName": "Alex",
  "lastName": "Chen",
  "merchantNo": 88888,
  "mobile": "13800138000",
  "mobileAreaCode": "+86",
  "nationality": "CN"
}'

Response

respCodestring
Business response code. 20000 means success.
respMsgstring
Response message.
Cardholder information.

Response example

{
  "respCode": "20000",
  "respMsg": "success",
  "data": {
    "cardholderId": 300001,
    "firstName": "Alex",
    "lastName": "Chen",
    "email": "example_cardholder@example.com",
    "mobile": "13800138000",
    "mobileAreaCode": "+86",
    "birthDay": "1990-01-01",
    "nationality": "CN",
    "addressRegionCode": "CN",
    "addressStateCode": "GD",
    "addressCityCode": "SZ",
    "addressDetailLine1": "Example address line 1",
    "addressDetailLine2": null,
    "addressPostalCode": "518000",
    "remark": null
  }
}
No error responses are documented for this endpoint.

Get card sensitive info

Query sensitive card information from a secure server-side environment.

Update cardholder

Update an existing cardholder's profile information.