Paiements

Demander un paiement avec redirection vers le portail Djomy

Cet endpoint permet d’initier un nouveau paiement avec redirection vers le portail Djomy pour la finalisation par le payeur.

Le fonctionnement est le suivant : • L’API retourne une URL de redirection dans la réponse. • Le marchand doit rediriger le payeur vers cette URL. • Le payeur choisit alors son moyen de paiement, saisit ses coordonnées (numéro de téléphone, carte bancaire, IBAN, etc.) et procède au paiement. • Une fois le paiement terminé, Djomy redirige le payeur vers l’URL de retour (returnUrl) fournie lors de la création du paiement.

✅ Tous les moyens de paiement sont autorisés sur cet endpoint, y compris VISA et MasterCard.

🔒 Sécurité : Cet appel nécessite :

  • Un en-tête Authorization : Bearer <jwt_token>
  • Un en-tête X-API-KEY : clientId:signature

La signature HMAC-SHA256 est calculée de la façon suivante :

signature = HMAC_SHA256(clientId, clientSecret)
X-API-KEY = clientId:signature

Exemple :

X-API-KEY: djomy-merchant-001:ab56b4d92b40713acc5af89985d4b786
post/v1/payments/gateway

Request

  • Base URL: https://sandbox-api.djomy.africa
  • URL: https://sandbox-api.djomy.africa/v1/payments/gateway
  • Auth: API key in header X-API-KEY and HTTP bearer

Request body

amountnumber required

Motant à payer par le payyer. Il doit être un nombre positif

countryCodestring required

Code du pays, Il doit respecter le standard international. ISO (ex : GN pour la Guinée, CI pour le Côte D'Ivoire)

payerNumberstring required
   Le numéro de téléphone du payeur. Il est obligatoire et doit être au format international. Ex 00224623707722
allowedPaymentMethodsstring[] 
Indique la liste des méthodes de paiement qui seront affichées sur la page de page de paiement. 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.
descriptionstring

Description associée au paiement pour donner du contexte

merchantPaymentReferencestring

Indique la reference fournie par le marchand. Celle-ci peut être liée à une référence de commande chez le marchand. Elle n'est pas obligatoire, mais fortement recommandée

returnUrlstring

Url de retour vers le site marchand si paiement effectué avec succès ou non.

Ce champ est obligatoire si le payeur est à rédiriger vers le portail de paiement de Djomy et doit être en htpps.

cancelUrlstring

Url de retour vers le site marchand si le payeur décide de quiter la page de paiement avant soumission du paiement.

Ce champ n'est pas fourni alors le returnUrl sera utilisé. Il doit toutefois être en htpps, s'il est fourni.

metadataobject 
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 status d'un 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" }

Response

Paiement initié avec succès

Changes

No recorded changes to this operation across all 1 revision of this API.