Vantiv eCommerce Python SDK 12.30.0!

EXAMPLES

Using dict

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 #Example for SDK
 from __future__ import print_function, unicode_literals

 from vantivsdk import *

 # Initial Configuration object. If you have saved configuration in '.vantiv_python_sdk.conf' at system environment
 # variable: VANTIV_SDK_CONFIG or user home directory, the saved configuration will be automatically load.
 conf = utils.Configuration()

 # Configuration need following attributes for online request:
 # attributes = default value
 # user = ''
 # password = ''
 # merchantId = ''
 # reportGroup = 'Default Report Group'
 # url = 'https://www.testvantivcnp.com/sandbox/communicator/online'
 # proxy = ''
 # print_xml = False

 # Transaction presented by dict
 txn_dict ={
     'authorization':{
         'orderId': '1',
         'amount': 10010,
         'orderSource': 'ecommerce',
         'id': 'ThisIsRequiredby11',
         'billToAddress': {
             'name': 'John & Mary Smith',
             'addressLine1': '1 Main St.',
             'city': 'Burlington',
             'state': 'MA',
             'zip': '01803-3747',
             'country': 'USA'
         },
         'card': {
             'number': '4100000000000000',
             'expDate': '1215',
             'cardValidationNum' : '349',
             'type': 'VI'
         },
         'enhancedData':{
             'detailTax': [
                 {'taxAmount':100},
                 {'taxAmount':200},
             ],
         }
     }
 }

 # Send request to server and get response as dict
 response = online.request(txn_dict, conf)

 print('Message: %s' % response['authorizationResponse']['message'])
 print('cnpTransaction ID: %s' % response['authorizationResponse']['cnpTxnId'])

 # Configuration need following attributes for batch request:
 # attributes = default value
 # sftp_username = ''
 # sftp_password = ''
 # sftp_url = ''
 # batch_requests_path = '/tmp/vantiv_sdk_batch_request'
 # batch_response_path = '/tmp/vantiv_sdk_batch_response'
 # fast_url = ''
 # fast_ssl = True
 # fast_port = ''
 # id = ''

 # Initial batch transactions container class
 transactions = batch.Transactions()

 # Add transaction to batch transactions container
 transactions.add(txn_dict)

 # Sent batch to server via socket and get response as dict
 response = batch.stream(transactions, conf)

 print('Message: %s' % response['batchResponse']['authorizationResponse']['message'])
 print('cnpTransaction ID: %s' % response['batchResponse']['authorizationResponse']['cnpTxnId'])

