Informations Organisation

Obtenez les informations de votre organisation marchand, y compris votre nom commercial et le solde courant de votre compte de dépôt.

Présentation

L'endpoint Informations Organisation permet de consulter le profil de l'organisation marchand associée à vos identifiants d'API. Cet appel est idéal pour vérifier votre solde disponible avant d'exécuter des paiements ou des transferts.

URL de Base selon l'environnement :

  • 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

Informations Endpoint

CaractéristiqueDétail
MéthodeGET
URL/merchant/organization
AuthentificationEn-têtes HTTP X-Auth-ApiKey et X-Auth-ApiSecret

Console d'essai interactive

Tester la recherche des informations de votre organisation

Consultez le nom de votre entreprise et le solde disponible de votre compte marchand.

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

Aucun paramètre d'URL configuré.

Structure de la réponse (JSON)

  • name (String) : Le nom commercial ou la raison sociale de votre entreprise.
  • depositAccount (Object) : Objet contenant les détails du solde de dépôt.
    • prefixedAmount (String) : Montant formaté avec la devise (ex: "6 F CFA").
    • amount (Number) : Valeur numérique exacte du solde (ex: 6.259916).

Exemple de réponse HTTP 200

{
  "name": "BOUTIQUE DEMO BMO",
  "depositAccount": {
    "prefixedAmount": "150 000 F CFA",
    "amount": 150000.0
  }
}

Codes de Statut HTTP

Code StatutSignificationAction
200 OKSuccès.Données d'organisation récupérées.
401 UnauthorizedClé ou secret invalide.Vérifier X-Auth-ApiKey et X-Auth-ApiSecret.
403 ForbiddenAccès interdit.Vérifier que le compte dispose des privilèges marchands.

Exemple de Code (Node.js Axios)

import axios from 'axios';

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

axios.get('https://svc.pap.bestcash.me/external/merchant/organization', {
  headers: {
    'X-Auth-ApiKey': apiKey,
    'X-Auth-ApiSecret': apiSecret
  },
})
.then(response => {
  const { name, depositAccount } = response.data;
  console.log(`Organisation : ${name}`);
  console.log(`Solde disponible : ${depositAccount.prefixedAmount}`);
})
.catch(error => {
  console.error('Erreur lors de la récupération de l\'organisation :', error.message);
});