bootpay 1.0.1 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f4571d472aea39ea1af1906ba2d69cc60712f0438633cd697097bd03bdae78d
-  data.tar.gz: 9027f9825321d43c1f93c852cbb40605338dcccaed31f98ace4a05c7ca41ee1b
+  metadata.gz: 1db5c75a6a35e6085bb32d154260ceefd3dce35fc02b8419baba46f4a7c9166b
+  data.tar.gz: 138c6ffa96ef2cda07a575d35507e1fd98a9e4c767a90619e06a539f5abc0ec8
 SHA512:
-  metadata.gz: 3692d6c28adb7e876f1cf129482182b99eed58f5570bae2d07d1cf779ef255877402f59523e8a11ef8f5559a54824e12441a94a37503ccc2dd4d43b6f0621df5
-  data.tar.gz: d9c4056f3b02a808ff6358b6bf7ef52fa5f2ca1c0a35e60da2467e9cdbdc57bed9b08df2914aac77a65d15f4e716af167e486621329713105c5b94ae2f4aad8a
+  metadata.gz: b01db426e436f99f84a6bc741df6252cb3df6692aaa037ac264409d8574858548898296d591876097f70c29ea8ae5d6feee3b15403a88214c064df7686ab82f7
+  data.tar.gz: 0a85381bdf7a0018417803137124025c72a8f59a7dc5014884262f8aae380018e37b58615b2a6bbd06bf123606cd931527eb71a01208c6375a79a5f2d76c7752

data/CHANGELOG.md

@@ -1,5 +1,17 @@
-## [Unreleased]
+## 1.0.4
 
-## [0.1.0] - 2021-08-30
+- cancel에 refund 형식 수정 
 
-- Initial release
+## 1.0.3 
+
+- BankCode 추가
+
+## 1.0.2
+- certificate data type application/json 으로 수정
+
+## 1.0.1
+- namespace 변경  
+
+## 1.0.0
+
+- 첫 배포 

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 ehowlsla
+Copyright (c) 2021 bootpay
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,10 +1,33 @@
-# Bootpay Ruby 플러그인 
 
-Bootpay Ruby 라이브러리는 Ruby 언어로 작성된 어플리케이션, 프레임워크 등에서 사용가능합니다.
+## Bootpay Ruby Server Side Library
+부트페이 공식 Ruby 라이브러리 입니다 (서버사이드 용)
 
-## Installation
+Ruby 언어로 작성된 어플리케이션, 프레임워크 등에서 사용가능합니다.
+
+* PG 결제창 연동은 클라이언트 라이브러리에서 수행됩니다. (Javascript, Android, iOS, React Native, Flutter 등)
+* 결제 검증 및 취소, 빌링키 발급, 본인인증 등의 수행은 서버사이드에서 진행됩니다. (Java, PHP, Python, Ruby, Node.js, Go, ASP.NET 등)
+
+
+## 기능   
+1. (부트페이 통신을 위한) 토큰 발급 요청   
+2. 결제 검증   
+3. 결제 취소 (전액 취소 / 부분 취소)
+4. 빌링키 발급
+   
+    4-1. 발급된 빌링키로 결제 승인 요청
+   
+    4-2. 발급된 빌링키로 결제 승인 예약 요청
+   
+    4-2-1. 발급된 빌링키로 결제 승인 예약 - 취소 요청
+   
+    4-3. 빌링키 삭제
+5. (부트페이 단독) 사용자 토큰 발급   
+6. (부트페이 단독) 결제 링크 생성   
+7. 서버 승인 요청   
+8. 본인 인증 결과 조회
+
+## Gem으로 설치하기 
 
-Gemfile 파일을 이용하여 설치하기  
 
 ```ruby
 gem 'bootpay'
@@ -20,25 +43,229 @@ Gemfile에 위 라인을 추가하고, 아래 라인으로 인스톨 합니다.
 
     $ gem install backend-ruby
 
-## Getting Started
+## 사용하기 
 
 ```ruby
