.. meta:: :description: Руководство по интеграции с Платёжным Шлюзом Payneteasy: сценарии использования API, справочник команд, интеграция mPOS и полные инструкции для Присоединяющихся Сторон. .. _connecting_party_integration_introduction: Введение ######################################## .. toctree:: :maxdepth: 2 :numbered: 2 :hidden: self api_use_cases_index general_api_usage_index API_commands_index mpos_api_index common_utilities_index reference_index openapi .. contents:: :local: .. role:: ex .. role:: code Обзор Платёжного Шлюза ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. role:: code .. role:: ex «Платёжный Шлюз Payneteasy» (далее — Система, Платёжный Шлюз или Payneteasy) — это платформа, сертифицированная по стандарту PCI DSS, которая обеспечивает приём, обработку, хранение и передачу платёжных данных между участниками платёжных процессов. Основные участники: .. list-table:: :widths: 25 75 :header-rows: 0 :class: longtable * - Плательщики или Получатели - конечные клиенты Торговцев. * - Присоединяющаяся Сторона - сами Торговцы, PSP/платёжные институты, представляющие Торговцев, или сторонние системы обмена данными (CRM, BI, мониторинг). * - Процессоры - интегрированные внешние платёжные институты и платёжные провайдеры. Payment Gateway provides the following methods of accepting payment data: 1. API available on the Internet 2. POS-terminals 3. Virtual terminal for manual entry of payment data, received by e-mail and phone Платёжный Шлюз предоставляет доступ к учётным записям пользователей. В нём предусмотрены следующие роли пользователей. Каждая корневая сущность может иметь собственных Сотрудников, которые могут получить доступ к данным корневой сущности, но с определёнными ограничениями: .. list-table:: :widths: 20 80 :header-rows: 0 :class: longtable * - Торговец - предоставляется представителям Торговца (Присоединяющейся Стороне). * - Реселлер - предоставляется агенту, привлекающему Торговцев в Платёжный Шлюз. * - Менеджер - предоставляется представителям Платёжного Шлюза. .. note:: Все определения терминов см. в :ref:`Глоссарии `. .. ifconfig:: openapi_doc == True The Payment Gateway API is also published as a machine-readable `OpenAPI 3.1 specification `_ — use it to explore the API interactively in your browser, generate client SDKs, or integrate with AI coding assistants. See the OpenAPI Specification page for details. .. _connecting_party_integration_scenarios: Сценарий интеграции Присоединяющейся Стороны ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ В зависимости от соответствия требованиям PCI и бизнес-требований Присоединяющаяся Сторона интегрируется с Платёжным Шлюзом через API Server-to-Server, API размещённых платёжных форм или их сочетание. Каждый вариант интеграции описан в разделе :ref:`Сценарии использования API`, и каждый сценарий использования API содержит чёткие инструкции, какие :ref:`API команды` вызывать на каждом этапе платёжного процесса и как обрабатывать их результаты. Все API являются :ref:`асинхронными`. Раздел :ref:`Общие утилиты` содержит дополнительные сервисы, которые могут быть включены по запросу. Страница :ref:`FAQ` помогает решать типовые вопросы при интеграции Присоединяющейся Стороны. Менеджер службы поддержки Payneteasy настраивает Проекты с подключёнными Endpoint и Группами Endpoint (при необходимости) для одной или нескольких учётных записей Торговца Присоединяющейся Стороны в Платёжном Шлюзе. Для интеграции по API Присоединяющаяся Сторона получает от Payneteasy следующие данные. Эти данные могут быть предоставлены независимо для sandbox (тестовой) и производственной среды. Все дополнительно необходимые учётные данные указаны в соответствующих сценариях использования API. Main required credentials are: 1. Endpoint IDs per currency or Endpoint Group IDs for multicurrency integration (see reference schema below). 2. Торговец login. 3. Торговец control key. 4. Integration scenario documentation. .. uml:: :align: center title Options for multi-currency processing integration package "Integration to Endpoint Group" { class "layoutHelper1" #ffe6cc;line:black;line.dotted class "Project\n currency A" #dae8fc;line:black;line.dotted class "Project\n currency B" #dae8fc;line:black;line.dotted class "Endpoint\n currency A" #ffe6cc;line:black;line.dotted class "Endpoint\n currency B" #ffe6cc;line:black;line.dotted class "Endpoint\nGroup" #ffe6cc;line:black;line.dotted } package "Integration to multiple Endpoints" { class "layoutHelper2\n" #ffe6cc;line:black;line.dotted class "Project\n currency C" #dae8fc;line:black;line.dotted class "Project\n currency D" #dae8fc;line:black;line.dotted class "Endpoint\n currency C" #ffe6cc;line:black;line.dotted class "Endpoint\n currency D" #ffe6cc;line:black;line.dotted } class "layoutHelper3" #ffe6cc;line:black;line.dotted class "Присоединяющаяся Сторона\n (Торговец)" #e1d5e7;line:black;line.dotted "Присоединяющаяся Сторона\n (Торговец)" -left-> "Endpoint\nGroup" "Присоединяющаяся Сторона\n (Торговец)" -down-> "layoutHelper3" "Присоединяющаяся Сторона\n (Торговец)" -down-> "Endpoint\n currency C" "Присоединяющаяся Сторона\n (Торговец)" -down-> "Endpoint\n currency D" "Endpoint\nGroup" -down- "Endpoint\n currency A" "Endpoint\nGroup" -down- "Endpoint\n currency B" "Endpoint\n currency C" -down- "Project\n currency C" "Endpoint\n currency D" -down- "Project\n currency D" "Endpoint\n currency A" -down- "Project\n currency A" "Endpoint\n currency B" -down- "Project\n currency B" "Присоединяющаяся Сторона\n (Торговец)" -left[hidden]- "layoutHelper1" "Присоединяющаяся Сторона\n (Торговец)" -right[hidden]- "layoutHelper2\n" "layoutHelper1" -[hidden]- "Endpoint\n currency A" "layoutHelper1" -[hidden]- "Endpoint\n currency B" "layoutHelper2\n" -[hidden]- "Endpoint\n currency C" "layoutHelper2\n" -[hidden]- "Endpoint\n currency D" hide members hide circle hide layoutHelper1 hide layoutHelper2\n hide layoutHelper3 Пример интеграции Присоединяющейся Стороны ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1. :ref:`Sale Form` - интеграция обработки sale-транзакций электронной коммерции через размещённую платёжную форму. 2. :ref:`Возвратные транзакции` - интеграция обработки возвратов. 3. :ref:`Обратные вызовы Присоединяющейся Стороны` - получение данных о транзакциях в CRM, BI и другие системы. 4. :ref:`Настройка форм` - брендирование размещённых платёжных форм и предоставление их менеджеру службы поддержки Payneteasy для установки. 5. Протестируйте решение в sandbox с :ref:`тестовыми сценариями` Payneteasy. 6. Сообщите менеджеру службы поддержки Payneteasy об успешном завершении тестирования и запросите производственные учётные данные для начала обработки платежей. Типы транзакций Платёжного Шлюза ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Транзакция — это операция перевода денежных средств между счетами. Платёжное решение Payneteasy поддерживает все распространённые типы транзакций, связанные с банковскими картами и альтернативными способами оплаты. Транзакции могут быть инициированы через API-команды, упомянутые в соответствующих сценариях использования, через Виртуальный терминал и другими способами. **Платежи:** .. include:: description_sale.rst .. include:: description_preauth.rst .. include:: description_cancel.rst .. include:: description_capture.rst .. include:: description_reversal.rst .. include:: description_void.rst .. include:: empty.txt .. include:: empty.txt **Диспутные и сервисные транзакции:** .. include:: description_fraud.rst .. include:: description_retrieval.rst .. include:: description_chargeback.rst .. include:: description_cb_reversal.rst .. include:: description_prearbitration.rst .. include:: description_arbitration.rst .. include:: empty.txt .. include:: empty.txt .. include:: empty.txt