Skip to content
Webhooks
/
/
SEPA_SCHEDULED_TRANSACTIO...

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

SEPA_DIRECT_DEBIT_RETURNWebhook

Request

A SEPA Direct Debit return notification was created because a SEPA Direct Debit collection from a customer's account did not meet the payment acceptance criteria, which led to Solaris declining the transaction. The payload will contain information about the SDD return, including its return code.

Bodyapplication/json
idstring

Unique ID of the SEPA Direct Debit return.

Example: "257eb92c4656691fd02d3de1fa88b9f5csdr"
creditor_ibanstring

The creditor's IBAN.

Example: "DE32110101001000000029"
creditor_namestring

The creditor's name.

Example: "Peter Mustermann"
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

Reference of the mandate. Must be unique for the creditor identifier.

Example: "SOBKTEST"
amountobject

The amount of the booking.

end_to_end_idstring

SEPA identifier provided by the transaction initiator, which will be routed throughout the whole payment process.

Example: "DD-12-28.05.2018"
sepa_return_codestring

SEPA return code.

Example: "MD01"
descriptionstring

Additional details about the booking.

recorded_atstring

The timestamp from when the return was recorded.

Example: "2018-08-12T13:58:58.000Z"
customer_idstring

The customer's ID.

Example: "74c586d116e7dcd138af3dd5d754f2abcper"
customer_typestring

Specifies whether the customer is a Person or Business.

Enum"Person""Business"
Example: "Person"
account_idstring

The customer's Solaris account ID.

Example: "3eb274b98be7afb13d91acb8ae53901ecacc"
application/json
{
  "id": "257eb92c4656691fd02d3de1fa88b9f5csdr",
  "creditor_iban": "DE32110101001000000029",
  "creditor_name": "Peter Mustermann",
  "creditor_identifier": "DE98ZZZ09999999999",
  "mandate_reference": "SOBKTEST",
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "end_to_end_id": "DD-12-28.05.2018",
  "sepa_return_code": "MD01",
  "description": "string",
  "recorded_at": "2018-08-12T13:58:58.000Z",
  "customer_id": "74c586d116e7dcd138af3dd5d754f2abcper",
  "customer_type": "Person",
  "account_id": "3eb274b98be7afb13d91acb8ae53901ecacc"
}

Responses

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

SEPA_SCHEDULED_TRANSACTIONWebhook

Request

A standing order was either executed or declined. Use this webhook to stay informed about the progression of standing orders and to connect each step in the process with its corresponding booking (or absence thereof).

Bodyapplication/json
idstring

The ID of the relevant standing order.

Example: "c14ed45ced80f17a1ecc62214db2738ccsto"
account_idstring

The account ID associated with the standing order.

Example: "008cad63f317721e582ba99eefff219fcacc"
processed_atstring

UTC timestamp from when the transaction was processed.

Example: "2017-10-21T00:50:00.438Z"
referencestring

Optional reference for the transaction. Will act as an idempotency key.

Example: "Reference-56eb879fae8faa2f6d14f87161cst"
sourcestring

Transaction source.

Example: "standing_order"
source_idstring

ID of the transaction's source.

Example: "c14ed45ced80f17a1ecc62214db2738ccsto"
statusstring

Status of the standing order.

Example: "EXECUTED"
decline_reasonArray of arrays

An array containing the reasons why the standing order was declined.

transaction_idstring

ID of the transaction.

Example: "49a57d88276df2e440cdd2e7eec291ctrx"
application/json
{
  "id": "c14ed45ced80f17a1ecc62214db2738ccsto",
  "account_id": "008cad63f317721e582ba99eefff219fcacc",
  "processed_at": "2017-10-21T00:50:00.438Z",
  "reference": "Reference-56eb879fae8faa2f6d14f87161cst",
  "source": "standing_order",
  "source_id": "c14ed45ced80f17a1ecc62214db2738ccsto",
  "status": "EXECUTED",
  "decline_reason": [],
  "transaction_id": "49a57d88276df2e440cdd2e7eec291ctrx"
}

Responses

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

SEPA_STANDING_ORDERWebhook

Request

A standing order has been canceled, either by Solaris (due to account closure or insufficient funds) or by the customer.

Bodyapplication/json
idstring

The ID of the standing order that has been canceled.

Example: "8b5c66882e8ab88369002f5da2659ec5csto"
referencestring

The reference ID of the standing order that has been canceled.

Example: "dsf2r3raedfs3fsf342fctrx"
statusstring

Status of the standing order.

Example: "CANCELED"
account_idstring

The account ID related to the canceled standing order.

Example: "bb8a31f9fb313e6f8cc3859a2c2ea625cacc"
application/json
{
  "id": "8b5c66882e8ab88369002f5da2659ec5csto",
  "reference": "dsf2r3raedfs3fsf342fctrx",
  "status": "CANCELED",
  "account_id": "bb8a31f9fb313e6f8cc3859a2c2ea625cacc"
}

Responses

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