Skip to main content

API Documentation

Complete reference for Chari Money's Banking-as-a-Service API. Integrate financial services into your applications with our robust and secure endpoints.

Getting Started

Version 1.9 · Last updated 14 avril 2026

Bienvenue dans la documentation officielle de l'API Banking-as-a-Service (BAAS) de Chari Money. Cette API REST permet aux fintechs, plateformes et développeurs d'intégrer une infrastructure financière complète dans leurs applications : ouverture de comptes avec vérification KYC, transactions wallet-à-wallet, dépôts par carte bancaire (3D Secure), virements bancaires via RIB, paiements marchands multi-canal (téléphone, QR Code, carte), gestion des bénéficiaires, agents retail et webhooks temps réel. Tous les endpoints suivent un modèle preview/execute avec confirmation asynchrone par webhook.

Authentication Headers

Incluez les en-têtes suivants dans toutes vos requêtes API :

HeaderTypeRequiredDescription
Chari-Api-KeystringRequiredClé API pour l'authentification. Fournie par Chari pour chaque environnement.
C-Request-IdstringOptionalIdentifiant unique par requête pour le traçage. Renvoyé dans la réponse. Format recommandé : UUID v4. Ex : 69906411-0aa24a89-ab2005ca-9d18dc15

Test Credit Card (Sandbox)

PAN

4918914107195005

CVV

123

Expiry

08/26 (ou toute date future)

3DS Code

555
New

LLM & AI Pack

Pack complet optimisé pour les LLMs et assistants IA : documentation Markdown, JSON Schemas, diagrammes Mermaid, spécification OpenAPI 3.0, exemples cURL et règles de validation. Idéal pour RAG, code generation et intégration avec Cursor, Copilot ou Claude.

OpenAPI 3.0JSON SchemaMermaidMarkdowncURL
Download .zip

Postman Collection

Téléchargez la collection Postman complète pour tester tous les endpoints de l'API.

Download

Changelog

v1.8

2025-11-05

Documentation initiale. Couverture complète de l'API v1.8.

v1.8.1

2025-12-01

Ajout de l'endpoint merchant-kyc-upload. Tables de référence enrichies (docTypes, customerStatuses, accountLevels). Codes d'erreur détaillés avec mapping endpoint. Paramètre autoActivate sur confirm. Correction de la route confirm.

v1.9

2026-04-14

Ajout de la section Simulation (Sandbox). Nouveaux Operation Types : 10=RECHARGE, 25=BILL_PAYMENT ; renommage 5→MOBILE_PAYMENT, 24→CARD_PAYMENT. Transaction Status formalisé : OPEN/COMPLETED/FAILED/CANCELED. Webhooks simplifiés : ajout payment.received, retrait de operation.created/operation.updated/customer.kyc/bank-transfer.failed. Format de référence CashIn/CashOut : numérique (ex : 1122334455).

P

Présentation — M-Wallet au Maroc

What is an M-Wallet?

Un M-Wallet (portefeuille mobile) est un compte de monnaie électronique réglementé qui permet aux particuliers et aux commerçants d'effectuer des transactions financières en utilisant un numéro de mobile comme identifiant. Il s'inscrit dans le cadre national de Bank Al-Maghrib (BAM) pour l'inclusion financière et les paiements numériques. Chaque wallet est lié à une identité vérifiée (KYC) et stocké sous la licence d'Établissement de Paiement CHARI MONEY, supervisée par Bank Al-Maghrib.

Core Principles

Identifiant unique

Le MSISDN (numéro de mobile) de l'utilisateur sert d'identifiant du wallet.

Réseau interopérable

Tous les M-Wallets peuvent échanger de la monnaie entre différents fournisseurs via le switch national.

Niveaux KYC

Les permissions et plafonds du compte dépendent du niveau de vérification de l'utilisateur (CIN, selfie, justificatif de domicile, etc.).

Opérations temps réel

Les virements, cash-in/out, paiements marchands et de factures sont exécutés instantanément avec confirmation.

Account Types

TypeOwnerDescriptionOperations
Consommateur (Particulier)ParticuliersWallet personnel lié à un numéro de mobile et une CIN.Cash-in/out, transferts P2P, paiements marchands, autres services de paiement.
CommerçantPetit commerce, boutique ou prestataireWallet professionnel lié à un compte marchand ou magasin.Recevoir des paiements, transférer vers une banque, rembourser un client, autres services de paiement.
Agent détaillantRéseau d'agents agréés / partenaireUtilisé par les agents de distribution pour faciliter le cash-in/out des utilisateurs.Alimenter / retirer des wallets clients.
Agent principalPartenaire / EDPWallet dédié aux entreprises avec des plafonds plus élevés et des solutions d'intégration.Virements en masse, paie, encaissements, et autres opérations.

Account Levels

LevelKYC RequirementBalance Limit
Niveau 1Nom + numéro de téléphone valide + numéro de CIN1 000 MAD
Niveau 2KYC complet (CIN + selfie ou scan du document)4 000 MAD
Niveau 3Pièce d'identité vérifiée (KYC), entretien, dossier client numérique20 000 MAD
Niveau 4KYC complet, entretien, dossier client numérique, justificatif de revenus, justificatif de domicile100 000 MAD
MarchandKYB complet + immatriculation (IF/RC)Négocié
G

Glossaire

TermDefinition
M-WalletCompte de monnaie électronique réglementé, lié à un numéro de mobile, permettant transferts, paiements et opérations de caisse.
WalletCompte utilisateur du système qui stocke la monnaie électronique, associé à un identifiant unique (MSISDN).
MSISDNNuméro de téléphone mobile utilisé comme identifiant principal d'un wallet.
KYC (Know Your Customer)Processus de vérification pour identifier et valider l'identité d'un utilisateur selon les exigences réglementaires.
Niveau KYCNiveau réglementaire assigné à un wallet en fonction de son état de vérification, définissant les plafonds de transactions et de solde.
OpérationAction métier de haut niveau initiée par un utilisateur ou partenaire (ex. cash-in, transfert, paiement).
TransactionMouvement financier (débit, crédit, frais, ajustement) généré dans le cadre d'une opération.
Type d'opérationCatégorie d'action métier (ex. CASHIN, TRANSFER, PAYMENT).
Type de transactionType de mouvement financier associé à une opération (ex. débit, crédit, frais).
Statut d'opérationÉtat actuel du cycle de vie d'une opération (ex. OPEN, COMPLETED, FAILED).
Statut de transactionÉtat de traitement d'une transaction (ex. COMPLETED, FAILED).
RéférenceIdentifiant unique généré pour une opération en attente (ex. cash-in/out), utilisé pour compléter la transaction via un réseau externe.
Agent / RéseauEntité tierce autorisée ou canal de distribution utilisé pour exécuter les opérations de cash-in et cash-out.
Clé APIJeton sécurisé utilisé pour authentifier les requêtes d'un partenaire vers l'API BAAS.
WebhookCallback HTTP automatisé envoyé par le système pour notifier les partenaires des mises à jour d'opération ou de transaction.
I

