1. WPay
WPay
  • Introduction
  • Signature
  • API Keys
  • Get Started
  • Webhook Service
  • Api Reference
    • Authentication
      • Get Access Token
      • Refresh Access Token
    • WPay
      • Hosted Payment Page
        POST
      • List Payment History
        POST
      • Get Payment Detail
        POST
      • Refund
        POST
      • List Subscriptions
        POST
      • Get Subscription Detail
        POST
      • Cancel Subscription
        POST
      • Get Subscription Bills
        POST
    • Webhook
      • Simulate a Event Call
  • Schemas
    • Schemas
      • RefundOrderDTO
      • RefundPageReq
      • ApiPageApiPageRefundOrderDTO
      • ApiResponseApiPageRefundOrderDTO
      • CancelReq
  1. WPay

List Payment History

Developing
POST
/checkout/w-payment/payments/list
Get a paginated list of payment history, with optional filtering by status, channel, time range, currency, amount, and payment method.

Request

Body Params application/jsonRequired

Example
{
  "pageNum": 1,
  "pageSize": 20,
  "status": 1,
  "channelId": "STRIPE",
  "startTime": "2026-01-01 00:00:00",
  "endTime": "2026-12-31 23:59:59",
  "currency": "USD",
  "amountMin": 10.00,
  "amountMax": 500.00,
  "paymentMethod": "VISA"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/checkout/w-payment/payments/list' \
--header 'Content-Type: application/json' \
--data '{
  "pageNum": 1,
  "pageSize": 20,
  "status": 1,
  "channelId": "STRIPE",
  "startTime": "2026-01-01 00:00:00",
  "endTime": "2026-12-31 23:59:59",
  "currency": "USD",
  "amountMin": 10.00,
  "amountMax": 500.00,
  "paymentMethod": "VISA"
}'

Responses

🟢200成功
application/json
Bodyapplication/json

Example
{
  "retcode": "200",
  "retmsg": null,
  "retdata": {
    "records": [
      {
        "id": 1001,
        "trxNo": "TRX1714012345678",
        "gatewayOrderNo": "cs_xxx",
        "channelId": "STRIPE",
        "status": 1,
        "payMode": "ONETIME",
        "mchOrderNo": "ORD-20240423-001",
        "mchSubscriptionNo": null,
        "amount": 99.99,
        "currency": "USD",
        "description": "Order payment",
        "customerEmail": "user@example.com",
        "createTime": "2026-04-23T10:00:00",
        "payTime": "2026-04-23T10:01:30",
        "processingFee": 2.99,
        "netAmount": 97.00,
        "gatewayAvailableOn": "2026-04-25T00:00:00",
        "paymentMethodLast4": "4242",
        "paymentMethodBrand": "visa",
        "paymentMethodType": "Visa credit card",
        "paymentMethodExpiry": "05/2032",
        "paymentMethodFingerprint": "abc123xyz",
        "cvcCheck": "Passed",
        "zipCheck": "Passed",
        "billingZip": "10001",
        "billingCountry": "US",
        "statementDescriptor": "WPAY*ORDER",
        "source": "Manually entered from Dashboard",
        "redirectUrl": null,
        "errMsg": null
      }
    ],
    "total": 1,
    "pageSize": 20,
    "pageNo": 1
  }
}
Modified at 2026-05-17 23:38:10
Previous
Hosted Payment Page
Next
Get Payment Detail
Built with