worldpay ecomm cnpapi reference guide€¦ · worldpay ecomm cnpapi reference guide v2.11 all...

eComm cnpAPI Reference Guide

January 2020

API Release: 11.4

Document Version: V2.11

Worldpay eComm cnpAPI Reference Guide V2.11

All information whether text or graphics, contained in this manual is confidential and proprietary information of Worldpay, LLC and is provided to you solely for the purpose of assisting you in using a Worldpay, LLC product. All such information is protected by copyright laws and international treaties. No part of this manual may be reproduced or transmitted in any form or by any means, electronic, mechanical or otherwise for any purpose without the express written permission of Worldpay, LLC. The possession, viewing, or use of the information contained in this manual does not transfer any intellectual property rights or grant a license to use this information or any software application referred to herein for any purpose other than that for which it was provided. Information in this manual is presented "as is" and neither Worldpay, LLC or any other party assumes responsibility for typographical errors, technical errors, or other inaccuracies contained in this document. This manual is subject to change without notice and does not represent a commitment on the part Worldpay, LLC or any other party. Worldpay, LLC does not warrant that the information contained herein is accurate or complete.

Worldpay, the logo and any associated brand names are trademarks or registered trademarks of Worldpay, LLC and/or its affiliates in the US, UK or other countries. All other trademarks are the property of their respective owners and all parties herein have consented to their trademarks appearing in this manual. Any use by you of the trademarks included herein must have express written permission of the respective owner.

Copyright © 2003-2020, Worldpay, LLC - ALL RIGHTS RESERVED.

CONTENTS

About This Guide

Intended Audience.................................................................................................................... xxiiiRevision History ........................................................................................................................ xxiiiDocument Structure ................................................................................................................. xxviiDocumentation Set .................................................................................................................. xxviiTypographical Conventions ...................................................................................................... xxixContact Information....................................................................................................................xxx

Chapter 1 IntroductionThe cnpAPI Data Format .............................................................................................................. 2

Communications Protocols ..................................................................................................... 2General XML Coding Requirements ....................................................................................... 3Other XML Resources ............................................................................................................ 4

Batch Transaction Processing ...................................................................................................... 5Recommended Session File Size ........................................................................................... 5Multiple Daily Delivery............................................................................................................. 5

Payment Integration Platform (cnpAPI SDKs) .............................................................................. 7Duplicate Transaction Detection ................................................................................................... 8

Batch Duplicate Checking....................................................................................................... 8Batch Dupe Checking for Dynamic Payout Funding Instructions...................................... 9

Online Duplicate Checking...................................................................................................... 9Coding for Report Groups........................................................................................................... 10

Additional/Alternate Methods of Tagging Transactions ....................................................... 11Recovery..................................................................................................................................... 12

Authorization/Sale Recycling ................................................................................................ 12Recycling Engine ........................................................................................................... 12

Account Updater Service ..................................................................................................... 14Match Back ..................................................................................................................... 15Merchant Requirements.................................................................................................. 16Account Updater Features .............................................................................................. 17

Recurring Engine ....................................................................................................................... 18Payment Plans...................................................................................................................... 18Subscriptions ........................................................................................................................ 19

Add Ons and Discounts .................................................................................................. 21Recurring Reports................................................................................................................. 21Transaction Types and Uses ................................................................................................ 22

Issuer Insights............................................................................................................................. 24Issuer Insights Secure Scheduled Report............................................................................. 24

© 2019 Worldpay, LLC and/or its affiliates. All rights reserved.

eComm cnpAPI Reference Guide V2.10 • API Release: 11.4iii

Contents

iv

Real Time Indicators ............................................................................................................. 24Prepaid Indicator ............................................................................................................. 24Affluence Indicator .......................................................................................................... 25Issuer Country Indicator .................................................................................................. 25Cardholder Type Indicator............................................................................................... 26

Extended Network Data ........................................................................................................ 26Insights Analytics Dashboard................................................................................................ 27

Fraud Toolkit .............................................................................................................................. 28Essential Tier ........................................................................................................................ 29