Inscription client

Gestion complète du cycle de vie client : vérification de statut, inscription, confirmation OTP, gestion du PIN, consultation du solde et des informations, et désinscription.

GET{host}/api/customers/status

Vérifier le statut (Chari)

Récupère le statut d'inscription actuel d'un client auprès de Chari uniquement.

ParameterTypeInRequiredDescription
PhoneNumberstringqueryRequiredNuméro de téléphone du client. Format : +212*********

Notes

  • •0 : Not exists — Le numéro n'existe pas chez ChariMoney.
  • •1 : Not confirmed — Le numéro existe chez ChariMoney mais n'est pas encore enrôlé chez Switch (OTP non saisi).
  • •2 : Confirmed — Le numéro existe et est enregistré auprès de Switch.
  • •3 : Active — Enregistré auprès de Switch et actif chez ChariMoney (PIN créé).
  • •4 : Locked temporary — Le numéro est temporairement bloqué (nombre de tentatives dépassé).
  • •5 : Locked — Le numéro est bloqué.
GET{host}/api/customers/default

Vérifier le wallet par défaut

Vérifie si Chari est le wallet par défaut du client auprès de Switch.

ParameterTypeInRequiredDescription
phoneNumberstringqueryRequiredNuméro de téléphone du client. Format : +212*********

Notes

  • •true : Chari est le wallet par défaut du client.
  • •false : Chari n'est PAS le wallet par défaut du client.
POST{host}/api/customers/register202

Inscription

Lance le processus d'inscription d'un nouveau client. Un OTP sera envoyé par SMS pour confirmation.

ParameterTypeInRequiredDescription
phoneNumberstringbodyRequiredNuméro de téléphone du client. Format : +212*********
firstNamestringbodyRequiredPrénom. Minimum 2 lettres (caractères latins uniquement).
lastNamestringbodyRequiredNom de famille. Minimum 2 lettres (caractères latins uniquement).
cinstringbodyRequiredNuméro de carte d'identité. Minimum 5 caractères.
walletTypestringbodyRequired"P" : Particulier / "C" : Commerçant
closeLoopOnlybooleanbodyOptionalSi true, inscrit le client uniquement en mode CloseLoop. Dans ce cas, un OTP est envoyé directement par CHARI.
POST{host}/api/customers/confirm200

Confirmation OTP

Confirme l'inscription d'un client en saisissant le code OTP reçu par SMS.

ParameterTypeInRequiredDescription
phoneNumberstringbodyRequiredNuméro de téléphone du client. Format : +212*********
codestringbodyRequiredCode OTP reçu par SMS. Format : xxx-xxx
walletTypestringbodyRequired2 types acceptés : "P" : Particulier, "C" : Commerçant (Merchant).
autoActivatebooleanbodyOptionalValeur par défaut : false. Indique si le wallet doit être activé automatiquement après la validation de l'OTP. Si false, l'utilisateur doit terminer l'activation en définissant ou saisissant un PIN. Si true, le wallet est activé automatiquement, sans PIN.
POST{host}/api/customers/confirm/resend-otp

Renvoyer l'OTP

Renvoie le code OTP pour l'inscription ou la confirmation.

ParameterTypeInRequiredDescription
phoneNumberstringqueryRequiredNuméro de téléphone du client. Format : +212*********
POST{host}/api/customers/login

Connexion par PIN

Authentifie un client existant avec son code PIN.

ParameterTypeInRequiredDescription
phoneNumberstringbodyRequiredNuméro de téléphone du client. Format : +212*********
pinstringbodyRequiredCode PIN du client.

Notes

  • •logged : true si l'authentification a réussi, false sinon.
  • •remainingAttempts : nombre de tentatives restantes avant le verrouillage du compte.
POST{host}/api/customers/pin

Créer un PIN

Définit un code PIN sécurisé pour un client inscrit et confirmé.

ParameterTypeInRequiredDescription
phoneNumberstringbodyRequiredNuméro de téléphone du client. Format : +212*********
pinstringbodyRequiredCode PIN du client (4 chiffres obligatoires).
PATCH{host}/api/customers/pin

Modifier le PIN

Modifie le code PIN existant d'un client.

ParameterTypeInRequiredDescription
phoneNumberstringbodyRequiredNuméro de téléphone du client. Format : +212*********
oldPinstringbodyRequiredPIN actuel du client.
newPinstringbodyRequiredNouveau PIN du client.
POST{host}/api/customers/pin/resetComing Soon

Réinitialiser le PIN

Réinitialise le code PIN d'un client. Disponible dans une prochaine version.

No parameters required.

GET{host}/api/customers/balance

Consulter le solde

Récupère le solde actuel du wallet d'un client inscrit.

ParameterTypeInRequiredDescription
phoneNumberstringqueryRequiredNuméro de téléphone du client. Format : +212*********
GET{host}/api/customers/info

Informations client

Récupère les données de profil détaillées d'un client inscrit (identité, solde, RIB, niveau de compte, partenaire).

ParameterTypeInRequiredDescription
phoneNumberstringqueryRequiredNuméro de téléphone du client. Format : +212*********

