WooshPay OpenAPI
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Back to WooshPay Website
  1. Checkout
  • API Introduction
  • Error Code
  • Payment Intents
    • Create a PaymentIntent
      POST
    • Update a PaymentIntent
      POST
    • Cancel a PaymentIntent
      POST
    • Capture a PaymentIntent
      POST
    • Confirm a PaymentIntent
      POST
    • Retrieve a PaymentIntent
      GET
    • List all PaymentIntents
      GET
    • Search PaymentIntents
      GET
  • Charges
    • Retrieve a charge
      GET
    • List all charges
      GET
  • Payment Methods
    • Create a PaymentMethod
      POST
    • Retrieve a PaymentMethod
      GET
    • Retrieve a Customer's PaymentMethod
      GET
    • Update a PaymentMethod
      POST
    • List PaymentMethods
      GET
    • List a Customer's PaymentMethods
      GET
    • Attach a PaymentMethod to a Customer
      POST
    • Detach a PaymentMethod from a Customer
      POST
  • Refunds
    • Create a refund
    • Retrieve a refund
  • Webhooks
    • Create a Webhook
    • List All Webhooks
    • Retrieve a Webhook
    • Delete a Webhook
    • Update a Webhook
  • Events
    • Types of events
    • Retrieve an event
  • Files
    • Files
    • Create a file
    • Retrieve a file
  • Disputes
    • Retrieve a dispute
    • Update a dispute
    • Close a dispute
    • List all disputes
  • Payouts
    • Beneficiary
      • Create a beneficiary
      • Retrieve a beneficiary
      • List all beneficiaries
      • Update a beneficiary
      • Delete a beneficiary
    • Payouts
      • Create a payout
      • Retrieve a Payout
      • Update a Payout
      • List All Payouts
  • Balance
    • Get balance
  • Products
    • Create a Product
    • Retrieve a product
    • Update a product
    • List all products
  • Prices
    • Create a price
    • Retrieve a price
    • Update a price
  • Payment Links
    • Create a payment link
    • Update a payment link
    • Retrieve payment link
    • List all payment links
    • Retrieve a payment link's line items
  • Checkout
    • 订阅计划升降级与按比例分摊
      • subscription
        • 创建订阅
        • confirm
        • 更新item
        • 支付invoice
    • Create a Session
      POST
    • Expire a Session
      POST
    • Retreive a Session
      GET
    • List All Checkout Sessions
      GET
    • Retrieve a Checkout Session's line items
      GET
    • Expire a Session Copy
      POST
  • Customers
    • Create a customer
    • Retrieve a customer
    • Update a customer
  • Invoices
    • Setup Intents
      • Create a SetupIntent
      • Retrieve a SetupIntent
      • Cancel a SetupIntent
      • List all SetupIntents
      • List all SetupAttempts
      • Update a SetupIntent
      • Confirm a SetupIntent
    • Create an invoice
    • Retrieve an invoice
    • Finalize an invoice
    • Send an invoice for manual payment
    • Delete a draft invoice
    • Void an invoice
    • List all invoices
    • Pay an invoice
  • Invoice Items
    • Create an invoice item
    • Retrieve an invoice item
  • Invoice Line Item
    • Bulk add invoice line items
  • Subscriptions
    • Create a subscription
    • Retrieve a subscription
    • Update a subscription
    • Cancel a subscription
    • List subscriptions
  • Subscription Items
    • Create a subscription item
    • Retrieve a subscription item
    • Delete a subscription item
  • Issuing
    • Authorizations
      • Retrieve an authorization
      • List all authorization
    • Cardholders
      • Create a cardholder
      • Update a cardholder
      • Retrieve a cardholder
      • List all cardholders
    • Cards
      • Create a card
      • Update a card
      • Retrieve a card
      • List all cards
      • Retrieve card remaining limits
    • Transactions
      • Update a transaction
      • Retrieve a transaction
      • List all transactions
  • Coupons
    • Create a Coupon
    • Retrieve a coupon
    • Delete a coupon
  • Promotion Code
    • Create a promotion code
    • Update a promotion code
  • Accounts
    • Retrieve account's paymentmethods
  • Fx Quote
    • Create an FX Quote
  1. Checkout

