Skip to content
Webhooks
/
/
TAX_EXEMPTION_UTILIZATION

Webhooks (1.0)

Download OpenAPI description
webhooks.json
webhooks.yaml
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/onboarding/webhooks/

Webhook subscription

Operations

Webhook events

Webhooks

TAX_EXEMPTION_UPDATEDWebhook

Request

The status of a tax exemption request has changed.

Bodyapplication/json
idstring

ID of the tax exemption request.

Example: "93bc0b9d-3321-4bac-84ce-1b300a137d7e"
deposit_typestring(DepositTypes)

The account type.

Value"SAVINGS_ACCOUNT"
deposit_account_idstring

ID of the savings account.

Example: "e48c29b85992b8772eb7ddd518490920cacc"
main_account_idstring

ID of the internal main account.
main_account_id is conditionally required when main_account_iban is null or empty.

Example: "148c29b85992b8772eb7ddd518490110cacc"
main_account_ibanstring

IBAN of the external main account.
main_account_iban is conditionally required when main_account_id is null or empty.

Example: "DE17110101000000000042"
exemption_typestring

Indicates the exemption request type.

Enum"CREATE""UPDATE""CLOSE""DELETE"
statusstring(TaxExemptionStatus)

The current status of the tax exemption order.

Enum"OPENED""SUCCESS""FAILED"
failure_reasonstring or null(TaxExemptionfailureReason)

In case the tax exemption request failed, this field will contain the reason.
Note that the tax exemption request failed if any of the following criteria are met:

  • Invalid processing year
  • Invalid Amount: Exemption amount submitted higher than maximum permissible value
  • Invalid amount: Exemption amount submitted smaller than utilization already completed
  • The date on which the tax benefit was withdrawn (renounceDate) is invalid
  • Date on which tax concession is legally terminated is invalid
  • Valid_from_date of the tax concession is invalid
  • The validity period of the NV certificate is invalid - longer than 3 years
  • Invalid serial number
  • Technical Error
  • Invalid period: Invalid valid_to date
  • Invalid period: the valid_from date is greater than the valid_to date.
  • Invalid action: Cannot change termination date
  • Invalid amount: The submitted amount must not be negative
  • Invalid amount: Amount submitted must be > 0
  • The current tax status cannot be changed due to existing tax transactions
  • Invalid new TaxStatus
  • Invalid action
  • Invalid Customer
  • Internal Error

amountobject
valid_from_yearstring

Year from which the tax exemption order takes effect.

Example: "2023"
valid_to_yearstring

Year until which the tax exemption order applies.

Example: "2025"
updated_atstring

UTC timestamp from when the savings account mapping was executed.

Example: "2024-04-06T09:03:05.321+00:00"
application/json
{
  "id": "93bc0b9d-3321-4bac-84ce-1b300a137d7e",
  "deposit_type": "SAVINGS_ACCOUNT",
  "deposit_account_id": "e48c29b85992b8772eb7ddd518490920cacc",
  "main_account_id": "148c29b85992b8772eb7ddd518490110cacc",
  "main_account_iban": "DE17110101000000000042",
  "exemption_type": "CREATE",
  "status": "OPENED",
  "failure_reason": "string",
  "amount": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  },
  "valid_from_year": "2023",
  "valid_to_year": "2025",
  "updated_at": "2024-04-06T09:03:05.321+00:00"
}

Responses

Return 200 to indicate that you successfully received the webhook notification.

TAX_EXEMPTION_UTILIZATIONWebhook

Request

The utilization details of the tax exemption allowance granted for a savings account.

Bodyapplication/json
idstring

ID of the tax exemption request.

Example: "93bc0b9d-3321-4bac-84ce-1b300a137d7e"
deposit_typestring

The account type.

Value"SAVINGS_ACCOUNT"
deposit_account_idstring

ID of the savings account.

Example: "e48c29b85992b8772eb7ddd518490920cacc"
main_account_idstring

ID of the main account.

Example: "148c29b85992b8772eb7ddd518490110cacc"
request_statusstring

The current status of the request.

Enum"OPENED""SUCCESS""FAILED"
Example: "SUCCESS"
failure_reasonstring or null

In case the tax exemption request failed, this field will contain the reason.

Example: ""
tax_allowance_amountobject
tax_allowance_used_amountobject

The used balance from the tax exemption allowance.

tax_allowance_remaining_amountobject

The remaining balance from the tax exemption allowance to be utilized.

tax_exemption_statusstring

The current status of the tax exemption order.

Enum"ACTIVE""INACTIVE""DELETED""EXPIRED""INVALID"
Example: "ACTIVE"
valid_from_yearstring

Year from which the tax exemption order takes effect.

Example: "2023"
valid_to_yearstring

Year until which the tax exemption order applies.

Example: "2025"
updated_atstring

UTC timestamp from when the savings account mapping was executed.

Example: "2024-04-06T09:03:05.321+00:00"
application/json
{
  "id": "93bc0b9d-3321-4bac-84ce-1b300a137d7e",
  "deposit_type": "SAVINGS_ACCOUNT",
  "deposit_account_id": "e48c29b85992b8772eb7ddd518490920cacc",
  "main_account_id": "148c29b85992b8772eb7ddd518490110cacc",
  "request_status": "SUCCESS",
  "failure_reason": "",
  "tax_allowance_amount": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  },
  "tax_allowance_used_amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "tax_allowance_remaining_amount": {
    "value": 4000,
    "unit": "cents",
    "currency": "EUR"
  },
  "tax_exemption_status": "ACTIVE",
  "valid_from_year": "2023",
  "valid_to_year": "2025",
  "updated_at": "2024-04-06T09:03:05.321+00:00"
}

Responses

Return 200 to indicate that you successfully received the webhook notification.

TRUSTED_IBAN_CONFIRMEDWebhook

Request

This webhook is triggered when a trusted IBAN is confirmed. The webhook contains information about the IBAN that was trusted and who approved the action.

Bodyapplication/json
idstring

The unique identifier of the trusted IBAN. This ID is used to reference the trusted IBAN in other API calls.

Example: "60d277e8-36dc-4ecb-8842-6b61977cba52"
ibanstring

The International Bank Account Number (IBAN) that has been trusted. This is the account number that will be used for transactions.

Example: "DE89370400440532013000"
account_idstring

The unique identifier of the account associated with the trusted IBAN. This ID is used to reference the account in other API calls.

Example: "46b3938833cbad04c394e5a08da9ec58cacc"
approved_bystring

The unique identifier of the person who approved the trusted IBAN.

Example: "fa74fe785db7e128ddfcc1eec18fbb6ccper"
application/json
{
  "id": "60d277e8-36dc-4ecb-8842-6b61977cba52",
  "iban": "DE89370400440532013000",
  "account_id": "46b3938833cbad04c394e5a08da9ec58cacc",
  "approved_by": "fa74fe785db7e128ddfcc1eec18fbb6ccper"
}

Responses

Return 200 to indicate that you successfully received the webhook notification.