Skip to content

Webhooks (1.0)

Download OpenAPI description
Languages
Servers
Mock Server
https://docs.solarisgroup.com/_mock/api-reference/onboarding/webhooks

Webhook subscription

Operations

Webhook events

Webhooks

ACCOUNT_SNAPSHOTWebhook

Request

The status of an account snapshot has changed. This webhook is used in the context of different lending products.

Bodyapplication/json
entity_uuidstring

Resource unique ID.

Example: "bc9eee989fb84f3aa8089e244bb8dfc1snap"
event_typestring

Webhook event

Example: "ACCOUNT_SNAPSHOT"
payloadobject(AccountSnapshotWeb.AccountSnapshot.ShowAccountSnapshotResponse)
application/json
{ "entity_uuid": "bc9eee989fb84f3aa8089e244bb8dfc1snap", "event_type": "ACCOUNT_SNAPSHOT", "payload": { "wizard_session_key": "wiz04852083740", "status_description": "string", "status": "available", "provider": "FINREACH", "location": "https://ui.solaris-i.prod.finleap.cloud?token=xxxxxx", "id": "6c8f81a234df4052a9cde197577347b7snap", "iban": "DE87110101001000057123", "account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc" } }

Responses

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

ACTIVATION_CHALLENGE_CREATIONWebhook

Request

This webhook event denotes that a new activation challenge is created. The payload contains the challenge_id which can be used to fetch the actual challenge itself.

Bodyapplication/json
person_idstring

The ID of the person for whom the challenge was created.

Example: "b9c5661fc7d240b8b51b9059b580cper"
challenge_idstring

ID of the challenge that is created.

Example: "a5f454e3f96447d6b3f7ecda46328040"
created_atstring

UTC timestamp when the challenge_id was created.

Example: "2025-02-31T10:55:55Z"
expires_atstring

UTC timestamp when the challenge_id will expire.

Example: "2025-03-31T10:55:55Z"
requested_bystring

The origin of the request that created this challenge. Possible values are - SOLARISBANK, WEBUI, MOBILE_APP, WEB

Example: "SOLARISBANK"
purposestring

The purpose for which the activation code is generataed. Currently it is only - DEVICE_BINDING

Example: "DEVICE_BINDING"
application/json
{ "person_id": "b9c5661fc7d240b8b51b9059b580cper", "challenge_id": "a5f454e3f96447d6b3f7ecda46328040", "created_at": "2025-02-31T10:55:55Z", "expires_at": "2025-03-31T10:55:55Z", "requested_by": "SOLARISBANK", "purpose": "DEVICE_BINDING" }

Responses

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

ACQUIRER_TOPUP_DECLINEDWebhook

Request

A Top-Up transaction was declined by Solaris. The status of the Top Up has changed to DECLINED.

Bodyapplication/json
idstring

The ID of the Top-Up that was declined.

Example: "b76cdcc321d345618084feedc47bbb1d"
account_idstring

ID of the customer account associated with the declined Top-Up transaction.

Example: "adc123a45d6d7cf8fbfeed537ba919d5cacc"
amountobject

The amount of the Top-Up.

client_secretstring

The client secret key provided by the Acquirer's API for use in their frontend SDK.

Example: "pi_1DrPlP2eZvKYlo2CSBQ7uqFH_secret_o1A7UsYFLWeGISUD1QYNkT8IU"
statusstring(TopupStatusValues)

The current status of the Top-Up.

Enum"ACCEPTED""CONFIRMED""EXECUTED""DECLINED""CANCELLED"
decline_reasonstring or null

The reason why the Top-Up was declined. Usually present if the status is DECLINED due to a technical issue.

Example: "Person has blocked account(s)"
application/json
{ "id": "b76cdcc321d345618084feedc47bbb1d", "account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc", "amount": { "value": 10000, "currency": "EUR" }, "client_secret": "pi_1DrPlP2eZvKYlo2CSBQ7uqFH_secret_o1A7UsYFLWeGISUD1QYNkT8IU", "status": "ACCEPTED", "decline_reason": "Person has blocked account(s)" }

Responses

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