citypay/paylink-sdk-php

PHP SDK for use with CityPay Paylink to process and authorise transactions using the CityPay Paylink API

1.0.0 2019-03-14 09:56 UTC

Requires

• php: >=5.5
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^6.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ~2.12
• phpunit/phpunit: ^4.8
• squizlabs/php_codesniffer: ~2.6

proprietary

• Swagger and contributors
• CityPay Limited

• php
• api
• sdk
• swagger

README

API for creating payments with CityPay's Paylink system.

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 3.1
• Build package: io.swagger.codegen.languages.PhpClientCodegen For more information, please visit https://citypay.com

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com//.git"
    }
  ],
  "require": {
    "/": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Swagger\Client\Model\TokenRequest(); // \Swagger\Client\Model\TokenRequest | 

try {
    $apiInstance->createPost($body);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createPost: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://secure.citypay.com/paylink3

Class	Method	HTTP request	Description
DefaultApi	createPost	POST /create	Creates a Paylink token to create a payment

Documentation For Models

• Address
• CardHolder
• Config
• CustomParam
• Options
• TokenRequest

Documentation For Authorization

All endpoints do not require authorization.

Author

[e-mail]