Tickets

Permissions: read_tickets

For what this feature does, see Tickets in Platform. This item appears in the Control Center provider sidebar only when the tickets provider feature is active.

Information on ticketing setup

After the feature is activated and set up it is possible to retrieve information in Control Center. From the provider overview, select ⚙️ to find information on vendors, products, zones, and tickets.

Ticketing: Vendors

This page lists the configured ticket vendors of the provider. Selecting the name of a vendor opens an overview of its data.

Name
Slug
Address
Support email
Support phone number
Support website
ToS
Vendor options adapter name

Ticketing: Products

In this view, an index of all products is shown. A product in the context of ticketing is an entity that a user can buy, such as a single tip ticket or a monthly pass, etc. Clicking on a product you can find the following information.

Vendor ID
Vendor
Slug
Translations
Purchasable
Purchasable from
Purchasable until
Renewable
Sort key
Price (net)
Price (gross)
Price VAT rate
Price type
Raw vendor data
Synced at
Created at
Updated at
Icon type
Number of zones

Further, here you can find information on

Purchase options
Redemption options and finally the product how it is serialized for the Passenger API.

Ticketing: Zones

If the ticket vendor uses zones, an index of those can be found here. Clicking on the name of a zone, you can find the following information.

Vendor ID
Vendor
Slug
Translations
Sort key
Synced at
Created at
Updated at

Additionally, you can find a map and also the raw vendor data (including the GeoJSON).

Ticketing: Tickets

This page lists all tickets of the provider, with a filter for the user name, state, product, vendor, and creation date. Each row links to the detail view of a single ticket, which shows information about the ticket and the corresponding booking transaction.

Ticket

ID
Ticketing product
Ticketing: Vendor
User
Ride
Purchase options
Redemption options
Vendor order ID
Vendor ticket ID
State
Renewable?
Price (net)
Price (gross)
Price VAT rate
Vendor
Cancelled at
Cancellation Reason
Scheduled redemption time
Issued at
Redeemed at
Created at
Updated at
Adapter
Response message

If the ticket has been deactivated, three more fields are shown:

Inactive since
Reason for deactivation
Deactivated by

Booking transaction

ID
Type
State
Amount gross
Amount net
Vat rate
Payment method type
Created at

The vendor, product, and zone setup shown here is read-only; viewing it requires access to the provider, and viewing tickets and their booking transactions requires read_tickets. Creating and editing the ticketing setup is done in the Management Area.

Deactivate a ticket

You can deactivate a valid ticket so that it can no longer be used, for example when a passenger reports a problem with it. The Deactivate action is available only while the ticket is still valid, which means it has been redeemed, is not already deactivated, and has not expired.

Open the ticket, either from the Ticketing: Tickets list or from its detail view.
Select Deactivate.
In Reason for deactivation, enter why the ticket is being deactivated. A reason is required.
Select Deactivate Ticket.

After deactivation, the ticket detail view shows who deactivated it, when, and the reason.

Deactivation only marks the ticket as unusable in ioki Platform. It does not issue a refund. If the passenger is entitled to a refund, the ticket must still be refunded manually with the ticket provider.

The last 15 tickets of a user are also listed on that user’s detail page when the provider supports tickets, so you can review a passenger’s recent tickets without opening the full Ticketing: Tickets list.