The page number for paginated results. Defaults to 1. Used to traverse the paginated response

The field to sort results by. Prefix with '-' for descending order (e.g., '-createdAt'). Sortable fields are indicated in each field's description. Used to sort the response in ascending or descending order of an attribute

Filter expression in the format: filter[field][operator]=value. See individual field descriptions for available operators. Example: filter[status][eq]=Funded. Used to filter the response on an attribute value

When the payment was created. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

The name of the CSO that processed the payment. Sortable: Yes. Filter Operators: eq, neq, nn, null, in, nin

A description of the payment. Sortable: Yes. Filter Operators: eq, neq, nn, null, in, nin

Additional payment details. Sortable: Yes. Filter Operators: eq, neq, nn, null, in, nin

An external identifier from a third-party system. Sortable: Yes. Filter Operators: eq, neq, nn, null, in, nin

When the payment failed. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

The error code from the payment processor. Sortable: Yes. Filter Operators: eq, neq, nn, null, in, nin

The UUID of the loan group. Use the GET /api/loan-groups endpoint to find available values. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

The UUID of the loan type. Use the GET /api/loan-types endpoint to find available values. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

The UUID of the loan this payment is applied to. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

How the payment was initiated. Possible values: Adjustment, Admin, Agent, Api, Auto Schedule, Cash, Collector, Customer, EFT Returned, External Loan Payoff, Funding, Import, Line of Credit Advance, Miscellaneous Payment, Paydit, Payment Plan, Prenote, Refund, Retry, Scheduled, Settlement, Subscription, Transfer, Withdraw Funds. Sortable: Yes. Filter Operators: eq, neq, in, nin

The type of payment. Possible values: Adjustment, Final, First, Funding, Late, Prenote, Transfer, Scheduled, Unscheduled. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null

When the payment was posted. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

When the payment was submitted to the processor. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

The payment processor that handled the transaction. Sortable: Yes. Filter Operators: eq, neq, nn, null, in, nin

A reference ID for tracking and reconciliation. Sortable: Yes. Filter Operators: eq, neq, nn, null, in, nin

The return code from the processor (e.g., R01 for insufficient funds). Sortable: Yes. Filter Operators: eq, neq, nn, null, in, nin

When the payment was returned. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

When the payment was settled. ISO 8601 date format (YYYY-MM-DD). Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

The current payment status. Possible values: Completed, Failed, Held, Pending, Posted, Processing, Rejected, Returned, Settled, Voided. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null

The payment's unique identifier (UUID v4 format). Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

Must be application/json.

Must be application/json.