v0.1.68

jkf-pay-proto

transaction/transaction.proto

CheckFreeDiamondReq

Field	Type	Label	Description
access_token	string
get_it_right_now	bool		false -> 單純查, true -> 我要領

CheckFreeDiamondRes

Field	Type	Description
diamond_amount	int64	餘額
cooldown_seconds	int64	-1 為不用倒數
free_diamond_amount	int64	此次領取到的數量

CompleteTransactionReq

Field	Type	Description
transaction_token	string
diamond_param	PaymentParamsOfDiamond
creditcard_param	PaymentParamsOfCreditCard
ecpay_inpay_param	PaymentParamsOfEcpayInpay	站內付
happy_pay_param	PaymentParamsOfHappypay	Happypay oversea
tap_pay_param	PaymentParamsOfTapPay
jpoint_pay_param	google.protobuf.Empty
cash_param	google.protobuf.Empty
jkopay_onlinepay_param	google.protobuf.Empty
jkopay_authpay_regular_param	PaymentParamsOfJkopayAuthPay
jkopay_authpay_limited_param	PaymentParamsOfJkopayAuthPay

CompleteTransactionRes

Field	Type	Label	Description
three_d_url	string		optional

CreateTransactionTokenReq

Field	Type	Label	Description
app_id	string
order_id	string
product_name	string
money	Money
check_code	string
callback_url	string
redirect_url	string
access_token	string
jpoint_discount	int64
payment_channels	PaymentChannel	repeated	optional 指定訂單付款方式
require_apea_twid	bool

CreateTransactionTokenRes

Field	Type	Label	Description
transaction_token	string
transc_id	string

CreditCard

Field	Type	Description
card_id	string
last_four_num	string
issuing_network	string	發卡機構
last_used	bool

CreditCard.Status

DiamondPackage

Field	Type	Description
id	int64
name	string
usd	double
twd	int64
diamond_amount	int64
img	string
description	string
can_buy	bool
type	DiamondPackageType
ribbon_url	string
bonus_amount	int64	bonus期間才會有數值 (bonus_start_at, bonus_end_at)

DiamondRecord

DiamondRecord 鑽石異動紀錄詳細資訊

Field	Type	Description
trade_id	string	trade_id - 關聯的交易識別碼
product_name	string	product_name - 商品名稱或異動原因
amount_before	int64	amount_before - 異動前鑽石數量
amount_after	int64	amount_after - 異動後鑽石數量
created_at	google.protobuf.Timestamp	created_at - 異動發生時間
memo	string	memo - 異動備註說明

DiscountTransactionReq

Field	Type	Label	Description
transaction_token	string
jpoint_discount	int64

DiscountTransactionRes

FormData

Field	Type	Label
key	string
value	string
options	FormDataOptions	repeated

FormDataOptions

Field	Type	Label	Description
value	string
text	string

GetBonusAmountReq

GetBonusAmountReq 取得超值方案鑽石餘額的請求參數

Field	Type	Label	Description
access_token	string		access_token - 用戶存取 token

GetBonusAmountRes

GetBonusAmountRes 取得超值方案鑽石餘額的回應結果

Field	Type	Label	Description
amount	int64		amount - 可用超值方案鑽石數量

GetDiamondAmountReq

Field	Type	Label	Description
access_token	string

GetDiamondAmountRes

Field	Type	Label	Description
diamond_amount	int64

GetDiamondPackagesReq

Field	Type	Label	Description
filter_type	DiamondPackageType
access_token	string

GetDiamondPackagesRes

Field	Type	Label	Description
packages	DiamondPackage	repeated

GetDiamondRecordReq

GetDiamondRecordReq 取得鑽石異動紀錄的請求參數

Field	Type	Description
access_token	string	access_token - 用戶存取 token
page	int64	page - 頁數
limit	int64	limit - 每頁筆數
start_at	google.protobuf.Timestamp	start_at - 異動時間起始範圍
end_at	google.protobuf.Timestamp	end_at - 異動時間結束範圍
type	DiamondRecordType	type - 異動紀錄類型篩選

GetDiamondRecordRes

GetDiamondRecordRes 取得鑽石異動紀錄的回應結果

Field	Type	Label	Description
records	DiamondRecord	repeated	records - 鑽石異動紀錄清單
total	int64		total - 總筆數

GetExchangeRateReq

GetExchangeRateRes

Field	Type	Label	Description
usd_to_twd	double

GetFreeDiamondAmountReq

GetFreeDiamondAmountReq 取得免費鑽石餘額的請求參數

Field	Type	Label	Description
access_token	string		access_token - 用戶存取 token

GetFreeDiamondAmountRes

GetFreeDiamondAmountRes 取得免費鑽石餘額的回應結果

Field	Type	Label	Description
amount	int64		amount - 可用免費鑽石數量

GetFreeDiamondEarnTimesReq

GetFreeDiamondEarnTimesReq 取得免費鑽石獲得次數的請求參數

Field	Type	Label	Description
access_token	string		access_token - 用戶存取 token

GetFreeDiamondEarnTimesRes

GetFreeDiamondEarnTimesRes 取得免費鑽石獲得次數的回應結果

Field	Type	Label	Description
earn_times	int64		earn_times - 免費鑽石獲得次數

GetPaymentInfoReq

Field	Type	Label	Description
transaction_token	string		tranasaction token
jpoint_discount	int64		optional

GetPaymentInfoRes

Field	Type	Label	Description
payment_methods	PaymentMethod	repeated
invoice_setting	InvoiceSetting

GetPurchaseRecordReq

Field	Type	Description
access_token	string
page	int64
limit	int64
start_completed_at	google.protobuf.Timestamp
end_completed_at	google.protobuf.Timestamp
currency	Currency
app_id	string	optional

GetPurchaseRecordRes

Field	Type	Label	Description
records	PurchaseRecord	repeated
total	int64

GetTransactionTokenReq

Field	Type	Label	Description
app_id	string
transc_id	string
check_code	string

GetTransactionTokenRes

Field	Type	Label	Description
transaction_token	string

InvoiceSetting

Field	Type	Label	Description
email	string
phone_carrier	string
id_carrier	string
donate_code	string
last_used	InvoiceType

Money

Field	Type	Label	Description
currency	Currency		交易貨幣
price	int64		交易金額
display_currency	Currency		顯示貨幣
display_price	int64		顯示金額
payment_currency	Currency	optional	付款貨幣，如果有設定且跟交易貨幣的值不同，會自動依據 JPay 系統設定匯率轉換
payment_amount	int64	optional	在某些場合，有設定此值代表實際金流交易的 payment currency 金額

PaymentCode

付款代碼提供 DisplayInfoUrl, CodeInfo

Field	Type	Label	Description
display_info_url	PaymentCode.DisplayInfoUrl	optional	付款網址，如果有提供，則以這個網址為主
atm_info	PaymentCode.AtmInfo
cvs_info	PaymentCode.CvsInfo

PaymentCode.AtmInfo

Field	Type	Label	Description
bank_code	string
bank_account	string
expire_date	google.protobuf.Timestamp
atm_option_value	string

PaymentCode.CvsInfo

Field	Type	Label
cvs_name	string
cvs_code	string
payment_url	string	optional
expire_date	google.protobuf.Timestamp
cvs_type	PaymentCode.CvsInfo.CvsType
cvs_option_value	string

PaymentCode.DisplayInfoUrl

Field	Type	Label
url	string
method	PaymentCode.DisplayInfoUrl.Method
data	FormData	repeated

PaymentMethod

Field	Type	Label	Description
payment_method_id	string
type	PaymentType		method creditcard, diamond
payment_channel	PaymentChannel
bound_credit_card	CreditCard	repeated	only response data on channel = creditcard
is_allow_new_credit_card	bool
is_form_post	bool		是否為 form post
form_post_url	string
form_post_data	FormData	repeated
ecpay_inpay_token	string
last_used	bool
invoice_status	InvoiceStatus
upstream_app_id	string
upstream_app_key	string
payment_code	PaymentCode	optional	付款代碼，例如 ATM 繳費代碼、 CVS 繳費代碼

PaymentParamsOfCreditCard

Field	Type	Label	Description
creditcard_id	string

PaymentParamsOfDiamond

PaymentParamsOfEcpayInpay

Field	Type	Label	Description
pay_token	string

PaymentParamsOfHappypay

Field	Type	Label	Description
creditcard_id	string

PaymentParamsOfJkopayAuthPay

Field	Type	Label	Description
auth_no	string	optional
creditcard_id	string	optional

PaymentParamsOfTapPay

Field	Type	Label	Description
creditcard_id	string
prime_token	string
remember_card	bool
creditcard_holder	string
creditcard_phone	string

PurchaseDiamondReq

Field	Type	Description
access_token	string
diamond_package_id	int64
redirect_url	string
ga4_client_id	string	for ga4
ga4_page_title	string
ga4_page_path	string
ga4_session_id	string

PurchaseRecord

Field	Type	Label	Description
trade_id	string
product_name	string
received_amount	int64
currency	Currency
completed_at	google.protobuf.Timestamp
received_jpoint	int64
application_name	string

QueryTransactionReq

Field	Type	Description
app_id	string
transc_id	string	trade_id
check_code	string

QueryTransactionRes

Field	Type	Description
transc_id	string
order_id	string
product_name	string
currency	Currency
price	int64	總價
received_amount	int64	實收金額
received_jpoint	int64	實收 JPoints
created_at	google.protobuf.Timestamp
completed_at	google.protobuf.Timestamp
status	TransactionStatus
pay_at	google.protobuf.Timestamp

RefundTransactionReq

Field	Type	Description
app_id	string
transc_id	string	trade_id
check_code	string
refund_fee	double	退款金額
refund_reason	string	退款原因

RefundTransactionRes

Field	Type	Label	Description
status	RefundTransactionStatus

SetPaymentMethodReq

Field	Type	Label	Description
payment_method_id	string
transaction_token	string

SetPaymentMethodRes

SetTransactionInvoiceReq

Field	Type	Description
transaction_token	string
invoice_type	InvoiceType
invoice_data	string
reference_trade_id	string	optional, 可以將此筆訂設定為某筆訂單的開發票方式

SetTransactionInvoiceRes

SubscriptionInfo

Field	Type	Label	Description
period	SubscriptionPeriod.Code
period_interval	int32

SubscriptionPeriod

TotalDepositAmountsReq

Field	Type	Label	Description
access_token	string

TotalDepositAmountsRes

Field	Type	Label	Description
twd	int64
diamond_amount	int64

TransactionTokenInfoReq

Field	Type	Label	Description
transaction_token	string

TransactionTokenInfoRes

Field	Type	Label	Description
product_name	string
money	Money
jpoint_discount	int64
jpoint_description	string
platform	string
required_apea_twid	bool
payment_selection_expired_at	google.protobuf.Timestamp		付款選擇過期時間
payment_process_expired_at	google.protobuf.Timestamp		付款處理過期時間
selected_payment_method_id	string	optional	使用者已選擇的付款方式
selected_invoice_setting	InvoiceSetting	optional	使用者已選擇的發票設定
transasction_status	TranscStatus		目前訂單狀態
subscription_info	SubscriptionInfo	optional	產品端設定的訂閱資訊
transaction_verbose_status	TranscStatus		訂單詳細狀態，包含付款錯誤時的狀態
transaction_failed_message	string	optional	訂單錯誤訊息

UseBonusDiamondReq

UseBonusDiamondReq 使用超值方案鑽石的請求參數

Field	Type	Label	Description
access_token	string		access_token - 用戶存取 token

UseBonusDiamondRes

UseBonusDiamondRes 使用超值方案鑽石的回應結果

