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.

To enable any of the IPNs below, refer to Enabling IPNs in BlueSnap.

IPN Descriptions and Parameters

IPN Name (Value of the transactionType parameter passed in the IPN)	Description	Parameters (Parameter Reference Guide)
ACCOUNT_UPDATER	Sent when a card number or expiration date has been updated.	accountId accountUpdaterLineId authkey bluesnapNode (or plimusNode) creditCardType linkedSubscriptions originalCreditCardExpirationMonth originalCreditCardExpirationYear originalCreditCardLast4Digits responseDate responseMessage sellerShopperId transactionType updatedCreditCardExpirationMonth updatedCreditCardExpirationYear updatedCreditCardLast4Digits updatedCreditCardType
AUTH_ONLY	Sent when a trial subscription for a zero amount is initiated. 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.	additionalChargeName[N] address1 address2 armadilloHardwareId authkey bluesnapNode (or 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
AUTH_ONLY_SINGLE_CHARGE	Sent when an Auth_Only API call is successful.	accountId address1 address2 bluesnapNode (or plimusNode) binCategory city company country creditCardExpDate creditCardLastFourDigits creditCardType dpanExpDate dpanLastFourDigits email firstName invoiceAddress1 invoiceAddress2 invoiceAmountUSD invoiceChargeAmount invoiceChargeCurrency invoiceCity invoiceCompany invoiceCountry invoiceEmail invoiceFirstName invoiceLastName invoiceLocalAmount invoiceLocalCurrency invoiceState invoiceUrl invoiceWorkPhone invoiceZipCode language lastName merchantTransactionId offlineOrderId originalRequestUrl paymentMethod paypalTransactionId personalId referenceNumber referrer regulatedCard remoteAddress shippingAddress1 shippingAddress2 shippingCity shippingCountry shippingFirstName shippingLastName shippingMethod shippingState shippingZipCode shopperOrderUrl state subscriptionId targetBalance templateId 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 (or 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 address1 address2 armadilloHardwareId authkey bankAccountNumber binCategory bluesnapNode (or plimusNode) bsbNumber 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 routingNumber 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.	additionalChargeAmount[N] additionalChargeCategory[N] additionalChargeName[N] address1 address2 armadilloHardwareId authkey bankAccountNumber binCategory bluesnapNode (or plimusNode) bsbNumber 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 routingNumber 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
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 additionalChargeCategory[N] additionalChargeName[N] address1 address2 binNumber bluesnapNode (or 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
CC_STATUS_CHANGED	Sent when the status of a shopper's stored card has changed.	accountId creditCardExpDate creditCardLastFourDigits creditCardType firstName lastName requestingParty status statusChangeDate
CHARGE	Sent when a new purchase has been completed. This applies to both one-time charges and recurring charges.	3dStatus accountId additionalChargeAmount[N] additionalChargeCategory[N] additionalChargeName[N] address1 address2 armadilloHardwareId authkey avsResponse avsSent binCategory binNumber bluesnapManualFee bluesnapNode (or plimusNode) brazilianId captureReferenceNumber cardSubType city company contractChargePrice contractId contractLocalPrice contractName contractOwner contractPrice country coupon couponChargeValue couponCode couponValue creditCardExpDate creditCardLastFourDigits creditCardSubType cardCategory cardIssuingCountry cardIssuingOrg creditCardType currency custom{N} cvvResponse cvvSent dpanExpDate dpanLastFourDigits EDWAmount EDWAmountUSD EDWContractId EDWPeriod EDWSurcharge EDWSurchargeUSD email extension faxNumber firstName homePhone invoiceAddress1 invoiceAddress2 invoiceAmount invoiceAmountUSD invoiceChargeAmount invoiceChargeCurrency invoiceCity invoiceCompany invoiceCountry invoiceEmail invoiceExtension invoiceFaxNumber invoiceFirstName invoiceInfoUrl invoiceLastName invoiceLocalAmount invoiceLocalCurrency invoiceMobilePhone invoiceState invoiceTitle invoiceUrl invoiceWorkPhone invoiceZipCode issuerAuthCode language lastName licenseKey merchantTransactionId metaDataKey mobilePhone offlineOrderId originalRequestUrl overridePrice paymentMethod paymentType 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 shopperAdminUrl shopperOrderUrl state subscriptionId targetBalance taxAmountUSD taxChargeAmount taxRate templateId testMode title transactionDate transactionType untilDate username vatId vendor[N].id vendor[N].name vendorCommissionPercent (if absolute amount isn’t available) vendorCurrency vendorLocalAmount (if percentage is available) vendorUsdAmount (if percentage is available) 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 additionalChargeAmount[N] additionalChargeCategory[N] additionalChargeName[N] address1 address2 armadilloHardwareId authkey binNumber bluesnapNode (or 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 subscriptionId targetBalance taxAmountUSD taxChargeAmount taxRate templateId testMode title transactionDate transactionType untilDate vatId vendor[N].id vendor[N].name vendorId vendorName workPhone zipCode
CHARGEBACK_FILE_UPLOADED	Sent when Chargeback Representment Upload API is successful.	ARN caseNumber chargebackId cycle dateSuccessfullySubmitted merchantId merchantName status
CHARGEBACK_STATUS_CHANGED	Sent when an event is received from Chargebacks911 that does not open a new chargeback.	accountId additionalChargeAmount[N] additionalChargeCategory[N] additionalChargeName[N] address1 address2 armadilloHardwareId authkey bluesnapNode (or 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 subscriptionId targetBalance taxAmountUSD taxChargeAmount taxRate templateId testMode title transactionDate transactionType untilDate vatId vendorId vendorName workPhone zipCode
CHARGE_PENDING	Sent when an ACH or SEPA Direct Debit payment is initially received. Once the payment has been processed a CHARGE IPN will be sent.	3dStatus accountId additionalChargeAmount[N] additionalChargeCategory[N] additionalChargeName[N] address1 address2 armadilloHardwareId authkey bankAccountAccountName bankAccountAccountNumber bankAccountBranch bankAccountBSBNmber bankAccountFinancialInstutition binNumber bluesnapManualFee bluesnapNode (or 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
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 additionalChargeAmount[N] additionalChargeCategory[N] additionalChargeName[N] address1 address2 authkey binCategory binNumber bluesnapNode (or 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 rejected due to payment processing or review process.	accountId additionalChargeAmount[N] additionalChargeCategory[N] additionalChargeName[N] address1 address2 armadilloHardwareId authkey bankAccountNumber binCategory bluesnapNode (or plimusNode) bsbNumber 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 routingNumber 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
FRAUD_DECLINE	Sent when a transaction is declined due to fraud.	3dStatus amount creditCardLastFourDigits currency email firstName fraudDeclineDate lastName paymentType
MERCHANT_PARTNER_ONBOARDED	Sent when a merchant has been successfully onboarded.	accountCanProcess merchantEmail merchantId merchantName payoutStatus sandboxId
MERCHANT_PARTNER_STATUS	Sent when the processing or payout status of a merchant changes.	accountCanProcess merchantEmail merchantId merchantName payoutStatus
OFFLINE_ORDER	Sent when an offline order (via Local Bank Transfer or Wire) is placed.	address1 address2 authkey bluesnapNode (or plimusNode) city company contractId contractName contractOwner contractPrice country couponCode email extension faxNumber firstName lastName merchantTransactionId offlineOrderId orderAmountUSD orderChargeAmount orderChargeCurrency orderId paymentMethod personalId productId productName quantity referenceNumber referrer remoteAddress shippingAddress1 shippingAddress2 shippingCity shippingCountry shippingFirstName shippingLastName shippingState shippingZipCode state title transactionDate transactionType workPhone zipCode
PAYMENT_METHOD_UPDATED	Sent when there is a successful update to a payment method.	accountId address1 address2 binCategory bluesnapNode (or 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 paymentType personalId productId productName quantity regulatedCard shopperOrderUrl subscriptionId title transactionDate transactionType vendor[N].id vendor[N].name vendorId vendorName workPhone zipCode
PAYMENT_METHOD_UPDATE_FAILURE	Sent when an update to a payment method has failed.	accountId address1 address2 bluesnapNode (or 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 each time BlueSnap issues a payout (deposit). If you have multiple payout currencies, they will all be included in a single payout IPN. Note: If there are insufficient funds to generate a payout, no payout notification is sent.	amount[N] currency[N] destination merchantId paymentCycleEndDate paymentCycleStartDate paymentId vendorId vendorName
PENDING_REFUND	Sent when a payment refund is initiated and when a pending refund is deleted after 3 months of unsuccessful processing attempts.	accountId additionalChargeAmount[N] additionalChargeCategory[N] additionalChargeName[N] address1 address2 authkey bankAccountNumber binCategory binNumber bluesnapNode (or plimusNode) bsbNumber 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 firstName invoiceAddress1 invoiceAddress2 invoiceAmount invoiceAmountUSD invoiceChargeAmount invoiceChargeCurrency invoiceCity invoiceCompany invoiceCountry invoiceEmail invoiceExtension invoiceFaxNumber invoiceFirstName invoiceInfoUrl invoiceLastName invoiceLocalCurrency invoiceState invoiceTitle invoiceUrl invoiceZipCode language lastName merchantTransactionId metaDataKey offlineOrderId originalRequestUrl paymentMethod paypalSubscriptionId paypalTransactionId personalId plimusNode 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 refundReserveAccountBalance remoteAddress reversalAmount reversalReason reversalRefNum routingNumber sepaIban sepaMandateDate sepaMandateId shippingAddress1 shippingAddress2 shippingCity shippingCountry shippingFirstName shippingLastName shippingMethod shippingState shippingZipCode shopperOrderUrl state status subscriptionId targetBalance taxAmountUSD taxChargeAmount taxRate templateId testMode title transactionDate transactionType untilDate vatId vendor[N].amount vendor[N].id workPhone zipCode
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 address1 address2 armadilloHardwareId authkey bankAccountNumber binCategory binNumber bluesnapNode (or plimusNode) bsbNumber 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 metaDataKey offlineOrderId oldContractId originalRefNum paymentMethod paypalSubscriptionId paypalTransactionId personalId productId productName promoteContractsNum quantity referenceNumber referrer regulatedCard remoteAddress routingNumber 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 additionalChargeAmount[N] additionalChargeCategory[N] additionalChargeName[N] address1 address2 armadilloHardwareId authkey bankAccountNumber binNumber bluesnapNode (or plimusNode) bsbNumber 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 metaDataKey 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 routingNumber 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 bankAccountNumber bluesnapNode (or plimusNode) bsbNumber 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 routingNumber sendStatus state subscriptionId title transactionDate transactionType untilDate vendor[N].id vendor[N].name vendorId vendorName zipCode
SUBSCRIPTION_CHARGE_FAILURE	Sent when a recurring payment fails for a shopper's subscription.	accountId address1 address2 bankAccountNumber binCategory binNumber bluesnapNode (or plimusNode) bsbNumber 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 metaDataKey numberOfAttemptsDone originalRefNum paymentMethod paypalSubscriptionId paypalTransactionId personalId proccessorCode productId productName quantity referrer regulatedCard routingNumber shopperOrderUrl state subscriptionId targetBalance testMode title transactionDate transactionType untilDate vatId vendor[N].id vendor[N].name workPhone zipCode
UNDER_VENDOR_REVIEW	Sent for each order if the merchant selected the "Review all orders" option in the general account settings.	accountId 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
VAULTED_SHOPPER	Sent to the merchant each time a vaulted shopper is created or updated.	vaultedShopperId merchantShopperId firstName lastName country state address address2 email zipCode phone companyName shopperCurrency personalIdentificationNumber threeDSecure chosenPaymentMethod paymentType dateCreated
VENDOR_REPORT_AVAILABLE	Sent to the Marketplace Merchant when Payout Detail report is available for vendor.	amount[N] currency[N] destination merchantId paymentCycleEndDate paymentCycleStartDate paymentId payoutCycle payoutPlannedDate vendorId vendorName
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

Top