article
README
🚀 达拉亚项目
达拉亚项目致力于打造一套基于 safaricom 的 Daraja API 的工具与框架,以此简化 M-Pesa 支付解决方案的集成流程。借助该项目,开发者能够更便捷地实现各类支付功能。
🚀 快速开始
达拉亚项目提供了一系列实用功能,可助力开发者轻松集成 M-Pesa 支付解决方案,涵盖发起支付请求、生成支付二维码、查询账户余额以及实现 B2C 支付等功能。
✨ 主要特性
- stk_push:发起 M-Pesa STK 推送请求,要求客户在移动设备上授权支付。
- generate_qr_code:生成 QR 码,供客户扫描完成支付。
- account_balance:查询账户余额。
- b2c_payment:实现 B2C 支付功能。
📦 安装指南
请参考 安装文档 进行项目安装和配置。
💻 使用示例
支付工具
stk_push
发起 M-Pesa STK 推送请求,提示客户在移动设备上完成支付授权。
# 输入参数:
# - `amount` (int): 需要支付的金额
# - `phone_number` (int): 客户的电话号码
# 返回值: JSON 格式的 M-PESA API 响应
generate_qr_code
生成 QR 码,用于客户扫描完成支付。
# 输入参数:
# - `merchant_name` (str): 商家名称
# - `transaction_reference_no` (str): 交易参考号
# - `amount` (int): 总金额
# - `transaction_type` (Literal["BG", "WA", "PB", "SM", "SB"]): 交易类型
# - `credit_party_identifier` (str): 收款方标识(手机号码、企业号码、代理柜台、Paybill、商家商品)
# 返回值: JSON 格式的 M-PESA API 响应,包含 QR 码数据
支付提示语
stk_push_prompt
生成用于发起 M-Pesa STK 推送支付请求的提示语。
# 输入参数:
# - `phone_number` (str): 客户电话号码
# - `amount` (int): 支付金额
# - `purpose` (str): 支付目的
# 返回值: 格式化的 STK 推送请求提示字符串
generate_qr_code_prompt
生成用于创建 M-Pesa QR 码支付请求的提示语。
# 输入参数:
# - `merchant_name` (str): 商家名称
# - `amount` (int): 支付金额
# - `transaction_type` (str): 交易类型(BG 表示购买商品,WA 表示钱包,PB 表示 Paybill,SM 表示发送资金,SB 表示发送至企业)
# - `identifier` (str): 收款方标识(电话号码、企业号码、代理柜台、Paybill、商家商品)
# - `reference` (str, optional): 交易参考号。如果未提供,默认生成。
# 返回值: 格式化的 QR 码生成提示字符串
文档处理工具
create_source
创建一个从数据源到无结构服务器的数据连接器,用于数据处理。
# 输入参数:
# - `connector_name` (str): 数据源连接器的名称
# 返回值: 新创建的连接器对象
create_target
创建一个从无结构服务器到目标系统的数据连接器,用于数据处理。
# 输入参数:
# - `connector_name` (str): 目标连接器的名称
# - `target_system` (str): 目标系统标识
# 返回值: 新创建的连接器对象
transform
定义并应用一个数据转换规则到目标连接器。
# 输入参数:
# - `connector` (TargetConnector): 需要转换的目标连接器
# - `rule` (Dict[str, Any]): 数据转换规则
# 返回值: 应用转换后的数据结果
文档处理提示语
extract
从文档中提取指定信息。
# 输入参数:
# - `document` (str): 输入文档内容
# - `fields` (List[str]): 需要提取的字段列表
# 返回值: 提取的结果字典
classify
对文档进行分类。
# 输入参数:
# - `document` (str): 输入文档内容
# - `categories` (List[str]): 可能的分类标签
# 返回值: 分类结果和置信度分数
📚 详细文档
资源信息
项目相关资源如下:
📄 许可证
本项目遵循 MIT 协议。具体许可内容请参考 LICENSE 文件。
致谢
感谢以下机构和个人对本项目的贡献和支持:
- Safaricom:提供了强大的 M-Pesa 服务支持
- Open Source 社区:为项目的开发和维护提供了宝贵的反馈和技术支持
扫码联系在线客服