自定义支付说明

#### PC端

##### 支付部分

**第一步**

在libs/Niaoyun/Payment 目录下新建要接入的支付方式php文件,比如要接入Aapay支付则新建Aapay.class.php,若存在需要引入的SDK文件则也在该目录下新建文件夹存放，如下Aapay支付

![](https://upload.apayun.com/2020/09/5f4db0c60fbf0.png?token=ruertdcyNmNLBhmSkyCspQ&expires=1713572081)

**第二步**

创建的支付方式类需要继承libs/Niaoyun/Payment/PayInterface/Ipay.class.php接口类并实现里面的 `pay()` 、 `getConfigAdmin()` 以及 `getConfig()` 接口 (Ipay.class.php接口默认存在)

Ipay.class.php:

![](https://upload.apayun.com/2020/09/5f58925fcfdd3.png?token=yJ-fJKEeyYqOsUM6XsSNdw&expires=1713572081)

Aapay.class.php

![](https://upload.apayun.com/2020/12/5fd80f63ab823.png?token=lBt1oIvnwtuKC2VqJsYOrA&expires=1713572081)

其中 `getConfigAdmin` 用于获取接口配置项，并展示与【平台后台】-【系统】-【全局设置】-【充值】中，便于管理员修改接口信息

支付参数配置以实际接口为准，示例如下图：

![](https://upload.apayun.com/2020/09/5f4dbc8b600b3.png?token=yXxDCgcQxu1cPy_CDsVhdw&expires=1713572081)

获取平台配置数据

![](https://upload.apayun.com/2020/09/5f4dbcae0a267.png?token=_ytRHgkHYJ12CJoxUZcXaw&expires=1713572081)

平台参数配置位置：【后台】-【系统】-【全局设置】-【充值】

![](https://upload.apayun.com/2020/09/5f4dbcc51fde9.png?token=2U7iK1IrgP23fhJSpJL-sQ&expires=1713572081)

`getPayName` 方法为自定义支付名称，不实现该方法将用默认值。例：

![](https://upload.apayun.com/2020/12/5fd813127f37a.png?token=sqdLK8X-KxQMbruYPwPoDQ&expires=1713572081)

![](https://upload.apayun.com/2020/12/5fd813349d018.jpg?token=wbC7VREvaOfwjaJYOMTncg&expires=1713572081)

`pay` 方法接收一个数组参数$parameters格式如下:

| 字段        | 类型   | 描述               |
| ----------- | ------ | ------------------ |
| total_fee   | Float  | 付款金额           |
| out_trad_no | String | 订单系统唯一订单号 |
| body        | String | 订单名称           |

**第三步**

Aapay.class.php 实现的pay方法实现你自己的支付方式返回结果格式分为两种如下:

**第一种：**

支付方式是类似微信扫码支付，并且返回的地址需要使用js去生成二维码，则需要返回如下结果:

```php
[
    'code'=>200,  //200表示成功,201 表示失败	
    'code_url'=>$code_rul, //支付方式返回的是二维码数据，并需要使用js生成二维码的则用code_url字段，用于 iframe 页面（生成二维码的js平台已集成，不用另外开发）
    'msg'=>'success'  //成功success，失败fail
 ]
```

**第二种：**

支付方式是类似支付宝的页面跳转,则需要返回如下结果:

```php
 [
     'code'=>200,  //200表示成功,201 表示失败	
     'html_text'=>$html_text, //返回的是跳转链接则用html_text字段，用于新窗口打开的页面
     'msg'=>'success'  //成功success，失败fail
 ]
```

**第三种：**

支付方式是类似微信扫码支付，并且返回的地址是已生成好的二维码地址，则需要返回如下结果:

```php
 [
     'code'=>200,  //200表示成功,201 表示失败	
     'qrcode_url'=>$qrcode_url, //返回的是已经生成好的二维码地址，则用qrcode_url字段，，用于 iframe 页面
     'msg'=>'success'  //成功success，失败fail
 ]
```

Pass：两者返回的字段名不一样

**返回给前端的内容**
    用于二维码支付，根据type类型判断是否需要js生成二维码

```json
 {
    "result":true,
    "total_fee":"10.00",  //价格
    "type":"2",       //0:代表qrcodeUrl字段需要js生成二维码；1：新窗口打开；2：qrcodeUrl字段为已经生成好的二维码
    "qrcodeUrl":"http://qrcodeUrl.test.com/xxxx",   //二维码地址
    "orderNo":"123456789"  //订单编号
}
 ```

##### 回调部分

**第一步**

在 `app\ApiNotify\Controller\` 下创建回调php文件，比如：Aapay，则创建`AapayNotifyController.class.php`，继承并实现 `app\ApiNotify\controller\PaymentNotifyController`
.class.php 中的 checkSign 和 getPayStatus 这两个方法

![](https://upload.apayun.com/2020/09/5f589229b85a6.png?token=lMFC8fF0XOFY_fq86XyHTw&expires=1713572081)

![](https://upload.apayun.com/2020/10/5f8cf4e0d5f3c.png?token=XoC3-9DUMqRX8tzlEL6QWg&expires=1713572081)

![](https://upload.apayun.com/2020/10/5f8cf45fb665a.png?token=txengiz3_BTPtRI1Y5NjuQ&expires=1713572081)

**第二步**

支付回调成功地址：`http://您的平台域名/ApiNotify/AapayNotify/notify`

备注：

支付方式的图标放在 public/template/user/Zkeys/PC/static/css/ucModule/finance/img/ 下面，图标名字为支付方式名和创建的对应php文件类名一样

附思维导图流程截图:

![](https://upload.apayun.com/2019/05/5cefcd976abd3.png?token=jiCvbcE_XaZOT2Z2aq1JhA&expires=1713572081)

#### 手机版

#####  支付部分

**第一步**

在libs/Niaoyun/Payment 目录下新建要接入的支付方式php文件,比如要接入Xunhupay支付则新建Xunhupay.class.php,若存在需要引入的SDK文件则也在该目录下新建文件夹存放，如下Xunhupay支付

![](https://upload.apayun.com/2021/01/60063bdc65e9f.png?token=bl3NRk1PGCSRUFQggq0FRQ&expires=1713572081)

**第二步**

创建的支付方式类需要继承libs/Niaoyun/Payment/PayInterface/Ipay.class.php接口类并实现里面的 `wapPay()` 、 `getConfigAdmin()` 以及 `getConfig()` 接口 (Ipay.class.php接口默认存在)

`getPayName()` 接口可以实现，实现则支付时候显示为自定义名称，否则显示为类名

Ipay.class.php:

![](https://upload.apayun.com/2021/01/60063bc0eb94f.png?token=nTg3dvL_Ojx-G3l9lDQ4Lw&expires=1713572081)

Xunhupay.class.php

![](https://upload.apayun.com/2021/01/60063bb831f68.png?token=PM7Psd6EUUkPji0I3WXsPA&expires=1713572081)

未实现getPayName()方法，则默认为类名

![](https://upload.apayun.com/2021/01/60063bab47062.png?token=jUho8Maaef71MygJxSRrGQ&expires=1713572081)

实现getPayName()方法，则为自定义名称

![](https://upload.apayun.com/2021/01/60063ba2660e0.png?token=Sv0JNbh4OyVsYFCQbYQoZw&expires=1713572081)

其中支付参数配置如下，`configAdmin` 中的键必须在 `config` 中存在，如不需要在后台配置的参数，`configAdmin` 中可以省略，如apiurl在config中存在，在`configAdmin`中不存在， `getConfigAdmin` 用于获取接口配置项，并在【平台后台】-【系统】-【全局设置】-【充值】中展示，便于管理员修改接口信息

支付参数配置以实际接口为准，示例如下图：

![](https://upload.apayun.com/2021/01/60063b9a10f5f.png?token=9Jna02J0-lhmPMsTbsyE4w&expires=1713572081)

平台参数配置位置：【后台】-【系统】-【全局设置】-【充值】

![](https://upload.apayun.com/2021/01/60063b88e7834.png?token=Xjm08U1PGySWo0cb9qn_GA&expires=1713572081)

`wapPay` 方法接收一个数组参数$parameters格式如下:

**第三步**

wapPay方法实现你自己的支付方式，返回结果格式分为两种如下（大多数为第一种）

第一种(也是主流的方式)：

支付方式是类似微信H5支付，**进行URL重定向**,则需要返回如下结果:

```
 [
 'code'=>200,  //200表示成功,400 表示失败  
 'type'=>'redirect',  
 'url'=>$url, //返回的是即将跳转的RUL地址
 'msg'=>'success'  //成功success，失败fail
 ]
```

伪代码示例如下：

![](https://upload.apayun.com/2021/01/60063b7bd9ea5.png?token=m87F3Ezj0DZWOcTq1sVRNQ&expires=1713572081)

第二种：

支付方式返回的是一个html页面:

```php
[
    'code'=>200,  //200表示成功,400 表示失败
    'type'=> 'html', //固定类型，表示返回的是html页面    
    'html'=>$html,//支付方式返回的是一个新的html自动跳转页面
    'msg'=>'success'  //成功success，失败fail
]
```

伪代码示例如下：

![](https://upload.apayun.com/2021/01/60063b6cec92b.png?token=8iUYl6dgGrqypMnjeUMsPw&expires=1713572081)

##### 回调部分

**第一步**

在 `app\ApiNotify\Controller\` 下创建回调php文件，比如：Xunhupay，则创建`XunhupayNotifyController.class.php`，继承并实现 `app\ApiNotify\controller\PaymentNotifyController` .class.php 中的 checkSign 和 getPayStatus 这两个方法。这2个方法参数获取的是` I('request.') `，如果获取不到，请用其他正确方式，如$raw = file_get_contents('php://input'); （不同平台回调方式不一样）

![](https://upload.apayun.com/2021/01/60063b59774e6.png?token=ErjBjIDeSWtIP3RNsz_t5w&expires=1713572081)

![](https://upload.apayun.com/2021/01/60063b4c8eb28.png?token=J6VU16-5_VplNg_Knn42Bg&expires=1713572081)

![](https://upload.apayun.com/2021/01/60063b3ed9e5b.png?token=FyGCruwPs1NTAKfdxG-qvA&expires=1713572081)

**第二步**

支付回调成功地址：`http://您的平台域名/ApiNotify/{自定义支付类名} + Notify/notify`
如：`http://www.example.com/ApiNotify/XunhupayNotify/notify`

备注：

支付方式的图标放在 template\User\Zkeys\Mobile\Static\css\ucMobile\finance\img 下面，图标名字为支付方式名和创建的对应php文件类名一样，如Xunhupay.png。建议大小是40px * 40px

阿帕云引擎

云引擎受控端

云引擎控制器

云引擎开放API

文档首页

云业务管理系统（国内版）

18+

1000+

30+

5+