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

# View payments (beta)

`GET /payments`

## Request

- Base URL: `https://nexhealth.info`
- URL: `https://nexhealth.info/payments`
- Auth: API key in header `Authorization`

> 🚧 Beta
>
> Send `Nex-Api-Version: v3.1.0` to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

> **Changed from v3.0.0:** Adds query param `paid_since`.

This endpoint returns the ledger payments for the specified location, narrowed down by the configured filters. At least one of the following filters must be provided: provider_id, patient_id, guarantor_id, claim_id, transaction_id, updated_since, or paid_since.

## 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
- `paid_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

- APIV31EntitiesLedgerPaymentCollectionResponseWithCursor: API_V31_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` APIV31EntitiesLedgerPayment[]
    - `id` integer: Resource ID
    - `foreign_id` string: Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it.
    - `location_id` integer: The ID of the location that this item is for
    - `patient_id` integer: The ID of the patient that this item is for
    - `guarantor_id` integer: The ID of the guarantor that this item is for
    - `provider_id` integer: The ID of the provider that this item is for
    - `updated_at` string, date-time: Last updated time for item in UTC
    - `description` string: A description of the item
    - `deleted_at` string, date-time: 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: The UTC date payment was made
    - `transaction_id` string: The ID of the transaction for this payment
    - `charge_id` integer: The ID of the charge for this payment
    - `claim_id` integer: The ID of the insurance claim for this payment
    - `payment_plan_id` integer: The ID of the payment plan associated with this payment
    - `insurance_plan_id` integer: The ID of the insurance plan associated with this payment
    - `payment_type_id` integer: 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.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta.md) - [All operations](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta/llms.txt) - [OpenAPI document](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta/revisions/93cb4af790a5?raw)