Zum Inhalt springen
Developer

DonationExternal

Abrechnung9 EndpunkteBilling / DonationExternal

Verfügbare Spendenbeträge und Funktionsstatus abrufen

GET/api/invoice/external/donation/amounts

Antworten

200Liefert die verfügbaren Spendenbeträge.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/invoice/external/donation/amounts \
  --header 'x-iw-jwt-token: <TOKEN>'

Eine Spende mit Zahlung einleiten

POST/api/invoice/external/donation/initiate

Antworten

200Erstellt eine Spende und liefert die Weiterleitungs-URL zur Zahlung zurück

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/invoice/external/donation/initiate \
  --header 'x-iw-jwt-token: <TOKEN>'

Rückruf-Benachrichtigung des Zahlungsanbieters

GET/api/invoice/external/donation/notify/{token}/{paymentProvider}

Pfad-Parameter

tokenPflichtstring
paymentProviderPflichtstring

Antworten

200Verarbeitet Zahlungsbenachrichtigung

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/invoice/external/donation/notify/42/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

Rückruf-Benachrichtigung des Zahlungsanbieters

POST/api/invoice/external/donation/notify/{token}/{paymentProvider}

Pfad-Parameter

tokenPflichtstring
paymentProviderPflichtstring

Antworten

200Verarbeitet Zahlungsbenachrichtigung

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/invoice/external/donation/notify/42/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

Spendenbescheinigung als PDF per Token herunterladen

GET/api/invoice/external/donation/pdf/{id}/{token}

Pfad-Parameter

idPflichtstring
tokenPflichtstring

Antworten

200Liefert die Spendenbescheinigung als PDF

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/invoice/external/donation/pdf/42/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

Eine wiederkehrende Spende einleiten, die per SEPA-Lastschrift eingezogen wird.

POST/api/invoice/external/donation/recurring/initiate

Antworten

200Erstellt eine wiederkehrende Spende mit SEPA-Mandat

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/invoice/external/donation/recurring/initiate \
  --header 'x-iw-jwt-token: <TOKEN>'

Dauerspenden-Status per Token abrufen

GET/api/invoice/external/donation/recurring/{token}

Pfad-Parameter

tokenPflichtstring

Antworten

200Liefert den Status der Dauerspende

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/invoice/external/donation/recurring/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

Eine wiederkehrende Spende per Token stornieren

POST/api/invoice/external/donation/recurring/{token}/cancel

Pfad-Parameter

tokenPflichtstring

Antworten

200Storniert eine wiederkehrende Spende

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/invoice/external/donation/recurring/42/cancel \
  --header 'x-iw-jwt-token: <TOKEN>'

Spendenstatus per Token abrufen

GET/api/invoice/external/donation/{token}

Pfad-Parameter

tokenPflichtstring

Antworten

200Liefert den Spendenstatus

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/invoice/external/donation/42 \
  --header 'x-iw-jwt-token: <TOKEN>'