(229) 65301333
Contact Us
Créer un compte
img not found img not found

Updated on 25 / 09 / 2023

CicaPay API DOC MENU

Exemple de Codes de l'API

Tutoriels de Cas d'Utilisation

Voici un ensemble de cas d'utilisation potentiel pour l'API CicaPay avec des exemples d'étapes d'intégration.

Prérequis pour les Tutoriels

  • Un Compte CicaPay vérifier ( KYC ) ( personnel / business )
  • Une plateforme capable d'éffectuer des appels HTTP à l'API CicaPay
  • Compréhension par les développeurs de la section intro documentation pour l'API CicaPay
  • Une clé API ( TEST / LIVE ) à obtenir sur la page API KEYS du dashboard CicaPay
  • Connaissance des différents codes de réseau prise en charge

Par défaut nous allons utiliser le mode test durant le tutoriel

Tutoriel 1 : PAY IN ( Paiement entrant par défaut )

Remarque

Vous devez sauvegarder le meTa que vous allez générer.

CicaPay ne fait pas de conversion pour la méthode fiat, vous devez considérer le XOF pour la méthode fiat.

Seule la méthode crypto bénéficie d'une conversion de devise.

Ce tutoriel couvre la fonctionnalité de paiement entrant basique.

Etape 1
Endpoint de la requête : https://api.cicapay.com/e_merchant/{MODE}/pay_in1/{YOUR_API_KEY}

On remplace {MODE} par test ou live sans les { }

On remplace {YOUR_API_KEY} par votre clé privé sans les { }

Exemple d'endpoint complète : https://api.cicapay.com/e_merchant/test/pay_in1/475kjdNVLPF745szerfr
Les données de la requête
Nom Type Caractère Maximum Requis ? Description
description String 30 Oui Description de la Commande
success_url String link format Oui Lien vers lequel le client sera redirigé après paiement
cancel_url String link format Oui Lien vers lequel le client sera redirigé en cas d'échec de paiement
order Array - Oui Tableau contenant la commande du client.
meTa String 20 Oui ID fourni par le marchand, il va s'en servir pour obtenir les informations de la transaction.
payWith String format CicaPay Oui Il s'agit de la méthode de paiement : fiat ou crypto. Le client sera redirigé vers la page de paiement en fonction de la méthode choisi.
currency String Currency Code (ISO 4217) Oui La devise utilisée par le marchand pour fixer la valeur de la commande. CicaPay supporte 3 devises à l'heure actuelle : EUR pour l'Euro, USD pour le dollars et XOF pour le Fcfa.

La réponse de cet appel d'API en cas de succès, renverra l'ID de la transaction que vous allez utiliser dans l'étape 2.

Etape 2
Endpoint de la requête : https://api.cicapay.com/e_merchant/{MODE}/pay_in2/{YOUR_API_KEY}

On remplace {MODE} par test ou live sans les { }

On remplace {YOUR_API_KEY} par votre clé privé sans les { }

Exemple d'endpoint complète : https://api.cicapay.com/e_merchant/test/pay_in2/475kjdNVLPF745szerfr
Les données de la requête
Nom Type Caractère Maximum Requis ? Description
description String 30 Oui Description de la Commande
success_url String link format Oui Lien vers lequel le client sera redirigé après paiement
cancel_url String link format Oui Lien vers lequel le client sera redirigé en cas d'échec de paiement
order Array - Oui Tableau contenant la commande du client
trans_id String - Oui ID interne fourni par le serveur CicaPay
payWith String format CicaPay Oui Il s'agit de la méthode de paiement : fiat ou crypto. Le client sera redirigé vers la page de paiement en fonction de la méthode choisi
currency String Currency Code (ISO 4217) Oui La devise utilisée par le marchand pour fixer la valeur de la commande. CicaPay supporte 3 devises à l'heure actuelle : EUR pour l'Euro, USD pour le dollars et XOF pour le Fcfa.

