logo
 

OXID ESALES

Supported Payment Methods
 Invoice
 Installment Payment
 Direct Debit
Features
 Due Date Activation
 Full cancellation
 Partial cancellation
+
-
Step 1 – Plug-In Installation

  1. Copy the contents of the plug-in zip archive to your shop’s root folder.
  2. In the admin component of your shop, under eShop Admin → BillPay → BillPay-Installation install the plug-in.
  3. Tick the “Aktiv” checkbox in the admin component under eShop Admin → Shopeinstellungen → Zahlarten → BillPay.
  4. Log out of the shop’s admin component and then log back in.
  5. Clear the cache of your shop.
+
-
Step 2 (V4.9 CE) – Modification of the Oxid Files

  1. Download and open the following file from your shop’s ftp-server:
    modules/oe/invoicepdf/models/invoicepdfarticlesummary.php (modification only necessary if the Pdf-Modul is installed)
  2. Edit the modules/oe/invoicepdf/models/invoicepdfarticlesummary.php file as follows:
    Find the following line:

    $this->_oData->oxorder__oxpaymenttype->value );

    Paste the following AFTER the code above:

    /** BEGIN BILLPAY CHANGED **/
    $billpayUtils = oxNew('billpayutil');
    $sPaymentType = $this->_oData->oxorder__oxpaymenttype->value;
    if ($billpayUtils->isBillpayPayment($sPaymentType)) {
       if ($sPaymentType == $billpayUtils->getTCName()) {
         $billpayUtils->setAdditionalTotal($this, $this->_oPdf,
         $this->_oData, $oPayment->oxpayments__oxdesc->value, $iStartPos);
        } else {
         $billpayUtils->setInvoiceText($this, $this->_oPdf,
         $this->_oData, $oPayment->oxpayments__oxdesc->value, $iStartPos);
            }
            return;
      }
    /** EOF BILLPAY CHANGED **/

    Find the following line:

    $text = $this->_oData->translate( 'ORDER_OVERVIEW_PDF_PAYUPTO'

    Paste the following BEFORE the code above:

    /** BEGIN BILLPAY CHANGED **/
            $billpayUtils = oxNew('billpayutil');
            $sPaymentType = $this->_oData->oxorder__oxpaymenttype->value;
            if ($billpayUtils->isBillpayPayment($sPaymentType)) {
                return;
            }
    /** EOF BILLPAY CHANGED **/

+
-
Step 2 (V4.5 – 4.8 CE / 5.0 – 5.1 EE) – Modification of the Oxid Files

  1. Download and open the following file from your shop’s ftp-server:
    modules/invoicepdf/myorder.php (modification only necessary if the Pdf-Modul is installed)
  2. Edit the modules/invoicepdf/myorder.php file as follows:
    Find the following line:

    $this->_oData->oxorder__oxpaymenttype->value );

    Paste the following AFTER the code above:

    /** BEGIN BILLPAY CHANGED **/
    $billpayUtils = oxNew('billpayutil');
    $sPaymentType = $this->_oData->oxorder__oxpaymenttype->value;
    if ($billpayUtils->isBillpayPayment($sPaymentType)) {
       if ($sPaymentType == $billpayUtils->getTCName()) {
         $billpayUtils->setAdditionalTotal($this, $this->_oPdf,
         $this->_oData, $oPayment->oxpayments__oxdesc->value, $iStartPos);
        } else {
         $billpayUtils->setInvoiceText($this, $this->_oPdf,
         $this->_oData, $oPayment->oxpayments__oxdesc->value, $iStartPos);
            }
            return;
      }
    /** EOF BILLPAY CHANGED **/

    Find the following line:

    $text = $this->_oData->translate( 'ORDER_OVERVIEW_PDF_PAYUPTO'

    Paste the following BEFORE the code above:

    /** BEGIN BILLPAY CHANGED **/
            $billpayUtils = oxNew('billpayutil');
            $sPaymentType = $this->_oData->oxorder__oxpaymenttype->value;
            if ($billpayUtils->isBillpayPayment($sPaymentType)) {
                return;
            }
    /** EOF BILLPAY CHANGED **/

+
-
Step 2 (V4.3 – 4.4.8) – Modification of the Oxid Files

  1. Download and open the following files from your shop’s ftp-server:
    • modules/invoicepdf/myorder.php (Anpassung nur nötig wenn das Pdf-Modul installiert ist)
    • out/basic/tpl/payment.tpl
    • out/basic/tpl/order.tpl
  2. Edit the modules/invoicepdf/myorder.php file as follows:
    Find the following line:
  3. $this->_oData->oxorder__oxpaymenttype->value );

    Paste the following AFTER the code above:

    /** BEGIN BILLPAY CHANGED **/
    $billpayUtils = oxNew('billpayutil');
    $sPaymentType = $this->_oData->oxorder__oxpaymenttype->value;
    if ($billpayUtils->isBillpayPayment($sPaymentType)) {
      if ($sPaymentType == $billpayUtils->getTCName()) {
        $billpayUtils->setAdditionalTotal($this, $this->_oPdf,
        $this->_oData, $oPayment->oxpayments__oxdesc->value, $iStartPos);
       } else {
        $billpayUtils->setInvoiceText($this, $this->_oPdf,
        $this->_oData, $oPayment->oxpayments__oxdesc->value, $iStartPos);
           }
           return;
     }
    /** EOF BILLPAY CHANGED **/

    Find the following line:

    $text = $this->_oData->translate( 'ORDER_OVERVIEW_PDF_PAYUPTO'

    Paste the following BEFORE the code above:

    /** BEGIN BILLPAY CHANGED **/
            $billpayUtils = oxNew('billpayutil');
            $sPaymentType = $this->_oData->oxorder__oxpaymenttype->value;
            if ($billpayUtils->isBillpayPayment($sPaymentType)) {
                return;
            }
    /** EOF BILLPAY CHANGED **/

  4. Edit the out/basic/tpl/payment.tpl file as follows:
    Find the following line:

  5. [{ oxmultilang ident="PAYMENT_COMLETEALLFIELDS" }]

    Paste the following AFTER the code above:

    /** BEGIN BILLPAY CHANGED **/
    [{ elseif $iPayError == $billpayUtils->getPaymentErrorCode() }]
      [{include file="billpay_payment_error.tpl"}] 
    /** EOF BILLPAY CHANGED **/

    Find the following line:

    [{elseif $sPaymentID == "oxidcreditcard"}]

    Paste the following BEFORE the code above:

    /** BEGIN BILLPAY CHANGED **/
    [{elseif $sPaymentID == $billpayUtils->getIName()}]
        [{if !$hide_billpay && !$hide_billpay_rec}]
          [{include file="billpay_payment_invoice.tpl"}]
        [{else}]
          [{assign var="inptcounter" value="`$inptcounter-1`"}]
        [{/if}]
    [{elseif $sPaymentID == $billpayUtils->getDDName()}]
        [{if !$hide_billpay && !$hide_billpay_elv}]
          [{include file="billpay_payment_direct_debit.tpl"}]
        [{else}]
          [{assign var="inptcounter" value="`$inptcounter-1`"}]
        [{/if}]
    [{elseif $sPaymentID == $billpayUtils->getTCName()}]
        [{if !$hide_billpay && !$hide_billpay_rtk}]
          [{include file="billpay_payment_transaction_credit.tpl"}]
        [{else}]
          [{assign var="inptcounter" value="`$inptcounter-1`"}]
        [{/if}]
    [{elseif $sPaymentID == $billpayUtils->getPayLaterName()}]
        [{if !$hide_billpay && !$hide_billpay_pl}]
          [{include file="billpay_payment_pay_later.tpl"}]
        [{else}]
          [{assign var="inptcounter" value="`$inptcounter-1`"}]
        [{/if}]
    /** EOF BILLPAY CHANGED **/

  6. Edit the out/basic/tpl/order.tpl file as follows:
    Find the following lines:
  7. $currency->sign}]
      
    

    Paste the following AFTER the code above:

    /** BEGIN BILLPAY CHANGED **/
     [{if $bputil->isBillpayPayment($sPaymentID)}]
        [{include file="billpay_order_confirmation.tpl"}]
    [{/if}]
    /** EOF BILLPAY CHANGED **/

    Find the following line:

    [{ oxmultilang ident="ORDER_EMAIL" }]

    Paste the following AFTER the code above:

    /** BEGIN BILLPAY CHANGED **/
     [{if $bputil->isBillpayPayment($sPaymentID) }]
        [{include file="billpay_order.tpl"}]
    [{else}]
    /** EOF BILLPAY CHANGED **/

    /** BEGIN BILLPAY CHANGED **/
     [{if $bputil->isBillpayPayment($sPaymentID) }]
        [{include file="billpay_order.tpl"}]
    [{else}]
    /** EOF BILLPAY CHANGED **/

    Find the following line:

    [{ oxmultilang ident="ORDER_PHONE" }]

    Paste the following AFTER the code above:

    /** BEGIN BILLPAY CHANGED **/
     [{/if}]
    /** EOF BILLPAY CHANGED **/

