Cabcharge

Cabcharge is an Australian corporate ground-travel and expense payment provider. The Cabcharge Plus API lets businesses manage taxi and travel payment accounts, travellers, digital cards and passes, trip transactions, and billing statements programmatically.

Power end-to-end data operations for your Cabcharge API with Nexla. Our bi-directional Cabcharge connector is purpose-built for Cabcharge, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Cabcharge or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Cabcharge workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Cabcharge credential, you need a Cabcharge Plus account and API access provisioned through the Cabcharge developer portal. The Cabcharge Plus API is published on an Azure API Management developer portal and requires two pieces of information to authenticate: an API subscription key and a set of account credentials (email, password, and client ID) that are exchanged for a short-lived bearer token.

To obtain your Cabcharge Plus API credentials, follow these steps:

1. Confirm that your organization has an active Cabcharge Plus account. API access is provisioned by Cabcharge for corporate customers; if you do not yet have access, contact your Cabcharge account representative to request API onboarding.

2. Sign in to the Cabcharge developer portal with the account provided to your organization.

3. Locate your Subscription Key in the developer portal. This key is issued per subscription and is sent as the subscription-key header on every API request. Keep this value confidential.

4. Note the Client ID issued with your subscription. This identifier is submitted, along with your account email and password, to the Cabcharge Plus authorization endpoint to obtain a bearer token.

5. Have the email and password for the Cabcharge Plus account that will be used for API access ready. Nexla exchanges these credentials at the authorization endpoint (/plus/v1/api/authorization) for an ID token, then sends that token as a Bearer value in the Authorization header on subsequent requests.

Nexla handles the token exchange automatically once the credential is saved, so you do not need to generate or refresh the bearer token yourself. For complete and up-to-date API details, refer to the Cabcharge developer documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
Email	Yes	No	Cabcharge Plus account email used to obtain an ID token.
Password	Yes	Yes	Cabcharge Plus account password used to obtain an ID token.
Client ID	Yes	No	Cabcharge Plus API client identifier issued with the subscription.
Subscription Key	Yes	Yes	API subscription key sent as the 'subscription-key' header on every request (from the Cabcharge developer portal).

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter the Cabcharge Plus account email in the Email field. This address, together with the password and client ID, is used to obtain an ID token from the Cabcharge authorization endpoint.

4. Enter the account password in the Password field. This value is stored securely and is used only to obtain the ID token.

5. Enter your Client ID, the API client identifier issued with your Cabcharge Plus subscription.

6. Enter your Subscription Key, the API subscription key from the Cabcharge developer portal. Nexla sends this value as the subscription-key header on every request.

   The subscription key and password are sensitive values. If either is compromised, rotate it in the Cabcharge developer portal and update the credential in Nexla.

7. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Cabcharge connector tile, then select the credential that will be used to connect to Cabcharge, and click Next; or, create a new Cabcharge credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Cabcharge endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

List Accounts

List all Cabcharge accounts the authenticated user can access.

• This endpoint requires no additional parameters. Use it first to retrieve the account identifiers needed by most other Cabcharge endpoints.

Search Billing Periods

Search billing periods within a date window.

• Provide the Start Date and End Date (ISO 8601) that bound the billing-period search window.

List Categories

List trip-tagging categories configured for an account.

• Provide the Account ID (from List Accounts) whose categories you want to retrieve.

List Tags

List tags within a trip-tagging category.

• Provide the Account ID and the Category ID (the trip-tagging category UUID within the account) whose tags you want to retrieve.

List Travellers

List travellers registered on the account.

• Optionally provide Page Number and Page Size to page through results, and Include Tag Profile to include each traveller's tag profile.

Get Traveller Tag Profile

Get the automatic trip-tagging profile for a traveller.

• Provide the Traveller ID (from List Travellers) whose tag profile you want to retrieve.

List Digital FASTCARD Orders

List Digital FASTCARD orders placed for an account.

• Provide the Account ID (from List Accounts) whose Digital FASTCARD orders you want to retrieve.

