Créer un lien de paiement

Aperçu

Crée un lien de paiement partageable : produit (lien produit) ou montant fixe (lien instantané). Les liens produit référencent un produit et un prix optionnel ; les liens instantanés ont un montant fixe.

Quand l’utiliser

Utilisez pour factures, vente sociale ou pages de paiement légères sans checkout complet.

Voir aussi

Lister les liens de paiement · Sessions checkout

Authentification

Les routes marchandes nécessitent une clé API dans l’en-tête X-API-KEY (voir Vue d’ensemble). Utilisez une clé test avec https://sandbox.api.lomi.africa et une clé live avec https://api.lomi.africa.

Endpoint

POST /payment-links

URLs de base :

https://sandbox.api.lomi.africa
https://api.lomi.africa

Requête

Paramètres d’URL

Pas d’autre paramètre dans l’URL.

Paramètres de requête

Aucun paramètre de requête.

Corps de la requête

Corps JSON.

Schéma: object

Champ	Obligatoire	Type	Description
`link_type`	Oui	`enum ("product", "instant")`	-
`title`	Oui	`string`	-
`currency_code`	Oui	`enum ("XOF", "USD", "EUR")`	-
`description`	Non	`string`	-
`amount`	Non	`number`	-
`product_id`	Non	`string`	-
`price_id`	Non	`string`	-
`allow_coupon_code`	Non	`boolean`	-
`allow_quantity`	Non	`boolean`	-
`require_billing_address`	Non	`boolean`	When true, show and require billing address on checkout.
`require_email`	Non	`boolean`	When true, show and require customer email. Default true when unset.
`require_phone`	Non	`boolean`	When true, show and require customer phone. Default false when unset.
`require_name`	Non	`boolean`	When true, show and require customer name. Default true when unset.
`fields`	Non	`array<object>`	Optional ordered checkout field schema. When provided, overrides require_* booleans.
`expires_at`	Non	`string`	-
`success_url`	Non	`string`	-
`cancel_url`	Non	`string`	-
`metadata`	Non	`object`	-

Exemple de corps :

{
  "link_type": "product",
  "title": "string",
  "currency_code": "XOF"
}

Réponses

Statut	Description
`201`	Lien de paiement créé avec succès
`400`	Entrée invalide ou erreur de validation
`401`	Clé API invalide ou manquante

Erreurs

Les erreurs suivent un format JSON standard. 401 : clé manquante ou invalide. 404 : ressource introuvable. 429 : trop de requêtes. Pour les créations, envoyez une clé d’idempotence si votre flux le permet.

Exemple

curl -sS -X POST "https://sandbox.api.lomi.africa/payment-links" \
  -H "X-API-KEY: $LOMI_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"link_type":"product","title":"string","currency_code":"XOF"}'

OpenAPI

operationId: PaymentLinksController_create
Operation: POST /payment-links

Schémas complets et Try it : référence API.

Créer un lien de paiement

Sur cette page