Skip to content
Webhooks
/
/
CONSUMER_LOAN_APPLICATION

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_FRONTING_APPLICATIONWebhook

Request

The status of a consumer loan application has changed.

Bodyapplication/json
idstringrequired

The unique ID of the fronting loan, generated after a loan is created for the customer.

Example: "620b95f7987243d398c2621c889a2039cflo"
application_idstringrequired

The unique ID of a consumer fronting loan application.

Example: "504f3c3659e14079a6941fe5b7a75eaacfla"
agionumber(float)required

The credit commission amount.

Example: 0
durationintegerrequired

The number of months over which the loan will be repaid.

Example: 12
recipient_ibanstringrequired

The IBAN of the loan's recipient to which the loan will be paid out.

Example: "DE92370601930002130041"
recipient_namestringrequired

The name of the loan recipient.

Example: "Max Mustermann"
requested_interest_ratenumber(float)required

The interest rate to apply to the fronting loan.

Example: 0.04
amountobject(SolarisToolkit.Web.Money)required

The loan amount.

Example: {"value":1000,"unit":"cents","currency":"EUR"}
amount.​valueintegerrequired

The amount value

Example: 1000
amount.​currencystringrequired

The currency of the given value. Only EURO is currently supported.

Example: "EUR"
amount.​unitstringrequired

The unit of the given value.

Value"cents"
Example: "cents"
collateral_account_ibanstringrequired

Your Solaris prefund account from which the full loan amount (agio + net loan amount) must be transferred to Solaris' settlement account.

Example: "DE85110101014480677574"
collection_account_ibanstringrequired

Your account to which the agio is transferred.

Example: "DE87110101001000057123"
settlement_account_ibanstringrequired

The Solaris settlement account from which the loan amount is transferred to the customer's account.

Example: "DE07110101014503906016"
statusstringrequired

The status of the consumer fronting loan.

Enum"payout_issued""payout_pending"
Example: "payout_issued"
application/json
{
  "agio": 0,
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "application_id": "504f3c3659e14079a6941fe5b7a75eaacfla",
  "collateral_account_iban": "DE85110101014480677574",
  "collection_account_iban": "DE87110101001000057123",
  "duration": 12,
  "id": "620b95f7987243d398c2621c889a2039cflo",
  "recipient_iban": "DE92370601930002130041",
  "recipient_name": "Max Mustermann",
  "requested_interest_rate": 0.04,
  "settlement_account_iban": "DE07110101014503906016",
  "status": "payout_issued"
}

Responses

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

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

The daily interest accrued by an person account.

SolarisToolkit.Web.Money (object)

The daily interest accrued by an person account.

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.