Skip to content
Webhooks
/
/
CARD_TOKEN_LIFECYCLE

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_LIFECYCLE_EVENTWebhook

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

CARD_TOKEN_LIFECYCLEWebhook

Request

A push provisioning token has been created or updated for a customer's card.

Bodyapplication/json
card_idstring

The ID of the card associated with the token.

Example: "8b48d56bdc1c091d9ab5547fe0e9511bmcrd"
token_reference_idstring

The unique reference ID of the token that was created.

Example: "DNITHE382228352676336613"
token_statusstring

The status of the token.

Enum"ACTIVE""DEACTIVATED""INACTIVE""SUSPENDED"
Example: "ACTIVE"
event_typestring

The event type of the token's lifecycle.

Enum"TOKEN_CREATED""TOKEN_STATUS_UPDATED""TOKEN_ACTIVATION_STIP"
Example: "TOKEN_CREATED"
message_reasonstring

Token's lifecycle event reason (from VISA's constantly changing message reason codes, e.g., TOKEN_CREATED).

Enum"CALL_CENTER_ACTIVATION""CARDHOLDER_STEPUP_RESULT""DEVICE_PROVISIONING_REPERSONALIZATION_RESULT""DEVICE_PROVISIONING_RESULT""LUK_REPLENISHMENT""MOBILE_BANK_APP_ACTIVATION""OTP_VERIFICATION_RESULT""TOKEN_CREATED""TOKEN_DEACTIVATED""TOKEN_DEVICE_BINDING_REMOVED"
Example: "TOKEN_CREATED"
client_wallet_account_idstring

Unique 24-byte identifier for each instance of a [Android user, Google account] pair. Google computes the ID as a keyed hash of the Android user ID and the Google account ID. The key to this hash lives on Google's servers; the wallet ID is created during user setup as an RPC.

Example: "Rwt3tJek_k1JxivcwbPHjKDk"
wallet_typestring

The type of the wallet.

Enum"APPLE""GOOGLE""SAMSUNG"
Example: "APPLE"
pan_reference_idstring

ID of the Primary Account Number (PAN) reference.

Example: "V-3019278454673935797827"
visa_pan_reference_idstringDeprecated

ID of the Primary Account Number (PAN) reference. Only appears in webhook notifications related to VISA cards. Deprecated in favor of pan_reference_id.

Example: "V-3019278454673935797827"
application/json
{
  "card_id": "8b48d56bdc1c091d9ab5547fe0e9511bmcrd",
  "token_reference_id": "DNITHE382228352676336613",
  "token_status": "ACTIVE",
  "event_type": "TOKEN_CREATED",
  "message_reason": "TOKEN_CREATED",
  "client_wallet_account_id": "Rwt3tJek_k1JxivcwbPHjKDk",
  "wallet_type": "APPLE",
  "visa_pan_reference_id": "V-3019278454673935797827",
  "pan_reference_id": "V-3019278454673935797827"
}

Responses

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

CASH_OPERATION_STATUS_CHANGEDWebhook

Request

A customer has paid out/paid in to a cash operation, or the cash operation has expired.

Bodyapplication/json
idstring

ID of the cash operation.

barcode_ean_13string

The EAN-13 barcode that your solution must generate so that the customer can present it at the merchant POS to complete the cash operation.

expires_atstring(date-time)

The date and time when the cash operation barcode expires.

statusstring

The current status of the cash operation.

Enum"PENDING""CREATED""PAID""EXPIRED""CANCELLED"
reference_idstring

End-to-end reference for the customer.

person_idstring

ID of the person who initiated the cash operation.

application/json
{
  "id": "string",
  "barcode_ean_13": "string",
  "expires_at": "2019-08-24T14:15:22Z",
  "status": "PENDING",
  "reference_id": "string",
  "person_id": "string"
}

Responses

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