Skip to main content

Zelty Integration Guide

This guide explains how to connect your Zelty account to the Keyban Dashboard. It is primarily intended for restaurant managers, with optional support from developers.

Overview​

The Keyban-Zelty integration allows you to:

  • Connect one of your restaurants to a Keyban application.
  • Validate a Zelty API key.
  • Create a payment method named Keyban in your Zelty backoffice.
  • Ensure transactions initiated from the Keyban Wallet are correctly tracked in Zelty.
  • Maintain a one-to-one link between a restaurant and a Keyban application.

Prerequisites​

Before starting, make sure you have:

  • Access to your Zelty backoffice: https://bo.zelty.fr
  • A valid administrator account in the Keyban Dashboard
  • An existing Keyban application

1. Creating or Retrieving Your Zelty API Key​

A valid clé API is required to link your Zelty account with Keyban.

Option A – via the Marketplace​

If your partner is listed in the Zelty marketplace:

  1. Go to https://bo.zelty.fr/marketplace
  2. Locate your partner (e.g. Keyban) and access the integration.
  3. Generate or retrieve your clé API from there.

Option B – via Manual Form (outside the marketplace)​

If the integration is not listed in the Zelty marketplace:

  1. Visit the request form: https://zelty.fr/forms/api
  2. Fill in the required information.
  3. API keys are created every Tuesday and Thursday at the end of the day.

🔐 Security note: Your clé API will only be visible for 5 minutes after generation. If you see a masked value (asterisks), disconnect and reconnect to trigger a new key.

2. Creating a "Keyban" Payment Method​

To record transactions properly, you must configure a méthode de paiement named Keyban in your Zelty backoffice.

Steps to Add a Payment Method​

  1. Go to: https://bo.zelty.fr/transaction-methods
  2. From the menu, select Configurations > Méthodes de paiement
  3. Click Ajouter
  4. Fill in the following:
    • Nom: Keyban
    • Icône: optional
    • Type spécial: select according to your needs (Aucun is acceptable)

You may also configure:

  • Whether the drawer opens automatically
  • A code comptable (optional)
  • Order display in the caisse
  • Activation options (e.g., disable or enable counting)

⚠️ The method must be named exactly Keyban (case-sensitive) to be recognized by the Keyban Dashboard.

You can create the method:

  • At the enseigne level (shared across multiple restaurants)
  • Or at the restaurant level (specific to one location)

3. Linking a Restaurant to a Keyban Application​

Now that you have your clé API and a valid payment method, proceed to the Keyban Dashboard.

  1. Log into the Keyban Dashboard
  2. Open your application configuration
  3. Select Zelty as your POS provider
  4. Paste your clé API
  5. Choose the restaurant you want to link
  6. Click Validate Integration

The system will:

  • Confirm the validity of your clé API
  • Check that a méthode de paiement named Keyban exists
  • Finalize the one-to-one association between the selected restaurant and your Keyban application

📌 Note: One restaurant ↔ one application. This link is exclusive.

4. Known Limitations​

  • One-to-one constraint: Each restaurant can only be linked to one Keyban application, and vice versa.

Final Steps​

Once validated:

  • Your restaurant is fully connected to Keyban
  • Transactions initiated from the Keyban Wallet will be recorded using the Keyban méthode de paiement
  • Your integration is live

For more help, contact your onboarding manager or refer to the admin logs in the Keyban Dashboard.