Skip to main content
POST
Enrôler un compte bancaire
Cet appel rattache un compte bancaire supplémentaire à un usager existant. Pour le premier instrument d’un nouvel usager, utilisez plutôt l’enrôlement d’usager.

Champs

C’est l’endpoint d’enrôlement le plus simple : les cinq champs sont tous obligatoires, sans variation selon le cas.
DAT désigne un dépôt à terme. Ces trois valeurs constituent la liste exhaustive du contrat : un type de compte non listé ne peut pas être enrôlé en l’état.

Avant d’appeler

1

Identifiez la banque émettrice

GET /contributors?typeInstrument=COMPTE_BANCAIRE&codeIso=... retourne les contributeurs proposant ce type d’instrument, avec leur référence.
2

Vérifiez que le compte n'est pas déjà enrôlé

POST /check-existence en passant le RIB comme identifiantCompte, puis validation de l’OTP.

Réponses

Le corps utile arrive dans body, à l’intérieur de l’enveloppe commune { message, status, body, timestamp }, et contient refInstrumentPaiement — la référence de l’instrument créé, à conserver pour les appels suivants. Un 404 indique qu’une entité renseignée est introuvable : le plus souvent refUsager ou l’une des deux références de contributeur. Voir la référence des codes d’erreur.

Et ensuite ?

Consulter le solde

GET /wallets/{referenceWallet}/balance

Exécuter une opération

Utilisez ce compte comme instrument initiateur.

Authorizations

Authorization
string
header
required

Jeton émis par POST /api/v1/auth/token.

Body

application/json
numeroRib
string
required

Le numéro RIB

refContributeurDemandeur
string
required

La référence du contributeur demandeur qui demande l'enrôlement de l'instrument de paiement

refContributeurEmetteur
string
required

La référence du contributeur émetteur de l'instrument de paiement à enrôler

refUsager
string
required

La reference de l'usager

typeCompteBancaire
enum<string>
required
Available options:
CHEQUE,
EPARGNE,
DAT

Response

Compte bancaire enrôlé.

Enveloppe standard de toutes les réponses (sauf auth).

message
string

Message technique décrivant le résultat de l'appel.

status
integer

Code de statut HTTP de la réponse.

timestamp
string<date-time>

Horodatage de la réponse.

body
object