{
  "name": "fin_api_access",
  "version": "1.117.0",
  "description": "strongRESTful_API_for_Account_Information_Services__AIS_and_Payment_Initiation_Services__PISstrongThe_following_pages_give_you_some_general_information_on_how_to_use_our_APIs_brThe_actual_API_services_documentation_then_follows_further_below__You_can_use_the_menu_to_jump_between_API_sections_brbrThis_page_has_a_built_in_HTTP_S_client_so_you_can_test_the_services_directly_from_within_this_pageby_filling_in_the_request_parameters_andor_body_in_the_respective_services_and_then_hitting_the_TRY_button_Note_that_you_need_to_be_authorized_to_make_a_successful_API_call__To_authorize_refer_to_the_Authorizationsection_of_the_API_or_just_use_the_OAUTH_button_that_can_be_found_near_the_TRY_button_brbrYou_should_also_check_out_the_a_hrefhttpsfinapi_zendesk_comhcen_us_target_blankDeveloper_Portalafor_more_information__If_you_need_any_help_with_the_API_contact_supportfinapi_io_brh2General_informationh2h3strongError_Responsesstrongh3When_an_API_call_returns_with_an_error_then_in_general_it_has_the_structure_shown_in_the_following_examplepre__errors____________message_Interface_FINTS_SERVER_is_not_supported_for_this_operation_______code_BAD_REQUEST______type_TECHNICAL________date_2020_11_19_165406_854__requestId_selfgen_312042e7_df55_47e4_bffd_956a68ef37b5__endpoint_POST_apiv1bankConnectionsimport__authContext_121__bank_DEMO0002___finAPI_Test_Redirect_BankpreIf_an_API_call_requires_an_additional_authentication_by_the_user_HTTP_code_510_is_returned_and_the_error_responsecontains_the_additional_multiStepAuthentication_object_see_the_following_examplepre__errors____________message_Es_ist_eine_zustzliche_Authentifizierung_erforderlich__Bitte_geben_Sie_folgenden_Code_an_123456______code_ADDITIONAL_AUTHENTICATION_REQUIRED______type_BUSINESS______multiStepAuthentication_________hash_678b13f4be9ed7d981a840af8131223a________status_CHALLENGE_RESPONSE_REQUIRED________challengeMessage_Es_ist_eine_zustzliche_Authentifizierung_erforderlich__Bitte_geben_Sie_folgenden_Code_an_123456________answerFieldLabel_TAN________redirectUrl_null________redirectContext_null________redirectContextField_null________twoStepProcedures_null________photoTanMimeType_null________photoTanData_null________opticalData_null______________date_2019_11_29_095155_931__requestId_selfgen_45059c99_1b14_4df7_9bd3_9d5f126df294__endpoint_POST_apiv1bankConnectionsimport__authContext_118__bank_DEMO0001___finAPI_Test_BankpreAn_exception_to_this_error_format_are_API_authentication_errors_where_the_following_structure_is_returnedpre__error_invalid_token__error_description_Invalid_access_token_cccbce46_xxxx_xxxx_xxxx_xxxxxxxxxxpreh3strongPagingstrongh3API_services_that_may_potentially_return_a_lot_of_data_implement_paging_They_return_a_limited_number_of_entries_within_a_page__Further_entries_must_be_fetched_withsubsequent_calls_brbrAny_API_service_that_implements_paging_provides_the_following_input_parametersbrbull_page_the_number_of_the_page_to_be_retrieved__starting_with_1_brbull_perPage_the_number_of_entries_within_a_page__The_default_and_maximum_value_is_statedin_the_documentation_of_the_respective_services_A_paged_response_contains_an_additional_paging_object_with_the_following_structurepre_________paging_____page_1____perPage_20____pageCount_234____totalCount_4662__preh3strongInternationalizationstrongh3The_finAPI_services_support_internationalization_which_means_you_can_define_the_language_you_preferfor_API_service_responses_brbrThe_following_languages_are_available_German_English_Czech_Slovak_brbrThe_preferred_language_can_be_defined_by_providing_the_official_HTTP_strongAccept_Languagestrongheader_For_web_form_request_issued_in_a_web_browser_the_Accept_Language_header_isautomatically_set_by_the_browser_based_on_the_browsers_or_operation_systems_language_settings_For_direct_API_calls_the_Accept_Language_header_must_be_set_explicity_brbrfinAPI_reacts_on_the_official_iso_language_codes_quotdequot_quotenquot_quotcsquotand_quotskquot_for_the_named_languages_Additional_subtags_supported_by_the_Accept_Language_header_may_be_providede_g__quoten_USquot_but_are_ignored_brIf_no_Accept_Language_header_is_given_German_is_used_as_the_default_language_brbrExceptionsbrbull_Bank_login_hints_and_login_fields_are_only_available_in_the_language_of_the_bank_and_notbeing_translated_brbull_Direct_messages_from_the_bank_systems_typically_returned_as_BUSINESS_errors_will_notbe_translated_brbull_BUSINESS_errors_created_by_finAPI_directly_are_available_in_German_and_English_brbull_TECHNICAL_errors_messages_meant_for_developers_are_mostly_in_English_but_also_may_betranslated_h3strongRequest_IDsstrongh3With_any_API_call_you_can_pass_a_request_ID_via_a_header_with_name_X_REQUEST_ID_The_request_ID_can_be_an_arbitrary_string_with_up_to_255_characters_Passing_a_longer_string_will_result_in_an_error_brbrIf_you_dont_pass_a_request_ID_for_a_call_finAPI_will_generate_a_random_ID_internally_brbrThe_request_ID_is_always_returned_back_in_the_response_of_a_service_as_a_header_withname_X_REQUEST_ID_brbrWe_highly_recommend_to_always_pass_a__preferably_unique_request_ID_and_include_it_into_yourclient_application_logs_whenever_you_make_a_request_or_receive_a_response_especially_in_the_case_of_an_error_response__finAPI_is_also_logging_request_IDs_on_its_end_Having_a_request_ID_can_help_the_finAPI_support_team_to_work_more_efficiently_and_solve_tickets_faster_h3strongOverriding_HTTP_methodsstrongh3Some_HTTP_clients_do_not_support_the_HTTP_methods_PATCH_or_DELETE_If_you_are_using_such_a_client_in_your_application_you_can_use_a_POST_request_instead_with_a_specialHTTP_header_indicating_the_originally_intended_HTTP_method_brbrThe_headers_name_is_strongX_HTTP_Method_Overridestrong__Set_its_value_to_eitherstrongPATCHstrong_or_strongDELETEstrong_POST_Requests_having_this_header_set_will_be_treated_either_as_PATCH_or_DELETE_by_the_finAPI_servers_brbrExamplebrbrstrongX_HTTP_Method_Override_PATCHstrongbrPOST_apiv1label51brname_changed_labelbrbrwill_be_interpreted_by_finAPI_asbrbrPATCH_apiv1label51brname_changed_labelbrh3strongUser_metadatastrongh3With_the_migration_to_PSD2_APIs_a_new_term_called_User_metadata_also_known_as_PSU_metadata_has_been_introduced_to_the_API_This_user_metadata_aims_to_inform_the_banking_API_if_there_was_a_real_end_userbehind_an_HTTP_request_or_if_the_request_was_triggered_by_a_system_e_g__by_an_automatic_batch_update__In_the_latter_case_the_bank_may_apply_some_restrictionssuch_as_limiting_the_number_of_HTTP_requests_for_a_single_consent_Also_some_operations_may_be_forbidden_entirely_by_the_banking_API_For_example_some_banks_do_not_allow_issuing_a_new_consent_without_the_end_user_being_involved_Therefore_the_PSU_metadata_must_always_be_provided_for_such_operations_brbrAs_finAPI_does_not_have_direct_interaction_with_the_end_userit_is_the_client_applications_responsibility_to_provide_all_the_necessaryinformation_about_the_end_user__This_must_be_done_by_sending_additional_headers_with_every_requesttriggered_on_behalf_of_the_end_user_brbrAt_the_moment_the_following_headers_are_supported_by_the_APIbrbull_PSU_IP_Address___the_IP_address_of_the_users_device_brbull_PSU_Device_OS___the_users_device_andor_operating_system_identification_brbull_PSU_User_Agent___the_users_web_browser_or_other_client_device_identification_brbrWeb_form_customers__or_unlicensed_customers_must_send_the_PSU_headers_from_their_client_applicationto_finAPI__It_will_not_take_effect_if_web_form_is_triggered_for_the_workflow_brIn_this_case_Values_for_the_PSU_Device_OS_and_PSU_User_Agent_headers_are_identifiedby_the_JS_platform_detection_and_the_PSU_IP_Address_is_obtained_from_a_public_Cloudflare_service_httpswww_cloudflare_comcdn_cgitrace_brbrBut_it_is_certainly_necessary_and_obligatory_to_have_the_true_PSU_header_data_for_API_callswhich_dont_trigger_a_web_form__like_Update_a_bank_connection_h3strongFAQstrongh3strongIs_there_a_finAPI_SDKstrongbrCurrently_we_do_not_offer_a_native_SDK_but_there_is_the_option_to_generate_a_SDKfor_almost_any_target_language_via_Swagger__Use_the_Download_SDK_button_on_this_page_for_SDKgeneration_brbrstrongHow_can_I_enable_finAPIs_automatic_batch_updatestrongbrCurrently_there_is_no_way_to_set_up_the_batch_update_via_the_API_Please_contact_supportfinapi_io_for_this_brbrstrongWhy_do_I_need_to_keep_authorizing_when_calling_services_on_this_pagestrongbrThis_page_is_a_one_page_app__Reloading_the_page_resets_the_OAuth_authorization_context_There_is_generally_no_need_to_reload_the_page_so_just_dont_do_it_and_your_authorization_will_persist_",
  "license": "Unlicense",
  "main": "src/index.js",
  "scripts": {
    "test": "mocha --recursive"
  },
  "browser": {
    "fs": false
  },
  "dependencies": {
    "superagent": "3.7.0",
    "querystring": "0.2.0"
  },
  "devDependencies": {
    "mocha": "~2.3.4",
    "sinon": "1.17.3",
    "expect.js": "~0.3.1"
  }
}