Skip to content
Developer

Self-Service / Donations

Customer portal8 EndpointsCustomerPanel / Self-Service / Donations

Own donations, recurring donations and the years with a Sammelbestätigung

GET/api/cp/self_service/donations

Responses

200Donations of the logged-in donorobject

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

Zuwendungsbestätigung of an own donation as PDF

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

Path parameters

idrequiredstring

Responses

200The receipt as PDF

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

Sammelbestätigung of the logged-in person for a year as PDF

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

Path parameters

yearrequiredstring

Responses

200The Sammelbestätigung as PDF

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

Change amount, interval or bank account of an own recurring donation

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

A new bank account needs a new SEPA mandate: the donor agrees again, the mandate gets a new reference and the next collection is a first collection.

Path parameters

idrequiredstring

Request body application/json

  • amountnumber
  • intervalstring

    monthly, quarterly, half_yearly or yearly

  • accountHolderstring
  • ibanstring
  • bicstring
  • mandateConsentboolean

    required with a new IBAN

Responses

200The changed recurring donation

Request
curl --request PUT \
  --url https://your-instance.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
}
'

Change amount, interval or bank account of an own recurring donation

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

A new bank account needs a new SEPA mandate: the donor agrees again, the mandate gets a new reference and the next collection is a first collection.

Path parameters

idrequiredstring

Request body application/json

  • amountnumber
  • intervalstring

    monthly, quarterly, half_yearly or yearly

  • accountHolderstring
  • ibanstring
  • bicstring
  • mandateConsentboolean

    required with a new IBAN

Responses

200The changed recurring donation

Request
curl --request PATCH \
  --url https://your-instance.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
}
'

Pause an own recurring donation; collections not yet handed to the bank are stopped

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

Path parameters

idrequiredstring

Responses

200The paused recurring donation

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

Resume an own paused recurring donation; the next collection is never in the past

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

Path parameters

idrequiredstring

Responses

200The running recurring donation

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

Cancel an own recurring donation

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

Path parameters

idrequiredstring

Responses

200The canceled recurring donation

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