Field	Type	Description
diamond_amount	int64	diamond_amount - 使用後的鑽石總餘額
available_amount	int64	available_amount - 目前可用的超值方案鑽石數量
free_diamond_amount	int64	free_diamond_amount - 此次實際使用的鑽石數量

WSMessage

Field	Type	Label	Description
type	WSMessageType
message	string
to_object_id	string

CreditCard.Status.Value

Name	Number	Description
None	0
Temporary	1

Currency

Name	Number	Description
None	0
TWD	1
USD	2
DIAMOND	3
USDCENTS	4

DiamondPackageType

Name	Number	Description
DPT_ONCE	0
DPT_DAILY	1
DPT_MONTHLY	2
DPT_LIFETIME	3
DPT_ALL	999

DiamondRecordType

DiamondRecordType 鑽石異動紀錄類型定義

Name	Number	Description
DRT_ALL	0	DRT_ALL - 全部異動紀錄
DRT_CREATE	1	DRT_CREATE - 鑽石增加紀錄（購買、贈送等）
DRT_PAYMENT	2	DRT_PAYMENT - 鑽石扣除紀錄（消費、付款等）

ErrBase

Name	Number	Description
ErrBaseNone	0
ErrTokenExpired	1001
ErrTokenInvalid	1002

ErrCTCode

Name	Number	Description
ErrCTCNotSet	0
ErrCTCCardExpired	11001	the creditcard is expired
ErrCTCPaymentFailed	11002	failed to pay via the gateway
ErrCTCCardInfoIncorrect	11003	the creditcard number does not exist
ErrCTCCardInsufficientBalance	11004	the balance of the creditcard is insufficient
ErrCTCCardBankDeclined	11005	the creditcard was declined by the bank, please contact the bank
ErrCTCRetryLater	11006	please retry the payment later
ErrCTCCardExistsWithToken	11007	the creditcard has been bound with the user with the card token
ErrCTCCard3DFailed	11008	the creditcard did not pass 3D verification
ErrCTCContactTicketCenter	11009	please contact our customer service or submit a ticket

InvoiceStatus

Name	Number	Description
Invoice	0
Receipt	1
ReceiptPdf	2

InvoiceType

Name	Number	Description
NotSet	0
Email	1
Phone	2
ID	3
Donate	4
Pdf	5

PaymentChannel

Name	Number	Description
Creditcard	0	通用-信用卡-串接模式
Diamond	3	鑽石購買
ECPAY_INPAY	4	綠界-INPAY
ATM	5	ATM
CVS	6	便利商店
HAPPYPAY_OVERSEAS	7	HappyPay-信用卡-串接模式
CreditcardTapPay	8	TapPay-信用卡-串接模式
NOT_SET	9
Jpoint	10	JPoints 全額折抵
Cash	11	現金
JkopayOnlinePay	12	街口支付-線上支付
JkopayAuthorizedPaymentRegular	13	街口支付-定期定額
JkopayAuthorizedPaymentLimited	14	街口支付-不定期不定額

PaymentCode.CvsInfo.CvsType

Name	Number	Description
NONE	0
FAMILY	1	全家超商
OKC	2	OK 超商
SEVEN	3	7-11
HILIFE	4	萊爾富超商

PaymentCode.DisplayInfoUrl.Method

Name	Number	Description
NONE	0
POST	1
GET	2

PaymentType

Name	Number	Description
Domestic_Type	0
Foreign_Type	1
Diamond_Type	2
ATM_Type	3
CSV_Type	4
NOT_SET_Type	5
Jpoint_Type	6
Cash_Type	7
Jkopay_Type	8
Jkopay_Authpay_Type	9

RefundTransactionStatus

Name	Number	Description
RTS_FAILED	0	取消訂單失敗
RTS_REFUNDED_WITHOUT_WITHDRAWAL	1	取消訂單成功，金流未退款
RTS_REFUNDED	2	取消訂單成功，金流已退款

SubscriptionPeriod.Code

Name	Number	Description
NONE	0
MONTHLY	1
YEARLY	2
DAY	3

TransactionStatus

Name	Number	Description
TS_NOTSET	0	狀態異常
TS_REFUNDED	1	已退款
TS_FAILED	2	訂單失敗, 逾期未付
TS_CREATED	3	尚未付款
TS_SUCCEEDED	4	訂單成功
TS_REFUNDED_WITHOUT_WITHDRAWAL	5	訂單已取消，金流未退款

TranscStatus

Name	Number	Description
TranscStatus_Created	0	訂單已建立
TranscStatus_Succeeded	1	訂單完成
TranscStatus_CallbackCompleted	2	訂單完成且回調完成
TranscStatus_InvoiceCompleted	3	訂單已開立發票
TranscStatus_SetPayment	4	訂單已設定付款方式
TranscStatus_SetPaymentCompleted	5	訂單已設定付款方式且回調完成
TranscStatus_Failed	-1	訂單失敗
TranscStatus_FailedCallbackCompleted	-2	訂單失敗且回調完成
TranscStatus_Refund	-3	訂單已退款
TranscStatus_RefundWithoutWithdrawal	-5	訂單已申請退款
TranscStatus_Overdue	-4	金流逾期未處理
TranscStatus_OverdueCallbackCompleted	-6	金流逾期未處理且完成回調
TranscStatus_PaymentNotSetOverdue	-7	訂單逾期未處理
TranscStatus_PaymentNotSetOverdueCallbackCompleted	-8	訂單逾期未處理且完成回調

WSMessageType

Name	Number	Description
WST_DIAMONDCHANGE	0
WST_ANNOUNCEMENT	1

TransactionService

Method Name	Request Type	Response Type	Description
CreateTransactionToken	CreateTransactionTokenReq	CreateTransactionTokenRes	後端呼叫生成一個可以付款的 transaction token
GetTransactionToken	GetTransactionTokenReq	GetTransactionTokenRes	使用trade_id 產生 transaction token
QueryTransaction	QueryTransactionReq	QueryTransactionRes	查詢訂單狀態
RefundTransaction	RefundTransactionReq	RefundTransactionRes	訂單退款
TransactionTokenInfo	TransactionTokenInfoReq	TransactionTokenInfoRes	取得交易資訊
DiscountTransaction	DiscountTransactionReq	DiscountTransactionRes	用戶使用jpoint 折抵
GetPaymentInfo	GetPaymentInfoReq	GetPaymentInfoRes	取得 transaction token 的付款資訊
SetPaymentMethod	SetPaymentMethodReq	SetPaymentMethodRes	設定訂單付費方式，前端於付費FORM POST前呼叫，記錄訂單付費方式，若在金流端發生異常沒有返回，要查單時才知去哪家金流查
CompleteTransaction	CompleteTransactionReq	CompleteTransactionRes	完成 transaction token 付款
SetTransactionInvoice	SetTransactionInvoiceReq	SetTransactionInvoiceRes	設定訂單的發票資訊
GetPurchaseRecord	GetPurchaseRecordReq	GetPurchaseRecordRes	取得購買紀錄
GetExchangeRate	GetExchangeRateReq	GetExchangeRateRes	other
GetDiamondAmount	GetDiamondAmountReq	GetDiamondAmountRes	jkf red diamond 以下api移到donate/diamond.proto 取得鑽石數量
PurchaseDiamond	PurchaseDiamondReq	CreateTransactionTokenRes	購買鑽石
GetDiamondPackages	GetDiamondPackagesReq	GetDiamondPackagesRes	取得可以購買的鑽石方案
GetFreeDiamondAmount	GetFreeDiamondAmountReq	GetFreeDiamondAmountRes	取得超值方案總量
CheckFreeDiamond	CheckFreeDiamondReq	CheckFreeDiamondRes	查詢/領取免費鑽石
GetBonusAmount	GetBonusAmountReq	GetBonusAmountRes	取得超值方案總量
UseBonusDiamond	UseBonusDiamondReq	UseBonusDiamondRes	使用超值方案
GetFreeDiamondEarnTimes	GetFreeDiamondEarnTimesReq	GetFreeDiamondEarnTimesRes	取得免費鑽石獲得次數
GetDiamondRecord	GetDiamondRecordReq	GetDiamondRecordRes	取得鑽石異動紀錄
TotalDepositAmounts	TotalDepositAmountsReq	TotalDepositAmountsRes	取得儲值鑽石總額

****************************************** |

model/data_config.proto

model/model.proto

AdminAppPsg

group by app_id, type

Field	Type	Label	Description
id	int64
app_id	string
psg_id	string
psg_method_id	string
type	transaction.PaymentType
status	PsgMethodStatus
priority	int64

Ga4Parameter

Ga4Parameter : Ga4參數

Field	Type	Label	Description
ga4_client_id	string
ga4_page_title	string
ga4_page_path	string
ga4_session_id	string
ga4_engagement_time_msec	string

Psg

Field	Type	Label	Description
id	string
name	string
provider	string
merchant_id	string
data_config	string
status	int64
invoice_status	int64
create_at	google.protobuf.Timestamp

PsgMethod

Field	Type	Description
id	string
name	string
psg	Psg
channel	transaction.PaymentChannel
type	transaction.PaymentType	oneof data_config
status	PsgMethodStatus

PsgMethodStatus

Name	Number	Description
Close	0
Open	1

activity/activity.proto

AchievementItem

Field	Type	Label	Description
item_id	int64
name	string
item_type	string
img_url	string
completed	bool

Activity

ActivityData

Field	Type	Description
activity_id	int64
name	string
icon_link	string	此欄位會先回傳空值
activity_link_url	string
start_at	google.protobuf.Timestamp
end_at	google.protobuf.Timestamp

ActivityIDRes

Field	Type	Label	Description
activity_id	int64

ActivityInfo

struct

Field	Type	Label	Description
gift_name	string
gift_image_url	string
amount	int64
lady_rank	string
top_fan_name	string
top_fan_avatar	string
activity_link_url	string
activity_type	int64
start_at	google.protobuf.Timestamp
end_at	google.protobuf.Timestamp

ActivityInfoRes

Field	Type	Label
activity_id	int64
name	string
free_item	Item
paid_item	Item
gift	GiftItem	repeated
start_at	google.protobuf.Timestamp
end_at	google.protobuf.Timestamp
main_type	Activity.MainType
use_level_title	bool
use_level_color	bool
lady_level_type	Activity.LadyLevelType

ActivityPackage

Field	Type	Description
name	string
diamond_price	int64
img_url	string
package_id	int64
description	string
can_buy	bool
cooldown_seconds	int64	-1 為不用倒數
type	ActivityPackage.ActivityPackageType

ActivityTopLady

struct

Field	Type	Label	Description
name	string
avatar	string
points	int64
top_fan_name	string
uid	int64

BackpackItem

Field	Type	Label	Description
item_id	int64
name	string
img_url	string
target_mode	int64
amount	int64
jkfuid	int64

BackpackTargetItem

Field	Type	Label	Description
item_id	int64
name	string
item_type	string
img_url	string
amount	int64
target_id	int64
target_title	string
jkfuid	int64

BannerInfo

struct

Field	Type	Label	Description
name	string
image_url	string
link_url	string

BuyPackageReq

Field	Type	Description
access_token	string
package_id	int64
ga4_client_id	string	Deprecated.
ga4_page_title	string	Deprecated.
ga4_page_path	string	Deprecated.
ga4_session_id	string	Deprecated.
ga4_parameter	model.Ga4Parameter

EmptyReq

EmptyRes

EquipItemReq

Field	Type	Label	Description
access_token	string
item_id	int64

EquipItemV2Req

Field	Type	Label	Description
access_token	string
item_id	int64
target_id	int64

Fan

Field	Type	Label	Description
object_id	string
points	int64

FanDetail

Field	Type	Label	Description
name	string
points	int64
avatar	string

GetActivityBannerListReq

