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_OPENING_REQUESTWebhook

Request

An account opening request has been either accepted or rejected.

Bodyapplication/json
account_opening_request_idstring

The ID of the account opening request.

Example: "f8d7fbbd587047a0aa449ce69d2d6c08aorq"
customer_idstring

The ID (i.e., person_id or business_id) of the customer for whom you're opening the account.

Example: "b109ee6f66d2a061e006bd31c6455df2cper"
statusstring
Enum"INITIATED""IN_PROGRESS""COMPLETED""REJECTED"
Example: "COMPLETED"
account_idstring

The ID of the account that was created for the customer.

Example: "c5a0e32369e9372e0fdf490294cecd8dcacc"
updated_atstring(date-time)

The timestamp (date-time) when the AOR was last updated.

Example: "2021-12-22T15:05:33.634+00:00"
errorobject or null

An object containing information about the reason why an account opening request has failed.

Example: {"code":"green_person_vetting","detail":"CustomerVettingStatus for person has to be 'green' to open an account."}
application/json
{ "account_opening_request_id": "f8d7fbbd587047a0aa449ce69d2d6c08aorq", "customer_id": "b109ee6f66d2a061e006bd31c6455df2cper", "status": "COMPLETED", "account_id": "c5a0e32369e9372e0fdf490294cecd8dcacc", "updated_at": "2021-12-22T15:05:33.634+00:00", "error": { "code": "green_person_vetting", "detail": "CustomerVettingStatus for person has to be 'green' to open an account." } }

Responses

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

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.

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
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.