crefopay / cppayments-oxid6-module
Oxid6 CrefoPay支付模块
Requires
- php: >=7.2
- ext-bcmath: *
- ext-curl: *
- ext-json: *
- ext-openssl: *
- crefopay/php-clientlibrary: dev-oxid-master
README
1. 简介
本快速入门指南旨在简化CrefoPay支付插件在Oxid eShop 6的安装和配置。步骤指南包含了启动所需的全部步骤。更多详细信息请参阅相关的Wiki。
1.1 开始前
在开始安装和配置CrefoPay支付插件之前,应准备以下信息:
- 您的Oxid安装的Shell访问权限
- Oxid eShop 6 CrefoPay支付插件
- 支持的Oxid版本:6.0 - 6.4
- CrefoPay访问数据
- 商户ID
- 店铺ID(s)
- 公钥
- 私钥
1.2 免责声明
作为软件发布者的CrefoPayment GmbH & Co. KG不对使用CrefoPay支付插件产生的任何损害承担任何责任。为了在生产环境中启动前进行全面的功能测试,可以通过service@crefopay.de向CrefoPay服务团队申请访问CrefoPay Sandbox。
2 备份
CrefoPay支付插件已经过充分测试,并由CrefoPayment GmbH & Co. KG的质量保证部门检查和批准。尽管如此,在软件中仍可能因不利条件导致安装或运行时出现意外错误。因此,强烈建议在安装和运行软件之前创建系统备份(备份)。
3. 安装
CrefoPay支付插件作为composer包通过packagist.org提供,并使用composer安装。
- 切换到商店安装的主目录(包含'source'和'vendor'文件夹的目录)
- 执行
composer require crefopay/cppayments-oxid6-module
以安装模块 - 模块现在在Oxid后端“扩展”>“模块”下可见,可以在此处激活
如果composer命令不可用,可能需要请求您的托管商提供支持。如果已成功执行composer require,但在Oxid后端看不到模块:执行以下命令以将模块添加到yaml中:vendor/bin/oe-console oe:module:install-configuration source/modules/crefopay/cppayments
4. 激活
4.1 输入访问数据
为了激活CrefoPay支付插件,需要CrefoPay访问数据。这些数据可以方便地从CrefoPay商家服务区域的API访问数据部分下在商店详情中获取(Sandbox|Live)。CrefoPay支付方式的激活通过Oxid后端的“扩展”>“模块”菜单项进行。
- 首先,必须点击“CrefoPay支付方式”模块以打开主选项卡。
- 接下来,必须切换到“设置”选项卡并打开访问数据区域。
- 在此处输入提供的CrefoPay访问数据,然后通过“保存”确认。 注意:问号符号提供有关相关输入字段的更多信息。
- 最后,可以通过点击激活来激活插件。注意:如果在激活过程中出现错误,将会显示这些错误。必须记录下显示的错误,以便CrefoPay服务团队能够在解决可能出现的错误时提供最佳支持。
4.2 激活CrefoPay支付方式
- 首先,必须在列表中点击要激活的支付方式。注意:如果商店中有许多支付方式可用,可以使用搜索功能,在搜索框中输入CrefoPay。
- 点击支付方式后,可以对其进行个别配置。
- 现在必须勾选启用复选框以激活支付方式。
- 在名称字段中,需要定义在商店前端显示的支付方式名称。
- 最后,通过点击保存来应用这些设置。
必须对所有要激活的CrefoPay支付方式重复步骤1至5。 - 将Crefopay支付方式分配给您的运输方式,有关详细信息,请参阅:https://docs.oxid-esales.com/eshop/de/6.2/einrichtung/versandarten/registerkarte-zahlungsarten.html
5. 配置
有关可能的Oxid eShop配置选项的详细信息,可以从通用Oxid文档中获取。本快速入门指南仅限于CrefoPay激活相关的信息。
模块配置是通过与激活相同的设置选项卡进行的。以下是以表格形式汇总的可能选项。
# | 部分 | 选项 | 备注 |
---|---|---|---|
1 | 模式 | 沙盒 | 实时 | 在此可以切换到测试模式(沙盒)和实时模式。注意:沙盒访问数据和实时访问数据通常不同! |
2.1 | 访问数据 | 商户ID | API访问数据:商家ID |
2.2 | 访问数据 | 商店ID | API访问数据:商店ID |
2.3 | 访问数据 | 私有密钥 | API访问数据:私有密钥 |
2.4 | 访问数据 | 公共密钥 | API访问数据:公共密钥 |
3 | CronJob | - | 对于处理CrefoPay通知很重要 |
4.1 | 订单设置 | 在订单结束时立即执行支付交易(自动捕获) | 自动捕获确保CrefoPay订单在最终用户授权后立即记账,即开始计费。此功能仅适用于数字商品的销售或与CrefoPay服务团队协商后启用。 |
4.2 | 订单设置 | 商业交易 | 如果此功能被禁用,则所有订单将自动作为个人客户交易处理。如果启用此选项,则将交易处理为商业交易,如果指定了公司名称。对于账单和直接借记支付方式,这也意味着将调用相应的信用查询接口。 |
4.3 | 订单设置 | 在订单完成前分配订单号 | 如果此功能被激活,则最终Oxid订单号将在执行支付之前创建。如果支付被拒绝或最终用户未完成支付,则可能在通常连续上升的Oxid订单号中产生空缺。 |
4.4 | 订单设置 | jQuery | 如果使用的Oxid前端主题不使用jQuery,则必须在此处选择“使用自己的jQuery库”,因为CrefoPay插件需要jQuery支持。 |
4.5 | 订单设置 | 出生日期 | 在此可以配置出生日期的查询和存储。出生日期用于私人个人的信用查询。 |
4.6 | 订单设置 | 订单号前缀 | 在此可以指定CrefoPay插件自动生成的订单ID的前缀。这可以用于与其他非CrefoPay支付方式的区分。 |
4.7 | 订单设置 | 预付款支付目标 | 该模块扩展了订单确认电子邮件,并在预付款支付方式下增加了对最终用户重要的(银行账户)信息。使用此选项可以指定付款期限(天数),在此期限内,期望买家最迟进行转账。 |
4.8 | 订单设置 | 账单付款期限 | 注意:此选项不控制CrefoPay设置的支付监控和自动催款中的付款期限,而仅用于向Oxid商店客户提供显示。要调整CrefoPay的支付监控付款期限,请联系CrefoPay的联系人。 |
4.9 | 订单设置 | 购物车有效期 | 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数据库中不再需要的过时数据将在此处规定的时间期限到期后删除。 |