# List payment requests

Retrieve a paginated list of payment requests for the location. Supports filtering by patient, status, and date range.

Endpoint: GET /partner/v2/account/{accountId}/location/{locationId}/payment-request
Version: 2.0
Security: PartnerOAuth

## Query parameters:

  - `patientId` (integer)
    Filter by patient ID

  - `status` (string)
    Filter by status
    Enum: "PENDING", "PARTIALLY_PAID", "PAID", "VOIDED", "EXPIRED"

  - `appointmentId` (integer)
    Filter by appointment ID

  - `createdAfter` (string)
    Start of creation date range (ISO 8601)

  - `createdBefore` (string)
    End of creation date range (ISO 8601)

  - `cursor` (string)
    Pagination cursor from previous response

  - `limit` (integer)
    Number of results per page (max 100)
    Example: 20

## Path parameters:

  - `accountId` (integer, required)
    Account identifier

  - `locationId` (integer, required)
    Location identifier

## Response 200 fields (application/json):

  - `nextCursor` (string)
    Opaque cursor for fetching the next page. Null if no more results.

  - `paymentRequests` (array)
    List of payment requests in this page

  - `paymentRequests.amountCents` (integer)
    Amount requested in cents
    Example: 5000

  - `paymentRequests.amountDisplay` (string)
    Amount requested formatted
    Example: "$50.00"

  - `paymentRequests.amountPaidCents` (integer)
    Amount paid so far in cents

  - `paymentRequests.amountPaidDisplay` (string)
    Amount paid formatted
    Example: "$0.00"

  - `paymentRequests.amountRemainingCents` (integer)
    Amount remaining in cents
    Example: 5000

  - `paymentRequests.amountRemainingDisplay` (string)
    Amount remaining formatted
    Example: "$50.00"

  - `paymentRequests.appointmentId` (integer)
    Associated appointment ID
    Example: 111

  - `paymentRequests.createdAt` (string)
    Creation timestamp
    Example: "2025-01-15T09:00:00Z"

  - `paymentRequests.description` (string)
    Description/memo for the payment
    Example: "Copay for office visit"

  - `paymentRequests.expiresAt` (string)
    When the request expires
    Example: "2025-02-15T23:59:59Z"

  - `paymentRequests.id` (integer)
    Unique payment request identifier
    Example: 12345

  - `paymentRequests.invoiceId` (integer)
    Associated invoice ID
    Example: 222

  - `paymentRequests.paidAt` (string)
    When payment was completed
    Example: "2025-01-16T14:30:00Z"

  - `paymentRequests.patientId` (integer)
    Patient ID
    Example: 67890

  - `paymentRequests.patientName` (string)
    Patient name
    Example: "John Doe"

  - `paymentRequests.paymentUrl` (string)
    Secure payment link for patient
    Example: "https://pay.lobbie.com/abc123"

  - `paymentRequests.status` (string)
    Request status
    Enum: "PENDING", "PARTIALLY_PAID", "PAID", "VOIDED", "EXPIRED"

  - `paymentRequests.updatedAt` (string)
    Last update timestamp
    Example: "2025-01-15T09:00:00Z"

  - `paymentRequests.voidReason` (string)
    Reason for voiding (if voided)
    Example: "Patient paid in person"


## Response 400 fields

## Response 401 fields

## Response 403 fields