Payment Modules

From FestOS wiki

Jump to: navigation, search
Payment modules config
Configuring payment modules
You configure payment modules from the FestOS Configuration, Payment modules page (see image at right). FestOS ships with four payment modules:
  • Pay by check
  • PayPal
  • Authorize.net
  • Offsite

To use any of these modules, you must click their Configure link, set the various options, and make sure to click the Enable option.

When applicants finish their application, they are presented with a payment screen. A "button" for each of the enabled payment modules is presented on that page. The order of those buttons matches their order in the Payment Modules Configuration page. Click the up and down triangles to re-order the payment modules (and thus their buttons).

Pay by check

You can use this module to enable applicants to pay registration and booth fees by check. It has no options to configure other than to enable or disable it. Applicants selecting this payment method will be shown your address and contact information (pulled from the lang.php file). The "invoice page" for this module is /addons/pay_check/pay.tpl. This module's button file is /addons/pay_check/button.php. Edit it to modify the appearance of the payment "button" shown to applicants.

Applicants choosing this payment method are marked as complete, but unpaid.

PayPal

PayPal config
Configuring the PayPal module

You will need a PayPal account to accept payment via the PayPal module.

  • PayPal ID — Your PayPal ID (which is your email address)
  • Invoice Text — The text you want shown to users on the PayPal payment page & bank statement
  • Currency Code — See PayPal's site for non-US dollar currencies
  • Taxable — (Yes or No)
  • Location Code — See PayPal's site for location codes outside of the USA.
  • Enabled: — (Yes or No) If set to No, this option will not be shown to applicants.
  • Test Mode: — (Yes or No) If set to Yes (in test mode), only $0.02 (two cents) will be charged. This is useful for testing to be sure everything is working. Make sure to set Test Mode = No before going live.

PayPal payments involve applicants leaving your site and paying at PayPal.com. In order for FestOS to "know" of the payment, PayPal must send transaction information back to your site. For this to work, you must configure IPN in your PayPal account.

  1. Log on to your PayPal account
  2. Click Profile
  3. Click Instant Payment Notification Preferences
  4. In the Return URL box, enter http://''your_web_site.com''/addons/pay_paypal/ipn.php (use the correct URL for your site)
  5. Click Save

This module's button file is /addons/pay_paypal/button.php. Edit it to modify the appearance of the payment "button" shown to applicants.

Authorize.net

Authorize.net config
Configuring the Authorize.net module

You can accept credit cards on your site by using the Authorize.net payment module. To accept credit card payments, you will need the following requirements:

  • A merchant account from your bank or other provider.
  • An Authorize.net gateway account from your merchant account provider.
  • An SSL certificate.
  • Secure web site hosting (with https:// address support)

(These components are not included with FestOS or this payment module. Skypanther Studios can help with each of these needs. Contact us for more information.)

Configure these values in FestOS

  • API ID — Your Authorize.net API ID (retrieve from your control panel). This is not your user ID nor your password for your Authorize.net control panel account.
  • Transaction ID — Your Authorize.net transaction ID (retrieve from your control panel).
  • Delimiter — Leave set to the vertical bar (|) unless your Authorize.net account is configured to use a different field delimiter.
  • Transaction Email — (Optional) Your email address or another to which a copy of the payment notice will be emailed. You can also set this sort of option in your Authorize.net control panel.
  • Invoice Text — The text that appears on a payer's credit card statement
  • Enabled: — (Yes/No)
  • Test Mode: — (Yes/No) If set to Yes (in test mode), no payments will actually be made. Your site and Authorize.net will communicate in test mode and while all the payment communications will proceed as normal, ultimately the credit card won't be charged. Make sure this is set to No for a live site.

(For testing, you might find the fake credit card numbers at http://www.darkcoding.net/credit-card-numbers/ useful.)

Offsite

Offiste module config
Configuring the Offsite payment module
This module was developed to meet one client's needs and will require extra work on your part. It will re-direct applicants to a different site where they can pay. That custom-client has two sites: one for their festival and another for the organization that manages the festival. On their organization's site, they have the necessary SSL certificate, secure hosting, and credit-card processing account. Rather than purchase duplicate such accounts, the FestOS Offsite payment module directs applicants from their festival web site to a special page on their organization's web site. On that page, custom code pulls needed info from the FestOS database and then provides the payment form.

You might be able to use this module to do the same sort of thing.

  • Invoice Text — Used within message body
  • Offsite URL — The URL to which applicants will be sent
  • Send email — (Yes/No) Send an email message containing the payment URL? Or, show message & URL in the browser.
  • Email subject — Subject line of the email message
  • Include applicant's ID — (Yes/No) Include the applicant's unique ID number in the URL (see next option).
  • Variable name — Query string variable name to hold the applicant's ID.
  • Message — The body of the email message, if one is sent. The text shown on the page if you don't send the email is in the addons/pay_offsite/pay.tpl file
  • Enabled — (Yes/No)
  • Test Mode — (Yes/No)

Further Information

Main FestOS Page : Installation : Customization  : Configuration : Administration : Payment Modules

Personal tools