---
title: "List payment pages"
method: GET
path: "/v1/payment_pages"
tags: ["Payment Pages"]
---

# List payment pages

`GET /v1/payment_pages`

Returns a paginated list of payment pages.

## Query parameters

- `limit` integer — Number of payment pages to return per page (max 100, default 100)
- `offset` integer — Number of payment pages to skip
- `status` 'UNPAID' | 'PAID' | 'EXPIRED' | 'CANCELED' — Filter by payment page status

## Response `200`

Success

- object — A list of payment pages
  - `status` 'SUCCEEDED', required
  - `data` object[], required
    - `id` string, required
    - `currency` 'USD' | 'AUD' | 'CAD' | 'CHF' | 'DKK' | 'EUR' | 'GBP' | 'HKD' | 'JPY' | 'NOK' | 'NZD' | 'PLN' | 'SEK' | 'SGD' | 'TWD' | 'KRW' | 'SOL' | 'USDC' | 'USDT' | 'HONEY' | 'EURC', required
    - `amount` number, required
    - `lineItems` object[]
      - `productId` string
      - `name` string, required
      - `currency` 'USD' | 'AUD' | 'CAD' | 'CHF' | 'DKK' | 'EUR' | 'GBP' | 'HKD' | 'JPY' | 'NOK' | 'NZD' | 'PLN' | 'SEK' | 'SGD' | 'TWD' | 'KRW' | 'SOL' | 'USDC' | 'USDT' | 'HONEY' | 'EURC', required
      - `amount` number, required
      - `price` number, required
      - `quantity` number, required
      - `description` string
      - `images` string[]
    - `clientReferenceId` string
    - `successReturnUrl` string
    - `failReturnUrl` string
    - `createdAt` number, required
    - `url` string, required
    - `status` 'UNPAID' | 'PAID' | 'EXPIRED' | 'CANCELED', required
    - `transactionNetwork` string
    - `transactionFromAddress` string
    - `transactionToken` string
    - `transactionAmount` string
    - `transactionHash` string
    - `isRecurring` boolean, required
    - `billingEmail` string
    - `paymentType` 'crypto_wallet' | 'crypto_deposit' | 'card' | 'upi' | 'stripe_normal' | 'stripe_recurring' | 'onramp_money' | 'moonpay' | 'onmeta_in' | 'stripe_onramp' | 'solana_deposit' | 'evm_deposit' | 'evm_wallet' | 'solana_wallet' | 'fiat' | 'transfer' | 'solana' | 'contract'
    - `refundStatus` 'processing' | 'succeeded' | 'failed'
    - `refundOperator` string
    - `refundReason` string
    - `displayStatus` 'UNPAID' | 'SUCCESSFUL' | 'REFUNDING' | 'REFUNDED' | 'DISPUTED' | 'EXPIRED' | 'CANCELED'
    - `customer` object
      - `id` string, required
      - `referenceId` string, required
      - `email` string
    - `payinDetails` object
      - `type` 'card' | 'crypto' | 'apple_pay' | 'google_pay'
      - `amount` number
      - `grossAmount` number
      - `currency` string
      - `scheme` string — See `Payment.scheme` — may contain legacy un-normalized values from historical documents.
      - `bin` string
      - `last4` string
      - `issuer` string
      - `issuerCountry` string
      - `cardType` 'CREDIT' | 'DEBIT' | 'PREPAID' | 'CHARGE' | 'DEFERRED DEBIT'
      - `acquirerReferenceNumber` string
      - `firstName` string
      - `lastName` string
      - `expiryMonth` number
      - `expiryYear` number
      - `threeDS` object
        - `requested` boolean, required
        - `flow` 'CHALLENGE' | 'FRICTIONLESS'
        - `eci` string
        - `authentication_status_code` string
      - `taxAmount` number
      - `taxProductCategory` string
      - `taxZipcode` string
      - `taxCountry` string
      - `network` string
      - `token` string
      - `transactionHash` string
      - `fromAddress` string
    - `invoice` string
  - `hasMore` boolean

## Other responses

- `400` — Bad request
- `401` — Unauthorized

---

[API](https://skmtc.dev/breeze/apis/breeze-api.md) · [All operations](https://skmtc.dev/breeze/apis/breeze-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/breeze/breeze-api/revisions/8911892bdf29/schema)