Bienvenue dans notre documentation API

Bictorys offre une infrastructure financière moderne conçue pour les entreprises et les développeurs, leur permettant de faciliter les paiements locaux et internationaux, de collecter des paiements de clients et de créer des comptes virtuels.

Comprendre l'API de paiement

L'API Charges permet aux marchands d'encaisser une facture, un lien de paiement ou une commande passée en ligne ou dans un point de vente. Les paramètres requis varient en fonction du type de transaction.

L'API peut être intégrée sous différentes formes avec votre application : Checkout, Iframe et Direct API.

• Intégration de type Checkout :
  Le checkout est le type d'intégration le plus simple. Il nécessite peu de code. Pour ce type d'intégration, appeler l'API Charges sans passer le paramètre de requête (query parameter) payment_type. Le client sera alors redirigé vers la page de paiement où il pourra choisir son mode de paiement et fournir les informations nécessaires. La page de paiement est hébergée par nous.

• Intégration de type Iframe :
  L'iframe vous permet d'intégrer notre element html de paiement personnalisable dans votre page de paiement. Le client reste sur votre page où il pourra saisir les informations de paiement et procéder au paiement sans toujours quitter votre page. Pour cette méthode, il est nécessaire d'inclure le fichier bictorys.js.Ne récupérer ce fichier que depuis notre site web pour être compliant avec la norme PCI-DSS.

• Intégration de type Direct API :
  Le direct API vous permet d'appeler notre API et de recevoir les données de la réponse sous forme de json. Vous devez obligatoire passer le paramètre de requête (query parameter) payment_type. Vous collectez les informations de paiements du client avant d'appeler notre API. Ce type d'intégration convient pour les applications sans browser, les applications mobiles ou si vous souhaitez construire votre propre flow de paiement.

🚧

Attention

L'utilisation du direct API pour les paiements avec carte bancaire nécessite au préalable que vous soyez certifié PCI-DSS. Aucune certification n'est demandée pour les paiements avec les mobiles money.

Choisissez le type d'intégration en fonction des besoins spécifiques de votre cas d'utilisation. Dans le doute, nous vous recommandons l'intégration de type checkout

Example d'utilisation de l'API pour un paiement avec l'intégration de type checkout

const data = JSON.stringify({
  "amount": 100,
  "currency": "XOF",
  "country": "SN",
  "successRedirectUrl": "https://example.com/commandes",
  "ErrorRedirectUrl": "https://example.coml/checkout"
});

const xhr = new XMLHt tpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://api.dev.bictorys.com/pay/v1/charges?payment_type=orange_money");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("X-Api-Key", "public-e6cf6c1d-3055-42fa-8eb7-c4f69b6fcbc8.7qmgwSXO69IttHNpS9oNg1WeUCOjnarUpa69jLPA5GmH96pe1EEKpUqf13AKbBSA");

xhr.send(data);

curl --request POST \
  --url http://localhost:8089/pay/v1/charges \
  --header 'Content-Type: application/json' \
  --header 'Request-Id: 038b8488-54fb-49c8-8aa1-0b30c1c99ded' \
  --header 'X-Api-Key: public-5a74cf42-1213-4ac8-8d13-5ba74e300e74.JRGOyPDGWDx2PXU6km5pOsVbuLTHTgC8bsqj8ie1BhmtTrcKOYFkF8uZ6B9Bf8Ui' \
  --data '{
  "amount": 100,
  "currency": "XOF",
  "successRedirectUrl": "https://client.co/redirect_url",
  "ErrorRedirectUrl": "https://client.co/redirect_url"
}'