Générer un OTP de débit
OTP
Générer un code OTP
Envoyer un code à usage unique au numéro rattaché à un instrument de paiement, pour sécuriser une opération de débit.
POST
Générer un OTP de débit
Cet appel demande au contributeur émetteur d’envoyer un code à usage unique au numéro de téléphone associé à l’instrument de paiement. Ce code authentifie l’usager au moment de valider le débit : il constitue l’avant-dernière étape avant l’exécution de l’opération.
Où il s’insère dans le parcours
1
Vous générez l'OTP
Cet appel. GIMpay déclenche l’envoi du code vers le téléphone de l’usager.
2
L'usager saisit le code
Dans votre application. GIMpay ne fournit pas d’interface de saisie.
3
Vous transmettez le code
Dans le champ
authData de l’exécution de l’opération.Ne confondez pas cet endpoint avec la vérification d’un OTP (
POST /otp/confirm), qui répond à un besoin distinct : valider un code auprès d’un contributeur tiers dans le cadre d’un enrôlement.Points de vigilance
L'instrument doit être disponible
L'instrument doit être disponible
Un
400 est retourné si refInstrumentPaiement est manquant ou si l’instrument de paiement est indisponible, par exemple verrouillé ou désenrôlé. Vérifiez son statut au préalable via GET /wallets/{referenceWallet}/authorization.Réponses
Un200 confirme que l’OTP a été généré et transmis. Le corps utile est un booléen dans body, à l’intérieur de l’enveloppe commune { message, status, body, timestamp }.
Le succès de cet appel signifie que la demande d’envoi a abouti, il ne garantit pas la réception effective du SMS par l’usager. Prévoyez dans votre interface une porte de sortie si l’usager ne reçoit rien.
Et ensuite ?
Exécuter l'opération
Transmettez le code saisi dans
authData.Codes d'erreur
Signification des
400, 404 et 500 sur cet endpoint.Authorizations
Jeton émis par POST /api/v1/auth/token.
Body
application/json
Référence GIMpay de l'instrument de paiement pour lequel générer le code OTP.