Phriction DatingVIP Public Payment Application Project Partner Notifications

Contents

Content
transaction.success
transaction.failed
transaction.change
subscription.created
subscription.trial
subscription.stopped
subscription.suspended
subscription.rebill
subscription.completed
subscription.change

Partner Notifications
Updated 250 Days AgoPublic
Actions

Content

transaction.success
transaction.failed
transaction.change
subscription.created
subscription.trial
subscription.stopped
subscription.suspended
subscription.rebill
subscription.completed
subscription.change

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

When partner receives a notification the next step should be confirmation. There are two ways to do that.

notifications.hash.validate api call (async) by sending received hash back
return a given string '*NOTIFIED*' as a result of notification request (http code must be 200)

For non confirmed notifications the resend mechanism will retry notification according to below schedule:

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
ptnr_id	int	Partner ID
ppac_id	int	Payment Processor Account ID
order_id	int	Order ID
ccdt_id	int	Credit Card Details ID
transaction_type	string	Transaction Type. Values: `s` (sale), `a` (auth), `r` (refund), `c` (chargeback), `f` (fake)
amount	string	Amount
currency	string	Currency (3 Letter ISO Code)
description	string	Description
status	string	Transaction status. Values: `failed`, `successful`
refunded_tran_id	int	Refunded Transaction ID
origin	string	Origin. Values: `direct`, `system`
ts	int	Timestamp
status_code	int	Status code
payment_code	int	Payment Code (700 on success)
order_type	string	Order type. Values: `basic`, `xsale`
pp_id	int	Payment Processor ID
processor	string	Payment Processor abbreviation
user_id	int	User ID in Payment Application
tracking_user	int	User Identifier from Partner
tracking_tag	int	Tag ID from Partner
items	array	Array of items
merchant*	array	Array of fields that identify merchant account**
selected_cc_data*	array	Array of card data fields (ccdt_id, bin, ccnum_last4, exp_date, cc_type, cc_status) (with optional flag: marked_as_fraud)***

*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]
For RocketGate transaction, only when using already existing card (rebills/rejoins)

transaction.failed

Sent in case of failed transaction.

Data array (json encoded)

Param Name	Type	Description
tran_id	int	Transaction ID
ptnr_id	int	Partner ID
ppac_id	int	Payment Processor Account ID
order_id	int	Order ID
ccdt_id	int	Credit Card Details ID
transaction_type	string	Transaction Type. Values: `s` (sale), `a` (auth), `r` (refund), `c` (chargeback), `f` (fake)
amount	string	Amount
currency	string	Currency (3 Letter ISO Code)
description	string	Description
status	string	Transaction status. Values: `failed`, `successful`
refunded_tran_id	int	Refunded Transaction ID
origin	string	Origin. Values: `direct`, `system`
ts	int	Timestamp
status_code	int	Status code
payment_code	int	Payment Code (700 on success)
order_type	string	Order type. Values: `basic`, `xsale`
pp_id	int	Payment Processor ID
processor	string	Payment Processor abbreviation
user_id	int	User ID in Payment Application
tracking_user	int	User Identifier from Partner
tracking_tag	int	Tag ID from Partner
items	array	Array of items
merchant*	array	Array of fields that identify merchant account**
selected_cc_data*	array	Array of card data fields (ccdt_id, bin, ccnum_last4, exp_date, cc_type, cc_status) (with optional flag: marked_as_fraud)***

transaction.change

Sent when transaction has been changed.
Possible cases when that might happen:

transaction.delete_chargeback
transaction.chargeback refund for the same transaction already exists. so we update Refund -> Chargeback

Data array (json encoded)

Param Name	Type	Description
tran_id	int	Transaction ID
ptnr_id	int	Partner ID
ppac_id	int	Payment Processor Account ID
order_id	int	Order ID
ccdt_id	int	Credit Card Details ID
transaction_type	string	Transaction Type. Values: `s` (sale), `a` (auth), `r` (refund), `c` (chargeback), `f` (fake)
amount	string	Amount
currency	string	Currency (3 Letter ISO Code)
description	string	Description
status	string	Transaction status. Values: `failed`, `successful`
refunded_tran_id	int	Refunded Transaction ID
origin	string	Origin. Values: `direct`, `system`
ts	int	Timestamp
status_code	int	Status code
payment_code	int	Payment Code (700 on success)
order_type	string	Order type. Values: `basic`, `xsale`
pp_id	int	Payment Processor ID
processor	string	Payment Processor abbreviation
user_id	int	User ID in Payment Application
tracking_user	int	User Identifier from Partner
tracking_tag	int	Tag ID from Partner
items	array	Array of items

*Processor dependant, may not be sent for all processors - currently only RocketGate

subscription.created