Using object

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 #Example for SDK
 from __future__ import print_function, unicode_literals

 from vantivsdk import *

 # Initial Configuration object. If you have saved configuration in '.vantiv_python_sdk.conf' at system environment
 # variable: VANTIV_SDK_CONFIG or user home directory, the saved configuration will be automatically load.
 conf = utils.Configuration()

 # Configuration need following attributes for online request:
 # attributes = default value
 # user = ''
 # password = ''
 # merchantId = ''
 # reportGroup = 'Default Report Group'
 # url = 'https://www.testvantivcnp.com/sandbox/communicator/online'
 # proxy = ''
 # print_xml = False

 # Initial Transaction.
 transaction = fields.authorization()
 transaction.orderId = '1'
 transaction.amount = 10010
 transaction.orderSource = 'ecommerce'
 transaction.id = 'ThisIsRequiredby11'

 # Create contact object
 contact = fields.contact()
 contact.name = 'John & Mary Smith'
 contact.addressLine1 = '1 Main St.'
 contact.city = 'Burlington'
 contact.state = 'MA'
 contact.zip = '01803-3747'
 contact.country = 'USA'
 # The type of billToAddress is contact
 transaction.billToAddress = contact

 # Create cardType object
 card = fields.cardType()
 card.number = '4100000000000000'
 card.expDate = '1215'
 card.cardValidationNum = '349'
 card.type = 'VI'
 # The type of card is cardType
 transaction.card = card

 # detail tax
 detailTaxList = list()

 detailTax = fields.detailTax()
 detailTax.taxAmount = 100
 detailTaxList.append(detailTax)

 detailTax2 = fields.detailTax()
 detailTax2.taxAmount = 200
 detailTaxList.append(detailTax2)

 enhancedData = fields.enhancedData()
 enhancedData.detailTax = detailTaxList

 # Send request to server and get response as dict
 response = online.request(transaction, conf)

 print('Message: %s' % response['authorizationResponse']['message'])
 print('cnpTransaction ID: %s' % response['authorizationResponse']['cnpTxnId'])

 # Configuration need following attributes for batch request:
 # attributes = default value
 # sftp_username = ''
 # sftp_password = ''
 # sftp_url = ''
 # batch_requests_path = '/tmp/vantiv_sdk_batch_request'
 # batch_response_path = '/tmp/vantiv_sdk_batch_response'
 # id = ''

 # Initial batch transactions container class
 transactions = batch.Transactions()

 # Add transaction to batch transactions container
 transactions.add(transaction)

 # Sent batch to server via socket and get response as dict
 response = batch.stream(transactions, conf)

 print('Message: %s' % response['batchResponse']['authorizationResponse']['message'])
 print('cnpTransaction ID: %s' % response['batchResponse']['authorizationResponse']['cnpTxnId'])

API

batch.download

vantivsdk.batch.download(filename, conf, delete_remote=False, timeout=60)

Download Processed Session File from server via sFTP

Get xml file from server and save to local file system

Parameters:
  • filename – filename of file in outbound folder at remote server with ‘.asc’ as extension.
  • conf – An instance of utils.Configuration.
  • delete_remote – If delete the remote file after download. The default is False
  • timeout – Timeout in second for ssh connection for sftp.
Returns:

path for file that saved in local file system.
Raises:

Exception depends on when get it.

batch.submit

vantivsdk.batch.submit(transactions, conf, filename='', timeout=60)

Submitting a Session File for Processing to server via sFTP

  1. Generate cnpRequest xml.
  2. Save xml at local file system.
  3. Send xml file to server.
Parameters:
  • transactions – an instance of batch.Transactions.
  • conf – An instance of utils.Configuration.
  • filename – String. File name for generated xml file. If the file exist, a timestamp string will be added.
  • timeout – Positive int. Timeout in second for ssh connection for sftp.
Returns:

filename of file in inbound folder at remote server with ‘.asc’ as extension.
Raises:

Exception depends on when get it.

batch.retrieve

vantivsdk.batch.retrieve(filename, conf, return_format='dict', save_to_local=False, delete_remote=False, timeout=60)

Retrieving Processed Session File from server via sFTP

  1. Get xml file string from server and return object
  2. If save_to_local, save to local file system
Parameters:
  • filename – filename of file in outbound folder at remote server with ‘.asc’ as extension.
  • conf – An instance of utils.Configuration.
  • return_format – Return format. The default is ‘dict’. Could be one of ‘dict’, ‘object’ or ‘xml’.
  • save_to_local – whether save file to local. default is false.
  • delete_remote – If delete the remote file after download. The default is False
  • timeout – Timeout in second for ssh connection for sftp.
Returns:

response XML in desired format.
Raises:

Exception depends on when get it.

batch.Transactions

class vantivsdk.batch.Transactions

Container of transactions for batch request

Then transactions could be RFRRequest and any batch request supported transactions and recurringTransaction. RFRRequest cannot exist in the same instance with any other transactions.

A instance cannot contain more than 1,000,000 transactions.

sameDayFunding

Since v11.1. Used for Dynamic Payout Funding Instructions only. Set to True to mark this Batch of Funding Instructions for same day funding.

Type:bool
add(transaction)

Add transaction to the container class.

