Skip to content
Webhooks
/
/
CONSUMER_OVERDRAFT_APPLIC...

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

CONSUMER_OVERDRAFTWebhook

Request

The status of a consumer overdraft has changed.

Bodyapplication/json
idstringrequired

The unique ID of a consumer overdraft, generated after an overdraft is offered.

Example: "00556cd181f2409aaa6c2a033cce3a8fcovd"
person_idstringrequired

The unique person ID, generated after completing the person onboarding process.

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
consumer_application_idstringrequired

The unique ID of a consumer overdraft application.

Example: "b83z264de98741018419b53648e20ca9coap"
account_ibanstringrequired

The IBAN of a person account.

Example: "DE87110101001000057123"
statusstringrequired

The status of an overdraft offered to a consumer.

Enum"created""conditions_pending""limit_pending""attached""defaulted_pending""conditions_termination_pending""termination_pending""terminated"
Example: "created"
interest_accrual_ratenumber(float)required

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

Example: 3
overdraft_ratenumber(float)required

The interest rate applicable to the overdraft.

Example: 9
created_atstring(datetime)required

The date and time the overdraft was created.

Example: "2021-08-03T18:01:48.000Z"
negative_sincestring or null(datetime)required

The date and time when overdraft went negative.

Example: "2021-08-03T18:01:48Z"
interest_accruedSolarisToolkit.Web.Money (object)required
SolarisToolkit.Web.Money (object)
limitobject or null(SolarisToolkit.Web.Money.Optional)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
application/json
{
  "status": "created",
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "overdraft_rate": 9,
  "negative_since": "2021-08-03T18:01:48Z",
  "limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "interest_accrued": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "interest_accrual_rate": 3,
  "id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  "created_at": "2021-08-03T18:01:48.000Z",
  "consumer_application_id": "b83z264de98741018419b53648e20ca9coap",
  "account_iban": "DE87110101001000057123"
}

Responses

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

CONSUMER_OVERDRAFT_APPLICATIONWebhook

Request

The status of a consumer overdraft application has changed.

Bodyapplication/json
idstringrequired

The unique ID of a consumer overdraft application.

Example: "b83z264de98741018419b53648e20ca9coap"
partner_idstringrequired

The unique partner ID, generated after creating a partner.

Example: "6ee8e4c8bdc2f9b15870c989706aa9cccpar"
person_idstringrequired

The unique person ID, generated after completing the person onboarding process.

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
identification_idstringrequired

The unique identification ID of a person, generated after completing the person identification process.

Example: "176a96d1ecf7459d659d1b7f0108a3f2cidt"
account_ibanstringrequired

The IBAN of a person account.

Example: "DE87110101001000057123"
statusstringrequired

The status of a consumer overdraft application.

Enum"scoring_pending""offered""overdraft_created""rejected""deleted"
Example: "offered"
created_atstring(datetime)required

The date and time the consumer overdraft application was created.

Example: "2021-08-03T18:01:48.000Z"
status_descriptionstring or null

The description of the consumer overdraft application status.

Example: "The overdraft is approved and offered to the customer."
partner_risk_classstring or null

The risk class assigned to a customer by the partner.

Example: "d"
partner_requested_limitobject or null(SolarisToolkit.Web.Money.Optional)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
partner_reference_numberstring or null

The partner's reference number.

Example: "a123456"
partner_contact_numberstring or null

The number of the partner's contact person.

Example: "+491565904345"
partner_contact_namestring or null

The name of the partner's contact person.

Example: "Peter Mustermann"
overdraft_idstring or null

The unique ID of a consumer overdraft, generated after an overdraft is offered.

Example: "00556cd181f2409aaa6c2a033cce3a8fcovd"
net_income_amountobject(SolarisToolkit.Web.Money)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
minimum_credit_risk_criteriaobject or null

Minimum credit risk criteria fields for scorer

limitobject or null(SolarisToolkit.Web.Money.Optional)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
interest_accrual_ratenumber or null(float)

Scorer rate for risk based pricing

employment_statusstring or null

The consumer's employment status, mentioned in the signed self-declaration form.

Enum"EMPLOYED""UNEMPLOYED""PUBLIC_SECTOR_EMPLOYEE""PROFESSIONAL_SOLDIER""FREELANCER""HOUSEWORK""APPRENTICE""MANAGEMENT""RETIRED""STUDENT"
Example: "EMPLOYED"
credit_record_idstring or null

The unique ID of a credit record, generated after creating a consumer credit record.

Example: "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
application/json
{
  "status_description": "The overdraft is approved and offered to the customer.",
  "status": "offered",
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "partner_risk_class": "d",
  "partner_requested_limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "partner_reference_number": "a123456",
  "partner_id": "6ee8e4c8bdc2f9b15870c989706aa9cccpar",
  "partner_contact_number": "+491565904345",
  "partner_contact_name": "Peter Mustermann",
  "overdraft_id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  "net_income_amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "minimum_credit_risk_criteria": {},
  "limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "interest_accrual_rate": 0.1,
  "identification_id": "176a96d1ecf7459d659d1b7f0108a3f2cidt",
  "id": "b83z264de98741018419b53648e20ca9coap",
  "employment_status": "EMPLOYED",
  "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  "created_at": "2021-08-03T18:01:48.000Z",
  "account_iban": "DE87110101001000057123"
}

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.