.. _connecting_party_integration_introduction:

General 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

.. toctree::
   :maxdepth: 3

.. contents::
   :local:

.. role:: ex

.. role:: code

Payment Gateway overview
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. contents::
    :local:

.. role:: code

.. role:: ex

“Payneteasy Payment Gateway” (here and hereafter System, Payment Gateway or Payneteasy) is a PCI DSS certified platform, which provides accepting, processing, storage and transmitting of payment data between participants of payment processes.

Main participants:

.. list-table::
  :widths: 25 75
  :header-rows: 0
  :class: longtable

  * - Payers or Receivers
    - end customers of merchants.
  * - Connecting Party
    - merchants themselves, PSP/Payment institutions which represent merchants, or third-party systems for data exchange (CRM, BI, monitoring).
  * - Processors
    - integrated external payment institutions and payment providers.

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

Payment Gateway provides access to user accounts. It has the following user roles. Each root entity, can have its own Employees who can get access to the data from the root entity, but with certain restrictions:

.. list-table::
  :widths: 20 80
  :header-rows: 0
  :class: longtable

  * - Merchant
    - provided to the merchant’s representatives (Connecting Party).
  * - Reseller
    - provided to the agent, which engage merchants for Payment Gateway.
  * - Manager
    - provided to the representatives of Payment Gateway.

.. note::
    See all terms definitions in :ref:`Glossary <glossary>`.

.. _connecting_party_integration_scenarios:

Connecting Party integration scenario
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Depending on the PCI compliance and business requirements, Connecting party integrates to Payment Gateway via Server-to-Server APIs, Hosted payment form APIs or a combination of them. Each integration option is provided in :ref:`API Use-Cases<api_use_cases>` section, and each API Use-Case provides clear instructions which :ref:`API commands<API_commands_callbacks_redirects>` to call on each stage of the payment flow and how to handle their results. All APIs are :ref:`asynchronous<asynchronous_response>`. :ref:`Common utilities<common_utilities>` section provides added value services which might be enabled by request. :ref:`FAQ<FAQ>` page helps to resolve common issues during Connecting Party integration.

Payneteasy support manager configures Projects with connected Endpoints and Endpoint Groups (if needed) for one or multiple merchant accounts of Connecting Party in Payment Gateway. For API integration, Connecting party receives the following data from Payneteasy. This data can be provided independently for sandbox (test) and production environment. Any additional required credentials are mentioned in relevant API Use-Cases.

Main required credentials are:
1. Endpoint IDs per currency or Endpoint Group IDs for multicurrency integration (see reference schema below).
2. Merchant login.
3. Merchant 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 "Connecting Party\n (Merchant)" #e1d5e7;line:black;line.dotted

  "Connecting Party\n (Merchant)" -left-> "Endpoint\nGroup"
  "Connecting Party\n (Merchant)" -down-> "layoutHelper3"
  "Connecting Party\n (Merchant)" -down-> "Endpoint\n currency C"
  "Connecting Party\n (Merchant)" -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"
  "Connecting Party\n (Merchant)" -left[hidden]- "layoutHelper1"
  "Connecting Party\n (Merchant)" -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

Connecting Party integration example
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

1. :ref:`Sale Form<sale_C>` - integrate hosted payment form processing of E-commerce sale transactions.
2. :ref:`Return transactions<return_transactions>` - integrate processing of refunds.
3. :ref:`Connecting Party callbacks<merchant_callbacks>` - receive transaction data to CRM, BI and other systems.
4. :ref:`Forms customization<forms_customization_reference>` - brand hosted payment forms and provide them to Payneteasy support manager for installation.
5. Test the solution on sandbox with Payneteasy :ref:`test scenarios<test_cards>`.
6. Inform Payneteasy support manager about successful finish of testing and request production credentials to start processing payments.


Payment Gateway Transaction Types
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Transaction is the operation of money transfer between accounts. Payneteasy payment solution supports all common types of transactions associated with bank card and alternative payments. Transactions can be initiated via API-commands mentioned in corresponding Use-Cases, Virtual terminal, and other methods.

**Payments:**

.. 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:: description_transfer.rst
.. include:: description_payout.rst

**Dispute and Service transactions:**

.. 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:: description_account_verification.rst
.. include:: empty.txt
.. include:: description_pan_eligibility.rst