The Credit Card module in Penelope allows your agency to process credit card payments using PayPal, Worldpay, SecurePay or Barclaycard. PayPal and Worldpay are both providers of secure payment processing services to businesses around the world (Barclaycard is limited to the UK and SecurePay is limited to Australia at present). Before signing up with your preferred supplier, please confirm that they provide services in your country.
NOTE: SecurePay integration with Penelope requires SecureFrame.
To set up the Credit Card module in Penelope you will need to be logged in with a System Administrator account. By following the instructions in the configuration guide you can easily configure Penelope to process credit card payments.
Getting started
In this section:
About the Credit Card module
The Credit Card Integration Module is an optional module within Penelope that supports credit card payment processing using either Payflow/PayPal, World Pay, SecurePay or Barclaycard.
Both World Pay and SecurePay are providers of secure payment processing services to businesses around the world (if you are considering using this module, please make sure to check first with World Pay and/or SecurePay to ensure that they provide services in your country) while Barclaycard is specific to the UK.
You can set up an integration between Penelope and one of these providers to process credit card payments securely online from within the application. The setup is easy and requires no change to the physical server where Penelope resides.
You just need to be logged in as a Penelope System Administrator to set the parameters needed for the day-to-day operations of credit card transactions. In version 4.8.2.0 and higher of Penelope, you have the ability to process refunds for historical Credit Card Gateways though only one account can be active for processing payments at a time.
Your active Gateway account is labelled as Current Gateway Account while previously configured accounts are shown as Historical Gateway Account.
Note: The display of historical Gateway Accounts is limited to the Gateway Account(s) added after upgrading to v4.8.2.0 or higher. If you previously processed payments under a different Gateway Account but changed providers prior to v4.8.2.0, those payments are still ineligible for refunds to their respective gateway account.
Configure the Credit Card module
Quick Navigation:
Before you begin:
1. For a much more detailed explanation and guide to credit card payment processing in Penelope, please download our Penelope Credit Card Processing document here: https://penelopehelp.files.wordpress.com/2013/10/penelope_credit_card_processing_setup.pdf. This document is more technical in nature is written with your IT team in mind.
2. We recommend that you log into your chosen Credit Card provider web portal before setting up the account in Penelope to process any password change prompts that may be required the first time you log into your account.
3. The “Change password” boxes referenced in several of the tasks below only change the password in the configuration in Penelope. They do not change the actual passwords in your Payflow/PayPal/World Pay/Secure Pay/Barclaycard accounts.
4. If your password(s) are changed on your Payflow/PayPal/World Pay/Secure Pay/Barclaycard accounts, you must also change them in the Penelope configuration above for the Credit Card processing to continue connecting to your account and processing payments.
Step 1: Create an account with either Payflow/PayPal, World Pay, SecurePay or Barclaycard Prior to configuring the Credit Card module, you must set up a Merchant Account with either Payflow/PayPal, World Pay, SecurePay, or Barclaycard directly.
Step 2: Enable the Credit Card module
Prerequisite: You must be logged in to Penelope using a System Administrator account.
1. In the System Setup section, click Credit Card Setup.
2. On the Credit Card Setup page, click Edit.
3. Click the Use Credit Card Interface option.
4. Click Save.
Step 3: Add a Gateway Account
Step 3 must be repeated if you are using Penelope and ClientConnect to process client payments e.g. you must add a Payment Method for both Penelope and ClientConnect even if they use the same payment gateway.
1. On the Credit Card Setup page, click Add Gateway Account.
2. From the Select Gateway drop-down, choose your Gateway provider (Payflow/PayPal, World Pay, Secure Pay or Barclaycard).
3. Select a Payment Method of Penelope or ClientConnect.
4. Select a Usage Mode of Pre-production
Note: We highly recommend choosing Pre-production to test your settings as this mode does not process real payments. Production should be reserved for processing and applying real payments. We also strongly recommended using a Sandbox installation of Penelope to perform pre-production (test) transactions.
If you do not have a sandbox and want to start credit card integration, it is strongly recommended to remove all test client transactions before switching the usage mode to Production.
5. In the Currency field, type the base currency that is understood to be the unit of transaction between Penelope and the Credit Card Provider. Acceptable values are ISO 4217 compliant codes. Refer to http://www.iso.org/iso/home/standards/currency_codes.htm for the complete list. Common values include:
• American Dollar = USD
• Australian Dollar = AUD
• Great Britain Pound = GBP
• Canadian Dollar = CAD
• New Zealand Dollar = NZD 6. Leave remaining fields blank.
6. Click Save. Continue on to Steps 3a, b c or d depending on which Gateway provider you’re using.
Step 3a: Configure Payflow/PayPal
If you chose the Payflow/PayPal integration, complete the following steps:
1. On the Credit Card Setup page, in the Payflow/Paypal section, click Edit.
2. Complete the following fields:
3. Click Save.
Step 3b: Configure World Pay
If you chose the World Pay integration, complete the following steps:
1. On the Credit Card Setup page, in the World Pay section, click Edit.
2. Complete the following fields:
Field Instructions
3. Click Save.
Step 3c: Configure Secure Pay
If you chose the Secure Pay integration, complete the following steps:
1. On the Credit Card Setup page, in the Secure Pay section, click Edit.
2. Complete the following fields:
3. Click Save.
Step 3d: Configure Barclaycard
If you will be using the Barclaycard integration, there are additional configuration steps that must take place in your Barclaycard account.
1. On the Credit Card Setup page, in the Barclaycard section, click Edit.
2. Complete the following fields:
3. Click Save. Note: You will need to copy the SHA-IN, SHA-OUT, API UserID, API Password, and Direct HTTP server-to-server request URL fields into your Barclaycard account and configure additional settings to complete the set up.
4. Log in to your Barclaycard online portal using your PSPID and Password.
5. Navigate to Configuration > Payment methods.
6. Ensure that the desired payment method has been configured. If not, on the Choose new payment methods tab, add a payment method following the direction on screen.
Note: Ensure that the currency type you select matches the currency you configured in Step 2: Enable the Credit Card module in Penelope.
7. Navigate to Configuration > Account > Currency.
8. Ensure that the currency type matches the currency you configured in Step 2: Enable the Credit Card module in Penelope. If not, complete the instructions on screen to submit a support ticket to Barclaycard.
9. Navigate to Configuration > Users.
10. Click New User and configure the following options:
11. Click Create.
12. On the Change password page, complete the following fields
13. Click Submit.
14. Navigate to Configuration > Technical Information > Global transaction parameters, configure the following options:
15. Click Save.
16. Navigate to Configuration > Technical Information > Global security parameters.
17. In the Hashing method section, configure the following options:
18. Navigate to Configuration > Technical Information > Data and origin verification tab. 19. In the Checks for e-Commerce section, in the SHA-IN pass phrase field, paste the SHA-IN pass phrase that you generated in Penelope in Step 2.
20. In the Checks for Barclaycard Direct Link section, in the SHA-IN pass phrase field, paste the SHA-IN pass phrase that you generated in Penelope in Step 2.
21. Click Save.
22. Navigate to Configuration > Technical Information > Transaction feedback.
23. In the Direct HTTP server-to-server section, complete the following fields:
24. In the Dynamic parameters section, under General, click the I would like Barclaycard to display a "processing" message to the customer during payment processing option.
25. In the Security for request parameters section, in the SHA-OUT pass phrase field, paste the SHA-OUT pass phrase that you generated in Penelope in Step 2.
26. In the HTTP request for status changes section, for the Timing of the request option, select No request.
27. Click Save.
Step 4: Configure the Credit Card Interface receipt reason
When the Credit Card module is enabled, a new system-generated Receipt Reason called “Credit Card Interface” is available. This Receipt Reason entry can be modified to default to a Deposit Type (you can use an existing Deposit Type or create a new one based upon your implementation needs). All new/future credit card payments will default to the appropriate deposit type based on the Site selected.
Prerequisite: You must be logged in to Penelope using a System Administrator account.
1. In the System Setup section, click Billing.
2. On the Settings tab, in the Receipt Reasons section, click Credit Card Interface.
3. If desired, in the Name field, modify the name of the Credit Card Interface Receipt Reason.
4. To enable this Receipt Reason, click the Active option.
5. From the Deposit Type drop-down, choose the type of deposit you want to use.
6. Click Save.
Step 5: Set up a bank account
We recommend creating a new Bank Account that will represent the credit card merchant account so that all credit card deposits will go through this account.
Prerequisite: You must be logged in to Penelope using a System Administrator account.
1. In the System Setup section, click Billing.
2. On the Setting tab, in the Bank Accounts section, click Add.
3. In the Account Name filed, type a name for the account.
4. In the Account No. field, type the bank account number.
5. Click Save.
6. On the Account page, in the Sites section, click Edit.
7. In the first column, select which Sites the bank account is applicable to.
8. In the Default column, select if the bank account should be the default account for the adjacent Site.
9. Click Save.
Step 6: Test the Credit Card module integration
Note: We strongly recommended using a Sandbox installation of Penelope to perform pre-production (test) transactions.
If you do not have a sandbox and want to start credit card integration, it is strongly recommended to remove all test client transactions before switching the usage mode to Production. To test the credit card module integration:
1. Create a test Service Event with one or more cart items that bill to the client (FFS Individual).
2. Set the attendance for the Service Event to “Show”.
3. Using either Quick Pay or Record/Add Payment, process a payment using the Credit Card module. For more information about processing a payment, see the following tutorials: https://intercom.help/ssgpenelope/en/articles/5156783-credit-card-module-requirements
Step 7: Enable production mode
Once you have confirmed that the test payment was successful, you can create your Production account for your Gateway provider.
Please note that it is not possible to modify the Usage Mode setting from Pre-Production to Production; instead, you will want to add a new Gateway Account choosing Production mode instead. This mechanism exists to allow you to continue to process refunds under previously in use Credit Card Gateways.
Prerequisite: You must be logged in to Penelope using a System Administrator account. Please refer to Step 3 for full details on adding a new Gateway Account.
1. In the System Setup section, click Credit Card Setup.
2. On the Credit Card Setup page, click Add Gateway Account.
3. From the Select Gateway drop-down, choose your Gateway provider (World Pay, Secure Pay or Barclaycard).
4. Select a Usage Mode of Production
5. In the Currency field, type the base currency that is understood to be the unit of transaction between Penelope and the Credit Card Provider. Acceptable values are ISO 4217 compliant codes. Refer to http://www.iso.org/iso/home/standards/currency_codes.htm for the complete list. Common values include:
a. American Dollar = USD
b. Australian Dollar = AUD
c. Great Britain Pound = GBP
d. Canadian Dollar = CAD
e. New Zealand Dollar = NZD
Continue on to Steps 3a, b, or c of this guide to continue configuring your Gateway information.
Manually Reconcile Payments to Penelope
To enhance security during payment transactions, there is a 30-minute time limit for which each Penelope Credit Card Token for a given payment transaction is active.
This means that if the payment process took too long or if the Internet connection was dropped during the process, there may be an out-of-sync situation where the payment has been recorded in the Credit Card Provider but not in Penelope.
To reconcile this process, you will need to:
1. Activate the “Credit Card Interface” receipt reason on the Billing Setup > Settings tab if you have not already done so.
2. When adding a payment against the Individual in question (be sure to pick the correct Individual as there is no way Penelope can help you verify it is the correct Individual for which the payment was made), select “Process other types of payment” and manually select the “Credit Card Interface” as payment reason.
3. Two new boxes (“Penelope Credit Card Token” and “External Transaction Number”) will appear. Carefully match them up from what is displayed on the Merchant Online Login, and copy those values into Penelope. Also copy the dollar amount of the payment transaction. This will manually add the credit card payment record in Penelope and you can proceed to apply/refund if necessary.