Payment Transaction

The PaymentTransaction resource represents a financial transaction related to a service or product provided, recorded on an invoice

This resource includes details about the amount paid, the payment method, associated patient, and the provider who received the payment. This resource is vital for tracking invoices and managing claims.

Endpoints

Endpoint	Operation	Description
`GET` `/main/PaymentTransaction`	List Payment Transactions	Retrieve a list or collection of payment transaction records in invoices
`GET` `/main/PaymentTransaction/{id}`	Get Payment Transaction	Retrieve an individual payment transaction record

Schema

Property	Description
id	`string` The identifier of this payment transaction
created	`date-time` The payment timestamp
method	`array of objects` The method of the payment transaction e.g. `"Braintree" "Discount" "BPAY"` `"text": "Cash"`
type	`array of objects` The type of payment transaction e.g. `"Deposit" "Failed"` `"text": "Payment"`
priceComponent	`array of objects` The amounts on the payment transaction type `enum` The kind of price component e.g. `"base"` `"surcharge"` `"deduction"` `"tax"` `"informational"` amount `array of objects` The value and currency of the price component
status	`array of objects` The status of the payment transaction
invoice	`Reference(Invoice)` The invoice where this payment transaction applies to `"reference": "/main/Invoice/1234567890"` `"type": "Invoice"` See also: Invoice
subject	`Reference(Patient)` The patient whom the payment transaction was for `"reference": "/main/Patient/123456789"` `"type": "Patient"` See also: Patient
comment	`string` Additional notes on the payment transaction
assignedPractitioner	`Reference(Practitioner)` The practitioner this payment is assigned to (optional, for deposits only) `"reference": "/main/Practitioner/PR-1234567"` `"type": "Practitioner"` See also: Practitioner
assignedOrganization	`Reference(Practitioner)` The clinic location this payment is assigned to (optional, for deposits only) `"reference": "/main/Organization/CL-12345"` `"type": "Organization"` See also: Organization