List All Checkout Sessions

GET
/v1/checkout/sessions/list
Returns a list of Checkout Sessions.

Request

Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
Header Params

Body Params application/json

Example
{
    "created": {
        "gt": "string",
        "gte": "string",
        "lt": "string",
        "lte": "string"
    },
    "ending_before": "string",
    "limit": 0,
    "starting_after": "string",
    "customer": "string",
    "customer_details": {
        "email": "string"
    },
    "payment_intent": "string"
}

Request 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 --request GET 'https://apitest.wooshpay.com/v1/checkout/sessions/list' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "created": {
        "gt": "string",
        "gte": "string",
        "lt": "string",
        "lte": "string"
    },
    "ending_before": "string",
    "limit": 0,
    "starting_after": "string",
    "customer": "string",
    "customer_details": {
        "email": "string"
    },
    "payment_intent": "string"
}'

Responses

🟢200OK
application/json
Body

Example
{
    "object": "\"list\"",
    "url": "string",
    "has_more": true,
    "data": [
        {
            "id": "string",
            "object": "string",
            "amount_subtotal": 0,
            "amount_total": 0,
            "billing_address_collection": "required",
            "cancel_url": "string",
            "client_reference_id": "string",
            "created": 0,
            "currency": "string",
            "customer": "string",
            "customer_email": "string",
            "expires_at": 0,
            "livemode": true,
            "metadata": {},
            "mode": "string",
            "payment_intent": "string",
            "payment_link": "string",
            "payment_method_options": {
                "card": {
                    "request_three_d_secure": "any",
                    "setup_future_usage": "on_session",
                    "capture_method": "string",
                    "tax_id": "string"
                },
                "alipayplus": {
                    "terminal_type": "APP",
                    "os_type": "IOS"
                },
                "alipay_hk": {
                    "terminal_type": "APP",
                    "os_type": "IOS"
                },
                "alipay": {
                    "terminal_type": "APP",
                    "os_type": "IOS"
                },
                "wechat_pay": {
                    "terminal_type": "WEB",
                    "client_ip": "string",
                    "os_type": "IOS",
                    "openid": "string"
                },
                "sepa_debit": {},
                "akulaku": {
                    "terminal_type": "WEB",
                    "os_type": "IOS"
                },
                "truemoney": {
                    "terminal_type": "WEB",
                    "os_type": "IOS"
                },
                "kakaopay": {
                    "terminal_type": "WEB",
                    "os_type": "IOS"
                },
                "shopeepay": {
                    "terminal_type": "string",
                    "os_type": "string"
                },
                "dana": {
                    "terminal_type": "string",
                    "os_type": "string"
                },
                "pix": {
                    "tax_id": "string"
                }
            },
            "payment_method_types": [
                "string"
            ],
            "payment_status": "string",
            "phone_number_collection": {
                "enabled": true
            },
            "shipping_address_collection": {
                "allowed_countries": [
                    "string"
                ]
            },
            "shipping": {
                "address": {
                    "city": "string",
                    "country": "string",
                    "line1": "string",
                    "line2": "string",
                    "postal_code": "string",
                    "state": "string"
                },
                "carrier": "string",
                "name": "string",
                "phone": "string",
                "tracking_number": "string"
            },
            "status": "open",
            "success_url": "string",
            "url": "string",
            "line_items": {},
            "customer_creation": "always",
            "customer_details": {
                "address": {
                    "city": "string",
                    "country": "string",
                    "line1": "string",
                    "line2": "string",
                    "postal_code": "string",
                    "state": "string"
                },
                "email": "string",
                "name": "string",
                "phone": "string"
            }
        }
    ]
}
Modified at 2024-01-31 12:14:00
Previous
Retreive a Session
Next
Retrieve a Checkout Session's line items
Built with