Prepaid Card Filtering .................................................................................................... 29International BIN Filtering ............................................................................................... 29Prior Chargeback Filtering ............................................................................................. 30Security Code No-Match Filter ....................................................................................... 30Card Velocity Filtering .................................................................................................... 30Prior Fraud Advice Filtering ............................................................................................ 31AVS Filter ....................................................................................................................... 31Email Velocity Filter......................................................................................................... 31Phone Velocity Filter ....................................................................................................... 31IP Velocity Filter .............................................................................................................. 32Device Velocity Filter....................................................................................................... 32Application of Filters - Filtering Rules ............................................................................. 32

Extended Tier........................................................................................................................ 33Premium Tier ........................................................................................................................ 34Modifications to Your Web Page........................................................................................... 34

cnpAPI Transactions ....................................................................................................... 34Information Only Option .................................................................................................. 36Fraud Check Transactions ............................................................................................. 36

Tokenization Feature .................................................................................................................. 37How Tokenization Works ...................................................................................................... 38Token Formats...................................................................................................................... 39

High Value Token Data Format Summary ...................................................................... 40Low Value Token Summary ............................................................................................ 42

Obtaining Tokens.................................................................................................................. 43Bulk Token Registration .................................................................................................. 43

Supported Token Transactions............................................................................................. 44Compliance with Visa Best Practices for Tokenization ......................................................... 45

Direct Debit Processing .............................................................................................................. 46Validation Feature................................................................................................................. 46Verification Feature............................................................................................................... 46

Required Contents of Decline Notice .............................................................................. 46Automatic Notice of Change (NoC) Updates ........................................................................ 47Auto Redeposit Feature ........................................................................................................ 48eCheck Prenotification .......................................................................................................... 48


eComm cnpAPI Reference Guide V2.10 • API Release: 11.4

Contents

eCommerce Solution for Apple Pay™ ........................................................................................ 50Overview of Apple Pay Operation......................................................................................... 50Worldpay Decryption of Apple Pay PKPaymentToken ......................................................... 51

Using the Browser JavaScript API for Apple Pay on the Web ........................................ 51Using the Worldpay Mobile API for Apple Pay................................................................ 53Submitting the Apple Pay PKPaymentToken in a cnpAPI Message............................... 54Merchant Decryption of Apple Pay PKPaymentToken.................................................... 55

Recurring Payments with Apple Pay..................................................................................... 56eCommerce Solution for Google Pay™...................................................................................... 57

Branding Requirements ........................................................................................................ 57Google Pay using eProtect ................................................................................................... 57Merchant Decryption Method................................................................................................ 60Recurring Payments with Google Pay .................................................................................. 62

Amazon Pay................................................................................................................................ 64Healthcare Card Feature ............................................................................................................ 66Supported Transaction Types..................................................................................................... 68

Authorization Transaction ..................................................................................................... 68AVS Only Transaction..................................................................................................... 69

Authorization Reversal Transactions .................................................................................... 69Notes on the Use of Authorization Reversal Transactions.............................................. 70Using Authorization Reversal to Halt Recycling Engine.................................................. 70

Activate Transaction ............................................................................................................. 71Activate Reversal Transaction (Online Only) ........................................................................ 71Balance Inquiry Transaction ................................................................................................. 71Cancel Subscription Transaction .......................................................................................... 71Capture Transaction ............................................................................................................. 71Capture Given Auth Transaction........................................................................................... 72Create Plan Transaction ....................................................................................................... 72Credit Transaction................................................................................................................. 72Deactivate Transaction ......................................................................................................... 73Deactivate Reversal Transaction (Online Only) .................................................................... 73Deposit Reversal Transaction (Online Only)......................................................................... 73eCheck Credit Transaction ................................................................................................... 73eCheck Prenotification Credit Transaction............................................................................ 73eCheck Prenotification Sale Transaction .............................................................................. 73eCheck Redeposit Transaction............................................................................................. 74eCheck Sales Transaction .................................................................................................... 74eCheck Verification Transaction ........................................................................................... 74eCheck Void Transaction (Online Only)................................................................................ 74Force Capture Transaction ................................................................................................... 74Gift Card Auth Reversal ........................................................................................................ 74Gift Card Capture.................................................................................................................. 75Gift Card Credit ..................................................................................................................... 75


eComm cnpAPI Reference Guide V2.10 • API Release: 11.4v

Contents

vi

