Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sverraest/pomelo-php
💷 PHP Bindings for the Pomelo Pay API
https://github.com/sverraest/pomelo-php
api api-client php php7 pomelopay
Last synced: 3 days ago
JSON representation
💷 PHP Bindings for the Pomelo Pay API
- Host: GitHub
- URL: https://github.com/sverraest/pomelo-php
- Owner: sverraest
- License: other
- Created: 2018-04-08T15:25:31.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-21T20:19:44.000Z (almost 6 years ago)
- Last Synced: 2024-11-14T21:16:35.253Z (2 months ago)
- Topics: api, api-client, php, php7, pomelopay
- Language: PHP
- Homepage: https://www.pomelopay.com
- Size: 35.2 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# PomeloPHP
[](https://travis-ci.org/sverraest/pomelo-php)
[](https://codecov.io/gh/sverraest/pomelo-php)
[](https://scrutinizer-ci.com/g/sverraest/pomelo-php/?branch=master)
[](https://codeclimate.com/github/sverraest/pomelo-php/maintainability)
[](https://packagist.org/packages/sverraest/pomelo-php)
[](https://packagist.org/packages/sverraest/pomelo-php)
[](https://packagist.org/packages/sverraest/pomelo-php)
> PHP API Client and bindings for the [Pomelo Pay API](https://github.com/PomeloPay/pomelo-apidoc)
Using this PHP API Client you can interact with your Pomelo Pay:
- 💳 __Transactions__
## Installation
Requires PHP 7.0 or higher
The recommended way to install pomelo-php is through [Composer](https://getcomposer.org):
First, install Composer:
```
$ curl -sS https://getcomposer.org/installer | php
```
Next, install the latest pomelo-php:
```
$ php composer.phar require sverraest/pomelo-php
```
Finally, you need to require the library in your PHP application:
```php
require "vendor/autoload.php";
```
## Development
- Run `composer test` and `composer phpcs` before creating a PR to detect any obvious issues.
- Please create issues for this specific API Binding under the [issues](https://github.com/sverraest/revolut-php/issues) section.
- [Contact Pomelo Pay](https://www.pomelopay.com) directly for Pomelo Pay API support.
## Quick Start
### PomeloPHP\Client
First get your `production` or `sandbox` API key from [Pomelo Pay](https://app.pomelopay.com/dashboard/apps).
If you want to get a `production` client:
```php
use PomeloPHP\Client;
$client = new Client('apikey', 'appid');
```
If you want to get a `sandbox` client:
```php
use PomeloPHP\Client;
$client = new Client('apikey', 'appid', 'sandbox');
```
If you want to pass additional [GuzzleHTTP](https://github.com/guzzle/guzzle) options:
```php
use PomeloPHP\Client;
$options = ['headers' => ['foo' => 'bar']];
$client = new Client('apikey', 'appid', 'sandbox', $options);
```
## Available API Operations
The following exposed API operations from the Pomelo Pay API are available using the API Client.
See below for more details about each resource.
💳 __Transactions__
Create a new transaction with or without a specific payment method.
## Usage details
### 💳 Transactions
#### Create transaction with a specific payment method
```php
use PomeloPHP\Client;
$client = new Client('apikey', 'appid');
$json = [
"provider" => "alipay", // Payment method enabled for your merchant account such as bcmc, alipay, card
"currency" => "GBP",
"amount" => 1000, // 10.00 GBP
"redirectUrl" => "https://foo.bar/order/123" // Optional redirect after payment completion
];
$transaction = $client->transactions->create($json);
header('Location: '. $transaction["url"]); // Go to transaction payment page
```
#### Create transaction without a payment method that will redirect to the payment method selection screen
```php
use PomeloPHP\Client;
$client = new Client('apikey', 'appid');
$json = [
"currency" => "GBP",
"amount" => 1000, // 10.00 GBP
"redirectUrl" => "https://foo.bar/order/987" // Optional redirect after payment completion
];
$transaction = $client->transactions->create($json);
header('Location: '. $transaction["url"]); // Go to payment method selection screen
```
## About
➡️ You can follow me on 🐦 [Twitter](https://www.twitter.com/simondoestech) or ✉️ email me at simon[-at-]pomelopay.com.
⭐ Sign up as a merchant at https://pomelopay.com and start receiving payments in seconds.