Developer's Guide

Manuals Brands PayPal Manuals Software PayPal Gateway - 2012

Table Of Contents

Gateway Developer

Guide and Reference

PayPal Payments Advanced

PayPal Payments Pro

Payflow Pro

Payflow Link

Last updated: 31 July 2012

Gateway Developer Guide and Reference

Summary of content (230 pages)

PAGE 1

Gateway Developer Guide and Reference PayPal Payments Advanced PayPal Payments Pro Payflow Pro Payflow Link Last updated: 31 July 2012 Gateway Developer Guide and Reference
PAGE 2

Document Number: 200045.en_US-20120731 © 2012 PayPal, Inc. All rights reserved. PayPal is a registered trademark of PayPal, Inc. The PayPal logo is a trademark of PayPal, Inc. Other trademarks and brands are the property of their respective owners. The information in this document belongs to PayPal, Inc. It may not be used, reproduced or disclosed without the written approval of PayPal, Inc. Copyright © PayPal. All rights reserved. PayPal (Europe) S.à r.l. et Cie., S.C.A.
PAGE 3

Content Chapter P Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Who Should Use This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Revision History . . . . . . . . . . . . . . . .
PAGE 4

Content Using a Secure Token and Dynamically Passing Form Post Variables . . . . . . . . . . . 36 Silent Posts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Force Silent Post Confirmation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Data Returned by the Silent Post Features . . . . . . . . . . . . . . . . . . . . . . . 39 Chapter 4 Payflow SDK . . . . . . . . . . . . . . . . . . . . . . . . . 41 Preparing the Payflow Gateway Client Application . . .
PAGE 5

Content Submitting Balance Inquiry Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . 56 Processing Platforms Supporting Balance Inquiry Transactions . . . . . . . . . . . . 56 Required Balance Inquiry Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 56 Example Balance Inquiry Transaction String . . . . . . . . . . . . . . . . . . . . . . 57 Submitting Card Present (SWIPE) Transactions. . . . . . . . . . . . . . . . . . . . . . .
PAGE 6

Content When To Use a Void Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Required Void Transaction Parameters . . . . . . . . . . . . . . . . . . . . . . . . . 73 Fields Copied From the Original Transaction Into the Void Transaction. . . . . . . . . 73 Example Void Transaction Parameter String . . . . . . . . . . . . . . . . . . . . . . 74 Using Address Verification Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 7

Content Transaction Advice Detail Parameters. . . . . . . . . . . . . . . . . . . . . . . . . .107 Airline Passenger Data Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . .107 American Express Other Parameters . . . . . . . . . . . . . . . . . . . . . . . . . .108 Elavon Additional Credit Card Parameters. . . . . . . . . . . . . . . . . . . . . . . . . .109 First Data Merchant Services Nashville, Additional Credit Card Parameters . . . . . . . .
PAGE 8

Content Preparing for TeleCheck Production Transactions . . . . . . . . . . . . . . . . . . . . . .136 Responses to TeleCheck Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . .136 Transaction Responses Common to All Tender Types . . . . . . . . . . . . . . . . .136 Response Code Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137 Sale Response Code Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137 Adjustment Code Values. . . . . . . . . . . .
PAGE 9

Content Example FDMS South Purchasing Card Level 2 and 3 Parameter String . . . . . . . .158 Example FDMS South Line Item Parameter String . . . . . . . . . . . . . . . . . . .158 Global Payments - Central Purchasing Card Transaction Processing . . . . . . . . . . . .159 Global Payments - Central Level 2 Parameters . . . . . . . . . . . . . . . . . . . . .159 Global Payments - East Purchasing Card Transaction Processing . . . . . . . . . . . . .159 Global Payments - East Level 2 Parameters . . . . . . . .
PAGE 10

Content Chapter D VERBOSITY: Viewing Processor-Specific Transaction Results 199 Chapter E ISO Country Codes . . . . . . . . . . . . . . . . . . . . 201 Chapter F Codes Used by FDMS South Only . . . . . . . . . . . . . 203 MasterCard Country Codes for FDMS South Only . . . . . . . . . . . . . . . . . . . . .203 Visa Country Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .210 Units of Measure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 11

P Preface This guide describes the data parameters for the Gateway payments solutions. Scope This guide is a reference to the payment card data parameters available for submitting in transaction requests over the Gateway to multiple supported processors. It also covers the resulting response data parameters and errors. The guide describes the requirements of an ever growing list of processing platforms.
PAGE 12

P Preface Intended Audience Who Should Use This Document This comprehensive developer guide includes integration information for multiple Gateway solutions. Legacy Payflow Link features are not included in this guide. For legacy Payflow Link features refer to the Payflow Link User’s Guide. Additionally, all the Gateway features explained in this guide are not necessarily available to every Gateway customer.
PAGE 13

Preface Intended Audience P New Payflow Link users who are using the Secure Token or the API should use this guide. However, new Payflow Link users who are using the legacy Payflow Link input tag integration should use the Payflow Link User’s Guide instead. Limited API Access means you can perform all API functions except for Sales and Authorization transactions. For Sales and Authorization type transactions you must use the Hosted Checkout Pages.
PAGE 14

P Preface Intended Audience  PayPal Payments Advanced Transactions submitted by PayPal Payments Advanced customers are processed through the Gateway with PayPal acting as the merchant bank. PayPal Payments Advanced users will see the following in the Service Summary box in PayPal Manager: PayPal Payments Advanced with Hosted Checkout Pages & Payflow SDK/API (Limited Access) Limited API Access means you can perform all API functions except for Sales and Authorization transactions.
PAGE 15

Preface Revision History P Revision History Revision History for the Gateway Developer Guide and Reference: Date Description 31 July 2012 Added a list of Setup Params and Customize Params. These parameters override PayPal Manager settings for Hosted Pages. Briefly explained the differences between Submitting Credit Transactions and Submitting Void Transactions. Updated the parameters in the Payflow Link legacy parameters and the equivalent Payflow parameters table.
PAGE 16

P Preface Revision History Date Description May 2012 (cont.) Document maintenance: Added cross-references and external links; reorganized content; removed no longer applicable content. April 2012 Added new transaction type: Balance Inquiry(TRXTYPE=B) can be used to obtain the balance of a pre-paid card.
PAGE 17

Preface Revision History Date Description January 2012 (cont.
PAGE 18

P 18 Preface Revision History Date Description January 2012 (cont.) Added concepts: Gateway Product Solutions - PayPal Payments Advanced, PayPal Payments Pro, Payflow Pro, Payflow Link Transaction Flow Transparent Redirect February 2011 First publication.
PAGE 19

1 Introducing the Gateway Checkout Solutions The Gateway provides checkout solutions for novice and advanced use. It provides merchants with a rich set of options to handle payment transactions.
PAGE 20

1 Introducing the Gateway Checkout Solutions About the Gateway Checkout Solutions token, the merchant adheres to compliance rules for handling customer data in a secure way: data is stored on PayPal so that it is not exposed to compromise.  Like PayPal Payments Advanced, PayPal Payments Pro sends transactions to the PayPal processor and PayPal is the acquiring bank. Using hosted checkout pages is an option.
PAGE 21

Introducing the Gateway Checkout Solutions About the Gateway Transaction Flow Feature PayPal Payments Advanced Payflow Link PayPal Payments Pro Payflow Pro Reference transactions (Tokenization) Yes Yes Secure token to preset hosted checkout page Yes Yes Reporting APIs Yes Yes Desktop integration Yes Yes Recurring billing Yes Yes Basic fraud protection Yes Yes Advanced fraud protection Yes Yes Partner/channel distribution support (Partner Manager, registration, XML registration) resa
PAGE 22

1 Introducing the Gateway Checkout Solutions About Security You can use the core transaction parameters supported by all Gateway processors described in this dcumentation to send transaction data to your processor. In addition:   Each Gateway processor may support various additional parameters beyond the core set that you can send in transaction requests. Your processor may also support purchasing cards (credit cards employers issue for business-related charges).
PAGE 23

Introducing the Gateway Checkout Solutions About Security 1 Secure Token The secure token stores request transaction data on the Gateway server. It eliminates the need to resend the parameter data for display in a hosted checkout page where the data might be subject to compromise. Hosted Checkout Pages The Gateway enables the use of hosted checkout pages, which help you achieve PCI compliance.
PAGE 24

1 Introducing the Gateway Checkout Solutions Processing Platforms Supporting Card-Present Transactions 6. The Gateway processes the payment through the payment processing network. 7. The Gateway server transparently returns the customer to the location on your website that you specified in the request to obtain a secure token. You display the results to the customer on your website.
PAGE 25

Introducing the Gateway Checkout Solutions Supported Payment Types 1 American Express American Express APAC Elavon Fifth Third Processing Solutions First Data Merchant Services (FDMS) Nashville First Data Merchant Services (FDMS) North First Data Merchant Services (FDMS) South Global Payments Central Global Payments East Heartland Payment Systems Litle Merchant e-Solutions Moneris Solutions Paymentech Salem Paymentech Tampa PayPal SecureNet TeleCheck TSYS Acquiring Solutions WorldPay Supported Payment Ty
PAGE 26

1 Introducing the Gateway Checkout Solutions Recurring Billing Service Automated Clearing House (ACH). For information on performing ACH transactions, contact your PayPal Sales Representative. Recurring Billing Service The Recurring Billing Service is a scheduled payment solution that enables you to automatically bill your customers at regular intervals—for example, you can bill your customers a monthly fee of $42 for 36 months with an initial fee of $129.
PAGE 27

2 Secure Token This section describes the secure token.  “Secure Token” on page 27  “Integrating the Secure Token With the Hosted Checkout Pages” on page 27   “Integrating the Secure Token Without the Hosted Checkout Pages: Transparent Redirect” on page 28 “Posting To the Hosted Checkout Page” on page 29 About the Secure Token Use a secure token to send non-credit card transaction data to the Gateway server for safer storage.
PAGE 28

2 Secure Token Integrating the Secure Token Without the Hosted Checkout Pages: Transparent Redirect NOT E : The secure token is valid for 30 minutes, and you can only use it one time. If you attempt to use the token after the time limit has expired, your transaction will fail with Result value 7, “Secure Token Expired.” If you attempt to reuse the token, you receive an error. 1. Set SECURETOKENID to a unique alphanumeric value up to 36 characters in length.
PAGE 29

Secure Token Posting To the Hosted Checkout Page 2 2. Set CREATESECURETOKEN to the value Y to request that the Gateway server return a token. CREATESECURETOKEN=Y 3. Set SILENTTRAN to the value TRUE to suppress the display of hosted pages. SILENTTRAN=TRUE Transparent Redirect Example The following is an example of an authorization parameter string that suppresses hosted pages. TRXTYPE=A&BILLTOSTREET=123 Main St.&BILLTOZIP=95131&AMT=24.
PAGE 30

2 Secure Token Posting To the Hosted Checkout Page PageTitle
PAGE 31
3 Configuring Hosted Checkout Pages This chapter describes the following:  “Configuring Hosted Checkout Pages” on page 31  “Configuring Hosted Pages Using PayPal Manager” on page 31  “Using a Secure Token and Dynamically Passing Form Post Variables” on page 36  “Silent Posts” on page 38 Configuring Hosted Checkout Pages PayPal enables you to customize the hosted checkout pages so that they reflect the look and feel of your website.
PAGE 32

3 32 Configuring Hosted Checkout Pages Configuring Hosted Pages Using PayPal Manager 31 July 2012 Gateway Developer Guide and Reference
PAGE 33

Configuring Hosted Checkout Pages Configuring Hosted Pages Using PayPal Manager 3 You can perform tasks such as:       Configure your PayPal Express Checkout display and specify email addresses for live and test transactions. Determine the URL and text of the link the buyer clicks on to cancel the payment on your website. Select the billing and shipping information fields the buyer will be required to complete during checkout.
PAGE 34

3 Configuring Hosted Checkout Pages Configuring Hosted Pages Using PayPal Manager Customize 34 31 July 2012 Gateway Developer Guide and Reference
PAGE 35

Configuring Hosted Checkout Pages Configuring Hosted Pages Using PayPal Manager 3 The Customize page allows you to customize your hosted checkout page. You can customize the header, background, title, button, and the order summary column of your payment page. PayPal offers three design layouts for you to choose. Layout A is the default layout but you can choose from any of the three layouts offered. Preview the design of your hosted checkout page.
PAGE 36

3 Configuring Hosted Checkout Pages Using a Secure Token and Dynamically Passing Form Post Variables – Title bar color and title text color – Button color and button text color  Order Summary Column (applicable to Layout B) - You can change the following: – Column Color – Upload image – Repeat image option Using a Secure Token and Dynamically Passing Form Post Variables You need to create a secure token and obtain the secure token ID prior to sending the form post with configuration parameters for the
PAGE 37

Configuring Hosted Checkout Pages Using a Secure Token and Dynamically Passing Form Post Variables Variable Description SILENTPOSTFAILEDURL The return URL when Silent Post fails. Maximum length: 255 characters. TEMPLATE Determines whether to use one of the two redirect templates (Layout A or B) or the embedded template C. Values are: TEMPLATEA or TEMPLATEB or MINLAYOUT (for template C) URLMETHOD The technical method used to deliver the CANCELURL.
PAGE 38

3 Configuring Hosted Checkout Pages Silent Posts Variable Description SHOWAMOUNT If you pass in $0 amount and trans type = A, then if SHOWAMOUNT=FALSE, Payflow will not display the amount in the order summary table.Values: TRUE/FALSE SUBTOTAL Amount you pass to Payflow. It is displayed in the order summary section. This amount is only for display purposes and is not passed to the transaction servers.
PAGE 39

Configuring Hosted Checkout Pages Silent Posts 3 Data Returned by the Silent Post Features The Silent Post feature returns either a short list of data or all of the data that was submitted for the transaction. You can control what is returned to you via the optional ECHODATA parameter:   To return a short list of values generated by PayPal and the issuing bank which provide status information on the submitted transaction, set the optional ECHODATA parameter to False.
PAGE 40

3 40 Configuring Hosted Checkout Pages Silent Posts 31 July 2012 Gateway Developer Guide and Reference
PAGE 41

4 Payflow SDK The Payflow Software Development Kit (SDK) is a set of APIs to allow you to integrate the Gateway with your application or website. This section includes:  “Preparing the Payflow Gateway Client Application” on page 41.  “Activating Your Payflow Gateway Account” on page 42.  “Host URL Addresses” on page 42 NOT E : Each SDK includes full API documentation. The Payflow SDK is available as a .NET or Java library.
PAGE 42

4 Payflow SDK Activating Your Payflow Gateway Account Activating Your Payflow Gateway Account When you are ready to activate your Gateway account to begin submitting live transactions, follow these steps: 1. Log in to PayPal Manager at https://manager.paypal.com 2. Click ActivateYour Account and follow the on-screen instructions. 3. Change the URL within your web or desktop application to point to the live Gateway server host addresses.
PAGE 43

5 Sending a Simple Transaction to the Server When using the Payflow SDK, you send transactions to the Gateway server in name-value pair format. Typically, a simple transaction includes connection parameters, user parameters, and transaction data parameters.
PAGE 44

5 Sending a Simple Transaction to the Server Payflow Connection Parameters COMPANYNAME[14]=Ruff & Johnson COMMENT1[7]=Level=5 NOT E : Do not use quotation marks ("") even if you use a length tag. Name-Value Parameter Syntax Guidelines Follow these guidelines when creating name-value pair (NVP) parameter strings:  Do not use spaces in values.  Enclose the NVP parameter string in quotation marks (“ “).  Do not place quotation marks within the body of the NVP parameter string.
PAGE 45

Sending a Simple Transaction to the Server User Parameter Data Parameter Description HOSTADDRESS (Required) Gateway server name. HOSTPORT (Required) Use port 443. TIMEOUT (Required) Time-out period for the transaction. PayPal recommends a minimum time-out value of 30 seconds. The client begins tracking from the time that it sends the transaction request to the server. PROXYADDRESS (Optional) Proxy server address. Use the PROXY parameters for servers behind a firewall.
PAGE 46

5 Sending a Simple Transaction to the Server Sale Transaction Example Sale Transaction Example In addition to the required connection and user parameters, each transaction type may require other parameters and can include a number of optional parameters.
PAGE 47

6 Submitting Credit Card Transactions When using the Payflow SDK, plan how to implement credit card processing based on your business needs. Payflow SDK offers a core set of transaction parameters that all credit card processors use. This section describes how to submit a transaction for each transaction type supported.
PAGE 48

6 Submitting Credit Card Transactions About Credit Card Processing Processing Services), and Paymentech. To accept live credit cards, provide details about your account to PayPal during the “Go Live” part of enrollment. NOT E : An Internet Merchant Account is different type of merchant account. It has additional risks associated with card-not-present (e-commerce) transactions. It is different from a merchant account used for face-to-face/card-present (in-person) retail transactions .
PAGE 49

