tenyun
Version:
Promise based and chained Tencent Cloud OpenAPI client for NodeJS
2,091 lines (1,946 loc) • 449 kB
TypeScript
/// <reference types="node" />
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** 账户信息 */
declare interface Acct {
/** STRING(50),见证子账户的账号(可重复) */
SubAcctNo: string | null;
/** STRING(10),见证子账户的属性(可重复。1: 普通会员子账号; 2: 挂账子账号; 3: 手续费子账号; 4: 利息子账号; 5: 平台担保子账号) */
SubAcctProperty: string | null;
/** STRING(32),交易网会员代码(可重复) */
TranNetMemberCode: string | null;
/** STRING(150),见证子账户的名称(可重复) */
SubAcctName: string | null;
/** STRING(20),见证子账户可用余额(可重复) */
AcctAvailBal: string | null;
/** STRING(20),见证子账户可提现金额(可重复。开户日期或修改日期) */
CashAmt: string | null;
/** STRING(8),维护日期 */
MaintenanceDate: string | null;
}
/** 添加合同响应对象 */
declare interface AddContractResult {
/** 合同主键 */
ContractId: string | null;
}
/** 添加商户响应对象 */
declare interface AddMerchantResult {
/** 系统商户号 */
MerchantNo: string | null;
}
/** 添加门店响应对象 */
declare interface AddShopResult {
/** 门店编号 */
ShopNo: string | null;
}
/** 经办人信息 */
declare interface AgencyClientInfo {
/** 经办人姓名,存在经办人必输 */
AgencyClientName: string;
/** 经办人证件类型,存在经办人必输 */
AgencyClientGlobalType: string;
/** 经办人证件号,存在经办人必输 */
AgencyClientGlobalId: string;
/** 经办人手机号,存在经办人必输 */
AgencyClientMobile: string;
}
/** 代理商完税证明 */
declare interface AgentTaxPayment {
/** 主播银行账号 */
AnchorId: string;
/** 主播姓名 */
AnchorName: string;
/** 主播身份证 */
AnchorIDCard: string;
/** 纳税的开始时间,格式yyyy-MM-dd */
StartTime: string;
/** 纳税的结束时间,格式yyyy-MM-dd */
EndTime: string;
/** 流水金额。以“分”为单位 */
Amount: number;
/** 应缴税款。以“分”为单位 */
Tax: number;
}
/** 代理商完税证明批次信息 */
declare interface AgentTaxPaymentBatch {
/** 状态消息 */
StatusMsg: string;
/** 批次号 */
BatchNum: number;
/** 录入记录的条数 */
InfoNum: number;
/** 源电子凭证下载地址 */
RawElectronicCertUrl: string;
/** 代理商账号 */
AgentId: string;
/** 文件名 */
FileName: string;
/** 状态码。0表示下载成功 */
StatusCode: number;
/** 渠道号 */
Channel: number;
/** 0-视同,1-个体工商户 */
Type: number;
}
/** 税前金额结果 */
declare interface AmountBeforeTaxResult {
/** 税前金额 */
AmountBeforeTax: string | null;
/** 两位精度税前金额 */
AmountBeforeTaxWithTwoDigitPrecision: string | null;
}
/** 主播签约信息 */
declare interface AnchorContractInfo {
/** 主播ID */
AnchorId: string;
/** 主播名称 */
AnchorName: string;
/** 代理商ID */
AgentId: string;
/** 代理商名称 */
AgentName: string;
/** 主播身份证号 */
IdNo: string;
}
/** 主播扩展信息 */
declare interface AnchorExtendInfo {
/** 扩展信息类型__id_card_no__:身份证号码__id_card_name__:身份证姓名__id_card_front__:身份证图片正面__id_card_back__:身份证图片反面__tax_type__:完税类型:0-自然人,1-个体工商户__channel_account__:渠道账号(_敏感信息_ 使用 __AES128-CBC-PKCS#7__ 加密) */
Type: string;
/** 扩展信息 */
Value: string;
}
/** 提交申报材料结果 */
declare interface ApplyDeclareData {
/** 商户号 */
MerchantId: string;
/** 第三方指令编号 */
TransactionId: string;
/** 受理状态 */
Status: string;
/** 申报流水号 */
DeclareId: string;
/** 原申报流水号 */
OriginalDeclareId: string | null;
/** 付款人ID */
PayerId: string;
}
/** 提交申报材料结果 */
declare interface ApplyDeclareResult {
/** 错误码 */
Code: string;
/** 提交申报材料数据 */
Data: ApplyDeclareData;
}
/** 付款结果 */
declare interface ApplyFlexPaymentResult {
/** 订单ID */
OrderId: string;
/** 税前金额 */
AmountBeforeTax: string;
/** 税后金额 */
AmountAfterTax: string;
/** 税金 */
Tax: string;
/** 增值税 */
Vat: string | null;
/** 个人所得税 */
IndividualIncomeTax: string | null;
/** 附加税总税额 */
AdditionalTaxSum: string | null;
/** 附加税税项。格式为JSON格式 */
AdditionalTaxItem: string | null;
}
/** 结算结果 */
declare interface ApplyFlexSettlementResult {
/** 订单ID */
OrderId: string;
/** 税前金额 */
AmountBeforeTax: string;
/** 税后金额 */
AmountAfterTax: string;
/** 税金 */
Tax: string;
}
/** 申请单笔交易回单结果 */
declare interface ApplyOpenBankOrderDetailReceiptResult {
/** 渠道回单申请ID */
ChannelApplyId: string;
/** 申请状态。SUCCESS:申请成功;FAILED:申请失败;PROCESSING:申请中。注意:若返回申请中,需要再次调用回单申请结果查询接口,查询结果。 */
ReceiptStatus: string;
/** 申请返回描述,例如失败原因等。 */
ReceiptMessage: string | null;
/** 回单下载链接,申请成功时返回。 */
DownloadUrl: string | null;
/** 过期时间,yyyy-MM-dd HH:mm:ss格式。 */
ExpireTime: string | null;
}
/** 云企付结算申请结果 */
declare interface ApplyOpenBankSettleOrderResult {
/** 外部结算流水号 */
OutSettleId: string;
/** 渠道结算流水号 */
ChannelSettleId: string;
/** 退款状态。SUCCESS:结算成功;FAILED:结算失败;PROCESSING:结算中;INIT:初始化;ACCEPT_FAILED:受理失败,底层银行返回订单不存在ACCEPTED:受理成功_UNKNOWN:默认未知 */
SettleStatus: string;
}
/** 子商户在线签约返回结果 */
declare interface ApplyOpenBankSubMerchantSignOnlineResult {
/** 处理状态 SUCCESS:签约成功 FAILED:签约失败 PROCESSING:签约中 */
SignStatus: string;
/** 上传返回描述,例如失败原因等 */
SignMessage: string | null;
/** 第三方渠道返回信息,见渠道特殊说明 */
ExternalReturnData: string | null;
}
/** 汇出指令申请数据 */
declare interface ApplyOutwardOrderData {
/** 商户号 */
MerchantId: string;
/** 对接方汇出指令编号 */
TransactionId: string;
/** 受理状态 */
Status: string;
}
/** 汇出指令申请结果 */
declare interface ApplyOutwardOrderResult {
/** 汇出指令申请数据 */
Data: ApplyOutwardOrderData;
/** 错误码 */
Code: string;
}
/** 付款人申请结果 */
declare interface ApplyPayerinfoData {
/** 商户号 */
MerchantId: string;
/** 付款人ID */
PayerId: string;
/** 状态 */
Status: string;
/** 失败原因 */
FailReason: string | null;
}
/** 付款人申请结果 */
declare interface ApplyPayerinfoResult {
/** 错误码 */
Code: string;
/** 数据 */
Data: ApplyPayerinfoData;
}
/** 申请对账文件结果 */
declare interface ApplyReconciliationFileResult {
/** 申请对账文件的任务ID。 */
ApplyFileId: string;
/** 对账文件申请状态。__I__:申请中__S__:申请成功__F__:申请失败 */
ApplyStatus: string;
/** 申请结果描述。 */
ApplyMessage: string | null;
}
/** 提交贸易材料结果 */
declare interface ApplyTradeData {
/** 商户号 */
MerchantId: string;
/** 贸易材料流水号 */
TradeFileId: string;
/** 交易币种 */
TradeCurrency: string;
/** 交易金额 */
TradeAmount: string;
/** 付款人ID */
PayerId: string;
/** 状态 */
Status: string;
}
/** 提交贸易材料结果 */
declare interface ApplyTradeResult {
/** 错误码 */
Code: string;
/** 提交贸易材料数据 */
Data: ApplyTradeData;
}
/** 分配关系 */
declare interface AssignmentData {
/** 主播ID */
AnchorId: string;
/** 主播名称 */
AnchorName: string;
/** 代理商ID */
AgentId: string;
/** 代理商名称 */
AgentName: string;
}
/** 支行信息 */
declare interface BankBranchInfo {
/** 银行名称。 */
BankName: string;
/** 银行简称。 */
BankAbbreviation: string;
/** 支行名。 */
BankBranchName: string;
/** 联行号。 */
BankBranchId: string;
}
/** 绑卡列表 */
declare interface BankCardItem {
/** 超级网银行号 */
EiconBankBranchId: string;
/** 大小额行号 */
CnapsBranchId: string;
/** 结算账户类型1 – 本行账户2 – 他行账户 */
SettleAcctType: number;
/** 结算账户户名<敏感信息> */
SettleAcctName: string;
/** 开户行名称 */
AcctBranchName: string;
/** 用于提现<敏感信息> */
SettleAcctNo: string;
/** 聚鑫计费SubAppId,代表子商户 */
SubAppId: string;
/** 验证类型1 – 小额转账验证2 – 短信验证 */
BindType: number;
/** 用于短信验证BindType==2时必填<敏感信息> */
Mobile: string;
/** 证件类型 */
IdType: string;
/** 证件号码<敏感信息> */
IdCode: string;
}
/** 机构账单文件下载地址响应对象 */
declare interface BillDownloadUrlResult {
/** 对账单下载地址。GET方式访问,返回zip包,解压后为csv格式文件。 */
DownloadUrl: string | null;
}
/** 第三方子商户银行卡绑定返回结果 */
declare interface BindOpenBankExternalSubMerchantBankAccountResult {
/** 渠道申请编号。 */
ChannelApplyId: string;
/** 绑定状态。__SUCCESS__: 绑定成功__FAILED__: 绑定失败__PROCESSING__: 绑定中。注意:若返回绑定中,需要再次调用绑定结果查询接口,查询结果。 */
BindStatus: string;
/** 绑定返回描述, 例如失败原因等。 */
BindMessage: string | null;
/** 渠道子商户银行账户信息, 为JSON格式字符串(绑定成功状态下返回)。详情见附录-复杂类型。 */
ExternalSubMerchantBankAccountReturnData: string | null;
/** 绑卡序列号。 */
BindSerialNo: string | null;
}
/** 绑定分账收款方响应 */
declare interface BindOpenBankProfitSharePayeeResult {
/** 账户ID。受益人ID */
AccountId: string;
/** 账户号,通联渠道指客户银行账号 */
AccountNo: string;
/** 账户货币。参考附录“币种类型”。 */
Currency: string;
}
/** 营业证件信息 */
declare interface BusinessLicenseInfo {
/** 营业证件类型 IDCARD:身份证 CREDITCODE:统一社会信用代码 */
BusinessLicenseType: string;
/** 营业证件号码 非个人商户上送统一社会信用代码,个人商户上送身份证号码 */
BusinessLicenseNumber: string;
/** 营业证件有效期类型 LONGTERM:长期有效OTHER:非长期有效 */
BusinessLicenseValidityType: string;
/** 营业证件生效日期,yyyy-MM-dd */
BusinessLicenseEffectiveDate: string;
/** 营业证件失效日期,yyyy-MM-dd */
BusinessLicenseExpireDate?: string;
}
/** 米大师内部存放的合约信息 */
declare interface ChannelContractInfo {
/** 外部合约协议号 */
OutContractCode: string;
/** 米大师内部生成的合约协议号 */
ChannelContractCode: string;
}
/** 米大师内部生成的合约信息 */
declare interface ChannelReturnContractInfo {
/** 平台合约状态协议状态,枚举值:CONTRACT_STATUS_SIGNED:已签约CONTRACT_STATUS_TERMINATED:未签约CONTRACT_STATUS_PENDING:签约进行中 */
ContractStatus: string;
/** 米大师内部存放的合约信息 */
ChannelContractInfo: ChannelContractInfo;
}
/** 查询城市编码响应对象 */
declare interface CityCodeResult {
/** 城市编码cityid,数字与字母的结合 */
CityId: string | null;
/** 省份 */
Province: string | null;
/** 县区 */
District: string | null;
/** 城市 */
City: string | null;
}
/** 银行在途清算结果信息 */
declare interface ClearItem {
/** STRING(8),日期(格式: 20190101) */
Date: string | null;
/** STRING(40),子账号类型(子帐号类型。1: 普通会员子账号; 2: 挂账子账号; 3: 手续费子账号; 4: 利息子账号; 5: 平台担保子账号; 7: 在途; 8: 理财购买子帐号; 9: 理财赎回子帐号; 10: 平台子拥有结算子帐号) */
SubAcctType: string | null;
/** STRING(3),对账状态(0: 成功; 1: 失败) */
ReconcileStatus: string | null;
/** STRING(300),对账返回信息 */
ReconcileReturnMsg: string | null;
/** STRING(20),清算状态(0: 成功; 1: 失败; 2: 异常; 3: 待处理) */
ClearingStatus: string | null;
/** STRING(2),清算返回信息 */
ClearingReturnMsg: string | null;
/** STRING(300),待清算总金额 */
TotalAmt: string | null;
}
/** 云企付-关单响应 */
declare interface CloseOpenBankPaymentOrderResult {
/** 外部商户订单号 */
OutOrderId: string;
/** 云企付平台订单号 */
ChannelOrderId: string;
/** 订单状态。关单成功CLOSED */
OrderStatus: string;
}
/** 附加项信息对象 */
declare interface CloudAttachmentInfo {
/** 附加项金额。附加项的金额(必须是正数,单位:分),代表积分的数量、抵扣的金额、溢价的金额、补贴的金额 */
AttachmentAmount: number;
/** 附加项类型。Add:加项;Sub:减项;Point:积分项;Subsidy:补贴项。 */
AttachmentType: string;
/** 附加项名称。当银行作为收单机构可能会对该字段有要求,请向米大师确认。 */
AttachmentName: string;
/** 附加项编号。当银行作为收单机构可能会对该字段有要求,请向米大师确认。 */
AttachmentCode: string;
}
/** 渠道方用户信息 */
declare interface CloudChannelExternalUserInfo {
/** 渠道方用户类型,枚举值:WX_OPENID 微信支付类型ALIPAY_BUYERID 支付宝支付类型 */
ChannelExternalUserType: string;
/** 渠道方用户Id */
ChannelExternalUserId: string;
}
/** 客户端信息 */
declare 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;
}
/** 渠道透传字段 */
declare interface CloudExternalAttachmentData {
/** 渠道名 */
ChannelName: string;
/** 渠道透传字段,由各个渠道自行定义 */
AttachmentData: string;
}
/** 第三方渠道数据信息 */
declare interface CloudExternalChannelData {
/** 第三方渠道数据名。PAYMENT_ORDER_EXTERNAL_REQUEST_DATA: 支付下单请求数据PAYMENT_ORDER_EXTERNAL_RETURN_DATA: 支付下单返回数据PAYMENT_ORDER_EXTERNAL_NOTIFY_DATA: 支付通知数据 */
ExternalChannelDataName: string | null;
/** 第三方渠道数据值。当ExternalChannelDataType=PAYMENT时,反序列化格式请参考[ExternalChannelPaymentDataValue](https://dev.tke.midas.qq.com/juxin-doc-next/apidocs/external-channel-data/QueryExternalChannelData.html#externalchannelpaymentdatavalue) */
ExternalChannelDataValue: string | null;
}
/** 渠道扩展促销信息 */
declare interface CloudExternalPromptGroup {
/** 渠道名。为米大师定义的枚举值:wechat 微信渠道 */
ChannelName: string;
/** 渠道扩展促销信息列表,由各个渠道自行定义。ChannelName为wechat时,组成为 */
ExternalPromptInfoList: CloudExternalPromptInfo[];
}
/** 渠道扩展促销信息 */
declare interface CloudExternalPromptInfo {
/** 优惠商品信息类型。 */
ExternalPromptType: string;
/** 优惠商品信息数据。 */
ExternalPromptValue: string;
/** 优惠商品名称。 */
ExternalPromptName?: string;
}
/** 渠道方用户信息 */
declare interface CloudExternalUserInfo {
/** 渠道方用户类型 */
ExternalUserType?: string;
/** 渠道方用户ID */
ExternalUserId?: string;
}
/** 全局支付时间信息 */
declare interface CloudGlobalPayTimeInfo {
/** 订单开始时间。不指定时默认为当前时间。 */
StartTimestamp?: number;
/** 订单结束时间。逾期将会拒绝下单。不指定时默认为当前时间的7天后结束。 */
ExpireTimestamp?: number;
/** 时区。不指定时默认为28800,表示北京时间(东八区)。 */
TimeOffset?: number;
}
/** 返回订单信息 */
declare interface CloudOrderReturn {
/** 米大师分配的支付主MidasAppId */
AppId: string;
/** 开发者支付订单号 */
OutTradeNo: string;
/** 调用下单接口传进来的子单列表 */
SubOrderList: CloudSubOrderReturn[] | null;
/** 调用下单接口获取的米大师交易订单号 */
TransactionId: string;
/** 用户Id */
UserId: string;
/** 支付渠道wechat:微信支付 */
Channel: string;
/** 物品Id */
ProductId: string;
/** 发货标识,由开发者在调用下单接口的时候传入 */
Metadata: string;
/** ISO货币代码 */
CurrencyType: string;
/** 支付金额,单位:分 */
Amt: number;
/** 订单状态0:初始状态,获取米大师交易订单成功1:拉起米大师支付页面成功,用户未支付2:用户支付成功,正在发货3:用户支付成功,发货失败4:用户支付成功,发货成功5:关单中6:已关单 */
OrderState: string;
/** 下单时间,unix时间戳 */
OrderTime: string;
/** 支付时间,unix时间戳 */
PayTime: string;
/** 支付回调时间,unix时间戳 */
CallBackTime: string;
/** 支付机构订单号 */
ChannelExternalOrderId: string;
/** 米大师内部渠道订单号 */
ChannelOrderId: string;
/** 是否曾退款 */
RefundFlag: string;
/** 用户支付金额 */
CashAmt: string;
/** 抵扣券金额 */
CouponAmt: string;
/** 商品名称 */
ProductName: string;
/** 结算信息 */
SettleInfo: CloudSettleInfo | null;
/** 附加项信息列表 */
AttachmentInfoList: CloudAttachmentInfo[] | null;
/** 渠道方返回的用户信息列表 */
ChannelExternalUserInfoList: CloudChannelExternalUserInfo[] | null;
/** 渠道扩展促销列表 */
ExternalReturnPromptGroupList: CloudExternalPromptGroup[] | null;
/** 场景扩展信息 */
SceneInfo: string | null;
/** 子应用ID */
SubAppId: string | null;
/** 支付场景 */
PayScene: string | null;
/** 支付方式 */
PaymentMethod: string | null;
/** 平台应收金额单位:分,需要注意的是,TotalAmt=TotalPlatformIncome+TotalMchIncome */
TotalPlatformIncome: number | null;
/** 商户应收金额单位:分,需要注意的是,TotalAmt=TotalPlatformIncome+TotalMchIncome */
TotalMchIncome: number | null;
}
/** 结算信息对象 */
declare interface CloudSettleInfo {
/** 是否需要支付确认。0: 不需要支付确认1: 需要支付确认传1时,需要在支付完成后成功调用了《支付确认》接口,该笔订单才会被清分出去 */
NeedToBeConfirmed?: number;
/** 是否指定分账。0: 不指定分账1: 指定分账 */
ProfitSharing?: number;
}
/** 门店信息 */
declare interface CloudStoreInfo {
/** 门店ID。 */
StoreId?: string;
/** 门店名称。 */
StoreName?: string;
/** 门店地址。 */
StoreAddress?: string;
/** 门店地区代码。 */
StoreAreaCode?: string;
/** 设备ID。wechat_ecommerce渠道 - h5支付方式,此字段必填。 */
StoreDeviceId?: string;
}
/** 子订单对象 */
declare interface CloudSubOrder {
/** 子订单号。长度32个字符供参考,部分渠道存在长度更短的情况接入时请联系开发咨询。 */
SubOutTradeNo: string;
/** 支付子商户ID。米大师计费SubAppId,代表子商户。 */
SubAppId: string;
/** 商品名称。业务自定义的子订单商品名称,无需URL编码,长度限制以具体所接入渠道为准。 */
ProductName: string;
/** 商品详情。业务自定义的子订单商品详情,无需URL编码,长度限制以具体所接入渠道为准。 */
ProductDetail: string;
/** 平台应收。子订单平台应收金额,单位:分,需要注意的是Amt = PlatformIncome+SubMchIncome。 */
PlatformIncome: number;
/** 商户应收。子订单结算应收金额,单位:分,需要注意的是Amt = PlatformIncome+SubMchIncome。 */
SubMchIncome: number;
/** 透传字段。发货标识,由开发者在调用米大师下单接口的 时候下发。 */
Metadata: string;
/** 支付金额。子订单支付金额,需要注意的是Amt = PlatformIncome+SubMchIncome。 */
Amt: number;
/** 原始金额。子订单原始金额,OriginalAmt>=Amt。 */
OriginalAmt: number;
/** 微信子商户号。 */
WxSubMchId?: string;
/** 结算信息。例如是否需要分账、是否需要支付确认等。 */
SettleInfo?: CloudSettleInfo;
/** 附加项信息列表。例如溢价信息、抵扣信息、积分信息、补贴信息通过该字段可以实现渠道方的优惠抵扣补贴等营销功能。 */
AttachmentInfoList?: CloudAttachmentInfo[];
/** 渠道透传数据列表。 */
ExternalAttachmentDataList?: CloudExternalAttachmentData[];
}
/** 退款子单 */
declare interface CloudSubOrderRefund {
/** 子订单退款金额 */
RefundAmt: number;
/** 平台应退金额 */
PlatformRefundAmt: number;
/** 商家应退金额 */
SubMchRefundAmt: number;
/** 子订单号 */
SubOutTradeNo: string;
/** 子退款单号,调用方需要保证全局唯一性 */
SubRefundId: string;
}
/** 子订单详情 */
declare interface CloudSubOrderReturn {
/** 子订单号 */
SubOutTradeNo: string;
/** 米大师计费SubAppId,代表子商户 */
SubAppId: string;
/** 子订单商品名称 */
ProductName: string;
/** 子订单商品详情 */
ProductDetail: string;
/** 子订单平台应收金额,单位:分 */
PlatformIncome: number;
/** 子订单结算应收金额,单位:分 */
SubMchIncome: number;
/** 子订单支付金额 */
Amt: number;
/** 子订单原始金额 */
OriginalAmt: number;
/** 核销状态,1表示核销,0表示未核销 */
SettleCheck: number;
/** 结算信息 */
SettleInfo: CloudSettleInfo | null;
/** 透传字段,由开发者在调用米大师下单接口的时候下发 */
Metadata: string;
/** 附加项信息 */
AttachmentInfoList: CloudAttachmentInfo | null;
/** 渠道方应答的订单号,透传处理 */
ChannelExternalSubOrderId: string;
/** 微信子商户号 */
WxSubMchId: string;
/** 米大师侧渠道子订单号 */
ChannelSubPayOrderId: string | null;
/** 物品ID */
ProductId: string | null;
}
/** 子单退款信息 */
declare interface CloudSubRefundItem {
/** 渠道方应答的退款ID,透传处理 */
ChannelExternalRefundId: string | null;
/** 渠道方应答的订单号,透传处理 */
ChannelExternalOrderId: string | null;
/** 子单退款金额 */
RefundAmt: number | null;
/** 子单订单号 */
SubOutTradeNo: string | null;
/** 子单退款id */
SubRefundId: string | null;
/** 子应用ID */
SubAppId: string | null;
/** 渠道子单支付订单号 */
ChannelSubOrderId: string | null;
/** 渠道子退款订单号 */
ChannelSubRefundId: string | null;
}
/** 公司抬头结果 */
declare interface CompanyTitleResult {
/** 公司银行账号 */
CompanyBankAccount: string | null;
/** 公司地址 */
CompanyAddress: string | null;
/** 公司税号 */
CompanyTaxpayerNum: string | null;
/** 公司名称 */
CompanyName: string | null;
/** 公司银行名称 */
CompanyBankName: string | null;
/** 公司电话 */
CompanyPhone: string | null;
}
/** 合约信息 */
declare interface ContractInfo {
/** 米大师内部签约商户号 */
ChannelContractMerchantId: string;
/** 米大师内部签约子商户号 */
ChannelContractSubMerchantId: string | null;
/** 米大师内部签约应用ID */
ChannelContractAppId: string | null;
/** 米大师内部签约子应用ID */
ChannelContractSubAppId: string | null;
/** 业务合约协议号 */
OutContractCode: string;
/** 第三方渠道用户信息 */
ExternalContractUserInfoList: ExternalContractUserInfo[] | null;
/** 签约方式,如 wechat_app ,使用app方式下的微信签 */
ContractMethod: string;
/** 合约场景id */
ContractSceneId: string | null;
/** 用户信息 */
UserInfo: ContractUserInfo;
/** 第三方渠道签约数据 */
ExternalContractData: string;
}
/** 支付中签约子订单列表 */
declare interface ContractOrderInSubOrder {
/** 子订单结算应收金额,单位: 分 */
SubMchIncome: number;
/** 子订单平台应收金额,单位:分 */
PlatformIncome: number;
/** 子订单商品详情 */
ProductDetail: string;
/** 子订单商品名称 */
ProductName: string;
/** 聚鑫计费SubAppId,代表子商户 */
SubAppId: string;
/** 子订单号 */
SubOutTradeNo: string;
/** 子订单支付金额 */
Amt: number;
/** 子订单原始金额 */
OriginalAmt: number;
/** 发货标识,由业务在调用聚鑫下单接口的 时候下发 */
Metadata?: string;
}
/** 合同-支付方式列表响应对象 */
declare interface ContractPayListResult {
/** 支付方式编号 */
PaymentId: string | null;
/** 支持的交易类型(多个以小写逗号分开,0现金,1刷卡,2主扫,3被扫,4JSPAY,5预授权) */
PaymentType: string | null;
/** 支付标签 */
PaymentTag: string | null;
/** 支付方式图片url路径 */
PaymentIcon: string | null;
/** 付款方式名称 */
PaymentName: string | null;
/** 付款方式名称(内部名称) */
PaymentInternalName: string | null;
/** 支付方式 */
PaymentOptionOne?: string | null;
/** 支付方式 */
PaymentOptionTwo?: string | null;
/** 支付方式 */
PaymentOptionThree?: string | null;
/** 支付方式 */
PaymentOptionFour?: string | null;
/** 支付方式 */
PaymentOptionFive?: string | null;
/** 支付方式 */
PaymentOptionSix?: string | null;
/** 支付方式 */
PaymentOptionSeven?: string | null;
/** 支付方式 */
PaymentOptionOther?: string | null;
/** 支付方式 */
PaymentOptionNine?: string | null;
/** 支付方式 */
PaymentOptionTen?: string | null;
}
/** 签约同步信息 */
declare interface ContractSyncInfo {
/** 第三方渠道合约信息 */
ExternalReturnContractInfo: ExternalReturnContractInfo;
/** 第三方渠道用户信息 */
ExternalContractUserInfo: ExternalContractUserInfo[];
/** 签约方式,枚举值,CONTRACT_METHOD_WECHAT_INVALID: 无效CONTRACT_METHOD_WECHAT_APP: 微信APPCONTRACT_METHOD_WECHAT_PUBLIC: 微信公众号CONTRACT_METHOD_WECHAT_MINIPROGRAM: 微信小程序CONTRACT_METHOD_WECHAT_H5: 微信H5 */
ContractMethod?: string;
/** 在米大师侧分配的场景id */
ContractSceneId?: string;
/** 调用方从第三方渠道查询到的签约数据,由各个渠道定义 */
ExternalReturnContractData?: string;
}
/** 用户信息 */
declare interface ContractUserInfo {
/** USER_ID: 用户IDANONYMOUS: 匿名类型用户ID */
UserType: string;
/** 用户类型 */
UserId: string;
}
/** CreateBatchPayment接口BatchInfo对象 */
declare interface CreateBatchPaymentBatchData {
/** 订单号 */
OrderId: string | null;
/** 交易流水号 */
TradeSerialNo: string | null;
/** 交易状态。0 处理中 1 预占成功 2 交易成功 3 交易失败 4 未知渠道异常 5 预占额度失败6 提交成功7 提交失败8 订单重复提交99 未知系统异常 */
Status: number | null;
/** 状态描述 */
StatusDesc: string | null;
/** 代理商ID */
AgentId: string | null;
/** 代理商名称 */
AgentName: string | null;
}
/** CreateBatchPayment接口返回响应 */
declare interface CreateBatchPaymentData {
/** 批次号 */
BatchId: string;
/** 批次列表详情 */
BatchInfoList: CreateBatchPaymentBatchData[] | null;
}
/** CreateBatchPayment转账明细 */
declare interface CreateBatchPaymentRecipient {
/** 转账金额 */
TransferAmount: number;
/** 订单号 */
OrderId: string;
/** 主播ID(与主播业务ID不能同时为空,两者都填取主播ID) */
AnchorId?: string;
/** 主播业务ID(与主播业务ID不能同时为空,两者都填取主播ID) */
Uid?: string;
/** 主播名称。如果该字段填入,则会对AnchorName和AnchorId/Uid进行校验。 */
AnchorName?: string;
/** 业务备注 */
Remark?: string;
/** 子单请求预留字段 */
ReqReserved?: string;
}
/** 创建第三方电子记账本返回值 */
declare interface CreateExternalAccountBookResult {
/** 处理状态。__SUCCESS__: 成功__FAILED__: 失败__PROCESSING__: 进行中。 */
DealStatus: string;
/** 处理返回描述,例如失败原因等 */
DealMessage: string | null;
/** 渠道电子记账本ID */
ChannelAccountBookId: string | null;
/** 电子记账本对外收款的账户信息。为JSON格式字符串(成功状态下返回)。详情见附录-复杂类型。 */
CollectMoneyAccountInfo: string | null;
}
/** CreateExternalAnchor接口返回参数 */
declare interface CreateExternalAnchorData {
/** 主播Id */
AnchorId: string;
}
/** 账户开立结果 */
declare interface CreateFlexPayeeResult {
/** 收款用户ID */
PayeeId: string;
}
/** 发票开具明细 */
declare 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;
}
/** 发票结果 */
declare interface CreateInvoiceResult {
/** 错误消息 */
Message: string;
/** 错误码 */
Code: number;
/** 数据 */
Data: CreateInvoiceResultData | null;
}
/** 蓝票结果数据 */
declare interface CreateInvoiceResultData {
/** 开票状态 */
State: number;
/** 发票ID */
InvoiceId: string;
/** 业务开票号 */
OrderSn: string;
}
/** 发票结果V2 */
declare interface CreateInvoiceResultV2 {
/** 发票ID */
InvoiceId: string;
}
/** 创建商户结果 */
declare interface CreateMerchantResult {
/** 状态码 */
Code: number;
/** 响应消息 */
Message: string;
/** 创建商户结果数据 */
Data: CreateMerchantResultData | null;
}
/** 创建商户结果数据 */
declare interface CreateMerchantResultData {
/** 企业名称 */
TaxpayerName: string;
/** 请求流水号 */
SerialNo: string;
/** 纳税号 */
TaxpayerNum: string;
}
/** 聚合支付子商户线上入驻结果 */
declare interface CreateOpenBankExternalAggregatedSubMerchantRegistrationResult {
/** 进件状态 SUCCESS: 进件成功 FAILED: 进件失败PROCESSING: 进件中 注意:若返回进件中,需要再次调用进件结果查询接口,查询结果。 */
RegistrationStatus: string;
/** 进件返回描述 */
RegistrationMessage: string | null;
/** 渠道进件序列号 */
ChannelRegistrationNo: string;
/** 渠道子商户ID */
ChannelSubMerchantId: string;
}
/** 子商户进件返回结果 */
declare interface CreateOpenBankExternalSubMerchantRegistrationResult {
/** 进件状态。__SUCCESS__: 进件成功__FAILED__: 进件失败__PROCESSING__: 进件中注意:若返回进件中,需要再次调用进件结果查询接口,查询结果。 */
RegistrationStatus: string;
/** 进件返回描述, 例如失败原因等。 */
RegistrationMessage: string | null;
/** 渠道进件序列号。 */
ChannelRegistrationNo: string;
/** 渠道子商户ID。 */
ChannelSubMerchantId: string;
/** 第三方渠道返回信息, 为JSON格式字符串。详情见附录-复杂类型。 */
ExternalReturnData: string | null;
}
/** 创建渠道商户返回结果 */
declare interface CreateOpenBankMerchantResult {
/** 渠道商户ID。 */
ChannelMerchantId: string;
}
/** 云企付-支付下单返回响应 */
declare interface CreateOpenBankOrderPaymentResult {
/** 云企付平台订单号。 */
ChannelOrderId: string;
/** 第三方支付平台返回支付订单号。 */
ThirdPayOrderId: string | null;
/** 跳转参数渠道为TENPAY,付款方式为EBANK_PAYMENT时必选。 */
RedirectInfo: OpenBankRedirectInfo | null;
/** 外部商户订单号,只能是数字、大小写字母,且在同一个接入平台下唯一。 */
OutOrderId: string;
/** 渠道扩展支付信息 */
PayInfo: string | null;
/** 渠道扩展支付信息类型 */
PayInfoType: string | null;
}
/** 云企付-充值下单返回响应 */
declare interface CreateOpenBankOrderRechargeResult {
/** 云企付平台订单号。 */
ChannelOrderId: string;
/** 第三方支付平台返回支付订单号。 */
ThirdPayOrderId: string | null;
/** 跳转参数 */
RedirectInfo: OpenBankRechargeRedirectInfo | null;
/** 外部商户订单号,只能是数字、大小写字母,且在同一个接入平台下唯一。 */
OutOrderId: string;
/** 充值状态 */
DealStatus: string | null;
/** 充值返回描述 */
DealMessage: string | null;
/** PC web端跳转链接 */
PcWebUrl: string | null;
}
/** 聚合支付子商户费率配置结果 */
declare interface CreateOpenBankSubMerchantRateConfigureResult {
/** 处理状态 SUCCESS: 开通成功 FAILED: 开通失败PROCESSING: 开通中 注意:若返回开通中,需要再次调用费率配置结果查询接口,查询结果。 */
DealStatus: string;
/** 处理描述 */
DealMessage: string | null;
/** 渠道产品费率序列号 */
ChannelProductFeeNo: string;
}
/** 云企付-支付下单返回响应 */
declare interface CreateOpenBankUnifiedOrderPaymentResult {
/** 云企付平台订单号。 */
ChannelOrderId: string;
/** 第三方支付平台返回支付订单号。 */
ThirdPayOrderId: string | null;
/** 跳转参数渠道为TENPAY,付款方式为EBANK_PAYMENT时必选。 */
RedirectInfo: OpenBankOrderRedirectInfo | null;
/** 外部商户订单号,只能是数字、大小写字母,且在同一个接入平台下唯一。 */
OutOrderId: string;
/** 渠道扩展支付信息 */
PayInfo: string | null;
/** 渠道扩展支付信息类型 */
PayInfoType: string | null;
}
/** 云企付-核销确认收货申请响应结果 */
declare interface CreateOpenBankVerificationResult {
/** 云企付渠道核销订单号 */
ChannelVerificationId: string;
/** 第三方支付渠道核销订单号 */
ThirdVerificationId: string;
/** 核销状态INIT("INIT","初始化"),SUCCESS("SUCCESS","核销成功"),FAILED("FAILED","核销失败"),PROCESSING("PROCESSING","核销中"); */
VerificationStatus: string;
/** 核销金额,单位分 */
VerificationAmount: number;
/** 渠道附加返回信息,一般情况可以不关注 */
ThirdVerificationReturnInfo: string | null;
}
/** 创建红票明细 */
declare interface CreateRedInvoiceItem {
/** 订单号 */
OrderId: string;
/** 发票结果回传地址 */
CallbackUrl?: string;
/** 业务开票号 */
OrderSn?: string;
/** 红字信息表编码 */
RedSerialNo?: string;
/** 门店编号 */
StoreNo?: string;
}
/** 红票结果 */
declare interface CreateRedInvoiceResult {
/** 错误消息 */
Message: string;
/** 错误码 */
Code: number;
/** 红票数据 */
Data: CreateRedInvoiceResultData[] | null;
}
/** 红票结果数据 */
declare interface CreateRedInvoiceResultData {
/** 红冲状态码 */
Code: number;
/** 红冲状态消息 */
Message: string;
/** 发票ID */
InvoiceId: string;
/** 业务开票号 */
OrderSn: string;
}
/** 红票结果V2 */
declare interface CreateRedInvoiceResultV2 {
/** 红票ID */
InvoiceId: string;
}
/** CreateSinglePayment接口返回响应 */
declare interface CreateSinglePaymentData {
/** 平台交易流水号,唯一 */
TradeSerialNo: string;
/** 代理商ID */
AgentId: string | null;
/** 代理商名称 */
AgentName: string | null;
}
/** 分账授权申请查询响应对象 */
declare interface DistributeAccreditQueryResult {
/** 状态(0-未开通,1-已开通,2-商户主动关闭,3-待审核,4-冻结,5-注销,6-待签合同) */
Status: string | null;
/** 合同h5地址 */
ContractUrl?: string | null;
/** 说明 */
Remark?: string | null;
}
/** 授权申请响应对象 */
declare interface DistributeAccreditResult {
/** 合同h5地址 */
ContractUrl: string | null;
/** 系统商户号 */
MerchantNo: string | null;
}
/** 分账撤销响应对象 */
declare interface DistributeCancelResult {
/** 分账订单状态(0初始1成功2失败3撤销) */
Status?: string | null;
/** 平台交易订单号 */
OrderNo?: string | null;
/** 商户分账单号 */
OutDistributeNo?: string | null;
/** 平台分账单号 */
DistributeNo?: string | null;
}
/** 分账申请响应对象 */
declare interface DistributeMultiApplyResult {
/** 分账状态(0分账初始 1分账成功 2分账失败) */
Status?: string | null;
/** 平台分账单号 */
DistributeNo?: string | null;
/** 入账日期,yyyy-MM-dd格式 */
InDate?: string | null;
/** 分账金额 */
Amount?: string | null;
/** 商户分账单号 */
OutDistributeNo?: string | null;
/** 平台支付单号 */
OrderNo?: string | null;
}
/** 分账结果响应对象 */
declare interface DistributeQueryResult {
/** 分账订单列表 */
Orders?: MultiApplyOrder[] | null;
}
/** 分账接收方响应对象 */
declare interface DistributeReceiverResult {
/** 商户编号 */
MerchantNo?: string | null;
}
/** 上传下载响应对象 */
declare interface DownloadFileResult {
/** 文件内容(base64加密的二进制内容) */
Content: string | null;
/** 存储区域(0私密区,1公共区),请严格按文件要求,上传到不同的区域 */
Storage: string | null;
}
/** 第三方渠道用户信息 */
declare interface ExternalContractUserInfo {
/** 第三方用户类型,例如: WX_OPENID, WX_SUB_OPENID,WX_PAYER_OPENID */
ExternalUserType: string;
/** 第三方用户ID */
ExternalUserId: string;
}
/** 第三方渠道合约信息 */
declare interface ExternalReturnContractInfo {
/** 第三方渠道协议id */
ExternalReturnAgreementId: string | null;
/** 第三方渠道协议生效时间戳 */
ExternalReturnContractEffectiveTimestamp: string | null;
/** 第三方渠道协议解约时间戳 */
ExternalReturnContractTerminationTimestamp: string | null;
/** 平台合约状态协议状态,枚举值:CONTRACT_STATUS_SIGNED:已签约CONTRACT_STATUS_TERMINATED:未签约CONTRACT_STATUS_PENDING:签约进行中 */
ExternalReturnContractStatus: string | null;
/** 第三方渠道请求序列号 */
ExternalReturnRequestId: string | null;
/** 第三方渠道协议签署时间戳 */
ExternalReturnContractSignedTimestamp: string | null;
/** 第三方渠道协议到期时间戳 */
ExternalReturnContractExpiredTimestamp: string | null;
/** 第三方渠道返回的合约数据 */
ExternalReturnContractData: string | null;
/** 第三方渠道解约备注 */
ExternalReturnContractTerminationRemark?: string | null;
/** 第三方渠道协议解约方式 */
ExternalReturnContractTerminationMode?: string | null;
}
/** 分段计费区间信息 */
declare interface FeeRangInfo {
/** 卡类型,银联产品使用 DEBIT:借记卡 CREDIT:贷记卡 */
CardType: string;
/** 区间起始金额,单位(分) */
RangeStartValue: number;
/** 区间结束金额,单位(分) */
RangeEndValue: number;
/** 分段计费模式 SINGLE:按金额计费 RATIO:按费率计费 */
RangeFeeMode: string;
/** 费用值,单位(0.01%或分) */
FeeValue: number;
/** 最低收费金额,单位(分) */
MinFee?: number;
/** 最高收费金额,单位(分) */
MaxFee?: number;
}
/** 对账文件信息 */
declare interface FileItem {
/** STRING(256),文件名称 */
FileName: string | null;
/** STRING(120),随机密码 */
RandomPassword: string | null;
/** STRING(512),文件路径 */
FilePath: string | null;
/** STRING(64),提取码 */
DrawCode: string | null;
}
/** 对账单文件下载链接 */
declare interface FlexBillDownloadUrlResult {
/** 对账单文件下载链接 */
Url: string;
/** 下载链接过期时间 */
ExpireTime: string;
}
/** 灵云V2-银行信息 */
declare interface FlexFundingAccountInfo {
/** 资金账户号 */
FundingAccountNo?: string;
/** 资金账户类型 */
FundingAccountType?: string;
/** 资金账户绑定序列号 */
FundingAccountBindSerialNo?: string;
/** 资金账户名称 */
FundingAccountName?: string;
}
/** 冻结余额结果 */
declare interface FreezeFlexBalanceResult {
/** 冻结订单ID */
OrderId: string;
}
/** 冻结单结果 */
declare interface FreezeOrderResult {
/** 税前金额 */
AmountBeforeTax: string;
/** 收入类型LABOR:劳务所得OCCASION:偶然所得 */
IncomeType: string;
/** 外部订单ID */
OutOrderId: string;
/** 订单ID */
OrderId: string;
/** 操作类型FREEZE:冻结UNFREEZE:解冻 */
OperationType: string;
/** 发起时间 */
InitiateTime: string;
/** 完成时间 */
FinishTime: string | null;
/** 状态ACCEPTED:已受理ACCOUNTED:已记账SUCCEED:已成功FAILED:已失败 */
Status: string;
/** 状态描述 */
StatusDesc: string;
/** 冻结备注 */
Remark: string | null;
/** 收款用户ID */
PayeeId: string;
/** 外部用户ID */
OutUserId: string;
}
/** 冻结订单列表 */
declare interface FreezeOrders {
/** 列表 */
List: FreezeOrderResult[] | null;
/** 总数 */
Count: number | null;
}
/** 会员资金交易明细信息 */
declare interface FundsTransactionItem {
/** 资金交易类型。__1__:提现/退款__2__:清分/充值 */
TransType: string;
/** 银行记账说明。 */
BankBookingMessage: string | null;
/** 交易状态。__0__:成功 */
TranStatus: string;
/** 业务方会员标识。_平安渠道为交易网会员代码_ */
TransNetMemberCode: string | null;
/** 子账户账号。_平安渠道为见证子账户的账号_ */
SubAccountNumber: string;
/** 子账户名称。_平安渠道为见证子账户的户名_ */
SubAccountName: string | null;
/** 交易金额。 */
TransAmount: string;
/** 交易手续费。 */
TransFee: string | null;
/** 交易日期,格式:yyyyMMdd。 */
TransDate: string;
/** 交易时间,格式:HHmmss。 */
TransTime: string | null;
/** 银行系统流水号。_平安渠道为见证系统流水号_ */
BankSequenceNumber: string;
/** 备注。_平安渠道,如果是见证+收单的交易,返回交易订单号_ */
Remark: string | null;
}
/** 商户法人代表信息 */
declare interface LegalPersonInfo {
/** 证件类型 IDCARD:身份证 PASSPORT:护照 SOLDIERSCERTIFICATE:士兵证 OFFICERSCERTIFICATE:军官证 GATXCERTIFICATE:香港居民来往内地通行证 TWNDCERTIFICATE:台湾同胞来往内地通行证 MACAOCERTIFICATE:澳门来往内地通行证 */
IdType: string;
/** 证件号码 */
IdNumber: string;
/** 姓名 */
PersonName: string;
/** 证件有效期类型 LONGTERM:长期有效 OTHER:非长期有效 */
IdValidityType: string;
/** 证件生效日期,yyyy-MM-dd */
IdEffectiveDate: string;
/** 联系电话 */
ContactPhone: string;
/** 证件失效日期,yyyy-MM-dd */
IdExpireDate?: string;
/** 联系地址 */
ContactAddress?: string;
/** 邮箱地址 */
EmailAddress?: string;
}
/** 会员间交易明细信息 */
declare interface MemberTransactionItem {
/** 交易类型。__1__:转出__2__:转入 */
TransType: string;
/** 交易状态。__0__:成功 */
TranStatus: string;
/** 交易金额。 */
TransAmount: string;
/** 交易日期,格式:yyyyMMdd。 */
TransDate: string;
/** 交易时间,格式:HHmmss。 */
TransTime: string | null;
/** 银行系统流水号。_平安渠道为见证系统流水号_ */
BankSequenceNumber: string;
/** 银行记账类型。_平安渠道为:__1:会员支付__2:会员冻结__3:会员解冻__4:登记挂账__6:下单预支付__7:确认并付款__8:会员退款__22:见证+收单平台调账__23:见证+收单资金冻结__24:见证+收单资金解冻__25:会员间交易退款_ */
BankBookingType: string | null;
/** 转入方子账户账号。_平安渠道为转入见证子账户的账号_ */
InSubAccountNumber: string;
/** 转出方子账户账号。_平安渠道为转出见证子账户的账号_ */
OutSubAccountNumber: string;
/** 备注。_平安渠道,如果是见证+收单的交易,返回交易订单号_ */
Remark: string | null;
}
/** 商户分类 */
declare interface MerchantClassificationId {
/** 分类编号 */
Code?: string;
/** 分类名称 */
Name?: string;
/** 父级编号(0为一级编号,大于0为父级分类编号) */
Parent?: string;
}
/** 商户查询管理端列表 */
declare interface MerchantManagementList {
/** 企业名称。 */
TaxpayerName: string;
/** 纳税人识别号(税号) 。 */
TaxpayerNum: string;
/** 请求流水号。 */
SerialNo: string;
/** 开票系统ID */
InvoicePlatformId: number;
}
/** 商户管理端结果 */
declare interface MerchantManagementResult {
/** 总数。 */
Total: number;
/** 商户列表。 */
List: MerchantManagementList[];
}
/** 商户支付方式数据 */
declare interface MerchantPayWayData {
/** 支付币种 */
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 | null;
}
/** 商户风险信息 */
declare interface MerchantRiskInfo {
/** 恶意注册等级,0-9级,9级最高 */
RiskLevel: number | null;
/** 恶意注册代码,代码以|分割,如"G001|T002" */
RiskTypes: string | null;
}
/** 分账明细 */
declare interface MultiApplyDetail {
/** 商户编号 */
MerchantNo: string;
/** 分账金额 */
Amount: string;
/** 备注 */
Remark?: string;
}
/** 分账订单信息 */
declare interface MultiApplyOrder {
/** 商户分账单号 */
OutDistributeNo: string | null;
/** 平台分账单号 */
DistributeNo: string | null;
/** 平台交易订单号 */
OrderNo: string | null;
/** 分账订单状态(0初始1成功2失败3撤销) */
Status: string | null;
/** 入账日期,格式yyyy-MM-dd */
InDate: string | null;
/** 备注 */
Remark: string | null;
/** 分账明细 */
Details: MultiApplyDetail[] | null;
}
/** 自然人信息 */
declare interface NaturalPersonInfo {
/** 自然人类型 2:商户负责人 3:授权经办人4:业务联系人 5:实际控制人 6:控股股东 7:受益人 8:结算人注意:HELIPAY渠道必传业务联系人 */
PersonType: string;
/** 证件类型 IDCARD:身份证 PASSPORT:护照 SOLDIERSCERTIFICATE:士兵证 OFFICERSCERTIFICATE:军官证 GATXCERTIFICATE:香港居民来往内地通行证 TWNDCERTIFICATE:台湾同胞来往内地通行证 MACAOCERTIFICATE:澳门来往内地通行证 */
IdType: string;
/** 证件号码 */
IdNumber: string;
/** 姓名 */
PersonName: string;
/** 证件有效期类型 LONGTERM:长期有效 OTHER:非长期有效 */
IdValidityType: string;
/** 证件生效日期,yyyy-MM-dd */
IdEffectiveDate: string;
/** 证件失效日期,yyyy-MM-dd */
IdExpireDate: string;
/** 联系电话,HELIPAY渠道业务联系人必传 */
ContactPhone?: string;
/** 联系地址 */
ContactAddress?: string;
/** 邮箱地址 */
EmailAddress?: string;
}
/** 附加项信息 */
declare interface OldAttachmentInfo {
/** 附加项金额 */
AttachmentAmount: number | null;
/** 附加项类型 */
AttachmentType: string | null;
/** 附加项名称 */
AttachmentName: string | null;
/** 附加项编号 */
AttachmentCode: string | null;
}
/** 渠道方用户信息 */
declare interface OldChannelExternalUserInfo {
/** 渠道方用户类型 */
ChannelExternalUserType: string | null;
/** 渠道方用户ID */
ChannelExternalUserId: string | null;
}
/** 子单退款信息 */
declare interface OldSubRefund {
/** 支付机构退款流水号 */
ChannelExternalRefundId: string | null;
/** 支付机构支付订单号 */
ChannelExternalOrderId: string | null;
/** 渠道退款订单号 */
ChannelRefundId: string | null;
/** 子订单号 */
SubOutTradeNo: string | null;
/** 子单退款金额 */
RefundAmt: string | null;
}
/** 银行复核指引。银行侧返回网银授权指引链接,一般PC网银,手机网银链接 */
declare interface OpenBankApprovalGuideInfo {
/** PC网银指引 */
PcGuideUrl: string;
/** 手机网银指引 */
MobileGuideUrl: string | null;
}
/** 云企付-账单信息 */
declare interface OpenBankBillingInfo {
/** 账单人名字 */
FirstName?: string;
/** 账单人姓氏 */
LastName?: string;
/** 账单地址1 */
AddressOne?: string;
/** 账单地址1 */
AddressTwo?: string;
/** 账单地址所在城市 */
City?: string;
/** 账单地址所在州/省,当国家是美国或加拿大时,使用ISO-3166-2:US或ISO -3166-2:CA 中该国家地区编 码标准中的两位字母编码。 */
State?: string;
/** 账单地址所在国家,使用ISO-3166-1标准中的两位字母编码。 */
Country?: string;
/** 账单地址邮编 */
ZipCode?: string;
/** 账单人手机号 */
Phone?: string;
}
/** 网银页面提交html */
declare interface OpenBankFormInfo {
/** 网银页面提交html */
FormHtml: string | null;
/** 网银提交页面字符集 */
FormEncoding: string | null;
}
/** 云企付-商品信息 */
declare interface OpenBankGoodsInfo {
/** 商品标题。默认值“商品支付”。 */
GoodsName?: string;
/** 商品详细描述(商品列表)。 */
GoodsDetail?: string;
/** 银行附言。不可以有以下字符:<>+{}()%*&';"[]等特殊符号 */
GoodsDescription?: string;
/** 业务类型。汇付渠道必填,汇付渠道传入固定值100099。 */
GoodsBizType?: string;
/** 商品编号。 */
Sku?: string;
/** 商品单价。 */
Price?: string;
/** 商品数量 */
Quantity?: string;
/** 商品图片url */
ProductImage?: string;
/** 商品链接url */
ProductUrl?: string;
}
/** 云企付-下单跳转参数,用于小程序前端跳转 */
declare interface OpenBankOrderRedirectInfo {
/** 生成二维码,引导用户扫码 */
QRCodeUrl: string | null;
/** 二维码凭证 */
QRCodeKey: string | null;
/** 跳转 URL,用于客户端跳转,订单未支付时返回该参数 */
Url: string | null;
/** 跳转凭证过期时间,yyyy-MM-dd HH:mm:ss */
ExpireTime: string | null;
/** 小程序 appid */
MpAppId: string | null;
/** 小程序路径 */
MpPath: string | null;
/** 小程序原始 id */
MpUserName: string | null;
/** 网银支付提交页面信息 */
FormInfo: OpenBankFormInfo | null;
}
/** 云企付-支付限制 */
declare interface OpenBankPayLimitInfo {
/** 限制类型 */
PayLimitType: string;
/** 限制类型值 */
PayLimitValue: string;
}
/** 云企付-收款人信息 */
declare interface OpenBankPayeeInfo {
/** 收款方唯一标识。当渠道为TENPAY,付款方式为EBANK_PAYMENT,必填,上送收款方入驻云企付商户ID;付款方式为OPENBANK_PAYMENT时,非必填,输入外部收款方的标识ID渠道为WECHAT,付款方式为TRANS_TO_CHANGE时,上送微信OPEN_ID; */
PayeeId?: string;
/** 支行名称。 */
BankBranchName?: string;
/** 银行账号。渠道为TENPAY,付款方式为OPENBANK_PAYMENT时必选 */
BankAccountNumber?: string;
/** 收款方名称。当渠道为TENPAY,付款方式为EBANK_PAYMENT时,上送收款方入驻云企付的商户名称;渠道为TENPAY,付款方式为OPENBANK_PAYMENT时必选,上送收款方账户名称;渠道为ALIPAY,付款方式为SAFT_ISV时,收款账户标识类型为ALIPAY_LOGON_ID时必传,上送收款方真实姓名。渠道为WECHAT,付款方式为TRANS_TO_CHANGE时,上送收款人姓名。 */
PayeeName?: string;
/** 联行号。渠道为TENPAY,付款方式为OPENBANK_PAYMENT时必选 */
BankBranchId?: string;
/** 收款方绑卡序列号。当渠道为TENPAY,付款方式为EBANK_PAYMENT时,必填,上送收款方入驻云企付平台时,下发的绑卡序列号;当渠道为ALIPAY,付款方式为SAFT_ISV时,必填,根据收款账户标识类型上送。 */
BindSerialNo?: string;
/** 收款账户标识类型BANK_ACCOUNT:绑定银行账户ACCOUNT_BOOK_ID:电子记账本IDALIPAY_USER_ID:支付宝的会员IDALIPAY_LOGON_ID:支付宝登录号。付款方式为SAFT_ISV时,必填。 */
AccountType?: string;
}
/** 云企付-付款人信息 */
declare interface OpenBankPayerInfo {
/** 付款方唯一标识。当TENPAY时,必填上送付款方入驻云企付商户ID。 */
PayerId?: string;
/** 付款方名称。当TENPAY上送付款方入驻云企付的商户名称。 */
PayerName?: string;
/** 付款方付款账户标识。当付款方式为OPENBANK_PAYMENT时,必输表示企业账户ID;当付款方式为SAFT_ISV时,必须上送付款方的渠道电子记账本ID;当付款方式为ONLINEBANK,上送付款方银行编号BankId。 */
BindSerialNo?: string;
/** 付款账户标识类型BANK_ACCOUNT:绑定银行账户ACCOUNT_BOOK_ID:电子记账本ID。当付款方式为SAFT_ISV时,必须上送类型为ACCOUNT_BOOK_ID。 */
AccountType?: string;
/** 付款卡类型。汇付渠道必填。DEBIT_CARD:借记卡CREDIT_CARD:信用卡 */
BankCardType?: string;
}
/** 云企付-分润信息 */
declare interface OpenBankProfitShareInfo {
/** 分润接收方,渠道商户号ID */
RecvId?: string;
/** 分润金额,单位分 */
ProfitShareFee?: number;
}
/** 分账收款人信息 */
declare interface OpenBankProfitSharePayeeInfo {
/** 收款人账户名称 */
AccountName: string;
/** 银行名称可大体识别银行就行 */
BankName: string;
/** 账户货币 */
Currency: string;
/** 账户类型。00:借记卡01:存折 02:信用卡 03:准贷记卡 04:预付卡费 05:境外卡 */
Nature: string;
/** 账户地区/受益人所在国家。参考附录“国家代码”表——“代码”字段 */
Country: string;
/** 账户开户所在国家参考附录“国家代码”表——“代码”字段 */
DepositCountry: string;
/** 合作有效期yyyy-MM-dd */
ExpireDate: string;
/** 0:个人(对私) 1:公司(对公) */
Flag: string;
/** 开户行地址账户地区非中国必填,【账户名+开户行地址不可超过114个字符(只允许【英文字母数字空格.,/-()'】),否则可能导致境外银行付款失败】 */
BankAddress?: string;
/** 客户地址非中国内地账户的客户地址不能为空 */
Address?: string;
/** 账户属性账户开户所在国家为中国则必填。1-离岸账户 0-在岸账户 */
IsOSA?: string;
/** 账户省份参考附录“地区代码” */
Province?: string;
/** 账户城市参考附录“地区代码 */
City?: string;
/** 证件号/统一信用证代码如果country与depositcountry字段都是CHN时,必填对公账户填统一信用证代码,对私账户填身份证号码离岸账户非必填 */
LegalIdNo?: string;
/** 手机号。账户地区是日本则必填 */
Telephone?: string;
/** 参考接口说明。 */
BicCode?: string;
/** 参考接口说明。 */
SwiftCode?: string;
/** 大额支付行号/支付行号参考接口说明。境外(大额支付行号)参考附录【大额行号】,境内(支付行号)参考附录【支付行号】 */
Cnaps?: string;
/** 中转行号,参考接口说明。 */
TransferBankNo?: string;
/** 关联附件。上传的文件ID */
Fid?: string;
}
/** 分账信息结果 */
declare interface OpenBankProfitShareRespInfo {
/** 接收方企业ID */
RecvId: string;
/** 分润金额(分) */
ProfitShareFee: number;
/** 实际分账金额 */
RealProfitShareFee: number;
/** 分账状态 */
ProfitShareStatus: string;
/** 分账完成时间 */
ProfitFinishTime: string;
/** 分账类型 */
ProfitShareType: number;
}
/** 云企付-退款查询结果 */
declare interface OpenBankQueryRefundOrderResult {
/** 外部商户退款单号 */
OutRefundId?: string | null;
/** 渠道退款单号 */
ChannelRefundId?: string | null;
/** 退款原因 */
RefundReason?: string | null;
/** 退款金额,单位分 */
RefundAmount?: number | null;
/** 实际退款金额,单位分 */
RealRefundAmount?: number | null;
/** 原支付订单总金额,单位分 */
TotalAmount?: number | null;
/** 退款完成时间 */
TimeFinish?: string | null;
/** 退款订单状态 */
RefundStatus?: string | null;
/** 退款明细信息 */
RefundInfo?: string | null;
/** 退款手续费金额 */
FeeAmount: number | null;
/** 退款返回描述,比如失败原因等。 */
RefundMessage: string | null;
/** 分账信息 */
ProfitShareRespInfoList: OpenBankProfitShareRespInfo[] | null;
}
/** 云企付-充值单收款人信息 */
declare interface OpenBankRechargePayeeInfo {
/** 收款方标识收款方类型为电子记账本时,上送渠道电子记账本ID */
PayeeId: string;
/** 收款方标识类型ACCOUNT_BOOK_ID:电子记账本ID */
PayeeIdType: string;
/** 收款方名称 */
PayeeName?: string;
}
/** 云企付-充值跳转参数 */
declare interface OpenBankRechargeRedirectInfo {
/** 跳转URL */
Url: string | null;
}
/** 云企付-跳转参数,用于小程序前端跳转 */
declare interface OpenBankRedirectInfo {
/** 生成二维码,引导用户扫码 */
QRCodeUrl: string;
/** 二维码凭证 */
QRCodeKey: string;
/** 跳转 URL,用于客户端跳转,订单未支付时返回该参数 */
Url: string | null;
/** 跳转凭证过期时间,yyyy-MM-dd HH:mm:ss */
ExpireTime: string;
/** 小程序 appid */
MpAppId: string;
/** 小程序路径 */
MpPath: string;
/** 小程序原始 id */
MpUserName: string;
/** 网银支付提交页面信息 */
FormInfo: OpenBankFormInfo | null;
}
/** 云企付-退款申请结果 */
declare interface OpenBankRefundOrderApplyResult {
/** 云企付订单号 */
ChannelOrderId?: string | null;
/** 云企付退款流水号 */
ChannelRefundId?: string | null;
/** 外部商户退款单号 */
OutRefundId?: string | null;
/** 外部商户订单号 */
OutOrderId?: string | null;
/** 退款返回描述,比如失败原因等。 */
RefundMessage?: string | null;
/** 退款金额 */
RefundAmount?: number | null;
/** 退款手续费金额 */
FeeAmount: number | null;
/** 退款状态 */
RefundStatus: string | null;
}
/** 云企付-设备信息 */
declare interface OpenBankSceneInfo {
/** 用户端实际 ip。汇付渠道必填。 */
PayerClientIp?: string;
/** 浏览器 User-Agent。 */
PayerUa?: string;
/** 用户下单时间。若不上送,服务端默认当前时间。 */
OrderTime?: string;
/** 终端设备号(门店号或收银设备 ID),示例值:POS1:1。 */
DeviceId?: string;
/** 终端设备类型。MOBILE_BROWSER:手机浏览器,MOBILE_APP:手机应用程序,TABLET:平板;WATCH:手表,PC:电脑PC,OTHER:其他。汇付渠道必填。 */
DeviceType?: string;
}
/** 云企付-结算规则信息 */
declare interface OpenBankSettlementRulesInfo {
/** ONCE:仅单次解冻(默认)MULTI:多次解冻 */
UnfreezeRule?: string | null;
/** ONCE:仅单次退款(默认)MULTI:多次退款 */
RefundRule?: string | null;
}
/** 云企付-邮寄信息 */
declare interface OpenBankShippingInfo {
/** 收货人名字 */
FirstName?: string;
/** 收货人姓氏 */
LastName?: string;
/** 收货地址1 */
AddressOne?: string;
/** 收货地址2 */
AddressTwo?: string;
/** 收货地址所在城市 */
City?: string;
/** 收货地址所在州,当国家是美国或加拿大时,使用ISO-3166-2:US或ISO -3166-2:CA 中该国家地区编码标准中的两位字母编码 */
State?: string;
/** 使用ISO-3166-1标准中的两位字母编码 */
Country?: string;
/** 收货地址邮编 */
ZipCode?: string;
/** 收货联系电话 */
Phone?: string;
}
/** 云企付-门店信息 */
declare interface OpenBankStoreInfo {
/** 门店名称 */
Name: string;
/** 地区编码 */
AreaCode: string;
/** 详细地址 */
Address: string;
/** 门店编号 */
Id?: string;
}
/** 线下查票-订单信息 */
declare interface Order {
/** 含税金额 */
AmountHasTax: number | null;
/** 优惠金额 */
Discount: number | null;
/** 销方名称 */
SellerName: string | null;
/** 发票类型 */
InvoiceType: number | null;
/** 默认“” */
Name: string | null;
/** 支付金额 */
Amount: number | null;
/** 下单日期 */
OrderDate: string | null;
/** 订单号 */
OrderId: string | null;
/** 门店号 */
StoreNo: string | null;
/** 明细 */
Items: OrderItem[] | null;
}
/** 线下查票-订单明细 */
declare interface OrderItem {
/** 明细金额 */
AmountHasTax: number | null;
/** 优惠金额 */
Discount: number | null;
/** 商品名称 */
Name: string | null;
/** 型号 */
Models: string | null;
/** 数量 */
Total: number | null;
/** 数量单位 */
Unit: string | null;
/** 默认“0” */
Status: string | null;
/** 单价 */
Price: number | null;
/** 商品编码 */
TaxCode: string | null;
}
/** 订单汇总列表 */
declare interface OrderSummaries {
/** 汇总列表 */
List: OrderSummaryResult[];
/** 总数 */
Count: number;
}
/** 订单汇总结果 */
declare interface OrderSummaryResult {
/** 汇总ID */
SummaryId: string;
/** 收款账户ID */
PayeeId: string;
/** 收款账户名称 */
Name: string;
/** 收入类型 */
IncomeType: string;
/** 汇总金额 */
SummaryAmount: string;
/** 汇总日期 */
SummaryTime: string;
/** 汇总记录数量 */
SummaryCount: number;
/** 外部用户ID */
OutUserId: string;
}
/** 公司信息 */
declare interface OrganizationInfo {
/** 公司名称,个体工商户必输 */
OrganizationName?: string;
/** 公司证件类型,个体工商户必输,证件类型仅支持73 */
OrganizationType?: string;
/** 公司证件号码,个体工商户必输 */
OrganizationCode?: string;
/** 法人名称,如果SubMchName不是法人,需要另外送入法人信息(企业必输)<敏感信息>加密详见《商户端接口敏感信息加密说明》 */
LegalPersonName?: string;
/** 法人证件类型,如果SubMchName不是法人,需要另外送入法人信息(企业必输) */
LegalPersonIdType?: string;
/** 法人证件号码,如果SubMchName不是法人,需要另外送入法人信息(企业必输)<敏感信息>加密详见《商户端接口敏感信息加密说明》 */
LegalPersonIdCode?: string;
}
/** 外部子商户扩展信息 */
declare interface OutSubMerchantExtensionInfo {
/** 地区代码,国标码HELIPAY渠道必传 */
RegionCode?: string;
/** 注册地址 */
RegisterAddress?: string;
/** 通讯地址HELIPAY渠道必传 */
MailingAddress?: string;
/** 营业地址/经营地址 */
BusinessAddress?: string;
/** 客服电话 */
ServicePhone?: string;
/** 网站url */
WebSiteUrl?: string;
/** 邮箱地址 */
EmailAddress?: string;
}
/** 分页参数 */
declare interface Paging {
/** 页码 */
Index: number;
/** 页长 */
Count: number;
}
/** pay支付方式json数据 */
declare interface PayDataResult {
/** 支付标签(唯一性) */
PaymentTag: string;
/** 添加合同时需要隐藏的选项(多个以小写逗号分开) */
PaymentOptionHide?: string;
/** 支付方式图片url路径 */
PaymentIcon: string;
/** 合同选项名称6 */
PaymentOptionSix?: string;
/** 付款方式名称 */
PaymentName: string;
/** 合同选项名称7 */
PaymentOptionSeven?: string;
/** 合同选项名称8 */
PaymentOptionOther?: string;
/** 合同选项名称2 */
PaymentOptionTwo?: string;
/** 合同选项名称1 */
PaymentOptionOne?: string;
/** 是否开启智能扣率(1是,0否) */
PaymentDiscountFee: string;
/** 支持的交易类型(多个以小写逗号分开,0现金,1刷卡,2主扫,3被扫,4JSPAY,5预授权) */
PaymentType: string;
/** 合同选项名称5 */
PaymentOptionFive?: string;
/** 合同选项名称9 */
PaymentOptionNine?: string;
/** 支付方式编号 */
PaymentId: string;
/** 合同选项名称3 */
PaymentOptionThree?: string;
/** 付款方式名称(内部名称) */
PaymentInternalName: string;
/** 合同选项名称4 */
PaymentOptionFour?: string;
/** 合同选项名称10 */
PaymentOptionTen?: string;
}
/** pay_fee支付方式行业分类费率json数据 */
declare interface PayFeeDataResult {
/** 机构的分佣扣率扣率 */
OrganizationFee: string;
/** 商户手续费封顶值,0为不限封顶 */
PaymentClassificationLimit: string;
/** 机构的分佣扣率类型(1按签约扣率,2按收单收益) */
OrganizationFeeType: string;
/** 商户扣率最大值 */
PaymentClassificationMaxFee: string;
/** 商户扣率最小值 */
PaymentClassificationMinFee: string;
/** 行业会类编号 */
PaymentClassificationId: string;
/** 行业分类名称 */
PaymentClassificationName: string;
}
/** 订单支付响应对象 */
declare interface PayOrderResult {
/** 付款订单号 */
OrderNo: string | null;
/** 开发者流水号 */
DeveloperNo: string | null;
/** 交易优惠金额(免充值券) */
TradeDiscountAmount: string | null;
/** 付款方式名称 */
PayName: string | null;
/** 商户流水号(从1开始自增长不重复) */
OrderMerchantId: string | null;
/** 交易帐号(银行卡号、支付宝帐号、微信帐号等,某些收单机构没有此数据) */
TradeAccount: string | null;
/** 实际交易金额(以分为单位,没有小数点) */
TradeAmount: string | null;
/** 币种签名 */
CurrencySign: string | null;
/** 付款完成时间(以收单机构为准) */
TradePayTime: string | null;
/** 门店流水号(从1开始自增长不重复) */
ShopOrderId: string | null;
/** 支付标签 */
PayTag: string | null;
/** 订单状态(1交易成功,2待支付,4已取消,9等待用户输入密码确认 */
Status: string | null;
/** 币种代码 */
OrderCurrency: string | null;
/** 二维码字符串 */
TradeQrcode: string | null;
/** 微信返回调起小程序/原生JS支付的appid参数 */
WechatAppId: string | null;
/** 微信返回调起小程序/原生JS支付的timeStamp参数 */
WechatTimeStamp: string | null;
/** 微信返回调起小程序/原生JS支付的nonceStr参数 */
WechatNonceStr: string | null;
/** 微信返回调起小程序/原生JS支付的signType参数 */
WechatSignType: string | null;
/** 微信返回调起小程序/原生JS支付的package参数 */
WechatPackage: string | null;
/** 微信返回调起小程序/原生JS支付的paySign参数 */
WechatPaySign: string | null;
}
/** 微工卡核身结果 */
declare interface PayRollAuthResult {
/** 结果为核身失败时的原因描述,仅在失败记录返回,空字符串等同null */
AuthFailedReason: string | null;
/** 商户系统内部的商家核身单号,要求此参数只能由数字、大小写字母组成,在服务商内部唯一 */
AuthNumber: string;
/** 核身渠道,发起核身时的来源渠道,如