Class ActiveMerchant::Billing::LinkpointGateway
In: lib/active_merchant/billing/gateways/linkpoint.rb
Parent: Gateway

Initialization Options :login Your store number :pem The text of your linkpoint PEM file. Note

                      this is not the path to file, but its
                      contents. If you are only using one PEM
                      file on your site you can declare it
                      globally and then you won't need to
                      include this option

A valid store number is required. Unfortunately, with LinkPoint YOU CAN‘T JUST USE ANY OLD STORE NUMBER. Also, you can‘t just generate your own PEM file. You‘ll need to use a special PEM file provided by LinkPoint.

Go to www.linkpoint.com/support/sup_teststore.asp to set up a test account and obtain your PEM file.

Declaring PEM file Globally ActiveMerchant::Billing::LinkpointGateway.pem_file = File.read( File.dirname(FILE) + ’/../mycert.pem’ )

Valid Order Options :result =>

  LIVE                  Production mode
  GOOD                  Approved response in test mode
  DECLINE               Declined response in test mode
  DUPLICATE             Duplicate response in test mode

:ponumber Order number

:transactionorigin => Source of the transaction

   ECI                  Email or Internet
   MAIL                 Mail order
   MOTO                 Mail order/Telephone
   TELEPHONE            Telephone
   RETAIL               Face-to-face

:ordertype =>

   SALE                 Real live sale
   PREAUTH              Authorize only
   POSTAUTH             Forced Ticket or Ticket Only transaction
   VOID
   CREDIT
   CALCSHIPPING         For shipping charges calculations
   CALCTAX              For sales tax calculations

Recurring Options :action =>

   SUBMIT
   MODIFY
   CANCEL

:installments Identifies how many recurring payments to charge the customer :startdate Date to begin charging the recurring payments. Format: YYYYMMDD or "immediate" :periodicity =>

    MONTHLY
    BIMONTHLY
    WEEKLY
    BIWEEKLY
    YEARLY
    DAILY

:threshold Tells how many times to retry the transaction (if it fails) before contacting the merchant. :comments Uh… comments

For reference:

www.linkpointcentral.com/lpc/docs/Help/APIHelp/lpintguide.htm

 Entities = {
   :payment => [:subtotal, :tax, :vattax, :shipping, :chargetotal],
   :billing => [:name, :address1, :address2, :city, :state, :zip, :country, :email, :phone, :fax, :addrnum],
   :shipping => [:name, :address1, :address2, :city, :state, :zip, :country, :weight, :items, :carrier, :total],
   :creditcard => [:cardnumber, :cardexpmonth, :cardexpyear, :cvmvalue, :track],
   :telecheck => [:routing, :account, :checknumber, :bankname, :bankstate, :dl, :dlstate, :void, :accounttype, :ssn],
   :transactiondetails => [:transactionorigin, :oid, :ponumber, :taxexempt, :terminaltype, :ip, :reference_number, :recurring, :tdate],
   :periodic => [:action, :installments, :threshold, :startdate, :periodicity, :comments],
   :notes => [:comments, :referred]
 }

IMPORTANT NOTICE:

LinkPoint‘s Items entity is not yet supported in this module.

Methods

authorize   capture   credit   new   purchase   recurring   test?   void  

Constants

TEST_URL = 'https://staging.linkpt.net:1129/'
LIVE_URL = 'https://secure.linkpt.net:1129/'

Public Class methods

Public Instance methods

Authorize the transaction

Reserves the funds on the customer‘s credit card, but does not charge the card.

Post an authorization.

Captures the funds from an authorized transaction. Order_id must be a valid order id from a prior authorized transaction.

Refund an order

identification must be a valid order id previously submitted by SALE

Send a purchase request with periodic options Recurring Options :action =>

   SUBMIT
   MODIFY
   CANCEL

:installments Identifies how many recurring payments to charge the customer :startdate Date to begin charging the recurring payments. Format: YYYYMMDD or "immediate" :periodicity =>

    :monthly
    :bimonthly
    :weekly
    :biweekly
    :yearly
    :daily

:threshold Tells how many times to retry the transaction (if it fails) before contacting the merchant. :comments Uh… comments

Void a previous transaction

[Validate]