Skip to content
Webhooks
/
/
CARD_DELIVERY_TRACKING

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_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.

CARD_DELIVERY_TRACKINGWebhook

Request

New card delivery tracking information is available.

Bodyapplication/json
idstring

Unique identifier for the card tracking record.

Example: "2ba86442-a9a1-4634-9eb8-fef3500322b3"
card_idstring

ID of the card.

Example: "1fe8caa4bf1f49d87b2d63c14bb565f0mcrd"
shipping_providerstring

The shipping company that shipped the card.

Example: "DHL Express"
date_of_shipmentstring(date)

Conditional field. If shipment successfully happened, this field is presenting on response and keeps shipment date information. Format: yyyy-MM-dd

Example: "2020-12-30"
shipping_tracking_informationstring

Conditional field. Keeps the tracking code from company. If its present message will be empty

Example: "JD014600009536663804"
messagestring

Conditional field. Keeps the error message from the provider. If its present shipping_tracking_information will be empty

Example: "a5844f601567db9b59b3531245a58e96cacc"
country_codestring

(Conditional field) Country ISO Code to represent countries, dependent territories, and special areas of geographical interest.

Example: "DE"
has_pictureboolean

(Conditional field) Flag that shows card has the picture or not.

Example: true
application/json
{
  "id": "2ba86442-a9a1-4634-9eb8-fef3500322b3",
  "card_id": "1fe8caa4bf1f49d87b2d63c14bb565f0mcrd",
  "shipping_provider": "DHL Express",
  "date_of_shipment": "2020-12-30",
  "shipping_tracking_information": "JD014600009536663804",
  "message": "a5844f601567db9b59b3531245a58e96cacc",
  "country_code": "DE",
  "has_picture": true
}

Responses

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

CARD_FRAUD_CASE_PENDINGWebhook

Request

A fraud case was recorded on a transaction made by a customer's card, and it requires the customer's immediate response (over a prompt provided by your frontend). See the Cards Smart Agent guide for more information.

Bodyapplication/json
idstring

ID of the fraud case.

Example: "154dca58bb1b5c8701039fa6514ffc66frdcs"
resolutionstring

The current status of the fraud case.

Enum"CONFIRMED""PENDING""TIMEOUT""WHITELISTED"
Example: "PENDING"
respond_untilstring

Timestamp indicating the deadline for the customer to confirm that the transaction is not fraudulent.

Example: "2020-05-05T11:54:26Z"
whitelisted_untilstring or null

Timestamp indicating how long transactions will be whitelisted for the given card after confirming that a transaction was not fraudulent (i.e., 10 minutes after making the API call).

Example: null
card_transactionobject

Object containing information about the declined transaction.

application/json
{
  "id": "154dca58bb1b5c8701039fa6514ffc66frdcs",
  "resolution": "PENDING",
  "respond_until": "2020-05-05T11:54:26Z",
  "whitelisted_until": null,
  "card_transaction": {
    "card_id": "f459e5de647e2909c94a7120c4d03557mcrd",
    "type": "PURCHASE",
    "status": "DECLINED",
    "attempted_at": "2019-04-01T12:23:42+00:00",
    "pos_entry_mode": "CHIP",
    "merchant": { … },
    "amount": { … },
    "original_amount": { … }
  }
}

Responses

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