Merge pull request #21 from yourpayments/qst-api

qst-api - comments
yourpayments · Jul 25, 2024 · 9e8874d · 9e8874d
2 parents 96e1539 + bc1606e
commit 9e8874d
Show file tree

Hide file tree

Showing 2 changed files with 96 additions and 46 deletions.
diff --git a/src/Examples/qstCreateIp.php b/src/Examples/qstCreateIp.php
@@ -14,54 +14,78 @@
 // Подключим файл, в котором заданы параметры мерчанта
 include_once 'start.php';
 
-/* Создание и отправка анкеты для подключения продавца */
+/* Создание и отправка анкеты для подключения сабмерчанта (продавца) ИП */
 
-/* Создаем и заполняем объект анкеты */
+/* Создадим объект анкеты */
 $qst = new Qst();
 
-/* ИНН продавца */
+/* Укажем ИНН добавляемого сабмерчанта */
 $qst->setInn('773200328662');
 
-/* Данные продавца */
+/* Создадим объект данных анкеты добавляемого сабмерчанта */
 $qstSchema = new QstSchema();
+
+/* Добавим в данные анкеты номер телефона сабмерчанта */
 $qstSchema->addPhone('+7 495 1234567, доб. 123');
+
+/* Добавим в данные анкеты email сабмерчанта */
 $qstSchema->addEmail('[email protected]');
 
+/* Создадим и заполним объект юридического адреса сабмерчанта */
 $qstLegalAddress = (new QstSchemaLegalAddress())
-    ->setZip('123456')
-    ->setRegion('Москва')
-    ->setCity('Москва')
-    ->setStreet('ул. Охотный ряд')
-    ->setHouse('1');
+    ->setZip('123456') // индекс
+    ->setRegion('Москва') // регион
+    ->setCity('Москва') // город
+    ->setStreet('ул. Охотный ряд') // улица
+    ->setHouse('1'); // дом
+/* Укажем объект юридического адреса сабмерчанта в данных анкеты */
 $qstSchema->setLegalAddress($qstLegalAddress);
 
+/*
+ * Создадим объект фактического адреса сабмерчанта и отметим, что
+ * фактический адрес сабмерчанта соответствует юридическому
+ */
 $qstActualAddress = (new QstSchemaActualAddress())->setChecked(true);
+/* Укажем объект фактического адреса сабмерчанта в данных анкеты */
 $qstSchema->setActualAddress($qstActualAddress);
 
+/*
+ * Создадим объект почтового адреса сабмерчанта и отметим, что
+ * почтовый адрес сабмерчанта соответствует юридическому
+ */
 $qstPostAddress = (new QstSchemaPostAddress())->setChecked(true);
+/* Укажем объект почтового адреса сабмерчанта в данных анкеты */
 $qstSchema->setPostAddress($qstPostAddress);
 
+/* Создадим объект удостоверяющего документа и заполним его паспортными данными ИП */
 $qstIdentityDoc = (new QstSchemaIdentityDoc())
-    ->setSeries('1234')
-    ->setNumber('123456')
-    ->setIssueDate('2000-01-30')
-    ->setIssuedBy('МВД')
-    ->setIssuedByKP('123-456');
-
+    ->setSeries('1234') // номер паспорта
+    ->setNumber('123456') // серия
+    ->setIssueDate('2000-01-30') // дата выдачи
+    ->setIssuedBy('МВД') // кем выдан
+    ->setIssuedByKP('123-456'); // к/п
+
+/*
+ * Заполним дату и место рождения ИП в данных анкеты.
+ * Укажем объект с паспортными данным ИП в данных анкеты.
+ */
 $qstSchema
-    ->setBirthDate('1969-02-23')
-    ->setBirthPlace('Москва')
-    ->setIdentityDoc($qstIdentityDoc);
+    ->setBirthDate('1969-02-23') // дата рождения ИП
+    ->setBirthPlace('Москва') // место рождения ИП
+    ->setIdentityDoc($qstIdentityDoc); // объект с паспортными данным ИП
 
+/* Создадим и заполним объект с банковскими данными ИП */
 $qstBankAccount = (new QstSchemaBankAccount())
-    ->setBankBIK('044525700')
-    ->setBankCorAccount('30101810200000000700')
-    ->setBankAccount('40702810100002400756');
-
+    ->setBankBIK('044525700') // БИК
+    ->setBankCorAccount('30101810200000000700') // кор. счет
+    ->setBankAccount('40702810100002400756'); // расч. счет
+/* Добавим объект с банковскими данными сабмерчанта в данные анкеты */
 $qstSchema->addBankAccount($qstBankAccount);
 
+/* Заполним дополнительное поле #1 (при наличии) */
 $qstSchema->setAdditionalFieldByKey(1, 'Доп. поле');
 
+/* Установим объект с данными анкеты в объект анкеты */
 $qst->setSchema($qstSchema);
 
 /* Создадим HTTP-запрос к API */

diff --git a/src/Examples/qstCreateOrg.php b/src/Examples/qstCreateOrg.php
@@ -15,58 +15,84 @@
 // Подключим файл, в котором заданы параметры мерчанта
 include_once 'start.php';
 
