Introduction

Vue d’ensemble

AlphaPay opère sur plusieurs pays d’Afrique de l’Ouest et du Centre, chacun rattaché à une devise, et sur les réseaux mobile money disponibles dans chacun d’eux.

Pays (Country)
├── iso_code           ── "BJ", "CI", "SN"...
├── default_currency    ── "XOF", "XAF"...
│
└── Réseaux (Network)   ── rattachés à un pays
    ├── code             ── "mtn_bj", "moov_ci"...  ← à utiliser dans vos requêtes
    ├── name
    └── is_active

code (ex. "mtn_bj") est la valeur à utiliser dans le champ network de Initier un paiement softpay et dans le champ method de Initier un retrait. C’est la clé technique qui relie ce catalogue de référence aux endpoints de paiement.Voir Pays, réseaux et format du téléphone pour un tableau complet (tous les pays actifs, tous les codes réseau, et le format de numéro de téléphone attendu par pays) — plus rapide à consulter que d’assembler /countries/ et /networks/ à la main.

Pays

Champ	Type	Description
`id`	uuid	Identifiant du pays
`iso_code`	string	Code ISO 2 lettres, ex. `BJ`
`name`	string	Nom du pays
`default_currency`	string	Devise ISO 3 lettres, ex. `XOF`
`created_at` / `updated_at`	datetime	—

Exemple

{
  "id": "6d1a...",
  "iso_code": "BJ",
  "name": "Bénin",
  "default_currency": "XOF"
}

GET /countries/ est public — aucune authentification requise, fonctionne même sans clé API. Pratique pour peupler un formulaire d’inscription avant qu’un compte n’existe. La liste n’est pas paginée (tableau JSON brut, pas d’enveloppe {count, results}) : c’est un catalogue borné, à récupérer en un seul appel.GET /countries/{id}/, en revanche, nécessite une authentification (clé API valide) — contrairement à la liste.

Réseaux

Champ	Type	Description
`id`	uuid	Identifiant du réseau
`country`	uuid	Pays auquel ce réseau est rattaché
`code`	string	Valeur technique, ex. `mtn_bj` — utilisée comme `network`/`method` dans les endpoints de paiement
`name`	string	Nom lisible, ex. `MTN Mobile Money`
`is_active`	boolean	Réseau actuellement opérationnel côté AlphaPay
`created_at` / `updated_at`	datetime	—

Contrairement à /countries/, GET /networks/ nécessite une authentification et est paginé. Il n’existe surtout aucun filtre ?country=, malgré le besoin évident de “quels réseaux pour ce pays” — vous devez lister l’ensemble et filtrer côté client sur le champ country.

Vue d'ensemble

Encaisser

Transactions

Liens de paiement

Décaissements

Solde & taux de change

Webhooks

Référentiels

Vue d’ensemble

Pays

Réseaux

​Vue d’ensemble

​Pays

​Réseaux

Vue d’ensemble

Pays

Réseaux