web-payme-sdk

v1.4.27

Published

3 years ago

Web PayME SDK

Downloads

0High
0Medium
0Low

tamdtm

minhdat97

huynhtandat90

PayME SDK là bộ thư viện để các app có thể tương tác với PayME Platform. PayME SDK bao gồm các chức năng chính như sau:

Hệ thống đăng ký, đăng nhập, eKYC thông qua tài khoản ví PayME
Chức năng nạp rút chuyển tiền từ ví PayME.
Tích hợp các dịch vụ của PayME Platform.

Một số thuật ngữ

| | Name | Giải thích | |--|--|--| | 1 | app | Là app mobile iOS/Android hoặc web sẽ tích hợp SDK vào để thực hiện chức năng thanh toán ví PayME | | 2 | SDK | Là bộ công cụ hỗ trợ tích hợp ví PayME vào hệ thống app. | | 3 | backend | Là hệ thống tích hợp hỗ trợ cho app, server hoặc api hỗ trợ | | 4 | AES | Hàm mã hóa dữ liệu AES. Tham khảo | | 5 | RSA| Thuật toán mã hóa dữ liệu RSA. | | 6 | IPN |Instant Payment Notification , dùng để thông báo giữa hệ thống backend của app và backend của PayME|

Cài đặt

npm: npm install web-payme-sdk
yarn: yarn add web-payme-sdk

Usage

Hệ thống PayME sẽ cung cấp cho app tích hợp các thông tin sau:

PublicKey : Dùng để mã hóa dữ liệu, app tích hợp cần truyền cho SDK để mã hóa.
AppToken : AppToken cấp riêng định danh cho mỗi app, cần truyền cho SDK để mã hóa
SecretKey : Dùng đã mã hóa và xác thực dữ liệu ở hệ thống backend cho app tích hợp.

Bên App sẽ cung cấp cho hệ thống PayME các thông tin sau:

AppPublicKey : Sẽ gửi qua hệ thống backend của PayME dùng để mã hóa.
AppPrivateKey: Sẽ truyền vào PayME SDK để thực hiện việc giải mã.

Chuẩn mã hóa: RSA-512bit.

Khởi tạo thư viện

Trước khi sử dụng PayME SDK cần import component SDK và ref để sử dụng các chức năng.

Khi sử dụng tài khoản khác cần cập nhật lại param configs

import React, { Component, useRef } from 'react'
import WebPaymeSDK from 'web-payme-sdk'

class Example extends Component {
  const refWebPaymeSDK = useRef(null)
  const configs = {
      appToken,
      deviceId,
      publicKey,
      privateKey,
      env, 
      appId,
      partner,
      configColor
   }
  render() {
    return <WebPaymeSDK configs={configs} ref={refWebPaymeSDK} propStyle={propStyle} />
  }
}

Parameters

| Property | Type | Required | Description | | -------------- | ---------- | -------- | ------------------------------------------------------------ | | propStyle | object | No | Custom style cho component | | appToken | string | Yes | AppId cấp riêng định danh cho mỗi app, cần truyền cho SDK để mã hóa. | | publicKey | string | Yes | Dùng để mã hóa dữ liệu, app tích hợp cần truyền cho SDK để mã hóa. Do hệ thống PayME cung cấp cho app tích hợp. | | privateKey | string | Yes | app cần truyền vào để giải mã dữ liệu. Bên app sẽ cung cấp cho hệ thống PayME. | | deviceId | string |Yes | Là deviceId của thiết bị | | env | string | Yes |Là môi trường sử dụng SDK (sandbox, production) | | appId | string | Yes |Là appID khi đăng ký merchant sdk sẽ được hệ thống tạo cho | | partner | object | Yes | { paddingTop: Tùy biến vị trí góc trên cùng khi thiết bị trên app có tùy biến header-statusbar} | | configColor | string[] | Yes | configColor : là tham số màu để có thể thay đổi màu sắc giao dịch ví PayME, kiểu dữ liệu là chuỗi với định dạng #rrggbb. Nếu như truyền 2 màu thì giao diện PayME sẽ gradient theo 2 màu truyền vào. |

Mã lỗi của PayME SDK

