View source for X-Payments:Managing payments

<noinclude>{{XP manual TOC}}</noinclude>

==Payments Page==
Payments made via X-Payments can be viewed/managed using the 'Payments' page.

{{Note1|'''Note:''' [[X-Payments:Managing_users|Non-root X-Payments users]] may not be able to view this page if they do not have the respective access permissions.}}

On the 'Payments' page, the list of payments is presented in the form of a table:
: [[File:XP2.0_payments.png|border]]

For each individual payment the following information is available:
* '''Reference ID''' - the payment's reference number;
* '''Payment ID''' - the payment's ID number;
* '''Submitted''' - when the payment was submitted;
* '''Online store''' - the online store from which the payment originated;
* '''Status''' - the payment status (See [[#Payment Statuses|Payment Statuses]] for more information);
* '''Last update''' - the last time that the payment was updated;
* '''Amount''' - the payment amount;
* '''Payment configuration''' - the payment configuration that was used to accept the payment;
* '''Customer IP''' - the IP address of the customer who made the payment;

You will see only some of the above information because the 'Payments' table can display no more than six columns simultaneously. To change the set of visible columns in the 'Payments' table:
# Click on the 'Settings' icon in the top right hand corner of the table:<br />[[File:XP2.0_columns.png|border]]
# Unselect the check boxes for the columns you do not need; then, select the check boxes for the columns you want enabled.
# Click '''Apply'''.

It is possible to change the payments' sort order. To change the way the payments are sorted, simply click on the table column headers.

It is possible to filter payments / find specific payments based on certain criteria. See [[#Filtering payments / Advanced search|Filtering payments / Advanced search]]

On the 'Payments' page you can:
* Open the details of a specific payment for viewing;
* Clear cardholder data for some or all payments ('''Note''': The user does not have to have the [[X-Payments:Managing_users|permission]] to view cardholder data to be able to clear cardholder data);
* Delete payments.

==Payment Statuses==

The 'Status' column of the 'Payments' table shows payment statuses. The possible payment statuses are as follows:
* ''New'' - The payment has been initiated, but the result is not known yet (for example, response from the payment gateway has not been received).
* ''Authorized'' - The money in the customer's account has been placed on hold to ensure the availability of funds for capture.
* ''Charged'' - The payment amount has been moved from the customer's account to the merchant's account.
* ''Refunded'' - The payment has been returned to the customer.
* ''Partially refunded'' - The payment has been partially returned to the customer.
* ''Declined'' - The payment has been declined (The payment gateway declined the transaction or cancelled the payment authorization, or the customer refused to complete the payment).

==Filtering payments / Advanced search==

X-Payments allows you to filter the 'Payments' table to find specific payments based on certain criteria:
# X-Payments 2.0 and later: Click the [[File:XP2.0_advanced_search_link.png]] link above the Payments table. In X-Payments 1.0, use the link [[File:Xp-19_custom_filter.gif]]. <br />The 'Advanced search' form opens:<br />[[File:XP2.0_advanced_search.png|border]]
# Use the 'Advanced search' page to provide your search criteria:
#* '''Date''': Select whether the payments should be submitted or updated during the dates you specify below. You can select from 'All dates', 'Day', 'Week', 'Month', 'Year' or 'Specified period. If you select 'Specified period, enter the exact dates below.
#* '''Payment ID''': Enter the ID of the payment you want to be displayed.
#* '''Reference ID''': Reference ID is passed from the shopping cart. It identifies the order, for which this payment is made, on the side of the shopping cart.
#* '''Status''': Select the check boxes next to payment statuses you want to be displayed.
#* '''Amount''': Enter the amount of payments you want to be displayed and select the currency in the third selectbox.
#* '''Online store''': Select which store the payments should come from.
#* '''Payment configuration''': Select the payment configuration, used for payments you want to be displayed.
#* '''Customer IP''': Enter the IP address of the customer, whose payments you want to be displayed.
# Click '''Search payments'''. The 'Advanced search' form disappears. Now you should be able to see a list of payments filtered according to the search criteria you provided.

To clear the 'Advanced search' form and start over:
: X-Payments 2.0 and later: Use the '''Reset form''' button at the bottom of the form.
: X-Payments 1.0: Use the [[File:Xp-20_reset_filter.gif]] link.

==Viewing Payment Details==

To view the details of a specific payment, locate the payment in the 'Payments' table and click on its Reference ID, or click on the 'Details' link pertaining to the payment in the last table column on the right. The 'Payment details' page opens:

: [[File:XP2.0_payment_details.png|border]]

The main section of the 'Payment details' page contains general information about the payment.

Below there is the 'Transaction list' section that displays all the transactions pertaining to this payment.

You may see the following types of transactions:
* ''Auth'': Transaction to place a pending charge or hold on the customer's payment account.
* ''Capture'': Transaction to capture a previously authorized payment amount - fully or partially. Transactions of this type are the result of the merchant using manual capture in a two-step payment flow (See [[X-Payments:User_manual#Auth and capture: Capturing funds|Auth and capture: Capturing funds]]).
* ''Sale'': Transaction to authorize and automatically capture a payment amount (authorization and capture actions are completed simultaneously).
* ''Void'': Transaction to void a previous authorization.
* ''Refund'' - Transaction to return a previously received payment amount from the merchant to the customer - fully or partially.
* ''Info'' - Transaction to obtain information about the current status of handling the payment from the payment gateway.

For example, the image below displays a list of transactions for a payment that was partially refunded. First the payment amount was charged, then a part of the amount was refunded:

: [[File:XP2.0_transaction_list.png|border]]

To see detailed information on a specific transaction:
: X-Payments 2.0 and later: Click [[File:XP2.0_view_transaction_details.png]]. You will see something like the following:<br />[[File:XP2.0_transaction_details.png|border]].<br />If there is [[X-Payments:General_settings#Cardholder Data|stored cardholder data]] associated with the payment, users who have the [[X-Payments:Managing_users|permission]] to view cardholder data can see it in a separate section on the right-hand side of the screen. If no stored cardholder data is available, the section is displayed like so:<br />[[File:XP2.0_cardholder_data_not_available.png]]<br />
: X-Payments 1.0: Click [[File:Xp-26_additional_info.gif]]. You will see something like the following:<br />[[File:Xp-additional_info.gif|378px]]

==Deleting payments==

To delete a payment, do one of the following:
* '''On the 'Payments' page''':<br />Select the payment(s) you wish to delete and click the '''Delete''' button.
* '''On the 'Payment details' page''':<br />X-Payments 2.0 and later: Click the [[File:XP2.0_delete_this_payment.png]] link. Confirm the deletion.<br />X-Payments 1.0: Click the [[File:Xp-28_delete_payment_link.gif]] link. Confirm the deletion.

==Clearing cardholder data==

Stored cardholder data for some or all payments can be removed via the 'Payments' page:
To remove cardholder data for specific payments, select the check boxes next to them and click the '''Clear cardholder data''' button.
To remove all stored cardholder data, click the '''Clear all cardholder data''' button.

It is also possible to remove stored cardholder data for a specific payment via the 'Payment details' page of that payment: click the '''Clear cardholder data''' link in the section that displays stored cardholder data.

==Auth and capture: Capturing funds==
{{X-Payments:Auth_and_Capture}}

==Voiding authorizations==
Depending on the payment gateway you use, you may be able to void authorizations.

'''To void an authorization''':
# On the 'Payments' page, locate the payment for which you want to void an authorization and open its details for viewing. The 'Payment details' page opens.
# On the 'Payment details' page, locate the section for Capture/Void actions:<br />X-Payments 2.0 and later:<br />[[File:XP2.0_capture_void.png]]
# Click '''Void'''.<br />X-Payments 1.0:<br />[[File:Auth_capture2.gif|border]]

Note that once an authorization has been voided, you will no longer be able to capture the payment - it will be declined.

==Issuing refunds==
Depending on the payment gateway you use, you may be able to refund payments received from your customers - fully or partially.

'''To issue a refund''':
# On the 'Payments' page, locate the payment for which you want to make a refund and open its details for viewing. The 'Payment details' page opens.
# On the 'Payment details' page, locate the section for Refund actions:<br />X-Payments 2.0 and later:<br />[[File:XP2.0_refund.png]]
# Click '''Refund'''.

'''ATTN users of Authorize.Net CIM''':
# Users of X-Payments versions prior to X-Payments 2.2.0 may find that they are unable to issue refunds for some Authorize.Net CIM transactions. This is typically the case for transactions that have not yet been submitted for settlement. It is normal because for Authorize.Net CIM transactions funding takes place after settlement; before settlement no money can be returned to the buyer since no money has yet been captured. After settlement, the issue resolves on its own. In X-Payments 2.2.0 we implemented "smart refunds": if a refund transaction cannot be completed successfully, we automatically attempt to void the initial transaction. 
# To ensure the correct processing of Authorize.Net CIM refunds, you need to make sure that the option selected in the "Expanded Credit Capabilities" setting in the payment configuration for Authorize.Net CIM in X-Payments matches the respective setting in your merchant account. More information on Expanded Credit Capabilities (ECC) is available here: https://www.authorize.net/support/CP/helpfiles/Miscellaneous/Pop-up_Terms/Expanded_Credit_Capabilities.htm

==Accept/Decline: Managing High Risk Transactions==
Some payment gateways provide merchants with fraud protection tools that allow them to identify potentially fraudulent transactions and manage their own fraud risk – to make their own decisions about which payments to accept or decline.

For example, some payment solutions by PayPal allow the merchant to set up Fraud Protection filters which make it easier for the merchant to detect and respond to fraudulent transactions. Depending on the merchant's preferences, the transactions identified as having a higher likelihood of risk can be rejected or held pending for review by the merchant so the merchant can explicitly accept or deny the payment.

X-Payments supports this feature for some payment gateway integrations (See [[X-Payments:Supported_payment_gateways | Supported payment gateways]], "Accept" and "Decline" columns).

When a transaction is identified as high-risk by the payment gateway, the payment gets the ''Authorized with warning''/''Charged with warning'' status in X-Payments:
:[[File:XP_charged_with_warning.png|border]]

The following section appears on the 'Payment details' page for the payment:
:[[File:XP2.0_accept_decline.png]]
You can use the '''Accept''' and '''Decline''' buttons in this section to specify whether you want to accept or decline the transaction.

If the transaction is accepted, the payment status is updated from ''Authorized with warning'' or ''Charged with warning'' to simply ''Authorized'' or ''Charged''.
If the transaction is declined, the payment becomes ''Declined''.

==Emulating transactions==
{{X-Payments:Emulating_transactions}}

==Tokenization and Re-Use of Saved Credit Cards (X-Payments 2.x and later)==
{{X-Payments:Tokenization_and_Re-Use_of_Saved_Credit_Cards_(X-Payments_2.x_and_later)}}

<noinclude>__NOTOC__</noinclude>


<noinclude>{{pdf_single}}</noinclude>

[[Category:X-Payments User Manual]]