Field	Type	Label	Description
activity_id	int64

GetActivityBannerListRes

Field	Type	Label	Description
banner_info	BannerInfo	repeated

GetActivityItemAmountReq

Field	Type	Description
access_token	string	女郎token
uuid	int64	女郎uuid
activity_id	int64	活動編號

GetActivityItemAmountRes

Field	Type	Label	Description
activity_item_amounts	LadyActivityItemAmount	repeated

GetActivityListByLadyReq

Field	Type	Label	Description
object_id	string		女郎 object_id(uuid)
uid	int64		女郎 uid

GetActivityListByLadyRes

Field	Type	Label	Description
data	ActivityData	repeated

GetActivityListReq

Field	Type	Label	Description
object_id	string		女郎 object_id(uuid)
uid	int64		女郎 uid

GetActivityListRes

Field	Type	Label	Description
info	ActivityInfo	repeated

GetActivitySpecialTopFansReq

GetActivitySpecialTopFansRes

Field	Type	Label	Description
fans	FanDetail	repeated

GetActivityTopFansReq

Field	Type	Label	Description
activity_id	int64
item_id	ActivityItemId		optional

GetActivityTopFansRes

Field	Type	Label	Description
fans	FanDetail	repeated

GetActivityTopLadyReq

Field	Type	Label	Description
activity_id	int64

GetActivityTopLadyRes

Field	Type	Label	Description
ladies	ActivityTopLady	repeated

GetInfoByIDReq

Field	Type	Label	Description
activity_id	int64

GetItemInfoReq

Field	Type	Label	Description
access_token	string
activity_id	int64

GetLadyActivityBonusThresholdReq

Field	Type	Label	Description
access_token	string		女郎 token
activity_id	int64		活動編號

GetLadyActivityBonusThresholdRes

Field	Type	Label	Description
Current	int64
Reward	int64
Next	int64

GetLadyActivityReq

Field	Type	Label	Description
object_id	string		女郎 UUID
activity_id	int64		活動編號

GetLadyActivityRes

Field	Type	Label	Description
current_level	int64
current_point	int64
next_level_point	int64
max_level	int64
main_part	LadyActivityPart
part1	LadyActivityPart
part2	LadyActivityPart
part3	LadyActivityPart
part4	LadyActivityPart
part5	LadyActivityPart

GetLadyActivityV2Res

Field	Type	Label	Description
lady	LevelInfo
targets	TargetLevelInfo	repeated
lady_rank	RankInfo
max_level	int64
main	TargetActivityPart	repeated	repeated TargetActivityPart sub = 12;

GetLadyTopFansReq

Field	Type	Label	Description
object_id	string
activity_id	int64

GetLadyTopFansRes

Field	Type	Label	Description
fans	Fan	repeated

GetMainGiftReq

Field	Type	Label	Description
activity_id	int64

GetMainGiftRes

Field	Type	Label	Description
gift_url	string
gift_name	string

GetMemberRankReq

Field	Type	Label	Description
access_token	string
activity_id	int64

GetMemberRankRes

Field	Type	Label	Description
user_rank	int64
avatar	string

GetMyBackpackItemListReq

Field	Type	Label	Description
access_token	string
activity_id	int64

GetMyBackpackItemListRes

Field	Type	Label
my_items	BackpackItem	repeated
equipable_items	BackpackItem	repeated
achievement_items	AchievementItem	repeated

GetMyBackpackItemListV2Res

Field	Type	Label
my_items	BackpackItem	repeated
equipable_items	BackpackTargetItem	repeated
achievement_items	AchievementItem	repeated

GetNotificationReq

Field	Type	Label	Description
access_token	string

GetNotificationRes

Field	Type	Label	Description
message	string
img_url	string
notify_at	google.protobuf.Timestamp
title	string
unread_count	int64
amount	int64

GetPackageInfoReq

Field	Type	Label	Description
activity_id	int64
accessToken	string

GetPackageInfoRes

Field	Type	Label	Description
packages	ActivityPackage	repeated

GetProgressOfBonusSkinReq

Field	Type	Label	Description
access_token	string
activity_id	int64

GetProgressOfBonusSkinRes

Field	Type	Label	Description
progresses	ProgressOfBonusSkin	repeated

GetSpecialMemberRankReq

Field	Type	Label	Description
access_token	string

GetSpecialMemberRankRes

Field	Type	Label	Description
user_rank	int64
avatar	string

GiftInfo

Field	Type	Label	Description
name	string
amount	int64
image_url	string

GiftItem

Field	Type	Label	Description
item_id	int64
gift_id	int64
item	Item

Item

Field	Type	Label	Description
name	string
img_url	string
point_type	Item.PointType
target_mode	Item.TargetMode

ItemActivityPart

Field	Type	Label	Description
item_id	int64
name	string
item_type	string
skin_name	string
amount	int64

LadyActivityItemAmount

Field	Type	Label	Description
activity_id	int64
activity_name	string
activity_type	ActivityType
gift	GiftInfo	repeated	禮物列表
start_at	google.protobuf.Timestamp
end_at	google.protobuf.Timestamp

LadyActivityPart

Field	Type	Label	Description
skin_name	string
amount	int64

LadyReceivedRecord

Field	Type	Label	Description
fan_object_id	string
item_type	string
item_name	string
amount	int64
img_url	string
received_at	google.protobuf.Timestamp

LadyReceivedRecordsReq

Field	Type	Label	Description
activity_id	int64
lady_object_id	string
received_before	google.protobuf.Timestamp
limit	int64

LadyReceivedRecordsRes

Field	Type	Label	Description
records	LadyReceivedRecord	repeated

LevelInfo

Field	Type	Label	Description
current_level	int64
current_point	int64
next_level_point	int64
decorations	string	repeated	only equipped Place title skin_name or color code

MyFreeItemRes

Field	Type	Description
amount	int64
next_cooldown_seconds	int64	下個獲得道具的時間, 如果已經滿的話則回傳 -1
receive_point	int64	本次獲得的隨機點數

MyPaidItemRes

Field	Type	Label	Description
amount	int64

ProgressOfBonusSkin

Field	Type	Description
item_id	int64
current_amount	int64
threshold_amount	int64	if can't receive bonus return -1

RankInfo

Field	Type	Label	Description
point	int64		總積分
level	int64		積分排行榜名次

RedeemCodeReq

Field	Type	Label	Description
access_token	string
code	string

SendItemReq

Field	Type	Label	Description
access_token	string
item_id	int64
object_id	string
amount	int64
ga4_client_id	string

SendItemRes

Field	Type	Label	Description
amount	int64
receive_point	int64		本次獲得的隨機點數

SendItemV2Req

Field	Type	Label	Description
access_token	string
item_id	int64
object_id	string
amount	int64
target_id	int64

TargetActivityPart

Only equipped

Field	Type	Label
target_id	int64
target_name	string
items	ItemActivityPart	repeated

TargetLevelInfo

Field	Type	Label	Description
target_id	int64
target_name	string
level_info	LevelInfo

TransactionRes

Field	Type	Label	Description
transaction_token	string

UseItemReq

Field	Type	Label	Description
access_token	string
activity_id	int64
object_id	string
amount	int64

UseItemV2Req

Field	Type	Label	Description
access_token	string
activity_id	int64
object_id	string
amount	int64
target_id	int64

UsePaidItemRes

Field	Type	Label	Description
amount	int64
receive_point	int64		本次獲得的隨機點數

Activity.LadyLevelType

Name	Number	Description
ItemLog	0
TargetsMin	1

Activity.MainType

Name	Number	Description
DecorateLayout	0
BetGame	1
EducationDolls	2

ActivityItemId

Name	Number	Description
AII_ALL	0
AII_BET_AMOUNT	21
AII_PAYOUT	22

ActivityPackage.ActivityPackageType

Name	Number	Description
Normal	0
Limited	1

ActivityType

Name	Number	Description
DEFAULT	0
FACE	1
LIVE	2

Item.PointType

Name	Number	Description
Static	0
BetRecord	1
Random	2

Item.TargetMode

Name	Number	Description
NoOne	0
SingleOne	1
ShareByRate	2

RedeemCodeReq.RedeemErr

Name	Number	Description
NotErr	0
TryLater	1001
Redeemed	1002
NotExist	1003

ActivityService

Method Name	Request Type	Response Type	Description
GetCurrent	EmptyReq	ActivityIDRes	活動取得現在進行中的活動資訊 ( status = 1 )
GetFeedsCurrent	EmptyReq	ActivityIDRes
GetInfoByID	GetInfoByIDReq	ActivityInfoRes	取得活動資訊 ( status = 1 )
GetLadyActivity	GetLadyActivityReq	GetLadyActivityRes	女郎活動裝飾列表： [OLD] decorate_layout ( main + part 1 ~ 4，範例：聖誕樹 ) [OLD] bet_game ( 範例：拉霸機 )
GetLadyActivityV2	GetLadyActivityReq	GetLadyActivityV2Res	k = count( activity_target ) n = count( activity_item, item_type = skin, position = main ) m = count( activity_item, item_type = skin, position = part ) o = ( activity use_point_level ) && count( activity_item, item_type = title, position = title ) [NEW] education_dolls ( main[k][n] + part[k][m] + title[o]，範例：美蛇雙姬 )
GetLadyReceivedRecords	LadyReceivedRecordsReq	LadyReceivedRecordsRes	取得某女郎的接受道具記錄
GetLadyTopFans	GetLadyTopFansReq	GetLadyTopFansRes	取得某個女郎的前十大粉絲
GetMyFreeItem	GetItemInfoReq	MyFreeItemRes	道具取得免費活動道具資訊
UseFreeItem	UseItemReq	MyFreeItemRes	使用免費活動道具
UseFreeItemV2	UseItemV2Req	MyFreeItemRes
GetMyPaidItem	GetItemInfoReq	MyPaidItemRes	取得付費活動道具資訊
UsePaidItem	UseItemReq	UsePaidItemRes	使用付費活動道具
UsePaidItemV2	UseItemV2Req	UsePaidItemRes
SendItem	SendItemReq	SendItemRes	使用道具
SendItemV2	SendItemV2Req	SendItemRes
EquipItem	EquipItemReq	EmptyRes	女郎裝備道具
EquipItemV2	EquipItemV2Req	EmptyRes
GetMyBackpackItemList	GetMyBackpackItemListReq	GetMyBackpackItemListRes	我的背包 - 道具列表
GetMyBackpackItemListV2	GetMyBackpackItemListReq	GetMyBackpackItemListV2Res
RedeemCode	RedeemCodeReq	EmptyRes	兌換碼換造型
GetPackageInfo	GetPackageInfoReq	GetPackageInfoRes	訂單取得付費道具購買資訊
BuyPackage	BuyPackageReq	TransactionRes	購買付費道具
GetNotification	GetNotificationReq	GetNotificationRes	獲得免費道具事件(like unread )
GetProgressOfBonusSkin	GetProgressOfBonusSkinReq	GetProgressOfBonusSkinRes	差多少可以獲得的skin
GetActivityTopFans	GetActivityTopFansReq	GetActivityTopFansRes	LandingPage 找尋排名前10的粉絲
GetActivityTopLady	GetActivityTopLadyReq	GetActivityTopLadyRes	找尋排名前N的女郎
GetLadyActivityBonusThreshold	GetLadyActivityBonusThresholdReq	GetLadyActivityBonusThresholdRes	取得女郎活動額外獎勵資訊
GetActivityList	GetActivityListReq	GetActivityListRes	取得活動資訊清單
GetActivityBannerList	GetActivityBannerListReq	GetActivityBannerListRes	取得活動banner清單
GetActivityItemAmount	GetActivityItemAmountReq	GetActivityItemAmountRes	取得活動當中禮物收集數量
GetActivityListByLady	GetActivityListByLadyReq	GetActivityListByLadyRes	GetActivityListByLady : 取得女郎參加的活動列表，由新到舊排序
GetMainGift	GetMainGiftReq	GetMainGiftRes	GetMainGift 取得活動主要禮物
GetMemberRank	GetMemberRankReq	GetMemberRankRes	GetMemberRank 取得會員活動名次
GetActivitySpecialTopFans	GetActivitySpecialTopFansReq	GetActivitySpecialTopFansRes	特規騎士榜 GetActivitySpecialTopFans 取得粉絲排名
GetSpecialMemberRank	GetSpecialMemberRankReq	GetSpecialMemberRankRes	GetMemberRank 取得會員活動名次

