full/wiki/api/12-wallet.md

WALLET API

钱包、支付方式、支付宝与微信支付。

本文档由 protobuf descriptor 生成。字段名采用 protobuf JSON 名称；64 位整数在 JSON 中应按字符串处理。

接入方式

• 动态 HTTP：POST /rpc/wallet/{Service}/{Method}
• 原生 gRPC：/wallet.{Service}/{Method}
• grpc-gateway：POST /wallet.{Service}/{Method}
• 鉴权：需要登录的接口通过 Authorization: Bearer <token> 传递凭证。
• 动态 HTTP 成功或失败均返回 HTTP 200，业务状态见 code、message、details。

服务概览

服务	方法数	说明
Alipay	4	Alipay 服务
Basic	8	Basic 服务
Payment	6	Payment 服务
Wechat	5	Wechat 服务

Alipay

方法	动态 HTTP 路径	请求	响应	类型
WapPay	POST /rpc/wallet/Alipay/WapPay	wallet.AlipayTradeWapPayRequest	wallet.AlipayTradeWapPayReply	Unary
PagePay	POST /rpc/wallet/Alipay/PagePay	wallet.AlipayTradePagePayRequest	wallet.AlipayTradePagePayReply	Unary
AppPay	POST /rpc/wallet/Alipay/AppPay	wallet.AlipayTradeAppPayRequest	wallet.AlipayTradeAppPayReply	Unary
Transfer	POST /rpc/wallet/Alipay/Transfer	wallet.AlipayUniTransferRequest	wallet.AlipayUniTransferReply	Unary

Alipay.WapPay

• 动态 HTTP：POST /rpc/wallet/Alipay/WapPay
• gRPC：/wallet.Alipay/WapPay
• 白名单键：wallet.Alipay.WapPay
• 请求示例：

{
  "amount": "0",
  "description": "string",
  "notifyUrl": "string",
  "quitUrl": "string",
  "userIdentification": "string"
}

Alipay.PagePay

• 动态 HTTP：POST /rpc/wallet/Alipay/PagePay
• gRPC：/wallet.Alipay/PagePay
• 白名单键：wallet.Alipay.PagePay
• 请求示例：

{
  "amount": "0",
  "description": "string",
  "notifyUrl": "string",
  "returnUrl": "string",
  "userIdentification": "string"
}

Alipay.AppPay

• 动态 HTTP：POST /rpc/wallet/Alipay/AppPay
• gRPC：/wallet.Alipay/AppPay
• 白名单键：wallet.Alipay.AppPay
• 请求示例：

{
  "amount": "0",
  "description": "string",
  "notifyUrl": "string",
  "userIdentification": "string"
}

Alipay.Transfer

• 动态 HTTP：POST /rpc/wallet/Alipay/Transfer
• gRPC：/wallet.Alipay/Transfer
• 白名单键：wallet.Alipay.Transfer
• 请求示例：

{
  "amount": "0",
  "description": "string",
  "fee": "0",
  "userIdentification": "string"
}

Basic

方法	动态 HTTP 路径	请求	响应	类型
GetWallet	POST /rpc/wallet/Basic/GetWallet	wallet.GetWalletRequest	wallet.GetWalletReply	Unary
SetPayPassword	POST /rpc/wallet/Basic/SetPayPassword	wallet.SetPayPasswordRequest	finance_wallet_blocks.StatusReply	Unary
BindPaymentId	POST /rpc/wallet/Basic/BindPaymentId	wallet.BindPaymentIDRequest	finance_wallet_blocks.StatusReply	Unary
Transactions	POST /rpc/wallet/Basic/Transactions	wallet.TransactionsRequest	wallet.TransactionsReply	Unary
AddBankCard	POST /rpc/wallet/Basic/AddBankCard	wallet.AddBankCardRequest	finance_wallet_blocks.StatusReply	Unary
GetBankCard	POST /rpc/wallet/Basic/GetBankCard	wallet.FinanceEmpty	wallet.GetBankCardReply	Unary
RmBankCard	POST /rpc/wallet/Basic/RmBankCard	wallet.RmBankCardRequest	finance_wallet_blocks.StatusReply	Unary
ApplyCash	POST /rpc/wallet/Basic/ApplyCash	wallet.ApplyCashRequest	finance_wallet_blocks.StatusReply	Unary

