API Demande de paiement

  OBLIGATOIRE


Après avoir suivi les étapes se trouvant dans la partie introduction, vous pouvez intégrer dès lors ce client API en suivant les étapes ci-dessous.


DEFINITION


L’API de la "Demande de paiement (DMP)" de PayDunya vous permet d’envoyer de façon très simple vos factures par SMS/Email à vos clients ou partenaires et de recevoir les paiements instantanément de partout dans le monde via une multitude de moyens de paiement.

Le client reçoit un SMS ou un Email, dans lequel il trouvera un lien sur lequel cliquer pour effectuer le paiement en fonction de son moyen de paiement préféré.

1 - Génération de vos clés API


Pour créer un DMP vous avez besoin de vos clés API dans votre compte PayDunya. Donc connectez-vous à votre compte PayDunya déjà créé et accéder à vos clés d'API par le lien détails se trouvant juste à droite de l'application que vous aviez créé.


Les clés d'API sont au nombre de trois(3):

  • PAYDUNYA-MASTER-KEY: qui est la clé principale de votre application

  • PAYDUNYA-PRIVATE-KEY: qui est la clé privée de votre application en mode production

  • PAYDUNYA-TOKEN: qui est le token de votre application en mode production


Une fois les clés générées, vous pouvez maintenant utiliser notre API DMP.


Endpoints API

https://app.paydunya.com/api/v1/dmp-api

Requête POST HTTP


curl -H "Content-Type: application/json" \ 
-H "PAYDUNYA-MASTER-KEY: wQzk9ZwR-Qq9m-0hD0-zpud-je5coGC3FHKW" \ 
-H "PAYDUNYA-PRIVATE-KEY: test_private_rMIdJM3PLLhLjyArx9tF3VURAF5" \ 
-H "PAYDUNYA-TOKEN: IivOiOxGJuWhc5znlIiK" \ 
-X POST -d '{ "recipient_email": "[email protected]", "amount": 1250, "support_fees ": 1, "send_notification":1 }' \ 
"https://app.paydunya.com/api/v1/dmp-api"

Note

  • recipient_email: c’est l’email de celui/celle qui va recevoir la demande de paiement.

  • recipient_phone: c’est le numéro de téléphone de celui/celle qui va recevoir la demande de paiement.

  • amount: c’est le montant de la demande de paiement. Elle est comprise entre 200 et 3 000 000.

  • support_fees: c’est une valeur Booléenne

    • 0: cela veut dire que c’est vos clients qui supportera les frais.

    • 1: cela veut dire que vous supportez les frais.

  • send_notification: c’est une valeur Booléenne

    • 1: cela veut dire que vous avez choisi l’option par défaut et que c’est PayDunya qui envoie les SMS et Emails à vos clients.

    • 0: cela veut dire que la notification (SMS, Email) ne sera pas envoyée. C’est à vous de personnaliser vos SMS et Emails à envoyer à vos clients.

Note


L'un des attributs recipient_phone ou recipient_email est requis dans la requête. Mais il est optionnel de soumettre les deux dans la même requête.


Réponse attendue


{ 
    "success": true,
    "message": "Votre demande de paiement a été envoyée avec succès."
}

Note


N’oubliez que pour cette option les SMS et Emails sont automatiquement envoyés par PayDunya.


REPONSE ATTENDUE DANS LE CAS DE L’OPTION 0


{
    "response-code": "00",
    "reference_number": "4190239470044",
    "url": "https://pydu.me/k5Rrrj",
    "description": "Votre demande de paiement a été créée avec succès"
}

Note

  • response-code: c’est la réponse lorsque la requête est à succès

  • reference_number: c’est le numéro de référence de la demande de paiement. Vous pouvez l’utiliser pour personnaliser vos messages.

  • url: c’est le lien vers la page de paiement à mettre sur vos messages(sms et email) personnalisés.

  • description: C’est le message à afficher lorsque la requête a aboutit.

Note


En plus de l’Endpoint de création de demande de paiement, il existe un autre qui permet de checker le statut. Cette méthode prend en entrée le reference_number qui a été retourné lors de la création de la DMP et vous retourne une response-code et un status.


ENDPOINT POUR CHECKER LE STATUT 

https://app.paydunya.com/api/v1/dmp-api/check-status


curl -H "Content-Type: application/json" \ 
-H "PAYDUNYA-MASTER-KEY: wQzk9ZwR-Qq9m-0hD0-zpud-je5coGC3FHKW" \ 
-H "PAYDUNYA-PRIVATE-KEY: test_private_rMIdJM3PLLhLjyArx9tF3VURAF5" \ 
-H "PAYDUNYA-TOKEN: IivOiOxGJuWhc5znlIiK" \ 
-X POST -d '{ "reference_number" : "4190239470044" }' \ 
"https://app.paydunya.com/api/v1/dmp-api/check-status"

REPONSE ATTENDUE


{
    "response-code": "00",
    "status": "pending"
}

Note

  • response-code: est le code obtenue sur la réponse de la requête . sa valeur est égale à "00" si le reference_number donné en entrée a une demande de paiement . Sinon sa valeur sera égale à "4004".

  • status: est le status de votre demande de paiement.

    • pending: si la demande de paiement est en attente de paiement.

    • completed: si la demande de paiement a été payée.

    • failed: si le paiement de la demande de paiement a échoué.

2 - Codes Erreurs


  • 00

    Requête de paiement créée avec succès.


    
{
    "response-code": "00", 
    "message": "Payment request created successfully",
    "description": "Payment request created successfully"   
}
  • 4000

    Requête mal formée.


    
{
    "response-code": "4000", 
    "message": "Your request was malformed. MASTER_KEY PRIVATE_KEY or TOKEN is missing",
    "description": "MASTER_KEY, PRIVATE_KEY or TOKEN is missing"
}
  • 4001

    Le mode d'intégration doit être le LIVE


    
{
    "response-code": "4001", 
    "message": "Integration mode must be live",
    "description": "Integration mode must be live"
}
  • 1000

    Clés API invalides


    
{
    "response-code": "1000", 
    "message": "Invalid keys",
    "description": "Invalid keys"
}
  • 4004

    Clés API invalides


    
{
    "response-code": "4004", 
    "message": "Payment request not found",
    "description": "Payment request not found"
}