Skip to content
Webhooks
/
/
CONSUMER_OVERDRAFT

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_LOAN_APPLICATIONWebhook

Request

The status of a consumer loan application has changed.

Bodyapplication/json
entity_uuidstring

Resource unique ID.

Example: "c5fe9ff6a90f47708e2d865d553c24f2clap"
event_typestring

Webhook event

Example: "CONSUMER_LOAN_APPLICATION"
payloadobject(ConsumerLoan.GetApplicationResponse)
application/json
{
  "entity_uuid": "c5fe9ff6a90f47708e2d865d553c24f2clap",
  "event_type": "CONSUMER_LOAN_APPLICATION",
  "payload": {
    "status_description": "string",
    "status": "esign_pending",
    "skip_account_snapshot": true,
    "signing_id": "7c63600ddddec4f2668893af39c1b814csig",
    "seller": "string",
    "payout_description": "string",
    "loan_id": "string",
    "id": "108787ede6b743dcbe0c3398bc4a6ce8clap",
    "financed_good": "string",
    "delayed_payout_strategy": "none",
    "cash_price": { … },
    "approximate_total_loan_expenses": { … }
  }
}

Responses

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

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.