> ## Documentation Index
> Fetch the complete documentation index at: https://docs.platform.chipper.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List payment pages



## OpenAPI

````yaml /api-reference/openapi.json get /v1/payment-pages
openapi: 3.1.0
info:
  title: Chipper Platform API
  version: '2026-02-20'
  description: >-
    Payouts, collections, and FX across African rails — bank, mobile money, and
    stablecoins — through one API.
servers:
  - url: https://sandbox-api.platform.chipper.ai
    description: Sandbox (sk_test_ keys — simulated rails, no real money)
  - url: https://api.platform.chipper.ai
    description: Production (sk_live_ keys)
security:
  - bearerAuth: []
paths:
  /v1/payment-pages:
    get:
      tags:
        - Payment pages
      summary: List payment pages
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            description: Page size, 1–100.
            example: 20
          required: false
          name: limit
          in: query
        - schema:
            type: string
            description: The `nextCursor` from the previous page.
          required: false
          name: cursor
          in: query
        - schema:
            type: string
            enum:
              - active
              - closed
          required: false
          name: status
          in: query
      responses:
        '200':
          description: Newest first.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PaymentPage'
                  hasMore:
                    type: boolean
                  nextCursor:
                    type:
                      - string
                      - 'null'
                    description: >-
                      Pass as `cursor` to fetch the next page. Null on the last
                      page.
                required:
                  - data
                  - hasMore
                  - nextCursor
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: unauthorized
                message: Invalid API key
                requestId: req_q7vei435zifs51ia0lqr
      security:
        - bearerAuth: []
components:
  schemas:
    PaymentPage:
      type: object
      properties:
        id:
          type: string
          description: 'Sandbox ids carry a stack marker: `pp_test_…`.'
          example: pp_x7kd92mfn3qp8wz4t6vb
        url:
          type: string
          description: The reusable hosted checkout URL — share it with anyone.
          example: >-
            https://chipper-platform-checkout-web.onrender.com/pp_x7kd92mfn3qp8wz4t6vb
        amount:
          type:
            - string
            - 'null'
          description: >-
            Fixed price, or null for an open-amount page where the payer
            chooses.
          example: '250.00'
        currency:
          type: string
          example: GHS
        title:
          type: string
          example: Zouk Inc. — Donations
        description:
          type:
            - string
            - 'null'
          example: Support our Accra chapter.
        status:
          type: string
          enum:
            - active
            - closed
          description: >-
            A page past `expiresAt` keeps status `active` but rejects new
            checkouts.
        allowedMethods:
          type: array
          items:
            type: string
            enum:
              - mobile_money
              - bank_transfer
              - crypto
          description: Rails the payer may choose from on the hosted checkout.
          example:
            - mobile_money
            - bank_transfer
        allowedCryptoAssets:
          type:
            - array
            - 'null'
          items:
            type: string
          description: >-
            Stablecoins accepted when `crypto` is allowed. Null = any supported
            asset.
          example: null
        customFields:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                example: orderNumber
              type:
                type: string
                example: text
              required:
                type: boolean
            required:
              - name
              - type
              - required
          description: Extra inputs the payer fills in at checkout.
        branding:
          type:
            - object
            - 'null'
          properties:
            logoUrl:
              type: string
              format: uri
            accentColor:
              type: string
              example: '#6642D1'
            businessName:
              type: string
              example: Zouk Inc.
          description: >-
            Shown on the hosted checkout. Null falls back to your organization
            defaults.
          example:
            accentColor: '#6642D1'
            businessName: Zouk Inc.
        redirectUrl:
          type:
            - string
            - 'null'
          description: Where the payer is sent after paying.
          example: https://zouk.example/thanks
        metadata:
          type: object
          additionalProperties: {}
        expiresAt:
          type:
            - string
            - 'null'
          format: date-time
          description: Null = never expires.
        createdAt:
          type: string
          format: date-time
          example: '2026-08-01T09:12:44.000Z'
        updatedAt:
          type: string
          format: date-time
        paymentCount:
          type: integer
          description: Child links that reached `paid`.
          example: 12
        totalCollected:
          type: string
          description: Gross amount received across all paid child links.
          example: '3000.00'
      required:
        - id
        - url
        - amount
        - currency
        - title
        - description
        - status
        - allowedMethods
        - allowedCryptoAssets
        - customFields
        - branding
        - redirectUrl
        - metadata
        - expiresAt
        - createdAt
        - updatedAt
        - paymentCount
        - totalCollected
    Error:
      type: object
      properties:
        error:
          type: string
          description: Stable machine-readable code.
        message:
          type: string
          description: Human-readable explanation.
        requestId:
          type: string
          description: Echoed in the x-request-id response header — quote it to support.
      required:
        - error
        - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key: `sk_test_…` (sandbox) or `sk_live_…` (production).'

````