POST/api/v1/payments/linksClé API

Créer un lien de paiement

Génère un lien réutilisable ou à usage unique pointant vers le checkout hébergé.

Corps de requête

Nom	Type	Requis	Description
amount	string	Oui	Montant
currency	string	Oui	Devise
description	string	—	Libellé
slug	string	—	Slug personnalisé (optionnel)
reusable	boolean	—	Lien réutilisable
maxUses	number	—	Nombre max d'utilisations
allowedMethods	string[]	—	Méthodes autorisées
successUrl	string	—	URL de succès
cancelUrl	string	—	URL d'annulation

Exemple requête

json

{
  "amount": "1000",
  "currency": "USD",
  "description": "Facture #42",
  "reusable": false,
  "allowedMethods": [
    "MOBILE_MONEY",
    "CARD"
  ]
}

Réponse (data)

Nom	Type	Requis	Description
object	string	Oui	Toujours payment_link
id	string	Oui	Identifiant template
slug	string	Oui	Slug URL du lien
url	string	Oui	URL publique du lien
linkStatus	string	Oui	ACTIVE, EXPIRED, CANCELLED, etc.
usesCount	number	Oui	Nombre d'utilisations réussies
maxUses	number \| null	—	Plafond d'utilisations
title	string \| null	—	Titre affiché au payeur
description	string \| null	—	Description complémentaire
reusable	boolean	—	Lien réutilisable
allowedMethods	string[]	—	Méthodes de paiement autorisées
successUrl	string \| null	—	URL de redirection après succès
cancelUrl	string \| null	—	URL de redirection après annulation

Exemple réponse

json

{
  "success": true,
  "data": {
    "object": "payment_link",
    "id": "cs_link_template_001",
    "reference": "summer-sale",
    "slug": "summer-sale",
    "url": "https://checkout.example/link/summer-sale",
    "amount": "5000",
    "currency": "CDF",
    "title": "Soldes d'été",
    "description": "Facture #42",
    "status": "OPEN",
    "linkStatus": "ACTIVE",
    "usesCount": 3,
    "maxUses": 100,
    "reusable": true,
    "allowedMethods": [
      "MOBILE_MONEY",
      "CARD"
    ],
    "successUrl": "https://merchant.example/thanks",
    "cancelUrl": null,
    "expiresAt": "2026-12-31T23:59:59.000Z",
    "createdAt": "2026-08-01T08:00:00.000Z"
  },
  "error": null
}

Erreurs

PAYMENT_LINK_SLUG_TAKEN (409) — Le slug est déjà utilisé

Exemples

bash

curl -X POST https://api.dev.izzi-finance.com/api/v1/api/v1/payments/links \
  -H "Authorization: Bearer izzi_mk_sandbox_…" \
  -H "Idempotency-Key: charge-order-1234-unique" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": "1000",
  "currency": "USD",
  "description": "Facture #42",
  "reusable": false,
  "allowedMethods": [
    "MOBILE_MONEY",
    "CARD"
  ]
}'

Voir aussi

GET/api/v1/payments/linksClé API

Lister les liens de paiement

Liste paginée des liens du tenant/marchand.

Paramètres de requête

Nom	Type	Requis	Description
page	number	—	Page
limit	number	—	Limite
status	string	—	Statut session : OPEN, CANCELLED

Réponse (data)

Nom	Type	Requis	Description
object	string	Oui	Toujours payment_link
id	string	Oui	Identifiant template
slug	string	Oui	Slug URL du lien
url	string	Oui	URL publique du lien
linkStatus	string	Oui	ACTIVE, EXPIRED, CANCELLED, etc.
usesCount	number	Oui	Nombre d'utilisations réussies
maxUses	number \| null	—	Plafond d'utilisations
title	string \| null	—	Titre affiché au payeur
description	string \| null	—	Description complémentaire
reusable	boolean	—	Lien réutilisable
allowedMethods	string[]	—	Méthodes de paiement autorisées
successUrl	string \| null	—	URL de redirection après succès
cancelUrl	string \| null	—	URL de redirection après annulation

