viaKLIX(3pm)

💖 viaKLIX 💖

okay bestie, so Business::OnlinePayment::viaKLIX is literally the viaKLIX backend for Business::OnlinePayment and I'm obsessed 🫶 it's a Perl module (that's the 3pm in the name, iykyk) and she handles your payment vibes through viaKLIX's Internet payment solution. no cap.

---

✨ SYNOPSIS ✨

here's the whole main character moment, copied exactly so you can just paste and go:

use Business::OnlinePayment;

my $tx = new Business::OnlinePayment(
    'viaKLIX', 'default_ssl_user_id' => 'webuser',
);

# See the module documentation for details of content()
$tx->content(
    type           => 'CC',
    action         => 'Normal Authorization',
    description    => 'Business::OnlinePayment::viaKLIX test',
    amount         => '49.95',
    invoice_number => '100100',
    customer_id    => 'jef',
    name           => 'Jeff Finucane',
    address        => '123 Anystreet',
    city           => 'Anywhere',
    state          => 'GA',
    zip            => '30004',
    email          => 'viaklix@weasellips.com',
    card_number    => '4111111111111111',
    expiration     => '12/09',
    cvv2           => '123',
    order_number   => 'string',
);

$tx->submit();

if ( $tx->is_success() ) {
    print(
        "Card processed successfully: ", $tx->authorization, "\n",
        "order number: ",                $tx->order_number,  "\n",
        "CVV2 response: ",               $tx->cvv2_response, "\n",
        "AVS code: ",                    $tx->avs_code,      "\n",
    );
}
else {
    print(
        "Card was rejected: ", $tx->error_message, "\n",
        "order number: ",      $tx->order_number,  "\n",
    );
}

---

🌸 DESCRIPTION 🌸

so this module is a back end driver 💅 like, it implements the interface that Business::OnlinePayment specifies, so you can do your payment handling through viaKLIX's Internet payment solution. it's giving middle-man but make it iconic.

and if you wanna know the deets of the interface this module supports, go read Business::OnlinePayment. she's the blueprint, fr fr.

---

🎀 Standard methods 🎀

• set_defaults() — this one sets the 'server' attribute to 'www.viaklix.com' and the port attribute to '443'. oh and she also sets up the "Module specific methods" we're gonna talk about below. multitasking queen 👑
• submit() — (yes that's all it says, she's mysterious like that ✨)

---

🦋 Unofficial methods 🦋

these methods are not officially part of the standard Business::OnlinePayment interface (as of 3.00_06) BUT bestie, multiple gateway modules support them and they're expected to be standardized soon. so they're like the cool underground ones:

• order_number()
• avs_code()
• cvv2_response()

---

💜 Module specific methods 💜

and these ones are currently not part of the standard Business::OnlinePayment interface at all:

• expdate_mmyy()
• debug()

---

🌈 Settings 🌈

the following default settings exist, no cap:

• server — www.viaklix.com
• port — 443
• path — /process.asp

---

💫 Parameters passed to constructor 💫

okay so here's the vibe: if any of the key/value pairs you pass to the constructor have a key starting with "default_", then those values get passed to viaKLIX as the corresponding form field (without the "default_" part, obviously 💅) whenever content(%content) is missing that key. it's the backup plan, the safety net, the ride-or-die 🫶

---

🍓 Handling of content(%content) 🍓

the following rules apply to your content(%content) data:

🧚 type

if 'type' matches one of these keys, it gets replaced by the right hand side value:

'visa'               => 'CC',
'mastercard'         => 'CC',
'american express'   => 'CC',
'discover'           => 'CC',

and the value of 'type' is used to set transaction_type(). heads up though: currently this module only supports the above values. that's it, that's the list 🎀

---

👑 Setting viaKLIX parameters from content(%content) 👑

here's the mapping rules applied to get data into viaKLIX parameters:

# viaKLIX param     => $content{<key>}
  ssl_merchant_id   => 'login',
  ssl_pin           => 'password',

  ssl_amount        => 'amount',
  ssl_card_number   => 'card_number',
  ssl_exp_date      => \( $month.$year ), # MM/YY from 'expiration'
  ssl_cvv2          => 'present' whenever cvv2 data is provided
  ssl_cvv2cvc2      => 'cvv2',
  ssl_description   => 'description',
  ssl_invoice_number=> 'invoice_number',
  ssl_customer_code   => 'customer_id',

  ssl_first_name    => 'first_name',
  ssl_last_name     => 'last_name',
  ssl_avs_address   => 'address',
  ssl_city          => 'city',
  ssl_state         => 'state',
  ssl_zip           => \$zip,       # 'zip' with non-alphanumerics removed
  ssl_country       => 'country',
  ssl_phone         => 'phone',
  ssl_email         => 'email',

  CardHolderName    => 'name',
  CustomerName      => 'account_name',

---

💖 Mapping viaKLIX transaction responses to object methods 💖

these methods give you access to the transaction response data that comes back from a viaKLIX request (after submit() gets called, obviously):

🌟 order_number()

this method returns the ssl_txn_id field for card transactions, so you can uniquely identify the transaction. she's the ✨fingerprint✨ of your payment.

🌟 result_code()

returns the ssl_result field for card transactions. it's the numeric return code that tells you how the attempted transaction turned out.

🌟 error_message()

returns the ssl_result_message field for transactions. this one gives you more details about the transaction result, so when something goes sideways you actually know why 😭

🌟 authorization()

returns the ssl_approval_code field, which is the approval code obtained from the card processing network. the receipt moment 💅

🌟 avs_code()

returns the ssl_avs_response field from the transaction result.

🌟 cvv2_response()

returns the ssl_cvvw_response field, which is a response message returned with the transaction result.

🌟 expdate_mmyy()

this method takes a single scalar argument (typically the value in $content{expiration}) and tries to parse and format the date into MMYY format as required by PayflowPro specification. and if it can't parse the expiration date? she just leaves it as is and lets the PayflowPro system try to handle it as-is. not her problem, honestly 🙈

🌟 debug()

enable or disble debugging. (yes, that's how the original spells it, we keep it verbatim bestie 💀) the value you specify here will also set $Business::OnlinePayment::HTTPS::DEBUG in submit(), which helps you troubleshoot problems. detective mode 🔍

---

💀 COMPATIBILITY 💀

this module implements an interface to the viaKLIX API version 2.0. periodt.

---

🎀 AUTHORS 🎀

• Jeff Finucane <viaklix@weasellips.com>
• based on Business::OnlinePayment::PayflowPro written by Ivan Kohler and Phil Lobbes.

---

🦋 SEE ALSO 🦋

perl(1), Business::OnlinePayment, Carp, and the Developer Guide to the viaKLIX Virtual Terminal.

---

and that's the whole page bestie 💜 this is from perl v5.36.0, dated 2022-12-10, and it's the viaKLIX(3pm) page under User Contributed Perl Documentation — go slay those payments ✨🫶