Notes

  • •accountLevel : niveau de compte (1 = basique, 2-4 = niveaux KYC supérieurs).
  • •customerStatus : statut du client (voir l'endpoint "Check Status with Chari").
  • •rib : Relevé d'Identité Bancaire associé au wallet.
PUT{host}/api/customers/unregister

Désinscription

Désactive ou supprime un client de la plateforme. Une raison de clôture doit être fournie.

ParameterTypeInRequiredDescription
PhoneNumberstringbodyRequiredNuméro de téléphone du client. Format : +212*********
ReasonintbodyRequiredCode de la raison de clôture (voir notes).

Notes

  • •1 : Clôture à l'initiative de l'EDP — Raison non spécifiée
  • •2 : Clôture à l'initiative de l'EDP — Suspicion de fraude
  • •3 : Clôture à l'initiative du client — Résiliation du contrat
  • •4 : Clôture à l'initiative du client — Téléphone perdu ou volé
  • •5 : Clôture à l'initiative du client — Raison non spécifiée
K

KYC (Vérification d'identité)

Flux KYC mobile (iOS/Android) propulsé par ShareID. Votre application lance le SDK ShareID pour le scan de document et la capture de selfie ; ShareID effectue les contrôles de qualité, d'authenticité et de correspondance visage/document. Sur demande, nous vous fournissons les SDK ShareID (Android/iOS) et les credentials d'installation.

Integration Flow

  1. 1Votre app appelle "/kyc/shareid/auth" pour obtenir un token KYC temporaire.
  2. 2L'app ouvre le SDK ShareID avec ce token.
  3. 3L'utilisateur scanne sa pièce d'identité et effectue un selfie guidé.
  4. 4ShareID exécute les vérifications.
  5. 5Votre app appelle "/kyc/session/complete" pour signaler la fin du flux côté appareil.
  6. 6Un callback est envoyé à notre API avec le statut et les documents — nous stockons/validons et exposons le résultat KYC final.
GET{host}/api/kyc/shareid/auth

Authentification KYC

Obtient un token KYC temporaire pour lancer le SDK ShareID.

ParameterTypeInRequiredDescription
PhoneNumberstringqueryRequiredNuméro de téléphone du client. Format : +212*********

Notes

  • •baseUrl : URL de base du SDK ShareID à utiliser.
  • •applicant_id : identifiant unique de la demande KYC.
  • •token : jeton JWT temporaire pour l'authentification côté SDK.
POST{host}/api/customers/upgrade/request

Confirmation KYC

Signale la fin du flux KYC côté appareil et demande la mise à niveau du compte.

ParameterTypeInRequiredDescription
PhoneNumberstringqueryRequiredNuméro de téléphone du client. Format : +212*********
AccountLevelintqueryRequiredNiveau de compte cible (2, 3 ou 4).
POST{host}/api/merchant/kyc/request

Upload documents marchand

Téléverse les documents KYC d'un commerçant pour demander une mise à niveau de compte (multipart/form-data).

ParameterTypeInRequiredDescription
PhoneNumberstringqueryRequiredNuméro de téléphone du commerçant. Format : +212*********
KycDocumentsmultipart formbodyRequiredTableau d'objets document KYC. Plusieurs documents peuvent être envoyés dans la même requête en répétant les champs indexés (ex. kycDocuments[0], kycDocuments[1], ...).
KycDocuments[n].DocTypeintbodyRequiredType de document (voir la table "Types de documents").
KycDocuments[n].DocFrontfilebodyRequiredImage recto du document. Formats acceptés : PNG, JPG/JPEG, PDF.
KycDocuments[n].DocBackfilebodyOptionalImage verso (requis pour IdentityCard, DrivingLicense, ResidencePermit).
O

Opérations

Toutes les opérations financières : dépôts par carte, transferts wallet-à-wallet, virements bancaires, paiements marchand, chargebacks, remboursements et requêtes par référence.

Dépôt par carte (CashIn Card)

Carte de test

Numéros de carte valides pour ajouter des fonds en environnement sandbox.

PAN

4918914107195005

CVV

123

Expiry

08/26 (ou toute date future)

3DS Code

555
POST{host}/api/operations/cashin/card/preview

Aperçu (par téléphone)

Vérifie la faisabilité du dépôt de fonds sur le wallet d'un client depuis une carte bancaire.

ParameterTypeInRequiredDescription
PhoneNumberstringqueryRequiredNuméro de téléphone du client. Format : +212*********
AmountdecimalbodyRequiredMontant à déposer. Doit être un nombre positif.
POST{host}/api/operations/cashin/card

Exécuter (par téléphone)

Dépose des fonds sur le wallet d'un client depuis une carte bancaire. Déclenche une authentification 3D Secure.

ParameterTypeInRequiredDescription
PhoneNumberstringqueryRequiredNuméro de téléphone du client.
FirstNamestringbodyRequiredPrénom du titulaire de la carte.
LastNamestringbodyRequiredNom du titulaire de la carte.
CvvstringbodyRequiredCode de sécurité à 3 chiffres (CVV).
AmountdecimalbodyRequiredMontant à déposer.
CurrencystringbodyOptionalCode devise ISO 3 lettres (ex : MAD).
PanstringbodyRequiredNuméro complet de la carte (PAN).
ExpiryDatestringbodyRequiredDate d'expiration au format YYMM.
KeepAliveboolbodyRequiredtrue : sauvegarder la carte pour usage futur / false : usage unique.
CardNamestringbodyOptionalNom choisi par l'utilisateur pour sauvegarder la carte.

Notes

  • •Après l'authentification 3D Secure, l'utilisateur est redirigé vers acceptURL ou declineURL.
  • •RESPONSE_CODE dans l'URL de redirection : 0 = succès, toute autre valeur = échec.
  • •REASON_CODE : raison lisible du résultat (ex : SUCCESS, DECLINED).
  • •Validez RESPONSE_CODE et REASON_CODE pour déterminer la suite dans votre application.
POST{host}/api/operations/cashin/card/{cardId}

Exécuter avec carte sauvegardée

Dépose des fonds depuis une carte déjà tokenisée et sauvegardée.

ParameterTypeInRequiredDescription
PhoneNumberstringqueryRequiredNuméro de téléphone du client.
CardIdintrouteRequiredIdentifiant de la carte sauvegardée.
CvvstringbodyRequiredCode de sécurité à 3 chiffres.
AmountdecimalbodyRequiredMontant à déposer.

Notes

  • •Après l'authentification 3D Secure, l'utilisateur est redirigé vers acceptURL ou declineURL selon le résultat.
  • •L'URL de redirection inclut des paramètres : RESPONSE_CODE (0 = succès, autre = échec), REASON_CODE (raison lisible : SUCCESS, DECLINED…) et OPERATION (type d'opération, ex : PAYMENT).
  • •Validez RESPONSE_CODE et REASON_CODE à la réception du retour pour déterminer la suite dans votre application.
POST{host}/api/operations/cashin/card/agent/preview

Aperçu (par agent)

Vérifie la faisabilité du dépôt via un code agent.

ParameterTypeInRequiredDescription
codestringqueryRequiredCode de l'agent.
AmountdecimalbodyRequiredMontant à déposer.
POST{host}/api/operations/cashin/card/agent

Exécuter (par agent)

Dépose des fonds sur le wallet d'un client via un agent.

ParameterTypeInRequiredDescription
agentstringqueryRequiredCode de l'agent.
FirstNamestringbodyRequiredPrénom du titulaire de la carte.
LastNamestringbodyRequiredNom du titulaire de la carte.
CvvstringbodyRequiredCode de sécurité à 3 chiffres.
AmountdecimalbodyRequiredMontant à déposer.
PanstringbodyRequiredNuméro complet de la carte.
ExpiryDatestringbodyRequiredDate d'expiration au format YYMM.
KeepAliveboolbodyRequiredSauvegarder la carte pour usage futur.
CurrencystringbodyOptionalCode devise ISO 3 lettres (ex : MAD).
CardNamestringbodyOptionalNom choisi par l'utilisateur pour sauvegarder la carte.

Notes

  • •Après l'authentification 3D Secure, l'utilisateur est redirigé vers acceptURL ou declineURL selon le résultat.
  • •L'URL de redirection inclut des paramètres : RESPONSE_CODE (0 = succès, autre = échec), REASON_CODE (raison lisible : SUCCESS, DECLINED…) et OPERATION (type d'opération, ex : PAYMENT).
  • •Validez RESPONSE_CODE et REASON_CODE à la réception du retour pour déterminer la suite dans votre application.

Transfert wallet-à-wallet

POST{host}/api/operations/transfer/preview

Aperçu

Vérifie la faisabilité d'un transfert de fonds entre wallets.

