{ "name": "cpdp", "display_name": "企业收付平台", "description": "介绍如何使用API对企业收付平台进行操作，包括聚鑫、云鉴、智慧零售等。", "domain": "other", "api_version": "2019-08-20", "endpoint": "cpdp.tencentcloudapi.com", "actions": [ { "name": "AddContract", "description": "云支付-添加合同接口", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "收单系统分配的开放ID", "example": "f2cc268b9c95fbbb230a19397fe35f8d" }, { "name": "OpenKey", "type": "string", "required": true, "description": "收单系统分配的密钥", "example": "e30051d527bd4e621e7090c9392739ec" }, { "name": "OutContractId", "type": "string", "required": true, "description": "机构合同主键（系统有唯一性校验），建议使用合同表的主键ID，防止重复添加合同", "example": "C0001" }, { "name": "Code", "type": "string", "required": true, "description": "合同编号（系统有唯一性校验）", "example": "11111" }, { "name": "PaymentId", "type": "string", "required": true, "description": "支付方式编号", "example": "0" }, { "name": "PaymentClassificationId", "type": "string", "required": true, "description": "支付方式行业分类编号", "example": "03-1" }, { "name": "PaymentClassificationLimit", "type": "string", "required": true, "description": "封顶值（分为单位，无封顶填0）", "example": "0" }, { "name": "MerchantNo", "type": "string", "required": true, "description": "商户编号", "example": "M0001" }, { "name": "Fee", "type": "string", "required": true, "description": "签约扣率百分比（如：0.32）", "example": "0.32" }, { "name": "StartDate", "type": "string", "required": true, "description": "合同生效日期（yyyy-mm-dd）", "example": "2019-9-9" }, { "name": "EndDate", "type": "string", "required": true, "description": "合同过期日期（yyyy-mm-dd）", "example": "2029-9-9" }, { "name": "SignMan", "type": "string", "required": true, "description": "合同签约人", "example": "张三" }, { "name": "SignName", "type": "string", "required": true, "description": "签购单名称，建议使用商户招牌名称", "example": "北极星" }, { "name": "SignDate", "type": "string", "required": true, "description": "合同签署日期（yyyy-mm-dd）", "example": "2019-9-9" }, { "name": "AutoSign", "type": "string", "required": true, "description": "是否自动续签（1是，0否）", "example": "0" }, { "name": "Contact", "type": "string", "required": true, "description": "联系人", "example": "张三" }, { "name": "ContactTelephone", "type": "string", "required": true, "description": "联系人电话", "example": "13800138000" }, { "name": "PictureOne", "type": "string", "required": true, "description": "合同照片【私密区】", "example": "201901/123456.jpg" }, { "name": "PictureTwo", "type": "string", "required": false, "description": "合同照片【私密区】", "example": "201901/123456.jpg" }, { "name": "ChannelExtJson", "type": "string", "required": false, "description": "渠道扩展字段，json格式", "example": "无" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" }, { "name": "PaymentOptionOne", "type": "string", "required": false, "description": "合同选项1（不同支付方式规则不一样，请以支付方式规定的格式传值）", "example": "open_id" }, { "name": "PaymentOptionTwo", "type": "string", "required": false, "description": "合同选项2（不同支付方式规则不一样，请以支付方式规定的格式传值）", "example": "open_key" }, { "name": "PaymentOptionThree", "type": "string", "required": false, "description": "合同选项3（不同支付方式规则不一样，请以支付方式规定的格式传值）", "example": "九江银行商户号" }, { "name": "PaymentOptionFour", "type": "string", "required": false, "description": "合同选项4（不同支付方式规则不一样，请以支付方式规定的格式传值）", "example": "微信子商户号" }, { "name": "PaymentOptionFive", "type": "string", "required": false, "description": "合同证书选项1（不同支付方式规则不一样，请以支付方式规定的格式传值）", "example": "微信子商户号" }, { "name": "PaymentOptionSix", "type": "string", "required": false, "description": "合同证书选项2（不同支付方式规则不一样，请以支付方式规定的格式传值）", "example": "微信子商户号" }, { "name": "PaymentOptionSeven", "type": "string", "required": false, "description": "合同选项5（不同支付方式规则不一样，请以支付方式规定的格式传值）", "example": "微信子商户号" }, { "name": "PaymentOptionOther", "type": "string", "required": false, "description": "合同选项6（不同支付方式规则不一样，请以支付方式规定的格式传值）", "example": "微信子商户号" }, { "name": "PaymentOptionTen", "type": "string", "required": false, "description": "合同选项8", "example": "微信子商户号" }, { "name": "PaymentOptionNine", "type": "string", "required": false, "description": "合同选项7（不同支付方式规则不一样，请以支付方式规定的格式传值）", "example": "微信子商户号" } ], "required": [ "OpenId", "OpenKey", "OutContractId", "Code", "PaymentId", "PaymentClassificationId", "PaymentClassificationLimit", "MerchantNo", "Fee", "StartDate", "EndDate", "SignMan", "SignName", "SignDate", "AutoSign", "Contact", "ContactTelephone", "PictureOne" ] }, { "name": "AddFlexFundingAccount", "description": "灵云V2-绑定收款用户资金账号信息", "status": "online", "parameters": [ { "name": "FundingAccountType", "type": "string", "required": true, "description": "资金账户类型 PINGAN_BANK:平安银行", "example": "无" }, { "name": "FundingAccountName", "type": "string", "required": true, "description": "收款资金账户姓名", "example": "无" }, { "name": "FundingAccountNo", "type": "string", "required": true, "description": "收款资金账户号", "example": "无" }, { "name": "PhoneNo", "type": "string", "required": true, "description": "收款资金账户手机号", "example": "无" }, { "name": "PayeeId", "type": "string", "required": true, "description": "收款用户ID", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 __test__:测试环境 缺省默认为生产环境", "example": "无" }, { "name": "BankBranchName", "type": "string", "required": false, "description": "开户支行名", "example": "无" } ], "required": [ "FundingAccountType", "FundingAccountName", "FundingAccountNo", "PhoneNo", "PayeeId" ] }, { "name": "AddFlexIdInfo", "description": "灵云V2-补充证件信息", "status": "online", "parameters": [ { "name": "IdType", "type": "integer", "required": true, "description": "证件类型 0:身份证 1:社会信用代码", "example": "无" }, { "name": "IdNo", "type": "string", "required": true, "description": "证件号", "example": "无" }, { "name": "PayeeId", "type": "string", "required": true, "description": "收款用户ID", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 __test__:测试环境 缺省默认为生产环境", "example": "无" }, { "name": "Name", "type": "string", "required": false, "description": "姓名", "example": "无" } ], "required": [ "IdType", "IdNo", "PayeeId" ] }, { "name": "AddFlexPhoneNo", "description": "灵云V2-补充手机号信息", "status": "online", "parameters": [ { "name": "PhoneNo", "type": "string", "required": true, "description": "手机号", "example": "无" }, { "name": "PayeeId", "type": "string", "required": true, "description": "收款用户ID", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 __test__:测试环境 缺省默认为生产环境", "example": "无" } ], "required": [ "PhoneNo", "PayeeId" ] }, { "name": "AddMerchant", "description": "云支付-添加商户接口", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "收单系统分配的开放ID", "example": "f2cc268b9c95fbbb230a19397fe35f8d" }, { "name": "OpenKey", "type": "string", "required": true, "description": "收单系统分配的密钥", "example": "e30051d527bd4e621e7090c9392739ec" }, { "name": "OutMerchantId", "type": "string", "required": true, "description": "机构商户主键（系统有唯一性校验），建议使用商户表的主键ID，防止重复添加商户", "example": "10" }, { "name": "MerchantName", "type": "string", "required": true, "description": "商户名称，小微商户命名要符合“”商户_名字” （例如：商户_张三）", "example": "北极星" }, { "name": "BusinessLicenseType", "type": "string", "required": true, "description": "营业执照类型（1三证合一，2非三证合一）", "example": "1" }, { "name": "BusinessLicenseNo", "type": "string", "required": true, "description": "营业执照编号（系统有唯一性校验），（小微商户不效验，随意传要有值，公司/个体户必传）", "example": "100" }, { "name": "BusinessLicensePicture", "type": "string", "required": true, "description": "营业执照图片【私密区】（系统返回的图片路径），（小微商户不效验，随意传要有值，公司/个体户必传）", "example": "picture3" }, { "name": "BusinessLicenseStartDate", "type": "string", "required": true, "description": "营业执照生效时间（yyyy-mm-dd），（小微商户不效验，随意传要有值，公司/个体户必传）", "example": "2019-9-9" }, { "name": "BusinessLicenseEndDate", "type": "string", "required": true, "description": "营业执照过期时间（yyyy-mm-dd），（小微商户不效验，随意传要有值，公司/个体户必传）", "example": "2029-9-9" }, { "name": "ClassificationIds", "type": "array", "required": true, "description": "行业分类编号列表（第一个分类编号为主分类，后面的为二级分类）", "example": "无", "item_type": "string" }, { "name": "BrandName", "type": "string", "required": true, "description": "招牌名称", "example": "北国风光" }, { "name": "Telephone", "type": "string", "required": true, "description": "联系电话", "example": "11111111111" }, { "name": "CityId", "type": "string", "required": true, "description": "城市编号", "example": "111000" }, { "name": "Address", "type": "string", "required": true, "description": "详细地址，不含省市区县名称，长度需要大于5。", "example": "东湖路" }, { "name": "OpenHours", "type": "string", "required": true, "description": "营业时间，多个以小写逗号分开(9:00-12:00,13:00-18:00)", "example": "9:00-12:00,13:00-18:00" }, { "name": "AccountType", "type": "string", "required": true, "description": "结算账户类型（2对私，1对公）", "example": "1" }, { "name": "BankNo", "type": "string", "required": true, "description": "清算联行号，开户行行号", "example": "1" }, { "name": "BankName", "type": "string", "required": true, "description": "开户行名称", "example": "中国银行" }, { "name": "AccountNo", "type": "string", "required": true, "description": "银行账号", "example": "10000" }, { "name": "AccountName", "type": "string", "required": true, "description": "银行户名", "example": "100" }, { "name": "BossIdType", "type": "string", "required": true, "description": "法人证件类型（1居民身份证,2临时居民身份证,3居民户口簿,4护照,5港澳居民来往内地通行证,6回乡证,7军人证,8武警身份证,9其他法定文件）", "example": "1" }, { "name": "BossIdNo", "type": "string", "required": true, "description": "法人证件号码", "example": "00000000000000000" }, { "name": "BossName", "type": "string", "required": true, "description": "法人姓名", "example": "张三" }, { "name": "BossSex", "type": "string", "required": true, "description": "法人性别（1男，2女）", "example": "1" }, { "name": "BossIdCountry", "type": "string", "required": true, "description": "法人证件国别/地区（中国CHN，香港HKG，澳门MAC，台湾CTN）", "example": "中国CHN" }, { "name": "BossPositive", "type": "string", "required": true, "description": "法人身份证正面【私密区】（系统返回的图片路径）", "example": "201901/123456.jpg" }, { "name": "BossBack", "type": "string", "required": true, "description": "法人身份证背面【私密区】（系统返回的图片路径）", "example": "201901/123456.jpg" }, { "name": "BossStartDate", "type": "string", "required": true, "description": "法人证件生效时间（yyyy-mm-dd）", "example": "2019-9-9" }, { "name": "BossEndDate", "type": "string", "required": true, "description": "法人证件过期时间（yyyy-mm-dd）", "example": "2029-9-9" }, { "name": "LicencePicture", "type": "string", "required": true, "description": "许可证图片【私密区】，（小微商户不效验，随意传要有值，公司/个体户必传）", "example": "201901/123456.jpg" }, { "name": "Type", "type": "string", "required": false, "description": "商户类型：1-个体，2-小微，3-企业。不传默认为2-小微商户。", "example": "2" }, { "name": "OrganizationNo", "type": "string", "required": false, "description": "组织机构代码证号", "example": "00000" }, { "name": "OrganizationStartDate", "type": "string", "required": false, "description": "组织机构代码证生效时间（yyyy-mm-dd）", "example": "2019-9-9" }, { "name": "OrganizationPicture", "type": "string", "required": false, "description": "组织机构代码证图片【私密区】", "example": "201901/123456.jpg" }, { "name": "OrganizationEndDate", "type": "string", "required": false, "description": "组织机构代码证过期时间（yyyy-mm-dd）", "example": "2029-9-9" }, { "name": "Intro", "type": "string", "required": false, "description": "商户简介", "example": "互联网商户" }, { "name": "Logo", "type": "string", "required": false, "description": "商户logo【公共区】", "example": "北极星" }, { "name": "Tag", "type": "string", "required": false, "description": "商户标记，自定义参数", "example": "10" }, { "name": "FinancialTelephone", "type": "string", "required": false, "description": "财务联系人电话", "example": "11111111111" }, { "name": "FinancialContact", "type": "string", "required": false, "description": "财务联系人", "example": "张三" }, { "name": "TaxRegistrationNo", "type": "string", "required": false, "description": "税务登记证号", "example": "00100" }, { "name": "TaxRegistrationPicture", "type": "string", "required": false, "description": "税务登记证图片【私密区】", "example": "201901/123456.jpg" }, { "name": "TaxRegistrationStartDate", "type": "string", "required": false, "description": "税务登记证生效时间（yyyy-mm-dd）", "example": "2019-9-9" }, { "name": "TaxRegistrationEndDate", "type": "string", "required": false, "description": "税务登记证过期时间（yyyy-mm-dd）", "example": "2029-9-9" }, { "name": "AccountBoss", "type": "string", "required": false, "description": "结算账户人身份（1法人，2法人亲属），结算帐户为对私时必填", "example": "1" }, { "name": "AccountManagerName", "type": "string", "required": false, "description": "客户经理姓名，必须为系统后台的管理员真实姓名", "example": "李四" }, { "name": "BossTelephone", "type": "string", "required": false, "description": "法人电话", "example": "11111111111" }, { "name": "BossJob", "type": "string", "required": false, "description": "法人职业", "example": "学生" }, { "name": "BossEmail", "type": "string", "required": false, "description": "法人邮箱", "example": "11111111111@163.com" }, { "name": "BossAddress", "type": "string", "required": false, "description": "法人住址", "example": "北京朝阳区" }, { "name": "AccountIdType", "type": "string", "required": false, "description": "法人亲属证件类型（1居民身份证,2临时居民身份证,3居民户口簿,4护照,5港澳居民来往内地通行证,6回乡证,7军人证,8武警身份证,9其他法定文件）结算账户人身份为法人亲属时必填", "example": "1" }, { "name": "AccountIdNo", "type": "string", "required": false, "description": "法人亲属证件号码", "example": "11111111111111112" }, { "name": "LicencePictureTwo", "type": "string", "required": false, "description": "授权文件【私密区】", "example": "201901/123456.jpg" }, { "name": "OtherPictureOne", "type": "string", "required": false, "description": "其他资料1", "example": "资料1" }, { "name": "OtherPictureTwo", "type": "string", "required": false, "description": "其他资料2", "example": "资料2" }, { "name": "OtherPictureThree", "type": "string", "required": false, "description": "其他资料3", "example": "资料3" }, { "name": "OtherPictureFour", "type": "string", "required": false, "description": "其他资料4", "example": "资料4" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey", "OutMerchantId", "MerchantName", "BusinessLicenseType", "BusinessLicenseNo", "BusinessLicensePicture", "BusinessLicenseStartDate", "BusinessLicenseEndDate", "ClassificationIds", "BrandName", "Telephone", "CityId", "Address", "OpenHours", "AccountType", "BankNo", "BankName", "AccountNo", "AccountName", "BossIdType", "BossIdNo", "BossName", "BossSex", "BossIdCountry", "BossPositive", "BossBack", "BossStartDate", "BossEndDate", "LicencePicture" ] }, { "name": "AddShop", "description": "云支付-添加门店接口", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "收单系统分配的开放ID", "example": "f2cc268b9c95fbbb230a19397fe35f8d" }, { "name": "OpenKey", "type": "string", "required": true, "description": "收单系统分配的密钥", "example": "e30051d527bd4e621e7090c9392739ec" }, { "name": "OutShopId", "type": "string", "required": true, "description": "机构门店主键（系统有唯一性校验），建议使用门店表的主键ID，防止重复添加门店", "example": "S0001" }, { "name": "ShopName", "type": "string", "required": true, "description": "门店简称（例如：南山店）", "example": "南山店" }, { "name": "ShopFullName", "type": "string", "required": true, "description": "门店全称（例如：江山小厨（南山店））", "example": "江山小厨（南山店）" }, { "name": "MerchantNo", "type": "string", "required": true, "description": "商户编号", "example": "M0001" }, { "name": "Telephone", "type": "string", "required": true, "description": "门店电话", "example": "11111111111" }, { "name": "OpenHours", "type": "string", "required": true, "description": "营业时间，多个以小写逗号分开(9:00-12:00,13:00-18:00)", "example": "9:00-12:00,13:00-18:00" }, { "name": "CityId", "type": "string", "required": true, "description": "门店所在的城市编码", "example": "440300" }, { "name": "Address", "type": "string", "required": true, "description": "门店详细地址，不含省市区县名称", "example": "大学城" }, { "name": "PictureOne", "type": "string", "required": true, "description": "整体门面（含招牌）图片【公共区】", "example": "201901/123456.jpg" }, { "name": "PictureTwo", "type": "string", "required": true, "description": "整体门面（含招牌）图片【公共区】", "example": "201901/123456.jpg" }, { "name": "PictureThree", "type": "string", "required": true, "description": "店内环境图片【公共区】", "example": "201901/123456.jpg" }, { "name": "FinancialTelephone", "type": "string", "required": false, "description": "负责人手机号码", "example": "11111111111" }, { "name": "Contact", "type": "string", "required": false, "description": "门店负责人", "example": "张三" }, { "name": "Latitude", "type": "string", "required": false, "description": "百度地图纬度", "example": "E114°03′" }, { "name": "LatitudeTwo", "type": "string", "required": false, "description": "高德地图纬度", "example": "E114°03′" }, { "name": "Longitude", "type": "string", "required": false, "description": "百度地图经度", "example": "N22°32′" }, { "name": "LongitudeTwo", "type": "string", "required": false, "description": "高德地图经度", "example": "N22°32′" }, { "name": "OtherPicture", "type": "string", "required": false, "description": "其他照片【公共区】", "example": "201901/123456.jpg" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey", "OutShopId", "ShopName", "ShopFullName", "MerchantNo", "Telephone", "OpenHours", "CityId", "Address", "PictureOne", "PictureTwo", "PictureThree" ] }, { "name": "ApplyApplicationMaterial", "description": "跨境-提交申报材料。申报材料的主体是付款人，需要提前调用【跨境-付款人申请】接口提交付款人信息且审核通过后调用。", "status": "online", "parameters": [ { "name": "TransactionId", "type": "string", "required": true, "description": "对接方汇出指令编号", "example": "trasid201911230012" }, { "name": "DeclareId", "type": "string", "required": true, "description": "申报流水号", "example": "dcldid201911230012" }, { "name": "PayerId", "type": "string", "required": true, "description": "付款人ID", "example": "qyfkr201911230004" }, { "name": "SourceCurrency", "type": "string", "required": true, "description": "源币种", "example": "CNY" }, { "name": "TargetCurrency", "type": "string", "required": true, "description": "目的币种", "example": "CNY" }, { "name": "TradeCode", "type": "string", "required": true, "description": "贸易编码", "example": "223010" }, { "name": "OriginalDeclareId", "type": "string", "required": false, "description": "原申报流水号", "example": " test12345" }, { "name": "SourceAmount", "type": "integer", "required": false, "description": "源金额", "example": "1" }, { "name": "TargetAmount", "type": "integer", "required": false, "description": "目的金额", "example": "1" }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填sandbox", "example": "sandbox" } ], "required": [ "TransactionId", "DeclareId", "PayerId", "SourceCurrency", "TargetCurrency", "TradeCode" ] }, { "name": "ApplyFlexPayment", "description": "灵云V2-付款", "status": "online", "parameters": [ { "name": "PayeeId", "type": "string", "required": true, "description": "收款用户ID", "example": "无" }, { "name": "IncomeType", "type": "string", "required": true, "description": "收入类型 LABOR:劳务所得 OCCASION:偶然所得", "example": "无" }, { "name": "AmountBeforeTax", "type": "string", "required": true, "description": "税前金额", "example": "无" }, { "name": "OutOrderId", "type": "string", "required": true, "description": "外部订单ID", "example": "无" }, { "name": "FundingAccountInfo", "type": "object", "required": true, "description": "资金账户信息", "example": "无", "children": [ { "name": "FundingAccountNo", "type": "string", "required": false, "description": "资金账户号", "example": "无" }, { "name": "FundingAccountType", "type": "string", "required": false, "description": "资金账户类型", "example": "无" }, { "name": "FundingAccountBindSerialNo", "type": "string", "required": false, "description": "资金账户绑定序列号", "example": "无" }, { "name": "FundingAccountName", "type": "string", "required": false, "description": "资金账户名称", "example": "无" } ] }, { "name": "Remark", "type": "string", "required": false, "description": "提现备注", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 __test__:测试环境 缺省默认为生产环境", "example": "无" }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "支付结果通知回调地址", "example": "无" } ], "required": [ "PayeeId", "IncomeType", "AmountBeforeTax", "OutOrderId", "FundingAccountInfo" ] }, { "name": "ApplyFlexSettlement", "description": "灵云V2-结算", "status": "online", "parameters": [ { "name": "PayeeId", "type": "string", "required": true, "description": "收款用户ID", "example": "无" }, { "name": "IncomeType", "type": "string", "required": true, "description": "收入类型 LABOR:劳务所得 OCCASION:偶然所得", "example": "无" }, { "name": "AmountBeforeTax", "type": "string", "required": true, "description": "税前金额", "example": "无" }, { "name": "OutOrderId", "type": "string", "required": true, "description": "外部订单ID", "example": "无" }, { "name": "Remark", "type": "string", "required": true, "description": "备注", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 __test__:测试环境 缺省默认为生产环境", "example": "无" } ], "required": [ "PayeeId", "IncomeType", "AmountBeforeTax", "OutOrderId", "Remark" ] }, { "name": "ApplyFlexWechatPreAuth", "description": "微工卡开通预核身接口", "status": "online", "parameters": [ { "name": "AuthNo", "type": "string", "required": true, "description": "商家核身单号", "example": "无" }, { "name": "OpenId", "type": "string", "required": true, "description": "微信用户标识", "example": "无" }, { "name": "ProjectName", "type": "string", "required": true, "description": "项目名称", "example": "无" }, { "name": "EmployerName", "type": "string", "required": true, "description": "用工单位名称", "example": "无" }, { "name": "UserName", "type": "string", "required": true, "description": "用户姓名", "example": "无" }, { "name": "IdNo", "type": "string", "required": true, "description": "用户证件号", "example": "无" }, { "name": "EmploymentType", "type": "string", "required": true, "description": "用工类型 LONG_TERM_EMPLOYMENT：长期用工， SHORT_TERM_EMPLOYMENT： 短期用工， COOPERATION_EMPLOYMENT：合作关系", "example": "无" }, { "name": "AuthType", "type": "string", "required": true, "description": "核身类型 SIGN_IN：考勤、签到打卡类型 INSURANCE：投保类型 CONTRACT：签约类型", "example": "无" }, { "name": "Environment", "type": "string", "required": true, "description": "环境类型 test 测试 release 生产 sandbox 沙箱", "example": "无" } ], "required": [ "AuthNo", "OpenId", "ProjectName", "EmployerName", "UserName", "IdNo", "EmploymentType", "AuthType", "Environment" ] }, { "name": "ApplyOpenBankOrderDetailReceipt", "description": "云企付-申请单笔交易回单", "status": "online", "parameters": [ { "name": "OutApplyId", "type": "string", "required": true, "description": "外部回单申请编号", "example": "无" }, { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户ID", "example": "无" }, { "name": "ChannelSubMerchantId", "type": "string", "required": true, "description": "渠道子商户ID", "example": "无" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称，目前只支持ALIPAY", "example": "ALIPAY" }, { "name": "PaymentMethod", "type": "string", "required": true, "description": "支付方式，目前只支持SAFT_ISV", "example": "SAFT_ISV" }, { "name": "ChannelOrderId", "type": "string", "required": true, "description": "云企付平台订单号", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "无" } ], "required": [ "OutApplyId", "ChannelMerchantId", "ChannelSubMerchantId", "ChannelName", "PaymentMethod", "ChannelOrderId" ] }, { "name": "ApplyOpenBankSettleOrder", "description": "云企付-结算申请接口", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户号", "example": "无" }, { "name": "OutSettleId", "type": "string", "required": true, "description": "外部结算流水号", "example": "无" }, { "name": "SettleAmount", "type": "integer", "required": true, "description": "结算金额", "example": "无" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称。详见附录-枚举类型-ChannelName。", "example": "无" }, { "name": "ChannelSubMerchantId", "type": "string", "required": false, "description": "渠道子商户号", "example": "无" }, { "name": "SettleDetail", "type": "string", "required": false, "description": "结算备注", "example": "无" }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "结算成功回调地址", "example": "无" }, { "name": "Remark", "type": "string", "required": false, "description": "附言", "example": "无" }, { "name": "ExternalSettleData", "type": "string", "required": false, "description": "结算第三方渠道扩展信息。通联国际必选", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "接入环境。沙箱环境填 sandbox。缺省默认调用生产环境", "example": "无" } ], "required": [ "ChannelMerchantId", "OutSettleId", "SettleAmount", "ChannelName" ] }, { "name": "ApplyOpenBankSubMerchantSignOnline", "description": "子商户在线签约", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户号。外部平台接入云企付平台下发。必填。", "example": "无" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称。详见附录-枚举类型-ChannelName。", "example": "无" }, { "name": "OutSubMerchantId", "type": "string", "required": false, "description": "外部子商户ID。", "example": "无" }, { "name": "ChannelSubMerchantId", "type": "string", "required": false, "description": "渠道子商户ID。", "example": "无" }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "签约成功回调地址。", "example": "无" } ], "required": [ "ChannelMerchantId", "ChannelName" ] }, { "name": "ApplyOutwardOrder", "description": "跨境-汇出指令申请。通过该接口可将对接方账户中的人民币余额汇兑成外币，再汇出至指定银行账户。", "status": "online", "parameters": [ { "name": "TransactionId", "type": "string", "required": true, "description": "对接方汇出指令编号", "example": "trasid201911230012" }, { "name": "PricingCurrency", "type": "string", "required": true, "description": "定价币种", "example": "CNY" }, { "name": "SourceCurrency", "type": "string", "required": true, "description": "源币种", "example": "CNY" }, { "name": "TargetCurrency", "type": "string", "required": true, "description": "目的币种", "example": "USD" }, { "name": "PayeeType", "type": "string", "required": true, "description": "收款人类型（银行卡填\"BANK_ACCOUNT\"）", "example": "BANK_ACCOUNT" }, { "name": "PayeeAccount", "type": "string", "required": true, "description": "收款人账号", "example": "325119780000" }, { "name": "SourceAmount", "type": "float", "required": false, "description": "源币种金额", "example": "10" }, { "name": "TargetAmount", "type": "float", "required": false, "description": "目的金额", "example": "1" }, { "name": "PayeeName", "type": "string", "required": false, "description": "收款人姓名（PayeeType为\"BANK_COUNT\"时必填）", "example": "TEST" }, { "name": "PayeeAddress", "type": "string", "required": false, "description": "收款人地址（PayeeType为\"BANK_COUNT\"时必填）", "example": "TEST" }, { "name": "PayeeBankAccountType", "type": "string", "required": false, "description": "收款人银行账号类型（PayeeType为\"BANK_COUNT\"时必填） 个人填\"INDIVIDUAL\" 企业填\"CORPORATE\"", "example": "CORPORATE" }, { "name": "PayeeCountryCode", "type": "string", "required": false, "description": "收款人国家或地区编码（PayeeType为\"BANK_COUNT\"时必填）", "example": "USA" }, { "name": "PayeeBankName", "type": "string", "required": false, "description": "收款人开户银行名称（PayeeType为\"BANK_COUNT\"时必填）", "example": "TEST" }, { "name": "PayeeBankAddress", "type": "string", "required": false, "description": "收款人开户银行地址（PayeeType为\"BANK_COUNT\"时必填）", "example": "TEST" }, { "name": "PayeeBankDistrict", "type": "string", "required": false, "description": "收款人开户银行所在国家或地区编码（PayeeType为\"BANK_COUNT\"时必填）", "example": "US" }, { "name": "PayeeBankSwiftCode", "type": "string", "required": false, "description": "收款银行SwiftCode（PayeeType为\"BANK_COUNT\"时必填）", "example": "CITIUS33XXX" }, { "name": "PayeeBankType", "type": "string", "required": false, "description": "收款银行国际编码类型", "example": " TEST" }, { "name": "PayeeBankCode", "type": "string", "required": false, "description": "收款银行国际编码", "example": "026009593" }, { "name": "ReferenceForBeneficiary", "type": "string", "required": false, "description": "收款人附言", "example": "TEST" }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填sandbox", "example": "sandbox" } ], "required": [ "TransactionId", "PricingCurrency", "SourceCurrency", "TargetCurrency", "PayeeType", "PayeeAccount" ] }, { "name": "ApplyPayerInfo", "description": "跨境-付款人申请。通过该接口提交付款人信息并进行 kyc 审核。", "status": "online", "parameters": [ { "name": "PayerId", "type": "string", "required": true, "description": "付款人ID", "example": "qyfkr201911230006" }, { "name": "PayerType", "type": "string", "required": true, "description": "付款人类型 (个人: INDIVIDUAL, 企业: CORPORATE)", "example": "CORPORATE" }, { "name": "PayerName", "type": "string", "required": true, "description": "付款人姓名", "example": "企业名称" }, { "name": "PayerIdType", "type": "string", "required": true, "description": "付款人证件类型 (身份证: ID_CARD, 统一社会信用代码: UNIFIED_CREDIT_CODE)", "example": "UNIFIED_CREDIT_CODE" }, { "name": "PayerIdNo", "type": "string", "required": true, "description": "付款人证件号", "example": "913302127996560011" }, { "name": "PayerCountryCode", "type": "string", "required": true, "description": "付款人常驻国家或地区编码 (见常见问题-国家/地区编码)", "example": "TEST" }, { "name": "PayerContactName", "type": "string", "required": false, "description": "付款人联系人名称", "example": "TEST" }, { "name": "PayerContactNumber", "type": "string", "required": false, "description": "付款人联系电话", "example": "TEST" }, { "name": "PayerEmailAddress", "type": "string", "required": false, "description": "付款人联系邮箱", "example": "TEST" }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填sandbox", "example": "sandbox" } ], "required": [ "PayerId", "PayerType", "PayerName", "PayerIdType", "PayerIdNo", "PayerCountryCode" ] }, { "name": "ApplyReWithdrawal", "description": "正常结算提现失败情况下，发起重新提现的请求接口", "status": "online", "parameters": [ { "name": "BusinessType", "type": "integer", "required": true, "description": "聚鑫业务类型" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "由平台客服提供的计费密钥Id" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "计费签名" }, { "name": "Body", "type": "object", "required": true, "description": "提现信息", "children": [ { "name": "WithdrawOrderId", "type": "string", "required": true, "description": "业务提现订单号" }, { "name": "Date", "type": "string", "required": true, "description": "提现日期" }, { "name": "PayAmt", "type": "string", "required": true, "description": "提现金额，单位： 分" }, { "name": "InSubAppId", "type": "string", "required": true, "description": "聚鑫分配转入账户appid" }, { "name": "OutSubAppId", "type": "string", "required": true, "description": "聚鑫分配转出账户appid" }, { "name": "CurrencyType", "type": "string", "required": true, "description": "ISO货币代码" }, { "name": "MetaData", "type": "string", "required": false, "description": "透传字段" }, { "name": "ExtendFieldData", "type": "string", "required": false, "description": "扩展字段" } ] }, { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫业务ID" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名: release: 现网环境 sandbox: 沙箱环境 development: 开发环境 缺省: release" } ], "required": [ "BusinessType", "MidasSecretId", "MidasSignature", "Body", "MidasAppId" ] }, { "name": "ApplyReconciliationFile", "description": "聚鑫-申请对账文件", "status": "online", "parameters": [ { "name": "ApplyFileType", "type": "string", "required": true, "description": "申请的文件类型。 __CZ__：充值文件 __TX__：提现文件 __JY__：交易文件 __YE__：余额文件", "example": "YE" }, { "name": "ApplyFileDate", "type": "string", "required": true, "description": "申请的对账文件日期，格式：yyyyMMdd。", "example": "20220222" }, { "name": "BankAccountNumber", "type": "string", "required": true, "description": "父账户账号。 _平安渠道为资金汇总账号_", "example": "无" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名。 __release__: 现网环境 __sandbox__: 沙箱环境 __development__: 开发环境 _缺省: release_", "example": "release" } ], "required": [ "ApplyFileType", "ApplyFileDate", "BankAccountNumber" ] }, { "name": "ApplyTrade", "description": "跨境-提交贸易材料。通过提交贸易材料接口可为对接方累计贸易额度，在额度范围内可发起汇兑汇出交易。", "status": "online", "parameters": [ { "name": "TradeFileId", "type": "string", "required": true, "description": "贸易材料流水号", "example": "tdflid20191123023" }, { "name": "TradeOrderId", "type": "string", "required": true, "description": "贸易材料订单号", "example": "tdodid20191118021" }, { "name": "PayerId", "type": "string", "required": true, "description": "付款人ID", "example": "qyfkr201911230001" }, { "name": "PayeeName", "type": "string", "required": true, "description": "收款人姓名", "example": "个人收款姓名A" }, { "name": "PayeeCountryCode", "type": "string", "required": true, "description": "收款人常驻国家或地区编码 (见常见问题)", "example": "CHN" }, { "name": "TradeType", "type": "string", "required": true, "description": "贸易类型 (GOODS: 商品, SERVICE: 服务)", "example": "GOODS" }, { "name": "TradeTime", "type": "string", "required": true, "description": "交易时间 (格式: yyyyMMdd)", "example": "20191118" }, { "name": "TradeCurrency", "type": "string", "required": true, "description": "交易币种", "example": "USD" }, { "name": "TradeAmount", "type": "float", "required": true, "description": "交易金额", "example": "10.22" }, { "name": "TradeName", "type": "string", "required": true, "description": "交易名称 (TradeType=GOODS时填写物品名称，可填写多个，格式无要求； TradeType=SERVICE时填写贸易类别，见常见问题-贸易类别)", "example": "帽子" }, { "name": "TradeCount", "type": "integer", "required": true, "description": "交易数量 (TradeType=GOODS 填写物品数量, TradeType=SERVICE填写服务次数)", "example": "1" }, { "name": "GoodsCarrier", "type": "string", "required": false, "description": "货贸承运人 (TradeType=GOODS 必填)", "example": "中外运空运;MC2410918701000931505" }, { "name": "ServiceDetail", "type": "string", "required": false, "description": "服贸交易细节 (TradeType=GOODS 必填, 见常见问题-交易细节)", "example": "TEST" }, { "name": "ServiceTime", "type": "string", "required": false, "description": "服贸服务时间 (TradeType=GOODS 必填, 见常见问题-服务时间)", "example": "20210101" }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填sandbox", "example": "sandbox" } ], "required": [ "TradeFileId", "TradeOrderId", "PayerId", "PayeeName", "PayeeCountryCode", "TradeType", "TradeTime", "TradeCurrency", "TradeAmount", "TradeName", "TradeCount" ] }, { "name": "ApplyWithdrawal", "description": "商户提现", "status": "online", "parameters": [ { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的支付主MidasAppId" }, { "name": "SubAppId", "type": "string", "required": true, "description": "聚鑫计费SubAppId，代表子商户" }, { "name": "SettleAcctNo", "type": "string", "required": true, "description": "用于提现 加密详见《商户端接口敏感信息加密说明》" }, { "name": "SettleAcctName", "type": "string", "required": true, "description": "结算账户户名 加密详见《商户端接口敏感信息加密说明》" }, { "name": "CurrencyType", "type": "string", "required": true, "description": "币种 RMB" }, { "name": "CurrencyUnit", "type": "integer", "required": true, "description": "单位，1：元，2：角，3：分" }, { "name": "CurrencyAmt", "type": "string", "required": true, "description": "金额" }, { "name": "TranWebName", "type": "string", "required": true, "description": "交易网名称" }, { "name": "IdType", "type": "string", "required": true, "description": "会员证件类型" }, { "name": "IdCode", "type": "string", "required": true, "description": "会员证件号码 加密详见《商户端接口敏感信息加密说明》" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "聚鑫分配的安全ID" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "按照聚鑫安全密钥计算的签名" }, { "name": "EncryptType", "type": "string", "required": false, "description": "敏感信息加密类型: RSA: rsa非对称加密，使用RSA-PKCS1-v1_5 AES: aes对称加密，使用AES256-CBC-PCKS7padding 缺省: RSA" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名: release: 现网环境 sandbox: 沙箱环境 development: 开发环境 缺省: release" }, { "name": "CommissionAmount", "type": "string", "required": false, "description": "手续费金额" }, { "name": "WithdrawOrderId", "type": "string", "required": false, "description": "提现单号，长度32字节" } ], "required": [ "MidasAppId", "SubAppId", "SettleAcctNo", "SettleAcctName", "CurrencyType", "CurrencyUnit", "CurrencyAmt", "TranWebName", "IdType", "IdCode", "MidasSecretId", "MidasSignature" ] }, { "name": "BindAccount", "description": "灵云-绑定账号", "status": "online", "parameters": [ { "name": "AnchorId", "type": "string", "required": true, "description": "主播Id", "example": "无" }, { "name": "TransferType", "type": "integer", "required": true, "description": "1 微信企业付款 2 支付宝转账 3 平安银企直连代发转账", "example": "无" }, { "name": "AccountNo", "type": "string", "required": true, "description": "收款方标识。 微信为open_id； 支付宝为会员alipay_user_id; 平安为收款方银行账号;", "example": "无" }, { "name": "PhoneNum", "type": "string", "required": true, "description": "手机号", "example": "无" } ], "required": [ "AnchorId", "TransferType", "AccountNo", "PhoneNum" ] }, { "name": "BindAcct", "description": "商户绑定提现银行卡，每个商户只能绑定一张提现银行卡", "status": "online", "parameters": [ { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的支付主MidasAppId", "example": "your_midas_app_id" }, { "name": "SubAppId", "type": "string", "required": true, "description": "聚鑫计费SubAppId，代表子商户", "example": "your_sub_app_id" }, { "name": "BindType", "type": "integer", "required": true, "description": "1 – 小额转账验证 2 – 短信验证 3 - 一分钱转账验证，无需再调CheckAcct验证绑卡 4 - 银行四要素验证，无需再调CheckAcct验证绑卡 每个结算账户每天只能使用一次小额转账验证", "example": "1" }, { "name": "SettleAcctNo", "type": "string", "required": true, "description": "用于提现 加密详见《商户端接口敏感信息加密说明》", "example": "encrypted_account_no" }, { "name": "SettleAcctName", "type": "string", "required": true, "description": "结算账户户名 加密详见《商户端接口敏感信息加密说明》", "example": "encrypted_account_name" }, { "name": "SettleAcctType", "type": "integer", "required": true, "description": "1 – 本行账户 2 – 他行账户", "example": "1" }, { "name": "IdType", "type": "string", "required": true, "description": "证件类型，见《证件类型》表", "example": "1" }, { "name": "IdCode", "type": "string", "required": true, "description": "证件号码 加密详见《商户端接口敏感信息加密说明》", "example": "encrypted_id_code" }, { "name": "AcctBranchName", "type": "string", "required": true, "description": "开户行名称", "example": "银行名称" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "聚鑫分配的安全ID", "example": "your_midas_secret_id" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "按照聚鑫安全密钥计算的签名", "example": "your_midas_signature" }, { "name": "Mobile", "type": "string", "required": false, "description": "用于短信验证 BindType==2时必填 加密详见《商户端接口敏感信息加密说明》", "example": "encrypted_mobile_no" }, { "name": "CnapsBranchId", "type": "string", "required": false, "description": "大小额行号，超级网银行号和大小额行号 二选一", "example": "1234567890" }, { "name": "EiconBankBranchId", "type": "string", "required": false, "description": "超级网银行号，超级网银行号和大小额行号 二选一", "example": "分行ID" }, { "name": "EncryptType", "type": "string", "required": false, "description": "敏感信息加密类型: RSA: rsa非对称加密，使用RSA-PKCS1-v1_5 AES: aes对称加密，使用AES256-CBC-PCKS7padding 缺省: RSA", "example": "RSA" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名: release: 现网环境 sandbox: 沙箱环境 development: 开发环境 缺省: release", "example": "release" }, { "name": "AgencyClientInfo", "type": "object", "required": false, "description": "经办人信息", "example": "无", "children": [ { "name": "AgencyClientName", "type": "string", "required": true, "description": "经办人姓名，存在经办人必输", "example": "张三" }, { "name": "AgencyClientGlobalType", "type": "string", "required": true, "description": "经办人证件类型，存在经办人必输", "example": "1" }, { "name": "AgencyClientGlobalId", "type": "string", "required": true, "description": "经办人证件号，存在经办人必输", "example": "1234567890" }, { "name": "AgencyClientMobile", "type": "string", "required": true, "description": "经办人手机号，存在经办人必输", "example": "13900000000" } ] } ], "required": [ "MidasAppId", "SubAppId", "BindType", "SettleAcctNo", "SettleAcctName", "SettleAcctType", "IdType", "IdCode", "AcctBranchName", "MidasSecretId", "MidasSignature" ] }, { "name": "BindOpenBankExternalSubMerchantBankAccount", "description": "云企付-子商户银行卡绑定", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户ID。", "example": "无" }, { "name": "ChannelSubMerchantId", "type": "string", "required": true, "description": "渠道子商户ID。", "example": "无" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称。 __TENPAY__: 商企付 __WECHAT__: 微信支付 __ALIPAY__: 支付宝", "example": "TENPAY" }, { "name": "PaymentMethod", "type": "string", "required": true, "description": "支付方式。 __EBANK_PAYMENT__: ebank支付 __OPENBANK_PAYMENT__: openbank支付", "example": "无" }, { "name": "ExternalSubMerchantBindBankAccountData", "type": "string", "required": true, "description": "第三方渠道子商户收款方银行卡信息, 为JSON格式字符串。详情见附录-复杂类型。", "example": "无" }, { "name": "OutApplyId", "type": "string", "required": true, "description": "外部申请编号。", "example": "无" }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "通知地址。", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "无" } ], "required": [ "ChannelMerchantId", "ChannelSubMerchantId", "ChannelName", "PaymentMethod", "ExternalSubMerchantBindBankAccountData", "OutApplyId" ] }, { "name": "BindOpenBankProfitSharePayee", "description": "云企付-绑定分账收款方", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户号。代理商/集团ID", "example": "无" }, { "name": "AccountNo", "type": "string", "required": true, "description": "收款人银行账户号。唯一", "example": "无" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称 通联国际: CNP", "example": "无" }, { "name": "ChannelSubMerchantId", "type": "string", "required": false, "description": "渠道子商户号。商户ID", "example": "无" }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "绑定状态通知地址,若为空，即不回调通知。", "example": "无" }, { "name": "ProfitSharePayeeInfo", "type": "object", "required": false, "description": "分账收款人信息。通联国际必选", "example": "无", "children": [ { "name": "AccountName", "type": "string", "required": true, "description": "收款人账户名称", "example": "无" }, { "name": "BankName", "type": "string", "required": true, "description": "银行名称 可大体识别银行就行", "example": "无" }, { "name": "Currency", "type": "string", "required": true, "description": "账户货币", "example": "无" }, { "name": "Nature", "type": "string", "required": true, "description": "账户类型。 00:借记卡 01:存折 02:信用卡 03:准贷记卡 04:预付卡费 05:境外卡", "example": "无" }, { "name": "Country", "type": "string", "required": true, "description": "账户地区/受益人所在国家。参考附录“国家代码”表——“代码”字段", "example": "无" }, { "name": "DepositCountry", "type": "string", "required": true, "description": "账户开户所在国家 参考附录“国家代码”表——“代码”字段", "example": "无" }, { "name": "ExpireDate", "type": "string", "required": true, "description": "合作有效期 yyyy-MM-dd", "example": "无" }, { "name": "Flag", "type": "string", "required": true, "description": "0:个人(对私) 1:公司(对公)", "example": "无" }, { "name": "BankAddress", "type": "string", "required": false, "description": "开户行地址 账户地区非中国必填，【账户名+开户行地址不可超过114个字符（只允许【英文字母数字空格.,/-()'】），否则可能导致境外银行付款失败】", "example": "无" }, { "name": "Address", "type": "string", "required": false, "description": "客户地址 非中国内地账户的客户地址不能为空", "example": "无" }, { "name": "IsOSA", "type": "string", "required": false, "description": "账户属性 账户开户所在国家为中国则必填。 1-离岸账户 0-在岸账户", "example": "无" }, { "name": "Province", "type": "string", "required": false, "description": "账户省份 参考附录“地区代码”", "example": "无" }, { "name": "City", "type": "string", "required": false, "description": "账户城市 参考附录“地区代码", "example": "无" }, { "name": "LegalIdNo", "type": "string", "required": false, "description": "证件号/统一信用证代码 如果country与depositcountry字段都是CHN时，必填 对公账户填统一信用证代码，对私账户填身份证号码 离岸账户非必填", "example": "无" }, { "name": "Telephone", "type": "string", "required": false, "description": "手机号。 账户地区是日本则必填", "example": "无" }, { "name": "BicCode", "type": "string", "required": false, "description": "参考接口说明。", "example": "无" }, { "name": "SwiftCode", "type": "string", "required": false, "description": "参考接口说明。", "example": "无" }, { "name": "Cnaps", "type": "string", "required": false, "description": "大额支付行号/支付行号 参考接口说明。境外（大额支付行号）参考附录【大额行号】，境内（支付行号）参考附录【支付行号】", "example": "无" }, { "name": "TransferBankNo", "type": "string", "required": false, "description": "中转行号，参考接口说明。", "example": "无" }, { "name": "Fid", "type": "string", "required": false, "description": "关联附件。上传的文件ID", "example": "无" } ] }, { "name": "ExternalProfitSharingData", "type": "string", "required": false, "description": "第三方拓展信息。若无特殊说明，可为空", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "接入环境。沙箱环境填 sandbox。缺省默认调用生产环境", "example": "无" } ], "required": [ "ChannelMerchantId", "AccountNo", "ChannelName" ] }, { "name": "BindRelateAccReUnionPay", "description": "会员绑定提现账户-回填银联鉴权短信码。用于会员填写动态验证码后，发往银行进行验证，验证成功则完成绑定。", "status": "online", "parameters": [ { "name": "MrchCode", "type": "string", "required": true, "description": "String(22)，商户号（签约客户号）" }, { "name": "TranNetMemberCode", "type": "string", "required": true, "description": "STRING(32)，交易网会员代码（若需要把一个待绑定账户关联到两个会员名下，此字段可上送两个会员的交易网代码，并且须用“|::|”（右侧）进行分隔）" }, { "name": "MemberAcctNo", "type": "string", "required": true, "description": "STRING(50)，会员的待绑定账户的账号（即 BindRelateAcctUnionPay接口中的“会员的待绑定账户的账号”）" }, { "name": "MessageCheckCode", "type": "string", "required": true, "description": "STRING(20)，短信验证码（即 BindRelateAcctUnionPay接口中的手机所接收到的短信验证码）" }, { "name": "ReservedMsg", "type": "string", "required": false, "description": "STRING(1027)，保留域" }, { "name": "Profile", "type": "string", "required": false, "description": "STRING(12)，接入环境，默认接入沙箱环境。接入正式环境填\"prod\"" } ], "required": [ "MrchCode", "TranNetMemberCode", "MemberAcctNo", "MessageCheckCode" ] }, { "name": "BindRelateAcctSmallAmount", "description": "会员绑定提现账户-小额鉴权。会员申请绑定提现账户，绑定后从会员子账户中提现到绑定账户。 转账鉴权有两种形式：往账鉴权和来账鉴权。 往账鉴权：该接口发起成功后，银行会向提现账户转入小于等于0.5元的随机金额，并短信通知客户查看，客户查看后，需将收到的金额大小，在电商平台页面上回填，并通知银行。银行验证通过后，完成提现账户绑定。 来账鉴权：该接\ufffd...", "status": "online", "parameters": [ { "name": "MrchCode", "type": "string", "required": true, "description": "String(22)，商户号（签约客户号）" }, { "name": "TranNetMemberCode", "type": "string", "required": true, "description": "STRING(32)，交易网会员代码（若需要把一个待绑定账户关联到两个会员名下，此字段可上送两个会员的交易网代码，并且须用“|::|”(右侧)进行分隔）" }, { "name": "MemberName", "type": "string", "required": true, "description": "STRING(150)，见证子账户的户名（首次绑定的情况下，此字段即为待绑定的提现账户的户名。非首次绑定的情况下，须注意带绑定的提现账户的户名须与留存在后台系统的会员户名一致）" }, { "name": "MemberGlobalType", "type": "string", "required": true, "description": "STRING(5)，会员证件类型（详情见“常见问题”）" }, { "name": "MemberGlobalId", "type": "string", "required": true, "description": "STRING(32)，会员证件号码" }, { "name": "MemberAcctNo", "type": "string", "required": true, "description": "STRING(50)，会员的待绑定账户的账号（提现的银行卡）" }, { "name": "BankType", "type": "string", "required": true, "description": "STRING(10)，会员的待绑定账户的本他行类型（1: 本行; 2: 他行）" }, { "name": "AcctOpenBranchName", "type": "string", "required": true, "description": "STRING(150)，会员的待绑定账户的开户行名称" }, { "name": "Mobile", "type": "string", "required": true, "description": "STRING(30)，会员的手机号（手机号须由长度为11位的数字构成）" }, { "name": "CnapsBranchId", "type": "string", "required": false, "description": "STRING(20)，会员的待绑定账户的开户行的联行号（本他行类型为他行的情况下，此字段和下一个字段至少一个不为空）" }, { "name": "EiconBankBranchId", "type": "string", "required": false, "description": "STRING(20)，会员的待绑定账户的开户行的超级网银行号（本他行类型为他行的情况下，此字段和上一个字段至少一个不为空）" }, { "name": "ReservedMsg", "type": "string", "required": false, "description": "STRING(1027)，转账方式（1: 往账鉴权(默认值); 2: 来账鉴权）" }, { "name": "Profile", "type": "string", "required": false, "description": "STRING(12)，接入环境，默认接入沙箱环境。接入正式环境填\"prod\"" } ], "required": [ "MrchCode", "TranNetMemberCode", "MemberName", "MemberGlobalType", "MemberGlobalId", "MemberAcctNo", "BankType", "AcctOpenBranchName", "Mobile" ] }, { "name": "BindRelateAcctUnionPay", "description": "会员绑定提现账户-银联鉴权。用于会员申请绑定提现账户，申请后银行前往银联验证卡信息：姓名、证件、卡号、银行预留手机是否相符，相符则发送给会员手机动态验证码并返回成功，不相符则返回失败。 平台接收到银行返回成功后，进入输入动态验证码的页面，有效期120秒，若120秒未输入，客户可点击重新发送动态验证码，这个步骤重新调用该接口即可。 平安银行的账\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "TranNetMemberCode", "type": "string", "required": true, "description": "STRING(32)，交易网会员代码（若需要把一个待绑定账户关联到两个会员名下，此字段可上送两个会员的交易网代码，并且须用“|::|”（右侧）进行分隔）" }, { "name": "MemberName", "type": "string", "required": true, "description": "STRING(150)，见证子账户的户名（首次绑定的情况下，此字段即为待绑定的提现账户的户名。非首次绑定的情况下，须注意带绑定的提现账户的户名须与留存在后台系统的会员户名一致）" }, { "name": "MemberGlobalType", "type": "string", "required": true, "description": "STRING(5)，会员证件类型（详情见“常见问题”）" }, { "name": "MemberGlobalId", "type": "string", "required": true, "description": "STRING(32)，会员证件号码" }, { "name": "MemberAcctNo", "type": "string", "required": true, "description": "STRING(50)，会员的待绑定账户的账号（提现的银行卡）" }, { "name": "BankType", "type": "string", "required": true, "description": "STRING(10)，会员的待绑定账户的本他行类型（1: 本行; 2: 他行）" }, { "name": "AcctOpenBranchName", "type": "string", "required": true, "description": "STRING(150)，会员的待绑定账户的开户行名称（若大小额行号不填则送超级网银号对应的银行名称，若填大小额行号则送大小额行号对应的银行名称）" }, { "name": "Mobile", "type": "string", "required": true, "description": "STRING(30)，会员的手机号（手机号须由长度为11位的数字构成）" }, { "name": "MrchCode", "type": "string", "required": true, "description": "String(22)，商户号（签约客户号）" }, { "name": "CnapsBranchId", "type": "string", "required": false, "description": "STRING(20)，会员的待绑定账户的开户行的联行号（本他行类型为他行的情况下，此字段和下一个字段至少一个不为空）" }, { "name": "EiconBankBranchId", "type": "string", "required": false, "description": "STRING(20)，会员的待绑定账户的开户行的超级网银行号（本他行类型为他行的情况下，此字段和上一个字段至少一个不为空）" }, { "name": "ReservedMsg", "type": "string", "required": false, "description": "STRING(1027)，保留域" }, { "name": "Profile", "type": "string", "required": false, "description": "STRING(12)，接入环境，默认接入沙箱环境。接入正式环境填\"prod\"" } ], "required": [ "TranNetMemberCode", "MemberName", "MemberGlobalType", "MemberGlobalId", "MemberAcctNo", "BankType", "AcctOpenBranchName", "Mobile", "MrchCode" ] }, { "name": "CheckAcct", "description": "商户绑定提现银行卡的验证接口", "status": "online", "parameters": [ { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的支付主MidasAppId", "example": "your_midas_app_id" }, { "name": "SubAppId", "type": "string", "required": true, "description": "聚鑫计费SubAppId，代表子商户", "example": "your_sub_app_id" }, { "name": "BindType", "type": "integer", "required": true, "description": "1 – 小额转账验证 2 – 短信验证 每个结算账户每天只能使用一次小额转账验证", "example": "1" }, { "name": "SettleAcctNo", "type": "string", "required": true, "description": "结算账户账号 加密详见《商户端接口敏感信息加密说明》", "example": "encrypted_settle_account_no" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "聚鑫分配的安全ID", "example": "your_midas_secret_id" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "按照聚鑫安全密钥计算的签名", "example": "签名" }, { "name": "CheckCode", "type": "string", "required": false, "description": "短信验证码或指令号 BindType==2必填，平安渠道必填", "example": "0000" }, { "name": "CurrencyType", "type": "string", "required": false, "description": "币种 RMB BindType==1必填", "example": "RMB" }, { "name": "CurrencyUnit", "type": "integer", "required": false, "description": "单位 1：元，2：角，3：分 BindType==1必填", "example": "1" }, { "name": "CurrencyAmt", "type": "string", "required": false, "description": "金额 BindType==1必填", "example": "10000" }, { "name": "EncryptType", "type": "string", "required": false, "description": "敏感信息加密类型: RSA: rsa非对称加密，使用RSA-PKCS1-v1_5 AES: aes对称加密，使用AES256-CBC-PCKS7padding 缺省: RSA", "example": "RSA" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名: release: 现网环境 sandbox: 沙箱环境 development: 开发环境 缺省: release", "example": "release" } ], "required": [ "MidasAppId", "SubAppId", "BindType", "SettleAcctNo", "MidasSecretId", "MidasSignature" ] }, { "name": "CheckAmount", "description": "验证鉴权金额。此接口可受理BindRelateAcctSmallAmount接口发起的转账金额（往账鉴权方式）的验证处理。若所回填的验证金额验证通过，则会绑定原申请中的银行账户作为提现账户。通过此接口也可以查得BindRelateAcctSmallAmount接口发起的来账鉴权方式的申请的当前状态。", "status": "online", "parameters": [ { "name": "MrchCode", "type": "string", "required": true, "description": "String(22)，商户号（签约客户号）" }, { "name": "TranNetMemberCode", "type": "string", "required": true, "description": "STRING(32)，交易网会员代码（若需要把一个待绑定账户关联到两个会员名下，此字段可上送两个会员的交易网代码，并且须用“|::|”(右侧)进行分隔）" }, { "name": "TakeCashAcctNo", "type": "string", "required": true, "description": "STRING(50)，会员的待绑定账户的账号（即 BindRelateAcctSmallAmount接口中的“会员的待绑定账户的账号”）" }, { "name": "AuthAmt", "type": "string", "required": true, "description": "STRING(20)，鉴权验证金额（即 BindRelateAcctSmallAmount接口中的“会员的待绑定账户收到的验证金额。原小额转账鉴权方式为来账鉴权的情况下此字段须赋值为0.00）" }, { "name": "Ccy", "type": "string", "required": true, "description": "STRING(3)，币种（默认为RMB）" }, { "name": "ReservedMsg", "type": "string", "required": false, "description": "STRING(1027)，原小额转账方式（1: 往账鉴权，此为默认值; 2: 来账鉴权）" }, { "name": "Profile", "type": "string", "required": false, "description": "STRING(12)，接入环境，默认接入沙箱环境。接入正式环境填\"prod\"" } ], "required": [ "MrchCode", "TranNetMemberCode", "TakeCashAcctNo", "AuthAmt", "Ccy" ] }, { "name": "CloseCloudOrder", "description": "通过此接口关闭此前已创建的订单。关闭后，用户将无法继续付款，仅能关闭创建后未支付的订单。", "status": "online", "parameters": [ { "name": "MidasAppId", "type": "string", "required": true, "description": "米大师分配的支付主MidasAppId", "example": "无" }, { "name": "UserId", "type": "string", "required": true, "description": "用户Id，长度不小于5位，仅支持字母和数字的组合", "example": "无" }, { "name": "OutTradeNo", "type": "string", "required": true, "description": "开发者订单号", "example": "无" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "release" } ], "required": [ "MidasAppId", "UserId", "OutTradeNo" ] }, { "name": "CloseOpenBankPaymentOrder", "description": "云企付-关闭订单", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户ID，云企付平台下发给外部接入平台。", "example": "CM2000232430491" }, { "name": "OutOrderId", "type": "string", "required": false, "description": "外部商户订单号，与ChannelOrderId不能同时为空", "example": "20209324350112001" }, { "name": "ChannelOrderId", "type": "string", "required": false, "description": "云企付平台订单号，与OutOrderId不能同时为空", "example": "202002011200001" }, { "name": "Environment", "type": "string", "required": false, "description": "接入环境。沙箱环境填 sandbox。缺省默认调用生产环境", "example": "沙箱环境sandbox；" } ], "required": [ "ChannelMerchantId" ] }, { "name": "CloseOrder", "description": "通过此接口关闭此前已创建的订单，关闭后，用户将无法继续付款。仅能关闭创建后未支付的订单", "status": "online", "parameters": [ { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的支付主MidasAppId" }, { "name": "UserId", "type": "string", "required": true, "description": "用户ID，长度不小于5位， 仅支持字母和数字的组合" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "聚鑫分配的安全ID" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "按照聚鑫安全密钥计算的签名" }, { "name": "OutTradeNo", "type": "string", "required": false, "description": "业务订单号，OutTradeNo ， TransactionId二选一，不能都为空,优先使用 OutTradeNo" }, { "name": "TransactionId", "type": "string", "required": false, "description": "聚鑫订单号，OutTradeNo ， TransactionId二选一，不能都为空,优先使用 OutTradeNo" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名: release: 现网环境 sandbox: 沙箱环境 development: 开发环境 缺省: release" } ], "required": [ "MidasAppId", "UserId", "MidasSecretId", "MidasSignature" ] }, { "name": "ConfirmOrder", "description": "云鉴-消费订单确认接口", "status": "online", "parameters": [ { "name": "MerchantAppId", "type": "string", "required": true, "description": "分配给商户的AppId", "example": "1c6f41570498301d85fc4589a5435b54" }, { "name": "OrderNo", "type": "string", "required": true, "description": "平台流水号。消费订单发起成功后，返回的平台唯一订单号。", "example": "T094795059988" } ], "required": [ "MerchantAppId", "OrderNo" ] }, { "name": "ContractOrder", "description": "应用需要先带上签约信息调用本接口生成支付订单号，并将应答的PayInfo透传给聚鑫SDK，拉起客户端（包括微信公众号/微信小程序/客户端App）支付。", "status": "online", "parameters": [ { "name": "CurrencyType", "type": "string", "required": true, "description": "ISO 货币代码，CNY", "example": "CNY" }, { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的支付主MidasAppId", "example": "your_midas_app_id" }, { "name": "OutTradeNo", "type": "string", "required": true, "description": "支付订单号，仅支持数字、字母、下划线（_）、横杠字符（-）、点（.）的组合", "example": "your_order_no" }, { "name": "ProductDetail", "type": "string", "required": true, "description": "商品详情，需要URL编码", "example": "商品详情" }, { "name": "ProductId", "type": "string", "required": true, "description": "商品ID，仅支持数字、字母、下划线（_）、横杠字符（-）、点（.）的组合", "example": "your_product_id" }, { "name": "ProductName", "type": "string", "required": true, "description": "商品名称，需要URL编码", "example": "商品名称" }, { "name": "TotalAmt", "type": "integer", "required": true, "description": "支付金额，单位： 分", "example": "1" }, { "name": "UserId", "type": "string", "required": true, "description": "用户ID，长度不小于5位，仅支持字母和数字的组合", "example": "your_user_id" }, { "name": "RealChannel", "type": "string", "required": true, "description": "银行真实渠道.如:bank_pingan", "example": "bank_pingan" }, { "name": "OriginalAmt", "type": "integer", "required": true, "description": "原始金额", "example": "1" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "聚鑫分配的安全ID", "example": "your_midas_secret_id" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "按照聚鑫安全密钥计算的签名", "example": "your_midas_signature" }, { "name": "ContractNotifyUrl", "type": "string", "required": true, "description": "签约通知地址", "example": "http://cloud.tencent.com" }, { "name": "CallbackUrl", "type": "string", "required": false, "description": "Web端回调地址", "example": "http://openmidas.com" }, { "name": "Channel", "type": "string", "required": false, "description": "指定支付渠道： wechat：微信支付 qqwallet：QQ钱包 bank：网银支付 只有一个渠道时需要指定", "example": "wechat" }, { "name": "Metadata", "type": "string", "required": false, "description": "透传字段，支付成功回调透传给应用，用于业务透传自定义内容", "example": "your_metadata" }, { "name": "Quantity", "type": "integer", "required": false, "description": "购买数量，不传默认为1", "example": "1" }, { "name": "SubAppId", "type": "string", "required": false, "description": "聚鑫计费SubAppId，代表子商户", "example": "your_sub_app_id" }, { "name": "SubOrderList", "type": "array", "required": false, "description": "子订单信息列表，格式：子订单号、子应用ID、金额。 压缩后最长不可超过65535字节(去除空格，换行，制表符等无意义字符) 注：接入银行或其他支付渠道服务商模式下，必传", "example": "无", "item_type": "object", "children": [ { "name": "SubMchIncome", "type": "integer", "required": true, "description": "子订单结算应收金额，单位： 分", "example": "1" }, { "name": "PlatformIncome", "type": "integer", "required": true, "description": "子订单平台应收金额，单位：分", "example": "1" }, { "name": "ProductDetail", "type": "string", "required": true, "description": "子订单商品详情", "example": "your_product_detail" }, { "name": "ProductName", "type": "string", "required": true, "description": "子订单商品名称", "example": "your_product_name" }, { "name": "SubAppId", "type": "string", "required": true, "description": "聚鑫计费SubAppId，代表子商户", "example": "unibank10001_01" }, { "name": "SubOutTradeNo", "type": "string", "required": true, "description": "子订单号", "example": "your_sub_out_trade_no" }, { "name": "Amt", "type": "integer", "required": true, "description": "子订单支付金额", "example": "3" }, { "name": "OriginalAmt", "type": "integer", "required": true, "description": "子订单原始金额", "example": "3" }, { "name": "Metadata", "type": "string", "required": false, "description": "发货标识，由业务在调用聚鑫下单接口的 时候下发", "example": "your_metadata" } ] }, { "name": "TotalMchIncome", "type": "integer", "required": false, "description": "结算应收金额，单位：分", "example": "1" }, { "name": "TotalPlatformIncome", "type": "integer", "required": false, "description": "平台应收金额，单位：分", "example": "0" }, { "name": "WxOpenId", "type": "string", "required": false, "description": "微信公众号/小程序支付时为必选，需要传微信下的openid", "example": "your_wx_openid" }, { "name": "WxSubOpenId", "type": "string", "required": false, "description": "在服务商模式下，微信公众号/小程序支付时wx_sub_openid和wx_openid二选一", "example": "your_wx_sub_openid" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名: release: 现网环境 sandbox: 沙箱环境 development: 开发环境 缺省: release", "example": "your_midas_environment" }, { "name": "WxAppId", "type": "string", "required": false, "description": "微信商户应用ID", "example": "your_wx_app_id" }, { "name": "WxSubAppId", "type": "string", "required": false, "description": "微信商户子应用ID", "example": "your_wx_sub_app_id" }, { "name": "PaymentNotifyUrl", "type": "string", "required": false, "description": "支付通知地址", "example": "http://cloud.tencent.com" }, { "name": "ContractSceneId", "type": "string", "required": false, "description": "传入调用方在Midas注册签约信息时获得的ContractSceneId。若未在Midas注册签约信息，则传入ExternalContractData。注意：ContractSceneId与ExternalContractData必须二选一传入其中一个", "example": "your_contract_scene_id" }, { "name": "ExternalContractData", "type": "string", "required": false, "description": "需要按照各个渠道的扩展签约信息规范组装好该字段。若未在Midas注册签约信息，则传入该字段。注意：ContractSceneId与ExternalContractData必须二选一传入其中一个", "example": "{\\\"plan_id\\\":\\\"138096\\\",\\\"contract_code\\\":\\\"your_contract_code\\\"" }, { "name": "OutContractCode", "type": "string", "required": false, "description": "外部签约协议号，唯一标记一个签约关系。仅支持数字、字母、下划线（_）、横杠字符（-）、点（.）的组合", "example": "your_out_contract_code" }, { "name": "AttachData", "type": "string", "required": false, "description": "透传给第三方渠道的附加数据", "example": "your_attach_data" }, { "name": "ContractDisplayName", "type": "string", "required": false, "description": "展示用的签约用户名称，若不传入时，默认取UserId", "example": "your_contract_display_name" } ], "required": [ "CurrencyType", "MidasAppId", "OutTradeNo", "ProductDetail", "ProductId", "ProductName", "TotalAmt", "UserId", "RealChannel", "OriginalAmt", "MidasSecretId", "MidasSignature", "ContractNotifyUrl" ] }, { "name": "CreateAcct", "description": "子商户入驻聚鑫平台", "status": "online", "parameters": [ { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫平台分配的支付MidasAppId", "example": "your_midas_app_id" }, { "name": "SubMchId", "type": "string", "required": true, "description": "业务平台的子商户ID，唯一", "example": "your_sub_mch_id" }, { "name": "SubMchName", "type": "string", "required": true, "description": "子商户名称", "example": "商户名称" }, { "name": "Address", "type": "string", "required": true, "description": "子商户地址", "example": "商户地址" }, { "name": "Contact", "type": "string", "required": true, "description": "子商户联系人 加密详见《商户端接口敏感信息加密说明》", "example": "encrypted_contact_information" }, { "name": "Mobile", "type": "string", "required": true, "description": "联系人手机号 加密详见《商户端接口敏感信息加密说明》", "example": "encrypted_mobile_no" }, { "name": "Email", "type": "string", "required": true, "description": "邮箱 加密详见《商户端接口敏感信息加密说明》", "example": "encrypted_email" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "聚鑫分配的安全ID", "example": "your_midas_secret_id" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "按照聚鑫安全密钥计算的签名", "example": "your_midas_signature" }, { "name": "SubMchType", "type": "string", "required": false, "description": "子商户类型： 个人: personal 企业: enterprise 个体工商户: individual 缺省: enterprise", "example": "enterprise" }, { "name": "ShortName", "type": "string", "required": false, "description": "不填则默认子商户名称", "example": "商户简称" }, { "name": "SubMerchantMemberType", "type": "string", "required": false, "description": "子商户会员类型： general: 普通子账户 merchant: 商户子账户 缺省: general", "example": "general" }, { "name": "SubMerchantKey", "type": "string", "required": false, "description": "子商户密钥 加密详见《商户端接口敏感信息加密说明》", "example": "密钥" }, { "name": "SubMerchantPrivateKey", "type": "string", "required": false, "description": "子商户私钥 加密详见《商户端接口敏感信息加密说明》", "example": "私钥" }, { "name": "EncryptType", "type": "string", "required": false, "description": "敏感信息加密类型: RSA: rsa非对称加密，使用RSA-PKCS1-v1_5 AES: aes对称加密，使用AES256-CBC-PCKS7padding 缺省: RSA", "example": "RSA" }, { "name": "SubAcctNo", "type": "string", "required": false, "description": "银行生成的子商户账户，已开户的场景需要录入", "example": "1234567890" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名: release: 现网环境 sandbox: 沙箱环境 development: 开发环境 缺省: release", "example": "release" }, { "name": "SubMerchantStoreName", "type": "string", "required": false, "description": "店铺名称 企业、个体工商户必输", "example": "示例店铺" }, { "name": "OrganizationInfo", "type": "object", "required": false, "description": "公司信息", "example": "无", "children": [ { "name": "OrganizationName", "type": "string", "required": false, "description": "公司名称，个体工商户必输", "example": "公司" }, { "name": "OrganizationType", "type": "string", "required": false, "description": "公司证件类型，个体工商户必输，证件类型仅支持73", "example": "73" }, { "name": "OrganizationCode", "type": "string", "required": false, "description": "公司证件号码，个体工商户必输", "example": "1234567890" }, { "name": "LegalPersonName", "type": "string", "required": false, "description": "法人名称，如果SubMchName不是法人，需要另外送入法人信息（企业必输） 加密详见《商户端接口敏感信息加密说明》", "example": "张三" }, { "name": "LegalPersonIdType", "type": "string", "required": false, "description": "法人证件类型，如果SubMchName不是法人，需要另外送入法人信息（企业必输）", "example": "1" }, { "name": "LegalPersonIdCode", "type": "string", "required": false, "description": "法人证件号码，如果SubMchName不是法人，需要另外送入法人信息（企业必输） 加密详见《商户端接口敏感信息加密说明》", "example": "1234567890" } ] }, { "name": "SubMerchantIdType", "type": "string", "required": false, "description": "子商户证件类型 1 - 身份证 3 - 回乡证 4 - 中国护照 5 - 台胞证 19 - 外国护照 52 - 组织机构代码证 68 - 营业执照 73 - 统一社会信用代码", "example": "无" }, { "name": "SubMerchantIdCode", "type": "string", "required": false, "description": "子商户证件号码 加密详见《商户端接口敏感信息加密说明》", "example": "无" } ], "required": [ "MidasAppId", "SubMchId", "SubMchName", "Address", "Contact", "Mobile", "Email", "MidasSecretId", "MidasSignature" ] }, { "name": "CreateAgentTaxPaymentInfos", "description": "直播平台-代理商完税信息录入", "status": "online", "parameters": [ { "name": "AgentId", "type": "string", "required": true, "description": "代理商ID", "example": "test" }, { "name": "Channel", "type": "integer", "required": true, "description": "平台渠道", "example": "1" }, { "name": "Type", "type": "integer", "required": true, "description": "类型。0-视同，1-个体工商户", "example": "0" }, { "name": "RawElectronicCertUrl", "type": "string", "required": true, "description": "源电子凭证下载地址", "example": "https://cloud.tencent.com/document/product/1122/40638" }, { "name": "FileName", "type": "string", "required": true, "description": "文件名", "example": "paxos.pdf" }, { "name": "AgentTaxPaymentInfos", "type": "array", "required": true, "description": "完税信息", "example": "无", "item_type": "object", "children": [ { "name": "AnchorId", "type": "string", "required": true, "description": "主播银行账号" }, { "name": "AnchorName", "type": "string", "required": true, "description": "主播姓名" }, { "name": "AnchorIDCard", "type": "string", "required": true, "description": "主播身份证" }, { "name": "StartTime", "type": "string", "required": true, "description": "纳税的开始时间，格式yyyy-MM-dd" }, { "name": "EndTime", "type": "string", "required": true, "description": "纳税的结束时间，格式yyyy-MM-dd" }, { "name": "Amount", "type": "integer", "required": true, "description": "流水金额。以“分”为单位" }, { "name": "Tax", "type": "integer", "required": true, "description": "应缴税款。以“分”为单位" } ] }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填sandbox", "example": "sandbox" } ], "required": [ "AgentId", "Channel", "Type", "RawElectronicCertUrl", "FileName", "AgentTaxPaymentInfos" ] }, { "name": "CreateAnchor", "description": "直播平台-主播入驻", "status": "online", "parameters": [ { "name": "AnchorUid", "type": "string", "required": true, "description": "主播业务ID，唯一", "example": "无" }, { "name": "AnchorName", "type": "string", "required": true, "description": "主播姓名", "example": "无" }, { "name": "AnchorPhone", "type": "string", "required": true, "description": "主播电话 _敏感信息_ 使用 __AES128-CBC-PKCS#7__ 加密", "example": "无" }, { "name": "AnchorEmail", "type": "string", "required": true, "description": "主播邮箱 _敏感信息_ 使用 __AES128-CBC-PKCS#7__ 加密", "example": "无" }, { "name": "AnchorAddress", "type": "string", "required": true, "description": "主播地址 _敏感信息_ 使用 __AES128-CBC-PKCS#7__ 加密", "example": "无" }, { "name": "AnchorIdNo", "type": "string", "required": true, "description": "主播身份证号 _敏感信息_ 使用 __AES128-CBC-PKCS#7__ 加密", "example": "无" }, { "name": "AnchorType", "type": "string", "required": true, "description": "主播类型 __KMusic__:全民K歌 __QMusic__:QQ音乐 __WeChat__:微信视频号", "example": "WeChat" }, { "name": "AnchorExtendInfo", "type": "array", "required": false, "description": "主播扩展信息", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "扩展信息类型 __id_card_no__:身份证号码 __id_card_name__:身份证姓名 __id_card_front__:身份证图片正面 __id_card_back__:身份证图片反面 __tax_type__:完税类型:0-自然人,1-个体工商户 __channel_account__:渠道账号(_敏感信息_ 使用 __AES128-CBC-PKCS#7__ 加密)", "example": "id_card_front" }, { "name": "Value", "type": "string", "required": true, "description": "扩展信息", "example": "file.png" } ] } ], "required": [ "AnchorUid", "AnchorName", "AnchorPhone", "AnchorEmail", "AnchorAddress", "AnchorIdNo", "AnchorType" ] }, { "name": "CreateBatchPayment", "description": "灵云-批量主播转账接口", "status": "online", "parameters": [ { "name": "TransferType", "type": "integer", "required": true, "description": "1 微信企业付款 2 支付宝转账 3 平安银企直连代发转账", "example": "无" }, { "name": "RecipientList", "type": "array", "required": true, "description": "转账详情", "example": "无", "item_type": "object", "children": [ { "name": "TransferAmount", "type": "integer", "required": true, "description": "转账金额", "example": "无" }, { "name": "OrderId", "type": "string", "required": true, "description": "订单号", "example": "无" }, { "name": "AnchorId", "type": "string", "required": false, "description": "主播ID（与主播业务ID不能同时为空，两者都填取主播ID）", "example": "无" }, { "name": "Uid", "type": "string", "required": false, "description": "主播业务ID（与主播业务ID不能同时为空，两者都填取主播ID）", "example": "无" }, { "name": "AnchorName", "type": "string", "required": false, "description": "主播名称。如果该字段填入，则会对AnchorName和AnchorId/Uid进行校验。", "example": "无" }, { "name": "Remark", "type": "string", "required": false, "description": "业务备注", "example": "无" }, { "name": "ReqReserved", "type": "string", "required": false, "description": "子单请求预留字段", "example": "无" } ] }, { "name": "ReqReserved", "type": "string", "required": false, "description": "请求预留字段", "example": "无" }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "回调Url", "example": "无" } ], "required": [ "TransferType", "RecipientList" ] }, { "name": "CreateCloudSubMerchant", "description": "创建子商户", "status": "online", "parameters": [ { "name": "MidasAppId", "type": "string", "required": true, "description": "米大师分配的支付主MidasAppId，根应用Id。", "example": "无" }, { "name": "ParentAppId", "type": "string", "required": true, "description": "父应用Id。", "example": "无" }, { "name": "SubMchName", "type": "string", "required": true, "description": "子商户名。", "example": "无" }, { "name": "SubMchDescription", "type": "string", "required": true, "description": "子商户描述。", "example": "无" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "release" }, { "name": "SubAppId", "type": "string", "required": false, "description": "子应用Id，为空则自动创建子应用id。", "example": "无" }, { "name": "SubMchShortName", "type": "string", "required": false, "description": "子商户名缩写。", "example": "无" }, { "name": "OutSubMerchantId", "type": "string", "required": false, "description": "业务平台自定义的子商户Id，唯一。", "example": "无" } ], "required": [ "MidasAppId", "ParentAppId", "SubMchName", "SubMchDescription" ] }, { "name": "CreateCustAcctId", "description": "会员子账户开立。会员在银行注册，并开立会员子账户，交易网会员代码即会员在平台端系统的会员编号。 平台需保存银行返回的子账户账号，后续交易接口都会用到。会员属性字段为预留扩展字段，当前必须送默认值。", "status": "online", "parameters": [ { "name": "FunctionFlag", "type": "string", "required": true, "description": "STRING(2)，功能标志（1: 开户; 3: 销户）" }, { "name": "FundSummaryAcctNo", "type": "string", "required": true, "description": "STRING(50)，资金汇总账号（即收单资金归集入账的账号）" }, { "name": "TranNetMemberCode", "type": "string", "required": true, "description": "STRING(32)，交易网会员代码（平台端的用户ID，需要保证唯一性，可数字字母混合，如HY_120）" }, { "name": "MemberProperty", "type": "string", "required": true, "description": "STRING(10)，会员属性（00-普通子账户(默认); SH-商户子账户）" }, { "name": "Mobile", "type": "string", "required": true, "description": "STRING(30)，手机号码" }, { "name": "MrchCode", "type": "string", "required": true, "description": "String(22)，商户号（签约客户号）" }, { "name": "SelfBusiness", "type": "boolean", "required": true, "description": "String(2)，是否为自营业务（0位非自营，1为自营）" }, { "name": "ContactName", "type": "string", "required": true, "description": "String(64)，联系人" }, { "name": "SubAcctName", "type": "string", "required": true, "description": "String(64)，子账户名称" }, { "name": "SubAcctShortName", "type": "string", "required": true, "description": "String(64)，子账户简称" }, { "name": "SubAcctType", "type": "integer", "required": true, "description": "String(4)，子账户类型（0: 个人子账户; 1: 企业子账户）" }, { "name": "UserNickname", "type": "string", "required": false, "description": "STRING(150)，用户昵称" }, { "name": "Email", "type": "string", "required": false, "description": "STRING(150)，邮箱" }, { "name": "ReservedMsg", "type": "string", "required": false, "description": "STRING(1027)，保留域" }, { "name": "Profile", "type": "string", "required": false, "description": "STRING(12)，接入环境，默认接入沙箱环境。接入正式环境填\"prod\"" } ], "required": [ "FunctionFlag", "FundSummaryAcctNo", "TranNetMemberCode", "MemberProperty", "Mobile", "MrchCode", "SelfBusiness", "ContactName", "SubAcctName", "SubAcctShortName", "SubAcctType" ] }, { "name": "CreateExternalAnchor", "description": "灵云-主播入驻", "status": "online", "parameters": [ { "name": "Uid", "type": "string", "required": true, "description": "平台业务系统唯一标示的主播id", "example": "无" }, { "name": "Name", "type": "string", "required": true, "description": "主播名称", "example": "无" }, { "name": "IdNo", "type": "string", "required": true, "description": "身份证号", "example": "无" }, { "name": "IdCardFront", "type": "string", "required": false, "description": "身份证正面图片下载链接", "example": "无" }, { "name": "IdCardReverse", "type": "string", "required": false, "description": "身份证反面图片下载链接", "example": "无" }, { "name": "AgentId", "type": "string", "required": false, "description": "指定分配的代理商ID", "example": "无" } ], "required": [ "Uid", "Name", "IdNo" ] }, { "name": "CreateFlexPayee", "description": "灵云V2-收款用户开立", "status": "online", "parameters": [ { "name": "OutUserId", "type": "string", "required": true, "description": "用户外部业务ID", "example": "无" }, { "name": "Name", "type": "string", "required": true, "description": "姓名", "example": "无" }, { "name": "IdNo", "type": "string", "required": true, "description": "证件号", "example": "无" }, { "name": "AccountName", "type": "string", "required": true, "description": "账户名称", "example": "无" }, { "name": "ServiceProviderId", "type": "string", "required": true, "description": "服务商ID", "example": "无" }, { "name": "TaxInfo", "type": "object", "required": true, "description": "计税信息", "example": "无", "children": [ { "name": "TaxTemplateInfoList", "type": "array", "required": true, "description": "计税模板列表", "example": "无", "item_type": "object", "children": [ { "name": "IncomeType", "type": "string", "required": true, "description": "收入类型 LABOR: 劳务所得 OCCASION: 偶然所得", "example": "无" }, { "name": "TaxTemplateId", "type": "string", "required": true, "description": "计税模板ID", "example": "无" } ] }, { "name": "TaxpayerIdNo", "type": "string", "required": true, "description": "纳税人识别号", "example": "无" }, { "name": "TaxEntityType", "type": "string", "required": true, "description": "纳税主体类型 NATURAL:自然人 NON_NATURAL:非自然人", "example": "无" }, { "name": "TaxServiceProviderId", "type": "string", "required": true, "description": "财税服务商ID", "example": "无" } ] }, { "name": "IdType", "type": "integer", "required": true, "description": "证件类型 0:身份证 1:社会信用代码", "example": "无" }, { "name": "Remark", "type": "string", "required": false, "description": "备注", "example": "无" }, { "name": "PhoneNo", "type": "string", "required": false, "description": "手机号码", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 __test__:测试环境 缺省默认为生产环境", "example": "无" } ], "required": [ "OutUserId", "Name", "IdNo", "AccountName", "ServiceProviderId", "TaxInfo", "IdType" ] }, { "name": "CreateInvoice", "description": "智慧零售-发票开具", "status": "online", "parameters": [ { "name": "InvoicePlatformId", "type": "integer", "required": true, "description": "开票平台ID。0：高灯，1：票易通", "example": "1" }, { "name": "TitleType", "type": "integer", "required": true, "description": "抬头类型：1：个人/政府事业单位；2：企业", "example": "1" }, { "name": "BuyerTitle", "type": "string", "required": true, "description": "购方名称", "example": "购方名称" }, { "name": "OrderId", "type": "string", "required": true, "description": "业务开票号", "example": "test12345678" }, { "name": "AmountHasTax", "type": "integer", "required": true, "description": "含税总金额（单位为分）", "example": "1" }, { "name": "TaxAmount", "type": "integer", "required": true, "description": "总税额（单位为分）", "example": "1" }, { "name": "AmountWithoutTax", "type": "integer", "required": true, "description": "不含税总金额（单位为分）。InvoicePlatformId 为1时，传默认值-1", "example": "1" }, { "name": "SellerTaxpayerNum", "type": "string", "required": true, "description": "销方纳税人识别号", "example": "1234567890" }, { "name": "SellerName", "type": "string", "required": false, "description": "销方名称。（不填默认读取商户注册时输入的信息）", "example": "NULL" }, { "name": "SellerAddress", "type": "string", "required": false, "description": "销方地址。（不填默认读取商户注册时输入的信息）", "example": "NULL" }, { "name": "SellerPhone", "type": "string", "required": false, "description": "销方电话。（不填默认读取商户注册时输入的信息）", "example": "NULL" }, { "name": "SellerBankName", "type": "string", "required": false, "description": "销方银行名称。（不填默认读取商户注册时输入的信息）", "example": "NULL" }, { "name": "SellerBankAccount", "type": "string", "required": false, "description": "销方银行账号。（不填默认读取商户注册时输入的信息）", "example": "NULL" }, { "name": "BuyerTaxpayerNum", "type": "string", "required": false, "description": "购方纳税人识别号（购方票面信息）,若抬头类型为2时，必传", "example": "NULL" }, { "name": "BuyerAddress", "type": "string", "required": false, "description": "购方地址。开具专用发票时必填", "example": "NULL" }, { "name": "BuyerBankName", "type": "string", "required": false, "description": "购方银行名称。开具专用发票时必填", "example": "NULL" }, { "name": "BuyerBankAccount", "type": "string", "required": false, "description": "购方银行账号。开具专用发票时必填", "example": "NULL" }, { "name": "BuyerPhone", "type": "string", "required": false, "description": "购方电话。开具专用发票时必填", "example": "NULL" }, { "name": "BuyerEmail", "type": "string", "required": false, "description": "收票人邮箱。若填入，会收到发票推送邮件", "example": "NULL" }, { "name": "TakerPhone", "type": "string", "required": false, "description": "收票人手机号。若填入，会收到发票推送短信", "example": "NULL" }, { "name": "InvoiceType", "type": "integer", "required": false, "description": "开票类型： 1：增值税专用发票； 2：增值税普通发票； 3：增值税电子发票； 4：增值税卷式发票； 5：区块链电子发票。 若该字段不填，或值不为1-5，则认为开具”增值税电子发票”", "example": "NULL" }, { "name": "CallbackUrl", "type": "string", "required": false, "description": "发票结果回传地址", "example": "NULL" }, { "name": "Drawer", "type": "string", "required": false, "description": "开票人姓名。（不填默认读取商户注册时输入的信息）", "example": "NULL" }, { "name": "Payee", "type": "string", "required": false, "description": "收款人姓名。（不填默认读取商户注册时输入的信息）", "example": "NULL" }, { "name": "Checker", "type": "string", "required": false, "description": "复核人姓名。（不填默认读取商户注册时输入的信息）", "example": "NULL" }, { "name": "TerminalCode", "type": "string", "required": false, "description": "税盘号", "example": "NULL" }, { "name": "LevyMethod", "type": "string", "required": false, "description": "征收方式。开具差额征税发票时必填2。开具普通征税发票时为空", "example": "NULL" }, { "name": "Deduction", "type": "integer", "required": false, "description": "差额征税扣除额（单位为分）", "example": "NULL" }, { "name": "Remark", "type": "string", "required": false, "description": "备注（票面信息）", "example": "NULL" }, { "name": "Items", "type": "array", "required": false, "description": "项目商品明细", "example": "NULL", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "商品名称" }, { "name": "TaxCode", "type": "string", "required": true, "description": "税收商品编码" }, { "name": "TotalPrice", "type": "integer", "required": true, "description": "不含税商品总价（商品含税价总额/（1+税率））。InvoicePlatformId 为1时，该金额为含税总金额。单位为分。" }, { "name": "TaxRate", "type": "integer", "required": true, "description": "商品税率" }, { "name": "TaxAmount", "type": "integer", "required": true, "description": "商品税额（不含税商品总价*税率）。单位为分" }, { "name": "TaxType", "type": "string", "required": false, "description": "税收商品类别" }, { "name": "Models", "type": "string", "required": false, "description": "商品规格" }, { "name": "Unit", "type": "string", "required": false, "description": "商品单位" }, { "name": "Total", "type": "string", "required": false, "description": "商品数量" }, { "name": "Price", "type": "string", "required": false, "description": "不含税商品单价。InvoicePlatformId 为1时，该金额为含税单价。" }, { "name": "Discount", "type": "integer", "required": false, "description": "含税折扣总额。单位为分" }, { "name": "PreferentialPolicyFlag", "type": "string", "required": false, "description": "优惠政策标志。0：不使用优惠政策；1：使用优惠政策。" }, { "name": "ZeroTaxFlag", "type": "string", "required": false, "description": "零税率标识： 空：非零税率； 0：出口零税率； 1：免税； 2：不征税； 3：普通零税率。" }, { "name": "VatSpecialManagement", "type": "string", "required": false, "description": "增值税特殊管理。PreferentialPolicyFlag字段为1时，必填。目前仅支持5%(3%，2%，1.5%)简易征税、免税、不征税。" } ] }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填sandbox。", "example": "NULL" }, { "name": "UndoPart", "type": "integer", "required": false, "description": "撤销部分商品。0-不撤销，1-撤销", "example": "NULL" }, { "name": "OrderDate", "type": "string", "required": false, "description": "订单下单时间（格式 YYYYMMDD）", "example": "NULL" }, { "name": "Discount", "type": "integer", "required": false, "description": "订单级别折扣（单位为分）", "example": "NULL" }, { "name": "StoreNo", "type": "string", "required": false, "description": "门店编码", "example": "NULL" }, { "name": "InvoiceChannel", "type": "integer", "required": false, "description": "开票渠道。0：APP渠道，1：线下渠道，2：小程序渠道。不填默认为APP渠道", "example": "NULL" } ], "required": [ "InvoicePlatformId", "TitleType", "BuyerTitle", "OrderId", "AmountHasTax", "TaxAmount", "AmountWithoutTax", "SellerTaxpayerNum" ] }, { "name": "CreateInvoiceV2", "description": "智慧零售-发票开具V2", "status": "online", "parameters": [ { "name": "InvoicePlatformId", "type": "integer", "required": true, "description": "开票平台ID。0：高灯，1：票易通", "example": "1" }, { "name": "TitleType", "type": "integer", "required": true, "description": "抬头类型：1：个人/政府事业单位；2：企业", "example": "1" }, { "name": "BuyerTitle", "type": "string", "required": true, "description": "购方名称", "example": "购方名称" }, { "name": "OrderId", "type": "string", "required": true, "description": "业务开票号", "example": "test12345678" }, { "name": "AmountHasTax", "type": "integer", "required": true, "description": "含税总金额（单位为分）", "example": "1" }, { "name": "TaxAmount", "type": "integer", "required": true, "description": "总税额（单位为分）", "example": "1" }, { "name": "AmountWithoutTax", "type": "integer", "required": true, "description": "不含税总金额（单位为分）。InvoicePlatformId 为1时，传默认值-1", "example": "1" }, { "name": "SellerTaxpayerNum", "type": "string", "required": true, "description": "销方纳税人识别号", "example": "1234567890" }, { "name": "SellerName", "type": "string", "required": false, "description": "销方名称。（不填默认读取商户注册时输入的信息）", "example": "NULL" }, { "name": "SellerAddress", "type": "string", "required": false, "description": "销方地址。（不填默认读取商户注册时输入的信息）", "example": "NULL" }, { "name": "SellerPhone", "type": "string", "required": false, "description": "销方电话。（不填默认读取商户注册时输入的信息）", "example": "NULL" }, { "name": "SellerBankName", "type": "string", "required": false, "description": "销方银行名称。（不填默认读取商户注册时输入的信息）", "example": "NULL" }, { "name": "SellerBankAccount", "type": "string", "required": false, "description": "销方银行账号。（不填默认读取商户注册时输入的信息）", "example": "NULL" }, { "name": "BuyerTaxpayerNum", "type": "string", "required": false, "description": "购方纳税人识别号（购方票面信息）,若抬头类型为2时，必传", "example": "NULL" }, { "name": "BuyerAddress", "type": "string", "required": false, "description": "购方地址。开具专用发票时必填", "example": "NULL" }, { "name": "BuyerBankName", "type": "string", "required": false, "description": "购方银行名称。开具专用发票时必填", "example": "NULL" }, { "name": "BuyerBankAccount", "type": "string", "required": false, "description": "购方银行账号。开具专用发票时必填", "example": "NULL" }, { "name": "BuyerPhone", "type": "string", "required": false, "description": "购方电话。开具专用发票时必填", "example": "NULL" }, { "name": "BuyerEmail", "type": "string", "required": false, "description": "收票人邮箱。若填入，会收到发票推送邮件", "example": "NULL" }, { "name": "TakerPhone", "type": "string", "required": false, "description": "收票人手机号。若填入，会收到发票推送短信", "example": "NULL" }, { "name": "InvoiceType", "type": "integer", "required": false, "description": "开票类型： 1：增值税专用发票； 2：增值税普通发票； 3：增值税电子发票； 4：增值税卷式发票； 5：区块链电子发票。 若该字段不填，或值不为1-5，则认为开具”增值税电子发票”", "example": "NULL" }, { "name": "CallbackUrl", "type": "string", "required": false, "description": "发票结果回传地址", "example": "NULL" }, { "name": "Drawer", "type": "string", "required": false, "description": "开票人姓名。（不填默认读取商户注册时输入的信息）", "example": "NULL" }, { "name": "Payee", "type": "string", "required": false, "description": "收款人姓名。（不填默认读取商户注册时输入的信息）", "example": "NULL" }, { "name": "Checker", "type": "string", "required": false, "description": "复核人姓名。（不填默认读取商户注册时输入的信息）", "example": "NULL" }, { "name": "TerminalCode", "type": "string", "required": false, "description": "税盘号", "example": "NULL" }, { "name": "LevyMethod", "type": "string", "required": false, "description": "征收方式。开具差额征税发票时必填2。开具普通征税发票时为空", "example": "NULL" }, { "name": "Deduction", "type": "integer", "required": false, "description": "差额征税扣除额（单位为分）", "example": "NULL" }, { "name": "Remark", "type": "string", "required": false, "description": "备注（票面信息）", "example": "NULL" }, { "name": "Items", "type": "array", "required": false, "description": "项目商品明细", "example": "NULL", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "商品名称" }, { "name": "TaxCode", "type": "string", "required": true, "description": "税收商品编码" }, { "name": "TotalPrice", "type": "integer", "required": true, "description": "不含税商品总价（商品含税价总额/（1+税率））。InvoicePlatformId 为1时，该金额为含税总金额。单位为分。" }, { "name": "TaxRate", "type": "integer", "required": true, "description": "商品税率" }, { "name": "TaxAmount", "type": "integer", "required": true, "description": "商品税额（不含税商品总价*税率）。单位为分" }, { "name": "TaxType", "type": "string", "required": false, "description": "税收商品类别" }, { "name": "Models", "type": "string", "required": false, "description": "商品规格" }, { "name": "Unit", "type": "string", "required": false, "description": "商品单位" }, { "name": "Total", "type": "string", "required": false, "description": "商品数量" }, { "name": "Price", "type": "string", "required": false, "description": "不含税商品单价。InvoicePlatformId 为1时，该金额为含税单价。" }, { "name": "Discount", "type": "integer", "required": false, "description": "含税折扣总额。单位为分" }, { "name": "PreferentialPolicyFlag", "type": "string", "required": false, "description": "优惠政策标志。0：不使用优惠政策；1：使用优惠政策。" }, { "name": "ZeroTaxFlag", "type": "string", "required": false, "description": "零税率标识： 空：非零税率； 0：出口零税率； 1：免税； 2：不征税； 3：普通零税率。" }, { "name": "VatSpecialManagement", "type": "string", "required": false, "description": "增值税特殊管理。PreferentialPolicyFlag字段为1时，必填。目前仅支持5%(3%，2%，1.5%)简易征税、免税、不征税。" } ] }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填sandbox。", "example": "NULL" }, { "name": "UndoPart", "type": "integer", "required": false, "description": "撤销部分商品。0-不撤销，1-撤销", "example": "NULL" }, { "name": "OrderDate", "type": "string", "required": false, "description": "订单下单时间（格式 YYYYMMDD）", "example": "NULL" }, { "name": "Discount", "type": "integer", "required": false, "description": "订单级别折扣（单位为分）", "example": "NULL" }, { "name": "StoreNo", "type": "string", "required": false, "description": "门店编码", "example": "NULL" }, { "name": "InvoiceChannel", "type": "integer", "required": false, "description": "开票渠道。0：APP渠道，1：线下渠道，2：小程序渠道。不填默认为APP渠道", "example": "NULL" } ], "required": [ "InvoicePlatformId", "TitleType", "BuyerTitle", "OrderId", "AmountHasTax", "TaxAmount", "AmountWithoutTax", "SellerTaxpayerNum" ] }, { "name": "CreateMerchant", "description": "智慧零售-商户注册", "status": "online", "parameters": [ { "name": "InvoicePlatformId", "type": "integer", "required": true, "description": "开票平台ID", "example": "0" }, { "name": "TaxpayerName", "type": "string", "required": true, "description": "企业名称", "example": "测试名称" }, { "name": "TaxpayerNum", "type": "string", "required": true, "description": "销方纳税人识别号", "example": "111212222233338" }, { "name": "LegalPersonName", "type": "string", "required": true, "description": "注册企业法定代表人名称", "example": "测试名称" }, { "name": "ContactsName", "type": "string", "required": true, "description": "联系人", "example": "联系人" }, { "name": "Phone", "type": "string", "required": true, "description": "联系人手机号", "example": "11111111111" }, { "name": "Address", "type": "string", "required": true, "description": "不包含省市名称的地址", "example": "地址" }, { "name": "RegionCode", "type": "integer", "required": true, "description": "地区编码", "example": "44" }, { "name": "CityName", "type": "string", "required": true, "description": "市（地区）名称", "example": "深圳市" }, { "name": "Drawer", "type": "string", "required": true, "description": "开票人", "example": "drawer" }, { "name": "TaxRegistrationCertificate", "type": "string", "required": true, "description": "税务登记证图片（Base64）字符串，需小于 3M", "example": "TEST" }, { "name": "Email", "type": "string", "required": false, "description": "联系人邮箱地址", "example": "test@email.com" }, { "name": "BusinessMobile", "type": "string", "required": false, "description": "企业电话", "example": "123456" }, { "name": "BankName", "type": "string", "required": false, "description": "银行名称", "example": "银行名称" }, { "name": "BankAccount", "type": "string", "required": false, "description": "银行账号", "example": "621281240305123200" }, { "name": "Reviewer", "type": "string", "required": false, "description": "复核人", "example": "reviewer" }, { "name": "Payee", "type": "string", "required": false, "description": "收款人", "example": "payee" }, { "name": "RegisterCode", "type": "string", "required": false, "description": "注册邀请码", "example": "1010" }, { "name": "State", "type": "string", "required": false, "description": "不填默认为1，有效状态 0：表示无效； 1:表示有效； 2:表示禁止开蓝票； 3:表示禁止冲红。", "example": "1" }, { "name": "CallbackUrl", "type": "string", "required": false, "description": "接收推送的消息地址", "example": "http://test.html" }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填 sandbox。", "example": "sandbox" } ], "required": [ "InvoicePlatformId", "TaxpayerName", "TaxpayerNum", "LegalPersonName", "ContactsName", "Phone", "Address", "RegionCode", "CityName", "Drawer", "TaxRegistrationCertificate" ] }, { "name": "CreateOpenBankAggregatedSubMerchantRegistration", "description": "云企付-子商户进件V2", "status": "online", "parameters": [ { "name": "OutRegistrationNo", "type": "string", "required": true, "description": "外部进件序列号。", "example": "outNo9747817" }, { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户ID。", "example": "CM6147741696" }, { "name": "OutSubMerchantId", "type": "string", "required": true, "description": "外部子商户ID。", "example": "E1806456666" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称。详见附录-云企付枚举类说明-ChannelName。 TENPAY: 商企付 WECHAT: 微信支付 ALIPAY: 支付宝 HELIPAY:合利宝", "example": "TENPAY" }, { "name": "OutSubMerchantType", "type": "string", "required": true, "description": "外部子商户类型。 ENTERPRISE：企业商户 INSTITUTION：事业单位商户 INDIVIDUALBISS：个体工商户 PERSON：个人商户(小微商户) SUBJECT_TYPE_OTHERS：其他组织", "example": "ENTERPRISE" }, { "name": "OutSubMerchantName", "type": "string", "required": true, "description": "外部子商户名称。 HELIPAY渠道(长度不能小于5大于150)。", "example": "子商户01" }, { "name": "LegalPersonInfo", "type": "object", "required": true, "description": "商户法人代表信息。", "example": "无", "children": [ { "name": "IdType", "type": "string", "required": true, "description": "证件类型 IDCARD：身份证 PASSPORT：护照 SOLDIERSCERTIFICATE：士兵证 OFFICERSCERTIFICATE：军官证 GATXCERTIFICATE：香港居民来往内地通行证 TWNDCERTIFICATE：台湾同胞来往内地通行证 MACAOCERTIFICATE：澳门来往内地通行证", "example": "IDCARD" }, { "name": "IdNumber", "type": "string", "required": true, "description": "证件号码", "example": "440****99201010171" }, { "name": "PersonName", "type": "string", "required": true, "description": "姓名", "example": "张三" }, { "name": "IdValidityType", "type": "string", "required": true, "description": "证件有效期类型 LONGTERM：长期有效 OTHER：非长期有效", "example": "LONGTERM" }, { "name": "IdEffectiveDate", "type": "string", "required": true, "description": "证件生效日期，yyyy-MM-dd", "example": "2010-09-01" }, { "name": "ContactPhone", "type": "string", "required": true, "description": "联系电话", "example": "157****5574" }, { "name": "IdExpireDate", "type": "string", "required": false, "description": "证件失效日期，yyyy-MM-dd", "example": "2030-09-01" }, { "name": "ContactAddress", "type": "string", "required": false, "description": "联系地址", "example": "联系地址***" }, { "name": "EmailAddress", "type": "string", "required": false, "description": "邮箱地址", "example": "test@tencent.com" } ] }, { "name": "BusinessLicenseInfo", "type": "object", "required": true, "description": "营业证件信息。", "example": "无", "children": [ { "name": "BusinessLicenseType", "type": "string", "required": true, "description": "营业证件类型 IDCARD：身份证 CREDITCODE：统一社会信用代码", "example": " IDCARD" }, { "name": "BusinessLicenseNumber", "type": "string", "required": true, "description": "营业证件号码 非个人商户上送统一社会信用代码，个人商户上送身份证号码", "example": "B06938889642830696" }, { "name": "BusinessLicenseValidityType", "type": "string", "required": true, "description": "营业证件有效期类型 LONGTERM：长期有效 OTHER：非长期有效", "example": "LONGTERM" }, { "name": "BusinessLicenseEffectiveDate", "type": "string", "required": true, "description": "营业证件生效日期，yyyy-MM-dd", "example": "2021-09-01" }, { "name": "BusinessLicenseExpireDate", "type": "string", "required": false, "description": "营业证件失效日期，yyyy-MM-dd", "example": "2031-09-01" } ] }, { "name": "InterConnectionSubMerchantData", "type": "string", "required": true, "description": "支付渠道子商户进件信息。 json字符串，详情见附录-复杂类型-InterConnectionSubMerchantData。", "example": "无" }, { "name": "PaymentMethod", "type": "string", "required": false, "description": "支付方式。详见附录-云企付枚举类说明-PaymentMethod。 合利宝渠道不需要传。", "example": "UNIFIED_PAYMENT" }, { "name": "OutSubMerchantShortName", "type": "string", "required": false, "description": "外部子商户简称。 HELIPAY渠道必传(长度不能小于2大于20)。", "example": "子商户简称01" }, { "name": "OutSubMerchantDescription", "type": "string", "required": false, "description": "外部子商户描述。", "example": "子商户描述01" }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "通知地址。", "example": "http://www.merchant.com" }, { "name": "NaturalPersonList", "type": "array", "required": false, "description": "相关自然人信息列表。 HELIPAY渠道必传业务联系人。", "example": "无", "item_type": "object", "children": [ { "name": "PersonType", "type": "string", "required": true, "description": "自然人类型 2：商户负责人 3：授权经办人 4：业务联系人 5：实际控制人 6：控股股东 7：受益人 8：结算人 注意：HELIPAY渠道必传业务联系人", "example": "2" }, { "name": "IdType", "type": "string", "required": true, "description": "证件类型 IDCARD：身份证 PASSPORT：护照 SOLDIERSCERTIFICATE：士兵证 OFFICERSCERTIFICATE：军官证 GATXCERTIFICATE：香港居民来往内地通行证 TWNDCERTIFICATE：台湾同胞来往内地通行证 MACAOCERTIFICATE：澳门来往内地通行证", "example": "IDCARD" }, { "name": "IdNumber", "type": "string", "required": true, "description": "证件号码", "example": "420704********6030" }, { "name": "PersonName", "type": "string", "required": true, "description": "姓名", "example": "张三" }, { "name": "IdValidityType", "type": "string", "required": true, "description": "证件有效期类型 LONGTERM：长期有效 OTHER：非长期有效", "example": "LONGTERM" }, { "name": "IdEffectiveDate", "type": "string", "required": true, "description": "证件生效日期，yyyy-MM-dd", "example": "2021-09-01" }, { "name": "IdExpireDate", "type": "string", "required": true, "description": "证件失效日期，yyyy-MM-dd", "example": "2031-09-01" }, { "name": "ContactPhone", "type": "string", "required": false, "description": "联系电话，HELIPAY渠道业务联系人必传", "example": "156****6677" }, { "name": "ContactAddress", "type": "string", "required": false, "description": "联系地址", "example": "北京市****街道***" }, { "name": "EmailAddress", "type": "string", "required": false, "description": "邮箱地址", "example": "1293****332@qq.com" } ] }, { "name": "SettleInfo", "type": "object", "required": false, "description": "商户结算信息。 HELIPAY渠道必传。", "example": "无", "children": [ { "name": "SettleAccountType", "type": "string", "required": false, "description": "结算账户类型 PRIVATE：对私 BUSINESS：对公 HELIPAY渠道必传", "example": "PRIVATE" }, { "name": "SettleAccountNumber", "type": "string", "required": false, "description": "结算账号 HELIPAY渠道必传", "example": "90719*****00014" }, { "name": "SettleAccountName", "type": "string", "required": false, "description": "结算账户名称 HELIPAY渠道必传", "example": "结算账户名称01" }, { "name": "BankBranchId", "type": "string", "required": false, "description": "支行号 HELIPAY渠道必传", "example": "10*******0048" }, { "name": "BankBranchName", "type": "string", "required": false, "description": "支行名称", "example": "中国XX银行XX支行" }, { "name": "SettleMode", "type": "string", "required": false, "description": "结算方式 AUTO：自动结算 SELF：自主结算 HELIPAY渠道必传", "example": "AUTO" }, { "name": "SettlePeriod", "type": "string", "required": false, "description": "结算周期 T1：工作日隔天结算 D1：自然日隔天结算 D0：当日结算 HELIPAY渠道必传", "example": " T1" } ] }, { "name": "OutSubMerchantExtensionInfo", "type": "object", "required": false, "description": "外部子商户其他公用扩展信息。 HELIPAY渠道必传。", "example": "无", "children": [ { "name": "RegionCode", "type": "string", "required": false, "description": "地区代码，国标码 HELIPAY渠道必传", "example": "110101" }, { "name": "RegisterAddress", "type": "string", "required": false, "description": "注册地址", "example": "北京市-朝阳区" }, { "name": "MailingAddress", "type": "string", "required": false, "description": "通讯地址 HELIPAY渠道必传", "example": "天河区珠江东路28号" }, { "name": "BusinessAddress", "type": "string", "required": false, "description": "营业地址/经营地址", "example": "营业地址001" }, { "name": "ServicePhone", "type": "string", "required": false, "description": "客服电话", "example": "15678995567" }, { "name": "WebSiteUrl", "type": "string", "required": false, "description": "网站url", "example": "http://www.merchant.com" }, { "name": "EmailAddress", "type": "string", "required": false, "description": "邮箱地址", "example": "test@tencent.com" } ] }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "无" } ], "required": [ "OutRegistrationNo", "ChannelMerchantId", "OutSubMerchantId", "ChannelName", "OutSubMerchantType", "OutSubMerchantName", "LegalPersonInfo", "BusinessLicenseInfo", "InterConnectionSubMerchantData" ] }, { "name": "CreateOpenBankExternalSubMerchantAccountBook", "description": "第三方子商户电子记账本创建接口", "status": "online", "parameters": [ { "name": "OutAccountBookId", "type": "string", "required": true, "description": "外部账本ID", "example": "OUT123876544" }, { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户ID", "example": "CM128989485" }, { "name": "ChannelSubMerchantId", "type": "string", "required": true, "description": "渠道子商户ID", "example": "CSM12874759" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称。目前只支持支付宝 __TENPAY__: 商企付 __WECHAT__: 微信支付 __ALIPAY__: 支付宝", "example": "ALIPAY" }, { "name": "PaymentMethod", "type": "string", "required": true, "description": "支付方式。目前只支持安心发支付 __EBANK_PAYMENT__: ebank支付 __OPENBANK_PAYMENT__: openbank支付 __SAFT_ISV__: 安心发支付", "example": "SAFT_ISV" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "无" } ], "required": [ "OutAccountBookId", "ChannelMerchantId", "ChannelSubMerchantId", "ChannelName", "PaymentMethod" ] }, { "name": "CreateOpenBankExternalSubMerchantRegistration", "description": "云企付-子商户进件", "status": "online", "parameters": [ { "name": "OutRegistrationNo", "type": "string", "required": true, "description": "外部进件序列号。", "example": "无" }, { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户ID。", "example": "无" }, { "name": "OutSubMerchantId", "type": "string", "required": true, "description": "外部子商户ID,平台侧商户唯一ID。", "example": "无" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称。详见附录-云企付枚举类说明-ChannelName。 __TENPAY__: 商企付 __WECHAT__: 微信支付 __ALIPAY__: 支付宝", "example": "TENPAY" }, { "name": "PaymentMethod", "type": "string", "required": true, "description": "支付方式。详见附录-云企付枚举类说明-PaymentMethod。 __EBANK_PAYMENT__: ebank支付 __OPENBANK_PAYMENT__: openbank支付", "example": "无" }, { "name": "BusinessLicenseNumber", "type": "string", "required": true, "description": "社会信用代码。", "example": "无" }, { "name": "OutSubMerchantName", "type": "string", "required": true, "description": "外部子商户名称。", "example": "无" }, { "name": "LegalName", "type": "string", "required": false, "description": "法人姓名。", "example": "无" }, { "name": "OutSubMerchantShortName", "type": "string", "required": false, "description": "外部子商户简称。", "example": "无" }, { "name": "OutSubMerchantDescription", "type": "string", "required": false, "description": "外部子商户描述。", "example": "无" }, { "name": "ExternalSubMerchantRegistrationData", "type": "string", "required": false, "description": "第三方子商户进件信息，为JSON格式字符串。详情见附录-复杂类型。", "example": "无" }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "通知地址。", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "无" } ], "required": [ "OutRegistrationNo", "ChannelMerchantId", "OutSubMerchantId", "ChannelName", "PaymentMethod", "BusinessLicenseNumber", "OutSubMerchantName" ] }, { "name": "CreateOpenBankGlobalPaymentOrder", "description": "云企付-跨境支付下单", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户号", "example": "CM572433237990035456" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称", "example": "CNP" }, { "name": "PayType", "type": "string", "required": true, "description": "付款方式", "example": "CREDIT_GATEWAY" }, { "name": "OutOrderId", "type": "string", "required": true, "description": "外部商户订单号,只能是数字、大小写字母，且在同一个接入平台下唯一", "example": "202002011200001" }, { "name": "TotalAmount", "type": "integer", "required": true, "description": "付款金额，单位分", "example": "10" }, { "name": "Currency", "type": "string", "required": true, "description": "支付币种，参考附录：货币代码", "example": "CNY" }, { "name": "ChannelSubMerchantId", "type": "string", "required": false, "description": "渠道子商户号", "example": "CM572433237990035456" }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "支付成功回调地址。", "example": "https://xxxx.com/notify/pay" }, { "name": "FrontUrl", "type": "string", "required": false, "description": "前端跳转地址。通联支付成功后，支付网关跳回商户的地址", "example": "https://xxxx.com/page" }, { "name": "FrontLanguage", "type": "string", "required": false, "description": "网站语言。收银台显示语言，见附录网站语言", "example": "zh" }, { "name": "Remark", "type": "string", "required": false, "description": "付款备注", "example": "无" }, { "name": "ExternalPaymentData", "type": "string", "required": false, "description": "第三方拓展信息信息", "example": "无" }, { "name": "GoodsInfos", "type": "array", "required": false, "description": "商品信息", "example": "无", "item_type": "object", "children": [ { "name": "GoodsName", "type": "string", "required": false, "description": "商品标题。默认值“商品支付”。", "example": "商品支付" }, { "name": "GoodsDetail", "type": "string", "required": false, "description": "商品详细描述（商品列表）。", "example": "商品详细描述（商品列表，默认值“商品支付”）" }, { "name": "GoodsDescription", "type": "string", "required": false, "description": "银行附言。不可以有以下字符：+{}()%*\u0026';\"[]等特殊符号", "example": "商品简单描述。需传入应用市场上的" }, { "name": "GoodsBizType", "type": "string", "required": false, "description": "业务类型。汇付渠道必填，汇付渠道传入固定值100099。", "example": "100099" }, { "name": "Sku", "type": "string", "required": false, "description": "商品编号。", "example": "123121" }, { "name": "Price", "type": "string", "required": false, "description": "商品单价。", "example": "10.12" }, { "name": "Quantity", "type": "string", "required": false, "description": "商品数量", "example": "1" }, { "name": "ProductImage", "type": "string", "required": false, "description": "商品图片url", "example": "无" }, { "name": "ProductUrl", "type": "string", "required": false, "description": "商品链接url", "example": "无" } ] }, { "name": "ShippingInfo", "type": "object", "required": false, "description": "邮寄信息", "example": "无", "children": [ { "name": "FirstName", "type": "string", "required": false, "description": "收货人名字", "example": "无" }, { "name": "LastName", "type": "string", "required": false, "description": "收货人姓氏", "example": "无" }, { "name": "AddressOne", "type": "string", "required": false, "description": "收货地址1", "example": "无" }, { "name": "AddressTwo", "type": "string", "required": false, "description": "收货地址2", "example": "无" }, { "name": "City", "type": "string", "required": false, "description": "收货地址所在城市", "example": "无" }, { "name": "State", "type": "string", "required": false, "description": "收货地址所在州，当国家是美国或加拿大时，使用ISO-3166-2:US或ISO -3166-2:CA 中该 国家地区编码标准中的两位字母编码", "example": "无" }, { "name": "Country", "type": "string", "required": false, "description": "使用ISO-3166-1标准中的两位字母编码", "example": "无" }, { "name": "ZipCode", "type": "string", "required": false, "description": "收货地址邮编", "example": "无" }, { "name": "Phone", "type": "string", "required": false, "description": "收货联系电话", "example": "无" } ] }, { "name": "BillingInfo", "type": "object", "required": false, "description": "账单信息", "example": "无", "children": [ { "name": "FirstName", "type": "string", "required": false, "description": "账单人名字", "example": "无" }, { "name": "LastName", "type": "string", "required": false, "description": "账单人姓氏", "example": "无" }, { "name": "AddressOne", "type": "string", "required": false, "description": "账单地址1", "example": "无" }, { "name": "AddressTwo", "type": "string", "required": false, "description": "账单地址1", "example": "无" }, { "name": "City", "type": "string", "required": false, "description": "账单地址所在城市", "example": "无" }, { "name": "State", "type": "string", "required": false, "description": "账单地址所在州/省，当国家是美国或加拿大时，使用ISO-3166-2:US或ISO -3166-2:CA 中该国家地区编 码标准中的两位字母编码。", "example": "无" }, { "name": "Country", "type": "string", "required": false, "description": "账单地址所在国家，使用ISO-3166-1标准中的两位字母编码。", "example": "无" }, { "name": "ZipCode", "type": "string", "required": false, "description": "账单地址邮编", "example": "无" }, { "name": "Phone", "type": "string", "required": false, "description": "账单人手机号", "example": "无" } ] }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 缺省默认为生产环境", "example": "无" } ], "required": [ "ChannelMerchantId", "ChannelName", "PayType", "OutOrderId", "TotalAmount", "Currency" ] }, { "name": "CreateOpenBankMerchant", "description": "云企付-创建商户", "status": "online", "parameters": [ { "name": "OutMerchantId", "type": "string", "required": true, "description": "外部商户ID。", "example": "无" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称。 __TENPAY__: 商企付", "example": "TENPAY" }, { "name": "OutMerchantName", "type": "string", "required": true, "description": "外部商户名称。", "example": "无" }, { "name": "ExternalMerchantInfo", "type": "string", "required": true, "description": "第三方渠道商户信息。详情见附录-复杂类型。", "example": "无" }, { "name": "OutMerchantShortName", "type": "string", "required": false, "description": "外部商户简称。", "example": "无" }, { "name": "OutMerchantDescription", "type": "string", "required": false, "description": "外部商户描述", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "sandbox" } ], "required": [ "OutMerchantId", "ChannelName", "OutMerchantName", "ExternalMerchantInfo" ] }, { "name": "CreateOpenBankPaymentOrder", "description": "云企付-创建支付订单。支持B2B网关支付，B2C转账下单。", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "云企付渠道商户号。外部接入平台入驻云企付平台后下发。", "example": "CM572433237990035456" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称。详见附录-云企付枚举类说明-ChannelName。 __TENPAY__: 商企付 __WECHAT__: 微信支付 __ALIPAY__: 支付宝 __HUIFU__: 汇付斗拱", "example": "TENPAY" }, { "name": "PaymentMethod", "type": "string", "required": true, "description": "付款方式。详见附录-云企付枚举类说明-PaymentMethod。 __EBANK_PAYMENT__:B2B EBank付款 __OPENBANK_PAYMENT__:B2C openbank付款 __SAFT_ISV__:支付宝安心发 __TRANS_TO_CHANGE__: 微信支付转账到零钱v2 __TRANS_TO_CHANGE_V3__: 微信支付转账到零钱v3 __ONLINEBANK__: 汇付网银", "example": "EBANK_PAYMENT" }, { "name": "PaymentMode", "type": "string", "required": true, "description": "付款模式。默认直接支付，如 __DIRECT__:直接支付 __FREEZE__:担保支付", "example": "DIRECT" }, { "name": "OutOrderId", "type": "string", "required": true, "description": "外部订单号,只能是数字、大小写字母，且在同一个接入平台下唯一，限定长度40位。", "example": "20210203855632001" }, { "name": "TotalAmount", "type": "integer", "required": true, "description": "付款金额，单位分。", "example": "100" }, { "name": "Currency", "type": "string", "required": true, "description": "固定值CNY。", "example": "CNY" }, { "name": "PayerInfo", "type": "object", "required": true, "description": "付款方信息。", "example": "无", "children": [ { "name": "PayerId", "type": "string", "required": false, "description": "付款方唯一标识。当TENPAY时，必填上送 付款方入驻云企付商户ID。", "example": "sub1w00001" }, { "name": "PayerName", "type": "string", "required": false, "description": "付款方名称。当TENPAY上送付款方入驻云企付的商户名称。", "example": "子商户001" }, { "name": "BindSerialNo", "type": "string", "required": false, "description": "付款方付款账户标识。 当付款方式为OPENBANK_PAYMENT时，必输表示企业账户ID；当付款方式为SAFT_ISV时，必须上送付款方的渠道电子记账本ID；当付款方式为ONLINEBANK，上送付款方银行编号BankId。", "example": "10232043567" }, { "name": "AccountType", "type": "string", "required": false, "description": "付款账户标识类型 BANK_ACCOUNT：绑定银行账户 ACCOUNT_BOOK_ID：电子记账本ID。 当付款方式为SAFT_ISV时，必须上送类型为ACCOUNT_BOOK_ID。", "example": "ACCOUNT_BOOK_ID" }, { "name": "BankCardType", "type": "string", "required": false, "description": "付款卡类型。汇付渠道必填。 DEBIT_CARD：借记卡 CREDIT_CARD：信用卡", "example": "DEBIT_CARD" } ] }, { "name": "PayeeInfo", "type": "object", "required": true, "description": "收款方信息。", "example": "无", "children": [ { "name": "PayeeId", "type": "string", "required": false, "description": "收款方唯一标识。 当渠道为TENPAY，付款方式为EBANK_PAYMENT，必填，上送收款方入驻云企付商户ID； 付款方式为OPENBANK_PAYMENT时，非必填，输入外部收款方的标识ID 渠道为WECHAT，付款方式为TRANS_TO_CHANGE时，上送微信OPEN_ID；", "example": "sub1w00002" }, { "name": "BankBranchName", "type": "string", "required": false, "description": "支行名称。", "example": "深圳华侨城支行" }, { "name": "BankAccountNumber", "type": "string", "required": false, "description": "银行账号。渠道为TENPAY，付款方式为OPENBANK_PAYMENT时必选", "example": "310899991010003084911" }, { "name": "PayeeName", "type": "string", "required": false, "description": "收款方名称。 当渠道为TENPAY，付款方式为EBANK_PAYMENT时，上送收款方入驻云企付的商户名称； 渠道为TENPAY，付款方式为OPENBANK_PAYMENT时必选，上送收款方账户名称； 渠道为ALIPAY，付款方式为SAFT_ISV时，收款账户标识类型为ALIPAY_LOGON_ID时必传，上送收款方真实姓名。 渠道为WECHAT，付款方式为TRANS_TO_CHANGE时，上送收款人姓名。", "example": "收款子商户0002" }, { "name": "BankBranchId", "type": "string", "required": false, "description": "联行号。渠道为TENPAY，付款方式为OPENBANK_PAYMENT时必选", "example": "301290050123" }, { "name": "BindSerialNo", "type": "string", "required": false, "description": "收款方绑卡序列号。 当渠道为TENPAY，付款方式为EBANK_PAYMENT时，必填，上送收款方入驻云企付平台时，下发的绑卡序列号；当渠道为ALIPAY，付款方式为SAFT_ISV时，必填，根据收款账户标识类型上送。", "example": "10232043567" }, { "name": "AccountType", "type": "string", "required": false, "description": "收款账户标识类型 BANK_ACCOUNT：绑定银行账户 ACCOUNT_BOOK_ID：电子记账本ID ALIPAY_USER_ID：支付宝的会员ID ALIPAY_LOGON_ID：支付宝登录号。 付款方式为SAFT_ISV时，必填。", "example": "ACCOUNT_BOOK_ID" } ] }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "通知地址，如www.test.com。", "example": "如www.test.com" }, { "name": "ExpireTime", "type": "string", "required": false, "description": "订单过期时间，yyyy-MM-dd HH:mm:ss格式。", "example": "2020-02-11 18:11:54" }, { "name": "FrontUrl", "type": "string", "required": false, "description": "前端成功回调URL。条件可选。", "example": "http://127.0.0.1/web/success" }, { "name": "RefreshUrl", "type": "string", "required": false, "description": "前端刷新 URL。条件可选。", "example": "http://127.0.0.1/web/refresh" }, { "name": "SceneInfo", "type": "object", "required": false, "description": "设备信息，条件可选。", "example": "无", "children": [ { "name": "PayerClientIp", "type": "string", "required": false, "description": "用户端实际 ip。汇付渠道必填。", "example": "14.17.22.32" }, { "name": "PayerUa", "type": "string", "required": false, "description": "浏览器 User-Agent。", "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_2) AppleWebKit/537.3" }, { "name": "OrderTime", "type": "string", "required": false, "description": "用户下单时间。若不上送，服务端默认当前时间。", "example": "2020-12-11 11:33:43" }, { "name": "DeviceId", "type": "string", "required": false, "description": "终端设备号（门店号或收银设备 ID），示例值：POS1:1。", "example": "POS1:1" }, { "name": "DeviceType", "type": "string", "required": false, "description": "终端设备类型。MOBILE_BROWSER:手机浏览器，MOBILE_APP:手机应用程序，TABLET:平板；WATCH:手表，PC:电脑PC，OTHER:其他。 汇付渠道必填。", "example": "MOBILE_BROWSER" } ] }, { "name": "GoodsInfo", "type": "object", "required": false, "description": "商品信息，条件可选。", "example": "无", "children": [ { "name": "GoodsName", "type": "string", "required": false, "description": "商品标题。默认值“商品支付”。", "example": "商品支付" }, { "name": "GoodsDetail", "type": "string", "required": false, "description": "商品详细描述（商品列表）。", "example": "商品详细描述（商品列表，默认值“商品支付”）" }, { "name": "GoodsDescription", "type": "string", "required": false, "description": "银行附言。不可以有以下字符：+{}()%*\u0026';\"[]等特殊符号", "example": "商品简单描述。需传入应用市场上的" }, { "name": "GoodsBizType", "type": "string", "required": false, "description": "业务类型。汇付渠道必填，汇付渠道传入固定值100099。", "example": "100099" }, { "name": "Sku", "type": "string", "required": false, "description": "商品编号。", "example": "123121" }, { "name": "Price", "type": "string", "required": false, "description": "商品单价。", "example": "10.12" }, { "name": "Quantity", "type": "string", "required": false, "description": "商品数量", "example": "1" }, { "name": "ProductImage", "type": "string", "required": false, "description": "商品图片url", "example": "无" }, { "name": "ProductUrl", "type": "string", "required": false, "description": "商品链接url", "example": "无" } ] }, { "name": "Attachment", "type": "string", "required": false, "description": "附加信息，查询时原样返回。", "example": "name=123" }, { "name": "ProfitShareFlag", "type": "string", "required": false, "description": "若不上传，即使用默认值无需分润 __NO_NEED_SHARE__：无需分润； __SHARE_BY_INFO__：分润时指定金额，此时如果分润信息 ProfitShareInfo为空，只冻结，不分账给其他商户；需要调用解冻接口。 __SHARE_BY_API__：后续调用分润接口决定分润金额", "example": "NO_NEED_SHARE" }, { "name": "ProfitShareInfoList", "type": "array", "required": false, "description": "分润信息，配合ProfitShareFlag使用。", "example": "无", "item_type": "object", "children": [ { "name": "RecvId", "type": "string", "required": false, "description": "分润接收方，渠道商户号ID", "example": "sub1w00003" }, { "name": "ProfitShareFee", "type": "integer", "required": false, "description": "分润金额，单位分", "example": "100" } ] }, { "name": "SettlementRulesInfo", "type": "object", "required": false, "description": "商企付-担保支付（PaymentMode为 FREEZE ）时需设置该参数", "example": "无", "children": [ { "name": "UnfreezeRule", "type": "string", "required": false, "description": "ONCE：仅单次解冻（默认） MULTI：多次解冻", "example": "ONCE" }, { "name": "RefundRule", "type": "string", "required": false, "description": "ONCE：仅单次退款（默认） MULTI：多次退款", "example": "ONCE" } ] }, { "name": "ExternalPaymentData", "type": "string", "required": false, "description": "底层支付渠道特殊字段，若无特殊说明时，可以为空", "example": "无" }, { "name": "Remark", "type": "string", "required": false, "description": "备注信息。", "example": "备注" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 缺省默认为生产环境", "example": "沙箱环境sandbox" } ], "required": [ "ChannelMerchantId", "ChannelName", "PaymentMethod", "PaymentMode", "OutOrderId", "TotalAmount", "Currency", "PayerInfo", "PayeeInfo" ] }, { "name": "CreateOpenBankRechargeOrder", "description": "云企付-创建充值订单", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "云企付渠道商户号。外部接入平台入驻云企付平台后下发。", "example": "无" }, { "name": "OutOrderId", "type": "string", "required": true, "description": "外部订单号,只能是数字、大小写字母，且在同一个接入平台下唯一，限定长度40位。", "example": "20210203855632001" }, { "name": "TotalAmount", "type": "integer", "required": true, "description": "付款金额，单位分。", "example": "100" }, { "name": "Currency", "type": "string", "required": true, "description": "固定值CNY。", "example": "CNY" }, { "name": "ExpireTime", "type": "string", "required": true, "description": "订单过期时间，yyyy-MM-dd HH:mm:ss格式。", "example": "2020-02-11 18:11:54" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称。 __TENPAY__: 商企付 __WECHAT__: 微信支付 __ALIPAY__: 支付宝", "example": "ALIPAY" }, { "name": "PaymentMethod", "type": "string", "required": true, "description": "渠道名称。 __TENPAY__: 商企付 __WECHAT__: 微信支付 __ALIPAY__: 支付宝", "example": "SAFT_ISV" }, { "name": "PayeeInfo", "type": "object", "required": true, "description": "收款方信息。", "example": "无", "children": [ { "name": "PayeeId", "type": "string", "required": true, "description": "收款方标识 收款方类型为电子记账本时，上送渠道电子记账本ID", "example": "sub1w0002" }, { "name": "PayeeIdType", "type": "string", "required": true, "description": "收款方标识类型 ACCOUNT_BOOK_ID：电子记账本ID", "example": "ACCOUNT_BOOK_ID" }, { "name": "PayeeName", "type": "string", "required": false, "description": "收款方名称", "example": "无" } ] }, { "name": "ChannelSubMerchantId", "type": "string", "required": true, "description": "渠道子商户号", "example": "无" }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "通知地址，如www.test.com。", "example": "如www.test.com" }, { "name": "Remark", "type": "string", "required": false, "description": "备注信息。限制200个字符。", "example": "备注" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "无" } ], "required": [ "ChannelMerchantId", "OutOrderId", "TotalAmount", "Currency", "ExpireTime", "ChannelName", "PaymentMethod", "PayeeInfo", "ChannelSubMerchantId" ] }, { "name": "CreateOpenBankSubMerchantRateConfigure", "description": "云企付-子商户费率配置", "status": "online", "parameters": [ { "name": "ChannelRegistrationNo", "type": "string", "required": true, "description": "渠道进件序列号。 填写子商户进件返回的渠道进件编号。", "example": "123456" }, { "name": "OutProductFeeNo", "type": "string", "required": true, "description": "外部产品费率申请序列号。", "example": "12345678" }, { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户ID。", "example": "CM123456" }, { "name": "ChannelSubMerchantId", "type": "string", "required": true, "description": "渠道子商户ID。", "example": "CM345678" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称。详见附录-云企付枚举类说明-ChannelName。", "example": "HELIPAY" }, { "name": "PayType", "type": "string", "required": true, "description": "支付类型。 SWIPE:刷卡 SCAN:扫码 WAP:WAP PUBLIC:公众号支付 SDK:SDK MINI_PROGRAM:小程序 注意：HELIPAY渠道传SDK。", "example": "SDK" }, { "name": "PayChannel", "type": "string", "required": true, "description": "支付渠道。 ALIPAY：支付宝 WXPAY：微信支付 UNIONPAY：银联", "example": "WXPAY" }, { "name": "FeeMode", "type": "string", "required": true, "description": "计费模式。 SINGLE：按单笔金额计费 RATIO：按单笔费率计费 RANGE：按分段区间计费", "example": "SINGLE" }, { "name": "FeeValue", "type": "integer", "required": true, "description": "费用值，单位（0.01%或分）。", "example": "1" }, { "name": "PaymentMethod", "type": "string", "required": false, "description": "支付方式。详见附录-云企付枚举类说明-PaymentMethod。 HELIPAY渠道不需要传入。", "example": "UNIFIED_PAYMENT" }, { "name": "MinFee", "type": "integer", "required": false, "description": "最低收费金额，单位（分）。", "example": "1" }, { "name": "MaxFee", "type": "integer", "required": false, "description": "最高收费金额，单位（分）。", "example": "1" }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "通知地址。", "example": "http://xxx.com" }, { "name": "FeeRangeList", "type": "array", "required": false, "description": "分段计费区间列表。", "example": "无", "item_type": "object", "children": [ { "name": "CardType", "type": "string", "required": true, "description": "卡类型，银联产品使用 DEBIT：借记卡 CREDIT：贷记卡", "example": "DEBIT" }, { "name": "RangeStartValue", "type": "integer", "required": true, "description": "区间起始金额，单位（分）", "example": "1" }, { "name": "RangeEndValue", "type": "integer", "required": true, "description": "区间结束金额，单位（分）", "example": "2" }, { "name": "RangeFeeMode", "type": "string", "required": true, "description": "分段计费模式 SINGLE：按金额计费 RATIO：按费率计费", "example": "SINGLE" }, { "name": "FeeValue", "type": "integer", "required": true, "description": "费用值，单位（0.01%或分）", "example": "1" }, { "name": "MinFee", "type": "integer", "required": false, "description": "最低收费金额，单位（分）", "example": "1" }, { "name": "MaxFee", "type": "integer", "required": false, "description": "最高收费金额，单位（分）", "example": "2" } ] }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "无" } ], "required": [ "ChannelRegistrationNo", "OutProductFeeNo", "ChannelMerchantId", "ChannelSubMerchantId", "ChannelName", "PayType", "PayChannel", "FeeMode", "FeeValue" ] }, { "name": "CreateOpenBankUnifiedOrder", "description": "云企付-聚合下单", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户号。", "example": "CM572433237990035456" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称。", "example": "HELIPAY" }, { "name": "PayType", "type": "string", "required": true, "description": "支付产品类型。 被扫（扫码）：SWIPE, 主扫（刷卡）：SCAN, H5：WAP, 公众号：PUBLIC, APP-SDK：SDK, 小程序：MINI_PROGRAM, 快捷支付：QUICK, 网银支付：ONLINE_BANK。", "example": "SDK" }, { "name": "OutOrderId", "type": "string", "required": true, "description": "外部商户订单号。 只能是数字、大小写字母，且在同一个接入平台下唯一。", "example": "202002011200001" }, { "name": "TotalAmount", "type": "integer", "required": true, "description": "交易金额，单位分。", "example": "100" }, { "name": "Currency", "type": "string", "required": true, "description": "币种。固定：CNY。", "example": "CNY" }, { "name": "ChannelSubMerchantId", "type": "string", "required": false, "description": "渠道子商户号。", "example": "CM572433237990035456" }, { "name": "PayChannel", "type": "string", "required": false, "description": "实际支付渠道。没有则无需填写。如 支付宝 ALIPAY 微信支付 WXPAY 银联 UNIONPAY 一般在间连模式下使用。", "example": "WXPAY" }, { "name": "SceneInfo", "type": "object", "required": false, "description": "设备信息。", "example": "无", "children": [ { "name": "PayerClientIp", "type": "string", "required": false, "description": "用户端实际 ip。汇付渠道必填。", "example": "14.17.22.32" }, { "name": "PayerUa", "type": "string", "required": false, "description": "浏览器 User-Agent。", "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_2) AppleWebKit/537.3" }, { "name": "OrderTime", "type": "string", "required": false, "description": "用户下单时间。若不上送，服务端默认当前时间。", "example": "2020-12-11 11:33:43" }, { "name": "DeviceId", "type": "string", "required": false, "description": "终端设备号（门店号或收银设备 ID），示例值：POS1:1。", "example": "POS1:1" }, { "name": "DeviceType", "type": "string", "required": false, "description": "终端设备类型。MOBILE_BROWSER:手机浏览器，MOBILE_APP:手机应用程序，TABLET:平板；WATCH:手表，PC:电脑PC，OTHER:其他。 汇付渠道必填。", "example": "MOBILE_BROWSER" } ] }, { "name": "ProfitShareInfoList", "type": "array", "required": false, "description": "分账信息列表。", "example": "无", "item_type": "object", "children": [ { "name": "RecvId", "type": "string", "required": false, "description": "分润接收方，渠道商户号ID", "example": "sub1w00003" }, { "name": "ProfitShareFee", "type": "integer", "required": false, "description": "分润金额，单位分", "example": "100" } ] }, { "name": "OrderSubject", "type": "string", "required": false, "description": "订单标题。", "example": "购买商品" }, { "name": "GoodsDetail", "type": "string", "required": false, "description": "商品信息。", "example": "商品描述" }, { "name": "ExpireTime", "type": "string", "required": false, "description": "超时时间。", "example": "2020-02-11 18:11:54" }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "支付成功回调地址。", "example": "https://xxxx.com/notify/pay" }, { "name": "FrontUrl", "type": "string", "required": false, "description": "支付成功前端跳转URL。", "example": "https://xxxx.com/page" }, { "name": "Attachment", "type": "string", "required": false, "description": "订单附加信息，查询或者回调的时候原样返回。", "example": "附加信息" }, { "name": "ExternalPaymentData", "type": "string", "required": false, "description": "第三方渠道扩展字段。见附录-复杂类型。 未作特殊说明，则无需传入。", "example": "{\"xxx\":\"xxx\"}" }, { "name": "Remark", "type": "string", "required": false, "description": "备注。", "example": "备注" }, { "name": "StoreInfo", "type": "object", "required": false, "description": "门店信息。", "example": "无", "children": [ { "name": "Name", "type": "string", "required": true, "description": "门店名称", "example": "无" }, { "name": "AreaCode", "type": "string", "required": true, "description": "地区编码", "example": "无" }, { "name": "Address", "type": "string", "required": true, "description": "详细地址", "example": "无" }, { "name": "Id", "type": "string", "required": false, "description": "门店编号", "example": "无" } ] }, { "name": "PayLimitInfo", "type": "object", "required": false, "description": "支付限制。", "example": "无", "children": [ { "name": "PayLimitType", "type": "string", "required": true, "description": "限制类型", "example": "无" }, { "name": "PayLimitValue", "type": "string", "required": true, "description": "限制类型值", "example": "无" } ] }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "无" } ], "required": [ "ChannelMerchantId", "ChannelName", "PayType", "OutOrderId", "TotalAmount", "Currency" ] }, { "name": "CreateOpenBankVerificationOrder", "description": "云企付-创建核销申请，适用于针对支付订单维度的确认收货，解冻等业务场景。目前支持的渠道有TENPAY下的EBANK_PAYMENT付款方式创建支付订单时，选择担保支付下单的订单进行解冻。", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "云企付渠道商户号。外部接入平台入驻云企付平台后下发。", "example": "CM20209324350112001" }, { "name": "OutVerificationId", "type": "string", "required": true, "description": "外部核销申请订单号", "example": "20209324350112001" }, { "name": "VerificationAmount", "type": "integer", "required": true, "description": "核销金额，单位分", "example": "1000" }, { "name": "OutOrderId", "type": "string", "required": false, "description": "外部支付订单号。调用创建支付订单时，下单支付时的外部订单号。与ChannelOrderId不能同时为空。", "example": "202224350112001" }, { "name": "ChannelOrderId", "type": "string", "required": false, "description": "云企付渠道订单号。调用创建支付订单时，下单支付时的云企付渠道订单号。与OutOrderId不能同时为空。", "example": "66789324350112001" }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "核销成功回调地址。若不上送，则不回调通知。", "example": "https://xxx.cloud.xxx.com/notify" }, { "name": "Remark", "type": "string", "required": false, "description": "备注。", "example": "无" }, { "name": "ExternalVerificationData", "type": "string", "required": false, "description": "第三方支付渠道需要额外上送字段。详情见附录描述。", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "无" } ], "required": [ "ChannelMerchantId", "OutVerificationId", "VerificationAmount" ] }, { "name": "CreateOrder", "description": "云鉴-消费订单发起的接口", "status": "online", "parameters": [ { "name": "ChannelCode", "type": "string", "required": true, "description": "渠道编号。ZSB2B：招商银行B2B。", "example": "ZSB2B" }, { "name": "MerchantAppId", "type": "string", "required": true, "description": "进件成功后返给商户方的 AppId。", "example": "1c6f41570498301d85fc4589a5435b54" }, { "name": "Amount", "type": "string", "required": true, "description": "交易金额。单位：元", "example": "交易金额" }, { "name": "TraceNo", "type": "string", "required": true, "description": "商户流水号。商户唯一订单号由字母或数字组成。", "example": "46eed0ce0edc3b11bc1056b97dbc734c" }, { "name": "NotifyUrl", "type": "string", "required": true, "description": "通知地址。商户接收交易结果的通知地址。", "example": "http://aaa.aaa.aaa/" }, { "name": "ReturnUrl", "type": "string", "required": true, "description": "返回地址。支付成功后，页面将跳 转返回到商户的该地址。", "example": "http://bbb.bbb.bbb/" } ], "required": [ "ChannelCode", "MerchantAppId", "Amount", "TraceNo", "NotifyUrl", "ReturnUrl" ] }, { "name": "CreatePayMerchant", "description": "商户新增的接口", "status": "online", "parameters": [ { "name": "PlatformCode", "type": "string", "required": true, "description": "平台编号", "example": "1001" }, { "name": "ChannelMerchantNo", "type": "string", "required": true, "description": "渠道方收款商户编号，由渠道方(银行)提 供。", "example": "m123456" }, { "name": "ChannelCheckFlag", "type": "string", "required": true, "description": "是否需要向渠道进行 商户信息验证 1:验证 0:不验证", "example": "0" }, { "name": "MerchantName", "type": "string", "required": true, "description": "收款商户名称", "example": "美亿佳白石洲店" }, { "name": "BusinessPayFlag", "type": "string", "required": false, "description": "是否开通 B2B 支付 1:开通 0:不开通 缺省:1", "example": "1" } ], "required": [ "PlatformCode", "ChannelMerchantNo", "ChannelCheckFlag", "MerchantName" ] }, { "name": "CreatePayRollPreOrder", "description": "务工卡-核身预下单", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "用户在商户对应appid下的唯一标识", "example": "无" }, { "name": "SubMerchantId", "type": "string", "required": true, "description": "微信服务商下特约商户的商户号，由微信支付生成并下发", "example": "无" }, { "name": "AuthNumber", "type": "string", "required": true, "description": "商户系统内部的商家核身单号，要求此参数只能由数字、大小写字母组成，在服务商内部唯一", "example": "无" }, { "name": "ProjectName", "type": "string", "required": true, "description": "该劳务活动的项目名称", "example": "无" }, { "name": "CompanyName", "type": "string", "required": true, "description": "该工人所属的用工企业", "example": "无" }, { "name": "WechatAppId", "type": "string", "required": false, "description": "是服务商在微信申请公众号/小程序或移动应用成功后分配的账号ID（与服务商主体一致） 当输入服务商Appid时，会校验其与服务商商户号的绑定关系。服务商APPID和与特约商户APPID至少输入一个，且必须要有拉起领薪卡小程序时使用的APPID", "example": "无" }, { "name": "WechatSubAppId", "type": "string", "required": false, "description": "特约商户在微信申请公众号/小程序或移动应用成功后分配的账号ID（与特约商户主体一致） 当输入特约商户Appid时，会校验其与特约商户号的绑定关系。服务商APPID和与特约商户APPID至少输入一个，且必须要有拉起领薪卡小程序时使用的APPID", "example": "无" } ], "required": [ "OpenId", "SubMerchantId", "AuthNumber", "ProjectName", "CompanyName" ] }, { "name": "CreatePayRollPreOrderWithAuth", "description": "务工卡-核身预下单带授权", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "用户在商户对应appid下的唯一标识", "example": "无" }, { "name": "SubMerchantId", "type": "string", "required": true, "description": "微信服务商下特约商户的商户号，由微信支付生成并下发", "example": "无" }, { "name": "AuthNumber", "type": "string", "required": true, "description": "商户系统内部的商家核身单号，要求此参数只能由数字、大小写字母组成，在服务商内部唯一", "example": "无" }, { "name": "ProjectName", "type": "string", "required": true, "description": "该劳务活动的项目名称", "example": "无" }, { "name": "CompanyName", "type": "string", "required": true, "description": "该工人所属的用工企业", "example": "无" }, { "name": "UserName", "type": "string", "required": true, "description": "用户实名信息，该字段需进行加密处理，加密方法详见[敏感信息加密说明](https://pay.weixin.qq.com/wiki/doc/apiv3_partner/wechatpay/wechatpay4_3.shtml)", "example": "无" }, { "name": "IdNo", "type": "string", "required": true, "description": "用户证件号，该字段需进行加密处理，加密方法详见[敏感信息加密说明](https://pay.weixin.qq.com/wiki/doc/apiv3_partner/wechatpay/wechatpay4_3.shtml)", "example": "无" }, { "name": "EmploymentType", "type": "string", "required": true, "description": "微工卡服务仅支持用于与商户有用工关系的用户，需明确用工类型；参考值： LONG_TERM_EMPLOYMENT：长期用工， SHORT_TERM_EMPLOYMENT： 短期用工， COOPERATION_EMPLOYMENT：合作关系", "example": "无" }, { "name": "WechatAppId", "type": "string", "required": false, "description": "是服务商在微信申请公众号/小程序或移动应用成功后分配的账号ID（与服务商主体一致） 当输入服务商Appid时，会校验其与服务商商户号的绑定关系。服务商APPID和与特约商户APPID至少输入一个，且必须要有拉起领薪卡小程序时使用的APPID", "example": "无" }, { "name": "WechatSubAppId", "type": "string", "required": false, "description": "特约商户在微信申请公众号/小程序或移动应用成功后分配的账号ID（与特约商户主体一致） 当输入特约商户Appid时，会校验其与特约商户号的绑定关系。服务商APPID和与特约商户APPID至少输入一个，且必须要有拉起领薪卡小程序时使用的APPID", "example": "无" } ], "required": [ "OpenId", "SubMerchantId", "AuthNumber", "ProjectName", "CompanyName", "UserName", "IdNo", "EmploymentType" ] }, { "name": "CreatePayRollToken", "description": "务工卡-生成授权令牌", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "用户在商户对应appid下的唯一标识", "example": "无" }, { "name": "SubMerchantId", "type": "string", "required": true, "description": "微信服务商下特约商户的商户号，由微信支付生成并下发", "example": "无" }, { "name": "UserName", "type": "string", "required": true, "description": "用户实名信息，该字段需进行加密处理，加密方法详见[敏感信息加密说明](https://pay.weixin.qq.com/wiki/doc/apiv3_partner/wechatpay/wechatpay4_3.shtml)", "example": "无" }, { "name": "IdNo", "type": "string", "required": true, "description": "用户证件号，该字段需进行加密处理，加密方法详见[敏感信息加密说明](https://pay.weixin.qq.com/wiki/doc/apiv3_partner/wechatpay/wechatpay4_3.shtml)", "example": "无" }, { "name": "EmploymentType", "type": "string", "required": true, "description": "微工卡服务仅支持用于与商户有用工关系的用户，需明确用工类型；参考值： LONG_TERM_EMPLOYMENT：长期用工， SHORT_TERM_EMPLOYMENT： 短期用工， COOPERATION_EMPLOYMENT：合作关系", "example": "无" }, { "name": "WechatAppId", "type": "string", "required": false, "description": "是服务商在微信申请公众号/小程序或移动应用成功后分配的账号ID（与服务商主体一致） 当输入服务商Appid时，会校验其与服务商商户号的绑定关系。服务商APPID和与特约商户APPID至少输入一个，且必须要有拉起领薪卡小程序时使用的APPID", "example": "无" }, { "name": "WechatSubAppId", "type": "string", "required": false, "description": "特约商户在微信申请公众号/小程序或移动应用成功后分配的账号ID（与特约商户主体一致） 当输入特约商户Appid时，会校验其与特约商户号的绑定关系。服务商APPID和与特约商户APPID至少输入一个，且必须要有拉起领薪卡小程序时使用的APPID", "example": "无" } ], "required": [ "OpenId", "SubMerchantId", "UserName", "IdNo", "EmploymentType" ] }, { "name": "CreateRedInvoice", "description": "智慧零售-发票红冲", "status": "online", "parameters": [ { "name": "InvoicePlatformId", "type": "integer", "required": true, "description": "开票平台ID 0 : 高灯 1 : 票易通", "example": "1" }, { "name": "Invoices", "type": "array", "required": true, "description": "红冲明细", "example": "[ { \"OrderId\":\"test195992\" ", "item_type": "object", "children": [ { "name": "OrderId", "type": "string", "required": true, "description": "订单号" }, { "name": "CallbackUrl", "type": "string", "required": false, "description": "发票结果回传地址" }, { "name": "OrderSn", "type": "string", "required": false, "description": "业务开票号" }, { "name": "RedSerialNo", "type": "string", "required": false, "description": "红字信息表编码" }, { "name": "StoreNo", "type": "string", "required": false, "description": "门店编号" } ] }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填 sandbox。", "example": "NULL" }, { "name": "InvoiceChannel", "type": "integer", "required": false, "description": "开票渠道。0：线上渠道，1：线下渠道。不填默认为线上渠道", "example": "NULL" } ], "required": [ "InvoicePlatformId", "Invoices" ] }, { "name": "CreateRedInvoiceV2", "description": "智慧零售-发票红冲V2", "status": "online", "parameters": [ { "name": "InvoicePlatformId", "type": "integer", "required": true, "description": "开票平台ID 0 : 高灯 1 : 票易通", "example": "1" }, { "name": "OrderId", "type": "string", "required": true, "description": "订单号", "example": "123456" }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填 sandbox。", "example": "NULL" }, { "name": "InvoiceChannel", "type": "integer", "required": false, "description": "开票渠道。0：线上渠道，1：线下渠道。不填默认为线上渠道", "example": "NULL" } ], "required": [ "InvoicePlatformId", "OrderId" ] }, { "name": "CreateSinglePayment", "description": "灵云-单笔主播转账接口", "status": "online", "parameters": [ { "name": "TransferType", "type": "integer", "required": true, "description": "转账类型 1 微信企业付款 2 支付宝转账 3 平安银企直连代发转账", "example": "1" }, { "name": "OrderId", "type": "string", "required": true, "description": "订单流水号", "example": "orderId" }, { "name": "TransferAmount", "type": "integer", "required": true, "description": "转账金额", "example": "100" }, { "name": "AnchorId", "type": "string", "required": true, "description": "主播ID（与主播业务ID不能同时为空，两者都填取主播ID）", "example": "anchorId" }, { "name": "ReqReserved", "type": "string", "required": false, "description": "请求预留字段，原样透传返回", "example": "reqReserved" }, { "name": "Remark", "type": "string", "required": false, "description": "业务备注", "example": "remark" }, { "name": "AnchorName", "type": "string", "required": false, "description": "主播名称。如果该字段填入，则会对AnchorName和AnchorId/Uid进行校验。", "example": "主播名称" }, { "name": "Uid", "type": "string", "required": false, "description": "主播业务ID（与主播ID不能同时为空，两者都填取主播ID）", "example": "uid" }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "转账结果回调通知URL。若不填，则不进行回调。", "example": "https://123.com" } ], "required": [ "TransferType", "OrderId", "TransferAmount", "AnchorId" ] }, { "name": "CreateTransferBatch", "description": "微信商户发起批量转账", "status": "online", "parameters": [ { "name": "MerchantId", "type": "string", "required": true, "description": "商户号。 示例值：129284394" }, { "name": "TransferDetails", "type": "array", "required": true, "description": "转账明细列表。 发起批量转账的明细列表，最多三千笔", "item_type": "object", "children": [ { "name": "MerchantDetailNo", "type": "string", "required": true, "description": "商家明细单号。 商户系统内部区分转账批次单下不同转账明细单的唯一标识，要求此参数只能由数字、大小写字母组成。 示例值：x23zy545Bd5436" }, { "name": "TransferAmount", "type": "integer", "required": true, "description": "转账金额。 转账金额单位为分。 示例值：200000" }, { "name": "TransferRemark", "type": "string", "required": true, "description": "转账备注。 单条转账备注（微信用户会收到该备注）。UTF8编码，最多32字符。 示例值：2020年4月报销" }, { "name": "OpenId", "type": "string", "required": true, "description": "用户在直连商户下的唯一标识。 示例值：o-MYE42l80oelYMDE34nYD456Xoy" }, { "name": "UserName", "type": "string", "required": true, "description": "收款用户姓名。 收款方姓名。 示例值：张三" } ] }, { "name": "MerchantAppId", "type": "string", "required": true, "description": "直连商户appId。 即商户号绑定的appid。 示例值：wxf636efh567hg4356" }, { "name": "MerchantBatchNo", "type": "string", "required": true, "description": "商家批次单号。 商户系统内部的商家批次单号，此参数只能由数字、字母组成，商户系统内部唯一，UTF8编码，最多32个字符。 示例值：plfk2020042013" }, { "name": "BatchName", "type": "string", "required": true, "description": "批次名称。 批量转账的名称。 示例值：2019年1月深圳分部报销单" }, { "name": "BatchRemark", "type": "string", "required": true, "description": "转账说明。 UTF8编码，最多32个字符。 示例值：2019年深圳分部报销单" }, { "name": "TotalAmount", "type": "integer", "required": true, "description": "转账总金额。 转账金额，单位为分。 示例值：4000000" }, { "name": "TotalNum", "type": "integer", "required": true, "description": "转账总笔数。 一个转账批次最多允许发起三千笔转账。 示例值：200" }, { "name": "Profile", "type": "string", "required": false, "description": "环境名。 release: 现网环境 sandbox: 沙箱环境 development: 开发环境 缺省: release" } ], "required": [ "MerchantId", "TransferDetails", "MerchantAppId", "MerchantBatchNo", "BatchName", "BatchRemark", "TotalAmount", "TotalNum" ] }, { "name": "DeduceQuota", "description": "直播平台-扣减额度", "status": "online", "parameters": [ { "name": "AnchorId", "type": "string", "required": true, "description": "主播ID", "example": "Anchor123" }, { "name": "Amount", "type": "integer", "required": true, "description": "提现金额，单位为\"分\"", "example": "100" }, { "name": "OrderId", "type": "string", "required": true, "description": "外部业务订单号", "example": "OrderId123" } ], "required": [ "AnchorId", "Amount", "OrderId" ] }, { "name": "DeleteAgentTaxPaymentInfo", "description": "直播平台-删除代理商完税信息", "status": "online", "parameters": [ { "name": "BatchNum", "type": "integer", "required": true, "description": "批次号", "example": "1" }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填sandbox", "example": "sandbox" } ], "required": [ "BatchNum" ] }, { "name": "DeleteAgentTaxPaymentInfos", "description": "直播平台-删除代理商完税信息", "status": "online", "parameters": [ { "name": "BatchNum", "type": "integer", "required": true, "description": "批次号", "example": "1" } ], "required": [ "BatchNum" ] }, { "name": "DescribeChargeDetail", "description": "查询充值明细接口", "status": "online", "parameters": [ { "name": "RequestType", "type": "string", "required": true, "description": "请求类型" }, { "name": "MerchantCode", "type": "string", "required": true, "description": "商户号" }, { "name": "PayChannel", "type": "string", "required": true, "description": "支付渠道" }, { "name": "PayChannelSubId", "type": "integer", "required": true, "description": "子渠道" }, { "name": "OrderId", "type": "string", "required": true, "description": "原始交易订单号或者流水号" }, { "name": "BankAccountNumber", "type": "string", "required": true, "description": "父账户账号，资金汇总账号" }, { "name": "AcquiringChannelType", "type": "string", "required": true, "description": "收单渠道类型" }, { "name": "PlatformShortNumber", "type": "string", "required": true, "description": "平台短号(银行分配)" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "聚鑫分配的安全ID" }, { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的支付主MidasAppId" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "计费签名" }, { "name": "TransSequenceNumber", "type": "string", "required": true, "description": "交易流水号" }, { "name": "MidasEnvironment", "type": "string", "required": true, "description": "Midas环境参数" }, { "name": "ReservedMessage", "type": "string", "required": false, "description": "保留域" } ], "required": [ "RequestType", "MerchantCode", "PayChannel", "PayChannelSubId", "OrderId", "BankAccountNumber", "AcquiringChannelType", "PlatformShortNumber", "MidasSecretId", "MidasAppId", "MidasSignature", "TransSequenceNumber", "MidasEnvironment" ] }, { "name": "DescribeOrderStatus", "description": "查询单笔订单交易状态", "status": "online", "parameters": [ { "name": "RequestType", "type": "string", "required": true, "description": "请求类型，此接口固定填：QueryOrderStatusReq" }, { "name": "MerchantCode", "type": "string", "required": true, "description": "商户号" }, { "name": "PayChannel", "type": "string", "required": true, "description": "支付渠道" }, { "name": "PayChannelSubId", "type": "integer", "required": true, "description": "子渠道" }, { "name": "OrderId", "type": "string", "required": true, "description": "交易订单号或流水号，提现，充值或会员交易请求时的CnsmrSeqNo值" }, { "name": "BankAccountNumber", "type": "string", "required": true, "description": "父账户账号，资金汇总账号" }, { "name": "PlatformShortNumber", "type": "string", "required": true, "description": "平台短号(银行分配)" }, { "name": "QueryType", "type": "string", "required": true, "description": "功能标志 0：会员间交易 1：提现 2：充值" }, { "name": "TransSequenceNumber", "type": "string", "required": true, "description": "银行流水号" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "计费签名" }, { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的支付主MidasAppId" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "聚鑫分配的安全ID" }, { "name": "MidasEnvironment", "type": "string", "required": true, "description": "Midas环境参数" }, { "name": "ReservedMessage", "type": "string", "required": false, "description": "保留字段" }, { "name": "BankSubAccountNumber", "type": "string", "required": false, "description": "子账户账号 暂未使用" }, { "name": "TransDate", "type": "string", "required": false, "description": "交易日期 暂未使用" } ], "required": [ "RequestType", "MerchantCode", "PayChannel", "PayChannelSubId", "OrderId", "BankAccountNumber", "PlatformShortNumber", "QueryType", "TransSequenceNumber", "MidasSignature", "MidasAppId", "MidasSecretId", "MidasEnvironment" ] }, { "name": "DistributeAccreditQuery", "description": "云支付-分账授权申请查询接口", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "使用门店OpenId", "example": "f2cc268b9c95fbbb230a19397fe35f8d" }, { "name": "OpenKey", "type": "string", "required": true, "description": "使用门店OpenKey", "example": "e30051d527bd4e621e7090c9392739ec" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey" ] }, { "name": "DistributeAccreditTlinx", "description": "云支付-分账授权申请接口", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "使用门店OpenId", "example": "f2cc268b9c95fbbb230a19397fe35f8d" }, { "name": "OpenKey", "type": "string", "required": true, "description": "使用门店OpenKey", "example": "e30051d527bd4e621e7090c9392739ec" }, { "name": "AuthType", "type": "string", "required": true, "description": "验证方式，传1手机验证(验证码时效60S)传2结算卡验证(时效6小时)，多种方式用逗号隔开", "example": "1" }, { "name": "Percent", "type": "string", "required": false, "description": "分账比例（500=5%）不传默认百分之10", "example": "200" }, { "name": "FullName", "type": "string", "required": false, "description": "营业执照商户全称", "example": "营业执照商户全称测试" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey", "AuthType" ] }, { "name": "DistributeAddReceiver", "description": "云支付-分账添加分账接收方接口", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "使用门店OpenId", "example": "f2cc268b9c95fbbb230a19397fe35f8d" }, { "name": "OpenKey", "type": "string", "required": true, "description": "使用门店OpenKey", "example": "e30051d527bd4e621e7090c9392739ec" }, { "name": "MerchantNo", "type": "string", "required": true, "description": "商户编号", "example": "M0001" }, { "name": "Remark", "type": "string", "required": false, "description": "备注", "example": "备注" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey", "MerchantNo" ] }, { "name": "DistributeApply", "description": "云支付-分账请求接口", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "使用门店OpenId", "example": "f2cc268b9c95fbbb230a19397fe35f8d" }, { "name": "OpenKey", "type": "string", "required": true, "description": "使用门店OpenKey", "example": "e30051d527bd4e621e7090c9392739ec" }, { "name": "OutDistributeNo", "type": "string", "required": true, "description": "商户分账单号", "example": "123" }, { "name": "Details", "type": "array", "required": true, "description": "分账明细", "example": "无", "item_type": "object", "children": [ { "name": "MerchantNo", "type": "string", "required": true, "description": "商户编号", "example": "M0001" }, { "name": "Amount", "type": "string", "required": true, "description": "分账金额", "example": "100" }, { "name": "Remark", "type": "string", "required": false, "description": "备注", "example": "备注" } ] }, { "name": "DeveloperNo", "type": "string", "required": false, "description": "商户交易订单号，和OrderNo二者传其一", "example": "456" }, { "name": "OrderNo", "type": "string", "required": false, "description": "平台交易订单号，和DeveloperNo二者传其一", "example": "789" }, { "name": "Remark", "type": "string", "required": false, "description": "说明", "example": "说明" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey", "OutDistributeNo", "Details" ] }, { "name": "DistributeCancel", "description": "云支付-分账撤销接口", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "使用门店OpenId", "example": "f2cc268b9c95fbbb230a19397fe35f8d" }, { "name": "OpenKey", "type": "string", "required": true, "description": "使用门店OpenKey", "example": "e30051d527bd4e621e7090c9392739ec" }, { "name": "OrderNo", "type": "string", "required": true, "description": "平台交易订单号", "example": "789" }, { "name": "OutDistributeNo", "type": "string", "required": false, "description": "商户分账单号，type为2时，和DistributeNo二者传其一", "example": "123" }, { "name": "DistributeNo", "type": "string", "required": false, "description": "平台分账单号，type为2时，和OutDistributeNo二者传其一", "example": "456" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey", "OrderNo" ] }, { "name": "DistributeQuery", "description": "云支付-分账结果查询接口", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "使用门店OpenId", "example": "f2cc268b9c95fbbb230a19397fe35f8d" }, { "name": "OpenKey", "type": "string", "required": true, "description": "使用门店OpenKey", "example": "e30051d527bd4e621e7090c9392739ec" }, { "name": "Type", "type": "string", "required": true, "description": "查询类型（1-全部，2-单笔）", "example": "1" }, { "name": "OutDistributeNo", "type": "string", "required": false, "description": "商户分账单号，type为2时，和DistributeNo二者传其一", "example": "123" }, { "name": "DistributeNo", "type": "string", "required": false, "description": "平台分账单号，type为2时，和OutDistributeNo二者传其一", "example": "456" }, { "name": "OrderNo", "type": "string", "required": false, "description": "平台交易订单号", "example": "789" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey", "Type" ] }, { "name": "DistributeQueryReceiver", "description": "云支付-查询已添加分账接收方接口", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "使用门店OpenId", "example": "f2cc268b9c95fbbb230a19397fe35f8d" }, { "name": "OpenKey", "type": "string", "required": true, "description": "使用门店OpenKey", "example": "e30051d527bd4e621e7090c9392739ec" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey" ] }, { "name": "DistributeRemoveReceiver", "description": "云支付-分账解除分账接收方接口", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "使用门店OpenId", "example": "f2cc268b9c95fbbb230a19397fe35f8d" }, { "name": "OpenKey", "type": "string", "required": true, "description": "使用门店OpenKey", "example": "e30051d527bd4e621e7090c9392739ec" }, { "name": "MerchantNo", "type": "string", "required": true, "description": "商户编号", "example": "M0001" }, { "name": "Remark", "type": "string", "required": false, "description": "备注", "example": "备注" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey", "MerchantNo" ] }, { "name": "DownloadBill", "description": "账单下载接口，根据本接口返回的URL地址，在D+1日下载对账单。注意，本接口返回的URL地址有时效，请尽快下载。URL超时时效后，请重新调用本接口再次获取。", "status": "online", "parameters": [ { "name": "StateDate", "type": "string", "required": true, "description": "请求下载对账单日期", "example": "20191202" }, { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的MidasAppId", "example": "test_midas_app_id" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "聚鑫分配的SecretId", "example": "your_midas_secret_id" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "使用聚鑫安全密钥计算的签名", "example": "xx" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名: release: 现网环境 sandbox: 沙箱环境 development: 开发环境 缺省: release", "example": "xx" } ], "required": [ "StateDate", "MidasAppId", "MidasSecretId", "MidasSignature" ] }, { "name": "DownloadOrgFile", "description": "云支付-下载机构文件接口", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "收单系统分配的开放ID", "example": "f2cc268b9c95fbbb230a19397fe35f8d" }, { "name": "OpenKey", "type": "string", "required": true, "description": "收单系统分配的密钥", "example": "e30051d527bd4e621e7090c9392739ec" }, { "name": "Storage", "type": "string", "required": false, "description": "存储区域（0私密区，1公共区），请严格按文件要求，上传到不同的区域", "example": "1" }, { "name": "FilePath", "type": "string", "required": false, "description": "文件路径", "example": "201912/eabc9ba6b7a5d577011def3a9f4c5302.png" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey" ] }, { "name": "DownloadReconciliationUrl", "description": "获取对账中心账单下载地址的接口", "status": "online", "parameters": [ { "name": "MainAppId", "type": "string", "required": true, "description": "平台应用ID", "example": "8793784" }, { "name": "AppCode", "type": "string", "required": true, "description": "平台代码", "example": "cpdp_recon12384" }, { "name": "BillDate", "type": "string", "required": true, "description": "账单日期，yyyy-MM-dd", "example": "2021-08-21" }, { "name": "SubAppId", "type": "string", "required": false, "description": "商户或者代理商ID", "example": "9098835664433" } ], "required": [ "MainAppId", "AppCode", "BillDate" ] }, { "name": "ExecuteMemberTransaction", "description": "会员间交易接口", "status": "online", "parameters": [ { "name": "RequestType", "type": "string", "required": true, "description": "请求类型此接口固定填：MemberTransactionReq" }, { "name": "MerchantCode", "type": "string", "required": true, "description": "银行注册商户号" }, { "name": "PayChannel", "type": "string", "required": true, "description": "支付渠道" }, { "name": "PayChannelSubId", "type": "integer", "required": true, "description": "子渠道" }, { "name": "OutTransNetMemberCode", "type": "string", "required": true, "description": "转出交易网会员代码" }, { "name": "OutSubAccountName", "type": "string", "required": true, "description": "转出见证子账户的户名" }, { "name": "InSubAccountName", "type": "string", "required": true, "description": "转入见证子账户的户名" }, { "name": "OutSubAccountNumber", "type": "string", "required": true, "description": "转出子账户账号" }, { "name": "InSubAccountNumber", "type": "string", "required": true, "description": "转入子账户账号" }, { "name": "BankAccountNumber", "type": "string", "required": true, "description": "父账户账号，资金汇总账号" }, { "name": "CurrencyUnit", "type": "string", "required": true, "description": "货币单位 单位，1：元，2：角，3：分" }, { "name": "CurrencyType", "type": "string", "required": true, "description": "币种" }, { "name": "CurrencyAmount", "type": "string", "required": true, "description": "交易金额" }, { "name": "OrderId", "type": "string", "required": true, "description": "订单号" }, { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的支付主MidasAppId" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "聚鑫分配的安全ID" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "计费签名" }, { "name": "TransSequenceNumber", "type": "string", "required": true, "description": "交易流水号 生成方式：用户短号+日期（6位）+ 随机编号（10位）例如：F088722005120904930798 短号：F08872 日期： 200512 随机编号：0904930798" }, { "name": "InTransNetMemberCode", "type": "string", "required": true, "description": "转入交易网会员代码" }, { "name": "MidasEnvironment", "type": "string", "required": true, "description": "Midas环境标识 release 现网环境 sandbox 沙箱环境 development 开发环境" }, { "name": "PlatformShortNumber", "type": "string", "required": false, "description": "平台短号(银行分配)" }, { "name": "TransType", "type": "string", "required": false, "description": "1：下单预支付 2：确认并付款 3：退款 6：直接支付T+1 9：直接支付T+0" }, { "name": "TransFee", "type": "string", "required": false, "description": "交易手续费" }, { "name": "ReservedMessage", "type": "string", "required": false, "description": "保留域" } ], "required": [ "RequestType", "MerchantCode", "PayChannel", "PayChannelSubId", "OutTransNetMemberCode", "OutSubAccountName", "InSubAccountName", "OutSubAccountNumber", "InSubAccountNumber", "BankAccountNumber", "CurrencyUnit", "CurrencyType", "CurrencyAmount", "OrderId", "MidasAppId", "MidasSecretId", "MidasSignature", "TransSequenceNumber", "InTransNetMemberCode", "MidasEnvironment" ] }, { "name": "FreezeFlexBalance", "description": "灵云V2-冻结余额", "status": "online", "parameters": [ { "name": "PayeeId", "type": "string", "required": true, "description": "收款用户ID", "example": "无" }, { "name": "AmountBeforeTax", "type": "string", "required": true, "description": "税前金额", "example": "无" }, { "name": "IncomeType", "type": "string", "required": true, "description": "收入类型 LABOR:劳务所得 OCCASION:偶然所得", "example": "无" }, { "name": "OutOrderId", "type": "string", "required": true, "description": "外部订单ID", "example": "无" }, { "name": "OperationType", "type": "string", "required": true, "description": "操作类型 FREEZE:冻结 UNFREEZE:解冻", "example": "无" }, { "name": "Remark", "type": "string", "required": false, "description": "冻结备注", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 __test__:测试环境 缺省默认为生产环境", "example": "无" } ], "required": [ "PayeeId", "AmountBeforeTax", "IncomeType", "OutOrderId", "OperationType" ] }, { "name": "GetBillDownloadUrl", "description": "调用该接口返回对账单下载地址，对账单下载URL通过GET方式访问，返回zip包，解压后为csv格式文件。文件首行如下： 订单号,订单归属日期,机构编号,订单描述,交易类型,订单状态,支付场景,原始金额,折扣金额,实际交易金额,支付渠道优惠金额,抹零金额,币种,下单时间,付款成功时间,商户编号,门店编号,付款方式编号,付款方式名称,商户手续费T1,商户扣率,是否信用卡交易,原始订单\ufffd...", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "收单系统分配的开放ID", "example": "OpenId123" }, { "name": "OpenKey", "type": "string", "required": true, "description": "收单系统分配的密钥", "example": "OpenKey123" }, { "name": "Day", "type": "string", "required": true, "description": "清算日期（YYYYMMDD，今天传昨天的日期，每日下午1点后出前一日的账单）", "example": "20220322" } ], "required": [ "OpenId", "OpenKey", "Day" ] }, { "name": "GetDistributeBillDownloadUrl", "description": "调用该接口返回对账单下载地址，对账单下载URL通过GET方式访问，返回zip包，解压后为csv格式文件。文件首行如下： 商户号,订单号,支付订单号,分账订单总金额,分账详情（通过|分割每笔明细：商户号1#分账金额1|商户号2#分账金额2）,交易手续费承担方商户号,交易手续费,发起时间,分账状态,结算日期,非交易主体分账金额,商户退款订单号,商户分账单号", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "收单系统分配的开放ID", "example": "OpenId123" }, { "name": "OpenKey", "type": "string", "required": true, "description": "收单系统分配的密钥", "example": "OpenKey123" }, { "name": "Day", "type": "string", "required": true, "description": "分账日期（YYYYMMDD，今天传昨天的日期）", "example": "20220322" } ], "required": [ "OpenId", "OpenKey", "Day" ] }, { "name": "GetPayRollAuth", "description": "务工卡-查询授权关系", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "用户在商户对应appid下的唯一标识", "example": "无" }, { "name": "SubMerchantId", "type": "string", "required": true, "description": "微信服务商下特约商户的商户号，由微信支付生成并下发", "example": "无" }, { "name": "WechatAppId", "type": "string", "required": false, "description": "是服务商在微信申请公众号/小程序或移动应用成功后分配的账号ID（与服务商主体一致） 当输入服务商Appid时，会校验其与服务商商户号的绑定关系。服务商APPID和与特约商户APPID至少输入一个，且必须要有拉起领薪卡小程序时使用的APPID", "example": "无" }, { "name": "WechatSubAppId", "type": "string", "required": false, "description": "特约商户在微信申请公众号/小程序或移动应用成功后分配的账号ID（与特约商户主体一致） 当输入特约商户Appid时，会校验其与特约商户号的绑定关系。服务商APPID和与特约商户APPID至少输入一个，且必须要有拉起领薪卡小程序时使用的APPID", "example": "无" } ], "required": [ "OpenId", "SubMerchantId" ] }, { "name": "GetPayRollAuthList", "description": "务工卡-查询核身记录", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "用户在商户对应appid下的唯一标识", "example": "无" }, { "name": "SubMerchantId", "type": "string", "required": true, "description": "微信服务商下特约商户的商户号，由微信支付生成并下发", "example": "无" }, { "name": "AuthDate", "type": "string", "required": true, "description": "核身日期，一次只能查询一天，最久可查询90天内的记录，格式为YYYY-MM-DD", "example": "无" }, { "name": "Offset", "type": "integer", "required": true, "description": "非负整数，表示该次请求资源的起始位置，从0开始计数", "example": "无" }, { "name": "Limit", "type": "integer", "required": true, "description": "非0非负的整数，该次请求可返回的最大资源条数，默认值为10，最大支持10条", "example": "无" }, { "name": "WechatAppId", "type": "string", "required": false, "description": "是服务商在微信申请公众号/小程序或移动应用成功后分配的账号ID（与服务商主体一致） 当输入服务商Appid时，会校验其与服务商商户号的绑定关系。服务商APPID和与特约商户APPID至少输入一个，且必须要有拉起领薪卡小程序时使用的APPID", "example": "无" }, { "name": "WechatSubAppId", "type": "string", "required": false, "description": "特约商户在微信申请公众号/小程序或移动应用成功后分配的账号ID（与特约商户主体一致） 当输入特约商户Appid时，会校验其与特约商户号的绑定关系。服务商APPID和与特约商户APPID至少输入一个，且必须要有拉起领薪卡小程序时使用的APPID", "example": "无" }, { "name": "AuthStatus", "type": "string", "required": false, "description": "核身状态，列表查询仅提供成功状态的核身记录查询，故此字段固定AUTHENTICATE_SUCCESS即可", "example": "无" } ], "required": [ "OpenId", "SubMerchantId", "AuthDate", "Offset", "Limit" ] }, { "name": "GetPayRollAuthResult", "description": "务工卡-获取核身结果", "status": "online", "parameters": [ { "name": "AuthNumber", "type": "string", "required": true, "description": "商户系统内部的商家核身单号，要求此参数只能由数字、大小写字母组成，在服务商内部唯一", "example": "无" }, { "name": "SubMerchantId", "type": "string", "required": true, "description": "微信服务商下特约商户的商户号，由微信支付生成并下发", "example": "无" } ], "required": [ "AuthNumber", "SubMerchantId" ] }, { "name": "MigrateOrderRefund", "description": "山姆聚合支付项目-存量订单退款接口。可以通过本接口将支付款全部或部分退还给付款方，在收到用户退款请求并且验证成功之后，按照退款规则将支付款按原路退回到支付账号。", "status": "online", "parameters": [ { "name": "MerchantId", "type": "string", "required": true, "description": "商户代码", "example": "cm1111" }, { "name": "PayChannel", "type": "string", "required": true, "description": "支付渠道，ALIPAY对应支付宝渠道；UNIONPAY对应银联渠道", "example": "wxpay" }, { "name": "PayOrderId", "type": "string", "required": true, "description": "正向支付商户订单号", "example": "111" }, { "name": "RefundOrderId", "type": "string", "required": true, "description": "退款订单号，最长64位，仅支持数字、 字母", "example": "out202300001" }, { "name": "RefundAmt", "type": "integer", "required": true, "description": "退款金额，单位：分。备注：改字段必须大于0 和小于10000000000的整数。", "example": "1" }, { "name": "ThirdChannelOrderId", "type": "string", "required": true, "description": "第三方支付机构支付交易号", "example": "454654612213" }, { "name": "PayAmt", "type": "integer", "required": false, "description": "原始支付金额，单位：分。备注：当该字段为空或者为0 时，系统会默认使用订单当 实付金额作为退款金额", "example": "1" }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填 sandbox。", "example": "sandbox" }, { "name": "RefundReason", "type": "string", "required": false, "description": "退款原因", "example": "123" } ], "required": [ "MerchantId", "PayChannel", "PayOrderId", "RefundOrderId", "RefundAmt", "ThirdChannelOrderId" ] }, { "name": "MigrateOrderRefundQuery", "description": "提交退款申请后，通过调用该接口查询退款状态。退款可能有一定延时。", "status": "online", "parameters": [ { "name": "MerchantId", "type": "string", "required": true, "description": "商户号" }, { "name": "PayChannel", "type": "string", "required": true, "description": "支付渠道，ALIPAY对应支付宝渠道；UNIONPAY对应银联渠道" }, { "name": "RefundOrderId", "type": "string", "required": true, "description": "退款订单号，最长64位，仅支持数字、 字母" }, { "name": "TradeSerialNo", "type": "string", "required": true, "description": "退款流水号" }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填 sandbox。" } ], "required": [ "MerchantId", "PayChannel", "RefundOrderId", "TradeSerialNo" ] }, { "name": "ModifyAgentTaxPaymentInfo", "description": "直播平台-修改代理商完税信息", "status": "online", "parameters": [ { "name": "BatchNum", "type": "integer", "required": true, "description": "批次号", "example": "98" }, { "name": "RawElectronicCertUrl", "type": "string", "required": true, "description": "新源电子凭证地址", "example": "https://xxx.com/url" }, { "name": "FileName", "type": "string", "required": false, "description": "新的文件名", "example": "TEST" }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填sandbox", "example": "sandbox" } ], "required": [ "BatchNum", "RawElectronicCertUrl" ] }, { "name": "ModifyBindedAccount", "description": "灵云-重新绑定账号", "status": "online", "parameters": [ { "name": "AnchorId", "type": "string", "required": true, "description": "主播Id", "example": "无" }, { "name": "TransferType", "type": "integer", "required": true, "description": "1 微信企业付款 2 支付宝转账 3 平安银企直连代发转账", "example": "无" }, { "name": "AccountNo", "type": "string", "required": true, "description": "收款方标识。 微信为open_id； 支付宝为会员alipay_user_id; 平安为收款方银行账号;", "example": "无" }, { "name": "PhoneNum", "type": "string", "required": true, "description": "手机号", "example": "无" } ], "required": [ "AnchorId", "TransferType", "AccountNo", "PhoneNum" ] }, { "name": "ModifyFlexFundingAccount", "description": "灵云V2-修改收款用户资金账号信息", "status": "online", "parameters": [ { "name": "PayeeId", "type": "string", "required": true, "description": "收款用户ID", "example": "无" }, { "name": "FundingAccountBindSerialNo", "type": "string", "required": true, "description": "收款用户资金账户ID", "example": "无" }, { "name": "FundingAccountType", "type": "string", "required": true, "description": "资金账户类型 PINGAN_BANK:平安银行", "example": "无" }, { "name": "PhoneNo", "type": "string", "required": true, "description": "收款资金账户手机号", "example": "无" }, { "name": "FundingAccountName", "type": "string", "required": true, "description": "收款资金账户姓名", "example": "无" }, { "name": "FundingAccountNo", "type": "string", "required": true, "description": "收款资金账户号", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 __test__:测试环境 缺省默认为生产环境", "example": "无" }, { "name": "BankBranchName", "type": "string", "required": false, "description": "开户支行名", "example": "无" } ], "required": [ "PayeeId", "FundingAccountBindSerialNo", "FundingAccountType", "PhoneNo", "FundingAccountName", "FundingAccountNo" ] }, { "name": "ModifyFlexPayeeAccountRightStatus", "description": "灵云V2-收款用户账户权益状态修改", "status": "online", "parameters": [ { "name": "PayeeId", "type": "string", "required": true, "description": "收款用户ID", "example": "无" }, { "name": "AccountRightType", "type": "string", "required": true, "description": "账户权益类型 SETTLEMENT:结算权益 PAYMENT:付款权益", "example": "无" }, { "name": "AccountRightStatus", "type": "string", "required": true, "description": "账户权益状态 ENABLE:启用 DISABLE:停用", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 __test__:测试环境 缺省默认为生产环境", "example": "无" } ], "required": [ "PayeeId", "AccountRightType", "AccountRightStatus" ] }, { "name": "ModifyMerchant", "description": "云鉴-商户信息修改的接口", "status": "online", "parameters": [ { "name": "MerchantAppId", "type": "string", "required": true, "description": "进件成功后返给商户的AppId", "example": "1c6f41570498301d85fc4589a5435b54" }, { "name": "MerchantName", "type": "string", "required": true, "description": "收款商户名称", "example": "美亿佳乐购超市" }, { "name": "BusinessPayFlag", "type": "string", "required": true, "description": "B2B 支付标志。是否开通 B2B支付， 1:开通 0:不开通。", "example": "1" } ], "required": [ "MerchantAppId", "MerchantName", "BusinessPayFlag" ] }, { "name": "ModifyMntMbrBindRelateAcctBankCode", "description": "维护会员绑定提现账户联行号。此接口可以支持市场修改会员的提现账户的开户行信息，具体包括开户行行名、开户行的银行联行号（大小额联行号）和超级网银行号。", "status": "online", "parameters": [ { "name": "MrchCode", "type": "string", "required": true, "description": "String(22)，商户号（签约客户号）" }, { "name": "SubAcctNo", "type": "string", "required": true, "description": "STRING(50)，见证子账户的账号" }, { "name": "MemberBindAcctNo", "type": "string", "required": true, "description": "STRING(50)，会员绑定账号" }, { "name": "AcctOpenBranchName", "type": "string", "required": true, "description": "STRING(150)，开户行名称（若大小额行号不填则送超级网银号对应的银行名称，若填大小额行号则送大小额行号对应的银行名称）" }, { "name": "CnapsBranchId", "type": "string", "required": false, "description": "STRING(20)，大小额行号（CnapsBranchId和EiconBankBranchId两者二选一必填）" }, { "name": "EiconBankBranchId", "type": "string", "required": false, "description": "STRING(20)，超级网银行号" }, { "name": "ReservedMsg", "type": "string", "required": false, "description": "STRING(1027)，保留域" }, { "name": "Profile", "type": "string", "required": false, "description": "STRING(12)，接入环境，默认接入沙箱环境。接入正式环境填\"prod\"" } ], "required": [ "MrchCode", "SubAcctNo", "MemberBindAcctNo", "AcctOpenBranchName" ] }, { "name": "QueryAcctBinding", "description": "聚鑫-查询子账户绑定银行卡", "status": "online", "parameters": [ { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的支付主MidasAppId", "example": "your_midas_app_id" }, { "name": "SubAppId", "type": "string", "required": true, "description": "聚鑫计费SubAppId，代表子商户", "example": "your_sub_mch_id" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "由平台客服提供的计费密钥Id", "example": "your_midas_secret_id" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "计费签名", "example": "your_midas_secret_key" }, { "name": "EncryptType", "type": "string", "required": false, "description": "敏感信息加密类型: RSA: rsa非对称加密，使用RSA-PKCS1-v1_5 AES: aes对称加密，使用AES256-CBC-PCKS7padding 缺省: RSA", "example": "RSA" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名: release: 现网环境 sandbox: 沙箱环境 development: 开发环境 缺省: release", "example": "release" } ], "required": [ "MidasAppId", "SubAppId", "MidasSecretId", "MidasSignature" ] }, { "name": "QueryAcctInfo", "description": "聚鑫-开户信息查询", "status": "online", "parameters": [ { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫平台分配的支付MidasAppId" }, { "name": "SubMchId", "type": "string", "required": true, "description": "业务平台的子商户Id，唯一" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "由平台客服提供的计费密钥Id" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "计费签名" }, { "name": "EncryptType", "type": "string", "required": false, "description": "敏感信息加密类型: RSA: rsa非对称加密，使用RSA-PKCS1-v1_5 AES: aes对称加密，使用AES256-CBC-PCKS7padding 缺省: RSA" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名: release: 现网环境 sandbox: 沙箱环境 development: 开发环境 缺省: release" } ], "required": [ "MidasAppId", "SubMchId", "MidasSecretId", "MidasSignature" ] }, { "name": "QueryAcctInfoList", "description": "聚鑫-开户信息列表查询, 查询某一段时间的开户信息", "status": "online", "parameters": [ { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的支付主MidasAppId" }, { "name": "QueryAcctBeginTime", "type": "string", "required": true, "description": "查询开始时间(以开户时间为准)" }, { "name": "QueryAcctEndTime", "type": "string", "required": true, "description": "查询结束时间(以开户时间为准)" }, { "name": "PageOffset", "type": "string", "required": true, "description": "分页号, 起始值为1，每次最多返回20条记录，第二页返回的记录数为第21至40条记录，第三页为41至60条记录，顺序均按照开户时间的先后" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "由平台客服提供的计费密钥Id" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "计费签名" }, { "name": "EncryptType", "type": "string", "required": false, "description": "敏感信息加密类型: RSA: rsa非对称加密，使用RSA-PKCS1-v1_5 AES: aes对称加密，使用AES256-CBC-PCKS7padding 缺省: RSA" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名: release: 现网环境 sandbox: 沙箱环境 development: 开发环境 缺省: release" } ], "required": [ "MidasAppId", "QueryAcctBeginTime", "QueryAcctEndTime", "PageOffset", "MidasSecretId", "MidasSignature" ] }, { "name": "QueryAgentStatements", "description": "直播平台-查询代理商结算单链接", "status": "online", "parameters": [ { "name": "Date", "type": "string", "required": true, "description": "结算单日期，月结算单填每月1日", "example": "2020-05-01" }, { "name": "Type", "type": "string", "required": true, "description": "日结算单:daily 月结算单:monthly", "example": "monthly" } ], "required": [ "Date", "Type" ] }, { "name": "QueryAgentTaxPaymentBatch", "description": "直播平台-查询批次信息", "status": "online", "parameters": [ { "name": "BatchNum", "type": "integer", "required": true, "description": "批次号", "example": "1" }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填sandbox", "example": "sandbox" } ], "required": [ "BatchNum" ] }, { "name": "QueryAnchorContractInfo", "description": "直播平台-查询主播签约信息", "status": "online", "parameters": [ { "name": "BeginTime", "type": "string", "required": true, "description": "起始时间，格式为yyyy-MM-dd", "example": "2020-01-01" }, { "name": "EndTime", "type": "string", "required": true, "description": "起始时间，格式为yyyy-MM-dd", "example": "2020-01-01" } ], "required": [ "BeginTime", "EndTime" ] }, { "name": "QueryApplicationMaterial", "description": "跨境-成功申报材料查询。查询成功入库的申报材料。", "status": "online", "parameters": [ { "name": "DeclareId", "type": "string", "required": true, "description": "申报流水号", "example": "DeclareId" }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填sandbox", "example": "sandbox" } ], "required": [ "DeclareId" ] }, { "name": "QueryAssignment", "description": "直播平台-查询分配关系", "status": "online", "parameters": [ { "name": "AnchorId", "type": "string", "required": true, "description": "主播ID", "example": "无" } ], "required": [ "AnchorId" ] }, { "name": "QueryBalance", "description": "子商户余额查询", "status": "online", "parameters": [ { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的支付主MidasAppId" }, { "name": "SubAppId", "type": "string", "required": true, "description": "聚鑫计费SubAppId，代表子商户" }, { "name": "QueryFlag", "type": "string", "required": true, "description": "2：普通会员子账号 3：功能子账号" }, { "name": "PageOffset", "type": "string", "required": true, "description": "起始值为1，每次最多返回20条记录，第二页返回的记录数为第21至40条记录，第三页为41至60条记录，顺序均按照建立时间的先后" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "聚鑫分配的安全ID" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "按照聚鑫安全密钥计算的签名" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名: release: 现网环境 sandbox: 沙箱环境 development: 开发环境 缺省: release" } ], "required": [ "MidasAppId", "SubAppId", "QueryFlag", "PageOffset", "MidasSecretId", "MidasSignature" ] }, { "name": "QueryBankClear", "description": "查询银行在途清算结果。查询时间段内交易网的在途清算结果。", "status": "online", "parameters": [ { "name": "MrchCode", "type": "string", "required": true, "description": "String(22)，商户号（签约客户号）" }, { "name": "FunctionFlag", "type": "string", "required": true, "description": "STRING(2)，功能标志（1: 全部; 2: 指定时间段）" }, { "name": "PageNum", "type": "string", "required": true, "description": "STRING (10)，页码（起始值为1，每次最多返回20条记录，第二页返回的记录数为第21至40条记录，第三页为41至60条记录，顺序均按照建立时间的先后）" }, { "name": "StartDate", "type": "string", "required": false, "description": "STRING(8)，开始日期（若是指定时间段查询，则必输，当查询全部时，不起作用。格式: 20190101）" }, { "name": "EndDate", "type": "string", "required": false, "description": "STRING(8)，终止日期（若是指定时间段查询，则必输，当查询全部时，不起作用。格式：20190101）" }, { "name": "ReservedMsg", "type": "string", "required": false, "description": "STRING(1027)，保留域" }, { "name": "Profile", "type": "string", "required": false, "description": "STRING(12)，接入环境，默认接入沙箱环境。接入正式环境填\"prod\"" } ], "required": [ "MrchCode", "FunctionFlag", "PageNum" ] }, { "name": "QueryBankTransactionDetails", "description": "查询银行时间段内交易明细。查询时间段的会员成功交易。", "status": "online", "parameters": [ { "name": "MrchCode", "type": "string", "required": true, "description": "String(22)，商户号（签约客户号）" }, { "name": "FunctionFlag", "type": "string", "required": true, "description": "STRING(2)，功能标志（1: 当日; 2: 历史）" }, { "name": "SubAcctNo", "type": "string", "required": true, "description": "STRING(50)，见证子帐户的帐号" }, { "name": "QueryFlag", "type": "string", "required": true, "description": "STRING(4)，查询标志（1: 全部; 2: 转出; 3: 转入 ）" }, { "name": "PageNum", "type": "string", "required": true, "description": "STRING(10)，页码（起始值为1，每次最多返回20条记录，第二页返回的记录数为第21至40条记录，第三页为41至60条记录，顺序均按照建立时间的先后）" }, { "name": "StartDate", "type": "string", "required": false, "description": "STRING(8)，开始日期（若是历史查询，则必输，当日查询时，不起作用。格式：20190101）" }, { "name": "EndDate", "type": "string", "required": false, "description": "STRING(8)，终止日期（若是历史查询，则必输，当日查询时，不起作用。格式：20190101）" }, { "name": "ReservedMsg", "type": "string", "required": false, "description": "STRING(1027)，保留域" }, { "name": "Profile", "type": "string", "required": false, "description": "STRING(12)，接入环境，默认接入沙箱环境。接入正式环境填\"prod\"" } ], "required": [ "MrchCode", "FunctionFlag", "SubAcctNo", "QueryFlag", "PageNum" ] }, { "name": "QueryBankWithdrawCashDetails", "description": "查询银行时间段内清分提现明细。查询银行时间段内清分提现明细接口：若为“见证+收单退款”“见证+收单充值”记录时备注Note为“见证+收单充值,订单号”“见证+收单退款,订单号”，此接口可以查到T0/T1的充值明细和退款记录。查询标志：充值记录仍用3清分选项查询，退款记录同提现用2选项查询。", "status": "online", "parameters": [ { "name": "MrchCode", "type": "string", "required": true, "description": "String(22)，商户号（签约客户号）" }, { "name": "FunctionFlag", "type": "string", "required": true, "description": "STRING(2)，功能标志（1: 当日; 2: 历史）" }, { "name": "SubAcctNo", "type": "string", "required": true, "description": "STRING(50)，见证子帐户的帐号" }, { "name": "QueryFlag", "type": "string", "required": true, "description": "STRING(4)，查询标志（2: 提现; 3: 清分）" }, { "name": "PageNum", "type": "string", "required": true, "description": "STRING(10)，页码（起始值为1，每次最多返回20条记录，第二页返回的记录数为第21至40条记录，第三页为41至60条记录，顺序均按照建立时间的先后）" }, { "name": "BeginDate", "type": "string", "required": false, "description": "STRING(8)，开始日期（若是历史查询，则必输，当日查询时，不起作用。格式：20190101）" }, { "name": "EndDate", "type": "string", "required": false, "description": "STRING(8)，结束日期（若是历史查询，则必输，当日查询时，不起作用。格式：20190101）" }, { "name": "ReservedMsg", "type": "string", "required": false, "description": "STRING(1027)，保留域" }, { "name": "Profile", "type": "string", "required": false, "description": "STRING(12)，接入环境，默认接入沙箱环境。接入正式环境填\"prod\"" } ], "required": [ "MrchCode", "FunctionFlag", "SubAcctNo", "QueryFlag", "PageNum" ] }, { "name": "QueryBatchPaymentResult", "description": "灵云-批量转账结果查询", "status": "online", "parameters": [ { "name": "BatchId", "type": "string", "required": true, "description": "批次号", "example": "无" } ], "required": [ "BatchId" ] }, { "name": "QueryBillDownloadURL", "description": "获取单笔代发转账对账单下载URL", "status": "online", "parameters": [ { "name": "MerchantId", "type": "string", "required": true, "description": "商户号", "example": "faryrong" }, { "name": "TransferType", "type": "integer", "required": true, "description": "代发类型： 1、 微信企业付款 2、 支付宝转账 3、 平安银企直联代发转账", "example": "3" }, { "name": "BillDate", "type": "string", "required": true, "description": "账单日期，格式yyyy-MM-dd", "example": "2020-12-18" } ], "required": [ "MerchantId", "TransferType", "BillDate" ] }, { "name": "QueryCityCode", "description": "云支付-查询城市编码接口", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "收单系统分配的开放ID", "example": "f2cc268b9c95fbbb230a19397fe35f8d" }, { "name": "OpenKey", "type": "string", "required": true, "description": "收单系统分配的密钥", "example": "e30051d527bd4e621e7090c9392739ec" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey" ] }, { "name": "QueryCloudChannelData", "description": "发起支付等渠道操作后，可以调用该接口查询渠道的数据。", "status": "online", "parameters": [ { "name": "MidasAppId", "type": "string", "required": true, "description": "米大师分配的支付主MidasAppId", "example": "无" }, { "name": "OutOrderNo", "type": "string", "required": true, "description": "业务订单号，外部订单号", "example": "无" }, { "name": "ExternalChannelDataType", "type": "string", "required": true, "description": "数据类型 PAYMENT:支付", "example": "无" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "release" }, { "name": "SubAppId", "type": "string", "required": false, "description": "子应用ID", "example": "无" }, { "name": "ChannelOrderId", "type": "string", "required": false, "description": "渠道订单号", "example": "无" }, { "name": "Channel", "type": "string", "required": false, "description": "渠道名称，指定渠道查询 wechat:微信支付", "example": "无" } ], "required": [ "MidasAppId", "OutOrderNo", "ExternalChannelDataType" ] }, { "name": "QueryCloudOrder", "description": "根据订单号或用户ID，查询支付订单状态。", "status": "online", "parameters": [ { "name": "MidasAppId", "type": "string", "required": true, "description": "米大师分配的支付主MidasAppId", "example": "无" }, { "name": "UserId", "type": "string", "required": true, "description": "用户Id，长度不小于5位，仅支持字母和数字的组合", "example": "无" }, { "name": "Type", "type": "string", "required": true, "description": "查询类型 by_order:根据订单号查订单", "example": "无" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "release" }, { "name": "OutTradeNo", "type": "string", "required": false, "description": "开发者的主订单号", "example": "无" } ], "required": [ "MidasAppId", "UserId", "Type" ] }, { "name": "QueryCloudRefundOrder", "description": "提交退款申请后，通过调用该接口查询退款状态。退款可能有一定延时，用微信零钱支付的退款约20分钟内到账，银行卡支付的退款约3个工作日后到账。", "status": "online", "parameters": [ { "name": "MidasAppId", "type": "string", "required": true, "description": "米大师分配的支付主MidasAppId", "example": "无" }, { "name": "UserId", "type": "string", "required": true, "description": "用户Id，长度不小于5位，仅支持字母和数字的组合", "example": "无" }, { "name": "RefundId", "type": "string", "required": true, "description": "退款订单号，仅支持数字、字母、下划线（_）、横杠字符（-）、点（.）的组合", "example": "无" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "release" } ], "required": [ "MidasAppId", "UserId", "RefundId" ] }, { "name": "QueryCommonTransferRecharge", "description": "查询普通转账充值明细。接口用于查询会员主动转账进资金汇总账户的明细情况。若会员使用绑定账号转入，则直接入账到会员子账户。若未使用绑定账号转入，则系统无法自动清分到对应子账户，则转入挂账子账户由平台自行清分。若是 “见证+收单充值”T0充值记录时备注Note为“见证+收单充值,订单号” 此接口可以查到T0到账的“见证+收单充值”充值记录。", "status": "online", "parameters": [ { "name": "MrchCode", "type": "string", "required": true, "description": "String(22)，商户号（签约客户号）" }, { "name": "FunctionFlag", "type": "string", "required": true, "description": "STRING(2)，功能标志（1为查询当日数据，0查询历史数据）" }, { "name": "StartDate", "type": "string", "required": true, "description": "STRING(8)，开始日期（格式：20190101）" }, { "name": "EndDate", "type": "string", "required": true, "description": "STRING(8)，终止日期（格式：20190101）" }, { "name": "PageNum", "type": "string", "required": true, "description": "STRING(10)，页码（起始值为1，每次最多返回20条记录，第二页返回的记录数为第21至40条记录，第三页为41至60条记录，顺序均按照建立时间的先后）" }, { "name": "ReservedMsg", "type": "string", "required": false, "description": "STRING(1027)，保留域" }, { "name": "Profile", "type": "string", "required": false, "description": "STRING(12)，接入环境，默认接入沙箱环境。接入正式环境填\"prod\"" } ], "required": [ "MrchCode", "FunctionFlag", "StartDate", "EndDate", "PageNum" ] }, { "name": "QueryCompanyTitle", "description": "智慧零售-查询公司抬头", "status": "online", "parameters": [ { "name": "CompanyTitleKeyword", "type": "string", "required": true, "description": "公司抬头关键字", "example": "无" }, { "name": "InvoicePlatformId", "type": "integer", "required": true, "description": "开票平台ID。0：高灯，1：票易通", "example": "无" }, { "name": "SellerTaxpayerNum", "type": "string", "required": true, "description": "销方纳税人识别号", "example": "无" }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填sandbox。", "example": "无" } ], "required": [ "CompanyTitleKeyword", "InvoicePlatformId", "SellerTaxpayerNum" ] }, { "name": "QueryContract", "description": "通过此接口查询签约数据", "status": "online", "parameters": [ { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的支付主MidasAppId", "example": "your_midas_app_id" }, { "name": "UserId", "type": "string", "required": true, "description": "用户ID，长度不小于5位，仅支持字母和数字的组合", "example": "your_user_id" }, { "name": "Channel", "type": "string", "required": true, "description": "指定渠道： wechat：微信支付 qqwallet：QQ钱包 bank：网银支付 只有一个渠道时需要指定", "example": "wechat" }, { "name": "ContractQueryMode", "type": "string", "required": true, "description": "枚举值： CONTRACT_QUERY_MODE_BY_OUT_CONTRACT_CODE：按 OutContractCode + ContractSceneId 查询 CONTRACT_QUERY_MODE_BY_CHANNEL_CONTRACT_CODE：按ChannelContractCode查询", "example": "CONTRACT_QUERY_MODE_BY_OUT_CONTRACT_CODE" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "按照聚鑫安全密钥计算的签名", "example": "your_midas_signature" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "聚鑫分配的安全ID", "example": "your_midas_secret_id" }, { "name": "SubAppId", "type": "string", "required": false, "description": "聚鑫计费SubAppId，代表子商户", "example": "your_sub_app_id" }, { "name": "OutContractCode", "type": "string", "required": false, "description": "业务签约合同协议号 当 ContractQueryMode=CONTRACT_QUERY_MODE_BY_OUT_CONTRACT_CODE 时 ，必填", "example": "your_out_contract_code" }, { "name": "ContractSceneId", "type": "string", "required": false, "description": "签约场景ID，当 ContractQueryMode=CONTRACT_QUERY_MODE_BY_OUT_CONTRACT_CODE 时 必填，在米大师侧托管后生成", "example": "your_contract_scene_id" }, { "name": "ChannelContractCode", "type": "string", "required": false, "description": "米大师生成的协议号 ，当 ContractQueryMode=CONTRACT_QUERY_MODE_BY_CHANNEL_CONTRACT_CODE 时必填", "example": "your_channel_contract_code" }, { "name": "ExternalContractData", "type": "string", "required": false, "description": "第三方渠道合约数据，为json字符串，与特定渠道有关", "example": "{\\\"plan_id\\\":\\\"10086\\\",\\\"contract_code\\\":\\\"C11111111000001\\\",\\\"w" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名: release: 现网环境 sandbox: 沙箱环境 development: 开发环境 缺省: release", "example": "your_midas_environment" }, { "name": "UserType", "type": "string", "required": false, "description": "USER_ID: 用户ID ANONYMOUS: 匿名类型 USER_ID 默认值为 USER_ID", "example": "USER_ID" }, { "name": "MigrateMode", "type": "string", "required": false, "description": "签约代扣穿透查询存量数据迁移模式", "example": "MigrateMode_CONTRACT_MIGRATE_MODE_NO" }, { "name": "ContractMethod", "type": "string", "required": false, "description": "签约方式", "example": "CONTRACT_METHOD_WECHAT_JSAPI" } ], "required": [ "MidasAppId", "UserId", "Channel", "ContractQueryMode", "MidasSignature", "MidasSecretId" ] }, { "name": "QueryContractPayFee", "description": "云支付-查询支付方式费率及自定义表单项接口", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "收单系统分配的开放ID", "example": "f2cc268b9c95fbbb230a19397fe35f8d" }, { "name": "OpenKey", "type": "string", "required": true, "description": "收单系统分配的密钥", "example": "e30051d527bd4e621e7090c9392739ec" }, { "name": "PaymentId", "type": "string", "required": true, "description": "支付方式编号", "example": "21" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey", "PaymentId" ] }, { "name": "QueryContractPayWayList", "description": "云支付-查询合同支付方式列表接口", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "收单系统分配的开放ID", "example": "f2cc268b9c95fbbb230a19397fe35f8d" }, { "name": "OpenKey", "type": "string", "required": true, "description": "收单系统分配的密钥", "example": "e30051d527bd4e621e7090c9392739ec" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey" ] }, { "name": "QueryContractRelateShop", "description": "云支付-查询合同可关联门店接口", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "收单系统分配的开放ID", "example": "f2cc268b9c95fbbb230a19397fe35f8d" }, { "name": "OpenKey", "type": "string", "required": true, "description": "收单系统分配的密钥", "example": "e30051d527bd4e621e7090c9392739ec" }, { "name": "ContractId", "type": "string", "required": true, "description": "合同主键", "example": "C0001" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey", "ContractId" ] }, { "name": "QueryCustAcctIdBalance", "description": "查询银行子账户余额。查询会员子账户以及平台的功能子账户的余额。", "status": "online", "parameters": [ { "name": "MrchCode", "type": "string", "required": true, "description": "String(22)，商户号（签约客户号）" }, { "name": "QueryFlag", "type": "string", "required": true, "description": "STRING(4)，查询标志（2: 普通会员子账号; 3: 功能子账号）" }, { "name": "PageNum", "type": "string", "required": true, "description": "STRING(10)，页码（起始值为1，每次最多返回20条记录，第二页返回的记录数为第21至40条记录，第三页为41至60条记录，顺序均按照建立时间的先后）" }, { "name": "SubAcctNo", "type": "string", "required": false, "description": "STRING(50)，见证子账户的账号（若SelectFlag为2时，子账号必输）" }, { "name": "ReservedMsg", "type": "string", "required": false, "description": "STRING(1027)，保留域" }, { "name": "Profile", "type": "string", "required": false, "description": "STRING(12)，接入环境，默认接入沙箱环境。接入正式环境填\"prod\"" } ], "required": [ "MrchCode", "QueryFlag", "PageNum" ] }, { "name": "QueryDownloadBillURL", "description": "云鉴-查询对账单下载地址的接口", "status": "online", "parameters": [ { "name": "MerchantAppId", "type": "string", "required": true, "description": "分配给商户的AppId。进件成功后返给商户方的AppId。", "example": "1c6f41570498301d85fc4589a5435b54" }, { "name": "ChannelCode", "type": "string", "required": true, "description": "渠道编号。固定值：ZSB2B", "example": "ZSB2B" }, { "name": "BillDate", "type": "string", "required": true, "description": "对账单日期，格式yyyyMMdd", "example": "20211012" } ], "required": [ "MerchantAppId", "ChannelCode", "BillDate" ] }, { "name": "QueryExceedingInfo", "description": "灵云-查询超额信息", "status": "online", "parameters": [ { "name": "TimeStr", "type": "string", "required": true, "description": "超额日期。格式为yyyy-MM-dd。", "example": "2022-01-01" }, { "name": "Dimension", "type": "string", "required": false, "description": "维度。目前支持三个维度: AGENT, ANCHOR, ORDER。不填默认使用AGENT维度。", "example": "AGENT" }, { "name": "PageNumber", "type": "object", "required": false, "description": "分页信息。不填默认Index为1，Count为100。", "example": "无", "children": [ { "name": "Index", "type": "integer", "required": true, "description": "页码" }, { "name": "Count", "type": "integer", "required": true, "description": "页长" } ] } ], "required": [ "TimeStr" ] }, { "name": "QueryExchangeRate", "description": "跨境-查询汇率", "status": "online", "parameters": [ { "name": "SourceCurrency", "type": "string", "required": true, "description": "源币种 (默认CNY)", "example": "CNY" }, { "name": "TargetCurrency", "type": "string", "required": false, "description": "目的币种 (见常见问题-汇出币种)", "example": "TargetCurrency" }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填sandbox", "example": "sandbox" } ], "required": [ "SourceCurrency" ] }, { "name": "QueryFinancialDataUrl", "description": "财税-查询金融数据文件下载链接", "status": "online", "parameters": [ { "name": "EndTime", "type": "string", "required": true, "description": "数据查询范围:结束时间 yyyy-MM-dd HH:mm:ss", "example": "无" }, { "name": "StartTime", "type": "string", "required": true, "description": "数据查询范围:开始时间 yyyy-MM-dd HH:mm:ss", "example": "无" }, { "name": "DataType", "type": "string", "required": true, "description": "数据类型：ADDED_INVOICE_REPORT 增值税开票数据，NATURAL_FINANCE_REPORT 自然人金融数据, NATURAL_FINANCE_REPORT_BY_TIME 按次报税数据导出, NATURAL_FINANCE_REPORT_STAT_BY_DAY 按日累计报税数据导出", "example": "无" } ], "required": [ "EndTime", "StartTime", "DataType" ] }, { "name": "QueryFlexAmountBeforeTax", "description": "灵云V2-查询税前金额", "status": "online", "parameters": [ { "name": "PayeeId", "type": "string", "required": true, "description": "收款用户ID", "example": "无" }, { "name": "IncomeType", "type": "string", "required": true, "description": "收入类型 LABOR:劳务所得 OCCASION:偶然所得", "example": "无" }, { "name": "AmountAfterTax", "type": "string", "required": true, "description": "税后金额", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 __test__:测试环境 缺省默认为生产环境", "example": "无" } ], "required": [ "PayeeId", "IncomeType", "AmountAfterTax" ] }, { "name": "QueryFlexBillDownloadUrl", "description": "灵云V2-查询对账单文件下载链接", "status": "online", "parameters": [ { "name": "BillDate", "type": "string", "required": true, "description": "对账单日期", "example": "无" }, { "name": "BillType", "type": "string", "required": true, "description": "对账单类型：FREEZE, SETTLEMENT,PAYMENT", "example": "无" }, { "name": "ServiceProviderId", "type": "string", "required": false, "description": "服务商ID，如不填则查询平台级别对账单文件", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 __test__:测试环境 缺省默认为生产环境", "example": "无" } ], "required": [ "BillDate", "BillType" ] }, { "name": "QueryFlexFreezeOrderList", "description": "灵云V2-查询冻结订单列表", "status": "online", "parameters": [ { "name": "PayeeId", "type": "string", "required": true, "description": "收款用户ID", "example": "无" }, { "name": "OperationType", "type": "string", "required": true, "description": "操作类型 FREEZE:冻结 UNFREEZE:解冻", "example": "无" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，格式\"yyyy-MM-dd hh:mm:ss\"", "example": "无" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，格式\"yyyy-MM-dd hh:mm:ss\"", "example": "无" }, { "name": "PageNumber", "type": "object", "required": true, "description": "分页", "example": "无", "children": [ { "name": "Index", "type": "integer", "required": true, "description": "页码" }, { "name": "Count", "type": "integer", "required": true, "description": "页长" } ] }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 __test__:测试环境 缺省默认为生产环境", "example": "无" } ], "required": [ "PayeeId", "OperationType", "StartTime", "EndTime", "PageNumber" ] }, { "name": "QueryFlexOrderSummaryList", "description": "灵云V2-订单汇总列表查询", "status": "online", "parameters": [ { "name": "SummaryDate", "type": "string", "required": true, "description": "汇总日期:yyyy-MM-dd", "example": "无" }, { "name": "PageNumber", "type": "object", "required": true, "description": "分页", "example": "无", "children": [ { "name": "Index", "type": "integer", "required": true, "description": "页码" }, { "name": "Count", "type": "integer", "required": true, "description": "页长" } ] }, { "name": "OrderType", "type": "string", "required": true, "description": "汇总订单类型:FREEZE, SETTLEMENT,PAYMENT", "example": "无" }, { "name": "PayeeId", "type": "string", "required": false, "description": "收款用户ID", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 __test__:测试环境 缺省默认为生产环境", "example": "无" } ], "required": [ "SummaryDate", "PageNumber", "OrderType" ] }, { "name": "QueryFlexPayeeAccountBalance", "description": "灵云V2-收款用户账户余额查询", "status": "online", "parameters": [ { "name": "PayeeId", "type": "string", "required": true, "description": "收款用户ID", "example": "无" }, { "name": "IncomeType", "type": "string", "required": true, "description": "收入类型 LABOR:劳务所得 OCCASION:偶然所得", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 __test__:测试环境 缺省默认为生产环境", "example": "无" }, { "name": "SnapshotDate", "type": "string", "required": false, "description": "快照日期。格式yyyy-MM-dd", "example": "无" } ], "required": [ "PayeeId", "IncomeType" ] }, { "name": "QueryFlexPayeeAccountInfo", "description": "灵云V2-收款用户账户信息查询", "status": "online", "parameters": [ { "name": "PayeeId", "type": "string", "required": false, "description": "收款用户ID", "example": "无" }, { "name": "OutUserId", "type": "string", "required": false, "description": "外部用户ID", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 __test__:测试环境 缺省默认为生产环境", "example": "无" } ], "required": [] }, { "name": "QueryFlexPayeeAccountList", "description": "灵云V2-收款用户账户列表查询", "status": "online", "parameters": [ { "name": "PropertyInfo", "type": "object", "required": true, "description": "账户属性信息", "example": "无", "children": [ { "name": "SettleRightStatus", "type": "string", "required": false, "description": "结算权益状态 ENABLE:启用 DISABLE:停用 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "PaymentRightStatus", "type": "string", "required": false, "description": "付款权益状态 ENABLE:启用 DISABLE:停用 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间", "example": "无" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间", "example": "无" }, { "name": "PageNumber", "type": "object", "required": false, "description": "分页", "example": "无", "children": [ { "name": "Index", "type": "integer", "required": true, "description": "页码" }, { "name": "Count", "type": "integer", "required": true, "description": "页长" } ] }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 __test__:测试环境 缺省默认为生产环境", "example": "无" } ], "required": [ "PropertyInfo" ] }, { "name": "QueryFlexPayeeInfo", "description": "灵云V2-收款用户信息查询", "status": "online", "parameters": [ { "name": "PayeeId", "type": "string", "required": false, "description": "收款用户ID", "example": "无" }, { "name": "OutUserId", "type": "string", "required": false, "description": "外部用户ID", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 __test__:测试环境 缺省默认为生产环境", "example": "无" } ], "required": [] }, { "name": "QueryFlexPaymentOrderList", "description": "灵云V2-查询付款订单列表", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，格式\"yyyy-MM-dd hh:mm:ss\"", "example": "无" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，格式\"yyyy-MM-dd hh:mm:ss\"", "example": "无" }, { "name": "PageNumber", "type": "object", "required": true, "description": "分页", "example": "无", "children": [ { "name": "Index", "type": "integer", "required": true, "description": "页码" }, { "name": "Count", "type": "integer", "required": true, "description": "页长" } ] }, { "name": "PayeeId", "type": "string", "required": false, "description": "收款用户ID", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 __test__:测试环境 缺省默认为生产环境", "example": "无" } ], "required": [ "StartTime", "EndTime", "PageNumber" ] }, { "name": "QueryFlexPaymentOrderStatus", "description": "灵云V2-查询付款订单状态", "status": "online", "parameters": [ { "name": "OutOrderId", "type": "string", "required": false, "description": "外部订单ID", "example": "无" }, { "name": "OrderId", "type": "string", "required": false, "description": "订单ID", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 __test__:测试环境 缺省默认为生产环境", "example": "无" } ], "required": [] }, { "name": "QueryFlexPlatformAccountBalance", "description": "灵云V2-平台账户余额查询", "status": "online", "parameters": [ { "name": "IncomeType", "type": "string", "required": true, "description": "收入类型 LABOR:劳务所得 OCCASION:偶然所得", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 __test__:测试环境 缺省默认为生产环境", "example": "无" }, { "name": "SnapshotDate", "type": "string", "required": false, "description": "快照日期。格式yyyy-MM-dd", "example": "无" } ], "required": [ "IncomeType" ] }, { "name": "QueryFlexServiceProviderAccountBalance", "description": "灵云V2-查询服务商账户余额", "status": "online", "parameters": [ { "name": "ServiceProviderId", "type": "string", "required": true, "description": "服务商ID", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 __test__:测试环境 缺省默认为生产环境", "example": "无" } ], "required": [ "ServiceProviderId" ] }, { "name": "QueryFlexSettlementOrderList", "description": "灵云V2-查询结算订单列表", "status": "online", "parameters": [ { "name": "PayeeId", "type": "string", "required": true, "description": "收款用户ID", "example": "无" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，格式\"yyyy-MM-dd hh:mm:ss\"", "example": "无" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，格式\"yyyy-MM-dd hh:mm:ss\"", "example": "无" }, { "name": "PageNumber", "type": "object", "required": true, "description": "分页", "example": "无", "children": [ { "name": "Index", "type": "integer", "required": true, "description": "页码" }, { "name": "Count", "type": "integer", "required": true, "description": "页长" } ] }, { "name": "OperationType", "type": "string", "required": false, "description": "操作类型。 ENABLE_SETTLE: 正常结算 DISABLE_SETTLE: 停用结算 UNFREEZE_SETTLE: 解冻结算 若需要支持多个操作类型，则以;分隔", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 __test__:测试环境 缺省默认为生产环境", "example": "无" } ], "required": [ "PayeeId", "StartTime", "EndTime", "PageNumber" ] }, { "name": "QueryFlexWechatAuthResult", "description": "查询微工卡核身结果", "status": "online", "parameters": [ { "name": "AuthNo", "type": "string", "required": true, "description": "商户核身单号", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 test 测试 release 生产 sandbox 沙箱", "example": "无" } ], "required": [ "AuthNo" ] }, { "name": "QueryFundsTransactionDetails", "description": "聚鑫-查询会员资金交易信息列表", "status": "online", "parameters": [ { "name": "QueryDateType", "type": "string", "required": true, "description": "查询的交易发生时间类型。 __1__：当日 __2__：历史", "example": "1" }, { "name": "QueryTranType", "type": "string", "required": true, "description": "查询的交易类型。 __2__：提现/退款 __3__：清分/充值", "example": "1" }, { "name": "BankAccountNumber", "type": "string", "required": true, "description": "父账户账号。 _平安渠道为资金汇总账号_", "example": "无" }, { "name": "SubAccountNumber", "type": "string", "required": true, "description": "子账户账号。 _平安渠道为见证子账户的账号_", "example": "无" }, { "name": "PageOffSet", "type": "string", "required": true, "description": "分页号, 起始值为1。", "example": "1" }, { "name": "QueryStartDate", "type": "string", "required": false, "description": "查询开始日期，格式：yyyyMMdd。 __若是历史查询，则必输，当日查询时，不起作用；开始日期不能超过当前日期__", "example": "20220222" }, { "name": "QueryEndDate", "type": "string", "required": false, "description": "查询终止日期，格式：yyyyMMdd。 __若是历史查询，则必输，当日查询时，不起作用；终止日期不能超过当前日期__", "example": "22220222" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名。 __release__: 现网环境 __sandbox__: 沙箱环境 __development__: 开发环境 _缺省: release_", "example": "release" } ], "required": [ "QueryDateType", "QueryTranType", "BankAccountNumber", "SubAccountNumber", "PageOffSet" ] }, { "name": "QueryInvoice", "description": "智慧零售-发票查询", "status": "online", "parameters": [ { "name": "InvoicePlatformId", "type": "integer", "required": true, "description": "开票平台ID 0 : 高灯 1 : 票易通", "example": "1" }, { "name": "OrderId", "type": "string", "required": true, "description": "订单号", "example": "test123456" }, { "name": "OrderSn", "type": "string", "required": false, "description": "业务开票号", "example": "NULL" }, { "name": "IsRed", "type": "integer", "required": false, "description": "发票种类： 0：蓝票 1：红票【该字段默认为0， 如果需要查询红票信息，本字段必须传1，否则可能查询不到需要的发票信息】。", "example": "NULL" }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填sandbox。", "example": "NULL" }, { "name": "InvoiceChannel", "type": "integer", "required": false, "description": "开票渠道。0：线上渠道，1：线下渠道。不填默认为线上渠道", "example": "NULL" }, { "name": "SellerTaxpayerNum", "type": "string", "required": false, "description": "当渠道为线下渠道时，必填", "example": "NULL" } ], "required": [ "InvoicePlatformId", "OrderId" ] }, { "name": "QueryInvoiceV2", "description": "智慧零售-发票查询V2", "status": "online", "parameters": [ { "name": "InvoicePlatformId", "type": "integer", "required": true, "description": "开票平台ID 0 : 高灯 1 : 票易通", "example": "1" }, { "name": "OrderId", "type": "string", "required": true, "description": "订单号", "example": "test123456" }, { "name": "IsRed", "type": "integer", "required": false, "description": "发票种类： 0：蓝票 1：红票【该字段默认为0， 如果需要查询红票信息，本字段必须传1，否则可能查询不到需要的发票信息】。", "example": "NULL" }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填sandbox。", "example": "NULL" }, { "name": "InvoiceChannel", "type": "integer", "required": false, "description": "开票渠道。0：线上渠道，1：线下渠道。不填默认为线上渠道", "example": "NULL" }, { "name": "SellerTaxpayerNum", "type": "string", "required": false, "description": "当渠道为线下渠道时，必填", "example": "NULL" } ], "required": [ "InvoicePlatformId", "OrderId" ] }, { "name": "QueryMaliciousRegistration", "description": "商户恶意注册接口", "status": "online", "parameters": [ { "name": "MerchantId", "type": "string", "required": true, "description": "商户ID，调用方使用的商户号信息，与商户主体一一对应", "example": "无" }, { "name": "MerchantName", "type": "string", "required": true, "description": "商户名称", "example": "无" }, { "name": "CompanyName", "type": "string", "required": true, "description": "企业工商注册标准名称", "example": "无" }, { "name": "RegAddress", "type": "string", "required": true, "description": "注册地址", "example": "无" }, { "name": "RegTime", "type": "integer", "required": true, "description": "商户进件Unix时间，单位秒（非企业注册工商时间)", "example": "无" }, { "name": "USCI", "type": "string", "required": false, "description": "统一社会信用代码", "example": "无" }, { "name": "RegNumber", "type": "string", "required": false, "description": "工商注册码，匹配优先级为Usci\u003eRegNumber\u003eCompanyName", "example": "无" }, { "name": "EncryptedPhoneNumber", "type": "string", "required": false, "description": "手机号码32位MD5加密结果，全大写，格式为0086-13812345678", "example": "无" }, { "name": "EncryptedEmailAddress", "type": "string", "required": false, "description": "邮箱32位MD5加密结果，全大写", "example": "无" }, { "name": "EncryptedPersonId", "type": "string", "required": false, "description": "身份证MD5加密结果，最后一位x大写", "example": "无" }, { "name": "Ip", "type": "string", "required": false, "description": "填写信息设备的IP地址", "example": "无" }, { "name": "Channel", "type": "string", "required": false, "description": "进件渠道号，客户自行编码即可", "example": "无" } ], "required": [ "MerchantId", "MerchantName", "CompanyName", "RegAddress", "RegTime" ] }, { "name": "QueryMemberBind", "description": "会员绑定信息查询。查询标志为“单个会员”的情况下，返回该会员的有效的绑定账户信息。 查询标志为“全部会员”的情况下，返回市场下的全部的有效的绑定账户信息。查询标志为“单个会员的证件信息”的情况下，返回市场下的指定的会员的留存在电商见证宝系统的证件信息。", "status": "online", "parameters": [ { "name": "MrchCode", "type": "string", "required": true, "description": "String(22)，商户号（签约客户号）" }, { "name": "QueryFlag", "type": "string", "required": true, "description": "STRING(4)，查询标志（1: 全部会员; 2: 单个会员; 3: 单个会员的证件信息）" }, { "name": "PageNum", "type": "string", "required": true, "description": "STRING (10)，页码（起始值为1，每次最多返回20条记录，第二页返回的记录数为第21至40条记录，第三页为41至60条记录，顺序均按照建立时间的先后）" }, { "name": "SubAcctNo", "type": "string", "required": false, "description": "STRING(50)，见证子账户的账号（若SelectFlag为2或3时，子账户账号必输）" }, { "name": "ReservedMsg", "type": "string", "required": false, "description": "STRING(1027)，保留域" }, { "name": "Profile", "type": "string", "required": false, "description": "STRING(12)，接入环境，默认接入沙箱环境。接入正式环境填\"prod\"" } ], "required": [ "MrchCode", "QueryFlag", "PageNum" ] }, { "name": "QueryMemberTransaction", "description": "会员间交易-不验证。此接口可以实现会员间的余额的交易，实现资金在会员之间流动。", "status": "online", "parameters": [ { "name": "MrchCode", "type": "string", "required": true, "description": "String(22)，商户号（签约客户号）" }, { "name": "FunctionFlag", "type": "string", "required": true, "description": "STRING(2)，功能标志（1: 下单预支付; 2: 确认并付款; 3: 退款; 6: 直接支付T+1; 9: 直接支付T+0）" }, { "name": "OutSubAcctNo", "type": "string", "required": true, "description": "STRING(50)，转出方的见证子账户的账号（付款方）" }, { "name": "OutMemberCode", "type": "string", "required": true, "description": "STRING(32)，转出方的交易网会员代码" }, { "name": "OutSubAcctName", "type": "string", "required": true, "description": "STRING(150)，转出方的见证子账户的户名（户名是绑卡时上送的账户名称，如果未绑卡，就送OpenCustAcctId接口上送的用户昵称UserNickname）" }, { "name": "InSubAcctNo", "type": "string", "required": true, "description": "STRING(50)，转入方的见证子账户的账号（收款方）" }, { "name": "InMemberCode", "type": "string", "required": true, "description": "STRING(32)，转入方的交易网会员代码" }, { "name": "InSubAcctName", "type": "string", "required": true, "description": "STRING(150)，转入方的见证子账户的户名（户名是绑卡时上送的账户名称，如果未绑卡，就送OpenCustAcctId接口上送的用户昵称UserNickname）" }, { "name": "TranAmt", "type": "string", "required": true, "description": "STRING(20)，交易金额" }, { "name": "TranFee", "type": "string", "required": true, "description": "STRING(20)，交易费用（平台收取交易费用）" }, { "name": "TranType", "type": "string", "required": true, "description": "STRING(20)，交易类型（01: 普通交易）" }, { "name": "Ccy", "type": "string", "required": true, "description": "STRING(3)，币种（默认: RMB）" }, { "name": "OrderNo", "type": "string", "required": false, "description": "STRING(50)，订单号（功能标志为1,2,3时必输）" }, { "name": "OrderContent", "type": "string", "required": false, "description": "STRING(500)，订单内容" }, { "name": "Remark", "type": "string", "required": false, "description": "STRING(300)，备注（建议可送订单号，可在对账文件的备注字段获取到）" }, { "name": "ReservedMsg", "type": "string", "required": false, "description": "STRING(1027)，保留域（若需短信验证码则此项必输短信指令号）" }, { "name": "WebSign", "type": "string", "required": false, "description": "STRING(300)，网银签名（若需短信验证码则此项必输）" }, { "name": "Profile", "type": "string", "required": false, "description": "STRING(12)，接入环境，默认接入沙箱环境。接入正式环境填\"prod\"" } ], "required": [ "MrchCode", "FunctionFlag", "OutSubAcctNo", "OutMemberCode", "OutSubAcctName", "InSubAcctNo", "InMemberCode", "InSubAcctName", "TranAmt", "TranFee", "TranType", "Ccy" ] }, { "name": "QueryMemberTransactionDetails", "description": "聚鑫-查询会员间交易信息列表", "status": "online", "parameters": [ { "name": "QueryDateType", "type": "string", "required": true, "description": "查询的交易发生时间类型。 __1__：当日 __2__：历史", "example": "1" }, { "name": "QueryTranType", "type": "string", "required": true, "description": "查询的交易类型。 __1__：全部 __2__：转出 __3__：转入", "example": "1" }, { "name": "BankAccountNumber", "type": "string", "required": true, "description": "父账户账号。 _平安渠道为资金汇总账号_", "example": "无" }, { "name": "SubAccountNumber", "type": "string", "required": true, "description": "子账户账号。 _平安渠道为见证子账户的账号_", "example": "无" }, { "name": "PageOffSet", "type": "string", "required": true, "description": "分页号, 起始值为1。", "example": "1" }, { "name": "QueryStartDate", "type": "string", "required": false, "description": "查询开始日期，格式：yyyyMMdd。 __若是历史查询，则必输，当日查询时，不起作用；开始日期不能超过当前日期__", "example": "20220222" }, { "name": "QueryEndDate", "type": "string", "required": false, "description": "查询终止日期，格式：yyyyMMdd。 __若是历史查询，则必输，当日查询时，不起作用；终止日期不能超过当前日期__", "example": "22220222" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名。 __release__: 现网环境 __sandbox__: 沙箱环境 __development__: 开发环境 _缺省: release_", "example": "release" } ], "required": [ "QueryDateType", "QueryTranType", "BankAccountNumber", "SubAccountNumber", "PageOffSet" ] }, { "name": "QueryMerchant", "description": "云鉴-商户信息查询接口", "status": "online", "parameters": [ { "name": "MerchantAppId", "type": "string", "required": true, "description": "进件成功后返给商户方的 AppId", "example": "1c6f41570498301d85fc4589a5435b54" } ], "required": [ "MerchantAppId" ] }, { "name": "QueryMerchantBalance", "description": "跨境-对接方账户余额查询", "status": "online", "parameters": [ { "name": "Currency", "type": "string", "required": true, "description": "余额币种", "example": "Currency" }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填sandbox", "example": "sandbox" } ], "required": [ "Currency" ] }, { "name": "QueryMerchantClassification", "description": "云支付-查询商户分类接口", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "收单系统分配的开放ID", "example": "f2cc268b9c95fbbb230a19397fe35f8d" }, { "name": "OpenKey", "type": "string", "required": true, "description": "收单系统分配的密钥", "example": "e30051d527bd4e621e7090c9392739ec" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey" ] }, { "name": "QueryMerchantInfoForManagement", "description": "智慧零售-查询管理端商户", "status": "online", "parameters": [ { "name": "InvoicePlatformId", "type": "integer", "required": true, "description": "开票平台ID", "example": "0" }, { "name": "Offset", "type": "integer", "required": true, "description": "页码", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "页大小", "example": "10" }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填sandbox。", "example": "sandbox" } ], "required": [ "InvoicePlatformId", "Offset", "Limit" ] }, { "name": "QueryMerchantOrder", "description": "云鉴-消费订单查询接口", "status": "online", "parameters": [ { "name": "MerchantAppId", "type": "string", "required": true, "description": "进件成功后返给商户方的AppId。", "example": "1c6f41570498301d85fc4589a5435b54" }, { "name": "OrderNo", "type": "string", "required": true, "description": "平台流水号。平台唯一订单号。", "example": "847f33d665d83eecaf0a8805a2ee6c7a" } ], "required": [ "MerchantAppId", "OrderNo" ] }, { "name": "QueryMerchantPayWayList", "description": "商户查询已开通的支付方式列表", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "使用门店OpenId", "example": "5fb33938bb819024b8ed719edf221840" }, { "name": "OpenKey", "type": "string", "required": true, "description": "使用门店OpenKey", "example": "e95bffc38504f0ac408c27d61eb52d1a" }, { "name": "PayType", "type": "string", "required": true, "description": "支付类型，逗号分隔。1-现金，2-主扫，3-被扫，4-JSAPI。", "example": "2" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey", "PayType" ] }, { "name": "QueryOpenBankBankAccountBalance", "description": "云企付-子商户银行卡余额查询", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "云企付渠道商户号。外部接入平台入驻云企付平台后下发。", "example": "CM28698939401" }, { "name": "ChannelSubMerchantId", "type": "string", "required": true, "description": "云企付渠道子商户号。入驻在渠道商户下的子商户ID，如付款方的商户ID，对应创建支付订单中接口参数中的PayerInfo中的payerId。", "example": "sub1w00001" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称。 __TENPAY__: 商企付 __WECHAT__: 微信支付 __ALIPAY__: 支付宝", "example": "TENPAY" }, { "name": "PaymentMethod", "type": "string", "required": true, "description": "支付方式，如 __EBANK_PAYMENT__:ebank付款 __OPENBANK_PAYMENT__: openbank付款", "example": "OPENBANK_PAYMENT" }, { "name": "BindSerialNo", "type": "string", "required": true, "description": "绑卡序列号，银行账户唯一ID，区分多卡或多账户的场景", "example": "10232043567" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 release:生产环境 sandbox:沙箱环境 缺省默认为生产环境", "example": "sandbox" } ], "required": [ "ChannelMerchantId", "ChannelSubMerchantId", "ChannelName", "PaymentMethod", "BindSerialNo" ] }, { "name": "QueryOpenBankBankBranchList", "description": "云企付-查询联行号", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户ID。", "example": "CM28698939401" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称。 __TENPAY__: 商企付 __WECHAT__: 微信支付 __ALIPAY__: 支付宝", "example": "TENPAY" }, { "name": "PaymentMethod", "type": "string", "required": true, "description": "支付方式。 __EBANK_PAYMENT__:ebank付款 __OPENBANK_PAYMENT__: openbank付款", "example": "OPENBANK_PAYMENT" }, { "name": "BankBranchName", "type": "string", "required": true, "description": "支行名称。", "example": "10232043567" }, { "name": "BankAbbreviation", "type": "string", "required": true, "description": "银行简称。", "example": "CMB/CITIC/ICBC/OTHERS" }, { "name": "PageNumber", "type": "object", "required": true, "description": "页码。Index和Count必须大于等于1。Count建议不超过100。", "example": "无", "children": [ { "name": "Index", "type": "integer", "required": true, "description": "页码" }, { "name": "Count", "type": "integer", "required": true, "description": "页长" } ] }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "sandbox" } ], "required": [ "ChannelMerchantId", "ChannelName", "PaymentMethod", "BankBranchName", "BankAbbreviation", "PageNumber" ] }, { "name": "QueryOpenBankBillDataPage", "description": "云企付-分页查询对账单数据", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户号，外部接入平台方入驻云企付平台后下发。 EBANK_PAYMENT支付方式下，填写渠道商户号； SAFT_ISV支付方式下，填写渠道子商户号; HELIPAY渠道下，填写渠道子商户号。", "example": "CM20348565901" }, { "name": "BillDate", "type": "string", "required": true, "description": "账单日期,yyyy-MM-dd。", "example": "2020-10-07" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称。详见附录-云企付枚举类说明-ChannelName。 __TENPAY__: 商企付 __WECHAT__: 微信支付 __ALIPAY__: 支付宝 HELIPAY：合利宝", "example": "TENPAY" }, { "name": "PageNo", "type": "integer", "required": true, "description": "分页页码。", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页大小，最大1000。", "example": "20" }, { "name": "BillType", "type": "string", "required": false, "description": "账单类型，默认交易账单。", "example": "TRADE" }, { "name": "PaymentMethod", "type": "string", "required": false, "description": "支付方式。详见附录-云企付枚举类说明-PaymentMethod。", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "无" } ], "required": [ "ChannelMerchantId", "BillDate", "ChannelName", "PageNo", "PageSize" ] }, { "name": "QueryOpenBankBindExternalSubMerchantBankAccount", "description": "云企付-子商户银行卡绑定结果查询", "status": "online", "parameters": [ { "name": "ChannelSubMerchantId", "type": "string", "required": true, "description": "渠道子商户ID。", "example": "无" }, { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户ID。", "example": "无" }, { "name": "ChannelApplyId", "type": "string", "required": false, "description": "渠道申请编号，与外部申请编号二者选填其一。", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "无" }, { "name": "OutApplyId", "type": "string", "required": false, "description": "外部申请编号，与渠道申请编号二者选填其一。", "example": "无" } ], "required": [ "ChannelSubMerchantId", "ChannelMerchantId" ] }, { "name": "QueryOpenBankDailyReceiptDownloadUrl", "description": "云企付-按日期批量查询回单下载地址", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "云企付渠道商户号。外部接入平台入驻云企付平台后下发。", "example": "CM28698939401" }, { "name": "ChannelSubMerchantId", "type": "string", "required": true, "description": "云企付渠道子商户号。入驻在渠道商户下的子商户ID，如付款方的商户ID，对应创建支付订单中接口参数中的PayerInfo中的payerId。", "example": "sub1w00001" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称。 __TENPAY__: 商企付 __WECHAT__: 微信支付 __ALIPAY__: 支付宝", "example": "TENPAY" }, { "name": "PaymentMethod", "type": "string", "required": true, "description": "付款方式。如 __EBANK_PAYMENT__:ebank付款 __OPENBANK_PAYMENT__: openbank付款", "example": "OPENBANK_PAYMENT" }, { "name": "BindSerialNo", "type": "string", "required": true, "description": "绑卡序列号，银行卡唯一标记，资金账户ID，用于区分商户绑定多卡或多账户场景", "example": "10232043567" }, { "name": "QueryDate", "type": "string", "required": true, "description": "查询日期，D日查询D-1日的回单文件", "example": "2020-01-11" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 release:生产环境 sandbox:沙箱环境 缺省默认为生产环境", "example": "sandbox" } ], "required": [ "ChannelMerchantId", "ChannelSubMerchantId", "ChannelName", "PaymentMethod", "BindSerialNo", "QueryDate" ] }, { "name": "QueryOpenBankDownLoadUrl", "description": "云企付-查询对账单下载地址", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户号，外部接入平台方入驻云企付平台后下发。 EBANK_PAYMENT支付方式下，填写渠道商户号； SAFT_ISV支付方式下，填写渠道子商户号。", "example": "CM20348565901" }, { "name": "BillDate", "type": "string", "required": true, "description": "账单日期,yyyy-MM-dd。", "example": "2020-10-07" }, { "name": "BillType", "type": "string", "required": false, "description": "账单类型，默认交易账单。", "example": "TRADE" }, { "name": "Environment", "type": "string", "required": false, "description": "接入环境。沙箱环境填 sandbox。缺省默认调用生产环境。", "example": "沙箱环境sandbox" }, { "name": "ChannelName", "type": "string", "required": false, "description": "渠道名称。不填默认为商企付。 __TENPAY__: 商企付 __WECHAT__: 微信支付 __ALIPAY__: 支付宝", "example": "TENPAY" }, { "name": "PaymentMethod", "type": "string", "required": false, "description": "支付方式。不填默认为ebank支付。 __EBANK_PAYMENT__: ebank支付 __OPENBANK_PAYMENT__: openbank支付 __SAFT_ISV__: 人资ISV支付", "example": "ALIPAY" } ], "required": [ "ChannelMerchantId", "BillDate" ] }, { "name": "QueryOpenBankExternalSubAccountBookBalance", "description": "第三方子商户电子记账本余额查询接口", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户ID", "example": "CM834794323" }, { "name": "ChannelSubMerchantId", "type": "string", "required": true, "description": "渠道子商户ID", "example": "CMS43432323" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称。目前只支持支付宝 __TENPAY__: 商企付 __WECHAT__: 微信支付 __ALIPAY__: 支付宝", "example": "ALIPAY" }, { "name": "PaymentMethod", "type": "string", "required": true, "description": "支付方式。目前只支持安心发支付 __EBANK_PAYMENT__: ebank支付 __OPENBANK_PAYMENT__: openbank支付 __SAFT_ISV__: 安心发支付", "example": "SAFT_ISV" }, { "name": "OutAccountBookId", "type": "string", "required": false, "description": "外部账本号ID。与ChannelAccountBookId二者选填其一。", "example": "OUT948944" }, { "name": "ChannelAccountBookId", "type": "string", "required": false, "description": "渠道账本号ID。与OutAccountBookId二者选填其一。", "example": "CAB947894" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "无" } ], "required": [ "ChannelMerchantId", "ChannelSubMerchantId", "ChannelName", "PaymentMethod" ] }, { "name": "QueryOpenBankExternalSubMerchantBankAccount", "description": "云企付-子商户银行卡列表查询", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户ID。", "example": "无" }, { "name": "ChannelSubMerchantId", "type": "string", "required": true, "description": "渠道子商户ID。", "example": "无" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称。 __TENPAY__: 商企付 __WECHAT__: 微信支付 __ALIPAY__: 支付宝", "example": "TENPAY" }, { "name": "PaymentMethod", "type": "string", "required": true, "description": "支付方式。 __EBANK_PAYMENT__: ebank支付 __OPENBANK_PAYMENT__: openbank支付", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "无" } ], "required": [ "ChannelMerchantId", "ChannelSubMerchantId", "ChannelName", "PaymentMethod" ] }, { "name": "QueryOpenBankExternalSubMerchantRegistration", "description": "云企付-子商户进件结果查询", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户号。", "example": "无" }, { "name": "ChannelRegistrationNo", "type": "string", "required": false, "description": "渠道进件号，与外部进件号二者选填其一。", "example": "无" }, { "name": "OutRegistrationNo", "type": "string", "required": false, "description": "外部进件号，与渠道进件号二者选填其一。", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "无" } ], "required": [ "ChannelMerchantId" ] }, { "name": "QueryOpenBankOrderDetailReceiptInfo", "description": "云企付-单笔交易回单申请结果查询", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户ID", "example": "无" }, { "name": "ChannelSubMerchantId", "type": "string", "required": true, "description": "渠道子商户ID", "example": "无" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称，目前只支持ALIPAY", "example": "ALIPAY" }, { "name": "PaymentMethod", "type": "string", "required": true, "description": "支付方式，目前只支持SAFT_ISV", "example": "SAFT_ISV" }, { "name": "OutApplyId", "type": "string", "required": false, "description": "外部回单申请ID，与渠道回单申请ID二者选填其一", "example": "无" }, { "name": "ChannelApplyId", "type": "string", "required": false, "description": "渠道回单申请ID，与外部回单申请ID二者选填其一", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "无" } ], "required": [ "ChannelMerchantId", "ChannelSubMerchantId", "ChannelName", "PaymentMethod" ] }, { "name": "QueryOpenBankPaymentOrder", "description": "云企付-查询订单支付结果", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户号。外部接入平台入驻云企付平台下发。", "example": "CM8950112001" }, { "name": "OutOrderId", "type": "string", "required": true, "description": "外部商户订单号。与ChannelOrderId不能同时为空。若传空串即表示忽略该参数。", "example": "202022167824350112001" }, { "name": "ChannelOrderId", "type": "string", "required": true, "description": "云平台订单号。与OutOrderId不能同时为空。若调用下单接口时，发生异常，无法取到ChannelOrderId，传空串即可", "example": "202022167824350112001" }, { "name": "Environment", "type": "string", "required": false, "description": "接入环境。沙箱环境填 sandbox。缺省默认调用生产环境。", "example": "沙箱环境sandbox" } ], "required": [ "ChannelMerchantId", "OutOrderId", "ChannelOrderId" ] }, { "name": "QueryOpenBankProfitSharePayee", "description": "云企付-绑定分账收款方查询", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户号。代理商/集团ID", "example": "无" }, { "name": "ChannelSubMerchantId", "type": "string", "required": false, "description": "渠道子商户号。商户ID", "example": "无" }, { "name": "AccountId", "type": "string", "required": false, "description": "分账方绑定添加返回的AccountId，账户号和账户ID选其一", "example": "无" }, { "name": "AccountNo", "type": "string", "required": false, "description": "银行账户号要与绑定收款方时保持一致，账户号AccountNo和账户AccoutId选其一", "example": "无" }, { "name": "Currency", "type": "string", "required": false, "description": "使用账户号时必选", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "接入环境。沙箱环境填 sandbox。缺省默认调用生产环境", "example": "无" } ], "required": [ "ChannelMerchantId" ] }, { "name": "QueryOpenBankRefundOrder", "description": "云企付-退款结果查询", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户号。", "example": "CM702312111196" }, { "name": "OutRefundId", "type": "string", "required": false, "description": "外部商户退单号，与渠道退款单号二者选填其一。", "example": "R202002011200001" }, { "name": "ChannelRefundId", "type": "string", "required": false, "description": "渠道退款订单号，与外部商户退款单号二者选填其一。", "example": "R202002011200001" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "无" } ], "required": [ "ChannelMerchantId" ] }, { "name": "QueryOpenBankSettleOrder", "description": "云企付-结算单查询结果", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户号", "example": "无" }, { "name": "ChannelSubMerchantId", "type": "string", "required": false, "description": "渠道子商户号", "example": "无" }, { "name": "OutSettleId", "type": "string", "required": false, "description": "外部结算流水号，与渠道结算流水号二选一", "example": "无" }, { "name": "ChannelSettleId", "type": "string", "required": false, "description": "渠道结算流水号，与外部结算流水号二选一", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "接入环境。沙箱环境填 sandbox。缺省默认调用生产环境", "example": "无" } ], "required": [ "ChannelMerchantId" ] }, { "name": "QueryOpenBankSubMerchantCredential", "description": "云企付-子商户资质文件查询", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户ID。", "example": "无" }, { "name": "ChannelSubMerchantId", "type": "string", "required": true, "description": "渠道子商户ID。", "example": "无" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称。详见附录-枚举类型-ChannelName。", "example": "无" }, { "name": "PaymentMethod", "type": "string", "required": false, "description": "支付方式。 合利宝渠道不需要传。", "example": "无" }, { "name": "OutApplyId", "type": "string", "required": false, "description": "外部申请流水号。 外部申请流水号与渠道申请流水号两者选填其一。", "example": "无" }, { "name": "ChannelApplyId", "type": "string", "required": false, "description": "渠道申请流水号。 外部申请流水号与渠道申请流水号两者选填其一。", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "无" } ], "required": [ "ChannelMerchantId", "ChannelSubMerchantId", "ChannelName" ] }, { "name": "QueryOpenBankSubMerchantRateConfigure", "description": "云企付-子商户费率配置结果查询", "status": "online", "parameters": [ { "name": "ChannelRegistrationNo", "type": "string", "required": true, "description": "渠道进件序列号。", "example": "R123456" }, { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户ID。", "example": "CM123456" }, { "name": "ChannelSubMerchantId", "type": "string", "required": true, "description": "渠道子商户ID。", "example": "CM345678" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称。详见附录-云企付枚举类说明-ChannelName。 TENPAY: 商企付 WECHAT: 微信支付 ALIPAY: 支付宝 HELIPAY:合利宝", "example": "HELIPAY" }, { "name": "ChannelProductFeeNo", "type": "string", "required": false, "description": "渠道产品费率序列号。与外部产品费率序列号二者选填其一。", "example": "P123456" }, { "name": "OutProductFeeNo", "type": "string", "required": false, "description": "外部产品费率序列号。与渠道产品费率序列号二者选填其一。", "example": "P345678" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "无" } ], "required": [ "ChannelRegistrationNo", "ChannelMerchantId", "ChannelSubMerchantId", "ChannelName" ] }, { "name": "QueryOpenBankSubMerchantSignOnline", "description": "子商户在线签约查询", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户号。外部平台接入云企付平台下发。必填。", "example": "无" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称。详见附录-枚举类型-ChannelName。", "example": "无" }, { "name": "OutSubMerchantId", "type": "string", "required": false, "description": "外部子商户ID。", "example": "无" }, { "name": "ChannelSubMerchantId", "type": "string", "required": false, "description": "渠道子商户ID。", "example": "无" } ], "required": [ "ChannelMerchantId", "ChannelName" ] }, { "name": "QueryOpenBankSupportBankList", "description": "云企付-查询支持银行列表", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户ID。", "example": "CM28698939401" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称。 __TENPAY__: 商企付 __WECHAT__: 微信支付 __ALIPAY__: 支付宝", "example": "TENPAY" }, { "name": "PaymentMethod", "type": "string", "required": true, "description": "支付方式。 __EBANK_PAYMENT__:ebank付款 __OPENBANK_PAYMENT__: openbank付款", "example": "OPENBANK_PAYMENT" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "sandbox" } ], "required": [ "ChannelMerchantId", "ChannelName", "PaymentMethod" ] }, { "name": "QueryOpenBankUnbindExternalSubMerchantBankAccount", "description": "云企付-子商户银行卡解绑结果查询", "status": "online", "parameters": [ { "name": "ChannelSubMerchantId", "type": "string", "required": true, "description": "渠道子商户ID。", "example": "无" }, { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户ID。", "example": "无" }, { "name": "ChannelApplyId", "type": "string", "required": false, "description": "渠道申请编号，与外部申请编号二者选填其一。", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "无" }, { "name": "OutApplyId", "type": "string", "required": false, "description": "外部申请编号，与渠道申请编号二者选填其一。", "example": "无" } ], "required": [ "ChannelSubMerchantId", "ChannelMerchantId" ] }, { "name": "QueryOpenBankVerificationOrder", "description": "云企付-查询核销订单状态，客户可以使用该接口来查询核销申请的订单状态。目前仅支持TENPAY渠道EBANK_PAYMENT付款方式的担保支付订单查询。", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "云企付渠道商户号。外部接入平台入驻云企付平台后下发。", "example": "CM20209324350112001" }, { "name": "ChannelVerificationId", "type": "string", "required": false, "description": "云企付渠道核销订单号。与OutVerificationId不能同时为空。", "example": "678920209324350112001" }, { "name": "OutVerificationId", "type": "string", "required": false, "description": "外部核销申请订单号。与ChannelVerificationId不能同时为空。", "example": "20209324350112001" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "无" } ], "required": [ "ChannelMerchantId" ] }, { "name": "QueryOrder", "description": "根据订单号，或者用户Id，查询支付订单状态", "status": "online", "parameters": [ { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的支付主 MidasAppId", "example": "your_midas_app_id" }, { "name": "UserId", "type": "string", "required": true, "description": "用户ID，长度不小于5位， 仅支持字母和数字的组合", "example": "your_user_id" }, { "name": "Type", "type": "string", "required": true, "description": "type=by_order根据订单号 查订单； type=by_user根据用户id 查订单 。", "example": "by_order" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "聚鑫分配的安全ID", "example": "your_midas_secret_id" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "按照聚鑫安全密钥计算的签名", "example": "MidasSignature" }, { "name": "Count", "type": "integer", "required": false, "description": "每页返回的记录数。根据用户 号码查询订单列表时需要传。 用于分页展示。Type=by_order时必填", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "记录数偏移量，默认从0开 始。根据用户号码查询订单列 表时需要传。用于分页展示。Type=by_order时必填", "example": "1" }, { "name": "StartTime", "type": "string", "required": false, "description": "查询开始时间，Unix时间戳。Type=by_order时必填", "example": "1652768614" }, { "name": "EndTime", "type": "string", "required": false, "description": "查询结束时间，Unix时间戳。Type=by_order时必填", "example": "1652768614" }, { "name": "OutTradeNo", "type": "string", "required": false, "description": "业务订单号，OutTradeNo与 TransactionId不能同时为 空，都传优先使用 OutTradeNo", "example": "your_order_no" }, { "name": "TransactionId", "type": "string", "required": false, "description": "聚鑫订单号，OutTradeNo与 TransactionId不能同时为 空，都传优先使用 OutTradeNo", "example": "your_order_no" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名: release: 现网环境 sandbox: 沙箱环境 development: 开发环境 缺省: release", "example": "release" } ], "required": [ "MidasAppId", "UserId", "Type", "MidasSecretId", "MidasSignature" ] }, { "name": "QueryOrderStatus", "description": "云支付-查询订单付款状态", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "使用门店OpenId", "example": "5fb33938bb819024b8ed719edf221840" }, { "name": "OpenKey", "type": "string", "required": true, "description": "使用门店OpenKey", "example": "e95bffc38504f0ac408c27d61eb52d1a" }, { "name": "DeveloperNo", "type": "string", "required": true, "description": "开发者流水号", "example": "TEST00000111" }, { "name": "OrderNo", "type": "string", "required": false, "description": "付款订单号", "example": "9163238193244046880658645" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey", "DeveloperNo" ] }, { "name": "QueryOutwardOrder", "description": "跨境-查询汇出结果", "status": "online", "parameters": [ { "name": "TransactionId", "type": "string", "required": true, "description": "对接方汇出指令编号", "example": "TransactionId" }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填sandbox", "example": "sandbox" } ], "required": [ "TransactionId" ] }, { "name": "QueryPayerInfo", "description": "跨境-付款人查询", "status": "online", "parameters": [ { "name": "PayerId", "type": "string", "required": true, "description": "付款人ID", "example": "PayerId" }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填sandbox", "example": "sandbox" } ], "required": [ "PayerId" ] }, { "name": "QueryReconciliationDocument", "description": "查询对账文件信息。平台调用该接口获取需下载对账文件的文件名称以及密钥。 平台获取到信息后， 可以再调用OPENAPI的文件下载功能。", "status": "online", "parameters": [ { "name": "MrchCode", "type": "string", "required": true, "description": "String(22)，商户号" }, { "name": "FileType", "type": "string", "required": true, "description": "STRING(10)，文件类型（充值文件-CZ; 提现文件-TX; 交易文件-JY; 余额文件-YE; 合约文件-HY）" }, { "name": "FileDate", "type": "string", "required": true, "description": "STRING(8)，文件日期（格式：20190101）" }, { "name": "ReservedMsg", "type": "string", "required": false, "description": "STRING(1027)，保留域" }, { "name": "Profile", "type": "string", "required": false, "description": "STRING(12)，接入环境，默认接入沙箱环境。接入正式环境填\"prod\"" } ], "required": [ "MrchCode", "FileType", "FileDate" ] }, { "name": "QueryReconciliationFileApplyInfo", "description": "聚鑫-查询对账文件申请结果", "status": "online", "parameters": [ { "name": "ApplyFileId", "type": "string", "required": true, "description": "申请对账文件的任务ID。", "example": "无" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名。 __release__: 现网环境 __sandbox__: 沙箱环境 __development__: 开发环境 _缺省: release_", "example": "release" } ], "required": [ "ApplyFileId" ] }, { "name": "QueryRefund", "description": "提交退款申请后，通过调用该接口查询退款状态。退款可能有一定延时，用微信零钱支付的退款约20分钟内到账，银行卡支付的退款约3个工作日后到账。", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": true, "description": "用户ID，长度不小于5位，仅支持字母和数字的组合。", "example": "your_user_id" }, { "name": "RefundId", "type": "string", "required": true, "description": "退款订单号，仅支持数字、字母、下划线（_）、横杠字符（-）、点（.）的组合。", "example": "refund_id_000001" }, { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的支付主MidasAppId", "example": "your_midas_app_id" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "聚鑫分配的安全ID", "example": "your_midas_secret_id" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "按照聚鑫安全密钥计算的签名", "example": "your_midas_signature" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名: release: 现网环境 sandbox: 沙箱环境 development: 开发环境 缺省: release", "example": "xx" } ], "required": [ "UserId", "RefundId", "MidasAppId", "MidasSecretId", "MidasSignature" ] }, { "name": "QueryShopOpenId", "description": "云支付-获取门店OpenId接口", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "收单系统分配的开放ID", "example": "f2cc268b9c95fbbb230a19397fe35f8d" }, { "name": "OpenKey", "type": "string", "required": true, "description": "收单系统分配的密钥", "example": "e30051d527bd4e621e7090c9392739ec" }, { "name": "ShopNo", "type": "string", "required": true, "description": "门店编号", "example": "TestS115" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey", "ShopNo" ] }, { "name": "QuerySinglePaymentResult", "description": "灵云-单笔转账结果查询", "status": "online", "parameters": [ { "name": "TransferType", "type": "integer", "required": true, "description": "转账类型", "example": "无" }, { "name": "TradeSerialNo", "type": "string", "required": false, "description": "交易流水流水号，唯一", "example": "无" }, { "name": "OrderId", "type": "string", "required": false, "description": "订单号，与TradeSerialNo不能同时为空", "example": "无" } ], "required": [ "TransferType" ] }, { "name": "QuerySingleTransactionStatus", "description": "查询银行单笔交易状态。查询单笔交易的状态。", "status": "online", "parameters": [ { "name": "MrchCode", "type": "string", "required": true, "description": "String(22)，商户号（签约客户号）" }, { "name": "FunctionFlag", "type": "string", "required": true, "description": "STRING(2)，功能标志（2: 会员间交易; 3: 提现; 4: 充值）" }, { "name": "TranNetSeqNo", "type": "string", "required": true, "description": "STRING(52)，交易网流水号（提现，充值或会员交易请求时的CnsmrSeqNo值）" }, { "name": "SubAcctNo", "type": "string", "required": false, "description": "STRING(50)，见证子帐户的帐号（未启用）" }, { "name": "TranDate", "type": "string", "required": false, "description": "STRING(8)，交易日期（未启用）" }, { "name": "ReservedMsg", "type": "string", "required": false, "description": "STRING(1027)，保留域" }, { "name": "Profile", "type": "string", "required": false, "description": "STRING(12)，接入环境，默认接入沙箱环境。接入正式环境填\"prod\"" } ], "required": [ "MrchCode", "FunctionFlag", "TranNetSeqNo" ] }, { "name": "QuerySmallAmountTransfer", "description": "查询小额鉴权转账结果。查询小额往账鉴权的转账状态。", "status": "online", "parameters": [ { "name": "MrchCode", "type": "string", "required": true, "description": "String(22)，商户号（签约客户号）" }, { "name": "OldTranSeqNo", "type": "string", "required": true, "description": "STRING(52)，原交易流水号（小额鉴权交易请求时的CnsmrSeqNo值）" }, { "name": "TranDate", "type": "string", "required": true, "description": "STRING(8)，交易日期（格式：20190101）" }, { "name": "ReservedMsg", "type": "string", "required": false, "description": "STRING(1027)，保留域" }, { "name": "Profile", "type": "string", "required": false, "description": "STRING(12)，接入环境，默认接入沙箱环境。接入正式环境填\"prod\"" } ], "required": [ "MrchCode", "OldTranSeqNo", "TranDate" ] }, { "name": "QueryTrade", "description": "跨境-贸易材料明细查询。", "status": "online", "parameters": [ { "name": "TradeFileId", "type": "string", "required": true, "description": "贸易材料流水号", "example": "TradeFileId" }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填sandbox", "example": "sandbox" } ], "required": [ "TradeFileId" ] }, { "name": "QueryTransferBatch", "description": "通过商家批次单号或者微信批次号查询批次单", "status": "online", "parameters": [ { "name": "MerchantId", "type": "string", "required": true, "description": "商户号。 示例值：129284394" }, { "name": "NeedQueryDetail", "type": "boolean", "required": true, "description": "微信明细单号。 微信区分明细单返回的唯一标识。 示例值：1030000071100999991182020050700019480101" }, { "name": "MerchantBatchNo", "type": "string", "required": false, "description": "商家批次单号。 商户系统内部的商家批次单号，此参数只能由数字、字母组成，商户系统内部唯一，UTF8编码，最多32个字符。 示例值：plfk2020042013" }, { "name": "BatchId", "type": "string", "required": false, "description": "是否查询账单明细。 true-是； false-否，默认否。 商户可选择是否查询指定状态的转账明细单，当转账批次单状态为“FINISHED”（已完成）时，才会返回满足条件的转账明细单。 示例值：true" }, { "name": "Profile", "type": "string", "required": false, "description": "环境名: release: 现网环境 sandbox: 沙箱环境 development: 开发环境 缺省: release" }, { "name": "Offset", "type": "integer", "required": false, "description": "请求资源起始位置。 从0开始，默认值为0。 示例值：20" }, { "name": "Limit", "type": "integer", "required": false, "description": "最大资源条数。 该次请求可返回的最大资源（转账明细单）条数，最小20条，最大100条，不传则默认20条。不足20条按实际条数返回 示例值：20" }, { "name": "DetailStatus", "type": "string", "required": false, "description": "明细状态。 ALL：全部，需要同时查询转账成功喝失败的明细单； SUCCESS：转账成功，只查询成功的明细单； FAIL：转账失败，只查询转账失败的明细单。 示例值：FAIL" } ], "required": [ "MerchantId", "NeedQueryDetail" ] }, { "name": "QueryTransferDetail", "description": "通过商家或者微信批次明细单号查询明细单", "status": "online", "parameters": [ { "name": "MerchantId", "type": "string", "required": true, "description": "商户号。 示例值：129284394" }, { "name": "MerchantBatchNo", "type": "string", "required": false, "description": "商家批次单号。 商户系统内部的商家批次单号，此参数只能由数字、字母组成，商户系统内部唯一，UTF8编码，最多32个字符。 示例值：plfk2020042013" }, { "name": "MerchantDetailNo", "type": "string", "required": false, "description": "商家明细单号。 商户系统内部的商家明细单号 示例值：plfk2020042013" }, { "name": "BatchId", "type": "string", "required": false, "description": "微信批次单号。 微信商家转账系统返回的唯一标识。 商家单号（包含批次号和明细单号）和微信单号（包含批次号和明细单号）二者必填其一。 示例值：1030000071100999991182020050700019480001" }, { "name": "DetailId", "type": "string", "required": false, "description": "微信明细单号。 微信区分明细单返回的唯一标识。 示例值：1030000071100999991182020050700019480001" }, { "name": "Profile", "type": "string", "required": false, "description": "环境名: release: 现网环境 sandbox: 沙箱环境 development: 开发环境 缺省: release" } ], "required": [ "MerchantId" ] }, { "name": "QueryTransferResult", "description": "智能代发-单笔代发转账查询接口", "status": "online", "parameters": [ { "name": "MerchantId", "type": "string", "required": true, "description": "商户号", "example": "xx" }, { "name": "MerchantAppId", "type": "string", "required": true, "description": "申请商户号的appid或者商户号绑定的appid", "example": "xx" }, { "name": "TransferType", "type": "integer", "required": true, "description": "1、 微信企业付款 2、 支付宝转账 3、 平安银企直联代发转账", "example": "0" }, { "name": "TradeSerialNo", "type": "string", "required": false, "description": "交易流水流水号（与 OrderId 不能同时为空）", "example": "xx" }, { "name": "OrderId", "type": "string", "required": false, "description": "订单号（与 TradeSerialNo 不能同时为空）", "example": "xx" }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填sandbox。", "example": "sandbox" } ], "required": [ "MerchantId", "MerchantAppId", "TransferType" ] }, { "name": "RechargeByThirdPay", "description": "会员在途充值(经第三方支付渠道)接口", "status": "online", "parameters": [ { "name": "RequestType", "type": "string", "required": true, "description": "请求类型 此接口固定填：MemberRechargeThirdPayReq" }, { "name": "MerchantCode", "type": "string", "required": true, "description": "商户号" }, { "name": "PayChannel", "type": "string", "required": true, "description": "支付渠道" }, { "name": "PayChannelSubId", "type": "integer", "required": true, "description": "子渠道" }, { "name": "OrderId", "type": "string", "required": true, "description": "交易订单号" }, { "name": "BankAccountNumber", "type": "string", "required": true, "description": "父账户账号，资金汇总账号" }, { "name": "PlatformShortNumber", "type": "string", "required": true, "description": "平台短号(银行分配)" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "聚鑫分配的安全ID" }, { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的支付主MidasAppId" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "计费签名" }, { "name": "TransSequenceNumber", "type": "string", "required": true, "description": "交易流水号" }, { "name": "BankSubAccountNumber", "type": "string", "required": true, "description": "子账户账号" }, { "name": "TransFee", "type": "string", "required": true, "description": "交易手续费，以元为单位" }, { "name": "ThirdPayChannel", "type": "string", "required": true, "description": "第三方支付渠道类型 0001-微信 0002-支付宝 0003-京东支付" }, { "name": "ThirdPayChannelMerchantCode", "type": "string", "required": true, "description": "第三方渠道商户号" }, { "name": "ThirdPayChannelOrderId", "type": "string", "required": true, "description": "第三方渠道订单号或流水号" }, { "name": "CurrencyAmount", "type": "string", "required": true, "description": "交易金额" }, { "name": "CurrencyUnit", "type": "string", "required": true, "description": "单位，1：元，2：角，3：分" }, { "name": "CurrencyType", "type": "string", "required": true, "description": "币种" }, { "name": "TransNetMemberCode", "type": "string", "required": true, "description": "交易网会员代码" }, { "name": "MidasEnvironment", "type": "string", "required": true, "description": "midas环境参数" }, { "name": "ReservedMessage", "type": "string", "required": false, "description": "保留域" }, { "name": "Remark", "type": "string", "required": false, "description": "备注" } ], "required": [ "RequestType", "MerchantCode", "PayChannel", "PayChannelSubId", "OrderId", "BankAccountNumber", "PlatformShortNumber", "MidasSecretId", "MidasAppId", "MidasSignature", "TransSequenceNumber", "BankSubAccountNumber", "TransFee", "ThirdPayChannel", "ThirdPayChannelMerchantCode", "ThirdPayChannelOrderId", "CurrencyAmount", "CurrencyUnit", "CurrencyType", "TransNetMemberCode", "MidasEnvironment" ] }, { "name": "RechargeMemberThirdPay", "description": "见证宝-会员在途充值(经第三方支付渠道)", "status": "online", "parameters": [ { "name": "TranNetMemberCode", "type": "string", "required": true, "description": "STRING(32)，交易网会代码" }, { "name": "MemberFillAmt", "type": "string", "required": true, "description": "STRING(20)，会员充值金额" }, { "name": "Commission", "type": "string", "required": true, "description": "STRING(20)，手续费金额" }, { "name": "Ccy", "type": "string", "required": true, "description": "STRING(3)，币种。如RMB" }, { "name": "PayChannelType", "type": "string", "required": true, "description": "STRING(20)，支付渠道类型。 0001-微信 0002-支付宝 0003-京东支付" }, { "name": "PayChannelAssignMerNo", "type": "string", "required": true, "description": "STRING(50)，支付渠道所分配的商户号" }, { "name": "PayChannelTranSeqNo", "type": "string", "required": true, "description": "STRING(52)，支付渠道交易流水号" }, { "name": "EjzbOrderNo", "type": "string", "required": true, "description": "STRING(52)，电商见证宝订单号" }, { "name": "MrchCode", "type": "string", "required": true, "description": "String(22)，商户号" }, { "name": "EjzbOrderContent", "type": "string", "required": false, "description": "STRING(500)，电商见证宝订单内容" }, { "name": "Remark", "type": "string", "required": false, "description": "STRING(300)，备注" }, { "name": "ReservedMsgOne", "type": "string", "required": false, "description": "STRING(300)，保留域1" }, { "name": "ReservedMsgTwo", "type": "string", "required": false, "description": "STRING(300)，保留域2" }, { "name": "ReservedMsgThree", "type": "string", "required": false, "description": "STRING(300)，保留域3" }, { "name": "Profile", "type": "string", "required": false, "description": "STRING(12)，接入环境，默认接入沙箱环境。接入正式环境填\"prod\"" } ], "required": [ "TranNetMemberCode", "MemberFillAmt", "Commission", "Ccy", "PayChannelType", "PayChannelAssignMerNo", "PayChannelTranSeqNo", "EjzbOrderNo", "MrchCode" ] }, { "name": "Refund", "description": "如交易订单需退款，可以通过本接口将支付款全部或部分退还给付款方，聚鑫将在收到退款请求并且验证成功之后，按照退款规则将支付款按原路退回到支付帐号。最长支持1年的订单退款。在订单包含多个子订单的情况下，如果使用本接口传入OutTradeNo或TransactionId退款，则只支持全单退款；如果需要部分退款，请通过传入子订单的方式来指定部分金额退款。", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": true, "description": "用户ID，长度不小于5位， 仅支持字母和数字的组合" }, { "name": "RefundId", "type": "string", "required": true, "description": "退款订单号，仅支持数字、 字母、下划线（_）、横杠字 符（-）、点（.）的组合" }, { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的支付主MidasAppId" }, { "name": "TotalRefundAmt", "type": "integer", "required": true, "description": "退款金额，单位：分。备注：当该字段为空或者为0 时，系统会默认使用订单当 实付金额作为退款金额" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "聚鑫分配的安全ID" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "按照聚鑫安全密钥计算的签名" }, { "name": "OutTradeNo", "type": "string", "required": false, "description": "商品订单，仅支持数字、字 母、下划线（_）、横杠字符 （-）、点（.）的组合。 OutTradeNo ,TransactionId 二选一,不能都为空,优先使用 OutTradeNo" }, { "name": "MchRefundAmt", "type": "integer", "required": false, "description": "结算应收金额，单位：分" }, { "name": "TransactionId", "type": "string", "required": false, "description": "调用下单接口获取的聚鑫交 易订单。 OutTradeNo ,TransactionId 二选一,不能都为空,优先使用 OutTradeNo" }, { "name": "PlatformRefundAmt", "type": "integer", "required": false, "description": "平台应收金额，单位：分" }, { "name": "SubOrderRefundList", "type": "array", "required": false, "description": "支持多个子订单批量退款单 个子订单退款支持传 SubOutTradeNo ，也支持传 SubOutTradeNoList ，都传的时候以 SubOutTradeNoList 为准。 如果传了子单退款细节，外 部不需要再传退款金额，平 台应退，商户应退金额，我 们可以直接根据子单退款算出来总和。", "item_type": "object", "children": [ { "name": "PlatformRefundAmt", "type": "integer", "required": true, "description": "平台应退金额" }, { "name": "RefundAmt", "type": "integer", "required": true, "description": "子订单退款金额" }, { "name": "SubMchRefundAmt", "type": "integer", "required": true, "description": "商家应退金额" }, { "name": "SubOutTradeNo", "type": "string", "required": true, "description": "子订单号" }, { "name": "SubRefundId", "type": "string", "required": true, "description": "子退款单号，调用方需要保证 全局唯一性" } ] }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名: release: 现网环境 sandbox: 沙箱环境 development: 开发环境 缺省: release" } ], "required": [ "UserId", "RefundId", "MidasAppId", "TotalRefundAmt", "MidasSecretId", "MidasSignature" ] }, { "name": "RefundCloudOrder", "description": "如交易订单需退款，可以通过本接口将支付款全部或部分退还给付款方，聚鑫将在收到退款请求并且验证成功之后，按照退款规则将支付款按原路退回到支付帐号。最长支持1年的订单退款。在订单包含多个子订单的情况下，如果使用本接口传入OutTradeNo或TransactionId退款，则只支持全单退款；如果需要部分退款，请通过传入子订单的方式来指定部分金额退款。", "status": "online", "parameters": [ { "name": "MidasAppId", "type": "string", "required": true, "description": "米大师分配的支付主MidasAppId", "example": "无" }, { "name": "UserId", "type": "string", "required": true, "description": "用户Id，长度不小于5位，仅支持字母和数字的组合", "example": "无" }, { "name": "RefundId", "type": "string", "required": true, "description": "退款订单号，仅支持数字、字母、下划线（_）、横杠字符（-）、点（.）的组合", "example": "无" }, { "name": "TotalRefundAmt", "type": "integer", "required": true, "description": "退款金额，单位：分 当该字段为空或者为0时，系统会默认使用订单当实付金额作为退款金额", "example": "无" }, { "name": "OutTradeNo", "type": "string", "required": true, "description": "商品订单，仅支持数字、字母、下划线（_）、横杠字符（-）、点（.）的组合", "example": "无" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "release" }, { "name": "PlatformRefundAmt", "type": "integer", "required": false, "description": "平台应收金额，单位：分", "example": "无" }, { "name": "MchRefundAmt", "type": "integer", "required": false, "description": "结算应收金额，单位：分", "example": "无" }, { "name": "SubOrderRefundList", "type": "array", "required": false, "description": "支持多个子订单批量退款单个子订单退款支持传SubOutTradeNo 也支持传SubOrderRefundList，都传的时候以SubOrderRefundList为准。 如果传了子单退款细节，外部不需要再传退款金额，平台应退，商户应退金额", "example": "无", "item_type": "object", "children": [ { "name": "RefundAmt", "type": "integer", "required": true, "description": "子订单退款金额", "example": "无" }, { "name": "PlatformRefundAmt", "type": "integer", "required": true, "description": "平台应退金额", "example": "无" }, { "name": "SubMchRefundAmt", "type": "integer", "required": true, "description": "商家应退金额", "example": "无" }, { "name": "SubOutTradeNo", "type": "string", "required": true, "description": "子订单号", "example": "无" }, { "name": "SubRefundId", "type": "string", "required": true, "description": "子退款单号，调用方需要保证全局唯一性", "example": "无" } ] }, { "name": "ChannelOrderId", "type": "string", "required": false, "description": "渠道订单号，当出现重复支付时，可以将重复支付订单的渠道订单号传入，以进行退款（注意：目前该重复支付订单的渠道订单号仅能通过米大师内部获取），更多重复支付订单退款说明，请参考[重复支付订单退款说明](https://dev.tke.midas.qq.com/juxin-doc-next/apidocs/receive-order/Refund.html#%E9%87%8D%E5%A4%8D%E6%94%AF%E4%BB%98%E8%AE%A2%E5%8D%95%E9%80%80%E6%AC%BE%E8%AF%B4%E6%98%8E)", "example": "无" }, { "name": "RefundNotifyUrl", "type": "string", "required": false, "description": "通知地址", "example": "无" }, { "name": "Metadata", "type": "string", "required": false, "description": "透传字段，退款成功回调透传给应用，用于开发者透传自定义内容", "example": "无" }, { "name": "ExternalRefundPromptGroupList", "type": "string", "required": false, "description": "渠道扩展退款促销列表，可将各个渠道的退款促销信息放于该列表", "example": "无" } ], "required": [ "MidasAppId", "UserId", "RefundId", "TotalRefundAmt", "OutTradeNo" ] }, { "name": "RefundMemberTransaction", "description": "会员间交易退款", "status": "online", "parameters": [ { "name": "OutSubAccountName", "type": "string", "required": true, "description": "转出见证子账户的户名" }, { "name": "InSubAccountName", "type": "string", "required": true, "description": "转入见证子账户的户名" }, { "name": "PayChannelSubId", "type": "integer", "required": true, "description": "子渠道" }, { "name": "OutSubAccountNumber", "type": "string", "required": true, "description": "转出见证子账户账号" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "计费签名" }, { "name": "InSubAccountNumber", "type": "string", "required": true, "description": "转入见证子账户账号" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "聚鑫分配的安全ID" }, { "name": "BankAccountNumber", "type": "string", "required": true, "description": "父账户账号，资金汇总账号" }, { "name": "OldTransSequenceNumber", "type": "string", "required": true, "description": "原老订单流水号" }, { "name": "MerchantCode", "type": "string", "required": true, "description": "银行注册商户号" }, { "name": "RequestType", "type": "string", "required": true, "description": "请求类型，固定为MemberTransactionRefundReq" }, { "name": "CurrencyAmount", "type": "string", "required": true, "description": "交易金额" }, { "name": "TransSequenceNumber", "type": "string", "required": true, "description": "交易流水号" }, { "name": "PayChannel", "type": "string", "required": true, "description": "渠道" }, { "name": "OldOrderId", "type": "string", "required": true, "description": "原订单号" }, { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的支付主MidasAppId" }, { "name": "OrderId", "type": "string", "required": true, "description": "订单号" }, { "name": "MidasEnvironment", "type": "string", "required": true, "description": "Midas环境标识 release 现网环境 sandbox 沙箱环境 development 开发环境" }, { "name": "OutTransNetMemberCode", "type": "string", "required": false, "description": "转出子账户交易网会员代码" }, { "name": "InTransNetMemberCode", "type": "string", "required": false, "description": "转入子账户交易网会员代码" }, { "name": "ReservedMessage", "type": "string", "required": false, "description": "保留域" }, { "name": "PlatformShortNumber", "type": "string", "required": false, "description": "平台短号(银行分配)" }, { "name": "TransType", "type": "string", "required": false, "description": "0-登记挂账，1-撤销挂账" }, { "name": "TransFee", "type": "string", "required": false, "description": "交易手续费" } ], "required": [ "OutSubAccountName", "InSubAccountName", "PayChannelSubId", "OutSubAccountNumber", "MidasSignature", "InSubAccountNumber", "MidasSecretId", "BankAccountNumber", "OldTransSequenceNumber", "MerchantCode", "RequestType", "CurrencyAmount", "TransSequenceNumber", "PayChannel", "OldOrderId", "MidasAppId", "OrderId", "MidasEnvironment" ] }, { "name": "RefundOpenBankOrder", "description": "云企付-退款申请", "status": "online", "parameters": [ { "name": "OutRefundId", "type": "string", "required": true, "description": "外部商户退款单号。", "example": "R202002011200001" }, { "name": "RefundAmount", "type": "integer", "required": true, "description": "退款金额。单位分。", "example": "100" }, { "name": "ChannelMerchantId", "type": "string", "required": false, "description": "渠道商户号。外部平台接入云企付平台下发。必填。", "example": "CM772002011200001" }, { "name": "OutOrderId", "type": "string", "required": false, "description": "外部商户订单号，与云企付渠道订单号二者不能同时为空。", "example": "202002011200001" }, { "name": "ChannelOrderId", "type": "string", "required": false, "description": "云企付渠道订单号，与外部订单号二者不能同时为空。", "example": "202002011200001" }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "退款通知地址。", "example": "无" }, { "name": "RefundReason", "type": "string", "required": false, "description": "退款原因。 当EBANK_PAYMENT担保支付订单退款时，此字段必传。", "example": "无" }, { "name": "ExternalRefundData", "type": "string", "required": false, "description": "第三方渠道退款附加信息。详见附录-复杂类型。 若未作特殊说明，则无需传入。", "example": "无" }, { "name": "Remark", "type": "string", "required": false, "description": "备注信息", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "无" }, { "name": "ProfitShareInfoList", "type": "array", "required": false, "description": "分账信息列表。", "example": "无", "item_type": "object", "children": [ { "name": "RecvId", "type": "string", "required": false, "description": "分润接收方，渠道商户号ID", "example": "sub1w00003" }, { "name": "ProfitShareFee", "type": "integer", "required": false, "description": "分润金额，单位分", "example": "100" } ] } ], "required": [ "OutRefundId", "RefundAmount" ] }, { "name": "RefundOrder", "description": "云鉴-消费订单退款的接口", "status": "online", "parameters": [ { "name": "MerchantAppId", "type": "string", "required": true, "description": "进件成功后返给商户方的AppId", "example": "1c6f41570498301d85fc4589a5435b54" }, { "name": "OrderNo", "type": "string", "required": true, "description": "平台流水号。消费订单发起成功后，返回的平台唯一订单号。", "example": "T03210722000014555992" } ], "required": [ "MerchantAppId", "OrderNo" ] }, { "name": "RefundTlinxOrder", "description": "云支付订单退款接口", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "使用门店OpenId", "example": "f2cc268b9c95fbbb230a19397fe35f8d" }, { "name": "OpenKey", "type": "string", "required": true, "description": "使用门店OpenKey", "example": "e30051d527bd4e621e7090c9392739ec" }, { "name": "DeveloperNo", "type": "string", "required": true, "description": "原始订单的开发者交易流水号", "example": "TEST00000456" }, { "name": "RefundOutNo", "type": "string", "required": true, "description": "新退款订单的开发者流水号，同一门店内唯一", "example": "TEST00000457" }, { "name": "RefundOrderName", "type": "string", "required": true, "description": "退款订单名称，可以为空", "example": "退款测试" }, { "name": "RefundAmount", "type": "string", "required": true, "description": "退款金额（以分为单位，没有小数点）", "example": "1" }, { "name": "ShopPassword", "type": "string", "required": true, "description": "主管密码，对密码进行SHA-1加密，默认为123456", "example": "7c4a8d09ca3762af61e59520943dc26494f8941b" }, { "name": "Remark", "type": "string", "required": false, "description": "退款备注", "example": "备注" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey", "DeveloperNo", "RefundOutNo", "RefundOrderName", "RefundAmount", "ShopPassword" ] }, { "name": "RegisterBehavior", "description": "商户查询是否签约和签约行为上报", "status": "online", "parameters": [ { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的支付主MidasAppId", "example": "your_midas_app_id" }, { "name": "SubAppId", "type": "string", "required": true, "description": "聚鑫计费SubAppId，代表子商户", "example": "your_sub_app_id" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "聚鑫分配的安全ID", "example": "your_midas_secret_id" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "按照聚鑫安全密钥计算的签名", "example": "your_midas_signature" }, { "name": "FunctionFlag", "type": "integer", "required": true, "description": "功能标志 1：登记行为记录信息 2：查询补录信息", "example": "1" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名: release: 现网环境 sandbox: 沙箱环境 development: 开发环境 缺省: release", "example": "release" }, { "name": "OperationClickTime", "type": "string", "required": false, "description": "操作点击时间 yyyyMMddHHmmss 功能标志FunctionFlag=1时必输", "example": "20210513120030" }, { "name": "IpAddress", "type": "string", "required": false, "description": "IP地址 功能标志FunctionFlag=1时必输", "example": "127.0.0.1" }, { "name": "MacAddress", "type": "string", "required": false, "description": "MAC地址 功能标志FunctionFlag=1时必输", "example": "A1:B1:C1:D1:E1:F1" }, { "name": "SignChannel", "type": "integer", "required": false, "description": "签约渠道 1: App 2: 平台H5网页 3：公众号 4：小程序 功能标志FunctionFlag=1时必输", "example": "1" } ], "required": [ "MidasAppId", "SubAppId", "MidasSecretId", "MidasSignature", "FunctionFlag" ] }, { "name": "RegisterBill", "description": "登记挂账(支持撤销)", "status": "online", "parameters": [ { "name": "RequestType", "type": "string", "required": true, "description": "请求类型此接口固定填：RegBillSupportWithdrawReq" }, { "name": "MerchantCode", "type": "string", "required": true, "description": "商户号" }, { "name": "PayChannel", "type": "string", "required": true, "description": "支付渠道" }, { "name": "PayChannelSubId", "type": "integer", "required": true, "description": "子渠道" }, { "name": "OrderId", "type": "string", "required": true, "description": "交易订单号" }, { "name": "BankAccountNo", "type": "string", "required": true, "description": "父账户账号，资金汇总账号" }, { "name": "PlatformShortNo", "type": "string", "required": true, "description": "平台短号(银行分配)" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "聚鑫分配的安全ID" }, { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的支付主MidasAppId" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "计费签名" }, { "name": "TransSeqNo", "type": "string", "required": true, "description": "交易流水号" }, { "name": "TranFee", "type": "string", "required": true, "description": "暂未使用，默认传0.0" }, { "name": "OrderAmt", "type": "string", "required": true, "description": "挂账金额，以元为单位" }, { "name": "BankSubAccountNo", "type": "string", "required": true, "description": "子账户账号" }, { "name": "TranNetMemberCode", "type": "string", "required": true, "description": "交易网会员代码" }, { "name": "TranType", "type": "string", "required": true, "description": "0,登记挂账，1，撤销挂账" }, { "name": "ReservedMessage", "type": "string", "required": false, "description": "保留域" }, { "name": "Remark", "type": "string", "required": false, "description": "备注" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "Midas环境参数" } ], "required": [ "RequestType", "MerchantCode", "PayChannel", "PayChannelSubId", "OrderId", "BankAccountNo", "PlatformShortNo", "MidasSecretId", "MidasAppId", "MidasSignature", "TransSeqNo", "TranFee", "OrderAmt", "BankSubAccountNo", "TranNetMemberCode", "TranType" ] }, { "name": "RegisterBillSupportWithdraw", "description": "登记挂账(支持撤销)。此接口可实现把不明来账或自有资金等已登记在挂账子账户下的资金调整到普通会员子账户。即通过申请调用此接口，将会减少挂账子账户的资金，调增指定的普通会员子账户的可提现余额及可用余额。此接口不支持把挂账子账户资金清分到功能子账户。", "status": "online", "parameters": [ { "name": "TranNetMemberCode", "type": "string", "required": true, "description": "STRING(32)，交易网会员代码" }, { "name": "OrderNo", "type": "string", "required": true, "description": "STRING(50)，订单号" }, { "name": "SuspendAmt", "type": "string", "required": true, "description": "STRING(20)，挂账金额（包含交易费用）" }, { "name": "TranFee", "type": "string", "required": true, "description": "STRING(20)，交易费用（暂未使用，默认传0.0）" }, { "name": "MrchCode", "type": "string", "required": true, "description": "String(22)，商户号（签约客户号）" }, { "name": "Remark", "type": "string", "required": false, "description": "STRING(300)，备注" }, { "name": "ReservedMsgOne", "type": "string", "required": false, "description": "STRING(300)，保留域1" }, { "name": "ReservedMsgTwo", "type": "string", "required": false, "description": "STRING(300)，保留域2" }, { "name": "ReservedMsgThree", "type": "string", "required": false, "description": "STRING(300)，保留域3" }, { "name": "Profile", "type": "string", "required": false, "description": "STRING(12)，接入环境，默认接入沙箱环境。接入正式环境填\"prod\"" } ], "required": [ "TranNetMemberCode", "OrderNo", "SuspendAmt", "TranFee", "MrchCode" ] }, { "name": "ReviseMbrProperty", "description": "修改会员属性-普通商户子账户。修改会员的会员属性。", "status": "online", "parameters": [ { "name": "MrchCode", "type": "string", "required": true, "description": "String(22)，商户号（签约客户号）" }, { "name": "SubAcctNo", "type": "string", "required": true, "description": "STRING(50)，见证子账户的账号" }, { "name": "MemberProperty", "type": "string", "required": true, "description": "STRING(10)，会员属性（00-普通子账号; SH-商户子账户。暂时只支持00-普通子账号改为SH-商户子账户）" }, { "name": "ReservedMsg", "type": "string", "required": false, "description": "STRING(1027)，保留域" }, { "name": "Profile", "type": "string", "required": false, "description": "STRING(12)，接入环境，默认接入沙箱环境。接入正式环境填\"prod\"" } ], "required": [ "MrchCode", "SubAcctNo", "MemberProperty" ] }, { "name": "RevokeMemberRechargeThirdPay", "description": "撤销会员在途充值(经第三方支付渠道)", "status": "online", "parameters": [ { "name": "OldFillFrontSeqNo", "type": "string", "required": true, "description": "STRING(52)，原充值的前置流水号" }, { "name": "OldFillPayChannelType", "type": "string", "required": true, "description": "STRING(20)，原充值的支付渠道类型" }, { "name": "OldPayChannelTranSeqNo", "type": "string", "required": true, "description": "STRING(52)，原充值的支付渠道交易流水号" }, { "name": "OldFillEjzbOrderNo", "type": "string", "required": true, "description": "STRING(52)，原充值的电商见证宝订单号" }, { "name": "ApplyCancelMemberAmt", "type": "string", "required": true, "description": "STRING(20)，申请撤销的会员金额" }, { "name": "ApplyCancelCommission", "type": "string", "required": true, "description": "STRING(20)，申请撤销的手续费金额" }, { "name": "MrchCode", "type": "string", "required": true, "description": "String(22)，商户号" }, { "name": "Remark", "type": "string", "required": false, "description": "STRING(300)，备注" }, { "name": "ReservedMsgOne", "type": "string", "required": false, "description": "STRING(300)，保留域1" }, { "name": "ReservedMsgTwo", "type": "string", "required": false, "description": "STRING(300)，保留域2" }, { "name": "ReservedMsgThree", "type": "string", "required": false, "description": "STRING(300)，保留域3" }, { "name": "Profile", "type": "string", "required": false, "description": "STRING(12)，接入环境，默认接入沙箱环境。接入正式环境填\"prod\"" } ], "required": [ "OldFillFrontSeqNo", "OldFillPayChannelType", "OldPayChannelTranSeqNo", "OldFillEjzbOrderNo", "ApplyCancelMemberAmt", "ApplyCancelCommission", "MrchCode" ] }, { "name": "RevokeRechargeByThirdPay", "description": "撤销会员在途充值(经第三方支付渠道)接口", "status": "online", "parameters": [ { "name": "RequestType", "type": "string", "required": true, "description": "请求类型此接口固定填：RevokeMemberRechargeThirdPayReq" }, { "name": "MerchantCode", "type": "string", "required": true, "description": "商户号" }, { "name": "PayChannel", "type": "string", "required": true, "description": "支付渠道" }, { "name": "PayChannelSubId", "type": "integer", "required": true, "description": "子渠道" }, { "name": "OrderId", "type": "string", "required": true, "description": "原始充值交易订单号" }, { "name": "BankAccountNumber", "type": "string", "required": true, "description": "父账户账号，资金汇总账号" }, { "name": "PlatformShortNumber", "type": "string", "required": true, "description": "平台短号(银行分配)" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "聚鑫分配的安全ID" }, { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的支付主MidasAppId" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "计费签名" }, { "name": "TransSequenceNumber", "type": "string", "required": true, "description": "交易流水号" }, { "name": "TransFee", "type": "string", "required": true, "description": "申请撤销的手续费金额,以元为单位" }, { "name": "ThirdPayChannel", "type": "string", "required": true, "description": "第三方支付渠道类型 0001-微信 0002-支付宝 0003-京东支付" }, { "name": "ThirdPayChannelOrderId", "type": "string", "required": true, "description": "第三方渠道订单号或流水号" }, { "name": "OldFrontSequenceNumber", "type": "string", "required": true, "description": "充值接口银行返回的流水号(FrontSeqNo)" }, { "name": "CurrencyAmount", "type": "string", "required": true, "description": "申请撤销的金额" }, { "name": "CurrencyUnit", "type": "string", "required": true, "description": "单位，1：元，2：角，3：分 目前固定填1" }, { "name": "CurrencyType", "type": "string", "required": true, "description": "币种 目前固定填RMB" }, { "name": "MidasEnvironment", "type": "string", "required": true, "description": "Midas环境标识" }, { "name": "ReservedMessage", "type": "string", "required": false, "description": "保留域" }, { "name": "Remark", "type": "string", "required": false, "description": "备注" } ], "required": [ "RequestType", "MerchantCode", "PayChannel", "PayChannelSubId", "OrderId", "BankAccountNumber", "PlatformShortNumber", "MidasSecretId", "MidasAppId", "MidasSignature", "TransSequenceNumber", "TransFee", "ThirdPayChannel", "ThirdPayChannelOrderId", "OldFrontSequenceNumber", "CurrencyAmount", "CurrencyUnit", "CurrencyType", "MidasEnvironment" ] }, { "name": "SyncContractData", "description": "对于存量的签约关系导入或者部分场景下米大师无法收到签约通知的场景，需要由调用方主动将签约状态同步至米大师", "status": "online", "parameters": [ { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的支付主MidasAppId", "example": "your_midas_app_id" }, { "name": "UserId", "type": "string", "required": true, "description": "用户ID，长度不小于5位，仅支持字母和数字的组合", "example": "your_user_id" }, { "name": "Channel", "type": "string", "required": true, "description": "签约使用的渠道", "example": "wechat" }, { "name": "OutContractCode", "type": "string", "required": true, "description": "业务签约合同协议号", "example": "your_contract_code" }, { "name": "ContractStatus", "type": "string", "required": true, "description": "签约状态，枚举值 CONTRACT_STATUS_INVALID=无效状态 CONTRACT_STATUS_SIGNED=已签约 CONTRACT_STATUS_TERMINATED=已解约 CONTRACT_STATUS_PENDING=签约进行中", "example": "CONTRACT_STATUS_SIGNED" }, { "name": "ContractSyncInfo", "type": "object", "required": true, "description": "签约同步信息", "example": "无", "children": [ { "name": "ExternalReturnContractInfo", "type": "object", "required": true, "description": "第三方渠道合约信息", "example": "无", "children": [ { "name": "ExternalReturnAgreementId", "type": "string", "required": true, "description": "第三方渠道协议id 注意：此字段可能返回 null，表示取不到有效值。", "example": "agreement_id" }, { "name": "ExternalReturnContractEffectiveTimestamp", "type": "string", "required": true, "description": "第三方渠道协议生效时间戳 注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-05-11T20:41:07Z" }, { "name": "ExternalReturnContractTerminationTimestamp", "type": "string", "required": true, "description": "第三方渠道协议解约时间戳 注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-05-11T20:41:07Z" }, { "name": "ExternalReturnContractStatus", "type": "string", "required": true, "description": "平台合约状态 协议状态，枚举值： CONTRACT_STATUS_SIGNED：已签约 CONTRACT_STATUS_TERMINATED：未签约 CONTRACT_STATUS_PENDING：签约进行中 注意：此字段可能返回 null，表示取不到有效值。", "example": "CONTRACT_STATUS_PENDING" }, { "name": "ExternalReturnRequestId", "type": "string", "required": true, "description": "第三方渠道请求序列号 注意：此字段可能返回 null，表示取不到有效值。", "example": "request_id" }, { "name": "ExternalReturnContractSignedTimestamp", "type": "string", "required": true, "description": "第三方渠道协议签署时间戳 注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-05-11T20:41:07Z" }, { "name": "ExternalReturnContractExpiredTimestamp", "type": "string", "required": true, "description": "第三方渠道协议到期时间戳 注意：此字段可能返回 null，表示取不到有效值。", "example": "2021-05-11T20:41:07Z" }, { "name": "ExternalReturnContractData", "type": "string", "required": true, "description": "第三方渠道返回的合约数据 注意：此字段可能返回 null，表示取不到有效值。", "example": "data" }, { "name": "ExternalReturnContractTerminationRemark", "type": "string", "required": false, "description": "第三方渠道解约备注 注意：此字段可能返回 null，表示取不到有效值。", "example": "mode" }, { "name": "ExternalReturnContractTerminationMode", "type": "string", "required": false, "description": "第三方渠道协议解约方式 注意：此字段可能返回 null，表示取不到有效值。", "example": "mode" } ] }, { "name": "ExternalContractUserInfo", "type": "array", "required": true, "description": "第三方渠道用户信息", "example": "无", "item_type": "object", "children": [ { "name": "ExternalUserType", "type": "string", "required": true, "description": "第三方用户类型，例如: WX_OPENID, WX_SUB_OPENID,WX_PAYER_OPENID", "example": "WX_OPENID" }, { "name": "ExternalUserId", "type": "string", "required": true, "description": "第三方用户ID", "example": "your_wx_openid" } ] }, { "name": "ContractMethod", "type": "string", "required": false, "description": "签约方式，枚举值， CONTRACT_METHOD_WECHAT_INVALID: 无效 CONTRACT_METHOD_WECHAT_APP: 微信APP CONTRACT_METHOD_WECHAT_PUBLIC: 微信公众号 CONTRACT_METHOD_WECHAT_MINIPROGRAM: 微信小程序 CONTRACT_METHOD_WECHAT_H5: 微信H5", "example": "CONTRACT_METHOD_WECHAT_PUBLIC" }, { "name": "ContractSceneId", "type": "string", "required": false, "description": "在米大师侧分配的场景id", "example": "your_contract_scene_id" }, { "name": "ExternalReturnContractData", "type": "string", "required": false, "description": "调用方从第三方渠道查询到的签约数据，由各个渠道定义", "example": "your_external_contract_data" } ] }, { "name": "MidasSignature", "type": "string", "required": true, "description": "按照聚鑫安全密钥计算的签名", "example": "your_midas_signature" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "聚鑫分配的安全ID", "example": "your_midas_secret_id" }, { "name": "SubAppId", "type": "string", "required": false, "description": "聚鑫计费SubAppId，代表子商户", "example": "your_sub_app_id" }, { "name": "UserType", "type": "string", "required": false, "description": "用户类型，枚举值 USER_ID: 用户ID ANONYMOUS: 匿名类型 USER_ID 默认值为 USER_ID", "example": "USER_ID" }, { "name": "SceneInfo", "type": "object", "required": false, "description": "场景信息", "example": "无", "children": [ { "name": "LocaleCode", "type": "string", "required": true, "description": "语言代码 注意：此字段可能返回 null，表示取不到有效值。", "example": "code" }, { "name": "RegionCode", "type": "string", "required": true, "description": "地区代码 注意：此字段可能返回 null，表示取不到有效值。", "example": "code" }, { "name": "UserClientIp", "type": "string", "required": true, "description": "用户IP 注意：此字段可能返回 null，表示取不到有效值。", "example": "your_ip" } ] }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名: release: 现网环境 sandbox: 沙箱环境 development: 开发环境 缺省: release", "example": "your_midas_environment" } ], "required": [ "MidasAppId", "UserId", "Channel", "OutContractCode", "ContractStatus", "ContractSyncInfo", "MidasSignature", "MidasSecretId" ] }, { "name": "TerminateContract", "description": "通过此接口进行解约", "status": "online", "parameters": [ { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的支付主MidasAppId", "example": "your_midas_app_id" }, { "name": "UserId", "type": "string", "required": true, "description": "用户ID，长度不小于5位，仅支持字母和数字的组合", "example": "your_user_id" }, { "name": "Channel", "type": "string", "required": true, "description": "指定渠道： wechat：微信支付 qqwallet：QQ钱包 bank：网银支付 只有一个渠道时需要指定", "example": "wechat" }, { "name": "TerminateMode", "type": "string", "required": true, "description": "枚举值： CONTRACT_TERMINATION_MODE_BY_OUT_CONTRACT_CODE: 按OutContractCode+ContractSceneId解约 CONTRACT_TERMINATION_MODE_BY_CHANNEL_CONTRACT_CODE：按ChannelContractCode解约", "example": "CONTRACT_TERMINATION_MODE_BY_OUT_CONTRACT_CODE" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "聚鑫分配的安全ID", "example": "your_midas_secret_id" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "按照聚鑫安全密钥计算的签名", "example": "your_midas_signature" }, { "name": "SubAppId", "type": "string", "required": false, "description": "聚鑫计费SubAppId，代表子商户", "example": "your_sub_app_id" }, { "name": "OutContractCode", "type": "string", "required": false, "description": "业务签约合同协议号 当TerminateMode=CONTRACT_TERMINATION_MODE_BY_OUT_CONTRACT_CODE 时 必填", "example": "your_contract_code" }, { "name": "ContractSceneId", "type": "string", "required": false, "description": "签约场景ID，当 TerminateMode=CONTRACT_TERMINATION_MODE_BY_OUT_CONTRACT_CODE 时 必填，在米大师侧托管后生成", "example": "your_scene_id" }, { "name": "ChannelContractCode", "type": "string", "required": false, "description": "米大师生成的协议号 当 TerminateMode=CONTRACT_TERMINATION_MODE_BY_CHANNEL_CONTRACT_CODE 时 必填", "example": "your_contract_code" }, { "name": "ExternalContractData", "type": "string", "required": false, "description": "第三方渠道合约数据，json字符串，与特定渠道有关", "example": "{\\\"plan_id\\\":\\\"10086\\\",\\\"contract_code\\\":\\\"C11111111000001\\\",\\\"w" }, { "name": "TerminationReason", "type": "string", "required": false, "description": "终止合约原因", "example": "your_reason" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名: release: 现网环境 sandbox: 沙箱环境 development: 开发环境 缺省: release", "example": "release" }, { "name": "UserType", "type": "string", "required": false, "description": "USER_ID: 用户ID ANONYMOUS: 匿名类型 USER_ID 默认值为 USER_ID", "example": "USER_ID" }, { "name": "ContractMethod", "type": "string", "required": false, "description": "签约方式", "example": "CONTRACT_METHOD_WECHAT_JSAPI" }, { "name": "MigrateMode", "type": "string", "required": false, "description": "签约代扣穿透查询存量数据迁移模式", "example": "MigrateMode_CONTRACT_MIGRATE_MODE_NO" } ], "required": [ "MidasAppId", "UserId", "Channel", "TerminateMode", "MidasSecretId", "MidasSignature" ] }, { "name": "TransferSinglePay", "description": "智能代发-单笔代发转账接口", "status": "online", "parameters": [ { "name": "MerchantId", "type": "string", "required": true, "description": "商户号", "example": "test" }, { "name": "MerchantAppId", "type": "string", "required": true, "description": "微信申请商户号的appid或者商户号绑定的appid 支付宝、平安填入MerchantId", "example": "test" }, { "name": "TransferType", "type": "integer", "required": true, "description": "1、 微信企业付款 2、 支付宝转账 3、 平安银企直联代发转账", "example": "1" }, { "name": "OrderId", "type": "string", "required": true, "description": "订单流水号，唯一，不能包含特殊字符，长度最大限制64位，推荐使用字母，数字组合，\"_\",\"-\"组合", "example": "1234567" }, { "name": "TransferAmount", "type": "integer", "required": true, "description": "转账金额，单位分", "example": "1" }, { "name": "PayeeId", "type": "string", "required": true, "description": "收款方标识。 微信为open_id； 支付宝为会员alipay_user_id; 平安为收款方银行账号", "example": "123" }, { "name": "PayeeName", "type": "string", "required": false, "description": "收款方姓名。支付宝可选；微信，平安模式下必传", "example": "test" }, { "name": "PayeeExtends", "type": "string", "required": false, "description": "收款方附加信息，平安接入使用。需要以JSON格式提供以下字段： PayeeBankName：收款人开户行名称 CcyCode：货币类型（RMB-人民币） UnionFlag：行内跨行标志（1：行内转账，0：跨行转账）。", "example": "null" }, { "name": "ReqReserved", "type": "string", "required": false, "description": "请求预留字段，原样透传返回", "example": "null" }, { "name": "Remark", "type": "string", "required": false, "description": "业务备注", "example": "null" }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "转账结果回调通知URL。若不填，则不进行回调。", "example": "null" }, { "name": "Profile", "type": "string", "required": false, "description": "接入环境。沙箱环境填sandbox。", "example": "null" } ], "required": [ "MerchantId", "MerchantAppId", "TransferType", "OrderId", "TransferAmount", "PayeeId" ] }, { "name": "UnBindAcct", "description": "商户解除绑定的提现银行卡", "status": "online", "parameters": [ { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的支付主MidasAppId" }, { "name": "SubAppId", "type": "string", "required": true, "description": "聚鑫计费SubAppId，代表子商户" }, { "name": "SettleAcctNo", "type": "string", "required": true, "description": "用于提现 加密详见《商户端接口敏感信息加密说明》" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "聚鑫分配的安全ID" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "按照聚鑫安全密钥计算的签名" }, { "name": "EncryptType", "type": "string", "required": false, "description": "敏感信息加密类型: RSA: rsa非对称加密，使用RSA-PKCS1-v1_5 AES: aes对称加密，使用AES256-CBC-PCKS7padding 缺省: RSA" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名: release: 现网环境 sandbox: 沙箱环境 development: 开发环境 缺省: release" } ], "required": [ "MidasAppId", "SubAppId", "SettleAcctNo", "MidasSecretId", "MidasSignature" ] }, { "name": "UnbindOpenBankExternalSubMerchantBankAccount", "description": "云企付-子商户银行卡解绑", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户ID。", "example": "无" }, { "name": "ChannelSubMerchantId", "type": "string", "required": true, "description": "渠道子商户ID。", "example": "无" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称。 __TENPAY__: 商企付 __WECHAT__: 微信支付 __ALIPAY__: 支付宝", "example": "TENPAY" }, { "name": "PaymentMethod", "type": "string", "required": true, "description": "支付方式。 __EBANK_PAYMENT__: ebank支付 __OPENBANK_PAYMENT__: openbank支付", "example": "无" }, { "name": "BindSerialNo", "type": "string", "required": true, "description": "绑卡序列号。", "example": "无" }, { "name": "OutApplyId", "type": "string", "required": true, "description": "外部申请编号。", "example": "无" }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "通知地址。", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "无" } ], "required": [ "ChannelMerchantId", "ChannelSubMerchantId", "ChannelName", "PaymentMethod", "BindSerialNo", "OutApplyId" ] }, { "name": "UnbindRelateAcct", "description": "会员解绑提现账户。此接口可以支持会员解除名下的绑定账户关系。", "status": "online", "parameters": [ { "name": "MrchCode", "type": "string", "required": true, "description": "String(22)，商户号（签约客户号）" }, { "name": "FunctionFlag", "type": "string", "required": true, "description": "STRING(2)，功能标志（1: 解绑）" }, { "name": "TranNetMemberCode", "type": "string", "required": true, "description": "STRING(32)，交易网会员代码（若需要把一个待绑定账户关联到两个会员名下，此字段可上送两个会员的交易网代码，并且须用“|::|”(右侧)进行分隔）" }, { "name": "MemberAcctNo", "type": "string", "required": true, "description": "STRING(50)，待解绑的提现账户的账号（提现账号）" }, { "name": "ReservedMsg", "type": "string", "required": false, "description": "STRING(1027)，保留域" }, { "name": "Profile", "type": "string", "required": false, "description": "STRING(12)，接入环境，默认接入沙箱环境。接入正式环境填\"prod\"" } ], "required": [ "MrchCode", "FunctionFlag", "TranNetMemberCode", "MemberAcctNo" ] }, { "name": "UnifiedCloudOrder", "description": "应用需要先调用本接口生成支付订单号，并将应答的PayInfo透传给聚鑫SDK，拉起客户端（包括微信公众号/微信小程序/客户端App）支付。", "status": "online", "parameters": [ { "name": "MidasAppId", "type": "string", "required": true, "description": "米大师分配的支付主MidasAppId", "example": "无" }, { "name": "UserId", "type": "string", "required": true, "description": "用户ID 长度不小于5位，仅支持字母和数字的组合，长度限制以具体接入渠道为准", "example": "无" }, { "name": "OutTradeNo", "type": "string", "required": true, "description": "开发者主订单号 支付订单号，仅支持数字、字母、下划线（_）、横杠字符（-）、点（.）的组合，长度供参考，部分渠道存在长度更短的情况接入时请联系开发咨询", "example": "无" }, { "name": "CurrencyType", "type": "string", "required": true, "description": "货币类型 ISO货币代码，CNY", "example": "无" }, { "name": "ProductId", "type": "string", "required": true, "description": "商品ID 业务自定义的商品id，仅支持数字、字母、下划线（_）、横杠字符（-）、点（.）的组合。", "example": "无" }, { "name": "ProductName", "type": "string", "required": true, "description": "商品名称 业务自定义的商品名称，无需URL编码，长度限制以具体所接入渠道为准。", "example": "无" }, { "name": "ProductDetail", "type": "string", "required": true, "description": "商品详情 业务自定义的商品详情，无需URL编码，长度限制以具体所接入渠道为准。", "example": "无" }, { "name": "OriginalAmt", "type": "integer", "required": true, "description": "原始金额 单位：分，需要注意的是，OriginalAmt\u003e=TotalAmt", "example": "无" }, { "name": "TotalAmt", "type": "integer", "required": true, "description": "支付金额 单位：分，需要注意的是，TotalAmt=TotalPlatformIncome+TotalMchIncome。", "example": "无" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境类型 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "release" }, { "name": "SubAppId", "type": "string", "required": false, "description": "支付SubAppId 米大师计费SubAppId，代表子商户。指定使用该商户的商户号下单时必传。", "example": "无" }, { "name": "RealChannel", "type": "string", "required": false, "description": "顶层支付渠道 银行收单: openbank_ccb: 建设银行 openbank_icbc: 工商银行 openbank_cmb: 招商银行 openbank_ping: 平安银行 openbank_icbc_jft：工商银行聚付通 非银行收单，可以为空", "example": "无" }, { "name": "Channel", "type": "string", "required": false, "description": "支付渠道 wechat：微信支付 wechat_ecommerce: 微信电商收付通 open_alipay: 支付宝 open_quickpass: 银联云闪付 icbc_epay: 工银e支付 foreign_cardpay: 外卡支付 icbc_jft_wechat: 工行聚付通-微信 icbc_jft_alipay: 工行聚付通-支付宝 icbc_jft_epay: 工行聚付通-e支付 指定渠道下单时必传", "example": "无" }, { "name": "Metadata", "type": "string", "required": false, "description": "透传字段 支付成功回调透传给应用，用于开发者透传自定义内容。", "example": "无" }, { "name": "Quantity", "type": "integer", "required": false, "description": "数量 购买数量,不传默认为1。", "example": "无" }, { "name": "CallbackUrl", "type": "string", "required": false, "description": "Web端回调地址 Web端网页回调地址，仅当Web端SDK使用页面跳转方式时有效。", "example": "无" }, { "name": "CancelUrl", "type": "string", "required": false, "description": "支付取消地址", "example": "无" }, { "name": "WxAppId", "type": "string", "required": false, "description": "微信AppId wechat渠道或wchat_ecommerce渠道可以指定下单时的wxappid。", "example": "无" }, { "name": "WxSubAppId", "type": "string", "required": false, "description": "微信SubAppId wechat渠道可以指定下单时的sub_appid。", "example": "无" }, { "name": "WxOpenId", "type": "string", "required": false, "description": "微信公众号/小程序OpenId 微信公众号/小程序支付时为必选，需要传微信下的openid。", "example": "无" }, { "name": "WxSubOpenId", "type": "string", "required": false, "description": "微信公众号/小程序SubOpenId 在服务商模式下，微信公众号/小程序支付时wx_sub_openid和wx_openid二选一。", "example": "无" }, { "name": "TotalPlatformIncome", "type": "integer", "required": false, "description": "平台应收金额 单位：分，需要注意的是，TotalAmt=TotalPlatformIncome+TotalMchIncome", "example": "无" }, { "name": "TotalMchIncome", "type": "integer", "required": false, "description": "结算应收金额 单位：分，需要注意的是，TotalAmt=TotalPlatformIncome+TotalMchIncome", "example": "无" }, { "name": "SubOrderList", "type": "array", "required": false, "description": "子订单列表 格式：子订单号、子应用Id、金额。压缩后最长不可超过32K字节(去除空格，换行，制表符等无意义字符)。", "example": "无", "item_type": "object", "children": [ { "name": "SubOutTradeNo", "type": "string", "required": true, "description": "子订单号。 长度32个字符供参考，部分渠道存在长度更短的情况接入时请联系开发咨询。", "example": "无" }, { "name": "SubAppId", "type": "string", "required": true, "description": "支付子商户ID。 米大师计费SubAppId，代表子商户。", "example": "无" }, { "name": "ProductName", "type": "string", "required": true, "description": "商品名称。 业务自定义的子订单商品名称，无需URL编码，长度限制以具体所接入渠道为准。", "example": "无" }, { "name": "ProductDetail", "type": "string", "required": true, "description": "商品详情。 业务自定义的子订单商品详情，无需URL编码，长度限制以具体所接入渠道为准。", "example": "无" }, { "name": "PlatformIncome", "type": "integer", "required": true, "description": "平台应收。 子订单平台应收金额，单位：分，需要注意的是Amt = PlatformIncome+SubMchIncome。", "example": "无" }, { "name": "SubMchIncome", "type": "integer", "required": true, "description": "商户应收。 子订单结算应收金额，单位：分，需要注意的是Amt = PlatformIncome+SubMchIncome。", "example": "无" }, { "name": "Metadata", "type": "string", "required": true, "description": "透传字段。 发货标识，由开发者在调用米大师下单接口的 时候下发。", "example": "无" }, { "name": "Amt", "type": "integer", "required": true, "description": "支付金额。 子订单支付金额，需要注意的是Amt = PlatformIncome+SubMchIncome。", "example": "无" }, { "name": "OriginalAmt", "type": "integer", "required": true, "description": "原始金额。 子订单原始金额，OriginalAmt\u003e=Amt。", "example": "无" }, { "name": "WxSubMchId", "type": "string", "required": false, "description": "微信子商户号。", "example": "无" }, { "name": "SettleInfo", "type": "object", "required": false, "description": "结算信息。 例如是否需要分账、是否需要支付确认等。", "example": "无", "children": [ { "name": "NeedToBeConfirmed", "type": "integer", "required": false, "description": "是否需要支付确认。 0: 不需要支付确认 1: 需要支付确认 传1时，需要在支付完成后成功调用了《支付确认》接口，该笔订单才会被清分出去", "example": "无" }, { "name": "ProfitSharing", "type": "integer", "required": false, "description": "是否指定分账。 0: 不指定分账 1: 指定分账", "example": "无" } ] }, { "name": "AttachmentInfoList", "type": "array", "required": false, "description": "附加项信息列表。 例如溢价信息、抵扣信息、积分信息、补贴信息 通过该字段可以实现渠道方的优惠抵扣补贴等营销功能。", "example": "无", "item_type": "object", "children": [ { "name": "AttachmentAmount", "type": "integer", "required": true, "description": "附加项金额。 附加项的金额（必须是正数，单位：分），代表积分的数量、抵扣的金额、溢价的金额、补贴的金额", "example": "无" }, { "name": "AttachmentType", "type": "string", "required": true, "description": "附加项类型。 Add：加项； Sub：减项； Point：积分项； Subsidy：补贴项。", "example": "无" }, { "name": "AttachmentName", "type": "string", "required": true, "description": "附加项名称。 当银行作为收单机构可能会对该字段有要求，请向米大师确认。", "example": "无" }, { "name": "AttachmentCode", "type": "string", "required": true, "description": "附加项编号。 当银行作为收单机构可能会对该字段有要求，请向米大师确认。", "example": "无" } ] }, { "name": "ExternalAttachmentDataList", "type": "array", "required": false, "description": "渠道透传数据列表。", "example": "无", "item_type": "object", "children": [ { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名", "example": "无" }, { "name": "AttachmentData", "type": "string", "required": true, "description": "渠道透传字段，由各个渠道自行定义", "example": "无" } ] } ] }, { "name": "SettleInfo", "type": "object", "required": false, "description": "结算信息 例如是否需要分账、是否需要支付确认等， 注意：如果子单列表中传入了SettleInfo，在主单中不可再传入SettleInfo字段。", "example": "无", "children": [ { "name": "NeedToBeConfirmed", "type": "integer", "required": false, "description": "是否需要支付确认。 0: 不需要支付确认 1: 需要支付确认 传1时，需要在支付完成后成功调用了《支付确认》接口，该笔订单才会被清分出去", "example": "无" }, { "name": "ProfitSharing", "type": "integer", "required": false, "description": "是否指定分账。 0: 不指定分账 1: 指定分账", "example": "无" } ] }, { "name": "AttachmentInfoList", "type": "array", "required": false, "description": "附加项信息列表 例如溢价信息、抵扣信息、积分信息、补贴信息 通过该字段可以实现渠道方的优惠抵扣补贴等营销功能 注意：当传SubOrderList时，请在子单信息中传附加项信息，不要在主单中传该字段。", "example": "无", "item_type": "object", "children": [ { "name": "AttachmentAmount", "type": "integer", "required": true, "description": "附加项金额。 附加项的金额（必须是正数，单位：分），代表积分的数量、抵扣的金额、溢价的金额、补贴的金额", "example": "无" }, { "name": "AttachmentType", "type": "string", "required": true, "description": "附加项类型。 Add：加项； Sub：减项； Point：积分项； Subsidy：补贴项。", "example": "无" }, { "name": "AttachmentName", "type": "string", "required": true, "description": "附加项名称。 当银行作为收单机构可能会对该字段有要求，请向米大师确认。", "example": "无" }, { "name": "AttachmentCode", "type": "string", "required": true, "description": "附加项编号。 当银行作为收单机构可能会对该字段有要求，请向米大师确认。", "example": "无" } ] }, { "name": "PaymentNotifyUrl", "type": "string", "required": false, "description": "支付通知地址 调用方可通过该字段传入自定义支付通知地址。", "example": "无" }, { "name": "PayScene", "type": "string", "required": false, "description": "支付场景 需要结合 RealChannel和Channel字段使用可选值: wechat-app 微信APP支付方式 wechat-mini 微信小程序支付，示例：当 RealChannel=wechat Channel=wechat PayScene=wechat-mini时，内部会直接以小程序方式调用微信统一下单接口。", "example": "无" }, { "name": "LocaleCode", "type": "string", "required": false, "description": "语言代码 取值请参考[ISO 639-1代码表](https://zh.wikipedia.org/zh-cn/ISO_639-1%E4%BB%A3%E7%A0%81%E8%A1%A8)", "example": "无" }, { "name": "RegionCode", "type": "string", "required": false, "description": "地区代码 取值请参考[ISO 3166-1二位字母代码表](https://zh.wikipedia.org/zh-cn/ISO_3166-1%E4%BA%8C%E4%BD%8D%E5%AD%97%E6%AF%8D%E4%BB%A3%E7%A0%81#%E6%AD%A3%E5%BC%8F%E5%88%86%E9%85%8D%E4%BB%A3%E7%A0%81)", "example": "无" }, { "name": "UserClientIp", "type": "string", "required": false, "description": "用户IP 请求用户的IP地址，特定的渠道或特定的支付方式，此字段为必填 wechat_ecommerce渠道 - h5支付方式，此字段必填。", "example": "无" }, { "name": "ChannelOrderIdMode", "type": "string", "required": false, "description": "渠道订单号生成模式 枚举值。决定请求渠道方时的订单号的生成模式，详情请联系米大师沟通。不指定时默认为由米大师自行生成。", "example": "无" }, { "name": "GlobalPayTimeInfo", "type": "object", "required": false, "description": "全局支付时间信息", "example": "无", "children": [ { "name": "StartTimestamp", "type": "integer", "required": false, "description": "订单开始时间。 不指定时默认为当前时间。", "example": "无" }, { "name": "ExpireTimestamp", "type": "integer", "required": false, "description": "订单结束时间。 逾期将会拒绝下单。不指定时默认为当前时间的7天后结束。", "example": "无" }, { "name": "TimeOffset", "type": "integer", "required": false, "description": "时区。 不指定时默认为28800，表示北京时间（东八区）。", "example": "无" } ] }, { "name": "ChannelAppIdPolicy", "type": "string", "required": false, "description": "渠道应用ID取用方式 USE_APPID 使用渠道应用Id; USE_SUB_APPID 使用子渠道应用Id; USE_APPID_AND_SUB_APPID 既使用渠道应用Id也使用子渠道应用ID。", "example": "无" }, { "name": "StoreInfo", "type": "object", "required": false, "description": "门店信息 特定的渠道或特定的支付方式，此字段为必填 wechat_ecommerce渠道 - h5支付方式，此字段必填", "example": "无", "children": [ { "name": "StoreId", "type": "string", "required": false, "description": "门店ID。", "example": "无" }, { "name": "StoreName", "type": "string", "required": false, "description": "门店名称。", "example": "无" }, { "name": "StoreAddress", "type": "string", "required": false, "description": "门店地址。", "example": "无" }, { "name": "StoreAreaCode", "type": "string", "required": false, "description": "门店地区代码。", "example": "无" }, { "name": "StoreDeviceId", "type": "string", "required": false, "description": "设备ID。 wechat_ecommerce渠道 - h5支付方式，此字段必填。", "example": "无" } ] }, { "name": "ClientInfo", "type": "object", "required": false, "description": "客户端信息 特定的渠道或特定的支付方式，此字段为必填 wechat_ecommerce渠道 - h5支付方式，此字段必填", "example": "无", "children": [ { "name": "ClientType", "type": "string", "required": false, "description": "场景类型。 wechat_ecommerce渠道 - h5支付方式，此字段必填； 枚举值： CLIENT_TYPE_UNKNOWN 未知; CLIENT_TYPE_IOS ios系统; CLIENT_TYPE_ANDROID 安卓系统; CLIENT_TYPE_WAP WAP场景; CLIENT_TYPE_H5 H5场景;", "example": "无" }, { "name": "AppName", "type": "string", "required": false, "description": "应用名称。", "example": "无" }, { "name": "AppUrl", "type": "string", "required": false, "description": "网站URL。", "example": "无" }, { "name": "BundleId", "type": "string", "required": false, "description": "IOS平台BundleID。", "example": "无" }, { "name": "PackageName", "type": "string", "required": false, "description": "Android平台PackageName", "example": "无" } ] }, { "name": "ExternalPromptGroupList", "type": "array", "required": false, "description": "渠道扩展促销列表 可将各个渠道的促销信息放于该列表。", "example": "无", "item_type": "object", "children": [ { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名。 为米大师定义的枚举值： wechat 微信渠道", "example": "无" }, { "name": "ExternalPromptInfoList", "type": "array", "required": true, "description": "渠道扩展促销信息列表，由各个渠道自行定义。 ChannelName为wechat时，组成为", "example": "无", "item_type": "object", "children": [ { "name": "ExternalPromptType", "type": "string", "required": true, "description": "优惠商品信息类型。", "example": "无" }, { "name": "ExternalPromptValue", "type": "string", "required": true, "description": "优惠商品信息数据。", "example": "无" }, { "name": "ExternalPromptName", "type": "string", "required": false, "description": "优惠商品名称。", "example": "无" } ] } ] }, { "name": "OrderReceiveMode", "type": "string", "required": false, "description": "收单模式 ORDER_RECEIVE_MODE_COMMON - 普通支付 ORDER_RECEIVE_MODE_COMBINE - 合单支付 ORDER_RECEIVE_MODE_V_COMBINE - 虚拟合单支付 若不传入该字段，则会根据是否传入子单来判断是 普通支付 还是 合单支付", "example": "无" }, { "name": "ExternalUserInfoList", "type": "array", "required": false, "description": "渠道方用户信息列表", "example": "无", "item_type": "object", "children": [ { "name": "ExternalUserType", "type": "string", "required": false, "description": "渠道方用户类型", "example": "无" }, { "name": "ExternalUserId", "type": "string", "required": false, "description": "渠道方用户ID", "example": "无" } ] }, { "name": "ExternalAttachmentDataList", "type": "array", "required": false, "description": "渠道透传数据列表", "example": "无", "item_type": "object", "children": [ { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名", "example": "无" }, { "name": "AttachmentData", "type": "string", "required": true, "description": "渠道透传字段，由各个渠道自行定义", "example": "无" } ] } ], "required": [ "MidasAppId", "UserId", "OutTradeNo", "CurrencyType", "ProductId", "ProductName", "ProductDetail", "OriginalAmt", "TotalAmt" ] }, { "name": "UnifiedOrder", "description": "应用需要先调用本接口生成支付订单号，并将应答的PayInfo透传给聚鑫SDK，拉起客户端（包括微信公众号/微信小程序/客户端App）支付。", "status": "online", "parameters": [ { "name": "CurrencyType", "type": "string", "required": true, "description": "ISO 货币代码，CNY", "example": "CNY" }, { "name": "MidasAppId", "type": "string", "required": true, "description": "聚鑫分配的支付主MidasAppId", "example": "your_midas_app_id" }, { "name": "OutTradeNo", "type": "string", "required": true, "description": "支付订单号，仅支持数字、字母、下划线（_）、横杠字符（-）、点（.）的组合", "example": "your_order_no" }, { "name": "ProductDetail", "type": "string", "required": true, "description": "商品详情，需要URL编码", "example": "商品详情" }, { "name": "ProductId", "type": "string", "required": true, "description": "商品ID，仅支持数字、字母、下划线（_）、横杠字符（-）、点（.）的组合", "example": "your_product_id" }, { "name": "ProductName", "type": "string", "required": true, "description": "商品名称，需要URL编码", "example": "商品名称" }, { "name": "TotalAmt", "type": "integer", "required": true, "description": "支付金额，单位： 分", "example": "1" }, { "name": "UserId", "type": "string", "required": true, "description": "用户ID，长度不小于5位，仅支持字母和数字的组合", "example": "your_user_id" }, { "name": "RealChannel", "type": "string", "required": true, "description": "银行真实渠道.如:bank_pingan", "example": "bank_pingan" }, { "name": "OriginalAmt", "type": "integer", "required": true, "description": "原始金额", "example": "1" }, { "name": "MidasSecretId", "type": "string", "required": true, "description": "聚鑫分配的安全ID", "example": "your_midas_secret_id" }, { "name": "MidasSignature", "type": "string", "required": true, "description": "按照聚鑫安全密钥计算的签名", "example": "your_midas_signature" }, { "name": "CallbackUrl", "type": "string", "required": false, "description": "Web端回调地址", "example": "http://callbackurl" }, { "name": "Channel", "type": "string", "required": false, "description": "指定支付渠道： wechat：微信支付 qqwallet：QQ钱包 bank：网银支付 只有一个渠道时需要指定", "example": "wechat" }, { "name": "Metadata", "type": "string", "required": false, "description": "透传字段，支付成功回调透传给应用，用于业务透传自定义内容", "example": "xxxx" }, { "name": "Quantity", "type": "integer", "required": false, "description": "购买数量，不传默认为1", "example": "1" }, { "name": "SubAppId", "type": "string", "required": false, "description": "聚鑫计费SubAppId，代表子商户", "example": "your_sub_app_id" }, { "name": "SubOrderList", "type": "array", "required": false, "description": "子订单信息列表，格式：子订单号、子应用ID、金额。 压缩后最长不可超过65535字节(去除空格，换行，制表符等无意义字符) 注：接入银行或其他支付渠道服务商模式下，必传", "example": "无", "item_type": "object", "children": [ { "name": "SubMchIncome", "type": "integer", "required": true, "description": "子订单结算应收金额，单位： 分" }, { "name": "PlatformIncome", "type": "integer", "required": true, "description": "子订单平台应收金额，单位：分" }, { "name": "ProductDetail", "type": "string", "required": true, "description": "子订单商品详情" }, { "name": "ProductName", "type": "string", "required": true, "description": "子订单商品名称" }, { "name": "SubAppId", "type": "string", "required": true, "description": "聚鑫计费SubAppId，代表子商户" }, { "name": "SubOutTradeNo", "type": "string", "required": true, "description": "子订单号" }, { "name": "Amt", "type": "integer", "required": true, "description": "子订单支付金额" }, { "name": "Metadata", "type": "string", "required": true, "description": "发货标识，由业务在调用聚鑫下单接口的 时候下发" }, { "name": "OriginalAmt", "type": "integer", "required": true, "description": "子订单原始金额" } ] }, { "name": "TotalMchIncome", "type": "integer", "required": false, "description": "结算应收金额，单位：分", "example": "1" }, { "name": "TotalPlatformIncome", "type": "integer", "required": false, "description": "平台应收金额，单位：分", "example": "0" }, { "name": "WxOpenId", "type": "string", "required": false, "description": "微信公众号/小程序支付时为必选，需要传微信下的openid", "example": "xxxx" }, { "name": "WxSubOpenId", "type": "string", "required": false, "description": "在服务商模式下，微信公众号/小程序支付时wx_sub_openid和wx_openid二选一", "example": "your_wx_sub_open_id" }, { "name": "MidasEnvironment", "type": "string", "required": false, "description": "环境名: release: 现网环境 sandbox: 沙箱环境 development: 开发环境 缺省: release", "example": "xxxx" }, { "name": "WxAppId", "type": "string", "required": false, "description": "微信商户应用ID", "example": "your_wx_app_id" }, { "name": "WxSubAppId", "type": "string", "required": false, "description": "微信商户子应用ID", "example": "your_wx_sub_app_id" }, { "name": "PaymentNotifyUrl", "type": "string", "required": false, "description": "支付通知地址", "example": "http://cloud.tencent.com" } ], "required": [ "CurrencyType", "MidasAppId", "OutTradeNo", "ProductDetail", "ProductId", "ProductName", "TotalAmt", "UserId", "RealChannel", "OriginalAmt", "MidasSecretId", "MidasSignature" ] }, { "name": "UnifiedTlinxOrder", "description": "云支付-统一下单接口", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "使用门店OpenId", "example": "f2cc268b9c95fbbb230a19397fe35f8d" }, { "name": "OpenKey", "type": "string", "required": true, "description": "使用门店OpenKey", "example": "e30051d527bd4e621e7090c9392739ec" }, { "name": "DeveloperNo", "type": "string", "required": true, "description": "开发者流水号", "example": "TEST00000458" }, { "name": "PayTag", "type": "string", "required": true, "description": "支付标签", "example": "WeixinLS" }, { "name": "TradeAmount", "type": "string", "required": true, "description": "实际交易金额（以分为单位，没有小数点）", "example": "1" }, { "name": "NotifyUrl", "type": "string", "required": true, "description": "交易结果异步通知url地址", "example": "http://www.baidu.com/tlinx2apidemo1/callback/scanpay_cashier/pay" }, { "name": "PayName", "type": "string", "required": false, "description": "付款方式名称(当PayTag为Diy时，PayName不能为空)", "example": "1" }, { "name": "JumpUrl", "type": "string", "required": false, "description": "公众号支付时，支付成功后跳转url地址", "example": "http://www.baidu.com/tlinx2apidemo1/callback/scanpay_cashier/pay" }, { "name": "OrderName", "type": "string", "required": false, "description": "订单名称（描述）", "example": "自定义订单名称" }, { "name": "OriginalAmount", "type": "string", "required": false, "description": "原始交易金额（以分为单位，没有小数点）", "example": "1" }, { "name": "IgnoreAmount", "type": "string", "required": false, "description": "抹零金额（以分为单位，没有小数点）", "example": "1" }, { "name": "DiscountAmount", "type": "string", "required": false, "description": "折扣金额（以分为单位，没有小数点）", "example": "1" }, { "name": "TradeAccount", "type": "string", "required": false, "description": "交易帐号（银行卡号）", "example": "622522" }, { "name": "TradeNo", "type": "string", "required": false, "description": "交易号（收单机构交易号）", "example": "T001" }, { "name": "AuthCode", "type": "string", "required": false, "description": "条码支付的授权码（条码抢扫手机扫到的一串数字）", "example": "33523" }, { "name": "Tag", "type": "string", "required": false, "description": "订单标记，订单附加数据。", "example": "附加数据" }, { "name": "Remark", "type": "string", "required": false, "description": "订单备注", "example": "备注" }, { "name": "TradeResult", "type": "string", "required": false, "description": "收单机构原始交易报文，请转换为json", "example": "null" }, { "name": "Royalty", "type": "string", "required": false, "description": "0-不分账，1-需分账。为1时标记为待分账订单，待分账订单不会进行清算。不传默认为不分账。", "example": "1" }, { "name": "Jsapi", "type": "string", "required": false, "description": "小程序支付参数：填默认值 1", "example": "1" }, { "name": "SubAppId", "type": "string", "required": false, "description": "小程序支付参数： 当前调起支付的小程序APPID", "example": "xxx" }, { "name": "SubOpenId", "type": "string", "required": false, "description": "小程序支付参数: 用户在子商户appid下的唯一标识。", "example": "xxx" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey", "DeveloperNo", "PayTag", "TradeAmount", "NotifyUrl" ] }, { "name": "UploadExternalAnchorInfo", "description": "灵云-上传主播信息", "status": "online", "parameters": [ { "name": "AnchorId", "type": "string", "required": true, "description": "主播Id", "example": "无" }, { "name": "IdCardFront", "type": "string", "required": false, "description": "身份证正面图片下载链接", "example": "无" }, { "name": "IdCardReverse", "type": "string", "required": false, "description": "身份证反面图片下载链接", "example": "无" } ], "required": [ "AnchorId" ] }, { "name": "UploadFile", "description": "直播平台-文件上传", "status": "online", "parameters": [ { "name": "FileName", "type": "string", "required": true, "description": "文件名", "example": "demo.png" }, { "name": "FileType", "type": "string", "required": true, "description": "文件类型 __IdCard__:身份证 __IdCardCheck__:身份证加验证(只支持人像面)", "example": "IdCard" }, { "name": "FileUrl", "type": "string", "required": false, "description": "文件链接 __FileUrl和FileContent二选一__", "example": "无" }, { "name": "FileContent", "type": "string", "required": false, "description": "文件内容，Base64编码 __FileUrl和FileContent二选一__", "example": "无" }, { "name": "FileExtendInfo", "type": "array", "required": false, "description": "文件扩展信息", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "扩展信息类型 __id_card_no__:身份证号码 __id_card_name__:身份证姓名 __id_card_front__:身份证图片正面 __id_card_back__:身份证图片反面 __tax_type__:完税类型:0-自然人,1-个体工商户 __channel_account__:渠道账号(_敏感信息_ 使用 __AES128-CBC-PKCS#7__ 加密)", "example": "id_card_front" }, { "name": "Value", "type": "string", "required": true, "description": "扩展信息", "example": "file.png" } ] } ], "required": [ "FileName", "FileType" ] }, { "name": "UploadOpenBankSubMerchantCredential", "description": "云企付-子商户资质文件上传", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户ID。", "example": "无" }, { "name": "ChannelSubMerchantId", "type": "string", "required": true, "description": "渠道子商户ID。", "example": "无" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称。详见附录-枚举类型-ChannelName。", "example": "HELIPAY" }, { "name": "OutApplyId", "type": "string", "required": true, "description": "外部序列进件号。", "example": "无" }, { "name": "CredentialType", "type": "string", "required": true, "description": "资质类型，详见附录-枚举类型-CredentialType。", "example": "无" }, { "name": "FileType", "type": "string", "required": true, "description": "文件类型。 合利宝渠道，文件类型为PNG/JPG格式。", "example": "无" }, { "name": "PaymentMethod", "type": "string", "required": false, "description": "支付方式。 合利宝渠道不需要传。", "example": "无" }, { "name": "CredentialContent", "type": "string", "required": false, "description": "资质文件内容。Base64编码，资质文件内容和链接二选一。 合利宝渠道，文件限制大小5M以内。", "example": "无" }, { "name": "CredentialUrl", "type": "string", "required": false, "description": "资质文件链接。资质文件内容和链接二选一。 合利宝渠道，文件限制大小5M以内。", "example": "无" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "无" } ], "required": [ "ChannelMerchantId", "ChannelSubMerchantId", "ChannelName", "OutApplyId", "CredentialType", "FileType" ] }, { "name": "UploadOrgFile", "description": "云支付-上传机构文件接口", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "收单系统分配的开放ID", "example": "f2cc268b9c95fbbb230a19397fe35f8d" }, { "name": "OpenKey", "type": "string", "required": true, "description": "收单系统分配的密钥", "example": "e30051d527bd4e621e7090c9392739ec" }, { "name": "Storage", "type": "string", "required": true, "description": "存储区域（0私密区，1公共区），请严格按文件要求，上传到不同的区域", "example": "1" }, { "name": "FileMd5", "type": "string", "required": true, "description": "文件的md5值（为防止平台多次上传重复文件，文件名为文件md5,且不会覆盖，重复上传返回第一次上传成功的文件路径）", "example": "E68A2FEBA43406F3D27B38F71E1C39A7" }, { "name": "FileContent", "type": "string", "required": true, "description": "文件内容（先将图片转换成二进制，再进行base64加密）", "example": "iVBORw0KGgoAAAANSUhEUgAAAI8AAAAeCAYAAAAVWU11AAAACXBIWXMAAAsTAAAL" }, { "name": "FileExtension", "type": "string", "required": true, "description": "文件扩展名（png,jpg,gif）", "example": "jpg" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey", "Storage", "FileMd5", "FileContent", "FileExtension" ] }, { "name": "UploadTaxList", "description": "直播平台-上传代理商完税列表", "status": "online", "parameters": [ { "name": "Channel", "type": "integer", "required": true, "description": "平台渠道" }, { "name": "BeginMonth", "type": "string", "required": true, "description": "起始月份，YYYY-MM" }, { "name": "EndMonth", "type": "string", "required": true, "description": "结束月份。如果只上传一个月，结束月份等于起始月份" }, { "name": "FileUrl", "type": "string", "required": true, "description": "完税列表下载地址" } ], "required": [ "Channel", "BeginMonth", "EndMonth", "FileUrl" ] }, { "name": "UploadTaxPayment", "description": "直播平台-上传代理商完税证明", "status": "online", "parameters": [ { "name": "Channel", "type": "integer", "required": true, "description": "平台渠道", "example": "1" }, { "name": "TaxId", "type": "string", "required": true, "description": "完税ID", "example": "tax-xxx" }, { "name": "FileUrl", "type": "string", "required": true, "description": "完税列表下载地址", "example": "http://cos.qcloud.com/tax.xlsx" } ], "required": [ "Channel", "TaxId", "FileUrl" ] }, { "name": "VerifyOpenBankAccount", "description": "云企付-子商户银行卡打款验证，在接入TENPAY渠道EBANK_PAYMENT付款时，若客户期望接入担保支付，需在接入前先完成，收款商户绑定的银行卡进行打款验证。验证成功后，才可以调用CreateOpenBankPaymentOrder接口进行担保支付下单。", "status": "online", "parameters": [ { "name": "ChannelMerchantId", "type": "string", "required": true, "description": "渠道商户号。外部接入平台入驻云企付平台下发", "example": "CM584693967762206720" }, { "name": "ChannelName", "type": "string", "required": true, "description": "渠道名称。详见附录-云企付枚举类说明-ChannelName。 __TENPAY__: 商企付", "example": "TENPAY" }, { "name": "PayeeInfo", "type": "object", "required": true, "description": "收款方信息。", "example": "无", "children": [ { "name": "PayeeId", "type": "string", "required": false, "description": "收款方唯一标识。 当渠道为TENPAY，付款方式为EBANK_PAYMENT，必填，上送收款方入驻云企付商户ID； 付款方式为OPENBANK_PAYMENT时，非必填，输入外部收款方的标识ID 渠道为WECHAT，付款方式为TRANS_TO_CHANGE时，上送微信OPEN_ID；", "example": "sub1w00002" }, { "name": "BankBranchName", "type": "string", "required": false, "description": "支行名称。", "example": "深圳华侨城支行" }, { "name": "BankAccountNumber", "type": "string", "required": false, "description": "银行账号。渠道为TENPAY，付款方式为OPENBANK_PAYMENT时必选", "example": "310899991010003084911" }, { "name": "PayeeName", "type": "string", "required": false, "description": "收款方名称。 当渠道为TENPAY，付款方式为EBANK_PAYMENT时，上送收款方入驻云企付的商户名称； 渠道为TENPAY，付款方式为OPENBANK_PAYMENT时必选，上送收款方账户名称； 渠道为ALIPAY，付款方式为SAFT_ISV时，收款账户标识类型为ALIPAY_LOGON_ID时必传，上送收款方真实姓名。 渠道为WECHAT，付款方式为TRANS_TO_CHANGE时，上送收款人姓名。", "example": "收款子商户0002" }, { "name": "BankBranchId", "type": "string", "required": false, "description": "联行号。渠道为TENPAY，付款方式为OPENBANK_PAYMENT时必选", "example": "301290050123" }, { "name": "BindSerialNo", "type": "string", "required": false, "description": "收款方绑卡序列号。 当渠道为TENPAY，付款方式为EBANK_PAYMENT时，必填，上送收款方入驻云企付平台时，下发的绑卡序列号；当渠道为ALIPAY，付款方式为SAFT_ISV时，必填，根据收款账户标识类型上送。", "example": "10232043567" }, { "name": "AccountType", "type": "string", "required": false, "description": "收款账户标识类型 BANK_ACCOUNT：绑定银行账户 ACCOUNT_BOOK_ID：电子记账本ID ALIPAY_USER_ID：支付宝的会员ID ALIPAY_LOGON_ID：支付宝登录号。 付款方式为SAFT_ISV时，必填。", "example": "ACCOUNT_BOOK_ID" } ] }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "通知地址，如www.test.com。", "example": "https://xxx.cloud.xxx.com/notify" }, { "name": "Environment", "type": "string", "required": false, "description": "环境类型。 __release__:生产环境 __sandbox__:沙箱环境 _不填默认为生产环境_", "example": "无" } ], "required": [ "ChannelMerchantId", "ChannelName", "PayeeInfo" ] }, { "name": "ViewContract", "description": "云支付-查询合同明细接口", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "收单系统分配的开放ID", "example": "f2cc268b9c95fbbb230a19397fe35f8d" }, { "name": "OpenKey", "type": "string", "required": true, "description": "收单系统分配的密钥", "example": "e30051d527bd4e621e7090c9392739ec" }, { "name": "OutContractId", "type": "string", "required": false, "description": "外部合同主键编号（ContractId或OutContractId必须传一个）", "example": "C001" }, { "name": "ContractId", "type": "string", "required": false, "description": "合同主键（ContractId或OutContractId必须传一个）", "example": "TestC115" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey" ] }, { "name": "ViewMerchant", "description": "云支付-查询商户明细接口", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "收单系统分配的开放ID", "example": "f2cc268b9c95fbbb230a19397fe35f8d" }, { "name": "OpenKey", "type": "string", "required": true, "description": "收单系统分配的密钥", "example": "e30051d527bd4e621e7090c9392739ec" }, { "name": "OutMerchantId", "type": "string", "required": false, "description": "外部商户主键编号（MerchantNo或OutMerchantId必须传一个）", "example": "S0001" }, { "name": "MerchantNo", "type": "string", "required": false, "description": "商户编号（MerchantNo或OutMerchantId必须传一个）", "example": "Test10" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey" ] }, { "name": "ViewShop", "description": "云支付-查询门店明细接口", "status": "online", "parameters": [ { "name": "OpenId", "type": "string", "required": true, "description": "收单系统分配的开放ID", "example": "f2cc268b9c95fbbb230a19397fe35f8d" }, { "name": "OpenKey", "type": "string", "required": true, "description": "收单系统分配的密钥", "example": "e30051d527bd4e621e7090c9392739ec" }, { "name": "OutShopId", "type": "string", "required": false, "description": "外部商户主键编号（ShopNo或OutShopId必须传一个）", "example": "test1" }, { "name": "ShopNo", "type": "string", "required": false, "description": "门店编号（ShopNo或OutShopId必须传一个）", "example": "Test5333" }, { "name": "Profile", "type": "string", "required": false, "description": "沙箱环境填sandbox，正式环境不填", "example": "sandbox" } ], "required": [ "OpenId", "OpenKey" ] }, { "name": "WithdrawCashMembership", "description": "会员提现-不验证。此接口受理会员发起的提现申请。会员子账户的可提现余额、可用余额会减少，市场的资金汇总账户(监管账户)会减少相应的发生金额，提现到会员申请的收款账户。", "status": "online", "parameters": [ { "name": "MrchCode", "type": "string", "required": true, "description": "String(22)，商户号（签约客户号）" }, { "name": "TranWebName", "type": "string", "required": true, "description": "STRING(150)，交易网名称（市场名称）" }, { "name": "MemberGlobalType", "type": "string", "required": true, "description": "STRING(5)，会员证件类型（详情见“常见问题”）" }, { "name": "MemberGlobalId", "type": "string", "required": true, "description": "STRING(32)，会员证件号码" }, { "name": "TranNetMemberCode", "type": "string", "required": true, "description": "STRING(32)，交易网会员代码" }, { "name": "MemberName", "type": "string", "required": true, "description": "STRING(150)，会员名称" }, { "name": "TakeCashAcctNo", "type": "string", "required": true, "description": "STRING(50)，提现账号（银行卡）" }, { "name": "OutAmtAcctName", "type": "string", "required": true, "description": "STRING(150)，出金账户名称（银行卡户名）" }, { "name": "Ccy", "type": "string", "required": true, "description": "STRING(3)，币种（默认为RMB）" }, { "name": "CashAmt", "type": "string", "required": true, "description": "STRING(20)，可提现金额" }, { "name": "Remark", "type": "string", "required": false, "description": "STRING(300)，备注（建议可送订单号，可在对账文件的备注字段获取到）" }, { "name": "ReservedMsg", "type": "string", "required": false, "description": "STRING(1027)，保留域" }, { "name": "WebSign", "type": "string", "required": false, "description": "STRING(300)，网银签名" }, { "name": "Profile", "type": "string", "required": false, "description": "STRING(12)，接入环境，默认接入沙箱环境。接入正式环境填\"prod\"" } ], "required": [ "MrchCode", "TranWebName", "MemberGlobalType", "MemberGlobalId", "TranNetMemberCode", "MemberName", "TakeCashAcctNo", "OutAmtAcctName", "Ccy", "CashAmt" ] } ] }