Skip to content

Latest commit

 

History

History
130 lines (88 loc) · 4.57 KB

README.md

File metadata and controls

130 lines (88 loc) · 4.57 KB
Raw

Omnipay: Total Apps Gateway

Total Apps Gateway gateway for the Omnipay PHP payment processing library

Omnipay is a framework agnostic, multi-gateway payment processing library for PHP 7.2+. This package implements Total Apps Gateway support for Omnipay.

Install

Via Composer

$ composer require league/omnipay:^3 knightar/omnipay-total-apps-gateway

Usage

The following gateways are provided by this package:

  • Total Apps Gateway

####This driver supports Omnipay v3. To use the outdated v2 package see the v.0.1.0 release.

For general usage instructions, please see the main 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:

    $gateway = Omnipay::create('TotalAppsGateway');
    $gateway->setApiKey('6457Thfj624V5r7WUwc5v6a68Zsd6YEm');

purchase example

    $formData = array('number' => '4111111111111111', 'expiryMonth' => '10', 'expiryYear' => '2025', 'cvv' => '123');
    $gateway->purchase([
        'amount' => '10.00',
        'card'   => $formData
    ]);

Driver also supports paying using store cards in the customer vault using cardReference instead of card, use the vault functions with the cardReference parameter.

This driver also supports storing customer data in Total Apps Gateway's customer vault:

  • createCard($options) - Create an entry in the customer vault
  • updateCard($options) - Update an entry in the customer vault
  • deleteCard($options) - Delete an entry in a customer vault
    $formData = array('number' => '4111111111111111', 'expiryMonth' => '10', 'expiryYear' => '2025', 'cvv' => '123');
    
    $response = $gateway->createCard([
        'card'          => $formData
    ])->send();
    
    $cardReference = $response->getCardReference();

cardReference can be used to authorize, purchase, and refund requests:

    $gateway->purchase([
        'amount'        => '10.00',
        'cardReference' => '1234567890'
    ]);

This driver also support ACH related transactions using the \Omnipay\TotalAppsGateway\ACH class to validate ACH details, and createACH, updateACH methods in the Gateway. Your merchant account must have this approved and activated.

API Calls on the TODO list which will be implemented eventually:

  • 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):

  • 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 Total Apps Gateway if you need this functionality. Please note that this code is untested.

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.

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email jablonski.kce@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.