Change Details

= Content [[ public/payment/partners/notifications/#transaction-success | transaction.success ]] [[ public/payment/partners/notifications/#transaction-failed | transaction.failed ]] [[ public/payment/partners/notifications/#subscription-created | subscription.created ]] [[ public/payment/partners/notifications/#subscription-trial | subscription.trial ]] [[ public/payment/partners/notifications/#subscription-stopped | subscription.stopped ]] [[ public/payment/partners/notifications/#subscription-suspended | subscription.suspended ]] [[ public/payment/partners/notifications/#subscription-rebill | subscription.rebill ]] [[ public/payment/partners/notifications/#subscription-completed | subscription.completed ]] [[ public/payment/partners/notifications/#subscription-change | subscription.change ]] [[ public/payment/partners/notifications/#subscriptions-prerebill | subscriptions.prerebill ]] ------ PV2 is sending notifications to our partners regarding various actions on PV2. Notifications are always sent to the same URL defined for each partner along with hash and other related data. If partner doesn't respond to notification, PV2 will try to resend it. Generally notifications will be sent in this format: <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr> <td>command</td><td>string</td><td>The command that needs to be executed</td> </tr> <tr> <td>hash</td><td>string</td><td>Hash</td> </tr> <tr> <td>data</td><td>string</td><td>json encoded string with data array</td> </tr> </table> After receiving notification partner should respond with [[public/payment/partners/apidocs/notifications.hash.validate|notifications.hash.validate]] api call by sending received hash back, otherwise notification will be resent with this schedulle: # After 1 minute # After 5 minutes # After 15 minutes # After 30 minutes # After 30 minutes notifications.hash.validate call also has another important purpose, so partners can validate if the notification actually came from us. This is list of notifications which will be send out. = transaction.success Sent in case of successful transaction. Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>tran_id</td><td>int</td><td>**Transaction** ID</td></tr> <tr><td>ptnr_id</td><td>int</td><td>**Partner** ID</td></tr> <tr><td>ppac_id</td><td>int</td><td>**Payment Processor Account** ID</td></tr> <tr><td>order_id</td><td>int</td><td>**Order** ID</td></tr> <tr><td>ccdt_id</td><td>int</td><td>Credit Card Details ID</td></tr> <tr><td>transaction_type</td><td>string</td><td>Transaction Type. Values: `s` (sale), `a` (auth), `r` (refund), `c` (chargeback), `f` (fake)</td></tr> <tr><td>amount</td><td>string</td><td>Amount</td></tr> <tr><td>currency</td><td>string</td><td>Currency (3 Letter ISO Code)</td></tr> <tr><td>description</td><td>string</td><td>Description</td></tr> <tr><td>status</td><td>string</td><td>Transaction status. Values: `failed`, `successful`</td></tr> <tr><td>refunded_tran_id</td><td>int</td><td>Refunded **Transaction** ID</td></tr> <tr><td>origin</td><td>string</td><td>Origin. Values: `direct`, `system`</td></tr> <tr><td>ts</td><td>int</td><td>Timestamp</td></tr> <tr><td>status_code</td><td>int</td><td>Status code</td></tr> <tr><td>payment_code</td><td>int</td><td>[[ public/payment/partners/codes/ | Payment Code ]] (700 on success)</td></tr> <tr><td>order_type</td><td>string</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>pp_id</td><td>int</td><td>**Payment Processor** ID</td></tr> <tr><td>processor</td><td>string</td><td>**Payment Processor** abbreviation</td></tr> <tr><td>user_id</td><td>int</td><td>User ID in **Payment Application**</td></tr> <tr><td>tracking_user</td><td>int</td><td>User Identifier from **Partner**</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tag ID from **Partner**</td></tr> <tr><td>items</td><td>array</td><td>Array of items</td></tr> </table> = transaction.failed Sent in case of failed transaction. Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>tran_id</td><td>int</td><td>**Transaction** ID</td></tr> <tr><td>ptnr_id</td><td>int</td><td>**Partner** ID</td></tr> <tr><td>ppac_id</td><td>int</td><td>**Payment Processor Account** ID</td></tr> <tr><td>order_id</td><td>int</td><td>**Order** ID</td></tr> <tr><td>ccdt_id</td><td>int</td><td>Credit Card Details ID</td></tr> <tr><td>transaction_type</td><td>string</td><td>Transaction Type. Values: `s` (sale), `a` (auth), `r` (refund), `c` (chargeback), `f` (fake)</td></tr> <tr><td>amount</td><td>string</td><td>Amount</td></tr> <tr><td>currency</td><td>string</td><td>Currency (3 Letter ISO Code)</td></tr> <tr><td>description</td><td>string</td><td>Description</td></tr> <tr><td>status</td><td>string</td><td>Transaction status. Values: `failed`, `successful`</td></tr> <tr><td>refunded_tran_id</td><td>int</td><td>Refunded **Transaction** ID</td></tr> <tr><td>origin</td><td>string</td><td>Origin. Values: `direct`, `system`</td></tr> <tr><td>ts</td><td>int</td><td>Timestamp</td></tr> <tr><td>status_code</td><td>int</td><td>Status code</td></tr> <tr><td>payment_code</td><td>int</td><td>[[ public/payment/partners/codes/ | Payment Code ]] (700 on success)</td></tr> <tr><td>order_type</td><td>string</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>pp_id</td><td>int</td><td>**Payment Processor** ID</td></tr> <tr><td>processor</td><td>string</td><td>**Payment Processor** abbreviation</td></tr> <tr><td>user_id</td><td>int</td><td>User ID in **Payment Application**</td></tr> <tr><td>tracking_user</td><td>int</td><td>User Identifier from **Partner**</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tag ID from **Partner**</td></tr> <tr><td>items</td><td>array</td><td>Array of items</td></tr> </table> = subscription.created Sent in case of successfully created subscription Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>sub_id</td><td>int</td><td>Subscription ID</td></tr> <tr><td>item_id</td><td>int</td><td>Item ID</td></tr> <tr><td>status</td><td>string</td><td>Subscription status (s/b initial on create, rebill after 1st rebill)</td></tr> <tr><td>start_ts</td><td>int</td><td>Start timestamp</td></tr> <tr><td>change_ts</td><td>int</td><td>Change(edit) timestamp</td></tr> <tr><td>end_ts</td><td>int</td><td>End timestamp</td></tr> <tr><td>rebill_count</td><td>int</td><td>Number of recurring payments</td></tr> <tr><td>last_rebill_ts</td><td>int</td><td>Last rebill ts</td></tr> <tr><td>next_rebill_ts</td><td>int</td><td>Next rebill ts</td></tr> <tr><td>next_rebill_amount</td><td>int</td><td>Next rebill amount</td></tr> <tr><td>step_down</td><td>int</td><td>Step Down (charge amount reductions)</td></tr> <tr><td>order_id</td><td>int</td><td>Order ID</td></tr> <tr><td>description</td><td>int</td><td>Order Description</td></tr> <tr><td>rebill_amount</td><td>int</td><td>Rebill amount (not including next one)</td></tr> <tr><td>trial_unit</td><td>string</td><td>Trial Unit (day|week|month|year)</td></tr> <tr><td>rebill_unit</td><td>string</td><td>Rebill Unit (day|week|month|year)</td></tr> <tr><td>rebill_period</td><td>int</td><td>Rebill period</td></tr> <tr><td>max_rebill_count</td><td>int</td><td>Max Rebill Count</td></tr> <tr><td>trial_period</td><td>int</td><td>Trial period</td></tr> <tr><td>tracking_item</td><td>int</td><td>Tracking item ID</td></tr> <tr><td>pp_id</td><td>int</td><td>Payment Processor ID</td></tr> <tr><td>user_id</td><td>int</td><td>PV2 user ID</td></tr> <tr><td>hash</td><td>string</td><td>Hash</td></tr> <tr><td>first_name</td><td>int</td><td>Customer's First Name</td></tr> <tr><td>last_name</td><td>int</td><td>Customer's Last Name</td></tr> <tr><td>ppac_id</td><td>int</td><td>Payment Processor Account ID</td></tr> <tr><td>email</td><td>int</td><td>Customer's Email Address</td></tr> <tr><td>ptnr_id</td><td>int</td><td>Partner ID</td></tr> <tr><td>currency</td><td>string</td><td>Currency</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tracking Tag param</td></tr> <tr><td>ip</td><td>int</td><td>Customer's IP Address</td></tr> <tr><td>order_type</td><td>int</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>tracking_user</td><td>int</td><td>User ID on partners' site</td></tr> <tr><td>processor</td><td>int</td><td>Payment Processor's abreviation</td></tr> <tr><td>tran_id*</td><td>int</td><td>Last Transaction's ID</td></tr> </table> //* Not present for all payment processors// = subscription.trial Sent in case of successfully created subscription <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>sub_id</td><td>int</td><td>Subscription ID</td></tr> <tr><td>item_id</td><td>int</td><td>Item ID</td></tr> <tr><td>status</td><td>string</td><td>Subscription status (s/b initial on create, rebill after 1st rebill)</td></tr> <tr><td>start_ts</td><td>int</td><td>Start timestamp</td></tr> <tr><td>change_ts</td><td>int</td><td>Change(edit) timestamp</td></tr> <tr><td>end_ts</td><td>int</td><td>End timestamp</td></tr> <tr><td>rebill_count</td><td>int</td><td>Number of recurring payments</td></tr> <tr><td>last_rebill_ts</td><td>int</td><td>Last rebill ts</td></tr> <tr><td>next_rebill_ts</td><td>int</td><td>Next rebill ts</td></tr> <tr><td>next_rebill_amount</td><td>int</td><td>Next rebill amount</td></tr> <tr><td>step_down</td><td>int</td><td>Step Down (charge amount reductions)</td></tr> <tr><td>order_id</td><td>int</td><td>Order ID</td></tr> <tr><td>description</td><td>int</td><td>Order Description</td></tr> <tr><td>rebill_amount</td><td>int</td><td>Rebill amount (not including next one)</td></tr> <tr><td>trial_unit</td><td>string</td><td>Trial Unit (day|week|month|year)</td></tr> <tr><td>rebill_unit</td><td>string</td><td>Rebill Unit (day|week|month|year)</td></tr> <tr><td>rebill_period</td><td>int</td><td>Rebill period</td></tr> <tr><td>max_rebill_count</td><td>int</td><td>Max Rebill Count</td></tr> <tr><td>trial_period</td><td>int</td><td>Trial period</td></tr> <tr><td>tracking_item</td><td>int</td><td>Tracking item ID</td></tr> <tr><td>pp_id</td><td>int</td><td>Payment Processor ID</td></tr> <tr><td>user_id</td><td>int</td><td>PV2 user ID</td></tr> <tr><td>hash</td><td>string</td><td>Hash</td></tr> <tr><td>first_name</td><td>int</td><td>Customer's First Name</td></tr> <tr><td>last_name</td><td>int</td><td>Customer's Last Name</td></tr> <tr><td>ppac_id</td><td>int</td><td>Payment Processor Account ID</td></tr> <tr><td>email</td><td>int</td><td>Customer's Email Address</td></tr> <tr><td>ptnr_id</td><td>int</td><td>Partner ID</td></tr> <tr><td>currency</td><td>string</td><td>Currency</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tracking Tag param</td></tr> <tr><td>ip</td><td>int</td><td>Customer's IP Address</td></tr> <tr><td>order_type</td><td>int</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>tracking_user</td><td>int</td><td>User ID on partners' site</td></tr> <tr><td>processor</td><td>int</td><td>Payment Processor's abreviation</td></tr> <tr><td>tran_id*</td><td>int</td><td>Last Transaction's ID</td></tr> </table> //* Not present for all payment processors// = subscription.stopped Sent in case of stopped subscription (action initiated via api call) Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>sub_id</td><td>int</td><td>Subscription ID</td></tr> <tr><td>item_id</td><td>int</td><td>Item ID</td></tr> <tr><td>status</td><td>string</td><td>Subscription status (s/b initial on create, rebill after 1st rebill)</td></tr> <tr><td>start_ts</td><td>int</td><td>Start timestamp</td></tr> <tr><td>change_ts</td><td>int</td><td>Change(edit) timestamp</td></tr> <tr><td>end_ts</td><td>int</td><td>End timestamp</td></tr> <tr><td>rebill_count</td><td>int</td><td>Number of recurring payments</td></tr> <tr><td>last_rebill_ts</td><td>int</td><td>Last rebill ts</td></tr> <tr><td>next_rebill_ts</td><td>int</td><td>Next rebill ts</td></tr> <tr><td>next_rebill_amount</td><td>int</td><td>Next rebill amount</td></tr> <tr><td>step_down</td><td>int</td><td>Step Down (charge amount reductions)</td></tr> <tr><td>order_id</td><td>int</td><td>Order ID</td></tr> <tr><td>description</td><td>int</td><td>Order Description</td></tr> <tr><td>rebill_amount</td><td>int</td><td>Rebill amount (not including next one)</td></tr> <tr><td>trial_unit</td><td>string</td><td>Trial Unit (day|week|month|year)</td></tr> <tr><td>rebill_unit</td><td>string</td><td>Rebill Unit (day|week|month|year)</td></tr> <tr><td>rebill_period</td><td>int</td><td>Rebill period</td></tr> <tr><td>max_rebill_count</td><td>int</td><td>Max Rebill Count</td></tr> <tr><td>trial_period</td><td>int</td><td>Trial period</td></tr> <tr><td>tracking_item</td><td>int</td><td>Tracking item ID</td></tr> <tr><td>pp_id</td><td>int</td><td>Payment Processor ID</td></tr> <tr><td>user_id</td><td>int</td><td>PV2 user ID</td></tr> <tr><td>hash</td><td>string</td><td>Hash</td></tr> <tr><td>first_name</td><td>int</td><td>Customer's First Name</td></tr> <tr><td>last_name</td><td>int</td><td>Customer's Last Name</td></tr> <tr><td>ppac_id</td><td>int</td><td>Payment Processor Account ID</td></tr> <tr><td>email</td><td>int</td><td>Customer's Email Address</td></tr> <tr><td>ptnr_id</td><td>int</td><td>Partner ID</td></tr> <tr><td>currency</td><td>string</td><td>Currency</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tracking Tag param</td></tr> <tr><td>ip</td><td>int</td><td>Customer's IP Address</td></tr> <tr><td>order_type</td><td>int</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>tracking_user</td><td>int</td><td>User ID on partners' site</td></tr> <tr><td>processor</td><td>int</td><td>Payment Processor's abreviation</td></tr> <tr><td>is_cancel</td><td>boolean</td><td>s/b true</td></tr> <tr><td>cancel_reason</td><td>string</td><td>Optional, not always sent. If it has value 'cancel_reason_rebill_bin_filter' it means that subscription was stopped because BIN used for purchase is not allowed to rebill.</td></tr> </table> = subscription.suspended Sent in case of suspended subscription (usually happens when we can't rebill user after defined number of attempts) Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>sub_id</td><td>int</td><td>Subscription ID</td></tr> <tr><td>item_id</td><td>int</td><td>Item ID</td></tr> <tr><td>status</td><td>string</td><td>Subscription status (s/b initial on create, rebill after 1st rebill)</td></tr> <tr><td>start_ts</td><td>int</td><td>Start timestamp</td></tr> <tr><td>change_ts</td><td>int</td><td>Change(edit) timestamp</td></tr> <tr><td>end_ts</td><td>int</td><td>End timestamp</td></tr> <tr><td>rebill_count</td><td>int</td><td>Number of recurring payments</td></tr> <tr><td>last_rebill_ts</td><td>int</td><td>Last rebill ts</td></tr> <tr><td>next_rebill_ts</td><td>int</td><td>Next rebill ts</td></tr> <tr><td>next_rebill_amount</td><td>int</td><td>Next rebill amount</td></tr> <tr><td>step_down</td><td>int</td><td>Step Down (charge amount reductions)</td></tr> <tr><td>order_id</td><td>int</td><td>Order ID</td></tr> <tr><td>description</td><td>int</td><td>Order Description</td></tr> <tr><td>rebill_amount</td><td>int</td><td>Rebill amount (not including next one)</td></tr> <tr><td>trial_unit</td><td>string</td><td>Trial Unit (day|week|month|year)</td></tr> <tr><td>rebill_unit</td><td>string</td><td>Rebill Unit (day|week|month|year)</td></tr> <tr><td>rebill_period</td><td>int</td><td>Rebill period</td></tr> <tr><td>max_rebill_count</td><td>int</td><td>Max Rebill Count</td></tr> <tr><td>trial_period</td><td>int</td><td>Trial period</td></tr> <tr><td>tracking_item</td><td>int</td><td>Tracking item ID</td></tr> <tr><td>pp_id</td><td>int</td><td>Payment Processor ID</td></tr> <tr><td>user_id</td><td>int</td><td>PV2 user ID</td></tr> <tr><td>hash</td><td>string</td><td>Hash</td></tr> <tr><td>first_name</td><td>int</td><td>Customer's First Name</td></tr> <tr><td>last_name</td><td>int</td><td>Customer's Last Name</td></tr> <tr><td>ppac_id</td><td>int</td><td>Payment Processor Account ID</td></tr> <tr><td>email</td><td>int</td><td>Customer's Email Address</td></tr> <tr><td>ptnr_id</td><td>int</td><td>Partner ID</td></tr> <tr><td>currency</td><td>string</td><td>Currency</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tracking Tag param</td></tr> <tr><td>ip</td><td>int</td><td>Customer's IP Address</td></tr> <tr><td>order_type</td><td>int</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>tracking_user</td><td>int</td><td>User ID on partners' site</td></tr> <tr><td>processor</td><td>int</td><td>Payment Processor's abreviation</td></tr> </table> = subscription.rebill Sent after successfully made rebill. It will be sent right after transaction.success Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>sub_id</td><td>int</td><td>Subscription ID</td></tr> <tr><td>item_id</td><td>int</td><td>Item ID</td></tr> <tr><td>status</td><td>string</td><td>Subscription status (s/b initial on create, rebill after 1st rebill)</td></tr> <tr><td>start_ts</td><td>int</td><td>Start timestamp</td></tr> <tr><td>change_ts</td><td>int</td><td>Change(edit) timestamp</td></tr> <tr><td>end_ts</td><td>int</td><td>End timestamp</td></tr> <tr><td>rebill_count</td><td>int</td><td>Number of recurring payments</td></tr> <tr><td>last_rebill_ts</td><td>int</td><td>Last rebill ts</td></tr> <tr><td>next_rebill_ts</td><td>int</td><td>Next rebill ts</td></tr> <tr><td>next_rebill_amount</td><td>int</td><td>Next rebill amount</td></tr> <tr><td>step_down</td><td>int</td><td>Step Down (charge amount reductions)</td></tr> <tr><td>order_id</td><td>int</td><td>Order ID</td></tr> <tr><td>description</td><td>int</td><td>Order Description</td></tr> <tr><td>rebill_amount</td><td>int</td><td>Rebill amount (not including next one)</td></tr> <tr><td>trial_unit</td><td>string</td><td>Trial Unit (day|week|month|year)</td></tr> <tr><td>rebill_unit</td><td>string</td><td>Rebill Unit (day|week|month|year)</td></tr> <tr><td>rebill_period</td><td>int</td><td>Rebill period</td></tr> <tr><td>max_rebill_count</td><td>int</td><td>Max Rebill Count</td></tr> <tr><td>trial_period</td><td>int</td><td>Trial period</td></tr> <tr><td>tracking_item</td><td>int</td><td>Tracking item ID</td></tr> <tr><td>pp_id</td><td>int</td><td>Payment Processor ID</td></tr> <tr><td>user_id</td><td>int</td><td>PV2 user ID</td></tr> <tr><td>hash</td><td>string</td><td>Hash</td></tr> <tr><td>first_name</td><td>int</td><td>Customer's First Name</td></tr> <tr><td>last_name</td><td>int</td><td>Customer's Last Name</td></tr> <tr><td>ppac_id</td><td>int</td><td>Payment Processor Account ID</td></tr> <tr><td>email</td><td>int</td><td>Customer's Email Address</td></tr> <tr><td>ptnr_id</td><td>int</td><td>Partner ID</td></tr> <tr><td>currency</td><td>string</td><td>Currency</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tracking Tag param</td></tr> <tr><td>ip</td><td>int</td><td>Customer's IP Address</td></tr> <tr><td>order_type</td><td>int</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>tracking_user</td><td>int</td><td>User ID on partners' site</td></tr> <tr><td>processor</td><td>int</td><td>Payment Processor's abreviation</td></tr> <tr><td>tran_id*</td><td>int</td><td>Last Transaction's ID</td></tr> </table> //* Not present for all payment processors// = subscription.completed Sent after completed subscription (happens only on subs with limited number of rebills). Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>sub_id</td><td>int</td><td>Subscription ID</td></tr> <tr><td>item_id</td><td>int</td><td>Item ID</td></tr> <tr><td>status</td><td>string</td><td>Subscription status (s/b initial on create, rebill after 1st rebill)</td></tr> <tr><td>start_ts</td><td>int</td><td>Start timestamp</td></tr> <tr><td>change_ts</td><td>int</td><td>Change(edit) timestamp</td></tr> <tr><td>end_ts</td><td>int</td><td>End timestamp</td></tr> <tr><td>rebill_count</td><td>int</td><td>Number of recurring payments</td></tr> <tr><td>last_rebill_ts</td><td>int</td><td>Last rebill ts</td></tr> <tr><td>next_rebill_ts</td><td>int</td><td>Next rebill ts</td></tr> <tr><td>next_rebill_amount</td><td>int</td><td>Next rebill amount</td></tr> <tr><td>step_down</td><td>int</td><td>Step Down (charge amount reductions)</td></tr> <tr><td>order_id</td><td>int</td><td>Order ID</td></tr> <tr><td>description</td><td>int</td><td>Order Description</td></tr> <tr><td>rebill_amount</td><td>int</td><td>Rebill amount (not including next one)</td></tr> <tr><td>trial_unit</td><td>string</td><td>Trial Unit (day|week|month|year)</td></tr> <tr><td>rebill_unit</td><td>string</td><td>Rebill Unit (day|week|month|year)</td></tr> <tr><td>rebill_period</td><td>int</td><td>Rebill period</td></tr> <tr><td>max_rebill_count</td><td>int</td><td>Max Rebill Count</td></tr> <tr><td>trial_period</td><td>int</td><td>Trial period</td></tr> <tr><td>tracking_item</td><td>int</td><td>Tracking item ID</td></tr> <tr><td>pp_id</td><td>int</td><td>Payment Processor ID</td></tr> <tr><td>user_id</td><td>int</td><td>PV2 user ID</td></tr> <tr><td>hash</td><td>string</td><td>Hash</td></tr> <tr><td>first_name</td><td>int</td><td>Customer's First Name</td></tr> <tr><td>last_name</td><td>int</td><td>Customer's Last Name</td></tr> <tr><td>ppac_id</td><td>int</td><td>Payment Processor Account ID</td></tr> <tr><td>email</td><td>int</td><td>Customer's Email Address</td></tr> <tr><td>ptnr_id</td><td>int</td><td>Partner ID</td></tr> <tr><td>currency</td><td>string</td><td>Currency</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tracking Tag param</td></tr> <tr><td>ip</td><td>int</td><td>Customer's IP Address</td></tr> <tr><td>order_type</td><td>int</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>tracking_user</td><td>int</td><td>User ID on partners' site</td></tr> <tr><td>processor</td><td>int</td><td>Payment Processor's abreviation</td></tr> </table> = subscription.change Sent in when subscription is changed (action initiated via `subscription.change` api call) Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>sub_id</td><td>int</td><td>Subscription ID</td></tr> <tr><td>item_id</td><td>int</td><td>Item ID</td></tr> <tr><td>status</td><td>string</td><td>Subscription status (s/b initial on create, rebill after 1st rebill)</td></tr> <tr><td>start_ts</td><td>int</td><td>Start timestamp</td></tr> <tr><td>change_ts</td><td>int</td><td>Change(edit) timestamp</td></tr> <tr><td>end_ts</td><td>int</td><td>End timestamp</td></tr> <tr><td>rebill_count</td><td>int</td><td>Number of recurring payments</td></tr> <tr><td>last_rebill_ts</td><td>int</td><td>Last rebill ts</td></tr> <tr><td>next_rebill_ts</td><td>int</td><td>Next rebill ts</td></tr> <tr><td>next_rebill_amount</td><td>int</td><td>Next rebill amount</td></tr> <tr><td>step_down</td><td>int</td><td>Step Down (charge amount reductions)</td></tr> <tr><td>order_id</td><td>int</td><td>Order ID</td></tr> <tr><td>description</td><td>int</td><td>Order Description</td></tr> <tr><td>rebill_amount</td><td>int</td><td>Rebill amount (not including next one)</td></tr> <tr><td>trial_unit</td><td>string</td><td>Trial Unit (day|week|month|year)</td></tr> <tr><td>rebill_unit</td><td>string</td><td>Rebill Unit (day|week|month|year)</td></tr> <tr><td>rebill_period</td><td>int</td><td>Rebill period</td></tr> <tr><td>max_rebill_count</td><td>int</td><td>Max Rebill Count</td></tr> <tr><td>trial_period</td><td>int</td><td>Trial period</td></tr> <tr><td>tracking_item</td><td>int</td><td>Tracking item ID</td></tr> <tr><td>pp_id</td><td>int</td><td>Payment Processor ID</td></tr> <tr><td>user_id</td><td>int</td><td>PV2 user ID</td></tr> <tr><td>hash</td><td>string</td><td>Hash</td></tr> <tr><td>first_name</td><td>int</td><td>Customer's First Name</td></tr> <tr><td>last_name</td><td>int</td><td>Customer's Last Name</td></tr> <tr><td>ppac_id</td><td>int</td><td>Payment Processor Account ID</td></tr> <tr><td>email</td><td>int</td><td>Customer's Email Address</td></tr> <tr><td>ptnr_id</td><td>int</td><td>Partner ID</td></tr> <tr><td>currency</td><td>string</td><td>Currency</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tracking Tag param</td></tr> <tr><td>ip</td><td>int</td><td>Customer's IP Address</td></tr> <tr><td>order_type</td><td>int</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>tracking_user</td><td>int</td><td>User ID on partners' site</td></tr> <tr><td>processor</td><td>int</td><td>Payment Processor's abreviation</td></tr> </table> = subscriptions.prerebill (WIP) Sent from cron job that runs at 1h frequency. Data consists of subscriptions that are due to rebill in next X days, where X is configurable from cron manager. (one value of X per one cron job instance) Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>interval</td><td>string</td><td>When from now should rebill happen ('2 day', '3 day', 'X day')</td></tr> <tr><td>subscriptions</td><td>array</td><td>Array of data related to subscriptions rebills (see below)</td></tr> </table> Subscriptions array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>sub_id</td><td>int</td><td>Subscription ID</td></tr> <tr><td>next_rebill_ts</td><td>int</td><td>Next rebill timestamp</td></tr> <tr><td>ptnr_id</td><td>int</td><td>Partner ID</td></tr> <tr><td>tracking_user</td><td>int</td><td>User ID on partners' site</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tracking Tag param</td></tr> <tr><td>bin</td><td>string</td><td>BIN of card for this susbcription</td></tr> <tr><td>ccnum_last4</td><td>string</td><td>Last 4 digits of card for this susbcription</td></tr> <tr><td>currency</td><td>string</td><td>Currency</td></tr> <tr><td>order_type</td><td>string</td><td>Order type ('basic' | 'xsale')</td></tr> <tr><td>item_id</td><td>int</td><td>Item ID</td></tr> <tr><td>cc_type</td><td>string</td><td>Card type ('visa' ...)</td></tr> <tr><td>pp_name</td><td>string</td><td>PP Name</td></tr> <tr><td>bin_high_risk</td><td>int</td><td>Is BIN on High Risk List (1|0)</td></tr> <tr><td>bin_blocked_for_rebill</td><td>int</td><td>Is BIN blocked for rebill (1|0)</td></tr> </table>

= Content [[ public/payment/partners/notifications/#transaction-success | transaction.success ]] [[ public/payment/partners/notifications/#transaction-failed | transaction.failed ]] [[ public/payment/partners/notifications/#subscription-created | subscription.created ]] [[ public/payment/partners/notifications/#subscription-trial | subscription.trial ]] [[ public/payment/partners/notifications/#subscription-stopped | subscription.stopped ]] [[ public/payment/partners/notifications/#subscription-suspended | subscription.suspended ]] [[ public/payment/partners/notifications/#subscription-rebill | subscription.rebill ]] [[ public/payment/partners/notifications/#subscription-completed | subscription.completed ]] [[ public/payment/partners/notifications/#subscription-change | subscription.change ]] [[ public/payment/partners/notifications/#subscriptions-prerebill | subscriptions.prerebill ]] ------ PV2 is sending notifications to our partners regarding various actions on PV2. Notifications are always sent to the same URL defined for each partner along with hash and other related data. If partner doesn't respond to notification, PV2 will try to resend it. Generally notifications will be sent in this format: <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr> <td>command</td><td>string</td><td>The command that needs to be executed</td> </tr> <tr> <td>hash</td><td>string</td><td>Hash</td> </tr> <tr> <td>data</td><td>string</td><td>json encoded string with data array</td> </tr> </table> After receiving notification partner should respond with [[public/payment/partners/apidocs/notifications.hash.validate|notifications.hash.validate]] api call by sending received hash back, otherwise notification will be resent with this schedulle: # After 1 minute # After 5 minutes # After 15 minutes # After 30 minutes # After 30 minutes notifications.hash.validate call also has another important purpose, so partners can validate if the notification actually came from us. This is list of notifications which will be send out. = transaction.success Sent in case of successful transaction. Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>tran_id</td><td>int</td><td>**Transaction** ID</td></tr> <tr><td>ptnr_id</td><td>int</td><td>**Partner** ID</td></tr> <tr><td>ppac_id</td><td>int</td><td>**Payment Processor Account** ID</td></tr> <tr><td>order_id</td><td>int</td><td>**Order** ID</td></tr> <tr><td>ccdt_id</td><td>int</td><td>Credit Card Details ID</td></tr> <tr><td>transaction_type</td><td>string</td><td>Transaction Type. Values: `s` (sale), `a` (auth), `r` (refund), `c` (chargeback), `f` (fake)</td></tr> <tr><td>amount</td><td>string</td><td>Amount</td></tr> <tr><td>currency</td><td>string</td><td>Currency (3 Letter ISO Code)</td></tr> <tr><td>description</td><td>string</td><td>Description</td></tr> <tr><td>status</td><td>string</td><td>Transaction status. Values: `failed`, `successful`</td></tr> <tr><td>refunded_tran_id</td><td>int</td><td>Refunded **Transaction** ID</td></tr> <tr><td>origin</td><td>string</td><td>Origin. Values: `direct`, `system`</td></tr> <tr><td>ts</td><td>int</td><td>Timestamp</td></tr> <tr><td>status_code</td><td>int</td><td>Status code</td></tr> <tr><td>payment_code</td><td>int</td><td>[[ public/payment/partners/codes/ | Payment Code ]] (700 on success)</td></tr> <tr><td>order_type</td><td>string</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>pp_id</td><td>int</td><td>**Payment Processor** ID</td></tr> <tr><td>processor</td><td>string</td><td>**Payment Processor** abbreviation</td></tr> <tr><td>user_id</td><td>int</td><td>User ID in **Payment Application**</td></tr> <tr><td>tracking_user</td><td>int</td><td>User Identifier from **Partner**</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tag ID from **Partner**</td></tr> <tr><td>items</td><td>array</td><td>Array of items</td></tr> <tr><td>merchant*</td><td>array</td><td>Array of fields that identify merchant account**</td></tr> </table> *//Processor dependant, may not be sent for all processors - currently only RocketGate and Payon use this field// **//For RocketGate transaction, merchant is [merchant_id, merchant_account], for Payon it is [channel]// = transaction.failed Sent in case of failed transaction. Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>tran_id</td><td>int</td><td>**Transaction** ID</td></tr> <tr><td>ptnr_id</td><td>int</td><td>**Partner** ID</td></tr> <tr><td>ppac_id</td><td>int</td><td>**Payment Processor Account** ID</td></tr> <tr><td>order_id</td><td>int</td><td>**Order** ID</td></tr> <tr><td>ccdt_id</td><td>int</td><td>Credit Card Details ID</td></tr> <tr><td>transaction_type</td><td>string</td><td>Transaction Type. Values: `s` (sale), `a` (auth), `r` (refund), `c` (chargeback), `f` (fake)</td></tr> <tr><td>amount</td><td>string</td><td>Amount</td></tr> <tr><td>currency</td><td>string</td><td>Currency (3 Letter ISO Code)</td></tr> <tr><td>description</td><td>string</td><td>Description</td></tr> <tr><td>status</td><td>string</td><td>Transaction status. Values: `failed`, `successful`</td></tr> <tr><td>refunded_tran_id</td><td>int</td><td>Refunded **Transaction** ID</td></tr> <tr><td>origin</td><td>string</td><td>Origin. Values: `direct`, `system`</td></tr> <tr><td>ts</td><td>int</td><td>Timestamp</td></tr> <tr><td>status_code</td><td>int</td><td>Status code</td></tr> <tr><td>payment_code</td><td>int</td><td>[[ public/payment/partners/codes/ | Payment Code ]] (700 on success)</td></tr> <tr><td>order_type</td><td>string</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>pp_id</td><td>int</td><td>**Payment Processor** ID</td></tr> <tr><td>processor</td><td>string</td><td>**Payment Processor** abbreviation</td></tr> <tr><td>user_id</td><td>int</td><td>User ID in **Payment Application**</td></tr> <tr><td>tracking_user</td><td>int</td><td>User Identifier from **Partner**</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tag ID from **Partner**</td></tr> <tr><td>items</td><td>array</td><td>Array of items</td></tr> <tr><td>merchant*</td><td>array</td><td>Array of fields that identify merchant account**</td></tr> </table> *//Processor dependant, may not be sent for all processors - currently only RocketGate and Payon use this field// **//For RocketGate transaction, merchant is [merchant_id, merchant_account], for Payon it is [channel]// = subscription.created Sent in case of successfully created subscription Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>sub_id</td><td>int</td><td>Subscription ID</td></tr> <tr><td>item_id</td><td>int</td><td>Item ID</td></tr> <tr><td>status</td><td>string</td><td>Subscription status (s/b initial on create, rebill after 1st rebill)</td></tr> <tr><td>start_ts</td><td>int</td><td>Start timestamp</td></tr> <tr><td>change_ts</td><td>int</td><td>Change(edit) timestamp</td></tr> <tr><td>end_ts</td><td>int</td><td>End timestamp</td></tr> <tr><td>rebill_count</td><td>int</td><td>Number of recurring payments</td></tr> <tr><td>last_rebill_ts</td><td>int</td><td>Last rebill ts</td></tr> <tr><td>next_rebill_ts</td><td>int</td><td>Next rebill ts</td></tr> <tr><td>next_rebill_amount</td><td>int</td><td>Next rebill amount</td></tr> <tr><td>step_down</td><td>int</td><td>Step Down (charge amount reductions)</td></tr> <tr><td>order_id</td><td>int</td><td>Order ID</td></tr> <tr><td>description</td><td>int</td><td>Order Description</td></tr> <tr><td>rebill_amount</td><td>int</td><td>Rebill amount (not including next one)</td></tr> <tr><td>trial_unit</td><td>string</td><td>Trial Unit (day|week|month|year)</td></tr> <tr><td>rebill_unit</td><td>string</td><td>Rebill Unit (day|week|month|year)</td></tr> <tr><td>rebill_period</td><td>int</td><td>Rebill period</td></tr> <tr><td>max_rebill_count</td><td>int</td><td>Max Rebill Count</td></tr> <tr><td>trial_period</td><td>int</td><td>Trial period</td></tr> <tr><td>tracking_item</td><td>int</td><td>Tracking item ID</td></tr> <tr><td>pp_id</td><td>int</td><td>Payment Processor ID</td></tr> <tr><td>user_id</td><td>int</td><td>PV2 user ID</td></tr> <tr><td>hash</td><td>string</td><td>Hash</td></tr> <tr><td>first_name</td><td>int</td><td>Customer's First Name</td></tr> <tr><td>last_name</td><td>int</td><td>Customer's Last Name</td></tr> <tr><td>ppac_id</td><td>int</td><td>Payment Processor Account ID</td></tr> <tr><td>email</td><td>int</td><td>Customer's Email Address</td></tr> <tr><td>ptnr_id</td><td>int</td><td>Partner ID</td></tr> <tr><td>currency</td><td>string</td><td>Currency</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tracking Tag param</td></tr> <tr><td>ip</td><td>int</td><td>Customer's IP Address</td></tr> <tr><td>order_type</td><td>int</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>tracking_user</td><td>int</td><td>User ID on partners' site</td></tr> <tr><td>processor</td><td>int</td><td>Payment Processor's abreviation</td></tr> <tr><td>tran_id*</td><td>int</td><td>Last Transaction's ID</td></tr> </table> //* Not present for all payment processors// = subscription.trial Sent in case of successfully created subscription <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>sub_id</td><td>int</td><td>Subscription ID</td></tr> <tr><td>item_id</td><td>int</td><td>Item ID</td></tr> <tr><td>status</td><td>string</td><td>Subscription status (s/b initial on create, rebill after 1st rebill)</td></tr> <tr><td>start_ts</td><td>int</td><td>Start timestamp</td></tr> <tr><td>change_ts</td><td>int</td><td>Change(edit) timestamp</td></tr> <tr><td>end_ts</td><td>int</td><td>End timestamp</td></tr> <tr><td>rebill_count</td><td>int</td><td>Number of recurring payments</td></tr> <tr><td>last_rebill_ts</td><td>int</td><td>Last rebill ts</td></tr> <tr><td>next_rebill_ts</td><td>int</td><td>Next rebill ts</td></tr> <tr><td>next_rebill_amount</td><td>int</td><td>Next rebill amount</td></tr> <tr><td>step_down</td><td>int</td><td>Step Down (charge amount reductions)</td></tr> <tr><td>order_id</td><td>int</td><td>Order ID</td></tr> <tr><td>description</td><td>int</td><td>Order Description</td></tr> <tr><td>rebill_amount</td><td>int</td><td>Rebill amount (not including next one)</td></tr> <tr><td>trial_unit</td><td>string</td><td>Trial Unit (day|week|month|year)</td></tr> <tr><td>rebill_unit</td><td>string</td><td>Rebill Unit (day|week|month|year)</td></tr> <tr><td>rebill_period</td><td>int</td><td>Rebill period</td></tr> <tr><td>max_rebill_count</td><td>int</td><td>Max Rebill Count</td></tr> <tr><td>trial_period</td><td>int</td><td>Trial period</td></tr> <tr><td>tracking_item</td><td>int</td><td>Tracking item ID</td></tr> <tr><td>pp_id</td><td>int</td><td>Payment Processor ID</td></tr> <tr><td>user_id</td><td>int</td><td>PV2 user ID</td></tr> <tr><td>hash</td><td>string</td><td>Hash</td></tr> <tr><td>first_name</td><td>int</td><td>Customer's First Name</td></tr> <tr><td>last_name</td><td>int</td><td>Customer's Last Name</td></tr> <tr><td>ppac_id</td><td>int</td><td>Payment Processor Account ID</td></tr> <tr><td>email</td><td>int</td><td>Customer's Email Address</td></tr> <tr><td>ptnr_id</td><td>int</td><td>Partner ID</td></tr> <tr><td>currency</td><td>string</td><td>Currency</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tracking Tag param</td></tr> <tr><td>ip</td><td>int</td><td>Customer's IP Address</td></tr> <tr><td>order_type</td><td>int</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>tracking_user</td><td>int</td><td>User ID on partners' site</td></tr> <tr><td>processor</td><td>int</td><td>Payment Processor's abreviation</td></tr> <tr><td>tran_id*</td><td>int</td><td>Last Transaction's ID</td></tr> </table> //* Not present for all payment processors// = subscription.stopped Sent in case of stopped subscription (action initiated via api call) Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>sub_id</td><td>int</td><td>Subscription ID</td></tr> <tr><td>item_id</td><td>int</td><td>Item ID</td></tr> <tr><td>status</td><td>string</td><td>Subscription status (s/b initial on create, rebill after 1st rebill)</td></tr> <tr><td>start_ts</td><td>int</td><td>Start timestamp</td></tr> <tr><td>change_ts</td><td>int</td><td>Change(edit) timestamp</td></tr> <tr><td>end_ts</td><td>int</td><td>End timestamp</td></tr> <tr><td>rebill_count</td><td>int</td><td>Number of recurring payments</td></tr> <tr><td>last_rebill_ts</td><td>int</td><td>Last rebill ts</td></tr> <tr><td>next_rebill_ts</td><td>int</td><td>Next rebill ts</td></tr> <tr><td>next_rebill_amount</td><td>int</td><td>Next rebill amount</td></tr> <tr><td>step_down</td><td>int</td><td>Step Down (charge amount reductions)</td></tr> <tr><td>order_id</td><td>int</td><td>Order ID</td></tr> <tr><td>description</td><td>int</td><td>Order Description</td></tr> <tr><td>rebill_amount</td><td>int</td><td>Rebill amount (not including next one)</td></tr> <tr><td>trial_unit</td><td>string</td><td>Trial Unit (day|week|month|year)</td></tr> <tr><td>rebill_unit</td><td>string</td><td>Rebill Unit (day|week|month|year)</td></tr> <tr><td>rebill_period</td><td>int</td><td>Rebill period</td></tr> <tr><td>max_rebill_count</td><td>int</td><td>Max Rebill Count</td></tr> <tr><td>trial_period</td><td>int</td><td>Trial period</td></tr> <tr><td>tracking_item</td><td>int</td><td>Tracking item ID</td></tr> <tr><td>pp_id</td><td>int</td><td>Payment Processor ID</td></tr> <tr><td>user_id</td><td>int</td><td>PV2 user ID</td></tr> <tr><td>hash</td><td>string</td><td>Hash</td></tr> <tr><td>first_name</td><td>int</td><td>Customer's First Name</td></tr> <tr><td>last_name</td><td>int</td><td>Customer's Last Name</td></tr> <tr><td>ppac_id</td><td>int</td><td>Payment Processor Account ID</td></tr> <tr><td>email</td><td>int</td><td>Customer's Email Address</td></tr> <tr><td>ptnr_id</td><td>int</td><td>Partner ID</td></tr> <tr><td>currency</td><td>string</td><td>Currency</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tracking Tag param</td></tr> <tr><td>ip</td><td>int</td><td>Customer's IP Address</td></tr> <tr><td>order_type</td><td>int</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>tracking_user</td><td>int</td><td>User ID on partners' site</td></tr> <tr><td>processor</td><td>int</td><td>Payment Processor's abreviation</td></tr> <tr><td>is_cancel</td><td>boolean</td><td>s/b true</td></tr> <tr><td>cancel_reason</td><td>string</td><td>Optional, not always sent. If it has value 'cancel_reason_rebill_bin_filter' it means that subscription was stopped because BIN used for purchase is not allowed to rebill.</td></tr> </table> = subscription.suspended Sent in case of suspended subscription (usually happens when we can't rebill user after defined number of attempts) Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>sub_id</td><td>int</td><td>Subscription ID</td></tr> <tr><td>item_id</td><td>int</td><td>Item ID</td></tr> <tr><td>status</td><td>string</td><td>Subscription status (s/b initial on create, rebill after 1st rebill)</td></tr> <tr><td>start_ts</td><td>int</td><td>Start timestamp</td></tr> <tr><td>change_ts</td><td>int</td><td>Change(edit) timestamp</td></tr> <tr><td>end_ts</td><td>int</td><td>End timestamp</td></tr> <tr><td>rebill_count</td><td>int</td><td>Number of recurring payments</td></tr> <tr><td>last_rebill_ts</td><td>int</td><td>Last rebill ts</td></tr> <tr><td>next_rebill_ts</td><td>int</td><td>Next rebill ts</td></tr> <tr><td>next_rebill_amount</td><td>int</td><td>Next rebill amount</td></tr> <tr><td>step_down</td><td>int</td><td>Step Down (charge amount reductions)</td></tr> <tr><td>order_id</td><td>int</td><td>Order ID</td></tr> <tr><td>description</td><td>int</td><td>Order Description</td></tr> <tr><td>rebill_amount</td><td>int</td><td>Rebill amount (not including next one)</td></tr> <tr><td>trial_unit</td><td>string</td><td>Trial Unit (day|week|month|year)</td></tr> <tr><td>rebill_unit</td><td>string</td><td>Rebill Unit (day|week|month|year)</td></tr> <tr><td>rebill_period</td><td>int</td><td>Rebill period</td></tr> <tr><td>max_rebill_count</td><td>int</td><td>Max Rebill Count</td></tr> <tr><td>trial_period</td><td>int</td><td>Trial period</td></tr> <tr><td>tracking_item</td><td>int</td><td>Tracking item ID</td></tr> <tr><td>pp_id</td><td>int</td><td>Payment Processor ID</td></tr> <tr><td>user_id</td><td>int</td><td>PV2 user ID</td></tr> <tr><td>hash</td><td>string</td><td>Hash</td></tr> <tr><td>first_name</td><td>int</td><td>Customer's First Name</td></tr> <tr><td>last_name</td><td>int</td><td>Customer's Last Name</td></tr> <tr><td>ppac_id</td><td>int</td><td>Payment Processor Account ID</td></tr> <tr><td>email</td><td>int</td><td>Customer's Email Address</td></tr> <tr><td>ptnr_id</td><td>int</td><td>Partner ID</td></tr> <tr><td>currency</td><td>string</td><td>Currency</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tracking Tag param</td></tr> <tr><td>ip</td><td>int</td><td>Customer's IP Address</td></tr> <tr><td>order_type</td><td>int</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>tracking_user</td><td>int</td><td>User ID on partners' site</td></tr> <tr><td>processor</td><td>int</td><td>Payment Processor's abreviation</td></tr> </table> = subscription.rebill Sent after successfully made rebill. It will be sent right after transaction.success Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>sub_id</td><td>int</td><td>Subscription ID</td></tr> <tr><td>item_id</td><td>int</td><td>Item ID</td></tr> <tr><td>status</td><td>string</td><td>Subscription status (s/b initial on create, rebill after 1st rebill)</td></tr> <tr><td>start_ts</td><td>int</td><td>Start timestamp</td></tr> <tr><td>change_ts</td><td>int</td><td>Change(edit) timestamp</td></tr> <tr><td>end_ts</td><td>int</td><td>End timestamp</td></tr> <tr><td>rebill_count</td><td>int</td><td>Number of recurring payments</td></tr> <tr><td>last_rebill_ts</td><td>int</td><td>Last rebill ts</td></tr> <tr><td>next_rebill_ts</td><td>int</td><td>Next rebill ts</td></tr> <tr><td>next_rebill_amount</td><td>int</td><td>Next rebill amount</td></tr> <tr><td>step_down</td><td>int</td><td>Step Down (charge amount reductions)</td></tr> <tr><td>order_id</td><td>int</td><td>Order ID</td></tr> <tr><td>description</td><td>int</td><td>Order Description</td></tr> <tr><td>rebill_amount</td><td>int</td><td>Rebill amount (not including next one)</td></tr> <tr><td>trial_unit</td><td>string</td><td>Trial Unit (day|week|month|year)</td></tr> <tr><td>rebill_unit</td><td>string</td><td>Rebill Unit (day|week|month|year)</td></tr> <tr><td>rebill_period</td><td>int</td><td>Rebill period</td></tr> <tr><td>max_rebill_count</td><td>int</td><td>Max Rebill Count</td></tr> <tr><td>trial_period</td><td>int</td><td>Trial period</td></tr> <tr><td>tracking_item</td><td>int</td><td>Tracking item ID</td></tr> <tr><td>pp_id</td><td>int</td><td>Payment Processor ID</td></tr> <tr><td>user_id</td><td>int</td><td>PV2 user ID</td></tr> <tr><td>hash</td><td>string</td><td>Hash</td></tr> <tr><td>first_name</td><td>int</td><td>Customer's First Name</td></tr> <tr><td>last_name</td><td>int</td><td>Customer's Last Name</td></tr> <tr><td>ppac_id</td><td>int</td><td>Payment Processor Account ID</td></tr> <tr><td>email</td><td>int</td><td>Customer's Email Address</td></tr> <tr><td>ptnr_id</td><td>int</td><td>Partner ID</td></tr> <tr><td>currency</td><td>string</td><td>Currency</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tracking Tag param</td></tr> <tr><td>ip</td><td>int</td><td>Customer's IP Address</td></tr> <tr><td>order_type</td><td>int</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>tracking_user</td><td>int</td><td>User ID on partners' site</td></tr> <tr><td>processor</td><td>int</td><td>Payment Processor's abreviation</td></tr> <tr><td>tran_id*</td><td>int</td><td>Last Transaction's ID</td></tr> </table> //* Not present for all payment processors// = subscription.completed Sent after completed subscription (happens only on subs with limited number of rebills). Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>sub_id</td><td>int</td><td>Subscription ID</td></tr> <tr><td>item_id</td><td>int</td><td>Item ID</td></tr> <tr><td>status</td><td>string</td><td>Subscription status (s/b initial on create, rebill after 1st rebill)</td></tr> <tr><td>start_ts</td><td>int</td><td>Start timestamp</td></tr> <tr><td>change_ts</td><td>int</td><td>Change(edit) timestamp</td></tr> <tr><td>end_ts</td><td>int</td><td>End timestamp</td></tr> <tr><td>rebill_count</td><td>int</td><td>Number of recurring payments</td></tr> <tr><td>last_rebill_ts</td><td>int</td><td>Last rebill ts</td></tr> <tr><td>next_rebill_ts</td><td>int</td><td>Next rebill ts</td></tr> <tr><td>next_rebill_amount</td><td>int</td><td>Next rebill amount</td></tr> <tr><td>step_down</td><td>int</td><td>Step Down (charge amount reductions)</td></tr> <tr><td>order_id</td><td>int</td><td>Order ID</td></tr> <tr><td>description</td><td>int</td><td>Order Description</td></tr> <tr><td>rebill_amount</td><td>int</td><td>Rebill amount (not including next one)</td></tr> <tr><td>trial_unit</td><td>string</td><td>Trial Unit (day|week|month|year)</td></tr> <tr><td>rebill_unit</td><td>string</td><td>Rebill Unit (day|week|month|year)</td></tr> <tr><td>rebill_period</td><td>int</td><td>Rebill period</td></tr> <tr><td>max_rebill_count</td><td>int</td><td>Max Rebill Count</td></tr> <tr><td>trial_period</td><td>int</td><td>Trial period</td></tr> <tr><td>tracking_item</td><td>int</td><td>Tracking item ID</td></tr> <tr><td>pp_id</td><td>int</td><td>Payment Processor ID</td></tr> <tr><td>user_id</td><td>int</td><td>PV2 user ID</td></tr> <tr><td>hash</td><td>string</td><td>Hash</td></tr> <tr><td>first_name</td><td>int</td><td>Customer's First Name</td></tr> <tr><td>last_name</td><td>int</td><td>Customer's Last Name</td></tr> <tr><td>ppac_id</td><td>int</td><td>Payment Processor Account ID</td></tr> <tr><td>email</td><td>int</td><td>Customer's Email Address</td></tr> <tr><td>ptnr_id</td><td>int</td><td>Partner ID</td></tr> <tr><td>currency</td><td>string</td><td>Currency</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tracking Tag param</td></tr> <tr><td>ip</td><td>int</td><td>Customer's IP Address</td></tr> <tr><td>order_type</td><td>int</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>tracking_user</td><td>int</td><td>User ID on partners' site</td></tr> <tr><td>processor</td><td>int</td><td>Payment Processor's abreviation</td></tr> </table> = subscription.change Sent in when subscription is changed (action initiated via `subscription.change` api call) Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>sub_id</td><td>int</td><td>Subscription ID</td></tr> <tr><td>item_id</td><td>int</td><td>Item ID</td></tr> <tr><td>status</td><td>string</td><td>Subscription status (s/b initial on create, rebill after 1st rebill)</td></tr> <tr><td>start_ts</td><td>int</td><td>Start timestamp</td></tr> <tr><td>change_ts</td><td>int</td><td>Change(edit) timestamp</td></tr> <tr><td>end_ts</td><td>int</td><td>End timestamp</td></tr> <tr><td>rebill_count</td><td>int</td><td>Number of recurring payments</td></tr> <tr><td>last_rebill_ts</td><td>int</td><td>Last rebill ts</td></tr> <tr><td>next_rebill_ts</td><td>int</td><td>Next rebill ts</td></tr> <tr><td>next_rebill_amount</td><td>int</td><td>Next rebill amount</td></tr> <tr><td>step_down</td><td>int</td><td>Step Down (charge amount reductions)</td></tr> <tr><td>order_id</td><td>int</td><td>Order ID</td></tr> <tr><td>description</td><td>int</td><td>Order Description</td></tr> <tr><td>rebill_amount</td><td>int</td><td>Rebill amount (not including next one)</td></tr> <tr><td>trial_unit</td><td>string</td><td>Trial Unit (day|week|month|year)</td></tr> <tr><td>rebill_unit</td><td>string</td><td>Rebill Unit (day|week|month|year)</td></tr> <tr><td>rebill_period</td><td>int</td><td>Rebill period</td></tr> <tr><td>max_rebill_count</td><td>int</td><td>Max Rebill Count</td></tr> <tr><td>trial_period</td><td>int</td><td>Trial period</td></tr> <tr><td>tracking_item</td><td>int</td><td>Tracking item ID</td></tr> <tr><td>pp_id</td><td>int</td><td>Payment Processor ID</td></tr> <tr><td>user_id</td><td>int</td><td>PV2 user ID</td></tr> <tr><td>hash</td><td>string</td><td>Hash</td></tr> <tr><td>first_name</td><td>int</td><td>Customer's First Name</td></tr> <tr><td>last_name</td><td>int</td><td>Customer's Last Name</td></tr> <tr><td>ppac_id</td><td>int</td><td>Payment Processor Account ID</td></tr> <tr><td>email</td><td>int</td><td>Customer's Email Address</td></tr> <tr><td>ptnr_id</td><td>int</td><td>Partner ID</td></tr> <tr><td>currency</td><td>string</td><td>Currency</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tracking Tag param</td></tr> <tr><td>ip</td><td>int</td><td>Customer's IP Address</td></tr> <tr><td>order_type</td><td>int</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>tracking_user</td><td>int</td><td>User ID on partners' site</td></tr> <tr><td>processor</td><td>int</td><td>Payment Processor's abreviation</td></tr> </table> = subscriptions.prerebill (WIP) Sent from cron job that runs at 1h frequency. Data consists of subscriptions that are due to rebill in next X days, where X is configurable from cron manager. (one value of X per one cron job instance) Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>interval</td><td>string</td><td>When from now should rebill happen ('2 day', '3 day', 'X day')</td></tr> <tr><td>subscriptions</td><td>array</td><td>Array of data related to subscriptions rebills (see below)</td></tr> </table> Subscriptions array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>sub_id</td><td>int</td><td>Subscription ID</td></tr> <tr><td>next_rebill_ts</td><td>int</td><td>Next rebill timestamp</td></tr> <tr><td>ptnr_id</td><td>int</td><td>Partner ID</td></tr> <tr><td>tracking_user</td><td>int</td><td>User ID on partners' site</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tracking Tag param</td></tr> <tr><td>bin</td><td>string</td><td>BIN of card for this susbcription</td></tr> <tr><td>ccnum_last4</td><td>string</td><td>Last 4 digits of card for this susbcription</td></tr> <tr><td>currency</td><td>string</td><td>Currency</td></tr> <tr><td>order_type</td><td>string</td><td>Order type ('basic' | 'xsale')</td></tr> <tr><td>item_id</td><td>int</td><td>Item ID</td></tr> <tr><td>cc_type</td><td>string</td><td>Card type ('visa' ...)</td></tr> <tr><td>pp_name</td><td>string</td><td>PP Name</td></tr> <tr><td>bin_high_risk</td><td>int</td><td>Is BIN on High Risk List (1|0)</td></tr> <tr><td>bin_blocked_for_rebill</td><td>int</td><td>Is BIN blocked for rebill (1|0)</td></tr> </table>

= Content [[ public/payment/partners/notifications/#transaction-success | transaction.success ]] [[ public/payment/partners/notifications/#transaction-failed | transaction.failed ]] [[ public/payment/partners/notifications/#subscription-created | subscription.created ]] [[ public/payment/partners/notifications/#subscription-trial | subscription.trial ]] [[ public/payment/partners/notifications/#subscription-stopped | subscription.stopped ]] [[ public/payment/partners/notifications/#subscription-suspended | subscription.suspended ]] [[ public/payment/partners/notifications/#subscription-rebill | subscription.rebill ]] [[ public/payment/partners/notifications/#subscription-completed | subscription.completed ]] [[ public/payment/partners/notifications/#subscription-change | subscription.change ]] [[ public/payment/partners/notifications/#subscriptions-prerebill | subscriptions.prerebill ]] ------ PV2 is sending notifications to our partners regarding various actions on PV2. Notifications are always sent to the same URL defined for each partner along with hash and other related data. If partner doesn't respond to notification, PV2 will try to resend it. Generally notifications will be sent in this format: <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr> <td>command</td><td>string</td><td>The command that needs to be executed</td> </tr> <tr> <td>hash</td><td>string</td><td>Hash</td> </tr> <tr> <td>data</td><td>string</td><td>json encoded string with data array</td> </tr> </table> After receiving notification partner should respond with [[public/payment/partners/apidocs/notifications.hash.validate|notifications.hash.validate]] api call by sending received hash back, otherwise notification will be resent with this schedulle: # After 1 minute # After 5 minutes # After 15 minutes # After 30 minutes # After 30 minutes notifications.hash.validate call also has another important purpose, so partners can validate if the notification actually came from us. This is list of notifications which will be send out. = transaction.success Sent in case of successful transaction. Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>tran_id</td><td>int</td><td>**Transaction** ID</td></tr> <tr><td>ptnr_id</td><td>int</td><td>**Partner** ID</td></tr> <tr><td>ppac_id</td><td>int</td><td>**Payment Processor Account** ID</td></tr> <tr><td>order_id</td><td>int</td><td>**Order** ID</td></tr> <tr><td>ccdt_id</td><td>int</td><td>Credit Card Details ID</td></tr> <tr><td>transaction_type</td><td>string</td><td>Transaction Type. Values: `s` (sale), `a` (auth), `r` (refund), `c` (chargeback), `f` (fake)</td></tr> <tr><td>amount</td><td>string</td><td>Amount</td></tr> <tr><td>currency</td><td>string</td><td>Currency (3 Letter ISO Code)</td></tr> <tr><td>description</td><td>string</td><td>Description</td></tr> <tr><td>status</td><td>string</td><td>Transaction status. Values: `failed`, `successful`</td></tr> <tr><td>refunded_tran_id</td><td>int</td><td>Refunded **Transaction** ID</td></tr> <tr><td>origin</td><td>string</td><td>Origin. Values: `direct`, `system`</td></tr> <tr><td>ts</td><td>int</td><td>Timestamp</td></tr> <tr><td>status_code</td><td>int</td><td>Status code</td></tr> <tr><td>payment_code</td><td>int</td><td>[[ public/payment/partners/codes/ | Payment Code ]] (700 on success)</td></tr> <tr><td>order_type</td><td>string</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>pp_id</td><td>int</td><td>**Payment Processor** ID</td></tr> <tr><td>processor</td><td>string</td><td>**Payment Processor** abbreviation</td></tr> <tr><td>user_id</td><td>int</td><td>User ID in **Payment Application**</td></tr> <tr><td>tracking_user</td><td>int</td><td>User Identifier from **Partner**</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tag ID from **Partner**</td></tr> <tr><td>items</td><td>array</td><td>Array of items</td></tr> <tr><td>merchant*</td><td>array</td><td>Array of fields that identify merchant account**</td></tr> </table> *//Processor dependant, may not be sent for all processors - currently only RocketGate and Payon use this field// **//For RocketGate transaction, merchant is [merchant_id, merchant_account], for Payon it is [channel]// = transaction.failed Sent in case of failed transaction. Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>tran_id</td><td>int</td><td>**Transaction** ID</td></tr> <tr><td>ptnr_id</td><td>int</td><td>**Partner** ID</td></tr> <tr><td>ppac_id</td><td>int</td><td>**Payment Processor Account** ID</td></tr> <tr><td>order_id</td><td>int</td><td>**Order** ID</td></tr> <tr><td>ccdt_id</td><td>int</td><td>Credit Card Details ID</td></tr> <tr><td>transaction_type</td><td>string</td><td>Transaction Type. Values: `s` (sale), `a` (auth), `r` (refund), `c` (chargeback), `f` (fake)</td></tr> <tr><td>amount</td><td>string</td><td>Amount</td></tr> <tr><td>currency</td><td>string</td><td>Currency (3 Letter ISO Code)</td></tr> <tr><td>description</td><td>string</td><td>Description</td></tr> <tr><td>status</td><td>string</td><td>Transaction status. Values: `failed`, `successful`</td></tr> <tr><td>refunded_tran_id</td><td>int</td><td>Refunded **Transaction** ID</td></tr> <tr><td>origin</td><td>string</td><td>Origin. Values: `direct`, `system`</td></tr> <tr><td>ts</td><td>int</td><td>Timestamp</td></tr> <tr><td>status_code</td><td>int</td><td>Status code</td></tr> <tr><td>payment_code</td><td>int</td><td>[[ public/payment/partners/codes/ | Payment Code ]] (700 on success)</td></tr> <tr><td>order_type</td><td>string</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>pp_id</td><td>int</td><td>**Payment Processor** ID</td></tr> <tr><td>processor</td><td>string</td><td>**Payment Processor** abbreviation</td></tr> <tr><td>user_id</td><td>int</td><td>User ID in **Payment Application**</td></tr> <tr><td>tracking_user</td><td>int</td><td>User Identifier from **Partner**</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tag ID from **Partner**</td></tr> <tr><td>items</td><td>array</td><td>Array of items</td></tr> <tr><td>merchant*</td><td>array</td><td>Array of fields that identify merchant account**</td></tr> </table> *//Processor dependant, may not be sent for all processors - currently only RocketGate and Payon use this field// **//For RocketGate transaction, merchant is [merchant_id, merchant_account], for Payon it is [channel]// = subscription.created Sent in case of successfully created subscription Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>sub_id</td><td>int</td><td>Subscription ID</td></tr> <tr><td>item_id</td><td>int</td><td>Item ID</td></tr> <tr><td>status</td><td>string</td><td>Subscription status (s/b initial on create, rebill after 1st rebill)</td></tr> <tr><td>start_ts</td><td>int</td><td>Start timestamp</td></tr> <tr><td>change_ts</td><td>int</td><td>Change(edit) timestamp</td></tr> <tr><td>end_ts</td><td>int</td><td>End timestamp</td></tr> <tr><td>rebill_count</td><td>int</td><td>Number of recurring payments</td></tr> <tr><td>last_rebill_ts</td><td>int</td><td>Last rebill ts</td></tr> <tr><td>next_rebill_ts</td><td>int</td><td>Next rebill ts</td></tr> <tr><td>next_rebill_amount</td><td>int</td><td>Next rebill amount</td></tr> <tr><td>step_down</td><td>int</td><td>Step Down (charge amount reductions)</td></tr> <tr><td>order_id</td><td>int</td><td>Order ID</td></tr> <tr><td>description</td><td>int</td><td>Order Description</td></tr> <tr><td>rebill_amount</td><td>int</td><td>Rebill amount (not including next one)</td></tr> <tr><td>trial_unit</td><td>string</td><td>Trial Unit (day|week|month|year)</td></tr> <tr><td>rebill_unit</td><td>string</td><td>Rebill Unit (day|week|month|year)</td></tr> <tr><td>rebill_period</td><td>int</td><td>Rebill period</td></tr> <tr><td>max_rebill_count</td><td>int</td><td>Max Rebill Count</td></tr> <tr><td>trial_period</td><td>int</td><td>Trial period</td></tr> <tr><td>tracking_item</td><td>int</td><td>Tracking item ID</td></tr> <tr><td>pp_id</td><td>int</td><td>Payment Processor ID</td></tr> <tr><td>user_id</td><td>int</td><td>PV2 user ID</td></tr> <tr><td>hash</td><td>string</td><td>Hash</td></tr> <tr><td>first_name</td><td>int</td><td>Customer's First Name</td></tr> <tr><td>last_name</td><td>int</td><td>Customer's Last Name</td></tr> <tr><td>ppac_id</td><td>int</td><td>Payment Processor Account ID</td></tr> <tr><td>email</td><td>int</td><td>Customer's Email Address</td></tr> <tr><td>ptnr_id</td><td>int</td><td>Partner ID</td></tr> <tr><td>currency</td><td>string</td><td>Currency</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tracking Tag param</td></tr> <tr><td>ip</td><td>int</td><td>Customer's IP Address</td></tr> <tr><td>order_type</td><td>int</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>tracking_user</td><td>int</td><td>User ID on partners' site</td></tr> <tr><td>processor</td><td>int</td><td>Payment Processor's abreviation</td></tr> <tr><td>tran_id*</td><td>int</td><td>Last Transaction's ID</td></tr> </table> //* Not present for all payment processors// = subscription.trial Sent in case of successfully created subscription <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>sub_id</td><td>int</td><td>Subscription ID</td></tr> <tr><td>item_id</td><td>int</td><td>Item ID</td></tr> <tr><td>status</td><td>string</td><td>Subscription status (s/b initial on create, rebill after 1st rebill)</td></tr> <tr><td>start_ts</td><td>int</td><td>Start timestamp</td></tr> <tr><td>change_ts</td><td>int</td><td>Change(edit) timestamp</td></tr> <tr><td>end_ts</td><td>int</td><td>End timestamp</td></tr> <tr><td>rebill_count</td><td>int</td><td>Number of recurring payments</td></tr> <tr><td>last_rebill_ts</td><td>int</td><td>Last rebill ts</td></tr> <tr><td>next_rebill_ts</td><td>int</td><td>Next rebill ts</td></tr> <tr><td>next_rebill_amount</td><td>int</td><td>Next rebill amount</td></tr> <tr><td>step_down</td><td>int</td><td>Step Down (charge amount reductions)</td></tr> <tr><td>order_id</td><td>int</td><td>Order ID</td></tr> <tr><td>description</td><td>int</td><td>Order Description</td></tr> <tr><td>rebill_amount</td><td>int</td><td>Rebill amount (not including next one)</td></tr> <tr><td>trial_unit</td><td>string</td><td>Trial Unit (day|week|month|year)</td></tr> <tr><td>rebill_unit</td><td>string</td><td>Rebill Unit (day|week|month|year)</td></tr> <tr><td>rebill_period</td><td>int</td><td>Rebill period</td></tr> <tr><td>max_rebill_count</td><td>int</td><td>Max Rebill Count</td></tr> <tr><td>trial_period</td><td>int</td><td>Trial period</td></tr> <tr><td>tracking_item</td><td>int</td><td>Tracking item ID</td></tr> <tr><td>pp_id</td><td>int</td><td>Payment Processor ID</td></tr> <tr><td>user_id</td><td>int</td><td>PV2 user ID</td></tr> <tr><td>hash</td><td>string</td><td>Hash</td></tr> <tr><td>first_name</td><td>int</td><td>Customer's First Name</td></tr> <tr><td>last_name</td><td>int</td><td>Customer's Last Name</td></tr> <tr><td>ppac_id</td><td>int</td><td>Payment Processor Account ID</td></tr> <tr><td>email</td><td>int</td><td>Customer's Email Address</td></tr> <tr><td>ptnr_id</td><td>int</td><td>Partner ID</td></tr> <tr><td>currency</td><td>string</td><td>Currency</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tracking Tag param</td></tr> <tr><td>ip</td><td>int</td><td>Customer's IP Address</td></tr> <tr><td>order_type</td><td>int</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>tracking_user</td><td>int</td><td>User ID on partners' site</td></tr> <tr><td>processor</td><td>int</td><td>Payment Processor's abreviation</td></tr> <tr><td>tran_id*</td><td>int</td><td>Last Transaction's ID</td></tr> </table> //* Not present for all payment processors// = subscription.stopped Sent in case of stopped subscription (action initiated via api call) Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>sub_id</td><td>int</td><td>Subscription ID</td></tr> <tr><td>item_id</td><td>int</td><td>Item ID</td></tr> <tr><td>status</td><td>string</td><td>Subscription status (s/b initial on create, rebill after 1st rebill)</td></tr> <tr><td>start_ts</td><td>int</td><td>Start timestamp</td></tr> <tr><td>change_ts</td><td>int</td><td>Change(edit) timestamp</td></tr> <tr><td>end_ts</td><td>int</td><td>End timestamp</td></tr> <tr><td>rebill_count</td><td>int</td><td>Number of recurring payments</td></tr> <tr><td>last_rebill_ts</td><td>int</td><td>Last rebill ts</td></tr> <tr><td>next_rebill_ts</td><td>int</td><td>Next rebill ts</td></tr> <tr><td>next_rebill_amount</td><td>int</td><td>Next rebill amount</td></tr> <tr><td>step_down</td><td>int</td><td>Step Down (charge amount reductions)</td></tr> <tr><td>order_id</td><td>int</td><td>Order ID</td></tr> <tr><td>description</td><td>int</td><td>Order Description</td></tr> <tr><td>rebill_amount</td><td>int</td><td>Rebill amount (not including next one)</td></tr> <tr><td>trial_unit</td><td>string</td><td>Trial Unit (day|week|month|year)</td></tr> <tr><td>rebill_unit</td><td>string</td><td>Rebill Unit (day|week|month|year)</td></tr> <tr><td>rebill_period</td><td>int</td><td>Rebill period</td></tr> <tr><td>max_rebill_count</td><td>int</td><td>Max Rebill Count</td></tr> <tr><td>trial_period</td><td>int</td><td>Trial period</td></tr> <tr><td>tracking_item</td><td>int</td><td>Tracking item ID</td></tr> <tr><td>pp_id</td><td>int</td><td>Payment Processor ID</td></tr> <tr><td>user_id</td><td>int</td><td>PV2 user ID</td></tr> <tr><td>hash</td><td>string</td><td>Hash</td></tr> <tr><td>first_name</td><td>int</td><td>Customer's First Name</td></tr> <tr><td>last_name</td><td>int</td><td>Customer's Last Name</td></tr> <tr><td>ppac_id</td><td>int</td><td>Payment Processor Account ID</td></tr> <tr><td>email</td><td>int</td><td>Customer's Email Address</td></tr> <tr><td>ptnr_id</td><td>int</td><td>Partner ID</td></tr> <tr><td>currency</td><td>string</td><td>Currency</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tracking Tag param</td></tr> <tr><td>ip</td><td>int</td><td>Customer's IP Address</td></tr> <tr><td>order_type</td><td>int</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>tracking_user</td><td>int</td><td>User ID on partners' site</td></tr> <tr><td>processor</td><td>int</td><td>Payment Processor's abreviation</td></tr> <tr><td>is_cancel</td><td>boolean</td><td>s/b true</td></tr> <tr><td>cancel_reason</td><td>string</td><td>Optional, not always sent. If it has value 'cancel_reason_rebill_bin_filter' it means that subscription was stopped because BIN used for purchase is not allowed to rebill.</td></tr> </table> = subscription.suspended Sent in case of suspended subscription (usually happens when we can't rebill user after defined number of attempts) Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>sub_id</td><td>int</td><td>Subscription ID</td></tr> <tr><td>item_id</td><td>int</td><td>Item ID</td></tr> <tr><td>status</td><td>string</td><td>Subscription status (s/b initial on create, rebill after 1st rebill)</td></tr> <tr><td>start_ts</td><td>int</td><td>Start timestamp</td></tr> <tr><td>change_ts</td><td>int</td><td>Change(edit) timestamp</td></tr> <tr><td>end_ts</td><td>int</td><td>End timestamp</td></tr> <tr><td>rebill_count</td><td>int</td><td>Number of recurring payments</td></tr> <tr><td>last_rebill_ts</td><td>int</td><td>Last rebill ts</td></tr> <tr><td>next_rebill_ts</td><td>int</td><td>Next rebill ts</td></tr> <tr><td>next_rebill_amount</td><td>int</td><td>Next rebill amount</td></tr> <tr><td>step_down</td><td>int</td><td>Step Down (charge amount reductions)</td></tr> <tr><td>order_id</td><td>int</td><td>Order ID</td></tr> <tr><td>description</td><td>int</td><td>Order Description</td></tr> <tr><td>rebill_amount</td><td>int</td><td>Rebill amount (not including next one)</td></tr> <tr><td>trial_unit</td><td>string</td><td>Trial Unit (day|week|month|year)</td></tr> <tr><td>rebill_unit</td><td>string</td><td>Rebill Unit (day|week|month|year)</td></tr> <tr><td>rebill_period</td><td>int</td><td>Rebill period</td></tr> <tr><td>max_rebill_count</td><td>int</td><td>Max Rebill Count</td></tr> <tr><td>trial_period</td><td>int</td><td>Trial period</td></tr> <tr><td>tracking_item</td><td>int</td><td>Tracking item ID</td></tr> <tr><td>pp_id</td><td>int</td><td>Payment Processor ID</td></tr> <tr><td>user_id</td><td>int</td><td>PV2 user ID</td></tr> <tr><td>hash</td><td>string</td><td>Hash</td></tr> <tr><td>first_name</td><td>int</td><td>Customer's First Name</td></tr> <tr><td>last_name</td><td>int</td><td>Customer's Last Name</td></tr> <tr><td>ppac_id</td><td>int</td><td>Payment Processor Account ID</td></tr> <tr><td>email</td><td>int</td><td>Customer's Email Address</td></tr> <tr><td>ptnr_id</td><td>int</td><td>Partner ID</td></tr> <tr><td>currency</td><td>string</td><td>Currency</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tracking Tag param</td></tr> <tr><td>ip</td><td>int</td><td>Customer's IP Address</td></tr> <tr><td>order_type</td><td>int</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>tracking_user</td><td>int</td><td>User ID on partners' site</td></tr> <tr><td>processor</td><td>int</td><td>Payment Processor's abreviation</td></tr> </table> = subscription.rebill Sent after successfully made rebill. It will be sent right after transaction.success Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>sub_id</td><td>int</td><td>Subscription ID</td></tr> <tr><td>item_id</td><td>int</td><td>Item ID</td></tr> <tr><td>status</td><td>string</td><td>Subscription status (s/b initial on create, rebill after 1st rebill)</td></tr> <tr><td>start_ts</td><td>int</td><td>Start timestamp</td></tr> <tr><td>change_ts</td><td>int</td><td>Change(edit) timestamp</td></tr> <tr><td>end_ts</td><td>int</td><td>End timestamp</td></tr> <tr><td>rebill_count</td><td>int</td><td>Number of recurring payments</td></tr> <tr><td>last_rebill_ts</td><td>int</td><td>Last rebill ts</td></tr> <tr><td>next_rebill_ts</td><td>int</td><td>Next rebill ts</td></tr> <tr><td>next_rebill_amount</td><td>int</td><td>Next rebill amount</td></tr> <tr><td>step_down</td><td>int</td><td>Step Down (charge amount reductions)</td></tr> <tr><td>order_id</td><td>int</td><td>Order ID</td></tr> <tr><td>description</td><td>int</td><td>Order Description</td></tr> <tr><td>rebill_amount</td><td>int</td><td>Rebill amount (not including next one)</td></tr> <tr><td>trial_unit</td><td>string</td><td>Trial Unit (day|week|month|year)</td></tr> <tr><td>rebill_unit</td><td>string</td><td>Rebill Unit (day|week|month|year)</td></tr> <tr><td>rebill_period</td><td>int</td><td>Rebill period</td></tr> <tr><td>max_rebill_count</td><td>int</td><td>Max Rebill Count</td></tr> <tr><td>trial_period</td><td>int</td><td>Trial period</td></tr> <tr><td>tracking_item</td><td>int</td><td>Tracking item ID</td></tr> <tr><td>pp_id</td><td>int</td><td>Payment Processor ID</td></tr> <tr><td>user_id</td><td>int</td><td>PV2 user ID</td></tr> <tr><td>hash</td><td>string</td><td>Hash</td></tr> <tr><td>first_name</td><td>int</td><td>Customer's First Name</td></tr> <tr><td>last_name</td><td>int</td><td>Customer's Last Name</td></tr> <tr><td>ppac_id</td><td>int</td><td>Payment Processor Account ID</td></tr> <tr><td>email</td><td>int</td><td>Customer's Email Address</td></tr> <tr><td>ptnr_id</td><td>int</td><td>Partner ID</td></tr> <tr><td>currency</td><td>string</td><td>Currency</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tracking Tag param</td></tr> <tr><td>ip</td><td>int</td><td>Customer's IP Address</td></tr> <tr><td>order_type</td><td>int</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>tracking_user</td><td>int</td><td>User ID on partners' site</td></tr> <tr><td>processor</td><td>int</td><td>Payment Processor's abreviation</td></tr> <tr><td>tran_id*</td><td>int</td><td>Last Transaction's ID</td></tr> </table> //* Not present for all payment processors// = subscription.completed Sent after completed subscription (happens only on subs with limited number of rebills). Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>sub_id</td><td>int</td><td>Subscription ID</td></tr> <tr><td>item_id</td><td>int</td><td>Item ID</td></tr> <tr><td>status</td><td>string</td><td>Subscription status (s/b initial on create, rebill after 1st rebill)</td></tr> <tr><td>start_ts</td><td>int</td><td>Start timestamp</td></tr> <tr><td>change_ts</td><td>int</td><td>Change(edit) timestamp</td></tr> <tr><td>end_ts</td><td>int</td><td>End timestamp</td></tr> <tr><td>rebill_count</td><td>int</td><td>Number of recurring payments</td></tr> <tr><td>last_rebill_ts</td><td>int</td><td>Last rebill ts</td></tr> <tr><td>next_rebill_ts</td><td>int</td><td>Next rebill ts</td></tr> <tr><td>next_rebill_amount</td><td>int</td><td>Next rebill amount</td></tr> <tr><td>step_down</td><td>int</td><td>Step Down (charge amount reductions)</td></tr> <tr><td>order_id</td><td>int</td><td>Order ID</td></tr> <tr><td>description</td><td>int</td><td>Order Description</td></tr> <tr><td>rebill_amount</td><td>int</td><td>Rebill amount (not including next one)</td></tr> <tr><td>trial_unit</td><td>string</td><td>Trial Unit (day|week|month|year)</td></tr> <tr><td>rebill_unit</td><td>string</td><td>Rebill Unit (day|week|month|year)</td></tr> <tr><td>rebill_period</td><td>int</td><td>Rebill period</td></tr> <tr><td>max_rebill_count</td><td>int</td><td>Max Rebill Count</td></tr> <tr><td>trial_period</td><td>int</td><td>Trial period</td></tr> <tr><td>tracking_item</td><td>int</td><td>Tracking item ID</td></tr> <tr><td>pp_id</td><td>int</td><td>Payment Processor ID</td></tr> <tr><td>user_id</td><td>int</td><td>PV2 user ID</td></tr> <tr><td>hash</td><td>string</td><td>Hash</td></tr> <tr><td>first_name</td><td>int</td><td>Customer's First Name</td></tr> <tr><td>last_name</td><td>int</td><td>Customer's Last Name</td></tr> <tr><td>ppac_id</td><td>int</td><td>Payment Processor Account ID</td></tr> <tr><td>email</td><td>int</td><td>Customer's Email Address</td></tr> <tr><td>ptnr_id</td><td>int</td><td>Partner ID</td></tr> <tr><td>currency</td><td>string</td><td>Currency</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tracking Tag param</td></tr> <tr><td>ip</td><td>int</td><td>Customer's IP Address</td></tr> <tr><td>order_type</td><td>int</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>tracking_user</td><td>int</td><td>User ID on partners' site</td></tr> <tr><td>processor</td><td>int</td><td>Payment Processor's abreviation</td></tr> </table> = subscription.change Sent in when subscription is changed (action initiated via `subscription.change` api call) Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>sub_id</td><td>int</td><td>Subscription ID</td></tr> <tr><td>item_id</td><td>int</td><td>Item ID</td></tr> <tr><td>status</td><td>string</td><td>Subscription status (s/b initial on create, rebill after 1st rebill)</td></tr> <tr><td>start_ts</td><td>int</td><td>Start timestamp</td></tr> <tr><td>change_ts</td><td>int</td><td>Change(edit) timestamp</td></tr> <tr><td>end_ts</td><td>int</td><td>End timestamp</td></tr> <tr><td>rebill_count</td><td>int</td><td>Number of recurring payments</td></tr> <tr><td>last_rebill_ts</td><td>int</td><td>Last rebill ts</td></tr> <tr><td>next_rebill_ts</td><td>int</td><td>Next rebill ts</td></tr> <tr><td>next_rebill_amount</td><td>int</td><td>Next rebill amount</td></tr> <tr><td>step_down</td><td>int</td><td>Step Down (charge amount reductions)</td></tr> <tr><td>order_id</td><td>int</td><td>Order ID</td></tr> <tr><td>description</td><td>int</td><td>Order Description</td></tr> <tr><td>rebill_amount</td><td>int</td><td>Rebill amount (not including next one)</td></tr> <tr><td>trial_unit</td><td>string</td><td>Trial Unit (day|week|month|year)</td></tr> <tr><td>rebill_unit</td><td>string</td><td>Rebill Unit (day|week|month|year)</td></tr> <tr><td>rebill_period</td><td>int</td><td>Rebill period</td></tr> <tr><td>max_rebill_count</td><td>int</td><td>Max Rebill Count</td></tr> <tr><td>trial_period</td><td>int</td><td>Trial period</td></tr> <tr><td>tracking_item</td><td>int</td><td>Tracking item ID</td></tr> <tr><td>pp_id</td><td>int</td><td>Payment Processor ID</td></tr> <tr><td>user_id</td><td>int</td><td>PV2 user ID</td></tr> <tr><td>hash</td><td>string</td><td>Hash</td></tr> <tr><td>first_name</td><td>int</td><td>Customer's First Name</td></tr> <tr><td>last_name</td><td>int</td><td>Customer's Last Name</td></tr> <tr><td>ppac_id</td><td>int</td><td>Payment Processor Account ID</td></tr> <tr><td>email</td><td>int</td><td>Customer's Email Address</td></tr> <tr><td>ptnr_id</td><td>int</td><td>Partner ID</td></tr> <tr><td>currency</td><td>string</td><td>Currency</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tracking Tag param</td></tr> <tr><td>ip</td><td>int</td><td>Customer's IP Address</td></tr> <tr><td>order_type</td><td>int</td><td>Order type. Values: `basic`, `xsale`</td></tr> <tr><td>tracking_user</td><td>int</td><td>User ID on partners' site</td></tr> <tr><td>processor</td><td>int</td><td>Payment Processor's abreviation</td></tr> </table> = subscriptions.prerebill (WIP) Sent from cron job that runs at 1h frequency. Data consists of subscriptions that are due to rebill in next X days, where X is configurable from cron manager. (one value of X per one cron job instance) Data array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>interval</td><td>string</td><td>When from now should rebill happen ('2 day', '3 day', 'X day')</td></tr> <tr><td>subscriptions</td><td>array</td><td>Array of data related to subscriptions rebills (see below)</td></tr> </table> Subscriptions array (json encoded) <table> <tr> <th>Param Name</th><th>Type</th><th>Description</th> </tr> <tr><td>sub_id</td><td>int</td><td>Subscription ID</td></tr> <tr><td>next_rebill_ts</td><td>int</td><td>Next rebill timestamp</td></tr> <tr><td>ptnr_id</td><td>int</td><td>Partner ID</td></tr> <tr><td>tracking_user</td><td>int</td><td>User ID on partners' site</td></tr> <tr><td>tracking_tag</td><td>int</td><td>Tracking Tag param</td></tr> <tr><td>bin</td><td>string</td><td>BIN of card for this susbcription</td></tr> <tr><td>ccnum_last4</td><td>string</td><td>Last 4 digits of card for this susbcription</td></tr> <tr><td>currency</td><td>string</td><td>Currency</td></tr> <tr><td>order_type</td><td>string</td><td>Order type ('basic' | 'xsale')</td></tr> <tr><td>item_id</td><td>int</td><td>Item ID</td></tr> <tr><td>cc_type</td><td>string</td><td>Card type ('visa' ...)</td></tr> <tr><td>pp_name</td><td>string</td><td>PP Name</td></tr> <tr><td>bin_high_risk</td><td>int</td><td>Is BIN on High Risk List (1|0)</td></tr> <tr><td>bin_blocked_for_rebill</td><td>int</td><td>Is BIN blocked for rebill (1|0)</td></tr> </table>