Skip to content
Webhooks
/
/
MESSAGE

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

LOANWebhook

Request

The status of a customer's loan has changed. Please note that webhook payload is returned as a JSON-encoded string.

Bodyapplication/json
payloadobject

An object containing the webhook payload.

event_typestring

The webhook event name.

Example: "LOAN"
entity_uuidstring

The resource ID of the loan.

Example: "82d78c39956645ffbd59c51cdb63f7b0cloa"
application/json
{
  "payload": {
    "total_loan_expenses": { … },
    "term": 24,
    "status_reason": "upfront_subsidy_pull_failed_collateral_account_not_set",
    "status": "payout_issued",
    "repayment_plan_updated_at": "2021-04-16T13:52:05Z",
    "repayment_plan_created_at": "2020-04-16T13:52:05Z",
    "repayment_begin_date": "2020-05-16",
    "reference": "string",
    "recipient_iban": "DE88888881010987654321",
    "purpose": "Buying a car.",
    "person_id": "547a870b2c8461a3104559369d09265dcper",
    "payout_date": "2020-05-16",
    "overdue_amount": { … },
    "monthly_payment": { … },
    "maturity_date": "2022-05-16",
    "loan_account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc",
    "loan_account_iban": "DE72110101014351836685",
    "interest_start_date": "2021-06-16",
    "interest_rate": 0.0499,
    "id": "c13447d659db4cdcb450b977f8f25c57cloa",
    "effective_interest_rate": 0.0511,
    "created_at": "2021-06-16T10:22:38",
    "billing_account_id": "1d0e52af0a62b4b44d8c54a87a7fc6a7cacc",
    "billing_account_iban": "DE72110101014351836685",
    "annual_percentage_rate": 0,
    "amount": { … }
  },
  "event_type": "LOAN",
  "entity_uuid": "82d78c39956645ffbd59c51cdb63f7b0cloa"
}

Responses

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

MESSAGEWebhook

Request

The message to a customer

Bodyapplication/json
account_idstring

ID of the account for which the message is being sent.

Example: "c2a13abed3b0686ab5343aa748d7f2fecacc"
channelstring

The notification channel used to send the message.

Enum"any""email"
Example: "email"
person_idstring

ID of the person associated to whom the message is being sent.

Example: "0ba2211cab11af6094d60ead81f2bd9dcper"
titlestring

The title of the message.

Example: "Ihre Samsung Pay Bezahlung"
textstring

The text of the message.

business_idstring

ID of the business to whom the message is being sent.

Example: "567eaf2b22fce21a1920e14e11e2bfa3cbiz"
application/json
{
  "account_id": "c2a13abed3b0686ab5343aa748d7f2fecacc",
  "channel": "email",
  "person_id": "0ba2211cab11af6094d60ead81f2bd9dcper",
  "title": "Ihre Samsung Pay Bezahlung",
  "text": "string",
  "business_id": "567eaf2b22fce21a1920e14e11e2bfa3cbiz"
}

Responses

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

OVERDRAFTWebhook

Request

The status of a freelancer overdraft has changed.

Bodyapplication/json
idstringrequired

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

Example: "00556cd181f2409aaa6c2a033cce3a8fcovd"
person_idstringrequired

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

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
statusstringrequired

The status of an overdraft offered to a freelancer.

Enum"created""interest_conditions_set""limit_set""terminated"
Example: "created"
created_atstring(datetime)required

The date and time the overdraft was created.

Example: "2021-08-03T18:01:48.000Z"
interest_accruedSolarisToolkit.Web.Money (object)required

The daily interest accrued by a freelancer account.

SolarisToolkit.Web.Money (object)

The daily interest accrued by a freelancer account.

overdraft_ratenumber

The interest rate applicable to the overdraft.

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

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

Example: 3
account_idstring or null

The unique ID of a customer's bank account.

Example: "575189c6eb825b10b9d0392fcb3bf61dcacc"
application/json
{
  "status": "created",
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "overdraft_rate": 9,
  "limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "interest_conditions_enabled": true,
  "interest_accrued": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "interest_accrual_rate": 3,
  "id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  "created_at": "2021-08-03T18:01:48.000Z",
  "account_id": "575189c6eb825b10b9d0392fcb3bf61dcacc"
}

Responses

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