Bootpay Ruby Server Side Library
부트페이 공식 Ruby 라이브러리 입니다 (서버사이드 용)
Ruby 언어로 작성된 어플리케이션, 프레임워크 등에서 사용가능합니다.
- PG 결제창 연동은 클라이언트 라이브러리에서 수행됩니다. (Javascript, Android, iOS, React Native, Flutter 등)
- 결제 검증 및 취소, 빌링키 발급, 본인인증 등의 수행은 서버사이드에서 진행됩니다. (Java, PHP, Python, Ruby, Node.js, Go, ASP.NET 등)
기능
- (부트페이 통신을 위한) 토큰 발급
- 결제 단건 조회
- 결제 취소 (전액 취소 / 부분 취소)
- 신용카드 자동결제 (빌링결제)
4-1. 빌링키 발급
4-2. 발급된 빌링키로 결제 승인 요청
4-3. 발급된 빌링키로 결제 예약 요청
4-4. 발급된 빌링키로 결제 예약 - 취소 요청
4-5. 빌링키 삭제
4-6. 빌링키 조회
- (생체인증, 비밀번호 결제를 위한) 구매자 토큰 발급
- 서버 승인 요청
- 본인 인증 결과 조회
- (에스크로 이용시) PG사로 배송정보 보내기
Gem으로 설치하기
gem 'bootpay-backend-ruby'
Gemfile에 위 라인을 추가하고, 아래 라인으로 인스톨 합니다.
$ bundle install
또는 아래 문장을 통해 바로 설치할 수 있습니다:
$ gem install bootpay-backend-ruby
사용하기
require 'bootpay-backend-ruby'
@api = Bootpay::RestClient.new(
application_id: '5b8f6a4d396fa665fdc2b5ea',
private_key: 'rm6EYECr6aroQVG2ntW0A6LpWnkTgP4uQ3H18sDDUYw=',
)
response = @api.request_access_token
if response.success?
puts response.data.to_json
end
함수 단위의 샘플 코드는 이곳을 참조하세요.
1. (부트페이 통신을 위한) 토큰 발급
부트페이와 서버간 통신을 하기 위해서는 부트페이 서버로부터 토큰을 발급받아야 합니다.
발급된 토큰은 30분간 유효하며, 최초 발급일로부터 30분이 지날 경우 토큰 발급 함수를 재호출 해주셔야 합니다.
api = Bootpay::RestClient.new(
application_id: '59bfc738e13f337dbd6ca48a',
private_key: 'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0='
)
api.request_access_token.success?
2. 결제 단건 조회
승인/취소된 결제건을 조회합니다. 위변조된 결제인지 검증하기 위해 사용됩니다.
api = Bootpay::RestClient.new(
application_id: '59bfc738e13f337dbd6ca48a',
private_key: 'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0='
)
if api.request_access_token.success?
response = api.receipt_payment(
"62a818cf1fc19203154a8f2e"
)
puts response.data.to_json
end
3. 결제 취소 (전액 취소 / 부분 취소)
price를 지정하지 않으면 전액취소 됩니다.
- 휴대폰 결제의 경우 이월될 경우 이통사 정책상 취소되지 않습니다
- 정산받으실 금액보다 취소금액이 클 경우 PG사 정책상 취소되지 않을 수 있습니다. 이때 PG사에 문의하시면 되겠습니다.
- 가상계좌의 경우 CMS 특약이 되어있지 않으면 취소되지 않습니다. 그러므로 결제 테스트시에는 가상계좌로 테스트 하지 않길 추천합니다.
부분취는 카드로 결제된 건만 가능하며, 일부 PG사만 지원합니다. 요청시 price에 금액을 지정하시면 되겠습니다.
- (지원가능 PG사: 이니시스, kcp, 다날, 페이레터, 나이스페이, 카카오페이, 페이코)
간혹 개발사에서 실수로 여러번 부분취소를 보내서 여러번 취소되는 경우가 있기때문에, 부트페이에서는 부분취소 중복 요청을 막기 위해 cancel_id 라는 필드를 추가했습니다. cancel_id를 지정하시면, 해당 건에 대해 중복 요청방지가 가능합니다.
api = Bootpay::RestClient.new(
application_id: '59bfc738e13f337dbd6ca48a',
private_key: 'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0='
)
if api.request_access_token.success?
response = api.cancel_payment(
receipt_id: "624a56111fc19202e4746df2",
cancel_price: 1000,
cancel_username: 'test_user',
cancel_message: 'test_message',
)
puts response.data.to_json
end
4-1. 빌링키 발급
REST API 방식으로 고객의 카드 정보를 전달하여, PG사로부터 빌링키를 발급받을 수 있습니다. (부트페이에서는 PG사의 빌링키를 개발사에게 전달하지 않고, 부트페이가 내부적으로 발급한 빌링키를 전달합니다) 발급받은 빌링키를 저장하고 있다가, 원하는 시점, 원하는 금액에 결제 승인 요청하여 좀 더 자유로운 결제시나리오에 적용이 가능합니다.
- 비인증 정기결제(REST API) 방식을 지원하는 PG사만 사용 가능합니다. ```ruby api = Bootpay::RestClient.new( application_id: '59bfc738e13f337dbd6ca48a', private_key: 'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0=' )
if api.request_access_token.success? response = @api.request_subscribe_billing_key( subscription_id: '1234', pg: 'nicepay', order_name: '테스트 결제', card_no: '', # 값 할당 필요, 카드번호 card_pw: '', # 값 할당 필요, 카드 비밀번호 2자리 card_expire_year: '', # 값 할당 필요, 카드 유효기간 연도 2자리 card_expire_month: '', # 값 할당 필요, 카드 유효기간 월 2자리 card_identity_no: '' # 값 할당 필요, 카드 소유주 생년월일 ) puts response.data.to_json end
## 4-2. 발급된 빌링키로 결제 승인 요청
발급된 빌링키로 원하는 시점에 원하는 금액으로 결제 승인 요청을 할 수 있습니다. 잔액이 부족하거나 도난 카드 등의 특별한 건이 아니면 PG사에서 결제를 바로 승인합니다.
```ruby
api = Bootpay::RestClient.new(
application_id: '59bfc738e13f337dbd6ca48a',
private_key: 'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0='
)
if api.request_access_token.success?
response = api.request_subscribe_card_payment(
billing_key: '6295cd1d1fc19202e4e319b0',
order_name: '테스트결제',
price: 1000,
card_quota: '00',
order_id: Time.current.to_i,
user: {
phone: '01000000000',
username: '홍길동',
email: '[email protected]'
}
)
puts response.data.to_json
end
4-3. 발급된 빌링키로 결제 예약 요청
원하는 시점에 4-1로 결제 승인 요청을 보내도 되지만, 빌링키 발급 이후에 바로 결제 예약 할 수 있습니다. (빌링키당 최대 10건)
api = Bootpay::RestClient.new(
application_id: '59bfc738e13f337dbd6ca48a',
private_key: 'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0='
)
if api.request_access_token.success?
response = api.subscribe_payment_reserve(
billing_key: '628c0d0d1fc19202e5ef2866',
order_name: '테스트결제',
price: 1000,
order_id: Time.current.to_i,
user: {
phone: '01000000000',
username: '홍길동',
email: '[email protected]'
},
reserve_execute_at: (Time.current + 30.seconds).iso8601
)
print response.data.to_json
end
4-4. 발급된 빌링키로 결제 예약 - 취소 요청
빌링키로 예약된 결제건을 취소합니다.
api = Bootpay::RestClient.new(
application_id: '59bfc738e13f337dbd6ca48a',
private_key: 'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0='
)
if api.request_access_token.success?
response = api.subscribe_payment_reserve(
billing_key: '623028630e019e036fe98478',
order_name: '테스트결제',
price: 1000,
order_id: Time.current.to_i,
user: {
phone: '01000000000',
username: '홍길동',
email: '[email protected]'
},
reserve_execute_at: (Time.current + 5.seconds).iso8601
)
puts response.data.to_json
if response.success?
puts "cancel reserve_id: #{response.data[:reserve_id]}"
cancel = api.cancel_subscribe_reserve(response.data[:reserve_id])
puts cancel.data.to_json
end
end
4-5. 빌링키 삭제
발급된 빌링키가 더 이상 사용되지 않도록, 삭제 요청합니다.
api = Bootpay::RestClient.new(
application_id: '59bfc738e13f337dbd6ca48a',
private_key: 'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0='
)
if api.request_access_token.success?
response = api.destroy_billing_key(
'6257bafb1fc19202e47471f7:'
)
print response.data.to_json
end
4-6. 빌링키 조회
(빌링키 발급 완료시 리턴받았던 receipt_id에 한정) 어떤 빌링키였는지 조회합니다.
api = Bootpay::RestClient.new(
application_id: '59bfc738e13f337dbd6ca48a',
private_key: 'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0='
)
if api.request_access_token.success?
response = api.lookup_subscribe_billing_key(
"624e4f7c1fc19202e4746f91"
)
print response.data.to_json
end
5. (생체인증, 비밀번호 결제를 위한) 구매자 토큰 발급
부트페이에서 제공하는 간편결제창, 생체인증 기반의 결제 사용을 위해서는 개발사에서 회원 고유번호를 관리해야하며, 해당 회원에 대한 사용자 토큰을 발급합니다. 이 토큰값을 기반으로 클라이언트에서 결제요청 하시면 되겠습니다.
api = Bootpay::RestClient.new(
application_id: '59bfc738e13f337dbd6ca48a',
private_key: 'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0='
)
if api.request_access_token.success?
response = api.request_user_token(
user_id: 'gosomi1',
phone: '01012345678'
)
print response.data.to_json
end
6. 서버 승인 요청
결제승인 방식은 클라이언트 승인 방식과, 서버 승인 방식으로 총 2가지가 있습니다.
클라이언트 승인 방식은 javascript나 native 등에서 confirm 함수에서 진행하는 일반적인 방법입니다만, 경우에 따라 서버 승인 방식이 필요할 수 있습니다.
필요한 이유
- 100% 안정적인 결제 후 고객 안내를 위해 - 클라이언트에서 PG결제 진행 후 승인 완료될 때 onDone이 수행되지 않아 (인터넷 환경 등), 결제 이후 고객에게 안내하지 못할 수 있습니다
- 단일 트랜잭션의 개념이 필요할 경우 - 재고파악이 중요한 커머스를 운영할 경우 트랜잭션 개념이 필요할 수 있겠으며, 이를 위해서는 서버 승인을 사용해야 합니다.
api = Bootpay::RestClient.new(
application_id: '59bfc738e13f337dbd6ca48a',
private_key: 'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0='
)
if api.request_access_token.success?
response = api.confirm_payment(
"61d3d41b1fc19202e483320b"
)
print response.data.to_json
end
7. 본인 인증 결과 조회
다날 본인인증 후 결과값을 조회합니다. 다날 본인인증에서 통신사, 외국인여부, 전화번호 이 3가지 정보는 다날에 추가로 요청하셔야 받으실 수 있습니다.
api = Bootpay::RestClient.new(
application_id: '59bfc738e13f337dbd6ca48a',
private_key: 'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0='
)
if api.request_access_token.success?
response = api.certificate(
"624d2e531fc19202e4746f40"
)
print response.data.to_json
end
8. (에스크로 이용시) PG사로 배송정보 보내기
현금 거래에 한해 구매자의 안전거래를 보장하는 방법으로, 판매자와 구매자의 온라인 전자상거래가 원활하게 이루어질 수 있도록 중계해주는 매매보호서비스입니다. 국내법에 따라 전자상거래에서 반드시 적용이 되어 있어야합니다. PG에서도 에스크로 결제를 지원하며, 에스크로 결제 사용을 원하시면 PG사 가맹시에 에스크로결제를 미리 얘기하고나서 진행을 하시는 것이 수월합니다.
PG사로 배송정보( 이니시스, KCP만 지원 )를 보내서 에스크로 상태를 변경하는 API 입니다.
api = Bootpay::RestClient.new(
application_id: '59bfc738e13f337dbd6ca48a',
private_key: 'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0=',
mode: 'development'
)
if api.request_access_token.success?
response = api.shipping_start(
receipt_id: "62a818cf1fc19203154a8f2e",
tracking_number: '123456',
delivery_corp: 'CJ대한통운',
user: {
username: '강훈',
phone: '01095735114',
address: '경기도 화성시 동탄기흥로 277번길 59',
zipcode: '08490'
}
)
print response.data.to_json
end
Example 프로젝트
적용한 샘플 프로젝트을 참조해주세요
Documentation
부트페이 개발매뉴얼을 참조해주세요
기술문의
부트페이 홈페이지 우측 하단 채팅을 통해 기술문의 주세요!