Skip to content
Webhooks
/
/
BATCH_TRANSFER_STATUS_CHA...

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

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.

BATCH_TRANSFER_STATUS_CHANGEDWebhook

Request

When a batch transfer’s status changes to IN_PROGRESS, REJECTED or FINISHED, this webhook will be triggered.

Bodyapplication/json
idstring

Unique ID of the batch transfer.

Example: "f874b3102718a4d757a6b6e4d5996078sctb"
account_idstring

The account ID of the account that the batch transfer is associated with.

Example: "236f9042a19b65c0867e10c922b93502cacc"
statusstring

The status of the batch transfer.

Enum"REJECTED""IN_PROGRESS""FINISHED"
Example: "FINISHED"
transfer_typestring

The type for all transfers of the batch.

Enum"SCT""SCT_INSTANT"
Example: "SCT_INSTANT"
referencestring

A reference for the batch transfer.

Example: "12f7ec0b-6762-4578-b49f-c0b1647d0e2d"
descriptionstring

Optional description for the batch.

Example: "Monthly Salary Payments"
total_amountnumber

The total amount of all planned transfers in the batch in cents.

Example: 1000
transfers_summaryobject

Summary of executed and failed transfer counts within the batch.

created_atstring(date-time)

UTC timestamp when the batch transfer was created.

Example: "2025-04-01T13:59:52+00:00"
started_atstring(date-time)

UTC timestamp when the batch transfer started the processing of all their transfers.

Example: "2025-04-01T14:01:00+00:00"
finished_atstring(date-time)

UTC timestamp when all transfers were processed and the status of the batch reached FINISHED.

Example: "2025-04-01T14:10:30+00:00"
updated_atstring(date-time)

UTC timestamp when the batch transfer was updated the last time.

Example: "2025-04-01T14:10:30+00:00"
application/json
{
  "id": "f874b3102718a4d757a6b6e4d5996078sctb",
  "account_id": "236f9042a19b65c0867e10c922b93502cacc",
  "status": "FINISHED",
  "transfer_type": "SCT_INSTANT",
  "reference": "12f7ec0b-6762-4578-b49f-c0b1647d0e2d",
  "description": "Monthly Salary Payments",
  "total_amount": 1000,
  "transfers_summary": {
    "executed": 9,
    "failed": 1
  },
  "created_at": "2025-04-01T13:59:52+00:00",
  "started_at": "2025-04-01T14:01:00+00:00",
  "finished_at": "2025-04-01T14:10:30+00:00",
  "updated_at": "2025-04-01T14:10:30+00:00"
}

Responses

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

BENEFICIAL_OWNERWebhook

Request

A new beneficial owner was linked to a business, or an existing one was updated. Solaris will send a notification on this webhook if additional beneficial owners are discovered during the business identification process. For more information about beneficial owners, check the business onboarding guide.

Bodyapplication/json
idstring

ID of the beneficial owner relationship.

Example: "a5f454e3f96447d6b3f7ecda46328040"
beneficial_owner_idstring

Person ID of the beneficial owner.

Example: "b9c5661fc7d240b8b51b9059b580cper"
person_idstring

Person ID of the beneficial owner.

Example: "b9c5661fc7d240b8b51b9059b580cper"
valid_untilstring

The date when the beneficial owner relationship expires.

Example: "2022-12-31"
voting_shareinteger

The beneficial owner's voting share. Expressed as a double-digit percentile (e.g., 75% would be expressed as 75).

Example: 75
business_idstring

ID of the business to which the beneficial owner is linked.

Example: "e0277fae750a4c849660da873f94cbiz"
application/json
{
  "id": "a5f454e3f96447d6b3f7ecda46328040",
  "beneficial_owner_id": "b9c5661fc7d240b8b51b9059b580cper",
  "person_id": "b9c5661fc7d240b8b51b9059b580cper",
  "valid_until": "2022-12-31",
  "voting_share": 75,
  "business_id": "e0277fae750a4c849660da873f94cbiz"
}

Responses

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