API-Integration
Authentifizieren Sie Händler für das Accept SDK über Ihr Backend.
Damit Ihre Händler das Tapaya Accept SDK nutzen können, registriert Ihr Backend jeden Händler und fordert für jede SDK-Session ein kurzlebiges Login-Token an. Beide Aufrufe verwenden Ihr Server Secret Token; wie Sie eines erzeugen, beschreibt die Authentifizierung der Platform API.
Das Onboarding von Händlern und das Abrufen von Zahlungsdaten funktionieren für alle Tapaya-Produkte gleich und sind im gemeinsamen Bereich „Übersicht“ dokumentiert: Merchant Onboarding API und Reporting und Zahlungen.
Routing nach Umgebung
Das Accept SDK leitet Anfragen automatisch weiter, je nachdem, wie es initialisiert wurde:
- Sandbox (Standard): Verbindet sich mit der Sandbox-Umgebung unter
https://api.sandbox.tapaya.com. - Produktion: Verbindet sich mit der Produktionsumgebung unter
https://api.tapaya.com.
Händler-Authentifizierung (Accept-SDK-Integrationen)
Nur für Accept-SDK-Integrationen
Überspringen Sie diesen Abschnitt, wenn Sie die App Tapaya Terminal direkt steuern (Intent/Deeplink, ohne eingebettetes SDK); dann ist das in Tapaya Terminal angemeldete Konto der Merchant of Record (für die Transaktion verantwortlicher Händler), und Ihr Backend authentifiziert nie eine Händler-Session. Siehe Integration ohne SDK.
Damit Ihre Händler das Tapaya Accept SDK nutzen können, müssen Sie in Ihrem Backend die folgenden Endpoints implementieren.
Neuen Händler registrieren
Bevor ein Händler das SDK nutzen kann, muss er im Tapaya-System registriert sein. Das geschieht in der Regel, wenn sich ein Nutzer für Ihren Dienst registriert. Sie müssen den Händler nur einmal registrieren. Die Registrierung ist in der Tapaya Platform UI oder über die API möglich.
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"
}'Parameter:
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
merchantToken | string | Eine eindeutige, stabile Kennung aus Ihrem System (z. B. eine Datenbank-ID), die den | |
| Händler identifiziert. Wenn Sie keine angeben, wird ein zufälliges Token für Sie erzeugt. | |||
merchantName | string | Lesbarer Name, an dem Sie den Händler im Dashboard und in Berichten erkennen. Ohne Angabe wird | |
merchantToken verwendet. | |||
email | string | ✓ | Admin-E-Mail-Adresse des Händlers, verwendet für die Anmeldung und wichtige Mitteilungen. |
Antworten:
| Code | Beschreibung |
|---|---|
200 | Händler erfolgreich registriert |
400 | Validierungsfehler der Anfrage |
401 | Nicht autorisiert |
409 | Konflikt: Händler bereits registriert |
Antwort-Body:
{
"merchantToken": "unique_merchant_id_from_your_db"
}Login-Token erzeugen
Damit ein Mobilgerät das SDK für einen bestimmten Händler initialisieren kann, müssen Sie ein kurzlebiges Login-Token erzeugen. Ihre mobile App fordert es bei Ihrem Backend an, und Ihr Backend fordert es bei Tapaya an. Bei jeder Initialisierung des SDK benötigen Sie ein neues Token.
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"
}'Parameter:
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
merchantToken | string | ✓ | Händlerkennung des Integrators, für die das Authentifizierungstoken |
ausgestellt wird. Dieselbe wie in /auth/register. | |||
allowOnboarding | boolean | true, wenn der Nutzer im Namen des Händlers Onboarding-/KYB-Angaben einsehen und aktualisieren, neue | |
Zahlungsmethoden registrieren und die AGB akzeptieren darf. Muss beim ersten Aufruf true sein, damit der | |||
Händler mindestens eine Zahlungsmethode registrieren kann. false, wenn der Nutzer keinen Zugriff auf das Onboarding hat und nur | |||
bereits konfigurierte Zahlungsmethoden verwenden kann. Ohne Angabe gilt true. | |||
employeeEmail | string | E-Mail-Adresse des Mitarbeiters, der das Terminal verwendet. |
Antworten:
| Code | Beschreibung |
|---|---|
200 | Händler erfolgreich angemeldet |
400 | Validierungsfehler der Anfrage |
401 | Nicht autorisiert |
404 | Nicht gefunden |
Antwort-Body:
{
"token": "EesrFq4PUK1WxHUj93hkrKASDFp8GxJ0"
}Übergeben Sie dieses token an Ihre mobile App, um das SDK zu initialisieren. Übertragen Sie
es sicher an die mobile App und löschen Sie es unmittelbar nach der Verwendung. Das Token ist an den Händler gebunden, der durch
merchantToken identifiziert wird.
Sicherheitswarnung
Achten Sie darauf, beim Abrufen des SDK-Tokens das richtige merchantToken zu verwenden. Das Tapaya SDK verwendet dieses Token, um sich
im Namen des Händlers anzumelden, und erhält damit Zugriff auf dessen Daten und Gelder.