Complex Types

additionalCOFData

class vantivsdk.fields.additionalCOFData
Variables:
  • frequencyOfMIT – String or Number
  • paymentType – String or Number
  • sequenceIndicator – String or Number
  • totalPaymentCount – String or Number
  • uniqueId – String or Number
  • validationReference – String or Number

address

class vantivsdk.fields.address
Variables:
  • addressLine1 – String or Number
  • addressLine2 – String or Number
  • addressLine3 – String or Number
  • city – String or Number
  • country – String or Number
  • state – String or Number
  • zip – String or Number

advancedFraudChecksType

class vantivsdk.fields.advancedFraudChecksType
Variables:
  • customAttribute1 – String or Number
  • customAttribute2 – String or Number
  • customAttribute3 – String or Number
  • customAttribute4 – String or Number
  • customAttribute5 – String or Number
  • threatMetrixSessionId – String or Number
  • webSessionId – String or Number

advancedFraudResultsType

class vantivsdk.fields.advancedFraudResultsType
Variables:
  • deviceReputationScore – String or Number
  • deviceReviewStatus – String or Number
  • triggeredRule – String or Number

applepayHeaderType

class vantivsdk.fields.applepayHeaderType
Variables:
  • applicationData – String or Number
  • ephemeralPublicKey – String or Number
  • publicKeyHash – String or Number
  • transactionId – String or Number

applepayType

class vantivsdk.fields.applepayType
Variables:

authInformation

class vantivsdk.fields.authInformation
Variables:

billToAddress

class vantivsdk.fields.billToAddress
Variables:
  • addressLine1 – String or Number
  • addressLine2 – String or Number
  • addressLine3 – String or Number
  • city – String or Number
  • companyName – String or Number
  • country – String or Number
  • email – String or Number
  • firstName – String or Number
  • lastName – String or Number
  • middleInitial – String or Number
  • name – String or Number
  • phone – String or Number
  • sellerId – String or Number
  • state – String or Number
  • url – String or Number
  • zip – String or Number

card

class vantivsdk.fields.card
Variables:
  • cardValidationNum – String or Number
  • expDate – String or Number
  • number – String or Number
  • pin – String or Number
  • track – String or Number
  • type – String or Number

cardPaypageType

class vantivsdk.fields.cardPaypageType
Variables:
  • cardValidationNum – String or Number
  • expDate – String or Number
  • paypageRegistrationId – String or Number
  • type – String or Number

cardTokenType

class vantivsdk.fields.cardTokenType
Variables:
  • authenticatedShopperID – String or Number
  • cardValidationNum – String or Number
  • checkoutId – String or Number
  • cnpToken – String or Number
  • expDate – String or Number
  • tokenURL – String or Number
  • type – String or Number

cardType

class vantivsdk.fields.cardType
Variables:
  • cardValidationNum – String or Number
  • expDate – String or Number
  • number – String or Number
  • pin – String or Number
  • track – String or Number
  • type – String or Number

cnpInternalRecurringRequestType

class vantivsdk.fields.cnpInternalRecurringRequestType
Variables:
  • finalPayment – String or Number
  • recurringTxnId – String or Number
  • subscriptionId – String or Number

createAddOnType

class vantivsdk.fields.createAddOnType
Variables:
  • addOnCode – String or Number
  • amount – String or Number
  • endDate – String or Number
  • name – String or Number
  • startDate – String or Number

createDiscountType

class vantivsdk.fields.createDiscountType
Variables:
  • amount – String or Number
  • discountCode – String or Number
  • endDate – String or Number
  • name – String or Number
  • startDate – String or Number

ctxPaymentInformationType

class vantivsdk.fields.ctxPaymentInformationType
Variables:ctxPaymentDetail – String or Number

customBilling

class vantivsdk.fields.customBilling
Variables:
  • city – String or Number
  • descriptor – String or Number
  • phone – String or Number
  • url – String or Number

customerInfo

