IPN Parameter Reference

Below are all the parameters that are included in BlueSnap's IPNs (webhooks), with a description of each parameter, the supported values per parameter, and the list of IPNs that include each parameter.

The available IPN types are described in Default IPN types and On-demand IPN types. For a list of IPNs and associated parameters, see IPN Name Reference.

Parameter Name
Value
Description & Relevant IPNs

3dStatus

String
Possible values:
  3DS Not Enabled
  Bypass
  Failed Authentication
  Incomplete
  Successful Authentication
  System Unavailable

3D Secure status.
IPNs:
  Charge
  Fraud Decline




accountCanProcess

'Yes'
'No'
'Pending'

Specifies if the merchant account can process transactions.
IPN: Merchant Partner Onboarded




accountId

Number

BlueSnap account ID assigned to the shopper.
IPNs:
  Account Updater
  Cancellation
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




accountUpdaterLineId

Number

Unique identifier of the update.
IPN: Account Updater




addCD

Y/N

Indicates whether the shopper ordered a CD on demand.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Recurring
  Refund
  Under Review
  Under Vendor Review




additionalChargeAmount[N]

Number

Amount of additional charge. The index refers to the same number as the corresponding additionalChargeCategory and additionalChargeName.

IPNs:
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Refund
  Under Review
  Under Vendor Review




additionalChargeCategory[N]

String

Name of the additional charge category. The index indicates the category number.

IPNs:
  Cancellation Refund
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Refund
  Under Review
  Under Vendor Review




additionalChargeName[N]

String

Name of the additional charge.

IPNs:
  Auth Only
  Cancellation Refund
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Refund
  Under Review
  Under Vendor Review




address1

String

Shopper's address line 1.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




address2

String

Shopper's address line 2.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




amount

Number

The amount of the transaction.
Example: 1234.56

IPNs:
  Failed Payout Transfer
  Fraud Decline




amount[N]

Number

Indicates the amount per currency for each payout. The index associates the amount to the corresponding payout currency.

IPN: Payout




armadilloHardwareId

Number

Sent if the account has an armadillo ID.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Decline
  Recurring
  Refund
  Under Review
  Under Vendor Review




authkey

String
Empty unless the Data Protection Key is set up, in which case the value of the parameter is:
MD5 (referenceNumber+contractId+DataProtectionKey)
unless it's being used for Account Updater.

For Account Updater the value is:
MD5(‘Last 4 digits’+‘accountID’ +‘DataProtectionKey’)

This enables merchants to ensure the IPN originates from BlueSnap, as only BlueSnap knows the secret password set up by the merchant in the control panel.

IPNs:
  Account Updater
  Auth Only
  Cancellation
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Recurring
  Refund
  Under Review
  Under Vendor Review




binCategory

String
Possible values:

  Corporate: Business card
  Consumer: Personal card

Indicates whether the card is used for business expenses or personal expenses.

IPNs:
  Auth Only
  Cancel on Renewal
  Cancellation
  Cancellation Refund
  Charge
  Contract Change
  Decline
  Payment Method Updated
  Recurring
  Subscription Charge Failure
  Under Review
  Under Vendor Review




binNumber

Number

Bank identification number. The first 6 digits of the shopper's payment card.

IPNs:
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Contact Change
  Recurring
  Refund
  Subscription Charge Failure




bluesnapManualFee

Number

Shows the amount, in USD, of any manual fee that was charged by BlueSnap. Please note that this amount is already included within invoiceAmountUSD.

IPN: Charge




bluesnapNode
(also appears as plimusNode)

Number
The values are:
  1 = US servers
  2 = UK servers
  99 = Sandbox

BlueSnap datacenter that processed the transaction and is storing the information.

IPNs:
  Account Updater
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review




cancelledContractId

String

The cancelled contract ID.

IPN: Cancellation




cancelReason

String

The reason the subscription was cancelled.

IPNs:
  Cancellation
  Cancellation Refund
  Chargeback
  Chargeback Status Changed




cancelRenewal

Y/N

Indicates whether the renewal is cancelled.

IPN: Cancel on Renewal




captureReferenceNumber

Number

BlueSnap reference number for the capture.

IPN: Capture




captureStatus

String
The value is always FAIL.

