magento plugin content - marketplace...magento plugin i n s t a l l a t i on a n d u s e g u i d e...

Magento Plugin

Installation and Use Guide

Content

Installation Using Composer 2

Configuration 3

Using the Features 7

To Process Payments 7

To Process Pre-authorizations 8

To Process Refunds 10

To Manage Subscription Plans 11

To Manage Card Tokens 12

Magento Plugin Installation and Use Guide

1. Installation Using Composer

To install our plugin you only can:

1. Run the composer require worldnettps/payment-gateway command from your CLI, or;

2. Add the dependency “worldnettps/payment-gateway”: “1.0.0” to the “require” section of

your composer.json file (root folder of your Magento application) and run the command

composer update on your CLI.

FIGURE - Configuration File (Dependencies) - composer.json

[ 2 / 12 ]


2. Configuration

To configure the plugin you need to navigate to the configuration page:

➔ STORES > CONFIGURATION > SALES > PAYMENT METHODS

FIGURE - Payment Method Configuration - Part 1

[ 3 / 12 ]


FIGURE - Payment Method Configuration - Part 2

Expand the payment method WorldnetTPS payment element and provide the following details.

● Enabled: Yes or No. If Yes, this payment method is going to be available for customers.

● Payment Action:

○ Authorize Only: if you use this action, you are going to need to complete the

authorization later on.

○ Authorize and Capture: This action does not require later completion.

● Integration Type:

○ XML: accepts payment within the e-commerce application premises.

○ HPP: redirects the customer to a safe PCI compliant webpage to enter the card

details and perform the payment.

[ 4 / 12 ]


● Transaction Type: Depends on the integration type. For more details, search

TRANSACTIONTYPE field in:

○ For XML:

https://docs.worldnettps.com/doku.php?id=developer:api_specification:xml_paym

ent_features.

○ For HPP:

https://docs.worldnettps.com/doku.php?id=developer:api_specification:hpp_pay

ment_features.

● Dynamic Descriptor: dynamic descriptor to be used by your acquirer as the identifying

name of a purchase appearing on the monthly cardholder’s credit card statement.

● Account Type: Test or Live.

● Gateway URL HPP: URL endpoint to which provides the payment integration for this

integration type. Preferably, mark the “Use system value” option.

● Gateway URL XML: URL endpoint to which provides the payment integration for this

integration type. Preferably, mark the “Use system value” option.

● <Test/Live> Primary Currency: Currency to be used. Based on the currency (s) allowed

to the terminal indicated by the following Terminal ID.

● <Test/Live> Primary Terminal ID: Terminal identification.

● <Test/Live> Primary Shared Secret: Terminal secret. Defined on setup. It can be

changed by the merchant using the Merchant SelfCare System.

● <Test/Live> Primary Multicurrency: Yes or No. Defines if the terminal is multi-currency

or not.

● <Test/Live> Secondary Currency: Currency to be used. Based on the currency (s)

allowed to the terminal indicated by the following Terminal ID.

● <Test/Live> Secondary Terminal ID: Terminal identification.

● <Test/Live> Secondary Shared Secret: Terminal secret. Defined on setup. It can be

changed by the merchant using the Merchant SelfCare System.

● <Test/Live> Secondary Multicurrency: Yes or No. Defines if the terminal is

multi-currency or not.

● <Test/Live> Third Currency: Currency to be used. Based on the currency (s) allowed to

the terminal indicated by the following Terminal ID.

● <Test/Live> Third Terminal ID: Terminal identification.

● <Test/Live> Third Shared Secret: Terminal secret. Defined on setup. It can be changed

by the merchant using the Merchant SelfCare System.

[ 5 / 12 ]

https://docs.worldnettps.com/doku.php?id=developer:api_specification:xml_payment_features

https://docs.worldnettps.com/doku.php?id=developer:api_specification:xml_payment_features

https://docs.worldnettps.com/doku.php?id=developer:api_specification:hpp_payment_features

