All IPNs Name Reference

Below are all the IPNs (webhooks) that BlueSnap offers (separated by type) with the IPN name, description, and associated parameters. For a complete list of all parameters that are sent in IPNs, refer to the IPN parameter reference.

Default IPNs
Default IPNs are available automatically.

On-Demand IPNs
On-Demand IPNs are available in addition to the standard Default IPN types. To enable these IPN types, see Enabling IPNs in BlueSnap.


Default IPNs

IPN
Description
Parameters

AUTH_ONLY

Sent when an Authorization Only request is performed. Auth Only is a request to check whether a credit card is valid and has the funds to complete a specific transaction (i.e. purchase). It does not actually run a charge on the card, but does temporarily hold the funds aside. It can also be run with a 0 charge value.

  • addCD
  • additionalChargeName[N]
  • address1
  • address2
  • armadilloHardwareId
  • authkey
  • bluesnapNode (also appears as plimusNode)
  • binCategory
  • city
  • company
  • contractChargePrice
  • contractId
  • contractLocalPrice
  • contractName
  • contractOwner
  • contractPrice
  • country
  • coupon
  • couponChargeValue
  • couponCode
  • couponValue
  • creditCardExpDate
  • creditCardLastFourDigits
  • creditCardType
  • cardCategory
  • custom{N}
  • dpanExpDate
  • dpanLastFourDigits
  • email
  • extension
  • faxNumber
  • firstName
  • invoiceAddress1
  • invoiceAddress2
  • invoiceAmountUSD
  • invoiceChargeAmount
  • invoiceChargeCurrency
  • invoiceCity
  • invoiceCompany
  • invoiceCountry
  • invoiceEmail
  • invoiceExtension
  • invoiceFaxNumber
  • invoiceFirstName
  • invoiceLastName
  • invoiceLocalAmount
  • invoiceLocalCurrency
  • invoiceState
  • invoiceTitle
  • invoiceUrl
  • invoiceWorkPhone
  • invoiceZipCode
  • language
  • lastName
  • licenseKey
  • offlineOrderId
  • originalRequestUrl
  • paymentMethod
  • paypalSubscriptionId
  • paypalTransactionId
  • personalId
  • productId
  • productName
  • promoteContract
  • promoteContractId{N}
  • promoteContract
  • promoteContract
  • promoteContractName{N}
  • promoteContractOwner{N}
  • promoteContractPrice{N}
  • promoteContractQuantity{N}
  • promoteContractsNum
  • promoteProductId{N}
  • promoteProductName{N}
  • promoteSubscriptionId{N}
  • quantity
  • recurringDisclaimer
  • referenceNumber
  • referrer
  • regulatedCard
  • remoteAddress
  • shippingAddress1
  • shippingAddress2
  • shippingCity
  • shippingCountry
  • shippingFirstName
  • shippingLastName
  • shippingMethod
  • shippingState
  • shippingZipCode
  • shopperOrderUrl
  • state
  • subscriptionId
  • targetBalance
  • templateId
  • testMode
  • title
  • transactionDate
  • transactionType
  • untilDate
  • vatId
  • vendor[N].id
  • vendor[N].name
  • vendorId
  • vendorName
  • workPhone
  • zipCode




CANCEL_ON_RENEWAL

Sent when a customer requests to cancel a subscription that is set to auto renew. The subscription will be cancelled automatically at the end of the subscription period.

  • accountId
  • address1
  • address2
  • binCategory
  • bluesnapNode (also appears as plimusNode)
  • cancelRenewal
  • city
  • company
  • contractName
  • contractOwner
  • country
  • creditCardExpDate
  • creditCardLastFourDigits
  • creditCardType
  • cardSubType
  • cardCategory
  • custom{N}
  • daysTillCancelDate
  • dpanExpDate
  • dpanLastFourDigits
  • email
  • extension
  • faxNumber
  • firstName
  • language
  • lastName
  • licenseKey
  • merchantTransactionId
  • offlineOrderId
  • originalRefNum
  • originalRequestUrl
  • paymentMethod
  • paypalSubscriptionId
  • paypalTransactionId
  • personalId
  • productId
  • productName
  • quantity
  • referrer
  • regulatedCard
  • remoteAddress
  • shippingAddress1
  • shippingAddress2
  • shippingCity
  • shippingCountry
  • shippingFirstName
  • shippingLastName
  • shippingMethod
  • shippingState
  • shippingZipCode
  • shopperOrderUrl
  • state
  • subscriptionId
  • targetBalance
  • testMode
  • title
  • transactionDate
  • transactionType
  • untilDate
  • vatId
  • vendor[N].id
  • vendor[N].name
  • vendorId
  • vendorName
  • workPhone
  • zipCode




CANCELLATION

Sent when a recurring charge is cancelled. The cancellation can be initiated by the customer, merchant, or BlueSnap.

  • accountId
  • addCD
  • address1
  • address2
  • armadilloHardwareId
  • authkey
  • binCategory
  • bluesnapNode (also appears as plimusNode)
  • cancelledContractId
  • cancelReason
  • city
  • company
  • contractId
  • contractName
  • contractOwner
  • country
  • coupon
  • couponValue
  • creditCardExpDate
  • creditCardLastFourDigits
  • creditCardType
  • cardSubType
  • cardCategory
  • custom{N}
  • dpanExpDate
  • dpanLastFourDigits
  • email
  • extension
  • faxNumber
  • invoiceAmountUSD
  • invoiceCountry
  • language
  • lastName
  • licenseKey
  • merchantTransactionId
  • offlineOrderId
  • originalRefNum
  • paymentMethod
  • paypalSubscriptionId
  • paypalTransactionId
  • personalId
  • productId
  • productName
  • promoteContractsNum
  • promoteProductName{N}
  • quantity
  • referrer
  • regulatedCard
  • remoteAddress
  • sepaIban
  • sepaMandateDate
  • sepaMandateId
  • shippingAddress1
  • shippingAddress2
  • shippingCity
  • shippingCountry
  • shippingFirstName
  • shippingLastName
  • shippingMethod
  • shippingState
  • shippingZipCode
  • shopperOrderUrl
  • state
  • subscriptionId
  • targetBalance
  • taxAmountUSD
  • taxChargeAmount
  • taxRate
  • templateId
  • testMode
  • title
  • transactionDate
  • transactionType
  • untilDate
  • vatId
  • vendor[N].id
  • vendor[N].name
  • vendorId
  • vendorName
  • workPhone
  • zipCode




