Transmettre un OTP pour confirmation
OTP
Vérifier un code OTP
Transmettre un code OTP à un contributeur tiers pour validation, dans le cadre d’un enrôlement.
POST
Transmettre un OTP pour confirmation
Cet appel transmet un code OTP au contributeur tiers émetteur de l’instrument de paiement, pour qu’il le valide. Si le code est correct, l’usager est autorisé à poursuivre son parcours.
Il complète le cycle ouvert par
POST /check-existence : lorsque cet appel signale qu’un instrument n’est pas encore connu de GIMpay, un OTP part vers le numéro rattaché au compte. C’est ce code que vous validez ici, avant de procéder à l’enrôlement.
Distinguez bien les deux endpoints OTP :
Identifier le compte
Les cinq champs sont tous obligatoires. Ils désignent le compte chez le contributeur tiers, pas encore une entité GIMpay. Puisqu’à ce stade l’instrument n’est justement pas enrôlé :Points de vigilance
Un 400 ne distingue pas code faux et donnée mal formée
Un 400 ne distingue pas code faux et donnée mal formée
La spécification décrit le
400 comme « une donnée fournie est incorrecte ou invalide ». Ce qui couvre aussi bien un code OTP erroné qu’un indicatif mal formaté. Inspectez le champ message de la réponse pour orienter le message affiché à l’usager.Réponses
Un200 signifie que le code est valide. Le corps utile est un booléen dans body, à l’intérieur de l’enveloppe commune { message, status, body, timestamp }.
Et ensuite ?
Enrôler l'usager
Une fois l’OTP validé, créez l’usager et son premier instrument.
Vérifier l'existence
L’étape qui déclenche l’envoi de cet OTP.
Authorizations
Jeton émis par POST /api/v1/auth/token.
Body
application/json
La référence du contributeur émetteur de l'instrument de paiement à enrôler
Identifiant du compte chez le contributeur tiers.
Code OTP saisi par l'usager.
Example:
"123456"
Numéro local du téléphone.
Required string length:
8 - 10Indicatif international pays, sans le symbole +.
Required string length:
1 - 3