Skip to content
Webhooks
/
/
SCA_CHALLENGE

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

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.

SCA_CHALLENGEWebhook

Request

A customer has made a purchase or performed a card servicing operation (e.g., adding a card to a Google or Apple Pay wallet) that requires authentication.

Bodyapplication/json
amountobject

The transaction's amount.

merchantobject

The merchant related to the transaction.

challenged_atstring(datetime)

UTC timestamp from when the authentication challenge was presented to the customer.

Example: "2022-11-07T13:34:27+00:00"
expires_atstring(datetime)

UTC timestamp from when the authentication challenge was expired.

Example: "2022-11-07T13:39:27+00:00"
person_idstring

The person ID of the customer who initiated the action requiring authentication.

Example: "682a85d7e490c1360f6c2be2f1addd57cper"
card_idstring

The ID of the card that was used for the transaction.

Example: "03bafc5569a53a62dd02ad2e5a789b80mcrd"
authenticate_change_request_idstring

The authorization change request ID.

Example: "bbcafe6e9cc66a4aebaa907cea325435csc"
decline_change_request_idstring

The decline change request ID.

Example: "6fbb54aebc42e2c5d4dc881d5cf566d6csc"
challenge_idstring

ID of the SCA challenge. Use this parameter for declining the transaction.

Example: "8bc7c682cf2b47fbb0da40146h2gscachal"
channelstring

The channel that was used for the transaction.

Example: "browser"
application/json
{
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "merchant": {
    "name": "MCDONALDS 1435",
    "country": "DE",
    "url": "https://mcdonalds.de"
  },
  "challenged_at": "2022-11-07T13:34:27+00:00",
  "expires_at": "2022-11-07T13:39:27+00:00",
  "person_id": "682a85d7e490c1360f6c2be2f1addd57cper",
  "card_id": "03bafc5569a53a62dd02ad2e5a789b80mcrd",
  "authenticate_change_request_id": "bbcafe6e9cc66a4aebaa907cea325435csc",
  "decline_change_request_id": "6fbb54aebc42e2c5d4dc881d5cf566d6csc",
  "challenge_id": "8bc7c682cf2b47fbb0da40146h2gscachal",
  "channel": "browser"
}

Responses

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

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.