Skip to content
Download OpenAPI description
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/onboarding/webhooks/

Operations
Webhooks

Request

A legal representative was linked to, or unlinked from, a business. Solaris will send notifications on this webhook if more legal representatives are discovered during the business identification process.

Bodyapplication/json
idstring

ID of the legal representative relationship.

Example: "a46578f4049f42aba9fe88a2a80fed53"
legal_representative_idstring

ID of the person or business with the legal authority to represent the business.

Example: "33fbdd2c0bb94db1af5b5d2a4426cper"
legal_representative_typestring

The type of legal representative that this record represents.

Enum"Person""Business"
Example: "Person"
valid_untilstring

Date when the legal representative relationship expires.

Example: "2022-12-31"
business_idstring

ID of the business for which the person or business is a legal representative.

Example: "095cc43012a04ccca02f0f93c145cbiz"
application/json
{ "id": "a46578f4049f42aba9fe88a2a80fed53", "legal_representative_id": "33fbdd2c0bb94db1af5b5d2a4426cper", "legal_representative_type": "Person", "valid_until": "2022-12-31", "business_id": "095cc43012a04ccca02f0f93c145cbiz" }

Responses

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

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.

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.