ninepay-sdk 1.3.0

Official Python SDK for 9PAY Payment Gateway

9PAY Payment Gateway Python SDK

Official Python SDK for integrating 9PAY Payment Gateway.

English | Tiếng Việt

---

English

🚀 Quick Start (Recommended)

1. Install SDK:

   pip install ninepay-sdk python-dotenv
   

2. Configure Environment: Copy .env.example to .env and fill in your credentials.

   cp .env.example .env
   

   NINEPAY_MERCHANT_ID=your_merchant_id
   NINEPAY_SECRET_KEY=your_secret_key
   NINEPAY_CHECKSUM_KEY=your_checksum_key
   NINEPAY_ENV=SANDBOX
   NINEPAY_ENDPOINT=9pay_endpoint
   

3. Usage:

   from ninepay import NinePayConfig, NinePayGateway
   
   # Load config automatically from .env
   config = NinePayConfig.from_env()
   gateway = NinePayGateway(config)
   

📦 Features

• ✅ Dynamic Config: Managed via .env files (PHP/Laravel style)
• ✅ Secure: Signature generation and verification (HMAC-SHA256)
• ✅ Comprehensive API:
  • Portal Payment (Redirect)
  • Transaction Inquiry
  • Refunds (Full/Partial)
  • Card Payment Flow (Payer Auth, Authorize, Capture, Reverse)
• ✅ Framework Friendly: Ready for Django, Flask, FastAPI

🛠 Installation

pip install ninepay-sdk

💡 Example: Create Payment

from ninepay import CreatePaymentRequest, PaymentMethod, Currency, Language
import time

request = CreatePaymentRequest(
    invoice_no=f'INV_{int(time.time())}',
    amount='50000',
    description='Order #12345',
    back_url='https://yoursite.com/cancel',
    return_url='https://yoursite.com/success'
).with_method(PaymentMethod.CREDIT_CARD).with_lang(Language.EN)

response = gateway.create_payment(request)
if response.is_success():
    print(f"Redirect URL: {response.get_data()['redirect_url']}")

---

Tiếng Việt

🚀 Bắt đầu nhanh (Khuyên dùng)

1. Cài đặt:

   pip install ninepay-sdk python-dotenv
   

2. Cấu hình môi trường: Copy .env.example thành .env và điền thông tin của bạn.

   cp .env.example .env
   

3. Sử dụng:

   from ninepay import NinePayConfig, NinePayGateway
   
   # Tự động load cấu hình từ file .env
   config = NinePayConfig.from_env()
   gateway = NinePayGateway(config)
   

✨ Tính năng chính

• ✅ Cấu hình tập trung: Quản lý qua file .env (giống Laravel/PHP)
• ✅ Bảo mật: Tự động tạo và xác thực chữ ký chuẩn HMAC-SHA256
• ✅ Đầy đủ API:
  • Tạo thanh toán Portal (Redirect)
  • Truy vấn đơn hàng (Inquiry)
  • Hoàn tiền (Refund)
  • Luồng thẻ nâng cao (Payer Auth, Authorize, Capture, Reverse)
• ✅ Dễ tích hợp: Tương thích tốt với Django, Flask, FastAPI

💡 Ví dụ: Truy vấn đơn hàng

# Truy vấn đơn hàng theo transaction ID (mã 9Pay) hoặc Invoice No
response = gateway.inquiry("454518005824417")
if response.is_success():
    print(f"Trạng thái đơn hàng: {response.get_data()['status']}")

🖥 Chạy Demo

Bạn có thể chạy script demo để kiểm tra nhanh:

python demo.py

🧪 Chạy Test

python -m unittest discover tests -v

Licensed under MIT.