payneteasy-payneteasyapi 0.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,18 @@
+PATH
+  remote: .
+  specs:
+    payneteasy-payneteasyapi (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.1.0)
+    test-unit (2.5.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  payneteasy-payneteasyapi!
+  rake
+  test-unit

data/README.md

@@ -0,0 +1,54 @@
+# Ruby Library for PaynetEasy API integration [![Build Status](https://travis-ci.org/payneteasy/ruby-library-payneteasy-api.png?branch=master)](https://travis-ci.org/payneteasy/ruby-library-payneteasy-api)
+## Доступная функциональность
+
+Данная библиотека позволяет производить оплату с помощью [merchant PaynetEasy API](http://wiki.payneteasy.com/index.php/PnE:Merchant_API). На текущий момент реализованы следующие платежные методы:
+- [x] [Sale Transactions](http://wiki.payneteasy.com/index.php/PnE:Sale_Transactions)
+- [x] [Preauth/Capture Transactions](http://wiki.payneteasy.com/index.php/PnE:Preauth/Capture_Transactions)
+- [x] [Transfer Transactions](http://wiki.payneteasy.com/index.php/PnE:Transfer_Transactions)
+- [x] [Return Transactions](http://wiki.payneteasy.com/index.php/PnE:Return_Transactions)
+- [x] [Recurrent Transactions](http://wiki.payneteasy.com/index.php/PnE:Recurrent_Transactions)
+- [x] [Payment Form Integration](http://wiki.payneteasy.com/index.php/PnE:Payment_Form_integration)
+- [ ] [Buy Now Button integration](http://wiki.payneteasy.com/index.php/PnE:Buy_Now_Button_integration)
+- [ ] [eCheck integration](http://wiki.payneteasy.com/index.php/PnE:eCheck_integration)
+- [ ] [Western Union Integration](http://wiki.payneteasy.com/index.php/PnE:Western_Union_Integration)
+- [ ] [Bitcoin Integration](http://wiki.payneteasy.com/index.php/PnE:Bitcoin_integration)
+- [ ] [Loan Integration](http://wiki.payneteasy.com/index.php/PnE:Loan_integration)
+- [ ] [Qiwi Integration](http://wiki.payneteasy.com/index.php/PnE:Qiwi_integration)
+- [x] [Merchant Callbacks](http://wiki.payneteasy.com/index.php/PnE:Merchant_Callbacks)
+
+## Системные требования
+
+* Ruby >= 1.9.3
+
+## Установка
+
+1. Установите bundler, если его еще нет: `gem install bundler`
+2. Перейдите в папку проекта: `cd my/project/directory`
+3. Создайте Gemfile проекта для bundler, если его еще нет: `bundle init`
+4. Добавьте библиотеку в зависимости проекта:
+      * С помощью консоли, выполнив команду `echo "gem 'payneteasy-payneteasyapi'" >> Gemfile`
+      * С помощью текстового редактора. добавив строку `gem 'payneteasy-payneteasyapi'` в файл Gemfile
+      в корневой папке проекта
+5. Установите зависимости: `bundle install`
+
+## Запуск тестов
+
+1. Перейдите в папку с библиотекой: `cd vendor/payneteasy/php-library-payneteasy-api/`
+2. Запустите тесты: `phpunit -c test/phpunit.xml test`
+
+## Использование
+
+* [Простой пример использования библиотеки](doc/00-basic-tutorial.md)
+* [Внутренняя структура библиотеки](doc/01-library-internals.md)
+    * [Семейство классов для хранения и обмена данными, PaynetEasy\PaynetEasyApi\PaymentData](doc/library-internals/00-payment-data.md)
+    * [Фронтенд библиотеки, PaynetEasy\PaynetEasyApi\PaymentProcessor](doc/library-internals/01-payment-processor.md)
+    * [Валидатор данных, PaynetEasy\PaynetEasyApi\Util\Validator](doc/library-internals/02-validator.md)
+    * [Класс для работы с цепочками свойств, PaynetEasy\PaynetEasyApi\Util\PropertyAccessor](doc/library-internals/03-property-accessor.md)
+* [Интеграция различных платежных сценариев](doc/02-payment-scenarios.md)
+    * [Sale transactions](doc/payment-scenarios/00-sale-transactions.md)
+    * [Preauth/Capture Transactions](doc/payment-scenarios/01-preauth-capture-transactions.md)
+    * [Transfer Transactions](doc/payment-scenarios/02-transfer-transactions.md)
+    * [Return Transactions](doc/payment-scenarios/03-return-transactions.md)
+    * [Recurrent Transactions](doc/payment-scenarios/04-recurrent-transactions.md)
+    * [Payment Form Integration](doc/payment-scenarios/05-payment-form-integration.md)
+    * [Merchant Callbacks](doc/payment-scenarios/06-merchant-callbacks.md)

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/paynet_easy/paynet_easy_api'
+  t.test_files = Dir['test/**/*_test.rb']
+end

data/doc/00-basic-tutorial.md

@@ -0,0 +1,254 @@
+# Простой пример использования библиотеки
+
+Разберем выполнение запросов при [интеграции платежной формы](http://wiki.payneteasy.com/index.php/PnE:Payment_Form_integration). Типовая обработка платежа происходит в три этапа. Первый и последний этапы происходят на стороне сервиса мерчанта, а второй - на стороне PaynetEasy.
+
+1. Инициация оплаты:
+    1. [Подключение загрузчика классов и необходимых классов](#stage_1_step_1)
+    2. [Создание новой платежной транзакции](#stage_1_step_2)
+    3. [Создание сервиса для обработки платежей](#stage_1_step_4)
+    4. [Запуск обработки платежной транзакции](#stage_1_step_6)
+        1. Проверка данных платежной транзакции и формирование на ее основе запроса к PaynetEasy
+        3. Изменение статуса платежа **status**
+        4. Выполнение запроса для старта обработки платежной транзакции и ее первичной проверки
+        5. Получение ответа от PaynetEasy
+        6. Изменение статуса платежной транзакции **status** на основе данных ответа
+        7. Сохранение платежной транзакции
+        8. Перенаправление клиента на платежную форму
+
+2. Процессинг платежной формы:
+    1. Заполнение клиентом платежной формы и отправка данных шлюзу PaynetEasy
+    2. Обработка данных шлюзом
+    3. Возврат пользователя на сервис мерчанта с передачей результата обработки платежной формы
+
+3. Обработка результатов:
+    1. [Подключение загрузчика классов и необходимых классов](#stage_2_step_1)
+    2. [Загрузка сохраненной платежной транзакции](#stage_2_step_2)
+    3. [Создание сервиса для обработки платежей](#stage_2_step_4)
+    4. [Запуск обработки данных, полученных при возвращении пользователя с платежной формы](#stage_2_step_6)
+        1. Проверка данных, полученные по возвращении клиента с платежной формы PaynetEasy
+        2. Изменение статуса платежной транзакции **status**
+        3. Сохранение платежной транзакции
+        4. Вывод статуса платежа **status** и статуса платежной транзакции **status** на экран
+
+Рассмотрим примеры исходного кода для выполнения обоих этапов. Код для выполнения второго этапа должен выполняться при переходе по ссылке, заданной в настройках по ключу **redirect_url**. Например, разместите исходный код первого этапа в файле `first_stage.php`, а второго - `second_stage.php`.
+
+### <a name="stage_1"></a>Начало обработки платежной транзакции
+
+1. <a name="stage_1_step_1"></a>Подключение загрузчика классов, [предоставляемого composer](http://getcomposer.org/doc/01-basic-usage.md#autoloading), и необходимых классов:
+
+    ```php
+    require_once 'project/root/dir/vendor/autoload.php';
+
+    use PaynetEasy\PaynetEasyApi\PaymentData\PaymentTransaction;
+    use PaynetEasy\PaynetEasyApi\PaymentData\Payment;
+    use PaynetEasy\PaynetEasyApi\PaymentData\QueryConfig;
+    use PaynetEasy\PaynetEasyApi\PaymentData\BillingAddress;
+    use PaynetEasy\PaynetEasyApi\PaymentData\Customer;
+    use PaynetEasy\PaynetEasyApi\Transport\Response;
+    use PaynetEasy\PaynetEasyApi\PaymentProcessor;
+    use Exception;
+    ```
+2. <a name="stage_1_step_2"></a>Создание новой платежной транзакции:
+    ##### С использованием массивов, переданных в конструктор:
+
+    ```php
+    $customer = new Customer(array
+    (
+        'email'                     => 'vass.pupkin@example.com',
+        'ip_address'                => '127.0.0.1'
+    ));
+
+    $billingAddress = new BillingAddress(array
+    (
+        'country'                   => 'US',
+        'city'                      => 'Houston',
+        'state'                     => 'TX',
+        'first_line'                => '2704 Colonial Drive',
+        'zip_code'                  => '1235',
+        'phone'                     => '660-485-6353'
+    ));
+
+    $queryConfig = new QueryConfig(array
+    (
+        'end_point'                 =>  253,
+        'login'                     => 'rp-merchant1',
+        'signing_key'               => '3FD4E71A-D84E-411D-A613-40A0FB9DED3A',
+        'redirect_url'              => "http://{$_SERVER['HTTP_HOST']}/second_stage.php",
+        'gateway_mode'              =>  QueryConfig::GATEWAY_MODE_SANDBOX,
+        'gateway_url_sandbox'       => 'https://sandbox.domain.com/paynet/api/v2/',
+        'gateway_url_production'    => 'https://payment.domain.com/paynet/api/v2/'
+    ));
+
+    $payment = new Payment(array
+    (
+        'client_id'                 => 'CLIENT-112244',
+        'description'               => 'This is test payment',
+        'amount'                    =>  9.99,
+        'currency'                  => 'USD',
+        'customer'                  => $customer,
+        'billing_address'           => $billingAddress
+    ));
+
+    $paymentTransaction = new PaymentTransaction(array
+    (
+        'payment'                   => $payment,
+        'query_config'              => $queryConfig
+    ));
+    ```
+    ##### С использованием сеттеров:
+
+    ```php
+    $customer = (new Customer)
+        ->setEmail('vass.pupkin@example.com')
+        ->setIpAddress('127.0.0.1')
+    ;
+
+    $billingAddress = (new BillingAddress)
+        ->setCountry('US')
+        ->setState('TX')
+        ->setCity('Houston')
+        ->setFirstLine('2704 Colonial Drive')
+        ->setZipCode('1235')
+        ->setPhone('660-485-6353')
+    ;
+
+    $queryConfig = (new QueryConfig)
+        ->setEndPoint(253)
+        ->setLogin('rp-merchant1')
+        ->setSigningKey('3FD4E71A-D84E-411D-A613-40A0FB9DED3A')
+        ->setRedirectUrl("http://{$_SERVER['HTTP_HOST']}/second_stage.php")
+        ->setGatewayMode(QueryConfig::GATEWAY_MODE_SANDBOX)
+        ->setGatewayUrlSandbox('https://sandbox.domain.com/paynet/api/v2/')
+        ->setGatewayUrlProduction('https://payment.domain.com/paynet/api/v2/')
+    ;
+
+    $payment = (new Payment)
+        ->setClientId('CLIENT-112244')
+        ->setDescription('This is test payment')
+        ->setAmount(9.99)
+        ->setCurrency('USD')
+        ->setCustomer($customer)
+        ->setBillingAddress($billingAddress)
+    ;
+
+    $paymentTransaction = (new PaymentTransaction)
+        ->setPayment($payment)
+        ->setQueryConfig($queryConfig)
+    ;
+    ```
+
+    Поля конфигурации запроса **QueryConfig**:
+    * **[end_point](http://wiki.payneteasy.com/index.php/PnE:Introduction#Endpoint)** - точка входа для аккаунта мерчанта, выдается при подключении
+    * **[login](http://wiki.payneteasy.com/index.php/PnE:Introduction#PaynetEasy_Users)** - логин мерчанта для доступа к панели PaynetEasy, выдается при подключении
+    * **signing_key** - ключ мерчанта для подписывания запросов, выдается при подключении
+    * **[redirect_url](http://wiki.payneteasy.com/index.php/PnE:Payment_Form_integration#Payment_Form_final_redirect)** - URL, на который пользователь будет перенаправлен после окончания запроса
+    * **gateway_mode** - режим работы библиотеки: sandbox, production
+    * **gateway_url_sandbox** - ссылка на шлюз PaynetEasy для режима работы sandbox
+    * **gateway_url_production** - ссылка на шлюз PaynetEasy для режима работы production
+
+3. <a name="stage_1_step_4"></a>Создание сервиса для обработки платежей:
+    ```php
+    $paymentProcessor = new PaymentProcessor(array
+    (
+        PaymentProcessor::HANDLER_CATCH_EXCEPTION   => function(Exception $exception)
+        {
+            print "<pre>";
+            print "Exception catched.\n";
+            print "Exception message: '{$exception->getMessage()}'.\n";
+            print "Exception traceback: \n{$exception->getTraceAsString()}\n";
+            print "</pre>";
+        },
+        PaymentProcessor::HANDLER_SAVE_CHANGES      => function(PaymentTransaction $paymentTransaction)
+        {
+            start_session();
+            $_SESSION['payment_transaction'] = serialize($paymentTransaction);
+        },
+        PaymentProcessor::HANDLER_REDIRECT          => function(Response $response)
+        {
+            header("Location: {$response->getRedirectUrl()}");
+            exit;
+        }
+    ));
+    ```
+
+    Обработчики событий для сервиса:
+    * **PaymentProcessor::HANDLER_CATCH_EXCEPTION** - для обработки исключения, если оно было брошено
+    * **PaymentProcessor::HANDLER_SAVE_CHANGES** - для сохранения платежной транзакции
+    * **PaymentProcessor::HANDLER_REDIRECT** - для переадресации пользователя на URL платежной формы, полученный от PaynetEasy
+
+4. <a name="stage_1_step_6"></a>Запуск обработки платежа:
+
+    ```php
+    $paymentProcessor->executeQuery('sale-form', $paymentTransaction);
+    ```
+    Будут выполнены следующие шаги:
+    1. Проверка данных платежной транзакции и формирование на ее основе запроса к PaynetEasy
+    3. Изменение статуса платежа **status**
+    4. Выполнение запроса для старта обработки платежной транзакции и ее первичной проверки
+    5. Получение ответа от PaynetEasy
+    6. Изменение статуса платежной транзакции **status** на основе данных ответа
+    7. Сохранение платежной транзакции обработчиком для `PaymentProcessor::HANDLER_SAVE_PAYMENT`
+    8. Перенаправление клиента на платежную форму обработчиком для `PaymentProcessor::HANDLER_REDIRECT`
+
+### <a name="stage_2"></a>Окончание обработки платежной транзакции
+
+1. <a name="stage_2_step_1"></a>Подключение загрузчика классов, [предоставляемого composer](http://getcomposer.org/doc/01-basic-usage.md#autoloading), и необходимых классов:
+
+    ```php
+    require_once 'project/root/dir/vendor/autoload.php';
+
+    use PaynetEasy\PaynetEasyApi\PaymentData\PaymentTransaction;
+    use PaynetEasy\PaynetEasyApi\Transport\CallbackResponse;
+    use PaynetEasy\PaynetEasyApi\PaymentProcessor;
+    use Exception;
+    ```
+2. <a name="stage_2_step_2"></a>Загрузка сохраненной платежной транзакции:
+
+    ```php
+    session_start();
+    $paymentTransaction = unserialize($_SESSION['payment_transaction']);
+    ```
+
+3. <a name="stage_2_step_4"></a>Создание сервиса для обработки платежей:
+
+    ```php
+    $paymentProcessor = new PaymentProcessor(array
+    (
+        PaymentProcessor::HANDLER_CATCH_EXCEPTION   => function(Exception $exception)
+        {
+            print "<pre>";
+            print "Exception catched.\n";
+            print "Exception message: '{$exception->getMessage()}'.\n";
+            print "Exception traceback: \n{$exception->getTraceAsString()}\n";
+            print "</pre>";
+        },
+        PaymentProcessor::HANDLER_SAVE_CHANGES      => function(PaymentTransaction $paymentTransaction)
+        {
+            $_SESSION['payment_transaction'] = serialize($paymentTransaction);
+        },
+        PaymentProcessor::HANDLER_FINISH_PROCESSING => function(PaymentTransaction $paymentTransaction)
+        {
+            print "<pre>";
+            print "Payment processing finished.\n";
+            print "Payment status: '{$paymentTransaction->getPayment()->getStatus()}'.\n";
+            print "Payment transaction status: '{$paymentTransaction->getStatus()}'.\n";
+            print "</pre>";
+        }
+    ));
+    ```
+
+    Обработчики событий для сервиса:
+    * **PaymentProcessor::HANDLER_CATCH_EXCEPTION** - для обработки исключения, если оно было брошено
+    * **PaymentProcessor::HANDLER_SAVE_CHANGES** - для сохранения платежа
+    * **PaymentProcessor::HANDLER_FINISH_PROCESSING** - для вывода информации о платеже после окончания обработки
+
+4. <a name="stage_2_step_6"></a>Запуск обработки данных, полученных при возвращении пользователя с платежной формы:
+
+    ```php
+    $paymentProcessor->processCustomerReturn(new CallbackResponse($_POST), $paymentTransaction);
+    ```
+    Будут выполнены следующие шаги:
+    1. Проверка данных, полученные по возвращении клиента с платежной формы PaynetEasy (суперглобальный массив $_POST)
+    2. Изменение статуса платежной транзакции **status** на основе проверенных данных
+    3. Сохранение платежной транзакции обработчиком для `PaymentProcessor::HANDLER_SAVE_PAYMENT`
+    4. Вывод статуса платежа **status** и статуса платежной транзакции **status** на экран обработчиком для `PaymentProcessor::HANDLER_FINISH_PROCESSING`

data/doc/01-library-internals.md

@@ -0,0 +1,6 @@
+# Внутренняя структура библиотеки
+
+* [Семейство классов для хранения и обмена данными, PaynetEasy\PaynetEasyApi\PaymentData](library-internals/00-payment-data.md)
+* [Фронтенд библиотеки, PaynetEasy\PaynetEasyApi\PaymentProcessor](library-internals/01-payment-processor.md)
+* [Валидатор данных, PaynetEasy\PaynetEasyApi\Util\Validator](library-internals/02-validator.md)
+* [Класс для работы с цепочками свойств, PaynetEasy\PaynetEasyApi\Util\PropertyAccessor](library-internals/03-property-accessor.md)

data/doc/02-payment-scenarios.md

@@ -0,0 +1,9 @@
+# Интеграция различных платежных сценариев
+
+* [Sale Transactions](payment-scenarios/00-sale-transactions.md)
+* [Preauth/Capture Transactions](payment-scenarios/01-preauth-capture-transactions.md)
+* [Transfer Transactions](payment-scenarios/02-transfer-transactions.md)
+* [Return Transactions](payment-scenarios/03-return-transactions.md)
+* [Recurrent Transactions](payment-scenarios/04-recurrent-transactions.md)
+* [Payment Form Integration](payment-scenarios/05-payment-form-integration.md)
+* [Merchant Callbacks](payment-scenarios/06-merchant-callbacks.md)

data/doc/library-internals/00-payment-data.md

@@ -0,0 +1,162 @@
+# Классы для хранения и передачи данных
+
+Семейство классов для хранения данных и обмена данными между библиотекой и CMS мерчанта. Расположены в пространстве имен **[PaynetEasy\PaynetEasyApi\PaymentData](../../source/PaynetEasy/PaynetEasyApi/PaymentData)**. Представлены следующими классами объектов:
+* [PaymentTransaction](#PaymentTransaction)
+* [Payment](#Payment)
+* [QueryConfig](#QueryConfig)
+* [Customer](#Customer)
+* [BillingAddress](#BillingAddress)
+* [CreditCard](#CreditCard)
+* [RecurrentCard](#RecurrentCard)
+
+Каждый из классов позволяет наполнять объект данными как с помощью массива, переданного в конструктор, так и с помощью сеттеров. При использовании массива в качестве ключа для данных необходимо использовать underscored название свойства класса.
+
+##### Использование массива и underscored названий свойств класса
+
+```php
+$payment = new Payment(array
+(
+    'client_id'         => 'CLIENT-112233',
+    'paynet_id'         => 'PAYNET-112233',
+    'description'       => 'test payment'
+));
+```
+##### Использование сеттеров
+
+```php
+$payment = (new Payment)
+    ->setClientId('CLIENT-112233')
+    ->setPaynetId('PAYNET-112233')
+    ->setDescription('test payment')
+;
+```
+
+### <a name="PaymentTransaction"></a> PaymentTransaction
+
+Центральным объектом для хранения и передачи данных является объект класса **[PaynetEasy\PaynetEasyApi\PaymentData\PaymentTransaction](../../source/PaynetEasy/PaynetEasyApi/PaymentData/PaymentTransaction.php)**. Именно он передается из CMS в библиотеку при выполнении любого запроса. Хранит следующие данные:
+
+Свойство класса     |Тип                        |Поле запроса   |Назначение
+--------------------|---------------------------|---------------|-------------------------------------------------------
+processorType       |string                     |               |Transaction processor type (query, callback)
+processorName       |string                     |               |Transaction processor name (query or callback name)
+status              |string                     |               |Transaction status (new, processing, approved, filtered, declined, error)
+payment             |[Payment](#Payment)        |               |Платеж, для которого создана транзакция
+queryConfig         |[QueryConfig](#QueryConfig)|               |Payment query config
+errors              |array                      |               |Transaction processing errors
+
+Поля **processorType** и **processorName** заполняются обработчиком транзакции после формирования платежного запроса. Поле **status** изменяется на основе данных ответа от сервера PaynetEasy.
+
+### <a name="Payment"></a> Payment
+
+Объект класса **[PaynetEasy\PaynetEasyApi\PaymentData\Payment](../../source/PaynetEasy/PaynetEasyApi/PaymentData/Payment.php)**. Используется при выполнении всех запросов. Хранит следующие данные:
+
+Свойство класса     |Тип                                |Поле запроса   |Назначение
+--------------------|-----------------------------------|---------------|-------------------------------------------------------
+clientId            |string                             |client_orderid |Merchant payment identifier
+paynetId            |string                             |orderid        |Unique identifier of transaction assigned by PaynetEasy
+description         |string                             |order_desc     |Brief payment description
+destination         |string                             |destination    |Destination to where the payment goes
+amount              |float                              |amount         |Amount to be charged
+currency            |string                             |currency       |Three-letter currency code
+comment             |string                             |comment        |A short comment for payment
+status              |string                             |               |Payment status (new, preauth, capture, return)
+customer            |[Customer](#Customer)              |               |Payment customer
+billingAddress      |[BillingAddress](#BillingAddress)  |               |Payment billing address
+creditCard          |[CreditCard](#CreditCard)          |               |Payment credit card
+recurrentCardFrom   |[RecurrentCard](#RecurrentCard)    |               |Payment source recurrent card
+recurrentCardTo     |[RecurrentCard](#RecurrentCard)    |               |Payment destination recurrent card
+
+Поле **status** заполняется обработчиком транзакции после формирования платежного запроса в зависимости от того, какую платежную операцию реализует обработчик.
+
+### <a name="QueryConfig"></a> QueryConfig
+
+Объект класса **[PaynetEasy\PaynetEasyApi\PaymentData\QueryConfig](../../source/PaynetEasy/PaynetEasyApi/PaymentData/QueryConfig.php)**. Используется при выполнении всех запросов. Хранит следующие данные:
+
+Свойство класса     |Тип    |Поле запроса       |Назначение
+--------------------|-------|-------------------|-------------------------------------------------------
+login               |string |login              |Merchant login
+siteUrl             |string |site_url           |URL the original payment is made from
+redirectUrl         |string |redirect_url       |URL the customer will be redirected to upon completion of the transaction
+callbackUrl         |string |server_callback_url|URL the transaction result will be sent to
+endPoint            |integer|                   |Merchant end point
+signingKey          |string |                   |Merchant key for payment signing
+gatewayMode         |string |                   |Gateway mode (sandbox, production)
+gatewayUrlSandbox   |string |                   |Sandbox gateway url
+gatewayUrlProduction|string |                   |Production gateway url
+
+Значение свойства endPoint участвует в формировании URL для вызова платежного метода шлюза PaynetEasy, а свойства signingKey - в формировании подписи для данных платежа. Значения свойств **gatewayUrlSandbox** и **gatewayUrlProduction** содержат ссылки на sandbox и production гейты. Выбор между этими url осуществляется на основе значения поля **gatewayMode**, если значение поля `QueryConfig::GATEWAY_MODE_SANDBOX`, то будет выбран url **gatewayUrlSandbox**, если `QueryConfig::GATEWAY_MODE_PRODUCTION` - то url **gatewayUrlProduction**.
+
+### <a name="Customer"></a> Customer
+
+Объект класса **[PaynetEasy\PaynetEasyApi\PaymentData\Customer](../../source/PaynetEasy/PaynetEasyApi/PaymentData/Customer.php)**. Используется при выполнении следующих запросов:
+* [sale](../payment-scenarios/00-sale-transactions.md#sale)
+* [preauth](../payment-scenarios/01-preauth-capture-transactions.md#preauth)
+* [sale-form, preauth-form, transfer-form](../payment-scenarios/05-payment-form-integration.md#form)
+* [make-rebill](../payment-scenarios/04-recurrent-transactions.md#make-rebill)
+* [transfer-by-ref](../payment-scenarios/02-transfer-transactions.md#transfer-by-ref)
+
+Объект хранит следующие данные:
+
+Свойство класса     |Тип    |Поле запроса   |Назначение
+--------------------|-------|---------------|-------------------------------------------------------
+firstName           |string |first_name     |Customer’s first name
+lastName            |string |last_name      |Customer’s last name
+email               |string |email          |Customer’s email address
+ipAddress           |string |ipaddress      |Customer’s IP address
+birthday            |string |birthday       |Customer’s date of birth, in the format MMDDYY
+ssn                 |string |ssn            |Last four digits of the customer’s social security number
+
+### <a name="BillingAddress"></a> BillingAddress
+
+Объект класса **[PaynetEasy\PaynetEasyApi\PaymentData\BillingAddress](../../source/PaynetEasy/PaynetEasyApi/PaymentData/BillingAddress.php)**. Используется при выполнении следующих запросов:
+* [sale](../payment-scenarios/00-sale-transactions.md#sale)
+* [preauth](../payment-scenarios/01-preauth-capture-transactions.md#preauth)
+* [sale-form, preauth-form, transfer-form](../payment-scenarios/05-payment-form-integration.md#form)
+
+Объект хранит следующие данные:
+
+Свойство класса     |Тип    |Поле запроса   |Назначение
+--------------------|-------|---------------|-------------------------------------------------------
+country             |string |country        |Customer’s two-letter country code
+state               |string |state          |Customer’s two-letter state code
+city                |string |city           |Customer’s city
+firstLine           |string |address1       |Customer’s address line 1
+zipCode             |string |zip_code       |Customer’s ZIP code
+phone               |string |phone          |Customer’s full international phone number, including country code
+cellPhone           |string |cell_phone     |Customer’s full international cell phone number, including country code
+
+### <a name="CreditCard"></a> CreditCard
+
+Объект класса **[PaynetEasy\PaynetEasyApi\PaymentData\CreditCard](../../source/PaynetEasy/PaynetEasyApi/PaymentData/CreditCard.php)**. Используется при выполнении следующих запросов:
+* [sale](../payment-scenarios/00-sale-transactions.md#sale)
+* [preauth](../payment-scenarios/01-preauth-capture-transactions.md#preauth)
+
+Объект хранит следующие данные:
+
+Свойство класса     |Тип    |Поле запроса       |Назначение
+--------------------|-------|-------------------|-------------------------------------------------------
+cvv2                |integer|cvv2               |RecurrentCard CVV2
+cardPrintedName     |string |card_printed_name  |Card holder name
+creditCardNumber    |string |credit_card_number |Credit card number
+expireYear          |integer|expire_year        |Card expiration year
+expireMonth         |integer|expire_month       |Card expiration month
+
+### <a name="RecurrentCard"></a> RecurrentCard
+
+Объект класса **[PaynetEasy\PaynetEasyApi\PaymentData\RecurrentCard](../../source/PaynetEasy/PaynetEasyApi/PaymentData/RecurrentCard.php)**. Используется при выполнении следующих запросов:
+* [create-card-ref](../payment-scenarios/04-recurrent-transactions.md#create-card-ref)
+* [get-card-info](../payment-scenarios/04-recurrent-transactions.md#get-card-info)
+* [make-rebill](../payment-scenarios/04-recurrent-transactions.md#make-rebill)
+* [transfer-by-ref](../payment-scenarios/02-transfer-transactions.md#transfer-by-ref)
+
+Объект хранит следующие данные:
+
+Свойство класса     |Тип    |Поле запроса       |Назначение
+--------------------|-------|-------------------|-------------------------------------------------------
+paynetId            |integer|cardrefid          |RecurrentCard PaynetEasy ID
+cvv2                |integer|cvv2               |RecurrentCard CVV2
+cardPrintedName     |string |                   |Card holder name
+expireYear          |integer|                   |Card expiration year
+expireMonth         |integer|                   |Card expiration month
+bin                 |integer|                   |Bank Identification Number
+lastFourDigits      |integer|                   |The last four digits of PAN (card number)