Vantiv CnpAPI Reference Guide Cnp API API11.3 V1.8
User Manual: Pdf
Open the PDF directly: View PDF
Page Count: 944 [warning: Documents this large are best viewed by clicking the View PDF Link!]
- cnpAPI Reference Guide
- About This Guide
- 1 Introduction
- 1.1 The cnpAPI Data Format
- 1.2 Batch Transaction Processing
- 1.3 Payment Integration Platform (cnpAPI SDKs)
- 1.4 Duplicate Transaction Detection
- 1.5 Coding for Report Groups
- 1.6 Recovery
- 1.7 Recurring Engine
- 1.8 Issuer Insights
- 1.9 Fraud Toolkit
- 1.9.1 Essential Tier
- 1.9.1.1 Prepaid Card Filtering
- 1.9.1.2 International BIN Filtering
- 1.9.1.3 Prior Chargeback Filtering
- 1.9.1.4 Security Code No-Match Filter
- 1.9.1.5 Card Velocity Filtering
- 1.9.1.6 Prior Fraud Advice Filtering
- 1.9.1.7 AVS Filter
- 1.9.1.8 Email Velocity Filter
- 1.9.1.9 Phone Velocity Filter
- 1.9.1.10 IP Velocity Filter
- 1.9.1.11 Device Velocity Filter
- 1.9.1.12 Application of Filters - Filtering Rules
- 1.9.2 Extended Tier
- 1.9.3 Premium Tier
- 1.9.4 Modifications to Your Web Page
- 1.9.1 Essential Tier
- 1.10 Tokenization Feature
- 1.11 eCheck Processing
- 1.12 SEPA Direct Debit
- 1.13 iDEAL, SOFORT, and Giropay
- 1.14 eCommerce Solution for Apple Pay™
- 1.15 eCommerce Solution for Android Pay™
- 1.16 Supported Transaction Types
- 1.16.1 Authorization Transaction
- 1.16.2 Authorization Reversal Transactions
- 1.16.3 Activate Transaction
- 1.16.4 Activate Reversal Transaction (Online Only)
- 1.16.5 Balance Inquiry Transaction
- 1.16.6 Cancel Subscription Transaction
- 1.16.7 Capture Transaction
- 1.16.8 Capture Given Auth Transaction
- 1.16.9 Create Plan Transaction
- 1.16.10 Credit Transaction
- 1.16.11 Deactivate Transaction
- 1.16.12 Deactivate Reversal Transaction (Online Only)
- 1.16.13 Deposit Reversal Transaction (Online Only)
- 1.16.14 eCheck Credit Transaction
- 1.16.15 eCheck Prenotification Credit Transaction
- 1.16.16 eCheck Prenotification Sale Transaction
- 1.16.17 eCheck Redeposit Transaction
- 1.16.18 eCheck Sales Transaction
- 1.16.19 eCheck Verification Transaction
- 1.16.20 eCheck Void Transaction (Online Only)
- 1.16.21 Force Capture Transaction
- 1.16.22 Gift Card Auth Reversal
- 1.16.23 Gift Card Capture
- 1.16.24 Gift Card Credit
- 1.16.25 Load Transaction
- 1.16.26 Load Reversal Transaction (Online Only)
- 1.16.27 Refund Reversal Transaction (Online Only)
- 1.16.28 Register Token Transaction
- 1.16.29 Sale Transaction
- 1.16.30 Status Query Transaction
- 1.16.31 Unload Transaction
- 1.16.32 Unload Reversal Transaction (Online Only)
- 1.16.33 Update Card Validation Number Transaction
- 1.16.34 Update Plan Transaction
- 1.16.35 Update Subscription Transaction
- 1.16.36 Void Transaction (Online Only)
- 1.16.37 Instruction-Based Dynamic Payout Transactions
- 2 Testing Your cnpAPI Transactions
- 2.1 Certification and Testing Environments
- 2.2 Overview of Testing
- 2.3 Transferring Files
- 2.4 Performing the Required Certification Tests
- 2.4.1 Testing Authorization (including Indicators), AVS Only, Capture, Credit, Sale, and Void Transactions
- 2.4.2 Testing Authorization Reversal Transactions
- 2.4.3 Testing eCheck Transactions
- 2.4.4 Testing Token Transactions
- 2.4.5 Testing Query Transactions
- 2.4.6 Testing Online Duplicate Transaction Processing
- 2.5 Performing the Optional Tests
- 2.5.1 Testing AVS and Card Validation
- 2.5.2 Testing Address Responses
- 2.5.3 Testing Advanced AVS Response Codes
- 2.5.4 Testing Response Reason Codes and Messages
- 2.5.5 Testing 3DS Responses
- 2.5.6 Testing the Prepaid Filtering Feature
- 2.5.7 Testing the International Card Filter Feature
- 2.5.8 Testing Security Code No-Match Filtering
- 2.5.9 Testing Advanced Fraud Tools
- 2.5.10 Testing Account Updater
- 2.5.11 Testing Tax Billing
- 2.5.12 Testing Convenience Fees
- 2.5.13 Testing the Recycling Engine
- 2.5.14 Testing Recurring Engine Transactions
- 2.5.15 Testing Gift Card Transactions
- 2.5.16 Testing MasterPass Transactions
- 2.5.17 Testing Apple Pay Transaction Processing
- 2.5.18 Testing Android Pay Transaction Processing
- 2.5.19 Testing checkoutId
- 2.5.20 Testing SEPA Direct Debit Transaction
- 2.5.21 Testing iDEAL Transactions
- 2.5.22 Testing Giropay Transactions
- 2.5.23 Testing SOFORT Transactions
- 2.5.24 Testing Transaction Volume Capacity
- 3 cnpAPI Transaction Examples
- 3.1 Overview of Online and Batch Processing Formats
- 3.2 Online Processing Format
- 3.3 Transaction Types and Examples
- 3.3.1 Authorization Transactions
- 3.3.2 Authorization Reversal Transactions
- 3.3.3 Activate Transactions
- 3.3.4 Activate Reversal Transactions (Online Only)
- 3.3.5 Balance Inquiry Transactions
- 3.3.6 Cancel Subscription Transactions
- 3.3.7 Capture Transactions
- 3.3.8 Capture Given Auth Transactions
- 3.3.9 Create Plan Transactions
- 3.3.10 Credit Transactions
- 3.3.11 Deactivate Transactions
- 3.3.12 Deactivate Reversal Transactions (Online Only)
- 3.3.13 Deposit Reversal Transactions (Online Only)
- 3.3.14 eCheck Credit Transactions
- 3.3.15 eCheck Prenotification Credit Transactions (Batch Only)
- 3.3.16 eCheck Prenotification Sale Transactions (Batch Only)
- 3.3.17 eCheck Redeposit Transactions
- 3.3.18 eCheck Sale Transactions
- 3.3.19 eCheck Verification Transactions
- 3.3.20 eCheck Void Transactions (Online Only)
- 3.3.21 Force Capture Transactions
- 3.3.22 Fraud Check Transaction
- 3.3.23 Gift Card Auth Reversal Transactions
- 3.3.24 Gift Card Capture Transactions
- 3.3.25 Gift Card Credit Transactions
- 3.3.26 Load Transactions
- 3.3.27 Load Reversal Transactions (Online Only)
- 3.3.28 Status Query Transactions (Online Only)
- 3.3.29 Refund Reversal Transactions (Online Only)
- 3.3.30 Register Token Transactions
- 3.3.31 RFR Transactions (Batch Only)
- 3.3.32 Sale Transactions
- 3.3.33 Unload Transactions
- 3.3.34 Unload Reversal Transactions (Online Only)
- 3.3.35 Update Plan Transactions
- 3.3.36 Update Subscription Transactions
- 3.3.37 Update Card Validation Number Transactions
- 3.3.38 Void Transactions (Online Only)
- 4 cnpAPI Elements
- 4.1 accNum
- 4.2 accountInfo
- 4.3 accountInformation
- 4.4 accountNumber
- 4.5 accountNumberLength
- 4.6 accountUpdate
- 4.7 accountUpdateFileRequestData
- 4.8 accountUpdater
- 4.9 accountUpdateResponse
- 4.10 accType
- 4.11 actionReason
- 4.12 activate
- 4.13 activateResponse
- 4.14 activateReversal
- 4.15 activateReversalResponse
- 4.16 active
- 4.17 addOnCode
- 4.18 addressIndicator
- 4.19 addressLine1, addressLine2, addressLine3
- 4.20 advancedAVSResult
- 4.21 advancedFraudChecks
- 4.22 advancedFraudResults
- 4.23 affiliate
- 4.24 affluence
- 4.25 allowPartialAuth
- 4.26 amexAggregatorData
- 4.27 amount
- 4.28 androidpayResponse
- 4.29 applepay
- 4.30 applepayResponse
- 4.31 applicationData
- 4.32 applicationExpirationDate
- 4.33 applicationPrimaryAccountNumber
- 4.34 approvedAmount
- 4.35 authAmount
- 4.36 authCode
- 4.37 authDate
- 4.38 authenticatedByMerchant
- 4.39 authentication
- 4.40 authenticationResult
- 4.41 authenticationTransactionId
- 4.42 authenticationValue
- 4.43 authInformation
- 4.44 authorization
- 4.45 authorizationResponse
- 4.46 authorizationSourcePlatform
- 4.47 authReversal
- 4.48 authReversalResponse
- 4.49 availableBalance
- 4.50 avsResult
- 4.51 balanceInquiry
- 4.52 balanceInquiryResponse
- 4.53 batchRequest
- 4.54 batchResponse
- 4.55 beginningBalance
- 4.56 billingDate
- 4.57 billMeLaterRequest
- 4.58 billMeLaterResponseData
- 4.59 billToAddress
- 4.60 bin
- 4.61 bmlMerchantId
- 4.62 bmlProductType
- 4.63 bypassVelocityCheck
- 4.64 campaign
- 4.65 cancelSubscription
- 4.66 cancelSubscriptionResponse
- 4.67 capability
- 4.68 capture
- 4.69 captureAmount
- 4.70 captureGivenAuth
- 4.71 captureGivenAuthResponse
- 4.72 captureResponse
- 4.73 card
- 4.74 cardAcceptorTaxId
- 4.75 cardholderAuthentication
- 4.76 cardholderId
- 4.77 cardholderName
- 4.78 cardOrToken
- 4.79 cardProductType
- 4.80 cardSuffix
- 4.81 cardValidationNum
- 4.82 cardValidationResult
- 4.83 cashBackAmount
- 4.84 catLevel
- 4.85 ccdPaymentInformation
- 4.86 chargeback
- 4.87 checkNum
- 4.88 checkoutId
- 4.89 city
- 4.90 clinicOtherAmount
- 4.91 code
- 4.92 commodityCode
- 4.93 companyName
- 4.94 country
- 4.95 createAddOn
- 4.96 createDiscount
- 4.97 createPlan
- 4.98 createPlanResponse
- 4.99 credit
- 4.100 creditAmount
- 4.101 creditLine
- 4.102 creditLitleTxnId
- 4.103 creditResponse
- 4.104 cryptogram
- 4.105 currencyCode
- 4.106 customAttribute1
- 4.107 customBilling
- 4.108 customIdentifier
- 4.109 customerInfo
- 4.110 customerIpAddress
- 4.111 customerReference
- 4.112 customerRegistrationDate
- 4.113 customerType
- 4.114 customerWorkTelephone
- 4.115 data
- 4.116 deactivate
- 4.117 deactivateResponse
- 4.118 deactivateReversal
- 4.119 deactivateReversalResponse
- 4.120 debtRepayment
- 4.121 deleteAddOn
- 4.122 deleteDiscount
- 4.123 deliveryType
- 4.124 dentalAmount
- 4.125 depositReversal
- 4.126 depositReversalResponse
- 4.127 description
- 4.128 descriptor
- 4.129 destinationCountryCode
- 4.130 destinationPostalCode
- 4.131 detailTax
- 4.132 deviceManufacturerIdentifier
- 4.133 deviceReputationScore
- 4.134 deviceReviewStatus
- 4.135 discountAmount
- 4.136 discountCode
- 4.137 dob
- 4.138 dutyAmount
- 4.139 echeck
- 4.140 eCheckAccountSuffix
- 4.141 echeckCredit
- 4.142 echeckCreditResponse
- 4.143 echeckForToken
- 4.144 echeckOrEcheckToken
- 4.145 echeckPreNoteCredit
- 4.146 echeckPreNoteCreditResponse
- 4.147 echeckPreNoteSale
- 4.148 echeckPreNoteSaleResponse
- 4.149 echeckRedeposit
- 4.150 echeckRedepositResponse
- 4.151 echeckSale
- 4.152 echeckSalesResponse
- 4.153 echeckToken
- 4.154 echeckVerification
- 4.155 echeckVerificationResponse
- 4.156 echeckVoid
- 4.157 echeckVoidResponse
- 4.158 eciIndicator
- 4.159 email
- 4.160 employerName
- 4.161 encryptedTrack
- 4.162 endDate
- 4.163 endingBalance
- 4.164 endpoint
- 4.165 enhancedAuthResponse
- 4.166 enhancedData
- 4.167 entryMode
- 4.168 ephemeralPublicKey
- 4.169 expDate
- 4.170 expMonth
- 4.171 expYear
- 4.172 extendedCardResponse
- 4.173 fastAccessFunding
- 4.174 fastAccessFundingResponse
- 4.175 fieldValue
- 4.176 filtering
- 4.177 finalPayment
- 4.178 firstName
- 4.179 forceCapture
- 4.180 forceCaptureResponse
- 4.181 formatId
- 4.182 fraudCheck
- 4.183 fraudCheckResponse
- 4.184 fraudFilterOverride
- 4.185 fraudResult
- 4.186 fundingInstructionVoid
- 4.187 fundingInstructionVoidResponse
- 4.188 fundingSource
- 4.189 fundingSubmerchantId
- 4.190 fundsTransferId
- 4.191 giftCardAuthReversal
- 4.192 giftCardAuthReversalResponse
- 4.193 giftCardBin
- 4.194 giftCardCapture
- 4.195 giftCardCaptureResponse
- 4.196 giftCardCredit
- 4.197 giftCardCreditResponse
- 4.198 giftCardResponse
- 4.199 giropay
- 4.200 giropayResponse
- 4.201 header
- 4.202 healthcareAmounts
- 4.203 healthcareIIAS
- 4.204 iban
- 4.205 ideal
- 4.206 idealResponse
- 4.207 IIASFlag
- 4.208 incomeAmount
- 4.209 incomeCurrency
- 4.210 international
- 4.211 intervalType
- 4.212 invoiceReferenceNumber
- 4.213 issuerCountry
- 4.214 itemCategoryCode
- 4.215 itemDescription
- 4.216 itemDiscountAmount
- 4.217 itemSequenceNumber
- 4.218 ksn
- 4.219 lastName
- 4.220 lineItemData
- 4.221 lineItemTotal
- 4.222 lineItemTotalWithTax
- 4.223 litleInternalRecurringRequest
- 4.224 litleOnlineRequest
- 4.225 litleOnlineResponse
- 4.226 litleRequest
- 4.227 litleResponse
- 4.228 litleSessionId
- 4.229 litleToken
- 4.230 litleTxnId
- 4.231 load
- 4.232 loadResponse
- 4.233 loadReversal
- 4.234 loadReversalResponse
- 4.235 mandateProvider
- 4.236 mandateReference
- 4.237 mandateSignatureDate
- 4.238 mandateURL
- 4.239 matchCount
- 4.240 merchantData
- 4.241 merchantGroupingId
- 4.242 merchantId
- 4.243 message
- 4.244 middleInitial
- 4.245 mpos
- 4.246 name
- 4.247 networkField
- 4.248 networkResponse
- 4.249 networkSubField
- 4.250 networkTransactionId
- 4.251 newAccountInfo
- 4.252 newCardInfo
- 4.253 newCardTokenInfo
- 4.254 newTokenInfo
- 4.255 nextRecycleTime
- 4.256 number
- 4.257 numberOfPayments
- 4.258 onlinePaymentCryptogram
- 4.259 orderDate
- 4.260 orderId
- 4.261 orderSource
- 4.262 originalAccountInfo
- 4.263 origAccountNumber
- 4.264 origActionType
- 4.265 origId
- 4.266 originalAmount
- 4.267 originalCard
- 4.268 originalCardInfo
- 4.269 originalCardTokenInfo
- 4.270 originalNetworkTransactionId
- 4.271 originalRefCode
- 4.272 originalSequenceNumber
- 4.273 originalSystemTraceId
- 4.274 originalToken
- 4.275 originalTokenInfo
- 4.276 originalTransactionAmount
- 4.277 originalTxnTime
- 4.278 origLitleTxnId
- 4.279 origOrderId
- 4.280 password
- 4.281 payerId
- 4.282 payFacCredit
- 4.283 payFacCreditResponse
- 4.284 payFacDebit
- 4.285 payFacDebitResponse
- 4.286 paymentDataType
- 4.287 paymentPurpose
- 4.288 paypage
- 4.289 paypageRegistrationId
- 4.290 paypal
- 4.291 payPalNotes
- 4.292 payPalOrderComplete
- 4.293 phone
- 4.294 physicalCheckCredit
- 4.295 physicalCheckCreditResponse
- 4.296 physicalCheckDebit
- 4.297 physicalCheckDebitResponse
- 4.298 pin
- 4.299 planCode
- 4.300 pos
- 4.301 postDate
- 4.302 postDay
- 4.303 preapprovalNumber
- 4.304 preferredLanguage
- 4.305 prepaid
- 4.306 prepaidCardType
- 4.307 processingInstructions
- 4.308 processingType
- 4.309 productCode
- 4.310 publicKeyHash
- 4.311 quantity
- 4.312 queryTransaction
- 4.313 queryTransactionResponse
- 4.314 queryTransactionUnavailableResponse
- 4.315 recurringRequest
- 4.316 recurringResponse
- 4.317 recurringTxnId
- 4.318 recycleAdvice
- 4.319 recycleAdviceEnd
- 4.320 recycleBy
- 4.321 recycleEngineActive
- 4.322 recycleId
- 4.323 recycling
- 4.324 recyclingRequest
- 4.325 redirectToken
- 4.326 redirectUrl
- 4.327 refCode
- 4.328 refundReversal
- 4.329 refundReversalResponse
- 4.330 registerTokenRequest
- 4.331 registerTokenResponse
- 4.332 reloadable
- 4.333 reserveCredit
- 4.334 reserveCreditResponse
- 4.335 reserveDebit
- 4.336 reserveDebitResponse
- 4.337 residenceStatus
- 4.338 response
- 4.339 responseCode
- 4.340 responseMessage
- 4.341 responseTime
- 4.342 results_Max10
- 4.343 RFRRequest
- 4.344 RFRResponse
- 4.345 routingNum
- 4.346 RxAmount
- 4.347 sale
- 4.348 saleResponse
- 4.349 salesTax
- 4.350 secondaryAmount
- 4.351 sellerId
- 4.352 sellerMerchantCategoryCode
- 4.353 sepaDirectDebit
- 4.354 sepaDirectDebitResponse
- 4.355 sequenceNumber
- 4.356 sequenceType
- 4.357 shipFromPostalCode
- 4.358 shippingAmount
- 4.359 shipToAddress
- 4.360 signature
- 4.361 sofort
- 4.362 sofortResponse
- 4.363 ssn
- 4.364 startDate
- 4.365 state
- 4.366 submerchantCredit
- 4.367 submerchantCreditResponse
- 4.368 submerchantDebit
- 4.369 submerchantDebitResponse
- 4.370 submerchantName
- 4.371 subscription
- 4.372 subscriptionId
- 4.373 surchargeAmount
- 4.374 systemTraceId
- 4.375 taxAmount
- 4.376 taxExempt
- 4.377 taxIncludedInTotal
- 4.378 taxRate
- 4.379 taxType
- 4.380 taxTypeIdentifier
- 4.381 terminalId
- 4.382 termsAndConditions
- 4.383 threatMetrixSessionId
- 4.384 token
- 4.385 tokenMessage
- 4.386 tokenResponse
- 4.387 tokenResponseCode
- 4.388 totalHealthcareAmount
- 4.389 track
- 4.390 track1Status
- 4.391 track2Status
- 4.392 transactionAmount
- 4.393 transactionId
- 4.394 trialIntervalType
- 4.395 trialNumberOfIntervals
- 4.396 triggeredRule
- 4.397 txnTime
- 4.398 type
- 4.399 unitCost
- 4.400 unitOfMeasure
- 4.401 unload
- 4.402 unloadResponse
- 4.403 unloadReversal
- 4.404 unloadReversalResponse
- 4.405 updateAddOn
- 4.406 updatedCard
- 4.407 updateCardValidationNumOnToken
- 4.408 updateCardValidationNumOnTokenResponse
- 4.409 updateDiscount
- 4.410 updatePlan
- 4.411 updatePlanResponse
- 4.412 updateSubscription
- 4.413 updateSubscriptionResponse
- 4.414 updatedToken
- 4.415 url
- 4.416 user
- 4.417 vendorCredit
- 4.418 vendorCreditResponse
- 4.419 vendorDebit
- 4.420 vendorDebitResponse
- 4.421 vendorName
- 4.422 verificationCode
- 4.423 verify
- 4.424 version
- 4.425 virtualAccountNumber
- 4.426 virtualAuthenticationKeyData
- 4.427 virtualAuthenticationKeyPresenceIndicator
- 4.428 virtualGiftCard
- 4.429 virtualGiftCardBin
- 4.430 virtualGiftCardResponse
- 4.431 visionAmount
- 4.432 void
- 4.433 voidResponse
- 4.434 wallet
- 4.435 walletSourceType
- 4.436 walletSourceTypeId
- 4.437 yearsAtEmployer
- 4.438 yearsAtResidence
- 4.439 zip
- A Payment Transaction Response Codes
- A.1 Payment Transaction Response Codes
- A.2 3DS Authentication Result Codes
- A.3 AVS Response Codes
- A.4 AAVS Response Codes
- A.5 Card Validation Response Codes
- A.6 Advanced Fraud Tools Triggered Rules
- A.7 XML Validation Error Messages
- A.8 Additional Response Header Error Messages
- A.9 ACH Return Reason Codes
- A.10 ACH NoC Change Codes
- A.11 Canadian eCheck Return Codes
- B Credit Card Number Formats
- C Test Card Numbers
- D PayFac™ Dynamic Payout