Exemple réponse

json

{
  "success": true,
  "data": [
    {
      "object": "payment_link",
      "id": "cs_link_template_001",
      "reference": "summer-sale",
      "slug": "summer-sale",
      "url": "https://checkout.example/link/summer-sale",
      "amount": "5000",
      "currency": "CDF",
      "title": "Soldes d'été",
      "description": "Facture #42",
      "status": "OPEN",
      "linkStatus": "ACTIVE",
      "usesCount": 3,
      "maxUses": 100,
      "reusable": true,
      "allowedMethods": [
        "MOBILE_MONEY",
        "CARD"
      ],
      "successUrl": "https://merchant.example/thanks",
      "cancelUrl": null,
      "expiresAt": "2026-12-31T23:59:59.000Z",
      "createdAt": "2026-08-01T08:00:00.000Z"
    }
  ],
  "error": null,
  "meta": {
    "page": 1,
    "pageSize": 25,
    "total": 1,
    "totalPages": 1
  }
}

Exemples

bash

curl -X GET https://api.dev.izzi-finance.com/api/v1/api/v1/payments/links \
  -H "Authorization: Bearer izzi_mk_sandbox_…" \
  -H "Content-Type: application/json"

Voir aussi

POST/api/v1/payments/links/:id/cancelClé API

Annuler un lien de paiement

Désactive un lien existant.

Paramètres de chemin

Nom	Type	Requis	Description
id	string	Oui	Identifiant du lien

Réponse (data)

Nom	Type	Requis	Description
object	string	Oui	Toujours payment_link
id	string	Oui	Identifiant template
slug	string	Oui	Slug URL du lien
url	string	Oui	URL publique du lien
linkStatus	string	Oui	ACTIVE, EXPIRED, CANCELLED, etc.
usesCount	number	Oui	Nombre d'utilisations réussies
maxUses	number \| null	—	Plafond d'utilisations
title	string \| null	—	Titre affiché au payeur
description	string \| null	—	Description complémentaire
reusable	boolean	—	Lien réutilisable
allowedMethods	string[]	—	Méthodes de paiement autorisées
successUrl	string \| null	—	URL de redirection après succès
cancelUrl	string \| null	—	URL de redirection après annulation

Exemple réponse

json

{
  "success": true,
  "data": {
    "object": "payment_link",
    "id": "cs_link_template_001",
    "reference": "summer-sale",
    "slug": "summer-sale",
    "url": "https://checkout.example/link/summer-sale",
    "amount": "5000",
    "currency": "CDF",
    "title": "Soldes d'été",
    "description": "Facture #42",
    "status": "CANCELLED",
    "linkStatus": "CANCELLED",
    "usesCount": 3,
    "maxUses": 100,
    "reusable": true,
    "allowedMethods": [
      "MOBILE_MONEY",
      "CARD"
    ],
    "successUrl": "https://merchant.example/thanks",
    "cancelUrl": null,
    "expiresAt": "2026-12-31T23:59:59.000Z",
    "createdAt": "2026-08-01T08:00:00.000Z"
  },
  "error": null
}

Erreurs

PAYMENT_LINK_NOT_FOUND (404) — Lien introuvable

Exemples

bash

curl -X POST https://api.dev.izzi-finance.com/api/v1/api/v1/payments/links/:id/cancel \
  -H "Authorization: Bearer izzi_mk_sandbox_…" \
  -H "Content-Type: application/json"

Voir aussi

GET/api/v1/payments/links/:idClé API

Détail d'un lien de paiement

Récupère un lien de paiement par identifiant.

Paramètres de chemin

Nom	Type	Requis	Description
id	string	Oui	Identifiant du lien

Réponse (data)

