Gateway Developer Guide and Reference PayPal Payments Advanced PayPal Payments Pro Payflow Pro Payflow Link Last updated: 07 February 2013 Gateway Developer Guide and Reference
Document Number: 200045.en_US-201302 © 2013 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., Société en Commandite par Actions.
Content Chapter Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Who Should Use This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Revision History . . . . . . . . . . . . . . . . . .
Content Configuring Hosted Pages Using PayPal Manager . . . . . . . . . . . . . . . . . . . . . 37 Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Customize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Integrate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Using a Secure Token to Pass Hosted Pages Customization Parameters . . . . . . . . . 41 Using the PARMLIST Parameter. . . . . . .
Content Core Credit Card Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 Submitting Account Verifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 When To Use Account Verifications . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Required Account Verification Parameters . . . . . . . . . . . . . . . . . . . . . . . 62 Example Account Verification String . . . . . . . . . . . . . . . . . . . . . . . . . . .
Content Additional Parameters For Sale Transactions . . . . . . . . . . . . . . . . . . . . . . 77 Typical Sale Transaction Parameter String . . . . . . . . . . . . . . . . . . . . . . . 78 Submitting Soft Merchant Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 About Soft Merchant Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Ways to Send Soft Merchant Information . . . . . . . . . . . . . . . . . . . . . . . .
Content RESULT Values and RESPMSG Text . . . . . . . . . . . . . . . . . . . . . . . . . . . .102 RESULT Values For Communications Errors . . . . . . . . . . . . . . . . . . . . . .108 Chapter A Processors Requiring Additional Transaction Parameters 111 American Express Additional Credit Card Parameters . . . . . . . . . . . . . . . . . . . 111 Retail Transaction Advice Addendum (for SWIPE transactions) . . . . . . . . . . . . 111 Internet Transaction Data . . . . . . . . . . . . . . . . . . . . . . . .
Content TeleCheck NFTF Overview of Services . . . . . . . . . . . . . . . . . . . . . . . . . . .137 TeleCheck NFTF Processing Overview . . . . . . . . . . . . . . . . . . . . . . . . . . .137 NFTF Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137 NFTF Processing Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . .139 NFTF Guidelines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139 TeleCheck Parameters . . . . . . . . . . . .
Content Example Elavon Level 2 Transaction Parameter String . . . . . . . . . . . . . . . . .161 First Data Merchant Services (FDMS) Nashville Purchasing Card Transaction Processing.161 FDMS Nashville Commercial Card Parameters . . . . . . . . . . . . . . . . . . . . .161 First Data Merchant Services (FDMS) North Purchasing Card Transaction Processing . .162 FDMS North Purchasing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . .162 FDMS North Purchasing Card Line Item Parameters . . . . . . .
Content TSYS Acquiring Solutions Purchasing Card Transaction Processing . . . . . . . . . . . .195 TSYS Acquiring Solutions Level 2 Parameters . . . . . . . . . . . . . . . . . . . . .195 TSYS Acquiring Solutions Level 3 MasterCard Parameters. . . . . . . . . . . . . . .196 TSYS Acquiring Solutions Level 3 Visa Parameters. . . . . . . . . . . . . . . . . . .198 Vantiv Purchasing Card Transaction Processing . . . . . . . . . . . . . . . . . . . . . .201 Vantiv Purchasing Parameters. . . . . . . . . . . . .
Content Chapter J Payflow Link Migration . . . . . . . . . . . . . . . . . . 245 Migrating from a legacy Payflow Link Integration . . . . . . . . . . . . . . . . . . . . . .245 Chapter K Payflow Gateway MagTek Parameters . . . . . . . . . . . 247 MagTek MagneSafe Secure Card Readers and Qwick Codes . . . . . . . . . . . . . . .247 MagneSafe Secure Card Reader Authenticators . . . . . . . . . . . . . . . . . . . .247 MagTek Qwick Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Content 12 07 February 2013 Gateway Developer Guide and Reference
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.
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.
Preface Intended Audience 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.
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.
Preface Revision History Revision History Revision History for the Gateway Developer Guide and Reference: Date Description 28 Jan 2013 Added a new Appendix on Payflow Header Parameters. Added information about duplicate parameters in the Name-Value Parameter Syntax Guidelines. In the Hosted Pages Chapter, added the Passing Other Data to Your Server Using Post or Silent Post section, and clarified that Silent Posts are returned for both approved and declined transactions.
Preface Revision History Date Description 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. Added DATE_TO_SETTLE to Credit Card Transaction Responses parameters table. Added a note to the About Credit Card Processing section. 23 July 2012 Added the Bill Me Later feature to the Gateway Product Details section.
Preface Revision History Date Description Updated TeleCheck chapter: Updated MICR values in Testing TeleCheck Transactions section Added TeleCheck Adjustment Response Code Values table Updated parameters and examples: Added a description for response parameters HOSTCODE, RESPTEXT, PROCCARDSECURE, ADDLMSGS and an explanation on how to use these parameters to obtain the processor’s raw response codes and response messages.
Preface Revision History Date Description January 2012 (cont.
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.
Preface Revision History 22 07 February 2013 Gateway Developer Guide and Reference
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.
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.
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
1 Introducing the Gateway Checkout Solutions About Security 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). Purchasing card Level 2 and Level 3 parameters provide specialized reporting so an employer can monitor card use.
Introducing the Gateway Checkout Solutions About Security 1 Numbers in the figure correspond to the numbered comments below: 1. The customer clicks Buy to purchase merchandise on your website. 2. You request a secure token by passing a token ID to the Gateway server. 3. The Gateway server returns the secure token and your token ID to your website. 4. You submit the secure token and token ID in an HTTP post to pages hosted on the Gateway server and redirect the customer’s browser to the hosted pages. 5.
1 Introducing the Gateway Checkout Solutions Processing Platforms Supporting Card-Present Transactions Implementing Transparent Redirect is very similar to implementing hosted pages. It differs only in the steps shown in boldface below: 1. The customer clicks Buy to purchase merchandise on your website. 2. You request a secure token by passing a secure token ID to the Gateway server. In the request, you pass the name-value pair, SILENTTRAN=TRUE.
Introducing the Gateway Checkout Solutions Supported Payment Types 1 Moneris Solutions Paymentech Salem Paymentech Tampa PayPal SecureNet TeleCheck TSYS Acquiring Solutions Vantiv WorldPay Supported Payment Types Credit cards PayPal (supported by PayPal’s Express Checkout product) Pinless debit cards Electronic checks Check cards Purchasing cards (also referred to as commercial cards, corporate cards, procurement cards, or business cards) Level 2 and Level 3 Automated Clearing House (ACH).
1 Introducing the Gateway Checkout Solutions Recurring Billing Service 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. You enroll separately for the Recurring Billing Service. You can learn about the Recurring Billing Service in the Payflow Pro – Recurring Billing Service User’s Guide.
2 Secure Token This section describes the secure token. “Secure Token” on page 31 “Integrating the Secure Token With the Hosted Checkout Pages” on page 31 “Integrating the Secure Token Without the Hosted Checkout Pages: Transparent Redirect” on page 32 “Posting To the Hosted Checkout Page” on page 34 “Using the PARMLIST Parameter” on page 44 About the Secure Token Use a secure token to send non-credit card transaction data to the Gateway server for safer storage.
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.
Secure Token Secure Token Errors 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.
2 Secure Token Posting To the Hosted Checkout Page 160 Secure Token already been used. Indicates that the secure token has expired due to either a successful transaction or the token has been used three times while trying to successfully process a transaction. You must generate a new secure token. 161 Transaction using secure token is already in progress. This could occur if a customer hits the submit button two or more times before the transaction completed. 162 Secure Token Expired.
Secure Token Posting To the Hosted Checkout Page 2 For more information on the Payflow parameters that are used to pass information to the Gateway hosted checkout pages, see “Using a Secure Token to Pass Hosted Pages Customization Parameters” on page 41 The following example uses Payflow name-value pairs to pass values in a form post to the hosted checkout pages. For details on the name-value pair strings used in this example, see “Sending a Simple Transaction to the Server” on page 51.
2 36 Secure Token Posting To the Hosted Checkout Page 07 February 2013 Gateway Developer Guide and Reference
3 Configuring Hosted Checkout Pages This chapter describes the following: “Configuring Hosted Checkout Pages” on page 37 “Configuring Hosted Pages Using PayPal Manager” on page 37 “Using a Secure Token to Pass Hosted Pages Customization Parameters” on page 41 “Hosted Pages and Mobile Browsers” on page 45 “Silent Posts” on page 47 “Passing Other Data to Your Server Using Post or Silent Post” on page 48 Configuring Hosted Checkout Pages PayPal enables you to customize the hosted check
3 Configuring Hosted Checkout Pages Configuring Hosted Pages Using PayPal Manager Setup The Setup page in PayPal Manager enables you to select the information you want to collect from buyers and what you want displayed on your hosted checkout pages. This includes selecting the billing and the shipping information information fields, the payment confirmation page settings, the confirmation email details, security options and other settings.
Configuring Hosted Checkout Pages Configuring Hosted Pages Using PayPal Manager 3 developer portal. For more information on the Silent Post feature, go to “Silent Posts” on page 47 Customize The Customize page allows you to customize the layout and appearance of your hosted checkout page. You can customize the header, background, payment method section and the order summary column of your payment page. PayPal offers three design layouts for you to choose from.
3 Configuring Hosted Checkout Pages Configuring Hosted Pages Using PayPal Manager On the Customize page, you can either change the design of your existing layout, or select and customize a different layout. To make changes, double-click on the section of the template you are trying to modify or the corresponding Click to Edit button for that section. In the pop-up that appears, click the color selector to change the color, or enter the appropriate URL.
Configuring Hosted Checkout Pages Using a Secure Token to Pass Hosted Pages Customization Parameters 3 Page Background (Applicable to Layout B only) - You can change the following: – Background color – Footer text color – Upload a background image - .jpg, .jpeg, .gif, or .png. The maximum allowable image size is 100kb.
3 Configuring Hosted Checkout Pages Using a Secure Token to Pass Hosted Pages Customization Parameters The table below describes the form post parameters that you can use to dynamically configure the hosted checkout pages. Setup Params 42 Variable Description CANCELURL The URL that customers would go to if pressing a Cancel link from the hosted page (Layouts A and B only) and from the Express Checkout flow if the buyer chooses Express Checkout as their payment method. Maximum length: 512 characters.
Configuring Hosted Checkout Pages Using a Secure Token to Pass Hosted Pages Customization Parameters 3 Customize Params Variable Description PAGECOLLAPSEBGCOLOR Sets the color of the border around the embedded template C. Example: PAGECOLLAPSEBGCOLOR=993300 PAGECOLLAPSETEXTCOLOR Sets the color of the words “Pay with PayPal” and “Pay with credit or debit card”. Example: PAGECOLLAPSETEXTCOLOR=990000 PAGEBUTTONBGCOLOR Sets the color of the Pay Now / Submit button.
3 Configuring Hosted Checkout Pages Using the PARMLIST Parameter Variable Description 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. VERBOSITY Additional values returned from the transaction response to the merchant in the Silent Post. By default, there is no verbosity set which means the standard set of values that Silent Post currently uses is returned.
Configuring Hosted Checkout Pages Hosted Pages and Mobile Browsers 3 If you choose to use PARMLIST, then you can only pass the following 3 HTTP Post parameters to Payflow with PARMLIST: SECURETOKEN, SECURETOKENID and MODE (optional). If you try to pass in any other parameter (such as VERIFY=TRUE), then you will receive an error message. NOT E : The MODE parameter will be deprecated in the future.
3 Configuring Hosted Checkout Pages Hosted Pages and Mobile Browsers supported mobile browser and then explicitly pass the form post parameter: TEMPLATE=MOBILE.
Configuring Hosted Checkout Pages Silent Posts 3 Mobile page flow for a credit card payment Silent Posts Silent Post ensures that the transaction data is passed back to your website when a transaction is completed. The Silent Post feature uses the HTML Post method to return data to your server for both approved and declined trasactions. This occurs even if a customer closes the browser before returning to your site, or if the PayPal-hosted payment confirmation page is disabled.
3 Configuring Hosted Checkout Pages Passing Other Data to Your Server Using Post or Silent Post sure to check Void transaction when my server fails to receive data sent by the silent post when setting up Silent Posts in PayPal Manager. 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.
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 49. “Activating Your Payflow Gateway Account” on page 50. “Host URL Addresses” on page 50 NOT E : Each SDK includes full API documentation. IM PORT AN T : The Payflow SDK is available as a .NET or Java library. Using these SDKs is recommended to simplify integration.
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.
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.
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.
Sending a Simple Transaction to the Server User Parameter Data 5 Pass the connection parameters in the format and syntax required by the Payflow SDK and programming language that you are using. See your integration documentation for details. 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.
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.
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. NOT E : Some of the transaction types and features described in this chapter are not supported by all processors.
6 Submitting Credit Card Transactions Obtaining an Internet Merchant Account Obtaining an Internet Merchant Account To accept credit cards over the internet, you need a special account called an Internet Merchant Account. If PayPal is your merchant bank, you do not need the Internet Merchant Account. Your account provider or merchant (acquiring) bank works with a PayPal-supported credit card processor. Examples are First Data, TSYS Acquiring Solutions (formerly Vital Processing Services), and Paymentech.
Submitting Credit Card Transactions Credit Card Features 6 Credit Card Features The Payflow SDK supports the following transaction types for credit card processing: Transaction Type Billable Authorization Yes Account Verification No Balance Inquiry No Credit Yes Delayed Capture No Inquiry No Sale Yes Voice Authorization Yes Void Yes The Payflow SDK also supports the following credit card features: Address verification service and card security code validation Card-present (SWIP
6 Submitting Credit Card Transactions Planning Your Gateway Integration process is also useful for evaluating information in the response, such as whether the issuer verifies the billing address, and so on. Electronic goods merchants, who fulfill the order immediately, can use the one-step process. Check with your Internet Merchant Account provider for suggestions on the best method for you. Whether or how to use risk management tools such as address verification service and card security code.
Submitting Credit Card Transactions Core Credit Card Parameters 6 To accept additional credit card types, contact your acquiring bank (holding your Internet Merchant Account) and ask them to add the card type to your account. Upon notification from your acquirer that you can start accepting the card type, add the card to your Payflow account through PayPal Manager. See PayPal Manager online help for details. NOT E : American Express cards require explicit acceptance when PayPal is the processor.
6 Submitting Credit Card Transactions Core Credit Card Parameters Parameter Description EXPDATE (Required) Expiration date of the credit card. For example, 1215 represents December 2015. Limitations: mmyy format 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.
Submitting Credit Card Transactions Core Credit Card Parameters Parameter Description SWIPE (Required for card-present transactions only) Used to pass the Track 1 or Track 2 data (card’s magnetic stripe information) for card-present transactions. Include either Track 1 or Track 2 data—not both. If Track 1 is physically damaged, the point-of-sale (POS) application can send Track 2 data instead. The track data includes the disallowed = (equal sign) character.
6 Submitting Credit Card Transactions Submitting Account Verifications Parameter Description SHIPTOSTREET (Optional) Ship-to street address. Limitations: 150-character string. SHIPTOCITY (Optional) Ship-to city. Limitations: 45-character string. SHIPTOSTATE (Optional) Ship-to state. Limitations: 2-character string (Varies depending on processor: 2 to 45 characters). SHIPTOZIP (Optional) Ship-to postal code. Limitations: 10-character string. SHIPTOCOUNTRY (Optional) Ship-to country.
Submitting Credit Card Transactions Submitting Authorization/Delayed Capture Transactions Parameter Description AMT (Required) Set to 0. VERBOSITY (Required) Set to HIGH to obtain information about a partial authorization in the response. 6 Example Account Verification String The following is an example of account verification: TRXTYPE=A&TENDER=C&PARTNER=PayPal&USER=SuperUser&PWD=SuperUserPasswo rd&AMT=0.
6 Submitting Credit Card Transactions Submitting Balance Inquiry Transactions If your business provides immediate fulfillment and you are not using the PayPal processor with Fraud Protection Services, you can use a simple sale transaction instead. For details, see “Submitting Sale Transactions” on page 77. To recharge a credit card when you are not storing credit card information in your local database, perform a new reference transaction based on a sale.
Submitting Credit Card Transactions Submitting Card Present (SWIPE) Transactions 6 Processing Platforms Supporting Balance Inquiry Transactions The following processing platforms currently support pre-paid card balance inquiry transactions. This feature will be added for more processors in the near future. As more processors are added, this list will be updated accordingly.
6 Submitting Credit Card Transactions Submitting Card Present (SWIPE) Transactions Contact PayPal Customer Service to request them to set up your account properly for accepting and passing swipe data. If you plan to process card-present as well as card-not-present transactions, set up 2 separate Gateway accounts. Request that one account be set up for card-present transactions, and use it solely for that purpose. Use the other for card-not-present transactions.
Submitting Credit Card Transactions Submitting Credit Transactions 6 Card Present Transaction Syntax Use the SWIPE parameter to pass the Track 1 or Track 2 data (the card’s magnetic stripe information). Include either Track 1 or Track 2 data (up to 80 alphanumeric characters). If Track 1 is physically damaged, the POS application can send Track 2 data instead. The track data includes the disallowed = (equal sign) character.
6 Submitting Credit Card Transactions Submitting Credit Transactions transactions. To submit a credit transaction when non-referenced credits are not allowed, 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.
Submitting Credit Card Transactions Submitting Inquiry Transactions 6 Fields Copied From the Original Transaction Into the Credit Transaction The following fields are copied from the original transaction into the credit transaction (if they exist in the original transaction). If you provide a new value for any of these parameters when submitting the credit transaction, the new value is used. (Exceptions are ACCT, EXPDATE, and SWIPE. These parameters retain their original values.
6 Submitting Credit Card Transactions Submitting Inquiry Transactions When To Use an Inquiry Transaction You perform an inquiry using a reference to an original transaction—either the PNREF value returned for the original transaction or the CUSTREF value that you specified for the original transaction. You can also perform an inquiry using the secure token.
Submitting Credit Card Transactions Submitting Inquiry Transactions Parameter Description STARTTIME (Optional) For inquiry transactions when using CUSTREF to specify the transaction. STARTTIME specifies the beginning of the time period during which the transaction specified by the CUSTREF occurred. ENDTIME must be less than 30 days after STARTTIME. You cannot perform an inquiry across a date range greater than 30 days. If you set ENDTIME, and not STARTTIME, STARTTIME defaults to 30 days before ENDTIME.
6 Submitting Credit Card Transactions Submitting Partial Authorizations Inquiry Parameter String Using the Secure Token The following is an example inquiry request string with the SECURETOKEN parameter. TRXTYPE=I&TENDER=C&PARTNER=PayPal&PWD=SuperUserPassword&USER=SuperMerchant& VERBOSITY=HIGH&VENDOR=SuperMerchant&SECURETOKEN=FmyM1y7wy8kiS6aumnMPhTQN&VE RBOSITY=HIGH The following is the response string.
Submitting Credit Card Transactions Submitting Purchasing Card Transactions Parameter Description PARTIALAUTH (Required) Set to Y to submit a partial authorization. Limitations: 1 alphanumeric character. VERBOSITY (Required) Set to HIGH to obtain information about a partial authorization in the response. 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.
6 Submitting Credit Card Transactions Submitting Reference Transactions (Tokenization) To obtain the best bank interchange rates for commercial cards, pass specific additional transaction information. Purchasing card support and parameters vary from processor to processor. See “Submitting Purchasing Card Level 2 and 3 Transactions” on page 151. NOT E : The PayPal processor does not support purchasing card transactions.
Submitting Credit Card Transactions Submitting Reference Transactions (Tokenization) 6 Transaction Types That Can Be Used As the Original Transaction You can reference the following transaction types to supply data for a new sale or authorization transaction: Authorization (To capture the funds for an approved authorization transaction, be sure to perform a delayed capture transaction—not a reference transaction.
6 Submitting Credit Card Transactions Submitting Reference Transactions (Tokenization) TRXTYPE=A&TENDER=C&PWD=x1y2z3&PARTNER=PayPal&VENDOR=SuperMerchant&USER=Supe rMerchant&ACCT=5555555555554444&EXPDATE=1215&AMT=100.00&INVNUM=123456789&BI LLTOSTREET=5199 MAPLE&BILLTOZIP=94588 Note the value of the PNREF in the response: RESULT=0&PNREF=VXYZ01234567&RESPMSG=APPROVED&AUTHCODE=123456&AVSADDR=Y&AVSZ IP=N NOT E : The PNREF returned in the original transaction is valid in reference transactions for 12 months.
Submitting Credit Card Transactions Submitting Sale Transactions 6 EXPDATE This is an example upload transaction request: TRXTYPE=L&TENDER=C&ACCT=5105105105105100&EXPDATE=1215&BILLTOFIRSTNAME=Ted&B ILLTOLASTNAME=Smith&BILLTOSTREET=123&BILLTOCITY=SanJose&BILLTOSTATE=CA&BILL TOZIP=12345&BILLTOPHONENUM=123-123-1234 This is the response: RESULT=0&PNREF=v19A2E710FCF&RESPMSG=Approved&TRANSTIME=2011-11-02 16:53:58 You can send shipping and billing information to be stored, but you must not include the AMT
6 Submitting Credit Card Transactions Submitting Soft Merchant Information NOT E : The pinless debit tender type requires essentially the same parameters as a credit card transaction. In addition to the values required by all transactions, pass values for the ACCT and AMT parameters. The First Data Merchant Services (FDMS) South processing platform supports sale and credit transactions only. Typical Sale Transaction Parameter String The following is a typical NVP string passed in a sale transaction.
Submitting Credit Card Transactions Submitting Soft Merchant Information 6 Ways to Send Soft Merchant Information There are 2 ways you can send soft merchant information: Soft merchant information (SM Record) Merchant descriptor (M Record) The Paymentech processor requires that you follow their guidelines to send soft descriptor information using either of these methods. Soft Merchant Information (SM Record) Soft merchant information is for American Express credit cards only.
6 Submitting Credit Card Transactions Submitting Voice Authorization Transactions Submitting Voice Authorization Transactions A voice authorization (TRXTYPE=F) is a transaction that the processing network authorizes over the phone. NOT E : The PayPal processor does not support voice authorization 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.
Submitting Credit Card Transactions Submitting Void Transactions 6 PayPal will issue an authorization reversal as part of the void transaction for debit and credit cards if the processor supports it. Because the bank or issuer ultimately decides whether to honor authorization reversals, there is no accurate way to determine if an authorization reversal was completed and the hold on funds has been removed.
6 Submitting Credit Card Transactions Using Address Verification Service SHIPTOFIRSTNAME SHIPTOMIDDLENAME SHIPTOLASTNAME SHIPTOSTATE SHIPTOSTREET SHIPTOZIP BILLTOSTATE BILLTOSTREET SWIPE TAXAMT BILLTOPHONENUM TAXEXEMPT BILLTOZIP 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 t
Submitting Credit Card Transactions Using Card Security Code 6 In this example response, the address value matches the value in the bank’s records, but the zip code does not. The AVSZIP response is N. RESULT=0&PNREF=VXW412345678&RESPMSG=APPROVED&AUTHCODE=123456&AVSADDR=Y&AVSZ IP=N&IAVS=X 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.
6 84 Submitting Credit Card Transactions Using Card Security Code 07 February 2013 Gateway Developer Guide and Reference
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 50.
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.
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
7 88 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
Testing Transactions Processors Other Than PayPal RESULT value Definition How to test using Payflow Gateway 114 CVV2 Mismatch Use the AMOUNT 1114.
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.
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.
7 92 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
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 07 February 2013 7 93
7 94 Testing Transactions PayPal Processor 07 February 2013 Gateway Developer Guide and Reference
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.
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.
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.
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.
Transaction Responses Address Verification Service Responses From PayPal PayPal processor AVS 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 Unavailable X X W Whole Zi
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.
Transaction Responses BALAMT Response and Stored Value Cards PayPal Processor CVV2 Code PayPal Processor Code Description All other 8 PROCVV2MATCH 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.
8 Transaction Responses RESULT Values and RESPMSG Text 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.
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.
8 104 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.
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.
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 Failed to lock terminal number. Please try again later.
Transaction Responses RESULT Values and RESPMSG Text RESULT RESPMSG and Explanation 150 Issuing bank timed out PayPal Australia 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 160 Secure Token already been used.
8 Transaction Responses RESULT Values and RESPMSG Text RESULT RESPMSG and Explanation 1023 Buyer Authentication Service — merchant status for 3D secure is invalid 1041 Buyer Authentication Service — Validate Authentication failed: missing or invalid PARES 1042 Buyer Authentication Service — Validate Authentication failed: PARES format is invalid 1043 Buyer Authentication Service — Validate Authentication failed: Cannot find successful Verify Enrollment 1044 Buyer Authentication Service — Valida
Transaction Responses RESULT Values and RESPMSG Text RESULT Description -1 Failed to connect to host -2 Failed to resolve hostname -5 Failed to initialize SSL context -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 option
8 110 Transaction Responses RESULT Values and RESPMSG Text RESULT Description -103 Context initialization failed -104 Unexpected transaction state -105 Invalid name value pair request -106 Invalid response format -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 si
A Processors Requiring Additional Transaction Parameters Additional parameters are those required by individual processors beyond the core parameters. Parameters are organized alphabetically by processor.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
A 136 Processors Requiring Additional Transaction Parameters WorldPay Additional Credit Card Parameters 07 February 2013 Gateway Developer Guide and Reference
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.
B TeleCheck Electronic Check Processing TeleCheck NFTF Processing Overview 138 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.
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.
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.
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.
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.
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).
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 145 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.
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.
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.
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
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.
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.
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.
C Submitting Purchasing Card Level 2 and 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.
C Submitting Purchasing Card Level 2 and 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.
Submitting Purchasing Card Level 2 and 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 154) 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).
C Submitting Purchasing Card Level 2 and 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.
Submitting Purchasing Card Level 2 and 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.
C Submitting Purchasing Card Level 2 and 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.
Submitting Purchasing Card Level 2 and 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.
C Submitting Purchasing Card Level 2 and 3 Transactions American Express Purchasing Card Transaction Processing Field Description SHIPTOZIP (Required) Ship-to postal code (called zip code in the USA).
Submitting Purchasing Card Level 2 and 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.
C Submitting Purchasing Card Level 2 and 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.
Submitting Purchasing Card Level 2 and 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.
C Submitting Purchasing Card Level 2 and 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).
Submitting Purchasing Card Level 2 and 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.
C Submitting Purchasing Card Level 2 and 3 Transactions First Data Merchant Services South (FDMS) Purchasing Card Transaction Processing FDMS South Level 2 and Level 3 Purchasing Card Parameters 164 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.
Submitting Purchasing Card Level 2 and 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.
C Submitting Purchasing Card Level 2 and 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.
Submitting Purchasing Card Level 2 and 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.
C Submitting Purchasing Card Level 2 and 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.
Submitting Purchasing Card Level 2 and 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.
C Submitting Purchasing Card Level 2 and 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.
Submitting Purchasing Card Level 2 and 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.
C Submitting Purchasing Card Level 2 and 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.
Submitting Purchasing Card Level 2 and 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.
C Submitting Purchasing Card Level 2 and 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.
Submitting Purchasing Card Level 2 and 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.
C 176 Submitting Purchasing Card Level 2 and 3 Transactions Litle 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.
Submitting Purchasing Card Level 2 and 3 Transactions Merchant e-Solutions Purchasing Card Transaction Processing C Merchant e-Solutions Purchasing Card Transaction Processing 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.
C Submitting Purchasing Card Level 2 and 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).
Submitting Purchasing Card Level 2 and 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.
C Submitting Purchasing Card Level 2 and 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.
Submitting Purchasing Card Level 2 and 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.
C Submitting Purchasing Card Level 2 and 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.
Submitting Purchasing Card Level 2 and 3 Transactions Paymentech Salem (New Hampshire) Purchasing Card Transaction Processing Field Description SHIPTOZIP (Required) Ship-to postal code (called zip code in the USA). Character length and limitations: 15 alphanumeric characters TAXAMT (Optional) Total tax amount. Must include a decimal and be exact to the cent (42.00, not 42) and exclude comma separators (1234.56 not 1,234.56).
C Submitting Purchasing Card Level 2 and 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. If more than 38 characters, use proper and meaningful abbreviation.
Submitting Purchasing Card Level 2 and 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.
C Submitting Purchasing Card Level 2 and 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.
Submitting Purchasing Card Level 2 and 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.
C Submitting Purchasing Card Level 2 and 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.
Submitting Purchasing Card Level 2 and 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).
C Submitting Purchasing Card Level 2 and 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).
Submitting Purchasing Card Level 2 and 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.
C Submitting Purchasing Card Level 2 and 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.
Submitting Purchasing Card Level 2 and 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.
C Submitting Purchasing Card Level 2 and 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.
Submitting Purchasing Card Level 2 and 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.
C Submitting Purchasing Card Level 2 and 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.
Submitting Purchasing Card Level 2 and 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.
C Submitting Purchasing Card Level 2 and 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.
Submitting Purchasing Card Level 2 and 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.
C Submitting Purchasing Card Level 2 and 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.
Submitting Purchasing Card Level 2 and 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.
C Submitting Purchasing Card Level 2 and 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.
Submitting Purchasing Card Level 2 and 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.
C Submitting Purchasing Card Level 2 and 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.
Submitting Purchasing Card Level 2 and 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.
C 206 Submitting Purchasing Card Level 2 and 3 Transactions WorldPay Purchasing Cards Transaction Processing 07 February 2013 Gateway Developer Guide and Reference
D Payflow Header Parameters The Payflow header parameters can be used to bypass Payflow and send a request message directly to PayPal. They can also be used to post transactions directly to the Payflow servers without installing an SDK.
D Payflow Header Parameters Posting Transactions Directly Without the Payflow SDK Posting Transactions Directly Without the Payflow SDK The Payflow SDK is recommended for .NET and Java users to simplify the Payflow integration. Developers who prefer to write code in other programming languages can go to the PayPal Labs integration wizard web site (https://www.paypallabs.com/integrationwizard/index.php.). The wizard generates customizable code samples in languages such as PHP.
Payflow Header Parameters Posting Transactions Directly Without the Payflow SDK D available in your programming language of choice to send the data via HTTPS. For example, if you use PHP, you might choose to use cURL. Payflow Message Protocol Headers In addition to the Payflow parameters that you pass in your request, you must set the request headers described in the following table.
D Payflow Header Parameters Posting Transactions Directly Without the Payflow SDK Required Payflow Headers Header Name Description X-VPS-REQUEST-ID (Required) A unique identifier for each request, whether the request is a single name-value transaction or an XMLPay 2.0 document with multiple transactions. This identifier is associated with all the transactions in that particular request. X-VPS-REQUEST-ID is made up of 1 to 32 printable characters.
Payflow Header Parameters Posting Transactions Directly Without the Payflow SDK D Standard HTTP Headers Required Header Name Description Connection State of the connection. The server returns the value close to close the connection after the response is sent. Content-Length (Required) Size of message body. Content-Type (Required) Provide one of the following values: text/name value, transaction request body is in name-value pair format. text/xml, transaction request body is in XMLPay 2.
D Payflow Header Parameters Posting Transactions Directly Without the Payflow SDK Name-Value Pair Transaction Request Body The transaction request body contains the transaction information. The following is an example transaction request body in name-value pair format. TRXTYPE[1]=S&ACCT[16]=5105105105105100&EXPDATE[4]=0109&TENDER[1]=C&INVNUM[8 ]=INV12345&AMT[5]=25.12&PONUM[7]=PO12345&STREET[23]=123 Main St.
Payflow Header Parameters Posting Transactions Directly Without the Payflow SDK NOT E : D The parameters in this section are not required but it is highly recommended you send them. Payflow Recommended Headers Header Name Description X-VPS-VIT-INTEGRATION-PRODUCT Identifies the integration product that calls the PayPal server.
D 214 Payflow Header Parameters Posting Transactions Directly Without the Payflow SDK 07 February 2013 Gateway Developer Guide and Reference
E VERBOSITY: Processor-Specific 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.
E 216 VERBOSITY: Processor-Specific Transaction Results 07 February 2013 Gateway Developer Guide and Reference
F 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 241.
F 218 ISO Country Codes 07 February 2013 Gateway Developer Guide and Reference
G Codes Used by FDMS South Only The following codes are used by FDMS South only.
G 220 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.
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
G 222 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
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
G 224 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.
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.
G 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 226 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 07 February 2013 Gat
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.
G 228 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
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
G 230 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
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
G 232 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.
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 G 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
G 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.
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
G 236 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
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
G 238 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
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
G 240 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 07 February 2013 Gateway Developer Guide and Reference
H PayPal Acquirer If PayPal is your acquirer, 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.
H 242 PayPal Acquirer PayPal Currency Codes 07 February 2013 Gateway Developer Guide and Reference
I 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.
Additional Processor Information Moneris Solutions 244 07 February 2013 Gateway Developer Guide and Reference
J 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.
J 246 Payflow Link Migration Migrating from a legacy Payflow Link Integration Payflow Link Legacy Parameter Payflow Parameter EMAILTOSHIP SHIPTOEMAIL FAX BILLTOFAX FAXTOSHIP SHIPTOFAX FIRSTNAME BILLTOFIRSTNAME INVOICE INVNUM LASTNAME BILLTOLASTNAME LOGIN VENDOR METHOD TENDER NAME BILLTOFIRSTNAME BILLTOLASTNAME NAMETOSHIP SHIPTOFIRSTNAME SHIPTOLASTNAME PHONE BILLTOPHONENUM PHONETOSHIP SHIPTOPHONENUM SHIPAMOUNT FREIGHTAMT STATE BILLTOSTATE STATETOSHIP SHIPTOSTATE TAX TAXAMT
K Payflow Gateway MagTek Parameters MagTek products for both merchants and consumers provide added security to payment transactions. For merchants, MagTek’s MagneSafe card readers encrypt payment card data when the card is swiped. For consumers, MagTek has a subscription based service named Qwick Codes. Consumers can use Qwick Codes instead of their payment card details to purchase goods and services.
K Payflow Gateway MagTek Parameters Passing Encrypted Card Swipe Data and Qwick Codes to the Payflow Gateway USB MSR: Dynamag. Insert MSR for Kiosks, ATMs, etc.: MagneSafe I-65 for Chip Cards and MagStripe, PSeries MagneSafe for outdoors, Slim Seal MagneSafe. Mobile Readers: iDynamo for iOS, Bullet for Android, uDynamo for phones and tablets with audio jack port. PINPads: IPAD PINPad available as standard model and also with signature capture support. For more information, go to: http://www.
Payflow Gateway MagTek Parameters Passing Encrypted Card Swipe Data and Qwick Codes to the Payflow Gateway Delayed Capture (TRXTYPE=D) Sale (TRXTYPE=S) Void (TRXTYPE=V) K Encrypted Card Swipe Payflow Example The purpose of this example is to show you how to format a request.You cannot use the values in this example for testing. You must have a MagneSafe card reader and test credit cards or live credit cards to send a request to the Payflow Gateway.
K Payflow Gateway MagTek Parameters Parameters for Encrypted Card Swipe Transactions TRXTYPE=A&TENDER=C&VENDOR=MerchantUserID&PARTNER=PayPal&USER=UserIDI fAvailOrSameAsVendor&PWD=Pwd4Gateway&VERBOSITY=HIGH&AMT=18&SWIPEDECR HOST=MAGT&PCODE=23456789&MERCHANTID=MerchantID123&MERCHANTNAME=Merch antName&PAN4=1234&BILLTOLASTNAME=Miller&MAGTEKUSERNAME=MagTekUserNam e&MAGTEKPWD=MagTekPwd&BILLTOEMAIL=jmiller@anyemailprovider.
Payflow Gateway MagTek Parameters Parameters for Encrypted Card Swipe Transactions Field Required Description Data Type Length ENCRYPTIONBLOCK TYPE Required The code which indicates what type of Encryption Block is used. 1=MagneSafe V4/V5 compatible 2TDEA-CBC Encryption, IV=0 Block contains data only.2=iPad V1 compatible 2TDEACBC Encryption Block contains header + data. Integer 1 ENCTRACK2 Required Encrypted Track 2 information returned by a MagneSafe device when a card is swiped.
K Payflow Gateway MagTek Parameters Parameters for Encrypted Card Swipe Transactions Field Required Description Data Type SWIPEDECRHOST Required MAGT is the only value that is accepted in the SWIPEDECRHOST parameter. If you pass a different value you will see RESULT=7 and MAGTRESPONSE with an error message in the response. DEVICESN Optional The device serial number. String ENCTRACK1 Optional Encrypted Track 1 information returned by a MagneSafe device when a card is swiped.
Payflow Gateway MagTek Parameters Parameters for MagTek Qwick Code (PCode) Transactions K Parameters for MagTek Qwick Code (PCode) Transactions Qwick Code (PCode) Transactions - Request Parameters Field Required Description Data Type Length MERCHANTID Required Your Merchant ID or the Merchant ID of the merchant redeeming the Protection Code. String 1 to 40 characters PAN4 Required The last 4 digits of the PAN / account number encoded in the card.
K Payflow Gateway MagTek Parameters MagTek Error Codes and Messages Qwick Code (PCode) Transactions - Response Parameters Field Description Data Type Notes MAGTRESPONSE This only appears in the response if a data validation error occurs or if the MagTek processor throws an error. String See the error codes below for more information. MagTek Error Codes and Messages If an error occurs, you will see one of the following error codes in the MAGTRESPONSE response parameter.
Payflow Gateway MagTek Parameters MagTek Error Codes and Messages K Encrypted Card Swipe Transactions - Other Error Codes Error Message Notes Y001 - No PAN Found in Track2 Data Y003 - Device is not allowed MagTek maintains a list of registered Devices. Y093 - Invalid MagnePrint Error obtained while Scoring Transaction MagnePrint against a Reference MagnePrint made up of Zeros.
K Payflow Gateway MagTek Parameters MagTek Error Codes and Messages Error Message Notes H381 - Invalid AUTHVALUE2 H382 - Invalid AUTHVALUE3 H383 - Invalid MERCHANTNAME H384 - Invalid USERNAME Invalid MAGTEKUSERNAME H385 - Invalid PASSWORD Invalid MAGTEKPWD Qwick Code (PCode) Transactions - Other Error Codes Error Message Notes P021 - Invalid Protection Code - Not Found. P022 - Revoked Protection Code. This Protection Code has already been revoked. P028 - Expired Protection Code.
