2017 © Pedro Peláez
 

library omnipay-tithely

Tithe.ly driver for the Omnipay payment processing library

image

elvanto/omnipay-tithely

Tithe.ly driver for the Omnipay payment processing library

  • Thursday, August 31, 2017
  • by bensinclair
  • Repository
  • 3 Watchers
  • 0 Stars
  • 17,632 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 2 Versions
  • 98 % Grown

The README.md

Omnipay: Tithely

Tithe.ly driver for the Omnipay payment processing library, (*1)

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads, (*2)

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

Install

Via Composer, (*4)

``` bash $ composer require elvanto/omnipay-tithely, (*5)


## Versions Omnipay 3.x is supported starting with v2.0.0 of this package. ## Usage The following gateways are provided by this package: * Tithe.ly (Quick Charge) For general usage instructions, please see the main [Omnipay](https://github.com/thephpleague/omnipay) repository. ### Specific Usage Instructions Omnipay tithely is an API middleware to simplify requests to [Tithely Quick-Charge v1](https://docs.tithe.ly/reference/quick-charge) and later V2. This Tithely api allows users to create a payment request without creating an account. ### Creating the payment request. #### Tithely Payment Gateway Validation data like our *tithely organisation id* `tithely_org_Id`, *tithely public `tithely_public` and secret `tithely_secret` keys* exist as part of our gateway request. Additionally the gateway also takes our *giving type* `giving_type` field as a string. The gateway details are set with the functions: ```php $gateway->setPublicKey($tithely_public); // Required $gateway->setPrivateKey($tithely_secret); // Required $gateway->setOrganizationId($tithely_org_Id); // Required $gateway->setGivingType("Offering"); // Required

Request Body

Unlike regular use of the tithely quick charge api, the omnipay/tithely api object requires a card object within the request to pass our first_name, last_name, and email. The token, description, currency and exist in request objects main body., (*6)

Specific to omnipay / tithely the currency field within the $request body is required., (*7)

$request["card"] =  new CreditCard(array(  
    "first_name" => $first_name,   // Required
    "last_name" => $last_name,   // Required
    "email" => $email   // Required
));  

$request["token"] = $token; // Stripe token. Required
$request["amount"] = "10.00";  // Required
$request["description"] = "Donation to church.";
$request["currency"] = $currency; //e.g. "USD" "CAD" "AUD" Required

$gateway = Omnipay::create('Tithely');

$tithely_public = "pub_*****"; // Required
$tithely_secret = "pri_*****"; // Required
$tithely_org_Id = "org_*****"; // Required

$gateway->setPublicKey($tithely_public);  // Required
$gateway->setPrivateKey($tithely_secret);  // Required
$gateway->setOrganizationId($tithely_org_Id);   // Required
$gateway->setGivingType("Offering");  // Required

$response = $gateway->purchase($request)->send();

Accessing the response object.

The $reponse comes as a protected object. To access the response use the getRequest and getData() odadmnipay functions., (*8)

$response->getRequest()->getData()["first_name"];

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., (*9)

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., (*10)

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., (*11)

Testing

bash $ composer test, (*12)

Contributing

Please see CONTRIBUTING for details., (*13)

Security

If you discover any security related issues, please email developers@elvanto.com instead of using the issue tracker., (*14)

License

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

The Versions

31/08 2017

dev-master

9999999-dev https://github.com/elvanto/omnipay-tithely

Tithe.ly driver for the Omnipay payment processing library

  Sources   Download

MIT

The Requires

 

The Development Requires

omnipay tithely

31/08 2017

v1.0.0

1.0.0.0 https://github.com/elvanto/omnipay-tithely

Tithe.ly driver for the Omnipay payment processing library

  Sources   Download

MIT

The Requires

 

The Development Requires

omnipay tithely