Pingpp Python SDK

简介

pingpp 文件夹下是 Python SDK 文件，
example 文件夹里面是简单的接入示例，该示例仅供参考。

安装

pip install pingpp

或使用 setup.py 手动安装

python setup.py install

接入方法

示例代码

初始化

pingpp.api_key = 'YOUR_KEY'

开启日志

pingpp.log = 'debug'  # 支持 debug 和 info

或者设置环境变量 PINGPP_LOG

export PINGPP_LOG=debug

设置请求签名密钥

密钥需要你自己生成，公钥请填写到 Ping++ Dashboard
设置你的私钥路径

pingpp.private_key_path = '/path/to/your_rsa_private_key.pem'

设置重试

设置重试次数，0 表示不重试，默认为 1。

pingpp.max_network_retries = 0

当服务端返回 502 时，是否根据返回内容(阿里高防返回)来判断是否重试。False 表示只要是 502，全部重试。默认为 True。

pingpp.bad_gateway_match = False

重试延时设置（秒）

pingpp.network_retry_delay = 0.5

支付

ch = pingpp.Charge.create(
    order_no='201123456789',
    channel='alipay',
    amount=100,
    subject='Item Subject',
    body='Item Body',
    currency='cny',
    app=dict(id='APP_ID'),
    client_ip='127.0.0.1'
)

查询

pingpp.Charge.retrieve('CHARGE_ID')

params = {
    "app": {"id": "APP_ID"},
    "limit": 3,
}
pingpp.Charge.list(**params)

线下渠道交易撤销

pingpp.Charge.reverse('CHARGE_ID')

退款

re = pingpp.Charge.refund("CHARGE_ID"
                          description='Your Descripton',
                          amount=1)

退款列表

params = {
    'limit': 3,
}
refunds = pingpp.Charge.list_refunds('CHARGE_ID', **params)

退款查询

re = pingpp.Charge.retrieve_refund('CHARGE_ID', 'REFUND_ID')

微信红包

pingpp.RedEnvelope.create(
    order_no='123456789',
    channel='wx_pub',
    amount=100,
    subject='Your Subject',
    body='Your Body',
    currency='cny',
    app=dict(id='APP_ID'),
    extra=dict(send_name='Send Name'),
    recipient='User Openid',
    description='Your Description'
)

查询

pingpp.RedEnvelope.retrieve('RED_ID')

pingpp.RedEnvelope.list()

查询 event

pingpp.Event.retrieve('EVENT_ID')

微信企业付款

tr = pingpp.Transfer.create(
    order_no='1234567890',
    channel='wx_pub',
    amount=100,
    currency='cny',
    app=dict(id='APP_ID'),
    type='b2c',
    recipient='User Openid',
    extra=dict(user_name='User Name', force_check=False),
    description='Your Description'
)

查询

pingpp.Transfer.retrieve('TRANSFER_ID')

pingpp.Transfer.list()

Batch Refunds 批量退款

创建 Batch refund 对象

pingpp.BatchRefund.create（
    "app": 'APP_ID',
    "batch_no": "batchrefund2010801001",
    "description": "Batch refund description.",
    "charges": [
        "ch_L8qn10mLmr1GS8e5OODmHaL4",
        "ch_fdOmHaLmLmr1GOD4qn1dS8e5"
    ]
)

查询 Batch refund 对象

pingpp.BatchRefund.retrieve('BATCH_REFUND_ID')

查询 Batch refund 对象列表

pingpp.BatchRefund.list()

Batch Transfers 批量企业付款

创建批量付款

params = {
    "app": 'APP_ID',
    "batch_no": "batchrefund2010801001",
    "description": "Batch refund description.",
    "charges": [
        "ch_L8qn10mLmr1GS8e5OODmHaL4",
        "ch_fdOmHaLmLmr1GOD4qn1dS8e5"
    ]
}
pingpp.BatchTransfer.create(**params)

查询批量付款

pingpp.BatchTransfer.retrieve('BATCH_TRANSFER_ID')

查询批量付款列表

pingpp.BatchTransfer.list(app="APP_ID", per_page=3)

身份证银行卡信息认证接口

params = {
    "app": "APP_ID",
    "data": {
        "id_name": "张三",
        "id_number": "320291198811110000",
        "card_number": "6201111122223333"
    },
    "type": "bank_card"
}
pingpp.Identification.create(**params)

报关接口

请求报关接口

pingpp.Customs.create(
    app='APP_ID',
    charge='CHARGE_ID',
    channel='alipay',
    amount=100,  # 报关金额, 人民币单位：分
    customs_code='GUANGZHOU',
    trade_no='15112496832609'
)

