Skip to main content
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

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

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

Authorization
string
header
required

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

Body

application/json
refInstrumentPaiement
string
required

Référence GIMpay de l'instrument de paiement pour lequel générer le code OTP.

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