+
-
Step 3 – Configuring the BillPay Settings

Under eShop Admin → BillPay → BillPay-Konfiguration enter your merchant account credentials and select “Testmodus”.

1

+
-
Step 4 – Place an Order in the Shop

1. Please go to your shop and create a test order. The test order must include the following:

  1. Diacritic characters (i.e. Umlauts: ä, ö, ü) in the customer name, address and an article when possible.
  2. Place two different articles in the basket.
  3. Please make sure the combined value of the articles does not exceed 1000 €.
  4. Apply a coupon code (discount) when ordering. Please confirm in writing if no coupon codes are used in your shop.
  5. For the test order, please use a shipping method that carries costs. Should you only offer free shipping, please confirm that in writing.

Important:
If the word “test” is used as the first or last name of the customer, the request will be rejected.
Every customer is allowed a maximum of 3 open orders. To place further orders, either a different name has to be used for the 4th order or one of the open orders needs to be canceled.

+
-
Step 5 – Activating an Order in the Admin Component of the Shop

Open the order details in the admin component of your shop under eShop Admin → Bestellungen verwalten → Bestellungen and click the „Zahlungsziel aktivieren“ in the „BillPay“ tab.

+
-
Step 6 – Send the Order Confirmation and Invoice

1. Please send a copy of the order confirmation to abnahme@billpay.de

  1. The shop bank account details must be removed from the order confirmation email templates.
  2. Check if the BillPay payment payment derails are included.

