QueryOrderList API

Endpoints

Live POST https://pay.onlinepay.ai/order/queryOrderList

Sandbox POST https://testpay.onlinepay.ai/order/queryOrderList

note

There are refunds for SEPA,Credit Cards and Alipay, UnionPay no refund.

Request Parameters

Parameter	Type	Required	Description
merNo	integer	Yes	Merchant Number, Unique identifier assigned to the merchant by the onlinepay payment platform when registering with onlinepay
merOrderNos	array[string]	No	Merchant Order Number
tradeNos	array[string]	No	The flow number generated after each order payment
dateLimit	object	No	Start and end time of the query
-from	string	Yes	Start date
-to	string	Yes	End data
version	string	No	V3.0.0
sign	string	Yes	MD5(merNo+PrivateKey) or RSA
pageNum	integer	Yes	Number of pages
pageSize	integer	Yes	Size of pages

Example Request

{
  "merNo": 111111,
  "merOrderNos": [
    "2222221",
    "2222222",
    "2222223",
    "2222224",
    "2222225"
  ],
  "tradeNos": [
    "333331",
    "333332",
    "333333",
    "333334",
    "333335"
  ],
  "dateLimit": {
    "from": "2023-05-01 00:00:00",
    "to": "2023-05-01 23:59:59"
  },
  "version": "V3.0.1",
  "pageNum": 1,
  "pageSize": 15
}

Responses 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
data.pageNum	number	Yes	Number of pages.
data.pageSize	number	Yes	Quantity per page.
data.totalPage	number	Yes	Total pages.
data.total	number	Yes	Total data volume.
data.list	array	Yes
data.list.state	number	Yes	1: Transaction processing, 5: Transaction successful, 6: Transaction failed, 9: Refund successful, 10: Refund processing, 11: Chargeback, 12: Chargeback processing, 17: Chargeback after refund.
data.list.merOrderNo	string	Yes	Merchant order number.
data.list.tradeNo	string	Yes	The flow number generated after each order payment (unique marker).
data.list.handlingFee	string	Yes	Handling fee.
data.list.receiveAmount	string	Yes	Receive amount for payment(used for cryptopay).
data.list.settlementCurrency	string	Yes	Currency of settlement to merchants.
data.list.settleAmount	string	Yes	Amount of settlement to merchants.
data.list.margin	string	Yes	Margin for orders.
data.list.refusalPayReason	string	Yes	Reasons for refusal of payment.
data.list.message	string	Yes	Reason.
data.list.transactionProcessingFee	string	Yes	Transaction processing fee.
data.list.exceptionHandlingFee	string	Yes	Refusal to pay / Fraud / Refunds.
data.list.refundAmount	string	Yes	Refund amount.
data.list.refundCurrency	string	Yes	Refund currency.
data.list.sourceAmount	string	Yes	Original amount.
data.list.sourceCurrency	string	Yes	Original currency.
data.list.settle	integer	Yes	1: Settled, 0: Unsettled
data.list.gasFee	string	No	Order collection transfer GAS, only for crypto pay use
data.list.transactionHash	string	No	On-chain transaction hash, used to query transaction details in the blockchain browser, only for crypto pay

Example Responses

{
  "code": "00000",
  "message": "Success",
  "data": {
    "pageNum": 1,
    "pageSize": 10,
    "totalPage": 2,
    "total": 15,
    "list": [
      {
        "state": 5,
        "merOrderNo": "20230901001",
        "tradeNo": "T20230901001",
        "handlingFee": "10.00",
        "receiveAmount": "100.00",
        "settlementCurrency": "USD",
        "settleAmount": "90.00",
        "margin": "5.00",
        "refusalPayReason": "",
        "message": "Transaction successful",
        "transactionProcessingFee": "2.00",
        "exceptionHandlingFee": "0.00",
        "refundAmount": "0.00",
        "refundCurrency": "USD",
        "sourceAmount": "100.00",
        "sourceCurrency": "USD",
        "settle": 1
      },
      {
        "state": 6,
        "merOrderNo": "20230901002",
        "tradeNo": "T20230901002",
        "handlingFee": "10.00",
        "receiveAmount": "100.00",
        "settlementCurrency": "USD",
        "settleAmount": "0.00",
        "margin": "5.00",
        "refusalPayReason": "Insufficient funds",
        "message": "Transaction failed",
        "transactionProcessingFee": "2.00",
        "exceptionHandlingFee": "0.00",
        "refundAmount": "0.00",
        "refundCurrency": "USD",
        "sourceAmount": "100.00",
        "sourceCurrency": "USD"
      }
    ]
  }
}