crefopay/cppayments-oxid7-module

Oxid7 的 CrefoPay 支付模块

安装: 549

依赖: 0

建议者: 0

安全: 0

类型:oxideshop-module

1.0.1 2023-11-14 13:58 UTC

This package is auto-updated.

Last update: 2024-09-14 15:52:56 UTC


README

1. 简介

本快速入门指南旨在简化 CrefoPay Payment 插件在 Oxid eShop 7 中的安装和配置。步骤指南包含了启动所需的全部步骤。更多详细信息请参考相关的 Wiki

1.1 开始之前

在开始安装和配置 CrefoPay Payment 插件之前,应准备以下信息

  • 对 Oxid 安装的 Shell 访问权限
  • Oxid eShop 7 的 CrefoPay 支付插件
    • 支持的 Oxid 版本:7.0
  • CrefoPay 访问数据
    • 商户 ID
    • 商店 ID(s)
    • 公钥
    • 私钥

1.2 免责声明

作为软件发行者的 CrefoPayment GmbH & Co. KG 对 CrefoPay Payment 插件使用过程中可能产生的任何损害不承担任何责任。为了在生产环境中运行之前进行全面的功能测试,可以通过向 CrefoPay 服务团队发送电子邮件至 service@crefopay.de 请求访问 CrefoPay 沙箱

2 备份

CrefoPay Payment 插件已经过全面测试,并由 CrefoPayment GmbH & Co. KG 的质量保证部门检查和批准。尽管如此,在不利条件下,在安装或运行过程中,任何软件都可能发生意外的错误。因此,强烈建议在安装和运行软件之前创建系统备份(备份)。

3. 安装

CrefoPay Payment 插件作为 composer 包通过 packagist.org 提供,并通过 composer 安装

  1. 切换到商店安装的主目录(包含 'source' 和 'vendor' 文件夹的目录)
  2. 执行 composer require crefopay/cppayments-oxid7-module 以安装模块
  3. 模块现在在 Oxid 后端“扩展”>“模块”下可见,并可在此处启用

如果 composer 命令不可用,您可能需要请求您的托管商提供支持。如果 composer require 执行成功,但在 Oxid 后端无法看到模块,请执行以下操作:vendor/bin/oe-console oe:module:install-configuration source/modules/crefopay/cppayments 以将模块添加到 yaml 中

4. 激活

4.1 输入访问数据

为了激活 CrefoPay Payment 插件,需要 CrefoPay 访问数据。这些数据可以通过 CrefoPay 商户服务区域的“商店详情”下的 API 访问数据轻松获取(沙箱|实时)。CrefoPay 支付方式的激活通过 Oxid 后端中的“扩展”>“模块”菜单项进行。

  1. 首先,需要点击 CrefoPay 支付方式 模块以打开基本选项卡。
  2. 接下来,需要切换到 设置 选项卡并打开访问数据区域。
  3. 在此处输入提供的CrefoPay访问数据,然后通过点击保存进行确认。提示:问号符号提供有关相关输入字段的更多信息。
  4. 最后,可以通过点击启用来激活插件。提示:如果在激活过程中出现错误,将显示错误。务必记录显示的错误,以便CrefoPay服务团队能够在解决任何错误时提供最佳支持。

4.2 启用CrefoPay支付方式

  1. 首先必须在列表中单击要启用的支付方式。提示:如果商店中有许多支付方式可用,可以使用搜索功能,将CrefoPay一词输入搜索栏。
  2. 单击支付方式后,可以对其进行个别配置。
  3. 要启用支付方式,现在必须设置启用复选框。
  4. 名称字段中,要定义在商店前端显示的支付方式名称。
  5. 最后,通过点击保存来接受设置。
    必须重复步骤1至5以启用所有CrefoPay支付方式。
  6. 将Crefopay支付方式分配给您的配送方式,有关详细信息,请参阅:https://docs.oxid-esales.com/eshop/de/7.0/einrichtung/versandarten/registerkarte-zahlungsarten.html

5. 配置

有关可能的Oxid eShop配置选项的详细信息,可以在通用Oxid文档中找到。此快速入门指南仅限于CrefoPay激活相关的信息。