CANCELLATION_REFUND

Sent when a subscription is cancelled and a refund is processed.

  • addCD
  • additionalChargeAmount[N]
  • additionalChargeCategory[N]
  • additionalChargeName[N]
  • address1
  • address2
  • armadilloHardwareId
  • authkey
  • binCategory
  • bluesnapNode (also appears as plimusNode)
  • cancelReason
  • city
  • company
  • contractChargePrice
  • contractId
  • contractName
  • contractOwner
  • contractPrice
  • country
  • coupon
  • couponChargeValue
  • couponCode
  • couponValue
  • creditCardExpDate
  • creditCardLastFourDigits
  • creditCardType
  • cardSubType
  • cardCategory
  • custom{N}
  • dpanExpDate
  • dpanLastFourDigits
  • email
  • extension
  • faxNumber
  • firstName
  • invoiceAddress1
  • invoiceAddress2
  • invoiceAmountUSD
  • invoiceChargeAmount
  • invoiceChargeCurrency
  • invoiceCity
  • invoiceCompany
  • invoiceCountry
  • invoiceEmail
  • invoiceExtension
  • invoiceFaxNumber
  • invoiceFirstName
  • invoiceLastName
  • invoiceLocalAmount
  • invoiceLocalCurrency
  • invoiceState
  • invoiceTitle
  • invoiceUrl
  • invoiceWorkPhone
  • invoiceZipCode
  • language
  • lastName
  • licenseKey
  • merchantTransactionId
  • offlineOrderId
  • originalRefNum
  • paymentMethod
  • paypalSubscriptionId
  • paypalTransactionId
  • personalId
  • productId
  • productName
  • purchaseDate
  • quantity
  • referenceNumber
  • referrer
  • regulatedCard
  • remoteAddress
  • reversalAmount
  • sepaIban
  • sepaMandateDate
  • sepaMandateId
  • shippingAddress1
  • shippingAddress2
  • shippingCity
  • shippingCountry
  • shippingFirstName
  • shippingLastName
  • shippingMethod
  • shippingState
  • shippingZipCode
  • shopperOrderUrl
  • state
  • subscriptionId
  • targetBalance
  • taxAmountUSD
  • taxChargeAmount
  • taxRate
  • testMode
  • title
  • transactionDate
  • transactionType
  • untilDate
  • vatId
  • vendor[N].id
  • vendor[N].name
  • vendorId
  • vendorName
  • workPhone
  • zipCode




CHARGE

Sent when a new purchase has been completed. This applies to both one-time charges and recurring charges.

  • 3dStatus
  • accountId
  • addCD
  • additionalChargeAmount[N]
  • additionalChargeCategory[N]
  • additionalChargeName[N]
  • address1
  • address2
  • armadilloHardwareId
  • authkey
  • binCategory
  • binNumber
  • bluesnapManualFee
  • bluesnapNode (also appears as plimusNode)
  • captureReferenceNumber
  • city
  • company
  • contractChargePrice
  • contractId
  • contractLocalPrice
  • contractName
  • contractOwner
  • contractPrice
  • country
  • coupon
  • couponChargeValue
  • couponCode
  • couponValue
  • creditCardExpDate
  • creditCardLastFourDigits
  • creditCardSubType
  • cardCategory
  • cardIssuingCountry
  • cardIssuingOrg
  • creditCardType
  • currency
  • custom{N}
  • dpanExpDate
  • dpanLastFourDigits
  • EDWAmount
  • EDWAmountUSD
  • EDWContractId
  • EDWPeriod
  • EDWSurcharge
  • EDWSurchargeUSD
  • email
  • extension
  • faxNumber
  • firstName
  • invoiceAddress1
  • invoiceAddress2
  • invoiceAmountUSD
  • invoiceChargeAmount
  • invoiceChargeCurrency
  • invoiceCity
  • invoiceCompany
  • invoiceCountry
  • invoiceEmail
  • invoiceExtension
  • invoiceFaxNumber
  • invoiceFirstName
  • invoiceLastName
  • invoiceLocalAmount
  • invoiceLocalCurrency
  • invoiceState
  • invoiceTitle
  • invoiceUrl
  • invoiceWorkPhone
  • invoiceZipCode
  • lastName
  • licenseKey
  • merchantTransactionId
  • offlineOrderId
  • originalRequestUrl
  • paymentMethod
  • paypalSubscriptionId
  • paypalTransactionId
  • personalId
  • productId
  • productName
  • promoteContract
  • promoteContractId{N}
  • promoteContract
  • promoteContract
  • promoteContractName{N}
  • promoteContractOwner{N}
  • promoteContractPrice{N}
  • promoteContractQuantity{N}
  • promoteContractsNum
  • promoteProductId{N}
  • promoteProductName{N}
  • promoteSubscriptionId{N}
  • quantity
  • recurringDisclaimer
  • referenceNumber
  • referrer
  • regulatedCard
  • remoteAddress
  • sepaIban
  • sepaMandateDate
  • sepaMandateId
  • shippingAddress1
  • shippingAddress2
  • shippingCity
  • shippingCountry
  • shippingFirstName
  • shippingLastName
  • shippingMethod
  • shippingState
  • shippingZipCode
  • shopperOrderUrl
  • state
  • subscriptionId
  • targetBalance
  • taxAmountUSD
  • taxChargeAmount
  • taxRate
  • templateId
  • testMode
  • title
  • transactionDate
  • transactionType
  • untilDate
  • vatId
  • vendor[N].id
  • vendor[N].name
  • vendorId
  • vendorName
  • workPhone
  • zipCode