Submitting Credit Card Transactions Planning Your Gateway Integration Transaction Type Billable Balance Inquiry No Credit Yes Delayed Capture No Inquiry No Sale Yes Voice Authorization Yes Void Yes 6 The Payflow SDK also supports the following credit card features:  Address verification service and card security code validation  Card-present (SWIPE) transactions  Partial authorizations for pre-paid cards  Purchasing card transactions  Reference transactions (also called token
PAGE 50

6 Submitting Credit Card Transactions Planning Your Gateway Integration the issuer checks the street address and the zip code against the billing address on file for the consumer. Card security code refers to a 3- or 4-digit number that appears on the back of most credit cards. On American Express, the number appears proceeding and to the right of the embossed card number. Card security code is known by other names, such as CVV2, depending on the type of card.
PAGE 51

Submitting Credit Card Transactions Core Credit Card Parameters NOT E : 6 American Express cards require explicit acceptance when PayPal is the processor. To accept American Express cards, go to the Profile Page in PayPal Manager and click American Express card acceptance. Core Credit Card Parameters All credit card processors accept the basic parameters described in the following table with one exception: the PayPal processor does not support SWIPE.
PAGE 52

6 Submitting Credit Card Transactions Core Credit Card Parameters Parameter Description AMT (Required) Amount (Default: U.S. based currency). Limitations: Specify the exact amount to the cent using a decimal point. For example, use 34.00 not 34. Do not include comma separators. For example, use 1199.95 not 1,199.95. Your processor or Internet Merchant Account provider may stipulate a maximum amount.
PAGE 53

Submitting Credit Card Transactions Core Credit Card Parameters Parameter Description ORDERID (Optional) Checks for a duplicate order. If you pass ORDERID in a request and pass it again in the future, the response returns DUPLICATE=2 along with the ORDERID. N O TE : 6 Do not use ORDERID to catch duplicate orders processed within seconds of each other. Use ORDERID with Request ID to prevent duplicates as a result of processing or communication errors.
PAGE 54

6 Submitting Credit Card Transactions Submitting Account Verifications Parameter Description SHIPTOCOUNTRY (Optional) Ship-to country. Limitations: 3-character country code. Submitting Account Verifications Account verification, also known as zero dollar authorization (TRXTYPE=A), verifies credit card information. While you pass TRXTYPE=A for account verification and normal authorization, account verification differs from authorization in the following ways:   Always pass the AMT value 0.
PAGE 55

Submitting Credit Card Transactions Submitting Authorization/Delayed Capture Transactions 6 TRXTYPE=A&TENDER=C&PARTNER=PayPal&USER=SuperUser&PWD=SuperUserPasswo rd&AMT=0.00&ACCT=378282246310005&EXPDATE=1215&INVNUM=PONUM1&VERBOSIT Y=HIGH&BILLTOZIP=95031 This is the response: RESULT=0&PNREF=VFHA0FF8F27D&RESPMSG=Verified&AUTHCODE=667PNI&AVSADDR =X&AVSZIP=X&HOSTCODE=A&PROCAVS=U&AMEXID=123456789012345&AMEXPOSDATA= 123456789012&TRANSTIME=2011-0111 18:42:01&AMT=0.
PAGE 56

6 Submitting Credit Card Transactions Submitting Balance Inquiry Transactions Required Authorization Transaction Parameters To perform a delayed capture transaction, pass the following parameter: Parameter Description ORIGID (Required by some transaction types) ID of the original transaction referenced. The PNREF parameter returns this ID, and it appears as the Transaction ID in PayPal Manager reports. Limitations: 12 case-sensitive alphanumeric characters.
PAGE 57

Submitting Credit Card Transactions Submitting Card Present (SWIPE) Transactions Parameter Description TRXTYPE (Required) Set to B. Limitations: 1 alphanumeric character. EXPDATE (Required) Expiration date of the pre-paid card in the format MMYY. For example, 1215 represents December 2015. VERBOSITY (Required) Set to HIGH to obtain information about a balance inquriy in the response.
PAGE 58

6 Submitting Credit Card Transactions Submitting Card Present (SWIPE) Transactions Processing Platforms Supporting Card-Present Transactions The following processing platforms support card-present transactions.
PAGE 59

Submitting Credit Card Transactions Submitting Credit Transactions NOT E : 6 Do not include the ACCT or EXPDATE parameters in card-present transactions. The SWIPE value includes this data. TRXTYPE=S&TENDER=C&PARTNER=PayPal&USER=SuperMerchant&PWD=SuperMerchant&SWIP E[40]=;4912000033330026=15121011000012345678?&AMT=21.00 Submitting Credit Transactions The credit transaction (TRXTYPE=C) refunds the specified amount back to the cardholder.
PAGE 60

6 Submitting Credit Card Transactions Submitting Credit Transactions Set the value of ORIGID to the PNREF value returned for the original transaction. (PayPal Manager reports display the PNREF as the Transaction ID.) If you do not specify an amount, the amount of the original transaction is credited to the cardholder.
PAGE 61

Submitting Credit Card Transactions Submitting Inquiry Transactions ACCT AMT BILLTOCITY BILLTOCOUNTRY BILLTOEMAIL BILLTOMIDDLENAME BILLTOLASTNAME BILLTOPHONENUM BILLTOSTATE BILLTOSTREET BILLTOZIP COMMENT1 COMMENT2 COMPANYNAME CUSTCODE CUSTIP EXPDATE INVNUM PONUM SHIPTOCITY SHIPTOCOUNTRY SHIPTOFIRSTNAME SHIPTOMIDDLENAME SHIPTOLASTNAME SHIPTOSTATE SHIPTOSTREET SHIPTOZIP SWIPE 6 Example Credit Transaction Parameter Strings The following is an example of a credit transaction strin
PAGE 62

6 Submitting Credit Card Transactions Submitting Inquiry Transactions Parameter Description ORIGID (Required by some transaction types) ID of the original transaction referenced. The PNREF parameter returns this ID, and it appears as the Transaction ID in PayPal Manager reports. Limitations: 12 case-sensitive alphanumeric characters. Set ORIGID to the PNREF (Transaction ID in PayPal Manager reports) value returned in the original transaction.
PAGE 63

Submitting Credit Card Transactions Submitting Inquiry Transactions Parameter Description ENDTIME (Optional) For inquiry transactions when using CUSTREF to specify the transaction. ENDTIME specifies the end of the time period during which the transaction specified by the CUSTREF occurred. Limitations: 14 numeric characters NOT E : 6 If there are multiple transactions with a particular CUSTREF value, inquiry returns the last transaction only with the specified CUSTREF.
PAGE 64

6 Submitting Credit Card Transactions Submitting Partial Authorizations RESULT=0&PNREF=VFHE1A0CB0A9&TRANSSTATE=6&ORIGRESULT=0&ORIGPNREF=VFHE1A0CB0A 8&RESPMSG=Approved&AUTHCODE=010101&AVSADDR=Y&AVSZIP=Y&HOSTCODE=00&PROCAVS=Y &DATE_TO_SETTLE=2011-02-04 16:16:50&TRANSTIME=2011-0204 16:16:50&BILLTOFIRSTNAME=James&BILLTOLASTNAME=Smith&AMT=555.00&ACCT=0002 &EXPDATE=0120&CARDTYPE=0&IAVS=N Submitting Partial Authorizations A partial authorization is a partial approval of an authorization (TRXTYPE=A) transaction.
PAGE 65

Submitting Credit Card Transactions Submitting Purchasing Card Transactions 6 Example Partial Authorization The following is an example partial authorization. 1. You submit the initial authorization as a partial authorization. TRXTYPE=A&TENDER=C&AMT=100.00&ACCT=4111111111111111&EXPDATE=0119 &PARTIALAUTH=Y&VERBOSITY=HIGH 2. The card issuer notes that the card has a remaining balance of $80.00. 3. The card issuer sends a partial authorization for $80.00.
PAGE 66

6 Submitting Credit Card Transactions Submitting Reference Transactions (Tokenization) Submitting Reference Transactions (Tokenization) To recharge a credit card when you are not storing the credit card information in your local database, you can perform a reference transaction. A reference transaction takes the existing credit card information that is on file and reuses it. (Securely storing data for future reference is also known as tokenization.
PAGE 67

Submitting Credit Card Transactions Submitting Reference Transactions (Tokenization)  Delayed capture  Sale   6 Voice authorization (Payflow does not copy the voice authorization code to the new transaction) Void Fields Copied From Reference Transactions The following fields are copied from the reference transaction into the new sale or authorization transaction (if they exist in the original transaction).
PAGE 68

6 Submitting Credit Card Transactions Submitting Reference Transactions (Tokenization) 2. Capture the authorized funds for a partial shipment of $66. When you deliver the first $66 worth of product, you use a normal delayed capture transaction to collect the $66. Set ORIGID to the value of PNREF in the original authorization as in this transaction request. TRXTYPE=D&TENDER=C&PWD=x1y2z3&PARTNER=PayPal&VENDOR=SuperMerchant&USER=Supe rMerchant&ORIGID=VXYZ01234567&AMT=66.
PAGE 69

Submitting Credit Card Transactions Submitting Sale Transactions 6 You can send shipping and billing information to be stored, but you must not include the AMT field. If you pass a value for AMT, you will receive an error with RESULT=4 and RESPMSG=Invalid Amount. NOT E : PayPal does not verify the credit card data, as it is not sent to the banks for processing. To validate a transaction, you must submit an account verification, also known as a zero dollar authorization (TRXTYPE=A).
PAGE 70

6 Submitting Credit Card Transactions Submitting Soft Merchant Information TRXTYPE=S&TENDER=C&USER=SuperUser&PWD=SuperUserPassword&VENDOR=SuperUser&PA RTNER=PayPal&ACCT=5105105105105100&EXPDATE=1215&CVV2=123&AMT=99.00&BILLTOFI RSTNAME=John&BILLTOLASTNAME=Smith&BILLTOSTREET=123 Main St.
PAGE 71

Submitting Credit Card Transactions Submitting Voice Authorization Transactions 6 Soft Merchant Information (SM Record) Soft merchant information is for American Express credit cards only.
PAGE 72

6 Submitting Credit Card Transactions Submitting Void Transactions When To Use a Voice Authorization Transaction Some transactions cannot be authorized over the Internet (for example, high dollar amounts) and require manual authorization. These referral transactions generate RESULT value 13. In these situations, you contact the customer service department of your merchant bank and provide the payment information as requested.
PAGE 73

Submitting Credit Card Transactions Submitting Void Transactions 6 When To Use a Void Transaction Use the following guidelines when using void transactions:   You can void delayed capture, sale, credit, authorization, and voice authorization transactions. You cannot void a void transaction. You can only use a void transaction on a transaction that has not yet settled. To refund a customer’s money for a settled transaction, submit a credit transaction.
PAGE 74

6 Submitting Credit Card Transactions Using Address Verification Service Example Void Transaction Parameter String The following is an example void transaction string: TRXTYPE=V&TENDER=C&PARTNER=PayPal&VENDOR=SuperMerchant&USER=SuperMerchant&P WD=x1y2z3&ORIGID=VPNE12564395&VERBOSITY=HIGH Using Address Verification Service To qualify for the lowest bank rate, pass address verification service information, including the street address and zip (postal) code.
PAGE 75

Submitting Credit Card Transactions Using Card Security Code 6 Using Card Security Code The card security code is a 3- or 4-digit number (not part of the credit card number) that is printed on the credit card. Because the card security code appears only on the card and not on receipts or statements, the code provides some assurance that the physical card is in the buyer’s possession. This fraud prevention tool has various names, depending on the payment network.
PAGE 76

6 76 Submitting Credit Card Transactions Using Card Security Code 31 July 2012 Gateway Developer Guide and Reference
PAGE 77

7 Testing Transactions Before you activate your website or application for use by buyers, test your integration. A simulated payment network handles transactions, enabling you to verify the configuration and operation of your website or application. No money changes hands. Setting Up The Payflow Gateway Testing Environment Before testing transactions be sure you are linked to the test servers. Direct all transactions to the host URL for testing. See “Host URL Addresses” on page 42.
PAGE 78

7 Testing Transactions Processors Other Than PayPal Diners Club 38520000023237 Discover 6011111111111117 Discover 6011000990139424 JCB 3530111333300000 JCB 3566002020360505 MasterCard 5555555555554444 MasterCard 5105105105105100 Visa 4111111111111111 Visa 4012888888881881 Visa 4222222222222 NOT E : Even though this number has a different character count than the other test numbers, it is the correct and functional number.
PAGE 79

Testing Transactions Processors Other Than PayPal Processing Platform RESULT Values Available for Testing First Data Merchant Services North 0, 4, 5, 12, 13, 23, 24,114, 1000 First Data Merchant Services Nashville 0, 12, 13, 104 First Data Merchant Services South 0, 12, 13, 104 Global Payments Central 0, 4, 5, 8, 12, 13, 23, 24, 104, 111, 114, 1000 Global Payments East 0, 4, 5, 12, 13, 23, 24, 30, 100, 104, 114, 1000 Paymentech Salem (New Hampshire) 0, 12, 13, 104 Paymentech Tampa 0, 3, 4, 5
PAGE 80

7 80 Testing Transactions Processors Other Than PayPal RESULT value Definition How to test using Payflow Gateway 19 Original transaction ID not found Submit a delayed capture transaction with an invalid ORIGID 22 Invalid ABA number Applies only to ACH transactions – submit an invalid ABA number (8 digits) 23 Invalid account number Submit an invalid account number, for example, 000000000000000 24 Invalid expiration date Submit an invalid expiration date, for example, 0298 25 Transaction ty
PAGE 81

Testing Transactions Processors Other Than PayPal RESULT value Definition How to test using Payflow Gateway 114 CVV2 Mismatch Use the AMOUNT 1114.
PAGE 82

7 Testing Transactions PayPal Processor Testing Card Security Code If you submit a value for the card security code, the cardholder’s bank returns a Yes / No / Not Supported (Y / N / X) response on whether the value matches the number on file at the bank. Card security code is described in “Card Security Code Validation”. NOT E : Some processors will decline (RESULT value 12) a transaction if the card security code does not match without returning a CVV2MATCH value.
PAGE 83

Testing Transactions PayPal Processor JCB 3530111333300000 JCB 3566002020360505 MasterCard 5555555555554444 MasterCard 5105105105105100 Visa 4111111111111111 Visa 4012888888881881 Visa 4222222222222 NOT E : 7 Even though this number has a different character count than the other test numbers, it is the correct and functional number. Result Values Based On Amount The following table shows another method for obtaining RESULT values.
PAGE 84

7 84 Testing Transactions PayPal Processor Result Definition How to test 7 Field format error Use any of these as AMOUNT:  10405  10406  10407  10408  10409  10410  10412  10413  10416  10419  10420  10421  10509  10512  10513  10514  10515  10516  10517  10518  10540  10542 12 Declined Use any of these as AMOUNT:  10417  15002  15005  15006  15028  15039  10544  10545  10546 13 Referral Use the AMOUNT 10422 23 Invalid account number Use any of these as AMOUNT
PAGE 85

Testing Transactions PayPal Processor Result Definition How to test 24 Invalid expiration date Use any of these as AMOUNT:  10502  10508 30 Duplicate Transaction Use the AMOUNT 10536 105 Credit error Attempt to credit an authorization 112 Failed AVS check Use the AMOUNT 10505 114 CVV2 Mismatch Use the AMOUNT 10504 1000 Generic Host (Processor) Error Use an AMOUNT other than those listed in this column Gateway Developer Guide and Reference 31 July 2012 7 85
PAGE 86

7 86 Testing Transactions PayPal Processor 31 July 2012 Gateway Developer Guide and Reference
PAGE 87

8 Transaction Responses When a transaction finishes, the Payflow server returns a response string made up of namevalue pairs. The following is an example response string: RESULT=0&PNREF=EFHP0D426A53&RESPMSG=APPROVED&AUTHCODE=25TEST&AVSADDR=Y&AVSZ IP=N&CVV2MATCH=Y Credit Card Transaction Responses The table below describes values that can be returned in response strings. Field Description PNREF Gateway transaction ID, a unique number that identifies the transaction.
PAGE 88

8 Transaction Responses Credit Card Transaction Responses Field Description RESPMSG The response message returned with the transaction result. Exact wording varies. Sometimes a colon appears after the initial RESPMSG followed by more detailed information. NOTE: For account verification transactions, RESULT=0 with RESPMSG=Verified means a zero dollar authorization has been successfully performed. NOTE: The PayPal processor may also return a warning message in the RESPMSG string when RESULT=0.
PAGE 89

Transaction Responses Credit Card Transaction Responses Field Description HOSTCODE The raw response code returned by the processor. This field is not normalized and is returned when VERBOSITY is set to HIGH. Use RESPTEXT to obtain the response message from the processor. For additional PayPal processor response code information, refer to the PayPal API error codes. For all other processors, please contact your merchant bank or processor directly.
PAGE 90

8 Transaction Responses Address Verification Service Responses From PayPal Field Description CARDTYPE The credit card type. Is returned in an inquiry response when you send a VERBOSITY request parameter value of HIGH. Is one of the following values for currently used cards:  0 = Visa  1 = MasterCard  2 = Discover  3 = American Express  4 = Diner’s Club  5 = JCB EMAILMATCH Verifies whether the BILLTOEMAIL value sent is what is on file with the processor.
PAGE 91

Transaction Responses Address Verification Service Responses From PayPal PayPal processor Address Verification Service code Meaning AVSADDR AVSZIP A Address Y N B International “A” Y N C International “N” N N D International “X” Y Y E Not allowed for MOTO (Internet/Phone) transactions X X F UK-specific “X” Y Y G Global Unavailable X X I International Unavailable X X N No N N P Postal (International “Z”) N Y R Retry X X S Service not Supported X X U Unava
PAGE 92

8 Transaction Responses Card Security Code Results Card Security Code Results Normalized Card Security Code Results The CVV2MATCH parameter returns Y, N, or X or a processor-specific response. The CVV2MATCH parameter returns Y, N, or X. The following table shows the detailed results that the PayPal processor returns for card security codes. To obtain the PayPal processor value, set the VERBOSITY parameter to HIGH. The processor value is returned in the PROCCVV2 response parameter.
PAGE 93

Transaction Responses BALAMT Response and Stored Value Cards PayPal Processor CVV2 Code PayPal Processor Code Description PROCVV2MATCH X No Response X All other 8 X BALAMT Response and Stored Value Cards Transactions meeting American Express reporting and statement requirements may return BALAMT when the transaction involves a stored value card. Stored value cards typically are offered as gift cards, allowing the customer to spend any amount up to the balance remaining on the card.
PAGE 94

8 Transaction Responses RESULT Values and RESPMSG Text  VADE0B248932  ACRAF23DB3C4 NOT E : Printable characters also include symbols other than letters and numbers such as the question mark (?). A PNREF value typically contains letters and numbers only. The PNREF in a transaction response tells you that your transaction is connecting to PayPal. RESULT Values and RESPMSG Text The RESULT parameter is the first response parameter returned in the response string.
PAGE 95

Transaction Responses RESULT Values and RESPMSG Text RESULT RESPMSG and Explanation 1 User authentication failed. Error is caused by one or more of the following:  Login information is incorrect. Verify that USER, VENDOR, PARTNER, and PASSWORD have been entered correctly. VENDOR is your merchant ID and USER is the same as VENDOR unless you created a Payflow Pro user. All fields are case sensitive.  Invalid Processor information entered. Contact merchant bank to verify.
PAGE 96

8 96 Transaction Responses RESULT Values and RESPMSG Text RESULT RESPMSG and Explanation 25 Invalid Host Mapping. Error is caused by one or more of the following:  You are trying to process a tender type such as Discover Card, but you are not set up with your merchant bank to accept this card type.  You are trying to process an Express Checkout transaction when your account is not set up to do so. Contact your account holder to have Express Checkout added to your account.
PAGE 97

Transaction Responses RESULT Values and RESPMSG Text RESULT RESPMSG and Explanation 103 Error reading response from host The financial host could not interpret the response from the processor. This error can result in an uncaptured authorization if the transaction is an authorization or a sale, except on the following processors:  PayPal Australia: Time-out reversal logic should reverse the transaction. According to PayPal Australia, this is a best effort and is not guaranteed.
PAGE 98

8 Transaction Responses RESULT Values and RESPMSG Text RESULT RESPMSG and Explanation 112 Failed AVS check. Address and zip code do not match. An authorization may still exist on the cardholder’s account. 113 Merchant sale total will exceed the sales cap with current transaction. ACH transactions only. 114 Card Security Code (CSC) Mismatch. An authorization may still exist on the cardholder’s account. 115 System busy, try again later 116 VPS Internal error. Failed to lock terminal number.
PAGE 99

Transaction Responses RESULT Values and RESPMSG Text RESULT RESPMSG and Explanation 150 Issuing bank timed out FDRA reported a timeout between their system and the bank. This error will be reversed by time-out reversal. According to PayPal Australia, this is a best effort and is not guaranteed. 151 Issuing bank unavailable 200 Reauth error 201 Order error 600 Cybercash Batch Error 601 Cybercash Query Error 1000 Generic host error.
PAGE 100

8 Transaction Responses RESULT Values and RESPMSG Text RESULT RESPMSG and Explanation 1044 Buyer Authentication Service — Validate Authentication failed: Signature validation failed for PARES 1045 Buyer Authentication Service — Validate Authentication failed: Mismatched or invalid amount in PARES 1046 Buyer Authentication Service — Validate Authentication failed: Mismatched or invalid acquirer in PARES 1047 Buyer Authentication Service — Validate Authentication failed: Mismatched or invalid Merch
PAGE 101

Transaction Responses RESULT Values and RESPMSG Text RESULT Description -6 Parameter list format error: & in name -7 Parameter list format error: invalid [ ] name length clause -8 SSL failed to connect to host -9 SSL read failed -10 SSL write failed -11 Proxy authorization failed -12 Timeout waiting for response -13 Select failure -14 Too many connections -15 Failed to set socket options -20 Proxy read failed -21 Proxy write failed -22 Failed to initialize SSL certificate -23 H
PAGE 102

8 102 Transaction Responses RESULT Values and RESPMSG Text RESULT Description -107 This XMLPay version is not supported -108 The server certificate chain did not validate -109 Unable to do logging -111 The following error occurred while initializing from message file:
-113 Unable to round and truncate the currency value simultaneously 31 July 2012 Gateway Developer Guide and Reference
PAGE 103

A Processors Requiring Additional Transaction Parameters Additional parameters are those required by individual processors beyond the core parameters. Parameters are organized alphabetically by processor.
PAGE 104

A Processors Requiring Additional Transaction Parameters American Express Additional Credit Card Parameters Field Description L_AMTn (Optional) Amount of this line-item (n is a line item number from 1 to 6). Character length and limitations: Must include a decimal and be exact to the cent (42.00, not 42) and exclude comma separators (1234.56 not 1,234.56). Examples: tip=3.00, convenience charge=2.00.
PAGE 105

Processors Requiring Additional Transaction Parameters American Express Additional Credit Card Parameters A Address Verification Service Parameters Field Description BILLTOSTREET (Optional) Account holder’s street address (number and street name). Character length and limitations: 20 characters BILLTOZIP (Optional) Account holder’s 5- to 9-digit ZIP (postal) code excluding spaces, dashes, and non-numeric characters.
PAGE 106

A Processors Requiring Additional Transaction Parameters American Express Additional Credit Card Parameters Field Description MERCHANTCITY (Optional) The name of the city were the transaction took place.  If you are a third-party biller (bill for services or goods rendered by another entity), you must enter the name of the city in which the seller is located.
PAGE 107

Processors Requiring Additional Transaction Parameters American Express Additional Credit Card Parameters A Transaction Advice Detail Parameters Field Description ADDLAMTn (Optional) Detail of a charge where n is a value from 1 - 5. Use for additional breakdown of the amount. Character length and limitations: Must include a decimal and be exact to the cent (42.00, not 42) and exclude comma separators (1234.56 not 1,234.56). Examples: tip=3.00, convenience charge=2.00.
PAGE 108

A Processors Requiring Additional Transaction Parameters American Express Additional Credit Card Parameters Field Description AIR-ROUTINGCITYn (Optional) Airport codes of each city in this flight including cities of origin and destination, where n is a value from 1 to 10. Character length and limitations: 5 alphanumeric characters AIR-CARRIERn (Optional) Two character airline code for each unique airline in this flight, where n is a value from 1 to 10.
PAGE 109

Processors Requiring Additional Transaction Parameters Elavon Additional Credit Card Parameters Field Description INVNUM (Optional) Merchant invoice number. The merchant invoice number is used for authorizations and settlements and, depending on your merchant bank, will appear on your customer's credit card statement and your bank reconciliation report. If you do not provide an invoice number, the transaction ID (PNREF) will be submitted.
PAGE 110

A Processors Requiring Additional Transaction Parameters First Data Merchant Services Nashville, Additional Credit Card Parameters First Data Merchant Services Nashville, Additional Credit Card Parameters In addition to the core credit card parameters, First Data Merchant Services (FDMS) Nashville accepts the parameters described below. Field Description INVNUM (Optional) Merchant invoice number.
PAGE 111

Processors Requiring Additional Transaction Parameters Heartland, Additional Credit Card Parameters Field Description MERCHSVC (Optional) Defaults to the city where the merchant outlet is located for retail and to the merchant’s phone number for non-retail. For example, 800 111-1111. This information is usually displayed in the account holder’s statement.
PAGE 112

A Processors Requiring Additional Transaction Parameters Litle Additional Credit Card Parameters Field Description INVNUM (Optional) Merchant invoice number. The merchant invoice number is used for authorizations. If you do not provide an invoice number, the transaction ID (PNREF) will be submitted. Character length and limitations: 20 alphanumeric characters MERCHANTCITY (Optional) The name of the city were the transaction took place.
PAGE 113

Processors Requiring Additional Transaction Parameters Merchant e-Solutions, Additional Credit Card Parameters A Merchant e-Solutions, Additional Credit Card Parameters In addition to the core credit card parameters, Merchant e-Solutions accepts the parameters described below. Field Description INVNUM (Optional) Merchant invoice number.
PAGE 114

A Processors Requiring Additional Transaction Parameters Paymentech Salem (New Hampshire) Additional Credit Card Parameters for American Express Field Description CUSTHOSTNAME (Optional) Name of the server that the account holder is connected to. Example: PHX.QW.AOL.COM. Character length and limitations: 60 alphanumeric and special characters CUSTBROWSER (Optional) Name of the server that the account holder is connected to. Example: MOZILLA/4.0~(COMPATIBLE;~MSIE~5.
PAGE 115

Processors Requiring Additional Transaction Parameters PayPal Credit Card Transaction Request Parameters Field Description SHIPTOSTREET (Optional) Shipping street address. Character length and limitations: 30 characters SHIPTOCOUNTRY (Optional) Numeric country code of ship-to country. Example: USA: 840. Character length and limitations: 3 alphanumeric characters SHIPTOZIP (Optional) Shipping 5- to 9-digit zip (postal) code excluding spaces, dashes, and non-numeric characters.
PAGE 116

A Processors Requiring Additional Transaction Parameters PayPal Credit Card Transaction Request Parameters Parameter Description AMT (Required) Amount (US Dollars) U.S. based currency. AMT=ITEMAMT + TAXAMT + FREIGHTAMT + HANDLINGAMT + INSURANCEAMT - DISCOUNT N O TE : You must set CURRENCY to one of the three-character currency codes for any of the supported PayPal currencies. See CURRENCY in this table for details. Limitations: Must not exceed $10,000 USD in any currency.
PAGE 117

Processors Requiring Additional Transaction Parameters PayPal Credit Card Transaction Request Parameters Parameter Description ITEMAMT (Required if L_COSTn is specified) Sum of cost of all items in this order. ITEMAMT = L_QTY0*LCOST0 + L_QTY1*LCOST1...L_QTYn*L_COSTn Limitations: Nine numeric characers plus decimal (.) character. No currency symbol. Specify the exact amount to the cent using a decimal point—use 34.00, not 34. Do not include comma separators—use 1199.95 not 1,199.95.
PAGE 118

A Processors Requiring Additional Transaction Parameters PayPal Credit Card Transaction Request Parameters Parameter Description L_NAMEn (Optional) Line-item name. N O TE : To enable line-item support, you must contact Merchant Technical Support at http://www.paypal.com/mts Character length and limitations: 36 alphanumeric characters. L_DESCn (Optional) Line-item description of the item purchased such as hiking boots or cooking utensils.
PAGE 119

Processors Requiring Additional Transaction Parameters PayPal Credit Card Transaction Request Parameters Parameter Description NOTIFYURL (Optional) Your URL for receiving Instant Payment Notification (IPN) about this transaction. If you do not specify NOTIFYURL in the request, the notification URL from your Merchant Profile is used, if one exists. Limitations: 2048 alphanumeric characters. ORDERDESC (Optional) Description of items the customer is purchasing. Limitations: 127 alphanumeric characters.
PAGE 120

A Processors Requiring Additional Transaction Parameters SecureNet Additional Credit Card Parameters for American Express Parameter Description SHIPTOSTATE (Optional) Ship-to state or province address. N O TE : If you pass in any of the ship-to address parameters such as SHIPTOCITY or SHIPTOSTATE, you must pass in the complete set (that is, SHIPTOSTREET, SHIPTOCITY, SHIPTOSTATE, SHIPTOCOUNTRY, and SHIPTOZIP). Limitations: 10-character string. SHIPTOCOUNTRY (Optional) Ship-to country code.
PAGE 121

Processors Requiring Additional Transaction Parameters SecureNet Additional Credit Card Parameters for American Express A Internet Transaction Data Field Description BILLTOEMAIL (Optional) Account holder’s email address. Character length and limitations: 60 alphanumeric characters BILLTOPHONENUM (Optional) Account holder’s telephone number.
PAGE 122

A Processors Requiring Additional Transaction Parameters SecureNet Additional Credit Card Parameters for American Express Field Description BILLTOPHONENUM (Optional) Account holder’s telephone number. The formats are:  xxx-xxx-xxxx (US numbers)  +xxxxxxxxxxx (international numbers) Character length and limitations: 10 characters SHIPTOFIRSTNAME (Optional) First name in the shipping address.
PAGE 123

Processors Requiring Additional Transaction Parameters SecureNet Additional Credit Card Parameters for American Express Parameter Description MERCHANTSTATE (Optional) The region code that corresponds to the state, province, or country subdivision of the merchant location where the transaction took place.
PAGE 124

A Processors Requiring Additional Transaction Parameters SecureNet Additional Credit Card Parameters for American Express Field Description AIR-ORIGIN (Optional) Airport code of the originating airport. For a list of airport codes, see http://www.world-airport-codes.com/alphabetical/airport-code/a.html. N O TE : Present day airport codes are three characters in length. The five character length is designed to allow for future expansion.
PAGE 125

Processors Requiring Additional Transaction Parameters Vantiv Additional Credit Card Parameters Field Description AIRNUMBEROFPASSENGERS (Optional) Number of passengers on this trip. Character length and limitations: numeric AIR-ISETICKET (Optional) If this is an electronic ticket. Character length and limitations: 1 alphanumeric character (Y or N) AIR-RESERVATIONCODE (Optional) Code assigned to the travel reservation before the ticket was purchased.
PAGE 126

A Processors Requiring Additional Transaction Parameters Vantiv Additional Credit Card Parameters Soft Merchant Descriptor Parameters Field Description MERCHANTNAME (Optional) Name of merchant. Character length and limitations: 38 alphanumeric characters MERCHANTSTREET (Optional) Merchant’s street address (number and street name). Character length and limitations: 38 alphanumeric characters. If more than 38 characters, use proper and meaningful abbreviation. Do not truncate.
PAGE 127

Processors Requiring Additional Transaction Parameters WorldPay Additional Credit Card Parameters Field Description MERCHANTCONTACTINFO (Optional) Merchant’s telephone number or web address. (URLs and e-mail addresses may be lowercase, as appropriate.) This entry may appear on the descriptive bill on the card-member’s statement, or may be used to resolve billing inquiries and disputes.
PAGE 128

A 128 Processors Requiring Additional Transaction Parameters WorldPay Additional Credit Card Parameters 31 July 2012 Gateway Developer Guide and Reference
PAGE 129

B TeleCheck Electronic Check Processing This appendix describes the host-based capture version of the TeleCheck Non-Face-To-Face Check Acceptance (NFTF) services. TeleCheck NFTF Overview of Services NFTF offers merchants the convenience of electronic check deposits. When a NFTF transaction is approved by TeleCheck, the manually entered MICR data from the check is electronically converted to an ACH debit and is processed through the ACH Network. The merchant receives funds within two banking days.
PAGE 130

B TeleCheck Electronic Check Processing TeleCheck NFTF Processing Overview             130 Dual ID is required for all transactions. For personal checks, it must be MICR data and personal check writer identification such as a driver’s license. For company checks, it must be MICR data and Federal Tax ID. In the event that a company does not have a Federal Tax ID, the driver’s license can also be used.
PAGE 131

TeleCheck Electronic Check Processing TeleCheck NFTF Processing Overview B System. Various optional data elements throughout each of the message packets could be affected by this requirement.  First Data Gateway Partners, External Gateway vendors, First Data Platforms, and the Global Gateway Router (GGR) that route merchant transactions to TeleCheck via this specification must code for all fields, features, and functionality available in this specification. Nothing is optional for these partners.
PAGE 132

B TeleCheck Electronic Check Processing TeleCheck Parameters Transaction flow Method Messages sent from the Merchant to TeleCheck are authorization messages. Messages sent from TeleCheck to the Merchant are Response messages. The sale transaction process is often referred to as a 2-part hand-off. The process begins with the merchant’s Authorization message.
PAGE 133

TeleCheck Electronic Check Processing TeleCheck Parameters B Required TeleCheck Parameters Field Description USER (Required) Case-sensitive login ID for the Gateway account that you created while registering for the account. In the future, each account will allow multiple users. This parameter will specify the user. Character length and limitations: 64 alphanumeric characters VENDOR (Required) Case-sensitive Vendor ID that you created while registering for the account.
PAGE 134

B TeleCheck Electronic Check Processing TeleCheck Parameters Field Description BILLTOPHONENUM (Required) Account holder’s telephone number. Character length and limitations: 10 numeric characters. This value may not contain spaces or non-numeric characters. BILLTOSTATE (Required) Account holder’s state. Character length and limitations: 2 alphanumeric characters BILLTOSTREET (Required) Account holder’s street address.
PAGE 135

TeleCheck Electronic Check Processing Testing TeleCheck Transactions Field Description SS Account holder’s social security number. You are required to pass a value for SS when a value for CHKTYPE is passed:  If CHKTYPE=P, you are required to pass a value for either DL or SS as an identifier.  If CHKTYPE=C, you are required to pass the Federal Tax ID. B Character length and limitations: 35 alphanumeric characters TENDER (Required) Method of payment. Use only the value K (electronic check).
PAGE 136

B TeleCheck Electronic Check Processing Preparing for TeleCheck Production Transactions MICR values for testing You may view a complete list of TeleCheck response codes at “Sale Response Code Values” on page 137 MICR HOSTCODE TeleCheck Result 3333333333 07 Approved 1111111111 08 Rejected (negative data) 2222222222 88 Rejected Code 3 (Risk) Preparing for TeleCheck Production Transactions Before going into production with your check integration, you must certify your storefront with TeleCheck.
PAGE 137

TeleCheck Electronic Check Processing Response Code Values Field Description HOSTCODE TeleCheck’s response code representing the results of the transaction authorization attempt. Character length and limitations: 6 numeric characters RESPMSG A descriptive message associated with decline or error result values. Character length and limitations: alphanumeric, variable number of characters B Response Code Values For your service, below is a complete list of possible Response Codes.
PAGE 138

B TeleCheck Electronic Check Processing Response Code Values Sale Referral Responses Code Description Merchant Action 09 Risk Referral requested Contact TeleCheck. 69 Call Center Contact TeleCheck. Sale Error Responses Code Description Merchant Action 46 Merchant setup does not allow this type of transaction 49 Processor Not Available 98 Invalid MICR Data 27 Invalid Value for Field 78 Invalid RT (Routing/Bank Number) 97 Unable to Process (Time Out) Re-send message later.
PAGE 139

TeleCheck Electronic Check Processing TeleCheck Authorization Requirements Code Description ACK Inquiry Packet was accepted by the TeleCheck Host NAK Inquiry Packet was not successfully processed by TeleCheck (general error) 49 Inquiry Packet was not successfully processed by TeleCheck (scheduled maintenance) 97 Inquiry Packet was not successfully processed by TeleCheck (timeout) 27 Inquiry Packet was not successfully processed by TeleCheck (invalid data) B TeleCheck Authorization Requirements
PAGE 140

B TeleCheck Electronic Check Processing TeleCheck Authorization Requirements return item fee by electronic funds transfer(s) or draft(s) drawn from my account. Click here to view your state’s returned item fee. If this payment is from a corporate account, I make these authorizations as an authorized corporate representative and agree that the entity will be bound by the NACHA Operating Rules.
PAGE 141

TeleCheck Electronic Check Processing TeleCheck Authorization Requirements B Today (insert today’s date), I’d like to confirm that you, (insert first and last name), are authorizing a payment in the amount of (insert amount) to be processed as an electronic funds transfer or draft drawn from your account.
PAGE 142

B TeleCheck Electronic Check Processing TeleCheck Authorization Requirements merchant should link directly to the TeleCheck-hosted URL provided above. State fees are updated on a regular basis and linking to a TeleCheck-hosted page will minimize the number of maintenance updates required. The merchant may choose how to display the state fees. Suggestions include a new pop-up window, a full browser window, or directly on the checkout page.
PAGE 143

C Submitting Purchasing Card Level 2 and Level 3 Transactions PayPal Payment Services supports passing Purchasing Card Level 2 information (such as purchase order number, tax amount, and charge description) in the settlement file.
PAGE 144

C Submitting Purchasing Card Level 2 and Level 3 Transactions About American Express Purchasing Card Transactions Level Description Level 1 Function as normal credit cards and are authorized and associated with normal transaction data in authorization and settlement. Any merchant who accepts credit cards supports this level.. Level 2 Additional data regarding sales tax, customer code, purchase order number, invoice number are captured at the point of sale.
PAGE 145

Submitting Purchasing Card Level 2 and Level 3 Transactions About American Express Purchasing Card Transactions C Avoiding Downgrade If a transaction uses the purchasing card BIN range (see “Accepted BIN Ranges” on page 146) and contains a line item but does not include all mandatory Level 3 parameters, the transaction succeeds but is processed as Level 2 or Level 1 during settlement (depending on which data was passed).
PAGE 146

C Submitting Purchasing Card Level 2 and Level 3 Transactions American Express Purchasing Card Transaction Processing Accepted BIN Ranges The following BIN ranges are accepted for American Express Level 2 and Level 3 transactions: 37326 37429 37857 37859 37873 37965 American Express Purchasing Card Transaction Processing The American Express supports Level 2 transaction data. NOT E : Most merchants in the United States follow American Express reporting and statement requirements.
PAGE 147

Submitting Purchasing Card Level 2 and Level 3 Transactions American Express Purchasing Card Transaction Processing Field Description L_AMT1 (Optional) Charge for this line item. Must include a decimal and be exact to the cent (42.00, not 42) and exclude comma separators (1234.56 not 1,234.56). Character length and limitations: 12 numeric characters L_QTY1 (Optional) Quantity of this line item.
PAGE 148

C Submitting Purchasing Card Level 2 and Level 3 Transactions American Express Purchasing Card Transaction Processing Field Description MERCHANTCITY (Optional) The name of the city were the transaction took place.  If you are a third-party biller (bill for services or goods rendered by another entity), you must enter the name of the city in which the seller is located.
PAGE 149

Submitting Purchasing Card Level 2 and Level 3 Transactions American Express Purchasing Card Transaction Processing C Transaction Advice Detail Parameters Field Description ADDLAMTn (Optional) Detail of a charge where n is a value from 1 - 5. Use for additional breakdown of the amount. Character length and limitations: Must include a decimal and be exact to the cent (42.00, not 42) and exclude comma separators (1234.56 not 1,234.56). Examples: tip=3.00, convenience charge=2.00.
PAGE 150

C Submitting Purchasing Card Level 2 and Level 3 Transactions American Express Purchasing Card Transaction Processing Field Description SHIPTOZIP (Required) Ship-to postal code (called zip code in the USA).
PAGE 151

Submitting Purchasing Card Level 2 and Level 3 Transactions American Express Purchasing Card Transaction Processing Field Description L_PRODCODEn (Optional) The item’s supplier stock keeping unit (SKU) number. Character length and limitations: 1 to 30 alphanumeric characters L_UPCn (Optional) The item’s universal product code (UPC). Character length and limitations: 1 to 30 alphanumeric characters L_TAXAMTn (Optional) Item tax amount.
PAGE 152

C Submitting Purchasing Card Level 2 and Level 3 Transactions Elavon (Formerly Nova) Purchasing Card Transaction Processing Elavon (Formerly Nova) Purchasing Card Transaction Processing Elavon supports Level 2 for Visa and MasterCard sale, credit, and delayed capture transactions. Elavon Level 2 Parameters To get the discount rate, include both Level 2 parameters listed in the following table. Pass these parameters in authorization and sale transactions.
PAGE 153

Submitting Purchasing Card Level 2 and Level 3 Transactions First Data Merchant Services (FDMS) Nashville Purchasing Card Transaction Processing C Example Elavon Level 2 Transaction Parameter String TRXTYPE=S&ACCT=5105105105105100&AMT=20.10&BILLTOCITY=Mountain View&COMMENT1 =L2 Testing&EXPDATE=1215&BILLTOFIRSTNAME=Cardholder First Name&BILLTOLASTNA ME=Cardholder Last Name&PARTNER=PayPal&PWD=pwd&BILLTOSTATE=CA&BILLTOSTREET= 123 Main St.&TENDER=C&USER=user&BILLTOZIP=94043&CUSTCODE=123456&TAXAMT=1.
PAGE 154

C Submitting Purchasing Card Level 2 and Level 3 Transactions First Data Merchant Services (FDMS) North Purchasing Card Transaction Processing Field Description TAXAMT (Optional)Tax amount. The value must include a decimal and the exact amount to the cent (42.00, not 42). Do not include comma separators (1234.56 not 1,234.56).
PAGE 155

Submitting Purchasing Card Level 2 and Level 3 Transactions First Data Merchant Services South (FDMS) Purchasing Card Transaction Processing C FDMS North Purchasing Card Line Item Parameters Line item data (Level 3) describes the details of the item purchased and can be passed for each transaction. The convention for passing line item data in name-value pairs is that each namevalue starts with L_ and ends with n where n is the line item number.
PAGE 156

C Submitting Purchasing Card Level 2 and Level 3 Transactions First Data Merchant Services South (FDMS) Purchasing Card Transaction Processing FDMS South Level 2 and Level 3 Purchasing Card Parameters 156 Field Description BILLTOCITY (Optional) Cardholder’s city. Character length and limitations: 13 alpha characters SHIPTOCOUNTRY (Optional) Destination Country Code. Visa and MasterCard are different. Refer to Country Code tables.
PAGE 157

Submitting Purchasing Card Level 2 and Level 3 Transactions First Data Merchant Services South (FDMS) Purchasing Card Transaction Processing Field Description ORDERTIME (Optional) Order time and date. Format is either YYYY-MM-DD or YYYY-MM-DD HH:MI:SS (where HH is in 24-hour time). If the value does not conform to one of the formats or if the date is not valid (for example, 2004-17-35), then the transaction is rejected with a RESULT=7 (SIG_FIELD_ERR) and RESPMSG=Invalid ORDERTIME.
PAGE 158

C Submitting Purchasing Card Level 2 and Level 3 Transactions First Data Merchant Services South (FDMS) Purchasing Card Transaction Processing Field Description L_DESCn (Optional) Item description. Character length and limitations: 35 alphanumeric characters L_UOMn (Optional) Item unit of measure. Character length and limitations: 3 alpha characters L_COSTn (Optional) Cost per item, excluding tax.
PAGE 159

Submitting Purchasing Card Level 2 and Level 3 Transactions Global Payments - Central Purchasing Card Transaction Processing C Global Payments - Central Purchasing Card Transaction Processing Global Payments - Central (MAPP) supports Level 2 parameters for MasterCard, and Visa sale, credit, and delayed capture transactions. Global Payments - Central Level 2 Parameters Pass the following Level 2 parameters to get the discount rate.
PAGE 160

C Submitting Purchasing Card Level 2 and Level 3 Transactions Heartland Purchasing Card Transaction Processing Level 2 Parameters Description CUSTCODE (Required) Customer code. Character length and limitations: 1 to 16 alphanumeric characters TAXAMT (Required) Sales tax. The value must include a decimal and the exact amount to the cent (42.00, not 42). Do not include comma separators (1234.56 not 1,234.56). To qualify for Level 2 discounts, this value must not be all zeros or blank spaces.
PAGE 161

Submitting Purchasing Card Level 2 and Level 3 Transactions Heartland Purchasing Card Transaction Processing Parameter Description TAXAMT (Required) Tax amount. The value must include a decimal and the exact amount to the cent (42.00, not 42). Do not include comma separators (1234.56 not 1,234.56). To qualify for Level 2 discounts, this value must not be all zeros or blank spaces. Character length and limitations: numeric TAXEXEMPT (Optional) Tax amount identifier.
PAGE 162

C Submitting Purchasing Card Level 2 and Level 3 Transactions Heartland Purchasing Card Transaction Processing Parameter Description NATIONALTAXAMT (Optional) National tax amount. You may omit this parameter if there is no such tax. Character length and limitations: 12 numeric characters INVNUM (Required) Purchase Order number or customer reference ID. The PNREF value is sent if no value is provided.
PAGE 163

Submitting Purchasing Card Level 2 and Level 3 Transactions Heartland Purchasing Card Transaction Processing Parameter Description L_QTYn (Required) Quantity. Character length and limitations: 12 numeric characters L_UOMn (Required) Unit of measure code. Character length and limitations: 12 alphanumeric characters L_COSTn (Required) Unit cost. Character length and limitations: 12 numeric characters L_TAXAMTn (Optional) VAT/tax amount.
PAGE 164

C Submitting Purchasing Card Level 2 and Level 3 Transactions Heartland Purchasing Card Transaction Processing Parameter Description TAXAMT (Required) Tax amount. The value must include a decimal and the exact amount to the cent (42.00, not 42). Do not include comma separators (1234.56 not 1,234.56). Character length and limitations: numeric LOCALTAXAMT (Optional) Local tax amount. Character length and limitations: 12 numeric characters TAXEXEMPT (Optional) Local tax incl flag.
PAGE 165

Submitting Purchasing Card Level 2 and Level 3 Transactions Heartland Purchasing Card Transaction Processing Parameter Description VATREGNUM (Required) VAT registration number. Can be part of the registration data or passed with each transaction. Character length and limitations: 20 alphanumeric characters FREIGHTAMT (Required) Unique VAT inventory reference number. Can be part of the registration data or passed with each transaction.
PAGE 166

C Submitting Purchasing Card Level 2 and Level 3 Transactions Litle Purchasing Card Transaction Processing Example Heartland Level 3 Visa Transaction Parameter String TRXTYPE=S&TENDER=C&PARTNER=Partner&USER=User&PWD=Password&ACCT=411111111111 1111&EXPDATE=1215&AMT=1.00&BILLTOSTREET=5199 JOHNSON&TAXAMT=1.06&BILLTOZIP= 94588&ALTTAXAMT=1.00&CUSTVATREGNUM=11111&LOCALTAXAMT=1.01&NATIONALTAXAMT=1. 02&COMMCODE=22222&VATAXAMT=1.03&VATAXPERCENT=55&TAXEXEMPT=N&DISCOUNT=.50&FR EIGHTAMT=1.00&DUTYAMT=1.
PAGE 167

Submitting Purchasing Card Level 2 and Level 3 Transactions Litle Purchasing Card Transaction Processing Field Description L_COMMCODEn (Optional) Identifier assigned by the card acceptor that categorizes the purchased item, where n is a line-item number from 1 to 99. Character length and limitations: 12 alphanumeric characters L_COSTn (Required if L_QTYn is supplied) Price of one unit of the item purchased, where n is a line-item number from 1 to 99.
PAGE 168

C Submitting Purchasing Card Level 2 and Level 3 Transactions Merchant e-Solutions Purchasing Card Transaction Processing Field Description FREIGHTAMT (Optional) Shipping amount for the order. Character length and limitations: The decimal is implied. If, for example, you specify 500, this value is equivalent to $5.00. 8 numeric characters TAXAMT (Optional) Tax amount included in the amount of the transaction. Character length and limitations: The decimal is implied.
PAGE 169

Submitting Purchasing Card Level 2 and Level 3 Transactions Merchant e-Solutions Purchasing Card Transaction Processing C Merchant e-Solutions Level 2 Parameters Merchant e-Solutions supports MasterCard and Visa for Level 2 processing. Merchant e-Solutions indicates in the authorization response whether the credit card in the transaction is a commercial card. Based on the commercial card indicator, Payflow will format the Level 2 information in the settlement request.
PAGE 170

C Submitting Purchasing Card Level 2 and Level 3 Transactions Merchant e-Solutions Purchasing Card Transaction Processing Merchant e-Solutions Level 2 MasterCard Parameters Required for Level 3 Transactions Parameter Description PONUM (Required) Purchase identifier. Character length and limitations: 25 alphanumeric characters TAXAMT (Required) Tax amount. The value must include a decimal and the exact amount to the cent (42.00, not 42). Do not include comma separators (1234.56 not 1,234.56).
PAGE 171

Submitting Purchasing Card Level 2 and Level 3 Transactions Merchant e-Solutions Purchasing Card Transaction Processing C Merchant e-Solutions Level 3 MasterCard Line Item Detail Records NOT E : For the following values, n is a sequence counter that should begin with 1 and increase in sequence. With each line item, include the quantity (L_QTYn) and unit price (L_COSTn) fields. Parameter Description L_COMMCODEn (Optional) Item commodity code.
PAGE 172

C Submitting Purchasing Card Level 2 and Level 3 Transactions Merchant e-Solutions Purchasing Card Transaction Processing Merchant e-Solutions Level 3 Visa Parameters To qualify for Level 3 transactions, the authorization response for the transaction must have the commercial card indicator set and one or more line items should be present in the delayed capture or sale request. Level 2 transaction parameters marked as Required are required for Level 3 transactions.
PAGE 173

Submitting Purchasing Card Level 2 and Level 3 Transactions Merchant e-Solutions Purchasing Card Transaction Processing Parameter Description FREIGHTAMT (Optional) Freight amount. Character length and limitations: 12 numeric characters DUTYAMT (Optional)Duty amount. Character length and limitations: 12 numeric characters ORDERDATE (Required) Order date. Format is mmddyy with no slashes or dashes. For example, July 28, 2003 is 072803.
PAGE 174

C Submitting Purchasing Card Level 2 and Level 3 Transactions Paymentech Salem (New Hampshire) Purchasing Card Transaction Processing Parameter Description L_UOMn (Required) Unit of measure code. Character length and limitations: 12 alphanumeric characters L_COSTn (Required) Unit cost. Character length and limitations: 12 numeric characters L_TAXAMTn (Optional) VAT/tax amount. Character length and limitations: 12 numeric characters L_TAXRATEn (Optional) VAT/tax rate.
PAGE 175

Submitting Purchasing Card Level 2 and Level 3 Transactions Paymentech Salem (New Hampshire) Purchasing Card Transaction Processing C CPC Level 2 Transaction Advice Addendum Parameters Field Description PONUM (Required) Purchase order number. Character length and limitations: 17 alphanumeric characters SHIPTOZIP (Required) Ship-to postal code (called zip code in the USA). Character length and limitations: 15 alphanumeric characters TAXAMT (Optional) Total tax amount.
PAGE 176

C Submitting Purchasing Card Level 2 and Level 3 Transactions Paymentech Salem (New Hampshire) Purchasing Card Transaction Processing Location Transaction Advice Addendum Parameters Field Description MERCHANTNAME (Optional) Name of merchant. Character length and limitations: 38 alphanumeric characters MERCHANTSTREET (Optional) Merchant’s street address (number and street name). Character length and limitations: 38 alphanumeric characters.
PAGE 177

Submitting Purchasing Card Level 2 and Level 3 Transactions Paymentech Salem (New Hampshire) Purchasing Card Transaction Processing Field Description MERCHANTID (Required) American Express-assigned service establishment number used to identify and facilitate payments to merchants. N O TE : C Paymentech must enable your division for soft merchant processing or your transaction will fail with response reason code 258. Contact your Paymentech Account Manager for details.
PAGE 178

C Submitting Purchasing Card Level 2 and Level 3 Transactions Paymentech Salem (New Hampshire) Purchasing Card Transaction Processing Parameter Description TAXAMT (Required) Sales tax. The value must include a decimal and the exact amount to the cent (42.00, not 42). Do not include comma separators (1234.56 not 1,234.56). To qualify for Level 2 discounts, this value must not be all zeros or blank spaces.
PAGE 179

Submitting Purchasing Card Level 2 and Level 3 Transactions Paymentech Salem (New Hampshire) Purchasing Card Transaction Processing C . Level 3 MasterCard Line Item Record #2 Parameters Parameter Description L_AMTn (Optional) Line-item total. Character length and limitations: numeric L_DISCOUNTn (Optional) Discount amount. Character length and limitations: numeric L_TAXTYPEn (Optional) Tax type applied.
PAGE 180

C Submitting Purchasing Card Level 2 and Level 3 Transactions Paymentech Tampa Level 2 Purchasing Card Transaction Processing . Level 3 Visa Line Item Record #2 Parameters Parameter Description L_AMTn (Optional) Line-item total. Character length and limitations: numeric L_DISCOUNTn (Optional) Discount amount. Character length and limitations: numeric L_UPCn (Optional) Item commodity code. L_COSTn (Optional) Unit cost.
PAGE 181

Submitting Purchasing Card Level 2 and Level 3 Transactions SecureNet Purchasing Card Transaction Processing C Paymentech Tampa Level 2 Parameters Paymentech Tampa Level 2 Parameters Description PONUM (Required) Customer reference number. Character length and limitations: 1 to 17 alphanumeric characters TAXAMT (Required) Sales tax. The value must include a decimal and the exact amount to the cent (42.00, not 42). Do not include comma separators (1234.56 not 1,234.56).
PAGE 182

C Submitting Purchasing Card Level 2 and Level 3 Transactions SecureNet Purchasing Card Transaction Processing SecureNet Level 2 Parameters Parameter Description PONUM (Required) Customer reference ID. Character length and limitations: 1 to 17 alphanumeric characters TAXAMT (Required) Tax amount. The value must include a decimal and the exact amount to the cent (42.00, not 42). Do not include comma separators (1234.56 not 1,234.56).
PAGE 183

Submitting Purchasing Card Level 2 and Level 3 Transactions SecureNet Purchasing Card Transaction Processing Parameter Description TAXEXEMPT (Optional) Local tax incl flag. Character length and limitations: 1 alphanumeric, Y or N NATIONALTAXAMT (Optional)National tax amount. Character length and limitations: 12 numeric characters INVNUM (Required) Purchase order number/customer reference ID. The value of PNREF is sent if the INVNUM parameter is not provided.
PAGE 184

C Submitting Purchasing Card Level 2 and Level 3 Transactions SecureNet Purchasing Card Transaction Processing Parameter Description L_QTYn (Required) Quantity. Character length and limitations: 12 numeric characters L_UOMn (Required)Unit of measure/code. Character length and limitations: 12 alphanumeric characters L_TAXRATEn (Optional) Tax rate applied. Character length and limitations: 4 numeric characters L_TAXTYPEn (Optional) Tax type applied.
PAGE 185

Submitting Purchasing Card Level 2 and Level 3 Transactions SecureNet Purchasing Card Transaction Processing Parameter Description TAXAMT (Required)Tax amount. The value must include a decimal and the exact amount to the cent (42.00, not 42). Do not include comma separators (1234.56 not 1,234.56). Character length and limitations: numeric LOCALTAXAMT (Optional) Local tax. Character length and limitations: 12 numeric characters TAXEXEMPT (Optional) Local tax incl flag.
PAGE 186

C Submitting Purchasing Card Level 2 and Level 3 Transactions SecureNet Purchasing Card Transaction Processing Parameter Description VATREGNUM (Required) VAT registration number. Can be part of the registration data or passed with each transaction. Character length and limitations: 20 alphanumeric characters FREIGHTAMT (Required) Unique VAT inv reference number. Can be part of the registration data or passed with each transaction.
PAGE 187

Submitting Purchasing Card Level 2 and Level 3 Transactions TSYS Acquiring Solutions Purchasing Card Transaction Processing Parameter Description L_AMTn (Optional) Line-item total. Character length and limitations: 12 numeric characters C Example SecureNet Level 3 Visa Transaction Parameter String TRXTYPE=S&TENDER=C&PARTNER=Partner&USER=User&PWD=Password&ACCT=411111111111 1111&EXPDATE=1215&AMT=1.00&BILLTOSTREET=5199 JOHNSON&TAXAMT=1.06&BILLTOZIP= 94588&ALTTAXAMT=1.00&CUSTVATREGNUM=11111&LOCALTAXAMT=1.
PAGE 188

C Submitting Purchasing Card Level 2 and Level 3 Transactions TSYS Acquiring Solutions Purchasing Card Transaction Processing Parameter Description TAXEXEMPT (Optional) Tax amount identifier. Character length and limitations: 1 alpha character, Y or N Example TSYS Acquiring Solutions Level 2 Visa Transaction Parameter String. TRXTYPE=S&ACCT=4111111111111111&AMT=20.
PAGE 189

Submitting Purchasing Card Level 2 and Level 3 Transactions TSYS Acquiring Solutions Purchasing Card Transaction Processing C TSYS Acquiring Solutions Level 3 MasterCard Extended Data The parameters listed in the table below apply to Level 3 MasterCard transactions as extended data. Parameter Description FREIGHTAMT (Optional) Freight amount. Character length and limitations: 12 numeric characters DUTYAMT (Optional) Duty amount.
PAGE 190

C Submitting Purchasing Card Level 2 and Level 3 Transactions TSYS Acquiring Solutions Purchasing Card Transaction Processing Parameter Description L_DISCOUNTn (Optional) Discount amount. Character length and limitations: 12 numeric characters Example TSYS Acquiring Solutions Level 3 MasterCard Transaction Parameter String TRXTYPE=S&TENDER=C&PARTNER=Partner&USER=User&PWD=Password&ACCT=552500000000 0005&EXPDATE=1215&AMT=1.00&BILLTOSTREET=5199 JOHNSON&BILLTOZIP=94588&ALTTAX AMT=1.
PAGE 191

Submitting Purchasing Card Level 2 and Level 3 Transactions TSYS Acquiring Solutions Purchasing Card Transaction Processing Parameter Description INVNUM (Required) Purchase order number/customer reference ID. The value of PNREF is sent if the INVNUM parameter is not provided. Character length and limitations: 9 alphanumeric characters C TSYS Acquiring Solutions Level 3 Visa Extended Data The parameters listed in the table below apply to Level 3 Visa transactions as extended data.
PAGE 192

C Submitting Purchasing Card Level 2 and Level 3 Transactions TSYS Acquiring Solutions Purchasing Card Transaction Processing TSYS Acquiring Solutions Level 3 Visa Line Item Detail Records NOT E : For these values, n is a sequence counter that should begin with 1 and increase in sequence. Each line item should also contain quantity (L_QTYn) and unit price (L_COSTn) fields. Parameter Description L_COMMCODEn (Optional) Item commodity code.
PAGE 193

Submitting Purchasing Card Level 2 and Level 3 Transactions Vantiv Purchasing Card Transaction Processing C Vantiv Purchasing Card Transaction Processing The following parameters are recommended to obtain the best rates for Level 2 and Level 3 purchasing card transactions with Vantiv. Vantiv Purchasing Parameters Field Description SHIPTOCOUNTRY (Optional) Destination country code. Visa and MasterCard are different.
PAGE 194

C Submitting Purchasing Card Level 2 and Level 3 Transactions WorldPay Purchasing Cards Transaction Processing Vantiv Line Item Parameters Field Description L_QTYn (Required) Quantity (whole units only). Character length and limitations: 10 numeric characters L_COMMCODEn (Optional) Item commodity code. Character length and limitations: 12alphanumeric characters L_DESCn (Optional) Item description. Character length and limitations: 35 alphanumeric characters L_UOMn (Optional) Item unit of measure.
PAGE 195

Submitting Purchasing Card Level 2 and Level 3 Transactions WorldPay Purchasing Cards Transaction Processing Level 2 Parameters Description COUNTRYCODE (Optional) Country code. Character length and limitations: 3 alphanumeric characters CUSTDATA (Optional) Generic data the merchant can pass to the WorldPay processor. Character length and limitations: 95 alphanumeric characters CUSTOMERID (Optional) Purchase order number.
PAGE 196

C Submitting Purchasing Card Level 2 and Level 3 Transactions WorldPay Purchasing Cards Transaction Processing Level 2 Parameters Description MISCDATA (Optional) Miscellaneous data. Character length and limitations: 95 alphanumeric characters ORDERDATE (Required) Order date. The format is MMDDYY with no slashes or dashes. For example, July 28, 2011 is 072811. Character length and limitations: 6 numeric characters PONUM (Optional) Purchase order number.
PAGE 197

Submitting Purchasing Card Level 2 and Level 3 Transactions WorldPay Purchasing Cards Transaction Processing Level 3 Parameters Description L_ALTTAXRATEn (Optional) Alternate tax rate for this item. Character length and limitations: 4 numeric characters plus decimal: XX.XX L_ALTTAXIDn (Optional) Alternate tax identifier for this item. Character length and limitations: 95 alphanumeric characters L_EXTAMTn (Optional) Extended item amount.
PAGE 198

C 198 Submitting Purchasing Card Level 2 and Level 3 Transactions WorldPay Purchasing Cards Transaction Processing 31 July 2012 Gateway Developer Guide and Reference
PAGE 199

D VERBOSITY: Viewing ProcessorSpecific Transaction Results Set the VERBOSITY parameter to HIGH to view the processor’s raw response values and additional values. This setting returns multiple parameters. Select only the returned parameters that you want to handle and disregard the rest. NOT E : VERBOSITY is being deprecated in future Gateway releases.
PAGE 200

D 200 VERBOSITY: Viewing Processor-Specific Transaction Results 31 July 2012 Gateway Developer Guide and Reference
PAGE 201

E ISO Country Codes The Gateway API uses the International Standards Organization (ISO) 3166-1 numeric country codes in the following fields: BILLTOCOUNTRY and SHIPTOCOUNTRY. For a complete list of the current officially assigned ISO 3166-1 numeric country codes, refer to: http://en.wikipedia.org/wiki/ISO_3166-1_numeric NOT E : If PayPal is your acquirer, refer instead to the “Countries and Regions Supported by PayPal” on page 225.
PAGE 202

E 202 ISO Country Codes 31 July 2012 Gateway Developer Guide and Reference
PAGE 203

F Codes Used by FDMS South Only The following codes are used by FDMS South only.
PAGE 204

F 204 Codes Used by FDMS South Only MasterCard Country Codes for FDMS South Only BELIZE BLZ BENIN BEN BERMUDA BMU BHUTAN BTN BOLIVIA BOL BOSNIA AND HERZEGOVINA BIH BOTSWANA BWA BOUVET ISLAND BVT BRAZIL BRA BRITISH INDIAN OCEAN TERRITORY IOT BRUNEI BRN BULGARIA BGR BURKINA FASO BFA BURUNDI BDI CAMBODIA KHM CANADA CAN CAPE VERDE CPV CAYMAN ISLANDS CYM CENTRAL AFRICAN REPUBLIC CAF CHAD TCD CHILE CHL CHINA CHN CHRISTMAS ISLAND CXR CMEROON, UNITED REP.
PAGE 205

Codes Used by FDMS South Only MasterCard Country Codes for FDMS South Only CYPRUS CYP CZECH REPUBLIC CZE DENMARK DNK DJIBOUTI DJI DOMINICA DMA DOMINICAN REPUBLIC DOM EL SALVADOR SLV EQUATORIAL GUINEA GNQ ESTONIA EST ETHIOPIA ETH FAEROE ISLANDS FRO FALKLAND ISLANDS (MALVINAS) FLK FIJI FJI FINLAND FIN FRANCE FRA FRENCH GUIANA GUF FRENCH POLYNESIA PYF FRENCH SOUTHERN TERRITORIES ATF GABON GAB GAMBIA GMB GEORGIA GEO GERMAN DEMOCRATIC REP DDR GERMANY DEU GHANA GHA
PAGE 206

F 206 Codes Used by FDMS South Only MasterCard Country Codes for FDMS South Only GUINEA-BISSAU GNB GUYANA GUY HAITI HTI HEARD AND MCDONALD ISLANDS HMD HONDURAS HND HONG KONG HKG HUNGARY HUN ICELAND ISL INDIA IND INDONESIA IDN IRAN IRN IRAQ IRQ IRELAND IRL ISRAEL ISR ITALY ITA JAMAICA JAM JAPAN JPN JORDAN JOR KAZAKHSTAN KAZ KENYA KEN KOREA, REPUBLIC OF KOR KUWAIT KWT KYRGYZSTAN KGZ LAO PEOPLES DEMOCRATIC LAO LATVIA LVA LEBANON LBN LESOTHO LSO LIBERIA
PAGE 207

Codes Used by FDMS South Only MasterCard Country Codes for FDMS South Only MACAU MAC MALAYSIA MYS MALDIVES MDV MALI MLI MALTA MLT MANACO MCO MARSHALL ISLANDS MHL MARTINIQUE MTQ MAURITANIA MRT MAURITIUS MUS MEXICO MEX MICRONESIA FSM MOLDOVA MDA MONGOLIA MNG MONTSERRAT MSR MOROCCO MAR MOZAMBIQUE MOZ MYANMAR MMR NAMIBIA NAM NAURU NRU NEGEL SEN NEPAL NPL NETHERLANDS NLD NETHERLANDS ANTILLES ANT NEW CALEDONIA NCL NEW ZEALAND NZL NICARAGUA NIC NIGER NER NIG
PAGE 208

F 208 Codes Used by FDMS South Only MasterCard Country Codes for FDMS South Only NORWAY NOR OMAN OMN PAKISTAN PAK PALAU PLW PANAMA PAN PAPUA NEW GUINEA PNG PARAGUAY PRY PERU PER PHILIPPINES PHI PITCAIRN ISLAND PCN POLAND POL PORTUGAL PRT PUERTO RICO PRI QATAR QAT REUNION REU ROMANIA ROM RUSSIAN FEDERATION RUS RWANDA RWA SAMOA WSM SAN MARINO SMR SAN TOME AND PRICIPEL STP SAUDI ARABIA SAU SEYCHELLES SYC SIERRA LEONA SLE SINGAPORE SGP ST. HELENA SHN ST.
PAGE 209

Codes Used by FDMS South Only MasterCard Country Codes for FDMS South Only SVALBARD AND JAN MAYEN ISLANDS SJM SWAZILAND SWZ SWEDEN SWE SWITZERLAND CHE SYRIAN ARAB REPUBLIC SYR TAIWAN, PROVIDENCE OF CHINA TWN TAJIKISTAN TJK TANZANIA, UNITED REPUBLIC TZA THAILAND THA TOGO TGO TOKELAU TKL TONGA TON TRINIDAD AND TOBAGO TTO TUNISIA TUN TURKEY TR TURKMENISTAN TM TURKS AND CAICOS ISLANDS TC TUVALU TUV U.S. MINOR OUTLYING ISL.
PAGE 210

F Codes Used by FDMS South Only Visa Country Codes WALLIS AND FUTUNA IS WLF WESTERN SAHARA ESH YEMEN YEM YUGOSLAVIA YUG ZAIRE ZAR ZAMBIA ZMB ZIMBABWE RHO Visa Country Codes 210 ALBANIA AL ALGERIA DZ AMERICAN SAMOA AS ANDORRA AD ANGOLA AO ANGUILLA AI ANTARCTICA AQ ANTIGUA AG APHGANISTAN AF ARGENTINA AR ARMENIA AM ARUBA AW AUSTRALIA AU AUSTRIA AT AZERBAIJAN AZ BAHAMAS BS BAHRAIN BH BANGLADESH BD BARBADOS BB BELARUS BY BELGIUM BE 31 July 2012 Gateway
PAGE 211

Codes Used by FDMS South Only Visa Country Codes BELIZE BZ BENIN BJ BERMUDA BM BHUTAN BT BOLIVIA BO BOSNIA AND HERZEGOVINA BA BOTSWANA BW BOUVET ISLAND BV BRAZIL BR BRITISH INDIAN OCEAN TERRITORY IO BRUNEI BN BULGARIA BG BURKINA FASO BF BURUNDI BI CAMBODIA KH CANADA CA CAPE VERDE CV CAYMAN ISLANDS KY CENTRAL AFRICAN REPUBLIC CF CHAD TD CHILE CL CHINA CN CHRISTMAS ISLAND CX CMEROON, UNITED REP.
PAGE 212

F 212 Codes Used by FDMS South Only Visa Country Codes CZECH REPUBLIC CZ DENMARK DK DJIBOUTI DJ DOMINICA DM DOMINICAN REPUBLIC DO EAST TIMOR TP ECUADOR EC EGYPT EG EL SALVADOR SV EQUATORIAL GUINEA GQ ESTONIA EE ETHIOPIA ET FAEROE ISLANDS FK FALKLAND ISLANDS (MALVINAS) FK FIJI FJ FINLAND FI FRANCE FR FRENCH GUIANA GF FRENCH METROPOLITAN FX FRENCH POLYNESIA PF FRENCH SOUTHERN TERRITORIES TF GABON GA GAMBIA GM GEORGIA GE GERMANY DE GHANA GH GIBRALTER GI
PAGE 213

Codes Used by FDMS South Only Visa Country Codes GUATEMALA GT GUINEA GN GUINEA-BISSAU GW GUYANA GY HAITI HT HEARD AND MCDONALD ISLANDS HM HONDURAS HN HONG KONG HK HUNGARY HU ICELAND IS INDIA IN INDONESIA ID IRAN IR IRAQ IQ IRELAND IE ISRAEL IL ITALY IT JAMAICA JM JAPAN JP JORDAN JO KAZAKHSTAN KZ KENYA KE KIRIBATI KI KOREA, REPUBLIC OF KR KUWAIT KW KYRGYZSTAN KG LAO PEOPLES DEMOCRATIC LA LATVIA LV LEBANON LB LESOTHO LS LIBERIA LR LIBYAN ARAB JAMA
PAGE 214

F 214 Codes Used by FDMS South Only Visa Country Codes LIECHTNSTIEN LI LITHUANIA LT LUXEMBOURG LU MACAU MO MACEDONIA MK MADAGASCAR MG MALAWI MW MALAYSIA MY MALDIVES MV MALI ML MALTA MT MANACO MC MARSHALL ISLANDS MH MARTINIQUE MQ MAURITANIA MR MAURITIUS MU MAYOTTE YT MEXICO MX MICRONESIA FM MOLDOVA MD MONGOLIA MN MONTSERRAT MS MOROCCO MA MOZAMBIQUE MZ MYANMAR MM NAMIBIA NA NAURU NR NEPAL NP NETHERLANDS NL NETHERLANDS ANTILLES AN NEW CALDONIA NC
PAGE 215

Codes Used by FDMS South Only Visa Country Codes NICARAGUA NI NIGER NE NIGERIA NG NIUE NU NORFOLK ISLAND NF NORTHERN MARIANA ISLAND MP NORWAY NO OMAN OM PAKISTAN PK PALAU PW PANAMA PA PAPUA NEW GUINEA PG PARAGUAY PY PERU PE PHILIPPINES PH PITCAIRN ISLAND PN POLAND PL PORTUGUL PT PUERTO RICO PR QATAR QA REUNION RE ROMANIA RO RUSSIAN FEDERATION RU RWANDA RW SAMOA WS SAN MARINO SM SAN TOME AND PRICIPEL ST SAUDI ARABIA SA SENEGAL SN SEYCHELLES SC SIER
PAGE 216

F 216 Codes Used by FDMS South Only Visa Country Codes ST. HELENA SH ST. KITTS-NEVIS-ANGUILLA KN ST. LUCIA LC ST. PIERRE AND MIQUELON PM ST.
PAGE 217

Codes Used by FDMS South Only Units of Measure UZBEKISTAN UZ VANUATU VU VATICAN CITY STATE VA VENEZUELA VE VIETNAM VN VIRGIN ISLANDS BRITISH VG VIRGIN ISLANDS US VI WALLIS AND FUTUNA IS WF WESTERN SAHARA EH YEMEN YE YUGOSLAVIA YU ZAIRE ZR ZAMBIA ZM ZIMBABWE ZW F Units of Measure Acre (4840 yd2) ACR Alcoholic strength by mass ASM Alcoholic strength by volume ASV Ampere* AMP Ampere=hour (3,6 kC)* AMH Are (100 m2) ARE Bar* BAR Barrel (petroleum) (158,987 dm3) BLL B
PAGE 218

F Codes Used by FDMS South Only Units of Measure Bushel (35,2391 dm3) BUA Bushel (36,36874 dm3) BUI Candela* CDL Carrying capacity in metric tonnes CCT Cental GB (45,359237 kg) CNT Center, metric (100 kg) (syn.
PAGE 219

Codes Used by FDMS South Only Units of Measure Dozen DZN Dozen packs DZP Dozen pairs DZR Dozen pieces DCP Dozen rolls DRL Drachm GB (3,887935 g) DRM Dram GB (1,771745 g) DRI Dram US (3,887935 g) DRA Dry Barrel (115,627 dm3) BLD Dry gallon (4,404884 dm3) GLD Dry pint (0,55061 dm3) PTD Dry quart (1,101221 dm3) QTD Farad* FAR Fluid ounce (28,413 cm3) OZI Fluid ounce (29,5735 cm3) OZA Foot (0,3048 m) FOT Gallon (4,546092 dm3) GLI Gigabecquerel* GBQ Gigawatt-hour (1 million k
PAGE 220

F 220 Codes Used by FDMS South Only Units of Measure Hectolitre of pure alcohol HPA Hectolitre* HLT Hectometre* HMT Hertz* HTZ Hour* HUR Hundred CEN Hundred boxes BHX Hundred international units HIU Hundred leaves CLF Hundred packs CNP Hundredweight US (45,3592 kg) CWA Inch (25,4 mm) INH Joule* JOU Kelvin* KEL Kilobar* KBA Kilogram of caustic potash KPH Kilogram of caustic soda KSH Kilogram of named substance KNS Kilogram of nitrogen KNI Kilogram of phosphonic anhydr
PAGE 221

Codes Used by FDMS South Only Units of Measure Kilopascal* KPA Kilorgram of uranium KUR Kilotonne* KTN Kilovar KVR Kilovolt* KVT Kilovolt-ampere* KVA Kilowatt* KWT Kilowatt-hour* KWH Knot (1 nautical mile per hour) KNT Leaf LEF Liquid gallon (3,78541 dm3) GLL Liquid pint (0,473176 dm3) PTL Liquid quart (0,946353 dm3) QTL Litre (1 dm3)* LTR Litre of pure alcohol LPA Long ton GB, US (1,0160469 t) LTN (long) hundredweight GB (50,802345 kg) CWI Lumen* LUM Lux LUX Megahertz
PAGE 222

F 222 Codes Used by FDMS South Only Units of Measure Millibar* MBR Millicurie MCU Milligram* MGM Millilitre* MLT Millimetre* MMT Million MIO Million cubic metres* HMQ Million international units MIU Minute* MIN Month MON Nautical mile (1852 m) NMI Net (register) ton NTT Newton* NEW Number NMB Number of articles NAR Number of bobbons NBB Number of cells* NCL Number of international units NIU Number of packs NMP Number of pairs NMR Number of parcels NPL Number of p
PAGE 223

Codes Used by FDMS South Only Units of Measure Quart (1,136523 dm3) QTI Quarter (of a year) QAN Quarter, GB (12,700586 kg) QTR Quintal, metric (100 kg) DTN Revolution per minute* RPM Revolution per second* RPS Score SCO scruple, GB (1,2955982 g) SCR Second* SEC Set SET Shipping ton SHT Short standard (7200 matches) SST Short ton GB, US (0,90718474 t) STN Siemens* SIE Square centimetre* CMK Square decimetre* DMK Square foot FTK Square inch INK Square kilometre* KMK Squa
PAGE 224

F 224 Codes Used by FDMS South Only Units of Measure Thousand board feet (2,36 m3) MBF Thousand cubic metres per day* TQD Thousand standard brick equivalent MBE Ton of steam per hour TSH Tonne (1000 kg)* TNE Tonne of substance 90 percent dry TSD Trillion EUR TRL Trillion US BIL Troy ounce APZ Troy pound, US (373,242 g) LBT Volt* VLT Watt* WTT Watt-hour* WHR Weber WEB Week WEE Yard (0,9144 m) YRD Year ANN 31 July 2012 Gateway Developer Guide and Reference
PAGE 225

G PayPal Acquirer If PayPal is your acquirer and no other bank is involved in processing your transactions, use the following PayPal specific codes. Countries and Regions Supported by PayPal PayPal uses 2-character IS0-3166-1 codes for specifying countries and regions that are supported in fields and variables. For a complete list of countries and regions supported by PayPal and their 2-character ISO3166-1 codes, please refer to the PayPal API reference list of Countries and Regions.
PAGE 226

G 226 PayPal Acquirer PayPal Currency Codes 31 July 2012 Gateway Developer Guide and Reference
PAGE 227

H Additional Processor Information Moneris Solutions The Moneris Solutions processor has the following characteristics:    It supports ecommerce and mail order or telephone order (MOTO) transactions. It supports the four basic credit card types: American Express, Discover, MasterCard, and Visa. To process live transactions, it requires undergoing a certification process. For details, see the Moneris Receipts Specification available on the PayPal developer website.
PAGE 228

Additional Processor Information Moneris Solutions 228 31 July 2012 Gateway Developer Guide and Reference
PAGE 229

I Payflow Link Migration If you are currently using the legacy Payflow Link HTML input tag integration and you would like to use the name-value pair integration, you will need to contact PayPal Merchant Technical Support to request your account to be upgraded to the new version of Payflow. Before you request an upgrade, it is important that you understand the differences between the Payflow Link legacy parameters and the equivalent Payflow parameters.
PAGE 230

I 230 Payflow Link Migration Migrating from a legacy Payflow Link Integration Payflow Link Legacy Parameter Payflow Parameter CSCMATCH CVV2MATCH CUSTID CUSTID DESCRIPTION N/A DLNUM DLNUM EMAIL BILLTOEMAIL EMAILTOSHIP SHIPTOEMAIL EXPDATE EXPDATE FAX BILLTOFAX FAXTOSHIP SHIPTOFAX FIRSTNAME BILLTOFIRSTNAME INVOICE INVNUM LASTNAME BILLTOLASTNAME LOGIN VENDOR METHOD TENDER NAME BILLTOFIRSTNAME BILLTOLASTNAME NAMETOSHIP SHIPTOFIRSTNAME SHIPTOLASTNAME PARTNER PARTNER PHONE B