查询报关接口

pingpp.Customs.retrieve("CUSTOMS_ID")

订单

创建商品订单

params = {
    "app": 'APP_ID',
    "uid": "15800973612",
    "merchant_order_no": "88888888888",
    "coupon":"300316082514255200000900",
    "amount": "30",
    "client_ip": "127.0.0.1",
    "currency": "cny",
    "subject": "test1",
    "body": "test1body1",
    "description": "test1-description",
    "time_expire": int(time.time()) + 1000
}

pingpp.Order.create(**params)

商品订单支付

params = {
    "charge_amount": 10,
    "channel": "balance"
}
pingpp.Order.pay("ORDER_ID", **params)

商品订单取消

pingpp.Order.cancel("ORDER_ID")

商品订单查询

pingpp.Order.retrieve("ORDER_ID")

商品订单列表

pingpp.Order.list()

商品订单charge列表查询

pingpp.Order.list_charges("ORDER_ID")

商品订单charge查询

pingpp.Order.retrieve_charge("ORDER_ID", "CHARGE_ID")

商品订单退款

params = {
    "description": "Your description",
    "charge": "CHARGE_ID",
    "charge_amount": 10
}
pingpp.Order.refund("ORDER_ID", **params)

商品订单退款查询

pingpp.Order.retrieve_refund("ORDER_ID", "REFUND_ID")

商品订单退款列表查询

params = {
    "per_page": 3
}
pingpp.Order.list_refunds("ORDER_ID", **params)

账户系统

用户充值

params = {
    "user": "user_test_01",
    "charge": {
        "amount": 100,
        "channel": "alipay_qr",
        "order_no": "8888888888888",
        "subject": "Your subject",
        "body": "Your body",
        "time_expire": "1502770016",
        "client_ip": "127.0.0.1",
        "extra": {}
    },
    "balance_bonus": {
        "amount": 100,
    },
    "from_user": "user_test_02",
    "description": "Your description",
    "metadata": {}
}

recharge = pingpp.Recharge.create(**params)

用户充值查询

pingpp.Recharge.retrieve("RECHARGE_ID")

用户充值列表

params = {
    "page": 1,
    "per_page": 3,
}
pingpp.Recharge.list(**params)

用户充值退款创建

params = {
    "description": "Your description",
    "metadata": {}
}
pingpp.Recharge.refund("RECHARGE_ID", **params)

用户充值退款查询

pingpp.Recharge.retrieve_refund("RECHARGE_ID", "REFUND_ID")

用户充值退款列表

params = {
    "page": 1,
    "per_page": 3,
}
pingpp.Recharge.list_refunds("RECHARGE_ID", **params)

创建账户

params = {
    "id": "user_001", # id 唯一
    "address": "address_1",
    "avatar": None,
    "email": None,
    "gender": "MALE",
    "metadata": {},
    "mobile": None,
    "name": "Your user name"
}
pingpp.User.create(app="APP_ID", **params)

获取账户列表

params = {
    "page": 1,
    "per_page": 3,
}
pingpp.User.list(app="APP_ID", **params)

获取账户详细信息

pingpp.User.retrieve("user_001", app="APP_ID")

更新账户信息

params = {
    "address": "address_1",
    "avatar": None,
    "email": None,
    "gender": "MALE",
    "metadata": {},
    "mobile": None,
    "name": "Your user name"
}
pingpp.User.update("user_001", app="APP_ID", **params)

用户账户交易明细

pingpp.BalanceTransaction.retrieve("TXN_ID",
                                   app="APP_ID")

用户账户交易查询列表

params = {
    "page": 1,
    "per_page": 3,
}
pingpp.BalanceTransaction.list(app="APP_ID", **params)

余额转账

pingpp.BalanceTransfer.create(app="APP_ID", **params)

余额提现申请

params = {
    "user": "user_001",
    "amount": 20000,
    "user_fee": 50,
    "description": "Description",
    "extra": {
        "card_number": "6225210207073918",
        "user_name": "姓名",
        "open_bank_code": "0102",
        "prov": "上海",
        "city": "上海"
    }
}
pingpp.Withdrawal.create(app="APP_ID", **params)

余额提现明细

pingpp.Withdrawal.retrieve("WITHDRAWAL_ID", app="APP_ID")

余额提现取消

pingpp.Withdrawal.cancel("WITHDRAWAL_ID", app="APP_ID")

余额提现列表

params = {
    "page": 1,
    "per_page": 3,
    "user": "user_001"
}
pingpp.Withdrawal.list(app="APP_ID", **params)

