Skip to content
Download OpenAPI description
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/onboarding/webhooks/

Operations
Webhooks

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.

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.

Request

A fraud case that was recorded for a transaction with a customer's card did not receive a response from the customer within 30 minutes. 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: "TIMEOUT"
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": "TIMEOUT", "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.