Create Cash Topup
Path Parameters
UUID of the driver (v4 format)
Body Parameters
UUID of the collection point where cash is being deposited
UUID of the staff/operator collecting the cash
Deposit amount as a decimal string (e.g., “150.00”)
ISO 4217 currency code (3 characters). Defaults to “CUP”
Optional notes for the cash collection record
Optional description for the transaction (e.g., “cash topup at desk”)
Free-form metadata object (e.g.,
{"source": "window-3"})Response
Indicates if the operation was successful
Response message
Created cash collection record
This creates a pending cash collection record and transaction. The wallet is not credited until the topup is confirmed.
Confirm Cash Topup
Path Parameters
UUID of the CashCollectionRecord to confirm (v4 format)
Body Parameters
Optional confirmation comment (max 500 characters, e.g., “Billetes verificados y contados”)
Response
Indicates if the operation was successful
Response message
Confirmed cash topup details
Get Driver Wallet Balance
Path Parameters
UUID of the driver (v4 format)
Response
Indicates if the operation was successful
Response message
Driver wallet balance information
Get Wallet Movements
Path Parameters
UUID of the wallet (driver_balance.id, v4 format)
Query Parameters
Page number for pagination
Number of items per page
Filter by transaction UUID
Start date filter in ISO-8601 format (e.g., “2025-01-01T00:00:00Z”)
End date filter in ISO-8601 format (e.g., “2025-12-31T23:59:59Z”)
Search term to filter movements
Field to sort by
createdAt- Sort by creation dateamount- Sort by transaction amount
Sort direction
asc- Ascending orderdesc- Descending order
Response
Indicates if the operation was successful
Response message
Array of wallet movement records
Pagination metadata
Block Driver Wallet
Path Parameters
UUID of the driver (v4 format)
Body Parameters
Reason for blocking the wallet (max 250 characters, for audit/traceability)
Additional comment (max 500 characters, e.g., “Bloqueo preventivo hasta resolver disputa #D-1234”)
Response
Indicates if the operation was successful
Response message (indicates if wallet was already blocked - idempotent)
Wallet status change information
This operation is idempotent. If the wallet is already blocked, it returns success without making changes.
Unblock Driver Wallet
Path Parameters
UUID of the driver (v4 format)
Body Parameters
Reason for unblocking (max 250 characters, e.g., “Disputa resuelta”)
Additional comment (max 500 characters, e.g., “Se validó identidad del conductor y se cerró el ticket”)
Response
Indicates if the operation was successful
Response message (indicates if wallet was already active - idempotent)
Wallet status change information
This operation is idempotent. If the wallet is already active, it returns success without making changes.