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

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection.

Response

OK

Automatically submitted accountability record for one CASH checkout session.

cashSettlementId
string<uuid>
required

Cash settlement identifier.

checkoutSessionId
string<uuid>
required

Unique checkout session that originated the settlement.

paymentId
string<uuid> | null
required

Payment linked after cooperative confirmation.

organizationId
string<uuid>
required

Cooperative organization identifier.

cooperativeId
string<uuid>
required

Cooperative responsible for confirmation.

transportOperatorId
string<uuid>
required

Transport operator from the trip context.

driverId
string<uuid>
required

Driver responsible for the cash sale.

declaredAmount
integer
required

Amount automatically declared in cents.

Required range: x >= 0
status
enum<string>
required

Cash settlement status.

Available options:
PENDING,
CONFIRMED,
REJECTED
submittedBy
string<uuid>
required

User that confirmed the checkout session.

submittedAt
string<date-time>
required

Automatic submission date.

confirmedBy
string<uuid> | null
required

OPS user that confirmed the settlement.

confirmedAt
string<date-time> | null
required

Cooperative confirmation date.

rejectedBy
string<uuid> | null
required

OPS user that rejected the settlement.

rejectedAt
string<date-time> | null
required

Cooperative rejection date.

rejectionReason
string | null
required

Reason informed when the settlement is rejected.

createdBy
string<uuid> | null
required

User that created the record.

createdAt
string<date-time>
required

Creation date.

updatedBy
string<uuid> | null
required

User that last updated the record.

updatedAt
string<date-time>
required

Last update date.