Basic.GetWallet

• 动态 HTTP：POST /rpc/wallet/Basic/GetWallet
• gRPC：/wallet.Basic/GetWallet
• 白名单键：wallet.Basic.GetWallet
• 请求示例：

{
  "isTotalAllIn": false,
  "isTotalAllOut": false,
  "isTotalMonthIn": false,
  "isTotalMonthOut": false,
  "isTotalTodayIn": false,
  "isTotalTodayOut": false
}

Basic.SetPayPassword

• 动态 HTTP：POST /rpc/wallet/Basic/SetPayPassword
• gRPC：/wallet.Basic/SetPayPassword
• 白名单键：wallet.Basic.SetPayPassword
• 请求示例：

{
  "passportIdentity": "string",
  "password": "string"
}

Basic.BindPaymentId

• 动态 HTTP：POST /rpc/wallet/Basic/BindPaymentId
• gRPC：/wallet.Basic/BindPaymentId
• 白名单键：wallet.Basic.BindPaymentId
• 请求示例：

{
  "authCode": "string",
  "payType": 0
}

Basic.Transactions

• 动态 HTTP：POST /rpc/wallet/Basic/Transactions
• gRPC：/wallet.Basic/Transactions
• 白名单键：wallet.Basic.Transactions
• 请求示例：

{
  "end": "string",
  "page": "0",
  "pageSize": "0",
  "start": "string",
  "tradeType": "0",
  "transType": "0"
}

Basic.AddBankCard

• 动态 HTTP：POST /rpc/wallet/Basic/AddBankCard
• gRPC：/wallet.Basic/AddBankCard
• 白名单键：wallet.Basic.AddBankCard
• 请求示例：

{
  "cardNo": "string",
  "cardOwner": "string",
  "idCard": "string",
  "phone": "string",
  "walletIdentity": "string"
}

Basic.GetBankCard

• 动态 HTTP：POST /rpc/wallet/Basic/GetBankCard
• gRPC：/wallet.Basic/GetBankCard
• 白名单键：wallet.Basic.GetBankCard
• 请求示例：

{}

Basic.RmBankCard

• 动态 HTTP：POST /rpc/wallet/Basic/RmBankCard
• gRPC：/wallet.Basic/RmBankCard
• 白名单键：wallet.Basic.RmBankCard
• 请求示例：

{
  "identity": "string"
}

Basic.ApplyCash

• 动态 HTTP：POST /rpc/wallet/Basic/ApplyCash
• gRPC：/wallet.Basic/ApplyCash
• 白名单键：wallet.Basic.ApplyCash
• 请求示例：

{
  "amount": "0",
  "channel": 0,
  "remark": "string"
}

Payment

方法	动态 HTTP 路径	请求	响应	类型
Hello	POST /rpc/wallet/Payment/Hello	finance_wallet_blocks.Empty	wallet.PaymentReply	Unary
Way	POST /rpc/wallet/Payment/Way	wallet.WayRequest	wallet.WayReply	Unary
Get	POST /rpc/wallet/Payment/Get	finance_wallet_blocks.IdentRequest	wallet.PaymentItem	Unary
ByOrder	POST /rpc/wallet/Payment/ByOrder	wallet.OrderRequest	wallet.PaymentReply	Unary
ByCharge	POST /rpc/wallet/Payment/ByCharge	wallet.ChargeRequest	wallet.PaymentReply	Unary
Callback	POST /rpc/wallet/Payment/Callback	wallet.CallbackRequest	finance_wallet_blocks.StatusReply	Unary

Payment.Hello

• 动态 HTTP：POST /rpc/wallet/Payment/Hello
• gRPC：/wallet.Payment/Hello
• 白名单键：wallet.Payment.Hello
• 请求示例：

{}

Payment.Way

