Add upgrade docs

diff --git a/docs/index.rst b/docs/index.rst
index 8ea371cef678aeab1d946453ecc558958737a7b8..0ba1e64b30b13cd80f5e831e6591f7ad33ebbff6 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -20,6 +20,7 @@ Library user documentation content
    transfers
    debits
    tested
+   upgrading_4_5
    upgrading_3_4
    upgrading_2_3
    upgrading_1_2

diff --git a/docs/upgrading_4_5.rst b/docs/upgrading_4_5.rst
new file mode 100644 (file)
index 0000000..383ec8c
--- /dev/null
+++ b/docs/upgrading_4_5.rst
@@ -0,0 +1,12 @@
+Upgrading from python-fints 4.x to 5.x
+======================================
+
+Release 5.0 of this library was made to introduce breaking changes:
+
+* When your bank no longer supports fetching MT940 bank statements, `get_transactions()` will transparently fall back
+  to retrieve XML statements and convert them to dictionaries. While we tried to keep the most important fields in
+  place, this will cause different output. Please verify that the new output does not cause issues in your application.
+
+* When sending a credit transfer, you might now receive a `NeedVOPResponse` instead of a `NeedTANResponse` if there is
+  no exact match of payer names. You can proceed with `approve_vop_response()` and will then receive your
+  `NeedTANResponse` as usual.