Générer un lien de paiement
Crée un nouveau lien de paiement avec les paramètres spécifiés.Le lien généré peut être partagé avec les clients pour effectuer des paiements.Retourne les informations détaillées du lien créé avec sa référence unique.
Request
- Base URL: https://sandbox-api.djomy.africa
- URL: https://sandbox-api.djomy.africa/v1/links
- Auth: API key in header X-API-KEY and HTTP bearer
Request body
Indique le montant à payer. Si fournit, le payeur n'aura pas à le saisir au moment du paiement.
Indique le nom du lien. Utile pour retrouver facilement le lien de paiement dans la rubrique Liens de paiements dans l'espace marchand
Le numéro de téléphone du payeur. Si vous voulez que Djomy envoie le lien de paiement au payeur alors le numéro de téléphone est obligatoire
Indique si Djomy doit envoyer le lien de paiement au payeur par SMS.
- *true : Indique que Djomy peut envoyer le lien
- false : Indique que le lien doit/sera pas envoyé La valeur par défaut est false
Permet de donner du contexte au paiement qui sera effectué. Cette information utile et affichée dans le tableau de bord
Code du pays, Il doit respecter le standard international. ISO (ex : GN pour la Guinée, CI pour le Côte D'Ivoire)
Indique le type d'usage de lien de paiement."
- UNIQUE : indique qu'un seul paiement pour être effectués à travers ce lien. Une fois le paiement effectué avec succès, le lien se d'ésactive automatiquement
- MULTIPLE : indique que plusieurs paiements pour être effectués à travers ce lien.
Indique la date à laquelle le lien ne sera plus valide. Il sera automatique désactivé
Permet au marchant d'indiquer une référence qui sera lié au paiement une fois effectué. Dans le cas de paiement à usage multiple, tous les paiements effectués seront liés au lien à travers cette référence
Indique le nombre de paiement autorisé à travers ce lien. Une fois ce nombre effectué avec succès est atteint, le lien est automatiquement desactivé. ⚠️ Attention ce champs n'est applicable que pour les usages MULTIPLE
Url de redirection vers le site du marchand. Permet au payeur d'être vers le site du marchand, une fois le paiment finalisé. Djomy rajoutera en paramètre d'url les informations suivantes : transactionId et le status. Si l'url est fournie, alors elle doit être en https. Le cas échéant un bad request sera retourné en reponse. Exemple d'url de retour : https://merchant.example.com/checkout/return ?transactionId=691b9039-0818-4ff2-a3a0-6073c3b4660d &status=SUCCESS
Url de redirection vers le site du marchand dans le cas ou le payeur veut annuler le processus de paiement. ⚠️ L'annulation n'est plus possible une fois le paiement soumis. Cependant si le paiement échoue, elle devient possible Si l'url est fournie, alors elle doit être en https. Le cas échéant un bad request sera retourné en reponse. Exemple d'url de retour : https://merchant.example.com/checkout/cancel
Indique la liste des méthodes de paiement qui seront affichées sur la page de page de paiement que vous avez fourni. Par défaut toutes méthodes seront affichées.
- **OM** : Orange Money
- **MOMO** : MTN MoMo
- **SOUTRA_MONEY** : Soutra money
- **PAYCARD** : PayCard
- **CARD** : pour les paiements par carte (VISA & MasterCard)
- ⚠️ Si vous fournissez une méthode de paiement qui ne figure pas dans la liste ou avec une mauvaise prthographe, celle-ci ne sera pas prise en compte.
Si la liste fournie n'est pas valide, la liste par défaut sera affichée (c'est à dire toutes les méthodes) sur la page de paiement.
Ce champs optionnel permet au marchant d'envoyer des informations qu'il souhaitent récupérer dans les webhooks et/ou quand il demande le datail d'un lien de paiement
- Il doit être au format JSON et ne contenir ni de list, ni de structure imbriquée
- Ex : { "order_id": "ORD-456", "vip": true, "referrer": "campaign-2026" }
Indique la redirection automatique vers le site du marchand. Par défaut, elle est à false et aucune redirection ne sera faite.
Response
Lien de paiement généré avec succès
Changes
No recorded changes to this operation across all 1 revision of this API.