ParameterTypeInRequiredDescription
CustomerPhoneNumberstringbodyRequiredNuméro de l'émetteur. Format : +212*********
AmountdecimalbodyRequiredMontant à transférer.
ReasonstringbodyRequiredMotif du transfert.
RecipientPhoneNumberstringbodyRequiredNuméro du bénéficiaire. Format : +212*********
BeneficiaryIdintbodyOptionalRéférence à un bénéficiaire existant (optionnel).
POST{host}/api/operations/transfer

Exécuter

Exécute un transfert de fonds entre wallets.

ParameterTypeInRequiredDescription
CustomerPhoneNumberstringbodyRequiredNuméro de l'émetteur.
AmountdecimalbodyRequiredMontant à transférer.
ReasonstringbodyRequiredMotif du transfert.
RecipientPhoneNumberstringbodyRequiredNuméro du bénéficiaire.
BeneficiaryIdintbodyOptionalRéférence à un bénéficiaire existant (optionnel).

Virement bancaire

POST{host}/api/operations/bank-transfer/preview

Aperçu

Vérifie la faisabilité d'un virement vers un compte bancaire externe.

ParameterTypeInRequiredDescription
CustomerPhoneNumberstringbodyOptionalRequis si AgentCode est vide. Exclusif avec AgentCode (l'un OU l'autre).
AgentCodestringbodyOptionalRequis si CustomerPhoneNumber est vide. Code Agent (Principal ou Retail). Exclusif avec CustomerPhoneNumber.
AmountdecimalbodyRequiredMontant à virer.
ReasonstringbodyRequiredMotif du virement (caractères latins uniquement, 35 caractères max).
BeneficiaryIdintbodyOptionalOptionnel si rib + beneficiaryName sont fournis.
BeneficiaryNamestringbodyOptionalOptionnel si beneficiaryId est fourni.
RibstringbodyOptionalRIB : chaîne numérique de 24 chiffres. Optionnel si beneficiaryId est fourni.

Notes

  • •Au moins un identifiant parmi beneficiaryId ou (rib + beneficiaryName) doit être fourni.
POST{host}/api/operations/bank-transfer

Exécuter

Envoie de l'argent d'un wallet vers un compte bancaire externe.

ParameterTypeInRequiredDescription
CustomerPhoneNumberstringbodyOptionalRequis si AgentCode est vide. Exclusif avec AgentCode (l'un OU l'autre).
AgentCodestringbodyOptionalRequis si CustomerPhoneNumber est vide. Exclusif avec CustomerPhoneNumber.
AmountdecimalbodyRequiredMontant à virer.
ReasonstringbodyOptionalMotif du virement (optionnel à l'exécution).
BeneficiaryIdintbodyOptionalOptionnel si rib + beneficiaryName sont fournis.
BeneficiaryNamestringbodyOptionalOptionnel si beneficiaryId est fourni.
RibstringbodyOptionalRIB : 24 chiffres. Requis si pas de beneficiaryId.

Paiement marchand

POST{host}/api/operations/merchant/payment/push/manual/preview

Par téléphone — Aperçu

Vérifie la faisabilité d'un paiement marchand par numéro de téléphone.

ParameterTypeInRequiredDescription
CustomerPhoneNumberstringbodyRequiredNuméro du client payeur.
AmountdecimalbodyRequiredMontant du paiement.
ReasonstringbodyRequiredMotif du paiement.
RecipientPhoneNumberstringbodyRequiredNuméro du marchand.
BeneficiaryIdintbodyOptionalRéférence à un bénéficiaire existant (optionnel).
POST{host}/api/operations/merchant/payment/push/manual

Par téléphone — Exécuter

Effectue un paiement marchand par numéro de téléphone.

ParameterTypeInRequiredDescription
CustomerPhoneNumberstringbodyRequiredNuméro du client payeur.
AmountdecimalbodyRequiredMontant du paiement.
ReasonstringbodyRequiredMotif du paiement.
RecipientPhoneNumberstringbodyRequiredNuméro du marchand.
BeneficiaryIdintbodyOptionalRéférence à un bénéficiaire existant (optionnel).
POST{host}/api/operations/merchant/payment/push/qrcode/preview

Par QR Code — Aperçu

Vérifie la faisabilité d'un paiement marchand par QR Code.

ParameterTypeInRequiredDescription
CustomerPhoneNumberstringbodyRequiredNuméro du client payeur.
QrCodeContentstringbodyRequiredContenu du QR Code scanné.
AmountdecimalbodyRequiredMontant du paiement.
POST{host}/api/operations/merchant/payment/push/qrcode

Par QR Code — Exécuter

Effectue un paiement marchand par QR Code.

ParameterTypeInRequiredDescription
CustomerPhoneNumberstringbodyRequiredNuméro du client payeur.
QrCodeContentstringbodyRequiredContenu du QR Code.
AmountdecimalbodyRequiredMontant du paiement.
POST{host}/api/operations/merchant/payment/push/card/preview

Par carte — Aperçu

Vérifie la faisabilité d'un paiement marchand par carte (Card to Wallet).

ParameterTypeInRequiredDescription
PhoneNumberstringqueryRequiredNuméro du marchand.
AmountdecimalbodyRequiredMontant du paiement.
POST{host}/api/operations/merchant/payment/card

Par carte — Exécuter

Effectue un paiement marchand par carte (Card to Wallet). Flux 3DS : la réponse fournit `redirectionURL` à ouvrir.

ParameterTypeInRequiredDescription
PhoneNumberstringqueryRequiredNuméro du marchand. Format : +212*********
FirstNamestringbodyRequiredPrénom du titulaire.
LastNamestringbodyRequiredNom du titulaire.
CvvstringbodyRequiredCVV (3 chiffres).
AmountdecimalbodyRequiredMontant du paiement.
PanstringbodyRequiredNuméro de carte (PAN).
ExpiryDatestringbodyRequiredDate d'expiration au format `YYMM`. Ex : `2608`.
KeepAliveboolbodyRequiredTokenizer la carte pour réutilisation via l'endpoint Tokenized Card.
CurrencystringbodyOptionalDevise. Par défaut : MAD.
3dSecureboolbodyOptionalActiver 3D Secure. Par défaut : true.
FeesPercentdecimalbodyOptionalPourcentage de frais appliqués au payeur.
AllowInternationalCardsboolbodyOptionalAccepter les cartes internationales.
InternationalFeesPercentdecimalbodyOptionalFrais % spécifiques aux cartes internationales.
AutoCaptureboolbodyOptionalCapture automatique du paiement.
NotificationUrlstringbodyOptionalURL notifiée après fin de transaction (succès/échec).
AcceptUrlstringbodyOptionalURL de redirection en cas de succès 3DS.
CardNamestringbodyOptionalLibellé de la carte (pour tokenisation).
ExternalReferencestringbodyOptionalRéférence externe du marchand.

Notes

  • •Après l'authentification 3D Secure, l'utilisateur est redirigé vers acceptURL ou declineURL selon le résultat.
  • •L'URL de redirection inclut des paramètres : RESPONSE_CODE (0 = succès, autre = échec), REASON_CODE (raison lisible : SUCCESS, DECLINED…) et OPERATION (type d'opération, ex : PAYMENT).
  • •Validez RESPONSE_CODE et REASON_CODE à la réception du retour pour déterminer la suite dans votre application.
