Bootpay Python Server Side Library

부트페이 공식 파이썬 라이브러리 입니다 (서버사이드 용)

PG 결제창 연동은 클라이언트 라이브러리에서 수행됩니다. (Javascript, Android, iOS, React Native, Flutter 등)
결제 검증 및 취소, 빌링키 발급, 본인인증 등의 수행은 서버사이드에서 진행됩니다. (Java, PHP, Python, Ruby, Node.js, Go, ASP.NET 등)

기능

(부트페이 통신을 위한) 토큰 발급 요청
결제 검증
결제 취소 (전액 취소 / 부분 취소)
빌링키 발급

4-1. 발급된 빌링키로 결제 승인 요청

4-2. 발급된 빌링키로 결제 승인 예약 요청

4-2-1. 발급된 빌링키로 결제 승인 예약 - 취소 요청

4-3. 빌링키 삭제

4-4. 빌링키 조회
(부트페이 단독) 사용자 토큰 발급
(부트페이 단독) 결제 링크 생성
서버 승인 요청
본인 인증 결과 조회

pypi로 설치하기

pip install bootpay

사용하기

example.y

from bootpay import Bootpay

rest_application_id = '5b8f6a4d396fa665fdc2b5ea'
rest_private_key = 'rm6EYECr6aroQVG2ntW0A6LpWnkTgP4uQ3H18sDDUYw='

bootpay = Bootpay(rest_application_id, rest_private_key)
result = bootpay.get_access_token()

print(result)
print(result['data']['token'])

2. 결제 검증

결제창 및 정기결제에서 승인/취소된 결제건에 대하여 올바른 결제건인지 서버간 통신으로 결제검증을 합니다.

from bootpay import Bootpay

bootpay = Bootpay('5b8f6a4d396fa665fdc2b5ea', 'rm6EYECr6aroQVG2ntW0A6LpWnkTgP4uQ3H18sDDUYw=')
receipt_id = ''

tokenResponse = bootpay.get_access_token()
if tokenResponse['status'] is 200:
    result = bootpay.verify(receipt_id)
    print(result)

3. 결제 취소 (전액 취소 / 부분 취소)

price를 지정하지 않으면 전액취소 됩니다.

휴대폰 결제의 경우 이월될 경우 이통사 정책상 취소되지 않습니다
정산받으실 금액보다 취소금액이 클 경우 PG사 정책상 취소되지 않을 수 있습니다. 이때 PG사에 문의하시면 되겠습니다.
가상계좌의 경우 CMS 특약이 되어있지 않으면 취소되지 않습니다. 그러므로 결제 테스트시에는 가상계좌로 테스트 하지 않길 추천합니다.

부분취는 카드로 결제된 건만 가능하며, 일부 PG사만 지원합니다. 요청시 price에 금액을 지정하시면 되겠습니다.

(지원가능 PG사: 이니시스, kcp, 다날, 페이레터, 나이스페이, 카카오페이, 페이코)

간혹 개발사에서 실수로 여러번 부분취소를 보내서 여러번 취소되는 경우가 있기때문에, 부트페이에서는 부분취소 중복 요청을 막기 위해 cancel_id 라는 필드를 추가했습니다. cancel_id를 지정하시면, 해당 건에 대해 중복 요청방지가 가능합니다.

from bootpay import Bootpay

bootpay = Bootpay('5b8f6a4d396fa665fdc2b5ea', 'rm6EYECr6aroQVG2ntW0A6LpWnkTgP4uQ3H18sDDUYw=')

tokenResponse = bootpay.get_access_token()
if tokenResponse['status'] == 200:
    result = bootpay.cancel('1234', 'test', 'test결제 취소')
    print(result)

4. 빌링키 발급

REST API 방식으로 고객으로부터 카드 정보를 전달하여, PG사에게 빌링키를 발급받을 수 있습니다. 발급받은 빌링키를 저장하고 있다가, 원하는 시점, 원하는 금액에 결제 승인 요청하여 좀 더 자유로운 결제시나리오에 적용이 가능합니다.

비인증 정기결제(REST API) 방식을 지원하는 PG사만 사용 가능합니다.

from bootpay import Bootpay

bootpay = Bootpay('5b8f6a4d396fa665fdc2b5ea', 'rm6EYECr6aroQVG2ntW0A6LpWnkTgP4uQ3H18sDDUYw=')

tokenResponse = bootpay.get_access_token()
if tokenResponse['status'] == 200:
    result = bootpay.get_subscribe_billing_key(
        'nicepay',
        str(time.time()),
        '30일 결제권',
        '[ 카드 번호 ]',
        '[ 카드 비밀번호 앞자리 2개 ]',
        '[ 카드 만료 연도 2자리 ]',
        '[ 카드 만료 월 2자리 ]',
        '[ 카드 소유주 생년월일 혹은 사업자 등록번호 ]',
        None,
        {
            'subscribe_test_payment': 1
        }
    )
    print(result)

