Tapaya
Acceptation des paiements en magasinGuide d’intégrationIntégration API

Intégration API

Authentifiez les commerçants pour l’Accept SDK depuis votre backend.

Pour que vos commerçants puissent utiliser le Tapaya Accept SDK, votre backend enregistre chaque commerçant et demande un jeton de connexion de courte durée pour chaque session SDK. Les deux appels utilisent votre Server Secret Token ; pour en générer un, consultez l’authentification de la Platform API.

L’onboarding des commerçants et la récupération des données de paiement fonctionnent de la même manière pour tous les produits Tapaya et sont documentés dans la section commune « Présentation » : API d’onboarding des commerçants et Reporting et paiements.

Routage selon l’environnement

L’Accept SDK route automatiquement les requêtes selon la manière dont il a été initialisé :

  • Sandbox (par défaut) : se connecte à l’environnement sandbox à l’adresse https://api.sandbox.tapaya.com.
  • Production : se connecte à l’environnement de production à l’adresse https://api.tapaya.com.

Authentification des commerçants (intégrations Accept SDK)

Intégrations Accept SDK uniquement

Ignorez cette section si vous pilotez directement l’application Tapaya Terminal (intent/deeplink, sans SDK intégré) ; le compte connecté à Tapaya Terminal est alors le commerçant officiel (merchant of record), et votre backend n’authentifie jamais de session commerçant. Consultez Intégrer sans le SDK.

Pour permettre à vos commerçants d’utiliser le Tapaya Accept SDK, vous devez implémenter les endpoints suivants sur votre backend.

Enregistrer un nouveau commerçant

Avant de pouvoir utiliser le SDK, un commerçant doit être enregistré dans le système Tapaya. Cela se fait généralement lorsqu’un utilisateur s’inscrit à votre service. Vous n’avez besoin d’enregistrer le commerçant qu’une seule fois. L’enregistrement peut se faire dans la Tapaya Platform UI ou via l’API.

Endpoint : POST /merchant/auth/register

curl -X 'POST' 'https://api.tapaya.com/merchant/auth/register' \
-H 'Content-Type: application/json' \
-H 'Authorization: REPLACE_ME' \
-d '{
        "merchantToken": "unique_merchant_id_from_your_db",
        "merchantName": "Acme Corp",
        "email": "admin@acme.com"
    }'

Paramètres :

ChampTypeObligatoireDescription
merchantTokenstringIdentifiant unique et stable issu de votre système (par exemple, un ID de base de données) qui identifie
le commerçant. S’il n’est pas fourni, un jeton aléatoire est généré pour vous.
merchantNamestringNom lisible permettant d’identifier le commerçant dans le tableau de bord et les rapports. Vaut
merchantToken par défaut s’il n’est pas fourni.
emailstring✓E-mail de l’administrateur du commerçant, utilisé pour la connexion et les communications critiques.

Réponses :

CodeDescription
200Commerçant enregistré avec succès
400Erreur de validation de la requête
401Non autorisé
409Conflit : commerçant déjà enregistré

Corps de la réponse :

{
    "merchantToken": "unique_merchant_id_from_your_db"
}

Générer un jeton de connexion

Pour qu’un appareil mobile puisse initialiser le SDK pour un commerçant donné, vous devez générer un jeton de connexion de courte durée. Votre application mobile le demande à votre backend, et votre backend le demande à Tapaya. Il vous faut un nouveau jeton à chaque initialisation du SDK.

Endpoint : POST /merchant/auth/login

curl -X 'POST' 'https://api.tapaya.com/merchant/auth/login' \
-H 'Content-Type: application/json' \
-H 'Authorization: REPLACE_ME' \
-d '{
        "merchantToken": "unique_merchant_id_from_your_db",
        "allowOnboarding": true,
        "employeeEmail": "john@acme.com"
    }'

Paramètres :

ChampTypeObligatoireDescription
merchantTokenstring✓Identifiant du commerçant chez l’intégrateur, pour lequel le jeton d’authentification sera
émis. Identique à celui de /auth/register.
allowOnboardingbooleantrue si l’utilisateur peut consulter et mettre à jour les informations d’onboarding/KYB, activer de nouveaux
moyens de paiement et accepter les CGU au nom du commerçant. Doit valoir true lors du premier appel pour permettre au
commerçant d’activer au moins un moyen de paiement. false si l’utilisateur n’a pas accès à l’onboarding et ne peut utiliser que
des moyens de paiement déjà configurés. Vaut true par défaut.
employeeEmailstringE-mail de l’employé qui utilise le terminal.

Réponses :

CodeDescription
200Commerçant connecté avec succès
400Erreur de validation de la requête
401Non autorisé
404Introuvable

Corps de la réponse :

{
    "token": "EesrFq4PUK1WxHUj93hkrKASDFp8GxJ0"
}

Transmettez ce token à votre application mobile pour initialiser le SDK. Transférez-le de manière sécurisée vers l’application mobile et supprimez-le immédiatement après utilisation. Le jeton est lié au commerçant identifié par merchantToken.

Avertissement de sécurité

Veillez à utiliser le bon merchantToken lorsque vous récupérez le jeton du SDK. Le Tapaya SDK utilise ce jeton pour se connecter au nom du commerçant, ce qui donne accès à ses données et à ses fonds.

Il manque quelque chose sur cette page ?Demandez une fonctionnalité. Nous joignons cette page pour que l’équipe ait le contexte.