-/* Создание и отправка анкеты для подключения продавца */
+/* Создание и отправка анкеты для подключения сабмерчанта (продавца) организации */
 
-/* Создаем и заполняем объект анкеты */
+/* Создадим объект анкеты */
 $qst = new Qst();
 
-/* ИНН продавца */
+/* Укажем ИНН добавляемого сабмерчанта */
 $qst->setInn('7704217370');
 
-/* Данные продавца */
+/* Создадим объект данных анкеты добавляемого сабмерчанта */
 $qstSchema = new QstSchema();
+
+/* Добавим в данные анкеты номер телефона сабмерчанта */
 $qstSchema->addPhone('+7 495 1234567, доб. 123');
+/* Добавим в данные анкеты еще один номер телефона сабмерчанта */
 $qstSchema->addPhone('+7 499 7654321, доб. 321');
+
+/* Добавим в данные анкеты email сабмерчанта */
 $qstSchema->addEmail('[email protected]');
 
+/* Создадим и заполним объект юридического адреса сабмерчанта */
 $qstLegalAddress = (new QstSchemaLegalAddress())
-    ->setZip('123112')
-    ->setRegion('Москва')
-    ->setCity('Москва')
-    ->setStreet('Пресненская наб.')
-    ->setHouse('д. 10')
-    ->setFlat('эт. 41, Пом. I, комн. 6');
+    ->setZip('123112') // индекс
+    ->setRegion('Москва') // регион
+    ->setCity('Москва') // город
+    ->setStreet('Пресненская наб.') // улица
+    ->setHouse('д. 10') // дом
+    ->setFlat('эт. 41, Пом. I, комн. 6'); // офис
+/* Установим объект юридического адреса сабмерчанта в данных анкеты */
 $qstSchema->setLegalAddress($qstLegalAddress);
 
+/*
+ * Создадим объект фактического адреса сабмерчанта и отметим, что
+ * фактический адрес сабмерчанта соответствует юридическому
+ */
 $qstActualAddress = (new QstSchemaActualAddress())->setChecked(true);
+/* Установим объект фактического адреса сабмерчанта в данных анкеты */
 $qstSchema->setActualAddress($qstActualAddress);
 
-$qstCeoIdentityDoc = (new QstSchemaIdentityDoc())
-    ->setSeries('1234')
-    ->setNumber('123456')
-    ->setIssueDate('2000-01-30')
-    ->setIssuedBy('МВД')
-    ->setIssuedByKP('123-456');
 
+/* Создадим объект удостоверяющего документа и заполним его паспортными данными руководителя организации */
+$qstCeoIdentityDoc = (new QstSchemaIdentityDoc())
+    ->setSeries('1234') // номер паспорта
+    ->setNumber('123456') // серия
+    ->setIssueDate('2000-01-30') // дата выдачи
+    ->setIssuedBy('МВД') // кем выдан
+    ->setIssuedByKP('123-456'); // к/п
+
+/*
+ * Создадим объект руководителя организации.
+ * Установим в него объект с паспортными данными руководителя.
+ * Заполним место и дату рождения, адрес регистрации руководителя
+ */
 $qstCeo = (new QstSchemaCeo())
-    ->setIdentityDoc($qstCeoIdentityDoc)
-    ->setBirthDate('1980-01-30')
-    ->setBirthPlace('Москва')
-    ->setRegistrationAddress('г. Москва, ул. Ленина, д. 1, кв. 1');
+    ->setIdentityDoc($qstCeoIdentityDoc) // объект с паспортными данными руководителя
+    ->setBirthDate('1980-01-30') // дата рождения руководителя
+    ->setBirthPlace('Москва') // место рождения руководителя
+    ->setRegistrationAddress('г. Москва, ул. Ленина, д. 1, кв. 1'); // адрес регистрации руководителя
+
+/* Установим объект с данными руководителя организации в данных анкеты */
 $qstSchema->setCeo($qstCeo);
 
+/* Создадим объект собственника организации, заполним ФИО и долю собственника */
 $qstOwner = (new QstSchemaOwner())->setOwner('Иванов Иван Иванович')->setShare('100');
+/* Добавим объект с данными собственника организации в объект данных анкеты */
 $qstSchema->addOwner($qstOwner);
 
+/* Создадим и заполним объект с банковскими данными организации */
 $qstBankAccount = (new QstSchemaBankAccount())
-    ->setBankBIK('044525700')
-    ->setBankCorAccount('30101810200000000700')
-    ->setBankAccount('40702810100002400756');
-
+    ->setBankBIK('044525700') // БИК
+    ->setBankCorAccount('30101810200000000700') // кор. счет
+    ->setBankAccount('40702810100002400756'); // расч. счет
+/* Добавим объект с банковскими данными сабмерчанта в данные анкеты */
 $qstSchema->addBankAccount($qstBankAccount);
 
+/* Заполним дополнительное поле #1 (при наличии) */
 $qstSchema->setAdditionalFieldByKey(1, 'Доп. поле');
 
+/* Установим объект с данными анкеты в объект анкеты */
 $qst->setSchema($qstSchema);
 
 /* Создадим HTTP-запрос к API */