CommonApiVersion 1.0.0
Check Orders
https://pay.globepay.co/api/v1.0/gateway/partners/{partner_code}/ordersGet a list of orders. This api may change in the future.
Header
| Field | Description |
|---|---|
Accept | application/json |
Content-Type | application/json |
Path Variable
| Field | Type | Description |
|---|---|---|
partner_code | String | Required, Partner code |
Query Params
| Field | Type | Description |
|---|---|---|
date | String | Payment order creation date,which is formatted in 'yyyyMMdd' ,UTC+10. Query all orders if not provided |
status | String | Order status
|
page | int | Page number. start with 1 |
limit | int | Rows per page |
time | Long | Required, UTC timestamp in milliseconds |
nonce_str | String | Required, Random string |
sign | String | Required, Sign |
ROOT
| Field | Type | Description |
|---|---|---|
return_code | String | Execution result |
data | JSON[] | Orders list |
pagination | JSON | Pagination information |
analysis | JSON | Payment analysis |
data
| Field | Type | Description |
|---|---|---|
channel_order_id | String | Channel(such as Wechat、Alipay) Order Id |
order_id | String | GlobePay Order ID |
partner_order_id | String | Partner Order ID |
total_fee | int | Order amount |
real_fee | int | Actual paid amount |
payment | String | via channel: Alipay, Wechat |
currency | String | Currency |
create_time | String | Time when order is created, which is formatted in 'yyyy-MM-dd HH:mm:ss', UTC+10 |
pay_time | String | Time when order is paid, which is formatted in 'yyyy-MM-dd HH:mm:ss', UTC+10. will be null if not paid |
status | String | order status
|
order_body | String | Order description |
gateway | String |
|
partner_code | String | Partner code |
partner_name | String | Partner name |
refund_fee | String | Total refund amount of this order |
pagination
| Field | Type | Description |
|---|---|---|
page | int | Page number,start with 1 |
limit | int | Rows per page |
totalCount | int | Total rows |
totalPages | int | Total pages |
analysis
| Field | Type | Description |
|---|---|---|
order_count | int | Order count of successful payment (including orders which have refunds) |
total_fee | int | Total amount |
real_fee | int | Actual paid amount |
ERROR
| Name | Description |
|---|---|
return_code | Error Code |
return_msg | Error Description |
Error Code
| Name | Description |
|---|---|
SYSTEMERROR | Exception inside system |
INVALID_SHORT_ID | Partner code is invalid or there is no partner associated with this code |
SIGN_TIMEOUT | Sign expired, the difference between time and the server time is more than 5 minutes |
INVALID_SIGN | Invalid sign |
PARAM_INVALID | Parameters are invalid. See return_msg for more details. |
NOT_PERMITTED | Gateway payment permission has not been enabled for this partner |
INVALID_CHANNEL | Channel name is not available, check the Capitalize |