Skip to main content
GET
Get Cash Settlement

Authorizations

Authorization
string
header
required

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

Path Parameters

cashSettlementId
string<uuid>
required

Cash settlement identifier

Example:

"01981264-9aa0-7d18-a4a4-3b9a9a3a1c13"

Query Parameters

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

cashSettlementId
string<uuid>
required

Cash settlement identifier

Example:

"01981264-9aa0-7d18-a4a4-3b9a9a3a1c13"

checkoutSessionId
string<uuid>
required

Checkout session identifier

Example:

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

organizationId
string<uuid>
required

Organization identifier

Example:

"0197a7f7-7291-7a43-96db-2c8580b80c5d"

organization
object
required

Organization

cooperativeId
string<uuid>
required

Cooperative identifier

Example:

"0197a800-24e6-76a2-90ed-ff0f6fba7b0c"

cooperative
object
required

Cooperative

transportOperatorId
string<uuid>
required

Transport operator identifier

Example:

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

transportOperator
object
required

Transport operator

driverId
string<uuid>
required

Driver identifier

Example:

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

driver
object
required

Driver

declaredAmount
integer
required

Declared amount in cents

Example:

11400

status
enum<string>
required

Cash settlement status

Available options:
PENDING,
CONFIRMED,
REJECTED
Example:

"PENDING"

submittedBy
string<uuid>
required

Submitted by

Example:

"0197a805-0910-7eb2-bae7-90a13df2a9b2"

checkoutSession
object
required

Checkout session identity

createdAt
string<date-time>
required

Created at

Example:

"2026-07-08T12:11:08.000Z"

submittedAt
string<date-time>
required

Submitted at

Example:

"2026-07-08T12:11:08.000Z"

updatedAt
string<date-time>
required

Updated at

Example:

"2026-07-08T12:11:08.000Z"

paymentId
string<uuid> | null

Payment linked after confirmation

Example:

null

confirmedBy
string<uuid> | null

Confirmed by

Example:

null

rejectedBy
string<uuid> | null

Rejected by

Example:

null

rejectionReason
string | null

Rejection reason

Maximum string length: 500
Example:

null

createdBy
string<uuid> | null

Created by

Example:

null

updatedBy
string<uuid> | null

Updated by

Example:

null

confirmedAt
string<date-time> | null

Confirmed at

Example:

null

rejectedAt
string<date-time> | null

Rejected at

Example:

null