class vantivsdk.fields.customerInfo
Variables:
  • accountCreatedDate – String or Number
  • accountUsername – String or Number
  • customerCheckingAccount – String or Number
  • customerRegistrationDate – String or Number
  • customerSavingAccount – String or Number
  • customerType – String or Number
  • customerWorkTelephone – String or Number
  • dob – String or Number
  • employerName – String or Number
  • incomeAmount – String or Number
  • incomeCurrency – String or Number
  • membershipEmail – String or Number
  • membershipId – String or Number
  • membershipName – String or Number
  • membershipPhone – String or Number
  • residenceStatus – String or Number
  • ssn – String or Number
  • userAccountEmail – String or Number
  • userAccountNumber – String or Number
  • userAccountPhone – String or Number
  • yearsAtEmployer – String or Number
  • yearsAtResidence – String or Number

deleteAddOnType

class vantivsdk.fields.deleteAddOnType
Variables:addOnCode – String or Number

deleteDiscountType

class vantivsdk.fields.deleteDiscountType
Variables:discountCode – String or Number

detailTax

class vantivsdk.fields.detailTax
Variables:
  • cardAcceptorTaxId – String or Number
  • taxAmount – String or Number
  • taxIncludedInTotal – String or Number
  • taxRate – String or Number
  • taxTypeIdentifier – String or Number

echeckForTokenType

class vantivsdk.fields.echeckForTokenType
Variables:
  • accNum – String or Number
  • routingNum – String or Number

echeckTokenType

class vantivsdk.fields.echeckTokenType
Variables:
  • accType – String or Number
  • checkNum – String or Number
  • cnpToken – String or Number
  • routingNum – String or Number

echeckType

class vantivsdk.fields.echeckType
Variables:
  • accNum – String or Number
  • accType – String or Number
  • ccdPaymentInformation – String or Number
  • checkNum – String or Number
  • routingNum – String or Number

echeckTypeCtx

class vantivsdk.fields.echeckTypeCtx
Variables:
  • accNum – String or Number
  • accType – String or Number
  • ccdPaymentInformation – String or Number
  • checkNum – String or Number
  • ctxPaymentInformation – instance of vantivsdk.fields.ctxPaymentInformationType
  • routingNum – String or Number

enhancedData

class vantivsdk.fields.enhancedData
Variables:
  • customerReference – String or Number
  • deliveryType – String or Number
  • destinationCountryCode – String or Number
  • destinationPostalCode – String or Number
  • detailTax – instance of vantivsdk.fields.detailTax
  • discountAmount – String or Number
  • discountCode – String or Number
  • discountPercent – String or Number
  • dutyAmount – String or Number
  • fulfilmentMethodType – String or Number
  • invoiceReferenceNumber – String or Number
  • lineItemData – instance of vantivsdk.fields.lineItemData
  • orderDate – String or Number
  • salesTax – String or Number
  • shipFromPostalCode – String or Number
  • shippingAmount – String or Number
  • taxExempt – String or Number

filteringType

class vantivsdk.fields.filteringType
Variables:
  • chargeback – String or Number
  • international – String or Number
  • prepaid – String or Number

fraudCheckType

class vantivsdk.fields.fraudCheckType
Variables:
  • authenticatedByMerchant – String or Number
  • authenticationProtocolVersion – String or Number
  • authenticationTransactionId – String or Number
  • authenticationValue – String or Number
  • customerIpAddress – String or Number
  • tokenAuthenticationValue – String or Number

fraudResult

class vantivsdk.fields.fraudResult
Variables:
  • advancedAVSResult – String or Number
  • advancedFraudResults – instance of vantivsdk.fields.advancedFraudResultsType
  • authenticationResult – String or Number
  • avsResult – String or Number
  • cardValidationResult – String or Number

giftCardCardType

class vantivsdk.fields.giftCardCardType
Variables:
  • cardValidationNum – String or Number
  • expDate – String or Number
  • number – String or Number
  • pin – String or Number
  • track – String or Number
  • type – String or Number

giropayType

class vantivsdk.fields.giropayType
Variables:preferredLanguage – String or Number

healthcareAmounts

class vantivsdk.fields.healthcareAmounts
Variables:
  • RxAmount – String or Number
  • clinicOtherAmount – String or Number
  • copayAmount – String or Number
  • dentalAmount – String or Number
  • totalHealthcareAmount – String or Number
  • visionAmount – String or Number

