Partner Notifications
Updated 2,613 Days AgoPublic
Actions

Version 8 of 18: You are viewing an older version of this document, as it appeared on Mar 20 2017, 13:00.

Content

transaction.success
transaction.failed
subscription.created
subscription.trial
subscription.stopped
subscription.suspended
subscription.rebill
subscription.completed
subscription.change
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:

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

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

subscription.change

Sent in when subscription is changed (action initiated via subscription.change 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

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)

Param Name	Type	Description
interval	string	When from now should rebill happen ('2 day', '3 day', 'X day')
subscriptions	array	Array of data related to subscriptions rebills (see below)

Subscriptions array (json encoded)

Param Name	Type	Description
sub_id	int	Subscription ID
next_rebill_ts	int	Next rebill timestamp
ptnr_id	int	Partner ID
tracking_user	int	User ID on partners' site
tracking_tag	int	Tracking Tag param
bin	string	BIN of card for this susbcription
ccnum_last4	string	Last 4 digits of card for this susbcription
currency	string	Currency
order_type	string	Order type ('basic' \| 'xsale')
item_id	int	Item ID
cc_type	string	Card type ('visa' ...)
pp_name	string	PP Name
bin_high_risk	int	Is BIN on High Risk List (1\|0)
bin_blocked_for_rebill	int	Is BIN blocked for rebill (1\|0)