Zum Hauptinhalt springen

API für Händleranwendungen

Ein Händlerantrag enthält die KYC-Daten eines von Ihnen neu registrierten Händlers: Unternehmensdaten, Rechtsform, wirtschaftliche Eigentümer, Bankdaten sowie Informationen zum Produkt- und Preisumfeld des Händlers. Die Anträge sind in Schritte gegliedert, die einzeln ausgefüllt und aktualisiert werden können, und enden mit der rechtlichen Bestätigung durch den Händler selbst über den gehosteten Übermittlungsablauf.

Basispfad: /api/v2.0/onboarding/merchant-applications · Berechtigung: JOIN_PROGRAM_ACCESS

MethodePfadBeschreibung
POST/Händlerantrag erstellen (leerer Entwurf oder vollständige Daten)
GET/Alle Händleranträge auflisten
GET/searchHändleranträge suchen
GET/{id}Händlerantrag abrufen
PATCH/{id}Händleranwendung aktualisieren
DELETE/{id}Händleranwendung löschen (endgültig)
PATCH/{id}/stepsEinen Schritt einer Händleranwendung aktualisieren
DELETE/{id}/stepsEinen Schritt einer Händleranmeldung löschen
GET/{id}/submission-urlDie gehostete Übermittlungs-URL zurückgeben
GET/{id}/statusAntragsstatus abrufen
POST/{id}/submitBewerbung einreichen und eine Organisation anlegen

Typischer Lebenszyklus​

create (draft) ──▶ update / update steps ──▶ submission URL ──▶ merchant confirms ──▶ status: active
└──▶ submit & create organization (API-completed flow)

Händleranmeldung erstellen​

Der Request-Body ist optional: Senden Sie einen leeren Body, um einen Antragsentwurf zu erstellen, oder senden Sie die vollständige Antragsdatenlast, um den Antrag mit den Anfangsdaten zu erstellen. Tragen Sie alle Ihnen bereits bekannten Daten Ihres Kunden vorab ein – so muss dieser sie nicht erneut eingeben.

curl -X POST "https://app-wallee.com/api/v2.0/onboarding/merchant-applications" \
-H "Authorization: Bearer <JWT>" \
-H "account: <YOUR_ACCOUNT_ID>" \
-H "Content-Type: application/json" \
-d '{ ...merchant application data... }'

Antwort: 201 Created, wobei der Antrag auch dessen id enthält.

Abrufen, Auflisten und Suchen​

GET /api/v2.0/onboarding/merchant-applications/{id}
GET /api/v2.0/onboarding/merchant-applications
GET /api/v2.0/onboarding/merchant-applications/search

Nutzen Sie die Liste/Suche, um sich einen eigenen Überblick über die Onboarding-Pipelines zu verschaffen – z. B. alle Bewerbungen, die sich noch im Entwurfsstadium befinden, oder alle Bewerbungen, die in der letzten Woche eingereicht wurden.

Händleranwendung aktualisieren​

Bewerbungen können aktualisiert werden, solange sie sich noch im Entwurfsstadium befinden:

curl -X PATCH "https://app-wallee.com/api/v2.0/onboarding/merchant-applications/{id}" \
-H "Authorization: Bearer <JWT>" \
-H "account: <YOUR_ACCOUNT_ID>" \
-H "Content-Type: application/json" \
-d '{ ...updated fields... }'

Einen einzelnen Schritt aktualisieren oder löschen​

Anträge sind in einzelne Schritte unterteilt (z. B. Unternehmensdaten, wirtschaftliche Eigentümer). Die einzelnen Schritte können separat aktualisiert oder entfernt werden – dies ist besonders nützlich, wenn Ihre Plattform die Daten über mehrere Bildschirme hinweg erfasst:

PATCH  /api/v2.0/onboarding/merchant-applications/{id}/steps
DELETE /api/v2.0/onboarding/merchant-applications/{id}/steps

Die URL für die Einreichung abrufen​

Der Händler muss den Antrag selbst prüfen und rechtlich bestätigen. Rufen Sie die gehostete URL für die Einreichung ab und leiten Sie den Händler dorthin weiter (oder betten Sie den Link in Ihr Produkt ein):

curl "https://app-wallee.com/api/v2.0/onboarding/merchant-applications/{id}/submission-url" \
-H "Authorization: Bearer <JWT>" \
-H "account: <YOUR_ACCOUNT_ID>"

Den Status des Antrags abrufen​

curl "https://app-wallee.com/api/v2.0/onboarding/merchant-applications/{id}/status" \
-H "Authorization: Bearer <JWT>" \
-H "account: <YOUR_ACCOUNT_ID>"

Verwenden Sie diese Funktion, um den Fortschritt des Onboardings in Ihrem eigenen Produkt anzuzeigen, oder abonnieren Sie Webhooks für Statusänderungen, anstatt regelmäßig Abfragen durchzuführen.

Antrag einreichen und eine Organisation anlegen​

Schließt die Anwendung programmgesteuert ab und legt die Organisation des Händlers an:

POST /api/v2.0/onboarding/merchant-applications/{id}/submit

Unabhängig davon, wie der Antrag ausgefüllt wird, führt wallee die vollständigen KYC-/AML- und PSD2-Prüfungen durch und bleibt das regulierte Unternehmen. Die rechtliche Bestätigung des Händlers ist stets erforderlich.

Händlerantrag löschen​

DELETE /api/v2.0/onboarding/merchant-applications/{id}

Antwort: 204 No Content

Warnung: Das Löschen ist endgültig und kann nicht rückgängig gemacht werden. Es sollten nur Entwürfe von Anträgen gelöscht werden.

Vollständige Anfrage-/Antwortschemas für jeden Endpunkt: Interaktiver API-Client – suchen Sie nach „Händleranwendung“.