Get Transactions

Returns a list of transactions across your properties. Transactions in Warden represent the actual movement of money — each transaction can be linked to one or more payments. Use this to reconcile collections, track payment gateway activity, and monitor the flow of funds in and out of your properties.

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 by transaction `id`, linked `paymentId`, resident/lead `name`, `bankReferenceNumber`, or `referenceNumber`
`id`	number	Filter by exact transaction ID
`propertyId`	number	Filter transactions by property
`residentId`	number	Filter transactions belonging to a specific resident
`beneficiaryId`	number	Filter transactions by beneficiary (used for outbound/refund transactions)
`paymentId`	number	Filter transactions linked to a specific payment
`status`	enum	Filter by transaction status (see values below)
`entry`	enum	Filter by how the transaction was entered. Allowed values: `Manual`, `Gateway`, `CirclePe`, `Payout`, `Transfer`
`method`	enum	Filter by payment method (see values below)
`direction`	enum	Filter by direction of money flow. Allowed values: `Incoming`, `Outgoing`
`referenceNumber`	string	Filter by the internal reference number of the transaction
`bankReferenceNumber`	string	Filter by the bank-issued reference number
`isReconciled`	boolean	Filter by whether the transaction has been reconciled (`true` or `false`)
`settledAtDateTime`	datetime	Filter by the date and time the transaction was settled
`createdAt`	datetime	Filter by record creation date
`updatedAt`	datetime	Filter by last updated date

`status` 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

`method` Enum Values

UPI, NEFT, IMPS, Cash, Online, Cheque, Cheque (Dated), Cheque (Undated), Debit Card, Credit Card, Wallet, Net Banking, Bank Deposit, Transfer, Unknown, TDS Receivable, POS Machine, POS Link

Operators

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

Filter Examples

# Get all successful transactions for a property
GET /api/v1/external-app/get-transactions?q=propertyId:=412$$status:=Success

# Get all incoming transactions
GET /api/v1/external-app/get-transactions?q=direction:=Incoming

# Get unreconciled transactions
GET /api/v1/external-app/get-transactions?q=isReconciled:=false

# Filter by bank reference number
GET /api/v1/external-app/get-transactions?q=bankReferenceNumber~=TXN12345

# Get all transactions for a specific payment
GET /api/v1/external-app/get-transactions?q=paymentId:=9876

Sorting

Parameter	Type	Options	Default
`sort`	string	`createdAt`, `updatedAt`, `settledAtDateTime`	`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 ********************

{ "transactions": [ { "userName": "Shubh Gaur", "roomName": "S027", "propertyName": "Warden House Baner", "id": 8293, "status": "Void", "method": "Debit Card", "referenceNumber": " twCWzvHIUFLarHiP", "gatewayReferenceNumber": null, "bankReferenceNumber": null, "amount": 15000, "serviceCharge": null, "requestMessage": null, "entry": "Manual", "gatewayData": null, "photos": [], "statusTransitions": [], "memo": null, "isReconciled": false, "settledAtDateTime": "2023-04-01T00:00:00+05:30", "bankSettledAtDateTime": null, "userId": 51, "companyId": 11, "propertyId": 19, "residentId": 904, "leadId": null, "subscriptionId": null, "beneficiaryId": null, "settlementReportId": null, "isServiceChargeAdded": null, "receiptFileId": null, "files": [], "invoices": [], "paymentConnections": [], "createdById": 941, "updatedById": 941, "createdAt": "2023-06-29T18:11:23+05:30", "updatedAt": "2023-06-29T18:11:23+05:30", "isDeleted": false, "orderAmount": 15000, "settlementAmount": 15000, "statusKey": 5, "invoiceIds": [], "paymentIds": [], "settledInvoices": [], "settledPayments": [] }, { "userName": "Umang Agarwal", "roomName": "S026", "propertyName": "Warden House Baner", "id": 8258, "status": "Void", "method": "NEFT", "referenceNumber": " UdCy95lBgXAttgK2", "gatewayReferenceNumber": null, "bankReferenceNumber": null, "amount": 15000, "serviceCharge": null, "requestMessage": null, "entry": "Manual", "gatewayData": null, "photos": [], "statusTransitions": [], "memo": null, "isReconciled": false, "settledAtDateTime": "2023-06-04T00:00:00+05:30", "bankSettledAtDateTime": null, "userId": 48, "companyId": 11, "propertyId": 19, "residentId": 901, "leadId": null, "subscriptionId": null, "beneficiaryId": null, "settlementReportId": null, "isServiceChargeAdded": null, "receiptFileId": null, "files": [], "invoices": [], "paymentConnections": [], "createdById": 941, "updatedById": 941, "createdAt": "2023-06-29T18:11:23+05:30", "updatedAt": "2023-06-29T18:11:23+05:30", "isDeleted": false, "orderAmount": 15000, "settlementAmount": 15000, "statusKey": 5, "invoiceIds": [], "paymentIds": [], "settledInvoices": [], "settledPayments": [] }, { "userName": "Umang Agarwal", "roomName": "S026", "propertyName": "Warden House Baner", "id": 8259, "status": "Void", "method": "Cash", "referenceNumber": " tk10DcOR0enra10Bk9", "gatewayReferenceNumber": null, "bankReferenceNumber": null, "amount": 15000, "serviceCharge": null, "requestMessage": null, "entry": "Manual", "gatewayData": null, "photos": [], "statusTransitions": [], "memo": null, "isReconciled": false, "settledAtDateTime": "2023-03-03T00:00:00+05:30", "bankSettledAtDateTime": null, "userId": 48, "companyId": 11, "propertyId": 19, "residentId": 901, "leadId": null, "subscriptionId": null, "beneficiaryId": null, "settlementReportId": null, "isServiceChargeAdded": null, "receiptFileId": null, "files": [], "invoices": [], "paymentConnections": [], "createdById": 941, "updatedById": 941, "createdAt": "2023-06-29T18:11:23+05:30", "updatedAt": "2023-06-29T18:11:23+05:30", "isDeleted": false, "orderAmount": 15000, "settlementAmount": 15000, "statusKey": 5, "invoiceIds": [], "paymentIds": [], "settledInvoices": [], "settledPayments": [] }, { "userName": "Umang Agarwal", "roomName": "S026", "propertyName": "Warden House B

Query Parameters#

Pagination#

Filtering#

Available Filter Keys#

status Enum Values#

method Enum Values#

Operators#

Filter Examples#

Sorting#

Authentication#

Request

Responses