nicepay-node v0.2.14

nicepay-node

nicepay-node는 나이스페이먼츠라는 PG사의 신용카드 전자결제서비스 API인 NICEPAY API 1.0 및 NICEPAY BILLING API 1.0.6 버전을 Node.js에서 사용할 수 있게 해주는 모듈입니다.

* nicepay-node는 나이스페이먼츠와 무관합니다.

요구사항

• MID, MerchantKey: 나이스페이먼츠의 신용카드 전자결제서비스 신청 후 발급
• Node.js 8, 10+

설치

npm install nicepay-node
# 또는
yarn add nicepay-node

사용법

인증결제

구매자의 웹브라우저 또는 모바일 앱에 나이스페이먼츠의 결제창을 띄워 구매자가 원하는 카드사를 고를 수 있도록 합니다. 구매자가 카드사를 고르면 그 카드사의 결제창이 추가로 뜨고 구매자는 카드정보를 입력합니다. 그 정보는 나이스페이먼츠 및 판매자(aka 상점 또는 가맹점)의 서버를 통하지 않고 카드사로 직접 전송되고, 카드사에서 그 정보를 인증하면 그 인증정보가 콜백 호출 형식으로 판매자의 백엔드로 전송됩니다. 판매자는 이 정보를 이용해 나이스페이먼츠에 결제요청을 할 수 있습니다.

const express = require('express');
const Nicepay = require('nicepay-node');

const app = express();
const nicepay = new Nicepay({
  MID: '',
  MerchantKey: '',
  CharSet: 'utf-8',
});

app.post('/payment', express.json(), async (req, res) => {
  const {
    Amt,
    AuthToken,
    NextAppURL,
    TxTid: TID
  } = req.body;

  try {
    const result = await nicepay.checkout.charge({
      Amt,
      AuthToken,
      NextAppURL,
      TID,
    });

    console.log(result);
  } catch (err) {
    console.log(err);
  }
});

app.listen(3000, () => {
  console.log('Server listening on port 3000...');
});

빌링결제 (정기결제)

구매자가 판매자(aka 상점 또는 가맹점)의 상품을 정기적으로 구매하기로 동의한 경우, 구매자로부터 카드정보를 받아 나이스페이먼츠에 빌키를 신청하고, 이후에는 그 빌키만을 이용해 정기적으로 결제요청을 할 수 있습니다. 정기결제에 대한 개념은 아임포트의 매뉴얼에 잘 나와있습니다.

const Nicepay = require('nicepay-node');

const nicepay = new Nicepay({
  MID: '',
  MerchantKey: '',
  CharSet: 'utf-8',
});

nicepay
  .billing.createBID({
    CardNo: '',
    CardPw: '',
    ExpMonth: '',
    ExpYear: '',
    IDNo: '',
    Moid: '',
  })
  .then((result) => console.log(result))
  .catch((err) => console.log(err));

API

초기화

const Nicepay = require('nicepay-node');

const nicepay = new Nicepay(options);

options object

const options = {
  MID: '',
  MerchantKey: '',
  ...
};

인증결제 (checkout)

결제승인 요청

nicepay.checkout.charge(params)
  .then((result) => console.log(result))
  .catch((err) => console.log(err));

params object

const params = {
  Amt: 1000,
  AuthToken: '',
  NextAppURL: '',
  TID: '',
  ...
};

Response object | undefined

NICEPAY API 1.0 문서를 참고하시기 바랍니다.

본 라이브러리는 디버그 용도로 API의 응답사양에 EdiDate를 추가했습니다.

결제승인 요청에 대한 망취소

다음의 두 경우 기 요청한 결제승인에 대한 거래대사 불일치 방지를 위해 결제요청 취소요청을 진행하는데 이를 망취소라고 합니다.

1. 결제승인 요청 시 connection timeout이 발생한 경우
2. 결제승인 요청 후 read timeout이 발생한 경우

nicepay.checkout.cancelTimeoutCharge(params)
  .then((result) => console.log(result))
  .catch((err) => console.log(err));

params object

const params = {
  AuthToken: '',
  NetCancelURL: '',
  TID: '',
  ...
};

Response object | undefined

NICEPAY API 1.0 문서를 참고하시기 바랍니다.

본 라이브러리는 디버그 용도로 API의 응답사양에 EdiDate를 추가했습니다.

결제취소 요청

nicepay.checkout.cancelCharge(params)
  .then((result) => console.log(result))
  .catch((err) => console.log(err));

params object

const params = {
  CancelAmt: 1000,
  CancelMsg: '',
  Moid: '',
  PartialCancelCode: '',
  TID: '',
  ...
};

Response object | undefined

NICEPAY API 1.0 문서를 참고하시기 바랍니다.

본 라이브러리는 디버그 용도로 API의 응답사양에 EdiDate를 추가했습니다.

빌링결제 (billing)

빌키 발급 요청

nicepay.billing.createBID(params)
  .then((result) => console.log(result))
  .catch((err) => console.log(err));

params object

const params = {
  CardNo: '',
  CardPw: '',
  ExpMonth: '',
  ExpYear: '',
  IDNo: '',
  Moid: '',
  ...
};

Response object | undefined

{
  ResultCode: '',
  ResultMsg: '',
  BID: '',
  AuthDate: '',
  CardCode: '',
  CardName: '',
  TID: '',
  CardCl: '',
  AcquCardCode: '',
  AcquCardName: '',
  EdiDate: ''
}

본 라이브러리는 디버그 용도로 API의 응답사양에 EdiDate를 추가했습니다.

빌키 삭제 요청

nicepay.billing.deleteBID(params)
  .then((result) => console.log(result))
  .catch((err) => console.log(err));

params object

const params = {
  BID: '',
  Moid: '',
  ...
};

Response object | undefined

NICEPAY BILLING API 1.0.6 문서를 참고하시기 바랍니다.

본 라이브러리는 디버그 용도로 API의 응답사양에 EdiDate를 추가했습니다.

빌링 결제 승인 요청

nicepay.billing.charge(params)
  .then((result) => console.log(result))
  .catch((err) => console.log(err));

params object

const params = {
  Amt: 1000,
  BID: '',
  CardInterest: '',
  CardQuota: '',
  Moid: '',
  GoodsName: '',
  ...
};

Response object | undefined

{
  ResultCode: '',
  ResultMsg: '',
  AuthCode: '',
  AuthDate: '',
  AcquCardCode: '',
  AcquCardName: '',
  CardCode: '',
  CardName: '',
  CardQuota: '',
  CardInterest: '',
  CardCl: '',
  Amt: '',
  GoodsName: '',
  MID: '',
  Moid: '',
  BuyerName: '',
  TID: '',
  CardNo: '',
  EdiDate: ''
}

본 라이브러리는 디버그 용도로 API의 응답사양에 EdiDate를 추가했습니다.

빌링 결제 승인 취소 요청

nicepay.billing.cancelCharge(params)
  .then((result) => console.log(result))
  .catch((err) => console.log(err));

params object

const params = {
  CancelAmt: 1000,
  CancelMsg: '',
  Moid: '',
  PartialCancelCode: '',
  ...
};

Response object | undefined

NICEPAY BILLING API 1.0.6 문서를 참고하시기 바랍니다.

본 라이브러리는 디버그 용도로 API의 응답사양에 EdiDate를 추가했습니다.

라이센스

MIT