Skip to content
Webhooks
/
/
CARD_AUTHORIZATION_DECLIN...

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

CARD_AUTHORIZATIONWebhook

Request

An authorization was created on a customer's account following a card transaction.

Bodyapplication/json
idstring

ID of the reservation related to the card transaction.

Example: "b814e2213c5c45149945ed53422db0c4cres"
amountobject

Amount of the reservation related to the card transaction (in Euro cents).

reservation_typestring

The type of reservation.

Value"CARD_AUTHORIZATION"
Example: "CARD_AUTHORIZATION"
referencestring

Reference for the transaction.

Example: "ccfd9e66-3f3d-4630-b20c-8c268616b702"
statusstring

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

Enum"OPEN""RESOLVED"
Example: "OPEN"
meta_infostring(Solaris-Resources-MetaInfo-JSON)

JSON-serialized supplementary information about the transaction. For example, information about the card and the merchant associated with the transaction.

Example: "{\"cards\":{\"card_id\":\"abe6963e8be94364b8c1aa34d1bb5bc3mcrd\",\"merchant\":{\"id\":\"123456789101112\",\"country_code\":\"GB\",\"category_code\":\"5411\",\"name\":\"Grocery\",\"town\":\"London\"},\"original_amount\":{\"currency\":\"GBP\",\"value\":50000,\"fx_rate\":10.0,\"fx_markup\":7.3165,\"issuer_fee\":0.0},\"pos_entry_mode\":\"MANUAL_PAN_ENTRY\",\"trace_id\":\"382621b66280020528d9433d135c2ae418fa53d0\",\"transaction_id\":\"c158f11c-d6b2-4f8f-9391-ac20c2167f89\",\"transaction_date\":\"2024-10-18\",\"transaction_time\":\"2024-10-18T15:22:02+00:00\",\"auth_code\":\"053630\",\"acquirer_id\":\"123456\",\"terminal_id\":\"12345678\",\"transaction_type\":\"PURCHASE\"}}"
expires_atstring

UTC timestamp when the reservation will expire.

Example: "2020-03-30T00:00:00Z"
expired_atstring or null

UTC timestamp from when the authorization expired (null if it hasn't expired).

Example: null
resolved_atstring or null

UTC timestamp from when the authorization was resolved.

Example: null
descriptionstring

A description of the transaction related to the authorization.

Example: "PAYPAL *RECISIO KAR, 35314369001"
partner_idstring

The unique ID of the partner to whom the customer belongs.

Example: "fa126a6d6f47d2ffc23e9d6a3cd69a6fcpar"
application/json
{
  "id": "b814e2213c5c45149945ed53422db0c4cres",
  "amount": {
    "value": 800,
    "unit": "cents",
    "currency": "EUR"
  },
  "reservation_type": "CARD_AUTHORIZATION",
  "reference": "ccfd9e66-3f3d-4630-b20c-8c268616b702",
  "status": "OPEN",
  "meta_info": "{\"cards\":{\"card_id\":\"abe6963e8be94364b8c1aa34d1bb5bc3mcrd\",\"merchant\":{\"id\":\"123456789101112\",\"country_code\":\"GB\",\"category_code\":\"5411\",\"name\":\"Grocery\",\"town\":\"London\"},\"original_amount\":{\"currency\":\"GBP\",\"value\":50000,\"fx_rate\":10.0,\"fx_markup\":7.3165,\"issuer_fee\":0.0},\"pos_entry_mode\":\"MANUAL_PAN_ENTRY\",\"trace_id\":\"382621b66280020528d9433d135c2ae418fa53d0\",\"transaction_id\":\"c158f11c-d6b2-4f8f-9391-ac20c2167f89\",\"transaction_date\":\"2024-10-18\",\"transaction_time\":\"2024-10-18T15:22:02+00:00\",\"auth_code\":\"053630\",\"acquirer_id\":\"123456\",\"terminal_id\":\"12345678\",\"transaction_type\":\"PURCHASE\"}}",
  "expires_at": "2020-03-30T00:00:00Z",
  "expired_at": null,
  "resolved_at": null,
  "description": "PAYPAL *RECISIO KAR, 35314369001",
  "partner_id": "fa126a6d6f47d2ffc23e9d6a3cd69a6fcpar"
}

Responses

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

CARD_AUTHORIZATION_DECLINE_V2Webhook

Request

A customer's card transaction was declined. Click here to see the full list of possible reasons.

Bodyapplication/json
reasonsArray of objects

Array of objects containing information about why the transaction was declined. A transaction may have been declined for multiple reasons.

card_transactionobject

Object containing information about the declined transaction.

application/json
{
  "reasons": [
    { … }
  ],
  "card_transaction": {
    "status": "DECLINED",
    "amount": { … },
    "terminal_id": "678656789765",
    "merchant": { … },
    "pos_entry_mode": "CHIP",
    "attempted_at": "2019-04-01T12:23:42+00:00",
    "card_id": "f459e5de647e2909c94a7120c4d03557mcrd",
    "acquirer_id": "75638395813",
    "type": "PURCHASE",
    "original_amount": { … }
  }
}

Responses

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

CARD_AUTHORIZATION_RESOLUTIONWebhook

Request

A reservation for a card transaction was cancelled or booked, or it expired. You do not have to send the customer a push notification for this webhook.

Bodyapplication/json
idstring

ID of the reservation.

Example: "b814e2213c5c45149945ed53422db0c4cres"
amountobject
reservation_typestring

The type of reservation.

Value"CARD_AUTHORIZATION"
Example: "CARD_AUTHORIZATION"
referencestring

Unique reference for the authorization.

Example: "0e30e961-9abd-41a2-bbd6-4730a22f17fd"
statusstring

The current status of the reservation.

Value"RESOLVED"
Example: "RESOLVED"
meta_infoobject(Solaris-Resources-MetaInfo)

An object containing all meta information related to the reservation.

expires_atstring

UTC timestamp when the reservation will expire.

Example: "2020-03-30T00:00:00Z"
expired_atstring or null

UTC timestamp from when the authorization expired (null if it hasn't expired).

Example: null
resolved_atstring or null

UTC timestamp from when the authorization was resolved.

Example: "2020-03-30T00:10:00Z"
descriptionstring

A description of the transaction.

Example: "PAYPAL *RECISIO KAR, 35314369001"
application/json
{
  "id": "b814e2213c5c45149945ed53422db0c4cres",
  "amount": {
    "value": 5000,
    "unit": "cents",
    "currency": "EUR"
  },
  "reservation_type": "CARD_AUTHORIZATION",
  "reference": "0e30e961-9abd-41a2-bbd6-4730a22f17fd",
  "status": "RESOLVED",
  "meta_info": {
    "cards": { … }
  },
  "expires_at": "2020-03-30T00:00:00Z",
  "expired_at": null,
  "resolved_at": "2020-03-30T00:10:00Z",
  "description": "PAYPAL *RECISIO KAR, 35314369001"
}

Responses

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