CreateCardholder API

Endpoints

Live POST https://pay.onlinepay.ai/card/createCardholder

Sandbox POST https://testpay.onlinepay.ai/card/createCardholder

Request Parameters

Basic Information

Parameter	Type	Required	Description
merNo	Integer	Yes	Merchant Number, Unique identifier assigned to the merchant by the onlinepay payment platform when registering with onlinepay
firstName	String	Yes	First Name (max 50 characters)
lastName	String	Yes	Last name (max 50 characters)
city	String	Yes	City of residence (bill) (max 100 characters)
country	String	Yes	refer to Country info,such as China : CN
address	String	Yes	Billing address 1 (max 128 characters)
zipcode	String	Yes	Postal Code (max 20 characters)
state	String	Yes	State Name (max 100 characters)
email	String	Yes	email (max 100 characters)
tel	String	Yes	phone (max 20 characters)
birthday	String	Yes	Birthday (yyyy-MM-dd)
gender	String	Yes	1:male 0:female
telCode	String	Yes	refer to Country info,such as China : CN
idType1	String	Yes	01:idCard(nationality is China) 02:passport(country is not China)
idCard1	String	Yes	ID number (max 50 characters)
idType2	String	No	required when nationality is not China. 03: Hong Kong, Macao and Taiwan ID card. 06: Other types of personal valid documents 06: Other types of personal valid documents
idCard2	String	No	ID number (max 50 characters) ,required when nationality is not China.
photoFrontId1	String	Yes	front photo fid of idTeype1,result of Upload File
photoBackId1	String	Yes	back photo fid of idType1,result of Upload File
photoFrontId2	String	No	front photo fid of idType2,result of Upload File
photoBackId2	String	No	back photo fid of idType2,result of Upload File
sign	String	Yes	Signature, MD5(merNo+PrivateKey) or RSA

Example Request

{
  "merNo": "104001001",
  "firstName": "test2",
  "lastName": "test",
  "city": "city1",
  "country": "CN",
  "address": "adress1",
  "zipcode": "000000",
  "state": "state1",
  "email": "[email protected]",
  "tel": "123456789",
  "birthday": "2000-01-01",
  "gender": "1",
  "telCode": "86",
  "idType1": "01",
  "idCard1": "331000000000000000",
  "photoFrontId1": "1727235173391.png",
  "photoBackId1": "1727235173391.png",
  "sign": "e8b6b0b9f0b0f8b0b8b0a0b0c0d0e0f"
}

Responses Body

Parameter	Type	Required	Description
code	string	Yes	If the value is 00000, it will return success, other please refer to Error Code
message	string	Yes	Interface returns description
data	string	Yes	applyOrderNo: onlinePay apply order number

Example Responses

{
    "code":"00000",
    "message":"SUCCESS",
    "data":"CAD0240927153321448"
}