Parameters:transaction – an instance of Transactions or RFRRequest which could process by Batch.
Returns:None
Raises:Exceptions.
is_rfr_request

A property, whether current instanc include a RFRRequest

Returns:Boolean
recurringTransactions

A property, return a new list of recurringTransactions.

Returns:list of recurringTransactions
transactions

A property, return a new list of transactions.

Returns:list of transactions

online.request

vantivsdk.online.request(transaction, conf, return_format='dict', timeout=30, sameDayFunding=False)

Send request to server.

Parameters:
  • transaction – An instance of transaction class
  • conf – An instance of utils.Configuration
  • return_format – Return format. The default is ‘dict’. Could be one of ‘dict’, ‘object’ or ‘xml’.
  • timeout – timeout for the request in seconds. timeout is not a time limit on the entire response. It’s the time that server has not issued a response.
  • sameDayFunding (bool) – Start v11.3. Used for Online Dynamic Payout Funding Instructions only. Set to True for same day funding.
Returns:

response XML in desired format.
Raises:

VantivExceptions.

utils.Configuration

class vantivsdk.utils.Configuration(conf_dict={})

Setup Configuration variables.

user

authentication.user

Type:Str
password

authentication.password

Type:Str
merchantId

The unique string to identify the merchant within the system.

Type:Str
reportGroup

To separate your transactions into different categories,

Type:Str
url

Url for server.

Type:Str
proxy

Https proxy server address. Must start with “https://”

Type:Str
sftp_username

Username for sftp

Type:Str
sftp_password

Password for sftp

Type:Str
sftp_url

Address for sftp

Type:Str
batch_requests_path

Location for saving generated batch request xml

Type:Str
batch_response_path

Location for saving batch response xml

Type:Str
print_xml

Whether print request and response xml

Type:Str
save()

Save Class Attributes to .vantiv_python_sdk.conf

Returns:full path for configuration file.
Raises:IOError – An error occurred

Transactions

accountUpdate

class vantivsdk.fields.accountUpdate
Variables:

activate

class vantivsdk.fields.activate
Variables:

activateReversal

class vantivsdk.fields.activateReversal
Variables:
  • card – instance of vantivsdk.fields.giftCardCardType
  • cnpTxnId – String or Number
  • customerId – String or Number
  • id – String or Number
  • originalAmount – String or Number
  • originalRefCode – String or Number
  • originalSequenceNumber – String or Number
  • originalSystemTraceId – String or Number
  • originalTxnTime – String or Number
  • reportGroup – String or Number
  • virtualGiftCardBin – String or Number

authReversal

class vantivsdk.fields.authReversal
Variables:
  • actionReason – String or Number
  • additionalCOFData – instance of vantivsdk.fields.additionalCOFData
  • amount – String or Number
  • cnpTxnId – String or Number
  • customerId – String or Number
  • id – String or Number
  • payPalNotes – String or Number
  • reportGroup – String or Number
  • surchargeAmount – String or Number

authorization

class vantivsdk.fields.authorization
Variables:

balanceInquiry

class vantivsdk.fields.balanceInquiry
Variables:

cancelSubscription

class vantivsdk.fields.cancelSubscription
Variables:subscriptionId – String or Number

capture

class vantivsdk.fields.capture
Variables:

captureGivenAuth

class vantivsdk.fields.captureGivenAuth
Variables:

createPlan

class vantivsdk.fields.createPlan
Variables:
  • active – String or Number
  • amount – String or Number
  • description – String or Number
  • intervalType – String or Number
  • name – String or Number
  • numberOfPayments – String or Number
  • planCode – String or Number
  • trialIntervalType – String or Number
  • trialNumberOfIntervals – String or Number

credit

class vantivsdk.fields.credit
Variables:

customerCredit

class vantivsdk.fields.customerCredit
Variables:
  • accountInfo – instance of vantivsdk.fields.echeckTypeCtx
  • amount – String or Number
  • customIdentifier – String or Number
  • customerId – String or Number
  • customerName – String or Number
  • fundingCustomerId – String or Number
  • fundsTransferId – String or Number
  • id – String or Number
  • reportGroup – String or Number

