Skip to content
Download OpenAPI description
Languages
Servers
Mock Server

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

Operations
Webhooks

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.

Request

The status of a customer's card has changed. You can find the full list of available statuses here.

Bodyapplication/json
idstring

ID of the card.

Example: "8febdba4912a747808ccc6f95f82bbb4"
statusstring

The current status of the card.

Enum"ACTIVE""ACTIVATION_BLOCKED_BY_SOLARIS""BLOCKED""BLOCKED_BY_SOLARIS""CLOSED""CLOSED_BY_SOLARIS""COUNTERFEIT_CARD""FRAUD""INACTIVE""LOST"
Example: "ACTIVE"
referencestring

Unique reference number for the card.

Example: "87285d83-ab15-4906-af87-5763801d9e43"
typestring

The type of the card. Note The following enum list is not exhaustive but only indicative of some possible values.

Enum"MASTERCARD_DEBIT""MASTERCARD_BUSINESS_DEBIT""VIRTUAL_MASTERCARD_DEBIT""VIRTUAL_MASTERCARD_BUSINESS_DEBIT""VIRTUAL_MASTERCARD_FREELANCE_DEBIT""VISA_DEBIT""VISA_BUSINESS_DEBIT""VIRTUAL_VISA_DEBIT""VIRTUAL_VISA_BUSINESS_DEBIT""VIRTUAL_VISA_FREELANCE_DEBIT"
Example: "MASTERCARD_DEBIT"
expiration_datestring

The expiration date of the card.

Example: "2020-12-30"
person_idstring

ID of the cardholder person resource.

Example: "5af2ea4271038d5c53e68ccbf4fe43b3cper"
account_idstring

ID of the account to which the card is tied.

Example: "a5844f601567db9b59b3531245a58e96cacc"
business_idstring

(For business cards) ID of the business with which the card is associated.

Example: "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz"
representationobject(Solaris_Decorators_PublicPlasticCard)

Object containing information about the cardholder, the card's masked PAN, and the formatted expiration date.

application/json
{ "id": "8febdba4912a747808ccc6f95f82bbb4", "status": "ACTIVE", "reference": "87285d83-ab15-4906-af87-5763801d9e43", "type": "MASTERCARD_DEBIT", "expiration_date": "2020-12-30", "person_id": "5af2ea4271038d5c53e68ccbf4fe43b3cper", "account_id": "a5844f601567db9b59b3531245a58e96cacc", "business_id": "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz", "representation": { "line_1": "SLY STALLONE", "line_2": "BUSINESS NAME", "masked_pan": "537458******4567", "formatted_expiration_date": "09/22" } }

Responses

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