Pre-requisites

Step 1 - Initiate standing order

To initiate a SEPA Standing Order use the Create a standing order endpoint:

POST /api/webForms/standingOrder
CODE

If the IBAN of the sender account is already known, we recommend including it in the standing order initiation payload to avoid the possibility that several SCAs will be required.

If the IBAN of the sender account is not known, it is still possible to initiate a standing order without the sender account and the user will have to select the Bank or IBAN on the Web Form (see the next step).

There are some payment data validations that we recommend being implemented to avoid bank payment rejections. Please refer to Payment Data Validation.

Step 2 - User to log in at the bank and authorise the standing order

As a result of Step 1, the web form is generated. You can find the URL of the web form in the response:

url: "https://webform.finapi.io/wf/946db09e-5bfc-11eb-ae93-0242ac130002"
CODE

The webform has to be presented to the user. If the sender IBAN was not provided in Step 1, the user will have to either enter the IBAN into the web form or search for a bank first. Once the sender account is selected, the user will proceed to the standing order authorisation.

You have two options how to present the webform to the user:

  • Embed the web form into your application. How to: Embedded Web Form 2.0

  • Redirect the user to the Web Form URL in the browser.

There are several branding and customization possibilities available for the web form. Please check out the web form documentation: White labeling

Step 3 - Check the status of the web form

To retrieve the status of the web form, you can either call the Get a web form service or a callback can be sent of completion to a callback URL provided in the standing order initiation payload during Step 1.

Note the standingOrderId returned in the response (in the payload object) to get the status of the standing order initiation in the next step.

More details are available here: https://finapi.jira.com/wiki/spaces/FWFPD/pages/2039971847/Web+Form+2.0+Basics#Want-to-know-web-form-status%3F

Step 4 - Check the status of the standing order initiation

To retrieve the status of the standing order initiation, get the standingOrderId from Step 3 and execute Get Standing Orders:

GET /api/v1/standingOrders?ids=$standingOrderId
CODE

For more details, please refer to How to get the payment initiation status.

Step 5 - Delete User (Optional)

If for your use-case you do not need to save the user to re-use it later, we recommend that you delete the user once the standing order initiation has been finalized via Delete the authorized user endpoint:

DELETE /api/v1/users
CODE