Search

订单查询、退款查询、拒付查询、结算查询

1. 订单批量查询

请求地址:GET /search/list/order

必须有一个查询条件,查询时间不能超过一个月

1.1 请求参数

参数
类型

uniqueId

String(128)

系统交易 ID

transactionId

String(128)

商户交易请求 ID

startDate

String(32)

交易查询时间,开始时间

格式(2023-01-01/2023-01-01 00:00:00)

endingDate

String(32)

交易查询时间,结束时间

格式(2023-01-01/2023-01-01 00:00:00)

currPage

Number

翻页参数,默认为 1,不能作为查询条件

1.2 请求实例

curl --location 'https://domain/search/list/order?startDate=2023-01-01&currPage=28'

1.3 返回实例

{
    "code": 121,
    "message": "Search success",
    "timestamp": 1677817727833,
    "currPage": 26,
    "totalCount": 276,
    "totalPage": 28,
    "pageSize": 10,
    "data": [
        {
            "code": 101,
            "uniqueId": "1592743695274926082",
            "appId": 1590336007032328193,
            "transactionId": "1668574662",
            "transactionCurrency": "USD",
            "transactionAmount": "1.00",
            "transactionCardNumber": "411111******1111",
            "transactionAt": "2023-03-03 13:29:59",
            "timestamp": 1677817727833,
            "isTest": false
        },
        {
            ......
        }
    ]
}

1.4 返回参数

参数
类型
说明

code

Number(3)

返回码,详见附录

message

String(255)

普通返回信息

timestamp

Number

返回时间戳

currPage

Number

当前页

totalCount

Number

总条数

totalPage

Number

总页数

pageSize

Number

每页显示条数

data

Array

查询数据数组对象,参数详见 Sale 返回参数

2. 单笔交易查询

请求地址:GET /search/order/{uniqueId}

2.1 请求参数

只接受 URL 传参 uniqueId,其他任何参数都不接受

2.2 请求实例

curl --location 'https://domain/search/order/1592743695274926082'

2.3 返回实例

{
    "code": 101,
    "uniqueId": "1631496627003060226",
    "appId": 1625420154047475713,
    "transactionId": "1677814082",
    "transactionCurrency": "USD",
    "transactionAmount": "10.00",
    "transactionCardNumber": "411111******1111",
    "billDescription": "xxx.com",
    "transactionMessage": "Declined",
    "transactionAt": "2023-03-03 13:29:59",
    "message": "transaction failed",
    "timestamp": 1677814082360,
    "isTest": true
}

2.4 返回参数

单笔交易查询返回参数和交易返回参数相同,详见 Sale 返回参数

3. 批量退款查询

请求地址:GET /search/list/refund

必须有一个查询条件,查询时间不能超过一个月

3.1 请求参数

参数
类型
说明

uniqueId

String(128)

原交易系统返回交易 ID

transactionId

String(128)

原交易商户请求交易 ID

refundTransactionId

String(128)

退款商户请求的退款 ID

refundUniqueId

String(128)

退款返回的系统唯一退款 ID

startDate

String(128)

退款查询时间,开始时间

格式(2023-01-01/2023-01-01 00:00:00)

endingDate

String(128)

退款查询时间,结束时间

格式(2023-01-01/2023-01-01 00:00:00)

currPage

Number

翻页参数,默认为 1,不能作为查询条件

3.2 请求实例

curl --location 'https://domain/search/list/refund?startDate=2022-10-10' \

3.3 返回实例

{
    "code": 121,
    "message": "Search success",
    "timestamp": 1677825024053,
    "currPage": 1,
    "totalCount": 66,
    "totalPage": 7,
    "pageSize": 10,
    "data": [
        {
            "code": 111,
            "merchantRefundId": "1677823321",
            "uniqueId": "1631534182100414466",
            "refundUniqueId": "1631535378940026882",
            "refundCurrency": "USD",
            "refundAmount": "1.00",
            "refundRequestAt": "2023-03-03 14:02:01",
            "refundAt": "2023-03-03 14:02:01",
            "message": "Refund successful",
            "timestamp": 1677825024053
        },
        {
            ......
        }
    ]
}

3.4 返回参数

参数
类型
说明

code

Number(3)

返回码,详见附录

message

String(255)

普通返回信息

timestamp

Number

返回时间戳

currPage

Number

当前页

totalCount

Number

总条数

totalPage

Number

总页数

pageSize

Number

每页显示条数

data

Array

查询数据数组对象,参数详见 Refund 返回参数

Last updated