4-1. 발급된 빌링키로 결제 승인 요청

발급된 빌링키로 원하는 시점에 원하는 금액으로 결제 승인 요청을 할 수 있습니다. 잔액이 부족하거나 도난 카드 등의 특별한 건이 아니면 PG사에서 결제를 바로 승인합니다.

from bootpay import Bootpay

bootpay = Bootpay('5b8f6a4d396fa665fdc2b5ea', 'rm6EYECr6aroQVG2ntW0A6LpWnkTgP4uQ3H18sDDUYw=')

tokenResponse = bootpay.get_access_token()
if tokenResponse['status'] == 200:
    result = bootpay.subscribe_billing('5b025b33e13f33310ce560fb', '정기 결제 테스트 아이템', 3000, '12345', [], {'username': 'test'})
    print(result)

4-2. 발급된 빌링키로 결제 예약 요청

원하는 시점에 4-1로 결제 승인 요청을 보내도 되지만, 빌링키 발급 이후에 바로 결제 예약 할 수 있습니다. (빌링키당 최대 5건)

from bootpay import Bootpay

bootpay = Bootpay('5b8f6a4d396fa665fdc2b5ea', 'rm6EYECr6aroQVG2ntW0A6LpWnkTgP4uQ3H18sDDUYw=')

tokenResponse = bootpay.get_access_token()
if tokenResponse['status'] == 200:
    result = bootpay.subscribe_billing_reserve(
        '612deb53019943001fb52312',
        '정기 결제 테스트 아이템',
        3000,
        '12345'
    )
    print(result)

4-2-1. 발급된 빌링키로 결제 예약 - 취소 요청

빌링키로 예약된 결제건을 취소합니다.

from bootpay import Bootpay

bootpay = Bootpay('5b8f6a4d396fa665fdc2b5ea', 'rm6EYECr6aroQVG2ntW0A6LpWnkTgP4uQ3H18sDDUYw=')

tokenResponse = bootpay.get_access_token()
if tokenResponse['status'] == 200:
    result = bootpay.subscribe_billing_reserve_cancel(
        '5e8d3c6f05df0f036ad43e41'
    )
    print(result)

4-3. 빌링키 삭제

발급된 빌링키로 더 이상 사용되지 않도록, 삭제 요청합니다.

from bootpay import Bootpay

bootpay = Bootpay('5b8f6a4d396fa665fdc2b5ea', 'rm6EYECr6aroQVG2ntW0A6LpWnkTgP4uQ3H18sDDUYw=')

tokenResponse = bootpay.get_access_token()
if tokenResponse['status'] == 200:
    result = bootpay.destroy_subscribe_billing_key(
        '5b025b33e13f33310ce560fb'
    )
    print(result)

4-4. 빌링키 조회

빌링키 발급시 리턴되었던 receipt_id로, 발급된 빌링키를 조회합니다.

bootpay = Bootpay('5b8f6a4d396fa665fdc2b5ea', 'rm6EYECr6aroQVG2ntW0A6LpWnkTgP4uQ3H18sDDUYw=')

tokenResponse = bootpay.get_access_token()
if tokenResponse['status'] == 200:
    result = bootpay.lookup_billing_key('receipt_id')
    print(result)

5. 사용자 토큰 발급

(부트페이 단독) 부트페이에서 제공하는 간편결제창, 생체인증 기반의 결제 사용을 위해서는 개발사에서 회원 고유번호를 관리해야하며, 해당 회원에 대한 사용자 토큰을 발급합니다. 이 토큰값을 기반으로 클라이언트에서 결제요청 하시면 되겠습니다.

from bootpay import Bootpay

bootpay = Bootpay('5b8f6a4d396fa665fdc2b5ea', 'rm6EYECr6aroQVG2ntW0A6LpWnkTgP4uQ3H18sDDUYw=')

tokenResponse = bootpay.get_access_token()
if tokenResponse['status'] == 200:
    result = bootpay.get_user_token({
        'user_id': '[[ 회원정보 아이디 ]]', # 필수
        'email': '[[ 회원 이메일 ]]', # 선택
        'name': '[[ 회원 이름 ]]', # 선택
        'gender': '[[ 성별, 0 - 여자, 1 - 남자 ]]', # 선택
        'birth': '[[ 회원 생년 월일 (6자리) ]]', # 선택
        'phone': '[[ 연락가능한 회원 번호 ]]' # 페이앱인 경우 필수, 나머지는 선택
    })
    print(result)

6. 결제 링크 생성

