README

This is simple and easy to use Laravel and Lumen package for using multiple payment gateways in a single place. Now you don't need to install multiple packages for multiple payment gateways. Here we provide 2 of most widely used Payment Gateways (PayPal, Stripe) having easy to use methods such as pay(), invoice(), refund() etc.

Installation

Via Composer

for both Laravel and Lumen

$ composer require hetsabit/payments ">=1.0"

or you can just add it in your composer.json

"require": {
    "hetsabit/payments": ">=1.0"
}

Next, run composer update.

Usage for Laravel

i). For Laravel Add the ServiceProvider to your config/app.php

a). Add in providers array,

'providers' => array(
    // ...

    Hetsabit\Payments\PaymentsServiceProvider::class,
);

b). Add alias in alias array,

'aliases' => array(
    // ...

    'Payment'   => Hetsabit\Payments\Facades\Payment::class,
);

c). Finally publish the package configurations by running the following command in Terminal

`php artisan vendor:publish --provider="Hetsabit\Payments\PaymentsServiceProvider"`

Usage for Lumen

a). For Lumen make a directory named config and make a file there named payments and add the below code,

<?php

return [
	'payment_type' => env('PAYMENT_TYPE', 'paypal'),
	'stripe' => [
		'key'       => env('STRIPE_KEY'),
		'secret'    => env('STRIPE_SECRET'),
	],
	'paypal_payment' => [
		# Define your application mode here
		'mode' => env('PAYPAL_MODE', 'sandbox'),  //"sanbox" for testing and "live" for production

		# Account credentials from developer portal
		'account' => [
			'client_id'		=> env('PAYPAL_CLIENT_ID', ''),
			'client_secret' => env('PAYPAL_CLIENT_SECRET', ''),
		],

		# Connection Information
			'http' => [
			'connection_time_out' => 30,
			'retry' => 1,
		],

		# Logging Information
		'log' => [
			'log_enabled' => true,

			# When using a relative path, the log file is created
			# relative to the .php file that is the entry point
			# for this request. You can also provide an absolute
			# path here
			'file_name' => '../PayPal.log',

			# Logging level can be one of FINE, INFO, WARN or ERROR
			# Logging is most verbose in the 'FINE' level and
			# decreases as you proceed towards ERROR
			'log_level' => 'FINE',
		],
	],
];

b). Make a directory inside in app named Support and make a file there named helpers.php. Now add the following lines in your composer.json.

//in composer.json

"autoload": {
    "classmap": [
        "database/seeds",
        "database/factories"
    ],
    "psr-4": {
        "App\\": "app/"
    },
    "files": [
        "app/Support/helpers.php"
    ]
},

//in app/Support/helpers.php

<?php

if ( ! function_exists('config_path')){
    /**
     * Get the configuration path.
     *
     * @param  string $path
     * @return string
     */
    function config_path($path = ''){
        return app()->basePath() . '/config' . ($path ? '/' . $path : $path);
    }
}

c). Go to your bootstrap/app.php and uncomment line there withEloquent() and add the following lines,

$app->register(Hetsabit\Payments\PaymentsServiceProvider::class);

class_alias('Hetsabit\Payments\Facades\Payment', 'Payment');

$app->configure('payments');

Important instructions

a). search for vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/PayPalModel.php at line 173

change else if(sizeof($v) <= 0 && is_array($v)) to else if(is_array($v) && sizeof($v) <= 0)

b). Add credentials in your .env

STRIPE_KEY='YOUR_CREDENTIALS'
STRIPE_SECRET='YOUR_CREDENTIALS'

PAYPAL_MODE='YOUR_CREDENTIALS' 			//"sanbox" for testing and "live" for production (default: sandbox)
PAYMENT_TYPE='YOUR_TYPE' 				//paypal, stripe (default: paypal)
PAYPAL_CLIENT_ID='YOUR_CREDENTIALS'
PAYPAL_CLIENT_SECRET='YOUR_CREDENTIALS'

Examples

1). For PayPal (if PAYMENT_TYPE == paypal in .env)

i). For payment through PayPal

//for shipping details 						(Optional)
$shipping = \Payment::shipping();
$shipping->setLine1("3909 Witmer Road")
->setLine2("Niagara Falls")
->setCity("Niagara Falls")
->setState("NY")
->setPostalCode("14305")
->setCountryCode("US")
->setPhone("716-298-1822")
->setRecipientName("Jhone");
	