CHARGEBACK

Sent when a shopper challenges a transaction with their issuing bank, who then initiates the chargeback process. This IPN (webhook) provides you the opportunity to address the issue.

  • accountId
  • addCD
  • additionalChargeAmount[N]
  • additionalChargeCategory[N]
  • additionalChargeName[N]
  • address1
  • address2
  • armadilloHardwareId
  • authkey
  • binNumber
  • bluesnapNode (also appears as plimusNode)
  • cancelReason
  • cardIssuingCountry
  • cardIssuingOrg
  • cbStatus
  • city
  • company
  • contractChargePrice
  • contractId
  • contractName
  • contractOwner
  • contractPrice
  • country
  • coupon
  • couponChargeValue
  • couponCode
  • couponValue
  • creditCardExpDate
  • creditCardLastFourDigits
  • creditCardType
  • currency
  • custom{N}
  • dpanExpDate
  • dpanLastFourDigits
  • EDWAmount
  • EDWAmountUSD
  • EDWContractId
  • EDWPeriod
  • EDWSurcharge
  • EDWSurchargeUSD
  • email
  • extension
  • faxNumber
  • firstName
  • invoiceAddress1
  • invoiceAddress2
  • invoiceAmountUSD
  • invoiceChargeAmount
  • invoiceChargeCurrency
  • invoiceCity
  • invoiceCompany
  • invoiceCountry
  • invoiceEmail
  • invoiceExtension
  • invoiceFaxNumber
  • invoiceFirstName
  • invoiceLastName
  • invoiceLocalCurrency
  • invoiceState
  • invoiceTitle
  • invoiceUrl
  • invoiceWorkPhone
  • invoiceZipCode
  • language
  • lastName
  • licenseKey
  • merchantTransactionId
  • offlineOrderId
  • originalRequestUrl
  • paymentMethod
  • paypalSubscriptionId
  • paypalTransactionId
  • personalId
  • productId
  • productName
  • promoteContract
  • promoteContractId{N}
  • promoteContract
  • promoteContractName{N}
  • promoteContractOwner{N}
  • promoteContractPrice{N}
  • promoteContractQuantity{N}
  • promoteContractsNum
  • promoteProductId{N}
  • promoteProductName{N}
  • promoteSubscriptionId{N}
  • purchaseDate
  • quantity
  • referenceNumber
  • referrer
  • remoteAddress
  • reversalReason
  • reversalRefNum
  • sepaIban
  • sepaMandateDate
  • sepaMandateId
  • shippingAddress1
  • shippingAddress2
  • shippingCity
  • shippingCountry
  • shippingFirstName
  • shippingLastName
  • shippingMethod
  • shippingState
  • shippingZipCode
  • shopperOrderUrl
  • state
  • subscriptionCancelled
  • subscriptionId
  • targetBalance
  • taxAmountUSD
  • taxChargeAmount
  • taxRate
  • templateId
  • testMode
  • title
  • transactionDate
  • transactionType
  • untilDate
  • vatId
  • vendor[N].id
  • vendor[N].name
  • vendorId
  • vendorName
  • workPhone
  • zipCode




CHARGEBACK_STATUS_CHANGED

Sent when an event is received from Chargebacks911 that does not open a new chargeback.

  • accountId
  • addCD
  • additionalChargeAmount[N]
  • additionalChargeCategory[N]
  • additionalChargeName[N]
  • address1
  • address2
  • armadilloHardwareId
  • authkey
  • bluesnapNode (also appears as plimusNode)
  • cancelReason
  • cbStatus
  • city
  • company
  • contractChargePrice
  • contractId
  • contractName
  • contractOwner
  • contractPrice
  • country
  • coupon
  • couponChargeValue
  • couponCode
  • couponValue
  • creditCardExpDate
  • creditCardLastFourDigits
  • creditCardType
  • currency
  • custom{N}
  • dpanExpDate
  • dpanLastFourDigits
  • EDWAmount
  • EDWAmountUSD
  • EDWContractId
  • EDWPeriod
  • EDWSurcharge
  • EDWSurchargeUSD
  • email
  • extension
  • faxNumber
  • firstName
  • invoiceAddress1
  • invoiceAddress2
  • invoiceAmountUSD
  • invoiceChargeAmount
  • invoiceChargeCurrency
  • invoiceCity
  • invoiceCompany
  • invoiceCountry
  • invoiceEmail
  • invoiceExtension
  • invoiceFaxNumber
  • invoiceFirstName
  • invoiceLastName
  • invoiceLocalCurrency
  • invoiceState
  • invoiceTitle
  • invoiceUrl
  • invoiceWorkPhone
  • invoiceZipCode
  • language
  • lastName
  • licenseKey
  • merchantTransactionId
  • offlineOrderId
  • originalRequestUrl
  • paymentMethod
  • paypalSubscriptionId
  • paypalTransactionId
  • personalId
  • productId
  • productName
  • promoteContract
  • promoteContractId{N}
  • promoteContract
  • promoteContractName{N}
  • promoteContractOwner{N}
  • promoteContractPrice{N}
  • promoteContractQuantity{N}
  • promoteContractsNum
  • promoteProductId{N}
  • promoteProductName{N}
  • promoteSubscriptionId{N}
  • purchaseDate
  • quantity
  • referenceNumber
  • referrer
  • remoteAddress
  • reversalReason
  • reversalRefNum
  • sepaIban
  • sepaMandateDate
  • sepaMandateId
  • shippingAddress1
  • shippingAddress2
  • shippingCity
  • shippingCountry
  • shippingFirstName
  • shippingLastName
  • shippingMethod
  • shippingState
  • shippingZipCode
  • shopperOrderUrl
  • state
  • subscriptionCancelled
  • subscriptionId
  • targetBalance
  • taxAmountUSD
  • taxChargeAmount
  • taxRate
  • templateId
  • testMode
  • title
  • transactionDate
  • transactionType
  • untilDate
  • vatId
  • vendorId
  • vendorName
  • workPhone
  • zipCode




