v1.0.5 2017-03-27 09:11 UTC

README

Build Status Coverage Status Total Downloads Latest Stable Version License

Library provide ability to make requests to TransactPRO Gateway API.
Library are supported by me, and not by TransactPRO. So, submit all requests, issues and questions directly here (on GitHub). Library provided as is.
You must adopt library for your projects by yourselves, I only provide basic functionality to make requests.

Installation

Composer

Recommended way of installation is through composer.
Run command line command composer require transact-pro/gate or add to your composer.json:

"require": {
    "transact-pro/gate": "^v1.0"
}

And then install with:

$ composer.phar install

Manual

You can manually download library and use autoloader.

require_once 'lib/autoloader.php'

Usage

Create gate client

Field Mandatory Type Description
apiUrl yes string Api URL. Can be aquired via Integration manual.
guid yes string Merchant GUID.
pwd yes string Unecrypted password. It will be encrypted by client.
verifySSL no bool Default: true. Must be set to false for test environment

Basic client

use TransactPRO\Gate\GateClient;

$gateClient = new GateClient(array(
    'apiUrl'    => 'https://www.payment-api.com',
    'guid'      => 'AAAA-AAAA-AAAA-AAAA',
    'pwd'       => '111'
));

Client with disabled SSL check.

use TransactPRO\Gate\GateClient;

$gateClient = new GateClient(array(
    'apiUrl'    => 'https://www.payment-api.com',
    'guid'      => 'AAAA-AAAA-AAAA-AAAA',
    'pwd'       => '111',
    'verifySSL' => false
));

Actions

GateClient instance provide number of actions, such as 'charge' or 'status_request'. All data passed into action are validated and if mandatory field missed, then exception will be raised. Please check integration manual, to get more info about required data for each action.

Init

$response = $gateClient->init(array(
    'rs'                      => 'AAAA',
    'merchant_transaction_id' => '1',
    'user_ip'                 => '127.0.0.1',
    'description'             => 'Test description',
    'amount'                  => '100',
    'currency'                => 'LVL',
    'name_on_card'            => 'Vasyly Pupkin',
    'street'                  => 'Main street 1',
    'zip'                     => 'LV-0000',
    'city'                    => 'Riga',
    'country'                 => 'LV',
    'state'                   => 'NA',
    'email'                   => 'email@example.lv',
    'phone'                   => '+371 11111111',
    'card_bin'                => '511111',
    'bin_name'                => 'BANK',
    'bin_phone'               => '+371 11111111',
    'merchant_site_url'       => 'http://www.example.com'
));

Charge

$response = $gateClient->charge(array(
    'f_extended'          => '5',
    'init_transaction_id' => '13hpf5rp1e0ss72dypjnhalzn1wmrkfmsjtwzocg',
    'cc'                  => '5111111111111111',
    'cvv'                 => '111',
    'expire'              => '01/20'
));

Init DMS

$response = $gateClient->initDms(array(
    'rs'                      => 'AAAA',
    'merchant_transaction_id' => microtime(true),
    'user_ip'                 => '127.0.0.1',
    'description'             => 'Test description',
    'amount'                  => '100',
    'currency'                => 'LVL',
    'name_on_card'            => 'Vasyly Pupkin',
    'street'                  => 'Main street 1',
    'zip'                     => 'LV-0000',
    'city'                    => 'Riga',
    'country'                 => 'LV',
    'state'                   => 'NA',
    'email'                   => 'email@example.lv',
    'phone'                   => '+371 11111111',
    'card_bin'                => '511111',
    'bin_name'                => 'BANK',
    'bin_phone'               => '+371 11111111',
    'merchant_site_url'       => 'http://www.example.com'
));

Make hold

$response = $gateClient->makeHold(array(
    'f_extended'          => '5',
    'init_transaction_id' => '13hpf5rp1e0ss72dypjnhalzn1wmrkfmsjtwzocg',
    'cc'                  => '5111111111111111',
    'cvv'                 => '111',
    'expire'              => '01/20'
));