customerDebit

class vantivsdk.fields.customerDebit
Variables:
  • accountInfo – instance of vantivsdk.fields.echeckTypeCtx
  • amount – String or Number
  • customIdentifier – String or Number
  • customerId – String or Number
  • customerName – String or Number
  • fundingCustomerId – String or Number
  • fundsTransferId – String or Number
  • id – String or Number
  • reportGroup – String or Number

deactivate

class vantivsdk.fields.deactivate
Variables:

deactivateReversal

class vantivsdk.fields.deactivateReversal
Variables:
  • card – instance of vantivsdk.fields.giftCardCardType
  • cnpTxnId – String or Number
  • customerId – String or Number
  • id – String or Number
  • originalRefCode – String or Number
  • originalSequenceNumber – String or Number
  • originalSystemTraceId – String or Number
  • originalTxnTime – String or Number
  • reportGroup – String or Number

depositReversal

class vantivsdk.fields.depositReversal
Variables:
  • card – instance of vantivsdk.fields.giftCardCardType
  • cnpTxnId – String or Number
  • customerId – String or Number
  • id – String or Number
  • originalAmount – String or Number
  • originalRefCode – String or Number
  • originalSequenceNumber – String or Number
  • originalSystemTraceId – String or Number
  • originalTxnTime – String or Number
  • reportGroup – String or Number

depositTransactionReversal

class vantivsdk.fields.depositTransactionReversal
Variables:

echeckCredit

class vantivsdk.fields.echeckCredit
Variables:

echeckPreNoteCredit

class vantivsdk.fields.echeckPreNoteCredit
Variables:

echeckPreNoteSale

class vantivsdk.fields.echeckPreNoteSale
Variables:

echeckRedeposit

class vantivsdk.fields.echeckRedeposit
Variables:

echeckSale

class vantivsdk.fields.echeckSale
Variables:

echeckVerification

class vantivsdk.fields.echeckVerification
Variables:

echeckVoid

class vantivsdk.fields.echeckVoid
Variables:
  • cnpTxnId – String or Number
  • customerId – String or Number
  • id – String or Number
  • reportGroup – String or Number

fastAccessFunding

class vantivsdk.fields.fastAccessFunding
Variables:

forceCapture

class vantivsdk.fields.forceCapture
Variables:

fraudCheck

class vantivsdk.fields.fraudCheck
Variables:

fundingInstructionVoid

class vantivsdk.fields.fundingInstructionVoid
Variables:
  • cnpTxnId – String or Number
  • customerId – String or Number
  • id – String or Number
  • reportGroup – String or Number

giftCardAuthReversal

class vantivsdk.fields.giftCardAuthReversal
Variables:
  • card – instance of vantivsdk.fields.giftCardCardType
  • cnpTxnId – String or Number
  • customerId – String or Number
  • id – String or Number
  • originalAmount – String or Number
  • originalRefCode – String or Number
  • originalSequenceNumber – String or Number
  • originalSystemTraceId – String or Number
  • originalTxnTime – String or Number
  • reportGroup – String or Number

giftCardCapture

class vantivsdk.fields.giftCardCapture
Variables:
  • captureAmount – String or Number
  • card – instance of vantivsdk.fields.giftCardCardType
  • cnpTxnId – String or Number
  • customerId – String or Number
  • id – String or Number
  • originalAmount – String or Number
  • originalRefCode – String or Number
  • originalTxnTime – String or Number
  • partial – String or Number
  • reportGroup – String or Number

giftCardCredit

class vantivsdk.fields.giftCardCredit
Variables:
  • card – instance of vantivsdk.fields.giftCardCardType
  • cnpTxnId – String or Number
  • creditAmount – String or Number
  • customerId – String or Number
  • id – String or Number
  • orderId – String or Number
  • orderSource – String or Number
  • reportGroup – String or Number

