Magento 2 Paya Connect

Home > Magento Extension User Guides > Magento 2 Paya Connect

Magento 2 Paya Connect extension integrates Magento 2 store with Paya Connect payment solution to capture secure online payments from the customers.

 

Table of Content

  1. Extension Installation Guide
  2. Configuration
  3. Paya Connect in Frontend
  4. Paya Connect Payment Details in Order View Backend
  5. Paya Connect Payment Method for Backend Order

 

  1. Extension Installation
  • For Magento Marketplace Customers
    • Find the Composer name and version of the extension in the extension’s composer.json file.
    • Login to your SSH and run:
      • composer require meetanshi/magento-2-paya-connect
    • Enter your authentication keys. Your public key is your username; your private key is your password.
    • Wait for Composer to finish updating your project dependencies and make sure there aren’t any errors.
    • To verify that the extension installed properly, run the command:
      • php bin/magento module:status Meetanshi_PayaConnect
          • By default, the extension is probably disabled.
          • Enable the extension and clear static view files:
      • php bin/magento module:enable Meetanshi_PayaConnect --clear-static-content
      • php bin/magento setup:upgrade
      • For Magento version 2.0.x to 2.1.x - php bin/magento setup:static-content:deploy
      • For Magento version 2.2.x & above - php bin/magento setup:static-content:deploy –f
      • php bin/magento cache:flush
         
  • For Meetanshi Customers
  • Extract the zip folder and upload our extension to the root of your Magento 2 directory via FTP.
  • Login to your SSH and run below commands step by step:
  • php bin/magento setup:upgrade
  • For Magento version 2.0.x to 2.1.x - php bin/magento setup:static-content:deploy
  • For Magento version 2.2.x & above - php bin/magento setup:static-content:deploy –f
  • php bin/magento cache:flush

 

  1. Configuration
    For configuring the extension, login to Magento 2, move to Stores à Configuration à Sales à Payment Methods à Paya Connect Payments - Meetanshi, where you can find various settings to configure the extension.
  • Enabled: Enable or disable Paya Connect extension from here.
  • Vault Enabled: Set YES to enable vault to allow customers save cards for future transactions.

Basic Paya Connect Settings:

  • Title: Enter title for the Paya Connect payment method to show in the frontend.
  • Show Paya Logo: Select YES to show Paya logo on the checkout page in frontend.
  • Payment Action: Select one of the payment actions for the payment capture.
    • Authorize: Authorizes and validates card for the order amount. The admin has to manually capture the amount (by generating invoice using “Capture Online” option) within the authorization hold period which is 7 calendar days for Paya connect.
    • Authorize and Capture: Authorizes and captures the order amount immediately.
  • Sandbox Mode: Set YES to enable sandbox mode for the payment gateway.
  • User API Key: Enter the user API key you have received after registration with Paya Connect.
  • User Hash Key: Enter the user hash key you have received after registration with Paya Connect.
  • User ID: Enter the user ID you have received after registration with Paya Connect.
  • Location ID: Enter the location ID you have received after registration with Paya Connect.
  • Developer ID: Enter the developer ID you have received after registration with Paya Connect.

 

  • Click on the “Project Details” tab to get the location ID, Developer ID and Hash key. Copy each and paste them in the relevant field in Magento 2 extension configuration.

  • Click on the “API Credentials” tab to get the user ID, user API key and User hash key. Copy each and paste them in the relevant field in Magento 2 extension configuration.

 

Advanced Paya Connect Settings:

  • Vault Title: Enter the vault title to show in the email to customers.
  • Add Surcharge: Select YES to add surcharge on the orders placed through Paya Connect method.
  • Show Account Holder Name in Payment Form: Select YES to show account holder name in the payment form on the checkout page.
  • New Order Status: Set status for the new orders placed through Paya Connect method.
  • Credit Card Types: Select credit cards to allow use of while paying through the Paya Connect.
  • Debug: Select YES to enable debug.
  • Instructions: Enter additional instructions to show on the checkout page in the frontend.
  • Minimum Order Total: Enter the minimum order total to allow the use of the payment method.
  • Maximum Order Total: Enter the minimum order total to allow the use of the payment method.
  • Sort Order: Enter sort order of the payment method.

 

  1. Paya Connect in Frontend
    Once the extension is configured, it can be seen enabled in the frontend. Simply add products to cart and go to the check out, you can see payment method enabled. Select it, enter the card details in the payment form and click submit to finish payment and place the order. The customers can tick the box here to save the card for future transactions.

 

  • Paya Connect Payment Details in My Account Section
    Immediately after the order is placed, the Paya Connect payment details can be seen in order view under customer’s My Account section.

 

  • Paya Connect Stored Cards
    If the vault is enabled and the customers have ticked the box from the checkout page to save the cards for the future transactions, they can see stored cards in their My Account section under “Stored Payment Methods” tab.

 

  • New Order Placement using Stored Cards
    If the vault is enabled and the customer has ticked the box from the checkout page to save the card for the future transactions, he can use the stored card to pay for the new order.

 

 

  1. Paya Connect Payment Details in Order View Backend
    Apart from the customer’s My Account section, the admin can see Paya Connect payment details from the Sales à Orders à Order View section in the backend.

 

  1. Paya Connect Payment Method for Backend Order
    Just as the frontend, Paya Connect payment method also works with backend orders. Admin needs to create a new order, select the customer, add products, enter the address details and select Paya Connect payment method, add card details and click submit order to place order from backend using the Paya Connect payment method.

 

 

​​​​​​​

Updated:

Other Articles

and 238 more ...