CardOpen API

Endpoints

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

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

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
productType	String	Yes	000000:test card(USD,use for test environment) 001001:通华金服VISA公务卡(HKD) 001201:通华金服VISA虚拟卡(HKD) 021201:通华VPA电子卡(HKD) 001202:Hong Kong Visa Card(USD) 100001:Hong Kong Master Card(EUR,GBP,USD) 100002:United States Visa Card(USD)
currency	String	Yes	card currency code
cardHolderNo	String	Yes	result of Create Cardholder
shippingCountry	String	No	required when productType is 001001,refer to Country info,such as China : CN
shippingState	String	No	required when shippingCountry is CHN
shippingCity	String	No	required when shippingCountry is CHN
shippingAddress	String	No	required when productType is 001001
shippingZipcode	String	No	required when productType is 001001
payType	String	Yes	payment currency, such as USDC
isMainCard	String	Yes	1:main card 0:sub card(if productType is (001202,100001,100002), the value is 1)
merApplyNo	String	Yes	merchant apply number
notifyUrl	String	No	Asynchronous notification address to notify the merchant of the final result (max 512 characters)
payeeAccount	String	No	required when productType is 021201
procureContent	String	No	required when productType is 021201
agmfid	String	No	result of Upload File, required when productType is 021201
mainCardNo	String	Yes	required when isMainCard is 1, the value is the main card number
sceneId	String	No	required when productType is 021201
sign	String	Yes	Signature, MD5(merNo+merOrderNo+currencyCode+sourceAmount+PrivateKey) or RSA

Example Request

{
  "merNo": "104001001",
  "productType": "021201",
  "shippingCountry": "CHN",
  "shippingState": "000007",
  "shippingCity": "000008",
  "shippingAddress": "shippingAddress1",
  "shippingZipcode": "000000",
  "payType": "USDT_TRC",
  "isMainCard": "1",
  "merApplyNo": "MER123456789",
  "notifyUrl": "https://testpay.onlinepay.ai",
  "payeeAccount": "payeeAccount",
  "procureContent": "procurecontent",
  "agmfid": "1727235173391.png",
  "mainCardNo": "4083870020395826",
  "sceneId": "455",
  "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"
}