优惠券

创建单个优惠券

params = {
    "coupon_template": "300116082415452100000700",
}
pingpp.Coupon.create("user_001", **params)

更新优惠券

params = {
    "coupon_template": "300116082415452100000700",
    "metadata": {
        "key": "value"
    }
}
pingpp.Coupon.update("user_001", "coupon_id_001", **params)

删除优惠券

pingpp.Coupon.delete("user_001", "coupon_id_001")

查询优惠券

pingpp.Coupon.retrieve("user_001", "coupon_id_001")

查询用户优惠券列表

pingpp.Coupon.list("user_001", per_page=3)

优惠券模板

创建优惠券模板

params = {
    "name": "25OFF",
    "type": 1,
    "percent_off": 25,
    "amount_available": 10000,
    "max_circulation": 1000,
    "metadata": {
    },
    "expiration": null
}
pingpp.CouponTemplate.create(**params)

获取优惠券模板列表

pingpp.CouponTemplate.list(per_page=3)

获取优惠券模板明细

pingpp.CouponTemplate.retrieve("COUPON_TMPL_001")

更新优惠券模板

pingpp.CouponTemplate.update("COUPON_TMPL_001", **params)

删除优惠券模板

pingpp.CouponTemplate.delete("COUPON_TMPL_001")

查询优惠券模板下的优惠券列表

pingpp.CouponTemplate.list_coupons("COUPON_TMPL_001", per_page=3)

创建单个优惠券

pingpp.CouponTemplate.create_coupons("COUPON_TMPL_001", **params)

创建批量付款

params = {
    "app": "APP_ID",
    "batch_no": "batchrefund20100801001",
    "description": "Batch refund description.",
    "charges": [
        "ch_L8qn10mLmr1GS8e5OODmHaL4",
        "ch_fdOmHaLmLmr1GOD4qn1dS8e5"
    ]
}
pingpp.BatchTransfer.create(**params)

查询批量付款

pingpp.BatchTransfer.retrieve('BATCH_TRANSFER_ID')

查询批量付款列表

params = {
    "page": 1,
    "per_page": 3
}
pingpp.BatchTransfer.list(**params)

批量提现确认

params = {
    "withdrawals": [
        "1701611150302360654",
        "1701611151015078981"
    ]
}
pingpp.BatchWithdrawal.create(app="APP_ID", **params)

批量提现确认查询

pingpp.BatchWithdrawal.retrieve("BATCH_WITHDRAWAL_ID", app="APP_ID")

创建子商户

params = {
    'display_name': 'sub_app_display_name',
    'user': 'user_101',
    'metadata': {
        'key': 'value'
    },
    'description': 'Your description'
}
sub_app = pingpp.SubApp.create(app="APP_ID", **params)

查询子商户

pingpp.SubApp.retrieve("app_1Gqj58ynP0mHeX1q", app="APP_ID")

删除子商户

pingpp.SubApp.delete("app_1Gqj58ynP0mHeX1q", app="APP_ID")

查询子商户列表

pingpp.SubApp.list(app="APP_ID")

配置子商户渠道参数

params = {
    "banned_msg": None,
    "channel": "alipay",
    "description": "Your description",
    "params": {
        "alipay_account": "Your alipay Account",
        "alipay_app_id": "Your Alipay App ID",
        "alipay_app_public_key": "-----BEGIN PUBLIC KEY-----\nMIGeMA0GCSqGSIb3DQEBAQUAA4GMADCBiAKBgHoOhsk4g\/6sIK5KB5V9Vvim\/tFb\nCNuJ2zVhBjp377rnWIlf0ogfW7AHW5lyPl8rwVshFdk1F1eFk4Hk9s25tp8klbJl\nkJ3\/DxZIqBc7i9j\/h75Lx\/0nKqsLophYGBGWxJGl1RgwXlbw+mXJdpXbSNxAifIv\nqNqEZwwAS7C\/rmn1AgMBAAE=\n-----END PUBLIC KEY-----",
        "alipay_app_public_key_rsa2": None,
        "alipay_mer_app_private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIICWwIBAAKBgHoOhsk4g\/6sIK5KB5V9Vvim\/tFbCNuJ2zVhBjp377rnWIlf0ogf\nW7AHW5lyPl8rwVshFdk1F1eFk4Hk9s25tp8klbJlkJ3\/DxZIqBc7i9j\/h75Lx\/0n\nKqsLophYGBGWxJGl1RgwXlbw+mXJdpXbSNxAifIvqNqEZwwAS7C\/rmn1AgMBAAEC\ngYBuV5mUaaoyXovA5J4Mj95DNj0hKMpOJkds70TBMNIhxqlsr5rVgnvSHCS8COLI\nCPdpGfT1gyCR9+kNQd+4xg6IeqDpL3CqIgtZi+qRGpVJgXW1x\/oZYzzpqD4Q0\/4U\nUmOp6Mo9bDPnYKSVgReWWNtCdKncWvBE4gbYadHXYva6FQJBALfW1SPWzA2i7fQu\ncG89pPkBQOMG\/pd8JyeBgEHOv2\/nBN9zqir\/zMMFd+EbI00A1goy1pu4IVvt+GFG\nq\/\/5ZE8CQQCp93SxpFjbB49s5F+Lvs0PR08IzfxY9eoCrd9xt4hXqmksUYcodBtu",
        "alipay_mer_app_private_key_rsa2": None,
        "alipay_pid": "alipay_pid",
        "alipay_refund_nopwd": False,
        "alipay_security_key": "alipay_security_key",
        "alipay_sign_type": "rsa",
        "alipay_version": 1,
        "fee_rate": 80
    }
}
pingpp.SubApp.create_channel("app_1Gqj58ynP0mHeX1q", app="APP_ID", **params)

