Marchands

Authentification

Les requêtes s’authentifient avec la clé API dans l’en-tête `X-API-Key`. Voir Authentification.

Pour réglages, tarification et indicateurs au niveau organisation, privilégiez l’API Organisations lorsque votre clé porte sur l’organisation.

Points de terminaison

Détails d’un marchand

Récupère le détail d’un compte marchand.

Point de terminaison : `GET /merchants/{id}`

Paramètres de chemin :

Exemple de réponse (200 OK) :

{
  "data": {
    "merchant_id": "904d003c-3736-41d4-90a5-9de74d404fd7",
    "name": "Test Merchant",
    "email": "merchant@example.com",
    "phone_number": "+123456789",
    "country": "SN",
    "mrr": 50000, // In smallest currency unit
    "arr": 600000, // In smallest currency unit
    "merchant_lifetime_value": 1200000, // In smallest currency unit
    "retry_payment_every": 3,
    "total_retries": 5,
    "metadata": {
      "industry": "e-commerce"
    },
    "created_at": "2023-01-15T10:30:00Z",
    "updated_at": "2023-02-20T14:45:00Z"
  }
}

(Voir Modèles de données pour la description des propriétés.)

Erreurs possibles :

MRR mensuel du marchand

Récupère le MRR courant d’un marchand.

Point de terminaison : `GET /merchants/{id}/mrr`

Paramètres de chemin :

Exemple de réponse (200 OK) :

{
  "data": {
    "merchant_id": "904d003c-3736-41d4-90a5-9de74d404fd7",
    "mrr": 50000, // In smallest currency unit
    "currency_code": "XOF",
    "as_of_date": "2023-04-01T00:00:00Z"
  }
}

Erreurs possibles :

ARR annuel du marchand

Récupère l’ARR courant d’un marchand.

Point de terminaison : `GET /merchants/{id}/arr`

Paramètres de chemin :

Exemple de réponse (200 OK) :

{
  "data": {
    "merchant_id": "904d003c-3736-41d4-90a5-9de74d404fd7",
    "arr": 600000, // In smallest currency unit
    "currency_code": "XOF",
    "as_of_date": "2023-04-01T00:00:00Z"
  }
}

Erreurs possibles :

Solde du compte marchand

Récupère le solde courant d’un marchand pour une devise donnée.

Point de terminaison : `GET /merchants/{id}/balance`

Paramètres de chemin :

Paramètres de requête :

Exemple de réponse (200 OK) :

{
  "data": {
    "merchant_id": "904d003c-3736-41d4-90a5-9de74d404fd7",
    "currency_code": "XOF",
    "balance": 250000, // In smallest currency unit
    "as_of_date": "2023-04-01T12:30:45Z"
  }
}

Erreurs possibles :

Notes d’implémentation

• Les montants (`mrr`, `arr`, `merchant_lifetime_value`, `balance`) sont exprimés dans la plus petite unité monétaire (ex. centimes pour l’USD ; XOF en unité de base).
• Les dates sont au format ISO 8601 (`YYYY-MM-DDTHH:mm:ssZ`).
• Voir Erreurs pour la gestion d’erreurs générale.