Skip to main content
GET
List loan payments

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

businessId
string<uuid>
required

The UUID of the business.

Query Parameters

sort_by
string
default:date

Field to sort by. Defaults to date.

sort_order
enum<string>
default:ASC

Sort direction. Defaults to ASC.

Available options:
ASC,
DESC
cursor
string

Pagination cursor returned by the previous list request. Omit for the first page.

limit
integer
default:100

Maximum number of results to return. Defaults to 100.

show_total_count
boolean
default:false

If true, include total_count in the pagination metadata. Has a performance cost; defaults to false.

Response

200 - application/json

A list of loan payments.

data
object[]
required
meta
object

Request metadata. Present on paginated list responses.