(부트페이 단독) 요청 하시면 결제링크가 리턴되며, 해당 url을 고객에게 안내, 결제 유도하여 결제를 진행할 수 있습니다.

from bootpay import Bootpay

bootpay = Bootpay('5b8f6a4d396fa665fdc2b5ea', 'rm6EYECr6aroQVG2ntW0A6LpWnkTgP4uQ3H18sDDUYw=')

tokenResponse = bootpay.get_access_token()
if tokenResponse['status'] == 200:
    result = bootpay.request_payment(
        'kcp',
        'card',
        None,
        1000,
        str(time.time()),
        None,
        0,
        '테스트 부트페이 상품'
    )
    print(result)

7. 서버 승인 요청

결제승인 방식은 클라이언트 승인 방식과, 서버 승인 방식으로 총 2가지가 있습니다.

클라이언트 승인 방식은 javascript나 native 등에서 confirm 함수에서 진행하는 일반적인 방법입니다만, 경우에 따라 서버 승인 방식이 필요할 수 있습니다.

필요한 이유

100% 안정적인 결제 후 고객 안내를 위해 - 클라이언트에서 PG결제 진행 후 승인 완료될 때 onDone이 수행되지 않아 (인터넷 환경 등), 결제 이후 고객에게 안내하지 못할 수 있습니다
단일 트랜잭션의 개념이 필요할 경우 - 재고파악이 중요한 커머스를 운영할 경우 트랜잭션 개념이 필요할 수 있겠으며, 이를 위해서는 서버 승인을 사용해야 합니다.

from bootpay import Bootpay

bootpay = Bootpay('5b8f6a4d396fa665fdc2b5ea', 'rm6EYECr6aroQVG2ntW0A6LpWnkTgP4uQ3H18sDDUYw=')
receipt_id = ''

tokenResponse = bootpay.get_access_token()
if tokenResponse['status'] == 200:
    result = bootpay.submit(receipt_id)
    print(result)

8. 본인 인증 결과 조회

다날 본인인증 후 결과값을 조회합니다. 다날 본인인증에서 통신사, 외국인여부, 전화번호 이 3가지 정보는 다날에 추가로 요청하셔야 받으실 수 있습니다.

from bootpay import Bootpay

bootpay = Bootpay('5b8f6a4d396fa665fdc2b5ea', 'rm6EYECr6aroQVG2ntW0A6LpWnkTgP4uQ3H18sDDUYw=')

tokenResponse = bootpay.get_access_token()
if tokenResponse['status'] == 200:
    result = bootpay.certificate('1234')
    print(result)

9. 빌링키를 receipt_id 로 조회하기

클라이언트에서 받은 자동결제 발급 receipt_id를 가지고 빌링키를 REST API로 가져옵니다.

from bootpay import Bootpay

bootpay = Bootpay('5b8f6a4d396fa665fdc2b5ea', 'rm6EYECr6aroQVG2ntW0A6LpWnkTgP4uQ3H18sDDUYw=')

tokenResponse = bootpay.get_access_token()
if tokenResponse['status'] == 200:
    result = bootpay.lookup_billing_key('receipt_id')
    print(result)

Example 프로젝트

적용한 샘플 프로젝트을 참조해주세요

Documentation

부트페이 개발매뉴얼을 참조해주세요

기술문의

부트페이 홈페이지 우측 하단 채팅을 통해 기술문의 주세요!

License

MIT License.

Release files for bootpay 1.0.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bootpay 1.0.7
File	Size	Uploaded
bootpay-1.0.7.tar.gz	12.5 kB	Jul 12, 2022	Details

Built distribution (wheel)

Table of built distributions (wheels) for bootpay 1.0.7
File	Interpreter	ABI	Platform	Reset
bootpay-1.0.7-py3-none-any.whl 10.1 kB Jul 12, 2022	Python 3	none	any	Details

Total release size: 22.7 kB

Release files / bootpay-1.0.7.tar.gz

Download URL	bootpay-1.0.7.tar.gz
Size	12.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`6ac1c74b87aae8029ec74605a48c03a3ba8c882bdc7602bb50e472690a047c36`
BLAKE2b-256 checksum How to use checksums	`cd2dbe9deb02eb472e79797b47a36d86dfe024e8222fb45fd43b3b064d787547`
Upload date	Jul 12, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.8.9`

Release files / bootpay-1.0.7-py3-none-any.whl

Download URL	bootpay-1.0.7-py3-none-any.whl
Size	10.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`9bc4fb41d061e008ea8dd0ccfc12142f9923ac5177865a649b31190ccb9336d6`
BLAKE2b-256 checksum How to use checksums	`35c4c13c9acd50777226afdb8139515a32c80fca1d530e848941e76f5ffa6e46`
Upload date	Jul 12, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.8.9`