load

class vantivsdk.fields.load
Variables:

loadReversal

class vantivsdk.fields.loadReversal
Variables:
  • card – instance of vantivsdk.fields.giftCardCardType
  • cnpTxnId – String or Number
  • customerId – String or Number
  • id – String or Number
  • originalAmount – String or Number
  • originalRefCode – String or Number
  • originalSequenceNumber – String or Number
  • originalSystemTraceId – String or Number
  • originalTxnTime – String or Number
  • reportGroup – String or Number

payFacCredit

class vantivsdk.fields.payFacCredit
Variables:
  • amount – String or Number
  • customerId – String or Number
  • fundingSubmerchantId – String or Number
  • fundsTransferId – String or Number
  • id – String or Number
  • reportGroup – String or Number

payFacDebit

class vantivsdk.fields.payFacDebit
Variables:
  • amount – String or Number
  • customerId – String or Number
  • fundingSubmerchantId – String or Number
  • fundsTransferId – String or Number
  • id – String or Number
  • reportGroup – String or Number

payoutOrgCredit

class vantivsdk.fields.payoutOrgCredit
Variables:
  • amount – String or Number
  • customerId – String or Number
  • fundingCustomerId – String or Number
  • fundsTransferId – String or Number
  • id – String or Number
  • reportGroup – String or Number

payoutOrgDebit

class vantivsdk.fields.payoutOrgDebit
Variables:
  • amount – String or Number
  • customerId – String or Number
  • fundingCustomerId – String or Number
  • fundsTransferId – String or Number
  • id – String or Number
  • reportGroup – String or Number

physicalCheckCredit

class vantivsdk.fields.physicalCheckCredit
Variables:
  • amount – String or Number
  • customerId – String or Number
  • fundingCustomerId – String or Number
  • fundingSubmerchantId – String or Number
  • fundsTransferId – String or Number
  • id – String or Number
  • reportGroup – String or Number

physicalCheckDebit

class vantivsdk.fields.physicalCheckDebit
Variables:
  • amount – String or Number
  • customerId – String or Number
  • fundingCustomerId – String or Number
  • fundingSubmerchantId – String or Number
  • fundsTransferId – String or Number
  • id – String or Number
  • reportGroup – String or Number

queryTransaction

class vantivsdk.fields.queryTransaction
Variables:
  • customerId – String or Number
  • id – String or Number
  • origActionType – String or Number
  • origCnpTxnId – String or Number
  • origId – String or Number
  • reportGroup – String or Number
  • showStatusOnly – String or Number

refundReversal

class vantivsdk.fields.refundReversal
Variables:
  • card – instance of vantivsdk.fields.giftCardCardType
  • cnpTxnId – String or Number
  • customerId – String or Number
  • id – String or Number
  • originalAmount – String or Number
  • originalRefCode – String or Number
  • originalSequenceNumber – String or Number
  • originalSystemTraceId – String or Number
  • originalTxnTime – String or Number
  • reportGroup – String or Number

refundTransactionReversal

class vantivsdk.fields.refundTransactionReversal
Variables:

registerTokenRequest

class vantivsdk.fields.registerTokenRequest
Variables:
  • accountNumber – String or Number
  • applepay – instance of vantivsdk.fields.applepayType
  • cardValidationNum – String or Number
  • customerId – String or Number
  • echeckForToken – instance of vantivsdk.fields.echeckForTokenType
  • encryptedAccountNumber – String or Number
  • encryptedCardValidationNum – String or Number
  • encryptionKeyId – String or Number
  • id – String or Number
  • mpos – instance of vantivsdk.fields.mposType
  • orderId – String or Number
  • paypageRegistrationId – String or Number
  • reportGroup – String or Number

reserveCredit

