ccpay.js

CCPay

[English Doc] [中文文档]

This lib can be used in CCTip Box to get user info, request payment, etc.

JS SDK

Install

Install via NPM

npm install ccpay.js -S

Install via HTML Script

<script src="https://cdn.jsdelivr.net/npm/ccpay.js"></script>

Initialize

import CCPay from 'ccpay.js'
const ccpay = new CCPay({
  app_id: 'app_id_xxxx',
  debug: true, // Enable debug mode, log inside logs
})

Check CCPay environment

console.log(ccpay.env.isCCPay) // true/false

Login

Get user access_token and pass it to backend server to validate the validity of user.CCPay Merchant API Doc

ccpay.login().then(console.log).catch(console.error)

Response

{
  "sys_id": "87333djfd33j3jk33jk2", // The user id on CCTip platform
  "access_token": "accessTokenxxxxxxxxxxxxxxxxx", // User's access_token
  "expire_at": 1594613256, // Token validity period
}

Get user info

There is a whitelist that allows Apps within the whitelist to login and get user information directly from this SDK, without the need for user authorization.

ccpay.requestUserInfo()
  .then(console.log)
  .catch(console.log)

Response

{
    "sys_id": "893sfdjdu38dj389dj3", // Unique id for this user
    "nickname": "God",
    "avatar": "https://baidu.com/a.png",
    "sns_platform": "wechat", // The platform where user come from，including wechat/telegram/discord/twitter/reddit for now.
    "sns_id": "222323243f33333", // The user's id on the social platform, used to association with platform's account.
}

Deposit

Request user to deposit:

ccpay.requestDeposit({
  symbol: 'BCH'
})
  .then(res => {
    if (res) {
      console.log(res)
      alert('Deposit success')
    }
    else {
      alert('User cancelled')
    }
  })
  .catch(console.error)

It will return a amount after depositing successfully, otherwise it will return empty.

{
  "record_id": "record_id_xyz123",
  "symbol": "BCH",
  "amount": "123.456"
}

Get client version

console.log(ccpay.env.clientVersion) // '0.0.1'

Get client language

console.log(ccpay.env.language) // 'en', 'id-ID'