| Hằng số | Mã lỗi | Giải thích | -------------- | ---------- | -------- | | EXPIRED | 401 | token hết hạn sử dụng | | ACCOUNT_LOCK | 405 | tài khoản bị khoá chủ động | | NETWORK | -1 | Kết nối mạng bị sự cố | | SYSTEM | -2 | Lỗi hệ thống | | LIMIT | -3 | app cần truyền vào để giải mã dữ liệu. Bên app sẽ cung cấp cho hệ thống PayME. | | NOT_ACTIVATED | -4 | Lỗi tài khoản chưa kích hoạt | | KYC_NOT_APPROVED | -5 | Lỗi tài khoản chưa được duyệt | | PAYMENT_ERROR | -6 | Thanh toán thất bại | | ERROR_KEY_ENCODE | -7 | Lỗi mã hóa/giải mã dữ liệu | | USER_CANCELLED | -8 | Người dùng thao tác hủy | | NOT_LOGIN | -9 | Lỗi tài khoản chưa login | | BALANCE_ERROR | -11 | Lỗi số dư ví không đủ | | UNKNOWN_PAYCODE | -12 | Lỗi thiếu thông tin payCode |

Các chức năng của PayME SDK

login()

Có 2 trường hợp

Dùng để login lần đầu tiên ngay sau khi khởi tạo PayME.
Dùng khi accessToken hết hạn, khi gọi hàm của SDK mà trả về mã lỗi ERROR_CODE.EXPIRED hoặc ERROR_CODE.ACCOUNT_LOCK, lúc này app cần gọi login lại để lấy accessToken dùng cho các chức năng khác.

Sau khi gọi login() thành công rồi thì mới gọi các chức năng khác của SDK ( openWallet, pay, ... )

const configsLogin = {
   ...configs,
   connectToken,
   phone,
   userId
}
refWebPaymeSDK.current.login(
   configsLogin,
   (response) => {
      // onSuccess
   },
   (error) => {
      // onError
   }
)

Constant

| Property | Type | Description | | ------------------ | ------ | ---------------------- | | ENV.SANDBOX | enum | Môi trường sandbox. | | ENV.PRODUCTION | enum | Môi trường production. |

| Property | Type | Description | | ------------------ | ------ | ---------------------- | | NOT_ACTIVATED | enum | Tài khoản chưa kích hoạt. | | NOT_KYC | enum | Tài khoản chưa định danh. | | KYC_APPROVED | enum | Tài khoản đã định danh. | | KYC_REVIEW | enum | Tài khoản đang chờ duyệt | | KYC_REJECTED | enum | Tài khoản bị từ chối |

Parameters

| Property | Type | Description | | -------------- | ---------- | ------------------------------------------------------------ | | connectToken | string | app cần truyền giá trị được cung cấp ở trên, xem cách tạo bên dưới. | | phone | string | Số điện thoại của hệ thống tích hợp | | userId | string, number | Là giá trị cố định duy nhất tương ứng với mỗi tài khoản khách hàng ở dịch vụ, thường giá trị này do server hệ thống được tích hợp cấp cho PayME SDK |

Cách tạo connectToken:

connectToken cần để truyền gọi api từ tới PayME và sẽ được tạo từ hệ thống backend của app tích hợp. Cấu trúc như sau:

import forge from 'node-forge'

function encryptAES(text, secretKey) {
  // parse data into base64
  const iv = Buffer.from(ivbyte);
  const algorithm = determineAlthorithm(secretKey);
  const cipher = crypto.createCipheriv(algorithm, secretKey, iv);
  let encrypted = cipher.update(text, 'utf8', 'base64');
  encrypted += cipher.final('base64');
  return encrypted;
}

const data = {
  timestamp: "2021-01-20T06:53:07.621Z",
  userId : "abc",
  phone : "0123456789"
};

const connectToken = encryptAES(JSON.stringify(data), appSecretkey)

Tạo connectToken bao gồm thông tin KYC (Dành cho các đối tác có hệ thống KYC riêng)

