String channelId
String businessCode
ApplySubjectConfirmCreateRequest.ApplySubConfirmContactInfo contactInfo
ApplySubjectConfirmCreateRequest.ApplySubConfirmSubjectInfo subjectInfo
ApplySubjectConfirmCreateRequest.ApplySubConfirmIdentificationInfo identityInfo
List<E> uboInfoList
ApplySubjectConfirmCreateRequest.ApplySubConfirmAdditionInfo additionInfo
String contactType
String name
String contactIdDocType
String contactIdNumber
String contactIdDocCopy
String contactIdDocCopyBack
String contactPeriodBegin
String contactPeriodEnd
String mobile
String idHolderType
字段idHolderType
IdTypeEnum identificationType
String authorizeLetterCopy
String identificationName
String identificationNumber
String identificationValidDate
String identificationAddress
String identificationFrontCopy
String identificationBackCopy
Boolean owner
SubjectTypeEnum subjectType
Boolean financeInstitution
ApplySubjectConfirmCreateRequest.ApplySubConfirmSubjectInfo.ApplySubConfirmBusinessLicenseInfo businessLicenseInfo
ApplySubjectConfirmCreateRequest.ApplySubConfirmSubjectInfo.ApplySubConfirmCertificateInfo certificateInfo
String companyProveCopy
ApplySubjectConfirmCreateRequest.ApplySubConfirmSubjectInfo.ApplySubConfirmAssistProveInfo assistProveInfo
List<E> specialOperationList
ApplySubjectConfirmCreateRequest.ApplySubConfirmSubjectInfo.ApplySubConfirmFinanceInstitutionInfo financeInstitutionInfo
String microBizType
String storeName
String storeAddressCode
String storeAddress
String storeHeaderCopy
String storeIndoorCopy
String licenseNumber
String licenseCopy
String merchantName
String legalPerson
String companyAddress
String periodBegin
String certCopy
CertTypeEnum certType
String certNumber
String merchantName
String companyAddress
String legalPerson
String certValidDate
FinanceTypeEnum financeType
FinanceTypeEnum
List<E> financeLicensePics
Integer categoryId
List<E> financeLicensePics
IdTypeEnum uboIdDocType
String uboIdDocCopy
String uboIdDocCopyBack
String uboIdDocName
String uboIdDocNumber
String uboIdDocAddress
String uboPeriodBegin
String uboPeriodEnd
String applymentId
AuthorizeStateEnum applymentState
ApplySubjectStateEnum applymentState
String qrcodeData
String rejectParam
String rejectReason
String accountName
String accountType
String accountBank
String bankName
String bankBranchId
String accountNumber
String verifyResult
String verifyFailReason
String verifyFinishTime
String accountName
AccountTypeEnum accountType
String accountBank
String bankName
String bankBranchId
String accountNumber
SettlementVerifyStateEnum verifyResult
String verifyFailReason
String verifyFinishTime
String businessCode
WxPayApplyment4SubCreateRequest.ContactInfo contactInfo
WxPayApplyment4SubCreateRequest.SubjectInfo subjectInfo
WxPayApplyment4SubCreateRequest.BusinessInfo businessInfo
WxPayApplyment4SubCreateRequest.SettlementInfo settlementInfo
WxPayApplyment4SubCreateRequest.BankAccountInfo bankAccountInfo
WxPayApplyment4SubCreateRequest.AdditionInfo additionInfo
String merchantShortname
String servicePhone
WxPayApplyment4SubCreateRequest.BusinessInfo.SalesInfo salesInfo
List<E> salesScenesType
WxPayApplyment4SubCreateRequest.BusinessInfo.SalesInfo.BizStoreInfo bizStoreInfo
WxPayApplyment4SubCreateRequest.BusinessInfo.SalesInfo.MpInfo mpInfo
WxPayApplyment4SubCreateRequest.BusinessInfo.SalesInfo.MiniProgramInfo miniProgramInfo
WxPayApplyment4SubCreateRequest.BusinessInfo.SalesInfo.AppInfo appInfo
WxPayApplyment4SubCreateRequest.BusinessInfo.SalesInfo.WebInfo webInfo
WxPayApplyment4SubCreateRequest.BusinessInfo.SalesInfo.WeworkInfo weworkInfo
String contactType
String contactName
String contactIdDocType
String contactIdNumber
String contactIdDocCopy
String contactIdDocCopyBack
String contactPeriodBegin
String contactPeriodEnd
String businessAuthorizationLetter
String openid
String mobilePhone
String contactEmail
String settlementId
String qualificationType
List<E> qualifications
String activitiesId
String activitiesRate
String debitActivitiesRate
String creditActivitiesRate
List<E> activitiesAdditions
SubjectTypeEnum subjectType
Boolean financeInstitution
WxPayApplyment4SubCreateRequest.SubjectInfo.BusinessLicenseInfo businessLicenseInfo
WxPayApplyment4SubCreateRequest.SubjectInfo.CertificateInfo certificateInfo
String certificateLetterCopy
WxPayApplyment4SubCreateRequest.SubjectInfo.FinanceInstitutionInfo financeInstitutionInfo
WxPayApplyment4SubCreateRequest.SubjectInfo.IdentityInfo identityInfo
List<E> uboInfoList
FinanceTypeEnum financeType
FinanceTypeEnum
List<E> financeLicensePics
String idHolderType
字段idHolderType
IdTypeEnum idDocType
String authorizeLetterCopy
WxPayApplyment4SubCreateRequest.SubjectInfo.IdentityInfo.IdCardInfo idCardInfo
WxPayApplyment4SubCreateRequest.SubjectInfo.IdentityInfo.IdDocInfo idDocInfo
Boolean owner
IdTypeEnum uboIdDocType
String uboIdDocCopy
String uboIdDocCopyBack
String uboIdDocName
String uboIdDocNumber
String uboIdDocAddress
String uboPeriodBegin
String uboPeriodEnd
String applymentId
Integer totalCount
字段名:查询数据总条数 变量名:total_count 是否必填:是 类型:int 描述: 经过条件筛选,查询到的支行总数 示例值:10
Integer count
字段名:本次查询条数 变量名:count 是否必填:是 类型:int 描述: 本次查询到的支行数据条数 示例值:10
List<E> data
字段名:支行列表 变量名:data 是否必填:否 类型:array 描述: 单次查询返回的支行列表结果数组
Integer offset
字段名:本次查询偏移量 变量名:offset 是否必填:是 类型:int 描述: 该次请求资源的起始位置,请求中包含偏移量时应答消息返回相同偏移量,否则返回默认值0 示例值:0
PageLink links
字段名:分页链接 变量名:offset 是否必填:是 类型:object 描述: 返回前后页和当前页面的访问链接
String accountBank
字段名:开户银行 变量名:account_bank 是否必填:是 类型:string[1, 128] 描述: 查询到的支行所属开户银行的名称,非直连银行统一为其他银行 示例值:招商银行其他银行
Integer accountBankCode
字段名:开户银行编码 变量名:account_bank_code 是否必填:是 类型:int 描述: 查询到的支行所属开户银行的开户银行编码,可用于付款到银行卡等场景中指定银行卡的开户银行 示例值:1001
String bankAlias
字段名:银行别名 变量名:bank_alias 是否必填:是 类型:string[1, 128] 描述: 查询到的支行所属银行的银行别名 示例值:工商银行深圳前海微众银行
String bankAliasCode
字段名:银行别名编码 变量名:bank_alias_code 是否必填:是 类型:string[1, 32] 描述: 查询到的支行所属银行的银行别名编码,用于校验回包 示例值:1000006247
String bankBranchName
字段名:开户银行支行名称 变量名:bank_branch_name 是否必填:是 类型:string[1, 128] 描述: 开户银行支行名称,用于开户银行为其他银行的情况下,在入驻、修改结算银行卡、企业付款等场景下填写结算银行卡信息。 示例值:中国工商银行上海市周浦支行
String bankBranchId
字段名:开户银行支行联行号 变量名:bank_branch_id 是否必填:是 类型:string[1, 64] 描述: 开户银行支行的联行号,用于开户银行为其他银行的情况下,在入驻、修改结算银行卡、企业付款等场景下填写结算银行卡信息。 示例值:102290072311
String next
字段名:下一页链接 变量名:next 是否必填:否 类型:string[1, 2048] 描述: 使用同样的limit进行下一页查询时的相对请求链接,使用方需要自行根据当前域名进行拼接。如果已经到最后时,为空 示例值:/v3/capital/capitallhh/banks/1001/branches?offset=10&limit=5
String prev
字段名:上一页链接 变量名:prev 是否必填:否 类型:string[1, 2048] 描述: 使用同样的limit进行上一页查询时的相对请求链接,使用方需要自行根据当前域名进行拼接。如果是第一页,为空 示例值:/v3/capital/capitallhh/banks/1001/branchesoffset=0&limit=5
String self
字段名:当前链接 变量名:self 是否必填:否 类型:string[1, 2048] 描述: 当前的相对请求链接,使用方需要自行根据当前域名进行拼接 示例值:/v3/capital/capitallhh/banks/1001/branches?offset=5&limit=5
String outBatchNo
字段名:商家品牌红包批次单号 变量名:out_batch_no 是否必填:是 类型:string[1, 32] 描述: path商户系统内部的商家品牌红包批次单号,要求此参数只能由数字、大小写字母组成,在商户系统内部唯一 示例值:plfk2020042013
Boolean needQueryDetail
字段名:是否需要查询品牌红包明细单 变量名:need_query_detail 是否必填:否 类型:boolean 描述: query枚举值: true:是; false:否,默认否。 商户可选择是否查询指定状态的品牌红包明细单,当品牌红包批次单状态为“FINISHED”(已完成)时,才会返回满足条件的品牌红包明细单
String detailState
字段名:品牌红包明细单状态 变量名:detail_state 是否必填:否 类型:string 描述: query查询指定状态的品牌红包明细单信息 DETAIL_VIEW_ALL - 全部,需要同时查询发送成功和发送失败的品牌红包明细单 DETAIL_VIEW_SUCCESS - 发送成功,只查询发送成功的品牌红包明细单 DETAIL_VIEW_FAIL - 发送失败,只查询发送失败的品牌红包明细单 示例值:DETAIL_VIEW_FAIL
String outBatchNo
字段名:商家品牌红包批次单号 变量名:out_batch_no 是否必填:是 类型:string[5, 32] 描述: path商户系统内部的商家品牌红包批次单号,要求此参数只能由数字、大小写字母组成,在商户系统内部唯一 示例值:plfk2020042013
String outDetailNo
字段名:商家品牌红包明细单号 变量名:out_detail_no 是否必填:是 类型:string[5, 32] 描述: path商户系统内部区分品牌红包批次单下不同品牌红包明细单的唯一标识,要求此参数只能由数字、大小写字母组成 示例值:x23zy545Bd5436
Integer brandId
字段名:品牌ID 变量名:brand_id 是否必填:是 类型:int 描述: body品牌在微信支付进行品牌认证后的唯一标识品牌ID 示例值:1234
String brandAppid
字段名:品牌AppID 变量名:brand_appid 是否必填:是 类型:string[1, 32] 描述: body品牌商户在微信申请公众号/小程序或移动应用成功后分配的账号ID,需与品牌有绑定关系,使用品牌的AppID时需要填写 示例值:wxf636efh567hg4356
String scene
字段名:品牌红包发放场景 变量名:scene 是否必填:是 类型:string 描述: body品牌红包发放场景,用户可以在指定的场景领取到红包 CUSTOM_SEND - 自定义发放场景,自定义场景发放红包,使用已配置的自定义发放模板进行发红包 示例值:CUSTOM_SEND
String templateId
字段名:品牌红包模板ID 变量名:template_id 是否必填:是 类型:string[1, 128] 描述: body品牌主配置的品牌红包模板ID 示例值:123400001
String outBatchNo
字段名:商家品牌红包批次单号 变量名:out_batch_no 是否必填:是 类型:string[5, 32] 描述: body品牌商户系统内部的品牌红包批次单号,要求此参数只能由数字、大小写字母组成,在商户系统内部唯一 示例值:plfk2020042013
String batchName
字段名:品牌红包批次名称 变量名:batch_name 是否必填:是 类型:string[1, 32] 描述: body该品牌红包批次的名称,展示在用户红包领取通知的红包活动名称 示例值:双十一营销用品牌红包
String batchRemark
字段名:品牌红包批次备注 变量名:batch_remark 是否必填:是 类型:string[1, 32] 描述: body该批次品牌红包的备注,仅用于品牌商户内部管理 示例值:双十一营销用品牌红包
Integer totalAmount
字段名:总金额 变量名:total_amount 是否必填:是 类型:int 描述: body品牌红包总金额必须与品牌红包批次内所有品牌红包明细发送金额之和保持一致,否则无法发送品牌红包 示例值:10000
Integer totalNum
字段名:总笔数 变量名:total_num 是否必填:是 类型:int 描述: body一个品牌红包批次单最多发送10笔品牌红包明细。品牌红包总笔数必须与批次内所有品牌红包明细之和保持一致,否则无法发送品牌红包 示例值:10
List<E> detailList
字段名:品牌红包明细列表 变量名:detail_list 是否必填:否 类型:array 描述: body品牌红包明细列表,最多10笔
String batchNo
字段名:微信支付品牌红包批次单号 变量名:batch_no 是否必填:是 类型:string[32, 64] 描述: path微信支付品牌红包批次单号,微信商家品牌红包系统返回的唯一标识 示例值:1030000071100999991182020050700019480001
Boolean needQueryDetail
字段名:是否需要查询品牌红包明细单 变量名:need_query_detail 是否必填:是 类型:boolean 描述: query枚举值: true:是; false:否,默认否。 商户可选择是否查询指定状态的品牌红包明细单,当品牌红包批次单状态为“FINISHED”(已完成)时,才会返回满足条件的品牌红包明细单 示例值:true
String detailState
字段名:品牌红包明细单状态 变量名:detail_status 是否必填:否 类型:string[1,32] 描述: query查询指定状态的品牌红包明细单信息 DETAIL_VIEW_ALL - 全部,需要同时查询发送成功和发送失败的品牌红包明细单 DETAIL_VIEW_SUCCESS - 发送成功,只查询发送成功的品牌红包明细单 DETAIL_VIEW_FAIL - 发送失败,只查询发送失败的品牌红包明细单 示例值:DETAIL_VIEW_FAIL
String batchNo
字段名:微信支付品牌红包批次单号 变量名:batch_no 是否必填:是 类型:string[32, 64] 描述: path微信支付品牌红包批次单号,微信商家品牌红包系统返回的唯一标识 示例值:1030000071100999991182020050700019480001
String detailNo
字段名:微信明细单号 变量名:detail_no 是否必填:是 类型:string[32, 64] 描述: path微信支付系统内部区分品牌红包批次单下不同品牌红包明细单的唯一标识 示例值:1040000071100999991182020050700019500100
String brandMchid
字段名:品牌主商户号 变量名:brand_mchid 是否必填:是 类型:string[1, 32] 描述: 微信服务商下特约商户的商户号,且已经认证品牌的品牌主商户号 示例值:1900001109
String batchNo
字段名:微信支付品牌红包批次单号 变量名:batch_no 是否必填:是 类型:string[32, 64] 描述: 品牌在微信支付进行品牌认证后的唯一标识品牌ID 示例值:1030000071100999991182020050700019480001
String outBatchNo
字段名:商家品牌红包批次单号 变量名:out_batch_no 是否必填:是 类型:string[1, 32] 描述: 品牌商户系统内部的品牌红包批次单号,要求此参数只能由数字、大小写字母组成,在商户系统内部唯一 示例值:plfk2020042013
Integer brandId
字段名:品牌ID 变量名:brand_id 是否必填:否 类型:int 描述: 品牌在微信支付进行品牌认证后的唯一标识品牌ID 示例值:1234
String templateId
字段名:品牌红包模板ID 变量名:template_id 是否必填:否 类型:string[1, 128] 描述: 品牌主配置的品牌红包模板ID 示例值:12340000000001
String brandAppid
字段名:品牌AppID 变量名:brand_appid 是否必填:否 类型:string[1, 32] 描述: 品牌商户在微信申请公众号/小程序或移动应用成功后分配的账号ID,该AppID需与品牌ID有绑定关系(B-A绑定关系) 示例值:wxf636efh567hg4356
String batchState
字段名:品牌红包批次状态 变量名:batch_state 是否必填:是 类型:string 描述: 当前品牌红包批次状态 WAIT_PAY - 待付款,商户员工确认付款阶段 ACCEPTED - 已受理,批次已受理成功,若发起品牌红包的30分钟后,品牌红包批次单仍处于该状态,可能原因是商户账户余额不足等。商户可查询账户资金流水,若该笔品牌红包批次单的扣款已经发生,则表示批次已经进入发送中,请再次查单确认 PROCESSING - 发送中,已开始处理批次内的品牌红包明细单 FINISHED - 已完成,批次内的所有品牌红包明细单都已处理完成 CLOSED - 已关闭,可查询具体的批次关闭原因确认 示例值:ACCEPTED
String batchName
字段名:品牌红包批次名称 变量名:batch_name 是否必填:是 类型:string[1, 32] 描述: 该批次品牌红包的备注,用于品牌商户内部管理 示例值:双十一营销发放品牌红包
String batchRemark
字段名:品牌红包批次备注 变量名:batch_remark 是否必填:是 类型:string[1, 32] 描述: 该批次品牌红包的备注,仅用于品牌商户内部管理 示例值:双十一营销发放品牌红包
String closeReason
字段名:品牌红包批次单关闭原因 变量名:close_reason 是否必填:否 类型:string 描述: 品牌红包批次单状态为“CLOSED”(已关闭)时返回 MERCHANT_REVOCATION - 商户主动撤销 SYSTEM_OVERDUE_CLOSE - 系统超时关闭 示例值:SYSTEM_OVERDUE_CLOSE
Integer totalAmount
字段名:总金额 变量名:total_amount 是否必填:是 类型:int 描述: 品牌红包金额单位为“分” 示例值:10000
Integer totalNum
字段名:总笔数 变量名:total_num 是否必填:是 类型:int 描述: 一个品牌红包批次单最多发送10笔品牌红包明细。品牌红包总笔数必须与批次内所有品牌红包明细之和保持一致,否则无法发送品牌红包 示例值:10
String createTime
字段名:品牌红包批次创建时间 变量名:create_time 是否必填:是 类型:string[1, 32] 描述: 品牌红包批次受理成功时返回,遵循rfc3339标准格式, 格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。 例如:2015-05-20T13:29:35+08:00表示北京时间2015年05月20日13点29分35秒 示例值:2015-05-20T13:29:35+08:00
String updateTime
字段名:品牌红包批次更新时间 变量名:update_time 是否必填:是 类型:string[1, 32] 描述: 品牌红包批次最近一次状态变更时间,遵循rfc3339标准格式, 格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。 例如:2015-05-20T13:29:35+08:00表示北京时间2015年05月20日13点29分35秒 示例值:2015-05-20T13:29:35+08:00
Integer successAmount
字段名:发放成功金额 变量名:success_amount 是否必填:是 类型:int 描述: 品牌红包发放成功的金额,单位为“分”。当批次状态为“PROCESSING”(发送中)时,发放成功金额随时可能变化 示例值:5000
Integer successNum
字段名:发放成功笔数 变量名:success_num 是否必填:是 类型:int 描述: 品牌红包发放成功的笔数。当批次状态为“PROCESSING”(发放中)时,发放成功笔数随时可能变化 示例值:10
Integer failAmount
字段名:发放失败金额 变量名:fail_amount 是否必填:是 类型:int 描述: 品牌红包发放失败的金额,单位为“分” 示例值:5000
Integer failNum
字段名:发放失败笔数 变量名:fail_num 是否必填:是 类型:int 描述: 品牌红包发放失败的笔数 示例值:10
List<E> detailList
字段名:品牌红包明细列表 变量名:detail_list 是否必填:否 类型:array 描述: 当批次状态为“FINISHED”(已完成),且成功查询到品牌红包明细单时返回。包括微信支付品牌红包明细单号、明细状态信息
String transferDetailNo
字段名:微信支付品牌红包明细单号 变量名:transfer_detail_no 是否必填:是 类型:string[32, 64] 描述: 微信支付系统内部区分品牌红包批次单下不同品牌红包明细单的唯一标识 示例值:1220000071100999991182020050700019500100
String outDetailNo
字段名:商家品牌红包明细单号 变量名:out_detail_no 是否必填:是 类型:string[1, 32] 描述: 品牌商户系统内部区分品牌红包批次单下不同品牌红包明细单的唯一标识,要求此参数只能由数字、大小写字母组成 示例值:x23zy545Bd5436
String detailState
字段名:品牌红包明细单状态 变量名:detail_state 是否必填:是 类型:string[1, 64] 描述: 品牌红包明细单的状态 DETAIL_PROCESSING - 发送中,正在处理中,品牌红包发送结果尚未明确 DETAIL_SUCCESS - 发送成功,发送成功 DETAIL_FAIL - 发送失败,需要确认失败原因后,再决定是否重新对该笔品牌红包明细单进行发送(并非整个品牌红包批次单) 示例值:DETAIL_SUCCESS
String brandMchid
字段名:品牌主商户号 变量名:brand_mchid 是否必填:是 类型:string[1,32] 描述: 微信服务商下特约商户的商户号,且已经认证品牌的品牌主商户号 示例值:1900001109
String outBatchNo
字段名:商家品牌红包批次单号 变量名:out_batch_no 是否必填:是 类型:string[1,32] 描述: 商户系统内部的商家品牌红包批次单号,在商户系统内部唯一 示例值:plfk2020042013
String batchNo
字段名:微信支付品牌红包批次单号 变量名:batch_no 是否必填:是 类型:string[32, 64] 描述: 微信支付品牌红包批次单号,微信商家品牌红包系统返回的唯一标识 示例值:1030000071100999991182020050700019480001
String outDetailNo
字段名:商家品牌红包明细单号 变量名:out_detail_no 是否必填:是 类型:string[1,32] 描述: 品牌商户系统内部的品牌红包批次单号,要求此参数只能由数字、大小写字母组成,在商户系统内部唯一 示例值:x23zy545Bd5436
String detailNo
字段名:微信支付品牌红包明细单号 变量名:detail_id 是否必填:是 类型:string[32, 64] 描述: 微信支付系统内部区分品牌红包批次单下不同品牌红包明细单的唯一标识 示例值:1040000071100999991182020050700019500100
String detailState
字段名:品牌红包明细单状态 变量名:detail_state 是否必填:是 类型:string 描述: 品牌红包明细单状态 DETAIL_PROCESSING - 发送中,正在处理中,品牌红包发送结果尚未明确 DETAIL_SUCCESS - 发送成功,发送成功 DETAIL_FAIL - 发送失败,需要确认失败原因后,再决定是否重新对该笔品牌红包明细单进行发送(并非整个品牌红包批次单) 示例值:DETAIL_SUCCESS
Integer amount
字段名:红包金额 变量名:amount 是否必填:是 类型:int 描述: 红包金额单位为“分” 示例值:100
String remark
字段名:红包备注 变量名:remark 是否必填:是 类型:string[1,32] 描述: 单个品牌红包备注(微信用户会收到该备注),UTF8编码,最多允许32个字符 示例值:来自XX品牌红包
String failReason
字段名:明细失败原因 变量名:fail_reason 是否必填:否 类型:string 描述: 明细失败原因 ACCOUNT_FROZEN - 该用户账户被冻结 REAL_NAME_CHECK_FAIL - 收款人未实名认证,需要用户完成微信实名认证 NAME_NOT_CORRECT - 收款人姓名校验不通过,请核实信息 OPENID_INVALID - OpenID格式错误或者不属于商家公众账号 TRANSFER_QUOTA_EXCEED - 超过用户单笔收款区间,核实产品设置是否准确 DAY_RECEIVED_QUOTA_EXCEED - 超过用户单日收款额度,核实产品设置是否准确 DAY_RECEIVED_COUNT_EXCEED - 超过用户单日收款次数,核实产品设置是否准确 PRODUCT_AUTH_CHECK_FAIL - 未开通该权限或权限被冻结,请核实产品权限状态 OVERDUE_CLOSE - 该笔转账已关闭 ACCOUNT_NOT_EXIST - 该用户账户不存在 TRANSFER_RISK - 该笔转账可能存在风险,已被微信拦截 USER_ACCOUNT_LIMIT - 用户账户收款受限,请引导用户在微信支付查看详情 FAIL_REASON_UNKNOWN - 失败原因未知 PAYER_ACCOUNT_ABNORMAL - 商户账户付款受限,可前往商户平台获取解除功能限制指引 PAYEE_ACCOUNT_ABNORMAL - 用户账户收款异常,请联系用户完善其在微信支付的身份信息以继续收款 USER_RECEIVE_OVERDUE - 用户逾期未领取 REMARK_NOT_CORRECT - 红包备注设置失败,请修改后再试 示例值:ACCOUNT_FROZEN
String openid
字段名:接收红包用户OpenID 变量名:openid 是否必填:是 类型:string[1, 64] 描述: 接收红包的用户OpenID,OpenID为用户在对应AppID下的唯一标识 示例值:o-MYE42l80oelYMDE34nYD456Xoy
String userName
字段名:接收红包用户姓名 变量名:user_name 是否必填:否 类型:string[1,1024] 描述: 发放品牌红包时传入的接收红包用户姓名,已使用商户的私钥加密 示例值:757b340b45ebef5467rter35gf464344v3542sdf4t6re4tb4f54ty45t4yyry45
String initiateTime
字段名:品牌红包发起时间 变量名:initiate_time 是否必填:否 类型:string[1,32] 描述: 品牌红包发起的时间,遵循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
String updateTime
字段名:品牌红包更新时间 变量名:update_time 是否必填:是 类型:string[1,32] 描述: 品牌红包明细单最后一次状态变更时间,遵循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
Integer brandId
字段名:品牌ID 变量名:brand_id 是否必填:是 类型:int 描述: 品牌在微信支付进行品牌认证后的唯一标识品牌ID 示例值:1234
String templateId
字段名:品牌红包模板ID 变量名:template_id 是否必填:是 类型:string[1, 128] 描述: 品牌主配置的品牌红包模板ID 示例值:12340000000001
String brandAppid
字段名:品牌AppID 变量名:brand_appid 是否必填:否 类型:string[1, 32] 描述: 品牌商户在微信申请公众号/小程序或移动应用成功后分配的账号ID,该AppID需与品牌ID有绑定关系(B-A绑定关系) 示例值:wxf636efh567hg4356
String outBatchNo
字段名:商家品牌红包批次单号 变量名:out_batch_no 是否必填:是 类型:string[5, 32] 描述: 品牌商户系统内部区分品牌红包批次单下不同品牌红包明细单的唯一标识,要求此参数只能由数字、大小写字母组成 示例值:plfk2020042013
String batchNo
字段名:微信支付品牌红包批次单号 变量名:batch_no 是否必填:是 类型:string[32, 64] 描述: 微信批次单号,微信商家转账系统返回的唯一标识 示例值:1210000071100999991182020050700019480001
String createTime
字段名:品牌红包批次创建时间 变量名:create_time 是否必填:是 类型:string[1, 32] 描述: 批次受理成功时返回,遵循rfc3339标准格式, 格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。 例如:2015-05-20T13:29:35+08:00表示北京时间2015年05月20日13点29分35秒 示例值:2015-05-20T13:29:35+08:00
String mchid
微信支付分配的商户号 示例值:1230000109
String merchantName
商圈商户名称 示例值:微信支付
String shopName
门店名称,商圈在商圈小程序上圈店时填写的门店名称 示例值:微信支付
String shopNumber
门店编号,商圈在商圈小程序上圈店时填写的门店编号,用于跟商圈自身已有的商户识别码对齐 示例值:123456
String appid
顾客授权积分时使用的小程序的appid 示例值:wxd678efh567hg6787
String openid
顾客授权时使用的小程序上的openid 示例值:oUpF8uMuAJ2pxb1Q9zNjWeS6o
String timeEnd
交易完成时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示北京时间2015年05月20日13点29分35秒(需要增加所有跟时间有关的参数的描述) 示例值:2015-05-20T13:29:35+08:00
Integer amount
用户实际消费金额,单位(分) 示例值:200
String transactionId
微信支付订单号 示例值:1234567890
String commitTag
手动提交积分标记,自动提交时无该字段,用于区分用户手动申请后推送的积分数据 示例值:oUpF8uMuAJ2pxb1Q9zNjWUHsd
String subMchid
字段名:商圈商户ID 变量名:sub_mchid 是否必填:否 类型:string[1,64] 描述: 当以服务商模式管理商圈积分能力时,则要带上商圈商户ID,否则留空 示例值:1234567890
String transactionId
字段名:微信订单号 变量名:transaction_id 是否必填:是 类型:string[1,64] 描述: 微信支付推送的商圈内交易通知里携带的微信订单号 示例值:1217752501201407033233368018
String appid
字段名:小程序appid 变量名:appid 是否必填:是 类型:string[1,128] 描述: 顾客授权积分时使用的小程序的appid 示例值:wx1234567890abcdef
String openid
字段名:用户标识 变量名:openid 是否必填:是 类型:string[1,64] 描述: 顾客授权时使用的小程序上的openid 示例值:oWmnN4xxxxxxxxxxe92NHIGf1xd8
Boolean earnPoints
字段名:是否获得积分 变量名:earn_points 是否必填:是 类型:boolean 描述: 用于标明此单是否获得积分, true为获得积分, false为未获得 示例值:true
Integer increasedPoints
字段名:订单新增积分值 变量名:increased_points 是否必填:是 类型:int 描述: 顾客此笔交易新增的积分值 示例值:100
String pointsUpdateTime
字段名:积分更新时间 变量名:points_update_time 是否必填:是 类型:string[1,32] 描述: 为顾客此笔交易成功积分的时间 示例值:2020-05-20T13:29:35.120+08:00
String noPointsRemarks
字段名:未获得积分的备注信息 变量名:no_points_remarks 是否必填:否 类型:string[1,128] 描述: 当未获得积分时,提供未获得积分的原因等备注信息 示例值:商品不参与积分活动
Integer totalPoints
字段名:顾客积分总额 变量名:total_points 是否必填:否 类型:int 描述: 当前顾客积分总额 示例值:888888
String mchid
微信支付分配的商户号 示例值:1230000109
String merchantName
商圈商户名称 示例值:微信支付
String shopName
门店名称,商圈在商圈小程序上圈店时填写的门店名称 示例值:微信支付
String shop_number
门店编号,商圈在商圈小程序上圈店时填写的门店编号,用于跟商圈自身已有的商户识别码对齐 示例值:123456
String appid
顾客授权积分时使用的小程序的appid 示例值:wxd678efh567hg6787
String openid
顾客授权时使用的小程序上的openid 示例值:oUpF8uMuAJ2pxb1Q9zNjWeS6o
String refundTime
退款完成时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示北京时间2015年05月20日13点29分35秒(需要增加所有跟时间有关的参数的描述) 示例值:2015-05-20T13:29:35+08:00
Integer payAmount
用户实际消费金额,单位(分) 示例值:100
Integer refundAmount
用户退款金额,单位(分) 示例值:100
String transactionId
微信支付订单号 示例值:1234567890
String refundId
微信支付退款单号 示例值:1217752501201407033233368999
String complaintId
字段名:投诉单号 是否必填:是 描述:投诉单对应的投诉单号
String complaintId
字段名:投诉单号 是否必填:是 描述:投诉单对应的投诉单号
String complaintTime
字段名:投诉时间 是否必填:是 描述:投诉时间,遵循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
String complaintDetail
字段名:投诉详情 是否必填:是 投诉的具体描述
String complainedMchid
字段名:被诉商户号 是否必填:是 投诉单对应的被诉商户号。
String complaintState
字段名:投诉单状态 是否必填:是 标识当前投诉单所处的处理阶段,具体状态如下所示: PENDING:待处理 PROCESSING:处理中 PROCESSED:已处理完成
String payerPhone
字段名:投诉人联系方式 是否必填:否 投诉人联系方式。该字段已做加密处理,具体解密方法详见敏感信息加密说明。
String payerOpenid
字段名:投诉人openid 是否必填:是 投诉人在商户appid下的唯一标识
List<E> complaintMediaList
字段名:投诉资料列表 是否必填:是 用户上传的投诉相关资料,包括图片凭证等
List<E> complaintOrderInfo
字段名:投诉单关联订单信息 是否必填:是 投诉单关联订单信息 注:投诉单和订单目前是一对一关系,array是预留未来一对多的扩展
List<E> serviceOrderInfo
字段名:投诉单关联服务单信息 是否必填:否 投诉单关联服务单信息, 支付分服务单投诉时可能存在
Boolean complaintFullRefunded
字段名:投诉单是否已全额退款 是否必填:是 描述: 投诉单下所有订单是否已全部全额退款
Boolean incomingUserResponse
字段名:是否有待回复的用户留言 是否必填:是 描述: 投诉单是否有待回复的用户留言
String problemDescription
字段名:问题描述 是否必填:是 描述: 用户发起投诉前选择的faq标题(2021年7月15日之后的投诉单均包含此信息)
Integer userComplaintTimes
字段名:用户投诉次数 是否必填:是 描述: 用户投诉次数。用户首次发起投诉记为1次,用户每有一次继续投诉就加1
String problemType
字段名:问题类型 是否必填:否 描述:问题类型为申请退款的单据是需要最高优先处理的单据 REFUND:申请退款 SERVICE_NOT_WORK:服务权益未生效 OTHERS:其他类型 示例值:REFUND
Integer applyRefundAmount
字段名:用户投诉次数 是否必填:否 描述:仅当问题类型为申请退款时, 有值, (单位:分) 示例值:10
String[] userTagList
字段名:用户标签列表 是否必填:否 描述: TRUSTED:可信,此类用户满足极速退款条件 OTHERS:其它,此类用户不满足极速退款条件 示例值:[TRUSTED]
ComplaintDetailResult.AdditionalInfo additionalInfo
字段名:补充信息 是否必填:否 描述: 用在特定行业或场景下返回的补充信息
Boolean inPlatformService
字段名:是否在平台协助中 是否必填:否 描述:标识当前投诉单是否正处在平台协助流程中。 注:在协助期间由微信支付客服为用户服务,期间商户向用户发送的留言用户不可见
Boolean needImmediateService
字段名:是否需即时服务用户 是否必填:否 描述:因用户诉求紧急度、用户界面差异等因素,部分投诉单建议商户更即时地响应用户诉求。 如此处标识为“是”,建议商户提升服务时效,给用户带来更好的体验
String type
字段名:补充信息类型 是否必填:否 描述: 补充信息类型 示例值:SHARE_POWER_TYPE: 充电宝投诉相关行业
ComplaintDetailResult.AdditionalInfo.SharePowerInfo sharePowerInfo
字段名:充电宝投诉相关信息 是否必填:否 描述:当type为充电宝投诉相关时有值
String returnTime
字段名:归还时间 是否必填:否 描述:遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE, yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头, HH:mm:ss表示时分秒, TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。 示例值:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒
ComplaintDetailResult.AdditionalInfo.SharePowerInfo.ReturnAddressInfo returnAddressInfo
字段名:归还地点信息 是否必填:否 描述: 归还地点信息
Boolean isReturnedToSameMachine
字段名:是否归还同一柜机 是否必填:否 描述:用户声明是否将充电宝归还至与借取时同一柜机
String url
字段名:通知地址 是否必填:是 描述:通知地址,仅支持https。
Integer limit
字段名:分页大小 是否必填:否 描述:设置该次请求返回的最大投诉条数,范围【1,50】,商户自定义字段,不传默认为10。 注:如遇到提示“当前查询结果数据量过大”,是回包触发微信支付下行数据包大小限制,请缩小入参limit并重试。
Integer offset
字段名:分页开始位置 是否必填:否 描述:该次请求的分页开始位置,从0开始计数,例如offset=10,表示从第11条记录开始返回,不传默认为0 。
String beginDate
字段名:开始日期 是否必填:是 描述:投诉发生的开始日期,格式为yyyy-MM-DD。注意,查询日期跨度不超过30天,当前查询为实时查询
String endDate
字段名:结束日期 是否必填:是 描述:投诉发生的结束日期,格式为yyyy-MM-DD。注意,查询日期跨度不超过30天,当前查询为实时查询
String complaintedMchid
字段名:被诉商户号 是否必填:否 描述:投诉单对应的被诉商户号。
NegotiationHistoryResult.NegotiationHistory.ComplaintMedia complaintMediaList
字段名:投诉资料列表 是否必填:是 用户上传的投诉相关资料,包括图片凭证等
String logId
字段名:操作流水号 是否必填:是 描述: 操作流水号
String operator
字段名:操作人 是否必填:是 描述: 当前投诉协商记录的操作人
String operateTime
字段名:操作时间 是否必填:是 描述: 当前投诉协商记录的操作时间,遵循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
String operateType
字段名:操作类型 是否必填:是 描述: 当前投诉协商记录的操作类型,对应枚举: USER_CREATE_COMPLAINT: 用户提交投诉 USER_CONTINUE_COMPLAINT: 用户继续投诉 USER_RESPONSE: 用户留言 PLATFORM_RESPONSE: 平台留言 MERCHANT_RESPONSE: 商户留言 MERCHANT_CONFIRM_COMPLETE: 商户申请结单 USER_CREATE_COMPLAINT_SYSTEM_MESSAGE: 用户提交投诉系统通知 COMPLAINT_FULL_REFUNDED_SYSTEM_MESSAGE: 投诉单发起全额退款系统通知 USER_CONTINUE_COMPLAINT_SYSTEM_MESSAGE: 用户继续投诉系统通知 USER_REVOKE_COMPLAINT: 用户主动撤诉(只存在于历史投诉单的协商历史中) USER_COMFIRM_COMPLAINT: 用户确认投诉解决(只存在于历史投诉单的协商历史中) PLATFORM_HELP_APPLICATION: 平台催办 USER_APPLY_PLATFORM_HELP: 用户申请平台协助 MERCHANT_APPROVE_REFUND: 商户同意退款申请 MERCHANT_REFUSE_RERUND: 商户拒绝退款申请, 此时操作内容里展示拒绝原因 USER_SUBMIT_SATISFACTION: 用户提交满意度调查结果,此时操作内容里会展示满意度分数 SERVICE_ORDER_CANCEL: 服务订单已取消 SERVICE_ORDER_COMPLETE: 服务订单已完成 COMPLAINT_PARTIAL_REFUNDED_SYSTEM_MESSAGE: 投诉单发起部分退款系统通知 COMPLAINT_REFUND_RECEIVED_SYSTEM_MESSAGE: 投诉单退款到账系统通知 COMPLAINT_ENTRUSTED_REFUND_SYSTEM_MESSAGE: 投诉单受托退款系统通知 USER_APPLY_PLATFORM_SERVICE: 用户申请平台协助 USER_CANCEL_PLATFORM_SERVICE: 用户取消平台协助 PLATFORM_SERVICE_FINISHED: 客服结束平台协助
String operateDetails
字段名:操作内容 是否必填:否 描述: 当前投诉协商记录的具体内容
List<E> imageList
字段名:图片凭证 是否必填:是 描述: 当前投诉协商记录提交的图片凭证(url格式),最多返回4张图片,url有效时间为1小时。如未查询到协商历史图片凭证,则返回空数组。 注:本字段包含商户、微信支付客服在协商解决投诉时上传的图片凭证,若希望查看用户图片,请使用complaint_media_list字段并联系微信支付客服 注:此字段不包含用户提交的图片凭证,建议统一使用complaint_media_list字段接收和请求资料凭证,未来该字段将废弃
String userApplyPlatformServiceReason
字段名:用户申请平台协助原因 是否必填:否 描述:用户此次申请平台协助时选择的申请协助原因
String userApplyPlatformServiceReasonDescription
字段名:用户申请平台协助原因描述 是否必填:否 描述:用户此次申请平台协助时填写的具体申请协助原因描述
String complaintId
字段名:投诉单号 是否必填:是 描述:投诉单对应的投诉单号
String complaintedMchid
字段名:被诉商户号 是否必填:是 描述:投诉单对应的被诉商户号
String responseContent
字段名:回复内容 是否必填:是 描述:具体的投诉处理方案,限制200个字符以内。
List<E> responseImages
字段名:回复图片 是否必填:否 描述: 传入调用商户上传反馈图片接口返回的media_id,最多上传4张图片凭证 示例值:file23578_21798531.jpg
String jumpUrl
字段名:跳转链接 是否必填:是 描述: 商户可在回复中附加跳转链接,引导用户跳转至商户客诉处理页面,链接需满足https格式 注:配置文字链属于灰度功能, 若有需要请使用超管邮箱,按照要求发送邮件申请。邮件要求详情见: 商户申请开通留言链接白名单指南。 示例值:https://www.xxx.com/notify
String jumpUrlText
字段名:跳转链接文案 是否必填:否 描述: 实际展示给用户的文案,附在回复内容之后。用户点击文案,即可进行跳转。 注:若传入跳转链接,则跳转链接文案为必传项,二者缺一不可。
ResponseRequest.MiniProgramJumpInfo miniProgramJumpInfo
字段名:跳转小程序信息 是否必填:否 描述:商户可在回复中附加小程序信息,引导用户跳转至商户客诉处理小程序。 注:配置小程序属于灰度功能,若有需要请联系对接的行业运营进行咨询。
String complaintId
字段名:投诉单号 是否必填:是 描述:投诉单对应的投诉单号
String action
字段名:审批动作 是否必填:是 描述:同意 或 拒绝 可选取值: REJECT: 拒绝退款 APPROVE: 同意退款
Integer launchRefundDay
字段名:预计发起退款时间 是否必填:否 描述:在同意退款时返回,预计将在多少个工作日内能发起退款, 0代表当天
String rejectReason
字段名:拒绝退款原因 是否必填:否 string(200) 描述:在拒绝退款时返回拒绝退款的原因
List<E> rejectMediaList
字段名:拒绝退款的举证图片列表 是否必填:否 描述:在拒绝退款时,如果有拒绝的图片举证,可以提供 最多上传4张图片, 传入调用“商户上传反馈图片”接口返回的media_id,最多上传4张图片凭证
String remark
字段名:备注 是否必填:否 string(200) 描述:任何需要向微信支付客服反馈的信息
String couponId
字段名:代金券id 变量名:coupon_id 是否必填:是 示例值:1757 类型:String 说明:代金券id
String stockId
字段名:代金券批次号 变量名:stock_id 是否必填:是 示例值:58818 类型:String 说明:代金劵对应的批次号
String openid
字段名:用户openid 变量名:openid 是否必填:是 示例值:onqOjjrXT-776SpHnfexGm1_P7iE 类型:String 说明:Openid信息,用户在appid下的openid。
String opUserId
字段名:操作员 变量名:op_user_id 是否必填:否 示例值:10000098 类型:String(32) 说明:操作员帐号, 默认为商户号,可在商户平台配置操作员对应的api权限
String deviceInfo
字段名:设备号 变量名:device_info 是否必填:否 示例值: 类型:String(32) 说明:微信支付分配的终端设备号
String version
字段名:协议版本 变量名:version 是否必填:否 示例值:1.0 类型:String(32) 说明:默认1.0
String type
字段名:协议类型 变量名:type 是否必填:否 示例值:XML 类型:String(32) 说明:XML【目前仅支持默认XML】
String deviceInfo
字段名:设备号. 变量名:device_info 是否必填:否 示例值:123456sb 类型:String(32) 说明:微信支付分配的终端设备号,
String couponStockId
字段名:批次ID. 变量名:coupon_stock_id 是否必填:是 示例值:1567 类型:String 说明:代金券批次Id
String couponId
字段名:代金券id. 变量名:coupon_id 是否必填:是 示例值:4242 类型:String 说明:代金券id
Integer couponValue
字段名:代金券面额. 变量名:coupon_value 是否必填:是 示例值:4 类型:Unsinged int 说明:代金券面值,单位是分
Integer couponMinimum
字段名:代金券使用门槛. 变量名:coupon_minimum 微信文档有误 是否必填:是 示例值:10 类型:Unsinged int 说明:代金券使用最低限额,单位是分
String couponName
字段名:代金券名称. 变量名:coupon_name 是否必填:是 示例值:测试代金券 类型:String 说明:代金券名称
String couponState
字段名:代金券状态. 变量名:coupon_state 是否必填:是 示例值:SENDED 类型:String 说明:代金券状态:SENDED-可用,USED-已实扣,EXPIRED-已过期
String couponDesc
字段名:代金券描述. 变量名:coupon_desc 是否必填:是 示例值:微信支付-代金券 类型:String 说明:代金券描述
Integer couponUseValue
字段名:实际优惠金额. 变量名:coupon_use_value 是否必填:是 示例值:0 类型:Unsinged int 说明:代金券实际使用金额
Integer couponRemainValue
字段名:优惠剩余可用额. 变量名:coupon_remain_value 是否必填:是 示例值:4 类型:Unsinged int 说明:代金券剩余金额:部分使用情况下,可能会存在券剩余金额
String beginTime
字段名:生效开始时间. 变量名:begin_time 是否必填:是 示例值:1943787483 类型:String 说明:格式为时间戳
String endTime
字段名:生效结束时间. 变量名:end_time 是否必填:是 示例值:1943787484 类型:String 说明:格式为时间戳
String sendTime
字段名:发放时间. 变量名:send_time 是否必填:是 示例值:1943787420 类型:String 说明:格式为时间戳
String consumerMchId
字段名:消耗方商户id. 变量名:consumer_mch_id 是否必填:否 示例值:10000098 类型:String 说明:代金券使用后,消耗方商户id
String sendSource
字段名:发放来源. 变量名:send_source 是否必填:是 示例值:FULL_SEND 类型:String 说明:代金券发放来源:FULL_SEND-满送 NORMAL-普通发放场景
String isPartialUse
字段名:是否允许部分使用. 变量名:is_partial_use 是否必填:否 示例值:1 类型:String 说明:该代金券是否允许部分使用标识:1-表示支持部分使用
String couponStockId
字段名:代金券批次id 变量名:coupon_stock_id 是否必填:是 示例值:1757 类型:String 说明:代金券批次id
Integer openidCount
字段名:openid记录数 变量名:openid_count 是否必填:是 示例值:1 类型:int 说明:openid记录数(目前支持num=1)
String partnerTradeNo
字段名:商户单据号 变量名:partner_trade_no 是否必填:是 示例值:1000009820141203515766 类型:String 说明:商户此次发放凭据号(格式:商户id+日期+流水号),商户侧需保持唯一性
String openid
字段名:用户openid 变量名:openid 是否必填:是 示例值:onqOjjrXT-776SpHnfexGm1_P7iE 类型:String 说明:Openid信息,用户在appid下的openid。
String opUserId
字段名:操作员 变量名:op_user_id 是否必填:否 示例值:10000098 类型:String(32) 说明:操作员帐号, 默认为商户号,可在商户平台配置操作员对应的api权限
String deviceInfo
字段名:设备号 变量名:device_info 是否必填:否 示例值: 类型:String(32) 说明:微信支付分配的终端设备号
String version
字段名:协议版本 变量名:version 是否必填:否 示例值:1.0 类型:String(32) 说明:默认1.0
String type
字段名:协议类型 变量名:type 是否必填:否 示例值:XML 类型:String(32) 说明:XML【目前仅支持默认XML】
String deviceInfo
字段名:设备号 变量名:device_info 是否必填:否 示例值:123456sb 类型:String(32) 描述:微信支付分配的终端设备号,
String couponStockId
字段名:代金券批次id 变量名:coupon_stock_id 是否必填:是 示例值:1757 类型:String 描述:用户在商户appid下的唯一标识
Integer respCount
字段名:返回记录数 变量名:resp_count 是否必填:是 示例值:1 类型:Int 描述:返回记录数
Integer successCount
字段名:成功记录数 变量名:success_count 是否必填:是 示例值:1或者0 类型:Int 描述:成功记录数
Integer failedCount
字段名:失败记录数 变量名:failed_count 是否必填:是 示例值:1或者0 类型:Int 描述:失败记录数
String openid
字段名:用户标识 变量名:openid 是否必填:是 示例值:onqOjjrXT-776SpHnfexGm1_P7iE 类型:String 描述:用户在商户appid下的唯一标识
String retCode
字段名:返回码 变量名:ret_code 是否必填:是 示例值:SUCCESS或者FAILED 类型:String 描述:返回码,SUCCESS/FAILED
String couponId
字段名:代金券id 变量名:coupon_id 是否必填:是 示例值:1870 类型:String 描述:对一个用户成功发放代金券则返回代金券id,即ret_code为SUCCESS的时候;如果ret_code为FAILED则填写空串""
String retMsg
字段名:返回信息 变量名:ret_msg 是否必填:是 示例值:失败描述信息,例如:“用户已达领用上限” 类型:String 描述:返回信息,当返回码是FAILED的时候填写,否则填空串“”
String couponStockId
字段名:代金券批次id 变量名:coupon_stock_id 是否必填:是 示例值:1757 类型:String 说明:代金券批次id
String opUserId
字段名:操作员 变量名:op_user_id 是否必填:否 示例值:10000098 类型:String(32) 说明:操作员帐号, 默认为商户号,可在商户平台配置操作员对应的api权限
String deviceInfo
字段名:设备号 变量名:device_info 是否必填:否 示例值: 类型:String(32) 说明:微信支付分配的终端设备号
String version
字段名:协议版本 变量名:version 是否必填:否 示例值:1.0 类型:String(32) 说明:默认1.0
String type
字段名:协议类型 变量名:type 是否必填:否 示例值:XML 类型:String(32) 说明:XML【目前仅支持默认XML】
String deviceInfo
字段名:设备号. 变量名:device_info 是否必填:否 示例值:123456sb 类型:String(32) 说明:微信支付分配的终端设备号
String couponStockId
字段名:代金券批次ID. 变量名:coupon_stock_id 是否必填:是 示例值:1757 类型:String 说明:代金券批次Id
String couponName
字段名:代金券名称. 变量名:coupon_name 是否必填:否 示例值:测试代金券 类型:String 说明:代金券名称
Integer couponValue
字段名:代金券面额. 变量名:coupon_value 是否必填:是 示例值:5 类型:Unsinged int 说明:代金券面值,单位是分
Integer couponMinimum
字段名:代金券使用最低限额. 变量名:coupon_mininumn 是否必填:否 示例值:10 类型:Unsinged int 说明:代金券使用最低限额,单位是分
Integer couponStockStatus
字段名:代金券批次状态. 变量名:coupon_stock_status 是否必填:是 示例值:4 类型:int 说明:批次状态: 1-未激活;2-审批中;4-已激活;8-已作废;16-中止发放;
Integer couponTotal
字段名:代金券数量. 变量名:coupon_total 是否必填:是 示例值:100 类型:Unsigned int 说明:代金券数量
Integer maxQuota
字段名:代金券最大领取数量. 变量名:max_quota 是否必填:否 示例值:1 类型:Unsigned int 说明:代金券每个人最多能领取的数量, 如果为0,则表示没有限制
Integer isSendNum
字段名:代金券已经发送的数量. 变量名:is_send_num 是否必填:否 示例值:0 类型:Unsigned int 说明:代金券已经发送的数量
String beginTime
字段名:生效开始时间. 变量名:begin_time 是否必填:是 示例值:1943787483 类型:String 说明:格式为时间戳
String endTime
字段名:生效结束时间. 变量名:end_time 是否必填:是 示例值:1943787490 类型:String 说明:格式为时间戳
String createTime
字段名:创建时间. 变量名:create_time 是否必填:是 示例值:1943787420 类型:String 说明:格式为时间戳
Integer couponBudget
字段名:代金券预算额度. 变量名:coupon_budget 是否必填:否 示例值:500 类型:Unsigned int 说明:代金券预算额度
String appid
字段名:机构APPID 变量名:appid 是否必填:是 类型:string(32) 描述: 微信分配的公众账号ID 示例值:wxd678efh567hg6787
String mchid
字段名:商户号 变量名:mchid 是否必填:是 类型:string(32) 描述: 微信支付分配的商户号 示例值:1230000109
String orderType
字段名:订单类型 变量名:order_type 是否必填:是 类型:string(16) 描述: 4种订单号类型,选择一种 out_trade_no 商户订单号 transaction_id 微信支付订单号 sub_order_no 商户子订单号 sub_order_id 微信子订单号 示例值:out_trade_no
String orderNo
字段名:订单号 变量名:order_no 是否必填:是 类型:string(32) 描述: 根据订单号类型,传入不同的订单号码 示例值:20150806125346
String customs
字段名:海关 变量名:customs 是否必填:是 类型:string(32) 描述: 海关代码, 枚举值参见参数规定-海关列表(https://pay.weixin.qq.com/wiki/doc/api/wxpay/ch/declarecustom_ch/chapter2_3.shtml#menu11) 示例值:SHANGHAI_ZS
String offset
字段名:偏移量 变量名:offset 是否必填:是 类型:int 描述: 非0整数,该次请求资源的起始位置,从0开始计数。调用方选填,默认为0 示例值:0
String limit
字段名:请求最大记录条数 变量名:limit 是否必填:是 类型:int 描述: 非0非负的整数,该次请求可返回的最大资源条数。调用方选填,默认值建议为20 示例值:20
String appid
字段名:机构APPID 变量名:appid 是否必填:是 类型:string(32) 描述: 微信分配的公众账号ID 示例值:wxd678efh567hg6787
String mchid
字段名:商户号 变量名:mchid 是否必填:是 类型:string(32) 描述: 微信支付分配的商户号 示例值:1230000109
String transactionId
字段名:微信支付返回的订单号 变量名:transaction_id 是否必填:是 类型:string(32) 描述: 微信分配的公众账号ID 示例值:1000320306201511078440737890
String verifyDepartment
字段名:核验机构 变量名:verify_department 是否必填:是 类型:string(16) 描述: 核验机构代码 UNIONPAY:银联 NETSUNION:网联 OTHERS:其他 示例值:UNIONPAY
String verifyDepartmentTradeId
字段名:核验机构交易流水号 变量名:Verify_department_trade_id 是否必填:是 类型:string(64) 描述: 交易流水号,来自验核机构,如银联记录的交易流水号,供商户报备海关 示例值:2018112288340107038204310100000
Integer offset
字段名:偏移量 变量名:offset 是否必填:是 类型:int 描述: 非0整数,该次请求资源的起始位置,从0开始计数。调用方选填,默认为0 示例值:0
Integer limit
字段名:请求最大记录条数 变量名:limit 是否必填:是 类型:int 描述: 非0非负的整数,该次请求可返回的最大资源条数。调用方选填,默认值建议为20 示例值:20
Integer totalCount
字段名:查询结果总条数 变量名:total_count 是否必填:是 类型:int 描述: 查询结果总条数 示例值:1
List<E> data
字段名:报关数据包 变量名:data 是否必填:是 类型:array 描述: 报关单结果数组,具体内容参见下方描述 示例值:
String appid
字段名:机构APPID 变量名:appid 是否必填:是 类型:string(32) 描述: 微信分配的公众账号ID 示例值:wxd678efh567hg6787
String mchid
字段名:商户号 变量名:mchid 是否必填:是 类型:string(32) 描述: 微信支付分配的商户号 示例值:1230000109
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string(32) 描述: 商户系统内部订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一 示例值:20150806125346
String transactionId
字段名:微信支付返回的订单号 变量名:transaction_id 是否必填:是 类型:string(32) 描述: 微信分配的公众账号ID 示例值:1000320306201511078440737890
String customs
字段名:海关 变量名:customs 是否必填:是 类型:string(32) 描述: 海关代码, 枚举值参见参数规定-海关列表(https://pay.weixin.qq.com/wiki/doc/api/wxpay/ch/declarecustom_ch/chapter2_3.shtml#menu11) 示例值:SHANGHAI_ZS
String merchantCustomsNo
字段名:商户海关备案号 变量名:merchant_customs_no 是否必填:是 类型:string(32) 描述: 商户在海关登记的备案号 示例值:123456
Integer duty
字段名:关税 变量名:duty 是否必填:否 类型:int 描述: 关税,以分为单位,非必填项,不会提交给海关 示例值:888
String subOrderNo
字段名:商户子订单号 变量名:sub_order_no 是否必填:是 类型:string(32) 描述: 商户子订单号,如有拆单则必传 注意:仅适用于机构模式 示例值:20150806125346
String feeType
字段名:货币类型 变量名:fee_type 是否必填:否 类型:string(32) 描述: 微信支付订单支付时使用的币种,暂只支持人民币CNY,如有拆单则必传 示例值:CNY
Integer orderFee
字段名:子订单金额 变量名:order_fee 是否必填:否 类型:int 描述: 子订单金额,以分为单位,不能超过原订单金额,order_fee=transport_fee+product_fee(应付金额=物流费+商品价格),如有拆单则必传 示例值:888
Integer transportFee
字段名:物流费用 变量名:transport_fee 是否必填:否 类型:int 描述: 物流费用,以分为单位,如有拆单则必传 示例值:888
Integer productFee
字段名:商品费用 变量名:product_fee 是否必填:否 类型:int 描述: 商品费用,以分为单位,如有拆单则必传 示例值:888
String appid
字段名:机构APPID 变量名:appid 是否必填:是 类型:string(32) 描述: 微信分配的公众账号ID 示例值:wxd678efh567hg6787
String mchid
字段名:商户号 变量名:mchid 是否必填:是 类型:string(32) 描述: 微信支付分配的商户号 示例值:1230000109
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string(32) 描述: 商户系统内部订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一 示例值:wxd678efh567hg6787
String transactionId
字段名:微信支付返回的订单号 变量名:transaction_id 是否必填:是 类型:string(32) 描述: 微信分配的公众账号ID 示例值:1000320306201511078440737890
String state
字段名:报关状态 变量名:state 是否必填:是 类型:string(32) 描述: 申报结果状态码 PROCESSING:申报中 UNDECLARED:未申报 SUBMITTED:已修改未申报 SUCCESS:申报成功 FAIL:申报失败 EXCEPT:海关接口异常 示例值:PROCESSING
String subOrderNo
字段名:商户子订单号 变量名:sub_order_no 是否必填:否 类型:string(32) 描述: 微信子订单号,如有拆单则返回 示例值:20150806125346
String subOrderId
字段名:微信子订单号 变量名:sub_order_id 是否必填:否 类型:string(32) 描述: 商户子订单号,如有拆单则必传 注意:仅适用于机构模式 示例值:20150806125346
String verifyDepartment
字段名:核验机构 变量名:verify_department 是否必填:是 类型:string(16) 描述: 核验机构代码 UNIONPAY:银联 NETSUNION:网联 OTHERS:其他 示例值:UNIONPAY
String verifyDepartmentTradeId
字段名:核验机构交易流水号 变量名:Verify_department_trade_id 是否必填:是 类型:string(64) 描述: 交易流水号,来自验核机构,如银联记录的交易流水号,供商户报备海关 示例值:2018112288340107038204310100000
String appid
字段名:机构APPID 变量名:appid 是否必填:是 类型:string(32) 描述: 微信分配的公众账号ID 示例值:wxd678efh567hg6787
String mchid
字段名:商户号 变量名:mchid 是否必填:是 类型:string(32) 描述: 微信支付分配的商户号 示例值:1230000109
String transactionId
字段名:微信订单号 变量名:transaction_id 是否必填:是 类型:string(32) 描述: out_trade_no, transaction_id二选一传入 示例值:1000320306201511078440737890
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string(32) 描述: out_trade_no, transaction_id二选一传入 示例值:20150806125346
String subOrderNo
字段名:商户子订单号 变量名:sub_order_no 是否必填:是 类型:string(32) 描述: 商户子订单号,如有拆单则必传 注意:仅适用于机构模式 示例值:20150806125346
String subOrderId
字段名:微信子订单号 变量名:sub_order_id 是否必填:否 类型:string(32) 描述: 商户子订单号,如有拆单则必传 注意:仅适用于机构模式 示例值:20150806125346
String customs
字段名:海关 变量名:customs 是否必填:是 类型:string(32) 描述: 海关代码, 枚举值参见参数规定-海关列表(https://pay.weixin.qq.com/wiki/doc/api/wxpay/ch/declarecustom_ch/chapter2_3.shtml#menu11) 示例值:SHANGHAI_ZS
String merchantCustomsNo
字段名:商户海关备案号 变量名:merchant_customs_no 是否必填:是 类型:string(32) 描述: 商户在海关登记的备案号 示例值:123456
String appid
字段名:机构APPID 变量名:appid 是否必填:是 类型:string(32) 描述: 微信分配的公众账号ID 示例值:wxd678efh567hg6787
String mchid
字段名:商户号 变量名:mchid 是否必填:是 类型:string(32) 描述: 微信支付分配的商户号 示例值:1230000109
String transactionId
字段名:微信订单号 变量名:transaction_id 是否必填:是 类型:string(32) 描述: 微信支付返回的订单号 示例值:1000320306201511078440737890
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string(32) 描述: 商户系统内部订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一 示例值:20150806125346
String subOrderNo
字段名:商户子订单号 变量名:sub_order_no 是否必填:是 类型:string(32) 描述: 商户子订单号,如有拆单则必传 注意:仅适用于机构模式 示例值:20150806125346
String subOrderId
字段名:微信子订单号 变量名:sub_order_id 是否必填:否 类型:string(32) 描述: 商户子订单号,如有拆单则必传 注意:仅适用于机构模式 示例值:20150806125346
String state
字段名:报关状态 变量名:state 是否必填:是 类型:string(32) 描述: 申报结果状态码 PROCESSING:申报中 UNDECLARED:未申报 SUBMITTED:已修改未申报 SUCCESS:申报成功 FAIL:申报失败 EXCEPT:海关接口异常 示例值:PROCESSING
String explanation
字段名:报关结果说明 变量名:explanation 是否必填:是 类型:string(128) 描述: 申报结果说明,如果状态是失败或异常,显示失败原因 示例值:支付单已存在并且为非退单状态
String modifyTime
字段名:最后更新时间 变量名:modify_time 是否必填:是 类型:string(32) 描述: 最后更新时间,该时间取自微信服务器 示例值:2015-09-01T10:00:00+08:00
String appid
字段名:机构APPID 变量名:appid 是否必填:是 类型:string(32) 描述: 微信分配的公众账号ID 示例值:wxd678efh567hg6787
String mchid
字段名:商户号 变量名:mchid 是否必填:是 类型:string(32) 描述: 微信支付分配的商户号 示例值:1230000109
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string(32) 描述: 商户系统内部订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一 示例值:20150806125346
String transactionId
字段名:微信支付返回的订单号 变量名:transaction_id 是否必填:是 类型:string(32) 描述: 微信分配的公众账号ID 示例值:1000320306201511078440737890
String customs
字段名:海关 变量名:customs 是否必填:是 类型:string(32) 描述: 海关代码, 枚举值参见参数规定-海关列表(https://pay.weixin.qq.com/wiki/doc/api/wxpay/ch/declarecustom_ch/chapter2_3.shtml#menu11) 示例值:SHANGHAI_ZS
String merchantCustomsNo
字段名:商户海关备案号 变量名:merchant_customs_no 是否必填:是 类型:string(32) 描述: 商户在海关登记的备案号 示例值:123456
String subOrderNo
字段名:商户子订单号 变量名:sub_order_no 是否必填:是 类型:string(32) 描述: 商户子订单号,如有拆单则必传 注意:仅适用于机构模式 示例值:20150806125346
String certificateType
字段名:证件类型 变量名:certificate_type 是否必填:是 类型:string(16) 描述: 请传固定值IDCARD,暂只支持大陆身份证 示例值:IDCARD
String certificateId
字段名:证件号 变量名:certificate_id 是否必填:是 类型:string 描述: 用户大陆身份证号,尾号为字母X的身份证号,请大写字母X。该字段需要进行加密 示例值:330821198809085211
String certificateName
字段名:证件姓名 变量名:certificate_name 是否必填:是 类型:string 描述: 证件姓名,字段值需要进行加密 示例值:330821198809085211
String appid
字段名:机构APPID 变量名:appid 是否必填:是 类型:string(32) 描述: 微信分配的公众账号ID 示例值:wxd678efh567hg6787
String mchid
字段名:商户号 变量名:mchid 是否必填:是 类型:string(32) 描述: 微信支付分配的商户号 示例值:1230000109
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string(32) 描述: 商户系统内部订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一 示例值:20150806125346
String transactionId
字段名:微信支付返回的订单号 变量名:transaction_id 是否必填:是 类型:string(32) 描述: 微信分配的公众账号ID 示例值:1000320306201511078440737890
String certificateCheckResult
字段名:身份核验结果 变量名:certificate_check_result 是否必填:是 类型:string(32) 描述: 订购人和支付人身份信息校验结果 SAME:身份信息校验匹配 DIFFERENT:身份信息校验不匹配 示例值:SAME
String mediaId
String applicationType
String applicationMediaId
String outApplyNo
String subMchid
String rejectReason
String cancelState
String updateTime
String outRequestNo
字段名:业务申请编号 变量名:out_request_no 是否必填:是 类型:string(124) 描述: 1、服务商自定义的商户唯一编号。 2、每个编号对应一个申请单,每个申请单审核通过后会生成一个微信支付商户号。 3、若申请单被驳回,可填写相同的“业务申请编号”,即可覆盖修改原申请单信息 。 示例值:APPLYMENT_00000000001
String organizationType
字段名:主体类型 变量名:organization_type 是否必填:是 类型:string(4) 描述: 非小微的主体类型需与营业执照/登记证书上一致,可参考选择主体指引,枚举值如下。 2401:小微商户,指无营业执照的个人商家。 2500:个人卖家,指无营业执照,已持续从事电子商务经营活动满6个月,且期间经营收入累计超过20万元的个人商家。(若选择该主体,请在“补充说明”填写相关描述)。 4:个体工商户,营业执照上的主体类型一般为个体户、个体工商户、个体经营。 2:企业,营业执照上的主体类型一般为有限公司、有限责任公司。 3:事业单位,包括国内各类事业单位,如:医疗、教育、学校等单位。 2502:政府机关,包括各级、各类政府机关,如机关党委、税务、民政、人社、工商、商务、市监等。 1708:社会组织,包括社会团体、民办非企业、基金会、基层群众性自治组织、农村集体经济组织等组织。 示例值:2
Boolean financeInstitution
字段名:是否金融机构 变量名:finance_institution 是否必填:条件选填 类型:bool 描述: 选填,请根据申请主体的实际情况填写,可参考选择金融机构指引: 1、若商户主体是金融机构,则填写:true。 2、若商户主体不是金融机构,则填写:false。 若未传入将默认填写:false。 示例值:true
ApplymentsRequest.BusinessLicenseInfo businessLicenseInfo
字段名:+营业执照/登记证书信息 变量名:business_license_info 是否必填:条件选填 类型:object 描述: 1、主体为“小微/个人卖家”时,不填。 2、主体为“个体工商户/企业”时,请上传营业执照。 3、主体为“政府机关/事业单位/社会组织”时,请上传登记证书。
ApplymentsRequest.FinanceInstitutionInfo financeInstitutionInfo
字段名:+金融机构许可证信息 变量名:finance_institution_info 是否必填:条件选填 类型:object 描述:当主体是金融机构时,必填
String idHolderType
String idDocType
字段名:经营者/法人证件类型 变量名:id_doc_type 是否必填:条件选填 类型:string(64) 描述: 1、当证件持有人类型为经营者/法人时,需要填写。其他情况,无需上传。 2、主体为“小微/个人卖家”,可选择:身份证。 3、主体为“个体户/企业/事业单位/社会组织”:可选择任一证件类型,主体为“政府机关”仅支持中国大陆居民-身份证类型。 4、若没有填写,系统默认选择:身份证。 枚举值: IDENTIFICATION_TYPE_MAINLAND_IDCARD:中国大陆居民-身份证 IDENTIFICATION_TYPE_OVERSEA_PASSPORT:其他国家或地区居民-护照 IDENTIFICATION_TYPE_HONGKONG:中国香港居民--来往内地通行证 IDENTIFICATION_TYPE_MACAO:中国澳门居民--来往内地通行证 IDENTIFICATION_TYPE_TAIWAN:中国台湾居民--来往大陆通行证 IDENTIFICATION_TYPE_FOREIGN_RESIDENT:外国人居留证 IDENTIFICATION_TYPE_HONGKONG_MACAO_RESIDENT:港澳居民证 IDENTIFICATION_TYPE_TAIWAN_RESIDENT:台湾居民证 示例值:IDENTIFICATION_TYPE_MAINLAND_IDCARD
String authorizeLetterCopy
字段名:法定代表人说明函 变量名:authorize_letter_copy 是否必填:条件选填 类型:string(256) 描述: 1、当证件持有人类型为经办人时,必须上传。其他情况,无需上传。 2、若因特殊情况,无法提供法定代表人证件时,请参照示例图打印法定代表人说明函,全部信息需打印,不支持手写商户信息,并加盖公章。 3、可上传1张图片,请填写通过图片上传API预先上传图片生成好的MediaID。 示例值:47ZC6GC-vnrbEny_Ie_An5-tCpqxucuxi-vByf3Gjm7KEIUv0OF4wFNIO4kqg05InE4d2I6_H7I4
ApplymentsRequest.IdCardInfo idCardInfo
字段名:+经营者/法人身份证信息 变量名:id_card_info 是否必填:条件选填 类型:object 描述: 当证件持有人类型为经营者/法人且证件类型为“身份证”时填写。
ApplymentsRequest.IdDocInfo idDocInfo
字段名:+经营者/法人其他类型证件信息 变量名:id_doc_info 是否必填:条件选填 类型:object 描述:当证件持有人类型为经营者/法人且证件类型不为“身份证”时填写。
Boolean owner
字段名:经营者/法人是否为受益人 变量名:owner 是否必填:条件选填 类型:bool 描述:主体类型为企业时,需要填写:1、若经营者/法人是最终受益人,则填写:true。2、若经营者/法人不是最终受益人,则填写:false。 示例值:true
List<E> uboInfoList
字段名:最终受益人信息列表 变量名:ubo_info_list 是否必填:条件选填 类型:bool 描述: 仅企业需要填写。 若经营者/法人不是最终受益所有人,则需提填写受益所有人信息,最多上传4个。 若经营者/法人是最终受益所有人之一,可在此填写其他受益所有人信息,最多上传3个。 根据国家相关法律法规,需要提供公司受益所有人信息,受益所有人需符合至少以下条件之一: 1、直接或者间接拥有超过25%公司股权或者表决权的自然人。 2、通过人事、财务等其他方式对公司进行控制的自然人。 3、公司的高级管理人员,包括公司的经理、副经理、财务负责人、上市公司董事会秘书和公司章程规定的其他人员。
ApplymentsRequest.AccountInfo accountInfo
字段名:+结算账户信息 变量名:account_info 是否必填:是 类型:object 描述:请填写商家提现收款的银行账户信息
ApplymentsRequest.ContactInfo contactInfo
字段名:+超级管理员信息 变量名:contact_info 是否必填:是 类型:object 描述: 请填写店铺的超级管理员信息。 超级管理员需在开户后进行签约,并可接收日常重要管理信息和进行资金操作,请确定其为商户法定代表人或负责人。
ApplymentsRequest.SalesSceneInfo salesSceneInfo
字段名:+店铺信息 变量名:sales_scene_info 是否必填:是 类型:object 描述:请填写店铺信息
ApplymentsRequest.SettlementInfo settlementInfo
字段名:+结算规则 变量名:settlement_info 是否必填:否 类型:object 描述:请填写商家的结算费率规则、所属行业等信息。若电商平台未传入,系统将填写默认值
String merchantShortname
字段名:商户简称 变量名:merchant_shortname 是否必填:是 类型:string(64) 描述: UTF-8格式,中文占3个字节,即最多21个汉字长度。将在支付完成页向买家展示,需与商家的实际售卖商品相符 。 示例值:腾讯
String qualifications
字段名:特殊资质 变量名:qualifications 是否必填:否 类型:string(1024) 描述: 1、根据商户经营业务要求提供相关资质,详情查看《行业对应特殊资质》。 2、请提供为“申请商家主体”所属的特殊资质,可授权使用总公司/分公司的特殊资 质; 3、最多可上传5张照片,请填写通过图片上传接口预先上传图片生成好的MediaID 。 示例值:jTpGmxUX3FBWVQ5NJInE4d2I6_H7I4
String businessAdditionPics
字段名:补充材料 变量名:business_addition_pics 是否必填:否 类型:string(1024) 描述: 根据实际审核情况,额外要求提供。最多可上传5张照片,请填写通过图片上传接口预先上传图片生成好的MediaID 。 示例值:jTpGmg05InE4d2I6_H7I4
String businessAdditionDesc
字段名:补充说明 变量名:business_addition_desc 是否必填:否 类型:string(512) 描述: 1、若主体为“个人卖家”,该字段必传,则需填写描述“ 该商户已持续从事电子商务经营活动满6个月,且期间经营收入累计超过20万元。” 示例值:特殊情况,说明原因
String bankAccountType
字段名:账户类型 变量名:bank_account_type 是否必填:是 类型:string(2) 描述: 1、若主体为企业/政府机关/事业单位/社会组织,可填写:74-对公账户。 2、主体为小微/个人卖家,可选择:75-对私账户。 3、若主体为个体工商户,可填写:74-对公账户、75-对私账户。 示例值:75
String accountBank
字段名:开户银行 变量名:account_bank 是否必填:是 类型:string(10) 描述: 对私银行调用:查询支持个人业务的银行列表API 对公银行调用:查询支持对公业务的银行列表API。 示例值:工商银行
String accountName
字段名:开户名称 变量名:account_name 是否必填:是 类型:string(128) 描述: 1、选择经营者个人银行卡时,开户名称必须与身份证姓名一致。 2、选择对公账户时,开户名称必须与营业执照上的“商户名称”一致。 3、该字段需进行加密处理,加密方法详见敏感信息加密说明。(提醒:必须在HTTP头中上送Wechatpay-Serial) 示例值:AOZdYGISxo4y44/UgZ69bdu9X+tfMUJ9dl+LetjM45/zMbrYu+wWZ8gn4CTdo+D/m9MrPg+V4sm73oxqdQu/hj7aWyDl4GQtPXVdaztB9jVbVZh3QFzV+BEmytMNQp9dt1uWJktlfdDdLR3AMWyMB377xd+m9bSr/ioDTzagEcGe+vLYiKrzcroQv3OR0p3ppFYoQ3IfYeU/04S4t9rNFL+kyblK2FCCqQ11NdbbHoCrJc7NV4oASq6ZFonjTtgjjgKsadIKHXtb3JZKGZjduGdtkRJJp0/0eow96uY1Pk7Rq79Jtt7+I8juwEc4P4TG5xzchG/5IL9DBd+Z0zZXkw==
String bankAddressCode
字段名:开户银行省市编码 变量名:bank_address_code 是否必填:是 类型:string(12) 描述: 至少精确到市,详细参见省市区编号对照表。 注: 仅当省市区编号对照表中无对应的省市区编号时,可向上取该银行对应市级编号或省级编号。 示例值:110000
String bankBranchId
字段名:开户银行联行号 变量名:bank_branch_id 是否必填:条件选填 类型:string(64) 描述: 1、根据开户银行查询接口中的“是否需要填写支行”判断是否需要填写。如为其他银行,开户银行全称(含支行)和开户银行联行号二选一。 2、详细需调用查询支行列表API查看查询结果。 示例值:402713354941
String bankName
字段名:开户银行全称 (含支行) 变量名:bank_name 是否必填:条件选填 类型:string(128) 描述: 1、根据开户银行查询接口中的“是否需要填写支行”判断是否需要填写。如为其他银行,开户银行全称(含支行)和开户银行联行号二选一。 2、详细需调用查询支行列表API查看查询结果。 示例值:中国工商银行股份有限公司北京市分行营业部
String accountNumber
字段名:银行帐号 变量名:account_number 是否必填:是 类型:string(128) 描述: 1、数字,长度遵循系统支持的对公/对私卡号长度要求表。 2、该字段需进行加密处理,加密方法详见敏感信息加密说明。(提醒:必须在HTTP头中上送Wechatpay-Serial) 示例值: d+xT+MQCvrLHUVDWv/8MR/dB7TkXLVfSrUxMPZy6jWWYzpRrEEaYQE8ZRGYoeorwC+w==
ApplymentsRequest.AccountInfo.AccountCertInfo accountCertInfo
字段名:+银行帐户证明材料 变量名:account_cert_info 是否必填:否 类型:string(128) 描述: 1. 当主体类型是“政府机关/事业单位”时或所属行业为“党费”时,支持在有合法资金管理关系的情况下结算账户设置为非同名。 2. 若结算账户设置为非同名,则需填写非同名证明材料,若结算账户为同名,则无需填写。
String settlementCertPic
字段名:结算证明函 变量名:settlement_cert_pic 是否必填:是 类型:string(256) 描述: 1. 请参照示例图打印结算证明函。 2、可上传1张图片,请填写通过图片上传API预先上传图片生成好的MediaID。 示例值:47ZC6GC-vnrbEny_Ie_An5-tCpqxucuxi-vByf3Gjm7KEIUv0OF4wFNIO4kqg05InE4d2I6_H7I4
String relationCertPic
字段名:关系证明函 变量名:relation_cert_pic 是否必填:是 类型:string(256) 描述: 1. 请参照示例图打印关系证明函。 2、可上传1张图片,请填写通过图片上传API预先上传图片生成好的MediaID。 示例值:47ZC6GC-vnrbEny_Ie_An5-tCpqxucuxi-vByf3Gjm7KEIUv0OF4wFNIO4kqg05InE4d2I6_H7I4
String otherCertPics
字段名:其他补充证明 变量名:other_cert_pics 是否必填:是 类型:array 描述: 1. 请提供非同名结算的法律法规、政策通知、政府或上级部门公文等证明文件,以作上述材料的补充证明。 2、可上传1-3张图片,请填写通过图片上传API预先上传图片生成好的MediaID。 示例值:47ZC6GC-vnrbEny_Ie_An5-tCpqxucuxi-vByf3Gjm7KEIUv0OF4wFNIO4kqg05InE4d2I6_H7I4
String certType
字段名:证书类型 变量名:cert_type 是否必填:条件选填 类型:string 描述: 1、主体为“政府机关/事业单位/社会组织”时,请上传登记证书类型。 2、主体为“个体工商户/企业”时,不填。 当主体为事业单位时,选择此枚举值: CERTIFICATE_TYPE_2388:事业单位法人证书 当主体为政府机关,选择此枚举值: CERTIFICATE_TYPE_2389:统一社会信用代码证书 当主体为社会组织,选择以下枚举值之一: CERTIFICATE_TYPE_2389:统一社会信用代码证书 CERTIFICATE_TYPE_2394:社会团体法人登记证书 CERTIFICATE_TYPE_2395:民办非企业单位登记证书 CERTIFICATE_TYPE_2396:基金会法人登记证书 CERTIFICATE_TYPE_2399:宗教活动场所登记证 CERTIFICATE_TYPE_2400:政府部门下发的其他有效证明文件 CERTIFICATE_TYPE_2520:执业许可证/执业证 CERTIFICATE_TYPE_2521:基层群众性自治组织特别法人统一社会信用代码证 CERTIFICATE_TYPE_2522:农村集体经济组织登记证 示例值:CERTIFICATE_TYPE_2388
String businessLicenseCopy
字段名:营业执照扫描件 变量名:business_license_copy 是否必填:是 类型:string(256) 描述: 1、主体为“个体工商户/企业”时,请上传营业执照的证件图片。 2、主体为“政府机关/事业单位/社会组织”时,请上传登记证书的证件图片。 3、可上传1张图片,请填写通过图片上传API预先上传图片生成好的MediaID 。 4、图片要求: (1)请上传证件的彩色扫描件或彩色数码拍摄件,黑白复印件需加盖公章(公章信息需完整) 。 (2)不得添加无关水印(非微信支付商户申请用途的其他水印)。 (3)需提供证件的正面拍摄件,完整、照面信息清晰可见。信息不清晰、扭曲、压缩变形、反光、不完整均不接受。 (4)不接受二次剪裁、翻拍、PS的证件照片。 示例值:47ZC6GC-vnrbEny__Ie_An5-tCpqxucuxi-vByf3Gjm7KE53JXvGy9tqZm2XAUf-4KGprrKhpVBDIUv0OF4wFNIO4kqg05InE4d2I6_H7I4
String businessLicenseNumber
字段名:营业执照注册号 变量名:business_license_number 是否必填:是 类型:string(18) 描述: 1、主体为“个体工商户/企业”时,请填写营业执照上的注册号/统一社会信用代码,须为18位数字|大写字母。 2、主体为“政府机关/事业单位/社会组织”时,请填写登记证书的证书编号。 示例值:123456789012345678
String merchantName
字段名:商户名称 变量名:merchant_name 是否必填:是 类型:string(128) 描述: 1、请填写营业执照/登记证书的商家名称,2~110个字符,支持括号 。 2、个体工商户/政府机关/事业单位/社会组织,不能以“公司”结尾。 3、个体工商户,若营业执照上商户名称为空或为“无”,请填写"个体户+经营者姓名",如“个体户张三” 。 示例值:腾讯科技有限公司
String legalPerson
字段名:经营者/法定代表人姓名 变量名:legal_person 是否必填:是 类型:string(128) 描述: 请填写证件的经营者/法定代表人姓名 示例值:张三
String companyAddress
字段名:注册地址 变量名:company_address 是否必填:条件选填 类型:string(128) 描述: 主体为“政府机关/事业单位/社会组织”时必填,请填写登记证书的注册地址。 示例值:深圳南山区科苑路
String businessTime
字段名:营业期限 变量名:business_time 是否必填:条件选填 类型:string(256) 描述: 1、主体为“政府机关/事业单位/社会组织”时必填,请填写证件有效期。 2、若证件有效期为长期,请填写:长期。 3、结束时间需大于开始时间。 示例值:["2014-01-01","长期"]
String contactType
字段名:超级管理员类型 变量名:contact_type 是否必填:是 类型:string(2) 描述: 1、主体为“小微/个人卖家 ”,可选择:65-经营者/法人。 2、主体为“个体工商户/企业/政府机关/事业单位/社会组织”,可选择:65-经营者/法人、66- 经办人。 (经办人:经商户授权办理微信支付业务的人员)。 示例值:65
String contactName
字段名:超级管理员姓名 变量名:contact_name 是否必填:是 类型:string(256) 描述: 1、若管理员类型为“法人”,则该姓名需与法人身份证姓名一致。 2、若管理员类型为“经办人”,则可填写实际负责人的姓名。 3、该字段需进行加密处理,加密方法详见敏感信息加密说明。(提醒:必须在HTTP头中上送Wechatpay-Serial) (后续该管理员需使用实名微信号完成签约) 示例值: pVd1HJ6zyvPedzGaV+X3IdGdbDnuC4Eelw/wDa4SzfeespQO/0kjiwfqdfg==
String contactIdDocType
字段名:超级管理员证件类型 变量名:contact_id_doc_type 是否必填:条件选填 类型:string 描述: 当超级管理员类型是经办人时,请上传超级管理员证件类型。 IDENTIFICATION_TYPE_MAINLAND_IDCARD:中国大陆居民-身份证 IDENTIFICATION_TYPE_OVERSEA_PASSPORT:其他国家或地区居民-护照 IDENTIFICATION_TYPE_HONGKONG:中国香港居民--来往内地通行证 IDENTIFICATION_TYPE_MACAO:中国澳门居民--来往内地通行证 IDENTIFICATION_TYPE_TAIWAN:中国台湾居民--来往大陆通行证 IDENTIFICATION_TYPE_FOREIGN_RESIDENT:外国人居留证 IDENTIFICATION_TYPE_HONGKONG_MACAO_RESIDENT:港澳居民证 IDENTIFICATION_TYPE_TAIWAN_RESIDENT:台湾居民证 示例值:IDENTIFICATION_TYPE_MAINLAND_IDCARD
String contactIdCardNumber
字段名:超级管理员身份证件号码 变量名:contact_id_card_number 是否必填:条件选填 类型:string(256) 描述: 1、若超级管理员类型为法人,则该身份证号码需与法人身份证号码一致。若超级管理员类型为经办人,则可填写实际经办人的身份证号码。 2、可传身份证、来往内地通行证、来往大陆通行证、护照等证件号码。 3、超级管理员签约时,校验微信号绑定的银行卡实名信息,是否与该证件号码一致。 4、该字段需进行加密处理,加密方法详见敏感信息加密说明。(提醒:必须在HTTP头中上送Wechatpay-Serial) 示例值:pVd1HJ6zyvPedzGaV+X3qtmrq9bb9tPROvwia4ibL+F6mfjbzQIzfb3HHDnuC4EL5Kz4jBHLiCyOb+tI0m2qhZ9evAM+Jv1z0NVa8MRtelw/wDa4SzfeespQO/0kjiwfqdfg==
String contactIdDocCopy
字段名:超级管理员证件正面照片 变量名:contact_id_doc_copy 是否必填:条件选填 类型:string(256) 描述: 1、当超级管理员类型是经办人时,请上传超级管理员证件的正面照片。 2、若证件类型为身份证,请上传人像面照片。 3、可上传1张图片,请填写通过图片上传API预先上传图片生成好的MediaID。 4、请上传彩色照片or彩色扫描件or复印件(需加盖公章鲜章),可添加“微信支付”相关水印(如微信支付认证)。 示例值:jTpGmxUX3FBWVQ5NJTZvvDujqhThn4ReFxikqJ5YW6zFQ
String contactIdDocCopyBack
字段名:超级管理员证件反面照片 变量名:contact_id_doc_copy_back 是否必填:条件选填 类型:string(256) 描述: 1、当超级管理员类型是经办人时,请上传超级管理员证件的反面照片。 2、若证件类型为护照,无需上传反面照片。 3、可上传1张图片,请填写通过图片上传API预先上传图片生成好的MediaID。 4、请上传彩色照片or彩色扫描件or复印件(需加盖公章鲜章),可添加“微信支付”相关水印(如微信支付认证)。 示例值:jTpGmxUX3FBWVQ5NJTZvvDujqhThn4ReFxikqJ5YW6zFQ
String contactIdDocPeriodBegin
字段名:超级管理员证件有效期开始时间 变量名:contact_id_doc_period_begin 是否必填:条件选填 类型:string(128) 描述: 1、当超级管理员类型是经办人时,请上传证件有效期开始时间。 2、请按照示例值填写。 3、结束时间大于开始时间。 示例值:2019-06-06
String contactIdDocPeriodEnd
字段名:超级管理员证件有效期结束时间 变量名:contact_id_doc_period_end 是否必填:条件选填 类型:string(128) 描述: 1、当超级管理员类型是经办人时,请上传证件有效期结束时间。 2、请按照示例值填写,若证件有效期为长期,请填写:长期。 3、结束时间大于开始时间。 示例值:2026-06-06
String businessAuthorizationLetter
字段名:业务办理授权函 变量名:business_authorization_letter 是否必填:条件选填 类型:string(256) 描述: 1、当超级管理员类型是经办人时,请上传业务办理授权函。 2、请参照示例图打印业务办理授权函,全部信息需打印,不支持手写商户信息,并加盖公章。 3、可上传1张图片,请填写通过图片上传API预先上传图片生成好的MediaID。 示例值:47ZC6GC-vnrbEny_Ie_An5-tCpqxucuxi-vByf3Gjm7KEIUv0OF4wFNIO4kqg05InE4d2I6_H7I4
String mobilePhone
字段名:超级管理员手机 变量名:mobile_phone 是否必填:是 类型:string(256) 描述: 1、请填写管理员的手机号,11位数字, 用于接收微信支付的重要管理信息及日常操作验证码 。 2、该字段需进行加密处理,加密方法详见敏感信息加密说明。(提醒:必须在HTTP头中上送Wechatpay-Serial) 示例值:pVd1HJ6zyvPedzGaV+X3qtmrq9bb9tPROvwia4ibL+F6mfjbzQIzfb3HHLEjZ4YiNWWNeespQO/0kjiwfqdfg==
String contactEmail
字段名:超级管理员邮箱 变量名:contact_email 是否必填:是 类型:string(256) 描述: 1、主体类型为“小微商户/个人卖家”可选填,其他主体需必填。 2、用于接收微信支付的开户邮件及日常业务通知。 3、需要带@,遵循邮箱格式校验 。 4、该字段需进行加密处理,加密方法详见敏感信息加密说明。(提醒:必须在HTTP头中上送Wechatpay-Serial) 示例值:pVd1HJ6zyvPedzGaV+X3qtmrq9bb9tPROvwia4ibL+FWWNUlw/wDa4SzfeespQO/0kjiwfqdfg==
String financeType
字段名:金融机构类型 变量名:finance_type 是否必填:是 类型:string 描述: 金融机构类型需与营业执照/登记证书上一致,可参考选择金融机构指引。 BANK_AGENT:银行业, 适用于商业银行、政策性银行、农村合作银行、村镇银行、开发性金融机构等 PAYMENT_AGENT:支付机构, 适用于非银行类支付机构 INSURANCE:保险业, 适用于保险、保险中介、保险代理、保险经纪等保险类业务 TRADE_AND_SETTLE:交易及结算类金融机构, 适用于交易所、登记结算类机构、银行卡清算机构、资金清算中心等 OTHER:其他金融机构, 适用于财务公司、信托公司、金融资产管理公司、金融租赁公司、汽车金融公司、贷款公司、货币经纪公司、消费金融公司、证券业、金融控股公司、股票、期货、货币兑换、小额贷款公司、金融资产管理、担保公司、商业保理公司、典当行、融资租赁公司、财经咨询等其他金融业务 示例值:BANK_AGENT
List<E> financeLicensePics
字段名:金融机构许可证图片 变量名:finance_license_pics 是否必填:是 类型:array 描述: 1、根据所属金融机构类型的许可证要求提供,详情查看金融机构指引。 2、请提供为“申请商家主体”所属的许可证,可授权使用总公司/分公司的特殊资质。 3、最多可上传5张照片,请填写通过图片上传API预先上传图片生成好的MediaID。 示例值:47ZC6GC-vnrbEny__Ie_An5-tCpqxucuxi-vByf3Gjm7KE53JXvGy9tqZm2XAUf-4KGprrKhpVBDIUv0OF4wFNIO4kqg05InE4d2I6_H7I4
String idCardCopy
字段名:身份证人像面照片 变量名:id_card_copy 是否必填:是 类型:string(256) 描述: 1、证件类型为“身份证”时,上传身份证人像面照片。 2、可上传1张图片,请填写通过图片上传API预先上传图片生成好的MediaID。 3、请上传彩色照片or彩色扫描件or复印件(需加盖公章鲜章),可添加“微信支付”相关水印(如微信支付认证)。 示例值:jTpGmxUX3FBWVQ5NJTZvlKX_gdU4cRz7z5NxpnFuAxhBTEO_PvWkfSCJ3zVIn001D8daLC-ehEuo0BJqRTvDujqhThn4ReFxikqJ5YW6zFQ
String idCardNational
字段名:身份证国徽面照片 变量名:id_card_national 是否必填:是 类型:string(256) 描述: 1、证件类型为“身份证”时,上传身份证国徽面照片。 2、可上传1张图片,请填写通过图片上传API预先上传图片生成好的MediaID 。 3、请上传彩色照片or彩色扫描件or复印件(需加盖公章鲜章),可添加“微信支付”相关水印(如微信支付认证)。 示例值:47ZC6GC-vnrbEny__Ie_An5-tCpqxuZm2XAUf-4KGprrKhpVBDIUv0OF4wFNIO4kqg05InE4d2I6_H7I4
String idCardName
字段名:身份证姓名 变量名:id_card_name 是否必填:是 类型:string(256) 描述: 1、请填写经营者/法定代表人对应身份证的姓名,2~30个中文字符、英文字符、符号。 2、该字段需进行加密处理,加密方法详见敏感信息加密说明。(提醒:必须在HTTP头中上送Wechatpay-Serial) 示例值:pVd1HJ6zyvPedzGaV+X3qtmrq9bb9tPROvwia4ibL+F6mfjbzQIzfb3HHLEjC4EL5Kz4jBHLiCyOb+tI0m2qhZ9evAM+Jv1z0NVa8MRtelw/wDa4SzfeespQO/0kjiwfqdfg==
String idCardNumber
字段名:身份证号码 变量名:id_card_number 是否必填:是 类型:string(256) 描述: 1、请填写经营者/法定代表人对应身份证的号码。 2、15位数字或17位数字+1位数字|X ,该字段需进行加密处理,加密方法详见敏感信息加密说明。(提醒:必须在HTTP头中上送Wechatpay-Serial) 示例值:AOZdYGISxo4y44/UgZ69bdu9X+tfMUJ9dl+LetjM45/zMbrYu+wWZ8gn4CT3JZKGZjduGdtkRJJp0/0eow96uY1Pk7Rq79Jtt7+I8juwEc4P4TG5xzchG/5IL9DBd+Z0zZXkw==
String idCardAddress
字段名:身份证居住地址 变量名:id_card_address 是否必填:条件选填 类型:string(512) 描述: 1、主体类型为企业时,需要填写。其他主体类型,无需上传。 2、请按照身份证住址填写,如广东省深圳市南山区xx路xx号xx室 3、该字段需进行加密处理,加密方法详见敏感信息加密说明。(提醒:必须在HTTP头中上送Wechatpay-Serial) 示例值:AOZdYGISxo4y44/UgZ69bdu9X+tfMUJ9dl+LetjM45/zMbrYu+wWZ8gn4CTdo+D/m9MrPg+V4p0/0eow96uY1Pk7Rq79Jtt7+I8juwEc4P4TG5xzchG/5IL9DBd+Z0zZXkw==
String idCardValidTimeBegin
字段名:身份证开始时间 变量名:id_card_valid_time_begin 是否必填:是 类型:string(128) 描述: 1、请按照示例值填写。 2、结束时间大于开始时间。 示例值:2019-06-06
String idCardValidTime
字段名:身份证结束时间 变量名:id_card_valid_time 是否必填:是 类型:string(128) 描述: 1、请按照示例值填写,若证件有效期为长期,请填写:长期。 2、结束时间大于开始时间。 示例值:2026-06-06
String idDocCopy
字段名:证件正面照片 变量名:id_doc_copy 是否必填:是 类型:string(256) 描述: 1、证件类型不为“身份证”时,上传证件正面照片。 2、可上传1张图片,请填写通过图片图片上传API预先上传图片生成好的MediaID。 3、请上传彩色照片or彩色扫描件or复印件(需加盖公章鲜章),可添加“微信支付”相关水印(如微信支付认证)。 示例值:jTpGmxUX3FBWVQ5NJTZvlKX_gdU4cRz7z5NxpnFuAxhBTEO_PvWkfSCJ3zVIn001D8daLC-ehEuo0BJqRTvDujqhThn4ReFxikqJ5YW6zFQ
String idDocCopyBack
字段名:证件反面照片 变量名:id_doc_copy_back 是否必填:条件选填 类型:string(256) 描述: 1、若证件类型为来往通行证、外国人居留证、港澳居住证、台湾居住证时,上传证件反面照片。 2、若证件类型为护照,无需上传反面照片。 3、可上传1张图片,请填写通过图片上传API预先上传图片生成好的MediaID 。 4、请上传彩色照片or彩色扫描件or复印件(需加盖公章鲜章),可添加“微信支付”相关水印(如微信支付认证)。 示例值:47ZC6GC-vnrbEny__Ie_An5-tCpqxucuxi-vByf3Gjm7KE53JXvGy9tqZm2XAUf-4KGprrKhpVBDIUv0OF4wFNIO4kqg05InE4d2I6_H7I4
String idDocName
字段名:证件姓名 变量名:id_doc_name 是否必填:是 类型:string(128) 描述: 1、请填写经营者/法人姓名。 2、该字段需进行加密处理,加密方法详见敏感信息加密说明。(提醒:必须在HTTP头中上送Wechatpay-Serial) 示例值:jTpGmxUX3FBWVQ5NJTZvlKX_gdU4cRz7z5NxpnFuAxhBTEO_PvWkfSCJ3zVIn001D8daLC-ehEuo0BJqRTvDujqhThn4ReFxikqJ5YW6zFQ
String idDocNumber
字段名:证件号码 变量名:id_doc_number 是否必填:是 类型:string(256) 描述: 7~11位 数字|字母|连字符 。 该字段需进行加密处理,加密方法详见敏感信息加密说明。(提醒:必须在HTTP头中上送Wechatpay-Serial) 示例值:jTpGmxUX3FBWVQ5NJTZvlKX_gdU4cRz7z5NxpnFuAxhBTEO_PvWkfSCJ3zVIn001D8daLC-ehEuo0BJqRTvDujqhThn4ReFxikqJ5YW6zFQ
String idDocAddress
字段名:证件居住地址 变量名:id_doc_address 是否必填:条件选填 类型:string(512) 描述: 1、主体类型为企业时,需要填写。其他主体类型,无需上传。 2、请按照证件上住址填写,若证件上无住址则按照实际住址填写,如广东省深圳市南山区xx路xx号xx室。 3、该字段需进行加密处理,加密方法详见敏感信息加密说明。(提醒:必须在HTTP头中上送Wechatpay-Serial) 示例值:jTpGmxUX3FBWVQ5NJTZvlKX_gdU4cRz7z5NxpnFuAxhBTEO_PvWkfSCJ3zVIn001D8daLC-ehEuo0BJqRTvDujqhThn4ReFxikqJ5YW6zFQ
String docPeriodBegin
字段名:证件有效期开始时间 变量名:doc_period_begin 是否必填:是 类型:string(128) 描述: 1、请按照示例值填写 2、结束时间大于开始时间 示例值:2019-06-06
String docPeriodEnd
字段名:证件有效期结束时间 变量名:doc_period_end 是否必填:是 类型:string(128) 描述: 1、请按照示例值填写,若证件有效期为长期,请填写:长期。 2、结束时间大于开始时间。 示例值:2020-01-02
String storeName
字段名:店铺名称 变量名:store_name 是否必填:是 类型:string(256) 描述: 请填写店铺全称。 示例值:爱烧烤
String storeUrl
字段名:店铺链接 变量名:store_url 是否必填:二选一 类型:string(1024) 描述: 1、店铺二维码or店铺链接二选一必填。 2、请填写店铺主页链接,需符合网站规范。 示例值:http://www.qq.com
String storeQrCode
字段名:店铺二维码 变量名:store_qr_code 是否必填:二选一 类型:string(256) 描述: 1、店铺二维码 or 店铺链接二选一必填。 2、若为电商小程序,可上传店铺页面的小程序二维码。 3、请填写通过图片上传API预先上传图片生成好的MediaID,仅能上传1张图片 。 示例值:jTpGmxUX3FBWVQ5NJTZvlKX_gdU4cRz7z5NxpnFuAxhBTEO_PvWkfSCJ3zVIn001D8daLC-ehEuo0BJqRTvDujqhThn4ReFxikqJ5YW6zFQ
String miniProgramSubAppid
字段名:小程序AppID 变量名:mini_program_sub_appid 是否必填:否 类型:string(256) 描述: 1、商户自定义字段,可填写已认证的小程序AppID,认证主体需与二级商户主体一致; 2、完成入驻后, 系统发起二级商户号与该AppID的绑定(即配置为sub_appid,可在发起支付时传入) 示例值:wxa123344545577
Integer settlementId
字段名:结算规则ID 变量名:settlement_id 是否必填:否 类型:int 描述: 1、选填,请选择二级商户的结算规则ID,需匹配电商平台开通工具箱选择的费率档位,详细参见电商二级商户结算规则对照表;https://kf.qq.com/faq/220228qEfuAz220228bMFji6.html 2、若电商平台未传入,将默认选择0.6%费率对应的结算规则id; 示例值:719
String qualificationType
字段名:所属行业 变量名:qualification_type 是否必填:二选一 类型:string[1, 200] 描述: 1、选填,请填写二级商户所属的行业名称,映射特殊资质要求,详细参见电商二级商户结算规则对照表; 2、若电商平台未传入,将默认填写无需特殊资质的行业名称; 示例值:零售批发/生活娱乐/其他
String uboIdDocType
字段名:证件类型 变量名:ubo_id_doc_type 是否必填:是 类型:string 描述: 请填写受益人的证件类型。 枚举值: IDENTIFICATION_TYPE_MAINLAND_IDCARD:中国大陆居民-身份证 IDENTIFICATION_TYPE_OVERSEA_PASSPORT:其他国家或地区居民-护照 IDENTIFICATION_TYPE_HONGKONG:中国香港居民--来往内地通行证 IDENTIFICATION_TYPE_MACAO:中国澳门居民--来往内地通行证 IDENTIFICATION_TYPE_TAIWAN:中国台湾居民--来往大陆通行证 IDENTIFICATION_TYPE_FOREIGN_RESIDENT:外国人居留证 IDENTIFICATION_TYPE_HONGKONG_MACAO_RESIDENT:港澳居民证 IDENTIFICATION_TYPE_TAIWAN_RESIDENT:台湾居民证 示例值:IDENTIFICATION_TYPE_MAINLAND_IDCARD
String uboIdDocCopy
字段名:证件正面照片 变量名:ubo_id_doc_copy 是否必填:是 类型:string(256) 描述: 1、请上传受益人证件的正面照片。 2、若证件类型为身份证,请上传人像面照片。 3、可上传1张图片,请填写通过图片上传API预先上传图片生成好的MediaID。 4、请上传彩色照片or彩色扫描件or复印件(需加盖公章鲜章),可添加“微信支付”相关水印(如微信支付认证)。 示例值:jTpGmxUXqRTvDujqhThn4ReFxikqJ5YW6zFQ
String uboIdDocCopyBack
字段名:证件反面照片 变量名:ubo_id_doc_copy_back 是否必填:条件选填 类型:string(256) 描述: 1、请上传受益人证件的反面照片。 2、若证件类型为护照,无需上传反面照片。 3、可上传1张图片,请填写通过图片上传API预先上传图片生成好的MediaID。 4、请上传彩色照片or彩色扫描件or复印件(需加盖公章鲜章),可添加“微信支付”相关水印(如微信支付认证)。 示例值:jTpGmxUX3FBWVQ5NJTZvvDujqhThn4ReFxikqJ5YW6zFQ
String uboIdDocName
字段名:证件姓名 变量名:ubo_id_doc_name 是否必填:是 类型:string(128) 描述: 该字段需进行加密处理,加密方法详见敏感信息加密说明。(提醒:必须在HTTP头中上送Wechatpay-Serial) 示例值:AOZdYGISxo4y44/Ug4P4TG5xzchG/5IL9DBd+Z0zZXkw==
String uboIdDocNumber
字段名:证件号码 变量名:ubo_id_doc_number 是否必填:是 类型:string(256) 描述: 该字段需进行加密处理,加密方法详见敏感信息加密说明。(提醒:必须在HTTP头中上送Wechatpay-Serial) 示例值:AOZdYGISxo4y44/Ug4P4TG5xzchG/5IL9DBd+Z0zZXkw==
String uboIdDocAddress
字段名:证件居住地址 变量名:ubo_id_doc_address 是否必填:条件选填 类型:string(512) 描述: 1、请按照证件上住址填写,若证件上无住址则按照实际住址填写,如广东省深圳市南山区xx路xx号xx室。 2、 该字段需进行加密处理,加密方法详见敏感信息加密说明。(提醒:必须在HTTP头中上送Wechatpay-Serial) 示例值:pVd1HJ6zyvPedzGaV+X3qtmrq9bb9tPROvwia4ibL+F6mfjbzQIzfDa4SzfeespQO/0kjiwfqdfg==
String uboIdDocPeriodBegin
字段名:证件有效期开始时间 变量名:ubo_id_doc_period_begin 是否必填:是 类型:string(128) 描述: 1、请按照示例值填写。 2、结束时间大于开始时间。 示例值:2019-06-06
String uboIdDocPeriodEnd
字段名:证件有效期结束时间 变量名:ubo_id_doc_period_end 是否必填:是 类型:string(128) 描述: 1、请按照示例值填写,若证件有效期为长期,请填写:长期。 2、结束时间大于开始时间。 示例值:2026-06-06
String applymentState
字段名:申请状态 变量名:applyment_state 是否必填:否 类型:string(32) 描述: 枚举值: CHECKING:资料校验中 ACCOUNT_NEED_VERIFY:待账户验证 AUDITING:审核中 REJECTED:已驳回 NEED_SIGN:待签约 FINISH:完成 FROZEN:已冻结 示例值:FINISH
String applymentStateDesc
字段名:申请状态描述 变量名:applyment_state_desc 是否必填:否 类型:string(32) 描述: 申请状态描述 示例值:“审核中”
String signUrl
字段名:签约链接 变量名:sign_url 是否必填:否 类型:string(256) 描述: 1、当申请状态为NEED_SIGN时才返回。 2、建议将链接转为二维码展示,需让申请单-管理者用微信扫码打开,完成签约。 示例值:https://pay.weixin.qq.com/public/apply4ec_sign/s?applymentId=2000002126198476&sign=b207b673049a32c858f3aabd7d27c7ec
String signState
字段名:签约状态 变量名:sign_state 是否必填:否 类型:string(16) 描述: 1、UNSIGNED:未签约。该状态下,电商平台可查询获取签约链接,引导二级商户的超级管理员完成签约; 2、SIGNED :已签约。指二级商户的超级管理员已完成签约。注意:若申请单被驳回,商户修改了商户主体名称、法人名称、超级管理员信息、主体类型等信息,则需重新签约。 3、NOT_SIGNABLE:不可签约。该状态下,暂不支持超级管理员签约。一般为申请单处于已驳回、已冻结、机器校验中状态,无法签约。 示例值:https://pay.weixin.qq.com/public/apply4ec_sign/s?applymentId=2000002126198476&sign=b207b673049a32c858f3aabd7d27c7ec
String subMchid
字段名:电商平台二级商户号 变量名:sub_mchid 是否必填:否 类型:string(32) 描述: 当申请状态为NEED_SIGN或FINISH时才返回。 示例值:1542488631
ApplymentsStatusResult.AccountValidation accountValidation
字段名:+汇款账户验证信息 变量名:account_validation 是否必填:否 类型:object 描述:当申请状态为ACCOUNT_NEED_VERIFY 时有返回,可根据指引汇款,完成账户验证。
List<E> auditDetail
字段名:+驳回原因详情 变量名:audit_detail 是否必填:否 类型:array 描述:各项资料的审核情况。当申请状态为REJECTED或 FROZEN时才返回。
String legalValidationUrl
字段名:法人验证链接 变量名:legal_validation_url 是否必填:否 类型:string(256) 描述: 1、当申请状态为 ACCOUNT_NEED_VERIFY,且通过系统校验的申请单,将返回链接。 2、建议将链接转为二维码展示,让商户法人用微信扫码打开,完成账户验证。 示例值: https://pay.weixin.qq.com/public/apply4ec_sign/s?applymentId=2000002126198476&sign=b207b673049a32c858f3aabd7d27c7ec
String outRequestNo
字段名:业务申请编号 变量名:out_request_no 是否必填:是 类型:string(124) 描述: 提交接口填写的业务申请编号。 示例值:APPLYMENT_00000000001
String applymentId
字段名:微信支付申请单号 变量名:applyment_id 是否必填:否 类型:uint64 描述: 微信支付分配的申请单号。 示例值:2000002124775691
String accountName
字段名:付款户名 变量名:account_name 是否必填:否 类型:uint64 描述: 需商户使用该户名的账户进行汇款。 示例值: rDdICA3ZYXshYqeOSslSjSMf+MhhC4oaujiISFzq3AE+as7mAEDJly+DgRuVs74msmKUH8pl+3oA==
String accountNo
字段名:付款卡号 变量名:account_no 是否必填:否 类型:string(128) 描述: 结算账户为对私时会返回,商户需使用该付款卡号进行汇款。 示例值:9nZYDEvBT4rDdICA3ZYXshYqeOSslSjSauAE+as7mAEDJly+DgRuVs74msmKUH8pl+3oA==
String payAmount
字段名:汇款金额 变量名:pay_amount 是否必填:否 类型:string(32) 描述: 需要汇款的金额(单位:分)。 示例值:124
String destinationAccountNumber
字段名:收款卡号 变量名:destination_account_number 是否必填:否 类型:string(128) 描述: 收款账户的卡号 示例值:7222223333322332
String destinationAccountName
字段名:收款户名 变量名:destination_account_name 是否必填:否 类型:string(128) 描述: 收款账户名 示例值:财付通支付科技有限公司
String destinationAccountBank
字段名:开户银行 变量名:destination_account_bank 是否必填:否 类型:string(128) 描述: 收款账户的开户银行名称。 示例值:招商银行威盛大厦支行
String city
字段名:省市信息 变量名:city 是否必填:否 类型:string(128) 描述: 收款账户的省市。 示例值:深圳
String remark
字段名:备注信息 变量名:remark 是否必填:否 类型:string(128) 描述: 商户汇款时,需要填写的备注信息。 示例值:入驻账户验证
String deadline
字段名:汇款截止时间 变量名:deadline 是否必填:否 类型:string(20) 描述: 请在此时间前完成汇款。 示例值:2018-12-1017:09:01
NotifyResponse rawData
CombineTransactionsResult result
String combineAppid
字段名:合单商户appid 变量名:combine_appid 是否必填:是 类型:string(32) 描述: 合单发起方的appid。 示例值:wxd678efh567hg6787
String combineMchid
字段名:合单商户号 变量名:combine_mchid 是否必填:是 类型:string(32) 描述: 合单发起方商户号。 示例值:1900000109
String combineOutTradeNo
字段名:合单商户订单号 变量名:combine_out_trade_no 是否必填:是 类型:string(32) 描述: 合单支付总订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一。 示例值:P20150806125346
CombineTransactionsRequest.SceneInfo sceneInfo
字段名:+场景信息 变量名:scene_info 是否必填:否 类型:object 描述:支付场景信息描述
List<E> subOrders
字段名:+子单信息 变量名:sub_orders 是否必填:是 类型:array 描述: 最多支持子单条数:50
CombineTransactionsRequest.CombinePayerInfo combinePayerInfo
字段名:+支付者 变量名:combine_payer_info 是否必填:否(JSAPI必填) 类型:object 描述:支付者信息
String timeStart
字段名:交易起始时间 变量名:time_start 是否必填:否 类型:string(14) 描述: 订单生成时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2019-12-31T15:59:60+08:00
String timeExpire
字段名:交易结束时间 变量名:time_expire 是否必填:否 类型:string(14) 描述: 订单失效时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2019-12-31T15:59:60+08:00
String notifyUrl
字段名:通知地址 变量名:notify_url 是否必填:是 类型:string(256) 描述: 接收微信支付异步通知回调地址,通知url必须为直接可访问的URL,不能携带参数。 格式: URL 示例值:https://yourapp.com/notify
String openid
字段名:用户标识 变量名:openid 是否必填:是 类型:string(128) 描述: 使用合单appid获取的对应用户openid。是用户在商户appid下的唯一标识。 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
String type
字段名:场景类型 变量名:type 是否必填:是 类型:string(32) 描述: 场景类型,枚举值: iOS:IOS移动应用; Android:安卓移动应用; Wap:WAP网站应用; 示例值:iOS
String appName
字段名:应用名称 变量名:app_name 是否必填:否 类型:string(64) 描述: 应用名称 示例值:王者荣耀
String appUrl
字段名:网站URL 变量名:app_url 是否必填:否 类型:string(128) 描述: 网站URL 示例值:https://pay.qq.com
String bundleId
字段名:iOS平台BundleID 变量名:bundle_id 是否必填:否 类型:string(128) 描述: iOS平台BundleID 示例值:com.tencent.wzryiOS
String packageName
字段名:Android平台PackageName 变量名:package_name 是否必填:否 类型:string(128) 描述: Android平台PackageName 示例值:com.tencent.tmgp.sgame
String deviceId
字段名:商户端设备号 变量名:device_id 是否必填:否 类型:string(16) 描述: 终端设备号(门店号或收银设备ID)。 特殊规则:长度最小7个字节 示例值:POS1:1
String payerClientIp
字段名:用户终端IP 变量名:payer_client_ip 是否必填:是 类型:string(45) 描述: 用户端实际ip 格式: ip(ipv4+ipv6) 示例值:14.17.22.32
CombineTransactionsRequest.H5Info h5Info
字段名:H5场景信息 变量名:h5_info 是否必填:否(H5支付必填) 类型:object 描述: H5场景信息
String mchid
字段名:子单商户号 变量名:mchid 是否必填:是 类型:string(32) 描述: 子单发起方商户号,必须与发起方appid有绑定关系。 示例值:1900000109 此处一般填写服务商商户号
String attach
字段名:附加信息 变量名:attach 是否必填:是 类型:string(128) 描述: 附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用。 示例值:深圳分店
CombineTransactionsRequest.Amount amount
字段名:+订单金额 变量名:amount 是否必填:是 类型:object 描述:
String outTradeNo
字段名:子单商户订单号 变量名:out_trade_no 是否必填:是 类型:string(32) 描述: 商户系统内部订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一。 特殊规则:最小字符长度为6 示例值:20150806125346
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string(32) 描述: 二级商户商户号,由微信支付生成并下发。 注意:仅适用于电商平台 服务商 示例值:1900000109
String description
字段名:商品描述 变量名:description 是否必填:是 类型:string(128) 描述: 商品简单描述。需传入应用市场上的APP名字-实际商品名称,例如:天天爱消除-游戏充值。 示例值:腾讯充值中心-QQ会员充值
CombineTransactionsRequest.SettleInfo settleInfo
字段名:+结算信息 变量名:settle_info 是否必填:否 类型:Object 描述:结算信息
String combineAppid
字段名:合单商户appid 变量名:combine_appid 是否必填:是 类型:string(32) 描述: 合单发起方的appid。(即电商平台appid) 示例值:wxd678efh567hg6787
String combineMchid
字段名:合单商户号 变量名:combine_mchid 是否必填:是 类型:string(32) 描述: 合单发起方商户号。(即电商平台mchid) 示例值:1900000109
String combineOutTradeNo
字段名:合单商户订单号 变量名:combine_out_trade_no 是否必填:是 类型:string(32) 描述: 合单支付总订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一。 示例值:P20150806125346
CombineTransactionsResult.SceneInfo sceneInfo
字段名:+场景信息 变量名:scene_info 是否必填:否 类型:object 描述:支付场景信息描述
List<E> subOrders
字段名:+子单信息 变量名:sub_orders 是否必填:是 类型:array 描述: 最多支持子单条数:50
CombineTransactionsResult.CombinePayerInfo combinePayerInfo
字段名:+支付者 变量名:combine_payer_info 是否必填:否 类型:object 描述:示例值:见请求示例
Integer totalAmount
字段名:标价金额 变量名:total_amount 是否必填:是 类型:int64 描述: 子单金额,单位为分。 示例值:100
String currency
字段名:标价币种 变量名:currency 是否必填:是 类型:string(8) 描述: 符合ISO 4217标准的三位字母代码,人民币:CNY。 示例值:CNY
Integer payerAmount
字段名:现金支付金额 变量名:payer_amount 是否必填:是 类型:int64 描述: 订单现金支付金额。 示例值:10
String payerCurrency
字段名:现金支付币种 变量名:payer_currency 是否必填:是 类型:string(8) 描述: 货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY。 示例值: CNY
String openid
字段名:用户标识 变量名:openid 是否必填:是 类型:string(128) 描述: 使用合单appid获取的对应用户openid。是用户在商户appid下的唯一标识。 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
String deviceId
字段名:商户端设备号 变量名:device_id 是否必填:否 类型:string(16) 描述: 终端设备号(门店号或收银设备ID)。 特殊规则:长度最小7个字节 示例值:POS1:1
String mchid
字段名:子单商户号 变量名:mchid 是否必填:是 类型:string(32) 描述: 子单发起方商户号,必须与发起方Appid有绑定关系。(即电商平台mchid) 示例值:1900000109
String tradeType
字段名:交易类型 变量名:trade_type 是否必填:是 类型:string (16) 描述: 枚举值: NATIVE:扫码支付 JSAPI:公众号支付 APP:APP支付 MWEB:H5支付 示例值: JSAPI
String tradeState
字段名:交易状态 变量名:trade_state 是否必填:是 类型:string (32) 描述: 枚举值: SUCCESS:支付成功 REFUND:转入退款 NOTPAY:未支付 CLOSED:已关闭 USERPAYING:用户支付中 PAYERROR:支付失败(其他原因,如银行返回失败) 示例值: SUCCESS
String bankType
字段名:付款银行 变量名:bank_type 是否必填:否 类型:string(16) 描述: 银行类型,采用字符串类型的银行标识。 示例值:CMC
String attach
字段名:附加信息 变量名:attach 是否必填:是 类型:string(128) 描述: 附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用。 示例值:深圳分店
String successTime
字段名:支付完成时间 变量名:success_time 是否必填:是 类型:string(16) 描述: 订单支付时间,遵循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年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35.120+08:00
String transactionId
字段名:微信订单号 变量名:transaction_id 是否必填:是 类型:string(32) 描述: 微信支付订单号。 示例值: 1009660380201506130728806387
String outTradeNo
字段名:子单商户订单号 变量名:out_trade_no 是否必填:是 类型:string(32) 描述: 商户系统内部订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一。 特殊规则:最小字符长度为6 示例值:20150806125346
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string(32) 描述: 二级商户商户号,由微信支付生成并下发。 注意:仅适用于电商平台 服务商 示例值:1900000109
CombineTransactionsResult.Amount amount
字段名:+订单金额 变量名:amount 是否必填:是 类型:object 描述:订单金额信息
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string(32) 描述: 分账出资的电商平台二级商户,填写微信支付分配的商户号。 示例值:1900000109
String transactionId
字段名:微信订单号 变量名:transaction_id 是否必填:是 类型:string(32) 描述: 微信支付订单号。 示例值:4208450740201411110007820472
String outOrderNo
字段名:商户分账单号 变量名:out_order_no 是否必填:是 类型:string(64) 描述: 商户系统内部的分账单号,在商户系统内部唯一(单次分账、多次分账、完结分账应使用不同的商户分账单号),同一分账单号多次请求等同一次。 示例值:P20150806125346
String description
字段名:分账描述 变量名:description 是否必填:是 类型:string(80) 描述: 分账的原因描述,分账账单中需要体现。 示例值:分给商户1900000109
String billDate
字段名:账单日期 变量名:bill_date 是否必填:是 类型:string(10) 描述: 格式YYYY-MM-DD 仅支持三个月内的账单下载申请。 示例值:2019-06-11
String accountType
字段名:资金账户类型 变量名:account_type 是否必填:是 类型:string(32) 描述: 枚举值: ALL:所有账户 示例值:ALL
String tarType
字段名:压缩类型 变量名:tar_type 是否必填:否 类型:string(32) 描述: 不填则以不压缩的方式返回数据流 枚举值: GZIP:返回格式为.gzip的压缩包账单 示例值:GZIP
String algorithm
字段名:加密算法 变量名:algorithm 是否必填:是 类型:string(32) 描述: 枚举值: AEAD_AES_256_GCM:AEAD_AES_256_GCM加密算法 示例值:AEAD_AES_256_GCM
int downloadBillCount
字段名:下载信息总数 变量名:download_bill_count 是否必填:是 类型:int 描述: 下载信息总数 示例值:1
FundBillResult.FundBill[] downloadBillList
字段名:下载信息明细 变量名:download_bill_list 是否必填:否 类型:array 描述: 下载信息明细
String billSequence
字段名:账单文件序号 变量名:bill_sequence 是否必填:是 类型:int 描述: 商户将多个文件按账单文件序号的顺序合并为完整的资金账单文件,起始值为1 示例值:1
String hashType
字段名:哈希类型 变量名:hash_type 是否必填:是 类型:string(32) 描述: 枚举值: SHA1:SHA1值 示例值:SHA1
String hashValue
字段名:哈希值 变量名:hash_value 是否必填:是 类型:string(1024) 描述: 原始账单(gzip需要解压缩)的摘要值,用于校验文件的完整性。 示例值:79bb0f45fc4c42234a918000b2668d689e2bde04
String downloadUrl
字段名:账单下载地址 变量名:download_url 是否必填:是 类型:string(2048) 描述: 供下一步请求账单文件的下载地址,该地址30s内有效。 示例值:https://api.mch.weixin.qq.com/v3/billdownload/file?token=xxx
String encryptKey
字段名:加密密钥 变量名:encrypt_key 是否必填:是 类型:string(512) 描述: 加密账单文件使用的加密密钥。密钥用商户证书的公钥进行加密,然后进行Base64编码 示例值:YpkbxSne+mDwyXq//xYPmtr9eQ5LsH7zLMZSs+GSEcY4wjhlsfioS4n9X6q1ZBL0wM1v5qd7KhWuj0rFJ4N1FidP7Q8KDy25QDTt46wiKnsPKSCAXWRFNw1D2JmJBqZsc9y5g0DupONWKYB2GfRigRDEBVszj67uOIILPdxOKX1w3N4jvu0U9IFanJa7ldm70KVvYrMWVgQFDPbgjh1gVDbuTAjmPN88AobLdkiegnBUS2woDZW+PfhPo13kweOiR3h1gXIKRlnKnN3Jkkwpna/AFFijXrFphO3voSuiV0CfptfzTtcae4X3DYG3RSroKqmpa+5tuy2aU2VJUSIuFQ==
String nonce
字段名:随机字符串 变量名:nonce 是否必填:是 类型:string(16) 描述: 加密账单文件使用的随机字符串 示例值:a8607ef79034c49c
NotifyResponse rawData
PartnerTransactionsResult result
String spMchid
字段名:服务商户号 变量名:sp_mchid 是否必填:是 类型:string(32) 描述: 服务商户号,由微信支付生成并下发 示例值:1230000109
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string(32) 描述: 二级商户的商户号,有微信支付生成并下发。 示例值:1900000109
String transactionId
字段名:微信支付订单号 变量名:transaction_id 是否必填:是 类型:string(32) 描述: 微信支付系统生成的订单号 示例值:1217752501201407033233368018
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string(32) 描述: 商户系统内部订单号,只能是数字、大小写字母_-*且在同一个商户号下唯一,详见【商户订单号】。 特殊规则:最小字符长度为6 示例值:1217752501201407033233368018
String spAppid
字段名:服务商公众号ID 变量名:sp_appid 是否必填:是 类型:string(32) 描述: 服务商申请的公众号或移动应用appid 示例值:wx8888888888888888
String spMchid
字段名:服务商户号 变量名:sp_mchid 是否必填:是 类型:string(32) 描述: 服务商户号,由微信支付生成并下发 示例值:1230000109
String subAppid
字段名:子商户公众号ID 变量名:sub_appid 是否必填:否 类型:string(32) 描述: 子商户申请的公众号或移动应用appid。 示例值:wxd678efh567hg6999
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string(32) 描述: 二级商户的商户号,有微信支付生成并下发。 示例值:1900000109
String description
字段名:商品描述 变量名:description 是否必填:是 类型:string(127) 描述: 商品描述 示例值:Image形象店-深圳腾大-QQ公仔
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string(127) 描述: 商户系统内部订单号, 只能是数字、大小写字母_-*且在同一个商户号下唯一,详见【商户订单号】 特殊规则:最小字符长度为6 示例值:1217752501201407033233368018
String timeExpire
字段名:交易结束时间 变量名:time_expire 是否必填:否 类型:string(14) 描述: 订单失效时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2019-12-31T15:59:60+08:00
String attach
字段名:附加数据 变量名:attach 是否必填:否 类型:string(128) 描述: 附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用。 示例值:自定义数据
String notifyUrl
字段名:通知地址 变量名:notify_url 是否必填:是 类型:string(127) 描述: 通知URL必须为直接可访问的URL,不允许携带查询串。 示例值:https://www.weixin.qq.com/wxpay/pay.php
String goodsTag
字段名:订单优惠标记 变量名:goods_tag 是否必填:否 类型:string(32) 描述: 订单优惠标记 示例值:WXG
Boolean supportFapiao
字段名:电子发票入口开放标识 变量名:support_fapiao 是否必填:否 类型:boolean 描述:传入true时,支付成功消息和支付详情页将出现开票入口。需要在微信支付商户平台或微信公众平台开通电子发票功能,传此字段才可生效。
PartnerTransactionsRequest.SettleInfo settleInfo
字段名:+结算信息 变量名:settle_info 是否必填:否 类型:Object 描述:结算信息
PartnerTransactionsRequest.Amount amount
字段名:订单金额 变量名:amount 是否必填:是 类型:object 描述: 订单金额信息
PartnerTransactionsRequest.Discount detail
字段名:优惠功能 变量名:detail 是否必填:否 类型:object 描述: 优惠功能
PartnerTransactionsRequest.Payer payer
字段名:支付者 变量名:payer 是否必填:是(仅JSAPI支付必传) 类型:object 描述: 支付者信息
PartnerTransactionsRequest.SceneInfo sceneInfo
字段名:场景信息 变量名:scene_info 是否必填:是(仅H5支付必传) 类型:object 描述: 支付场景描述
Integer costPrice
字段名:订单原价 变量名:cost_price 是否必填:否 类型:int64 描述: 1、商户侧一张小票订单可能被分多次支付,订单原价用于记录整张小票的交易金额。 2、当订单原价与支付金额不相等,则不享受优惠。 3、该字段主要用于防止同一张小票分多次支付,以享受多次优惠的情况,正常支付订单不必上传此参数。 示例值:608800
String invoiceId
字段名:商品小票ID 变量名:invoice_id 是否必填:否 类型:string(32) 描述: 商品小票ID 示例值:微信123
List<E> goodsDetails
字段名:单品列表 变量名:goods_detail 是否必填:否 类型:array 描述: 单品列表信息 条目个数限制:【1,undefined】
String merchantGoodsId
字段名:商户侧商品编码 变量名:merchant_goods_id 是否必填:是 类型:string(32) 描述: 由半角的大小写字母、数字、中划线、下划线中的一种或几种组成。 示例值:商品编码
String wechatpayGoodsId
字段名:微信侧商品编码 变量名:wechatpay_goods_id 是否必填:否 类型:string(32) 描述: 微信支付定义的统一商品编号(没有可不传) 示例值:1001
String goodsName
字段名:商品名称 变量名:goods_name 是否必填:否 类型:string(256) 描述: 商品的实际名称 示例值:iPhoneX 256G
Integer quantity
字段名:商品数量 变量名:quantity 是否必填:是 类型:int64 描述: 用户购买的数量 示例值:1
Integer unitPrice
字段名:商品单价 变量名:unit_price 是否必填:是 类型:int64 描述: 商品单价,单位为分 示例值:828800
String type
字段名:场景类型 变量名:type 是否必填:是 类型:string(32) 描述: 场景类型,枚举值: iOS:IOS移动应用; Android:安卓移动应用; Wap:WAP网站应用; 示例值:iOS
String appName
字段名:应用名称 变量名:app_name 是否必填:否 类型:string(64) 描述: 应用名称 示例值:王者荣耀
String appUrl
字段名:网站URL 变量名:app_url 是否必填:否 类型:string(128) 描述: 网站URL 示例值:https://pay.qq.com
String bundleId
字段名:iOS平台BundleID 变量名:bundle_id 是否必填:否 类型:string(128) 描述: iOS平台BundleID 示例值:com.tencent.wzryiOS
String packageName
字段名:Android平台PackageName 变量名:package_name 是否必填:否 类型:string(128) 描述: Android平台PackageName 示例值:com.tencent.tmgp.sgame
String deviceId
字段名:商户端设备号 变量名:device_id 是否必填:否 类型:string(16) 描述: 终端设备号(门店号或收银设备ID)。 特殊规则:长度最小7个字节 示例值:POS1:1
String payerClientIp
字段名:用户终端IP 变量名:payer_client_ip 是否必填:是 类型:string(45) 描述: 用户端实际ip 格式: ip(ipv4+ipv6) 示例值:14.17.22.32
PartnerTransactionsRequest.H5Info h5Info
字段名:H5场景信息 变量名:h5_info 是否必填:否(H5支付必填) 类型:object 描述: H5场景信息
PartnerTransactionsRequest.StoreInfo storeInfo
字段名:商户门店信息 变量名:store_info 是否必填:否(H5支付必填) 类型:object 描述: 商户门店信息
Boolean profitSharing
字段名:是否指定分账 变量名:profit_sharing 是否必填:否 类型:bool 描述: 是否分账,与外层profit_sharing同时存在时,以本字段为准。 true:是 false:否 示例值:true
BigDecimal subsidyAmount
字段名:补差金额 变量名:subsidy_amount 是否必填:否 类型:int64 描述: SettleInfo.profit_sharing为true时,该金额才生效。 注意:单笔订单最高补差金额为5000元 示例值:10
String id
字段名:门店编号 变量名:id 是否必填:否 类型:string(32) 描述: 商户侧门店编号 示例值:0001
String name
字段名:门店名称 变量名:name 是否必填:是 类型:string(256) 描述: 商户侧门店名称 示例值:腾讯大厦分店
String areaCode
字段名:地区编码 变量名:area_code 是否必填:是 类型:string(32) 描述: 地区编码,详细请见省市区编号对照表(https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/ecommerce/applyments/chapter4_1.shtml)。 示例值:440305
String address
字段名:详细地址 变量名:address 是否必填:是 类型:string(512) 描述: 详细的商户门店地址 示例值:广东省深圳市南山区科技中一道10000号
String spAppid
字段名:服务商公众号ID 变量名:sp_appid 是否必填:是 类型:string(32) 描述: 服务商申请的公众号或移动应用appid。 示例值:wx8888888888888888
String spMchid
字段名:服务商户号 变量名:sp_mchid 是否必填:是 类型:string(32) 描述: 服务商户号,由微信支付生成并下发 示例值:1230000109
String subAppid
字段名:二级商户公众号ID 变量名:sub_appid 是否必填:否 类型:string(32) 描述: 二级商户申请的公众号或移动应用appid。 示例值:wxd678efh567hg6999
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string(32) 描述: 二级商户的商户号,有微信支付生成并下发。 示例值:1900000109
String outTradeNo
字段名:+商户订单号 变量名:out_trade_no 是否必填:是 类型:string(32) 描述:商户系统内部订单号,只能是数字、大小写字母_-*且在同一个商户号下唯一,详见【商户订单号】。 特殊规则:最小字符长度为6 示例值:1217752501201407033233368018
String transactionId
字段名:微信支付订单号 变量名:transaction_id 是否必填:否 类型:string(32) 描述:微信支付系统生成的订单号。 示例值:1217752501201407033233368018
String tradeType
字段名:交易类型 变量名:trade_type 是否必填:否 类型:string(16) 描述:交易类型,枚举值: JSAPI:公众号支付 NATIVE:扫码支付 APP:APP支付 MICROPAY:付款码支付 MWEB:H5支付 FACEPAY:刷脸支付 示例值: MICROPAY
String tradeState
字段名:交易状态 变量名:trade_state 是否必填:是 类型:string(32) 描述:交易状态,枚举值: SUCCESS:支付成功 REFUND:转入退款 NOTPAY:未支付 CLOSED:已关闭 REVOKED:已撤销(付款码支付) USERPAYING:用户支付中(付款码支付) PAYERROR:支付失败(其他原因,如银行返回失败) 示例值:SUCCESS
String tradeStateDesc
字段名:交易状态描述 变量名:trade_state_desc 是否必填:是 类型:string(256) 描述:交易状态描述 示例值:支付失败,请重新下单支付
String bankType
字段名:付款银行 变量名:bank_type 是否必填:否 类型:string(16) 描述:银行类型,采用字符串类型的银行标识。 示例值:CMC
String attach
字段名:附加数据 变量名:attach 是否必填:否 类型:string(128) 描述:附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用 示例值:自定义数据
String successTime
字段名:支付完成时间 变量名:success_time 是否必填:否 类型:string(64) 描述:支付完成时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2018-06-08T10:34:56+08:00
PartnerTransactionsResult.CombinePayerInfo payer
字段名:支付者信息 变量名:payer 是否必填:是 类型:object 描述:基础支付支付者信息
PartnerTransactionsResult.CombinePayerInfo combinePayerInfo
字段名:支付者 变量名:combine_payer_info 是否必填:否 类型:object 描述:合单支付支付者信息,示例值:见请求示例
PartnerTransactionsResult.Amount amount
字段名:订单金额 变量名:amount 是否必填:是 类型:object 描述:订单金额信息
PartnerTransactionsResult.SceneInfo sceneInfo
字段名:场景信息 变量名:scene_info 是否必填:否 类型:object 描述:支付场景信息描述
List<E> promotionDetails
字段名:优惠功能 变量名:promotion_detail 是否必填:否 类型:array 描述:优惠功能,享受优惠时返回该字段。
Integer total
字段名:总金额 变量名:total 是否必填:否 类型:int 描述: 订单总金额,单位为分 示例值:100
Integer payerTotal
字段名:用户支付金额 变量名:payer_total 是否必填:否 类型:int 描述: 用户支付金额,单位为分。 示例值:100
String currency
字段名:货币类型 变量名:currency 是否必填:否 类型:string(16) 描述: CNY:人民币,境内商户号仅支持人民币。 示例值:CNY
String payerCurrency
字段名:用户支付币种 变量名:payer_currency 是否必填:否 类型:string(8) 描述: 用户支付币种 示例值: CNY
String goodsId
字段名:商品编码 变量名:goods_id 是否必填:是 类型:string(32) 描述:商品编码 示例值:M1006
Integer quantity
字段名:商品数量 变量名:quantity 是否必填:是 类型:int64 描述: 用户购买的数量 示例值:1
Integer unitPrice
字段名:商品单价 变量名:unit_price 是否必填:是 类型:int64 描述: 商品单价,单位为分 示例值:100
Integer discountAmount
字段名:商品优惠金额 变量名:discount_amount 是否必填:是 类型:int 描述:商品优惠金额 示例值:0
String goodsRemark
字段名:商品备注 变量名:goods_remark 是否必填:否 类型:string(128) 描述:商品备注信息 示例值:商品备注信息
String couponId
字段名:券ID 变量名:coupon_id 是否必填:是 类型:string(32) 描述: 券ID 示例值:109519
String name
字段名:优惠名称 变量名:name 是否必填:否 类型:string(64) 描述: 优惠名称 示例值:单品惠-6
String scope
字段名:优惠范围 变量名:scope 是否必填:否 类型:string(32) 描述: 优惠名称 示例值: GLOBAL:全场代金券 SINGLE:单品优惠 示例值:GLOBAL
String type
字段名:优惠类型 变量名:type 是否必填:否 类型:string(32) 描述: CASH:充值 NOCASH:预充值 示例值:CASH
Integer amount
字段名:优惠券面额 变量名:amount 是否必填:是 类型:int 描述: 优惠券面额 示例值:100
String stockId
字段名:活动ID 变量名:stock_id 是否必填:否 类型:string(32) 描述:活动ID 示例值:931386
Integer wechatpayContribute
字段名:微信出资 变量名:wechatpay_contribute 是否必填:否 类型:int 描述:微信出资,单位为分 示例值:0
Integer merchantContribute
字段名:商户出资 变量名:merchant_contribute 是否必填:否 类型:int 描述:商户出资,单位为分 示例值:0
Integer otherContribute
字段名:其他出资 变量名:other_contribute 是否必填:否 类型:int 描述:其他出资,单位为分 示例值:0
String currency
字段名:优惠币种 变量名:currency 是否必填:否 类型:String(16) 描述: CNY:人民币,境内商户号仅支持人民币。 示例值:CNY
List<E> goodsDetails
字段名:单品列表 变量名:goods_detail 是否必填:否 类型:array 描述:单品列表信息
String deviceId
字段名:商户端设备号 变量名:device_id 是否必填:否 类型:string(16) 描述: 终端设备号(门店号或收银设备ID)。 特殊规则:长度最小7个字节 示例值:POS1:1
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string(32) 描述: 分账出资的电商平台二级商户,填写微信支付分配的商户号。 示例值:1900000109
String transactionId
字段名:微信订单号 变量名:transaction_id 是否必填:是 类型:string(32) 描述: 微信支付订单号。 示例值: 4208450740201411110007820472
String outOrderNo
字段名:商户分账单号 变量名:out_order_no 是否必填:是 类型:string(64) 描述: 商户系统内部的分账单号,在商户系统内部唯一(单次分账、多次分账、完结分账应使用不同的商户分账单号),同一分账单号多次请求等同一次。 示例值:P20150806125346
String appid
字段名:公众账号ID 变量名:appid 是否必填:是 类型:string(32) 描述: 电商平台的appid(公众号APPID或者小程序APPID) 示例值:wx8888888888888888
String type
字段名:接收方类型 变量名:type 是否必填:是 类型:string(32) 描述: 分账接收方的类型,枚举值: MERCHANT_ID:商户 PERSONAL_OPENID:个人 示例值:MERCHANT_ID
String account
字段名:接收方账号 变量名:account 是否必填:是 类型:string(64) 描述: 分账接收方的账号 类型是MERCHANT_ID时,是商户号 类型是PERSONAL_OPENID时,是个人openid,openid获取方法 示例值:190001001
String name
字段名:接收方名称 变量名:name 是否必填:是 类型:string(256) 描述: 分账接收方的名称,当type为MERCHANT_ID时,接收方名称是商户全称。 示例值:张三网络公司
String encryptedName
字段名:接收方名称的密文 变量名:encrypted_name 是否必填:否 类型:string(10240) 描述: 1、分账接收方类型是PERSONAL_OPENID时,是个人姓名的密文(选传,传则校验) 此字段的加密的方式为: 2、使用微信支付平台证书中的公钥 3、使用RSAES-OAEP算法进行加密 4、将请求中HTTP头部的Wechatpay-Serial设置为证书序列号 字段加密: 使用APIv3定义的方式加密 示例值:hu89ohu89ohu89o
String relationType
字段名:与分账方的关系类型 变量名:relation_type 是否必填:是 类型:string(32) 描述: 子商户与接收方的关系。 枚举值: SUPPLIER:供应商 DISTRIBUTOR:分销商 SERVICE_PROVIDER:服务商 PLATFORM:平台 OTHERS:其他 示例值:SUPPLIER
String appid
字段名:公众账号ID 变量名:appid 是否必填:是 类型:string(32) 描述: 微信分配的公众账号ID。 示例值:wx8888888888888888
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string(32) 描述: 分账出资的电商平台二级商户,填写微信支付分配的商户号。 示例值:1900000109
String transactionId
字段名:微信订单号 变量名:transaction_id 是否必填:是 类型:string(32) 描述: 微信支付订单号。 示例值:4208450740201411110007820472
String outOrderNo
字段名:商户分账单号 变量名:out_order_no 是否必填:是 类型:string(64) 描述: 商户系统内部的分账单号,在商户系统内部唯一(单次分账、多次分账、完结分账应使用不同的商户分账单号),同一分账单号多次请求等同一次。 示例值:P20150806125346
List<E> receivers
字段名:分账接收方列表 变量名:receivers 是否必填:是 类型:array 描述: 分账接收方列表,支持设置出资商户作为分账接收方,单次分账最多可有5个分账接收方
Boolean finish
字段名:是否分账完成 变量名:finish 是否必填:是 类型:bool 描述: 是否完成分账 1、如果为true,该笔订单剩余未分账的金额会解冻回电商平台二级商户; 2、如果为false,该笔订单剩余未分账的金额不会解冻回电商平台二级商户,可以对该笔订单再次进行分账。 示例值:true
String type
字段名:分账接收方类型 变量名:type 是否必填:否 类型:string(32) 描述: 分账接收方类型,枚举值: MERCHANT_ID:商户 PERSONAL_OPENID:个人 示例值:MERCHANT_ID
String receiverAccount
字段名:分账接收方账号 变量名:receiver_account 是否必填:是 类型:string(32) 描述: 分账接收方账号: 类型是MERCHANT_ID时,是商户ID 类型是PERSONAL_OPENID时,是个人openid,openid获取方法 https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/ecommerce/guide/chapter2_1.shtml#menu1 示例值:1900000109
Integer amount
字段名:分账金额 变量名:amount 是否必填:是 类型:int 描述: 分账金额,单位为分,只能为整数,不能超过原订单支付金额及最大分账比例金额。 示例值:190
String description
字段名:分账描述 变量名:description 是否必填:是 类型:string(180) 描述: 分账的原因描述,分账账单中需要体现。 示例值:分给商户1900000109
String receiverName
字段名:分账个人姓名 变量名:receiver_name 是否必填:否 类型:string(10240) 描述: 可选项,在接收方类型为个人的时可选填,若有值,会检查与 receiver_name 是否实名匹配,不匹配会拒绝分账请求 1、分账接收方类型是PERSONAL_OPENID时,是个人姓名的密文(选传,传则校验) 此字段的加密方法详见:敏感信息加密说明 2、使用微信支付平台证书中的公钥 3、使用RSAES-OAEP算法进行加密 4、将请求中HTTP头部的Wechatpay-Serial设置为证书序列号 示例值:hu89ohu89ohu89o
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string(32) 描述: 分账出资的电商平台二级商户,填写微信支付分配的商户号。 示例值:1900000109
String transactionId
字段名:微信订单号 变量名:transaction_id 是否必填:是 类型:string(32) 描述: 微信支付订单号。 示例值:4208450740201411110007820472
String outOrderNo
字段名:商户分账单号 变量名:out_order_no 是否必填:是 类型:string(64) 描述: 商户系统内部的分账单号,在商户系统内部唯一(单次分账、多次分账、完结分账应使用不同的商户分账单号),同一分账单号多次请求等同一次。 示例值:P20150806125346
String orderId
字段名:微信分账单号 变量名:order_id 是否必填:是 类型:string (64) 描述: 微信分账单号,微信系统返回的唯一标识。 示例值:6754760740201411110007865434
String status
字段名:分账单状态 变量名:status 是否必填:是 类型:string (64) 描述: 分账单状态,枚举值: ACCEPTED:受理成功 PROCESSING:处理中 FINISHED:分账成功 CLOSED:处理失败,已关单 示例值:FINISHED
List<E> receivers
字段名:分账接收方列表 变量名:receivers 是否必填:否 类型:array 描述: 分账接收方列表。当查询分账完结的执行结果时,不返回该字段
String closeReason
字段名:关单原因 变量名:close_reason 是否必填:否 类型:string (32) 描述: 关单原因描述,当分账单状态status为CLOSED(处理失败,已关单)时,返回该字段。 枚举值: NO_AUTH:分账授权已解除 示例值:NO_AUTH
Integer finishAmount
字段名:分账完结金额 变量名:finish_amount 是否必填:否 类型:int 描述: 分账完结的分账金额,单位为分, 仅当查询分账完结的执行结果时,存在本字段。 示例值:100
String finishDescription
字段名:分账完结描述 变量名:finish_description 是否必填:否 类型:string (80) 描述: 分账完结的原因描述,仅当查询分账完结的执行结果时,存在本字段。 示例值:分账完结
String receiverMchid
字段名:分账接收商户号 变量名:receiver_mchid 是否必填:是 类型:string (32) 描述: 填写微信支付分配的商户号,仅支持通过添加分账接收方接口添加的接收方;电商平台商户已默认添加到分账接收方,无需重复添加。 示例值:1900000109
Integer amount
字段名:分账金额 变量名:amount 是否必填:否 类型:int 描述: 分账金额,单位为分,只能为整数,不能超过原订单支付金额及最大分账比例金额。 示例值: 4208450740201411110007820472
String description
字段名:分账描述 变量名:description 是否必填:是 类型:string (80) 描述: 分账的原因描述,分账账单中需要体现。 示例值:分帐1900000110
String result
字段名:分账结果 变量名:result 是否必填:是 类型:string (32) 描述: 分账结果,枚举值: PENDING:待分账 SUCCESS:分账成功 ADJUST:分账失败待调账 RETURNED:已转回分账方 CLOSED:已关闭 示例值:SUCCESS
String finishTime
字段名:完成时间 变量名:finish_time 是否必填:是 类型:string (64) 描述: 分账完成时间,遵循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年5月20日 13点29分35秒。 示例值: 2015-05-20T13:29:35.120+08:00
String failReason
字段名:分账失败原因 变量名:fail_reason 是否必填:否 类型:string (32) 描述: 分账失败原因,当分账结果result为RETURNED(已转回分账方)或CLOSED(已关闭)时,返回该字段 枚举值: ACCOUNT_ABNORMAL:分账接收账户异常 NO_RELATION:分账关系已解除 RECEIVER_HIGH_RISK:高风险接收方 示例值:NO_RELATION
String type
字段名:分账接收方类型 变量名:type 是否必填:是 类型:string (32) 描述: 分账接收方类型,枚举值: MERCHANT_ID:商户 PERSONAL_OPENID:个人 示例值:MERCHANT_ID
String receiverAccount
字段名:分账接收方类型 变量名:receiver_account 是否必填:是 类型:string (64) 描述: 分账接收方账号: 类型是MERCHANT_ID时,是商户ID 类型是PERSONAL_OPENID时,是个人openid 示例值:1900000109
String detailId
字段名:分账明细单号 变量名:detail_id 类型:string[1,64] 是否必填:是 (查询明细结果时是必有的) 描述:微信分账明细单号,每笔分账业务执行的明细单号,可与资金账单对账使用 示例值:3601111111111111111111
NotifyResponse rawData
String spMchid
字段名:电商平台商户号 变量名:sp_mchid 是否必填:是 类型:string(32) 描述: 微信支付分配给电商平台的商户号 示例值:1900000100
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string(32) 描述: 分账出资的电商平台二级商户,填写微信支付分配的商户号。 示例值:1900000109
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string(32) 描述: 返回的商户订单号 示例值: 1217752501201407033233368018
String transactionId
字段名:微信订单号 变量名:transaction_id 是否必填:是 类型:string(32) 描述: 微信支付订单号 示例值: 1217752501201407033233368018
String outRefundNo
字段名:商户退款单号 变量名:out_refund_no 是否必填:是 类型:string(32) 描述: 商户退款单号 示例值: 1217752501201407033233368018
String refundId
字段名:微信退款单号 变量名:refund_id 是否必填:是 类型:string(32) 描述: 微信退款单号 示例值: 1217752501201407033233368018
String refundStatus
字段名:退款状态 变量名:refund_status 是否必填:是 类型:string(16) 描述: 退款状态,枚举值: SUCCESS:退款成功 CLOSE:退款关闭 ABNORMAL:退款异常,退款到银行发现用户的卡作废或者冻结了,导致原路退款银行卡失败,可前往【服务商平台—>交易中心】,手动处理此笔退款 示例值:SUCCESS
String successTime
字段名:退款成功时间 变量名:success_time 是否必填:否 类型:string(64) 描述: 1、退款成功时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中, 表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。 例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。 2、当退款状态为退款成功时返回此参数。 示例值:2018-06-08T10:34:56+08:00
String userReceivedAccount
字段名:退款入账账户 变量名:user_received_account 是否必填:是 类型:string(64) 描述: 取当前退款单的退款入账方。 退回银行卡:{银行名称}{卡类型}{卡尾号} 退回支付用户零钱: 支付用户零钱 退还商户: 商户基本账户、商户结算银行账户 退回支付用户零钱通:支付用户零钱通 示例值:招商银行信用卡0403
RefundNotifyResult.Amount amount
字段名:金额信息 变量名:amount 是否必填:是 类型:object 描述: 金额信息
String refundAccount
字段名:退款出资商户 变量名:refund_account 是否必填:否 类型:string(32) 描述: 电商平台垫资退款专用参数。需先确认已开通此功能后,才能使用。若需要开通,请联系微信支付客服。 枚举值: REFUND_SOURCE_PARTNER_ADVANCE : 电商平台垫付,需要向微信支付申请开通 REFUND_SOURCE_SUB_MERCHANT : 二级商户,默认值 注意: 若传入REFUND_SOURCE_PARTNER_ADVANCE,仅代表可以使用垫付退款,实际出款账户需以退款申请受理结果或查单结果为准。 示例值:REFUND_SOURCE_SUB_MERCHANT
Integer total
字段名:订单金额 变量名:total 是否必填:是 类型:int 描述: 订单总金额,单位为分,只能为整数,详见支付金额 示例值:999
Integer refund
字段名:退款金额 变量名:refund 是否必填:是 类型:int 描述: 退款金额,币种的最小单位,只能为整数,不能超过原订单支付金额,如果有使用券,后台会按比例退。 示例值:999
Integer payerTotal
字段名:用户支付金额 变量名:payer_total 是否必填:是 类型:int 描述: 用户支付金额,单位为分。 示例值:100
Integer payerRefund
字段名:用户退款金额 变量名:payer_refund 是否必填:是 类型:int 描述: 退款给用户的金额,不包含所有优惠券金额 示例值:999
String refundId
字段名:微信退款单号 变量名:refund_id 是否必填:是 类型:string(32) 描述: 微信退款单号 示例值: 1217752501201407033233368018
String outRefundNo
字段名:商户退款单号 变量名:out_refund_no 是否必填:是 类型:string(32) 描述: 商户退款单号 示例值: 1217752501201407033233368018
String transactionId
字段名:微信订单号 变量名:transaction_id 是否必填:是 类型:string(32) 描述: 微信支付订单号 示例值: 1217752501201407033233368018
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string(32) 描述: 返回的商户订单号 示例值: 1217752501201407033233368018
String channel
字段名:退款渠道 变量名:channel 是否必填:否 类型:string(16) 描述: ORIGINAL:原路退款 BALANCE:退回到余额 OTHER_BALANCE:原账户异常退到其他余额账户 OTHER_BANKCARD:原银行卡异常退到其他银行卡 示例值: ORIGINAL
String userReceivedAccount
字段名:退款入账账户 变量名:user_received_account 是否必填:是 类型:string(64) 描述: 取当前退款单的退款入账方。 退回银行卡:{银行名称}{卡类型}{卡尾号} 退回支付用户零钱: 支付用户零钱 退还商户: 商户基本账户、商户结算银行账户 退回支付用户零钱通:支付用户零钱通 示例值:招商银行信用卡0403
String successTime
字段名:退款成功时间 变量名:success_time 是否必填:否 类型:string(64) 描述: 1、退款成功时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中, 表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。 例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。 2、当退款状态为退款成功时返回此参数。 示例值:2018-06-08T10:34:56+08:00
String createTime
字段名:退款创建时间 变量名:create_time 是否必填:是 类型:string(64) 描述: 1、退款受理时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中, 表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。 例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。 2、当退款状态为退款成功时返回此字段。 示例值:2018-06-08T10:34:56+08:00
String status
字段名:退款状态 变量名:status 是否必填:是 类型:string(16) 描述: 退款状态,枚举值: SUCCESS:退款成功 REFUNDCLOSE:退款关闭 PROCESSING:退款处理中 ABNORMAL:退款异常,退款到银行发现用户的卡作废或者冻结了,导致原路退款银行卡失败,可前往【服务商平台—>交易中心】,手动处理此笔退款 示例值:SUCCESS
RefundQueryResult.Amount amount
字段名:金额信息 变量名:amount 是否必填:是 类型:object 描述: 金额信息
List<E> promotionDetails
字段名:营销详情 变量名:promotion_detail 是否必填:否 类型:array 描述: 优惠退款信息
String refundAccount
字段名:退款出资商户 变量名:refund_account 是否必填:否 类型:string(32) 描述: 电商平台垫资退款专用参数。需先确认已开通此功能后,才能使用。若需要开通,请联系微信支付客服。 枚举值: REFUND_SOURCE_PARTNER_ADVANCE : 电商平台垫付,需要向微信支付申请开通 REFUND_SOURCE_SUB_MERCHANT : 二级商户,默认值 注意: 若传入REFUND_SOURCE_PARTNER_ADVANCE,仅代表可以使用垫付退款,实际出款账户需以退款申请受理结果或查单结果为准。 示例值:REFUND_SOURCE_SUB_MERCHANT
String fundsAccount
字段名:资金账户 变量名:funds_account 是否必填:否 类型:string(32) 描述: 若订单处于待分账状态,且未指定垫资退款(即refund_account未指定为REFUND_SOURCE_PARTNER_ADVANCE), 可以传入此参数,指定退款资金来源账户。当该字段不存在时,默认使用订单交易资金所在账户出款, 即待分账时使用不可用余额的资金进行退款,已分账或无分账时使用可用余额的资金进行退款。 AVAILABLE:可用余额 示例值:AVAILABLE
String refund
字段名:退款金额 变量名:refund 是否必填:是 类型:int 描述: 退款金额,币种的最小单位,只能为整数,不能超过原订单支付金额。 示例值:888
String payerRefund
字段名:用户退款金额 变量名:payer_refund 是否必填:是 类型:int 描述: 退款给用户的金额,不包含所有优惠券金额。 示例值:888
Integer discountRefund
字段名:优惠退款金额 变量名:discount_refund 是否必填:否 类型:int 描述: 优惠券的退款金额,原支付单的优惠按比例退款。 示例值:888
String currency
字段名:退款币种 变量名:currency 是否必填:否 类型:string(18) 描述: 符合ISO 4217标准的三位字母代码,目前只支持人民币:CNY 。 示例值: CNY
String promotionId
字段名:券ID 变量名:promotion_id 是否必填:是 类型:string(32) 描述:券或者立减优惠id 。 示例值:109519
String scope
字段名:优惠范围 变量名:scope 是否必填:是 类型:string(32) 描述: 优惠范围 枚举值: GLOBAL:全场代金券 SINGLE:单品优惠 示例值:GLOBAL
String type
字段名:优惠类型 变量名:type 是否必填:是 类型:string(32) 描述: 枚举值: COUPON:充值型代金券,商户需要预先充值营销经费 DISCOUNT:免充值型优惠券,商户不需要预先充值营销经费 示例值:DISCOUNT
Integer amount
字段名:优惠券面额 变量名:amount 是否必填:是 类型:int 描述: 用户享受优惠的金额(优惠券面额=微信出资金额+商家出资金额+其他出资方金额 )。 示例值:5
Integer refundAmount
字段名:优惠退款金额 变量名:refund_amount 是否必填:是 类型:int 描述: 代金券退款金额<=退款金额,退款金额-代金券或立减优惠退款金额为现金,说明详见《代金券或立减优惠》。 示例值:100
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string(32) 描述: 微信支付分配二级商户的商户号。 示例值:1900000109
String spAppid
字段名:电商平台APPID 变量名:sp_appid 是否必填:是 类型:string(32) 描述: 电商平台在微信公众平台申请服务号对应的APPID,申请商户功能的时候微信支付会配置绑定关系。 示例值:wx8888888888888888
String subAppid
字段名:二级商户APPID 变量名:sub_appid 是否必填:否 类型:string(32) 描述: 二级商户在微信申请公众号成功后分配的帐号ID,需要电商平台侧配置绑定关系才能传参。 示例值:wxd678efh567hg6999
String transactionId
字段名:微信订单号 变量名:transaction_id 是否必填:与out_order_no二选一 类型:string(32) 描述: 微信支付订单号。 示例值:4208450740201411110007820472
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:与transaction_id二选一 类型:string(64) 描述: 原支付交易对应的商户订单号。 示例值:P20150806125346
String outRefundNo
字段名:商户退款单号 变量名:out_refund_no 是否必填:是 类型:string(64) 描述: 商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母_-|*@,同一退款单号多次请求只退一笔。 示例值:1217752501201407033233368018
String reason
字段名:退款原因 变量名:reason 是否必填:是 类型:string(80) 描述: 若商户传入,会在下发给用户的退款消息中体现退款原因。 注意:若订单退款金额≤1元,且属于部分退款,则不会在退款消息中体现退款原因 示例值:商品已售完
RefundsRequest.Amount amount
字段名:订单金额 变量名:amount 是否必填:是 类型:object 描述: 订单金额信息
String notifyUrl
字段名:退款结果回调url 变量名:notify_url 是否必填:是 类型:string(256) 描述: 异步接收微信支付退款结果通知的回调地址,通知url必须为外网可访问的url,不能携带参数。 如果参数中传了notify_url,则商户平台上配置的回调地址将不会生效,优先回调当前传的地址。 示例值:https://weixin.qq.com
String refundAccount
字段名:退款出资商户 变量名:refund_account 是否必填:否 类型:string(32) 描述: 电商平台垫资退款专用参数。需先确认已开通此功能后,才能使用。若需要开通,请联系微信支付客服。 枚举值: REFUND_SOURCE_PARTNER_ADVANCE : 电商平台垫付,需要向微信支付申请开通 REFUND_SOURCE_SUB_MERCHANT : 二级商户,默认值 注意: 若传入REFUND_SOURCE_PARTNER_ADVANCE,仅代表可以使用垫付退款,实际出款账户需以退款申请受理结果或查单结果为准。 示例值:REFUND_SOURCE_SUB_MERCHANT
String fundsAccount
字段名:资金账户 变量名:funds_account 是否必填:否 类型:string(32) 描述: 若订单处于待分账状态,且未指定垫资退款(即refund_account未指定为REFUND_SOURCE_PARTNER_ADVANCE), 可以传入此参数,指定退款资金来源账户。当该字段不存在时,默认使用订单交易资金所在账户出款, 即待分账时使用不可用余额的资金进行退款,已分账或无分账时使用可用余额的资金进行退款。 AVAILABLE:可用余额 示例值:AVAILABLE
String refundId
字段名:微信退款单号 变量名:refund_id 是否必填:是 类型:string(32) 描述: 微信支付退款订单号。 示例值:1217752501201407033233368018
String outRefundNo
字段名:商户退款单号 变量名:out_refund_no 是否必填:是 类型:string(64) 描述: 商户系统内部的退款单号,商户系统内部唯一,同一退款单号多次请求只退一笔。 示例值:1217752501201407033233368018
String createTime
字段名:退款创建时间 变量名:create_time 是否必填:是 类型:string(64) 描述: 退款受理时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。 示例值:2018-06-08T10:34:56+08:00
RefundsResult.Amount amount
字段名:订单金额 变量名:amount 是否必填:是 类型:object 描述: 订单金额信息
RefundsResult.PromotionDetail[] promotionDetail
字段名:优惠退款详情 变量名:promotion_detail 是否必填:否 类型:array 描述: 优惠退款功能信息
String refundAccount
字段名:退款资金来源 变量名:refund_account 是否必填:否 类型:string(32) 描述: 枚举值: REFUND_SOURCE_PARTNER_ADVANCE : 电商平台垫付 REFUND_SOURCE_SUB_MERCHANT : 二级商户,默认值 示例值:REFUND_SOURCE_SUB_MERCHANT
Integer refund
字段名:退款金额 变量名:refund 是否必填:是 类型:int 描述: 退款金额,币种的最小单位,只能为整数,不能超过原订单支付金额。 示例值:888
Integer payerRefund
字段名:用户退款金额 变量名:payer_refund 是否必填:是 类型:int64 描述: 退款给用户的金额,不包含所有优惠券金额。 示例值:888
Integer discountRefund
字段名:优惠退款金额 变量名:discount_refund 是否必填:否 类型:int64 描述: 优惠券的退款金额,原支付单的优惠按比例退款。 示例值:888
String currency
字段名:币类型 变量名:currency 是否必填:否 类型:string(18) 描述: 符合ISO 4217标准的三位字母代码,目前只支持人民币:CNY。 示例值:CNY
String promotionId
字段名:券ID 变量名:promotion_id 是否必填:是 类型:string(32) 描述: 券或者立减优惠id。 示例值:109519
String scope
字段名:优惠范围 变量名:scope 是否必填:是 类型:string(32) 描述: 枚举值: GLOBAL:全场代金券 SINGLE:单品优惠 示例值:SINGLE
String type
字段名:优惠类型 变量名:type 是否必填:是 类型:string(32) 描述: 枚举值: COUPON:充值型代金券,商户需要预先充值营销经费 DISCOUNT:免充值型优惠券,商户不需要预先充值营销经费 示例值:DISCOUNT
Integer amount
字段名:优惠券面额 变量名:amount 是否必填:是 类型:int 描述: 用户享受优惠的金额(优惠券面额=微信出资金额+商家出资金额+其他出资方金额 )。 示例值:5
Integer refundAmount
字段名:优惠退款金额 变量名:refund_amount 是否必填:是 类型:int 描述: 代金券退款金额<=退款金额,退款金额-代金券或立减优惠退款金额为现金,说明详见《代金券或立减优惠》https://pay.weixin.qq.com/wiki/doc/api/tools/sp_coupon.php?chapter=12_1 。 示例值:CNY
String refundId
字段名:微信退款单号 变量名:refund_id 是否必填:是 类型:string(32) 描述: 微信支付退款单的主键,唯一定义此资源的标识。 必须是垫付退款的微信支付退款单 示例值:50000000382019052709732678859
String advanceReturnId
字段名:微信回补单号 变量名:advance_return_id 是否必填:是 类型:string(32) 描述:微信支付生成的垫付回补操作单号 示例值:1215562501201407033233368018
Integer returnAmount
字段名:垫付回补金额 变量名:return_amount 是否必填:是 类型:int 描述:退款单对应的垫付退款的金额 示例值:888
String payerMchid
字段名:出款方商户号 变量名:payer_mchid 是否必填:是 类型:string(32) 描述:微信支付分配给出款方的商户号 示例值:1900000109
String payerAccount
字段名:出款方账户 变量名:payer_account 是否必填:是 类型:string(32) 描述: 枚举值: BASIC:基本账户 OPERATION:运营账户 示例值:BASIC
String payeeMchid
字段名:入账方商户号 变量名:payee_mchid 是否必填:是 类型:string(32) 描述: 微信支付分配给入账方的商户号 示例值:1900000108
String payeeAccount
字段名:入账方账户 变量名:payee_account 是否必填:是 类型:string(32) 描述:枚举值: BASIC:基本账户 OPERATION:运营账户 示例值:BASIC
String result
字段名:垫付回补结果 变量名:result 是否必填:是 类型:string(32) 描述:枚举值: SUCCESS:回补成功 FAILED:回补失败,出款方账户余额不足时发生 PROCESSING:处理中 示例值:SUCCESS
String successTime
字段名:垫付回补完成时间 变量名:success_time 是否必填:否 类型:string(64) 描述:垫付回补完成的时间,遵循rfc3339标准格式, 格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日, T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒, TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。 例如:2015-05-20T13:29:35+08:00表示北京时间2015年05月20日13点29分35秒。 示例值:2018-06-08T10:34:56+08:00
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string(32) 描述: 分账出资的电商平台二级商户,填写微信支付分配的商户号。 示例值:1900000109
String orderId
字段名:微信分账单号 变量名:order_id 是否必填:与out_order_no二选一 类型:string(64) 描述: 微信分账单号,微信系统返回的唯一标识。微信分账单号和商户分账单号二选一填写。 示例值:3008450740201411110007820472
String outOrderNo
字段名:商户分账单号 变量名:out_order_no 是否必填:与order_id二选一 类型:string(64) 描述: 商户系统内部的分账单号,在商户系统内部唯一(单次分账、多次分账、完结分账应使用不同的商户分账单号),同一分账单号多次请求等同一次。 示例值:P20150806125346
String outReturnNo
字段名:商户回退单号 变量名:out_return_no 是否必填:是 类型:string(64) 描述: 此回退单号是商户在自己后台生成的一个新的回退单号,在商户后台唯一。 示例值:P20150806125346
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string(32) 描述: 分账出资的电商平台二级商户,填写微信支付分配的商户号。 示例值:1900000109
String orderId
字段名:微信分账单号 变量名:order_id 是否必填:与out_order_no二选一 类型:string(64) 描述: 微信分账单号,微信系统返回的唯一标识。微信分账单号和商户分账单号二选一填写。 示例值:3008450740201411110007820472
String outOrderNo
字段名:商户分账单号 变量名:out_order_no 是否必填:与order_id二选一 类型:string(64) 描述: 商户系统内部的分账单号,在商户系统内部唯一(单次分账、多次分账、完结分账应使用不同的商户分账单号),同一分账单号多次请求等同一次。 示例值:P20150806125346
String outReturnNo
字段名:商户回退单号 变量名:out_return_no 是否必填:是 类型:string(64) 描述: 此回退单号是商户在自己后台生成的一个新的回退单号,在商户后台唯一。 示例值:P20150806125346
String returnMchid
字段名:回退商户号 变量名:return_mchid 是否必填:是 类型:string(32) 描述: 只能对原分账请求中成功分给商户接收方进行回退。 示例值:86693852
Integer amount
字段名:回退金额 变量名:amount 是否必填:是 类型:int 描述: 需要从分账接收方回退的金额,单位为分,只能为整数,不能超过原始分账单分出给该接收方的金额。 示例值:10
String description
字段名:回退描述 变量名:description 是否必填:是 类型:string(80) 描述: 分账回退的原因描述 示例值:分账回退
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string(32) 描述: 分账出资的电商平台二级商户,填写微信支付分配的商户号。 示例值:1900000109
String orderId
字段名:微信分账单号 变量名:order_id 是否必填:与out_order_no二选一 类型:string(64) 描述: 微信分账单号,微信系统返回的唯一标识。微信分账单号和商户分账单号二选一填写。 示例值:3008450740201411110007820472
String outOrderNo
字段名:商户分账单号 变量名:out_order_no 是否必填:与order_id二选一 类型:string(64) 描述: 商户系统内部的分账单号,在商户系统内部唯一(单次分账、多次分账、完结分账应使用不同的商户分账单号),同一分账单号多次请求等同一次。 示例值:P20150806125346
String outReturnNo
字段名:商户回退单号 变量名:out_return_no 是否必填:是 类型:string(64) 描述: 此回退单号是商户在自己后台生成的一个新的回退单号,在商户后台唯一。 示例值:P20150806125346
String returnMchid
字段名:回退商户号 变量名:return_mchid 是否必填:是 类型:string(32) 描述: 只能对原分账请求中成功分给商户接收方进行回退。 示例值:86693852
Integer amount
字段名:回退金额 变量名:amount 是否必填:是 类型:int 描述: 需要从分账接收方回退的金额,单位为分,只能为整数,不能超过原始分账单分出给该接收方的金额。 示例值:10
String returnNo
字段名:微信回退单号 变量名:return_no 是否必填:是 类型:string(64) 描述: 微信分账回退单号,微信系统返回的唯一标识。 示例值:3008450740201411110007820472
String result
字段名:回退结果 变量名:result 是否必填:是 类型:string(32) 描述: 如果请求返回为处理中,则商户可以通过调用回退结果查询接口获取请求的最终处理结果,枚举值: PROCESSING:处理中 SUCCESS:已成功 FAIL:已失败 注意:如果返回为处理中,请勿变更商户回退单号,使用相同的参数再次发起分账回退,否则会出现资金风险 在处理中状态的回退单如果5天没有成功,会因为超时被设置为已失败 示例值:SUCCESS
String failReason
字段名:失败原因 变量名:fail_reason 是否必填:否 类型:string(32) 描述: 回退失败的原因,此字段仅回退结果为FAIL时存在,枚举值: ACCOUNT_ABNORMAL:分账接收方账户异常 TIME_OUT_CLOSED::超时关单 示例值:TIME_OUT_CLOSED
String finishTime
字段名:完成时间 变量名:finish_time 是否必填:是 类型:string(64) 描述: 分账回退完成时间,遵循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年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35.120+08:00
String accountType
字段名:账户类型 变量名:account_type 是否必填:是 类型:string(32) 描述: 根据特约商户号的主体类型,可选择的账户类型如下: 1、小微主体:经营者个人银行卡 2、个体工商户主体:经营者个人银行卡/ 对公银行账户 3、企业主体:对公银行账户 4、党政、机关及事业单位主体:对公银行账户 5、其他组织主体:对公银行账户 枚举值: ACCOUNT_TYPE_BUSINESS:对公银行账户 ACCOUNT_TYPE_PRIVATE:经营者个人银行卡 示例值:ACCOUNT_TYPE_BUSINESS
String accountBank
字段名:开户银行 变量名:account_bank 是否必填:是 类型:string(128) 描述: 请填写开户银行名称,详细参见《开户银行对照表》https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/ecommerce/applyments/chapter4_1.shtml。 示例值:工商银行
String bankAddressCode
字段名:开户银行省市编码 变量名:bank_address_code 是否必填:是 类型:string(128) 描述: 需至少精确到市,详细参见《省市区编号对照表》。 示例值:110000
String bankName
字段名:开户银行全称(含支行) 变量名:bank_name 是否必填:否 类型:string(128) 描述: 若开户银行为“其他银行”,则需二选一填写“开户银行全称(含支行)”或“开户银行联行号”。 填写银行全称,如"深圳农村商业银行XXX支行" ,详细参见开户银行全称(含支行)对照表。 示例值:施秉县农村信用合作联社城关信用社
String bankBranchId
字段名:开户银行联行号 变量名:bank_branch_id 是否必填:否 类型:string(128) 描述: 若开户银行为“其他银行”,则需二选一填写“开户银行全称(含支行)”或“开户银行联行号”。 填写银行联行号,详细参见《开户银行全称(含支行)对照表》。 示例值:402713354941
String accountNumber
字段名:银行账号 变量名:account_number 是否必填:是 类型:string(128) 描述: 1、数字,长度遵循系统支持的对公/对私卡号长度要求 2、该字段需进行加密处理,加密方法详见《敏感信息加密说明》。(提醒:必须在HTTP头中上送Wechatpay-Serial)
String accountType
字段名:账户类型 变量名:account_type 是否必填:是 类型:string(32) 描述: 枚举值: ACCOUNT_TYPE_BUSINESS:对公银行账户 ACCOUNT_TYPE_PRIVATE:经营者个人银行卡 示例值:ACCOUNT_TYPE_BUSINESS
String accountBank
字段名:开户银行 变量名:account_bank 是否必填:是 类型:string(128) 描述: 返回特约商户的结算账户-开户银行全称。 示例值:工商银行
String bankName
字段名:开户银行全称(含支行) 变量名:bank_name 是否必填:是 类型:string(128) 描述: 返回特约商户的结算账户-开户银行全称(含支行)。 示例值:施秉县农村信用合作联社城关信用社
String bankBranchId
字段名:开户银行联行号 变量名:bank_branch_id 是否必填:是 类型:string(128) 描述: 返回特约商户的结算账户-联行号。 示例值:402713354941
String accountNumber
字段名:银行账号 变量名:account_number 是否必填:是 类型:string(128) 描述: 返回特约商户的结算账户-银行账号,掩码显示。 示例值:62*************78
String verifyResult
字段名:汇款验证结果 变量名:verify_result 是否必填:是 类型:string(32) 描述: 返回特约商户的结算账户-汇款验证结果。 VERIFYING:系统汇款验证中,商户可发起提现尝试。 VERIFY_SUCCESS:系统成功汇款,该账户可正常发起提现。 VERIFY_FAIL:系统汇款失败,该账户无法发起提现,请检查修改。 示例值:VERIFY_SUCCESS
String outRequestNo
字段名:商户提现单号 变量名:out_request_no 是否必填:是 类型:string(32) 描述: 商户提现单号,由商户自定义生成。 示例值:20190611222222222200000000012122
Integer amount
字段名:提现金额 变量名:amount 是否必填:是 类型:int64 描述: 提现金额,单位:分(RMB) 示例值:1
String remark
字段名:备注 变量名:remark 是否必填:否 类型:string(56) 描述: 商户对提现单的备注 示例值:交易提现
String bankMemo
字段名:银行附言 变量名:bank_memo 是否必填:否 类型:string(32) 描述: 展示在收款银行系统中的附言,数字、字母最长32个汉字(能否成功展示依赖银行系统支持)。 示例值:xx平台提现
String accountType
字段名:账户类型 变量名:account_type 是否必填:是 类型:string(16) 描述: 枚举值: BASIC:基本账户 OPERATION:运营账户 FEES:手续费账户 示例值:BASIC
String withdrawId
字段名:微信支付提现单号 变量名:withdraw_id 是否必填:否 (文档里面是【否】,理论上应该都有值) 类型:string(128) 描述: 微信支付系统生成的提现单号。 示例值:12321937198237912739132791732912793127931279317929791239112123
String outRequestNo
字段名:商户提现单号 变量名:out_request_no 是否必填:是 类型:string(32) 描述: 必须是字母数字 示例值: 20190611222222222200000000012122
String status
字段名:提现单状态 变量名:status 是否必填:是 类型:string(16) 描述: 枚举值: CREATE_SUCCESS:受理成功 SUCCESS:提现成功 FAIL:提现失败 REFUND:提现退票 CLOSE:关单 INIT:业务单已创建 示例值:CREATE_SUCCESS
String withdrawId
字段名:微信支付提现单号 变量名:withdraw_id 是否必填:是 类型:string(128) 描述: 电商平台提交二级商户提现申请后,由微信支付返回的申请单号,作为查询申请状态的唯一标识。 示例值: 12321937198237912739132791732912793127931279317929791239112123
String outRequestNo
字段名:商户提现单号 变量名:out_request_no 是否必填:是 类型:string(32) 描述: 商户提现单号,由商户自定义生成。 示例值: 20190611222222222200000000012122
Integer amount
字段名:提现金额 变量名:amount 是否必填:是 类型:int) 描述: 单位:分 示例值:1
String createTime
字段名:发起提现时间 变量名:create_time 是否必填:是 类型:string(29) 描述: 遵循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+08:00表示,北京时间2015年5月20日13点29分35秒。 示例值:2015-05-20T13:29:35.120+08:00
String updateTime
字段名:提现状态更新时间 变量名:update_time 是否必填:是 类型:string(29) 描述: 遵循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+08:00表示,北京时间2015年5月20日13点29分35秒。 示例值:2015-05-20T13:29:35.120+08:00
String reason
字段名:失败原因 变量名:reason 是否必填:是 类型:string(255) 描述: 仅在提现失败、退票、关单时有值 示例值:卡号错误
String remark
字段名:提现备注 变量名:remark 是否必填:是 类型:string(56) 描述: 商户对提现单的备注,若发起提现时未传入相应值或输入不合法,则该值为空 示例值:交易提现
String bankMemo
字段名:银行附言 变量名:bank_memo 是否必填:是 类型:string(32) 描述: 展示在收款银行系统中的附言,由数字、字母、汉字组成(能否成功展示依赖银行系统支持)。若发起提现时未传入相应值或输入不合法,则该值为空 示例值:微信提现
String account_type
字段名:出款账户类型 变量名:account_type 是否必填:是 类型:string(16) 描述: BASIC:基本户 OPERATION:运营账户 FEES:手续费账户 示例值:BASIC
String solution
字段名:提现失败解决方案 变量名:solution 是否必填:是 类型:string(255) 描述: 仅在提现失败、退票、关单时有值 示例值:请修改结算银行卡信息
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string(32) 描述: 补差的电商平台二级商户,填写微信支付分配的商户号。 示例值:1900000109
String transactionId
字段名:微信订单号 变量名:transaction_id 是否必填:是 类型:string(64) 描述: 微信支付订单号。 示例值: 4208450740201411110007820472
String description
字段名:取消补差描述 变量名:description 是否必填:是 类型:string(80) 描述: 取消补差描述,查询的时候原样带回。 示例值:订单退款
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string(32) 描述: 补差的电商平台二级商户,填写微信支付分配的商户号。 示例值:1900000109
String transactionId
字段名:微信订单号 变量名:transaction_id 是否必填:是 类型:string(64) 描述: 微信支付订单号。 示例值: 4208450740201411110007820472
String result
字段名:取消补差结果 变量名:result 是否必填:是 类型:string(16) 描述: 取消补差结果,枚举值: SUCCESS:成功 FAIL:失败 示例值:SUCCESS
String description
字段名:取消补差描述 变量名:description 是否必填:是 类型:string(80) 描述: 取消补差描述 示例值:订单退款
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string(32) 描述: 补差的电商平台二级商户,填写微信支付分配的商户号。 示例值:1900000109
String transactionId
字段名:微信订单号 变量名:transaction_id 是否必填:是 类型:string(64) 描述: 微信支付订单号。 示例值: 4208450740201411110007820472
String outSubsidyNo
字段名:商户补差单号 变量名:out_subsidy_no 是否必填:是 类型:string(64) 描述: 商户系统内部的补差单号,在商户系统内部唯一,同一补差单号多次请求等同一次。 示例值:P20150806125347
Integer amount
字段名:补差金额 变量名:amount 是否必填:是 类型:int64 描述: 补差金额,单位为分,只能为整数,不能超过下单时候的最大补差金额。 注意:单笔订单最高补差金额为10000元 示例值:10
String description
字段名:补差描述 变量名:description 是否必填:是 类型:string(80) 描述: 补差备注描述,查询的时候原样带回。 示例值:测试备注
String refundId
字段名:微信退款单号 变量名:refund_id 是否必填:否 类型:string(32) 描述: 微信退款单号,微信支付系统退款返回的唯一标识,当补差金额小于下单时候的金额,该字段必填 示例值:3008450740201411110007820472
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string(32) 描述: 补差的电商平台二级商户,填写微信支付分配的商户号。 示例值:1900000109
String transactionId
字段名:微信订单号 变量名:transaction_id 是否必填:是 类型:string(64) 描述: 微信支付订单号。 示例值: 4208450740201411110007820472
String subsidyId
字段名:微信补差单号 变量名:subsidy_id 是否必填:是 类型:string(64) 描述: 微信补差单号,微信支付系统返回的唯一标识。 示例值: 3008450740201411110007820472
String description
字段名:补差描述 变量名:description 是否必填:是 类型:string(80) 描述: 补差备注描述,查询的时候原样带回。 示例值:测试备注
Integer amount
字段名:补差金额 变量名:amount 是否必填:是 类型:int64 描述: 补差金额,单位为分,只能为整数,不能超过下单时候的最大补差金额。 注意:单笔订单最高补差金额为10000元 示例值:10
String result
字段名:补差单结果 变量名:result 是否必填:是 类型:string(16) 描述: 补差单状态,枚举值: SUCCESS:补差成功 FAIL:补差失败 REFUND:已全额回退 示例值:SUCCESS
String successTime
字段名:补差完成时间 变量名:success_time 是否必填:是 类型:string(32) 描述: 补贴完成时间,遵循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+08:00表示,北京时间2015年5月20日13点29分35秒。 示例值: 2015-05-20T13:29:35.120+08:00
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string(32) 描述: 补差的电商平台二级商户,填写微信支付分配的商户号。 示例值:1900000109
String transactionId
字段名:微信订单号 变量名:transaction_id 是否必填:是 类型:string(64) 描述: 微信支付订单号。 示例值: 4208450740201411110007820472
String outOrderNo
字段名:商户补差回退单号 变量名:out_order_no 是否必填:是 类型:string(64) 描述: 原发起补差请求时使用的商户系统内部的补差单号。 示例值:P20150806125346
Integer amount
字段名:补差金额 变量名:amount 是否必填:是 类型:int64 描述: 补差金额,单位为分,只能为整数,不能超过下单时候的最大补差金额。 注意:单笔订单最高补差金额为10000元 示例值:10
String description
字段名:补差描述 变量名:description 是否必填:是 类型:string(80) 描述: 补差备注描述,查询的时候原样带回。 示例值:测试备注
String refundId
字段名:微信退款单号 变量名:refund_id 是否必填:否 类型:string(64) 描述: 微信退款单号,微信支付系统退款返回的唯一标识。 用户零钱账户异常,无法在线发起退款时,此字段可以不传;其他情况下必传。 示例值:3008450740201411110007820472
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string(32) 描述: 补差的电商平台二级商户,填写微信支付分配的商户号。 示例值:1900000109
String transactionId
字段名:微信订单号 变量名:transaction_id 是否必填:是 类型:string(64) 描述: 微信支付订单号。 示例值: 4208450740201411110007820472
String subsidyRefundId
字段名:微信补差单号 变量名:subsidy_refund_id 是否必填:是 类型:string(64) 描述: 微信补差单号,微信支付系统返回的唯一标识。 示例值: 3008450740201411110007820472
String refundId
字段名:微信退款单号 变量名:refund_id 是否必填:否 类型:string(64) 描述: 微信退款单号,微信支付系统退款返回的唯一标识。 示例值: 3008450740201411110007820472
String outOrderNo
字段名:商户补差回退单号 变量名:out_order_no 是否必填:是 类型:string(64) 描述: 商户系统内部的补差回退单号,在商户系统内部唯一,只能是数字、大小写字母_-|*@ ,同一补差回退单号多次请求等同一次。 示例值:P20150806125346
String description
字段名:补差描述 变量名:description 是否必填:是 类型:string(80) 描述: 补差备注描述,查询的时候原样带回。 示例值:测试备注
Integer amount
字段名:补差金额 变量名:amount 是否必填:是 类型:int64 描述: 补差金额,单位为分,只能为整数,不能超过下单时候的最大补差金额。 注意:单笔订单最高补差金额为10000元 示例值:10
String result
字段名:补差单结果 变量名:result 是否必填:是 类型:string(16) 描述: 补差单状态,枚举值: SUCCESS:补差成功 FAIL:补差失败 REFUND:已全额回退 示例值:SUCCESS
String successTime
字段名:补差完成时间 变量名:success_time 是否必填:是 类型:string(32) 描述: 补贴完成时间,遵循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+08:00表示,北京时间2015年5月20日13点29分35秒。 示例值: 2015-05-20T13:29:35.120+08:00
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string(32) 描述: 电商平台二级商户号,由微信支付生成并下发。 示例值:1900000109
String outRequestNo
字段名:商户提现单号 变量名:out_request_no 是否必填:是 类型:string(32) 描述: 必须是字母数字 示例值: 20190611222222222200000000012122
Integer amount
字段名:提现金额 变量名:amount 是否必填:是 类型:int64 描述: 提现金额(单位:分) 示例值:100
String remark
字段名:备注 变量名:remark 是否必填:否 类型:string(56) 描述: 商户对提现单的备注 示例值:交易提现
String bankMemo
字段名:银行附言 变量名:bank_memo 是否必填:否 类型:string(32) 描述: 展示在收款银行系统中的附言,数字、字母最长32个汉字(能否成功展示依赖银行系统支持)。 示例值:微信支付提现
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string(32) 描述: 电商平台二级商户号,由微信支付生成并下发。 示例值:1900000109
String withdrawId
字段名:微信支付提现单号 变量名:withdraw_id 是否必填:是 类型:string(128) 描述: 电商平台提交二级商户提现申请后,由微信支付返回的申请单号,作为查询申请状态的唯一标识。 示例值: 12321937198237912739132791732912793127931279317929791239112123
String outRequestNo
字段名:商户提现单号 变量名:out_request_no 是否必填:否 类型:string(32) 描述: 必须是字母数字 示例值: 20190611222222222200000000012122
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string(32) 描述: 电商平台二级商户号,由微信支付生成并下发。 示例值:1900000109
String spMchid
字段名:电商平台商户号 变量名:sp_mchid 是否必填:是 类型:string(32) 描述: 电商平台商户号 示例值:1800000123
String status
字段名:提现单状态 变量名:status 是否必填:是 类型:string(16) 描述: 枚举值: CREATE_SUCCESS:受理成功 SUCCESS:提现成功 FAIL:提现失败 REFUND:提现退票 CLOSE:关单 INIT:业务单已创建 示例值:CREATE_SUCCESS
String withdrawId
字段名:微信支付提现单号 变量名:withdraw_id 是否必填:是 类型:string(128) 描述: 电商平台提交二级商户提现申请后,由微信支付返回的申请单号,作为查询申请状态的唯一标识。 示例值: 12321937198237912739132791732912793127931279317929791239112123
String outRequestNo
字段名:商户提现单号 变量名:out_request_no 是否必填:是 类型:string(32) 描述: 商户提现单号,由商户自定义生成。 示例值: 20190611222222222200000000012122
Integer amount
字段名:提现金额 变量名:amount 是否必填:是 类型:int) 描述: 单位:分 示例值:1
String createTime
字段名:发起提现时间 变量名:create_time 是否必填:是 类型:string(29) 描述: 遵循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+08:00表示,北京时间2015年5月20日13点29分35秒。 示例值:2015-05-20T13:29:35.120+08:00
String updateTime
字段名:提现状态更新时间 变量名:update_time 是否必填:是 类型:string(29) 描述: 遵循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+08:00表示,北京时间2015年5月20日13点29分35秒。 示例值:2015-05-20T13:29:35.120+08:00
String reason
字段名:失败原因 变量名:reason 是否必填:是 类型:string(255) 描述: 仅在提现失败、退票、关单时有值 示例值:卡号错误
String remark
字段名:提现备注 变量名:remark 是否必填:是 类型:string(56) 描述: 商户对提现单的备注,若发起提现时未传入相应值或输入不合法,则该值为空 示例值:交易提现
String bankMemo
字段名:银行附言 变量名:bank_memo 是否必填:是 类型:string(32) 描述: 展示在收款银行系统中的附言,由数字、字母、汉字组成(能否成功展示依赖银行系统支持)。若发起提现时未传入相应值或输入不合法,则该值为空 示例值:微信提现
String billDate
字段名:账单日期 变量名:bill_date 是否必填:是 类型:string(10) 描述: 格式YYYY-MM-DD 仅支持三个月内的账单下载申请。 示例值:2019-06-11
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:否 类型:string(12) 描述: 1、若商户是直连商户:无需填写该字段。 2、若商户是服务商: ● 不填则默认返回服务商下的交易或退款数据。 ● 如需下载某个子商户下的交易或退款数据,则该字段必填。 特殊规则:最小字符长度为8 注意:仅适用于电商平台 服务商 示例值:1900000001
String billType
字段名:账单类型 变量名:bill_type 是否必填:否 类型:string(32) 描述: 不填则默认是ALL 枚举值: ALL:返回当日所有订单信息(不含充值退款订单) SUCCESS:返回当日成功支付的订单(不含充值退款订单) REFUND:返回当日退款订单(不含充值退款订单) 示例值:ALL
String tarType
字段名:压缩类型 变量名:tar_type 是否必填:否 类型:string(32) 描述: 不填则默认是数据流 枚举值: GZIP:返回格式为.gzip的压缩包账单 示例值:GZIP
String hashType
字段名:哈希类型 变量名:hash_type 是否必填:是 类型:string(32) 描述: 原始账单(gzip需要解压缩)的摘要值,用于校验文件的完整性。 示例值:SHA1
String hashValue
字段名:哈希值 变量名:hash_value 是否必填:是 类型:string(1024) 描述: 原始账单(gzip需要解压缩)的摘要值,用于校验文件的完整性。 示例值:79bb0f45fc4c42234a918000b2668d689e2bde04
String downloadUrl
字段名:账单下载地址 变量名:download_url 是否必填:是 类型:string(32) 描述: 供下一步请求账单文件的下载地址,该地址30s内有效。 示例值:https://api.mch.weixin.qq.com/v3/billdownload/file?token=xxx
String prepayId
字段名:预支付交易会话标识 (APP支付、JSAPI支付 会返回) 变量名:prepay_id 是否必填:是 类型:string(64) 描述: 数字和字母。微信生成的预支付会话标识,用于后续接口调用使用。 示例值:wx201410272009395522657a690389285100
String h5Url
字段名:支付跳转链接 (H5支付 会返回) 变量名:h5_url 是否必填:是 类型:string(512) 描述: 支付跳转链接 示例值:https://wx.tenpay.com/cgi-bin/mmpayweb-bin/checkmweb?prepay_id=wx2016121516420242444321ca0631331346&package=1405458241
String codeUrl
字段名:二维码链接 (NATIVE支付 会返回) 变量名:h5_url 是否必填:是 类型:string(512) 描述: 二维码链接 示例值:weixin://pay.weixin.qq.com/bizpayurl/up?pr=NwY5Mz9&groupid=00
String partnerTradeNo
String paymentNo
String bankNoMd5
String trueNameMd5
Integer amount
String status
PROCESSING(处理中,如有明确失败,则返回额外失败原因;否则没有错误原因) SUCCESS(付款成功) FAILED(付款失败) BANK_FAIL(银行退票,订单状态由付款成功流转至退票,退票时付款金额和手续费会自动退还)
Integer cmmsAmount
String createTime
String paySuccessTime
String failReason
String partnerTradeNo
商户企业付款单号. 变量名:partner_trade_no 是否必填:是 示例值:1212121221227 类型:string(32) 描述:商户订单号,需保持唯一(只允许数字[0~9]或字母[A~Z]和[a~z],最短8位,最长32位)
String encBankNo
收款方银行卡号. 传值时请传原始值 变量名:enc_bank_no 是否必填:是 示例值:8609cb22e1774a50a930e414cc71eca06121bcd266335cda230d24a7886a8d9f 类型:string(64) 描述:收款方银行卡号(采用标准RSA算法,公钥由微信侧提供),详见获取RSA加密公钥API
String encTrueName
收款方用户名. 传值时请传原始值 变量名:enc_true_name 是否必填:是 示例值:ca775af5f841bdf424b2e6eb86a6e21e 类型:string(64) 描述:收款方用户名(采用标准RSA算法,公钥由微信侧提供)详见获取RSA加密公钥API
String bankCode
收款方开户行. 变量名:bank_code 是否必填:是 示例值:1001 类型:string(64) 描述:银行卡所在开户行编号,详见银行编号列表
Integer amount
付款金额. 变量名:amount 是否必填:是 示例值:100000 类型:int 描述:付款金额:RMB分(支付总额,不含手续费) 注:大于0的整数
String description
付款说明. 变量名:desc 是否必填:否 示例值:理财 类型:string 描述:企业付款到银行卡付款说明,即订单备注(UTF8编码,允许100个字符以内)
String partnerTradeNo
字段名:商户订单号. 变量名:partner_trade_no 是否必填:是 示例值:10000098201411111234567890 类型:String 描述商户订单号
String partnerTradeNo
String detailId
String status
String reason
String openid
String transferName
Integer paymentAmount
String transferTime
String paymentTime
String desc
String mchBillNo
String mchBillNo
String detailId
String status
String sendType
Integer totalAmount
String reason
String sendTime
String refundTime
Integer refundAmount
String wishing
String remark
String actName
String openid
Integer amount
String rcvTime
String senderName
String senderHeaderMediaId
String mchBillNo
String wxAppId
String senderName
String agentId
String senderHeaderMediaId
String reOpenid
Integer totalAmount
String wishing
String actName
String remark
String sceneId
String mchBillNo
String mchId
String wxAppId
String reOpenid
String totalAmount
String sendListId
String senderName
String senderHeaderMediaId
String mchAppid
字段名:公众账号appid. 变量名:mch_appid 是否必填:是 示例值:wx8888888888888888 类型:String 描述:微信分配的公众账号ID(企业号corpid即为此appId)
String mchId
字段名:商户号. 变量名:mchid 是否必填:是 示例值:1900000109 类型:String(32) 描述:微信支付分配的商户号
String deviceInfo
字段名:设备号. 变量名:device_info 是否必填:否 示例值:13467007045764 类型:String(32) 描述:微信支付分配的终端设备号
String partnerTradeNo
字段名:商户订单号. 变量名:partner_trade_no 是否必填:是 示例值:10000098201411111234567890 类型:String 描述:商户订单号
String openid
字段名:需保持唯一性 用户openid. 变量名:openid 是否必填:是 示例值:oxTWIuGaIt6gTKsQRLau2M0yL16E 类型:String 描述:商户appid下,某用户的openid
String checkName
字段名:校验用户姓名选项. 变量名:check_name 是否必填:是 示例值:OPTION_CHECK 类型:String 描述:NO_CHECK:不校验真实姓名 FORCE_CHECK:强校验真实姓名(未实名认证的用户会校验失败,无法转账) OPTION_CHECK:针对已实名认证的用户才校验真实姓名(未实名认证用户不校验,可以转账成功)
String reUserName
字段名:收款用户姓名. 变量名:re_user_name 是否必填:可选 示例值:马花花 类型:String 描述:收款用户真实姓名。 如果check_name设置为FORCE_CHECK或OPTION_CHECK, 则必填用户真实姓名
Integer amount
字段名:金额. 变量名:amount 是否必填:是 示例值:10099 类型:int 描述:企业付款金额, 单位为分
String description
字段名:企业付款描述信息. 变量名:desc 是否必填:是 示例值:理赔 类型:String 描述:企业付款操作说明信息。必填。
String spbillCreateIp
字段名:Ip地址. 变量名:spbill_create_ip 是否必填:是 示例值:192.168.0.1 类型:String(32) 描述:调用接口的机器Ip地址
String scene
字段名:付款场景. 变量名:scene 是否必填:否 示例值:BRAND_REDPACKET 类型:String(64) 描述:BRAND_REDPACKET:品牌红包,其他值或不传则默认为普通付款到零钱
Integer brandId
字段名:品牌ID. 变量名:brand_id 是否必填:否 示例值:1234 类型:int 描述:品牌在微信支付的唯一标识。仅在付款场景为品牌红包时必填
String finderTemplateId
字段名:消息模板ID. 变量名:finder_template_id 是否必填:否 示例值:1243100000000000 类型:String(128) 描述:品牌所配置的消息模板的唯一标识。仅在付款场景为品牌红包时必填。
String partnerTradeNo
字段名:商户订单号. 变量名:partner_trade_no 是否必填:是 示例值:10000098201411111234567890 类型:String 描述:商户订单号
String openid
字段名:需保持唯一性 用户openid. 变量名:openid 是否必填:是 示例值:oxTWIuGaIt6gTKsQRLau2M0yL16E 类型:String 描述:商户appid下,某用户的openid
String deviceInfo
字段名:设备号. 变量名:device_info 是否必填:否 示例值:13467007045764 类型:String(32) 描述:微信支付分配的终端设备号
String checkName
字段名:校验用户姓名选项. 变量名:check_name 是否必填:是 示例值:OPTION_CHECK 类型:String 描述:NO_CHECK:不校验真实姓名 FORCE_CHECK:强校验真实姓名(未实名认证的用户会校验失败,无法转账) OPTION_CHECK:针对已实名认证的用户才校验真实姓名(未实名认证用户不校验,可以转账成功)
String reUserName
字段名:收款用户姓名. 变量名:re_user_name 是否必填:可选 示例值:马花花 类型:String 描述:收款用户真实姓名。 如果check_name设置为FORCE_CHECK或OPTION_CHECK, 则必填用户真实姓名
Integer amount
字段名:金额. 变量名:amount 是否必填:是 示例值:10099 类型:int 描述:企业付款金额, 单位为分
String description
字段名:企业付款描述信息. 变量名:desc 是否必填:是 示例值:理赔 类型:String 描述:企业付款操作说明信息。必填。
String spbillCreateIp
字段名:Ip地址. 变量名:spbill_create_ip 是否必填:是 示例值:192.168.0.1 类型:String(32) 描述:调用接口的机器Ip地址
String wwMsgType
字段名: 付款消息类型 变量名: ww_msg_type 是否必填: 是 示例值:NORMAL_MSG 描述:NORMAL_MSG:普通付款消息 APPROVAL _MSG:审批付款消息
String approvalNumber
字段名: 审批单号 变量名: approval_number 是否必填: 否 示例值: 201705160008 描述:ww_msg_type为APPROVAL _MSG时,需要填写approval_number
Integer approvalType
字段名: 审批类型 变量名: approval_type 是否必填: 否 示例值: 1 描述:ww_msg_type为APPROVAL _MSG时,需要填写1
String actName
字段名: 项目名称 变量名: act_name 是否必填: 是 示例值: 产品部门报销 描述:项目名称,最长50个utf8字符
Integer agentId
字段名: 付款的应用id 变量名: agentid 是否必填: 否 示例值: 1 描述:以企业应用的名义付款,企业应用id,整型,可在企业微信管理端应用的设置页面查看。
String updateTime
* 字段名:修改时间 变量名:update_time 是否必填:否 类型:string[1,32] 描述: 修改时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35+08:00
String notifyUrl
* 字段名:通知URL地址 变量名:notify_url 是否必填:是 类型:string[10,256] 描述: 商户提供的用于接收商家券事件通知的url地址,必须支持https。 示例值:https://pay.weixin.qq.com
String mchid
* 字段名:商户号 变量名:mchid 是否必填:是 类型:string[8,15] 描述: 微信支付商户的商户号,由微信支付生成并下发。 示例值:10000098
String stockId
* 字段名:批次号 变量名:stock_id 是否必填:是 类型:string[1,20] 描述: path 微信为每个商家券批次分配的唯一ID 示例值:98065001
List<E> couponCodeList
* 字段名:券code列表 变量名:coupon_code_list 是否必填:否 类型:array 描述: body 商户上传的券code列表,code允许包含的字符有0-9、a-z、A-Z、-、_、\、/、=、|。 特殊规则:单个券code长度为【1,32】,条目个数限制为【1,200】。 示例值:ABC9588200,ABC9588201
String uploadRequestNo
* 字段名:请求业务单据号 变量名:upload_request_no 是否必填:是 类型:string[1,128] 描述: body 商户上传code的凭据号,商户侧需保持唯一性。 示例值:100002322019090134234sfdf
String stockId
* 字段名:批次号 变量名:stock_id 是否必填:是 类型:string[1,20] 描述: 微信为每个商家券批次分配的唯一ID。 示例值:98065001
Integer totalCount
* 字段名:去重后上传code总数 变量名:total_count 是否必填:是 类型:uint64 描述: 本次上传操作,去重后实际上传的code数目。 示例值:500
Integer successCount
* 字段名:上传成功code个数 变量名:success_count 是否必填:是 类型:uint64 描述: 本次上传操作上传成功个数。 示例值:20
List<E> successCodes
* 字段名:上传成功的code列表 变量名:success_codes 是否必填:否 类型:array 描述: 本次新增上传成功的code信息。 特殊规则:单个券code长度为【1,32】,条目个数限制为【1,200】。 示例值:MMAA12345
String successTime
* 字段名:上传成功时间 变量名:success_time 是否必填:是 类型:string[1,32] 描述: 上传操作完成时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35+08:00
Integer failCount
* 字段名:上传失败code个数 变量名:fail_count 是否必填:否 类型:uint64 描述: 本次上传操作上传失败的code数。 示例值:10
List<E> failCodes
* 字段名:+上传失败的code及原因 变量名:fail_codes 是否必填:否 类型:array 描述: 本次导入失败的code信息,请参照错误信息,修改后重试。
List<E> existCodes
* 字段名:已存在的code列表 变量名:exist_codes 是否必填:否 类型:array 描述: 历史已存在的code列表,本次不会重复导入。 特殊规则:单个券code长度为【1,32】,条目个数限制为【1,200】。 示例值:ABCD2345
List<E> duplicateCodes
* 字段名:本次请求中重复的code列表 变量名:duplicate_codes 是否必填:否 类型:array 描述: 本次重复导入的code会被自动过滤,仅保留一个做导入,如满足要求则成功;如不满足要求,则失败;请参照报错提示修改重试。 特殊规则:单个券code长度为【1,32】,条目个数限制为【1,200】。 示例值:AACC2345
String stockId
* 字段名:批次号 变量名:stock_id 是否必填:是 类型:string[1,20] 描述: body 微信为每个商家券批次分配的唯一ID,对于商户自定义code的批次,关联请求必须填写批次号 示例值:100088
String couponCode
* 字段名:券code 变量名:coupon_code 是否必填:是 类型:string[1,32] 描述: body 券的唯一标识 示例值:sxxe34343434
String outTradeNo
* 字段名:关联的商户订单号 变量名:out_trade_no 是否必填:是 类型:string[1,128] 描述: body 微信支付下单时的商户订单号,欲与该商家券关联的微信支付 示例值:MCH_102233445
String outRequestNo
* 字段名:商户请求单号 变量名:out_request_no 是否必填:是 类型:string[1,128] 描述: body 商户创建批次凭据号(格式:商户id+日期+流水号),商户侧需保持唯一性,可包含英文字母,数字,|,_,*,-等内容,不允许出现其他不合法符号。 示例值:1002600620019090123143254435
String wechatpayAssociateTime
* 字段名:关联成功时间 变量名:wechatpay_associate_time 是否必填:是 类型:string[1,32] 描述: 系统关联券成功的时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35+08:00
String wechatpayDisassociateTime
* 字段名:取消关联时间 变量名:wechatpay_associate_time 是否必填:是 类型:string[1,32] 描述: 系统成功取消商家券与订单信息关联关系的时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35+08:00
String couponCode
* 字段名:券code 变量名:coupon_code 是否必填:是 类型:string[1,32] 描述: body券的唯一标识 示例值:sxxe34343434
String stockId
* 字段名:批次号 变量名:stock_id 是否必填:是 类型:string[1,20] 描述: body券的所属批次号 示例值:1234567891
String deactivateRequestNo
* 字段名:失效请求单据号 变量名:deactivate_request_no 是否必填:是 类型:string[1, 128] 描述: body每次失效请求的唯一标识,商户需保证唯一 示例值:1002600620019090123143254436
String deactivateReason
* 字段名:失效原因 变量名:deactivate_reason 是否必填:否 类型:string[1, 64] 描述: body商户失效券的原因 示例值:此券使用时间设置错误
String wechatpayDeactivateTime
* 字段名:券成功失效的时间 变量名:wechatpay_deactivate_time 是否必填:是 类型:string[1,32] 描述: 系统券成功失效的时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2020-05-20T13:29:35.08:00
String couponCode
* 字段名:券code 变量名:coupon_code 是否必填:是 类型:string[1,20] 描述: body券的唯一标识 示例值:sxxe34343434
String stockId
* 字段名:批次号 变量名:stock_id 是否必填:是 类型:string[1,32] 描述: body券的所属批次号 示例值:1234567891
String returnRequestNo
* 字段名:退券请求单据号 变量名:return_request_no 是否必填:是 类型:string[1, 128] 描述: body每次退券请求的唯一标识,商户需保证唯一 示例值:1002600620019090123143254436
String wechatpayReturnTime
* 字段名:微信退券成功的时间 变量名:wechatpay_return_time 是否必填:是 类型:string[1,32] 描述: 微信退券成功的时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2020-05-20T13:29:35+08:00
String stockId
字段名:批次号 变量名:stock_id 是否必填:是 类型:string[1,20] 描述: 微信为每个商家券批次分配的唯一ID 示例值: 100088
String openid
字段名:用户标识 变量名:openid 是否必填:是 类型:string[1,128] 描述: 用户在公众号内的唯一身份标识。 示例值:dsadas34345454545
String wechatpayUseTime
字段名:系统核销券成功的时间 变量名:wechatpay_use_time 是否必填:是 类型:string[1,32] 描述: 系统成功核销券的时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35+08:00
String id
* 字段名:通知ID 变量名:id 是否必填:是 类型:string[1,36] 描述: 通知的唯一id。 示例值:8b33f79f-8869-5ae5-b41b-3c0b59f957d0
String createTime
* 字段名:通知创建时间 变量名:create_time 是否必填:是 类型:string[1,32] 描述: 通知创建的时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。 示例值:2019-12-12T16:54:38+08:00
String eventType
* 字段名:通知类型 变量名:event_type 是否必填:是 类型:string[1,32] 描述: 券的回调通知类型,枚举值: COUPON.SEND:领券 示例值:COUPON.SEND
String resourceType
* 字段名:通知数据类型 变量名:resource_type 是否必填:是 类型:string[1,32] 描述: 通知的资源数据类型,券的回调通知为encrypt-resource。 示例值:encrypt-resource
String summary
* 字段名:回调摘要 变量名:summary 是否必填:是 类型:string[1,64] 描述: 回调摘要 示例值:商家券领券通知
BusiFavorNotifyRequest.Resource resource
* 字段名:+通知数据 变量名:resource 是否必填:是 类型:object 描述: 通知资源数据。 json格式,见示例
String openid
* 字段名:用户标识 变量名:openid 是否必填:是 类型:string[1,128] 描述: path Openid信息,用户在appid下的唯一标识。 示例值:2323dfsdf342342
String appid
* 字段名:公众账号ID 变量名:appid 是否必填:是 类型:string[1,32] 描述: query 支持传入与当前调用接口商户号有绑定关系的appid。支持小程序appid与公众号appid。 示例值:wx233544546545989
String couponCode
* 字段名:券code 变量名:coupon_code 是否必填:是 类型:string[1,32] 描述: path 券的唯一标识。 示例值:123446565767
String belongMerchant
* 字段名:批次归属商户号 变量名:belong_merchant 是否必填:是 类型:string[8,15] 描述: 批次归属于哪个商户。 示例值:10000022
String stockName
* 字段名:商家券批次名称 变量名:stock_name 是否必填:是 类型:string[1,21] 描述: 批次名称,字数上限为21个,一个中文汉字/英文字母/数字均占用一个字数。 示例值:商家券
String comment
* 字段名:批次备注 变量名:comment 是否必填:否 类型:string[1,20] 描述: 仅配置商户可见,用于自定义信息。字数上限为20个,一个中文汉字/英文字母/数字均占用一个字数。 示例值:xxx可用
String goodsName
* 字段名:适用商品范围 变量名:goods_name 是否必填:是 类型:string[1,15] 描述: 适用商品范围,字数上限为15个,一个中文汉字/英文字母/数字均占用一个字数。 示例值:xxx商品可用
String stockType
* 字段名:批次类型 变量名:stock_type 是否必填:是 类型:string[1,128] 描述: 批次类型 NORMAL:固定面额满减券批次 DISCOUNT:折扣券批次 EXCHANGE:换购券批次 示例值:NORMAL
Boolean transferable
* 字段名:是否允许转赠 变量名:transferable 是否必填:否 类型:bool 描述: 不填默认否,枚举值: true:是 false:否 该字段暂未开放 示例值:false
Boolean shareable
* 字段名:是否允许分享领券链接 变量名:shareable 是否必填:否 类型:bool 描述: 不填默认否,枚举值: true:是 false:否 该字段暂未开放 示例值:false
String couponState
* 字段名:券状态 变量名:coupon_state 是否必填:否 类型:string[1,16] 描述: 商家券状态 枚举值: SENDED:可用 USED:已核销 EXPIRED:已过期 示例值:SENDED
DisplayPatternInfo displayPatternInfo
* 字段名:+样式信息 变量名:display_pattern_info 是否必填:否 类型:object 描述: 商家券详细信息
CouponUseRule couponUseRule
* 字段名:+券核销规则 变量名:coupon_use_rule 是否必填:是 类型:券核销规则 描述: 券核销相关规则
CustomEntrance customEntrance
* 字段名:+自定义入口 变量名:custom_entrance 是否必填:否 类型:object 描述: 卡详情页面,可选择多种入口引导用户。
String couponCode
* 字段名:券code 变量名:coupon_code 是否必填:否 类型:string[1,32] 描述: 券的唯一标识。 示例值:123446565767
String stockId
* 字段名:批次号 变量名:stock_id 是否必填:否 类型:string[1,20] 描述: 微信为每个商家券批次分配的唯一ID,是否指定批次号查询。 示例值:1002323
String availableStartTime
* 字段名:券可使用开始时间 变量名:available_start_time 是否必填:是 类型:string[1,32] 描述: 1、用户领取到该张券实际可使用的开始时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35+08:00
String expireTime
* 字段名:券过期时间 变量名:expire_time 是否必填:是 类型:string[1,32] 描述: 用户领取到该张券的过期时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35+08:00
String receiveTime
* 字段名:券领券时间 变量名:receive_time 是否必填:是 类型:string[1,32] 描述: 用户领取到该张券的时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35+08:00
String sendRequestNo
* 字段名:发券请求单号 变量名:send_request_no 是否必填:是 类型:string[1,32] 描述: 发券时传入的唯一凭证 示例值: MCHSEND202003101234
String useRequestNo
* 字段名:核销请求单号 变量名:use_request_no 是否必填:否 类型:string[1,32] 描述: 核销时传入的唯一凭证(如券已被核销,将返回此字段) 示例值: MCHUSE202003101234
String useTime
* 字段名:券核销时间 变量名:use_time 是否必填:否 类型:string[1,32] 描述: 券被核销的时间(如券已被核销,将返回此字段);遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35+08:00
String openid
* 字段名:用户标识 变量名:openid 是否必填:是 类型:string[1,128] 描述: path Openid信息,用户在appid下的唯一标识。 示例值:2323dfsdf342342
String appid
* 字段名:公众账号ID 变量名:appid 是否必填:是 类型:string[1,32] 描述: query 支持传入与当前调用接口商户号有绑定关系的appid。支持小程序appid与公众号appid。 示例值:wx233544546545989
String stockId
* 字段名:批次号 变量名:stock_id 是否必填:否 类型:string[1,20] 描述: query 微信为每个商家券批次分配的唯一ID,是否指定批次号查询。 示例值:9865000
String couponState
* 字段名:券状态 变量名:coupon_state 是否必填:否 类型:string[1,16] 描述: query 券状态 枚举值: SENDED:可用 USED:已核销 EXPIRED:已过期 示例值:SENDED
String creatorMerchant
* 字段名:创建批次的商户号 变量名:creator_merchant 是否必填:否 类型:string[1,32] 描述: query 批次创建方商户号 示例值:1000000001
String belongMerchant
* 字段名:批次归属商户号 变量名:belong_merchant 是否必填:否 类型:string[8,15] 描述: query 批次归属商户号 示例值:1000000002
String senderMerchant
* 字段名:批次发放商户号 变量名:sender_merchant 是否必填:否 类型:string[1,32] 描述: query 批次发放商户号 示例值:1000000003
Integer offset
* 字段名:分页页码 变量名:offset 是否必填:否 类型:int 描述: query 分页页码 示例值:0
Integer limit
* 字段名:分页大小 变量名:limit 是否必填:否 类型:int 描述: query 分页大小 示例值:20
String stockId
* 字段名:批次号 变量名:stock_id 是否必填:是 类型:string[1,20] 描述: path批次号 示例值:98065001
Integer targetMaxCoupons
* 字段名:目标批次最大发放个数 变量名:target_max_coupons 是否必填:二选一 类型:int 描述: body批次最大发放个数 示例值:3000
Integer targetMaxCouponsByDay
* 字段名:目标单天发放上限个数 变量名:target_max_coupons 是否必填:二选一 类型:int 描述: body 目标单天发放上限个数 示例值:3000
Integer currentMaxCoupons
* 字段名:当前批次最大发放个数 变量名:current_max_coupons 是否必填:否 类型:int 描述: body当前批次最大发放个数,当传入target_max_coupons大于0时,current_max_coupons必传 示例值:500
Integer currentMaxCouponsByDay
* 字段名:当前单天发放上限个数 变量名:current_max_coupons_by_day 是否必填:否 类型:int 描述: body当前单天发放上限个数 ,当传入target_max_coupons_by_day大于0时,current_max_coupons_by_day必填 示例值:300
String modifyBudgetRequestNo
* 字段名:修改预算请求单据号 变量名:modify_budget_request_no 是否必填:是 类型:string[1,128] 描述: body修改预算请求单据号 示例值:1002600620019090123143254436
String stockName
字段名:批次名称 变量名:stock_name 是否必填:是 类型:string[1,21] 描述: 批次名称 校验规则: 1、批次名称最多9个中文汉字 2、批次名称最多20个字母 3、批次名称中不能包含不当内容和特殊字符 _ , ; | 示例值:微信支付代金券批次
String belongMerchant
字段名:归属商户号 变量名:belong_merchant 是否必填:是 类型:string[8,15] 描述: 批次归属商户号 该字段暂未开放 示例值:98568865
String comment
字段名:批次备注 变量名:comment 是否必填:否 类型:string[1,20] 描述: 仅制券商户可见,用于自定义信息。 校验规则:批次备注最多60个UTF8字符数 示例值:零售批次
String goodsName
字段名:适用商品范围 变量名:goods_name 是否必填:是 类型:string[1,15] 描述: 用来描述批次在哪些商品可用,会显示在微信卡包中。字数上限为15个,一个中文汉字/英文字母/数字均占用一个字数。 示例值:xxx商品使用
StockTypeEnum stockType
字段名:批次类型 变量名:stock_type 是否必填:是 类型:string[1,32] 描述: 批次类型 NORMAL:固定面额满减券批次 DISCOUNT:折扣券批次 EXCHANGE:换购券批次 示例值:NORMAL
CouponUseRule couponUseRule
字段名:核销规则 变量名:coupon_use_rule 是否必填:是 类型:object 描述:核销规则
StockSendRule stockSendRule
字段名:券发放相关规则 变量名:stock_send_rule 是否必填:是 类型:object 描述:券发放相关规则
String outRequestNo
字段名:商户单据号 变量名:out_request_no 是否必填:是 类型:string[1,128] 描述: 商户创建批次凭据号(格式:商户id+日期+流水号),可包含英文字母,数字,|,_,*,-等内容,不允许出现其他不合法符号,商户侧需保持商户单据号全局唯一。
CustomEntrance customEntrance
字段名:自定义入口 变量名:custom_entrance 是否必填:否 类型:object 描述:卡详情页面,可选择多种入口引导用户。
DisplayPatternInfo displayPatternInfo
字段名:样式信息 变量名:display_pattern_info 是否必填:否 类型:object 描述:创建批次时的样式信息。
String couponCodeMode
字段名:券code模式 变量名:coupon_code_mode 是否必填:是 类型:string[1,128] 描述:枚举值: WECHATPAY_MODE:系统分配券code。(固定22位纯数字) MERCHANT_API:商户发放时接口指定券code。 MERCHANT_UPLOAD:商户上传自定义code,发券时系统随机选取上传的券code。
NotifyConfig notifyConfig
字段名:事件通知配置 变量名:notify_config 是否必填:否 类型:object 描述:事件回调通知商户的配置
String stockId
字段名:批次号 变量名:stock_id 是否必填:是 类型:string[1,20] 描述: 微信为每个商家券批次分配的唯一ID 示例值: 98065001
String createTime
字段名:创建时间 变量名:create_time 是否必填:是 类型:string[1,32] 描述: 遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35+08:00
Integer totalSendNum
字段名:已发放券张数 变量名:total_send_num 是否必填:否 类型:uint64 描述: 批次已发放的券数量,满减、折扣、换购类型会返回该字段 示例值:1
Integer totalSendAmount
字段名:已发放券金额 变量名:total_send_amount 是否必填:否 类型:uint64 描述: 批次已发放的预算金额,满减券类型会返回该字段 示例值:34
String todaySendNum
字段名:单天已发放券张数 变量名:today_send_num 是否必填:否 类型:uint64 描述: 批次当天已发放的券数量,设置了单天发放上限的满减、折扣、换购类型返回该字段 示例值:1
String todaySendAmount
字段名:单天已发放券金额 变量名:today_send_amount 是否必填:否 类型:uint64 描述: 批次当天已发放的预算金额,设置了当天发放上限的满减券类型返回该字段 示例值:34
Integer totalSendNum
字段名:已发放券张数 变量名:total_send_num 是否必填:否 类型:uint64 描述: 批次已发放的券数量,满减、折扣、换购类型会返回该字段 示例值:1
Integer totalSendAmount
字段名:已发放券金额 变量名:total_send_amount 是否必填:否 类型:uint64 描述: 批次已发放的预算金额,满减券类型会返回该字段 示例值:34
String todaySendNum
字段名:单天已发放券张数 变量名:today_send_num 是否必填:否 类型:uint64 描述: 批次当天已发放的券数量,设置了单天发放上限的满减、折扣、换购类型返回该字段 示例值:1
String todaySendAmount
字段名:单天已发放券金额 变量名:today_send_amount 是否必填:否 类型:uint64 描述: 批次当天已发放的预算金额,设置了当天发放上限的满减券类型返回该字段 示例值:34
String stockId
* 字段名:商家券批次号 变量名:stock_id 是否必填:是 类型:string[1, 20] 描述: body由微信支付生成,调用创建商家券API成功时返回的唯一批次ID 仅支持“满减券”和“折扣券”的批次,“换购券”批次不支持 示例值:128888000000001
String couponCode
* 字段名:商家券Code 变量名:coupon_code 是否必填:是 类型:string[1, 128] 描述: body券的唯一标识。 在WECHATPAY_MODE的券Code模式下,商家券Code是由微信支付生成的唯一ID; 在MERCHANT_UPLOAD、MERCHANT_API的券Code模式下,商家券Code是由商户上传或指定,在批次下保证唯一; 示例值:ABCD12345678
String transactionId
* 字段名:微信支付订单号 变量名:transaction_id 是否必填:是 类型:string[28, 32] 描述: body微信支付下单支付成功返回的订单号 示例值:4200000913202101152566792388
String payerMerchant
* 字段名:营销补差扣款商户号 变量名:payer_merchant 是否必填:是 类型:string[1, 32] 描述: body营销补差扣款商户号 示例值:1900000001
String payeeMerchant
* 字段名:营销补差入账商户号 变量名:payee_merchant 是否必填:是 类型:string[1, 32] 描述: body营销补差入账商户号 示例值:1900000002
Integer amount
* 字段名:补差付款金额 变量名:amount 是否必填:是 类型:int 描述: body单位为分,单笔订单补差金额不得超过券的优惠金额,最高补差金额为5000元 > 券的优惠金额定义: 满减券:满减金额即为优惠金额 折扣券:优惠金额 = 微信支付订单金额 ÷ 折扣比例 × (1 - 折扣比例) 换购券:不支持 示例值:100
String description
* 字段名:补差付款描述 变量名:description 是否必填:是 类型:string[1, 1024] 描述: body付款备注描述,查询的时候原样带回 示例值:20210115DESCRIPTION
String outSubsidyNo
* 字段名:业务请求唯一单号 变量名:out_subsidy_no 是否必填:是 类型:string[1, 128] 描述: body商户侧需保证唯一性。可包含英文字母,数字,|,_,*,-等内容,不允许出现其他不合法符号 示例值:subsidy-abcd-12345678
String subsidyReceiptId
* 字段名:补差付款单号 变量名:subsidy_receipt_id 是否必填:是 类型:string[28, 32] 描述: 补差付款唯一单号,由微信支付生成,仅在补差付款成功后有返回 示例值:1120200119165100000000000001
String stockId
* 字段名:商家券批次号 变量名:stock_id 是否必填:是 类型:string[1, 20] 描述: 由微信支付生成,调用创建商家券API成功时返回的唯一批次ID 示例值:128888000000001
String couponCode
* 字段名:商家券Code 变量名:coupon_code 是否必填:是 类型:string[1, 128] 描述: 券的唯一标识 示例值:ABCD12345678
String transactionId
* 字段名:微信支付订单号 变量名:transaction_id 是否必填:是 类型:string[28, 32] 描述: 微信支付下单支付成功返回的订单号 示例值:4200000913202101152566792388
String payerMerchant
* 字段名:营销补差扣款商户号 变量名:payer_merchant 是否必填:是 类型:string[1, 32] 描述: 营销补差扣款商户号 示例值:1900000001
String payeeMerchant
* 字段名:营销补差入账商户号 变量名:payee_merchant 是否必填:是 类型:string[1, 32] 描述: 营销补差入账商户号 示例值:1900000002
Integer amount
* 字段名:补差付款金额 变量名:amount 是否必填:是 类型:int 描述: 单位为分,单笔订单补差金额不得超过券的优惠金额,最高补差金额为5000元 > 券的优惠金额定义: 满减券:满减金额即为优惠金额 折扣券:优惠金额 = 微信支付订单金额 ÷ 折扣比例 × (1 - 折扣比例) 换购券:不支持 示例值:100
String description
* 字段名:补差付款描述 变量名:description 是否必填:是 类型:string[1, 1024] 描述: 付款备注描述,查询的时候原样带回 示例值:20210115DESCRIPTION
String status
* 字段名:补差付款单据状态 变量名:status 是否必填:是 类型:string[1, 32] 描述: 补差付款单据状态 ACCEPTED:受理成功 SUCCESS:补差补款成功 FAIL:补差付款失败 RETURNING:补差回退中 PARTIAL_RETURN:补差部分回退 FULL_RETURN:补差全额回退 示例值:SUCCESS
String failReason
* 字段名:补差付款失败原因 变量名:fail_reason 是否必填:否 类型:string[1, 1024] 描述: 仅在补差付款失败时,返回告知对应失败的原因 INSUFFICIENT_BALANCE:扣款商户余额不足 NOT_INCOMESPLIT_ORDER:非分账订单 EXCEED_SUBSIDY_AMOUNT_QUOTA:超出订单补差总额限制 EXCEED_SUBSIDY_COUNT_QUOTA:超出订单补差总数限制 OTHER:其他原因 示例值:INSUFFICIENT_BALANCE
String successTime
* 字段名:补差付款完成时间 变量名:success_time 是否必填:否 类型:string[28, 32] 描述: 仅在补差付款成功时,返回完成时间。遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2021-01-20T10:29:35+08:00
String outSubsidyNo
* 字段名:业务请求唯一单号 变量名:out_subsidy_no 是否必填:是 类型:string[1, 128] 描述: 商户侧需保证唯一性。可包含英文字母,数字,|,_,*,-等内容,不允许出现其他不合法符号 示例值:subsidy-abcd-12345678
String createTime
* 字段名:补差付款发起时间 变量名:create_time 是否必填:否 类型:string[28, 32] 描述: 补差付款单据创建时间。遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2021-01-20T10:29:35+08:00
String mchid
字段名:商户号 变量名:mchid 是否必填:是 类型:string[1,20] 描述: 微信支付商户号。 示例值:9856888
String notifyUrl
字段名:通知url地址 变量名:notify_url 是否必填:是 类型:string[1,256] 描述: 支付通知商户url地址。 示例值:https://pay.weixin.qq.com
Boolean switchBool
字段名:回调开关 变量名:switch 是否必填:否 类型:bool 描述: 如果商户不需要再接收营销事件通知,可通过该开关关闭。枚举值: true:开启推送 false:停止推送 示例值:true
String updateTime
修改时间,遵循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年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35.120+08:00
String notifyUrl
通知地址 示例值:api.weixin.qq.com
String stockId
字段名:批次号 变量名:stock_id 是否必填:是 类型:string[1,20] 描述: 微信为每个批次分配的唯一id。 校验规则:必须为代金券(全场券或单品券)批次号,不支持立减与折扣。 示例值:9856000
String outRequestNo
字段名:商户单据号 变量名:out_request_no 是否必填:是 类型:string[1,128] 描述: 商户此次发放凭据号(格式:商户id+日期+流水号),可包含英文字母,数字,|,_,*,-等内容,不允许出现其他不合法符号,商户侧需保持唯一性。 示例值: 89560002019101000121
String appid
字段名:公众账号ID 变量名:appid 是否必填:是 类型:string[1,128] 描述: 微信为发券方商户分配的公众账号ID,接口传入的所有appid应该为公众号的appid或者小程序的appid(在mp.weixin.qq.com申请的),不能为APP的appid(在open.weixin.qq.com申请的)。。 校验规则: 1、该appid需要与接口传入中的openid有对应关系; 2、该appid需要与调用接口的商户号(即请求头中的商户号)有绑定关系,若未绑定,可参考该指引完成绑定(商家商户号与AppID账号关联管理) 示例值:wx233544546545989
String stockCreatorMchid
字段名:创建批次的商户号 变量名:stock_creator_mchid 是否必填:是 类型:string[1,20] 描述: 批次创建方商户号。 示例值:8956000
Integer couponValue
字段名:指定面额发券,面额 变量名:coupon_value 是否必填:否 类型:uint64 描述: 指定面额发券场景,券面额,其他场景不需要填,单位:分。 校验规则:仅在发券时指定面额及门槛的场景才生效,常规发券场景请勿传入该信息。 示例值:100
Integer couponMinimum
字段名:指定面额发券,券门槛 变量名:coupon_minimum 是否必填:是 类型:uint64 描述: 指定面额发券批次门槛,其他场景不需要,单位:分。 校验规则:仅在发券时指定面额及门槛的场景才生效,常规发券场景请勿传入该信息。 示例值:100
String couponId
发放给用户的代金券id。 示例值:9867041
String stockCreatorMchid
批次创建方商户号 示例值:9800064
String stockId
微信为每个代金券批次分配的唯一id。 示例值:9865888
String couponId
微信为代金券唯一分配的id。 示例值:98674556
FavorCouponsGetResult.CutToMessage cutToMessage
单品优惠特定信息
String couponName
代金券名称 示例值:微信支付代金券
String status
代金券状态: SENDED:可用 USED:已实扣 EXPIRED:已过期 示例值:EXPIRED
String description
代金券描述说明字段。 示例值:微信支付营销
String createTime
领券时间,遵循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年5月20日 13点29分35秒。 示例值: 2015-05-20T13:29:35.120+08:00
String couponType
券类型: NORMAL:满减券 CUT_TO:减至券 示例值:CUT_TO
Boolean noCash
枚举值: true:是 false:否 示例值:true
String availableBeginTime
可用开始时间,遵循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年5月20日 13点29分35秒。 示例值: 2015-05-20T13:29:35.120+08:00
String availableEndTime
可用结束时间,遵循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年5月20日 13点29分35秒。 示例值: 2015-05-20T13:29:35.120+08:00
Boolean singleitem
枚举值: true:是 false:否 示例值:true
String outRequestNo
商户此次发放凭据号(格式:商户id+日期+流水号),可包含英文字母,数字,|,_,*,-等内容,不允许出现其他不合法符号,商户侧需保持唯一性。 示例值: 89560002019101000121
FavorCouponsGetResult.NormalCouponInformation normalCouponInformation
普通满减券面额、门槛信息。
String openid
字段名:用户标识 变量名:openid 是否必填:是 类型:string[1,128] 描述: 用户在商户appid 下的唯一标识。 示例值:2323dfsdf342342
String appid
字段名:公众账号ID 变量名:appid 是否必填:是 类型:string[1,128] 描述: 微信为发券方商户分配的公众账号ID,接口传入的所有appid应该为公众号的appid(在mp.weixin.qq.com申请的),不能为APP的appid(在open.weixin.qq.com申请的)。 示例值:wx233544546545989
String stockId
字段名:批次号 变量名:stock_id 是否必填:否 类型:string[1,20] 描述: 批次号,是否指定批次号查询,填写available_mchid,该字段不生效。 示例值:9865000
String status
字段名:券状态 变量名:status 是否必填:否 类型:string[1,6] 描述: 代金券状态: SENDED:可用 USED:已实扣 填写available_mchid,该字段不生效。 示例值:USED
String creatorMchid
字段名:创建批次的商户号 变量名:creator_mchid 是否必填:否 类型:string[1,20] 描述: 批次创建方商户号。 示例值:9865002
String senderMchid
字段名:批次发放商户号 变量名:sender_mchid 是否必填:否 类型:string[1,20] 描述: 批次创建方商户号。 示例值:9865002
String availableMchid
字段名:可用商户号 变量名:available_mchid 是否必填:否 类型:string[1,20] 描述: 批次创建方商户号。 示例值:9865002
Integer offset
字段名:分页页码 变量名:offset 是否必填:是 类型:uint32 描述: 页码从0开始,默认第0页。 示例值:1
Integer limit
字段名:分页大小 变量名:limit 是否必填:是 类型:uint32 描述: 分页大小,最大10。 示例值:8
String stockCreatorMchid
批次创建方商户号 示例值:9800064
String stockId
微信为每个代金券批次分配的唯一id。 示例值:9865888
String couponId
微信为代金券唯一分配的id。 示例值:98674556
FavorCouponsUseResult.SingleitemDiscountOff singleitemDiscountOff
单品优惠特定信息。
FavorCouponsUseResult.DiscountTo discountTo
减至优惠限定字段,仅减至优惠场景有返回。
String couponName
代金券名称 示例值:微信支付代金券
String status
代金券状态: SENDED:可用 USED:已实扣 EXPIRED:已过期 示例值:EXPIRED
String description
代金券描述说明字段。 示例值:微信支付营销
String createTime
领券时间,遵循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年5月20日 13点29分35秒。 示例值: 2015-05-20T13:29:35.120+08:00
String couponType
券类型: NORMAL:满减券 CUT_TO:减至券 示例值:CUT_TO
Boolean noCash
枚举值: true:是 false:否 示例值:true
String availableBeginTime
可用开始时间,遵循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年5月20日 13点29分35秒。 示例值: 2015-05-20T13:29:35.120+08:00
String availableEndTime
可用结束时间,遵循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年5月20日 13点29分35秒。 示例值: 2015-05-20T13:29:35.120+08:00
Boolean singleitem
枚举值: true:是 false:否 示例值:true
FavorCouponsUseResult.NormalCouponInformation normalCouponInformation
普通满减券面额、门槛信息。
FavorCouponsUseResult.ConsumeInformation consumeInformation
普通满减券面额、门槛信息。
String consumeTime
代金券核销时间,遵循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年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35.120+08:00
String consumeMchid
核销代金券的商户号。 示例值:9856081
String transactionId
核销订单号 示例值:2345234523
List<E> goodsDetail
商户下单接口传的单品信息。
Long singlePriceMax
单品最高优惠价格,单位:分。 示例值:100
String stockName
字段名:批次名称 变量名:stock_name 是否必填:是 类型:string[1,20] 描述: 批次名称 校验规则: 1、批次名称最多9个中文汉字 2、批次名称最多20个字母 3、批次名称中不能包含不当内容和特殊字符 _ , ; | 示例值:微信支付代金券批次
String comment
字段名:批次备注 变量名:comment 是否必填:否 类型:string[1,60] 描述: 仅制券商户可见,用于自定义信息。 校验规则:批次备注最多60个UTF8字符数 示例值:零售批次
String belongMerchant
字段名:归属商户号 变量名:belong_merchant 是否必填:是 类型:string[1,20] 描述: 批次归属商户号 该字段暂未开放 示例值:98568865
String availableBeginTime
字段名:可用时间-开始时间 变量名:available_begin_time 是否必填:是 类型:string[1,32] 描述: 批次开始时间,遵循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年5月20日 13点29分35秒。 校验规则: 1、开始时间不可早于当前时间 2、不能创建365天后开始的批次 示例值:2015-05-20T13:29:35.120+08:00
String availableEndTime
字段名:可用时间-结束时间 变量名:available_end_time 是否必填:是 类型:string[1,32] 描述: 批次结束时间,遵循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年5月20日 13点29分35秒。 校验规则: 1、结束时间需晚于开始时间 2、可用时间最长为90天 3、有效时间间隔最短为1s 示例值:2015-05-20T13:29:35.120+08:00
FavorStocksCreateRequest.StockUseRule stockUseRule
字段名:发放规则 变量名:stock_use_rule 是否必填:是 类型:object 描述:批次使用规则
FavorStocksCreateRequest.PatternInfo patternInfo
字段名:样式设置 变量名:pattern_info 是否必填:否 类型:object 描述:代金券详情页
FavorStocksCreateRequest.CouponUseRule couponUseRule
字段名:核销规则 变量名:coupon_use_rule 是否必填:是 类型:object 描述:核销规则
Boolean noCash
字段名:营销经费 变量名:no_cash 是否必填:是 类型:bool 描述: 营销经费。枚举值: true:免充值 false:预充值 1、免充值:制券方无需提前充值资金,用户核销代金券时,直接从订单原价中扣除优惠减价金额,最终只将用户实际支付的金额结算给核销商户,商户实收少于订单原价。 2、预充值:制券方需将优惠预算提前充值到微信支付商户可用余额中,用户核销代金券时,系统从制券方商户可用余额中扣除优惠减价部分对应的资金,连同用户实际支付的资金,一并结算给核销商户,不影响实收。 示例值:false
StockTypeEnum stockType
字段名:批次类型 变量名:stock_type 是否必填:是 类型:string[1,16] 描述: 批次类型,仅支持: NORMAL:固定面额满减券批次 示例值:NORMAL
String outRequestNo
字段名:商户单据号 变量名:out_request_no 是否必填:是 类型:string[1,128] 描述: 商户创建批次凭据号(格式:商户id+日期+流水号),可包含英文字母,数字,|,_,*,-等内容,不允许出现其他不合法符号,商户侧需保持商户单据号全局唯一。
String extInfo
字段名:扩展属性 变量名:ext_info 是否必填:否 类型:string[1,128] 描述: 扩展属性字段,按json格式,如无需要则不填写。 示例值:{'exinfo1':'1234','exinfo2':'3456'}
FavorStocksCreateRequest.FixedNormalCoupon fixedNormalCoupon
字段名:固定面额满减券使用规则 变量名:fixed_normal_coupon 是否必填:否 类型:object 描述: stock_type为NORMAL时必填。
List<E> goodsTag
字段名:订单优惠标记 变量名:goods_tag 是否必填:否 类型:array 描述: 订单优惠标记,按json格式。 商户下单时需要传入相同的标记(goods_tag),用户同时符合其他规则才能享受优惠 校验规则: 1、最多允许录入50个 2、每个订单优惠标记支持字母/数字/下划线,不超过128个UTF8字符。 示例值:["123321","456654"]
List<E> limitPay
字段名:指定付款方式 变量名:limit_pay 是否必填:否 类型:array[1,1] 描述: 指定付款方式的交易可核销/使用代金券,可指定零钱付款、指定银行卡付款,需填入支付方式编码, 不在此列表中的银行卡,暂不支持此功能。 校验规则:条目个数限制为【1,1】。 示例值:ICBC_CREDIT
FavorStocksCreateRequest.LimitCard limitCard
字段名:指定银行卡BIN 变量名:limit_card 是否必填:否 类型:object 描述: 指定银行卡bin付款的交易可核销/使用代金券,当批次限定了指定银行卡时方可生效
List<E> tradeType
字段名:支付方式 变量名:trade_type 是否必填:否 类型:array 描述: 允许指定支付方式的交易才可核销/使用代金券,不填则默认“不限”。 枚举值: MICROAPP:小程序支付 APPPAY:APP支付 PPAY:免密支付 CARD:刷卡支付 FACE:人脸支付 OTHER:其他支付 示例值:["MICROAPP","APPPAY"]
Boolean combineUse
字段名:是否可叠加其他优惠 变量名:combine_use 是否必填:否 类型:bool 描述: 允许指定本优惠是否可以和本商户号创建的其他券同时使用,不填则默认允许同时使用。枚举值: true:是 false:否 示例值:false
List<E> availableItems
字段名:可核销商品编码 变量名:available_items 是否必填:否 类型:array 描述: 包含指定SKU商品编码的交易才可核销/使用代金券:活动商户在交易下单时,需传入用户购买的所有SKU商品编码,当命中代金券中设置的商品编码时可享受优惠。 校验规则: 1、单个商品编码的字符长度为【1,128】 2、条目个数限制为【1,50】 示例值:['123321','456654']
List<E> availableMerchants
字段名:可用商户号 变量名:available_merchants 是否必填:是 类型:array 描述: 可用商户的交易才可核销/使用代金券。当营销经费no_cash=false时,可用商户允许填入任何类型的特约商户或普通商户 当营销经费no_cash=ture时,分为以下几种情况: 1、创建商户是普通商户或服务商特约商户(子商户):可添加本商户号或同品牌商户。 说明:若可用商户中,有特约商户(子商户),那么特约商户自己发起的交易、以及服务商帮特约商户发起的交易,都可以使用代金券。 2、创建商户是普通服务商:可添加已授权的子商户,详见《申请免充值代金券产品权限》。 说明:特约商户如果有多个服务商,那么服务商为他发起的交易,只要完成了免充值授权,都可以使用代金券;特约商户自己发起的交易不可以使用代金券。 3、创建商户是渠道商、银行服务商或从业机构:可直接添加旗下任意子商户,不需要子商户授权。 示例值:['9856000','9856111']
Integer couponAmount
字段名:面额 变量名:fixed_normal_coupon 是否必填:是 类型:uint64 描述: 面额,单位:分。 校验规则: 1、必须为整数 2、必须大于1分且小于等于1000元 示例值:100
Integer transactionMinimum
字段名:门槛 变量名:transaction_minimum 是否必填:是 类型:uint64 描述: 使用券金额门槛,单位:分。 若指定可核销商品编码,门槛则为可核销商品部分的消费金额,而不是订单的消费金额。 校验规则:使用门槛必须大于优惠金额 示例值:100
String description
字段名:使用说明 变量名:description 是否必填:是 类型:string[1,3000] 描述: 用于说明详细的活动规则,会展示在代金券详情页。 校验规则:最多1000个UTF8字符 示例值:微信支付营销代金券
String merchantLogo
字段名:商户logo 变量名:merchant_logo 是否必填:否 类型:string[1,128] 描述: 商户logo ,仅支持通过《图片上传API》接口获取的图片URL地址。 1、商户logo大小需为120像素*120像素。 2、支持JPG/JPEG/PNG格式,且图片小于1M。 3、最多128个UTF8字符 示例值:https://qpic.cn/xxx
String merchantName
字段名:品牌名称 变量名:merchant_name 是否必填:否 类型:string[1,128] 描述: 品牌名称,展示在用户卡包 校验规则: 1、最多12个中文汉字 2、最多36个英文字符 示例值:微信支付
BackgroundColorEnum backgroundColor
字段名:背景颜色 变量名:background_color 是否必填:否 类型:string[1,15] 描述: 券的背景颜色,可设置10种颜色,色值请参考卡券背景颜色图。颜色取值为颜色图中的颜色名称。可选枚举字段不用则不传,不可以传空值 示例值:COLOR020
String couponImage
字段名:券详情图片 变量名:coupon_image 是否必填:是 类型:string[1,128] 描述: 券详情图片, 850像素*350像素,且图片大小不超过2M,支持JPG/PNG格式,仅支持通过《图片上传API》接口获取的图片URL地址。。 示例值:https://qpic.cn/xxx
Integer maxCoupons
字段名:发放总上限 变量名:max_coupons 是否必填:是 类型:uint64 描述: 最大发券数 校验规则: 1、发放总个数最少5个 2、发放总个数最多1000万个 示例值:100
Integer maxAmount
字段名:总预算 变量名:max_amount 是否必填:是 类型:uint64 描述: 最大发券预算,当营销经费no_cash选择预充值false时,激活批次时会从制券商户的余额中扣除预算,请保证账户金额充足,单位:分 max_amount需要等于coupon_amount(面额) * max_coupons(发放总上限) 校验规则:批次总预算最多1亿元 示例值:5000
Integer maxAmountByDay
字段名:单天预算发放上限 变量名:max_amount_by_day 是否必填:否 类型:uint64 描述: 设置此字段,允许指定单天最大发券预算,单位:分。 校验规则:不能大于总预算 示例值:400
Integer maxCouponsPerUser
字段名:单个用户可领个数 变量名:max_coupons_per_user 是否必填:是 类型:uint32 描述: 活动期间每个用户可领个数,当开启了自然人限领时,多个微信号同属于一个身份证时,视为同一用户。 校验规则: 1、不能大于发放总个数 2、最少为1个,最多为60个 示例值:3
Boolean naturalPersonLimit
字段名:是否开启自然人限制 变量名:natural_person_limit 是否必填:是 类型:bool 描述: 当开启了自然人限领时,多个微信号同属于一个身份证时,视为同一用户,枚举值 true:是 false:否 示例值:false
Boolean preventApiAbuse
字段名:是否开启防刷拦截 变量名:prevent_api_abuse 是否必填:是 类型:bool 描述: 若开启防刷拦截,当用户命中恶意、小号、机器、羊毛党、黑产等风险行为时,无法成功发放代金券。 枚举值 true:是 false:否 示例值:false
String stockId
微信为每个代金券批次分配的唯一ID。 示例值:98065001
String stockId
微信为每个代金券批次分配的唯一id。 示例值:9836588
String stockCreatorMchId
批次创建方商户号。 示例值:123456
String stockName
批次名称 示例值:微信支付批次
String status
批次状态 枚举值: unactivated:未激活 audit:审核中 running:运行中 stoped:已停止 paused:暂停发放 示例值:paused
String createTime
批次创建时间,遵循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年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35.120+08:00
String description
批次描述信息 示例值:微信支付营销
FavorStocksGetResult.StockUseRule stockUseRule
普通发券批次特定信息。 示例值:1900000109
String availableBeginTime
可用开始时间,遵循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年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35.120+08:00
String availableEndTime
可用结束时间,遵循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年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35.120+08:00
Long distributedCoupons
已发券数量 示例值:100
Boolean noCash
是否无资金流。 ture:是 false:否 示例值:true
String startTime
批次激活开启时间,遵循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年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35.120+08:00
String stopTime
批次永久停止时间,遵循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年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35.120+08:00
FavorStocksGetResult.CutToMessage cutToMessage
单品优惠特定信息
Boolean singleItem
枚举值: true:是 false:否 示例值:true
String stockType
批次类型, 枚举值: NORMAL:代金券批次 DISCOUNT_CUT:立减与折扣 OTHER:其他 示例值:NORMAL
Long maxCoupons
最大发券数 示例值:100
Long maxAmount
总消耗金额,单位:分。 示例值:5000
Long maxAmountByDay
单天最高消耗金额,单位:分。 示例值:400
FavorStocksGetResult.FixedNormalCoupon fixedNormalCoupon
固定面额发券批次特定信息。
Long maxCouponsPerUser
单个用户可领个数,每个用户最多100张券 示例值:3
String couponType
枚举值: NORMAL:满减券 CUT_TO:减至券 示例值:NORMAL
List<E> goodsTag
订单优惠标记 特殊规则:单个优惠标记的字符长度为【1,128】,条目个数限制为【1,50】。 示例值:{'123456','23456'}
List<E> tradeType
默认不限制 枚举值: MICROAPP:小程序支付 APPPAY:APP支付 PPAY:免密支付 CARD:付款码支付 FACE:人脸支付 OTHER:(公众号、扫码等) 示例值:MICROAPP
Boolean combineUse
枚举值: true:是 false:否 示例值:true
String pauseTime
生效时间,遵循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年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35.120+08:00
String stockId
微信为每个代金券批次分配的唯一ID。 示例值:98065001
Integer offset
字段名:分页页码 变量名:offset 是否必填:是 类型:uint32 描述: 页码从0开始,默认第0页。 示例值:1
Integer limit
字段名:分页大小 变量名:limit 是否必填:是 类型:uint32 描述: 分页大小,最大10。 示例值:8
String stockCreatorMchid
字段名:创建批次的商户号 变量名:stock_creator_mchid 是否必填:是 类型:string[1,20] 描述: 批次创建方商户号。 示例值:9856888
String createStartTime
字段名:起始时间 变量名:create_start_time 是否必填:否 类型:string[1,64] 描述: 起始创建时间,起始创建时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 校验规则:get请求,参数在 url中,需要进行 url 编码传递 示例值:2015-05-20T13:29:35+08:00
String createEndTime
字段名:终止时间 变量名:create_end_time 是否必填:否 类型:string[1,64] 描述: 终止创建时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 校验规则:get请求,参数在 url中,需要进行 url 编码传递 示例值:2015-05-20T13:29:35+08:00
String status
字段名:批次状态 变量名:status 是否必填:否 类型:string[1,20] 描述: 批次状态,枚举值: unactivated:未激活 audit:审核中 running:运行中 stoped:已停止 paused:暂停发放
String restartTime
生效时间,遵循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年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35.120+08:00
String stockId
微信为每个代金券批次分配的唯一ID。 示例值:98065001
String stockCreatorMchid
字段名:创建批次的商户号 变量名:stock_creator_mchid 是否必填:是 类型:string[1,20] 描述: 批次创建方商户号。 示例值:8956000
String startTime
生效时间,遵循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年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35.120+08:00
String stockId
微信为每个代金券批次分配的唯一ID。 示例值:98065001
Integer[] weekDay
字段名:可用星期数 变量名:week_day 是否必填:否 类型:array[int] 描述: 0代表周日,1代表周一,以此类推 当填写available_day_time时,week_day必填 示例值:1, 2
AvailableWeek.AvailableDayTime availableDayTime
字段名:当天可用时间段 变量名:available_day_time 是否必填:否 类型:array 描述: 可以填写多个时间段,最多不超过2个。
String availableBeginTime
字段名:开始时间 变量名:available_begin_time 是否必填:是 类型:string[1,32] 描述: 批次开始时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 注意:开始时间设置有效期最长为1年。 示例值:2015-05-20T13:29:35+08:00
String availableEndTime
字段名:结束时间 变量名:available_end_time 是否必填:是 类型:string[1,32] 描述: 批次结束时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 注意:结束时间设置有效期最长为1年。 示例值:2015-05-20T13:29:35+08:00
Integer availableDayAfterReceive
字段名:生效后N天内有效 变量名:available_day_after_receive 是否必填:否 类型:int 描述: 日期区间内,券生效后x天内有效。例如生效当天内有效填1,生效后2天内有效填2,以此类推……注意,用户在有效期开始前领取商家券,则从有效期第1天开始计算天数,用户在有效期内领取商家券,则从领取当天开始计算天数,无论用户何时领取商家券,商家券在活动有效期结束后均不可用。可配合wait_days_after_receive一同填写,也可单独填写。单独填写时,有效期内领券后立即生效,生效后x天内有效。 示例值:3
AvailableWeek availableWeek
字段名:固定周期有效时间段 变量名:available_week 是否必填:否 类型:object 描述: 可以设置多个星期下的多个可用时间段,比如每周二10点到18点,用户自定义字段。
List<E> irregularyAvaliableTime
字段名:无规律的有效时间段 变量名:irregulary_avaliable_time 是否必填:否 类型:array 描述: 无规律的有效时间,多个无规律时间段,用户自定义字段。
Integer waitDaysAfterReceive
字段名:领取后N天开始生效 变量名:wait_days_after_receive 是否必填:否 类型:int 描述: 日期区间内,用户领券后需等待x天开始生效。例如领券后当天开始生效则无需填写,领券后第2天开始生效填1,以此类推……用户在有效期开始前领取商家券,则从有效期第1天开始计算天数,用户在有效期内领取商家券,则从领取当天开始计算天数。无论用户何时领取商家券,商家券在活动有效期结束后均不可用。需配合available_day_after_receive一同填写,不可单独填写。 示例值:7
CouponAvailableTime couponAvailableTime
字段名:券生效时间 变量名:coupon_available_time 是否必填:是 类型:object 描述: 允许指定券的特殊生效时间规则。 该字段暂未开放
FixedNormalCoupon fixedNormalCoupon
字段名:固定面额满减券使用规则 变量名:fixed_normal_coupon 是否必填:否 类型:object 描述: stock_type为NORMAL时必填。
DiscountCoupon discountCoupon
字段名:折扣券使用规则 变量名:discount_coupon 是否必填:否 类型:object 描述: stock_type为DISCOUNT时必填。
ExchangeCoupon exchangeCoupon
字段名:换购券使用规则 变量名:exchange_coupon 是否必填:否 类型:object 描述: stock_type为EXCHANG时必填。
String useMethod
字段名:核销方式 变量名:use_method 是否必填:是 类型:string[1,128] 描述: 枚举值: OFF_LINE:线下滴码核销,点击券“立即使用”跳转展示券二维码详情。 MINI_PROGRAMS:线上小程序核销,点击券“立即使用”跳转至配置的商家小程序(需要添加小程序appid和path)。 PAYMENT_CODE:微信支付付款码核销,点击券“立即使用”跳转至微信支付钱包付款码。 SELF_CONSUME:用户自助核销,点击券“立即使用”跳转至用户自助操作核销界面(当前暂不支持用户自助核销)。 示例值:OFF_LINE
String miniProgramsAppid
字段名:小程序appid 变量名:mini_programs_appid 是否必填:否 类型:string[1,32] 描述: 核销方式为线上小程序核销才有效。 示例值:wx23232232323
String miniProgramsPath
字段名:小程序path 变量名:mini_programs_path 是否必填:否 类型:string[1,128] 描述: 核销方式为线上小程序核销才有效。 示例值:/path/index/index
CustomEntrance.MiniProgramsInfo miniProgramsInfo
字段名:小程序入口 变量名:mini_programs_info 是否必填:否 类型:object 描述: 需要小程序APPID、path、入口文案、引导文案。如果需要跳转小程序,APPID、path、入口文案为必填,引导文案非必填。 appid要与归属商户号有M-A or M-m-suba关系
String appId
字段名:商户公众号appid 变量名:appid 是否必填:否 类型:string[1,32] 描述: 可配置商户公众号,从券详情可跳转至公众号,用户自定义字段。 示例值:wx324345hgfhfghfg
String hallId
字段名:营销馆id 变量名:hall_id 是否必填:否 类型:string[1,64] 描述: 填写微信支付营销馆的馆id,用户自定义字段。 营销馆需在商户平台 创建。 示例值:233455656
String storeId
字段名:可用门店id 变量名:store_id 是否必填:否 类型:string[1,64] 描述: 填写代金券可用门店id,用户自定义字段。 示例值:233554655
String codeDisplayMode
字段名:code展示模式 变量名:code_display_mode 是否必填:否 类型:string[1,8] 描述: 枚举值: NOT_SHOW:不展示code BARCODE:一维码 QRCODE:二维码 示例值:BARCODE
String miniProgramsAppid
字段名:商家小程序appid 变量名:mini_programs_appid 是否必填:是 类型:string[1,32] 描述: 商家小程序appid要与归属商户号有M-A or M-m-suba关系。 示例值:wx234545656765876
String miniProgramsPath
字段名:商家小程序path 变量名:mini_programs_path 是否必填:是 类型:string[1,128] 描述: 商家小程序path 示例值:/path/index/index
String entranceWords
字段名:入口文案 变量名:entrance_words 是否必填:是 类型:string[1,5] 描述: 入口文案,字数上限为5个,一个中文汉字/英文字母/数字均占用一个字数。 示例值:欢迎选购
String guidingWords
字段名:引导文案 变量名:guiding_words 是否必填:否 类型:string[1,6] 描述: 小程序入口引导文案,用户自定义字段。字数上限为6个,一个中文汉字/英文字母/数字均占用一个字数。 示例值:获取更多优惠
String description
字段名:使用须知 变量名:description 是否必填:否 类型:string[1,1000] 描述: 用于说明详细的活动规则,会展示在代金券详情页。 示例值:xxx门店可用
String merchantLogoUrl
字段名:商户logo 变量名:merchant_logo_url 是否必填:否 类型:string[1,128] 描述: 商户logo的URL地址,仅支持通过《图片上传API》接口获取的图片URL地址。 1、商户logo大小需为120像素*120像素。 2、支持JPG/JPEG/PNG格式,且图片小于1M。 示例值:https://qpic.cn/xxx
String merchantName
字段名:商户名称 变量名:merchant_name 是否必填:否 类型:string[1,16] 描述: 商户名称,字数上限为16个,一个中文汉字/英文字母/数字均占用一个字数。 示例值:微信支付
String backgroundColor
字段名:背景颜色 变量名:background_color 是否必填:否 类型:string[1,16] 描述: 券的背景颜色,可设置10种颜色,色值请参考卡券背景颜色图。颜色取值为颜色图中的颜色名称。 示例值:Color020
String couponImageUrl
字段名:券详情图片 变量名:coupon_image_url 是否必填:否 类型:string[1,128] 描述: 券详情图片,850像素*350像素,且图片大小不超过2M,支持JPG/PNG格式,仅支持通过《图片上传API》接口获取的图片URL地址。 示例值:https://qpic.cn/xxx
String beginTime
字段名:开始时间 变量名:begin_time 是否必填:否 类型:string[1,32] 描述: 开始时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35+08:00
String endTime
字段名:结束时间 变量名:end_time 是否必填:否 类型:string[1,32] 描述: 结束时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35+08:00
String notifyAppId
字段名:事件通知appid 变量名:coupon_image_url 是否必填:否 类型:string[1,64] 描述: 用于回调通知时,计算返回操作用户的openid(诸如领券用户),支持小程序or公众号的APPID;如该字段不填写,则回调通知中涉及到用户身份信息的openid与unionid都将为空。 示例值:wx23232232323
Integer maxCoupons
字段名:批次最大发放个数 变量名:max_coupons 是否必填:是 类型:int 描述: 批次最大可发放个数限制 特殊规则:取值范围 1 ≤ value ≤ 1000000000 示例值:100
Integer maxCouponsPerUser
字段名:用户最大可领个数 变量名:max_coupons_per_user 是否必填:是 类型:int 描述: 用户可领个数,每个用户最多100张券 。 示例值:5
Integer maxCouponsByDay
字段名:单天发放上限个数 变量名:max_coupons_by_day 是否必填:否 类型:bool 描述: 单天发放上限个数(stock_type为DISCOUNT或EXCHANGE时可传入此字段控制单天发放上限)。 特殊规则:取值范围 1 ≤ value ≤ 1000000000 示例值:100
Boolean naturalPersonLimit
字段名:是否开启自然人限制 变量名:natural_person_limit 是否必填:否 类型:bool 描述: 不填默认否,枚举值: true:是 false:否 示例值:false
Boolean preventApiAbuse
字段名:可疑账号拦截 变量名:prevent_api_abuse 是否必填:否 类型:bool 描述: 不填默认否,枚举值: true:是 false:否 示例值:false
Boolean transferable
字段名:是否允许转赠 变量名:transferable 是否必填:否 类型:bool 描述: 不填默认否,枚举值: true:是 false:否 该字段暂未开放 示例值:false
Boolean shareable
字段名:是否允许分享链接 变量名:shareable 是否必填:否 类型:bool 描述: 不填默认否,枚举值: true:是 false:否 该字段暂未开放 示例值:false
String mchid
字段名:商户号 变量名:mchid 是否必填:是 类型:string[1, 32] 描述: query微信服务商下特约商户的商户号,由微信支付生成并下发 示例值:1111111
String subMchid
字段名:子商户号 变量名:sub_mchid 是否必填:是 类型:string[1, 32] 描述: query微信服务商下特约商户的商户号,由微信支付生成并下发 示例值:1111111
String openid
字段名:用户标识 变量名:authenticate_number 是否必填:是 类型:string[1, 64] 描述: 用户在商户对应appid下的唯一标识 示例值:onqOjjmo8wmTOOtSKwXtGjg9Gb58
String authenticateScene
字段名:核身渠道 变量名:authenticate_scene 是否必填:是 类型:string[1, 16] 描述: 核身渠道,发起核身时的来源渠道,如通过小程序,硬件设备等 FROM_MINI_APP:来自小程序方式核身 FROM_HARDWARE:来自硬件设备方式核身 示例值:onqOjjmo8wmTOOtSKwXtGjg9Gb58
String authenticateSource
字段名:核身渠道标识 变量名:authenticate_source 是否必填:是 类型:string[1, 64] 描述: 核身渠道标识,用于定位渠道具体来源,如果是扫码打卡渠道标识就是具体的小程序appid,若是硬件设备,则是设备的序列号等 示例值:wdiooewl7587443649000
String projectName
字段名:项目名称 变量名:project_name 是否必填:是 类型:string[1, 12] 描述: 该项目的名称 示例值:某项目
String employerName
字段名:单位名称 变量名:employer_name 是否必填:是 类型:string[1, 12] 描述: 该用户所属的单位名称。 示例值:某单位名称
String authenticateState
字段名:核身状态 变量名:authenticate_state 是否必填:是 类型:string[1, 32] 描述: 核身状态 AUTHENTICATE_PROCESSING:核身中 AUTHENTICATE_SUCCESS:核身成功 AUTHENTICATE_FAILED:核身失败 示例值:AUTHENTICATE_PROCESSING
String authenticateTime
字段名:核身时间 变量名:authenticate_time 是否必填:是 类型:string[1, 32] 描述: 核身时间,遵循RFC3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。 示例值:2015-05-20T13:29:35+08:00
String authenticateNumber
字段名:商家核身单号 变量名:authenticate_number 是否必填:是 类型:string[1, 64] 描述: 商户系统内部的商家核身单号,要求此参数只能由数字、大小写字母组成,在服务商内部唯一 示例值:mcdhehfgisdhfjghed39384564i83
String authenticateFailedReason
字段名:核身失败原因 变量名:authenticate_failed_reason 是否必填:否 类型:string[1, 128] 描述: 结果为核身失败时的原因描述,仅在失败记录返回 示例值:人脸验证未通过
String openid
字段名:用户标识 变量名:openid 是否必填:是 类型:string[1, 64] 描述: 用户在商户对应appid下的唯一标识 示例值:9x111111
String appid
字段名:应用ID 变量名:appid 是否必填:二选一 类型:string[1, 32] 描述: 是服务商在微信申请公众号/小程序或移动应用成功后分配的账号ID(与服务商主体一致),登录平台为mp.weixin.qq.com或open.weixin.qq.com。 当输入应用ID时,会校验其与服务商商户号的绑定关系。服务商应用ID和与子商户应用ID至少输入一个,且必须要有拉起微工卡时使用的APPID。 示例值:wxa1111111
String subAppid
字段名:子商户应用ID 变量名:sub_appid 是否必填:是 类型:string[1, 32] 描述: 是特约商户在微信申请公众号/小程序或移动应用成功后分配的账号ID(与特约商户主体一致),登录平台为mp.weixin.qq.com或open.weixin.qq.com。当输入子商户应用ID时,会校验其与特约商户号的绑定关系。 服务商应用ID和与子商户应用ID至少输入一个,且必须要有拉起微工卡时使用的APPID。 示例值:wxa1111111
String subMchid
字段名:子商户号 变量名:sub_mchid 是否必填:是 类型:string[1, 32] 描述: 微信服务商下特约商户的商户号,由微信支付生成并下发 示例值:1111111
String authenticateDate
字段名:核身日期 变量名:authenticate_date 是否必填:是 类型:string[8, 8] 描述: query核身日期,一次只能查询一天,最久可查询90天内的记录,格式为“YYYY-MM-DD” 示例值:2020-12-25
String authenticateState
字段名:核身状态 变量名:authenticate_state 是否必填:否 类型:string[1, 32] 描述: query核身状态,列表查询仅提供成功状态的核身记录查询,故此字段固定默认值即可 示例值:AUTHENTICATE_SUCCESS
Integer offset
字段名:本次查询偏移量 变量名:offset 是否必填:否 类型:int 描述: query非负整数,表示该次请求资源的起始位置,从0开始计数。调用方选填,默认为0。offset为10,limit为10时,查询第10-19条数据
Integer limit
字段名:本次请求最大查询条数 变量名:limit 是否必填:否 类型:int 描述: query非0非负的整数,该次请求可返回的最大资源条数,默认值为10,最大支持10条。 示例值:10
List<E> dataList
Integer totalCount
字段名:总记录条数 变量名:total_count 是否必填:是 类型:int 描述: 经过条件筛选,查询到的记录总数 示例值:9
Integer offset
字段名:记录起始位置 变量名:offset 是否必填:是 类型:int 描述: 该次请求资源的起始位置,请求中包含偏移量时应答消息返回相同偏移量,否则返回默认值0
Integer limit
字段名:本次返回条数 变量名:limit 是否必填:是 类型:int 描述: 经过条件筛选,本次查询到的记录条数 示例值:10
String mchid
字段名:商户号 变量名:mchid 是否必填:是 类型:string[1, 32] 描述: 微信服务商商户的商户号,由微信支付生成并下发。 示例值:1111111
String subMchid
字段名:子商户号 变量名:sub_mchid 是否必填:是 类型:string[1, 32] 描述: 微信服务商下特约商户的商户号,由微信支付生成并下发 示例值:111111
String openid
字段名:用户标识 变量名:openid 是否必填:是 类型:string[1, 64] 描述: 用户在商户对应appid下的唯一标识 示例值:onqOjjmo8wmTOOtSKwXtGjg9Gb58
String authenticateScene
字段名:核身渠道 变量名:authenticate_scene 是否必填:是 类型:string[1, 16] 描述: 核身渠道,发起核身时的来源渠道,如通过小程序,硬件设备等 FROM_MINI_APP:来自小程序方式核身 FROM_HARDWARE:来自硬件设备方式核身 示例值:FROM_HARDWARE
String authenticateSource
字段名:核身渠道标识 变量名:authenticate_source 是否必填:是 类型:string[1, 64] 描述: 核身渠道标识,用于定位渠道具体来源,如果是扫码打卡渠道标识就是具体的小程序appid,若是硬件设备,则是设备的序列号等 示例值:wdiooewl7587443649000
String projectName
字段名:项目名称 变量名:project_name 是否必填:是 类型:string[1, 12] 描述: 该项目的名称 示例值:某项目
String employerName
字段名:单位名称 变量名:employer_name 是否必填:是 类型:string[1, 12] 描述: 该用户所属的单位名称。 示例值:某单位名称
String authenticateState
字段名:核身状态 变量名:authenticate_state 是否必填:是 类型:string[1, 32] 描述: 核身状态 AUTHENTICATE_PROCESSING:核身中 AUTHENTICATE_SUCCESS:核身成功 AUTHENTICATE_FAILED:核身失败 示例值:AUTHENTICATE_PROCESSING
String authenticateTime
字段名:核身时间 变量名:authenticate_time 是否必填:是 类型:string[1, 32] 描述: 核身时间,遵循RFC3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。 示例值:2015-05-20T13:29:35+08:00
String authenticateNumber
字段名:商家核身单号 变量名:authenticate_number 是否必填:是 类型:string[1, 64] 描述: 商户系统内部的商家核身单号,要求此参数只能由数字、大小写字母组成,在服务商内部唯一 示例值:mcdhehfgisdhfjghed39384564i83
String accountType
字段名:账户类型 变量名:account_type 是否必填:是 类型:string[1, 32] 描述: query需查询银行来账记录商户的账户类型。 枚举值: BASIC:基本账户 OPERATION:运营账户 FEES:手续费账户 示例值:BASIC
String date
字段名:日期 变量名:date 是否必填:是 类型:string[10, 10] 描述: query查询的日期,一次只能查询一天,最久可查询90天内的记录,格式为“YYYY-MM-DD”。 示例值:2019-06-11
int offset
字段名:本次查询偏移量 变量名:offset 是否必填:否 类型:int 描述: query非负整数,表示该次请求资源的起始位置,从0开始计数。调用方选填,默认为0。offset为20,limit为100时,查询第20-119条数据。 示例值:0
int limit
字段名:本次请求最大查询条数 变量名:limit 是否必填:是 类型:int 描述: query非0非负的整数,该次请求可返回的最大资源条数,最大支持100条。 示例值:100
int totalCount
字段名:查询数据总条数 变量名:total_count 是否必填:是 类型:int 描述: 经过条件筛选,查询到的银行来账记录总数 。 示例值:20
int offset
字段名:本次查询偏移量 变量名:offset 是否必填:否 类型:int 描述: 该次请求资源的起始位置,请求中包含偏移量时应答消息返回相同偏移量,否则返回默认值0。 示例值:0
int limit
字段名:本次请求最大查询条数 变量名:limit 是否必填:是 类型:int 描述: 经过条件筛选,本次查询到的银行来账记录条数。 示例值:100
List<E> incomeRecordDataList
字段名:银行来账记录列表 变量名:data 是否必填:否 类型:array 描述: 单次查询返回的银行来账记录列表结果,如果查询结果为空时,则为空数组。
List<E> linksDataList
字段名:分页链接 变量名:links 是否必填:是 类型:object 描述: 返回前后页和当前页面的访问链接
String mchid
字段名:商户号 变量名:sub_mchid 是否必填:是 类型:string[1, 32] 描述: 需查询银行来账记录列表的商户号 示例值:2480253391
String accountType
字段名:账户类型 变量名:account_type 是否必填:是 类型:string[1, 32] 描述: 需查询银行来账记录商户的账户类型。 枚举值: BASIC:基本账户 OPERATION:运营账户 FEES:手续费账户 示例值:BASIC
String incomeRecordType
字段名:银行来账类型 变量名:income_record_type 是否必填:是 类型:string[1, 64] 描述: 银行来账类型,后续会有所扩展。 枚举值: OFFLINERECHARGE:转账充值 ENTERPRISEDIRECTREVENUE:企业直收 示例值:OFFLINERECHARGE
String incomeRecordId
字段名:银行来账微信单号 变量名:income_record_id 是否必填:是 类型:string[1, 64] 描述: 银行来账的微信单号 示例值:4200000811202011056138519459
String amount
字段名:银行来账金额 变量名:amount 是否必填:是 类型:int 描述: 银行来账金额,单位为分,只能为整数。 示例值:2734921
String successTime
字段名:银行来账完成时间 变量名:success_time 是否必填:是 类型:string[1, 32] 描述: 银行来账完成时间,遵循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年5月20日 13点29分35秒。 示例值:2017-12-08T00:08:00.00+08:00
String bankName
字段名:付款方银行名称 变量名:bank_name 是否必填:是 类型:string[1, 256] 描述: 银行来账的付款方银行名称,由于部分银行的数据获取限制,该字段有可能为空。 示例值:招商银行
String bankAccountName
字段名:付款方银行户名 变量名:bank_account_name 是否必填:是 类型:string[1, 256] 描述: 银行来账的付款方银行账户信息,户名为全称、明文,由于部分银行的数据获取限制,该字段有可能为空。 示例值:北京三快科技有限公司
String bankAccountNumber
字段名:付款方银行卡号 变量名:bank_account_number 是否必填:是 类型:string[1, 64] 描述: 四位掩码+付款方银行卡尾号后四位。 示例值:****6473
String rechargeRemark
字段名:银行备注 变量名:recharge_remark 是否必填:是 类型:string[1, 256] 描述: 随银行转账时,商户填入的附言、摘要等信息,目前支持的银行及填写指引请查看各银行对账详情 示例值:单号:202106010001
String next
字段名:下一页链接 变量名:next 是否必填:是 类型:string[1, 2048] 描述: 使用同样的limit进行下一页查询时的相对请求链接,使用方需要自行根据当前域名进行拼接。如果已经到最后时,为空 。 示例值:/v3/merchantfund/partner/income-records?offset=10&limit=5
String prev
字段名:上一页链接 变量名:prev 是否必填:是 类型:string[1, 2048] 描述: 使用同样的limit进行上一页查询时的相对请求链接,使用方需要自行根据当前域名进行拼接。如果是第一页,为空。 示例值:/v3/merchantfund/partner/income-records?offset=0&limit=5
String self
字段名:当前链接 变量名:self 是否必填:是 类型:string[1, 2048] 描述: 当前的相对请求链接,使用方需要自行根据当前域名进行拼接。 示例值:/v3/merchantfund/partner/income-records?offset=5&limit=5
String subMchid
字段名:特约商户号 变量名:sub_mchid 是否必填:是 类型:string[1, 32] 描述: query需查询银行来账记录列表的特约商户的商户号,该商户号须为服务商的特约商户号。 示例值:2480253391
String accountType
字段名:账户类型 变量名:account_type 是否必填:是 类型:string[1, 32] 描述: query需查询银行来账记录商户的账户类型。 枚举值: BASIC:基本账户 OPERATION:运营账户 FEES:手续费账户 示例值:BASIC
String date
字段名:日期 变量名:date 是否必填:是 类型:string[10, 10] 描述: query查询的日期,一次只能查询一天,最久可查询90天内的记录,格式为“YYYY-MM-DD”。 示例值:2019-06-11
int offset
字段名:本次查询偏移量 变量名:offset 是否必填:否 类型:int 描述: query非负整数,表示该次请求资源的起始位置,从0开始计数。调用方选填,默认为0。offset为20,limit为100时,查询第20-119条数据。 示例值:0
int limit
字段名:本次请求最大查询条数 变量名:limit 是否必填:是 类型:int 描述: query非0非负的整数,该次请求可返回的最大资源条数,最大支持100条。 示例值:100
int totalCount
字段名:查询数据总条数 变量名:total_count 是否必填:是 类型:int 描述: 经过条件筛选,查询到的银行来账记录总数 。 示例值:20
int offset
字段名:本次查询偏移量 变量名:offset 是否必填:否 类型:int 描述: 该次请求资源的起始位置,请求中包含偏移量时应答消息返回相同偏移量,否则返回默认值0。 示例值:0
int limit
字段名:本次请求最大查询条数 变量名:limit 是否必填:是 类型:int 描述: 经过条件筛选,本次查询到的银行来账记录条数。 示例值:100
List<E> incomeRecordDataList
字段名:银行来账记录列表 变量名:data 是否必填:否 类型:array 描述: 单次查询返回的银行来账记录列表结果,如果查询结果为空时,则为空数组。
List<E> linksDataList
字段名:分页链接 变量名:links 是否必填:是 类型:object 描述: 返回前后页和当前页面的访问链接
String subMchid
字段名:特约商户号 变量名:sub_mchid 是否必填:是 类型:string[1, 32] 描述: 需查询银行来账记录列表的特约商户的商户号,该商户号须为服务商的特约商户号。 示例值:2480253391
String accountType
字段名:账户类型 变量名:account_type 是否必填:是 类型:string[1, 32] 描述: 需查询银行来账记录商户的账户类型。 枚举值: BASIC:基本账户 OPERATION:运营账户 FEES:手续费账户 示例值:BASIC
String incomeRecordType
字段名:银行来账类型 变量名:income_record_type 是否必填:是 类型:string[1, 64] 描述: 银行来账类型,后续会有所扩展。 枚举值: OFFLINERECHARGE:转账充值 ENTERPRISEDIRECTREVENUE:企业直收 示例值:OFFLINERECHARGE
String incomeRecordId
字段名:银行来账微信单号 变量名:income_record_id 是否必填:是 类型:string[1, 64] 描述: 银行来账的微信单号 示例值:4200000811202011056138519459
String amount
字段名:银行来账金额 变量名:amount 是否必填:是 类型:int 描述: 银行来账金额,单位为分,只能为整数。 示例值:2734921
String successTime
字段名:银行来账完成时间 变量名:success_time 是否必填:是 类型:string[1, 32] 描述: 银行来账完成时间,遵循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年5月20日 13点29分35秒。 示例值:2017-12-08T00:08:00.00+08:00
String bankName
字段名:付款方银行名称 变量名:bank_name 是否必填:是 类型:string[1, 256] 描述: 银行来账的付款方银行名称,由于部分银行的数据获取限制,该字段有可能为空。 示例值:招商银行
String bankAccountName
字段名:付款方银行户名 变量名:bank_account_name 是否必填:是 类型:string[1, 256] 描述: 银行来账的付款方银行账户信息,户名为全称、明文,由于部分银行的数据获取限制,该字段有可能为空。 示例值:北京三快科技有限公司
String bankAccountNumber
字段名:付款方银行卡号 变量名:bank_account_number 是否必填:是 类型:string[1, 64] 描述: 四位掩码+付款方银行卡尾号后四位。 示例值:****6473
String rechargeRemark
字段名:银行备注 变量名:recharge_remark 是否必填:是 类型:string[1, 256] 描述: 随银行转账时,商户填入的附言、摘要等信息,目前支持的银行及填写指引请查看各银行对账详情 示例值:单号:202106010001
String next
字段名:下一页链接 变量名:next 是否必填:是 类型:string[1, 2048] 描述: 使用同样的limit进行下一页查询时的相对请求链接,使用方需要自行根据当前域名进行拼接。如果已经到最后时,为空 。 示例值:/v3/merchantfund/partner/income-records?offset=10&limit=5
String prev
字段名:上一页链接 变量名:prev 是否必填:是 类型:string[1, 2048] 描述: 使用同样的limit进行上一页查询时的相对请求链接,使用方需要自行根据当前域名进行拼接。如果是第一页,为空。 示例值:/v3/merchantfund/partner/income-records?offset=0&limit=5
String self
字段名:当前链接 变量名:self 是否必填:是 类型:string[1, 2048] 描述: 当前的相对请求链接,使用方需要自行根据当前域名进行拼接。 示例值:/v3/merchantfund/partner/income-records?offset=5&limit=5
String openid
字段名:用户标识 变量名:openid 是否必填:是 类型:string[1, 64] 描述: 用户在商户对应appid下的唯一标识 示例值:9x111111
String appid
字段名:应用ID 变量名:appid 是否必填:二选一 类型:string[1, 32] 描述: 是服务商在微信申请公众号/小程序或移动应用成功后分配的账号ID(与服务商主体一致),登录平台为mp.weixin.qq.com或open.weixin.qq.com。 当输入应用ID时,会校验其与服务商商户号的绑定关系。服务商应用ID和与子商户应用ID至少输入一个,且必须要有拉起微工卡时使用的APPID。 示例值:wxa1111111
String subMchid
字段名:子商户号 变量名:sub_mchid 是否必填:是 类型:string[1, 32] 描述: 微信服务商下特约商户的商户号,由微信支付生成并下发 示例值:1111111
String subAppid
字段名:子商户应用ID 变量名:sub_appid 是否必填:是 类型:string[1, 32] 描述: 是特约商户在微信申请公众号/小程序或移动应用成功后分配的账号ID(与特约商户主体一致),登录平台为mp.weixin.qq.com或open.weixin.qq.com。当输入子商户应用ID时,会校验其与特约商户号的绑定关系。 服务商应用ID和与子商户应用ID至少输入一个,且必须要有拉起微工卡时使用的APPID。 示例值:wxa1111111
String authenticateNumber
字段名:商家核身单号 变量名:authenticate_number 是否必填:是 类型:string[1, 64] 描述: body商户系统内部的商家核身单号,要求此参数只能由数字、大小写字母组成,在服务商内部唯一 示例值:mcdhehfgisdhfjghed39384564i83
String projectName
字段名:项目名称 变量名:project_name 是否必填:是 类型:string[1, 12] 描述: body该项目的名称 示例值:某项目
String employerName
字段名:单位名称 变量名:employer_name 是否必填:是 类型:string[1, 12] 描述: body该用户所属的单位名称 示例值:某单位名称
String authenticateNumber
字段名:商家核身单号 变量名:authenticate_number 是否必填:是 类型:string[1, 64] 描述: 商户系统内部的商家核身单号,要求此参数只能由数字、大小写字母组成,在服务商内部唯一 示例值:mcdhehfgisdhfjghed39384564i83
String openid
字段名:用户标识 变量名:openid 是否必填:是 类型:string[1, 64] 描述: 用户在商户对应appid下的唯一标识 示例值:9x111111
String mchid
字段名:服务商商户号 变量名:mchid 是否必填:是 类型:string[1, 32] 描述: 微信服务商商户的商户号,由微信支付生成并下发。 示例值:1111111
String subMchid
字段名:子商户号 变量名:sub_mchid 是否必填:是 类型:string[1, 32] 描述: 微信服务商下特约商户的商户号,由微信支付生成并下发 示例值:1111111
String token
字段名:授权token 变量名:token 是否必填:是 类型:string[1, 1024] 描述: 授权token 示例值:abcdefghijklmn
Integer expiresIn
字段名:token有效时间 变量名:expires_in 是否必填:是 类型:int 描述: token有效时间,单位秒 示例值:1800
String openid
字段名:用户标识 变量名:openid 是否必填:是 类型:string[1, 64] 描述: 用户在商户对应appid下的唯一标识 示例值:9x111111
String appid
字段名:应用ID 变量名:appid 是否必填:二选一 类型:string[1, 32] 描述: 是服务商在微信申请公众号/小程序或移动应用成功后分配的账号ID(与服务商主体一致),登录平台为mp.weixin.qq.com或open.weixin.qq.com。 当输入应用ID时,会校验其与服务商商户号的绑定关系。服务商应用ID和与子商户应用ID至少输入一个,且必须要有拉起微工卡时使用的APPID。 示例值:wxa1111111
String subMchid
字段名:子商户号 变量名:sub_mchid 是否必填:是 类型:string[1, 32] 描述: 微信服务商下特约商户的商户号,由微信支付生成并下发 示例值:1111111
String subAppid
字段名:子商户应用ID 变量名:sub_appid 是否必填:是 类型:string[1, 32] 描述: 是特约商户在微信申请公众号/小程序或移动应用成功后分配的账号ID(与特约商户主体一致),登录平台为mp.weixin.qq.com或open.weixin.qq.com。当输入子商户应用ID时,会校验其与特约商户号的绑定关系。 服务商应用ID和与子商户应用ID至少输入一个,且必须要有拉起微工卡时使用的APPID。 示例值:wxa1111111
String authenticateNumber
字段名:商家核身单号 变量名:authenticate_number 是否必填:是 类型:string[1, 64] 描述: 商户系统内部的商家核身单号,要求此参数只能由数字、大小写字母组成,在服务商内部唯一 示例值:mcdhehfgisdhfjghed39384564i83
String projectName
字段名:项目名称 变量名:project_name 是否必填:是 类型:string[1, 12] 描述: 该项目的名称 示例值:某项目
String employerName
字段名:用工单位名称 变量名:employer_name 是否必填:是 类型:string[1, 12] 描述: 该用户所属的单位名称。 示例值:某单位名称
String userName
字段名:用户实名 变量名:user_name 是否必填:是 类型:string[1, 1024] 描述: 用户证件号,该字段需进行加密处理,加密方法详见敏感信息加密说明。(提醒:必须在HTTP头中上送Wechatpay-Serial) 示例值:7FzH5XksJG3a8HLLsaaUV6K54y1OnPMY5
String idCardNumber
字段名:用户证件号 变量名:id_card_number 是否必填:是 类型:string[1, 1024] 描述: 用户证件号,该字段需进行加密处理,加密方法详见敏感信息加密说明。(提醒:必须在HTTP头中上送Wechatpay-Serial) 示例值:7FzH5XksJG3a8HLLsaaUV6K54y1OnPMY5
String employmentType
字段名:用工类型 变量名:employment_type 是否必填:是 类型:string[1,32] 描述: 微工卡服务仅支持用于与商户有用工关系的用户,需明确用工类型;参考值: LONG_TERM_EMPLOYMENT:长期用工, SHORT_TERM_EMPLOYMENT: 短期用工, COOPERATION_EMPLOYMENT:合作关系 示例值:LONG_TERM_EMPLOYMENT
String authenticateNumber
字段名:商家核身单号 变量名:authenticate_number 是否必填:是 类型:string[1, 64] 描述: 商户系统内部的商家核身单号,要求此参数只能由数字、大小写字母组成,在服务商内部唯一 示例值:mcdhehfgisdhfjghed39384564i83
String openid
字段名:用户标识 变量名:authenticate_number 是否必填:是 类型:string[1, 64] 描述: 用户在商户对应appid下的唯一标识 示例值:onqOjjmo8wmTOOtSKwXtGjg9Gb58
Integer mchid
字段名:商户号 变量名:mchid 是否必填:是 类型:string[1, 32] 描述: 微信服务商商户的商户号,由微信支付生成并下发 示例值:1111111
String subMchid
字段名:特约商户号 变量名:sub_mchid 是否必填:是 类型:string[1, 32] 描述: 微信服务商下特约商户的商户号,由微信支付生成并下发 示例值:1900000109
String token
字段名:授权token 变量名:token 是否必填:是 类型:string[1, 1024] 描述: 授权token 示例值:abcdefghijklmn
Integer expiresIn
字段名:token有效时间 变量名:expires_in 是否必填:是 类型:int 描述: token有效时间,单位秒 示例值:300
String openid
字段名:用户标识 变量名:openid 是否必填:是 类型:string[1, 64] 描述: 用户在商户对应appid下的唯一标识 示例值:9x111111
String subMchid
字段名:子商户号 变量名:sub_mchid 是否必填:是 类型:string[1, 32] 描述: 微信服务商下特约商户的商户号,由微信支付生成并下发 示例值:1111111
String appid
字段名:应用ID 变量名:appid 是否必填:二选一 类型:string[1, 32] 描述: 是服务商在微信申请公众号/小程序或移动应用成功后分配的账号ID(与服务商主体一致),登录平台为mp.weixin.qq.com或open.weixin.qq.com。 当输入应用ID时,会校验其与服务商商户号的绑定关系。服务商应用ID和与子商户应用ID至少输入一个,且必须要有拉起微工卡时使用的APPID。 示例值:wxa1111111
String subAppid
字段名:子商户应用ID 变量名:sub_appid 是否必填:是 类型:string[1, 32] 描述: 是特约商户在微信申请公众号/小程序或移动应用成功后分配的账号ID(与特约商户主体一致),登录平台为mp.weixin.qq.com或open.weixin.qq.com。当输入子商户应用ID时,会校验其与特约商户号的绑定关系。 服务商应用ID和与子商户应用ID至少输入一个,且必须要有拉起微工卡时使用的APPID。 示例值:wxa1111111
String openid
字段名:用户标识 变量名:openid 是否必填:是 类型:string[1, 64] 描述: 用户在商户对应appid下的唯一标识 示例值:9x111111
String mchid
字段名:服务商商户号 变量名:mchid 是否必填:是 类型:string[1, 32] 描述: 微信服务商商户的商户号,由微信支付生成并下发。 示例值:1111111
String subMchid
字段名:子商户号 变量名:sub_mchid 是否必填:是 类型:string[1, 32] 描述: 微信服务商下特约商户的商户号,由微信支付生成并下发 示例值:1111111
String authorizeState
字段名:授权状态 变量名:authorize_state 是否必填:是 类型:string[1, 32] 描述: 授权状态: UNAUTHORIZED:未授权 AUTHORIZED:已授权 DEAUTHORIZED:已取消授权 示例值:UNAUTHORIZED
String authorizeTime
字段名:授权时间 变量名:authorize_time 是否必填:否 类型:string[1, 32] 描述: 授权时间,遵循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
String deauthorizeTime
字段名:取消授权时间 变量名:deauthorize_time 是否必填:否 类型:string[1, 32] 描述: 取消授权时间,遵循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
String subMchid
字段名:子商户号 变量名:sub_mchid 是否必填:是 类型:string[1, 32] 描述: query下载指定子商户的账单。 示例值:19000000001
String billDate
字段名:账单日期 变量名:bill_date 是否必填:是 类型:string[10, 10] 描述: query格式YYYY-MM-DD 示例值:2019-06-11
String accountType
字段名:资金账户类型 变量名:account_type 是否必填:是 类型:string[1, 16] 描述: query枚举值: BASIC:基本账户 OPERATION:运营账户 FEES:手续费账户 示例值:BASIC
String algorithm
字段名:加密算法 变量名:algorithm 是否必填:是 类型:string[1, 31] 描述: query枚举值: AEAD_AES_256_GCM:AEAD_AES_256_GCM加密算法 示例值:AEAD_AES_256_GCM
String tarType
字段名:压缩格式 变量名:tar_type 是否必填:否 类型:string[1, 8] 描述: query不填则以不压缩的方式返回数据流 枚举值: GZIP:返回格式为.gzip的压缩包账单 示例值:GZIP
String openid
字段名:用户标识 变量名:openid 是否必填:是 类型:string[1, 64] 描述: 用户在商户对应appid下的唯一标识 示例值:9x111111
String appid
字段名:应用ID 变量名:appid 是否必填:二选一 类型:string[1, 32] 描述: 是服务商在微信申请公众号/小程序或移动应用成功后分配的账号ID(与服务商主体一致),登录平台为mp.weixin.qq.com或open.weixin.qq.com。 当输入应用ID时,会校验其与服务商商户号的绑定关系。服务商应用ID和与子商户应用ID至少输入一个,且必须要有拉起微工卡时使用的APPID。 示例值:wxa1111111
String subAppid
字段名:子商户应用ID 变量名:sub_appid 是否必填:是 类型:string[1, 32] 描述: 是特约商户在微信申请公众号/小程序或移动应用成功后分配的账号ID(与特约商户主体一致),登录平台为mp.weixin.qq.com或open.weixin.qq.com。当输入子商户应用ID时,会校验其与特约商户号的绑定关系。 服务商应用ID和与子商户应用ID至少输入一个,且必须要有拉起微工卡时使用的APPID。 示例值:wxa1111111
String subMchid
字段名:子商户号 变量名:sub_mchid 是否必填:是 类型:string[1, 32] 描述: 微信服务商下特约商户的商户号,由微信支付生成并下发 示例值:1111111
String userName
字段名:用户实名 变量名:user_name 是否必填:是 类型:string[1, 1024] 描述: 用户证件号,该字段需进行加密处理,加密方法详见敏感信息加密说明。(提醒:必须在HTTP头中上送Wechatpay-Serial) 示例值:7FzH5XksJG3a8HLLsaaUV6K54y1OnPMY5
String idCardNumber
字段名:用户证件号 变量名:id_card_number 是否必填:是 类型:string[1, 1024] 描述: 用户证件号,该字段需进行加密处理,加密方法详见敏感信息加密说明。(提醒:必须在HTTP头中上送Wechatpay-Serial) 示例值:7FzH5XksJG3a8HLLsaaUV6K54y1OnPMY5
String employmentType
字段名:用工类型 变量名:employment_type 是否必填:是 类型:string[1,32] 描述: 微工卡服务仅支持用于与商户有用工关系的用户,需明确用工类型;参考值: LONG_TERM_EMPLOYMENT:长期用工, SHORT_TERM_EMPLOYMENT: 短期用工, COOPERATION_EMPLOYMENT:合作关系 示例值:LONG_TERM_EMPLOYMENT
String openid
字段名:用户标识 变量名:openid 是否必填:是 类型:string[1, 64] 描述: 用户在商户对应appid下的唯一标识 示例值:9x111111
String mchid
字段名:服务商商户号 变量名:mchid 是否必填:是 类型:string[1, 32] 描述: 微信服务商商户的商户号,由微信支付生成并下发。 示例值:1111111
String subMchid
字段名:子商户号 变量名:sub_mchid 是否必填:是 类型:string[1, 32] 描述: 微信服务商下特约商户的商户号,由微信支付生成并下发 示例值:1111111
String token
字段名:授权token 变量名:token 是否必填:是 类型:string[1, 1024] 描述: 授权token 示例值:abcdefghijklmn
Integer expiresIn
字段名:token有效时间 变量名:expires_in 是否必填:是 类型:int 描述: token有效时间,单位秒 示例值:1800
String batchId
字段名:微信支付批次单号 变量名:need_query_detail 是否必填:是 类型:string[32, 64] 描述: path微信支付批次单号,微信商家转账系统返回的唯一标识 示例值:1030000071100999991182020050700019480001
String detailId
字段名:微信明细单号 变量名:need_query_detail 是否必填:是 类型:string[32, 64] 描述: path微信支付系统内部区分转账批次单下不同转账明细单的唯一标识 示例值:1040000071100999991182020050700019500100
String spMchid
字段名:服务商商户号 变量名:sp_mchid 是否必填:是 类型:string[1, 32] 描述: 微信支付分配的商户号,此处为服务商商户号 示例值:1900001109
String outBatchNo
字段名:商家批次单号 变量名:out_batch_no 是否必填:是 类型:string[5, 32] 描述: 商户系统内部的商家批次单号,在商户系统内部唯一 示例值:plfk2020042013
String batchId
字段名:微信支付批次单号 变量名:batch_id 是否必填:是 类型:string[5, 32] 描述: 微信支付批次单号,微信商家转账系统返回的唯一标识 示例值:1030000071100999991182020050700019480001
String appId
字段名:商户的appid 变量名: 是否必填:否 类型:string[1, 32] 描述: 微信分配的特约商户公众账号ID。特约商户授权类型为 INFORMATION_AUTHORIZATION_TYPE和 INFORMATION_AND_FUND_AUTHORIZATION_TYPE时对应的是特约商户的appid, 特约商户授权类型为FUND_AUTHORIZATION_TYPE时为服务商的appid 例值:wxf636efh567hg4356
String outDetailNo
字段名:商家明细单号 变量名:out_detail_no 是否必填:是 类型:string[5, 32] 描述: 商户系统内部区分转账批次单下不同转账明细单的唯一标识 示例值:x23zy545Bd5436
String detailId
字段名:微信支付明细单号 变量名:detail_id 是否必填:是 类型:string[32, 64] 描述: 微信支付系统内部区分转账批次单下不同转账明细单的唯一标识 示例值:1040000071100999991182020050700019500100
String detailStatus
字段名:明细状态 变量名:detail_status 是否必填:是 类型:string[1, 32] 描述: 枚举值: PROCESSING:转账中。正在处理中,转账结果尚未明确 SUCCESS:转账成功 FAIL:转账失败。需要确认失败原因后,再决定是否重新发起对该笔明细单的转账(并非整个转账批次单) 示例值:SUCCESS
Integer transferAmount
字段名:转账金额 变量名:transfer_amount 是否必填:是 类型:int 描述: 转账金额单位为“分” 示例值:200000
String transferRemark
字段名:转账备注 变量名:transfer_remark 是否必填:是 类型:string[1, 32] 描述: 单条转账备注(微信用户会收到该备注),UTF8编码,最多允许32个字符 示例值:2020年4月报销
String failReason
字段名:明细失败原因 变量名:fail_reason 是否必填:否 类型:string[1, 64] 描述: 如果转账失败则有失败原因: ACCOUNT_FROZEN:账户冻结 REAL_NAME_CHECK_FAIL:用户未实名 NAME_NOT_CORRECT:用户姓名校验失败 OPENID_INVALID:Openid校验失败 TRANSFER_QUOTA_EXCEED:超过用户单笔收款额度 DAY_RECEIVED_QUOTA_EXCEED:超过用户单日收款额度 MONTH_RECEIVED_QUOTA_EXCEED:超过用户单月收款额度 DAY_RECEIVED_COUNT_EXCEED:超过用户单日收款次数 PRODUCT_AUTH_CHECK_FAIL:产品权限校验失败 OVERDUE_CLOSE:转账关闭 ID_CARD_NOT_CORRECT:用户身份证校验失败 ACCOUNT_NOT_EXIST:用户账户不存在 TRANSFER_RISK:转账存在风险 示例值:ACCOUNT_FROZEN
String openid
字段名:收款用户openid 变量名:openid 是否必填:是 类型:string[1, 64] 描述: 收款用户openid。如果转账特约商户授权类型是INFORMATION_AUTHORIZATION_TYPE,对应的是特约商户公众号下的openid; 如果转账特约商户授权类型是FUND_AUTHORIZATION_TYPE,对应的是服务商商户公众号下的openid。 示例值:o-MYE42l80oelYMDE34nYD456Xoy
String userName
字段名:收款用户姓名 变量名:username 是否必填:是 类型:string[1, 1024] 描述: 1、收款方姓名。采用标准RSA算法,公钥由微信侧提供 2、该字段需进行加密处理,加密方法详见敏感信息加密说明。(提醒:必须在HTTP头中上送Wechatpay-Serial) 示例值:757b340b45ebef5467rter35gf464344v3542sdf4t6re4tb4f54ty45t4yyry45
String initiateTime
字段名:转账发起时间 变量名:initiate_time 是否必填:是 类型:string[1, 32] 描述: 转账发起的时间,遵循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
String updateTime
字段名:明细更新时间 变量名:initiate_time 是否必填:是 类型:string[1, 32] 描述: 明细最后一次状态变更的时间,遵循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
String batchId
字段名:微信支付批次单号 变量名:batch_id 是否必填:是 类型:string[32, 64] 描述: path微信支付批次单号,微信商家转账系统返回的唯一标识 示例值:1030000071100999991182020050700019480001
Boolean needQueryDetail
字段名:是否查询转账明细单 变量名:need_query_detail 是否必填:是 类型:boolean 默认否 描述: 商户可选择是否查询指定状态的转账明细单,当转账批次单状态为“FINISHED”(已完成)时,才会返回满足条件的转账明细单 示例值:true
Integer offset
字段名:请求资源起始位置 变量名:offset 是否必填:否 类型:int 描述: query该次请求资源的起始位置。返回的明细是按照设置的明细条数进行分页展示的,一次查询可能无法返回所有明细,我们使用该参数标识查询开始位置,默认值为0 示例值:0
Integer limit
字段名:最大资源条数 变量名:limit 是否必填:否 类型:int 描述: query该次请求可返回的最大明细条数,最小20条,最大100条,不传则默认20条。不足20条按实际条数返回 示例值:20
String detailStatus
字段名:明细状态 变量名:detail_status 是否必填:否 类型:string[1, 32] 描述: query查询指定状态的转账明细单,不传没有明细状态信息返回。当need_query_detail为true时,该字段必填 枚举值: ALL:全部。需要同时查询转账成功和转账失败的明细单 SUCCESS:转账成功。只查询转账成功的明细单 FAIL:转账失败。只查询转账失败的明细单 示例值:FAIL
String spMchid
字段名:服务商商户号 变量名:sp_mchid 是否必填:是 类型:string[1, 32] 描述: 微信支付分配的服务商商户号 示例值:1900001109
String subMchid
字段名:特约商户号 变量名:sub_mchid 是否必填:是 类型:string[1, 32] 描述: 微信支付分配的特约商户号 示例值:1900000109
String outBatchNo
字段名:商家批次单号 变量名:out_batch_no 是否必填:是 类型:string[5, 32] 描述: 商户系统内部的商家批次单号,在商户系统内部唯一 示例值:plfk2020042013
String batchId
字段名:微信支付批次单号 变量名:batch_id 是否必填:是 类型:string[32, 64] 描述: 微信支付批次单号,微信商家转账系统返回的唯一标识 示例值:1030000071100999991182020050700019480001
String subAppid
字段名:特约商户appid 变量名:sub_appid 是否必填:否 类型:string[1, 32] 描述: 微信分配的特约商户公众账号ID。特约商户appid 示例值:wxf636efh567hg4356
String batchStatus
字段名:批次状态 变量名:batch_status 是否必填:是 类型:string[1, 32] 描述: 枚举值: WAIT_PAY:待付款,商户员工确认付款阶段。 ACCEPTED:已受理。批次已受理成功,若发起批量转账的30分钟后,转账批次单仍处于该状态,可能原因是商户账户余额不足等。商户可查询账户资金流水,若该笔转账批次单的扣款已经发生,则表示批次已经进入转账中,请再次查单确认 PROCESSING:转账中。已开始处理批次内的转账明细单 FINISHED:已完成。批次内的所有转账明细单都已处理完成 CLOSED:已关闭。可查询具体的批次关闭原因确认 示例值:ACCEPTED
String batchType
字段名:批次类型 变量名:batch_type 是否必填:是 类型:string[1, 32] 描述: 枚举值: API:API方式发起 WEB:页面方式发起 示例值:API
String authorizationType
字段名:特约商户授权类型 变量名:authorization_type 是否必填:是 类型:string[1, 32] 描述: 特约商户授权类型: INFORMATION_AUTHORIZATION_TYPE:信息授权类型 FUND_AUTHORIZATION_TYPE:资金授权类型 INFORMATION_AND_FUND_AUTHORIZATION_TYPE:信息和资金授权类型 示例值:INFORMATION_AUTHORIZATION_TYPE
String batchName
字段名:批次名称 变量名:batch_name 是否必填:是 类型:string[1, 32] 描述: 示例值:2019年1月深圳分部报销单
String batchRemark
字段名:批次备注 变量名:batch_remark 是否必填:是 类型:string[1, 32] 描述: 转账说明,UTF8编码,最多允许32个字符 示例值:2019年1月深圳分部报销单
String closeReason
字段名:批次关闭原因 变量名:close_reason 是否必填:否 类型:string[1, 64] 描述: 如果批次单状态为“CLOSED”(已关闭),则有关闭原因: MERCHANT_REVOCATION:商户主动撤销 OVERDUE_CLOSE:系统超时关闭 示例值:OVERDUE_CLOSE
Integer totalAmount
字段名:转账总金额 变量名:total_amount 是否必填:是 类型:int 描述: 转账金额单位为“分” 示例值:4000000
Integer totalNum
字段名:转账总笔数 变量名:total_num 是否必填:是 类型:int 描述: 一个转账批次单最多发起三千笔转账 示例值:200
String createTime
字段名:批次创建时间 变量名:create_time 是否必填:否 类型:string[1, 32] 描述: 批次受理成功时返回,遵循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
String updateTime
字段名:批次更新时间 变量名:update_time 是否必填:否 类型:string[1, 32] 描述: 批次最近一次状态变更的时间,遵循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
Integer successAmount
字段名:转账成功金额 变量名:success_amount 是否必填:否 类型:int 描述: 转账成功的金额,单位为“分”。当批次状态为“PROCESSING”(转账中)时,转账成功金额随时可能变化 示例值:3900000
Integer successNum
字段名:转账成功笔数 变量名:success_num 是否必填:否 类型:int 描述: 转账成功的笔数。当批次状态为“PROCESSING”(转账中)时,转账成功笔数随时可能变化 示例值:199
Integer failAmount
字段名:转账失败金额 变量名:fail_amount 是否必填:否 类型:int 描述: 转账失败的金额,单位为“分” 示例值:100000
Integer failNum
字段名:转账失败笔数 变量名:fail_amount 是否必填:否 类型:int 描述: 转账失败的笔数 示例值:1
List<E> transferDetailList
字段名:转账明细单列表 变量名:transfer_detail_list 是否必填:否 类型:int 描述: 当批次状态为“FINISHED”(已完成),且成功查询到转账明细单时返回。包括微信明细单号、明细状态信息
String spAppid
字段名:服务商的appid 变量名:sp_appid 是否必填:否 类型:string[1, 32] 描述: 微信分配的服务商商户公众账号ID,特约商户授权类型为FUND_AUTHORIZATION_TYPE时才有该字段 示例值:wxf636efh567hg4388
String transferPurpose
字段名:批量转账用途 变量名:transfer_purpose 是否必填:否 类型:string[1,16] 描述: 批量转账用途: GOODSPAYMENT:货款 COMMISSION:佣金 REFUND:退款 REIMBURSEMENT:报销 FREIGHT:运费 OTHERS:其他 示例值:COMMISSION
String detailId
字段名:微信支付明细单号 变量名:detail_id 是否必填:是 类型:string[32, 64] 描述: 微信支付系统内部区分转账批次单下不同转账明细单的唯一标识 示例值:1040000071100999991182020050700019500100
String outDetailNo
字段名:商家明细单号 变量名:out_detail_no 是否必填:是 类型:string[5, 32] 描述: 商户系统内部区分转账批次单下不同转账明细单的唯一标识 示例值:x23zy545Bd5436
String detailStatus
字段名:明细状态 变量名:detail_status 是否必填:是 类型:string[1, 32] 描述: 枚举值: PROCESSING:转账中。正在处理中,转账结果尚未明确 SUCCESS:转账成功 FAIL:转账失败。需要确认失败原因后,再决定是否重新发起对该笔明细单的转账(并非整个转账批次单) 示例值:SUCCESS
String outBatchNo
字段名:商家批次单号 变量名:out_batch_no 是否必填:是 类型:string[5,32] 描述: 商户系统内部的商家批次单号,在商户系统内部唯一。需要电子回单的批次单号 示例值:plfk2020042013
String signatureNo
字段名:电子回单申请单号 变量名:signature_no 是否必填:是 类型:string[3.45] 描述: 电子回单申请单号,申请单据的唯一标识 示例值:1050000010509999485212020110200058820001
String signatureStatus
字段名:电子回单状态 变量名:signature_status 是否必填:否 类型:string[1,10] 描述: 枚举值: ACCEPTED:已受理,电子签章已受理成功 FINISHED:已完成。电子签章已处理完成 示例值:ACCEPTED
String hashType
字段名:电子回单文件的hash方法 变量名:hash_type 是否必填:否 类型:string[1,20] 描述: 电子回单文件的hash方法,回单状态为:FINISHED时返回。 示例值:SHA256
String hashValue
字段名:电子回单文件的hash值 变量名:hash_value 是否必填:否 类型:string[3,1000] 描述: 电子回单文件的hash值,用于下载之后验证文件的完整、正确性,回单状态为:FINISHED时返回。 示例值:DE731F35146A0BEFADE5DB9D1E468D96C01CA8898119C674FEE9F11F4DBE5529
String downloadUrl
字段名:电子回单文件的下载地址 变量名:hash_value 是否必填:否 类型:string[10,3000] 描述: 电子回单文件的下载地址,回单状态为:FINISHED时返回。URL有效时长为10分钟,10分钟后需要重新去获取下载地址 示例值:https://api.mch.weixin.qq.com/v3/billdownload/file?token=xxx
String createTime
字段名:创建时间 变量名:create_time 是否必填:否 类型:string[1, 32] 描述: 电子签章单创建时间,遵循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秒 示例值:2020-05-20T13:29:35.120+08:00
String updateTime
字段名:更新时间 变量名:update_time 是否必填:否 类型:string[1, 32] 描述: 电子签章单最近一次状态变更的时间,遵循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秒 示例值:2020-05-21T13:29:35.120+08:00
String hashType
字段名:电子回单文件的hash方法 变量名:hash_type 是否必填:否 类型:string[1, 20] 描述: 电子回单文件的hash方法,回单状态为:FINISHED时返回 例值:SHA256
String hashValue
字段名:电子回单文件的hash值 变量名:hash_value 是否必填:否 类型:string[3, 1000] 描述: 电子回单文件的hash值,用于下载之后验证文件的完整、正确性,回单状态为:FINISHED时返回 示例值:DE731F35146A0BEFADE5DB9D1E468D96C01CA8898119C674FEE9F11F4DBE5529
String downloadUrl
字段名:电子回单文件的下载地址 变量名:download_url 是否必填:否 类型:string[10, 3000] 描述: 电子回单文件的下载地址,回单状态为:FINISHED时返回。URL有效时长为10分钟,10分钟后需要重新去获取下载地址(但不需要走受理) 示例值:https://api.mch.weixin.qq.com/v3/billdownload/file?token=xxx
String acceptType
字段名:受理类型 变量名:accept_type 是否必填:是 类型:string[1,32] 描述: body电子回单受理类型: BATCH_TRANSFER:批量转账明细电子回单 TRANSFER_TO_POCKET:企业付款至零钱电子回单 TRANSFER_TO_BANK:企业付款至银行卡电子回单 示例值:BATCH_TRANSFER
String outBatchNo
字段名:商家转账批次单号 变量名:out_batch_no 是否必填:否 类型:string[5, 32] 描述: body需要电子回单的批量转账明细单所在的转账批次单号,该单号为商户申请转账时生成的商户单号。受理类型为BATCH_TRANSFER时该单号必填,否则该单号留空。 示例值:GD2021011610162610BBdkkIwcu3
String outDetailNo
字段名:商家转账明细单号 变量名:out_batch_no 是否必填:是 类型:string[5, 32] 描述: body该单号为商户申请转账时生成的商家转账明细单号。 1.受理类型为BATCH_TRANSFER时填写商家批量转账明细单号。 2. 受理类型为TRANSFER_TO_POCKET或TRANSFER_TO_BANK时填写商家转账单号。 示例值:mx0911231610162610v4CNkO4HAf
String acceptType
字段名:受理类型 变量名:accept_type 是否必填:是 类型:string[1,32] 描述: 电子回单受理类型: BATCH_TRANSFER:批量转账明细电子回单 TRANSFER_TO_POCKET:企业付款至零钱电子回单 TRANSFER_TO_BANK:企业付款至银行卡电子回单 示例值:BATCH_TRANSFER
String outBatchNo
字段名:商家转账批次单号 变量名:out_batch_no 是否必填:否 类型:string[5, 32] 描述: 需要电子回单的批量转账明细单所在的转账批次单号,该单号为商户申请转账时生成的商户单号。受理类型为BATCH_TRANSFER时该单号必填,否则该单号留空。 示例值:GD2021011610162610BBdkkIwcu3
String outDetailNo
字段名:商家转账明细单号 变量名:out_detail_no 是否必填:是 类型:string[5, 32] 描述: 该单号为商户申请转账时生成的商家转账明细单号。 1.受理类型为BATCH_TRANSFER时填写商家批量转账明细单号。 2. 受理类型为TRANSFER_TO_POCKET或TRANSFER_TO_BANK时填写商家转账单号。 示例值:mx0911231610162610v4CNkO4HAf
String signatureNo
字段名:电子回单受理单号 变量名:signature_no 是否必填:是 类型:string[3, 256] 描述: 电子回单受理单号,受理单据的唯一标识 示例值:1050000010509999485212020110200058820001
String signatureStatus
字段名:电子回单状态 变量名:signature_status 是否必填:否 类型:string[1, 10] 描述: 枚举值: ACCEPTED:已受理,电子签章已受理成功 FINISHED:已完成。电子签章已处理完成 示例值:ACCEPTED
String hashType
字段名:电子回单文件的hash方法 变量名:hash_type 是否必填:否 类型:string[1, 20] 描述: 电子回单文件的hash方法,回单状态为:FINISHED时返回 例值:SHA256
String hashValue
字段名:电子回单文件的hash值 变量名:hash_value 是否必填:否 类型:string[3, 1000] 描述: 电子回单文件的hash值,用于下载之后验证文件的完整、正确性,回单状态为:FINISHED时返回 示例值:DE731F35146A0BEFADE5DB9D1E468D96C01CA8898119C674FEE9F11F4DBE5529
String downloadUrl
字段名:电子回单文件的下载地址 变量名:download_url 是否必填:否 类型:string[10, 3000] 描述: 电子回单文件的下载地址,回单状态为:FINISHED时返回。URL有效时长为10分钟,10分钟后需要重新去获取下载地址(但不需要走受理) 示例值:https://api.mch.weixin.qq.com/v3/billdownload/file?token=xxx
String outBatchNo
字段名:商家批次单号 变量名:out_batch_no 是否必填:是 类型:string[5, 32] 描述: path商户系统内部的商家批次单号,要求此参数只能由数字、大小写字母组成,在商户系统内部唯一 示例值:plfk2020042013
Boolean needQueryDetail
字段名:是否查询转账明细单 变量名:need_query_detail 是否必填:是 类型:boolean 默认否 描述: 商户可选择是否查询指定状态的转账明细单,当转账批次单状态为“FINISHED”(已完成)时,才会返回满足条件的转账明细单 示例值:true
Integer offset
字段名:请求资源起始位置 变量名:offset 是否必填:否 类型:int 描述: query该次请求资源的起始位置。返回的明细是按照设置的明细条数进行分页展示的,一次查询可能无法返回所有明细,我们使用该参数标识查询开始位置,默认值为0 示例值:0
Integer limit
字段名:最大资源条数 变量名:limit 是否必填:否 类型:int 描述: query该次请求可返回的最大明细条数,最小20条,最大100条,不传则默认20条。不足20条按实际条数返回 示例值:20
String detailStatus
字段名:明细状态 变量名:detail_status 是否必填:否 类型:string[1, 32] 描述: query查询指定状态的转账明细单,不传没有明细状态信息返回。当need_query_detail为true时,该字段必填 枚举值: ALL:全部。需要同时查询转账成功和转账失败的明细单 SUCCESS:转账成功。只查询转账成功的明细单 FAIL:转账失败。只查询转账失败的明细单 示例值:FAIL
String subMchid
字段名:特约商户号 变量名:sub_mchid 是否必填:是 类型:string(32) 描述: 特约商户号 示例值:1900000109
String subAppid
字段名:特约商户appid 变量名:sub_appid 是否必填:否 类型:string(32) 描述: 示例值:wxf636efh567hg4356
String authorizationType
字段名:特约商户授权类型 变量名:authorization_type 是否必填:是 类型:string(32) 描述: 特约商户授权类型: INFORMATION_AUTHORIZATION_TYPE:特约商户信息授权类型 FUND_AUTHORIZATION_TYPE:特约商户资金授权类型 INFORMATION_AND_FUND_AUTHORIZATION_TYPE:特约商户信息和资金授权类型 示例值:INFORMATION_AUTHORIZATION_TYPE
String outBatchNo
字段名:商家批次单号 变量名:out_batch_no 是否必填:是 类型:string(5-32) 描述: 商户系统内部的商家批次单号,要求此参数只能由数字、大小写字母组成,在商户系统内部唯一 示例值:plfk2020042013
String batchName
字段名:批次名称 变量名:batch_name 是否必填:是 类型:string(32) 描述: body该笔批量转账的名称 示例值:2019年1月深圳分部报销单
String batchRemark
字段名:批次备注 变量名:out_trade_no 是否必填:是 类型:string(32) 描述: body转账说明,UTF8编码,最多允许32个字符 示例值:2019年1月深圳分部报销单
Integer totalAmount
字段名:转账总金额 变量名:time_expire 是否必填:是 类型:int 描述: body转账金额单位为“分”。转账总金额必须与批次内所有明细转账金额之和保持一致,否则无法发起转账操作 示例值:4000000
Integer totalNum
字段名:转账总笔数 变量名:total_num 是否必填:是 类型:int 描述: body一个转账批次单最多发起三千笔转账。转账总笔数必须与批次内所有明细之和保持一致,否则无法发起转账操作 示例值:200
List<E> transferDetailList
字段名:转账明细列表 变量名:transfer_detail_list 是否必填:是 类型:array 描述: body发起批量转账的明细列表,最多三千笔
String spAppid
字段名:服务商的appid 变量名:sp_appid 是否必填:否 类型:string[1, 32] 描述: 特约商户授权类型为FUND_AUTHORIZATION_TYPE时需要填写 示例值:wxf636efh567hg4388
String transferPurpose
字段名:批量转账用途 变量名:transfer_purpose 是否必填:否 类型:string[1, 32] 描述: body批量转账用途,枚举值: GOODSPAYMENT:货款、COMMISSION:佣金、REFUND:退款、REIMBURSEMENT:报销 FREIGHT:运费、OTHERS:其他 示例值:COMMISSION
String transferScene
字段名:转账场景【微工卡】 变量名:transfer_scene 是否必填:否 类型:string[1, 32] 描述: body商户的转账场景 ORDINARY_TRANSFER:普通转账,可转入用户的零钱账户 PAYROLL_CARD_TRANSFER:微工卡转账,可转入用户在微工卡选择的收款账户(零钱/银行卡) 示例值:ORDINARY_TRANSFER
String outDetailNo
字段名:商家明细单号 变量名:out_detail_no 是否必填:是 类型:string[5, 32] 描述: 商户系统内部区分转账批次单下不同转账明细单的唯一标识,要求此参数只能由数字、大小写字母组成 示例值:x23zy545Bd5436
Integer transferAmount
字段名:转账金额 变量名:transfer_amount 是否必填:是 类型:int 描述: 转账金额单位为“分” 示例值:200000
String transferRemark
字段名:转账备注 变量名:transfer_amount 是否必填:是 类型:string[1, 32] 描述: 单条转账备注(微信用户会收到该备注),UTF8编码,最多允许32个字符 示例值:2020年4月报销
String openid
字段名:收款用户openid 变量名:openid 是否必填:是 类型:string[1, 64] 描述: 收款用户openid。如果转账特约商户授权类型是INFORMATION_AUTHORIZATION_TYPE,对应的是特约商户公众号下的openid。 示例值:o-MYE42l80oelYMDE34nYD456Xoy
String userName
字段名:收款用户姓名 变量名:user_name 是否必填:是 类型:string[1, 1024] 描述: 1、收款用户姓名。采用标准RSA算法,公钥由微信侧提供 2、该字段需进行加密处理,加密方法详见敏感信息加密说明。(提醒:必须在HTTP头中上送Wechatpay-Serial) 示例值:757b340b45ebef5467rter35gf464344v3542sdf4t6re4tb4f54ty45t4yyry45
String userIdCard
字段名:收款用户身份证 变量名:user_id_card 是否必填:否 类型:string[1, 1024] 描述: 1、收款方身份证号,可不用填(采用标准RSA算法,公钥由微信侧提供) 2、该字段需进行加密处理,加密方法详见敏感信息加密说明。(提醒:必须在HTTP头中上送Wechatpay-Serial) 示例值:8609cb22e1774a50a930e414cc71eca06121bcd266335cda230d24a7886a8d9f
String outBatchNo
字段名:商家批次单号 变量名:out_batch_no 是否必填:是 类型:string[5, 32] 描述: 商户系统内部的商家批次单号,在商户系统内部唯一 示例值:plfk2020042013
String batchId
字段名:微信支付批次单号 变量名:batch_id 是否必填:是 类型:string[32, 64] 描述: 微信支付批次单号,微信商家转账系统返回的唯一标识 示例值:1030000071100999991182020050700019480001
String createTime
字段名:批次创建时间 变量名:create_time 是否必填:是 类型:string[1, 32] 描述: 批次受理成功时返回,遵循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
String outBatchNo
字段名:商家批次单号 变量名:out_batch_no 是否必填:是 类型:string[5, 32] 描述: body商户系统内部的商家批次单号,在商户系统内部唯一。需要电子回单的批次单号 示例值:plfk2020042013
Integer limit
字段名:最大资源条数 变量名:limit 是否必填:否 类型:int 描述: query该次请求可返回的最大资源(转账明细单)条数,最小20条,最大100条,不传则默认20条。不足20条按实际条数返回 示例值:20
Integer offset
字段名:请求资源起始位置 变量名:transfer_batch 是否必填:否 类型:int 描述: query该次请求资源(转账明细单)的起始位置,从0开始,转账明细单列表为空时不返回 示例值:1
BatchesQueryResult.TransferBatch transferBatch
字段名:转账批次单 变量名:transfer_batch 是否必填:是 类型:object 描述: 转账批次单基本信息
List<E> transferDetailList
字段名:转账明细单列表 变量名:transfer_detail_list 是否必填:否 类型:array 描述: body发起批量转账的明细列表,最多三千笔
String mchId
字段名:商户号 变量名:mchid 是否必填:是 类型:string[1,32] 描述: 微信支付分配的商户号 示例值:1900001109
String outBatchNo
字段名:商家批次单号 变量名:out_batch_no 是否必填:是 类型:string[1,32] 描述: 商户系统内部的商家批次单号,在商户系统内部唯一 示例值:plfk2020042013
String batchId
字段名:微信批次单号 变量名:batch_id 是否必填:是 类型:string[1,32] 描述: 微信批次单号,微信商家转账系统返回的唯一标识 示例值:1030000071100999991182020050700019480001
String appid
字段名:直连商户的appid 变量名:appid 是否必填:是 类型:string[1,32] 描述: 申请商户号的appid或商户号绑定的appid(企业号corpid即为此appid) 示例值:wxf636efh567hg4356
String batchStatus
字段名:批次状态 变量名:batch_status 是否必填:是 类型:string[1,32] 描述: 枚举值: WAIT_PAY:待付款,商户员工确认付款阶段 ACCEPTED:已受理。批次已受理成功,若发起批量转账的30分钟后,转账批次单仍处于该状态,可能原因是商户账户余额不足等。商户可查询账户资金流水,若该笔转账批次单的扣款已经发生,则表示批次已经进入转账中,请再次查单确认 PROCESSING:转账中。已开始处理批次内的转账明细单 FINISHED:已完成。批次内的所有转账明细单都已处理完成 CLOSED:已关闭。可查询具体的批次关闭原因确认 示例值:ACCEPTED
String batchType
字段名:批次类型 变量名:batch_type 是否必填:是 类型:string[1,32] 描述: 枚举值: API:API方式发起 WEB:页面方式发起 示例值:API
String batchName
字段名:批次名称 变量名:batch_name 是否必填:是 类型:string[1,32] 描述: 该笔批量转账的名称 示例值:2019年1月深圳分部报销单
String batchRemark
字段名:批次备注 变量名:batch_remark 是否必填:是 类型:string[1,32] 描述: 转账说明,UTF8编码,最多允许32个字符 示例值:2019年1月深圳分部报销单
String closeReason
字段名:批次关闭原因 变量名:close_reason 是否必填:否 类型:string[1,64] 描述: 如果批次单状态为“CLOSED”(已关闭),则有关闭原因 MERCHANT_REVOCATION:商户主动撤销 OVERDUE_CLOSE:系统超时关闭 示例值:OVERDUE_CLOSE
Integer totalAmount
字段名:转账总金额 变量名:total_amount 是否必填:是 类型:int 描述: 转账金额单位为分 示例值:4000000
Integer totalNum
字段名:转账总笔数 变量名:total_num 是否必填:是 类型:int 描述: 一个转账批次单最多发起三千笔转账 示例值:200
String createTime
字段名:批次创建时间 变量名:create_time 是否必填:否 类型:string[1,32] 描述: 批次受理成功时返回,遵循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
String updateTime
字段名:批次更新时间 变量名:update_time 是否必填:否 类型:string[1,32] 描述: 批次最近一次状态变更的时间,遵循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
Integer successAmount
字段名:转账成功金额 变量名:success_amount 是否必填:否 类型:int 描述: 转账成功的金额,单位为分。当批次状态为“PROCESSING”(转账中)时,转账成功金额随时可能变化 示例值:3900000
Integer successNum
字段名:转账成功笔数 变量名:success_num 是否必填:否 类型:int 描述: 转账成功的笔数。当批次状态为“PROCESSING”(转账中)时,转账成功笔数随时可能变化 示例值:199
Integer failAmount
字段名:转账失败金额 变量名:fail_amount 是否必填:否 类型:int 描述: 转账失败的金额,单位为分 示例值:100000
Integer failNum
字段名:转账失败笔数 变量名:fail_num 是否必填:否 类型:int 描述: 转账失败的笔数 示例值:1
String detailId
字段名:微信明细单号 变量名:detail_id 是否必填:是 类型:string[1,64] 描述: 微信支付系统内部区分转账批次单下不同转账明细单的唯一标识 示例值:1040000071100999991182020050700019500100
String outDetailNo
字段名:商家明细单号 变量名:out_detail_no 是否必填:是 类型:string[1,32] 描述: 商户系统内部区分转账批次单下不同转账明细单的唯一标识 示例值:x23zy545Bd5436
String detailStatus
字段名:明细状态 变量名:detail_status 是否必填:是 类型:string[1,32] 描述: 枚举值: PROCESSING:转账中。正在处理中,转账结果尚未明确 SUCCESS:转账成功 FAIL:转账失败。需要确认失败原因后,再决定是否重新发起对该笔明细单的转账(并非整个转账批次单) 示例值:SUCCESS
String acceptType
字段名:受理类型 变量名:accept_type 是否必填:是 类型:string[1,32] 描述: query电子回单受理类型: BATCH_TRANSFER:批量转账明细电子回单 TRANSFER_TO_POCKET:企业付款至零钱电子回单 TRANSFER_TO_BANK:企业付款至银行卡电子回单 示例值:BATCH_TRANSFER
String outBatchNo
字段名:商家转账批次单号 变量名:out_batch_no 是否必填:否 类型:string[5,32] 描述: query需要电子回单的批量转账明细单所在的转账批次单号,该单号为商户申请转账时生成的商户单号。受理类型为BATCH_TRANSFER时该单号必填,否则该单号留空。 示例值:GD2021011610162610BBdkkIwcu3
String outDetailNo
字段名:商家转账明细单号 变量名:out_detail_no 是否必填:是 类型:string[5,32] 描述: query该单号为商户申请转账时生成的商家转账明细单号。 1.受理类型为BATCH_TRANSFER时填写商家批量转账明细单号。 2. 受理类型为TRANSFER_TO_POCKET或TRANSFER_TO_BANK时填写商家转账单号。 示例值:mx0911231610162610v4CNkO4HAf
String acceptType
字段名:受理类型 变量名:accept_type 是否必填:是 类型:string[1,32] 描述: 电子回单受理类型: BATCH_TRANSFER:批量转账明细电子回单 TRANSFER_TO_POCKET:企业付款至零钱电子回单 TRANSFER_TO_BANK:企业付款至银行卡电子回单 示例值:BATCH_TRANSFER
String outBatchNo
字段名:商家转账批次单号 变量名:out_batch_no 是否必填:否 类型:string[5,32] 描述: 需要电子回单的批量转账明细单所在的转账批次单号,该单号为商户申请转账时生成的商户单号。受理类型为BATCH_TRANSFER时该单号必填,否则该单号留空。 示例值:GD2021011610162610BBdkkIwcu3
String outDetailNo
字段名:商家转账明细单号 变量名:out_detail_no 是否必填:是 类型:string[5,32] 描述: 该单号为商户申请转账时生成的商家转账明细单号。 1.受理类型为BATCH_TRANSFER时填写商家批量转账明细单号。 2. 受理类型为TRANSFER_TO_POCKET或TRANSFER_TO_BANK时填写商家转账单号。 示例值:mx0911231610162610v4CNkO4HAf
String signatureNo
字段名:电子回单受理单号 变量名:signature_no 是否必填:是 类型:string[3,256] 描述: 电子回单受理单号,受理单据的唯一标识 示例值:1050000010509999485212020110200058820001
String signatureStatus
字段名:电子回单状态 变量名:signature_status 是否必填:否 类型:string[1,10] 描述: 枚举值: ACCEPTED:已受理,电子签章已受理成功 FINISHED:已完成。电子签章已处理完成 示例值:ACCEPTED
String hashType
字段名:电子回单文件的hash方法 变量名:hash_type 是否必填:否 类型:string[1,20] 描述: 电子回单文件的hash方法,回单状态为:FINISHED时返回 示例值:SHA256
String hashValue
字段名:电子回单文件的hash值 变量名:hash_value 是否必填:否 类型:string[3,1000] 描述: 电子回单文件的hash值,用于下载之后验证文件的完整、正确性,回单状态为:FINISHED时返回 示例值:DE731F35146A0BEFADE5DB9D1E468D96C01CA8898119C674FEE9F11F4DBE5529
String downloadUrl
字段名:电子回单文件的下载地址 变量名:download_url 是否必填:否 类型:string[10,3000] 描述: 电子回单文件的下载地址,回单状态为:FINISHED时返回。URL有效时长为10分钟,10分钟后需要重新去获取下载地址(但不需要走受理) 示例值:https://api.mch.weixin.qq.com/v3/billdownload/file?token=xxx
String mchid
字段名:商户号 变量名:mchid 是否必填:是 类型:string[1,32] 描述: 微信支付分配的商户号 示例值:1900001109
String outBatchNo
字段名:商家批次单号 变量名:out_batch_no 是否必填:是 类型:string[1,32] 描述: 商户系统内部的商家批次单号,在商户系统内部唯一 示例值:plfk2020042013
String batchId
字段名:微信批次单号 变量名:batch_id 是否必填:是 类型:string[1,64] 描述: 微信批次单号,微信商家转账系统返回的唯一标识 示例值:1030000071100999991182020050700019480001
String appid
字段名:直连商户的appid 变量名:appid 是否必填:是 类型:string[1,32] 描述: 申请商户号的appid或商户号绑定的appid(企业号corpid即为此appid) 示例值:wxf636efh567hg4356
String outDetailNo
字段名:商家明细单号 变量名:out_detail_no 是否必填:是 类型:string[1,32] 描述: 商户系统内部区分转账批次单下不同转账明细单的唯一标识 示例值:x23zy545Bd5436
String detailId
字段名:微信明细单号 变量名:detail_id 是否必填:是 类型:string[1,64] 描述: 微信支付系统内部区分转账批次单下不同转账明细单的唯一标识 示例值:1040000071100999991182020050700019500100
String detailStatus
字段名:明细状态 变量名:detail_status 是否必填:是 类型:string[1,32] 描述: 枚举值: PROCESSING:转账中。正在处理中,转账结果尚未明确 SUCCESS:转账成功 FAIL:转账失败。需要确认失败原因后,再决定是否重新发起对该笔明细单的转账(并非整个转账批次单) 示例值:SUCCESS
Integer transferAmount
字段名:转账金额 变量名:transfer_amount 是否必填:是 类型:int 描述: 转账金额单位为分 示例值:200000
String transferRemark
字段名:转账备注 变量名:transfer_remark 是否必填:是 类型:string[1,32] 描述: 单条转账备注(微信用户会收到该备注),UTF8编码,最多允许32个字符 示例值:2020年4月报销
String failReason
字段名:明细失败原因 变量名:fail_reason 是否必填:否 类型:string[1,64] 描述: 如果转账失败则有失败原因 ACCOUNT_FROZEN:账户冻结 REAL_NAME_CHECK_FAIL:用户未实名 NAME_NOT_CORRECT:用户姓名校验失败 OPENID_INVALID:Openid校验失败 TRANSFER_QUOTA_EXCEED:超过用户单笔收款额度 DAY_RECEIVED_QUOTA_EXCEED:超过用户单日收款额度 MONTH_RECEIVED_QUOTA_EXCEED:超过用户单月收款额度 DAY_RECEIVED_COUNT_EXCEED:超过用户单日收款次数 PRODUCT_AUTH_CHECK_FAIL:产品权限校验失败 OVERDUE_CLOSE:转账关闭 ID_CARD_NOT_CORRECT:用户身份证校验失败 ACCOUNT_NOT_EXIST:用户账户不存在 TRANSFER_RISK:转账存在风险 REALNAME_ACCOUNT_RECEIVED_QUOTA_EXCEED:用户账户收款受限,请引导用户在微信支付查看详情 RECEIVE_ACCOUNT_NOT_PERMMIT:未配置该用户为转账收款人 PAYER_ACCOUNT_ABNORMAL:商户账户付款受限,可前往商户平台-违约记录获取解除功能限制指引 PAYEE_ACCOUNT_ABNORMAL:用户账户收款异常,请引导用户完善其在微信支付的身份信息以继续收款 示例值:ACCOUNT_FROZEN
String openid
字段名:用户在直连商户应用下的用户标示 变量名:openid 是否必填:是 类型:string[1,128] 描述: 用户在直连商户appid下的唯一标识 示例值:o-MYE42l80oelYMDE34nYD456Xoy
String userName
字段名:收款用户姓名 变量名:user_name 是否必填:否 类型:string[1,1024] 描述: 1、商户转账时传入了收款用户姓名、查询时会返回收款用户姓名; 2、收款方姓名采用标准RSA算法,公钥由微信侧提供 3、 该字段需进行加密处理,加密方法详见敏感信息加密说明。(提醒:必须在HTTP头中上送Wechatpay-Serial) 示例值:757b340b45ebef5467rter35gf464344v3542sdf4t6re4tb4f54ty45t4yyry45
String initiateTime
字段名:转账发起时间 变量名:initiate_time 是否必填:是 类型:string[1,32] 描述: 转账发起的时间,遵循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
String updateTime
字段名:明细更新时间 变量名:update_time 是否必填:是 类型:string[1,32] 描述: 明细最后一次状态变更的时间,遵循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
String outBatchNo
字段名:商家批次单号 变量名:out_batch_no 是否必填:是 类型:string[5,32] 描述: body商户系统内部的商家批次单号,在商户系统内部唯一。需要电子回单的批次单号 示例值:plfk2020042013
String outBatchNo
字段名:商家批次单号 变量名:out_batch_no 是否必填:是 类型:string[5,32] 描述: body商户系统内部的商家批次单号,在商户系统内部唯一。需要电子回单的批次单号 示例值:plfk2020042013
String signatureNo
字段名:电子回单申请单号 变量名:signature_no 是否必填:是 类型:string[3,45] 描述: 电子回单申请单号,申请单据的唯一标识 示例值:1050000010509999485212020110200058820001
String signatureStatus
字段名:电子回单状态 变量名:signature_status 是否必填:否 类型:string[1,10] 描述: 枚举值: ACCEPTED:已受理,电子签章已受理成功 FINISHED:已完成。电子签章已处理完成 示例值:ACCEPTED
String hashType
字段名:电子回单文件的hash方法 变量名:hash_type 是否必填:否 类型:string[1,20] 描述: 电子回单文件的hash方法,回单状态为:FINISHED时返回。 示例值:SHA256
String hashValue
字段名:电子回单文件的hash值 变量名:hash_value 是否必填:否 类型:string[3,1000] 描述: 电子回单文件的hash值,用于下载之后验证文件的完整、正确性,回单状态为:FINISHED时返回。 示例值:DE731F35146A0BEFADE5DB9D1E468D96C01CA8898119C674FEE9F11F4DBE5529
String downloadUrl
字段名:电子回单文件的下载地址 变量名:download_url 是否必填:否 类型:string[10,3000] 描述: 电子回单文件的下载地址,回单状态为:FINISHED时返回。URL有效时长为10分钟,10分钟后需要重新去获取下载地址(但不需要走受理) 示例值:https://api.mch.weixin.qq.com/v3/billdownload/file?token=xxx
String createTime
字段名:创建时间 变量名:create_time 是否必填:否 类型:string[1,32] 描述: 电子签章单创建时间,遵循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秒 示例值:2020-05-20T13:29:35.120+08:00
String updateTime
字段名:更新时间 变量名:update_time 是否必填:否 类型:string[1,32] 描述: 电子签章单最近一次状态变更的时间,遵循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秒 示例值:2020-05-21T13:29:35.120+08:00
String outBatchNo
字段名:商家批次单号 变量名:out_batch_no 是否必填:是 类型:string[1,32] 描述: path商户系统内部的商家批次单号,要求此参数只能由数字、大小写字母组成,在商户系统内部唯一 示例值:plfk2020042013
Boolean needQueryDetail
字段名:是否查询转账明细单 变量名:need_query_detail 是否必填:是 类型:boolean 描述: query枚举值: true:是; false:否,默认否。 商户可选择是否查询指定状态的转账明细单,当转账批次单状态为“FINISHED”(已完成)时,才会返回满足条件的转账明细单 示例值:true
Integer offset
字段名:请求资源起始位置 变量名:offset 是否必填:否 类型:int 描述: query该次请求资源的起始位置,从0开始,默认值为0
Integer limit
字段名:最大资源条数 变量名:limit 是否必填:否 类型:int 描述: query该次请求可返回的最大明细条数,最小20条,最大100条,不传则默认20条。不足20条按实际条数返回 示例值:20
String detailStatus
字段名:明细状态 变量名:detail_status 是否必填:否 类型:string[1,32] 描述: query查询指定状态的转账明细单,当need_query_detail为true时,该字段必填 ALL:全部。需要同时查询转账成功和转账失败的明细单 SUCCESS:转账成功。只查询转账成功的明细单 FAIL:转账失败。只查询转账失败的明细单 示例值:FAIL
String outDetailNo
字段名:商家明细单号 变量名:out_detail_no 是否必填:是 类型:string[1,32] 描述: path商户系统内部区分转账批次单下不同转账明细单的唯一标识,要求此参数只能由数字、大小写字母组成 示例值:x23zy545Bd5436
String outBatchNo
字段名:商家批次单号 变量名:out_batch_no 是否必填:是 类型:string[1,32] 描述: path商户系统内部的商家批次单号,要求此参数只能由数字、大小写字母组成,在商户系统内部唯一 示例值:plfk2020042013
String appid
字段名:直连商户的appid 变量名:appid 是否必填:是 类型:string[1,32] 描述: 申请商户号的appid或商户号绑定的appid(企业号corpid即为此appid) 示例值:wxf636efh567hg4356
String outBatchNo
字段名:商家批次单号 变量名:out_batch_no 是否必填:是 类型:string[1,32] 描述: path商户系统内部的商家批次单号,要求此参数只能由数字、大小写字母组成,在商户系统内部唯一 示例值:plfk2020042013
String batchName
字段名:批次名称 变量名:batch_name 是否必填:是 类型:string[1,32] 描述: 该笔批量转账的名称 示例值:2019年1月深圳分部报销单
String batchRemark
字段名:批次备注 变量名:batch_remark 是否必填:是 类型:string[1,32] 描述: 转账说明,UTF8编码,最多允许32个字符 示例值:2019年1月深圳分部报销单
Integer totalAmount
字段名:转账总金额 变量名:total_amount 是否必填:是 类型:int 描述: 转账金额单位为分 示例值:4000000
Integer totalNum
字段名:转账总笔数 变量名:total_num 是否必填:是 类型:int 描述: 一个转账批次单最多发起三千笔转账 示例值:200
List<E> transferDetailList
字段名:转账明细单列表 变量名:transfer_detail_list 是否必填:否 类型:array 描述: body发起批量转账的明细列表,最多三千笔
String transferSceneId
字段名:转账场景ID 变量名:transfer_scene_id 是否必填:否 类型:string(36) 描述: 该批次转账使用的转账场景,如不填写则使用商家的默认场景,如无默认场景可为空,可前往“商家转账到零钱-前往功能”中申请。 示例值:1001
String notifyUrl
字段名:通知地址
变量名:notify_url
是否必填:否
类型:string(256)
描述:
异步接收微信支付结果通知的回调地址,通知url必须为公网可访问的url,必须为https,不能携带参数。
回调解析: WxPayService.parseTransferBatchesNotifyV3Result(java.lang.String, com.github.binarywang.wxpay.bean.notify.SignatureHeader)
String outDetailNo
字段名:商家明细单号 变量名:out_detail_no 是否必填:是 类型:string[1,32] 描述: 商户系统内部区分转账批次单下不同转账明细单的唯一标识 示例值:x23zy545Bd5436
Integer transferAmount
字段名:转账金额 变量名:transfer_amount 是否必填:是 类型:int 描述: 转账金额单位为分 示例值:200000
String transferRemark
字段名:转账备注 变量名:transfer_remark 是否必填:是 类型:string[1,32] 描述: 单条转账备注(微信用户会收到该备注),UTF8编码,最多允许32个字符 示例值:2020年4月报销
String openid
字段名:用户在直连商户应用下的用户标示 变量名:openid 是否必填:是 类型:string[1,128] 描述: 用户在直连商户appid下的唯一标识 示例值:o-MYE42l80oelYMDE34nYD456Xoy
String userName
字段名:收款用户姓名 变量名:user_name 是否必填:否 类型:string[1,1024] 描述: 1、商户转账时传入了收款用户姓名、查询时会返回收款用户姓名; 2、收款方姓名采用标准RSA算法,公钥由微信侧提供 3、 该字段需进行加密处理,加密方法详见敏感信息加密说明。(提醒:必须在HTTP头中上送Wechatpay-Serial) 示例值:757b340b45ebef5467rter35gf464344v3542sdf4t6re4tb4f54ty45t4yyry45
String outBatchNo
字段名:商家批次单号 变量名:out_batch_no 是否必填:是 类型:string[1,32] 描述: 商户系统内部的商家批次单号,在商户系统内部唯一 示例值:plfk2020042013
String batchId
字段名:微信批次单号 变量名:batch_id 是否必填:是 类型:string[1,32] 描述: 微信批次单号,微信商家转账系统返回的唯一标识 示例值:1030000071100999991182020050700019480001
String createTime
字段名:批次创建时间 变量名:create_time 是否必填:否 类型:string[1,32] 描述: 批次受理成功时返回,遵循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
String batchStatus
String batchId
字段名:微信批次单号 变量名:batch_id 是否必填:是 类型:string[1,64] 描述: path微信批次单号,微信商家转账系统返回的唯一标识 示例值:1030000071100999991182020050700019480001
Boolean needQueryDetail
字段名:是否查询转账明细单 变量名:need_query_detail 是否必填:是 类型:boolean 描述: query枚举值: true:是; false:否,默认否。 商户可选择是否查询指定状态的转账明细单,当转账批次单状态为“FINISHED”(已完成)时,才会返回满足条件的转账明细单 示例值:true
Integer offset
字段名:请求资源起始位置 变量名:offset 是否必填:否 类型:int 描述: query该次请求资源的起始位置,从0开始,默认值为0
Integer limit
字段名:最大资源条数 变量名:limit 是否必填:否 类型:int 描述: query该次请求可返回的最大明细条数,最小20条,最大100条,不传则默认20条。不足20条按实际条数返回 示例值:20
String detailStatus
字段名:明细状态 变量名:detail_status 是否必填:否 类型:string[1,32] 描述: query查询指定状态的转账明细单,当need_query_detail为true时,该字段必填 ALL:全部。需要同时查询转账成功和转账失败的明细单 SUCCESS:转账成功。只查询转账成功的明细单 FAIL:转账失败。只查询转账失败的明细单 示例值:FAIL
String batchId
字段名:微信批次单号 变量名:batch_id 是否必填:是 类型:string[1,64] 描述: path微信批次单号,微信商家转账系统返回的唯一标识 示例值:1030000071100999991182020050700019480001
String detailId
字段名:微信明细单号 变量名:detail_id 是否必填:是 类型:string[1,64] 描述: path微信支付系统内部区分转账批次单下不同转账明细单的唯一标识 示例值:1040000071100999991182020050700019500100
OriginNotifyResponse rawData
CombineNotifyResult.DecryptNotifyResult result
Integer totalAmount
字段名:标价金额 变量名:total_amount 是否必填:是 类型:int64 描述: 子单金额,单位为分。 示例值:100
String currency
字段名:标价币种 变量名:currency 是否必填:是 类型:string[1,8] 描述: 符合ISO 4217标准的三位字母代码,人民币:CNY。 示例值:CNY
Integer payerAmount
字段名:现金支付金额 变量名:payer_amount 是否必填:是 类型:int64 描述: 订单现金支付金额。 示例值:10
String payerCurrency
字段名:现金支付币种 变量名:payer_currency 是否必填:是 类型:string[1,8] 描述: 货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY。 示例值: CNY
String openid
字段名:用户标识 变量名:openid 是否必填:是 类型:string[1,128] 描述: 使用合单appid获取的对应用户openid。是用户在商户appid下的唯一标识。 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
String combineAppid
字段名:合单商户appid 变量名:combine_appid 是否必填:是 类型:string[1,32] 描述: 合单发起方的appid。 示例值:wxd678efh567hg6787
String combineMchid
字段名:合单商户号 变量名:combine_mchid 是否必填:是 类型:string[1,32] 描述: 合单发起方商户号。 示例值:1900000109
String combineOutTradeNo
字段名:合单商户订单号 变量名:combine_out_trade_no 是否必填:是 类型:string[1,32] 描述: 合单支付总订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一。 示例值:P20150806125346
CombineNotifyResult.SceneInfo sceneInfo
字段名:场景信息 变量名:scene_info 是否必填:否 类型:object 描述: 支付场景信息描述
List<E> subOrders
字段名:子单信息 变量名:sub_orders 是否必填:是 类型:array 描述: 最多支持子单条数:10
CombineNotifyResult.CombinePayerInfo combinePayerInfo
字段名:支付者 变量名:combine_payer_info 是否必填:否 类型:object 描述: 示例值:见请求示例
String goodsId
字段名:商品编码 变量名:goods_id 是否必填:是 类型:string[1, 32] 描述: 商品编码 示例值:M1006
Integer quantity
字段名:商品数量 变量名:quantity 是否必填:是 类型:int 描述: 商品数量 示例值:1
Integer unitPrice
字段名:商品单价 变量名:unit_price 是否必填:是 类型:int 描述: 商品价格 示例值:100
Integer discountAmount
字段名:商品优惠金额 变量名:discount_amount 是否必填:是 类型:int 描述: 商品优惠金额 示例值:1
String goodsRemark
字段名:商品备注 变量名:goods_remark 是否必填:否 类型:string[1, 128] 描述: 商品备注 示例值:商品备注信息
String couponId
字段名:券ID 变量名:coupon_id 是否必填:是 类型:string[1, 32] 描述: 券ID 示例值:109519
String name
字段名:优惠名称 变量名:name 是否必填:否 类型:string[1, 64] 描述: 优惠名称 示例值:单品惠-6
String scope
字段名:优惠范围 变量名:scope 是否必填:否 类型:string[1, 32] 描述: GLOBAL:全场代金券 SINGLE:单品优惠 示例值:GLOBALSINGLE
String type
字段名:优惠类型 变量名:type 是否必填:否 类型:string[1,8] 描述: CASH:充值; NOCASH:预充值。 示例值:CASH
Integer amount
字段名:优惠券面额 变量名:amount 是否必填:是 类型:int 描述: 当前子单中享受的优惠券金额 示例值:100
String stockId
字段名:活动ID 变量名:stock_id 是否必填:否 类型:string[1, 32] 描述: 活动ID,批次ID 示例值:931386
Integer wechatpayContribute
字段名:微信出资 变量名:wechatpay_contribute 是否必填:否 类型:int 描述: 单位为分 示例值:100
Integer merchantContribute
字段名:商户出资 变量名:merchant_contribute 是否必填:否 类型:int 描述: 单位为分 示例值:100
Integer otherContribute
字段名:其他出资 变量名:other_contribute 是否必填:否 类型:int 描述: 单位为分 示例值:100
String currency
字段名:优惠币种 变量名:currency 是否必填:否 类型:string[1,16] 描述: CNY:人民币,境内商户号仅支持人民币。 示例值:CNY
List<E> goodsDetail
字段名:单品列表 变量名:goods_detail 是否必填:否 类型:array 描述: 单品列表信息
String deviceId
字段名:商户端设备号 变量名:device_id 是否必填:否 类型:string[7,16] 描述: 终端设备号(门店号或收银设备ID)。 特殊规则:长度最小7个字节 示例值:POS1:1
String mchid
字段名:子单商户号 变量名:mchid 是否必填:是 类型:string[1,32] 描述: 子单发起方商户号,必须与发起方Appid有绑定关系。 示例值:1900000109
String tradeType
字段名:交易类型 变量名:trade_type 是否必填:是 类型:string[1,16] 描述: 枚举值: NATIVE:扫码支付 JSAPI:公众号支付 APP:APP支付 MWEB:H5支付 示例值: JSAPI
String tradeState
字段名:交易状态 变量名:trade_state 是否必填:是 类型:string[1,32] 描述: 枚举值: SUCCESS:支付成功 REFUND:转入退款 NOTPAY:未支付 CLOSED:已关闭 USERPAYING:用户支付中 PAYERROR:支付失败(其他原因,如银行返回失败) 示例值: SUCCESS
String bankType
字段名:付款银行 变量名:bank_type 是否必填:否 类型:string[1,16] 描述: 银行类型,采用字符串类型的银行标识。银行标识请参考《银行类型对照表》https://pay.weixin.qq.com/wiki/doc/apiv3/terms_definition/chapter1_1_3.shtml#part-6 示例值:CMC
String attach
字段名:附加信息 变量名:attach 是否必填:是 类型:string[1,128] 描述: 附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用。 示例值:深圳分店
String successTime
字段名:支付完成时间 变量名:success_time 是否必填:是 类型:string[1,32] 描述: 订单支付时间,遵循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年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35.120+08:00
String transactionId
字段名:微信订单号 变量名:transaction_id 是否必填:是 类型:string[1,32] 描述: 微信支付订单号。 示例值: 1009660380201506130728806387
String outTradeNo
字段名:子单商户订单号 变量名:out_trade_no 是否必填:是 类型:string[6,32] 描述: 商户系统内部订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一。 特殊规则:最小字符长度为6 示例值:20150806125346
String subAppid
字段名:子商户应用ID 变量名:sub_appid 是否必填:是 类型:string[1,32] 描述: 子商户申请的应用ID,全局唯一。请求基础下单接口时请注意APPID的应用属性,例如公众号场景下, 需使用应用属性为公众号的APPID 若sub_openid有传的情况下, sub_appid必填,且sub_appid需与sub_openid对应 示例值:wxd678efh567hg6999
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string[1,32] 描述: 二级商户商户号,由微信支付生成并下发。服务商子商户的商户号,被合单方。直连商户不用传二级商户号。 示例值:1900000109
CombineNotifyResult.Amount amount
字段名:订单金额 变量名:amount 是否必填:是 类型:object 描述: 订单金额信息
List<E> promotionDetail
字段名:优惠功能 变量名:promotion_detail 是否必填:是 类型:array 描述: 优惠功能,子单有核销优惠券时有返回
OriginNotifyResponse rawData
ComplaintNotifyResult.DecryptNotifyResult result
String complaintId
字段名:投诉单号 是否必填:是 描述: 投诉单对应的投诉单号
String actionType
字段名:动作类型 是否必填:是 描述: 触发本次投诉通知回调的具体动作类型,枚举如下: 常规通知: CREATE_COMPLAINT:用户提交投诉 CONTINUE_COMPLAINT:用户继续投诉 USER_RESPONSE:用户新留言 RESPONSE_BY_PLATFORM:平台新留言 SELLER_REFUND:商户发起全额退款 MERCHANT_RESPONSE:商户新回复 MERCHANT_CONFIRM_COMPLETE:商户反馈处理完成 USER_APPLY_PLATFORM_SERVICE:用户申请平台协助 USER_CANCEL_PLATFORM_SERVICE:用户取消平台协助 PLATFORM_SERVICE_FINISHED:客服结束平台协助 申请退款单的附加通知: 以下通知会更新投诉单状态,建议收到后查询投诉单详情。 MERCHANT_APPROVE_REFUND:商户同意退款 MERCHANT_REJECT_REFUND:商户驳回退款 REFUND_SUCCESS:退款到账
String id
字段名:通知ID 变量名:id 是否必填:是 类型:string[1,36] 描述: 通知的唯一ID 示例值:EV-2018022511223320873
String createTime
字段名:通知创建时间 变量名:create_time 是否必填:是 类型:string[1,32] 描述: 通知创建的时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。 示例值:2018-06-08T10:34:56+08:00
String eventType
字段名:通知类型 变量名:event_type 是否必填:是 类型:string[1,32] 描述: 通知的类型: REFUND.SUCCESS:退款成功通知 REFUND.ABNORMAL:退款异常通知 REFUND.CLOSED:退款关闭通知 示例值:REFUND.SUCCESS
String summary
字段名:通知简要说明 变量名:summary 是否必填:是 类型:string[1,16] 描述: 通知简要说明 示例值:退款成功
String resourceType
字段名:通知数据类型 变量名:resource_type 是否必填:是 类型:string[1,32] 描述: 通知的资源数据类型,支付成功通知为encrypt-resource 示例值:encrypt-resource
OriginNotifyResponse.Resource resource
字段名:通知数据 变量名:resource 是否必填:是 类型:object 描述: 通知资源数据 json格式,见示例
String algorithm
字段名:加密算法类型 变量名:algorithm 是否必填:是 类型:string[1,32] 描述: 对开启结果数据进行加密的加密算法,目前只支持AEAD_AES_256_GCM 示例值:AEAD_AES_256_GCM
String originalType
字段名:原始类型 变量名:original_type 是否必填:是 类型:string[1,16] 描述: 原始回调类型,为transaction 示例值:transaction
String ciphertext
字段名:数据密文 变量名:ciphertext 是否必填:是 类型:string[1,1048576] 描述: Base64编码后的开启/停用结果数据密文 示例值:sadsadsadsad
String associatedData
字段名:附加数据 变量名:associated_data 是否必填:否 类型:string[1,16] 描述: 附加数据 示例值:fdasfwqewlkja484w
String nonce
字段名:随机串 变量名:nonce 是否必填:是 类型:string[1,16] 描述: 加密使用的随机串 示例值:fdasflkja484w
OriginNotifyResponse rawData
WxPayNotifyV3Result.DecryptNotifyResult result
Integer total
字段名:总金额 变量名:total 是否必填:否 类型:int 描述: 订单总金额,单位为分。 示例值:100
Integer payerTotal
字段名:用户支付金额 变量名:payer_total 是否必填:否 类型:int 描述: 用户支付金额,单位为分。 示例值:100
String currency
字段名:货币类型 变量名:currency 是否必填:否 类型:string[1,16] 描述: CNY:人民币,境内商户号仅支持人民币。 示例值:CNY
String payerCurrency
字段名:用户支付币种 变量名:payer_currency 是否必填:否 类型:string[1,16] 描述: 用户支付币种 示例值: CNY
String appid
字段名:应用ID 变量名:appid 是否必填:是 类型:string[1,32] 描述: 直连商户申请的公众号或移动应用appid。 示例值:wxd678efh567hg6787
String mchid
字段名:商户号 变量名:mchid 是否必填:是 类型:string[1,32] 描述: 商户系统内部订单号,只能是数字、大小写字母_-*且在同一个商户号下唯一。 特殊规则:最小字符长度为6 示例值:1217752501201407033233368018
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string[6,32] 描述: 商户系统内部订单号,只能是数字、大小写字母_-*且在同一个商户号下唯一。 特殊规则:最小字符长度为6 示例值:1217752501201407033233368018
String transactionId
字段名:微信支付订单号 变量名:transaction_id 是否必填:是 类型:string[1,32] 描述: 微信支付系统生成的订单号。 示例值:1217752501201407033233368018
String tradeType
字段名:交易类型 变量名:trade_type 是否必填:是 类型:string[1,16] 描述: 交易类型,枚举值: JSAPI:公众号支付 NATIVE:扫码支付 APP:APP支付 MICROPAY:付款码支付 MWEB:H5支付 FACEPAY:刷脸支付 示例值:MICROPAY
String tradeState
字段名:交易状态 变量名:trade_state 是否必填:是 类型:string[1,32] 描述: 交易状态,枚举值: SUCCESS:支付成功 REFUND:转入退款 NOTPAY:未支付 CLOSED:已关闭 REVOKED:已撤销(付款码支付) USERPAYING:用户支付中(付款码支付) PAYERROR:支付失败(其他原因,如银行返回失败) 示例值:SUCCESS
String tradeStateDesc
字段名:交易状态描述 变量名:trade_state_desc 是否必填:是 类型:string[1,256] 描述: 交易状态描述 示例值:支付成功
String bankType
字段名:付款银行 变量名:bank_type 是否必填:是 类型:string[1,16] 描述: 银行类型,采用字符串类型的银行标识。银行标识请参考《银行类型对照表》https://pay.weixin.qq.com/wiki/doc/apiv3/terms_definition/chapter1_1_3.shtml#part-6 示例值:CMC
String attach
字段名:附加数据 变量名:attach 是否必填:否 类型:string[1,128] 描述: 附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用 示例值:自定义数据
String successTime
字段名:支付完成时间 变量名:success_time 是否必填:是 类型:string[1,64] 描述: 支付完成时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2018-06-08T10:34:56+08:00
WxPayNotifyV3Result.Payer payer
字段名:支付者 变量名:payer 是否必填:是 类型:object 描述: 支付者信息
WxPayNotifyV3Result.Amount amount
字段名:订单金额 变量名:amount 是否必填:否 类型:object 描述: 订单金额信息
WxPayNotifyV3Result.SceneInfo sceneInfo
字段名:场景信息 变量名:scene_info 是否必填:否 类型:object 描述: 支付场景信息描述
List<E> promotionDetails
字段名:优惠功能 变量名:promotion_detail 是否必填:否 类型:array 描述: 优惠功能,享受优惠时返回该字段。
String goodsId
字段名:商品编码 变量名:goods_id 是否必填:是 类型:string[1,32] 描述: 商品编码 示例值:M1006
Integer quantity
字段名:商品数量 变量名:quantity 是否必填:是 类型:int 描述: 用户购买的数量 示例值:1
Integer unitPrice
字段名:商品单价 变量名:unit_price 是否必填:是 类型:int 描述: 商品单价,单位为分 示例值:100
Integer discountAmount
字段名:商品优惠金额 变量名:discount_amount 是否必填:是 类型:int 描述: 商品优惠金额 示例值:0
String goodsRemark
字段名:商品备注 变量名:goods_remark 是否必填:否 类型:string[1,128] 描述: 商品备注信息 示例值:商品备注信息
String openid
字段名:用户标识 变量名:openid 是否必填:是 类型:string[1,128] 描述: 用户在直连商户appid下的唯一标识。 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
String couponId
字段名:券ID 变量名:coupon_id 是否必填:是 类型:string[1,32] 描述: 券ID 示例值:109519
String name
字段名:优惠名称 变量名:name 是否必填:否 类型:string[1,64] 描述: 优惠名称 示例值:单品惠-6
String scope
字段名:优惠范围 变量名:scope 是否必填:否 类型:string[1,32] 描述: GLOBAL:全场代金券 SINGLE:单品优惠 示例值:GLOBAL
String type
字段名:优惠类型 变量名:type 是否必填:否 类型:string[1,32] 描述: CASH:充值 NOCASH:预充值 示例值:CASH
Integer amount
字段名:优惠券面额 变量名:amount 是否必填:是 类型:int 描述: 优惠券面额 示例值:100
String stockId
字段名:活动ID 变量名:stock_id 是否必填:否 类型:string[1,32] 描述: 活动ID 示例值:931386
Integer wechatpayContribute
字段名:微信出资 变量名:wechatpay_contribute 是否必填:否 类型:int 描述: 微信出资,单位为分 示例值:0
Integer merchantContribute
字段名:商户出资 变量名:merchant_contribute 是否必填:否 类型:int 描述: 商户出资,单位为分 示例值:0
Integer otherContribute
字段名:其他出资 变量名:other_contribute 是否必填:否 类型:int 描述: 其他出资,单位为分 示例值:0
String currency
字段名:优惠币种 变量名:currency 是否必填:否 类型:string[1,16] 描述: CNY:人民币,境内商户号仅支持人民币。 示例值:CNY
List<E> goodsDetails
字段名:单品列表 变量名:goods_detail 是否必填:否 类型:array 描述: 单品列表信息
String deviceId
字段名:商户端设备号 变量名:device_id 是否必填:否 类型:string[1,32] 描述: 终端设备号(门店号或收银设备ID)。 示例值:013467007045764
String promotionDetail
字段名:营销详情. 变量名:promotion_detail 是否必填:否,单品优惠才有 类型:String(6000) 示例值:[{"promotion_detail":[{"promotion_id":"109519","name":"单品惠-6","scope":"SINGLE","type":"DISCOUNT","amount":5,"activity_id":"931386","wxpay_contribute":0,"merchant_contribute":0,"other_contribute":5,"goods_detail":[{"goods_id":"a_goods1","goods_remark":"商品备注","quantity":7,"price":1,"discount_amount":4},{"goods_id":"a_goods2","goods_remark":"商品备注","quantity":1,"price":2,"discount_amount":1}]}]} 描述:单品优惠专用参数,详见https://pay.weixin.qq.com/wiki/doc/api/danpin.php?chapter=9_203&index=4
String deviceInfo
字段名:设备号. 变量名:device_info 是否必填:否 类型:String(32) 示例值:013467007045764 描述:微信支付分配的终端设备号,
String openid
字段名:用户标识. 变量名:openid 是否必填:是 类型:String(128) 示例值:wxd930ea5d5a258f4f 描述:用户在商户appid下的唯一标识
String isSubscribe
字段名:是否关注公众账号. 变量名:is_subscribe 是否必填:否 类型:String(1) 示例值:Y 描述:用户是否关注公众账号,Y-关注,N-未关注,仅在公众账号类型支付有效
String subOpenid
字段名:用户子标识. 变量名:sub_openid 是否必填:是 类型:String(128) 示例值:wxd930ea5d5a258f4f 描述:用户在子商户appid下的唯一标识
String subIsSubscribe
字段名:是否关注子公众账号. 变量名:sub_is_subscribe 是否必填:否 类型:String(1) 示例值:Y 描述:用户是否关注子公众账号,Y-关注,N-未关注,仅在公众账号类型支付有效
String tradeType
字段名:交易类型. 变量名:trade_type 是否必填:是 类型:String(16) 示例值:JSAPI 描述:JSAPI、NATIVE、APP
String bankType
字段名:付款银行. 变量名:bank_type 是否必填:是 类型:String(16) 示例值:CMC 描述:银行类型,采用字符串类型的银行标识,银行类型见银行列表
Integer totalFee
字段名:订单金额. 变量名:total_fee 是否必填:是 类型:Int 示例值:100 描述:订单总金额,单位为分
Integer settlementTotalFee
字段名:应结订单金额. 变量名:settlement_total_fee 是否必填:否 类型:Int 示例值:100 描述:应结订单金额=订单金额-非充值代金券金额,应结订单金额<=订单金额。
String feeType
字段名:货币种类. 变量名:fee_type 是否必填:否 类型:String(8) 示例值:CNY 描述:货币类型,符合ISO4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型
Integer cashFee
字段名:现金支付金额. 变量名:cash_fee 是否必填:是 类型:Int 示例值:100 描述:现金支付金额订单现金支付金额,详见支付金额
String cashFeeType
字段名:现金支付货币类型. 变量名:cash_fee_type 是否必填:否 类型:String(16) 示例值:CNY 描述:货币类型,符合ISO4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型
Integer couponFee
字段名:总代金券金额. 变量名:coupon_fee 是否必填:否 类型:Int 示例值:10 描述:代金券金额<=订单金额,订单金额-代金券金额=现金支付金额,详见支付金额
Integer couponCount
字段名:代金券使用数量. 变量名:coupon_count 是否必填:否 类型:Int 示例值:1 描述:代金券使用数量
List<E> couponList
String transactionId
字段名:微信支付订单号. 变量名:transaction_id 是否必填:是 类型:String(32) 示例值:1217752501201407033233368018 描述:微信支付订单号
String outTradeNo
字段名:商户订单号. 变量名:out_trade_no 是否必填:是 类型:String(32) 示例值:1212321211201407033568112322 描述:商户系统的订单号,与请求一致。
String attach
字段名:商家数据包. 变量名:attach 是否必填:否 类型:String(128) 示例值:123456 描述:商家数据包,原样返回
String timeEnd
字段名:支付完成时间. 变量名:time_end 是否必填:是 类型:String(14) 示例值:20141030133525 描述:支付完成时间,格式为yyyyMMddHHmmss,如2009年12月25日9点10分10秒表示为20091225091010。其他详见时间规则
String version
字段名:接口版本号. 变量名:version 类型:String(32) 示例值:1.0 更多信息,详见文档:https://pay.weixin.qq.com/wiki/doc/api/danpin.php?chapter=9_101&index=1
String rateValue
字段名:汇率. 变量名:rate_value 类型:String(16) 示例值:650000000 标价币种与支付币种的兑换比例乘以10的8次方即为此值,例如美元兑换人民币的比例为6.5,则rate_value=650000000
String signType
字段名:签名类型. 变量名:sign_type 类型:String(32) 示例值:HMAC-SHA256 签名类型,目前支持HMAC-SHA256和MD5,默认为MD5
OriginNotifyResponse rawData
WxPayPartnerNotifyV3Result.DecryptNotifyResult result
Integer total
字段名:总金额 变量名:total 是否必填:否 类型:int 描述: 订单总金额,单位为分。 示例值:100
Integer payerTotal
字段名:用户支付金额 变量名:payer_total 是否必填:否 类型:int 描述: 用户支付金额,单位为分。 示例值:100
String currency
字段名:货币类型 变量名:currency 是否必填:否 类型:string[1,16] 描述: CNY:人民币,境内商户号仅支持人民币。 示例值:CNY
String payerCurrency
字段名:用户支付币种 变量名:payer_currency 是否必填:否 类型:string[1,16] 描述: 用户支付币种 示例值: CNY
String spAppid
字段名:服务商应用ID 变量名:spAppid 是否必填:是 类型:string[1,32] 描述: 由微信生成的应用ID,全局唯一。请求统一下单接口时请注意APPID的应用属性,例如公众号场景下,需使用应用属性为公众号的APPID 示例值:wxd678efh567hg6787
String spMchid
字段名:服务商商户号 变量名:spMchid 是否必填:是 类型:string[1,32] 描述: 服务商商户号,由微信支付生成并下发。 示例值:1230000109
String subAppid
字段名:子商户应用ID 变量名:subAppid 是否必填:否 类型:string[1,32] 描述: 由微信生成的应用ID,全局唯一。请求统一下单接口时请注意APPID的应用属性,例如公众号场景下,需使用应用属性为公众号的APPID 示例值:wxd678efh567hg6787
String subMchid
字段名:子商户商户号 变量名:subMchid 是否必填:是 类型:string[1,32] 描述: 子商户商户号,由微信支付生成并下发。 示例值:1230000109
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string[6,32] 描述: 商户系统内部订单号,只能是数字、大小写字母_-*且在同一个商户号下唯一。 特殊规则:最小字符长度为6 示例值:1217752501201407033233368018
String transactionId
字段名:微信支付订单号 变量名:transaction_id 是否必填:是 类型:string[1,32] 描述: 微信支付系统生成的订单号。 示例值:1217752501201407033233368018
String tradeType
字段名:交易类型 变量名:trade_type 是否必填:是 类型:string[1,16] 描述: 交易类型,枚举值: JSAPI:公众号支付 NATIVE:扫码支付 APP:APP支付 MICROPAY:付款码支付 MWEB:H5支付 FACEPAY:刷脸支付 示例值:MICROPAY
String tradeState
字段名:交易状态 变量名:trade_state 是否必填:是 类型:string[1,32] 描述: 交易状态,枚举值: SUCCESS:支付成功 REFUND:转入退款 NOTPAY:未支付 CLOSED:已关闭 REVOKED:已撤销(付款码支付) USERPAYING:用户支付中(付款码支付) PAYERROR:支付失败(其他原因,如银行返回失败) 示例值:SUCCESS
String tradeStateDesc
字段名:交易状态描述 变量名:trade_state_desc 是否必填:是 类型:string[1,256] 描述: 交易状态描述 示例值:支付成功
String bankType
字段名:付款银行 变量名:bank_type 是否必填:是 类型:string[1,16] 描述: 银行类型,采用字符串类型的银行标识。银行标识请参考《银行类型对照表》https://pay.weixin.qq.com/wiki/doc/apiv3/terms_definition/chapter1_1_3.shtml#part-6 示例值:CMC
String attach
字段名:附加数据 变量名:attach 是否必填:否 类型:string[1,128] 描述: 附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用 示例值:自定义数据
String successTime
字段名:支付完成时间 变量名:success_time 是否必填:是 类型:string[1,64] 描述: 支付完成时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2018-06-08T10:34:56+08:00
WxPayPartnerNotifyV3Result.Payer payer
字段名:支付者 变量名:payer 是否必填:是 类型:object 描述: 支付者信息
WxPayPartnerNotifyV3Result.Amount amount
字段名:订单金额 变量名:amount 是否必填:否 类型:object 描述: 订单金额信息
WxPayPartnerNotifyV3Result.SceneInfo sceneInfo
字段名:场景信息 变量名:scene_info 是否必填:否 类型:object 描述: 支付场景信息描述
List<E> promotionDetails
字段名:优惠功能 变量名:promotion_detail 是否必填:否 类型:array 描述: 优惠功能,享受优惠时返回该字段。
String goodsId
字段名:商品编码 变量名:goods_id 是否必填:是 类型:string[1,32] 描述: 商品编码 示例值:M1006
Integer quantity
字段名:商品数量 变量名:quantity 是否必填:是 类型:int 描述: 用户购买的数量 示例值:1
Integer unitPrice
字段名:商品单价 变量名:unit_price 是否必填:是 类型:int 描述: 商品单价,单位为分 示例值:100
Integer discountAmount
字段名:商品优惠金额 变量名:discount_amount 是否必填:是 类型:int 描述: 商品优惠金额 示例值:0
String goodsRemark
字段名:商品备注 变量名:goods_remark 是否必填:否 类型:string[1,128] 描述: 商品备注信息 示例值:商品备注信息
String openid
字段名:用户标识 变量名:openid 是否必填:是 类型:string[1,128] 描述: 用户在直连商户appid下的唯一标识。 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
String spOpenid
字段名:用户服务标识 变量名:sp_openid 是否必填:是 类型:string[1,128] 描述: 用户在服务商appid下的唯一标识。 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
String subOpenid
字段名:用户子标识 变量名:sub_openid 是否必填:否 类型:string[1,128] 描述: 用户在子商户appid下的唯一标识。 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
String couponId
字段名:券ID 变量名:coupon_id 是否必填:是 类型:string[1,32] 描述: 券ID 示例值:109519
String name
字段名:优惠名称 变量名:name 是否必填:否 类型:string[1,64] 描述: 优惠名称 示例值:单品惠-6
String scope
字段名:优惠范围 变量名:scope 是否必填:否 类型:string[1,32] 描述: GLOBAL:全场代金券 SINGLE:单品优惠 示例值:GLOBAL
String type
字段名:优惠类型 变量名:type 是否必填:否 类型:string[1,32] 描述: CASH:充值 NOCASH:预充值 示例值:CASH
Integer amount
字段名:优惠券面额 变量名:amount 是否必填:是 类型:int 描述: 优惠券面额 示例值:100
String stockId
字段名:活动ID 变量名:stock_id 是否必填:否 类型:string[1,32] 描述: 活动ID 示例值:931386
Integer wechatpayContribute
字段名:微信出资 变量名:wechatpay_contribute 是否必填:否 类型:int 描述: 微信出资,单位为分 示例值:0
Integer merchantContribute
字段名:商户出资 变量名:merchant_contribute 是否必填:否 类型:int 描述: 商户出资,单位为分 示例值:0
Integer otherContribute
字段名:其他出资 变量名:other_contribute 是否必填:否 类型:int 描述: 其他出资,单位为分 示例值:0
String currency
字段名:优惠币种 变量名:currency 是否必填:否 类型:string[1,16] 描述: CNY:人民币,境内商户号仅支持人民币。 示例值:CNY
List<E> goodsDetails
字段名:单品列表 变量名:goods_detail 是否必填:否 类型:array 描述: 单品列表信息
String deviceId
字段名:商户端设备号 变量名:device_id 是否必填:否 类型:string[1,32] 描述: 终端设备号(门店号或收银设备ID)。 示例值:013467007045764
OriginNotifyResponse rawData
WxPayPartnerRefundNotifyV3Result.DecryptNotifyResult result
Integer total
字段名:订单金额 变量名:total 是否必填:是 类型:int 描述: 订单总金额,单位为分,只能为整数,详见支付金额 示例值:999
Integer refund
字段名:退款金额 变量名:refund 是否必填:是 类型:int 描述: 退款金额,币种的最小单位,只能为整数,不能超过原订单支付金额,如果有使用券,后台会按比例退。 示例值:999
Integer payerTotal
字段名:用户支付金额 变量名:payer_total 是否必填:是 类型:int 描述: 用户实际支付金额,单位为分,只能为整数,详见支付金额 示例值:999
Integer payerRefund
字段名:用户退款金额 变量名:payer_refund 是否必填:是 类型:int 描述: 退款给用户的金额,不包含所有优惠券金额 示例值:999
String spMchId
字段名:服务商的商户号 变量名:sub_mchid 是否必填:是 类型:string[1, 32] 描述: 服务商的商户号,由微信支付生成并下发。 示例值:1230000109
String subMchId
字段名:子商户的商户号 变量名:sub_mchid 是否必填:是 类型:string[1, 32] 描述: 子商户商户号,由微信支付生成并下发。 示例值:1230000109
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string[1,32] 描述: 返回的商户订单号 示例值: 1217752501201407033233368018
String transactionId
字段名:微信支付订单号 变量名:transaction_id 是否必填:是 类型:string[1,32] 描述: 微信支付订单号 示例值: 1217752501201407033233368018
String outRefundNo
字段名:商户退款单号 变量名:out_refund_no 是否必填:是 类型:string[1,64] 描述: 商户退款单号 示例值: 1217752501201407033233368018
String refundId
字段名:微信支付退款号 变量名:refund_id 是否必填:是 类型:string[1,32] 描述: 微信退款单号 示例值: 1217752501201407033233368018
String refundStatus
字段名:退款状态 变量名:refund_status 是否必填:是 类型:string[1,16] 描述: 退款状态,枚举值: SUCCESS:退款成功 CLOSE:退款关闭 ABNORMAL:退款异常,退款到银行发现用户的卡作废或者冻结了,导致原路退款银行卡失败,可前往【商户平台—>交易中心】,手动处理此笔退款 示例值:SUCCESS
String successTime
字段名:退款成功时间 变量名:success_time 是否必填:否 类型:string[1,64] 描述: 1、退款成功时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。 2、当退款状态为退款成功时返回此参数。 示例值:2018-06-08T10:34:56+08:00
String userReceivedAccount
字段名:退款入账账户 变量名:user_received_account 是否必填:是 类型:string[1,64] 描述: 取当前退款单的退款入账方。 1、退回银行卡:{银行名称}{卡类型}{卡尾号} 2、退回支付用户零钱: 支付用户零钱 3、退还商户: 商户基本账户、商户结算银行账户 4、退回支付用户零钱通:支付用户零钱通 示例值:招商银行信用卡0403
WxPayPartnerRefundNotifyV3Result.Amount amount
字段名:金额信息 变量名:amount 是否必填:是 类型:object 描述: 金额信息
String reqInfoString
字段名:加密信息. 变量名:req_info 是否必填:是 类型:String(1024) 描述:加密信息请用商户证书与商户秘钥进行解密
WxPayRefundNotifyResult.ReqInfo reqInfo
OriginNotifyResponse rawData
WxPayRefundNotifyV3Result.DecryptNotifyResult result
Integer total
字段名:订单金额 变量名:total 是否必填:是 类型:int 描述: 订单总金额,单位为分,只能为整数,详见支付金额 示例值:999
Integer refund
字段名:退款金额 变量名:refund 是否必填:是 类型:int 描述: 退款金额,币种的最小单位,只能为整数,不能超过原订单支付金额,如果有使用券,后台会按比例退。 示例值:999
Integer payerTotal
字段名:用户支付金额 变量名:payer_total 是否必填:是 类型:int 描述: 用户实际支付金额,单位为分,只能为整数,详见支付金额 示例值:999
Integer payerRefund
字段名:用户退款金额 变量名:payer_refund 是否必填:是 类型:int 描述: 退款给用户的金额,不包含所有优惠券金额 示例值:999
String mchid
字段名:直连商户号 变量名:mchid 是否必填:是 类型:string[1,32] 描述: 直连商户的商户号,由微信支付生成并下发。 示例值:1900000100
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string[1,32] 描述: 返回的商户订单号 示例值: 1217752501201407033233368018
String transactionId
字段名:微信支付订单号 变量名:transaction_id 是否必填:是 类型:string[1,32] 描述: 微信支付订单号 示例值: 1217752501201407033233368018
String outRefundNo
字段名:商户退款单号 变量名:out_refund_no 是否必填:是 类型:string[1,64] 描述: 商户退款单号 示例值: 1217752501201407033233368018
String refundId
字段名:微信支付退款号 变量名:refund_id 是否必填:是 类型:string[1,32] 描述: 微信退款单号 示例值: 1217752501201407033233368018
String refundStatus
字段名:退款状态 变量名:refund_status 是否必填:是 类型:string[1,16] 描述: 退款状态,枚举值: SUCCESS:退款成功 CLOSE:退款关闭 ABNORMAL:退款异常,退款到银行发现用户的卡作废或者冻结了,导致原路退款银行卡失败,可前往【商户平台—>交易中心】,手动处理此笔退款 示例值:SUCCESS
String successTime
字段名:退款成功时间 变量名:success_time 是否必填:否 类型:string[1,64] 描述: 1、退款成功时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。 2、当退款状态为退款成功时返回此参数。 示例值:2018-06-08T10:34:56+08:00
String userReceivedAccount
字段名:退款入账账户 变量名:user_received_account 是否必填:是 类型:string[1,64] 描述: 取当前退款单的退款入账方。 1、退回银行卡:{银行名称}{卡类型}{卡尾号} 2、退回支付用户零钱: 支付用户零钱 3、退还商户: 商户基本账户、商户结算银行账户 4、退回支付用户零钱通:支付用户零钱通 示例值:招商银行信用卡0403
WxPayRefundNotifyV3Result.Amount amount
字段名:金额信息 变量名:amount 是否必填:是 类型:object 描述: 金额信息
OriginNotifyResponse rawData
WxPayTransferBatchesNotifyV3Result.DecryptNotifyResult result
String mchid
字段名:直连商户号 变量名:mchid 是否必填:是 类型:string[1,32] 描述: 直连商户的商户号,由微信支付生成并下发。 示例值:1900000100
String outBatchNo
String batchId
String batchStatus
Integer totalNum
Integer totalAmount
Integer successAmount
Integer successNum
Integer failAmount
Integer failNum
String closeReason
String updateTime
String mwebUrl
String codeUrl
Integer planDetailNo
Integer originalPrice
String planDiscountDescription
Integer actualPrice
String planDetailState
String orderId
String merchantPlanDetailNo
String planDetailName
Integer actualPayPrice
String useTime
String completeTime
String cancelTime
String signPlanId
String openid
String subOpenid
字段名:二级商户用户标识 变量名:sub_openid 是否必填:否 类型:string(128) 描述: 用户在二级商户appid下的唯一标识。 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
String serviceId
String mchid
String subMchid
String appid
String subAppid
String merchantSignPlanNo
String merchantCallbackUrl
String planId
Integer goingDetailNo
String signState
String cancelSignTime
String cancelSignType
String cancelReason
String planName
String planOverTime
Integer totalOriginPrice
Integer deductionQuantity
Integer totalActualPrice
List<E> signedDetailList
String signTime
String id
String createTime
String eventType
1、授权成功通知的类型为PAYSCORE.USER_OPEN_SERVICE
2、解除授权成功通知的类型为PAYSCORE.USER_CLOSE_SERVICE
3、用户确认成功通知的类型为PAYSCORE.USER_CONFIRM
4、支付成功通知的类型为PAYSCORE.USER_PAID
5、取消签约成功通知类型为PAYSCORE.USER_CANCEL_SIGN_PLAN
6、签约计划成功通知类型为PAYSCORE.USER_SIGN_PLAN
String resourceType
PayScoreNotifyData.Resource resource
String summary
Integer planDetailNo
String couponId
String name
String scope
String type
Integer amount
String stockId
Integer wechatpayContribute
Integer merchantContribute
Integer otherContribute
String currency
List<E> goodsDetail
PayScoreNotifyData rawData
String appid
字段名:公众账号ID 变量名:appid 是否必填:是 类型:string[1,32] 描述: 调用授权服务接口提交的公众账号ID。 示例值:wxd678efh567hg6787
String mchid
字段名:商户号 变量名:mchid 是否必填:是 类型:string[1,32] 描述: 调用授权服务接口提交的商户号。 示例值:1230000109
String outRequestNo
字段名:商户签约单号 变量名:out_request_no 是否必填:否 类型: string[1,64] 描述: 调用授权服务接口提交的商户请求唯一标识(新签约的用户,且在授权签约中上传了该字段,则在解约授权回调通知中有返回)。 示例值:1234323JKHDFE1243252
String serviceId
字段名:服务ID 变量名:service_id 是否必填:是 类型: string[1,32] 描述: 调用授权服务接口提交的服务ID。 示例值:1234323JKHDFE1243252
String openid
字段名:用户标识 变量名:openid 是否必填:是 类型: string[1,128] 描述: 微信用户在商户对应appid下的唯一标识。 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
String userServiceStatus
字段名:回调状态 变量名:user_service_status 是否必填:否 类型: string[1,32] 描述: 1、USER_OPEN_SERVICE:授权成功 2、USER_CLOSE_SERVICE:解除授权成功 示例值:USER_OPEN_SERVICE
String openOrCloseTime
字段名:服务授权/解除授权时间 变量名:openorclose_time 是否必填:否 类型: string[1,32] 描述: 服务授权/解除授权成功时间。 示例值:20180225112233
String authorizationCode
字段名:授权协议号 变量名:authorization_code 是否必填:否 类型: string[1,32] 描述: 授权协议号,预授权时返回,非预授权不返回 示例值:1275342195190894594
String subAppid
String subMchid
String subOpenid
String outApplyNo
String resultNotifyUrl
String subAppid
String subMchid
String subOpenid
String planName
Integer planDuration
Integer deductionQuantity
Integer totalOriginalPrice
Integer totalActualPrice
List<E> planDetailList
String merchantPlanNo
String signPlanId
Integer planDetailNo
String outTradeNo
String planId
String merchantSignPlanNo
List<E> signPlanDetail
String subAppid
String subMchid
String planId
String merchantPlanNo
String planName
String planDuration
String planState
String totalOriginalPrice
String deductionQuantity
Integer totalActualPrice
List<E> planDetailList
String stopMchid
String stopTime
PartnerUserSignPlanEntity signPlan
String pack
String subAppId
字段名:子商户应用ID 变量名:sub_appid 是否必填:是 类型:string[1,32] 描述: 子商户申请的公众号或移动应用APPID。 示例值:wxd678efh567hg6787
String subMchId
字段名:子商户的商户号 变量名:sub_mchid 是否必填:是 类型:string[1,32] 描述: 子商户商户号,由微信支付生成并下发。 示例值:1230000109
String subOpenid
字段名:子商户公众号下openid 变量名:sub_mchid 是否必填:是 类型:string[1,32] 描述: 微信用户在商户对应sub_appid下的唯一标识。(传了sub_appid的情况下则只返回sub_openid)。 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
String outOrderNo
String appid
String serviceId
String serviceIntroduction
TimeRange timeRange
Location location
RiskFund riskFund
String attach
String notifyUrl
String openid
Boolean needUserConfirm
Boolean profitSharing
List<E> postPayments
List<E> postDiscounts
Integer totalAmount
String reason
String goodsTag
String type
SyncDetail detail
String authorizationCode
String completeTime
String appid
String mchid
String outOrderNo
String serviceId
String serviceIntroduction
String state
String stateDescription
RiskFund riskFund
TimeRange timeRange
Location location
String attach
String notifyUrl
String orderId
String packageX
List<E> postPayments
List<E> postDiscounts
boolean needCollection
WxPayScoreResult.Collection collection
Map<K,V> payScoreSignInfo
String openid
String applyPermissionsToken
String authorizationCode
String authorizationState
String cancelAuthorizationTime
String authorizationSuccessTime
Integer userRiskLevel
Integer riskLevelVersion
Integer totalAmount
String channelId
String state
int totalAmount
int payingAmount
int paidAmount
List<E> details
String type
字段名:分账接收方类型 是否必填:是 描述: 1、MERCHANT_ID:商户号 2、PERSONAL_OPENID:个人openid(由父商户APPID转换得到)
String account
字段名:分账接收方帐号 是否必填:是 描述: 1、分账接收方类型为MERCHANT_ID时,分账接收方账号为商户号 2、分账接收方类型为PERSONAL_OPENID时,分账接收方账号为个人openid
Integer amount
字段名:分账金额 是否必填:是 描述: 分账金额,单位为分,只能为整数,不能超过原订单支付金额及最大分账比例金额
String description
字段名:分账描述 是否必填:是 描述: 分账的原因描述,分账账单中需要体现
String name
字段名:分账个人接收方姓名 是否必填:否 描述: 可选项,在接收方类型为个人的时可选填,若有值,会检查与 name 是否实名匹配,不匹配会拒绝分账请求 1、分账接收方类型是PERSONAL_OPENID,是个人姓名的密文(选传,传则校验) 此字段的加密方法详见:敏感信息加密说明 2、使用微信支付平台证书中的公钥 3、使用RSAES-OAEP算法进行加密 4、将请求中HTTP头部的Wechatpay-Serial设置为证书序列号
String relationType
字段名:与分账方的关系类型 是否必填:是 描述:子商户与接收方的关系。 本字段值为枚举: STORE:门店 STAFF:员工 STORE_OWNER:店主 PARTNER:合作伙伴 HEADQUARTER:总部 BRAND:品牌方 DISTRIBUTOR:分销商 USER:用户 SUPPLIER: 供应商 CUSTOM:自定义
String customRelation
字段名:自定义的分账关系 是否必填:是 描述:子商户与接收方具体的关系,本字段最多10个字。 当字段relationType的值为CUSTOM时,本字段必填; 当字段relationType的值不为CUSTOM时,本字段无需填写。
String id
字段名:通知ID 是否必填:是 描述:通知的唯一ID
String createTime
字段名:通知创建时间 是否必填:是 描述:通知创建的时间,Rfc3339标准
String resourceType
字段名:通知数据类型 是否必填:是 描述:通知的资源数据类型
String eventType
字段名:通知类型 是否必填:是 描述:通知的类型
ProfitSharingNotifyV3Response.Resource resource
字段名:通知数据 是否必填:是 描述:通知资源数据
String summary
字段名:通知简要说明 是否必填:是 描述:通知简要说明
String algorithm
字段名:加密算法类型 是否必填:是 描述:对分账结果数据进行加密的加密算法,目前只支持AEAD_AES_256_GCM
String originalType
字段名:加密前的对象类型 是否必填:是 描述:加密前的对象类型,分账动账通知的类型为profitsharing
String cipherText
字段名:数据密文 是否必填:是 描述:Base64编码后的分账结果数据密文
String nonce
字段名:随机串 是否必填:是 描述:加密使用的随机串
String associatedData
字段名:附加数据 是否必填:否 描述:附加数据
String mchId
字段名:直连商户号 是否必填:是 描述:直连模式分账发起和出资商户
String spMchid
字段名:服务商商户号 是否必填:是 描述:服务商模式分账发起商户。
String subMchid
字段名:子商户号 是否必填:是 描述:服务商模式分账出资商户。
String transactionId
字段名:微信订单号 是否必填:是 描述:微信支付订单号
String orderId
字段名:微信分账/回退单号 是否必填:是 描述:微信分账/回退单号
String outOrderNo
字段名:商户分账/回退单号 是否必填:是 描述:分账方系统内部的分账/回退单号
ProfitSharingNotifyV3Result.Receiver receiver
字段名:分账接收方 是否必填:是 描述:分账接收方对象
String successTime
字段名:成功时间 是否必填:是 描述:成功时间,Rfc3339标准
String transactionId
字段名:微信订单号. 变量名:transaction_id 是否必填:是 String(32) 示例值:4208450740201411110007820472 描述:微信支付订单号
String subMchId
字段名:子商户号 是否必填:是 描述:微信支付分配的子商户号,即分账的出资商户号。
String transactionId
字段名:微信支付订单号. 变量名:transaction_id 是否必填:是 String(32) 示例值:4208450740201411110007820472 描述:微信支付订单号
String outOrderNo
字段名:商户分账单号. 变量名:out_order_no 是否必填:是 String(64) 示例值:P20150806125346 描述:查询分账结果,输入申请分账时的商户分账单号; 查询分账完结的执行结果,输入发起分账完结时的商户分账单号
String receiver
字段名:分账接收方. 变量名:receiver 是否必填:是 String(2048) 示例值:{ "type": "MERCHANT_ID", "account": "190001001", "name": "示例商户全称", "relation_type": "STORE_OWNER" } 描述:分账接收方对象,json格式
String subMchId
字段名:子商户号 是否必填:是 描述:微信支付分配的子商户号,即分账的出资商户号。
String appid
字段名:应用ID 是否必填:是 描述:微信分配的商户appid
String subAppid
字段名:子商户应用ID 是否必填:否 描述:子商户的公众账号ID,分账接收方类型包含PERSONAL_SUB_OPENID时必填
String type
字段名:分账接收方类型 是否必填:是 描述: 1、MERCHANT_ID:商户号 2、PERSONAL_OPENID:个人openid(由父商户APPID转换得到)
String account
字段名:分账接收方帐号 是否必填:是 描述: 1、分账接收方类型为MERCHANT_ID时,分账接收方账号为商户号 2、分账接收方类型为PERSONAL_OPENID时,分账接收方账号为个人openid
String name
字段名:分账个人接收方姓名 是否必填:否 描述: 可选项,在接收方类型为个人的时可选填,若有值,会检查与 name 是否实名匹配,不匹配会拒绝分账请求 1、分账接收方类型是PERSONAL_OPENID,是个人姓名的密文(选传,传则校验) 此字段的加密方法详见:敏感信息加密说明 2、使用微信支付平台证书中的公钥 3、使用RSAES-OAEP算法进行加密 4、将请求中HTTP头部的Wechatpay-Serial设置为证书序列号
String relationType
字段名:与分账方的关系类型 是否必填:是 描述:子商户与接收方的关系。 本字段值为枚举: STORE:门店 STAFF:员工 STORE_OWNER:店主 PARTNER:合作伙伴 HEADQUARTER:总部 BRAND:品牌方 DISTRIBUTOR:分销商 USER:用户 SUPPLIER: 供应商 CUSTOM:自定义
String customRelation
字段名:自定义的分账关系 是否必填:是 描述:子商户与接收方具体的关系,本字段最多10个字。 当字段relationType的值为CUSTOM时,本字段必填; 当字段relationType的值不为CUSTOM时,本字段无需填写。
String transactionId
字段名:微信订单号. 变量名:transaction_id 是否必填:是 String(32) 示例值:4208450740201411110007820472 描述:微信支付订单号
String outOrderNo
字段名:商户分账单号. 变量名:out_order_no 是否必填:是 String(64) 示例值:P20150806125346 描述:商户系统内部的分账单号,在商户系统内部唯一(单次分账、多次分账、完结分账应使用不同的商户分账单号),同一分账单号多次请求等同一次。只能是数字、大小写字母_-|*@
String receivers
字段名:分账接收方列表. 变量名:receivers 是否必填:是 String(10240) 示例值:[ { "type": "MERCHANT_ID", "account":"190001001", "amount":100, "description": "分到商户" }, { "type": "PERSONAL_WECHATID", "account":"86693952", "amount":888, "description": "分到个人" } ] 描述:分账接收方列表,不超过50个json对象,不能设置分账方作为分账接受方,使用Json格式
String orderId
字段名:微信分账单号. 变量名:order_id 是否必填:二选一 string(64) 示例值:3008450740201411110007820472 描述:原发起分账请求时,微信返回的微信分账单号,与商户分账单号一一对应。 微信分账单号与商户分账单号二选一填写
String outOrderNo
字段名:商户分账单号. 变量名:out_order_no 是否必填:二选一 Sstring(64) 示例值:P20180806125346 描述:原发起分账请求时使用的商户后台系统的分账单号。 微信分账单号与商户分账单号二选一填写
String outReturnNo
字段名:商户回退单号. 变量名:out_return_no 是否必填:是 string(64) 示例值:R20190516001 描述:调用回退接口提供的商户系统内部的回退单号
String orderId
字段名:微信分账单号. 变量名:order_id 是否必填:二选一 string(64) 示例值:3008450740201411110007820472 描述:原发起分账请求时,微信返回的微信分账单号,与商户分账单号一一对应。 微信分账单号与商户分账单号二选一填写
String outOrderNo
字段名:商户分账单号. 变量名:out_order_no 是否必填:二选一 Sstring(64) 示例值:P20180806125346 描述:原发起分账请求时使用的商户后台系统的分账单号。 微信分账单号与商户分账单号二选一填写
String outReturnNo
字段名:商户回退单号. 变量名:out_return_no 是否必填:是 string(64) 示例值:R20190516001 描述:此回退单号是商户在自己后台生成的一个新的回退单号,在商户后台唯一 只能是数字、大小写字母_-|*@ ,同一回退单号多次请求等同一次。
String returnAccountType
字段名:回退方类型. 变量名:return_account_type 是否必填:是 String(32) 示例值:MERCHANT_ID 描述:枚举值: MERCHANT_ID:商户ID 暂时只支持从商户接收方回退分账金额
String returnAccount
字段名:回退方账号. 变量名:return_account 是否必填:是 String(64) 示例值:86693852 描述:回退方类型是MERCHANT_ID时,填写商户ID 只能对原分账请求中成功分给商户接收方进行回退
Integer returnAmount
字段名:回退金额. 变量名:return_amount 是否必填:是 int 示例值:888 描述:需要从分账接收方回退的金额,单位为分,只能为整数,不能超过原始分账单分出给该接收方的金额
String description
字段名:回退描述. 变量名:description 是否必填:是 String(80) 示例值:用户退款 描述:分账回退的原因描述
String subMchId
字段名:子商户号 是否必填:是 描述:分账回退的接收商户,对应原分账出资的分账方商户,填写微信支付分配的商户号
String orderId
字段名:微信分账单号 是否必填:是 描述:微信分账单号,微信系统返回的唯一标识。
String outOrderNo
字段名:商户分账单号 是否必填:是 描述:商户系统内部的分账单号,在商户系统内部唯一,同一分账单号多次请求等同一次。只能是数字、大小写字母_-|*@
String outReturnNo
字段名:商户回退单号 是否必填:是 描述:此回退单号是商户在自己后台生成的一个新的回退单号,在商户后台唯一
String returnMchid
字段名:回退商户号 是否必填:是 描述:分账回退的出资商户,只能对原分账请求中成功分给商户接收方进行回退
Long amount
字段名:回退金额 是否必填:是 描述:需要从分账接收方回退的金额,单位为分,只能为整数,不能超过原始分账单分出给该接收方的金额
String description
字段名:回退描述 是否必填:是 描述: 分账回退的原因描述
String transactionId
字段名:微信订单号. 变量名:transaction_id 是否必填:是 String(32) 示例值:4208450740201411110007820472 描述:微信支付订单号
String outOrderNo
字段名:商户分账单号. 变量名:out_order_no 是否必填:是 String(64) 示例值:P20150806125346 描述:商户系统内部的分账单号,在商户系统内部唯一(单次分账、多次分账、完结分账应使用不同的商户分账单号),同一分账单号多次请求等同一次。只能是数字、大小写字母_-|*@
String description
字段名:分账完结描述. 变量名:out_order_no 是否必填:是 String(80) 示例值:分账已完成 描述:分账完结的原因描述
String subMchId
字段名:子商户号 是否必填:是 描述:微信支付分配的子商户号,即分账的出资商户号。
String transactionId
字段名:微信订单号 是否必填:是 描述:微信支付订单号
String outOrderNo
字段名:商户分账单号 是否必填:是 描述:商户系统内部的分账单号,在商户系统内部唯一,同一分账单号多次请求等同一次。只能是数字、大小写字母_-|*@
String description
字段名:分账描述 是否必填:是 描述: 分账的原因描述,分账账单中需要体现
String subMchId
字段名:子商户号 是否必填:是 描述:微信支付分配的子商户号,即分账的出资商户号。
String appid
字段名:应用ID 是否必填:是 描述:微信分配的商户appid
String subAppid
字段名:子商户应用ID 是否必填:否 描述:子商户的公众账号ID,分账接收方类型包含PERSONAL_SUB_OPENID时必填
String transactionId
字段名:微信订单号 是否必填:是 描述:微信支付订单号
String outOrderNo
字段名:商户分账单号 是否必填:是 描述:商户系统内部的分账单号,在商户系统内部唯一,同一分账单号多次请求等同一次。只能是数字、大小写字母_-|*@
List<E> receivers
字段名:分账接收方列表 是否必填:是 描述:分账接收方列表,可以设置出资商户作为分账接受方,最多可有50个分账接收方
boolean unfreezeUnsplit
字段名:是否解冻剩余未分资金 是否必填:是 描述: 1、如果为true,该笔订单剩余未分账的金额会解冻回分账方商户; 2、如果为false,该笔订单剩余未分账的金额不会解冻回分账方商户,可以对该笔订单再次进行分账。
String type
字段名:分账接收方类型 是否必填:是 描述: 1、MERCHANT_ID:商户号 2、PERSONAL_OPENID:个人openid(由父商户APPID转换得到)
String account
字段名:分账接收方帐号 是否必填:是 描述: 1、分账接收方类型为MERCHANT_ID时,分账接收方账号为商户号 2、分账接收方类型为PERSONAL_OPENID时,分账接收方账号为个人openid
Integer amount
字段名:分账金额 是否必填:是 描述: 分账金额,单位为分,只能为整数,不能超过原订单支付金额及最大分账比例金额
String name
字段名:分账个人接收方姓名 是否必填:否 描述: 可选项,在接收方类型为个人的时可选填,若有值,会检查与 name 是否实名匹配,不匹配会拒绝分账请求 1、分账接收方类型是PERSONAL_OPENID,是个人姓名的密文(选传,传则校验) 此字段的加密方法详见:敏感信息加密说明 2、使用微信支付平台证书中的公钥 3、使用RSAES-OAEP算法进行加密 4、将请求中HTTP头部的Wechatpay-Serial设置为证书序列号
String relationType
字段名:与分账方的关系类型 是否必填:是 描述:子商户与接收方的关系。 本字段值为枚举: STORE:门店 STAFF:员工 STORE_OWNER:店主 PARTNER:合作伙伴 HEADQUARTER:总部 BRAND:品牌方 DISTRIBUTOR:分销商 USER:用户 SUPPLIER: 供应商 CUSTOM:自定义
String customRelation
字段名:自定义的分账关系 是否必填:是 描述:子商户与接收方具体的关系,本字段最多10个字。 当字段relationType的值为CUSTOM时,本字段必填; 当字段relationType的值不为CUSTOM时,本字段无需填写。
String description
字段名:分账描述 是否必填:是 描述: 分账的原因描述,分账账单中需要体现
String downloadUrl
字段名:账单下载地址 变量名:download_url 是否必填:是 类型:string[1,2048] 描述: 供下一步请求账单文件的下载地址,该地址30s内有效。 示例值:https://api.mch.weixin.qq.com/v3/bill/downloadurl?token=xxx
String hashType
字段名:哈希类型 变量名:hash_type 是否必填:是 类型:string[1, 32] 描述: 原始账单(gzip需要解压缩)的摘要值,用于校验文件的完整性。 示例值:SHA1
String hashValue
字段名:哈希值 变量名:hash_value 是否必填:是 类型:string[1,1024] 描述: 原始账单(gzip需要解压缩)的摘要值,用于校验文件的完整性。 示例值:79bb0f45fc4c42234a918000b2668d689e2bde04
Integer maxRatio
String transactionId
String outOrderNo
String orderId
String status
String closeReason
String receiversJson
List<E> receivers
Integer amount
String description
String receiver
String subMchId
字段名:子商户号 是否必填:是 描述:微信支付分配的子商户号,即分账的出资商户号。
String type
字段名:分账接收方类型 是否必填:是 描述: 1、MERCHANT_ID:商户号 2、PERSONAL_OPENID:个人openid(由父商户APPID转换得到)
String account
字段名:分账接收方帐号 是否必填:是 描述: 1、分账接收方类型为MERCHANT_ID时,分账接收方账号为商户号 2、分账接收方类型为PERSONAL_OPENID时,分账接收方账号为个人openid
String name
字段名:分账个人接收方姓名 是否必填:否 描述: 可选项,在接收方类型为个人的时可选填,若有值,会检查与 name 是否实名匹配,不匹配会拒绝分账请求 1、分账接收方类型是PERSONAL_OPENID,是个人姓名的密文(选传,传则校验) 此字段的加密方法详见:敏感信息加密说明 2、使用微信支付平台证书中的公钥 3、使用RSAES-OAEP算法进行加密 4、将请求中HTTP头部的Wechatpay-Serial设置为证书序列号
String relationType
字段名:与分账方的关系类型 是否必填:是 描述:子商户与接收方的关系。 本字段值为枚举: STORE:门店 STAFF:员工 STORE_OWNER:店主 PARTNER:合作伙伴 HEADQUARTER:总部 BRAND:品牌方 DISTRIBUTOR:分销商 USER:用户 SUPPLIER: 供应商 CUSTOM:自定义
String customRelation
字段名:自定义的分账关系 是否必填:是 描述:子商户与接收方具体的关系,本字段最多10个字。 当字段relationType的值为CUSTOM时,本字段必填; 当字段relationType的值不为CUSTOM时,本字段无需填写。
String type
字段名:分账接收方类型 是否必填:是 描述: 枚举值: MERCHANT_ID:商户号(mch_id或者sub_mch_id) PERSONAL_OPENID:个人openid(由服务商的APPID转换得到) PERSONAL_SUB_OPENID:个人sub_openid(由品牌主的APPID转换得到)
String account
字段名:分账接收方帐号 是否必填:是 描述: 1、分账接收方类型为MERCHANT_ID时,分账接收方账号为商户号 2、分账接收方类型为PERSONAL_OPENID时,分账接收方账号为个人openid
Integer amount
字段名:分账金额 是否必填:是 描述: 分账金额,单位为分,只能为整数,不能超过原订单支付金额及最大分账比例金额
String receiverMchid
字段名:分账接收商户号 是否必填:是 描述: 仅分账接收方类型为MERCHANT_ID时,填写微信支付分配的商户号
String description
字段名:分账描述 是否必填:是 描述: 分账的原因描述,分账账单中需要体现
String result
字段名:分账结果 是否必填:是 描述: 1、PENDING:待分账 2、SUCCESS:分账成功 3、CLOSED:已关闭
String failReason
字段名:分账失败原因 是否必填:是 描述:包含以下枚举值: 1、ACCOUNT_ABNORMAL : 分账接收账户异常 2、NO_RELATION : 分账关系已解除 3、RECEIVER_HIGH_RISK : 高风险接收方 4、RECEIVER_REAL_NAME_NOT_VERIFIED : 接收方未实名 5、NO_AUTH : 分账权限已解除
String createTime
字段名:分账创建时间 是否必填:是 描述:遵循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年5月20日 13点29分35秒。
String finishTime
字段名:分账完成时间 是否必填:是 描述:遵循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年5月20日 13点29分35秒。
String detailId
字段名:微信分账明细单号 是否必填:是 每笔分账业务执行的明细单号,可与资金账单对账使用, 例如:36011111111111111111111
String errorCode
String errorMsg
String orderId
String outOrderNo
String outReturnNo
String returnNo
String returnAccountType
String returnAccount
Integer returnAmount
String description
String result
String failReason
String finishTime
String subMchId
字段名:子商户号 是否必填:是 描述:分账回退的接收商户,对应原分账出资的分账方商户,填写微信支付分配的商户号
String orderId
字段名:微信分账单号 是否必填:是 描述:微信分账单号,微信系统返回的唯一标识。
String outOrderNo
字段名:商户分账单号 是否必填:是 描述:商户系统内部的分账单号,在商户系统内部唯一,同一分账单号多次请求等同一次。只能是数字、大小写字母_-|*@
String outReturnNo
字段名:商户回退单号 是否必填:是 描述:此回退单号是商户在自己后台生成的一个新的回退单号,在商户后台唯一
String returnId
字段名:微信回退单号 是否必填:是 描述:微信分账回退单号,微信系统返回的唯一标识
String returnMchid
字段名:回退商户号 是否必填:是 描述:分账回退的出资商户,只能对原分账请求中成功分给商户接收方进行回退
Long amount
字段名:回退金额 是否必填:是 描述:需要从分账接收方回退的金额,单位为分,只能为整数,不能超过原始分账单分出给该接收方的金额
String description
字段名:回退描述 是否必填:是 描述: 分账回退的原因描述
String result
字段名:分账结果 是否必填:是 描述: 如果请求返回为处理中,则商户可以通过调用回退结果查询接口获取请求的最终处理结果。 如果查询到回退结果在处理中,请勿变更商户回退单号,使用相同的参数再次发起分账回退,否则会出现资金风险。 在处理中状态的回退单如果5天没有成功,会因为超时被设置为已失败。 PROCESSING:处理中 SUCCESS:已成功 FAILED:已失败
String failReason
字段名:失败原因 是否必填:是 描述:失败原因。包含以下枚举值: ACCOUNT_ABNORMAL : 分账接收方账户异常 TIME_OUT_CLOSED : 超时关单
String createTime
字段名:分账回退创建时间 是否必填:是 描述:遵循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年5月20日 13点29分35秒。
String finishTime
字段名:分账回退完成时间 是否必填:是 描述:遵循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年5月20日 13点29分35秒。
String subMchid
字段名:子商户号 是否必填:是 描述:微信支付分配的子商户号,即分账的出资商户号
String transactionId
字段名:微信订单号 是否必填:是 描述:微信支付订单号
String outOrderNo
字段名:商户分账单号 是否必填:是 描述:商户系统内部的分账单号,在商户系统内部唯一,同一分账单号多次请求等同一次。只能是数字、大小写字母_-|*@
String orderId
字段名:微信分账单号 是否必填:是 描述:微信分账单号,微信系统返回的唯一标识。
String state
字段名:分账单状态 是否必填:是 描述:分账单状态(每个接收方的分账结果请查看receivers中的result字段),枚举值: 1、PROCESSING:处理中 2、FINISHED:分账完成
List<E> receivers
String type
字段名:分账接收方类型 是否必填:是 描述: 1、MERCHANT_ID:商户号 2、PERSONAL_OPENID:个人openid(由父商户APPID转换得到)
String account
字段名:分账接收方帐号 是否必填:是 描述: 1、分账接收方类型为MERCHANT_ID时,分账接收方账号为商户号 2、分账接收方类型为PERSONAL_OPENID时,分账接收方账号为个人openid
Long amount
字段名:分账金额 是否必填:是 描述: 分账金额,单位为分,只能为整数,不能超过原订单支付金额及最大分账比例金额
String description
字段名:分账描述 是否必填:是 描述: 分账的原因描述,分账账单中需要体现
String result
字段名:分账结果 是否必填:是 描述: 1、PENDING:待分账 2、SUCCESS:分账成功 3、CLOSED:已关闭
String failReason
字段名:分账失败原因 是否必填:是 描述:枚举值: 1、PENDING:待分账 2、SUCCESS:分账成功 3、CLOSED:已关闭
String createTime
字段名:分账创建时间 是否必填:是 描述:遵循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年5月20日 13点29分35秒。
String finishTime
字段名:分账完成时间 是否必填:是 描述:遵循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年5月20日 13点29分35秒。
String detailId
字段名:分账明细单号 是否必填:是 描述:微信分账明细单号,每笔分账业务执行的明细单号,可与资金账单对账使用
String subMchId
字段名:子商户号 是否必填:是 描述:微信支付分配的子商户号,即分账的出资商户号。
String transactionId
字段名:微信订单号 是否必填:是 描述:微信支付订单号
String outOrderNo
字段名:商户分账单号 是否必填:是 描述:商户系统内部的分账单号,在商户系统内部唯一,同一分账单号多次请求等同一次。只能是数字、大小写字母_-|*@
String orderId
字段名:微信分账单号, 是否必填:是 描述:微信系统返回的唯一标识.
String state
字段名:分账单状态 是否必填:是 描述:分账单状态(每个接收方的分账结果请查看receivers中的result字段): 1、PROCESSING:处理中 2、FINISHED:分账完成.
List<E> receivers
String type
字段名:分账接收方类型 是否必填:是 描述: 1、MERCHANT_ID:商户号 2、PERSONAL_OPENID:个人openid(由父商户APPID转换得到)
String account
字段名:分账接收方帐号 是否必填:是 描述: 1、分账接收方类型为MERCHANT_ID时,分账接收方账号为商户号 2、分账接收方类型为PERSONAL_OPENID时,分账接收方账号为个人openid
Integer amount
字段名:分账金额 是否必填:是 描述: 分账金额,单位为分,只能为整数,不能超过原订单支付金额及最大分账比例金额
String description
字段名:分账描述 是否必填:是 描述: 分账的原因描述,分账账单中需要体现
String result
字段名:分账结果 是否必填:是 描述: 1、PENDING:待分账 2、SUCCESS:分账成功 3、CLOSED:已关闭
String failReason
字段名:分账失败原因 是否必填:是 描述:包含以下枚举值: 1、ACCOUNT_ABNORMAL : 分账接收账户异常 2、NO_RELATION : 分账关系已解除 3、RECEIVER_HIGH_RISK : 高风险接收方 4、RECEIVER_REAL_NAME_NOT_VERIFIED : 接收方未实名 5、NO_AUTH : 分账权限已解除
String createTime
字段名:分账创建时间 是否必填:是 描述:遵循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年5月20日 13点29分35秒。
String finishTime
字段名:分账完成时间 是否必填:是 描述:遵循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年5月20日 13点29分35秒。
String detailId
字段名:微信分账明细单号 是否必填:是 每笔分账业务执行的明细单号,可与资金账单对账使用, 例如:36011111111111111111111
String appid
字段名:公众账号ID. 变量名:appid 是否必填:是 类型:String(32) 示例值:wxd678efh567hg6787 描述:微信分配的公众账号ID(企业号corpid即为此appId)
String mchId
字段名:商户号. 变量名:mch_id 是否必填:是 类型:String(32) 示例值:1230000109 描述:微信支付分配的商户号
String subAppId
字段名:服务商模式下的子商户公众账号ID. 变量名:sub_appid 是否必填:是 类型:String(32) 示例值:wxd678efh567hg6787 描述:微信分配的子商户公众账号ID
String subMchId
字段名:服务商模式下的子商户号. 变量名:sub_mch_id 是否必填:是 类型:String(32) 示例值:1230000109 描述:微信支付分配的子商户号,开发者模式下必填
String nonceStr
字段名:随机字符串. 变量名:nonce_str 是否必填:是 类型:String(32) 示例值:5K8264ILTKCH16CQ2502SI8ZNMTM67VS 描述:随机字符串,不长于32位。推荐随机数生成算法
String sign
字段名:签名. 变量名:sign 是否必填:是 类型:String(32) 示例值:C380BEC2BFD727A4B6845133519F3AD6 描述:签名,详见签名生成算法
String signType
签名类型. sign_type 否 String(32) HMAC-SHA256 签名类型,目前支持HMAC-SHA256和MD5
String workWxSign
String combineAppid
字段名:合单商户appid 变量名:combine_appid 是否必填:是 类型:string[1,32] 描述: 合单发起方的appid。 示例值:wxd678efh567hg6787
String combineMchid
字段名:合单商户号 变量名:combine_mchid 是否必填:是 类型:string[1,32] 描述: 合单发起方商户号。 示例值:1900000109
String combineOutTradeNo
字段名:合单商户订单号 变量名:combine_out_trade_no 是否必填:是 类型:string[1,32] 描述: 合单支付总订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一 。 示例值:P20150806125346
CombineTransactionsRequest.SceneInfo sceneInfo
字段名:场景信息 变量名:scene_info 是否必填:否 类型:object 描述: 支付场景信息描述
List<E> subOrders
字段名:子单信息 变量名:sub_orders 是否必填:是 类型:array 描述: 最多支持子单条数:10
CombineTransactionsRequest.CombinePayerInfo combinePayerInfo
字段名:支付者 变量名:combine_payer_info 是否必填:否(JSAPI必填) 类型:object 描述: 支付者信息
String timeStart
字段名:交易起始时间 变量名:time_start 是否必填:否 类型:string[1,32] 描述: 订单生成时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2019-12-31T15:59:59+08:00
String timeExpire
字段名:交易结束时间 变量名:time_expire 是否必填:否 类型:string[1,32] 描述: 订单失效时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2019-12-31T15:59:59+08:00
String notifyUrl
字段名:通知地址 变量名:notify_url 是否必填:是 类型:string[1,256] 描述: 接收微信支付异步通知回调地址,通知url必须为直接可访问的URL,不能携带参数。 格式: URL 示例值:https://yourapp.com/notify
String openid
字段名:用户标识 变量名:openid 是否必填:是 类型:string[1,128] 描述: 使用合单appid获取的对应用户openid。是用户在商户appid下的唯一标识。 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
String subOpenid
字段名:子用户标识 变量名:sub_openid 是否必填:是 类型:string[1,128] 描述: 服务商模式下,使用某个子商户的Appid获取的对应用户Openid, 是用户在该子商户Appid下的唯一标识。openid和sub_openid可以选传其中之一, 如果选择传sub_openid,则必须传sub_appid。 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
String type
字段名:场景类型 变量名:type 是否必填:是 类型:string[1,32] 描述: 场景类型,枚举值: iOS:IOS移动应用; Android:安卓移动应用; Wap:WAP网站应用; 示例值:iOS
String appName
字段名:应用名称 变量名:app_name 是否必填:否 类型:string[1,64] 描述: 应用名称 示例值:王者荣耀
String appUrl
字段名:网站URL 变量名:app_url 是否必填:否 类型:string[1,128] 描述: 网站URL 示例值:https://pay.qq.com
String bundleId
字段名:iOS平台BundleID 变量名:bundle_id 是否必填:否 类型:string[1,128] 描述: iOS平台BundleID 示例值:com.tencent.wzryiOS
String packageName
字段名:Android平台PackageName 变量名:package_name 是否必填:否 类型:string[1,128] 描述: Android平台PackageName 示例值:com.tencent.tmgp.sgame
String deviceId
字段名:商户端设备号 变量名:device_id 是否必填:否 类型:string[7,16] 描述: 终端设备号(门店号或收银设备ID)。 示例值:POS1:123
String payerClientIp
字段名:用户终端IP 变量名:payer_client_ip 是否必填:是 类型:string[1,45] 描述: 用户的客户端IP,支持IPv4和IPv6两种格式的IP地址。 格式: ip(ipv4+ipv6) 示例值:14.17.22.32
CombineTransactionsRequest.H5Info h5Info
字段名:H5场景信息 变量名:h5_info 是否必填:否(H5支付必填) 类型:object 描述: H5场景信息
String mchid
字段名:子单商户号 变量名:mchid 是否必填:是 类型:string[1,32] 描述: 子单发起方商户号,必须与发起方appid有绑定关系。 示例值:1900000109
String attach
字段名:附加信息 变量名:attach 是否必填:是 类型:string[1,128] 描述: 附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用。 示例值:深圳分店
CombineTransactionsRequest.Amount amount
字段名:订单金额 变量名:amount 是否必填:是 类型:object 描述: 订单金额信息
String outTradeNo
字段名:子单商户订单号 变量名:out_trade_no 是否必填:是 类型:string[1,32] 描述: 商户系统内部订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一。 特殊规则:最小字符长度为6 示例值:20150806125346
String goodsTag
字段名:订单优惠标记 变量名:goods_tag 是否必填:是 类型:string[1,32] 描述: 订单优惠标记,使用代金券或立减优惠功能时需要的参数,说明详见代金券或立减优惠 示例值:WXG
String subMchid
字段名:二级商户号 变量名:sub_mchid 是否必填:是 类型:string[1,32] 描述: 二级商户商户号,由微信支付生成并下发。服务商子商户的商户号,被合单方。直连商户不用传二级商户号。 示例值:1900000109
String description
字段名:商品描述 变量名:description 是否必填:是 类型:string[1,127] 描述: 商品简单描述。需传入应用市场上的APP名字-实际商品名称,例如:天天爱消除-游戏充值。 示例值:腾讯充值中心-QQ会员充值
CombineTransactionsRequest.SettleInfo settleInfo
字段名:结算信息 变量名:settle_info 是否必填:否 类型:Object 描述:结算信息
String subAppid
字段名:子商户应用ID 变量名:sub_appid 是否必填:是 类型:string[1,32] 描述: 子商户申请的应用ID,全局唯一。请求基础下单接口时请注意APPID的应用属性,例如公众号场景下, 需使用应用属性为公众号的APPID 若sub_openid有传的情况下, sub_appid必填,且sub_appid需与sub_openid对应 示例值:wxd678efh567hg6999
String planId
协议模板ID plan_id 是 String(28) 12535 协议模板ID,分为首次签约,支付中签约,重新签约
String contractCode
签约协议号 contract_code 是 String(32) 100000 商户侧签约协议号,由商户生成,只能是数字,大小写字母组成
Long requestSerial
请求序列号 request_serial 是 int(64) 1000 商户请求签约时的序列号,要求唯一性,禁止使用0开头的,用户排序,纯数字
String contractDisplayAccount
用户账户展示名称 contract_display_account 是 string(32) 微信代扣 签约用户的名称,用户页面展示,不支持符号表情
String notifyUrl
回调通知URL notify_url 是 string(256) https://weixin.qq.com 用于接收签约成功消息的回调通知地址
String version
版本号 sign 是 string(8) 1.0 固定值1.0
String timestamp
时间戳 timestamp 是 string(10) 1414488825 系统当前时间,10位
String clientIp
客户端IP clientip 是 string(32) 127.0.0.1 用户客户端的IP地址
String returnAppid
回调应用appid return_appid 否 string(32) wxcbda96de0b16 用来控制签约页面结束后的返回路径, 当指定该字段是,签约成功将返回return_appid指定的APP应用,如果不填且签约发起的浏览器ua可被微信识别, 则挑战到浏览器,否则留在微信
String outerId
商户测用户标识 outerid 否 string(32) 陈*(10000001) 用于多账号签约,值与contract_display_account一样就行
String planId
协议模板ID plan_id 是 String(28) 12535 协议模板ID,分为首次签约,支付中签约,重新签约
String contractCode
签约协议号 contract_code 是 String(32) 100000 商户侧签约协议号,由商户生成,只能是数字,大小写字母组成
Long requestSerial
请求序列号 request_serial 是 int(64) 1000 商户请求签约时的序列号,要求唯一性,禁止使用0开头的,用户排序,纯数字
String contractDisplayAccount
用户账户展示名称 contract_display_account 是 string(32) 微信代扣 签约用户的名称,用户页面展示,不支持符号表情
String notifyUrl
回调通知URL notify_url 是 string(256) https://weixin.qq.com 用于接收签约成功消息的回调通知地址
String version
版本号 sign 是 string(8) 1.0 固定值1.0
String timestamp
时间戳 timestamp 是 string(10) 1414488825 系统当前时间,10位
String outerId
商户侧用户标识 outerId 否 String 陈*(141448825) 用户在商户侧的标识
String planId
协议模板ID plan_id 是 String(28) 12535 协议模板ID,分为首次签约,支付中签约,重新签约
String contractCode
签约协议号 contract_code 是 String(32) 100000 商户侧签约协议号,由商户生成,只能是数字,大小写字母组成
Long requestSerial
请求序列号 request_serial 是 int(64) 1000 商户请求签约时的序列号,要求唯一性,禁止使用0开头的,用户排序,纯数字
String contractDisplayAccount
用户账户展示名称 contract_display_account 是 string(32) 微信代扣 签约用户的名称,用户页面展示,不支持符号表情
String notifyUrl
回调通知URL notify_url 是 string(256) https://weixin.qq.com 用于接收签约成功消息的回调通知地址
String version
版本号 sign 是 string(8) 1.0 固定值1.0
String timestamp
时间戳 timestamp 是 string(10) 1414488825 系统当前时间,10位
Integer returnWeb
返回web return_web 否 int 1 用来控制签约页面结束后的返回路径(不传签约后留在微信内),1 表示返回签约页面的referrer url, 不填或获取不到referrer则不返回,跳转referrer url 时会自动带上from_wxpay=1
String outerId
商户测的用户标识 outerid 否 String() 陈*(101000203) 用于多账户签约,同一个模板下要保持一致,取值和contractDisplayAccount取一样就行
String billDate
字段名:账单日期 变量名:bill_date 是否必填:是 类型:string[1,10] 描述: 格式YYYY-MM-DD 仅支持三个月内的账单下载申请。 示例值:2019-06-11
String accountType
字段名:资金账户类型 变量名:account_type 是否必填:是 类型:string[1,32] 描述: 不填则默认是BASIC 枚举值: BASIC:基本账户 OPERATION:运营账户 FEES:手续费账户 示例值:BASIC
String tarType
字段名:压缩类型 变量名:tar_type 是否必填:是 类型:string[1,32] 描述: 不填则默认是数据流 枚举值: GZIP:返回格式为.gzip的压缩包账单 示例值:GZIP
String billDate
字段名:账单日期 变量名:bill_date 是否必填:是 类型:string[1,10] 描述: 格式YYYY-MM-DD 仅支持三个月内的账单下载申请。 示例值:2019-06-11
String billType
字段名:账单类型 变量名:bill_type 是否必填:是 类型:string[1,32] 描述: 不填则默认是ALL 枚举值: ALL:返回当日所有订单信息(不含充值退款订单) SUCCESS:返回当日成功支付的订单(不含充值退款订单) REFUND:返回当日退款订单(不含充值退款订单) 示例值:ALL
String tarType
字段名:压缩类型 变量名:tar_type 是否必填:是 类型:string[1,32] 描述: 不填则默认是数据流 枚举值: GZIP:返回格式为.gzip的压缩包账单 示例值:GZIP
String authCode
授权码 auth_code 是 String(128) 扫码支付授权码,设备读取用户微信中的条码或者二维码信息
String appid
字段名:应用ID 变量名:appid 是否必填:是 类型:string[1,32] 描述: 由微信生成的应用ID,全局唯一。请求统一下单接口时请注意APPID的应用属性,例如公众号场景下,需使用应用属性为公众号的APPID 示例值:wxd678efh567hg6787
String mchid
字段名:直连商户号 变量名:mchid 是否必填:是 类型:string[1,32] 描述: 直连商户的商户号,由微信支付生成并下发。 示例值:1230000109
String description
字段名:商品描述 变量名:description 是否必填:是 类型:string[1,127] 描述: 商品描述 示例值:Image形象店-深圳腾大-QQ公仔
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string[6,32] 描述: 商户系统内部订单号,只能是数字、大小写字母_-*且在同一个商户号下唯一 示例值:1217752501201407033233368018
String transactionId
字段名:微信支付返回的订单号 变量名:transaction_id 是否必填:是 类型:string(32) 描述: 微信分配的公众账号ID 示例值:1000320306201511078440737890
String attach
字段名:附加数据 变量名:attach 是否必填:否 类型:string[1,128] 描述: 附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用 示例值:自定义数据
String goodsTag
字段名:订单优惠标记 变量名:goods_tag 是否必填:否 类型:string[1,256] 描述: 订单优惠标记 示例值:WXG
Boolean supportFapiao
字段名:电子发票入口开放标识 变量名:support_fapiao 是否必填:否 类型:boolean 描述:传入true时,支付成功消息和支付详情页将出现开票入口。需要在微信支付商户平台或微信公众平台开通电子发票功能,传此字段才可生效。
WxPayCodepayRequest.Payer payer
字段名:支付者 变量名:payer 是否必填:是 类型:object 描述: 支付者信息
WxPayCodepayRequest.Amount amount
字段名:订单金额 变量名:amount 是否必填:是 类型:object 描述: 订单金额信息
WxPayCodepayRequest.SceneInfo sceneInfo
字段名:场景信息 变量名:scene_info 是否必填:否 类型:object 描述: 支付场景描述
List<E> promotionDetails
字段名:优惠功能 变量名:promotion_detail 是否必填:否 类型:array 描述: 优惠功能,享受优惠时返回该字段。
WxPayCodepayRequest.SettleInfo settleInfo
字段名:结算信息 变量名:settle_info 是否必填:否 类型:Object 描述:结算信息
Integer total
字段名:总金额 变量名:total 是否必填:否 类型:int 描述: 订单总金额,单位为分。 示例值:100
Integer payerTotal
字段名:用户支付金额 变量名:payer_total 是否必填:否 类型:int 描述: 用户支付金额,单位为分。 示例值:100
String currency
字段名:货币类型 变量名:currency 是否必填:否 类型:string[1,16] 描述: CNY:人民币,境内商户号仅支持人民币。 示例值:CNY
String payerCurrency
字段名:用户支付币种 变量名:payer_currency 是否必填:否 类型:string[1,16] 描述: 用户支付币种 示例值: CNY
String goodsId
字段名:商品编码 变量名:goods_id 是否必填:是 类型:string[1,32] 描述: 商品编码 示例值:M1006
Integer quantity
字段名:商品数量 变量名:quantity 是否必填:是 类型:int 描述: 用户购买的数量 示例值:1
Integer unitPrice
字段名:商品单价 变量名:unit_price 是否必填:是 类型:int 描述: 商品单价,单位为分 示例值:100
Integer discountAmount
字段名:商品优惠金额 变量名:discount_amount 是否必填:是 类型:int 描述: 商品优惠金额 示例值:0
String goodsRemark
字段名:商品备注 变量名:goods_remark 是否必填:否 类型:string[1,128] 描述: 商品备注信息 示例值:商品备注信息
String authCode
字段名:用户标识 变量名:auth_code 是否必填:是 类型:string[32] 描述: 付款码支付授权码,即用户打开微信钱包显示的码。 示例值:130061098828009406
String couponId
字段名:券ID 变量名:coupon_id 是否必填:是 类型:string[1,32] 描述: 券ID 示例值:109519
String name
字段名:优惠名称 变量名:name 是否必填:否 类型:string[1,64] 描述: 优惠名称 示例值:单品惠-6
String scope
字段名:优惠范围 变量名:scope 是否必填:否 类型:string[1,32] 描述: GLOBAL:全场代金券 SINGLE:单品优惠 示例值:GLOBAL
String type
字段名:优惠类型 变量名:type 是否必填:否 类型:string[1,32] 描述: CASH:充值 NOCASH:预充值 示例值:CASH
Integer amount
字段名:优惠券面额 变量名:amount 是否必填:是 类型:int 描述: 优惠券面额 示例值:100
String stockId
字段名:活动ID 变量名:stock_id 是否必填:否 类型:string[1,32] 描述: 活动ID 示例值:931386
Integer wechatpayContribute
字段名:微信出资 变量名:wechatpay_contribute 是否必填:否 类型:int 描述: 微信出资,单位为分 示例值:0
Integer merchantContribute
字段名:商户出资 变量名:merchant_contribute 是否必填:否 类型:int 描述: 商户出资,单位为分 示例值:0
Integer otherContribute
字段名:其他出资 变量名:other_contribute 是否必填:否 类型:int 描述: 其他出资,单位为分 示例值:0
String currency
字段名:优惠币种 变量名:currency 是否必填:否 类型:string[1,16] 描述: CNY:人民币,境内商户号仅支持人民币。 示例值:CNY
List<E> goodsDetails
字段名:单品列表 变量名:goods_detail 是否必填:否 类型:array 描述: 单品列表信息
String deviceIp
字段名:商户端设备 IP 变量名:device_ip 是否必填:是 类型:string[1,45] 描述: 用户的客户端IP,支持IPv4和IPv6两种格式的IP地址。 示例值:14.23.150.211
String deviceId
字段名:商户端设备号 变量名:device_id 是否必填:否 类型:string[1,32] 描述: 商户端设备号(门店号或收银设备ID)。 示例值:013467007045764
WxPayCodepayRequest.StoreInfo storeInfo
字段名:商户门店信息 变量名:store_info 是否必填:否 类型:object 描述: 商户门店信息
Boolean profitSharing
字段名:是否指定分账 变量名:profit_sharing 是否必填:否 类型:boolean 描述: 是否指定分账 示例值:false
String id
字段名:门店编号 变量名:id 是否必填:是 类型:string[1,32] 描述: 此参数与商家自定义编码(out_id)二选一必填。 微信支付线下场所ID,格式为纯数字。 基于合规要求与风险管理目的,线下条码支付时需传入用户实际付款的场景信息。 指引参见:https://kf.qq.com/faq/230817neeaem2308177ZFfqM.html。 示例值:0001
String outId
字段名:商家自定义编码 变量名:out_id 是否必填:否 类型:string[1,256] 描述: 此参数与门店(id)二选一必填。 商户系统的门店编码,支持大小写英文字母、数字,仅支持utf-8格式。 基于合规要求与风险管理目的,线下条码支付时需传入用户实际付款的场景信息。 示例值:A1111
String deviceInfo
设备号 device_info 否 String(32) 13467007045764 终端设备号
String billType
账单类型 bill_type 是 ALL String(8) --ALL,返回当日所有订单信息,默认值 --SUCCESS,返回当日成功支付的订单 --REFUND,返回当日退款订单
String billDate
对账单日期 bill_date 是 String(8) 20140603 下载对账单的日期,格式:20140603
String tarType
压缩账单 tar_type 否 String(8) GZIP 非必传参数,固定值:GZIP,返回格式为.gzip的压缩包账单。不传则默认为数据流形式。
String contractMchId
签约商户号 contract_mchid 是 String(32) 1200009811 签约商户号,必须与mch_id一致
String contractAppId
签约APPID contract_appid 是 String(32) wxcbda96de0b165486 签约公众号,必须与APPID一致
String outTradeNo
商户订单号 out_trade_no 是 String(32) 123456 商户系统内部的订单号,32字符内,可包含字母
String deviceInfo
设备号 device_info 否 String(32) 013467007045764 终端设备号,若为PC网页或公众号内则传WEB
String body
商品描述 body 是 String(128) ipad mini 16G 白色 商品支付单简要描述
String detail
商品详情 detail 否 String(8192) ipad mini 16G 白色 商品名称明细列表
String attach
附加数据 attach 否 String(127) online/dev/dev1 商家数据包
String notifyUrl
回调通知url notify_url 是 String(256) https://weixin.qq.com 回调通知地址
Integer totalFee
总金额 total_fee 是 int 888 订单总金额,单位分
String spbillCreateIp
终端ip spbill_create_ip 是 String(16) 127.0.0.1 用户的客户端IP
String timeStart
交易起始时间 time_start 否 String(14) 20201025171529 订单生成时间,格式yyyyMMddHHmmss
String timeExpire
交易结束时间 time_expire 否 String(14) 20201025171529 订单失效时间,格式yyyyMMddHHmmss
String goodsTag
商品标记 goods_tag 否 String(32) wxg 商品标记,代金券或立减优惠功能参数
String tradeType
交易类型 trade_type 是 String(16) JSAPI JSAPI,MWEB
String productId
商品ID product_id 否 String(32) 12234355463434643 二维码支付必传,二维码中包含商品ID
String limitPay
指定支付方式 limit_pay 否 String(32) no_credit no_credit--指定不能使用信用卡支付
String openId
用户表示 openid 否 String(128) oUpF4sdsidj3Jds89 tradetype=JSAPI 则必传
String planId
协议模板ID plan_id 是 String(28) 12535 协议模板ID,分为首次签约,支付中签约,重新签约
String contractCode
签约协议号 contract_code 是 String(32) 100000 商户侧签约协议号,由商户生成,只能是数字,大小写字母组成
Long requestSerial
请求序列号 request_serial 是 int(64) 1000 商户请求签约时的序列号,要求唯一性,禁止使用0开头的,用户排序,纯数字
String contractDisplayAccount
用户账户展示名称 contract_display_account 是 string(32) 微信代扣 签约用户的名称,用户页面展示,不支持符号表情
String contractNotifyUrl
签约信息通知URL contract_notify_url 是 string(32) https://yoursite.com 签约信息回调通知URL
String contractOuterId
商户测的用户标识 contract_outerid 否 string(32) 陈*(12000002) 用于多账户签约,值与contract_display_account相同即可,同一模板下唯一
String storeId
字段名:门店编号 变量名:store_id 是否必填:是 类型:string(32) 示例值:1001 描述:门店编号, 由商户定义, 各门店唯一
String storeName
字段名:门店名称 变量名:store_name 是否必填:是 类型:string(128) 示例值:骏易科技 描述:门店名称,由商户定义。(可用于展示)
String deviceId
字段名:终端设备编号 变量名:device_id 是否必填:是 类型:string(32) 示例值: 描述:终端设备编号,由商户定义。
String attach
字段名:附加字段 变量名:attach 是否必填:是 类型:string 示例值: 描述:附加字段。字段格式使用Json
String rawdata
字段名:初始化数据 变量名:attach 是否必填:是 类型:string(2048) 示例值: 描述:初始化数据。由微信人脸SDK的接口返回。
String now
字段名:当前时间 变量名:now 是否必填:否 类型:String(10) 示例值:1239878956 描述:取当前时间,10位unix时间戳。 例如:1239878956
String version
字段名:接口版本号. 变量名:version 是否必填:是 类型:String 示例值:1.0 描述:版本号。固定为1
String deviceInfo
字段名:设备号. 变量名:device_info 是否必填:否 类型:String(32) 示例值:013467007045764 描述:终端设备号(商户自定义,如门店编号)
String body
字段名:商品描述. 变量名:body 是否必填:是 类型:String(128) 示例值:image形象店-深圳腾大- QQ公仔 描述:商品或支付单简要描述,格式要求:门店品牌名-城市分店名-实际商品名称
String detail
字段名:商品详情. 变量名:detail 是否必填:否 类型:String(8192) 示例值: 描述:商品详细列表,使用Json格式,传输签名前请务必使用CDATA标签将JSON文本串保护起来。
String attach
字段名:附加数据. 变量名:attach 是否必填:否 类型:String(127) 示例值:说明 描述:附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据
String outTradeNo
字段名:商户订单号. 变量名:out_trade_no 是否必填:是 类型:String(32) 示例值:1217752501201407033233368018 描述:商户系统内部的订单号,32个字符内、可包含字母;更换授权码必须要换新的商户订单号 其他说明见商户订单号
Integer totalFee
字段名:总金额. 变量名:total_fee 是否必填:是 类型:Int 示例值:888 描述:订单总金额,单位为分,只能为整数,详见支付金额
String feeType
字段名:货币类型. 变量名:fee_type 是否必填:否 类型:String(16) 示例值:CNY 描述:符合ISO4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型
String spbillCreateIp
字段名:终端IP. 变量名:spbill_create_ip 是否必填:是 类型:String(16) 示例值:127.0.0.1 描述:调用微信支付API的机器IP
String goodsTag
字段名:商品标记. 变量名:goods_tag 是否必填:否 类型:String(32) 示例值:1234 描述:商品标记,代金券或立减优惠功能的参数,说明详见代金券或立减优惠
String openid
字段名:用户标识. 变量名:openid 是否必填:是 类型:String(128) 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o 描述:用户在商户appid 下的唯一标识
String faceCode
字段名:人脸凭证. 变量名:face_code 是否必填:是 类型:String(128) 示例值: 描述:人脸凭证,用于刷脸支付
String deviceInfo
字段名:设备号. 变量名:device_info 是否必填:否 类型:String(32) 示例值:013467007045764 描述:终端设备号(商户自定义,如门店编号)
String version
字段名:接口版本号. 变量名:version 是否必填:单品优惠必填 类型:String(32) 示例值:1.0 描述:单品优惠新增字段,区分原接口,固定填写1.0 更多信息,详见文档:https://pay.weixin.qq.com/wiki/doc/api/danpin.php?chapter=9_101&index=1
String body
字段名:商品描述. 变量名:body 是否必填:是 类型:String(128) 示例值:image形象店-深圳腾大- QQ公仔 描述:商品简单描述,该字段须严格按照规范传递,具体请见参数规定
String detail
字段名:商品详情. 变量名:detail 是否必填:否 类型:String(6000) 示例值: 描述:单品优惠功能字段,需要接入请见详细说明
String attach
字段名:附加数据. 变量名:attach 是否必填:否 类型:String(127) 示例值:说明 描述:附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据
String outTradeNo
字段名:商户订单号. 变量名:out_trade_no 是否必填:是 类型:String(32) 示例值:1217752501201407033233368018 描述:商户系统内部的订单号,32个字符内、可包含字母,其他说明见商户订单号
Integer totalFee
字段名:订单金额. 变量名:total_fee 是否必填:是 类型:Int 示例值:888 描述:订单总金额,单位为分,只能为整数,详见支付金额
String feeType
字段名:货币类型. 变量名:fee_type 是否必填:否 类型:String(16) 示例值:CNY 描述:符合ISO4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型
String spbillCreateIp
字段名:终端IP. 变量名:spbill_create_ip 是否必填:是 类型:String(16) 示例值:8.8.8.8 描述:调用微信支付API的机器IP
String goodsTag
字段名:商品标记. 变量名:goods_tag 是否必填:否 类型:String(32) 示例值:1234 描述:商品标记,代金券或立减优惠功能的参数,说明详见代金券或立减优惠
String limitPay
字段名:指定支付方式. 变量名:limit_pay 是否必填:否 类型:String(32) 示例值:no_credit 描述:no_credit--指定不能使用信用卡支付
String timeStart
字段名:交易起始时间. 变量名:time_start 是否必填:否 类型:String(14) 示例值:20091225091010 描述:订单生成时间,格式为yyyyMMddHHmmss,如2009年12月25日9点10分10秒表示为20091225091010。其他详见时间规则
String timeExpire
字段名:交易结束时间. 变量名:time_expire 是否必填:否 类型:String(14) 示例值:20091227091010 描述:订单失效时间,格式为yyyyMMddHHmmss,如2009年12月27日9点10分10秒表示为20091227091010。其他详见时间规则 注意:最短失效时间间隔必须大于5分钟
String receipt
字段名:电子发票入口开放标识 . 变量名:receipt 是否必填:否 类型:String(8) 示例值:Y 描述:Y,传入Y时,支付成功消息和支付详情页将出现开票入口。需要在微信支付商户平台或微信公众平台开通电子发票功能,传此字段才可生效
String authCode
字段名:授权码. 变量名:auth_code 是否必填:是 类型:String(128) 示例值:120061098828009406 描述:扫码支付授权码,设备读取用户微信中的条码或者二维码信息注:用户刷卡条形码规则:18位纯数字,以10、11、12、13、14、15开头)
String sceneInfo
字段名:场景信息. 变量名:scene_info 是否必填:否 类型:String(256) 示例值:{"store_info" : { "id": "SZTX001", "name": "腾大餐厅", "area_code": "440305", "address": "科技园中一路腾讯大厦" }} 描述:该字段用于上报场景信息,目前支持上报实际门店信息。该字段为JSON对象数据,对象格式为{"store_info":{"id": "门店ID","name": "名称","area_code": "编码","address": "地址" }}
String profitSharing
字段名:是否指定服务商分账. 变量名:profit_sharing 是否必填:否 详情:Y-是,需要分账 N-否,不分账,字母要求大写,不传默认不分账 详细参考 https://pay.weixin.qq.com/wiki/doc/api/allocation_sl.php?chapter=24_3&index=3
String outTradeNo
商户订单号 out_trade_no 二选一 String(32) 20150806125346 商户系统内部的订单号,当没提供transaction_id时需要传这个。
String mchid
字段名:直连商户号 变量名:mchid 是否必填:是 类型:string[1,32] 描述: 直连商户的商户号,由微信支付生成并下发。 示例值:1230000109
String version
字段名:接口版本号. 变量名:version 是否必填:单品优惠必填 类型:String(32) 示例值:1.0 描述:单品优惠新增字段,区分原接口,固定填写1.0, 查单接口上传version后查询结果才返回单品信息,不上传不返回单品信息。 更多信息,详见文档:https://pay.weixin.qq.com/wiki/doc/api/danpin.php?chapter=9_102&index=2
String transactionId
微信订单号 transaction_id 二选一 String(32) 1009660380201506130728806387 微信的订单号,优先使用
String outTradeNo
商户订单号 out_trade_no 二选一 String(32) 20150806125346 商户系统内部的订单号,当没提供transaction_id时需要传这个。
String mchid
字段名:直连商户号 变量名:mchid 是否必填:是 类型:string[1,32] 描述: 直连商户的商户号,由微信支付生成并下发。 示例值:1230000109
String transactionId
字段名:微信支付订单号 变量名:transaction_id 是否必填:是 类型:string[1,32] 描述: 微信支付系统生成的订单号 示例值:1217752501201407033233368018
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string[1,32] 描述: 商户系统内部订单号,只能是数字、大小写字母_-*且在同一个商户号下唯一。 特殊规则:最小字符长度为6 示例值:1217752501201407033233368018
String spMchId
字段名:服务商商户号 变量名:sp_mchid 是否必填:是 类型:string[1,32] 描述: 服务商商户号,由微信支付生成并下发。 示例值:1230000109
String subMchId
字段名:特约商户商户号 变量名:sp_mchid 是否必填:是 类型:string[1,32] 描述: 特约商户商户号,由微信支付生成并下发。 示例值:1230000109
String transactionId
字段名:微信支付订单号 变量名:transaction_id 是否必填:是 类型:string[1,32] 描述: 微信支付系统生成的订单号 示例值:1217752501201407033233368018
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string[1,32] 描述: 商户系统内部订单号,只能是数字、大小写字母_-*且在同一个商户号下唯一。 特殊规则:最小字符长度为6 示例值:1217752501201407033233368018
String fundsAccount
字段名:退款资金来源 变量名:funds_account 是否必填:否 类型:string[1, 32] 描述: 若传递此参数则使用对应的资金账户退款,否则默认使用未结算资金退款(仅对老资金流商户适用) 示例值: UNSETTLED : 未结算资金 AVAILABLE : 可用余额 UNAVAILABLE : 不可用余额 OPERATION : 运营户 BASIC : 基本账户(含可用余额和不可用余额)
String spAppid
字段名:服务商应用ID 变量名:spAppid 是否必填:是 类型:string[1,32] 描述: 由微信生成的应用ID,全局唯一。请求统一下单接口时请注意APPID的应用属性,例如公众号场景下,需使用应用属性为公众号的APPID 示例值:wxd678efh567hg6787
String spMchId
字段名:服务商商户号 变量名:spMchid 是否必填:是 类型:string[1,32] 描述: 服务商商户号,由微信支付生成并下发。 示例值:1230000109
String subAppid
字段名:子商户应用ID 变量名:subAppid 是否必填:否 类型:string[1,32] 描述: 由微信生成的应用ID,全局唯一。请求统一下单接口时请注意APPID的应用属性,例如公众号场景下,需使用应用属性为公众号的APPID 示例值:wxd678efh567hg6787
String subMchId
字段名:子商户商户号 变量名:subMchid 是否必填:是 类型:string[1,32] 描述: 子商户商户号,由微信支付生成并下发。 示例值:1230000109
String description
字段名:商品描述 变量名:description 是否必填:是 类型:string[1,127] 描述: 商品描述 示例值:Image形象店-深圳腾大-QQ公仔
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string[6,32] 描述: 商户系统内部订单号,只能是数字、大小写字母_-*且在同一个商户号下唯一 示例值:1217752501201407033233368018
String timeExpire
字段名:交易结束时间 变量名:time_expire 是否必填:是 类型:string[1,64] 描述: 订单失效时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2018-06-08T10:34:56+08:00
String attach
字段名:附加数据 变量名:attach 是否必填:否 类型:string[1,128] 描述: 附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用 示例值:自定义数据
String notifyUrl
字段名:通知地址 变量名:notify_url 是否必填:是 类型:string[1,256] 描述: 通知URL必须为直接可访问的URL,不允许携带查询串,要求必须为https地址。 格式:URL 示例值:https://www.weixin.qq.com/wxpay/pay.php
String goodsTag
字段名:订单优惠标记 变量名:goods_tag 是否必填:否 类型:string[1,256] 描述: 订单优惠标记 示例值:WXG
Boolean supportFapiao
字段名:电子发票入口开放标识 变量名:support_fapiao 是否必填:否 类型:boolean 描述:传入true时,支付成功消息和支付详情页将出现开票入口。需要在微信支付商户平台或微信公众平台开通电子发票功能,传此字段才可生效。
WxPayPartnerUnifiedOrderV3Request.Amount amount
字段名:订单金额 变量名:amount 是否必填:是 类型:object 描述: 订单金额信息
WxPayPartnerUnifiedOrderV3Request.Payer payer
字段名:支付者 变量名:payer 是否必填:是 类型:object 描述: 支付者信息
WxPayPartnerUnifiedOrderV3Request.Discount detail
字段名:优惠功能 变量名:detail 是否必填:否 类型:object 描述: 优惠功能
WxPayPartnerUnifiedOrderV3Request.SceneInfo sceneInfo
字段名:场景信息 变量名:scene_info 是否必填:否 类型:object 描述: 支付场景描述
WxPayPartnerUnifiedOrderV3Request.SettleInfo settleInfo
字段名:结算信息 变量名:settle_info 是否必填:否 类型:Object 描述:结算信息
Integer costPrice
字段名:订单原价 变量名:cost_price 是否必填:否 类型:int 描述: 1、商户侧一张小票订单可能被分多次支付,订单原价用于记录整张小票的交易金额。 2、当订单原价与支付金额不相等,则不享受优惠。 3、该字段主要用于防止同一张小票分多次支付,以享受多次优惠的情况,正常支付订单不必上传此参数。 示例值:608800
String invoiceId
字段名:商品小票ID 变量名:invoice_id 是否必填:否 类型:string[1,32] 描述: 商品小票ID 示例值:微信123
List<E> goodsDetails
字段名:单品列表 变量名:goods_detail 是否必填:否 类型:array 描述: 单品列表信息 条目个数限制:【1,6000】
String merchantGoodsId
字段名:商户侧商品编码 变量名:merchant_goods_id 是否必填:是 类型:string[1,32] 描述: 由半角的大小写字母、数字、中划线、下划线中的一种或几种组成。 示例值:商品编码
String wechatpayGoodsId
字段名:微信侧商品编码 变量名:wechatpay_goods_id 是否必填:否 类型:string[1,32] 描述: 微信支付定义的统一商品编号(没有可不传) 示例值:1001
String goodsName
字段名:商品名称 变量名:goods_name 是否必填:否 类型:string[1,256] 描述: 商品的实际名称 示例值:iPhoneX 256G
Integer quantity
字段名:商品数量 变量名:quantity 是否必填:是 类型:int 描述: 用户购买的数量 示例值:1
Integer unitPrice
字段名:商品单价 变量名:unit_price 是否必填:是 类型:int 描述: 商品单价,单位为分 示例值:828800
String type
字段名:场景类型 变量名:type 是否必填:是 类型:string[1,32] 描述: 场景类型 示例值:iOS, Android, Wap
String appName
字段名:应用名称 变量名:app_name 是否必填:否 类型:string[1,64] 描述: 应用名称 示例值:王者荣耀
String appUrl
字段名:网站URL 变量名:app_url 是否必填:否 类型:string[1,128] 描述: 网站URL 示例值:https://pay.qq.com
String bundleId
字段名:iOS平台BundleID 变量名:bundle_id 是否必填:否 类型:string[1,128] 描述: iOS平台BundleID 示例值:com.tencent.wzryiOS
String packageName
字段名:Android平台PackageName 变量名:package_name 是否必填:否 类型:string[1,128] 描述: Android平台PackageName 示例值:com.tencent.tmgp.sgame
String payerClientIp
字段名:用户终端IP 变量名:payer_client_ip 是否必填:是 类型:string[1,45] 描述: 用户的客户端IP,支持IPv4和IPv6两种格式的IP地址。 示例值:14.23.150.211
String deviceId
字段名:商户端设备号 变量名:device_id 是否必填:否 类型:string[1,32] 描述: 商户端设备号(门店号或收银设备ID)。 示例值:013467007045764
WxPayPartnerUnifiedOrderV3Request.StoreInfo storeInfo
字段名:商户门店信息 变量名:store_info 是否必填:否 类型:object 描述: 商户门店信息
WxPayPartnerUnifiedOrderV3Request.H5Info h5Info
字段名:H5场景信息 变量名:h5_info 是否必填:否(H5支付必填) 类型:object 描述: H5场景信息
Boolean profitSharing
字段名:是否指定分账 变量名:profit_sharing 是否必填:否 类型:boolean 描述: 是否指定分账 示例值:false
String id
字段名:门店编号 变量名:id 是否必填:是 类型:string[1,32] 描述: 商户侧门店编号 示例值:0001
String name
字段名:门店名称 变量名:name 是否必填:否 类型:string[1,256] 描述: 商户侧门店名称 示例值:腾讯大厦分店
String areaCode
字段名:地区编码 变量名:area_code 是否必填:否 类型:string[1,32] 描述: 地区编码, 详细请见省市区编号对照表。 示例值:440305
String address
字段名:详细地址 变量名:address 是否必填:是 类型:string[1,512] 描述: 详细的商户门店地址 示例值:广东省深圳市南山区科技中一道10000号
String beginTime
字段名:开始时间. 变量名:begin_time 是否必填:是 类型:String(19) 示例值:20170724000000 描述:按用户评论时间批量拉取的起始时间,格式为yyyyMMddHHmmss
String endTime
字段名:结束时间. 变量名:end_time 是否必填:是 类型:String(19) 示例值:20170725000000 描述:按用户评论时间批量拉取的结束时间,格式为yyyyMMddHHmmss
Integer offset
字段名:位移. 变量名:offset 是否必填:是 类型:uint(64) 示例值:0 描述:指定从某条记录的下一条开始返回记录。接口调用成功时,会返回本次查询最后一条数据的offset。商户需要翻页时,应该把本次调用返回的offset 作为下次调用的入参。注意offset是评论数据在微信支付后台保存的索引,未必是连续的
Integer limit
字段名:条数. 变量名:limit 是否必填:否 类型:uint(32) 示例值:100 描述:一次拉取的条数, 最大值是200,默认是200
String deviceInfo
设备号 device_info 否 String(32) 013467007045764 商户自定义的终端设备号,如门店编号、设备的ID等
String transactionId
微信订单号 transaction_id String(32) 1217752501201407033233368018 微信订单号
String outTradeNo
商户订单号 out_trade_no String(32) 1217752501201407033233368018 商户系统内部的订单号
String outRefundNo
商户退款单号 out_refund_no String(32) 1217752501201407033233368018 商户侧传给微信的退款单号
String refundId
微信退款单号 refund_id String(28) 1217752501201407033233368018 微信生成的退款单号,在申请退款接口有返回
String deviceInfo
字段名:设备号. 变量名:device_info 是否必填:否 类型:String(32) 示例值:13467007045764 描述:终端设备号
String transactionId
字段名:微信订单号. 变量名:transaction_id 是否必填:跟out_trade_no二选一 类型:String(28) 示例值:1217752501201400000000000000 描述:微信生成的订单号,在支付通知中有返回
String outTradeNo
字段名:商户订单号. 变量名:out_trade_no 是否必填:跟transaction_id二选一 类型:String(32) 示例值:1217752501201400000000000000 描述:商户侧传给微信的订单号
String outRefundNo
字段名:商户退款单号. 变量名:out_refund_no 是否必填:是 类型:String(32) 示例值:1217752501201400000000000000 描述:商户系统内部的退款单号,商户系统内部唯一,同一退款单号多次请求只退一笔
Integer totalFee
字段名:订单金额. 变量名:total_fee 是否必填:是 类型:Int 示例值:100 描述:订单总金额,单位为分,只能为整数,详见支付金额
Integer refundFee
字段名:退款金额. 变量名:refund_fee 是否必填:是 类型:Int 示例值:100 描述:退款总金额,订单总金额,单位为分,只能为整数,详见支付金额
String refundFeeType
字段名:货币种类. 变量名:refund_fee_type 是否必填:否 类型:String(8) 示例值:CNY 描述:货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型
String opUserId
字段名:操作员. 变量名:op_user_id 是否必填:是 类型:String(32) 示例值:1900000109 描述:操作员帐号, 默认为商户号
String refundAccount
字段名:退款资金来源. 变量名:refund_account 是否必填:否 类型:String(30) 示例值:REFUND_SOURCE_RECHARGE_FUNDS 描述:仅针对老资金流商户使用,
String refundDesc
字段名:退款原因. 变量名:refund_account 是否必填:否 类型:String(80) 示例值:商品已售完 描述:若商户传入,会在下发给用户的退款消息中体现退款原因
String notifyUrl
字段名:退款结果通知url. 变量名:notify_url 是否必填:否 类型:String(256) 示例值:https://weixin.qq.com/notify/ 描述: 异步接收微信支付退款结果通知的回调地址,通知URL必须为外网可访问的url,不允许带参数 如果参数中传了notify_url,则商户平台上配置的回调地址将不会生效。
String detail
字段名:商品详情 变量名:detail 类型:否 示例值:String(6000) 退款包含的商品列表信息detail字段列表说明: 字段名 变量名 必填 类型 示例值 描述 商品列表 goods_detail 是 String 示例见下文 商品信息,使用Json数组格式提交 商品列表goods_detail字段列表说明: 字段名 变量名 必填 类型 示例值 描述 商品编码 goods_id 是 String(32) 商品编码 由半角的大小写字母、数字、中划线、下划线中的一种或几种组成 微信侧商品编码 wxpay_goods_id 否 String(32) 1001 微信支付定义的统一商品编号(没有可不传) 商品名称 goods_name 否 String(256) iPhone6s 16G 商品的实际名称 商品退款金额 refund_amount 是 int 528800 商品退款金额 商品退货数量 refund_quantity 是 int 1 单品的退款数量 商品单价 price 是 int 528800 单位为:分。如果商户有优惠,需传输商户优惠后的单价(例如:用户对一笔100元的订单使用了商场发的优惠券100-50,则活动商品的单价应为原单价-50) detail字段值举例如下: { "goods_detail": [ { "goods_id": "商品编码", "wxpay_goods_id": "1001", "goods_name": "iPhone6s 16G", "refund_amount": 528800, "refund_quantity": 1, "price": 528800 }, { "goods_id": "商品编码", "wxpay_goods_id": "1001", "goods_name": "iPhone6s 16G", "refund_amount": 528800, "refund_quantity": 1, "price": 608800 } ] } 描述:退款包含的商品列表信息,全额退款可不传,必须按照规范上传,JSON格式
String transactionId
字段名:微信支付订单号 变量名:transaction_id 是否必填:与out_order_no二选一 类型:string[1, 32] 描述: 原支付交易对应的微信订单号。 示例值:1217752501201407033233368018
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:与transaction_id二选一 类型:string[1, 32] 描述: 原支付交易对应的商户订单号。 示例值:1217752501201407033233368018
String outRefundNo
字段名:商户退款单号 变量名:out_refund_no 是否必填:是 类型:string[1, 64] 描述: 商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母_-|*@ ,同一退款单号多次请求只退一笔。 示例值:1217752501201407033233368018
String reason
字段名:退款原因 变量名:reason 是否必填:否 类型:string[1, 80] 描述: 若商户传入,会在下发给用户的退款消息中体现退款原因。 示例值:商品已售完
String notifyUrl
字段名:退款结果回调url 变量名:notify_url 是否必填:否 类型:string[8, 256] 描述: 异步接收微信支付退款结果通知的回调地址,通知url必须为外网可访问的url,不能携带参数。 如果参数中传了notify_url,则商户平台上配置的回调地址将不会生效,优先回调当前传的这个地址。 示例值:https://weixin.qq.com
WxPayRefundV3Request.Amount amount
字段名:订单金额 变量名:amount 是否必填:是 类型:object 描述: 订单金额信息
List<E> goodsDetails
字段名:退款商品 变量名:goods_detail 是否必填:否 类型:array 描述: 指定商品退款需要传此参数,其他场景无需传递。
String subMchid
字段名:子商户的商户号 变量名:sub_mchid 是否必填:是 类型:string[1, 32] 描述: 子商户商户号,由微信支付生成并下发。 示例值:1230000109
Integer refund
字段名:退款金额 变量名:refund 是否必填:是 类型:int 描述: 退款金额,币种的最小单位,只能为整数,不能超过原订单支付金额。 示例值:888
Integer total
字段名:原订单金额 变量名:total 是否必填:是 类型:int 描述: 原支付交易的订单总金额,币种的最小单位,只能为整数。 示例值:888
String currency
字段名:币类型 变量名:currency 是否必填:是 类型:string[1, 16] 描述: 符合ISO 4217标准的三位字母代码,目前只支持人民币:CNY。 示例值:CNY
String merchantGoodsId
字段名:商户侧商品编码 变量名:merchant_goods_id 是否必填:是 类型:string[1,32] 描述: 由半角的大小写字母、数字、中划线、下划线中的一种或几种组成。 示例值:1217752501201407033233368018
String wechatpayGoodsId
字段名:微信侧商品编码 变量名:wechatpay_goods_id 是否必填:否 类型:string[1,32] 描述: 微信支付定义的统一商品编号(没有可不传)。 示例值:1001
String goodsName
字段名:商品名称 变量名:goods_name 是否必填:否 类型:string[1,256] 描述: 商品的实际名称。 示例值:iPhone6s 16G
Integer unitPrice
字段名:商品单价 变量名:unit_price 是否必填:是 类型:int 描述: 商品单价金额,单位为分。 示例值:528800
Integer refundAmount
字段名:商品退款金额 变量名:refund_amount 是否必填:是 类型:int 描述: 商品退款金额,单位为分。 示例值:528800
Integer refundQuantity
字段名:商品退货数量 变量名:refund_quantity 是否必填:是 类型:int 描述: 单品的退款数量。 示例值:1
String deviceInfo
设备号. device_info 否 String(32) 013467007045764 商户自定义的终端设备号,如门店编号、设备的ID等
String interfaceUrl
接口URL. interface_url 是 String(127) https://api.mch.weixin.qq.com/pay/unifiedorder 报对应的接口的完整URL,类似:https://api.mch.weixin.qq.com/pay/unifiedorder, 对于刷卡支付,为更好的和商户共同分析一次业务行为的整体耗时情况, 对于两种接入模式,请都在门店侧对一次刷卡支付进行一次单独的整体上报, 上报URL指定为:https://api.mch.weixin.qq.com/pay/micropay/total,关于两种接入模式具体可参考本文档章节: 刷卡支付商户接入模式,其它接口调用仍然按照调用一次,上报一次来进行。
Integer executeTime
接口耗时. execute_time 是 Int 1000 接口耗时情况,单位为毫秒
String returnCode
返回状态码. return_code 是 String(16) SUCCESS SUCCESS/FAIL,此字段是通信标识,非交易标识,交易是否成功需要查看trade_state来判断
String returnMsg
返回信息. return_msg 否 String(128) 签名失败 返回信息,如非空,为错误原因,签名失败,参数格式校验错误
String resultCode
业务结果. result_code 是 String(16) SUCCESS SUCCESS/FAIL
String errCode
错误代码. err_code 否 String(32) SYSTEMERROR ORDERNOTEXIST—订单不存在,SYSTEMERROR—系统错误
String errCodeDes
错误代码描述. err_code_des 否 String(128) 系统错误 结果信息描述
String outTradeNo
商户订单号. out_trade_no 否 String(32) 1217752501201407033233368018 商户系统内部的订单号,商户可以在上报时提供相关商户订单号方便微信支付更好的提高服务质量。
String userIp
访问接口IP. user_ip 是 String(16) 8.8.8.8 发起接口调用时的机器IP
String time
商户上报时间. time 否 String(14) 20091227091010 系统时间,格式为yyyyMMddHHmmss,如2009年12月27日9点10分10秒表示为20091227091010。其他详见时间规则
String mchBillNo
String sendName
String reOpenid
Integer totalAmount
Integer totalNum
String wishing
String actName
String remark
String notifyWay
String sceneId
发放红包使用场景,红包金额大于200时必传 PRODUCT_1:商品促销 PRODUCT_2:抽奖 PRODUCT_3:虚拟物品兑奖 PRODUCT_4:企业内部福利 PRODUCT_5:渠道分润 PRODUCT_6:保险回馈 PRODUCT_7:彩票派奖 PRODUCT_8:税务刮奖
String wxAppid
String mchBillNo
String sendName
String reOpenid
Integer totalAmount
Integer totalNum
String amtType
String wishing
String clientIp
String actName
String remark
String wxAppid
String msgAppid
msgappid wx28b16568a629bb33 String(32) 服务商模式下触达用户时的appid(可填服务商自己的appid或子商户的appid), 服务商模式下必填,服务商模式下填入的子商户appid必须在微信支付商户平台中先录入,否则会校验不过。
String sceneId
scene_id. 场景id PRODUCT_1:商品促销 PRODUCT_2:抽奖 PRODUCT_3:虚拟物品兑奖 PRODUCT_4:企业内部福利 PRODUCT_5:渠道分润 PRODUCT_6:保险回馈 PRODUCT_7:彩票派奖 PRODUCT_8:税务刮奖 非必填字段
String riskInfo
risk_info. 活动信息 posttime:用户操作的时间戳 mobile:业务系统账号的手机号,国家代码-手机号。不需要+号 deviceid :mac 地址或者设备唯一标识 clientversion :用户操作的客户端版本 把值为非空的信息用key=value进行拼接,再进行urlencode urlencode(posttime=xx&mobile=xx&deviceid=xx) 非必填字段
String consumeMchId
consume_mch_id. 资金授权商户号 资金授权商户号 服务商替特约商户发放时使用 非必填字段
String longUrl
URL链接 long_url 是 String(512) weixin://wxpay/bizpayurl?sign=XXXXX&appid=XXXXX&mch_id=XXXXX&product_id=XXXXXX&time_stamp=XXXXXX&nonce_str=XXXXX 需要转换的URL,签名用原串,传输需URLencode
String version
字段名:接口版本号. 变量名:version 是否必填:单品优惠必填 类型:String(32) 示例值:1.0 描述:单品优惠新增字段,接口版本号,区分原接口,默认填写1.0。 入参新增version后,则支付通知接口也将返回单品优惠信息字段promotion_detail,请确保支付通知的签名验证能通过。 更多信息,详见文档:https://pay.weixin.qq.com/wiki/doc/api/danpin.php?chapter=9_102&index=2
String deviceInfo
字段名:设备号. 变量名:device_info 是否必填:否 类型:String(32) 示例值:013467007045764 描述:终端设备号(门店号或收银设备Id),注意:PC网页或公众号内支付请传"WEB"
String body
字段名:商品描述. 变量名:body 是否必填:是 类型:String(128) 示例值: 腾讯充值中心-QQ会员充值 描述:商品简单描述,该字段须严格按照规范传递,具体请见参数规定
String detail
字段名:商品详情. 变量名:detail 是否必填:否 类型:String(6000) 示例值: { "goods_detail":[ { "goods_id":"iphone6s_16G", "wxpay_goods_id":"1001", "goods_name":"iPhone6s 16G", "goods_num":1, "price":528800, "goods_category":"123456", "body":"苹果手机" }, { "goods_id":"iphone6s_32G", "wxpay_goods_id":"1002", "goods_name":"iPhone6s 32G", "quantity":1, "price":608800, "goods_category":"123789", "body":"苹果手机" } ] } 描述:商品详细列表,使用Json格式,传输签名前请务必使用CDATA标签将JSON文本串保护起来。 goods_detail []: └ goods_id String 必填 32 商品的编号 └ wxpay_goods_id String 可选 32 微信支付定义的统一商品编号 └ goods_name String 必填 256 商品名称 └ goods_num Int 必填 商品数量 └ price Int 必填 商品单价,单位为分 └ goods_category String 可选 32 商品类目Id └ body String 可选 1000 商品描述信息
String attach
字段名:附加数据. 变量名:attach 是否必填:否 类型:String(127) 示例值: 深圳分店 描述: 附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据
String outTradeNo
字段名:商户订单号. 变量名:out_trade_no 是否必填:是 类型:String(32) 示例值:20150806125346 描述:商户系统内部的订单号,32个字符内、可包含字母, 其他说明见商户订单号
String feeType
字段名:货币类型. 变量名:fee_type 是否必填:否 类型:String(16) 示例值:CNY 描述: 符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型
Integer totalFee
字段名:总金额. 变量名:total_fee 是否必填:是 类型:Int 示例值: 888 描述:订单总金额,单位为分,详见支付金额
String spbillCreateIp
字段名:终端IP. 变量名:spbill_create_ip 是否必填:是 类型:String(16) 示例值:123.12.12.123 描述:APP和网页支付提交用户端ip,Native支付填调用微信支付API的机器IP。
String timeStart
字段名:交易起始时间. 变量名:time_start 是否必填:否 类型:String(14) 示例值:20091225091010 描述:订单生成时间,格式为yyyyMMddHHmmss,如2009年12月25日9点10分10秒表示为20091225091010。其他详见时间规则
String timeExpire
字段名:交易结束时间. 变量名:time_expire 是否必填:否 类型:String(14) 示例值:20091227091010 描述:订单失效时间,格式为yyyyMMddHHmmss,如2009年12月27日9点10分10秒表示为20091227091010。其他详见时间规则 注意:最短失效时间间隔必须大于5分钟
String goodsTag
字段名:商品标记. 变量名:goods_tag 是否必填:否 类型:String(32) 示例值:WXG 描述:商品标记,代金券或立减优惠功能的参数,说明详见代金券或立减优惠
String notifyUrl
字段名:通知地址. 变量名:notify_url 是否必填:是 类型:String(256) 示例值:http://www.weixin.qq.com/wxpay/pay.php 描述:接收微信支付异步通知回调地址,通知url必须为直接可访问的url,不能携带参数。
String tradeType
字段名:交易类型. 变量名:trade_type 是否必填:是 类型:String(16) 示例值: JSAPI 描述: 取值如下:JSAPI,NATIVE,APP,详细说明见参数规定: JSAPI--公众号支付、NATIVE--原生扫码支付、APP--app支付,统一下单接口trade_type的传参可参考这里
String productId
字段名:商品Id. 变量名:product_id 是否必填:否 类型:String(32) 示例值:12235413214070356458058 描述:trade_type=NATIVE,此参数必传。此id为二维码中包含的商品Id,商户自行定义。
String limitPay
字段名:指定支付方式. 变量名:limit_pay 是否必填:否 类型:String(32) 示例值:no_credit 描述:no_credit--指定不能使用信用卡支付
String openid
字段名:用户标识. 变量名:openid 是否必填:否 类型:String(128) 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o 描述:trade_type=JSAPI,此参数必传,用户在商户appid下的唯一标识。 openid如何获取,可参考【获取openid】。 企业号请使用【企业号OAuth2.0接口】获取企业号内成员userid,再调用【企业号userid转openid接口】进行转换
String subOpenid
字段名:用户子标识. 变量名:sub_openid 是否必填:否 类型:String(128) 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o 描述:trade_type=JSAPI,此参数必传,用户在子商户appid下的唯一标识。 openid和sub_openid可以选传其中之一,如果选择传sub_openid,则必须传sub_appid。 下单前需要调用【网页授权获取用户信息】接口获取到用户的Openid。
String receipt
字段名:电子发票入口开放标识. 变量名: receipt 是否必填:否 类型:String(8) 示例值:Y 描述:Y,传入Y时,支付成功消息和支付详情页将出现开票入口。需要在微信支付商户平台或微信公众平台开通电子发票功能,传此字段才可生效
String sceneInfo
字段名:场景信息. 变量名:scene_info 是否必填:否,对H5支付来说是必填 类型:String(256) 示例值:{ "store_id": "SZT10000", "store_name":"腾讯大厦腾大餐厅" } 描述:该字段用于统一下单时上报场景信息,目前支持上报实际门店信息。 { "store_id": "", //门店唯一标识,选填,String(32) "store_name":"”//门店名称,选填,String(64) }
String fingerprint
字段名:浏览器指纹. 变量名:fingerprint 是否必填:否 详细参考 https://pay.weixin.qq.com/wiki/doc/api/H5.php?chapter=15_7&index=6
String profitSharing
字段名:是否指定服务商分账. 变量名:profit_sharing 是否必填:否 详情:Y-是,需要分账 N-否,不分账,字母要求大写,不传默认不分账 详细参考 https://pay.weixin.qq.com/wiki/doc/api/allocation_sl.php?chapter=24_3&index=3
String appid
字段名:应用ID 变量名:appid 是否必填:是 类型:string[1,32] 描述: 由微信生成的应用ID,全局唯一。请求统一下单接口时请注意APPID的应用属性,例如公众号场景下,需使用应用属性为公众号的APPID 示例值:wxd678efh567hg6787
String mchid
字段名:直连商户号 变量名:mchid 是否必填:是 类型:string[1,32] 描述: 直连商户的商户号,由微信支付生成并下发。 示例值:1230000109
String description
字段名:商品描述 变量名:description 是否必填:是 类型:string[1,127] 描述: 商品描述 示例值:Image形象店-深圳腾大-QQ公仔
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string[6,32] 描述: 商户系统内部订单号,只能是数字、大小写字母_-*且在同一个商户号下唯一 示例值:1217752501201407033233368018
String timeExpire
字段名:交易结束时间 变量名:time_expire 是否必填:是 类型:string[1,64] 描述: 订单失效时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2018-06-08T10:34:56+08:00
String attach
字段名:附加数据 变量名:attach 是否必填:否 类型:string[1,128] 描述: 附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用 示例值:自定义数据
String notifyUrl
字段名:通知地址 变量名:notify_url 是否必填:是 类型:string[1,256] 描述: 通知URL必须为直接可访问的URL,不允许携带查询串,要求必须为https地址。 格式:URL 示例值:https://www.weixin.qq.com/wxpay/pay.php
String goodsTag
字段名:订单优惠标记 变量名:goods_tag 是否必填:否 类型:string[1,256] 描述: 订单优惠标记 示例值:WXG
Boolean supportFapiao
字段名:电子发票入口开放标识 变量名:support_fapiao 是否必填:否 类型:boolean 描述:传入true时,支付成功消息和支付详情页将出现开票入口。需要在微信支付商户平台或微信公众平台开通电子发票功能,传此字段才可生效。
WxPayUnifiedOrderV3Request.Amount amount
字段名:订单金额 变量名:amount 是否必填:是 类型:object 描述: 订单金额信息
WxPayUnifiedOrderV3Request.Payer payer
字段名:支付者 变量名:payer 是否必填:是 类型:object 描述: 支付者信息
WxPayUnifiedOrderV3Request.Discount detail
字段名:优惠功能 变量名:detail 是否必填:否 类型:object 描述: 优惠功能
WxPayUnifiedOrderV3Request.SceneInfo sceneInfo
字段名:场景信息 变量名:scene_info 是否必填:否 类型:object 描述: 支付场景描述
WxPayUnifiedOrderV3Request.SettleInfo settleInfo
字段名:结算信息 变量名:settle_info 是否必填:否 类型:Object 描述:结算信息
Integer costPrice
字段名:订单原价 变量名:cost_price 是否必填:否 类型:int 描述: 1、商户侧一张小票订单可能被分多次支付,订单原价用于记录整张小票的交易金额。 2、当订单原价与支付金额不相等,则不享受优惠。 3、该字段主要用于防止同一张小票分多次支付,以享受多次优惠的情况,正常支付订单不必上传此参数。 示例值:608800
String invoiceId
字段名:商品小票ID 变量名:invoice_id 是否必填:否 类型:string[1,32] 描述: 商品小票ID 示例值:微信123
List<E> goodsDetails
字段名:单品列表 变量名:goods_detail 是否必填:否 类型:array 描述: 单品列表信息 条目个数限制:【1,6000】
String merchantGoodsId
字段名:商户侧商品编码 变量名:merchant_goods_id 是否必填:是 类型:string[1,32] 描述: 由半角的大小写字母、数字、中划线、下划线中的一种或几种组成。 示例值:商品编码
String wechatpayGoodsId
字段名:微信侧商品编码 变量名:wechatpay_goods_id 是否必填:否 类型:string[1,32] 描述: 微信支付定义的统一商品编号(没有可不传) 示例值:1001
String goodsName
字段名:商品名称 变量名:goods_name 是否必填:否 类型:string[1,256] 描述: 商品的实际名称 示例值:iPhoneX 256G
Integer quantity
字段名:商品数量 变量名:quantity 是否必填:是 类型:int 描述: 用户购买的数量 示例值:1
Integer unitPrice
字段名:商品单价 变量名:unit_price 是否必填:是 类型:int 描述: 商品单价,单位为分 示例值:828800
String type
字段名:场景类型 变量名:type 是否必填:是 类型:string[1,32] 描述: 场景类型 示例值:iOS, Android, Wap
String appName
字段名:应用名称 变量名:app_name 是否必填:否 类型:string[1,64] 描述: 应用名称 示例值:王者荣耀
String appUrl
字段名:网站URL 变量名:app_url 是否必填:否 类型:string[1,128] 描述: 网站URL 示例值:https://pay.qq.com
String bundleId
字段名:iOS平台BundleID 变量名:bundle_id 是否必填:否 类型:string[1,128] 描述: iOS平台BundleID 示例值:com.tencent.wzryiOS
String packageName
字段名:Android平台PackageName 变量名:package_name 是否必填:否 类型:string[1,128] 描述: Android平台PackageName 示例值:com.tencent.tmgp.sgame
String openid
字段名:用户标识 变量名:openid 是否必填:是 类型:string[1,128] 描述: 用户在直连商户appid下的唯一标识。 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
WxPayUnifiedOrderV3Request.Identity identity
String payerClientIp
字段名:用户终端IP 变量名:payer_client_ip 是否必填:是 类型:string[1,45] 描述: 用户的客户端IP,支持IPv4和IPv6两种格式的IP地址。 示例值:14.23.150.211
String deviceId
字段名:商户端设备号 变量名:device_id 是否必填:否 类型:string[1,32] 描述: 商户端设备号(门店号或收银设备ID)。 示例值:013467007045764
WxPayUnifiedOrderV3Request.StoreInfo storeInfo
字段名:商户门店信息 变量名:store_info 是否必填:否 类型:object 描述: 商户门店信息
WxPayUnifiedOrderV3Request.H5Info h5Info
字段名:H5场景信息 变量名:h5_info 是否必填:否(H5支付必填) 类型:object 描述: H5场景信息
Boolean profitSharing
字段名:是否指定分账 变量名:profit_sharing 是否必填:否 类型:boolean 描述: 是否指定分账 示例值:false
String id
字段名:门店编号 变量名:id 是否必填:是 类型:string[1,32] 描述: 商户侧门店编号 示例值:0001
String name
字段名:门店名称 变量名:name 是否必填:否 类型:string[1,256] 描述: 商户侧门店名称 示例值:腾讯大厦分店
String areaCode
字段名:地区编码 变量名:area_code 是否必填:否 类型:string[1,32] 描述: 地区编码, 详细请见省市区编号对照表。 示例值:440305
String address
字段名:详细地址 变量名:address 是否必填:是 类型:string[1,512] 描述: 详细的商户门店地址 示例值:广东省深圳市南山区科技中一道10000号
String mchId
String appId
WxPreWithholdRequest.EstimateAmount estimateAmount
String contractId
字段名:委托代扣协议ID. 变量名:contract_id 是否必填:二选一 类型:String(32) 示例值:1000005698 签约成功后由微信返回
String version
字段名:接口版本号. 变量名:version 是否必填:是 类型:String(8) 示例值:1.0 固定填写1.0,
Integer planId
字段名:模板ID. 变量名:plan_id 是否必填:二选一 类型:int 示例值:123 代扣模板ID
String contractCode
字段名:签约协议号. 变量名:contract_code 是否必填:二选一 类型:String(32) 示例值:12332343 商户侧唯一
String contractId
字段名:委托代扣协议ID. 变量名:contract_id 是否必填:二选一 类型:String(32) 示例值:1000005698 签约成功后由微信返回
String contractTerminationRemark
字段名:解约备注. 变量名:contract_termination_remark 是否必填:是 类型:String(256) 示例值:解约原因 例如:签约信息有误,须重新签约
String version
字段名:接口版本号. 变量名:version 是否必填:是 类型:String(8) 示例值:1.0 固定填写1.0,
Integer planId
字段名:模板ID. 变量名:plan_id 是否必填:二选一 类型:int 示例值:123 代扣模板ID
String contractCode
字段名:签约协议号. 变量名:contract_code 是否必填:二选一 类型:String(32) 示例值:12332343 商户侧唯一
String body
商品描述 body 是 String(128) ipad mini 16G 白色 商品支付单简要描述
String detail
商品详情 detail 否 String(8192) ipad mini 16G 白色 商品名称明细列表
String attach
附加数据 attach 否 String(127) online/dev/dev1 商家数据包
String outTradeNo
商户订单号 out_trade_no 是 String(32) 123456 商户系统内部的订单号,32字符内,可包含字母
Integer totalFee
总金额 total_fee 是 int 888 订单总金额,单位分
String feeType
货币类型 fee_type 否 String(16) CNY 默认人民币:CNY
String spbillCreateIp
终端ip spbill_create_ip 否 String(16) 127.0.0.1 用户的客户端IP
String goodsTag
商品标记 goods_tag 否 String(32) wxg 商品标记,代金券或立减优惠功能参数
String notifyUrl
回调通知url notify_url 是 String(256) https://weixin.qq.com 回调通知地址
String tradeType
交易类型 trade_type 是 String(16) JSAPI JSAPI,MWEB
String contractId
委托代扣协议ID contract_id 是 String(32) Wx234324808503234483920 签约成功后微信返回的委托代扣协议ID
String combineAppid
字段名:合单商户appid 变量名:combine_appid 是否必填:是 类型:string[1,32] 描述: 合单发起方的appid。 示例值:wxd678efh567hg6787
String combineMchid
字段名:合单商户号 变量名:combine_mchid 是否必填:是 类型:string[1,32] 描述: 合单发起方商户号。 示例值:1900000109
String combineOutTradeNo
字段名:合单商户订单号 变量名:combine_out_trade_no 是否必填:是 类型:string[1,32] 描述: 合单支付总订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一。 示例值:P20150806125346
CombineQueryResult.SceneInfo sceneInfo
字段名:场景信息 变量名:scene_info 是否必填:否 类型:object 描述:支付场景信息描述
List<E> subOrders
字段名:子单信息 变量名:sub_orders 是否必填:是 类型:array 描述: 最多支持子单条数:10
CombineQueryResult.CombinePayerInfo combinePayerInfo
字段名:支付者 变量名:combine_payer_info 是否必填:否 类型:object 描述: 示例值:见请求示例
Integer totalAmount
字段名:标价金额 变量名:total_amount 是否必填:是 类型:int64 描述: 子单金额,单位为分。 示例值:100
String currency
字段名:标价币种 变量名:currency 是否必填:是 类型:string[1,8] 描述: 符合ISO 4217标准的三位字母代码,人民币:CNY。 示例值:CNY
Integer payerAmount
字段名:现金支付金额 变量名:payer_amount 是否必填:是 类型:int64 描述: 订单现金支付金额。 示例值:10
String payerCurrency
字段名:现金支付币种 变量名:payer_currency 是否必填:是 类型:string[1,8] 描述: 货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY。 示例值: CNY
String openid
字段名:用户标识 变量名:openid 是否必填:是 类型:string[1,128] 描述: 使用合单appid获取的对应用户openid。是用户在商户appid下的唯一标识。 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
String goodsId
字段名:商品编码 变量名:goods_id 是否必填:是 类型:string[1, 32] 描述: 商品编码 示例值:M1006
Integer quantity
字段名:商品数量 变量名:quantity 是否必填:是 类型:int 描述: 商品数量 示例值:1
Integer unitPrice
字段名:商品单价 变量名:unit_price 是否必填:是 类型:int 描述: 商品价格 示例值:100
Integer discountAmount
字段名:商品优惠金额 变量名:discount_amount 是否必填:是 类型:int 描述: 商品优惠金额 示例值:1
String goodsRemark
字段名:商品备注 变量名:goods_remark 是否必填:否 类型:string[1, 128] 描述: 商品备注 示例值:商品备注信息
String couponId
字段名:券ID 变量名:coupon_id 是否必填:是 类型:string[1, 32] 描述: 券ID 示例值:109519
String name
字段名:优惠名称 变量名:name 是否必填:否 类型:string[1, 64] 描述: 优惠名称 示例值:单品惠-6
String scope
字段名:优惠范围 变量名:scope 是否必填:否 类型:string[1, 32] 描述: GLOBAL:全场代金券 SINGLE:单品优惠 示例值:GLOBALSINGLE
String type
字段名:优惠类型 变量名:type 是否必填:否 类型:string[1,8] 描述: CASH:充值; NOCASH:预充值。 示例值:CASH
Integer amount
字段名:优惠券面额 变量名:amount 是否必填:是 类型:int 描述: 当前子单中享受的优惠券金额 示例值:100
String stockId
字段名:活动ID 变量名:stock_id 是否必填:否 类型:string[1, 32] 描述: 活动ID,批次ID 示例值:931386
Integer wechatpayContribute
字段名:微信出资 变量名:wechatpay_contribute 是否必填:否 类型:int 描述: 单位为分 示例值:100
Integer merchantContribute
字段名:商户出资 变量名:merchant_contribute 是否必填:否 类型:int 描述: 单位为分 示例值:100
Integer otherContribute
字段名:其他出资 变量名:other_contribute 是否必填:否 类型:int 描述: 单位为分 示例值:100
String currency
字段名:优惠币种 变量名:currency 是否必填:否 类型:string[1,16] 描述: CNY:人民币,境内商户号仅支持人民币。 示例值:CNY
List<E> goodsDetail
字段名:单品列表 变量名:goods_detail 是否必填:否 类型:array 描述: 单品列表信息
String deviceId
字段名:商户端设备号 变量名:device_id 是否必填:否 类型:string[7,16] 描述: 终端设备号(门店号或收银设备ID)。 示例值:POS1:1
String mchid
字段名:子单商户号 变量名:mchid 是否必填:是 类型:string[1,32] 描述: 子单发起方商户号,必须与发起方Appid有绑定关系。 示例值:1900000109
String tradeType
字段名:交易类型 变量名:trade_type 是否必填:是 类型:string[1,16] 描述: 枚举值: NATIVE:扫码支付 JSAPI:公众号支付 APP:APP支付 MWEB:H5支付 示例值: JSAPI
String tradeState
字段名:交易状态 变量名:trade_state 是否必填:是 类型:string[1,32] 描述: 枚举值: SUCCESS:支付成功 REFUND:转入退款 NOTPAY:未支付 CLOSED:已关闭 USERPAYING:用户支付中 PAYERROR:支付失败(其他原因,如银行返回失败) ACCEPT:已接收,等待扣款 示例值: SUCCESS
String bankType
字段名:付款银行 变量名:bank_type 是否必填:否 类型:string[1,16] 描述: 银行类型,采用字符串类型的银行标识。 示例值:CMC
String attach
字段名:附加信息 变量名:attach 是否必填:是 类型:string[1,128] 描述: 附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用。 示例值:深圳分店
String successTime
字段名:支付完成时间 变量名:success_time 是否必填:是 类型:string[1,32] 描述: 订单支付时间,遵循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+08:00表示,北京时间2015年5月20日13点29分35秒。 示例值: 2015-05-20T13:29:35.120+08:00
String transactionId
字段名:微信订单号 变量名:transaction_id 是否必填:是 类型:string[1,32] 描述: 微信支付订单号。 示例值:1009660380201506130728806387
String outTradeNo
字段名:子单商户订单号 变量名:out_trade_no 是否必填:是 类型:string[6,32] 描述: 商户系统内部订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一。 示例值:20150806125346
CombineQueryResult.Amount amount
字段名:订单金额 变量名:amount 是否必填:是 类型:object 描述: 订单金额信息
List<E> promotionDetail
字段名:优惠功能 变量名:promotion_detail 是否必填:是 类型:array 描述: 优惠功能,子单有核销优惠券时有返回
String prepayId
字段名:预支付交易会话标识(APP支付、JSAPI和小程序支付返回) 变量名:prepay_id 是否必填:是 类型:string[1,64] 描述: 数字和字母。微信生成的预支付会话标识,用于后续接口调用使用,该值有效期为2小时。 示例值:wx201410272009395522657a690389285100
String h5Url
字段名:支付跳转链接(H5支付返回) 变量名:h5_url 是否必填:是 类型:string[1,512] 描述: 支付跳转链接,h5_url的有效期为5分钟 示例值:https://wx.tenpay.com/cgi-bin/mmpayweb-bin/checkmweb?prepay_id=wx2016121516420242444321ca0631331346&package=1405458241
String codeUrl
字段名:二维码链接(NATIVE支付返回) 变量名:h5_url 是否必填:是 类型:string[1,512] 描述: 二维码链接 示例值:weixin://pay.weixin.qq.com/bizpayurl/up?pr=NwY5Mz9&groupid=00
String hashType
字段名:哈希类型 变量名:hash_type 是否必填:是 类型:string[1, 32] 描述: 原始账单(gzip需要解压缩)的摘要值,用于校验文件的完整性。 示例值:SHA1
String hashValue
字段名:哈希值 变量名:hash_value 是否必填:是 类型:string[1,1024] 描述: 原始账单(gzip需要解压缩)的摘要值,用于校验文件的完整性。 示例值:79bb0f45fc4c42234a918000b2668d689e2bde04
String downloadUrl
字段名:账单下载地址 变量名:download_url 是否必填:是 类型:string[1,2048] 描述: 供下一步请求账单文件的下载地址,该地址30s内有效。 示例值:https://api.mch.weixin.qq.com/v3/billdownload/file?token=xxx
String openid
用户标识. openid 是 String(128) 用户在商户appid下的唯一标识
String tradeTime
String appId
String mchId
String subMchId
String deviceInfo
String transactionId
String outTradeNo
String openId
String tradeType
String tradeState
String bankType
String feeType
String totalFee
String couponFee
String refundId
String outRefundNo
String settlementRefundFee
String couponRefundFee
String refundChannel
String refundState
String body
String attach
String poundage
String poundageRate
String totalAmount
String appliedRefundAmount
String feeRemark
String refundTime
String refundSuccessTime
List<E> billInfoList
String totalRecord
String totalFee
String totalRefundFee
String totalCouponFee
String totalPoundageFee
String totalAmount
String totalAppliedRefundFee
String appid
字段名:应用ID 变量名:appid 是否必填:是 类型:string[1,32] 描述: 由微信生成的应用ID,全局唯一。请求统一下单接口时请注意APPID的应用属性,例如公众号场景下,需使用应用属性为公众号的APPID 示例值:wxd678efh567hg6787
String mchid
字段名:直连商户号 变量名:mchid 是否必填:是 类型:string[1,32] 描述: 直连商户的商户号,由微信支付生成并下发。 示例值:1230000109
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string[6,32] 描述: 商户系统内部订单号,只能是数字、大小写字母_-*且在同一个商户号下唯一 示例值:1217752501201407033233368018
String transactionId
字段名:微信支付返回的订单号 变量名:transaction_id 是否必填:是 类型:string(32) 描述: 微信分配的公众账号ID 示例值:1000320306201511078440737890
String tradeType
字段名:交易类型 变量名:trade_type 是否必填:是 类型:string[1,16] 描述: 枚举值: NATIVE:扫码支付 JSAPI:公众号支付 APP:APP支付 MWEB:H5支付 示例值: JSAPI
String bankType
字段名:付款银行 变量名:bank_type 是否必填:否 类型:string(16) 描述: 银行类型,采用字符串类型的银行标识。 示例值:CMC
String successTime
字段名:支付完成时间 变量名:success_time 是否必填:否 类型:string(64) 描述:支付完成时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2018-06-08T10:34:56+08:00
String tradeState
字段名:交易状态 变量名:trade_state 是否必填:是 类型:string[1,32] 描述: 交易状态,枚举值: SUCCESS:支付成功 REFUND:转入退款 NOTPAY:未支付 REVOKED:已撤销(付款码支付) USERPAYING:用户支付中(付款码支付) PAYERROR:支付失败(其他原因,如银行返回失败) 示例值:SUCCESS
String tradeStateDesc
字段名:交易状态描述 变量名:trade_state_desc 是否必填:是 类型:string(256) 描述:交易状态描述 示例值:支付失败,请重新下单支付
String attach
字段名:附加数据 变量名:attach 是否必填:否 类型:string[1,128] 描述: 附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用 示例值:自定义数据
String goodsTag
字段名:订单优惠标记 变量名:goods_tag 是否必填:否 类型:string[1,256] 描述: 订单优惠标记 示例值:WXG
Boolean supportFapiao
字段名:电子发票入口开放标识 变量名:support_fapiao 是否必填:否 类型:boolean 描述:传入true时,支付成功消息和支付详情页将出现开票入口。需要在微信支付商户平台或微信公众平台开通电子发票功能,传此字段才可生效。
WxPayCodepayResult.Payer payer
字段名:支付者 变量名:payer 是否必填:是 类型:object 描述: 支付者信息
WxPayCodepayResult.Amount amount
字段名:订单金额 变量名:amount 是否必填:是 类型:object 描述: 订单金额信息
WxPayCodepayResult.SceneInfo sceneInfo
字段名:场景信息 变量名:scene_info 是否必填:否 类型:object 描述: 支付场景描述
List<E> promotionDetails
字段名:优惠功能 变量名:promotion_detail 是否必填:否 类型:array 描述: 优惠功能,享受优惠时返回该字段。
Integer total
字段名:总金额 变量名:total 是否必填:否 类型:int 描述: 订单总金额,单位为分。 示例值:100
Integer payerTotal
字段名:用户支付金额 变量名:payer_total 是否必填:否 类型:int 描述: 用户支付金额,单位为分。 示例值:100
String currency
字段名:货币类型 变量名:currency 是否必填:否 类型:string[1,16] 描述: CNY:人民币,境内商户号仅支持人民币。 示例值:CNY
String payerCurrency
字段名:用户支付币种 变量名:payer_currency 是否必填:否 类型:string[1,16] 描述: 用户支付币种 示例值: CNY
String goodsId
字段名:商品编码 变量名:goods_id 是否必填:是 类型:string[1,32] 描述: 商品编码 示例值:M1006
Integer quantity
字段名:商品数量 变量名:quantity 是否必填:是 类型:int 描述: 用户购买的数量 示例值:1
Integer unitPrice
字段名:商品单价 变量名:unit_price 是否必填:是 类型:int 描述: 商品单价,单位为分 示例值:100
Integer discountAmount
字段名:商品优惠金额 变量名:discount_amount 是否必填:是 类型:int 描述: 商品优惠金额 示例值:0
String goodsRemark
字段名:商品备注 变量名:goods_remark 是否必填:否 类型:string[1,128] 描述: 商品备注信息 示例值:商品备注信息
String authCode
字段名:用户标识 变量名:auth_code 是否必填:是 类型:string[32] 描述: 付款码支付授权码,即用户打开微信钱包显示的码。 示例值:130061098828009406
String couponId
字段名:券ID 变量名:coupon_id 是否必填:是 类型:string[1,32] 描述: 券ID 示例值:109519
String name
字段名:优惠名称 变量名:name 是否必填:否 类型:string[1,64] 描述: 优惠名称 示例值:单品惠-6
String scope
字段名:优惠范围 变量名:scope 是否必填:否 类型:string[1,32] 描述: GLOBAL:全场代金券 SINGLE:单品优惠 示例值:GLOBAL
String type
字段名:优惠类型 变量名:type 是否必填:否 类型:string[1,32] 描述: CASH:充值 NOCASH:预充值 示例值:CASH
Integer amount
字段名:优惠券面额 变量名:amount 是否必填:是 类型:int 描述: 优惠券面额 示例值:100
String stockId
字段名:活动ID 变量名:stock_id 是否必填:否 类型:string[1,32] 描述: 活动ID 示例值:931386
Integer wechatpayContribute
字段名:微信出资 变量名:wechatpay_contribute 是否必填:否 类型:int 描述: 微信出资,单位为分 示例值:0
Integer merchantContribute
字段名:商户出资 变量名:merchant_contribute 是否必填:否 类型:int 描述: 商户出资,单位为分 示例值:0
Integer otherContribute
字段名:其他出资 变量名:other_contribute 是否必填:否 类型:int 描述: 其他出资,单位为分 示例值:0
String currency
字段名:优惠币种 变量名:currency 是否必填:否 类型:string[1,16] 描述: CNY:人民币,境内商户号仅支持人民币。 示例值:CNY
List<E> goodsDetails
字段名:单品列表 变量名:goods_detail 是否必填:否 类型:array 描述: 单品列表信息
String deviceIp
字段名:商户端设备 IP 变量名:device_ip 是否必填:是 类型:string[1,45] 描述: 用户的客户端IP,支持IPv4和IPv6两种格式的IP地址。 示例值:14.23.150.211
String deviceId
字段名:商户端设备号 变量名:device_id 是否必填:否 类型:string[1,32] 描述: 商户端设备号(门店号或收银设备ID)。 示例值:013467007045764
WxPayCodepayResult.StoreInfo storeInfo
字段名:商户门店信息 变量名:store_info 是否必填:否 类型:object 描述: 商户门店信息
Boolean profitSharing
字段名:是否指定分账 变量名:profit_sharing 是否必填:否 类型:boolean 描述: 是否指定分账 示例值:false
String id
字段名:门店编号 变量名:id 是否必填:是 类型:string[1,32] 描述: 此参数与商家自定义编码(out_id)二选一必填。 微信支付线下场所ID,格式为纯数字。 基于合规要求与风险管理目的,线下条码支付时需传入用户实际付款的场景信息。 指引参见:https://kf.qq.com/faq/230817neeaem2308177ZFfqM.html。 示例值:0001
String outId
字段名:商家自定义编码 变量名:out_id 是否必填:否 类型:string[1,256] 描述: 此参数与门店(id)二选一必填。 商户系统的门店编码,支持大小写英文字母、数字,仅支持utf-8格式。 基于合规要求与风险管理目的,线下条码支付时需传入用户实际付款的场景信息。 示例值:A1111
String contractResultCode
String contractErrCode
String contractErrCodeDes
String prepayId
String tradeType
String codeUrl
Integer planId
Long requestSerial
String contractCode
String contractDisplayAccount
String mwebUrl
String outTradeNo
String BillingTime
String bizTransactionId
String fundFlowId
String bizName
String bizType
String financialType
String financialFee
String AccountBalance
String fundApplicant
String memo
String bizVoucherId
String openid
用户标识. openid 是 String(128) Y 用户在商户appid 下的唯一标识
String isSubscribe
是否关注公众账号. is_subscribe 是 String(1) Y 用户是否关注公众账号,仅在公众账号类型支付有效,取值范围:Y或N;Y-关注;N-未关注
String subOpenid
用户子标识. sub_openid 否 String(128) Y 子商户appid下用户唯一标识,如需返回则请求时需要传sub_appid
String subIsSubscribe
是否关注子公众账号. sub_is_subscribe 否 String(1) Y 用户是否关注子公众账号,仅在公众账号类型支付有效,取值范围:Y或N;Y-关注;N-未关注
String tradeType
交易类型. trade_type 是 String(16) MICROPAY 支付类型为MICROPAY(即扫码支付)
String bankType
付款银行. bank_type 是 String(32) CMC 银行类型,采用字符串类型的银行标识,值列表详见银行类型
String feeType
货币类型. fee_type 否 String(16) CNY 符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型
Integer totalFee
订单金额. total_fee 是 Int 888 订单总金额,单位为分,只能为整数,详见支付金额
Integer settlementTotalFee
应结订单金额. settlement_total_fee 否 Int 100 应结订单金额=订单金额-非充值代金券金额,应结订单金额<=订单金额。
Integer couponFee
代金券金额. coupon_fee 否 Int 100 “代金券”金额<=订单金额,订单金额-“代金券”金额=现金支付金额,详见支付金额
String cashFeeType
现金支付货币类型. cash_fee_type 否 String(16) CNY 符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型
Integer cashFee
现金支付金额. cash_fee 是 Int 100 订单现金支付金额,详见支付金额
String transactionId
微信支付订单号. transaction_id 是 String(32) 1217752501201407033233368018 微信支付订单号
String outTradeNo
商户订单号. out_trade_no 是 String(32) 1217752501201407033233368018 商户系统的订单号,与请求一致。
String attach
商家数据包. attach 否 String(128) 123456 商家数据包,原样返回
String timeEnd
支付完成时间. time_end 是 String(14) 20141030133525 订单生成时间,格式为yyyyMMddHHmmss,如2009年12月25日9点10分10秒表示为20091225091010。详见时间规则
String promotionDetail
营销详情. promotion_detail 否 String(6000) 示例见下文 新增返回,单品优惠功能字段,需要接入请见详细说明
String resultMsg
String promotionDetail
字段名:营销详情. 变量名:promotion_detail 是否必填:否,单品优惠才有 类型:String(6000) 示例值:[{"promotion_detail":[{"promotion_id":"109519","name":"单品惠-6","scope":"SINGLE","type":"DISCOUNT","amount":5,"activity_id":"931386","wxpay_contribute":0,"merchant_contribute":0,"other_contribute":5,"goods_detail":[{"goods_id":"a_goods1","goods_remark":"商品备注","quantity":7,"price":1,"discount_amount":4},{"goods_id":"a_goods2","goods_remark":"商品备注","quantity":1,"price":2,"discount_amount":1}]}]} 描述:单品优惠专用参数,详见https://pay.weixin.qq.com/wiki/doc/api/danpin.php?chapter=9_201&index=3
String deviceInfo
设备号. device_info 否 String(32) 013467007045764 微信支付分配的终端设备号,
String openid
用户标识. openid 是 String(128) oUpF8uMuAJO_M2pxb1Q9zNjWeS6o 用户在商户appid下的唯一标识
String isSubscribe
是否关注公众账号. is_subscribe 是 String(1) Y 用户是否关注公众账号,Y-关注,N-未关注,仅在公众账号类型支付有效
String subOpenid
用户子标识 . sub_openid 否 String(128) oUpF8uMuAJO_M2pxb1Q9zNjWeS6o 用户在子商户appid下的唯一标识
String isSubscribeSub
是否关注子公众账号. sub_is_subscribe 否 String(1) Y 用户是否关注子公众账号,Y-关注,N-未关注(机构商户不返回)
String tradeType
交易类型. trade_type 是 String(16) JSAPI 调用接口提交的交易类型,取值如下:JSAPI,NATIVE,APP,MICROPAY,详细说明见参数规定
String tradeState
交易状态. trade_state 是 String(32) SUCCESS SUCCESS—支付成功,REFUND—转入退款,NOTPAY—未支付,CLOSED—已关闭,REVOKED—已撤销(刷卡支付),USERPAYING--用户支付中,PAYERROR--支付失败(其他原因,如银行返回失败)
String bankType
付款银行. bank_type 是 String(16) CMC 银行类型,采用字符串类型的银行标识
String detail
商品详情. detail 否 String(8192) 商品详细列表,使用Json格式,传输签名前请务必使用CDATA标签将JSON文本串保护起来。如果使用了单品优惠,会有单品优惠信息返回 discount_detail []: └ goods_id String 必填 32 商品的编号 └ goods_name String 必填 256 商品名称 └ coupon_batch_id String 必填 代金券批次ID └ coupon_id String 必填 代金卷ID └ coupon_fee Int 必填 代金券支付金额,单位为分
Integer totalFee
订单金额. total_fee 是 Int 100 订单总金额,单位为分
String feeType
货币种类. fee_type 否 String(8) CNY 货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型
Integer settlementTotalFee
应结订单金额. settlement_total_fee 否 Int 100 应结订单金额=订单金额-非充值代金券金额,应结订单金额<=订单金额。
Integer cashFee
现金支付金额. cash_fee 是 Int 100 现金支付金额订单现金支付金额,详见支付金额
String cashFeeType
现金支付货币类型. cash_fee_type 否 String(16) CNY 货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型
Integer couponFee
代金券金额. coupon_fee 否 Int 100 “代金券”金额<=订单金额,订单金额-“代金券”金额=现金支付金额,详见支付金额
Integer couponCount
代金券使用数量. coupon_count 否 Int 1 代金券使用数量
List<E> coupons
String transactionId
微信支付订单号. transaction_id 是 String(32) 1009660380201506130728806387 微信支付订单号
String outTradeNo
商户订单号. out_trade_no 是 String(32) 20150806125346 商户系统的订单号,与请求一致。
String attach
附加数据. attach 否 String(128) 深圳分店 附加数据,原样返回
String timeEnd
支付完成时间. time_end 是 String(14) 20141030133525 订单支付时间,格式为yyyyMMddHHmmss,如2009年12月25日9点10分10秒表示为20091225091010。其他详见时间规则
String tradeStateDesc
交易状态描述. trade_state_desc 是 String(256) 支付失败,请重新下单支付 对当前查询订单状态的描述和下一步操作的指引
String couponType
代金券类型. coupon_type_$n 否 String CASH
String couponId
代金券ID. coupon_id_$n 否 String(20) 10000 代金券ID, $n为下标,从0开始编号
Integer couponFee
单个代金券支付金额. coupon_fee_$n 否 Int 100 单个代金券支付金额, $n为下标,从0开始编号
String appid
字段名:应用ID 变量名:appid 是否必填:是 类型:string[1,32] 描述: 直连商户申请的公众号或移动应用appid。 示例值:wxd678efh567hg6787
String mchid
字段名:直连商户号 变量名:mchid 是否必填:是 类型:string[1,32] 描述: 直连商户的商户号,由微信支付生成并下发。 示例值:1230000109
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string[6,32] 描述: 商户系统内部订单号,只能是数字、大小写字母_-*且在同一个商户号下唯一,详见【商户订单号】。 示例值:1217752501201407033233368018
String transactionId
字段名:微信支付订单号 变量名:transaction_id 是否必填:否 类型:string[1,32] 描述: 微信支付系统生成的订单号。 示例值:1217752501201407033233368018
String tradeType
字段名:交易类型 变量名:trade_type 是否必填:否 类型:string[1,16] 描述: 交易类型,枚举值: JSAPI:公众号支付 NATIVE:扫码支付 APP:APP支付 MICROPAY:付款码支付 MWEB:H5支付 FACEPAY:刷脸支付 示例值:MICROPAY
String tradeState
字段名:交易状态 变量名:trade_state 是否必填:是 类型:string[1,32] 描述: 交易状态,枚举值: SUCCESS:支付成功 REFUND:转入退款 NOTPAY:未支付 CLOSED:已关闭 REVOKED:已撤销(付款码支付) USERPAYING:用户支付中(付款码支付) PAYERROR:支付失败(其他原因,如银行返回失败) ACCEPT:已接收,等待扣款 示例值:SUCCESS
String tradeStateDesc
字段名:交易状态描述 变量名:trade_state_desc 是否必填:是 类型:string[1,256] 描述: 交易状态描述 示例值:支付成功
String bankType
字段名:付款银行 变量名:bank_type 是否必填:否 类型:string[1,16] 描述: 银行类型,采用字符串类型的银行标识。银行标识请参考《银行类型对照表》https://pay.weixin.qq.com/wiki/doc/apiv3/terms_definition/chapter1_1_3.shtml#part-6 示例值:CMC
String attach
字段名:附加数据 变量名:attach 是否必填:否 类型:string[1,128] 描述: 附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用 示例值:自定义数据
String successTime
字段名:支付完成时间 变量名:success_time 是否必填:否 类型:string[1,64] 描述: 支付完成时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2018-06-08T10:34:56+08:00
WxPayOrderQueryV3Result.Payer payer
字段名:支付者 变量名:payer 是否必填:是 类型:object 描述: 支付者信息
WxPayOrderQueryV3Result.Amount amount
字段名:订单金额 变量名:amount 是否必填:否 类型:object 描述: 订单金额信息,当支付成功时返回该字段。
WxPayOrderQueryV3Result.SceneInfo sceneInfo
字段名:场景信息 变量名:scene_info 是否必填:否 类型:object 描述: 支付场景描述
List<E> promotionDetails
字段名:优惠功能 变量名:promotion_detail 是否必填:否 类型:array 描述: 优惠功能,享受优惠时返回该字段。
Integer total
字段名:总金额 变量名:total 是否必填:否 类型:int 描述: 订单总金额,单位为分。 示例值:100
Integer payerTotal
字段名:用户支付金额 变量名:payer_total 是否必填:否 类型:int 描述: 用户支付金额,单位为分。 示例值:100
String currency
字段名:货币类型 变量名:currency 是否必填:否 类型:string[1,16] 描述: CNY:人民币,境内商户号仅支持人民币。 示例值:CNY
String payerCurrency
字段名:用户支付币种 变量名:payer_currency 是否必填:否 类型:string[1,16] 描述: 用户支付币种 示例值: CNY
String goodsId
字段名:商品编码 变量名:goods_id 是否必填:是 类型:string[1,32] 描述: 商品编码 示例值:M1006
Integer quantity
字段名:商品数量 变量名:quantity 是否必填:是 类型:int 描述: 用户购买的数量 示例值:1
Integer unitPrice
字段名:商品单价 变量名:unit_price 是否必填:是 类型:int 描述: 商品单价,单位为分 示例值:100
Integer discountAmount
字段名:商品优惠金额 变量名:discount_amount 是否必填:是 类型:int 描述: 商品优惠金额 示例值:0
String goodsRemark
字段名:商品备注 变量名:goods_remark 是否必填:否 类型:string[1,128] 描述: 商品备注信息 示例值:商品备注信息
String openid
字段名:用户标识 变量名:openid 是否必填:是 类型:string[1,128] 描述: 用户在直连商户appid下的唯一标识。 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
String couponId
字段名:券ID 变量名:coupon_id 是否必填:是 类型:string[1,32] 描述: 券ID 示例值:109519
String name
字段名:优惠名称 变量名:name 是否必填:否 类型:string[1,64] 描述: 优惠名称 示例值:单品惠-6
String scope
字段名:优惠范围 变量名:scope 是否必填:否 类型:string[1,32] 描述: GLOBAL:全场代金券 SINGLE:单品优惠 示例值:GLOBAL
String type
字段名:优惠类型 变量名:type 是否必填:否 类型:string[1,32] 描述: CASH:充值 NOCASH:预充值 示例值:CASH
Integer amount
字段名:优惠券面额 变量名:amount 是否必填:是 类型:int 描述: 优惠券面额 示例值:100
String stockId
字段名:活动ID 变量名:stock_id 是否必填:否 类型:string[1,32] 描述: 活动ID 示例值:931386
Integer wechatpayContribute
字段名:微信出资 变量名:wechatpay_contribute 是否必填:否 类型:int 描述: 微信出资,单位为分 示例值:0
Integer merchantContribute
字段名:商户出资 变量名:merchant_contribute 是否必填:否 类型:int 描述: 商户出资,单位为分 示例值:0
Integer otherContribute
字段名:其他出资 变量名:other_contribute 是否必填:否 类型:int 描述: 其他出资,单位为分 示例值:0
String currency
字段名:优惠币种 变量名:currency 是否必填:否 类型:string[1,16] 描述: CNY:人民币,境内商户号仅支持人民币。 示例值:CNY
List<E> goodsDetails
字段名:单品列表 变量名:goods_detail 是否必填:否 类型:array 描述: 单品列表信息
String deviceId
字段名:商户端设备号 变量名:device_id 是否必填:否 类型:string[1,32] 描述: 商户端设备号(发起扣款请求的商户服务器设备号)。 示例值:013467007045764
String isRecall
是否重调 recall 是 String(1) Y 是否需要继续调用撤销,Y-需要,N-不需要
String appid
字段名:应用ID 变量名:appid 是否必填:是 类型:string[1,32] 描述: 由微信生成的应用ID,全局唯一。请求统一下单接口时请注意APPID的应用属性,例如公众号场景下,需使用应用属性为公众号的APPID 示例值:wxd678efh567hg6787
String mchid
字段名:直连商户号 变量名:mchid 是否必填:是 类型:string[1,32] 描述: 直连商户的商户号,由微信支付生成并下发。 示例值:1230000109
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string[6,32] 描述: 商户系统内部订单号,只能是数字、大小写字母_-*且在同一个商户号下唯一 示例值:1217752501201407033233368018
String spAppid
字段名:服务商应用ID 变量名:appid 是否必填:是 类型:string[1,32] 描述: 服务商申请的公众号或移动应用appid。 示例值:wxd678efh567hg6787
String spMchId
字段名:服务商户号 变量名:mchid 是否必填:是 类型:string[1,32] 描述: 服务商户号,由微信支付生成并下发 示例值:1230000109
String subAppid
字段名:子商户应用ID 变量名:appid 是否必填:是 类型:string[1,32] 描述: 子商户申请的公众号或移动应用appid。 示例值:wxd678efh567hg6787
String subMchId
字段名:子商户商户号 变量名:mchid 是否必填:是 类型:string[1,32] 描述: 子商户的商户号,由微信支付生成并下发。 示例值:1230000109
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string[6,32] 描述: 商户系统内部订单号,只能是数字、大小写字母_-*且在同一个商户号下唯一,详见【商户订单号】。 示例值:1217752501201407033233368018
String transactionId
字段名:微信支付订单号 变量名:transaction_id 是否必填:否 类型:string[1,32] 描述: 微信支付系统生成的订单号。 示例值:1217752501201407033233368018
String tradeType
字段名:交易类型 变量名:trade_type 是否必填:否 类型:string[1,16] 描述: 交易类型,枚举值: JSAPI:公众号支付 NATIVE:扫码支付 APP:APP支付 MICROPAY:付款码支付 MWEB:H5支付 FACEPAY:刷脸支付 示例值:MICROPAY
String tradeState
字段名:交易状态 变量名:trade_state 是否必填:是 类型:string[1,32] 描述: 交易状态,枚举值: SUCCESS:支付成功 REFUND:转入退款 NOTPAY:未支付 CLOSED:已关闭 REVOKED:已撤销(付款码支付) USERPAYING:用户支付中(付款码支付) PAYERROR:支付失败(其他原因,如银行返回失败) ACCEPT:已接收,等待扣款 示例值:SUCCESS
String tradeStateDesc
字段名:交易状态描述 变量名:trade_state_desc 是否必填:是 类型:string[1,256] 描述: 交易状态描述 示例值:支付成功
String bankType
字段名:付款银行 变量名:bank_type 是否必填:否 类型:string[1,16] 描述: 银行类型,采用字符串类型的银行标识。 银行标识请参考《银行类型对照表》 示例值:CMC
String attach
字段名:附加数据 变量名:attach 是否必填:否 类型:string[1,128] 描述: 附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用 示例值:自定义数据
String successTime
字段名:支付完成时间 变量名:success_time 是否必填:否 类型:string[1,64] 描述: 支付完成时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2018-06-08T10:34:56+08:00
WxPayPartnerOrderQueryV3Result.Payer payer
字段名:支付者 变量名:payer 是否必填:是 类型:object 描述: 支付者信息
WxPayPartnerOrderQueryV3Result.Amount amount
字段名:订单金额 变量名:amount 是否必填:否 类型:object 描述: 订单金额信息,当支付成功时返回该字段。
WxPayPartnerOrderQueryV3Result.SceneInfo sceneInfo
字段名:场景信息 变量名:scene_info 是否必填:否 类型:object 描述: 支付场景描述
List<E> promotionDetails
字段名:优惠功能 变量名:promotion_detail 是否必填:否 类型:array 描述: 优惠功能,享受优惠时返回该字段。
Integer total
字段名:总金额 变量名:total 是否必填:否 类型:int 描述: 订单总金额,单位为分。 示例值:100
Integer payerTotal
字段名:用户支付金额 变量名:payer_total 是否必填:否 类型:int 描述: 用户支付金额,单位为分。 示例值:100
String currency
字段名:货币类型 变量名:currency 是否必填:否 类型:string[1,16] 描述: CNY:人民币,境内商户号仅支持人民币。 示例值:CNY
String payerCurrency
字段名:用户支付币种 变量名:payer_currency 是否必填:否 类型:string[1,16] 描述: 用户支付币种 示例值: CNY
String goodsId
字段名:商品编码 变量名:goods_id 是否必填:是 类型:string[1,32] 描述: 商品编码 示例值:M1006
Integer quantity
字段名:商品数量 变量名:quantity 是否必填:是 类型:int 描述: 用户购买的数量 示例值:1
Integer unitPrice
字段名:商品单价 变量名:unit_price 是否必填:是 类型:int 描述: 商品单价,单位为分 示例值:100
Integer discountAmount
字段名:商品优惠金额 变量名:discount_amount 是否必填:是 类型:int 描述: 商品优惠金额 示例值:0
String goodsRemark
字段名:商品备注 变量名:goods_remark 是否必填:否 类型:string[1,128] 描述: 商品备注信息 示例值:商品备注信息
String couponId
字段名:券ID 变量名:coupon_id 是否必填:是 类型:string[1,32] 描述: 券ID 示例值:109519
String name
字段名:优惠名称 变量名:name 是否必填:否 类型:string[1,64] 描述: 优惠名称 示例值:单品惠-6
String scope
字段名:优惠范围 变量名:scope 是否必填:否 类型:string[1,32] 描述: GLOBAL:全场代金券 SINGLE:单品优惠 示例值:GLOBAL
String type
字段名:优惠类型 变量名:type 是否必填:否 类型:string[1,32] 描述: CASH:充值 NOCASH:预充值 示例值:CASH
Integer amount
字段名:优惠券面额 变量名:amount 是否必填:是 类型:int 描述: 优惠券面额 示例值:100
String stockId
字段名:活动ID 变量名:stock_id 是否必填:否 类型:string[1,32] 描述: 活动ID 示例值:931386
Integer wechatpayContribute
字段名:微信出资 变量名:wechatpay_contribute 是否必填:否 类型:int 描述: 微信出资,单位为分 示例值:0
Integer merchantContribute
字段名:商户出资 变量名:merchant_contribute 是否必填:否 类型:int 描述: 商户出资,单位为分 示例值:0
Integer otherContribute
字段名:其他出资 变量名:other_contribute 是否必填:否 类型:int 描述: 其他出资,单位为分 示例值:0
String currency
字段名:优惠币种 变量名:currency 是否必填:否 类型:string[1,16] 描述: CNY:人民币,境内商户号仅支持人民币。 示例值:CNY
List<E> goodsDetails
字段名:单品列表 变量名:goods_detail 是否必填:否 类型:array 描述: 单品列表信息
String deviceId
字段名:商户端设备号 变量名:device_id 是否必填:否 类型:string[1,32] 描述: 商户端设备号(发起扣款请求的商户服务器设备号)。 示例值:013467007045764
String mchBillNo
字段含义:商户订单号. 字段名:mch_billno 是否必填:是 示例值:10000098201411111234567890 类型:String(28) 字段说明:商户使用查询API填写的商户单号的原路返回
String detailId
字段含义:红包单号. 字段名:detail_id 是否必填:是 示例值:1000000000201503283103439304 类型:String(32) 字段说明:使用API发放现金红包时返回的红包单号
String status
字段含义:红包状态. 字段名:status 是否必填:是 示例值:RECEIVED 类型:string(16) 字段说明:SENDING:发放中, SENT:已发放待领取, FAILED:发放失败, RECEIVED:已领取, RFUND_ING:退款中, REFUND:已退款
String sendType
字段含义:发放类型. 字段名:send_type 是否必填:是 示例值:API 类型:String(32) 字段说明:API:通过API接口发放, UPLOAD:通过上传文件方式发放, ACTIVITY:通过活动方式发放
String hbType
字段含义:红包类型. 字段名:hb_type 是否必填:是 示例值:GROUP 类型:String(32) 字段说明:GROUP:裂变红包, NORMAL:普通红包
Integer totalNum
字段含义:红包个数. 字段名:total_num 是否必填:是 示例值:1 类型:int 字段说明:红包个数
Integer totalAmount
字段含义:红包金额. 字段名:total_amount 是否必填:是 示例值:5000 类型:int 字段说明:红包总金额(单位分)
String reason
字段含义:失败原因. 字段名:reason 是否必填:否 示例值:余额不足 类型:String(32) 字段说明:发送失败原因
String sendTime
字段含义:红包发送时间. 字段名:send_time 是否必填:是 示例值:2015-04-21 20:00:00 类型:String(32) 字段说明:红包的发送时间
String refundTime
字段含义:红包退款时间. 字段名: refund_time 是否必填:否 示例值:2015-04-21 23:03:00 类型:String(32) 字段说明:红包的退款时间(如果其未领取的退款)
Integer refundAmount
字段含义:红包退款金额. 字段名:refund_amount 是否必填:否 示例值:8000 类型:Int 字段说明:红包退款金额
String wishing
字段含义:祝福语. 字段名:wishing 是否必填:否 示例值:新年快乐 类型:String(128) 字段说明:祝福语
String remark
字段含义:活动描述. 字段名:remark 是否必填:否 示例值:新年红包 类型:String(256) 字段说明:活动描述,低版本微信可见
String actName
字段含义:活动名称. 字段名:act_name 是否必填:否 示例值:新年红包 类型:String(32) 字段说明:发红包的活动名称
List<E> redpackList
字段含义:裂变红包领取列表. 字段名:redpackList 是否必填:否 字段说明: 裂变红包的领取列表
String openid
字段含义:领取红包的Openid. 字段名: openid 是否必填:是 示例值:ohO4GtzOAAYMp2yapORH3dQB3W18 类型:String(32) 字段说明:领取红包的openid
Integer amount
字段含义:金额. 字段名: amount 是否必填:是 示例值:100 类型:int 字段说明:领取金额
String receiveTime
字段含义:接收时间. 字段名: rcv_time 是否必填:是 示例值:2015-04-21 20:00:00 类型:String(32) 字段说明:领取红包的时间
String couponRefundId
字段名:退款代金券ID. 变量名:coupon_refund_id_$n_$m 是否必填:否 类型:String(20) 示例值:10000 描述:退款代金券ID, $n为下标,$m为下标,从0开始编号
Integer couponRefundFee
字段名:单个退款代金券支付金额. 变量名:coupon_refund_fee_$n_$m 是否必填:否 类型:Int 示例值:100 描述:单个退款代金券支付金额, $n为下标,$m为下标,从0开始编号
String couponType
字段名:代金券类型. 变量名:coupon_type_$n_$m 是否必填:否 类型:String(8) 示例值:CASH 描述:CASH--充值代金券 , NO_CASH---非充值代金券。 开通免充值券功能,并且订单使用了优惠券后有返回(取值:CASH、NO_CASH)。 $n为下标,$m为下标,从0开始编号,举例:coupon_type_$0_$1
String promotionId
String scope
String type
Integer refundAmount
List<E> goodsDetails
String deviceInfo
字段名:设备号. 变量名:device_info 是否必填:否 类型:String(32) 示例值:013467007045764 描述:终端设备号
String transactionId
字段名:微信订单号. 变量名:transaction_id 是否必填:是 类型:String(32) 示例值:1217752501201407033233368018 描述:微信订单号
String outTradeNo
字段名:商户订单号. 变量名:out_trade_no 是否必填:是 类型:String(32) 示例值:1217752501201407033233368018 描述:商户系统内部的订单号
Integer totalFee
字段名:订单金额. 变量名:total_fee 是否必填:是 类型:Int 示例值:100 描述:订单总金额,单位为分,只能为整数,详见支付金额
Integer refundFee
字段名:退款总金额. 变量名:refund_fee 是否必填:是 类型:Int 示例值:100 描述:各退款单的退款金额累加,单位为分,只能为整数,
Integer couponRefundFee
字段名:代金券退款总金额. 变量名:coupon_refund_fee 是否必填:是 类型:Int 示例值:100 描述:各退款单的代金券退款金额累加,单位为分,只能为整数,
Integer cashRefundFee
字段名:用户退款金额. 变量名:cash_refund_fee 是否必填:是 类型:Int 示例值:100 描述:退款给用户的金额,不包含所有优惠券金额,单位为分,只能为整数,
Integer settlementTotalFee
字段名:应结订单金额. 变量名:settlement_total_fee 是否必填:否 类型:Int 示例值:100 描述:应结订单金额=订单金额-非充值代金券金额,应结订单金额<=订单金额。
String feeType
字段名:货币种类. 变量名:fee_type 是否必填:否 类型:String(8) 示例值:CNY 描述:订单金额货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型
Integer cashFee
字段名:现金支付金额. 变量名:cash_fee 是否必填:是 类型:Int 示例值:100 描述:现金支付金额,单位为分,只能为整数,详见支付金额
Integer refundCount
字段名:退款笔数. 变量名:refund_count 是否必填:是 类型:Int 示例值:1 描述:退款记录数
List<E> refundRecords
String promotionDetailString
List<E> promotionDetails
String outRefundNo
字段名:商户退款单号. 变量名:out_refund_no_$n 是否必填:是 类型:String(32) 示例值:1217752501201407033233368018 描述:商户退款单号
String refundId
字段名:微信退款单号. 变量名:refund_id_$n 是否必填:是 类型:String(28) 示例值:1217752501201407033233368018 描述:微信退款单号
String refundChannel
字段名:退款渠道. 变量名:refund_channel_$n 是否必填:否 类型:String(16) 示例值:ORIGINAL 描述:ORIGINAL—原路退款 BALANCE—退回到余额
Integer refundFee
字段名:申请退款金额. 变量名:refund_fee_$n 是否必填:是 类型:Int 示例值:100 描述:退款总金额,单位为分,可以做部分退款
Integer settlementRefundFee
字段名:退款金额. 变量名:settlement_refund_fee_$n 是否必填:否 类型:Int 示例值:100 描述:退款金额=申请退款金额-非充值代金券退款金额,退款金额<=申请退款金额
String refundAccount
字段名:退款资金来源. 变量名:refund_account 是否必填:否 类型:String(30) 示例值:REFUND_SOURCE_RECHARGE_FUNDS 描述:REFUND_SOURCE_RECHARGE_FUNDS---可用余额退款/基本账户, REFUND_SOURCE_UNSETTLED_FUNDS---未结算资金退款
Integer couponRefundFee
字段名:代金券退款金额. 变量名:coupon_refund_fee_$n 是否必填:否 类型:Int 示例值:100 描述:代金券退款金额<=退款金额,退款金额-代金券或立减优惠退款金额为现金,说明详见代金券或立减优惠
Integer couponRefundCount
字段名:退款代金券使用数量. 变量名:coupon_refund_count_$n 是否必填:否 类型:Int 示例值:1 描述:退款代金券使用数量 ,$n为下标,从0开始编号
List<E> refundCoupons
String refundStatus
字段名:退款状态. 变量名:refund_status_$n 是否必填:是 类型:String(16) 示例值:SUCCESS 描述:退款状态: SUCCESS—退款成功, FAIL—退款失败, PROCESSING—退款处理中, CHANGE—转入代发, 退款到银行发现用户的卡作废或者冻结了,导致原路退款银行卡失败,资金回流到商户的现金帐号,需要商户人工干预,通过线下或者财付通转账的方式进行退款。
String refundRecvAccount
字段名:退款入账账户. 变量名:refund_recv_accout_$n 是否必填:是 类型:String(64) 示例值:招商银行信用卡0403 描述:取当前退款单的退款入账方,1)退回银行卡:{银行名称}{卡类型}{卡尾号},2)退回支付用户零钱:支付用户零钱
String refundSuccessTime
字段名:退款成功时间. 变量名:refund_success_time_$n 是否必填:否 类型:String(20) 示例值:2016-07-25 15:26:26 描述:退款成功时间,当退款状态为退款成功时有返回。$n为下标,从0开始编号。
String refundId
字段名:微信支付退款号 变量名:refund_id 是否必填:是 类型:string[1, 32] 描述: 微信支付退款号 示例值:50000000382019052709732678859
String outRefundNo
字段名:商户退款单号 变量名:out_refund_no 是否必填:是 类型:string[1, 64] 描述: 商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母_-|*@ ,同一退款单号多次请求只退一笔。 示例值:1217752501201407033233368018
String transactionId
字段名:微信支付订单号 变量名:transaction_id 是否必填:是 类型:string[1, 32] 描述: 微信支付交易订单号 示例值:1217752501201407033233368018
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string[1, 32] 描述: 原支付交易对应的商户订单号 示例值:1217752501201407033233368018
String channel
字段名:退款渠道 变量名:channel 是否必填:否 类型:string[1, 16] 描述: 枚举值: ORIGINAL:原路退款 BALANCE:退回到余额 OTHER_BALANCE:原账户异常退到其他余额账户 OTHER_BANKCARD:原银行卡异常退到其他银行卡 示例值:ORIGINAL
String userReceivedAccount
字段名:退款入账账户 变量名:user_received_account 是否必填:是 类型:string[1, 64] 描述: 取当前退款单的退款入账方,有以下几种情况: 1)退回银行卡:{银行名称}{卡类型}{卡尾号} 2)退回支付用户零钱:支付用户零钱 3)退还商户:商户基本账户商户结算银行账户 4)退回支付用户零钱通:支付用户零钱通 示例值:招商银行信用卡0403
String successTime
字段名:退款成功时间 变量名:success_time 是否必填:否 类型:string[1, 64] 描述: 退款成功时间,当退款状态为退款成功时有返回。 示例值:2020-12-01T16:18:12+08:00
String createTime
字段名:退款创建时间 变量名:create_time 是否必填:是 类型:string[1, 64] 描述: 退款受理时间 示例值:2020-12-01T16:18:12+08:00
String status
字段名:退款状态 变量名:status 是否必填:是 类型:string[1, 32] 描述: 退款到银行发现用户的卡作废或者冻结了,导致原路退款银行卡失败,可前往商户平台(pay.weixin.qq.com)-交易中心,手动处理此笔退款。 枚举值: SUCCESS:退款成功 CLOSED:退款关闭 PROCESSING:退款处理中 ABNORMAL:退款异常 示例值:SUCCESS
String fundsAccount
字段名:资金账户 变量名:funds_account 是否必填:否 类型:string[1, 32] 描述: 退款所使用资金对应的资金账户类型 枚举值: UNSETTLED : 未结算资金 AVAILABLE : 可用余额 UNAVAILABLE : 不可用余额 OPERATION : 运营户 BASIC : 基本账户(含可用余额和不可用余额) 示例值:UNSETTLED
WxPayRefundQueryV3Result.Amount amount
字段名:金额信息 变量名:amount 是否必填:是 类型:object 描述: 金额详细信息
List<E> promotionDetail
字段名:优惠退款信息 变量名:promotion_detail 是否必填:否 类型:array 描述: 优惠退款信息
Integer total
字段名:订单金额 变量名:total 是否必填:是 类型:int 描述: 订单总金额,单位为分 示例值:100
Integer refund
字段名:退款金额 变量名:refund 是否必填:是 类型:int 描述: 退款标价金额,单位为分,可以做部分退款 示例值:100
List<E> from
字段名:退款出资账户及金额 变量名:from 是否必填:是 类型:array 描述: 退款出资的账户类型及金额信息
Integer payerTotal
字段名:用户支付金额 变量名:payer_total 是否必填:是 类型:int 描述: 现金支付金额,单位为分,只能为整数 示例值:90
Integer payerRefund
字段名:用户退款金额 变量名:payer_refund 是否必填:是 类型:int 描述: 退款给用户的金额,不包含所有优惠券金额 示例值:90
Integer settlementRefund
字段名:应结退款金额 变量名:settlement_refund 是否必填:是 类型:int 描述: 去掉非充值代金券退款金额后的退款金额,单位为分,退款金额=申请退款金额-非充值代金券退款金额,退款金额<=申请退款金额 示例值:100
Integer settlementTotal
字段名:应结订单金额 变量名:settlement_total 是否必填:是 类型:int 描述: 应结订单金额=订单金额-免充值代金券金额,应结订单金额<=订单金额,单位为分 示例值:100
Integer discountRefund
字段名:优惠退款金额 变量名:discount_refund 是否必填:否 类型:int 描述: 优惠退款金额<=退款金额,退款金额-代金券或立减优惠退款金额为现金,说明详见代金券或立减优惠,单位为分 示例值:10
String currency
字段名:退款币种 变量名:currency 是否必填:否 类型:string[1, 16] 描述: 符合ISO 4217标准的三位字母代码,目前只支持人民币:CNY。 示例值:CNY
Integer refundFee
String merchantGoodsId
字段名:商户侧商品编码 变量名:merchant_goods_id 是否必填:是 类型:string[1, 32] 描述: 由半角的大小写字母、数字、中划线、下划线中的一种或几种组成 示例值:1217752501201407033233368018
String wechatpayGoodsId
字段名:微信侧商品编码 变量名:wechatpay_goods_id 是否必填:否 类型:string[1, 32] 描述: 微信支付定义的统一商品编号(没有可不传) 示例值:1001
String goodsName
字段名:商品名称 变量名:goods_name 是否必填:否 类型:string[1, 256] 描述: 商品的实际名称 示例值:iPhone6s 16G
Integer unitPrice
字段名:商品单价 变量名:unit_price 是否必填:是 类型:int 描述: 商品单价金额,单位为分 示例值:528800
Integer refundAmount
字段名:商品退款金额 变量名:refund_amount 是否必填:是 类型:int 描述: 商品退款金额,单位为分 示例值:528800
Integer refundQuantity
字段名:商品退货数量 变量名:refund_quantity 是否必填:是 类型:int 描述: 单品的退款数量,单位为分 示例值:1
String promotionId
字段名:券ID 变量名:promotion_id 是否必填:是 类型:string[1, 32] 描述: 券或者立减优惠id 示例值:109519
String scope
字段名:优惠范围 变量名:scope 是否必填:是 类型:string[1, 32] 描述: 枚举值: GLOBAL:全场代金券 SINGLE:单品优惠 示例值:SINGLE
String type
字段名:优惠类型 变量名:type 是否必填:是 类型:string[1, 32] 描述: 枚举值: COUPON:代金券,需要走结算资金的充值型代金券 DISCOUNT:优惠券,不走结算资金的免充值型优惠券 示例值:DISCOUNT
Integer amount
字段名:优惠券面额 变量名:amount 是否必填:是 类型:int 描述: 用户享受优惠的金额(优惠券面额=微信出资金额+商家出资金额+其他出资方金额 ),单位为分 示例值:5
Integer refundAmount
字段名:优惠退款金额 变量名:refund_amount 是否必填:是 类型:int 描述: 优惠退款金额<=退款金额,退款金额-代金券或立减优惠退款金额为用户支付的现金,说明详见代金券或立减优惠,单位为分 示例值:100
List<E> goodsDetail
字段名:商品列表 变量名:goods_detail 是否必填:否 类型:array 描述: 优惠商品发生退款时返回商品信息
String transactionId
String outTradeNo
String outRefundNo
String refundId
Integer refundFee
Integer settlementRefundFee
Integer totalFee
Integer settlementTotalFee
String feeType
Integer cashFee
String cashFeeType
Integer cashRefundFee
Integer couponRefundCount
Integer couponRefundFee
字段名:代金券退款总金额. 变量名:coupon_refund_fee 是否必填:否 类型:Int 示例值:100 描述:代金券退款金额<=退款金额,退款金额-代金券或立减优惠退款金额为现金,说明详见代金券或立减优惠
String promotionDetailString
List<E> promotionDetails
List<E> refundCoupons
String refundId
字段名:微信支付退款号 变量名:refund_id 是否必填:是 类型:string[1, 32] 描述: 微信支付退款号 示例值:50000000382019052709732678859
String outRefundNo
字段名:商户退款单号 变量名:out_refund_no 是否必填:是 类型:string[1, 64] 描述: 商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母_-|*@ ,同一退款单号多次请求只退一笔。 示例值:1217752501201407033233368018
String transactionId
字段名:微信支付订单号 变量名:transaction_id 是否必填:是 类型:string[1, 32] 描述: 微信支付交易订单号 示例值:1217752501201407033233368018
String outTradeNo
字段名:商户订单号 变量名:out_trade_no 是否必填:是 类型:string[1, 32] 描述: 原支付交易对应的商户订单号 示例值:1217752501201407033233368018
String channel
字段名:退款渠道 变量名:channel 是否必填:是 类型:string[1, 16] 描述: 枚举值: ORIGINAL—原路退款 BALANCE—退回到余额 OTHER_BALANCE—原账户异常退到其他余额账户 OTHER_BANKCARD—原银行卡异常退到其他银行卡 示例值:ORIGINAL
String userReceivedAccount
字段名:退款入账账户 变量名:user_received_account 是否必填:是 类型:string[1, 64] 描述: 取当前退款单的退款入账方,有以下几种情况: 1)退回银行卡:{银行名称}{卡类型}{卡尾号} 2)退回支付用户零钱:支付用户零钱 3)退还商户:商户基本账户商户结算银行账户 4)退回支付用户零钱通:支付用户零钱通 示例值:招商银行信用卡0403
String successTime
字段名:退款成功时间 变量名:success_time 是否必填:是 类型:string[1, 64] 描述: 退款成功时间,当退款状态为退款成功时有返回。 示例值:2020-12-01T16:18:12+08:00
String createTime
字段名:退款创建时间 变量名:create_time 是否必填:是 类型:string[1, 64] 描述: 退款受理时间 示例值:2020-12-01T16:18:12+08:00
String status
字段名:退款状态 变量名:status 是否必填:是 类型:string[1, 32] 描述: 退款到银行发现用户的卡作废或者冻结了,导致原路退款银行卡失败,可前往商户平台(pay.weixin.qq.com)-交易中心,手动处理此笔退款。 枚举值: SUCCESS:退款成功 CLOSED:退款关闭 PROCESSING:退款处理中 ABNORMAL:退款异常 示例值:SUCCESS
String fundsAccount
字段名:资金账户 变量名:funds_account 是否必填:否 类型:string[1, 32] 描述: 退款所使用资金对应的资金账户类型 枚举值: UNSETTLED : 未结算资金 AVAILABLE : 可用余额 UNAVAILABLE : 不可用余额 OPERATION : 运营户 BASIC : 基本账户(含可用余额和不可用余额) 示例值:UNSETTLED
WxPayRefundV3Result.Amount amount
字段名:金额信息 变量名:amount 是否必填:是 类型:object 描述: 金额详细信息
List<E> promotionDetail
字段名:优惠退款信息 变量名:promotion_detail 是否必填:否 类型:array 描述: 优惠退款信息
Integer total
字段名:订单金额 变量名:total 是否必填:是 类型:int 描述: 订单总金额,单位为分 示例值:100
Integer refund
字段名:退款金额 变量名:refund 是否必填:是 类型:int 描述: 退款标价金额,单位为分,可以做部分退款 示例值:100
List<E> from
字段名:退款出资账户及金额 变量名:from 是否必填:否 类型:array 描述: 退款出资的账户类型及金额信息
Integer payerTotal
字段名:用户支付金额 变量名:payer_total 是否必填:是 类型:int 描述: 现金支付金额,单位为分,只能为整数 示例值:90
Integer payerRefund
字段名:用户退款金额 变量名:payer_refund 是否必填:是 类型:int 描述: 退款给用户的金额,不包含所有优惠券金额 示例值:90
Integer settlementRefund
字段名:应结退款金额 变量名:settlement_refund 是否必填:是 类型:int 描述: 去掉非充值代金券退款金额后的退款金额,单位为分,退款金额=申请退款金额-非充值代金券退款金额,退款金额<=申请退款金额 示例值:100
Integer settlementTotal
字段名:应结订单金额 变量名:settlement_total 是否必填:是 类型:int 描述: 应结订单金额=订单金额-免充值代金券金额,应结订单金额<=订单金额,单位为分 示例值:100
Integer discountRefund
字段名:优惠退款金额 变量名:discount_refund 是否必填:否 类型:int 描述: 优惠退款金额<=退款金额,退款金额-代金券或立减优惠退款金额为现金,说明详见代金券或立减优惠,单位为分 示例值:10
String currency
字段名:币类型 变量名:currency 是否必填:是 类型:string[1, 16] 描述: 符合ISO 4217标准的三位字母代码,目前只支持人民币:CNY。 示例值:CNY
Integer refundFee
String merchantGoodsId
字段名:商户侧商品编码 变量名:merchant_goods_id 是否必填:是 类型:string[1, 32] 描述: 由半角的大小写字母、数字、中划线、下划线中的一种或几种组成 示例值:1217752501201407033233368018
String wechatpayGoodsId
字段名:微信侧商品编码 变量名:wechatpay_goods_id 是否必填:否 类型:string[1, 32] 描述: 微信支付定义的统一商品编号(没有可不传) 示例值:1001
String goodsName
字段名:商品名称 变量名:goods_name 是否必填:否 类型:string[1, 256] 描述: 商品的实际名称 示例值:iPhone6s 16G
Integer unitPrice
字段名:商品单价 变量名:unit_price 是否必填:是 类型:int 描述: 商品单价金额,单位为分 示例值:528800
Integer refundAmount
字段名:商品退款金额 变量名:refund_amount 是否必填:是 类型:int 描述: 商品退款金额,单位为分 示例值:528800
Integer refundQuantity
字段名:商品退货数量 变量名:refund_quantity 是否必填:是 类型:int 描述: 单品的退款数量,单位为分 示例值:1
String promotionId
字段名:券ID 变量名:promotion_id 是否必填:是 类型:string[1, 32] 描述: 券或者立减优惠id 示例值:109519
String scope
字段名:优惠范围 变量名:scope 是否必填:是 类型:string[1, 32] 描述: 枚举值: GLOBAL:全场代金券 SINGLE:单品优惠 示例值:SINGLE
String type
字段名:优惠类型 变量名:type 是否必填:是 类型:string[1, 32] 描述: 枚举值: COUPON:代金券,需要走结算资金的充值型代金券 DISCOUNT:优惠券,不走结算资金的免充值型优惠券 示例值:DISCOUNT
Integer amount
字段名:优惠券面额 变量名:amount 是否必填:是 类型:int 描述: 用户享受优惠的金额(优惠券面额=微信出资金额+商家出资金额+其他出资方金额 ),单位为分 示例值:5
Integer refundAmount
字段名:优惠退款金额 变量名:refund_amount 是否必填:是 类型:int 描述: 优惠退款金额<=退款金额,退款金额-代金券或立减优惠退款金额为用户支付的现金,说明详见代金券或立减优惠,单位为分 示例值:100
List<E> goodsDetail
字段名:商品列表 变量名:goods_detail 是否必填:否 类型:array 描述: 优惠商品发生退款时返回商品信息
String sandboxSignKey
沙箱密钥 sandbox_signkey 否 013467007045764 String(32) 返回的沙箱密钥
String shortUrl
URL链接 short_url 是 String(64) weixin://wxpay/s/XXXXXX 转换后的URL
String prepayId
字段名:预支付交易会话标识(APP支付、JSAPI支付 会返回) 变量名:prepay_id 是否必填:是 类型:string[1,64] 描述: 预支付交易会话标识。用于后续接口调用中使用,该值有效期为2小时 示例值:wx201410272009395522657a690389285100
String h5Url
字段名:支付跳转链接(H5支付 会返回) 变量名:h5_url 是否必填:是 类型:string[1,512] 描述: h5_url为拉起微信支付收银台的中间页面,可通过访问该url来拉起微信客户端,完成支付,h5_url的有效期为5分钟。 示例值:https://wx.tenpay.com/cgi-bin/mmpayweb-bin/checkmweb?prepay_id=wx2016121516420242444321ca0631331346&package=1405458241
String codeUrl
字段名:二维码链接(NATIVE支付 会返回) 变量名:h5_url 是否必填:是 类型:string[1,512] 描述: 此URL用于生成支付二维码,然后提供给用户扫码支付。 注意:code_url并非固定值,使用时按照URL格式转成二维码即可。 示例值:weixin://wxpay/bizpayurl/up?pr=NwY5Mz9&groupid=00
String contractId
String planId
Long requestSerial
String contractCode
String contractDisplayAccount
Integer contractState
String contractSignedTime
String contractExpiredTime
String contractTerminatedTime
Integer contractTerminatedMode
String contractTerminationRemark
String openId
String deviceInfo
String openId
String isSubscribe
String tradeType
String tradeState
String bankType
Integer totalFee
String feeType
Integer cashFee
String cashFeeType
Integer couponFee
Integer couponCount
List<E> couponList
String transactionId
String outTradeNo
String attach
String timeEnd
String tradeStateDesc
String temp
String batchId
Boolean needQueryDetail
Integer offset
Integer limit
String detailStatus
String outBatchNo
Integer offset
Integer limit
QueryTransferBatchesResult.TransferBatch transferBatch
List<E> transferDetailList
String mchid
String outBatchNo
String batchId
String appid
String outDetailNo
String detailId
String detailStatus
Integer transferAmount
String transferRemark
String failReason
String openid
String userName
String initiateTime
String updateTime
String appid
String outBatchNo
String batchName
String batchRemark
Integer totalAmount
Integer totalNum
List<E> transferDetailList
String transferSceneId
String notifyUrl
String outBillNo
String transferBillNo
String state
String updateTime
String mchId
String outBillNo
String transferBillNo
String appid
String state
WxPayConstants.TransformBillState
String transferAmount
String transferRemark
String failReason
String openid
String userName
String createTime
String updateTime
OriginNotifyResponse rawData
TransferBillsNotifyResult.DecryptNotifyResult result
String mchId
String outBillNo
String transferBillNo
String state
Integer transferAmount
String openid
String createTime
String updateTime
String failReason
String appid
String outBillNo
String transferSceneId
String openid
String userName
Integer transferAmount
String transferRemark
String notifyUrl
String userRecvPerception
List<E> transferSceneReportInfos
OriginNotifyResponse rawData
TransferNotifyResult.DecryptNotifyResult result
String mchid
String outBatchNo
String batchId
String batchStatus
Integer totalNum
Integer totalAmount
Integer successAmount
Integer successNum
Integer failAmount
Integer failNum
String updateTime
String closeReason
Copyright © 2025. All rights reserved.