AddVpaScene API

Endpoints

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

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

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
sceneName	String	Yes
type	String	Yes	0:time limit 1:cycle limit 2:single limit
cycleType	String	No	required when type=1, 0:Natural month 1:Natural day
cycleDay	String	No	required when type=1 and cycleType=1, value range:1-28
maxNum	String	No	required when type=0 or 1
maxAmount	String	No
startTime	String	No	required when type=0
endTime	String	No	required when type=0
sign	string	Yes	Signature, MD5(merNo+privateKey) or RSA

Example Request

{
  "merNo": "104001001",
  "sceneName": "test",
  "type": "1",
  "cycleType": "0",
  "maxNum": "10000",
  "maxAmount": "100000",
  "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	senceId

Example Responses

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