Skip to main content
POST
Send a payment advice

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

A unique value you choose for this request, such as a UUID. Sending the same key again returns the first answer instead of doing the work twice, so a timed-out request is safe to retry. Reusing a key for a different request is refused with 409 idempotency_key_conflict, and retrying while the first request is still running with 409 idempotency_key_reused. See Retries and idempotency.

Minimum string length: 1

Path Parameters

clinic_id
string<uuid>
required

Body

application/json

A payment advice. Each allocation names a claim of that insurer that is awaiting payment and an amount no larger than what the claim still owes; the allocations may not add up to more than amount. currency, if sent, must be the clinic's currency.

insurance_company_id
string<uuid>
required
paid_on
string<date>
required
amount
number
required
method
enum<string>
required
Available options:
bank_transfer,
eft,
cheque,
other
currency
string
Maximum string length: 10
reference
string
Maximum string length: 200
allocations
object[]
Maximum array length: 500

Response

Created - an advice, status advised.

data
object
required

What an insurer says it paid the clinic. It is an ADVICE for clinic staff to reconcile: it never changes a claim, the clinic's payments or its books. status is advised until staff act on it.

idempotent_replay
boolean

Present and true when this Idempotency-Key was already used and the original answer is returned.