Enrôler un compte bancaire
Instruments de paiement
Enrôler un compte bancaire
Rattacher un compte bancaire à un usager déjà enrôlé dans GIMpay.
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 dansbody, à 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}/balanceExécuter une opération
Utilisez ce compte comme instrument initiateur.
Authorizations
Jeton émis par POST /api/v1/auth/token.
Body
application/json
Le numéro RIB
La référence du contributeur demandeur qui demande l'enrôlement de l'instrument de paiement
La référence du contributeur émetteur de l'instrument de paiement à enrôler
La reference de l'usager
Available options:
CHEQUE, EPARGNE, DAT