Appears only if the capture has failed.
IPN: Decline




cardCategory

String

Indicates whether card was business, prepaid, etc.

IPNs:
  Auth Only
  Cancel on Renewal
  Cancellation
  Cancellation Refund
  Charge
  Charge Pending
  Contract Change
  Decline
  Payment Method Updated
  Recurring
  Subscription Charge Failure
  Under Review
  Under Vendor Review




cardIssuingCountry

String

The country where the payment card was issued.

IPNs:
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Contact Change
  Recurring
  Refund
  Subscription Charge Failure




cardIssuingOrg

String

The bank that issued the shopper's payment card.

IPNs:
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Contact Change
  Recurring
  Refund
  Subscription Charge Failure




cbStatus

String
Possible values:
  Closed
  Completed_Lost
  Completed_Pending
  Completed_Won
  New
  Working

Chargeback status.
IPNs:
  Chargeback
  Chargeback Status Changed




chargeDescription

String

Specifies the description passed in the <charge-description> element of the Create Subscription Charge request web service. For more details see Subscriptions.

Note: This parameter is also sent to affiliates.

IPN: Recurring




city

String

Shopper's city.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




company

String

Shopper's company name.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




contractChargePrice

Number
#,###.##

Price of contract in the shopper's currency. The price is per unit and does not include coupon discounts, balance carry-over, etc.

IPNs:
  Auth Only
  Cancellation Refund
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




contractId

Number

BlueSnap contract ID.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




contractLocalPrice

Number

Price of contract in shopper's local currency. If local currency is supported for the charge, the value should be the same as contractChargePrice.

IPNs:
  Auth Only
  CC Charge Failed
  Charge
  Charge Pending
  Contract Change
  Decline
  Under Review
  Under Vendor Review




contractName

String

Contract name.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




contractOwner

String

Contract owner.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




contractPrice

Number
#,###.##

Contract price per unit. Does not include coupon discounts, balance carry-over, etc.

IPNs:
  Auth Only
  Cancellation Refund
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Recurring
  Refund
  Subscription Charge Failure
  Under Review
  Under Vendor Review




country

String

Shopper country code.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




coupon

Y/N

Indicates whether the shopper used a coupon.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Decline
  Recurring
  Refund
  Subscription Reminder
  Under Review
  Under Vendor Review




couponChargeValue

Number
#,###.##

Coupon value in USD.

IPNs:
  Auth Only
  Cancellation Refund
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Recurring
  Refund
  Subscription Reminder
  Under Review
  Under Vendor Review




couponCode

String

Coupon code used.

IPNs:
  Auth Only
  Cancellation Refund
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Recurring
  Refund
  Subscription Reminder
  Under Review
  Under Vendor Review




couponValue

Number
#,###.##

Coupon value in USD.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Decline
  Recurring
  Refund
  Subscription Reminder
  Under Review
  Under Vendor Review




creditCardAddress1

String

Credit card address line 1 provided by the shopper.

IPNs:
  Payment Updated
  Payment Update Failure




creditCardAddress2

String

Credit card address line 2 provided by the shopper.

IPNs:
  Payment Updated
  Payment Update Failure




creditCardCity

String

Credit card city provided by the shopper.

IPNs:
  Payment Updated
  Payment Update Failure




creditCardCountry

String

Credit card country provided by the shopper.

IPNs:
  Payment Updated
  Payment Update Failure




creditCardExpDate

Number

Expiration date of the credit card being used for payment of purchase.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Under Review
  Under Vendor Review




creditCardFirstName

String

Shopper's first name, as printed on the credit card.

IPNs:
  Payment Updated
  Payment Update Failure




creditCardLastFourDigits

Number

Last four digits of the credit card being used for payment of purchase.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Fraud Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Under Review
  Under Vendor Review




creditCardLastName

String

Shopper's last name, as printed on the credit card.

IPNs:
  Payment Updated
  Payment Update Failure




creditCardSubType

String

Indicates whether the charge was debit or credit.

IPNs:
  Cancel on Renewal
  Cancellation
  Cancellation Refund
  Charge
  Charge Pending
  Charge Failure
  Payment Method Updated
  Recurring
  Subscription Charge Failure




creditCardType

String

