List orders

List orders

POST/pay/order/list

Base URLhttps://sandbox.j-pay.net/pay/order/list

Query a paginated list of orders for a merchant under the agent account.

Headers

Agent-Merchant-Idstringrequired

Agent merchant ID. The request is signed with the agent API key.

Bodyapplication/x-www-form-urlencoded

pay_memberidstringrequiredsign

Merchant ID to query orders for.

pagestringsign

Page number. Default: 1.

sizestringsign

Page size. Default: 20.

pay_applydate_startstring, YYYY-MM-DDsign

Order creation start date (inclusive).

pay_applydate_endstring, YYYY-MM-DDsign

Order creation end date (inclusive).

signstringrequired

See MD5 signature algorithm

Response parameters

totalnumber

Total number of matching orders.

pagenumber

Current page number.

sizenumber

Page size.

listarray

Order object in the list array.

list.transaction_idstring

Platform transaction ID.

list.pay_memberidstring

Merchant ID.

list.pay_orderidstring

Merchant order ID.

list.pay_applydatestring

Order creation time.

list.pay_bankcodestring

Payment bank code.

list.pay_notifyurlstring

Async notification URL.

list.pay_callbackurlstring

Return URL after payment.

list.pay_amountstring

Order amount.

list.pay_currencystring

Currency code.

list.pay_urlstring

Payment page URL.

list.pay_productnamestring

Product name or JSON string.

list.pay_customernamestring

Customer name.

list.pay_street_address1string

Street address.

list.pay_citystring

City.

list.pay_statestring

State or province.

list.pay_postcodestring

Postal code.

list.pay_country_iso_code_2string, ISO 3166-1 alpha-2

Country code (e.g., US).

list.pay_email_addressstring

Customer email.

list.pay_telephonestring

Customer phone number.

list.pay_ipstring

Customer IP address.

list.trade_statestring, NOTPAY | PENDING | FAIL | SUCCESS | REFUND

Order status: NOTPAY — unpaid; PENDING — processing; FAIL — failed; SUCCESS — paid; REFUND — refunded.

list.refund_amountstring

Total refunded amount.

list.refund_listarray

Refund records. Each item matches the refund_list object below.

list.pay_card_prefixstring

First 6 digits of the card number.

list.pay_card_last4string

Last 4 digits of the card number.

list.pay_typestring, subscribes | card | apm

Payment type.

list.pay_methodstring

Payment method (e.g., Alipay, Apple Pay).

refund_listarray

Refund object in each order's refund_list array.

refund_list.orderidstring

Merchant order ID.

refund_list.transaction_idstring

Platform transaction ID.

refund_list.refund_orderidstring

Refund order ID.

refund_list.amountstring

Original order amount.

refund_list.refund_amountstring

Refund amount.

refund_list.refund_currencystring

Refund currency.

refund_list.pay_applydatestring

Order creation time.

refund_list.apply_datestring

Refund application time.

refund_list.refund_datestring

Refund completion time.

POST/pay/order/list

Request examplecurlJavascript

curl

curl --request POST \
  --url https://sandbox.j-pay.net/pay/order/list \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'Agent-Merchant-Id: 10010' \
  --data 'pay_memberid=10130&page=1&size=15&sign=YOUR_SIGN'

Response exampleSuccessError

{
"list": [
  {
    "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"
  }
],
"total": 1,
"page": 1,
"size": 15
}