API Reference

View payments

get
https://nexhealth.info/payments

This endpoint returns a list of payments. You can filter by provider_id, patient_id, guarantor_id, claim_id, transaction_id, or updated_since. You must provide at least one filter.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Used to scope the request to the specified institution

int32
required

Used to scope the request to the specified location

int32

Filter by patient

int32

Filter by provider

int32

Filter by guarantor

int32

Filter by charge

int32

Filter by claim

string

Filter by transaction

date-time

Filter for charges updated since a specific time

boolean
Defaults to false

Include deleted payments

string
Defaults to null

Optional comma-separated string of fields to sort on. Include a leading dash for descending order.

Available fields:

  • updated_at
  • -updated_at
string

First item of the current page. Starts empty

string

Last item of the current page. Starts empty

int32
Defaults to 5

Number of results to return per page. Maximum allowed amount is 1000.

Headers
string
required
Defaults to v20240412

The NexHealth API version

Responses

Updated about 1 month ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago