...
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%2Fyourapp.
...
net%2Fweb-form-redirect%3FredirectParam%3Dfoobar&customerSupportUrl=
...
https%3A%2F%2Fyourapp.
...
net%2Fweb-form-redirect%3FsupportParam%3Dfoobar
Payment Initiation Services (Standalone Payments and Payment with account ID)
API parameter
purpose
- Some banks are unable to process payments without the field. It would be best to provide the purpose to ensure better success rates with payment initiationSupported character set - Depending on the bank’s technology stack and other requirements, special characters in the input might lead to failed payments. We strongly urge customers to stick to the below character set. This impacts the API parameters ,
purpose
,endToEndId
,recipient.name
a b c d e f g h i j k l m n o p q r s t u v w x y z
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
0 1 2 3 4 5 6 7 8 9
/ - ? : ( ) . , ' +
Space
Some banks supports support umlauts (ä
, Ä
, ö
, Ö
, ü
, Ü
) while some don't. The simplest solution to ensure high success rates would be to substitute umlauts with ae
, AE
, oe
, OE
, ue
, UE
respectively.
Account Information Services
API parameter
accountTypes
- We urge customers to utilize the parameter and specify only those account types which apply to their business case. When you provide this parameter, the API will attempt to import only those accounts types and stop once we have covered every account type that is requested. (BAUSPAREN┃CHECKING┃CREDIT_CARD┃LOAN┃MEMBERSHIP┃SAVINGS┃SECURITY)We use different protocols (interfaces) for different account types. The end user will be asked if they would like to loop over the entire workflow until we get all requested account types. To optimize the experience for the end user, provide only those account types that apply to your use case.
bankConnectionUpdate end point “Update a bank connection” endpoint - As mentioned in the API documentation, the update “Update a bank connection end point will serve connection” endpoint serves multiple purposes. Hence, configure the end point endpoint with the correct parameters accordinglyaccording to your need.
API parameter
importNewAccounts
: - Only when your end users would like to ADD new accounts to an existing bank connection, use the parameter,importNewAccounts
for updates. To ensure the best user experience, you can use the API parameteraccountTypes
along with it, just like you might do with the import “Import a bank connection end pointconnection” endpoint. Link this API call (with the specific parameter) to the trigger on your web site website or app, where you allow users to add new accounts to their portfolio overviewAPI parameter
editSavedSettings
- If you want to force the web form to go through the entire flow, in order to allow the end user to change the saved settings, use this parameter. For example, for end users who might have changed their online banking credentials, and would like to update the new credentials in our database as well.Using neither of the above parameters would update only existing accounts (and their transactions, balances, status) to have the latest snapshot like in Online Banking.
...