Load Transaction .................................................................................................................. 75Load Reversal Transaction (Online Only) ............................................................................. 75Refund Reversal Transaction (Online Only) ......................................................................... 75Register Token Transaction.................................................................................................. 75Sale Transaction ................................................................................................................... 75Status Query Transaction .................................................................................................... 76Unload Transaction............................................................................................................... 76Unload Reversal Transaction (Online Only) ......................................................................... 76Update Card Validation Number Transaction ....................................................................... 76Update Plan Transaction ...................................................................................................... 77Update Subscription Transaction.......................................................................................... 77Void Transaction (Online Only)............................................................................................. 77

Using Void to Halt Recycling Engine............................................................................... 77Instruction-Based Dynamic Payout Transactions ................................................................ 78

Chapter 2 Testing Your cnpAPI TransactionsCertification and Testing Environments ...................................................................................... 80

Sandbox Environment........................................................................................................... 80Pre-Live Environment ........................................................................................................... 80

Pre-Live Environment Limitations and Maintenance Schedules ..................................... 80Overview of Testing .................................................................................................................... 82

Planning for Certification Testing .......................................................................................... 82Required Certification Testing............................................................................................... 83Optional Testing.................................................................................................................... 83System Doctor ...................................................................................................................... 83

Transferring Files ........................................................................................................................ 86Transferring Session Files .................................................................................................... 86

Submitting a Session File for Processing........................................................................ 86Retrieving Processed Session Files................................................................................ 86

Transferring Online Files....................................................................................................... 87ASP Programming Example ........................................................................................... 88Java Programming Example ........................................................................................... 89Notes on Timeout Settings.............................................................................................. 89Notes on Persistent Connections.................................................................................... 90Helpful Web Sites............................................................................................................ 90

Performing the Required Certification Tests ............................................................................... 91Testing Authorization (including Indicators), AVS Only, Capture, Credit, Sale, and Void Transactions ......................................................................................................................... 91Testing Authorization Reversal Transactions ..................................................................... 104Testing Direct Debit Transactions....................................................................................... 108Testing Token Transactions................................................................................................ 115Testing Query Transactions................................................................................................ 119Testing Stored Credentials Processing............................................................................... 120



Contents

Testing Online Duplicate Transaction Processing .............................................................. 123Testing Refund Authorization.............................................................................................. 124

Performing the Optional Tests .................................................................................................. 125Testing AVS and Card Validation ....................................................................................... 126Testing Address Responses ............................................................................................... 127Testing Advanced AVS Response Codes .......................................................................... 128Testing Response Reason Codes and Messages.............................................................. 129Testing 3DS Responses ..................................................................................................... 133Testing the Prepaid Filtering Feature.................................................................................. 135Testing the International Card Filter Feature ...................................................................... 136Testing Security Code No-Match Filtering .......................................................................... 137Testing Advanced Fraud Tools ........................................................................................... 139Testing Account Updater .................................................................................................... 141

Testing Account Updater Extended Response Codes.................................................. 142Testing Account Updater for Tokenized Merchants ...................................................... 142

Testing Tax Billing............................................................................................................... 142Testing Convenience Fees ................................................................................................. 143Testing the Recycling Engine ............................................................................................. 145

Testing Recycling Engine Cancellation......................................................................... 153Testing Recurring Engine Transactions.............................................................................. 155Testing Gift Card Transactions ........................................................................................... 166Testing MasterPass Transactions....................................................................................... 175Testing Apple Pay Transaction Processing ........................................................................ 176

Testing the Submission of the Decrypted PKPaymentToken in cnpAPI ....................... 176Testing the Submission of PKPaymentToken in cnpAPI .............................................. 177

Testing Google Pay Transaction Processing...................................................................... 178Testing Google Pay using eProtect............................................................................... 178

Testing Amazon Pay........................................................................................................... 179Testing checkoutId.............................................................................................................. 182Testing Transaction Volume Capacity ................................................................................ 183

Chapter 3 cnpAPI Transaction ExamplesOverview of Online and Batch Processing Formats ................................................................. 186

Batch Process Format ........................................................................................................ 186Supported Communication Protocols............................................................................ 187Batch Processing Request Format ............................................................................... 187Batch Processing Response Format............................................................................. 187

Online Processing Format ........................................................................................................ 188Supported Communication Protocols ................................................................................. 189Online Processing Request Format .................................................................................... 189Online Processing Response Format ................................................................................. 189

