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

Updated on 25 / 09 / 2023

CicaPay API DOC MENU

Paiement Entrant par Défaut

Remarque

Cette API permet de recevoir un paiement en utilisant la page de paiement de CicaPay.
Si vous voulez personnalisé votre propre page de paiement, veuillez utiliser l'API PAY IN PRO

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.

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 externe 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.
Exemple d'Array pour l'input orders

$order = array(
[
'name' => 'moulin A',
'unit_price' => 10,
'quantity' => 200
],
[
'name' => 'moulin A',
'unit_price' => 100,
'quantity' => 20
],
[
'name' => 'moulin A',
'unit_price' => 100,
'quantity' => 200
]
);

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.

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
  • 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.
Tags:

Toujours coincé ?Comment pouvons nous aider ?

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