Skip to main content
GET
List Pending Cash Settlements

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
number
default:10

Items per page

Example:

10

page
number
default:1

Page number

Example:

1

checkoutSessionId
string<uuid>

Checkout session identifier

Example:

"01981255-3c7a-7bd4-bb5f-8b47bc4dce91"

driverId
string<uuid>

Driver identifier

Example:

"0197a807-1ec7-75e8-8ff8-df64dd070046"

submittedAt
string

Submission date range

Example:

">=2024-01-01;<=2024-12-31"

transportOperatorId
string<uuid>

Transport operator identifier

Example:

"01980d30-6a3c-7a42-9182-17ad6324d3aa"

sortBy
enum<string>
default:submittedAt

Field to sort by

Available options:
submittedAt,
declaredAmount,
status
Example:

"submittedAt"

sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc
Example:

"desc"

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

Cash settlement list

data
object[]
required
meta
object
required