Skip to main content
GET
Get a payment

Authorizations

Authorization
string
header
required

Access token issued by POST /sessions and associated with a valid server-side session.

Path Parameters

id
string<uuid>
required

UUID identifying this resource.

Query Parameters

company_id
string<uuid>
required

Company UUID. Must equal the authenticated session company when that session has a company assigned; the equality check is skipped for sessions without one.

school_id
string<uuid>

School UUID. Omit to use the operation's documented company/session scope.

school_ids
string<uuid>[]

Optional school UUID filter. When school_id is also supplied, both filters apply. Accepts repeated query parameters or comma-separated values; empty entries are dropped and surrounding whitespace is trimmed.

fields
enum<string>[]

Select response properties. Unknown names return 400. Default: payment_id, family_id, family_name, transaction_date, amount, total_amount, state. Accepts repeated query parameters or comma-separated values; empty entries are dropped and surrounding whitespace is trimmed.

Available options:
payment_id,
transaction_id,
school_id,
family_id,
family_name,
transaction_date,
amount,
fee_amount,
total_amount,
balance,
state,
receipt_number,
payment_mode,
payment_method_sub_kind,
description,
is_posted,
payd_online,
auto_billing,
created_at

Response

Successful response.

A sparse row containing only the selected fields. Default fields: payment_id, family_id, family_name, transaction_date, amount, total_amount, state.

payment_id
string

Payment id.

transaction_id
string

Transaction id.

school_id
string

School id.

family_id
string

Family id.

family_name
string
transaction_date
string<date>
amount
number
fee_amount
number | null
total_amount
number
balance
number
state
string
receipt_number
string
payment_mode
string
payment_method_sub_kind
string
description
string
is_posted
boolean
payd_online
boolean
auto_billing
boolean
created_at
string

Local timestamp in YYYY-MM-DD HH:mm:ss format; no timezone suffix.

Example:

"2026-01-15 09:30:00"