Skip to content
Webhooks
/
/
RESERVATION_CREATED

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

REFERENCE_ACCOUNT_INSTANT_PAYOUT_EXECUTEDWebhook

Request

An instant reference account payout was successful and a booking was made on the account.

Bodyapplication/json
idstring

Unique ID of the payout.

Example: "4b157d71def54b5c9dac28ef1d04432c"
referencestring

A unique reference for the payout. Used as an idempotency key.

Example: "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669"
statusstring

Current status of the payout.

Example: "EXECUTED"
end_to_end_idstring

End-to-end ID of the payout.

Example: "end_to_end_ref"
descriptionstring

A description for the payout.

Example: "Payout description"
reference_account_idstring

ID of the reference account to which the payout is directed.

Example: "78f354e508314bb8ac982a3d7f969dde"
decline_reasonstring

Contains a technical code for the payout if the status is DECLINED. Check decline_reason_details for more information.

decline_reason_detailsstring

Contains a detailed reason why the payout was declined if the status is DECLINED.

amountobject

Amount of the payout.

instantboolean

A field to indicate whether the transaction is instant or not.

Example: true
application/json
{
  "id": "4b157d71def54b5c9dac28ef1d04432c",
  "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
  "status": "EXECUTED",
  "end_to_end_id": "end_to_end_ref",
  "description": "Payout description",
  "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
  "instant": true
}

Responses

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

RESERVATION_CREATEDWebhook

Request

A reservation was created on a customer's account. This webhook event is only for seizure-related reservations.

Bodyapplication/json
idstring

ID of the reservation that was created.

Example: "b814e2213c5c45149945ed53422db0c4cres"
amountobject

Amount of the reservation (in Euro cents).

reservation_typestring

The type of reservation.

Enum"CARD_AUTHORIZATION""CLEARING_TRANSACTION""INTRA_CUSTOMER_TRANSFER""SEIZURE""SEPA_CREDIT_BATCH""SEPA_CREDIT_TRANSFER""ProtectedAccountSeizure""SEPAInstantCreditTransfer"
Example: "SEIZURE"
referencestring

Reference number for the reservation.

Example: "1234567example"
statusstring

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

Enum"OPEN""RESOLVED"
Example: "OPEN"
descriptionstring

Seizure-related reservation.

ibanstring

IBAN of the account on which the reservation was created.

Example: "DE87110101001000057123"
account_idstring

ID of the account on which the reservation was created.

Example: "adc123a45d6d7cf8fbfeed537ba919d5cacc"
created_atstring

UTC timestamp from when the reservation was created on the account.

Example: "2022-05-19T13:30:30Z"
resolved_atstring

UTC timestamp from when the reservation was resolved on the account.

meta_infoobject(Solaris-Resources-MetaInfo)

An object containing all meta information related to the reservation.

application/json
{
  "id": "b814e2213c5c45149945ed53422db0c4cres",
  "amount": {
    "value": 800,
    "unit": "cents",
    "currency": "EUR"
  },
  "reservation_type": "SEIZURE",
  "reference": "1234567example",
  "status": "OPEN",
  "description": "string",
  "iban": "DE87110101001000057123",
  "account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc",
  "created_at": "2022-05-19T13:30:30Z",
  "resolved_at": "string",
  "meta_info": {
    "cards": { … }
  }
}

Responses

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

RESERVATION_RESOLVEDWebhook

Request

A reservation on a customer's account was resolved. This webhook event is only for seizure-related reservations.

Bodyapplication/json
idstring

ID of the reservation that was resolved.

Example: "b814e2213c5c45149945ed53422db0c4cres"
amountobject

Amount of the reservation (in Euro cents).

reservation_typestring

The type of reservation.

Enum"CARD_AUTHORIZATION""CLEARING_TRANSACTION""INTRA_CUSTOMER_TRANSFER""SEIZURE""SEPA_CREDIT_BATCH""SEPA_CREDIT_TRANSFER""ProtectedAccountSeizure""SEPAInstantCreditTransfer"
Example: "SEIZURE"
referencestring

Reference number for the reservation.

Example: "1234567example"
statusstring

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

Enum"OPEN""RESOLVED"
Example: "RESOLVED"
descriptionstring

Seizure-related reservation.

ibanstring

IBAN of the account on which the reservation was created.

Example: "DE87110101001000057123"
account_idstring

ID of the account on which the reservation was created.

Example: "adc123a45d6d7cf8fbfeed537ba919d5cacc"
created_atstring

UTC timestamp from when the reservation was created on the account.

Example: "2022-05-19T13:30:30Z"
resolved_atstring

UTC timestamp from when the reservation was resolved on the account.

Example: "2022-08-19T13:30:30Z"
meta_infoobject(Solaris-Resources-MetaInfo)

An object containing all meta information related to the reservation.

application/json
{
  "id": "b814e2213c5c45149945ed53422db0c4cres",
  "amount": {
    "value": 800,
    "unit": "cents",
    "currency": "EUR"
  },
  "reservation_type": "SEIZURE",
  "reference": "1234567example",
  "status": "RESOLVED",
  "description": "string",
  "iban": "DE87110101001000057123",
  "account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc",
  "created_at": "2022-05-19T13:30:30Z",
  "resolved_at": "2022-08-19T13:30:30Z",
  "meta_info": {
    "cards": { … }
  }
}

Responses

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