Skip to content

Latest commit

 

History

History
198 lines (148 loc) · 6.47 KB

README.md

File metadata and controls

198 lines (148 loc) · 6.47 KB
Raw

Omnipay: Novalnet

Novalnet gateway for the Omnipay PHP payment processing library

Build Status Latest Stable Version Total Downloads

Omnipay is a framework agnostic, multi-gateway payment processing library for PHP 5.3+. This package implements Novalnet support for Omnipay.

Installation

Omnipay is installed via Composer. To install, simply require this package with:

composer require fruitcake/omnipay-novalnet

Basic Usage

The following gateways are provided by this package:

  • Novalnet_Redirect
  • Novalnet_Xml

For general usage instructions, please see the main Omnipay repository. You can also check out to the documentation provided by Novalnet.

For common but obscure errors check out these errors. If you find more errors like these, please create a PR to help the others out.

Example

use Omnipay\Novalnet\RedirectGateway;

/*
 * 1. Create the gateway
 */
$gateway = new RedirectGateway();
//$gateway = new XmlGateway(); // For XML

$gateway->setVendorId($vendorId);
$gateway->setVendorAuthcode($vendorAuthcode);
$gateway->setProductId($productId);
$gateway->setTariffId($tariffId);

/*
 * 1. Set payment method
 */

// For Redirect Gateway
# $gateway->setPaymentMethod(RedirectGateway::GIROPAY_METHOD);
# $gateway->setPaymentMethod(RedirectGateway::IDEAL_METHOD);
# $gateway->setPaymentMethod(RedirectGateway::ONLINE_TRANSFER_METHOD);
# $gateway->setPaymentMethod(RedirectGateway::EPS_METHOD);
# $gateway->setPaymentMethod(RedirectGateway::PAYPAL_METHOD);
# $gateway->setPaymentMethod(RedirectGateway::CREDITCARD_METHOD);

// To show the Novalnet screen with only the selected method:
//$gateway->setChosenOnly(true);

// For XML Gateway
# $gateway->setPaymentMethod(XmlGateway::CREDITCARD_METHOD);
# $gateway->setPaymentMethod(XmlGateway::DIRECT_DEBIT_SEPA);

/*
 * 3. Define the purchase parameters
 *
 * The easiest way to get a payment method working is starting
 * with zero parameters. Then start adding the parameters
 * which are noted as missed on sending the request.
 */
$params = [
    'amount' => 10.21,
    'currency' => 'EUR',
    'transactionId' => '12345678',
    'iban' => 'DE24300209002411761956',

    'notifyUrl' => 'http://example.com/notify',
    'returnUrl' => 'http://example.com/return',
    'cancelUrl' => 'http://example.com/cancel',
    'paymentKey' => $paymentKey,

    // client details
    'card' => [
        'firstName' => 'John',
        'lastName' => 'Doe',
        'address1' => 'Streetname 1', // note that the house number is included
        'postcode' => '1234AB',
        'city' => 'Amsterdam',
        'country' => 'NL',
        'email' => '[email protected]',
        'phone' => '+31612345678',
        'number' => '4200 0000 0000 0000',
        'expiryMonth' => date('m', strtotime('+1 month')),
        'expiryYear' => date('Y', strtotime('+1 month')),
        'cvv' => 123,
    ],
];

/*
 * 4. Initialize purchase
 */
if (!isset($_POST['tid'])) {

    /*
     * 4.1. Create the request
     */
    $request = $gateway->purchase($params);


    /*
     * 4.2. Receive the response
     */
    $response = $request->send();


    /*
     * 4.3. Handle the response appropriate
     */
    if ($response->isSuccessful()) {
        echo $response->getMessage();
    } elseif ($response->isRedirect()) {
        // redirect to offsite payment gateway
        $response->redirect();
    } else {
        // payment failed: display message to customer
        echo "Error " .$response->getCode() . ': ' . $response->getMessage();
    }
}

/*
 * 5. Handle success, error and/or notify request for Redirect Gateway
 */
if (isset($_POST['tid'])) {
    $response = $gateway->completePurchase($params)->send();
    if ($response->isSuccessful()) {
        echo 'Success [code: '. $response->getStatus() . ']';
    } else {
        echo 'Failed [code: '. $response->getStatus() . ']';
    }
    die();
}

Available Payment Methods

Xml Gateway

  • CREDITCARD
  • DIRECT_DEBIT_SEPA

Redirect Gateway

  • 33 - Online Transfer Sofort
  • 49 - Online Transfer iDEAL
  • 69 - Online bank transfer (giropay)
  • 34 - PayPal
  • 50 - eps
  • 6 - Creditcard

Payment form/page hosted on Novalnet Server

When one of the above payment methods is set (excluding nr. 99), you can also set the chosenOnly property.

When true, the user will be redirected to Novalnet’s payment portal. There they can complete their personal details and finish the payment. This can be usefull if you don’t want to handle the user’s credit card details for example.

Code:

    $gateway->setPaymentMethod(Gateway::CREDITCARD_METHOD);
    $gateway->setChosenOnly(true);

Example url with chosen only property: https://payport.novalnet.de/nn/paygate.jsp?vendor=4&product=14&tariff=30&amount=522&lang=en&key=6&chosen_only=1

Example url using payment method 99: https://payport.novalnet.de/nn/paygate.jsp?vendor=4&product=14&tariff=30&amount=522&lang=en

Note: For payment method 99 as well as the chosenOnly property you can still include the user’s data in the parameters. This allows Novalnet to autofill the form with the matching fields.

Confidential information such as credit card details should not be sent nor be asked when using these settings.

Support

If you are having general issues with Omnipay, we suggest posting on Stack Overflow. Be sure to add the omnipay tag so it can be easily found.

If you want to keep up to date with release anouncements, discuss ideas for the project, or ask more detailed questions, there is also a mailing list which you can subscribe to.

If you believe you have found a bug, please report it using the GitHub issue tracker, or better yet, fork the library and submit a pull request.