POST{host}/api/operations/merchant/payment/tokenized/card/{cardId}

Par carte tokenisée — Exécuter

Effectue un paiement marchand via une carte précédemment tokenisée (`KeepAlive = true`). Seul le CVV est requis.

ParameterTypeInRequiredDescription
cardIdintpathRequiredID de la carte tokenisée.
PhoneNumberstringqueryRequiredNuméro du marchand. Format : +212*********
CvvstringbodyRequiredCVV (3 chiffres).
AmountdecimalbodyRequiredMontant du paiement.

Notes

  • •Même structure de réponse que « Paiement marchand par carte — Exécuter ».
  • •Après l'authentification 3D Secure, l'utilisateur est redirigé vers acceptURL ou declineURL selon le résultat.
  • •L'URL de redirection inclut des paramètres : RESPONSE_CODE (0 = succès, autre = échec), REASON_CODE (raison lisible) et OPERATION.
GET{host}/api/operations/merchant/qrcode/static

Génération QR statique

Génère un QR Code statique (sans montant pré-intégré) pour un marchand. Le client saisit le montant lors du paiement.

ParameterTypeInRequiredDescription
PhoneNumberstringqueryRequiredNuméro du marchand.
MaskedNumberboolqueryOptionalMasquer le numéro du marchand dans le contenu QR. Ex : +2126######74
POST{host}/api/operations/merchant/qrcode

Génération QR dynamique

Génère un QR Code dynamique avec un montant fixe intégré, associé à une référence unique.

ParameterTypeInRequiredDescription
PhoneNumberstringqueryRequiredNuméro du marchand.
MaskedNumberboolqueryOptionalMasquer le numéro du marchand.
AmountdecimalbodyRequiredMontant fixe du QR Code.

Notes

  • •QR statique (GET) : aucun montant intégré, le client saisit le montant au paiement.
  • •QR dynamique (POST) : montant fixe intégré, référence unique `qrCodeReference`.

Chargeback (Rétrofacturation)

POST{host}/api/operations/chargeback/preview

Aperçu

Vérifie la faisabilité d'un chargeback.

ParameterTypeInRequiredDescription
SourcePhoneNumberstringbodyRequiredNuméro du client à l'origine. Format : +212*********
AmountdecimalbodyRequiredMontant du chargeback.
DescriptionstringbodyRequiredMotif du chargeback.
DestinationPhoneNumberstringbodyRequiredNuméro du destinataire. Format : +212*********
OriginalOperationIdintbodyRequiredID de l'opération d'origine qui a déclenché le chargeback.
POST{host}/api/operations/chargeback

Exécuter

Exécute un chargeback.

ParameterTypeInRequiredDescription
SourcePhoneNumberstringbodyRequiredNuméro du client à l'origine.
AmountdecimalbodyRequiredMontant du chargeback.
DescriptionstringbodyRequiredMotif du chargeback.
DestinationPhoneNumberstringbodyRequiredNuméro du destinataire.
OriginalOperationIdintbodyRequiredID de l'opération d'origine.

Opérations par référence (Request)

POST{host}/api/operations/cashin/request

Demander un CashIn

Crée une demande de CashIn. Génère une référence unique avec une durée de validité limitée.

ParameterTypeInRequiredDescription
PhoneNumberstringbodyRequiredNuméro de téléphone du client.
AmountdecimalbodyRequiredMontant du CashIn.

Notes

  • •operationType : 1 = CashIn, 2 = CashOut
  • •operationStatus : 1 = open, 2 = completed, 3 = failed, 4 = canceled
POST{host}/api/operations/cashout/request

Demander un CashOut

Crée une demande de CashOut. Génère une référence unique avec une durée de validité limitée.

ParameterTypeInRequiredDescription
PhoneNumberstringbodyRequiredNuméro de téléphone du client.
AmountdecimalbodyRequiredMontant du CashOut.

Consulter les opérations

GET{host}/api/operations

Par client

Récupère la liste des opérations d'un client avec filtres optionnels.

ParameterTypeInRequiredDescription
PhoneNumberstringqueryRequiredNuméro de téléphone du client.
PageSizeintqueryOptionalRésultats par page. Par défaut : 10
PageNumberintqueryOptionalNuméro de page. Par défaut : 1
OperationTypelist intqueryOptional1=CASHIN, 2=CASHOUT, 3=TRANSFER, 5=MOBILE_PAYMENT, 7=PAYMENT_REFUND, 9=BANK_TRANSFER, 10=RECHARGE, 12=CHARGEBACK, 24=CARD_PAYMENT, 25=BILL_PAYMENT
TransactionStatusintqueryOptional1=OPEN, 2=COMPLETED, 3=FAILED, 4=CANCELED
SensintqueryOptional1=CREDIT, 2=DEBIT
FromdatetimequeryOptionalDate/heure de début du filtre.
TodatetimequeryOptionalDate/heure de fin du filtre.

Notes

  • •collection : liste paginée des opérations.
  • •count : nombre total d'opérations correspondant aux filtres.
  • •accountNumber : peut être un numéro de téléphone, un RIB ou un accountId.
GET{host}/api/operations/{id}

Par ID

Récupère le détail d'une opération spécifique par son ID.

ParameterTypeInRequiredDescription
PhoneNumberstringqueryRequiredNuméro de téléphone du client.
IdintrouteRequiredID de l'opération.

Notes

  • •operationId : identifiant de l'opération globale.
  • •transactionId : identifiant de la transaction principale (une opération peut générer plusieurs transactions : débit émetteur, crédit destinataire, frais, etc.).
  • •transactionReference : référence de la transaction principale.
  • •amount : montant initial.
  • •totalAmount : montant après application des frais et commissions.
GET{host}/api/operations/all

Toutes (par partenaire)

Récupère la liste de toutes les opérations du partenaire.

ParameterTypeInRequiredDescription
PhoneNumberstringqueryRequiredNuméro de téléphone du client. Format : +212*********
PageSizeintqueryOptionalRésultats par page. Par défaut : 10
PageNumberintqueryOptionalNuméro de page (commence à 1). Par défaut : 1
OperationTypelist intqueryOptionalFiltrer par type d'opération.
TransactionStatusintqueryOptionalFiltrer par statut de transaction.
SensintqueryOptional1 = CREDIT, 2 = DEBIT
FromdatetimequeryOptionalDate/heure de début.
TodatetimequeryOptionalDate/heure de fin.
GET{host}/api/operations/c-request-idComing Soon

Par C-Request-Id

Récupère une opération par son identifiant C-Request-Id. Disponible dans une prochaine version.

No parameters required.

Remboursement

POST{host}/api/operations/refund/preview

Aperçu

Vérifie la faisabilité d'un remboursement après paiement marchand.

