> For the complete documentation index, see [llms.txt](https://codico-dispatch.gitbook.io/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://codico-dispatch.gitbook.io/documentation/integrations/transferz.md).

# Transferz

Receive transfer bookings from the Transferz platform.

Transferz brings you transfer bookings from travel agencies and booking sites. With the integration, Transferz trips appear in **Bookings** with the Transferz icon, and driver assignment, trip progress and live GPS are reported back to Transferz and the passenger.

Open **Integrations → Transferz**. The page has two tabs: **Connection settings** and **Vehicle category mapping**.

## Before you start

You need login details for the Transferz portal from your Transferz contact.

## Connect

{% stepper %}
{% step %}

### Turn the integration on

Enable **Enable Transferz integration** and **Receive bookings from Transferz**. Leave **Send bookings to Transferz** off unless Transferz asks you to use it.
{% endstep %}

{% step %}

### Send your webhook link

Copy **Link for incoming bookings** from the page and send it to Transferz with your company name. Transferz registers it and sends you a **Webhook security key (HMAC)**.
{% endstep %}

{% step %}

### Enter your credentials

In the Transferz portal, open **API keys**, create a key and paste it into **API key**. Paste the **Webhook security key**. Keep **Transferz server address** on staging while testing. Click **Test connection**, then **Save**.
{% endstep %}

{% step %}

### Map vehicle categories

Open **Vehicle category mapping** and choose a vehicle class for each Transferz type (*Sedan*, *SUV*, *Minibus* and so on) in each market (division). Click **Save mapping**.
{% endstep %}

{% step %}

### Test and go live

Make a test booking as Transferz instructs. When Transferz approves, update the API key, the server address and, if needed, the webhook URL with the production values.
{% endstep %}
{% endstepper %}

## Options

| Setting                                      | What it does                                                                                                       |
| -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| **Automatically accept incoming offers**     | Some trips arrive as an offer that must be accepted within a time limit. When on, the system accepts them for you. |
| **Send driver name and phone to Transferz**  | Lets Transferz show the driver's contact details to the passenger. Recommended.                                    |
| **Send driver live location to Transferz**   | Shares the vehicle position during the trip, about every 30 seconds.                                               |
| **Minimum seconds between location updates** | How often the position is sent.                                                                                    |

## If something does not work

| Problem                               | Check                                                                                                               |
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| No new bookings                       | The integration is enabled, the API key and HMAC key are saved, and vehicle mapping is filled in for your division. |
| A booking fails to import             | Missing vehicle mapping, or a pickup outside your service area (division).                                          |
| Transferz does not see driver updates | The driver has a valid phone number, and the driver contact and GPS options are on.                                 |
| Test connection fails                 | Wrong API key, or a staging/live mismatch in the server address.                                                    |

Read more about the [Transferz integration](https://codico.io/taxi-dispatch-software/transferz-integration/) on the CodiCo website.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://codico-dispatch.gitbook.io/documentation/integrations/transferz.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.