---
title: "List payout pages"
method: GET
path: "/v1/payout_pages"
tags: ["Payout Pages"]
---

# List payout pages

`GET /v1/payout_pages`

Returns a paginated list of payout pages. Use the nextCursorToken from the response as cursorToken in the next request to page through results. When hasMore is false, you have reached the last page.

## Query parameters

- `limit` integer
- `cursorToken` string
- `status` string[] — Filter by payout page status. Repeat the parameter to filter by multiple statuses (e.g. status=CREATED&status=PENDING).
- `email` string, email
- `id` string

## Response `200`

Success

- object — A list of payout pages
  - `status` 'SUCCEEDED', required
  - `data` object[], required
    - `id` string, required
    - `email` string, required
    - `clientReferenceId` string, required
    - `status` 'CREATED' | 'PENDING' | 'PROCESSING' | 'PROCESSED' | 'ON_HOLD' | 'REFUNDED' | 'EXPIRED' | 'CANCELLED' | 'REJECTED', required
    - `pendingStatus` 'PENDING_USER_CONFIRMATION' | 'PENDING_USER_ONBOARDING' | 'PENDING_MERCHANT_RELEASE'
    - `createdAt` number, required
    - `customerConfirmedAt` number
    - `sourceAmount` string, required
    - `sourceCurrency` 'USDC' | 'USDCE' | 'USDBC' | 'USDT' | 'EURC' | 'DAI' | 'BUSD' | 'BTC' | 'ETH' | 'BNB' | 'MATIC' | 'POL' | 'AVAX' | 'SOL' | 'TRX' | 'KAP' | 'ARB' | 'CBBTC' | 'PYUSD' | 'SNS' | 'HONEY', required
    - `payoutMethodType` 'BANK_ACCOUNT' | 'CRYPTO_WALLET' | 'CARD'
    - `receipt` object
      - `emailOfframpProcessStartedSent` boolean
      - `receiverNetAmount` number, required
      - `fee` object, required
        - `processingFee` number
        - `cryptoGasFee` number
        - `newUserFee` number
        - `totalFee` number, required
      - `feePayer` 'MERCHANT' | 'CUSTOMER', required
      - `destCurrency` 'USDC' | 'USDCE' | 'USDBC' | 'USDT' | 'EURC' | 'DAI' | 'BUSD' | 'BTC' | 'ETH' | 'BNB' | 'MATIC' | 'POL' | 'AVAX' | 'SOL' | 'TRX' | 'KAP' | 'ARB' | 'CBBTC' | 'PYUSD' | 'SNS' | 'HONEY' | 'USD' | 'AUD' | 'CAD' | 'CHF' | 'DKK' | 'EUR' | 'GBP' | 'HKD' | 'JPY' | 'NOK' | 'NZD' | 'PLN' | 'SEK' | 'SGD' | 'TWD' | 'KRW', required
      - `bankAccount` object
        - `bankAccountId` string, required
        - `bankName` string, required
        - `bankAccountNumberLast4` string, required
        - `bankRoutingNumber` string
        - `achTraceNumber` string
      - `cryptoWallet` object
        - `walletAddress` string, required
        - `destNetwork` 'ETHEREUM' | 'OPTIMISM' | 'BINANCE' | 'POLYGON' | 'ARBITRUM' | 'AVALANCHE' | 'SOLANA' | 'TRON' | 'BASE' | 'BITCOIN', required
        - `destToken` 'USDC' | 'USDCE' | 'USDBC' | 'USDT' | 'EURC' | 'DAI' | 'BUSD' | 'BTC' | 'ETH' | 'BNB' | 'MATIC' | 'POL' | 'AVAX' | 'SOL' | 'TRX' | 'KAP' | 'ARB' | 'CBBTC' | 'PYUSD' | 'SNS' | 'HONEY', required
        - `transactionHash` string
      - `card` object
        - `cardId` string, required
        - `cardLast4` string, required
        - `cardScheme` 'VISA' | 'MASTERCARD' | 'AMERICAN_EXPRESS' | 'DISCOVER', required
    - `rejectionReason` union
      - 'UNDERAGE' | 'UNSUPPORTED_STATE' | 'USER_NAME_MISMATCH' | 'RISKY'
      - 'UNSUPPORTED_STATE' | 'UNDERAGE' | 'GENERIC_REJECTION'
    - `resultCode` string
    - `resultMessage` string
  - `hasMore` boolean
  - `nextCursorToken` string — Pass this value as cursorToken in the next request to fetch the next page. Absent when there are no more items.

## 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)
