Pingpp PHP SDK

简介

lib 文件夹下是 PHP SDK 文件，
example 文件夹里面是简单的接入示例，该示例仅供参考。

版本要求

PHP 版本 5.3 及以上
你可以执行目录下的环境检测脚本，来进行一些基本检测

php PingppEnvInspect.php

安装

使用 Composer

在你自己的 composer.json 中添加以下代码

{
  "require": {
    "pingplusplus/pingpp-php": "dev-master"
  }
}

然后执行

composer install

使用 Composer 的 autoload 引入

require_once('vendor/autoload.php');

手动引入

require_once('/path/to/pingpp-php/init.php');

接入方法

初始化

\Pingpp\Pingpp::setApiKey('YOUR-KEY');

设置请求签名密钥

密钥需要你自己生成，公钥请填写到 Ping++ Dashboard

\Pingpp\Pingpp::setPrivateKeyPath('/path/to/your_rsa_private_key.pem');

支付

$ch = \Pingpp\Charge::create(
    array(
        'order_no'  => '123456789',
        'app'       => array('id' => 'APP_ID'),
        'channel'   => 'alipay',
        'amount'    => 100,
        'client_ip' => '127.0.0.1',
        'currency'  => 'cny',
        'subject'   => 'Your Subject',
        'body'      => 'Your Body',
        'extra'     => $extra
    )
);

由于 PHP 5.3 不支持 JsonSerializable JSON 序列化接口，当你需要将其放入其他数组或者对象时， 建议先将其转成数组，例：$arr = array('charge' => json_decode($ch, true))。

charge 查询

\Pingpp\Charge::retrieve('CHARGE_ID');

\Pingpp\Charge::all(array('limit' => 5));

退款

$ch = \Pingpp\Charge::retrieve('CHARGE_ID');
$re = $ch->refunds->create(array('description' => 'Refund Description');

退款查询

$ch = \Pingpp\Charge::retrieve('CHARGE_ID');
$ch->refunds->retrieve('REFUND_ID');

$ch = \Pingpp\Charge::retrieve('CHARGE_ID');
$ch->refunds->all(array('limit' => 5));

微信红包

\Pingpp\RedEnvelope::create(
    array(
        'order_no'  => '123456789',
        'app'       => array('id' => 'APP_ID'),
        'channel'   => 'wx_pub',
        'amount'    => 100,
        'currency'  => 'cny',
        'subject'   => 'Your Subject',
        'body'      => 'Your Body',
        'extra'     => array(
            'nick_name' => 'Nick Name',
            'send_name' => 'Send Name'
        ),
        'recipient'   => 'Openid',
        'description' => 'Your Description'
    )
);

查询指定微信红包

\Pingpp\RedEnvelope::retrieve('RED_ID');

查询微信红包列表

\Pingpp\RedEnvelope::all(array('limit' => 5));

微信公众号获取签名

如果使用微信 JS-SDK 来调起支付，需要在创建 charge 后，获取签名（signature），传给 HTML5 SDK。

$jsapi_ticket_arr = \Pingpp\WxpubOAuth::getJsapiTicket($wx_app_id, $wx_app_secret);
$ticket = $jsapi_ticket_arr['ticket'];

正常情况下，jsapi_ticket 的有效期为 7200 秒。由于获取 jsapi_ticket 的 api 调用次数非常有限，频繁刷新 jsapi_ticket 会导致 api 调用受限，影响自身业务，开发者必须在自己的服务器全局缓存 jsapi_ticket。

下面方法中 $url 是当前网页的 URL，不包含 # 及其后面部分

$signature = \Pingpp\WxpubOauth::getSignature($charge, $ticket, $url);

然后在 HTML5 SDK 里调用

pingpp.createPayment(charge, callback, signature, false);

event 查询

\Pingpp\Event::retrieve('EVT_ID');

event 列表查询

\Pingpp\Event::all(array('type' => 'charge.succeeded'));

详细信息请参考 API 文档。

微信企业付款

\Pingpp\Transfer::create(
    array(
        'amount' => 100,
        'order_no' => '123456d7890',
        'currency' => 'cny',
        'channel' => 'wx_pub',
        'app' => array('id' => 'APP_ID'),
        'type' => 'b2c',
        'recipient' => 'o9zpMs9jIaLynQY9N6yxcZ',
        'description' => 'testing',
        'extra' => array('user_name' => 'User Name', 'force_check' => true)
    )
);

查询指定 transfer

\Pingpp\Transfer::retrieve('TR_ID');

查询 transfer 列表

\Pingpp\Transfer::all(array('limit' => 5));

查询卡片信息

\Pingpp\CardInfo::query(array(
    'app' => 'APP_ID',
    'card_number' => 'ENCRYPTED_CARD_NUMBER'
));

创建 customer

\Pingpp\Customer::create(array(
    'app' => 'APP_ID',
    'source' => 'TOKEN_ID'
));

查询 customer

\Pingpp\Customer::retrieve('CUS_ID');

更新 customer

$cus = \Pingpp\Customer::retrieve('CUS_ID');
$cus['description'] = 'Customer Description';
$cus->save();

删除 customer

$cus = \Pingpp\Customer::retrieve('CUS_ID');
$cus->delete();

创建 card

$cus = \Pingpp\Customer::retrieve('CUS_ID');
$cus->sources->create(array(
    'source' => 'TOKEN_ID'
));

查询 card

$cus = \Pingpp\Customer::retrieve('CUS_ID');
$card = $cus->sources->retrieve('CARD_ID');

删除 card

$cus = \Pingpp\Customer::retrieve('CUS_ID');
$cus->sources->retrieve('CARD_ID')->delete();

身份证认证

\Pingpp\Identification::identify(array(
    'type' => 'id_card',
    'app' => $app_id,
    'data' => array(
        'id_name' => '张三', // 姓名
        'id_number' => '310181198910107641' // 身份证号
    )
));

银行卡认证

\Pingpp\Identification::identify(array(
    'type' => 'bank_card',
    'app' => $app_id,
    'data' => array(
        'id_name' => '张三', // 姓名
        'id_number' => '310181198910107641', // 身份证号,
        'card_number' => '6201111122223333', // 银行卡号
        'phone_number' => '18623234545' // 银行预留手机号，不支持 178 号段
    )
));