Sellers' Instant Payment Notification Variables

Variable Type Description
testMode Y/N Test transaction made by the vendor
referenceNumber Number Plimus Reference Number
originalReferenceNumber Number Plimus Original Reference Number (for subscriptions)
subscriptionId Number The permanent numeric identifier set by Plimus for promotion on a subscription or recurring charge order.
paymentMethod String Method of payment, i.e. CC/PAYPAL/WIRE
creditCardType String Type of credit-card, i.e. AMEX/VISA
transactionDate mm/dd/yyyy hh:mi AM/PM Date & Time transaction occurred
untilDate mm/dd/yyyy hh:mi AM/PM Subscription expiration date
productId Number Plimus Product Id
productName String Product name
contractId Number Plimus Contract Id
contractName String Contract name
contractOwner String Contract owner
oldProductId Number In the event of a subscription contract switch, the old product id
oldContractId Number In the event of a subscription contract switch, the old contract id
newProductId Number In the event of a subscription contract switch, the new product id
newContractId Number In the event of a subscription contract switch, the new contract id
contractPrice Number #,###.## Contract price
transactionType String
  • AUTH_ONLY - orders that were authorized for a future charge
  • CHARGE - orders that were successfully charged
  • REFUND - orders that were refunded
  • CHARGEBACK - ordered that were charged back by the customer
  • CANCELLATION - orders that were cancelled (for unapproved orders and cancelled subscriptions)
  • RECURRING - subscription orders that were successfully charged
  • CANCELLATION_REFUND - orders that were refunded and cancelled (for cancelled subscriptions)
  • CANCELLATION_CHARGEBACK - subscription orders that were charged back by the customer
  • CONTRACT_CHANGE - subscription orders that had their contract switched
  • CANCEL - invalid orders that were rejected
  • DECLINE - orders that were rejected
quantity Number Quantity ordered
currency String Currency code used in the order
addCD Y/N Did the Customer also order a CD on Demand ?
coupon String Did the Customer use a coupon ?
couponValue Number #,###.## Coupon value
referrer String The referrer URL that the Customer came from to the BuyNow page
promoteContractId# Number Promotion Contract Id. The # sign from 0 to number of the promotion contracts in the order
promoteContractName# String Promotion contract name. The # sign from 0 to number of the promotion contracts in the order
promoteProductId# Number Promotion Product ID. The # sign from 0 to number of the promotion contracts in the order
promoteProductName# String Promotion Product name. The # sign from 0 to number of the promotion contracts in the order
promoteContractOwner# String Promotion contract owner. The # sign from 0 to number of the promotion contracts in the order
promoteContractPrice# Number #,###.## Promotion contract price. The # sign from 0 to number of the promotion contracts in the order
promoteContractQuantity# Number Promotion contract quantity. The # sign from 0 to number of the promotion contracts in the order
promoteContractLicenseKey# String Promotion contract license key. The # sign from 0 to number of the promotion contracts in the order
promoteSubscriptionId# Number Promotion subscription Id. The # sign from 0 to number of the promotion contracts in the order
promoteContractsNum Number Number of promotions.
custom fields String Contract custom fields as defined in the contract page (up to 5 per contract). All spaces are deleted from the field name for this purpose
Additional Charges String Parameter name is the category/group name as entered by you and the value is the selected option name. All spaces are deleted from the field name for this purpose
promotion custom fields String Promotion contract custom fields as defined in the promotion contract page (up to 5 per contract). All spaces are deleted from the field name for this purpose
accountId Number Plimus Account Id assigned to the customer
title String Customer title
firstName String Customer first name
lastName String Customer last name
username String Customer username
company String Customer company name
address1 String Customer address line 1
address2 String Customer address line 2
city String Customer city
state String Customer state
country String Customer country code
zipCode String Customer zip code
email String Customer email address
workPhone String Customer work phone number
extension String Customer work phone extension
mobilePhone String Customer mobile phone number
homePhone String Customer home phone number
faxNumber String Customer fax number
licenseKey String License key supplied to the customer
shippingFirstName String Shipping first name
shippingLastName String Shipping last name
shippingAddress1 String Shipping address line 1
shippingAddress2 String Shipping address line 2
shippingCity String Shipping city
shippingState String Shipping state
shippingCountry String Shipping country code
shippingZipCode String Shipping zip code
remoteAddress String Customer remote IP address
shippingMethod String i.e. UPS/USPS
couponCode String coupon Code used
invoiceAmount (Deprecated) Number #,###.## The invoice amount in USD
invoiceAmountUSD Number #,###.## The invoice amount in USD
invoiceChargeCurrency Number #,###.## The currency the shopper was billed in
invoiceChargeAmount Number #,###.## The invoice amount in shopper's local currency
invoiceInfoURL String Invoice details web-page
paypalTransactionId String Id of the transaction made in PayPal
originalPaypalTransactionId String Reference to the original Id of the transaction made in PayPal (i.e. for refund this Id will be the Id of the transaction that will be refunded)
paypalSubscriptionId String Id of the subscription profile created in PayPal
targetBalance String Indication as to where the transaction funds will be credited or refund made - (could be Plimus account or Vendor PayPal account)
cancelReason String The reason the payment was cancelled.
paymentType String The method of payment, i.e. CC/wire
creditCardType String The type of credit card, i.e. MC/Visa/Amex
creditCardLastFourDigits Number The last four digits of the customer’s credit card that is being used for payment of purchase.
creditCardExpDate Number The expiry date of the credit card being used for payment of purchase.
errorProcessingCode Number If payment processing fails, the error code is sent to seller. This error code signifies the reason processing failed.
processorCode String Displays the name of processor.
plimusNode Number The datacenter which processed the transaction and is storing the information. The values are: 1 - US servers / 2 - UK servers / 99 - Sandbox
oldcustomfield String The custom field value of the old contract before contract was switched.