v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB
Payments

Create payment

This endpoint enqueues a write-back that records the payment in the integrated health record system

post/payments

Query parameters

subdomainstring required

Used to scope the request to the specified institution

location_idinteger required

Used to scope the request to the specified location

Headers

Nex-Api-Versionstring required

The NexHealth API version

Request body

Example request

{
  "payment": {
    "patient_id": 1,
    "amount": -138,
    "payment_type_id": 10,
    "transaction_id": "API:123456",
    "paid_at": "2024-05-20T21:00:00+00:00",
    "charge_splits": {
      "charge_id_1": -37,
      "charge_id_2": -100
    },
    "provider_splits": {
      "provider_id_1": -0.5,
      "provider_id_2": -0.5
    },
    "notes": "Prepayment for xrays"
  }
}

Response

Create payment