Order List
Parameter description
Request
| name | type | required | desc | example |
|---|---|---|---|---|
| param | JSONObject | YES | ||
| ─epayAccount | string | YES | Merchant Epay Account | test2020@epay.com |
| ─version | string | YES | Version number | V2.0.0 |
| ─pageNum | integer | YES | Current page | 1 |
| ─pageSize | integer | YES | Size per page | 10 |
| ─epayOrderNo | string | NO | Epay order number | 211151433035626655117312 |
| ─merchantOrderNo | string | NO | Merchant order number | 20210708220 |
| ─status | string | NO | Order Status | 9 |
| ─beginTime | string | NO | Start time | 2021-09-01 19:54:53 |
| ─endTime | string | NO | End time | 2021-09-03 19:54:53 |
| sign | string | YES | Signature |
Response
| name | type | required | desc | default |
|---|---|---|---|---|
| sign | string | YES | Signature | |
| epayAccount | string | YES | Merchant Epay Account | test2020@epay.com |
| version | string | YES | Version Number | V2.0.0 |
| code | integer | YES | Response code 1 : Success | 1 |
| message | string | YES | Message info | success |
| data | JSONObject | YES | ||
| ─page | JSONObject | YES | page info | |
| ─pageNum | integer | YES | page Num | 1 |
| ─pageSize | integer | YES | page Size | 10 |
| ─total | integer | YES | total | 1489 |
| ─pages | integer | YES | pages | 149 |
| ─nextPage | integer | YES | next Page | 2 |
| ─prePage | integer | YES | pre Page | 0 |
| ─list | array | |||
| ─ | JSONObject | |||
| ─epayOrderNo | string | YES | Epay order number | 211151433035626655117312 |
| ─merchantOrderNo | string | YES | Merchant order number | 20210708220 |
| ─merchantEmail | string | YES | Merchant Email | test2020@epay.com |
| ─businessCode | string | YES | Business type | 115 |
| ─amount | string | YES | Amount | 100.0 |
| ─fee | string | YES | Fees | 5.0 |
| ─currency | string | YES | Currency | USD |
| ─transferEmail | string | YES | Counterparty E-mail | test2020@epay.com |
| ─status | string | YES | Order Status | 9 |
| ─createTime | string | YES | Order creation time | 2021-09-01 19:54:53 |
| ─remark | string | NO | remarks | |
| ─extendFields | string | NO | Merchant extension field | |
| ─version | string | YES | version number | V2.0.0 |
Parameter example
curl --location --request POST 'http://29597375fx.epaydev.xyz/capi/openapi/payinApi/getOrderList' \
--header 'Content-Type: application/json' \
--data-raw '{
"param": {
"epayAccount": "test2020@epay.com",
"version": "V2.0.0",
"epayOrderNo": "",
"merchantOrderNo": "",
"status": "",
"beginTime": "",
"endTime": "",
"pageNum": 1,
"pageSize": 10
},
"sign": "{{sign}}"
}'
RequestExample
curl --location --request POST 'http://29597375fx.epaydev.xyz/capi/openapi/payinApi/getOrderList' \
--header 'Content-Type: application/json' \
--data-raw '{
"param": {
"epayAccount": "test2020@epay.com",
"version": "V2.0.0",
"epayOrderNo": "",
"merchantOrderNo": "",
"status": "",
"beginTime": "",
"endTime": "",
"pageNum": 1,
"pageSize": 10
},
"sign": "{{sign}}"
}'
ResponseExample
{
"sign": "",
"epayAccount": "test2020@epay.com",
"version": "V2.0.0",
"code": 1,
"message": "success",
"data": {
"page": {
"pageNum": 1,
"pageSize": 10,
"total": 1489,
"pages": 149,
"nextPage": 2,
"prePage": 0
},
"list": [
{
"epayOrderNo": "211151433035626655117312",
"merchantOrderNo": "20210708220",
"merchantEmail": "test2020@epay.com",
"businessCode": "115",
"amount": "100.0",
"fee": "5.0",
"currency": "USD",
"transferEmail": "test2020@epay.com",
"status": "9",
"createTime": "2021-09-01 19:54:53"
},
{
"epayOrderNo": "211151433033399790071808",
"merchantOrderNo": "20210708901",
"merchantEmail": "test2020@epay.com",
"businessCode": "115",
"amount": "100.0",
"fee": "4.0",
"currency": "USD",
"transferEmail": "test2020@epay.com",
"status": "9",
"createTime": "2021-09-01 19:46:02"
},
{
"epayOrderNo": "211151433032815305420800",
"merchantOrderNo": "202107087319",
"merchantEmail": "test2020@epay.com",
"businessCode": "115",
"amount": "100.0",
"fee": "4.3",
"currency": "USD",
"transferEmail": "test2020@epay.com",
"status": "9",
"createTime": "2021-09-01 19:43:42"
},
{
"epayOrderNo": "201141433021229044301824",
"merchantOrderNo": "1630493860 ",
"merchantEmail": "q53@163.com",
"businessCode": "114",
"amount": "100.23",
"fee": "2.51",
"currency": "JPY",
"transferEmail": "q54@163.com",
"status": "7",
"createTime": "2021-09-01 18:57:39"
},
{
"epayOrderNo": "211151433016406525472768",
"merchantOrderNo": "2021070817171",
"merchantEmail": "jing32@qq.com",
"businessCode": "115",
"amount": "100.0",
"fee": "4.3",
"currency": "USD",
"transferEmail": "jing32@qq.com",
"status": "6",
"createTime": "2021-09-01 18:38:30"
},
{
"epayOrderNo": "211151433003226869010432",
"merchantOrderNo": "20210708744",
"merchantEmail": "test2020@epay.com",
"businessCode": "115",
"amount": "100.0",
"fee": "4.0",
"currency": "USD",
"transferEmail": "test2020@epay.com",
"status": "7",
"createTime": "2021-09-01 17:46:08"
},
{
"epayOrderNo": "211151433001399398174720",
"merchantOrderNo": "20210708743",
"merchantEmail": "test2020@epay.com",
"businessCode": "115",
"amount": "100.0",
"fee": "5.0",
"currency": "USD",
"transferEmail": "test2020@epay.com",
"status": "7",
"createTime": "2021-09-01 17:38:52"
},
{
"epayOrderNo": "211151432985883568771072",
"merchantOrderNo": "20210708742",
"merchantEmail": "test2020@epay.com",
"businessCode": "115",
"amount": "100.0",
"fee": "4.0",
"currency": "USD",
"transferEmail": "test2020@epay.com",
"status": "9",
"createTime": "2021-09-01 16:37:13"
},
{
"epayOrderNo": "201141432985088068911104",
"merchantOrderNo": "1630485243 ",
"merchantEmail": "q53@163.com",
"businessCode": "114",
"amount": "100.23",
"fee": "2.51",
"currency": "JPY",
"transferEmail": "q54@163.com",
"status": "1",
"createTime": "2021-09-01 16:34:03"
},
{
"epayOrderNo": "211151432983271440125952",
"merchantOrderNo": "20210708741",
"merchantEmail": "test2020@epay.com",
"businessCode": "115",
"amount": "100.0",
"fee": "4.3",
"currency": "USD",
"transferEmail": "test2020@epay.com",
"status": "7",
"createTime": "2021-09-01 16:26:50"
}
]
}
}