Sent when subscription is successfully created and subscription does not have trial.
Subscription does not have trial, if appropriate item passed in transaction.init call, have empty value for parameter trial_period.
(Minor use case: Also sent for manually rebilled subscriptions, in this case value of rebill_period for appropriate item in transaction.init call should be -1)

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
change_ts	int	Change(edit) timestamp
end_ts	int	End timestamp
rebill_count	int	Number of recurring payments
last_rebill_ts	int	Last rebill ts
next_rebill_ts	int	Next rebill ts
next_rebill_amount	int	Next rebill amount
step_down	int	Step Down (charge amount reductions)
order_id	int	Order ID
description	int	Order Description
rebill_amount	int	Rebill amount (not including next one)
trial_unit	string	Trial Unit (day\|week\|month\|year)
rebill_unit	string	Rebill Unit (day\|week\|month\|year)
rebill_period	int	Rebill period
max_rebill_count	int	Max Rebill Count
trial_period	int	Trial period
tracking_item	int	Tracking item ID
pp_id	int	Payment Processor ID
user_id	int	PV2 user ID
hash	string	Hash
first_name	int	Customer's First Name
last_name	int	Customer's Last Name
ppac_id	int	Payment Processor Account ID
email	int	Customer's Email Address
ptnr_id	int	Partner ID
currency	string	Currency
tracking_tag	int	Tracking Tag param
ip	int	Customer's IP Address
order_type	int	Order type. Values: `basic`, `xsale`
tracking_user	int	User ID on partners' site
processor	int	Payment Processor's abreviation
tran_id*	int	Last Transaction's ID

* Not present for all payment processors

subscription.trial

Sent when subscription is successfully created and subscription does have trial.
Subscription does have trial, if appropriate item passed in transaction.init call, have non-empty value for parameter trial_period.

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
change_ts	int	Change(edit) timestamp
end_ts	int	End timestamp
rebill_count	int	Number of recurring payments
last_rebill_ts	int	Last rebill ts
next_rebill_ts	int	Next rebill ts
next_rebill_amount	int	Next rebill amount
step_down	int	Step Down (charge amount reductions)
order_id	int	Order ID
description	int	Order Description
rebill_amount	int	Rebill amount (not including next one)
trial_unit	string	Trial Unit (day\|week\|month\|year)
rebill_unit	string	Rebill Unit (day\|week\|month\|year)
rebill_period	int	Rebill period
max_rebill_count	int	Max Rebill Count
trial_period	int	Trial period
tracking_item	int	Tracking item ID
pp_id	int	Payment Processor ID
user_id	int	PV2 user ID
hash	string	Hash
first_name	int	Customer's First Name
last_name	int	Customer's Last Name
ppac_id	int	Payment Processor Account ID
email	int	Customer's Email Address
ptnr_id	int	Partner ID
currency	string	Currency
tracking_tag	int	Tracking Tag param
ip	int	Customer's IP Address
order_type	int	Order type. Values: `basic`, `xsale`
tracking_user	int	User ID on partners' site
processor	int	Payment Processor's abreviation
tran_id*	int	Last Transaction's ID