activity_game/activity_game.proto

GameRecord

Field	Type	Description
lady_uuid	string	女郎 uuid string 36
user_id	string	uuid account string
bet_id	string	注單編號 string
bet_amount	int64	注單金額
payout	int64	派彩金額
win_loss	int64	輸贏

GetGameRecordsReq

Field	Type	Label	Description
game_id	string
min_id	int64
limit	int64

GetGameRecordsRes

Field	Type	Label	Description
game_records	GameRecord	repeated
max_id	int64

ActivityGameService

Method Name	Request Type	Response Type	Description
GetGameRecords	GetGameRecordsReq	GetGameRecordsRes	取得押注記錄 ACTIVITY後端呼叫

donate-enums/enum.proto

ConsumeSourceType

ConsumeSourceType：商品分類

Name	Number	Description
CONSUME_SOURCE_TYPE_UNSPECIFIED	0
CONSUME_SOURCE_TYPE_GIFT	1	donate 禮物
CONSUME_SOURCE_TYPE_DIAMOND_PACKAGE	2	donate 紅鑽禮包
CONSUME_SOURCE_TYPE_ACTIVITY_PACKAGE	3	donate 遊戲機禮包
CONSUME_SOURCE_TYPE_TICKET	4	board 預約門票
CONSUME_SOURCE_TYPE_CARD	5	board 紀念卡
CONSUME_SOURCE_TYPE_FREE_DIAMOND	6	donate 免費鑽石
CONSUME_SOURCE_TYPE_COIN_PACKAGE	7	donate Face券禮包
CONSUME_SOURCE_TYPE_COIN	8	donate Face券
CONSUME_SOURCE_TYPE_DIAMOND_FEE	9	退紅鑽手續費
CONSUME_SOURCE_TYPE_TICKET_FEE	10	退門票手續費

CurrencyType

CurrencyType：幣別分類

Name	Number	Description
CURRENCY_TYPE_UNSPECIFIED	0
CURRENCY_TYPE_TWD	1
CURRENCY_TYPE_DIAMOND	2
CURRENCY_TYPE_COIN	3

OrderStatus

OrderStatus : 訂單狀態

Name	Number	Description
ORDER_STATUS_CREATED	0
ORDER_STATUS_COMPLETED	1
ORDER_STATUS_FAILED	-1
ORDER_STATUS_REFUND	-2

ProfitType

ProfitType : 分潤類別

Name	Number	Description
PROFIT_TYPE_UNSPECIFIED	0
PROFIT_TYPE_SIX	1
PROFIT_TYPE_SEVEN	2

RechargePackageType

RechargePackageType：鑽石/Face券禮包分類

Name	Number	Description
RPT_DIAMOND_ONCE	0
RPT_DIAMOND_DAILY	1
RPT_DIAMOND_MONTHLY	2
RPT_DIAMOND_LIFETIME	3
RPT_COIN_ONCE	4
RPT_COIN_LIFETIME	5
RPT_ALL	999

TradeStatus

TradeStatus：訂單狀態

Name	Number	Description
TRADE_STATUS_UNSPECIFIED	0
TRADE_STATUS_REFUND	-2	已退單
TRADE_STATUS_FAILED	-1	交易失敗
TRADE_STATUS_CREATE_ORDER	1	創立訂單
TRADE_STATUS_ADD_AMOUNT_SUCCESS	2	儲值成功
TRADE_STATUS_SUB_AMOUNT_SUCCESS	3	交易完成

donate-direct/diamond.proto

ConsumeDiamondReq

Field	Type	Label	Description
token	string
member_object_id	string
transc_id	string
diamond_amount	int64
product_name	string
source	donateenums.ConsumeSourceType
is_voucher	bool
voucher_id	int64
platform	string
amount	int64
source_id	int64

ConsumeDiamondRes

RefundDiamondReq

Field	Type	Description
token	string
transc_id	string
diamond_amount	int64
source	donateenums.ConsumeSourceType
memo	string
need_refund_fee	bool	抽手續費，舉例: 商品100元要抽10%手續費的話需要退款的總額為90

RefundDiamondRes

DiamondDirectService

Method Name	Request Type	Response Type	Description
ConsumeDiamond	ConsumeDiamondReq	ConsumeDiamondRes	消費鑽石
RefundDiamond	RefundDiamondReq	RefundDiamondRes	退鑽石

donate/coin.proto

CoinPackage

Field	Type	Label	Description
id	int64
name	string
usd	double
twd	int64
amount	int64
can_buy	bool
type	donateenums.RechargePackageType
ribbon_url	string
description	string

GetCoinAmountReq

Field	Type	Label	Description
access_token	string

GetCoinAmountRes

Field	Type	Label	Description
amount	int64

GetCoinPackagesReq

Field	Type	Label	Description
access_token	string

GetCoinPackagesRes

Field	Type	Label	Description
packages	CoinPackage	repeated

PurchaseCoinReq

Field	Type	Label	Description
access_token	string
package_id	int64
redirect_url	string
ga4_client_id	string
ga4_page_title	string
ga4_page_path	string
ga4_session_id	string

PurchaseCoinRes

Field	Type	Label	Description
transaction_token	string
transaction_id	string

CoinService

Method Name	Request Type	Response Type	Description
GetCoinAmount	GetCoinAmountReq	GetCoinAmountRes	取得Face券數量
GetCoinPackages	GetCoinPackagesReq	GetCoinPackagesRes	取得可以購買的Face券方案 [已搬移到face]
PurchaseCoin	PurchaseCoinReq	PurchaseCoinRes	購買Face券 [已搬移到face]

donate/diamond.proto

CheckFreeDiamondReq

Field	Type	Label	Description
access_token	string
get_it_right_now	bool		false -> 單純查, true -> 我要領

CheckFreeDiamondRes

Field	Type	Description
diamond_amount	int64	餘額
cooldown_seconds	int64	-1 為不用倒數
free_diamond_amount	int64	此次領取到的數量

DiamondPackage

Field	Type	Description
id	int64
name	string
usd	double
twd	int64
diamond_amount	int64
img	string
description	string
can_buy	bool
type	DiamondPackageType	棄用
ribbon_url	string
bonus_amount	int64	bonus期間才會有數值 (bonus_start_at, bonus_end_at)
package_type	donateenums.RechargePackageType

DiamondRecord

Field	Type	Label	Description
trade_id	string
product_name	string
amount_before	int64
amount_after	int64
created_at	google.protobuf.Timestamp
memo	string

GetBonusAmountReq

Field	Type	Label	Description
access_token	string

GetBonusAmountRes

Field	Type	Label	Description
amount	int64		可用數量

GetDiamondAmountReq

Field	Type	Label	Description
access_token	string

GetDiamondAmountRes

Field	Type	Label	Description
diamond_amount	int64

GetDiamondPackagesReq

Field	Type	Description
filter_type	DiamondPackageType	棄用
access_token	string
package_type	donateenums.RechargePackageType

GetDiamondPackagesRes

Field	Type	Label	Description
packages	DiamondPackage	repeated

GetDiamondRecordReq

Field	Type	Label	Description
access_token	string
page	int64
limit	int64
start_at	google.protobuf.Timestamp
end_at	google.protobuf.Timestamp
type	DiamondRecordType

GetDiamondRecordRes

Field	Type	Label	Description
records	DiamondRecord	repeated
total	int64

GetFreeDiamondAmountReq

Field	Type	Label	Description
access_token	string

GetFreeDiamondAmountRes

Field	Type	Label	Description
amount	int64		可用數量

GetFreeDiamondEarnTimesReq

Field	Type	Label	Description
access_token	string

GetFreeDiamondEarnTimesRes

Field	Type	Label	Description
earn_times	int64		獲得次數

PurchaseDiamondReq

Field	Type	Label	Description
access_token	string
diamond_package_id	int64
redirect_url	string
ga4_client_id	string
ga4_page_title	string
ga4_page_path	string
ga4_session_id	string

PurchaseDiamondRes

Field	Type	Label	Description
transaction_token	string
transaction_id	string

UseBonusDiamondReq

Field	Type	Label	Description
access_token	string

UseBonusDiamondRes

Field	Type	Description
diamond_amount	int64	餘額
available_amount	int64	可用數量
free_diamond_amount	int64	此次領取到的數量

DiamondPackageType

棄用

Name	Number	Description
DPT_ONCE	0
DPT_DAILY	1
DPT_MONTHLY	2
DPT_LIFETIME	3
DPT_ALL	999

DiamondRecordType

Name	Number	Description
DRT_ALL	0
DRT_CREATE	1
DRT_PAYMENT	2

DiamondService

Method Name	Request Type	Response Type	Description
GetDiamondAmount	GetDiamondAmountReq	GetDiamondAmountRes	取得鑽石數量
PurchaseDiamond	PurchaseDiamondReq	PurchaseDiamondRes	購買鑽石 [已搬移到face]
GetDiamondPackages	GetDiamondPackagesReq	GetDiamondPackagesRes	取得可以購買的鑽石方案 [已搬移到face]
CheckFreeDiamond	CheckFreeDiamondReq	CheckFreeDiamondRes	查詢/領取免費鑽石
GetBonusAmount	GetBonusAmountReq	GetBonusAmountRes	取得超值方案總量
UseBonusDiamond	UseBonusDiamondReq	UseBonusDiamondRes	使用超值方案
GetFreeDiamondEarnTimes	GetFreeDiamondEarnTimesReq	GetFreeDiamondEarnTimesRes	取得免費鑽石獲得次數
GetFreeDiamondAmount	GetFreeDiamondAmountReq	GetFreeDiamondAmountRes	取得超值方案總量
GetDiamondRecord	GetDiamondRecordReq	GetDiamondRecordRes	取得鑽石異動紀錄

donate/donate.proto

BadgeInfos

Field	Type	Label	Description
title	string
icon	string
link	string
order	int64
achieve_at	google.protobuf.Timestamp

BuyGiftReq

Field	Type	Description
access_token	string
gift_id	int64
message	string
to_object_id	string
amount	int64
ga4_client_id	string	Deprecated.
ga4_page_title	string	Deprecated.
ga4_page_path	string	Deprecated.
ga4_session_id	string	Deprecated.
ga4_parameter	model.Ga4Parameter

BuyGiftRes

Field	Type	Label	Description
transaction_token	string
order_id	string

DonateRecord

Field	Type	Label	Description
order_no	string
product_name	string
product_amount	int64
object_id	string
completed_at	google.protobuf.Timestamp

GetDonateRecordReq

Field	Type	Label	Description
access_token	string
page	int64
limit	int64
start_completed_at	google.protobuf.Timestamp
end_completed_at	google.protobuf.Timestamp
lady_object_id	string

GetDonateRecordRes

Field	Type	Label	Description
records	DonateRecord	repeated
total	int64

GetGiftHistoryReq

Field	Type	Description
access_token	string	optional
object_id	string	取得誰的
year	int64
month	int64
page	int64
limit	int64
time_zone	int64	必填, -12 ~ 12, 錯誤格式回傳 +8 時區資料