ParameterTypeInRequiredDescription
PhoneNumberstringbodyRequiredNuméro du client à rembourser.
OperationIdintbodyRequiredID de l'opération à rembourser.
RefundAmountdecimalbodyRequiredMontant du remboursement.
OrderIdstringbodyRequiredOrderId original du paymentGateway.
TransactionTrackIdstringbodyRequiredTransactionTrackId original du paymentGateway.
POST{host}/api/operations/refund

Exécuter

Exécute le remboursement d'un client après paiement marchand.

ParameterTypeInRequiredDescription
phoneNumberstringbodyRequiredNuméro du client.
OperationIdintbodyRequiredID de l'opération à rembourser.
RefundAmountdecimalbodyRequiredMontant du remboursement.
OrderIdstringbodyRequiredOrderId original.
TransactionTrackIdstringbodyRequiredTransactionTrackId original.
B

Bénéficiaires

Gérez les bénéficiaires d'un client : consultation, ajout, modification et suppression. Les bénéficiaires peuvent être identifiés par numéro de téléphone et/ou RIB.

GET{host}/api/customer/beneficiaries

Liste des bénéficiaires

Récupère la liste paginée des bénéficiaires d'un client.

ParameterTypeInRequiredDescription
PhoneNumberstringqueryRequiredNuméro de téléphone du client.
PageSizeintqueryOptionalRésultats par page. Par défaut : 10
PageNumberintqueryOptionalNuméro de page. Par défaut : 1
SearchstringqueryOptionalFiltrer par mot-clé.
FromdatetimequeryOptionalDate de création — début.
TodatetimequeryOptionalDate de création — fin.
POST{host}/api/customer/beneficiaries

Ajouter un bénéficiaire

Ajoute un nouveau bénéficiaire. Au moins le PhoneNumber ou le RIB doit être fourni.

ParameterTypeInRequiredDescription
PhoneNumber (query)stringqueryRequiredNuméro de téléphone du client (propriétaire).
NamestringbodyRequiredNom du bénéficiaire. Minimum 2 lettres.
PhoneNumberstringbodyOptionalNuméro du bénéficiaire. Format : +212*********
RibstringbodyOptionalRIB du bénéficiaire. 24 chiffres.
EmailstringbodyOptionalEmail du bénéficiaire.

Notes

  • •PhoneNumber ou RIB : au moins l'un des deux doit être fourni.
PUT{host}/api/customer/beneficiaries/{id}

Modifier un bénéficiaire

Met à jour un bénéficiaire existant.

ParameterTypeInRequiredDescription
PhoneNumber (query)stringqueryRequiredNuméro de téléphone du client (propriétaire).
IdintrouteRequiredID du bénéficiaire à modifier.
NamestringbodyRequiredNom du bénéficiaire. Minimum 2 lettres.
PhoneNumber (body)stringbodyOptionalNuméro de téléphone du bénéficiaire.
RibstringbodyOptionalRIB du bénéficiaire. 24 chiffres.
EmailstringbodyOptionalEmail du bénéficiaire.
DELETE{host}/api/customer/beneficiaries/{Id}

Supprimer un bénéficiaire

Supprime un bénéficiaire existant.

ParameterTypeInRequiredDescription
PhoneNumberstringqueryRequiredNuméro de téléphone du client.
IdintrouteRequiredID du bénéficiaire à supprimer.
C

Cartes tokenisées

Consultez et gérez les cartes bancaires sauvegardées (tokenisées) d'un client.

GET{host}/api/customers/tokenized/cards

Liste des cartes

Récupère toutes les cartes tokenisées d'un client.

ParameterTypeInRequiredDescription
PhoneNumberstringqueryRequiredNuméro de téléphone du client.
PageSizeintqueryOptionalRésultats par page. Par défaut : 10
PageNumberintqueryOptionalNuméro de page. Par défaut : 1

Notes

  • •customerBankCardId : identifiant unique de la carte sauvegardée.
  • •maskedPan : numéro de carte masqué (4 derniers chiffres).
  • •issuer : nom de la banque émettrice.
  • •scheme : réseau de la carte (Visa, Mastercard, etc.).
  • •cardName : libellé optionnel choisi par le client au moment de la tokenisation.
GET{host}/api/customers/tokenized/cards/{id}

Carte par ID

Récupère les détails d'une carte tokenisée spécifique.

ParameterTypeInRequiredDescription
PhoneNumberstringqueryRequiredNuméro de téléphone du client.
IdintrouteRequiredID de la carte.
DELETE{host}/api/customers/tokenized/cards/{id}Coming Soon

Supprimer une carte

Supprime une carte tokenisée. Disponible dans une prochaine version.

No parameters required.

A

Agents détaillants

Gérez les agents détaillants : consultation, ajout, et exécution d'opérations CashIn/CashOut par référence.

GET{host}/api/agents/retail

Liste des agents détaillants

Récupère la liste paginée des agents détaillants.

ParameterTypeInRequiredDescription
CodestringqueryRequiredCode de l'agent.
PageSizeintqueryOptionalRésultats par page. Par défaut : 10
PageNumberintqueryOptionalNuméro de page. Par défaut : 1
FromdatetimequeryOptionalCréation de l'agent — date début.
TodatetimequeryOptionalCréation de l'agent — date fin.
GET{host}/api/agents/retail/{code}

Agent par code

Récupère les détails d'un agent détaillant par son code.

ParameterTypeInRequiredDescription
CodestringrouteRequiredCode de l'agent.
POST{host}/api/agents/retail

Ajouter un agent

Ajoute un nouvel agent détaillant.

ParameterTypeInRequiredDescription
PhoneNumberstringbodyRequiredNuméro de téléphone de l'agent. Format : +212*********
NamestringbodyRequiredNom commercial de l'agent.
FirstNamestringbodyRequiredPrénom. Minimum 2 lettres.
LastNamestringbodyRequiredNom de famille. Minimum 2 lettres.
CinstringbodyRequiredNuméro de pièce d'identité.
AddressstringbodyOptionalAdresse de l'agent.
EmailstringbodyOptionalEmail de l'agent.
PUT{host}/api/agents/retail/{code}Coming Soon

Modifier un agent

Met à jour un agent détaillant existant. Disponible dans une prochaine version.

No parameters required.

GET{host}/api/operations/cashin/request

Consulter CashIn par référence

Récupère les détails d'une opération CashIn demandée via sa référence unique.

ParameterTypeInRequiredDescription
ReferencestringqueryRequiredRéférence unique de l'opération.

Notes

  • •type : 1 = CashIn, 2 = CashOut
  • •status : 1 = open, 2 = completed, 3 = failed
POST{host}/api/operations/cashin/agent

Exécuter CashIn par référence

L'agent exécute une opération CashIn en utilisant la référence générée par le client.

ParameterTypeInRequiredDescription
CodestringbodyRequiredCode de l'agent effectuant l'opération.
ReferencestringbodyRequiredRéférence unique de l'opération à exécuter.
GET{host}/api/operations/cashout/request

Consulter CashOut par référence

Récupère les détails d'une opération CashOut via sa référence unique.

ParameterTypeInRequiredDescription
ReferencestringqueryRequiredRéférence unique de l'opération.
POST{host}/api/operations/cashout/agent

