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
| Methode | Pfad | Beschreibung |
|---|---|---|
| POST | / | Händlerantrag erstellen (leerer Entwurf oder vollständige Daten) |
| GET | / | Alle Händleranträge auflisten |
| GET | /search | Händleranträge suchen |
| GET | /{id} | Händlerantrag abrufen |
| PATCH | /{id} | Händleranwendung aktualisieren |
| DELETE | /{id} | Händleranwendung löschen (endgültig) |
| PATCH | /{id}/steps | Einen Schritt einer Händleranwendung aktualisieren |
| DELETE | /{id}/steps | Einen Schritt einer Händleranmeldung löschen |
| GET | /{id}/submission-url | Die gehostete Übermittlungs-URL zurückgeben |
| GET | /{id}/status | Antragsstatus abrufen |
| POST | /{id}/submit | Bewerbung 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