Skip to content
Webhooks
/
/
SEPA_CREDIT_TRANSACTION_D...

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

SDD_COLLECTION_APPLICATIONWebhook

Request

To start receiving updates about application Decoupled Cards product.

Bodyapplication/json
idstring

ID of the SDD collection application.

Example: "dec2961f594045159195ca66e55fd6ea"
person_idstring

ID of the person who created the SDD collection application.

Example: "ec71f4b0456b424b97cc8be75b2c77d4"
credit_record_idstring

The credit_record_id of the SDD collection application.

Example: "84f468eacc7a4784ba0d4b0b577a9265"
sdd_collection_idstring

ID of the SDD collection.

Example: "c06fbfcc98b04376a9f220c4578932e4"
account_snapshot_idstring

ID of the relevant account snapshot record.

Example: "973a5f01ed7a416fadfed954c5bce782"
statusstring

The current status of the SDD collection application.

Example: "pending"
decisionstring

The decision taken on the SDD collection application.

Enum"OFFERED""REJECTED"
Example: "OFFERED"
rejection_reasonsArray of strings

An array of reasons why the SDD collection application was rejected.

Items Enum"not_preferred_alternate_offer""probability_of_default"
Example: ["probability_of_default"]
created_atstring(date-time)

UTC timestamp from when the application was created.

Example: "2021-10-20T14:45:54Z"
limitobject
application/json
{
  "id": "dec2961f594045159195ca66e55fd6ea",
  "person_id": "ec71f4b0456b424b97cc8be75b2c77d4",
  "credit_record_id": "84f468eacc7a4784ba0d4b0b577a9265",
  "sdd_collection_id": "c06fbfcc98b04376a9f220c4578932e4",
  "account_snapshot_id": "973a5f01ed7a416fadfed954c5bce782",
  "status": "pending",
  "decision": "OFFERED",
  "rejection_reasons": [
    "probability_of_default"
  ],
  "created_at": "2021-10-20T14:45:54Z",
  "limit": {
    "value": 10000,
    "unit": "cents",
    "currency": "EUR"
  }
}

Responses

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

SEPA_CREDIT_TRANSACTION_DECLINEDWebhook

Request

A SEPA Credit Transfer conducted by one of your customers was declined. The transaction may have initially been accepted, but then something changed (e.g., a block was placed on the account, the balance proved to be insufficient) and the transaction was declined instead of executed.

Bodyapplication/json
idstring

Unique ID of the transaction.

Example: "45bd0881-a79a-4054-9286-f11060d5511f"
statusstring

Status of the transaction.

Example: "declined"
referencestring

Optional unique reference. Used as an idempotency key.

Example: "8880a72c-2675-482d-8d88-70a02c608592"
amountobject
descriptionstring

Additional description about the transaction. Please note the SEPA character restrictions.

recipient_ibanstring

The recipient's IBAN.

Example: "DE87110101001000057123"
recipient_namestring

The recipient's name. Please note the SEPA character restrictions.

Example: "Max Mustermann"
recipient_bicstring

The recipient's BIC.

Example: "SOBKDEB2XXX"
end_to_end_idstring

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

Example: "END2ENDREJ"
schedule_idstring

Unique ID of the schedule transfer.

Example: "f874b3102718a4d757a6b6e4d599607csctr"
batch_idstring

Unique ID of the batch.

Example: "d6c778822b2d7bd3b778935bcfd0d1d3csc"
created_atstring(date-time)

UTC timestamp from when the transaction was created.

Example: "2021-01-01T20:37:50Z"
rejection_reasonstring

Reason why the transaction failed.

application/json
{
  "id": "45bd0881-a79a-4054-9286-f11060d5511f",
  "status": "declined",
  "reference": "8880a72c-2675-482d-8d88-70a02c608592",
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "description": "string",
  "recipient_iban": "DE87110101001000057123",
  "recipient_name": "Max Mustermann",
  "recipient_bic": "SOBKDEB2XXX",
  "end_to_end_id": "END2ENDREJ",
  "schedule_id": "f874b3102718a4d757a6b6e4d599607csctr",
  "batch_id": "d6c778822b2d7bd3b778935bcfd0d1d3csc",
  "created_at": "2021-01-01T20:37:50Z",
  "rejection_reason": "string"
}

Responses

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

SEPA_DIRECT_DEBIT_TRANSACTION_SCHEDULEDWebhook

Request

A SEPA Direct Debit (SDD) transaction was scheduled on a customer's account.

Bodyapplication/json
account_idstring

The ID of the account on which the SDD transaction was scheduled.

Example: "adc123a45d6d7cf8fbfeed537ba919d5cacc"
collection_sequencestring

The collection sequence of the SDD transaction.

Enum"FRST""RCUR""OOFF""FNAL"
Example: "FRST"
amountobject

The amount of the SDD transaction in Euro cents.

valuta_datestring(date)

The date on which the SDD transaction will be executed.

descriptionstring

Description of the SDD transaction.

Example: "inv:123cust:456"
end_to_end_idstring

End-to-end ID of the SDD transaction.

Example: "REFX123X123X456"
transaction_idstring

Unique ID of the transaction. Same as the transaction ID in the booking resource.

Example: "E8B845AC29AD49D294FC833A0342FE5A"
creditor_idstring

Creditor ID of the SDD transaction.

Example: "DE00ZZZ00000000005"
creditor_namestring

The name of the creditor.

Example: "Vodafone GmbH"
creditor_ibanstring

The creditor IBAN.

Example: "DE84110101019999999999"
creditor_bicstring

The creditor BIC.

Example: "BANKDEBBXXX"
debtor_namestring

The name of the debtor.

Example: "Bob Mustermann"
debtor_ibanstring

The debtor IBAN.

Example: "DE75110101013333333333"
debtor_bicstring

The debtor BIC.

Example: "SOBKDEB2XXX"
application/json
{
  "account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc",
  "collection_sequence": "FRST",
  "amount": {
    "value": 800,
    "unit": "cents",
    "currency": "EUR"
  },
  "valuta_date": "2019-08-24",
  "description": "inv:123cust:456",
  "end_to_end_id": "REFX123X123X456",
  "transaction_id": "E8B845AC29AD49D294FC833A0342FE5A",
  "creditor_id": "DE00ZZZ00000000005",
  "creditor_name": "Vodafone GmbH",
  "creditor_iban": "DE84110101019999999999",
  "creditor_bic": "BANKDEBBXXX",
  "debtor_name": "Bob Mustermann",
  "debtor_iban": "DE75110101013333333333",
  "debtor_bic": "SOBKDEB2XXX"
}

Responses

Webhook event received successfully.