Skip to content

Webhooks (1.0)

Download OpenAPI description
Languages
Servers
Mock Server
https://docs.solarisgroup.com/_mock/api-reference/onboarding/webhooks/

Webhook subscription

Operations

Webhook events

Webhooks

CONSUMER_OVERDRAFT_INTEREST_RATE_CHANGEWebhook

Request

The overdraft's interest_accrual_rate has been recalculated and updated due to a reference rate change.

Bodyapplication/json
idstringrequired

The ID of the overdraft.

interest_accrual_ratenumber(float)required

The new daily rate at which interest is accrued on the used amount of the overdraft.

effective_fromstring(date-time)required

The date and time in which the new interest accrual rate becomes effective.

application/json
{ "id": "string", "interest_accrual_rate": 0.1, "effective_from": "2019-08-24T14:15:22Z" }

Responses

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

CREDIT_CARD_APPLICATIONWebhook

Request

The status of a credit card application has changed.

Bodyapplication/json
idstring

The ID of the credit card application.

Example: "6e6fefdcd553468fb04555499f060b18ccla"
external_customer_idstring

Arbitrary ID provided by you (e.g., membership ID).

customer_idstring

ID of the person who applied for the credit card.

Example: "0ba2211cab11af6094d60ead81f2bd9dcper"
account_idstring

ID of the Solaris account associated with the credit card.

Example: "c2a13abed3b0686ab5343aa748d7f2fecacc"
account_ibanstring

IBAN of the Solaris account associated with the credit card.

Example: "DE53110101013323159108"
reference_account_idstring

ID of the reference account associated with the credit card.

Example: "d1ed02309ca52b5e636e215ff82b2d52sddm"
statusstring

The current status of the credit card.

Enum"PENDING""IN_SCORING""PRE_APPROVED""FINALIZING""FINALIZED""DECLINED""TERMINATED""WAITING_FOR_IDENTIFICATION""IN_KNE_SCORING"
Example: "PENDING"
product_typestring

Indicates the type of credit card.

Enum"CONSUMER_CREDIT_CARD""FREELANCER_CREDIT_CARD""BUSINESS_CREDIT_CARD"
Example: "CONSUMER_CREDIT_CARD"
billing_start_datestring(date)

The start date of the current billing cycle.

Example: "2022-07-01"
billing_end_datestring(date)

The end date of the current billing cycle.

Example: "2022-07-28"
approved_limitobject
Example: {"value":20000,"unit":"cents","currency":"EUR"}
requested_limitobject
Example: {"value":50000,"unit":"cents","currency":"EUR"}
current_limitobject
Example: {"value":15000,"unit":"cents","currency":"EUR"}
decline_reasonsArray of strings

An array of reasons why the credit card application was declined.

Items Value"DECLINED_BY_SCORING"
repayment_optionsobject
scoring_optionsconsumer_scoring_options (object) or business_scoring_options (object)
One of:

Object containing information about the scoring for the credit card application.

in_dunningboolean

Boolean value to indicate whether the credit card is currently subject to the dunning process.

created_atstring

The date & time when the credit card application was created.

Example: "2023-07-26T11:59:52+00:00"
qes_atstring(date)

The date of QES completion.

Example: "2022-07-28"
active_termination_idstring

ID of the termination of the credit card application.

Example: "c7184779-3a57-5c8c-8ef4-c3aec9528531"
repayment_type_switch_available_datestring(date)

The date when switch to another repayment type is possible.

Example: "2022-07-28"
application/json
{ "id": "6e6fefdcd553468fb04555499f060b18ccla", "external_customer_id": "string", "customer_id": "0ba2211cab11af6094d60ead81f2bd9dcper", "account_id": "c2a13abed3b0686ab5343aa748d7f2fecacc", "account_iban": "DE53110101013323159108", "reference_account_id": "d1ed02309ca52b5e636e215ff82b2d52sddm", "status": "PENDING", "product_type": "CONSUMER_CREDIT_CARD", "billing_start_date": "2022-07-01", "billing_end_date": "2022-07-28", "approved_limit": { "value": 20000, "unit": "cents", "currency": "EUR" }, "requested_limit": { "value": 50000, "unit": "cents", "currency": "EUR" }, "current_limit": { "value": 15000, "unit": "cents", "currency": "EUR" }, "decline_reasons": [ "DECLINED_BY_SCORING" ], "repayment_options": { "upcoming_type": "PARTIAL", "minimum_amount": {}, "minimum_percentage": 2, "current_type": "PARTIAL", "upcoming_billing_cycle": "MONTHLY", "current_billing_cycle": "MONTHLY", "grace_period_in_days": 15, "minimum_amount_lower_threshold": {}, "minimum_amount_upper_threshold": {}, "minimum_percentage_lower_threshold": 3, "minimum_percentage_upper_threshold": 20 }, "scoring_options": { "customer_desired_limit": {}, "number_of_dependents": 1, "marital_status": "MARRIED", "living_situation": "LIVING_WITH_PARENTS", "living_situation_expenses": {}, "net_income": {}, "credit_repayment_excluding_mortgage": {}, "other_credit_card_limit": {}, "employment_since": "2019-08-24", "annual_turnover": {}, "monthly_business_costs": {}, "total_clients_12_months": 10, "has_credit_card": true, "reference_account_created_year": "2019", "member_since": "2019-08-24", "provision_code": "string", "reference_account_iban": "string" }, "in_dunning": true, "created_at": "2023-07-26T11:59:52+00:00", "qes_at": "2022-07-28", "active_termination_id": "c7184779-3a57-5c8c-8ef4-c3aec9528531", "repayment_type_switch_available_date": "2022-07-28" }

Responses

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

CREDIT_CARD_APPLICATION_TERMINATIONWebhook

Request

A credit card termination was created by Solaris for one of your customers' credit cards, or the status of an open termination has changed.

Bodyapplication/json
idstring

The ID of the credit card termination.

Example: "c7184779-3a57-5c8c-8ef4-c3aec9528531"
application_idstring

The ID of the credit card application that is being terminated.

Example: "a8cafe0c24e949c78bfbea04cb5b2905ccla"
reasonstring

The reason for the termination.

Enum"CUSTOMER_WISH""OTHER_IMMEDIATE""OTHER_ORDINARY"
Example: "CUSTOMER_WISH"
statusstring

The current status of the termination.

Enum"INITIATED""IN_PROGRESS""COMPLETED""REVOKED"
Example: "IN_PROGRESS"
legally_terminated_atstring(date)

The date when the credit card termination will take effect.

Example: "2023-08-31"
revocable_untilstring(date)

The date until which the termination can be revoked.

Example: "2023-08-02"
created_atstring(date-time)

UTC timestamp from when the termination was created.

Example: "2023-07-28T14:47:00.000Z"
application/json
{ "id": "c7184779-3a57-5c8c-8ef4-c3aec9528531", "application_id": "a8cafe0c24e949c78bfbea04cb5b2905ccla", "reason": "CUSTOMER_WISH", "status": "IN_PROGRESS", "legally_terminated_at": "2023-08-31", "revocable_until": "2023-08-02", "created_at": "2023-07-28T14:47:00.000Z" }

Responses

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