Order List
Request address
Sandbox : https://sandbox.j-pay.net/pay/order/list
Request parameters
| Parameter Name | Type | Required(Y or N) | Sign(Y or N) | Parameter Description |
|---|---|---|---|---|
| pay_memberid | String | Y | Y | Merchant ID |
| page | String | N | Y | Page number, default 1 |
| size | String | N | Y | Page size, default 20 |
| pay_applydate_start | String | N | Y | Order creation start time(YYYY-mm-dd) |
| pay_applydate_end | String | N | Y | Order creation end time(YYYY-mm-dd) |
| sign | String | Y | N | See MD5 signature example |
Return parameters
| Parameter Name | Type | Parameter Description |
|---|---|---|
| list | Array | Merchant list |
| total | Number | Total count |
| page | Number | Current page |
| size | Number | Page size |
list[]
| Parameter Name | Type | Parameter Description |
|---|---|---|
| transaction_id | String | Transaction order number |
| pay_memberid | String | Merchant ID |
| pay_orderid | String | Merchant order number |
| pay_applydate | String | Order creation time |
| pay_bankcode | String | Payment bank code |
| pay_notifyurl | String | Notify URL |
| pay_callbackurl | String | Callback URL |
| pay_amount | String | Order amount |
| pay_currency | String | Currency |
| pay_url | String | Merchant website URL |
| pay_productname | String | Product json string |
| pay_customername | String | Customer name |
| pay_street_address1 | String | Street address |
| pay_city | String | City |
| pay_state | String | State / Province |
| pay_postcode | String | Postal code |
| pay_country_iso_code_2 | String | Country code (ISO 3166-1 alpha-2), e.g. US |
| pay_email_address | String | Customer email |
| pay_telephone | String | Customer phone number |
| pay_ip | String | Customer IP |
| trade_state | String | Order status (converted). NOTPAY: unpaid PENDING: processing FAIL: failed SUCCESS: paid REFUND: refund |
| refund_amount | String | Order refund amount |
| refund_list | Array | Refund list |
| pay_card_prefix | String | Card number first 6 digits |
| pay_card_last4 | String | Card number last 4 digits |
| pay_type | String | payment type: subscribes card apm |
| pay_method | String | such as Alipay, Apple Pay |
refund_list[]
| Parameter Name | Type | Parameter Description |
|---|---|---|
| orderid | String | Merchant order number |
| transaction_id | String | Transaction order number |
| refund_orderid | String | Refund order number |
| amount | String | Order amount |
| refund_amount | String | Refund amount |
| refund_currency | String | Refund currency |
| pay_applydate | String | Order creation time |
| apply_date | String | Refund application time |
| refund_date | String | Refund time |
Example Request
- Javascript
- Php
- Python
import { md5 } from "js-md5";
import axios from "axios";
const KEY = "7e4nicn14nhyup146dfbi8hpnpus9juz";
const MEMBER_ID = "10010";
let query = {
'pay_memberid': '10130',
'page': 1,
'size': 15,
};
let signData = [];
Object.keys(query)
.sort()
.forEach((key) => signData.push(`${key}=${query[key]}`));
signData.push(`key=${KEY}`);
Object.assign(query, {
sign: md5(signData.join("&")).toUpperCase(),
});
axios
.request({
url: "https://sandbox.j-pay.net/pay/trade/query",
method: "post",
headers: {
"Content-Type": "application/x-www-form-urlencoded",
},
data: query,
})
.then(({ data }) => {
console.log("success", JSON.stringify(data));
})
.catch((error) => {
console.log("error", error);
});
Comming soon...
Comming soon...
返回示例
- Success
- Error
{
"transaction_id": "O20240723141428",
"pay_memberid": "10005",
"pay_orderid": "OUT_20240723141428",
"pay_applydate": "2024-07-23 14:14:28",
"pay_bankcode": "SUCCESS",
"pay_notifyurl": "https://example.com/notify",
"pay_callbackurl": "https://example.com/callback",
"pay_amount": "1.80",
"pay_currency": "USD",
"pay_url": "https://sandbox.j-pay.net/pay/xxxxx",
"pay_productname": "Product Name",
"pay_customername": "Customer Name",
"pay_street_address1": "Street address",
"pay_city": "City",
"pay_state": "State",
"pay_postcode": "100000",
"pay_country_iso_code_2": "US",
"pay_email_address": "[email protected]",
"pay_telephone": "123456789",
"pay_ip": "127.0.0.1",
"trade_state": "SUCCESS"
}
{ msg: 'message', status: 'error' }