Skip to main content

Order List

Request address

Sandbox : https://sandbox.j-pay.net/pay/order/list

Request parameters

Parameter NameTypeRequired(Y or N)Sign(Y or N)Parameter Description
pay_memberidStringYYMerchant ID
pageStringNYPage number, default 1
sizeStringNYPage size, default 20
pay_applydate_startStringNYOrder creation start time(YYYY-mm-dd)
pay_applydate_endStringNYOrder creation end time(YYYY-mm-dd)
signStringYNSee MD5 signature example

Return parameters

Parameter NameTypeParameter Description
listArrayMerchant list
totalNumberTotal count
pageNumberCurrent page
sizeNumberPage size

list[]

Parameter NameTypeParameter Description
transaction_idStringTransaction order number
pay_memberidStringMerchant ID
pay_orderidStringMerchant order number
pay_applydateStringOrder creation time
pay_bankcodeStringPayment bank code
pay_notifyurlStringNotify URL
pay_callbackurlStringCallback URL
pay_amountStringOrder amount
pay_currencyStringCurrency
pay_urlStringMerchant website URL
pay_productnameStringProduct json string
pay_customernameStringCustomer name
pay_street_address1StringStreet address
pay_cityStringCity
pay_stateStringState / Province
pay_postcodeStringPostal code
pay_country_iso_code_2StringCountry code (ISO 3166-1 alpha-2), e.g. US
pay_email_addressStringCustomer email
pay_telephoneStringCustomer phone number
pay_ipStringCustomer IP
trade_stateStringOrder status (converted). NOTPAY: unpaid
PENDING: processing
FAIL: failed
SUCCESS: paid
REFUND: refund
refund_amountStringOrder refund amount
refund_listArrayRefund list
pay_card_prefixStringCard number first 6 digits
pay_card_last4StringCard number last 4 digits
pay_typeStringpayment type: subscribes
card
apm
pay_methodStringsuch as Alipay, Apple Pay
refund_list[]
Parameter NameTypeParameter Description
orderidStringMerchant order number
transaction_idStringTransaction order number
refund_orderidStringRefund order number
amountStringOrder amount
refund_amountStringRefund amount
refund_currencyStringRefund currency
pay_applydateStringOrder creation time
apply_dateStringRefund application time
refund_dateStringRefund time

Example Request

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);
});

返回示例

{
"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"
}