Get Payments

Returns a list of payments across your properties. Payments in Warden represent individual payment records tied to bookings, residents, or leads. Use this to track payment status, reconcile collections, monitor overdue payments, and sync financial data with your own systems.

Query Parameters

Pagination

Parameter	Type	Default	Description
`page`	number	`0`	Page number (zero-indexed)
`per_page`	number	`50`	Number of results per page (max: `10000`)

Filtering

Filters are passed via the q parameter. Multiple filters can be combined using $$ as a separator.

Syntax: q=<filterKey><operator><value>

Combining filters: q=<filter1>$$<filter2>$$<filter3>

Available Filter Keys

Filter Key	Type	Description
`searchText`	string	Search across resident/lead `name` and `room name`, or by exact payment `id`
`id`	number	Filter by exact payment ID
`bookingId`	number	Filter payments belonging to a specific booking
`residentId`	number	Filter payments belonging to a specific resident
`leadId`	number	Filter payments belonging to a specific lead
`propertyId`	number	Filter payments by property
`sessionId`	number	Filter payments associated with a specific session (matches across resident, lead, and booking)
`chartOfAccountId`	number	Filter payments that contain a payment item with a specific chart of account
`settlementReportId`	number	Filter payments included in a specific settlement report
`status`	enum	Filter by payment status (see values below)
`type`	enum	Filter by payment type. Allowed values: `Rent Collection`, `Refund`
`category`	enum	Filter by payment category (see values below)
`scope`	enum	Filter by payment scope. Allowed values: `Document`, `Shadow`
`entry`	enum	Filter by the transaction entry method used for settlement. Allowed values: `Manual`, `Gateway`, `CirclePe`, `Payout`, `Transfer`
`transactionStatus`	enum	Filter by the status of associated transactions (see values below)
`entityType`	enum	Filter by the entity the payment belongs to. Allowed values: `Resident`, `Lead`
`isOverdue`	boolean	Filter overdue payments (`true`) or non-overdue pending payments (`false`)
`dueDate`	datetime	Filter by payment due date
`billingDate`	datetime	Filter by payment billing date
`paidOnDateTime`	datetime	Filter by the date payment was received
`createdAt`	datetime	Filter by record creation date
`updatedAt`	datetime	Filter by last updated date
`residentMoveInDate`	datetime	Filter by the associated resident's move-in date
`residentMoveOutDate`	datetime	Filter by the associated resident's move-out date
`leadMoveInDate`	datetime	Filter by the associated lead's move-in date
`leadMoveOutDate`	datetime	Filter by the associated lead's move-out date
`sessionStartDate`	datetime	Filter payments whose associated session starts on or after this date
`sessionEndDate`	datetime	Filter payments whose associated session ends on or before this date

`status` Enum Values

Value	Description
`Draft`	Payment has been created but not yet issued
`Pending`	Payment has been issued and is awaiting collection
`Paid`	Payment has been successfully collected
`Processing`	Payment is being processed via a payment gateway
`Void`	Payment has been voided and is no longer collectible
`Uncollectable`	Payment could not be collected
`Adjusted`	Payment has been adjusted against another payment

`category` Enum Values

Value	Description
`Booking`	Reservation payment collected at the time of booking
`Initial Payment`	Check-in payment collected before or at move-in
`Rent`	Standard recurring rent collection
`Security Refund`	Refund of the security deposit to the resident's bank
`Security Forfeit`	Security deposit forfeited by the resident
`Security Transfer`	Security deposit transferred to another booking
`Adjustment Refund`	Refund issued as an adjustment

`transactionStatus` Enum Values

Value	Description
`Creating`	Transaction is being initialised
`Open`	Transaction is open and awaiting action
`Pending`	Transaction is pending completion
`Success`	Transaction completed successfully
`Failed`	Transaction failed
`Void`	Transaction has been voided
`Requested`	Transaction has been requested by the resident
`Declined`	Resident's transaction request was declined by the admin

Operators

Operator	Meaning
`:=`	Exact match
`~=`	Contains (partial match)
`>=`	Greater than or equal
`<=`	Less than or equal
`!=`	Not equal

Filter Examples

# Get all pending payments for a property
GET /api/v1/external-app/get-payments?q=propertyId:=412$$status:=Pending

# Get all overdue payments
GET /api/v1/external-app/get-payments?q=isOverdue:=true

# Get all rent payments for a booking
GET /api/v1/external-app/get-payments?q=bookingId:=15902$$category:=Rent

# Get payments due before a specific date
GET /api/v1/external-app/get-payments?q=dueDate<=2026-08-01

# Get all refund payments
GET /api/v1/external-app/get-payments?q=type:=Refund

Sorting

Parameter	Type	Options	Default
`sort`	string	`createdAt`, `updatedAt`, `dueDate`, `billingDate`, `paidOnDateTime`	`createdAt`
`order`	string	`asc`, `desc`	`desc`

Authentication

This endpoint requires a valid Bearer Token in the Authorization header. Obtain one via the Credential Refresh endpoint.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Parameters#

Pagination#

Filtering#

Available Filter Keys#

status Enum Values#

category Enum Values#

transactionStatus Enum Values#

Operators#

Filter Examples#

Sorting#

Authentication#

Request

Responses