Content Comparison

Enhance your experience!

• Use callback URLs, avoid polling!

  • After opening the Web Form for your user, your application has to wait until the Web Form flow is completed and then get the result.

...

• • In case you included

  a callbacks

  • callback.finalised in the API call, your application will receive a POST request to the callbacks.finalised once the Web Form flow has been completed. You can then get more details on the result with the “Get a web form” REST service

  (see below)In case you didn't include a callbacks.finalised in the Web Form

  • .

  • Bank connection update

    For the bank connection update flow, there is an additional callback option, callbacks.webFormRequired. This callback gets triggered if we are unable to download the account data without end-user intervention (e.g. second-factor authentication gets triggered). Use this notification to forward the end-user to the Web Form workflow.

  • In case you don’t use callback URLs, you will need to poll the “Get a web form” and/or “Get a task” service at regular intervals to detect by yourself

  when

  • if the

  flow has been completed

  • workflow has reached the end. We recommend polling the status every couple of seconds (at most, once a second)

• Read the API response carefully. The payload could carry carries -

  • bankConnectionId or paymentId - when the Web Form is completed successfully. Use this in Access to get more data about the bank connection or the payment.

  • (optionally) errorCode - when the Web Form is completed with the status “COMPLETED_WITH_ERROR”. Use the data in this field to determine how you would like to navigate the end-user within your application for the next steps.

...

For the above example, the complete URL to open in your user's browser (with an added redirectUrl and customerSupportUrl) would be:

https://live.finapi.io/webForm/nEvozFaPhCXw8ZnnRBb2KJGANW6y9RjZgQtX6YRAhB_Li7TzO19jTh0wtBg9AbvblAMnJFp7DS1C0zzj746U4B7GUj4LUIyt9ZR9Sn2UoLzg5SYaEx9Ps6ax_6ImXTOB
?redirectUrl=https%3A%2F%2Fyourapphttps%3A%2F%2Fyourapp.net%2Fwebnet%2Fweb-form-redirect%3FredirectParam%3Dfoobar&customerSupportUrl=https%3A%2F%2Fyourapphttps%3A%2F%2Fyourapp.net%2Fwebnet%2Fweb-form-redirect%3FsupportParam%3Dfoobar

...