SubscriptionBridge: recurring billing and subscription management system - Documentation

User Tools

Site Tools

You are here: SubscriptionBridge Documentation » Merchant User Guide » Notifications: events posted to the Callback URL
Trace: • Notifications: events posted to the Callback URL
merchant_guide:notifications_list_callbackurl

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
merchant_guide:notifications_list_callbackurl [2010/04/12 14:28] – earlyimpactmerchant_guide:notifications_list_callbackurl [2012/06/07 00:51] (current) – [1. Thank You] matt
Line 5: Line 5:
 This is a list of events that are posted to the **Callback URL** defined in the [[merchant_guide:notifications|Notification Settings]]. Some of these events are configurable on the "Events" section of the Notification Settings page (e.g. how many days after a declined payment should SubscriptionBridge reminder a customer to pay the outstanding balance?), other are not (e.g. you have no control on "when" a new customer buys a new subscription). The Notification Settings are defined at the store level within the SubscriptionBridge Merchant Center. This is a list of events that are posted to the **Callback URL** defined in the [[merchant_guide:notifications|Notification Settings]]. Some of these events are configurable on the "Events" section of the Notification Settings page (e.g. how many days after a declined payment should SubscriptionBridge reminder a customer to pay the outstanding balance?), other are not (e.g. you have no control on "when" a new customer buys a new subscription). The Notification Settings are defined at the store level within the SubscriptionBridge Merchant Center.
  
-===== Events ===== 
  
 +===== Using Events =====
 +
 +Events are posted in a universal XML standard formatting.  The callback application or file you specify in your **Callback URL** must receive the event message.  Next, it must parse the message to determine the event code.  After the callback application knows event code of the message it has received it can use the GUID (unique subscription identifier) to perform a specific action.  For example, if a callback application receives a message with event code "sb_n_3a" it will know that a trail was converted to full.  The application can then parse the GUID from the message and use it to update the local database, perhaps enabling some new content or features that not available during the trial.
 +
 +===== Event Messages =====
 +
 +All event messages contain the same basic information:
 +
 +  * GUID:  This is the unique subscription identifier returned in the [[:developer_guide:call_reference:SubscriptionRequest|SubscriptionResponse]] when you create a new subscription via the API. If you application saves the GUID after it creates a subscription, then it can use this information to manage the subscription.
 +  * Event_Code: This is a string that tells the application what event has just occurred. 
 +
 +A typical event message will appear as follows:
 +
 +  * Sample XML: <code><?xml version="1.0" encoding="utf-8"?>
 +<SB_Callback>
 +<GUID>string</GUID>
 +<Event_Code>sb_n_1a</Event_Code>
 +</SB_Callback></code>
 +
 +
 +
 +
 +===== Events/ Event Codes =====
  
 ==== 1. Thank You ==== ==== 1. Thank You ====
Line 15: Line 37:
     * **sb_n_1b** - Sent to Customer: No Trial Message     * **sb_n_1b** - Sent to Customer: No Trial Message
     * **sb_n_1c** - Sent to Merchant: Notification of new subscription created     * **sb_n_1c** - Sent to Merchant: Notification of new subscription created
-  * Sample XML: <code><?xml version="1.0" encoding="utf-8"?> +    * **sb_n_1d** - Sent to Merchant: Notification of new subscription created, in which first payment is a Trial or different from regular amount. 
-<SB_Callback> +
-<GUID>string</GUID> +
-<Event_Code>sb_n_1a</Event_Code> +
-</SB_Callback></code>+
  
 ==== 2. Trial To Expire ==== ==== 2. Trial To Expire ====
Line 29: Line 48:
  
 ... where the number of days ("N" and "M") is defined in the [[notifications|Notification Settings]] for the store. ... where the number of days ("N" and "M") is defined in the [[notifications|Notification Settings]] for the store.
- 
 ==== 3. Subscription Status Switched ==== ==== 3. Subscription Status Switched ====
  
   * Scenario: new subscription included a trial period, and the trial is stopped before it was scheduled to end. The trial may be stopped directly by the customer (e.g. via the SubscriptionBridge Customer Center) or by the merchant (e.g. customer calls in or sends an email asking for the subscription to be switched to full mode).   * Scenario: new subscription included a trial period, and the trial is stopped before it was scheduled to end. The trial may be stopped directly by the customer (e.g. via the SubscriptionBridge Customer Center) or by the merchant (e.g. customer calls in or sends an email asking for the subscription to be switched to full mode).
   * Event Codes:   * Event Codes:
-    * **sb_n_3a** - Sent to Customer: confirmation of subscription updated from "Trial" to "Full" status ([[http://www.earlyimpact.com/images/2009/sb_notification_trialAccountToFull.gif|see example]])+    * **sb_n_3a** - Sent to Customer: confirmation of subscription updated from "Trial" to "Full" status
     * **sb_n_3b** - Sent to Merchant: notification of change in subscription status     * **sb_n_3b** - Sent to Merchant: notification of change in subscription status
  
Line 65: Line 83:
     * **sb_n_7a** - Sent to Customer: P days have passed since unsuccessful payment     * **sb_n_7a** - Sent to Customer: P days have passed since unsuccessful payment
     * **sb_n_7b** - Sent to Customer: Q days have passed since unsuccessful payment, final notice     * **sb_n_7b** - Sent to Customer: Q days have passed since unsuccessful payment, final notice
-    * **sb_n_7c** - Sent to Merchant: notification of the issue, in both cases+    * **sb_n_7c** - Sent to Merchant: notification of the 7a 
 +    * **sb_n_7d** - Sent to Merchant: notification of the 7b 
 +    * **sb_n_7e** - Sent to Customer: R days have passed since unsuccessful payment, action taken 
 +    * **sb_n_7f** - Sent to Merchant: notification of action taken in 7.e
  
 ==== 8. Subscription Canceled ==== ==== 8. Subscription Canceled ====
Line 82: Line 103:
     * **sb_n_9a** - Sent to Customer: confirmation of change of Package     * **sb_n_9a** - Sent to Customer: confirmation of change of Package
     * **sb_n_9b** - Sent to Customer: confirmation of change of Features     * **sb_n_9b** - Sent to Customer: confirmation of change of Features
-    * **sb_n_9c** - Sent to Merchant: notification of subscription changes+    * **sb_n_9c** - Sent to Merchant: notification of change of Package 
 +    * **sb_n_9d** - Sent to Merchant: notification of change of Features 
  
  
Line 98: Line 121:
     * **sb_n_11b** - Sent to Customer: Notification credit card has expired     * **sb_n_11b** - Sent to Customer: Notification credit card has expired
  
-===== Related articles ===== +===== Related articles =====   
- +  * [[merchant_guide:notifications|Notification settings]]   
-  * [[merchant_guide:notifications|Notification settings]] +  * [[merchant_guide:notifications_list|Notifications sent via e-mail]] \\ A list of e-mail notifications sent by SubscriptionBridge when various events happen during the life of a subscription.  
-  * [[merchant_guide:notifications_list|Notifications sent via e-mail]] \\ A list of e-mail notifications sent by SubscriptionBridge when various events happen during the life of a subscription.+
   * [[developer_guide:developer_guide|SubscriptionBridge API home]]   * [[developer_guide:developer_guide|SubscriptionBridge API home]]
merchant_guide/notifications_list_callbackurl.1271096886.txt.gz · Last modified: 2010/04/12 00:00 (external edit)