Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/culturekings/laravel5-afterpay
PHP Laravel Service Provider for the Afterpay.com.au API - Unmaintained as of April 2021
https://github.com/culturekings/laravel5-afterpay
afterpay laravel payments php
Last synced: 3 months ago
JSON representation
PHP Laravel Service Provider for the Afterpay.com.au API - Unmaintained as of April 2021
- Host: GitHub
- URL: https://github.com/culturekings/laravel5-afterpay
- Owner: culturekings
- License: mit
- Archived: true
- Created: 2016-08-24T03:12:46.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-05-12T05:10:09.000Z (over 7 years ago)
- Last Synced: 2024-09-21T14:06:28.694Z (3 months ago)
- Topics: afterpay, laravel, payments, php
- Language: PHP
- Homepage:
- Size: 109 KB
- Stars: 2
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Afterpay for Laravel 5
=======================
This packages exposes services from [CultureKings/Afterpay](https://github.com/culturekings/afterpay) in Laravel5.
[](https://coveralls.io/github/culturekings/laravel5-afterpay?branch=master)
[](https://img.shields.io/circleci/project/culturekings/laravel5-afterpay.svg?style=svg)
[](https://scrutinizer-ci.com/g/culturekings/afterpay/laravel5-afterpay/quality-score.png?b=master)
[](https://img.shields.io/sensiolabs/i/3fd9cfea-4edb-4ce1-94f5-bd2358bfb7a6.svg)
## Version Compatibility
Laravel | Laravel5 Afterpay
:---------|:----------
5.3.x | @dev
## Installation
The recommended way to install is via [Composer](http://getcomposer.org).
```bash
composer require culturekings/laravel5-afterpay
```
Find the providers key in your config/app.php and register the Afterpay Service Provider
```php
'providers' => array(
// ...
CultureKings\LaravelAfterpay\Provider\AfterpayProvider::class,
)
```
## Configuration
### Merchant API Configuration
By default, the package uses the following environment variables to auto-configure the plugin without modification:
```bash
AFTERPAY_API_URL (defaults to sandbox url)
AFTERPAY_MERCHANT_ID
AWS_AFTERPAY_SECRET_KEY
```
### InStore API Configuration
```bash
AFTERPAY_INSTORE_API_URL (defaults to sandbox url)
```
To customize the configuration file, publish the package configuration using Artisan.
php artisan vendor:publish
Update your settings in the generated app/config/afterpay.php configuration file.
## Usage
### Merchant API Facades
This package exposes multiple facades for you to use.
Using the facades allows you not to worry about the Authorisation object that is required for calls.
Configuration
```php
$api = \App::make('afterpay_merchant_configuration');
$api::get();
```
Payments
```php
$api = \App::make('afterpay_merchant_payments');
$payments = $api::listPayments();
```
Orders
```php
$api = \App::make('afterpay_merchant_orders');
$order = $api::get(ORDER_TOKEN);
```
### InStore API Facades
This package exposes multiple facades for you to use.
Authentication is more manual with this API and it is required for you to manually set the details on `\CultureKings\Afterpay\Model\InStore\Authorization`.
Customer
```php
$api = \App::make('afterpay_instore_customer');
$api::invite();
```
Device
```php
$api = \App::make('afterpay_instore_device');
$api::activate();
```
Order
```php
$api = \App::make('afterpay_instore_order');
$order = $api::create();
```
PreApproval
```php
$api = \App::make('afterpay_instore_preapproval');
$order = $api::enquiry();
```
Refund
```php
$api = \App::make('afterpay_instore_refund');
$order = $api::create();
```
### Raw
[read the documentation](https://github.com/culturekings/afterpay)
Raw does away with the Facade and hits the services directly, giving you more flexibility.
The trade off is that your now responsible for creating your own Authentication object and injecting it into the services.
You can still ask Laravel to create you an Authentication object with your credentials loaded from config.
```php
$auth = \App::make(CultureKings\Afterpay\Model\Merchant\Authorization::class);
```