knightar/omnipay-mojopay

Mojopay driver for the Omnipay PHP payment processing library

Omnipay: Mojopay

Mojopay gateway for the Omnipay PHP payment processing library, _(*1)

, _(*2)

Omnipay is a framework agnostic, multi-gateway payment processing library for PHP 5.3+. This package implements Mojopay support for Omnipay., _(*3)

Install

Via Composer, _(*4)

``` bash $ composer require knightar/omnipay-mojopay, <sub>(*5)</sub>

## Usage

The following gateways are provided by this package:

 * Mojopay

For general usage instructions, please see the main [Omnipay](https://github.com/thephpleague/omnipay) repository.

This driver supports following transaction types:

- authorize($options) - authorize an amount on the customer's card
- capture($options) - capture an amount you have previously authorized
- purchase($options) - authorize and immediately capture an amount on the customer's card
- refund($options) - refund an already processed transaction
- void($options) - generally can only be called up to 24 hours after submitting a transaction

Gateway instantiation:
``` PHP
    $gateway = Omnipay::create('Mojopay');
    $gateway->setProcessorId('abcdefg1234567');
    $gateway->setToken('6ef44f261a4a1595cd377d3ca7b57b92');
    $gateway->setTestMode(true);

Driver also supports paying using store cards in the customer vault using cardReference instead of card, use the vault functions with the cardReference parameter., <sub>(*6)</sub>

This driver also supports storing customer data in Mojopay's customer vault:, <sub>(*7)</sub>

• createCard($options) - Create a entry in the customer vault
• updateCard($options) - Update an entry in the customer vault

• deleteCard($options) - Delete an entry in a customer vault ``` PHP $formData = array('number' => '4242424242424242', 'expiryMonth' => '8', 'expiryYear' => '2017', 'cvv' => '123');, <sub>(*8)</sub>

  $response = $gateway->createCard([ 'card' => $formData ])->send();, <sub>(*9)</sub>

  $cardReference = $response->getCardReference();, <sub>(*10)</sub>

- listCards - Listing customer vault records by criteria
``` PHP
    # Each criteria are optional, no criteria will return no records
    $response = $gateway->listCards([
        'cardReference' => '', # The hash to identify the customer in the vault
        'firstName'     => '', # Portion of cardholder's first name.
        'lastName'      => '', # Portion of cardholder's last name.
        'email'         => '', # Portion of billing email address.
        'last4cc'       => ''  # Last 4 digits of credit card number.
    ]);
    $response_rows = $response->getResponse();

cardReference can be used in the authorize, purchase, and refund requests: ``` PHP $gateway->purchase([ 'amount' => '10.00', 'cardReference' => '1234567890' ]);, <sub>(*11)</sub>

This driver also supports subscription management which can be accessed using:

- subscription_add($options) - Add a subscription
- subscription_delete($options) - Delete a subscription
``` PHP
    # As an example we will add a subscription the starts on 01/04/2017
    $gateway->subscription_add([
        'cardReference'          => '1234567890',
        'planId'                 => '1234567890',
        'subscriptionStartDay'   => '01',
        'subscriptionStartMonth' => '04',
        'subscriptionStartYear'  => '2017'
    ]);

API Calls on the TODO list which will be implemented eventually:, <sub>(*12)</sub>

• Adding, updating, removing, listing Recurring Plans
• Listing subscriptions by customer
• Add a Customer to the Vault while Initiating a Sale/Authorization/Credit/Validate Transaction

We currently have no plans to implement the following calls (Pull requests are accepted for those who wants to add them):, <sub>(*13)</sub>

• Adding a custom subscription - Does not return necessary subscription ID to cancel
• Adding a customer and subscription - Does not return necessary subscription ID to cancel

Note: Credit API call is implemented but is not enabled by default on merchant accounts, contact Mojopay if you need this functionality. Please note that this code is untested., <sub>(*14)</sub>

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., <sub>(*15)</sub>

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., <sub>(*16)</sub>

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., <sub>(*17)</sub>

Change log

Please see CHANGELOG for more information what has changed recently., <sub>(*18)</sub>

Testing

bash $ composer test, <sub>(*19)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*20)</sub>

Security

If you discover any security related issues, please email jablonski.kce@gmail.com instead of using the issue tracker., <sub>(*21)</sub>

Credits

• John Jablonski
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*22)</sub>