Nom	Type	Requis	Description
object	string	Oui	Toujours payment_link
id	string	Oui	Identifiant template
slug	string	Oui	Slug URL du lien
url	string	Oui	URL publique du lien
linkStatus	string	Oui	ACTIVE, EXPIRED, CANCELLED, etc.
usesCount	number	Oui	Nombre d'utilisations réussies
maxUses	number \| null	—	Plafond d'utilisations
title	string \| null	—	Titre affiché au payeur
description	string \| null	—	Description complémentaire
reusable	boolean	—	Lien réutilisable
allowedMethods	string[]	—	Méthodes de paiement autorisées
successUrl	string \| null	—	URL de redirection après succès
cancelUrl	string \| null	—	URL de redirection après annulation

Exemple réponse

json

{
  "success": true,
  "data": {
    "object": "payment_link",
    "id": "cs_link_template_001",
    "reference": "summer-sale",
    "slug": "summer-sale",
    "url": "https://checkout.example/link/summer-sale",
    "amount": "5000",
    "currency": "CDF",
    "title": "Soldes d'été",
    "description": "Facture #42",
    "status": "OPEN",
    "linkStatus": "ACTIVE",
    "usesCount": 3,
    "maxUses": 100,
    "reusable": true,
    "allowedMethods": [
      "MOBILE_MONEY",
      "CARD"
    ],
    "successUrl": "https://merchant.example/thanks",
    "cancelUrl": null,
    "expiresAt": "2026-12-31T23:59:59.000Z",
    "createdAt": "2026-08-01T08:00:00.000Z"
  },
  "error": null
}

Erreurs

PAYMENT_LINK_NOT_FOUND (404) — Lien introuvable

Exemples

bash

curl -X GET https://api.dev.izzi-finance.com/api/v1/api/v1/payments/links/:id \
  -H "Authorization: Bearer izzi_mk_sandbox_…" \
  -H "Content-Type: application/json"

Voir aussi

PATCH/api/v1/payments/links/:idClé API

Modifier un lien de paiement

Met à jour les champs éditables d'un lien (titre, expiration, méthodes, etc.). Montant, devise et slug sont immuables.

Paramètres de chemin

Nom	Type	Requis	Description
id	string	Oui	Identifiant du lien

Corps de requête

Nom	Type	Requis	Description
title	string	—	Titre
description	string	—	Description
reusable	boolean	—	Réutilisable
maxUses	number	—	Nombre max d'utilisations
expiresAt	string	—	Date d'expiration ISO 8601
neverExpires	boolean	—	Sans expiration
allowedMethods	string[]	—	Méthodes autorisées
successUrl	string	—	URL de succès
cancelUrl	string	—	URL d'annulation

Exemple requête

json

{
  "title": "Soldes d'été — mise à jour",
  "neverExpires": true,
  "allowedMethods": [
    "MOBILE_MONEY",
    "CARD"
  ]
}

Réponse (data)

Nom	Type	Requis	Description
object	string	Oui	Toujours payment_link
id	string	Oui	Identifiant template
slug	string	Oui	Slug URL du lien
url	string	Oui	URL publique du lien
linkStatus	string	Oui	ACTIVE, EXPIRED, CANCELLED, etc.
usesCount	number	Oui	Nombre d'utilisations réussies
maxUses	number \| null	—	Plafond d'utilisations
title	string \| null	—	Titre affiché au payeur
description	string \| null	—	Description complémentaire
reusable	boolean	—	Lien réutilisable
allowedMethods	string[]	—	Méthodes de paiement autorisées
successUrl	string \| null	—	URL de redirection après succès
cancelUrl	string \| null	—	URL de redirection après annulation

Exemple réponse

json

{
  "success": true,
  "data": {
    "object": "payment_link",
    "id": "cs_link_template_001",
    "reference": "summer-sale",
    "slug": "summer-sale",
    "url": "https://checkout.example/link/summer-sale",
    "amount": "5000",
    "currency": "CDF",
    "title": "Soldes d'été",
    "description": "Facture #42",
    "status": "OPEN",
    "linkStatus": "ACTIVE",
    "usesCount": 3,
    "maxUses": 100,
    "reusable": true,
    "allowedMethods": [
      "MOBILE_MONEY",
      "CARD"
    ],
    "successUrl": "https://merchant.example/thanks",
    "cancelUrl": null,
    "expiresAt": "2026-12-31T23:59:59.000Z",
    "createdAt": "2026-08-01T08:00:00.000Z"
  },
  "error": null
}

