Zum Inhalt springen
Developer

Self-Service / Donations

CustomerPanel / Self-Service / Spenden

Kundenportal8 EndpunkteCustomerPanel / Self-Service / Donations

Eigene Spenden, wiederkehrende Spenden und die Jahre mit einer Sammelbestätigung

GET/api/cp/self_service/donations

Antworten

200Spenden des angemeldeten Spendersobject

Felder anzeigen (5)
  • donationsarray<object>
  • recurring_donationsarray<object>
  • collective_receipt_yearsarray<object>
  • receipts_availableboolean
  • recurring_optionsobject
Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/cp/self_service/donations \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "donations": [
    {}
  ],
  "recurring_donations": [
    {}
  ],
  "collective_receipt_years": [
    {}
  ],
  "receipts_available": true
}

Zuwendungsbestätigung einer eigenen Spende als PDF

GET/api/cp/self_service/donations/{id}/pdf

Pfad-Parameter

idPflichtstring

Antworten

200Die Quittung als PDF

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

Sammelbestätigung der angemeldeten Person für ein Jahr als PDF

GET/api/cp/self_service/donations/collective_receipt/{year}/pdf

Pfad-Parameter

yearPflichtstring

Antworten

200Die Sammelbestätigung als PDF

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/cp/self_service/donations/collective_receipt/42/pdf \
  --header 'x-iw-jwt-token: <TOKEN>'

Betrag, Intervall oder Bankkonto einer eigenen wiederkehrenden Spende ändern

PUT/api/cp/self_service/recurring_donations/{id}

Ein neues Bankkonto benötigt ein neues SEPA-Mandat: Der Spender stimmt erneut zu, das Mandat erhält eine neue Referenz, und die nächste Lastschrift ist eine Erstlastschrift.

Pfad-Parameter

idPflichtstring

Request-Body application/json

  • amountnumber
  • intervalstring

    monatlich, quartalsweise, halbjährlich oder jährlich

  • accountHolderstring
  • ibanstring
  • bicstring
  • mandateConsentboolean

    bei neuer IBAN erforderlich

Antworten

200Die geänderte wiederkehrende Spende

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/cp/self_service/recurring_donations/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "iban": "DE02120300000000202051",
  "bic": "BYLADEM1001",
  "amount": 49.9,
  "interval": "string",
  "accountHolder": "string",
  "mandateConsent": true
}
'

Betrag, Intervall oder Bankkonto einer eigenen wiederkehrenden Spende ändern

PATCH/api/cp/self_service/recurring_donations/{id}

Ein neues Bankkonto benötigt ein neues SEPA-Mandat: Der Spender stimmt erneut zu, das Mandat erhält eine neue Referenz, und die nächste Lastschrift ist eine Erstlastschrift.

Pfad-Parameter

idPflichtstring

Request-Body application/json

  • amountnumber
  • intervalstring

    monatlich, quartalsweise, halbjährlich oder jährlich

  • accountHolderstring
  • ibanstring
  • bicstring
  • mandateConsentboolean

    bei neuer IBAN erforderlich

Antworten

200Die geänderte wiederkehrende Spende

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/cp/self_service/recurring_donations/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "iban": "DE02120300000000202051",
  "bic": "BYLADEM1001",
  "amount": 49.9,
  "interval": "string",
  "accountHolder": "string",
  "mandateConsent": true
}
'

Eigene wiederkehrende Spende pausieren; noch nicht an die Bank übergebene Einzüge werden gestoppt

POST/api/cp/self_service/recurring_donations/{id}/pause

Pfad-Parameter

idPflichtstring

Antworten

200Die pausierte wiederkehrende Spende

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/cp/self_service/recurring_donations/42/pause \
  --header 'x-iw-jwt-token: <TOKEN>'

Eine eigene pausierte wiederkehrende Spende fortsetzen; der nächste Einzug liegt nie in der Vergangenheit.

POST/api/cp/self_service/recurring_donations/{id}/resume

Pfad-Parameter

idPflichtstring

Antworten

200Die laufende wiederkehrende Spende

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/cp/self_service/recurring_donations/42/resume \
  --header 'x-iw-jwt-token: <TOKEN>'

Eine eigene wiederkehrende Spende stornieren

POST/api/cp/self_service/recurring_donations/{id}/cancel

Pfad-Parameter

idPflichtstring

Antworten

200Die stornierte wiederkehrende Spende

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/cp/self_service/recurring_donations/42/cancel \
  --header 'x-iw-jwt-token: <TOKEN>'