Card

Endpoints

Live POST https://pay.onlinepay.ai/payout

Sandbox POST https://testpay.onlinepay.ai/payout

note

OnlinePay will obtain the HTTP Header referer to verify the website source. The website source must be configured by OnlinePay to be verified. If you do not access the interface through a browser, you need to actively add a referer.

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
merOrderNo	string	Yes	Merchant Order Number, Each order must be unique, and each merchant order number can only be submitted once within 1 second
currencyCode	string	Yes	Please refer to Currency Code
sourceAmount	string	Yes	Total amount of the order, keep two decimals
withdrawType	string	Yes	Fix valued "1"
returnUrl	string	Yes	Jump address after payment is completed (max 512 characters)
notifyUrl	string	No	Asynchronous notification address to notify the merchant of the final payment result (max 512 characters)
sign	string	Yes	Signature, MD5(merNo+merOrderNo+currencyCode+sourceAmount+PrivateKey) or RSA

Card Information

Parameter	Type	Required	Description
cardNo	string	Yes*	Card number, Checkout mode Can be empty

Billing Information

Parameter	Type	Required	Description
billingFirstName	string	Yes	First Name (max 50 characters)
billingLastName	string	Yes	Last name (max 50 characters)
billingPhone	string	Yes	Billing phone (max 20 characters),The format of phone number should be like regioncode-phonenumber. e.g.1-123456.
billingAddress1	string	No	Billing address 1 (max 128 characters)
billingAddress2	string	No	Billing address 2 (max 128 characters)
billingCity	string	No	City of residence (bill) (max 100 characters)
billingState	string	No	State Name (Bill) (max 100 characters)
billingCountry	string	No	International ISO country abbreviation, Refer to the Country Code (max 2 characters)
billingZipCode	string	No	Postal Code (max 20 characters)
billingEmail	string	No	Billing email (max 100 characters)

Additional Information

Parameter	Type	Required	Description
ipAddress	string	Yes	Cardholder IP address (max 64 characters)
beneficiaryType	string	Yes	Fix valued "individual"
version	string	Yes	V3.0.0

* Required in Direct mode, can be empty in Checkout mode ** Required for physical goods, not needed for virtual goods

Example Request

{
  "merNo": 111111,
  "merOrderNo": "222222",
  "currencyCode": "USD",
  "sourceAmount": "100.05",
  "withdrawType": "1",
  "returnUrl": "https://example.com",
  "notifyUrl": "https://example.com/notify",
  "sign": "906FDF4880B00B00281F2AB61AE9A721",
  "cardNo": "4242424242424242",
  "cardExpireMonth": "01",
  "cardExpireYear": "2022",
  "cardSecurityCode": "335",
  "billingFirstName": "Tati",
  "billingLastName": "Moore",
  "billingAddress1": "123 Main St",
  "billingCity": "Anytown",
  "billingState": "CA",
  "billingCountry": "US",
  "billingZipCode": "12345",
  "billingPhone": "1234567890",
  "billingEmail": "[email protected]",
  "ipAddress": "192.168.1.1",
  "beneficiaryType": "individual",
  "version": "V3.0.0"
}

Respones 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	object	Yes**	Request response data
-tradeNo	string	Yes	The flow number generated after each order payment (unique marker)
-payCode	string	Yes	Payment status code(Where: 1 means payment failure, 0 means payment success, 2 means pending)
-merOrderNo	string	Yes	Corresponds to the [OrderNo] parameter of the order submission parameter

Example Responses

{
    "code":"00000",
    "message":"SUCCESS",
    "data":{
        "payCode":0,
        "tradeNo":"3333333",
        "merorderNo":"222222"
     }
}