QueryOrderList - OnlinePay API

Request

Body Params application/json

merNo

string

required

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

merOrderNos

array[string]

optional

Merchant Order Number

tradeNos

array[string]

optional

The flow number generated after each order payment

dateLimit

object

optional

from

string

required

Start date

to

string

required

End date

version

string

required

V3.0.0

sign

string

required

MD5(merNo+PrivateKey)

pageNum

integer

required

number of pages

pageSize

integer

required

Quantity per page

Example

{
  "merNo": "111111",
  "merOrderNos": [
    "2222221",
    "2222222",
    "2222223",
    "2222224",
    "2222225"
  ],
  "tradeNos": [
    "3333331",
    "3333332",
    "3333333",
    "3333334",
    "3333335"
  ],
  "dateLimit": {
    "from": "2023-05-01 00:00:00",
    "to": "2023-05-01 00:00:00"
  },
  "version": "string",
  "pageNum": 1,
  "pageSize": 15
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'http://prod-cn.your-api-server.com' \
--header 'Content-Type: application/json' \
--data-raw '{
    "merNo":"111111",
    "merOrderNos":[
        "2222221",
        "2222222",
        "2222223",
        "2222224",
        "2222225"
    ],
    "tradeNos":[
        "3333331",
        "3333332",
        "3333333",
        "3333334",
        "3333335"
    ],
    "dateLimit":{
        "from":"2023-05-01 00:00:00",
        "to":"2023-05-01 00:00:00"
    },
    "version":"string",
    "pageNum":1,
    "pageSize":15
}'

Responses

🟢200OK

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

required

pageNum

number

required

number of pages

pageSize

number

required

Quantity per page

totalPage

number

required

total pages

total

number

required

total data volume

list

array [object {15}]

required

Example

{
  "code": "00000",
  "message": "SUCCESS",
  "data": {
    "pageNum": 1,
    "pageSize": 15,
    "totalPage": 1,
    "total": 19,
    "list": {
      "state": "3",
      "tradeNo": "333333",
      "merOrderNo": "222222",
      "handlingFee": "1.50",
      "settlementCurrency": "USD",
      "settleAmount": "1111",
      "margin": "10",
      "refusalPayReason": "did not receive the item",
      "transactionProcessingFee": "1.50",
      "exceptionHandlingFee": "1.50",
      "refundAmount": "500",
      "refundCurrency": "USD",
      "tradeDateTime": "2023-05-05 14:56:46",
      "sourceAmount": "500",
      "sourceCurrency": "USD"
    }
  }
}