Exécuter CashOut par référence

L'agent exécute une opération CashOut en utilisant la référence générée par le client.

ParameterTypeInRequiredDescription
CodestringbodyRequiredCode de l'agent effectuant l'opération.
ReferencestringbodyRequiredRéférence unique de l'opération à exécuter.
A

Agents principaux

Consultez les informations d'un agent principal.

GET{host}/api/agents/principal

Agent principal par code

Récupère les informations de compte d'un agent principal.

ParameterTypeInRequiredDescription
CodestringqueryRequiredCode de l'agent principal.

Notes

  • •Réponse : objet Agent + objet Account (solde, RIB, niveau, etc.).
S

Simulation (Sandbox)

Endpoints de simulation disponibles uniquement en sandbox pour finaliser les opérations CashIn/CashOut par référence sans interaction avec un réseau d'agents réel. Associez-les à la carte de test ci-dessous pour dérouler un parcours bout-en-bout.

Carte de test

Utilisez ces données de carte pour tester les dépôts par carte en environnement sandbox.

PAN

4918914107195005

CVV

123

Expiry

08/26 (ou toute date future)

3DS Code

555
POST{host}/api/simulate/network/operations/cashin200

Simuler un CashIn réseau

Simule l'exécution d'un CashIn par référence (étape agent réseau). Déclenche le webhook `cashin.network.executed`.

ParameterTypeInRequiredDescription
referencestringbodyRequiredRéférence numérique retournée lors de la création de la requête CashIn.
POST{host}/api/simulate/network/operations/cashout200

Simuler un CashOut réseau

Simule l'exécution d'un CashOut par référence (étape agent réseau). Déclenche le webhook `cashout.network.executed`.

ParameterTypeInRequiredDescription
referencestringbodyRequiredRéférence numérique retournée lors de la création de la requête CashOut.
W

Webhooks

Les webhooks permettent au BAAS Chari de notifier votre système des événements (opération complétée, mises à jour KYC, etc.) en quasi temps réel. Votre serveur expose un endpoint HTTPS ; nous envoyons des événements JSON signés par POST.

HTTP Request

POSThttps://{your-domain}/webhooks/chari

Vous pouvez fournir tout autre endpoint.

Headers

Content-Type: application/jsonUser-Agent: Chari-BAAS-Webhook/1.0C-Webhook-Id: xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxxX-Api-Key: xxxxxxxx
  • •C-Webhook-Id : identifiant unique de la requête webhook, généré par Chari.
  • •X-Api-Key : clé secrète pour l'authentification de votre système (vous devez nous fournir cette clé).

Réponse attendue : 200 OK sous 5 secondes (corps vide). En cas d'erreur métier ou de rupture de contrat de notre côté, veuillez retourner une erreur 400 avec une description du problème. Tout code non-2xx déclenche un retry.

Event Body Properties

Propriétés communes

PropertyTypeRequiredDescription
WebhookIdstringRequiredIdentifiant du webhook.
EventIdstringRequiredType d'événement. Ex : bank-transfer.initiated
CRequestIdstringRequiredIdentifiant de traçage reçu du partenaire.
OperationIdintRequiredID de l'opération exécutée (peut être 0 si aucune opération créée).
TransactionIdintOptionalID de la transaction principale.
OperationTypeintRequiredCode du type d'opération (voir Types).
OperationStatusintRequired1 = Open, 2 = Completed, 3 = Failed, 4 = Canceled
CreatedAtdateRequiredDate de début du processus.
ExecutedAtdateRequiredDate d'exécution de l'opération.
AmountdecimalRequiredMontant de l'opération.
FeeAmountdecimalRequiredMontant des frais.
PrimaryAccountNumberstringRequiredNuméro de téléphone de l'émetteur.
SecondaryAccountNumberstringOptionalNuméro de téléphone du destinataire.
MethodstringOptionalMéthode : Card / Agent / Network

Spécifique Cash-in Card

PropertyTypeRequiredDescription
CustomDatastringOptionalDonnées personnalisées fournies par le partenaire (max 128 caractères).
GatewayTrackIdstringOptionalGateway Transaction Track Id.
GatewayOrderIdstringOptionalGateway Transaction Order Id.
GatewayReferenceIdstringOptionalGateway Transaction Reference Id.

Spécifique virement bancaire

PropertyTypeRequiredDescription
BankTransferBeneficiaryNamestringOptionalNom du bénéficiaire pour les virements bancaires.

Cash-in / Cash-out (référence réseau)

PropertyTypeRequiredDescription
NetworkNamestringOptionalNom du réseau pour les opérations réseau.
ReferencestringOptionalRéférence de l'opération par référence.

Retry Policy

Backoff:1 min, 5 min, 30 min, 60 min, puis toutes les 6h jusqu'à 72h au total.
Stop:Arrêt au premier 200.
Dead letter:Après 72h sans réponse 200, l'événement est marqué comme non distribuable.

Events

Event IDDescription
customer.level.updatedNiveau de compte client mis à jour
cashin.card.authorizedCashIn par carte accepté
payment.card.authorizedPaiement par carte accepté
payment.receivedPaiement reçu par le marchand
bank-transfer.initiatedVirement bancaire envoyé
bank-transfer.completedVirement bancaire finalisé (réglé, rejeté ou retourné — inspecter OperationStatus)
bank-transfer.receivedVirement bancaire reçu
transfer.receivedTransfert reçu
cashin.network.executedCashIn par référence exécuté
cashout.network.executedCashOut par référence exécuté

Example Event Body

Virement bancaire

json
{
  "data": {
    "WebhookId": 12345,
    "CRequestId": "a4d1e0b5-9f6a-4c1d-bc7b-2d0a7f4b9b12",
    "OperationId": 924381,
    "OperationType": 5,
    "OperationStatus": 2,
    "CreatedAt": "2025-11-05T10:12:00Z",
    "ExecutedAt": "2025-11-05T10:12:22Z",
    "Amount": 25000.00,
    "FeeAmount": 350.00,
    "CustomData": "{\"note\":\"Salary for October\"}",
    "PrimaryAccountNumber": "+212711111111",
    "SecondaryAccountNumber": "+212722222222",
    "Method": "BankTransfer",
    "Reference": "BANK-REF-9FJ2X7",
    "BankTransferBeneficiaryName": "Aminata Diop"
  }
}

CashIn par carte

json
{
  "data": {
    "WebhookId": 12346,
    "CRequestId": "7b8c9f1a-15da-4e1c-8c3b-3a2bd0ed5e6f",
    "OperationId": 563210,
    "OperationType": 1,
    "OperationStatus": 2,
    "CreatedAt": "2025-11-05T09:41:00Z",
    "ExecutedAt": "2025-11-05T09:41:18Z",
    "Amount": 10000.00,
    "FeeAmount": 150.00,
    "CustomData": "ref12345",
    "PrimaryAccountNumber": "+212711111111",
    "Method": "Card",
    "GatewayTrackId": "83c1d1c7",
    "GatewayOrderId": "20251105_00045",
    "GatewayReferenceId": "6f92b0aa"
  }
}
F

