This article contains the data that is pinged by our IPN system when a customer processes a one-time payment order or when a refund is issued. The main difference between sale and refund or partial_refund is the transaction_type variable (see table below), which is for the sale, (refund) for the refund and partial_refund for the partial refund.
In case of a refund or partial refund, the system also sends the transaction_parent_id parameter, which is the original sale's order ID. That will help you identify which original transaction is being refunded.
Sale variables for IPN
Variable name | Description |
---|---|
transaction_id | Kartra order id |
transaction_full_amount | The amount paid by the customer |
transaction_base_amount | The base price for the transaction |
transaction_discount | If any discount coupon was applied, the amount deducted from the original price |
transaction_shipping | The shipping price |
transaction_tax | The sales tax or VAT |
transaction_date | The date of the transaction. Format yyyy-mm-dd hh:mm:ss EST |
transaction_type | The transaction type. Possible values: ‘sale’ |
transaction_parent_id | 0 |
transaction_affiliate | The username of the affiliate ('N/A' if no affiliate) |
transaction_jv | The username of the jv broker ('N/A' if no jv) |
transaction_quantity | Product units |
transaction_subscription_id | 'N/A' |
transaction_internal_subscription_id | 'N/A' |
transaction_subscription_pay_number | 'N/A' |
transaction_last_4_card_digits | The last 4 digits of the used card ('N/A' if PayPal) |
original_id | 0 |
product_name | The name of the purchased product |
product_id | The ID of the product |
product_price_point | The price point number. This is a number from 1 onwards |
trial | 0 |
trial_amount | N/A |
trial_period | N/A |
payments_left | 0 |
lead_id | Buyer's unique identifier id |
lead_first_name | Buyer's first name |
lead_last_name | Buyer's last name |
lead_email | Buyer's email |
lead_username | Buyer’s username |
lead_phone_country_code | Buyer's phone country code |
lead_phone_number | Buyer's phone number |
lead_address | Buyer's billing address |
lead_city | Buyer's billing city |
lead_zip | Buyer's billing ZIP |
lead_state | Buyer's billing state |
lead_country | Buyer's billing country |
lead_country_code_2 | Buyer's two letter country code |
lead_country_code_3 | Buyer's three letter country code |
lead_ip | Buyer's IP |
shipping_address | Buyer's shipping address |
shipping_city | Buyer's shipping city |
shipping_zip | Buyer's shipping ZIP |
shipping_state | Buyer's shipping state |
shipping_country | Buyer's shipping country |
secret_key | The secret key you setup when you created the notification |
vendor_tracking_id_1 | Vendor's tracking ID 1 if the sale was generated from a tracking link |
vendor_tracking_id_2 | Vendor's tracking ID 2 if the sale was generated from a tracking link |
vendor_tracking_link | Vendor's tracking link name |
gdpr_lead_status | integer, possible values:
|
gdpr_lead_status_date | string (DD Mmm YYYY HH:MM:SS) |
gdpr_lead_status_ip | string |
gdpr_lead_communications | integer, possible values: 0 - Lead hasn't agreed to be contacted 1 - Lead has agreed to be contacted |
payment_processor_type | "PayPal" "Braintree" "Stripe" " Authorize.net" |
kartra_reference_id | Kartra internal reference id |
lead_company | Buyer’s company |
lead_sales_tax_id | Buyer’s sales tax id |
Refund, partial refund, and chargeback variables for IPN
transaction_id | Kartra order id |
transaction_full_amount | The amount paid by the customer |
transaction_base_amount | The base price for the transaction |
transaction_discount | If any discount coupon was applied, the amount deducted from the original price |
transaction_shipping | The shipping price |
transaction_tax | The sales tax or VAT |
transaction_date | The date of the transaction. Format yyyy-mm-dd hh:mm:ss EST |
transaction_type | The transaction type. Possible values: 'refund', 'partial_refund', 'chargeback' |
transaction_parent_id | The id of the parent transaction |
transaction_affiliate | The username of the affiliate ('N/A' if no affiliate) |
transaction_jv | The username of the jv broker ('N/A' if no jv) |
transaction_quantity | Product units |
transaction_subscription_id | 'N/A' |
transaction_internal_subscription_id | 'N/A' |
transaction_subscription_pay_number | 'N/A' |
original_id | 0 |
product_name | The name of the purchased product |
product_id | The ID of the product |
product_price_point | The price point number. This is a number from 1 onwards |
lead_id | Buyer's unique identifier id |
lead_first_name | Buyer's first name |
lead_last_name | Buyer's last name |
lead_email | Buyer's email |
lead_username | Buyer’s username |
lead_phone_country_code | Buyer's phone country code |
lead_phone_number | Buyer's phone number |
lead_address | Buyer's billing address |
lead_city | Buyer's billing city |
lead_zip | Buyer's billing ZIP |
lead_state | Buyer's billing state |
lead_country | Buyer's billing country |
lead_country_code_2 | Buyer's two letter country code |
lead_country_code_3 | Buyer's three letter country code |
shipping_address | Buyer's shipping address |
shipping _city | Buyer's shipping city |
shipping _zip | Buyer's shipping ZIP |
shipping _state | Buyer's shipping state |
shipping _country | Buyer's shipping country |
secret_key | The secret key you setup when you created the notification |
vendor_tracking_id_1 | Vendor's tracking ID 1 if the sale was generated from a tracking link |
vendor_tracking_id_2 | Vendor's tracking ID 2 if the sale was generated from a tracking link |
vendor_tracking_link | Vendor's tracking link name |
gdpr_lead_status | integer, possible values:
|
gdpr_lead_status_date | string (DD Mmm YYYY HH:MM:SS) |
gdpr_lead_status_ip | string |
gdpr_lead_communications | integer, possible values: 0 - Lead hasn't agreed to be contacted 1 - Lead has agreed to be contacted |
payment_processor_type | "PayPal" "Braintree" "Stripe" " Authorize.net" |
lead_company | Buyer’s company |
lead_sales_tax_id | Buyer’s sales tax id |