CONTRACT_CHANGE

Sent when the contract associated with a recurring charge or a subscription contract is replaced with another contract, such as a customer moving from one service plan to another.

  • accountId
  • addCD
  • additionalChargeAmount[N]
  • additionalChargeCategory[N]
  • additionalChargeName[N]
  • address1
  • address2
  • authkey
  • binCategory
  • binNumber
  • bluesnapNode (also appears as plimusNode)
  • cardCategory
  • cardIssuingCountry
  • cardIssuingOrg
  • city
  • company
  • contractChargePrice
  • contractId
  • contractLocalPrice
  • contractName
  • contractOwner
  • contractPrice
  • country
  • couponChargeValue
  • couponCode
  • creditCardExpDate
  • creditCardLastFourDigits
  • creditCardType
  • currency
  • dpanExpDate
  • dpanLastFourDigits
  • EDWAmount
  • EDWAmountUSD
  • EDWContractId
  • EDWPeriod
  • EDWSurcharge
  • EDWSurchargeUSD
  • email
  • extension
  • failureReason
  • faxNumber
  • firstName
  • invoiceAddress1
  • invoiceAddress2
  • invoiceAmountUSD
  • invoiceChargeAmount
  • invoiceChargeCurrency
  • invoiceCity
  • invoiceCompany
  • invoiceCountry
  • invoiceEmail
  • invoiceExtension
  • invoiceFaxNumber
  • invoiceFirstName
  • invoiceLastName
  • invoiceLocalAmount
  • invoiceLocalCurrency
  • invoiceState
  • invoiceTitle
  • invoiceUrl
  • invoiceWorkPhone
  • invoiceZipCode
  • language
  • lastName
  • licenseKey
  • merchantTransactionId
  • newProductId
  • oldContractId
  • oldCustom[N]
  • oldProductId
  • paymentMethod
  • personalId
  • productId
  • productName
  • promoteContract
  • promoteContract
  • promoteContractPrice{N}
  • promoteContractsNum
  • quantity
  • recurringDisclaimer
  • referenceNumber
  • referrer
  • regulatedCard
  • remoteAddress
  • resultCode
  • shippingAddress1
  • shippingAddress2
  • shippingCity
  • shippingCountry
  • shippingFirstName
  • shippingLastName
  • shippingMethod
  • shippingState
  • shippingZipCode
  • shopperOrderUrl
  • state
  • subscriptionId
  • targetBalance
  • taxAmountUSD
  • taxChargeAmount
  • taxRate
  • templateId
  • title
  • transactionDate
  • transactionType
  • untilDate
  • vatId
  • vendor[N].id
  • vendor[N].name
  • vendorId
  • vendorName
  • workPhone
  • zipCode




DECLINE

Sent when a transaction is declined due to BlueSnap manual review process.

  • accountId
  • addCD
  • additionalChargeAmount[N]
  • additionalChargeCategory[N]
  • additionalChargeName[N]
  • address1
  • address2
  • armadilloHardwareId
  • authkey
  • binCategory
  • bluesnapNode (also appears as plimusNode)
  • captureStatus
  • city
  • company
  • contractChargePrice
  • contractId
  • contractLocalPrice
  • contractName
  • contractOwner
  • contractPrice
  • country
  • coupon
  • couponChargeValue
  • couponCode
  • couponValue
  • creditCardExpDate
  • creditCardLastFourDigits
  • creditCardType
  • cardCategory
  • custom{N}
  • declineReason
  • dpanExpDate
  • dpanLastFourDigits
  • EDWAmount
  • EDWAmountUSD
  • EDWContractId
  • EDWPeriod
  • EDWSurcharge
  • EDWSurchargeUSD
  • email
  • extension
  • faxNumber
  • firstName
  • invoiceAddress1
  • invoiceAddress2
  • invoiceAmountUSD
  • invoiceChargeAmount
  • invoiceChargeCurrency
  • invoiceCity
  • invoiceCompany
  • invoiceCountry
  • invoiceEmail
  • invoiceExtension
  • invoiceFaxNumber
  • invoiceFirstName
  • invoiceLastName
  • invoiceLocalAmount
  • invoiceLocalCurrency
  • invoiceState
  • invoiceTitle
  • invoiceUrl
  • invoiceWorkPhone
  • invoiceZipCode
  • language
  • lastName
  • licenseKey
  • merchantTransactionId
  • offlineOrderId
  • originalRequestUrl
  • paymentMethod
  • paypalSubscriptionId
  • paypalTransactionId
  • personalId
  • productId
  • productName
  • promoteContract
  • promoteContractId{N}
  • promoteContract
  • promoteContract
  • promoteContractName{N}
  • promoteContractOwner{N}
  • promoteContractPrice{N}
  • promoteContractQuantity{N}
  • promoteContractsNum
  • promoteProductId{N}
  • promoteProductName{N}
  • promoteSubscriptionId{N}
  • quantity
  • referenceNumber
  • referrer
  • regulatedCard
  • remoteAddress
  • sepaIban
  • sepaMandateDate
  • sepaMandateId
  • shippingAddress1
  • shippingAddress2
  • shippingCity
  • shippingCountry
  • shippingFirstName
  • shippingLastName
  • shippingMethod
  • shippingState
  • shippingZipCode
  • shopperOrderUrl
  • state
  • subscriptionId
  • targetBalance
  • taxAmountUSD
  • taxChargeAmount
  • taxRate
  • templateId
  • testMode
  • title
  • transactionDate
  • transactionType
  • untilDate
  • vatId
  • vendor[N].id
  • vendor[N].name
  • vendorId
  • vendorName
  • workPhone
  • zipCode




FAILED_PAYOUT_TRANSFER

Sent when a payout transfer fails. If you receive this notification, note the following:

  • There was a payout issue and you will not receive your funds on time.
  • You need to contact BlueSnap Merchant Support to have them correct your payout information.
  • amount
  • currency
  • destination
  • merchantId
  • payeeName
  • payeePhoneNumber
  • payeeEmail
  • paymentId
  • vendorId




