Home

PayPal Order Management - 2005 Integration Guide

1. 0 19 PDT and PayPal Account Optional e e 19 PDT Notification Synch 0 o o 20 Constructing the POST a ocs aaora caeau aaa a a a a a a a aaa a a 20 PayPal Response to POST e 21 PDT and Auto Return Messaging to Buyer aoaaa aa 0005 21 Preventing Fraud a 22 Code Samples 3 240 344 8004 a a ae Raed Be dG da o 22 Chapter 3 Instant Payment Notification IPN 23 How It Works 2 2 ee 23 How IPN POSTS Are Sent 2 2 1 ae 24 setting Up IPN s b ec ee ee ee ee a ee a eee a 25 IPN Notification and Notification Validation 0 00000 eee eee 26 Shared Secret Per Transaction or by Profile Setting 26 Shared Secret Validation 2 sias Kasana 27 HTTPS Postback to PayPal o e 2 27 Using IPN with Multiple Currencies 2 0 e e 28 payment_gross and paymMent_fe8 e 28 Examples of Multi currency IPN Variables 0 29 Order Management Integration Guide August 2005 Neal Contents Dispute Notification g x sa nes ekant eale e a e 32 Chapter 4 Downloadable History Log 33 Customizing Your Downloadable History Log o o e 34 Downloading Your History 2 o e e 36 Viewing Your Downloaded Log o e o 37 Appendix A IPN and PDT Variables 39 Data Type
2. Frorn Completed Details x x e Money Market usp 0 00 USD USD USD 2005 4 Click the Customize My History Download link August 2005 Order Management Integration Guide Downloadable History Log Customizing Your Downloadable History Log FIGURE 4 2 Customize My History Download PayPal My Account Send Money Request Money Merchant Services Auction Tools Prod Overview AddFunds Withdraw History Resolution Center Profile Customize My History Download Check the boxes next to the fields you want to download All checked fields will be included in your downloadable log Default Fields Date Time Time Zone Name Type Status Currency Gross Fee Net From Email Address To Email Address Transaction ID Reference Transaction ID Receipt ID PayPal Website Payments Item ID I Item Title FP Invoice Number I Custom Number FP Shipping Amount F Insurance Amount FP Single Column Shipping Address Address will be displayed in a single column E Multi Column Shipping Address Address will be displayed in separate columns Niks I Counter Party Status Verified vs Unverified Address Status Confirmed vs Unconfirmed I Sales Tax I Option Names and Values Auction Payments I Item ID I Item Title I Shipping Amount FP Insurance Amount F Auction Site FP Buyer ID FP Item URL FP Closing Date F Single Column Shipping Address F Counter Party Status Verified vs Unverified I Address Stat
3. non_receipt 55 not_as_described 55 notification synch 20 notification validation 26 27 notify_url 26 27 notify_version 40 num_cart_items 43 O option_namel 42 44 option_name2 42 44 option_selectionl 42 option_selectionl_x 44 option_selection2 43 option_selection2_x 44 other 45 P parent_txn_id 44 Partially Refunded 44 password 51 payer_business_name 41 payer_email 41 payer_id 41 payer_status 41 Payment Data Transfer See PDT payment_ tatus 44 payment_date 44 48 payment_fee 28 47 payment_gross 28 47 payment_status 39 48 payment_type 45 PayPal supported currencies 13 PDT 15 activating 18 enabling 18 FAIL response 21 identity token 19 SUCCESS response 21 Pending 44 pending_reason 45 period 50 period2 50 period3 50 Processed 44 Q quantity 42 R reason_code 45 55 ReasonCode 44 reattempt 50 receiver_email_x 48 receiver_email 42 receiver_id 42 recur_times 50 August 2005 Order Management Integration Guide recurring 50 verify_sign 40 Refunded 44 Voided 44 remaining settle 43 residence_country 41 Resolution Center 32 W retry_at 50 web 46 Reversed 44 S send_money 46 settle_amount 47 settle_currency 47 special 55 st 56 subscr_cancel 49 subscr_date 49 subscr_effective 50 subscr_eot 49 subscr_failed 49 subscr_id 51 subser_modify 49 subscr_payment 49 subscr_signup 49 SUCCESS or FAIL response in PDT 21 T tax 43 46 test_ipn 40 tx 56 tx variable for PDT 20 txn_i
4. selection2 If this is a shopping cart transaction see Table A 3 IPN and PDT Variables Shopping Cart Information on page 43 for more information tax Amount of tax charged on payment Tf this is a shopping cart transaction see Table A 3 IPN and PDT Variables Shopping Cart Information on page 43 for more information Shopping Cart Information auth_amount auth_status TABLE A 3 PN and PDT Variables Shopping Cart Information Variable Name Possible Values Description auth_id Authorization identification number auth_exp Authorization expiration date and time Authorization amount Status of authorization The amount is in the currency of mc_currency where x is the shopping cart detail item number The sum of mc_gross_x should total mc_gross The x is the shopping cart detail item number The handling_cart cart wide Website Payments variable is also included in the mc_handling variable for this reason the sum of mc_handling_x might not be equal to mc_handling This is the combined total of shipping and shipping2 WebsitePayments variables where x is the shopping cart detail item number The shippingx variable is only shown when the merchant applies a shipping amount for a specific item Because profile shipping might apply the sum of shippingx If this is a PayPal Shopping Cart transaction number of items in cart remaining_ Remaining amount that can be captured settle mc_gross_X Transaction
5. specific for multiple currencies mc_ Transaction handling_x specific for multiple currencies mc_ Transaction shipping_x specific for multiple currencies might not be equal to shipping num_cart_ items August 2005 43 IPN and PDT Variables Shopping Cart Information TABLE A 3 IPN and PDT Variables Shopping Cart Information Variable Name Possible Values option_ namel option_ name2 option_ selectionl_ x option_ selection2_ x parent_txn_ id payment_ date Canceled Reversal payment_ status Completed Denied Expired Failed In Progress Partially Refunded Pending Processed Refunded Reversed Voided Description PayPal appends the number of the item where x represents the number of the shopping cart detail item e g option_namel option_name2 PayPal appends the number of the item where x represents the number of the shopping cart detail item e g option_name2 option_name2 PayPal appends the number of the item e g opt ion_selectionl option_selection2 where x represents the number of the shopping cart detail item PayPal appends the number of the item where x represents the number of the shopping cart detail item e g opt ion_selectionl option_selection2 In the case of a refund reversal or canceled reversal this variable contains the txn_id of the original transaction while txn_id contains a new ID for the new transaction
6. Maximum Field Lengths and URL Encoding 39 About These Tables of Variables e 2 4 39 test_ipn Variable in Sandbox 2 e 40 IPN Variables in All POSTS o 000000 2 ee ee 40 Buyer Information s es ssaa ea ae o a a a a a a aa aa DA E o ARA 40 Basic Information oaoa a ee 41 Advanced and Custom Information oaoa oa a 42 Shopping Cart Information a aa a 43 Currency and Currency Exchange a 46 AUCUONS io koa Aa ic da di a a di ee ald ek da de a e is A 47 Mass Payment io ciar e Moe e e a a a e aw a 48 Subscriptions Variables e 49 Dispute Notification Variables 0 e eo 54 PDT Specific Variables o o e mo 56 Appendix B Downloadable History Log Columns and Values 59 Appendix C Country Codes 67 ISO 3166 Standard Country Codes 2 2 o 67 August 2005 Order Management Integration Guide Table 1 1 Table 4 1 Table A 1 Table A 2 Table A 3 Table A 4 Table A 5 Table A 6 Table A 7 Table A 8 Table A 9 Table A 10 Table B 1 Table C 1 Order Management Integration Guide List of Tables PayPal Supported Currencies Currency Codes and Maximum Transaction Amounts 13 IPN and PDT Variables Buyer Information 40 IPN and PDT Variables Basic Information 41 IPN and PDT Variables Advanced and Custom In
7. before transaction fee is subtracted Equivalent to payment_gross for USD payments If this amount is negative it signifies a refund or reversal and either of those payment statuses can be for the full or partial amount of the original transaction This is the total handling amount associated with the transaction If this is a shopping cart transaction see Table A 3 IPN and PDT Variables Shopping Cart Information on page 43 for more information This is the total shipping amount associated with the transaction If this is a shopping cart transaction see Table A 3 IPN and PDT Variables Shopping Cart Information on page 43 for more information 46 August 2005 IPN and PDT Variables EN Auctions TABLE A 4 IPN and PDT Variables Currency and Currency Exchange Information Variable Name Possible Values Description payment_fee Transaction USD transaction fee associated with the payment payment_gross minus specific for payment_fee equals the amount deposited into the receiver email account USD payments Is empty for non USD payments This is a legacy field replaced by mc_fee If only this amount is negative it signifies a refund or reversal and either of those payment statuses can be for the full or partial amount of the original transaction fee payment_ Transaction Full USD amount of the customer s payment before transaction fee is gross specific for subtracted Will be empty for non USD payments T
8. 2003 Order Management Integration Guide August 2005 15 Payment Data Transfer How PDT Works Step 2 Bob is taken to a PayPal Payment Details page which displays the details of the payment he is about to make pamens ty PayPal _ e x 4 Global Industries Inc Globe str ik gt fa ii Industries Widget Warehouse Payment Details Secure Transaction Ej PayPal is the secure payment processor for your seller To continue vacY please enter the required information below j BBBOnLine Pay To Widget Warehouse Payment For Widget Currency U S Dollars E Amount 142 50 USD If you have never paid through PayPal _ Click Here PayPal Login Email Address bdeboeapaypal com problems loaaina in PayPal Password EAU EGORdE Continue Step 3 Bob enters his PayPal account information into the PayPal Login fields Step 4 Bob is then taken to a confirmation page that displays the details of his selection information about how his automatic payments will be funded and his shipping information He clicks Pay to complete the payment ramensty PayPal FOO Global industries ing F AA Widget Warehouse Confirm Your Payment Check the following details and click the Pay button below to complete your payment Pay To Globe Industries Inc User Status Unverified Business Member 0 Payment For Widget Quantity 1 Currency U S Dollars Bl Amount 142 50 USD Shipping amp Hand
9. 48 02 Akihiko williams Payment Received Reversed USD 15 0 74 14 26 ylee 2 11 5 2002 0 47 57 Akihiko williams Payment Received Reversed asdf USD 15 0 74 14 26 yle 11 5 2002 0 47 13 Akihiko williams Payment Received Denied asdf USD 10 0 10 asdf ylee 20 1 4 2002 18 27 14 Pranzut shi Auction Payment Sent completed 1111 USD 11 1 0 11 1 tv 1 1 2002 15 16 53 i k secondmai1 0208106paypal com Canceled Payment completed USD 22 22 1 1 2002 15 14 32 k secondmai 1 0208106paypal com Canceled Payment completed USD 5 0 5 gt Az Once the file is formatted import the file into whatever program you use for reconciliation purposes August 2005 Order Management Integration Guide IPN and PDT Variables IPN and PDT variables are case sensitive All values are lowercase except those for payment_status which have an initial capital letter Data Type Maximum Field Lengths and URL Encoding IPN posts contain only alphanumeric characters The maximum field length for each returned field is 127 characters with the following exceptions e custom has a maximum length of 255 characters e memo has a maximum length of 255 characters e The unique PayPal Transaction ID txn_id variable is 17 characters long Values posted by IPN are URL encoded For example the colon in http is encoded as 3A in the IPN post About These Tables of Variables The tables in this appendix group IPN v
10. Completed 2 00 18 Ebiz Subscription Payment Completed Transaction Rows lt I00000OvVoO0oDooo FIGURE 4 5 A comma delimited history log in a text file fj Download csy Notepad TES Elle Edit Format Help Date Time Name Type Status Subject Currency Gross Fee Net Note From Ema 11 8 2002 16 09 57 Canceled Reversal Update to Reversal canceled USD 0 67 4 8 2002 16 07 56 Ebiz Canceled Payment Canceled USD 0 67 0 0 67 jk ebiz payp 11 8 2002 15 54 25 biz Canceled Payment Completed USD 0 67 0 0 67 j k ebiz paypal con 11 7 2002 18 46 15 Ebiz Payment Received Completed GBP 10 0 54 9 46 k ebiz paypal con PAE E012 Payment Received Completed GBP 10 0 54 9 46 Nery Sogo al cor 11 7 2002 15 33 30 Ebiz subscription Payment Received Uncleared USD 800 0 800 jk ebiz g 11 7 2002 15 24 27 Eb1z Payment e pos EUR rl ye 53 Y dl tye 1 Com 11 7 2002 15 24 12 Eb12 Payment Received Reversed USD 1 0 33 0 67 jk ebiz paypal com 1 7 2002 15 23 44 Ebiz Payment SRR VET COND letan E 1 353 Ya e ne 1 com EE A ed te eri Received Reversed USD 1 0 33 0 67 j pi jo pp j 7 2002 15 20 11 Ebiz echeck Received Cleared USD 1 0 33 0 67 jk ebiz paypal com jk k ebiz pa Nae k ylee 11 7 2002 15 20 11 Ebiz echeck Received Cleared USD 1 0 33 0 67 11 5 2002 0 50 22 akihiko williams Canceled Payment Completed USD 14 26 0 14 26 1 5 2002 0
11. Management Integration Guide Instant Payment Notification IPN EN Using IPN with Multiple Currencies These values are absent for non USD payments so that IPN scripts will not process these amounts as USD However legacy IPN scripts will continue to work as before as long as the merchant only receives USD payments Examples of Multi currency IPN Variables IPNs that use the payment_gross variable will have the following multi currency variables added The variables mc_gross and mc_ fee will not be added to IPNs with txn_type subscr_signup subscr_cancel subscr_modify subscr_failed or subscr_eot e mc_gross Full amount of payment received before transaction fee Norte If payment is in USD the payment_gross value equals mc_gross e mc_fee Transaction fee associated with the payment Variable function like payment _fee variable variable does not appear when payment pending and so on Note If payment is in USD the payment_ fee value equals mc_fee e mc_currency Currency of mc_gross mc_fee payment_gross and payment_fee amounts Possible values are detailed in Table 1 1 PayPal Supported Currencies Currency Codes and Maximum Transaction Amounts on page 13 e For subscription IPNs such as signup cancel modify failed and eot mc_currency is the currency of the subscription rather than the currency of the payment Example 1 If a user with a USD balance receives a 100 USD payment the following variables wi
12. account open up a new web browser e g Internet Explorer or Netscape and type in the PayPal URL si https www paypal com to be Payment Details sure you are on the real PayPal site Amount 162 50 USD PayPal will never ask you to enter your gt password in an email Transaction ID 78H54514UY26 Quantity 1 Item Product Widget Name For more information on protecting yourself from fraud please review our Security Tips at https www paypal com securitytips Protect Your Password You should never give your PayPal password to anyone including PayPal employees Enabling Payment Data Transfer To enable PDT 1 Click the My Account tab 2 Click the Profile subtab 3 Click the Website Payment Preferences link as shown in the following diagram Selling Preferences Auctions Sales Tax Shipping Calculations Shipping Preferences UPS Preferences Payment Receiving Preferences Instant Payment Notification Preferences PayPal Shops Reputation Guarantee Preferences Seller Eligibility for PayPal Buyer Protection Website Payments Preference Custom les Pages The Website Payment Preferences page opens 18 August 2005 Order Management Integration Guide Payment Data Transfer EN PDT and PayPal Account Optional 4 Click the Payment Data Transfer On radio button as shown in the following diagram Payment Data Transfer optional Payment Data Transfer allows you to recei are made The use
13. and Notification Validation IPN Notification and Notification Validation After your server receives Instant Payment Notification you must confirm that you received 1t This is known as notification validation which is a means for PayPal to help you prevent spoofing or man in the middle attacks You have two methods by which you can validate the notification 1 Sending a shared secret described in Shared Secret Validation on page 27 PayPal recommends this method because 1t decreases network traffic to and from your website Shared secret validation is appropriate if you are not using a shared website hosting service if you have enabled SSL on your web server if you are using PayPal Encrypted Website Payments if you use the notify_url variable on each individual payment transaction Sending a POST back to PayPal after you receive the IPN described in HTTPS Postback to PayPal on page 27 Postback is appropriate if you rely on a shared website hosting service if you do not have SSL enabled on your web server Both methods rely on the concept of a notification URL which is described in the next section Shared Secret Per Transaction or by Profile Setting The URL to which PayPal posts IPN data is called the notification URL It can be set either with each individual payment transaction or globally in your Profile for all transactions Per Transaction If you want to receiv
14. for the security of your customer and your payment There are two ways to validate the notification For details see IPN Notification and Notification Validation on page 26 24 August 2005 Order Management Integration Guide Instant Payment Notification IPN EN Setting Up IPN Step 5 After verifying the correctness of the data from IPN you can update your database with the IPN data and process the purchase Your Server Verified Process Order Now gt Setting Up IPN To set up IPN 1 Log in to your Business or Premier PayPal account 2 Click the Profile subtab 3 Click the Instant Payment Notification Preferences link in the Selling Preferences column 4 Click Edit 5 Click the checkbox and enter the URL at which you would like to receive your IPN Notifications 6 Click Save Alternatively you can activate IPN by including the notify_url field in your PayPal button This field specifies the URL of a script that can process the IPN For a complete list of IPN fields variables and sample code see Appendix A IPN and PDT Variables Code samples for the following development environments are also available on the PayPal website at http www paypal com cgi bin webscr cmd p xcl rec ipn code outside e ASP Net C e ASP VBScript e ColdFusion e Java JSP e PERL e PHP Order Management Integration Guide August 2005 25 26 Instant Payment Notification IPN IPN Notification
15. of Payment Data Trans your Return URL Please note that in order on Auto Return Payment Data Gion Transfer rr Note You must enable Auto Return in order to use Payment Data Transfer Auto Return can also be enabled from the Website Payment Preferences page 5 Click Save Getting and Using the Identity Token When you click Save and save your PDT preferences a message appears at the top of the page indicating that you have successfully saved your preferences Your identity token also appears in this message You will need to pass this identity token along with the transaction token to PayPal in order to receive information that confirms that a payment is complete Payment Data Transfer optional Payment Data Transfer allows you to receive notification of successful payments as they are made The use of Payment Data Transfer depends on your system configuration and your Return URL Please note that in order to use Payment Data Transfer you must turn on Auto Return Payment Data C On Transfer C off Identity Token imeSWn6 ZISil9BdnDY4g570zrgYomzimewyXqrwb445qFj1h8eiR3cUFhe For security the identity token is not sent to you however once you have enabled PDT it permanently appears below the Payment Data Transfer On Off radio buttons on the Website Payments Preferences page PDT and PayPal Account Optional The PayPal Account Optional does not require your customers who are new to PayPal to create a PayPal accoun
16. option_ selection2 invoice subscr_id 64 August 2005 Order Management Integration Guide Downloadable History Log Columns and Values EN TABLE B 1 Downloadable History Log Columns and Values Column Heading Custom Number Shipping Address Line 1 Shipping Address Line 2 Town City State Province Regi on County Territor y Prefecture Repub lic Zip Postal Code Country Balance Description Format Specified by seller in any of the alphanumeric following button creation fields e PayPal Shopping Cart Custom Number e Buy Now Custom Number e Subscription Custom Number First line of shipping address as alphanumeric specified by counterparty 395 character limit Second line of shipping address as alphanumeric 395 character limit specified by counterparty if applicable Town City of shipping address as specified by counterparty alphanumeric State Province Region Territory Pref ecture Republic of shipping address as specified by counterparty Zip Postal Code of shipping address as specified by counterparty Country of shipping address as specified by counterparty Account balance at time of transaction Balance is reported in the currency that transaction was received in signed decimal Payment Button Variable custom Related IPN Variable custom address_ streetl address_ street2 address_city address_stat e address_zip address_ country Orde
17. sent via a FORM GET variable to this return URL To properly use PDT and display transaction details to your customer you should read the transaction token from the variable tx and retrieve transaction details from PayPal by constructing an HTTPS POST to PayPal This is called notification synch or synchronization Constructing the POST Here are the guidelines for constructing the PDT HTTPS POST to PayPal for notification synch 1 Your POST must be sent to https www paypal com cgi bin webscr 2 You must include the cmd variable with the value _notify synch cmd _notify synch 3 You must include the transaction token in the variable tx and the value of the transaction token received via PayPal s GET tx value_of transaction_token 4 You must post your identity token using the variable at and the value of your PDT identity token at your_identity_token For information about the identity token see Getting and Using the Identity Token on page 19 August 2005 Order Management Integration Guide Payment Data Transfer E PDT Notification Synch PayPal Response to POST PayPal responds to the post with a single word on one line in the body of the response SUCCESS or FAIL When you receive a SUCCESS response the rest of the body of the response is the transaction details one per line in the format key value where key and value are both be URL encoded strings This response data needs to be parsed appropriately and
18. Address Status Item Title Item ID Description Email address of transaction recipient PayPal generated unique transaction ID Payment type used for transaction eCheck Instant PayPal Funds Account status of buyer International Unverified International Verified Unverified Verified Status of counterparty s Shipping Address Confirmed Non confirmed Specified by buyer in the website field e Auction Item Title Or by seller in any of the following button creation fields e PayPal Shopping Cart Item Name e Buy Now Item Name e Donations Item Name e Subscriptions Name Specified by buyer in the website field e Auction Item Number Or by seller in any of the following button creation fields e PayPal Shopping Cart Item Number e Buy Now ID Number e Donations ID Number e Subscription Reference Number Format alphanumeric 128 character limit alphanumeric 17 character limit alphanumeric 27 character limit alphanumeric 27 character limit alphanumeric 14 character limit alphanumeric 128 character limit alphanumeric 256 character limit Payment Button Variable business item_name item_number Related IPN Variable receiver_ email txn_id payment_type payer_status address_ status item_name item_number 62 August 2005 Order Management Integration Guide Downloadable History Log Columns and Values EN TABLE B 1 Downloa
19. Basic Information TABLE A 1 IPN and PDT Variables Basic Information Variable Name business item_name item_number Possible Values Description Email address or account ID of the payment recipient i e the merchant Equivalent to receiver_email if payment is sent to primary account and essentially an echo of the business variable passed in the Website Payment button HTML code Item name as passed by you the merchant Or if not passed by you as entered by your customer If this is a shopping cart transaction PayPal will append the number of the item e g item_namel item_name2 Pass through variable for you to track purchases It will get passed back to you at the completion of the payment If omitted no variable will be passed back to you Character Length 127 127 127 August 2005 41 a IPN and PDT Variables Advanced and Custom Information TABLE A 1 PN and PDT Variables Basic Information Character Variable Name Possible Values Description Length quantity Quantity as entered by your customer or as passed by you the merchant If this is a shopping cart transaction PayPal appends the number of the item e g quantityl quantity2 receiver_ Primary email address of the payment recipient 1 e the 127 email merchant If the payment is sent to a non primary email address on your PayPal account the receiver_email will still be your primary email receiver_id Unique a
20. Character length and limitations 17 Time Date stamp generated by PayPal format 18 30 30 Jan 1 2000 PST The status of the payment Canceled Reversal A reversal has been canceled For example you won a dispute with the customer and the funds for the transaction that was reversed have been returned to you Completed The payment has been completed and the funds have been added successfully to your account balance Denied You denied the payment This happens only if the payment was previously pending because of possible reasons described for the PendingReason element Expired This authorization has expired and cannot be captured Failed The payment has failed This happens only if the payment was made from your customer s bank account In Progress The transaction is in process of authorization and capture Partially Refunded The transaction has been partially refunded Pending The payment is pending See pending_ reason on page 45 for more information Refunded You refunded the payment Reversed A payment was reversed due to a chargeback or other type of reversal The funds have been removed from your account balance and returned to the buyer The reason for the reversal is specified in the ReasonCode element Processed A payment has been accepted Voided This authorization has been voided August 2005 TABLE A 3 IPN and PDT Variables Shopping Cart Information IPN and PDT Variables Sh
21. Column Headers EE A B c ji 1 Date Time Name Type 11 8 2002 16 09 57 Canceled Reversal Update to Reversal 11 8 2002 16 07 56 Ediz Canceled Payment 11 8 2002 15 54 25 Eviz Canceled Payment 11 7 2002 18 46 15 Ediz Payment Recewed 11 7 2002 18 45 54 Ediz Payment Recewed 11 7 2002 15 33 30 Ebiz Subscaption Payment RUnciened 11 7 2002 15 24 27 Ediz Payment Recewed Comgieret 11 7002 15 2412 Ediz Payment Recewed Reverses 11 7 2002 15 2344 Ediz Payment Recewed Completed 11 7 2002 16 23 13 Ediz Payment Recewed Reversed 117 2002 15 2011 Ediz eCheck Recewed Cleared 11 7 2002 152011 Ediz eCheck Recewed Cleared 1 5 2002 0 50 22 Akiko Wihams Canceled Payment Corngleted 14 26 11 5 2002 0 48 02 Akihiko Wihams Payment Recewed Reversed 15 15 2002 0 47 5 Akiko Wihams Payment Recewed Reversed asd 15 115 2002 047 13 Akiko WiBams Payment Recewed Denied no 10 11 4 2002 16 27 14 Pranzut Shi Auchon Payment Sent Completed 111 9 11 1 2002 15 16 53 jk secondmail 02031 Canceled Payment Completed 22 22 1111 2002 15 14 32 jk secondmai 2081 Canceled Payment Completed 5 11 1 2002 14 38 05 PayPal Money Mar Dividend From PayPal h Completed 1 116 410 37 10 31 2002 19 41 09 Mary Ann Agostinho Payment Recewed Completed 10 3 10 31 2002 14 48 44 From US Dollar Transfer 10 31 2002 14 45 44 To Yen Transfer Completed 10 31 2002 2 00 24 Ebiz Subsception Payment E Completed 10 31 2002 2 00 22 Ebiz Subscaption Payment E Completed 10 31 2002 2 00 20 Ebiz Subscaption Payrnert E
22. PayPal Order Management Integration Guide For Professional Use Only Currently only available in English A usage Professional Uniquement Disponible en Anglais uniquement pour l instant Last Updated August 2005 PayPal Order Management Integration Guide O 2006 PayPal Inc All rights reserved PayPal and the PayPal logo are registered trademarks of PayPal Inc Designated trademarks and brands are the property of their respective owners PayPal Europe Ltd is authorised and regulated by the Financial Services Authority in the United Kingdom as an electronic money institution PayPal FSA Register Number 226056 Notice of Non Liability PayPal Inc and the authors assume no liability for errors or omissions or for damages resulting from the use of this Manual or the information contained in this Manual Contents Preface 2 66 2 ee we ee Ae a aa aaa Y Chapter 1 Introduction on aoe wee ee ee A ee a Re Email oi 4464446 GO ed et e eee eA Ae Ape Sete ak A 11 o x sorire eGo Ne BEL ee ROR RAE eee BGA ra ek at Bek Aa eae ie BS 11 Differences between Instant Payment Notification IPN and Payment Data Transfer PDT 12 SSL Not Required for IPN o ee ee 12 PayPal Supported Currencies 13 Chapter 2 Payment Data Transfer ee 15 How PDT Works Sis ao ote a a o a we rd A a ee A A 15 Enabling Payment Data Transfer oaoa e 18 Getting and Using the Identity Token
23. TABLE A 9 Dispute Notification Variables Possible Variable Values Description case_id Case identification number Format PP nnn nnn nnn where n is any numeric character case_type complaint e complaint A buyer has logged a complaint through the chargeback PayPal Resolution Center chargeback A buyer has filed a chargeback with his credit card company which has notified PayPal of the reason for the chargeback case_ Transaction Date and time case was registered creation_ specific Format HH mm ss mon DD YYYY TZ date s where TZ is a three character time zone reason_code Depends on Reason for the case value of case_type reason_code Values for case_type complaint non_receipt Buyer claims that he did not receive goods or service not_as_ Buyer claims that the goods or service received differ from described merchant s description of the goods or service reason_code Values for case_type chargeback unauthorized Buyer claims that he did not authorize transaction non_receipt Buyer claims that he did not receive goods or service duplicate Buyer claims that a possible duplicate payment was made to the merchant merchandise Buyer claims that the received merchandise is unsatisfactory defective or damaged special Some other reason Usually special indicates a credit card processing error for which the merchant is not responsible and for which no debit to the merchant will result PayPal must review the documentatio
24. Variables for Each Subscription Event The following table shows which variables are associated and can be included in IPN posts with each subscription event type About payment_status and txn_type with Subscription IPN In IPN messages posted by Subscription events the payment_ status variable is sent only when a payment occurs For all other events the pertiunent variable is txn_type TABLE A 8 PN Variables with Each Subscription Event Payment Multi Payment Currency Variable Signup Cancel Modify USD Failed EOT Basic Information business X X X X X X X receiver_email X X X X X X X receiver_id X X item_name X X X X X X X item number X X X X X X X Advanced and Custom Information invoice X X X X X X X custom X X X X X X X option_namel X X X X X X X option_selecti X X X X X X X onl opt ion_name2 X X X X X X X option_selecti X X X X X X X on2 Transaction Information payment_status X X pending_reason X X reason_code X X payment_date X X txn_id X X parent_txn_id X X txn_type subscr_ subscr_ subscr_ subscr_payment subscr_ subscr_ signup cancel modify failed eot 52 August 2005 IPN and PDT Variables EN Subscriptions Variables TABLE A 8 PN Variables with Each Subscription Event Payment Multi Payment Currency Variable Signup Cancel Modify USD Failed EOT Currency and Exchange information mc_gross X X mc_fee X X mc_currency X X X X X X X settle_amount X X exchange_rate X X payment_gross X X X pa
25. Your buyer comes to your website and clicks on a PayPal Buy Now button to make a purchase Home Art Language History Science TkH Herodotus The History Herodotus Translated by David Grene Condition Like new slightly worn binding Price 15 00 Buy Now Step 2 After your buyer checks the payment details and sends the payment he will see a confirmation page as shown in the following diagram You Made A Payment Payment Information A payment of 17 00 has been sent to Alice s Used Books You will receive an email receipt for this transaction shortly For details on your transaction please contact Alice s Used Books Item Name Herodotus The History Add free gift wrap No How did you hear about us PayPal Shops Featured Shop Item Number HIS 0001 Shipping amp Handling 2 00 Amount 15 00 Quantity 1 Total Amount 17 00 Contact Information Business Name Alice s Used Books Contact Email help mystore com Contact Phone 988 898 8888 Click here to continue Step 3 At the time the payment is made PayPal will post a notification to your server at the URL you specified All of your customer s payment information and a piece of encrypted code will be included in this notification 0101010101101 5 Your Server 0001100001010 PayPal value HIS 001 value 17 00 value sales tax 0101010101101 E E Step 4 On receiving the notification your server validates the notification
26. above checks you can update your database based on the information provided If you receive an INVALID response you should investigate In some cases this response is caused by an IPN error possibly from a change in the IPN format To determine if it is an IPN error first examine your code If you need further assistance go to http www paypal com wf click the Seller Tools topic and click Instant Payment Notification IPN Using IPN with Multiple Currencies With multiple currencies you can accept payments in any of the PayPal supported currencies see Table 1 1 PayPal Supported Currencies Currency Codes and Maximum Transaction Amounts on page 13 As a result your IPNs will then include information about the currency of the payment The following overview explains how IPN interacts with multiple currencies Note If you are using one of PayPal s Website Payments solutions e g PayPal Shopping Cart and would like to be paid in a currency other than U S Dollars you will need to set up your buttons for your currency of choice payment_gross and payment_fee These variables reflect the amount received and corresponding fee of U S Dollar USD payments If the amount received and fee deducted are in a currency other than USD the variables will still appear in your IPN but will have no values in them NOTE payment_fee is not always present in IPNs such as when a payment is pending August 2005 Order
27. ariables by different characteristics e test_ipn Variable in Sandbox on page 40 e IPN Variables in All Posts on page 40 e Buyer Information on page 40 e Advanced and Custom Information on page 42 e Shopping Cart Information on page 43 e Currency and Currency Exchange on page 46 e Auctions on page 47 e Mass Payment on page 48 e Dispute Notification Variables on page 54 e PDT Specific Variables on page 56 Transaction Specifc Variable Values Unless otherwise indicated in the table column labeled Possible Values the value of an IPN or PDT variable is always specific to the transaction whose information is being posted August 2005 39 40 IPN and PDT Variables test_ipn Variable in Sandbox test_ipn Variable in Sandbox In the Sandbox environment IPN includes the additional variable test_ipn with a value of 1 one The purpose of test_ipn is to provide testing programs a means to differentiate between Sanbox IPN and live IPN IPN Variables in All Posts IPN Version notify_version The value of the notify_version variable is the version number of Instant Payment Notification that makes the post NOTE The value notify_version is a means for PayPal to track versions of IPN There is no need for your programs to store this value or query it Security Information verify_sign The value of of verify_sign is an encrypted string used to validate the authentic
28. ccount ID of the payment recipient i e the merchant 13 This is the same as the recipient s referral ID Advanced and Custom Information TABLE A 2 IPN and PDT Variables Advanced and Custom Information Character Variable Name Possible Values Description Length custom Custom value as passed by you the merchant These are pass 255 through variables that are never presented to your customer invoice Passthrough variable you can use to identify your Invoice 127 Number for this purchase If omittted no variable is passed back memo Memo as entered by your customer in PayPal Website Payments 255 note field option_ Option 1 name as requested by you 64 namel Tf this is a shopping cart transaction see Table A 3 IPN and PDT Variables Shopping Cart Information on page 43 for more information option_name Option 2 name as requested by you 2 Tf this is a shopping cart transaction see Table A 3 IPN and PDT Variables Shopping Cart Information on page 43 for more information option_ Option 1 choice as entered by your customer 200 selectionl If this is a shopping cart transaction see Table A 3 IPN and PDT Variables Shopping Cart Information on page 43 for more information 42 August 2005 IPN and PDT Variables Shopping Cart Information TABLE A 2 IPN and PDT Variables Advanced and Custom Information Character Variable Name Possible Values Description Length option_ Option 2 choice as entered by your customer
29. d 46 54 txn_type 46 49 54 U unauthorized 55 unilateral 45 upgrade 45 URL encoding in IPN data 39 username 51 V VERIFIED response 28 verify 45 Order Management Integration Guide August 2005 73 74 August 2005 Order Management Integration Guide
30. d to effectively measure and manage your business With PayPal s Reporting Tools you can e Analyze your revenue sources to better understand your customers buying behavior e Automate time consuming bookkeeping tasks e Accurately settle and reconcile transactions Available reports e Monthly Account Statements View a summary of all credits and debits that have affected your account balance each month e Merchant Sales Reports Every week receive valuable analysis of revenue by sales channel and currency e History Log View an online record of your received and sent payments Order Management Integration Guide August 2005 11 EN Introduction Differences between Instant Payment Notification IPN and Payment Data Transfer PDT e Downloadable Logs Keep track of your transaction history by downloading it into various file formats suitable for financial settlements For more information about PayPal s reports see http www paypal com cgi bin webscr cmd p xcl rec reports intro outside Differences between Instant Payment Notification IPN and Payment Data Transfer PDT PDT s primary function is to display payment transaction details to buyers when they are automatically redirected back to your site upon payment completion however there are cases where you will not receive notification of all transactions such as with pending transactions refunds and reversals For these reasons or if you are using this data t
31. dable History Log Columns and Values Payment Button Related IPN Column Heading Description Format Variable Variable Shipping Amount Specified by buyer in the website unsigned shipping field decimal shipping2 e eBay Auction Shipping amount handling Or by seller in any of the following button creation fields e PayPal Shopping Cart Shipping amount e Buy Now Shipping amount Insurance Amount Specified by buyer in the website unsigned field decimal e eBay Auction Insurance amount Sales Tax Sales Tax Amount specified in unsigned tax seller s button creation process and decimal Profile preferences Option 1 Name Specified by seller in any of the alphanumeric on0 option_namel following button creation fields 60 character e PayPal Shopping Cart Option 1 limit Name e Buy Now Option 1 Name Subscription Option 1 Name Option 1 Value Entered by buyer in any of the alphanumeric onl opt ion_name2 following website fields 30 character e PayPal Shopping Cart Option 1 limit Value e Buy Now Option Value e Subscription Option 1 Value Or specified by seller in any of the following button creation fields e PayPal Shopping Cart Value 1 Choices e Buy Now Value 1 Choices e Subscription Value 1 Choices Option 2 Name Specified by seller in any of the alphanumeric onl option_selec following button creation fields 60 character tionl e PayPal Shopping Cart Option 2 limit Name e Buy Now Option 2 Name e Subscription Option 2 Na
32. e Complaint A buyer has used the PayPal Resolution Center to register a claim about a payment to a merchant Note After notification about a complaint claim merchants must log in to PayPal to use the Resolution Center to respond to the case e Chargeback A buyer has filed a complaint with a credit card company that has resulted in a chargeback The credit card company notifies PayPal about the reason for the chargeback After investigating the case PayPal notifies the merchant of any action required IPN variables for cases include the type of case the reason and other information about the case For details about all variables and their possible values see Dispute Notification Variables on page 54 32 August 2005 Order Management Integration Guide Downloadable History Log PayPal s Downloadable History Log makes it easier and more efficient to track sort and print transactions from your PayPal account Download your transaction history into one of several available file formats outlined in this document so that you can view and store your transaction history offline Once you ve downloaded your history log you can analyze the data to learn more about your business and customer needs as well as generate customer lists financial statements and customized reports This manual is designed to provide you a comprehensive overview of the information and instructions you need to get the most from PayPal s Downloadable H
33. e payment notifications for different payments at different URLs for example if you need to separate payments to different websites you run use the notify_url variable to pass the notification URL With each payment PayPal saves the value of the notify_url for a specific payment and any subsequent updates to that payment such as a cleared eCheck are sent to that notify_url When you pass a notify_url in your post it overrides the setting in your Profile Profile Setting If you want to receive your IPNs at only a single URL enter that URL in the Preferences section of your Profile Likewise the shared secret you can use to validate that you have received an IPN can be set either with each individual payment transaction or globally in your Profile for all transactions Per Transaction If you want a distinct shared secret for each notification for each payment append a FORM variable name and a shared secret value to the value of the notify_url variable When you pass a shared secret in your payment post it overrides the setting in your Profile Profile Setting If you want the same shared secret for each and every transaction enter that shared secret in the Preferences section of your Profile August 2005 Order Management Integration Guide Instant Payment Notification IPN IPN Notification and Notification Validation Shared Secret Validation The first and recommended method for notification validation is to use a shared secr
34. e user s email address Order Management Integration Guide August 2005 a Downloadable History Log Columns and Values TABLE B 1 Downloadable History Log Columns and Values Column Heading Type Description Format Type of transaction alphanumeric Add Funds from a Bank Account 39 character ATM Withdrawal ATM Withdrawal Reversal Auction Payment Received Auction Payment Sent Canceled Fee Canceled Payment Canceled Transfer Chargeback Settlement Check Withdrawal from PayPal Currency Conversion Debit Card Cash Advance Debit Card Purchase Dividend From PayPal Money Market eCheck Received eCheck Sent Funds Added with a Personal Check Guarantee Reimbursement Payment Received Payment Sent PayPal PayPal Balance Adjustment Referral Bonus Refund Shopping Cart Payment Received Shopping Cart Payment Sent Subscription Payment Received Subscription Payment Sent Transfer Update to Add Funds from a Bank Account Update to Debit Card Credit Update to eCheck Received Update to Payment Received Update to Payment Sent Update to Reversal Update to Web Accept Payment Received Virtual Debit Card Authorization Virtual Debit Card Credit Received Virtual Debit Card Purchase Virtual Debt Card Credit Received Web Accept Payment Received Web Accept Payment Sent Withdraw Funds to a Bank Account limit Payment Button Related IPN Variable Variable txn_type 60 August 2005 Order Management Integration G
35. eceipt of an IPN is to post back to PayPal the exact variables and values you received in the IPN Constructing the POST Here are the guidelines for constructing the IPN HTTPS POST to PayPal for notification validation Note You can implement IPN without SSL but PayPal recommends against doing so 1 Your POST must be sent to https www paypal com cgi bin webscr 2 You must include the variable cmd with the value _notify validate cmd _notify validate 3 You must post all the form variables you received exactly as you received them Order Management Integration Guide August 2005 27 28 Instant Payment Notification IPN Using IPN with Multiple Currencies PayPal Response to Postback PayPal responds to the postback with a single word in the body of the response VERIFIED or INVALID When you receive a VERIFTED response perform the following checks 1 Check that the payment_status is Completed 2 If the payment_status is Completed check the txn_id against the previous PayPal transaction you have processed to ensure it is not a duplicate 3 After you have checked the payment_status and txn_id make sure the receiver_email is an email address registered in your PayPal account 4 Check that the price mc_gross and currency mc_currency are correct for the item item_name or item_number 5 Check the the shared secret returned to you is correct Once you have completed the
36. ent was Pending you will receive another IPN when the payment clears fails or is denied IPN can be seamlessly integrated with each of the PayPal Website Payments solutions Buy Now Buttons PayPal Shopping Cart Subscriptions and Recurring Payments and Donations and with regular PayPal Send Money and Mass Pay payments It lets you focus on selling not on manually tracking your orders How It Works When a customer makes a payment to you or a payment is reversed or refunded PayPal will post a notification to your server at the URL you specified Included in this notification will be all of your customer s payment information e g customer name payment amount as well as a piece of encrypted code When your server receives a notification it will then post the information including the encrypted code back to a secure PayPal URL PayPal will authenticate the transaction and send confirmation of its validity back to your server After you have activated Instant Payment Notification your server will be sent a notification every time you receive a payment This notification will be sent as a hidden FORM POST to the URL you specified and will include all of the payment information The FORM variables for these notifications are available in Appendix A of this manual Order Management Integration Guide August 2005 23 HN Instant Payment Notification IPN How IPN POSTs Are Sent How IPN POSTs Are Sent Step 1
37. et on individual payment transactions Add a shared secret variable and value to the value of the notify_url variable to which the IPN data is posted after a payment is made The shared secret consists of the following notify_ur1 yourlPNnotificationURL shared_secret_variable_name shared_secret_value where yourlPNNotificationURL is a URL on your website at which you want to receive notification shared_secret_variable_nameis any variable name you want shared secret value is the shared secret itself For example the value of notify_url variable might look like this notify_url https www mysite com PP IPN Validate cfm secret shhhhhhh Security Considerations with Shared Secret Validation To ensure the security of your shared secret you should use Encrypted Website Payments EWP For information about EWP see the PayPal Standard Checkout Integration Guide The value of the shared secret is not encrypted it is in clear text for easier processing Therefore the shared secret value is recorded in your web server s access log Be sure to practice proper security for your server access logs If you use a web server hosting service ensure that your provider practices proper security of your data IMPORTANT Your notification URL should check the validity of the returned shared secret and flag for investigation any transaction that does not have the correct shared secret HTTPS Postback to PayPal The second method for validating your r
38. formation 42 IPN and PDT Variables Shopping Cart Information 43 IPN and PDT Variables Currency and Currency Exchange Information 46 IPN and PDT Variables Auctions o 47 IPN and PDT Variables Mass Pay o e 48 Subscriptions Variables o 49 IPN Variables with Each Subscription Event 52 Dispute Notification Variables 54 PDT Specific Variables o o 56 Downloadable History Log Columns and Values 59 ISO 3166 Two Character Country Codes 67 August 2005 fa List of Tables 6 August 2005 Order Management Integration Guide Figure 4 1 Figure 4 2 Figure 4 3 Figure 4 4 Figure 4 5 Order Management Integration Guide List of Figures The Download My History Link Customize My History Download Download History Page A Comma Separated Value History log in a spreadsheet file A comma delimited history log in a text file August 2005 34 35 36 38 38 HER List of Figures 8 August 2005 Order Management Integration Guide Preface This Document This release of the PayPal Order Management Integration Guide a document that describes the PayPal features for managing orders such as Payment Data Transfer PDT Instant Payment Notification IPN and Downloadbale History Log replaces the version released
39. he set XXXXXX Hypertext link to a URL or that initiates a web action such as sending mail Documentation Problems If you discover any errors in or have any problems with this documentation please email us by following the instructions below Describe the error or problem as completely as possible and give us the document title the date of the document located at the foot of every page and the page number or page range To contact Customer Service about documentation problems 1 Go to https www paypal com Click Help in the upper left corner of the page 2 3 Click Contact Us in the lower left of the page 4 Choose Help by Email 5 Complete the form August 2005 Order Management Integration Guide Introduction PayPal offers four payment notification methods for backend integration e Email e Reporting Tools e Instant Payment Notification IPN e Payment Data Transfer PDT Email You will receive an email notification in the following cases e Successful Payment e Pending Payment e Cancelled Payment If you do not want to receive payment notifications via email 1 Click the Profile subtab of the My Account tab 2 Click the Notifications link in the Account Information column 3 Find the Payment Notifications heading and clear the I receive PayPal Website Payments and Instant Purchase checkbox 4 Click Save Reporting PayPal s Reporting Tools provide you with the information you nee
40. his is a legacy field USD payments replaced by mc_gross If this amount is negative it signifies a refund or only reversal and either of those payment statuses can be for the full or partial amount of the original transaction settle_ Amount that is deposited into the account s primary balance after a currency amount conversion from automatic conversion through your Payment Receiving Preferences or manual conversion through manually accepting a payment settle_ Currency of sett le_amount currency Auctions TABLE A 5 PNand PDT Variables Auctions Character Variable Name Possible Values Description Length auction_ This is the customer s auction ID 64 buyer_id auction_ This is the auction s close date closing_ date auction_ This is the number of items purchased in multi item auction multi_item payments It allows you to count the mc_gross or payment_gross for the first IPN you receive from a multi item auction auction_multi_item since each item from the auction will generate an Instant Payment Notification showing the amount for the entire auction for_auction true This is an auction payment payments made using Pay for eBay Items or Smart Logos as well as Send Money Money Request payments with the type eBay items or Auction Goods non eBay August 2005 47 48 IPN and PDT Variables Mass Payment TABLE A 6 Mass Payment IPN and PDT Variables Mass Pay Variable Name mass
41. in June 2005 This document replaces portions of the Merchant User Manual and Integration Guide issued in April 2005 Intended Audience This document is written for merchants who use PayPal to manage order information Organization of This Document Chapter 1 Introduction gives a brief overview of the PayPal features for order management discussed in this guide Chapter 2 Payment Data Transfer describes how PDT works and how to set it up Chapter 3 Instant Payment Notification IPN describes how IPN works and how to set it up Chapter 4 Downloadable History Log describes the Downloadable History Log and how you can use it to reconcile payment transactions Appendix A IPN and PDT Variables is a detailed description of all variables and values returned by IPN or PDT Appendix B Downloadable History Log Columns and Values describes the columns and values that can be included in the Downloadable History Log Notational Conventions This document uses typefaces to identify the characteristics of text These typefaces and the characteristics they imply are described below Typeface How Used serif italics A document title A term being discussed or defined For example A file is a readable or writable stream of characters Boolean values not keywords For example The function returns true if it encounters an error Order Management Integration Guide August 2005 P
42. ise blank optional Amount of payment for trial period 2 for USD payments otherwise blank optional Amount of payment for regular subscription period for USD payments otherwise blank Amount of payment for trial period 1 regardless of currency optional Amount of payment for trial period 2 regardless of currency optional Amount of payment for regular subscription period regardless of currency For non payment subscriptions IPNs 1 e txn_type signup cancel failed eot or modify this is the currency of the subscription For payment IPNs it is the currency of the payment i e txn_type subscr_payment Indicates whether regular rate recurs 1 is yes blank is no Indicates whether reattempts should occur upon payment failures 1 is yes blank is no Date PayPal will retry a failed subscription payment The number of payment installments that will occur at the regular rate August 2005 IPN and PDT Variables EN Subscriptions Variables TABLE A 7 Subscriptions Variables Possible Character Variable Values Description Limit username optional Username generated by PayPal and 64 given to subscriber to access the subscription password optional Password generated by PayPal and given to subscriber to access the subscription password will be encrypted subscr_id ID generated by PayPal for the subscriber 19 August 2005 51 EN IPN and PDT Variables Subscriptions Variables
43. istory Log feature Order Management Integration Guide August 2005 33 34 Downloadable History Log Customizing Your Downloadable History Log Customizing Your Downloadable History Log Business or Premier PayPal account holders can customize their Downloadable History Log at any time e Add info to or remove from your Downloadable History Log e Modify how information is displayed in your account For example you can display a buyer s shipping address in a single column rather than multiple columns Here s how 1 Log in to your PayPal account 2 Click the History subtab under the My Account tab 3 Click the Download My History link in the Reporting Tools box FIGURE 4 1 The Download My History Link eee Overview Add Funds Withdraw Cision Resolution Center Profile History Monthly Account Statements Reporting Tools View up to three previous months of transaction history in one convenient place e Merchant Sales Report Next statement available on Jan 15 2005 Lea More Dec 2004 View e Advanced Search e Transaction Disputes Search Search your Account History and see results below Show Al Activity Advanced View Within The Past Day x From fiz 7 A OS A fos eos Month Day Year Month Day Year Search All Activity Advanced View from Dec 6 2004 to Jan 5 2005 Date Type To From Name Email Status Details Action Gross Fee mene Balance Jan i PayPal 0 07 0 07 0 07 1 Dividend
44. item_namel item_name2 The tax_x variable is included only if there was a specific tax amount applied to a particular shopping cart item Because profile tax may apply to other items in the cart the sum of tax_x might not total to tax A unique transaction ID generated by the PayPal system Character length and limitations 17 cart Transaction created by customer via the PayPal Shopping Cart feature send money Transaction created by customer from the Send Money tab on the PayPal website web accept Transaction created by customer via Buy Now Donation or Auction Smart Logos Currency and Currency Exchange TABLE A 4 IPN and PDT Variables Currency and Currency Exchange Information Variable Name Possible Values exchange_ rate mc_currency See table of supported currencies mc_fee mc_gross mc_handling mc_shipping Description Exchange rate used if a currency conversion occurred For payment IPNs this is the currency of the payment For non payment subscription IPNs this is the currency of the subscription Transaction fee associated with the payment mc_gross minus mc_fee will equal the amount deposited into the receiver_email account Equivalent to payment_fee for USD payments If this amount is negative it signifies a refund or reversal and either of those payment statuses can be for the full or partial amount of the original transaction fee Full amount of the customer s payment
45. ity of the transaction Buyer Information TABLE 4 1 IPN and PDT Variables Buyer Information Variable Name Possible Values address_ city address_ country address_ country_ code address_ name address_ state address_ status confirmed unconfirmed Description City of customer s address Country of customer s address Two character ISO 3166 country code Name used with address included when the customer provides a Gift Address State of customer s address Customer provided a confirmed address Customer provided an unconfirmed address Character Length 40 64 128 40 August 2005 TABLE 4 1 IPN and PDT Variables Basic Information IPN and PDT Variables Buyer Information Variable Name address_ street address_zip first_name last_name payer_ business_ name payer_email payer_id payer_ status residence_ country Possible Values verified unverified Description Customer s street address Zip code of customer s address Customer s first name Customer s last name Customer s company name if customer represents a business Customer s primary email address Use this email to provide any credits Unique customer ID Customer has a Verified PayPal account Customer has an Unverified PayPal account Two character ISO 3166 country code Character Length 200 20 64 64 127 127 13
46. ling 20 00 USD Total Amount 162 50 USD Source of Funds U S Dollar Balance 162 50 USD More Funding Options Shipping Information Ship to 1234 Main Street Walnut Creek CA95599 Add Address C No shipping address required Pay Cancel 16 August 2005 Order Management Integration Guide Payment Data Transfer How PDT Works Step 5 A payment confirmation page appears that informs Bob that his payment has been completed and that he is being redirected back to the Widget Warehouse website Payments ty Pay Pal Global Industries Inc Widget Warehouse You Made A Payment Your payment for 162 50 USD has been completed You are now being redirected to Widget Warehouse If you are not redirected within 10 seconds click here Step 6 A transaction token is passed to the return URL provided by the Widget Warehouse The Widget Warehouse fetches the transaction token and retrieves the transaction details from PayPal via an HTTP POST Included in the HTTP post is the identity token that was given to the Widget Warehouse when PDT was enabled For more information about the PDT identity token see Getting and Using the Identity Token on page 19 For more information about the HTTP POST see PDT Notification Synch on page 20 Step 7 The Widget Warehouse s Thank You page appears and displays the transaction information again informing Bob that his transaction has been completed and a receipt f
47. ll be used for the payment e mc_gross payment_gross e mc_fee payment_fee EXAMPLE 3 1 Multi currency IPN USD Payment payment_status Completed payment_gross 100 payment_fee 3 00 mc_gross 100 mc_fee 3 00 mc_currency USD Example 2 f a user with a CAD balance receives a 100 CAD payment the following variables will be used for the payment e mc_gross and mc_fee have values e payment_gross and payment_fee are blank EXAMPLE 3 2 Multi currency IPN CAD Payment payment_status Completed Order Management Integration Guide August 2005 29 30 Instant Payment Notification IPN Using IPN with Multiple Currencies payment_gross payment_fee mc_gross 100 mc_fee 3 00 mc_currency CAD Example 3 If the account is set to automatically convert payments these variables will be used to show the conversion This example is for a user with a USD balance who receives a payment of 100 GBP EXAMPLE 3 3 Mutli currency IPN Automatic Conversion of GBP Payment payment_status Completed payment_gross payment_fee mc_gross 100 mc_fee 3 00 mc_currency GBP settle_amount 145 5 settle_currency USD exchange_rate 1 5 Example 4 If a payment received is pending due to pending_reason multi_currency the first IPN received would not have the settle_amount settle_ currency or exchange_rate EXAMPLE 3 4 Mutli currency IPN Pending Payment payment_status Pending pending_reas
48. made to an email address that is not yet registered or confirmed upgrade The payment is pending because it was made via credit card and you must upgrade your account to Business or Premier status in order to receive the funds upgrade can also mean that you have reached the monthly limit for transactions on your account verify The payment is pending because you are not yet verified You must verify your account before you can accept this payment other The payment is pending for a reason other than those listed above For more information contact PayPal Customer Service This variable is only set if payment_status Reversed or Refunded chargeback A reversal has occurred on this transaction due to a chargeback by your customer guarantee A reversal has occurred on this transaction due to your customer triggering a money back guarantee buyer complaint A reversal has occurred on this transaction due to a complaint about the transaction from your customer refund A reversal has occurred on this transaction because you have given the customer a refund other A reversal has occurred on this transaction due to a reason not listed above August 2005 45 IPN and PDT Variables Currency and Currency Exchange TABLE A 3 PN and PDT Variables Shopping Cart Information Variable Name Possible Values tax txn_id txn_type cart send_money web accept Description PayPal appends the number of the item e g
49. me Order Management Integration Guide August 2005 63 a Downloadable History Log Columns and Values TABLE B 1 Downloadable History Log Columns and Values Column Heading Option 2 Value Auction Site Item URL Closing Date Reference Txn ID Invoice Number Subscription Number Description Entered by buyer in any of the following website fields e PayPal Shopping Cart Option 2 Value e Buy Now Option 2 Value e Subscription Option 2 Value Or specified by seller in any of the following button creation fields e PayPal Shopping Cart Value 2 Choices e Buy Now Value 2 Choices e Subscription Value 2 Choices Name of Auction Site eBay Yahoo Auctions uBid com Amazon com Auctions MSN Auctions BidVille Other URL of eBay Auction Item eBay Auction specific Close date of eBay Auction Item eBay Auction specific Transaction ID of parent transaction Specified by seller in any of the following button creation fields e PayPal Shopping Cart Invoice Number e Buy Now Invoice Number e Subscription Invoice Number PayPal generated Subscription Transaction ID Number S XXXXXXXXXXXXXXXX where x is the transaction ID Payment Button Format Variable alphanumeric osl 30 character limit alphanumeric 20 character limit alphanumeric 256 character limit M M D D Y YYY alphanumeric 17 character limit alphanumeric invoice alphanumeric 19 character limit Related IPN Variable
50. meone from reusing an old completed transaction e receiver_email is an email address registered in your PayPal account to prevent the payment from being sent to a fraudulent account e Other transaction details such as the item number and price to confirm that the price has not been changed Code Samples PayPal has made available code samples that you can use to set up PDT These samples are available at https www paypal com us cgi bin webscr cmd p xcl rec pdt code There are code samples for the following development environments e ASP VBScript e ColdFusion e PERL e PHP 22 August 2005 Order Management Integration Guide Instant Payment Notification IPN Instant Payment Notification IPN allows you to integrate PayPal payments with your website s back end operations IPN provides immediate notification and confirmation of PayPal payments you receive allowing you to e Customize your website s response to customer purchases in real time e Track customers through the notification s pass through variables e Automate your fulfillment operations e Store transaction information in your own database To activate Instant Payment Notification you will need to go to your Profile to enter the URL at which you would like to receive notification posts Once you activate IPN you will receive an IPN when a payment is first sent which will state the status of the payment Completed or Pending If the paym
51. n from the credit card company to determine the nature of the dispute and possibly contact the merchant to resolve it August 2005 55 EN IPN and PDT Variables PDT Specific Variables PDT Specific Variables The following variables apply only to PDT TABLE A 10 PDT Specific Variables Variable Description tx Transaction ID PDT token st Transaction status amt Amount of the transaction cc Currency code cm Custom message 56 August 2005 IPN and PDT Variables a PDT Specific Variables August 2005 57 IPN and PDT Variables PDT Specific Variables 58 August 2005 Downloadable History Log Columns and Values TABLE B 1 Downloadable History Log Columns and Values PaymentButton Related IPN Column Heading Description Format Variable Variable Date Date transaction was initiated M M D D Y payment_date according to PayPal system time YYY subscr_date US Pacific time zone Log sorted in reverse chronological order by Date most recent first Time Time transaction was initiated HH MM SS according to PayPal system time US Pacific time zone Timezone The time zone used for recording Alphanumeric transactions in your PayPal account three character codes Name Name of counterparty alphanumeric first_name If counterparty is a PayPal verified 128 character last_name user this field will contain the users limit first and last name If counterparty is not a verified user field will contain th
52. o fulfill orders PayPal strongly recommends that you also enable Instant Payment Notification IPN Both IPN and PDT send back the same data however there are several important differences PDT e Requires Auto Return to be enabled e Auto Return will include an ID that can be used to query PayPal for the complete transaction details e Itis possible to miss a notification if the user closes the browser before the redirection is complete IPN e Does not require Auto Return to be enabled e At the end of the website payment flow PayPal POSTs the IPN data asynchronously i e not as part of the website payment flow e IPNs will also POST for eCheck clearings reversals and refunds SSL Not Required for IPN Because credit card and bank information is not transmitted in Instant Payment Notification IPN PayPal does not require Secure Sockets Layer SSL to encrypt IPN transmissions 12 August 2005 Order Management Integration Guide Introduction PayPal Supported Currencies PayPal Supported Currencies The following currencies are supported by PayPal TABLE 1 1 PayPal Supported Currencies Currency Codes and Maximum Transaction Amounts Maximum Transaction Code Currency Amount AUD Australian Dollar 12 500 AUD CAD Canadian Dollar 12 500 CAD EUR Euro 8 000 EUR GBP Pound Sterling 5 500 GBP JPY Japanese Yen 1 000 000 JPY USD U S Dollar 10 000 USD Order Management Integration Guide August 2005 13 E In
53. ols _notify synch 20 _notify validate 27 A Account Optional and PDT 19 address 45 address_city 40 address_country 40 address_country_code 40 address_name 40 address_state 40 address_street 41 address_zip 41 amountl 50 amount2 50 amount3 50 amt 56 at variable for PDT 20 auction_buyer_id 47 auction_closing_date 47 auction_multi_item 47 auth_amount 43 auth_exp 43 auth_id 43 auth_status 43 authorization 45 Auto Return and PDT 19 21 B business 41 C Canceled Reversal 44 cart 46 case_creation_date 55 case_id 55 Order Management Integration Guide case_type 55 cc 56 chargeback 32 55 claims 32 cm 56 complaint 55 Completed 44 country codes 67 currency codes 13 custom 42 D Denied 44 duplicate 55 E echeck 45 exchange_rate 46 Expired 44 F Failed 44 first name 41 for_auction 47 identity token 19 In Progress 44 instant 45 Instant Payment Notification See IPN intl 45 INVALID response 28 invoice 42 IPN 23 INVALID reponse 28 multiple currencies 28 set up 25 August 2005 71 72 VERIFIED response 28 item_name 41 item_number 41 L last_name 41 masspay_txn_id_x 48 mc_amountl 50 mc_amount2 50 mc_amount3 50 mc_currency 29 46 50 mc_currency_x 48 mc_fee 29 46 47 mc_fee_x 48 mc_gross 29 46 mc_gross_x 43 48 mc_handling 46 mc_handling x 43 mc_shipping 46 mc_shipping_x 43 memo 42 merchandise 55 multi currency 45 multiple currencies 28 N new_case 54
54. on multi_currency payment_gross mc_gross 100 mc_currency GBP The second IPN contains information about settling the payment If the payment is accepted into the account s primary currency which is USD in the following example EXAMPLE 3 5 Pending Convert to Primary Currency payment_status Completed payment_gross payment_fee mc_gross 100 mc_fee 3 00 mc_currency GBP settle_amount 145 5 settle_currency USD exchange_rate 1 5 If the payment is accepted into a balance of the same currency August 2005 Order Management Integration Guide Instant Payment Notification IPN EN Using IPN with Multiple Currencies EXAMPLE 3 6 Pending Accept to Currency Balance payment_status Completed payment_gross payment_fee mc_gross 100 mc_fee 3 00 mc_currency GBP If the payment is denied EXAMPLE 3 7 Pending Denied payment_status Denied payment_gross mc_gross 100 mc_currency GBP NOTE If a user receives a payment into a currency balance and later converts this amount into another currency balance the corresponding currency conversion transaction has no IPN Order Management Integration Guide August 2005 31 HN Instant Payment Notification IPN Dispute Notification Dispute Notification Buyers can register claims about payments such claims are called cases PayPal notifies merchants about new cases with email and with IPN There are two kinds of cases
55. opping Cart Information Variable Name payment_ type pending_ reason reason_code Possible Values echeck instant address authorization echeck intl multi currency unilateral upgrade verify other chargeback guarantee buyer complain t refund other Description echeck This payment was funded with an eCheck instant This payment was funded with PayPal balance credit card or Instant Transfer This variable is set only if payment_status Pending address The payment is pending because your customer did not include a confirmed shipping address and your Payment Receiving Preferences is set yo allow you to manually accept or deny each of these payments To change your preference go to the Preferences section of your Profile authorization You set lt PaymentAction gt Authorization lt PaymentAction gt on SetExpressCheckoutRequest and have not yet captured funds echeck The payment is pending because it was made by an eCheck that has not yet cleared int1 The payment is pending because you hold a non U S account and do not have a withdrawal mechanism You must manually accept or deny this payment from your Account Overview multi currency You do not have a balance in the currency sent and you do not have your Payment Receiving Preferences set to automatically convert and accept this payment You must manually accept or deny this payment unilateral The payment is pending because it was
56. or the purchase has been emailed to him The page also displays payment details a link to PayPal that Bob can use to view more transaction details if necessary as well as links that he can use to continue shopping For example as shown in the following diagram Thank you for your payment Your transaction has been completed and a receipt for your purchase has been emailed to you You may log into your account at www paypal com to view details of this transaction Widget Warehouse Thank you for your payment Your transaction has been completed Item Widget Amount 162 50 Email bdeboe merchantty Ship to Bob Deboe 1234 Main Street Walnut Creek CA 95599 Pleate print this page for your records A receipt for your purchase has also been emailed to you Giota Industrees Ine 48 nghts neverved 2003 Order Management Integration Guide August 2005 17 Payment Data Transfer Enabling Payment Data Transfer Step 8 Bob receives an email receipt for this transaction confirming his purchase and including a copy of the payment details the Widget Warehouse s business information and his confirmed shipping address Th dand PayPal ias Protect Your Account Info Dear Bob Deboe Make sure you never provide your i i assword to fraudulent websites This email confirms that you Bob Deboe have paid pi Widget Warehouse 162 50 using PayPal To safely and securely access the PayPal website or your
57. ow to ignore previously downloaded transactions and transactions older than 30 days 5 Choose the desired file format 6 Select whichever of the two checkboxes that apply 7 Click the Download History button and save the file to a memorable location for easy reference later 36 August 2005 Order Management Integration Guide Downloadable History Log E Viewing Your Downloaded Log Viewing Your Downloaded Log As detailed in the previous section your Downloadable History Log can be saved and viewed in any of the following file formats e Comma separated value CSV plain text file for use with spreadsheet programs e Tab delimited plain text file e Intuit Quicken QuickBooks file For automated file processing and reconciliation applications PayPal recommends you use comma delimited or tab delimited formats Comma delimited and tab delimited files may contain fields with punctuation and spaces Those fields will be automatically double quoted in the file output When viewing comma delimited or tab delimited file formats in spreadsheet applications like Excel the log files display field column headers across the first row and data values for individual transactions in subsequent rows Each row is separated by a carriage return Order Management Integration Guide August 2005 37 Downloadable History Log Viewing Your Downloaded Log FIGURE 4 4 A Comma Separated Value History log in a spreadsheet file gt Field
58. pay_ txn_id_x me_currency x mc_fee_X mc_Qgross_X payment_ date payment_fee X payment_ gross_X payment_ status receiver_ email_x Possible Values Transaction specific for multiple currencies Transaction specific for multiple Currencies Transaction specific for Multiple Currencies Transaction specific for USD payments only Transaction specific for USD payments only Completed Denied Processed Description For Mass Payments a unique transaction ID generated by the PayPal system where x is the record number of the mass pay item For Mass Payments the currency of the amount and fee where x is the record number the mass pay item For Mass Payments the transaction fee associated with the payment where x is the record number the mass pay item The gross amount for the amount where x is the record number the mass pay item For Mass Payments the first IPN is the date time when the record set is processed and the second IPN is the date time when all payments are completed returned If the payment is USD then the value is the same as that for mc_fee_x where X is the record number if the currency is not USD then this is an empty string If the payment is USD then the value for this is the same as that for the mc_gross_x where x is the record number the mass pay item If the currency is not USD this is an empty string Completed For Mass Payments this means that all of you
59. r Management Integration Guide August 2005 65 Downloadable History Log Columns and Values 66 August 2005 Order Management Integration Guide Country Codes ISO 3166 Standard Country Codes PayPal relies on two character country codes defined by International Standards Organization 1SO 3166 TABLE C 1 SO 3166 Two Character Country Codes Country Code Anguilla Al Argentina AR Australia AU Austria AT Belgium BE Brazil BR Canada CA Chile CL China CN Costa Rica CR Cyprus CY Czech Republic CZ Denmark DK Dominican Republic DO Ecuador EC EE Estonia Finland FI France FR Germany DE Greece GR Hong Kong HK August 2005 Neal Country Codes ISO 3166 Standard Country Codes TABLE C 1 SO 3166 Two Character Country Codes Country Code Hungary HU Iceland IS India IN Treland IE Israel IL Italy IT Jamaica JM Japan JP Latvia LV Lithuania LT Luxembourg LU Malaysia MY Malta MT Mexico MX Netherlands NL New Zealand NZ Norway NO Poland PL Portugal PT Singapore SG Slovakia SK Slovenia SI South Africa ZA South Korea KR Spain ES Sweden SE Switzerland CH Taiwan TW 68 August 2005 Country Codes a ISO 3166 Standard Country Codes TABLE C 1 SO 3166 Two Character Country Codes Country Code Thailand TH Turkey TR United Kingdom GB United States US Uruguay UY Venezuela VE August 2005 69 E Country Codes ISO 3166 Standard Country Codes 70 August 2005 Index Symb
60. r payments have been claimed or after a period of 30 days unclaimed payments have been returned to you Denied For Mass Payments this means that your funds were not sent and the Mass Payment was not initiated This may have been caused by lack of funds Processed Your Mass Payment has been processed and all payments have been sent For Mass Pay payments the primary email address of the payment recipient where x is the record number the mass pay item August 2005 IPN and PDT Variables EN Subscriptions Variables TABLE A 6 PN and PDT Variables Mass Pay Variable Name Possible Values status_X Completed Failed Reversed Pending txn_type masspay unique_id_X Description For Mass Payments the status of the payment where x is the record number Completed The payment has been processed regardless 1f this was originally a unilateral payment Failed The payment failed because there was not enough funds in the balance Reversed This is for unilateral payments that were not claimed after 30 days and have been returned to the Sender Or the funds have been returned because the Receiver s account was locked Pending This is for unilateral payments that are unclaimed This payment was sent via Mass Payment For Mass Payments the unique ID from input where x is the record number This allows the merchant to cross reference the payment Subscriptions Variables Along with other IPN variables the follo
61. reface 10 Typeface How Used monospaced Pathnames or file names that appear in body text frames Code related names that appear in body text frames Such names are used for functions callbacks arguments data structures and fields For example AbstractResponseType is the SOAP response type definition on which all PayPal API response methods are based Components of Internet protocol requests and responses such as HTTPS and FORM variables For example The PayPal system uses a method POST request to return IPN status variables related to subscriptions such as txn_type Serif bold User interface names such as window names or menu selections For example On the Profile page click Email to confirm your email address San serif Placeholders used in the context of a format or programming standard or formal oblique descriptions of PayPal system syntax Placeholders indicate values or names that the reader should provide Example For example amount is the variable for a single item shopping cart but amount_X is the name of the variable for a multi item shopping cart anount_3 is the item amount for the third item in a multiple item shopping cart To convey additional information this document may also apply color and underlining to words or phrases that use the typefaces described above Such use is described below Text attribute How Used XXXXXX Hypertext link to a page in the current document or to another document in t
62. t to complete a purchase they go through an alternate checkout and have the option to sign up afterward Customers who already have PayPal accounts will continue to enjoy the privileges of those accounts such as payment history and integration with eBay Auctions and their checkout experience will remain the same This PayPal Account Optional feature is available for Buy Now Donations and Shopping Cart buttons but not for Subscription buttons Order Management Integration Guide August 2005 19 20 Payment Data Transfer PDT Notification Synch PayPal Account Optional is enabled by default If the merchant has turned on Payment Data Transfer and has not disabled PayPal Account Optional a new user will not be automatically directed back to the merchant website but will be given the option to return When the buyer clicks Continue the transaction ID associated with the transaction is sent The merchant returns the transaction ID along with their identity token and PayPal then sends the merchant payment information that confirms that the payment is complete The buyer is directed back to the merchant site where the transaction information is displayed However if the buyer does not click Continue they will not be directed back to the merchant s site and PDT will not be initiated PDT Notification Synch After you have activated PDT every time a buyer makes a website payment and is redirected to your return URL a transaction token is
63. then URL decoded Example successful response SUCCESS first_name Jane Doe last_name Smith payment_status Completed payer_email Janedoesmith 40hotmail com payment_gross 3 99 mc_currency USD custom For the purchaset toftthetraretbook GreentEggs 26 Ham If the response is FAIL PayPal recommends making sure that e The Transaction token is not bad e The ID token is not bad e The tokens have not expired PDT and Auto Return Messaging to Buyer When Auto Return you must display a message on the page displayed by the Return URL that helps the buyer understand that the payment has been made that the transaction has been completed and that payment transaction details will be emailed to the buyer You can display to your customer whatever payment details you feel are appropriate however PayPal recommends including the following e Item name e Amount paid e Payer email e Shipping address If you are using PDT to determine when to fulfill an order automatically confirm that the payment_status is Completed since the buyer could use methods such as echecks that do not immediately clear For a list of PDT variables see Appendix A IPN and PDT Variables Order Management Integration Guide August 2005 21 a Payment Data Transfer Preventing Fraud Preventing Fraud In order to prevent fraud PayPal recommends that your programs verify the following e txn_idis not a duplicate to prevent so
64. troduction PayPal Supported Currencies 14 August 2005 Order Management Integration Guide Payment Data Transfer Payment Data Transfer PDT provides merchants with the ability to display transaction details to buyers who are redirected back to their site upon payment completion Norte You must enable Auto Return for Website Payments to use Payment Data Transfer Auto Return brings your buyers back to your website immediately after payment completion Auto Return applies to PayPal Website Payments including Buy Now Donations Subscriptions and Shopping Cart For more information about Auto Return see the PayPal Website Payments Standard Integration Guide How PDT Works Bob is going to purchase a widget from the Widget Warehouse Step 1 Bob goes to the Widget Warehouse website finds the widget he wants and clicks Buy Now z F wa eines me Globe P Indushies af Wi Wid dget FNE wa eee E Wooden Widgets id Rubusrivtoste Widget 019983763 Aluminum Widgets The surprisingly compact Widget 019983763 Is a powerful Steel Widgets no compromise solution for Outdoor Widgets widget professionals who are Indoor Widgets Ha Ct ily bey road and frei TS the office but who never want to be Auinmagiva Widgets without the speed and power of Plastic Widgets an automotive widget It slices dices and it will even make bread Titanium Widgets x Sale Price 142 50 Global Industries Inc All rights reserved
65. uide Downloadable History Log Columns and Values EN TABLE B 1 Downloadable History Log Columns and Values Column Heading Status Subject Currency Gross Fee Net Note From Email Address Description Status of transaction at time of download Canceled Cleared Completed Denied Expired Failed Pending Refunded Returned Reversed Unclaimed Uncleared Subject of transaction as entered by counterparty Currency of transaction Gross amount of transaction Fee if applicable for transaction Net amount of transaction Note for transaction as entered by counterparty Email address of transaction sender Format alphanumeric 10 character limit alphanumeric 256 character limit alphanumeric three character limit signed decimal signed decimal signed decimal alphanumeric 2000 character limit alphanumeric 128 character limit Payment Button Variable currency_ code amount Related IPN Variable payment_stat us pending_reas on me_currency settle_ currency exchange_ rate mc_gross payment_ gross settle_ amount amount 1 amount 2 amount 3 payment_fee mc_fee payer_email Order Management Integration Guide August 2005 61 a Downloadable History Log Columns and Values TABLE B 1 Downloadable History Log Columns and Values Column Heading To Email Address Transaction ID Payment Type Counterparty Status
66. us Confirmed vs Unconfirmed Sales Tax Other Fields Subject FP Note Subscription Number FP Payment Type Save Cancel 5 A list of items appears This is where you can select your preferences to customize your Downloadable History Log 6 After modifying your selections click Save Order Management Integration Guide August 2005 35 a Downloadable History Log Downloading Your History Downloading Your History Follow the instructions below to download your transaction history 1 Log in to your PayPal account 2 Click the History subtab under the My Account tab 3 Click the Download My History link in the Reporting Tools box FIGURE 4 3 Download History Page Overview AddFunds Withdraw History Resolution Center Profile Download History Secure Transaction 3 Select your options below Customize My History Download From py po J foa T for pe z f2005 view Changes to Download History Month Day Year Month Day Year Download File Types Comma delimited file for use in any spreadsheet application All Activity Completed Payments Only Tab delimited file all Activity Completed Payments Only C Quicken C QuickBooks T Include shopping cart detail comma and tab delimited files only Learn More I Ignore previously downloaded transactions and transactions older than 30 days Download History 4 On the next page specify the date range You can check one of the boxes bel
67. wing variables are included in Subscriptions IPNs TABLE A 7 Subscriptions Variables Possible Character Variable Values Description Limit txn_type subscr subscr_signup subscription sign up failed subscr_cancel subscription cancellation subscr subscr_failed subscription payment failure cancel subscr_payment subscription payment subscr subscr_eot subscription s end of term payment subscr_modify subscription modification subscr signup subscr eot subscr modify subscr_date Start date or cancellation date depending on whether transaction is subscr_signup or subscr_cancel August 2005 49 50 IPN and PDT Variables Subscriptions Variables TABLE A 7 Subscriptions Variables Variable subscr_ effective periodl period2 period3 amount 1 amount 2 amount 3 mc_amount 1 mc_amount2 mc_amount3 mc_currency See table of recurring reattempt retry_at recur_times Possible Values supported currencies Character Description Limit Date when the subscription modification will be effective only for txn_type subscr_modi fy optional Trial subscription interval in days weeks months years example a 4 day interval is period1 4 D optional Trial subseription interval in days weeks months or years Regular subscription interval in days weeks months or years Amount of payment for trial period 1 for USD payments otherw
68. yment_fee X Buyer Information first_name X X X X X X X last_name X X X X X X X payer_business X X X X X X _name address_name X X X X X X address_street X X X X X X address_city X X X X X X address_state X X X X X X address_zip X X X X X X address_ X X X X X X country payer_email X X X X X X X payer_id X X X X X X X payer_status X X X X X X X payment_type X X Subscription Information subscr_date X X X subscr_ X effective periodi X X X August 2005 53 54 IPN and PDT Variables Dispute Notification Variables TABLE A 8 PN Variables with Each Subscription Event Variable Signup period2 X period3 X amount1 X amount 2 X amount 3 x mc_amount1 X mc_amount2 X recurring X reattempt X retry_at recur_times X username X password X subscr_id X Cancel X X X Payment Multi Payment Currency Modify USD Failed EOT X x x x x x x x x x x x x x x x x X X X X X X x x x Dispute Notification Variables Variables related to customer dispute cases are detailed in Table A 9 Dispute Notification Variables on page 54 TABLE A 9 Dispute Notification Variables Variable txn_type txn_id Possible Values new_case Description A new case has been registered The merchant s original transaction identification number for the payment from the buyer against which the case was registered August 2005 IPN and PDT Variables EN Dispute Notification Variables

PayPal Order Management - 2005 Integration Guide

Contents

Download Pdf Manuals

Related Search

Related Contents