GetGiftHistoryRes

Field	Type	Label	Description
gift_history	GiftHistory	repeated
total	int64

GetGiftPackagesReq

Field	Type	Label	Description
star_object_id	string

GetGiftPackagesRes

Field	Type	Label	Description
gift_packages	GiftPackage	repeated

GetMyUnreadGiftReq

Field	Type	Label	Description
access_token	string

GetMyUnreadGiftRes

Field	Type	Label	Description
gift_history	GiftHistory
count	int64

GetRewardDetailInfo

Field	Type	Description
order_no	string	訂單編號
gift_info	GetRewardDetailInfo.GiftInfo	禮物資訊
amount	int64	送禮數量
completed_at	google.protobuf.Timestamp	贊助完成時間
member_info	GetRewardDetailInfo.MemberInfo	會員資訊
usd	double	分潤金額

GetRewardDetailInfo.GiftInfo

Field	Type	Label	Description
name	string		禮物名稱

GetRewardDetailInfo.MemberInfo

Field	Type	Label	Description
object_id	string		會員 object_id

GetRewardDetailV2Req

Field	Type	Description
access_token	string	[必填] token
year	int64	[必填] 資料年份
month	int64	[必填] 資料月份
page	int64	[必填] 分頁頁數
limit	int64	[必填] 分頁筆數
donator	string	donate 用戶姓名
time_zone	int64	[必填], -12 ~ 12, 錯誤格式回傳 +8 時區資料

GetRewardDetailV2Res

Field	Type	Label	Description
reward_detail_data	GetRewardDetailInfo	repeated
total	int64		查詢時間段的總數量

GetRewardHistoryV2Req

Field	Type	Label	Description
access_token	string

GetRewardHistoryV2Res

Field	Type	Description
current_period_amount	double
previous_period_amount	double
unpaid_amount	double
total_amount	double	總收益
gift_scale	GetRewardHistoryV2Res.GiftScale	禮物比例

GetRewardHistoryV2Res.GiftScale

Field	Type	Label	Description
event_gift_percent	int64		應援比例
live_gift_percent	int64		直播比例

GetUserBadgesReq

Field	Type	Label	Description
object_id	string		取得誰的

GetUserBadgesRes

Field	Type	Label	Description
badge_infos	BadgeInfos	repeated

GetUserDetailReq

Field	Type	Label	Description
access_token	string		[必填] token

GetUserDetailRes

Field	Type	Label	Description
diamond_amount	int64
coin_amount	int64
level	int64

GiftHistory

Field	Type	Label	Description
object_id	string
gift_package	GiftPackage
message	string
created_at	google.protobuf.Timestamp
amount	int64

GiftPackage

Field	Type	Label	Description
id	int64
name	string
diamond_price	int64
img	string
animation	string
gift_type	string

DonateService

Method Name	Request Type	Response Type	Description
GetGiftPackages	GetGiftPackagesReq	GetGiftPackagesRes	送禮方案項目
BuyGift	BuyGiftReq	BuyGiftRes	贈送禮物
GetGiftHistory	GetGiftHistoryReq	GetGiftHistoryRes	讀取女郎收到的禮物與留言x
GetMyUnreadGift	GetMyUnreadGiftReq	GetMyUnreadGiftRes	我未讀的禮物
GetUserBadges	GetUserBadgesReq	GetUserBadgesRes	讀取用戶的勳章
GetDonateRecord	GetDonateRecordReq	GetDonateRecordRes	取得應援紀錄
GetRewardHistoryV2	GetRewardHistoryV2Req	GetRewardHistoryV2Res	女郎收益V2 (含總收益，禮物比例)
GetRewardDetailV2	GetRewardDetailV2Req	GetRewardDetailV2Res	女郎收益詳細記錄
GetUserDetail	GetUserDetailReq	GetUserDetailRes	GetUserDetail 紅鑽/Face券/等級

donateadmin/v2/admin.proto

CoinRecord

Field	Type	Label	Description
id	int64
order_no	string
user_object_id	string
user_name	string
scanner_object_id	string
scanner_name	string
amount	int64
status	donateenums.OrderStatus
update_at	google.protobuf.Timestamp

CoinRecordListReq

Field	Type	Description
access_token	string
user_object_id	string	optional
scanner_object_id	string	optional
start_at	google.protobuf.Timestamp	optional
end_at	google.protobuf.Timestamp	optional
page	int64
limit	int64
trade_id	string	optional

CoinRecordListRes

Field	Type	Label	Description
record	CoinRecord	repeated
total	int64

DiamondSubscribe

Field	Type	Label	Description
id	int64
object_id	string
phone	string
diamond_package_name	string
status	SubscribeStatus
invoice_type	string
invoice_data	string
created_at	google.protobuf.Timestamp

GetCoinRecordDetailReq

Field	Type	Label	Description
access_token	string
id	int64

GetCoinRecordDetailRes

Field	Type	Description
id	int64
order_no	string
user_object_id	string
user_name	string
scanner_object_id	string
scanner_name	string
group_name	string
amount	int64
profit	donateenums.ProfitType	分潤類別
status	donateenums.OrderStatus
created_at	google.protobuf.Timestamp
update_at	google.protobuf.Timestamp
receiver_object_id	string	接收者 objectID
receiver_name	string	接收者名稱

GetDiamondSubscribeListReq

Field	Type	Description
access_token	string
page	int64
limit	int64
object_id	string	optional
status	SubscribeStatus	optional
phone	string

GetDiamondSubscribeListRes

Field	Type	Label	Description
subscribes	DiamondSubscribe	repeated
total	int64

GetPersonalDiamondListReq

Field	Type	Description
access_token	string
member_object_id	string	[必填]會員 objectID
source	donateenums.ConsumeSourceType	商品分類
page	int64
limit	int64

GetPersonalDiamondListRes

Field	Type	Label	Description
info	PersonalDiamondInfo	repeated
member_name	string		會員名稱
member_diamond_amount	int64		會員餘額
total	int64

GetRewardItemListReq

Field	Type	Label	Description
secret_key	string
activity_id	int64
start_at	google.protobuf.Timestamp
end_at	google.protobuf.Timestamp
status	int64

GetRewardItemListRes

Field	Type	Label	Description
items	RewardItem	repeated

GetSourceCoinDetailRes

Field	Type	Description
trade_id	string
source	donateenums.ConsumeSourceType	商品分類
product_name	string	商品名稱
amount	int64	數量
member_object_id	string	會員 objectID
scanner_object_id	string	掃描者 objectID
scanner_name	string	掃描者名稱
group_name	string	群組名稱
profit	donateenums.ProfitType	分潤
receiver_object_id	string	接收者 objectID
receiver_name	string	接收者名稱
member_name	string	會員名稱

GetSourceCoinPackageDetailRes

Field	Type	Description
trade_id	string
source	donateenums.ConsumeSourceType	商品分類
product_name	string	商品名稱
member_object_id	string	會員 objectID
twd_amount	int64	台幣支付金額
pay_order_no	string	pay 訂單號
member_name	string	會員名稱

GetSourceDetailReq

Field	Type	Label	Description
access_token	string
trade_id	string		[必填]服務訂單號

GetSourceDiamondPackageDetailRes

Field	Type	Description
trade_id	string
source	donateenums.ConsumeSourceType	商品分類
product_name	string	商品名稱
member_object_id	string	會員 objectID
twd_amount	int64	台幣支付金額
pay_order_no	string	pay 訂單號
member_name	string	會員名稱

GetSourceGiftDetailRes

Field	Type	Description
trade_id	string
source	donateenums.ConsumeSourceType	商品分類
product_name	string	商品名稱
member_object_id	string	會員 objectID
lady_object_id	string	女郎 objectID
lady_name	string	女郎名稱
member_name	string	會員名稱

GetTradeRecordListReq

Field	Type	Description
access_token	string
created_start_at	google.protobuf.Timestamp	建立時間-開始
created_end_at	google.protobuf.Timestamp	建立時間-結束
complete_start_at	google.protobuf.Timestamp	完成時間-開始
complete_end_at	google.protobuf.Timestamp	完成時間-結束
member_object_id	string	會員 objectID
member_phone	string	會員手機號碼
trade_id	string	訂單號碼
status	donateenums.TradeStatus	訂單狀態
source	donateenums.ConsumeSourceType	商品分類
page	int64
limit	int64
currency	donateenums.CurrencyType	幣別
pay_order_no	string	pay的訂單號碼

GetTradeRecordListRes

Field	Type	Label	Description
info	TradeRecordInfo	repeated
total	int64

Gift

Field	Type	Label	Description
id	int64
name	string
price	int64
image	string
start_at	google.protobuf.Timestamp
end_at	google.protobuf.Timestamp
created_at	google.protobuf.Timestamp
updated_at	google.protobuf.Timestamp

GiftOrder

Field	Type	Label	Description
id	int64
transaction_id	string
order_no	string
total_price	int64
status	int64
created_at	google.protobuf.Timestamp
updated_at	google.protobuf.Timestamp

GiftRecord

Field	Type	Description
id	int64
user_object_id	string
lady_object_id	string
gift	Gift
gift_amount	int64
gift_order	GiftOrder
status	int64	0:未完成，1：完成，-1：退款
created_at	google.protobuf.Timestamp

GiftRecordListReq

Field	Type	Description
access_token	string
page	int64
limit	List.Limit
user_object_id	string	optional
lady_object_id	string	optional
start_at	google.protobuf.Timestamp	optional
end_at	google.protobuf.Timestamp	optional

GiftRecordListRes

Field	Type	Label	Description
records	GiftRecord	repeated
total	int64

List

PersonalDiamondInfo

Field	Type	Description
id	int64	ID
trade_id	string	服務訂單號
source	donateenums.ConsumeSourceType	商品分類
before_diamond	int64	紅鑽異動前
after_diamond	int64	紅鑽異動後
diamond_amount	int64	紅鑽異動數
created_at	google.protobuf.Timestamp	建立時間
memo	string	備註

RefundDiamondReq

Field	Type	Label	Description
transc_id	string
order_no	string
sign	string

RefundDiamondRes

RefundReq

Field	Type	Description
access_token	string
trade_id	string	[必填]服務訂單號
source	donateenums.ConsumeSourceType	商品分類
need_refund_fee	bool	抽手續費

RefundRes

RewardItem

Field	Type	Label	Description
id	int64
name	string
price	int64
status	int64

TradeRecordInfo

Field	Type	Description
id	int64	ID
trade_id	string	服務訂單號
source	donateenums.ConsumeSourceType	商品分類
member_object_id	string	會員 objectID
member_name	string	會員名稱
product_name	string	商品名稱
diamond_amount	int64	鑽石數量 // 棄用
status	donateenums.TradeStatus	訂單狀態
created_at	google.protobuf.Timestamp	建立時間
complete_at	google.protobuf.Timestamp	完成時間
currency	donateenums.CurrencyType	幣別
amount	int64	數量
pay_order_no	string	pay的訂單號碼

UnsubscribeDiamondReq

Field	Type	Label	Description
access_token	string
object_id	string
subscribe_id	int64

UnsubscribeDiamondRes

List.Limit

Name	Number	Description
Size_0	0
Size_10	10
Size_25	25
Size_50	50
Size_100	100

SubscribeStatus

Name	Number	Description
SB_Default	0
SB_Unsubscribe	1
SB_Subscribe	2

AdminService