-    # 결제 검증하기 
-    receipt_id = '612df0250d681b001de61de6'
 
-    api = Bootpay::Api.new(
-      application_id: '5b8f6a4d396fa665fdc2b5ea',
-      private_key:    'rm6EYECr6aroQVG2ntW0A6LpWnkTgP4uQ3H18sDDUYw=',
+require 'bootpay'
+
+@api = Bootpay::Api.new(
+  application_id: '5b8f6a4d396fa665fdc2b5ea',
+  private_key:    'rm6EYECr6aroQVG2ntW0A6LpWnkTgP4uQ3H18sDDUYw=',
+)
+response = @api.request_access_token
+if response.success?
+  puts  response.data.to_json
+end
+```
+함수 단위의 샘플 코드는 [이곳](https://github.com/bootpay/backend-ruby/tree/main/spec/bootpay)을 참조하세요.
+
+
+## 1. 토큰 발급 
+
+부트페이와 서버간 통신을 하기 위해서는 부트페이 서버로부터 토큰을 발급받아야 합니다.  
+발급된 토큰은 30분간 유효하며, 최초 발급일로부터 30분이 지날 경우 토큰 발급 함수를 재호출 해주셔야 합니다.
+```ruby 
+def get_token
+  response = @api.request_access_token
+  if response.success?
+    puts  response.data.to_json
+  end
+end
+```
+
+
+## 2. 결제 검증 
+결제창 및 정기결제에서 승인/취소된 결제건에 대하여 올바른 결제건인지 서버간 통신으로 결제검증을 합니다.
+```ruby  
+def verification
+  receipt_id = '612df0250d681b001de61de6'
+  if @api.request_access_token.success?
+    response = @api.verify(receipt_id)
+    puts  response.data.to_json
+  end
+end
+```
+
+
+## 3. 결제 취소 (전액 취소 / 부분 취소)
+price를 지정하지 않으면 전액취소 됩니다. 
+* 휴대폰 결제의 경우 이월될 경우 이통사 정책상 취소되지 않습니다
+* 정산받으실 금액보다 취소금액이 클 경우 PG사 정책상 취소되지 않을 수 있습니다. 이때 PG사에 문의하시면 되겠습니다.
+* 가상계좌의 경우 CMS 특약이 되어있지 않으면 취소되지 않습니다. 그러므로 결제 테스트시에는 가상계좌로 테스트 하지 않길 추천합니다. 
+
+부분취는 카드로 결제된 건만 가능하며, 일부 PG사만 지원합니다. 요청시 price에 금액을 지정하시면 되겠습니다. 
+* (지원가능 PG사: 이니시스, kcp, 다날, 페이레터, 나이스페이, 카카오페이, 페이코)
+
+간혹 개발사에서 실수로 여러번 부분취소를 보내서 여러번 취소되는 경우가 있기때문에, 부트페이에서는 부분취소 중복 요청을 막기 위해 cancel_id 라는 필드를 추가했습니다. cancel_id를 지정하시면, 해당 건에 대해 중복 요청방지가 가능합니다.  
+```ruby 
+def cancel
+  if @api.request_access_token.success?
+    response = @api.cancel_payment(
+      receipt_id:      "612df0250d681b001de61de6",
+      cancel_username:        'test',
+      cancel_message:         'test',
+      cancel_price:     1000, # 부분취소 요청시
+      refund: { # 가상계좌 환불 요청시, 단 CMS 특약이 되어있어야만 환불요청이 가능하다.
+        account: '675601010124', # 환불계좌
+        accountholder: '홍길동', # 환불계좌주
+        bankcode: Bootpay::BANKCODE["국민은행"] # 은행코드
+      }
     )
-    if api.request_access_token.success?
-      response = api.verify(receipt_id)
-      print  response.data.to_json
-    end
+    puts  response.data.to_json
+  end
+end
 ```
 
+## 4. 빌링키 발급 
+REST API 방식으로 고객으로부터 카드 정보를 전달하여, PG사에게 빌링키를 발급받을 수 있습니다. 
+발급받은 빌링키를 저장하고 있다가, 원하는 시점, 원하는 금액에 결제 승인 요청하여 좀 더 자유로운 결제시나리오에 적용이 가능합니다.
+* 비인증 정기결제(REST API) 방식을 지원하는 PG사만 사용 가능합니다. 
+```ruby 
+def get_billing_key
+  if @api.request_access_token.success?
+    response = @api.get_billing_key(
+      order_id:         '1234',
+      pg:               'nicepay',
+      item_name:        '테스트 결제',
+      card_no:          '', # 값 할당 필요
+      card_pw:          '', # 값 할당 필요
+      expire_year:      '', # 값 할당 필요
+      expire_month:     '', # 값 할당 필요
+      identify_number:  '' # 값 할당 필요
+    )
+    puts response.data.to_json
+  end
+end
+```
+
+## 4-1. 발급된 빌링키로 결제 승인 요청  
+발급된 빌링키로 원하는 시점에 원하는 금액으로 결제 승인 요청을 할 수 있습니다. 잔액이 부족하거나 도난 카드 등의 특별한 건이 아니면 PG사에서 결제를 바로 승인합니다.
+
+```ruby  
+def subscribe_billing
+  billing_key = '612deb53019943001fb52312'
+  if @api.request_access_token.success?
+    response = @api.subscribe_billing(
+      billing_key:    billing_key,
+      item_name:      '테스트 결제',
+      price:          1000,
+      tax_free:       1000,
+      order_id:       '1234'
+    )
+    puts response.data.to_json
+  end
+end
+```
+## 4-2. 발급된 빌링키로 결제 예약 요청
+원하는 시점에 4-1로 결제 승인 요청을 보내도 되지만, 빌링키 발급 이후에 바로 결제 예약 할 수 있습니다. (빌링키당 최대 5건)
+```ruby  
+def subscribe_reserve_billing
+  billing_key = '612deb53019943001fb52312'
+  if @api.request_access_token.success?
+    response = @api.subscribe_reserve_billing(
+      billing_key:    billing_key,
+      item_name:      '테스트 결제',
+      price:          1000,
+      tax_free:       1000,
+      order_id:       '1234',
+      execute_at: (Time.now + 10.seconds).to_i # 10초 뒤 결제
+    )
+    puts response.data.to_json
+  end
+end
+```
+## 4-2-1. 발급된 빌링키로 결제 예약 - 취소 요청 
+빌링키로 예약된 결제건을 취소합니다. 
+```ruby  
+def subscribe_reserve_cancel
+  reserve_id = '612deb53019943001fb52312'
+  if @api.request_access_token.success?
+    response = @api.subscribe_reserve_cancel(reserve_id)
+    puts response.data.to_json
+  end
+end
+```
+## 4-3. 빌링키 삭제 
+발급된 빌링키로 더 이상 사용되지 않도록, 삭제 요청합니다.
+```java 
+Bootpay bootpay = new Bootpay("5b8f6a4d396fa665fdc2b5ea", "rm6EYECr6aroQVG2ntW0A6LpWnkTgP4uQ3H18sDDUYw=");
+
+try {
+    ResDefault res = bootpay.destroyBillingKey("6100e7ea0d681b001fd4de69");
+    System.out.println(res.toJson());
+} catch (Exception e) {
+    e.printStackTrace();
+}
+```
+## 5. 사용자 토큰 발급 
+(부트페이 단독) 부트페이에서 제공하는 간편결제창, 생체인증 기반의 결제 사용을 위해서는 개발사에서 회원 고유번호를 관리해야하며, 해당 회원에 대한 사용자 토큰을 발급합니다.
+이 토큰값을 기반으로 클라이언트에서 결제요청 하시면 되겠습니다.
+```ruby  
+def destroy_billing_key
+  if @api.request_access_token.success?
+    billing_key = '612debc70d681b0039e6133d'
+    response = @api.destroy_billing_key(billing_key)
+    puts response.data.to_json
+  end
+end
+```
+## 6. 결제 링크 생성 
+(부트페이 단독) 요청 하시면 결제링크가 리턴되며, 해당 url을 고객에게 안내, 결제 유도하여 결제를 진행할 수 있습니다. 
+```ruby  
+def request_link
+  if @api.request_access_token.success?
+    response = @api.request_link(
+      pg:             'nicepay',
+      price:          1000,
+      tax_free:       1000,
+      order_id:       '1234',
+      name:           '결제테스트'
+    )
+    puts response.data.to_json
+  end
+end
+```
+
+## 7. 서버 승인 요청 
+결제승인 방식은 클라이언트 승인 방식과, 서버 승인 방식으로 총 2가지가 있습니다.
+
+클라이언트 승인 방식은 javascript나 native 등에서 confirm 함수에서 진행하는 일반적인 방법입니다만, 경우에 따라 서버 승인 방식이 필요할 수 있습니다.
+
+필요한 이유 
+1. 100% 안정적인 결제 후 고객 안내를 위해 - 클라이언트에서 PG결제 진행 후 승인 완료될 때 onDone이 수행되지 않아 (인터넷 환경 등), 결제 이후 고객에게 안내하지 못할 수 있습니다  
+2. 단일 트랜잭션의 개념이 필요할 경우 - 재고파악이 중요한 커머스를 운영할 경우 트랜잭션 개념이 필요할 수 있겠으며, 이를 위해서는 서버 승인을 사용해야 합니다. 
+
+```ruby  
+def submit
+  receipt_id = '612e09260d681b0021e61ab9'
+  if @api.request_access_token.success?
+    response = @api.server_submit(receipt_id)
+    puts response.data.to_json
+  end
+end
+```
+
+## 8. 본인 인증 결과 조회 
+다날 본인인증 후 결과값을 조회합니다. 
+다날 본인인증에서 통신사, 외국인여부, 전화번호 이 3가지 정보는 다날에 추가로 요청하셔야 받으실 수 있습니다.
+```ruby 
+def certificate
+  receipt_id = '612e09260d681b0021e61ab9'
+  if @api.request_access_token.success?
+    response = @api.certificate(receipt_id)
+    puts response.data.to_json
+  end
+end
+```
+
+## Example 프로젝트
+
+[적용한 샘플 프로젝트](https://github.com/bootpay/backend-ruby-example)을 참조해주세요
+
 ## Documentation
 
-[부트페이 개발매뉴얼](https://app.gitbook.com/@bootpay)을 참조해주세요
+[부트페이 개발매뉴얼](https://bootpay.gitbook.io/docs/)을 참조해주세요
 
 ## 기술문의
 
@@ -46,4 +273,4 @@ Gemfile에 위 라인을 추가하고, 아래 라인으로 인스톨 합니다.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+[MIT License](https://opensource.org/licenses/MIT).

data/lib/bootpay/billing.rb

@@ -6,21 +6,32 @@ module Bootpay::Billing
     # Comment by ehowlsla
     # Date: 2021-08-30
     def get_billing_key(order_id: nil, pg: nil, item_name: nil, card_no: nil, card_pw: nil, expire_year: nil, expire_month: nil, identify_number: nil,
-                       user_info: {id: nil, username: nil, email: nil, phone: nil, gender: nil, area: nil, birth: nil},
-                       extra: {subscribeTestPayment: nil, raw_data: nil})
+                       user_info: { # 구매자 정보
+                         id: nil, #  개발사에서 관리하는 회원 고유 id
+                         username: nil, # 구매자 이름
+                         email: nil, # 구매자 email
+                         phone: nil, # 01012341234
+                         gender: nil, # 0:여자, 1:남자
+                         area: nil, # 서울|인천|대구|광주|부산|울산|경기|강원|충청북도|충북|충청남도|충남|전라북도|전북|전라남도|전남|경상북도|경북|경상남도|경남|제주|세종|대전 중 택 1
+                         birth: nil # 생일 901004
+                       },
+                       extra: { # 기타 설정
+                         subscribe_test_payment: nil, # subscribe_test_payment:100원 결제 후 결제가 되면 billing key를 발행, 결제가 실패하면 에러
+                         raw_data: nil # raw_data: PG 오류 코드 및 메세지까지 리턴
+                       })
       request(
         uri: 'request/card_rebill',
         payload:
           {
-            order_id:        order_id,
-            pg:              pg,
-            item_name:       item_name,
-            card_no:         card_no,
-            card_pw:         card_pw,
-            expire_year:     expire_year,
-            expire_month:    expire_month,
-            identify_number: identify_number,
-            user_info:       user_info,
+            order_id:        order_id, # 개발사에서 관리하는 고유 주문 번호
+            pg:              pg, # PG사의 Alias ex) danal, kcp, inicis 등
+            item_name:       item_name, # 상품명
+            card_no:         card_no, # 카드 일련번호
+            card_pw:         card_pw, # 카드 비밀번호 앞 2자리
+            expire_year:     expire_year, # 카드 유효기간 년
+            expire_month:    expire_month, # 카드 유효기간 월
+            identify_number: identify_number, # 주민등록번호 또는 사업자번호
+            user_info:       user_info, # 구매자 정보
             extra:           extra.values.any? {|v|v != nil} ? extra : nil
           }.compact
       )
@@ -40,9 +51,20 @@ module Bootpay::Billing
     # Comment by ehowlsla
     # Date: 2021-08-30
     def subscribe_billing(billing_key: nil, item_name: nil, price: 0, tax_free: 0, order_id: nil, quota: nil, interest: nil,
-                          user_info: {id: nil, username: nil, email: nil, phone: nil, gender: nil, area: nil, birth: nil},
+                          user_info: { # 구매자 정보
+                                       id: nil, #  개발사에서 관리하는 회원 고유 id
+                                       username: nil, # 구매자 이름
+                                       email: nil, # 구매자 email
+                                       phone: nil, # 01012341234
+                                       gender: nil, # 0:여자, 1:남자
+                                       area: nil, # 서울|인천|대구|광주|부산|울산|경기|강원|충청북도|충북|충청남도|충남|전라북도|전북|전라남도|전남|경상북도|경북|경상남도|경남|제주|세종|대전 중 택 1
+                                       birth: nil # 생일 901004
+                          },
                           feedback_url: nil, feedback_content_type: nil,
-                          extra: {subscribeTestPayment: nil, raw_data: nil})
+                          extra: { # 기타 설정
+                                   subscribe_test_payment: nil, # subscribe_test_payment:100원 결제 후 결제가 되면 billing key를 발행, 결제가 실패하면 에러
+                                   raw_data: nil # raw_data: PG 오류 코드 및 메세지까지 리턴
+                          })
       raise 'billing_key 값을 입력해주세요.' if billing_key.blank?
       raise 'item_name 값을 입력해주세요.' if item_name.blank?
       raise 'price 금액을 설정을 해주세요.' if price.blank?
@@ -50,17 +72,17 @@ module Bootpay::Billing
       request(
         uri: 'subscribe/billing',
         payload: {
-          billing_key:    billing_key,
-          item_name:      item_name,
-          price:          price,
-          tax_free:       tax_free,
-          order_id:       order_id,
-          quota:          quota,
-          interest:       interest,
+          billing_key:    billing_key, # 발급받은 빌링키
+          item_name:      item_name, # 결제할 상품명, 결제창에 노출됨
+          price:          price, # 결제할 상품금액
+          tax_free:       tax_free, # 면세 상품일 경우 해당만큼의 금액을 설정
+          order_id:       order_id, # 개발사에서 지정하는 고유주문번호
+          quota:          quota, # 5만원 이상 결제건에 대한 할부개월 노출 설정. 00-일시불, 01-1개월, 02-2개월 ... 12까지 지정가능, 만약 09로 지정할 경우 최대 9개월까지 선택가능. 지정하지 않을 경우 해당 PG사의 기본값 적용
+          interest:       interest, # 웰컴페이먼츠 전용, 무이자여부를 보내는 파라미터가 있다
           user_info:      user_info.values.any? {|v|v != nil} ? user_info : nil,
-          feedback_url:   feedback_url,
-          feedback_content_type: feedback_content_type,
-          extra:          extra.values.any? {|v|v != nil} ? extra : nil
+          feedback_url:   feedback_url, # webhook 통지시 받으실 url 주소 (localhost 사용 불가)
+          feedback_content_type: feedback_content_type.presence || 'urlencoded', # webhook 통지시 받으실 데이터 타입 (json 또는 urlencoded, 기본값 urlencoded)
+          extra:          extra.values.any? {|v|v != nil} ? extra : nil # subscribe_test_payment:100원 결제 후 결제가 되면 billing key를 발행, 결제가 실패하면 에러, raw_data: PG 오류 코드 및 메세지까지 리턴
         }.compact,
       )
     end
@@ -72,7 +94,7 @@ module Bootpay::Billing
                           user_info: {id: nil, username: nil, email: nil, phone: nil, gender: nil, area: nil, birth: nil},
                           feedback_url: nil, feedback_content_type: nil,
                           extra: {subscribeTestPayment: 0, raw_data: 0},
-                          scheduler_type: nil, execute_at: nil)
+                          execute_at: nil)
       raise 'billing_key 값을 입력해주세요.' if billing_key.blank?
       raise 'item_name 값을 입력해주세요.' if item_name.blank?
       raise 'price 금액을 설정을 해주세요.' if price.blank?
@@ -80,19 +102,19 @@ module Bootpay::Billing
       request(
         uri: 'subscribe/billing/reserve',
         payload: {
-          billing_key:    billing_key,
-          item_name:      item_name,
-          price:          price,
-          tax_free:       tax_free,
-          order_id:       order_id,
-          quota:          quota,
-          interest:       interest,
+          billing_key:    billing_key, # 발급받은 빌링키
+          item_name:      item_name, # 결제할 상품명, 결제창에 노출됨
+          price:          price, # 결제할 상품금액
+          tax_free:       tax_free, # 면세 상품일 경우 해당만큼의 금액을 설정
+          order_id:       order_id, # 개발사에서 지정하는 고유주문번호
+          quota:          quota, # 5만원 이상 결제건에 대한 할부개월 노출 설정. 00-일시불, 01-1개월, 02-2개월 ... 12까지 지정가능, 만약 09로 지정할 경우 최대 9개월까지 선택가능. 지정하지 않을 경우 해당 PG사의 기본값 적용
+          interest:       interest, # 웰컴페이먼츠 전용, 무이자여부를 보내는 파라미터가 있다
           user_info:      user_info.values.any? {|v|v != nil} ? user_info : nil,
-          feedback_url:   feedback_url,
-          feedback_content_type: feedback_content_type,
-          extra:          extra.values.any? {|v|v != nil} ? extra : nil,
-          scheduler_type: scheduler_type.presence || 'oneshot',
-          execute_at:     execute_at.presence || (Time.now + 10.seconds).to_i
+          feedback_url:   feedback_url,  # webhook 통지시 받으실 url 주소 (localhost 사용 불가)
+          feedback_content_type: feedback_content_type.presence || 'urlencoded', # webhook 통지시 받으실 데이터 타입 (json 또는 urlencoded, 기본값 urlencoded)
+          extra:          extra.values.any? {|v|v != nil} ? extra : nil, # subscribe_test_payment:100원 결제 후 결제가 되면 billing key를 발행, 결제가 실패하면 에러, raw_data: PG 오류 코드 및 메세지까지 리턴
+          scheduler_type: 'oneshot',
+          execute_at:     execute_at.presence || (Time.now + 10.seconds).to_i # 예약 실행시간, 미지정 시 10초뒤 실행
         }.compact,
         )
     end

data/lib/bootpay/cancel.rb

@@ -6,18 +6,18 @@ module Bootpay::Cancel
     # Comment by Gosomi
     # Date: 2021-05-21
     def cancel_payment(cancel_id: nil, receipt_id:, cancel_price: nil, cancel_tax_free: 0, cancel_username: '시스템', cancel_message: '결제취소',
-                       refund: { bank_account: nil, bank_username: nil, bank_code: nil })
+                       refund: { account: nil, accountholder: nil, bankcode: nil })
       request(
         uri: 'cancel',
         payload:
              {
-               cancel_id:       cancel_id.presence || SecureRandom.uuid,
-               receipt_id:      receipt_id,
-               price:           cancel_price,
-               tax_free:        cancel_tax_free,
-               name:            cancel_username,
-               reason:          cancel_message,
-               refund:          refund.values.any? {|v|v != nil} ? refund : nil
+               cancel_id:       cancel_id.presence || SecureRandom.uuid, # (선택사항) 부분취소 요청시 중복 요청을 방지하기 위한 고유값
+               receipt_id:      receipt_id, # 부트페이에서 발급한 영수증 id
+               price:           cancel_price, # (선택사항) 부분취소 요청시 금액을 지정, 미지정시 전액 취소 (부분취소가 가능한 PG사, 결제수단에 한해 적용됨)
+               tax_free:        cancel_tax_free, # 취소할 비과세 금액
+               name:            cancel_username, # 취소 요청자 이름
+               reason:          cancel_message, # 취소 요청 사유
+               refund:          refund.values.any? {|v|v != nil} ? refund : nil # (선택사항) 가상계좌 환불요청시, 전제조건으로 PG사와 CMS 특약이 체결되어 있을 경우에만 환불요청 가능, 기본적으로 가상계좌는 결제취소가 안됨
              }.compact
       )
     end

data/lib/bootpay/easy.rb

@@ -12,12 +12,12 @@ module Bootpay::Easy
       request(
         uri: 'request/user/token',
         payload: {
-          user_id: user_id,
-          email: email,
-          name: name,
-          gender: gender,
-          birth: birth,
-          phone: phone
+          user_id: user_id, # 개발사에서 관리하는 회원 고유 id
+          email: email, # 회원 email
+          name: name, # 회원명
+          gender: gender, # 0:여자, 1:남자
+          birth: birth, # 생일 901004
+          phone: phone # 01012341234
         }.compact
       )
     end

data/lib/bootpay/escrow.rb

@@ -3,7 +3,8 @@ module Bootpay::Escrow
 
   included do
 
-    # bootpay dev api
+
+    # @deprecated, 사용되지 않는 api
     # Comment by Gosomi
     # Date: 2020-06-18
     # @return [Hash]

data/lib/bootpay/link.rb

@@ -8,24 +8,33 @@ module Bootpay::Link
   included do
     def request_link(pg: nil, method: nil, methods: nil, price: nil, order_id: nil, params: nil, tax_free: nil, name: nil,
                      user_info: {id: nil, username: nil, email: nil, phone: nil, gender: nil, area: nil, birth: nil},
-                     items: nil, return_url: nil,
-                     extra: {escrow: nil, expire_month: nil, quota: nil, subscribe_test_payment: nil, disp_cash_result: nil, offer_period: nil, seller_name: nil, theme: nil, custom_background: nil, custom_font_color: nil })
+                     items: nil,
+                     extra: {
+                       escrow: nil, # 에스크로 연동 시 true, 기본값 false
+                       quota: nil, #List<int> 형태,  결제금액이 5만원 이상시 할부개월 허용범위를 설정할 수 있음, ex) "0,2,3" 지정시 - [0(일시불), 2개월, 3개월] 허용, 미설정시 PG사별 기본값 적용
+                       disp_cash_result: nil, # 현금영수증 노출할지 말지 (가상계좌 이용시)
+                       offer_period: nil, # 통합결제창, PG 정기결제창에서 표시되는 '월 자동결제'에 해당하는 문구를 지정한 값으로 변경, 지원하는 PG사만 적용 가능
+                       theme: nil, # 통합결제창 테마, [ red, purple(기본), custom ] 중 택 1
+                       custom_background: nil, # 통합결제창 배경색,  ex) "#00a086" theme가 custom 일 때 background 색상 지정 가능
+                       custom_font_color: nil # 통합결제창 글자색,  ex) "#ffffff" theme가 custom 일 때 font color 색상 지정 가능
+                     }
+    )
       request(
         uri: 'request/payment',
         payload:
           {
-            pg:               pg,
-            method:           method,
-            methods:          methods,
-            price:            price,
-            order_id:         order_id,
-            params:           params,
-            tax_free:         tax_free,
-            name:             name,
-            user_info:        user_info,
-            items:            items,
-            return_url:       return_url,
-            extra:            extra.values.any? {|v|v != nil} ? extra : nil
+            pg:               pg, # [PG 결제] 사용하고자 하는 PG사의 Alias를 입력. ex) danal, kcp, inicis등, 미 지정시 통합결제창이 오픈
+            method:           method, # card:카드, phone: 휴대폰, bank: 실시간 계좌이체, vbank: 가상계좌, auth: 본인인증, card_rebill: 정기결제, easy: 카카오,페이코,네이버페이 등의 간편결제, 미지정시 통합결제창 오픈
+            methods:          methods, # 통합결제시 사용할 method 배열 형태
+            price:            price, # 결제금액
+            order_id:         order_id, # 개발사에서 관리하는 고유결제번호
+            params:           params, # string 형태로 전달 할 값, 결제 후 똑같이 리턴해드림
+            tax_free:         tax_free, # 비과세 금액
+            name:             name, # 결제할 상품명
+            user_info:        user_info, # 구매자 정보
+            items:            items, #  상품정보
+            # return_url:       return_url, # 결제후 이동할 페이지 url, 아직 사용하지 않음
+            extra:            extra.values.any? {|v|v != nil} ? extra : nil # 기타 옵션
           }.compact
       )
     end

data/lib/bootpay/version.rb

@@ -1,6 +1,25 @@
 # frozen_string_literal: true
 
 module Bootpay
-  VERSION = "1.0.1"
+  VERSION = "1.0.5"
+  BANKCODE = {
+    "한국은행" => "001",
+    "기업은행" => "003",
+    "국민은행" => "004",
+    "외환은행" => "005",
+    "수협은행" => "007",
+    "농협은행" => "011",
+    "우리은행" => "020",
+    "SC은행" => "023",
+    "대구은행" => "031",
+    "부산은행" => "032",
+    "광주은행" => "034",
+    "경남은행" => "039",
+    "우체국" => "071",
+    "KEB하나은행" => "081",
+    "신한은행" => "088",
+    "케이뱅크" => "089",
+    "카카오뱅크" => "090",
+  }
 end
   

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootpay
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.5
 platform: ruby
 authors:
 - bootpay
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-03 00:00:00.000000000 Z
+date: 2021-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -56,6 +56,11 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- bootpay-1.0.0.gem
+- bootpay-1.0.1.gem
+- bootpay-1.0.2.gem
+- bootpay-1.0.3.gem
+- bootpay-1.0.4.gem
 - bootpay.gemspec
 - lib/.DS_Store
 - lib/bootpay.rb