healthcareIIAS

class vantivsdk.fields.healthcareIIAS
Variables:

idealType

class vantivsdk.fields.idealType
Variables:preferredLanguage – String or Number

lineItemData

class vantivsdk.fields.lineItemData
Variables:
  • commodityCode – String or Number
  • detailTax – instance of vantivsdk.fields.detailTax
  • itemCategory – String or Number
  • itemDescription – String or Number
  • itemDiscountAmount – String or Number
  • itemSequenceNumber – String or Number
  • itemSubCategory – String or Number
  • lineItemTotal – String or Number
  • lineItemTotalWithTax – String or Number
  • productCode – String or Number
  • productId – String or Number
  • productName – String or Number
  • quantity – String or Number
  • taxAmount – String or Number
  • unitCost – String or Number
  • unitOfMeasure – String or Number

lodgingCharge

class vantivsdk.fields.lodgingCharge
Variables:name – String or Number

lodgingInfo

class vantivsdk.fields.lodgingInfo
Variables:
  • bookingID – String or Number
  • checkInDate – String or Number
  • checkOutDate – String or Number
  • customerServicePhone – String or Number
  • duration – String or Number
  • fireSafetyIndicator – String or Number
  • hotelFolioNumber – String or Number
  • lodgingCharge – instance of vantivsdk.fields.lodgingCharge
  • numAdults – String or Number
  • numberOfRooms – String or Number
  • passengerName – String or Number
  • programCode – String or Number
  • propertyAddress – instance of vantivsdk.fields.propertyAddress
  • propertyLocalPhone – String or Number
  • roomRate – String or Number
  • roomTax – String or Number
  • smokingPreference – String or Number
  • tollFreePhoneNumber – String or Number
  • travelPackageIndicator – String or Number

merchantDataType

class vantivsdk.fields.merchantDataType
Variables:
  • affiliate – String or Number
  • campaign – String or Number
  • merchantGroupingId – String or Number

mposType

class vantivsdk.fields.mposType
Variables:
  • encryptedTrack – String or Number
  • formatId – String or Number
  • ksn – String or Number
  • track1Status – String or Number
  • track2Status – String or Number

passengerTransportData

class vantivsdk.fields.passengerTransportData
Variables:
  • arrivalDate – String or Number
  • carrierName – String or Number
  • computerizedReservationSystem – String or Number
  • creditReasonIndicator – String or Number
  • customerCode – String or Number
  • exchangeAmount – String or Number
  • exchangeFeeAmount – String or Number
  • exchangeTicketNumber – String or Number
  • issueDate – String or Number
  • issuingCarrier – String or Number
  • numberOfAdults – String or Number
  • numberOfChildren – String or Number
  • passengerName – String or Number
  • restrictedTicketIndicator – String or Number
  • ticketChangeIndicator – String or Number
  • ticketIssuerAddress – String or Number
  • ticketNumber – String or Number
  • travelAgencyCode – String or Number
  • travelAgencyName – String or Number
  • tripLegData – instance of vantivsdk.fields.tripLegData

payPal

class vantivsdk.fields.payPal
Variables:

pinlessDebitRequestType

class vantivsdk.fields.pinlessDebitRequestType
Variables:

pos

class vantivsdk.fields.pos
Variables:
  • capability – String or Number
  • cardholderId – String or Number
  • catLevel – String or Number
  • entryMode – String or Number
  • terminalId – String or Number

preferredDebitNetworksType

class vantivsdk.fields.preferredDebitNetworksType
Variables:debitNetworkName – String or Number

processingInstructions

class vantivsdk.fields.processingInstructions
Variables:bypassVelocityCheck – String or Number

propertyAddress

class vantivsdk.fields.propertyAddress
Variables:
  • city – String or Number
  • country – String or Number
  • name – String or Number
  • region – String or Number

recurringRequestType

class vantivsdk.fields.recurringRequestType
Variables:createSubscription – instance of vantivsdk.fields.recurringSubscriptionType

recurringSubscriptionType

class vantivsdk.fields.recurringSubscriptionType
Variables:

recyclingRequestType

