Skip to content
Webhooks
/
/
TRUSTED_IBAN_CONFIRMED

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_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

The amount of the tax exemption allowance granted for a savings account. This amount will not be taxed.

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.

(Legacy) BUSINESS_DIRECT_DEBIT_PROFILE_BLOCK_CANCELLEDDeprecatedWebhook

Request

A scheduled block on a business' SEPA Direct Debit profile was canceled.

Bodyapplication/json
idstring

ID of the SEPA Direct Debit profile.

Example: "3cab044cedf84443841d489547177469"
statusstring

Indicates whether or not the SEPA Direct Debit profile has been accepted and whether or not it is active.

Enum"ACCEPTED""REJECTED""ACTIVE""BLOCKED""EXPIRED"
Example: "ACCEPTED"
status_reasonsstring

Associated reasoning behind REJECTED and BLOCKED statuses.

collection_limitobject or null(SolarisToolkit.Web.Money.Optional)

The available collection limit for the profile.

application/json
{
  "id": "3cab044cedf84443841d489547177469",
  "status": "ACCEPTED",
  "status_reasons": "string",
  "collection_limit": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  }
}

Responses

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