Parameters

# & A • B • C • D • E • F • H • I • L • M • N • O • P • Q & R • S • T • U • V • W–Z

# & A

Name	Value	Description & IPNs
3dStatus	String Possible values: 3DS Not Enabled AUTHENTICATION_SUCCEEDED AUTHENTICATION_FAILED AUTHENTICATION_BYPASSED AUTHENTICATION_UNAVAILABLE AUTHENTICATION_INCOMPLETE	3D Secure status IPNs: Charge Fraud Decline
accountCanProcess	Yes, No, or Pending	Specifies if the merchant account can process transactions. IPNs: Merchant Partner Onboarded Merchant Partner Status
accountId	Number	BlueSnap account ID assigned to the shopper. IPNs: Account Updater ACH Notification of Change Auth Only Single Charge Cancellation Cancel on Renewal CC Charge Failed CC Status Changed Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Payment Updated Payment Update Failure Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Reminder Under Vendor Review
accountType	String	Indicates the account type. IPNs: ACH Notification of Change
accountUpdaterLineId	Number	Unique identifier of the update. IPN: Account Updater
ARN	Number	Acquirer Reference Number IPN: Chargeback File Uploaded
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 Pending Refund RDR Refund 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 Pending Refund RDR Refund 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 Pending Refund RDR Refund Under Vendor Review
address1 address2	String	Shopper's address line 1 and 2. IPNs: Auth Only Auth Only Single Charge 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 Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Reminder Under Vendor Review Vaulted Shopper
amount	Number	The amount of the transaction. Example: 1234.56. IPNs: Failed Payout Transfer and Fraud Decline
amount[N]	Number	Indicates the amount per currency for each payout. The index associates the amount to the corresponding payout currency. IPNs: Payout and Vendor Report Available
armadilloHardwareId	Number	Sent if the account has an armadillo ID. IPNs: Auth Only Cancellation Cancellation Refund Charge Charge Pending Chargeback Chargeback Status Changed Decline RDR Recurring Refund 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('accountId'+'originalCreditCardLast4Digits'+ '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 ACH Notification of Change Auth Only Cancellation Cancellation Refund Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Offline Order Pending Refund RDR Recurring Refund Under Vendor Review
avsResponse	String	Indicates the AVS response. IPN: Charge
avsSent	Y/N	Indicates whether AVS details were sent. IPN: Charge

B

Name	Value	Description & IPNs
bankAccountAccountName	String	IPNs: Charge Pending
bankAccountBranch	String	IPNs: Charge Pending
bankAccountBsbNumber	String	IPNs: Charge Pending
bankAccountFinancialInstitution	String	IPNs: Charge Pending
bankAccountNumber	String	IPNs: Cancellation Cancellation Refund Charge Charge Pending Decline Pending Refund Recurring Refund Subscription Charge Failure Subscription Reminder
binCategory	String Possible values: Commercial Consumer	Indicates whether the card is used for business expenses or personal expenses. IPNs: Auth Only Auth Only Single Charge Cancel on Renewal Cancellation Cancellation Refund Charge Contract Change Decline Payment Method Updated Pending Refund Recurring Subscription Charge Failure 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 Pending Refund RDR Recurring Refund Subscription Charge Failure
bluesnapManualFee	Number	Shows the amount, in USD, of any manual fee that was charged by BlueSnap. This amount is already included within invoiceAmountUSD. IPN: Charge
bluesnapNode (also appears as plimusNode)	Number Possible values: 1 = US Servers 2 = UK Servers 99 = Sandbox	BlueSnap datacenter that processed the transaction and is storing the information. IPNs: Account Updater ACH Notification of Change Auth Only Auth Only Single Charge 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 Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Reminder
brazilianId	String	Applicable if the shopper is located in Brazil. Value is the shopper's personal identification (CPF/CNPJ) number. IPN: Charge
bsbNumber	String	IPNs: Cancellation Cancellation Refund Charge Pending Decline Pending Refund Recurring Refund Subscription Charge Failure Subscription Reminder

C

Name	Value	Description & IPNs
cancelledContractId	String	The cancelled contract ID. IPN: Cancellation
cancelReason	String	The reason the subscription was cancelled. IPNs: Cancellation Cancellation Refund Chargeback Chargeback Status Changed RDR
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 Vendor Review
cardIssuingCountry cardIssuingOrg	String	The country where the payment card was issued. The bank that issued the shopper's payment card. IPNs: CC Charge Failed Charge Charge Pending Chargeback Contact Change Pending Refund RDR Recurring Refund Subscription Charge Failure
cardSubType	String	Card sub-type, such as credit or debit. IPN: Charge
caseNumber	String	Represents the case number assigned by the card brand/bank. IPN: Chargeback File Uploaded
cbStatus	String Possible values: Closed Completed_Lost Completed_Pending Completed_Won New Working	Chargeback status. IPNs: Chargeback and 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
chargebackId	String	The Chargeback 911 case number IPNs: Chargeback Chargeback File Uploaded Chargeback Status Changed
city company companyName	String	Shopper's city and company name. IPNs: Auth Only Auth Only Single Charge 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 Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Reminder Under Vendor Review Vaulted Shopper
contractChargePrice	Number Format: #,###.##	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 Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Reminder 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 Vendor Review
contractId contractName contractOwner	String	BlueSnap Contract ID. Contract name. 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 Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Reminder Under Vendor Review
contractPrice	Number Format: #,###.##	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 Pending Refund RDR Recurring Refund Subscription Charge Failure Under Vendor Review
country	String	Shopper country code. IPNs: Auth Only Auth Only Single Charge 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 Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Reminder Under Vendor Review Vaulted Shopper
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 Pending Refund RDR Recurring Refund Subscription Reminder Under Vendor Review
couponChargeValue	Number Format: #,###.##	Coupon value in USD. IPNs: Auth Only Cancellation Refund CC Charge Failed Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Pending Refund RDR Recurring Refund Subscription Reminder 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 Pending Refund RDR Recurring Refund Subscription Reminder Under Vendor Review
couponValue	Number Format: #,###.##	Coupon value in USD. IPNs: Auth Only Cancellation Cancellation Refund CC Charge Failed Charge Charge Pending Chargeback Chargeback Status Changed Decline Pending Refund RDR Recurring Refund Subscription Reminder Under Vendor Review
creditCardAddress1 creditCardAddress2 creditCardCity creditCardCountry creditCardZipCode	String	Credit card address information provided by the shopper. IPNs: Payment Updated and Payment Update Failure
creditCardExpDate creditCardLastFourDigits	Number	Expiration date and the last four digits of the credit card being used for payment of purchase. IPNs: Auth Only Auth Only Single Charge Cancellation Cancellation Refund Cancel on Renewal CC Charge Failed CC Status Changed Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Payment Updated Payment Update Failure Pending Refund RDR Recurring Refund Subscription Charge Failure Under Vendor Review
creditFirstName creditLastName	String	Shopper's first name and last name, as printed on the credit card. IPNs: Payment Updated and Payment Update Failure
creditCardType	String	Type of credit card (for example: AMEX, VISA, etc.). IPNs: Account Updater Auth Only Auth Only Single Charge Cancellation Cancellation Refund Cancel on Renewal CC Charge Failed CC Status Changed Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Payment Updated Payment Update Failure Pending Refund RDR Recurring Refund Subscription Charge Failure Under Vendor Review
currency	String	Three-digit currency code. IPNs: CC Charge Failed Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Failed Payout Transfer Fraud Decline Pending Refund RDR Recurring Refund Subscription Charge Failure
currency[N]	String	Three-digit currency code. The index ([N]) associates the currency to the corresponding payout amount. IPNs: Payout and Vendor Report Available
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 Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Reminder Under Vendor Review
cvvResponse	String	Indicates the CVV response. IPN: Charge
cvvSent	Y/N	Indicates whether CVV details were sent. IPN: Charge
cycle	String	5. A 1-digit integer with the following potential values: 1: First Chargeback 2: Second Chargeback 9: Retrieval Request (RFI) IPN: Chargeback File Uploaded

D

Name	Value	Description & IPNs
dateDue	yyyy-mm-dd	The last day that the merchant can dispute the chargeback. IPNs: Chargeback
dateSuccessfullySubmitted	mm/dd/yyyy hh:mi AM/PM	Date the file was successfully uploaded. IPNs: Chargeback File Uploaded
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. IPNs: Failed Payout Transfer, Payout, and Vendor Report Available
dpanLastFourDigits dpanExpDate	String	Last four digits of device account number. Expiration month and year of device account number. Example: 11%2F2025 ("%2F" in UTF-8 encoding is "/") Note: These parameters are relevant for Apple Pay transactions. IPNs: Auth Only Auth Only Single Charge 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 Pending Refund RDR Recurring Refund Subscription Charge Failure Under Vendor Review

E

Name	Value	Description & IPNs
ecpPublicAccount ecpPublicRouting	String	ECP Account number and Routing number. Only available if ECP payment type is used. IPN: Charge Pending
email	String	Shopper's email address. IPNs: Auth Only Auth Only Single Charge 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 Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Reminder Under Vendor Review Vaulted Shopper
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 Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Reminder Under Vendor Review

F

Name	Value	Description & IPNs
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 RDR Recurring Refund Subscription Charge Failure Subscription Reminder Under Vendor Review
firstName	String	Shopper's first name. IPNs: Auth Only Auth Only Single Charge Cancellation Refund Cancel on Renewal CC Charge Failed CC Status Changed Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Fraud Decline Offline Order Payment Updated Payment Update Failure Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Reminder Under Vendor Review Vaulted Shopper
fraudDeclineDate	mm/dd/yyyy hh:mi AM/PM	Date of the fraud decline. IPN: Fraud Decline

H

Name	Value	Description & IPNs
homePhone	String	Shopper's home phone number. IPN: Charge

I

Name	Value	Description & IPNs
invoiceAddress1 invoiceAddress2 invoiceCity invoiceState invoiceCountry invoiceZip	String	Address information on the invoice IPNs: Auth Only Auth Only Single Charge Cancellation Refund Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Pending Refund RDR Recurring Refund Under Vendor Review
invoiceAmount invoiceAmountUSD	Number Format: #,###.##	Amount in USD on the invoice. IPNs: Auth Only Auth Only Single Charge Cancellation Cancellation Refund Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Pending Refund RDR Recurring Refund Under Vendor Review
invoiceChargeAmount	Number Format: #,###.##	Charged amount (in shopper's local currency) on the invoice. IPNs: Auth Only Auth Only Single Charge Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Pending Refund RDR Recurring Refund Under Vendor Review
invoiceChargeCurrency	String	Currency the Customer was billed in on the invoice. IPNs: Auth Only Auth Only Single Charge Cancellation Refund Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Pending Refund RDR Recurring Refund Under Vendor Review
invoiceCompany	String	The company billed on the invoice. IPNs: Auth Only Auth Only Single Charge Cancellation Refund Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Pending Refund RDR Recurring Refund Under Vendor Review
invoiceEmail	String	Email address on the invoice. IPNs: Auth Only Auth Only Single Charge Cancellation Refund Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Pending Refund RDR Recurring Refund 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 Pending Refund RDR Recurring Refund Under Vendor Review
invoiceFirstName invoiceLastName	String	Shopper's first and last name on the invoice. IPNs: Auth Only Auth Only Single Charge Cancellation Refund Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Pending Refund RDR Recurring Refund Under Vendor Review
invoiceInfoURL	String	Returns link to order_locator_info.jsp page. IPNs: Auth Only Cancellation Cancellation Refund Charge Charge IPN Charge Pending Chargeback Decline RDR Recurring Refund Under Vendor Review
invoiceLocalAmount	Number Format: #,###.##	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 Auth Only Single Charge Cancellation Refund Charge Charge Pending Contract Change Decline 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 Auth Only Single Charge Cancellation Refund Charge Charge Pending Chargeback Chargeback Status Changed Decline Pending Refund RDR Recurring Refund Under Vendor Review
invoiceMobilePhone	String	The shopper's mobile phone number on the invoice. IPN: Charge
invoiceTitle	String	Shopper's title on the invoice. IPNs: Auth Only Cancellation Refund Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Pending Refund RDR Recurring Refund Under Vendor Review
invoiceUrl	String	Direct URL to the purchase page on the invoice. IPNs: Auth Only Auth Only Single Charge Cancellation Refund Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Pending Refund RDR Recurring Refund Under Vendor Review
invoiceExtension invoiceWorkPhone	String	Work phone and extension on the invoice. IPNs: Auth Only Auth Only Single Charge Cancellation Refund Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline RDR Recurring Refund Under Vendor Review
issuerAuthCode	Alphanumeric	Bank authorization code of the original transaction. IPN: Charge

L

Name	Value	Description & IPNs
language	String	Language of the BuyNow page. IPNs: Auth Only Auth Only Single Charge Cancellation Cancellation Refund Cancel on Renewal CC Charge Failed Chargeback Chargeback Status Changed Contract Change Decline Payment Updated Payment Update Failure Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Reminder 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 Auth Only Single Charge Cancellation Cancellation Refund Cancel on Renewal CC Charge Failed CC Status Changed Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Fraud Decline Offline Order Payment Updated Payment Update Failure Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Reminder Under Vendor Review Vaulted Shopper
legalEntity[N]	String	Identifies the payout region. The index [N] associates the payout region to the corresponding currency[N]. IPNs: Failed Payout Transfer Payout
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 RDR Recurring Refund Subscription Charge Failure Subscription Reminder Under Vendor Review
linkedSubscriptions	String	Sent when responseMessage is 501 - Account closed. Contains all the subscription IDs linked to the credit card. IPNs: Account Updater ACH Notification of Change

M

Name	Value	Description & IPNs
merchantEmail	String	Merchant email address IPN: Merchant Partner Onboarded Merchant Partner Status
merchantId	Number	The merchant identification number (MID) is a unique number assigned to the merchant by BlueSnap. IPNs: Failed Payout Transfer Merchant Partner Onboarded Merchant Partner Status Payout Vendor Report Available
merchantName	String	Merchant name IPN: Merchant Partner Onboarded Merchant Partner Status
merchantShopperId	String	A unique shopper ID assigned to the merchant. IPNs: Vaulted Shopper
merchantTransactionId	Number	The merchant transaction identifier (MTI) is a unique number assigned by a merchant to identify a transaction throughout the course of processing activities. IPNs: Auth Only Single Charge Cancellation Cancellation Refund Cancel on Renewal Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Offline Order Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Reminder Under Vendor Review
metaDataKey	String	This parameter is applicable if metadata was passed in the API request. The parameter name is the metadata key and the parameter value is the metadata value. For example, if the metadata key is "keyNumber1" and the metadata value is "value1", keyNumber1=value1 would be passed in the IPN. IPNs: Charge Pending Refund Recurring Refund Subscription Charge Failure
mobilePhone	String	The shopper's mobile phone number. IPN: Charge

N

Name	Value	Description & IPNs
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 and Payment Update Failure
numberOfAttemptsDone	Number	Number of failed subscription charge attempts. IPN: Subscription Charge Failure

Name

Value

Description & IPNs

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 and Payment Update Failure

numberOfAttemptsDone

Number

Number of failed subscription charge attempts.

IPN: Subscription Charge Failure

O

Name	Value	Description & IPNs
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 Auth Only Single Charge Cancellation Cancellation Refund Cancel on Renewal Charge Charge Pending Chargeback Chargeback Status Changed Decline Offline Order Pending Refund RDR Recurring Refund Under Vendor Review
oldContractId	String	Old contract ID before the contract was switched. IPNs: Contract Change and 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
orderAmountUSD	Number Format: #,###.##	Amount in USD of the order. IPN: Offline Order
orderChargeAmount	Number Format: #,###.##	Charge amount (in shopper's local currency) of the order. IPN: Offline Order
orderChargeCurrency	String	Currency the customer was billed in of the order. IPN: Offline Order
orderId	String	Order invoice ID. IPN: Offline Order
originalCreditCardExpirationMonth originalCreditCardExpirationYear originalCreditCardLast4Digits	Number	The expiration month and year and the last four digits of the credit card prior to the update. IPN: Account Updater
originalPublicAccountNumber originalPublicRoutingNumber	Number	The last 5 digits of the account number and routing number prior to the update. IPN: ACH Notification of Change
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 Auth Only Single Charge Cancel on Renewal Charge Charge Pending Chargeback Chargeback Status Changed Decline Pending Refund RDR Refund Under Vendor Review
overridePrice	Number Format: #,###.##	Applicable if the price of the contract was overridden. Value is the amount charged to the shopper. IPN: Charge

P

Name	Value	Description & IPNs
payeeName	String	Payee name as defined in merchant name. 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. IPN: Failed Payout Transfer
payeeEmail	String	Payee's main email address as defined in merchant's email address. IPN: Failed Payout Transfer
paymentCycleStartDate paymentCycleEndDate	String	Indicates the first and last day of the payment cycle. IPNs: Payout, Payout, and Vendor Report Available
paymentId	String	Unique reference ID for each payout. IPNs: Failed Payout Transfer, Payout, and Vendor Report Available
paymentMethod paymentType	String	Possible values: ALIPAY APPLE_PAY BALANCE BANKTRANSFER ANKTRANSFER_AR BANKTRANSFER_BR BANKTRANSFER_COMMON BOLETO_BANCARIO BUSINESS CASHIER CASHU CC CHECK DIRECTDEBIT ECP FAX GIROPAY GOOGLE_PAY GOOGLE_PAY_TOKENIZED_CARD MAIL MONEY_ORDER MONEYBOOKERS NONE OFFLINE_ECP ONLINEBANKING PAYMENT_REQUEST PAYPAL PAYPAL_PAYMENT_METHOD PAYSAFECARD PERSONAL PHONE PO REALTIMEBANK SEPA_DIRECT_DEBIT SOFORTUBERWEISUNG UKASH WALLET_MP WALLET_VISA WALLIE WALLIE_DR WALLIE_GC WEBMONEY WIRE Method of payment (i.e. CC/Paypal/Wire). IPNs: Auth Only Auth Only Single Charge Cancellation Cancellation Refund Cancel on Renewal CC Charge Failed Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Fraud Decline (paymentType parameter) Offline Order Payment Method Updated Payment Method Update Failure Pending Refund RDR Recurring Refund Subscription Reminder Subscription Charge Failure Under Vendor Review
paymentURL	String	Link to the page with payment instructions for the shopper to renew their subscription. IPN: Subscription Reminder
payoutPlannedDate	mm/dd/yyyy hh:mi AM/PM	The date a payment is expected to be initiated according to your payout schedule. IPN: Vendor Report Available
payoutStatus	Yes No Pending	Specifies if the merchant is set up for payout. IPNs: Merchant Partner Onboarded Merchant Partner Status
paypalSubscriptionId paypalTransactionId	Number	Subscription ID and Transaction ID in the merchant's PayPal account. IPNs: Auth Only Auth Only Single Charge (Transaction ID only) Cancellation Cancellation Refund Cancel on Renewal Charge Charge Pending Chargeback Chargeback Status Changed Decline Pending Refund RDR Recurring Refund Subscription Charge Failure Under Vendor Review
personalId	String	Personal identification number for shoppers in these countries: Argentina (DNI), Brazil (CPF/CNPJ), Chile (RUN), and Mexico (CURP/RFC) IPNs: Auth Only Auth Only Single Charge 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 Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Remider Under Vendor Review
personalIdentificationNumber	String	Personal identification number for shoppers. IPNs: Vaulted Shopper
proccessorCode	String	Deprecated — Do not use
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 Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Remider 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 Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Remider Under Vendor Review
promoteContractChargePrice{N}	Number Format: #,###.##	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 RDR Refund Under Vendor Review
promoteContractId{N}	Number	ID of the promotional contract. IPNs: Auth Only CC Charge Failed Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Pending Refund RDR Refund Under Vendor Review
promoteContractLicenseKey{N}	String	License key linked to the promotional contract. IPNs: Auth Only CC Charge Failed Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline RDR Refund Under Vendor Review
promoteContractLocalPrice{N}	Number Format: #,###.##	Price of the promotional contract in the shopper's local currency. If the local currency is natively supported for the charge, this should be the same as promoteContractChargePrice. IPNs: Auth Only CC Charge Failed Charge Charge Pending Contract Change Decline 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 Pending Refund RDR Refund 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 Pending Refund RDR Refund 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 Pending Refund RDR Refund 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 Pending Refund RDR Refund 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 Pending Refund RDR Recurring Refund 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 Pending Refund RDR Refund Under Vendor Review
promoteProductName{N}	String	ID of the promotional item. IPNs: Auth Only Cancellation CC Charge Failed Charge Charge Pending Chargeback Chargeback Status Changed Decline Pending Refund RDR Refund 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 Pending Refund RDR Refund Under Vendor Review
purchaseDate	mm/dd/yyyy hh:mi AM/PM	Transaction date of the original invoice. IPNs: Cancellation Refund Chargeback Chargeback Status Changed Pending Refund RDR Refund

Q and R

Name	Value	Description & IPNs
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 Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Reminder 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 Vendor Review
referenceNumber	Number	BlueSnap reference number. Note: referenceNumber is the same as an invoice, order, or transaction ID. IPNs: Auth Only Auth Only Single Charge Cancellation Refund Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Offline Order Pending Refund RDR Recurring Refund Under Vendor Review
referrer	String	Referrer URL that the Customer came from to the BuyNow page. IPNs: Auth Only Auth Only Single Charge Cancellation Cancellation Refund Cancel on Renewal CC Charge Failed Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Offline Order Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Reminder Under Vendor Review
regulatedCard	String Possible values: N: (default) Card is not regulated Y: Card is regulated	Indicates if this card is regulated. IPNs: Auth Only Auth Only Single Charge Cancel on Renewal Cancellation Cancellation Refund CC Charge Failed Charge Contract Change Decline Payment Method Updated Recurring Subscription Charge Failure Under Vendor Review
reminderNumber	Number	Reminder number of the notice sent to the shopper (1, 2, or 3). IPN: Subscription Reminder
remoteAddress	String	The IP address from which the request was sent. IPNs: Auth Only Auth Only Single Charge Cancellation Cancellation Refund Cancel on Renewal CC Charge Failed Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Offline Order Pending Refund RDR Recurring Refund Under Vendor Review
requestingParty	String	The card issuer that requested the status change. IPN: CC Status Changed
responseDate	MM/DD/YYYY hh:mm AM/PM	Date the update was processed. IPNs: Account Updater ACH Notification of Change
responseMessage	String	Account Updater completion response code. IPNs: Account Updater ACH Notification of Change
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 Pending Refund Refund
reversalReason	String	Reason for the refund or chargeback. IPNs: Chargeback Chargeback Status Changed Pending Refund RDR Refund
reversalRefNum	Number	Reference number of the refund or chargeback. For the reference number of the original transaction, see the referenceNumber parameter in the IPN. IPNs: Chargeback Chargeback Status Changed Pending Refund RDR Refund
routingNumber	String	IPNs: Cancellation Cancellation Refund Charge Pending Decline Pending Refund Recurring Refund Subscription Charge Failure Subscription Reminder

S

Name	Value	Description & IPNs
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 IPNs: Account Updater ACH Notification of Change
sendStatus	String	Status of the sent reminder (sent, failed, or sent by seller). IPN: Subscription Reminder
sepaIban	String Format: {first4}XXXXXXXXX{last4}	IPNs: Cancellation Cancellation Refund Charge Charge Pending Chargeback Chargeback Status Changed Decline Pending Refund RDR Recurring Refund
sepaMandateDate	Date	Mandate date for the SEPA Direct Debit payment. IPNs: Cancellation Cancellation Refund Charge Charge Pending Chargeback Chargeback Status Changed Decline Pending Refund RDR Recurring Refund
sepaMandateId	String	Mandate ID for the SEPA Direct Debit payment. IPNs: Cancellation Cancellation Refund Charge Charge Pending Chargeback Chargeback Status Changed Decline Pending Refund RDR Recurring Refund
shippingAddress1 shippingAddress2 shippingCity shippingState shippingZipCode shippingCountry	String	Shipping address line 1, line 2, city, state, zip code, and country. IPNs: Auth Only Auth Only Single Charge Cancellation Cancellation Refund Cancel on Renewal CC Charge Failed Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Offline Order Pending Refund RDR Refund Under Vendor Review
shippingFirstName shippingLastName	String	Shipping first name and last name. IPNs: Auth Only Auth Only Single Charge Cancellation Cancellation Refund Cancel on Renewal CC Charge Failed Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Offline Order Pending Refund RDR Refund Under Vendor Review
shippingMethod	String	Shipping method, such as UPS or USPS. IPNs: Auth Only Auth Only Single Charge Cancellation Cancellation Refund Cancel on Renewal CC Charge Failed Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Pending Refund RDR Refund Under Vendor Review
shopperAdminUrl shopperOrderUrl	String	Link to the shopper's order information page. IPNs: Auth Only Auth Only Single Charge Cancellation Cancellation Refund Cancel on Renewal Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Payment Updated Payment Update Failure Pending Refund RDR Recurring Refund Subscription Charge Failure Under Vendor Review
shopperCurrency	String	Shopper's three-digit currency code. IPNs: Vaulted Shopper
state	String	Shopper's state. IPNs: Auth Only Auth Only Single Charge Cancellation Cancellation Refund Cancel on Renewal CC Charge Failed Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Offline Order Payment Update Failure Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Reminder Under Vendor Review Vaulted Shopper
status	String Possible values: NEW, REFUND, COMPLETE	The status of CB911 chargeback file upload. IPN: Chargeback File Uploaded
status	String Possible values: SUSPENDED, RESUMED, DELETED	The status of the shopper's card. IPNs: CC Status Changed Pending Refund
statusChangeDate	Date and time	The date and time of the card status change. IPNs: CC Status Changed
subscriptionId	Number	Subscription ID. The subscription ID is displayed in each recurring charge. IPNs: Auth Only Auth Only Single Charge Cancellation Cancellation Refund Cancel on Renewal Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Payment Update Failure Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Reminder Under Vendor Review

T

Name	Value	Description & IPNs
targetBalance	String	Where the transaction funds will be credited or refund made (could be BlueSnap account or Merchant PayPal account). IPNs: Auth Only Auth Only Single Charge Cancellation Cancellation Refund Cancel on Renewal Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Pending Refund RDR Refund Subscription Charge Failure Under Vendor Review
taxAmountUSD	Number Format: #,###.##	Amount, in USD, of tax/VAT paid by a shopper for the order. IPNs: Cancellation Cancellation Refund Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Pending Refund RDR Recurring Refund Under Vendor Review
taxChargeAmount	Number Format: #,###.##	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 Pending Refund RDR Recurring Refund 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 Pending Refund RDR Recurring Refund 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 Auth Only Single Charge Cancellation CC Charge Failed Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Pending Refund RDR Recurring Refund Under Vendor Review
testMode	Y/N	Test transaction made by the Merchant. IPNs: Auth Only Cancel on Renewal Cancellation Cancellation Refund CC Charge Failed Charge Charge Pending Chargeback Chargeback Status Changed Decline Pending Refund RDR Recurring Refund Under Vendor Review
threeDSecure	String	3D Secure status IPNs: Vaulted Shopper
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 Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Reminder Under Vendor Review
transactionDate	mm/dd/yyyy hh:mi AM/PM	Date and time that the transaction occurred. IPNs: Auth Only Auth Only Single Charge 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 Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Reminder Under Vendor Review
transactionType	String Possible values: Account Updater Application Document Request Auth Only Cancellation Cancellation Refund/li> Cancel on Renewal CC Charge Failed Charge Charge Pending Chargeback Contract Change Decline Fraud Decline Offline Order Payment Updated Payment Update Failure RDR Recurring Refund Subscription Charge Failure Subscription Reminder Under Vendor Review Vendor Report Available	Indicates the transaction type IPNs: Account Updater ACH Notification of Change Auth Only Auth Only Single Charge 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 Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Reminder Under Vendor Review

U

Name	Value	Description & IPNs
untilDate	mm/dd/yyyy hh:mi AM/PM	The next scheduled renewal date of a subscription. This also includes the date of the next recurring charge. IPNs: Auth Only Auth Only Single Charge Cancellation Cancellation Refund Cancel on Renewal Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Reminder Under Vendor Review
updatedCreditCardExpirationMonth updatedCreditCardExpirationYear updatedCreditCardLast4Digits	Number	Expiration month, year, and 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
updatedPublicAccountNumber updatedPublicRoutingNumber	Number	The last 5 digits of the account number and routing number after the update. IPN: ACH Notification of Change
username	String	Shopper's username. IPN: Charge

V

Name	Value	Description & IPNs
vatId	Number	Shopper’s VAT ID, as provided during their purchase. IPNs: Auth Only Auth Only Single Charge Cancellation Cancellation Refund Cancel on Renewal CC Charge Failed Charge Charge Pending Chargeback Chargeback Status Changed Contract Change Decline Pending Refund RDR Recurring Refund Subscription Charge Failure Under Vendor Review
vaultedShopperId	Number	A unique identification number assigned to the vaulted shopper by BlueSnap. IPNs: Vaulted Shopper
vendorAccountOpenedDate	mm/dd/yyyy hh:mi AM/PM	Date the vendor account was opened. IPN: Vendor Status Changed
vendorAccountStatus	String Possible values: Active and Inactive	Vendor's account status. IPN: Vendor Status Changed
vendorAccountStatusChangedDate	mm/dd/yyyy hh:mi AM/PM	Date the vendor account status changed. IPN: Vendor Status Changed
vendor[N].id	Number	Vendor's ID. Used to associate transactions with primary merchant. The [N] index associates the vendor ID to the corresponding vendor name. IPNs: Auth Only Auth Only Single Charge Cancel on Renewal Cancellation Cancellation Refund Charge Charge Pending Chargeback Contract Change Decline Payment Method Update Failure Payment Method Updated Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Reminder Under Vendor Review
vendor[N].name	String	Vendor's name. The [N] index associates the vendor name to the corresponding vendor ID. IPNs: Auth Only Auth Only Single Charge Cancel on Renewal Cancellation Cancellation Refund Charge Charge Pending Chargeback Contract Change Decline Payment Method Update Failure Payment Method Updated RDR Recurring Refund Subscription Charge Failure Subscription Reminder Under Vendor Review
vendorCommissionPercent	String	The percent of each vendor's commission at the time of the charge. Sent if absolute amount isn’t available. IPNs: Charge
vendorCurrency	String	The vendor's currency. IPNs: Charge
vendorId	Number	Vendor's ID. Used to associate transactions with primary merchant. IPNs: Auth Only Auth Only Single Charge Cancel on Renewal Cancellation Cancellation Refund Charge Charge Pending Chargeback Chargeback Status Changed Contract Change (subscriptions only) Decline Failed Payout Transfer Payment Updated Payment Updated Failure Payout RDR Recurring Refund Subscription Reminder Under Vendor Review Vendor Report Available Vendor Status Changed
vendorLocalAmount	String	The amount of each vendor's commission at the time of the charge. Sent if percentage isn’t available. IPNs: Charge
vendorMissingFields	String	Contains missing vendor information. Sent when vendorPayoutStatus is N. IPN: Vendor Status Changed
vendorName	String	Vendor's name. IPNs: Auth Only Cancel on Renewal Cancellation Cancellation Refund Charge Charge Pending Chargeback Chargeback Status Changed Contract Change (subscriptions only) Decline Payment Updated Payment Updated Failure Payout RDR Recurring Refund Subscription Reminder Under Vendor Review Vendor Report Available 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: A (Approved) D (Declined) N (Incomplete) R (Under Review/Pending)	Vendor's payout status. IPN: Vendor Status Changed
vendorProcessingStatus	String Possible values: Active and Inactive	Vendor's processing status. IPN: Vendor Status Changed
vendorUsdAmount	String	The USD amount of each vendor's commission at the time of the charge. Sent if percentage isn’t available. IPNs: Charge

W–Z

Name	Value	Description & IPNs
walletType	String	Mobile wallet payment type that the shopper used for the transaction. IPNs: ApplePay GooglePay VisaCheckout MasterPass
workPhone	String	Shopper's work phone number. IPNs: Auth Only Auth Only Single Charge 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 Pending Refund RDR Recurring Refund Subscription Charge Failure Under Vendor Review
zipCode zip	String	Shopper's ZIP code. IPNs: Auth Only Auth Only Single Charge 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 Pending Refund RDR Recurring Refund Subscription Charge Failure Subscription Reminder Vaulted Shopper

Name

Value

Description & IPNs

walletType

String

Mobile wallet payment type that the shopper used for the transaction.

IPNs:

ApplePay
GooglePay
VisaCheckout
MasterPass

workPhone

String

Shopper's work phone number.

IPNs:

Auth Only
Auth Only Single Charge
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
Pending Refund
RDR
Recurring
Refund
Subscription Charge Failure
Under Vendor Review

zipCode
zip

String

Shopper's ZIP code.

IPNs:

Auth Only
Auth Only Single Charge
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
Pending Refund
RDR
Recurring
Refund
Subscription Charge Failure
Subscription Reminder
Vaulted Shopper