class vantivsdk.fields.recyclingRequestType
Variables:
  • recycleBy – String or Number
  • recycleId – String or Number

retailerAddress

class vantivsdk.fields.retailerAddress
Variables:
  • addressLine1 – String or Number
  • addressLine2 – String or Number
  • addressLine3 – String or Number
  • city – String or Number
  • companyName – String or Number
  • country – String or Number
  • email – String or Number
  • firstName – String or Number
  • lastName – String or Number
  • middleInitial – String or Number
  • name – String or Number
  • phone – String or Number
  • sellerId – String or Number
  • state – String or Number
  • url – String or Number
  • zip – String or Number

sellerAddress

class vantivsdk.fields.sellerAddress
Variables:
  • sellerCity – String or Number
  • sellerCountrycode – String or Number
  • sellerPostalcode – String or Number
  • sellerProvincecode – String or Number
  • sellerStreetaddress – String or Number
  • sellerUnit – String or Number

sellerInfo

class vantivsdk.fields.sellerInfo
Variables:
  • accountNumber – String or Number
  • aggregateOrderCount – String or Number
  • aggregateOrderDollars – String or Number
  • createdDate – String or Number
  • domain – String or Number
  • email – String or Number
  • lastUpdateDate – String or Number
  • name – String or Number
  • onboardingEmail – String or Number
  • onboardingIpAddress – String or Number
  • parentEntity – String or Number
  • phone – String or Number
  • sellerAddress – instance of vantivsdk.fields.sellerAddress
  • sellerId – String or Number
  • sellerTags – instance of vantivsdk.fields.sellerTagsType
  • username – String or Number

sellerTagsType

class vantivsdk.fields.sellerTagsType
Variables:tag – String or Number

sepaDirectDebitType

class vantivsdk.fields.sepaDirectDebitType
Variables:
  • iban – String or Number
  • mandateProvider – String or Number
  • mandateReference – String or Number
  • mandateSignatureDate – String or Number
  • mandateUrl – String or Number
  • preferredLanguage – String or Number
  • sequenceType – String or Number

shipToAddress

class vantivsdk.fields.shipToAddress
Variables:
  • addressLine1 – String or Number
  • addressLine2 – String or Number
  • addressLine3 – String or Number
  • city – String or Number
  • companyName – String or Number
  • country – String or Number
  • email – String or Number
  • firstName – String or Number
  • lastName – String or Number
  • middleInitial – String or Number
  • name – String or Number
  • phone – String or Number
  • sellerId – String or Number
  • state – String or Number
  • url – String or Number
  • zip – String or Number

sofortType

class vantivsdk.fields.sofortType
Variables:preferredLanguage – String or Number

token

class vantivsdk.fields.token
Variables:
  • authenticatedShopperID – String or Number
  • cardValidationNum – String or Number
  • checkoutId – String or Number
  • cnpToken – String or Number
  • expDate – String or Number
  • tokenURL – String or Number
  • type – String or Number

tripLegData

class vantivsdk.fields.tripLegData
Variables:
  • arrivalTime – String or Number
  • carrierCode – String or Number
  • departureCode – String or Number
  • departureDate – String or Number
  • departureTime – String or Number
  • destinationCode – String or Number
  • fareBasisCode – String or Number
  • originCity – String or Number
  • remarks – String or Number
  • serviceClass – String or Number
  • stopOverCode – String or Number
  • travelNumber – String or Number
  • tripLegNumber – String or Number

updateAddOnType

class vantivsdk.fields.updateAddOnType
Variables:
  • addOnCode – String or Number
  • amount – String or Number
  • endDate – String or Number
  • name – String or Number
  • startDate – String or Number

updateDiscountType

class vantivsdk.fields.updateDiscountType
Variables:
  • amount – String or Number
  • discountCode – String or Number
  • endDate – String or Number
  • name – String or Number
  • startDate – String or Number

virtualGiftCardType

class vantivsdk.fields.virtualGiftCardType
Variables:
  • accountNumberLength – String or Number
  • giftCardBin – String or Number

wallet

class vantivsdk.fields.wallet
Variables:
  • walletSourceType – String or Number
  • walletSourceTypeId – String or Number