---
title: "View payments"
method: GET
path: "/payments"
tags: ["Payments"]
---

# View payments

`GET /payments`

This endpoint returns the ledger payments for the specified location, narrowed down by the configured filters (at least one filter is required)

## Query parameters

- `subdomain` string, required
- `location_id` integer, required
- `patient_id` integer
- `provider_id` integer
- `guarantor_id` integer
- `charge_id` integer
- `claim_id` integer
- `transaction_id` string
- `updated_since` string, date-time
- `include_deleted` boolean
- `sort` string
- `start_cursor` string
- `end_cursor` string
- `per_page` integer

## Headers

- `Nex-Api-Version` string, required

## Response `200`

Successful

- APIV20240412EntitiesLedgerPaymentCollectionResponseWithCursor — API_V20240412_Entities_Ledger_Payment_Collection_Response_WithCursor model
  - `code` boolean — Indicates the success or failure of the request
  - `description` string — Additional context on the request to help with debugging.
  - `error` string[] — Any errors that occur during the execution of the request.
  - `data` APIV20240412EntitiesLedgerPayment[]
    - `id` integer — Resource id
    - `foreign_id` string — Unique identifier of this resource from the integrated system
    - `location_id` integer, nullable — The ID of the location that this item is for
    - `patient_id` integer, nullable — The ID of the patient that this item is for
    - `guarantor_id` integer, nullable — The ID of the guarantor that this item is for
    - `provider_id` integer, nullable — The ID of the provider that this item is for
    - `updated_at` string, date-time — Last updated time for item in UTC
    - `description` string, nullable — A description of the item
    - `deleted_at` string, date-time, nullable — Deleted time for item in UTC
    - `payment_amount` APIV2EntitiesPrice
      - `amount` string — The currency value, in whole units (e.g. dollars)
      - `currency` string — The ISO currency code
    - `paid_at` string, date, nullable — The UTC date payment was made
    - `transaction_id` string, nullable — The ID of the transaction for this payment
    - `charge_id` integer, nullable — The ID of the charge for this payment
    - `claim_id` integer, nullable — The ID of the insurance claim for this payment
    - `payment_plan_id` integer, nullable — The ID of the payment plan associated with this payment
    - `insurance_plan_id` integer, nullable — The ID of the insurance plan associated with this payment
    - `payment_type_id` integer, nullable — The ID of the payment type for this payment
  - `page_info` object — Pagination information that can be used for fetching previous and next pages.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.net/nexhealth/apis/nexhealth-api.md) · [All operations](https://skmtc.net/nexhealth/apis/nexhealth-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nexhealth/nexhealth-api/revisions/a180e830b672/schema)