# VirtuePay Node.js SDK

## 简介
lib 文件夹下是 Node.js SDK 文件，  
example 文件夹里面是一个简单的接入示例，该示例仅供参考。
docs 接口文档

## 版本要求
nodejs 版本 4 及以上

## 安装
`npm install @virtuepay/virtuepay-node`

### 初始化
``` js
var virtuePay = require('@virtuepay/virtuepay-node`')('YOUR-KEY');
```

### 设置请求签名密钥
密钥需要你自己生成，公钥请填写到 [VirtuePay Dashboard](https://dashboard.virtuepay.cn)  
设置你的私钥路径
``` js
virtuePay.setPrivateKeyPath("/path/to/your_rsa_private_key.pem");
```
也可以设置私钥内容
``` js
virtuePay.setPrivateKey("你的 RSA 私钥内容字符串");
```

### 支付
``` js
virtuePay.charges.create({
  order_no:  "123456789",
  app:       { id: "APP_ID" },
  channel:   channel,
  amount:    100,
  client_ip: "127.0.0.1",
  currency:  "cny",
  subject:   "Your Subject",
  body:      "Your Body",
  extra:     extra
}, function(err, charge) {
  // YOUR CODE
});
```

### 查询
``` js
virtuePay.charges.retrieve(
  "CHARGE_ID",
  function(err, charge) {
    // YOUR CODE
  }
);
```
``` js
virtuePay.charges.list(
  { limit: 5 },
  function(err, charges) {
    // YOUR CODE
  }
);
```

### 退款
``` js
virtuePay.charges.createRefund(
  "CHARGE_ID",
  { amount: 100, description: "Refund Description" },
  function(err, refund) {
    // YOUR CODE
  }
);
```

### 退款查询
``` js
virtuePay.charges.retrieveRefund(
  "CHARGE_ID",
  "REFUND_ID",
  function(err, refund) {
    // YOUR CODE
  }
);
```
``` js
virtuePay.charges.listRefunds(
  "CHARGE_ID",
  { limit: 5 },
  function(err, refunds) {
    // YOUR CODE
  }
);
```

### 红包
``` js
virtuePay.redEnvelopes.create({
  order_no:    "123456789",
  app:         { id: "APP_ID" },
  channel:     "wx_pub",
  amount:      100,
  currency:    "cny",
  subject:     "Your Subject",
  body:        "Your Body",
  extra: {
    nick_name: "Nick Name",
    send_name: "Send Name"
  },
  recipient:   "Openid",
  description: "Your Description"
}, function(err, redEnvelope) {
  // YOUR CODE
});
```

### 微信公众号获取签名
如果使用微信 JS-SDK 来调起支付，需要在创建 `charge` 后，获取签名（`signature`），传给 HTML5 SDK。
``` js
virtuePay.wxOAuth.getJsapiTicket(wx_app_id, wx_app_secret, function(e, response){
  var ticket = response['ticket'];
});
```
**正常情况下，`jsapi_ticket` 的有效期为 7200 秒。由于获取 `jsapi_ticket` 的 api 调用次数非常有限，频繁刷新 `jsapi_ticket` 会导致 api 调用受限，影响自身业务，开发者必须在自己的服务器全局缓存 `jsapi_ticket`。**

_下面方法中 `url` 是当前网页的 URL，不包含`#`及其后面部分_
``` js
var signature = virtuePay.wxOAuth.getSignature(charge, ticket, url);
```
然后在 HTML5 SDK 里调用
``` js
virtuePay.createPayment(charge, callback, signature, false);
```

### Event 事件
``` js
virtuePay.events.retrieve(
  "EVENT_ID",
  function(err, event) {
    // YOUR CODE
  }
);
```

### 企业付款
``` js
virtuePay.transfers.create({
  order_no:    "123456789",
  app:         { id: "APP_ID" },
  channel:     "wx_pub",
  amount:      100,
  currency:    "cny",
  type:        "b2c",
  recipient:   "Openid",
  description: "Your Description"
}, function(err, transfer) {
  // YOUR CODE
});
```

