X-Payments:Configuring the connection to X-Payments in the Magento Admin panel - Magento Connector versions prior to 1.8.0

From X-Payments Help
Jump to: navigation, search

After configuring the connection to your Magento store in X-Payments, log in to your Magento Admin panel and complete setting up the connection on the Magento end.

The following procedure assumes that:



After configuring the connection to your Magento store in X-Payments, log in to your Magento Admin panel and complete setting up the connection on the Magento end.

Complete the following steps:

  1. Log in to the Admin panel of your Magento store.
  2. Go to System -> Configuration:
    Sysconfig xpconnector1.png

  3. In the left-hand side menu, select X-Payments connector:
    Sysconfig xpconnector2.png

    This opens the 'X-Payments Connector Settings' section:
    Connector settings.png

  4. Configure the connection settings needed for your Magento store to interact with X-Payments:
    • X-Payments configuration bundle: This is where you need to paste the configuration bundle you copied earlier while in the X-Payments back end.
    • IP addresses for X-Payments callbacks: Use this field to enter the IP addresses from which your X-Payments callbacks will originate.
      Comment: X-Payments will send callback requests to your store from specific IP addresses. To ensure that your store accepts callback requests only from these IP addresses, specify the allowed IP addresses here as a comma-separated list. Note that the address "127.0.0.1" may not be used here. For better understanding of what IP address(es) to put here, see Callback from X-Payments to the store.
    • Payment currency: Specify the currency in which payments that will be made via X-Payments will need to be processed. The currency specified here should be the same as the currency specified in the settings of the X-Payments payment configuration connected to your Magento store (You can check the payment configuration details in the X-Payments back end).
    • Setup minimum payment amount for recurring orders and customer card authorization actions: Use this field to set the minimal authorization amount for recurring subscriptions ordered with start date in the future and customer card authorization actions.
      Comment:When a customer purchases a recurring subscription with a start date in the future or chooses to save their credit card with your store for future payments, you need to run an authorization against their card to have the card details saved by the payment service provider and to obtain a token which will later need to be submitted for any future authorization/charge requests for that customer to use their card for payment. By default the Magento X-Payments integration performs a zero value authorization on the customer's card in this case. However, some payment service providers do not support zero value authorizations. If this is the case with the PSP you are using for your Magento store, you need to adjust the authorization amount value in the "Setup minimum payment amount for recurring orders..." field according to the requirements of your PSP so you can obtain non-zero value authorizations.
  5. Click the Save Config button at the top right-hand corner of the screen to save the changes:
    Save config button.png

  6. Go to System -> X-Payments connector:
    Sys xpconnector.png

  7. Test the connection between your Magento store and X-Payments by running a test transaction:
    Click the Test module button.
    Test module button.png

    If the connection is configured properly, a message saying "The test transaction has been completed successfully" will be displayed at the top of the page:
    Xp magento test success.png

  8. Import payment methods from X-Payments:
    Click the Import payment methods from X-Payments button:
    Import payment methods button.png

    X-Payments will return a list of payment methods available for your Magento store:
    Imported xp payment methods.png

  9. Configure the X-Payments payment methods you are going to use:
    1. Go to System -> Configuration again:
      Sysconfig payment methods0.png

    2. Select Payment Methods from the left-hand side menu:
      Sysconfig payment methods.png

    3. Scroll down the page to locate the three sections pertaining to X-Payments payment methods: X-Payments connector, Use saved credit cards (X-Payments) and Prepaid Payments (X-Payments).
    4. Use the X-Payments connector section:
      Xp connector method.png

      to adjust the settings for your main X-Payments payment method - the one allowing buyers to pay by entering their credit card details at checkout:
      • Enabled: Use this setting to enable/disable payments via X-Payments for buyers at your Magento store. If enabled, the payment method will be available for selection by shoppers at checkout. If disabled, the method will not appear on the list of methods available for selection.
      • Sort order: Use this to control the sort order of payment methods in the list of methods displayed to buyers.
      • Title: Enter a name that will help buyers to identify this payment method. This name will appear on the list of available payment methods. By default, the name is "Credit Card (X-Payments)".
      • Payment from applicable countries: Use this field to specify whether you are going to accept payments from any countries supported by your PSP (select All Allowed Countries), or only from some specific countries (select Specific Countries).
      • Payment from Specific countries: If you have specified that you are going to accept payments only from Specific Countries, specify those specific countries here. More than one item may be selected by holding down the Ctrl key while clicking on the country names.
      • Payment configuration: Select the payment configuration to use with your Magento store.
      • Use iFrame: This setting determines what method will be used to provide the form for entering credit card details to the buyer. Select Yes if you want the form to be displayed in your Magento store using iFrame; in this case, the form will be embedded into your store's page. Select No if you want this form to be provided to the buyer on a separate page, without the use of iFrame. Please note that if you choose to enable the "Use iFrame" option in Magento, you should also enable the template Iframe for Magento in the X-Payments back end.
      • Show credit card form at: This field is displayed only if you have enabled the "Use iFrame" option at the previous step. It allows you to specify at what step of your Magento store checkout routine the form for entering the customer's credit card information needs to appear. The available options are ORDER REVIEW step:
        Iframe order review2.png

        and PAYMENT INFORMATION step:
        Iframe payment info1.png

        Important: In Magento stores allowing customers to partially pay for their order using reward points, where at the PAYMENT INFORMATION step of the checkout routine, at which the method of payment is chosen, customer is allowed to specify the amount of reward points they wish to redeem, it is not recommended to use the checkout routine configuration where the form for entering credit card details is displayed via iframe at the PAYMENT INFORMATION step. When such a configuration is used, the contents of the iframe may be displayed on the page before the customer applies their reward points to the order, which may result in payment problems, for example:
        1. The customer's card may be charged the full amount instead of the amount that has been reduced by reward points.
        2. The card may be charged successfully, but the order will be immediately canceled in Magento.
        To avoid the above named problems, it is recommended to use a configuration in which the credit card form is displayed using iframe at the ORDER REVIEW step of the standard Magento checkout routine, or is output without the use of iframe - on a separate page.

      • Use forced Authorize operation: This setting determines how the buyer's credit card is charged when they pay you using this method:

        If this is set to Yes, a two-step process is used in which the authorization of payment is separated from the capture of the authorized payment. At the time of the initial transaction, you perform only an authorization on the buyer's card without actually capturing the funds. This corresponds to the payment status "Authorized" in X-Payments, the status "X-Payments Pending payment" in the Magento admin and the status "X-Payments Authorized payment" in the Magento front end. Later you need to take additional steps to capture the funds or void the authorization.

        If this is set to No, an actual charge is made on the buyer's card as soon as the buyer's payment information is processed by the payment gateway - without any further interaction on your part. In X-Payments the status of such payments appears as "Charged", which corresponds to the Magento status "Processing".

        Some payment gateways do not support two-step payments with separate authorization and capture, so if you choose the "Use forced Authorize operation" option, make sure your payment gateway supports this feature.

        The option "Use forced Authorize operation" can be used to override the value of the "Initial transaction" setting of the payment configuration used by your Magento store - as provided on the respective Payment configuration details page in X-Payments: Setting "Use forced Authorize operation" to Yes in Magento allows you to have a two-step payment process with separate authorization and capture - even if the payment configuration in X-Payments is configured to use the "Auth and capture" mode for the initial transaction.
      • Use forced Authorize operation for initial fee: This setting is similar to "Use forced Authorize operation", but applies only to the initial fee of products with recurring profiles.

    5. If your payment gateway supports tokenized payments, and you wish to allow your Magento store shoppers to save their credit cards for future use at the store, adjust the settings in the section Use saved credit cards (X-Payments):
      Use saved credit cards section.png

      • Enabled: Use this setting to enable/disable payments with saved credit cards for buyers at your Magento store. If enabled, registered customers will be provided with an option to save their credit card details for future orders - either during checkout, or at any other time via the "MY PAYMENT CARDS" section of their account.
        Note: The credit card details will be saved in a PCI compliant manner (by your payment service provider, not by your Magento store itself) . After having their credit card details saved, customers will be able to use their saved credit cards for new orders. You - as the store administrator - will also be able to use your customers' saved credit cards to create orders for your customers via the Magento store's admin panel.

        If disabled, your customers will not be able to save their cards or use them for payment.

      • Sort order: Use this to control the sort order of payment methods in the list of methods displayed to buyers.
      • Title: Enter a name that will help buyers to identify this payment method. This name will appear on the list of available payment methods. By default, the name is "Use saved payment cards (X-Payments)".
    6. If your payment gateway supports tokenized payments, and you wish to use the prepaid payments feature, adjust the settings in the section Prepaid Payments (X-Payments):
      Prepaid payments section.png

      • Enabled: Use this setting to enable/disable prepaid payments.
      • Sort order: Use this to control the sort order of payment methods in the list of methods displayed to buyers.
      • Title: Enter a name that will help buyers to identify this payment method. This name will appear on the list of available payment methods. By default, the name is "Prepaid payments (X-Payments)".

    7. Click the Save Config button at the top right-hand corner of the screen to save the changes:
      Save config payment methods.png

That's it. You have connected your Magento store to X-Payments.