更新子商户渠道参数

updateParams = {
    'description': 'Your Channel description',
    'params': {
        "alipay_account": "Your alipay Account",
        "alipay_app_id": "Your Alipay App ID",
        "alipay_app_public_key": "-----BEGIN PUBLIC KEY-----\nMIGeMA0GCSqGSIb3DQEBAQUAA4GMADCBiAKBgHoOhsk4g\/6sIK5KB5V9Vvim\/tFb\nCNuJ2zVhBjp377rnWIlf0ogfW7AHW5lyPl8rwVshFdk1F1eFk4Hk9s25tp8klbJl\nkJ3\/DxZIqBc7i9j\/h75Lx\/0nKqsLophYGBGWxJGl1RgwXlbw+mXJdpXbSNxAifIv\nqNqEZwwAS7C\/rmn1AgMBAAE=\n-----END PUBLIC KEY-----",
        "alipay_app_public_key_rsa2": None,
        "alipay_mer_app_private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIICWwIBAAKBgHoOhsk4g\/6sIK5KB5V9Vvim\/tFbCNuJ2zVhBjp377rnWIlf0ogf\nW7AHW5lyPl8rwVshFdk1F1eFk4Hk9s25tp8klbJlkJ3\/DxZIqBc7i9j\/h75Lx\/0n\nKqsLophYGBGWxJGl1RgwXlbw+mXJdpXbSNxAifIvqNqEZwwAS7C\/rmn1AgMBAAEC\ngYBuV5mUaaoyXovA5J4Mj95DNj0hKMpOJkds70TBMNIhxqlsr5rVgnvSHCS8COLI\nCPdpGfT1gyCR9+kNQd+4xg6IeqDpL3CqIgtZi+qRGpVJgXW1x\/oZYzzpqD4Q0\/4U\nUmOp6Mo9bDPnYKSVgReWWNtCdKncWvBE4gbYadHXYva6FQJBALfW1SPWzA2i7fQu\ncG89pPkBQOMG\/pd8JyeBgEHOv2\/nBN9zqir\/zMMFd+EbI00A1goy1pu4IVvt+GFG\nq\/\/5ZE8CQQCp93SxpFjbB49s5F+Lvs0PR08IzfxY9eoCrd9xt4hXqmksUYcodBtu",
        "alipay_mer_app_private_key_rsa2": None,
        "alipay_pid": "alipay_pid",
        "alipay_refund_nopwd": False,
        "alipay_security_key": "alipay_security_key",
        "alipay_sign_type": "rsa",
        "alipay_version": 1,
        "fee_rate": 80
    },
    'banned': False
}
pingpp.SubApp.update_channel("app_1Gqj58ynP0mHeX1q", 'alipay', **updateParams)

删除子商户渠道参数

pingpp.SubApp.delete_channel('app_1Gqj58ynP0mHeX1q', 'alipay')

获取子商户渠道参数

pingpp.SubApp.retrieve_channel('app_1Gqj58ynP0mHeX1q', 'alipay')

创建结算账号

# 创建结算账号-**银联渠道
params = {
    "channel": "unionpay",
    "recipient": {
        "account": "6214850266666666",
        "name": "11111111",
        "type": "b2c",  # 转账类型。b2c：企业向个人付款，b2b：企业向企业付款。
        "open_bank": "招商银行",
        "open_bank_code": "0308"
    }

}
pingpp.SettleAccount.create('user_001', app="APP_ID", **params)