Method Name	Request Type	Response Type	Description
GiftRecordList	GiftRecordListReq	GiftRecordListRes	送禮紀錄
GetDiamondSubscribeList	GetDiamondSubscribeListReq	GetDiamondSubscribeListRes	月卡資訊
UnsubscribeDiamond	UnsubscribeDiamondReq	UnsubscribeDiamondRes	月卡退訂
RefundDiamond	RefundDiamondReq	RefundDiamondRes	RefundDiamond 退鑽沖銷流程
GetRewardItemList	GetRewardItemListReq	GetRewardItemListRes	GetRewardItemList 取得禮物列表
GetTradeRecordList	GetTradeRecordListReq	GetTradeRecordListRes	GetTradeRecordList 取得訂單紀錄
GetPersonalDiamondList	GetPersonalDiamondListReq	GetPersonalDiamondListRes	GetPersonalDiamondList 取得紅鑽個人紀錄
GetSourceGiftDetail	GetSourceDetailReq	GetSourceGiftDetailRes	GetSourceGiftDetail 取得紅鑽禮物詳細資料
GetSourceDiamondPackageDetail	GetSourceDetailReq	GetSourceDiamondPackageDetailRes	GetSourceDiamondPackageDetail 取得紅鑽禮包詳細資料
GetSourceCoinPackageDetail	GetSourceDetailReq	GetSourceCoinPackageDetailRes	GetSourceCoinPackageDetail 取得Face券禮包詳細資料
GetSourceCoinDetail	GetSourceDetailReq	GetSourceCoinDetailRes	GetSourceCoinDetail 取得花費Face券詳細資料
Refund	RefundReq	RefundRes	Refund 退單
CoinRecordList	CoinRecordListReq	CoinRecordListRes	CoinRecordList Face轉移紀錄
GetCoinRecordDetail	GetCoinRecordDetailReq	GetCoinRecordDetailRes	GetCoinRecordDetail Face轉移紀錄詳細資料

jkfpay/transaction_api/transaction_api.proto

ChangeSubscriptionStatusReq

ChangeSubscriptionStatusReq 變更訂閱狀態的請求參數

Field	Type	Description
app_token	string	app_token - 應用程式認證 token
subsc_id	string	subsc_id - 系統內部訂閱識別碼
status	SubscriptionStatus.Code	status - 欲變更的訂閱狀態

ChangeSubscriptionStatusRes

ChangeSubscriptionStatusRes 變更訂閱狀態的回應結果（空回應）

CreateSubscriptionTokenReq

CreateSubscriptionTokenReq 建立訂閱 token 的請求參數

Field	Type	Label	Description
app_token	string		app_token - 應用程式認證 token
product_name	string		product_name - 訂閱商品名稱
money	transaction.Money		money - 貨幣金額的交易(結帳)與顯示設定
callback_url	string		callback_url - 交易狀態回呼網址
object_id	string		object_id - PAN 使用者系統物件識別碼，用於關聯用戶身份
redirect_url	string		redirect_url - 交易完成後重導向網址
invoice_remark	string	optional	invoice_remark: optional, 發票備註 - 發票備註，只能由產品端設定
payment_channels	transaction.PaymentChannel	repeated	payment_channels: optional, 指定訂單付款方式 - 限制可用的付款管道
payment_period	PaymentPeriod	optional	payment_period: 指定付款方式的最短、最長期間 - 各付款方式的時間限制設定
period	SubscriptionPeriod.Code		period - 訂閱週期類型（月、年、日）
period_interval	int32		period_interval - 訂閱週期間隔數（例如：每2個月為2，每3個月為3）
order_id	string		order_id - 平台自訂訂單編號
subscription_callback_url	string		subscription_callback_url - 訂閱狀態更新專用回呼網址
downstream_subscription_id	string		downstream_subscription_id - 平台自訂訂閱識別碼

CreateSubscriptionTokenRes

CreateSubscriptionTokenRes 建立訂閱 token 的回應結果

Field	Type	Description
transaction_token	string	transaction_token - 交易 token，用於前端發起首次付款
subsc_id	string	subsc_id - 系統內部訂閱識別碼
transc_id	string	transc_id - 系統內部交易識別碼

CreateTransactionTokenReq

CreateTransactionTokenReq 建立交易 token 的請求參數

Field	Type	Label	Description
app_id	string		jpay application id - 應用程式識別碼
order_id	string		platform custom order ID - 平台自訂訂單編號
product_name	string		platform product name for transaction - 交易商品名稱
money	transaction.Money		貨幣金額相關設定 money.currency: transaction currency - 交易幣別 money.price: transaction price - 交易金額 money.display_currency: display currency on page - 頁面顯示幣別 money.display_price: display price on page - 頁面顯示金額 money.payment_currency: Payment to Bank with Specified Currency - 實際付款幣別
callback_url	string		platform callback_url - 交易狀態回呼網址
object_id	string		pan object_id - PAN 使用者系統物件識別碼，用於關聯用戶身份
jpoint_discount	int64		Deprecated. jpoint_discount is deprecated - 已棄用預先 JPOINTS 點數折扣欄位
check_code	string		check_code generated by platform with transaction information - 平台生成的交易驗證碼
redirect_url	string		platform redirect_url - 交易完成後重導向網址
require_apea_twid	bool		require_apea_twid - 是否需要 APEA TWID 驗證
invoice_remark	string		invoice_remark: optional, 發票備註 - 發票備註，只能由產品端設定
payment_channels	transaction.PaymentChannel	repeated	payment_channels: optional, 指定訂單付款方式 - 限制可用的付款管道
payment_period	PaymentPeriod	optional	payment_period: 指定付款方式的最短、最長期間 - 各付款方式的時間限制設定
subscription_period	SubscriptionPeriod.Code	optional	subscription_period: 通常由訂閱系統指定續費週期 - 訂閱週期類型
subscription_period_interval	int32	optional	subscription_period_interval: 通常由訂閱系統指定週期間隔 - 訂閱週期間隔數

CreateTransactionTokenRes

CreateTransactionTokenRes 建立交易 token 的回應結果

Field	Type	Label	Description
transaction_token	string		transaction_token - 交易 token，用於前端發起交易
transc_id	string		transc_id - 系統內部交易識別碼

DurationMinMax

DurationMinMax 定義時間期間的最小值與最大值範圍

Field	Type	Label	Description
min	google.protobuf.Duration		min - 最短時間期間
max	google.protobuf.Duration		max - 最長時間期間

PaymentPeriod

PaymentPeriod 定義各種付款方式的時間期間限制

Field	Type	Label	Description
selection_period	DurationMinMax	optional	selection_period: 指定第一階段(待選擇付款方式)的最短、最長期間不同訂單可以接受的期間有所不同，會儘量在 min~max 之間如果該訂單無法符合 min~max 則無法建立 Transaction 並回傳錯誤
process_cvs_period	DurationMinMax	optional	process_cvs_period: 指定第二階段(付款處理)的便利商店付款最短、最長期間因為金流差異可以接受的期間有所不同，會儘量在 min~max 之間如果該金流無法符合 min~max 則無法建立 Transaction 並回傳錯誤
process_atm_period	DurationMinMax	optional	process_atm_period: 指定第二階段(付款處理)的 ATM 轉帳最短、最長期間因為金流差異可以接受的期間有所不同，會儘量在 min~max 之間如果該金流無法符合 min~max 則無法建立 Transaction 並回傳錯誤
process_creditcard_period	DurationMinMax	optional	process_creditcard_period: 指定第二階段(付款處理)的信用卡付款最短、最長期間因為金流差異可以接受的期間有所不同，會儘量在 min~max 之間如果該金流無法符合 min~max 則無法建立 Transaction 並回傳錯誤
process_jkopay_period	DurationMinMax	optional	process_jkopay_period: 指定第二階段(付款處理)的街口支付最短、最長期間因為金流差異可以接受的期間有所不同，會儘量在 min~max 之間如果該金流無法符合 min~max 則無法建立 Transaction 並回傳錯誤

QuerySubscriptionPaymentRecordReq

QuerySubscriptionPaymentRecordReq 查詢訂閱付款記錄的請求參數

Field	Type	Description
app_token	string	app_token - 應用程式認證 token
subsc_id	string
page	int64	page - 分頁頁碼（從 1 開始）
page_size	int64	page_size - 每頁記錄數量, 最多 100

QuerySubscriptionPaymentRecordRes

QuerySubscriptionPaymentRecordRes 查詢訂閱付款記錄的回應結果

Field	Type	Label	Description
records	SubscriptionPaymentRecord	repeated	records - 訂閱付款記錄列表
total	int64		total - 符合條件的記錄總數
total_amount	int64		total_amount - 所有記錄的總金額

QuerySubscriptionReq

QuerySubscriptionReq 查詢訂閱資訊的請求參數

Field	Type	Label	Description
app_token	string		app_token - 應用程式認證 token
subsc_id	string		subsc_id - 系統內部訂閱識別碼

QuerySubscriptionRes

QuerySubscriptionRes 查詢訂閱資訊的回應結果

Field	Type	Description
subsc_id	string	subsc_id - 系統內部訂閱識別碼
payment_method_id	string	payment_method_id - 用戶綁定的付款方式識別碼
payment_creditcard_id	string	payment_creditcard_id - 用戶綁定的信用卡識別碼
status	SubscriptionStatus.Code	status - 目前訂閱狀態
next_renew_at	google.protobuf.Timestamp	next_renew_at - 預定下次續費扣款時間
renewing_at	google.protobuf.Timestamp	renewing_at - 目前續費處理的開始時間（處理中狀態）
trial_start_at	google.protobuf.Timestamp	trial_start_at - 試用期開始時間
trial_end_at	google.protobuf.Timestamp	trial_end_at - 試用期結束時間（之後開始正式扣款）
period	SubscriptionPeriod.Code	period - 訂閱週期類型

SubscriptionPaymentRecord

SubscriptionPaymentRecord 訂閱付款記錄（用於記錄每次續費的詳細資訊）

Field	Type	Description
id	string	id - 付款記錄唯一識別碼
transc_id	string	transc_id - 對應的系統交易識別碼
payment_method_id	string	payment_method_id - 此次續費使用的付款方式識別碼
payment_creditcard_id	string	payment_creditcard_id - 此次續費使用的信用卡識別碼
amount	transaction.Money	amount - 此次續費的付款金額與幣別資訊
created_at	google.protobuf.Timestamp	created_at - 付款記錄建立時間
subscription_callback_status	string	subscription_callback_status - 訂閱回調處理狀態
transaction_status	transaction.TranscStatus

SubscriptionPeriod

SubscriptionPeriod 定義訂閱的週期類型

SubscriptionStatus

SubscriptionStatus 定義訂閱的各種狀態

TransactionApiError

TransactionApiError 定義交易 API 的錯誤代碼

SubscriptionPeriod.Code

Name	Number	Description
NONE	0	NONE - 無週期/未設定
MONTHLY	1	MONTHLY - 月付制
YEARLY	2	YEARLY - 年付制
DAY	3	DAY - 日付制

SubscriptionStatus.Code

Name	Number	Description
NONE	0	NONE - 無狀態/未知狀態
CREATED	1	CREATED - 已建立（尚未進行首次付款）
TRIAL	2	TRIAL - 試用期中
ACTIVE	3	ACTIVE - 啟用中（正常續費扣款）
CANCELLED	4	CANCELLED - 已取消（用戶主動取消，不再續費）
EXPIRED	5	EXPIRED - 已過期（到期後未續費）
PAUSED	6	PAUSED - 已暫停（臨時停止續費，可恢復）
PAYMENT_FAILED	7	PAYMENT_FAILED - 付款失敗（續費扣款失敗）

TransactionApiError.Code

