Get a payment
- Sandbox: available
- On your own host? Choose https://{host} in the playground.
Reads one insurer's payment and how it splits across claims.
Scope: the caller's project, with PATIENT_BILLING_ENABLED on.
Behaviour
- Your access policy must grant
patient_billing_claimsreadand let you read every patient whose claim it pays, else 404PAYMENT_NOT_FOUND.
Example
curl 'https://api.sandbox.ovok.com/v1/patient-billing/payments/<paymentId>' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'bearerAuthorizationBearer <JWT>paymentId*stringThe payment id.
^[A-Za-z0-9\-.]{1,64}$The payment and how it splits across claims.
application/json- response
id*stringversion*stringSend it as If-Match: W/"<version>" to change only this version.
identifier*clinicId*stringinsurer*paidOn*stringamount*disposition*stringallocations*array<>curl -X GET 'https://api.sandbox.ovok.com/v1/patient-billing/payments/string'{ "id": "string", "version": "string", "identifier": { "system": "string", "value": "string" }, "clinicId": "string", "insurer": { "id": "string", "ik": "string", "name": "string" }, "paidOn": "string", "amount": { "value": 0, "currency": "string" }, "disposition": "string", "allocations": [ { "claimId": "string", "amount": { "value": 0, "currency": "string" } } ]}Record an insurer's payment POST
Records an insurer's payment to a clinic from its remittance: a FHIR `PaymentReconciliation` that splits it across the claims it pays, and a `PaymentNotice` per claim. **Scope:** the caller's project, with `PATIENT_BILLING_ENABLED` on. ## Behaviour - Your access policy must grant `patient_billing_claims` `update` and let you read each claim's patient, else **403** `PATIENT_BILLING_NOT_ALLOWED` or **404** `CLAIM_NOT_FOUND`. - Every claim must be active, of the clinic `clinicId` names, and to the same insurer, which is the payer. The allocations must add up to `amount`, in its currency. Else **422** `PAYMENT_ALLOCATION_INVALID`. - Amounts are more than zero. Every claim's total must be in the payment's currency. - `identifier` is the insurer's id for the payment: the same identifier at the same clinic again answers the payment already recorded, with **200**. A new one answers **201** with `Location: /v1/patient-billing/payments/<id>`. - It is recorded holding the locks of the patients whose claims it pays, so none is withdrawn meanwhile; another change to one of them running at the same time answers **409**; send it again. ## Example ```bash curl -X POST 'https://api.sandbox.ovok.com/v1/patient-billing/payments' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \ -H 'Content-Type: application/json' \ -d '{ "identifier": { "system": "https://example.com/remittances", "value": "R-2026-11-0042" }, "clinicId": "<clinicId>", "paidOn": "2026-11-30", "amount": { "value": 31.62, "currency": "EUR" }, "allocations": [{ "claimId": "<claimId>", "amount": { "value": 31.62, "currency": "EUR" } }], "disposition": null }' ```
Get patient sharing settings GET
Returns the caller's project settings for data sharing: whether patients may share their data with each other, and whether the patient and practitioner invites (`/v1/invites`) are on. **Scope:** the caller's project (from the token). ## Behaviour - `enabled`: patient-to-patient sharing is on. Off unless an admin turned it on. - `accessPolicyId`: the ID of the read-only template AccessPolicy every patient-to-patient share points at, or `null` while none has been created. - `practitionerSharingEnabled`: the `/v1/invites` routes are on. Off unless an admin turned it on. - `practitionerAlertDigest`: whether the clinician alert digest is on and how many hours apart it goes out. Off, every 6 hours, unless an admin set it. ## Example ```bash curl -X GET 'https://api.sandbox.ovok.com/v1/patient-sharing/settings' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ``` **Who can call it:** a project admin. See [roles](/access-policies#who-can-call-a-route).