Skip to content
This repository has been archived by the owner on Nov 30, 2022. It is now read-only.

Latest commit

 

History

History
64 lines (50 loc) · 3.17 KB

user_guide_en.md

File metadata and controls

64 lines (50 loc) · 3.17 KB
Raw

Logo

heidelpay plentymarkets-merchant-gateway plugin

This extension provides an integration of the heidelpay payment methods for your plentymarkets shop.

REQUIREMENTS

  • This plugin is designed for Plentymarkets 7.

Release notes

This module is based on the heidelpay php-sdk (https://github.com/heidelpay/heidelpayPHP).

Installation

  • Please refer to plentyKnowledge in order to learn how to install plugins.
  • In order to test the configuration described below please use a test keypair so the plugin will run in sandbox mode
  • Once you are satisfied with the configuration, you can replace the keypair with one for live mode to use the module productively

Configuration

Basic configuration

  • In the Plugin overview select your plugin set and in it the "heidelpay merchant gateway" plugin to switch to the configuration overview.
  • Switch to the Default container links, select all elements in the list and save the configuration.
  • For the plugin configuration please go to System->Orders->Payment->Plugins->Heidelpay.

Plugin settings

Public / Private key

Public key is required to create payment types by the browser. Private key is required for transactions on heidelpay server.

The first letter of the keys determine the environment the plugin communicates with:

  • s identifies the key for the sandbox environment (no money is transferred).
  • p identifies the key for production mode in which actual transactions take place and money is transferred.

When you press the Save button the plugin registers heidelpay webhooks with the provided keys. These webhooks are used to synchronize the payments between Plentymarkets and heidelpay For example it updates the status of the payment in plentymarkets if the customer pays an invoice

Payment Method Parameters
Active

If checked the payment method will be selectable on the checkout page

Display Name

The name of the payment method shown on the checkout page.
A default name will be shown if the input is empty.

Min-/Max-Total

The payment method will only be available if the basket has a total between these values. Setting one of those values to 0 will disable the corresponding limitation.

URL to payment icon

This defines an icon for the payment method which is shown within the checkout in addition to the display name. A default icon will be shown if the input is empty.
Prerequisites for the URL string:

  • it must be reachable from the internet
  • it must start with 'http://' or 'https://'
  • it must end with '.jpg', '.png' or '.gif'
Card payment method

Card payments and paypal can be used in two different modes:

  • Direct charge: the bank account of the customer will be charged directly.
  • Authorize and charge: First the total amount will be reserved on the customer's account. Later you charge the money.

for further information about the payment method please refer to our manual

Manual

For further information like a workflow description or how to create event procedures, please refer to our [manual] (https://dev.heidelpay.com/manual-plentymarkets-merchant-gateway-plugin/)