MERCHANT_PARTNER_ONBOARDED

Sent when a platform partner onboards a new merchant.

  • accountCanProcess
  • merchantEmail
  • merchantId
  • merchantName
  • payoutStatus




RECURRING

Sent when a charge has been made for a subscription contract. This applies only to the second and subsequent charges. The first payment of a subscription contract is treated as a standard charge and a CHARGE IPN is sent.

  • accountId
  • addCD
  • address1
  • address2
  • armadilloHardwareId
  • authkey
  • binCategory
  • binNumber
  • bluesnapNode (also appears as plimusNode)
  • chargeDescription
  • city
  • company
  • contractChargePrice
  • contractId
  • contractName
  • contractOwner
  • contractPrice
  • country
  • coupon
  • couponChargeValue
  • couponCode
  • couponValue
  • creditCardExpDate
  • creditCardLastFourDigits
  • creditCardType
  • cardSubType
  • cardCategory
  • cardIssuingCountry
  • cardIssuingOrg
  • currency
  • custom{N}
  • dpanExpDate
  • dpanLastFourDigits
  • email
  • extension
  • faxNumber
  • firstName
  • invoiceAddress1
  • invoiceAddress2
  • invoiceAmountUSD
  • invoiceChargeAmount
  • invoiceChargeCurrency
  • invoiceCity
  • invoiceCompany
  • invoiceCountry
  • invoiceEmail
  • invoiceExtension
  • invoiceFaxNumber
  • invoiceFirstName
  • invoiceLastName
  • invoiceLocalCurrency
  • invoiceState
  • invoiceTitle
  • invoiceUrl
  • invoiceWorkPhone
  • invoiceZipCode
  • language
  • lastName
  • licenseKey
  • merchantTransactionId
  • offlineOrderId
  • oldContractId
  • originalRefNum
  • paymentMethod
  • paypalSubscriptionId
  • paypalTransactionId
  • personalId
  • productId
  • productName
  • promoteContractsNum
  • quantity
  • referenceNumber
  • referrer
  • regulatedCard
  • remoteAddress
  • sepaIban
  • sepaMandateDate
  • sepaMandateId
  • shopperOrderUrl
  • state
  • subscriptionId
  • taxAmountUSD
  • taxChargeAmount
  • taxRate
  • templateId
  • testMode
  • title
  • transactionDate
  • transactionType
  • untilDate
  • vatId
  • vendor[N].id
  • vendor[N].name
  • vendorId
  • vendorName
  • workPhone
  • zipCode




REFUND

Sent when a refund is issued.

  • accountId
  • addCD
  • additionalChargeAmount[N]
  • additionalChargeCategory[N]
  • additionalChargeName[N]
  • address1
  • address2
  • armadilloHardwareId
  • authkey
  • binNumber
  • bluesnapNode (also appears as plimusNode)
  • cardIssuingCountry
  • cardIssuingOrg
  • city
  • company
  • contractChargePrice
  • contractId
  • contractName
  • contractOwner
  • contractPrice
  • country
  • coupon
  • couponChargeValue
  • couponCode
  • couponValue
  • creditCardExpDate
  • creditCardLastFourDigits
  • creditCardType
  • currency
  • custom{N}
  • dpanExpDate
  • dpanLastFourDigits
  • EDWAmount
  • EDWAmountUSD
  • EDWContractId
  • EDWPeriod
  • EDWSurcharge
  • EDWSurchargeUSD
  • email
  • extension
  • faxNumber
  • firstName
  • invoiceAddress1
  • invoiceAddress2
  • invoiceAmountUSD
  • invoiceChargeAmount
  • invoiceChargeCurrency
  • invoiceCity
  • invoiceCompany
  • invoiceCountry
  • invoiceEmail
  • invoiceExtension
  • invoiceFaxNumber
  • invoiceFirstName
  • invoiceLastName
  • invoiceLocalCurrency
  • invoiceState
  • invoiceTitle
  • invoiceUrl
  • invoiceZipCode
  • language
  • lastName
  • licenseKey
  • merchantTransactionId
  • offlineOrderId
  • originalRequestUrl
  • paymentMethod
  • paypalSubscriptionId
  • paypalTransactionId
  • personalId
  • productId
  • productName
  • promoteContract
  • promoteContractId{N}
  • promoteContract
  • promoteContractName{N}
  • promoteContractOwner{N}
  • promoteContractPrice{N}
  • promoteContractQuantity{N}
  • promoteContractsNum
  • promoteProductId{N}
  • promoteProductName{N}
  • promoteSubscriptionId{N}
  • purchaseDate
  • quantity
  • referenceNumber
  • referrer
  • remoteAddress
  • reversalAmount
  • reversalReason
  • reversalRefNum
  • sepaIban
  • sepaMandateDate
  • sepaMandateId
  • shippingAddress1
  • shippingAddress2
  • shippingCity
  • shippingCountry
  • shippingFirstName
  • shippingLastName
  • shippingMethod
  • shippingState
  • shippingZipCode
  • shopperOrderUrl
  • state
  • subscriptionId
  • targetBalance
  • taxAmountUSD
  • taxChargeAmount
  • taxRate
  • templateId
  • testMode
  • title
  • transactionDate
  • transactionType
  • untilDate
  • vatId
  • vendor[N].id
  • vendor[N].name
  • vendorId
  • vendorName
  • workPhone
  • zipCode




SUBSCRIPTION_REMINDER

Sent each time a subscription reminder email should be sent to a shopper for renewal of their subscription. Using the information sent in the notification, you can generate your own email to send to your customer reminding them of their upcoming payment period for the subscription renewal.

  • accountId
  • address1
  • address2
  • bluesnapNode (also appears as plimusNode)
  • city
  • company
  • contractChargePrice
  • contractId
  • contractName
  • contractOwner
  • country
  • coupon
  • couponChargeValue
  • couponCode
  • couponValue
  • custom{N}
  • daysTillCancelDate
  • daysTillPaymentDue
  • email
  • extension
  • faxNumber
  • firstName
  • language
  • lastName
  • licenseKey
  • merchantTransactionId
  • originalRefNum
  • paymentMethod
  • paymentURL
  • personalId
  • productId
  • productName
  • quantity
  • referrer
  • reminderNumber
  • sendStatus
  • state
  • subscriptionId
  • title
  • transactionDate
  • transactionType
  • untilDate
  • vendor[N].id
  • vendor[N].name
  • vendorId
  • vendorName
  • zipCode