Name	Number	Description
None	0	None - 無錯誤
PAYMENT_SELECTION_PERIOD_NOT_SUPPORTED	1001	PAYMENT_SELECTION_PERIOD_NOT_SUPPORTED - 付款選擇期間不支援
PAYMENT_PROCESS_CVS_PERIOD_NOT_SUPPORTED	1002	PAYMENT_PROCESS_CVS_PERIOD_NOT_SUPPORTED - 便利商店付款處理期間不支援
PAYMENT_PROCESS_ATM_PERIOD_NOT_SUPPORTED	1003	PAYMENT_PROCESS_ATM_PERIOD_NOT_SUPPORTED - ATM 付款處理期間不支援
PAYMENT_PROCESS_CREDITCARD_PERIOD_NOT_SUPPORTED	1004	PAYMENT_PROCESS_CREDITCARD_PERIOD_NOT_SUPPORTED - 信用卡付款處理期間不支援
SET_PAYMENT_METHOD_ABOVE_ONCE	1005	SET_PAYMENT_METHOD_ABOVE_ONCE - 交易只允許設定付款方式一次
SUBSCRIPTION_CHANGE_STATUS_FAILED	1006	SUBSCRIPTION_CHANGE_STATUS_FAILED - 訂閱狀態變更失敗
PAYMENT_PROCESS_JKOPAY_PERIOD_NOT_SUPPORTED	1007	PAYMENT_PROCESS_JKOPAY_PERIOD_NOT_SUPPORTED - 街口支付處理期間不支援

TransactionApiService

TransactionApiService 提供交易與訂閱相關的 API 服務

Method Name	Request Type	Response Type	Description
CreateTransactionToken	CreateTransactionTokenReq	CreateTransactionTokenRes	CreateTransactionToken 生成一次性交易 token
CreateSubscriptionToken	CreateSubscriptionTokenReq	CreateSubscriptionTokenRes	CreateSubscriptionToken 生成訂閱制交易 token
ChangeSubscriptionStatus	ChangeSubscriptionStatusReq	ChangeSubscriptionStatusRes	ChangeSubscriptionStatus 變更訂閱狀態（暫停、取消、恢復等）
QuerySubscription	QuerySubscriptionReq	QuerySubscriptionRes	QuerySubscription 查詢訂閱詳細資訊與狀態
QuerySubscriptionPaymentRecord	QuerySubscriptionPaymentRecordReq	QuerySubscriptionPaymentRecordRes	QuerySubscriptionPaymentRecord 查詢訂閱付款紀錄

payadmin/admin.proto

AppListReq

Field	Type	Label	Description
admin_token	string

AppListRes

Field	Type	Label	Description
application	Application	repeated

Application

Field	Type	Label	Description
app_id	string
app_name	string
status	int64
jpoint_app_name	string
jpoint_app_secret_key	string

CancelSubscriptionReq

Field	Type	Label
admin_token	string
subscription_id	string
reason	string	optional

CancelSubscriptionRes

CancelSubscriptionRes.Error

CheckTransactionReq

Field	Type	Label	Description
admin_token	string
trade_id	string

CheckTransactionRes

Field	Type	Label	Description
result	string

CreateAppPaymentReq

Field	Type	Label	Description
admin_token	string
app_psg	CreateAppPaymentReq.CreateAppPsg

CreateAppPaymentReq.CreateAppPsg

Field	Type	Label	Description
app_id	string
psg_id	string
psg_method_id	string

CreateAppPaymentRes

CreateAppReq

Field	Type	Label	Description
admin_token	string
status	int64
app_name	string
jpoint_app_name	string
jpoint_app_secret_key	string

CreateAppRes

Field	Type	Label	Description
app_id	string

CreatePaymentMethodReq

Field	Type	Label	Description
admin_token	string
psg_method	model.PsgMethod

CreatePaymentMethodRes

Field	Type	Label	Description
psg_method_id	string

CreatePaymentServiceGatewayReq

Field	Type	Label	Description
admin_token	string
psg	model.Psg

CreatePaymentServiceGatewayRes

CreateSystemInfoReq

Field	Type	Label	Description
admin_token	string
usd_twd_exchange_rate	double
status	SystemInfoStatus

CreateSystemInfoRes

Field	Type	Label	Description
id	int64

CreditCard

Field	Type	Label	Description
id	string
phone_id	string
l4	string
created_at	google.protobuf.Timestamp
psg	model.Psg

DeleteSystemInfoReq

Field	Type	Label	Description
admin_token	string
id	int64

DeleteSystemInfoRes

DiamondLog

Field	Type	Label	Description
id	int64
user_object_id	string
trade_id	string
amount_before	int64
amount_after	int64
created_at	google.protobuf.Timestamp
memo	string

DiamondOrder

Field	Type	Label	Description
id	int64

DiamondSubscribe

Field	Type	Label	Description
id	int64
object_id	string
phone	string
diamond_package_name	string
status	SubscribeStatus
invoice_type	string
invoice_data	string
created_at	google.protobuf.Timestamp

GetAppPaymentsReq

app psg

Field	Type	Label	Description
admin_token	string
app_id	string

GetAppPaymentsRes

Field	Type	Label	Description
app_psg	model.AdminAppPsg	repeated

GetAppReq

Field	Type	Label	Description
admin_token	string
app_id	string

GetAppRes

Field	Type	Label	Description
application	Application

GetBindCreditcardListReq

Field	Type	Description
admin_token	string
page	int64
limit	int64
phone_id	string	optional

GetBindCreditcardListRes

Field	Type	Label	Description
creditcards	CreditCard	repeated
total	int64

GetChannelsReq

channel

Field	Type	Label	Description
admin_token	string
app_id	string

GetChannelsRes

Field	Type	Label	Description
channels	transaction.PaymentChannel	repeated

GetDiamondSubscribeListReq

Field	Type	Description
admin_token	string
page	int64
limit	int64
object_id	string	optional
status	SubscribeStatus	optional
phone	string

GetDiamondSubscribeListRes

Field	Type	Label	Description
subscribes	DiamondSubscribe	repeated
total	int64

GetMemberInfoReq

Field	Type	Label	Description
phone	string
user_object_id	string
secrect	string

GetMemberInfoRes

Field	Type	Label	Description
diamond_amount	int64
jr_vip_expired_at	google.protobuf.Timestamp

GetPaymentMethodListReq

Field	Type	Label	Description
admin_token	string

GetPaymentMethodListRes

Field	Type	Label	Description
psg_methods	model.PsgMethod	repeated

GetPaymentMethodReq

Field	Type	Label	Description
admin_token	string
psg_method_id	string

GetPaymentMethodRes

Field	Type	Label	Description
psg_method	model.PsgMethod

GetPaymentServiceGatewayReq

Field	Type	Label	Description
admin_token	string
psg_id	string

GetPaymentServiceGatewayRes

Field	Type	Label	Description
psg	model.Psg

GetPaymentServiceGatewaysReq

psg

Field	Type	Description
admin_token	string
app_id	string	optional
channels	transaction.PaymentChannel	optional

GetPaymentServiceGatewaysRes

Field	Type	Label	Description
psgs	model.Psg	repeated

GetSubscriptionListReq

Field	Type	Label
admin_token	string
page	int64
limit	int64
status	int32	optional
user_object_id	string	optional
start_at	google.protobuf.Timestamp	optional
end_at	google.protobuf.Timestamp	optional
phone_number	string	optional
app_id	string	optional
subscription_id	string	optional

GetSubscriptionListRes

Field	Type	Label
records	SubscriptionRecord	repeated
total	int64
totalAmount	int64

GetTransactionGatewayLogReq

Field	Type	Description
admin_token	string
trade_id	string	trade_id 可以擇一帶入
subscription_id	string	subscription_id 可以擇一帶入

GetTransactionGatewayLogRes

Field	Type	Label	Description
records	SystemLogRecord	repeated

GetTranscRecordListReq

Field	Type	Description
admin_token	string
page	int64
limit	int64
status	int32	optional
user_object_id	string	optional
trade_id	string	optional
upstream_trade_id	string	optional
downstream_trade_id	string	optional
start_at	google.protobuf.Timestamp	optional
end_at	google.protobuf.Timestamp	optional
start_completed_at	google.protobuf.Timestamp	optional
end_completed_at	google.protobuf.Timestamp	optional
phone_number	string	optional
currency	Currency	optional
app_id	string	optional
payment_type	transaction.PaymentType	optional

GetTranscRecordListRes

Field	Type	Label
records	TranscRecord	repeated
total	int64
totalAmount	int64

GetUserDiamondLogReq

Field	Type	Label	Description
admin_token	string
page	int64
limit	int64
user_object_id	string

GetUserDiamondLogRes

Field	Type	Label
diamond_logs	DiamondLog	repeated
total	int64
user_balance	int64

QueryGatewayTransactionReq

Field	Type	Label	Description
admin_token	string
trade_id	string

QueryGatewayTransactionRes

Field	Type	Label	Description
result	string

QuerySubscriptionPaymentRecordReq

QuerySubscriptionPaymentRecordReq 查詢訂閱付款記錄的請求參數

Field	Type	Description
admin_token	string	admin_token - JKFC 認證 token
subsc_id	string
page	int64	page - 分頁頁碼（從 1 開始）
page_size	int64	page_size - 每頁記錄數量, 最多 100

QuerySubscriptionPaymentRecordRes

QuerySubscriptionPaymentRecordRes 查詢訂閱付款記錄的回應結果

Field	Type	Label	Description
records	jkfpay.transaction_api.SubscriptionPaymentRecord	repeated	records - 訂閱付款記錄列表
total	int64		total - 符合條件的記錄總數
total_amount	int64		total_amount - 所有記錄的總金額

QuerySystemInfoListReq

Field	Type	Label
admin_token	string
page	int64
page_size	int64
status	SystemInfoStatus	optional

QuerySystemInfoListRes

Field	Type	Label	Description
system_infos	SystemInfo	repeated
total	int64

RenewSubscriptionReq

Field	Type	Label	Description
admin_token	string
subscription_id	string
force_renew	bool

RenewSubscriptionRes

RenewSubscriptionRes.Error

RevokeDiamondReq

Field	Type	Label	Description
admin_token	string
order_id	int64

RevokeDiamondRes

RevokeOrderReq

Field	Type	Label	Description
admin_token	string
trade_id	string

RevokeOrderRes

SubscriptionRecord

Field	Type	Label	Description
id	string
app_id	string
subscription_token	string	optional
object_id	string
phone_id	string
product_name	string
money	transaction.Money
display_money	transaction.Money
callback_url	string
redirect_url	string
status	int32
period	int32
period_interval	int32
payment_method_id	string
payment_creditcard_id	string
next_renew_at	google.protobuf.Timestamp	optional
renewing_at	google.protobuf.Timestamp	optional
trial_start_at	google.protobuf.Timestamp	optional
trial_end_at	google.protobuf.Timestamp	optional
invoice_remark	string
invoice_type	string
invoice_data	string
subscription_callback_url	string
downstream_subscription_id	string
require_apea_twid	bool
payment_channels	transaction.PaymentChannel	repeated
display_exchange_rate	float
payment_period	jkfpay.transaction_api.PaymentPeriod	optional	payment_period: 指定付款方式的最短、最長期間，因為訂單條件與金流差異而系統可以接受的期間有所不同，
created_at	google.protobuf.Timestamp
updated_at	google.protobuf.Timestamp

SystemInfo

SystemInfo related messages

Field	Type	Label	Description
id	int64
usd_twd_exchange_rate	double
status	SystemInfoStatus
created_at	google.protobuf.Timestamp
updated_at	google.protobuf.Timestamp
deleted_at	google.protobuf.Timestamp

SystemLogRecord

Field	Type	Label	Description
id	string
name	string
data	string
created_at	google.protobuf.Timestamp

TranscRecord