class vantivsdk.fields.reserveCredit
Variables:
  • amount – String or Number
  • customerId – String or Number
  • fundingCustomerId – String or Number
  • fundingSubmerchantId – String or Number
  • fundsTransferId – String or Number
  • id – String or Number
  • reportGroup – String or Number

reserveDebit

class vantivsdk.fields.reserveDebit
Variables:
  • amount – String or Number
  • customerId – String or Number
  • fundingCustomerId – String or Number
  • fundingSubmerchantId – String or Number
  • fundsTransferId – String or Number
  • id – String or Number
  • reportGroup – String or Number

sale

class vantivsdk.fields.sale
Variables:

serviceStatusRequest

class vantivsdk.fields.serviceStatusRequest
Variables:
  • customerId – String or Number
  • id – String or Number
  • pathId – String or Number
  • reportGroup – String or Number
  • serviceId – String or Number

submerchantCredit

class vantivsdk.fields.submerchantCredit
Variables:
  • accountInfo – instance of vantivsdk.fields.echeckTypeCtx
  • amount – String or Number
  • customIdentifier – String or Number
  • customerId – String or Number
  • fundingSubmerchantId – String or Number
  • fundsTransferId – String or Number
  • id – String or Number
  • reportGroup – String or Number
  • submerchantName – String or Number

submerchantDebit

class vantivsdk.fields.submerchantDebit
Variables:
  • accountInfo – instance of vantivsdk.fields.echeckTypeCtx
  • amount – String or Number
  • customIdentifier – String or Number
  • customerId – String or Number
  • fundingSubmerchantId – String or Number
  • fundsTransferId – String or Number
  • id – String or Number
  • reportGroup – String or Number
  • submerchantName – String or Number

translateToLowValueTokenRequest

class vantivsdk.fields.translateToLowValueTokenRequest
Variables:
  • customerId – String or Number
  • id – String or Number
  • orderId – String or Number
  • reportGroup – String or Number
  • token – String or Number

unload

class vantivsdk.fields.unload
Variables:

unloadReversal

class vantivsdk.fields.unloadReversal
Variables:
  • card – instance of vantivsdk.fields.giftCardCardType
  • cnpTxnId – String or Number
  • customerId – String or Number
  • id – String or Number
  • originalAmount – String or Number
  • originalRefCode – String or Number
  • originalSequenceNumber – String or Number
  • originalSystemTraceId – String or Number
  • originalTxnTime – String or Number
  • reportGroup – String or Number

updateCardValidationNumOnToken

class vantivsdk.fields.updateCardValidationNumOnToken
Variables:
  • cardValidationNum – String or Number
  • cnpToken – String or Number
  • customerId – String or Number
  • id – String or Number
  • orderId – String or Number
  • reportGroup – String or Number

updatePlan

class vantivsdk.fields.updatePlan
Variables:
  • active – String or Number
  • planCode – String or Number

updateSubscription

class vantivsdk.fields.updateSubscription
Variables:

vendorCredit

class vantivsdk.fields.vendorCredit
Variables:
  • accountInfo – instance of vantivsdk.fields.echeckTypeCtx
  • amount – String or Number
  • customerId – String or Number
  • fundingCustomerId – String or Number
  • fundingSubmerchantId – String or Number
  • fundsTransferId – String or Number
  • id – String or Number
  • reportGroup – String or Number
  • vendorAddress – instance of vantivsdk.fields.address
  • vendorName – String or Number

vendorDebit

class vantivsdk.fields.vendorDebit
Variables:
  • accountInfo – instance of vantivsdk.fields.echeckTypeCtx
  • amount – String or Number
  • customerId – String or Number
  • fundingCustomerId – String or Number
  • fundingSubmerchantId – String or Number
  • fundsTransferId – String or Number
  • id – String or Number
  • reportGroup – String or Number
  • vendorAddress – instance of vantivsdk.fields.address
  • vendorName – String or Number

void

class vantivsdk.fields.void
Variables:

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