OnlinePay API
CONTENTS
Introduction
How to start
Country Code
Currency Code
Error Code
API Reference
POST
Credit Card
POST
Alipay
POST
Union Pay
POST
WeChat
POST
PIX
POST
GCash
POST
Crypto Pay
POST
Payout
POST
Payout CheckOut
POST
OnlinePay CheckOut
POST
notifyUrl
POST
Refund
POST
Query
POST
QueryOrderList
POST
Subscribe Query
POST
Subscribe Cancel
POST
Subscribe Update
Powered by Apifox

Credit Card

POSTLive- https://pay.onlinepay.ai/payment
POSTSandbox- https://testpay.onlinepay.ai/payment

Direct mode: PCI compliance is required in this mode. The merchant system can capture the cardholder's card number information and transmit them to OlinePay, then the request is quickly verified and processed, and the payment result is returned directly.

Checkout: When you initiate a payment request, you will receive a checkout URL back from OnlinePay and be redirected to that checkout URL to submit your card number and other information, finally jump to the returnUrl to synchronize your payment results.

3DS: 3DS is designed to reduce the risk of fraud and unauthorized transactions by verifying the identity of the cardholder. When making a 3DS-based payment, it redirects to a secure authentication page that allows the user to perform 3DS authentication.

Note: OnlinePay will obtain the HTTP Header referrer 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.

Params

Body Params (application/json)
merNo
integer 
required

Merchant Number, Unique identifier assigned to the merchant by the onlinepay payment platform when registering with onlinepay

merOrderNo
string 
required

Merchant Order Number, Each order must be unique, and each merchant order number can only be submitted once within 1 second

currencyCode
string 
required

Please refer to Currency Code

sourceAmount
string 
required

Total amount of the order, keep two decimals

returnUrl
string 
required

Jump address after payment is completed,

<= 512 characters
notifyUrl
string 
optional

Asynchronous notification address to notify the merchant of the final payment result

<= 512 characters
sign
string 
required

signature, MD5(merNo+merOrderNo+currencyCode+sourceAmount+PrivateKey)

cardNo
string 
required

card number, Checkout mode Can be empty

cardExpireMonth
string 
required

Expiry date of card (month), Checkout mode Can be empty

cardExpireYear
string 
required

Expiry date of card (year), Checkout mode Can be empty

cardSecurityCode
string 
required

CVV2/CSC, Checkout mode Can be empty

billingFirstName
string 
required

First Name

<= 50 characters
billingLastName
string 
required

Last name

<= 50 characters
billingAddress1
string 
required

billing address 1

<= 128 characters
billingAddress2
string 
optional

billing address 2

<= 128 characters
billingCity
string 
required

City of residence (bill)

<= 100 characters
billingState
string 
required

State Name (Bill)

<= 100 characters
billingCountry
string 
required

International ISO country abbreviation, Refer to the Country Code

<= 2 characters
billingZipCode
string 
required

Postal Code

<= 20 characters
billingPhone
string 
required

billing phone

<= 20 characters
billingEmail
string 
required

billing email

<= 100 characters
shippingFirstName
string 
required

Consignee’s first name, Virtual goods do not need to be filled in, physical goods are required

<= 50 characters
shippingLastName
string 
required

Consignee’s last name, UnionPay Can,WeChat,AliPay be empty, Virtual goods do not need to be filled in, physical goods are required

<= 50 characters
shippingAddress1
string 
required

Receiving address details 1, Virtual goods do not need to be filled in, physical goods are required

<= 128 characters
shippingAddress2
string 
required

Receiving address details 2, Virtual goods do not need to be filled in, physical goods are required

<= 128 characters
shippingCity
string 
required

Receiving city, Virtual goods do not need to be filled in, physical goods are required

<= 100 characters
shippingState
string 
required

Receiving continent, province, Virtual goods do not need to be filled in, physical goods are required

<= 100 characters
shippingCountry
string 
required

Receiving country, Refer to the country code table, Virtual goods do not need to be filled in, physical goods are required

<= 2 characters
shippingZipCode
string 
required

Consignee’s zip code, Virtual goods do not need to be filled in, physical goods are required

<= 20 characters
shippingPhone
string 
required

Consignee phone, Virtual goods do not need to be filled in, physical goods are required

<= 20 characters
shippingEmail
string 
required

shilling email, Virtual goods do not need to be filled in, physical goods are required

<= 100 characters
userAgent
string 
required

Cardholder browser UserAgent

<= 128 characters
ipAddress
string 
required

Cardholder IP address

<= 64 characters
productInfoList
array [object {4}] 
required

product list

sku
string 
required

Product ID

<= 64 characters
productName
string 
required

product name

<= 128 characters
price
string 
required

Commodity price

<= 16 characters
quantity
string 
required

quantity of commodity

<= 16 characters
version
string 
required

V3.0.0

paymentMethod
integer 
optional

0:normal, 1:subscribe

paymentInterval
integer 
optional

0:weekly, 1:monthly, 2:yearly

cardId
integer 
optional

Binding bank card id

Example

Responses

HTTP Code: 200
Content Type : JSON
Data Schema
code
string 
required

If the value is 00000, it will return success, other please refer to Error Code

message
string 
required

Interface returns description

data
object {4} 
optional

Request response data

tradeNo
string 
required

The flow number generated after each order payment (unique marker)

payCode
string 
required

Payment status code(Where: 1 means payment failure, 0 means payment success, 2 means pending)

payUrl
string 
optional

If the paycode is 2, redirect to this address

merOrderNo
string 
required

Corresponds to the [OrderNo] parameter of the order submission parameter

cardId
string 
optional

Binding bank card id

Example