Kalipay logo Kalipay.
API REST · Webhooks temps réel

Documentation API.

Tout ce qu'il faut pour intégrer Kalipay en moins de cinq minutes. SDKs, endpoints, webhooks, exemples.

Démarrage rapide

Trois étapes jusqu'au premier paiement.

De la création de compte au premier payment.succeeded : trois commandes suffisent. Aucune configuration serveur, aucun environnement à installer.

01 · Clé API

Récupérer votre clé API

Connectez-vous au tableau de bord, ouvrez l'onglet Développeurs, copiez votre clé secrète sk_live_….

curl https://api.kalipay.com/v1/keys \
  -H "Authorization: Bearer sk_live_…"
02 · SDK

Installer le SDK

Quatre langages disponibles. La version Node couvre 95 % des intégrations e-commerce.

npm install @kalipay/node
# ou
yarn add @kalipay/node
03 · Paiement

Créer une transaction

Un PaymentIntent représente l'intention d'encaisser : montant, devise, client.

import Kalipay from "@kalipay/node";
const kp = new Kalipay(process.env.KALIPAY_KEY);

const intent = await kp.payments.create({
  amount: 4990,
  currency: "EUR",
  customer: "cus_8a2f1c"
});
Référence API

Six endpoints essentiels.

Toutes les ressources Kalipay suivent les conventions REST : verbes HTTP standard, JSON, codes d'erreur explicites. Versionning par préfixe /v1/.

POST /v1/payments Créer un paiement avec montant, devise et client associé.
GET /v1/payments/:id Récupérer le détail d'un paiement, son statut et son historique.
POST /v1/refunds Émettre un remboursement total ou partiel sur une transaction.
POST /v1/customers Créer un client réutilisable avec ses moyens de paiement.
GET /v1/transactions Lister les transactions filtrables par date, statut ou devise.
POST /v1/webhooks Enregistrer un endpoint webhook pour recevoir les événements.
SDKs officiels

Quatre langages maintenus.

Chaque SDK offre la même surface d'API : typages stricts, gestion automatique des retries idempotents, signature des webhooks intégrée. Sources ouvertes sur GitHub.

01 · JavaScript

Node.js & TypeScript

npm install @kalipay/node

Compatible Node 18+, support natif TypeScript.

Voir sur GitHub
02 · Python

Python

pip install kalipay

Compatible Python 3.9+, type hints complets, async natif.

Voir sur GitHub
03 · PHP

PHP

composer require kalipay/php

PHP 8.1+, intégrations Laravel et Symfony documentées.

Voir sur GitHub
04 · Ruby

Ruby

gem install kalipay

Ruby 3.0+, gem Rails dédiée pour les engines.

Voir sur GitHub
Webhooks

Événements temps réel.

Chaque événement est signé HMAC-SHA256 avec votre secret. Retries exponentiels jusqu'à 72 heures en cas d'indisponibilité de votre endpoint.

payment.succeeded Émis dès qu'un paiement est confirmé et capturé.
payment.failed Échec d'autorisation, fonds insuffisants, fraude détectée.
refund.created Remboursement émis manuellement ou via API.
dispute.opened Un client conteste une transaction auprès de sa banque.
Support technique

Besoin d'aide pour intégrer ?

Notre équipe d'ingénieurs répond aux questions d'implémentation par email, chat et appels en visio. Premier message en moins d'une heure ouvrée.

Centre d'aide Contacter un ingénieur