模块的配置,就像之前激活一样,通过设置选项卡进行。以下以表格形式总结了可能的选项。

#部分选项说明
1模式沙盒 | 实时在这里可以在测试模式(沙盒)和实时之间切换。注意:沙盒访问数据和实时访问数据通常不同!
2.1访问数据商户 IDAPI访问数据:商家ID
2.2访问数据商店IDAPI访问数据:商店ID
2.3访问数据私有密钥API访问数据:私有密钥
2.4访问数据公共密钥API访问数据:公共密钥
3CronJob-对于处理CrefoPay通知很重要
4.1订单设置在订单结束时立即执行支付交易(自动捕获)自动捕获确保CrefoPay订单在终端客户授权后直接入账,即进行记账。此功能应仅用于销售数字商品或与CrefoPay服务团队协商后启用。
4.2订单设置商业交易如果此功能被禁用,则所有订单将自动作为私人客户交易处理。如果选项被激活,则将处理包含公司名称的交易,作为商业交易。对于账单和直接借记支付方式,这也意味着将调用相应的信用查询接口。
4.3订单设置在订单结束时预先分配订单号如果此功能被激活,则最终Oxid订单号将在执行支付之前创建。如果支付被拒绝或由终端客户未完成,则可能在通常连续上升的Oxid订单号中产生空白。
4.4订单设置出生日期在此可以配置出生日期的查询和存储。出生日期用于私人个人的信用查询。
4.5订单设置订单号前缀在此可以指定由CrefoPay插件自动生成的订单ID的前缀。这可以用于与其他非CrefoPay支付方式的区分。
4.6订单设置预付款的支付目标该模块扩展了电子邮件订单确认功能,并在预付款订单的情况下补充了对最终用户重要的(银行账户)信息。通过此选项,可以指定买家最迟付款日期(以天为单位)。
4.7订单设置账单付款目标注意:此选项不控制CrefoPay为支付监控和自动催款设置的付款目标,而仅用于向Oxid商店客户显示。要调整CrefoPay的支付监控付款目标,请联系CrefoPay的联系人。
4.8订单设置购物车有效期CrefoPay交易具有从创建到成功完成的时效性。通过此选项可以定义此时间段。这里必须指定一个数字,否则会导致与CrefoPay API的通信错误。
5.1信用卡标志CVV帮助选择信用卡支付方式时,此选项将在结账时显示一张图片,其中标记了最终用户在其信用卡上找到CVV的位置。
5.2信用卡标志MasterCard标志选择信用卡支付方式时,此选项将在结账时显示MasterCard标志。
5.3信用卡标志VISA标志选择信用卡支付方式时,此选项将在结账时显示VISA标志。
6.1其他设置传输购物车位置如果没有勾选,则只传输一个包含总金额的位置。如果勾选,将传输单个项目以及(如有必要)优惠券/折扣、运费等位置。但是,可能会出现潜在的与Oxid购物车的四舍五入差异,模块将尝试通过调整最后一个位置来平衡这些差异。
6.2其他设置仅显示CrefoPay支付方式CrefoPay模块能够隐藏竞争性支付方式。如果此选项处于活动状态,则仅在结账时显示CrefoPay支付方式。
6.3其他设置显示用户在Crefopay中保存的支付方式如果此选项处于活动状态,则已注册的客户将在简化结账过程中提供他们在CrefoPay先前使用的信用卡和银行账户。在此过程中,支付数据不会存储在Oxid中,而是安全地存储在CrefoPay,并且仅以掩码形式向最终用户显示。
6.4其他设置将信用评分纳入Oxid客户账户如果此选项处于活动状态,则将进行信用审查时提供的评分(如有)存储在客户账户中预定字段。
6.5其他设置日志级别该模块具有不同的记录级别。调试记录模块的所有相关操作。警告记录模块的严重和轻微错误。错误仅记录对CrefoPay连接过程有重大影响的严重错误。
6.6其他设置(天)后删除日志文件该插件将在指定的天数后自动删除不再需要的日志文件,以避免在服务器上占用不必要的存储空间。
6.7其他设置(天)后删除过期的交易未完成的CrefoPay交易在购物车有效期到期后将转换为“过期”状态。在Oxid数据库中不再需要的数据将在指定的天数后同样被删除。