• 动态 HTTP：POST /rpc/wallet/Payment/Way
• gRPC：/wallet.Payment/Way
• 白名单键：wallet.Payment.Way
• 请求示例：

{
  "platform": "string"
}

Payment.Get

• 动态 HTTP：POST /rpc/wallet/Payment/Get
• gRPC：/wallet.Payment/Get
• 白名单键：wallet.Payment.Get
• 请求示例：

{
  "id": "0",
  "identity": "string"
}

Payment.ByOrder

• 动态 HTTP：POST /rpc/wallet/Payment/ByOrder
• gRPC：/wallet.Payment/ByOrder
• 白名单键：wallet.Payment.ByOrder
• 请求示例：

{
  "args": "string",
  "desc": "string",
  "openId": "string",
  "orderNo": "string",
  "password": "string",
  "payChannel": 0,
  "payType": "string"
}

Payment.ByCharge

• 动态 HTTP：POST /rpc/wallet/Payment/ByCharge
• gRPC：/wallet.Payment/ByCharge
• 白名单键：wallet.Payment.ByCharge
• 请求示例：

{
  "amount": "0",
  "desc": "string",
  "openId": "string",
  "payChannel": 0,
  "payType": "string",
  "remark": "string"
}

Payment.Callback

• 动态 HTTP：POST /rpc/wallet/Payment/Callback
• gRPC：/wallet.Payment/Callback
• 白名单键：wallet.Payment.Callback
• 请求示例：

{
  "callbackMsg": "string",
  "callbackStatus": false,
  "id": "0",
  "identity": "string"
}

Wechat

方法	动态 HTTP 路径	请求	响应	类型
JsapiPreOrder	POST /rpc/wallet/Wechat/JsapiPreOrder	wallet.WxpayJSAPIPreOrderRequest	wallet.WxpayJSAPIPreOrderReply	Unary
AppPreOrder	POST /rpc/wallet/Wechat/AppPreOrder	wallet.WxpayAppPreOrderRequest	wallet.WxpayAppPreOrderReply	Unary
NativePreOrder	POST /rpc/wallet/Wechat/NativePreOrder	wallet.WxpayNativePreOrderRequest	wallet.WxpayNativePreOrderReply	Unary
Transfer	POST /rpc/wallet/Wechat/Transfer	wallet.WxpayTransferRequest	wallet.WxpayTransferReply	Unary
WxCallback	POST /rpc/wallet/Wechat/WxCallback	wallet.WxCallBackRequest	wallet.CallBackReply	Unary

Wechat.JsapiPreOrder

• 动态 HTTP：POST /rpc/wallet/Wechat/JsapiPreOrder
• gRPC：/wallet.Wechat/JsapiPreOrder
• 白名单键：wallet.Wechat.JsapiPreOrder
• 请求示例：

{
  "amount": "0",
  "authCode": "string",
  "description": "string",
  "notifyUrl": "string",
  "orderNo": "string",
  "userIdentification": "string"
}

Wechat.AppPreOrder

• 动态 HTTP：POST /rpc/wallet/Wechat/AppPreOrder
• gRPC：/wallet.Wechat/AppPreOrder
• 白名单键：wallet.Wechat.AppPreOrder
• 请求示例：

{
  "amount": "0",
  "description": "string",
  "notifyUrl": "string",
  "userIdentification": "string"
}

Wechat.NativePreOrder

• 动态 HTTP：POST /rpc/wallet/Wechat/NativePreOrder
• gRPC：/wallet.Wechat/NativePreOrder
• 白名单键：wallet.Wechat.NativePreOrder
• 请求示例：

{
  "amount": "0",
  "description": "string",
  "notifyUrl": "string",
  "userIdentification": "string"
}

Wechat.Transfer

• 动态 HTTP：POST /rpc/wallet/Wechat/Transfer
• gRPC：/wallet.Wechat/Transfer
• 白名单键：wallet.Wechat.Transfer
• 请求示例：

{
  "amount": "0",
  "description": "string",
  "fee": "0",
  "transferName": "string",
  "userIdentification": "string"
}

Wechat.WxCallback

