Magento 2 Paya Payments

Home > Magento Extension User Guides > Magento 2 Paya Payments

Magento 2 Paya Payments integrates Magento 2 store with USA's popular Paya payment gateway (Formerly known as Sage Payment) for accepting secure online payments from the customers.

 

Table of Content

  1. Extension Installation Guide
  2. Configuration
  3. Paya Payments in Frontend
  4. Paya Payment Details in Order View Backend
  5. Paya 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-payments
    • 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_Paya
          • By default, the extension is probably disabled.
          • Enable the extension and clear static view files:
      • php bin/magento module:enable Meetanshi_Paya --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 Payments - Meetanshi, where you can find various settings to configure the extension.
  • Enabled: Enable or disable Paya Payments extension from here.
  • Debug: Select YES to enable debug.
  • Title: Enter title for the Paya Payment method to show in the frontend.
  • Vault Enabled: Select YES to enable vault to allow customers to save card data for future use.
  • Vault Title: Set a custom title for the stored card (vault) payment method.
  • Show Paya Logo: Select YES to show the Paya logo on the checkout page in the frontend.
  • Sandbox Mode: Set YES to enable sandbox mode for the payment gateway.
  • Merchant ID: Enter the merchant ID you have received from the Paya payment gateway.
  • Merchant Key: Enter the merchant key you have received from the Paya payment gateway.
  • 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 payments.
    • Authorize and Capture: Authorizes and captures the order amount immediately.
  • New Order Status: Set the order status of the new orders placed using the Paya payment method.
  • Credit Card Types: Select the credit card types to allow payment using the Paya payment method.
  • Payment from Applicable Countries: Select countries to allow the use of the payment method.
  • Instructions: Enter additional instructions to show on the checkout page in the frontend.
  • Minimum Order Total: Enter the minimum order total to allow using the payment method.
  • Maximum Order Total: Enter the minimum order total to allow using the payment method.
  • Sort Order: Enter the sort order of the payment method.


 

  1. Paya Payments in Frontend
    Once the extension is configured, it can be seen enabled on the frontend. Simply add products to cart and at checkout, you can see payment method enabled. Select it, add card details and click to finish payment and place order. Tick the “Save card for later use” checkbox to save the card details for future use.

 

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

 

 

  • Saved Cards in My Account Section
    If the customer has saved card for future use while placing the order, his saved card details are shown under “Stored Payment Methods” in the “My Account” section. The customer can delete the card from here.


  

  • Frontend Order Using Stored Card
    If the customer has saved card for future use while placing the order, he can use the saved card to create a new order from the frontend.


 

  1. Paya Payment Details in Order View Backend
    Apart from My Account section, Paya payment details can be found in the Sales > Orders > Order View section in the backend.


  

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


  

  • Backend Order Using Stored Card
    If the customer has saved card data from the frontend while placing the order, the admin can create a new order using the saved card from the backend.


 

If you are using Authorize as a Payment Action, you can select “Capture Online” under “Amount” dropdown while generating the invoice.


Paya payments now supports online refund facility as well. You can refund online while generating credit memo from the backend.

 

Updated:

Other Articles

and 238 more ...