Skip to content

Commit

Permalink
📝 [#3005] Document new payment flow
Browse files Browse the repository at this point in the history
  • Loading branch information
SilviaAmAm committed Dec 12, 2023
1 parent 08f7a1f commit 68cac2c
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/configuration/general/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ General configuration
oidc
cms_integration
virus_scan
payment_flow
20 changes: 20 additions & 0 deletions docs/configuration/general/payment_flow.rst
Original file line number Diff line number Diff line change
@@ -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.
13 changes: 13 additions & 0 deletions docs/manual/forms/basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------------

Expand Down

0 comments on commit 68cac2c

Please sign in to comment.