Get Scheduled Payments

get

https://{your-totality-url}.com/api/scheduled-payments

Retrieve paginated list of scheduled payments. Permission: Read Scheduled Payments

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

Page

string

Defaults to page=5

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

Sort

string

Defaults to sort=+createdAt

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

string

Defaults to createdAt=eq:2022-01-01

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

amount

integer

The scheduled payment amount in dollars. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

balance

integer

The expected remaining loan balance after this payment, in dollars. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

cashierPaymentMethodUuid

string

The UUID of the payment method to be used. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

createdAt

string

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

currentInterest

integer

The current calculated interest amount, in dollars. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

fees

integer

The fee portion of the scheduled payment, in dollars. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

interest

integer

The interest portion of the scheduled payment, in dollars. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

isAutoScheduled

boolean

Whether this payment was automatically scheduled. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

isEcheck

boolean

Whether this will be processed as an eCheck/ACH. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

loanUuid

string

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

origin

string

How the scheduled payment was created. Possible values: Adjustment, Admin, Agent, Api, Auto Schedule, Cash, Collector, Customer, Funding, Import, Payment Plan, Prenote, Retry, Scheduled, Settlement, Transfer. Sortable: Yes. Filter Operators: eq, sw, in, nin, ne, neq, nn, null

paymentDate

string

The date the payment is scheduled. ISO 8601 date format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

paymentUuid

string

The UUID of the actual payment created when processed. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

prenotePaymentUuid

string

The UUID of the associated prenote payment. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

principle

integer

The principal portion of the scheduled payment, in dollars. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

updatedAt

string

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

uuid

string

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

Headers

string

required

Defaults to application/vnd.totality.v1+json

Must be application/json.

Content-Type

string

required

Defaults to application/json

Must be application/json.

Responses

200Successful response

400400

401401

403403

500500