• 动态 HTTP：POST /rpc/wallet/Wechat/WxCallback
• gRPC：/wallet.Wechat/WxCallback
• 白名单键：wallet.Wechat.WxCallback
• 请求示例：

{
  "SignInfo": {
    "actCode": "string",
    "activityId": "string",
    "cardId": "string",
    "code": "string",
    "hallBelongMchId": "0",
    "hallCode": "string",
    "transactionId": "string"
  },
  "createTime": "string",
  "eventType": "string",
  "id": "string",
  "resource": {
    "algorithm": "string",
    "associatedData": "string",
    "ciphertext": "string",
    "nonce": "string",
    "originalType": "string"
  },
  "resourceType": "string",
  "summary": "string"
}

消息结构

finance_wallet_blocks.Empty

空消息：请求时发送 {}。

finance_wallet_blocks.IdentRequest

JSON 字段	类型	规则
id	int64	可选
identity	string	可选

finance_wallet_blocks.StatusReply

JSON 字段	类型	规则
code	int32	可选
message	string	可选
details	string	可选
timeseq	int64	可选

wallet.AddBankCardRequest

JSON 字段	类型	规则
walletIdentity	string	可选
cardNo	string	可选
cardOwner	string	可选
idCard	string	可选
phone	string	可选

wallet.AlipayTradeAppPayReply

JSON 字段	类型	规则
payParam	string	可选

wallet.AlipayTradeAppPayRequest

JSON 字段	类型	规则
userIdentification	string	可选
amount	int64	可选
description	string	可选
notifyUrl	string	可选

wallet.AlipayTradePagePayReply

JSON 字段	类型	规则
payUrl	string	可选

wallet.AlipayTradePagePayRequest

JSON 字段	类型	规则
userIdentification	string	可选
amount	int64	可选
description	string	可选
notifyUrl	string	可选
returnUrl	string	可选

wallet.AlipayTradeWapPayReply

JSON 字段	类型	规则
payUrl	string	可选

wallet.AlipayTradeWapPayRequest

JSON 字段	类型	规则
userIdentification	string	可选
amount	int64	可选
description	string	可选
notifyUrl	string	可选
quitUrl	string	可选

wallet.AlipayUniTransferReply

空消息：请求时发送 {}。

wallet.AlipayUniTransferRequest

JSON 字段	类型	规则
userIdentification	string	可选
amount	int64	可选
fee	int64	可选
description	string	可选

wallet.ApplyCashRequest

JSON 字段	类型	规则
channel	int32	可选
amount	int64	可选
remark	string	可选

wallet.BankCardInfo

JSON 字段	类型	规则
id	int64	可选
bankNumber	string	可选
bankName	string	可选
cardOwner	string	可选
idCard	string	可选
phone	string	可选
bindId	string	可选
bankType	string	可选
bank	string	可选
created	string	可选

wallet.BindPaymentIDRequest

JSON 字段	类型	规则
payType	int32	可选
authCode	string	可选

wallet.CallBackReply

JSON 字段	类型	规则
code	string	可选
message	string	可选

wallet.CallbackRequest

JSON 字段	类型	规则
id	int64	可选
identity	string	可选
callbackStatus	bool	可选
callbackMsg	string	可选

wallet.ChargeRequest

JSON 字段	类型	规则
amount	int64	可选
remark	string	可选
payChannel	int32	可选
payType	string	可选
desc	string	可选
openId	string	可选

wallet.FinanceEmpty

空消息：请求时发送 {}。

wallet.GetBankCardReply

JSON 字段	类型	规则
data	[]wallet.BankCardInfo	数组

wallet.GetWalletReply

JSON 字段	类型	规则
passportIdentity	string	可选
walletIdentity	string	可选
balance	int64	可选
withdrawalBalance	int64	可选
status	int32	可选
alipayId	string	可选
alipayName	string	可选
wxpayId	string	可选
wxpayName	string	可选
total	map<string, int64>	对象映射
created	string	可选

wallet.GetWalletReply.TotalEntry

JSON 字段	类型	规则
key	string	可选
value	int64	可选

wallet.GetWalletRequest

