library gopay-simple

markette/gopay-simple

GoPay Inline Simple Payment Gateway

, _(*1)

, _(*2)

Website 🚀 contributte.org | Contact 👨🏻‍💻 f3l1x.io | Twitter 🐦 @contributte , _(*3)

Disclaimer

Composer	markette/gopay-simple
Version
PHP
License

Documentation

Goal

One class rule-them-all, best way is $gopay->call()., _(*4)

Install

composer require markette/gopay-simple

Requirements

You need GoID, ClientID and ClientSecret., _(*5)

• Webpage (https://www.gopaygate.com)
• Offical resources in EN (https://doc.gopay.com/en/)
• Offical resources in CZ (https://doc.gopay.com/cs/)

Usage

This super simple class provides a few methods, 2 public and 4 protected, for easy extending / prototyping., _(*6)

Public

• call(string $method, string $endpoint, array $args = []) : stdClass
• setMode(int $gopay::DEV/PROD) : void
• $useragent : PHP+Markette/GopaySimple/{VERSION}
• $options : [] (cURL options)

Protected

• authenticate(array $args) : stdClass (token)
• makeRequest(string $method, string $endpoint, array $args = []) : string
• getEndpoint(string $type) : string
• getEndpointUrl(string $uri) : string

Common part

use Markette\GopaySimple\GopaySimple;

$gopay = new GopaySimple($clientId, $clientSecret);

# For testing purpose
$gopay->setMode($gopay::DEV);

Authorization (Oauth)

Auth process is very simple and automatic. So, you do not have to do anything., _(*7)

If you really need override authorization, you have to extend GopaySimple and call authenticate($args) directly., _(*8)

Payments

POST+payments/payment

$response = $gopay->call('POST', 'payments/payment', [
    'payer' => [
        'default_payment_instrument' => 'BANK_ACCOUNT',
        'allowed_payment_instruments' => ['BANK_ACCOUNT'],
        'default_swift' => 'FIOBCZPP',
        'allowed_swifts' => ['FIOBCZPP', 'BREXCZPP'],
        'contact' => [
            'first_name' => 'Zbynek',
            'last_name' => 'Zak',
            'email' => 'zbynek.zak@gopay.cz',
            'phone_number' => '+420777456123',
            'city' => 'C.Budejovice',
            'street' => 'Plana 67',
            'postal_code' => '373 01',
            'country_code' => 'CZE',
        ],
    ],
    'target': ['type' => 'ACCOUNT', 'goid' => '_YOUR_GO_ID_',
    'amount' => 150,
    'currency' => 'CZK',
    'order_number' => '001',
    'order_description' => 'pojisteni01',
    'items' => [
        ['name' => 'item01', 'amount' => 50],
        ['name' => 'item02', 'amount' => 100],
    ],
    'additional_params' => [
        array('name' => 'invoicenumber', 'value' => '20160001')
    ],
    'return_url' => 'http://www.your-url.tld/return',
    'notify_url' => 'http://www.your-url.tld/notify',
    'lang' => 'cs',
]);

GET+payments/payment/{id}

$response = $gopay->call('GET', 'payments/payment/{id}');

Best practice

You should inject GopaySimple into your service layer. And configure $args before creating payment for target., _(*9)

Example of GopayService., _(*10)

Testing

1. Start build-in server at tests/buildin/run.sh
2. Run tester at tests/tester

Development

This package was maintain by these authors., _(*11)

, _(*12)

Consider to support contributte development team. Also thank you for being used this package., _(*13)