Skip to content
Download OpenAPI description
Languages
Servers
Mock Server

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

Operations
Webhooks

Request

The account closure process has completed for a customer's account.

Bodyapplication/json
account_idstring

The ID of customer's account that was closed.

Example: "adc123a45d6d7cf8fbfeed537ba919d5cacc"
person_idstring

The ID of the person resource of the customer whose account was closed.

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
business_idstring

The ID of the business resource of the customer whose account was closed.

Example: "null"
ibanstring

The IBAN of the account that was closed.

Example: "DE87110101001000057123"
application/json
{ "account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc", "person_id": "dc1a6812a14f6cc338cd084208535bcdcper", "business_id": "null", "iban": "DE87110101001000057123" }

Responses

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

Request

Solaris has initiated the account closure process for a customer's account.

Bodyapplication/json
idstring

ID of the account closure request.

Example: "f8d7fbbd587047a0aa449ce69d2d6c08acrq"
closure_reasonstring

The reason for the account closure.

Enum"ACCOUNT_REVOCATION""ACCOUNT_REVOCATION_INTERNAL""COMPLIANCE_IMMEDIATE_INTERNAL""COMPLIANCE_ORDINARY_INTERNAL""CUSTOMER_WISH""CUSTOMER_WISH_INTERNAL""DUNNING_DECOUPLED_CARD_INTERNAL""INSOLVENCY_IMMEDIATE_INTERNAL""INSOLVENCY_ORDINARY_INTERNAL""PARTNER_SERVICE_ACCOUNT_TERMINATED"
Example: "COMPLIANCE_IMMEDIATE_INTERNAL"
statusstring

Status of the account closure request.

Enum"INITIATED""CONFIRMED""IN_PROGRESS""COMPLETED""FAILED""REVOKED"
Example: "IN_PROGRESS"
account_idstring

ID of the account to be closed.

Example: "5526853938474f3e92b22a03ea57a544cacc"
technical_closure_datestring(date)

The date when the account was removed from the Solaris system.

Example: "2021-10-11"
legal_closure_datestring(date)

The date when the contractual relationship underlying the product/account ends.

Example: "2021-10-11"
failure_reasonobject

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

Example: {"code":"negative_balance","detail":"Account balance is negative, can't perform technical closure."}
payout_allowedboolean

payout_allowed is deciding whether the funds can be paid out in the automated process, but it also serves as information for the Partner on whether or not the Customer is allowed to pay out funds from the account.

Enumfalsetrue
updated_atstring(date-time)

Updated date and time

Example: "2021-12-22T15:05:33.634Z"
application/json
{ "id": "f8d7fbbd587047a0aa449ce69d2d6c08acrq", "closure_reason": "COMPLIANCE_IMMEDIATE_INTERNAL", "status": "IN_PROGRESS", "account_id": "5526853938474f3e92b22a03ea57a544cacc", "technical_closure_date": "2021-10-11", "legal_closure_date": "2021-10-11", "failure_reason": { "code": "negative_balance", "detail": "Account balance is negative, can't perform technical closure." }, "payout_allowed": false, "updated_at": "2021-12-22T15:05:33.634Z" }

Responses

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

ACCOUNT_CLOSURE_REQUEST_UPDATEWebhook

Request

This webhook sends notifications about certain status transitions for account closure requests.

Bodyapplication/json
idstring

ID of the account closure request.

Example: "f8d7fbbd587047a0aa449ce69d2d6c08acrq"
closure_reasonstring

The reason for the account closure.

Enum"ACCOUNT_REVOCATION""ACCOUNT_REVOCATION_INTERNAL""COMPLIANCE_IMMEDIATE_INTERNAL""COMPLIANCE_ORDINARY_INTERNAL""CUSTOMER_WISH""CUSTOMER_WISH_INTERNAL""DUNNING_DECOUPLED_CARD_INTERNAL""INSOLVENCY_IMMEDIATE_INTERNAL""INSOLVENCY_ORDINARY_INTERNAL""PARTNER_SERVICE_ACCOUNT_TERMINATED"
Example: "COMPLIANCE_IMMEDIATE_INTERNAL"
statusstring

Status of the account closure request.

Enum"INITIATED""CONFIRMED""IN_PROGRESS""COMPLETED""FAILED""REVOKED"
Example: "IN_PROGRESS"
account_idstring

ID of the account to be closed.

Example: "5526853938474f3e92b22a03ea57a544cacc"
technical_closure_datestring(date)

The date when the account was removed from the Solaris system.

Example: "2021-10-11"
legal_closure_datestring(date)

The date when the contractual relationship underlying the product/account ends.

Example: "2021-10-11"
failure_reasonobject

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

Example: {"code":"negative_balance","detail":"Account balance is negative, can't perform technical closure."}
payout_allowedboolean

payout_allowed is deciding whether the funds can be paid out in the automated process, but it also serves as information for the Partner on whether or not the Customer is allowed to pay out funds from the account.

Enumfalsetrue
updated_atstring(date-time)

Updated date and time

Example: "2021-12-22T15:05:33.634Z"
application/json
{ "id": "f8d7fbbd587047a0aa449ce69d2d6c08acrq", "closure_reason": "COMPLIANCE_IMMEDIATE_INTERNAL", "status": "IN_PROGRESS", "account_id": "5526853938474f3e92b22a03ea57a544cacc", "technical_closure_date": "2021-10-11", "legal_closure_date": "2021-10-11", "failure_reason": { "code": "negative_balance", "detail": "Account balance is negative, can't perform technical closure." }, "payout_allowed": false, "updated_at": "2021-12-22T15:05:33.634Z" }

Responses

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