# List payments

Returns a paginated list of Payments for the specified site. Supports filtering and sorting.

Endpoint: GET /site/{siteId}/ahds/v1/payment
Version: 1.0
Security: bearer

## Path parameters:

  - `siteId` (number, required)
    Site identifier

## Query parameters:

  - `page` (number)
    Page number (0-indexed)

  - `pageSize` (number)
    Number of items per page

  - `sortBy` (string)
    Field to sort by
    Enum: "createdAt", "updatedAt", "allocatedAmount", "amount", "availableAmount", "cashAmount", "cashChange", "comments", "currency", "paymentDate", "paymentDetails", "roundingFactor"

  - `sortOrder` (string)
    Sort order
    Enum: "asc", "desc"

  - `clientId` (string)
    Identifier of the client associated with this payment.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `comments` (string)
    Internal comments or notes about the payment.

  - `currency` (string)
    ISO 4217 currency code for the payment amount.

  - `isActive` (boolean)
    Indicates whether the payment record is active.

  - `ownershipId` (string)
    Identifier for the owning organization or practice.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `paymentDetails` (string)
    Free-text or structured details about the payment method (e.g., last 4 digits, reference number).

  - `paymentMethod` (string)
    Method used to make the payment.
    Enum: "cash", "card", "check", "bank_transfer", "online", "other"

  - `status` (string)
    Lifecycle status of the payment.
    Enum: "pending", "completed", "cancelled", "refunded", "failed"


## Response 200 fields

## Response 401 fields