bootpay-backend 2.8.1__tar.gz → 2.10.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (78) hide show
  1. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/PKG-INFO +86 -1
  2. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/README.md +85 -0
  3. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/__init__.py +45 -1
  4. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/commerce_resource.py +27 -1
  5. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/__init__.py +14 -0
  6. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/alimtalk_message.py +4 -4
  7. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/alimtalk_official.py +4 -4
  8. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/alimtalk_optout.py +5 -5
  9. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/alimtalk_send.py +11 -4
  10. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/alimtalk_sender.py +8 -8
  11. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/alimtalk_template.py +11 -11
  12. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/alimtalk_webhook.py +7 -6
  13. bootpay_backend-2.10.0/bootpay_backend/commerce/modules/deposit.py +107 -0
  14. bootpay_backend-2.10.0/bootpay_backend/commerce/modules/faq.py +141 -0
  15. bootpay_backend-2.10.0/bootpay_backend/commerce/modules/inquiry.py +192 -0
  16. bootpay_backend-2.10.0/bootpay_backend/commerce/modules/notice.py +146 -0
  17. bootpay_backend-2.10.0/bootpay_backend/commerce/modules/payout.py +52 -0
  18. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/product.py +8 -7
  19. bootpay_backend-2.10.0/bootpay_backend/commerce/modules/product_qna.py +216 -0
  20. bootpay_backend-2.10.0/bootpay_backend/commerce/modules/product_review.py +204 -0
  21. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/types/__init__.py +163 -19
  22. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/rest_client.py +1 -1
  23. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend.egg-info/PKG-INFO +86 -1
  24. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend.egg-info/SOURCES.txt +10 -0
  25. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/setup.py +1 -1
  26. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/commerce/test_alimtalk.py +160 -46
  27. bootpay_backend-2.10.0/tests/commerce/test_board.py +464 -0
  28. bootpay_backend-2.10.0/tests/commerce/test_deposit.py +150 -0
  29. bootpay_backend-2.10.0/tests/commerce/test_payout.py +179 -0
  30. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/commerce/test_wire_format.py +16 -6
  31. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/LICENSE +0 -0
  32. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/__init__.py +0 -0
  33. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/bankcode.py +0 -0
  34. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/cart.py +0 -0
  35. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/category.py +0 -0
  36. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/coupon.py +0 -0
  37. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/invoice.py +0 -0
  38. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/mall_setting.py +0 -0
  39. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/order.py +0 -0
  40. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/order_cancel.py +0 -0
  41. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/order_subscription.py +0 -0
  42. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/order_subscription_adjustment.py +0 -0
  43. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/order_subscription_bill.py +0 -0
  44. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/order_subscription_request.py +0 -0
  45. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/point.py +0 -0
  46. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/store.py +0 -0
  47. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/user.py +0 -0
  48. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/user_group.py +0 -0
  49. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend/commerce/modules/webhook.py +0 -0
  50. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend.egg-info/dependency_links.txt +0 -0
  51. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend.egg-info/not-zip-safe +0 -0
  52. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend.egg-info/requires.txt +0 -0
  53. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/bootpay_backend.egg-info/top_level.txt +0 -0
  54. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/setup.cfg +0 -0
  55. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/__init__.py +0 -0
  56. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/commerce/__init__.py +0 -0
  57. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/commerce/test_auth_contract.py +0 -0
  58. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/commerce/test_mall_setting.py +0 -0
  59. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/commerce/test_order.py +0 -0
  60. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/commerce/test_order_subscription_charge.py +0 -0
  61. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/commerce/test_product.py +0 -0
  62. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/commerce/test_product_mall.py +0 -0
  63. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/commerce/test_store.py +0 -0
  64. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/commerce/test_token.py +0 -0
  65. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/commerce/test_user.py +0 -0
  66. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/commerce/test_user_mall.py +0 -0
  67. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/commerce/test_webhook.py +0 -0
  68. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/conftest.py +0 -0
  69. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/pg/__init__.py +0 -0
  70. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/pg/test_auth.py +0 -0
  71. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/pg/test_billing.py +0 -0
  72. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/pg/test_cash_receipt.py +0 -0
  73. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/pg/test_cash_receipt_wire_format.py +0 -0
  74. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/pg/test_legacy_compatibility.py +0 -0
  75. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/pg/test_payment.py +0 -0
  76. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/pg/test_sequential_billing_key.py +0 -0
  77. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/pg/test_token.py +0 -0
  78. {bootpay_backend-2.8.1 → bootpay_backend-2.10.0}/tests/pg/test_wallet.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: bootpay_backend
3
- Version: 2.8.1
3
+ Version: 2.10.0
4
4
  Summary: bootpay server side plugin for python
5
5
  Home-page: https://github.com/bootpay/backend-python/tree/2-x-development
6
6
  Author: bootpay <bootpay.co.kr@gmail.com>