Type of credit-card (i.e. AMEX/VISA).

IPNs:
  Account Updater
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Under Review
  Under Vendor Review




creditCardZipCode

String

Credit card ZIP code provided by the shopper.

IPNs:
  Payment Updated
  Payment Update Failure




currency

String

Three-digit currency code.
Example: “EUR”

IPNs:
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Failed Payout Transfer
  Fraud Decline
  Recurring
  Refund
  Subscription Charge Failure




currency[N]

String

Three-digit currency code. The index associates the currency to the corresponding payout amount.

IPN: Payout




custom{N}

String

Data selected or entered in the transaction for the custom field defined for the contract. Parameter name is extracted from the 'Title' field of the corresponding 'Custom Field'. For example, title label for custom1 = Gender. Gender is passed in the IPN.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Decline
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




daysTillCancelDate

mm/dd/yyyy hh:mi AM/PM

Number of days until the scheduled subscription cancellation date, which is based on the grace period defined for the contract.

IPNs:
  Cancel on Renewal
  Subscription Charge Failure
  Subscription Reminder




daysTillPaymentDue

mm/dd/yyyy hh:mi AM/PM

Number of days until the scheduled subscription payment is due.

IPN: Subscription Reminder




declineReason

String

Includes the decline reason code and description.

IPN: Decline




destination

String

ID of the account(s) where the funds are sent.
Example: “BOFAUS1ABC-1234”

IPNs:
  Failed Payout Transfer
  Payout




dpanExpDate

String

Expiration month and year of device account number. Relevant for Apple Pay transactions.

Example: 11%2F2025
Note: "%2F" in UTF-8 encoding means "/"

IPNs:
  Auth Only
  CC Charge Failed
  Cancel On Renewal
  Cancellation
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Payment Method Update Failure
  Payment Method Updated
  Recurring
  Refund
  Subscription Charge Failure
  Under Review
  Under Vendor Review




dpanLastFourDigits

String

Last four digits of device account number. Relevant for Apple Pay transactions.

Example: 7526

IPNs:
  Auth Only
  CC Charge Failed
  Cancel On Renewal
  Cancellation
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Payment Method Update Failure
  Payment Method Updated
  Recurring
  Refund
  Subscription Charge Failure
  Under Review
  Under Vendor Review




ecpPublicAccount

String

ECP Account Number. Only available if ECP payment type is used.

IPN: Charge Pending




ecpPublicRouting

String

ECP Routing Number. Only present if ECP payment type is used.

IPN: Charge Pending




EDWAmount

Number
#,###.##

Amount paid in the charge currency for the Extended Download Warranty.

IPNs:
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Refund
  Under Review
  Under Vendor Review




EDWAmountUSD

Number
#,###.##

Amount paid in USD for the Extended Download Warranty.

IPNs:
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Refund
  Under Review
  Under Vendor Review




EDWContractId

Number

Contract ID for which the Extended Download Warranty was sold.

IPNs:
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Refund
  Under Review
  Under Vendor Review




EDWPeriod

String

Period for which the Extended Download Warranty was sold (1-year or 2-year warranty).

IPNs:
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Refund
  Under Review
  Under Vendor Review




EDWSurcharge

Number
#,###.##

Surcharge amount in the charge currency for the Extended Download Warranty.

IPNs:
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Refund
  Under Review
  Under Vendor Review




EDWSurchargeUSD

Number
#,###.##

Surcharge amount for the Extended Download Warranty in USD.

IPNs:
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Refund
  Under Review
  Under Vendor Review




email

String

Shopper's email address.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Fraud Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




errorProcessingCode

String

Error code.

IPNs:
  CC Charge Failed
  Subscription Charge Failure




extension

String

Shopper's work phone extension.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




failureReason

String

Reason for the failure.

IPNs:
  CC Charge Failed
  Contract Change
  Subscription Charge Failure




faxNumber

String

Shopper's fax number.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




firstName

String

Shopper's first name.

IPNs:
  Auth Only
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Fraud Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




fraudDeclineDate

mm/dd/yyyy hh:mi AM/PM

Date of the fraud decline.

IPN: Fraud Decline




invoiceAddress1

String

Address line 1 on the invoice.