# 创建结算账号-支付宝渠道
params = {
    "channel": "alipay",
    "recipient": {
        "account": "account@domain.com",
        "name": "李四",
        "type": "b2c"  # 转账类型。b2c：企业向个人付款。
    }

}
pingpp.SettleAccount.create('user_001', app="APP_ID", **params)

# 创建结算账号-微信渠道
params = {
    "channel": "wx_pub",
    "recipient": {
        "account": "your_open_id",
        "name": "王五",
        "type": "b2c",  # 转账类型。b2c：企业向个人付款。
        "force_check": False
    }
}
pingpp.SettleAccount.create('user_001', app="APP_ID", **params)

查询结算账号

pingpp.SettleAccount.retrieve('user_001', 'SETTLE_ACCOUNT_ID', app="APP_ID")

删除结算账号

pingpp.SettleAccount.delete('user_001', 'SETTLE_ACCOUNT_ID', app="APP_ID")

查询结算账号列表

pingpp.SettleAccount.list('user_001', app="APP_ID")

批量更新分润对象

params = {
    "ids": [
        "170301124238000111",
        "170301124238000211"
    ],
    "method": "manual",
    "description": "Your description"
}
pingpp.Royalty.update(**params)

查询分润对象

pingpp.Royalty.retrieve('ROYALTY_ID')

查询分润对象列表

params = {
    'page': 1,
    'per_page': 3
}
pingpp.Royalty.list(**params)

创建分润结算对象

params = {
    "payer_app": "APP_ID",
    "method": "unionpay",
    "recipient_app": "APP_ID_2",
    "created": {
        "gt": 1488211200,
        "lte": 1488297600
    }
}
pingpp.RoyaltySettlement.create(**params)

查询分润结算对象

pingpp.RoyaltySettlement.retrieve('ROYALTY_SETTLEMENT_ID')

更新分润结算对象

# 更新分润结算对象-确认
pingpp.RoyaltySettlement.confirm('ROYALTY_SETTLEMENT_ID')
# 更新分润结算对象-取消
pingpp.RoyaltySettlement.cancel('ROYALTY_SETTLEMENT_ID')

查询分润结算列表

pingpp.RoyaltySettlement.list(**params)

查询分润明细

params = {
    "page": 1,
    "per_page": 15
}
pingpp.RoyaltyTransaction.list(**params)

查询分润明细列表

pingpp.RoyaltyTransaction.retrieve('ROYALTY_TRANSACTION_ID')

查询余额结算列表

pingpp.BalanceSettlement.list(page=1, per_page=10)

查询余额结算

pingpp.BalanceSettlement.retrieve('BALANCE_SETTLEMENT_ID')

银行卡信息查询

pingpp.CardInfo.query(
    app="APP_ID",
    bank_account='6214888888888888'
)

详细信息请参考 API 文档。

PingPlusPlus/pingpp-python

Pingpp Python SDK

简介

安装

接入方法

初始化

开启日志

设置请求签名密钥

设置重试

支付

查询

线下渠道交易撤销

退款

退款列表

退款查询

微信红包

查询

查询 event

微信企业付款

查询

Batch Refunds 批量退款

创建 Batch refund 对象

查询 Batch refund 对象

查询 Batch refund 对象列表

Batch Transfers 批量企业付款

创建批量付款

查询批量付款

查询批量付款列表

身份证银行卡信息认证接口

报关接口

请求报关接口

查询报关接口

订单

创建商品订单

商品订单支付

商品订单取消

商品订单查询

商品订单列表

商品订单charge列表查询

商品订单charge查询

商品订单退款

商品订单退款查询

商品订单退款列表查询

账户系统

用户充值

用户充值查询

用户充值列表

用户充值退款创建

用户充值退款查询

用户充值退款列表

创建账户

获取账户列表

获取账户详细信息

更新账户信息

用户账户交易明细

用户账户交易查询列表

余额转账

余额提现申请

余额提现明细

余额提现取消

余额提现列表

优惠券

创建单个优惠券

更新优惠券

删除优惠券

查询优惠券

查询用户优惠券列表

优惠券模板

创建优惠券模板

获取优惠券模板列表

获取优惠券模板明细

更新优惠券模板

删除优惠券模板

查询优惠券模板下的优惠券列表

创建单个优惠券

创建批量付款

查询批量付款

查询批量付款列表

批量提现确认

批量提现确认查询