Server : Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.4.20 System : Linux st2.domain.com 3.10.0-1127.10.1.el7.x86_64 #1 SMP Wed Jun 3 14:28:03 UTC 2020 x86_64 User : apache ( 48) PHP Version : 7.4.20 Disable Function : NONE Directory : /var/www/html/luckymerchan/vendor/phpjuice/paypal-checkout-sdk/ |
# PayPal Checkout SDK
[](https://packagist.org/packages/phpjuice/paypal-checkout-sdk)
[](https://codeclimate.com/github/phpjuice/paypal-checkout-sdk/maintainability)
[](https://packagist.org/packages/phpjuice/paypal-checkout-sdk)
[](https://packagist.org/packages/phpjuice/paypal-checkout-sdk)
This Package is a PHP SDK wrapper around version 2 of the PayPal rest API. It provides a simple, fluent API to create
and capture orders with both sandbox and production environments supported.
To learn all about it, head over to the extensive [documentation](https://phpjuice.gitbook.io/paypal-checkout-sdk).
## Installation
PayPal Checkout SDK Package requires PHP 7.4 or higher.
> **INFO:** If you are using an older version of php this package may not function correctly.
The supported way of installing PayPal Checkout SDK package is via Composer.
```bash
composer require phpjuice/paypal-checkout-sdk
```
## Setup
PayPal Checkout SDK is designed to simplify using the new PayPal checkout api in your app.
### Setup Credentials
Get client ID and client secret by going
to [https://developer.paypal.com/developer/applications](https://developer.paypal.com/developer/applications) and
generating a REST API app. Get Client ID and Secret from there.
### Setup a Paypal Client
Inorder to communicate with PayPal platform we need to set up a client first :
#### Create a client with sandbox environment :
```php
// import namespace
use PayPal\Http\Environment\SandboxEnvironment;
use PayPal\Http\PayPalClient;
// client id and client secret retrieved from PayPal
$clientId = "<<PAYPAL-CLIENT-ID>>";
$clientSecret = "<<PAYPAL-CLIENT-SECRET>>";
// create a new sandbox environment
$environment = new SandboxEnvironment($clientId, $clientSecret);
// create a new client
$client = new PayPalClient($environment);
```
#### Create a client with production environment :
```php
// import namespace
use PayPal\Http\Environment\ProductionEnvironment;
use PayPal\Http\PayPalClient;
// client id and client secret retrieved from PayPal
$clientId = "<<PAYPAL-CLIENT-ID>>";
$clientSecret = "<<PAYPAL-CLIENT-SECRET>>";
// create a new sandbox environment
$environment = new ProductionEnvironment($clientId, $clientSecret);
// create a new client
$client = new PayPalClient($environment);
```
> **INFO**: head over to the extensive [documentation](https://phpjuice.gitbook.io/paypal-checkout-sdk).
## Usage
### Create an Order
```php
// Import namespace
use PayPal\Checkout\Requests\OrderCreateRequest;
use PayPal\Checkout\Orders\AmountBreakdown;
use PayPal\Checkout\Orders\Item;
use PayPal\Checkout\Orders\Order;
use PayPal\Checkout\Orders\PurchaseUnit;
// Create a purchase unit with the total amount
$purchase_unit = new PurchaseUnit(AmountBreakdown::of('100.00'));
// Create & add item to purchase unit
$purchase_unit->addItem(Item::create('Item 1', '100.00', 'USD', 1));
// Create a new order with intent to capture a payment
$order = new Order();
// Add a purchase unit to order
$order->addPurchaseUnit($purchase_unit);
// Create an order create http request
$request = new OrderCreateRequest($order);
// Send request to PayPal
$response = $client->send($request);
// Parse result
$result = json_decode((string) $response->getBody());
echo $result->id; // id of the created order
echo $result->intent; // CAPTURE
echo $result->status; // CREATED
```
> **INFO**: head over to the extensive [documentation](https://phpjuice.gitbook.io/paypal-checkout-sdk).
### Capture an Order
```php
// Import namespace
use PayPal\Checkout\Requests\OrderCaptureRequest;
// Create an order capture http request
$request = new OrderCaptureRequest($order_id);
// Send request to PayPal
$response = $client->send($request);
// Parse result
$result = json_decode((string) $response->getBody());
echo $result->id; // id of the captured order
echo $result->status; // CAPTURED
```
> **INFO**: head over to the extensive [documentation](https://phpjuice.gitbook.io/paypal-checkout-sdk).
## Changelog
Please see the [changelog](changelog.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for details and a todo list.
## Security
If you discover any security related issues, please email author instead of using the issue tracker.
## Credits
- [PayPal Docs](https://developer.paypal.com/docs/)
- [Gitbook](https://www.gitbook.com/)
## License
license. Please see the [Licence](https://github.com/phpjuice/paypal-checkout-sdk/blob/main/LICENSE) for more
information.
[](https://packagist.org/packages/phpjuice/paypal-checkout-sdk)
[](https://codeclimate.com/github/phpjuice/paypal-checkout-sdk/maintainability)
[](https://packagist.org/packages/phpjuice/paypal-checkout-sdk)
[](https://packagist.org/packages/phpjuice/paypal-checkout-sdk)