* Not present for all payment processors

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
change_ts	int	Change(edit) timestamp
end_ts	int	End timestamp
rebill_count	int	Number of recurring payments
last_rebill_ts	int	Last rebill ts
next_rebill_ts	int	Next rebill ts
next_rebill_amount	int	Next rebill amount
step_down	int	Step Down (charge amount reductions)
order_id	int	Order ID
description	int	Order Description
rebill_amount	int	Rebill amount (not including next one)
trial_unit	string	Trial Unit (day\|week\|month\|year)
rebill_unit	string	Rebill Unit (day\|week\|month\|year)
rebill_period	int	Rebill period
max_rebill_count	int	Max Rebill Count
trial_period	int	Trial period
tracking_item	int	Tracking item ID
pp_id	int	Payment Processor ID
user_id	int	PV2 user ID
hash	string	Hash
first_name	int	Customer's First Name
last_name	int	Customer's Last Name
ppac_id	int	Payment Processor Account ID
email	int	Customer's Email Address
ptnr_id	int	Partner ID
currency	string	Currency
tracking_tag	int	Tracking Tag param
ip	int	Customer's IP Address
order_type	int	Order type. Values: `basic`, `xsale`
tracking_user	int	User ID on partners' site
processor	int	Payment Processor's abreviation
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
change_ts	int	Change(edit) timestamp
end_ts	int	End timestamp
rebill_count	int	Number of recurring payments
last_rebill_ts	int	Last rebill ts
next_rebill_ts	int	Next rebill ts
next_rebill_amount	int	Next rebill amount
step_down	int	Step Down (charge amount reductions)
order_id	int	Order ID
description	int	Order Description
rebill_amount	int	Rebill amount (not including next one)
trial_unit	string	Trial Unit (day\|week\|month\|year)
rebill_unit	string	Rebill Unit (day\|week\|month\|year)
rebill_period	int	Rebill period
max_rebill_count	int	Max Rebill Count
trial_period	int	Trial period
tracking_item	int	Tracking item ID
pp_id	int	Payment Processor ID
user_id	int	PV2 user ID
hash	string	Hash
first_name	int	Customer's First Name
last_name	int	Customer's Last Name
ppac_id	int	Payment Processor Account ID
email	int	Customer's Email Address
ptnr_id	int	Partner ID
currency	string	Currency
tracking_tag	int	Tracking Tag param
ip	int	Customer's IP Address
order_type	int	Order type. Values: `basic`, `xsale`
tracking_user	int	User ID on partners' site
processor	int	Payment Processor's abreviation

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
change_ts	int	Change(edit) timestamp
end_ts	int	End timestamp
rebill_count	int	Number of recurring payments
last_rebill_ts	int	Last rebill ts
next_rebill_ts	int	Next rebill ts
next_rebill_amount	int	Next rebill amount
step_down	int	Step Down (charge amount reductions)
order_id	int	Order ID
description	int	Order Description
rebill_amount	int	Rebill amount (not including next one)
trial_unit	string	Trial Unit (day\|week\|month\|year)
rebill_unit	string	Rebill Unit (day\|week\|month\|year)
rebill_period	int	Rebill period
max_rebill_count	int	Max Rebill Count
trial_period	int	Trial period
tracking_item	int	Tracking item ID
pp_id	int	Payment Processor ID
user_id	int	PV2 user ID
hash	string	Hash
first_name	int	Customer's First Name
last_name	int	Customer's Last Name
ppac_id	int	Payment Processor Account ID
email	int	Customer's Email Address
ptnr_id	int	Partner ID
currency	string	Currency
tracking_tag	int	Tracking Tag param
ip	int	Customer's IP Address
order_type	int	Order type. Values: `basic`, `xsale`
tracking_user	int	User ID on partners' site
processor	int	Payment Processor's abreviation
tran_id*	int	Last Transaction's ID

* 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)

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
change_ts	int	Change(edit) timestamp
end_ts	int	End timestamp
rebill_count	int	Number of recurring payments
last_rebill_ts	int	Last rebill ts
next_rebill_ts	int	Next rebill ts
next_rebill_amount	int	Next rebill amount
step_down	int	Step Down (charge amount reductions)
order_id	int	Order ID
description	int	Order Description
rebill_amount	int	Rebill amount (not including next one)
trial_unit	string	Trial Unit (day\|week\|month\|year)
rebill_unit	string	Rebill Unit (day\|week\|month\|year)
rebill_period	int	Rebill period
max_rebill_count	int	Max Rebill Count
trial_period	int	Trial period
tracking_item	int	Tracking item ID
pp_id	int	Payment Processor ID
user_id	int	PV2 user ID
hash	string	Hash
first_name	int	Customer's First Name
last_name	int	Customer's Last Name
ppac_id	int	Payment Processor Account ID
email	int	Customer's Email Address
ptnr_id	int	Partner ID
currency	string	Currency
tracking_tag	int	Tracking Tag param
ip	int	Customer's IP Address
order_type	int	Order type. Values: `basic`, `xsale`
tracking_user	int	User ID on partners' site
processor	int	Payment Processor's abreviation

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
change_ts	int	Change(edit) timestamp
end_ts	int	End timestamp
rebill_count	int	Number of recurring payments
last_rebill_ts	int	Last rebill ts
next_rebill_ts	int	Next rebill ts
next_rebill_amount	int	Next rebill amount
step_down	int	Step Down (charge amount reductions)
order_id	int	Order ID
description	int	Order Description
rebill_amount	int	Rebill amount (not including next one)
trial_unit	string	Trial Unit (day\|week\|month\|year)
rebill_unit	string	Rebill Unit (day\|week\|month\|year)
rebill_period	int	Rebill period
max_rebill_count	int	Max Rebill Count
trial_period	int	Trial period
tracking_item	int	Tracking item ID
pp_id	int	Payment Processor ID
user_id	int	PV2 user ID
hash	string	Hash
first_name	int	Customer's First Name
last_name	int	Customer's Last Name
ppac_id	int	Payment Processor Account ID
email	int	Customer's Email Address
ptnr_id	int	Partner ID
currency	string	Currency
tracking_tag	int	Tracking Tag param
ip	int	Customer's IP Address
order_type	int	Order type. Values: `basic`, `xsale`
tracking_user	int	User ID on partners' site
processor	int	Payment Processor's abreviation