Skip to content
PHP Client Library for CoolPay API
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
CoolPay
Tests/api
.gitattributes
.gitignore
.scrutinizer.yml
.travis.yml
CHANGELOG.md
LICENSE.txt
README.md
composer.json
composer.lock
phpcs.xml
phpunit.xml

README.md

coolpay-php-client

coolpay-php-client is a official client for CoolPay API. The CoolPay API enables you to accept payments in a secure and reliable manner. This package currently support CoolPay v10 api.

Installation

Composer

Simply add a dependency on coolpay/coolpay-php-client to your project's composer.json file if you use Composer to manage the dependencies of your project. Here is a minimal example of a composer.json file that just defines a dependency on newest stable version of CoolPay:

{
    "require": {
        "coolpay/coolpay-php-client": "1.0.*"
    }
}

Manually upload

If you cannot use composer and all the goodness the autoloader in composer gives you, you can upload /CoolPay/ to your web space. However, then you need to manage the autoloading of the classes yourself.

Usage

Before doing anything you should register yourself with CoolPay and get access credentials. If you haven't please click here to apply.

Create a new client

First you should create a client instance that is anonymous or authorized with api_key or login credentials provided by CoolPay.

To initialise an anonymous client:

<?php
use CoolPay\CoolPay;

try {
    $client = new CoolPay();
} catch (Exception $e) {
    //...
}
?>

To initialise a client with CoolPay Api Key:

<?php
use CoolPay\CoolPay;

try {
    $api_key = 'xxx';
    $client = new CoolPay(":{$api_key}");
} catch (Exception $e) {
    //...
}
?>

Or you can provide login credentials like:

<?php
use CoolPay\CoolPay;

try {
    $qp_username = 'xxx';
    $qp_password = 'xxx';
    $client = new CoolPay("{$qp_username}:{$qp_password}");
} catch (Exception $e) {
    //...
}
?>

API Calls

You can afterwards call any method described in CoolPay api with corresponding http method and endpoint. These methods are supported currently: get, post, put, patch and delete.

// Get all payments
$payments = $client->request->get('/payments');

// Get specific payment
$payments = $client->request->get('/payments/{id}');

// Create payment
$form = array(
    'order_id' => $order_id,
    'currency' => $currency,
    ...
);
$payments = $client->request->post('/payments', $form);
$status = $payments->httpStatus();
if ($status == 201) {
    // Successful created
}

Handling the response

Getting the HTTP status code:

$response = $client->request->get('/payments');
$status = $response->httpStatus();

if ($status == 200) {
    // Successful request
}

The returned response object supports 3 different ways of returning the response body, asRaw(), asObject, asArray().

// Get the HTTP status code, headers and raw response body.
list($status_code, $headers, $response_body) = $client->request->get('/payments')->asRaw();

// Get the response body as an object
$response_body = $client->request->get('/payments')->asObject();

// Get the response body as an array
$response_body = $client->request->get('/payments')->asArray();

// Example usage
$payments = $client->request->get('/payments')->asArray();

foreach($payments as $payment) {
    //...
}

You can read more about api responses at http://www.coolpay.com/docs.

Tests

Use composer to create an autoloader:

$ composer install
$ phpunit
You can’t perform that action at this time.