Transaction Types and Examples............................................................................................. 190Authorization Transactions ................................................................................................. 192


eComm cnpAPI Reference Guide V2.10 • API Release: 11.4vii

Contents

viii

Authorization Request Structure ................................................................................... 192Authorization Response Structure ................................................................................ 199

Authorization Reversal Transactions .................................................................................. 204Authorization Reversal Requests.................................................................................. 204Authorization Reversal Responses ............................................................................... 205

Activate Transactions.......................................................................................................... 206Activate Request ........................................................................................................... 206Activate Response ........................................................................................................ 208

Activate Reversal Transactions (Online Only) .................................................................... 209Activate Reversal Request............................................................................................ 209Activate Reversal Response ......................................................................................... 210

Balance Inquiry Transactions.............................................................................................. 211Balance Inquiry Request ............................................................................................... 211Balance Inquiry Response ............................................................................................ 212

Cancel Subscription Transactions ...................................................................................... 213Cancel Subscription Request........................................................................................ 213Cancel Subscription Response ..................................................................................... 213

Capture Transactions.......................................................................................................... 214Capture Request ........................................................................................................... 214Capture Response ........................................................................................................ 221

Capture Given Auth Transactions....................................................................................... 222Capture Given Auth Request ........................................................................................ 222Capture Given Auth Response ..................................................................................... 226

Create Plan Transactions ................................................................................................... 228Create Plan Request..................................................................................................... 228Create Plan Response .................................................................................................. 229

Credit Transactions............................................................................................................. 229Credit Request for a Worldpay Processed Transaction ................................................ 230Credit Request for a Non-Worldpay Processed Transaction ........................................ 233Credit Response ........................................................................................................... 237

Deactivate Transactions ..................................................................................................... 239Deactivate Request....................................................................................................... 239Deactivate Response .................................................................................................... 240

Deactivate Reversal Transactions (Online Only) ................................................................ 240Deactivate Reversal Request........................................................................................ 241Deactivate Reversal Response..................................................................................... 242

Deposit Reversal Transactions (Online Only) ..................................................................... 242Deposit Reversal Request ............................................................................................ 243Deposit Reversal Response.......................................................................................... 244

eCheck Credit Transactions................................................................................................ 244eCheck Credit Request Against a Worldpay Transaction ............................................. 245eCheck Credit Request for a Non-Worldpay Processed Sale....................................... 246eCheck Credit Response .............................................................................................. 247



Contents

eCheck Prenotification Credit Transactions (Batch Only) ................................................... 247eCheck Prenotification Credit Request ......................................................................... 248eCheck Prenotification Credit Response ...................................................................... 249

eCheck Prenotification Sale Transactions (Batch Only) ..................................................... 250eCheck Prenotification Sale Request............................................................................ 250eCheck Prenotification Sale Response......................................................................... 251

eCheck Redeposit Transactions ......................................................................................... 252eCheck Redeposit Request .......................................................................................... 252eCheck Redeposit Response........................................................................................ 254

eCheck Sale Transactions .................................................................................................. 255eCheck Sale Request ................................................................................................... 255eCheck Sale Response................................................................................................. 256

eCheck Verification Transactions ....................................................................................... 258eCheck Verification Request......................................................................................... 258eCheck Verification Response ...................................................................................... 260

eCheck Void Transactions (Online Only) ............................................................................ 262eCheck Void Request ................................................................................................... 262eCheck Void Response................................................................................................. 262

Force Capture Transactions ............................................................................................... 263Force Capture Request................................................................................................. 263Force Capture Response .............................................................................................. 266

Fraud Check Transaction.................................................................................................... 268Fraud Check Request ................................................................................................... 268Fraud Check Response ................................................................................................ 269

Gift Card Auth Reversal Transactions ................................................................................ 270Gift Card Auth Reversal Request.................................................................................. 270Gift Card Auth Reversal Response ............................................................................... 271

Gift Card Capture Transactions .......................................................................................... 272Gift Card Capture Request............................................................................................ 272Gift Card Capture Response......................................................................................... 273

Gift Card Credit Transactions ............................................................................................. 273Gift Card Credit Request............................................................................................... 274Gift Card Credit Response ............................................................................................ 275

Load Transactions .............................................................................................................. 276Load Request................................................................................................................ 276Load Response............................................................................................................. 277

