Query - OnlinePay API

Request

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

<= 32 characters

sign

string

required

signature, MD5(merNo+merOrderNo+tradeNo+PrivateKey)

operationType

string

required

Operation Type, default：query

version

string

required

V3.0.0

tradeNo

string

optional

Transaction serial number

queryType

string

required

Query type, Refund the query: refund; Transaction Order query: sales

refundNo

string

optional

A unique refund number generated by the onlinepay system, Refund enquiries must be sent

Example

{
  "merNo": "111111",
  "merOrderNo": "222222",
  "version": "V3.0.0",
  "sign": "9D6FDF4880B00B002B1F2AB61AE9A721",
  "operationType": "query",
  "queryType": "refund",
  "tradeNo": "333333",
  "refundNo": "444444"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://pay.online.ai/order/query' \
--header 'Content-Type: application/json' \
--data-raw '{
    "merNo": "111111",
    "merOrderNo": "222222",
    "version": "V3.0.0",
    "sign": "9D6FDF4880B00B002B1F2AB61AE9A721",
    "operationType": "query",
    "queryType": "refund",
    "tradeNo": "333333",
    "refundNo": "444444"
}'

Responses

🟢200Success

application/json

Body

code

string

required

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

message

string

required

Interface returns description

data

object

optional

Request response data

state

enum<integer>

required

1: Transaction processing, 2: Transaction failed, 3: Transaction successful: 4 Refund processing, 5 Refund failed, 6 Refund successful

Allowed value:

4.Refund Processing

refundNo

string

required

Unique ID generated for successful refund application

merNo

string

required

Merchant number

merOrderNo

string

required

Merchant order number

tradeNo

string

required

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

refundCurrency

string

required

Refund Currency

Example

{
  "code": "00000",
  "message": "SUCCESS",
  "data": {
    "tradeNo": "333333",
    "merOrderNo": "222222",
    "merNo": 111111,
    "state": "3"
  }
}