bootpay-backend 2.2.0
bootpay server side plugin for python
License: MIT
Requires Python: !=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7


## Bootpay Python Server Side Library
부트페이 공식 파이썬 라이브러리 입니다 (서버사이드 용)

Python 언어로 작성된 어플리케이션, 프레임워크 등에서 사용가능합니다.

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

## 목차 
- [사용하기](#사용하기)
   - [1. 토큰 발급](#1-토큰-발급)
   - [2. 결제 단건 조회](#2-결제-단건-조회)
   - [3. 결제 취소 (전액 취소 / 부분 취소)](#3-결제-취소-전액-취소--부분-취소)
   - [4. 자동/빌링/정기 결제](#4-자동빌링정기-결제)
      - [4-1. 카드 빌링키 발급](#4-1-카드-빌링키-발급)
      - [4-2. 계좌 빌링키 발급](#4-2-계좌-빌링키-발급)
      - [4-3. 결제 요청하기](#4-3-결제-요청하기)
      - [4-4. 결제 예약하기](#4-4-결제-예약하기)
      - [4-5. 예약 조회하기](#4-5-예약-조회하기)
      - [4-6. 예약 취소하기](#4-6-예약-취소하기)
      - [4-7. 빌링키 삭제하기](#4-7-빌링키-삭제하기)
      - [4-8. 빌링키 조회하기](#4-8-빌링키-조회하기)
   - [5. 회원 토큰 발급요청](#5-회원-토큰-발급요청)
   - [6. 서버 승인 요청](#6-서버-승인-요청)
   - [7. 본인 인증 결과 조회](#7-본인-인증-결과-조회)
   - [8. 에스크로 이용시 PG사로 배송정보 보내기](#8-에스크로-이용시-pg사로-배송정보-보내기)
   - [9-1. 현금영수증 발행하기](#9-1-현금영수증-발행하기)
   - [9-2. 현금영수증 발행 취소](#9-2-현금영수증-발행-취소)
   - [9-3. 별건 현금영수증 발행](#9-3-별건-현금영수증-발행)
   - [9-4. 별건 현금영수증 발행 취소](#9-4-별건-현금영수증-발행-취소)
- [Example 프로젝트](#example-프로젝트)
- [Documentation](#documentation)
- [기술문의](#기술문의)
- [License](#license)


## pypi로 설치하기
```
pip install bootpay-backend
```

# 사용하기

```python

from bootpay_backend import BootpayBackend

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

token = bootpay.get_access_token() 
if 'error_code' not in token:
    # 토큰 발급 성공 
    print(token)
```


## 1. 토큰 발급

부트페이와 서버간 통신을 하기 위해서는 부트페이 서버로부터 토큰을 발급받아야 합니다.  
발급된 토큰은 30분간 유효하며, 최초 발급일로부터 30분이 지날 경우 토큰 발급 함수를 재호출 해주셔야 합니다.

```python
bootpay = BootpayBackend('5b8f6a4d396fa665fdc2b5ea', 'rm6EYECr6aroQVG2ntW0A6LpWnkTgP4uQ3H18sDDUYw=')

token = bootpay.get_access_token() 
if 'error_code' not in token:
    # 토큰 발급 성공 
    print(token)
```


## 2. 결제 단건 조회
결제창 및 정기결제에서 승인/취소된 결제건에 대하여 올바른 결제건인지 서버간 통신으로 결제검증을 합니다.
```python 
response = bootpay.receipt_payment('62b2c3c2d01c7e001bc20b10')
if 'error_code' not in response:
    # 요청 성공 
    print(response)
```

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

부분취는 카드로 결제된 건만 가능하며, 일부 PG사만 지원합니다. 요청시 price에 금액을 지정하시면 되겠습니다. 
* (지원가능 PG사: 이니시스, kcp, 다날, 페이레터, 나이스페이, 카카오페이, 페이코)

간혹 개발사에서 실수로 여러번 부분취소를 보내서 여러번 취소되는 경우가 있기때문에, 부트페이에서는 부분취소 중복 요청을 막기 위해 cancel_id 라는 필드를 추가했습니다. cancel_id를 지정하시면, 해당 건에 대해 중복 요청방지가 가능합니다.  
```python 
response = bootpay.cancel_payment(
        receipt_id='62ba5a3cd01c7e001fb45c46', 
        cancel_id=str(uuid.uuid4()),
        cancel_username='test', 
        cancel_message='test결제 취소'
    )
if 'error_code' not in response:
    # 요청 성공 
    print(response)
```

## 4. 자동/빌링/정기 결제

## 4-1. 카드 빌링키 발급
REST API 방식으로 고객으로부터 카드 정보를 전달하여, PG사에게 빌링키를 발급받을 수 있습니다. 
발급받은 빌링키를 저장하고 있다가, 원하는 시점, 원하는 금액에 결제 승인 요청하여 좀 더 자유로운 결제시나리오에 적용이 가능합니다.
* 비인증 정기결제(REST API) 방식을 지원하는 PG사만 사용 가능합니다. 
```python 
response = bootpay.request_subscribe_billing_key(
        pg='나이스페이',
        order_name='테스트결제',
        subscription_id=str(time.time()),
        card_no="5570********1074", # 카드번호 
        card_pw="**", # 카드 비밀번호 2자리 
        card_identity_no="******", # 카드 소주 생년월일 
        card_expire_year="**", # 카드 유효기간 년 2자리 
        card_expire_month="**",  # 카드 유효기간 월 2자리 

    )
if 'error_code' not in response:
    # 요청 성공 
    print(response)
```


## 4-2. 계좌 빌링키 발급
REST API 방식으로 고객의 계좌 정보를 전달하여, PG사에게 빌링키 발급을 요청합니다. 요청 후 빌링키가 바로 발급되진 않고, 출금동의 확인 절차까지 진행해야 빌링키가 발급됩니다.
먼저 빌링키를 요청합니다.
```python 
response = bootpay.request_subscribe_automatic_transfer_billing_key(
        pg="나이스페이",
        order_name='테스트결제',
        subscription_id=str(time.time()),
        price=1000,
        username='홍길동',
        bank_name='국민',
        bank_account='67560123412342472',
        identity_no='901014',
        cash_receipt_identity_no='01012341234',
        phone='01012341234'
    )
```

이후 빌링키 발급 요청시 응답받은 receipt_id로, 출금 동의 확인을 요청합니다.
```python
response = bootpay.publish_automatic_transfer_billing_key(
    receipt_id="66542d4be86c1eedf6b17965",
)
```


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

```python 
response = bootpay.request_subscribe_card_payment(
        billing_key='62b2c3cfd01c7e001cc20a84',
        order_name='테스트결제',
        order_id=str(time.time()),
        price=100,
        user={
            "phone": '01000000000',
            "username": '홍길동',
            "email": 'test@bootpay.co.kr'
        }
    )
if 'error_code' not in response:
    # 요청 성공 
    print(response)
``` 
## 4-4. 결제 예약하기
원하는 시점에 4-1로 결제 승인 요청을 보내도 되지만, 빌링키 발급 이후에 바로 결제 예약 할 수 있습니다. (빌링키당 최대 10건)
```python 
response = bootpay.subscribe_payment_reserve(
        billing_key='[ 빌링키 ]',
        order_name='테스트결제',
        order_id=str(time.time()),
        price=1000,
        user={
            "phone": '01000000000',
            "username": '홍길동',
            "email": 'test@bootpay.co.kr'
        },
        reserve_execute_at=(datetime.datetime.now() + datetime.timedelta(seconds=5)).astimezone().strftime(
            '%Y-%m-%dT%H:%M:%S%z')
    )
if 'error_code' not in response:
    # 요청 성공 
    print(response)
```

## 4-5. 예약 조회하기
예약시 응답받은 reserveId로 예약된 건을 조회합니다.
```python
response = bootpay.subscribe_payment_reserve_lookup('6490149ca575b40024f0b70d')
print(response)
```

## 4-6. 예약 취소하기
예약시 응답받은 reserveId로 예약된 건을 취소합니다.
```python
result = bootpay.cancel_subscribe_reserve(
        '612debc70d681b0039e6133d'
    )
if 'error_code' not in response:
    # 요청 성공 
    print(response)
```

## 4-7. 빌링키 삭제하기
발급된 빌링키를 삭제합니다. 삭제하더라도 예약된 결제건은 취소되지 않습니다. 예약된 결제건 취소를 원하시면 예약 취소하기를 요청하셔야 합니다. 
```python 
response = bootpay.destroy_billing_key(
        billing_key='62b2c3cfd01c7e001cc20a85',
)
if 'error_code' not in response:
    # 요청 성공 
    print(response)
```

## 4-8. 빌링키 조회하기
클라이언트에서 빌링키 발급시, 보안상 클라이언트 이벤트에 빌링키를 전달해주지 않습니다. 그러므로 이 API를 통해 조회해야 합니다.
다음은 빌링키 발급 요청했던 receiptId 로 빌링키를 조회합니다.
```python 
response = bootpay.lookup_subscribe_billing_key('62b2c3c2d01c7e001bc20b10')
if 'error_code' not in response:
    # 요청 성공 
    print(response)
```
아래는 billingKey로 조회합니다.
```python 
response = bootpay.lookup_billing_key('66542dfb4d18d5fc7b43e1b6')
print(response)
```

## 5. 회원 토큰 발급요청
ㅇㅇ페이 사용을 위해 가맹점 회원의 토큰을 발급합니다. 가맹점은 회원의 고유번호를 관리해야합니다.
이 토큰값을 기반으로 클라이언트에서 결제요청(payload.user_token) 하시면 되겠습니다.
```python 
result = bootpay.request_user_token({
        'user_id': '12341-234',
        'email': 'test@email.com',
        'name': '홍길동',
        'gender': '1',
        'birth': '901014',
        'phone': '01012341234'
    })
if 'error_code' not in token: 
    # 요청 성공 
    print(response)
``` 

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

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

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

```python 
result = bootpay.confirm_payment(
    receipt_id='612df0250d681b001de61de6'
)
if 'error_code' not in token: 
    # 요청 성공 
    print(response)
```

## 7. 본인 인증 결과 조회 
다날 본인인증 후 결과값을 조회합니다. 
다날 본인인증에서 통신사, 외국인여부, 전화번호 이 3가지 정보는 다날에 추가로 요청하셔야 받으실 수 있습니다.
```python 
result = bootpay.certificate(
        receipt_id='612df0250d681b001de61de6'
)
if 'error_code' not in token: 
    # 요청 성공 
    print(response)
```


8. (에스크로 이용시) PG사로 배송정보 보내기
현금 거래에 한해 구매자의 안전거래를 보장하는 방법으로, 판매자와 구매자의 온라인 전자상거래가 원활하게 이루어질 수 있도록 중계해주는 매매보호서비스입니다. 국내법에 따라 전자상거래에서 반드시 적용이 되어 있어야합니다. PG에서도 에스크로 결제를 지원하며, 에스크로 결제 사용을 원하시면 PG사 가맹시에 에스크로결제를 미리 얘기하고나서 진행을 하시는 것이 수월합니다.

PG사로 배송정보( 이니시스, KCP만 지원 )를 보내서 에스크로 상태를 변경하는 API 입니다.
```python 
response = bootpay.shipping_start(
        receipt_id="62a946aad01c7e001b7dc20b",
        tracking_number='3989838',
        delivery_corp='CJ대한통운',
        user={
            "phone": '01000000000',
            "username": '홍길동',
            "address": "서울특별시 종로구",
            "zipcode": "039899"
        }
)
if 'error_code' not in token: 
    # 요청 성공 
    print(response)
```

## 9-1. 현금영수증 발행하기 
bootpay api를 통해 결제된 건에 대하여 현금영수증을 발행합니다. 

```python 
response = bootpay.cash_receipt_publish_on_receipt(
        receipt_id='62e0f11f1fc192036b1b3c92',
        username='테스트',
        email='test@bootpay.co.kr',
        phone='01000000000',
        identity_no='01000000000',
        cash_receipt_type='소득공제'
    )
if 'error_code' not in token:
   # 요청 성공
   print(response)
```


## 9-2. 현금영수증 발행 취소 
9-1을 통해 발행한 현금영수증을 취소합니다. 
```python 
response = bootpay.cash_receipt_cancel_on_receipt(
        receipt_id='62e0f11f1fc192036b1b3c92',
    )
if 'error_code' not in token:
   # 요청 성공
   print(response)
```

## 9-3. (별건) 현금영수증 발행
부트페이 결제와 상관없이 금액, 상품명, 현금영수증 발행정보 등을 보내 현금영수증을 발행하는 API 입니다 
```python 
 response = bootpay.request_cash_receipt(
        pg='토스',
        price=1000,
        order_name='테스트',
        cash_receipt_type='소득공제',
        user={
            "username": '부트페이',
            "phone": '01000000000',
            "email": "bootpay@bootpay.co.kr"
        },
        identity_no='01000000000',
        purchased_at=datetime.datetime.now().astimezone().strftime(
            '%Y-%m-%dT%H:%M:%S%z'),
        order_id=str(time.time())
    )
if 'error_code' not in token:
   # 요청 성공
   print(response)
```

## 9-4. (별건) 현금영수증 발행 취소 
9-3을 통해 발행한 현금영수증을 취소합니다.
```python 
response = bootpay.cancel_cash_receipt(
        receipt_id='62f20fc21fc192036b4f6f89',
        cancel_username='시스템',
        cancel_message='테스트'
    )
if 'error_code' not in token:
   # 요청 성공
   print(response)
```

## Example 프로젝트

[적용한 샘플 프로젝트](https://github.com/bootpay/backend-python-example)을 참조해주세요

## Documentation

[부트페이 개발매뉴얼](https://developer.bootpay.co.kr/)을 참조해주세요

## 기술문의

[부트페이 홈페이지](https://www.bootpay.co.kr) 우측 하단 채팅을 통해 기술문의 주세요!

## License

[MIT License](https://opensource.org/licenses/MIT).