Skip to main content

IPN and Keygen Variables

Variables Sent Through to Your Keygen and IPN Scripts

Welcome to WarriorPlus.

There are times when you may want to integrate with a script that is not automatically supported by WarriorPlus. For these cases, you will need to create a custom script on your site that will extract the POST information, allowing you to use the data on your pages. Below is a list of the variables sent and how they are used.

Main Variables Sent to Your Scripts

These variables can also be used by Affiliate webhooks, with the exception of personal customer information.

WP_ACTION

Action related to this IPN message (currently 'sale', 'refund', ‘dispute’, or other values for Recurring sales, as listed below)

WP_SALE

The unique, alphanumeric identifier for this sale, prefixed with "sale_" (also used in the API)

WP_ITEM_NAME

Product name entered in WarriorPlus

WP_ITEM_NUMBER

Item number generated by WarriorPlus (unique to this product)

WP_BUYER_NAME

First and last name of the buyer

WP_BUYER_EMAIL

Email address of the buyer

WP_BUYER_IP

IP address of the buyer, if applicable

WP_BUYER_(XXX)

Additional buyer fields, if collected (where XXX can be: ADDRESS1, ADDRESS2, CITY, STATE, COUNTRY, POSTALCODE)

WP_SALE_AMOUNT

Price the buyer paid

WP_SALE_CURRENCY

Currency the buyer paid with (currently always USD)

WP_SALE_FEE

Fee collected by WarriorPlus for this sale

WP_SALE_EARNINGS_(XXX)

Earnings data for this sale, where applicable (where XXX can be: AFF, AFF2, JV, VENDOR, WPFEE)

WP_TXNID

Payment processor generated transaction id of the sale

WP_SALEID

WarriorPlus generated sale id (unique to this sale)

WP_PAYMETHOD

Payment method used (ie paypal, stripe, free, wallet)

WP_PAYMENT_STATUS

Status of this payment (ie Completed, Refunded, Pending)

IPN_ID

The unique ID of this IPN message

IPN_RCPT_TYPE

The type of recipient this IPN is for (ie 'vend' or 'aff')

Optional Fields

These fields are used only if you have set them up within your account and offer/product listings or where applicable

WP_AFFID

WarriorPlus unique affiliate id of referring affiliate (if applicable)

WP_AFFUSER

WarriorPlus username of referring affiliate (if applicable)

WP_SID

SubId value passed when SID is passed via the Buy Button Link (via 's' param)

WP_TID

TrackingID value when TID is passed via the Buy Button Link (via 'tid' param)

WP_HOP_SID

SubId value when SID is passed via a Vendor or Affiliate Hop Link (depending on IPN_RCPT_TYPE), ie /o2/v/[offer_code]/[page_code]/[sid]

WP_HOP_TID

TrackingId value when TID is passed via a Vendor or Affiliate Hop Link (depending on IPN_RCPT_TYPE) ie /o2/v/[offer_code]/[page_code]/[sid]/[tid]

WP_CHECKOUT_CUSTOM

Custom params passed to checkout page

WP_SECURITYKEY

If set in your account settings, this will be sent so you can validate the authenticity of the IPN message

Subscription/Recurring Payment Fields

  • Used specifically for subscription or recurring based purchases.

WP_SUBSCR_ID

The unique ID of this subscription

WP_SUBSCR_STATUS

The status of the subscription

WP_SUBSCR_PAYMENT_NUM

The current payment number that is being processed

WP_SUBSCR_PAYMENT_AMOUNT

The amount of the payment

WP_SUBSCR_PAYMENT_TXNID

The transaction id of the payment

WP_SUBSCR_NEXT_PAYMENT_DATE

The date of the next scheduled payment

Subscription and Recurring Products WP_ACTION Array

  • In addition to the above variables, an array is also sent with specific information when processing a recurring or subscription IPN.

subscr_created

New subscription was created (when the initial sale is made)

subscr_cancelled

Subscription was cancelled (This happens from the subscription detail page, either initiated by admin/buyer/vendor, or the first payment was refunded which will automatically cancel the subscription.)

subscr_completed

Recurring payment was processed successfully

subscr_failed_invalid

Credit card number lookup failed

subscr_failed_declined

Credit card was declined

subscr_suspended

Subscription was suspended due to multiple failed charges

subscr_reactivated

Suspended subscription was re-activated after the buyer made a payment. Currently the buyer can only pay and reactivate the subscription within 30 days of suspension

subscr_ended

The last payment was processed and the subscription ended. (This only happens when the subscription has an ending value.)

subscr_refunded

Payment was refunded (the payment number is set in the 'WP_SUBSCR_PAYMENT_NUM' field)



If you have any further questions, please don’t hesitate to reach out — our support team will respond promptly. We also invite you to join our Facebook community by clicking here.

Finally, on behalf of the entire WarriorPlus team, welcome to the family.

Did this answer your question?