const data = {
  timestamp: "2021-01-20T06:53:07.621Z",
  userId : "abc",
  phone : "0123456789",
  kycInfo: {
    fullname: "Nguyễn Văn A",
    gender: "MALE",
    birthday: "1995-01-20T06:53:07.621Z",
    address: "15 Nguyễn cơ thạch",
    identifyType: "CMND",
    identifyNumber: "142744332",
    issuedAt: "2013-01-20T06:53:07.621Z",
    placeOfIssue: "Hồ Chí Minh",
    video: "https://file-examples-com.github.io/uploads/2017/04/file_example_MP4_480_1_5MG.mp4",
    face: "https://cdn.pixabay.com/photo/2015/04/23/22/00/tree-736885__480.jpg",
    image: {
      front: "https://cdn.pixabay.com/photo/2015/04/23/22/00/tree-736885__480.jpg",
      back: "https://cdn.pixabay.com/photo/2015/04/23/22/00/tree-736885__480.jpg"
    }
  }
};

const connectToken = encryptAES(JSON.stringify(data), appSecretkey)

Trong đó AES là hàm mã hóa theo thuật toán AES. Tùy vào ngôn ngữ ở server mà bên hệ thống dùng thư viện tương ứng. Xem thêm tại đây https://en.wikipedia.org/wiki/Advanced_Encryption_Standard

Tham số KycInfo

logout

⚠️⚠️⚠️ version 1.4.12 trở đi

Clear cache thông tin tài khoản đã login. Sau khi logout thì cần thực hiện login lại để thực hiện các chức năng.

refWebPaymeSDK.current.logout(
   (response) => {
      // onSuccess
   },
   (error) => {
      // onError
   }
)

getAccountInfo

App có thể dùng thuộc tính này sau khi khởi tạo SDK để biết được trạng thái liên kết tới ví PayME.

refWebPaymeSDK.current.getAccountInfo(
   (response) => {
      // onSuccess
   },
   (error) => {
      // onError
   }
)

openWallet - Mở UI chức năng PayME tổng hợp

Hàm này được gọi khi từ app tích hợp khi muốn gọi 1 chức năng PayME bằng cách truyền vào tham số Action như trên.

refWebPaymeSDK.current.openWallet(
   (response) => {
      // onSuccess
   },
   (error) => {
      // onError
   }
)

openHistory

Hàm này được gọi khi từ app tích hợp khi muốn mở lịch sử giao dịch từ ví.

** Yêu cầu tài khoản đã kích hoạt và định danh để mở lịc sử Ví

⚠️⚠️⚠️ version 1.4.10 trở đi

refWebPaymeSDK.current.openHistory(
   (response) => {
      // onSuccess
   },
   (error) => {
      // onError
   }
)

scanQR

Mở chức năng quét mã QR để thanh toán

⚠️⚠️⚠️ version 1.4.1 trở đi

refWebPaymeSDK.current.scanQR(
   {
      payCode: String
   },
   (response) => {
      // onSuccess
   },
   (error) => {
      // onError
   }
)

Định dạng QR:

const qrString = "{$type}|${storeId}|${action}|${amount}|${note}|${orderId}|${userName}"

action: loại giao dịch ('PAYMENT' => thanh toán)
amount: số tiền thanh toán
note: Mô tả giao dịch từ phía đối tác
orderId: mã giao dịch của đối tác, cần duy nhất trên mỗi giao dịch. Tối đa 22 kí tự.
storeId: ID của store phía công thanh toán thực hiên giao dịch thanh toán
userName: Tên tài khoản
type: OPENEWALLET

Ví dụ :

const qrString = "OPENEWALLET|54938607|PAYMENT|20000|Chuyentien|2445562323|taikhoan"

payQRCode

Hàm dùng để thanh toán mã QR code do đối tác cung cấp

⚠️⚠️⚠️ version 1.4.1 trở đi

refWebPaymeSDK.current.payQRCode(
   {
      qrContent: String,
      payCode: String,
      isShowResultUI: Boolean
   },
   (response) => {
      // onSuccess
   },
   (error) => {
      // onError
   }
)

deposit - Nạp tiền

refWebPaymeSDK.current?.deposit(
   {
      amount: Number,
      closeWhenDone: Boolean
   },
   (response) => {
      // onSuccess
   },
   (error) => {
      // onError
   }
);