Load Reversal Transactions (Online Only) ......................................................................... 278Load Reversal Request................................................................................................. 278Load Reversal Response.............................................................................................. 279

Status Query Transactions (Online Only) .......................................................................... 280Query Transaction Request .......................................................................................... 280Query Transaction Response ....................................................................................... 280

Refund Reversal Transactions (Online Only) ..................................................................... 283


eComm cnpAPI Reference Guide V2.10 • API Release: 11.4ix

Contents

x

Refund Reversal Request ............................................................................................. 284Refund Reversal Response .......................................................................................... 285

Register Token Transactions .............................................................................................. 286Register Token Request ............................................................................................... 286Register Token Response............................................................................................. 289

RFR Transactions (Batch Only) .......................................................................................... 291RFR Request ................................................................................................................ 291RFR Response.............................................................................................................. 292

Sale Transactions ............................................................................................................... 292Sale Request................................................................................................................. 292Sale Response.............................................................................................................. 295

Unload Transactions ........................................................................................................... 300Unload Request ............................................................................................................ 300Unload Response.......................................................................................................... 301

Unload Reversal Transactions (Online Only)...................................................................... 301Unload Reversal Request ............................................................................................. 302Unload Reversal Response .......................................................................................... 303

Update Plan Transactions................................................................................................... 303Update Plan Request .................................................................................................... 304Update Plan Response ................................................................................................. 304

Update Subscription Transactions ...................................................................................... 305kUpdate Subscription Request...................................................................................... 305Update Subscription Response..................................................................................... 306

Update Card Validation Number Transactions ................................................................... 307Update Card Validation Number Request..................................................................... 307Update Card Validation Number Response .................................................................. 308

Void Transactions (Online Only) ......................................................................................... 308Void Request................................................................................................................. 309Void Response.............................................................................................................. 310

Chapter 4 cnpAPI ElementsaccNum .................................................................................................................................... 312accountInfo .............................................................................................................................. 313accountInformation .................................................................................................................. 314accountNumber ........................................................................................................................ 315accountNumberLength ............................................................................................................. 316accountUpdate ......................................................................................................................... 317accountUpdateFileRequestData .............................................................................................. 318accountUpdater ........................................................................................................................ 319accountUpdateResponse ......................................................................................................... 323accType .................................................................................................................................... 324actionReason ........................................................................................................................... 325activate ..................................................................................................................................... 326



Contents

activateResponse .................................................................................................................... 327activateReversal ...................................................................................................................... 328activateReversalResponse ...................................................................................................... 329active ........................................................................................................................................ 330addOnCode .............................................................................................................................. 331addressIndicator ....................................................................................................................... 332addressLine1, addressLine2, addressLine3 ............................................................................. 333advancedAVSResult ................................................................................................................. 334advancedFraudChecks ............................................................................................................ 335advancedFraudResults ............................................................................................................ 336affiliate....................................................................................................................................... 337affluence ................................................................................................................................... 338allowPartialAuth ........................................................................................................................ 339amexAggregatorData................................................................................................................ 340amount ...................................................................................................................................... 341androidpayResponse ............................................................................................................... 342applepay ................................................................................................................................... 343applepayResponse ................................................................................................................... 344applicationData ......................................................................................................................... 345applicationExpirationDate ......................................................................................................... 346applicationPrimaryAccountNumber........................................................................................... 347approvedAmount....................................................................................................................... 348authAmount............................................................................................................................... 349authCode .................................................................................................................................. 350authDate ................................................................................................................................... 351authenticatedByMerchant ......................................................................................................... 352authentication............................................................................................................................ 353authenticationResult ................................................................................................................. 354authenticationTransactionId...................................................................................................... 355authenticationValue .................................................................................................................. 356authInformation ......................................................................................................................... 357authorization ............................................................................................................................. 358authorizationResponse ............................................................................................................. 359authorizationSourcePlatform..................................................................................................... 360authReversal............................................................................................................................. 361authReversalResponse............................................................................................................. 362availableBalance....................................................................................................................... 363avsResult .................................................................................................................................. 364balanceInquiry .......................................................................................................................... 365balanceInquiryResponse ......................................................................................................... 366batchRequest............................................................................................................................ 367batchResponse......................................................................................................................... 375beginningBalance .................................................................................................................... 376