IPNs:
  Auth Only
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Recurring
  Refund
  Under Review
  Under Vendor Review




invoiceAddress2

String

Address line 2 on the invoice.

IPNs:
  Auth Only
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Recurring
  Refund
  Under Review
  Under Vendor Review




invoiceAmountUSD

Number
#,###.##

Amount in USD on the invoice.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Recurring
  Refund
  Under Review
  Under Vendor Review




invoiceChargeAmount

Number
#,###.##

Charged amount (in shopper's local currency) on the invoice.

IPNs:
  Auth Only
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Recurring
  Refund
  Under Review
  Under Vendor Review




invoiceChargeCurrency

String

Currency the Customer was billed in on the invoice.

IPNs:
  Auth Only
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Recurring
  Refund
  Under Review
  Under Vendor Review




invoiceCity

String

City on the invoice.

IPNs:
  Auth Only
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Recurring
  Refund
  Under Review
  Under Vendor Review




invoiceCompany

String

Company name on the invoice.

IPNs:
  Auth Only
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Recurring
  Refund
  Under Review
  Under Vendor Review




invoiceCountry

String

Country on the invoice.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Recurring
  Refund
  Under Review
  Under Vendor Review




invoiceEmail

String

Email address on the invoice.

IPNs:
  Auth Only
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Recurring
  Refund
  Under Review
  Under Vendor Review




invoiceExtension

String

Work phone extension on the invoice.

IPNs:
  Auth Only
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Recurring
  Refund
  Under Review
  Under Vendor Review




invoiceFaxNumber

String

Fax number on the invoice.

IPNs:
  Auth Only
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Recurring
  Refund
  Under Review
  Under Vendor Review




invoiceFirstName

String

First name on the invoice.

IPNs:
  Auth Only
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Recurring
  Refund
  Under Review
  Under Vendor Review




invoiceInfoURL

String

Returns link to order_locator_info.jsp page.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Chargeback
  Charge
  Charge IPN
  Charge Pending
  Decline
  Recurring
  Refund
  Under Review
  Under Vendor
  Under Vendor Review




invoiceLastName

String

Last name on the invoice.

IPNs:
  Auth Only
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Recurring
  Refund
  Under Review
  Under Vendor Review




invoiceLocalAmount

Number
#,###.##

Total amount of the order in the shopper's local currency. If local currency is natively supported for the charge, this is the same as the invoiceChargeAmount.

IPNs:
  Auth Only
  Cancellation Refund
  Charge
  Charge Pending
  Contract Change
  Decline
  Under Review
  Under Vendor Review




invoiceLocalCurrency

String

Shopper's selected currency for the order. If local currency is natively supported for the charge, this is the same as the invoiceChargeCurrency.

IPNs:
  Auth Only
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Decline
  Recurring
  Refund
  Under Review
  Under Vendor Review




invoiceState

String

State on the invoice.

IPNs:
  Auth Only
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Recurring
  Refund
  Under Review
  Under Vendor Review




invoiceTitle

String

Shopper's title on the invoice.

IPNs:
  Auth Only
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Recurring
  Refund
  Under Review
  Under Vendor Review




invoiceUrl

String

Direct URL to the purchase page on the invoice.

IPNs:
  Auth Only
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Recurring
  Refund
  Under Review
  Under Vendor Review




invoiceWorkPhone

String

Work phone number on the invoice.

IPNs:
  Auth Only
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Recurring
  Under Review
  Under Vendor Review




invoiceZipCode

String

ZIP code on the invoice.

IPNs:
  Auth Only
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Recurring
  Refund
  Under Review
  Under Vendor Review




language

String

Language of the BuyNow page.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




lastAttempt

Y/N

Indicates whether subscription charge retry was the last attempt.

IPN: Subscription Charge Failure




lastName

String

Shopper's last name.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Fraud Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




licenseKey

String

License key supplied to the shopper.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




linkedSubscriptions

String

Sent when responseMessage is 501 - Account closed. Contains all the subscription IDs linked to the credit card.

IPN: Account Updater




merchantEmail

String

Merchant email address
IPN: Merchant Partner Onboarded




merchantId

Number

BlueSnap merchant account number.
Example: 123456

IPNs:
  Failed Payout Transfer
  Merchant Partner Onboarded
  Payout




merchantName

String

Merchant name
IPN: Merchant Partner Onboarded




merchantTransactionId

Number

BlueSnap merchant transaction number.

IPNs:
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Recurring*
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review



* Recurring IPN with merchantTransactionId is only sent with merchant-managed subscriptions




newProductId

Number

ID of the new product, in the event of a subscription contract switch.

IPN: Contract Change




nextChargeDate

mm/dd/yyyy hh:mi AM/PM

Next scheduled charge date.

IPNs:
  Payment Updated
  Payment Update Failure




numberOfAttemptsDone

Number

Number of failed subscription charge attempts.

IPN: Subscription Charge Failure




offlineOrderId

Number

Relevant for a subscription paid using an offline payment method. This transaction should link to the Offline Order notification where the offlineOrderId is the same.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Decline
  Offline Order
  Recurring
  Refund
  Under Review
  Under Vendor Review




oldContractId

String

Old contract ID before the contract was switched.

IPNs:
  Contract Change
  Recurring




oldCustom[N]

String

Custom field value of the old contract (the first original contract) before contract was switched.

IPN: Contract Change




oldProductId

Number

ID of the old product, in the event of a subscription contract switch.

IPN: Contract Change




originalCreditCard
ExpirationMonth

Number

Expiration month of the credit card prior to the update.

IPN: Account Updater




originalCreditCard
ExpirationYear

Number

Expiration year of the credit card prior to the update.

IPN: Account Updater




originalCreditCard
Last4Digits

Number

Last 4 digits of the credit card prior to the update.

IPN: Account Updater




originalRefNum

Number

Reference number of the initial transaction of the recurring contract.

IPNs:
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  Payment Updated
  Payment Update Failure
  Recurring
  Subscription Charge Failure
  Subscription Reminder




originalRequestUrl

String

URL from which the original request to the BuyNow checkout page took place.

IPNs:
  Auth Only
  Cancel on Renewal
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Decline
  Refund
  Under Review
  Under Vendor Review




payeeName

String

Payee name as defined in merchant name.

Example: “John Doe”

IPN: Failed Payout Transfer




payeePhoneNumber

Number

Payee’s phone number as defined in merchant's phone number or merchant's mobile phone number, if the former is blank.

Example: 1264594894

IPN: Failed Payout Transfer




payeeEmail

String

Payee's main email address as defined in merchant's email address.

Example: “john@someservice.com”

IPN: Failed Payout Transfer




paymentCycleEndDate

String

Indicates the last day of the payment cycle.

IPN: Payout




paymentCycleStartDate

String

Indicates the first day of the payment cycle.

IPN: Payout




paymentId

String

Unique reference ID for each payout.
Example: 1234

IPN:
  Failed Payout Transfer
  Payout




paymentMethod

String

Method of payment (i.e. CC/Paypal/Wire). Duplicate of paymentType.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Fraud Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  RefundSubscription Reminder
  Subscription Charge Failure
  Under Review
  Under Vendor Review




paymentURL

String

Link to the page with payment instructions for the shopper to renew their subscription.

IPN: Subscription Reminder




payoutStatus

'Yes'
'No'
'Pending'

Specifies if the merchant is set up for payout.

IPN: Merchant Partner Onboarding




paypalSubscriptionId

Number

Subscription ID in the merchant's PayPal account.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Decline
  Recurring
  Refund
  Subscription Charge Failure
  Under Review
  Under Vendor Review




paypalTransactionId

Number

Transaction ID in the merchant's PayPal account.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Decline
  Recurring
  Refund
  Subscription Charge Failure
  Under Review
  Under Vendor Review




personalId

String

Personal identification number for shoppers in these countries:
  Argentina - DNI
  Brazil - CPF/CNPJ
  Chile - RUN
  Colombia - CC
  Mexico - CURP/RFC

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




proccessorCode

String

Deprecated — Do not use
Name of processor or acquiring bank name.

IPNs:
  CC Charge Failed
  Subscription Charge Failure




productId

Number

BlueSnap product ID.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




productName

String

Product name.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




promoteContract
ChargePrice{N}

Number
#,###.##

Price of the promotional contract in the currency the shopper was charged.

IPNs:
  Auth Only
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Refund
  Under Review
  Under Vendor Review




promoteContractId{N}

Number

ID of the promotional contract.

IPNs:
  Auth Only
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Decline
  Refund
  Under Review
  Under Vendor Review




promoteContract
LicenseKey{N}

String

License key linked to the promotional contract.

IPNs:
  Auth Only
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Decline
  Refund
  Under Review
  Under Vendor Review




promoteContract
LocalPrice{N}

Number
#,###.##

Price in the shopper's local currency. If the local currency is natively supported for the charge, the value should be the same as promoteContractChargePrice.

IPNs:
  Auth Only
  CC Charge Failed
  Charge
  Charge Pending
  Contract Change
  Decline
  Under Review
  Under Vendor Review




promoteContractName{N}

String

Name of the promotional contract.

IPNs:
  Auth Only
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Decline
  Refund
  Under Review
  Under Vendor Review




promoteContractOwner{N}

String

Contract owner's BlueSnap ID. Relevant if you are promoting another merchant's products.

IPNs:
  Auth Only
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Decline
  Refund
  Under Review
  Under Vendor Review




promoteContractPrice{N}

String

Promotional contract price in USD. It should not include any deductions or additions: no coupons, tax or other. It should only list the price the customer paid for the contract in USD.

IPNs:
  Auth Only
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Refund
  Under Review
  Under Vendor Review




promoteContractQuantity{N}

Number

Quantity of the promotional contract.

IPNs:
  Auth Only
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Decline
  Refund
  Under Review
  Under Vendor Review




promoteContractsNum

Number

Number of promotions.

IPNs:
  Auth Only
  Cancellation
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Recurring
  Refund
  Under Review
  Under Vendor Review




promoteProductId{N}

Number

ID of the promotional item.

IPNs:
  Auth Only
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Decline
  Refund
  Under Review
  Under Vendor Review




promoteProductName{N}

String

Name of the promotional contract.

IPNs:
  Auth Only
  Cancellation
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Decline
  Refund
  Under Review
  Under Vendor Review




promoteSubscriptionId{N}

Number

Subscription ID of the promotional contract.

IPNs:
  Auth Only
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Decline
  Refund
  Under Review
  Under Vendor Review




purchaseDate

mm/dd/yyyy hh:mi AM/PM

Transaction date of the original invoice.

IPNs:
  Cancellation Refund
  Chargeback
  Chargeback Status Changed
  Refund




quantity

Number

Quantity ordered.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




recurringDisclaimer

Y/N

Indicates whether a shopper authorized a merchant to use their account details for future purchases via the API.

IPNs:
  Auth Only
  Charge
  Charge Pending
  Contract Change
  Under Review
  Under Vendor Review




referenceNumber

Number

BlueSnap reference number.

Note: referenceNumber, invoice ID, order ID, and Transaction ID are interchangeable.

IPNs:
  Auth Only
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Recurring
  Refund
  Under Review
  Under Vendor Review




referrer

String

Referrer URL that the Customer came from to the BuyNow page.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




regulatedCard

String
Possible values:

  N (No, default):
  Card is not regulated
  Y (Yes):
  Card is regulated

Indicates whether or not this card is regulated.

IPNs:
  Auth Only
  Cancel on Renewal
  Cancellation
  Cancellation Refund
  Charge
  Contract Change
  Decline
  Payment Method Updated
  Recurring
  Subscription Charge Failure
  Under Review
  Under Vendor Review




reminderNumber

Number

Reminder number of the notice sent to the shopper (1, 2, or 3).

IPN: Subscription Reminder




remoteAddress

String

Shopper's remote IP address.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Recurring
  Refund
  Under Review
  Under Vendor Review




responseDate

mm/dd/yyyy hh:mi AM/PM

Date the update was processed.

IPN: Account Updater




responseMessage

String

Account Updater completion response code.

IPN: Account Updater




resultCode

String

Recurring IPN is sent if there is a charge for the first contract. BlueSnap sends the status (successful or failure) of the charge for the contract.

IPN: Contract Change




reversalAmount

String

Amount of the refund.

IPNs:
  Cancellation Refund
  Refund




reversalReason

String

Reason for the refund or chargeback.

IPNs:
  Chargeback
  Chargeback Status Changed
  Refund




reversalRefNum

Number

Reference number of the refund or chargeback.
For the reference number of the original transaction, see the ‘referenceNumber’ parameter in this IPN.

IPNs:
  Chargeback
  Chargeback Status Changed
  Refund




sealcomodovisible

String

Defines whether the Comodo seal is visible.




sellerShopperId

String

A unique shopper ID assigned by the merchant.
Relevant only for merchants using the Extended Payment API who send this in the request.

IPN: Account Updater




sendStatus

String

Status of the sent reminder (sent, failed, or sent by seller).

IPN: Subscription Reminder




sepaIban

String
Format:
{first4}XXXXXXXXX{last4}
Example: 1234XXXXXXXX6789

IBAN for SEPA Direct Debit payment.

IPNs:
  Cancellation
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Decline
  Recurring
  Refund




sepaMandateDate

Date

Mandate date for the SEPA Direct Debit payment.

IPNs:
  Cancellation
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Decline
  Recurring
  Refund




sepaMandateId

String

Mandate ID for the SEPA Direct Debit payment.

IPNs:
  Cancellation
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Decline
  Recurring
  Refund




shippingAddress1

String

Shipping address line 1.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Refund
  Under Review
  Under Vendor Review




shippingAddress2

String

Shipping address line 2.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Refund
  Under Review
  Under Vendor Review




shippingCity

String

Shipping city.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Refund
  Under Review
  Under Vendor Review




shippingCountry

String

Shipping country.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Refund
  Under Review
  Under Vendor Review




shippingFirstName

String

Shipping first name.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Refund
  Under Review
  Under Vendor Review




shippingLastName

String

Shipping last name.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Refund
  Under Review
  Under Vendor Review




shippingMethod

String

Shipping method, such as UPS or USPS.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Refund
  Under Review
  Under Vendor Review




shippingState

String

Shipping state.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Refund
  Under Review
  Under Vendor Review




shippingZipCode

String

Shipping ZIP code.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Refund
  Under Review
  Under Vendor Review




shopperOrderUrl

String

Link to the shopper's order information page.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Under Review
  Under Vendor Review




state

String

Shopper's state.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




subscriptionCancelled

Y/N

Indicates whether the subscription in the charged back invoice was cancelled along with the refund or chargeback.

IPNs:
  Chargeback
  Chargeback Status Changed




subscriptionId

Number

Subscription ID. The subscription ID is displayed in each recurring charge.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




targetBalance

String

Where the transaction funds will be credited or refund made (could be BlueSnap account or Merchant PayPal account).

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Refund
  Subscription Charge Failure
  Under Review
  Under Vendor Review




taxAmountUSD

Number
#,###.##

Amount, in USD, of tax/VAT paid by a shopper for the order.

IPNs:
  Cancellation
  Cancellation Refund
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Recurring
  Refund
  Under Review
  Under Vendor Review




taxChargeAmount

Number
#,###.##

Amount, in charge currency, of tax/VAT paid by a shopper for the order.

IPNs:
  Cancellation
  Cancellation Refund
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Recurring
  Refund
  Under Review
  Under Vendor Review




taxRate

String

Rate of VAT, based on the shopper’s country. Value should be a percentage (%).

IPNs:
  Cancellation
  Cancellation Refund
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Recurring
  Refund
  Under Review
  Under Vendor Review




templateId

Number

ID of the BuyNow skin (template) used for the purchase. If a default template was used (no parameter submitted to BuyNow), its ID will also be provided.

IPNs:
  Auth Only
  Cancellation
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Recurring
  Refund
  Under Review
  Under Vendor Review




testMode

Y/N

Test transaction made by the Merchant.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Decline
  Recurring
  Refund
  Subscription Charge Failure
  Under Review
  Under Vendor Review




title

String

Shopper's title.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




transactionDate

mm/dd/yyyy hh:mi AM/PM

Date and time that the transaction occurred.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




transactionType

String
Possible values:
  ACCOUNT_UPDATER
  AUTH_ONLY
  CANCELLATION
  CANCELLATION_REFUND
  CANCEL_ON_RENEWAL
  CC_CHARGE_FAILED
  CHARGE
  CHARGE_PENDING
  CHARGEBACK
  
  CONTRACT_CHANGE
  DECLINE
  OFFLINE_ORDER
  PAYMENT_UPDATED
  PAYMENT_UPDATE_FAILURE
  RECURRING
  REFUND
  SUBSCRIPTION_CHARGE_FAILURE
  SUBSCRIPTION_REMINDER
  UNDER_REVIEW
  UNDER_VENDOR_REVIEW

Indicates the transaction type,

IPNs:
  Account Updater
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




untilDate

mm/dd/yyyy hh:mi AM/PM

The next scheduled renewal date of a subscription.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




updatedCreditCard
ExpirationMonth

Number

Expiration month of the credit card after the update.

IPN: Account Updater




updatedCreditCard
ExpirationYear

Number

Expiration year of the credit card after the update.

IPN: Account Updater




updatedCreditCard
Last4Digits

Number

Last 4 digits of the credit card after the update.

IPN: Account Updater




updatedCreditCardType

String

Credit card type after the update (i.e. Visa, Mastercard, etc.).

IPN: Account Updater




vatId

Number

Shopper’s VAT ID, as provided during their purchase.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Recurring
  Refund
  Subscription Charge Failure
  Under Review
  Under Vendor Review




vendorAccountOpenedDate

mm/dd/yyyy hh:mi AM/PM

Date vendor account opened.

IPN: Vendor Status Changed




vendorAccountStatus

String
Possible values:
  Active
  Inactive

Vendor's account status.

IPN: Vendor Status Changed




vendorAccountStatusChangedDate

mm/dd/yyyy hh:mi AM/PM

Date of vendor account status change.

IPN: Vendor Status Changed




vendor[N].id

Number

Vendor's ID. Used to associate transactions with primary merchant. The index associates the vendor ID to the corresponding vendor name.

IPNs:
  Auth Only
  Cancel on Renewal
  Cancellation
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Contract Change
  Decline
  Payment Method Update Failure
  Payment Method Updated
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




vendor[N].name

String

Vendor's name. The index associates the vendor name to the corresponding vendor ID.

IPNs:
  Auth Only
  Cancel on Renewal
  Cancellation
  Cancellation Refund
  Charge
  Charge Pending
  Chargeback
  Contract Change
  Decline
  Payment Method Update Failure
  Payment Method Updated
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review




vendorId

Number

Vendor's ID. Used to associate transactions with primary merchant.
Example: 123457

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change (only applicable to subscriptions)
  Decline
  Failed Payout Transfer
  Payment Updated
  Payment Updated Failure
  Recurring
  Refund
  Subscription Reminder
  Under Review
  Under Vendor Review
  Vendor Status Changed




vendorMissingFields

String

Contains missing vendor information. Sent when vendorPayoutStatus is N.

IPN: Vendor Status Changed




vendorName

String

Vendor's name.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change (only applicable to subscriptions)
  Decline
  Payment Updated
  Payment Updated Failure
  Recurring
  Refund
  Subscription Reminder
  Under Review
  Under Vendor Review
  Vendor Status Changed




vendorPayoutDeclineReason

String
Possible values:
  Cannot verify vendor information
  Card brand violation
  Fraud
  Other

Reason for vendor decline.
Sent when vendorPayoutStatus is D.

IPN: Vendor Status Changed




vendorPayoutStatus

String

Possible values:
  R (Under review/pending)
  N (Incomplete)
  A (Approved)
  D (Declined)

Vendor's payout status.

IPN: Vendor Status Changed




vendorProcessingStatus

String
Possible values:
  Active
  Inactive

Vendor's processing status.

IPN: Vendor Status Changed




workPhone

String

Shopper's work phone number.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Under Review
  Under Vendor Review




zipCode

String

Shopper's ZIP code.

IPNs:
  Auth Only
  Cancellation
  Cancellation Refund
  Cancel on Renewal
  CC Charge Failed
  Charge
  Charge Pending
  Chargeback
  Chargeback Status Changed
  Contract Change
  Decline
  Offline Order
  Payment Updated
  Payment Update Failure
  Recurring
  Refund
  Subscription Charge Failure
  Subscription Reminder
  Under Review
  Under Vendor Review

IPN Parameter Reference


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.