Top


On-Demand IPNs

On-Demand IPNs are available in addition to the standard Default IPNs. To enable these IPN types, see Enabling IPNs in BlueSnap.

IPN Name
Description
Parameters

ACCOUNT_UPDATER

Sent when a card number or expiration date has been updated.

  • accountId
  • accountUpdaterLineId
  • authkey
  • bluesnapNode (also appears as plimusNode)
  • creditCardType
  • linkedSubscriptions
  • originalCreditCardExpirationMonth
  • originalCreditCardExpirationYear
  • originalCreditCardLast4Digits
  • responseDate
  • responseMessage
  • sellerShopperId
  • transactionType
  • updatedCreditCardExpirationMonth
  • updatedCreditCardExpirationYear
  • updatedCreditCardLast4Digits
  • updatedCreditCardType




CC_CHARGE_FAILED

Sent when a credit card payment for an initial charge fails (for both one-time and subscription purchases).

Note: This does not apply to recurring charge failures.

  • accountId
  • addCD
  • additionalChargeCategory[N]
  • additionalChargeName[N]
  • address1
  • address2
  • binNumber
  • bluesnapNode (also appears as plimusNode)
  • cardIssuingCountry
  • cardIssuingOrg
  • city
  • company
  • contractChargePrice
  • contractId
  • contractLocalPrice
  • contractName
  • contractOwner
  • contractPrice
  • country
  • coupon
  • couponChargeValue
  • couponCode
  • couponValue
  • creditCardExpDate
  • creditCardLastFourDigits
  • creditCardSubType
  • creditCardType
  • currency
  • custom{N}
  • dpanExpDate
  • dpanLastFourDigits
  • EDWAmount
  • EDWAmountUSD
  • EDWContractId
  • EDWPeriod
  • EDWSurcharge
  • EDWSurchargeUSD
  • email
  • errorProcessingCode
  • extension
  • failureReason
  • faxNumber
  • firstName
  • language
  • lastName
  • paymentMethod
  • personalId
  • proccessorCode
  • productId
  • productName
  • promoteContract
  • promoteContractId{N}
  • promoteContract
  • promoteContractName{N}
  • promoteContractOwner{N}
  • promoteContractPrice{N}
  • promoteContractQuantity{N}
  • promoteContractsNum
  • promoteProductId{N}
  • promoteProductName{N}
  • promoteSubscriptionId{N}
  • quantity
  • referrer
  • remoteAddress
  • shippingAddress1
  • shippingAddress2
  • shippingCity
  • shippingCountry
  • shippingFirstName
  • shippingLastName
  • shippingMethod
  • shippingState
  • shippingZipCode
  • state
  • taxAmountUSD
  • taxChargeAmount
  • taxRate
  • templateId
  • testMode
  • title
  • transactionDate
  • transactionType
  • vatId
  • workPhone
  • zipCode




CHARGE_PENDING

Sent when an ACH or SEPA payment is initially received. Once the ACH/SEPA payment has been processed a CHARGE IPN will be sent.

  • 3dStatus
  • accountId
  • addCD
  • additionalChargeAmount[N]
  • additionalChargeCategory[N]
  • additionalChargeName[N]
  • address1
  • address2
  • armadilloHardwareId
  • authkey
  • binNumber
  • bluesnapManualFee
  • bluesnapNode (also appears as plimusNode)
  • captureReferenceNumber
  • city
  • company
  • contractChargePrice
  • contractId
  • contractLocalPrice
  • contractName
  • contractOwner
  • contractPrice
  • country
  • coupon
  • couponChargeValue
  • couponCode
  • couponValue
  • creditCardExpDate
  • creditCardLastFourDigits
  • creditCardSubType
  • cardCategory
  • cardIssuingCountry
  • cardIssuingOrg
  • creditCardType
  • currency
  • custom{N}
  • dpanExpDate
  • dpanLastFourDigits
  • ecpPublicAccount
  • ecpPublicRouting
  • EDWAmount
  • EDWAmountUSD
  • EDWContractId
  • EDWPeriod
  • EDWSurcharge
  • EDWSurchargeUSD
  • email
  • extension
  • faxNumber
  • firstName
  • invoiceAddress1
  • invoiceAddress2
  • invoiceAmountUSD
  • invoiceChargeAmount
  • invoiceChargeCurrency
  • invoiceCity
  • invoiceCompany
  • invoiceCountry
  • invoiceEmail
  • invoiceExtension
  • invoiceFaxNumber
  • invoiceFirstName
  • invoiceLastName
  • invoiceLocalAmount
  • invoiceLocalCurrency
  • invoiceState
  • invoiceTitle
  • invoiceUrl
  • invoiceWorkPhone
  • invoiceZipCode
  • lastName
  • licenseKey
  • merchantTransactionId
  • offlineOrderId
  • originalRequestUrl
  • paymentMethod
  • paypalSubscriptionId
  • paypalTransactionId
  • personalId
  • productId
  • productName
  • promoteContract
  • promoteContractId{N}
  • promoteContract
  • promoteContract
  • promoteContractName{N}
  • promoteContractOwner{N}
  • promoteContractPrice{N}
  • promoteContractQuantity{N}
  • promoteContractsNum
  • promoteProductId{N}
  • promoteProductName{N}
  • promoteSubscriptionId{N}
  • quantity
  • recurringDisclaimer
  • referenceNumber
  • referrer
  • remoteAddress
  • sepaIban
  • sepaMandateDate
  • sepaMandateId
  • shippingAddress1
  • shippingAddress2
  • shippingCity
  • shippingCountry
  • shippingFirstName
  • shippingLastName
  • shippingMethod
  • shippingState
  • shippingZipCode
  • shopperOrderUrl
  • state
  • subscriptionId
  • targetBalance
  • taxAmountUSD
  • taxChargeAmount
  • taxRate
  • templateId
  • testMode
  • title
  • transactionDate
  • transactionType
  • untilDate
  • vatId
  • vendor[N].id
  • vendor[N].name
  • vendorId
  • vendorName
  • workPhone
  • zipCode




