Skip to content
Log inContact
Developers

Wire benefits into your systems

A JSON REST API, authenticated by key, exposing what the portal does: create a beneficiary, issue a card, credit a wallet, upload a payout batch, read a balance.

What the API gives you

REST API

Explicit resources, standard HTTP verbs, JSON responses and stable error codes. The identifiers returned on creation are the ones used everywhere else.

Signed webhooks

Every lifecycle event — card issued, wallet credited, transaction accepted — can be pushed to your endpoint, with a signature to verify.

Test environment

An isolated environment, with its own keys and disposable data, to run the full integration before switching to production.

API keys are managed from the portal

Each company generates its keys, names them, revokes them. A revoked key stops being accepted immediately. A key is shown in full only once, at creation — after that, only its fingerprint remains visible.

  • One key per integration, so revoking one doesn't break the others
  • Never a key in client-side code or in a repository
  • Periodic rotation: create the new key before revoking the old one
Authorization
# En-tête de chaque appelAuthorization: Bearer tk_live_9f2c… # 401 si la clé est révoquée{  "error": "invalid_api_key"}

Receiving events

Declare a URL, pick the events you care about, verify the signature on arrival. Failed deliveries are retried, and their history is visible from the portal.

POST /votre-endpoint
{  "event": "gift_card.redeemed",  "reference": "gc_4KQ2mn",  "amount": 180.00,  "balance": 320.00,  "occurredAt": "2026-09-15T12:04:11Z"} // X-Tiki-Signature: à vérifier avant de traiter

The integration path

  1. Get test access

    You receive an isolated environment and a dedicated API key, with no commitment and no real data.

  2. Work through the cases

    You implement issuance, crediting and webhook handling, and replay the error cases.

  3. Switch to production

    The same calls, a production key, your real beneficiaries. The API contract does not change.

The detailed integration guide, the endpoint reference and payload examples are provided when your test environment is opened. Write to us to get access.

Request test access

Tell us what you want to automate and from which system. We open a test environment and help you through the first calls.

Contact us