Field	Type	Description
status	int32
user_object_id	string
trade_id	string
downstream_trade_id	string
upstream_trade_id	string
product_name	string
required_amount	int64
received_amount	int64
currency	string
created_at	google.protobuf.Timestamp
phone	string
redirect_url	string
diamond_order	DiamondOrder
completed_at	google.protobuf.Timestamp
ip	string
received_jpoint	int64
phone_id	string
application_name	string
psg_provider	string
psg_merchant_id	string
psg_method_channel	string	廢棄
paymentType	transaction.PaymentType
failed_message	string

UnbindCreditcardReq

Field	Type	Label	Description
admin_token	string
creditcard_id	string

UnbindCreditcardRes

UnsubscribeDiamondReq

Field	Type	Label	Description
admin_token	string
object_id	string
subscribe_id	int64

UnsubscribeDiamondRes

UpdateAppPaymentPriorityReq

Field	Type	Label	Description
admin_token	string
ids	int64	repeated

UpdateAppPaymentPriorityRes

UpdateAppPaymentStatusReq

Field	Type	Label	Description
admin_token	string
id	int64
status	model.PsgMethodStatus

UpdateAppPaymentStatusRes

UpdateAppReq

Field	Type	Label	Description
admin_token	string
app_id	string
app_name	string
status	int64
jpoint_app_name	string
jpoint_app_secret_key	string

UpdateAppRes

UpdateAppStatusReq

Field	Type	Label	Description
admin_token	string
app_id	string
status	int64

UpdateAppStatusRes

UpdatePaymentMethodReq

Field	Type	Label	Description
admin_token	string
psg_method	model.PsgMethod

UpdatePaymentMethodRes

UpdatePaymentMethodStatusReq

Field	Type	Label	Description
admin_token	string
psg_method_id	string
status	int64

UpdatePaymentMethodStatusRes

UpdatePaymentServiceGatewayReq

Field	Type	Label	Description
admin_token	string
psg	model.Psg

UpdatePaymentServiceGatewayRes

UpdatePaymentServiceGatewayStatusReq

Field	Type	Label	Description
admin_token	string
psg_id	string
status	int64

UpdatePaymentServiceGatewayStatusRes

UpdateSystemInfoReq

Field	Type	Label
admin_token	string
id	int64
usd_twd_exchange_rate	double	optional
status	SystemInfoStatus	optional

UpdateSystemInfoRes

WithdrawOrderReq

Field	Type	Label	Description
admin_token	string
trade_id	string

WithdrawOrderRes

CancelSubscriptionRes.Error.Code

Name	Number	Description
NONE	0
FAILED	1001

Currency

Name	Number	Description
CURRENCY_NOT_SET	0
CURRENCY_TWD	1
CURRENCY_USD	2
CURRENCY_DIAMOND	3
CURRENCY_USD_CENTS	4

RenewSubscriptionRes.Error.Code

Name	Number	Description
NONE	0
FAILED	1001
PAYMENT_FAILED	1002

SubscribeStatus

Name	Number	Description
SB_Default	0
SB_Unsubscribe	1
SB_Subscribe	2

SystemInfoStatus

Name	Number	Description
SYSTEM_INFO_STATUS_UNSPECIFIED	0
SYSTEM_INFO_STATUS_ACTIVE	1
SYSTEM_INFO_STATUS_INACTIVE	2

AdminService

Method Name	Request Type	Response Type	Description
CheckTransaction	CheckTransactionReq	CheckTransactionRes	查詢 transaction 結果
QueryGatewayTransaction	QueryGatewayTransactionReq	QueryGatewayTransactionRes	查詢金流端的 transaction 紀錄
GetTranscRecordList	GetTranscRecordListReq	GetTranscRecordListRes
GetUserDiamondLog	GetUserDiamondLogReq	GetUserDiamondLogRes
GetTransactionGatewayLog	GetTransactionGatewayLogReq	GetTransactionGatewayLogRes	查詢訂單與金流端的紀錄
AppList	AppListReq	AppListRes	application
CreateApp	CreateAppReq	CreateAppRes
GetApp	GetAppReq	GetAppRes
UpdateApp	UpdateAppReq	UpdateAppRes
RevokeDiamond	RevokeDiamondReq	RevokeDiamondRes
RevokeOrder	RevokeOrderReq	RevokeOrderRes	退款
WithdrawOrder	WithdrawOrderReq	WithdrawOrderRes	退單
GetBindCreditcardList	GetBindCreditcardListReq	GetBindCreditcardListRes	綁卡資訊
UnbindCreditcard	UnbindCreditcardReq	UnbindCreditcardRes
GetMemberInfo	GetMemberInfoReq	GetMemberInfoRes	for pan
GetDiamondSubscribeList	GetDiamondSubscribeListReq	GetDiamondSubscribeListRes	月卡資訊
UnsubscribeDiamond	UnsubscribeDiamondReq	UnsubscribeDiamondRes
CreateSystemInfo	CreateSystemInfoReq	CreateSystemInfoRes	system info
UpdateSystemInfo	UpdateSystemInfoReq	UpdateSystemInfoRes
QuerySystemInfoList	QuerySystemInfoListReq	QuerySystemInfoListRes
DeleteSystemInfo	DeleteSystemInfoReq	DeleteSystemInfoRes
GetPaymentServiceGateways	GetPaymentServiceGatewaysReq	GetPaymentServiceGatewaysRes	psg
CreatePaymentServiceGateway	CreatePaymentServiceGatewayReq	CreatePaymentServiceGatewayRes
GetPaymentServiceGateway	GetPaymentServiceGatewayReq	GetPaymentServiceGatewayRes
UpdatePaymentServiceGateway	UpdatePaymentServiceGatewayReq	UpdatePaymentServiceGatewayRes
GetAppPayments	GetAppPaymentsReq	GetAppPaymentsRes	app_psg (對應table app_psg_method, 舊版app_psg廢棄)
CreateAppPayment	CreateAppPaymentReq	CreateAppPaymentRes
UpdateAppPaymentStatus	UpdateAppPaymentStatusReq	UpdateAppPaymentStatusRes
UpdateAppPaymentPriority	UpdateAppPaymentPriorityReq	UpdateAppPaymentPriorityRes
CreatePaymentMethod	CreatePaymentMethodReq	CreatePaymentMethodRes	psg_method
GetPaymentMethod	GetPaymentMethodReq	GetPaymentMethodRes
GetPaymentMethodList	GetPaymentMethodListReq	GetPaymentMethodListRes
UpdatePaymentMethod	UpdatePaymentMethodReq	UpdatePaymentMethodRes
GetSubscriptionList	GetSubscriptionListReq	GetSubscriptionListRes	List subscriptions
CancelSubscription	CancelSubscriptionReq	CancelSubscriptionRes	Cancel subscription
RenewSubscription	RenewSubscriptionReq	RenewSubscriptionRes	Renew subscription
QuerySubscriptionPaymentRecord	QuerySubscriptionPaymentRecordReq	QuerySubscriptionPaymentRecordRes	Query subscription payment record

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)

v0.1.68 ​

jkf-pay-proto ​

transaction/transaction.proto ​

CheckFreeDiamondReq ​

CheckFreeDiamondRes ​

CompleteTransactionReq ​

CompleteTransactionRes ​

CreateTransactionTokenReq ​

CreateTransactionTokenRes ​

CreditCard ​

CreditCard.Status ​

DiamondPackage ​

DiamondRecord ​

DiscountTransactionReq ​

DiscountTransactionRes ​

FormData ​

FormDataOptions ​

GetBonusAmountReq ​

GetBonusAmountRes ​

GetDiamondAmountReq ​

GetDiamondAmountRes ​

GetDiamondPackagesReq ​

GetDiamondPackagesRes ​

GetDiamondRecordReq ​

GetDiamondRecordRes ​

GetExchangeRateReq ​

GetExchangeRateRes ​

GetFreeDiamondAmountReq ​

GetFreeDiamondAmountRes ​

GetFreeDiamondEarnTimesReq ​

GetFreeDiamondEarnTimesRes ​

GetPaymentInfoReq ​

GetPaymentInfoRes ​

GetPurchaseRecordReq ​

GetPurchaseRecordRes ​

GetTransactionTokenReq ​

GetTransactionTokenRes ​

InvoiceSetting ​

Money ​

PaymentCode ​

PaymentCode.AtmInfo ​

PaymentCode.CvsInfo ​

PaymentCode.DisplayInfoUrl ​

PaymentMethod ​

PaymentParamsOfCreditCard ​

PaymentParamsOfDiamond ​

PaymentParamsOfEcpayInpay ​

PaymentParamsOfHappypay ​

PaymentParamsOfJkopayAuthPay ​

PaymentParamsOfTapPay ​

PurchaseDiamondReq ​

PurchaseRecord ​

QueryTransactionReq ​

QueryTransactionRes ​

RefundTransactionReq ​

RefundTransactionRes ​

SetPaymentMethodReq ​

SetPaymentMethodRes ​

SetTransactionInvoiceReq ​

SetTransactionInvoiceRes ​

SubscriptionInfo ​

SubscriptionPeriod ​

TotalDepositAmountsReq ​

TotalDepositAmountsRes ​

TransactionTokenInfoReq ​

TransactionTokenInfoRes ​

UseBonusDiamondReq ​

UseBonusDiamondRes ​

WSMessage ​

CreditCard.Status.Value ​

Currency ​

DiamondPackageType ​

DiamondRecordType ​

ErrBase ​

ErrCTCode ​

InvoiceStatus ​

InvoiceType ​

PaymentChannel ​

PaymentCode.CvsInfo.CvsType ​

PaymentCode.DisplayInfoUrl.Method ​

v0.1.68

jkf-pay-proto

transaction/transaction.proto

CheckFreeDiamondReq

CheckFreeDiamondRes

CompleteTransactionReq

CompleteTransactionRes

CreateTransactionTokenReq

CreateTransactionTokenRes

CreditCard

CreditCard.Status

DiamondPackage

DiamondRecord

DiscountTransactionReq

DiscountTransactionRes

FormData

FormDataOptions

GetBonusAmountReq

GetBonusAmountRes

GetDiamondAmountReq

GetDiamondAmountRes

GetDiamondPackagesReq

GetDiamondPackagesRes

GetDiamondRecordReq

GetDiamondRecordRes

GetExchangeRateReq

GetExchangeRateRes

GetFreeDiamondAmountReq

GetFreeDiamondAmountRes

GetFreeDiamondEarnTimesReq

GetFreeDiamondEarnTimesRes

GetPaymentInfoReq

GetPaymentInfoRes

GetPurchaseRecordReq

GetPurchaseRecordRes

GetTransactionTokenReq

GetTransactionTokenRes

InvoiceSetting

Money

PaymentCode

PaymentCode.AtmInfo

PaymentCode.CvsInfo

PaymentCode.DisplayInfoUrl

PaymentMethod

PaymentParamsOfCreditCard

PaymentParamsOfDiamond

PaymentParamsOfEcpayInpay

PaymentParamsOfHappypay

PaymentParamsOfJkopayAuthPay

PaymentParamsOfTapPay

PurchaseDiamondReq

PurchaseRecord

QueryTransactionReq

QueryTransactionRes

RefundTransactionReq

RefundTransactionRes

SetPaymentMethodReq

SetPaymentMethodRes

SetTransactionInvoiceReq

SetTransactionInvoiceRes

SubscriptionInfo

SubscriptionPeriod

TotalDepositAmountsReq

TotalDepositAmountsRes

TransactionTokenInfoReq

TransactionTokenInfoRes

UseBonusDiamondReq

UseBonusDiamondRes

WSMessage

CreditCard.Status.Value

Currency

DiamondPackageType

DiamondRecordType

ErrBase

ErrCTCode

InvoiceStatus

InvoiceType

PaymentChannel

PaymentCode.CvsInfo.CvsType

PaymentCode.DisplayInfoUrl.Method