List Digital Pass Orders

List Digital Pass orders placed for an account.

• Provide the Account ID (from List Accounts) whose Digital Pass orders you want to retrieve.

Get Statement

Get the billing statement for an account and billing period.

• Provide the Account ID, the Billing Period identifier, and the Format (JSON, PDF, EXCEL, or XML) for the statement.

List Transactions by Product Type

List trip transactions for an account filtered by product type and date range.

• Provide the Account ID, the Product Type (for example, DigitalPass, DigitalFastCard, eTICKET, FASTCARD, or FlexiFastCard), and the From Date. The To Date is optional.

Get Transactions Summary

List a summary of transactions for an account, optionally filtered by date range.

• Provide the Account ID. Optionally provide From Date, To Date, and Has Details to narrow the summary and control whether trip detail fields are included.

Get Transaction Details

Get full trip details (route, fare, extras) for a single transaction.

• Provide the Account ID and the Transaction ID within that account.

List Transactions by Order

List transactions associated with a digital order.

• Provide the Account ID and the Order ID (digital order identifier) whose transactions you want to retrieve.

Get Active Products

List active FASTCARD/Digital Pass/eTICKET inventory assigned within an account.

• Provide the Product Type (for example, DigitalPass, DigitalFastCard, eTICKET, FASTCARD, or FlexiFastCard) and the Account ID whose active inventory you want to retrieve.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Cabcharge data sources can also be manually configured to ingest data from any valid Cabcharge Plus API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Cabcharge data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Cabcharge destination, and select the Send to Destination option from the menu. Select the Cabcharge connector from the list of available destination connectors, then select the credential that will be used to connect to Cabcharge, and click Next; or, create a new Cabcharge credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Cabcharge endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Add Category

Create a new trip-tagging category for an account.

• Provide the Account ID (from List Accounts). Each record from your Nexset is sent as the JSON request body describing the category to create.

Rename Category

Rename an existing trip-tagging category.

• Provide the Account ID and the Category ID (the trip-tagging category UUID within the account). Each record from your Nexset is sent as the JSON request body with the new category name.

Add Tag

Add a new tag to a trip-tagging category.

• Provide the Account ID and the Category ID. Each record from your Nexset is sent as the JSON request body describing the tag to add.

Add Traveller

Register a new traveller on the account.

• This endpoint requires no additional parameters. Each record from your Nexset is sent as the JSON request body describing the traveller to register.

Add Tag Profile

Create the automatic trip-tagging profile for a traveller.

• Provide the Traveller ID (from List Travellers). Each record from your Nexset is sent as the JSON request body describing the tag profile.

Create Digital FASTCARD Order

Create a new Digital FASTCARD order.

• This endpoint requires no additional parameters. Each record from your Nexset is sent as the JSON request body describing the Digital FASTCARD order to create.

Create Digital Pass Order

Create a new Digital Pass order.

• This endpoint requires no additional parameters. Each record from your Nexset is sent as the JSON request body describing the Digital Pass order to create.

Create Digital Pass Orders (Bulk)

Create multiple Digital Pass orders in a single request.

• This endpoint requires no additional parameters. Each record from your Nexset is sent as the JSON request body containing the batch of Digital Pass orders to create.

Tag Transaction

Apply trip tags to a single transaction.

• Provide the Account ID and the Transaction ID. Each record from your Nexset is sent as the JSON request body listing the tags to apply.

Assign Products

Assign inventory tickets (FASTCARD/FlexiFastCard/eTICKET) to a traveller.

• Provide the Product Type (for example, DigitalPass, DigitalFastCard, eTICKET, FASTCARD, or FlexiFastCard) and the Account ID. Each record from your Nexset is sent as the JSON request body describing the inventory to assign.

Manual configuration

Cabcharge destinations can also be manually configured to send data to any valid Cabcharge Plus API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Cabcharge Plus APIs expect JSON in the request body. For update operations, include the identifier of the object to be updated at the end of the endpoint URL.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Cabcharge endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Cabcharge endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.