Skip to main content
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é :
indicatif et numero doivent reprendre exactement les valeurs envoyées à POST /check-existence. Le contributeur associe l’OTP à ce couple : une divergence, même de formatage, peut faire échouer la validation.

Points de vigilance

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

Un 200 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

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

Identifiant du compte chez le contributeur tiers.

codeOtp
string
required

Code OTP saisi par l'usager.

Example:

"123456"

numero
string
required

Numéro local du téléphone.

Required string length: 8 - 10
indicatif
string
required

Indicatif international pays, sans le symbole +.

Required string length: 1 - 3

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