Home

PayPal Gateway - 2014 Developer's Guide

1. Q 5 0 E CB ae Customer Merchant s Site Gateway Server Payment Processing Netwark 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 Gateway Developer Guide and Reference 07 January 2014 217 28 Introducing the Gateway Checkout Solutions About Security e Each Gateway processor may support various additional parameters beyond the core set that you can send 1n 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 Security 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
2. The Payflow SDK also supports the following credit card features e Address verification service and card security code validation e Card present SWIPE transactions e Partial authorizations for pre paid cards e Purchasing card transactions e Reference transactions also called tokenization e Submitting Soft Merchant information Planning Your Gateway Integration When designing your Gateway integration evaluate e 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 merchants should use a two step process since settlement should occur when the merchant ships the goods A two step Gateway Developer Guide and Reference 07 January 2014 59 60 Submitting Credit Card Transactions Planning Your Gateway Integration process is also useful for evaluating information in the response such as whether the issuer verifies the billing address and so on Electronic goods merc
3. Characteristic length and limitations The decimal 1s 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 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions Cielo Payments Purchasing Card Transaction Processing D Cielo Payments Purchasing Card Transaction Processing Cielo Payments Level 2 Parameters Cielo Payments formerly Merchant e Solutions supports MasterCard and Visa for Level 2 processing Cielo Payments 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 Cielo Payments Level 2 Transaction Data To get the discount rate Level 2 values marked as Required in the following table must be present Parameter Description PONUM 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 o
4. L QTYN Description 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 characters 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 characters 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 Optional Total shipping insurance cost for this order Limitations Nine numeric characters 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 Optional Line item name NOTE To enable line item support send an email from the Primary email address on the account to payflow support paypal com Character length and limitations 36 alphanumeric characters Optional Line item description of the item purchased such as hiking boots or cooking utensils NOTE To enable line item support send an email from
5. Limited to the major version and one digit of the minor version can include alphanumeric characters not just digits Format String lt Major Version gt lt Minor Version gt Examples 1 1 4 5 10 0 Linux2 1 Default Value Blank Name of operating system on which the client is running Format String Examples Linux SunOS Windows 2000 Windows NT Windows XP Mac OS X Free BSD Default Value Blank Version of operating system on which the client is running Format String XXX X Example 2 4 Default Value Blank 160 07 January 2014 Gateway Developer Guide and Reference Payflow Header Parameters C Posting Transactions Directly Without the Payflow SDK Cc Header Name Description X VPS VIT RUNTIME VERSION Version of runtime environment of the language in which the client is written and is running Format String XXX XE Examples 10 1 2 5 Default Value Blank For more information on Payflow headers see this Merchant Technical Support MTS knowledge base article Gateway Developer Guide and Reference 07 January 2014 161 Payflow Header Parameters Posting Transactions Directly Without the Payflow SDK 162 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions PayPal Payment Services supports passing Purchasing Card Level 2 information such as purchase order number tax amount and charge description in the settlement file If addit
6. use 1199 95 not 1 199 95 Required Ship to postal code called zip code in the USA Character length and limitations 1 to 9 alphanumeric characters Required Ship to country The Payflow API accepts a 3 digit numeric country code Refer to http en wikipedia org wiki ISO_3166 1_ numeric Character length and limitations 3 character country code Required The postal code called zip code in the USA from which shipping occurs Character length and limitations 1 to 9 alphanumeric characters Required Shipping discount for this order Character length and limitations 9 numeric characters plus a decimal point 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 Required Alternate Tax ID Required Indicates whether the customer is tax exempt It is one of the following values Y The customer is tax exempt N The customer is not tax exempt default Character length and limitations 1 alphanumeric characters Required Customer reference number Character length and limitations 1 to 17 alphanumeric characters Required Item commodity code n is a line item number from 1 to 6 Character length and limitations 1 to 12 alphanumeric characters Required Description of this line item n 1s a line item number from 1 to 6 Character length and limitations 1 to 19 alphanumeric characters Required
7. 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 174 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 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 Land ends with n where n is the line item number For example L QTY0 1 is the quantity for line item O 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
8. 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 Gateway Developer Guide and Reference 07 January 2014 133 134 Processors Requiring Additional Transaction Parameters SecureNet Additional Credit Card Parameters for American Express Field SHI PTOCOUNTRY SHI PME THOD Description Optional Numeric country code of ship to country Example USA 840 The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wikvISO 3166 1 numeric Character length and limitations 3 alphanumeric characters Optional Shipping method code The values are 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 BILLTOSTREET BILLTOZIP BILLTOPHONENUM SHIPTOFIRSTNAME SHIPTOLASTNAME SHIPTOSTREET SHI PTOCOUNTRY SHIPTOZIP Description Optional Account holder s street address number and street name Character length and limitations 30 characters Optional Account holder s 5 to 9 digit ZIP po
9. 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 Vantiv Additional Credit Card Parameters Additional Credit Card Parameters Field MERCHDESCR Description 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 Soft Merchant Descriptor Parameters Field MERCHANTNAME MERCHANTSTREET Description 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 07 January 2014 Gateway Developer Guide and Reference Processors Requiring Additional Transaction Parameters Vantiv Additional Credit Card Parameters A 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 1s located e If you are a mail order phone order or internet industry you may substitute the name of the city in which
10. Please test your integration first to determine if the billing information fields are required Limitations 40 alphanumeric characters BILLTOSTATE Conditional Bill to state or province address NOTE Some merchants maybe required to pass this billing information Please test your integration first to determine if the billing information fields are required Limitations 40 alphanumeric characters Gateway Developer Guide and Reference 07 January 2014 131 Processors Requiring Additional Transaction Parameters A PayPal Credit Card Transaction Request Parameters Parameter BILLTOCOUNTRY SHIPTOSTREET SHIPTOCITY SHIPTOSTATE SHIPTOCOUNTRY SHIPTOZIP 132 Description Conditional Bill to country address For the PayPal acquirer refer to PayPal s country codes https developer paypal com webapps developer docs classic api country_codes NOTE Some merchants maybe required to pass this billing information Please test your integration first to determine if the billing information fields are required Limitations 2 alphanumeric characters Optional Ship to street 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 SHIPTOSTREET SHIPTOCITY SHIPTOSTATE SHIPTOCOUNTRY and SHIPTOZIP Limitations 100 character string Optional Ship to city address NOTE If you pass in any of the ship to a
11. by a MagneSafe device when a card is Swiped ENCTRACK3 Optional Encrypted Track 3 String information returned by a MagneSafe device when a card is swiped Encrypted Card Swipe Transactions Response Parameters Field Description Data Type Notes MAGTRESPONSE This parameter appears in String See the error codes below the response if a data for more information validation error occurs or if the MagTek processor throws an error 256 07 January 2014 Gateway Developer Guide and Reference Payflow Gateway Mag Tek Parameters Parameters for Mag Tek Qwick Code PCode Transactions Parameters for MagTek Qwick Code PCode Transactions Qwick Code PCode Transactions Request Parameters Field MERCHANTID PAN4 PCODE SWIPEDECRHOST AUTHVALUEI AUTHVALUE2 AUTHVALUE3 BILITOEMAIL BILLTOLASTNAME BILLTOZIP MAGTEKUSERNAME MAGTEKPWD MERCHANTNAME SHIPTOZIP Required Required Required Required Required Optional Optional Optional Optional Optional Optional Optional Optional Optional Optional Description Your Merchant ID or the Merchant ID of the merchant redeeming the Protection Code The last 4 digits of the PAN account number encoded in the card The generated Protection Code MAGT is the only value currently accepted in the SWIPEDECRHOST parameter Authentication Value 1 generated with the PCode Authentication Value 2 generated with
12. centered right Applicable to Layouts A and B 07 January 2014 Gateway Developer Guide and Reference Configuring Hosted Checkout Pages Using a Secure Token to Pass Hosted Pages Customization Parameters e Page Background Applicable to Layout B only You can change the following Background color Footer text color Upload a background image jpg Jpeg gif or png The maximum allowable image size is 100kb Repeat image option e Payment Method Section Applicable to Layouts B and C You can change the following Text color of the section title Applicable to Layout B only Subheader text color Applicable to Layouts B and C Color of other text in this section Applicable to Layout B only Section border color Applicable to Layouts B and C Button color and button text color Applicable to Layouts B and C e Order Summary Column Applicable to Layout Bonly You can change the following Integrate Column background color Upload a background image Repeat image option Testing with the Payflow Gateway This guide shows you how to setup a test account configure a hosted checkout page and submit a test transaction Additional Resources PayPal s developer portal includes e Developer integration guides which are comprehensive product guides like this guide e See the Payflow Gateway product page for links to other useful resources such as SDKs screencasts code samples and more Using a Secure Token
13. headers described in the following table Required Payflow Headers Header Name Description X VPS REQUEST ID Required A unique identifier for each request whether the request is a single name value transaction or an XMLPay 2 0 document with multiple transactions This identifier is associated with all the transactions in that particular request X VPS REQUEST ID is made up of 1 to 32 printable characters You must provide the X VPS REQUEST ID value in the transaction request The server uses the X VPS REQUEST ID to check for duplicate transaction requests When a transaction request is received the server checks the requests table to see if the X VPS REQUEST ID has been used before by this merchant If the X VPS REQUEST ID has been used before the server views it as a retry transaction and the transaction is treated as a duplicate The response to the original transaction request is returned and DUPLICATE 1 is appended to the response indicating that this transaction is a duplicate In Manager you will see these DUPLICATE transactions with a TENDER type of N IMPORTANT If you send in a NEW transaction with a previously used X VPS REQUEST ID the server ignores the new data and returns the response to the original transaction associated with that X VPS REQUEST ID It is VERY IMPORTANT that you check for DUPLICATE 1 and if you receive it and the transaction is not a re attempt of the original request of a faile
14. 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 transfer 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 1s 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 Deve
15. 11 Failed to settle transactions fail settlement usually because of problems with the merchant s processor or because the card type is not set up with the merchant s processor 12 Unsettled transaction because of incorrect account information 14 For various reasons the batch containing this transaction failed settlement 15 Settlement incomplete due to a charge back 16 Merchant ACH settlement failed need to manually collect it 106 Unknown Status Transaction Transactions not settled 206 Transactions on hold pending customer intervention Character length and limitations 10 integer characters 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 Gateway Developer Guide and Reference 07 January 2014 101 102 Transaction Responses Address Verification Service Responses From PayPal PayPal processor AVS code A Mm a a y N lt xXx gana All other Meaning Address International A International N International X Not allowed for MOTO Internet Phone transactions UK specific X Global Unavailable International Unavailable No Postal Intern
16. 195 o D Submitting Purchasing Card Level 2 and 3 Transactions Paymentech Salem New Hampshire Purchasing Card Transaction Processing Location Transaction Advice Addendum Parameters Field Description MERCHANTNAME Optional Name of merchant Character length and limitations 38 alphanumeric characters MERCHANTSTREET Optional Merchant s street address number and street name Character length and limitations 38 alphanumeric characters If more than 38 characters use proper and meaningful abbreviation 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 1s 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 1s 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 reg
17. 2014 Gateway Developer Guide and Reference Configuring Hosted Checkout Pages Silent Posts 3 Mobile page flow for a credit card payment Entry Credit Card Done Optional Merchant ABC Total 270 07 7 Merchant ABC Total 270 07 T Card Detalls VIRA C Total 270 07 o Billing information Receipt amp Confirmation ELDHA TAS Bill Te krri Seah Cancel amd return do Semit a Silent Posts Silent Post ensures that the transaction data is passed back to your website when a transaction is completed The Silent Post feature uses the HTML Post method to return data to your server for both approved and declined trasactions This occurs even if a customer closes the browser before returning to your site or if the PayPal hosted payment confirmation page is disabled Silent Post data is sent to your server at the same time as when a payment confirmation page 1s displayed or as soon as a transaction is declined This feature is configured through https manager paypal com e Go to Service Settings then from the Hosted Checkout Pages section select Setup e On the Setup page set Use Silent Post to Yes Then enter the Silent Post URL on your server 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 post F
18. 20304 character Gateway Developer Guide and Reference 07 January 2014 91 92 Testing Transactions Processors Other Than PayPal 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 value 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 x 001 300 Y 301 600 N 601 or higher X Testing the Litle Automatic Account Updater Feature The Litle Automatic Account Updater feature identifies outdated card information repairs it and substitutes new card information before submitting the transaction to the network See the Litle Automatic Account Updater on page 113 section for more information Merchants utilizing this feature should check for the presence of the CCUPDATED Y response parameter and 1f it is returned should also check for the presence of the ACCT and EXPDATE response parameters to determine what card informa
19. AMOUNT e 10548 e 10549 94 07 January 2014 Gateway Developer Guide and Reference Testing Transactions T PayPal Processor 7 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 Gateway Developer Guide and Reference 07 January 2014 95 96 Testing Transactions PayPal Processor Result 24 30 105 112 114 1000 Definition Invalid expiration date Duplicate Transaction Credit error Failed AVS check CVV2 Mismatch Generic Host Processor Error How to test Use any of these as AMOUNT e 10502 e 10508 Use the AMOUNT 10536 Attempt to credit an authorization Use the AMOUNT 10505 Use the AMOUNT 10504 Use an AMOUNT other than those listed in this column 07 January 2014 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 EKFHPOD426A53 amp RES PMSG APPROVED amp AUTHCODE 2 5TEST amp AVSADDR Y
20. 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 yymmdd with no slashes or dashes For example January 28 2013 is 130128 Character length and limitations 6 numeric characters SHIPTOCOUNTRY Optional Destination country code The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wiki ISO_3166 1 numeric Character length and limitations 3 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 TSYS Acquiring Solutions Level 3 Visa Line Item Detail Records NOTE For these values nis a sequence counter that should begin with 1 and increase in sequence Each line item should also contain quantity L_QTYn and unit price L COSTn fields Parameter Description L COM
21. Code The Payflow API accepts 3 digit numeric country codes Refer to the appendix at the end of this guide for FDMS South country codes Visa and Mastercard are different 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 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
22. Description ALTTAXAMT Optional Alternate tax amount Character length and limitations 8 alphanumeric characters COMMCODE Optional Summary commodity code identifier for the business Character length and limitations 4 alphanumeric characters SHIPTOCOUNTRY Optional Country code Either a 2 character alpha country code or a 3 character numeric country code Character length and limitations 2 or 3 alphanumeric characters CUSTDATA Optional Generic data the merchant can pass to the WorldPay processor Character length and limitations 95 alphanumeric characters CUSTOMERID Optional Purchase order number Character length and limitations 95 alphanumeric characters CUSTOMERNUMBER Optional Customer number Character length and limitations 95 alphanumeric characters DISCOUNT Optional Discount amount on total sale Character length and limitations 10 currency characters Gateway Developer Guide and Reference 07 January 2014 21 218 Submitting Purchasing Card Level 2 and 3 Transactions WorldPay Purchasing Cards Transaction Processing Level 2 Parameters DLNAME DLNUM DOB DUTYAMT FREIGHTAMT INVNUM MERCHANTDESCR MERCHANTINVNUM MERCHANTVATNUM MERCHANTZIP MISCDATA ORDERDATE PONUM SHIPTOZIP Description Optional Account holder s driver license name Character length and limitations 95characters Optional Account holder s driver license number Character length and
23. ENCMP has incorrect length H186 KSNhas incorrect format H187 KSNhas incorrect length H188 MPSTATUS has incorrect format H189 MPSTATUS has incorrect length H206 Invalid CARDTYPE H211 Invalid ENCRYPTIONBLOCKTYPE H219 Invalid OUTPUTFORMATCODE H251 Invalid DEVICESN Invalid MAGTEKCARDTYPE 07 January 2014 Gateway Developer Guide and Reference Payflow Gateway Mag Tek Parameters J Mag Tek Error Codes and Messages Jo Encrypted Card Swipe Transactions Other Error Codes Error Message Notes YOO1 No PAN Found in Track2 Data Y003 Device is not allowed MagTek maintains a list of registered Devices Y093 Invalid MagnePrint Error obtained while Scoring Transaction MagnePrint against a Reference MagnePrint made up of Zeros Y094 Invalid MagnePrint Negative 2 Invalid Transaction CRC PAN Obtained when Scoring Transaction MagnePrint against a Reference MagnePrint Made up of Zeros Y095 Error Scoring Card Y096 Inactive MagnePrint Reference This occurs whenever the Card has an inactive MagnePrint Reference Y097 Replay Prevented This occurs when the DUKPT KSN and Counter is replayed YO98 Problem with Reader Data This occurs if there is a problem while decrypting the Data Qwick Code PCode Transactions Input Validation Error Codes Error Message Notes H330 PCODE has incorrect length H331 PCODE has incorrect format H336 EMAIL has incorrect format BILLTO
24. Error Codes and Messages MagTek MagneSafe Secure Card Readers and Qwick Codes MagneSafe Secure Card Reader Authenticators MagTek s MagneSafe secure card readers encrypt payment card track data such as the credit card account number and the expiration date MagTek s Secure Card Reader Authenticators SCRAs capture data with a single swipe and can deliver dynamic card authentication data encryption tokenization and device host authentication to help protect merchants and their customers from identity theft and card fraud MagTek s MagneSafe SCRAs can also identify counterfeit cards What is MagneSafe The MagneSafe Security Architecture MSA is MagTek s digital identification and authentication architecture that can safeguard consumers and their personal data MSA leverages strong encryption secure tokenization counterfeit detection tamper recognition data relevance and integrity and dynamic digital transaction signatures to validate and protect the entire transaction The devices suported by MagTek s MagneSafe security and Magensa Services are Gateway Developer Guide and Reference 07 January 2014 251 202 Payflow Gateway MagTek Parameters Passing Encrypted Card Swipe Data and Qwick Codes to the Payflow Gateway e USB MSR Dynamag e Insert MSR for Kiosks ATMs etc MagneSafe I 65 for Chip Cards and MagStripe PSeries MagneSafe for outdoors Slim Seal MagneSafe e Mobile Readers iDynamo for 10S Bullet f
25. Guide and Reference TeleCheck Electronic Check Processing TeleCheck Authorization Requirements B Today insert today s date I d like to confirm that you insert first and last name are authorizing a payment in the amount of insert amount to be processed as an electronic funds transfer or draft drawn from your account Do you agree If your payment 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 For an 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
26. Guide and Reference 07 January 2014 127 A Processors Requiring Additional Transaction Parameters PayPal Credit Card Transaction Request Parameters PayPal Credit Card Transaction Request Parameters In addition to the core credit card parameters PayPal accepts the parameters described below Parameter AMT CURRENCY BUT TONSOURCE CUSTIP 128 Description 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 characters 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 The PayPal acquirer allows PayPal Payments Advanced and PayPal Payments Pro merchants to run transactions using any of the following six currencies with a single account AUD Australian dollar CAD Canadian dollar EUR Euro GBP British pound JPY Japanese Yen USD US dollar Limitations Three characters Optional Identification code for
27. 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 192 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions D Cielo Payments Purchasing Card Transaction Processing Parameter Description 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 The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wikiISO_3166 1 numeric Character length and limitations 3 alphanumeric characters VATR
28. MICR 3 333333333 amp AUTHTYPE I1 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 98 776542143 amp VERBOSITY HIGH RESULT 0 amp PNREF EQ RB8A32CD69 amp RESPMSG Approved amp AUTHCODE 12 amp TRACEID 1234567890 amp ACHSTATUS A amp HOST CODE 07 amp TRANSTIME 2 012 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 0ORIGID E QORB8A32CD6 9 amp VERBOS ITY HIGH RESULT 0 amp PNREF EQRB8A3 2 CD6A amp RES PMSG Approved amp AUTHCODE 0 0 amp TRACEID 1234567890 S amp ACHSTATUS A amp HOSTCODE 07 amp TRANSTIME 2012 02 09 15 24 22 Gateway Developer Guide and Reference 07 January 2014 147 148 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 149 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 m
29. Order date Format is mmddyy with no slashes or dashes For example July 28 2003 is 072803 Character length and limitations 6 numeric characters 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions D 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 S IG 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 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 BILLTOSTATE Optional Cardholder s state Cha
30. 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 07 January 2014 55 5 Sending a Simple Transaction to the Server Sale Transaction Example Sale Transaction Example In addition to the required connection and user parameters each transaction type may require other parameters and can include a number of optional parameters To perform a sale transaction involving a 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 e 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 Pwd4Gateway amp PARTNER PayPal amp ACCT 5105105105105100 amp EXPDATE 1215 amp AMT 23 45 amp COMMENT1 Airport Shuttle amp BILLTOFIRS TNAME Jamie amp BILLTOLASTNAME M11ler amp BILLTOSTREET 123 Main St amp BILLTOCITY San Jose a
31. PAYPAL NVP Y in the request header Declaring PAYPAL NVP Y in the request header is required when passing negative discount amounts to PayPal through Payflow Please note that passing PAYPAL NVP Y in the request header changes the format of the response message you receive from Payflow For example if PAYPAL NVP Y is NOT declared in the header the Payflow response message is formatted as follows RESULT 0 amp RESPMSG Approved amp TOKEN EC 868676987383 93917 amp CORRELATIONID 5f 817d830101 If the request header PAYPAL NVP Y is declared the response returned from Payflow includes bracketed numbers next to the names of the response parameters These bracketed numbers are length tags indicating the length of the values returned The following is a response message that contains length tags RESULT 0 amp RESPMSG Approved amp TOKEN 20 EC 97J718043X120051H amp TIMESTAMP 20 2012 10 11T15 19 37Z amp CORRELATIONID 13 274 8d4493dbe amp ACK 7 Success amp VERSION 4 92 0 amp BUILD 7 3893058 You can also use length tags in the Payflow request message to pass the special characters of amp and in the values sent See Using Special Characters In Values on page 53 for more information Express Checkout for Payflow For information on using the PayPal Express Checkout API with Payflow see the Express Checkout for Payflow integration guide Gateway Developer Guide and Reference 07 January 2014 155 156 Payflo
32. Parameters on page 121 e First Data Merchant Services Nashville Additional Credit Card Parameters on page 122 e First Data Merchant Services North Additional Credit Card Parameters on page 122 e Heartland Additional Credit Card Parameters on page 123 e Litle Additional Credit Card Parameters on page 123 e Cielo Payments Additional Credit Card Parameters on page 125 e Paymentech Salem New Hampshire Additional Credit Card Parameters for American Express on page 125 e PayPal Credit Card Transaction Request Parameters on page 128 e SecureNet Additional Credit Card Parameters for American Express on page 133 e Vantiv Additional Credit Card Parameters on page 138 e WorldPay Additional Credit Card Parameters on page 140 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 parameters 1f 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 1s a line item number from 1 to 6 Character length and limitations 19 alphanumeric characters Gateway Devel
33. PayPal Payments Pro merchants using Fraud Protection Service FPS 31 Oct 2013 Submitting Account Verifications is now supported by the PayPal processor Added the CCTRANSID and CCTRANS POSDATA response fields to Credit Card Transaction Responses currently supported for TSYS processor only and are useful for merchants who authorize transactions through the Gateway but settle through a third party Clarified in the Example Reference Transaction section that the capture step of a reference transaction does not require the TENDER parameter Clarified that the duration of the Secure Token is 30 minutes Added a new section for Payflow Gateway FAQs 20 Sep 2013 Updated the character limits for billing and shipping address fields These limits are different for the PayPal acquirer PayPal Credit Card Transaction Request Parameters compared with all other processors Core Credit Card Parameters Provided clarification on which Country Codes to use for each of the following the PayPal acquirer TeleCheck FDMS South and for all other processors Added a section on the The PayPal Manager Website 19 Jul 2013 Removed the ACCTTYPE parameter from this guide Gateway Developer Guide and Reference 07 January 2014 17 a Revision History Date Description 11 Jul 2013 Maintenance release Added a new section on Processor specific Response Parameters which includes Litle Response Parameters and information on the Litle Auto
34. 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 PayFlow Pro 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 39 B New Payflow Pro users can take advantage of all of 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 07 January 2014 15 Intended Audience service Summary Service Status Mode Hosted Checkout Pages Live Payflow SDK API 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 amp Payflow SDK API Limited Access Service Summary Service Status Mode O PayPal Payments Advanced Live Hosted Checkout
35. 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 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 07 January 2014 Gateway Developer Guide and Reference Introducing the Gateway Checkout Solutions About Security 1 PARC Company 1 Company Merchant s Site as Customer Gateway Server Payment Processing Network Numbers 1n the figure correspond to the numbered comments below 1 The customer clicks Buy to purchase merchandise on your website 2 You request a secure token by passing a token ID to the Gateway server 3 The Gateway server returns the secure token and your token ID to your website 4 You submit the secure token and token ID in an HTTP
36. Required for Force transactions Authorization date Character length and limitations 1 1lalphanumeric characters CUSTOMERID Optional Customer identification Character length and limitations 18 alphanumeric characters Gateway Developer Guide and Reference 07 January 2014 123 Processors Requiring Additional Transaction Parameters Litle Additional Credit Card Parameters Field INVNUM MERCHANTCITY MERCHANTURL MERCHDESCR MERCHSVC PONUM REPORTGROUP BILLTOSTREET2 BILLTOSTREETS TAXAMT TAXEXEMPT Description 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 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 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 Optional Use this parameter to pass in you
37. 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 Gateway Developer Guide and Reference 07 January 2014 61 6 Submitting Credit Card Transactions Core Credit Card Parameters Parameter EXPDATE Description Required Expiration date of the credit card For example 1215 represents COMMENT COMMENT2 CVV2 RECURRING 62 December 2015 Limitations mmyy format 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 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 1n 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 t
38. Solutions 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 Cielo Payments 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 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 NATIONALTAXAMT Optional National tax amount Character length and limitations 12 numeric characters INVNUM Required Purchase order number customer reference ID The Transaction ID is sent if no value is provided Character length and limitations 9 alphanumeric characters Cielo Payments
39. The item s supplier stock keeping unit SKU number n is a line item number from to 6 Character length and limitations 1 to 30 alphanumeric characters Required Quantity invoiced n is a line item number from 1 to 6 Character length and limitations 1 to 10 numeric characters Required Unit of measure n is a line item number from to 6 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions D Paymentech Tampa Level 2 Purchasing Card Transaction Processing Paymentech Tampa Level 3 Parameters Description L COST1 Required Unit price n is a line item number from 1 to 6 Character length and limitations 9 numeric characters plus a decimal point 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 L DISCOUNT1 Required Discount per line item n is a line item number from 1 to 6 Character length and limitations 9 numeric characters plus a decimal point 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 L AMT1 Required Total line item amount including tax and discount The amount should be a positive number for debits and a negative number for credits n is a line item number from 1 to 6 Character length and limitations 9 numeri
40. VAT tax amount freight shipping Character length and limitations 12 numeric characters VATTAXRATE 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 L ALTTAXRATEN Optional Alternate tax rate for this item Character length and limitations 4 numeric characters plus decimal XX XX L ALTTAXIDn Optional Alternate tax identifier for this item Character length and limitations 95 alphanumeric characters L EXTAMTn Optional Extended item amount Character length and limitations 8 numeric characters L TAXTYPEn Optional Tax type applied Character length and limitations 4 alphanumeric characters L COMMCODEN Optional Item commodity code Character length and limitations 35 alphanumeric characters Gateway Developer Guide and Reference 07 January 2014 219 220 Submitting Purchasing Card Level 2 and 3 Transactions WorldPay Purchasing Cards Transaction Processing Level 3 Parameters L DESCN L AMTn L SKUN L QTyn L CARRIERSERVICELEV ELCODEN L COSTN L UOMN L TAXAMTN L TAXRATEN Description Optional Item description Character length and
41. a a a a a a 138 WorldPay Additional Credit Card Parameters a aoa a oa a a a a a a eee eee 140 Chapter B TeleCheck Electronic Check Processing 141 TeleCheck NFTF Overview of Services o oo a a a a 141 TeleCheck NFTF Processing Overview aoaaa a a a a a 141 NFTF Requirements aaoo a 141 NFTF Processing Considerations 2 2 a 143 NFTF Guidelines 2 a a a a a a a 143 TeleCheck Parameters o oo aoaaa a a a a a a a a a 144 Required TeleCheck Parameters 1 a a a 145 Testing TeleCheck Transactions noa oaoa a oa a a a a a a a a 147 Example Test Transaction 2 2 oa a a a a a 147 Preparing for TeleCheck Production Transactions o oa aoao a a a 000 sees 148 Responses to TeleCheck Transactions 0 2 00 0 2 eee ee ee ee 148 Transaction Responses Common to All Tender Types 148 Response Code Values onoo 149 Sale Response Code Values 1 2 ee 149 Adjustment Code Values 2 aoao a a 150 Response Codes For Status Response Packets 2 150 TeleCheck Authorization Requirements 2 2 ee 151 Authorization Sales Consent 2 aoao a a a a a 151 Authorization Sales Decline Error o aoao a a a a a a a 154 Chapter C Payflow Header Parameters 54 155 Sending Requests Directly to PayPal Bypassing Payflow 155 Posting Transactions Directly Without the Payflow SDK 156 T
42. a message in name value format Connection close Server VPS 3 028 00 Date Mon 16 May 2005 22 48 06 GMT Content Type text name value Gateway Developer Guide and Reference 07 January 2014 159 Payflow Header Parameters Posting Transactions Directly Without the Payflow SDK Content Length 145 X VPS REQUEST ID Same ID as sent Name Value Pair Transaction Response Body The transaction response body contains the response to the request The following 1s an example response body in name value format RESULT 0 amp PNREF V5 3A0A3 0B542 amp RESPMSG Approved amp AUTHCODE 8 82 PNI SAVSADDR X amp AVSZ IP X amp IAVS X amp PREFPSMSG No Rules Triggered amp POSTFPSMSG No Rules Triggered Integrator Provided Data These headers are extensions to the Payflow message protocol The extension parameters describe the specific version of a client and the client s environment Send the applicable parameters to PayPal in the transaction request headers NOTE The parameters in this section are not required but it is highly recommended you send them Payflow Recommended Headers Header Name X VPS VIT INTEGRATION PRODUCT X VPS VIT INTEGRATION VERSION X VPS VIT OS NAME X VPS VIT OS VERSION Description Identifies the integration product that calls the PayPal server Format String Examples iPayment ColdFusion MIVA shopping cart Default Value Blank Version of the software as defined by the integrator vendor
43. 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 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 NA
44. adjustment transaction is submitted that has the same merchant trace ID as a previously submitted adjustment transaction If a duplicate 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 07 January 2014 143 O B TeleCheck Electronic Check Processing TeleCheck Parameters Transaction flow Method Messages sent
45. amp DISCOUNT 0 OOSALTERNATE TAXID 0 amp TAXEXEMPT N amp CUSTCODE XY2Z1903 amp L COMMCODE1 55121600 amp L DESC1 LABEL 100 X100 FLAM SOLID SINGLES amp L PRODCODE1 HML5SS amp L OTY1 50 amp L UOM1 KSH amp L COST1 0 16 amp L DISCOUNT1 0 00 amp L AMT1 8 10 amp L UPC1 1 amp L NGI1 Y amp L TAXAMT1 1 00 Gateway Developer Guide and Reference 07 January 2014 203 SecureNet Purchasing Card Transaction Processing o D Submitting Purchasing Card Level 2 and 3 Transactions SecureNet Purchasing Card Transaction Processing SecureNet supports MasterCard and Visa for 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 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 O
46. amp KSN 9011400B02AA0E00002B amp MPSTAT US 3162209 amp ENCRYPTIONBLOCKTYPE 1 amp REGISTEREDBY PayPa1 amp MAGTEKCARDTYPE 1 amp DEVICESN B02AA0E12151 See the Encrypted Card Swipe Transactions Request Parameters for more information Response If successful the response will contain the standard Payflow response parameters for your transaction type RESULT 0 amp PNREF V24A0A55E168 amp RESPMSG Approved amp AUTHCODE 098PNIOOPN amp HOS TCODE A amp VISACARDLEVEL 12 If you do not pass the required MagTek parameters you will see RESULT 7 in the response along with a MagTek specific error message such as MAGTRESPONSE H178 ENCTRACK2 has incorrect format See the Encrypted Card Swipe Transactions Response Parameters for more information Qwick Code PCode Payflow Example The purpose of this example is to show you how to format a request You cannot use the values in this example for testing You must have a MagTek test Qwick Code or live Qwick Codes to send a request to the Payflow Gateway Please contact MagTek for more Qwick Code information Request This request contains regular Payflow parameters along with required MagTek parameters Gateway Developer Guide and Reference 07 January 2014 253 Payflow Gateway MagTek Parameters Parameters for Encrypted Card Swipe Transactions TRXTYPE ASTENDER C amp VENDOR MerchantUserID amp PARTNER PayPal amp USER UserIDI fAvailOrSameAsVendor amp PWD Pwd4Gateway amp VERBOSITY HIGH amp
47. amp PONUM P09876 amp CREATESECURETOKEN Y amp SECURETOKENID 9a9ea8208del1 413abc3d60c86cb1f4c5 The Gateway server returns SECURETOKEN and SECURETOKENID 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 F 1AFUW t0 I0CUFOKh5WA amp SECURET OKENID 9a49 ea8208de1l413abc3d60c86cb1lf4c5 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 Card Transactions on page 57 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 07 January 2014 Gateway Developer Guide and Reference Secure Token Secure Token Errors NOTE The secure token 1s 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 SE
48. 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 1n 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 AMTn Optional Amount of this line item including tax where n 1s a line item number from 1 to 99 L AMTn L TAXAMTn line item total Character length and limitations The decimal 1s implied If for example you specify 500 this value is equivalent to 5 00 8 numeric characters 186 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions Litle Purchasing Card Transaction Processing D Field Description L COMMCODEN Optional Identifier assigned by the card acceptor that categorizes the purchase
49. 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 53 NOTE SWIPE card present transactions are not supported by the PayPal processor Limitations Alphanumeric and special characters 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 duplicate orders processed within seconds of each other Use ORDERID with Request ID to prevent duplicates as a result of processing or communication errors 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
50. 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 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 oe Y yes e N n0 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 BILLTOFIRSTNAME BILLTOLASTNAME Description 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 characters 07 January 2014 Gateway Developer Guide and Reference Pro
51. 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 07 January 2014 167 o D Submitting Purchasing Card Level 2 and 3 Transactions American Express Purchasing Card Transaction Processing Field Description MERCHANTCITY Optional The name of the city were the transaction took place 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 1s 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 1s 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 b
52. 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 Cielo Payments 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 00 amp BILLTOSTREET 5199 JOHNSON amp BILLTOZIP 94588 amp ALTTAX AMT 1 00 amp CUSTVATREGNUM 11111 amp LOCALTAXAMT 1 00 amp NATIONALTAXAMT 1 00 amp COMMCODE 22222 amp VATAXAMT 1 00 amp VATAXPERCENT 10 amp TAXEXEMPT Y amp DISCOUNT 1 00 amp FREIGHTAMT 1 OOS amp DUTYAMT 1 00 amp SHIPTOZIP 3 3333 amp SHIPFROMZI P 44444 amp SHIPTOCOUNTRY 84 0 amp ORDERDA TE 020725 amp L COMMCODE1 123456789ABC amp L DESC1 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 Gateway Developer Guide and Reference 07 January 2014 191 o D Submitting Purchasing Card Level 2 and 3 Transactions Cielo Payments Purchasing Card Transaction Processing Cielo Payments Level 3 Visa Parameters For Cielo Payments formerly Merchant e
53. 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 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 d
54. from which shipping occurs Character length and limitations 10 alphanumeric characters SHIPTOCOUNTRY Optional Destination country code The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wikiISO_3166 1 numeric Character length and limitations 3 alphanumeric characters 190 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions Cielo Payments Purchasing Card Transaction Processing D Parameter Description ALTTAXAMT Optional Alternate tax amount Character length and limitations 9 numeric characters Cielo Payments Level 3 MasterCard Line Item 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 QTYn Required Quantity Character length and limitations 12 numeric characters L UOMn Required Unit of measure code Character length and limitations 12 alphanumeric characters L COSTN Required Unit cost Character length and limitations 12 numeric
55. 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 Ifthe above 1s 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 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 Cha
56. 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 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 Gateway 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 BILLTOSTREET ADDRESSTOSHIP SHIPTOSTREET AMOUNT AMT AVSDATA AVSADDR and AVSZIP CARDNUM ACCT CITY BILETOCITY CITYTOSHIP SHIPTOCITY COUNTRY BILLTOCOUNTRY COUNTRYTOSHIP SHIPTOCOUNTRY CSC CVV2 CSCMATCH CVV2MATCH DESCRIPTION N A EMAIL BILLTOEMATL Gateway Developer Guide and Reference 07 January 2014 249 250 Payflow Link Migration Migrating from a legacy Payflow Link Integ
57. numeric L DISCOUNTN Optional Discount amount Character length and limitations numeric L UPCn Optional Item commodity code L CoSTn Optional Unit cost Character length 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 548018000000 0024 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 OO amp FREIGH TAMT 2 OO amp SDUTYAMT 3 OO amp SHIPTOZIP 94543 amp SHI PTOCOUNTRY 84 0 amp SHI PFROMZTP 94509 amp ALTERNATETAXTD 10 amp ALTERNATETAXAMT 4 00 amp L DESC1 MC Pcard amp L UPC1 1 amp L QTY1 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 TRXTY PE 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 OO amp FREIGH TAMT 2 OO amp SDUTYAMT 3 OO amp SHIPTOZIP 94543 amp SHI PTOCOUNTRY 84 0 amp SHI PFROMZTP 94509 amp DISCOUNT 4 OO amp VATAXAMT 5 OO amp VATAXPERCENT 10 amp L DESC1 TSYS Acquiring Solution Ss P
58. 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 with the processor American Express processor only Character length and limitations 1 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 1 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 1s returned in the response for inquiry transactions only TRXTYPE 1 100 07 January 2014 Gateway Developer Guide and Reference Transaction Responses Address Verification Service Responses From PayPal 8 Field Description PAYMENTADVICECODE A processor response code
59. partner permissions Insufficient user permissions Invalid XML document This could be caused by an unrecognized XML tag or a bad XML format that cannot be parsed by the system Duplicate transaction Error in adding the recurring profile Error in modifying the recurring profile Error in canceling the recurring profile Error in forcing the recurring profile Error in reactivating the recurring profile OLTP Transaction failed 07 January 2014 Gateway Developer Guide and Reference Transaction Responses 8 RESULT Values and RESPMSG Text RESULT RESPMSG and Explanation 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 1s 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 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 authoriz
60. 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 6 The Gateway processes the payment through the payment processing network 7 The Gateway server transparently returns the customer to the location on your website that you specified in the request to obtain a secure token You display the results to the customer on your website 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 71 PCI Compliance Without Hosted Pages 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 Gateway Developer Guide and Reference 07 January 2014 29 30 Introducing the Gateway Checkout Solutions The PayPal Manager Website Implementing Transparent Redirect is
61. 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 DESC MERCHDESCR Description 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 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 07 January 2014 Gateway Developer Guide and Reference Processors Requiring Additional Transaction Parameters Heartland Additional Credit Card Parameters A Field Description MERCHSVC Optional Defaults to the city where the merchant outlet is located for retail and to the
62. s records but the zip code does not The AVSZIP response is N RESULT 0 amp PNREF VXW4 12345678 amp RES PMSG APPROVED amp AUTHCODE 123 456 amp AVSADDR Y amp AVSZ IP N amp 1AVS X 07 January 2014 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 1n 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 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 sec
63. the PCode Authentication Value 3 generated with the PCode Purchaser s email address The last name of the card holder encoded in the card The billing zipcode MagTek username MagTek password Shipping zipcode Data Type String String String String String String String String String String String String Length 1 to 40 characters 4 characters 8 character alphanumeric Gateway Developer Guide and Reference 07 January 2014 257 208 Payflow Gateway MagTek Parameters MagTek Error Codes and Messages Qwick Code PCode Transactions Response Parameters Field Description Data Type MAGTRESPONSE This only appears in the String response if a data validation error occurs or if the MagTek processor throws an error Notes See the error codes below for more information MagTek Error Codes and Messages If an error occurs you will see one of the following error codes in the MAGTRESPONSE response parameter Encrypted Card Swipe Transactions Input Validation Error Codes Error Message Notes H023 REGISTEREDBY has incorrect length H024 REGISTEREDBY has incorrect format H176 ENCTRACK1 has incorrect format H177 ENCTRACK1 has incorrect length H178 ENCTRACK2 has incorrect format H179 ENCTRACK2 has incorrect length H180 ENCTRACK3 has incorrect format H181 ENCTRACK3 has incorrect length H182 ENCMP has incorrect format H183
64. the Primary email address on the account to payflow support paypal com Limitations 127 alphanumeric characters 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 send an email from the Primary email address on the account to payflow support paypal com 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 characters 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 if L COSTn is supplied Line item quantity NOTE To enable line item support send an email from the Primary email address on the account to payflow support paypal com Limitations 10 character integer 130 07 January 2014 Gateway Developer Guide and Reference Processors Requiring Additional Transaction Parameters PayPal Credit Card Transaction Request Parameters A Parameter Description L SKUn Optional Product number NOTE To enable line item support send an email from the Primary email address on the account to payflow support paypal com Limitations 18 characters L TAXAMTn Optional Line item tax amount NOTE T
65. time out waiting for response 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 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 Original transaction ID not found The transaction ID you entered for this transaction is not valid See RESPMSG Cannot find the customer reference number Invalid ABA number Invalid account number Check credit card number and bank account number and re submit Invalid expiration date Check card expiration date and re submit 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 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 Insufficient
66. typically returned on declined recurring transactions Its purpose is to provide merchants with information and specific instructions on how to handle the decline It is the merchant s responsibility to follow the instructions provided in order to avoid chargebacks For details on the meanings of these codes see https merchant paypal com us cgi bin amp cmd _render content amp content ID merchant cc compliance error codes NOTE Ifa recurring transaction is declined with a returned PAYMENTADVICECODE value of 03 or 21 it is the merchant s responsibility to stop this recurring transaction These two codes indicate that either the account was closed fraud was involved or the cardholder has asked the bank to stop this payment for another reason Even if a reattempted transaction is successful it will likely result in a chargeback TRANSSTATE State of the transaction sent in an Inquiry response The values are e 0 Account Verification no settlement involved 1 General error state 3 Authorization approved 4 Partial capture 6 Settlement pending transaction 1s scheduled to be settled 7 Settlement in progress transaction involved in a currently ongoing settlement 8 Settled successfully 9 Authorization captured once an authorization type transaction is captured its TRANSSSTATE becomes 9 e 10 Capture failed an error occurred while trying to capture an authorization because the transaction was already captured e
67. 0 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 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 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions D TSYS Acquiring Solutions Purchasing Card Transaction Processing 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 NATIONALTAXA
68. 014 Gateway Developer Guide and Reference Testing Transactions T Processors Other Than PayPal 7 RESULT value Definition How to test using Payflow Gateway 114 CVV2 Mismatch Use the AMOUNT 1114 Only applies to TSYS Acquiring Solutions Cielo Payments formerly 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 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 RA 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
69. 1 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 DISCOUNTI 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 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 Gateway Developer Guide and Reference 07 January 2014 209 o D Submitting Purcha
70. 1051051051051008AMT 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 BILLTOZIP 94043 amp CUSTCODE 123456 amp TAXAMT 1 34 Global Payments East Purchasing Card Transaction Processing Global Payments East 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 07 January 2014 179 o D Submitting Purchasing Card Level 2 and 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 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 1LO amp BILLTOCITY Mountain View amp COMMENT1 L2 Tes
71. 2 a a a a 52 Chapter 5 Sending a Simple Transaction to the Server 53 About Name Value Pairs 2 a a a 53 Using Special Characters In Values oa oa oaoa oa a a a a a a 53 Name Value Parameter Syntax Guidelines a a a a 54 Do Not URL Encode Name Value Parameter Data a oaoa aa a a a a a 54 Payflow Connection Parameters oa oaoa ao a a a a a a a a a a a 54 User Parameter Data oao aoao a a a a a a a a 55 Sale Transaction Example oa aooaa a a a a a 56 Typical Sale Transaction o aoao a a a a a a a a 56 Formatting Payflow Gateway Transactions aoa oaoa a a a 0 a a a a 56 Chapter 6 Submitting Credit Card Transactions 57 Obtaining an Internet Merchant Account n aoao aoao a a a a a 58 About Credit Card Processing aoa oaoa a a a a a a a a a a 58 Credit Card Features a oaoa aoa a a a a a 59 Planning Your Gateway Integration a a oaoa a a a a a a a a a a 59 Complying With E commerce Indicator oa aoao a a a a a a a 60 4 07 January 2014 Gateway Developer Guide and Reference Content a Handling Credit Card Type Information a 02 ee eee 60 Core Credit Card Parameters 2 2 a a a a a a a 61 Submitting Account Verifications 2 aoa a a a a a a a a 64 When To Use Account Verifications a aoao a a a a a 64 Required Account Verification Parameters aoao a a a a a a a a a 64 Example Account Verification String a ao
72. 4 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 Guide and Reference 07 January 2014 181 o D Submitting Purchasing Card Level 2 and 3 Transactions Heartland Purchasing Card Transaction Processing Parameter Description NATIONALTAXAMT Optional National tax amount You may omit this parameter 1f 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 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 Chara
73. 5 e Visa Country Codes on page 232 e Units of Measure on page 239 MasterCard Country Codes for FDMS South Only ALBANIA ALB ALGERIA DZA AMERICAN SAMOA ASM ANDORRA AND ANGOLA AGO ANGUILLA ATA 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 07 January 2014 225 226 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 CHINA CHRISTMAS ISLAND CMEROON UNITED REP COCOS KEELING ISLANDS COLOMBIA COMOROS CONGO COOK ISLANDS COSTA RICA COTED TVOIRE CROATIA BLZ BEN BMU BIN 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 07 January 2014 Gateway Developer Guide and Reference Codes Used by FDMS South Only MasterCard Country Codes for FDMS South Only a CYPRUS CYP CZECH REPUBLIC CZE DENMARK DNK DJIBOUTI DJI DOMINICA DMA DOMINICAN REPUBLIC DOM EL SALVADOR SLV EQUATORIAL GUINEA GNQ ESTONIA EST ETHIOPIA ETH F
74. 55555555554444 amp EXPDATE 1215 amp AMT 123 OO amp VERBOSITY HIGH 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 07 January 2014 Gateway Developer Guide and Reference Submitting Credit Card Transactions Submitting Inquiry Transactions 6 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 ACCT AMT BILLTOCITY BILLTOCOUNTRY BILLTOEMAIL BILLTOMIDDLENAME BILLTOLASTNAME BILLTOPHONENUM BILLTOSTATE BILLTOSTREET BILLTOZIP COMMENT 1 COMMENT2 COMPANYNAME CUSTCODE CUSTIP EXPDATE INVNUM PONUM SHIPTOCITY SHI PTOCOUNTRY SHIPTOFIRSTNAME SHIPTOMIDDLENAME SHIPTOLASTNAME SHIPTOSTATE SHIPTOSTREET SHIPTOZIP SWIPE Submitting Inquiry Transactions An inquiry transaction TRXTYPE T returns the result and status of a transaction When To Use an Inquiry Transaction You perform an inquiry using a reference to a
75. 567890 amp PONUM C12345 amp VERBOSITY HIGH Besides the required parameters that you pass 1n 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 CV V2 parameter For details on address verification service and card security code see the following e Submitting Card Present SWIPE Transactions on page 67 e Using Card Security Code on page 85 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 of hiking boots online from Hiker s Duds in San Jose California and charges them to his credit card The transaction goes to the aggregat
76. 6 117 118 120 121 122 125 RESPMSG and Explanation 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 Duplicate suppression time out 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 1f 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 reversal credit a payment or submit a payment for a credit 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 Referenced auth against order Error 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 Failed AVS check Address and zip code do not match An authorization may still exist on the cardholder s account Merchant sale total will exceed the sales cap with current transaction ACH transactions only Card Security Code CSC Mismatch An authorization may still exi
77. 94588 amp ALTTAX AMT 1 00 amp CUSTVATREGNUM 11111 amp LOCALTAXAMT 1 OO amp NATIONALTAXAMT 1 00 amp COMMCODE 22222 amp VATAXAMT 1 OO amp VATAXPERCENT 1 0 amp TAXEXEMPT Y amp DISCOUNT 1 OO amp FRE IGHTAMT 1 OO amp DUTYAMT 1 OO amp SHIPTOZIP 33333 amp SHIPFROMZIP 44444 amp SHI PTOCOUNTRY 84 0 amp ORDERDA TE 020725 amp L COMMCODE1 123456789ABC amp L DESC1 Line item 1 description amp L UPC1 C BA987654321 amp L OTY1 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 206 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions SecureNet Purchasing Card Transaction Processing D O SecureNet Level 2 Visa Parameters for Level 3 Line Item Transactions Parameter Description PONUM Required Purchase identifier The transaction ID is sent
78. A MONGOLIA MONTSERRAT MOROCCO MOZAMBIQUE MYANMAR NAMIBIA NAURU NEPAL NETHERLANDS NETHERLANDS ANTILLES NEW CALDONIA NEW ZEALAND LI LT LU MO MK MG MW MY MV ML MT MC MH MQ MR MU YT MX FM MD MN MS MA MZ MM NA NR NP NL AN NC NZ 07 January 2014 Gateway Developer Guide and Reference Codes Used by FDMS South Only Visa Country Codes CE 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 07 January 2014 23 238 Codes Used by FDMS South Only Visa Country Codes ST HELENA ST KITTS NEVIS ANGUILLA ST LUCIA ST PIERRE AND MIQUELON ST VINCENT AND THE GRENADINES SUDAN SURINAME SVALBARD AND JAN MAYEN IS SWAZILAND SWEDEN SWITZERLAND SYRIAN ARAB REPUBLIC TAIWAN PROVIDENCE OF CHINA TAJIKISTAN TANZANIA UNITED REPUBLIC THAILAND TOGO TOKELAU TONGA TRINIDAD AND TOBAGO TUNISIA TURKEY TURKMENISTAN TURKS AND CAICOS ISLANDS TUVALU U S MINOR OUTLYING ISL UGANDA UKRAINIAN SSR UNITED ARAB EMIRATES UNITED KINGDOM UNITED
79. A 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 07 January 2014 231 232 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 RHO Visa Country Codes ALBANIA ALGERIA AMERICAN SAMOA ANDORRA ANGOLA ANGUILLA ANTARCTICA ANTIGUA APHGANISTAN ARGENTINA ARMENIA ARUBA AUSTRALIA AUSTRIA AZERBAIJAN BAHAMAS BAHRAIN BANGLADESH BARBADOS BELARUS BELGIUM AL DZ AS AD AO AI AQ AG AF AR AM AW AU AT AZ BS BH BD BB BY BE 07 January 2014 Gateway Developer Guide and Reference Codes Used by FDMS South Only Visa Country Codes CE BELIZE BZ BENIN BJ BERMUDA BM BHUTAN BT BOLIVIA BO BOSNIA AND HERZEGOVINA BA BOTSWANA BW BOUVET ISLAND BV BRAZIL BR BRITISH INDIAN OCEAN TERRITORY IO BRUNEI BN BULGARIA BG BURKINA FASO BF BURUNDI BI CAMBODIA KH CANADA CA CAPE VERDE CV CAYMAN ISLANDS KY CENTRAL AFRICAN REPUBLIC CF CHAD TD CHILE CL CHINA CN CHRISTMAS ISLAND CX CMEROON UNITED REP CM COLOMBIA CO COMOROS KM CONGO CG COOK ISLANDS CK COSTA RICA CR COTEDIVOIRE CI CROATIA HR CYPRUS CY Gateway Developer Guide and Reference 07 January 2014 233 234
80. AEROE 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 07 January 2014 221 228 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 LITHUANIA LUXEMBOURG GNB GUY HTI HMD HND HKG HUN ISL IND IDN IRN IRQ IRL ISR ITA JAM JPN JOR KAZ KEN KOR KWT KGZ LAO LVA LBN LSO LBR LBY LIE LTU LUX 07 January 2014 Gateway Developer Guide and Reference Codes Used by FDMS South Only MasterCard Country Codes for FDMS South Only MACAU MALAYSIA MALDIVES MALI MALTA MANACO MARSHALL ISLANDS MARTINIQUE MAURITANIA MAURITIUS MEXICO MICRONESIA MOLDOVA MONGOLIA MONTSERRAT MOROCCO MOZAMBIQUE MYANMAR NAMIBIA NAURU NEGEL NEPAL NETHERLANDS NETHERLANDS ANTILLES NEW CALEDONIA NEW ZEALAND NICARAGUA NIGER NIGE
81. AMT 18 amp SWIPEDECR HOST MAGT amp PCODE 2 3456789 amp MERCHANTID MerchantID123 amp MERCHANTNAME Merch antName amp PAN4 1234 amp BILLTOLASTNAME Mi 1 Ller amp MAGTEKUSERNAME MagTekUserNam e amp MAGTEKPWD MagTekPwd amp BILLTOEMAIL jmiller anyemailprovider com amp BILLT OZTP 95131 amp SHIPTOZIP 94089 amp AUTHVALUE1 123 4 SAUTHVALUE2 5678 SAUTHVALUE 3 9012 See the Qwick Code PCode Transactions Request Parameters for more information Response If successful the response will contam the standard Payflow response parameters for your transaction type RESULT 0 amp PNREF V24A0A55E1 9C amp RESPMSG Approved amp AUTHCODE 4 74 PNI00PN amp HOS TCODE A amp VISACARDLEVEL 12 If you do not pass the required MagTek parameters you will see RESULT 7 in the response along with a MagTek specific error message such as MAGTRESPONSE H3 64 MERCHANTID has incorrect format See the Qwick Code PCode Transactions Response Parameters for more information Parameters for Encrypted Card Swipe Transactions Encrypted Card Swipe Transactions Request Parameters Field Required Description Data Type Length ENCMP Required Encrypted String MagnePrint Information returned by a MagneSafe device when a card is swiped 254 07 January 2014 Gateway Developer Guide and Reference Payflow Gateway Mag Tek Parameters Parameters for Encrypted Card Swipe Transactions Field Required ENCRYPTIONBLOCK Required TYPE ENCTRACK2 Required KSN Requir
82. ATREGNUM 11111 amp LOCALTAXAMT 1 OLENATIONALTAXAMT 1 02 amp COMMCODE 22222 amp VATAXAMT 1 O3 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 130125 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 DISCOUNTI 50 amp L AMT1 1 00 amp L TAXTYPE1 TT1 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 The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wiki ISO_3166 1 numeric Character length and limitations 3 alpha characters Gateway Developer Guide and Reference 07 January 2014 215 Submitting Purchasing Card Level 2 and 3 Transactions Vantiv Purchasing Card Transaction Processing Field Description DISCOUNT Optional Discount amount on total sale Character length and limitations 10 currency characters DUTYAMT 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 separ
83. AUTHVALUE3 mismatch Problem with Reader Data Notes This Protection Code has already been revoked BILLTOLASTNAME mismatch MAGTEKUSERNAME given does not match the one stored MAGTEKPWD given does not match the one stored BILLTOEMAIL given does not match the one stored BILLTOZIP given does not match the one stored SHIPTOZIP given does not match the one stored AUTHVALUE1 given does not match the one stored AUTHVALUE2 given does not match the one stored AUTHVALUE3 given does not match the one stored This occurs if there is a problem while decrypting the Data 260 07 January 2014 Gateway Developer Guide and Reference Payflow Gateway FAQs Frequently Asked Questions e How do I determine the version of the Payflow Gateway SDK I have See this Merchant Technical Support MTS knowledge base article to determine your Payflow SDK version e How do I contact Payflow Support Go to https manager paypal com jsp common contactUs jsp for the Payflow Support phone number for your region e What do the error codes 1 and 31 mean See this Merchant Technical Support MTS knowledge base article for more information about these error codes Gateway Developer Guide and Reference 07 January 2014 261
84. CHA 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 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 07 January 2014 Gateway Developer
85. COUNT 25 amp DUTYAMT 34 00 amp FREI GHTAMT 12 OOS INVNUM 123456789 amp ORDERDATE 021 70 0 amp PONUM 1234567890123456789012 345 amp SHIPFROMZIP 940151234 amp SHIPTOZIP 94065 amp TAXAMT 1 OO amp TAXEXEMPT Y amp L OTY1 1 amp L UPC1 PN amp L DESC1 Test amp L UOMI INO amp L COST1 1 00 amp L PRODCODE1 12345 amp L DISCOUNT 1 25 amp amp L AMT1 75 amp L TAXAMT1 0 178 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions D 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 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 Example Global Payments Central Level 2 Visa or MasterCard Transaction Parameter String TRXTYPE S amp ACCT 5
86. CURETOKENID to a unique alphanumeric value up to 36 characters in length SECURETOKENID 9a9ea8208de1l413abc3d60c86cblf4c5 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 1413abc3d60c86cb1f4c5 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 value returned RESULT 0 amp RESPMSG Approved amp SECURETOKEN 25 F 1AFUW t0 1I0CUFOKh5WA amp SECURET OKENID 9a9ea8208del1413abc3d60c86cbh1f4c5 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 If you are using the PARMLIST parameter with the Transparent Redirect see Using the PARMLIST Parameter on page 46 for more i
87. 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 The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wiki ISO_3166 1 numeric 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 SHI PTOPHONENUM 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 characters use proper and meaningful abbreviation Do not truncate Gateway Developer Guide and Reference 07 January 2014 117 A Processors Requiring Additional Transaction
88. 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 FUI 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 07 January 2014 Gateway Developer Guide and Reference Codes Used by FDMS South Only Visa Country Codes CE GUATEMALA GT GUINEA GN GUINEA BISSAU GW GUYANA GY HAITI HT HEARD AND MCDONALD ISLANDS HM HONDURAS HN HONG KONG HK HUNGARY HU ICELAND IS INDIA IN INDONESIA ID IRAN IR IRAQ IQ IRELAND IE ISRAEL IL ITALY IT JAMAICA JM JAPAN JP JORDAN JO KAZAKHSTAN KZ KENYA KE KIRIBATI KI KOREA REPUBLIC OF KR KUWAIT KW KYRGYZSTAN KG LAO PEOPLES DEMOCRATIC LA LATVIA LV LEBANON LB LESOTHO LS LIBERIA LR LIBYAN ARAB JAMAHIRIYA LY Gateway Developer Guide and Reference 07 January 2014 235 236 Codes Used by FDMS South Only Visa Country Codes LIECHTNSTIEN LITHUANIA LUXEMBOURG MACAU MACEDONIA MADAGASCAR MALAWI MALAYSIA MALDIVES MALI MALTA MANACO MARSHALL ISLANDS MARTINIQUE MAURITANIA MAURITIUS MAYOTTE MEXICO MICRONESIA MOLDOV
89. Corporate Card B Business Card U Unknown default 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 1 2 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions First Data Merchant Services FDMS Nashville Purchasing Card Transaction Processing Example Elavon Level 2 Transaction Parameter String TRXTYPE SS amp ACCT 51051051051051008AMT 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 BILLTOZIP 940434CUSTCODE 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 Par
90. 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 07 January 2014 185 oO D Submitting Purchasing Card Level 2 and 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 00 amp BILLTOSTREET 5199 JOHNSON amp TAXAMT 1 06 amp BILLTOZIP 94588 amp ALTTAXAMT 1 00 amp CUSTVATREGNUM 11111 amp LOCALTAXAMT 1 01 amp NATIONALTAXAMT 1 02 amp COMMCODE 22222 amp VATAXAMT 1 03 amp VATAXPERCENT 55 amp TAXEXEMPT N amp DISCOUNT 50 amp FR EIGHTAMT 1 00 amp DUTYAMT 1 00 amp SHIPTOZIP 33333 amp SHIPFROMZIP 44444 amp SHIPTOCOUNTRY 840 amp ORDERDATE 020725 amp L COMMCODE1 123456789ABC amp L DESC1 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 DISCOUNTI 50 amp L AMT1 1 00 amp L TAXTYPE1 TT1 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
91. Developer Guide and Reference 07 January 2014 245 246 Codes Used by FDMS South Only Units of Measure Thousand board feet 2 36 m3 MBF Thousand cubic metres per day TQD Thousand standard brick equivalent MBE Ton of steam per hour TSH Tonne 1000 kg TNE Tonne of substance 90 percent dry TSD Trillion EUR TRL Trillion US BIL Troy ounce APZ Troy pound US 373 242 g LBT Volt VLT Watt WITT Watt hour WHR Weber WEB Week WEE Yard 0 9144 m YRD Year ANN 07 January 2014 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 t 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 07 January 2014 247 a Additional Processor Information Moneris Solutions 248 07 January 2014 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
92. E 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 68 07 January 2014 Gateway Developer Guide and Reference Submitting Credit Card Transactions Submitting Credit Refund Transactions characters 1n the track data and passes that number as the length tag For details on length tags see Using Special Characters In Values on page 53 The length tag in the following example is 40 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 Refund 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 original 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 su
93. EGNUM 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 Cielo Payments 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 Gateway Developer Guide and Reference 07 January 2014 193 o D Submitting Purchasing Card Level 2 and 3 Transactions Paymentech Salem New Hampshire Purchasing Card Transaction Processing Parameter Description L UOMn Required Unit of measure code Character length an
94. EMAIL has incorrect format H337 EMAIL has incorrect length BILLTOEMAIL has incorrect length H348 BTZIP has incorrect format BILLTOZIP has incorrect format H349 BTZIP has incorrect length BILLTOZIP has incorrect length H360 STZIP has incorrect format SHIPTOZIP has incorrect format H361 STZIP has incorrect length SHIPTOZIP has incorrect length H364 MERCHANTID has incorrect format H365 MERCHANTID has incorrect length H366 Invalid LASTNAME Invalid BILLTOLASTNAME H375 PAN4 has incorrect length H376 PAN4 has incorrect format H380 Invalid AUTHVALUE1 Gateway Developer Guide and Reference 07 January 2014 259 Payflow Gateway Mag Tek Parameters Mag Tek Error Codes and Messages Error Message H381 H382 H383 H384 H385 Invalid AUTHVALUE2 Invalid AUTHVALUE3 Invalid MERCHANTNAME Invalid USERNAME Invalid PASSWORD Notes Invalid MAGTEKUSERNAME Invalid MAGTEKPWD Qwick Code PCode Transactions Other Error Codes Error Message P021 P022 P028 P031 P032 P033 P034 P035 P036 P037 P038 P039 P040 P041 P042 P098 Invalid Protection Code Not Found Revoked Protection Code Expired Protection Code Last 4 of PAN mismatch LASTNAME mismatch MERCHANTID is locked Protection Code can no longer be Redeemed USERNAME mismatch PASSWORD mismatch EMAIL mismatch BTZIP mismatch STZIP mismatch AUTHVALUE1 mismatch AUTHVALUE2 mismatch
95. Express 378282246310005 American Express 371449635398431 American Express Corporate 378734493671000 Gateway Developer Guide and Reference 07 January 2014 87 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 count 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 0 1000 1001 2000 2001 Result 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 s
96. First Data Merchant Services FDMS Nashville Purchasing Card Transaction Processing 173 FDMS Nashville Commercial Card Parameters a aoa aoa a a a a a a a a a 173 First Data Merchant Services FDMS North Purchasing Card Transaction Processing 174 FDMS North Purchasing Parameters aona aaa a 174 FDMS North Purchasing Card Line Item Parameters aooaa a a a a a 175 First Data Merchant Services South FDMS Purchasing Card Transaction Processing 175 FDMS South Level 2 and Level 3 Purchasing Card Parameters 176 FDMS South Line Item Parameters aooaa a 0 a 177 Example FDMS South Purchasing Card Level 2 and 3 Parameter String 178 Example FDMS South Line Item Parameter String 178 Global Payments Central Purchasing Card Transaction Processing 179 Global Payments Central Level 2 Parameters a aoao aoao a a a a a a a 179 Global Payments East Purchasing Card Transaction Processing 179 Global Payments East Level 2 Parameters oaoa aoa oa a a a a a a a a 179 Example Global Payments East Level 2 Visa or MasterCard Transaction Parameter String 180 Heartland Purchasing Card Transaction Processing a a oaoa a a a a a a a a 180 Heartland Level 2 Parameters 2 aoao a a a a a a 180 Heartland Level 3 MasterCard Parameters 0 00000 a a 181 Heartland Level 3 Visa Parameters oao aoao a a a a a a a 183 Litle Purchasing Card Trans
97. Integrating the Secure Token With the Hosted Checkout Pages 34 Integrating the Secure Token Without the Hosted Checkout Pages Transparent Redirect 34 Secuie Tok NEMO asa sra raara SG hGeSG Hee eb eta DADAS as 35 Posting To the Hosted Checkout Page c ccccccclll a a 36 Chapter 3 Configuring Hosted Checkout Pages 39 Gateway Developer Guide and Reference 07 January 2014 a Content Configuring Hosted Checkout Pages 2 a a a a 39 Configuring Hosted Pages Using PayPal Manager 04 39 DCU sms seo FLA Es eee eee eee owe eee eee ee O 40 CUSTOM ZG espero pee iee ee hee ete hea buge oboe e ss 41 MEC sake e ewe eee te ea hee eo eae ee ee 43 Using a Secure Token to Pass Hosted Pages Customization Parameters 43 Using the PARMLIST Parameter 2 a 2 a 46 Hosted Pages and Mobile Browsers 2 2 1 a a a a a a 47 Mobile Optimized Checkout Pages 2 a a a a a a a a a 47 Sen POSIS 54452456 48948 ee eee eeaee ee eee SEDGE SESE eZ 49 Force Silent Post Confirmation 0 a a a a a ee ee 49 Data Returned by the Silent Post Features 0204 4 50 Passing Other Data to Your Server Using Post or Silent Post 50 Chapter 4 Payflow SDK 2 2 ee ee ee ee ee ee ee 51 Preparing the Payflow Gateway Client Application 2 08 51 Activating Your Payflow Gateway Account a a a 2 eee ee ee a 52 Host URL Addresses 2
98. 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 07 January 2014 Gateway Developer Guide and Reference Codes Used by FDMS South Only Units of Measure Gq Kilopascal KPA Kilorgram of urantum 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 1000 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 07 January 2014 243 244 Codes Used by FDMS South Only Units of Measure Millibar MBR Millicurie MCU Milligram MGM Millilitre MLT M
99. MCODEN 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 214 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions Vantiv Purchasing Card Transaction Processing D Parameter Description L QTYn 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 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 00 amp BILLTOSTREET 5199 JOHNSON amp TAXAMT 1 O6 amp BILLTOZIP 9458 8 amp ALTTAXAMT 1 OO amp CUSTV
100. MT 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 TSYS Acquiring Solutions Level 3 Required Parameters The parameters listed in the table below apply to Level 3 transactions as extended data Parameter Description COMMCODE Required Commodity code identifier for the business Character length and limitations 4 alphanumeric 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 VATREGNUM Required VAT registration number Can be part of the registration data or passed with each transaction Character length and limitations 20 alphanumeric characters Gateway Developer Guide and Reference 07 January 2014 213 oO D Submitting Purchasing Card Level 2 and 3 Transactions TSYS Acquiring Solutions Purchasing Card Transaction Processing 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 DISCOUNT Optional Discount amount
101. 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 the amount of the original transaction 1s 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 as described in Non Referenced Credits Not Allowed Using the ACCT EXPDATE or AMT parameters for such restricted accounts leads to the return of RESULT value 117 failed the security check To help reduce fraud PayPal recommends that you do not activate non referenced credits unless you have a business reason For information on configuring your security settings see PayPal Manager online help Example 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 X1y2 23 GACCT 55
102. 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 BALAMT Response and Stored Value Cards Transactions meeting American Express reporting and statement requirements may return BALAMT when the transaction involves a stored value card Stored value cards typically are offered as gift cards allowing the customer to spend any amount up to the balance remaining on the card 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 Gateway Developer Guide and Reference 07 January 2014 103 104 Transaction Responses PNREF PNREF 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 123 OO amp BILLTOSTREET 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 00 amp AVSADDR Y amp AVSZI P N The PNREF is a unique transaction identification number issued by PayPal tha
103. NREF 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 Classic APIs 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 developer paypal com 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 07 January 2014 13 o Intended Audience Who Should Use This Document This comprehensive developer guide includes integration information for multiple Gateway solutions NOTE 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 G
104. 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 07 January 2014 197 o D Submitting Purchasing Card Level 2 and 3 Transactions Paymentech Salem New Hampshire Purchasing Card Transaction Processing Parameter Description TAXAMT Required Sales tax The value must include a decimal and the exact amount to the cent 42 00 not 42 Do not include comma separators 1234 56 not 1 234 56 To qualify for Level 2 discounts this value must not be all zeros or blank spaces 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 Duty amount Character length and limitations numer
105. PC1 PN amp L DESC2 Test amp L UOM2 12 amp L C OST2 1 00 amp 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 07 January 2014 171 oO D Submitting Purchasing Card Level 2 and 3 Transactions Elavon Formerly Nova Purchasing Card Transaction Processing Elavon Formerly Nova Purchasing Card Transaction Processing Elavon supports Level 2 for Visa and MasterCard sale credit and delayed capture transactions Elavon Level 2 Parameters To get the discount rate include both Level 2 parameters listed in the following table Pass these parameters in authorization and sale transactions Level 2 Parameters Description CUSTCODE Required Customer code Character length and limitations 1 to 16 alphanumeric characters TAXAMT Required Sales tax The value must include a decimal and the exact amount to the cent 42 00 not 42 Do not include comma separators 1234 56 not 1 234 56 To qualify for Level 2 discounts this value must not be all zeros or blank spaces 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 C
106. Pages Live Paytlow SDOK 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 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 Pages amp Payflow SDK API Full Access service Summary Service PayPal Payments Pro Hosted Checkout Pages Payflow SDK API Full Access 07 January 2014 Gateway Developer Guide and Reference Revision History a Revision History Revision History for the Gateway Developer Guide and Reference Date Description 07 Jan 2014 Added Paymentech Tampa Level 3 Parameters Updated processor name Cielo Payments formerly Merchant e Solutions Maintenance release 21 Nov 2013 Updated the description of the CURRENCY field in PayPal Credit Card Transaction Request Parameters with information for PayPal Payments Advanced and PayPal Payments Pro merchants 08 Nov 2013 Added the TRANSSTATE response field description to Credit Card Transaction Responses Added a note in When To Use a Sale Transaction for PayPal Payments Advanced or
107. Pal Payrar Sample only Your order summary appears here Pay with credit or debit card e Sample only Live page will reflect your settings Secure payments by PayPal f Return to Merchant Site Copyright PayPal Inc All rights reserved Undo Changes Save and Publish Gateway Developer Guide and Reference 07 January 2014 41 42 Configuring Hosted Checkout Pages Configuring Hosted Pages Using PayPal Manager On the Customize page you can either change the design of your existing layout or select and customize a different layout To make changes double click on the section of the template you are trying to modify or the corresponding Click to Edit button for that section In the pop up that appears click the color selector to change the color or enter the appropriate URL The customization options vary for the different Layouts These options are described in greater detail in the next section Customizing Your Layout 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 NO
108. Parameters American Express Additional Credit Card Parameters Field Description 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 1s 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 1s 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 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 selle
109. PayPal Gateway Developer Guide and Reference PayPal Payments Advanced PayPal Payments Pro Payflow Pro Payflow Link Last updated 07 January 2014 Gateway Developer Guide and Reference Document Number 200045 en US 201401 O 1999 2014 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 O 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 inf
110. Payflow Manager website refer to the website s online help NOTE PayPal Payments Advanced and PayPal Payments Pro merchants should also use the Payflow Manager website https manager paypal com to perform transactional processing functions instead of the the main paypal com website However the main paypal com website can be used to process chargebacks or other non transactional items Processing Platforms Supporting Card Present Transactions The following processing platforms support card present transactions For instructions on setting up or changing your processor see the Processor Setup Guide PDF NOTE PayPal Australia FDRA merchants with a 12 digit merchant ID can contact Payflow support to request a 16 digit merchant ID 07 January 2014 Gateway Developer Guide and Reference Introducing the Gateway Checkout Solutions Supported Payment Types 1 American Express American Express APAC Elavon 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 Vantiv WorldPay Supported Payment Types Credit cards PayPal supported by PayPal s Express Checkout product Pinless debit cards Electronic checks Ch
111. RIA NIUE NORFOLK ISLAND NORTHERN MARIANA ISLAND MAC MYS MDV MLI MLT MCO MHL MTQ MRT MUS MEX FSM MDA MNG MSR MAR MOZ MMR NAM NRU SEN NPL NLD ANT NCL NZL NIC NER NGA NIU NFK MNP Gateway Developer Guide and Reference 07 January 2014 229 230 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 SAU SYC SLE SGP SHN KNA LCA SPM VCT SDN SUR 07 January 2014 Gateway Developer Guide and Reference Codes Used by FDMS South Only MasterCard Country Codes for FDMS South Only a 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 UGAND
112. Receiving Information from the Hosted Pages If you would like to pass information to or receive information from the PayPal Hosted Checkout Pages use one of the following URLs e For live transactions use https payflowlink paypal com e For testing purposes use https pilot payflowlink paypal com NOTE You no longer need to use the MODE parameter when passing a test secure token Instead post your form parameters to the testing Payflow Link URL The MODE parameter will be deprecated in the future 07 January 2014 Gateway Developer Guide and Reference Sending a Simple Transaction to the Server When using the Payflow SDK you send transactions to the Gateway server in name value pair format Typically a simple transaction includes connection parameters user parameters and transaction data parameters e About Name Value Pairs on page 53 e Payflow Connection Parameters on page 54 e User Parameter Data on page 55 e Sale Transaction Example on page 56 e Formatting Payflow Gateway Transactions on page 56 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 stri
113. Response Parameters RESULT Description Host address not specified Invalid transaction type Failed to create a socket Failed to initialize socket layer Parameter list format error invalid name length clause Parameter list format error name Failed to initialize SSL connection Invalid timeout value The certificate chain did not validate no local certificate found The certificate chain did not validate common name did not match URL Unexpected Request ID found in request Required Request ID not found in request Out of memory Parameter list cannot be empty Context initialization failed Unexpected transaction state Invalid name value pair request Invalid response format This XMLPay version is not supported The server certificate chain did not validate Unable to do logging The following error occurred while initializing from message file lt Details of the error message gt Unable to round and truncate the currency value simultaneously Processor specific Response Parameters Some of the response parameters returned in a Payflow transaction are processor specific and are returned only to merchants using a certain processing platform For a list of processing platforms supported by Payflow see Processing Platforms Supporting Card Present Transactions on page 30 Litle Response Parameters on page 113 07 January 2014 Gateway Developer Guide and Reference Transaction Responses Processor
114. STATES URUGUAY SH KN LC PM VC SD SR SJ SZ SE CH SY TW TJ TZ TH TG TK TO TT TN TR TM TC TV UM UG UA AE GB US UY 07 January 2014 Gateway Developer Guide and Reference Codes Used by FDMS South Only Units of Measure Gq UZBEKISTAN UZ VANUATU VU VATICAN CITY STATE VA VENEZUELA VE VIETNAM VN VIRGIN ISLANDS BRITISH VG VIRGIN ISLANDS US VI WALLIS AND FUTUNA IS WE 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 07 January 2014 239 240 Codes Used by FDMS South Only Units of Measure Bushel 35 2391 dm3 BUA Bushel 36 36874 dm3 BUI Candela CDL Carrying capacity in metric tonnes CCT Cental GB 45 359237 kg CNT Center metric 100 kg syn 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 C
115. SULT 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 07 January 2014 Gateway Developer Guide and Reference Submitting Credit Card Transactions Submitting Sale Transactions 6 zero dollar authorization TRXTYPE A For details see Submitting Account Verifications on page 64 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 sale 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 65 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 NOTE PayPal Payments Advanced a
116. SZIP 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 1s 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 1s 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 PayPal amp VENDOR Vendor amp USER SuperMerchant amp amp ACCT 5555555555554444 amp EXPDATE 1215 amp AMT 123 OO amp SBILLTOSTREET 5 199 Maple amp BILLTOZIP 98765 In this example response the address value matches the value in the bank
117. SecureNet Level 3 MasterCard Line Item Detail Records NOTE For these values nis a sequence counter that should begin with 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 Gateway Developer Guide and Reference 07 January 2014 205 o D Submitting Purchasing Card Level 2 and 3 Transactions SecureNet Purchasing Card Transaction Processing 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 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 amp EXPDATE 1215 amp AMT 1 00 amp BILLTOSTREET 5199 JOHNSON amp BILLTOZIP
118. TCODE 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 008ACCT 0002 amp EXPDATE 0120 amp CARDTYPE 0 amp IAVS N Submitting Partial 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 Gateway Developer Guide and Reference 07 January 2014 13 6 Submitting Credit Card Transactions Submitting Partial Authorizations 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 Requir
119. TE 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 NOTE Payflow will ignore the cancel URL field that you entered in PayPal Manager if you select layout template C To force Payflow to use the cancel URL field with layout template C in PayPal Manager add DISPLAY URL before your cancel URL Example DISPLAY URL http www yoursite com home php Customizing Your Layout You can customize the appearance of the Layout template that you selected on the customize page These customizations apply mostly to Layouts A and B Layout C is embedded on a page you host in an iFrame So for Layout C you already control the appearance of the page NOTE These customizations are not applied to the mobile version of the hosted checkout pages e Header Applicable to Layouts A and B You can change the following Header height Applicable to Layouts A and B Header background color Applicable to Layout B only Header font type size Applicable to Layouts A and B Header font color Applicable to Layout B only Swap between displaying the business name or the business logo image Edit business name in the header Applicable to Layouts A and B Position of the business name or the logo within the header left
120. TION 136 Description Optional Departure date in the format YYYYMMDD Character length and limitations 8 alphanumeric characters Optional Name of the passenger in the following format with fields separated by a space surname firstname middleinitial title Character length and limitations 40 alphanumeric characters 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 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 07 January 2014 Gateway Developer Guide and Reference Processors Requiring Additional Transaction Parameters A SecureNet Additional Credit Card Parameters for American Express Field Description AIR NUMBEROFCITIES Optional Number of unique cities in th
121. TSYS Acquiring Solutions 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 212 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 00 amp BILLTOSTREET 5199 JOHNSON amp BILLTOZIP 94588 amp ALTTAX AMT 1 00 amp CUSTVATREGNUM 11111 amp LOCALTAXAMT 1 00 amp NATIONALTAXAMT 1 00 amp COMMCODE 22222 amp VATAXAMT 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 84 0 amp ORDERDA TE 020725 amp L COMMCODE1 123456789ABC amp L DESC1 Line item 1 description amp l UPC1 C BA987654321 amp L OTY1 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 0
122. The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wiki ISO_3166 1_ numeric Character length and limitations 3 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 Gateway Developer Guide and Reference 07 January 2014 207 oO D Submitting Purchasing Card Level 2 and 3 Transactions SecureNet Purchasing Card Transaction Processing Parameter Description 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 nis a sequence counter that should begin with 1 and increase in sequence Each line item should also contam 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 c
123. UR 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 07 January 2014 Gateway Developer Guide and Reference Codes Used by FDMS South Only Units of Measure Gq 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 GII 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 Reference 07 January 2014 241 242 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
124. Visa Order Parameters 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 The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wiki ISO_3166 1_ numeric 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 Required Product code Required Quantity Character length and limitations numeric characters Required Unit of measure Optional Tax amount Character length and limitations numeric Gateway Developer Guide and Reference 07 January 2014 199 oO D Submitting Purchasing Card Level 2 and 3 Transactions Paymentech Salem New Hampshire Purchasing Card Transaction Processing Parameter Description L TAXRATEN Optional Tax rate Character length and limitations 4 numeric characters Level 3 Visa Line Item Record 2 Parameters Parameter Description L AMTn Optional Line item total Character length and limitations
125. a a a a a a a a a a 65 Submitting Authorization Delayed Capture Transactions 65 When to Use Authorization Delayed Capture Transactions 65 Required Authorization Transaction Parameters a oaoa a aoa a a a a 66 Submitting Balance Inquiry Transactions oa aoao oa a a a a a a a 66 Processing Platforms Supporting Balance Inquiry Transactions 66 Required Balance Inquiry Parameters 2 0 2 eee ee ee ee 67 Example Balance Inquiry Transaction String 20 505004 67 Submitting Card Present SWIPE Transactions 02 008 67 Processing Platforms Supporting Card Present Transactions 68 Card Present Transaction Syntax a aoa aoa a a a a a a a a a a 68 Submitting Credit Refund Transactions 0 00 2 a a 69 Required Credit Transaction Parameters 0 0 0 4 a ee eee 69 Submitting Inquiry Transactions 2 a a a a 71 When To Use an Inquiry Transaction o o oaoa a a a a a a ee ee 71 Required Parameters When Using the PNREF 71 Inquiry Transaction Parameter String Using the PNREF 72 Required Parameters When Using the CUSTREF 72 Inquiry Transaction Parameter String Using the CUSTREF T3 Required Parameters When Using the Secure Token aooaa a a a a a a a 73 Inquiry Parameter String Using the Secure Token aoaaa a a a a a a a a a 73 Submitti
126. acter 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 1f 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 QTY3 Optional Quantity of this line item Character length and limitations 3 numeric characters L DESC4 Optional Description of this line item 1f 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 QTY4 Optional Quantity of this line item Character length and limitations 3 numeric
127. action 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 51 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 6 Parameter list format error amp in name 7 Parameter list format error invalid name length clause 8 SSL failed to connect to host 9 SSL read failed 10 SSL write failed 11 Proxy authorization failed 12 Timeout waiting for response 13 Select failure 14 Too many connections 15 Failed to set socket options 20 Proxy read failed 21 Proxy write failed 22 Failed to initialize SSL certificate Gateway Developer Guide and Reference 07 January 2014 111 112 Transaction Responses Processor specific
128. action Processing 2 0 eee a 186 Litle Level 2 Parameters 2 1 a 186 Litle Level 3 Parameters 2 aona a a a a 187 Cielo Payments Purchasing Card Transaction Processing 189 Cielo Payments Level 2 Parameters oa aoa oa a a a a a a a 189 Cielo Payments Level 3 MasterCard Parameters a a aoa a a a a a a 200 189 Gateway Developer Guide and Reference 07 January 2014 9 a Content 10 Chapter Chapter Cielo Payments Level 3 Visa Parameters 0 00002 eee eee 192 Paymentech Salem New Hampshire Purchasing Card Transaction Processing 194 Paymentech Salem New Hampshire Level 2 Parameters for American Express 194 Paymentech Salem New Hampshire Level 3 Purchasing Card Parameters 197 Paymentech Tampa Level 2 Purchasing Card Transaction Processing 201 Paymentech Tampa Level 2 Parameters 0 000000 ee eee 201 Example Paymentech Tampa Level 2 Visa and MasterCard Transaction Parameter String 201 Paymentech Tampa Level 3 Parameters a a a ee eee 201 Example Paymentech Tampa Level 3 Visa and MasterCard Transaction Parameter String 203 SecureNet Purchasing Card Transaction Processing 50 08 204 SecureNet Level 2 Parameters 2 1 a a a a a a a a a 204 SecureNet Level 3 MasterCard Parameters aoao aoao a a a a a a a a 204 SecureNet Acquiring Solutions Level 3 Visa Parameters 206 TSYS Acq
129. ail 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 takes 2 3 days Use the host address of the live server described in Host URL Addresses on page 52 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 RESULT PNREF Description The outcome of the attempted transaction A result of O zero indicates the transaction was approved Any other number indicates a decline or error Character length and limitations numeric variable number of characters PayPal Reference ID a unique number that identifies the transaction Character length and limitations 12 alphanumeric characters 07 January 2014 Gateway Developer Guide and Reference TeleCheck Electronic Check Processing Response Code Values B Field Description HOSTCODE TeleCheck s response code representing the results of the transaction authorization attempt Character length and limitations 6 numeric characters RESPMSG A
130. ameters 122 First Data Merchant Services North Additional Credit Card Parameters 122 Heartland Additional Credit Card Parameters 2 000 eee 123 Litle Additional Credit Card Parameters 2 0 2 ee a a 123 Cielo Payments Additional Credit Card Parameters 2 4 125 Paymentech Salem New Hampshire Additional Credit Card Parameters for American EXDIOSS asas LESS he eee ee a 125 Internet Transaction Data Parameters 2 2 ee ee a a 125 AVS Parameters aoaaa aa a a a a a a a a 126 Additional Credit Card Parameters for M Record aoaaa a a a a a 127 PayPal Credit Card Transaction Request Parameters a aoa aoa a a a a a 0008 128 SecureNet Additional Credit Card Parameters for American Express 133 Retail Transaction Advice Addendum for SWIPE transactions 133 Internet Transaction Data aooaa a a a a 133 AVS Parameters aooaa a a a a a a a a a 134 Location Transaction Advice Addendum Parameters a a a oa a a a a a a a 135 Transaction Advice Detail Parameters 2 a a a a a ee 136 Airline Passenger Data Parameters aoa oaoa a a a a a a a 136 Other Parameters aooaa a a a a a a a 138 Vantiv Additional Credit Card Parameters a aoa a a a a a a a a a a 138 Additional Credit Card Parameters a oa aoa a a a 138 Gateway Developer Guide and Reference 07 January 2014 7 Soft Merchant Descriptor Parameters 2 aa
131. ameters 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 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 Optional 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 07 January 2014 173 oO D Submitting Purchasing Card Level 2 and 3 Transactions First Data Merchant Services FDMS North Purchasing Card Transaction Processing Field Description TAXAMT Optional Tax amount The value must include a decimal and the exact amount to the cent 42 00 not 42 Do not include comma separators 1234 56 n
132. amp AVSZ IP N amp CVV2MATCH Y Credit Card Transaction Responses The table below describes values that can be returned 1n response strings Field Description PNREF Gateway transaction ID a unique number that identifies the transaction Character length and limitations 12 alphanumeric characters PPREF PayPal transaction ID of the payment returned by the PayPal processor 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 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 Y Match N No Match X One of the following Not processed Service not supported Unavailable No response or Invalid data was p assed Character length and limitations 1 alpha character Y N X or no response Gateway Developer Guide a
133. ansaction e If or 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 If a customer uses a card type you do not accept the SDK responds with RESULT 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 07 January 2014 Gateway Developer Guide and Reference Submitting Credit Card Transactions Core Credit Card Parameters To accept addit
134. 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 x1y2 Z3 amp AUTHCODE AB3 456 amp ACCT 5555555555554444 amp EXPDATE 1215 amp AMT 123 0O0 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 transaction and the original transaction will not appear on the customer s statement PayPal will issue an authorization reversal as part of the voi
135. are used for verifying the validity of customer credit card information TRXTYPE A is required for both account verifications and for normal authorization transactions however account verifications are different from normal authorizations in the following ways e For account verifications pass a zero AMT 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 In account verifications even if the RESULT value returned is O Approved the RESPMSG value returned is Verified instead of Approved NOTE Payflow returns RESULT value 4 Invalid Amount if the processor does not support account verifications When To Use Account Verifications Use account verifications to validate account numbers and other authentication elements such as CVV2 and AVS Account verifications cannot be voided captured or refunded Attempting to do so results in a declined transaction RESULT 12 A reference transaction can be based on a successful account verification transaction and used to charge the customer s verified account See Submitting Reference Transactions Tokenization on page 75 Required Account Verification Parameters To perform an account verification pass the following parameters 07 January 2014 Gateway Developer Guide and Reference Submitting Credit Card Transactions 6 Submitting Authorization Delayed Capture Transactions Parameter Desc
136. 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 files 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 1s 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 07 January 2014 Gateway Developer Guide and Reference Payflow Header Parameters This section includes information on the Payflow header parameters These header parameters can be used to bypass Payflow to send a request message directly to PayPal They can also be used to post transactions to the Payflow servers directly without installing an SDK This section includes e Sending Requests Directly to PayPal Bypassing Payflow on page 155 e Posting Transactions Directly Without the Payflow SDK on page 156 Sending Requests Directly to PayPal Bypassing Payflow Payflow will ignore the request parameters you pass and will forward them to PayPal when you declare
137. at you need for the transaction If you duplicate a parameter in your NVP string the last item will always be the one used and the others will be discarded 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 S 3DMerchantUserID 26PWD 3DPwd4Gateway 26 PART NER 3DPayPal 26ACCT S3D5105105105105100 26EXPDATE 3D1215 26AMT 3D23 45 26COM MENT1 3DA1rport Shuttle 26BILLTOFIRSTNAMES3DJamie 26BILLTOLASTNAME 3DMiller 26BILLTOSTREET S3D123 Main St s26BILLTOCITY 3DSan Jose 26BILLTOSTATE S3DCA 2 6BILLTOZIP S3D951311234326BILLTOCOUNTRY 3DUS 26CVV2 3D123 526CUSTIP S3D0 0 0 0 This example is correct TRXTYPE S amp TENDER C amp USER MerchantUser ID amp PWD Pwd4Gateway amp PARTNER PayPal amp ACCT 5105105105105100 amp SEXPDATE 1215 amp AMT 23 45 amp COMMENT1 Airport Shuttle amp BILLTOFIRS TNAME Jamie amp BILLTOLASTNAME M11ler amp BILLTOSTREET 123 Main St amp BILLTOCITY San Jose amp BILLTOSTATE CA amp BILLTOZIP 951311234 amp BILLTOCOUNTRY 840 amp CVV2 123 amp CUSTIP 0 ot 0 00 Payflow Connection Parameters The Payflow SDK passes connection parameters to define the connection to the Payflow server 54 07 January 2014 Gateway Developer Guide and Reference Sending a Simple Transaction to the Server User Parameter Data 5 Pass the connection parameters in the format and syntax required by the Pay
138. ateway 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 Payflow Link 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 Summary 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 14 07 January 2014 Gateway Developer Guide and Reference Intended Audience a service Summary Service Status 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
139. ation on your website thereby helping towards achieving PCI compliance PayPal s hosted checkout pages are optimized for supported desktop and mobile browsers NOTE The Payflow 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 a 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 Service Settings tab In the Hosted Checkout Pages section you have the following options e Setup e Customize e Integrate Gateway Developer Guide and Reference 07 January 2014 39 40 Configuring Hosted Checkout Pages Configuring Hosted Pages Using PayPal Manager Setup The Setup page in PayPal Manager enables you to select the information you want to collect from buyers and what you want displayed on your hosted checkout pages This includes selecting the billing and the shipping information information fields the payment confirmation page settings the confirmation email details security options and other settings PayPal Manager Home Account Administration Service Setings Search Transactions Virtual Terminal Reports Hosted Che
140. ation and Sale API calls not permitted PayPal Payments Pro Payflow Pro Yes Optional Optional Optional Yes Yes Yes Yes Yes Yes Yes Yes Full access 07 January 2014 Gateway Developer Guide and Reference Introducing the Gateway Checkout Solutions About the Gateway Transaction Flow 1 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 2 You send the transaction request to the Gateway server 3 The Gateway sends the transaction to the payment processing network 4 Your processor sends 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 ada The Gateway server returns the response to your website Your website displays the result to the customer nda ABC Company a _ O i O do A
141. ation 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 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 Gateway Developer Guide and Reference 07 January 2014 107 108 Transaction Responses RESULT Values and RESPMSG Text RESULT 106 107 108 109 110 111 112 113 114 115 11
142. ational Z Retry Service not Supported Unavailable Whole Zip Exact Match Yes Zip AVSADDR AVSZIP Y N Y N N N Y Y X X Y Y X X X X N N N Y X X X X X X N Y Y Y Y Y N Y 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 SAVSADDR Y amp AVSZ ITP Y amp HOSTCODE A amp PROCAVS Y amp VISACARDILEVEL 12 amp TRANSTIME 2011 01 12 13 54 35 amp AMT 1 OO amp ACCT 1111 amp EXPDATE 1215 amp CARDTYPE 0 amp IAVS N 07 January 2014 Gateway Developer Guide and Reference Transaction Responses Card Security Code Results 8 Card Security Code Results Normalized Card Security Code Results 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 Payflow CVV2MATCH M
143. ators 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 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 Land ends with n where n is the line item number For example L QTY0 1 is the quantity for line item O and is equal to 1 with n starting at 0 In addition the SHIPFROMZIP parameter is required for Level 3 transactions Vantiv Line Item Parameters Field Description L QTYn Required Quantity whole units only Character len
144. 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 retry request 150 Issuing bank timed out PayPal Australia reported a timeout between their system and the bank This error will be reversed by time out reversal According to PayPal Australia this is a best effort and is not guaranteed 151 Issuing bank unavailable 160 Secure Token already been used Indicates that the secure token has expired due to either a successful transaction or the token has been used three times while trying to successfully process a transaction You must generate a new secure token 161 Transaction using secure token is already in progress This could occur if a customer hits the submit button two or more times before the transaction completed 162 Secure Token Expired The time limit of 20 minutes has expired and the token can no longer be used 200 Reauth error 201 Order error 600 Cybercash Batch Error 601 Cybercash Query E
145. c characters plus a decimal point 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 L UPC1 Required The item s universal product code UPC n is a line item number from 1 to 6 Character length and limitations 1 to 30 alphanumeric characters L NGI1 Required Item net gross indicator n is a line item number from to 6 It is one of the following values N Item extended amount does not include tax Y Item extended amount includes tax L TAXAMT1 Required Line item tax amount n is a line item number from 1 to 6 NOTE To enable line item support send an email from the primary email address on the account to payflow support paypal com Character length and limitations 9 numeric characters plus a decimal point 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 Example Paymentech Tampa Level 3 Visa and MasterCard Transaction Parameter String TRXTY PE S amp TENDER C amp PWD PWD amp USER USER amp PARTNER PARTNER amp ACCT 4275330012345675 amp EXPDATE 1215 amp AMT 26 41 amp VERBOSITY HIGH amp BILLTOSTREET 123 Main St amp BILLTOZIP 4 9801L amp CVV2 248 amp TAXAMT 1 26 amp PONUM AB12345678 amp FREIGHTAMT 8 95 amp DUTYAMT 0 OO amp SHI PTOZIP 240181543 amp SHIPTOCOUNTRY US amp SHIPFROMZIP 60646
146. card amp l UPC1 1 amp L UOM1 2 amp L QTY1 3 amp L TAXAMT1 4 amp L TAXRATE1 5 amp L AMT1 6 amp L DISC OUNT1 7 amp L COMMCODE1 8 amp L COST1 9 amp L COST1 10 200 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions D Paymentech Tampa Level 2 Purchasing Card Transaction Processing Paymentech Tampa Level 2 Purchasing Card Transaction Processing Paymentech Tampa supports Level 2 purchasing card processing for MasterCard and Visa 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 S amp TENDER C amp PWD PWD amp USER USER amp PARTNER PARTNER amp ACCT 4275330012345675 amp EXPDATE 1215 amp AMT 12 59 amp VERBOSITY HIGH a
147. ce Authorization Transaction Parameters 82 Submitting Void Transactions oao oaoa a a a a a 82 When To Use a Void Transaction aooo a a a 83 Required Void Transaction Parameters a oaoa a a a a a a a a a a 83 Fields Copied From the Original Transaction Into the Void Transaction 83 Example Void Transaction Parameter String 0 000 ee eee 84 Using Address Verification Service oao oaoa oaoa a a a a a a a 84 Example Address Verification Service Parameter String 84 Using Card Security Code aoa oa aoa a a a a a a a a 85 Information for the PayPal Acquirer 1 a a 85 Countries and Regions Supported by PayPal 86 PayPal Currency Codes 2 2 ee a a 86 Testing Transactions 87 Setting Up The Payflow Gateway Testing Environment 87 Testing Guidelines 1 1 aoa a a a a a a a a 87 Processors Other Than PayPal aa a ee 87 Credit Card Numbers for Testing oaoa 2 a a a a a a 87 Testing Address Verification Service o aoao oaoa a a a 91 Testing Card Security Code aoao a a a a a a a 92 Testing the Litle Automatic Account Updater Feature 92 PayPal Processor aono a a 93 Credit Card Numbers for Testing aoaaa 0 a a a a 93 Result Values Based On Amount aoaaa a a a a a a 94 Transaction Responses 97 Credit Card Transaction Responses 2 a a a a a a a 97 Address Verificat
148. ce 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 original 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 it 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 Gateway Developer Guide and Reference 07 January 2014 15 6 Submitting Credit Card Transactions Submitting Reference Transactions Tokenization 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 Asa 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 se
149. cember 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 SHOSTCODE 000 amp T RANSTIME 2012 02 16 18 41 254AMT 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 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 Ifyou 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
150. cessors Requiring Additional Transaction Parameters Elavon Additional Credit Card 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 reyected 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 described below Field Description RECURRING Optional Identif
151. ch 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 UOMn Required Unit of measure code Character length and limitations 12 alphanumeric characters L costTn 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
152. ch 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 Gateway Developer Guide and Reference 07 January 2014 69 70 Submitting Credit Card Transactions Submitting Credit Refund Transactions Parameter ORIGID Description 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
153. 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 transactions with FDMS South Gateway Developer Guide and Reference 07 January 2014 175 oO D Submitting Purchasing Card Level 2 and 3 Transactions First Data Merchant Services South FDMS Purchasing Card Transaction Processing FDMS South Level 2 and Level 3 Purchasing Card Parameters Field BILLTOCITY SHIPTOCOUNTRY CUSTCODE DISCOUNT DUTYAMT BILLTOFIRSTNAME FRE IGHTAMT INVNUM BILLTOLASTNAME ORDERDATE 176 Description Optional Cardholder s city Character length and limitations 13 alpha characters Optional Destination Country
154. ckout Pages DAE Aio re 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 jye w How Your Checkout Pages Look Enter Text for Cancel URL optional Enter Cancel URL topliomal Enable Solo Switch Card No w PayPal Express Checkout How Your Pages Look Design Pages PayPal email address PayPal Sandbox email address agmohan gwpfite 11 paypal com You can perform tasks such as e Configure your PayPal Express Checkout display and specify email addresses for live and test transactions e Determine the cancel URL and the text of the link the buyer clicks on to cancel the payment on your website The cancel URL is the page to which PayPal redirects your buyer s browser if the buyer does not approve the payment NOTE Payflow will ignore the cancel URL field that you entered in PayPal Manager if you select layout template C To force Payflow to use the cancel URL field with layout template C in PayPal Manager add DISPLAY URL before your cancel URL Example DISPLAY URL http www yoursite com home php e Select the billing and shipping information fields the buyer will be required to complete during checkout e Choose to display a PayPal hosted payment confirmation page or host your own confirmation page on your website You can also specify the paypal hoste
155. cter length and limitations 10 alphanumeric characters SHIPTOCOUNTRY Optional Destination country code The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wikiAISO_3166 1 numeric 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 nis a sequence counter that should begin with 1 and increase in sequence Each line item should also contain quantity L_QTYn and unit price L COSTn fields Parameter Description L COMMCODEN Optional Item commodity code 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 182 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions Heartland Purchasing Card Transaction Processing D Parameter Description L QTYn Required Quantity Character length and limitations 12 numeric characters L UOMn Required Unit of measure code Character length and limitations 12 alphanumeric characters L COSTN Required Unit cost Character length and limitations 12 numeric characters L TAXAMTN Optional VAT tax amount C
156. cure is invalid Buyer Authentication Service Validate Authentication failed missing or invalid PARES Buyer Authentication Service Validate Authentication failed PARES format is invalid Buyer Authentication Service Validate Authentication failed Cannot find successful Verify Enrollment Buyer Authentication Service Validate Authentication failed Signature validation failed for PARES Buyer Authentication Service Validate Authentication failed Mismatched or invalid amount in PARES Buyer Authentication Service Validate Authentication failed Mismatched or invalid acquirer in PARES Buyer Authentication Service Validate Authentication failed Mismatched or invalid Merchant ID in PARES Buyer Authentication Service Validate Authentication failed Mismatched or invalid card number in PARES Buyer Authentication Service Validate Authentication failed Mismatched or invalid currency code in PARES Buyer Authentication Service Validate Authentication failed Mismatched or invalid XID in PARES Buyer Authentication Service Validate Authentication failed Mismatched or invalid order date in PARES 07 January 2014 Gateway Developer Guide and Reference Transaction Responses RESULT Values and RESPMSG Text 8 RESULT RESPMSG and Explanation 1052 Buyer Authentication Service Validate Authentication failed This PARES was already validated for a previous Validate Authentication trans
157. d item where n is a line item number from 1 to 99 Character length and limitations 12 alphanumeric characters L COSTN Required if L QTYnis 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 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 QTYN 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 length and limitations The decimal 1s 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 limita
158. d transaction you must change the Request ID If the X VPS REQUEST ID has not been used before the server stores the X VPS REQUEST ID to ensure that the X VPS REQUEST ID is not reused and then runs the associated transactions Duplicate checking is designed for short term retries a few minutes to a few hours after the original transaction The X VPS REQUEST ID is stored for a minimum of 7 to 8 days however retries should not be sent so long after the original transaction NOTE Any transaction with an ID older than 8 days will be treated as a new transaction The X VPS REQUEST ID check is only available if the database is up and available If for some reason the database is down transactions authorizations and sales will continue to be processed as normal however DUPLICATE 1 negative one will be returned to alert you that the database is down and there is no duplicate check being performed NOTE Buyer Authentication E Verify Enrollment Z Validate Authentication transactions and PayPal Express Checkout SetExpressCheckout and GetExpressCheckout transactions do not use duplicate suppression and will not return DUPLICATE 1 Gateway Developer Guide and Reference 07 January 2014 157 Payflow Header Parameters Posting Transactions Directly Without the Payflow SDK Header Name Description X VPS CLIENT TIMEOUT Required Time out value in seconds A transaction times out if the elapsed time between ending the original
159. d TRXTYPE A then if SHOWAMOUNT FALSE Payflow will not display the amount in the order summary table Values TRUE FALSE Gateway Developer Guide and Reference 07 January 2014 45 Configuring Hosted Checkout Pages Using the PARMLIST Parameter Variable Description SUBTOTAL Amount you pass to Payflow It is displayed in the order summary section This amount is only for display purposes and is not passed to the transaction servers VERBOSITY Additional values returned from the transaction response to the merchant in the Silent Post By default there is no verbosity set which means the standard set of values that Silent Post currently uses is returned 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 Using the PARMLIST Parameter PARMLIST is a HTTP Post parameter used with a secure token to pass information to the Gateway hosted checkout pages PARMLIST takes a string of name value pairs as its value Payflow parses out these name value pairs and uses them to run the transaction PARMLIST is especially useful for merchants that already use this parameter with the Payflow SDK and want to use an existing nam
160. d confirmation page header and footer text and the URL and text for the return link Additionally you can choose to enable the silent post feature e Opt to send email receipts to the buyer for each successful transaction For complete details on these settings click the Help button on the Setup page To quickly get get started with your hosted pages go to the Hosted Pages Getting Started Guide on the PayPal 07 January 2014 Gateway Developer Guide and Reference Configuring Hosted Checkout Pages Configuring Hosted Pages Using PayPal Manager 3 developer portal For more information on the Silent Post feature go to Silent Posts on page 49 Customize The Customize page allows you to customize the layout and appearance of your hosted checkout page You can customize the header background payment method section and the order summary column of your payment page PayPal offers three design layouts for you to choose from Layout A is the default layout but you can choose any of the three layouts offered Layouts A B and C PayPal Manager Home Account Administration Service Settings Search Transactions Virtual Terminal Reports Hosted Checkout Pages Ze il eiur site SetUp Customize Integrate Customize Your Page We ve created a basic page for you below but you can change it to reflect your company s brand Choose a layout and color Layout A Layout B Layout C Choose a way to pay Pay with Pay
161. d 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 07 January 2014 183 o D Submitting Purchasing Card Level 2 and 3 Transactions Heartland Purchasing Card Transaction Processing Parameter Description TAXAMT Required Tax amount The value must include a decimal and the exact amount to the cent 42 00 not 42 Do not include comma separators 1234 56 not 1 234 56 Character length and limitations numeric LOCALTAXAMT Optional Local tax amount Character length and limitations 12 numeric characters TAXEXEMPT Optional Local tax incl flag 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 Transaction ID is 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 MasterCa
162. d 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 1s captured 58 07 January 2014 Gateway Developer Guide and Reference Submitting Credit Card Transactions Credit Card Features Credit Card Features The Payflow SDK supports the following transaction types for credit card processing Transaction Type Billable Authorization Yes Account Verification No Balance Inquiry No Credit Yes Delayed Capture No Inquiry No Sale Yes Voice Authorization Yes Void Yes
163. d limitations 12 alphanumeric characters L costTn 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 Cielo Payments 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 00 amp BILLTOSTREET 5199 JOHNSON amp TAXAMT 1 O6 amp BILLTOZIP 9458 8SALTTAXAMT 1 OO amp CUSTVATREGNUM 11111 amp LOCALTAXAMT 1 OL amp NATIONALTAXAMT 1 02 amp COMMCODE 22222 amp VATAXAMT 1 O3 amp VATAXPERCENT 55 amp TAXEXEMPT N amp DISCOUNT 50 amp FR EIGHTAMT 1 00 amp DUTYAMT 1 00 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 05 amp L TAXRATE1 12 amp L DISCOUNTI 50 amp L AMT1 1 00 amp L TAXTYPE1 TT1 Paymentech Salem New Hampshire Purchasing Card Transaction Processing Paymentech Salem New Hampshire Level 2 Parameters for America
164. d the differences between Submitting Credit Refund Transactions and Submitting Void Transactions Gateway Developer Guide and Reference 07 January 2014 19 D Revision History Date Description Updated the parameters in the Payflow Link legacy 23 July 2012 16 July 2012 June 2012 May 2012 April 2012 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 Added the Bill Me Later feature to the Gateway Product Details section Updated the value of the required column for the BILLTOCITY BILLTOSTATE amp BILLTOCOUNTRY parameters in PayPal Credit Card Transaction Request Parameterstable Added the Who Should Use This Document section to the Preface In the Integrating the Secure Token Without the Hosted Checkout Pages Transparent Redirect section corrected the value of SILENTTRAN to True Added Silent Posts section to the Hosted Checkout Pages chapter Removed the legacy paramater CORPCOUNTRY from Country Codes Added new sections to the Testing Transactions chapter Testing Address Verification ServiceTesting Card Security Code Added PayPal Acquirer chapter Contains links to PayPal API Ref country and currency codes Added new transaction type Balance Inquiry TRXTYPE B can be used to obtain the balance of a pre paid card Updated TeleC
165. d transaction for debit and credit cards if the processor supports 1t 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 07 January 2014 Gateway Developer Guide and Reference Submitting Credit Card Transactions 6 Submitting Void Transactions When To Use a Void Transaction Use the following guidelines when using void transactions 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 from the original transaction into the void transaction if they exist in the original transaction If you provide a new value for any of these paramete
166. ddress parameters such as SHIPTOCITY or SHIPTOSTATE you must pass in the complete set that is SHIPTOSTREET SHIPTOCITY SHIPTOSTATE SHIPTOCOUNTRY and SHIPTOZIP Limitations 40 character string Optional Ship to state or province 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 SHIPTOSTREET SHIPTOCITY SHIPTOSTATE SHIPTOCOUNTRY and SHIPTOZIP Limitations 40 character string Optional Ship to country code For the PayPal acquirer refer to PayPal s country codes https developer paypal com webapps developer docs classic api country_codes 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 SHIPTOSTREET SHIPTOCITY SHIPTOSTATE SHIPTOCOUNTRY and SHIPTOZIP Limitations Two alpha characters Optional U S ship to zip code or other country specific postal code 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 SHIPTOSTREET SHIPTOCITY SHIPTOSTATE SHIPTOCOUNTRY and SHIPTOZIP Limitations 20 character string 07 January 2014 Gateway Developer Guide and Reference Processors Requiring Additional Transaction Parameters A SecureNet Additional Credit Card Parameters for American Express SecureNet Additional Credit Card Parameters for Ame
167. de 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 AIR NUMBEROFCITIES is 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 ATR ROUTINGCITYn parameters Gateway Developer Guide and Reference 07 January 2014 119 120 Processors Requiring Additional Transaction Parameters American Express Additional Credit Card Parameters Field AIR ROUTINGCITYN AIR CARRIERN AIR FAREBASIS AIR NUMBEROF PASSENGERS AIR ISETICKET AIR RESERVATIONCODE Description 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 unique airline in this flight where n is a value from to 10 If the same
168. 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 TAXAMT Required if L_TAXAMTN is specified Sum of tax for all items in this order TAXAMT L QTYO L TAXAMTO L QTVI L TAXAMTI L QTYn L TAXAMT N 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 characters 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 FREIGHTAMT 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 characters 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 Gateway Developer Guide and Reference 07 January 2014 129 Processors Requiring Additional Transaction Parameters A PayPal Credit Card Transaction Request Parameters Parameter HANDLINGAMT DISCOUNT INSURANCEAMT L NAMEN L DESCN L COSTN
169. ditional capabilities to be enabled such as Overflow Credits and MIA Duplicate Checking Change and Void transactions are 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 is 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 mor
170. e Character length and limitations 3 alpha characters L COSTN 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 L AMTn 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 Johns amp BILLTOLASTNAME Smith amp BILLTOCI TY Redwood amp SHIPTOCOUNTRY USA amp CUSTCODE 12345 amp DISCOUNT 25 amp DUTYAMT 34 00 amp FREI GHTAMT 12 OOS INVNUM 123456789 amp ORDERDATE 021 70 0 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 Johns amp BILLTOLASTNAME Smith amp BILLTOCI TY Redwood amp SHIPTOCOUNTRY USA amp CUSTCODE 12345 amp DIS
171. e 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 Gateway Developer Guide and Reference 07 January 2014 139 A Processors Requiring Additional Transaction Parameters WorldPay Additional Credit Card Parameters 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 ADDLAMTTY PEN Optional A 3 digit code indicating the type of the corresponding charge detail where n is a value
172. e 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 SECURETOKENID HTTP Form Post Examples The following is an example request string that displays the transaction information to the hosted checkout page 07 January 2014 Gateway Developer Guide and Reference Secure Token Posting To the Hosted Checkout Page 2m lt html 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 Fj 1AFUW t0 I0CUFOKh5WA name SECURETOKEN gt lt input type hidden value 9a9ea8208de1l413abc3d60c86cb1f4c5 name SECURETOKENID gt lt form gt lt body gt lt html gt For more information on the Payflow parameters that are used to pass information to the Gateway hosted checkout pages see Using a Secure Token to Pass Hosted Pages Customization Parameters on page 43 The following example uses Payflow name value pairs to pass values in a form post to the hosted checkout pages For details on the name value pair strings used in this example see Sending a Simple Transaction to the Server on page 53 lt html gt lt head gt lt title gt PageTitle lt title gt lt head gt lt body gt lt form method post action ht
173. e 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 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 are 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 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 23
174. e correct transaction use a unique CUSTREF when submitting any transaction including retries 07 January 2014 Gateway Developer Guide and Reference Submitting Credit Card Transactions 6 Submitting Partial Authorizations Inquiry Transaction Parameter String Using the CUSTREF This is an example inquiry parameter string using the CUSTREF TRXTYPE I amp TENDER C amp PARTNER PayPal amp VENDOR SuperMerchant amp USER SuperMerchant amp PWD x1y2 z3 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 I amp TENDER C amp PARTNER PayPal amp PND SuperUserPassword amp USER SuperMerchant amp VERBOSITY HIGH amp VENDOR SuperMerchant amp SECURETOKEN FmyM1y 7wy8kiS6aumnMPhTONEVE RBOSITY HIGH The following 1s the response string RESULT 0 amp PNREF VFHEILAOCBOA9S amp TRANSSTATE 6 amp 0RIGRESULT 0 amp 0RIGPNREF VFHEIAOCBOA 8 amp RESPMSG Approved amp AUTHCODE 010101 amp AVSADDR Y amp AVSZIP Y amp HOS
175. e internet you need a special account called an Internet Merchant Account If PayPal is your merchant bank you do not need the Internet Merchant Account Your account provider or merchant acquiring bank works with a PayPal supported credit card processor Examples are First Data TSYS Acquiring Solutions formerly Vital Processing Services and Paymentech 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 issuing 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 car
176. e 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 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 1s 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 MERCHANTCOUNTRYCODE Optional Country code of the location where the transact
177. e of these optional items based on the agreed upon contractual terms The merchant may need to account for and enable additional data element fields and product features in their system s and in communications to TeleCheck s Authorization 07 January 2014 Gateway Developer Guide and Reference TeleCheck Electronic Check Processing TeleCheck NFTF Processing Overview B System Various optional data elements throughout each of the message packets could be affected by this requirement 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
178. e value pair string PARMLIST Example lt html 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 name SECURETOKEN value Fj 1AFUW t0 IOCUFOKh5WA gt lt input type hidden name SECURETOKENID value 9a9ea8208del413abc3d60c86cbh1f4c5 gt lt input type hidden name MODE value LIVE gt lt input type hidden name PARMLIST value INVNUM INV1234 amp AMT 25 50 amp CURRENCY USD amp PONUM P012345 gt lt form gt lt body gt lt html gt 46 07 January 2014 Gateway Developer Guide and Reference Configuring Hosted Checkout Pages Hosted Pages and Mobile Browsers ERR Ifyou choose to use PARMLIST then you can only pass the following 3 HTTP Post parameters to Payflow with PARMLIST SECURETOKEN SECURETOKENID and MODE optional If you try to pass in any other parameter such as VERIFY TRUE then you will receive an error message NOTE The MODE parameter will be deprecated 1n the future If you are using a test secure token instead of passing MODE TEST change the Form Action attribute value to the testing URL https pilot payflowlink paypal com If you are using Transparent Redirect with PARMLIST you must pass the credit card information ACCT EXPDATE and CSC in the PARMLIST For more information on Transparent Redirect see Integrating the Secure Token Without the Hosted C
179. ecimal 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 210 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions D TSYS Acquiring Solutions Purchasing Card Transaction Processing TSYS Acquiring Solutions Level 3 Required Parameters The parameters listed in the table below apply to Level 3 transactions as extended data Parameter Description COMMCODE Required Commodity code identifier for the business Character length and limitations 4 alphanumeric 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 VATREGNUM Required VAT registra
180. eck 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 07 January 2014 31 q Introducing the Gateway Checkout Solutions Supported Languages Automated Clearing House ACH For information on performing ACH transactions contact your PayPal Sales Representative Supported Languages The Payflow Gateway only supports customer input and API parameter values that are in regular ASCII English language characters Payflow does not support extended ASCII characters or any other character sets other than regular ASCII at this time Additionally the Payflow hosted checkout pages and PayPal manager account settings pages are available in English only For information on a similar PayPal product that offers multi lingual support see Website Payments Pro Hosted Solution Recurring Billing Service The Recurring Billing Service is a scheduled payment solution that enables you to automatically bill your customers at regular intervals for example you can bill your customers a monthly fee of 42 for 36 months with an initial fee of 129 You enroll separately for the Recurring Billing Service You can learn about the Recurring Billing Service in the Payflow Pro Recurring Billing Service User s Guide If you already have this service this user guide will show you how to define and manage recurring tran
181. ecline this is not a true decline Gateway Developer Guide and Reference 07 January 2014 149 150 TeleCheck Electronic Check Processing Response Code Values Sale Referral Responses Code 09 69 Description Risk Referral requested Call Center Merchant Action Contact TeleCheck Contact TeleCheck Sale Error Responses Code 46 49 98 27 78 97 Description Merchant setup does not allow this type of transaction Processor Not Available Invalid MICR Data Invalid Value for Field Invalid RT Routing Bank Number Unable to Process Time Out Merchant Action Re send message later Re send message later Adjustment Code Values Adjustment Refund Change Void Responses Code 26 46 19 80 81 Response Codes For Status Response Packets Description Merchant allowed to send full partial adjustments refunds without transaction errors Merchant setup does not allow this type of transaction Original transaction was not approved Refund or partial amount is greater than the original sale amount Unable to locate original transaction TCK Trace ID Response Codes for Status Response Packets Merchant Action No action needed Adjustment cannot be processed by Adjustment cannot be processed by Adjustment cannot be processed by Adjustment cannot be processed by Code OK Description Inquiry POS system Packet was accepted and successfully process
182. ed MAGTEKCARDTYPE Required MPSTATUS Required REGISTEREDBY Required Description The code which indicates what type of Encryption Block is used 1 MagneSafe V4 V5 compatible 2TDEA CBC Encryption IV 0 Block contains data only 2 1Pad V1 compatible 2TDEA CBC Encryption Block contains header data Encrypted Track 2 information returned by a MagneSafe device when a card is Swiped 20 character string returned by a MagneSafe device when a card is swiped The code which indicates what type of Card Data Format is being submitted 1 Encoding Format for Financial Transaction Cards ISO 7811 MagnePrint Status of Card Swipe This is an alpha numeric string returned by a MagneSafe device when a card is swiped An alpha numeric entry between 1 and 20 characters long Data Type Length Integer l String String 20 char Integer Alphanumeric a 1 to 20 char Z A Z 0 9 Gateway Developer Guide and Reference 07 January 2014 255 Payflow Gateway MagTek Parameters Parameters for Encrypted Card Swipe Transactions Field Required Description Data Type Length SWIPEDECRHOST Required MAGT is the only value that is accepted in the SWIPEDECRHOST parameter If you pass a different value you will see RESULT 7 and MAGTRESPONSE with an error message in the response DEVICESN Optional The device serial String number ENCTRACK1 Optional Encrypted Track 1 String information returned
183. ed 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 Set to HIGH to obtain information about a partial authorization in the response Example Partial Authorization The following is an example partial authorization 1 You submit the initial authorization as a partial authorization TRXTY PE 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 74 07 January 2014 Gateway Developer Guide and Reference Submitting Credit Card Transactions 6 Submitting Purchasing Card Transactions Approval amp AUTHCODE 11111 amp HOSTCODE ES amp PROCAVS U amp TRANSTIME 2010 04 21 11 30 45 amp AMT 80 00 amp 0RIGAMT 100 00 amp BALAMT 0 amp ACCT 1111 amp EXPDATE 0119 amp 1AVS 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
184. ed by TeleCheck 07 January 2014 Gateway Developer Guide and Reference TeleCheck Electronic Check Processing TeleCheck Authorization Requirements B Code Description ACK Inquiry Packet was accepted by the TeleCheck Host NAK Inquiry Packet was not successfully processed by TeleCheck general error 49 Inquiry Packet was not successfully processed by TeleCheck scheduled maintenance 97 Inquiry Packet was not successfully processed by TeleCheck timeout 27 Inquiry Packet was not successfully processed by TeleCheck invalid data 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 Itis 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 iden
185. eference list of Countries and Regions PayPal Currency Codes PayPal uses 3 character ISO 4217 codes for specifying currencies in fields and variables Please refer to the table of currencies supported by PayPal 86 07 January 2014 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 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 52 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
186. end 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 TEMPLATE Determines whether to use one of the two redirect templates Layout A or B or the embedded template Layout C For Layouts A or B pass TEMPLATEA or TEMPLATEB Layouts A amp B auto redirect to mobile optimized pages if a supported mobile browser is detected No action is required from the merchant for Layouts A amp B For Layout C pass MOBILE for the mobile optimized page or MINLAYOUT for the default Layout C embedded template 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 44 07 January 2014 Gateway Developer Guide and Reference Configuring Hosted Checkout Pages 3 Using a Secure Token to Pass Hosted Pages Customization Parameters Customize Parameters Variable Description PAGECOLLAPSEBGCOLOR Sets the color of the border around the embedded template C Example PAGECOLLAPSEBGCOLOR 993300 PAGECOLLAPSETEXTCOLOR Sets the color of the words Pay w
187. eporting 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 one of the following values e Zip code of the destination where the merchandise is to be shipped e Ifthe above 1s not available Zip code of the location where the merchant executed the transaction Character length and limitations 15 alphanumeric characters TAXAMT Optional Total tax amount 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 12 numeric characters L DESC1 Optional Description of this line item 1f not provided DESC1 if present is used Character length and limitations 140 alphanumeric characters 166 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions American Express Purchasing Card Transaction Processing D Field Description L AMT1 Optional Charge for this line item Must include a decimal and be exact to the cent 42 00 not 42 and exclude comma separators 1234 56 not 1 234 56 Character length and limitations 12 numeric characters L QTY1 Optional Quantity of this line item Char
188. er 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 1f 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 Cielo Payments 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
189. er 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 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 HHHHH HH 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 Invalid or unsupported currency code Field format error Invalid information entered See RESPMSG Not a transaction server O mA NN Too many parameters or invalid stream Gateway Developer Guide and Reference 07 January 2014 105 106 Transaction Responses RESULT Values and RESPMSG Text RESULT 10 11 12 13 19 20 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 RESPMSG and Explanation Too many line items Client
190. er Guide and Reference Processors Requiring Additional Transaction Parameters Cielo Payments Additional Credit Card Parameters A Cielo Payments Additional Credit Card Parameters In addition to the core credit card parameters Cielo Payments formerly 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 Express In addition t
191. ers 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 MERCHANTINVNUM MERCHANTNAME MERCHANTURL MERCHANTVATNUM MERCHANTZIP MISCDATA REPORTGROUP SILENTTRAN STREETS3 VATINVNUM VATTAXAMT VATTAXRATE Added response parameters DUPLICATE response EXTRMSG response 22 07 January 2014 Gateway Developer Guide and Reference Revision History E 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 Gateway Developer Guide and Reference 07 January 2014 23 No Revision History 24 07 January 2014 Gateway Developer Guide and Reference Introducing the Gateway Checkout Solutions The Gateway provides checkout solutions for novice and advanced use It provides merchants with a rich set of options to handle payment transactions e About the Gateway Checkout Solutions on page 25 e About the Gateway Transaction Flow on page 27 e About Security on page 28 e Processing Platforms Supporting Card Present Transactions on page 30 e Supported Payment Types on page 31 e Recurring Billing Ser
192. flow SDK and programming language that you are using See your integration documentation for details Parameter Description HOSTADDRESS Required Gateway server name HOSTPORT Required Use port 443 TIMEOUT Required Time out period for the transaction PayPal recommends a minimum time out value of 30 seconds 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 PROXY PASSWORD Optional Proxy server logon password In addition to the connection parameters 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
193. follow these steps 1 Log in to PayPal Manager at https manager paypal com 2 Click ActivateYour Account and follow the on screen instructions 3 Change the URL within your web or desktop application to point to the live Gateway server host addresses 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 NOTE Ifyou are using an older version of the SDK you will notice that the live and testing URLs have changed Be sure to use the URLs mentioned above and remove the transaction from the end of the URL Testing Your PayPal Payments Advanced and PayPal Payments Pro Integration Ifyou have a PayPal Payments Advanced or a PayPal Payments Pro account and you would like to use the testing URL to test your integration you will first need a PayPal Sandbox test account If you do not have a Sandbox account go to https sandbox paypal com and follow the instructions to create this account You will need to enter your Sandbox account information on the Setup page of PayPal Manager http manager paypal com Service Settings gt Hosted Checkout Pages gt Setup Fill in the PayPal Sandbox Email Address field and click Save You can now test your Payflow Gateway integration against the testing URL https pilot payf lowpro paypal com Passing Information to and
194. 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 contains a radio frequency identification RFID chip for communicating with a point of sale device with an RFID receiver Character length and limitations alpha characters 140 07 January 2014 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
195. from the Merchant to TeleCheck are authorization messages Messages sent from TeleCheck to the Merchant are Response messages The sale transaction process is often referred to as a 2 part hand off The process begins with the merchant s Authorization message TeleCheck 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 2 Merchant Delayed Capture Request Delayed Capture Response TeleCheck Parameters Parameters used for processing electronic checks through TeleCheck are described in this section 144 07 January 2014 Gateway Developer Guide and Reference TeleCheck Electronic Check Processing TeleCheck Parameters B Required TeleCheck Parameters Field Description USER Required Case sensitive login ID for the Gateway account that you created while registering for the account In the future each account will allow multiple users This parameter will specify the user Character length and l
196. gned 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 characters Paymentech Salem
197. gth 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 216 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions WorldPay Purchasing Cards Transaction Processing D Field Description 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 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
198. hants 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 e 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 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 Whether 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 COMMENTI and COMMENT2 to help tie reports to your orders customers or to report on other information about the tr
199. haracter 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 TRXTYPE 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 94588 amp ALTTAX AMT 1 00 amp CUSTVATREGNUM 11111 amp LOCALTAXAMT 1 OO amp NATIONALTAXAMT 1 00 amp COMMCODE 22222 amp VATAXAMT 1 00 amp VATAXPERCENT 1 0 amp TAXEXEMPT Y amp DISCOUNT 1 00 amp FREIGHTAMT 1 00 amp DUTYAMT 1 OO amp SHIPTOZI P 3 3333 amp SHI PFROMZI P 44444 amp SHI PTOCOUNTRY 84 0 amp ORDERDA TE 020725 amp L COMMCODE1 123456789ABC amp L DESC1 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 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 require
200. haracters AIR Optional Number of passengers on this trip NUMBEROFPASSENGERS Character length and limitations numeric AIR ISETICKET Optional If this 1s 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 Gateway Developer Guide and Reference 07 January 2014 137 138 Processors Requiring Additional Transaction Parameters Vantiv Additional Credit Card Parameters Other Parameters Field BILLTOFIRSTNAME BILLTOLASTNAME INVNUM ORDERDATE Description 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 characters 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
201. haracters L QTYn 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 costTn 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 208 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions TSYS Acquiring Solutions Purchasing Card Transaction Processing 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 JOHNSON amp TAXAMT 1 O6 amp BILLTOZIP 9458 8SALTTAXAMT 1 OO amp CUSTVATREGNUM 11111 amp LOCALTAXAMT 1 OLENATIONALTAXAMT 1 02 amp COMMCODE 22222 amp VATAXAMT 1 O3 amp VATAXPERCENT 55 amp TAXEXEMPT N amp DISCOUNT 50 amp FR RIGHTAMT 1 OO amp DUTYAMT 1 OO amp SHIPTOZIP 33333 amp SHIPFROMZIP 44444 amp SHIPTOCOUNTRY 840 amp ORDERDATE 081125 amp L COMMCODE1 123456789ABC amp L DESC
202. he Payflow Message Protocol o a aoao a a eee ee ee 156 Payflow Message Protocol Headers 2 a a a a a a 157 Transaction Message aoao a a 158 Integrator Provided Data o oaoa a 160 Chapter D Submitting Purchasing Card Level 2 and 3 Transactions 163 About Purchasing Cards aoao aoaaa a a a a 163 About Program Levels 1 aaa 163 Accepted BIN Ranges aaou a 164 About American Express Purchasing Card Transactions 164 8 07 January 2014 Gateway Developer Guide and Reference Content a Supported Transaction Types 2 a a a a a a 164 Avoiding Downgrade a oaoa oaoa a a a a e a 165 Submitting Successful Level 3 Transactions oaoa aoea a 000008 165 Edi CheCk s aea gaa a E a aa a e a a aeo A k aek oe oa 4 E 165 Accepted BIN Ranges aoaaa a a a 166 American Express Purchasing Card Transaction Processing 166 American Express Level 2 Parameters for American Express 166 Example American Express Level 2 Transaction Parameter String 169 American Express Level 3 Parameters 1 0 a a a a 169 Example American Express Level 3 Transaction Parameter String 171 Elavon Formerly Nova Purchasing Card Transaction Processing 172 Elavon Level 2 Parameters 1 a a a a 172 Elavon Additional Parameters aoa a oaoa a a a a a 172 Example Elavon Level 2 Transaction Parameter String a a aoa aa a a a a 173
203. heck chapter Updated MICR values in Testing TeleCheck Transactions section Added TeleCheck Adjustment Response Code Values table 20 07 January 2014 Gateway Developer Guide and Reference Revision History a Date Description Updated parameters and examples Added a description for the 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 the Litle parameters STREET2 STREET3 to BILLTOSTREET2 BILLTOSTREETS Corrected the 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 ZIP COUNTRY Updated processor and entity names Vantiv previously known as Fifth Third Processing Solutions PayPal Australia previously known as First Data Australia January 2012 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 Gateway Developer Guide and Reference 07 January 2014 21 a Revision History Date January 2012 cont Description Added request paramet
204. heckout Pages Transparent Redirect on page 34 Hosted Pages and Mobile Browsers In PayPal Manager you can select one of 3 hosted pages Layout templates Layouts A and B the redirect templates or Layout C the embedded template Layout A is the default Layout Layout A Layout B Layout C You can also dynamically select your hosted pages Layout template using the form post TEMPLATE parameter This will override your default Layout template set in PayPal Manager Please see Using a Secure Token to Pass Hosted Pages Customization Parameters for more information on passing form post parameters to customize the checkout experience Mobile Optimized Checkout Pages PayPal s hosted checkout pages are mobile optimized for iPhone 1Pod and Android devices This mobile optimized experience is available for all 3 Layout templates A B and C In the case of Layouts A and B PayPal will auto detect if the checkout page is being viewed from a supported mobile browser and will redirect to the mobile optimized checkout page For Layout C PayPal does not automatically redirect mobile users to a mobile optimized flow The reason is that if PayPal automatically showed a mobile optimized embedded template within a merchant web page that may not be mobile optimized this can create unexpected and undesirable results To display the mobile checkout page for Layout C you must detect the Gateway Developer Guide and Reference 07 January 2014 47 3 Co
205. hip 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 HANDLINGAMTN for all line items Total Line Item Amount Summation of L QTYn L COSTn 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 07 January 2014 165 oO D Submitting Purchasing Card Level 2 and 3 Transactions American Express Purchasing Card Transaction Processing Accepted BIN Ranges The following BIN ranges are accepted for American Express Level 2 and Level 3 transactions 37326 37429 37857 37859 37873 37965 American Express Purchasing Card Transaction Processing The American Express supports Level 2 transaction data 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 r
206. hort list of generated values plus all of the transaction data that was submitted for the transaction set the optional ECHODATA parameter to True This 1s 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 Passing Other Data to Your Server Using Post or Silent Post The USER1 through USER10 Payflow parameters are ten optional string type parameters intended to store your temporary data such as variables session IDs order numbers and so on These parameters enable you to pass internal information to your server using the Post or Silent Post feature NOTE USER1 through USER1O are not displayed to the customer and are not stored in the PayPal transaction database 50 07 January 2014 Gateway Developer Guide and Reference Payflow SDK The Payflow Software Development Kit SDK 1s 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 51 e Activating Your Payflow Gateway Account on page 52 e Host URL Addresses on page 52 NOTE Fach SDK includes full API documentation IMPORTANT The Payflow SDK is available as a NET or Java library Using these SDKs is recommended to simplify integration Alternately you can build your own API by
207. ic SHIPTOZIP Required Destination zip code SHIPTOCOUNTRY Optional Destination country The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wiki ISO_3166 1 numeric 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 Required Description L PRODCODEN Optional Product code L QTYn Required Quantity Character length and limitations numeric characters L UOMn Required Unit of measure TAXAMTN Optional Tax amount Character length and limitations numeric L TAXRATEN Optional Tax rate Character length and limitations 4 numeric characters 198 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 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
208. ided 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 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 SHIPTOCOUNTRY Optional Destination country code The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wiki ISO_3166 1_ numeric Character length and limitations 3 alphanumeric characters ALTTAXAMT Optional Alternate tax amount Character length and limitations 9 numeric characters
209. ies 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 1 alphanumeric character Y or N Gateway Developer Guide and Reference 07 January 2014 121 122 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 INVNUM Description Optional Merchant invoice number The merchant invoice number 1s used for authorizations and settlements and depending on your merchant bank will appear on your customer s credit card statement and your bank
210. 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 SecureNet Level 3 Visa Extended Data The parameters listed in the table below apply to Level 3 Visa transactions as extended data Parameter Description 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 yymmdd with no slashes or dashes For example January 28 2013 is 130128 Character length and limitations 6 numeric characters SHIPTOCOUNTRY Optional Destination country code
211. iginal transaction is valid in reference transactions for 12 months If the original transaction was processed by the PayPal processor pass either the PPREF or PNREF of the original transaction in the ORIGID parameter 2 Capture the authorized funds for a partial shipment of 66 When you deliver the first 66 worth of product you use a normal delayed capture transaction to collect the 66 Set ORIGID to the value of PNREF in the original authorization as in this transaction request TRXTY PE D amp PWD x1y2Z3 amp PARTNER PayPal amp VENDOR SuperMerchant amp USER SuperMerchant amp ORIGID VXYZ01234567 SAMT 66 00 The following is the response RESULT 0 amp PNREF VXYZ012345684 amp AUTHCODE 25TEST amp AVSADDR Y amp AVSZIP N NOTE The TENDER parameter is not required in this step The TENDER of the capture will be the same as that of the original transaction Gateway Developer Guide and Reference 07 January 2014 T 18 Submitting Credit Card Transactions Submitting Reference Transactions Tokenization 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 transacti
212. ill 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 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 MERCHANTCOUNTRYCODE Optional Country code of the location where the transaction took place The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wiki MISO_3166 1_ numeric Character length and limitations 3 character country code 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 descripti
213. illimetre MMT Million MIO Million cubic metres HMQ Million international units MIU Minute MIN Month MON Nautical mile 1852 m NMI Net register ton NTT Newton NEW Number NMB Number of articles NAR Number of bobbons NBB Number of cells NCL Number of international units NIU Number of packs NMP Number of pairs NMR Number of parcels NPL Number of parts NPT Number of rolls NRL Ohm OHM Ounce GB US 28 349523 g ONZ Ounce GB US 31 103448 g syn Troy ounce APZ Pascal PAL Pennyweight GB US 1555174 g DWT Piece PCE Pint 0 568262 dm3 PTI Pound GB US 0 45359237 kg LBR Proof gallon PGL 07 January 2014 Gateway Developer Guide and Reference Codes Used by FDMS South Only Units of Measure Gq 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 Square 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
214. imitations 64 alphanumeric characters VENDOR Required Case sensitive Vendor ID that you created while registering for the account Character length and limitations 64 alphanumeric characters PARTNER 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 PWD Required Case sensitive 6 to 32 character password that you created while registering for the account Character length and limitations 32 alphanumeric characters AMT 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 AUTHTYPE 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 BILLTOCITY Required Account holder s city Charac
215. ion followed by a delayed capture NOTE PayPal 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 Gateway Developer Guide and Reference 07 January 2014 65 66 Submitting Credit Card Transactions Submitting Balance Inquiry Transactions NOTE Ifyou 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 79 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 75 NOTE You are allowed to perform one delayed capture transaction per authorization transaction Required Authorization Transaction Parameters To perform a delayed capture transaction pass the following parameter Parameter Description ORIGID Required by so
216. ion Service Responses From PayPal oaoa a a a aa 101 Card Security Code Results a a a a a a a a a a 103 Normalized Card Security Code Results oa aoa a a a a a a a a a 08 103 BALAMT Response and Stored Value Cards aoon oaoa a a 0 0 a eee ee ee es 103 07 January 2014 Gateway Developer Guide and Reference Content a American Express Stored Value Card Example 2004 103 PNBEPseewaee darana a ew ee ee ae ee DEE eo we 104 RESULT Values and RESPMSG Text 0 0 0 000000 002 eee 104 RESULT Values For Communications Errors 2 2 ee ee a 111 Processor specific Response Parameters 2 a ee e a a a 112 Litle Response Parameters aooo a a a 113 Chapter A Processors Requiring Additional Transaction Parameters 115 American Express Additional Credit Card Parameters a oa aoa oa a a a a a 115 Retail Transaction Advice Addendum for SWIPE transactions 115 Internet Transaction Data aooo a a a a 116 Address Verification Service Parameters oaoa aa a a a a 117 Location Transaction Advice Addendum Parameters a aoao a a a a a a a a 117 Transaction Advice Detail Parameters a aoa aoa oa a a a a a a 119 Airline Passenger Data Parameters aoa aoao a a a a a 119 American Express Other Parameters aoao aoa a a a a a a a a a a a 120 Elavon Additional Credit Card Parameters 0 0 a a 121 First Data Merchant Services Nashville Additional Credit Card Par
217. ion 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 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 MERCHANTCOUNTRYCODE Optional Country code of the location where the transaction took place The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wiki ISO_3166 1_ numeric Character length and limitations 3 character country code MERCHANTLOCATIONID 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 196 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions D Paymentech Salem New Hampshire Purchasing Card Transaction Processing Field Description MERCHANTID Required American Express assi
218. ion took place The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wiki ISO_3166 1 numeric Character length and limitations 3 character country code 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 Gateway Developer Guide and Reference 07 January 2014 135 Processors Requiring Additional Transaction Parameters A SecureNet Additional Credit Card Parameters for American Express Transaction Advice Detail Parameters Field ADDLAMTN ADDLAMT TY PEN Description 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 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 AIR DEPARTUREDATE AIR PASSENGERNAME AIR ORIGIN AIR DESTINA
219. ional 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 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 OFY3 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 QTY4 Optional Quantity of this line item Character length and limitations 3 numeric characters Gateway Developer Guide and Reference 07 January 2014
220. ional Tracking number Character length and limitations 1 to 30 alphanumeric characters Optional Drop off address1 Character length and limitations 1 to 40 alphanumeric characters Optional Drop off city Character length and limitations 2 to 30 alphanumeric characters Optional Drop off state Character length and limitations 2 alphanumeric characters Optional Drop off postal or zip code Character length and limitations 3 to 15 alphanumeric characters Optional Drop off country The payflow API accepts 3 digit country codes Refer to http en wikipedia org wiki ISO_3166 1 numeric Character length and limitations 3 character country code Optional UNSPSC code Character length and limitations 1 to 30 alphanumeric characters Example American Express Level 3 Transaction Parameter String TRXTYPE S amp TENDER C amp partner partner amp PWwD test amp USER test amp ACCT 378734493671000 amp EXPDATE 1213 amp AMT 5 0OO0 amp COMMENT1 PCARD Test amp COMMENT2 Testing amp BILLTOZIP 940151 234 amp BILLTOSTREET 123 Lincoln WAY amp CVV2 0123 amp SHIPTOCOUNTRY 840 amp CUSTCODE 12345 amp FREIGHTAMT 1 00 amp ORDERDATE 021700 amp HANDLINGAMT 1 OO amp PONUM 123456789012345678 9012345 amp SHIPFROMZIP 940151234 amp SHIPTOZIP 940151234 amp TAXAMT 1 OO amp TAXEXEMPT N amp L _UPC1 PN amp L QOTY1 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 QTY2 1 amp L U
221. ional 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 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 C Credit card D Pinless debit K Telecheck 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 Authorization B Balance Inquiry C Credit Refund D Delayed Capture F Voice Authorization I Inquiry L Data Upload N Duplicate Transaction NOTE A type N transaction 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
222. ional 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 through 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 enha
223. 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 07 January 2014 67 6 Submitting Credit Card Transactions Submitting Card Present SWIPE Transactions Processing Platforms Supporting Card Present Transactions The following processing platforms support card present transactions For instructions on setting up or changing your processor see the Processor Setup Guide PDF NOTE PayPal Australia FDRA merchants with a 12 digit merchant ID can contact Payflow support to request a 16 digit merchant ID American Express American Express APAC Elavon 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 Vantiv WorldPay Card Present Transaction Syntax Use the SWIPE parameter to pass the Track 1 or Track 2 data the card s magnetic stripe information Include either Track 1 or Track 2 data up to 80 alphanumeric characters If Track 1 is physically damaged the POS application can send Track 2 data instead The track data includes the disallowed equal sign character To enable you to use the data the SWIP
224. is trip including the cities of origin and destination where a maximum value of 10 is allowed For example AIR 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 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 AIR CARRIERN Optional Two character airline code for each unique 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 AIR CARRIERN values for the following trip are UA and AA e UA flight from IAD to DEN UA flight from DEN to LAX UA flight from LAX to SFO 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 c
225. it error Void error Capture error Failed AVS check Cannot exceed sales cap How to test using Payflow Gateway 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 Diners 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 1s configured by PayPal customer service to use the AVS Deny feature Applies to ACH transactions only 90 07 January 2
226. ith 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 Parameters 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 NOTE This parameter will be deprecated in the future Instead of using this parameter to specify if you are passing a live or test secure token post your form parameters to either the live URL or to the new testing URL See the Host URL Addresses section for more information PARMLIST A HTTP Post parameter used with a secure token PARMLIST takes a string of name value pairs as its value Payflow parses out these name value pairs and uses them to run the transaction PARMLIST 1s especially useful for merchants that already use this parameter with the Payflow SDK and want to use an existing name value pair string For more information see the Using the PARMLIST Parameter section of this guide SECURETOKEN SECURETOKENID Used with the secure token SHOWAMOUNT If you pass in 0 amount an
227. le 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 16 alphanumeric characters Unique transaction ID returned from some processors for all credit card transactions NOTE This field is only used by merchants who authorize transactions through the Gateway but settle through a third party solution Character length and limitations 15 numeric characters Value return from some proessors for all credit card transactions NOTE This field is only by merchants who authorize through the Gateway but settle through a third party solution Character length and limitations 16 alphanumeric characters Gateway Developer Guide and Reference 07 January 2014 99 8 Transaction Responses Credit Card Transaction Responses Field ORIGAMT CARDTYPE RMA TLMATCH PHONEMATCH EXTRSPMSG TRANSTIME DUPLICATE DATE TO SETTLE Description 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 The credit card type Is returned in an inquiry response when you send a VERBOSITY request
228. 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 cent 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 07 January 2014 Gateway Developer Guide and Reference VERBOSITY Processor Specific Transaction Results Se
229. 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 limitations 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 Op
230. ll communicate directly with MagTek s Magensa servers to retrieve the payment card information Payflow then passes the transaction data onto your merchant bank Supported Transaction Types Encrypted card swipe or Qwick Code PCode requests can be used with the following Payflow transaction types e Authorization TRXTYPE A e Credit TRXTYPE C 07 January 2014 Gateway Developer Guide and Reference Payflow Gateway MagTek Parameters so Passing Encrypted Card Swipe Data and Qwick Codes to the Payflow Gateway e Delayed Capture TRXTYPE D e Sale TRXTYPE S e Void TRXTYPE V Encrypted Card Swipe Payflow Example The purpose of this example is to show you how to format a request You cannot use the values in this example for testing You must have a MagneSafe card reader and test credit cards or live credit cards to send a request to the Payflow Gateway Please contact MagTek for more information on obtaining card readers Request This request contains regular Payflow parameters along with required MagTek parameters TRXTYPE A amp TENDER C amp VENDOR MerchantUserID amp PARTNER PayPal amp USER UserIDIfAvailOrSameAsVendor amp PWD Pwd4Gateway amp VERBOS ITY HIGH amp CARDTYPE 1 amp SWIPEDECRHOST MAGT amp ENCTRACK2 82C6 9E600FF72FC1755509A76AD04 9E8 96A6E EA64D9BB2F203DF8AAD 8265E90F4F8952A9ACO3CFC amp AMT 11 008ENCMP 71AB2EE Al5887C36B8A23FEDICE7E6404D98119E24D15549E9B69AB6ABFB251C4A607D6A7I18 B494449B506B 555BF8ED5FA4A9E2A6B814B
231. loper Guide and Reference 07 January 2014 153 O B TeleCheck Electronic Check Processing TeleCheck Authorization Requirements merchant should link directly to the TeleCheck hosted URL provided above State fees are updated on a regular basis and linking to a TeleCheck hosted page will minimize the number of maintenance updates required The merchant may choose how to display the state fees Suggestions include a new pop up window a full browser window or directly on the checkout page AK 30 HI 30 MN 30 ce OH VI 20 AL AR AZ CA CO CT DE DC FL GA GU 30 25 25 25 20 20 40 25 25 f 30 20 IA ID IL IN KS KY LA M M ME MI 30 20 25 20 30 50 25 25 35 25 25 MO MS MT NC ND N N NI 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 30f 20 50 VT WA WI WV WY 25 300 25 25 30 Authorization Sales Decline Error 154 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
232. low Link legacy parameters and the equivalent Payflow parameters parameter table Removed legacy Payflow Link parameters with identical Payflow equivalents Updated the description of the parameters BILLTOSTATE and SHIPTTOSTATE in the Core Credit Card Parameters table Added a note to the introduction of the Submitting Credit Card Transactions chapter Revised the introduction to the Payflow SDK chapter Updated some of the external links in the guide Corrected the format of the ORDERDATE parameter in TSYS Acquiring Solutions Level 3 Visa Parameters 28 Dec 2012 Updated the description of the Driver s Licencse DL field in Required TeleCheck Parameters 11 Dec 2012 Added info on forcing the Cancel URL with layout template C to Configuring Hosted Pages Using PayPal Manager Added Secure Token error codes to Secure Token Errors and to RESULT Values and RESPMSG Text 04 Oct 2012 Added a new section on Hosted Pages and Mobile Browsers and updated the Configuring Hosted Checkout Pages chapter Added a new section Supported Languages Added a new section Using the PARMLIST Parameter Added information to the Host URL Addresses section 29 Aug 2012 Added the Payflow Gateway MagTek Parameters Appendix 31 July 2012 Added a list of Setup and Customize parameters in the section on Using a Secure Token to Pass Hosted Pages Customization Parameters These parameters override PayPal Manager settings for Hosted Pages Briefly explaine
233. matic Account Updater feature Added information on Testing the Litle Automatic Account Updater Feature 15 Jun 2013 Added information on Submitting Credit Refund Transactions for the PayPal processor Added the PAYMENTADVICECODE field to Credit Card Transaction Responses Added a note on problems with using legacy Payflow Link parameters with the Secure Token Updated the support contact information for enabling PayPal processor line item support in the PayPal Credit Card Transaction Request Parameters table Added a Level 3 Required Parameters table to TSYS Acquiring Solutions Level 3 Visa Parameters Added information on Reference Authorizations and Sales specific to the PayPal processor in the Example Reference Transaction section Updated URL paths 25 Apr 2013 Updated the description of the Driver s Licencse DL field in Required TeleCheck Parameters 22 Feb 2013 Updated the description of the Driver s Licencse DL field in Required TeleCheck Parameters 18 07 January 2014 Gateway Developer Guide and Reference Revision History E Date Description 28 Jan 2013 Added a new Appendix on Payflow Header Parameters Added information about duplicate parameters in the Name Value Parameter Syntax Guidelines In the Hosted Pages Chapter added the Passing Other Data to Your Server Using Post or Silent Post section and clarified that Silent Posts are returned for both approved and declined transactions Updated the Payf
234. me amp BILLTOLASTNAME Cardholder last name amp PARTNER PayPal amp PONUM 12345 amp PWD pwd amp SHIPTOZIP 94 045 amp BILLTOSTATE CA amp BILLTOSTREET 123 Main St amp TEND HR 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 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 07 January 2014 169 170 Submitting Purchasing Card Level 2 and 3 Transactions American Express Purchasing Card Transaction Processing Field SHIPTOZIP INVOICEDATE TAXAMT DESC FREIGHTAMT HANDL INGAMT L QTYn L UOMN L COSTN L DESCN L CATALOGNUMN L COSTCENTERNUMN Description Required Ship to postal code called zip code
235. me transaction types ID of the original transaction referenced The PNREF parameter returns this ID and it appears as the Transaction ID in PayPal Manager reports Limitations 12 case sensitive alphanumeric characters Submitting 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 processors in the near future As more processors are added this list will be updated accordingly WorldPay 07 January 2014 Gateway Developer Guide and Reference Submitting Credit Card Transactions Submitting Card Present SWIPE Transactions 6 Required Balance Inquiry Parameters To perform a balance inquiry on a pre paid card pass the following parameters Parameter Description TRXTY PE Required Set to B Limitations 1 alphanumeric character EXPDATE Required Expiration date of the pre paid card in the format MMYY For example 1215 represents De
236. 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 Credit Card Parameters Field Description AUTHDATE
237. mp BILLTOSTATE CA amp BILLTOZIP 951311234 amp BILLTOCOUNTRY 840 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 Gateway Transactions For details on how to format a Payflow transaction see the examples and the supporting documentation provided with your SDK or see Submitting Credit Card Transactions 56 07 January 2014 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 NOTE Some of the transaction types and features described in this chapter are not supported by all processors Be sure to check wi
238. mp BILLTOSTREET 123 Main St amp BILLTOZIP 4 9801 amp CVV2 248 amp TAXAMT 1 22 amp PONUM AB1234567 8 amp SHIPTOZIP 98765 amp TAXEXEMPT N Paymentech Tampa Level 3 Parameters Paymentech Tampa Level 3 Parameters Description TAXAMT Required Total tax amount Character length and limitations 9 numeric characters plus a decimal point 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 07 January 2014 201 202 Submitting Purchasing Card Level 2 and 3 Transactions Paymentech Tampa Level 2 Purchasing Card Transaction Processing Paymentech Tampa Level 3 Parameters FREIGHTAMT DUTYAMT SHIPTOZIP SHIPTOCOUNTRY SHIPFROMZI P DISCOUNT ALTERNATETAXID TAXEXEMPT CUSTCODE L COMMCODE1 L DESC1 L PRODCODE1 i TY1 L UOM1 Description Required Total shipping costs for this order Character length and limitations 9 numeric characters plus a decimal point 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 Required Sometimes called import tax Character length and limitations 9 numeric characters plus a decimal point No currency symbol Specify the exact amount to the cent using a decimal point use 34 00 not 34 Do not include comma separators
239. n 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 194 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions D 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 characters L QTY1 Optional Quantity of this line item Character length and limitations 3 numeric characters L DESC2 Opt
240. n 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 as closely as possible Required Parameters When Using the PNREF To perform an inquiry pass the following parameter Parameter Description ORIGID Required by some transaction types ID of the original transaction referenced The PNREF parameter returns this ID and it appears as the Transaction ID in PayPal Manager reports Limitations 12 case sensitive alphanumeric characters Set ORIGID to the PNREF Transaction ID in PayPal Manager reports value returned in the original transaction Gateway Developer Guide and Reference 07 January 2014 11 72 Submitting Credit Card Transactions Submitting Inquiry Transactions 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 x1y223 amp 0RIGID VPNE12564395 amp VERBOSITY HIGH Required Parameters When Using the CUSTREF To perform an inquiry transaction when using the CUSTREF pass the CUSTREF
241. nced 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 07 January 2014 163 o D Submitting Purchasing Card Level 2 and 3 Transactions About American Express Purchasing Card Transactions Level Description Level 1 Function as normal credit cards and are authorized and associated with normal transaction data in authorization and settlement Any merchant who accepts credit cards supports this level Level 2 Additional data regarding sales tax customer code purchase order number invoice number are captured at the point of sale 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 Level 3 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 re
242. nd PayPal Payments Pro merchants using Fraud Protection Service FPS should process their transactions as Authorizations with Delayed Capture instead of a Sale FPS transactions are treated as authorizations and if the transaction is submitted as a Sale Payflow auto captures such transactions approximately every two hours which may result in a 2 hour or more delay in settling the 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 07 January 2014 19 80 Submitting Credit Card Transactions Submitting Soft Merchant Information TRXTYPE S amp TENDER C amp USER SuperUser amp PWD SuperUserPassword amp VENDOR SuperUser amp PA RINER PayPal amp ACCT 5105105105105100 amp EXPDATE 1215 amp CVV2 123 amp AMT 99 00 amp BILLTOFI RSTNAME John amp BILLTOLASTNAME Smi th amp BILLTOSTREET 123 Main St amp BILLTOCITY San Jose amp BILLTOSTATE CA amp BILLTOZIP 12345 amp COMMENTI Reservation amp INVNUM 1234
243. nd Reference 07 January 2014 97 8 Transaction Responses Credit Card Transaction Responses Field RESPMSG AUTHCODE AVSADDR AVSZIP IAVS PROCAVS PROCCVV2 Description 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 1s required when submitting a force F transaction Character length and limitations 6 alphanumeric characters 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 n
244. nd limitations 60 alphanumeric and special characters CUSTIP Optional Account holder s IP address Character length and limitations 15 alphanumeric and special characters SHIPTOCOUNTRY Optional Numeric country code of ship to country Example USA 840 The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wiki ISO_3166 1_ numeric Character length and limitations 3 characters SHI PMETHOD 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 116 07 January 2014 Gateway Developer Guide and Reference Processors Requiring Additional Transaction Parameters American Express Additional Credit Card Parameters A Address Verification Service Parameters Field Description BILLTOSTREET Optional Account holder s street address number and street name Character length and limitations 30 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 o xxxxxxxxxxx international numbers
245. nfiguring Hosted Checkout Pages Hosted Pages and Mobile Browsers supported mobile browser and then explicitly pass the form post parameter TEMPLATE MOBILE The TEMPLATE form post parameter Layout TEMPLATE parameter value Behavior on a Mobile Device Layout A TEMPLATE TEMPLATEA Auto redirects to mobile optimized page Layout B TEMPLATE TEMPLATEB Auto redirects to mobile optimized page Layout C TEMPLATE MINLAYOUT default Use TEMPLATE MINLAYOUT for TEMPLATE MOBILE your general online checkout If you have a mobile optimized experience explicitly pass TEMPLATE MOBILE instead to show the mobile optimized page The mobile checkout pages are identical for all Layout templates Layouts A B and the mobile version of Layout C Additionally appearance customizations that you set in PayPal Manager or submit as form post parameters are not applied to the mobile pages The figures below show the mobile optimized page flow for a PayPal payment and for a credit card payment Mobile page flow for a PayPal payment Login Review Done Optional eee Ee Entry Merchant AMC Total 270 07 Merchant ABC x Merchant ABC Merchant ABC Total 27007 F E y tor v o E Eu sao or USD Ed Login PayPal iy Theta PayPal VA ia ig Card 21003 SIT DT USD Total 270 07 Log WHA omai and patisora e oct James Mice SRH E Re H FPO AE 05508 Ursos Soto a Ascelpt amp Confirmation Pay with a card HETS a z 48 07 January
246. nformation Secure Token Errors A successful Payflow transaction will return RESULT 0 in the response If your Secure Token transaction is unsuccessful you can pass the token 2 more times to Payflow before the token expires A Payflow Secure Token will expire e Ifthe same Secure Token is passed to Payflow a total of 3 times Gateway Developer Guide and Reference 07 January 2014 35 2 Secure Token Posting To the Hosted Checkout Page 160 161 162 e 30 minutes after the Secure Token was generated e When the token is used in a successful transaction If you receive one of the following error codes in the RESULT response parameter then your Secure Token has expired Secure Token already been used Indicates that the secure token has expired due to either a successful transaction or the token has been used three times while trying to successfully process a transaction You must generate a new secure token Transaction using secure token is already in progress This could occur if a customer hits the submit button two or more times before the transaction completed Secure Token Expired The time limit of 30 minutes has expired and the token can no longer be used If you see a different error code in the RESULT parameter refer to the RESULT Values and RESPMSG Text section for more information Posting To the Hosted Checkout Page 36 To display the transaction information to the Gateway hosted checkout pag
247. ng Partial Authorizations a o oa 2 a 73 When To Use Partial Authorizations 2 2 aa a a a a a 74 Required Partial Authorization Parameters 0 0 00 50 2 4 ee 74 Example Partial Authorization a aoa a a a a a 74 Submitting Purchasing Card Transactions 2 a a a a a a a a 75 Submitting Reference Transactions Tokenization ao a aoa a a a a a a a a a a 75 When To Use a Reference Transaction 0 a a a 76 Transaction Types That Can Be Used As the Original Transaction 76 Fields Copied From Reference Transactions a o oa oaoa aoa a a a a a 05005008 76 Example Reference Transaction 2 a aa a a a a a a 77 Data Upload Storing Credit Card Data on the Gateway Server 78 Submitting Sale Transactions a o oaoa oa o a a e a 79 When To Use a Sale Transaction ooo a a a a a a a a 79 Gateway Developer Guide and Reference 07 January 2014 5 a Content Chapter 7 Chapter 8 Additional Parameters For Sale Transactions 05025425 79 Typical Sale Transaction Parameter String 0000082 22s 80 Submitting Soft Merchant Information a 2 ee ee ee a 80 About Soft Merchant Information 2 a 80 Ways to Send Soft Merchant Information 0002 eee 80 Submitting Voice Authorization Transactions 0 000 eee eee 81 When To Use a Voice Authorization Transaction 6 82 Required Voi
248. ng to the server The ampersand amp is a special character that separates each name value pair in the parameter string PARAMINAME va lue amp PARAM2NAME va lue 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 length tag specifies the exact number of characters and spaces that appear in the value The following are valid Gateway Developer Guide and Reference 07 January 2014 53 5 Sending a Simple Transaction to the Server Payflow Connection Parameters COMPANYNAME 14 Ruff amp Johnson COMMENT 1 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 Do not use spaces in values Enclose the NVP parameter string in quotation marks 9 Do not place quotation marks within the body of the NVP parameter string Separate all NVPs using an ampersand amp Set the VERBOSITY transaction parameter to HIGH to have the response return detailed information Act upon the returned values th
249. nsaction response parameters Parameter Description CCUPDATED Y This response parameter is returned if either or both the account number and expiration date have changed ACCT If the card number has changed the last 4 digits of the new card number will also be returned in the ACCT response parameter Should you require the full credit card number you will need to contact Litle to obtain the complete card number EXPDATE If the card expiration date has changed the updated expiration date will also be returned in the EXPDATE response parameter Gateway Developer Guide and Reference 07 January 2014 113 8 Transaction Responses Processor specific Response Parameters As a result merchants utilizing this feature should check for the presence of the CCUPDATED Y response parameter and if it is returned should also check for the presence of the ACCT and EXPDATE response parameters to determine what information has been updated If you would like to test your integration for this feature see Testing the Litle Automatic Account Updater Feature on page 92 114 07 January 2014 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 115 e Elavon Additional Credit Card
250. o enable line item support send an email from the Primary email address on the account to payflow support paypal com Limitations Nine numeric characters 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 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 BILLTOSTREET Conditional Bill to street address NOTE Some merchants maybe required to pass this billing information Please test your integration first to determine if the billing information fields are required Limitations 100 character string BILLTOCITY Conditional Bill to city address NOTE Some merchants maybe required to pass this billing information
251. o 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 IAVS responses are for advice only This value does not affect the outcome of the transaction Indicates whether address verification service response 1s 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 98 07 January 2014 Gateway Developer Guide and Reference Transaction Responses Credit Card Transaction Responses 8 Field HOSTCODE RESPTEXT PROCCARDSECURE ADDLMSGS PAYMENTTYPE CORRELATIONID AMEX ID AMEXPOSDATA CCTRANS ID CCTRANS POSDATA Description The raw response code
252. o 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 07 January 2014 125 126 Processors Requiring Additional Transaction Parameters Paymentech Salem New Hampshire Additional Credit Card Parameters for American Express Field CUSTHOSTNAME CUSTBROWSER CUSTIP SHIPTOCOUNTRY SHI PMETHOD SKU Description 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 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 Optional Account holder s IP address Character length and limitations 15 alphanumeric and special characte
253. on page 46 IMPORTANT Use only the Payflow parameters described in this guide with the Secure Token If you are using the legacy Payflow Link HTML input tag integration refer to the Payflow Link User s Guide for information on legacy Payflow Link features supported by your integration 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 Payments 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 1n 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 canno
254. on request TRXTYPE S amp TENDER C amp PWD x1y223 amp PARTNER PayPal amp VENDOR SuperMerchant amp USER SuperMerchant amp ORIGID VXYZ01234567 SAMT 34 00 The following is the response RESULT 0 amp PNREF VXY2Z0123456 9SAUTHCODE 25TEST amp AVSADDR Y amp AVSZIP N NOTE Ifthe original transaction was processed by the PayPal processor pass either the PPREF or PNREF of the original transaction in the ORIGID parameter Also if the original transaction was created using Express Checkout or a Billing Agreement set the TENDER parameter to TENDER P 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 ACCT e EXPDATE This is an example upload transaction request TRXTYPE L amp TENDER C amp ACCT 5105105105105100 amp SEXPDATE 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 v1 9A2E710FCF amp RESPMSG Approved amp TRANSTIME 2011 11 02 16 53 58 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 RE
255. onal Transaction Parameters A Paymentech Salem New Hampshire Additional Credit Card Parameters for American Express Field Description SHIPTOSTREET Optional Shipping street address Character length and limitations 30 characters SHIPTOCOUNTRY Optional Numeric country code of ship to country Example USA 840 The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wiki ISO_3166 1 numeric 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 SHI PTOPHONENUM 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 Gateway Developer
256. ons 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 Feature Hosted checkout page including an iFrame version PayPal payments Bill Me Later payments Available to US merchants only on Hosted checkout pages PayPal branding on full page templates Transparent Redirect Supports PayPal as a processor and an acquirer Credit and debit cards Level 2 and Level 3 purchase cards TeleCheck guaranteed electronic checks ACH electronic checks Virtual Terminal support including card present data passage Virtual Terminal API PayPal Payments Advanced Payflow Link Yes Included Included Yes Payflow Link only Limited access Authoriz
257. oper Guide and Reference 07 January 2014 115 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 QTYn 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 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 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 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 a
258. or Android uDynamo for phones and tablets with audio jack port e PINPads IPAD PINPad available as standard model and also with signature capture support For more information go to http www magtek com V2 products secure card reader authenticators index asp Mag Tek Qwick Codes MagTek offers a subscription based service to consumers named Qwick Codes Instead of handing over plastic cards to store clerks or inserting them into unattended terminals like ATMs or gas pumps that may have been rigged with skimmers to steal card data consumers can scan or type a Qwick Code from their smartphone or computer The Qwick Code token is used instead to initiate a transaction whereby the merchant or ATM s processor can gather the actual card data on the back end of the transaction where it can be better secured and shielded from potential compromise Qwick Code tokens are also known as Protection Codes or PCodes Passing Encrypted Card Swipe Data and Qwick Codes to the Payflow Gateway The Payflow Gateway can process transactions for merchants who already have MagneSafe card readers or who accept MagTek Qwick Codes You must have a MagneSafe card reader or the required Qwick Code information to use the MagTek specific parameters described below Please contact MagTek directly for more information on obtaining the required card readers and codes When you pass MagneSafe encrypted card swipe data or a Qwick Code to the Payflow Gateway Payflow wi
259. or 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 07 January 2014 Gateway Developer Guide and Reference Submitting Credit Card Transactions 6 Submitting Voice Authorization Transactions Soft Merchant Information SM Record Soft merchant information 1s 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 Credit department Upon approval Paymentech sets a flag at the transaction division to enable you to send the preceding parameters If the flag is no
260. orce 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 1s 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 Gateway Developer Guide and Reference 07 January 2014 49 3 Configuring Hosted Checkout Pages Passing Other Data to Your Server Using Post or Silent Post sure to check Void transaction when my server fails to receive data sent by the silent post when setting up Silent Posts in PayPal Manager Data Returned by the Silent Post Features The Silent Post feature returns either a short list of data or all of the data that was submitted for the transaction You can control what 1s 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 s
261. ormation 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 Preface ss scssaskiESRE EEE Sata lt o o c aspira ARE RAE ee ee Ra ee 13 Related Documentation a aoa a a oa a a a a a a a a 13 Intended Audience nonoa aoa a a a a a a 13 Who Should Use This Document n nonono a a 2 a a a a a 14 Revision History aooaa a a 17 Chapter 1 Introducing the Gateway Checkout Solutions 25 About the Gateway Checkout Solutions 2 a a a a a a a a a 25 Summary of the Gateway Checkout Solutions o aoa oaoa oa a a a a a 25 Gateway Product Details o aoa oaa a a a a a a a a 26 About the Gateway Transaction Flow noaoo a a a a a a a 27 About Security 2 aoa oaoa a a a 28 SECUICTO s se reaa aaaea E a S eee ee 28 Hosted Checkout Pages noaoo a a a a a a a 28 PCI Compliance Without Hosted Pages Transparent Redirect 29 The PayPal Manager Website 2 a a ee 30 Processing Platforms Supporting Card Present Transactions 30 Supported Payment Types 2 1 a a a a 31 Supported Languages 2 2 a a a a a 32 Recurring Billing Service 2 32 Fraud Protection Service 2 6 a a a a a a a a 32 Chapter 2 Secure Token 0 0 2 ee ee ee 33 About the Secure Token 2 2 a a a a a 33
262. ot 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 The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wiki ISO_3166 1 numeric 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 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
263. ovides the underlying transport for application level transactions using either the Payflow name value pair or XMLPay 2 0 format All transaction data as documented in this guide is embedded in the body of a standard HTTPS POST and POSTed to the URLs specified What is the disadvantage of building your own integration Since you are building your own integration you will need to add your own error handling retry logic and duplicate transaction handling within your code NOTE Ifyou prefer not to write your own client you can use the NET SDK which can also be used with classic ASP or the Java SDK if appropriate See Payflow SDK on page 51 for more information about the SDKs What code changes are required when migrating from a previous Payflow SDKs to this service The Payflow HTTPS service uses the same name value pair parameters or XMLPay schema as found in the current SDKs The the only code change needed 1s the way you communicate with the Payflow servers Instead of using an SDK to send the data you will use the methods available in your programming language of choice to send the data via HTTPS For example if you use PHP you might choose to use cURL 07 January 2014 Gateway Developer Guide and Reference Payflow Header Parameters C Posting Transactions Directly Without the Payflow SDK Cc Payflow Message Protocol Headers In addition to the Payflow parameters that you pass in your request you must set the request
264. parameter Parameter CUSTREF STARTTIME ENDTIME Description 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 transaction including retries Limitations 12 alphanumeric characters 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 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 th
265. pecific 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 American Express Brighton Elavon RESULT Values Available for Testing 0 12 13 104 1000 0 12 13 104 88 07 January 2014 Gateway Developer Guide and Reference Testing Transactions T Processors Other Than PayPal 7 Processing Platform RESULT Values Available for Testing First Data Merchant Services North 0 4 5 12 13 23 24 114 1000 First Data Merchant Services Nashville 0 12 13 104 First Data Merchant Services South 0 12 13 104 Global Payments Central 0 4 5 8 12 13 23 24 104 111 114 1000 Global Payments East 0 4 5 12 13 23 24 30 100 104 114 1000 Paymentech Salem New Hampshire 0 12 13 104 Paymentech Tampa 0 3 4 5 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 te
266. porting 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 In 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 is ignored The Gateway decides whether a transaction meets Level 3 requirements during autho
267. posting transactions directly to the Gateway servers using HTTPS See Posting Transactions Directly Without the Payflow SDK on page 156 for more information Any reference to Payflow SDK or the 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 Downloads page download the Payflow SDK appropriate for your platform 2 Extract 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 07 January 2014 51 52 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
268. ptional Tax amount identifier Character length and limitations 1 alpha character Y or N SecureN 204 Example SecureNet 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 First Name amp BILLTOLASTNAME CardHolder Last Name amp PARTNER PayPal amp PWD pwd amp BILLTOSTATE CASBILLTOSTREET 123 Main St amp TAXAMT 1 01 amp TAXEXEMPT N amp TENDER C amp USER user amp BI LLTOZIP 94043 et 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 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions D SecureNet Purchasing Card Transaction Processing 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 prov
269. r s location Character length and limitations 15 alphanumeric characters MERCHANTCOUNTRYCODE Optional Country code of the location where the transaction took place The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wiki MISO_3166 1_ numeric Character length and limitations 3 character country code 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 118 07 January 2014 Gateway Developer Guide and Reference Processors Requiring Additional Transac
270. r except in the case of RESULT 104 See the following table 07 January 2014 Gateway Developer Guide and Reference Transaction Responses RESULT Values and RESPMSG Text 8 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 parameters 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 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 error codes documentationon the PayPal developer website for information on corrective actions 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 us
271. r 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 07 January 2014 Gateway Develop
272. r blank spaces Character length and limitations numeric TAXEXEMPT Optional Tax amount identifier Character length and limitations 1 alpha character Y or N Example Cielo Payments 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 Cielo Payments Level 3 MasterCard Parameters For Cielo Payments formerly Merchant e Solutions 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 1n 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 Gateway Developer Guide and Reference 07 January 2014 189 o D Submitting Purchasing Card Level 2 and 3 Transactions Cielo Payments Purchasing Card Transaction Processing IMPORTANT The values required for Level 3 status vary by bank so contact your bank for details Cielo Payments Level 2 MasterCard Parameters Required for Level 3 Transactions Parameter Description PONUM Required Purchase identifi
273. racter 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 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions American Express Purchasing Card Transaction Processing D Field L PRODCODEN L UPCN L TAXAMTN L FREIGHTAMTN L HANDLINGAMTN L TRACKINGNUMN L PICKUPSTREETN L PICKUPCITYN L PICKUPSTATEN L PICKUPZIPN L PICKUPCOUNTRYN L UNSPSCCODEN Description 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 1 to 30 alphanumeric characters Optional Item tax amount Character length and limitations 1 to 6 numeric characters Optional Freight amount Character length and limitations 1 to 15 numeric characters Optional Handling amount Character length and limitations 1 to 15 numeric characters Opt
274. racter 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 QTY0 1 is the quantity for line item O and is equal to 1 with n starting at 0 FDMS South Purchasing Card 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 12 alphanumeric characters Gateway Developer Guide and Reference 07 January 2014 177 o D Submitting Purchasing Card Level 2 and 3 Transactions First Data Merchant Services South FDMS Purchasing Card Transaction Processing Field Description L DESCn Optional Item description Character length and limitations 35 alphanumeric characters L UOMn Optional Item unit of measur
275. ransaction 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 limitations 1 alpha character 07 January 2014 Gateway Developer Guide and Reference Submitting Credit Card Transactions Core Credit Card Parameters 6 Parameter SWIPE ORDERID BILLTOFIRSTNAME BILLTOLASTNAME BILLTOSTREET BILLTOCITY BILLTOSTATE BILLTOZIP BILLTOCOUNTRY SHIPTOFIRSTNAME SHI PTOLASTNAME SHIPTOSTREET Description Required for
276. ration Payflow Link Legacy Parameter EMAILTOSHIP FAX FAXTOSHI P FIRSTNAME INVOICE LAS TNAME LOGIN METHOD NAME NAMETOSHI P PHONE PHONETOSHI P SHI PAMOUNT STATE STATETOSHIP TAX TYPE ZIP ZIPTOSHIP Payflow Parameter SHIPTOEMAIL BILLTOFAX SHIPTOFAX BILLTOFIRSTNAME INVNUM BILLTOLASTNAME VENDOR TENDER BILLTOFIRSTNAME BILLTOLASTNAME SHIPTOFIRSTNAME SHIPTOLASTNAME BILLTOPHONENUM SHIPTOPHONENUM FREIGHTAMT BILLTOSTATE SHIPTOSTATE TAXAMT TRXTY PE BILLTOZIP SHIPTOZIP 07 January 2014 Gateway Developer Guide and Reference Payflow Gateway Mag Tek Parameters MagTek products for both merchants and consumers provide added security to payment transactions For merchants MagTek s MagneSafe card readers encrypt payment card data when the card is swiped For consumers MagTek has a subscription based service named Qwick Codes Consumers can use Qwick Codes instead of their payment card details to purchase goods and services NOTE You must have a MagneSafe card reader or the required Qwick Code information to use the MagTek specific parameters described in this appendix Please contact MagTek directly for more information e MagTek MagneSafe Secure Card Readers and Qwick Codes e Passing Encrypted Card Swipe Data and Qwick Codes to the Payflow Gateway e Parameters for Encrypted Card Swipe Transactions e Parameters for MagTek Qwick Code PCode Transactions e MagTek
277. rd 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 Gateway Developer Guide and Reference 07 January 2014 93 Testing Transactions PayPal Processor Discover 6011000990139424 JCB 3530111333300000 JCB 3566002020360505 MasterCard 5555555555554444 MasterCard 5105105105105100 Visa 4111111111111111 Visa 4012888888881881 Visa ADZALZLZ22222222 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 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
278. rd 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 The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wikiISO_3166 1 numeric Character length and limitations 3 alphanumeric characters 184 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions Heartland Purchasing Card Transaction Processing D Parameter Description VATREGNUM Required VAT registration number Can be part of the registration data or passed with ea
279. received over the internet e CBP authorizes and electronically settles checks presented over the phone through customer 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 1s required on all transactions and is unique to each location Gateway Developer Guide and Reference 07 January 2014 141 142 TeleCheck Electronic Check Processing TeleCheck NFTF Processing Overview Dual ID 1s required for all transactions For personal checks 1t must be MICR data and personal check writer identifica
280. 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 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 Direct 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 sett
281. ric characters Optional Amount of this line item including tax where n is a line item number from 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 RequiredifL_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 number 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
282. rican 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 1s a line item number from 1 to 6 Character length and limitations 19 alphanumeric characters 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 QTYn 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 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 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
283. ription 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 response Example Account Verification String The following is an example of account verification TRXTYPE A amp TENDER C amp PARTNER PayPal amp USER SuperUser amp PwD SuperUserPasswo rd amp AMT 0 O0O amp ACCT 3 782822463 10005 amp EXPDATE 1215 amp INVNUM PONUM1 amp VERBOSIT Y HIGHSBILLTOZIP 95031 This is the response RESULT 0 amp PNREF VFHAOFF8F2 7D amp RESPMSG Veri fied amp AUTHCODE 66 7 PNI amp AVSADDR X amp AVSZIP X amp HOSTCODE A amp PROCAVS U amp AMEXTD 123456789012345 amp AMEXPOSDATA 123456789012 amp TRANSTIME 2011 01 11 18 42 01 amp AMT 0 OO0 amp ACCT 0005 amp EXPDATE 1215 amp CARDTY PE 3 amp AVS 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 authorizat
284. rization Level 3 data is passed to the American Express processor only during settlement 164 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 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 166 and contains a line item but does not include all mandatory Level 3 parameters the transaction succeeds but 1s 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 PCARD L3 missing or invalid InvoiceNumber RequestorName Features not processed PCARD L3 line item 3 missing Description For details on VERBOSITY see VERBOSITY Processor Specific Transaction Results on page 221 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 relations
285. rror 1000 Generic host error This 1s 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 Gateway Developer Guide and Reference 07 January 2014 109 110 Transaction Responses RESULT Values and RESPMSG Text RESULT 1011 1012 1013 1014 1016 1017 1021 1022 1023 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 RESPMSG and Explanation Buyer Authentication Service unavailable Buyer Authentication Service unavailable Buyer Authentication Service unavailable Buyer Authentication Service Merchant is not enrolled for Buyer Authentication Service 3 D Secure 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 Buyer Authentication Service 3 D Secure error response is invalid An error response 1s received and the response 1s not well formed for a Validate Authentication transaction Buyer Authentication Service Invalid card type Buyer Authentication Service Invalid or missing currency code Buyer Authentication Service merchant status for 3D se
286. rs Character length and limitations 9 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 is 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 information is XXnnnnnnnn where e XX State code e nnnnnnmn Driver s license number Character length and limitations 33 alphanumeric characters Required Account holder s e mail address You are required to pass this value when AUTHTYPE I 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 limi
287. rs Optional Numeric country code of ship to country Example USA 840 The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wikvISO 3166 1 numeric Character length and limitations 3 alphanumeric characters Optional Shipping method code The values are e 01 Same day e 02 Overnight next day 03 Priority 2 3 days 04 Ground 4 or more days 05 Electronic delivery 06 ZZ Reserved for future use Optional Merchant product SKU Character length and limitations 15 alphanumeric and special characters AVS Parameters Field BILLTOSTREET BILLTOALP BILLTOPHONENUM SHIPTOFIRSTNAME SHIPTOLASTNAME Description Optional Account holder s street address number and street name Character length and limitations 30 characters 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 Optional Account holder s telephone number The formats are xxx xxx xxxx US numbers o xxxxxxxxxxx international numbers Character length and limitations 10 characters Optional First name in the shipping address Character length and limitations 30 characters Optional Last name in the shipping address Character length and limitations 30 characters 07 January 2014 Gateway Developer Guide and Reference Processors Requiring Additi
288. rs 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 COMMENT 1 COMMENT2 COMPANYNAME BILLTOCOUNTRY CUSTCODE CUSTIP DUTYAMT BILLTOEMATL EXPDATE BILLTOFIRSTNAME BILLTOMIDDLENAME BILLTOLASTNAME FREIGHTAMT INVNUM PONUM SHIPTOCITY SHIPTOCOUNTRY SHIPTOFIRSTNAME SHI PTOMIDDLENAME SHIPTOLASTNAME SHIPTOSTATE SHIPTOSTREET SHIPTOZIP BILLTOSTATE BILLTOSTREET SWIPE TAXAMT BILLTOPHONENUM TAXEXEMPT BILLTOZIP Gateway Developer Guide and Reference 07 January 2014 83 84 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 x1y223 amp 0RIGID VPNE12564395 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 service 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 AV
289. s and Qwick Codes 251 MagneSafe Secure Card Reader Authenticators 0 2 251 MagTek Qwick Codes noaoo a a a a a a a 252 Passing Encrypted Card Swipe Data and Qwick Codes to the Payflow Gateway 252 Encrypted Card Swipe Payflow Example 2050 5004 253 Qwick Code PCode Payflow Example 0 2 00 eee eee 253 Parameters for Encrypted Card Swipe Transactions 002 5000 254 Parameters for Mag Tek Qwick Code PCode Transactions 257 Mag Tek Error Codes and Messages Chapter K Payflow Gateway FAQs 261 Gateway Developer Guide and Reference 07 January 2014 11 a Content 12 07 January 2014 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 P
290. sactions programmatically You can also manage Recurring Billing tasks in PayPal Manager Fraud Protection Service Fraud Protection Services can help you significantly reduce the cost of fraud and the resulting damage to your business This service uses Fraud Protection filters to help protect you from fraudsters using stolen or false credit card information These filters identify potentially fraudulent activity and let you decide whether to accept or reject the suspicious transaction Fraud Protection Service can also minimize the risk of hacking your customer database by enabling you to place powerful constraints on access to and use of your PayPal Manager and Payflow Gateway accounts You enroll separately for the Fraud Protection Service You can learn more about Fraud Protection Service in the Payflow Fraud Protection Services User s Guide If you already have this service this user guide will show you how to setup Fraud Protection filters You can also manage some aspects of your Fraud Protection Service in PayPal Manager 32 07 January 2014 Gateway Developer Guide and Reference Secure Token This section describes the secure token Secure Token on page 33 Integrating the Secure Token With the Hosted Checkout Pages on page 34 Integrating the Secure Token Without the Hosted Checkout Pages Transparent Redirect on page 34 Posting To the Hosted Checkout Page on page 36 Using the PARMLIST Parameter
291. sign com X VPS REQUEST ID See Required Payflow Headers X VPS CLIENT TIMEOUT 45 X VPS VIT See Integrator Provided Data X VPS VIT See Integrator Provided Data The following is an example of a transaction request header associated with a message in name value format For XMLPay it would follow the same format except the content type would be text xml and the body of the request and response would contain the XML document Name Value Pair Transaction Request Body The transaction request body contains the transaction information The following is an example transaction request body in name value pair format TRXTYPE 1 S amp ACCT 16 5105105105105100 amp EXPDATE 4 0109 amp TENDER 1 C amp INVNUM 8 INV12345 amp AMT 5 25 12 amp PONUM 7 P012345 amp STREET 23 123 Main St amp ZIP 5 12345 amp USER 6 smi th amp VENDOR 6 j smith amp PARTNER 6 PayPal amp PWD 8 t estingl NOTE The bracketed numbers are length tags which allow you to use the special characters of amp and in the value sent See Using Special Characters In Values on page 53 for more information The Request Body should NOT be URL encoded Pass the data as a standard data and use the length tags if needed Transaction Response The transaction response consists of a transaction response header and body Name Value Pair Transaction Response Header The following is an example transaction response header associated with
292. sing Card Level 2 and 3 Transactions TSYS Acquiring Solutions Purchasing Card Transaction Processing Example TSYS Acquiring Solutions Level 2 Visa Transaction Parameter String TRXIYPE 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 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 usersB1 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 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 d
293. specific Response Parameters 8 Litle Response Parameters Merchants using the Litle processing platform may see the following transaction response parameters Parameter Description TYPE Defines the type of account used in the transaction in terms of card association card company Bill Me Later PayPal or eCheck AFFLUENT Has two possible values e MASS AFFLUENTReturned for certain Visa and MasterCard cards indicating high income customers gt 100K annual income e AFFLUENT Returned for certain Visa and MasterCard cards indicating high income customers with high spending patterns gt 100K annual income and gt 40K in card usage Litle Automatic Account Updater The Litle Automatic Account Updater feature identifies outdated payment card information repairs it and substitutes new card information before submitting the transaction to the network To use this feature you must sign up directly with Litle For more information see http www litle com products services processing recovery services automatic account updater After signing up for this feature Payflow merchants will receive a few extra transaction response parameters only for transactions in which the customer s account information has been updated If the customer s card number and or expiration date are currently different from the information passed in the Payflow transaction request merchants will receive some or all of the following tra
294. st on the cardholder s account System busy try again later Failed to lock terminal number Please try again later For Moneris Solutions another transaction or settlement is in process Rerun the transaction later 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 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 Invalid keywords found in string fields Attempt to reference a failed transaction Not enabled for feature Merchant sale total will exceed the credit cap with current transaction ACH transactions only Fraud Protection Services Filter Declined by filters 07 January 2014 Gateway Developer Guide and Reference Transaction Responses 8 RESULT Values and RESPMSG Text RESULT RESPMSG and Explanation 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
295. st 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 l 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 following 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 07 January 2014 89 Testing Transactions Processors Other Than PayPal RESULT value 19 22 23 24 29 29 30 50 99 100 101 103 104 105 108 111 112 113 Definition 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 Cred
296. stal code excluding spaces dashes and non numeric characters Example 951121737 Character length and limitations 9 characters Optional Account holder s telephone number The formats are xxx xxx xxxx US numbers xxxxxxxxxxx international numbers Character length and limitations 10 characters Optional First name in the shipping address Character length and limitations 30 characters Optional Last name in the shipping address Character length and limitations 30 characters Optional Shipping street address Character length and limitations 30 characters Optional Numeric country code of ship to country Example USA 840 The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wiki ISO_3166 1_ numeric Character length and limitations 3 alphanumeric characters 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 07 January 2014 Gateway Developer Guide and Reference Processors Requiring Additional Transaction Parameters A SecureNet Additional Credit Card Parameters for American Express Field Description SHI PTOPHONENUM Optional Shipping telephone number Character length and limitations 10 alphanumeric characters Location Transaction Advice Addendum Parameters Parameter Description MERCHANTNAME Optional Nam
297. t 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 T and voids TRXTYPE V e The PNREF value is used as the ORIGID value original transaction ID value in reference transactions for authorization TRXTYPE A and sale TRXTYPE S The PNREF value is a 12 character string of printable characters for example e VADE0B248932 e ACRAF23DB3C4 NOTE Printable characters also include symbols other than letters and numbers such as the question mark 2 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 erro
298. t 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 Gateway Developer Guide and Reference 07 January 2014 33 34 Secure Token Integrating the Secure Token With the Hosted Checkout Pages 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 57 In addition pass the following Payflow parameters to create the secure token NOTE The secure token 1s 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 9a9ea8208de1413abc3d60c86ch1if4c5 2 Set CREATESECURETOKEN to the value Y to request that Payflow gateway return a token CREATES ECURETOKEN 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 95131SAMT 23 45 amp CURRENCY USD amp INVNUM INV12345
299. t set and you send the parameters your transaction is 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 07 January 2014 81 82 Submitting Credit Card Transactions Submitting Void Transactions When To Use a Voice Authorization Transaction Some transactions cannot be authorized over the Internet for example high dollar amounts and require manual authorization These referral transactions generate RESULT value 13 In these situations you contact the customer service department of your merchant bank and provide the payment information as requested If the bank
300. t 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 07 January 2014 221 RE VERBOSITY Processor Specific Transaction Results 222 07 January 2014 Gateway Developer Guide and Reference Country Codes The Payflow API uses the International Standards Organization ISO 3166 1 numeric country codes in the following fields BILLTOCOUNTRY and SHIPTOCOUNTRY For a complete list of the current officially assigned ISO 3166 1 3 digit numeric country codes refer to http en wikipedia org wiki ISO_3166 1_ numeric IMPORTANT If PayPal is your acquirer refer instead to the Countries and Regions Supported by PayPal on page 86 NOTE For FDMS South codes refer to Codes Used by FDMS South Only on page 225 Codes Used by FDMS South Only on page 225 Codes Used by FDMS South Only on page 225 For TeleCheck refer to the ISO 3166 1 2 character alpha country codes Gateway Developer Guide and Reference 07 January 2014 223 OF Country Codes 224 07 January 2014 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 22
301. tations 65 numeric characters 07 January 2014 Gateway Developer Guide and Reference TeleCheck Electronic Check Processing Testing TeleCheck Transactions B Field Description SS Account holder s social security number You are required to pass a value for SS when a value for CHKTYPE is passed e IfCHKTYPE 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 52 Example Test Transaction This is the authorization request and response TRXTYPE 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 MATL j ohn xyz com amp
302. ter length and limitations 20 alphanumeric characters BILLTOCOUNTRY Account holder s country You are required to pass this value when AUTHTYPE I For TeleCheck the Payflow API requires 2 digit alpha country codes Refer to http en wikipedia org wik1 ISO 3166 1 alpha 2 Character length and limitations 2 alphanumeric characters BILLTOFIRSTNAME 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 Gateway Developer Guide and Reference 07 January 2014 145 146 TeleCheck Electronic Check Processing TeleCheck Parameters Field BILLTOLASTNAME BILLTOPHONENUM BILLTOSTATE BILLTOSTREET BILLTOZIP CHKNUM CHKIYPE CUSTIP DL BILLTOEMAIL INVNUM MICR Description Required Account holder s last name as it appears on the check Character length and limitations 30 alphanumeric characters 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 30 alphanumeric characters Required Account holder s postal code called ZIP code in the USA Do not use spaces dashes or non numeric characte
303. th your processor for information on the specific functionality that is supported e Obtaining an Internet Merchant Account on page 58 e About Credit Card Processing on page 58 e Credit Card Features on page 59 e Planning Your Gateway Integration on page 59 e Core Credit Card Parameters on page 61 e Submitting Account Verifications on page 64 e Submitting Authorization Delayed Capture Transactions on page 65 e Submitting Balance Inquiry Transactions on page 66 e Submitting Card Present SWIPE Transactions on page 67 e Submitting Credit Refund Transactions on page 69 e Submitting Inquiry Transactions on page 71 e Submitting Partial Authorizations on page 73 e Submitting Purchasing Card Transactions on page 75 e Submitting Reference Transactions Tokenization on page 75 e Submitting Sale Transactions on page 79 e Submitting Soft Merchant Information on page 80 e Submitting Voice Authorization Transactions on page 81 e Submitting Void Transactions on page 82 e Using Address Verification Service on page 84 e Using Card Security Code on page 85 e Information for the PayPal Acquirer on page 85 Gateway Developer Guide and Reference 07 January 2014 2 6 Submitting Credit Card Transactions Obtaining an Internet Merchant Account Obtaining an Internet Merchant Account To accept credit cards over th
304. the merchant s order processing facility 1s 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 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 MERCHANTCOUNTRYCODE Optional Country code of the location where the transaction took place The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wiki MISO_3166 1_ numeric Character length and limitations 3 character country code MERCHANTLOCATIONID Optional Merchant assigned store or location number or nam
305. 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 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 3 Transactions on page 163 NOTE The PayPal processor does not support purchasing card transactions 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 referen
306. tical 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 merchant 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 07 January 2014 151 152 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
307. ting 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 94 043 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 limitations 1 to 16 alphanumeric characters 180 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions Heartland Purchasing Card Transaction Processing D 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 b
308. tion Parameters American Express Additional Credit Card Parameters A Transaction Advice Detail Parameters Field Description ADDLAMTN Optional Detail of a charge where n is a value from 1 5 Use for additional breakdown of the amount Character length and limitations Must include a decimal and be exact to the cent 42 00 not 42 and exclude comma separators 1234 56 not 1 234 56 Examples tip 3 00 convenience charge 2 00 12 numeric characters ADDLAMTTY PEN 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 AIR DEPARTUREDATE Optional Departure date in the format YYYYMMDD Character length and limitations 8 alphanumeric characters AIR 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 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 AIR DESTINATION Optional Destination airport co
309. tion has been updated Merchants can test their integration for the Litle Automatic Account Updater feature in the Payflow pilot test environment by doing the following 1 In the ACCT request parameter pass one of the following testing card numbers Updated card number returnedin ACCT Card number passed in AccT request parameter response parameter 4111111111111111 4321432143214321 4012888888881881 4012000033330026 5105105105105100 5454545454545454 5560136761278244 5105105105105100 NOTE Only the last 4 digits of the updated credit card number will be returned 07 January 2014 Gateway Developer Guide and Reference Testing Transactions T PayPal Processor 7 2 In the EXPDATE request parameter pass one of the following expiration dates Expiration date passedin EXPDATE request Updated expiration date returnedin EXPDATE parameter response parameter 0000 0919 1213 1218 0120 0150 0230 0250 0340 0350 3 In the AMT request parameter pass an amount that falls within one of the following ranges to bring about different account updater test cases Amount passedin AMT request parameter Test case 1000 00 gt AMT gt 500 00 Both an updated credit card number and an updated expiration date 500 00 gt AMT gt 400 00 Only an updated credit card number 400 00 gt AMT gt 300 00 Only an updated expiration date PayPal Processor For the PayPal processor use the following guidelines Credit Ca
310. tion number Can be part of the registration data or passed with each transaction Character length and limitations 20 alphanumeric characters TSYS Acquiring Solutions Level 3 MasterCard Extended Data The parameters listed in the table below apply to Level 3 MasterCard transactions as extended data Parameter Description FREIGHTAMT Optional Freight amount Character length and limitations 12 numeric characters DUTYAMT Optional Duty amount Character length and limitations 12 numeric characters SHIPTOCOUNTRY Optional Destination country code The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wiki ISO_3166 1 numeric 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 nis a sequence counter that should begin with 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 Gateway Developer Guide and Reference 07 January 2014 211 oO D Submitting Purchasing Card Level 2 and 3 Transactions
311. tion such as a driver s license For company checks it must be MICR data and Federal Tax ID In the event that a company does not have a Federal Tax ID the driver s license can also be used 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 ad
312. tional 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 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions D WorldPay Purchasing Cards Transaction Processing Level 2 Parameters Description TAXAMT Optional 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 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 VATINVNUM Optional Value added tax invoice number Character length and limitations 95 alphanumeric characters VATNUM Optional Customer valued added tax number Character length and limitations 95 alphanumeric characters VATTAXAMT Optional
313. tions 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 07 January 2014 187 Submitting Purchasing Card Level 2 and 3 Transactions Litle Purchasing Card Transaction Processing Field FREIGHTAMT TAXAMT L AMTn L COMMCODEN L COSTN L DESCN L DISCOUNTN L PRODCODEN L QTYn L TAXAMTN L UOMN Description 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 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 nume
314. to Pass Hosted Pages Customization Parameters Another way to configure your hosted checkout pages is to submit hosted checkout page configuration parameters to the Payflow Gateway in a form post These parameters will override your hosted checkout page settings in PayPal Manager First you will need to create a secure token You then pass the secure token with the hosted pages configuration parameters To learn how to create a secure token see the Secure Token chapter Gateway Developer Guide and Reference 07 January 2014 43 3 Configuring Hosted Checkout Pages Using a Secure Token to Pass Hosted Pages Customization Parameters The table below describes the form post parameters that you can use to dynamically configure the hosted checkout pages Setup Parameters Variable Description CANCELURL The URL that customers would go to 1f pressing a Cancel link from the hosted page Layouts A and B only and from the Express Checkout flow 1f 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 Determines 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 EMAILCUSTOMER S
315. tps payflowlink paypal com gt lt input type text name SECURETOKEN value FyvwENnHTYRNUSVsZRIhFpudA gt lt input type text name SECURETOKENID value 9a9ea8208del413abc3d60c86cbh1if4c5 gt lt input type hidden name PARMLIST value INVNUM 8 INV12345 amp AMT 5 25 50 amp 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 Gateway Developer Guide and Reference 07 January 2014 3 2 Secure Token Posting To the Hosted Checkout Page 38 07 January 2014 Gateway Developer Guide and Reference Configuring Hosted Checkout Pages This chapter describes the following e Configuring Hosted Checkout Pages on page 39 e Configuring Hosted Pages Using PayPal Manager on page 39 e Using a Secure Token to Pass Hosted Pages Customization Parameters on page 43 e Hosted Pages and Mobile Browsers on page 47 e Silent Posts on page 49 e Passing Other Data to Your Server Using Post or Silent Post on page 50 Configuring Hosted Checkout Pages PayPal enables you to customize the hosted checkout pages so that they reflect the look and feel of your website In doing so the buyer seamlessly transitions from your website to the PayPal hosted checkout pages to make the payment and complete the transaction Since the pages are hosted on PayPal servers you do not have to capture or store credit card inform
316. transaction request and receiving the transaction response exceeds the value of X VPS CLIENT TIMEOUT The default value is 45 Standard HTTP Headers Required Header Name Description Connection State of the connection The server returns the value close to close the connection after the response is sent Content Length Required Size of message body Content Type Required Provide one of the following values e text name value transaction request body is in name value pair format e text xml transaction request body is in XMLPay 2 0 format Host Required Provide one of the two host URLs e Production payflowpro paypal com e Pilot pilot payflowpro paypal com Transaction Message The transaction message communicates the initial transaction data to the server It is made up of the transaction request and response URLs for Sending Messages Use the following URLs for sending transactions to PayPal s Payflow Production servers Production Live https payflowpro paypal com Pilot Test https pilot payflowpro paypal com Transaction Request The transaction request consists of a transaction request header and body Name Value Pair Transaction Request Header Content Type text name value Content Length 233 Connection close 158 07 January 2014 Gateway Developer Guide and Reference Payflow Header Parameters C Posting Transactions Directly Without the Payflow SDK Cc Host payflowpro veri
317. tting 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 Fraud Protection Service filters 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 not a reference transaction e Credit 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 e
318. uiring Solutions Purchasing Card Transaction Processing oaao 209 TSYS Acquiring Solutions Level 2 Parameters a aooaa a a a a a a a a a a 209 TSYS Acquiring Solutions Level 3 MasterCard Parameters 210 TSYS Acquiring Solutions Level 3 Visa Parameters 212 Vantiv Purchasing Card Transaction Processing a oa oaoa a a a a a a a 215 Vantiv Purchasing Parameters a aoa oaoa a a a a a a a 215 Vantiv Purchasing Card Line Item Parameters aooaa oa a a a a a 52508 216 WorldPay Purchasing Cards Transaction Processing a a aoao aoa a a a a a a 217 WorldPay Level 2 Parameters oa oaoa oa a a a a a a 217 WorldPay Level 3 Parameters oa oaoa a a a a a a a 219 E VERBOSITY Processor Specific Transaction Results 221 F Country CodeS aaao a aa aa cc 223 Chapter G Codes Used by FDMS South Only aaa aa 225 MasterCard Country Codes for FDMS South Only a aoao a a a 208 225 Visa Country Codes a aoao a a 232 Units of Measure aaoo a a a 239 Appendix H Additional Processor Information 247 Moneris Solutions oaoa a a a a a a a a a a a a a a aa 247 07 January 2014 Gateway Developer Guide and Reference Content Chapter Payflow Link Migration 4 249 Migrating from a legacy Payflow Link Integration 204 249 Chapter J Payflow Gateway MagTek Parameters 251 Mag Tek MagneSafe Secure Card Reader
319. urity 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 The following is an example request parameter string TRXTYPE S amp TENDER C amp USER SuperUser amp PWD SuperUserPassword amp VENDOR SuperUser amp PA RINER PayPal amp ACCT 5105105105105100 amp EXPDATE 1215 amp CVV2 123 amp AMT 99 00 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 Information for the PayPal Acquirer If PayPal is your acquirer use the following PayPal specific codes For all other acquirers refer to the Country Codes on page 223 Gateway Developer Guide and Reference 07 January 2014 85 6 Submitting Credit Card Transactions Information for the PayPal Acquirer Countries and Regions Supported by PayPal PayPal uses 2 character alpha ISO 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 alpha ISO 3 166 1 codes refer to the PayPal API r
320. 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 xxx xxx XxxX XxXX 07 January 2014 Gateway Developer Guide and Reference Processors Requiring Additional Transaction Parameters PayPal Credit Card Transaction Request Parameters A Parameter Description CAPTURECOMPLETE Optional Indicates if this Delayed Capture transaction is the last capture you intend to make The values are e Y default e N NOTE f CAPTURECOMPLETE is Y any remaining amount of the original reauthorized transaction is automatically voided Limitations 12 character alphanumeric string CUSTOM Optional A free form field for your own use Limitations 256 character alphanumeric string EMAIL Optional Email address of payer Limitations 127 alphanumeric characters INVNUM Optional Your own unique invoice or tracking number Limitations 127 alphanumeric characters ITEMAMT Required if L_COSTn is specified Sum of cost of all items in this order ITEMAMT L TYO LCOSTO L QTY1 LCOST1 L QTYn L COSTA Limitations Nine numeric characters plus decimal character No currency symbol Specify the exact amount to the cent using a
321. ve 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 168 07 January 2014 Gateway Developer Guide and Reference Submitting Purchasing Card Level 2 and 3 Transactions D 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 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 Example American Express Level 2 Transaction Parameter String TRXTYPE S amp ACCT 372449635311003 amp AMT 20 06 amp BILLTOCITY Mountain View amp DESC1 des C1 amp DESC2 desc2 amp DESC3 desc3 amp DESC4 FRT10 00 amp EXPDATE 1215 amp BILLTOFIRSTNAME Card holder first na
322. verification service verifies the STREET address Limitations 30 alphanumeric characters Optional Bill to city Limitations 20 character string Optional Bill to state Limitations 2 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 The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wiki ISO_3166 1_ numeric 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 30 character string Gateway Developer Guide and Reference 07 January 2014 63 64 Submitting Credit Card Transactions Submitting Account Verifications Parameter Description SHLPTOCITY Optional Ship to city Limitations 20 character string SHIPTOSTATE Optional Ship to state Limitations 2 character string SHIPTOZIP Optional Ship to postal code Limitations 9 character string SHIPTOCOUNTRY Optional Ship to country The Payflow API accepts 3 digit numeric country codes Refer to http en wikipedia org wiki ISO_3166 1_ numeric Limitations 3 character country code Submitting Account Verifications Account verifications also known as zero amount authorizations
323. very similar to implementing hosted pages It differs only in the steps shown in boldface below 1 The customer clicks Buy to purchase merchandise on your website 2 You request a secure token by passing a secure token ID to the Gateway server In the request you pass the name value pair SILENTTRAN TRUE This name value pair prevents the hosted pages from displaying 3 The Gateway server returns the secure token and your token ID to your website 4 You display the credit card fields to the customer in a checkout page on your website 5 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 6 The Gateway processes the payment through the payment processing network 7 The Gateway server transparently sends 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 The PayPal Manager Website Payflow merchants can manage their Payflow account settings view reports and perform transactional processing on the Payflow Manager website https manager paypal com For assistance with using the
324. vice on page 32 About the Gateway Checkout Solutions Gateway checkout consists of the following solutions e Payflow Link e Payflow Pro e PayPal Payments Advanced e PayPal Payments Pro Summary of the Gateway Checkout Solutions Below 1s 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 PayPal 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 07 January 2014 25 26 Introducing the Gateway Checkout Solutions About the Gateway Checkout Soluti
325. w Header Parameters Posting Transactions Directly Without the Payflow SDK Posting Transactions Directly Without the Payflow SDK The Payflow SDK is recommended for NET and Java users to simplify the Payflow integration Developers who prefer to write code in other programming languages can go to the PayPal Labs integration wizard web site https devtools paypal com integrationwizard The wizard generates customizable code samples in languages such as PHP Developers also have the option to post transactions directly to the Payflow servers using the Payflow message protocol without the need to install an SDK This section describes the HTTP headers that are required to post transactions directly to the Payflow servers The Payflow Message Protocol What is the Payflow message protocol and what are its advantages PayPal s Payflow message protocol is an HTTP compatible protocol for transactions The HTTP compliant implementation of this protocol has the following goals e It enhances flexibility to developers integrating with the Payflow Service Merchants can use the protocol in either of these ways Using a Payflow SDK such as NET or Java that uses this protocol Integrating this protocol directly into your own client application without using an SDK It increases reliability through adherence to open standards Built in tools to prevent duplicate transactions and authorizations e The Payflow message protocol pr
326. xist 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 ACCT BILLTOCITY EXPDATE BILLTOSTATE 76 07 January 2014 Gateway Developer Guide and Reference Submitting Credit Card Transactions Submitting Reference Transactions Tokenization 6 BILLTOFIRSTNAME BILLTOZIP BILLTOMIDDLENAME BILLTOCOUNTRY BILLTOLASTNAME SWIPE BILLTOSTREET 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 x1y2zZ3 amp PARTNER PayPal amp VENDOR SuperMerchant amp USER SuperMerchant amp ACCT 5555555555554444 amp EXPDATE 1215 amp AMT 100 00 amp INVNUM 123456789 amp BILLTOSTREET 5199 MAPLE amp BILLTOZIP 94588 Note the value of the PNREF in the response RESULT 0 amp PNREF VXYZ01234567 SRESPMSG APPROVED amp AUTHCODE 123456 amp AVSADDR Y S amp AVSZIP N NOTE The PNREF returned in the or

PayPal Gateway - 2014 Developer's Guide

Contents

Download Pdf Manuals

Related Search

Related Contents