eComm cnpAPI Reference Guide V2.10 • API Release: 11.4xi

Contents

xii

billingDate ................................................................................................................................ 377billMeLaterRequest ................................................................................................................... 378billMeLaterResponseData......................................................................................................... 380billToAddress ............................................................................................................................ 381bin ............................................................................................................................................. 383bmlMerchantId .......................................................................................................................... 384bmlProductType........................................................................................................................ 385bypassVelocityCheck................................................................................................................ 386campaign .................................................................................................................................. 387cancelSubscription ................................................................................................................... 388cancelSubscriptionResponse ................................................................................................... 389capability ................................................................................................................................... 390capture ...................................................................................................................................... 391captureAmount.......................................................................................................................... 392captureGivenAuth ..................................................................................................................... 393captureGivenAuthResponse..................................................................................................... 394captureResponse...................................................................................................................... 395card ........................................................................................................................................... 396cardAcceptorTaxId.................................................................................................................... 398cardholderAuthentication .......................................................................................................... 399cardholderId .............................................................................................................................. 400cardholderName ....................................................................................................................... 401cardOrToken ............................................................................................................................. 402cardProductType....................................................................................................................... 403cardSuffix ................................................................................................................................. 404cardValidationNum.................................................................................................................... 405cardValidationResult ................................................................................................................. 406cashBackAmount ..................................................................................................................... 407catLevel .................................................................................................................................... 408ccdPaymentInformation ........................................................................................................... 409chargeback ............................................................................................................................... 410checkNum ................................................................................................................................ 411checkoutId ................................................................................................................................ 412city............................................................................................................................................. 413clinicOtherAmount..................................................................................................................... 414code .......................................................................................................................................... 415commodityCode........................................................................................................................ 416companyName.......................................................................................................................... 417country ...................................................................................................................................... 418createAddOn ............................................................................................................................ 419createDiscount ......................................................................................................................... 420createPlan ................................................................................................................................ 421createPlanResponse ................................................................................................................ 422



Contents

credit ......................................................................................................................................... 423creditAmount............................................................................................................................. 424creditLine .................................................................................................................................. 425creditLitleTxnId ......................................................................................................................... 426creditResponse......................................................................................................................... 427cryptogram ............................................................................................................................... 428currencyCode ........................................................................................................................... 429customAttribute1 ...................................................................................................................... 430customBilling............................................................................................................................. 431customIdentifier ........................................................................................................................ 433customerInfo ............................................................................................................................. 434customerIpAddress ................................................................................................................... 435customerReference................................................................................................................... 436customerRegistrationDate ........................................................................................................ 437customerType ........................................................................................................................... 438customerWorkTelephone.......................................................................................................... 439data ........................................................................................................................................... 440deactivate ................................................................................................................................. 441deactivateResponse ................................................................................................................ 442deactivateReversal .................................................................................................................. 443deactivateReversalResponse .................................................................................................. 444debtRepayment......................................................................................................................... 445deleteAddOn ............................................................................................................................ 446deleteDiscount ......................................................................................................................... 447deliveryType.............................................................................................................................. 448dentalAmount............................................................................................................................ 449depositReversal ....................................................................................................................... 450depositReversalResponse ....................................................................................................... 451description ................................................................................................................................ 452descriptor .................................................................................................................................. 453destinationCountryCode ........................................................................................................... 454destinationPostalCode.............................................................................................................. 455detailTax ................................................................................................................................... 456deviceManufacturerIdentifier..................................................................................................... 457deviceReputationScore ............................................................................................................ 458deviceReviewStatus.................................................................................................................. 459discountAmount ........................................................................................................................ 460discountCode ........................................................................................................................... 461dob............................................................................................................................................ 462dutyAmount............................................................................................................................... 463echeck....................................................................................................................................... 464eCheckAccountSuffix ............................................................................................................... 465echeckCredit ............................................................................................................................. 466


eComm cnpAPI Reference Guide V2.10 • API Release: 11.4xiii

Contents

xiv

