Query Orders

service: queryOrders

Request for transaction list.

bizContent Request Parameters

Field	Type	Required	Description	Remark
startTime	String	Y	Start TIme	Examples: 2023-12-01 00:00:00
endTime	String	Y	End TIme	Examples: 2023-12-31 23:59:59
pageNo	Integer	N	Page Number	Default 1.
pageSize	Integer	N	The user agent for the client browser.	Range [1,100], Default 10.
status	string	N	Order Status	See Webhook Order Status

bizContent Request Sample

{
  "startTime": "2023-12-01 00:00:00",
  "endTime": "2023-12-31 23:59:59",
  "pageNo": 1,
  "pageSize": 10,
  "status": "Paid"
}

bizContent Response Parameters

Field	Type	Required	Description	Remark
status	Integer	Y	Status of the response: 0 indicates success, -1 indicates failure.
errorCode	String	N	Application specific error code about any error that occurred during processing.
errorMessage	String	N	Error Description
data	Object	N	The actual data payload of the response, which can be of any JSON-compatible type	See Data Payload

Data Payload

Field	Type	Required	Description
total	Integer	Y	Total number of Orders
current_page	Integer	Y	Current Page
per_page	Integer	Y	How many orders per page
from	Integer	Y	eg. 1
to	Integer	Y	eg. 10
last_page	Integer	Y	Last Page
orders	Array	Y	See Orders Data

Important：The specific business operation results are subject to status field

Orders Data

Field	Type	Required	Description
order_sn	String	Y	Merchant Order Number
platform_order_sn	String	Y	Unique Platform Order Number
currency	String	Y	Currency
amount	Number	Y	The amount of the order.
payerID	Number	Y	The id of the payer.
purposeOfTransaction	String	Y	Purpose of Transaction
description	String	Y	Description
status	String	Y	Order Status
requestID	String	Y	Unique identifier for the request
linkID	String	Y	Identifier for the Payment Order
linkExpiry	String	Y	Expiry Time
creationTime	String	Y	Created Time