### 企业付款取消
``` js
/* 企业付款取消 */
virtuePay.transfers.create({
  order_no:    "123456789",
  app:         { id: "APP_ID" },
  channel:     "unionpay",// 目前支持 wx(新渠道)、 wx_pub、 unionpay
  amount:      100,// 订单总金额, 人民币单位：分（如订单总金额为 1 元，此处请填 100,企业付款最小发送金额为 1 元）
  currency:    "cny",
  type:        "b2c",// 付款类型，当前仅支持 b2c 企业付款
  description: "Your Description",
  extra: {
    "user_name": "User Name",
    "card_number":"111111",
    "open_bank_code":"0100"
  }
}, function(err, transfer) {
  if (err) {
    console.log("virtuePay.transfers.create(unionpay) fail:",err)
    return
  }
  virtuePay.transfers.cancel(
    transfer.id,
    function(err, transfers) {
      if (err) {
        console.log("virtuePay.transfers.cancel fail:",err)
      }
      // YOUR CODE
    }
  );
});
```

### 企业付款查询
``` js
virtuePay.transfers.retrieve(
  "TRANSFER_ID",
  function(err, transfer) {
    // YOUR CODE
  }
);
```
``` js
virtuePay.transfers.list(
  { limit: 5 },
  function(err, transfers) {
    // YOUR CODE
  }
);
```

### 企业批量付款
``` js
virtuePay.batchTransfers.create({
  "app": "APP_ID" ,
  "batch_no": "123456789", // 批量付款批次号
  "channel": "alipay", // 目前只支持 alipay
  "amount": 8000, // 批量付款总金额
  "description": "Your Description",
  "recipients": [
    {
      "account": "account01@alipay.com", // 接收者支付宝账号
      "amount": 5000, // 付款金额
      "name": "李狗" // 接收者姓名
    },
    {
      "account": "account02@alipay.com", // 接收者支付宝账号
      "amount": 3000, // 付款金额
      "name": "伢子" // 接收者姓名
    }
  ],
  "type": "b2c" // 付款类型，当前仅支持 b2c 企业付款
}, function(err, transfer) {
  // YOUR CODE
});
```

### 企业批量付款查询
``` js
/* 查询 */
virtuePay.batchTransfers.retrieve(
  // 通过 Transfer 对象的 id 查询一个已创建的 Transfer 对象
  "181610181347533047",
  function(err, transfer) {
    // YOUR CODE
  }
);

/* 查询列表 */
virtuePay.batchTransfers.list(
  {page: 1},
  function(err, transfers) {
    // YOUR CODE
  }
);
```

### 身份证银行卡认证
``` js
virtuePay.identification.identify(
  {
    type: 'bank_card',
    app: 'APP_ID',
    data: {
      id_name: '张三',
      id_number: '320291198811110000',
      card_number: '6201111122223333'
    }
  },
  function(err, result) {
    // YOUR CODE
  }
);
```

### 接口列表
- [支付/退款](docs/charge.md)
- [红包](docs/red_envelope.md)
- [企业付款](docs/transfer.md)
- [企业批量付款](docs/batch_transfer.md)
- [账户](docs/user.md)
- [账户订单](docs/order.md)
- [账户充值](docs/recharge.md)
- [账户优惠券模板](docs/coupon_template.md)
- [账户优惠券](docs/coupon.md)
- [查询账户余额明细](docs/balance_transaction.md)
- [账户余额赠送](docs/balance_bonus.md)
- [账户余额转账](docs/balance_transfer.md)
- [账户余额提现](docs/withdrawal.md)
- [账户余额批量提现确认](docs/batch_withdrawal.md)
- [分润](docs/royalty.md)
- [分润结算](docs/royalty_settlement.md)
- [分润结算明细](docs/royalty_transaction.md)
- [分润模板](docs/royalty_template.md)
- [身份证银行卡认证](docs/identification.md)
- [Event 事件](docs/event.md)
- [报关接口](docs/transfer.md)
- [微信公众号/小程序获取 openid](docs/wx_oauth.md)
- [签约](docs/agreement.md)
- [余额结算](docs/balance_settlement.md)
- [查询银行卡信息](docs/card_info.md)

**详细信息请参考 [API 文档](https://virtuepay.cn/document/api?node.js)。**
