From 68cac2ca3e21b80dfee8fcf03674073254cb732d Mon Sep 17 00:00:00 2001 From: SilviaAmAm Date: Mon, 20 Nov 2023 17:37:31 +0100 Subject: [PATCH] :memo: [#3005] Document new payment flow --- docs/configuration/general/index.rst | 1 + docs/configuration/general/payment_flow.rst | 20 ++++++++++++++++++++ docs/manual/forms/basics.rst | 13 +++++++++++++ 3 files changed, 34 insertions(+) create mode 100644 docs/configuration/general/payment_flow.rst diff --git a/docs/configuration/general/index.rst b/docs/configuration/general/index.rst index 63293c8898..0eb1ca0d40 100644 --- a/docs/configuration/general/index.rst +++ b/docs/configuration/general/index.rst @@ -12,3 +12,4 @@ General configuration oidc cms_integration virus_scan + payment_flow diff --git a/docs/configuration/general/payment_flow.rst b/docs/configuration/general/payment_flow.rst new file mode 100644 index 0000000000..bad34fb942 --- /dev/null +++ b/docs/configuration/general/payment_flow.rst @@ -0,0 +1,20 @@ +.. _configuration_general_payment_flow: + +============ +Payment flow +============ + +For forms where a payment is required, it is possible to configure when the submission should be registered. +The setting **Wait for payment to register** can be found in the admin in the **General configuration**, +under the header **Registration**. + +If **Wait for payment to register** is checked, then a submission will only be sent to the registration backend when +the payment is completed. Note that if the submission should also be co-signed, then it will be registered only when +both the payment and the co-sign are completed. + +If **Wait for payment to register** is NOT checked, then the submission is registered as soon as it is completed (unless +co-sign is also needed). Then, once payment is completed, the payment status will be updated in the registration backend. +This means, that for registration backends that create a zaak (StUF-ZDS and ZGW registration backends), the +status of the zaak will be updated. In the case of the email registration backend, a second email will be sent to notify +that the payment has been received. For the MSGraph backend, the ``payment_status.txt`` file will be updated to say that +the payment was received. diff --git a/docs/manual/forms/basics.rst b/docs/manual/forms/basics.rst index 672d38fd61..a4788fd3ff 100644 --- a/docs/manual/forms/basics.rst +++ b/docs/manual/forms/basics.rst @@ -207,6 +207,19 @@ dezelfde regels als reguliere **Logica**. Zie ook: :ref:`configuration_payment_index` +Er zijn twee mogelijke flows om inzendingen te registreren voor formulieren waar een betaling nodig is. + +1. Zodra de inzending voltooid is, wordt de inzending naar de registratiebackend gestuurd. Als het wordt betaald, wordt + de status van de betaling in de registratiebackend aangepast. In het geval van de e-mailregistratiebackend, gebeurt + dit door een extra (update-)e-mail te sturen, terwijl voor StUF-ZDS en ZGW registratiebackends, de betaalstatus van de zaak + wordt aangepast. +2. De inzending wordt naar de registratiebackend gestuurd pas ná dat de betaling voltooid is. + +De flow kan ingesteld worden in de **Algemene Configuratie**. + +Zie ook: :ref:`configuration_general_payment_flow` + + Gegevens opschonen ------------------