Aller au contenu principal

Payment Links

Les payment links vous permettent d’exposer un point d’entrée de paiement hébergé sans construire votre propre UI de checkout.

Familles de routes implémentées​

Famille de routes authentifiée :

  • POST /api/v1/payment_links
  • GET /api/v1/payment_links/{id}
  • POST /api/v1/payment_links/{id}/deactivate

Route d’accès publique :

  • GET /pay/{slug}

La route publique résout le lien et redirige le client vers une URL de checkout session.

POST /api/v1/payment_links

Authentification :

  • ApiKey ou AppToken
  • scope d’écriture pour les paiements

Exemple :

curl -X POST https://api.ikawaari.com/api/v1/payment_links \
  -H "Authorization: Bearer ik_test_or_app_token" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 25000,
    "currency": "XOF",
    "country": "SN",
    "feeMode": "merchant_pays",
    "description": "Consultation fee",
    "paymentMethodTypes": ["mobile_money", "card"],
    "isSingleUse": false
  }'
ParamètreTypeDescription
amountinteger:int64Montant du lien dans la plus petite unité monétaire.
currencystringDevise du lien.
countrystringCode pays du checkout associé.
feeModestringMode de frais, par défaut merchant_pays.
descriptionstringDescription affichée au client.
paymentMethodTypesstring[]Méthodes proposées.
expiresAtstring:date-timeDate d’expiration optionnelle.
isSingleUsebooleanRend le lien utilisable une seule fois.
GET /api/v1/payment_links/{id}
POST /api/v1/payment_links/{id}/deactivate

Accès public côté client​

GET /pay/{slug}

Cette route publique résout le slug, crée ou récupère la checkout session associée, puis redirige le client vers l’URL de checkout hébergé.

Note opérationnelle​

Les payment links font partie du domaine checkout implémenté et sont étroitement liés à :

  • les checkout sessions hébergées
  • la gestion des payment links dans le dashboard marchand
  • l’accès public au checkout via des points d’entrée basés sur slug

Sections liées​