Partner Notifications
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:
| Param Name | Type | Description |
|---|---|---|
| command | string | The command that needs to be executed |
| hash | string | Hash |
| data | string | json encoded string with data array |
After receiving notification partner should respond with 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)
| Param Name | Type | Description |
|---|---|---|
| tran_id | int | Transaction ID |
| status | string | Transaction status |
| ccdt_id | int | ccdt ID |
| transaction_type | string | Transaction Type (S for Sale, A for Auth, R for refund) |
| payment_code | int | Payment Code (700 on success) |
| user_id | int | PV2 user ID |
| tracking_user | int | User ID on partners' site |
| ptnr_id | int | Partner ID |
| items | array | array of items |
transaction.failed
Sent in case of failed transaction.
Data array (json encoded)
| Param Name | Type | Description |
|---|---|---|
| tran_id | int | Transaction ID |
| status | string | Transaction status |
| ccdt_id | int | ccdt ID |
| transaction_type | string | Transaction Type (S for Sale, A for Auth, R for refund) |
| payment_code | int | Payment Code |
| user_id | int | PV2 user ID |
| tracking_user | int | User ID on partners' site |
| ptnr_id | int | Partner ID |
| items | array | array of items |
subscription.created
Sent in case of successfully created subscription
Data array (json encoded)
| Param Name | Type | Description |
|---|---|---|
| sub_id | int | Subscription ID |
| item_id | int | Item ID |
| status | string | Subscription status (s/b initial on create, rebill after 1st rebill) |
| start_ts | int | Start timestamp |
| user_id | int | PV2 user ID |
| tracking_user | int | User ID on partners' site |
| ptnr_id | int | Partner ID |
| tracking_tag | int | Tracking Tag param |
| currency | string | Currency |
| hash | string | Hash |
| pp_name | string | PP Name |
| trial_unit | string | Trial Unit (day|week|month|year) |
| trial_period | int | Trial period |
| rebill_unit | string | Rebill Unit (day|week|month|year) |
| rebill_period | int | Rebill period |
| max_rebill_count | int | Max Rebill Count |
| tracking_item | int | Tracking item ID |
| next_rebill_ts | int | Next rebill ts |
| last_rebill_ts | int | Last rebill ts |
subscription.trial
Sent in case of successfully created subscription
Data array (json encoded)
| Param Name | Type | Description |
|---|---|---|
| sub_id | int | Subscription ID |
| item_id | int | Item ID |
| status | string | Subscription status (s/b initial on create, rebill after 1st rebill) |
| start_ts | int | Start timestamp |
| user_id | int | PV2 user ID |
| tracking_user | int | User ID on partners' site |
| ptnr_id | int | Partner ID |
| tracking_tag | int | Tracking Tag param |
| currency | string | Currency |
| hash | string | Hash |
| pp_name | string | PP Name |
| trial_unit | string | Trial Unit (day|week|month|year) |
| trial_period | int | Trial period |
| rebill_unit | string | Rebill Unit (day|week|month|year) |
| rebill_period | int | Rebill period |
| max_rebill_count | int | Max Rebill Count |
| tracking_item | int | Tracking item ID |
| next_rebill_ts | int | Next rebill ts |
| last_rebill_ts | int | Last rebill ts |
subscription.stopped
Sent in case of stopped subscription (action initiated via api call)
Data array (json encoded)
| Param Name | Type | Description |
|---|---|---|
| sub_id | int | Subscription ID |
| item_id | int | Item ID |
| status | string | Subscription status (s/b initial on create, rebill after 1st rebill) |
| start_ts | int | Start timestamp |
| user_id | int | PV2 user ID |
| tracking_user | int | User ID on partners' site |
| ptnr_id | int | Partner ID |
| tracking_tag | int | Tracking Tag param |
| currency | string | Currency |
| hash | string | Hash |
| pp_name | string | PP Name |
| trial_unit | string | Trial Unit (day|week|month|year) |
| trial_period | int | Trial period |
| rebill_unit | string | Rebill Unit (day|week|month|year) |
| rebill_period | int | Rebill period |
| max_rebill_count | int | Max Rebill Count |
| tracking_item | int | Tracking item ID |
| next_rebill_ts | int | Next rebill ts |
| last_rebill_ts | int | Last rebill ts |
| is_cancel | boolean | s/b true |
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)
| Param Name | Type | Description |
|---|---|---|
| sub_id | int | Subscription ID |
| item_id | int | Item ID |
| status | string | Subscription status (s/b initial on create, rebill after 1st rebill) |
| start_ts | int | Start timestamp |
| user_id | int | PV2 user ID |
| tracking_user | int | User ID on partners' site |
| ptnr_id | int | Partner ID |
| tracking_tag | int | Tracking Tag param |
| currency | string | Currency |
| hash | string | Hash |
| pp_name | string | PP Name |
| trial_unit | string | Trial Unit (day|week|month|year) |
| trial_period | int | Trial period |
| rebill_unit | string | Rebill Unit (day|week|month|year) |
| rebill_period | int | Rebill period |
| max_rebill_count | int | Max Rebill Count |
| tracking_item | int | Tracking item ID |
| next_rebill_ts | int | Next rebill ts |
| last_rebill_ts | int | Last rebill ts |
subscription.rebill
Sent after successfully made rebill. It will be sent right after transaction.success
Data array (json encoded)
| Param Name | Type | Description |
|---|---|---|
| sub_id | int | Subscription ID |
| item_id | int | Item ID |
| status | string | Subscription status (s/b initial on create, rebill after 1st rebill) |
| start_ts | int | Start timestamp |
| user_id | int | PV2 user ID |
| tracking_user | int | User ID on partners' site |
| ptnr_id | int | Partner ID |
| tracking_tag | int | Tracking Tag param |
| currency | string | Currency |
| hash | string | Hash |
| pp_name | string | PP Name |
| trial_unit | string | Trial Unit (day|week|month|year) |
| trial_period | int | Trial period |
| rebill_unit | string | Rebill Unit (day|week|month|year) |
| rebill_period | int | Rebill period |
| max_rebill_count | int | Max Rebill Count |
| tracking_item | int | Tracking item ID |
| next_rebill_ts | int | Next rebill ts |
| last_rebill_ts | int | Last rebill ts |
subscription.completed
Sent after completed subscription (happens only on subs with limited number of rebills).
Data array (json encoded)
| Param Name | Type | Description |
|---|---|---|
| sub_id | int | Subscription ID |
| item_id | int | Item ID |
| status | string | Subscription status (s/b initial on create, rebill after 1st rebill) |
| start_ts | int | Start timestamp |
| user_id | int | PV2 user ID |
| tracking_user | int | User ID on partners' site |
| ptnr_id | int | Partner ID |
| tracking_tag | int | Tracking Tag param |
| currency | string | Currency |
| hash | string | Hash |
| pp_name | string | PP Name |
| trial_unit | string | Trial Unit (day|week|month|year) |
| trial_period | int | Trial period |
| rebill_unit | string | Rebill Unit (day|week|month|year) |
| rebill_period | int | Rebill period |
| max_rebill_count | int | Max Rebill Count |
| tracking_item | int | Tracking item ID |
| next_rebill_ts | int | Next rebill ts |
| last_rebill_ts | int | Last rebill ts |
- Last Author
- boris
- Last Edited
- Mar 11 2015, 13:17