FRAUD_DECLINE

Sent when a transaction is declined due to fraud.

  • 3dStatus
  • amount
  • creditCardLastFourDigits
  • currency
  • email
  • firstName
  • fraudDeclineDate
  • lastName
  • paymentType




OFFLINE_ORDER

Sent when an offline order (e.g. via fax or telephone) is processed.

  • accountId
  • addCD
  • address1
  • address2
  • authkey
  • bluesnapNode (also appears as plimusNode)
  • city
  • company
  • contractId
  • contractName
  • contractOwner
  • contractPrice
  • country
  • couponCode
  • creditCardExpDate
  • creditCardLastFourDigits
  • creditCardType
  • email
  • extension
  • faxNumber
  • firstName
  • invoiceAmountUSD
  • invoiceChargeAmount
  • invoiceChargeCurrency
  • lastName
  • licenseKey
  • merchantTransactionId
  • offlineOrderId
  • paymentMethod
  • personalId
  • productId
  • productName
  • promoteContractsNum
  • quantity
  • referenceNumber
  • referrer
  • remoteAddress
  • shippingAddress1
  • shippingAddress2
  • shippingCity
  • shippingCountry
  • shippingFirstName
  • shippingLastName
  • shippingMethod
  • shippingState
  • shippingZipCode
  • state
  • title
  • transactionDate
  • transactionType
  • workPhone
  • zipCode




PAYMENT_UPDATED

Sent when there is a successful update to a payment method.

  • accountId
  • address1
  • address2
  • binCategory
  • bluesnapNode (also appears as plimusNode)
  • city
  • company
  • contractId
  • contractName
  • contractOwner
  • country
  • creditCardAddress1
  • creditCardAddress2
  • creditCardCity
  • creditCardExpDate
  • creditCardFirstName
  • creditCardLastFourDigits
  • creditCardLastName
  • creditCardType
  • cardSubType
  • cardCategory
  • creditCardZipCode
  • dpanExpDate
  • dpanLastFourDigits
  • email
  • extension
  • faxNumber
  • firstName
  • language
  • lastName
  • nextChargeDate
  • originalRefNum
  • paymentMethod
  • personalId
  • productId
  • productName
  • quantity
  • regulatedCard
  • shopperOrderUrl
  • subscriptionId
  • title
  • transactionDate
  • transactionType
  • vendor[N].id
  • vendor[N].name
  • vendorId
  • vendorName
  • workPhone
  • zipCode




PAYMENT_UPDATED_FAILURE

Sent when an update to a payment method has failed.

  • accountId
  • address1
  • address2
  • bluesnapNode (also appears as plimusNode)
  • city
  • company
  • contractId
  • contractName
  • contractOwner
  • country
  • creditCardAddress1
  • creditCardAddress2
  • creditCardCity
  • creditCardExpDate
  • creditCardFirstName
  • creditCardLastFourDigits
  • creditCardLastName
  • creditCardType
  • creditCardZipCode
  • dpanExpDate
  • dpanLastFourDigits
  • email
  • extension
  • faxNumber
  • firstName
  • language
  • lastName
  • nextChargeDate
  • originalRefNum
  • paymentMethod
  • personalId
  • productId
  • productName
  • quantity
  • shopperOrderUrl
  • state
  • subscriptionId
  • title
  • transactionDate
  • transactionType
  • vendor[N].id
  • vendor[N].name
  • vendorId
  • vendorName
  • workPhone
  • zipCode




PAYOUT

Sent to the merchant for each time BlueSnap issues a payout (deposit).

Note: If there are insufficient funds to generate a payout, no payout notification is sent.

  • amount[N]
  • currency[N]
  • destination
  • merchantId
  • paymentCycleEndDate
  • paymentCycleStartDate
  • paymentId




SUBSCRIPTION_CHARGE_FAILURE

Sent when a recurring payment fails for a shopper's subscription.

  • accountId
  • address1
  • address2
  • binCategory
  • binNumber
  • bluesnapNode (also appears as plimusNode)
  • cardCategory
  • cardIssuingCountry
  • cardIssuingOrg
  • cardSubType
  • city
  • company
  • contractChargePrice
  • contractId
  • contractName
  • contractOwner
  • contractPrice
  • country
  • creditCardExpDate
  • creditCardLastFourDigits
  • creditCardType
  • currency
  • custom{N}
  • daysTillCancelDate
  • dpanExpDate
  • dpanLastFourDigits
  • email
  • errorProcessingCode
  • extension
  • failureReason
  • faxNumber
  • firstName
  • language
  • lastAttempt
  • lastName
  • licenseKey
  • merchantTransactionId
  • numberOfAttemptsDone
  • originalRefNum
  • paymentMethod
  • paypalSubscriptionId
  • paypalTransactionId
  • personalId
  • proccessorCode
  • productId
  • productName
  • quantity
  • referrer
  • regulatedCard
  • shopperOrderUrl
  • state
  • subscriptionId
  • targetBalance
  • testMode
  • title
  • transactionDate
  • transactionType
  • untilDate
  • vatId
  • vendor[N].id
  • vendor[N].name
  • workPhone
  • zipCode




UNDER_REVIEW

