Aller au contenu

Environnement de développement : contenu en cours de rédaction, rien ne pointe vers la production.

Sommaire de la documentation

Guides

Liens de paiement

Encaisser sans site marchand : créer un lien, le partager, suivre ses paiements, depuis le dashboard ou par l’API v3.

Un lien de paiement est une page de paiement prête à partager : vous l’envoyez par WhatsApp, e-mail ou SMS, ou vous imprimez son QR code. Chaque payeur qui l’ouvre paie sur le checkout Konnect avec les moyens de paiement routés sur votre compte de paiement. Konnect ne détient pas les fonds : l’argent va directement du payeur à votre compte chez le prestataire.

Dans le dashboard

Menu Liens de paiement, puis Nouveau lien :

  1. Un titre (ce que le payeur voit, par exemple « Atelier poterie, samedi 10 h ») et une description facultative.
  2. Le montant : fixe, ou libre avec un minimum et un maximum (dons, acomptes, participation).
  3. L’usage : unique (le lien est terminé après un paiement réussi) ou réutilisable, avec un nombre maximal de paiements facultatif.
  4. Une date d’expiration facultative (un an au plus).
  5. Les moyens de paiement proposés (tous ceux de votre compte par défaut), les informations du payeur à demander (nom, e-mail, téléphone : masqué, facultatif ou obligatoire), un message de remerciement et une URL de retour.

Après la création, le panneau de partage donne le lien, son QR code (SVG ou PNG) et des boutons WhatsApp, e-mail et SMS. La fiche du lien montre ses paiements, le montant encaissé et le taux de conversion. Il faut la permission payments.create pour créer et modifier un lien, payments.cancel pour le désactiver, payments.view pour les consulter.

Par l’API

Avec votre clé API (ou une session et organisationId) :

POST /payment-links HTTP/1.1
Host: api.konnect.network
x-api-key: <votre clé>
Content-Type: application/json
Idempotency-Key: 5d1f6c1e-1b7a-4b55-9a3f-0e2d1c4b5a69

{
  "title": "Atelier poterie, samedi 10 h",
  "amountType": "fixed",
  "amount": 45000,
  "usage": "reusable",
  "maxUses": 12,
  "payerFields": { "name": "required", "email": "optional", "phone": "hidden" },
  "successMessage": "Merci, à samedi."
}

La réponse contient url (la page publique, https://checkout.konnect.example/l/<slug>), status et les compteurs paymentsCount, succeededCount et collectedAmount (en millimes).

RouteRôle
GET /payment-linksListe, filtres status, account, q, pagination par cursor
GET /payment-links/{linkId}Un lien
PATCH /payment-links/{linkId}Modifier (le compte de paiement et le slug ne changent pas)
POST /payment-links/{linkId}/disable puis /enableDésactiver, réactiver
POST /payment-links/{linkId}/duplicateCopier les réglages dans un nouveau lien
GET /payment-links/{linkId}/statsPaiements par statut, montant encaissé, conversion
GET /payments?link={linkId}Les paiements nés du lien

Statuts et règles

  • active : le lien accepte des paiements ; disabled : désactivé par vous ; expired : sa date d’expiration est passée ; completed : le nombre maximal de paiements réussis est atteint.
  • Chaque payeur crée un paiement v3 (canal link, champ paymentLinkId) valable 30 minutes. Vos webhooks payment.succeeded et suivants arrivent comme pour tout paiement.
  • Un lien à usage unique est réservé pendant qu’un payeur paie : un second payeur reçoit « paiement en cours » (409 link_busy) jusqu’à la fin ou l’expiration de ce paiement. Deux payeurs simultanés n’obtiennent jamais tous les deux le dernier paiement.
  • Augmenter le nombre maximal de paiements d’un lien completed le réactive. Un lien n’est jamais supprimé, car ses paiements le référencent : désactivez-le.