Format de réponse

Toutes les réponses de l'API sont enveloppées dans un objet `data`. Le header C-Request-Id que vous envoyez est renvoyé dans la réponse pour faciliter le traçage.

C-Request-Id Header

L'API prend en charge le header C-Request-Id pour permettre le suivi des requêtes. Vous pouvez inclure un C-Request-Id unique dans les headers de requête, qui sera renvoyé dans la réponse. Cela facilite le logging, le debugging et le traçage des requêtes dans des systèmes distribués.

T

Types et références

Operation Types

IDCode
1CASHIN
2CASHOUT
3TRANSFER
5MOBILE_PAYMENT
7PAYMENT_REFUND
9BANK_TRANSFER
10RECHARGE
12CHARGEBACK
24CARD_PAYMENT
25BILL_PAYMENT

Transaction Types

IDCode
1CASHIN
2CASHOUT
3TRANSFER
5MOBILE_PAYMENT
6TRANSACTION_FEES
7PAYMENT_REFUND
9CHARGEBACK
10CHARGEBACK_CANCELLATION
16BANK_TRANSFER
17RECHARGE
18CASHBACK
24CARD_PAYMENT
25BILL_PAYMENT

Operation Statuses

IDCodeDescription
1OPENOuverte (cycle en cours)
2COMPLETEDTerminée avec succès
3FAILEDÉchouée
4CANCELEDAnnulée

Transaction Statuses

IDCodeDescription
1OPENEn cours
2COMPLETEDTerminée
3FAILEDÉchouée
4CANCELEDAnnulée

Transaction Direction (Sens)

IDCodeDescription
1CREDITCrédit (entrée de fonds)
2DEBITDébit (sortie de fonds)

Customer Statuses

IDCodeDescription
0NOT_EXISTSLe numéro n'existe pas chez ChariMoney
1NOT_CONFIRMEDExiste mais non confirmé (OTP non saisi)
2CONFIRMEDConfirmé et inscrit au Switch
3ACTIVEInscrit, actif et PIN créé
4LOCKED_TEMPORARYTemporairement bloqué (tentatives excessives)
5LOCKEDBloqué

Account Levels

IDCodeDescription
1LEVEL_1Niveau 1 — Nom + téléphone valide + numéro CIN. Plafond : 1 000 MAD.
2LEVEL_2Niveau 2 — KYC complet (CIN + selfie ou scan document). Plafond : 4 000 MAD.
3LEVEL_3Niveau 3 — Pièce vérifiée + entretien + dossier numérique. Plafond : 20 000 MAD.
4LEVEL_4Niveau 4 — KYC complet + entretien + justificatif de revenus + justificatif de domicile. Plafond : 100 000 MAD.
5MERCHANTMarchand — KYB complet + immatriculation IF/RC. Plafond : négocié.

Document Types

IDCodeDescription
1IdentityCardCarte d'identité nationale
2DrivingLicensePermis de conduire
3PassportPasseport
4ResidencePermitCarte de séjour
5ProofOfIncomeJustificatif de revenus
6ProofOfResidenceJustificatif de domicile
7SelfieSelfie / Photo de visage
8CommercialRegisterRegistre de commerce
C

Codes d'erreur

HTTP Status Codes

401 UnauthorizedIdentifiants d'authentification (API KEY) non autorisés.
422 UnprocessableLe serveur ne peut pas traiter la requête.
423 LockedL'accès est verrouillé pour le client donné.
400 Bad RequestErreur spécifique avec un code d'erreur Chari (voir ci-dessous).

Error Response Format

json
{
  "errorCode": 20005,
  "errorDescription": "The specified user could not be found."
}

Chari Error Codes

10xxxGénéral

CodeMessageRelated Endpoints
10001Paramètres manquants.

20xxxClient

CodeMessageRelated Endpoints
20000Le format du numéro de téléphone est invalide.
20005L'utilisateur spécifié est introuvable.
20006Les paramètres initiaux fournis sont incorrects ou invalides.
20007Le code de catégorie marchand (MCC) fourni est incorrect ou non reconnu.
20008L'inscription est temporairement verrouillée pour des raisons de sécurité.
20009La demande est en attente de confirmation. Veuillez patienter.
20017Aucune demande en attente n'est associée au numéro de téléphone fourni.

26xxxPIN / Authentification

CodeMessageRelated Endpoints
26001Le PIN saisi est incorrect.
26004Un PIN a déjà été défini pour ce wallet.
26005Le PIN fourni ne respecte pas le format requis (doit être un nombre à 4 chiffres).

27xxxBénéficiaire

CodeMessageRelated Endpoints
27000Le bénéficiaire existe déjà avec le même numéro de téléphone.
27001Le bénéficiaire n'existe pas.

32xxxKYC / Mise à niveau

CodeMessageRelated Endpoints
32000Une demande de mise à niveau est déjà en cours d'examen pour ce compte.
I

Infrastructure et sécurité

Environments

Sandbox

https://sandbox.charimoney.com

Environnement de développement et de test. Les transactions sont simulées.

Production

Communiqué sur demande

Transactions réelles. Nécessite une approbation préalable et des tests réussis en sandbox.

API Key Management

Vous recevrez une clé API dédiée pour chaque environnement (sandbox et production). Les clés doivent être incluses dans le header Chari-Api-Key de chaque requête.

IP & Domain Whitelisting

Vous devez partager les adresses IP et/ou domaines qui consommeront l'API. Seuls les IP/domaines autorisés (whitelistés) pourront accéder à l'API. En cas de changement d'infrastructure, mettez à jour votre liste auprès du support.

How to submit IPs / domains

  1. 1Fournir une liste d'adresses IP publiques ou de domaines qui accéderont à l'API.
  2. 2Transmettre cette liste à l'équipe support avant toute intégration.
  3. 3Communiquer tout changement au moins 72 h à l'avance afin de mettre à jour les règles de sécurité.

Security & Compliance

  • •L'authentification API est gérée par clés API.
  • •Les requêtes provenant d'IP/domaines non autorisés seront rejetées.
  • •En cas de compromission d'une clé API, elle doit être immédiatement révoquée et rotée.
  • •Un rate limiting peut s'appliquer pour prévenir les abus (contactez le support pour les limites).
  • •L'environnement de production nécessite une approbation préalable et des tests réussis en sandbox.

Next Steps for Integration

  1. 1
    Demander les clés API

    Contactez le support pour recevoir vos clés dédiées sandbox et production.

  2. 2
    Soumettre les IP/domaines

    Fournissez la liste des IP publiques ou domaines pour le whitelisting.

  3. 3
    Tester en sandbox

    Effectuez tous vos tests d'intégration dans l'environnement sandbox.

  4. 4
    Passer en production

    Une fois approuvé, basculez vers la production avec votre clé API live.

Vous recevrez un formulaire à remplir avec les éléments nécessaires.

API Documentation - ChariBaaS | ChariBaaS