Skip to content
Webhooks
/
/
BOOKING

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

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.

BOOKINGWebhook

Request

A booking was created on the account specified in the webhook payload. For more information about bookings, check the account management guide.

Bodyapplication/json
idstring

ID of the booking.

Example: "fe6561bdb526ed8866e9dac00bd1848ecboo"
creation_datestring

The date when the booking was created. Do not expose this to the account holder(s).

Example: "2022-01-18"
valuta_datestring

The valuta date of the booking (i.e., the date when the booking becomes effective).

Example: "2022-01-18"
booking_datestring

The date when the booking was posted.

Example: "2022-01-18"
booking_typestring(Solaris-Enums-BookingType)

The type of the booking. See the booking documentation for a list of explanations for each booking type.

Enum"CANCELLATION_BOOKING""CancellationCardTransaction""CANCELLATION_CARD_TRANSACTION_DIRECT""CANCELLATION_CHARGE_CARD""CANCELLATION_CHARGE_DUNNING""CANCELLATION_CHARGE_SEPA_DIRECT_DEBIT_RETURN""CANCELLATION_CRYPTO_EXCHANGE""CANCELLATION_CURRENCY_EXCHANGE_PARTNER""CANCELLATION_DIRECT_DEBIT""CANCELLATION_DOUBLE_BOOKING"
Example: "SEPA_CREDIT_TRANSFER"
amountobject

The amount of the booking.

Example: {"value":-160,"unit":"cents","currency":"EUR"}
descriptionstring

A description of the booking.

Example: "BERLINER VOLKSBANK EG, TXL ABFLUG"
purpose_codestring

The purpose code of the booking.

Example: "null"
recipient_bicstring

The recipient's BIC.

Example: "SOBKDEBBXXX"
recipient_ibanstring

The recipient's IBAN.

Example: "DE97110101002242911754"
recipient_namestring

The recipient's full name.

Example: "SURIA LUIS VENTURA VIERA PEREIRA RIBEIRO"
receiver_iban_virtualstring

(If applicable) The receiver's virtual IBAN.

sender_bicstring

The sender's BIC.

Example: "SOBKDEBBXXX"
sender_ibanstring

The sender's IBAN.

Example: "DE95110101000018501020"
sender_namestring

The sender's full name.

Example: "HANS MUSTERMANN"
end_to_end_idstring

SEPA identifier provided by the customer who initiated the SEPA transaction, routed through the entire payment process.

Example: "END2ENDREJ"
creditor_identifierstring

Unique reference that identifies a party collecting payments under the SEPA Direct Debit scheme within and across 32 countries. See the Deutsche Bundesbank's definition of creditor identifier for more information.

Example: "DE98ZZZ09999999999"
mandate_referencestring

The reference of the SDD mandate.

Example: "00000000000001"
transaction_idstring

The Solaris transaction ID.

Example: "d651ee23300b4e7c8fe7b7e2b2e96trx"
return_transaction_idstring

(If applicable) The Solaris ID of the return transaction.

Example: "758ea4a268974284ae7af17871f3fdc4"
sepa_chargesobject

(If applicable) Object containing information about the SEPA Direct Debit return transaction charges.

sepa_return_codestring or null

(If applicable) The SEPA reason code for the return transaction. See the EPC173-14 guidelines for more information.

Enum"AC01""AC03""AC04""AC06""AC13""AC14""AG01""AG02""AM01""AM02"
sepa_return_reasonstring

(If applicable) The SEPA return reason text as defined by ISO 20022.

sepa_return_reason_definitionstring

(If applicable) Explanation of the SEPA return reason code as defined by ISO 20022.

meta_infoobject or null
recorded_atstring

UTC timestamp from when the booking was recorded.

Example: "2022-01-24T00:41:57.634Z"
reconciliation_idstring

(If applicable) Unique ID of the related clearing transaction initiated by Solaris.

Example: "87271dda6e454393036b4ec2b64b2221itrx"
initiator_referencestring

Unique reference for the transaction's initiator.

charge_detailsstring

Transaction charge details. Only relevant for bookings with the type TARGET2_CREDIT_TRANSFER.

Enum"DEBT""SHAR""CRED"
Example: "CRED"
application/json
{
  "id": "fe6561bdb526ed8866e9dac00bd1848ecboo",
  "creation_date": "2022-01-18",
  "valuta_date": "2022-01-18",
  "booking_date": "2022-01-18",
  "booking_type": "SEPA_CREDIT_TRANSFER",
  "amount": {
    "value": -160,
    "unit": "cents",
    "currency": "EUR"
  },
  "description": "BERLINER VOLKSBANK EG, TXL ABFLUG",
  "purpose_code": "null",
  "recipient_bic": "SOBKDEBBXXX",
  "recipient_iban": "DE97110101002242911754",
  "recipient_name": "SURIA LUIS VENTURA VIERA PEREIRA RIBEIRO",
  "receiver_iban_virtual": "string",
  "sender_bic": "SOBKDEBBXXX",
  "sender_iban": "DE95110101000018501020",
  "sender_name": "HANS MUSTERMANN",
  "end_to_end_id": "END2ENDREJ",
  "creditor_identifier": "DE98ZZZ09999999999",
  "mandate_reference": "00000000000001",
  "transaction_id": "d651ee23300b4e7c8fe7b7e2b2e96trx",
  "return_transaction_id": "758ea4a268974284ae7af17871f3fdc4",
  "sepa_charges": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  },
  "sepa_return_code": "AC01",
  "sepa_return_reason": "string",
  "sepa_return_reason_definition": "string",
  "meta_info": "{\"cards\":{\"card_id\":\"abe6963e8be94364b8c1aa34d1bb5bc3mcrd\",\"merchant\":{\"id\":\"123456789101112\",\"country_code\":\"GB\",\"category_code\":\"5411\",\"name\":\"Grocery\",\"town\":\"London\"},\"original_amount\":{\"currency\":\"GBP\",\"value\":50000,\"fx_rate\":10.0,\"fx_markup\":7.3165,\"issuer_fee\":0.0},\"pos_entry_mode\":\"MANUAL_PAN_ENTRY\",\"trace_id\":\"382621b66280020528d9433d135c2ae418fa53d0\",\"transaction_id\":\"c158f11c-d6b2-4f8f-9391-ac20c2167f89\",\"transaction_date\":\"2024-10-18\",\"transaction_time\":\"2024-10-18T15:22:02+00:00\",\"auth_code\":\"053630\",\"acquirer_id\":\"123456\",\"terminal_id\":\"12345678\",\"transaction_type\":\"PURCHASE\"}}",
  "recorded_at": "2022-01-24T00:41:57.634Z",
  "reconciliation_id": "87271dda6e454393036b4ec2b64b2221itrx",
  "initiator_reference": "string",
  "charge_details": "CRED"
}

Responses

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

BUSINESS_CHANGEDWebhook

Request

One or more attributes of a business were changed. This webhook does not come with a payload. The notification includes the ID of the business that was changed in the header.

Headers
Solaris-Entity-Idstring

ID of the business whose attributes changed.

Example: 211c5c2f34ac442ff6f93d09fc8fb3edcbiz
Bodyapplication/json
object
application/json
{}

Responses

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