Sent when a shopper's purchase has not been finalized and is currently awaiting manual review by BlueSnap.

  • accountId
  • addCD
  • additionalChargeAmount[N]
  • additionalChargeCategory[N]
  • additionalChargeName[N]
  • address1
  • address2
  • armadilloHardwareId
  • authkey
  • binCategory
  • bluesnapNode (also appears as plimusNode)
  • city
  • company
  • contractChargePrice
  • contractId
  • contractLocalPrice
  • contractName
  • contractOwner
  • contractPrice
  • country
  • coupon
  • couponChargeValue
  • couponCode
  • couponValue
  • creditCardExpDate
  • creditCardLastFourDigits
  • creditCardType
  • cardCategory
  • custom{N}
  • dpanExpDate
  • dpanLastFourDigits
  • EDWAmount
  • EDWAmountUSD
  • EDWContractId
  • EDWPeriod
  • EDWSurcharge
  • EDWSurchargeUSD
  • email
  • extension
  • faxNumber
  • firstName
  • invoiceAddress1
  • invoiceAddress2
  • invoiceAmountUSD
  • invoiceChargeAmount
  • invoiceChargeCurrency
  • invoiceCity
  • invoiceCompany
  • invoiceCountry
  • invoiceEmail
  • invoiceExtension
  • invoiceFaxNumber
  • invoiceFirstName
  • invoiceLastName
  • invoiceLocalAmount
  • invoiceLocalCurrency
  • invoiceState
  • invoiceTitle
  • invoiceUrl
  • invoiceWorkPhone
  • invoiceZipCode
  • language
  • lastName
  • licenseKey
  • merchantTransactionId
  • offlineOrderId
  • originalRequestUrl
  • paymentMethod
  • paypalSubscriptionId
  • paypalTransactionId
  • personalId
  • productId
  • productName
  • promoteContract
  • promoteContractId{N}
  • promoteContract
  • promoteContract
  • promoteContractName{N}
  • promoteContractOwner{N}
  • promoteContractPrice{N}
  • promoteContractQuantity{N}
  • promoteContractsNum
  • promoteProductId{N}
  • promoteProductName{N}
  • promoteSubscriptionId{N}
  • quantity
  • recurringDisclaimer
  • referenceNumber
  • referrer
  • regulatedCard
  • remoteAddress
  • shippingAddress1
  • shippingAddress2
  • shippingCity
  • shippingCountry
  • shippingFirstName
  • shippingLastName
  • shippingMethod
  • shippingState
  • shippingZipCode
  • shopperOrderUrl
  • state
  • subscriptionId
  • targetBalance
  • taxAmountUSD
  • taxChargeAmount
  • taxRate
  • templateId
  • testMode
  • title
  • transactionDate
  • transactionType
  • untilDate
  • vatId
  • vendor[N].id
  • vendor[N].name
  • vendorId
  • vendorName
  • workPhone
  • zipCode




UNDER_VENDOR_REVIEW

Sent for each order if the merchant selected the "Review all orders" option in the general account settings.

  • accountId
  • addCD
  • additionalChargeAmount[N]
  • additionalChargeCategory[N]
  • additionalChargeName[N]
  • address1
  • address2
  • armadilloHardwareId
  • authkey
  • binCategory
  • city
  • company
  • contractChargePrice
  • contractId
  • contractLocalPrice
  • contractName
  • contractOwner
  • contractPrice
  • country
  • coupon
  • couponChargeValue
  • couponCode
  • couponValue
  • creditCardExpDate
  • creditCardLastFourDigits
  • creditCardType
  • cardCategory
  • custom{N}
  • dpanExpDate
  • dpanLastFourDigits
  • EDWAmount
  • EDWAmountUSD
  • EDWContractId
  • EDWPeriod
  • EDWSurcharge
  • EDWSurchargeUSD
  • email
  • extension
  • faxNumber
  • firstName
  • invoiceAddress1
  • invoiceAddress2
  • invoiceAmount
  • invoiceAmountUSD
  • invoiceChargeAmount
  • invoiceChargeCurrency
  • invoiceCity
  • invoiceCompany
  • invoiceCountry
  • invoiceEmail
  • invoiceExtension
  • invoiceFaxNumber
  • invoiceFirstName
  • invoiceMobilePhone
  • invoiceLastName
  • invoiceLocalAmount
  • invoiceLocalCurrency
  • invoiceState
  • invoiceTitle
  • invoiceUrl
  • invoiceWorkPhone

  • invoiceZipCode

  • language
  • lastName
  • licenseKey
  • merchantTransactionId
  • offlineOrderId
  • originalRequestUrl
  • paymentMethod
  • paypalSubscriptionId
  • paypalTransactionId
  • personalId
  • productId
  • productName
  • promoteContract
  • promoteContractId{N}
  • promoteContract
  • promoteContract
  • promoteContractName{N}
  • promoteContractOwner{N}
  • promoteContractPrice{N}
  • promoteContractQuantity{N}
  • promoteContractsNum
  • promoteProductId{N}
  • promoteProductName{N}
  • promoteSubscriptionId{N}
  • quantity
  • recurringDisclaimer
  • referenceNumber
  • referrer
  • regulatedCard
  • remoteAddress
  • shippingAddress1
  • shippingAddress2
  • shippingCity
  • shippingCountry
  • shippingFirstName
  • shippingLastName
  • shippingMethod
  • shippingState
  • shippingZipCode
  • shopperOrderUrl
  • state
  • subscriptionId
  • targetBalance
  • taxAmountUSD
  • taxChargeAmount
  • taxRate
  • templateId
  • testMode
  • title
  • transactionDate
  • transactionType
  • untilDate
  • vatId
  • vendor[N].id
  • vendor[N].name
  • vendorId
  • vendorName
  • workPhone
  • zipCode




VENDOR_STATUS_CHANGED

Sent to the Marketplace Merchant on the following events:

  • Change to vendor's account, payout, and/or processing statuses.
  • A vendor is created/updated , but there is still missing required vendor information.
  • vendorAccountOpenedDate
  • vendorAccountStatus
  • vendorAccountStatusChangedDate
  • vendorId
  • vendorMissingFields
  • vendorName
  • vendorPayoutDeclineReason
  • vendorPayoutStatus
  • vendorProcessingStatus

All IPNs Name Reference


Suggested Edits are limited on API Reference Pages

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