echeckCreditResponse............................................................................................................. 467echeckForToken ....................................................................................................................... 468echeckOrEcheckToken............................................................................................................. 469echeckPreNoteCredit ............................................................................................................... 470echeckPreNoteCreditResponse ............................................................................................... 471echeckPreNoteSale ................................................................................................................. 472echeckPreNoteSaleResponse ................................................................................................. 473echeckRedeposit ...................................................................................................................... 474echeckRedepositResponse ...................................................................................................... 475echeckSale ............................................................................................................................... 476echeckSalesResponse ............................................................................................................. 477echeckToken............................................................................................................................. 478echeckVerification..................................................................................................................... 479echeckVerificationResponse..................................................................................................... 480echeckVoid ............................................................................................................................... 481echeckVoidResponse ............................................................................................................... 482eciIndicator................................................................................................................................ 483email ......................................................................................................................................... 484employerName.......................................................................................................................... 485encryptedTrack ........................................................................................................................ 486endDate ................................................................................................................................... 487endingBalance ......................................................................................................................... 488endpoint ................................................................................................................................... 489enhancedAuthResponse........................................................................................................... 490enhancedData........................................................................................................................... 492entryMode................................................................................................................................. 496ephemeralPublicKey ................................................................................................................. 497expDate..................................................................................................................................... 498expMonth ................................................................................................................................. 499expYear .................................................................................................................................... 500extendedCardResponse .......................................................................................................... 501fastAccessFunding ................................................................................................................... 502fastAccessFundingResponse .................................................................................................. 503fieldValue ................................................................................................................................. 504filtering ...................................................................................................................................... 505finalPayment ............................................................................................................................ 506firstName................................................................................................................................... 507forceCapture ............................................................................................................................. 508forceCaptureResponse............................................................................................................. 509formatId .................................................................................................................................... 510fraudCheck ............................................................................................................................... 511fraudCheckResponse .............................................................................................................. 512fraudFilterOverride ................................................................................................................... 513



Contents

fraudResult ............................................................................................................................... 514fundingInstructionVoid ............................................................................................................. 515fundingInstructionVoidResponse ............................................................................................. 516fundingSource........................................................................................................................... 517fundingSubmerchantId ............................................................................................................. 518fundsTransferId......................................................................................................................... 519giftCardAuthReversal................................................................................................................ 520giftCardAuthReversalResponse................................................................................................ 521giftCardBin ............................................................................................................................... 522giftCardCapture......................................................................................................................... 523giftCardCaptureResponse ........................................................................................................ 524giftCardCredit............................................................................................................................ 525giftCardCreditResponse............................................................................................................ 526giftCardResponse .................................................................................................................... 527giropay ...................................................................................................................................... 528giropayResponse...................................................................................................................... 529header ...................................................................................................................................... 530healthcareAmounts ................................................................................................................... 531healthcareIIAS .......................................................................................................................... 532iban .......................................................................................................................................... 533ideal .......................................................................................................................................... 534idealResponse .......................................................................................................................... 535IIASFlag .................................................................................................................................... 536incomeAmount .......................................................................................................................... 537incomeCurrency........................................................................................................................ 538international .............................................................................................................................. 540intervalType ............................................................................................................................. 541invoiceReferenceNumber ......................................................................................................... 542issuerCountry............................................................................................................................ 543itemCategoryCode .................................................................................................................... 544itemDescription ......................................................................................................................... 545itemDiscountAmount................................................................................................................. 546itemSequenceNumber .............................................................................................................. 547ksn ............................................................................................................................................ 548lastName................................................................................................................................... 549lineItemData.............................................................................................................................. 550lineItemTotal ............................................................................................................................. 552lineItemTotalWithTax ................................................................................................................ 553litleInternalRecurringRequest ................................................................................................... 554litleOnlineRequest..................................................................................................................... 555litleOnlineResponse ................................................................................................................. 556litleRequest ............................................................................................................................... 558litleResponse ............................................................................................................................ 559


eComm cnpAPI Reference Guide V2.10 • API Release: 11.4xv

Contents

xvi