Erreurs

PAYMENT_LINK_NOT_FOUND (404) — Lien introuvable
PAYMENT_LINK_MAX_USES_BELOW_USAGE (400) — maxUses inférieur aux utilisations actuelles

Exemples

bash

curl -X PATCH https://api.dev.izzi-finance.com/api/v1/api/v1/payments/links/:id \
  -H "Authorization: Bearer izzi_mk_sandbox_…" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Soldes d'été — mise à jour",
  "neverExpires": true,
  "allowedMethods": [
    "MOBILE_MONEY",
    "CARD"
  ]
}'

Voir aussi

POST/api/v1/payments/links/:id/reactivateClé API

Réactiver un lien de paiement

Réactive un lien précédemment annulé (non expiré, non épuisé).

Paramètres de chemin

Nom	Type	Requis	Description
id	string	Oui	Identifiant du lien

Réponse (data)

Nom	Type	Requis	Description
object	string	Oui	Toujours payment_link
id	string	Oui	Identifiant template
slug	string	Oui	Slug URL du lien
url	string	Oui	URL publique du lien
linkStatus	string	Oui	ACTIVE, EXPIRED, CANCELLED, etc.
usesCount	number	Oui	Nombre d'utilisations réussies
maxUses	number \| null	—	Plafond d'utilisations
title	string \| null	—	Titre affiché au payeur
description	string \| null	—	Description complémentaire
reusable	boolean	—	Lien réutilisable
allowedMethods	string[]	—	Méthodes de paiement autorisées
successUrl	string \| null	—	URL de redirection après succès
cancelUrl	string \| null	—	URL de redirection après annulation

Exemple réponse

json

{
  "success": true,
  "data": {
    "object": "payment_link",
    "id": "cs_link_template_001",
    "reference": "summer-sale",
    "slug": "summer-sale",
    "url": "https://checkout.example/link/summer-sale",
    "amount": "5000",
    "currency": "CDF",
    "title": "Soldes d'été",
    "description": "Facture #42",
    "status": "OPEN",
    "linkStatus": "ACTIVE",
    "usesCount": 3,
    "maxUses": 100,
    "reusable": true,
    "allowedMethods": [
      "MOBILE_MONEY",
      "CARD"
    ],
    "successUrl": "https://merchant.example/thanks",
    "cancelUrl": null,
    "expiresAt": "2026-12-31T23:59:59.000Z",
    "createdAt": "2026-08-01T08:00:00.000Z"
  },
  "error": null
}

Erreurs

PAYMENT_LINK_CANNOT_REACTIVATE (409) — Lien non annulé, expiré ou épuisé

Exemples

bash

curl -X POST https://api.dev.izzi-finance.com/api/v1/api/v1/payments/links/:id/reactivate \
  -H "Authorization: Bearer izzi_mk_sandbox_…" \
  -H "Content-Type: application/json"

Voir aussi

DELETE/api/v1/payments/links/:idClé API

Supprimer un lien de paiement

Supprime définitivement un lien sans paiement enregistré (usesCount = 0).

Paramètres de chemin

Nom	Type	Requis	Description
id	string	Oui	Identifiant du lien

Réponse (data)

Nom	Type	Requis	Description
id	string	Oui	ID supprimé
deleted	boolean	Oui	Toujours true

Exemple réponse

json

{
  "success": true,
  "data": {
    "id": "cs_link_template_001",
    "deleted": true
  },
  "error": null
}

Erreurs

PAYMENT_LINK_HAS_USES (409) — Le lien a déjà reçu des paiements

Exemples

bash

curl -X DELETE https://api.dev.izzi-finance.com/api/v1/api/v1/payments/links/:id \
  -H "Authorization: Bearer izzi_mk_sandbox_…" \
  -H "Content-Type: application/json"