NodeJs

1. Install#

You can use package manager to install ksher-pay SDK.

1.1. npm#

npm install ksher-pay

1.2. yarn#

yarn add ksher-pay

2. How to use#

2.1. Prepare the configuration data#

// Please use you own host address and token...
const setting = {
  "host": "https://sandboxdoc.vip.ksher.net",
  "token": "your token",
}

2.2. Import the SDK and initialize#

const PaymentSDK = require("ksher-payment");
const MySDK = new PaymentSDK(setting);

// SDK for miniapp
const miniAppSDK = require('ksher-payment/src/miniapp')
const MyMiniAppSDK = new miniAppSDK(setting);

2.3. Create new order#

const data = {
    note: "Note to this order",                       
    redirect_url: "http://www.baidu.com",      
    redirect_url_fail: "http://www.baidu.com", 
    timestamp: "1623058159665",                // timestamp
    amount: 100,                               // the unit is cent.
    merchant_order_id: "202106070001"          // this should be uniq 
}

MySDK.orderCreate(data).then(({data})=>{
    console.log(data)             // order created successfully
    console.log(data.reference)   //Here is the payment link
}).catch(err => {
    console.log(err)              //error
})

2.4. Query order status#

const order_id = "202106070001"                // order id
const data = {
    timestamp: "1623058159665",                // time stamp
}

MySDK.orderQuery(order_id, data).then(({data})=>{
    console.log(data)
}).catch(err => {
    console.log(err)
})

2.5. Refund#

const order_id = '202106070001'
const data = {
    refund_order_id: "123456789001",           
    timestamp: "1623058159665",                
    refund_amount: 100                        
}

MySDK.orderRefund(order_id, data).then(({data})=>{
    console.log(data)
}).catch(err => {
    console.log(err)
})

2.6. Create new order for alipay miniapp#

2.6.1. Get orderStr#

const data = {
    amount: 100,                            // the unit is cent.
    merchant_order_id: "202106070001",      // this should be uniq 
    timestamp: "1623058159665",             // timestamp
    note: 'some note for this order',   
    channel: 'alipay',                  
    miniapp_openid: 'alipayOpenId',         // alipay user's openid
    miniapp_appid: 'alipayAppid',           // appid of alipay miniapp
}

MyMiniAppSDK.orderCreate(data).then(({data})=>{
    console.log(data)
    console.log(data.reference) // the orderStr
}).catch(err => {
    console.log(err)
})

2.6.2. Pay in alipay miniapp#

// run in alipay miniapp
my.tradePay({ orderStr: 'the reference value' })

2.7. Verify signature#

Verify signature from the webhook request

// this is a simple webhook
const webhookUrl = 'https://your-host.com/api/webhook'; // you webhook url
const data = {
  type: 'Order',
  instance: '1623817182537',
  code: 'StatusChange',
  message: 'Order Paid',
  signature: '944EFC0C6DB000A28C7BACEC6709AF119586F4E361F908DEAC576DA937A6F746'
}

const valid = MySDK.checkSignature(webhookUrl, data)
if(valid){
  console.log('success')
}

3. Reference#

The source code of the SDK is hosted in github, you are welcome to raise issue and PR.

https://github.com/ksher-solutions/payment_sdk_nodejs