withdraw - Rút tiền

refWebPaymeSDK.current?.withdraw(
   {
      amount: Number,
      closeWhenDone: Boolean
   },
   (response) => {
      // onSuccess
   },
   (error) => {
      // onError
   }
);

transfer - Chuyển tiền

refWebPaymeSDK.current?.transfer(
   {
      amount: Number,
      description: String
   },
   (response) => {
      // onSuccess
   },
   (error) => {
      // onError
   }
);

getListService

App có thể dùng thược tính này sau khi khởi tạo SDK để biết danh sách các dịch vụ mà PayME đang cung cấp

refWebPaymeSDK.current.getListService(
   (response) => {
      // onSuccess
   },
   (error) => {
      // onError
   }
)

openService

Hàm này được gọi khi từ app tích hợp khi muốn gọi 1 dịch vụ mà PayME cũng cấp bằng cách truyền vào tham số serviceCode như sau

refWebPaymeSDK.current.openService(
   serviceCode,
   (response) => {
      // onSuccess
   },
   (error) => {
      // onError
   }
)

getListPaymentMethod - ⚠️⚠️⚠️ Đã remove từ version 1.4.1 trở đi

Hàm này được gọi khi từ app tích hợp khi muốn lấy danh sách các phương thức thanh toán mà PayME cung cấp vs từng tài khoản sau khi tài khoản đã kích hoạt và định danh thành công, dùng để truyền vào hàm pay() để chọn trực tiếp phương thức thanh toán mà app đối tác muốn

refWebPaymeSDK.current.getListPaymentMethod(
   { 
      storeId
   },
   (response) => {
      // onSuccess
   },
   (error) => {
      // onError
   }
)

pay - Thanh toán

Hàm này được dùng khi app cần thanh toán 1 khoản tiền từ ví PayME đã được kích hoạt.

Khi thanh toán bằng ví PayME thì yêu cầu tài khoản đã kích hoạt,định danh và số dư trong ví phải lớn hơn số tiền thanh toán
Thông tin tài khoản lấy qua hàm getAccountInfo()
Thông tin số dư lấy qua hàm getWalletInfo()

⚠️⚠️⚠️ version 1.4.1 trở đi

const  data = {
  amount:  Number,
  orderId:  String,
  storeId:  Number?,
  extractData: String,
  note:  String,
  userName: String?,
  payCode: String,
  isShowResultUI: Boolean?,
}
refWebPaymeSDK.current.pay(
   data,
   (response) => {
      // onSuccess
   },
   (error) => {
      // onError
   }
);

getWalletInfo - Lấy các thông tin của ví

refWebPaymeSDK.current.getWalletInfo(response => {
   (response) => {
      // onSuccess
   },
   (error) => {
      // onError
   }
})

{
   "balance":  111,
   "cash":  1,
   "lockCash":  2
}

balance: App tích hợp có thể sử dụng giá trị trong key balance để hiển thị, các field khác hiện tại chưa dùng.

detail.cash: Tiền có thể dùng.

detail.lockCash: Tiền bị lock.

Danh sách phương thức thanh toán

| payCode | Phương thức thanh toán | | :------------| :-------------| | PAYME | Thanh toán ví PayME | | ATM | Thanh toán thẻ ATM Nội địa | | MANUAL_BANK | Thanh toán chuyển khoản ngân hàng | | CREDIT | Thanh toán thẻ tín dụng | | VIET_QR | Thanh toán VietQR |

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Cài đặt

Usage

Khởi tạo thư viện

Parameters

Mã lỗi của PayME SDK

Các chức năng của PayME SDK

login()

Constant

Parameters

logout

getAccountInfo

openWallet - Mở UI chức năng PayME tổng hợp

openHistory

scanQR

payQRCode

deposit - Nạp tiền

withdraw - Rút tiền

transfer - Chuyển tiền

getListService

openService

getListPaymentMethod - ⚠️⚠️⚠️ Đã remove từ version 1.4.1 trở đi

pay - Thanh toán

getWalletInfo - Lấy các thông tin của ví

Danh sách phương thức thanh toán

License