View source for Payment methods in Websky

==Payment methods in Websky==

Payment methods can be divided into the following groups:
* '''Payment Gateways Online''' are payment methods where Websky interacts with an external payment gateway and receives payment statuses for orders automatically online (see [[Payment Gateways]] for details):
** ''' Card payment gateways'''.
** ''' Gateways for paying by cache'''.
<br> For more information about online payment methods see [[payment gateways]]).
* '''Payment methods with manual status fixation''' - payment methods where Websky does not interact with external payment gateways and the payment status is changed manually by agency staff:
** '''[[Payment in office]]''',
** '''Payment by account (receipt/invoice)''',
* Payment by funds from the company's balance or available overdraft account in Websky system:
** '''Payment via [[Company Balance ]]'''.

==Payment process in Websky==
The direct process of payment acceptance always takes place outside Websky. The system only records the final status of the transaction received from the outside. There are two ways to assign a payment transaction status:
<!--[[File:Удалить_запись_об_оплате.png|705px|thumb|Payment transactions window]]-->
* '''Automatically''' - automatic change of transaction status occurs when interacting with external payment gateways, when payment gateway sends payment status by transaction or other status.
* '''Manually''' - the payment status can be fixed manually without interaction with external payment gateways using buttons:
** '''Record payment''' - assigns a payment attribute to the order in Websky.
** '''Delete payment record''' - deletes the payment attribute in Websky without actual refund. '''Attention!''' The operation does not imply interaction with payment gateways; payment is not cancelled.

===Payment transactions===

'''Websky Payment Transaction''' is an object that manages and stores the state of one payment per order.

The term '''transaction''' implies:
* maximum (but not complete) integrity of a single Websky payment transaction;
* absolute unrelatedness between payments;
* conflict protection (parallel access to the transaction object by different scripts is prohibited).

When you switch to payment by any payment method '''a payment transaction is created''' for this operation. Transactions are assigned to their own "individual identifier" (the number is also called billing). At the moment of switching to a payment gateway, the transaction fixes the amount to be paid in a certain currency (the amount that the user has to pay at a remote gateway). This amount ''does not change'' until the payment is completed, even if the order amount in Websky changes, regardless of the reason for the change (the price in GDS has changed or the price was changed manually, for example, by adding new services).

After the successful payment at a remote gateway, the transaction is marked as pre-authorized or successfully paid. Paid amount for the order is equal to the amount to be paid for all transactions in the status of preauthorized or paid.
* If the amount to be paid is "less" than the price of the order, the order is marked as '''Partially Paid'''. This order cannot be ticketed automatically, but it can be forcibly ticketed by the agency staff.
* If the amount to be paid is "more or equal" to the price of the order, the order gets the status "Paid" - automatic ticketing is started (if it is enabled by the settings).

During the ticketing process, if there is no failure on the part of the remote gateway, the paid payments that require confirmation (transactions in the "Preauthorized" status ) will be confirmed.
If the order is "partially paid", you can pay it by clicking the "Pay" button again. The amount in the transaction will be displayed as a necessary amount to recognize the order as paid.

==== Order actualization process ====
# In Websky, you can check for price increases immediately when you switch to payment. When the price increases, the user is offered a choice: pay more or return to the order.
# In case of a failure on behalf of the Websky system, a universal script for checking payment transaction relevance is launched (available only for the following PGs: Sberbank, Uniteller, Chronopay, Sirena2, ECPayment). The script is launched for transactions:
## created in the last 3 hours and in new or ready status.
## Created during the last 24 hours with locked funds.
## Updates are launched by the schedule:
<table style="margin-left:23px;" class="wikitable">
 <tr>
  <td>Update number</td><td>1</td><td>2</td><td>3</td><td>4</td><td>5</td><td>6</td><td>7</td><td>8</td><td>9</td><td>next</td>
 </tr>
 <tr>
  <td>Time</td><td>after 5 min.</td><td>after 10 min.</td><td>after 15 min.</td><td>after 25 min.</td><td>after 40 min.</td><td>after 60 min.</td><td>after 1 h. 30 min.</td><td>after 2 h.</td><td>after 3 h.</td><td>once per hour for up to 24 hours</td>
 </tr>
