Skip to content

Trip End ​

View as Markdown

Overview ​

The Trip End workflow finalises the passenger hire. The driver ends the trip on the Taxi Meter, which calculates all fare details and submits them to CabFare Connect. For Subsidy Scheme trips CabFare Connect processes the subsidy payment and returns the subsidy amount and remaining passenger-payable balance to both devices. The workflow then proceeds to Balance Payment to collect any remaining amount. Once all payments are complete the Taxi Meter closes the job and CabFare Connect reports the trip data to the Subsidy Provider.

Sequence Diagram ​

sequenceDiagram
    actor Driver
    participant TM as Taxi Meter
    participant CC as CabFare Connect
    participant PT as Payment Terminal

    Driver->>TM: Ends trip on Taxi Meter
    TM-->>Driver: Driver sets all fare details and extras

    alt Subsidy Scheme trip
        TM->>CC: POST /meter/trip/end (taxiMeterId, driverId, tripId, tripDetails, fareDetails)
        CC-->>CC: Processes subsidy payment against member account

        alt Subsidy payment successful
            CC-->>TM: 200 OK (mptpSubsidyPaid, remainingBalance, subsidyStatus)
            CC-->>PT: Updates Payment Terminal with subsidy and balance details
            TM-->>Driver: Displays remaining balance due
        else Subsidy payment failed
            CC-->>TM: 200 OK (subsidyStatus: failed, error details)
            TM-->>Driver: Displays error, driver takes appropriate next steps
        end

    else Standard trip
        TM-->>Driver: Displays full fare as balance due
    end

    Note over TM,PT: Proceed to Balance Payment workflow
    
    TM->>CC: POST /meter/job/done (taxiMeterId, driverId, tripId, paymentDetails)
    CC-->>CC: Sends trip data to Subsidy Provider

    alt Taxi Meter printer configured
        TM-->>Driver: Prints receipt including subsidy details
    else Payment Terminal printer configured
        CC->>PT: POST /print/receipt (tripDetails, subsidyDetails, paymentDetails)
        PT-->>Driver: Prints receipt including subsidy details
    end

Step-by-Step ​

Step 1 — Driver ends trip on Taxi Meter ​

The driver ends the hire by stopping the trip on the Taxi Meter as normal. The driver sets all relevant fare details on the Taxi Meter including any applicable extras.


Step 2 — Subsidy Scheme trip processing ​

If the current trip is a valid Subsidy Scheme trip the Taxi Meter submits the fare details to CabFare Connect for subsidy processing.

Taxi Meter calls:
POST /meter/trip/end

Required fields: taxiMeterId, driverId, vehiclePlate, tripId, tripDetails, fareDetails

The fareDetails must include all fare components — base fare, any surcharges, extras, lifting fees, and Subsidy Scheme member details. All monetary amounts must be expressed in cents as integers.

INFO

The extras and surcharges eligible to be included in the fare submitted to CabFare Connect are defined by the Subsidy Provider for your location. Refer to the relevant location section for a complete list of eligible extras applicable to your integration.

The Taxi Meter is the regulated fare calculation device and is responsible for all fare calculations. CabFare Connect is responsible only for processing the subsidy payment amount as requested by the Taxi Meter.

If the subsidy payment is successful:

  • CabFare Connect returns the subsidy amount paid, the remaining passenger-payable balance, and the subsidy status to the Taxi Meter
  • CabFare Connect updates the Payment Terminal with the subsidy and balance details
  • The Taxi Meter displays the remaining balance due to the driver

If the subsidy payment fails:

  • CabFare Connect returns an error response to the Taxi Meter
  • The Taxi Meter displays an error message and the driver takes appropriate next steps, such as manual processing

Step 3 — Standard trip ​

If the current trip is not a Subsidy Scheme trip the Taxi Meter displays the full fare as the balance due. No subsidy processing occurs. The workflow proceeds directly to Balance Payment.


Step 4 — Balance Payment ​

Once the remaining balance is known the workflow proceeds to the Balance Payment workflow. The driver selects the payment method on the Taxi Meter and collects the remaining amount from the passenger by card, cash, or other method.

Refer to the Balance Payment workflow for the full step-by-step.


Step 5 — Taxi Meter closes the job ​

Once all payments are complete the driver presses done on the Taxi Meter. The Taxi Meter sends a job complete notification to CabFare Connect including all payment details.

Taxi Meter calls:
POST /meter/job/done

Required fields: taxiMeterId, driverId, tripId, payment details

CabFare Connect sends all required trip and shift information to the Subsidy Provider.


Step 6 — Receipt ​

If the system is configured with a Taxi Meter printer:

  • The Taxi Meter prints a receipt including subsidy payment details

If the system is configured with a Payment Terminal printer:

  • CabFare Connect sends the trip, subsidy, and payment details to the Payment Terminal for printing

CabFare Connect calls:
POST /print/receipt on the Payment Terminal

Includes: trip details, subsidy details, payment details


Key Points ​

  • The Taxi Meter is the regulated fare calculation device — CabFare Connect does not calculate fares
  • All monetary amounts must be expressed in cents as integers
  • POST /meter/job/done must always be called to close the trip and trigger Subsidy Provider reporting
  • If isSubsidyCalculationMatching returns false in the trip end response, treat the CabFare Connect returned values as the source of truth
  • For Subsidy Scheme trips the subsidy amount and remaining balance are returned by CabFare Connect — the Taxi Meter must use these values for the Balance Payment step
  • Eligible extras and surcharges are defined by the Subsidy Provider for your location — refer to the relevant location section