Charge hold

$response = $gateClient->chargeHold(array(
    'init_transaction_id' => '13hpf5rp1e0ss72dypjnhalzn1wmrkfmsjtwzocg'
));

Cancel DMS

$response = $gateClient->cancelDms(array(
    'init_transaction_id' => '13hpf5rp1e0ss72dypjnhalzn1wmrkfmsjtwzocg',
    'amount_to_refund'    => '100'
));

Refund

$response = $gateClient->refund(array(
    'init_transaction_id' => '13hpf5rp1e0ss72dypjnhalzn1wmrkfmsjtwzocg',
    'amount_to_refund'    => '100'
));

Status request

$response = $gateClient->statusRequest(array(
    'request_type'        => 'transaction_status',
    'init_transaction_id' => '13hpf5rp1e0ss72dypjnhalzn1wmrkfmsjtwzocg',
    'f_extended'          => '5'
));

Init P2P transactions

$response = $gateClient->initP2P(array(
    'rs'                      => 'AAAA',
    'merchant_transaction_id' => microtime(true),
    'user_ip'                 => '127.0.0.1',
    'description'             => 'Test description',
    'amount'                  => '100',
    'currency'                => 'LVL',
    'name_on_card'            => 'Vasyly Pupkin',
    'street'                  => 'Main street 1',
    'zip'                     => 'LV-0000',
    'city'                    => 'Riga',
    'country'                 => 'LV',
    'state'                   => 'NA',
    'email'                   => 'email@example.lv',
    'phone'                   => '+371 11111111',
    'card_bin'                => '511111',
    'bin_name'                => 'BANK',
    'bin_phone'               => '+371 11111111',
    'merchant_site_url'       => 'http://www.example.com',
    'save_card'               => '1',
    'cardname'                => 'John Doe',
    'recipient_name'          => 'Jane Doe',
    'client_birth_date'       => '29061988',
));

Do P2P transactions

$response = $gateClient->doP2P(array(
    'f_extended'          => '5',
    'init_transaction_id' => '13hpf5rp1e0ss72dypjnhalzn1wmrkfmsjtwzocg',
    'cc_2'                => '5111111111111111',
));

Init Credit transactions

$response = $gateClient->initCredit(array(
    'rs'                      => 'AAAA',
    'merchant_transaction_id' => microtime(true),
    'user_ip'                 => '127.0.0.1',
    'description'             => 'Test description',
    'amount'                  => '100',
    'currency'                => 'LVL',
    'name_on_card'            => 'Vasyly Pupkin',
    'street'                  => 'Main street 1',
    'zip'                     => 'LV-0000',
    'city'                    => 'Riga',
    'country'                 => 'LV',
    'state'                   => 'NA',
    'email'                   => 'email@example.lv',
    'phone'                   => '+371 11111111',
    'card_bin'                => '511111',
    'bin_name'                => 'BANK',
    'bin_phone'               => '+371 11111111',
    'merchant_site_url'       => 'http://www.example.com',
));

Do Credit transactions

$response = $gateClient->doCredit(array(
    'f_extended'             => '5',
    'init_transaction_id'    => '13hpf5rp1e0ss72dypjnhalzn1wmrkfmsjtwzocg',
    'cc'                     => '5111111111111111',
    'cvv'                    => '111',
    'expire'                 => '01/20',
    'merchant_referring_url' => 'http://www.payment.example.com/id=example_referring_id',
));

Init store card for further SMS transactions without card

$response = $gateClient->initStoreCardSms(array(
    'rs'                      => 'AAAA',
    'merchant_transaction_id' => '1',
    'user_ip'                 => '127.0.0.1',
    'description'             => 'Test description',
    'amount'                  => '100',
    'currency'                => 'LVL',
    'name_on_card'            => 'Vasyly Pupkin',
    'street'                  => 'Main street 1',
    'zip'                     => 'LV-0000',
    'city'                    => 'Riga',
    'country'                 => 'LV',
    'state'                   => 'NA',
    'email'                   => 'email@example.lv',
    'phone'                   => '+371 11111111',
    'card_bin'                => '511111',
    'bin_name'                => 'BANK',
    'bin_phone'               => '+371 11111111',
    'merchant_site_url'       => 'http://www.example.com'
));

