Skip to content
Webhooks
/
/
REFERENCE_ACCOUNT_INSTANT...

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_CREATEDWebhook

Request

A customer has registered a new reference account for payouts used with restricted accounts.

Bodyapplication/json
idstring

ID of the customer's restricted account to which the reference account is linked.

Example: "9876827fc63a639ee829racc"
statusstring

Status of the reference account.

Example: "ACTIVE"
ibanstring

The IBAN of the reference account.

Example: "DE12345678900122"
account_idstring

ID of the DiBa account connected.

Example: "4ee59da2-83a4-4910-b771-4de07d41c2e9"
application/json
{
  "id": "9876827fc63a639ee829racc",
  "status": "ACTIVE",
  "iban": "DE12345678900122",
  "account_id": "4ee59da2-83a4-4910-b771-4de07d41c2e9"
}

Responses

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

REFERENCE_ACCOUNT_INSTANT_PAYOUT_DECLINEDWebhook

Request

An instant reference account payout was declined, and no 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: "DECLINED"
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 reason why the payout was declined if the status is DECLINED.

Example: "Insufficient funds"
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": "DECLINED",
  "end_to_end_id": "end_to_end_ref",
  "description": "Payout description",
  "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
  "instant": true,
  "decline_reason": "Insufficient funds"
}

Responses

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

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.