Introduction

This API support merchant query sub-merchant history order.

API Description

Request Method:POST

Request Path:open/api/order/list

Parameters

Request parameters

Parameter	Mandatory	Sign	Type	Length	Remarks
appId	Y	Y	string	64	AppId is unique for merchant
sign	Y	Y	string	128	Sign Check on About the sign
subMerchantNo	N	Y	string	64	Sub-merchant number
externalSubMerchantNo	N	Y	string	32	External sub-merchant number
pageNo	Y	Y	int	12	Page No
pageSize	Y	Y	int	12	Page Size
orderStatus	N	Y	string	32	Order status
customerPayNum	N	Y	string	64	Merchant order number

Request Example

{
    "appId": "TEST000001",
    "pageNo": 1,
    "pageSize": 20,
    "subMerchantNo": "300017425425787840220",
    "externalSubMerchantNo": "test_000001",
    "orderStatus": "COMPLETED",
    "sign": "D8499085CC2655AE19C6A68A12DF7EBB1D0822F9F7071042CD3AB7E4D433B7ACFAEF73C5DE4C58BCD5492B763E3B87531A4EE1422554D472F2B0EAAA0E4A90C8"
}

Description of Response Parameters

Parameter	Type	Details
success	boolean	Success
error	boolean	Error
code	long	Response code
msg	string	Response message
traceId	string	Trace id
model	object	Response details

Description of Model Parameters

Parameter	Mandatory	Type	Description
pageNo	N	int	Page number
pageSize	N	int	Number of items per page
sumRow	N	int	Total number of items
sumPage	N	int	Total number of pages
lastPage	N	boolean	Whether it is the last page
data	N	object	Data

Data Parameter

Parameter Name	Mandatory	Type	Description
subMerchantNo	Y	string	Sub-merchant number
orderNum	Y	string	Order number
customerPayNum	Y	string	Merchant order number
payNo	Y	string	Payment number
currencyType	Y	string	Order currency type (FAIT/CRYPTO)
orderAmount	Y	double	Order amount
orderCurrency	Y	string	Order currency
network	Y	string	Network
userId	Y	string	User ID
createTime	Y	string	Order creation time
payType	Y	string	Payment method
cryptoCurrency	N	string	Cryptocurrency unit
cryptoVolume	N	double	Cryptocurrency amount
settlementAmount	N	double	Settlement amount
settlementCurrency	N	string	Settlement currency
payCryptoVolume	N	double	Paid cryptocurrency amount
payCryptoCurrency	N	string	Paid cryptocurrency unit
fee	N	double	Transaction fee
status	Y	string	Order status
remark	N	string	Remark
failReason	N	string	Failure reason

Response Example

{
    "code": "0",
    "msg": "success",
    "model": {
        "pageNo": 1,
        "pageSize": 20,
        "sumRow": 2,
        "data": [
            {
                "subMerchantNo": "300017425425787840220",
                "externalSubMerchantNo": null,
                "orderNum": "300217428049183390284",
                "customerPayNum": "17428049140000",
                "payNum": "300317428049342220151",
                "currencyType": "FAIT",
                "orderAmount": 7,
                "orderCurrency": "USD",
                "network": "XLM",
                "userId": "[email protected]",
                "createTime": "2025-03-24 16:28:38",
                "payType": "WALLET",
                "cryptoCurrency": "XLM",
                "cryptoVolume": 26.67682927,
                "settlementAmount": 58.72,
                "settlementCurrency": "HKD",
                "payCryptoVolume": 26.6768293,
                "payCryptoCurrency": "XLM",
                "fee": 0.077,
                "status": "COMPLETED",
                "remark": null,
                "failReason": "Your actural payment amount exceeds the order amount"
            },
            {
                "subMerchantNo": "300017425425787840220",
                "externalSubMerchantNo": null,
                "orderNum": "300217425431084470250",
                "customerPayNum": "17425431050000",
                "payNum": "300317425431217630134",
                "currencyType": "FAIT",
                "orderAmount": 1,
                "orderCurrency": "USD",
                "network": "BSC",
                "userId": "[email protected]",
                "createTime": "2025-03-21 15:45:08",
                "payType": "WALLET",
                "cryptoCurrency": "USDT",
                "cryptoVolume": 1.1,
                "settlementAmount": 8.31,
                "settlementCurrency": "HKD",
                "payCryptoVolume": 1.1,
                "payCryptoCurrency": "USDT",
                "fee": 0.011,
                "status": "COMPLETED",
                "remark": null,
                "failReason": null
            }
        ],
        "sumPage": 1,
        "startIndex": 0,
        "lastPage": true
    },
    "traceId": "67e263c9bf6473ab7aa09ef4be4c5469",
    "success": true,
    "error": false
}