Wizard-API
Individual integration with maximum customisation
Please note that you can only use this option if you have a valid eIDAS certificate.
Keep in mind that this method of integration requires much more effort than the integration via the Javascript-Widget. Every form, every help text, and every SCA method has to be implemented on your side.
Overview
The Wizard-API is the REST-API alternative to the Javascript-Widget. Instead of integrating a tiny Javascript library on your page, the Wizard-API allows for full control of the customer-facing process.
For more information about the Wizard-API please read our technical documentation.
API documentationHow to use
Basic understanding
The Wizard-API is essentially a series of forms. Every form has to be rendered to the user, the user has to make their inputs. The inputs then have to be sent to the Wizard-API endpoint and the next form has to be rendered.
After creating a session the first step would be to initially call the Wizard-API. The following guides will provide information on how a session is generated for a specific product.
Payment Platform (XS2A.pay)Analytics Platform (XS2A.risk)Open Banking Platform (XS2A.api)If the API response contains a form, display that form to the user, collect the inputs and send them off to the Wizard-API endpoint again. If the API response then contains a form, repeat the process. The transaction is finished, if the Wizard-API endpoint does not contain any more forms.
Example of a form received by the Wizard-API
All received objects in elements
must be provided to the user via frontend to give the user the possibility to provide this data.
Example of an answer to a form by the Wizard-API
After the data is submitted you need to send this back to the API.
Last updated