Comptes de collecte
Page générée depuis la spécification OpenAPI que la passerelle sert (
GET /v1/openapi.json). Ne la modifiez pas à la main : elle est réécrite à chaque build.
| Méthode | Chemin | Description |
|---|---|---|
POST |
/v1/collection-accounts |
Creer un IBAN virtuel pour un client d'un systeme partenaire |
GET |
/v1/collection-accounts/{account_ref} |
Etat d'un compte de collecte |
GET |
/v1/collection-accounts/{account_ref}/rib |
Telecharger le RIB (PDF) |
POST /v1/collection-accounts
Creer un IBAN virtuel pour un client d'un systeme partenaire
Reserve aux CLIENTS SYSTEME omnibus (neo-card, neo-tpe). Un marchand ordinaire n'y a pas acces : son propre compte est cree automatiquement a l'approbation KYB et se consulte au tableau de bord.
Les identites transmises ici sont EXIGEES PAR LA BANQUE pour ouvrir un compte. neo-pays les transmet et n'en conserve rien : aucun client de systeme partenaire n'est enregistre chez nous, sous aucune forme.
⚠️ Conservez le ncp renvoye : toute operation ulterieure l'adresse, et neo-pays ne garde aucune ligne permettant de le retrouver.
⚠️ En cas de reponse 409 ambiguous_create, NE REESSAYEZ PAS : un compte peut exister a la banque. Cette API n'a pas de cle d'idempotence et une seconde tentative creerait un second compte reel.
Corps de la requête
| Champ | Type | Requis | Description |
|---|---|---|---|
customer_ref |
string | oui | VOTRE identifiant pour ce client. Devient le matricule, seul element qui ramenera les virements recus vers vous. Opaque pour neo-pays. |
nom |
string | oui | Nom de famille. Obligatoire cote banque. |
prenom |
string | non | |
adresse |
string | non | |
country |
string | non | ISO alpha-2. Doit etre dans la couverture configuree (SN). |
provider_id |
string | non | Optionnel. L'etablissement qui doit ouvrir le compte, sous forme de code stable (par exemple afrikabanque). Omis, c'est l'etablissement configure sur ce deploiement ; un code non configure est REFUSE et jamais remplace par un autre. |
Réponses
201— Compte cree (object)400— Requete invalide403— Ce client n'est pas un client systeme omnibus409— Issue INCONNUE — ne pas reessayer503— La banque est injoignable
GET /v1/collection-accounts/{account_ref}
Etat d'un compte de collecte
LA SECONDE MOITIE DE LA CREATION, pas une commodite. POST /v1/collection-accounts rend une demande ACCEPTEE et aucun IBAN : la banque termine le compte a son propre rythme (constate le 2026-09-26 : NOUVEAU / EN ATTENTE, RIB « a generer »). Interrogez cette route jusqu'a usable: true ; l'IBAN n'apparait qu'a ce moment.
⚠️ found: false ne signifie PAS « rien n'a ete cree ». La coherence de la recherche juste apres une creation n'est pas specifiee, donc une creation faite il y a quelques secondes peut legitimement repondre false. Ne recreez jamais sur cette base : vous obtiendriez un SECOND IBAN reel pour un meme client, et l'etablissement n'offre aucune suppression.
Paramètres
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
account_ref |
path | oui | NOTRE reference du compte, telle que la creation l'a rendue. Elle doit commencer par VOTRE espace de noms (par exemple neocard-) suivi des 12 chiffres ; nommer un compte hors de votre espace de noms est refuse. Remplace le ncp de l'etablissement, qui n'est plus accepte dans un chemin. |
Réponses
200— L'etat connu de la banque. (object)
GET /v1/collection-accounts/{account_ref}/rib
Telecharger le RIB (PDF)
Paramètres
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
account_ref |
path | oui | NOTRE reference du compte, telle que la creation l'a rendue. Elle doit commencer par VOTRE espace de noms (par exemple neocard-) suivi des 12 chiffres ; nommer un compte hors de votre espace de noms est refuse. Remplace le ncp de l'etablissement, qui n'est plus accepte dans un chemin. |
Réponses
200— Le PDF, tel quel (file)403— Ce compte appartient a un marchand neo-pays503— La banque est injoignable