Skip to content
Webhooks
/
/
BUSINESS_TAX_IDENTIFICATI...

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

BUSINESS_SEIZURE_UPDATEDWebhook

Request

The processing method for a seizure for a business has switched from automated to manual.

Bodyapplication/json
idstring

Unique ID of the seizure resource.

Example: "211c5c2f34ac442ff6f93d09fc8fb3edseiz"
enactment_datestring(date)

The date when the authority issued the seizure.

Example: "2019-01-31"
delivery_datestring

The date when the seizure notice was delivered to Solaris.

Example: "2019-01-28"
authority_namestring

The name of the authority that issued the seizure.

Example: "Court"
resolution_case_numberstring

The seizure's case ID number, generated by the issuing authority.

Example: "Number 212121212"
seizure_typestring

The type of seizure.

Enum"ATTACHMENT""AUTHORITY_SEIZURE""COURT_SEIZURE""PRE_ATTACHMENT"
Example: "COURT_SEIZURE"
statusstring

The current status of the seizure.

Enum"ACTIVE""FULFILLED""WAITING_FOR_AUTHORITY"
Example: "ACTIVE"
amountobject

Object that represents the amount of the debt.

additional_costobject

Additional costs of the seizure.

debtorobject

Object that contains the name and address information of the debtor.

creditorobject

Object that contains the name and address information of the creditor.

creditor_representativeobject

Object containing information about a person or an entity that represents the creditor (i.e., a third-party liaison between the debtor and creditor).

automatic_payout_datestring

The automatic payout date of the seizure amount.

Example: "2022-01-29"
insolvencyboolean

Field to indicate whether or not there's an insolvency case related to the customer.

Example: false
social_benefitsboolean

Field to indicate whether or not social benefits are applicable to the customer.

Example: false
seizure_protectedboolean

Field to indicate whether or not there's a seizure protection related to the customer.

Example: false
automatedboolean

Field to indicate whether or not the seizure will be processed automatically or manually.

Example: false
countrystring

The country in which the seizure happened.

Example: "DE"
multiple_drittschuldnerboolean

Field to indicate whether or not there are multiple third party debtors related to the customer.

Example: true
customer_idstring

The person or business ID of the customer whose account has the seizure.

Example: "880bbac68a34add190786b9c74f4c82fcbiz"
customer_typestring

The type of customer whose account has the seizure.

Example: "Business"
application/json
{
  "id": "211c5c2f34ac442ff6f93d09fc8fb3edseiz",
  "enactment_date": "2019-01-31",
  "delivery_date": "2019-01-28",
  "authority_name": "Court",
  "resolution_case_number": "Number 212121212",
  "seizure_type": "COURT_SEIZURE",
  "status": "ACTIVE",
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "additional_cost": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "debtor": {
    "name": "string",
    "address": "string",
    "postal_code": "string",
    "city": "string",
    "country": "AD",
    "state": "BE"
  },
  "creditor": {
    "name": "Betflix LLC",
    "address": "Bethousestrasse 43",
    "postal_code": "10409",
    "city": "Berlin",
    "country": "DE",
    "state": "BE",
    "iban": "DE72110101001000014344"
  },
  "creditor_representative": {
    "name": "Lawyer LLC",
    "address": "Gunsterstrasse 22",
    "postal_code": "10409",
    "city": "Berlin",
    "country": "DE",
    "state": "BE",
    "case_number": "42ABC-2",
    "iban": "DE87110101001000057123"
  },
  "automatic_payout_date": "2022-01-29",
  "insolvency": false,
  "social_benefits": false,
  "seizure_protected": false,
  "automated": false,
  "country": "DE",
  "multiple_drittschuldner": true,
  "customer_id": "880bbac68a34add190786b9c74f4c82fcbiz",
  "customer_type": "Business"
}

Responses

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

BUSINESS_TAX_IDENTIFICATION_CHANGEDWebhook

Request

The tax identification number of a business was modified. The webhook contains the id of the relevant business tax identification in the header and the id of the relevant business in the payload.

Headers
Solaris-Entity-Idstring

ID of the business tax identification that triggered the webhook notification.

Example: cba4289c773b7450482ee88a6e5126e9ctin
Bodyapplication/json
idstring

The ID of the business whose tax identification has changed.

Example: "e51dac3dfa8bd52f9df1a50b091dcbiz"
application/json
{
  "id": "e51dac3dfa8bd52f9df1a50b091dcbiz"
}

Responses

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

CARD_AUTHORIZATIONWebhook

Request

An authorization was created on a customer's account following a card transaction.

Bodyapplication/json
idstring

ID of the reservation related to the card transaction.

Example: "b814e2213c5c45149945ed53422db0c4cres"
amountobject

Amount of the reservation related to the card transaction (in Euro cents).

reservation_typestring

The type of reservation.

Value"CARD_AUTHORIZATION"
Example: "CARD_AUTHORIZATION"
referencestring

Reference for the transaction.

Example: "ccfd9e66-3f3d-4630-b20c-8c268616b702"
statusstring

The current status of the reservation. Possible values are OPEN and RESOLVED.

Enum"OPEN""RESOLVED"
Example: "OPEN"
meta_infostring(Solaris-Resources-MetaInfo-JSON)

JSON-serialized supplementary information about the transaction. For example, information about the card and the merchant associated with the transaction.

Example: "{\"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\"}}"
expires_atstring

UTC timestamp when the reservation will expire.

Example: "2020-03-30T00:00:00Z"
expired_atstring or null

UTC timestamp from when the authorization expired (null if it hasn't expired).

Example: null
resolved_atstring or null

UTC timestamp from when the authorization was resolved.

Example: null
descriptionstring

A description of the transaction related to the authorization.

Example: "PAYPAL *RECISIO KAR, 35314369001"
partner_idstring

The unique ID of the partner to whom the customer belongs.

Example: "fa126a6d6f47d2ffc23e9d6a3cd69a6fcpar"
application/json
{
  "id": "b814e2213c5c45149945ed53422db0c4cres",
  "amount": {
    "value": 800,
    "unit": "cents",
    "currency": "EUR"
  },
  "reservation_type": "CARD_AUTHORIZATION",
  "reference": "ccfd9e66-3f3d-4630-b20c-8c268616b702",
  "status": "OPEN",
  "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\"}}",
  "expires_at": "2020-03-30T00:00:00Z",
  "expired_at": null,
  "resolved_at": null,
  "description": "PAYPAL *RECISIO KAR, 35314369001",
  "partner_id": "fa126a6d6f47d2ffc23e9d6a3cd69a6fcpar"
}

Responses

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