JSON 字段	类型	规则
isTotalTodayIn	bool	可选
isTotalTodayOut	bool	可选
isTotalMonthIn	bool	可选
isTotalMonthOut	bool	可选
isTotalAllIn	bool	可选
isTotalAllOut	bool	可选

wallet.OrderRequest

JSON 字段	类型	规则
orderNo	string	可选
payChannel	int32	可选
payType	string	可选
password	string	可选
args	string	可选
desc	string	可选
openId	string	可选

wallet.PaymentItem

JSON 字段	类型	规则
orderNo	string	可选
tradeNo	string	可选
type	int32	可选
payChannel	int32	可选
payType	string	可选
amount	int64	可选
args	string	可选
status	int32	可选

wallet.PaymentReply

JSON 字段	类型	规则
code	int64	可选
result	map<string, string>	对象映射

wallet.PaymentReply.ResultEntry

JSON 字段	类型	规则
key	string	可选
value	string	可选

wallet.RmBankCardRequest

JSON 字段	类型	规则
identity	string	可选

wallet.SetPayPasswordRequest

JSON 字段	类型	规则
passportIdentity	string	可选
password	string	可选

wallet.Transaction

JSON 字段	类型	规则
transType	int32	可选
tradeType	int32	可选
inTradeNo	string	可选
outTradeNo	string	可选
money	int64	可选
fee	int64	可选
payChannel	int32	可选
payType	string	可选
created	string	可选
remark	string	可选

wallet.TransactionsReply

JSON 字段	类型	规则
total	int64	可选
records	[]wallet.Transaction	数组

wallet.TransactionsRequest

JSON 字段	类型	规则
transType	int64	可选
tradeType	int64	可选
start	string	可选
end	string	可选
page	int64	可选
pageSize	int64	可选

wallet.WayItem

JSON 字段	类型	规则
ident	string	可选
title	string	可选
intro	string	可选
args	string	可选

wallet.WayReply

JSON 字段	类型	规则
way	[]wallet.WayItem	数组

wallet.WayRequest

JSON 字段	类型	规则
platform	string	可选

wallet.WxCallBackRequest

JSON 字段	类型	规则
id	string	可选
createTime	string	可选
resourceType	string	可选
eventType	string	可选
summary	string	可选
resource	wallet.WxCallBackResource	可选
SignInfo	wallet.WxCallBackSignInfo	可选

wallet.WxCallBackResource

JSON 字段	类型	规则
originalType	string	可选
algorithm	string	可选
ciphertext	string	可选
associatedData	string	可选
nonce	string	可选

wallet.WxCallBackSignInfo

JSON 字段	类型	规则
transactionId	string	可选
actCode	string	可选
hallCode	string	可选
hallBelongMchId	int64	可选
cardId	string	可选
code	string	可选
activityId	string	可选

wallet.WxpayAppPreOrderReply

JSON 字段	类型	规则
prepayId	string	可选
appId	string	可选
mchId	string	可选

wallet.WxpayAppPreOrderRequest

JSON 字段	类型	规则
userIdentification	string	可选
amount	int64	可选
description	string	可选
notifyUrl	string	可选

wallet.WxpayJSAPIPreOrderReply

JSON 字段	类型	规则
prepayId	string	可选
appId	string	可选
timestamp	string	可选
nonceStr	string	可选
signType	string	可选
sign	string	可选

wallet.WxpayJSAPIPreOrderRequest

JSON 字段	类型	规则
userIdentification	string	可选
amount	int64	可选
authCode	string	可选
description	string	可选
notifyUrl	string	可选
orderNo	string	可选

wallet.WxpayNativePreOrderReply

JSON 字段	类型	规则
codeUrl	string	可选

wallet.WxpayNativePreOrderRequest

JSON 字段	类型	规则
userIdentification	string	可选
amount	int64	可选
description	string	可选
notifyUrl	string	可选

wallet.WxpayTransferReply

空消息：请求时发送 {}。

wallet.WxpayTransferRequest

JSON 字段	类型	规则
userIdentification	string	可选
amount	int64	可选
fee	int64	可选
description	string	可选
transferName	string	可选