</table>

<!--[[File:Ссылка_на_Платёжные_транзакции.png|205px|thumb|Link to Payment Transactions]]-->

====Information on payment transactions====

To access payment transaction information, open the '''service information''' on the order page (available only to agency managers and experts) and click the '''Payment transactions''' button located at the bottom of the "Payment information" block. This link is also available in your personal account in the '''Actions''' column.

In the logging system, there is a '''Billing''' column for records related to payment transactions. The field of this column contains the number of the last transaction in the log.

== Setting up payment methods in Websky ==

You can start and set up payment methods in the '''Finances''' section.

===Managing user access to payment methods===
In the '''Finances → Payment methods → Gateway access settings''' section, agent can set up availability of payment methods for users/groups/companies:<br>
* Select the object of settings application in the '''User''' field.
* Enable the payment methods allowed to the user and disable the prohibited ones.
'''Attention!''' The '''Enable new version''' option must always be <u> enabled</u>. This option activates the advanced payment acceptance module '''Payments 2.0'''.

===Setting up and managing payment methods===
On the '''Gateway Management''' page, you can set up descriptions and parameters of payment gateways available in the system.

The '''Gateway Management''' page displays a table of payment methods which contains all payment methods of the selected object (in the "User" field), as well as:
* brief information about each payment method you have set up,
* links to edit parameters of the payment method <!--[[File:Ссылка на Редактирование параметров.png]]-->, 
* links to payment method filtering settings, 
* links to set up payment method details,
* payment method removal buttons <!--[[File:Кнопка удаления.png]]-->.

<!--{| class="wikitable"
|-
|[[File:Таблица_платёжных_методов.png|1100px|Payment methods table in Websky]] 
|-
|Payment methods table in Websky
|}-->

====Payment method creation====
To create a new payment method:
# Go to '''Finances → Payment Methods → Gateway control'''.
# Click on '''Create new entry'''.
# Set the parameters for the payment gateway and click on '''Save'''.

The payment method will appear in the payment method table on the '''Gateway control''' page.

====Payment Method Settings====

