Skip to content
Webhooks
/
/
ACCOUNT_LIMIT_CHANGE

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

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.

ACCOUNT_LIMIT_CHANGEWebhook

Request

The limit on a customer's account has changed. This webhook is used in the context of the Decoupled Cards product.

Bodyapplication/json
account_idstring

The ID of customer's account whose limit changed.

Example: "adc123a45d6d7cf8fbfeed537ba919d5cacc"
application/json
{
  "account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc"
}

Responses

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

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

The status of the account opening request.

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.