Init store card for further Credit transactions without card

$response = $gateClient->initStoreCardCredit(array(
    'rs'                      => 'AAAA',
    'merchant_transaction_id' => microtime(true),
    'user_ip'                 => '127.0.0.1',
    'description'             => 'Test description',
    'amount'                  => '100',
    'currency'                => 'LVL',
    'name_on_card'            => 'Vasyly Pupkin',
    'street'                  => 'Main street 1',
    'zip'                     => 'LV-0000',
    'city'                    => 'Riga',
    'country'                 => 'LV',
    'state'                   => 'NA',
    'email'                   => 'email@example.lv',
    'phone'                   => '+371 11111111',
    'card_bin'                => '511111',
    'bin_name'                => 'BANK',
    'bin_phone'               => '+371 11111111',
    'merchant_site_url'       => 'http://www.example.com',
));

Init store card for further P2P transactions without card

$response = $gateClient->initStoreCardP2P(array(
    'rs'                      => 'AAAA',
    'merchant_transaction_id' => microtime(true),
    'user_ip'                 => '127.0.0.1',
    'description'             => 'Test description',
    'amount'                  => '100',
    'currency'                => 'LVL',
    'name_on_card'            => 'Vasyly Pupkin',
    'street'                  => 'Main street 1',
    'zip'                     => 'LV-0000',
    'city'                    => 'Riga',
    'country'                 => 'LV',
    'state'                   => 'NA',
    'email'                   => 'email@example.lv',
    'phone'                   => '+371 11111111',
    'card_bin'                => '511111',
    'bin_name'                => 'BANK',
    'bin_phone'               => '+371 11111111',
    'merchant_site_url'       => 'http://www.example.com',
    'save_card'               => '1',
    'cardname'                => 'John Doe',
    'recipient_name'          => 'Jane Doe',
    'client_birth_date'       => '29061988',
));

Store card for further transactions without card

$response = $gateClient->storeCard(array(
    'f_extended'          => '5',
    'init_transaction_id' => '13hpf5rp1e0ss72dypjnhalzn1wmrkfmsjtwzocg',
    'cc'                  => '5111111111111111',
    'expire'              => '01/20'
));

Initial recurrent transaction (usual, P2P, Credit)

For usual Recurrent use:

  • initRecurrent

For P2P recurrent use:

  • initRecurrentCredit

For Credit recurrent use:

  • initRecurrentP2P

Fields in these requests are same, read documetation for details.

Example:

$response = $gateClient->initRecurrent(array(
    'rs'                      => 'AAAA',
    'original_init_id'        => '13hpf5rp1e0ss72dypjnhalzn1wmrkfmsjtwzocg',
    'merchant_transaction_id' => microtime(true),
    'amount'                  => '100',
    'description'             => 'Test description',
));

Charge recurrent transaction

For usual Recurrent use:

  • chargeRecurrent

For P2P recurrent use:

  • doRecurrentCredit

For Credit recurrent use:

  • doRecurrentP2P

Example:

$response = $gateClient->chargeRecurrent(array(
    'f_extended'             => '5',
    'init_transaction_id'    => '13hpf5rp1e0ss72dypjnhalzn1wmrkfmsjtwzocg',
));

Response

Response instance returned as action result.

isSuccess

To check if curl request was successful, you can use isSuccessful method;

$response->isSuccessful(); // Return bool.

getResponseContent

To get raw response you can use getResponseContent.

If request was successful, then API response was returned. If not, then curl_error was returned.

$response->getResponseContent(); // Return string.
$response->getParsedResponse();  // Parsed response content.

Tests

If you wish to run tests, you need to install development dependencies:

$ composer.phar install --dev

And then run them with:

$ vendor/bin/phpunit