tencentcloud-sdk-nodejs
Version:
2,885 lines • 568 kB
TypeScript
/**
* QueryFlexPaymentOrderStatus请求参数结构体
*/
export interface QueryFlexPaymentOrderStatusRequest {
/**
* 外部订单ID
*/
OutOrderId?: string;
/**
* 订单ID
*/
OrderId?: string;
/**
* 环境类型
__release__:生产环境
__sandbox__:沙箱环境
__test__:测试环境
缺省默认为生产环境
*/
Environment?: string;
}
/**
* QueryAcctBinding请求参数结构体
*/
export interface QueryAcctBindingRequest {
/**
* 聚鑫分配的支付主MidasAppId
*/
MidasAppId: string;
/**
* 聚鑫计费SubAppId，代表子商户
*/
SubAppId: string;
/**
* 由平台客服提供的计费密钥Id
*/
MidasSecretId: string;
/**
* 计费签名
*/
MidasSignature: string;
/**
* 敏感信息加密类型:
RSA: rsa非对称加密，使用RSA-PKCS1-v1_5
AES: aes对称加密，使用AES256-CBC-PCKS7padding
缺省: RSA
*/
EncryptType?: string;
/**
* 环境名:
release: 现网环境
sandbox: 沙箱环境
development: 开发环境
缺省: release
*/
MidasEnvironment?: string;
}
/**
* QueryCompanyTitle返回参数结构体
*/
export interface QueryCompanyTitleResponse {
/**
* 错误码
*/
ErrCode: string;
/**
* 错误消息
*/
ErrMessage: string;
/**
* 公司抬头结果
注意：此字段可能返回 null，表示取不到有效值。
*/
Result: Array<CompanyTitleResult>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ReviseMbrProperty返回参数结构体
*/
export interface ReviseMbrPropertyResponse {
/**
* String(20)，返回码
*/
TxnReturnCode?: string;
/**
* String(100)，返回信息
*/
TxnReturnMsg?: string;
/**
* String(22)，交易流水号
*/
CnsmrSeqNo?: string;
/**
* STRING(1027)，保留域
注意：此字段可能返回 null，表示取不到有效值。
*/
ReservedMsg?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ApplyPayerInfo返回参数结构体
*/
export interface ApplyPayerInfoResponse {
/**
* 付款人申请结果
*/
Result: ApplyPayerinfoResult;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 绑定分账收款方查询响应
*/
export interface QueryOpenBankProfitSharePayeeResult {
/**
* 账户ID（受益ID）
*/
AccountId: string;
/**
* 账户号。通联国际指客户银行账户号
*/
AccountNo: string;
/**
* 账户货币。参考附录“币种类型”。
*/
Currency: string;
/**
* 收款人账户名称
*/
AccountName: string;
/**
* 银行名称
注意：此字段可能返回 null，表示取不到有效值。
*/
BankName: string;
/**
* 账户类型。
00:借记卡
01:存折
02:信用卡
03:准贷记卡
04:预付卡费
05:境外卡
注意：此字段可能返回 null，表示取不到有效值。
*/
Nature: string;
/**
* 状态
0-待审核；1-审核通过；2-审核不通过 3-关联实体未审核
*/
BindState: string;
/**
* 状态描述
*/
StateExplain: string;
}
/**
* UnifiedOrder返回参数结构体
*/
export interface UnifiedOrderResponse {
/**
* 支付金额，单位： 分
*/
TotalAmt: number;
/**
* 应用支付订单号
*/
OutTradeNo: string;
/**
* 支付参数透传给聚鑫SDK（原文透传给SDK即可，不需要解码）
*/
PayInfo: string;
/**
* 聚鑫的交易订单
*/
TransactionId: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ApplyOpenBankSettleOrder返回参数结构体
*/
export interface ApplyOpenBankSettleOrderResponse {
/**
* 错误码。
*/
ErrCode: string;
/**
* 错误信息。
*/
ErrMessage: string;
/**
* 返回结果
注意：此字段可能返回 null，表示取不到有效值。
*/
Result: ApplyOpenBankSettleOrderResult;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreatePayRollToken返回参数结构体
*/
export interface CreatePayRollTokenResponse {
/**
* Token有效时间，单位秒
*/
ExpireTime: number;
/**
* 微信服务商商户的商户号，由微信支付生成并下发
*/
MerchantId: string;
/**
* 用户在商户对应appid下的唯一标识
*/
OpenId: string;
/**
* 微信服务商下特约商户的商户号，由微信支付生成并下发
*/
SubMerchantId: string;
/**
* Token值
*/
Token: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 付款人申请结果
*/
export interface ApplyPayerinfoResult {
/**
* 错误码
*/
Code: string;
/**
* 数据
*/
Data: ApplyPayerinfoData;
}
/**
* 冻结余额结果
*/
export interface FreezeFlexBalanceResult {
/**
* 冻结订单ID
*/
OrderId: string;
}
/**
* BindAcct请求参数结构体
*/
export interface BindAcctRequest {
/**
* 聚鑫分配的支付主MidasAppId
*/
MidasAppId: string;
/**
* 聚鑫计费SubAppId，代表子商户
*/
SubAppId: string;
/**
* 1 – 小额转账验证
2 – 短信验证
3 - 一分钱转账验证，无需再调CheckAcct验证绑卡
4 - 银行四要素验证，无需再调CheckAcct验证绑卡
每个结算账户每天只能使用一次小额转账验证
*/
BindType: number;
/**
* 用于提现
<敏感信息>加密详见<a href="https://cloud.tencent.com/document/product/1122/48979" target="_blank">《商户端接口敏感信息加密说明》</a>
*/
SettleAcctNo: string;
/**
* 结算账户户名
<敏感信息>加密详见<a href="https://cloud.tencent.com/document/product/1122/48979" target="_blank">《商户端接口敏感信息加密说明》</a>
*/
SettleAcctName: string;
/**
* 1 – 本行账户
2 – 他行账户
*/
SettleAcctType: number;
/**
* 证件类型，见《证件类型》表
*/
IdType: string;
/**
* 证件号码
<敏感信息>加密详见<a href="https://cloud.tencent.com/document/product/1122/48979" target="_blank">《商户端接口敏感信息加密说明》</a>
*/
IdCode: string;
/**
* 开户行名称
*/
AcctBranchName: string;
/**
* 聚鑫分配的安全ID
*/
MidasSecretId: string;
/**
* 按照聚鑫安全密钥计算的签名
*/
MidasSignature: string;
/**
* 用于短信验证
BindType==2时必填
<敏感信息>加密详见<a href="https://cloud.tencent.com/document/product/1122/48979" target="_blank">《商户端接口敏感信息加密说明》</a>
*/
Mobile?: string;
/**
* 大小额行号，超级网银行号和大小额行号
二选一
*/
CnapsBranchId?: string;
/**
* 超级网银行号，超级网银行号和大小额行号
二选一
*/
EiconBankBranchId?: string;
/**
* 敏感信息加密类型:
RSA: rsa非对称加密，使用RSA-PKCS1-v1_5
AES: aes对称加密，使用AES256-CBC-PCKS7padding
缺省: RSA
*/
EncryptType?: string;
/**
* 环境名:
release: 现网环境
sandbox: 沙箱环境
development: 开发环境
缺省: release
*/
MidasEnvironment?: string;
/**
* 经办人信息
*/
AgencyClientInfo?: AgencyClientInfo;
}
/**
* QueryOpenBankBankBranchList返回参数结构体
*/
export interface QueryOpenBankBankBranchListResponse {
/**
* 错误码。
__SUCCESS__: 成功
__其他__: 见附录-错误码表
*/
ErrCode: string;
/**
* 错误消息。
注意：此字段可能返回 null，表示取不到有效值。
*/
ErrMessage: string;
/**
* 返回结果。
注意：此字段可能返回 null，表示取不到有效值。
*/
Result: QueryOpenBankBankBranchListResult;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* MigrateOrderRefundQuery返回参数结构体
*/
export interface MigrateOrderRefundQueryResponse {
/**
* 请求成功状态
*/
IsSuccess?: boolean;
/**
* 交易流水号
*/
TradeSerialNo?: string;
/**
* 交易备注
*/
TradeMsg?: string;
/**
* 交易状态：0=交易待处理；1=交易处理中；2=交易处理成功；3=交易失败；4=状态未知
*/
TradeStatus?: number;
/**
* 第三方支付机构支付交易号
注意：此字段可能返回 null，表示取不到有效值。
*/
ThirdChannelOrderId?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* QueryOpenBankPaymentOrder请求参数结构体
*/
export interface QueryOpenBankPaymentOrderRequest {
/**
* 渠道商户号。外部接入平台入驻云企付平台下发。
*/
ChannelMerchantId: string;
/**
* 外部商户订单号。与ChannelOrderId不能同时为空。若传空串即表示忽略该参数。
*/
OutOrderId: string;
/**
* 云平台订单号。与OutOrderId不能同时为空。若调用下单接口时，发生异常，无法取到ChannelOrderId，传空串即可
*/
ChannelOrderId: string;
/**
* 接入环境。沙箱环境填 sandbox。缺省默认调用生产环境。
*/
Environment?: string;
}
/**
* QueryOpenBankBindExternalSubMerchantBankAccount返回参数结构体
*/
export interface QueryOpenBankBindExternalSubMerchantBankAccountResponse {
/**
* 错误码。
__SUCCESS__: 成功
__其他__: 见附录-错误码表
*/
ErrCode: string;
/**
* 错误消息。
*/
ErrMessage: string;
/**
* 返回结果。
注意：此字段可能返回 null，表示取不到有效值。
*/
Result: QueryOpenBankBindExternalSubMerchantBankAccountResult;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UploadOrgFile请求参数结构体
*/
export interface UploadOrgFileRequest {
/**
* 收单系统分配的开放ID
*/
OpenId: string;
/**
* 收单系统分配的密钥
*/
OpenKey: string;
/**
* 存储区域（0私密区，1公共区），请严格按文件要求，上传到不同的区域
*/
Storage: string;
/**
* 文件的md5值（为防止平台多次上传重复文件，文件名为文件md5,且不会覆盖，重复上传返回第一次上传成功的文件路径）
*/
FileMd5: string;
/**
* 文件内容（先将图片转换成二进制，再进行base64加密）
*/
FileContent: string;
/**
* 文件扩展名（png,jpg,gif）
*/
FileExtension: string;
/**
* 沙箱环境填sandbox，正式环境不填
*/
Profile?: string;
}
/**
* GetPayRollAuthResult请求参数结构体
*/
export interface GetPayRollAuthResultRequest {
/**
* 商户系统内部的商家核身单号，要求此参数只能由数字、大小写字母组成，在服务商内部唯一
*/
AuthNumber: string;
/**
* 微信服务商下特约商户的商户号，由微信支付生成并下发
*/
SubMerchantId: string;
}
/**
* RefundTlinxOrder返回参数结构体
*/
export interface RefundTlinxOrderResponse {
/**
* 业务系统返回码，0表示成功，其他表示失败。
*/
ErrCode: string;
/**
* 业务系统返回消息
注意：此字段可能返回 null，表示取不到有效值。
*/
ErrMessage: string;
/**
* 退款响应对象
注意：此字段可能返回 null，表示取不到有效值。
*/
Result: RefundOrderResult;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreatePayMerchant请求参数结构体
*/
export interface CreatePayMerchantRequest {
/**
* 平台编号
*/
PlatformCode: string;
/**
* 渠道方收款商户编号，由渠道方(银行)提 供。
*/
ChannelMerchantNo: string;
/**
* 是否需要向渠道进行 商户信息验证 1:验证
0:不验证
*/
ChannelCheckFlag: string;
/**
* 收款商户名称
*/
MerchantName: string;
/**
* 是否开通 B2B 支付 1:开通 0:不开通 缺省:1
*/
BusinessPayFlag?: string;
}
/**
* QueryContractPayWayList返回参数结构体
*/
export interface QueryContractPayWayListResponse {
/**
* 业务系统返回消息
注意：此字段可能返回 null，表示取不到有效值。
*/
ErrMessage: string;
/**
* 业务系统返回码
*/
ErrCode: string;
/**
* 查询合同支付方式响应对象
注意：此字段可能返回 null，表示取不到有效值。
*/
Result: Array<ContractPayListResult>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* QueryContractPayWayList请求参数结构体
*/
export interface QueryContractPayWayListRequest {
/**
* 收单系统分配的开放ID
*/
OpenId: string;
/**
* 收单系统分配的密钥
*/
OpenKey: string;
/**
* 沙箱环境填sandbox，正式环境不填
*/
Profile?: string;
}
/**
* GetBillDownloadUrl返回参数结构体
*/
export interface GetBillDownloadUrlResponse {
/**
* 业务系统返回码
*/
ErrCode: string;
/**
* 业务系统返回消息
注意：此字段可能返回 null，表示取不到有效值。
*/
ErrMessage: string;
/**
* 账单文件下载地址响应对象
注意：此字段可能返回 null，表示取不到有效值。
*/
Result: BillDownloadUrlResult;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* QueryAssignment请求参数结构体
*/
export interface QueryAssignmentRequest {
/**
* 主播ID
*/
AnchorId: string;
}
/**
* 提交贸易材料结果
*/
export interface ApplyTradeResult {
/**
* 错误码
*/
Code: string;
/**
* 提交贸易材料数据
*/
Data: ApplyTradeData;
}
/**
* 退款子订单列表
*/
export interface RefundOutSubOrderRefundList {
/**
* 平台应退金额
*/
PlatformRefundAmt: number;
/**
* 子订单退款金额
*/
RefundAmt: number;
/**
* 商家应退金额
*/
SubMchRefundAmt: number;
/**
* 子订单号
*/
SubOutTradeNo: string;
/**
* 子退款单号，调用方需要保证 全局唯一性
*/
SubRefundId: string;
}
/**
* UnbindRelateAcct请求参数结构体
*/
export interface UnbindRelateAcctRequest {
/**
* String(22)，商户号（签约客户号）
*/
MrchCode: string;
/**
* STRING(2)，功能标志（1: 解绑）
*/
FunctionFlag: string;
/**
* STRING(32)，交易网会员代码（若需要把一个待绑定账户关联到两个会员名下，此字段可上送两个会员的交易网代码，并且须用“|::|”(右侧)进行分隔）
*/
TranNetMemberCode: string;
/**
* STRING(50)，待解绑的提现账户的账号（提现账号）
*/
MemberAcctNo: string;
/**
* STRING(1027)，保留域
*/
ReservedMsg?: string;
/**
* STRING(12)，接入环境，默认接入沙箱环境。接入正式环境填"prod"
*/
Profile?: string;
}
/**
* UnifiedTlinxOrder返回参数结构体
*/
export interface UnifiedTlinxOrderResponse {
/**
* 业务系统返回消息
注意：此字段可能返回 null，表示取不到有效值。
*/
ErrMessage: string;
/**
* 业务系统返回码，0表示成功，其他表示失败。
*/
ErrCode: string;
/**
* 统一下单响应对象
注意：此字段可能返回 null，表示取不到有效值。
*/
Result: PayOrderResult;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateMerchant请求参数结构体
*/
export interface CreateMerchantRequest {
/**
* 开票平台ID
*/
InvoicePlatformId: number;
/**
* 企业名称
*/
TaxpayerName: string;
/**
* 销方纳税人识别号
*/
TaxpayerNum: string;
/**
* 注册企业法定代表人名称
*/
LegalPersonName: string;
/**
* 联系人
*/
ContactsName: string;
/**
* 联系人手机号
*/
Phone: string;
/**
* 不包含省市名称的地址
*/
Address: string;
/**
* 地区编码
*/
RegionCode: number;
/**
* 市（地区）名称
*/
CityName: string;
/**
* 开票人
*/
Drawer: string;
/**
* 税务登记证图片（Base64）字符串，需小于 3M
*/
TaxRegistrationCertificate: string;
/**
* 联系人邮箱地址
*/
Email?: string;
/**
* 企业电话
*/
BusinessMobile?: string;
/**
* 银行名称
*/
BankName?: string;
/**
* 银行账号
*/
BankAccount?: string;
/**
* 复核人
*/
Reviewer?: string;
/**
* 收款人
*/
Payee?: string;
/**
* 注册邀请码
*/
RegisterCode?: string;
/**
* 不填默认为1，有效状态
0：表示无效；
1:表示有效；
2:表示禁止开蓝票；
3:表示禁止冲红。
*/
State?: string;
/**
* 接收推送的消息地址
*/
CallbackUrl?: string;
/**
* 接入环境。沙箱环境填 sandbox。
*/
Profile?: string;
}
/**
* QueryContractRelateShop返回参数结构体
*/
export interface QueryContractRelateShopResponse {
/**
* 业务系统返回消息
注意：此字段可能返回 null，表示取不到有效值。
*/
ErrMessage: string;
/**
* 业务系统返回码
*/
ErrCode: string;
/**
* 查询合同可关联门店响应对象
注意：此字段可能返回 null，表示取不到有效值。
*/
Result: Array<QueryContractRelateShopResult>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 子商户进件返回结果
*/
export interface CreateOpenBankExternalSubMerchantRegistrationResult {
/**
* 进件状态。
__SUCCESS__: 进件成功
__FAILED__: 进件失败
__PROCESSING__: 进件中
注意：若返回进件中，需要再次调用进件结果查询接口，查询结果。
*/
RegistrationStatus: string;
/**
* 进件返回描述, 例如失败原因等。
注意：此字段可能返回 null，表示取不到有效值。
*/
RegistrationMessage: string;
/**
* 渠道进件序列号。
*/
ChannelRegistrationNo: string;
/**
* 渠道子商户ID。
*/
ChannelSubMerchantId: string;
/**
* 第三方渠道返回信息, 为JSON格式字符串。详情见附录-复杂类型。
注意：此字段可能返回 null，表示取不到有效值。
*/
ExternalReturnData: string;
}
/**
* RefundTlinxOrder请求参数结构体
*/
export interface RefundTlinxOrderRequest {
/**
* 使用门店OpenId
*/
OpenId: string;
/**
* 使用门店OpenKey
*/
OpenKey: string;
/**
* 原始订单的开发者交易流水号
*/
DeveloperNo: string;
/**
* 新退款订单的开发者流水号，同一门店内唯一
*/
RefundOutNo: string;
/**
* 退款订单名称，可以为空
*/
RefundOrderName: string;
/**
* 退款金额（以分为单位，没有小数点）
*/
RefundAmount: string;
/**
* 主管密码，对密码进行SHA-1加密，默认为123456
*/
ShopPassword: string;
/**
* 退款备注
*/
Remark?: string;
/**
* 沙箱环境填sandbox，正式环境不填
*/
Profile?: string;
}
/**
* 查询发票结果
*/
export interface QueryInvoiceResult {
/**
* 错误消息
*/
Message: string;
/**
* 错误码
*/
Code: number;
/**
* 查询发票数据
注意：此字段可能返回 null，表示取不到有效值。
*/
Data: QueryInvoiceResultData;
/**
* 订单数据
注意：此字段可能返回 null，表示取不到有效值。
*/
Order: Order;
}
/**
* QueryAcctBinding返回参数结构体
*/
export interface QueryAcctBindingResponse {
/**
* 总行数
*/
TotalCount: number;
/**
* 银行卡信息列表
*/
BankCardItems: Array<BankCardItem>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 付款人查询数据
*/
export interface QueryPayerinfoData {
/**
* 商户号
*/
MerchantId: string;
/**
* 付款人ID
*/
PayerId: string;
/**
* 审核状态
*/
Status: string;
/**
* 失败原因
注意：此字段可能返回 null，表示取不到有效值。
*/
FailReason: string;
/**
* 付款人类型
*/
PayerType: string;
/**
* 付款人姓名
*/
PayerName: string;
/**
* 付款人证件类型
*/
PayerIdType: string;
/**
* 付款人证件号
*/
PayerIdNo: string;
/**
* 付款人联系电话
注意：此字段可能返回 null，表示取不到有效值。
*/
PayerContactNumber: string;
/**
* 付款人联系邮箱
注意：此字段可能返回 null，表示取不到有效值。
*/
PayerEmailAddress: string;
/**
* 付款人常驻国家或地区编码
*/
PayerCountryCode: string;
/**
* 付款人联系名称
注意：此字段可能返回 null，表示取不到有效值。
*/
PayerContactName: string;
}
/**
* 发票开具明细
*/
export interface CreateInvoiceItem {
/**
* 商品名称
*/
Name: string;
/**
* 税收商品编码
*/
TaxCode: string;
/**
* 不含税商品总价（商品含税价总额/（1+税率））。InvoicePlatformId 为1时，该金额为含税总金额。单位为分。
*/
TotalPrice: number;
/**
* 商品税率
*/
TaxRate: number;
/**
* 商品税额（不含税商品总价*税率）。单位为分
*/
TaxAmount: number;
/**
* 税收商品类别
*/
TaxType?: string;
/**
* 商品规格
*/
Models?: string;
/**
* 商品单位
*/
Unit?: string;
/**
* 商品数量
*/
Total?: string;
/**
* 不含税商品单价。InvoicePlatformId 为1时，该金额为含税单价。
*/
Price?: string;
/**
* 含税折扣总额。单位为分
*/
Discount?: number;
/**
* 优惠政策标志。0：不使用优惠政策；1：使用优惠政策。
*/
PreferentialPolicyFlag?: string;
/**
* 零税率标识：
空：非零税率；
0：出口零税率；
1：免税；
2：不征税；
3：普通零税率。
*/
ZeroTaxFlag?: string;
/**
* 增值税特殊管理。PreferentialPolicyFlag字段为1时，必填。目前仅支持5%(3%，2%，1.5%)简易征税、免税、不征税。
*/
VatSpecialManagement?: string;
}
/**
* 汇出指令申请数据
*/
export interface ApplyOutwardOrderData {
/**
* 商户号
*/
MerchantId: string;
/**
* 对接方汇出指令编号
*/
TransactionId: string;
/**
* 受理状态
*/
Status: string;
}
/**
* 商户支付方式数据
*/
export interface MerchantPayWayData {
/**
* 支付币种
注意：此字段可能返回 null，表示取不到有效值。
*/
PayCurrency: string;
/**
* 支付图标
注意：此字段可能返回 null，表示取不到有效值。
*/
PayIcon: string;
/**
* 支付名称
注意：此字段可能返回 null，表示取不到有效值。
*/
PayInternalName: string;
/**
* 支付简称
注意：此字段可能返回 null，表示取不到有效值。
*/
PayName: string;
/**
* 是否支持退款
注意：此字段可能返回 null，表示取不到有效值。
*/
PaySplitRefund: string;
/**
* 支付标签
注意：此字段可能返回 null，表示取不到有效值。
*/
PayTag: string;
/**
* 支付凭证图标
注意：此字段可能返回 null，表示取不到有效值。
*/
PayTicketIcon: string;
/**
* 支付类型，逗号分隔
注意：此字段可能返回 null，表示取不到有效值。
*/
PayType: string;
/**
* 凭证名称
注意：此字段可能返回 null，表示取不到有效值。
*/
TicketName: string;
}
/**
* 云企付-查询对账单文件下载url
*/
export interface QueryOpenBankDownLoadUrlResult {
/**
* 供下一步请求账单文件的下载地址。
*/
DownloadUrl: string;
/**
* 从 download_url 下载的文件的哈希值，用于校验文件的完整性。
*/
HashValue: string;
/**
* 从 download_url 下载的文件的哈希类型，用于校验文件的完整性。
*/
HashType: string;
}
/**
* QueryOpenBankSubMerchantSignOnline返回参数结构体
*/
export interface QueryOpenBankSubMerchantSignOnlineResponse {
/**
* 错误码。
*/
ErrCode: string;
/**
* 错误信息。
*/
ErrMessage: string;
/**
* 返回结果
注意：此字段可能返回 null，表示取不到有效值。
*/
Result: QueryOpenBankSubMerchantSignOnlineResult;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* BindAccount返回参数结构体
*/
export interface BindAccountResponse {
/**
* 错误码。响应成功："SUCCESS"，其他为不成功。
*/
ErrCode: string;
/**
* 响应消息。
*/
ErrMessage: string;
/**
* 该字段为null。
注意：此字段可能返回 null，表示取不到有效值。
*/
Result: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 蓝票结果数据
*/
export interface CreateInvoiceResultData {
/**
* 开票状态
*/
State: number;
/**
* 发票ID
*/
InvoiceId: string;
/**
* 业务开票号
*/
OrderSn: string;
}
/**
* 客户端信息
*/
export interface CloudClientInfo {
/**
* 场景类型。
wechat_ecommerce渠道 - h5支付方式，此字段必填；
枚举值：
CLIENT_TYPE_UNKNOWN 未知;
CLIENT_TYPE_IOS ios系统;
CLIENT_TYPE_ANDROID 安卓系统;
CLIENT_TYPE_WAP WAP场景;
CLIENT_TYPE_H5 H5场景;
*/
ClientType?: string;
/**
* 应用名称。
*/
AppName?: string;
/**
* 网站URL。
*/
AppUrl?: string;
/**
* IOS平台BundleID。
*/
BundleId?: string;
/**
* Android平台PackageName
*/
PackageName?: string;
}
/**
* 查询会员资金交易信息列表结果
*/
export interface QueryFundsTransactionDetailsResult {
/**
* 本次交易返回查询结果记录数。
*/
ResultCount: number;
/**
* 符合业务查询条件的记录总数。
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalCount: number;
/**
* 结束标志。
__0__：否
__1__：是
注意：此字段可能返回 null，表示取不到有效值。
*/
EndFlag: string;
/**
* 会员资金交易信息数组。
注意：此字段可能返回 null，表示取不到有效值。
*/
TranItemArray: Array<FundsTransactionItem>;
}
/**
* UnbindOpenBankExternalSubMerchantBankAccount请求参数结构体
*/
export interface UnbindOpenBankExternalSubMerchantBankAccountRequest {
/**
* 渠道商户ID。
*/
ChannelMerchantId: string;
/**
* 渠道子商户ID。
*/
ChannelSubMerchantId: string;
/**
* 渠道名称。
__TENPAY__: 商企付
__WECHAT__: 微信支付
__ALIPAY__: 支付宝
*/
ChannelName: string;
/**
* 支付方式。
__EBANK_PAYMENT__: ebank支付
__OPENBANK_PAYMENT__: openbank支付
*/
PaymentMethod: string;
/**
* 绑卡序列号。
*/
BindSerialNo: string;
/**
* 外部申请编号。
*/
OutApplyId: string;
/**
* 通知地址。
*/
NotifyUrl?: string;
/**
* 环境类型。
__release__:生产环境
__sandbox__:沙箱环境
_不填默认为生产环境_
*/
Environment?: string;
}
/**
* 创建红票明细
*/
export interface CreateRedInvoiceItem {
/**
* 订单号
*/
OrderId: string;
/**
* 发票结果回传地址
*/
CallbackUrl?: string;
/**
* 业务开票号
*/
OrderSn?: string;
/**
* 红字信息表编码
*/
RedSerialNo?: string;
/**
* 门店编号
*/
StoreNo?: string;
}
/**
* 添加商户响应对象
*/
export interface AddMerchantResult {
/**
* 系统商户号
注意：此字段可能返回 null，表示取不到有效值。
*/
MerchantNo: string;
}
/**
* 渠道方用户信息
*/
export interface CloudExternalUserInfo {
/**
* 渠道方用户类型
*/
ExternalUserType?: string;
/**
* 渠道方用户ID
*/
ExternalUserId?: string;
}
/**
* QueryOpenBankExternalSubMerchantRegistration请求参数结构体
*/
export interface QueryOpenBankExternalSubMerchantRegistrationRequest {
/**
* 渠道商户号。
*/
ChannelMerchantId: string;
/**
* 渠道进件号，与外部进件号二者选填其一。
*/
ChannelRegistrationNo?: string;
/**
* 外部进件号，与渠道进件号二者选填其一。
*/
OutRegistrationNo?: string;
/**
* 环境类型
__release__:生产环境
__sandbox__:沙箱环境
_不填默认为生产环境_
*/
Environment?: string;
}
/**
* RevokeRechargeByThirdPay请求参数结构体
*/
export interface RevokeRechargeByThirdPayRequest {
/**
* 请求类型此接口固定填：RevokeMemberRechargeThirdPayReq
*/
RequestType: string;
/**
* 商户号
*/
MerchantCode: string;
/**
* 支付渠道
*/
PayChannel: string;
/**
* 子渠道
*/
PayChannelSubId: number;
/**
* 原始充值交易订单号
*/
OrderId: string;
/**
* 父账户账号，资金汇总账号
*/
BankAccountNumber: string;
/**
* 平台短号(银行分配)
*/
PlatformShortNumber: string;
/**
* 聚鑫分配的安全ID
*/
MidasSecretId: string;
/**
* 聚鑫分配的支付主MidasAppId
*/
MidasAppId: string;
/**
* 计费签名
*/
MidasSignature: string;
/**
* 交易流水号
*/
TransSequenceNumber: string;
/**
* 申请撤销的手续费金额,以元为单位
*/
TransFee: string;
/**
* 第三方支付渠道类型 0001-微信 0002-支付宝 0003-京东支付
*/
ThirdPayChannel: string;
/**
* 第三方渠道订单号或流水号
*/
ThirdPayChannelOrderId: string;
/**
* 充值接口银行返回的流水号(FrontSeqNo)
*/
OldFrontSequenceNumber: string;
/**
* 申请撤销的金额
*/
CurrencyAmount: string;
/**
* 单位，1：元，2：角，3：分 目前固定填1
*/
CurrencyUnit: string;
/**
* 币种 目前固定填RMB
*/
CurrencyType: string;
/**
* Midas环境标识
*/
MidasEnvironment: string;
/**
* 保留域
*/
ReservedMessage?: string;
/**
* 备注
*/
Remark?: string;
}
/**
* QueryMerchantInfoForManagement返回参数结构体
*/
export interface QueryMerchantInfoForManagementResponse {
/**
* 商户结果
注意：此字段可能返回 null，表示取不到有效值。
*/
Result: MerchantManagementResult;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateTransferBatch返回参数结构体
*/
export interface CreateTransferBatchResponse {
/**
* 商家批次单号。
商户系统内部的商家批次单号，此参数只能由数字、字母组成，商户系统内部唯一，UTF8编码，最多32个字符。
示例值：plfk2020042013
*/
MerchantBatchNo?: string;
/**
* 微信批次单号。
微信商家转账系统返回的唯一标识。
示例值：1030000071100999991182020050700019480001
*/
BatchId?: string;
/**
* 批次受理成功时返回，遵循rfc3339标准格式。格式为YYYY-MM-DDTHH:mm:ss.sss+TIMEZONE，YYYY-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss.sss表示时分秒毫秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35.120+08:00表示北京时间2015年05月20日13点29分35秒。
示例值：2015-05-20T13:29:35.120+08:00
*/
CreateTime?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* BindAccount请求参数结构体
*/
export interface BindAccountRequest {
/**
* 主播Id
*/
AnchorId: string;
/**
* 1 微信企业付款
2 支付宝转账
3 平安银企直连代发转账
*/
TransferType: number;
/**
* 收款方标识。
微信为open_id；
支付宝为会员alipay_user_id;
平安为收款方银行账号;
*/
AccountNo: string;
/**
* 手机号
*/
PhoneNum: string;
}
/**
* 子商户费率配置查询结果
*/
export interface QueryOpenBankSubMerchantRateConfigureResult {
/**
* 处理状态
SUCCESS: 开通成功
FAILED: 开通失败
PROCESSING: 开通中
*/
DealStatus: string;
/**
* 处理描述
注意：此字段可能返回 null，表示取不到有效值。
*/
DealMessage: string;
}
/**
* QueryCloudChannelData返回参数结构体
*/
export interface QueryCloudChannelDataResponse {
/**
* 外部订单号
注意：此字段可能返回 null，表示取不到有效值。
*/
OutOrderNo: string;
/**
* 渠道订单号
注意：此字段可能返回 null，表示取不到有效值。
*/
ChannelOrderId: string;
/**
* 第三方渠道数据类型
注意：此字段可能返回 null，表示取不到有效值。
*/
ExternalChannelDataType: string;
/**
* 渠道名称
注意：此字段可能返回 null，表示取不到有效值。
*/
Channel: string;
/**
* 第三方渠道数据列表
注意：此字段可能返回 null，表示取不到有效值。
*/
ExternalChannelDataList: Array<CloudExternalChannelData>;
/**
* 子应用ID
注意：此字段可能返回 null，表示取不到有效值。
*/
SubAppId: string;
/**
* 米大师分配的支付主MidasAppId
注意：此字段可能返回 null，表示取不到有效值。
*/
AppId: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UploadExternalAnchorInfo返回参数结构体
*/
export interface UploadExternalAnchorInfoResponse {
/**
* 错误码。响应成功："SUCCESS"，其他为不成功。
*/
ErrCode: string;
/**
* 响应消息。
*/
ErrMessage: string;
/**
* 该字段为null。
注意：此字段可能返回 null，表示取不到有效值。
*/
Result: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* QueryCustAcctIdBalance返回参数结构体
*/
export interface QueryCustAcctIdBalanceResponse {
/**
* String(20)，返回码
*/
TxnReturnCode?: string;
/**
* String(100)，返回信息
*/
TxnReturnMsg?: string;
/**
* String(22)，交易流水号
*/
CnsmrSeqNo?: string;
/**
* STRING(10)，本次交易返回查询结果记录数
注意：此字段可能返回 null，表示取不到有效值。
*/
ResultNum?: string;
/**
* STRING(30)，起始记录号
注意：此字段可能返回 null，表示取不到有效值。
*/
StartRecordNo?: string;
/**
* STRING(2)，结束标志（0: 否; 1: 是）
注意：此字段可能返回 null，表示取不到有效值。
*/
EndFlag?: string;
/**
* STRING(10)，符合业务查询条件的记录总数（重复次数，一次最多返回20条记录）
注意：此字段可能返回 null，表示取不到有效值。
*/
TotalNum?: string;
/**
* 账户信息数组
注意：此字段可能返回 null，表示取不到有效值。
*/
AcctArray?: Array<Acct>;
/**
* STRING(1027)，保留域
注意：此字段可能返回 null，表示取不到有效值。
*/
ReservedMsg?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* QueryOpenBankSubMerchantSignOnline请求参数结构体
*/
export interface QueryOpenBankSubMerchantSignOnlineRequest {
/**
* 渠道商户号。外部平台接入云企付平台下发。必填。
*/
ChannelMerchantId: string;
/**
* 渠道名称。详见附录-枚举类型-ChannelName。
*/
ChannelName: string;
/**
* 外部子商户ID。
*/
OutSubMerchantId?: string;
/**
* 渠道子商户ID。
*/
ChannelSubMerchantId?: string;
}
/**
* CreateRedInvoice请求参数结构体
*/
export interface CreateRedInvoiceRequest {
/**
* 开票平台ID
0 : 高灯
1 : 票易通
*/
InvoicePlatformId: number;
/**
* 红冲明细
*/
Invoices: Array<CreateRedInvoiceItem>;
/**
* 接入环境。沙箱环境填 sandbox。
*/
Profile?: string;
/**
* 开票渠道。0：线上渠道，1：线下渠道。不填默认为线上渠道
*/
InvoiceChannel?: number;
}
/**
* QueryAcctInfoList返回参数结构体
*/
export interface QueryAcctInfoListResponse {
/**
* 本次交易返回查询结果记录数
*/
ResultCount?: number;
/**
* 符合业务查询条件的记录总数
*/
TotalCount?: number;
/**
* 查询结果项 [object,object]
*/
QueryAcctItems?: Array<QueryAcctItem>;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 合约信息
*/
export interface ContractInfo {
/**
* 米大师内部签约商户号
*/
ChannelContractMerchantId: string;
/**
* 米大师内部签约子商户号
注意：此字段可能返回 null，表示取不到有效值。
*/
ChannelContractSubMerchantId: string;
/**
* 米大师内部签约应用ID
注意：此字段可能返回 null，表示取不到有效值。
*/
ChannelContractAppId: string;
/**
* 米大师内部签约子应用ID
注意：此字段可能返回 null，表示取不到有效值。
*/
ChannelContractSubAppId: string;
/**
* 业务合约协议号
*/
OutContractCode: string;
/**
* 第三方渠道用户信息
注意：此字段可能返回 null，表示取不到有效值。
*/
ExternalContractUserInfoList: Array<ExternalContractUserInfo>;
/**
* 签约方式，如 wechat_app ，使用app方式下的微信签
*/
ContractMethod: string;
/**
* 合约场景id
注意：此字段可能返回 null，表示取不到有效值。
*/
ContractSceneId: string;
/**
* 用户信息
*/
UserInfo: ContractUserInfo;
/**
* 第三方渠道签约数据
*/
ExternalContractData: string;
}
/**
* QueryOpenBankExternalSubMerchantBankAccount请求参数结构体
*/
export interface QueryOpenBankExternalSubMerchantBankAccountRequest {
/**
* 渠道商户ID。
*/
ChannelMerchantId: string;
/**
* 渠道子商户ID。
*/
ChannelSubMerchantId: string;
/**
* 渠道名称。
__TENPAY__: 商企付
__WECHAT__: 微信支付
__ALIPAY__: 支付宝
*/
ChannelName: string;
/**
* 支付方式。
__EBANK_PAYMENT__: ebank支付
__OPENBANK_PAYMENT__: openbank支付
*/
PaymentMethod: string;
/**
* 环境类型。
__release__:生产环境
__sandbox__:沙箱环境
_不填默认为生产环境_
*/
Environment?: string;
}
/**
* 结算订单列表
*/
export interface SettlementOrders {
/**
* 列表
注意：此字段可能返回 null，表示取不到有效值。
*/
List: Array<SettlementOrderResult>;
/**
* 总数
注意：此字段可能返回 null，表示取不到有效值。
*/
Count: number;
}
/**
* 第三方渠道合约信息
*/
export interface ExternalReturnContractInfo {
/**
* 第三方渠道协议id
注意：此字段可能返回 null，表示取不到有效值。
*/
ExternalReturnAgreementId: string;
/**
* 第三方渠道协议生效时间戳
注意：此字段可能返回 null，表示取不到有效值。
*/
ExternalReturnContractEffectiveTimestamp: string;
/**
* 第三方渠道协议解约时间戳
注意：此字段可能返回 null，表示取不到有效值。
*/
ExternalReturnContractTerminationTimestamp: string;
/**
* 平台合约状态
协议状态，枚举值：
CONTRACT_STATUS_SIGNED：已签约
CONTRACT_STATUS_TERMINATED：未签约
CONTRACT_STATUS_PENDING：签约进行中
注意：此字段可能返回 null，表示取不到有效值。
*/
ExternalReturnContractStatus: string;
/**
* 第三方渠道请求序列号
注意：此字段可能返回 null，表示取不到有效值。
*/
ExternalReturnRequestId: string;
/**
* 第三方渠道协议签署时间戳
注意：此字段可能返回 null，表示取不到有效值。
*/
ExternalReturnContractSignedTimestamp: string;
/**
* 第三方渠道协议到期时间戳
注意：此字段可能返回 null，表示取不到有效值。
*/
ExternalReturnContractExpiredTimestamp: string;
/**
* 第三方渠道返回的合约数据
注意：此字段可能返回 null，表示取不到有效值。
*/
ExternalReturnContractData: string;
/**
* 第三方渠道解约备注
注意：此字段可能返回 null，表示取不到有效值。
*/
ExternalReturnContractTerminationRemark?: string;
/**
* 第三方渠道协议解约方式
注意：此字段可能返回 null，表示取不到有效值。
*/
ExternalReturnContractTerminationMode?: string;
}
/**
* ExecuteMemberTransaction返回参数结构体
*/
export interface ExecuteMemberTransactionResponse {
/**
* 请求类型
*/
RequestType?: string;
/**
* 银行流水号
*/
FrontSequenceNumber?: string;
/**
* 保留域
注意：此字段可能返回 null，表示取不到有效值。
*/
ReservedMessage?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 公司信息
*/
export interface OrganizationInfo {
/**
* 公司名称，个体工商户必输
*/
OrganizationName?: string;
/**
* 公司证件类型，个体工商户必输，证件类型仅支持73
*/
OrganizationType?: string;
/**
* 公司证件号码，个体工商户必输
*/
OrganizationCode?: string;
/**
* 法人名称，如果SubMchName不是法人，需要另外送入法人信息（企业必输）
<敏感信息>加密详见<a href="https://cloud.tencent.com/document/product/1122/48979" target="_blank">《商户端接口敏感信息加密说明》</a>
*/
LegalPersonName?: string;
/**
* 法人证件类型，如果SubMchName不是法人，需要另外送入法人信息（企业必输）
*/
LegalPersonIdType?: string;
/**
* 法人证件号码，如果SubMchName不是法人，需要另外送入法人信息（企业必输）
<敏感信息>加密详见<a href="https://cloud.tencent.com/document/product/1122/48979" target="_blank">《商户端接口敏感信息加密说明》</a>
*/
LegalPersonIdCode?: string;
}
/**
* 灵云V2-银行信息
*/
export interface FlexFundingAccountInfo {
/**
* 资金账户号
*/
FundingAccountNo?: string;
/**
* 资金账户类型
*/
FundingAccountType?: string;
/**
* 资金账户绑定序列号
*/
FundingAccountBindSerialNo?: string;
/**
* 资金账户名称
*/
FundingAccountName?: string;
}
/**
* ConfirmOrder请求参数结构体
*/
export interface ConfirmOrderRequest {
/**
* 分配给商户的AppId
*/
MerchantAppId: string;
/**
* 平台流水号。消费订单发起成功后，返回的平台唯一订单号。
*/
OrderNo: string;
}
/**
* 渠道扩展促销信息
*/
export interface CloudExternalPromptGroup {
/**
* 渠道名。
为米大师定义的枚举值：
wechat 微信渠道
*/
ChannelName: string;
/**
* 渠道扩展促销信息列表，由各个渠道自行定义。
ChannelName为wechat时，组成为 <Wechat-ExternalPromptInfo>
*/
ExternalPromptInfoList: Array<CloudExternalPromptInfo>;
}
/**
* ModifyFlexPayeeAccountRightStatus返回参数结构体
*/
export interface ModifyFlexPayeeAccountRightStatusResponse {
/**
* 错误码。SUCCESS为成功，其他为失败
*/
ErrCode: string;
/**
* 错误消息
*/
ErrMessage: string;
/**
* 返回结果。默认为空。
注意：此字段可能返回 null，表示取不到有效值。
*/
Result: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyMerchant返回参数结构体
*/
export interface ModifyMerchantResponse {
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 返回的合约信息
*/
export interface ReturnContractInfo {
/**
* 合约信息
*/
ContractInfo: ContractInfo;
/**
* 米大师内部生成的合约信息
*/
ChannelReturnContractInfo: ChannelReturnContractInfo;
/**
* 第三方渠道合约信息
*/
ExternalReturnContractInfo: ExternalReturnContractInfo;
}
/**
* VerifyOpenBankAccount请求参数结构体
*/
export interface VerifyOpenBankAccountRequest {
/**
* 渠道商户号。外部接入平台入驻云企付平台下发
*/
ChannelMerchantId: string;
/**
* 渠道名称。详见附录-云企付枚举类说明-ChannelName。
__TENPAY__: 商企付
*/
ChannelName: string;
/**
* 收款方信息。
*/
PayeeInfo: OpenBankPayeeInfo;
/**
* 通知地址，如www.test.com。
*/
NotifyUrl?: string;
/**
* 环境类型。
__release__:生产环境
__sandbox__:沙箱环境
_不填默认为生产环境_
*/
Environment?: string;
}
/**
* QuerySmallAmountTransfer返回参数结构体
*/
export interface QuerySmallAmountTransferResponse {
/**
* String(20)，返回码
*/
TxnReturnCode?: string;
/**
* String(100)，返回信息
*/
TxnReturnMsg?: string;
/**
* String(22)，交易流水号
*/
CnsmrSeqNo?: string;
/**
* STRING(10)，返回状态（0: 成功; 1: 失败; 2: 待确认）
注意：此字段可能返回 null，表示取不到有效值。
*/
ReturnStatus?: string;
/**
* STRING(512)，返回信息（失败返回具体信息）
注意：此字段可能返回 null，表示取不到有效值。
*/
ReturnMsg?: string;
/**
* STRING(1027)，保留域
注意：此字段可能返回 null，表示取不到有效值。
*/
ReservedMsg?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 查询城市编码响应对象
*/
export interface CityCodeResult {
/**
* 城市编码cityid，数字与字母的结合
注意：此字段可能返回 null，表示取不到有效值。
*/
CityId: string;
/**
* 省份
注意：此字段可能返回 null，表示取不到有效值。
*/
Province: string;
/**
* 县区
注意：此字段可能返回 null，表示取不到有效值。
*/
District: string;
/**
* 城市
注意：此字段可能返回 null，表示取不到有效值。
*/
City: string;
}
/**
* CreateFlexPayee返回参数结构体
*/
export interface CreateFlexPayeeResponse {
/**
* 错误码。SUCCESS为成功，其他为失败
*/
ErrCode: string;
/**
* 错误消息
*/
ErrMessage: string;
/**
* 返回结果
注意：此字段可能返回 null，表示取不到有效值。
*/
Result: CreateFlexPayeeResult;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 第三方子商户银行卡解绑返回结果
*/
export interface UnbindOpenBankExternalSubMerchantBankAccountResult {
/**
* 渠道申请编号。
*/
ChannelApplyId: string;
/**
* 解绑状态。
__SUCCESS__: 解绑成功
__FAILED__: 解绑失败
__PROCESSING__: 解绑中
注意：若返回解绑中，需要再次调用解绑结果查询接口查询结果。
*/
UnbindStatus: string;
/**
* 解绑返回描述, 例如失败原因等。
注意：此字段可能返回 null，表示取不到有效值。
*/
UnbindMessage: string;
}
/**
* QuerySingleTransactionStatus返回参数结构体
*/
export interface QuerySingleTransactionStatusResponse {
/**
* String(20)，返回码
*/
TxnReturnCode?: string;
/**
* String(100)，返回信息
*/
TxnReturnMsg?: string;
/**
* String(22)，交易流水号
*/
CnsmrSeqNo?: string;
/**
* STRING(2)，记账标志（记账标志。1: 登记挂账; 2: 支付; 3: 提现; 4: 清分; 5: 下单预支付; 6: 确认并付款; 7: 退款; 8: 支付到平台; N: 其他）
注意：此字段可能返回 null，表示取不到有效值。
*/
BookingFlag?: string;
/**
* STRING(32)，交易状态（0: 成功; 1: 失败; 2: 待确认; 5: 待处理; 6: 处理中。0和1是终态，2、5、6是中间态，其中2是特指提现后待确认提现是否成功，5是银行收到交易等待处理，6是交易正在处理）
注意：此字段可能返回 null，表示取不到有效值。
*/
TranStatus?: string;
/**
* STRING(20)，交易金额
注意：此字段可能返回 null，表示取不到有效值。
*/
TranAmt?: string;
/**
* STRING(8)，交易日期
注意：此字段可能返回 null，表示取不到有效值。
*/
TranDate?: string;
/**
* STRING(20)，交易时间
注意：此字段可能返回 null，表示取不到有效值。
*/
TranTime?: string;
/**
* STRING(50)，转入子账户账号
注意：此字段可能返回 null，表示取不到有效值。
*/
InSubAcctNo?: string;
/**
* STRING(50)，转出子账户账号
注意：此字段可能返回 null，表示取不到有效值。
*/
OutSubAcctNo?: string;
/**
* STRING(300)，失败信息（当提现失败时，返回交易失败原因）
注意：此字段可能返回 null，表示取不到有效值。
*/
FailMsg?: string;
/**
* STRING(50)，原前置流水号
注意：此字段可能返回 null，表示取不到有效值。
*/
OldTranFrontSeqNo?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateOpenBankMerchant返回参数结构体
*/
export interface CreateOpenBankMerchantResponse {
/**
* 错误码。
__SUCCESS__: 成功
__其他__: 见附录-错误码表
*/
ErrCode: string;
/**
* 错误消息。
*/
ErrMessage: string;
/**
* 返回结果。
注意：此字段可能返回 null，表示取不到有效值。
*/
Result: CreateOpenBankMerchantResult;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 提交申报材料结果
*/
export interface ApplyDeclareData {
/**
* 商户号
*/
MerchantId: string;
/**
* 第三方指令编号
*/
TransactionId: string;
/**
* 受理状态
*/
Status: string;
/**
* 申报流水号
*/
DeclareId: string;
/**
* 原申报流水号
注意：此字段可能返回 null，表示取不到有效值。
*/
OriginalDeclareId: string;
/**
* 付款人ID
*/
PayerId: string;
}
/**
* 批量转账查询返回批次明细实体
*/
export interface TransferDetailResponse {
/**
* 商家明细单号。
商户系统内部的商家明细单号
示例值：plfk2020042013
*/
MerchantDetailNo: string;
/**
* 微信明细单号。
微信区分明细单返回的唯一标识。
示例值：1030000071100999991182020050700019480001
*/
DetailId: string;
/**
* 明细状态。
PROCESSING：转账中，正在处理，结果未明；
SUCCESS：转账成功；
FAIL：转账失败，需要确认失败原因以后，再决定是否重新发起地该笔明细的转账。
示例值：SUCCESS
*/
DetailStatus: string;
}
/**
* 子商户查询签约返回结果
*/
export interface QueryOpenBankSubMerchantSignOnlineResult {
/**
* 处理状态
SUCCESS：签约成功
FAILED：签约失败
PROCESSING：签约中
*/
SignStatus: string;
/**
* 上传返回描述，例如失败原因等
注意：此字段可能返回 null，表示取不到有效值。
*/
SignMessage: string;
}
/**
* QueryOrder请求参数结构体
*/
export interface QueryOrderRequest {
/**
* 聚鑫分配的支付主 MidasAppId
*/
MidasAppId: string;
/**
* 用户ID，长度不小于5位， 仅支持字母和数字的组合
*/
UserId: string;
/**
* type=by_order根据订单号 查订单；
type=by_user根据用户id 查订单 。
*/
Type: string;
/**
* 聚鑫分配的安全ID
*/
MidasSecretId: string;
/**
* 按照聚鑫安全密钥计算的签名
*/
MidasSignature: string;
/**
* 每页返回的记录数。根据用户 号码查询订单列表时需要传。 用于分页展示。Type=by_order时必填
*/
Count?: number;
/**
* 记录数偏移量，默认从0开 始。根据用户号码查询订单列 表时需要传。用于分页展示。Type=by_order时必填
*/
Offset?: number;
/**
* 查询开始时间，Unix时间戳。Type=by_order时必填
*/
StartTime?: string;
/**
* 查询结束时间，Unix时间戳。Type=by_order时必填
*/
EndTime?: string;
/**
* 业务订单号，OutTradeNo与 TransactionId不能同时为 空，都传优先使用 OutTradeNo
*/
OutTradeNo?: string;
/**
* 聚鑫订单号，OutTradeNo与 TransactionId不能同时为 空，都传优先使用 OutTradeNo
*/
TransactionId?: string;
/**
* 环境名:
release: 现网环境
sandbox: 沙箱环境
development: 开发环境
缺省: release
*/
MidasEnvironment?: string;
}
/**
* RevokeMemberRechargeThirdPay返回参数结构体
*/
export interface RevokeMemberRechargeThirdPayResponse {
/**
* String(20)，返回码
*/
TxnReturnCode?: string;
/**
* String(100)，返回信息
*/
TxnReturnMsg?: string;
/**
* String(22)，交易流水号
*/
CnsmrSeqNo?: string;
/**
* STRING(52)，前置流水号
注意：此字段可能返回 null，表示取不到有效值。
*/
FrontSeqNo?: string;
/**
* STRING(300)，保留域1
注意：此字段可能返回 null，表示取不到有效值。
*/
ReservedMsgOne?: string;
/**
* STRING(300)，保留域2
注意：此字段可能返回 null，表示取不到有效值。
*/
ReservedMsgTwo?: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DistributeAccreditTlinx请求参数结构体
*/
export interface DistributeAccreditTlinxRequest {
/**
* 使用门店OpenId
*/
OpenId: string;
/**
* 使用门店OpenKey
*/
OpenKey: string;
/**
* 验证方式，传1手机验证(验证码时效60S)传2结算卡验证(时效6小时)，多种方式用逗号隔开
*/
AuthType: string;
/**
* 分账比例（500=5%）不传默认百分之10
*/
Percent?: string;
/**
* 营业执照商户全称
*/
FullName?: string;
/**
* 沙箱环境填sandbox，正式环境不填
*/
Profile?: string;
}
/**
* 云企付-分页查询对账单数据结果
*/
export interface QueryOpenBankBillData {
/**
* 交易日期
*/
BillDate: string;
/**
* 渠道编码
*/
Channel: string;
/**
* 二级渠道
注意：此字段可能返回 null，表示取不到有效值。
*/
SubChannel: string;
/**
* 系统父商户号
注意：此字段可能返回 null，表示取不到有效值。
*/
ParentMerchantId: string;
/**
* 外部商户号
注意：此字段可能返回 null，表示取不到有效值。
*/
OutMerchantId: string;
/**
* 系统商户号
*/
MerchantId: string;
/**
* 第三方商户号
注意：此字段可能返回 null，表示取不到有效值。
*/
EndMerchantId: string;
/**
* 外部订单号
注意：此字段可能返回 null，表示取不到有效值。
*/
OutTradeNo: string;
/**
* 系统订单号
*/
TradeNo: string;
/**
* 第三方订单号
注意：此字段可能返回 null，表示取不到有效值。
*/
EndTradeNo: string;
/**
* 收付类型，PAYMENT:付款，INCOME:收款
注意：此字段可能返回 null，表示取不到有效值。
*/
PaymentType: string;
/**
* 业务类型，WITHDRAW:提现，PAY:支付，RECHARGE:充值，TRANSFER:转账，REFUND:退款
注意：此字段可能返回 null，表示取不到有效值。
*/
BusinessType: string;
/**
* 发起交易时间，格式yyyy-MM-dd HH:mm:ss
*/
TradeTime: string;
/**
* 交易完成时间，格式yyyy-MM-dd HH:mm:ss
注意：此字段可能返回 null，表示取不到有效值。
*/
FinishTime: string;
/**
* 交易状态，0:未知，1:成功，2:失败
*/
TradeStatus: string;
/**
* 对账状态，1:成功，2:失败 3:长账 4:短账
*/
CheckStatus: string;
/**
* 对账失败原因
注意：此字段可能返回 null，表示取不到有效值。
*/
CheckFailReason: string;
/**
* 交易金额（元）
*/
OrderAmount: string;
/**
* 服务费（元）
注意：此字段可能返回 null，表示取不到有效值。
*/
ServiceFee: string;
/**
* 收款人账号
注意：此字段可能返回 null，表示取不到有效值。
*/
PayeeAccount: string;
/**
* 收款人名称
注意：此字段可能返回 null，表示取不到有效值。
*/
PayeeName: string;
/**
* 付款人账号
注意：此字段可能返回 null，表示取不到有效值。
*/
PayerAccount: string;
/**
* 付款人名称
注意：此字段可能返回 null，表示取不到有效值。
*/
PayerName: string;
/**
* 支付信息描述
注意：此字段可能返回 null，表示取不到有效值。
*/
Description: string;
}
/**
* QueryContractRelateShop请求参数结构体
*/
export interface QueryContractRelateShopRequest {
/**
* 收单系统分配的开放ID
*/
OpenId: string;
/**
* 收单系统分配的密钥
*/
OpenKey: string;
/**
* 合同主键
*/
ContractId: string;
/**
* 沙箱环境填sandbox，正式环境不填
*/
Profile?: string;
}
/**
* 平台账户余额信息
*/
export interface PlatformAccountBalanceResult {
/**
* 收入类型
LABOR:劳务所得
OCCASION:偶然所得
注意：此字段可能返回 null，表示取不到有效值。
*/
IncomeType: string;
/**
* 总余额
注意：此字段可能返回 null，表示取不到有效值。
*/
Balance: string;
/**
* 系统冻结余额
注意：此字段可能返回 null，表示取不到有效值。
*/
SystemFreezeBalance: string;
/**
* 人工冻结余额
注意：此字段可能返回 null，表示取不到有效值。
*/
ManualFreezeBalance: string;
/**
* 可提现余额
注意：此字段可能返回 null，表示取不到有效值。
*/
PayableBalance: string;
/**
* 提现中余额
注意：此字段可能返回 null，表示取不到有效值。
*/
InPayBalance: string;
}
/**
* CreateOpenBankRechargeOrder请求参数结构体
*/
export interface CreateOpenBankRechargeOrderRequest {
/**
* 云企付渠道商户号。外部接入平台入驻云企付平台后下发。
*/
ChannelMerchantId: string;
/**
* 外部订单号,只能是数字、大小写字母，且在同一个接入平台下唯一，限定长度40位。
*/
OutOrderId: string;
/**
* 付款金额，单位分。
*/
TotalAmount: number;
/**
* 固定值CNY。
*/
Currency: string;
/**
* 订单过期时间，yyyy-MM-dd HH:mm:ss格式。
*/
ExpireTime: string;
/**
* 渠道名称。
__TENPAY__: 商企付
__WECHAT__: 微信支付
__ALIPAY__: 支付宝
*/
ChannelName: string;
/**
* 渠道名称。
__TENPAY__: 商企付
__WECHAT__: 微信支付
__ALIPAY__: 支付宝
*/
PaymentMethod: string;
/**
* 收款方信息。
*/
PayeeInfo: OpenBankRechargePayeeInfo;
/**
* 渠道子商户号
*/
ChannelSubMerchantId: string;
/**
* 通知地址，如www.test.com。
*/
NotifyUrl?: string;
/**
* 备注信息。限制200个字符。
*/
Remark?: string;
/**
* 环境类型。
__release__:生产环境
__sandbox__:沙箱环境
_不填默认为生产环境_
*/
Environment?: string;
}
/**
* 渠道透传字段
*/
export interface CloudExternalAttachmentData {
/**
* 渠道名
*/
ChannelName: string;
/**
* 渠道透传字段，由各个渠道自行定义
*/
AttachmentData: string;
}
/**
* QueryExceedingInfo返回参数结构体
*/
export interface QueryExceedingInfoResponse {
/**
* 错误码。
*/
ErrCode: string;
/**
* 错误消息。
*/
ErrMessage: string;
/**
* 超额信息结果。
注意：此字段可能返回 null，表示取不到有效值。
*/
Result: QueryExceedingInfoResult;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AddContract请求参数结构体
*/
export interface AddContractRequest {
/**
* 收单系统分配的开放ID
*/
OpenId: string;
/**
* 收单系统分配的密钥
*/
OpenKey: string;
/**
* 机构合同主键（系统有唯一性校验），建议使用合同表的主键ID，防止重复添加合同
*/
OutContractId: string;
/**
* 合同编号（系统有唯一性校验）
*/
Code: string;
/**
* 支付方式编号
*/
PaymentId: string;
/**
* 支付方式行业分类编号
*/
PaymentClassificationId: string;
/**
* 封顶值（分为单位，无封顶填0）
*/
PaymentClassificationLimit: string;
/**
* 商户编号
*/
MerchantNo: string;
/**
* 签约扣率百分比（如：0.32）
*/
Fee: string;
/**
* 合同生效日期（yyyy-mm-dd）
*/
StartDate: string;
/**
* 合同过期日期（yyyy-mm-dd）
*/
EndDate: string;
/**
* 合同签约人
*/
SignMan: string;
/**
* 签购单名称，建议使用商户招牌名称
*/
SignName: string;
/**
* 合同签署日期（yyyy-mm-dd）
*/
SignDate: string;
/**
* 是否自动续签（1是，0否）
*/
AutoSign: string;
/**
* 联系人
*/
Contact: string;
/**
* 联系人电话
*/
ContactTelephone: string;
/**
* 合同照片【私密区】
*/
PictureOne: string;
/**
* 合同照片【私密区】
*/
PictureTwo?: string;
/**
* 渠道扩展字段，json格式
*/
ChannelExtJson?: string;
/**
* 沙箱环境填sandbox，正式环境不填
*/
Profile?: string;
/**
* 合同选项1（不同支付方式规则不一样，请以支付方式规定的格式传值）
*/
PaymentOptionOne?: string;
/**
* 合同选项2（不同支付方式规则不一样，请以支付方式规定的格式传值）
*/
PaymentOptionTwo?: string;
/**
* 合同选项3（不同支付方式规则不一样，请以支付方式规定的格式传值）
*/
PaymentOptionThree?: string;
/**
* 合同选项4（不同支付方式规则不一样，请以支付方式规定的格式传值）
*/
PaymentOptionFour?: string;
/**
* 合同证书选项1（不同支付方式规则不一样，请以支付方式规定的格式传值）
*/
PaymentOptionFive?: string;
/**
* 合同证书选项2（不同支付方式规则不一样，请以支付方式规定的格式传值）
*/
PaymentOptionSix?: string;
/**
* 合同选项5（不同支付方式规则不一样，请以支付方式规定的格式传值）
*/
PaymentOptionSeven?: string;
/**
* 合同选项6（不同支付方式规则不一样，请以支付方式规定的格式传值）
*/
PaymentOptionOther?: string;
/**
* 合同选项8
*/
PaymentOptionTen?: string;
/**
* 合同选项7（不同支付方式规则不一样，请以支付方式规定的格式传值）
*/
PaymentOptionNine?: string;
}
/**
* CreateAcct返回参数结构体
*/
export interface CreateAcctResponse {
/**
* 聚鑫计费SubAppId，代表子商户
*/
SubAppId: string;
/**
* 银行生成的子商户账户
*/
SubAcctNo: string;
/**
* 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateOpenBankVerificationOrder返回参数结构体
*/
exp