Créditer un compte (Dépôt)

Cet endpoint permet d'effectuer une opération de crédit (dépôt ou transfert de fonds) sur le compte d'un client B-MO.

Présentation

L'opération Créditer un compte permet à un marchand partenaire de transférer un montant spécifié vers le compte d'un client B-MO.

URL de Base (selon l'environnement sélectionné) :

  • PAP (Pré-production / Défaut) : https://svc.pap.bestcash.me/external
  • TEST (Sandbox) : https://svc.test.bestcash.me/external
  • LIVE (Production) : https://svc.bmo.bestcash.me/external

Vous pouvez basculer d'un environnement à un autre à tout moment depuis le menu déroulant en haut de la console d'essai ci-dessous.

Informations Endpoint

CaractéristiqueDétail
MéthodePOST
URL/external/operations/credit
AuthentificationEn-têtes HTTP X-Auth-ApiKey et X-Auth-ApiSecret

Console d'essai interactive

Tester l'opération de Crédit B-MO

Transmettez une requête de crédit vers un compte client et vérifiez la réponse de confirmation.

Authentification (En-têtes B-MO)
Paramètres d'URL / Query Parameters (0)

Aucun paramètre d'URL configuré.

Corps de la Requête (JSON Body)

Structure de la requête (JSON Body)

{
  "amount": 15000,
  "reason": "Motif de l'opération (optionnel)",
  "depositor": "Nom du déposant (optionnel)",
  "idType": "Type de pièce d'identité (optionnel)",
  "idNumber": "Numéro de pièce d'identité (optionnel)",
  "cardExpiration": "Date d'expiration de la pièce (optionnel)",
  "partnerReference": "Référence unique générée par le partenaire",
  "customer": {
    "phone": "+2290160000000",
    "firstname": "Prénom du client (optionnel si client existant)",
    "lastname": "Nom du client (optionnel si client existant)"
  }
}

Remarques importantes :

  • Les champs reason, idType, idNumber, cardExpiration, customer.firstname et customer.lastname sont optionnels.
  • Si le client n'existe pas encore (retour 404 lors du check), les champs firstname et lastname sont obligatoires pour créer automatiquement le compte lors du crédit.
  • La partnerReference est optionnelle mais fortement recommandée pour garantir l'unicité et le suivi de vos transactions.

Codes de Statut HTTP

  • 200 OK : L'opération de crédit a été validée avec succès.
  • 400 Bad Request : Données de requête invalides ou montant incorrect.
  • 401 Unauthorized : En-têtes d'authentification invalides.

Exemple de Code (Node.js Axios)

import axios from 'axios';

const apiKey = '+2290196666262';
const apiSecret = 'y7MwWuWeQORtpA==';

const requestData = {
  amount: 15000,
  reason: "Dépôt compte client",
  depositor: "Jonathan Doerson",
  partnerReference: `REF-${Date.now()}`,
  customer: {
    phone: "+2290160000000",
    firstname: "John",
    lastname: "Doe"
  }
};

axios.post('https://svc.pap.bestcash.me/external/operations/credit', requestData, {
  headers: {
    'X-Auth-ApiKey': apiKey,
    'X-Auth-ApiSecret': apiSecret,
    'Content-Type': 'application/json'
  }
})
.then(response => {
  console.log('Détails de la transaction de crédit :', response.data);
})
.catch(error => {
  console.error('Erreur lors de l\'opération :', error.response?.data || error.message);
});