Skip to main content
POST
Vérifier l'existence d'un instrument de paiement
C’est le point de départ de tout enrôlement. Cet appel vérifie si un instrument de paiement est déjà connu de GIMpay et, s’il ne l’est pas, déclenche l’envoi d’un OTP au numéro rattaché au compte amorçant ainsi le parcours d’enrôlement.

Interpréter la réponse

La logique de cet endpoint est inversée par rapport à ce que son nom suggère :
Le 400 n’est pas ici une erreur de votre requête au sens habituel : c’est le résultat métier « instrument déjà enrôlé ». Ne le traitez pas comme une donnée malformée dans votre gestion d’erreurs, sous peine d’afficher un message trompeur à l’usager.

Les quatre champs sont obligatoires

Contrairement à beaucoup d’endpoints où certains champs sont facultatifs, les quatre sont ici tous exigés :
Notez soigneusement indicatif et numero : la vérification de l’OTP exigera exactement les mêmes valeurs.

Réponses

Le corps utile est un booléen dans body, à l’intérieur de l’enveloppe commune { message, status, body, timestamp }. Un 404 indique que le contributeur renseigné est introuvable — vérifiez refContributeurEmetteur via GET /contributors. Voir la référence des codes d’erreur.

Et ensuite ?

Vérifier l'OTP

Validez le code reçu par l’usager auprès du contributeur émetteur.

Enrôler l'usager

Créez l’usager et rattachez son premier instrument de paiement.

Authorizations

Authorization
string
header
required

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

Body

application/json
refContributeurEmetteur
string
required

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

identifiantCompte
string
required

MSISDN (mobile wallet), RIB (compte bancaire), code client (carte prépayée) ou 4 derniers chiffres du PAN (carte bancaire).

numero
string
required

Numéro local du téléphone.

indicatif
string
required

Indicatif international pays, sans le symbole +.

Example:

"225"

Response

Succès. Le body de l'enveloppe est un booléen.

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
boolean