2. If you use the Oxid standard invoice, please send a copy to abnahme@billpay.de

  1. Payment type (invoice): The dynamic bank account data of BillPay must be included.
  2. Payment method (direct debit or PayLater): The standard texts of BillPay must be included.
  3. The shop bank account details must be removed from the invoice templates.

3. If you are generating your invoices outside of the shop system, please send a copy to abnahme@billpay.de

  1. Payment type (invoice): The dynamic account data of BillPay must be included. (https://www.billpay.de/de/geschaeftskunden/zahlungsinformationen/).
  2. Payment method (direct debit or PayLater): The standard texts of BillPay must be included.
  3. The shop bank account details must be removed from the invoice templates.

+
-
Step 7 – Creation of Refunds/Cancellations/Credit Memos

  1. Under eShop Admin → Bestellungen verwalten → Bestellungen in the „Artikel“ tab, cancel one item from the order or reduce the quantity of a particular item.
  2. You can cancel the entire order by clicking the “Pause” button under eShop Admin → Bestellungen verwalten → Bestellungen

+
-
Step 8 – Repeating Test Orders for the Compliance Test

Please repeat the compliance test (starting at Step 4) for all contractually agreed upon BillPay payment methods und countries.

+
-
Step 9 – Adjustment of terms and conditions

Merchants are required to include BillPay related text passages in the terms and conditions and privacy pages of their website. These passages were provided to you by BillPay.
Important: The pdf file/s you received contain references to linking text. Please create these links, and should you be offering invoice as a payment method, adjust the passage “20 or 30 calendar days” to reflect your payment due date – either in “20 calendar days” or “30 calendar days”.

+
-
Step 10 – BillPay branding

Should you display payment method logos in the footer of your website or in the payment method selection portion of your checkout, it is necessary for you to also include the relevant BillPay logos. These can be found and downloaded in either png or svg format via the following url: https://www.billpay.de/de/shopintegration/downloads/
Beispielbild1
Beispielbild 2