https://docs.worldnettps.com/doku.php?id=developer:api_specification:hpp_payment_features


● <Test/Live> Third Multicurrency: Yes or No. Defines if the terminal is multi-currency or

not.

● New Order Status: Status for new orders. Verify Magento’s status configuration

instructions to add new options to this list.

● Sort Order: Modifying this will change the display order of the payment method if more

than one is available (lower is higher with 0 being displayed on top).

● Debug: Yes or No. To activate the debug mode of your e-commerce application.

● Email Customer: Yes or No. If yes, the receipt is going to be sent by e-mail to customers.

● Merchant’s Email: Merchant’s support e-mail for contact and complaints.

● Credit Card Types: Allowed card brands which can be used to accept card payments by

the account. Limited by the terminal used to provide the integration.

● Payment From Application Countries: All or Specific List.

● Payment From Specific Countries: When selected a specific list, let’s you choose which

countries.

● Minimum Order Total: Minimum order amount to be able to use this payment method.

● Maximum Order Total: Maximum order amount to be able to use this payment method.

After defining these settings, you can start using the features.

[ 6 / 12 ]


3. Using the Features

To Process Payments

The payment processing allows you (ORDERS > Create New Order) and your customers

(Checkout) to create new orders and send them to the payment gateway for processing.

FIGURE - Payment/ Purchase

[ 7 / 12 ]


The result can be verified in SALES > OPERATIONS > TRANSACTIONS.

FIGURE - Transactions

To Process Pre-authorizations

The difference between processing payments or pre-authorizations depends on the Payment

Action configured in the payment method.

In case you configured Authorize Only, all of the payments generated from your e-commerce

platform will be Pre-authorizations, which requires you to go to each order and “Complete” them

before the payment is properly ready for settlement (when you are going to receive the actual

payment in your merchant account). To do that you are going to access:

1. SALES > ORDERS > [Select an Order by clicking on View]

2. [At the page top select Invoice]

3. [At the page bottom, go to Invoice Totals]

4. [In Amount select Capture Online] > Submit Invoice

[ 8 / 12 ]


FIGURE - Complete Pre-auth

The default configuration of our plugin is Pre-auth + Completion, so If during configuration you didn’t explicitly selected Payment Action as Authorize and Capture, most likely you are going to need to complete/ submit each invoice after authorization is confirmed.

[ 9 / 12 ]


To Process Refunds

There are cases where you might need to refund a specific purchase for a customer, and in this

case, you can also use your e-commerce. For this you need to go to:

1. SALES > ORDERS > [Select a successful Order by clicking on View]

2. [Select Invoices tab and choose an Invoice by clicking in View]

3. [Select Credit Memos] > [In Refund Totals section, page bottom, enter Amount] > Refund

FIGURE - Refund Payment (Credit Memo)

[ 10 / 12 ]


To Manage Subscription Plans

If you desire to create a payment plan for your customers, you can use this feature. We call this

functionality Stored Subscription.

Additionally, any stored subscription you configure is going to be presented to the customers

when they select to pay using our payment method (see the first feature of this section).

All the stored subscriptions and subscriptions “signed” by your customers will be available in

SALES > WORLDNETTPS SUBSCRIPTION. You are going to be able to edit or delete them if

desired.

FIGURE - Stored Subscription (Plans)

FIGURE - Customers’ Subscriptions

[ 11 / 12 ]


To Manage Card Tokens

When a customer pays a purchase using our payment method, the plugin gives an option to store

that card as a token.

All the tokens generated are presented in SALES > WORLDNETTPS SECURECARD. Here you can

see the token associated with customers and delete then, when necessary or required by your

customers.

FIGURE - Customers’ Tokens

For more details on our solutions and questions regarding the use of our platform, please contact our Sales team.

[ 12 / 12 ]

magento plugin content - marketplace...magento plugin i n s t a l l a t i on a n d u s e g u i d e...

Documents