Skip to main content
POST
Record a payment

Headers

auth
string
required

Path Parameters

admission_id
string
required

Id of the IPD admission.

Minimum string length: 1

Body

application/json
amount
string
required

Amount received. Decimal string, for example "1500.00".

Pattern: ^-?\d+(\.\d+)?$
mode
required

Payment method.

Available options:
cash
referenceNumber
string

Transaction / cheque reference.

notes
string
idempotencyKey
string

The same key records the payment once.

Response

A payment: id, amount, mode, referenceNumber, status, receiptNumber, createdAt, …

A payment: id, amount, mode, referenceNumber, status, receiptNumber, createdAt, …