Skip to main content
Vindicia Knowledge Center

Push Event Classes and Events

Push Event Classes and Events

Event Class: Entitlements

Entitlement push notifications pro-actively notify you when an entitlement starts and stops. Receiving entitlement push notifications can be useful, for example, if you set up CashBox to notify a client provisioning system that automatically starts and stops customers’ subscriptions.

The Entitlement Class currently includes the following events:

Event Trigger
Entitlement Started An individual Entitlement started service.
Message Content: entitlement
Entitlement Stopped An individual Entitlement ended service.
Message Content: entitlement

Event Class: Transactions

Transactions push notifications pro-actively inform you about key transaction processing events. Receiving near real time transaction results can assist, for example, if you set up CashBox to notify your customer-facing application to prompt for action, when desired - or to extend your retention/dunning activity.

The Transactions Class currently includes the following events:

Event Trigger
Transaction Succeeded One-time or Recurring Transaction captured
Message Content: transaction
Transaction Failed One-time or Recurring Transaction failed (cancelled)
Message Content: transaction
Renewal Transaction Succeeded Recurring renewal Transaction captured (active subscription billed beyond initial transaction)
Message Content: transaction

Event Class: Subscriptions

Subscriptions push notifications pro-actively inform you about key subscription events.

The Subscriptions (AutoBills) Class currently includes the following events:

Event Trigger
Subscription Started Service Start - Subscription Start Date reached.
Message Content: subscription
Subscription Stopped Service End - Subscription End Date reached.
Message Content: subscription
Subscription Cancelled Cancel submitted - Subscription may cancel immediately or be pending cancellation; the push event is the request.
Message Content: subscription
Subscription Modified Successful modification of a Subscription.
Message Content: subscription

Event Class: Accounts

Accounts push notifications pro-actively inform you about key Account change events. Receiving near real time account information can assist, for example, if you set up CashBox to notify your CRM or customer-facing application to prompt for action, when desired - or to update high-touch customer records.

The Accounts Class currently includes the following events:

Event Trigger
Account Created Initial creation of an Account.
Message Content: account
Account Shipping Address Changed Any change to the assigned Shipping Address.
Message Content: account, old address

Event Class: Payment Methods

Payment Methods push notifications pro-actively inform you about key pay method change events. Receiving near real time changes to on-file pay methods can assist, for example, if you set up CashBox to notify your CRM or customer-facing application to prompt for action, when desired - or to update high-touch customer records.

The Payment Methods Class currently includes the following events:

Event Trigger
Account Updater Change A payment method is updated due to Account Updater (AU) response.
Message Content: payment_method
Payment Method Activated Any payment method gets stored on an Account in Active status or a previously inactive payment method is moved to Active status.
Message Content: payment_method
Payment Method Deactivated Any payment method gets removed from an Account or a previously active payment method is moved to Inactive status.
Message Content: payment_method
Billing Address Changed Any change to the assigned Billing Address.
Message Content: payment_method, old address

Event Class: Adjustments

Adjustments push notifications inform you about financial adjustments to payments - specifically about refunds and chargebacks.

The Adjustments Class currently includes the following events:

Event Trigger
Refund Requested Initial request/issue of a refund (against a Transaction). Message Content: refund
  • cURL
  • Java
Example Object
{
    "content": {
        "merchantAutobillId": "sub-ab2",
        "merchantBillingPlanId": "",
        "merchantAutoBillItemId": "",
        "merchantEntitlementId": [
            "PROD4_ENT_1234"
        ],
        "merchantAccountId": "cust_1234",
        "entitlementSource": "Product",
        "merchantProductId": "prod_1234",
        "autoBillItemVid": "ef19a972130b659cadc162cd585336c6bf8c0249",
        "startTimestamp": "2016-06-06 17:51:01",
        "endTimestamp": "2099-01-01 00:00:00"
    },

    "header": {
        "author_id": "ae0e0dc8aaf92f4dfb2f3c9520d76cca33431754",
        "class_name": "entitlement",
        "message_id": "4c610678cbd1eadc8a1b85795ebdfc046e930a81",
        "event_name": "start",
        "merchant_vid": "72e532c12061b9dbc87342113a6569a13f1b1fa1",
        "x_el_id": "828310141",
        "soap_version": "18_0",
        "submitted": "2016-06-06T17:51:02.570578-0700",
        "hostname": "ws03.prodtest2.vindicia.com",
        "event_timestamp": "2016-06-06 17:51:02",
        "callers_save": "",
        "callers_new": ""
    }
}
{
    "content": {
        "merchantAutobillId": "sub-ab2",
        "merchantBillingPlanId": "",
        "merchantAutoBillItemId": "",
        "merchantEntitlementId": [
            "PROD4_ENT_1234"
        ],
        "merchantAccountId": "cust_1234",
        "entitlementSource": "Product",
        "merchantProductId": "prod_1234",
        "autoBillItemVid": "ef19a972130b659cadc162cd585336c6bf8c0249",
        "startTimestamp": "2016-06-06 17:51:01",
        "endTimestamp": "2099-01-01 00:00:00"
    },

    "header": {
        "author_id": "ae0e0dc8aaf92f4dfb2f3c9520d76cca33431754",
        "class_name": "entitlement",
        "message_id": "4c610678cbd1eadc8a1b85795ebdfc046e930a81",
        "event_name": "start",
        "merchant_vid": "72e532c12061b9dbc87342113a6569a13f1b1fa1",
        "x_el_id": "828310141",
        "soap_version": "18_0",
        "submitted": "2016-06-06T17:51:02.570578-0700",
        "hostname": "ws03.prodtest2.vindicia.com",
        "event_timestamp": "2016-06-06 17:51:02",
        "callers_save": "",
        "callers_new": ""
    }
}

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top