@@ -69,6 +69,8 @@ Python 언어로 작성된 어플리케이션, 프레임워크 등에서 사용
69
69
  - [9-2. 현금영수증 발행 취소](#9-2-현금영수증-발행-취소)
70
70
  - [9-3. 별건 현금영수증 발행](#9-3-별건-현금영수증-발행)
71
71
  - [9-4. 별건 현금영수증 발행 취소](#9-4-별건-현금영수증-발행-취소)
72
+ - [10. 뱅크알람 입금대기](#10-뱅크알람-입금대기-무통장-입금-자동-확인)
73
+ - [11. 입점사 지급 요청](#11-입점사-지급-요청)
72
74
  - [Example 프로젝트](#example-프로젝트)
73
75
  - [Documentation](#documentation)
74
76
  - [기술문의](#기술문의)
@@ -440,6 +442,89 @@ if 'error_code' not in token:
440
442
  print(response)
441
443
  ```
442
444
 
445
+ ## 10. 뱅크알람 입금대기 (무통장 입금 자동 확인)
446
+
447
+ 가맹점 서버가 아직 입금되지 않은 주문을 등록하면, 판매자 폰의 입금 알림 중 **금액 · 입금자명**이 맞는 것을
448
+ 뱅크알람이 그 주문에 연결해 입금을 확인하고 입금 웹훅으로 알립니다.
449
+ 전부 supervisor 전용이며, 인스턴스 role 과 무관하게 `BOOTPAY-ROLE: supervisor` 로 나갑니다.
450
+
451
+ ```python
452
+ import os
453
+
454
+ from bootpay_backend.commerce import BootpayCommerce
455
+
456
+ commerce = BootpayCommerce(
457
+ client_key=os.getenv('BOOTPAY_COMMERCE_CLIENT_KEY_PROD'),
458
+ secret_key=os.getenv('BOOTPAY_COMMERCE_SECRET_KEY_PROD')
459
+ )
460
+ commerce.get_access_token()
461
+
462
+ # 판매자 입금 계좌 목록 — 첫 계좌가 대표 계좌(primary: true)
463
+ accounts = commerce.deposit.accounts()['accounts']
464
+
465
+ # 웹훅 서명 비밀값 발급 — ⚠️ 원문은 이 응답에서만 받습니다. 다시 부르면 바뀝니다
466
+ secret = commerce.deposit.webhook_secret()['secret']
467
+
468
+ # 입금대기 등록 — 같은 merchant_order_id 로 같은 금액·입금자명·계좌를 다시 보내면 기존 주문을 돌려줍니다
469
+ # (하나라도 다르면 18110 BANK_DEPOSIT_MERCHANT_ID_CONFLICT)
470
+ commerce.deposit.create({
471
+ 'merchant_order_id': 'ORDER_1234',
472
+ 'price': 15000,
473
+ 'depositor': '홍길동', # 은행 입금 알림과 맞춰 볼 이름
474
+ 'order_name': '티셔츠 외 1건', # 미지정시 '무통장 입금'
475
+ 'memo': '관리자 메모',
476
+ 'buyer_name': '홍길동', # 미지정시 입금자명
477
+ 'buyer_email': 'buyer@example.com', # 주면 입금 안내 · 확인 메일 (무료)
478
+ 'account_id': accounts[0]['id'], # 미지정시 대표 계좌
479
+ 'webhook_url': 'https://example.com/hooks/deposit', # 비밀값을 먼저 발급받아야 합니다(18131)
480
+ # 구매자 알림톡 (유료) — buyer_phone 필수, link 는 https
481
+ # 'notify': {'deposit_guide': True, 'deposit_paid': True, 'link': 'https://example.com/orders/ORDER_1234'},
482
+ })
483
+
484
+ # 조회 · 취소 — 가맹점 주문번호 또는 부트페이 주문번호
485
+ commerce.deposit.detail('ORDER_1234') # status: awaiting · paid · expired · cancelled
486
+ commerce.deposit.cancel('ORDER_1234') # 이미 닫힌 주문은 그대로 돌려줍니다
487
+ ```
488
+
489
+ `webhook_secret(idempotency_key=None)` · `cancel(id, idempotency_key=None)` 은 멱등 키 선택 인자를 받고,
490
+ `create(params)` 는 `params['idempotency_key']` 로 받습니다. 미지정시 호출할 때마다 새 UUID 를 사용합니다.
491
+
492
+ > 입금 웹훅은 `X-Bootpay-Signature: sha256=HMAC_SHA256(secret, "{X-Bootpay-Timestamp}.{raw_body}")` 로 서명됩니다.
493
+ > 이벤트 코드는 `BANK_DEPOSIT_WEBHOOK_EVENT_*` 상수(400~407)를 참고하세요.
494
+
495
+ ## 11. 입점사 지급 요청
496
+
497
+ 가맹점 지정 금액(`manual`) 정산 방식에서 입점사와 지급액을 정해 지급 원장에 등록합니다.
498
+ 실제 송금은 별도 배치가 처리하며, 세 API 모두 인스턴스 role과 무관하게 `BOOTPAY-ROLE: supervisor`로 나갑니다.
499
+
500
+ ```python
501
+ from bootpay_backend.commerce import BootpayCommerce
502
+
503
+ commerce = BootpayCommerce(client_key='CLIENT_KEY', secret_key='SECRET_KEY')
504
+
505
+ # 등록 — 같은 merchant_payout_id 재호출은 처음 생성한 항목을 돌려줍니다
506
+ commerce.payout.create({
507
+ 'sub_seller_id': 'SUB_SELLER_ID',
508
+ 'amount': 150000,
509
+ 'merchant_payout_id': 'PAYOUT_20261112_001',
510
+ 'order_number': 'ORDER_1234', # 선택
511
+ 'payout_date': '2026-11-20', # 선택, YYYY-MM-DD
512
+ })
513
+
514
+ # merchant_payout_id 또는 지급 항목 id로 조회
515
+ commerce.payout.detail('PAYOUT_20261112_001')
516
+
517
+ # 목록은 전체 개수 래퍼 없는 지급 항목 배열입니다
518
+ commerce.payout.list({
519
+ 'status': 'ready', 'sub_seller_id': 'SUB_SELLER_ID',
520
+ 'from': '2026-11-01', 'to': '2026-11-30', 'page': 1, 'limit': 20,
521
+ })
522
+ ```
523
+
524
+ `status`는 `ready` · `held` · `sending` · `requested` · `processing` · `succeeded` · `failed` ·
525
+ `cancelled` · `unknown` · `void` 중 하나입니다. 세 메서드 모두 명시적 `idempotency_key`를 받을 수 있고,
526
+ 미지정하면 호출마다 새 UUID를 사용합니다.
527
+
443
528
  ## Example 프로젝트
444
529
 
445
530
  [적용한 샘플 프로젝트](https://github.com/bootpay/backend-python-example)을 참조해주세요
@@ -29,6 +29,8 @@ Python 언어로 작성된 어플리케이션, 프레임워크 등에서 사용
29
29
  - [9-2. 현금영수증 발행 취소](#9-2-현금영수증-발행-취소)
30
30
  - [9-3. 별건 현금영수증 발행](#9-3-별건-현금영수증-발행)
31
31
  - [9-4. 별건 현금영수증 발행 취소](#9-4-별건-현금영수증-발행-취소)
32
+ - [10. 뱅크알람 입금대기](#10-뱅크알람-입금대기-무통장-입금-자동-확인)
33
+ - [11. 입점사 지급 요청](#11-입점사-지급-요청)
32
34
  - [Example 프로젝트](#example-프로젝트)
33
35
  - [Documentation](#documentation)
34
36
  - [기술문의](#기술문의)
@@ -400,6 +402,89 @@ if 'error_code' not in token:
400
402
  print(response)
401
403
  ```
402
404
 
405
+ ## 10. 뱅크알람 입금대기 (무통장 입금 자동 확인)
406
+
407
+ 가맹점 서버가 아직 입금되지 않은 주문을 등록하면, 판매자 폰의 입금 알림 중 **금액 · 입금자명**이 맞는 것을
408
+ 뱅크알람이 그 주문에 연결해 입금을 확인하고 입금 웹훅으로 알립니다.
409
+ 전부 supervisor 전용이며, 인스턴스 role 과 무관하게 `BOOTPAY-ROLE: supervisor` 로 나갑니다.
410
+
411
+ ```python
412
+ import os
413
+
414
+ from bootpay_backend.commerce import BootpayCommerce
415
+
416
+ commerce = BootpayCommerce(
417
+ client_key=os.getenv('BOOTPAY_COMMERCE_CLIENT_KEY_PROD'),
418
+ secret_key=os.getenv('BOOTPAY_COMMERCE_SECRET_KEY_PROD')
419
+ )
420
+ commerce.get_access_token()
421
+
422
+ # 판매자 입금 계좌 목록 — 첫 계좌가 대표 계좌(primary: true)
423
+ accounts = commerce.deposit.accounts()['accounts']
424
+
425
+ # 웹훅 서명 비밀값 발급 — ⚠️ 원문은 이 응답에서만 받습니다. 다시 부르면 바뀝니다
426
+ secret = commerce.deposit.webhook_secret()['secret']
427
+
428
+ # 입금대기 등록 — 같은 merchant_order_id 로 같은 금액·입금자명·계좌를 다시 보내면 기존 주문을 돌려줍니다
429
+ # (하나라도 다르면 18110 BANK_DEPOSIT_MERCHANT_ID_CONFLICT)
430
+ commerce.deposit.create({
431
+ 'merchant_order_id': 'ORDER_1234',
432
+ 'price': 15000,
433
+ 'depositor': '홍길동', # 은행 입금 알림과 맞춰 볼 이름
434
+ 'order_name': '티셔츠 외 1건', # 미지정시 '무통장 입금'
435
+ 'memo': '관리자 메모',
436
+ 'buyer_name': '홍길동', # 미지정시 입금자명
437
+ 'buyer_email': 'buyer@example.com', # 주면 입금 안내 · 확인 메일 (무료)
438
+ 'account_id': accounts[0]['id'], # 미지정시 대표 계좌
439
+ 'webhook_url': 'https://example.com/hooks/deposit', # 비밀값을 먼저 발급받아야 합니다(18131)
440
+ # 구매자 알림톡 (유료) — buyer_phone 필수, link 는 https
441
+ # 'notify': {'deposit_guide': True, 'deposit_paid': True, 'link': 'https://example.com/orders/ORDER_1234'},
442
+ })
443
+
444
+ # 조회 · 취소 — 가맹점 주문번호 또는 부트페이 주문번호
445
+ commerce.deposit.detail('ORDER_1234') # status: awaiting · paid · expired · cancelled
446
+ commerce.deposit.cancel('ORDER_1234') # 이미 닫힌 주문은 그대로 돌려줍니다
447
+ ```
448
+
449
+ `webhook_secret(idempotency_key=None)` · `cancel(id, idempotency_key=None)` 은 멱등 키 선택 인자를 받고,
450
+ `create(params)` 는 `params['idempotency_key']` 로 받습니다. 미지정시 호출할 때마다 새 UUID 를 사용합니다.
451
+
452
+ > 입금 웹훅은 `X-Bootpay-Signature: sha256=HMAC_SHA256(secret, "{X-Bootpay-Timestamp}.{raw_body}")` 로 서명됩니다.
453
+ > 이벤트 코드는 `BANK_DEPOSIT_WEBHOOK_EVENT_*` 상수(400~407)를 참고하세요.
454
+
455
+ ## 11. 입점사 지급 요청
456
+
457
+ 가맹점 지정 금액(`manual`) 정산 방식에서 입점사와 지급액을 정해 지급 원장에 등록합니다.
458
+ 실제 송금은 별도 배치가 처리하며, 세 API 모두 인스턴스 role과 무관하게 `BOOTPAY-ROLE: supervisor`로 나갑니다.
459
+
460
+ ```python
461
+ from bootpay_backend.commerce import BootpayCommerce
462
+
463
+ commerce = BootpayCommerce(client_key='CLIENT_KEY', secret_key='SECRET_KEY')
464
+
465
+ # 등록 — 같은 merchant_payout_id 재호출은 처음 생성한 항목을 돌려줍니다
466
+ commerce.payout.create({
467
+ 'sub_seller_id': 'SUB_SELLER_ID',
468
+ 'amount': 150000,
469
+ 'merchant_payout_id': 'PAYOUT_20261112_001',
470
+ 'order_number': 'ORDER_1234', # 선택
471
+ 'payout_date': '2026-11-20', # 선택, YYYY-MM-DD
472
+ })
473
+
474
+ # merchant_payout_id 또는 지급 항목 id로 조회
475
+ commerce.payout.detail('PAYOUT_20261112_001')
476
+
477
+ # 목록은 전체 개수 래퍼 없는 지급 항목 배열입니다
478
+ commerce.payout.list({
479
+ 'status': 'ready', 'sub_seller_id': 'SUB_SELLER_ID',
480
+ 'from': '2026-11-01', 'to': '2026-11-30', 'page': 1, 'limit': 20,
481
+ })
482
+ ```
483
+
484
+ `status`는 `ready` · `held` · `sending` · `requested` · `processing` · `succeeded` · `failed` ·
485
+ `cancelled` · `unknown` · `void` 중 하나입니다. 세 메서드 모두 명시적 `idempotency_key`를 받을 수 있고,
486
+ 미지정하면 호출마다 새 UUID를 사용합니다.
487
+
403
488
  ## Example 프로젝트
404
489
 
405
490
  [적용한 샘플 프로젝트](https://github.com/bootpay/backend-python-example)을 참조해주세요
@@ -18,6 +18,13 @@ from .modules import (
18
18
  OrderSubscriptionRequestModule,
19
19
  MallSettingModule,
20
20
  WebhookModule,
21
+ DepositModule,
22
+ PayoutModule,
23
+ FaqModule,
24
+ NoticeModule,
25
+ InquiryModule,
26
+ ProductQnaModule,
27
+ ProductReviewModule,
21
28
  AlimtalkMessageModule,
22
29
  AlimtalkOfficialModule,
23
30
  AlimtalkOptoutModule,
@@ -87,7 +94,15 @@ class BootpayCommerce(BootpayCommerceResource):
87
94
  self.order_subscription_request = OrderSubscriptionRequestModule(self)
88
95
  self.mall_setting = MallSettingModule(self)
89
96
  self.webhook = WebhookModule(self)
90
- # 알림톡 (v1 /alimtalk 계열) — 주문·구독 웹훅과 별개다
97
+ self.deposit = DepositModule(self)
98
+ self.payout = PayoutModule(self)
99
+ # 게시판 계열 (FAQ·공지사항·1:1문의·상품문의·상품평)
100
+ self.faq = FaqModule(self)
101
+ self.notice = NoticeModule(self)
102
+ self.inquiry = InquiryModule(self)
103
+ self.product_qna = ProductQnaModule(self)
104
+ self.product_review = ProductReviewModule(self)
105
+ # 알림톡 (/alimtalk 계열 — 메시지 API 호스트) — 주문·구독 웹훅과 별개다
91
106
  self.alimtalk_message = AlimtalkMessageModule(self)
92
107
  self.alimtalk_official = AlimtalkOfficialModule(self)
93
108
  self.alimtalk_optout = AlimtalkOptoutModule(self)
@@ -227,6 +242,13 @@ __all__ = [
227
242
  'OrderSubscriptionRequestModule',
228
243
  'MallSettingModule',
229
244
  'WebhookModule',
245
+ 'DepositModule',
246
+ 'PayoutModule',
247
+ 'FaqModule',
248
+ 'NoticeModule',
249
+ 'InquiryModule',
250
+ 'ProductQnaModule',
251
+ 'ProductReviewModule',
230
252
  'AlimtalkMessageModule',
231
253
  'AlimtalkOfficialModule',
232
254
  'AlimtalkOptoutModule',
@@ -331,6 +353,28 @@ __all__ = [
331
353
  'MallSettingUpdateParams',
332
354
  'CommerceMallSetting',
333
355
  'SendTestWebhookParams',
356
+ # Deposit Types
357
+ 'DepositAccount',
358
+ 'DepositAccountsResponse',
359
+ 'DepositWebhookSecretResponse',
360
+ 'DepositNotifyParams',
361
+ 'DepositCreateParams',
362
+ 'DepositNotice',
363
+ 'DepositNotify',
364
+ 'CommerceDeposit',
365
+ 'BANK_DEPOSIT_WEBHOOK_EVENT_RECEIVED',
366
+ 'BANK_DEPOSIT_WEBHOOK_EVENT_MATCHED',
367
+ 'BANK_DEPOSIT_WEBHOOK_EVENT_AMBIGUOUS',
368
+ 'BANK_DEPOSIT_WEBHOOK_EVENT_UNMATCHED',
369
+ 'BANK_DEPOSIT_WEBHOOK_EVENT_CONFIRMED_MANUALLY',
370
+ 'BANK_DEPOSIT_WEBHOOK_EVENT_EXPIRED',
371
+ 'BANK_DEPOSIT_WEBHOOK_EVENT_CANCELLED',
372
+ 'BANK_DEPOSIT_WEBHOOK_EVENT_REVERTED',
373
+ # Payout Types
374
+ 'PayoutStatus',
375
+ 'PayoutCreateParams',
376
+ 'PayoutListParams',
377
+ 'CommercePayout',
334
378
  # Alimtalk Types
335
379
  'ALIMTALK_WEBHOOK_EVENT_SEND_REQUESTED',
336
380
  'ALIMTALK_WEBHOOK_EVENT_SEND_SUCCESS',
@@ -13,6 +13,13 @@ class BootpayCommerceResource:
13
13
  'stage': 'https://stage-api.bootapi.com/v1',
14
14
  'production': 'https://api.bootapi.com/v1'
15
15
  }
16
+ # 알림톡 API 전용 — 메시지 API 가 직접 받는다(경로에 /v1 없음). _api_base_url 이 고른다.
17
+ # @date: 26-09-18
18
+ MESSAGE_API_ENTRYPOINTS = {
19
+ 'development': 'https://dev-m.bootapi.com',
20
+ 'stage': 'https://stage-m.bootapi.com',
21
+ 'production': 'https://message.bootapi.com'
22
+ }
16
23
  API_VERSION = '1.0.0'
17
24
  SDK_VERSION = '1.0.0'
18
25
 
@@ -23,6 +30,7 @@ class BootpayCommerceResource:
23
30
  self.client_key: Optional[str] = None
24
31
  self.secret_key: Optional[str] = None
25
32
  self.timeout = 60
33
+ self._message_api_url: Optional[str] = None
26
34
 
27
35
  def set_configuration(self, client_key: str, secret_key: str, mode: str = 'production'):
28
36
  """
@@ -64,9 +72,27 @@ class BootpayCommerceResource:
64
72
  encoded = base64.b64encode(credentials.encode()).decode()
65
73
  return f'Basic {encoded}'
66
74
 
75
+ def set_message_api_url(self, url: str):
76
+ """
77
+ 알림톡(메시지 API) URL 을 변경한다.
78
+ @date: 26-09-18
79
+ """
80
+ self._message_api_url = url
81
+
82
+ def _api_base_url(self, url: str) -> str:
83
+ """
84
+ 요청 경로에 맞는 API 기본 주소.
85
+ 알림톡 API 는 26-09-18 부터 커머스 API(api.bootapi.com/v1)가 아니라 메시지 API(message.bootapi.com, /v1 없음)가 받는다.
86
+ 경로·파라미터·응답은 그대로이고 호스트만 다르다 — 그래서 알림톡 모듈은 고치지 않고 여기서 주소만 가른다.
87
+ 옛 주소(/v1/alimtalk/*)는 410 으로 응답한다.
88
+ """
89
+ if url.lstrip('/').startswith('alimtalk'):
90
+ return self._message_api_url or self.MESSAGE_API_ENTRYPOINTS[self.mode]
91
+ return self.API_ENTRYPOINTS[self.mode]
92
+
67
93
  def _entrypoints(self, url: str) -> str:
68
94
  """엔트리포인트 URL 생성"""
69
- return '/'.join([self.API_ENTRYPOINTS[self.mode], url])
95
+ return '/'.join([self._api_base_url(url), url])
70
96
 
71
97
  def _get_headers(self, include_auth: bool = True, headers: Optional[Dict[str, str]] = None) -> Dict[str, str]:
72
98
  """
@@ -16,6 +16,13 @@ from .cart import CartModule
16
16
  from .order_subscription_request import OrderSubscriptionRequestModule
17
17
  from .mall_setting import MallSettingModule
18
18
  from .webhook import WebhookModule
19
+ from .deposit import DepositModule
20
+ from .payout import PayoutModule
21
+ from .faq import FaqModule
22
+ from .notice import NoticeModule
23
+ from .inquiry import InquiryModule
24
+ from .product_qna import ProductQnaModule
25
+ from .product_review import ProductReviewModule
19
26
  from .alimtalk_message import AlimtalkMessageModule
20
27
  from .alimtalk_official import AlimtalkOfficialModule
21
28
  from .alimtalk_optout import AlimtalkOptoutModule
@@ -42,6 +49,13 @@ __all__ = [
42
49
  'OrderSubscriptionRequestModule',
43
50
  'MallSettingModule',
44
51
  'WebhookModule',
52
+ 'DepositModule',
53
+ 'PayoutModule',
54
+ 'FaqModule',
55
+ 'NoticeModule',
56
+ 'InquiryModule',
57
+ 'ProductQnaModule',
58
+ 'ProductReviewModule',
45
59
  'AlimtalkMessageModule',
46
60
  'AlimtalkOfficialModule',
47
61
  'AlimtalkOptoutModule',
@@ -12,7 +12,7 @@ from ..types import (
12
12
 
13
13
  class AlimtalkMessageModule:
14
14
  """
15
- 알림톡 발송내역·집계 모듈 (GET /v1/alimtalk/messages 계열)
15
+ 알림톡 발송내역·집계 모듈 (GET /alimtalk/messages 계열)
16
16
 
17
17
  **유료** 알림톡만 조회된다 (무료 커머스 알림톡은 포함되지 않는다).
18
18
  상태는 벤더 결과 동기화로 확정되므로 접수 직후에는 requested 로 보인다.
@@ -24,7 +24,7 @@ class AlimtalkMessageModule:
24
24
  def list(self, params: Optional[AlimtalkMessageListParams] = None):
25
25
  """
26
26
  발송내역 목록 조회
27
- GET /v1/alimtalk/messages
27
+ GET /alimtalk/messages
28
28
  ⚠️ 기간 기본값은 최근 30일이고 최대 조회 폭은 92일이다 — 초과분은 거부하지 않고 시작일을 당겨 잘라낸다.
29
29
  실제 적용된 구간은 응답의 period 로 확인한다.
30
30
  :param params: 조회 파라미터 (status: requested·success·failed·canceled)
@@ -39,7 +39,7 @@ class AlimtalkMessageModule:
39
39
  def stats(self, params: Optional[AlimtalkMessageStatsParams] = None):
40
40
  """
41
41
  기간 집계 조회
42
- GET /v1/alimtalk/messages/stats
42
+ GET /alimtalk/messages/stats
43
43
  일자별 집계 원장에서 읽으므로 응답이 빠르다.
44
44
  ⚠️ billing.unit_price_source 가 'default' 면 **잠정 단가**다 (확정 청구액이 아니다).
45
45
  ⚠️ billable_count 는 성공 − 폴백이다 — 폴백분은 LMS 단가로 따로 계산된다.
@@ -55,7 +55,7 @@ class AlimtalkMessageModule:
55
55
  def detail(self, receipt_id: str):
56
56
  """
57
57
  단건 발송 결과 조회
58
- GET /v1/alimtalk/messages/{receipt_id}
58
+ GET /alimtalk/messages/{receipt_id}
59
59
  실패 사유는 error_code·error_message 에 담긴다.
60
60
  fallback_type 은 폴백이 꺼진 건이면 None, 켜진 건이면 LMS 다.
61
61
  다른 프로젝트의 건이거나 없으면 404(3025).
@@ -12,7 +12,7 @@ from ..types import (
12
12
 
13
13
  class AlimtalkOfficialModule:
14
14
  """
15
- 부트페이 공식 알림톡 템플릿 카탈로그 모듈 (/v1/alimtalk/official 계열)
15
+ 부트페이 공식 알림톡 템플릿 카탈로그 모듈 (/alimtalk/official 계열)
16
16
 
17
17
  부트페이가 미리 카카오 승인을 받아 둔 템플릿이라, 그룹키가 등록된 채널이면 **검수 없이 즉시 발송**된다.
18
18
  `alimtalk_sender.create` 로 채널을 등록하면 그룹 등록이 함께 끝나므로 따로 채택할 것이 없다.
@@ -27,7 +27,7 @@ class AlimtalkOfficialModule:
27
27
  def list(self, params: Optional[AlimtalkOfficialListParams] = None):
28
28
  """
29
29
  공식 템플릿 검색
30
- GET /v1/alimtalk/official
30
+ GET /alimtalk/official
31
31
  keyword 는 본문·이름·분류를 부분일치(대소문자 무시)로 훑는다.
32
32
  ⚠️ 서버는 q 를 먼저 보고 없으면 keyword 를 본다 — 정본 키인 q 로 보낸다.
33
33
  :param params: 조회 파라미터 (msg_type 은 BA·EX 만 존재한다)
@@ -52,7 +52,7 @@ class AlimtalkOfficialModule:
52
52
  def recommend(self, params: AlimtalkOfficialRecommendParams):
53
53
  """
54
54
  보내려는 문구로 공식 템플릿을 추천받는다
55
- POST /v1/alimtalk/official/recommend
55
+ POST /alimtalk/official/recommend
56
56
  유사도 score(0~1) 내림차순으로 돌려준다.
57
57
  :param params: 추천 파라미터 (text 필수)
58
58
  :return: 추천 템플릿 목록
@@ -66,7 +66,7 @@ class AlimtalkOfficialModule:
66
66
  def detail(self, code: str, ksp_id: Optional[str] = None):
67
67
  """
68
68
  공식 템플릿 상세 조회
69
- GET /v1/alimtalk/official/{code}
69
+ GET /alimtalk/official/{code}
70
70
  :param code: 서버 채번 코드 (슬래시를 포함하지 않는다). 없거나 미노출이면 404(3015).
71
71
  :param ksp_id: 주면 그 채널의 변수 예문 사전으로 variable_examples 를 채워 준다 (표시용)
72
72
  :return: 공식 템플릿 상세
@@ -13,7 +13,7 @@ from ..types import (
13
13
 
14
14
  class AlimtalkOptoutModule:
15
15
  """
16
- 알림톡 수신거부 모듈 (/v1/alimtalk/optouts 계열, 가맹점 CRM 수신거부 동기화용)
16
+ 알림톡 수신거부 모듈 (/alimtalk/optouts 계열, 가맹점 CRM 수신거부 동기화용)
17
17
 
18
18
  발송 판정과 **같은 기준**으로 다룬다 — 부트페이 전역(global) + 내 프로젝트.
19
19
  ⚠️ 전역 건은 **조회는 되지만 해제할 수 없다** (releasable: False).
@@ -26,7 +26,7 @@ class AlimtalkOptoutModule:
26
26
  def list(self, params: Optional[AlimtalkOptoutListParams] = None):
27
27
  """
28
28
  수신거부 목록 조회
29
- GET /v1/alimtalk/optouts
29
+ GET /alimtalk/optouts
30
30
  phone 은 숫자만 남겨 **부분일치**로 찾는다 (정확 매칭이 아니다). 50건 단위로 페이징된다.
31
31
  :param params: 조회 파라미터
32
32
  :return: {'list': [{'id':, 'phone':, 'scope':, 'global':, 'releasable':, 'source':,
@@ -41,7 +41,7 @@ class AlimtalkOptoutModule:
41
41
  def create(self, params: AlimtalkOptoutCreateParams):
42
42
  """
43
43
  수신거부 등록
44
- POST /v1/alimtalk/optouts
44
+ POST /alimtalk/optouts
45
45
  내 프로젝트 스코프로 등록된다 (source: api). 같은 번호를 다시 등록해도 멱등이다.
46
46
  :param params: 등록 파라미터 (phone 필수)
47
47
  :return: 등록된 수신거부
@@ -55,7 +55,7 @@ class AlimtalkOptoutModule:
55
55
  def check(self, params: AlimtalkOptoutCheckParams):
56
56
  """
57
57
  발송 전 수신거부 사전 확인
58
- POST /v1/alimtalk/optouts/check
58
+ POST /alimtalk/optouts/check
59
59
  발송 판정과 **같은 축**으로 대조하므로, 벌크에서 skipped 로 낭비될 건을 미리 뺄 수 있다.
60
60
  단건(phone)·다건(phones) 모두 받는다.
61
61
  ⚠️ 1회 최대 1,000건이고 넘으면 -48 이다 (중복은 서버가 제거).
@@ -72,7 +72,7 @@ class AlimtalkOptoutModule:
72
72
  def release(self, phone: str):
73
73
  """
74
74
  수신거부 해제
75
- DELETE /v1/alimtalk/optouts/{phone}
75
+ DELETE /alimtalk/optouts/{phone}
76
76
  내 프로젝트 스코프 건만 해제되며 멱등이다 (없어도 성공).
77
77
  ⚠️ 전역 차단은 해제되지 않고 global_blocked: True 로 알려 준다 —
78
78
  "지웠는데 여전히 막히는" 상태를 응답으로 드러내기 위함이다.
@@ -11,7 +11,7 @@ from ..types import (
11
11
 
12
12
  class AlimtalkSendModule:
13
13
  """
14
- 알림톡 발송 모듈 (POST /v1/alimtalk/send · /send/bulk · DELETE /send/{receipt_id})
14
+ 알림톡 발송 모듈 (POST /alimtalk/send · /send/bulk · DELETE /send/{receipt_id})
15
15
 
16
16
  ⚠️ **실제로 카카오톡이 발송되고 과금된다. 샌드박스가 없다.**
17
17
 
@@ -32,11 +32,16 @@ class AlimtalkSendModule:
32
32
  def send(self, params: AlimtalkSendParams):
33
33
  """
34
34
  단건 발송
35
- POST /v1/alimtalk/send
35
+ POST /alimtalk/send
36
36
  ⚠️ 실제로 카카오톡이 발송되고 과금된다.
37
37
  fallback 은 알림톡 실패 시 문자(LMS) 대체발송 여부다.
38
38
  ⚠️ **미지정(None)과 False 는 다르다** — None 이면 프로젝트 기본값을 따르고, False 는 명시적으로 끈다.
39
39
  켜면 발신번호가 등록돼 있어야 하며 없으면 3030 으로 거부된다. 대체 문자에는 수신거부 링크가 자동 포함된다.
40
+ webhook_url 은 이 건의 결과 웹훅을 받을 주소다(26-09-21).
41
+ 주면 발송 성공·실패·문자 대체발송·예약취소 웹훅이 **이 주소로만** 간다(프로젝트 웹훅 설정은 쓰이지 않는다).
42
+ https 만 허용하며 2,000자를 넘으면 3028 로 거부된다. 서명은 프로젝트 시크릿으로 하고,
43
+ 시크릿만 필요하면 alimtalk_webhook.rotate_secret 으로 설정 없이 발급받을 수 있다.
44
+ ⚠️ 같은 ref_id 로 이미 접수·성공한 건을 다시 요청하면 기존 접수가 그대로 돌아와 새 주소는 무시된다.
40
45
  :param params: 발송 파라미터 (template_code · to 필수)
41
46
  :return: {'receipt_id':, 'ref_id':, 'to':, 'status':} — 접수 직후 status 는 requested
42
47
  """
@@ -49,13 +54,15 @@ class AlimtalkSendModule:
49
54
  def bulk(self, params: AlimtalkSendBulkParams):
50
55
  """
51
56
  벌크 발송 — 1요청 = N수신자
52
- POST /v1/alimtalk/send/bulk
57
+ POST /alimtalk/send/bulk
53
58
  recipients: [{'to': '01012345678', 'ref_id': 'bulk-0001', 'variables': {...}}, ...]
54
59
  ⚠️ 수신자 수만큼 실제 발송되고 과금된다.
55
60
  - 쿼터를 넘으면 요청 시점에 **전체 거부**된다(3022) — 일부만 나가지 않는다.
56
61
  - 개별 수신자의 실패는 건별 rejected 로 표시되고 나머지는 정상 발송된다.
57
62
  - 수신거부 번호는 skipped 이며 **과금되지 않고 발송 기록도 만들지 않는다**.
58
63
  - fallback 은 요청 단위로 한 번만 판정한다 — 발신번호가 없으면 요청 전체가 3030 으로 거부된다.
64
+ - webhook_url 도 요청 단위 하나다 — 이 요청으로 나간 모든 수신자 건의 결과 웹훅이 그 주소로 간다.
65
+ 형식이 틀리면(https 아님·2,000자 초과) 요청 전체가 3028 로 거부된다(26-09-21).
59
66
  :param params: 발송 파라미터 (template_code · recipients 필수)
60
67
  :return: {'count':, 'requested':, 'skipped':, 'rejected':, 'receipts': [...]}
61
68
  """
@@ -68,7 +75,7 @@ class AlimtalkSendModule:
68
75
  def cancel(self, receipt_id: str):
69
76
  """
70
77
  예약 발송 취소
71
- DELETE /v1/alimtalk/send/{receipt_id}
78
+ DELETE /alimtalk/send/{receipt_id}
72
79
  접수(READY) 상태의 예약 건만 취소할 수 있다 — 이미 전송에 들어갔으면 3023 이다.
73
80
  :param receipt_id: 발송 접수 ID
74
81
  :return: 취소 결과
@@ -12,7 +12,7 @@ from ..types import (
12
12
 
13
13
  class AlimtalkSenderModule:
14
14
  """
15
- 알림톡 발신프로필(카카오채널) 생명주기 모듈 (GET /v1/alimtalk/categories · /senders 계열)
15
+ 알림톡 발신프로필(카카오채널) 생명주기 모듈 (GET /alimtalk/categories · /senders 계열)
16
16
 
17
17
  카테고리 조회 → OTP 발송 → 발신프로필 등록 → 목록/상세 → 연동 해지 순으로 쓴다.
18
18
  등록이 끝나면 서버가 그룹키 등록까지 자동으로 하므로, 공식 템플릿은 별도 채택 없이 바로 발송된다.
@@ -27,7 +27,7 @@ class AlimtalkSenderModule:
27
27
  def categories(self):
28
28
  """
29
29
  카카오 카테고리 목록 조회
30
- GET /v1/alimtalk/categories
30
+ GET /alimtalk/categories
31
31
  발신프로필 등록 시 필요한 category_code 후보다. 벤더 응답을 그대로 프록시한다.
32
32
  :return: 카테고리 목록
33
33
  """
@@ -36,7 +36,7 @@ class AlimtalkSenderModule:
36
36
  def otp(self, params: AlimtalkSenderOtpParams):
37
37
  """
38
38
  채널 관리자폰으로 OTP 발송
39
- POST /v1/alimtalk/senders/otp
39
+ POST /alimtalk/senders/otp
40
40
  ⚠️ 실제로 문자가 나간다. 여기서 받은 인증번호를 `create` 의 otp 로 넘긴다.
41
41
  :param params: {'yellow_id': '@채널아이디', 'phone': '01012345678'}
42
42
  :return: 발송 결과
@@ -50,7 +50,7 @@ class AlimtalkSenderModule:
50
50
  def create(self, params: AlimtalkSenderCreateParams):
51
51
  """
52
52
  발신프로필 등록
53
- POST /v1/alimtalk/senders
53
+ POST /alimtalk/senders
54
54
  ⚠️ 카카오에 발신프로필이 실제 등록된다. 같은 yellow_id 를 다시 등록하면 기존 프로필을 재사용한다(dedup).
55
55
  등록 성공 시 그룹키 등록까지 서버가 수행하므로 공식 카탈로그 전체를 바로 발송할 수 있다.
56
56
  :param params: {'otp':, 'yellow_id':, 'phone':, 'category_code':}
@@ -65,7 +65,7 @@ class AlimtalkSenderModule:
65
65
  def list(self):
66
66
  """
67
67
  연동한 채널 목록 조회
68
- GET /v1/alimtalk/senders
68
+ GET /alimtalk/senders
69
69
  자체 DB 만 조회하며 벤더를 호출하지 않는다.
70
70
  :return: {'list': [...], 'count': int}
71
71
  """
@@ -74,7 +74,7 @@ class AlimtalkSenderModule:
74
74
  def detail(self, ksp_id: str, sync: Optional[bool] = None):
75
75
  """
76
76
  채널 상세 조회
77
- GET /v1/alimtalk/senders/{ksp_id}
77
+ GET /alimtalk/senders/{ksp_id}
78
78
  ⚠️ 미연동/미존재 채널은 404, 다른 프로젝트의 채널은 403 으로 오며 둘 다 error_code 는 3024 다.
79
79
  :param ksp_id: 채널 문서 ID
80
80
  :param sync: True 면 벤더에서 채널 상태를 다시 읽어 반영한다(느리다). 미지정이면 자체 DB 만 본다.
@@ -89,7 +89,7 @@ class AlimtalkSenderModule:
89
89
  def release(self, ksp_id: str):
90
90
  """
91
91
  채널 연동 해지
92
- DELETE /v1/alimtalk/senders/{ksp_id}
92
+ DELETE /alimtalk/senders/{ksp_id}
93
93
  이 프로젝트와의 연동만 끊는다 — 채널 모델과 템플릿은 보존된다. 성공 시 본문은 null 이다.
94
94
  :param ksp_id: 채널 문서 ID
95
95
  :return: None
@@ -102,7 +102,7 @@ class AlimtalkSenderModule:
102
102
  def variable_examples(self, ksp_id: str, examples: Dict[str, str]):
103
103
  """
104
104
  채널 변수 예문 사전 갱신
105
- PUT /v1/alimtalk/senders/{ksp_id}/variable_examples
105
+ PUT /alimtalk/senders/{ksp_id}/variable_examples
106
106
  템플릿 미리보기에서 #{user_name} 대신 '홍길동' 처럼 읽히게 하는 **표시용** 값이다.
107
107
  ⚠️ 발송값이 아니다 — 벤더로 전송되지 않으므로 검수 상태와 무관하다. 보낸 키만 덮어쓴다(부분 갱신).
108
108
  :param ksp_id: 채널 문서 ID