README

Payrix driver for the Omnipay PHP payment processing library

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

Installation

Omnipay is installed via Composer. To install, simply require league/omnipay and eventconnect/omnipay-payrix with Composer:

composer require league/omnipay eventconnect/omnipay-payrix

Basic Usage

$gateway = Omnipay::create('Payrix');
$gateway->setApiKey(API_KEY);
$gateway->setMerchantId(MERCHANT_ID);

$formData = [
    'number' => '4242424242424242',
    'expiryMonth' => '6',
    'expiryYear' => '2030',
    'cvv' => '123'
];
$response = $gateway->purchase([
    'amount' => '10.00',
    'currency' => 'CAD',
    'card' => $formData,
])->send();

if ($response->isSuccessful()) {
    // Payment was successful
} else {
    // Payment failed
}

For general usage instructions, please see the main Omnipay repository.

Limitations

Currently this package supports the following methods:

purchase

Test Mode

Operations can be run in test mode by enabling test mode:

$gateway->setTestMode(true);

Note: Test mode requires a test API key and Merchant ID.

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 announcements, 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.

TODO

Tests (!)
Support for additional Payrix functionality

eventconnect / omnipay-payrix

Maintainers

Details