litleSessionId............................................................................................................................. 561litleToken................................................................................................................................... 562litleTxnId.................................................................................................................................... 563load .......................................................................................................................................... 564loadResponse .......................................................................................................................... 565loadReversal ............................................................................................................................ 566loadReversalResponse ............................................................................................................ 567mandateProvider ...................................................................................................................... 568mandateReference .................................................................................................................. 569mandateSignatureDate ............................................................................................................ 570mandateURL ............................................................................................................................ 571matchCount............................................................................................................................... 572merchantData ........................................................................................................................... 573merchantGroupingId ................................................................................................................. 574merchantId ................................................................................................................................ 575message ................................................................................................................................... 576middleInitial ............................................................................................................................... 577mpos ......................................................................................................................................... 578name......................................................................................................................................... 579networkField ............................................................................................................................. 580networkResponse .................................................................................................................... 582networkSubField ...................................................................................................................... 583networkTransactionId ............................................................................................................... 584newAccountInfo ........................................................................................................................ 585newCardInfo ............................................................................................................................. 586newCardTokenInfo ................................................................................................................... 587newTokenInfo ........................................................................................................................... 588nextRecycleTime ..................................................................................................................... 589number...................................................................................................................................... 590numberOfPayments ................................................................................................................. 591onlinePaymentCryptogram ....................................................................................................... 592orderDate .................................................................................................................................. 593orderId....................................................................................................................................... 594orderSource .............................................................................................................................. 595originalAccountInfo ................................................................................................................... 597origAccountNumber ................................................................................................................. 598origActionType ......................................................................................................................... 599origId ........................................................................................................................................ 601originalAmount .......................................................................................................................... 602originalCard............................................................................................................................... 603originalCardInfo ........................................................................................................................ 604originalCardTokenInfo .............................................................................................................. 605originalNetworkTransactionId .................................................................................................. 606



Contents

originalRefCode ........................................................................................................................ 607originalSequenceNumber ......................................................................................................... 608originalSystemTraceId .............................................................................................................. 609originalToken ........................................................................................................................... 610originalTokenInfo ..................................................................................................................... 611originalTransactionAmount ...................................................................................................... 612originalTxnTime ........................................................................................................................ 613origLitleTxnId ........................................................................................................................... 614origOrderId ............................................................................................................................... 615password .................................................................................................................................. 616payerId ..................................................................................................................................... 617payFacCredit ............................................................................................................................ 618payFacCreditResponse ........................................................................................................... 619payFacDebit ............................................................................................................................. 620payFacDebitResponse ............................................................................................................. 621paymentDataType .................................................................................................................... 622paymentPurpose....................................................................................................................... 623paypage .................................................................................................................................... 624paypageRegistrationId .............................................................................................................. 625paypal ....................................................................................................................................... 626payPalNotes ............................................................................................................................. 627payPalOrderComplete .............................................................................................................. 628phone........................................................................................................................................ 629

phone as a child of billToAddress and shipToAddress ....................................................... 629phone as a child of customBilling........................................................................................ 629

physicalCheckCredit ................................................................................................................ 630physicalCheckCreditResponse ................................................................................................ 631physicalCheckDebit .................................................................................................................. 632physicalCheckDebitResponse ................................................................................................. 633pin ............................................................................................................................................ 634planCode .................................................................................................................................. 635pos ............................................................................................................................................ 636postDate.................................................................................................................................... 637postDay .................................................................................................................................... 638preapprovalNumber .................................................................................................................. 639preferredLanguage .................................................................................................................. 640prepaid ...................................................................................................................................... 641prepaidCardType ...................................................................................................................... 642processingInstructions .............................................................................................................. 643processingType ........................................................................................................................ 644productCode ............................................................................................................................. 645publicKeyHash ......................................................................................................................... 646quantity ..................................................................................................................................... 647


eComm cnpAPI Reference Guide V2.10 • API Release: 11.4xvi

Contents

xvii

queryTransaction ..................................................................................................................... 648queryTransactionResponse ..................................................................................................... 649queryTransactionUnavailableResponse .................................................................................. 650recurringRequest ..................................................................................................................... 651recurringResponse ................................................................................................................... 652recurringTxnId .......................................................................................................................... 653recycleAdvice............................................................................................................................ 654recycleAdviceEnd .................................................................................................................... 655recycleBy .................................................................................................................................. 656recycleEngineActive ................................................................................................................. 657recycleId ................................................................................................................................... 658recycling ................................................................................................................................... 659

recycling Element as a Child of authorizationResponse or saleResponse......................... 659recycling Element as a Child of voidResponse..............................

worldpay ecomm cnpapi reference guide€¦ · worldpay ecomm cnpapi reference guide v2.11 all...

Documents