.. _/api/v4/payout-form:

Payout Form
===========

.. contents::
  :local:

.. role:: ex

.. role:: code

Introduction
------------

| Payout-form is a type of transaction which results in funds transfer from Connecting Party banking account to customer (receiver) banking account or digital wallet. Payout-form transaction in most cases is used for bank account funding. Unlike Server-to-Server Payout integration, in which Connecting Party sends receiver account in initial request, Payout Form integration allows the receiver to submit the banking account credentials on the form hosted on Payneteasy side.
|
| See terms definitions in :ref:`Glossary<glossary>`.
|

1. Receiver fill out a payout form and sends data;

.. image:: /_static/images/payout_v4_flow/payout_v4_payment1.png
  :alt: Payment Form
  :align: center
  :width: 550

2. Contextual data is gathered by Payneteasy to process the transaction;

.. image:: /_static/images/3ds_server_to_server_sale_flow/wait_form.png
  :alt: Wait Form
  :align: center
  :width: 550

3. Receiver’s browser gets redirected to the Connecting Party website to the resultant page.

.. image:: /_static/images/payout_v4_flow/payout_v4_finish.jpg
  :alt: Finish Form
  :align: center
  :width: 550


Payout Form Flow
----------------

.. uml::
  :align: center

  participant Receiver as R
  participant "Connecting Party" as Cp
  autonumber
  group optional
  R -> Cp : Checkout
  activate Cp
  end
  == Payout form request ==
  Cp -> Payneteasy: /api/v4/payout-form/
  activate Payneteasy
  Payneteasy --> Cp: Order ID\nredirect-url
  deactivate Payneteasy
  Cp --> R : Redirect to Payout Form\nredirect-url
  deactivate Cp
  activate R
  R -> Payneteasy : GET redirect-url
  deactivate R
  activate Payneteasy
  Payneteasy --> R : Payout Form
  deactivate Payneteasy
  activate R
  R -> Payneteasy : Submit Form
  deactivate R
  activate Payneteasy
  Payneteasy --> Payneteasy : Process payout
  == Final redirect of Receiver ==
  Payneteasy --> R : Connecting Party website redirect_url
  activate R
  R -> Cp : POST status,Order ID
  deactivate R
  activate Cp
  group Get Final Status
  == Receive Connecting Party Callback ==
  Cp <- Payneteasy : Callback with Final Status
  Payneteasy <-- Cp: HTTP 200
  deactivate Payneteasy
  == Order Status request ==
  Cp -> Payneteasy: Get status by Order ID\napi/v2/status
  activate Payneteasy
  Payneteasy --> Cp : Response\nstatus,order-stage
  deactivate Payneteasy
  end
  group Optional
  Cp --> R: Show result
  deactivate Cp
  end

| (1) Payout-form can be initiated by Connecting Party based on internal business model or Receiver’s request.
| (2) To implement payout-form see :ref:`/api/v2/payout/form/`.
| (9) To implement final redirect see :ref:`Final Redirect<final_redirect>`.
| (11) To implement callback with final status handling see :ref:`Connecting Party Callback<merchant_callbacks>`.
| (13) To implement order status request see :ref:`/api/v2/status/</api/v2/status/>`. Status should be requested multiple times with 3-5 seconds interval until final status will be received in response.
| (15) Final Status can be sent by Connecting Party based on internal business model or by Receiver’s request.