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

Payout

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

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

When the payment is completed, the payment result will be sent to notifyUrl
<= 512 characters
sign
string 
required

signature, MD5(merNo+merOrderNo+currencyCode+sourceAmount+PrivateKey)
ipAddress
string 
required

Cardholder IP address
<= 64 characters
billingFirstName
string 
required

First Name
<= 50 characters
billingLastName
string 
required

Last name
<= 50 characters
billingAddress1
string 
required

billing address 1
<= 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
beneficiaryType
string 
required

beneficiary type can be "individual" or "business"

<= 100 characters
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)
merOrderNo
string 
required

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