Home

PayPal Gateway - 2012 Developer's Guide

1. 149 Example American Express Level 3 Transaction Parameter String 151 Elavon Formerly Nova Purchasing Card Transaction Processing 152 Elavon Level 2 Parameters 0 000 eee eee eee 152 Elavon Additional Parameters a aaa a 152 Example Elavon Level 2 Transaction Parameter String 153 First Data Merchant Services FDMS Nashville Purchasing Card Transaction Processing 153 FDMS Nashville Commercial Card Parameters 2 000004 153 First Data Merchant Services FDMS North Purchasing Card Transaction Processing 154 FDMS North Purchasing Parameters 2 2 2 0 0 eee es 154 FDMS North Purchasing Card Line Item Parameters 4 155 First Data Merchant Services South FDMS Purchasing Card Transaction Processing 155 FDMS South Level 2 and Level 3 Purchasing Card Parameters 156 FDMS South Line Item Parameters 2 2 0 e 157 8 31 July 2012 Gateway Developer Guide and Reference Content EN Example FDMS South Purchasing Card Level 2 and 3 Parameter String 158 Example FDMS South Line Item Parameter String 158 Global Payments Central Purchasing Card Transaction Processing 159 Global Payments Central Level 2 Parameters 159 Global Payments East Purchasing Card Transaction Processing 159 Global Payments East Level 2 Parameters
2. 2 2005 159 Example Global Payments East Level 2 Visa or MasterCard Transaction Parameter String 160 Heartland Purchasing Card Transaction Processing 0 160 Heartland Level 2 Parameters 0 00 eee eee ee 160 Heartland Level 3 MasterCard Parameters 0 2 161 Heartland Level 3 Visa Parameters o eo 163 Litle Purchasing Card Transaction Processing o e 166 Litle Level 2 Parameters o 166 Litle Level 3 Parameters 0000 eee ee 167 Merchant e Solutions Purchasing Card Transaction Processing 168 Merchant e Solutions Level 2 Parameters 0 2 169 Merchant e Solutions Level 3 MasterCard Parameters 169 Merchant e Solutions Level 3 Visa Parameters o 172 Paymentech Salem New Hampshire Purchasing Card Transaction Processing 174 Paymentech Salem New Hampshire Level 2 Parameters for American Express 174 Paymentech Salem New Hampshire Level 3 Purchasing Card Parameters 177 Paymentech Tampa Level 2 Purchasing Card Transaction Processing 180 Paymentech Tampa Level 2 Parameters 2 181 Example Paymentech Tampa Level 2 Visa and MasterCard Transaction Parameter String 181 SecureNet Purchasing Card Transaction Processing o 181 SecureNet Level 2 Pa
3. 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 Gateway Developer Guide and Reference 31 July 2012 59 60 Submitting Credit Card Transactions Submitting Credit Transactions Set the value of ORIGID to the PNREF value returned for the original transaction PayPal Manager reports display the PNREF as the Transaction ID If you do not specify an amount the amount of the original transaction is credited to the cardholder Non Referenced Credits Allowed When non referenced credits are allowed credit transactions are permitted in any amount up to the transaction limit for the credit card account that you specify To submit a credit transaction when non referenced credits are allowed you must pass values for the following parameters e ACCT e EXPDATE e AMT NOTE The default security setting for Gateway accounts is Allow non referenced credits No Sending the ORIGID is the preferred method for performing credit transactions Using the ACCT EXPDATE or AMT parameters for such accounts leads to the return of RESULT value 117 failed the security check To help reduce fraud PayPal recommends that you not activate non referenced credits unless you have a business reason For information on setting the securit
4. Payment Confirmation Header and footer text do not apply to Layout C How do you want to confirm payment On a PayPal hosted page Sample Return to a page on my website Receipt Header Text paypaz optional Receipt Footer Text pg optional Text for Return URL https www x com Return URL hitps qav5proxy1 vps f 32 31 July 2012 Gateway Developer Guide and Reference Configuring Hosted Checkout Pages Configuring Hosted Pages Using PayPal Manager You can perform tasks such as Configure your PayPal Express Checkout display and specify email addresses for live and test transactions Determine the URL and text of the link the buyer clicks on to cancel the payment on your website Select the billing and shipping information fields the buyer will be required to complete during checkout Choose to display your payment confirmation on either the hosted confirmation page or on your website You can also specify the receipt header and footer text the URL and text for the return link and whether to use silent post Opt to send email receipts to the buyer for each successful transaction Configure security features such as Accepted URLs to stop fraudsters from changing the monetary value of amounts being passed to and from the PayPal servers Address Verification System AVS and Card Security Code CSC For complete details on these settings click the Help button on the Setup pag
5. Vantiv Additional Credit Card Parameters Additional Credit Card Parameters Field Description MERCHDESCR Optional Use this parameter to pass in your DBA name and other data describing the transaction This information will be displayed in the account holder s statement Character length and limitations 25 alphanumeric characters Gateway Developer Guide and Reference 31 July 2012 125 A Processors Requiring Additional Transaction Parameters Vantiv Additional Credit Card Parameters Soft Merchant Descriptor Parameters Field Description MERCHANTNAME MERCHANTSTREET MERCHANTCITY MERCHANTSTATE MERCHANTZIP MERCHANTCOUNTRYCODE MERCHANTLOCATIONID MERCHANTID Optional Name of merchant Character length and limitations 38 alphanumeric characters 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 Optional The name of the city were the transaction took place e Ifyou 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 e If you are a mail order phone order or internet industry you may substitute the name of the city in which the merchant s order processing facility is located Character length and limitations 21 alphanumeric c
6. 31 July 2012 Gateway Developer Guide and Reference Processors Requiring Additional Transaction Parameters al Merchant e Solutions Additional Credit Card Parameters 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 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 NOTE Not supported by Payflow Link Character length and limitations 17 alphanumeric characters MERCHDESCR Optional Use this parameter to pass in your DBA name and other data describing the transaction default merchant name This information is usually displayed in the account holder s statement Character length and limitations 25 alphanumeric characters 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 Character length and limitations 13 alphanumeric characters Paymentech Salem New Hampshire Additional Credit Card Parameters for American E
7. 74 Using Card Security Code 2 2 2 2 0 75 Chapter 7 Testing Transactions 4 2 2 77 Setting Up The Payflow Gateway Testing Environment 4 77 Testing Guidelines 2 ee 77 Processors Other Than PayPal a aa aaa a 77 Credit Card Numbers for Testing aoaaa 000 eee ee 77 Testing Address Verification Service 0 e 2 81 Testing Card Security Code 0 00002 ee ee 82 PayPal Processor ou arm ai aok ee ta eA de ces me a oe a aa 82 Credit Card Numbers for Testing 1 0 0 eee ee 82 Result Values Based On Amount 2 2 a 83 Chapter 8 Transaction Responses 87 Credit Card Transaction Responses 0 0000 eee eee eee 87 Address Verification Service Responses From PayPal 4 90 Card Security Code Results 00 o 92 Normalized Card Security Code Results 0 92 PayPal Card Security Code Results a e o 92 BALAMT Response and Stored Value Cards 93 American Express Stored Value Card Example a a 93 PNREF coc asma ad da a ds Gee Wee Oh oe oe 93 RESULT Values and RESPMSG Text e 220050022 94 RESULT Values For Communications Errors 0 o e e 100 Chapter A Processors Requiring Additional Transaction Parameters 103 American Express A
8. 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 e About Name Value Pairs on page 43 e Payflow Connection Parameters on page 44 e User Parameter Data on page 45 e Sale Transaction Example on page 46 e Formatting Payflow Gateway Transactions on page 46 About Name Value Pairs Name value pair NVP is the format you use to specify the parameter information you send in a transaction request to the Payflow server A name value pair consists of the parameter name and its value The equal sign is a special character that associates the name and its value PARAMNAME value Typically you send several name value pairs as a parameter string to the server The ampersand amp is a special character that separates each name value pair in the parameter string PARAM1NAME value amp PARAM2NAME value amp PARAM3NAME value Follow the special character and syntax guidelines when creating name value pairs Using Special Characters In Values Because the ampersand amp and equal sign characters have special meanings they are invalid in a name value pair value The following are invalid COMPANYNAME Ruff amp Johnson COMMENT1 Level 5 To include special characters in the value portion of a name value pair use a length tag The len
9. ACCTTYPE BILLTOSTREET ACCT BILLTOCITY EXPDATE BILLTOSTATE BILLTOFIRSTNAME BILLTOZIP BILLTOMIDDLENAME BILLTOCOUNTRY BILLTOLASTNAME SWIPE Example Reference Transaction In this example you authorize an amount of 100 for a shipment and charge 66 for the first partial shipment using a normal delayed capture You charge the 34 for the final part of the shipment using a reference transaction to draw credit card and shipping address information from the initial authorization transaction This example procedure creates a reference transaction 1 Submit the initial transaction such as an authorization You use an authorization transaction for the full amount of the purchase of 100 as shown in this transaction request TRXTYPE A amp TENDER C amp PWD x1y2z3 amp PARTNER PayPal amp VENDOR SuperMerchant amp USER Supe rMerchant amp ACCT 5555555555554444 amp EXPDATE 1215 amp AMT 100 OOS INVNUM 123456789 amp BI LLTOSTREET 5199 MAPLE amp BILLTOZIP 94588 Note the value of the PNREF in the response RESULT 0 amp PNREF VXYZ01234567 amp RESPMSG APPROVED amp AUTHCODE 123456 amp AVSADDR Y amp AVSZ IP N NOTE The PNREF returned in the original transaction is valid in reference transactions for 12 months Gateway Developer Guide and Reference 31 July 2012 67 68 Submitting Credit Card Transactions Submitting Reference Transactions Tokenization 2 Capture the authorized funds for a partial shipment of 66 When you deliver
10. Required Case sensitive Vendor ID that you created while registering for the account Character length and limitations 64 alphanumeric characters Required The authorized PayPal Reseller that registered you for the Gateway service provided you with a Partner ID If you registered yourself use PayPal This parameter is case sensitive Character length and limitations 64 alphanumeric characters Required Case sensitive 6 to 32 character password that you created while registering for the account Character length and limitations 32 alphanumeric characters Required This is the transaction amount default U S dollars The transaction amount should always specify a decimal and the exact amount to the cent for example 34 00 instead of 34 Do not include comma separators in the amount Use 1199 95 not 1 199 95 Character length and limitations 7 numeric characters U S dollars only It is one of the following values e I Internet Check Acceptance ICA provides the capability to authorize and electronically settle checks over the intenet e P Checks By Phone CBP provides the capability to authorize and electronically settle checks over the phone e D Prearranged Deposit Services PPD debits the customer s account provided the customer has previously accepted a written authorization Required Account holder s city Character length and limitations 30 alphanumeric characters Account holder s country
11. The Payflow testing server simulates address verification service by returning a value for AVSADDR based on the first 3 characters of the submitted value for BILLTOSTREET The testing server returns a value for AVSZIP based on the submitted BILLTOZIP value as shown in the table If BILLTOSTREET starts with 667 or higher or begins with a non numeric character then the simulator returns AVSADDR X AVSZIP X The following table tests AVSADDR Submitted Value for Example BILLTOSTREET BILLTOSTREET Value AVSADDR Result 000 333 24285 Elm Y 334 666 49354 Main N 667 or higher or begins with a non 79232 Maple X numeric character The following table tests AVSZIP Submitted Value for BILLTOZIP Example BILLTOZIP Value AVSZIP Result 00000 50000 00382 Y 50001 99999 94303 N Any value if street address is 667 or BILLTOSTREET 79232 Maple X higher or begins with a non numeric BILLTOZIP 20304 character Gateway Developer Guide and Reference 31 July 2012 81 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 NOTE Some processors will decline RESULT value 12 a transaction if the card security code does not match without returning a CVV2MATCH val
12. 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 Optional Total shipping insurance cost for this order 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 Gateway Developer Guide and Reference 31 July 2012 117 O A Processors Requiring Additional Transaction Parameters PayPal Credit Card Transaction Request Parameters Parameter Description L NAMEN Optional Line item name NOTE 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 NOTE To enable line item support you must contact Merchant Technical Support at http www paypal com mts Limitations 127 alphanumeric characters L COSTN Required if L_QTYn is supplied Cost of the line item The line item unit price can be a positive or a negative value but not 0 NOTE To enable line item support you must contact Merchant Technical Support at http www paypal com mts NOTE You must set CURRENCY to one of the three character currency codes for any of the
13. 35 Error in reactivating the recurring profile 36 OLTP Transaction failed 37 Invalid recurring profile ID 50 Insufficient funds available in account 51 Exceeds per transaction limit 52 Permission issue Attempting to perform a transaction type such as Sale or Authorization that is not allowed for this account 99 General error See RESPMSG 100 Transaction type not supported by host 101 Time out value too small PayPal Australia Invalid transaction returned from host can be treated as an invalid transaction or a decline 102 Processor not available The financial host was unable to communicate with the external processor These transactions do not make it out of the Payflow network and will not settle or appear on processor reports 31 July 2012 Gateway Developer Guide and Reference 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 e PayPal Australia Time out reversal logic should reverse the transaction According to PayPal Australia this is a best effort and is not guaranteed e Global Payments Central Citi Bank Singapore Time out reversal logic should reverse the transaction e PayPal The transaction might settle There is no time
14. CHINA CHRISTMAS ISLAND CMEROON UNITED REP COCOS KEELING ISLANDS COLOMBIA COMOROS CONGO COOK ISLANDS COSTA RICA COTED IVOIRE CROATIA BLZ BEN BMU BTN BOL BIH BWA BVT BRA IOT BRN BGR BFA BDI KHM CAN CPV CYM CAF TCD CHL CHN CXR CMR CCK COL COM GOG COK CRI CIV HRV 31 July 2012 Gateway Developer Guide and Reference Codes Used by FDMS South Only E 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 GIBRALTAR GIB GREECE GRC GREENLAND GRL GRENADA GRD GUADALUPE GLP GUAM GUM GUATEMALA GTM GUINEA GIN Gateway Developer Guide and Reference 31 July 2012 205 206 Codes Used by FDMS South Only MasterCard Country Codes for FDMS South Only GUINEA BISSAU GUYANA HAITI HEARD AND MCDONALD ISLANDS HONDURAS HONG KONG HUNGARY ICELAND INDIA INDONESIA IRAN IRAQ IRELAND ISRAEL ITALY JAMAICA JAPAN JORDAN KAZAKHSTAN KENYA KOREA REPUBLIC OF KUWAIT KYRGYZSTAN LAO PEOPLES DEMOCRATIC LATVIA LEBANON LESOTHO LIBERIA LIBYAN ARAB JAMAHIRIYA LIECHTNSTIEN LITHUAN
15. Character length and limitations 3 alphanumeric characters MERCHANTCOUNTRYCODE Optional Country code of the location where the transaction took place Character length and limitations 3 alphanumeric characters MERCHANTZIP Optional The 5 to 9 digit zip postal code excluding spaces dashes and non numeric characters where the transaction took place If you are a third party biller bill for services or goods rendered by another entity you must enter the postal code that corresponds to the seller s location Character length and limitations 15 alphanumeric characters 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 12 numeric characters ADDLAMTTYPEN Optional A 3 digit code indicating the type of the corresponding charge detail where n is a value from 1 5 Character length and limitations 3 numeric characters Airline Passenger Data Parameters Field Description ATR DEPARTUREDATE Optional Departure date in the format YYYYMMDD Character length and limitations 8 alphanumeric characters ATR PASSENGERNAME Optional Name of the passenger in the following format with fields separated
16. 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 Character length and limitations 4 numeric characters L DISCOUNTN Optional Discount per line item Character length and limitations 12 numeric characters L_AMTn Optional Line item total Character length and limitations 12 numeric characters Gateway Developer Guide and Reference 31 July 2012 165 Submitting Purchasing Card Level 2 and Level 3 Transactions Litle Purchasing Card Transaction Processing Example Heartland Level 3 Visa Transaction Parameter String TRXTYPE S amp TENDER C amp PARTNER Partner amp USER User amp PWD Password amp ACCT 411111111111 1111 amp EXPDATE 1215 amp AMT 1 OO amp BILLTOSTREET 5199 JOHNSON amp TAXAMT 1 0O6 amp BILLTOZIP 94588 amp ALTTAXAMT 1 O0O amp CUSTVATREGNUM 11111 amp LOCALTAXAMT 1 OL amp NATIONALTAXAMT 1 02 amp COMMCODE 22222 amp VATAXAMT 1 03 amp VATAXPERCENT 55 amp TAXEXEMPT N amp DISCOUNT 50 amp FR EIGHTAMT 1 OO amp SDUTYAMT 1 OO amp SHIPTOZIP 33333 amp SHIPFROMZIP 44444 amp SHIPTOCOUNTRY 840 amp ORDERDATE 020725 amp L COMMCODE1 123456789ABC amp L DESC1l Line item 1 descripti on amp L UPC1 CBA987654321 amp L OTY1 1 amp L UOM1 123456789012 amp L COST1 1 50 amp L TAXAMT1 1 0581 TAXRATE1 12 amp L DISCOUNT1 50 amp L AMT1 1 00 amp L TAXTYPE1 TT1
17. 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 RECURRINGTYPE Optional Type of transaction occurrence The values are e F First occurrence e S Subsequent occurrence default Limitations One alpha character BILLTOCITY Conditional Bill to city address Limitations 40 alphanumeric characters NOTE Some merchants maybe required to pass this billing information Please test your integration first to determine if the billing information fields are required BILLTOSTATE Conditional Bill to state or province address Limitations 40 alphanumeric characters NOTE Some merchants maybe required to pass this billing information Please test your integration first to determine if the billing information fields are required BILLTOCOUNTRY Conditional Bill to country address Limitations 2 alphanumeric characters NOTE Some merchants maybe required to pass this billing information Please test your integration first to determine if the billing information fields are required SHIPTOSTREET Optional Ship to street address NOTE If you pass in any of the ship to address pa
18. Preparing for TeleCheck Production Transactions o 136 Responses to TeleCheck Transactions a a a a 136 Transaction Responses Common to All Tender Types 136 Response Code Values scs 5 ee a Sk ed a ee eee A a 137 Sale Response Code Values a a a 137 Adjustment Code Values 0 138 Response Codes For Status Response Packets 138 TeleCheck Authorization Requirements o e 139 Authorization Sales Consent ee 139 Authorization Sales Decline Error 142 Chapter C Submitting Purchasing Card Level 2 and Level 3 Transactions 43 About Purchasing Cards 1 aaa a 143 About Program Levels 2 2 143 Accepted BIN Ranges 0000 ee ee 144 About American Express Purchasing Card Transactions 144 Supported Transaction Types e 144 Avoiding Downgrade 2 a a a 145 Submitting Successful Level 3 Transactions 2 5 145 Edit Check as 24 04 aee ade dee eek a ba dee dk alee be bab 145 Accepted BIN Ranges 2 0000 eee ee 146 American Express Purchasing Card Transaction Processing 146 American Express Level 2 Parameters for American Express 146 Example American Express Level 2 Transaction Parameter String 149 American Express Level 3 Parameters
19. 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 Character length and limitations 9 alphanumeric characters SecureNet 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 Character length and limitations 12 numeric characters SHIPTOZIP Required The zip code of the address to which the goods are shipped Character length and limitations 10 alphanumeric characters SHIPFROMZIP Required The postal code called zip code in the USA from which shipping occurs Character length and limitations 10 alphanumeric characters SHIPTOCOUNTRY Optional Destination country code Character length and limitations 3 alphanumeric characters ALTTAXAMT Optional Alternate tax amount Character length and limitations 9 numeric characters SecureNet Level 3 MasterCard Line Item Detail Records NOTE For these values n is a sequence counter that should begin with 1 and increase in sequence Each line item should also contain quantity
20. The sale transaction process is often referred to as a 2 part hand off The process begins with the merchant s Authorization message TeleCheck responds with an Authorization response message indicating whether the transaction is approved and whether the check is eligible for conversion whether check conversion will be offered The Merchant then responds with a Delayed Capture message acknowledging receipt of TeleCheck s sale response and indicating whether electronic check conversion was accepted TeleCheck completes the transaction with a Delayed Capture response message confirming receipt of the merchant s status inquiry message Authorization Request Authorization Response Telecheck Merchant Delayed Capture Request Delayed Capture Response TeleCheck Parameters Parameters used for processing electronic checks through TeleCheck are described in this section 31 July 2012 Gateway Developer Guide and Reference TeleCheck Electronic Check Processing TeleCheck Parameters Required TeleCheck Parameters Field Description USER VENDOR PARTNER PWD AUTHTYPE BILLTOCITY BILLTOCOUNTRY BILLTOFIRSTNAME BILLTOLASTNAME 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
21. Address verification service address response returned if you are using address verification service Address verification service address responses are for advice only This process does not affect the outcome of the authorization Character length and limitations 1 alpha character Y N X or no response Address verification service address response returned if you are using address verification service Address verification service address responses are for advice only This process does not affect the outcome of the authorization Character length and limitations 1 alpha character Y N X or no response International address verification service address responses may be returned if you are using Address verification service AVS responses are for advice only This value does not affect the outcome of the transaction Indicates whether address verification service response is international Y US N or cannot be determined X Client version 3 06 or later is required Character length and limitations 1 alpha character Y N X or no response The raw address verification service response returned by the processor This field is not normalized and is returned when VERBOSITY is set to HIGH Character length and limitations 1 character The raw CVV2 response returned by the processor This field is not normalized and is returned when VERBOSITY is set to HIGH Character length and limitations 1 character 88 31 July 2
22. Litle Purchasing Card Transaction Processing Litle Level 2 Parameters The Litle platform supports Level 2 transaction data Litle Level 2 Parameters Field Description CUSTREF Optional Reference such as a purchase order number used by the customer for the purchase Character length and limitations 17 alphanumeric characters DISCOUNT Optional Discount 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 DUTYAMT Optional Duty amount on the total purchased 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 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 If for example you specify 500 this value is equivalent to 5 00 8 numeric characters L_AMIn Optional Amount of this line item including tax where n is a line item number from 1 to 99 L_AMTn L_TAXAMTn line item total Character length and limitations The decimal is implied If for example you specify 500 this value is equivalent to 5 00 8 numeric
23. 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 MERCHANTCITY Optional The name of the city were the transaction took place e Ifyou 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 e If you are a mail order phone order or internet industry you may substitute the name of the city in which the merchant s order processing facility is located Character length and limitations 21 alphanumeric characters If more than 21 characters use proper and meaningful abbreviation Do not truncate 122 31 July 2012 Gateway Developer Guide and Reference Processors Requiring Additional Transaction Parameters A 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 Region code examples e CA California USA e NS Nova Scotia Canada e COS Colima Mexico If you are a third party biller bill for services or goods rendered by another entity you must enter the region code that corresponds to the state province or country subdivision in which the seller is located
24. Optional Tax type applied Character length and limitations 4 alphanumeric characters L_TAXAMTN Optional Tax amount Character length and limitations 12 numeric characters Gateway Developer Guide and Reference 31 July 2012 189 190 Submitting Purchasing Card Level 2 and Level 3 Transactions TSYS Acquiring Solutions Purchasing Card Transaction Processing Parameter Description L DISCOUNTN Optional Discount amount Character length and limitations 12 numeric characters Example TSYS Acquiring Solutions Level 3 MasterCard Transaction Parameter String TRXTYPE S amp TENDER C amp PARTNER Partner amp USER User amp PWD Password amp ACCT 552500000000 0005 amp EXPDATE 1215 amp AMT 1 OO amp BILLTOSTREET 5199 JOHNSON amp BILLTOZIP 94588 amp ALTTAX AMT 1 00 amp CUSTVATREGNUM 11111 amp LOCALTAXAMT 1 OO amp NATIONALTAXAMT 1 0 0 amp COMMCODE 222228VATAXAMT 1 00 amp VATAXPERCENT 10 amp TAXEXEMPT Y amp DISCOUNT 1 00 amp FREIGHTAMT 1 OO amp DUTYAMT 1 OO amp SHIPTOZIP 33333 amp SHIPFROMZIP 44444 amp SHI PTOCOUNTRY 8408ORDERDA TE 020725 amp L COMMCODE1 123456789ABC amp L DESCl Line item 1 description amp L_UPC1 C BA987654321 amp L QTY1 1 amp L UOM1 123456789012 amp L COST1 1 00 amp L TAXAMT1 1 00 amp L TAXR ATE1 1 00 amp L DISCOUNT1 1 00 amp L AMT1 1 00 amp L TAXTYPE1 TT3 TSYS Acquiring Solutions Level 3 Visa Parameters To qualify for Level 3 purchasing card transaction processing the authorization response fo
25. Optional Use this parameter to pass in your DBA name and other data describing the transaction This information is usually displayed in the account holder s statement Character length and limitations 25 alphanumeric characters 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 Character length and limitations 13 alphanumeric characters Optional Purchase order number Character length and limitations 25 alphanumeric characters Optional Category that the transaction is in for example coffee mugs This field is for your own use Character length and limitations 25 alphanumeric characters Optional Second street address Character length and limitations 35 alphanumeric characters Optional Third street address Character length and limitations 35 alphanumeric characters Optional Total tax 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 12 numeric characters Optional Indicates whether the customer is tax exempt It is one of the following values e Y The customer is tax exempt e N The customer is not tax exempt default Character length and limitations 1 alpha character
26. Parameter Description FREIGHTAMT Required Freight amount Character length and limitations numeric DUTYAMT Required Duty amount Character length and limitations numeric SHIPTOZIP Required Destination zip code SHIPTOCOUNTRY Optional Destination country SHIPFROMZIP Required Ship from zip code DISCOUNT Required Discount amount Character length and limitations numeric TAXAMT Optional VAT Tax ID Character length and limitations numeric TAXPERCENTAGE Optional VAT Tax amount Level 3 Visa Line Item Record 1 Parameters Parameter Description L_DESCn Required Description L_PRODCODEN L_QTYn L_UOMn TAXAMTN L_TAXRATEN Required Product code Required Quantity Character length and limitations numeric characters Required Unit of measure Optional Tax amount Character length and limitations numeric Optional Tax rate Character length and limitations 4 numeric characters Gateway Developer Guide and Reference 31 July 2012 179 Submitting Purchasing Card Level 2 and Level 3 Transactions Paymentech Tampa Level 2 Purchasing Card Transaction Processing Level 3 Visa Line Item Record 2 Parameters Parameter Description L_AMTN Optional Line item total Character length and limitations numeric L_DISCOUNTN Optional Discount amount Character length and limitations numeric L_ UPCN Optional Item commodity code L_Costn Optional Unit cost Character l
27. Transparent Redirect PayPal Payments Pro and Payflow Pro merchants who want PCI compliance while maintaining full control over designing and hosting checkout pages on their website can use Transparent Redirect Transparent Redirect posts payment details silently to the Gateway server so this sensitive information never goes through the merchant s website Implementing Transparent Redirect is very similar to implementing hosted pages It differs only in the steps shown in boldface below 1 2 The customer clicks Buy to purchase merchandise on your website 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 This name value pair prevents the hosted pages from displaying The Gateway server returns the secure token and your token ID to your website You display the credit card fields to the customer in a checkout page on your website The customer enters their credit card number expiration date and other sensitive data into the credit card fields and clicks Submit The browser posts the payment data directly to the Gateway server avoiding your website and easing your PCI compliance requirements NOTE To ensure that the post goes from the browser directly to PayPal and not back to your website you should add scripting The Gateway processes the payment through the payment processing network The Gateway server transparently sends the
28. e 5 JCB e 8 Other Gateway Developer Guide and Reference 31 July 2012 115 O A Processors Requiring Additional Transaction Parameters PayPal Credit Card Transaction Request Parameters Parameter Description AMT CURRENCY BUTTONSOURCE CUSTIP CAPTURECOMPLETE CUSTOM EMAIL INVNUM Required Amount US Dollars U S based currency AMT ITEMAMT TAXAMT FREIGHTAMT HANDLINGAMT INSURANCEAMT DISCOUNT NOTE 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 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 Nine numeric characters plus decimal Required The currency code NOTE CURRENCY is applicable only to processors that support transaction level currency Limitations Three characters Optional Identification code for use by third party applications to identify transactions Limitations 32 alphanumeric characters Optional IP address of payer s browser as recorded in its HTTP request to your website This value is optional but recommended NOTE PayPal records this IP address as a means to detect possible fraud Limitations 15 character string in dotted quad format x
29. s telephone number Character length and limitations 10 characters PHONETYPE Optional Telephone company provided ANI information identifier digits indicating the telephone call type Examples cellular 61 63 payphone 27 Character length and limitations 2 alphanumeric characters 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 0 WINDOWS 95 Character length and limitations 60 alphanumeric and special characters CUSTIP Optional Account holder s IP address Character length and limitations 15 alphanumeric and special characters SHI PTOCOUNTRY Optional Numeric country code of ship to country Example USA 840 Character length and limitations 3 alphanumeric characters SHIPMETHOD Optional Shipping method code The values are e 01 Same day 02 Overnight next day 03 Priority 2 3 days 04 Ground 4 or more days 05 Electronic delivery 06 ZZ Reserved for future use AVS 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
30. you must pass in the complete set that is SHIPTOSTREET SHIPTOCITY SHIPTOSTATE SHIPTOCOUNTRY and SHIPTOZIP Limitations 20 character string SecureNet Additional Credit Card Parameters for American Express In addition to the core credit card parameters SecureNet accepts the parameters described below to meet American Express reporting and statement requirements Retail Transaction Advice Addendum for SWIPE transactions Field Description L_DESCn Optional Description of this line item n is a line item number from 1 to 6 Character length and limitations 19 alphanumeric characters L_AMIn 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 12 numeric characters L_OTYn Optional Quantity of this line item n is a line item number from 1 to 6 Character length and limitations 3 numeric characters 120 31 July 2012 Gateway Developer Guide and Reference Processors Requiring Additional Transaction Parameters A SecureNet Additional Credit Card Parameters for American Express Internet Transaction Data Field Description BILLTOEMAIL Optional Account holder s email address Character length and limitations 60 alphanumeric characters BILLTOPHONENUM Optional Account holder
31. 1 00 amp L DISCOUNT1 1 00 amp L AMT1 1 00 amp L TAXTYPE1 TT3 Heartland 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 Level 3 transactions that do not include the required Level 2 values are rejected IMPORTANT The values required for Level 3 status vary by bank so contact your bank for details Heartland Level 2 Visa Parameters Required for Level 3 Transactions Parameter Description PONUM Required Purchase identifier TheTransaction ID is sent if no value is provided Character length and limitations 25 alphanumeric characters Gateway Developer Guide and Reference 31 July 2012 163 164 Submitting Purchasing Card Level 2 and Level 3 Transactions Heartland Purchasing Card Transaction Processing Parameter Description TAXAMT Required Tax amount The value must include a decimal and the exact amount to the cent 42 00 not 42 Do not include comma separators 1234 56 not 1 234 56 Character length and limitations numeric LOCALTAXAMT Optional Local tax amount Character length and limitations 12 numeric characters TAXEXEMPT Optional Local tax incl flag Character length and limitations 1 alphanumeric Y or N NATIONA
32. ACCT 5105105105105100 amp AMT 20 10 amp BILLTOCITY Mountain View amp COMMENT1 L2 Testing amp EXPDATE 1215 amp BILLTOFIRSTNAME Cardholder First Name amp BILLTOLASTNA ME Cardholder Last Name amp PARTNER PayPal amp PWD pwd amp BILLTOSTATE CA amp BILLTOSTREET 123 Main St amp TENDER C amp USER user amp BILLTOZI P 94043 amp CUSTCODE 123456 amp TAXAMT 1 34 First Data Merchant Services FDMS Nashville Purchasing Card Transaction Processing NoTE FDMS Nashville supports Level 2 transaction processing only The following parameters are recommended to obtain the best rates for purchasing card transactions with FDMS Nashville FDMS Nashville Commercial Card Parameters Field Description COMMCARD Optional Type of purchasing card account number sent Is one of the following values e P Purchase Card C Corporate Card B Business Card U Unknown default N None Character length and limitations 1 alphanumeric character defaults to U DUTYAMT Optional Sometimes called import 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 Character length and limitations 10 currency characters FREIGHTAMT Optional Freight 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 10 currency characters PONUM Opt
33. 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 RPP CM COLOMBIA CO COMOROS KM CONGO CG COOK ISLANDS CK COSTA RICA CR COTED IVOIRE CI CROATIA HR CYPRUS CY Gateway Developer Guide and Reference 31 July 2012 211 212 Codes Used by FDMS South Only Visa Country Codes CZECH REPUBLIC DENMARK DJIBOUTI DOMINICA DOMINICAN REPUBLIC EAST TIMOR ECUADOR EGYPT EL SALVADOR EQUATORIAL GUINEA ESTONIA ETHIOPIA FAEROE ISLANDS FALKLAND ISLANDS MALVINAS FIJI FINLAND FRANCE FRENCH GUIANA FRENCH METROPOLITAN FRENCH POLYNESIA FRENCH SOUTHERN TERRITORIES GABON GAMBIA GEORGIA GERMANY GHANA GIBRALTER GREECE GREENLAND GRENADA GUADALUPE GUAM CZ DK DJ DM DO TP EC EG SV GQ EE ET FK FK FJ FI FR GF FX PF TF GA GM GE DE GH GI GR GL GD GP GU 31 July 2012 Gateway Developer Guide and Reference Codes Used by FDMS South Only E 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 JAPA
34. CVV2MATCH Result of the card security code CVV2 check The issuing bank may decline the transaction if there is a mismatch In other cases the transaction may be approved despite a mismatch Character length and limitations 1 alpha character Y N X or no response Gateway Developer Guide and Reference 31 July 2012 87 NA Transaction Responses Credit Card Transaction Responses Field Description RESPMSG AUTHCODE AVSADDR AVSZIP IAVS PROCAVS PROCCVV2 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 For more information on corrective actions see the PayPal developer documentation on the PayPal developer website NOTE For partial authorizations RESPMSG Partial Approval when RESULT 0 Character length and limitations variable alphanumeric characters Returned for sale authorization and voice authorization credit card transactions AUTHCODE is the approval code obtained over the telephone from the processing network AUTHCODE is required when submitting a force F transaction Character length and limitations 6 alphanumeric characters
35. Card Transactions on page 47 In addition pass the following 3 Payflow parameters in your request The first 2 parameters obtain a secure token The third parameter implements Transparent Redirect which suppresses hosted pages NOTE 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 SECURETOKENID 9a9ea8208de1413abc3d60c86cb1f4c5 31 July 2012 Gateway Developer Guide and Reference Secure Token ER Posting To the Hosted Checkout Page 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 amp BILLTOSTREET 123 Main St amp BILLTOZIP 95131 amp AMT 24 35 amp INVNUM INV123 45 amp PONUM P012345 amp CURRENCY USD amp CREATESECURETOKEN Y amp SECURETOKENID 9a9ea8208de 1413abc3d60c86cbh1f 4c5 amp SILENTTRAN TRUE The Gateway server returns a SECURETOKEN and SECURETOKENID in the response A tag follows the SECURETOKEN to indicate the length of the token val
36. IMPORTANT The values required for Level 3 status vary by bank so contact your bank for details TSYS Acquiring Solutions Level 2 MasterCard Parameters Required for Level 3 Line Item Transactions Parameter Description PONUM Required Purchase identifier The transaction ID is sent if no value is provided 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 Character length and limitations numeric LOCALTAXAMT Optional Local tax Character length and limitations 12 numeric characters 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 Character length and limitations 9 alphanumeric characters 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions TSYS Acquiring Solutions Purchasing Card Transaction Processing 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 Optio
37. L_ and ends with n where n is the line item number For example L_QTYO 1 is the quantity for line item 0 and is equal to 1 with n starting at 0 In addition the SHIPFROMZIP parameter is required for Level 3 transactions FDMS North 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 Character length and limitations 3 alpha characters L COSTN Optional Cost per item excluding tax Character length and limitations 10 currency characters L UPCN Optional Supplier specific product code Character length and limitations 12 alphanumeric characters L DISCOUNTN Optional Discount per line item Character length and limitations 10 currency characters L_AMTn Optional Total line item amount including tax and discount for debit for credits Character length and limitations 10 currency characters L_TAXAMTN Optional Line item tax amount Character length and limitations 10 currency characters First Data Merchant Services South FDMS Purchasing Card Transaction Processing The following parameters are recommended to obtain the best rates for Level 2 and Level 3 purchasing card trans
38. L_COMMCODEN Optional Item commodity code Character length and limitations 12 alphanumeric characters Gateway Developer Guide and Reference 31 July 2012 157 Submitting Purchasing Card Level 2 and Level 3 Transactions First Data Merchant Services South FDMS Purchasing Card Transaction Processing Description Optional Item description Character length and limitations 35 alphanumeric characters Optional Item unit of measure Character length and limitations 3 alpha characters Optional Cost per item excluding tax Character length and limitations 10 currency characters L_PRODCODEN Optional Supplier specific product code Character length and limitations 12 alphanumeric characters L DISCOUNTN Optional Discount per line item Character length and limitations 10 currency characters Required Total line item amount including tax and discount for debit for credits Character length and limitations 10 currency characters L_TAXAMTn Optional Line item tax amount Character length and limitations 10 currency characters Example FDMS South Purchasing Card Level 2 and 3 Parameter String TRXTYPE S amp TENDER C amp PARTNER PayPal amp VENDOR SuperMerchant amp USER SuperMerchant amp P WD x1y2z3 amp BILLTOSTATE CA amp BILLTOFIRSTNAME John amp BILLTOLASTNAME Smith amp BILLTOCI TY Redwood amp SHI PTOCOUNTRY USA amp CUSTCODE 12345 amp DISCOUNT 25 amp DUTYAMT 34 00 amp FREI GHTAMT 12
39. L_QTY lt n gt and unit price L_COST lt n gt fields Parameter Description L_DESCn Required Item descriptor Character length and limitations 35 alphanumeric characters L_ UPCN Optional Product code Character length and limitations 12 alphanumeric characters Gateway Developer Guide and Reference 31 July 2012 183 Submitting Purchasing Card Level 2 and Level 3 Transactions SecureNet Purchasing Card Transaction Processing Parameter Description L_QTYn Required Quantity Character length and limitations 12 numeric characters L_UOMN Required Unit of measure code Character length and limitations 12 alphanumeric characters L_TAXRATEN Optional Tax rate applied Character length and limitations 4 numeric characters L_TAXTYPEN Optional Tax type applied Character length and limitations 4 alphanumeric characters L_TAXAMTN Optional Tax amount Character length and limitations 12 numeric characters L_DISCOUNTN Optional Discount amount Character length and limitations 12 numeric characters Example SecureNet Level 3 MasterCard Transaction Parameter String TRXTYPE S amp TENDER C amp PARTNER Partner amp USER User amp PWD Password amp ACCT 552500000000 0005 EXPDATE 1215S6AMT 1 OO amp BILLTOSTREET 5199 JOHNSON amp BILLTOZIP 94588 amp SALTTAX AMT 1 O0O amp CUSTVATREGNUM 11111 amp LOCALTAXAMT 1 OO amp NATIONALTAXAMT 1 00 amp COMMCODE 22222 amp VATAXAMT 1 OO amp VATAXPERCENT 10 amp T
40. 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 Character length and limitations 4 numeric characters L_DISCOUNTN Optional Discount per line item Character length and limitations 12 numeric characters L_AMTn Optional Line item total Character length and limitations 12 numeric characters Example Merchant e Solutions Level 3 MasterCard Transaction Parameter String TRXTYPE S amp TENDER C amp PARTNER Partner amp USER User amp PWD Password amp ACCT 552500000000 0005 amp EXPDATE 1215 amp AMT 1 O0 amp SBILLTOSTREET 5199 JOHNSON amp BILLTOZIP 94588SALTTAX AMT 1 00 amp CUSTVATREGNUM 11111 amp LOCALTAXAMT 1 OO amp NATIONALTAXAMT 1 00 amp COMMCODE 22222 amp VATAXAMT 1 00 amp VATAXPERCENT 10 amp TAXEXEMPT Y amp DISCOUNT 1 00 amp FREIGHTAMT 1 O0O0 amp DUTYAMT 1 00 amp SHIPTOZIP 33333 amp SHIPFROMZIP 44444 amp SHIPTOCOUNTRY 840 amp ORDERDA TE 0207258 L_COMMCODE1 123456789ABC8L DESCl Line item 1 descriptiongL UPC1 C BA987654321 amp L QTY1 1 amp L_ UOM1 123456789012 amp L COST1 1 006L TAXAMT1 1 00 amp L TAXR ATE1 1 00 amp L DISCOUNT1 1 00 amp L AMT1 1 00 amp L TAXTYPE1 TT3 Gateway Developer Guide and Reference 31 July 2012 171 172 Submitting P
41. New Hampshire Purchasing Card Transaction Processing Paymentech Salem New Hampshire Level 2 Parameters for American Express The Paymentech Salem New Hampshire platform supports Level 2 parameters for American Express MasterCard Visa and Switch Solo Maestro The parameters in the following tables meet card acceptance and American Express reporting and statement requirements 174 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions Paymentech Salem New Hampshire Purchasing Card Transaction Processing CPC Level 2 Transaction Advice Addendum Parameters Field Description PONUM Required Purchase order number Character length and limitations 17 alphanumeric characters SHIPTOZIP Required Ship to postal code called zip code in the USA Character length and limitations 15 alphanumeric characters TAXAMT Optional Total tax amount 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_DESC1 Optional Description of this line item if not provided DESC1 if present is used Character length and limitations 140 alphanumeric characters 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 char
42. OO amp INVNUM 123456789 amp ORDERDATE 021700 amp PONUM 1234567890123456789012 345 amp SHIPFROMZIP 940151234 amp SHIPTOZIP 94065 amp TAXAMT 1 OO amp TAXEXEMPT Y Example FDMS South Line Item Parameter String TRXTYPE S amp TENDER C amp PARTNER PayPal amp VENDOR SuperMerchant amp USER SuperMerchant amp P WD x1y2z3 amp BILLTOSTATE CA amp BILLTOFIRSTNAME John amp BILLTOLASTNAME Smith amp BILLTOCI TY Redwood amp SHI PTOCOUNTRY USA amp CUSTCODE 12345 amp DISCOUNT 25 amp DUTYAMT 34 00 amp FREI GHTAMT 12 OO amp INVNUM 123456789 amp ORDERDATE 021700 amp PONUM 1234567890123456789012 345 amp SHIPFROMZIP 940151234 amp SHIPTOZIP 94065 amp TAXAMT 1 OO amp TAXEXEMPT Y amp L OTY1 1 amp L UPC1I PN L DESC1 Test amp L UOM1 INQ amp L COST1 1 00 amp L PRODCODE1 12345 amp L DISCOUNT 1 25 amp amp L AMT1 75 amp L TAXAMT1 0 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions Global Payments Central Purchasing Card Transaction Processing 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 Global Payments Central Level 2 parameters Level 2 Parameters Description CUSTCODE Required Customer code Character length and l
43. PCARD L3 missing or invalid InvoiceNumber RequestorName Features not processed PCARD L3 line item 3 missing Description For details on VERBOSITY see VERBOSITY Viewing Processor Specific Transaction Results on page 199 Submitting Successful Level 3 Transactions If a transaction uses the purchasing card BIN range contains all mandatory Level 3 fields and has at least 1 line item with all mandatory line item fields the Gateway flags it as Level 3 Edit Check The Gateway performs an edit check on the transaction s amount fields to ensure that all line item and tax amounts balance If the edit check fails the transaction fails with Result 4 Invalid Amount To pass the edit check the following relationship must be true Transaction Amount Total Tax Amount Total Freight Amount Total Handling Amount Total Line Item Amount Transaction Amount Total amount for the transaction AMT Total Tax Amount TAXAMT Total Freight Amount FREIGHTAMT or if not present the summation of L_FREIGHTAMTN for all line items Total Handling Amount HANDLINGAMT or if not present the summation of L_HANDLINGAMTH for all line items Total Line Item Amount Summation of L_QTYn L_COstTn for all line items n as the line item number For example if there are 2 line items then the Total Line Item Amount would be LOTY1 LCOST1 LOTY2 LCOST2 Gateway Developer Guide and Reference 31 July 2012 145 146 Submitting
44. SFO to DEN If not provided this value is equal to the number of ATR ROUTINGCITYN parameters Character length and limitations numeric maximum value is 10 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 For a list of airport codes see http www world airport codes com alphabetical airport code a html NOTE Present day airport codes are three characters in length The five character length is designed to allow for future expansion Character length and limitations 5 alphanumeric characters ATR CARRIERN Optional Two character airline code for each unique airline in this flight where n is a value from to 10 If the same carrier is used for multiple segments of the trip it is passed only once For example the two AIR CARRIERn values for the following trip are UA and AA UA flight from IAD to DEN e UA flight from DEN to LAX e UA flight from LAX to SFO e AA flight from SFO to DFW For information about airlines codes see http en wikipedia org wiki Airline_codes All Character length and limitations 5 alphanumeric characters AIR FAREBASIS Optional List discounts associated with the travel Character length and limitations 24 alphanumeric characters 124 31 July 2012 Gateway Developer Guide and Reference Vantiv Additional Credit Card Parameters Processors Requiring Additional Transaction Parameters A Field
45. Set to HIGH to obtain information about a partial authorization in the response 64 31 July 2012 Gateway Developer Guide and Reference Submitting Credit Card Transactions CE Submitting Purchasing Card Transactions Example Partial Authorization The following is an example partial authorization 1 You submit the initial authorization as a partial authorization TRXTYPE A amp TENDER C amp AMT 100 OO amp ACCT 4111111111111111 amp EXPDATE 0119 amp PARTIALAUTH Y amp VERBOSITY HIGH 2 The card issuer notes that the card has a remaining balance of 80 00 3 The card issuer sends a partial authorization for 80 00 RESULT 0 amp PNREF VRNS1A3B33C9 amp RESPMSG Partial Approval SAUTHCODE 11111 amp HOSTCODE E amp PROCAVS U amp TRANSTIME 2010 04 21 11 30 45 amp AMT 80 OO amp SORIGAMT 100 OO amp SBALAMT 0 amp ACCT 1111 amp EXPDATE 0119 amp IAVS X RESPMSG is Partial Approval AMT is now the actual amount approved ORIGAMT is the original requested amount and BALAMT is the balance on the card Since the amount charged is greater than the amount available on the card the response sets the balance amount BALAMT to zero If BALAMT is zero check if there is a balance due by comparing the original amount to the amount charged ORIGAMT AMT 4 You can choose to perform one of the following tasks Accept the 80 00 and request an alternate payment from the buyer for the additional 20 00 Reject the partial authorization by
46. You are required to pass this value when AUTHTYPE TI Character length and limitations 2 alphanumeric characters Account holder s first name as it appears on the check You are required to pass this value when CHKTYPE C Character length and limitations 30 alphanumeric characters Required Account holder s last name as it appears on the check Character length and limitations 30 alphanumeric characters Gateway Developer Guide and Reference 31 July 2012 133 TeleCheck Electronic Check Processing TeleCheck Parameters Field Description BILLTOPHONENUM BILLTOSTATE BILLTOSTREET BILLTOZIP CHKNUM CHKTYPE CUSTIP DL BILLTOEMAIL INVNUM MICR Required Account holder s telephone number Character length and limitations 10 numeric characters This value may not contain spaces or non numeric characters Required Account holder s state Character length and limitations 2 alphanumeric characters Required Account holder s street address Character length and limitations 50 alphanumeric characters Required Account holder s postal code called ZIP code in the USA Do not use spaces dashes or non numeric characters Character length and limitations 11 alphanumeric characters Required Account holder s next unused available check number Character length and limitations 7 numeric characters Required Check type It is one of the following values e P The check i
47. 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 Optional Indicates whether the customer is tax exempt It is one of the following values e Y The customer is tax exempt e N The customer is not tax exempt default Character length and limitations lalpha character Optional Value added tax invoice number Character length and limitations 95 alphanumeric characters Optional Customer valued added tax number Character length and limitations 95 alphanumeric characters Optional VAT tax amount freight shipping Character length and limitations 12 numeric characters Optional VAT tax rate freight shipping Character length and limitations 4 numeric characters WorldPay Level 3 Parameters Pass the following WorldPay Level 3 parameters to get the discount rate WorldPay Level 3 parameters Level 3 Parameters Description L_ALTTAXAMTN Optional Alternate tax amount for this item Character length and limitations 8 numeric characters plus decimal XXXX XX 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions WorldPay Purchasing Cards Transaction Processing Level 3 Parameters Description L_ALTTAXRATEN L _ALTTAXIDN L_EXTAMTN L_TAXTYP
48. are shipped Character length and limitations 10 alphanumeric characters SHIPFROMZIP Required The postal code called zip code in the USA from which shipping occurs Character length and limitations 10 alphanumeric characters SHIPTOCOUNTRY Optional Destination country code Character length and limitations 3 alphanumeric characters Gateway Developer Guide and Reference 31 July 2012 185 Submitting Purchasing Card Level 2 and Level 3 Transactions SecureNet Purchasing Card Transaction Processing Parameter Description VATREGNUM Required VAT registration number Can be part of the registration data or passed with each transaction Character length and limitations 20 alphanumeric characters FREIGHTAMT Required Unique VAT inv reference number Can be part of the registration data or passed with each transaction Character length and limitations 9 alphanumeric characters CUSTVATREGNUM Required Customer VAT Registration Number Character length and limitations 13 alphanumeric characters VATTAXAMT Optional VAT tax amount freight shipping Character length and limitations 12 numeric characters VATTAXPERCENT Optional VAT tax rate freight shipping Character length and limitations 4 numeric characters SecureNet Level 3 Visa Line Item Detail Records NOTE 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
49. are using a test not active account to submit a transaction to the live PayPal servers Change the host address from the test server URL to the live server URL 2 Invalid tender type Your merchant bank account does not support the following credit card type that was submitted 3 Invalid transaction type Transaction type is not appropriate for this transaction For example you cannot credit an authorization only transaction 4 Invalid amount format Use the format Do not include currency symbols or commas 5 Invalid merchant information Processor does not recognize your merchant account information Contact your bank account acquirer to resolve this problem 6 Invalid or unsupported currency code 7 Field format error Invalid information entered See RESPMSG 8 Not a transaction server 9 Too many parameters or invalid stream 10 Too many line items 11 Client time out waiting for response 12 Declined Check the credit card number expiration date and transaction information to make sure they were entered correctly If this does not resolve the problem have the customer call their card issuing bank to resolve 13 Referral Transaction cannot be approved electronically but can be approved with a verbal authorization Contact your merchant bank to obtain an authorization and submit a manual Voice Authorization transaction 19 Original transaction ID not found The transaction ID you entered for this transaction is not
50. by a space surname firstname middleinitial title Character length and limitations 40 alphanumeric characters Gateway Developer Guide and Reference 31 July 2012 123 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 NOTE Present day airport codes are three characters in length The five character length is designed to allow for future expansion Character length and limitations 5 alphanumeric characters ATR DESTINATION Optional Destination airport code for the first segment of the trip this is not necessarily the final destination For example if a passenger flies from STL to MIA with a layover at JFK the destination airport is JFK For a list of airport codes see http www world airport codes com alphabetical airport code a html NOTE Present day airport codes are three characters in length The five character length is designed to allow for future expansion Character length and limitations 5 alphanumeric characters AIR NUMBEROFCITIES Optional Number of unique cities in this trip including the cities of origin and destination where a maximum value of 10 is allowed For example ATR NUMBEROFCITIES is 3 for the following trip e DEN to LAX e LAX to SFO e
51. cent 42 00 not 42 Do not include comma separators 1234 56 not 1 234 56 Character length and limitations 10 currency characters Vantiv 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 name value starts with L and ends with n where n is the line item number For example L_QTYO 1 is the quantity for line item 0 and is equal to 1 with n starting at 0 In addition the SHIPFROMZIP parameter is required for Level 3 transactions Gateway Developer Guide and Reference 31 July 2012 193 Submitting Purchasing Card Level 2 and Level 3 Transactions WorldPay Purchasing Cards Transaction Processing Vantiv Line Item Parameters Field Description L_QTYnN 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 Character length and limitations 3 alpha characters L_costn Optional Cost per item excluding tax Character length and limitations 10 currency characters L_ UPCN Optional Supplier specific product code Character length and limitations 12 alphanumeric characters L_DISC
52. characters 166 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions Litle Purchasing Card Transaction Processing Field Description L_COMMCODEN Optional Identifier assigned by the card acceptor that categorizes the purchased item where n is a line item number from 1 to 99 Character length and limitations 12 alphanumeric characters L_costn Required if L_QTYn is supplied Price of one unit of the item purchased where n is a line item number from to 99 Character length and limitations 12 numeric characters L_DESCn Required Description of this line item where n is a line item number from 1 to 99 Character length and limitations 26 alphanumeric characters L DISCOUNTN Optional Discount per line item where n is a line item number from 1 to 99 Character length and limitations The decimal is implied If for example you specify 500 this value is equivalent to 5 00 8 numeric characters L PRODCODEN Optional Supplier specific product code of the purchased item where n is a line item number from 1 to 99 Character length and limitations 12 numeric characters L_OTYn Optional Number of items purchased where n is a line item number from 1 to 99 Character length and limitations 12 numeric characters L_TAXAMTN Optional Line item tax amount where n is a line item number from 1 to 99 L_AMTn L_TAXAMTn line item total Characteristic len
53. characters 31 July 2012 Gateway Developer Guide and Reference Elavon Additional Credit Card Parameters Processors Requiring Additional Transaction Parameters A 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 Character length and limitations 9 alphanumeric characters ORDERDATE Optional Specifies an order date Character length and limitations 6 numeric characters Format mmddyy with no slashes or dashes For example July 28 2003 is 072803 ORDERDATETIME Optional Specifies an order time and date Character length and limitations 19 alphanumeric characters 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 RESULT 7 SIG FIELD ERR RESPMSG Invalid ORDERTIME A truncated version of the ORDERTIME value up to 7 characters overwrites any value provided by ORDERDATE If no value is provided a NULL value is stored Elavon Additional Credit Card Parameters In addition to the core credit card parameters Elavon formerly Nova accepts the parameter
54. characters Paymentech Salem New Hampshire Level 3 Purchasing Card Parameters Paymentech Salem New Hampshire supports Level 3 parameters for MasterCard and Visa Both Level 2 transaction parameters in the following table are required for Level 3 transactions Level 3 transactions that do not include them are rejected Paymentech Salem New Hampshire Level 2 Parameters Required for Level 3 Transactions To get the discount rate pass both Level 2 parameters in the following table Level 2 Parameters Required for Level 3 Transactions Parameter Description PONUM Required Customer reference number Character length and limitations 1 to 17 alphanumeric characters Gateway Developer Guide and Reference 31 July 2012 177 178 Submitting Purchasing Card Level 2 and Level 3 Transactions Paymentech Salem New Hampshire Purchasing Card Transaction Processing Parameter Description TAXAMT Required Sales tax The value must include a decimal and the exact amount to the cent 42 00 not 42 Do not include comma separators 1234 56 not 1 234 56 To qualify for Level 2 discounts this value must not be all zeros or blank spaces Character length and limitations numeric Paymentech Salem New Hampshire Level 3 MasterCard Parameters Level 3 MasterCard Order Parameters Parameter Description FREIGHTAMT Required Freight amount Character length and limitations numeric DUTYAMT Required D
55. customer to the location on your website that you specified in the request to obtain a secure token You display the results to the customer on your website Processing Platforms Supporting Card Present Transactions The following processing platforms support card present transactions 24 31 July 2012 Gateway Developer Guide and Reference Introducing the Gateway Checkout Solutions Supported Payment Types American Express American Express APAC Elavon Fifth Third Processing Solutions First Data Merchant Services FDMS Nashville First Data Merchant Services FDMS North First Data Merchant Services FDMS South Global Payments Central Global Payments East Heartland Payment Systems Litle Merchant e Solutions Moneris Solutions Paymentech Salem Paymentech Tampa PayPal SecureNet TeleCheck TSYS Acquiring Solutions WorldPay Supported Payment 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 Gateway Developer Guide and Reference 31 July 2012 25 E Introducing the Gateway Checkout Solutions Recurring Billing Service Automated Clearing House ACH For information on performing ACH transactions contact your PayPal Sales Representative Recurring Billing Service The Recu
56. hands Setting Up The Payflow Gateway Testing Environment Before testing transactions be sure you are linked to the test servers Direct all transactions to the host URL for testing See Host URL Addresses on page 42 PayPal s simulated network processes transactions directed to the URL Testing Guidelines Follow these guidelines for testing e While testing use only the credit card numbers for testing Other numbers produce an error e Expiration date must be a valid date in the future Use the format mmyy e To view the credit card processor that you have selected for testing see PayPal Manager Processors Other Than PayPal For processors other than the PayPal processor use the guidelines below Credit Card Numbers for Testing For processors other than PayPal use the following credit card numbers for testing Any other card number produces a general failure American Express 3782822463 10005 American Express 37144963539843 1 American Express Corporate 37873449367 1000 Gateway Developer Guide and Reference 31 July 2012 17 Testing Transactions Processors Other Than PayPal Diners Club Discover Discover JCB JCB MasterCard MasterCard Visa Visa Visa 38520000023237 6011111111111117 6011000990139424 3530111333300000 3566002020360505 5555555555554444 5105105105105100 4111111111111111 4012888888881881 4222222222222 NOTE Even though this number has a different character coun
57. 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 Character length and limitations numeric Elavon Additional Parameters The following parameters are recommended to obtain the best rates for purchasing card transactions with Elavon Field Description COMMCARD Optional Type of purchasing card account number sent Is one of the following values e P Purchase Card e C Corporate Card e B Business Card e U Unknown default e N None Character length and limitations 1 alphanumeric character defaults to U PONUM Optional Purchase order number Character length and limitations 25 alphanumeric characters when used provides best rate 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 Character length and limitations 10 currency characters when used provides best rate 152 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions First Data Merchant Services FDMS Nashville Purchasing Card Transaction Processing Example Elavon Level 2 Transaction Parameter String TRXTYPE S amp
58. limitations The decimal is implied If for example you specify 500 this value is equivalent to 5 00 8 numeric characters Optional Tax amount included in the amount of the transaction Character length and limitations The decimal is implied If for example you specify 500 this value is equivalent to 5 00 8 numeric characters Optional Amount of this line item including tax where n is a line item number from 1 to 99 L_AMTn L_TAXAMTn line item total Character length and limitations The decimal is implied If for example you specify 500 this value is equivalent to 5 00 8 numeric characters 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 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 Character length and limitations 12 numeric characters Required Description of this line item where n is a line item number from 1 to 99 Character length and limitations 26 alphanumeric characters Optional Discount per line item where n is a line item number from 1 to 99 Character length and limitations The decimal is implied If for example you specify 500 this value is equivalent to 5 00 8 numeric characters Optional Supplier specific product code of the purchased item where n is a line item nu
59. lower card present transaction rate e Contact your merchant account provider to make sure that they support card present transactions e Contact PayPal Customer Service to request them to set up your account properly for accepting and passing swipe data e 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 Using the wrong account may result in downgrades e A sale is the preferred method to use for card present transactions Consult with your acquiring bank for recommendations on other methods Gateway Developer Guide and Reference 31 July 2012 57 6 Submitting Credit Card Transactions Submitting Card Present SWIPE Transactions Processing Platforms Supporting Card Present Transactions The following processing platforms support card present transactions American Express American Express APAC Elavon Fifth Third Processing Solutions First Data Merchant Services FDMS Nashville First Data Merchant Services FDMS North First Data Merchant Services FDMS South Global Payments Central Global Payments East Heartland Payment Systems Litle Merchant e Solutions Moneris Solutions Paymentech Salem Paymentech Tampa PayPal SecureNet TeleCheck TSYS Acquiring Solutions WorldPay Card Present Transactio
60. non numeric characters Example 951121737 Character length and limitations 9 characters Gateway Developer Guide and Reference 31 July 2012 121 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 e XXXXXXXXXXX international numbers Character length and limitations 10 characters SHIPTOFIRSTNAME Optional First name in the shipping address Character length and limitations 30 characters SHIPTOLASTNAME Optional Last name in the shipping address Character length and limitations 30 characters 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 Example 951121737 Character length and limitations 9 alphanumeric characters SHIPTOPHONENUM Optional Shipping telephone number Character length and limitations 10 alphanumeric characters Location Transaction Advice Addendum Parameters Parameter Description MERCHANTNAME Optional Name of merchant Character length and limitations 38 alphanumeric characters
61. only allowed within the original Sale processing window For NFTF cutoff time is 4 00PM CST recommend working with 3 30PM CST Adjustment transactions are electronically allowed within 90 days after the Sale transaction After the 90 day period all adjustments must be manually processed A prompt or process must be in place to identify a check as either personal or company Duplicate Checking TeleCheck has the ability to detect duplicate sale transactions at the point of sale if sent within a predetermined time limit Duplicates are identified when a sale inquiry 1s received with the same amount MICR number and check number matching a sale inquiry received within the last 2 minutes If a duplicate is detected it will return an ineligible response for ACH The 2nd transaction will also receive an ineligible response for ACH with the same ACH Transaction Status and Response Code as the original sale transaction The appropriate Application Type value must be sent to TeleCheck to indicate the type of NFTF transaction ICA CBP or NFTF PPD In the NFTF technical specification several data element fields and features are described as optional While these are technically optional meaning that the product can be technically implemented with or without them TeleCheck may require the merchant to code to one or more of these optional items based on the agreed upon contractual terms The merchant may need to account for and enable additi
62. returned unpaid I authorize you or your service provider to collect the payment and my state s return item fee by electronic fund 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 Internet Check Acceptance Recurring Payments WEB R By entering my account number above and clicking Authorize I authorize my payments to be processed as electronic funds transfers or drafts drawn from my account INSERT INFORMATION ON PAYMENT AMOUNT TIMING ETC If any of my payments are returned unpaid I authorize you or your service provider to collect the payment and my state s return item fee by electronic fund 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 This authorization is to remain in full force and effect until NAME OF MERCHANT has received written notification from me of my termination in such time and manner as to afford NAME OF MERCHANT a reasonably opportunity to act on it This text Click here to view your state s returned item fee in the consent language above represents a
63. reversal credit a payment or submit a payment for a credit 109 Time out waiting for host response The Payflow transaction server times out waiting for a financial host to respond This error can result in uncaptured authorizations on all platforms or settled sales on PayPal Australia Global Payments Central and PayPal 110 Referenced auth against order Error 111 Capture error Either an attempt to capture a transaction that is not an authorization transaction type or an attempt to capture an authorization transaction that has already been captured Gateway Developer Guide and Reference 31 July 2012 97 98 Transaction Responses RESULT Values and RESPMSG Text RESULT RESPMSG and Explanation 112 Failed AVS check Address and zip code do not match An authorization may still exist on the cardholder s account 113 Merchant sale total will exceed the sales cap with current transaction ACH transactions only 114 Card Security Code CSC Mismatch An authorization may still exist on the cardholder s account 115 System busy try again later 116 VPS Internal error Failed to lock terminal number For Moneris Solutions another transaction or settlement is in process Rerun the transaction later 117 Failed merchant rule check One or more of the following three failures occurred An attempt was made to submit a transaction that failed to meet the security settings specified on the PayPal Manager Security Settings page
64. sending the card issuer an authorization reversal void for 80 Submitting Purchasing Card Transactions A purchasing card also referred to as a commercial card corporate card procurement card or business card is a credit card that an employer requests to be issued A purchasing card is usually reserved for business related charges The card issuer provides specialized reporting for this card type so the employer can monitor the use of the card There is no method for determining whether a card is a purchase card or a commercial card based on the card number 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 Level 3 Transactions on page 143 NOTE The PayPal processor does not support purchasing card transactions Gateway Developer Guide and Reference 31 July 2012 65 66 Submitting Credit Card Transactions Submitting Reference Transactions Tokenization Submitting Reference Transactions Tokenization To recharge a credit card when you are not storing the credit card information in your local database you can perform a reference transaction A reference transaction takes the existing credit card information that is on file and reuses it Securely storing data for future reference is also known as tokenization The PNREF returned in the or
65. supported PayPal currencies See CURRENCY in this table for details 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 Nine numeric characters plus decimal L_OTYn Required if L_COSTn is supplied Line item quantity NOTE To enable line item support you must contact Merchant Technical Support at http www paypal com mts Limitations 10 character integer L_Skun Optional Product number NOTE To enable line item support you must contact Merchant Technical Support at http www paypal com mts Limitations 18 characters L_TAXAMTN Optional Line item tax amount NOTE To enable line item support you must contact Merchant Technical Support at http www paypal com mts 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 MERCHANTSESSIONID Optional Your customer Direct Payment session identification token PayPal records this session token as an additional means to detect possible fraud Limitations 64 characters 118 31 July 2012 Gateway Developer Guide and Reference Processors Requiring Additional Transaction Parameters E PayPal Credit Card Transaction Request Parameters
66. the Gateway features including Hosted Checkout Pages These users will see the following in the Service Summary box in PayPal Manager Hosted Checkout Pages amp Payflow SDK API Full Access Gateway Developer Guide and Reference 31 July 2012 13 14 Preface Intended Audience Service Summary Service Status Y Mode Hosted Checkout Pages Live PayTlow SDKLAPI Full Access Live e 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 8 Payflow SDK API Limited Access Service Summary Service Status Mode PayPal Payments Advanced Live Hosted Checkout Pages Live Live Payflow SOK API Limited Access Live 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 Hosted Checkout Pages e PayPal Payments Pro Transactions submitted by PayPal Payments Pro customers are processed through the Gateway with PayPal acting as the merchant bank PayPal Payments Pro users can use all of the Gateway features supported by PayPal These users will see the following in the Service Summary box in PayPal Manager PayPal Payments Pro with Hosted Checkout Page
67. the currency uses a decimal then 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 10 currency characters FREIGHTAMT Character length and limitations 10 currency characters PONUM Optional Purchase order number merchant related data Character length and limitations 25 alphanumeric characters provides best rate when used SHIPFROMZIP Optional The postal code called zip code in the USA from which shipping occurs Character length and limitations 9 numeric characters provides best rate when used SHIPTOZIP Optional Ship to postal code called zip code in the USA Character length and limitations 9 numeric characters provides best rate when used 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 Character length and limitations 10 currency characters 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions First Data Merchant Services South FDMS Purchasing Card Transaction Processing 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 name value starts with
68. the response back to the Gateway server and processes the transaction obtains the payment from the customer bank and deposits it in the merchant bank 5 The Gateway server returns the response to your website 6 Your website displays the result to the customer Gateway Developer Guide and Reference 31 July 2012 21 EN Introducing the Gateway Checkout Solutions About Security ad EPen HA A i ABC Company rn m tu HA _ O 0 o C9 o E etre reece rer ered Customer Merchant s Site Gateway Server Payment Processing Network You can use the core transaction parameters supported by all Gateway processors described in this dcumentation to send transaction data to your processor In addition e Each Gateway processor may support various additional parameters beyond the core set that you can send in transaction requests e 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 The parameter information may appear on the customer s statement or describe line items in greater detail Be sure to check for your processor s Level 2 and 3 parameters in this documentation The sections in this documentation describing the above parameters alphabetically organize parameters by processor name About Sec
69. 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 SECURETOKENID 9a9ea8208de1413abc3d60c86cb1f4c5 2 Set CREATESECURETOKEN to the value Y to request that Payflow gateway return a token CREATESECURETOKEN Y Secure Token Example The following is an example of a request parameter string that creates a secure token TRXTYPE ASBILLTOSTREET 123 Main St amp BILLTOZIP 95131 amp AMT 23 45 amp CURRENCY USD amp INVNUM INV12345 amp PONUM P098 76 amp CREATESECURETOKEN Y amp SECURETOKENID 9a9ea8208de1 413abc3d60c86cb1f4c5 The Gateway server returns SECURETOKEN and SECURETOKENTD in the response A tag follows the SECURETOKEN to indicate the length of the token value returned RESULT 0 amp RESPMSG Approved amp SECURETOKEN 25 Fj 1lAFUWf t0 I0CUFOKh5WA amp SECURET OKENID 9 a9ea8208de1413abc3d60c86cb1f4c5 Integrating the Secure Token Without the Hosted Checkout Pages Transparent Redirect To use your own checkout pages while complying with PCI guidelines sending the customer s sensitive data directly to the Gateway server pass all parameters that you need to process the transaction except for sensitive payment details such as the credit card number expiration date and check number For details on sending transactions see Submitting Credit
70. unit price L_COSTn fields Parameter Description L_COMMCODEN Optional Item commodity code Character length and limitations 12 alphanumeric characters L_DESCn Required Item descriptor Character length and limitations 35 alphanumeric characters L UPCN Optional Product code Character length and limitations 12 alphanumeric characters L_OTYn Required Item 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 Character length and limitations 12 numeric characters L_TAXRATEN Optional VAT tax rate Character length and limitations 4 numeric characters L DISCOUNTN Optional Discount per line item Character length and limitations 12 numeric characters 186 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions TSYS Acquiring Solutions Purchasing Card Transaction Processing Parameter Description L_AMIn Optional Line item total Character length and limitations 12 numeric characters Example SecureNet Level 3 Visa Transaction Parameter String TRXTYPE S amp TENDER C amp PARTNER Partner amp USER User amp PWD Password amp ACCT 411111111111 1111 amp EXPDATE 1215 amp AMT 1 OO amp BILLTOSTREET 5199 JOH
71. 000 KVA MVA Megawatt MAW Megawatt hour 100 kW h MWH Metre per second squared MSK Metre per second MTS Metre MTR Metric carat 200 mg 2 10 4 kg CTM Metric ton 1000 kg TNE Milliard MLD Gateway Developer Guide and Reference 31 July 2012 221 222 Codes Used by FDMS South Only Units of Measure Millibar Millicurie Milligram Millilitre Millimetre Million Million cubic metres Million international units Minute Month Nautical mile 1852 m Net register ton Newton Number Number of articles Number of bobbons Number of cells Number of international units Number of packs Number of pairs Number of parcels Number of parts Number of rolls Ohm Ounce GB US 28 349523 g Ounce GB US 31 103448 g syn Troy ounce Pascal Pennyweight GB US 1555174 g Piece Pint 0 568262 dm3 Pound GB US 0 45359237 kg Proof gallon 31 July 2012 Gateway Developer Guide and Reference Codes Used by FDMS South Only E 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 Sq
72. 012 Gateway Developer Guide and Reference Transaction Responses aa Credit Card Transaction Responses Field Description HOSTCODE RESPTEXT PROCCARDSECURE ADDLMSGS PAYMENTTYPE CORRELATIONID AMEXID AMEXPOSDATA ORIGAMT 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 Character length and limitations 6 characters The raw text returned by the processor which corresponds to the returned HOSTCODE This field is not normalized and is returned when VERBOSITY is set to HIGH Character length and limitations 32 characters The raw Buyer Authentication response returned by the processor This field is not normalized and is returned when VERBOSITY is set to HIGH Character length and limitations 1 character Additional error message that indicates the use of a features that has been disabled Character length and limitations Up to 1048 characters Typically 50 characters PayPal only Returns instant if the payment is instant or echeck if the payment is delayed DP on the PayPal processor Character length and limitations 7 character string PayPal only Value used for tracking this Dire
73. 234 56 Character length and limitations 10 currency characters Optional Merchant invoice number This reference number PNREF generated by PayPal is used for authorizations and settlements The acquirer decides if this information will appear on the merchant s bank reconciliation statement Character length and limitations 9 alphanumeric characters Optional Cardholder s last name Character length and limitations 15 alpha characters Optional Order date Format is mmddyy with no slashes or dashes For example July 28 2003 is 072803 Character length and limitations 6 numeric characters 156 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions First Data Merchant Services South FDMS Purchasing Card Transaction Processing Field Description ORDERTIME Optional Order time and date Format is either YYYY MM DD or YYYY MM DD HH MI SS where HH is in 24 hour time If the value does not conform to one of the formats or if the date is not valid for example 2004 17 35 then the transaction is rejected with a RESULT 7 SIG FIELD ERR and RESPMSG Invalid ORDERTIME A truncated version of the ORDERTIME value up to 7 characters overwrites any value provided by ORDERDATE If no value is provided a NULL value is stored Character length and limitations 19 alphanumeric characters PONUM Optional Purchase order number merchant related data Chara
74. 4 amp EXPDATE 1215 amp AMT 123 OOSBILLTOSTREET 5 199 Maple amp BILLTOZIP 98765 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 amp PNREF VXW4 12345678 amp RESPMSG APPROVED amp AUTHCODE 123456 amp AVSADDR Y amp AVSZ IP N amp IAVS X 31 July 2012 Gateway Developer Guide and Reference Submitting Credit Card Transactions Using Card Security Code Using Card Security Code The card security code is a 3 or 4 digit number not part of the credit card number that is printed on the credit card Because the card security code appears only on the card and not on receipts or statements the code provides some assurance that the physical card is in the buyer s possession This fraud prevention tool has various names depending on the payment network Visa calls it CVV2 MasterCard calls it CVC2 while American Express and Discover call it CID To make sure that your customers see a consistent name PayPal recommends use of the term card security code on all end user materials On most cards Diners Club Discover Mastercard and Visa the card security code is a 3 digit number printed on the back of the card usually in the signature field All or part of the card number appears before the card security code 567 in the example American Express prints a 4 digit number 1122 in the example on the front of the card above and to the right
75. 5 SecureNet Additional Credit Card Parameters for American Express 120 Retail Transaction Advice Addendum for SWIPE transactions 120 Internet Transaction Data oaoa aoa a a a a a 121 AVS Paraimeterss ooo to ca a Dd da e a Geo ae i ee OP ge a 121 Location Transaction Advice Addendum Parameters 122 Transaction Advice Detail Parameters aooaa a a a a a a ee 123 Airline Passenger Data Parameters oaoa a aaa a a 123 Other Parameters a a a 125 Vantiv Additional Credit Card Parameters 2 a a a a a a 125 Additional Credit Card Parameters e e 125 Soft Merchant Descriptor Parameters 126 WorldPay Additional Credit Card Parameters 0 e 2 127 Chapter B TeleCheck Electronic Check Processing 129 TeleCheck NFTF Overview of Services o a 129 TeleCheck NFTF Processing Overview o 0 eee ee ee 129 NFTF Requirements ee 129 NFTF Processing Considerations 0 00000 eee eee 131 NETA Guid line Ss rc xe ae eee gee wc a a ee ae wee EE a EE ea N 131 TeleCheck Parameters oaoa oa oaa a a a 132 Required TeleCheck Parameters a 133 Testing TeleCheck Transactions a o o oa a a 0 eee ee 135 Example Test Transaction a a a a 135 Gateway Developer Guide and Reference 31 July 2012 7 En Content
76. AUTHCODE 12 amp TRACEID 1234567890 amp ACHSTATUS A amp HOST CODE 07 amp TRANSTIME 2012 02 09 15 23 37 amp BILLTOFIRSTNAME Sally amp BILLTOLASTNAME Smith amp AMT 35 00 amp CARDTYPE P This is the delayed capture request and response TRXTYPE D amp TENDER K amp PARTNER partner amp USER user amp VENDOR vendor amp PWD pwd amp ORIGID E ORB8A32CD6 9 VERBOSTTY HIGH RESULT 0 amp PNREF EQRB8A3 2 CD6A amp RESPMSG Approved amp AUTHCODE 0 0 amp TRACEID 1234567890 amp ACHSTATUS A amp HOSTCODE 07 amp TRANSTIME 2012 02 09 15 24 22 Gateway Developer Guide and Reference 31 July 2012 135 136 TeleCheck Electronic Check Processing Preparing for TeleCheck Production Transactions MICR values for testing You may view a complete list of TeleCheck response codes at Sale Response Code Values on page 137 MICR HOSTCODE TeleCheck Result 3333333333 07 Approved 1111111111 08 Rejected negative data 2222222222 88 Rejected Code 3 Risk Preparing for TeleCheck Production Transactions Before going into production with your check integration you must certify your storefront with TeleCheck To begin the certification process send an e mail to iica_certification telecheck com Be sure to include the following information e Your test website address where test transactions can be processed e The name e mail address and phone number of the person to contact about any needed corrections The certification process usually ta
77. AXEXEMPT Y amp DISCOUNT 1 OO amp FREIGHTAMT 1 OO amp DUTYAMT 1 OO amp SHIPTOZIP 33333 amp SHIPFROMZIP 44444 amp SHI PIOCOUNTRY 84 0 amp ORDERDA TE 020725 amp L COMMCODE1 123456789ABC amp L DESCl Line item 1 description amp L_UPC1 C BA987654321 amp L QTY1 1 amp L UOM1 123456789012 amp L COST1 1 00 amp L TAXAMT1 1 00 amp L TAXR ATE1 1 00 amp L DISCOUNT1 1 00 amp L AMT1 1 00 amp L TAXTYPE1 TT3 SecureNet Acquiring Solutions Level 3 Visa Parameters To qualify for Level 3 purchasing card transaction processing 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 Level 3 transactions that do not include the required Level 2 values are rejected IMPORTANT The values required for Level 3 status vary by bank so contact your bank for details SecureNet Level 2 Visa Parameters for Level 3 Line Item Transactions Parameter Description Required Purchase identifier The transaction ID is sent if no value is provided Character length and limitations 25 alphanumeric characters 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions SecureNet Purchasing Card Transaction Processing Parameter Description TAXAMT Required Tax amount The value must inclu
78. CCT AMT BILLTOCITY BILLTOCOUNTRY BILLTOEMAIL BILLTOMIDDLENAME BILLTOLASTNAME BILLTOPHONENUM BILLTOSTATE BILLTOSTREET BILLTOZIP COMMENTI COMMENT2 COMPANYNAME CUSTCODE CUSTIP EXPDATE INVNUM PONUM SHIPTOCITY SHIPTOCOUNTRY SHIPTOFIRSTNAME SHIPTOMIDDLENAME SHIPTOLASTNAME SHIPTOSTATE SHIPTOSTREET SHIPTOZIP SWIPE Example Credit Transaction Parameter Strings The following is an example of a credit transaction string non referenced credits not allowed TRXTYPE C amp TENDER C amp PARTNER PayPal amp VENDOR SuperMerchant amp USER SuperMerchant amp P WD x1y2z3 ORIGID VPNE12564395 The following is an example credit transaction string non referenced credits allowed TRXTYPE C amp TENDER C amp PARTNER PayPal amp VENDOR SuperMerchant amp USER SuperMerchant amp P WD x1y2z3 amp ACCT 5555555555554444 amp EXPDATE 1215 amp AMT 123 OO amp VERBOSITY HIGH Submitting Inquiry Transactions An inquiry transaction TRXTYPE I returns the result and status of a transaction 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 While the amount of information returned in an inquiry transaction depends upon the VERBOSITY setting inquiry responses mimic the verbosity level of the original transaction a
79. CODE MERCHANTLOCATIONID MERCHANTID MERCHANTCONTACTINFO Optional The name of the city were the transaction took place e Ifyou 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 e If you are a mail order phone order or internet industry you may substitute the name of the city in which the merchant s order processing facility is located Character length and limitations 21 alphanumeric characters If more than 21 characters use proper and meaningful abbreviation Do not truncate Optional The region code that corresponds to the state province or country subdivision of the merchant location where the transaction took place Region code examples e CA California USA e NS Nova Scotia Canada e COS Colima Mexico If you are a third party biller bill for services or goods rendered by another entity you must enter the region code that corresponds to the state province or country subdivision in which the seller is located Character length and limitations 3 alphanumeric characters Optional The 5 to 9 digit zip postal code excluding spaces dashes and non numeric characters where the transaction took place If you are a third party biller bill for services or goods rendered by another entity you must enter the postal code that corresponds to the seller s location Character length and limitations 15 alphanume
80. CT e EXPDATE This is an example upload transaction request TRXTYPE L amp TENDER C amp ACCT 5105105105105100 amp EXPDATE 1215 amp BILLTOFIRSTNAME Ted amp B ILLTOLASTNAME Smith amp BILLTOSTREET 123 amp SBILLTOCITY SanJose amp BILLTOSTATE CA amp BILL TOZIP 12345 amp BILLTOPHONENUM 123 123 1234 This is the response RESULT 0 amp PNREF v19A2E710FCF amp RESPMSG Approved amp TRANSTIME 2011 11 02 16 53 58 31 July 2012 Gateway Developer Guide and Reference Submitting Credit Card Transactions Submitting Sale Transactions You can send shipping and billing information to be stored but you must not include the AMT field If you pass a value for AMT you will receive an error with RESULT 4 and RESPMSG Invalid Amount NOTE PayPal does not verify the credit card data as it is not sent to the banks for processing To validate a transaction you must submit an account verification also known as a zero dollar authorization TRXTYPE A For details see Submitting Account Verifications on page 54 Submitting Sale Transactions The sale transaction TRXTYPE S charges the specified amount against the account and marks the transaction for immediate fund transfer during the next settlement period PayPal submits each merchant s transactions for settlement on a daily basis NOTE PayPal Payments Advanced and Payflow Link users cannot submit sale transactions unless they obtain the Payflow SDK When To Use a Sale Transaction A sa
81. DK supports the following transaction types for credit card processing Transaction Type Billable Authorization Yes Account Verification No 31 July 2012 Gateway Developer Guide and Reference Submitting Credit Card Transactions Planning Your Gateway Integration Transaction Type Billable Balance Inquiry No Credit Yes Delayed Capture No Inquiry No Sale Yes Voice Authorization Yes Void Yes The Payflow SDK also supports the following credit card features Address verification service and card security code validation Card present SWIPE transactions Partial authorizations for pre paid cards Purchasing card transactions Reference transactions also called tokenization Submitting Soft Merchant information Planning Your Gateway Integration When designing your Gateway integration evaluate Whether to use a one step or two step transaction process One step Submit a sale transaction which performs the authorization and if successful then flags the transaction for settlement Two step Perform an authorization only transaction and then later perform a delayed capture transaction The delayed capture transaction can be for the same amount as the original transaction or for a lower amount In the case of a split shipment you can perform a delayed capture transaction for the initial shipment and a reference transaction for the final payment According to card association rules most physical goods merchan
82. Description AIR Optional Number of passengers on this trip NUMBEROFPASSENGERS 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 Character length and limitations 15 alphanumeric characters Other Parameters Field Description BILLTOFIRSTNAME Optional Account holder s first and last name NOTE Even though the parameter name indicates only the first name this single parameter holds all of the person s name information both first and last name at a minimum Character length and limitations 13 alphanumeric characters BILLTOLASTNAME Optional Account holder s last name Character length and limitations 13 alphanumeric characters 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 Character length and limitations 17 alphanumeric characters ORDERDATE Optional Specifies an order date Character length and limitations 6 numeric characters Format mmddyy with no slashes or dashes For example July 28 2003 is 072803
83. ELENA SH ST KITTS NEVIS ANGUILLA KN ST LUCIA LC ST PIERRE AND MIQUELON PM ST VINCENT AND THE GRENADINES VC SUDAN SD SURINAME SR SVALBARD AND JAN MAYEN IS SJ SWAZILAND SZ SWEDEN SE SWITZERLAND CH SYRIAN ARAB REPUBLIC SY TAIWAN PROVIDENCE OF CHINA TW TAJIKISTAN TJ TANZANIA UNITED REPUBLIC TZ THAILAND TH TOGO TG TOKELAU TK TONGA TO TRINIDAD AND TOBAGO TT TUNISIA TN TURKEY TR TURKMENISTAN TM TURKS AND CAICOS ISLANDS TC TUVALU TV U S MINOR OUTLYING ISL UM UGANDA UG UKRAINIAN SSR UA UNITED ARAB EMIRATES AE UNITED KINGDOM GB JNITED STATES US URUGUAY UY 31 July 2012 Gateway Developer Guide and Reference Codes Used by FDMS South Only ES 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 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 Becquerel BQL Billion EUR BIL Billion US MLD Board foot BFT Brake horse power 245 7 watts BHP British thermal unit 1 055 kilojoules BTU Gateway Developer Guide and Reference 31 July 2012 217 218 Codes Used by FDMS South Only Units of Measure Bushel 35 2391 dm3 BUA Bushel 36 36874 dm3 BUI Candela CDL C
84. EN L_COMMCODEN L_DESCN L_AMTn L SKUN L QTYN L CARRIERSERVICELEV ELCODEN L_COSTN L_UOMn L_TAXAMTN L_TAXRATEN Optional Alternate tax rate for this item Character length and limitations 4 numeric characters plus decimal XX XX Optional Alternate tax identifier for this item Character length and limitations 95 alphanumeric characters Optional Extended item amount Character length and limitations 8 numeric characters Optional Tax type applied Character length and limitations 4 alphanumeric characters Optional Item commodity code Character length and limitations 35 alphanumeric characters Optional Item description Character length and limitations 10 currency characters Optional Total line item amount including tax for debit for credits 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 12 numeric characters Optional Item s supplier stock keeping unit SKU number or product code Character length and limitations 8 numeric characters Required Quantity whole units only Character length and limitations 10 numeric characters Optional Service code Character length and limitations 1 alphanumeric character Optional Item freight amount Character length and limitations Must include a decimal and be exact to the c
85. ER PayPal amp VENDOR SuperMerchant amp USER SuperMerchant amp PWD x1y2z3 amp CUSTREF Inv00012345 Required Parameters When Using the Secure Token To perform an inquiry transaction when using the secure token pass the following parameter Parameter Description SECURETOKEN Required A value the Payflow server created upon your request for storing transaction data Limitations 32 alphanumeric characters Set SECURETOKEN to the PNREF Transaction ID in PayPal Manager reports value returned for the original transaction Inquiry Parameter String Using the Secure Token The following is an example inquiry request string with the SECURETOKEN parameter TRXTYPE 1 amp TENDER C amp PARTNER PayPal amp PWD SuperUserPassword amp USER SuperMerchant amp VERBOS ITY HIGH amp VENDOR SuperMerchant amp SECURETOKEN FmyM1ly7wy8kiS6aumnMPhTONE VE RBOSITY HIGH The following is the response string Gateway Developer Guide and Reference 31 July 2012 63 6 Submitting Credit Card Transactions Submitting Partial Authorizations RESULT 0 amp PNREF VFHE1AOCBOA9 amp TRANSSTATE 6 amp SORIGRESULT 0 amp ORIGPNREF VFHE1AOCBOA 8 amp RESPMSG Approved amp AUTHCODE 010101 amp AVSADDR Y amp AVSZI P Y amp HOSTCODE 00 amp PROCAVS Y amp DATE TO SETTLE 2011 02 04 16 16 50 amp TRANSTIME 2011 02 04 16 16 50 amp BILLTOFIRSTNAME James amp BILLTOLASTNAME Smith amp AMT 555 OO amp ACCT 0002 amp EXPDATE 0120 amp CARDTYPE 0 amp IAVS N Submitting Par
86. HTAMTN L_HANDLINGAMTN L_TRACKINGNUMN L_PICKUPSTREETN L PICKUPCITYAN L PICKUPSTATEN L PICKUPZIPN L_PICKUPCOUNTRYN L_UNSPSCCODEN Optional The item s supplier stock keeping unit SKU number Character length and limitations 1 to 30 alphanumeric characters Optional The item s universal product code UPC Character length and limitations Optional Item tax amount Character length and limitations Optional Freight amount Character length and limitations Optional Handling amount Character length and limitations Optional Tracking number Character length and limitations Optional Drop off address 1 Character length and limitations Optional Drop off city Character length and limitations Optional Drop off state Character length and limitations 1 to 30 alphanumeric characters 1 to 6 numeric characters 1 to 15 numeric characters 1 to 15 numeric characters 1 to 30 alphanumeric characters 1 to 40 alphanumeric characters 2 to 30 alphanumeric characters 2 alphanumeric characters Optional Drop off postal or zip code Character length and limitations Optional Drop off country Character length and limitations Optional UNSPSC code Character length and limitations 3 to 15 alphanumeric characters 2 to 3 alphanumeric characters 1 to 30 alphanumeric characters Example American Express Level 3 Transaction Paramet
87. IA LUXEMBOURG GNB GUY HTI HMD HND HKG HUN ISL IND IDN IRN IRQ IRL ISR ITA JAM JPN JOR KOR KWT KGZ LAO LVA LBN LSO LBR LBY LIE LTU LUX 31 July 2012 Gateway Developer Guide and Reference Codes Used by FDMS South Only E 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 NIGERIA NGA NIUE NIU NORFOLK ISLAND NFK NORTHERN MARIANA ISLAND MNP Gateway Developer Guide and Reference 31 July 2012 207 208 Codes Used by FDMS South Only MasterCard Country Codes for FDMS South Only NORWAY OMAN PAKISTAN PALAU PANAMA PAPUA NEW GUINEA PARAGUAY PERU PHILIPPINES PITCAIRN ISLAND POLAND PORTUGAL PUERTO RICO QATAR REUNION ROMANIA RUSSIAN FEDERATION RWANDA SAMOA SAN MARINO SAN TOME AND PRICIPEL SAUDI ARABIA SEYCHELLES SIERRA LEONA SINGAPORE ST HELENA ST KITTS NEVIS ANGUILLA ST LUCIA ST PIERRE AND MIQUELON ST VINCENT AND THE GRENADINES SUDAN SURINAME NOR OMN PAK PLW PAN PNG PRY PER PHI PCN POL PRT PRI QAT REU ROM RUS RWA WSM SMR STP
88. If the transaction exceeded the Maximum Amount security setting then no values are returned for AVS or CSC AVS validation failed The AVS return value should appear in the RESPMSG CSC validation failed The CSC return value should appear in the RESPMSG 118 Invalid keywords found in string fields 120 Attempt to reference a failed transaction 121 Not enabled for feature 122 Merchant sale total will exceed the credit cap with current transaction ACH transactions only 125 Fraud Protection Services Filter Declined by filters 126 Fraud Protection Services Filter Flagged for review by filters NOTE RESULT value 126 indicates that a transaction triggered a fraud filter This is not an error but a notice that the transaction is in a review status The transaction has been authorized but requires you to review and to manually accept the transaction before it will be allowed to settle RESULT value 126 is intended to give you an idea of the kind of transaction that is considered suspicious to enable you to evaluate whether you can benefit from using the Fraud Protection Services To eliminate RESULT 126 turn the filters off For more information see the fraud documentation for your payments solution 127 Fraud Protection Services Filter Not processed by filters 128 Fraud Protection Services Filter Declined by merchant after being flagged for review by filters 132 Card has not been submitted for update 133 Data mismatch in HTTP
89. LTAXAMT Optional National tax amount Character length and limitations 12 numeric characters INVNUM Required Purchase order number customer reference ID The Transaction IDis sent if no value is provided Character length and limitations 9 alphanumeric characters Heartland Level 3 Visa Extended Data The parameters listed in the table below apply to Level 3 MasterCard transactions as extended data Parameter Description COMMCODE Optional Summary commodity code identifier for the business Character length and limitations 4 alphanumeric characters DISCOUNT Optional Discount amount Character length and limitations 12 numeric characters 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 Character length and limitations 6 numeric characters SHIPTOZIP Required The zip code of the address to which the goods are shipped Character length and limitations 10 alphanumeric characters SHIPFROMZIP Required The postal code called zip code in the USA from which shipping occurs Character length and limitations 10 alphanumeric characters SHIPTOCOUNTRY Optional Destination country code Character length and limitations 3 alphanumeric characters 31 July 2012 Gateway Deve
90. Merchant defined value for reporting and auditing purposes Limitations 128 alphanumeric characters Optional A code printed not imprinted on the back of a credit card Used as partial assurance that the card is in the buyer s possession Limitations 3 or 4 digits Optional Identifies the transaction as recurring It is one of the following values e Y Identifies the transaction as recurring e N Does not identify the transaction as recurring default This value does not activate the Payflow Recurring Billing Service API If the RECURRING parameter value is Y in the original transaction this value is ignored when forming credit void and force transactions If you subscribe to the Payflow Fraud Protection Services e To avoid charging you to filter recurring transactions that you know are reliable the fraud filters do not screen recurring transactions e To screen a prospective recurring customer submit the transaction data using PayPal Manager s Manual Transactions page The filters screen the transaction in the normal manner If the transaction triggers a filter follow the normal process to review the filter results NOTE If your transaction is declined and the PAYMENTADVICECODE response parameter is supported by your processor a PAYMENTADVICECODE value is returned representing the reason that the transaction was declined Obtain the meaning of PAYMENTADVICECODE values from your acquiring bank Character length and li
91. N 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 JAMAHIRIYA LY Gateway Developer Guide and Reference 31 July 2012 213 A 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 NEW ZEALAND NZ 214 31 July 2012 Gateway Developer Guide and Reference Codes Used by FDMS South Only E 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 SIERRA LEONA SL SINGAPORE SG Gateway Developer Guide and Reference 31 July 2012 215 216 Codes Used by FDMS South Only Visa Country Codes ST H
92. NSON amp TAXAMT 1 06 amp BILLTOZIP 94588 amp ALTTAXAMT 1 008CUSTVATREGNUM 1111186LOCALTAXAMT 1 018NATIONALTAXAMT 1 02 amp COMMCODE 22222 amp VATAXAMT 1 03 amp VATAXPERCENT 55 amp TAXEXEMPT N amp DISCOUNT 50 amp FR EIGHTAMT 1 OO amp DUTYAMT 1 OO amp SHIPTOZIP 33333 amp SHIPFROMZIP 44444 amp SHIPTOCOUNTRY 840 amp ORDERDATE 081125 amp L COMMCODE1 123456789ABC amp L DESC1l Line item 1 descripti on amp L UPC1 CBA987654321 amp L OTY1 1 amp L UOM1 123456789012 amp L COST1 1 50 amp L TAXAMT1 1 0581 TAXRATE1 12 amp L DISCOUNT1 50 amp L AMT1 1 00 amp L TAXTYPE1 TT1 TSYS Acquiring Solutions Purchasing Card Transaction Processing TSYS Acquiring Solutions supports MasterCard and Visa for performing Level 2 and Level 3 purchasing card transactions TSYS Acquiring Solutions Level 2 Parameters TSYS Acquiring Solutions supports MasterCard and Visa for Level 2 purchasing card transactions TSYS Acquiring Solutions indicates in the authorization response whether the credit card in the transaction is a commercial card Based in the commercial card indicator Payflow will format the Level 2 information in the settlement request To get the discount rate Level 2 parameters marked as required in the following table must be present TSYS Acquiring Solutions Level 2 Parameters Parameter Description PONUM Required Customer reference ID Character length and limitations 1 to 17 alphanumeric characters TAXAMT Required Tax amo
93. ONUM Required Customer reference ID Character length and limitations 1 to 16 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 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 Character length and limitations 1 alpha character Y or N Example Merchant e Solutions Level 2 Visa Transaction Parameter String TRXTYPE S6ACCT 411111111111111186AMT 20 0286BILLTOCITY Mountain View amp COMMENT1 L2 Testing amp EXPDATE 1215 amp INVNUM 661254585 amp BILLTOFIRSTNAME CardHolder Name amp P ARTNER PayPal amp PWD pwd amp BILLTOSTATE CA amp BILLTOSTREET 123 Main St amp TAXAMT 1 01 amp TAXEXEMPT N amp TENDER C amp USER user amp BILLTOZIP 94043 Merchant e Solutions Level 3 MasterCard Parameters To qualify for Level 3 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 Level 3 transactions that do not include the required Level 2 values are rejected IMPORTANT The values required for Level 3 status vary by bank so contact your bank for details Gateway Developer Guid
94. OUNTN Optional Discount per line item Character length and limitations 10 currency characters L_AMTN Optional Total line item amount including tax and discount for debit for credits Character length and limitations 10 currency characters L_TAXAMTn Optional Line item tax amount Character length and limitations 10 currency characters WorldPay Purchasing Cards Transaction Processing The following parameters are recommended to obtain the best rates for Level 2 and Level 3 purchasing card transactions with WorldPay WorldPay Level 2 Parameters Pass the following WorldPay Level 2 parameters to get the discount rate WorldPay Level 2 parameters Level 2 Parameters Description ALTTAXAMT COMMCODE Optional Alternate tax amount Character length and limitations 8 alphanumeric characters Optional Summary commodity code identifier for the business Character length and limitations 4 alphanumeric characters 194 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions WorldPay Purchasing Cards Transaction Processing Level 2 Parameters Description COUNTRYCODE CUSTDATA CUSTOMERID CUSTOMERNUMBER DISCOUNT DLNAME DLNUM DOB DUTYAMT FREIGHTAMT INVNUM MERCHANTDESCR MERCHANTINVNUM MERCHANTVATNUM MERCHANTZIP Optional Country code Character length and limitations 3 alphanumeric character
95. PWD pwd amp BILLTOSTATE CA amp BILLTOSTREET 123 Main St amp TAXAMT 1 01 amp TAXEXEMPT N amp TENDER C amp USER usersBI LLTOZIP 94043 SecureNet Level 3 MasterCard Parameters To qualify for Level 3 purchasing card transaction processing 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 Level 3 transactions that do not include the required Level 2 values are rejected IMPORTANT The values required for Level 3 status vary by bank so contact your bank for details SecureNet Level 2 MasterCard Parameters Required for Level 3 Line Item Transactions Parameter Description PONUM Required Purchase identifier The transaction ID is sent if no value is provided 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 Character length and limitations numeric LOCALTAXAMT Optional Local tax Character length and limitations 12 numeric characters 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions SecureNet Purchasing Card Transaction Processing Parameter Description
96. PayPal Gateway Developer Guide and Reference PayPal Payments Advanced PayPal Payments Pro Payflow Pro Payflow Link Last updated 31 July 2012 Gateway Developer Guide and Reference Document Number 200045 en_US 20120731 O 2012 PayPal Inc All rights reserved PayPal is a registered trademark of PayPal Inc The PayPal logo is a trademark of PayPal Inc Other trademarks and brands are the property of their respective owners The information in this document belongs to PayPal Inc It may not be used reproduced or disclosed without the written approval of PayPal Inc Copyright PayPal All rights reserved PayPal Europe S r l et Cie S C A Soci t en Commandite par Actions Registered office 22 24 Boulevard Royal L 2449 Luxembourg R C S Luxembourg B 118 349 Consumer advisory The PayPal payment service is regarded as a stored value facility under Singapore law As such it does not require the approval of the Monetary Authority of Singapore You are advised to read the terms and conditions carefully Notice of non liability PayPal Inc is providing the information in this document to you AS IS with all faults PayPal Inc makes no warranties of any kind whether express implied or statutory with respect to the information contained herein PayPal Inc assumes no liability for damages whether direct or indirect caused by errors or omissions or resulting from the use of this document or the informat
97. Payments Advanced and Payflow Link users cannot submit authorization transactions unless they obtain the Payflow SDK When to Use Authorization Delayed Capture Transactions If your business does not provide immediate fulfillment of products or services PayPal recommends that you use delayed capture processing It enables you to capture credit card payments when you are ready to collect them NOTE If you signed up for the PayPal processor with Fraud Protection Services use delayed capture processing for all sale 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 69 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 For details see Submitting Reference Transactions Tokenization on page 66 NOTE You are allowed to perform one delayed capture transaction per authorization transaction Gateway Developer Guide and Reference 31 July 2012 55 6 Submitting Credit Card Transactions Submitting Balance Inquiry Transactions Required Authorization Transaction Parameters To perform a delayed capture transaction pass the following parameter Parameter Description ORIGID Required by some transaction types 1D of the original transaction referen
98. Purchasing Card Level 2 and Level 3 Transactions American Express Purchasing Card Transaction Processing Accepted BIN Ranges The following BIN ranges are accepted for American Express Level 2 and Level 3 transactions 37326 37429 37857 37859 37873 37965 American Express Purchasing Card Transaction Processing The American Express supports Level 2 transaction data NOTE Most merchants in the United States follow American Express reporting and statement requirements International merchants now follow these requirements as well but there maybe a few exceptions If you are not sure contact your American Express Representative American Express Level 2 Parameters for American Express The parameters to meet American Express reporting and statement requirements are described in the following tables CPC Level 2 Transaction Advice Addendum Parameters Field Description PONUM Required Purchase order number Character length and limitations 17 alphanumeric characters SHIPTOZIP Optional Ship to postal code called zip code in the USA This field must contain TAXAMT L DESC1 one of the following values e Zip code of the destination where the merchandise is to be shipped e If the above is not available Zip code of the location where the merchant executed the transaction Character length and limitations 15 alphanumeric characters Optional Total tax amount Must include a decimal and the exact amoun
99. R PHONE PHONETOSHIP PONUM SHIPAMOUNT STATE STATETOSHIP TAX TYPE USER1 USER10 ZIP ZIPTOSHIP CVV2MATCH CUSTID N A DLNUM BILLTOEMAIL SHIPTOEMAIL EXPDATE BILLTOFAX SHIPTOFAX BILLTOFIRSTNAME INVNUM BILLTOLASTNAME VENDOR TENDER BILLTOFIRSTNAME BILLTOLASTNAME SHIPTOFIRSTNAME SHIPTOLASTNAME PARTNER BILLTOPHONENUM SHI PTOPHONENUM PONUM FREIGHTAMT BILLTOSTATE SHIPTOSTATE TAXAMT TRXTYPE USER BILLTOZIP SHIPTOZIP 31 July 2012 Gateway Developer Guide and Reference
100. Required American Express assigned service establishment number used to identify and facilitate payments to merchants NOTE 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 Character length and limitations 15 alphanumeric characters 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 NOTE 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 Character length and limitations 40 alphanumeric characters 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 12 numeric characters ADDLAMTTYPEN Optional A 3 digit code indicating the type of the corresponding charge detail where n is a value from 1 5 Character length and limitations 3 numeric
101. SAU SYC SLE SGP SHN KNA LCA SPM VCT SDN SUR 31 July 2012 Gateway Developer Guide and Reference Codes Used by FDMS South Only E 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 UMI UGANDA UGA UKRAINE UKR UNITED ARAB EMIRATES ARE UNITED KINGDOM GBR UNITED STATES USA URUGUAY URY UZBEKISTAN UZB VANUATU VUT VATICAN CITY STATE VAT VENEZUELA VEN VIETNAM VNM VIRGIN ISLANDS BRITISH VGB VIRGIN ISLANDS US VIR Gateway Developer Guide and Reference 31 July 2012 209 210 Codes Used by FDMS South Only Visa Country Codes WALLIS AND FUTUNA IS WESTERN SAHARA YEMEN YUGOSLAVIA ZAIRE ZAMBIA ZIMBABWE WLF ESH YEM YUG ZAR ZMB Visa Country Codes ALBANIA AL ALGERIA DZ AMERICAN SAMOA AS ANDORRA AD ANGOLA AO ANGUILLA Al ANTARCTICA AQ ANTIGUA AG APHGANISTAN AF ARGENTINA AR ARMENIA AM ARUBA AW AUSTRALIA AU AUSTRIA AT AZERBAIJAN AZ BAHAMAS BS BAHRAIN BH BANGLADESH BD BARBADOS BB BELARUS BY BELGIUM BE 31 July 2012 Gateway Developer Guide and Reference Codes Used by FDMS South Only E Visa Country Codes BELIZE BZ BENIN
102. SULT value 25 Invalid host mapping or the processor returns a message that the customer is not signed up for the card type Optionally you can provide your customer with a list of the card types that you accept in a drop down list or menu for example 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 31 July 2012 Gateway Developer Guide and Reference Submitting Credit Card Transactions CEN Core Credit Card Parameters NOTE American Express cards require explicit acceptance when PayPal is the processor To accept American Express cards go to the Profile Page in PayPal Manager and click American Express card acceptance Core Credit Card Parameters All credit card processors accept the basic parameters described in the following table with one exception the PayPal processor does not support SWIPE Parameter Description TENDER Required The method of payment Values are e A Automated clearinghouse ACH e C Credit card e D Pinless debit e K Telecheck e P PayPal See the Payflow ACH Payment Service Guide for details on the ACH tender type TRXTYPE Required Indicates the type of transaction to perform Values are e A Aut
103. Transaction a 46 Formatting Payflow Gateway Transactions o e 2 2 46 Chapter 6 Submitting Credit Card Transactions 47 Obtaining an Internet Merchant Account o e e 47 About Credit Card Processing e o 48 Credit Card Features 0002 ee ee 48 Planning Your Gateway Integration 0 e o 49 Complying With E commerce Indicator 0 50 Handling Credit Card Type Information a 50 Core Credit Card Parameters e 51 Submitting Account Verifications a e eo 54 When To Use Account Verifications 02000 ee eee 54 Required Account Verification Parameters 54 Example Account Verification String 0 o ee 54 Submitting Authorization Delayed Capture Transactions 55 When to Use Authorization Delayed Capture Transactions 55 Required Authorization Transaction Parameters 0 2 08 2 0 56 Typical Authorization Transaction Parameter String 56 4 31 July 2012 Gateway Developer Guide and Reference Content HN Submitting Balance Inquiry Transactions o a 56 Processing Platforms Supporting Balance Inquiry Transactions 56 Required Balance Inquiry Parameters 0 e o e 56 Example Balance Inquiry Transa
104. a 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 12 13 23 24 1000 TSYS Acquiring Solutions 0 4 12 13 23 104 114 1000 Vantiv formerly Fifth Third Processing Solutions 0 4 5 12 13 23 24 114 1000 Result Values Based On Alternate Generation Methods The following table shows another method for obtaining RESULT values Servers do not return non zero RESULT values from processors Therefore you cannot simulate non zero RESULT values using the amount In some cases you may obtain certain results using the RESULT value plus 1000 even though this table suggests an alternate means of obtaining the RESULT value RESULT value Definition How to test using Payflow Gateway 0 Approved Use an AMOUNT of 1000 or less For all processors except Global Payments Central MAPP and FDI Credit C and force F transactions will always be approved regardless of dollar amount or card number 1 User authentication failed Use an invalid PWD 2 Invalid tender Use an invalid TENDER such as G 3 Invalid transaction type Use an invalid TRXTYPE such as G 4 Invalid amount Use an invalid AMOUNT such as 1 5 Invalid merchant information Use the AMOUNT 1005 Applies only to the fo
105. acters L OTY1 Optional Quantity of this line item Character length and limitations 3 numeric characters L_DESC2 Optional Description of this line item if not provided DESC2 if present is used Character length and limitations 40 alphanumeric characters L AMT2 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 OTY2 Optional Quantity of this line item Character length and limitations 3 numeric characters L_DESC3 Optional Description of this line item if not provided DESC3 if present is used Character length and limitations 40 alphanumeric characters L_AMT3 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_OTY3 Optional Quantity of this line item Character length and limitations 3 numeric characters L_DESC4 Optional Description of this line item if not provided DESC4 if present is used Character length and limitations 30 alphanumeric characters L_AMT4 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 OTY4 Optional Quantity of this line
106. actions with FDMS South Gateway Developer Guide and Reference 31 July 2012 155 Submitting Purchasing Card Level 2 and Level 3 Transactions First Data Merchant Services South FDMS Purchasing Card Transaction Processing FDMS South Level 2 and Level 3 Purchasing Card Parameters Field Description BILLTOCITY SHIPTOCOUNTRY CUSTCODE DISCOUNT DUTYAMT BILLTOFIRSTNAME FREIGHTAMT INVNUM BILLTOLASTNAME ORDERDATE Optional Cardholder s city Character length and limitations 13 alpha characters Optional Destination Country Code Visa and MasterCard are different Refer to Country Code tables Character length and limitations 3 alpha characters Optional Customer code customer reference ID Character length and limitations 17 alphanumeric characters Discount amount on total sale Character length and limitations 10 currency characters Optional Sometimes called import tax If the currency uses a decimal then 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 10 currency characters Optional Cardholder s first name Character length and limitations 15 alpha characters Optional Freight amount If the currency uses a decimal then 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
107. ains a radio frequency identification RFID chip for communicating with a point of sale device with an RFID receiver Character length and limitations alpha characters Gateway Developer Guide and Reference 31 July 2012 127 A Processors Requiring Additional Transaction Parameters WorldPay Additional Credit Card Parameters 128 31 July 2012 Gateway Developer Guide and Reference 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 NFTF includes TeleCheck Internet Check Acceptance ICA Checks By Phone CBP and Prearranged Deposit Services NFTF PPD Each of these products requires a separate Merchant ID also known as a Subscriber ID See below for more details e ICA provides merchants with the capability to authorize and electronically settle checks presented by customers over the internet ICA can be single entry or recurring This is based on customer s authorization received over the internet e CBP authorizes and electronically settles checks presented over the phone through cus
108. al Payments Advanced uses web pages hosted by PayPal also known as hosted checkout pages to send transactions to the PayPal processor With PayPal Payments Advanced PayPal is the acquiring bank By using hosted checkout pages with a secure Gateway Developer Guide and Reference 31 July 2012 19 20 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 e 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 Typically merchants integrate with the Payflow SDK or use HTTPS to send transactions to the PayPal processor NOTE PayPal strongly recommends that all users of Gateway checkout solutions take advantage of the secure token and the hosted checkout pages Doing so provides automatic compliance with processing card industry PCI standards for protecting cardholder data Gateway Product Details The table below compares how the Gateway checkout solutions support payment processing features PayPal Payments Advanced PayPal Payments Pro Feature Payflow Link Payflow Pro Hosted checkout page including an Yes Yes iFrame version PayPal payments Included Optional Bill Me Later payments Included Optional Available to US merchan
109. al transaction can only be one of the following a Sale TRXTYPE S Delayed Capture TRXTYPE D or Voice Authorization TRXTYPE F It is recommended that the merchant issue a credit only if the original transaction has already settled Even though it is possible to issue a credit to a transaction that has not settled it is recommended that you void such transactions Both the credit transaction and the original transaction will appear on the customer s statement Required Credit Transaction Parameters The required parameter data for a credit transaction depends on the Allow non referenced credits security setting for your Payflow account A non referenced credit is a credit transaction that does not use the credit card information from an existing transaction You provide the credit card information As an example Sally Smith calls you on the phone to cancel an order from your business To refund her money you credit her credit card by submitting a non referenced credit transaction Guidelines and parameter requirements for credit transactions differ depending on whether non referenced credits are allowed Non Referenced Credits Not Allowed When non referenced credits are not allowed the setting recommended by PayPal credit transactions are permitted only against existing sale delayed capture and voice authorization transactions To submit a credit transaction when non referenced credits are not allowed pass the following parameter
110. and limitations 1 to 8 alphanumeric characters Required Total 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 1 to 6 numeric characters Optional Charge description Defaults to NO Character length and limitations 1 to 40 alphanumeric characters Optional Total freight amount Character length and limitations 1 to 15 alphanumeric characters Optional Total handling amount Character length and limitations 1 to 15 alphanumeric characters Payflow SDK XMLPay Item Quantity Required Quantity invoiced Character length and limitations 1 to 10 numeric characters Required Unit of measure Character length and limitations 2 alphanumeric characters Required Unit price Character length and limitations 1 to 15 numeric characters Required Description of the item Character length and limitations 1 to 80 alphanumeric characters Required Supplier s catalog number Character length and limitations 1 to 20 alphanumeric characters Required Cost center number Character length and limitations 1 to 30 alphanumeric characters 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions American Express Purchasing Card Transaction Processing Field Description L PRODCODEN L UPCN L_TAXAMTN L_FREIG
111. ansaction Processing Paymentech Tampa supports Level 2 purchasing card processing for MasterCard and Visa 180 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions SecureNet Purchasing Card Transaction Processing 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 To qualify for Level 2 discounts this value must not be all zeros or blank spaces Character length and limitations numeric TAXEXEMPT Required Tax exempt Character length and limitations 1 alphanumeric character Y or N SHIPTOZIP Required Ship to postal code called zip code in the USA Character length and limitations 1 to 16 alphanumeric characters Example Paymentech Tampa Level 2 Visa and MasterCard Transaction Parameter String TRXTYPE S8 TENDER C8SPWD PWDSUSER USERSPARTNER PARTNERSACCT 42 753300123456758 EXPDATE 1215 amp AMT 12 5986 VERBOSITY HIGHSBILLTOSTREET 123 Main St amp BILLTOZIP 4 9801 amp CVV2 248 amp TAXAMT 1 22 amp PONUM AB12345678 amp SHIPTOZIP 98765 amp TAXEXEMPT N SecureNet Purchasing Card Transaction Processing SecureNet supports MasterCard and Visa f
112. arrying capacity in metric tonnes CCT Cental GB 45 359237 kg CNT Center metric 100 kg syn Hectokilogram DTN Centigram CGM Centilitre CLT Centimetre CMT Cord 3 63 m3 WCD Coulomb per kilogram CKG Coulomb COU Cubic centimetre CMQ Cubic decimetre DMQ Cubic foot FTQ Cubic inch INQ Cubic metre per hour MQH Cubic metre per second MQS Cubic metre MTQ Cubic millimetre MMQ Cubic yard YDQ Curie CUR Day DAY Decade ten years DEC Decare DAA Decilitre DLT Decimetre DMT Decitonne DTN Degree Celsius CEL Degree Fahrenheit FAH Degree Kelvin Kelvin Displacement tonnage DPT 31 July 2012 Gateway Developer Guide and Reference Codes Used by FDMS South Only E 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 kW h GWH Gill 0 142065 dm3 GH Gill 11 8294 cm3 GIA Grain GB US 64 798910 mg GRN Gram of fissile isotopes GFI Gram GRM Great gross 12 gross GGR Gross GRO Gross register ton GRT Half year six months SAN Hectare HAR Hectobar HBA Hectogram HGM Hectokilogram DTH Gateway Developer Guide and Ref
113. ations 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 Character length and limitations 4 numeric characters L_DISCOUNTN Optional Discount per line item Character length and limitations 12 numeric characters L_AMTn Optional Line item total Character length and limitations 12 numeric characters Example TSYS Acquiring Solutions Level 3 Visa Transaction Parameter String TRXTYPE S amp TENDER C amp PARTNER Partner amp USER User amp PWD Password amp ACCT 411111111111 1111 amp EXPDATE 1215 amp AMT 1 OO amp BILLTOSTREET 5199 JOHNSON amp TAXAMT 1 0O6 amp BILLTOZIP 94588 amp ALTTAXAMT 1 O0O amp CUSTVATREGNUM 11111 amp LOCALTAXAMT 1 OL amp NATIONALTAXAMT 1 02 amp COMMCODE 22222 amp VATAXAMT 1 03 amp VATAXPERCENT 55 amp TAXEXEMPT N amp DISCOUNT 50 amp FR EIGHTAMT 1 OO amp SDUTYAMT 1 OO amp SHIPTOZIP 33333 amp SHIPFROMZIP 44444 amp SHIPTOCOUNTRY 840 amp ORDERDATE 081125 amp L COMMCODE1 123456789ABC amp L DESC1l Line item 1 descripti on amp L UPC1 CBA987654321 amp L OTY1 1 amp L UOM1 123456789012 amp L COST1 1 50 amp L TAXAMT1 1 05 amp L TAXRATE1 12 amp L DISCOUNT1 50 amp L AMT1 1 00 amp L TAXTYPE1 TT1 192 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions Van
114. ayflow will not display the amount in the order summary table Values TRUE FALSE SUBTOTAL Amount you pass to Payflow It is displayed in the order summary section This amount is only for display purposes and is not passed to the transaction servers VERBOSITY Additional values that is 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 Passing in a verbosity will return the extra values that we get back in the transaction response Value HIGH VERIFY Runs a 0 authorization transaction using the credit card information the buyer enters If the 0 authorization is verified then Payflow will immediately run the transaction for the amount and transaction type you pass to Payflow Values TRUE FALSE Silent Posts The Silent Post feature returns data to your server using the HTML Post method whenever a transaction succeeds The data is sent at the same time as when the Receipt page is displayed This feature is configured through https manager paypal com e Goto Service Settings then Setup e Inthe Hosted Checkout Pages tab set Use Silent Post to Yes NOTE To ensure that transactions proceed only if your script actually receives the data returned by the Silent Post you must Force Silent Post Confirmation by checking Void transaction when my server fails to receive data sent by the silent
115. c country code of ship to country Example USA 840 Character length and limitations 3 alphanumeric characters SHIPMETHOD Optional Shipping method code The values are e 01 Same day e 02 Overnight next day e 03 Priority 2 3 days e 04 Ground 4 or more days e 05 Electronic delivery e 06 ZZ Reserved for future use SKU Optional Merchant product SKU Character length and limitations 15 alphanumeric and special characters AVS 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 Example 951121737 Character length and limitations 9 characters BILLTOPHONENUM Optional Account holder s telephone number The formats are XXX xxx xxxx US numbers e XXXXXXXXXxx international numbers Character length and limitations 10 characters SHIPTOFIRSTNAME Optional First name in the shipping address Character length and limitations 30 characters SHIPTOLASTNAME Optional Last name in the shipping address Character length and limitations 30 characters 31 July 2012 Gateway Developer Guide and Reference Processors Requiring Additional Transaction Parameters E PayPal Credit Card Transaction Request Parameters Field Description SHIPTOSTREET Optional Shipping street ad
116. ced The PNREF parameter returns this ID and it appears as the Transaction ID in PayPal Manager reports Limitations 12 case sensitive alphanumeric characters Typical Authorization Transaction Parameter String A typical NVP string passed in an authorization transaction is the same as a sale transaction string The only difference is that the TRXTYPE value is A in an authorization TRXTYPE A amp TENDER C amp USER SuperUser amp PWD SuperUserPassword amp VENDOR SuperUser amp PA RTNER PayPal amp ACCT 5105105105105100 amp EXPDATE 1215 amp CVV2 123 amp AMT 99 OO amp BILLTOFI RSTNAME John amp BILLTOLASTNAME Smith amp BILLTOSTREET 123 Main St amp BILLTOCITY San Jose amp BILLTOSTATE CA amp BILLTOZI P 12345 amp COMMENT1 Reservat ion amp INVNUM 1234567890 amp PONUM C12345 amp VERBOSITY HIGH Submitting Balance Inquiry Transactions Balance Inquiry TRXTYPE B transactions are used to obtain the balance of a pre paid card This transaction type is different from a balance inquiry performed during an authorization transaction However both of these transaction types will return the balance in the BALAMT response parameter NOTE Payflow returns RESULT value 3 Invalid Transaction Type if the processor does not support balance inquiry 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 processor
117. chant to use Internet Check Acceptance Authorizations At the end of the check out process the merchant must display consent language for the customer to accept prior to submitting the authorization request as follows Internet Check Acceptance Authorization Consent Required Language FULL DEBIT By entering my account number above and clicking Authorize I authorize my payment to be processed as an electronic funds transfer or draft drawn from my account If the payment is returned unpaid I authorize you or your service provider to collect the payment and my state s Gateway Developer Guide and Reference 31 July 2012 139 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 PARTIAL SHIPMENTS amp PARTIAL DEBITS By entering my account number above and clicking Authorize I authorize my payment to be processed as an electronic funds transfer or draft drawn from my account If my full order is not available at the same time I authorize partial debits to my account not to exceed the total authorized amount The partial debits will take place upon each shipment of partial goods If any of my payments are
118. characters use proper and meaningful abbreviation Do not truncate Gateway Developer Guide and Reference 31 July 2012 105 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 e 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 e If you are a mail order phone order or internet industry you may substitute the name of the city in which the merchant s order processing facility is located Character length and limitations 21 alphanumeric characters If more than 21 characters use proper and meaningful abbreviation Do not truncate MERCHANTSTATE Optional The region code that corresponds to the state province or country subdivision of the merchant location where the transaction took place Region code examples e CA California USA e NS Nova Scotia Canada e COS Colima Mexico If you are a third party biller bill for services or goods rendered by another entity you must enter the region code that corresponds to the state province or country subdivision in which the seller is located Character length and limitations 3 alphanumeric characters MERCHANTZIP Optional The 5 to 9 digit zip postal code excluding spaces dashes and non numeric characters whe
119. 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 NOTE If PayPal is your acquirer refer instead to the Countries and Regions Supported by PayPal on page 225 Gateway Developer Guide and Reference 31 July 2012 201 558 ISO Country Codes 202 31 July 2012 Gateway Developer Guide and Reference Codes Used by FDMS South Only The following codes are used by FDMS South only e MasterCard Country Codes for FDMS South Only on page 203 e Visa Country Codes on page 210 e Units of Measure on page 217 MasterCard Country Codes for FDMS South Only ALBANIA ALB ALGERIA DZA AMERICAN SAMOA ASM ANDORRA AND ANGOLA AGO ANGUILLA AIA ANTARCTICA ATA ANTIGUA ATG APHGANISTAN AFG ARGENTINA ARG ARMENIA ARN ARUBA ABW AUSTRALIA AUS AUSTRIA AUT AZERBAIJAN AZE BAHAMAS BHS BAHRAIN BHR BANGLADESH BGD BARBADOS BRB BELARUS BLR BELGIUM BEL Gateway Developer Guide and Reference 31 July 2012 203 204 Codes Used by FDMS South Only MasterCard Country Codes for FDMS South Only BELIZE BENIN BERMUDA BHUTAN BOLIVIA BOSNIA AND HERZEGOVINA BOTSWANA BOUVET ISLAND BRAZIL BRITISH INDIAN OCEAN TERRITORY BRUNEI BULGARIA BURKINA FASO BURUNDI CAMBODIA CANADA CAPE VERDE CAYMAN ISLANDS CENTRAL AFRICAN REPUBLIC CHAD CHILE
120. credit card for example pass the following parameters e TRXTYPE The type of the transaction such as S for Sale e TENDER The method of payment such as C for credit card e ACCT The buyer s credit card number e AMT The amount of the sale with two decimal places EXPDATE The expiration date of the credit card Typical Sale Transaction The following is a typical name value pair string for a sale transaction TRXTYPE S amp TENDER C amp USER MerchantUserID amp PWD Pwd4Gat eway amp PARTNER PayPal amp ACCT 51051051051051008 EXPDATE 121586AMT 23 45 amp COMMENT1 Airport Shuttle amp BILLTOFIRS TNAME Jamie amp BILLTOLASTNAME Miller amp BILLTOSTREET 123 Main St amp BILLTOCITY San Jose amp BILLTOSTATE CA amp BILLTOZIP 951311234 amp BILLTOCOUNTRY US amp CVV2 123 amp CUSTIP 0 0 0 0 amp VERBOSITY HIGH Besides the required sale transaction parameters the string includes other Payflow parameters typically included in a sale transaction When the transaction completes the Gateway server returns a response string made up of NVP response parameters If the transaction is successful the Gateway server returns RESULT value 0 The value of PNREF identifies the transaction in future requests and RESPMSG is a string indicating whether the transaction was approved The following is an example response RESULT 0 amp PNREF VXYZ01234567 amp RESPMSG APPROVED amp AVSADDR Y amp AVSZI P N amp IAVS Y amp CVV2 MATCH Y Formatting Payflow Ga
121. ct Payment transaction Character length and limitations 13 alphanumeric characters Unique transaction ID returned when VERBOSITY HIGH for tracking American Express CAPN transactions on non PayPal processors NOTE Used by merchants who authorize transactions through the Gateway but settle through a third party solution Character length and limitations 15 numeric characters Value returned for American Express CAPN transactions when VERBOSITY HIGH on non PayPal processors NOTE Used only by merchants who authorize through the Gateway but settle through a third party solution Character length and limitations 12 alphanumeric characters This field returns the transaction amount or if performing a partial authorization it will return the amount approved for the partial authorization Partial authorizations Original amount submitted for authorization Gateway Developer Guide and Reference 31 July 2012 89 me Transaction Responses Address Verification Service Responses From PayPal Field Description CARDTYPE EMAILMATCH PHONEMATCH EXTRSPMSG TRANSTIME DUPLICATE DATE TO SETTLE 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 e 0 Visa 1 MasterCard 2 Discover 3 American Express 4 Diner s Club 5 JCB Verifies whether the BILLTOEMAIL value sent is what is on file wi
122. cter length and limitations 25 alphanumeric characters provides best rate when used SHIPFROMZIP Optional The postal code called zip code in the USA from which shipping occurs Character length and limitations 9 numeric characters provides best rate when used SHIPTOZIP Optional Ship to postal code called zip code in the USA Character length and limitations 9 numeric characters provides best rate when used BILLTOSTATE Optional Cardholder s state Character length and limitations 2 alpha characters 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 Character length and limitations 10 currency characters provides best rate when used TAXEXEMPT Optional Is the customer tax exempt Character length and limitations 1 alphanumeric character Y or N FDMS South Line Item Parameters Line item data Level 3 describes the details of the item purchased and can be can be passed for each transaction The convention for passing line item data in name value pairs is that each name value starts with L_ and ends with n where n is the line item number For example L_QTYO 1 is the quantity for line item 0 and is equal to 1 with n starting at 0 FDMS South Purchasing Card Line Item Parameters Field Description L_OTYn Required Quantity whole units only Character length and limitations 10 numeric characters
123. ction String o 57 Submitting Card Present SWIPE Transactions 57 Processing Platforms Supporting Card Present Transactions 58 Card Present Transaction Syntax 2 o e 58 Submitting Credit Transactions e 59 Required Credit Transaction Parameters 59 Submitting Inquiry Transactions 2 e 61 When To Use an Inquiry Transaction 0 e e 61 Required Parameters When Using the PNREF 0 61 Inquiry Transaction Parameter String Using the PNREF 62 Required Parameters When Using the CUSTREF 62 Inquiry Transaction Parameter String Using the CUSTREF 63 Required Parameters When Using the Secure Token 63 Inquiry Parameter String Using the Secure Token 63 Submitting Partial Authorizations 2000002 eee 64 When To Use Partial Authorizations 200 0005007 64 Required Partial Authorization Parameters 2 2 2 0 0002 eee 64 Example Partial Authorization 2 2 2 0 00002 ee 65 Submitting Purchasing Card Transactions 2 2 022 200 65 Submitting Reference Transactions Tokenization 0 o 66 When To Use a Reference Transaction e 5205550 66 Transaction Types That Can Be Used As the Ori
124. d Transactions Submitting Account Verifications Parameter Description SHIPTOCOUNTRY Optional Ship to country Limitations 3 character country code Submitting Account Verifications Account verification also known as zero dollar authorization TRXTYPE A verifies credit card information While you pass TRXTYPE A for account verification and normal authorization account verification differs from authorization in the following ways e Always pass the AMT value 0 If you pass any other amount the transaction becomes a normal authorization that places a hold on the cardholder s open to buy limit e Although the RESULT value returned is 0 Approved the RESPMSG value returned is Verified rather than Approved NoTE Payflow returns RESULT value 4 Invalid Amount if the processor does not support account verifications When To Use Account Verifications Use account verification to validate account numbers and other authentication elements such as CVV2 and AVS You can also use an account verification as a reference transaction See Submitting Reference Transactions Tokenization on page 66 Required Account Verification Parameters To perform account verification pass the following parameters Parameter Description TRXTYPE Required Set to A Limitations 1 alphanumeric character AMT Required Set to 0 VERBOSITY Required Set to HIGH to obtain information about a partial authorization in the
125. d or invalid XID in PARES 1051 Buyer Authentication Service Validate Authentication failed Mismatched or invalid order date in PARES 1052 Buyer Authentication Service Validate Authentication failed This PARES was already validated for a previous Validate Authentication transaction RESULT Values For Communications Errors A RESULT value less than zero indicates that a communication error occurred In this case no transaction is attempted A value of 1 or 2 usually indicates a configuration error caused by an incorrect URL or by configuration issues with your firewall For information on firewall configuration see Preparing the Payflow Gateway Client Application on page 41 A value of 1 or 2 can also be possible if the Gateway servers are unavailable or you specified an incorrect server or socket pair A value of 1 can also result when there are internet connectivity errors Contact Customer Service regarding any other errors Details of the response message may vary slightly from the message shown in the table depending on your SDK integration RESULT Description 1 Failed to connect to host 2 Failed to resolve hostname 5 Failed to initialize SSL context 31 July 2012 Gateway Developer Guide and Reference Transaction Responses a RESULT Values and RESPMSG Text RESULT Description 6 Parameter list format error amp in name 7 Parameter list format error invalid name length claus
126. dditional Credit Card Parameters 04 103 Retail Transaction Advice Addendum for SWIPE transactions 103 Internet Transaction Data 2 e 104 Address Verification Service Parameters 105 Location Transaction Advice Addendum Parameters 105 6 31 July 2012 Gateway Developer Guide and Reference Content EN Transaction Advice Detail Parameters 107 Airline Passenger Data Parameters o 107 American Express Other Parameters 108 Elavon Additional Credit Card Parameters 2 0 ee 109 First Data Merchant Services Nashville Additional Credit Card Parameters 110 First Data Merchant Services North Additional Credit Card Parameters 110 Heartland Additional Credit Card Parameters 00000084 111 Litle Additional Credit Card Parameters 2 o 111 Merchant e Solutions Additional Credit Card Parameters 113 Paymentech Salem New Hampshire Additional Credit Card Parameters for American EXPIOSS 2445 04 a aa a AA ARA AR a 113 Internet Transaction Data Parameters ee 113 AVS Parameters ci is o ro nde ee be Geel ee eG da Eds ee a 114 Additional Credit Card Parameters for M Record 0 0000s 115 PayPal Credit Card Transaction Request Parameters 11
127. de 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 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 Character length and limitations 9 alphanumeric characters SecureNet Level 3 Visa Extended Data The parameters listed in the table below apply to Level 3 Visa transactions as extended data Parameter Description COMMCODE Optional Commodity code identifier for the business Character length and limitations 4 alphanumeric characters DISCOUNT Optional Discount amount Character length and limitations 12 numeric characters 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 The format is mmddyy with no slashes or dashes For example July 28 2003 is 072803 Character length and limitations 6 numeric characters SHIPTOZIP Required The zip code of the address to which the goods
128. described below Field Description RECURRING Optional Identifies the transaction as recurring This value does not activate the Payflow Recurring Billing Service API If the RECURRING parameter was set to Y for the original transaction then the setting is ignored when forming credit void and force transactions If you subscribe to Payflow Fraud Protection Services e To avoid charging you to filter recurring transactions that you know are reliable the fraud filters do not screen recurring transactions e To screen a prospective recurring customer submit the transaction data using PayPal Manager s Manual Transactions page The filters screen the transaction in the normal manner If the transaction triggers a filter then you can follow the normal process to review the filter results Character length and limitations alphanumeric character Y or N Gateway Developer Guide and Reference 31 July 2012 109 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 The merchant invoice number is used for authorizations and settlements and depending on your merchant bank wi
129. dit Card Parameters Field Description AUTHDATE Required for Force transactions Authorization date Character length and limitations 11alphanumeric characters CUSTOMERID Optional Customer identification Character length and limitations 18 alphanumeric characters Gateway Developer Guide and Reference 31 July 2012 111 Processors Requiring Additional Transaction Parameters Litle Additional Credit Card Parameters Field Description INVNUM MERCHANTCITY MERCHANTURL MERCHDESCR MERCHSVC PONUM REPORTGROUP BILLTOSTREET2 BILLTOSTREET3 TAXAMT TAXEXEMPT 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 Optional The name of the city were the transaction took place e Ifyou area 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 e Ifyou are a mail order phone order or internet industry you may substitute the name of the city in which the merchant s order processing facility is located Character length and limitations 21 alphanumeric characters Optional Merchant s website This information is usually displayed in the account holder s statement Character length and limitations 40 alphanumeric characters
130. dit department Upon approval Paymentech sets a flag at the transaction division to enable you to send the preceding parameters If the flag is not set and you send the parameters your transaction 1s rejected with Error 258 Merchant Descriptor M Record A merchant descriptor defines the merchant name and product that appears on the account holder s statement The descriptior information is passed to the processor in parameter fields such as the following e MERCHDESCR Defines the merchant name and product e MERCHSVC Includes the merchant contact information such as the merchant s telephone number e mail address or website URL To use merchant descriptors you are not required to have the processor set the division level flag However you are required to obtain prior risk or credit department approval before sending the parameters Submitting Voice Authorization Transactions A voice authorization TRXTYPE F is a transaction that the processing network authorizes over the phone NOTE The PayPal processor does not support voice authorization transactions Gateway Developer Guide and Reference 31 July 2012 71 72 Submitting Credit Card Transactions Submitting Void Transactions When To Use a Voice Authorization Transaction Some transactions cannot be authorized over the Internet for example high dollar amounts and require manual authorization These referral transactions generate RESULT value 13 In these
131. does not have a Federal Tax ID the driver s license can also be used For ICA and NFTF PPD the merchant must retain the customer s authorization of the transaction for a period of 2 years and for ICA prompt the customer to print a copy of this confirmation for their records The merchant must adhere to all authorization requirements data elements legal verbiage and check return fee requirements For CBP the merchant must audio record the customer s verbal confirmation of the transaction or provide a written confirmation of the transaction to the customer prior to settlement In either case the confirmation must be live IVR is not acceptable for confirmation If a merchant chooses audio the merchant must have the technical capability to retain these recordings for a period of 2 years else the written confirmation may be substituted and retained for the same time period The merchant must adhere to all authorization requirements data elements legal verbiage and check return fee requirements Only select US accounts drawn on U S banks participating in the ACH Network are eligible for processing via the ACH Network TeleCheck Trace ID TTID is required for all supplemental messages change void and adjustment transactions Merchant Trace ID is required for all adjustment transactions This field allows additional capabilities to be enabled such as Overflow Credits and MIA Duplicate Checking Change and Void transactions are
132. dress 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 Example 951121737 Character length and limitations 9 alphanumeric characters SHIPTOPHONENUM Optional Shipping telephone number Character length and limitations 10 alphanumeric characters Additional Credit Card Parameters for M Record Field Description MERCHDESCR Optional Use this parameter to pass in your DBA name and other data describing the transaction This information is usually displayed in the account holder s statement Character length and limitations 25 alphanumeric characters 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 Character length and limitations 13 alphanumeric characters PayPal Credit Card Transaction Request Parameters In addition to the core credit card parameters PayPal accepts the parameters described below Parameter Description ACCTTYPE Optional Credit card type The following card types are supported e 0 Visa e 1 MasterCard e 2 Discover e 3 AMEX e 4 DinersClub
133. e Gateway Developer Guide and Reference 31 July 2012 33 Configuring Hosted Checkout Pages Configuring Hosted Pages Using PayPal Manager Customize PayPal o Manager Reports Home Account Administration Service Settings Search Transactions Virtual Terminal Hosted Checkout Pages Mica SetUp Customize Integrate Customize Your Page We ve created a basic page for you below but you can change itto reflect your companys brand Choose a layout and color Layout A Layout B Layout C Choose a way to pay Pay with PayPal PayPal Sample only E Y Your order summary appears here Pay with credit or debit card __ Expiration Date Sample only Live page will reflect your settings Secure payments by PayPal j Return to Merchant Site Copyright PayPal Inc All rights reserved 34 31 July 2012 Gateway Developer Guide and Reference Configuring Hosted Checkout Pages Configuring Hosted Pages Using PayPal Manager The Customize page allows you to customize your hosted checkout page You can customize the header background title button and the order summary column of your payment page PayPal offers three design layouts for you to choose Layout A is the default layout but you can choose from any of the three layouts offered Preview the design of your hosted checkout page You can either change the design of your layout or select and customize a different layout on this pa
134. e 8 SSL failed to connect to host 9 SSL read failed 10 SSL write failed 11 Proxy authorization failed 12 Timeout waiting for response 13 Select failure 14 Too many connections 15 Failed to set socket options 20 Proxy read failed 21 Proxy write failed 22 Failed to initialize SSL certificate 23 Host address not specified 24 Invalid transaction type 25 Failed to create a socket 26 Failed to initialize socket layer 27 Parameter list format error invalid name length clause 28 Parameter list format error name 29 Failed to initialize SSL connection 30 Invalid timeout value 31 The certificate chain did not validate no local certificate found 32 The certificate chain did not validate common name did not match URL 40 Unexpected Request ID found in request 41 Required Request ID not found in request 99 Out of memory 100 Parameter list cannot be empty 103 Context initialization failed 104 Unexpected transaction state 105 Invalid name value pair request 106 Invalid response format Gateway Developer Guide and Reference 31 July 2012 101 Transaction Responses RESULT Values and RESPMSG Text RESULT Description 107 This XML Pay 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 lt Details of the error message gt 113 Unable to round and truncate the cur
135. e airline in this flight where n is a value from 1 to 10 If the same carrier is used for multiple segments of the trip it is passed only once For example the two ATR CARRIERN values for the following trip are UA and AA e UA flight from IAD to DEN e UA flight from DEN to LAX e UA flight from LAX to SFO e AA flight from SFO to DFW For information about airlines codes see http en wikipedia org wiki Airline_codes All Character length and limitations 24 alphanumeric characters Optional List discounts associated with the travel Character length and limitations 24 alphanumeric characters Optional Number of passengers on this trip Character length and limitations numeric Optional If this is an electronic ticket The values are e Y yes e N no Character length and limitations 1 alphanumeric character Optional Code assigned to the travel reservation before the ticket was purchased Character length and limitations 15 alphanumeric characters American Express Other Parameters Field Description BILLTOFIRSTNAME BILLTOLAS TNAME Optional Account holder s first and last name NOTE Even though the parameter name indicates only the first name this single parameter holds all of the person s name information both first and last name at a minimum Character length and limitations 13 alphanumeric characters Optional Account holder s last name Character length and limitations 13 alphanumeric
136. e and Reference 31 July 2012 169 170 Submitting Purchasing Card Level 2 and Level 3 Transactions Merchant e Solutions Purchasing Card Transaction Processing Merchant e Solutions Level 2 MasterCard Parameters Required for Level 3 Transactions Parameter Description PONUM Required Purchase identifier Character length and limitations 25 alphanumeric characters TAXAMT Required Tax amount The value must include a decimal and the exact amount to the cent 42 00 not 42 Do not include comma separators 1234 56 not 1 234 56 To qualify for Level 2 discounts this value must not be all zeros or blank spaces Character length and limitations numeric LOCALTAXAMT Optional Local tax Character length and limitations 12 numeric characters TAXEXEMPT Optional Local tax incl flag Character length and limitations 1 alphanumeric Y or N 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 Character length and limitations 9 alphanumeric characters Merchant e 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 n
137. e 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 Character length and limitations 13 alphanumeric characters Heartland Additional Credit Card Parameters In addition to the core credit card parameters Heartland accepts the parameters described below 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 NOTE Not supported by Payflow Link Character length and limitations 17 alphanumeric characters MERCHDESCR Optional Use this parameter to pass in your DBA name and other data describing the transaction default merchant name This information is usually displayed in the account holder s statement Character length and limitations 25 alphanumeric characters 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 Character length and limitations 13 alphanumeric characters Litle Additional Cre
138. elds and variables Please refer to the Currency Codes section of the PayPal API reference for a complete list of currencies supported by PayPal Gateway Developer Guide and Reference 31 July 2012 225 6 PayPal Acquirer PayPal Currency Codes 226 31 July 2012 Gateway Developer Guide and Reference Additional Processor Information Moneris Solutions The Moneris Solutions processor has the following characteristics e It supports ecommerce and mail order or telephone order MOTO transactions e It supports the four basic credit card types American Express Discover MasterCard and Visa e To process live transactions it requires undergoing a certification process For details see the Moneris Receipts Specification available on the PayPal developer website Gateway Developer Guide and Reference 31 July 2012 227 Additional Processor Information Moneris Solutions 228 31 July 2012 Gateway Developer Guide and Reference 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 Once you upgrade your account to the new version your
139. ence ID The value of PNREF is sent if the INVNUM parameter is not provided Character length and limitations 9 alphanumeric characters TSYS Acquiring Solutions Level 3 Visa Extended Data The parameters listed in the table below apply to Level 3 Visa transactions as extended data Parameter Description COMMCODE Optional Commodity code identifier for the business Character length and limitations 4 alphanumeric characters DISCOUNT Optional Discount amount Character length and limitations 12 numeric characters 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 The format is mmddyy with no slashes or dashes For example July 28 2003 is 072803 Character length and limitations 6 numeric characters SHIPTOZIP Required The zip code of the address to which the goods are shipped Character length and limitations 10 alphanumeric characters SHIPFROMZIP Required The postal code called zip code in the USA from which shipping occurs Character length and limitations 10 alphanumeric characters SHI PTOCOUNTRY Optional Destination country code Character length and limitations 3 alphanumeric characters VATREGNUM Required VAT registration number Can be part of the registration data or passed with each transaction Character length and limitations 20 alphanumeric cha
140. ength and limitations numeric Example Paymentech Salem New Hampshire Level 3 MasterCard Transaction Parameter String TRXTYPE S amp TENDER C amp PARTNER Partner amp PWD Password amp USER User amp ACCT 54 8018000000 0024 amp EXPDATE 1215 amp AMT 1 00 amp COMMENT1 0508 amp BILLTOFIRSTNAME Robert amp BILLTOSTREE T 123 Main St amp BILLTOZIP 94065 amp CVV2 426 amp PONUM ABCDEFGHIJ amp TAXAMT 1 00 amp FREIGH TAMT 2 OO amp DUTYAMT 3 OO amp SHIPTOZIP 94543 amp SHI PIOCOUNTRY 84 0 amp SHI PFROMZIP 94509 amp ALTERNATETAXID 1086ALTERNATETAXAMT 4 006 L DESC1 MC Pcard amp L_ UPC1 1 amp L QOTY1 2 amp L _UOM1 3 amp L TAXAMT1 4 amp L TAXRATE1 5 amp L AMT1 6 amp L DISCOUNT1 7 amp L TAXTYPE1 8 Example Paymentech Salem New Hampshire Level 3 Visa Transaction Parameter String TRXTYPE S amp TENDER C amp PARTNER Partner amp PWD Password amp USER User amp ACCT 427533001234 5626 amp EXPDATE 1215 amp AMT 1 OO amp COMMENT1 0508 amp BILLTOFIRSTNAME Robert amp BILLTOSTREE T 123 Main St amp BILLTOZIP 94065 amp CVV2 426 amp PONUM ABCDEFGHIJ amp TAXAMT 1 008FREIGH TAMT 2 OO amp DUTYAMT 3 OO amp SHI PTOZI P 94543 amp SHT PTOCOUNTRY 84 0 amp SHI PFROMZIP 94509 amp DISCOUNT 4 OO amp VATAXAMT 5 OO amp VATAXPERCENT 10 amp L DESC1 TSYS Acquiring Solution s Pcard amp L UPC1 1 amp L UOM1 28L QTY1 3 amp L_TAXAMT1 4 amp L TAXRATE1 5 amp L AMT1 6 amp L DISC OUNT1 786L COMMCODE1 8 L COST1 9 amp L COST1 10 Paymentech Tampa Level 2 Purchasing Card Tr
141. ent 42 00 not 42 and exclude comma separators 1234 56 not 1 234 56 Examples tip 3 00 convenience charge 2 00 10 currency characters Optional Item unit of measure Character length and limitations 3 alpha characters Optional Item tax 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 12 numeric characters Optional Tax rate for this item Character length and limitations 4 numeric characters plus decimal XXXX Gateway Developer Guide and Reference 31 July 2012 197 Submitting Purchasing Card Level 2 and Level 3 Transactions WorldPay Purchasing Cards Transaction Processing 198 31 July 2012 Gateway Developer Guide and Reference VERBOSITY Viewing 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 NOTE VERBOSITY is being deprecated in future Gateway releases Gateway Developer Guide and Reference 31 July 2012 199 o Dl VERBOSITY Viewing Processor Specific Transaction Results 200 31 July 2012 Gateway Developer Guide and Reference ISO Country Codes The Gateway API uses the International Standards Organization ISO 3166 1 numeric
142. er String TRXTYPE S amp TENDER C amp partner partner amp PWD test amp USER test amp ACCT 378734493671000 amp EXPDATE 1213 amp AMT 5 00 amp COMMENT1 PCARD Test amp COMMENT2 Test ing amp BILLTOZIP 940151 234 amp BILLTOSTREET 123 Lincoln WAY amp CVV2 0123 amp SHIPTOCOUNTRY USA amp CUSTCODE 12345 amp FREIGHTAMT 1 00O amp ORDERDATE 021700 amp HANDLINGAMT 1 00 amp PONUM 123456789012345678 9012345 amp SHIPFROMZIP 940151234 amp SHIPTOZIP 940151234 amp TAXAMT 1 0O0 amp TAXEXEMPT N amp L _UPC1 PN amp L_QTY1 1 amp L DESC1 Test123 amp L UOM1 12 amp L COST1 1 00 amp L PRODCODE1 123 amp L _ COSTCENTERNUM1 55 amp L TAXAMT1 0 amp L QOTY2 1 amp L UPC1 PN amp L_DESC2 Test amp L_ UOM2 12 amp L C OST2 1 008 L PRODCODE2 1234 amp L COSTCENTERNUM2 55 amp L TAXAMT2 1 00 amp REQNAME Rober t amp SHIPTOZIP 543210 amp INVNUM 123456789 amp VERBOSITY HIGH Gateway Developer Guide and Reference 31 July 2012 151 Submitting Purchasing Card Level 2 and Level 3 Transactions Elavon Formerly Nova Purchasing Card Transaction Processing Elavon Formerly Nova Purchasing Card Transaction Processing Elavon supports Level 2 for Visa and MasterCard sale credit and delayed capture transactions Elavon Level 2 Parameters To get the discount rate include both Level 2 parameters listed in the following table Pass these parameters in authorization and sale transactions Level 2 Parameters Description CUSTCODE Required Customer code Character
143. erence 31 July 2012 219 220 Codes Used by FDMS South Only Units of Measure Hectolitre of pure alcohol HPA Hectolitre HLT Hectometre HMT Hertz HTZ Hour HUR Hundred CEN Hundred boxes BHX Hundred international units HIU Hundred leaves CLF Hundred packs CNP Hundredweight US 45 3592 kg CWA Inch 25 4 mm INH Joule JOU Kelvin KEL Kilobar KBA Kilogram of caustic potash KPH Kilogram of caustic soda KSH Kilogram of named substance KNS Kilogram of nitrogen KNI Kilogram of phosphonic anhydride KPP Kilogram of phosphorus pentoxide KPP Kilogram of potassium hydroxide KPH Kilogram of potassium oxide KPO Kilogram of sodium hydroxide KSH Kilogram of substance 90 percent dry KSD Kilogram per cubic meter KMQ Kilogram per second KGS Kilogram KGM Kilohertz KHZ Kilojoule KJO Kilometre per hour KMH Kilometre KMT 31 July 2012 Gateway Developer Guide and Reference Codes Used by FDMS South Only E 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 MHZ Megalitre MAL Megametre MAM Megapascal MPA Megavolt ampere 1
144. eric characters ATR DESTINATION Optional Destination airport code for the first segment of the trip this is not necessarily the final destination For example if a passenger flies from STL to MIA with a layover at JFK the destination airport is JFK For a list of airport codes see http www world airport codes com alphabetical airport code a html NOTE Present day airport codes are three characters in length The five character length is designed to allow for future expansion Character length and limitations 5 alphanumeric characters AIR NUMBEROFCITIES Optional Number of unique cities in this trip including the cities of origin and destination where a maximum value of 10 is allowed For example ATR NUMBEROFCITIES 1s 3 for the following trip e DEN to LAX e LAX to SFO e SFO to DEN If not provided this value is equal to the number of AIR ROUTINGCITYn parameters Gateway Developer Guide and Reference 31 July 2012 107 108 Processors Requiring Additional Transaction Parameters American Express Additional Credit Card Parameters Field Description AIR ROUTINGCITYN AIR CARRIERN ATR FAREBASIS AIR NUMBEROF PASSENGERS AIR ISETICKET ATR RESERVATIONCODE 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 Optional Two character airline code for each uniqu
145. ervice compares the submitted billing street address and zip code with the values on file at the cardholder s bank The response includes values for AVSADDR and AVSZIP Y N or X for the match status of the customer s street address and zip code Y match N no match X cardholder s bank does not support address verification service The address verification service result is for advice only Banks do not decline transactions based on the address verification service result The merchant decides to approve or decline a transaction Most US banks and some international banks support the address verification service NOTE Address verification service checks only for a street number match not a street name match so 123 Main Street returns the same response as 123 Elm Street The international address verification service IAVS response indicates whether the address verification service response is international Y USA N or cannot be determined X NOTE When you set VERBOSITY to HIGH the Gateway returns the processor s raw response in the PROCAVS field To obtain details about the meaning of the response contact your merchant bank Example Address Verification Service Parameter String This example request includes the address verification service parameters BILLTOSTREET and BILLTOZIP TRXTYPE A amp TENDER C amp PWD SuperUserPassword amp PARTNER PayPa1 amp VENDOR Vendor amp USER SuperMerchant amp amp ACCT 555555555555444
146. es within 60 days from today You may also dispute the accuracy or completeness of any information in TeleCheck s consumer report TeleCheck did not make the adverse decision to not accept your payment item and is unable to explain why this decision was made Sale Error Responses We are unable to process this transaction with the payment information provided Please use a different form of payment at this time 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions PayPal Payment Services supports passing Purchasing Card Level 2 information such as purchase order number tax amount and charge description in the settlement file If additional required invoice information and line item details are included in the transaction PayPal formats Purchasing Card Level 3 information in an appropriate format for example EDI Electronic Data Interchange 810 format as required by American Express during settlement processing Please contact your merchant bank to determine which parameters are required to obtain the best rate for level 2 or level 3 type transactions If in doubt we recommend you send all the level 2 and level 3 fields specified below for your processor About Purchasing Cards The procurement process uses purchasing cards for a number of reasons Purchasing cards e Eliminate paper based order systems and associated costs e Improve control and accountability throug
147. eters For PayPal Processor Only When interpreting RESULT values for the PayPal processor note the following e When RESULT 0 warning information may be returned that is useful to the request application See the PayPal API documentation on x com for detailed information on corrective actions e When RESULT 104 log in to the PayPal website to determine whether the transaction actually went through If the transaction does not appear in the History section retry it RESULT RESPMSG and Explanation 0 Approved NOTE PayPal processor Warning information may be returned that may be useful to the request applicaton See the PayPal API documentation on x com for information on corrective actions 31 July 2012 Gateway Developer Guide and Reference 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 e 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 e Invalid Processor information entered Contact merchant bank to verify e Allowed IP Address security feature implemented The transaction is coming from an unknown IP address See PayPal Manager online help for details on how to update the allowed IP addresses e You
148. evel 3 MasterCard transactions as extended data Parameter Description FREIGHTAMT Optional Freight amount Character length and limitations 12 numeric characters DUTYAMT Optional Duty amount Character length and limitations 12 numeric characters SHIPTOZIP Required The zip code of the address to which the goods are shipped Character length and limitations 10 alphanumeric characters SHIPFROMZIP Required The postal code called zip code in the USA from which shipping occurs Character length and limitations 10 alphanumeric characters SHIPTOCOUNTRY Optional Destination country code Character length and limitations 3 alphanumeric characters ALTTAXAMT Optional Alternate tax amount Character length and limitations 9 numeric characters Heartland Level 3 MasterCard Line Item Detail Records NOTE 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_OTYn and unit price L_COSTn fields Parameter Description L_COMMCODEN Optional Item commodity code Character length and limitations 12 alphanumeric characters L_DESCn Required Item descriptor Character length and limitations 35 alphanumeric characters L_ UPCN Optional Product code Character length and limitations 12 alphanumeric characters 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions Heartland Purchas
149. for a Validate Authentication transaction 1021 Buyer Authentication Service Invalid card type 1022 Buyer Authentication Service Invalid or missing currency code 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 Gateway Developer Guide and Reference 31 July 2012 99 100 Transaction Responses RESULT Values and RESPMSG Text RESULT RESPMSG and Explanation 1044 Buyer Authentication Service Validate Authentication failed Signature validation failed for PARES 1045 Buyer Authentication Service Validate Authentication failed Mismatched or invalid amount in PARES 1046 Buyer Authentication Service Validate Authentication failed Mismatched or invalid acquirer in PARES 1047 Buyer Authentication Service Validate Authentication failed Mismatched or invalid Merchant ID in PARES 1048 Buyer Authentication Service Validate Authentication failed Mismatched or invalid card number in PARES 1049 Buyer Authentication Service Validate Authentication failed Mismatched or invalid currency code in PARES 1050 Buyer Authentication Service Validate Authentication failed Mismatche
150. fully 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 TeleCheck Authorization Requirements With the TeleCheck Non Face To Face NFTF Host Based Capture Service the merchant is responsible for handling all front end aspects of the point of sale including displaying the appropriate disclosures to the customer TeleCheck will provide form language for the merchant to use NOTE It is the merchant s responsibility to ensure that they have the most current language from TeleCheck TeleCheck will send out a Service Notice when updated language or system changes are required Additionally the Merchant should be familiar with NACHA FCRA and Reg E compliance requirements There are two different situations during which the merchant must display legal language e Authorization Sales Consent The language varies slightly between the Internet Check Acceptance and Checks By Phone services e Authorization Sales Decline The language is identical for Internet Check Acceptance and Checks By Phone services Authorization Sales Consent With the Non Face To Face Host Based Capture Service the merchant is responsible for handling all front end aspects of the point of sale including displaying the appropriate disclosures to the customer TeleCheck will provide form language for the mer
151. ge To make changes double click on the section you are trying to modify or the corresponding Click to Edit button for that section On the pop up that appears click the color selector to change the color or enter the appropriate URL as needed After making the changes click one of the following buttons e Preview Preview the changes you have made to your layout before saving and publishing it e Save and Publish Save all the changes you have made and publish the updated layout Your buyers will see the updated payment page e Cancel Discard all the changes you have made in this session e Undo Changes Discard all changes you have made since the last time you saved the layout Your buyers will see the last saved layout NOTE You must make all modifications including changing layouts within the same session otherwise all changes will be lost and you will have to redo your changes If the session times out the design of the layout will remain at the version that was last published Customizing Your Layout e Header You can change the following Header height Applicable to Layout A and B Header color Applicable to Layout B only Header font type size Applicable to Layout A and B Header font color Applicable to Layout B only Swap between displaying the business name or the business logo image Edit Header business name Position of the business name or the logo Upload a background image
152. ginal Transaction 66 Fields Copied From Reference Transactions 0 000 eee 67 Example Reference Transaction a a a a 67 Data Upload Storing Credit Card Data on the Gateway Server 68 Submitting Sale Transactions 0000 ee ee 69 When To Use a Sale Transaction 0002022 eee eee 69 Additional Parameters For Sale Transactions 2 5 69 Typical Sale Transaction Parameter String 0 200004 eae 69 Submitting Soft Merchant Information 222 00052007 70 About Soft Merchant Information 2220000220 e 70 Ways to Send Soft Merchant Information 70 Submitting Voice Authorization Transactions 2 220 71 When To Use a Voice Authorization Transaction 72 Required Voice Authorization Transaction Parameters 08 4 72 Submitting Void Transactions 00 2 ee 72 Gateway Developer Guide and Reference 31 July 2012 5 En Content When To Use a Void Transaction o a 73 Required Void Transaction Parameters 73 Fields Copied From the Original Transaction Into the Void Transaction 73 Example Void Transaction Parameter String 0 o 74 Using Address Verification Service 0 o e e 74 Example Address Verification Service Parameter String
153. gth and limitations The decimal is implied If for example you specify 500 this value is equivalent to 5 00 8 numeric characters L_UOMn Optional Unit of measure of the purchased item such as kit pair gallon or month where n is a line item number from 1 to 99 Character length and limitations 12 alphanumeric characters Litle Level 3 Parameters The Litle platform supports Level 3 transaction data Litle Level 3 Parameters Field Description CUSTREF Optional Reference such as a purchase order number used by the customer for the purchase Character length and limitations 17 alphanumeric characters DISCOUNT Optional Discount 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 DUTYAMT Optional Duty amount on the total purchased 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 Gateway Developer Guide and Reference 31 July 2012 167 Submitting Purchasing Card Level 2 and Level 3 Transactions Merchant e Solutions Purchasing Card Transaction Processing Field Description FREIGHTAMT TAXAMT L_AMTn L COMMCODEN L_COSTN L_DESCn L_DISCOUNTN L_PRODCODEN L_QTYn L_TAXAMTN L_UOMN Optional Shipping amount for the order Character length and
154. gth tag specifies the exact number of characters and spaces that appear in the value The following are valid Gateway Developer Guide and Reference 31 July 2012 43 44 Sending a Simple Transaction to the Server Payflow Connection Parameters COMPANYNAME 14 Ruff amp Johnson COMMENT1 7 Level 5 NOTE 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 e Do not use spaces in values e Enclose the NVP parameter string in quotation marks e Do not place quotation marks within the body of the NVP parameter string e Separate all NVPs using an ampersand amp e Set the VERBOSITY transaction parameter to HIGH to have the response return detailed information Act upon the returned values that you need for the transaction Do Not URL Encode Name Value Parameter Data Do not URL encode your NVP data because it can cause problems with authentication and reporting This example is incorrect TRXTYPE 3DS 26TENDER 3DC 26USER 3DMerchantUser1ID 26 PWD 3DPwd4Gateway 26 PART NER 3DPayPal 26ACCT 3D5105105105105100 26EXPDATE 3D1215 26AMT 3D23 45 26COM MENT1 3DAirport Shuttle 26BILLTOFIRSTNAMES 3DJamie 26BILLTOLASTNAME 3DMiller 26BILLTOSTREET 3D123 Main St 26BILLTOCITY 3DSan Jose 26BILLTOSTATE 3DCA 2 6BILLTOZIP 3D951311234 26BILLTOCOUNTRY 3DUS 26CVV2 3D123 26CUSTIP 3D0 0 0 0 This example is c
155. h itemized statements e Foster better risk controls through spending limits and buying from approved vendors e Reduce administrative overhead by empowering employees to make small purchases e Enable enterprises to negotiate better contract pricing and discounts with suppliers by using vendor detail reports To promote acceptance and usage of purchasing card programs card issuers have established incentive rates for merchants The incentive rates are available to merchants who comply at transaction processing Level 2 or Level 3 Transactions that comply at transaction processing Level 1 qualify as normal credit card transactions NOTE Card issuing institutions perform strict data verification on the enhanced data that merchants submit with Level 2 or Level 3 transactions Issuers may charge stiff penalties when fields contain either inaccurate or filler data Only transactions that contain accurate data are eligible for the incentive rates About Program Levels The term Level does not apply to the card but to the transaction data submitted for that card Generally a higher level means more detailed data for reporting The following table describes the recognized transaction levels Gateway Developer Guide and Reference 31 July 2012 143 144 Submitting Purchasing Card Level 2 and Level 3 Transactions About American Express Purchasing Card Transactions Level Description Level 1 Level 2 Level 3 Function as norma
156. haracters If more than 21 characters use proper and meaningful abbreviation Do not truncate Optional The region code that corresponds to the state province or country subdivision of the merchant location where the transaction took place Region code examples e CA California USA e NS Nova Scotia Canada e COS Colima Mexico If you are a third party biller bill for services or goods rendered by another entity you must enter the region code that corresponds to the state province or country subdivision in which the seller is located Character length and limitations 3 alphanumeric characters Optional The 5 to 9 digit zip postal code excluding spaces dashes and non numeric characters where the transaction took place If you are a third party biller bill for services or goods rendered by another entity you must enter the postal code that corresponds to the seller s location Character length and limitations 15 alphanumeric characters Optional Country code of the location where the transaction took place Character length and limitations 3 alphanumeric characters Optional Merchant assigned store or location number or name that uniquely identifies where the transaction took place Character length and limitations 15 alphanumeric characters Required American Express assigned service establishment number used to identify and facilitate payments to merchants Character length and limitations 15 al
157. he transaction data that was submitted for the transaction set the optional ECHODATA parameter to True This is the default setting This will return the name and address parameters that were provided in the request in addition to the values that you receive in a typical transaction response See Transaction Responses for more info Gateway Developer Guide and Reference 31 July 2012 39 Configuring Hosted Checkout Pages Silent Posts 40 31 July 2012 Gateway Developer Guide and Reference 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 e Preparing the Payflow Gateway Client Application on page 41 e Activating Your Payflow Gateway Account on page 42 e Host URL Addresses on page 42 NOTE Each SDK includes full API documentation The Payflow SDK is available as a NET or Java library NOTE Alternately you can build your own API by posting directly to the Gateway servers by HTTPS Any reference to Payflow SDK or API in this documentation is referred to simply as the Payflow SDK Preparing the Payflow Gateway Client Application Unless you are building your own API and using HTTPS to post to the servers you need to obtain the Payflow SDK Follow these steps 1 Download the Payflow SDK From the SDKs and Downloads page on x com download the Payflow SDK appropriate for your platform 2 E
158. horization e B Balance Inquiry e C Credit e D Delayed Capture e F Voice Authorization e I Inquiry e L Data Upload e N Duplicate Transaction NOTE A type Ntransaction represents a duplicate transaction version 4 SDK or HTTPS interface only with a PNREF the same as the original It appears only in the PayPal Manager user interface and never settles e S Sale e V Void ACCT Required for credit cards Credit card or purchase card number For example ACCT 5555555555554444 For the pinless debit TENDER type ACCT can be the bank account number Limitations This value may not contain spaces non numeric characters or dashes EXPDATE Required Expiration date of the credit card For example 1215 represents December 2015 Limitations mmyy format Gateway Developer Guide and Reference 31 July 2012 51 52 Submitting Credit Card Transactions Core Credit Card Parameters Parameter Description AMT COMMENTI COMMENT2 CVV2 RECURRING SWIPE Required Amount Default U S based currency Limitations Specify the exact amount to the cent using a decimal point For example use 34 00 not 34 Do not include comma separators For example use 1199 95 not 1 199 95 Your processor or Internet Merchant Account provider may stipulate a maximum amount 10 numeric characters plus decimal Optional Merchant defined value for reporting and auditing purposes Limitations 128 alphanumeric characters Optional
159. ia Added new processors First Third International Heartland Payment Systems Planet Payment SecureNet TeleCheck WorldPay Added new transaction types TRXTYPE L can be used to upload credit card data easing PCI compliance You can store the resulting PNREF locally for use in performing reference transactions 16 31 July 2012 Gateway Developer Guide and Reference Preface Revision History Date Description January 2012 cont Added request NVPs ADDLAMTn ADDLAMTTYPEN AUTHDATE CATTYPE CONTACTLESS CUSTDATA CUSTOMERID CUSTOMERNUMBER DISCOUNT DUTYAMT DLNAME DLNUM DOB L_ALTTAXAMTN L_ALTTAXIDN L_ALTTAXRATEN L_CARRIERSERVICELEVELCODEN L_COMMCODEN L_EXTAMTN L_PRODCODEN L_TAXTYPEN ORDERID MERCHANTDESCR MERCHANT INVNUM MERCHANTNAME MERCHANTURL MERCHANTVATNUM MERCHANTZIP MISCDATA REPORTGROUP SILENTTRAN STREET3 VATINVNUM VATTAXAMT VATTAXRATE Added response NVPs DUPLICATE response EXTRMSG response Gateway Developer Guide and Reference 31 July 2012 17 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 18 31 July 2012 Gateway Developer Guide and Reference Introducing the Gateway Checkout Solutions The Gateway provides checkout solutions for novice and advanced u
160. ide and Reference Processors Requiring Additional Transaction Parameters A American Express Additional Credit Card Parameters 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 12 numeric characters ADDLAMTTYPEN Optional A 3 digit code indicating the type of the corresponding charge detail where n is a value from 1 5 Character length and limitations 3 numeric characters Airline Passenger Data Parameters Field Description ATR DEPARTUREDATE Optional Departure date in the format YYYYMMDD Character length and limitations 8 alphanumeric characters ATR PASSENGERNAME Optional Name of the passenger in the following format with fields separated by a space surname firstname middleinitial title Character length and limitations 60 alphanumeric characters ATR 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 NOTE Present day airport codes are three characters in length The five character length is designed to allow for future expansion Character length and limitations 5 alphanum
161. iginal transaction is valid for use in reference transactions for 12 months You can also use the PNREF account verification returns in a reference transaction When To Use a Reference Transaction Say that Joe Smith purchases a holiday gift from your website store and requests that you send 1t by UPS ground service That evening Joe becomes concerned that the item might not arrive in time for the holiday So Joe calls you to upgrade shipping to second day air You obtain Joe s approval for charging an extra 10 for the upgrade In this situation you can create a reference transaction based on the original authorization and charge an additional 10 to Joe s credit card without having to ask him again for credit card information NOTE As a security measure reference transactions are disallowed by default Only your account administrator can enable reference transactions for your account If you attempt to perform a reference transaction in an account that does not allow reference transactions Payflow returns RESULT value 117 See PayPal Manager online help for instructions on setting reference transactions and other security features Sale and authorization transactions can use a reference transaction as a source of transaction data Payflow looks up the reference transaction and copies its transaction data into the new sale or authorization Except for dollar amount data which triggers a filter if out of range Fraud Protection Service filter
162. igit ZIP postal code excluding spaces dashes and non numeric characters Example 951121737 Character length and limitations 9 characters 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 Character length and limitations 30 characters SHIPTOLASTNAME Optional Last name in the shipping address Character length and limitations 30 characters 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 Example 951121737 Character length and limitations 9 alphanumeric characters SHIPTOPHONENUM Optional Shipping telephone number Character length and limitations 10 alphanumeric characters 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
163. imitations 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 Character length and limitations numeric Example Global Payments Central Level 2 Visa or MasterCard Transaction Parameter String TRXTYPE S amp ACCT 5105105105105100 amp AMT 20 10 amp BILLTOCITY Mountain View amp COMMENT1 L2 Testing amp EXPDATE 1209 amp BILLTOFIRSTNAME Cardholder First Name amp BILLTOLASTNA ME Cardholder Last Name amp PARTNER PayPal amp PWD pwd amp BILLTOSTATE CA amp BILLTOSTREET 123 Main St amp TENDER C amp USER user amp BILLTOZI P 94 043 amp CUSTCODE 123456 amp TAXAMT 1 34 Global Payments East Purchasing Card Transaction Processing Global Payments East NDCE supports Level 2 parameters for American Express MasterCard and Visa Global Payments East Level 2 Parameters Pass the following Level 2 parameters in authorization and sale transactions to get the discount rate Gateway Developer Guide and Reference 31 July 2012 159 Submitting Purchasing Card Level 2 and Level 3 Transactions Heartland Purchasing Card Transaction Processing Level 2 Parameters Description CUSTCODE TAXAMT Required Customer code Character length and limitations 1 to 16 alphanumeric characters Required Sales
164. ing Card Transaction Processing Parameter Description L OTYn Required Quantity Character length and limitations 12 numeric characters L_UOMnN 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 Character length and limitations 4 numeric characters L DISCOUNTN Optional Discount per line item Character length and limitations 12 numeric characters L_AMTn Optional Line item total Character length and limitations 12 numeric characters Example Heartland Level 3 MasterCard Transaction Parameter String TRXTY PE S amp TENDER C amp PARTNER Partner amp USER User amp PWD Password amp ACCT 552500000000 0005 amp EXPDATE 1215 amp AMT 1 00 amp BILLTOSTREET 5199 JOHNSON amp BILLTOZIP 94588SALTTAX AMT 1 00 amp CUSTVATREGNUM 11111 amp LOCALTAXAMT 1 OO amp NATIONALTAXAMT 1 00 amp COMMCODE 22222 amp VATAXAMT 1 00 amp VATAXPERCENT 10 amp TAXEXEMPT Y amp DISCOUNT 1 00 amp FREIGHTAMT 1 OO0 amp DUTYAMT 1 00 amp SHIPTOZIP 33333 amp SHIPFROMZIP 44444 amp SHIPTOCOUNTRY 840 amp 0ORDERDA TE 0207258 L_COMMCODE1 123456789ABC8L DESCl Line item 1 description amp L_UPC1 C BA987654321 amp L QTY1 1 amp L UOM1 123456789012 amp L COST1 1 00 amp L TAXAMT1 1 00 amp L TAXR ATE1
165. ion contained in this document or resulting from the application or use of the product or service described herein PayPal Inc reserves the right to make changes to any information herein without further notice Content Chapter P Preface 11 SCOPE mica a ar a ia es o Pe a A 11 Related Documentation 00 ee 11 Intended Audience ee 11 Who Should Use This Document 22 00052200 12 Revision History gt a 2 asda deasa aana a 15 Chapter 1 Introducing the Gateway Checkout Solutions 19 About the Gateway Checkout Solutions 0 0 0 19 Summary of the Gateway Checkout Solutions 0 19 Gateway Product Details o 20 About the Gateway Transaction Flow 0 0 0000 eee eee 21 About Secunly o career banded 22 Secure Token 2 aa 23 Hosted Checkout Pages e 23 PCI Compliance Without Hosted Pages Transparent Redirect 24 Processing Platforms Supporting Card Present Transactions 24 Supported Payment Types 2 2 0 2 25 Recurring Billing Service 2 0 e a 26 Chapter 2 Secure Token 2 eee ee 2 About the Secure Token Integrating the Secure Token With the Hosted Checkout Pages 27 Integrating the Secure Token Without the Hosted Checkout Pages Trans
166. ion country code Character length and limitations 3 alphanumeric characters 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 Character length and limitations 9 alphanumeric characters CUSTVATREGNUM Required Customer VAT registration number Character length and limitations 13 alphanumeric characters VATTAXAMT Optional VAT tax amount freight shipping Character length and limitations 12 numeric characters VATTAXPERCENT Optional VAT tax rate freight shipping Character length and limitations 4 numeric characters Merchant e Solutions Level 3 Visa Line Item Detail Records Parameter Description L_COMMCODEN Optional Item commodity code Character length and limitations 12 alphanumeric characters L_DESCn Required Item descriptor Character length and limitations 35 alphanumeric characters L_UPCN Optional Product code Character length and limitations 12 alphanumeric characters L_OTYn Required Quantity Character length and limitations 12 numeric characters Gateway Developer Guide and Reference 31 July 2012 173 Submitting Purchasing Card Level 2 and Level 3 Transactions Paymentech Salem New Hampshire Purchasing Card Transaction Proces
167. ional Purchase order number Character length and limitations 25 alphanumeric characters provides best rate when used SHIPTOZIP Optional Ship to postal code called zip code in the USA Character length and limitations 9 numeric characters provides best rate when used Gateway Developer Guide and Reference 31 July 2012 153 154 Submitting Purchasing Card Level 2 and Level 3 Transactions First Data Merchant Services FDMS North Purchasing Card Transaction Processing Field Description TAXAMT Optional Tax amount The value must include a decimal and the exact amount to the cent 42 00 not 42 Do not include comma separators 1234 56 not 1 234 56 Character length and limitations 10 currency characters provides best rate when used TAXEXEMPT Optional Is the customer tax exempt Character length and limitations 1 alphanumeric character Y or N First Data Merchant Services FDMS North Purchasing Card Transaction Processing The following parameters are recommended to obtain the best rates for Level 2 and Level 3 purchasing card transactions with FDMS North FDMS North Purchasing Parameters Field Description SHIPTOCOUNTRY Optional Destination country code Visa and MasterCard are different Character length and limitations 3 alpha characters DISCOUNT Optional Discount amount on total sale Character length and limitations 10 currency characters DUTYAMT Optional Sometimes called import tax If
168. is returned unpaid you authorize us or our service provider to collect the payment and your state s return item fee of insert state returned item fee by electronic funds transfer s or draft s drawn from your account Do you agree and authorize the payment The 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 you want to display the state fees Suggestions include a new pop up window a full browser window or directly on the checkout page NOTE Foran additional fee TeleCheck can send the written notification of the authorization and transaction to the consumer on the merchant s behalf Prearranged Payments and Deposits Authorizations PPD Payments are facilitated not authorized Authorization is via paper from consumer to merchant PPD Authorization Requirements e Must be face to face in writing and signed e Must clearly and conspicuously state it terms such as consumer name payment amount payment timing if recurring and bank routing account information Must also provide that authorization may be revoked in the manner specified in the authorization e Customer must be provided a copy Language Sample for PPD By providing a check as payment I authorize you to use information from my check to make a one time electronic funds tra
169. item Character length and limitations 3 numeric characters Gateway Developer Guide and Reference 31 July 2012 175 Submitting Purchasing Card Level 2 and Level 3 Transactions Paymentech Salem New Hampshire Purchasing Card Transaction Processing Location Transaction Advice Addendum Parameters Field Description MERCHANTNAME MERCHANTSTREET MERCHANTCITY MERCHANTSTATE MERCHANTZIP MERCHANTCOUNTRY CODE MERCHANTLOCATIONID Optional Name of merchant Character length and limitations 38 alphanumeric characters 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 Optional The name of the city were the transaction took place e Ifyou 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 e If you are a mail order phone order or internet industry you may substitute the name of the city in which the merchant s order processing facility is located Character length and limitations 21 alphanumeric characters If more than 21 characters use proper and meaningful abbreviation Do not truncate Optional The region code that corresponds to the state province or country subdivision of the merchant location where the transaction took place Region code e
170. jpg jpeg gif or png The maximum image size is 100kb e Background applicable to Layout B You can change the following Background color Footer text color Upload image Repeat image option e Title and Button applicable to Layout B You can change the following Header color Gateway Developer Guide and Reference 31 July 2012 35 Configuring Hosted Checkout Pages Using a Secure Token and Dynamically Passing Form Post Variables Title bar color and title text color Button color and button text color e Order Summary Column applicable to Layout B You can change the following Column Color Upload image Repeat image option Using a Secure Token and Dynamically Passing Form Post Variables You need to create a secure token and obtain the secure token ID prior to sending the form post with configuration parameters for the hosted pages For details see the Secure Token chapter The table below describes the form post variables that you can use to dynamically configure the hosted checkout pages Setup Params 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 CSCREQUIRED Determines if the card security code is required Values TRUE or FALSE CSCEDIT Deter
171. kes 2 3 days Use the host address of the live server described in Host URL Addresses on page 42 Responses to TeleCheck Transactions When a transaction finishes PayPal returns a response string made up of name value pairs For example RESULT 0 amp PNREF VXYZ01234567 amp HOSTCODE 000500 amp RESPMSG Approved TeleCheck transaction response values are described in the table below Transaction Responses Common to All Tender Types Field Description RESULT The outcome of the attempted transaction A result of 0 zero indicates the transaction was approved Any other number indicates a decline or error Character length and limitations numeric variable number of characters PNREF PayPal Reference ID a unique number that identifies the transaction Character length and limitations 12 alphanumeric characters 31 July 2012 Gateway Developer Guide and Reference TeleCheck Electronic Check Processing Boo 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 Response Code Values For your service below is a complete list of possible Response Codes Depending upon the merchants risk parameters and service
172. l Intended Audience This guide provides Gateway payments solutions to readers who e Are web or application developers e Have a background in payments services Gateway Developer Guide and Reference 31 July 2012 11 12 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 This section will help you determine whether you should use this document and which sections of the document are relevant to you To view the Gateway solutions available to you login to PayPal Manager at https manager paypal com PayPal Manager displays your Gateway Services in the Service Summary box e Payflow Link Payflow Link customers can choose PayPal or another merchant bank to process their transactions via the Payflow Gateway A Legacy Payflow Link users will see the following in the Service Summary box in PayPal Manager Payflow Link Service Summary Service Status Mode Pay flow Link Live Test If you are a legacy Payflow Link user do not use this guide instead use the Payflow Link User s Guide B New Payflow Link users will see the following in the Service S
173. l 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 QTY3 Optional Quantity of this line item Character length and limitations 3 numeric characters L_DESC4 Optional Description of this line item if not provided DESC4 if present is used Character length and limitations 30 alphanumeric characters L_AMT4 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 OTY4 Optional Quantity of this line item Character length and limitations 3 numeric characters 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 Do not truncate Gateway Developer Guide and Reference 31 July 2012 147 148 Submitting Purchasing Card Level 2 and Level 3 Transactions American Express Purchasing Card Transaction Processing Field Description MERCHANTCITY MERCHANTSTATE MERCHANTZIP MERCHANTCOUNTRY
174. l credit cards and are authorized and associated with normal transaction data in authorization and settlement Any merchant who accepts credit cards supports this level Additional data regarding sales tax customer code purchase order number invoice number are captured at the point of sale In most cases this information is combined with the merchant s tax ID number state and postal code data and is then passed through during settlement For some processors and banks however a Level 2 authorization may include some of this data Significant additional information such as line items product codes item descriptions unit price unit quantities and ship to postal data are added to the Level 2 data to provide optimal reporting to buyers and sellers Settlement transactions typically carry Level 3 data Level 2 and Level 3 data is generally considered non financial data Lack of adequate data may cause a transaction to be downgraded PayPal generally requires up to Level 2 information in an authorization transaction followed by additional Level 3 data in the associated delayed capture transaction A sale transaction should include all Level 3 data since it is authorized and later settled Accepted BIN Ranges Visa MasterCard and American Express publish specific Bank Identification Number BIN ranges for purchasing cards Sometimes the processor determines whether a card is a purchasing card for example TSYS Acquiring Solutions I
175. le transaction is best suited to businesses that provide immediate fulfillment for their products or services If your business does not provide immediate fulfillment credit card association rules recommend that you use an authorization and a delayed capture transaction For details see Submitting Authorization Delayed Capture Transactions on page 55 To recharge a credit card when you are not storing the credit card information in your local database you can perform a new reference transaction based on a Sale transaction Additional Parameters For Sale Transactions To perform a sale transaction pass the following parameters e ACCT e AMT e EXPDATE NoTE 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 Gateway Developer Guide and Reference 31 July 2012 69 70 Submitting Credit Card Transactions Submitting Soft Merchant Information TRXTYPE S amp TENDER C amp USER SuperUser amp PWD SuperUser Password amp VENDOR SuperUser amp PA RTNER PayPal amp ACCT 5105105105105100 amp EXPDATE 1215 amp CVV2 123 amp AMT 99 OO amp BILLTOFI RSTNAME John amp BILLTOLASTNAME S
176. link to the state fee table TeleCheck has posted a table of current state returned check fees at http www firstdata com support telecheck_returned_check returned_check_fees htm The 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 Checks By Phone Service Authorizations At the end of the check out process the customer service agent must read the consent language to the consumer and either audio record the consumer s authorization or send a written notification of the authorization and the transaction to the consumer prior to settlement of the transaction The consent language for the customer to accept prior to submitting the payment authorization request is as follows Checks By Phone Authorization Consent Required Language FULL DEBIT 140 31 July 2012 Gateway Developer Guide and Reference TeleCheck Electronic Check Processing TeleCheck Authorization Requirements 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 Do you agree If your payment
177. ll 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 Character length and limitations 9 alphanumeric characters First Data Merchant Services North Additional Credit Card Parameters In addition to the core credit card parameters First Data Merchant Services FDMS North accepts the parameters described Field Description DESC Optional Use the DESC parameters to pass in your DBA name and other data describing the transaction This information will be displayed in the account holder s statement NOTE Note FDMS North passes the descriptive data to the card associations with the following character lengths Visa 25 MasterCard 22 AMEX 20 DISC 22 Some card associations truncate the value to 19 characters If you have questions consult the card association Character length and limitations 25 alphanumeric characters MERCHDESCR Optional Use this parameter to pass in your DBA name and other data describing the transaction This information is usually displayed in the account holder s statement Character length and limitations 25 alphanumeric characters 110 31 July 2012 Gateway Developer Guide and Reference Processors Requiring Additional Transaction Parameters Heartland Additional Credit Card Parameters Field Description MERCHSVC Optional Defaults to the city where th
178. llowing processors Global Payments East and Central and American Express 7 Field format error Submit a delayed capture transaction with no ORIGID 12 Declined Use the AMOUNT 1012 or an AMOUNT of 2001 or more 13 Referral Use the AMOUNT 1013 Gateway Developer Guide and Reference 31 July 2012 79 Testing Transactions Processors Other Than PayPal RESULT value Definition How to test using Payflow Gateway 19 22 23 24 25 29 30 50 99 100 101 103 104 105 108 111 112 113 Original transaction ID not found Invalid ABA number Invalid account number Invalid expiration date Transaction type not mapped to this host Processor Invalid XML document Duplicate Transaction Insufficient funds available General error Invalid transaction returned from host Processor Time out value too small Error reading response from host Processor Timeout waiting for processor response Credit error Void error Capture error Failed AVS check Cannot exceed sales cap Submit a delayed capture transaction with an invalid ORIGID Applies only to ACH transactions submit an invalid ABA number 8 digits Submit an invalid account number for example 000000000000000 Submit an invalid expiration date for example 0298 Submit a transaction for a card or tender you are not currently set up to accept for example a Diners card if you aren t set up to accept Dine
179. loper Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions Heartland Purchasing Card Transaction Processing Parameter Description VATREGNUM Required VAT registration number Can be part of the registration data or passed with each transaction Character length and limitations 20 alphanumeric characters FREIGHTAMT Required Unique VAT inventory reference number Can be part of the registration data or passed with each transaction Character length and limitations 9 alphanumeric characters CUSTVATREGNUM Required Customer VAT registration number Character length and limitations 13 alphanumeric characters VATTAXAMT Optional VAT tax amount freight shipping Character length and limitations 12 numeric characters VATTAXPERCENT Optional VAT tax rate freight shipping Character length and limitations 4 numeric characters Heartland Level 3 Visa Line Item Detail Records Parameter Description L_COMMCODEN Optional Item commodity code Character length and limitations 12 alphanumeric characters L_DESCn Required Item descriptor Character length and limitations 35 alphanumeric characters L UPCN Optional Product code Character length and limitations 12 alphanumeric characters L QTYN Required Quantity Character length and limitations 12 numeric characters L_UOMnN Required Unit of measure code Character length and limitations 12 alphanumeric characters
180. mber from 1 to 99 Character length and limitations 12 numeric characters Optional Number of items purchased where n is a line item number from 1 to 99 Character length and limitations 12 numeric characters Optional Line item tax amount where n is a line item number from 1 to 99 L_AMTn L_TAXAMTn line item total Characteristic length and limitations The decimal is implied If for example you specify 500 this value is equivalent to 5 00 8 numeric characters Optional Unit of measure of the purchased item such as kit pair gallon or month where n is a line item number from 1 to 99 Character length and limitations 12 alphanumeric characters Merchant e Solutions Purchasing Card Transaction Processing 168 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions 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 Based on the commercial card indicator Payflow will format the Level 2 information in the settlement request Merchant e Solutions Level 2 Transaction Data To get the discount rate Level 2 values marked as Required in the following table must be present Parameter Description P
181. ment Processing Network Numbers in the figure correspond to the numbered comments below 1 The customer clicks Buy to purchase merchandise on your website You request a secure token by passing a token ID to the Gateway server The Gateway server returns the secure token and your token ID to your website bb U N 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 The Gateway server uses the secure token to retrieve the amount and other transaction data The customer submits their credit card number expiration date and other sensitive data directly to the host pages rather than to your website easing your PCI compliance requirements Gateway Developer Guide and Reference 31 July 2012 23 EN Introducing the Gateway Checkout Solutions Processing Platforms Supporting Card Present Transactions The Gateway processes the payment through the payment processing network The Gateway server transparently returns the customer to the location on your website that you specified in the request to obtain a secure token You display the results to the customer on your website NOTE If you do not get a response from the Gateway server submit an Inquiry transaction passing in the secure token to see if the transaction has completed For details see Submitting Inquiry Transactions on page 61 PCI Compliance Without Hosted Pages
182. mines if the card security code is editable Values TRUE or FALSE DISABLERECEI PT Determines if the payment confirmation order receipt page is a PayPal hosted page or a page on the merchant site For carts we recommend the carts host the order confirmation page Values TRUE or FALSE EMATLCUSTOMER Send the buyer an email confirmation or not Default value is FALSE ERRORURL The URL that customers are directed to if an error occurs Maximum length 512 characters RETURNURL The URL that customers are directed to after a transaction completes successfully Maximum length 512 characters SILENTPOSTURL The URL to which the Gateway will send Silent Post Maximum length 512 characters 36 31 July 2012 Gateway Developer Guide and Reference Configuring Hosted Checkout Pages EEN Using a Secure Token and Dynamically Passing Form Post Variables Variable Description SILENTPOSTFAILEDURL The return URL when Silent Post fails Maximum length 255 characters TEMPLATE Determines whether to use one of the two redirect templates Layout A or B or the embedded template C Values are TEMPLATEA or TEMPLATEB or MINLAYOUT for template C URLMETHOD The technical method used to deliver the CANCELURL The default is GET and cannot be changed without affecting the installed base but this value will likely be changed to Post by most carts Values POST or GET Customize Params Variable Description PAGECOLLAPSEBGCOLOR Se
183. mitations 1 alpha character 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 To enable you to use the data the SWIPE parameter must include a length tag specifying the number of characters in the track data For this reason in addition to passing the track data the POS application must count the characters in the track data and pass that number Length tags are described in Using Special Characters In Values on page 43 NOTE SWIPE card present transactions are not supported by the PayPal processor Limitations Alphanumeric and special characters 31 July 2012 Gateway Developer Guide and Reference Submitting Credit Card Transactions CEN Core Credit Card Parameters Parameter Description ORDERID BILLTOFIRSTNAME BILLTOLASTNAME BILLTOSTREET BILLTOCITY BILLTOSTATE BILLTOZIP BILLTOCOUNTRY SHIPTOFIRSTNAME SHIPTOLASTNAME SHIPTOSTREET SHIPTOCITY SHIPTOSTATE SHIPTOZIP Optional Checks for a duplicate order If you pass ORDERID in a request and pass it again in the future the response returns DUPLICATE 2 along with the ORDERID NOTE Do not use ORDERID to catch du
184. mith amp BILLTOSTREET 123 Main St amp BILLTOCITY San Jose amp BILLTOSTATE CA amp BILLTOZIP 12345 amp COMMENT1 Reservat ion amp INVNUM 1234567890 amp PONUM C12345 amp VERBOSITY HIGH Besides the required parameters that you pass in a sale transaction this string includes other typical parameters The COMMENT1 and COMMENT2 fields help to track transaction information Pass the customer s street address BILLTOSTREET and zip code BILLTOZIP to use address verification service To validate card security codes pass the CVV2 parameter For details on address verification service and card security code see the following e Submitting Card Present SWIPE Transactions on page 57 e Using Card Security Code on page 75 Submitting Soft Merchant Information Soft merchant information is detailed data about a merchant such as the merchant s name business address business location identifier and contact information About Soft Merchant Information Ways to Merchants aggregators who perform transactions on behalf of other merchants under a single merchant account provide the processor with soft merchant information Soft merchant information identifies the merchant making the sale and includes information about that merchant on the buyer s card statement Say for example Outdoor Apparel has a chain of 12 stores located in the Western United States with the corporate office in Oakland California John Lui purchases a pair
185. n 31 July 2012 201 203 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 It organizes parameters into a core set of request parameters supported by all processors additional parameters unique to individual processors and purchasing card parameters specialized to monitor credit card use in businesses It also provides a section on response parameters and error codes PNREF values that are not 0 Although this guide provides guidance on getting started with the SDK setting up credit card processing and testing your integration its broad scope does not lend to use as a tutorial on integration Refer to the PayPal Developer website and the Payflow Gateway SDK for detailed working examples and use cases Related Documentation For additional information on the Gateway payments solutions e See PayPal Manager at https manager paypal com e For more information on Payflow documentation examples and very current information see the PayPal developer site at the following URL https www x com developers paypa
186. n 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 To enable you to use the data the SWIPE parameter must include a length tag specifying the number of characters in the track data For this reason in addition to passing the track data the POS application counts the characters in the track data and passes that number as the length tag For details on length tags see Using Special Characters In Values on page 43 The length tag in the following example is 40 58 31 July 2012 Gateway Developer Guide and Reference Submitting Credit Card Transactions Submitting Credit Transactions NOTE Do not include the ACCT or EXPDATE parameters in card present transactions The SWIPE value includes this data TRXTYPE S amp TENDER C amp PARTNER PayPal amp USER SuperMerchant amp PWD SuperMerchant amp SWIP E 40 4912000033330026 15121011000012345678 amp AMT 21 00 Submitting Credit Transactions The credit transaction TRXTYPE C refunds the specified amount back to the cardholder A credit transaction can contain a reference to the original transaction referenced or not non referenced depending on how your account is setup To issue a credit the origin
187. n other cases the Gateway makes the determination based on the BIN range for example FDMS South and American Express About American Express Purchasing Card Transactions The information in this section applies to transactions processed by American Express not necessarily to all American Express cards Level 2 and Level 3 purchasing card rules may differ for American Express card transactions processed by other processors such as Paymentech or First Data Nashville Supported Transaction Types You can submit Level 3 parameters with delayed capture sale credit or force transactions Level 3 data in authorization transactions 1s ignored The Gateway decides whether a transaction meets Level 3 requirements during authorization Level 3 data is passed to the American Express processor only during settlement 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions About American Express Purchasing Card Transactions Avoiding Downgrade If a transaction uses the purchasing card BIN range see Accepted BIN Ranges on page 146 and contains a line item but does not include all mandatory Level 3 parameters the transaction succeeds but is processed as Level 2 or Level 1 during settlement depending on which data was passed For downgraded transactions with the VERBOSITY parameter set to HIGH the ADDLMSGS field returns a message like the following Features not processed
188. n value 9 a ea8208del413abc3d60c86cb1f4c5 name SECURETOKENID gt lt form gt lt center gt lt body gt lt html gt The following example uses Payflow name value pairs to pass values in a form post to the hosted checkout pages For details on name value pair strings see Sending a Simple Transaction to the Server on page 43 lt html gt lt META http equiv Content Type content text html charset UTF 8 gt lt head gt lt title gt PageTitle lt title gt lt head gt lt body gt lt form method post action https payflowlink paypal com gt lt input type text name SECURETOKEN value FvwEnHTYRNUSVsZR1hFpudA gt lt input type text name SECURETOKENID value 9a9ea8208de1413abc3d60c86cb1f4c5 gt lt input type hidden name PARMLIST value INVNUM 8 INV12345 amp AMT 5 25 506 CURRENCY 3 USD amp PONUM 7 P012345 gt lt input type submit gt lt form gt lt center gt lt body gt lt html gt 30 31 July 2012 Gateway Developer Guide and Reference Configuring Hosted Checkout Pages This chapter describes the following e Configuring Hosted Checkout Pages on page 31 e Configuring Hosted Pages Using PayPal Manager on page 31 e Using a Secure Token and Dynamically Passing Form Post Variables on page 36 e Silent Posts on page 38 Configuring Hosted Checkout Pages PayPal enables you to customize the hosted checkout pages so that the
189. nal Freight amount Character length and limitations 12 numeric characters DUTYAMT Optional Duty amount Character length and limitations 12 numeric characters SHIPTOZIP Required The zip code of the address to which the goods are shipped Character length and limitations 10 alphanumeric characters SHIPFROMZIP Required The postal code called zip code in the USA from which shipping occurs Character length and limitations 10 alphanumeric characters SHIPTOCOUNTRY Optional Destination country code Character length and limitations 3 alphanumeric characters ALTTAXAMT Optional Alternate tax amount Character length and limitations 9 numeric characters TSYS Acquiring Solutions Level 3 MasterCard Line Item Detail Records NOTE 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_QTY lt n gt and unit price L_COST lt n gt fields Parameter Description L_DESCn Required Item descriptor Character length and limitations 35 alphanumeric characters L_ UPCN Optional Product code Character length and limitations 12 alphanumeric characters L _OTYn Required Quantity Character length and limitations 12 numeric characters L_UOMnN 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
190. ns 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 PayPal Processor Code PayPal Processor CVV2 Code Description PROCVV2MATCH M Match Y N No Match N P Not Processed X S Service Not Supported X U Unavailable X X No Response X All other X PayPal Card Security Code Results The following table shows the detailed results the PayPal processor returnes 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 PayPal Processor Code PayPal Processor CVV2 Code Description PROCVV2MATCH M Match Y N No Match N P Not Processed X S Service Not Supported X U Unavailable X 92 31 July 2012 Gateway Developer Guide and Reference Transaction Responses c BALAMT Response and Stored Value Cards PayPal Processor Code PayPal Processor CVV2 Code Description PROCVV2MATCH X No Response X All other 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 a
191. nsfer EFT or draft from my account or to process the payment as a check transaction When you use information from my check to make an EFT funds may be withdrawn from my account as soon as the same day my payment is received and I will not receive my check back from my financial institution The account referenced above is a check one Consumer account Business account If my payment is returned unpaid I authorize you or your service provider to collect my payment and my state s return fee set forth below by EFT s or draft s from my account I understand that I can revoke this authorization by sending written notice to in such time and manner as to afford____ a reasonable opportunity to act on it If this payment is from a corporate owned account I make these authorizations as an authorized corporate representative and agree that the entity will be bound by the NACHA Operating Rules Returned Check Fees TeleCheck has posted a table of current state returned check fees at http www firstdata com support telecheck_returned_check returned_check_fees htm The Gateway Developer Guide and Reference 31 July 2012 141 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
192. nter Contact TeleCheck Sale Error Responses Code Description Merchant Action 46 Merchant setup does not allow this type of transaction 49 Processor Not Available Re send message later 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 Adjustment Code Values Adjustment Refund Change Void Responses Code Description Merchant Action 26 Merchant allowed to send full partial No action needed adjustments refunds without transaction errors 46 Merchant setup does not allow this type of Adjustment cannot be processed by transaction 79 Original transaction was not approved Adjustment cannot be processed by 80 Refund or partial amount is greater than Adjustment cannot be processed by the original sale amount 81 Unable to locate original transaction Adjustment cannot be processed by TCK Trace ID Response Codes For Status Response Packets Response Codes for Status Response Packets Code Description OK Inquiry POS system Packet was accepted and successfully processed by TeleCheck 31 July 2012 Gateway Developer Guide and Reference TeleCheck Electronic Check Processing Boo 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 success
193. nts Advanced and Payflow Link merchants must use a secure token with hosted checkout pages To obtain a secure token pass a unique 36 character secure token ID and set CREATESECURETOKEN Y in a request to the Gateway server The Gateway server associates your ID with a secure token and returns the token as a string of up to 32 alphanumeric characters To pass the transaction data to the hosted checkout page you pass the secure token and secure token ID in an HTTP form post The token and ID trigger the Gateway server to retrieve your data and display it for customer approval NOTE You cannot modify the data sent with a secure token with one exception You can configure PayPal Manager to allow you to modify billing and shipping information Integrating the Secure Token With the Hosted Checkout Pages To create a secure token pass all parameters that you need to process the transaction except for payment details parameters such as the credit card number expiration date and check number For details on transaction parameters see Submitting Credit Card Transactions on page 47 In addition pass the following Payflow parameters to create the secure token Gateway Developer Guide and Reference 31 July 2012 27 28 Secure Token Integrating the Secure Token Without the Hosted Checkout Pages Transparent Redirect NOTE The secure token is valid for 30 minutes and you can only use it one time If you attempt to use the token after
194. of hiking boots online from Hiker s Duds in San Jose California and charges them to his credit card The transaction goes to the aggregator at Outdoor Apparel in Oakland The aggregator sends soft merchant information about the Hiker s Duds store with the transaction to the credit card processor When John receives his credit card statement he recognizes the charge for the hiking boots he purchased at Hiker s Duds in San Jose Send Soft Merchant Information There are 2 ways you can send soft merchant information e Soft merchant information SM Record e Merchant descriptor M Record The Paymentech processor requires that you follow their guidelines to send soft descriptor information using either of these methods 31 July 2012 Gateway Developer Guide and Reference Submitting Credit Card Transactions CAEN Submitting Voice Authorization Transactions Soft Merchant Information SM Record Soft merchant information is for American Express credit cards only Typically aggregators and petroleum merchants pass soft merchant information to the processor in Gateway parameter fields such as the following e MERCHANTNAME e MERCHANTSTREET e MERCHANTCITY e MERCHANTSTATE e MERCHANTNAME e MERCHANTZIP e MERCHANTCOUNTRYCODE e MERCHANTLOCATIONID e MERCHANTID e MERCHANTCONTACTINFO NOTE Paymentech Salem processor only To take advantage of this level of soft descriptor you must be approved by the Paymentech Risk Cre
195. of the embossed account number Make sure that you explain this to your customers To validate the card security code in a transaction pass the card security code value in the CVV2 parameter in your request The response parameter CVV2MATCH returns the result of the card security code check NOTE To comply with credit card association regulations do not store the card security code value that you pass in the CVV2 parameter Card security code Authorized Signature The following is an example request parameter string TRXTYPE S amp TENDER C amp USER SuperUser amp PWD SuperUser Password amp VENDOR SuperUser amp PA RTNER PayPal amp ACCT 5105105105105100 amp EXPDATE 1215 amp CVV2 123 amp AMT 99 OO amp BILLTOFI RSTNAME John amp BILLTOLASTNAME Smith amp BILLTOSTREET 123 Main St amp BILLTOCITY San Jose amp BILLTOSTATE CA amp BILLTOZIP 12345 NOTE Payflow returns the raw response from the processor in the PROCCVV2 parameter For details on the meaning of the response contact your merchant bank Gateway Developer Guide and Reference 31 July 2012 75 o 6 Submitting Credit Card Transactions Using Card Security Code 76 31 July 2012 Gateway Developer Guide and Reference 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
196. of the three character currency codes for any of the supported PayPal currencies See CURRENCY in this table for details 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 Nine numeric characters plus decimal Optional Total shipping costs for this order NOTE 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 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 Nine numeric characters plus decimal Optional Total handling costs for this order NOTE 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 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 Nine numeric characters plus decimal Optional Shipping discount for this order Specify the discount as a positive amount Limitations Nine numeric characers plus decimal
197. old legacy integration will still work However to take advantage of the new features we recommend that you update your Payflow Link integration and use equivalent Payflow parameters instead of the legacy Payflow Link HTML input tags Migrating from a legacy Payflow Link Integration The legacy Payflow Link integration is now deprecated It is recommended that you upgrade the version of your Payflow Link account which allows you to perform a broader set of functions This upgrade allows you to switch from using the legacy Payflow Link HTML input tag parameters to using Payflow parameters The table below lists legacy Payflow Link parameters and their Payflow equivalents Payflow Link legacy parameters and the equivalent Payflow parameters Payflow Link Legacy Parameter Payflow Parameter ADDRESS BILTOSTREET ADDRESSTOSHIP SHIPTOSTREET AMOUNT AMT AVSDATA AVSADDR and AVSZIP CARDNUM ACCT CITY BILLTOCITY CITYTOSHIP SHIPTOCITY COMMENT 1 COMMENT 1 COMMENT2 COMMENT2 COUNTRY BILLTOCOUNTRY COUNTRYTOSHIP SHIPTOCOUNTRY COUNTRY CODE COUNTRY CODE CSC CVV2 Gateway Developer Guide and Reference 31 July 2012 229 230 Payflow Link Migration Migrating from a legacy Payflow Link Integration Payflow Link Legacy Parameter Payflow Parameter CSCMATCH CUSTID DESCRIPTION DLNUM EMAIL EMAILTOSHIP EXPDATE FAX FAXTOSHIP FIRSTNAME INVOICE LASTNAME LOGIN METHOD NAME NAMETOSHIP PARTNE
198. om the original transaction into the void transaction if they exist in the original transaction If you provide a new value for any of these parameters when submitting the void transaction the new value is used Exceptions are ACCT EXPDATE and SWIPE These parameters retain their original values NOTE For processors that use the RECURRING parameter If you set the RECURRING parameter to Y in the original transaction the setting is ignored when forming the void transaction ACCT AMT BILLTOCITY COMMENT1 COMMENT2 COMPANYNAME BILLTOCOUNTRY CUSTCODE CUSTIP DUTYAMT BILLTOEMATI EXPDATE BILLTOFIRSTNAME BILLTOMIDDLENAME BILLTOLASTNAME FREIGHTAMT INVNUM PONUM SHIPTOCITY SHIPTOCOUNTRY SHIPTOFIRSTNAME SHIPTOMIDDLENAME SHIPTOLASTNAME SHIPTOSTATE SHIPTOSTREET SHIPTOZIP BILLTOSTATE BILLTOSTREET SWIPE TAXAMT BILLTOPHONENUM TAXEXEMPT BILLTOZIP Gateway Developer Guide and Reference 31 July 2012 73 74 Submitting Credit Card Transactions Using Address Verification Service Example Void Transaction Parameter String The following is an example void transaction string TRXTYPE V amp TENDER C amp PARTNER PayPal amp VENDOR SuperMerchant amp USER SuperMerchant amp P WD x1y22Z3 amp ORIGID VPNE125643 95 amp VERBOSITY HIGH Using Address Verification Service To qualify for the lowest bank rate pass address verification service information including the street address and zip postal code Address verification s
199. on and the original transaction will not appear on the customer s statement 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 31 July 2012 Gateway Developer Guide and Reference When To Use a Void Transaction Submitting Credit Card Transactions Use the following guidelines when using void transactions Submitting Void Transactions em e You can void delayed capture sale credit authorization and voice authorization transactions You cannot void a void transaction e You can only use a void transaction on a transaction that has not yet settled To refund a customer s money for a settled transaction submit a credit transaction Required Void Transaction Parameters To perform a void transaction you are required to pass the following parameter Parameter Description ORIGID Required by some transaction types ID of the original transaction that is being referenced The PNREF parameter returns the ID and it appears as the Transaction ID in PayPal Manager reports Limitations 12 case sensitive alphanumeric characters Fields Copied From the Original Transaction Into the Void Transaction The following fields are copied fr
200. onal data element fields and product features in their system s and in communications to TeleCheck s Authorization 31 July 2012 Gateway Developer Guide and Reference TeleCheck Electronic Check Processing Boo TeleCheck NFTF Processing Overview System Various optional data elements throughout each of the message packets could be affected by this requirement e 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 Additionally these partners are required to maintain their NFTF specification as new revisions and addendums become available NFTF Processing Considerations TeleCheck and the Merchant must determine any of the following additional optional features during contract negotiations e MIA Duplicate Checking TeleCheck has the ability to detect duplicate adjustment transactions in back end processes Adjustments can be submitted up to 90 days after the original Sale transaction While multiple adjustment transactions are allowed for a given sale transaction each adjustment transaction must have a unique merchant trace ID Duplicates are detected when an adjustment transaction is submitted that has the same merchant trace ID as a previously submitted adjustment transaction If a du
201. only with voice authorized force capture transactions REQNAME Required Requester name Character length and limitations 1 to 40 alphanumeric characters PONUM Required Cardmember reference number Character length and limitations 1 to 17 alphanumeric characters Gateway Developer Guide and Reference 31 July 2012 149 Submitting Purchasing Card Level 2 and Level 3 Transactions American Express Purchasing Card Transaction Processing Field Description SHIPTOZIP INVOICEDATE TAXAMT DESC FREIGHTAMT HANDLINGAMT L_QTYn L_UOMn L COSTN L DESCN L CATALOGNUMN L COSTCENTERNUMN Required Ship to postal code called zip code in the USA This field must contain one of the following values e Zip code of the destination where the merchandise is to be shipped e If the above is not available Zip code of the location where the merchant executed the transaction Character length and limitations 5 to 6 alphanumeric characters Optional Invoice date Defaults to transaction date if not present Character length and limitations 8 alphanumeric characters in the YYYYMMDD format Required Total transaction 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 NOTE American Express Level 3 processing requires that this parameter have a maximum field length of 8 for Level 3 processing Character length
202. or performing Level 2 and Level 3 purchasing card transactions SecureNet Level 2 Parameters SecureNet supports MasterCard and Visa for Level 2 purchasing card transactions SecureNet indicates in the authorization response whether the credit card in the transaction is a commercial card Based in the commercial card indicator Payflow will format the Level 2 information in the settlement request To get the discount rate Level 2 parameters marked as Required in the following table must be present Gateway Developer Guide and Reference 31 July 2012 181 182 Submitting Purchasing Card Level 2 and Level 3 Transactions SecureNet Purchasing Card Transaction Processing SecureNet Level 2 Parameters Parameter Description PONUM Required Customer reference ID Character length and limitations 1 to 17 alphanumeric characters TAXAMT Required Tax amount The value must include a decimal and the exact amount to the cent 42 00 not 42 Do not include comma separators 1234 56 not 1 234 56 Character length and limitations numeric TAXEXEMPT Optional Tax amount identifier Character length and limitations 1 alpha character Y or N Example SecureNet Level 2 Visa Transaction Parameter String TRXTYPE S8ACCT 41111111111111118AMT 20 028BILLTOCITY Mountain View amp COMMENT1 L2 Test ing amp EXPDATE 1215 amp INVNUM 661254585 amp BILLTOFIRSTNAME CardHolder First Name amp BILLTOLASTNAME CardHolder Last Name amp PARTNER PayPal amp
203. order number customer reference ID The Transaction ID is sent if no value is provided Character length and limitations 9 alphanumeric characters Merchant e Solutions Level 3 Visa Extended Data The parameters listed in the table below apply to Level 3 MasterCard transactions as extended data Parameter Description COMMCODE DISCOUNT Optional Summary commodity code identifier for the business Character length and limitations 4 alphanumeric characters Optional Discount amount Character length and limitations 12 numeric characters 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions Merchant e Solutions Purchasing Card Transaction Processing Parameter Description FREIGHTAMT Optional Freight amount Character length and limitations 12 numeric characters DUTYAMT Optional Duty amount Character length and limitations 12 numeric characters ORDERDATE Required Order date Format is mmddyy with no slashes or dashes For example July 28 2003 is 072803 Character length and limitations 6 numeric characters SHIPTOZIP Required The zip code of the address to which the goods are shipped Character length and limitations 10 alphanumeric characters SHIPFROMZIP Required The postal code called zip code in the USA from which shipping occurs Character length and limitations 10 alphanumeric characters SHIPTOCOUNTRY Optional Destinat
204. orrect TRXTYPE S amp TENDER C amp USER MerchantUserID amp PWD Pwd4Gat eway amp PARTNER PayPal amp ACCT 5105105105105100 amp EXPDATE 1215 amp AMT 23 45 amp COMMENT1 Airport Shuttle amp BILLTOFIRS TNAME Jamie amp BILLTOLASTNAME Miller amp BILLTOSTREET 123 Main St amp BILLTOCITY San Jose amp BILLTOSTATE CA amp BILLTOZIP 951311234 amp BILLTOCOUNTRY US amp CVV2 123 amp CUSTIP 0 0 0 0 Payflow Connection Parameters The Payflow SDK passes connection parameters to define the connection to the Payflow server 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 31 July 2012 Gateway Developer Guide and Reference Sending a Simple Transaction to the Server ET User Parameter Data Parameter Description HOSTADDRESS Required Gateway server name HOSTPORT Required Use port 443 TIMEOUT Required Time out period for the transaction PayPal recommends a minimum time out value of 30 seconds The client begins tracking from the time that it sends the transaction request to the server PROXYADDRESS Optional Proxy server address Use the PROXY parameters for servers behind a firewall Your network administrator can provide the values PROXYPORT Optional Proxy server port PROXYLOGON Optional Proxy server logon ID PROXYPASSWORD Optional Proxy server logon password In addition to the connection pa
205. out reversal process on PayPal 104 Timeout waiting for processor response Try your transaction again The Payflow gateway sent the transaction to the processor but the processor did not respond in the allotted time This error can result in an uncaptured authorization if the transaction is an authorization or a sale except on the following processors e PayPal Australia Time out reversal logic should reverse the transaction According to PayPal Australia this is a best effort and is not guaranteed e Global Payments Central Citi Bank Singapore Time out reversal logic should reverse the transaction e PayPal The transaction might settle There is no time out reversal process on PayPal 105 Credit error Make sure you have not already credited this transaction or that this transaction ID is for a creditable transaction For example you cannot credit an authorization 106 Host not available The Payflow transaction server was unable to communicate with the financial host This error is an internal failure and the transaction will not make it to the processor 107 Duplicate suppression time out 108 Void error RESPMSG Make sure the transaction ID entered has not already been voided If not then look at the Transaction Detail screen for this transaction to see if it has settled The Batch field is set to a number greater than zero if the transaction has been settled If the transaction has already settled your only recourse is a
206. parent Redirect 28 Posting To the Hosted Checkout Page 0 e e e 29 Chapter 3 Configuring Hosted Checkout Pages 31 Configuring Hosted Checkout Pages 0000 ee eee eee 31 Configuring Hosted Pages Using PayPal Manager o 31 SOUPS ato a a ty Be in Ga a DE ad 31 CUSIOMIZE oc aa al a da e A A 34 Gateway Developer Guide and Reference 31 July 2012 En Content Using a Secure Token and Dynamically Passing Form Post Variables 36 Silent POS S 2 044 4605 088 a a AA A A 38 Force Silent Post Confirmation o e 38 Data Returned by the Silent Post Features 0 0 39 Chapter 4 Payflow SDK 2 2 ee eee eee ee Owe ee oe we we 0 Preparing the Payflow Gateway Client Application 41 Activating Your Payflow Gateway Account 2 22 22200 42 Host URL Addresses 2 2 0000 pe 42 Chapter 5 Sending a Simple Transaction to the Server 43 About Name Value Pairs a 43 Using Special Characters In Values 0 a 43 Name Value Parameter Syntax Guidelines o 44 Do Not URL Encode Name Value Parameter Data 2 44 Payflow Connection Parameters 2 00000 eee ee eee 44 User Parameter Data 2 000022 eee ee 45 Sale Transaction Example 00 ee 46 Typical Sale
207. payphone 27 Character length and limitations 2 characters 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 0 WINDOWS 95 Character length and limitations 60 alphanumeric and special characters CUSTIP Optional Account holder s IP address Character length and limitations 15 alphanumeric and special characters SHI PTOCOUNTRY Optional Numeric country code of ship to country Example USA 840 Character length and limitations 3 characters SHIPMETHOD Optional Shipping method code The values are e 01 Same day 02 Overnight next day 03 Priority 2 3 days 04 Ground 4 or more days 05 Electronic delivery 06 ZZ Reserved for future use SKU Optional Merchant product SKU Character length and limitations 15 alphanumeric characters 104 31 July 2012 Gateway Developer Guide and Reference Processors Requiring Additional Transaction Parameters A American Express Additional Credit Card Parameters 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 d
208. phanumeric characters 126 31 July 2012 Gateway Developer Guide and Reference Processors Requiring Additional Transaction Parameters A 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 NOTE American Express strongly recommends that aggregators third parties who bill for goods or services rendered by another entity always fill in this field with the URL e mail address or telephone number of the contact responsible for resolving disputes or inquiries Character length and limitations 40 alphanumeric characters WorldPay Additional Credit Card 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 11 alphanumeric characters ADDLAMTTYPEN Optional A 3 digit code indicating the type of the corresponding charge detail where n is a value from 1 5 Character length and limitations 18 alphanumeric characters CATTYPE Optional Type of terminal Character length and limitations numeric characters CONTACTLESS Optional Describes the card input capability It is the value RFD which means the card cont
209. plicate adjustment is detected and the original adjustment was accepted by TeleCheck the duplicate will also be accepted The duplicate transaction will then be filtered out by TeleCheck s back end settlement processes NFTF Guidelines The following guidelines should be followed when adhering to the above NFTF Requirements to electronically process a check payment e Fields marked as Required are required to process an electronic transaction e Not all fields are required by every merchant e Unused fields should be completely omitted from the message e Each field is variable in length justification and fillers are not used e The order of tagged fields from the POS and from the TeleCheck host are not significant e Fields must not have any hard coded data values e The transaction number increments on every attempt Message formats outline fields tags that are required not required or conditional to the Sale Status and Adjustment Inquiry packets Message Types e Merchant Authorization Message and the TeleCheck Authorization Response Message e Merchant Delayed Capture Message and the TeleCheck Delayed Capture Response Message Gateway Developer Guide and Reference 31 July 2012 131 132 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
210. plicate orders processed within seconds of each other Use ORDERID with Request ID to prevent duplicates as a result of processing or communication errors Character length and limitations alphanumeric characters Optional Account holder s first name Limitations 30 alphanumeric characters Optional but recommended Account holder s last name Limitations 30 alphanumeric characters Optional The cardholder s street address number and street name The address verification service verifies the STREET address Limitations 150 alphanumeric characters Optional Bill to city Limitations 45 character string Optional Bill to state Limitations 45 character string Limitations 10 character string Optional Account holder s 5 to 9 digit zip postal code Limitations 9 characters maximum Do not use spaces dashes or non numeric characters Optional Bill to country Limitations 3 character country code Optional Ship to first name Limitations 30 character string Optional Ship to last name Limitations 30 character string Optional Ship to street address Limitations 150 character string Optional Ship to city Limitations 45 character string Optional Ship to state Limitations 45 character string Limitations 10 character string Optional Ship to postal code Limitations 10 character string Gateway Developer Guide and Reference 31 July 2012 53 Submitting Credit Car
211. post Force Silent Post Confirmation The Force Silent Post Confirmation feature ensures that no transactions proceed unless your Web site receives the Silent Post data If you enable this feature Payflow Gateway sends the Silent Post data and waits for a 200 OK from your server indicating the server s receipt of the data If Payflow Gateway does not receive the success response then the transaction is voided and the customer sees a communication error message In this case PayPal Manager displays both a transaction that succeeded and a transaction that was voided To select this feature be 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 38 31 July 2012 Gateway Developer Guide and Reference Configuring Hosted Checkout Pages Silent Posts Data Returned by the Silent Post Features The Silent Post feature returns either a short list of data or all of the data that was submitted for the transaction You can control what is returned to you via the optional ECHODATA parameter e To return a short list of values generated by PayPal and the issuing bank which provide status information on the submitted transaction set the optional ECHODATA parameter to False This will return the same values that you receive in a typical transaction response See Transaction Responses for more info e To return both the short list of generated values plus all of t
212. r 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 Level 3 transactions that do not include the required Level 2 values are rejected IMPORTANT The values required for Level 3 status vary by bank so contact your bank for details TSYS Acquiring Solutions Level 2 Visa Parameters for Level 3 Line Item Transactions Parameter Description PONUM Required Purchase identifier The transaction ID is sent if no value is provided 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 Character length and limitations numeric LOCALTAXAMT Optional Local tax Character length and limitations 12 numeric characters 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 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions TSYS Acquiring Solutions Purchasing Card Transaction Processing Parameter Description INVNUM Required Purchase order number customer refer
213. r Use an AMOUNT other than those listed in this column Gateway Developer Guide and Reference 31 July 2012 85 Testing Transactions PayPal Processor 86 31 July 2012 Gateway Developer Guide and Reference Transaction Responses When a transaction finishes the Payflow server returns a response string made up of name value pairs The following is an example response string RESULT 0 amp PNREF EFHP0D426A53 amp RESPMSG APPROVED amp AUTHCODE 2 5TEST amp AVSADDR Y amp AVSZ IP N amp 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 Character length and limitations 12 alphanumeric characters PPREF Unique transaction ID of the payment Character length and limitations 17 character string RESULT The outcome of the attempted transaction RESULT 0 means the transaction was approved 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 For more information on corrective actions see the PayPal developer documentation on the PayPal developer website Any other value for RESULT indicates a decline or error Character length and limitations variable length numeric
214. racters FREIGHTAMT Required Unique VAT inv reference number Can be part of the registration data or passed with each transaction Character length and limitations 9 alphanumeric characters CUSTVATREGNUM Required Customer VAT Registration Number Character length and limitations 13 alphanumeric characters VATTAXAMT Optional VAT tax amount freight shipping Character length and limitations 12 numeric characters VATTAXPERCENT Optional VAT tax rate freight shipping Character length and limitations 4 numeric characters Gateway Developer Guide and Reference 31 July 2012 191 Submitting Purchasing Card Level 2 and Level 3 Transactions TSYS Acquiring Solutions Purchasing Card Transaction Processing TSYS Acquiring Solutions Level 3 Visa Line Item Detail Records NOTE 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_OTYn and unit price L_COSTn fields Parameter Description L_COMMCODEN Optional Item commodity code Character length and limitations 12 alphanumeric characters L_DESCn Required Item descriptor Character length and limitations 35 alphanumeric characters L_UPCn Optional Product code Character length and limitations 12 alphanumeric characters L_OTYn Required Item quantity Character length and limitations 12 numeric characters L_UOMn Required Unit of measure code Character length and limit
215. rameters o 181 SecureNet Level 3 MasterCard Parameters o 182 SecureNet Acquiring Solutions Level 3 Visa Parameters 184 TSYS Acquiring Solutions Purchasing Card Transaction Processing 187 TSYS Acquiring Solutions Level 2 Parameters 2 187 TSYS Acquiring Solutions Level 3 MasterCard Parameters 188 TSYS Acquiring Solutions Level 3 Visa Parameters 190 Vantiv Purchasing Card Transaction Processing o e eee 193 Vantiv Purchasing Parameters 0000 eee eee 193 Vantiv Purchasing Card Line Item Parameters 193 WorldPay Purchasing Cards Transaction Processing 194 WorldPay Level 2 Parameters 00002 eee eee eee 194 WorldPay Level 3 Parameters 000002 eee eee eee 196 Gateway Developer Guide and Reference 31 July 2012 9 10 Content Chapter D VERBOSITY Viewing Processor Specific Transaction Results 199 Chapter E ISO Country Codes Chapter F Codes Used by FDMS South Only MasterCard Country Codes for FDMS South Only Visa Country Codes 2 Units of Measure 2 2 2 0 Chapter G PayPal Acquirer Chapter H Additional Processor Information Moneris Solutions 2 004 Chapter Payflow Link Migration Migrating from a legacy Payflow Link Integratio
216. rameters in the table you must pass the NVP parameters that specify the payment information for the transaction User Parameter Data All Gateway transactions require the user parameters described as follows User paramters Parameter Description USER Required If you set up one or more additional users on the account this value is the ID of the user authorized to process transactions If however you have not set up additional users on the account USER has the same value as VENDOR Limitations 64 alphanumeric case sensitive characters VENDOR Required Your merchant login ID that you created when you registered for the account Limitations 64 alphanumeric case sensitive characters PARTNER Required The ID provided to you by the authorized PayPal Reseller who registered you for the Gateway gateway If you purchased your account directly from PayPal use PayPal Limitations 64 alphanumeric case sensitive characters PWD Required The password that you defined while registering for the account Limitations 6 to 32 alphanumeric case sensitive characters Gateway Developer Guide and Reference 31 July 2012 45 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 To perform a sale transaction involving a
217. rameters such as SHIPTOCITY or SHIPTOSTATE you must pass in the complete set that is SHIPTOSTREET SHIPTOCITY SHIPTOSTATE SHIPTOCOUNTRY and SHIPTOZIP Limitations 30 character string SHIPTOCITY Optional Ship to city address NOTE 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 SHTPTOSTREET SHIPTOCITY SHIPTOSTATE SHIPTOCOUNTRY and SHIPTOZIP Limitations 40 character string Gateway Developer Guide and Reference 31 July 2012 119 O A Processors Requiring Additional Transaction Parameters SecureNet Additional Credit Card Parameters for American Express Parameter Description SHIPTOSTATE Optional Ship to state or province address NOTE Ifyou 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 NOTE Ifyou 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 Two alpha characters SHIPTOZIP Optional U S ship to zip code or other country specific postal code NOTE Ifyou pass in any of the ship to address parameters such as SHIPTOCITY or SHIPTOSTATE
218. re rejected IMPORTANT The values required for Level 3 status vary by bank so contact your bank for details Heartland Level 2 MasterCard Parameters Required for Level 3 Transactions Parameter Description PONUM TAXAMT Required Purchase identifier Character length and limitations 25 alphanumeric characters 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 LOCALTAXAMT Optional Local tax Character length and limitations 12 numeric characters TAXEXEMPT Optional Local tax incl flag Character length and limitations 1 alphanumeric Y or N Gateway Developer G uide and Reference 31 July 2012 161 162 Submitting Purchasing Card Level 2 and Level 3 Transactions Heartland Purchasing Card Transaction Processing Parameter Description NATIONALTAXAMT Optional National tax amount You may omit this parameter if there is no such tax Character length and limitations 12 numeric characters INVNUM Required Purchase Order number or customer reference ID The PNREF value is sent if no value is provided Character length and limitations 9 alphanumeric characters Heartland Level 3 MasterCard Extended Data The parameters listed in the table below apply to L
219. re the transaction took place If you are a third party biller bill for services or goods rendered by another entity you must enter the postal code that corresponds to the seller s location Character length and limitations 15 alphanumeric characters MERCHANTCOUNTRYCODE Optional Country code of the location where the transaction took place Character length and limitations 3 alphanumeric characters MERCHANTLOCATIONID Optional Merchant assigned store or location number or name that uniquely identifies where the transaction took place Character length and limitations 15 alphanumeric characters MERCHANTID Required American Express assigned service establishment number used to identify and facilitate payments to merchants Character length and limitations 15 alphanumeric characters 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 NOTE American Express strongly recommends that aggregators third parties who bill for goods or services rendered by another entity always fill in this field with the URL e mail address or telephone number of the contact responsible for resolving disputes or inquiries Character length and limitations 40 alphanumeric characters 106 31 July 2012 Gateway Developer Gu
220. rency value simultaneously 102 31 July 2012 Gateway Developer Guide and Reference Processors Requiring Additional Transaction Parameters Additional parameters are those required by individual processors beyond the core parameters Parameters are organized alphabetically by processor e American Express Additional Credit Card Parameters on page 103 e Elavon Additional Credit Card Parameters on page 109 e First Data Merchant Services Nashville Additional Credit Card Parameters on page 110 e First Data Merchant Services North Additional Credit Card Parameters on page 110 e Heartland Additional Credit Card Parameters on page 111 e Litle Additional Credit Card Parameters on page 111 e Merchant e Solutions Additional Credit Card Parameters on page 113 e Paymentech Salem New Hampshire Additional Credit Card Parameters for American Express on page 113 e PayPal Credit Card Transaction Request Parameters on page 115 e SecureNet Additional Credit Card Parameters for American Express on page 120 e Vantiv Additional Credit Card Parameters on page 125 e WorldPay Additional Credit Card Parameters on page 127 American Express Additional Credit Card Parameters In addition to the core credit card parameters American Express accepts the parameters described below to meet AMEX reporting and statement requirements PayPal recommends that you include these paramete
221. response Example Account Verification String The following is an example of account verification 54 31 July 2012 Gateway Developer Guide and Reference Submitting Credit Card Transactions Submitting Authorization Delayed Capture Transactions TRXTYPE A amp TENDER C amp PARTNER PayPal amp USER SuperUser amp PWD SuperUserPasswo rd amp AMT 0 0OOSACCT 378282246310005 amp EXPDATE 1215 amp INVNUM PONUM1 amp VERBOSIT Y HIGH amp BILLTOZTP 95031 This is the response RESULT 0 amp PNREF VFHAOFF8F27D amp RESPMSG Veri fied amp AUTHCODE 66 7 PNI amp AVSADDR X amp AVSZIP X amp HOSTCODE A amp PROCAVS U amp SAMEXID 123456789012345 amp AMEXPOSDATA 123456789012 amp TRANSTIME 2011 01 11 18 42 01 amp AMT 0 OO amp ACCT 0005 amp EXPDATE 1215 amp CARDTYPE 3 amp IAVS X Submitting Authorization Delayed Capture Transactions An authorization TRXTYPE A transaction places a hold on the cardholder s open to buy limit lowering the cardholder s limit by the amount of the transaction It does not transfer funds Perform a delayed capture TRXTYPE D transaction after an authorization to capture the original authorization amount PayPal schedules the delayed capture for settlement during the next settlement period Because Visa and MasterCard regulations prohibit capturing credit card payments until the buyer receives the product or service most processing networks implement an authorization followed by a delayed capture NOTE PayPal
222. retry request 31 July 2012 Gateway Developer Guide and Reference Transaction Responses RESULT Values and RESPMSG Text RESULT RESPMSG and Explanation 150 Issuing bank timed out FDRA reported a timeout between their system and the bank This error will be reversed by time out reversal According to PayPal Australia this 1s a best effort and is not guaranteed 151 Issuing bank unavailable 200 Reauth error 201 Order error 600 Cybercash Batch Error 601 Cybercash Query Error 1000 Generic host error This is a generic message returned by your credit card processor The RESPMSG will contain more information describing the error 1001 Buyer Authentication Service unavailable 1002 Buyer Authentication Service Transaction timeout 1003 Buyer Authentication Service Invalid client version 1004 Buyer Authentication Service Invalid timeout value 1011 Buyer Authentication Service unavailable 1012 Buyer Authentication Service unavailable 1013 Buyer Authentication Service unavailable 1014 Buyer Authentication Service Merchant is not enrolled for Buyer Authentication Service 3 D Secure 1016 Buyer Authentication Service 3 D Secure error response received Instead of receiving a PARes response to a Validate Authentication transaction an error response was received 1017 Buyer Authentication Service 3 D Secure error response is invalid An error response is received and the response is not well formed
223. ric characters Optional Country code of the location where the transaction took place Character length and limitations 3 alphanumeric characters Optional Merchant assigned store or location number or name that uniquely identifies where the transaction took place Character length and limitations 15 alphanumeric characters Required American Express assigned service establishment number used to identify and facilitate payments to merchants Character length and limitations 15 alphanumeric characters 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 NOTE American Express strongly recommends that aggregators third parties who bill for goods or services rendered by another entity always fill in this field with the URL e mail address or telephone number of the contact responsible for resolving disputes or inquiries Character length and limitations 40 alphanumeric characters 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions American Express Purchasing Card Transaction Processing 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 amoun
224. rring 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 Using the Gateway to define and manage recurring transactions programmatically is described in Payflow Pro Recurring Billing Service User s Guide You can manage Recurring Billing tasks in PayPal Manager 26 31 July 2012 Gateway Developer Guide and Reference Secure Token This section describes the secure token Secure Token on page 27 Integrating the Secure Token With the Hosted Checkout Pages on page 27 Integrating the Secure Token Without the Hosted Checkout Pages Transparent Redirect on page 28 Posting To the Hosted Checkout Page on page 29 About the Secure Token Use a secure token to send non credit card transaction data to the Gateway server for safer storage The secure token prevents anyone from intercepting or manipulating the data You must use a secure token if you use hosted checkout pages The token is good for a one time transaction and is valid for 30 minutes NOTE PayPal Payments Pro and Payflow Pro merchants who do not use a secure token must host their own payment pages When hosting your own pages you are responsible for meeting PCI requirements by handling data securely PayPal Payme
225. rs Pass a bad XML document XMLPay users only Use the AMOUNT 1030 Only applies to Global Payments East and Global Payments Central processors Use the AMOUNT 1050 Only applies to Paymentech Use the AMOUNT 1099 Only applies to Global Payments East Use the AMOUNT 1100 Only applies to Global Payments East and Central Set timeout value to 1 Use the AMOUNT 1103 Use the AMOUNT 1104 Attempt to credit an authorization Attempt to void a captured authorization Capture an authorization transaction twice or attempt to capture a transaction that is not an authorization transaction You cannot generate this RESULT value by submitting an amount of 1112 but must submit a value for Address Verification Service that will fail in production this error occurs only if your account is configured by PayPal customer service to use the AVS Deny feature Applies to ACH transactions only 80 31 July 2012 Gateway Developer Guide and Reference Testing Transactions Processors Other Than PayPal RESULT value Definition How to test using Payflow Gateway 114 CVV2 Mismatch Use the AMOUNT 1114 Only applies to TSYS Acquiring Solutions Merchant e Solutions and Global Payments East and Global Payments Central processors 1000 Generic Host Processor Error Use the AMOUNT 2000 Does not apply to Elavon formerly Nova American Express or Global Payments East processors Testing Address Verification Service
226. rs if you would like to impact what appears on AMEX statements and reports NOTE The PayPal processor does not support SWIPE card present transactions Retail Transaction Advice Addendum for SWIPE transactions Field Description L_DESCn Optional Description of this line item n is a line item number from 1 to 6 Character length and limitations 19 alphanumeric characters Gateway Developer Guide and Reference 31 July 2012 103 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 12 numeric characters L_OTYn Optional Quantity of this line item n is a line item number from 1 to 6 Character length and limitations 3 numeric characters 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 Character length and limitations 10 characters PHONETYPE Optional Telephone company provided ANI information identifier digits indicating the telephone call type Examples cellular 61 63
227. s Optional Generic data the merchant can pass to the WorldPay processor Character length and limitations 95 alphanumeric characters Optional Purchase order number Character length and limitations 95 alphanumeric characters Optional Customer number Character length and limitations 95 alphanumeric characters Optional Discount amount on total sale Character length and limitations 10 currency characters Optional Account holder s driver license name Character length and limitations 95characters Optional Account holder s driver license number Character length and limitations 95 alphanumeric characters Optional Account holder s date of birth in the format MMDDYYYY For example July 28 2011 is represented as 07282011 Character length and limitations 8 characters Optional Sometimes called import tax Character length and limitations 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 10 currency characters Optional Total freight amount Character length and limitations 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 10 currency characters Optional Merchant invoice number for the transaction Character length and limitations 95 alphanumeric characters Optional Description of product Character length and limita
228. s on page 71 e Submitting Void Transactions on page 72 e Using Address Verification Service on page 74 e Using Card Security Code on page 75 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 Gateway Developer Guide and Reference 31 July 2012 47 48 Submitting Credit Card Transactions About Credit Card Processing Processing Services and Paymentech To accept live credit cards provide details about your account to PayPal during the Go Live part of enrollment NOTE An Internet Merchant Account is different type of merchant account It has additional risks associated with card not present e commerce transactions It is different from a merchant account used for face to face card present in person retail transactions Obtain an Internet Merchant Account even if you already accept credit cards at your location To apply for an Internet Merchant Account contact your merchant acquiring bank About Credit Card Processing Credit card processing occurs in 2 steps a real time authorization and a capture settlement of the funds that the cardholder s i
229. s amp Payflow SDK API Full Access Service Summary Serice Status Mode PayPal Payments Pro Live Hosted Checkout Pages Live _ Payflow SOK API Full Access Live 31 July 2012 Gateway Developer Guide and Reference Revision History Revision History Revision History for the Gateway Developer Guide and Reference Date Description 31 July 2012 Added a list of Setup Params and Customize Params These parameters override PayPal Manager settings for Hosted Pages Briefly explained the differences between Submitting Credit Transactions and Submitting Void Transactions Updated the parameters in the Payflow Link legacy parameters and the equivalent Payflow parameters table 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 16 July 2012 Updated required value for BILLTOCITY BILLTOSTATE BILLTOCOUNTRY in PayPal Credit Card Transaction Request Parameters table June 2012 Who Should Use This Document section added to the Preface Integrating the Secure Token Without the Hosted Checkout Pages Transparent Redirect section corrected value of SILENTTRAN to True Silent Posts section added to Hosted Checkout Pages chapter ISO Country Codes removed the legacy paramater CORPCOUNTRY May 2012 Added new sections to the Tes
230. s closely as possible Required Parameters When Using the PNREF To perform an inquiry pass the following parameter Gateway Developer Guide and Reference 31 July 2012 61 62 Submitting Credit Card Transactions Submitting Inquiry Transactions Parameter Description ORIGID Required by some transaction types 1D of the original transaction referenced The PNREF parameter returns this ID and it appears as the Transaction ID in PayPal Manager reports Limitations 12 case sensitive alphanumeric characters Set ORIGID to the PNREF Transaction ID in PayPal Manager reports value returned in the original transaction Inquiry Transaction Parameter String Using the PNREF This is an example inquiry transaction parameter string using the ORIGID parameter set to the PNREF value TRXTYPE 1 amp TENDER C amp PARTNER PayPal amp VENDOR SuperMerchant amp USER SuperMerchant amp P WD x1y2z3 amp SORIGID VPNE125643 95 amp VERBOSITY HIGH Required Parameters When Using the CUSTREF To perform an inquiry transaction when using the CUSTREF pass the CUSTREF parameter Parameter Description CUSTREF Required Merchant defined identifier for reporting and auditing purposes For example you can set CUSTREF to the invoice number You can use CUSTREF when performing inquiry transactions To make sure that you can always access the correct transaction when performing an inquiry provide a unique CUSTREF when submitting any transac
231. s a personal check default If CHKTYPE P you are required to pass a value for either DL or SS as an identifier e C The check is a company check If CHKTYPE C you are required to pass the Federal Tax ID for SS Character length and limitations 1 alphanumeric character Account holder s IP address You are required to pass this value when AUTHTYPE I Character length and limitations 15 alphanumeric characters Required Driver s license number If CHKTYPE P you are required to pass a value for either DL or SS as an identifier The format of the driver s license is XXnnnnnnnn where e XX State code e nnnnnnnn Driver s license number Character length and limitations 33 alphanumeric characters Account holder s e mail address You are required to pass this value when AUTHTYPE 1 Character length and limitations 100 alphanumeric characters Optional Check invoice number Character length and limitations 9 alphanumeric characters Required Magnetic ink check reader The value is the entire line of numbers at the bottom of all checks It includes the transit number account number and check number Character length and limitations 65 numeric characters 134 31 July 2012 Gateway Developer Guide and Reference TeleCheck Electronic Check Processing Boo Testing TeleCheck Transactions Field Description ss Account holder s social security number You are required to pass a value for SS when a val
232. s do not screen reference transactions NOTE When the Gateway looks up the reference transaction it does not alter in any way the transaction referenced or any other transaction in the database A reference transaction is a read only operation Payflow populates with data and acts upon the new transaction only It does not maintain any linkage between the reference transaction and the new transaction You can also initiate reference transactions from PayPal Manager See PayPal Manager online help for details 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 e Authorization To capture the funds for an approved authorization transaction be sure to perform a delayed capture transaction nof a reference transaction e Credit 31 July 2012 Gateway Developer Guide and Reference Submitting Credit Card Transactions CAE Submitting Reference Transactions Tokenization e Delayed capture e Sale e Voice authorization Payflow does not copy the voice authorization code to the new transaction e Void Fields Copied From Reference Transactions The following fields are copied from the reference transaction into the new sale or authorization transaction if they exist in the original transaction If you provide a value for any of these parameters when submitting the new transaction then the new value is used
233. s gift cards allowing the customer to spend any amount up to the balance remaining on the card A card must be active and not compromised for BALAMT to return the card balance If the card is used to purchase merchandise exceeding the card balance American Express declines the transaction and returns the card balance in BALAMT NOTE Not all processors support BALAMT when a transaction involves a stored value card American Express Stored Value Card Example The following authorization request is for a purchase of 123 00 TRXTY PE A amp TENDER C amp PWD x1y2 23 amp PARTNER PayPal amp VENDOR SuperMerchant amp USER Supe rMerchant amp ACCT 5555555555554444 amp EXPDATE 1215 amp AMT 123 OO amp SBILLTOSTREET 5199 M APLE amp BILLTOZIP 94588 Because the response returns a BALAMT of 99 00 the authorization is declined RESULT 12 amp PNREF VXYZ01234567 amp RESPMSG DECLINED amp BALANCE 99 OO amp AVSADDR Y amp AVSZI P N PNREF The PNREF is a unique transaction identification number issued by PayPal that identifies the transaction for billing reporting and transaction data purposes The PNREF value appears in the Transaction ID column in PayPal Manager reports e The PNREF value is used as the ORIGID value original transaction ID in delayed capture transactions TRXTYPE D credits TRXTYPE C inquiries TRXTYPE 1 and voids TRXTYPE V e The PNREF value is used as the ORIGID value original transaction ID value in reference tran
234. s in the near future As more processors are added this list will be updated accordingly WorldPay Required Balance Inquiry Parameters To perform a balance inquiry on a pre paid card pass the following parameters 56 31 July 2012 Gateway Developer Guide and Reference Submitting Credit Card Transactions CEN Submitting Card Present SWIPE Transactions Parameter Description TRXTYPE Required Set to B Limitations 1 alphanumeric character EXPDATE Required Expiration date of the pre paid card in the format MMY Y For example 1215 represents December 2015 VERBOSITY Required Set to HIGH to obtain information about a balance inquriy in the response Example Balance Inquiry Transaction String The following is an example of a balance inquiry transaction TRXTYPE B amp TENDER C amp PARTNER PayPal amp VENDOR SuperMerchant amp USER SuperUser amp PWD S uperUserPassword amp ACCT 5555555555554444 amp EXPDATE 1215 amp VERBOSITY HIGH This is the response RESULT 0 amp PNREF ERRV0A0 05933 amp RESPMSG Approved amp AUTHCODE 4 67 PNI amp HOSTCODE 000 amp T RANSTIME 2012 02 16 18 41 25 amp AMT 0 OO amp BALAMT 10 OO amp ACCT 4444 amp EXPDATE 1215 amp CARDTYPE 0 Submitting Card Present SWIPE Transactions The Payflow SDK supports card present transactions face to face purchases NOTE The PayPal processor does not support SWIPE card present transactions Follow these guidelines to take advantage of the
235. sactions for authorization TRXTYPE A and sale TRXTYPE S The PNREF value is a 12 character string of printable characters for example Gateway Developer Guide and Reference 31 July 2012 93 94 Transaction Responses RESULT Values and RESPMSG Text e VADE0B248932 e ACRAF23DB3C4 NOTE 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 The value of RESULT indicates the overall status of the transaction attempt e A value of 0 zero indicates that no errors occurred and the transaction was approved NOTE For account verification transactions RESULT 0 with RESPMSG Verified means that a zero dollar authorization is successful e A value less than 0 indicates that a communication error occurred In this case no transaction is attempted e A value greater than 0 indicates a decline or error except in the case of RESULT 104 See the following table The response message RESPMSG provides a brief description for decline or error results To obtain the raw response code and message returned by the processor set VERBOSITY to HIGH in your request and capture the response values of the HOSTCODE and RESPTEXT param
236. se It provides merchants with a rich set of options to handle payment transactions e About the Gateway Checkout Solutions on page 19 e About the Gateway Transaction Flow on page 21 e About Security on page 22 e Processing Platforms Supporting Card Present Transactions on page 24 e Supported Payment Types on page 25 e Recurring Billing Service on page 26 About the Gateway Checkout Solutions Gateway checkout consists of the following four solutions e Payflow Link e Payflow Pro e PayPal Payments Advanced e PayPal Payments Pro Summary of the Gateway Checkout Solutions Below is a basic comparison of the Gateway checkout solutions e Payflow Link uses hosted checkout pages to send transactions to a supported processor Merchants can use the Payflow SDK APIs to perform all transactions except authorization and sale transactions By using hosted pages with a secure 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 e Payflow Pro can send transactions to a number of different supported processors requirements for which are described in this documentation Merchants select a supported processor and obtain an acquiring bank Typically merchants integrate with and have full access to the Payflow SDK or use HTTPS to send transactions to the processor Using hosted pages is an option e PayP
237. sing Parameter Description L_UOMN Required Unit of measure code Character length and limitations 12 alphanumeric characters L_CcostTn 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 Character length and limitations 4 numeric characters L_DISCOUNTN Optional Discount per line item Character length and limitations 12 numeric characters L_AMTn Optional Line item total Character length and limitations 12 numeric characters Example Merchant e Solutions Level 3 Visa Transaction Parameter String TRXTYPE S amp TENDER C amp PARTNER Partner amp USER User amp PWD Password amp ACCT 411111111111 1111 amp EXPDATE 1215 amp AMT 1 OO amp BILLTOSTREET 5199 JOHNSON amp TAXAMT 1 0O6 amp BILLTOZIP 94588 amp ALTTAXAMT 1 O0O amp CUSTVATREGNUM 11111 amp LOCALTAXAMT 1 OL amp ENATIONALTAXAMT 1 02 amp COMMCODE 22222 amp VATAXAMT 1 03 amp VATAXPERCENT 55 amp TAXEXEMPT N amp DISCOUNT 50 amp FR EIGHTAMT 1 OO amp SDUTYAMT 1 OO amp SHIPTOZIP 33333 amp SHIPFROMZIP 44444 amp SHIPTOCOUNTRY 840 amp ORDERDATE 020725 amp L COMMCODE1 123456789ABC amp L DESC1l Line item 1 descripti on amp L_UPC1 CBA987654321 amp L QTY1 1 amp L UOM1 123456789012 amp L COST1 1 506 L TAXAMT1 1 056L TAXRATE1 12 amp L DISCOUNT1 50 amp L AMT1 1 00 amp L TAXTYPE1 TT1 Paymentech Salem
238. situations you contact the customer service department of your merchant bank and provide the payment information as requested If the bank approves the transaction the bank provides you with a voice authorization code AUTHCODE for the transaction On approval a voice authorization transaction is treated like a sale transaction and is settled with no further action on your part Like sale transactions you can void approved voice authorizations before settlement occurs Required Voice Authorization Transaction Parameters To perform a voice authorization transaction pass the AUTHCODE provided by your merchant bank Parameter Description AUTHCODE Required for voice authorizations Returned only for approved voice authorization transactions AUTHCODE is the approval code received over the phone from the processing network Limitations 6 alphanumeric characters The following is an example Voice Authorization request parameter string 4 TRXTYPE F amp TENDER C amp PARTNER PayPal amp VENDOR SuperMerchant amp USER SuperMerchant amp P WD x1y2z3 amp AUTHCODE AB3 456 amp ACCT 5555555555554444 amp EXPDATE 1215 amp AMT 123 OO amp VER BOSITY HIGH Submitting Void Transactions The void transaction TRXTYPE V prevents authorizations from being captured and delayed captures sales and voice authorizations from being settled You cannot void another void transaction or any inquiry type transactions The void transacti
239. ssuing bank authorizes You perform these 2 steps either as a single transaction or as 2 transactions depending on your business model For an authorization the server sends the transaction information to a credit card processor The processor routes the transaction through the financial networks to the cardholder s issuing bank The issuing bank checks whether the card is valid It evaluates whether sufficient credit exists checks values such as address verification service and card security codes and returns a response such as Approved Declined or Referral You receive the response a few seconds after you submit the transaction to the server If the bank approves an authorization it temporarily reserves the credit for the amount of the transaction to prepare to capture fulfill the transaction The hold on funds typically lasts for about a 3 7 days Capturing a transaction actually transfers the funds to your bank At least once a day PayPal gathers all transactions flagged for settlement and sends them in a batch file to the processor The processor then charges the issuing bank and transfers the funds to your bank It typically takes a few days before the money is available in your account depending on your bank NOTE For card not present transactions such as online transactions merchants are required to provide a service or ship goods before or on the same day the transaction is captured Credit Card Features The Payflow S
240. t 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 12 numeric characters ADDLAMTTYPEN Optional A 3 digit code indicating the type of the corresponding charge detail where n is a value from 1 5 Character length and limitations 3 numeric characters Example American Express Level 2 Transaction Parameter String TRXTY PE S amp ACCT 3 72449635311003 amp AMT 20 O6 amp BILLTOCITY Mountain View amp DESCl des C1 amp DESC2 desc2 amp DESC3 desc3 amp DESC4 FRT10 OOS EXPDATE 1215 amp BILLTOFIRSTNAME Card holder first name amp BILLTOLASTNAME Cardholder last name amp PARTNER PayPal amp PONUM 12345 amp PWD pwd amp SHIPTOZIP 94045 amp BILLTOSTATE CA amp BILLTOSTREET 123 Main St amp TEND ER C amp USER user amp BILLTOZIP 123451234 American Express Level 3 Parameters American Express supports Level 3 transaction data PayPal provides the Merchant Registration data values Supplier Name Supplier City Supplier State Supplier Postal code Merchant No and Federal Tax ID The merchant provides the values listed in the the following table American Express Level 3 Parameters Field Description INVNUM Optional Purchase order number Character length and limitations 1 to 9 alphanumeric characters AUTHCODE Required Authorization code It is passed transparently for delayed capture Use
241. t than the other test numbers it is the correct and functional number Result Values Based On Amount Submitted You can use the amount of the transaction to generate a particular result value The following table lists the general guidelines for specifying amounts to submit in requests Amount Result 0 1000 1001 2000 2001 RESULT value 0 Approved Certain amounts in this range return specific PayPal results You can generate the results by adding 1000 to that RESULT value For example for RESULT value 13 Referral submit the amount 1013 If the amount is in this range but does not correspond to a result supported by this testing mechanism Payflow returns RESULT value 12 Declined RESULT value 12 Declined Result Values Based On Amount Submitted and Processor This table lists the RESULT values that you can generate using the amount of the transaction To generate a specific value submit an amount of 1000 plus the RESULT value number for example submit an amount of 1013 for a RESULT value of 13 Processing Platform RESULT Values Available for Testing American Express Brighton Elavon 0 12 13 104 1000 0 12 13 104 78 31 July 2012 Gateway Developer Guide and Reference 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 Dat
242. t to the cent 42 00 not 42 Do not include comma separators 1234 56 not 1 234 56 Character length and limitations 12 numeric characters Optional Description of this line item if not provided DESC1 if present is used Character length and limitations 140 alphanumeric characters 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions American Express Purchasing Card Transaction Processing Field Description L AMT1 Optional Charge for this line item Must include a decimal and be exact to the cent 42 00 not 42 and exclude comma separators 1234 56 not 1 234 56 Character length and limitations 12 numeric characters L OTY1 Optional Quantity of this line item Character length and limitations 3 numeric characters L_DESC2 Optional Description of this line item if not provided DESC2 if present is used Character length and limitations 40 alphanumeric characters L AMT2 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 QTY2 Optional Quantity of this line item Character length and limitations 3 numeric characters L_DESC3 Optional Description of this line item if not provided DESC3 if present is used Character length and limitations 40 alphanumeric characters L_AMT3 Optiona
243. 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 Character length and limitations numeric Example Global Payments East Level 2 Visa or MasterCard Transaction Parameter String TRXTYPE S amp ACCT 5105105105105100 amp AMT 20 10 amp BILLTOCITY Mountain View amp COMMENT1 L2 Testing amp EXPDATE 1215 amp BILLTOFIRSTNAME Cardholder FirstName amp BILLTOLASTNAM E Cardholder LastName amp PARTNER PayPal amp PWD pwd amp BILLTOSTATE CA amp BILLTOSTREET 12 3 Main St amp TENDER C amp USER user amp BILLTOZIP 94043 amp CUSTCODE 123456 amp TAXAMT 1 34 Global Payments Central MAPP supports Level 2 for MasterCard and Visa Sale Credit and Delayed Capture transactions Heartland Purchasing Card Transaction Processing Heartland Level 2 Parameters Heartland supports MasterCard and Visa for Level 2 processing Heartland indicates in the authorization response whether the credit card in the transaction is a commercial card Based on the commercial card indicator Payflow will format the Level 2 information in the settlement request Heartland Level 2 Transaction Data To get the discount rate pass the Level 2 values marked Required in the following table Parameter Description PONUM Required Customer reference ID Character length and limita
244. teway Transactions For details on how to format a Payflow transaction see the examples and the supporting documentation provided with your SDK 46 31 July 2012 Gateway Developer Guide and Reference 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 e Obtaining an Internet Merchant Account on page 47 e About Credit Card Processing on page 48 e Credit Card Features on page 48 e Planning Your Gateway Integration on page 49 e Core Credit Card Parameters on page 51 e Submitting Account Verifications on page 54 e Submitting Authorization Delayed Capture Transactions on page 55 e Submitting Balance Inquiry Transactions on page 56 e Submitting Card Present SWIPE Transactions on page 57 e Submitting Credit Transactions on page 59 e Submitting Inquiry Transactions on page 61 e Submitting Partial Authorizations on page 64 e Submitting Purchasing Card Transactions on page 65 e Submitting Reference Transactions Tokenization on page 66 e Submitting Sale Transactions on page 69 e Submitting Soft Merchant Information on page 70 e Submitting Voice Authorization Transaction
245. th the processor American Express processor only Character length and limitations alpha character Y N X or no response Verifies whether the BILLTOPHONENUM value sent is what is on file with the processor American Express processor only Character length and limitations alpha character Y N X or no response Additional processor related messages Time of the transaction The following is an example response in the format returned TRANSTIME 2010 08 11 22 53 18 Character length and limitations See example Is returned with one of the following values e DUPLICATE 2 ORDERID has already been submitted in a previous request with the same ORDERID e DUPLICATE 1 The request ID has already been submitted for a previous request e DUPLICATE 1 The Gateway database is not available PayPal cannot determine whether this is a duplicate order or request The date a transaction will settle This parameter is returned in the response for inquiry transactions only TRXTYPE 1 Address Verification Service Responses From PayPal The following table compares the detailed response the PayPal processor returns for address verification to the normalized response value Y N or X that AVSADDR and AVSZIP return To obtain the PayPal processor value set the VERBOSITY parameter to HIGH The processor value is returned in the PROCAVS response parameter 90 31 July 2012 Gateway Developer Guide and Reference Transac
246. the first 66 worth of product you use a normal delayed capture transaction to collect the 66 Set ORIGID to the value of PNREF in the original authorization as in this transaction request TRXTYPE D8TENDER C8PWD x1y2Z38PARTNER PayPal amp VENDOR SuperMerchant amp USER Supe rMerchant SORIGID VXYZ01234567 SAMT 66 00 The following is the response RESULT 0 amp PNREF VXYZ0123456 8 SAUTHCODE 2 5TEST amp AVSADDR Y amp AVSZIP N 3 Submit a new sale transaction or an authorization and delayed capture transaction of 34 for the rest of the shipment When you ship the remainder of the product you can collect the remaining 34 in a sale transaction that uses the initial authorization as a reference transaction This is a sale transaction because Payflow allows only one delayed capture transaction per authorization The following is a sale transaction request TRXTYPE S amp TENDER C amp PWD x1y2 z3 amp PARTNER PayPal amp VENDOR SuperMerchant amp USER Supe rMerchant SORIGID VXYZ01234567 SAMT 34 00 The following is the response RESULT 0 amp PNREF VXYZ0123456 9SAUTHCODE 2 5 TEST amp AVSADDR Y amp AVSZIP N Data Upload Storing Credit Card Data on the Gateway Server To facilitate creating reference transactions while assisting you with PCI compliance PayPal allows you to upload credit card data by submitting an upload transaction TRXTYPE L At minimum you must pass values for the following parameters e TRXTYPE e TENDER e AC
247. ther to store information in your local database or use PayPal Manager reports to manage the data You may want to store shipping information in your system or you may prefer to send the information to PayPal with the transaction and report on it later NOTE Consider whether and how to use COMMENT1 and COMMENT2 to help tie reports to your orders customers or to report on other information about the transaction e Ifor how you want to integrate with other systems such as order fulfillment Customer Service and so on You may want to integrate your systems directly for capturing funds issuing refunds credits and so on Alternatively you may prefer to perform these steps manually using PayPal Manager Either way PayPal recommends that you monitor transaction activity using PayPal Manager e Whether to discuss with your internet Merchant Acquirer practices that help you to obtain the most advantageous rates Complying With E commerce Indicator Some processors support a software flag called E commerce Indicator ECI that indicates that the associated transaction is an internet transaction The Payflow SDK complies with ECI basic requirements for all supported processors If you use Buyer Authentication the ECI values reflect the authentication status Handling Credit Card Type Information The Payflow SDK does not check the credit card types that you are accepting Ifa customer uses a card type you do not accept the SDK responds with RE
248. tial Authorizations A partial authorization is a partial approval of an authorization TRXTYPE A transaction A partial authorization approves a transaction when the balance available is less than the amount of the transaction The transaction response returns the amount of the original transaction and the amount approved When To Use Partial Authorizations Use partial authorizations to reduce the number of declines resulting from buyers spending more than their balance on prepaid cards Say for example that you sell sportswear on your website Joe purchases a pair of running shoes in the amount of 100 00 At checkout Joe uses a giftcard with a balance of 80 00 to pay You request partial authorization of 100 00 The transaction response returns the original amount of 100 00 and the approved amount of 80 00 You can take either of the following actions e Accept the 80 00 and ask the buyer to provide an alternate payment for the additional 20 00 e Reject the partial authorization and submit to the card issuer an authorization reversal Void for 80 00 Required Partial Authorization Parameters To perform a partial authorization pass the same parameters that you would for an authorization TRXTYPE A ACCT AMT and EXPDATE In addition pass the following parameters Parameter Description PARTIALAUTH Required Set to Y to submit a partial authorization Limitations 1 alphanumeric character VERBOSITY Required
249. ting Transactions chapter Testing Address Verification ServiceTesting Card Security Code Added PayPal Acquirer chapter Contains links to PayPal API Ref country and currency codes Gateway Developer Guide and Reference 31 July 2012 15 Preface Revision History Date Description May 2012 cont April 2012 January 2012 Document maintenance Added cross references and external links reorganized content removed no longer applicable content Added new transaction type Balance Inquiry TRXTYPE B can be used to obtain the balance of a pre paid card 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 Changed Litle parameters from STREET2 STREET3 to BILLTOSTREET2 BILLTOSTREET3 Corrected description of MERCHSVC parameter for FDMS North Heartland Litle Merchant e Solutions Paymentech Salem Updated examples and removed legacy parameters to include FIRSTNAME LASTNAME STREET CITY STATE Z1P COUNTRY Updated processor and entity names Vantiv previously known as Fifth Third Processing Solutions PayPal Australia previously known as First Data Austral
250. tion including retries Limitations 12 alphanumeric characters 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 If you do not specify a STARTTIME or ENDTIME the system searches the last 30 days Limitations 14 numeric characters in the format yyyymmddhhmmss 31 July 2012 Gateway Developer Guide and Reference Submitting Credit Card Transactions ET Submitting Inquiry Transactions Parameter Description ENDTIME Optional For inquiry transactions when using CUSTREF to specify the transaction ENDTIME specifies the end of the time period during which the transaction specified by the CUSTREF occurred Limitations 14 numeric characters NOTE If there are multiple transactions with a particular CUSTREF value inquiry returns the last transaction only with the specified CUSTREF To make sure that you can always access the correct transaction use a unique CUSTREF when submitting any transaction including retries Inquiry Transaction Parameter String Using the CUSTREF This is an example inquiry parameter string using the CUSTREF TRXTYPE 1 amp TENDER C amp PARTN
251. tion Responses c Address Verification Service Responses From PayPal PayPal processor Address Verification Service code Meaning AVSADDR AVSZIP A Address Y N B International A Y N C International N N N D International X Y Y E Not allowed for MOTO Internet Phone X X transactions F UK specific X Y Y 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 Zip N Y X Exact Match Y Y Y Yes Y Y Z Zip N Y All other X X The following is an example Authorization request string that sets VERBOSITY to HIGH Payflow returns the PROCAVS value in the response TRXTYPE A amp BILLTOSTREET 123 Main St amp BILLTOZIP 00382 amp TENDER C amp PARTNER PayPal amp USER SuperMerchant amp PWD SuperUserPassword amp AMT 1 00 amp ACCT 4111111111111111 amp EXP DATE 1215 amp INVNUM PONUM1 amp VERBOSITY HIGH The PROCAVS value is returned in the response RESULT 0 amp PNREF VFHAOFF94691 amp RESPMSG Approved amp AUTHCODE 245 PNI amp AVSADDR Y amp AVSZ IP Y amp HOSTCODE A amp PROCAVS Y amp VISACARDLEVEL 12 amp TRANSTIME 2011 01 12 13 54 35 amp AMT 1 OOSACCT 1111 amp EXPDATE 1215 amp CARDTYPE 0 amp IAVS N Gateway Developer Guide and Reference 31 July 2012 91 E Transaction Responses Card Security Code Results Card Security Code Results Normalized Card Security Code Results The CVV2MATCH parameter retur
252. tions 1 to 16 alphanumeric characters 160 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions Heartland Purchasing Card Transaction Processing Parameter Description TAXAMT Required Tax amount The value must include a decimal and the exact amount to the cent 42 00 not 42 Do not include comma separators 1234 56 not 1 234 56 To qualify for Level 2 discounts this value must not be all zeros or blank spaces Character length and limitations numeric TAXEXEMPT Optional Tax amount identifier Character length and limitations alpha character Y or N Example Heartland Level 2 Visa Transaction Parameter String TRXTYPE S amp ACCT 4111111111111111 amp AMT 20 02 amp BILLTOCITY Mountain View amp COMMENT1 L2 Testing amp EXPDATE 1215 amp INVNUM 661254585 amp BILLTOFIRSTNAME CardHolder Name amp P ARTNER PayPal amp PWD pwd amp BILLTOSTATE CA amp BILLTOSTREET 123 Main St amp TAXAMT 1 01 amp TAXEXEMPT N amp TENDER C amp USER user amp BILLTOZIP 94043 Heartland Level 3 MasterCard Parameters To qualify for Level 3 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 Level 3 transactions that do not include the required Level 2 values a
253. tions 50 alphanumeric characters Optional Merchant invoice number Character length and limitations 25 alphanumeric characters Optional Merchant value added tax number Character length and limitations 95 alphanumericcharacters Optional 5 to 9 digit zip postal code excluding spaces dashes and nonnumeric characters where the transaction took place If you are a third party biller bill for services or goods rendered by another entity you must enter the postal code that corresponds to the seller s location Character length and limitations 15 alphanumeric characters Gateway Developer Guide and Reference 31 July 2012 195 196 Submitting Purchasing Card Level 2 and Level 3 Transactions WorldPay Purchasing Cards Transaction Processing Level 2 Parameters Description MISCDATA ORDERDATE PONUM SHIPTOZIP TAXAMT TAXEXEMPT VATINVNUM VATNUM VATTAXAMT VATTAXRATE Optional Miscellaneous data Character length and limitations 95 alphanumeric characters 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 Optional Purchase order number Character length and limitations 25 alphanumeric characters Optional Ship to postal code called zip code in the USA Character length and limitations 9 numeric characters Optional Sales tax The value must include a decimal
254. tiv Purchasing Card Transaction Processing 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 Character length and limitations 3 alpha characters DISCOUNT Optional Discount amount on total sale Character length and limitations 10 currency characters DUTYAMT Optional Sometimes called import tax Ifthe currency uses a decimal then 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 10 currency characters FREIGHTAMT Character length and limitations 10 currency characters PONUM Optional Purchase order number merchant related data Character length and limitations 25 alphanumeric characters provides best rate when used SHIPFROMZIP Optional The postal code called zip code in the USA from which shipping occurs Character length and limitations 9 numeric characters provides best rate when used SHIPTOZIP Optional Ship to postal code called zip code in the USA Character length and limitations 9 numeric characters provides best rate when used TAXAMT Optional Tax amount The value must include a decimal and the exact amount to the
255. to display the state fees Suggestions include a new pop up window a full browser window or directly on the checkout AK 30 HI 30 MN 30_ce OH 301 VI 20 page AL AR AZ CA CO CT DE DC FL GA GU 30 25 25 25 20 20 40 25 25 f 30 20 TA ID IL IN KS KY LA MA MD ME MI 30 20 25 20 30 50 257 25 35 25 25 MO MS MT NC ND NE NH NJ NM NV NY 25 40 30 25 30 35 25 30 30 25 20 OK OR PA PR RI SC SD TN TX UT VA 25 25 30 10 25 30 40 30 30t 20 50 VT WA WI WV WY 251 30 0 25 25 30 Authorization Sales Decline Error 142 Authorization requests can fail for a number of reasons ranging from missing or invalid fields to business decisions based on risk assessment These different scenarios need to be handled differently by the merchant and require different legal language to be displayed to the customer Sale Decline Required Language We are sorry that we cannot accept your check at this time Our decision is based in whole or in part on information provided to us by TeleCheck We encourage you to call TeleCheck at 1 800 366 2425 or write TeleCheck Customer Care at P O Box 4513 Houston TX 77210 4513 Please provide TeleCheck your driver s license number and the state where it was issued and the complete banking numbers printed on the bottom of your check Under the Fair Credit Reporting Act you have the right to a free copy of your information held in TeleCheck s fil
256. tomer interaction with a merchant call center representative CBP services are single entry only Partial debits and recurring entries are not allowable per NACHA guidelines e NFTF prearranged payment and deposit entry NFTF PPD may be used for either recurring or non recurring debits to a customer s account when the merchant has provided the customer with a written authorization which the customer has signed or similarly authenticated Actual payments are facilitated via the internet or via IVR or over the phone The application type value must be set to PPD PPD accounts must establish an end date to clearly define terms between customer and merchant but do not have time period caps TeleCheck NFTF Processing Overview NFTF requirements processing considerations and guidelines for processing check payments are described below NFTF Requirements The following requirements must be followed as standard operating procedures to electronically process a NFTF check payment e A TeleCheck Merchant ID is required on all transactions and is unique to each location Gateway Developer Guide and Reference 31 July 2012 129 130 TeleCheck Electronic Check Processing TeleCheck NFTF Processing Overview 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
257. ts only on Hosted checkout pages PayPal branding on full page templates Yes Optional Transparent Redirect No Yes Supports PayPal as a processor and an Yes Yes acquirer Credit and debit cards Yes Yes Level 2 and Level 3 purchase cards Yes Yes TeleCheck guaranteed electronic No Yes checks ACH electronic checks No Yes Virtual Terminal support including Yes Yes card present data passage Virtual Terminal Payflow Link only Yes API Limited access no authorization or sale Full access 31 July 2012 Gateway Developer Guide and Reference Introducing the Gateway Checkout Solutions About the Gateway Transaction Flow PayPal Payments Advanced PayPal Payments Pro Feature Payflow Link Payflow Pro Reference transactions Tokenization Yes Yes Secure token to preset hosted checkout Yes Yes page 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 Yes Yes Partner Manager registration XML registration resale and referral About the Gateway Transaction Flow The traditional transaction flow is as follows Numbers correspond to numbers in the figure 1 At your website the customer clicks Buy to purchase merchandise You send the transaction request to the Gateway server The Gateway sends the transaction to the payment processing network A Y N Your processor sends
258. ts should use a two step process since settlement should occur when the merchant ships the goods A two step 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 For the address verification service if the initial transaction submits the data Gateway Developer Guide and Reference 31 July 2012 49 50 Submitting Credit Card Transactions Planning Your Gateway Integration the issuer checks the street address and the zip code against the billing address on file for the consumer Card security code refers to a 3 or 4 digit number that appears on the back of most credit cards On American Express the number appears proceeding and to the right of the embossed card number Card security code is known by other names such as CVV2 depending on the type of card If card security code data is submitted the issuer can notify you whether the number matches the number assigned to the card It may also be possible to implement additional safeguards yourself or to use a fraud service You might want to discuss risk management with your Internet Merchant Account provider e Whe
259. ts 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 Example PAGEBUTTONBGCOLOR AA66FF PAGEBUTTONTEXTCOLOR Sets the color of the text on the Pay Now Submit button Example PAGEBUTTONTEXTCOLOR 33FFFF LABELTEXTCOLOR Sets the color of the text for card number expiration date etc Example LABELTEXTCOLOR 330000 Other HTML Post Params Variable Description MODE Optional Used in conjunction with secure token It lets Payflow know that the secure token passed in is a live or test token Values LIVE TEST Default is LIVE PARMLIST Used with a secure token Passing in a string such as SECURETOKEN SECURETOKENID PARMLIST COMMENT1 Test amp COMMENT2 Test2 amp US ER1 123456 will make it so that Payflow will parse out the name value pairs and use those to run thetransaction as well This is for merchants that alreadyhave an existing PARMLIST they would be using withthe Payflow SDK and want an easy integration Used with the secure token Gateway Developer Guide and Reference 31 July 2012 37 Configuring Hosted Checkout Pages Silent Posts Variable Description SHOWAMOUNT If you pass in 0 amount and trans type A then if SHOWAMOUNT FALSE P
260. type some of these may not apply Please confirm applicable codes with TeleCheck s Merchant Boarding and Certification group NOTE Merchants should establish policies and procedures for each applicable response code For example if a clerk enters a transaction and receives Response Code 27 they should retry the transaction If after entering the item a second time they receive a Response Code 27 again the merchant may choose to cancel or terminate the transaction and a retry the transaction b call TeleCheck Live Operator Authorization Center or c request another form of payment from the check writer Sale Response Code Values Sale Approval Responses Code Description Merchant Action 07 Approved No action needed Sale Decline Responses Code Description Merchant Action 08 Rejected Negative Data Ask for other form of payment or decline sale to customer 73 Lost or Stolen check Ask for other form of payment or decline sale to customer 88 Rejected Code 3 Risk Ask for other form of payment or decline sale to customer 25 Ineligible ACH Not Offered Ask for other form of payment NOTE Do NOT use the verbiage decline this is not a true decline Gateway Developer Guide and Reference 31 July 2012 137 138 TeleCheck Electronic Check Processing Response Code Values Sale Referral Responses Code Description Merchant Action 09 Risk Referral requested Contact TeleCheck 69 Call Ce
261. uare metre MTK Square mile MIK Square millimetre MMK Square yard YDK Standard WSD standard atmosphere 101325 Pa ATM statue mile 1609 344 m SMI Stone GB 6 350293 kg STI Technical atmosphere 98066 5 Pa ATT Ten days DAD Ten pairs TPR Thousand MIL Thousand ampere hour TAH Gateway Developer Guide and Reference 31 July 2012 223 224 Codes Used by FDMS South Only Units of Measure Thousand board feet 2 36 m3 Thousand cubic metres per day Thousand standard brick equivalent Ton of steam per hour Tonne 1000 kg Tonne of substance 90 percent dry Trillion EUR Trillion US Troy ounce Troy pound US 373 242 g Volt Watt Watt hour Weber Week Yard 0 9144 m Year MBF TOD MBE TSH TNE TSD TRL BIL APZ LBT VLT WTT WHR WEB WEE YRD ANN 31 July 2012 Gateway Developer Guide and Reference PayPal Acquirer If PayPal is your acquirer and no other bank is involved in processing your transactions use the following PayPal specific codes Countries and Regions Supported by PayPal PayPal uses 2 character 1S0 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 ISO 3166 1 codes please refer to the PayPal API reference list of Countries and Regions PayPal Currency Codes PayPal uses 3 character ISO 4217 codes for specifying currencies in fi
262. ue Test the results and check with your processor to determine whether they support card security code checking For the testing server the first three characters of the CVV2 value determine the CVV2MATCH result as shown here Testing CVV2MATCH CVV2 Value CVV2MATCH Value 000 Y 001 300 Y 301 600 N 601 or higher X PayPal Processor For the PayPal processor use the following guidelines Credit Card Numbers for Testing For the PayPal processor use the following credit card numbers for testing Any other card number produces a general failure American Express 378282246310005 American Express 371449635398431 Amex Corporate 378734493671000 Australian BankCard 5610591081018250 Diners Club 30569309025904 Diners Club 38520000023237 Discover 6011111111111117 Discover 6011000990139424 82 31 July 2012 Gateway Developer Guide and Reference Testing Transactions PayPal Processor JCB JCB MasterCard MasterCard Visa Visa Visa 3530111333300000 3566002020360505 5555555555554444 5105105105105100 4111111111111111 4012888888881881 4222222222222 NOTE 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 The servers do not return non zero RESULT values from processors Therefore you cannot simulate non zero RESULT
263. ue for CHKTYPE is passed e If CHKTYPE P you are required to pass a value for either DL or SS as an identifier e If CHKTYPE C you are required to pass the Federal Tax ID Character length and limitations 35 alphanumeric characters TENDER Required Method of payment Use only the value K electronic check Character length and limitations 1 alphabetic character TRXTYPE Required Type of transaction that should be processed It is one of the following values e A The transaction is an Authorization e D The transaction is a Delayed Capture e V The transaction is a Void e I The transaction is an Inquiry Character length and limitations 1 alpha character Testing TeleCheck Transactions PayPal provides a test server to support testing and configuration For information on the test server URL see Host URL Addresses on page 42 Example Test Transaction This is the authorization request and response TRXTY PE A amp TENDER K amp PARTNER partner amp USER user amp VENDOR vendor amp PWD pwd amp AMT 35 0 O amp BILLTOSTREET 1234 Main amp BILLTOCITY Buf falo amp DL CA123456 amp CHKNUM 1001 amp BILLTOE MAIL j ohn xyz com amp MICR 3 333333333 amp AUTHTYPE I amp INVNUM 12345 amp BILLTOFIRSTNAME S ally amp BILLTOLASTNAME Smith amp BILLTOSTATE CA amp BILLTOZIP 95050 amp BILLTOCOUNTRY US amp C USTIP 10 15 5 23 amp BILLTOPHONENUM 9876542143 amp VERBOSITY HIGH RESULT 0 amp PNREF EQ RB8A32CD69 amp RESPMSG Approved amp
264. ue returned RESULT 0 amp RESPMSG Approved amp SECURETOKEN 25 Fj 1lAFUWf t0 I0CUFOKh5WA amp SECURET OKENID 9 a9ea8208de1413abc3d60c86cb1f4c5 When the customer enters their sensitive data into the credit card fields on your website and clicks Submit the browser posts the data to the Gateway server rather than to your website NOTE Itis highly recommended that you add scripting to ensure the the browser posts the sensitive data directly to the PayPal Gateway server rather than to your website Posting To the Hosted Checkout Page To display the transaction information to the Gateway hosted checkout page you perform an HTTP form post 1 Direct the HTTP post to the Gateway applications server at the following URL https payflowlink paypal com 2 Send the following parameter data SECURETOKEN returned in the transaction response SECURETOKENTD HTTP Form Post Examples The following is an example request string that displays the transaction information to the hosted checkout page Gateway Developer Guide and Reference 31 July 2012 29 Secure Token Posting To the Hosted Checkout Page lt html gt lt META http equiv Content Type content text html charset UTF 8 gt lt head gt lt title gt PageTitle lt title gt lt head gt lt body gt lt form method post action https payflowlink paypal com gt lt input type hidden value F3 1AFUWft0 TOCUFOKh5WA name SECURETOKEN gt lt input type hidde
265. umeric characters DUTYAMT Optional Duty amount Character length and limitations 12 numeric characters SHIPTOZIP Required The zip code of the address to which the goods are shipped Character length and limitations 10 alphanumeric characters SHIPFROMZIP Required The postal code called zip code in the USA from which shipping occurs Character length and limitations 10 alphanumeric characters SHIPTOCOUNTRY Optional Destination country code Character length and limitations 3 alphanumeric characters ALTTAXAMT Optional Alternate tax amount Character length and limitations 9 numeric characters 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions Merchant e Solutions Purchasing Card Transaction Processing Merchant e Solutions Level 3 MasterCard Line ltem Detail Records NOTE For the following values nis 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 Character length and limitations 12 alphanumeric characters L_DESCn Required Item descriptor Character length and limitations 35 alphanumeric characters L_UPCn Optional Product code Character length and limitations 12 alphanumeric characters L_OTYn Required Quantity Character length and limitations 12 numeric characters
266. ummary box in PayPal Manager Hosted Checkout Pages amp Payflow SDK API Limited Access If PayPal Payments Advanced is also listed then you are not a Payflow Link customer 31 July 2012 Gateway Developer Guide and Reference Intended Audience Service Summary Service Status Y Mode Hosted Checkout Pages Test Test Payflow SDK API Limited Access Test _ 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 e Payflow Pro Payflow Pro customers can choose PayPal or another merchant bank to process their transactions via the Gateway A Legacy Payflow Pro users will see the following in the Service Summary box in PayPal Manager Payflow Pro Service Summary Service Status Mode PayFlow Pro Live Legacy Payflow Pro users should use this guide however these users can only use the API integration and do not have the Hosted Checkout Pages service If you are a legacy Payflow Pro user you should skip the chapter on Hosted Checkout Pages Configuring Hosted Checkout Pages on page 31 B New Payflow Pro users can take advantage of all of
267. unt 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 Gateway Developer Guide and Reference 31 July 2012 187 188 Submitting Purchasing Card Level 2 and Level 3 Transactions TSYS Acquiring Solutions Purchasing Card Transaction Processing Parameter Description TAXEXEMPT Optional Tax amount identifier Character length and limitations 1 alpha character Y or N Example TSYS Acquiring Solutions Level 2 Visa Transaction Parameter String TRXTYPE S amp ACCT 4111111111111111 amp AMT 20 0O2 amp BILLTOCITY Mountain View amp COMMENT1 L2 Test ing amp EXPDATE 1215 amp INVNUM 661254585 amp BILLTOFIRSTNAME CardHolder First Name amp BILLTOLASTNAME CardHolder Last Name amp PARTNER PayPal amp PWD pwd amp BILLTOSTATE CA amp BILLTOSTREET 123 Main St amp TAXAMT 1 01 amp TAXEXEMPT N amp TENDER C amp USER user amp BI LLTOZIP 94043 TSYS Acquiring Solutions Level 3 MasterCard Parameters To qualify for Level 3 purchasing card transaction processing 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 Level 3 transactions that do not include the required Level 2 values are rejected
268. urchasing Card Level 2 and Level 3 Transactions Merchant e Solutions Purchasing Card Transaction Processing Merchant e Solutions Level 3 Visa Parameters To qualify for Level 3 transactions the authorization response for the transaction must have the commercial card indicator set and one or more line items should be present in the delayed capture or sale request Level 2 transaction parameters marked as Required are required for Level 3 transactions Level 3 transactions that do not include the required Level 2 values are rejected IMPORTANT The values required for Level 3 status vary by bank so contact your bank for details Merchant e Solutions Level 2 Visa Parameters Required for Level 3 Transactions Parameter Description PONUM TAXAMT Required Purchase identifier TheTransaction ID is sent if no value is provided Character length and limitations 25 alphanumeric characters 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 Character length and limitations 1 alphanumeric Y or N NATIONALTAXAMT Optional National tax amount INVNUM Character length and limitations 12 numeric characters Required Purchase
269. urity It is your responsibility to adhere to PCI compliance standards to protect personal information and implement security safeguards on your website when processing payment card transactions Gateway solutions make available a secure token and hosted checkout pages to help you meet PCI compliance Hosted pages are optional to PayPal Payments Pro and Payflow Pro users If you do not use a secure token or hosted pages you must provide your own means of meeting compliance requirements NOTE PayPal Payments Advanced and Payflow Link merchants are required to use hosted pages 22 31 July 2012 Gateway Developer Guide and Reference Introducing the Gateway Checkout Solutions aa About Security Secure Token The secure token stores request transaction data on the Gateway server It eliminates the need to resend the parameter data for display in a hosted checkout page where the data might be subject to compromise Hosted Checkout Pages The Gateway enables the use of hosted checkout pages which help you achieve PCI compliance The hosted checkout pages enable you to pass transaction data securely to the server and to collect credit card acceptance data NOTE You are required to use hosted pages with PayPal Payments Advanced and Payflow Link The following figure shows the transaction flow when using hosted pages and a secure token Paec N Company Merchant s Site D E o 5 m E ao _ y Customer Gateway Server Pay
270. ut Pages Mica SetUp Customize Integrate Set Up Choose your settings Here are your current Hosted Checkout Page settings You can change them on this page to modify the checkout page Transaction Process Mode Liye v How Your Checkout Pages Look Enter Text for Cancel URL optional Enter Cancel URL optional Enable Solo Switch Card No y PayPal Express Checkout How Your Pages Look Design Pages PayPal email address 22030 gwpiiciPpaypalcom What is this PayPal Sandbox email address 3qmohan gwpfitc11 paypal com Billing Information Choose the fields your customer will be required to complete during checkout Please note that this section doesn t apply to Layout C Make these fields required 4 Name Y Address City Suburb Y State Province Y ZIP code Postal code Country Y Phone Email address Y CSC Make these fields editable Y Name Y Address M city Suburb Y State Province Y ZIP code Postal code Y Country Y Phone Email address Y CSC Note Required Editable Billing Information is not valid for Telecheck Shipping Information This section does not apply to Layout C Make these fields required Y Name Y Address Y City sSuburb State Province Y ZIP code Postal code Y Country Y Phone Y Email address Make these fields editable Y Name Y Address Y city Suburb State Province Y ZIP code Postal code Y Country Y Phone Y Email address
271. uty amount Character length and limitations numeric SHIPTOZIP Required Destination zip code SHIPTOCOUNTRY Optional Destination country SHIPFROMZIP Required Ship from zip code DISCOUNT Required Discount amount Character length and limitations numeric ALTERNATETAXID Optional Alternate tax ID ALTERNATETAXAMT Optional Alternate tax amount Character length and limitations numeric Level 3 MasterCard Line Item Record 1 Parameters Parameter Description L_DESCn L PRODCODEN L_QTYn L_UOMn TAXAMTN L_TAXRATEN Required Description Optional Product code Required Quantity Character length and limitations numeric characters Required Unit of measure Optional Tax amount Character length and limitations numeric Optional Tax rate Character length and limitations 4 numeric characters 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions Paymentech Salem New Hampshire Purchasing Card Transaction Processing Level 3 MasterCard Line Item Record 2 Parameters Parameter L_AMTn L_DISCOUNTN L_TAXTYPEN Description Optional Line item total Character length and limitations numeric Optional Discount amount Character length and limitations numeric Optional Tax type applied Paymentech Salem New Hampshire Level 3 Visa Parameters Level 3 Visa Order Parameters
272. valid See RESPMSG 20 Cannot find the customer reference number 22 Invalid ABA number 23 Invalid account number Check credit card number and bank account number and re submit 24 Invalid expiration date Check card expiration date and re submit Gateway Developer Guide and Reference 31 July 2012 95 96 Transaction Responses RESULT Values and RESPMSG Text RESULT RESPMSG and Explanation 25 Invalid Host Mapping Error is caused by one or more of the following e 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 e 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 26 Invalid vendor account 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 27 Insufficient partner permissions 28 Insufficient user permissions 29 Invalid XML document This could be caused by an unrecognized XML tag or a bad XML format that cannot be parsed by the system 30 Duplicate transaction 31 Error in adding the recurring profile 32 Error in modifying the recurring profile 33 Error in canceling the recurring profile 34 Error in forcing the recurring profile
273. values using the amount In some cases you may obtain certain results using the RESULT value plus 1000 even though this table suggests another means of obtaining the RESULT value Result Definition How to test 0 Approved Use an AMOUNT of 10000 or less 3 Invalid transaction type Use the AMOUNT 10402 4 Invalid amount Use any of these as AMOUNT e 10400 e 10401 e 10403 e 10404 5 Invalid merchant information Use any of these as AMOUNT e 10548 e 10549 Gateway Developer Guide and Reference 31 July 2012 83 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 10519 10521 10522 10527 10535 10541 10543 84 31 July 2012 Gateway Developer Guide and Reference Testing Transactions PayPal Processor Result Definition How to test 24 Invalid expiration date Use any of these as AMOUNT e 10502 e 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 Erro
274. xX XXX XXX XXX Optional Indicates if this Delayed Capture transaction is the last capture you intend to make The values are e Y default e N NOTE If CAPTURECOMPLETE is Y any remaining amount of the original reauthorized transaction is automatically voided Limitations 12 character alphanumeric string Optional A free form field for your own use Limitations 256 character alphanumeric string Optional Email address of payer Limitations 127 alphanumeric characters Optional Your own unique invoice or tracking number Limitations 127 alphanumeric characters 116 31 July 2012 Gateway Developer Guide and Reference Processors Requiring Additional Transaction Parameters PayPal Credit Card Transaction Request Parameters Parameter Description ITEMAMT TAXAMT FREIGHTAMT HANDLINGAMT DISCOUNT INSURANCEAMT Required if L_COSTN is specified Sum of cost of all items in this order ITEMAMT L QTYO LCOSTO L QOTY1 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 Limitations Nine numeric characters plus decimal Required if L_TAXAMTn is specified Sum of tax for all items in this order TAXAMT L QTYO L TAXAMTO L QTY1 L TAXAMT1 L QTYN L TAXAMTN NOTE You must set CURRENCY to one
275. xamples e CA California USA e NS Nova Scotia Canada e COS Colima Mexico If you are a third party biller bill for services or goods rendered by another entity you must enter the region code that corresponds to the state province or country subdivision in which the seller is located Character length and limitations 3 alphanumeric characters Optional The 5 to 9 digit zip postal code excluding spaces dashes and non numeric characters where the transaction took place If you are a third party biller bill for services or goods rendered by another entity you must enter the postal code that corresponds to the seller s location Character length and limitations 15 alphanumeric characters Optional Country code of the location where the transaction took place Character length and limitations 3 alphanumeric characters Optional Merchant assigned store or location number or name that uniquely identifies where the transaction took place NOTE 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 Character length and limitations 15 alphanumeric characters 176 31 July 2012 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and Level 3 Transactions Paymentech Salem New Hampshire Purchasing Card Transaction Processing Field Description MERCHANTID
276. xpress In addition to the core credit card parameters Paymentech Salem accepts the parameters to meet American Express statement and reporting requirements described below Internet Transaction Data Parameters Field Description BILLTOEMATL Optional Account holder s email address Character length and limitations 60 alphanumeric characters BILLTOPHONENUM Optional Account holder s telephone number Character length and limitations 20 characters PHONETYPE Optional Telephone company provided ANI information identifier digits indicating the telephone call type Examples cellular 61 63 payphone 27 Character length and limitations 2 characters Gateway Developer Guide and Reference 31 July 2012 113 114 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 0 WINDOWS 95 Character length and limitations 60 alphanumeric and special characters CUSTIP Optional Account holder s IP address Character length and limitations 15 alphanumeric and special characters SHIPTOCOUNTRY Optional Numeri
277. xtract the files to a local directory 3 Configure your firewall If you have a stateful firewall enable outbound traffic for SSL port 443 The firewall keeps state on the connection and automatically permits the inbound response from PayPal If you do not have a stateful firewall enable inbound and outbound traffic for SSL port 443 Outbound traffic permits the initial Gateway request while inbound permits the response from PayPal 4 Read the Readme txt file The Readme txt file includes integration information and samples that illustrate how to use the client application in your development environment Gateway Developer Guide and Reference 31 July 2012 41 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 Activate Your 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 Host URL Addresses Use the following host addresses for sending test and live transactions e For live transactions use https payflowpro paypal com e For testing purposes use https pilot payflowpro paypal com 42 31 July 2012 Gateway Developer Guide and Reference Sending a Simple Transaction to the Server
278. y reflect the look and feel of your website In doing so the buyer seamlessly transitions from your website to the Gateway hosted checkout pages to make the payment and complete the transaction Since the pages are hosted on PayPal you do not have to capture or store credit card information on your website thereby helping towards achieving PCI compliance NOTE Gateway implementation helps to achieve PCI compliance but does not necessarily guarantee it There are two ways to configure hosted checkout pages e Logging in to PayPal Manager and making selections e Using the secure token and passing configuration parameters in a form post Configuring Hosted Pages Using PayPal Manager You can specify the content of your hosted checkout pages and configure their appearance to reflect the look and feel of your website To do so log into PayPal Manager and click on the Settings tab In the Hosted Checkout Pages section you have the following options e Setup e Customize Setup The Setup page on PayPal Manager enables you to select the information you want to collect and display on your hosted checkout pages and where you want to display the payment confirmation Gateway Developer Guide and Reference 31 July 2012 31 Configuring Hosted Checkout Pages Configuring Hosted Pages Using PayPal Manager PayPal Manager Home Account Administration Service Settings Search Transactions Virtual Terminal Reports Hosted Checko
279. y settings see PayPal Manager online help Parameter Description ORIGID Required by some transaction types ID of the original transaction that is being referenced The PNREF parameter returns this ID and it appears as the Transaction ID in PayPal Manager reports Limitations 12 case sensitive alphanumeric characters Set the value of ORIGID to the PNREF value returned for the original transaction PayPal Manager reports display the PNREF as the Transaction ID If you do not specify an amount then the amount of the original transaction is credited to the cardholder 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 NoTE These fields are not copied for referenced credits TAXAMT TAXEXEMPT DUTYAMT FREIGHTAMT and for American Express only DESC4 NOTE For processors that use the RECURRING parameter If you set the RECURRING parameter to Y in the original transaction this setting is ignored when forming the credit transaction 31 July 2012 Gateway Developer Guide and Reference Submitting Credit Card Transactions CA Submitting Inquiry Transactions A

PayPal Gateway - 2012 Developer's Guide

Contents

Download Pdf Manuals

Related Search

Related Contents