# Bictorys Documentation > Bictorys API, Mobile and Card Payment in West Africa Append .md to any documentation page URL to get its markdown version. ## Guides - [Comprendre l'API de paiement](https://docs.bictorys.com/docs/comprendre-lapi-de-paiement.md): Une API unique pour tout type de paiement et d'integration - [Comment utiliser cette documentation](https://docs.bictorys.com/docs/how-to-use-this-documentation.md) - [Test vs Environment direct](https://docs.bictorys.com/docs/test-vs-live-environment.md) - [Tester vos Integrations](https://docs.bictorys.com/docs/test-your-integrations.md): Tester vos Integrations - [Cartes bancaires de Test](https://docs.bictorys.com/docs/cartes-bancaires-de-test.md) - [Test Mobile Money](https://docs.bictorys.com/docs/test-mobile-money.md) - [Intégration](https://docs.bictorys.com/docs/integration.md) - [Intégration-en](https://docs.bictorys.com/docs/intégration-en.md) - [Checkout](https://docs.bictorys.com/docs/how-checkout-works.md): Intégration de Paiement avec Bictorys : Mode Checkout - [Iframe](https://docs.bictorys.com/docs/elements.md): Intégration de Paiement avec Bictorys : Mode Iframe - [Woocommerce](https://docs.bictorys.com/docs/woocommerce.md): Intégration de Paiement avec Bictorys : Plugin pour WooCommerce - [Intégration Shopify — Bictorys Gateway](https://docs.bictorys.com/docs/shopify.md): Intégration de Paiement avec Bictorys : Plugin pour Shopify - [Drupal (pas encore disponible)](https://docs.bictorys.com/docs/drupal.md): Intégration de Paiement avec Bictorys : Plugin pour Drupal - [Direct API](https://docs.bictorys.com/docs/direct-api.md): Paiement avec Bictorys : Intégration Directe via l'API - [Les clés API](https://docs.bictorys.com/docs/get-your-api-key.md) - [Webhook](https://docs.bictorys.com/docs/webhook.md): Webhook - [Configurer le webhook](https://docs.bictorys.com/docs/setup-webhook.md): Configurer le webhook - [Comment valider les webhooks](https://docs.bictorys.com/docs/how-to-validate-webhooks.md) - [Aperçu](https://docs.bictorys.com/docs/aperçu-3.md): Facilitez vos transferts d'argent avec Bictorys - [Comment effectuer un déboursement](https://docs.bictorys.com/docs/comment-effectuer-un-transfert.md): Facilitez vos transferts d'argent avec Bictorys - [Aperçu](https://docs.bictorys.com/docs/aperçu-4.md): Facilitez vos remboursements avec Bictorys - [Comment effectuer un remboursement](https://docs.bictorys.com/docs/comment-effectuer-un-remboursement.md): Facilitez vos remboursements avec Bictorys - [Facturation](https://docs.bictorys.com/docs/invoice.md): Factures - [Créer une facture](https://docs.bictorys.com/docs/creer-invoice.md): Vendez en ligne sans avoir à créer une vitrine numérique. - [Détails d'une facture & Aperçu](https://docs.bictorys.com/docs/détails-dune-facture-aperçu.md) - [Liens de paiement](https://docs.bictorys.com/docs/payment-llink.md): Vendez en ligne sans avoir à créer une vitrine numérique. - [Créer un Lien de paiement](https://docs.bictorys.com/docs/create-payment-link.md): Vendez en ligne sans avoir à créer une vitrine numérique. - [Page de paiement & aperçu](https://docs.bictorys.com/docs/liens-de-paiement-aperçu.md): Liens de paiement & aperçu - [Paiement en ligne](https://docs.bictorys.com/docs/paiement-en-ligne.md) - [Ajouter une adresse IP Privée](https://docs.bictorys.com/docs/getting-your-private-ip-address.md) - [Réponses de statut et leurs significations](https://docs.bictorys.com/docs/status-responses-and-their-meanings.md) - [Limites de taux de l'API](https://docs.bictorys.com/docs/api-rate-limits.md): Limites de taux de l'API - [Guide rapide](https://docs.bictorys.com/docs/transaction-dynamics-copy.md): Guide rapide - [Dynamique des transactions](https://docs.bictorys.com/docs/transaction-dynamics.md): Dynamique des transactions - [Erreurs](https://docs.bictorys.com/docs/virtual-account-errors.md): Erreurs - [Erreurs de compte virtuel](https://docs.bictorys.com/docs/virtual-account-errors-1.md): Erreurs de compte virtuel - [Erreurs de paiement](https://docs.bictorys.com/docs/virtual-account-errors-copy.md): Erreurs de paiement - [Notifications](https://docs.bictorys.com/docs/during-payment.md): Autres - [Aperçu](https://docs.bictorys.com/docs/ajouter-produits-copy.md): Gerez vos produits et votre inventaire - [Ajouter produits](https://docs.bictorys.com/docs/ajouter-un-produit.md): Simplifiez l'Expérience d'Ajout de Produits avec Bictorys - [Aperçu](https://docs.bictorys.com/docs/aperçu.md): Optimisez votre relation clientèle avec Bictorys - [Ajouter un Client](https://docs.bictorys.com/docs/ajouter-un-client.md): Boostez votre clientèle en quelques clics avec Bictorys : ajout facile, interactions personnalisées, relations renforcées. - [Apercu](https://docs.bictorys.com/docs/aperçu-1.md): Facilitez votre expérience utilisateur avec Bictorys : une plateforme intuitive, des fonctionnalités puissantes et une personnalisation sans effort - [Ajouter un utilisateur](https://docs.bictorys.com/docs/ajouter-un-utilisateur.md): Un processus intuitif pour une gestion optimale. - [Aperçu](https://docs.bictorys.com/docs/aperçu-2.md): Votre Hub de Croissance - [Details de l'entreprise](https://docs.bictorys.com/docs/details-de-lentreprise.md): Espace dédié à votre entreprise - [Carte Bancaire](https://docs.bictorys.com/docs/carte-bancaire.md) - [Mobile Money](https://docs.bictorys.com/docs/mobile-money.md) - [Terminal virtuel (IOS, Android)](https://docs.bictorys.com/docs/terminal-virtuel.md) - [Préférences](https://docs.bictorys.com/docs/preferences.md): Préférences ## API Reference - [Obtenir vos Clés API 🔐](https://docs.bictorys.com/reference/getting-started.md): Pour appeler nos APIs - [Réponses API (Succès et Erreurs)](https://docs.bictorys.com/reference/how-to-use-this-documentation-copy.md) - [Returns list of transactions](https://docs.bictorys.com/reference/gettransactions.md): Use this endpoint to retrieve the list of checkout, payout and refund transactions. Transactions can be filtered using date, customer Id or phone number - [Returns number of transactions](https://docs.bictorys.com/reference/gettransactioncount.md): Use this endpoint to retrieve the number of checkout, payout or refund transactions. Transactions can be filtered using date, customer Id or phone number - [Returns total amount of transactions](https://docs.bictorys.com/reference/gettransactionamount.md): Use this endpoint to retrieve total amount of checkout, payout or refund transactions. Transactions can be filtered using date, customer Id or phone number - [Returns total fees of transactions paid by the merchant](https://docs.bictorys.com/reference/gettransactionmerchantfees.md): Use this endpoint to retrieve total amount of checkout, payout or refund transactions fees. - [Returns a transaction details](https://docs.bictorys.com/reference/gettransactiondetails.md): Use this endpoint to retrieve details of a transaction. - [Net available and pending Revenues](https://docs.bictorys.com/reference/getnetrevenues.md): Returns total amount of payment minus transfer and merchant fees, pending amount and pending fees for a given merchant - [Returns your total amount of payment minus transfer and payment fees.](https://docs.bictorys.com/reference/getmynetrevenues.md): Use this endpoint to retrieve total amount of received payments minus transfers and payment fees. - [Refund a transaction](https://docs.bictorys.com/reference/refundtransaction.md): Use this endpoint to refund a transaction. - [search transactions by customer name or customer phone](https://docs.bictorys.com/reference/searchtransactions.md): Use this endpoint to search the list of checkout, payout and refund transactions. using customer name or phone. - [Initiate a payout transaction](https://docs.bictorys.com/reference/createpayout.md): Use this endpoint to send money to a mobile money. - [Initiate a bulk payout](https://docs.bictorys.com/reference/createbatchpayout.md): Use this endpoint to send a bulk payout. After payment is completed merchant webhook is called to notify status of each transation. For security reason, we do not allow merchant to generate permission for this end point, please contact us in order to get a secret key for testing bulk payout on sandbox. - [Initiate a payment for a merchant](https://docs.bictorys.com/reference/createcharge.md): This API endpoint is used to collect payment with mobile money or credit card. The payment can be an invoice, a payment link or any other type of collect. The request body is defined by the type of collect. For example, to collect an invoice, just invoiceId is required in the request body. - [Complete an initiated payment request](https://docs.bictorys.com/reference/completecharges.md): Use this endpoint to complete an initiated charge request. When a request to /charges endpoint is initiated without precising the payment method, the system create a charge objet and redirect payment page url. Hence the customer can select the payment method and complete the form if needed then confirm payment - [Capture totally or partially a transaction previously authorized](https://docs.bictorys.com/reference/captureamount.md): This API endpoint allows to capture totally or partially a transaction previously authorized. The amount of capture must not exceed authorized amount. - [Returns list of saved card](https://docs.bictorys.com/reference/gettokenizedcards.md): This API returns the list of saved cards. Card are saved as a token. Tokens can be used to trigger a transaction - [Remove a card](https://docs.bictorys.com/reference/deletetokenizedcard.md): Use this endpoint to remove a customer saved card. - [Create a new customer](https://docs.bictorys.com/reference/createcustomer.md): Create a new customer for a merchant - [Returns list of customers](https://docs.bictorys.com/reference/getcustomers.md): This API returns the list of customers for a merchant. - [Returns number of customers](https://docs.bictorys.com/reference/getcustomercount.md): This API returns the number of customers for a merchant. - [search customers](https://docs.bictorys.com/reference/searchcustomers.md): This API searches customer by email or phone or name and returns list of matched customers. - [Returns details of a customer](https://docs.bictorys.com/reference/getcustomerdetails.md): This API returns details of a customer. - [Update customer details](https://docs.bictorys.com/reference/updatecustomer.md): Use this endpoint to update customer details - [delete a customer](https://docs.bictorys.com/reference/removecustomer.md): Use this endpoint to delete a customer - [Create a new product](https://docs.bictorys.com/reference/createproduct.md): Create a new product for a merchant - [Returns list of products](https://docs.bictorys.com/reference/getproducts.md): This API returns the list of products for a merchant. - [search products](https://docs.bictorys.com/reference/searchproducts.md): This API searches product by email or phone or name and returns list of matched products. - [Returns details of a product](https://docs.bictorys.com/reference/getproductdetails.md): This API returns details of a product. - [Update product details](https://docs.bictorys.com/reference/updateproduct.md): Use this endpoint to update product details - [delete a product](https://docs.bictorys.com/reference/removeproduct.md): Use this endpoint to delete a product - [Create a bulk products](https://docs.bictorys.com/reference/createbulkproduct.md): Create list of product for a merchant - [Add new Tax](https://docs.bictorys.com/reference/createtax.md): Add new tax for a new supported country. Tax refers to all taxes existing in the country. - [Returns list of taxes in a country](https://docs.bictorys.com/reference/gettaxes.md): This API returns the list of taxes applicable to a product in a country. - [Update Tax details](https://docs.bictorys.com/reference/updatetax.md): Use this endpoint to update tax details - [delete a tax](https://docs.bictorys.com/reference/removetax.md): Use this endpoint to delete a tax - [Create a new invoice](https://docs.bictorys.com/reference/createinvoice.md): Create a new invoice for a customer. The invoice can be sent to the customer - [Returns list of invoices](https://docs.bictorys.com/reference/getinvoices.md): This API returns the list of invoices for a merchant. - [Returns number of invoices](https://docs.bictorys.com/reference/getinvoicecount.md): This API returns number of invoices for a according filters. - [Returns list of found invoices](https://docs.bictorys.com/reference/searchinvoices.md): This API returns the list of found invoices for a merchant. - [Returns details of a invoice](https://docs.bictorys.com/reference/getinvoicedetails.md): This API returns details of a invoice. - [Update invoice details](https://docs.bictorys.com/reference/updateinvoice.md): Use this endpoint to update invoice details - [delete a invoice](https://docs.bictorys.com/reference/removeinvoice.md): Use this endpoint to delete a invoice - [Redirect to checkout page](https://docs.bictorys.com/reference/payinvoice.md): This API redirect to checkout page to allow customer to pay its invoice - [Download invoice](https://docs.bictorys.com/reference/downloadinvoice.md): This API allows customer to download its invoice - [Create a new payment link](https://docs.bictorys.com/reference/createpaymentlink.md): Create a new payment link for a customer. The payment link can be sent to the customer - [Returns number of payment links](https://docs.bictorys.com/reference/getpaymentlinkcount.md): This API returns number of payment links for a according filters. - [Returns list of payment links](https://docs.bictorys.com/reference/getpaymentlinks.md): This API returns the list of payment links for a merchant. - [Returns details of a payment link](https://docs.bictorys.com/reference/getpaymentlinkdetails.md): This API returns details of a payment link. - [Returns list of found payment links](https://docs.bictorys.com/reference/searchpaymentlinks.md): This API returns the list of found payment links for a merchant. - [Update payment link details](https://docs.bictorys.com/reference/updatepaymentlink.md): Use this endpoint to update payment link details - [delete a payment link](https://docs.bictorys.com/reference/removepaymentlink.md): Use this endpoint to delete a payment link - [Redirect to checkout page](https://docs.bictorys.com/reference/paypaymentlink.md): This API redirect to checkout page to allow customer to pay its invoice - [Create a new order](https://docs.bictorys.com/reference/createorder.md): Create a new order for a customer. The order can be sent to the customer - [Returns list of orders](https://docs.bictorys.com/reference/getorders.md): This API returns the list of orders for a merchant. - [Returns number of orders](https://docs.bictorys.com/reference/getordercount.md): This API returns number of orders for a according filters. - [Search orders](https://docs.bictorys.com/reference/searchorders.md): This API returns the list of found orders for a merchant. - [Returns details of a order](https://docs.bictorys.com/reference/getorderdetails.md): This API returns details of a order. - [Update order details](https://docs.bictorys.com/reference/updateorder.md): Use this endpoint to update order details - [delete a order](https://docs.bictorys.com/reference/removeorder.md): Use this endpoint to delete a order - [Retrieve merchant balance](https://docs.bictorys.com/reference/getmybalance.md): This API endpoint is used to retrieve current balance - [Returns list of settlements](https://docs.bictorys.com/reference/gettransactions-1.md): Use this endpoint to retrieve the list of settlements. Transactions can be filtered using date - [Returns number of settlements](https://docs.bictorys.com/reference/gettransactioncount-1.md): Use this endpoint to retrieve the number of settlement, top-ups transactions. Transactions can be filtered using date. - [Returns a settlement details](https://docs.bictorys.com/reference/gettransactiondetails-1.md): Use this endpoint to retrieve details of a transaction. - [Return Merchant public information](https://docs.bictorys.com/reference/getmypublicinfo.md): Use this endpoint to retrieve merchant public information. - [Return Merchant payment methods](https://docs.bictorys.com/reference/getmerchantpaymentmethods.md): Use this endpoint to retrieve merchant payment method configuration, a.k.a which payment methods are enabled or disabled. Merchant account is create with default settings. - [Create a subscription](https://docs.bictorys.com/reference/createsubscription.md): This endpoint allows the creation of a subscription for recurrent billing. - [Returns list of subscriptions](https://docs.bictorys.com/reference/getsubscriptions.md): This API returns the list of subscriptions for a merchant. - [Returns number of subscriptions](https://docs.bictorys.com/reference/getsubscriptioncount.md): This API returns number of subscriptions. - [Returns list of found subscriptions](https://docs.bictorys.com/reference/searchsubscriptions.md): This API returns the list of found subscription for a merchant. - [Returns details of a subscription](https://docs.bictorys.com/reference/getsubscriptiondetails.md): This API returns details of a subscription - [Update subscription details](https://docs.bictorys.com/reference/updatesubscription.md): Use this endpoint to update subscription details - [delete a subscription plan.](https://docs.bictorys.com/reference/deletesubscription.md): THe plan will be removed definitely. - [Cancel a subscription](https://docs.bictorys.com/reference/cancelsubscription.md): After a subscription has been cancelled, no payment will be requested to the customer - [Create a subscription plan.](https://docs.bictorys.com/reference/createsubscriptionplan.md): This endpoint enables the creation of a subscription plan for recurring billing. Once a plan is created, customers can subscribe to it. - [Returns list of subscription plans](https://docs.bictorys.com/reference/getsubscriptionplans.md): This API returns all subscription plans for a merchant. - [Returns details of a subscription plan](https://docs.bictorys.com/reference/getsubscriptionplandetails.md): This API returns details of a subscription plan - [Update subscription plan details](https://docs.bictorys.com/reference/updatesubscriptionplan.md): Use this endpoint to update subscription plan details - [delete a subscription plan.](https://docs.bictorys.com/reference/deletesubscriptionplan.md): THe plan will be removed definitively. - [Create a BNPL](https://docs.bictorys.com/reference/createbnpl.md): This endpoint allows the creation of a Buy Now, Pay Later (BNPL) plan for facility payments. Customers can make an optional initial payment, with the remaining amount distributed across recurring payment periods. - [Returns list of bnpl plan](https://docs.bictorys.com/reference/getbnpls.md): This API returns the list of bnpl plan for a merchant. - [Returns number of BNPL](https://docs.bictorys.com/reference/getbnplcount.md): This API returns number of BNPL. - [Returns list of found BNPL](https://docs.bictorys.com/reference/searchbnpl.md): This API returns the list of found BNPL for a merchant. - [Returns details of a BNPL plan](https://docs.bictorys.com/reference/getbnpldetails.md): This API returns details of a BNPL - [Update BNPL details](https://docs.bictorys.com/reference/updatebnpl.md): Use this endpoint to update BNPL details - [delete a BNPL subscription.](https://docs.bictorys.com/reference/deletebnpl.md): THe plan will be removed definitely. - [Cancel a BNPL plan](https://docs.bictorys.com/reference/cancelbnpl.md): After a BNPL has been cancelled, no payment will be requested to the customer