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

# List payments for a merchant

> Returns payments sorted by newest first using cursor pagination. Use `page.nextCursor` as the next `cursor` value. Optional `start` and `end` filters bound `createdAt` inclusively.



## OpenAPI

````yaml /openapi.json get /payments
openapi: 3.0.0
info:
  title: PayGood Merchant API
  description: Server-to-server integration surface for merchant API keys.
  version: '1.0'
  contact: {}
servers:
  - url: https://api-sandbox.paygood.co
    description: Sandbox
  - url: https://api.paygood.co
    description: Production
security: []
paths:
  /payments:
    get:
      tags:
        - payments
      summary: List payments for a merchant
      description: >-
        Returns payments sorted by newest first using cursor pagination. Use
        `page.nextCursor` as the next `cursor` value. Optional `start` and `end`
        filters bound `createdAt` inclusively.
      operationId: PaymentsController_list
      parameters:
        - name: end
          required: false
          in: query
          description: >-
            Inclusive ISO-8601 upper bound for payment `createdAt`. Must be >=
            `start` when both are provided.
          schema:
            example: '2026-03-31T23:59:59.999Z'
            type: string
        - name: start
          required: false
          in: query
          description: Inclusive ISO-8601 lower bound for payment `createdAt`.
          schema:
            example: '2026-03-01T00:00:00.000Z'
            type: string
        - name: cursor
          required: false
          in: query
          description: >-
            Opaque cursor from a previous `page.nextCursor`. Treat as an
            unreadable token.
          schema:
            example: >-
              eyJ2IjoxLCJkYXRhIjp7ImNyZWF0ZWRBdCI6IjIwMjYtMDMtMDFUMTI6MDA6MDAuMDAwWiIsImlkIjoicG10XzAxLi4uIn19
            type: string
        - name: limit
          required: false
          in: query
          description: >-
            Number of items to return. Maximum 100. If omitted, server default
            is used.
          schema:
            example: 25
            type: number
        - name: merchantId
          required: true
          in: query
          description: Merchant TypeID (`mer_...`) to scope the list.
          schema:
            example: mer_01hxy8m1nqk9g3x3y3p0azq2bg
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPaymentsResponseDto'
      security:
        - bearer: []
components:
  schemas:
    ListPaymentsResponseDto:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              paymentId:
                type: string
              idempotencyKey:
                type: string
                minLength: 1
              customerId:
                type: string
              merchantId:
                type: string
              paymentInstrumentId:
                type: string
              priceId:
                type: string
              captureMethod:
                type: string
                enum:
                  - automatic
                  - manual
              description:
                type: string
                minLength: 1
                maxLength: 1000
              metadata:
                type: object
                additionalProperties: {}
              amount:
                type: integer
                minimum: -9007199254740991
                maximum: 9007199254740991
              currency:
                description: Supported currency code (USD, CAD)
                type: string
                minLength: 3
                maxLength: 3
              status:
                type: string
                enum:
                  - pending
                  - authorized
                  - captured
                  - completed
                  - voided
                  - refunded
                  - declined
              createdAt:
                type: string
                format: date-time
                pattern: >-
                  ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
              authorizedAt:
                type: string
                format: date-time
                pattern: >-
                  ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
              capturedAt:
                type: string
                format: date-time
                pattern: >-
                  ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
              voidedAt:
                type: string
                format: date-time
                pattern: >-
                  ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
              processor:
                type: string
                enum:
                  - finix
            required:
              - paymentId
              - idempotencyKey
              - customerId
              - merchantId
              - paymentInstrumentId
              - priceId
              - captureMethod
              - amount
              - currency
              - status
              - createdAt
              - processor
        page:
          type: object
          properties:
            hasMore:
              type: boolean
              description: True when another page exists after this response.
            nextCursor:
              description: >-
                Opaque cursor to pass as the next request `cursor` when
                `hasMore` is true.
              type: string
          required:
            - hasMore
      required:
        - items
        - page
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: merchant_<prefix>_<secret>
      type: http
      description: >-
        Merchant API key bearer token. Legacy wire prefixes `api_key_` and
        `api_` are also accepted.

````