Freeside:3:Documentation:Administration:Real-time Processing

From Freeside
Jump to: navigation, search

Introduction

Freeside uses Business::OnlinePayment to process payments in real-time. See the Business::OnlinePayment homepage for supported processors. There is also an IPPay-specific version of these instructions.

Configuring Real-Time Processing

Install gateway module

  • Install a real-time processing module, such as Business::OnlinePayment::TCLink, or Business::OnlinePayment::Exact

Debian:

 root# aptitude install libbusiness-onlinepayment-gatewayname-perl

Other OSes:

 root# cpan Business::OnlinePayment::GatewayName

Configure billing events

  • Remove the Batch Card processing event(s), if any:
    • Configuration -> Billing -> View/Edit Billing Events
    • Click on "Batch card"
    • Check off "Disabled"
    • Click "Apply changes"
  • Add an event for realtime processing:
    • Configuration -> Billing -> View/Edit Billing Events
    • Click on "Add a new invoice event"
    • Choose Type "Invoice"
    • Scroll down to the "Event action" dropdown at the bottom, and select "Run card with a Business::OnlinePayment realtime gateway"
    • Click on "Add billing event definition" at the bottom of the form.

Configure the payment gateway

  • Configuration -> Settings
  • Click the "Billing" tab
  • Scroll down and click on the "business-onlinepayment" configuration option.
  • In the text box, enter the Business::OnlinePayment module you are using, followed by your account ID, password, and (optionally), type of action
 TCLink
 someuser
 password
 Normal Authorization
  • Some payment gateways such as LinkPoint don't use a username/password, and require additional parameters. These can be passed in as key<newline>value pairs
 LinkPoint
               <-- intentionally left blank 
               <-- intentionally left blank 
 Normal Authorization
 storename     <-- key
 123456        <-- value
 keyfile       <-- key
 123456.pem    <-- value
 lbin          <-- key
 /usr/bin.lbin <-- value
 tmp
 /tmp/secure
  • Click "Apply Changes"

Testing Real-Time Processing

One Time Transactions

  • Choose a customer account
  • Click on 'Process credit card payment'
  • Enter a payment ammount, and credit card details
  • Click 'Process payment'
  • The transaction should happen immediately
  • Click on 'View this customer'
  • At the bottom of the screen, "Payment History" should include this transaction

Recurring Transactions

  • Choose a customer account
  • Click on 'Bill now', or run the freeside-daily cronjob from the command line as the freeside user
  • At the bottom of the screen, "Payment History" should include this transaction

References