La réponse de cet appel d'API en cas de succès, renverra un lien vers lequel le client est directement redirigé et est invité à mettre les informations nécéssaire pour terminer son paiement. Aucune donnée n'est envoyé au marchand à ce niveau

En résumé le processus de paiement va se dérouler de la manière suivante :

  • Le marchand envoi les informations primaires pour la requête avec le meTa
  • Le marchand réenvoi les mêmes informations primaires pour la requête avec l' ID de la transaction
  • Le client est redirigé vers la page de paiement CicaPay où il mettra les informations complétaires et éffectuer le paiement
  • Le client est redirigé vers le lien approprié en fonction du statut de paiement
  • Un mail de paiement et de facture est envoyé au client
  • Aucune information n'est retourné ici, le marchand est donc invité à vérifier le statut de la transaction à l'aide du meTa fourni dans la requête avant de laisser le client àccéder au produit.

Tutoriel 2 : PAY IN PRO( Paiement entrant personnalisé )

Ce tutoriel couvre la fonctionnalité de paiement entrant pro.

Endpoint de la requête : https://api.cicapay.com/e_merchant_own/{MODE}/pay_in/{YOUR_API_KEY}

On remplace {MODE} par test ou live sans les { }

On remplace {YOUR_API_KEY} par votre clé privé sans les { }

Exemple d'endpoint complète : https://api.cicapay.com/e_merchant_own/test/pay_in/475kjdNVLPF745szerfr
Les données de la requête
Nom Type Caractère Maximum Requis ? Description
mobile_money_number Int format du réseau ( sans préfixe ) Oui Numéro de Paiement Mobile Money
network String format CicaPay Oui Réseau de Paiement
description String 30 Oui Description de la Commande
first_name String - Oui Nom du client
last_name String - Oui Prénom du client
email String email format Oui email du client
customer_company String - Non Nom de l'entreprise du client
order Array - Oui Tableau contenant la commande du client

La réponse de cet appel d'API en cas de succès, enverra un message push (débit) sur le numéro du client.
Après confirmation / annulation / échec par le client , un tableau de données d'information est retourné au marchand.
La réponse contient: le statut et l'ID de la transaction

En résumé le processus de paiement va se dérouler de la manière suivante :

  • Le marchand envoi les informations pour la requête
  • Le client reçois un push de débit
  • Le marchand reçoit les informations liés à la transaction
  • Le client reçoit un email de paiement et de facturation

Tutoriel 3 : PAY OUT( Paiement sortant )

Ce tutoriel couvre la fonctionnalité de paiement sortant.

Endpoint de la requête : https://api.cicapay.com/e_merchant_own/{MODE}/pay_out/{YOUR_API_KEY}

On remplace {MODE} par test ou live sans les { }

On remplace {YOUR_API_KEY} par votre clé privé sans les { }

Exemple d'endpoint complète : https://api.cicapay.com/e_merchant_own/test/pay_out/475kjdNVLPF745szerfr
Les données de la requête
Nom Type Caractère Maximum Requis ? Description
mobile_money_number Int format du réseau ( sans préfixe ) Oui Numéro de Paiement Mobile Money
network String format CicaPay Oui Réseau de Paiement
amount Int - Oui Montant à envoyé au client
first_name String - Oui Nom du client
last_name String - Oui Prénom du client
email String email format Oui email du client

La réponse de cet appel d'API en cas de succès, va executer un transfert de fonds du compte Marchand sur le numéro du client et va retourné : l'ID de la transaction et le status

En résumé le processus de paiement va se dérouler de la manière suivante :

  • Le marchand envoi les informations pour la requête
  • Le client reçois un tranfert de fonds
  • Le marchand reçoit les informations liés à la transaction
Tags:

Toujours coincé ?Comment pouvons nous aider ?

Est-ce que cela a été utile ?
logo-img