* '''Payment gateway name''' - the name of the payment gateway displayed on the page of payment methods selection.
* '''Payment information through this gateway''' - additional information displayed on the page of choosing payment methods and after choosing a specific payment method.
* '''Scenario of payment gateway''' - configuration of the 'Payments 2.0' module that allows you to describe the scenario of actions that will take place during the payment process. The setting is available for all payment gateways on Booking form 2.0. WYSIWYG is used to edit the script text. If the text is missing, the setting text "Payment information through this gateway" will be displayed in its place.
<!--[[File:Script Display_on_web.png|300px|thumb|right| Script Display after payment selection]]-->
* '''Payment result''' - this setting allows you to specify the text that will be displayed at the top of the order page when a user returns from the payment page.
* '''Button text''' - the text of the current payment method selection button.
* '''Link to the gateway logo (not available on all topics)''' - adds the image specified by the link, opposite the name of the payment gateway.
* '''The markup''' - the amount of the markup for payment determined by the agency's agreement with the SS. The markup - the fee of the payment gateway for payment, its size is set on the side of the payment gateway.
* '''Type of rule''' - specifies the type of calculation of the markup:
** '''Percent''' - the percentage is calculated from the total amount to be paid.
** '''Value''' - the sum of the specified currency (specify the currency in the parameter ''Currency of markup''), is added to the total amount to be paid.
* '''The markup is not less than''' - minimum markup limitation (according to the agency's contract with SS).
* '''The markup is not more than''' - the maximum markup limitation (according to the agency's contract with the Staff Pension Agency).
* '''Type of rule for limits''' - percentage/value, indicates how to perceive the markup restrictions, interests or absolute values.
* '''Savings currency''' - specifies the currency of markup calculation, if the markup or its limits are specified in absolute values.
* '''Payment method to display at least X hours before the service start''' - indicates the minimum whole number of hours before the service start, at which the payment method will be available to choose.
* '''Payment method to display at least X hours before the time limit''' - specify the minimum whole number of hours before the cancellation, at which the payment method will be available for selection.
* '''Order number on the payment selection page''' - enables you to specify the order number, under which the payment service will be displayed on the payment page.
* '''Source for gateway filtering''' - in combination with the 'Source matching' setting enables you to redefine the payment gateway behavior in Websky depending on the metric module transition source. It is necessary to specify the source number from the source table of the metric module. To specify several sources, you need to list them by comma without spaces, for example, "23,48,56".
* '''When the source coincides''' - defines additional behavior: 
** '''do nothing''',
** '''do not show in the list of payment methods''' - this payment gateway will not be available on the page of payment methods selection,
** '''do not apply the fee''' - the surcharge of the payment gateway will be equal to 0.
* '''Text transmitted in the remark to the GDS (Invoice)''' - the payment form is transmitted to the GDS, occurs at the stage of issuing the remark.
* '''Possibility of payment initialization before booking''' - this setting allows to display iframe of bank card before booking.
* '''Prohibition of automatic refunds when the price changes''' - this setting regulates automatic refund to the client. If the order value has increased by the time the status of successful payment is obtained, there is no automatic refund.
* '''Adding order number from Websky to the new payment identifiers''' - the setting affects the formation of the transaction number during the initialization of the payment, applies to new payments. If this setting is enabled, the payment ID will be the order ID + "_" + transaction ID. Works for PayOnline, Sirena2, Platron, Sberbank / roseurobank, WayForPay(PayU) payment gateways. For PG Uniteller, the setting is always active.

=== Filtering of payment methods===
After creating a payment method record in Websky, you can configure payment method filtering.

Filtering of payment gateways is used to automatically adjust availability of different payment methods for orders by specified parameters. Using filtering you can limit availability of different payment methods for different components (air tickets, railways, hotels), suppliers, order amounts, etc.

Availability conditions of the payment gateway are set individually for each record of the payment gateway using the filtering parameters. <br>If a payment gateway is available for payment of an order, the order must fit all conditions of the payment method filtration: 
<br>If the order parameters ''meet all conditions'' of the payment method filtration, then the payment method '''is available''' for selection as a payment method,
* if the order parameters ''do not fit at least one condition'' of the payment method filtering, the payment method '''is not available''' for selection as a payment method.
</u>'''All filtering settings are optional.'''

For specifying the conditions of payment method filtering:
# Open '''Finances → Payment methods → Gateway control'''.
# For the required payment method, in the "Actions" column click on the '''Filtering''' link.
# Set the filtering conditions for the payment gateway and click on the button '''Save'''.

====Payment method filtering parameters====
* '''Payment gateway enabled''' - the option enables/disables the payment method.
* '''Supplier''' - filtering by components and selected suppliers. The "Ticket exchange" option allows you to enable selection of this payment method when exchanging tickets.
* '''Requisite''' - use this option to specify specific details of the supplier.
* '''Source''' - using this option, you can enable access to payment using the payment method only when the transition was made from the source specified in the field (from [[Metrics module]]). The numeric ID of the transition source (comma) is specified.
* '''All sources except''' - using this setting you can disable access to payment via payment method if the transition was made via the source specified in this field. <br> '''Attention!''' The value must not intersect with the values from the field '''Source'''!
* '''Airlines''' - is used to set the filter by airlines,
* '''Display if the order amount is less than''' - the maximum order amount at which the payment method is available to choose.
* '''Display if the order amount is more than''' - the minimum order amount at which the payment method is available to choose.
* '''Display payment method not less than X hours before the beginning of the service''' - specify the minimum whole number of hours before the beginning of the service, at which the payment method is available in the option.
* '''The payment method to display at least X hours before the time limit''' - specify a minimum whole number of hours before the cancellation, at which the payment method will be available for selection.
* '''Allowed settlement currency (any from the list, if no values are selected) - using this setting you can specify the list of currencies, with which the selected payment gateway will work.
* '''Users with access to the payment method''' - either company names or logins/names of users, for whom this payment method will be displayed, are entered into the field. If no company/user is specified in the field, the payment method will be displayed for all.
* '''Users without access to the payment method''' - either company names or logins/names of users, for whom this payment method will be displayed, are entered into the field. If no company/user is specified in the field, the payment method will be displayed for all.

'''Attention!''' If the payment method is enabled in the filtering settings and the payment method is disabled on the ''Access to payment methods'' page, then the payment method <u> will not be available for selection</u>.

===Other payment method settings===

In the '''Finances → Payment methods → Outdated version → Main settings''' section, there are some other payment method settings.

<table border="1" cellspacing="0" cellpadding="3" class="wikitable">
<tr>
<th>Option</th>
<th>Possible values</th>
<th>Description</th>
</tr>
<tr>
<td>You can change the payment method</td>
<td>On / Off</td>
<td>If the setting is set to "Enabled", you can change the payment method after the order has been paid.</td>
</tr>
<tr>
<td>Quick account editing</td>
<td>No / Yes</td>
<td>If this option is enabled, the user for whom the account is opened has access to the account editing table. If not enabled - only certain users (manager and group users) can edit. '''Attention!'''It is recommended not to enable this setting.</td>
</tr>
<tr>
<td>Set the status only if there is confirmation from the external system</td>
<td>No / Yes</td>
<td>If the value of the "Yes" option is set, the order will be considered as paid only in case of payment in Websky system and transaction confirmation from the external system.</td>
</tr>
<tr>
<td>Orders from Sirena must be paid for by cards only through the Sirena (if the gateway is available).</td>
<td>No / Yes</td>
<td>If the setting is enabled, the algorithm is as follows:<br/>If several bank card payment systems are available, including the Sirena payment gateway, then:<br/>1) if the order is not from GDS Sirena Travel, then all bank card payment systems except PG Sirena become unavailable<br/>2) if the order is not from GDS Sirena, then Sirena PG is unavailable</td>.
</tr>
<tr>
<td>Tolerance, value</td>
<td>Number</td>
<td>The value of the tolerance amount.</td>
</tr>
<tr>
<td>Tolerance, currency</td>
<td>Drop-down list</td>
<td>Name of currency of tolerance sum.</td>
</tr>
</table>

'''Tolerance amount''' is the amount that the agent is willing to "forgive" the client in case of an increase in the order price. It is possible to ticket and add to the order a slight increase in price as a discount to increase the conversion. If the price increase does not exceed the value of this setting and the value of agency fee and airline commission, the difference in price is written as a discount to the order. The total price is not changed and payment is not interrupted. It is possible to set up only for an agency.

== Payment gateway icons ==

Для того, чтобы выставить иконку для платёжного шлюза, необходимо воспользоваться стилизацией.
Необходимо зайти в  “Site management” → “Appearance setting” and add the required code.
sample:
 .new-flights-passInfo__pay__method__logo_XXX {
    background-image: url('path/to/image.svg');
 }
Where "XXX" is the name of the payment gateway, which can be viewed in the browser inspector.

==Payment gateway name translation==
To translate the name of the payment gateway it is necessary to, in '''Finances → Payment Methods → Gateway control''' section, select the desired language in the upper right corner of the page, then edit the payment gateway record, specifying the name in the selected language. 


<!--{| class="wikitable"
|-
|[[File:Перевод названий платежных шлюзов.png|1000px]]
|-
|Translation of payment gateway names
|}-->

==Increase in order amount==

If the price of the paid but not issued order increases, the system will activate the possibility of paying the difference of the amount received after modifications in the order.
You can pay for the order only if the validity of the ticketing is available, but the order has not been ticketed yet, or if after the statement you have chosen ancillary services to be paid for.


== Connecting new payment methods == 

If you need a payment method that is not yet integrated into the Websky system, you can use the Payment Gateway API service, which allows you to quickly connect any payment solution.<br>
or more information, see the article [[Integration of payment acceptance services using Payment Gateway API]]

==See also==
*[[Payment Gateways]]
*[[Account]]
*[[Receipt]]
*[[Payment in office]]
*[[Company balance]]
*[[Integration of payment acceptance services using Payment Gateway API]]