//if making payment via credit_card (Required if card is set otherwise not required)
$card = \Payment::card();
$card->setType('visa')						
->setNumber(4032038634486363)	//required		
->setExpireMonth(11)	//required	
->setExpireYear(2023)	//required		
->setCvv(123)			//required		
->setFirstName('Abhishek')					
->setLastName('Rana');						
	
//if user wants to add some extra details 	(Optional)
$details = \Payment::details();
$details//>setShippingCharge(1.0)				
->setShippingTax(1.0)	(sub total must be a sumation of all taxes and price)	
->setSubtotal(2.0);

a). making payment (paypal checkout)

$pay = \Payment::setTax(0.2)									
->setPrice(1)	//required                          		
->setQuantity(1)	//required							
->setSubTotal(1)															
->setTotal(1.0)	//required                          	
->setCurrency('USD')	(Default USD, otherwise can be provided e.g. USD, AUD etc.)						
->setDescription('New description')			
->setItemName('New Items for shopping')	//required		
->setShippingDetails($shipping)	//required only if shipping details are set as above, otherwise optional		
->setReturnUrl(url('/payment?success=true'))	//required if card is not set (must be a full fletched URl)
->setCancelUrl(url('/payment?success=false'))	//required if card is not set (must be a full fletched URl)
->setExtraParam([		
	'url' => true	//required if you want only redirect URL for PayaPal (useful in cases when you are making API or something). if it is not set then for payment it will redirect to paypal payment screen
])
->setIntent('sale')	(Optional)(Default : sale)(e.g. sale, order, authorize)					
->setDetails($details)						
->pay();	//required
```

b). making payment through card, then set card

$pay = \Payment::setTax(0.2)									
->setPrice(1)	//required                          		
->setQuantity(1)	//optional							
->setSubTotal(1)	//optional
->setAmount(1)		//required           	
->setCurrency('USD')	(Default USD, otherwise can be provided e.g. USD, AUD etc.)						
->setDescription('New description')			
->setItemName('New Items for shopping')	//required		
->setShippingDetails($shipping)	//required only if shipping details are set as above, otherwise optional		
->setCard($card)	//required only if payment method is set as `credit_card` otherwise not required
->setIntent('sale')	(Optional)(Default : sale)(e.g. sale, order, authorize)					
->setDetails($details)						
->pay();	//required

b). For the invoice or payment details of any Payment through PayPal

$payment_id = 'PAY-1JK339012V705711ALPC3QSI';	: Required(fetch this id, when you are making transaction and store it safe)
$payment_details = \Payment::invoice($payment_id);

c). For refund of any transaction through PayPal

$transaction_id = '3S7574554G079694D'; : Required(fetch this id, when you are making transaction and store)
$refund = \Payment::setAmount(0.11)
->setCurrency('USD')
->setReason('to refund the amount reason')
->refund($transaction_id);

2). For Stripe (if PAYMENT_TYPE == stripe in .env) a). For payment through Stripe

//initialising the card object
$card = Payment::card();
$card->setNumber(4242424242424242)	: integer (Required)
->setExpireYear(2020)	: integer (Required)
->setExpireMonth(06)	: integer (Required)
->setCvv(314);	: integer (Required)
	
//making payments
$pay = \Payment::setAmount(1)	: integer (Required)
->setDescription('for whatever')	: string  (Optional)
->setCard($card)	: object  (Required)
->pay();	: required

b). To get invoice or payment details

$payment_id = 'ch_1DK0jWB108n83JtHxlqSCqrK';	: Required(fetch this id, when you are making transaction and store it safe)

$payment_details = \Payment::invoice($payment_id);

c). To get refund of any transaction

$transaction_id = 'ch_1DK0j1B108n83JtH236d8aH5'; : Required(fetch this id, when you are making transaction and store)
$refund = \Payment::setAmount(1)
->setReason('duplicate')
->refund($transaction_id);

Testing

$ vendor Hetsabit/payments

Environment

a). Just change the environment from env for PayPal sandbox for testing and live for production, in your .env

PAYPAL_MODE = sandbox/live

b). For Stripe just change the credentials of live and after activation of account for live payments everything will be fine.

Security

If you discover any security related issues, please email friends@hestabit.com instead of using the issue tracker.

License

license. Please see the license file for more information.

hestalabs / payments

Maintainers

Details