Home |Purchase|Contact|Documentation |Code Example|Demo

PayKit – Online Documentation

PayKit Installation Instructions:

1. Place files in the same directory on your webserver.
2. Open index.php in your web browser and follow installation instructions on the screen.
3. Complete the Sample Form to test your configuration.

PayKit maintains TWO sets of information. One set of information is stored directly in PayPal’s PayFlow Pro. The PP_PayFlow.class.php contains methods that maintain data in PayPal’s PayFlow Pro.A similar set of information is stored in local tables assumed to be in a MySQL database. Note that PayKit DOES NOT store credit card numbers in these local tables. The PP_PayFlowProfile.class.php contains methods that maintain data in these local tables.
Use local tables to avoid network traffic when performing simple lookups and viewing historic data.

TO CREATE A SUBSCRIPTION, use:
1. recurringTransaction in PP_PayFlow.class.php to create a subscription
2. recordProfile in PP_PayFlowProfile.class.php to create a local profile
3. fetchPaymentHistory in PP_PayFlow.class.php to check if payment was successful
4. recordProfileMisc in PP_PayFlowProfile.class.php to activate the local profile if payment was successful

TO MODIFY A SUBSCRIPTION, use:
1. modifyProfile in PP_PayFlow.class.php to change the subscription in PayPal
2. updateProfile in PP_PayFlowProfile.class.php to change the local profile

TO PROCESS ADJUSTMENTS or MANUAL PAYMENTS, use:
1. doPayment in PP_PayFlow.class.php to accept the payment
2. recordPayment in PP_PayFlowProfile.class.php to note the payment in the local profile

TO DISCONTINUE A SUBSCRIPTION, use:
1. deactivateProfile in PP_PayFlowProfile.class.php to deactivate subscription in local tables
2. deactivateProfile in PP_PayFlow.class.php to deactivate subscription in PayPal

DISCOUNTS, PROMOTION CODES and TRIAL PERIODS are supported but not yet documented.

Xeologic, Inc. © 2008-2010 - All Rights Reserved