Partner APIs

Partner API documentation for self serviced use of the Clearing services. See the developer guide for more information.

An API for handling consents within Entur's sales systems

Documentation of the Customers API

This api is in Beta. Search for offers by different means.

Open Mobility Sales API for searching, selecting, and purchasing mobility products and related resources.

Repository for data that is connectable to `orderId` and can be represented in String form. Note that only one note per `type` is able to be used per `orderId` for DEADLINE, VENDOR_CONTACT_INFO_OVERRIDE, ZERO_TICKET and PENALTY_FARE. If there is any need for nested data structures, consumers are invited to simply store small JSON objects in the `text` field.

The Order API provides services to create and manage orders in Entur sales platform. It allows clients to create orders, add and change order lines, apply fees, manage connected reservations, and handle traveller information.

The Payments API acts as a gateway to external payment service providers and provides endpoints to create, process and credit payment transactions. To be able to provide these services, the following data is stored and made available: * Payments * PaymentTransactions * PaymentMethods * Credits * CreditTransactions * RecurringPayments * PaymentConfigurations. This API is intended for partners who want to utilize Entur's platform to take payment for public transport tickets, as well as internal financial reporting tools.

Integrate personalisation in clients, for example show a customers status in programs.

Retrieve privacy data from personalisation to ensure GDPR compliance.

Personnel tickets are a Norwegian railway discount scheme providing reduced fares for employees, pensioners, and eligible family members in participating companies. The scheme is owned by the Norwegian Railway Directorate and managed by Entur, requiring companies to enter an agreement to participate. This API supports managing employee eligibility, connecting user profiles to ticket rights, and applying those rights in ticket sales. It also enables reporting of personnel ticket usage for administrative and tax purposes.

This API provides services to read and maintain products and fare data for public transport in Norway.

**This API specification is a draft and is not yet implemented. Endpoints, schemas, and behavior are subject to change without notice.** This API provides services to read and maintain products and fare data for public transport in Norway.

Provide access to the original NeTEx datasets uploaded by data providers

Public API for generating and delivering receipts for customer orders. Provides endpoints to send receipts, determine the resulting receipt type for an order, and retrieve pickup-code messages in multiple formats and languages.

Check refundable options and perform refunds or compensations on customer orders. This API allows partners to preview refund outcomes, execute refunds, and apply price reductions when compensation is sufficient.

Simplify adding offers to an order

Third party product is a catalog for products that does not exist in Enturs standard product database. Therefore, third party products must be provided by the client when creating an order. This means third party products are always connected to a specific order line within an order. Third party products enable selling products from another marketplace, using Entur's payment and order apis, which also includes that the sale is settled correctly in Entur's accounting.

Easy way to manage and distribute new tickets to ticketing systems.

Entur provides an API for uploading and downloading NeTEx timetable datasets. These endpoints have restricted access and require a service account (OAuth2) provided by Entur. ## Getting access to the API To get access to the Timetable Management API, please contact Entur at kollektivdata@entur.org You will be granted dedicated OAuth2 credentials ("client-id" and "client-secret") that will allow you to access the service. ## Entur authentication and authorization service The endpoints are protected by an OAuth2 authorization layer. Once you receive OAuth2 credentials, you will be able to request access tokens from Entur authorization server using the following parameters: | Env | OAuth2 token URI | OAuth2 audience / Base URI | | ------- | --------------------------------------------- | ---------------------------- | | Dev | https://partner.dev.entur.org/oauth/token | https://api.dev.entur.io | | Staging | https://partner.staging.entur.org/oauth/token | https://api.staging.entur.io | | Prod | https://partner.entur.org/oauth/token | https://api.entur.io |