{ "openapi" : "3.0.3", "info" : { "title" : "支付宝开放平台API", "description" : "支付宝开放平台v3协议文档", "contact" : { "name" : "开放平台文档中心", "url" : "https://openhome.alipay.com/developmentDocument.htm" }, "version" : "2023-06-06" }, "servers" : [ { "url" : "https://openapi.alipay.com", "description" : "Production server" }, { "url" : "http://openapi.sandbox.dl.alipaydev.com", "description" : "Sandbox server" } ], "paths" : { "/v3/alios/open/auto/info/query" : { "get" : { "tags" : [ "alios.open.auto.info" ], "summary" : "查询阿里车的车辆信息", "description" : "用户授权商户可获取用户的车辆信息后商户可通过openapi获取车辆信息", "operationId" : "alios.open.auto.info.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AliosOpenAutoInfoQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AliosOpenAutoInfoQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/AuthToken" }, { "name" : "user_id", "in" : "query", "description" : "蚂蚁统一会员ID", "schema" : { "type" : "string", "example" : "33424562" } }, { "name" : "open_id", "in" : "query", "description" : "经度", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } }, { "name" : "device_token", "in" : "query", "description" : "设备token", "schema" : { "type" : "string", "example" : "cn-shanghai.e81fe6ffe0214049be4da405b3e78849" } } ] } }, "/v3/alipay/boss/fnc/invoice/apply" : { "post" : { "tags" : [ "alipay.boss.fnc.invoice" ], "summary" : "应收开票申请(根据账单申请)", "description" : "根据账单申请应收发票开票", "operationId" : "alipay.boss.fnc.invoice.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayBossFncInvoiceApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayBossFncInvoiceApplyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayBossFncInvoiceApplyModel" } } }, "required" : false } } }, "/v3/alipay/boss/fnc/invoice/batchquery" : { "post" : { "tags" : [ "alipay.boss.fnc.invoice" ], "summary" : "应收发票综合查询", "description" : "根据综合查询条件查询对应发票信息", "operationId" : "alipay.boss.fnc.invoice.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayBossFncInvoiceBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayBossFncInvoiceBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayBossFncInvoiceBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/boss/fnc/invoice/query" : { "get" : { "tags" : [ "alipay.boss.fnc.invoice" ], "summary" : "根据发票ID查询发票信息", "description" : "根据发票综合查询接口（alipay.boss.fnc.invoice.batchquery）查询到发票列表后，再根据每个发票对应的发票id查询发票的详细信息", "operationId" : "alipay.boss.fnc.invoice.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayBossFncInvoiceQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayBossFncInvoiceQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "invoice_id", "in" : "query", "description" : "查询ID：用于标示一张发票，通过发票综合查询可以查询到该ID。", "schema" : { "type" : "string", "example" : "如：2017060210122000040400270002815483" } } ] } }, "/v3/alipay/boss/fnc/invoicereceipt/batchquery" : { "post" : { "tags" : [ "alipay.boss.fnc.invoicereceipt" ], "summary" : "根据月账单号集合和来源查询开票单据及金额汇总", "description" : "根据月账单号集合和来源查询开票单据及金额汇总", "operationId" : "alipay.boss.fnc.invoicereceipt.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayBossFncInvoicereceiptBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayBossFncInvoicereceiptBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayBossFncInvoicereceiptBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/boss/fnc/invoicereceipt/create" : { "post" : { "tags" : [ "alipay.boss.fnc.invoicereceipt" ], "summary" : "账单变更同步接口月帐单创建消息同步", "description" : "月帐单创建消息同步", "operationId" : "alipay.boss.fnc.invoicereceipt.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayBossFncInvoicereceiptCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayBossFncInvoicereceiptCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayBossFncInvoicereceiptCreateModel" } } }, "required" : false } } }, "/v3/alipay/boss/fnc/userinvoiceinfo/create" : { "post" : { "tags" : [ "alipay.boss.fnc.userinvoiceinfo" ], "summary" : "新增客户开票资料", "description" : "申请开票alipay.boss.fnc.invoice.create之前需要维护的开票资料信息", "operationId" : "alipay.boss.fnc.userinvoiceinfo.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayBossFncUserinvoiceinfoCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayBossFncUserinvoiceinfoCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayBossFncUserinvoiceinfoCreateModel" } } }, "required" : false } } }, "/v3/alipay/boss/fnc/userinvoiceinfo/modify" : { "post" : { "tags" : [ "alipay.boss.fnc.userinvoiceinfo" ], "summary" : "修改用户开票资料", "description" : "通过查询用户的开票资料（alipay.boss.fnc.userinvoiceinfo.query）后进行开票资料的修改", "operationId" : "alipay.boss.fnc.userinvoiceinfo.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayBossFncUserinvoiceinfoModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayBossFncUserinvoiceinfoModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayBossFncUserinvoiceinfoModifyModel" } } }, "required" : false } } }, "/v3/alipay/boss/fnc/userinvoiceinfo/query" : { "get" : { "tags" : [ "alipay.boss.fnc.userinvoiceinfo" ], "summary" : "根据PID获取相关的开票资料", "description" : "根据PID获取相关的开票资料", "operationId" : "alipay.boss.fnc.userinvoiceinfo.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayBossFncUserinvoiceinfoQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayBossFncUserinvoiceinfoQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "pid", "in" : "query", "description" : "开票pid/mid/ou，唯一标识商户信息/集团用户信息的ID", "schema" : { "type" : "string", "example" : "2088001007243670" } } ] } }, "/v3/alipay/boss/prod/my/test/query" : { "get" : { "tags" : [ "alipay.boss.prod.my.test" ], "summary" : "明焕open测试", "description" : "测试", "operationId" : "alipay.boss.prod.my.test.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayBossProdMyTestQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayBossProdMyTestQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "area_code", "in" : "query", "description" : "区.", "schema" : { "type" : "string", "example" : "sahuidsa" } } ] } }, "/v3/alipay/commerce/cityfacilitator/station/query" : { "get" : { "tags" : [ "alipay.commerce.cityfacilitator.station" ], "summary" : "地铁购票站点数据查询", "description" : "商户App获取地铁购票开放购票的站点和禁止到达的站点", "operationId" : "alipay.commerce.cityfacilitator.station.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceCityfacilitatorStationQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceCityfacilitatorStationQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "city_code", "in" : "query", "description" : "城市编码请参考查询 中华人民共和国行政区划代码。\t已支持城市：广州 440100，深圳 440300，杭州330100。", "schema" : { "type" : "string", "example" : "440300" } } ] } }, "/v3/alipay/commerce/cityfacilitator/voucher/batchquery" : { "post" : { "tags" : [ "alipay.commerce.cityfacilitator.voucher" ], "summary" : "地铁购票订单批量查询", "description" : "商户APP调该接口批量查询订单状态", "operationId" : "alipay.commerce.cityfacilitator.voucher.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceCityfacilitatorVoucherBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceCityfacilitatorVoucherBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceCityfacilitatorVoucherBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/commerce/cityfacilitator/voucher/generate" : { "post" : { "tags" : [ "alipay.commerce.cityfacilitator.voucher" ], "summary" : "地铁购票核销码发码", "description" : "商户APP调快捷支付付款后，获取地铁购票的核销码", "operationId" : "alipay.commerce.cityfacilitator.voucher.generate", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceCityfacilitatorVoucherGenerateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceCityfacilitatorVoucherGenerateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceCityfacilitatorVoucherGenerateModel" } } }, "required" : false } } }, "/v3/alipay/commerce/cityfacilitator/voucher/refund" : { "post" : { "tags" : [ "alipay.commerce.cityfacilitator.voucher" ], "summary" : "地铁购票发码退款", "description" : "地铁购票，商户发码后，调该接口从中间户退款", "operationId" : "alipay.commerce.cityfacilitator.voucher.refund", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceCityfacilitatorVoucherRefundResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceCityfacilitatorVoucherRefundErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceCityfacilitatorVoucherRefundModel" } } }, "required" : false } } }, "/v3/alipay/commerce/ec/balance/downloadurl/query" : { "get" : { "tags" : [ "alipay.commerce.ec.balance.downloadurl" ], "summary" : "对账单文件下载接口", "description" : "对账单文件下载接口", "operationId" : "alipay.commerce.ec.balance.downloadurl.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcBalanceDownloadurlQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcBalanceDownloadurlQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "enterprise_id", "in" : "query", "description" : "企业ID", "schema" : { "type" : "string", "example" : "2088123456789000" } }, { "name" : "account_id", "in" : "query", "description" : "共同账户ID", "schema" : { "type" : "string", "example" : "2088000295356628" } }, { "name" : "agreement_no", "in" : "query", "description" : "授权签约协议号", "schema" : { "type" : "string", "example" : "20205820659822371223" } }, { "name" : "bill_type", "in" : "query", "description" : "账单类型", "schema" : { "type" : "string", "example" : "enterprisetrade" } }, { "name" : "bill_date", "in" : "query", "description" : "账单时间", "schema" : { "type" : "string", "example" : "yyyy-MM-dd" } } ] } }, "/v3/alipay/commerce/ec/balance/period/modify" : { "post" : { "tags" : [ "alipay.commerce.ec.balance.period" ], "summary" : "企业码月对账单账期修改", "description" : "用于在企业码B端后台创建的企业调整月对账单账期", "operationId" : "alipay.commerce.ec.balance.period.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcBalancePeriodModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcBalancePeriodModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcBalancePeriodModifyModel" } } }, "required" : false } } }, "/v3/alipay/commerce/ec/consume/detail/query" : { "post" : { "tags" : [ "alipay.commerce.ec.consume.detail" ], "summary" : "企业码账单详情查询", "description" : "用于企业查询企业码账单详情", "operationId" : "alipay.commerce.ec.consume.detail.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcConsumeDetailQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcConsumeDetailQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcConsumeDetailQueryModel" } } }, "required" : false } } }, "/v3/alipay/commerce/ec/department" : { "put" : { "tags" : [ "alipay.commerce.ec.department.info" ], "summary" : "企业部门信息修改", "description" : "修改企业部门信息", "operationId" : "alipay.commerce.ec.department.info.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcDepartmentInfoModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcDepartmentInfoModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcDepartmentInfoModifyModel" } } }, "required" : false } }, "post" : { "tags" : [ "alipay.commerce.ec.department" ], "summary" : "企业部门创建", "description" : "创建企业部门", "operationId" : "alipay.commerce.ec.department.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcDepartmentCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcDepartmentCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcDepartmentCreateModel" } } }, "required" : false } } }, "/v3/alipay/commerce/ec/department/delete" : { "post" : { "tags" : [ "alipay.commerce.ec.department" ], "summary" : "企业部门删除", "description" : "删除企业部门", "operationId" : "alipay.commerce.ec.department.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcDepartmentDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcDepartmentDeleteErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcDepartmentDeleteModel" } } }, "required" : false } } }, "/v3/alipay/commerce/ec/department/info/query" : { "get" : { "tags" : [ "alipay.commerce.ec.department.info" ], "summary" : "查询部门详情", "description" : "根据部门id查询企业下某个部门的详细信息", "operationId" : "alipay.commerce.ec.department.info.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcDepartmentInfoQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcDepartmentInfoQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "enterprise_id", "in" : "query", "description" : "企业id", "schema" : { "type" : "string", "example" : "2088441363102941" } }, { "name" : "department_id", "in" : "query", "description" : "部门id", "schema" : { "type" : "string", "example" : "1001094000039142" } } ] } }, "/v3/alipay/commerce/ec/department/sublist/query" : { "get" : { "tags" : [ "alipay.commerce.ec.department.sublist" ], "summary" : "查询子部门id列表", "description" : "查询某个部门的子部门id列表，支持查询根部门id", "operationId" : "alipay.commerce.ec.department.sublist.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcDepartmentSublistQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcDepartmentSublistQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "enterprise_id", "in" : "query", "description" : "企业id", "schema" : { "type" : "string", "example" : "2088441363102941" } }, { "name" : "department_id", "in" : "query", "description" : "部门id，特殊值 -1 表示查询根部门id", "schema" : { "type" : "string", "example" : "1001094000039142" } } ] } }, "/v3/alipay/commerce/ec/employee/add" : { "post" : { "tags" : [ "alipay.commerce.ec.employee" ], "summary" : "添加员工", "description" : "企业添加员工，并返回员工签约链接", "operationId" : "alipay.commerce.ec.employee.add", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEmployeeAddResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcEmployeeAddErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEmployeeAddModel" } } }, "required" : false } } }, "/v3/alipay/commerce/ec/employee/delete" : { "post" : { "tags" : [ "alipay.commerce.ec.employee" ], "summary" : "删除员工", "description" : "删除员工并解绑因公付", "operationId" : "alipay.commerce.ec.employee.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEmployeeDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcEmployeeDeleteErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEmployeeDeleteModel" } } }, "required" : false } } }, "/v3/alipay/commerce/ec/employee/idlist/query" : { "get" : { "tags" : [ "alipay.commerce.ec.employee.idlist" ], "summary" : "查询部门下员工id列表", "description" : "查询某个部门下员工id列表", "operationId" : "alipay.commerce.ec.employee.idlist.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEmployeeIdlistQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcEmployeeIdlistQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "enterprise_id", "in" : "query", "description" : "企业id", "schema" : { "type" : "string", "example" : "2088441363102941" } }, { "name" : "department_id", "in" : "query", "description" : "部门id", "schema" : { "type" : "string", "example" : "1001094000039142" } }, { "name" : "page_num", "in" : "query", "description" : "查询页数", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "每页查询大小，限制最大为1000", "schema" : { "type" : "integer", "example" : "1000" } } ] } }, "/v3/alipay/commerce/ec/employee/info" : { "put" : { "tags" : [ "alipay.commerce.ec.employee.info" ], "summary" : "员工信息修改", "description" : "员工信息修改", "operationId" : "alipay.commerce.ec.employee.info.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEmployeeInfoModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcEmployeeInfoModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEmployeeInfoModifyModel" } } }, "required" : false } } }, "/v3/alipay/commerce/ec/employee/info/query" : { "get" : { "tags" : [ "alipay.commerce.ec.employee.info" ], "summary" : "查询员工详情", "description" : "根据员工id或员工uid查询企业下某个员工的详细信息", "operationId" : "alipay.commerce.ec.employee.info.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEmployeeInfoQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcEmployeeInfoQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "enterprise_id", "in" : "query", "description" : "企业id", "schema" : { "type" : "string", "example" : "2088441363102941" } }, { "name" : "employee_id", "in" : "query", "description" : "员工id", "schema" : { "type" : "string", "example" : "228420000000057942506" } }, { "name" : "open_id", "in" : "query", "description" : "蚂蚁统一会员ID", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } }, { "name" : "user_id", "in" : "query", "description" : "蚂蚁统一会员ID", "schema" : { "type" : "string", "example" : "2088501304519332" } } ] } }, "/v3/alipay/commerce/ec/employee/invite" : { "get" : { "tags" : [ "alipay.commerce.ec.employee.invite" ], "summary" : "获取员工邀请链接", "description" : "获取员工邀请链接，若只传入企业ID企业则邀请链接对企业员工均有效，若传入了企业ID和员工ID则链接只对传入的员工ID有效", "operationId" : "alipay.commerce.ec.employee.invite.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEmployeeInviteQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcEmployeeInviteQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "enterprise_id", "in" : "query", "description" : "企业id", "schema" : { "type" : "string", "example" : "2088985758939" } }, { "name" : "employee_id", "in" : "query", "description" : "企业码员工ID", "schema" : { "type" : "string", "example" : "2288099887700000" } }, { "name" : "page_content_code", "in" : "query", "description" : "页面内容code", "schema" : { "type" : "string", "example" : "PCC_STANDARD" } } ] } }, "/v3/alipay/commerce/ec/employee/title" : { "put" : { "tags" : [ "alipay.commerce.ec.employee.title" ], "summary" : "修改员工抬头信息", "description" : "修改员工抬头信息", "operationId" : "alipay.commerce.ec.employee.title.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEmployeeTitleModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcEmployeeTitleModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEmployeeTitleModifyModel" } } }, "required" : false } }, "post" : { "tags" : [ "alipay.commerce.ec.employee.title" ], "summary" : "新增员工抬头关系", "description" : "批量新增员工抬头关系", "operationId" : "alipay.commerce.ec.employee.title.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEmployeeTitleCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcEmployeeTitleCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEmployeeTitleCreateModel" } } }, "required" : false } } }, "/v3/alipay/commerce/ec/employee/title/delete" : { "post" : { "tags" : [ "alipay.commerce.ec.employee.title" ], "summary" : "删除员工抬头信息", "description" : "批量删除员工抬头信息", "operationId" : "alipay.commerce.ec.employee.title.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEmployeeTitleDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcEmployeeTitleDeleteErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEmployeeTitleDeleteModel" } } }, "required" : false } } }, "/v3/alipay/commerce/ec/enterprise" : { "put" : { "tags" : [ "alipay.commerce.ec.enterprise.info" ], "summary" : "企业信息修改", "description" : "修改企业信息", "operationId" : "alipay.commerce.ec.enterprise.info.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEnterpriseInfoModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcEnterpriseInfoModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEnterpriseInfoModifyModel" } } }, "required" : false } } }, "/v3/alipay/commerce/ec/enterprise/address" : { "get" : { "tags" : [ "alipay.commerce.ec.enterprise.address" ], "summary" : "企业地址查询", "description" : "查询企业地址信息", "operationId" : "alipay.commerce.ec.enterprise.address.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEnterpriseAddressQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcEnterpriseAddressQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "enterprise_id", "in" : "query", "description" : "企业id和account_id二选一", "schema" : { "type" : "string", "example" : "208890399440" } }, { "name" : "account_id", "in" : "query", "description" : "共同账户id和enterprise_id二选一", "schema" : { "type" : "string", "example" : "2088483784949" } }, { "name" : "agreement_no", "in" : "query", "description" : "协议号，如果填共同账户id，则该字段必填", "schema" : { "type" : "string", "example" : "23893293203" } }, { "name" : "address_id", "in" : "query", "description" : "地址id", "schema" : { "type" : "string", "example" : "190309300303" } }, { "name" : "city_code", "in" : "query", "description" : "市", "schema" : { "type" : "string", "example" : "310023" } }, { "name" : "page_num", "in" : "query", "description" : "页码从1开始", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "每页数据", "schema" : { "type" : "integer", "example" : "20" } } ] }, "put" : { "tags" : [ "alipay.commerce.ec.enterprise.address" ], "summary" : "企业地址修改", "description" : "企业地址修改", "operationId" : "alipay.commerce.ec.enterprise.address.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEnterpriseAddressModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcEnterpriseAddressModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEnterpriseAddressModifyModel" } } }, "required" : false } }, "post" : { "tags" : [ "alipay.commerce.ec.enterprise.address" ], "summary" : "企业地址添加", "description" : "企业地址添加", "operationId" : "alipay.commerce.ec.enterprise.address.add", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEnterpriseAddressAddResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcEnterpriseAddressAddErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEnterpriseAddressAddModel" } } }, "required" : false } } }, "/v3/alipay/commerce/ec/enterprise/agreement" : { "get" : { "tags" : [ "alipay.commerce.ec.enterprise.agreement" ], "summary" : "查询企业签约企业码信息", "description" : "查询企业签约企业码信息", "operationId" : "alipay.commerce.ec.enterprise.agreement.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEnterpriseAgreementQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcEnterpriseAgreementQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "enterprise_id", "in" : "query", "description" : "企业id；enterprise_id与account_id至少传一个，如果都传了优先使用enterprise_id", "schema" : { "type" : "string", "example" : "2088441399627416" } }, { "name" : "account_id", "in" : "query", "description" : "资金共同账号id；enterprise_id与account_id至少传一个，如果都传了优先使用enterprise_id", "schema" : { "type" : "string", "example" : "2088610274867962" } } ] } }, "/v3/alipay/commerce/ec/enterprise/create" : { "post" : { "tags" : [ "alipay.commerce.ec.enterprise" ], "summary" : "企业入驻", "description" : "企业入驻，并返回签约链接", "operationId" : "alipay.commerce.ec.enterprise.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEnterpriseCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcEnterpriseCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEnterpriseCreateModel" } } }, "required" : false } } }, "/v3/alipay/commerce/ec/enterprise/delete" : { "post" : { "tags" : [ "alipay.commerce.ec.enterprise" ], "summary" : "企业注销", "description" : "企业注销，清理企业数据", "operationId" : "alipay.commerce.ec.enterprise.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEnterpriseDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcEnterpriseDeleteErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEnterpriseDeleteModel" } } }, "required" : false } } }, "/v3/alipay/commerce/ec/enterprise/info" : { "get" : { "tags" : [ "alipay.commerce.ec.enterprise.info" ], "summary" : "查询企业详情", "description" : "查询企业详细信息", "operationId" : "alipay.commerce.ec.enterprise.info.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEnterpriseInfoQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcEnterpriseInfoQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "enterprise_id", "in" : "query", "description" : "企业id", "schema" : { "type" : "string", "example" : "20889490309498" } } ] } }, "/v3/alipay/commerce/ec/enterprise/unsignurl" : { "get" : { "tags" : [ "alipay.commerce.ec.enterprise" ], "summary" : "企业解约", "description" : "企业解约，获取解约链接，点击链接跳转到解约页面，进行解约协议", "operationId" : "alipay.commerce.ec.enterprise.unsign", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcEnterpriseUnsignResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcEnterpriseUnsignErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "enterprise_id", "in" : "query", "description" : "企业id", "schema" : { "type" : "string", "example" : "208893900430" } }, { "name" : "account_id", "in" : "query", "description" : "共同账户id和企业id二选一必填", "schema" : { "type" : "string", "example" : "208849300303" } }, { "name" : "agreement_no", "in" : "query", "description" : "签约协议号，account_id不为空则该字段必填", "schema" : { "type" : "string", "example" : "29300309290200200" } } ] } }, "/v3/alipay/commerce/ec/jointaccountbill/detail/batchquery" : { "get" : { "tags" : [ "alipay.commerce.ec.jointaccountbill.detail" ], "summary" : "企业账单批量分页查询", "description" : "分页查询企业账单", "operationId" : "alipay.commerce.ec.jointaccountbill.detail.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcJointaccountbillDetailBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcJointaccountbillDetailBatchqueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "enterprise_id", "in" : "query", "description" : "企业ID", "schema" : { "type" : "string", "example" : "2088123456789000" } }, { "name" : "biz_scene", "in" : "query", "description" : "业务场景。不传默认为ISV_DEFAULT", "schema" : { "type" : "string", "example" : "ISV_DEFAULT" } }, { "name" : "user_id", "in" : "query", "description" : "员工支付宝UID", "schema" : { "type" : "string", "example" : "2088123456789000" } }, { "name" : "open_id", "in" : "query", "description" : "员工支付宝UID", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } }, { "name" : "employee_id", "in" : "query", "description" : "员工id", "schema" : { "type" : "string", "example" : "2288029541813166" } }, { "name" : "page_num", "in" : "query", "description" : "页码", "schema" : { "type" : "string", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "每页大小", "schema" : { "type" : "string", "example" : "20" } }, { "name" : "start_date", "in" : "query", "description" : "起始日期", "schema" : { "type" : "string", "example" : "yyyy-MM-dd HH:mm:ss" } }, { "name" : "end_date", "in" : "query", "description" : "截止日期", "schema" : { "type" : "string", "example" : "yyyy-MM-dd HH:mm:ss" } } ] } }, "/v3/alipay/commerce/ec/user/enterprise" : { "get" : { "tags" : [ "alipay.commerce.ec.user.enterprise" ], "summary" : "用户企业列表", "description" : "用户所属企业列表", "operationId" : "alipay.commerce.ec.user.enterprise.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEcUserEnterpriseQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEcUserEnterpriseQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "user_id", "in" : "query", "description" : "用户id", "schema" : { "type" : "string", "example" : "20889384849393" } }, { "name" : "open_id", "in" : "query", "description" : "用户open_id", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } } ] } }, "/v3/alipay/commerce/educate/campus/institutions/add" : { "post" : { "tags" : [ "alipay.commerce.educate.campus.institutions" ], "summary" : "入驻学校信息", "description" : "学校信息入驻", "operationId" : "alipay.commerce.educate.campus.institutions.add", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEducateCampusInstitutionsAddResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEducateCampusInstitutionsAddErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEducateCampusInstitutionsAddModel" } } }, "required" : false } } }, "/v3/alipay/commerce/educate/campus/institutions/query" : { "get" : { "tags" : [ "alipay.commerce.educate.campus.institutions" ], "summary" : "查询学校信息", "description" : "可以通过学校库产品查询支付宝系统中是否已存在对应的学校，避免重复入驻，以及通过该接口查询入驻的进度：入驻成功则会返回学校信息，失败则不会返回", "operationId" : "alipay.commerce.educate.campus.institutions.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEducateCampusInstitutionsQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEducateCampusInstitutionsQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "inst_name", "in" : "query", "description" : "学校名称", "schema" : { "type" : "string", "example" : "复旦大学" } }, { "name" : "province_code", "in" : "query", "description" : "省份编码，编码标准为中华人民共和国行政区划代码，参见 2020年12月中华人民共和国县以上行政区划代码。", "schema" : { "type" : "string", "example" : "370000" } }, { "name" : "city_code", "in" : "query", "description" : "城市编码，编码标准为中华人民共和国行政区划代码，参见 2020年12月中华人民共和国县以上行政区划代码。", "schema" : { "type" : "string", "example" : "370900" } }, { "name" : "inst_id", "in" : "query", "description" : "学校内标：支付宝内部学校唯一编号。使用内标查询时，默认使用内标进行精确匹配。", "schema" : { "type" : "string", "example" : "2088000139662311" } }, { "name" : "inst_std_code", "in" : "query", "description" : "学校外标：统一社会信用编码或教育部提供的学校标识码。使用学校外标查询时，默认使用外标进行精确匹配。", "schema" : { "type" : "string", "example" : "202008016104" } }, { "name" : "like_property", "in" : "query", "description" : "是否使用学校名称模糊匹配进行查询，默认精确匹配。\t枚举值如下：\t1：精确匹配；\t0：模糊匹配", "schema" : { "type" : "string", "example" : "1" } } ] } }, "/v3/alipay/commerce/educate/schoolcard/order/sync" : { "post" : { "tags" : [ "alipay.commerce.educate.schoolcard.order" ], "summary" : "校园卡支付订单数据同步", "description" : "校园卡支付订单数据同步", "operationId" : "alipay.commerce.educate.schoolcard.order.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEducateSchoolcardOrderSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceEducateSchoolcardOrderSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceEducateSchoolcardOrderSyncModel" } } }, "required" : false } } }, "/v3/alipay/commerce/iot/device/report/upload" : { "post" : { "tags" : [ "alipay.commerce.iot.device.report" ], "summary" : "设备检测报告上传", "description" : "设备检测报告上传", "operationId" : "alipay.commerce.iot.device.report.upload", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceIotDeviceReportUploadResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceIotDeviceReportUploadErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceIotDeviceReportUploadModel" } } }, "required" : false } } }, "/v3/alipay/commerce/iot/sdarttool/message/query" : { "get" : { "tags" : [ "alipay.commerce.iot.sdarttool.message" ], "summary" : "消息查询", "description" : "isv通过消息id查询消息", "operationId" : "alipay.commerce.iot.sdarttool.message.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceIotSdarttoolMessageQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceIotSdarttoolMessageQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "message_no", "in" : "query", "description" : "消息ID", "schema" : { "type" : "string", "example" : "201911250000021611" } } ] } }, "/v3/alipay/commerce/iot/sdarttool/message/send" : { "post" : { "tags" : [ "alipay.commerce.iot.sdarttool.message" ], "summary" : "IOT消息服务", "description" : "ISV通过此接口向IOT设备推送消息", "operationId" : "alipay.commerce.iot.sdarttool.message.send", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceIotSdarttoolMessageSendResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceIotSdarttoolMessageSendErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceIotSdarttoolMessageSendModel" } } }, "required" : false } } }, "/v3/alipay/commerce/logistics/invoice/istdwaybill/create" : { "post" : { "tags" : [ "alipay.commerce.logistics.invoice.istdwaybill" ], "summary" : "开即时配送订单发票", "description" : "开即时配送订单发票", "operationId" : "alipay.commerce.logistics.invoice.istdwaybill.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceLogisticsInvoiceIstdwaybillCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceLogisticsInvoiceIstdwaybillCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceLogisticsInvoiceIstdwaybillCreateModel" } } }, "required" : false } } }, "/v3/alipay/commerce/logistics/invoice/istdwaybill/query" : { "get" : { "tags" : [ "alipay.commerce.logistics.invoice.istdwaybill" ], "summary" : "查询即时配送订单的开票结果", "description" : "查询即时配送订单的开票结果", "operationId" : "alipay.commerce.logistics.invoice.istdwaybill.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceLogisticsInvoiceIstdwaybillQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceLogisticsInvoiceIstdwaybillQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "logistics_code", "in" : "query", "description" : "即时配送公司编码", "schema" : { "type" : "string", "example" : "FENGNIAO" } }, { "name" : "out_invoice_request_no", "in" : "query", "description" : "开票请求流水号", "schema" : { "type" : "string", "example" : "out_invoice_no_00001" } } ] } }, "/v3/alipay/commerce/logistics/logisticscompany/instantdelivery/query" : { "get" : { "tags" : [ "alipay.commerce.logistics.logisticscompany.instantdelivery" ], "summary" : "查询支付宝支持的即时配送公司", "description" : "查询支付宝支持的即时配送公司", "operationId" : "alipay.commerce.logistics.logisticscompany.instantdelivery.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceLogisticsLogisticscompanyInstantdeliveryQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceLogisticsLogisticscompanyInstantdeliveryQueryErrorResponseModel" } ] } } } } } } }, "/v3/alipay/commerce/logistics/order/instantdelivery/cancel" : { "post" : { "tags" : [ "alipay.commerce.logistics.order.instantdelivery" ], "summary" : "取消即时配送订单", "description" : "取消即时配送订单", "operationId" : "alipay.commerce.logistics.order.instantdelivery.cancel", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceLogisticsOrderInstantdeliveryCancelResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceLogisticsOrderInstantdeliveryCancelErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceLogisticsOrderInstantdeliveryCancelModel" } } }, "required" : false } } }, "/v3/alipay/commerce/logistics/order/instantdelivery/create" : { "post" : { "tags" : [ "alipay.commerce.logistics.order.instantdelivery" ], "summary" : "下即时配送订单", "description" : "下即时配送订单", "operationId" : "alipay.commerce.logistics.order.instantdelivery.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceLogisticsOrderInstantdeliveryCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceLogisticsOrderInstantdeliveryCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceLogisticsOrderInstantdeliveryCreateModel" } } }, "required" : false } } }, "/v3/alipay/commerce/logistics/order/instantdelivery/precreate" : { "post" : { "tags" : [ "alipay.commerce.logistics.order.instantdelivery" ], "summary" : "预下即时配送订单", "description" : "预下即时配送订单", "operationId" : "alipay.commerce.logistics.order.instantdelivery.precreate", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceLogisticsOrderInstantdeliveryPrecreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceLogisticsOrderInstantdeliveryPrecreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceLogisticsOrderInstantdeliveryPrecreateModel" } } }, "required" : false } } }, "/v3/alipay/commerce/logistics/order/istdcancel/preconsult" : { "post" : { "tags" : [ "alipay.commerce.logistics.order.istdcancel" ], "summary" : "预取消即时配送订单", "description" : "预取消即时配送订单", "operationId" : "alipay.commerce.logistics.order.istdcancel.preconsult", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceLogisticsOrderIstdcancelPreconsultResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceLogisticsOrderIstdcancelPreconsultErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceLogisticsOrderIstdcancelPreconsultModel" } } }, "required" : false } } }, "/v3/alipay/commerce/logistics/order/istdretry/create" : { "post" : { "tags" : [ "alipay.commerce.logistics.order.istdretry" ], "summary" : "重下即时配送订单", "description" : "重下即时配送订单", "operationId" : "alipay.commerce.logistics.order.istdretry.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceLogisticsOrderIstdretryCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceLogisticsOrderIstdretryCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceLogisticsOrderIstdretryCreateModel" } } }, "required" : false } } }, "/v3/alipay/commerce/logistics/waybill/istddetail/query" : { "get" : { "tags" : [ "alipay.commerce.logistics.waybill.istddetail" ], "summary" : "查询即时配送运单详情", "description" : "查询即时配送运单详情", "operationId" : "alipay.commerce.logistics.waybill.istddetail.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceLogisticsWaybillIstddetailQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceLogisticsWaybillIstddetailQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "shop_no", "in" : "query", "description" : "商家球房编号", "schema" : { "type" : "string", "example" : "shopno001" } }, { "name" : "out_order_no", "in" : "query", "description" : "商家订单号", "schema" : { "type" : "string", "example" : "2020090411140000000000777000216122" } }, { "name" : "order_no", "in" : "query", "description" : "支付宝订单流水号", "schema" : { "type" : "string", "example" : "2020090411130000000000772400280352" } }, { "name" : "logistics_code", "in" : "query", "description" : "即时配送公司编码", "schema" : { "type" : "string", "example" : "FENGNIAO" } }, { "name" : "waybill_no", "in" : "query", "description" : "即时配送运单编号", "schema" : { "type" : "string", "example" : "waybillno001" } } ] } }, "/v3/alipay/commerce/operation/activity/merchant/modify" : { "post" : { "tags" : [ "alipay.commerce.operation.activity.merchant" ], "summary" : "商户签约信息修改", "description" : "商户签约信息修改", "operationId" : "alipay.commerce.operation.activity.merchant.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceOperationActivityMerchantModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceOperationActivityMerchantModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceOperationActivityMerchantModifyModel" } } }, "required" : false } } }, "/v3/alipay/commerce/operation/activity/merchant/sign" : { "post" : { "tags" : [ "alipay.commerce.operation.activity.merchant" ], "summary" : "商户签约活动", "description" : "商户签约活动", "operationId" : "alipay.commerce.operation.activity.merchant.sign", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceOperationActivityMerchantSignResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceOperationActivityMerchantSignErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceOperationActivityMerchantSignModel" } } }, "required" : false } } }, "/v3/alipay/commerce/operation/activity/merchant/unsign" : { "post" : { "tags" : [ "alipay.commerce.operation.activity.merchant" ], "summary" : "活动商户解约", "description" : "用户银行商户模式商户解约活动使用", "operationId" : "alipay.commerce.operation.activity.merchant.unsign", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceOperationActivityMerchantUnsignResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceOperationActivityMerchantUnsignErrorResponseModel" } ] } } } } } } }, "/v3/alipay/commerce/operation/bank/activity/query" : { "get" : { "tags" : [ "alipay.commerce.operation.bank.activity" ], "summary" : "银行活动信息查询", "description" : "银行活动信息查询", "operationId" : "alipay.commerce.operation.bank.activity.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceOperationBankActivityQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceOperationBankActivityQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "open_id", "in" : "query", "description" : "支付宝openId", "schema" : { "type" : "string", "example" : "021xxxx" } }, { "name" : "user_id", "in" : "query", "description" : "蚂蚁统一会员ID", "schema" : { "type" : "string", "example" : "2088xxxx" } } ] } }, "/v3/alipay/commerce/transport/charger/chargerbindinfo/sync" : { "post" : { "tags" : [ "alipay.commerce.transport.charger.chargerbindinfo" ], "summary" : "充电运营商同步用户绑定充电桩信息接口", "description" : "设备运营商通过该接口同步自己阵地中用户绑定充电桩的信息，包含绑定信息，解绑信息，设备状态等等设备信息", "operationId" : "alipay.commerce.transport.charger.chargerbindinfo.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceTransportChargerChargerbindinfoSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceTransportChargerChargerbindinfoSyncErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/AuthToken" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceTransportChargerChargerbindinfoSyncModel" } } }, "required" : false } } }, "/v3/alipay/commerce/transport/parking/enterinfo/sync" : { "post" : { "tags" : [ "alipay.commerce.transport.parking.enterinfo" ], "summary" : "停车入场模板消息配置", "description" : "车辆驶入停车场时，服务商通过此接口配置消息模板内容告知支付宝发送给用户", "operationId" : "alipay.commerce.transport.parking.enterinfo.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceTransportParkingEnterinfoSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceTransportParkingEnterinfoSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceTransportParkingEnterinfoSyncModel" } } }, "required" : false } } }, "/v3/alipay/commerce/transport/parking/exitinfo/sync" : { "post" : { "tags" : [ "alipay.commerce.transport.parking.exitinfo" ], "summary" : "停车离场消息模板配置", "description" : "用户要驶离停车场时，服务商通过此接口配置消息模板内容告知支付宝发送给用户", "operationId" : "alipay.commerce.transport.parking.exitinfo.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceTransportParkingExitinfoSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceTransportParkingExitinfoSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceTransportParkingExitinfoSyncModel" } } }, "required" : false } } }, "/v3/alipay/commerce/transport/parking/paymentinfo/sync" : { "post" : { "tags" : [ "alipay.commerce.transport.parking.paymentinfo" ], "summary" : "停车支付模板消息配置", "description" : "用户在场内支付时，服务商通过此接口配置消息模板内容告知支付宝发送给用户", "operationId" : "alipay.commerce.transport.parking.paymentinfo.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceTransportParkingPaymentinfoSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayCommerceTransportParkingPaymentinfoSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayCommerceTransportParkingPaymentinfoSyncModel" } } }, "required" : false } } }, "/v3/alipay/data/bill/accountbookereceipt/apply" : { "post" : { "tags" : [ "alipay.data.bill.accountbookereceipt" ], "summary" : "申请子账本电子回单(incubating)", "description" : "申请子账本电子回单（子账本业务定制接口）", "operationId" : "alipay.data.bill.accountbookereceipt.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayDataBillAccountbookereceiptApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayDataBillAccountbookereceiptApplyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayDataBillAccountbookereceiptApplyModel" } } }, "required" : false } } }, "/v3/alipay/data/bill/accountbookereceipt/query" : { "get" : { "tags" : [ "alipay.data.bill.accountbookereceipt" ], "summary" : "查询子账本电子回单状态(incubating)", "description" : "电子签章申请分两个步骤： 1、使用alipay.data.bill.ereceipt.apply创建申请，并获取file_id信息。 2、等待一段时间后，使用file_id查询alipay.data.bill.ereceipt.query申请信息。 单个申请建议每5分钟查询一次状态。汇总回单建议30分钟查询一次", "operationId" : "alipay.data.bill.accountbookereceipt.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayDataBillAccountbookereceiptQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayDataBillAccountbookereceiptQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "file_id", "in" : "query", "description" : "根据申请id查询状态", "schema" : { "type" : "string", "example" : "12345" } }, { "name" : "agreement_no", "in" : "query", "description" : "协议号", "schema" : { "type" : "string", "example" : "20205215001418078112" } } ] } }, "/v3/alipay/data/bill/accountlog/query" : { "get" : { "tags" : [ "alipay.data.bill.accountlog" ], "summary" : "支付宝商家账户账务明细查询", "description" : "为支付宝商家提供支付宝账户的账务流水信息，供对账使用。", "operationId" : "alipay.data.bill.accountlog.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayDataBillAccountlogQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayDataBillAccountlogQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "start_time", "in" : "query", "description" : "账务流水创建时间的起始范围", "schema" : { "type" : "string", "example" : "2019-01-01 00:00:00" } }, { "name" : "end_time", "in" : "query", "description" : "账务流水创建时间的结束范围。与起始时间间隔不超过31天。查询结果为起始时间至结束时间的左闭右开区间", "schema" : { "type" : "string", "example" : "2019-01-02 00:00:00" } }, { "name" : "alipay_order_no", "in" : "query", "description" : "支付宝订单号，通过支付宝订单号精确查询相关的流水明细，商户订单号与支付宝订单号互斥", "schema" : { "type" : "string", "example" : "20190101***" } }, { "name" : "merchant_order_no", "in" : "query", "description" : "商户订单号，通过商户订单号精确查询相关的流水明细，商户订单号与支付宝订单号互斥", "schema" : { "type" : "string", "example" : "TX***" } }, { "name" : "page_no", "in" : "query", "description" : "分页号，从1开始", "schema" : { "type" : "string", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "分页大小1000-2000，默认2000", "schema" : { "type" : "string", "example" : "2000" } }, { "name" : "trans_code", "in" : "query", "description" : "账务的类型代码，特殊场景下使用", "schema" : { "type" : "string", "example" : "101101,301101" } }, { "name" : "agreement_no", "in" : "query", "description" : "协议授权码，特殊场景下使用", "schema" : { "type" : "string", "example" : "20215606000635888888" } }, { "name" : "agreement_product_code", "in" : "query", "description" : "协议产品码。特殊场景下使用", "schema" : { "type" : "string", "example" : "FUND_SIGN_WITHHOLDING" } }, { "name" : "bill_user_id", "in" : "query", "description" : "指定用户做账单查询", "schema" : { "type" : "string", "example" : "2088123456789012" } } ] } }, "/v3/alipay/data/bill/bail/query" : { "get" : { "tags" : [ "alipay.data.bill.bail" ], "summary" : "支付宝商家账户保证金查询", "description" : "为支付宝商家提供支付宝账户保证金信息，供对账使用。", "operationId" : "alipay.data.bill.bail.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayDataBillBailQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayDataBillBailQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "start_time", "in" : "query", "description" : "保证金流水创建时间的起始范围", "schema" : { "type" : "string", "example" : "2019-01-01 00:00:00" } }, { "name" : "end_time", "in" : "query", "description" : "保证金流水创建时间的结束范围。与起始时间间隔不超过31天。查询结果为起始时间至结束时间的左闭右开区间", "schema" : { "type" : "string", "example" : "2019-01-02 00:00:00" } }, { "name" : "bail_type", "in" : "query", "description" : "保证金类型，目前支持TMALL_S_BAIL-天猫保证金，TAOBAO_BAIL-淘宝保证金", "schema" : { "type" : "string", "example" : "TMALL_S_BAIL" } }, { "name" : "trans_log_id", "in" : "query", "description" : "保证金流水号。如果查询参数中指定流水号，则只查询流水号相关的记录", "schema" : { "type" : "string", "example" : "20190101***" } }, { "name" : "biz_orig_no", "in" : "query", "description" : "业务基础订单号。如果查询参数中指定订单号，则只查询相关的记录", "schema" : { "type" : "string", "example" : "1***" } } ] } }, "/v3/alipay/data/bill/balance/query" : { "get" : { "tags" : [ "alipay.data.bill.balance" ], "summary" : "支付宝商家账户当前余额查询", "description" : "为支付宝商家提供支付宝账户当前余额信息，包括冻结金额，可用余额和总额，供对账使用。", "operationId" : "alipay.data.bill.balance.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayDataBillBalanceQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayDataBillBalanceQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "bill_user_id", "in" : "query", "description" : "目标查询账户（仅支持部分场景，查询自身时候不需要传递当前字段）。", "schema" : { "type" : "string", "example" : "2088123456789012" } } ] } }, "/v3/alipay/data/bill/balancehis/query" : { "get" : { "tags" : [ "alipay.data.bill.balancehis" ], "summary" : "支付宝商家账户历史余额查询", "description" : "为支付宝商家提供支付宝账户历史余额信息，供对账使用。", "operationId" : "alipay.data.bill.balancehis.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayDataBillBalancehisQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayDataBillBalancehisQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "biz_date", "in" : "query", "description" : "查询指定自然日的起初余额和期末余额，biz_date与biz_month传入参数互斥", "schema" : { "type" : "string", "example" : "2019-08-01" } }, { "name" : "biz_month", "in" : "query", "description" : "查询指定自然月的起初余额和期末余额，biz_date与biz_month传入参数互斥", "schema" : { "type" : "string", "example" : "2019-08" } } ] } }, "/v3/alipay/data/bill/bizfundagent/query" : { "get" : { "tags" : [ "alipay.data.bill.bizfundagent" ], "summary" : "ISV代理商户资金业务账单查询", "description" : "用于ISV代理商户查询商户的资金业务账单", "operationId" : "alipay.data.bill.bizfundagent.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayDataBillBizfundagentQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayDataBillBizfundagentQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "start_time", "in" : "query", "description" : "账单查询时间范围 -- 起始时间", "schema" : { "type" : "string", "example" : "2021-01-01 00:00:00" } }, { "name" : "end_time", "in" : "query", "description" : "账单查询时间范围 -- 结束范围。时间范围最大不超过31天。", "schema" : { "type" : "string", "example" : "2021-02-01 00:00:00" } }, { "name" : "page_no", "in" : "query", "description" : "页码，从1开始", "schema" : { "type" : "string", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "分页大小1000-2000，默认2000", "schema" : { "type" : "string", "example" : "2000" } }, { "name" : "agreement_no", "in" : "query", "description" : "ISV与商户授权协议号", "schema" : { "type" : "string", "example" : "20205215001418078112" } } ] } }, "/v3/alipay/data/bill/buy/query" : { "get" : { "tags" : [ "alipay.data.bill.buy" ], "summary" : "支付宝商家账户买入交易查询", "description" : "为支付宝商家提供支付宝账户买入交易信息，供对账使用。", "operationId" : "alipay.data.bill.buy.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayDataBillBuyQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayDataBillBuyQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "start_time", "in" : "query", "description" : "交易流水创建时间的起始范围", "schema" : { "type" : "string", "example" : "2019-01-01 00:00:00" } }, { "name" : "end_time", "in" : "query", "description" : "交易流水创建时间的结束范围。与起始时间间隔不超过31天。查询结果为起始时间至结束时间的左闭右开区间", "schema" : { "type" : "string", "example" : "2019-01-02 00:00:00" } }, { "name" : "alipay_order_no", "in" : "query", "description" : "支付宝交易流水号。如果查询参数中指定流水号，则只查询流水号相关的记录", "schema" : { "type" : "string", "example" : "20190101***" } }, { "name" : "merchant_order_no", "in" : "query", "description" : "商户交易号。如果查询参数中指定交易号，则只查询相关的记录", "schema" : { "type" : "string", "example" : "TX***" } }, { "name" : "store_no", "in" : "query", "description" : "球房编号，模糊搜索", "schema" : { "type" : "string", "example" : "球房1" } }, { "name" : "page_no", "in" : "query", "description" : "分页号，从1开始", "schema" : { "type" : "string", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "分页大小1000-2000，默认2000", "schema" : { "type" : "string", "example" : "2000" } } ] } }, "/v3/alipay/data/bill/ereceipt/apply" : { "post" : { "tags" : [ "alipay.data.bill.ereceipt" ], "summary" : "申请电子回单(incubating)", "description" : "支持商家下载多种类型支付宝资金凭证。包括：余额收支证明、余额收支流水证明、转入转出收支证明、收支汇总证明（日汇总）以及收支汇总证明（月汇总）。\n 账单凭证申请分两个步骤： \n1、使用alipay.data.bill.ereceipt.apply创建申请，并获取file_id信息。 \n2、使用file_id查询alipay.data.bill.ereceipt.query获取回单信息，回单生成完毕将会返回对应的下载链接，下载链接时效为30秒，过期将无法下载，需重新调用alipay.data.bill.ereceipt.query获取新的下载链接。", "operationId" : "alipay.data.bill.ereceipt.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayDataBillEreceiptApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayDataBillEreceiptApplyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayDataBillEreceiptApplyModel" } } }, "required" : false } } }, "/v3/alipay/data/bill/ereceipt/query" : { "get" : { "tags" : [ "alipay.data.bill.ereceipt" ], "summary" : "查询电子回单状态(incubating)", "description" : "电子签章申请分两个步骤：\n\n1、使用alipay.data.bill.ereceipt.apply创建申请，并获取file_id信息。\n2、等待一段时间后，使用file_id查询alipay.data.bill.ereceipt.query申请信息。\n\n单个申请建议每5分钟查询一次状态。批量回单建议20分钟查询一次。汇总回单建议30分钟查询一次", "operationId" : "alipay.data.bill.ereceipt.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayDataBillEreceiptQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayDataBillEreceiptQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "file_id", "in" : "query", "description" : "根据申请id查询状态。通过 alipay.data.bill.ereceipt.apply(申请电子回单(incubating)) 接口同步响应获取。", "schema" : { "type" : "string", "example" : "12345" } } ] } }, "/v3/alipay/data/bill/ereceiptagent/apply" : { "post" : { "tags" : [ "alipay.data.bill.ereceiptagent" ], "summary" : "ISV代理商户申请电子回单", "description" : "ISV代理商户，申请商户的资金业务回单。 \n电子签章申请分两个步骤： 1、使用alipay.data.bill.ereceiptagent.apply创建申请，并获取file_id信息。 2、等待一段时间后，使用file_id查询alipay.data.bill.ereceipt.query申请信息。单个申请建议每5分钟查询一次状态，汇总（日/月）回单建议20分钟查询一次。月初回单生成较慢，请耐心等待（汇总回单在月初申请需要等待几个小时） 注：申请成功，并不代表明细查询的流水一定存在。如果流水不存在，在查询时将会提示。\n", "operationId" : "alipay.data.bill.ereceiptagent.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayDataBillEreceiptagentApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayDataBillEreceiptagentApplyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayDataBillEreceiptagentApplyModel" } } }, "required" : false } } }, "/v3/alipay/data/bill/sell/query" : { "get" : { "tags" : [ "alipay.data.bill.sell" ], "summary" : "支付宝商家账户卖出交易查询", "description" : "为支付宝商家提供支付宝账户卖出交易信息，供对账使用。", "operationId" : "alipay.data.bill.sell.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayDataBillSellQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayDataBillSellQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "start_time", "in" : "query", "description" : "卖出交易流水创建时间的起始范围", "schema" : { "type" : "string", "example" : "2019-01-01 00:00:00" } }, { "name" : "end_time", "in" : "query", "description" : "卖出交易流水创建时间的结束范围。与起始时间间隔不超过31天。查询结果为起始时间至结束时间的左闭右开区间", "schema" : { "type" : "string", "example" : "2019-01-02 00:00:00" } }, { "name" : "alipay_order_no", "in" : "query", "description" : "支付宝交易流水号。如果查询参数中指定流水号，则只查询流水号相关的记录", "schema" : { "type" : "string", "example" : "20190101***" } }, { "name" : "merchant_order_no", "in" : "query", "description" : "商户交易号。如果查询参数中指定交易号，则只查询相关的记录", "schema" : { "type" : "string", "example" : "TX***" } }, { "name" : "store_no", "in" : "query", "description" : "球房编号，模糊搜索", "schema" : { "type" : "string", "example" : "球房1" } }, { "name" : "page_no", "in" : "query", "description" : "分页号，从1开始", "schema" : { "type" : "string", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "分页大小1000-2000，默认2000", "schema" : { "type" : "string", "example" : "2000" } } ] } }, "/v3/alipay/data/bill/transfer/query" : { "get" : { "tags" : [ "alipay.data.bill.transfer" ], "summary" : "支付宝商家账户充值，转账，提现查询", "description" : "为支付宝商家提供支付宝账户充值，转账，提现信息，供对账使用。", "operationId" : "alipay.data.bill.transfer.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayDataBillTransferQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayDataBillTransferQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "start_time", "in" : "query", "description" : "充值、转账、提现流水业务时间的起始范围", "schema" : { "type" : "string", "example" : "2019-01-01 00:00:00" } }, { "name" : "end_time", "in" : "query", "description" : "充值、转账、提现流水业务时间的结束范围。与起始时间间隔不超过31天。查询结果为起始时间至结束时间的左闭右开区间", "schema" : { "type" : "string", "example" : "2019-01-02 00:00:00" } }, { "name" : "type", "in" : "query", "description" : "转账类型：充值-DEPOSIT，提现-WITHDRAW，转账-TRANSFER。", "schema" : { "type" : "string", "example" : "DEPOSIT" } }, { "name" : "page_no", "in" : "query", "description" : "分页号，从1开始", "schema" : { "type" : "string", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "分页大小1000-2000，默认2000", "schema" : { "type" : "string", "example" : "2000" } } ] } }, "/v3/alipay/data/bill/transferaccountbook/query" : { "get" : { "tags" : [ "alipay.data.bill.transferaccountbook" ], "summary" : "子账本充提转账单查询(incubating)", "description" : "子账本充提转账单查询（子账本业务定制接口）", "operationId" : "alipay.data.bill.transferaccountbook.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayDataBillTransferaccountbookQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayDataBillTransferaccountbookQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "start_time", "in" : "query", "description" : "充值、转账、提现流水业务时间的起始范围", "schema" : { "type" : "string", "example" : "2019-01-01 00:00:00" } }, { "name" : "end_time", "in" : "query", "description" : "充值、转账、提现流水业务时间的结束范围。与起始时间间隔不超过31天。查询结果为起始时间至结束时间的左闭右开区间", "schema" : { "type" : "string", "example" : "2019-01-02 00:00:00" } }, { "name" : "type", "in" : "query", "description" : "转账类型：充值-DEPOSIT，提现-WITHDRAW，转账-TRANSFER。", "schema" : { "type" : "string", "example" : "TRANSFER" } }, { "name" : "agreement_no", "in" : "query", "description" : "协议号", "schema" : { "type" : "string", "example" : "20205215001418078112" } }, { "name" : "store_no", "in" : "query", "description" : "子账本号，或者子账本名称。模糊查询", "schema" : { "type" : "string", "example" : "2088000117463004" } }, { "name" : "page_no", "in" : "query", "description" : "分页号，从1开始", "schema" : { "type" : "string", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "分页大小1000-2000，默认2000", "schema" : { "type" : "string", "example" : "2000" } } ] } }, "/v3/alipay/data/dataservice/ad/conversion/upload" : { "post" : { "tags" : [ "alipay.data.dataservice.ad.conversion" ], "summary" : "转化数据回传", "description" : "用于回传转化数据", "operationId" : "alipay.data.dataservice.ad.conversion.upload", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayDataDataserviceAdConversionUploadResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayDataDataserviceAdConversionUploadErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayDataDataserviceAdConversionUploadModel" } } }, "required" : false } } }, "/v3/alipay/data/dataservice/ad/promotepage/batchquery" : { "get" : { "tags" : [ "alipay.data.dataservice.ad.promotepage" ], "summary" : "自建推广页列表批量查询", "description" : "用于获取指定商家的自建推广页列表", "operationId" : "alipay.data.dataservice.ad.promotepage.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayDataDataserviceAdPromotepageBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayDataDataserviceAdPromotepageBatchqueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "biz_token", "in" : "query", "description" : "代理商访问灯火平台的token", "schema" : { "type" : "string", "example" : "HYjofejnnlp89730202bcklHH" } }, { "name" : "principal_tag", "in" : "query", "description" : "商家标志", "schema" : { "type" : "string", "example" : "yfvbv133498" } }, { "name" : "type", "in" : "query", "description" : "推广页类型：COLLECT_INFO - 免费留资；TRADE - 付费留资； OPERATION_PAID - 运营商付费留资；待扩展", "schema" : { "type" : "string", "example" : "COLLECT_INFO" } }, { "name" : "page_no", "in" : "query", "description" : "分页参数之页数，从1开始", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "分页参数之每页大小，最大1000", "schema" : { "type" : "integer", "example" : "100" } } ] } }, "/v3/alipay/data/dataservice/ad/promotepage/download" : { "get" : { "tags" : [ "alipay.data.dataservice.ad.promotepage" ], "summary" : "自建推广页留资数据查询", "description" : "用于获取指定商家指定推广页的留资数据", "operationId" : "alipay.data.dataservice.ad.promotepage.download", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayDataDataserviceAdPromotepageDownloadResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayDataDataserviceAdPromotepageDownloadErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "biz_token", "in" : "query", "description" : "代理商访问灯火平台的token", "schema" : { "type" : "string", "example" : "HYjofejnnlp89730202bcklHH" } }, { "name" : "principal_tag", "in" : "query", "description" : "商家标志", "schema" : { "type" : "string", "example" : "yfvbv133498" } }, { "name" : "promote_page_id", "in" : "query", "description" : "推广页id", "schema" : { "type" : "integer", "example" : "2018374" } }, { "name" : "start_date", "in" : "query", "description" : "留资开始日期，格式：yyyy-mm-dd，不能早于30天前", "schema" : { "type" : "string", "example" : "\"2020-12-12\"" } }, { "name" : "end_date", "in" : "query", "description" : "留资结束日期，格式：yyyy-mm-dd；不能晚于当天", "schema" : { "type" : "string", "example" : "“2020-12-13”" } }, { "name" : "page_no", "in" : "query", "description" : "分页参数之页数，从1开始", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "分页参数之每页大小，最大1000", "schema" : { "type" : "integer", "example" : "100" } } ] } }, "/v3/alipay/data/dataservice/bill/downloadurl/query" : { "get" : { "tags" : [ "alipay.data.dataservice.bill.downloadurl" ], "summary" : "查询对账单下载地址", "description" : "为方便商户快速查账，支持商户通过本接口获取商户离线账单下载地址", "operationId" : "alipay.data.dataservice.bill.downloadurl.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayDataDataserviceBillDownloadurlQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayDataDataserviceBillDownloadurlQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "bill_type", "in" : "query", "description" : "账单类型，商户通过接口或商户经开放平台授权后其所属服务商通过接口可以获取以下账单类型，支持：\ttrade：商户基于支付宝交易收单的业务账单；\tsigncustomer：基于商户支付宝余额收入及支出等资金变动的账务账单；\tmerchant_act：营销活动账单，包含营销活动的发放，核销记录\ttrade_zft_merchant：直付通二级商户查询交易的业务账单；\tzft_acc：直付通平台商查询二级商户流水使用，返回所有二级商户流水。", "schema" : { "type" : "string", "example" : "trade" } }, { "name" : "bill_date", "in" : "query", "description" : "账单时间： \t* 日账单格式为yyyy-MM-dd，最早可下载2016年1月1日开始的日账单。不支持下载当日账单，只能下载前一日24点前的账单数据（T+1），当日数据一般于次日 9 点前生成，特殊情况可能延迟。 \t* 月账单格式为yyyy-MM，最早可下载2016年1月开始的月账单。不支持下载当月账单，只能下载上一月账单数据，当月账单一般在次月 3 日生成，特殊情况可能延迟。", "schema" : { "type" : "string", "example" : "2016-04-05" } }, { "name" : "smid", "in" : "query", "description" : "二级商户smid，这个参数只在bill_type是trade_zft_merchant时才能使用", "schema" : { "type" : "string", "example" : "2088123412341234" } } ] } }, "/v3/alipay/ebpp/bill/add" : { "post" : { "tags" : [ "alipay.ebpp.bill" ], "summary" : "创建账单", "description" : "创建账单", "operationId" : "alipay.ebpp.bill.add", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppBillAddResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppBillAddErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/AuthToken" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppBillAddModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/bill/get" : { "get" : { "tags" : [ "alipay.ebpp.bill" ], "summary" : "查询账单", "description" : "查询账单", "operationId" : "alipay.ebpp.bill.get", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppBillGetResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppBillGetErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/AuthToken" }, { "name" : "order_type", "in" : "query", "description" : "支付宝订单类型。公共事业缴纳JF,信用卡还款HK", "schema" : { "type" : "string", "example" : "JF" } }, { "name" : "merchant_order_no", "in" : "query", "description" : "输出机构的业务流水号，需要保证唯一性。", "schema" : { "type" : "string", "example" : "201203031234567" } } ] } }, "/v3/alipay/ebpp/invoice/apply/inv/upload" : { "put" : { "tags" : [ "alipay.ebpp.invoice.apply.inv" ], "summary" : "发票回传", "description" : "发票回传接口适用于以下场景：\n1、间联开票模式：阿里发票平台向ISV提交了原始发票申请，商户在ISV后台开具发票成功后，基于申请ID(apply_id)回传发票至阿里发票平台归集与交付。\n2、直连开票模式：阿里发票平台请求ISV开票，ISV系统异步执行开票事务后，基于开票流水号(serial_no)回传开票结果至阿里发票平台归集与交付。\n3、ISV直接回传发票给阿里发票平台，进行归集，并交付给业务前台和用户。", "operationId" : "alipay.ebpp.invoice.apply.inv.upload", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceApplyInvUploadResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceApplyInvUploadErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceApplyInvUploadModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/apply/result/sync" : { "post" : { "tags" : [ "alipay.ebpp.invoice.apply.result" ], "summary" : "ISV向支付宝同步发票申请结果", "description" : "ISV向支付宝同步发票申请结果", "operationId" : "alipay.ebpp.invoice.apply.result.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceApplyResultSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceApplyResultSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceApplyResultSyncModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/apply/status/notify" : { "put" : { "tags" : [ "alipay.ebpp.invoice.apply.status" ], "summary" : "发票申请状态变更", "description" : "发票申请状态变更通知", "operationId" : "alipay.ebpp.invoice.apply.status.notify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceApplyStatusNotifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceApplyStatusNotifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceApplyStatusNotifyModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/applystatus/query" : { "post" : { "tags" : [ "alipay.ebpp.invoice.applystatus" ], "summary" : "根据外部订单号查询开票状态", "description" : "根据外部订单号查询开票状态，仅有申请状态无完整票据信息", "operationId" : "alipay.ebpp.invoice.applystatus.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceApplystatusQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceApplystatusQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceApplystatusQueryModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/auth/sign" : { "post" : { "tags" : [ "alipay.ebpp.invoice.auth" ], "summary" : "发票授权关系签约", "description" : "用户在ISV端签约了发票相关的授权关系之后，ISV使用该接口将授权关系同步到发票管家。", "operationId" : "alipay.ebpp.invoice.auth.sign", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceAuthSignResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceAuthSignErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceAuthSignModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/auth/unsign" : { "post" : { "tags" : [ "alipay.ebpp.invoice.auth" ], "summary" : "发票授权关系解约", "description" : "用户在ISV端解约了发票相关的授权关系之后，ISV使用该接口将授权关系在发票管家端解约。", "operationId" : "alipay.ebpp.invoice.auth.unsign", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceAuthUnsignResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceAuthUnsignErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceAuthUnsignModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/detail/output/query" : { "post" : { "tags" : [ "alipay.ebpp.invoice.detail.output" ], "summary" : "获取发票详细信息", "description" : "根据发票代码，发票号码获取发票详细信息\r\n查询权限要求：\r\n发票属于当前isv报销单据进行状态（支持的状态有\r\nEXPENSE_APPLY－用户已提交申请\r\nEXPENSE_APPROVAL_PASS －报销审核通过\r\nEXPENSE_FINISHED－报销完结）", "operationId" : "alipay.ebpp.invoice.detail.output.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceDetailOutputQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceDetailOutputQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceDetailOutputQueryModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/ecorder/order/query" : { "get" : { "tags" : [ "alipay.ebpp.invoice.ecorder.order" ], "summary" : "企业码订单查询", "description" : "企业码订单查询", "operationId" : "alipay.ebpp.invoice.ecorder.order.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceEcorderOrderQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceEcorderOrderQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "enterprise_id", "in" : "query", "description" : "企业ID", "schema" : { "type" : "string", "example" : "2088501296144291" } }, { "name" : "account_id", "in" : "query", "description" : "共同账户ID", "schema" : { "type" : "string", "example" : "2088000000000000" } }, { "name" : "agreement_no", "in" : "query", "description" : "授权签约协议号", "schema" : { "type" : "string", "example" : "20200000000000000000" } }, { "name" : "order_id", "in" : "query", "description" : "订单ID", "schema" : { "type" : "string", "example" : "2020103022000000000000000000" } }, { "name" : "order_type", "in" : "query", "description" : "订单类型", "schema" : { "type" : "string", "example" : "METRO" } } ] } }, "/v3/alipay/ebpp/invoice/einvpackage/query" : { "get" : { "tags" : [ "alipay.ebpp.invoice.einvpackage" ], "summary" : "查询用户发票包的明细信息", "description" : "第三方报销软件根据支付宝提供的用户的发票包id，查询对应的发票包的电子发票，ocr纸票和消费记录明细信息", "operationId" : "alipay.ebpp.invoice.einvpackage.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceEinvpackageQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceEinvpackageQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "encrypted_uid", "in" : "query", "description" : "加密过的uid。获取详情参见 \"推\"模式发票报销。", "schema" : { "type" : "string", "example" : "Zhm4AKUE8ShJK6FYfKmk" } }, { "name" : "package_id", "in" : "query", "description" : "发票包id。获取详情参见 \"推\"模式发票报销。", "schema" : { "type" : "string", "example" : "202004150000000000000000000" } } ] } }, "/v3/alipay/ebpp/invoice/enterprise/merchantrelation/create" : { "post" : { "tags" : [ "alipay.ebpp.invoice.enterprise.merchantrelation" ], "summary" : "创建企业商户关系", "description" : "根据交易流水号创建企业商户绑定关系", "operationId" : "alipay.ebpp.invoice.enterprise.merchantrelation.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseMerchantrelationCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseMerchantrelationCreateErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "enterprise_id", "in" : "query", "description" : "企业ID", "schema" : { "type" : "string", "example" : "2088xxx" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseMerchantrelationCreateModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/enterpriseconsume/consume/batchquery" : { "post" : { "tags" : [ "alipay.ebpp.invoice.enterpriseconsume.consume" ], "summary" : "企业因公账单查询", "description" : "基于企业ID和员工UID，在指定时间段（时间间隔不超过24小时）内获取因公账单数据", "operationId" : "alipay.ebpp.invoice.enterpriseconsume.consume.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeConsumeBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeConsumeBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeConsumeBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/enterpriseconsume/detail/query" : { "get" : { "tags" : [ "alipay.ebpp.invoice.enterpriseconsume.detail" ], "summary" : "凭证详情查询接口", "description" : "获取凭证基础信息结构化数据", "operationId" : "alipay.ebpp.invoice.enterpriseconsume.detail.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeDetailQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeDetailQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "account_id", "in" : "query", "description" : "企业ID", "schema" : { "type" : "string", "example" : "2088123456789000" } }, { "name" : "agreement_no", "in" : "query", "description" : "授权签约协议号", "schema" : { "type" : "string", "example" : "20205820659822371223" } }, { "name" : "voucher_id", "in" : "query", "description" : "账单凭证ID", "schema" : { "type" : "string", "example" : "2020123100152601930000003650" } } ] } }, "/v3/alipay/ebpp/invoice/enterpriseconsume/enterpriseopenrule/create" : { "post" : { "tags" : [ "alipay.ebpp.invoice.enterpriseconsume.enterpriseopenrule" ], "summary" : "新增开票规则", "description" : "新增一条开票规则配置", "operationId" : "alipay.ebpp.invoice.enterpriseconsume.enterpriseopenrule.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleCreateModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/enterpriseconsume/enterpriseopenrule/modify" : { "post" : { "tags" : [ "alipay.ebpp.invoice.enterpriseconsume.enterpriseopenrule" ], "summary" : "修改开票规则", "description" : "修改开票规则", "operationId" : "alipay.ebpp.invoice.enterpriseconsume.enterpriseopenrule.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleModifyModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/enterpriseconsume/enterpriseopenrule/query" : { "get" : { "tags" : [ "alipay.ebpp.invoice.enterpriseconsume.enterpriseopenrule" ], "summary" : "查询开票规则", "description" : "根据开票规则ID查询开票规则详情", "operationId" : "alipay.ebpp.invoice.enterpriseconsume.enterpriseopenrule.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "enterprise_id", "in" : "query", "description" : "企业ID", "schema" : { "type" : "string", "example" : "2088000194958955" } }, { "name" : "invoice_rule_id", "in" : "query", "description" : "开票规则ID", "schema" : { "type" : "string", "example" : "2021032900152710950000000001" } }, { "name" : "account_id", "in" : "query", "description" : "共同账户ID", "schema" : { "type" : "string", "example" : "2088000194958956" } }, { "name" : "agreement_no", "in" : "query", "description" : "授权签约协议号", "schema" : { "type" : "string", "example" : "20215425001112341234" } } ] } }, "/v3/alipay/ebpp/invoice/enterpriseconsume/openrulerelation/create" : { "post" : { "tags" : [ "alipay.ebpp.invoice.enterpriseconsume.openrulerelation" ], "summary" : "新增开票规则并绑定费控规则", "description" : "新增开票规则并自动绑定到费控规则", "operationId" : "alipay.ebpp.invoice.enterpriseconsume.openrulerelation.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeOpenrulerelationCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeOpenrulerelationCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeOpenrulerelationCreateModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/enterpriseconsume/relatedetail/query" : { "get" : { "tags" : [ "alipay.ebpp.invoice.enterpriseconsume.relatedetail" ], "summary" : "合花账单关联详情查询", "description" : "合花账单关联详情查询，通过凭证ID获取这个账单详细信息和关联的凭证详细信息", "operationId" : "alipay.ebpp.invoice.enterpriseconsume.relatedetail.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeRelatedetailQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeRelatedetailQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "account_id", "in" : "query", "description" : "企业ID", "schema" : { "type" : "string", "example" : "2088123456789000" } }, { "name" : "agreement_no", "in" : "query", "description" : "授权签约协议号", "schema" : { "type" : "string", "example" : "20205820659822371223" } }, { "name" : "voucher_id", "in" : "query", "description" : "账单凭证ID", "schema" : { "type" : "string", "example" : "2020123100152601930000003650" } } ] } }, "/v3/alipay/ebpp/invoice/enterpriseconsume/summaryinvoicedetail/query" : { "get" : { "tags" : [ "alipay.ebpp.invoice.enterpriseconsume.summaryinvoicedetail" ], "summary" : "查询汇总发票详情", "description" : "根据汇总开票通知拿到的开票批次ID查询汇总发票详情", "operationId" : "alipay.ebpp.invoice.enterpriseconsume.summaryinvoicedetail.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeSummaryinvoicedetailQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeSummaryinvoicedetailQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "account_id", "in" : "query", "description" : "企业 ID", "schema" : { "type" : "string", "example" : "2088000237836238" } }, { "name" : "agreement_no", "in" : "query", "description" : "授权签约协议号", "schema" : { "type" : "string", "example" : "20205820659822371223" } }, { "name" : "summary_id", "in" : "query", "description" : "开票批次 ID", "schema" : { "type" : "string", "example" : "2021080400152500230000000881" } } ] } }, "/v3/alipay/ebpp/invoice/enterpriseexctrl/employertitle" : { "put" : { "tags" : [ "alipay.ebpp.invoice.enterpriseexctrl.employertitle" ], "summary" : "修改企业抬头", "description" : "修改企业开票抬头", "operationId" : "alipay.ebpp.invoice.enterpriseexctrl.employertitle.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseexctrlEmployertitleModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseexctrlEmployertitleModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseexctrlEmployertitleModifyModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/enterpriseexctrl/employertitle/batchquery" : { "post" : { "tags" : [ "alipay.ebpp.invoice.enterpriseexctrl.employertitle" ], "summary" : "批量查询企业抬头", "description" : "分页查询企业抬头列表", "operationId" : "alipay.ebpp.invoice.enterpriseexctrl.employertitle.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseexctrlEmployertitleBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseexctrlEmployertitleBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseexctrlEmployertitleBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/enterpriseexctrl/employertitle/create" : { "post" : { "tags" : [ "alipay.ebpp.invoice.enterpriseexctrl.employertitle" ], "summary" : "新增企业抬头", "description" : "新增一条企业开票抬头", "operationId" : "alipay.ebpp.invoice.enterpriseexctrl.employertitle.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseexctrlEmployertitleCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseexctrlEmployertitleCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseexctrlEmployertitleCreateModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/enterpriseexctrl/employertitle/query" : { "get" : { "tags" : [ "alipay.ebpp.invoice.enterpriseexctrl.employertitle" ], "summary" : "查询企业抬头", "description" : "根据抬头ID查询企业抬头详情", "operationId" : "alipay.ebpp.invoice.enterpriseexctrl.employertitle.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseexctrlEmployertitleQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceEnterpriseexctrlEmployertitleQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "account_id", "in" : "query", "description" : "共同账户id，与enterprise_id两者必填其一", "schema" : { "type" : "string", "example" : "2088xxxxxx" } }, { "name" : "enterprise_id", "in" : "query", "description" : "企业id，与account_id两者必填其一", "schema" : { "type" : "string", "example" : "2088xxxxxx" } }, { "name" : "agreement_no", "in" : "query", "description" : "授权签约协议号", "schema" : { "type" : "string", "example" : "9900000000000" } }, { "name" : "title_id", "in" : "query", "description" : "抬头ID", "schema" : { "type" : "string", "example" : "****" } } ] } }, "/v3/alipay/ebpp/invoice/expense/progress/sync" : { "post" : { "tags" : [ "alipay.ebpp.invoice.expense.progress" ], "summary" : "发票报销处理进度同步", "description" : "用户提交发票管家发票到isv申请报销后，isv对报销处理进度推进", "operationId" : "alipay.ebpp.invoice.expense.progress.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenseProgressSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenseProgressSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenseProgressSyncModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/expensecomsue/outsource/notify" : { "post" : { "tags" : [ "alipay.ebpp.invoice.expensecomsue.outsource" ], "summary" : "同步外部额度变更（交易形式）", "description" : "外部和企业码进行额度共管的时候，外部以交易的形式（支付、退款）将外部发生的额度变更同步给企业码", "operationId" : "alipay.ebpp.invoice.expensecomsue.outsource.notify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensecomsueOutsourceNotifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensecomsueOutsourceNotifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensecomsueOutsourceNotifyModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/expensecontrol/aggregation/create" : { "post" : { "tags" : [ "alipay.ebpp.invoice.expensecontrol.aggregation" ], "summary" : "创建费控规则聚合关系", "description" : "创建费控规则聚合关系", "operationId" : "alipay.ebpp.invoice.expensecontrol.aggregation.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensecontrolAggregationCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensecontrolAggregationCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensecontrolAggregationCreateModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/expensecontrol/employeequota/create" : { "post" : { "tags" : [ "alipay.ebpp.invoice.expensecontrol.employeequota" ], "summary" : "创建余额（特定场景）", "description" : "创建余额，该接口开放给特定场景。如果需要使用，请联系技术支持。", "operationId" : "alipay.ebpp.invoice.expensecontrol.employeequota.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensecontrolEmployeequotaCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensecontrolEmployeequotaCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensecontrolEmployeequotaCreateModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/expensecontrol/issuebatch/cancel" : { "post" : { "tags" : [ "alipay.ebpp.invoice.expensecontrol.issuebatch" ], "summary" : "作废额度发放", "description" : "通过发放批次id，作废当前批次下发放的额度", "operationId" : "alipay.ebpp.invoice.expensecontrol.issuebatch.cancel", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensecontrolIssuebatchCancelResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensecontrolIssuebatchCancelErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensecontrolIssuebatchCancelModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/expensecontrol/issuebatch/create" : { "post" : { "tags" : [ "alipay.ebpp.invoice.expensecontrol.issuebatch" ], "summary" : "手动发放额度接口", "description" : "通过该接口对企业下的员工进行批量的额度发放。", "operationId" : "alipay.ebpp.invoice.expensecontrol.issuebatch.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensecontrolIssuebatchCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensecontrolIssuebatchCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensecontrolIssuebatchCreateModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/expensecontrol/quota/create" : { "post" : { "tags" : [ "alipay.ebpp.invoice.expensecontrol.quota" ], "summary" : "创建余额/点券", "description" : "创建余额或者点券", "operationId" : "alipay.ebpp.invoice.expensecontrol.quota.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensecontrolQuotaCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensecontrolQuotaCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensecontrolQuotaCreateModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/expensecontrol/quota/modify" : { "post" : { "tags" : [ "alipay.ebpp.invoice.expensecontrol.quota" ], "summary" : "修改余额/点券", "description" : "修改余额或点券", "operationId" : "alipay.ebpp.invoice.expensecontrol.quota.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensecontrolQuotaModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensecontrolQuotaModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensecontrolQuotaModifyModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/expensecontrol/quota/query" : { "post" : { "tags" : [ "alipay.ebpp.invoice.expensecontrol.quota" ], "summary" : "查询余额/点券", "description" : "查询余额或者点券", "operationId" : "alipay.ebpp.invoice.expensecontrol.quota.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensecontrolQuotaQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensecontrolQuotaQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensecontrolQuotaQueryModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/expenserules/employee/query" : { "get" : { "tags" : [ "alipay.ebpp.invoice.expenserules.employee" ], "summary" : "查询费控规则员工", "description" : "查询费控规则员工", "operationId" : "alipay.ebpp.invoice.expenserules.employee.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesEmployeeQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesEmployeeQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "account_id", "in" : "query", "description" : "共同账号ID", "schema" : { "type" : "string", "example" : "2088123456789000" } }, { "name" : "agreement_no", "in" : "query", "description" : "授权签约协议号", "schema" : { "type" : "string", "example" : "20205820659822371223" } }, { "name" : "enterprise_id", "in" : "query", "description" : "企业码企业id", "schema" : { "type" : "string", "example" : "2088000194958956" } }, { "name" : "standard_id", "in" : "query", "description" : "费控规则ID", "schema" : { "type" : "string", "example" : "2021081900152601000000000101" } }, { "name" : "page_num", "in" : "query", "description" : "页数", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "页大小", "schema" : { "type" : "integer", "example" : "20" } } ] } }, "/v3/alipay/ebpp/invoice/expenserules/employeerules/query" : { "get" : { "tags" : [ "alipay.ebpp.invoice.expenserules.employeerules" ], "summary" : "查询员工绑定的所有费控规则", "description" : "分页查询指定员工绑定的所有费控规则，默认返回所有有效和无效规则，查询结果按费控规则的创建时间倒序", "operationId" : "alipay.ebpp.invoice.expenserules.employeerules.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesEmployeerulesQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesEmployeerulesQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "account_id", "in" : "query", "description" : "企业ID", "schema" : { "type" : "string", "example" : "208800019495xxxx" } }, { "name" : "agreement_no", "in" : "query", "description" : "授权签约协议号", "schema" : { "type" : "string", "example" : "2021542500111234xxxx" } }, { "name" : "employee_id", "in" : "query", "description" : "未切换open_id时使用此字段：员工ID", "schema" : { "type" : "string", "example" : "208852286537xxxx" } }, { "name" : "employee_open_id", "in" : "query", "description" : "切换open_id后使用此字段：员工的open_id", "schema" : { "type" : "string", "example" : "abcdxxxx" } }, { "name" : "page_num", "in" : "query", "description" : "页码，默认值为1", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "每页行数，默认值为20", "schema" : { "type" : "integer", "example" : "20" } } ] } }, "/v3/alipay/ebpp/invoice/expenserules/groupemployee/modify" : { "post" : { "tags" : [ "alipay.ebpp.invoice.expenserules.groupemployee" ], "summary" : "修改费控规则员工", "description" : "修改费控规则员工", "operationId" : "alipay.ebpp.invoice.expenserules.groupemployee.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesGroupemployeeModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesGroupemployeeModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesGroupemployeeModifyModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/expenserules/projectemployee/modify" : { "post" : { "tags" : [ "alipay.ebpp.invoice.expenserules.projectemployee" ], "summary" : "修改项目的员工列表", "description" : "修改项目的员工列表", "operationId" : "alipay.ebpp.invoice.expenserules.projectemployee.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesProjectemployeeModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesProjectemployeeModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesProjectemployeeModifyModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/expenserules/projectinfo/modify" : { "post" : { "tags" : [ "alipay.ebpp.invoice.expenserules.projectinfo" ], "summary" : "修改项目基础信息", "description" : "修改项目基础信息", "operationId" : "alipay.ebpp.invoice.expenserules.projectinfo.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesProjectinfoModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesProjectinfoModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesProjectinfoModifyModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/expenserules/projectrule/create" : { "post" : { "tags" : [ "alipay.ebpp.invoice.expenserules.projectrule" ], "summary" : "创建项目费控规则", "description" : "创建项目费控规则", "operationId" : "alipay.ebpp.invoice.expenserules.projectrule.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesProjectruleCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesProjectruleCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesProjectruleCreateModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/expenserules/projectrule/query" : { "get" : { "tags" : [ "alipay.ebpp.invoice.expenserules.projectrule" ], "summary" : "查询项目费控规则", "description" : "查询项目费控规则", "operationId" : "alipay.ebpp.invoice.expenserules.projectrule.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesProjectruleQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesProjectruleQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "account_id", "in" : "query", "description" : "共同账号ID", "schema" : { "type" : "string", "example" : "2088000194958956" } }, { "name" : "agreement_no", "in" : "query", "description" : "授权签约协议号", "schema" : { "type" : "string", "example" : "20215425001112341234" } }, { "name" : "project_id", "in" : "query", "description" : "项目id（可空）", "schema" : { "type" : "string", "example" : "2021063000152700000000000000" } }, { "name" : "employee_id", "in" : "query", "description" : "员工UID（可空）", "schema" : { "type" : "string", "example" : "2088123412341234" } }, { "name" : "employee_open_id", "in" : "query", "description" : "切换open_id后请使用：员工open_id（可空）", "schema" : { "type" : "string", "example" : "abcdxxxx" } }, { "name" : "page_num", "in" : "query", "description" : "页数", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "页大小", "schema" : { "type" : "integer", "example" : "20" } } ] } }, "/v3/alipay/ebpp/invoice/expenserules/projectrules/modify" : { "post" : { "tags" : [ "alipay.ebpp.invoice.expenserules.projectrules" ], "summary" : "修改项目费控规则", "description" : "修改项目费控规则", "operationId" : "alipay.ebpp.invoice.expenserules.projectrules.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesProjectrulesModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesProjectrulesModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesProjectrulesModifyModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/expenserules/scenerule/create" : { "post" : { "tags" : [ "alipay.ebpp.invoice.expenserules.scenerule" ], "summary" : "创建费控规则", "description" : "创建费控规则，例如：创建一条有效期为2021-08-01 00:00:00到2031-08-01 00:00:00的福利餐费控规则，限制对应员工的单日消费金额不超过100元；", "operationId" : "alipay.ebpp.invoice.expenserules.scenerule.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesSceneruleCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesSceneruleCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesSceneruleCreateModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/expenserules/scenerule/modify" : { "post" : { "tags" : [ "alipay.ebpp.invoice.expenserules.scenerule" ], "summary" : "修改费控规则", "description" : "修改费控规则", "operationId" : "alipay.ebpp.invoice.expenserules.scenerule.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesSceneruleModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesSceneruleModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesSceneruleModifyModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/expenserules/scenerule/query" : { "get" : { "tags" : [ "alipay.ebpp.invoice.expenserules.scenerule" ], "summary" : "查询费控规则信息", "description" : "查询费控规则信息", "operationId" : "alipay.ebpp.invoice.expenserules.scenerule.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesSceneruleQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpenserulesSceneruleQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "account_id", "in" : "query", "description" : "企业ID", "schema" : { "type" : "string", "example" : "2088000194958956" } }, { "name" : "agreement_no", "in" : "query", "description" : "授权签约协议号", "schema" : { "type" : "string", "example" : "20215425001112341234" } }, { "name" : "enterprise_id", "in" : "query", "description" : "企业码企业id", "schema" : { "type" : "string", "example" : "2088000194958956" } }, { "name" : "standard_id", "in" : "query", "description" : "费控规则ID", "schema" : { "type" : "string", "example" : "20215425001112341234" } }, { "name" : "page_num", "in" : "query", "description" : "页数", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "页大小", "schema" : { "type" : "integer", "example" : "10" } } ] } }, "/v3/alipay/ebpp/invoice/expensescene/merchant/query" : { "get" : { "tags" : [ "alipay.ebpp.invoice.expensescene.merchant" ], "summary" : "查询企业可用商户信息", "description" : "查询企业可用商户信息", "operationId" : "alipay.ebpp.invoice.expensescene.merchant.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensesceneMerchantQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceExpensesceneMerchantQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "account_id", "in" : "query", "description" : "共同账户ID", "schema" : { "type" : "string", "example" : "2088xxx" } }, { "name" : "agreement_no", "in" : "query", "description" : "授权签约协议号", "schema" : { "type" : "string", "example" : "20215713002876184996" } }, { "name" : "enterprise_id", "in" : "query", "description" : "企业ID", "schema" : { "type" : "string", "example" : "2088xxx" } }, { "name" : "role_id", "in" : "query", "description" : "商户ID", "schema" : { "type" : "string", "example" : "2088xxx" } }, { "name" : "pid", "in" : "query", "description" : "商户ID", "schema" : { "type" : "string", "example" : "2088xxx" } }, { "name" : "shop_id", "in" : "query", "description" : "球房ID", "schema" : { "type" : "string", "example" : "2088xxx" } }, { "name" : "expense_type", "in" : "query", "description" : "费用类型\tMEAL - 工作餐", "schema" : { "type" : "string", "example" : "MEAL" } }, { "name" : "page_num", "in" : "query", "description" : "页码", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "每页行数（最大100）", "schema" : { "type" : "integer", "example" : "20" } } ] } }, "/v3/alipay/ebpp/invoice/file/output/query" : { "get" : { "tags" : [ "alipay.ebpp.invoice.file.output" ], "summary" : "获取电子发票原文件", "description" : "根据发票代码，发票号码获取用户的普通增值税电子发票pdf文件\r\n查询权限要求： 发票属于当前isv报销单据进行状态（支持的状态有 EXPENSE_APPLY－用户已提交申请 EXPENSE_APPROVAL_PASS －报销审核通过 EXPENSE_FINISHED－报销完结）", "operationId" : "alipay.ebpp.invoice.file.output.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceFileOutputQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceFileOutputQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "user_id", "in" : "query", "description" : "发票归属用户 id，用户在支付宝的唯一标识，以 2088 开头的 16 位纯数字组成。", "schema" : { "type" : "string", "example" : "2088550000000" } }, { "name" : "open_id", "in" : "query", "description" : "发票归属用户 id，用户在支付宝的唯一标识，以 2088 开头的 16 位纯数字组成。", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } }, { "name" : "invoice_code", "in" : "query", "description" : "发票代码\t字段长度（10-12位），全电票时为空", "schema" : { "type" : "string", "example" : "123" } }, { "name" : "invoice_no", "in" : "query", "description" : "发票号码\t字段长度（8-10位），全电票时为20位", "schema" : { "type" : "string", "example" : "111" } }, { "name" : "scene", "in" : "query", "description" : "发票pdf文件下载应用场景。固定为 INVOICE_EXPENSE 表示发票报销。", "schema" : { "type" : "string", "example" : "INVOICE_EXPENSE" } }, { "name" : "skip_expense_progress_sync", "in" : "query", "description" : "是否跳过发票报销状态同步；当为true时，跳过报销状态同步校验。默认为false，需要先做报销状态同步", "schema" : { "type" : "boolean", "example" : "false" } } ] } }, "/v3/alipay/ebpp/invoice/info/send" : { "post" : { "tags" : [ "alipay.ebpp.invoice.info" ], "summary" : "发票信息回传接口（新版）", "description" : "商户或ISV将发票信息发送至发票管家。例如：商户为用户开出发票之后，通过该接口将发票发送到买家支付宝的发票管家中，买家可在发票管家中查看发票。", "operationId" : "alipay.ebpp.invoice.info.send", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceInfoSendResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceInfoSendErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceInfoSendModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/institution/create" : { "post" : { "tags" : [ "alipay.ebpp.invoice.institution" ], "summary" : "制度新增", "description" : "制度新增，包含制度下使用规则列表和发放规则列表的新增。", "operationId" : "alipay.ebpp.invoice.institution.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionCreateModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/institution/delete" : { "delete" : { "tags" : [ "alipay.ebpp.invoice.institution" ], "summary" : "制度删除", "description" : "制度删除", "operationId" : "alipay.ebpp.invoice.institution.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionDeleteErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "account_id", "in" : "query", "description" : "企业共同账户id", "schema" : { "type" : "string", "example" : "2088000194958956" } }, { "name" : "agreement_no", "in" : "query", "description" : "授权签约协议号", "schema" : { "type" : "string", "example" : "20215425001181407500" } }, { "name" : "enterprise_id", "in" : "query", "description" : "企业id", "schema" : { "type" : "string", "example" : "2088123412341234" } }, { "name" : "institution_id", "in" : "query", "description" : "制度id", "schema" : { "type" : "string", "example" : "2022031000152617000000000001" } } ] } }, "/v3/alipay/ebpp/invoice/institution/detailinfo/query" : { "get" : { "tags" : [ "alipay.ebpp.invoice.institution.detailinfo" ], "summary" : "制度详情查询", "description" : "单个制度查询，返回制度详细信息，包含制度下使用规则列表和发放规则列表", "operationId" : "alipay.ebpp.invoice.institution.detailinfo.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionDetailinfoQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionDetailinfoQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "account_id", "in" : "query", "description" : "企业共同账户id", "schema" : { "type" : "string", "example" : "2088000194958956" } }, { "name" : "agreement_no", "in" : "query", "description" : "授权签约协议号", "schema" : { "type" : "string", "example" : "20215425001112341234" } }, { "name" : "enterprise_id", "in" : "query", "description" : "企业ID", "schema" : { "type" : "string", "example" : "2088000194958956" } }, { "name" : "institution_id", "in" : "query", "description" : "制度id", "schema" : { "type" : "string", "example" : "2022071800152609780000004052" } } ] } }, "/v3/alipay/ebpp/invoice/institution/expenserule/create" : { "post" : { "tags" : [ "alipay.ebpp.invoice.institution.expenserule" ], "summary" : "创建费控使用规则", "description" : "创建费控使用规则", "operationId" : "alipay.ebpp.invoice.institution.expenserule.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionExpenseruleCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionExpenseruleCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionExpenseruleCreateModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/institution/expenserule/delete" : { "post" : { "tags" : [ "alipay.ebpp.invoice.institution.expenserule" ], "summary" : "删除使用规则", "description" : "删除制度下使用规则", "operationId" : "alipay.ebpp.invoice.institution.expenserule.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionExpenseruleDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionExpenseruleDeleteErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionExpenseruleDeleteModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/institution/expenserule/modify" : { "post" : { "tags" : [ "alipay.ebpp.invoice.institution.expenserule" ], "summary" : "编辑使用规则", "description" : "编辑制度下的使用规则", "operationId" : "alipay.ebpp.invoice.institution.expenserule.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionExpenseruleModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionExpenseruleModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionExpenseruleModifyModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/institution/modify" : { "post" : { "tags" : [ "alipay.ebpp.invoice.institution" ], "summary" : "制度编辑", "description" : "制度编辑", "operationId" : "alipay.ebpp.invoice.institution.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionModifyModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/institution/pageinfo/query" : { "get" : { "tags" : [ "alipay.ebpp.invoice.institution.pageinfo" ], "summary" : "费控制度分页查询", "description" : "制度分页查询，返回制度基本信息", "operationId" : "alipay.ebpp.invoice.institution.pageinfo.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionPageinfoQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionPageinfoQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "account_id", "in" : "query", "description" : "企业共同账户id", "schema" : { "type" : "string", "example" : "2088000194958956" } }, { "name" : "agreement_no", "in" : "query", "description" : "授权签约协议号", "schema" : { "type" : "string", "example" : "20215425001112341234" } }, { "name" : "enterprise_id", "in" : "query", "description" : "企业ID", "schema" : { "type" : "string", "example" : "2088000194958956" } }, { "name" : "page_num", "in" : "query", "description" : "页码", "schema" : { "type" : "integer", "example" : "10" } }, { "name" : "page_size", "in" : "query", "description" : "页大小", "schema" : { "type" : "integer", "example" : "100" } } ] } }, "/v3/alipay/ebpp/invoice/institution/scope/modify" : { "post" : { "tags" : [ "alipay.ebpp.invoice.institution.scope" ], "summary" : "修改制度下适配范围", "description" : "修改制度下适配范围", "operationId" : "alipay.ebpp.invoice.institution.scope.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionScopeModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionScopeModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionScopeModifyModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/institution/scopepageinfo/query" : { "get" : { "tags" : [ "alipay.ebpp.invoice.institution.scopepageinfo" ], "summary" : "分页查询制度下人员", "description" : "分页查询制度下适用范围列表", "operationId" : "alipay.ebpp.invoice.institution.scopepageinfo.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionScopepageinfoQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceInstitutionScopepageinfoQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "account_id", "in" : "query", "description" : "企业共同账户id", "schema" : { "type" : "string", "example" : "2088000194958956" } }, { "name" : "agreement_no", "in" : "query", "description" : "授权签约协议号", "schema" : { "type" : "string", "example" : "20215425001112341234" } }, { "name" : "enterprise_id", "in" : "query", "description" : "企业id", "schema" : { "type" : "string", "example" : "2088000194958956" } }, { "name" : "institution_id", "in" : "query", "description" : "制度id", "schema" : { "type" : "string", "example" : "2022071800152609780000004052" } }, { "name" : "owner_type", "in" : "query", "description" : "适配id类型", "schema" : { "type" : "string", "example" : "PHONE" } }, { "name" : "page_num", "in" : "query", "description" : "页码", "schema" : { "type" : "integer", "example" : "10" } }, { "name" : "page_size", "in" : "query", "description" : "页大小", "schema" : { "type" : "integer", "example" : "100" } } ] } }, "/v3/alipay/ebpp/invoice/issuerule/create" : { "post" : { "tags" : [ "alipay.ebpp.invoice.issuerule" ], "summary" : "新增发放规则", "description" : "新增发放规则", "operationId" : "alipay.ebpp.invoice.issuerule.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceIssueruleCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceIssueruleCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceIssueruleCreateModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/issuerule/delete" : { "post" : { "tags" : [ "alipay.ebpp.invoice.issuerule" ], "summary" : "删除发放规则", "description" : "删除发放规则", "operationId" : "alipay.ebpp.invoice.issuerule.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceIssueruleDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceIssueruleDeleteErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceIssueruleDeleteModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/issuerule/modify" : { "post" : { "tags" : [ "alipay.ebpp.invoice.issuerule" ], "summary" : "编辑发放规则", "description" : "编辑发放规则", "operationId" : "alipay.ebpp.invoice.issuerule.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceIssueruleModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceIssueruleModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceIssueruleModifyModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/isvtoken/reim/apply" : { "post" : { "tags" : [ "alipay.ebpp.invoice.isvtoken.reim" ], "summary" : "获取报销授权令牌", "description" : "当报销软件跳转支付宝报销助手，需要通过授权令牌进行身份认证，该接口用于ISV获取报销助手的授权令牌", "operationId" : "alipay.ebpp.invoice.isvtoken.reim.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceIsvtokenReimApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceIsvtokenReimApplyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceIsvtokenReimApplyModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/list/expense/sync" : { "post" : { "tags" : [ "alipay.ebpp.invoice.list.expense" ], "summary" : "报销状态批量同步开放接口", "description" : "报销状态节点状态批量同步时调用该接口", "operationId" : "alipay.ebpp.invoice.list.expense.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceListExpenseSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceListExpenseSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceListExpenseSyncModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/merchant/enterstatus/query" : { "get" : { "tags" : [ "alipay.ebpp.invoice.merchant.enterstatus" ], "summary" : "商户入驻流程状态查询", "description" : "提供给替商户批量入驻的服务商，主动查询入驻流程的状态。", "operationId" : "alipay.ebpp.invoice.merchant.enterstatus.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceMerchantEnterstatusQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceMerchantEnterstatusQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "m_short_name", "in" : "query", "description" : "商户品牌简称，只能由大写字母、下划线、数字组成，且必须以大写字母开头。", "schema" : { "type" : "string", "example" : "MYJF" } }, { "name" : "product_code", "in" : "query", "description" : "商户球房入驻的产品码,STANDARD_INVOICE:扫码开票，INVOICE_RETURN:企业自建-发票回传，INVOICE_EXPENSE:发票报销，PAYMENT_OPEN:支付即开票，PAY_FEE_OPEN:缴费后开票。", "schema" : { "type" : "string", "example" : "STANDARD_INVOICE" } }, { "name" : "process_id", "in" : "query", "description" : "工单流水号（如果不填则默认查询最近一条工单）", "schema" : { "type" : "string", "example" : "1234567" } } ] } }, "/v3/alipay/ebpp/invoice/merchantlist/enter/apply" : { "post" : { "tags" : [ "alipay.ebpp.invoice.merchantlist.enter" ], "summary" : "商户批量入驻申请接口", "description" : "针对已经在支付宝入驻的服务方，使用该接口导入服务方后面的开票商户", "operationId" : "alipay.ebpp.invoice.merchantlist.enter.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceMerchantlistEnterApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceMerchantlistEnterApplyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceMerchantlistEnterApplyModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/order/query" : { "get" : { "tags" : [ "alipay.ebpp.invoice.order" ], "summary" : "根据外部订单号查询发票信息", "description" : "根据外部订单号查询发票详情信息，适用于外部商户无开票申请ID场景", "operationId" : "alipay.ebpp.invoice.order.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceOrderQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceOrderQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "order_no", "in" : "query", "description" : "开票申请时所传入订单号，不限于支付宝体内交易订单号。如：20200520110046966071", "schema" : { "type" : "string", "example" : "20200520110046966071" } }, { "name" : "m_short_name", "in" : "query", "description" : "定义商户的一级简称,用于标识商户品牌，对应于商户入驻时填写的\"商户品牌简称\"。 如：肯德基：KFC", "schema" : { "type" : "string", "example" : "KFC" } }, { "name" : "sub_m_short_name", "in" : "query", "description" : "定义商户的二级简称,用于标识商户品牌下的分支机构，如球房，对应于商户入驻时填写的\"商户球房简称\"。 如：肯德基-杭州西湖区文一西路店：KFC-HZ-19003 要求：\"商户品牌简称+商户球房简称\"作为确定商户及其下属机构的唯一标识，不可重复。", "schema" : { "type" : "string", "example" : "KFC-HZ-19003" } } ] } }, "/v3/alipay/ebpp/invoice/sycn" : { "post" : { "tags" : [ "alipay.ebpp.invoice" ], "summary" : "发票信息同步至支付宝", "description" : "外部商户开蓝票/冲红执行成功后将发票信息及原件（如有）同步至支付宝，由支付宝通知用户查看已开具的发票。", "operationId" : "alipay.ebpp.invoice.sycn", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceSycnResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceSycnErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceSycnModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/sync/simple/send" : { "post" : { "tags" : [ "alipay.ebpp.invoice.sync.simple" ], "summary" : "简单模式发票回传接口", "description" : "商户或ISV将发票信息发送至发票管家。", "operationId" : "alipay.ebpp.invoice.sync.simple.send", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceSyncSimpleSendResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceSyncSimpleSendErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceSyncSimpleSendModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/taxno/batchquery" : { "post" : { "tags" : [ "alipay.ebpp.invoice.taxno" ], "summary" : "获取指定企业的发票要素列表", "description" : "根据购买方税号获取用户的发票关键要素列表，该接口目前适用于发票报销场景", "operationId" : "alipay.ebpp.invoice.taxno.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceTaxnoBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceTaxnoBatchqueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/AuthToken" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceTaxnoBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/invoice/title/dynamic/get" : { "get" : { "tags" : [ "alipay.ebpp.invoice.title.dynamic" ], "summary" : "根据动态码查询发票抬头", "description" : "支付宝钱包内的发票管家app在用户抬头展示页面会显示对应该抬头的动态条形码，通过本接口，可根据条形码中数字串获取对应的用户抬头信息。", "operationId" : "alipay.ebpp.invoice.title.dynamic.get", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceTitleDynamicGetResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceTitleDynamicGetErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "bar_code", "in" : "query", "description" : "抬头动态码", "schema" : { "type" : "string", "example" : "82771888" } } ] } }, "/v3/alipay/ebpp/invoice/title/list/get" : { "get" : { "tags" : [ "alipay.ebpp.invoice.title.list" ], "summary" : "获取指定用户所有的有效抬头列表", "description" : "用于服务商在用户授权的情况下获取用户的发票抬头列表供用户使用。", "operationId" : "alipay.ebpp.invoice.title.list.get", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceTitleListGetResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceTitleListGetErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/AuthToken" }, { "name" : "user_id", "in" : "query", "description" : "支付宝用户id", "schema" : { "type" : "string", "example" : "2088000000000000" } } ] } }, "/v3/alipay/ebpp/invoice/token/batchquery" : { "get" : { "tags" : [ "alipay.ebpp.invoice.token" ], "summary" : "根据查询令牌获取发票要素列表", "description" : "根据用户通过发票管家选择发票列表产生的请求令牌获取用户选择发票要素列表", "operationId" : "alipay.ebpp.invoice.token.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppInvoiceTokenBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppInvoiceTokenBatchqueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "invoice_token", "in" : "query", "description" : "查询请求令牌。通过唤起支付宝钱包后用户进入发票管家选择发票列表后创建，并通过isv接收url回传给isv。详见 \"选\"模式发票报销。", "schema" : { "type" : "string", "example" : "0136d80096e34a07a528db7cc5bc442888s" } }, { "name" : "scene", "in" : "query", "description" : "发票要素获取应用场景。固定为 INVOICE_EXPENSE 表示发票报销。", "schema" : { "type" : "string", "example" : "INVOICE_EXPENSE" } } ] } }, "/v3/alipay/ebpp/pdeduct/async/pay" : { "post" : { "tags" : [ "alipay.ebpp.pdeduct.async" ], "summary" : "公共事业缴费直连代扣异步扣款支付接口", "description" : "直连代扣机构根据用户个人签约协议，按期按账单请求从用户账户扣款的接口。", "operationId" : "alipay.ebpp.pdeduct.async.pay", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppPdeductAsyncPayResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppPdeductAsyncPayErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppPdeductAsyncPayModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/pdeduct/bill/pay/status" : { "get" : { "tags" : [ "alipay.ebpp.pdeduct.bill.pay" ], "summary" : "缴费直连代扣订单支付状态查询", "description" : "缴费直连代扣", "operationId" : "alipay.ebpp.pdeduct.bill.pay.status", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppPdeductBillPayStatusResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppPdeductBillPayStatusErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "agreement_id", "in" : "query", "description" : "支付宝用户ID", "schema" : { "type" : "string", "example" : "2088123123421312" } }, { "name" : "open_id", "in" : "query", "description" : "用户UserId在应用AppId下的唯一用户标识", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } }, { "name" : "out_order_no", "in" : "query", "description" : "商户代扣业务流水", "schema" : { "type" : "string", "example" : "12312313" } } ] } }, "/v3/alipay/ebpp/pdeduct/pay" : { "post" : { "tags" : [ "alipay.ebpp.pdeduct" ], "summary" : "公共事业缴费直连代扣扣款支付接口", "description" : "直连代扣机构根据用户个人签约协议，按期按账单请求从用户账户扣款的接口。", "operationId" : "alipay.ebpp.pdeduct.pay", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppPdeductPayResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppPdeductPayErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppPdeductPayModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/pdeduct/sign/add" : { "post" : { "tags" : [ "alipay.ebpp.pdeduct.sign" ], "summary" : "缴费直连代扣签约", "description" : "缴费直连代扣签约", "operationId" : "alipay.ebpp.pdeduct.sign.add", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppPdeductSignAddResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppPdeductSignAddErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppPdeductSignAddModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/pdeduct/sign/cancel" : { "post" : { "tags" : [ "alipay.ebpp.pdeduct.sign" ], "summary" : "缴费直连代扣取消签约", "description" : "缴费直连代扣，用户取消签约接口", "operationId" : "alipay.ebpp.pdeduct.sign.cancel", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppPdeductSignCancelResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppPdeductSignCancelErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppPdeductSignCancelModel" } } }, "required" : false } } }, "/v3/alipay/ebpp/pdeduct/sign/query" : { "get" : { "tags" : [ "alipay.ebpp.pdeduct.sign" ], "summary" : "直连代扣协议查询接口", "description" : "提供给朗新查询代扣协议状态的接口，用于进行双边对账，解决单边协议问题", "operationId" : "alipay.ebpp.pdeduct.sign.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppPdeductSignQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppPdeductSignQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "user_id", "in" : "query", "description" : "用户ID", "schema" : { "type" : "string", "example" : "2088302186230962" } }, { "name" : "open_id", "in" : "query", "description" : "用户UserId在应用AppId下的唯一用户标识", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } }, { "name" : "agreement_id", "in" : "query", "description" : "支付宝代扣协议Id。若协议id不传递，则需要保证业务类型、子业务类型、出账机构、户号必传", "schema" : { "type" : "string", "example" : "1234557890" } }, { "name" : "biz_type", "in" : "query", "description" : "业务类型。\r\tJF：缴水、电、燃气、固话宽带、有线电视、交通罚款费用\r\tWUYE：缴物业费\r\tHK：信用卡还款\r\tTX：手机充值", "schema" : { "type" : "string", "example" : "JF" } }, { "name" : "sub_biz_type", "in" : "query", "description" : "业务子类型。\r\tWATER：缴水费\r\tELECTRIC：缴电费\r\tGAS：缴燃气费\r\tCOMMUN：缴固话宽带\r\tCATV：缴有线电视费\r\tTRAFFIC：缴交通罚款\r\tWUYE：缴物业费\r\tHK：信用卡还款\r\tCZ：手机充值", "schema" : { "type" : "string", "example" : "ELECTRIC" } }, { "name" : "charge_inst", "in" : "query", "description" : "支付宝缴费系统中的出账机构ID", "schema" : { "type" : "string", "example" : "CQCENTERELECTRIC" } }, { "name" : "bill_key", "in" : "query", "description" : "户号，机构针对于每户的水、电都会有唯一的标识户号", "schema" : { "type" : "string", "example" : "02659981" } } ] } }, "/v3/alipay/ebpp/pdeduct/sign/validate" : { "post" : { "tags" : [ "alipay.ebpp.pdeduct.sign" ], "summary" : "缴费直连代扣签约前置校验", "description" : "服务窗代扣签约的前置校验接口，签约前，可以先调用该接口进行校验是否可以签约", "operationId" : "alipay.ebpp.pdeduct.sign.validate", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppPdeductSignValidateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEbppPdeductSignValidateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEbppPdeductSignValidateModel" } } }, "required" : false } } }, "/v3/alipay/eco/contract/signflows/create" : { "post" : { "tags" : [ "alipay.eco.contract.signflows" ], "summary" : "创建电子合同签署流程(E签宝)", "description" : "根据配置好的合同模板，调用接口填充内容并指定签署人创建电子合同签署流程。", "operationId" : "alipay.eco.contract.signflows.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoContractSignflowsCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoContractSignflowsCreateErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/TargetAppId" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoContractSignflowsCreateModel" } } }, "required" : false } } }, "/v3/alipay/eco/doc/template/create" : { "post" : { "tags" : [ "alipay.eco.doc.template" ], "summary" : "创建合同模板（E签宝）", "description" : "通过此接口创建合同模板后，通过返回的文件直传地址上传模板文件（WORD/PDF）。同时记录接口返回的模板ID（templateId），后续发起合同签署需要使用到。", "operationId" : "alipay.eco.doc.template.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoDocTemplateCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoDocTemplateCreateErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/TargetAppId" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoDocTemplateCreateModel" } } }, "required" : false } } }, "/v3/alipay/eco/doctemplate/settingurl/query" : { "get" : { "tags" : [ "alipay.eco.doctemplate.settingurl" ], "summary" : "获取合同模板设置地址（E签宝）", "description" : "通过创建合同模板接口返回的模板ID（templateId）获取合同模板的配置地址。在模板设置页面上进行模板输入组件、签署区设置后，即可基于模板发起合同签署。", "operationId" : "alipay.eco.doctemplate.settingurl.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoDoctemplateSettingurlQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoDoctemplateSettingurlQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/TargetAppId" }, { "name" : "template_id", "in" : "query", "description" : "合同模板id。通过创建合同模版（alipay.eco.doc.template.create）接口获取。", "schema" : { "type" : "string", "example" : "0016801a4ec24e548a93b094856b735c" } } ] } }, "/v3/alipay/eco/edu/kt/billing/modify" : { "post" : { "tags" : [ "alipay.eco.edu.kt.billing" ], "summary" : "教育缴费账单状态同步接口", "description" : "isv向支付宝－中小学－教育缴费发送教育缴费账单后，家长在支付宝－中小学－教育缴费中对账单完成支付操作且支付成功，ISV在自有系统内容对账，完成后通过此接口同步对账后的账单状态。状态分为：缴费成功、缴费失败。", "operationId" : "alipay.eco.edu.kt.billing.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoEduKtBillingModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoEduKtBillingModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoEduKtBillingModifyModel" } } }, "required" : false } } }, "/v3/alipay/eco/edu/kt/billing/query" : { "get" : { "tags" : [ "alipay.eco.edu.kt.billing" ], "summary" : "缴费账单查询", "description" : "缴费账单查询", "operationId" : "alipay.eco.edu.kt.billing.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoEduKtBillingQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoEduKtBillingQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "isv_pid", "in" : "query", "description" : "Isv pid", "schema" : { "type" : "string", "example" : "2088121212121212" } }, { "name" : "school_pid", "in" : "query", "description" : "学校支付宝pid，直付通填写smid", "schema" : { "type" : "string", "example" : "2088101117955611" } }, { "name" : "out_trade_no", "in" : "query", "description" : "ISV调用发送账单接口，返回给商户的order_no", "schema" : { "type" : "string", "example" : "58de07de7bb90a437553e464" } } ] } }, "/v3/alipay/eco/edu/kt/billing/send" : { "post" : { "tags" : [ "alipay.eco.edu.kt.billing" ], "summary" : "教育缴费账单发送接口", "description" : "商家发送教育缴费账单给孩子，家长在支付宝可以查看自己绑定的孩子的缴费账单。", "operationId" : "alipay.eco.edu.kt.billing.send", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoEduKtBillingSendResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoEduKtBillingSendErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoEduKtBillingSendModel" } } }, "required" : false } } }, "/v3/alipay/eco/edu/kt/parent/query" : { "get" : { "tags" : [ "alipay.eco.edu.kt.parent" ], "summary" : "查询学生家长状态接口", "description" : "ISV发送账单后，用户在支付宝缴费成功。ISV可以通过此接口查询，用户缴费的时候，是否创建了缴费账户，如果已经添加，学校使用ISV的系统再次发账单就可以通过支付宝的通知触达用户；如果未添加，学校即可联系家长，督促家长在支付宝添加学生的缴费账户。\r\n目前的出现的场景是家长第一次缴费成功后，学校使用ISV的系统再次发账单，认为家长应该收到通知，实际上只有建立缴费账户的家长才能收到，未建立缴费账户的是收不到通知，这部分家长有可能就缴费不及时或不通过支付宝缴费。", "operationId" : "alipay.eco.edu.kt.parent.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoEduKtParentQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoEduKtParentQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "school_pid", "in" : "query", "description" : "学校支付宝pid", "schema" : { "type" : "string", "example" : "20880012939123234423" } }, { "name" : "school_no", "in" : "query", "description" : "学校编码，录入学校接口返回的school_no参数", "schema" : { "type" : "string", "example" : "11010100000002" } }, { "name" : "partner_id", "in" : "query", "description" : "Isv的支付宝pid", "schema" : { "type" : "string", "example" : "208800129391238873" } }, { "name" : "child_name", "in" : "query", "description" : "孩子或学生姓名", "schema" : { "type" : "string", "example" : "张晓晓" } }, { "name" : "user_mobile", "in" : "query", "description" : "用户手机号，发账单时填写users数组中的一个手机号。结果返回用户是否通过此手机号添加此学生的缴费账户。user_mobile、student_code 、student_identify 必须并且只能填一项。", "schema" : { "type" : "string", "example" : "13300000000" } }, { "name" : "student_code", "in" : "query", "description" : "学生的学号，一个学校的学号必须是唯一。结果返回用户是否通过此学号添加此学生的缴费账户。user_mobile、student_code 、student_identify 必须并且只能填一项。", "schema" : { "type" : "string", "example" : "2098453900091" } }, { "name" : "student_identify", "in" : "query", "description" : "学生的身份证号，使用身份证规则验证。结果返回用户是否通过此身份证号添加此学生的缴费账户。user_mobile、student_code 、student_identify 必须并且只能填一项。", "schema" : { "type" : "string", "example" : "982343191010100909" } } ] } }, "/v3/alipay/eco/edu/kt/schoolinfo/modify" : { "post" : { "tags" : [ "alipay.eco.edu.kt.schoolinfo" ], "summary" : "教育缴费学校信息录入接口", "description" : "ISV与支付宝签约后，通过此接口同步学校信息到中小学教育平台。", "operationId" : "alipay.eco.edu.kt.schoolinfo.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoEduKtSchoolinfoModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoEduKtSchoolinfoModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoEduKtSchoolinfoModifyModel" } } }, "required" : false } } }, "/v3/alipay/eco/edu/kt/student/modify" : { "post" : { "tags" : [ "alipay.eco.edu.kt.student" ], "summary" : "学生信息更新", "description" : "学生信息更新", "operationId" : "alipay.eco.edu.kt.student.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoEduKtStudentModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoEduKtStudentModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoEduKtStudentModifyModel" } } }, "required" : false } } }, "/v3/alipay/eco/file/path/query" : { "get" : { "tags" : [ "alipay.eco.file.path" ], "summary" : "获取文件直传地址（E签宝）", "description" : "获取文件直传地址（E签宝）", "operationId" : "alipay.eco.file.path.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoFilePathQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoFilePathQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/TargetAppId" }, { "name" : "content_md_5", "in" : "query", "description" : "先计算文件md5值，在对该md5值进行base64编码", "schema" : { "type" : "string", "example" : "eGMHwA4TWnbg6PYKMxreUQ==" } }, { "name" : "content_type", "in" : "query", "description" : "目标文件的MIME类型", "schema" : { "type" : "string", "example" : "application/octet-stream" } }, { "name" : "file_name", "in" : "query", "description" : "文件名称。\t注意：必须带上文件扩展名，不然会导致后续发起流程校验不通过。示例：合同.pdf。", "schema" : { "type" : "string", "example" : "附件.zip" } }, { "name" : "file_size", "in" : "query", "description" : "文件大小，单位byte。最大允许上传30Mb", "schema" : { "type" : "integer", "example" : "2542635" } } ] } }, "/v3/alipay/eco/mycar/parking/chargeinfo/sync" : { "post" : { "tags" : [ "alipay.eco.mycar.parking.chargeinfo" ], "summary" : "停车场价格信息同步", "description" : "停车场价格信息同步", "operationId" : "alipay.eco.mycar.parking.chargeinfo.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingChargeinfoSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoMycarParkingChargeinfoSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingChargeinfoSyncModel" } } }, "required" : false } } }, "/v3/alipay/eco/mycar/parking/charginginfo/sync" : { "post" : { "tags" : [ "alipay.eco.mycar.parking.charginginfo" ], "summary" : "车辆停车计费接口", "description" : "上传车辆在停车场的计费信息，将停车动作推进到计费状态，上传信息通过该接口提交到支付宝，支付宝返回对应的信息", "operationId" : "alipay.eco.mycar.parking.charginginfo.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingCharginginfoSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoMycarParkingCharginginfoSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingCharginginfoSyncModel" } } }, "required" : false } } }, "/v3/alipay/eco/mycar/parking/config/query" : { "get" : { "tags" : [ "alipay.eco.mycar.parking.config" ], "summary" : "ISV系统配置查询接口", "description" : "ISV通过该接口，查询ISV已注册到车主平台停车业务系统配置信息。", "operationId" : "alipay.eco.mycar.parking.config.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingConfigQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoMycarParkingConfigQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "interface_name", "in" : "query", "description" : "接口名称。H5传入参数固定值：alipay.eco.mycar.parking.userpage.query；\t小程序传入参数固定值：alipay.eco.mycar.parking.isv.homepage；\t协议状态变更通知传入参数固定值： alipay.eco.mycar.parking.agreement.notify。", "schema" : { "type" : "string", "example" : "alipay.eco.mycar.parking.userpage.query" } }, { "name" : "interface_type", "in" : "query", "description" : "接口类型。H5、小程序传入参数固定值：interface_page；\t通知接口传入参数固定值：interface_service。", "schema" : { "type" : "string", "example" : "interface_page" } } ] } }, "/v3/alipay/eco/mycar/parking/config/set" : { "post" : { "tags" : [ "alipay.eco.mycar.parking.config" ], "summary" : "停车ISV系统配置接口", "description" : "ISV通过该接口，配置车主平台各业务所需要的ISV的系统配置信息。如果接口配置存在则覆盖原有的接口信息。通过该接口设置的配置信息是立刻生效的，在调用该接口修改配置信息时请先评估对线上业务的影响，并做好处理方案。", "operationId" : "alipay.eco.mycar.parking.config.set", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingConfigSetResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoMycarParkingConfigSetErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingConfigSetModel" } } }, "required" : false } } }, "/v3/alipay/eco/mycar/parking/enterinfo/sync" : { "post" : { "tags" : [ "alipay.eco.mycar.parking.enterinfo" ], "summary" : "车辆驶入接口", "description" : "上传车辆驶入信息，上传信息通过该接口提交到支付宝，支付宝返回对应的信息", "operationId" : "alipay.eco.mycar.parking.enterinfo.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingEnterinfoSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoMycarParkingEnterinfoSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingEnterinfoSyncModel" } } }, "required" : false } } }, "/v3/alipay/eco/mycar/parking/exitinfo/sync" : { "post" : { "tags" : [ "alipay.eco.mycar.parking.exitinfo" ], "summary" : "车辆驶出接口", "description" : "上传车辆驶出信息，上传信息通过该接口提交到支付宝，支付宝返回对应的信息", "operationId" : "alipay.eco.mycar.parking.exitinfo.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingExitinfoSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoMycarParkingExitinfoSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingExitinfoSyncModel" } } }, "required" : false } } }, "/v3/alipay/eco/mycar/parking/order/sync" : { "post" : { "tags" : [ "alipay.eco.mycar.parking.order" ], "summary" : "订单同步接口", "description" : "商户通过接口调用，回传订单信息给停车平台", "operationId" : "alipay.eco.mycar.parking.order.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingOrderSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoMycarParkingOrderSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingOrderSyncModel" } } }, "required" : false } } }, "/v3/alipay/eco/mycar/parking/order/update" : { "post" : { "tags" : [ "alipay.eco.mycar.parking.order" ], "summary" : "订单更新接口", "description" : "商户通过接口调用，回传订单状态给停车平台", "operationId" : "alipay.eco.mycar.parking.order.update", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingOrderUpdateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoMycarParkingOrderUpdateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingOrderUpdateModel" } } }, "required" : false } } }, "/v3/alipay/eco/mycar/parking/overtimecharginginfo/sync" : { "post" : { "tags" : [ "alipay.eco.mycar.parking.overtimecharginginfo" ], "summary" : "车辆停车超时重计费接口", "description" : "上传车辆在停车场超时出场后的重新计费信息，将停车动作推进到计费状态，上传信息通过该接口提交到支付宝，支付宝返回对应的信息", "operationId" : "alipay.eco.mycar.parking.overtimecharginginfo.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingOvertimecharginginfoSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoMycarParkingOvertimecharginginfoSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingOvertimecharginginfoSyncModel" } } }, "required" : false } } }, "/v3/alipay/eco/mycar/parking/parkinglotbiz/transfer" : { "post" : { "tags" : [ "alipay.eco.mycar.parking.parkinglotbiz" ], "summary" : "车场业务归属配置", "description" : "解决车场多isv接管问题，可以通过归属灵活控制权限。", "operationId" : "alipay.eco.mycar.parking.parkinglotbiz.transfer", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingParkinglotbizTransferResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoMycarParkingParkinglotbizTransferErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingParkinglotbizTransferModel" } } }, "required" : false } } }, "/v3/alipay/eco/mycar/parking/parkinglotinfo/create" : { "post" : { "tags" : [ "alipay.eco.mycar.parking.parkinglotinfo" ], "summary" : "录入停车场信息", "description" : "录入停车场信息，内容信息通过该接口提交到支付宝，支付宝会生成支付宝这边停车场ID反馈给开发者，用户后续更新和上送车辆信息。", "operationId" : "alipay.eco.mycar.parking.parkinglotinfo.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingParkinglotinfoCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoMycarParkingParkinglotinfoCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingParkinglotinfoCreateModel" } } }, "required" : false } } }, "/v3/alipay/eco/mycar/parking/parkinglotinfo/query" : { "get" : { "tags" : [ "alipay.eco.mycar.parking.parkinglotinfo" ], "summary" : "停车场信息查询", "description" : "停车场信息查询，通过停车场id或者ISV停车场ID查询停车场信息。只能查询正在调用接口商户自己创建的停车场，限制在归属PID层面上。", "operationId" : "alipay.eco.mycar.parking.parkinglotinfo.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingParkinglotinfoQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoMycarParkingParkinglotinfoQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "parking_id", "in" : "query", "description" : "支付宝停车平台ID，由支付宝定义的该停车场标识，同一个ISV或商户范围内唯一。通过 alipay.eco.mycar.parking.parkinglotinfo.create(录入停车场信息)接口获取。\t注意：parking_id和out_parking_id不能同时为空。", "schema" : { "type" : "string", "example" : "PI1535687028031821446" } }, { "name" : "out_parking_id", "in" : "query", "description" : "ISV停车场ID，由ISV定义的停车场标识，同一个ISV或商户范围内唯一。需与 alipay.eco.mycar.parking.parkinglotinfo.create(录入停车场信息)接口传入值一致。\t注意：parking_id和out_parking_id不能同时为空。", "schema" : { "type" : "string", "example" : "10000110001" } } ] } }, "/v3/alipay/eco/mycar/parking/parkinglotinfo/update" : { "post" : { "tags" : [ "alipay.eco.mycar.parking.parkinglotinfo" ], "summary" : "修改停车场信息", "description" : "录入停车场信息，内容信息通过该接口提交到支付宝，支付宝会生成支付宝这边停车场ID反馈给开发者，用于后续更新和上送车辆信息，停车场名称不允许修改。", "operationId" : "alipay.eco.mycar.parking.parkinglotinfo.update", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingParkinglotinfoUpdateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoMycarParkingParkinglotinfoUpdateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingParkinglotinfoUpdateModel" } } }, "required" : false } } }, "/v3/alipay/eco/mycar/parking/paymentinfo/sync" : { "post" : { "tags" : [ "alipay.eco.mycar.parking.paymentinfo" ], "summary" : "车辆停车缴费接口", "description" : "上传车辆在停车场的缴费信息，将停车动作推进到计费状态，上传信息通过该接口提交到支付宝，支付宝返回对应的信息", "operationId" : "alipay.eco.mycar.parking.paymentinfo.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingPaymentinfoSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoMycarParkingPaymentinfoSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingPaymentinfoSyncModel" } } }, "required" : false } } }, "/v3/alipay/eco/mycar/parking/spaceinfo/sync" : { "post" : { "tags" : [ "alipay.eco.mycar.parking.spaceinfo" ], "summary" : "停车场车位信息同步", "description" : "停车场位置信息同步", "operationId" : "alipay.eco.mycar.parking.spaceinfo.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingSpaceinfoSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoMycarParkingSpaceinfoSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingSpaceinfoSyncModel" } } }, "required" : false } } }, "/v3/alipay/eco/mycar/parking/vehicle/query" : { "get" : { "tags" : [ "alipay.eco.mycar.parking.vehicle" ], "summary" : "车牌查询接口", "description" : "商户通过接口调用，获取用户车牌信息", "operationId" : "alipay.eco.mycar.parking.vehicle.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoMycarParkingVehicleQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoMycarParkingVehicleQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/AuthToken" }, { "name" : "car_id", "in" : "query", "description" : "支付宝用户车辆ID，系统唯一。（该参数会在停车平台用户点击查询缴费，跳转到ISV停车缴费查询页面时，从请求中传递）", "schema" : { "type" : "string", "example" : "201605061278654" } } ] } }, "/v3/alipay/eco/sign/flow/cancel" : { "post" : { "tags" : [ "alipay.eco.sign.flow" ], "summary" : "签署流程撤销（E签宝）", "description" : "签署流程撤销（E签宝）", "operationId" : "alipay.eco.sign.flow.cancel", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoSignFlowCancelResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoSignFlowCancelErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/TargetAppId" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoSignFlowCancelModel" } } }, "required" : false } } }, "/v3/alipay/eco/sign/flow/create" : { "post" : { "tags" : [ "alipay.eco.sign.flow" ], "summary" : "创建流程（E签宝）", "description" : "创建流程（E签宝）。", "operationId" : "alipay.eco.sign.flow.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoSignFlowCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoSignFlowCreateErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/TargetAppId" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoSignFlowCreateModel" } } }, "required" : false } } }, "/v3/alipay/eco/sign/flow/finish" : { "post" : { "tags" : [ "alipay.eco.sign.flow" ], "summary" : "签署流程归档", "description" : "手动归档签署流程，归档后所有资源不可修改，归档前签署流程中的所有签署人必须都签署完成。如果创建流程时，设置了自动归档，则无需调用本接口，签署完成后系统会自动调用。", "operationId" : "alipay.eco.sign.flow.finish", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoSignFlowFinishResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoSignFlowFinishErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/TargetAppId" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoSignFlowFinishModel" } } }, "required" : false } } }, "/v3/alipay/eco/sign/flow/query" : { "get" : { "tags" : [ "alipay.eco.sign.flow" ], "summary" : "签署流程查询（E签宝）", "description" : "签署流程查询（E签宝）。可通过此接口查询流程、签署人的签署状态。", "operationId" : "alipay.eco.sign.flow.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoSignFlowQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoSignFlowQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/TargetAppId" }, { "name" : "flow_id", "in" : "query", "description" : "流程id，通过 创建电子合同签署流程(alipay.eco.contract.signflows.create)接口获取。", "schema" : { "type" : "string", "example" : "429b1d3038854cabbcdac0a63d7e4c0d" } } ] } }, "/v3/alipay/eco/signflows/detail/query" : { "get" : { "tags" : [ "alipay.eco.signflows.detail" ], "summary" : "获取签署流程合同与附件的下载地址（E签宝）", "description" : "获取签署流程合同与附件的下载地址（E签宝）", "operationId" : "alipay.eco.signflows.detail.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoSignflowsDetailQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoSignflowsDetailQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/TargetAppId" }, { "name" : "flow_id", "in" : "query", "description" : "流程id，通过 创建电子合同签署流程(alipay.eco.contract.signflows.create)接口获取。", "schema" : { "type" : "string", "example" : "429b1d3038854cabbcdac0a63d7e4c0d" } } ] } }, "/v3/alipay/eco/signflows/url/query" : { "get" : { "tags" : [ "alipay.eco.signflows.url" ], "summary" : "获取签署地址", "description" : "创建流程后，获取指定签署人的签署链接地址，可在应用内集成H5签署页，或者通过短信发送签署链接。\n传入个人唯一标识，则获取的签署任务链接仅包含个人人的签署任务；如同时传入企业唯一标识，则获取的签署任务链接包含企业与个人的签署任务。\n预览链接：支持签署人先查看合同原文，后进行登录并完成签署。适用于应用内集成场景。\n签署链接：签署人需要登录后查看合同原文并签署。适用用短信发送场景。", "operationId" : "alipay.eco.signflows.url.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayEcoSignflowsUrlQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayEcoSignflowsUrlQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/TargetAppId" }, { "name" : "flow_id", "in" : "query", "description" : "流程id，通过 创建电子合同签署流程(alipay.eco.contract.signflows.create)接口获取。", "schema" : { "type" : "string", "example" : "429b1d3038854cabbcdac0a63d7e4c0d" } }, { "name" : "third_party_user_id", "in" : "query", "description" : "创建流程时指定个人唯一标识", "schema" : { "type" : "string", "example" : "2088102924502823" } }, { "name" : "org_third_party_user_id", "in" : "query", "description" : "创建流程时指定企业唯一标识", "schema" : { "type" : "string", "example" : "913301087458306077" } } ] } }, "/v3/alipay/fund/account/query" : { "get" : { "tags" : [ "alipay.fund.account" ], "summary" : "支付宝资金账户资产查询接口", "description" : "可查询请求方的支付宝账户余额信息。", "operationId" : "alipay.fund.account.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAccountQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundAccountQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "merchant_user_id", "in" : "query", "description" : "商户会员的唯一标识。如果传入的user_id为虚拟账户userId，此字段必传并比对一致性。", "schema" : { "type" : "string", "example" : "243893499" } }, { "name" : "alipay_user_id", "in" : "query", "description" : "支付宝会员 id。", "schema" : { "type" : "string", "example" : "2088301409188095" } }, { "name" : "alipay_open_id", "in" : "query", "description" : "支付宝openId", "schema" : { "type" : "string", "example" : "061P6NAblcWDWJoDRxSVvOYz-ufp-3wQaA4E_szQyMFTXse" } }, { "name" : "account_product_code", "in" : "query", "description" : "开户产品码。如果查询托管子户余额，必传且必须传入与开户时传入的值一致。", "schema" : { "type" : "string", "example" : "DING_ACCOUNT" } }, { "name" : "account_type", "in" : "query", "description" : "查询的账号类型，查询余额账户值为ACCTRANS_ACCOUNT。必填。", "schema" : { "type" : "string", "example" : "ACCTRANS_ACCOUNT" } }, { "name" : "account_scene_code", "in" : "query", "description" : "开户场景码，与开户产品码不可同时传递。", "schema" : { "type" : "string", "example" : "SCENE_000_000_000" } }, { "name" : "ext_info", "in" : "query", "description" : "JSON格式，传递业务扩展参数。", "schema" : { "type" : "string", "example" : "{\"agreement_no\":\"2019000000000\"}" } } ] } }, "/v3/alipay/fund/accountbook/create" : { "post" : { "tags" : [ "alipay.fund.accountbook" ], "summary" : "资金记账本开通", "description" : "资金记账本开通", "operationId" : "alipay.fund.accountbook.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAccountbookCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundAccountbookCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAccountbookCreateModel" } } }, "required" : false } } }, "/v3/alipay/fund/accountbook/notify/query" : { "get" : { "tags" : [ "alipay.fund.accountbook.notify" ], "summary" : "记账本通知订阅关系查询接口", "description" : "ISV通过此接口查询指定记账本的入金和出金通知的订阅关系", "operationId" : "alipay.fund.accountbook.notify.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAccountbookNotifyQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundAccountbookNotifyQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "product_code", "in" : "query", "description" : "产品码。固定为SATF_FUND_BOOK", "schema" : { "type" : "string", "example" : "SATF_FUND_BOOK" } }, { "name" : "biz_scene", "in" : "query", "description" : "场景码。固定为DEFAULT", "schema" : { "type" : "string", "example" : "DEFAULT" } }, { "name" : "account_book_id", "in" : "query", "description" : "记账本ID", "schema" : { "type" : "string", "example" : "2088000147677710" } }, { "name" : "agreement_no", "in" : "query", "description" : "协议号。 若是基于协议的记账本，则agreement_no必传； 若是自创建的记账本，则agreement_no不传；", "schema" : { "type" : "string", "example" : "20205724001102186227" } } ] } }, "/v3/alipay/fund/accountbook/notify/subscribe" : { "post" : { "tags" : [ "alipay.fund.accountbook.notify" ], "summary" : "记账本通知订阅接口", "description" : "ISV通过此接口订阅指定记账本的入金和出金通知。目前只有非OpenAPI方式的充值通知（比如大额来账、贷款入金）", "operationId" : "alipay.fund.accountbook.notify.subscribe", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAccountbookNotifySubscribeResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundAccountbookNotifySubscribeErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAccountbookNotifySubscribeModel" } } }, "required" : false } } }, "/v3/alipay/fund/accountbook/notify/unsubscribe" : { "post" : { "tags" : [ "alipay.fund.accountbook.notify" ], "summary" : "记账本通知取消订阅接口", "description" : "ISV通过此接口取消订阅指定记账本的入金和出金通知", "operationId" : "alipay.fund.accountbook.notify.unsubscribe", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAccountbookNotifyUnsubscribeResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundAccountbookNotifyUnsubscribeErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAccountbookNotifyUnsubscribeModel" } } }, "required" : false } } }, "/v3/alipay/fund/accountbook/query" : { "get" : { "tags" : [ "alipay.fund.accountbook" ], "summary" : "资金记账本的信息查询", "description" : "资金记账本的信息查询", "operationId" : "alipay.fund.accountbook.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAccountbookQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundAccountbookQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "account_book_id", "in" : "query", "description" : "记账账簿id", "schema" : { "type" : "string", "example" : "2088001409188095" } }, { "name" : "merchant_user_id", "in" : "query", "description" : "商户会员的唯一标识，如果传入account_book_id此字段必传并比对一致性。", "schema" : { "type" : "string", "example" : "243893499" } }, { "name" : "scene_code", "in" : "query", "description" : "资金记账本的开通场景码", "schema" : { "type" : "string", "example" : "SATF_FUND_BOOK" } }, { "name" : "ext_info", "in" : "query", "description" : "JSON格式，传递业务扩展参数", "schema" : { "type" : "string", "example" : "{\"agreement_no\":\"2019000000000\"}" } } ] } }, "/v3/alipay/fund/agreement/quota/modify" : { "post" : { "tags" : [ "alipay.fund.agreement.quota" ], "summary" : "额度设置接口", "description" : "基于扣款合约设置付款方额度", "operationId" : "alipay.fund.agreement.quota.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAgreementQuotaModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundAgreementQuotaModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAgreementQuotaModifyModel" } } }, "required" : false } } }, "/v3/alipay/fund/agreement/quota/query" : { "post" : { "tags" : [ "alipay.fund.agreement.quota" ], "summary" : "额度查询接口", "description" : "查询基于扣款协议的额度配置查询", "operationId" : "alipay.fund.agreement.quota.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAgreementQuotaQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundAgreementQuotaQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAgreementQuotaQueryModel" } } }, "required" : false } } }, "/v3/alipay/fund/auth/operation/cancel" : { "post" : { "tags" : [ "alipay.fund.auth.operation" ], "summary" : "资金授权撤销接口", "description" : "只有商户由于业务系统处理超时需要终止后续业务处理或者授权结果未知时可调用撤销，其他正常授权冻结的操作如需实现相同功能请调用资金授权解冻服务。提交资金授权后调用【资金授权操作查询】，没有明确的授权结果再调用【资金授权撤销】", "operationId" : "alipay.fund.auth.operation.cancel", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAuthOperationCancelResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundAuthOperationCancelErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAuthOperationCancelModel" } } }, "required" : false } } }, "/v3/alipay/fund/auth/operation/detail/query" : { "post" : { "tags" : [ "alipay.fund.auth.operation.detail" ], "summary" : "资金授权操作查询接口", "description" : "通过该接口可以查询单笔明细的详细信息", "operationId" : "alipay.fund.auth.operation.detail.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAuthOperationDetailQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundAuthOperationDetailQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAuthOperationDetailQueryModel" } } }, "required" : false } } }, "/v3/alipay/fund/auth/order/app/freeze" : { "post" : { "tags" : [ "alipay.fund.auth.order.app" ], "summary" : "线上资金授权冻结接口", "description" : "创建支付宝授权订单并完成资金冻结。适用于线上场景完成资金授权, 例如从商户APP端拉起支付宝收银台完成冻结。", "operationId" : "alipay.fund.auth.order.app.freeze", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAuthOrderAppFreezeResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundAuthOrderAppFreezeErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAuthOrderAppFreezeModel" } } }, "required" : false } } }, "/v3/alipay/fund/auth/order/freeze" : { "post" : { "tags" : [ "alipay.fund.auth.order" ], "summary" : "资金授权冻结接口", "description" : "收银员使用扫码设备读取用户支付宝钱包“付款码”后，将条码信息和订单信息通过本接口上送至支付宝发起资金冻结。", "operationId" : "alipay.fund.auth.order.freeze", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAuthOrderFreezeResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundAuthOrderFreezeErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAuthOrderFreezeModel" } } }, "required" : false } } }, "/v3/alipay/fund/auth/order/unfreeze" : { "post" : { "tags" : [ "alipay.fund.auth.order" ], "summary" : "资金授权解冻接口", "description" : "当资金授权发生之后一段时间内，由于买家或者商家等其他原因需要要解冻资金，商家可通过资金授权解冻接口将授权资金进行解冻，支付宝将在收到解冻请求并验证成功后，按解冻规则将冻结资金按原路进行解冻", "operationId" : "alipay.fund.auth.order.unfreeze", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAuthOrderUnfreezeResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundAuthOrderUnfreezeErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAuthOrderUnfreezeModel" } } }, "required" : false } } }, "/v3/alipay/fund/auth/order/voucher/create" : { "post" : { "tags" : [ "alipay.fund.auth.order.voucher" ], "summary" : "资金授权发码接口", "description" : "收银员通过收银台或商户后台调用支付宝接口，生成二维码后，展示给用户，由用户扫描二维码完成资金冻结。", "operationId" : "alipay.fund.auth.order.voucher.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAuthOrderVoucherCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundAuthOrderVoucherCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundAuthOrderVoucherCreateModel" } } }, "required" : false } } }, "/v3/alipay/fund/enterprisepay/group/add" : { "post" : { "tags" : [ "alipay.fund.enterprisepay.group" ], "summary" : "因公付新增账户下群组", "description" : "创建因公付群组，包含群组信息和出资信息", "operationId" : "alipay.fund.enterprisepay.group.add", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundEnterprisepayGroupAddResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundEnterprisepayGroupAddErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundEnterprisepayGroupAddModel" } } }, "required" : false } } }, "/v3/alipay/fund/enterprisepay/group/delete" : { "delete" : { "tags" : [ "alipay.fund.enterprisepay.group" ], "summary" : "因公付删除账户下群组", "description" : "因公付删除账户下群组", "operationId" : "alipay.fund.enterprisepay.group.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundEnterprisepayGroupDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundEnterprisepayGroupDeleteErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "product_code", "in" : "query", "description" : "产品码，默认值\tENTERPRISE_PAY", "schema" : { "type" : "string", "example" : "ENTERPRISE_PAY" } }, { "name" : "biz_scene", "in" : "query", "description" : "场景码，联系支付宝分配", "schema" : { "type" : "string", "example" : "ANT_GROUP" } }, { "name" : "account_id", "in" : "query", "description" : "企业签约账户ID", "schema" : { "type" : "string", "example" : "2088888888" } }, { "name" : "agreement_no", "in" : "query", "description" : "平台和企业的三方授权协议号", "schema" : { "type" : "string", "example" : "1231231321323" } }, { "name" : "out_biz_no", "in" : "query", "description" : "外部业务号", "schema" : { "type" : "string", "example" : "12123123" } } ] } }, "/v3/alipay/fund/enterprisepay/group/modify" : { "post" : { "tags" : [ "alipay.fund.enterprisepay.group" ], "summary" : "因公付更新账户下群组", "description" : "因公付更新账户下群组", "operationId" : "alipay.fund.enterprisepay.group.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundEnterprisepayGroupModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundEnterprisepayGroupModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundEnterprisepayGroupModifyModel" } } }, "required" : false } } }, "/v3/alipay/fund/enterprisepay/group/query" : { "get" : { "tags" : [ "alipay.fund.enterprisepay.group" ], "summary" : "因公付查询账户下群组", "description" : "查询因公付群组，包含群组信息和对应的出资主体", "operationId" : "alipay.fund.enterprisepay.group.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundEnterprisepayGroupQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundEnterprisepayGroupQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "product_code", "in" : "query", "description" : "产品码，默认值 ENTERPRISE_PAY", "schema" : { "type" : "string", "example" : "ENTERPRISE_PAY" } }, { "name" : "biz_scene", "in" : "query", "description" : "场景码，联系支付宝分配", "schema" : { "type" : "string", "example" : "ANT_GROUP" } }, { "name" : "account_id", "in" : "query", "description" : "企业签约账户ID", "schema" : { "type" : "string", "example" : "2088888888" } }, { "name" : "agreement_no", "in" : "query", "description" : "平台和企业的三方授权协议号", "schema" : { "type" : "string", "example" : "1231231321323" } }, { "name" : "out_biz_no", "in" : "query", "description" : "外部业务号，外部群组号", "schema" : { "type" : "string", "example" : "12312313" } } ] } }, "/v3/alipay/fund/enterprisepay/member/modify" : { "post" : { "tags" : [ "alipay.fund.enterprisepay.member" ], "summary" : "因公付更新员工资金协议", "description" : "因公付更新员工资金协议", "operationId" : "alipay.fund.enterprisepay.member.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundEnterprisepayMemberModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundEnterprisepayMemberModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundEnterprisepayMemberModifyModel" } } }, "required" : false } } }, "/v3/alipay/fund/enterprisepay/sign" : { "post" : { "tags" : [ "alipay.fund.enterprisepay" ], "summary" : "因公付企业签约", "description" : "用于获取因公付企业签约链接", "operationId" : "alipay.fund.enterprisepay.sign", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundEnterprisepaySignResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundEnterprisepaySignErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundEnterprisepaySignModel" } } }, "required" : false } } }, "/v3/alipay/fund/enterprisepay/unsign" : { "post" : { "tags" : [ "alipay.fund.enterprisepay" ], "summary" : "因公付企业解约", "description" : "用于因公付企业解约时获取解约链接", "operationId" : "alipay.fund.enterprisepay.unsign", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundEnterprisepayUnsignResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundEnterprisepayUnsignErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundEnterprisepayUnsignModel" } } }, "required" : false } } }, "/v3/alipay/fund/jointaccount/bill/query" : { "get" : { "tags" : [ "alipay.fund.jointaccount.bill" ], "summary" : "因公付账单查询", "description" : "因公付账单查询", "operationId" : "alipay.fund.jointaccount.bill.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundJointaccountBillQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundJointaccountBillQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "product_code", "in" : "query", "description" : "因公付产品码", "schema" : { "type" : "string", "example" : "ENTERPRISE_PAY" } }, { "name" : "biz_scene", "in" : "query", "description" : "业务场景", "schema" : { "type" : "string", "example" : "DEFAULT" } }, { "name" : "account_id", "in" : "query", "description" : "账户ID", "schema" : { "type" : "string", "example" : "2088900976746215" } }, { "name" : "page_num", "in" : "query", "description" : "采用分页查询，本参数为空或0默认显示第一页。如果输入的值大于总页数，则支付宝返回最后一页数据", "schema" : { "type" : "string", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "每页大小，不传的情况下默认20条，超过20条默认按20条查询；不足20条则按实际记录数返回", "schema" : { "type" : "string", "example" : "1" } }, { "name" : "user_id", "in" : "query", "description" : "员工ID", "schema" : { "type" : "string", "example" : "2088900976746215" } }, { "name" : "open_id", "in" : "query", "description" : "员工的openId", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } }, { "name" : "start_date", "in" : "query", "description" : "起始日期", "schema" : { "type" : "string", "example" : "yyyy-MM-dd" } }, { "name" : "end_date", "in" : "query", "description" : "截止日期", "schema" : { "type" : "string", "example" : "yyyy-MM-dd" } }, { "name" : "agreement_no", "in" : "query", "description" : "授权协议号", "schema" : { "type" : "string", "example" : "2088900976746215123123" } } ] } }, "/v3/alipay/fund/jointaccount/detail/query" : { "get" : { "tags" : [ "alipay.fund.jointaccount.detail" ], "summary" : "共享资金-查询账户详情", "description" : "发起人在商户上点击查看账户详情，商户服务端进行受理，并调用支付宝进行处理。处理结果，同步返回给商户。", "operationId" : "alipay.fund.jointaccount.detail.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundJointaccountDetailQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundJointaccountDetailQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "product_code", "in" : "query", "description" : "销售产品码", "schema" : { "type" : "string", "example" : "ENTERPRISE_PAY" } }, { "name" : "biz_scene", "in" : "query", "description" : "业务场景码", "schema" : { "type" : "string", "example" : "DEFAULT" } }, { "name" : "account_id", "in" : "query", "description" : "合花群ID（查询方式二：通过传入account_id+agreement_no查询）
\t补充说明：
\t-该字段可在签约接口alipay.fund.jointaccount.sign调用后，由账户变更结果通知接口alipay.fund.jointaccount.account.completed中返回。
\t-该字段可在签约接口调用后，由查询账户详情接口alipay.fund.jointaccount.detail.query中返回。", "schema" : { "type" : "string", "example" : "2088xxx" } }, { "name" : "agreement_no", "in" : "query", "description" : "授权协议号（查询方式二：通过传入account_id+agreement_no查询）
\t补充说明：
\t-该字段可在签约接口alipay.fund.jointaccount.sign调用后，由账户变更结果通知接口alipay.fund.jointaccount.account.completed中返回。
\t-该字段可在签约接口调用后，由查询账户详情接口alipay.fund.jointaccount.detail.query中返回。", "schema" : { "type" : "string", "example" : "2088xxx" } }, { "name" : "out_biz_no", "in" : "query", "description" : "商户侧单号（查询方式一：通过传入\tout_biz_no查询）
\t补充说明：
\t-该字段与签约接口alipay.fund.jointaccount.sign请求参数中传入值保持一致", "schema" : { "type" : "string", "example" : "无" } }, { "name" : "channel", "in" : "query", "description" : "业务渠道
\t补充说明：
\t需要商户侧必传，支付宝侧不做强校验", "schema" : { "type" : "string", "example" : "MMJZ" } } ] } }, "/v3/alipay/fund/jointaccount/list/query" : { "get" : { "tags" : [ "alipay.fund.jointaccount.list" ], "summary" : "企业查询代付账户列表", "description" : "企业查询代付账户列表", "operationId" : "alipay.fund.jointaccount.list.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundJointaccountListQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundJointaccountListQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "product_code", "in" : "query", "description" : "产品码", "schema" : { "type" : "string", "example" : "ENTERPRISE_PAY" } }, { "name" : "biz_scene", "in" : "query", "description" : "业务场景", "schema" : { "type" : "string", "example" : "DEFAULT" } }, { "name" : "operate_role", "in" : "query", "description" : "角色：创建方(CREATOR)、参与方(PARTICIPANT)", "schema" : { "type" : "string", "example" : "CREATOR" } }, { "name" : "agreement_no", "in" : "query", "description" : "授权协议号", "schema" : { "type" : "string", "example" : "208890097674621512231" } }, { "name" : "identity", "in" : "query", "description" : "员工账号：\t\tidentity_type是ALIPAY_USER_ID填支付宝会员ID（2088开头）；\t\t是ALIPAY_LOGON_ID 填支付宝登录号", "schema" : { "type" : "string", "example" : "name@email.com" } }, { "name" : "identity_type", "in" : "query", "description" : "账号类型，目前支持如下类型： 1、ALIPAY_USER_ID 支付宝的会员ID 2、ALIPAY_LOGON_ID：支付宝登录号，支持邮箱和手机号格式", "schema" : { "type" : "string", "example" : "ALIPAY_LOGON_ID" } } ] } }, "/v3/alipay/fund/jointaccount/member/batchquery" : { "post" : { "tags" : [ "alipay.fund.jointaccount.member" ], "summary" : "企业批量查询员工信息（分页）", "description" : "企业查询员工列表，支持分页，支持按登录号精确查询，支持按会员号精确查询", "operationId" : "alipay.fund.jointaccount.member.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundJointaccountMemberBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundJointaccountMemberBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundJointaccountMemberBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/fund/jointaccount/member/bind" : { "post" : { "tags" : [ "alipay.fund.jointaccount.member" ], "summary" : "因公付邀请员工", "description" : "因公付邀请员工", "operationId" : "alipay.fund.jointaccount.member.bind", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundJointaccountMemberBindResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundJointaccountMemberBindErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundJointaccountMemberBindModel" } } }, "required" : false } } }, "/v3/alipay/fund/jointaccount/member/consult" : { "post" : { "tags" : [ "alipay.fund.jointaccount.member" ], "summary" : "员企关系咨询", "description" : "返回输入的员工列表是否在指定企业组织中", "operationId" : "alipay.fund.jointaccount.member.consult", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundJointaccountMemberConsultResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundJointaccountMemberConsultErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundJointaccountMemberConsultModel" } } }, "required" : false } } }, "/v3/alipay/fund/jointaccount/member/query" : { "get" : { "tags" : [ "alipay.fund.jointaccount.member" ], "summary" : "企业查询员工列表", "description" : "企业查询员工列表", "operationId" : "alipay.fund.jointaccount.member.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundJointaccountMemberQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundJointaccountMemberQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "product_code", "in" : "query", "description" : "产品码", "schema" : { "type" : "string", "example" : "ENTERPRISE_PAY" } }, { "name" : "biz_scene", "in" : "query", "description" : "业务场景", "schema" : { "type" : "string", "example" : "DEFAULT" } }, { "name" : "account_id", "in" : "query", "description" : "账户ID", "schema" : { "type" : "string", "example" : "2088900976746215" } }, { "name" : "page_num", "in" : "query", "description" : "采用分页查询，本参数为空或0默认显示第一页。如果输入的值大于总页数，则支付宝返回最后一页数据。", "schema" : { "type" : "string", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "每页大小，不传的情况下默认20条，超过20条默认按20条查询；不足20条则按实际记录数返回", "schema" : { "type" : "string", "example" : "1" } }, { "name" : "user_id", "in" : "query", "description" : "员工id", "schema" : { "type" : "string", "example" : "2088900976746215" } }, { "name" : "open_id", "in" : "query", "description" : "员工的openId", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } }, { "name" : "agreement_no", "in" : "query", "description" : "授权协议号", "schema" : { "type" : "string", "example" : "20889009767462151111111" } } ] } }, "/v3/alipay/fund/jointaccount/member/unbind" : { "post" : { "tags" : [ "alipay.fund.jointaccount.member" ], "summary" : "企业删除员工", "description" : "企业删除员工", "operationId" : "alipay.fund.jointaccount.member.unbind", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundJointaccountMemberUnbindResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundJointaccountMemberUnbindErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundJointaccountMemberUnbindModel" } } }, "required" : false } } }, "/v3/alipay/fund/jointaccount/memberrule/modify" : { "post" : { "tags" : [ "alipay.fund.jointaccount.memberrule" ], "summary" : "企业设置员工规则", "description" : "企业设置员工规则", "operationId" : "alipay.fund.jointaccount.memberrule.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundJointaccountMemberruleModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundJointaccountMemberruleModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundJointaccountMemberruleModifyModel" } } }, "required" : false } } }, "/v3/alipay/fund/jointaccount/quota/query" : { "get" : { "tags" : [ "alipay.fund.jointaccount.quota" ], "summary" : "查询账户额度详情", "description" : "查询账户额度详情", "operationId" : "alipay.fund.jointaccount.quota.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundJointaccountQuotaQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundJointaccountQuotaQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "product_code", "in" : "query", "description" : "产品码", "schema" : { "type" : "string", "example" : "ENTERPRISE_PAY" } }, { "name" : "biz_scene", "in" : "query", "description" : "业务场景", "schema" : { "type" : "string", "example" : "DEFAULT" } }, { "name" : "account_id", "in" : "query", "description" : "账户ID", "schema" : { "type" : "string", "example" : "2088900976746215" } }, { "name" : "member_id", "in" : "query", "description" : "员工ID", "schema" : { "type" : "string", "example" : "2088900976746215" } }, { "name" : "member_open_id", "in" : "query", "description" : "员工的openid", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } }, { "name" : "operate_role", "in" : "query", "description" : "角色：创建方(CREATOR)、参与方(PARTICIPANT)", "schema" : { "type" : "string", "example" : "CREATOR" } }, { "name" : "agreement_no", "in" : "query", "description" : "授权协议号", "schema" : { "type" : "string", "example" : "208890097674621512312" } } ] } }, "/v3/alipay/fund/jointaccount/rule/modify" : { "post" : { "tags" : [ "alipay.fund.jointaccount.rule" ], "summary" : "企业账户规则设置", "description" : "企业账户规则设置", "operationId" : "alipay.fund.jointaccount.rule.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundJointaccountRuleModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundJointaccountRuleModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundJointaccountRuleModifyModel" } } }, "required" : false } } }, "/v3/alipay/fund/jointaccount/sign/query" : { "get" : { "tags" : [ "alipay.fund.jointaccount.sign" ], "summary" : "企业签约结果查询", "description" : "通过外部订单号（out_biz_no）主动查询企业签约结果，可用于未收到签约结果通知的补偿操作", "operationId" : "alipay.fund.jointaccount.sign.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundJointaccountSignQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundJointaccountSignQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "product_code", "in" : "query", "description" : "产品码，默认值\tENTERPRISE_PAY", "schema" : { "type" : "string", "example" : "ENTERPRISE_PAY" } }, { "name" : "biz_scene", "in" : "query", "description" : "场景码，联系支付宝分配", "schema" : { "type" : "string", "example" : "ISV_ALIYUN" } }, { "name" : "out_biz_no", "in" : "query", "description" : "外部业务号，查询对应账户状态，优先级高于account_id", "schema" : { "type" : "string", "example" : "123123132" } }, { "name" : "account_id", "in" : "query", "description" : "企业签约账户ID,用于外部商户已获取企业签约ID，查询账户状态", "schema" : { "type" : "string", "example" : "208812312313213" } } ] } }, "/v3/alipay/fund/jointaccount/trade/query" : { "get" : { "tags" : [ "alipay.fund.jointaccount.trade" ], "summary" : "共同账户交易查询", "description" : "共同账户交易查询", "operationId" : "alipay.fund.jointaccount.trade.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundJointaccountTradeQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundJointaccountTradeQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "product_code", "in" : "query", "description" : "销售产品码", "schema" : { "type" : "string", "example" : "ENTERPRISE_PAY" } }, { "name" : "biz_scene", "in" : "query", "description" : "业务场景", "schema" : { "type" : "string", "example" : "ELE_ONLINE" } }, { "name" : "member_id", "in" : "query", "description" : "成员ID，消费发起人", "schema" : { "type" : "string", "example" : "208811123123" } }, { "name" : "member_open_id", "in" : "query", "description" : "消费发起人的openId", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } }, { "name" : "account_id", "in" : "query", "description" : "企业账户ID", "schema" : { "type" : "string", "example" : "208811123123" } }, { "name" : "agreement_no", "in" : "query", "description" : "三方授权协议号", "schema" : { "type" : "string", "example" : "12312312313123" } }, { "name" : "trade_no", "in" : "query", "description" : "支付宝交易订单号", "schema" : { "type" : "string", "example" : "12312313123" } }, { "name" : "platform_order_id", "in" : "query", "description" : "外部平台订单号。使用该参数查询时，返回结果见trade_info_list", "schema" : { "type" : "string", "example" : "781773393333012410369282" } } ] } }, "/v3/alipay/fund/trans/common/query" : { "get" : { "tags" : [ "alipay.fund.trans.common" ], "summary" : "转账业务单据查询接口", "description" : "商户可通过该接口查询转账业务单据的状态，主要应用于统一转账接口(alipay.fund.trans.uni.transfer)、无线转账接口(alipay.fund.trans.app.pay)、单笔转账到支付宝账户接口（alipay.fund.trans.toaccount.transfer）", "operationId" : "alipay.fund.trans.common.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundTransCommonQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundTransCommonQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "product_code", "in" : "query", "description" : "销售产品码，商家和支付宝签约的产品码，如果传递了out_biz_no则该字段为必传。可传值如下：\tSTD_RED_PACKET：现金红包\tTRANS_ACCOUNT_NO_PWD：单笔无密转账到支付宝账户\tTRANS_BANKCARD_NO_PWD：单笔无密转账到银行卡", "schema" : { "type" : "string", "example" : "STD_RED_PACKET" } }, { "name" : "biz_scene", "in" : "query", "description" : "描述特定的业务场景，如果传递了out_biz_no则该字段为必传。可取的业务场景如下：\r\tPERSONAL_PAY：C2C现金红包-发红包；\r\tPERSONAL_COLLECTION：C2C现金红包-领红包；\r\tREFUND：C2C现金红包-红包退回；\r\tDIRECT_TRANSFER：B2C现金红包、单笔无密转账", "schema" : { "type" : "string", "example" : "PERSONAL_PAY" } }, { "name" : "out_biz_no", "in" : "query", "description" : "商户转账唯一订单号，发起转账来源方定义的转账单据ID。 \t本参数和order_id（支付宝转账单据号）、pay_fund_order_id（支付宝支付资金流水号）三者不能同时为空。\t当三者同时传入时，将用pay_fund_order_id（支付宝支付资金流水号）进行查询，忽略其余两者；\t当本参数和支付宝转账单据号同时提供时，将用支付宝转账单据号进行查询，忽略本参数。", "schema" : { "type" : "string", "example" : "201808080001" } }, { "name" : "order_id", "in" : "query", "description" : "支付宝转账单据号。 本参数和out_biz_no（商户转账唯一订单号）、pay_fund_order_id（支付宝支付资金流水号）三者不能同时为空。 \t当三者同时传入时，将用pay_fund_order_id（支付宝支付资金流水号）进行查询，忽略其余两者；\t当本参数和pay_fund_order_id（支付宝支付资金流水号）同时提供时，将用支付宝支付资金流水号进行查询，忽略本参数； \t当本参数和out_biz_no（商户转账唯一订单号）同时提供时，将用本参数进行查询，忽略商户转账唯一订单号。", "schema" : { "type" : "string", "example" : "20190801110070000006380000250621" } }, { "name" : "pay_fund_order_id", "in" : "query", "description" : "支付宝支付资金流水号。本参数和支付宝转账单据号、商户转账唯一订单号三者不能同时为空。 \t当本参数和out_biz_no（商户转账唯一订单号）、order_id（支付宝转账单据号）同时提供时，将用本参数进行查询，忽略其余两者；\t当本参数和order_id（支付宝转账单据号）同时提供时，将用本参数进行查询，忽略支付宝转账单据号； \t当本参数和out_biz_no（商户转账唯一订单号）同时提供时，将用本参数进行查询，忽略商户转账唯一订单号。", "schema" : { "type" : "string", "example" : "20190801110070001506380000251556" } } ] } }, "/v3/alipay/fund/trans/order/query" : { "get" : { "tags" : [ "alipay.fund.trans.order" ], "summary" : "查询转账订单接口", "description" : "商户可通过该接口查询转账订单的状态、支付时间等相关信息，主要应用于B2C转账订单查询的场景", "operationId" : "alipay.fund.trans.order.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundTransOrderQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundTransOrderQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "out_biz_no", "in" : "query", "description" : "商户转账唯一订单号：发起转账来源方定义的转账单据ID。\r\t和支付宝转账单据号不能同时为空。当和支付宝转账单据号同时提供时，将用支付宝转账单据号进行查询，忽略本参数。", "schema" : { "type" : "string", "example" : "3142321423432" } }, { "name" : "order_id", "in" : "query", "description" : "支付宝转账单据号：和商户转账唯一订单号不能同时为空。当和商户转账唯一订单号同时提供时，将用本参数进行查询，忽略商户转账唯一订单号。", "schema" : { "type" : "string", "example" : "20160627110070001502260006780837" } } ] } }, "/v3/alipay/fund/trans/pay" : { "post" : { "tags" : [ "alipay.fund.trans" ], "summary" : "资金支付接口", "description" : "付款方通过协议、二维码、声波、人脸等方式，通过本接口提交给支付宝直接完成支付。", "operationId" : "alipay.fund.trans.pay", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundTransPayResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundTransPayErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundTransPayModel" } } }, "required" : false } } }, "/v3/alipay/fund/trans/payee/bind/query" : { "get" : { "tags" : [ "alipay.fund.trans.payee.bind" ], "summary" : "资金收款账号绑定关系查询", "description" : "资金收款账号绑定关系查询", "operationId" : "alipay.fund.trans.payee.bind.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundTransPayeeBindQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundTransPayeeBindQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "identity", "in" : "query", "description" : "证件号", "schema" : { "type" : "string", "example" : "230100199901010001" } }, { "name" : "identity_type", "in" : "query", "description" : "证件类型,暂仅支持 IDENTITY_CARD （身份证）", "schema" : { "type" : "string", "example" : "IDENTITY_CARD" } } ] } }, "/v3/alipay/fund/trans/refund" : { "post" : { "tags" : [ "alipay.fund.trans" ], "summary" : "资金退回接口", "description" : "当资金支付一段时间后，由于收款方一直没有收钱（比如抢红包），可以通过退款接口将资金退换给付款方。支付宝将会按照退款规则将支付款按原路退到付款方帐号上。 \r\n交易超过约定时间（签约时设置的可退款时间）的订单无法进行退款。支付宝退款支持单笔交易分多次退回，多次退款需要提交原支付订单的商户订单号和设置不同的退款单号。一笔退款失败后重新提交，要采用原来的退款单号。总退款金额不能超过（用户实际支付金额-已领红包）的金额。", "operationId" : "alipay.fund.trans.refund", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundTransRefundResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundTransRefundErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundTransRefundModel" } } }, "required" : false } } }, "/v3/alipay/fund/trans/toaccount/transfer" : { "post" : { "tags" : [ "alipay.fund.trans.toaccount" ], "summary" : "单笔转账到支付宝账户接口", "description" : "单笔转账到支付宝账户接口是基于支付宝的资金处理能力，为了满足支付宝商家向其他支付宝账户转账的需求，针对有部分开发能力的商家，提供通过API接口完成支付宝账户间的转账的功能。\n该接口适用行业较广，比如商家间的货款结算，商家给个人用户发放佣金等。（目前已对该接口能力做了升级，后续建议调用新接口alipay.fund.trans.uni.transfer）", "operationId" : "alipay.fund.trans.toaccount.transfer", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundTransToaccountTransferResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundTransToaccountTransferErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundTransToaccountTransferModel" } } }, "required" : false } } }, "/v3/alipay/fund/trans/uni/transfer" : { "post" : { "tags" : [ "alipay.fund.trans.uni" ], "summary" : "单笔转账接口", "description" : "单笔转账接口是基于支付宝的资金处理能力，为了满足支付宝商家的转账需求，针对有部分开发能力的商家，提供通过API接口完成企业自身支付宝账户到支付宝账户的转账功能。 适用于：C2C现金红包的红包领取、B2C现金红包的红包发放、B2C单笔转账到支付宝账户等。
\n说明：本接口为公用接口，参数说明不针对特定产品。不同产品入参请参考对应产品文档。", "operationId" : "alipay.fund.trans.uni.transfer", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundTransUniTransferResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundTransUniTransferErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundTransUniTransferModel" } } }, "required" : false } } }, "/v3/alipay/fund/usertrade/batchquery" : { "post" : { "tags" : [ "alipay.fund.usertrade" ], "summary" : "用户交易数据查询", "description" : "资金团队会监听指定球房相关的用户交易数据，并且，在用户授权后，开放该接口给到外部调用，查询用户近期内的交易数据。", "operationId" : "alipay.fund.usertrade.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundUsertradeBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayFundUsertradeBatchqueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/AuthToken" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayFundUsertradeBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/agent/create" : { "post" : { "tags" : [ "alipay.iservice.ccm.agent" ], "summary" : "新增客服接口", "description" : "新增一个CCM客服", "operationId" : "alipay.iservice.ccm.agent.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmAgentCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmAgentCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmAgentCreateModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/agent/delete" : { "delete" : { "tags" : [ "alipay.iservice.ccm.agent" ], "summary" : "删除客服接口", "description" : "管理员删除一个客服", "operationId" : "alipay.iservice.ccm.agent.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmAgentDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmAgentDeleteErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "id", "in" : "query", "description" : "客服id", "schema" : { "type" : "string", "example" : "2019032101896769" } } ] } }, "/v3/alipay/iservice/ccm/agent/get" : { "get" : { "tags" : [ "alipay.iservice.ccm.agent" ], "summary" : "查询客服详情", "description" : "ISV或商户查询获取某个客服的详细信息", "operationId" : "alipay.iservice.ccm.agent.get", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmAgentGetResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmAgentGetErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "id", "in" : "query", "description" : "客服id", "schema" : { "type" : "string", "example" : "2018101801902073" } }, { "name" : "job_number", "in" : "query", "description" : "客服工号", "schema" : { "type" : "string", "example" : "0001" } }, { "name" : "user_channel", "in" : "query", "description" : "客服账号渠道, ALIPAY:支付宝账号\tuser_channel和external_user_id必须配对使用", "schema" : { "type" : "string", "example" : "ALIPAY" } }, { "name" : "external_user_id", "in" : "query", "description" : "客服账号id，当user_channel=ALIPAY时，此id为支付宝2088id\texternal_user_id和user_channel必须配对使用", "schema" : { "type" : "string", "example" : "2088xxx" } } ] } }, "/v3/alipay/iservice/ccm/agent/modify" : { "post" : { "tags" : [ "alipay.iservice.ccm.agent" ], "summary" : "更新客服接口", "description" : "管理员修改客服信息", "operationId" : "alipay.iservice.ccm.agent.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmAgentModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmAgentModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmAgentModifyModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/agent/query" : { "post" : { "tags" : [ "alipay.iservice.ccm.agent" ], "summary" : "客服查询接口", "description" : "根据指定的查询条件查询客服列表", "operationId" : "alipay.iservice.ccm.agent.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmAgentQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmAgentQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmAgentQueryModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/agent/schedulelog/query" : { "post" : { "tags" : [ "alipay.iservice.ccm.agent.schedulelog" ], "summary" : "查询客服状态变更流水日志", "description" : "ISV或商户批量查询获取客服状态变更流水日志详细信息", "operationId" : "alipay.iservice.ccm.agent.schedulelog.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmAgentSchedulelogQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmAgentSchedulelogQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmAgentSchedulelogQueryModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/function/query" : { "get" : { "tags" : [ "alipay.iservice.ccm.function" ], "summary" : "列出所有的功能点", "description" : "列出所有的功能点", "operationId" : "alipay.iservice.ccm.function.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmFunctionQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmFunctionQueryErrorResponseModel" } ] } } } } } } }, "/v3/alipay/iservice/ccm/instance/create" : { "post" : { "tags" : [ "alipay.iservice.ccm.instance" ], "summary" : "创建租户实例", "description" : "创建租户实例", "operationId" : "alipay.iservice.ccm.instance.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmInstanceCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmInstanceCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmInstanceCreateModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/instance/get" : { "get" : { "tags" : [ "alipay.iservice.ccm.instance" ], "summary" : "查询单个租户实例（数据权限）", "description" : "查询单个租户实例（数据权限）", "operationId" : "alipay.iservice.ccm.instance.get", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmInstanceGetResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmInstanceGetErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "id", "in" : "query", "description" : "部门id（即租户实例ID、数据权限ID）", "schema" : { "type" : "string", "example" : "pYv_gs0m" } }, { "name" : "external_id", "in" : "query", "description" : "外部id", "schema" : { "type" : "string", "example" : "5544744" } } ] } }, "/v3/alipay/iservice/ccm/instance/query" : { "get" : { "tags" : [ "alipay.iservice.ccm.instance" ], "summary" : "列出所有的租户实例（数据权限）", "description" : "列出所有的租户实例（数据权限）。一个云客服租户下可以有多个租户实例（数据权限），每个租户实例之间的数据是隔离的（除了用户、权限、私信、IVR数据外）。", "operationId" : "alipay.iservice.ccm.instance.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmInstanceQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmInstanceQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "page_num", "in" : "query", "description" : "查询结果的页码，起始值为 1，默认值为 1", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "分页查询时设置的每页记录数，最大值 100 行，默认为 10", "schema" : { "type" : "integer", "example" : "10" } } ] } }, "/v3/alipay/iservice/ccm/isv/initialize" : { "post" : { "tags" : [ "alipay.iservice.ccm.isv" ], "summary" : "ccm isv注册接口", "description" : "商家 / ISV 开发的插件接入CCM（蚂蚁客户沟通管理平台）之前，需要先将自己的信息注册到 CCM，并设置一个用于 iframe 接口接入安全认证使用的公钥。", "operationId" : "alipay.iservice.ccm.isv.initialize", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmIsvInitializeResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmIsvInitializeErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmIsvInitializeModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/ols/chatrecord/query" : { "get" : { "tags" : [ "alipay.iservice.ccm.ols.chatrecord" ], "summary" : "查询某通在线服务的聊天记录", "description" : "ISV或商户根据在线服务记录id查询该通对话的聊天记录及相关信息", "operationId" : "alipay.iservice.ccm.ols.chatrecord.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmOlsChatrecordQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmOlsChatrecordQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "ccs_instance_id", "in" : "query", "description" : "租户实例id（数据权限id），不填，则使用默认的租户实例id", "schema" : { "type" : "string", "example" : "ZPSDWACN" } }, { "name" : "id", "in" : "query", "description" : "在线服务记录id", "schema" : { "type" : "string", "example" : "201909021113010100000001922200" } } ] } }, "/v3/alipay/iservice/ccm/robot/avatarbase/query" : { "post" : { "tags" : [ "alipay.iservice.ccm.robot.avatarbase" ], "summary" : "虚拟数字人开放接口调用", "description" : "用于与数字人交互", "operationId" : "alipay.iservice.ccm.robot.avatarbase.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmRobotAvatarbaseQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmRobotAvatarbaseQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmRobotAvatarbaseQueryModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/role/create" : { "post" : { "tags" : [ "alipay.iservice.ccm.role" ], "summary" : "创建角色", "description" : "创建角色", "operationId" : "alipay.iservice.ccm.role.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmRoleCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmRoleCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmRoleCreateModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/role/delete" : { "delete" : { "tags" : [ "alipay.iservice.ccm.role" ], "summary" : "删除角色", "description" : "删除角色", "operationId" : "alipay.iservice.ccm.role.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmRoleDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmRoleDeleteErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "id", "in" : "query", "description" : "角色id", "schema" : { "type" : "string", "example" : "123" } }, { "name" : "ccs_instance_id", "in" : "query", "description" : "部门id（即租户实例ID、数据权限ID），如果不传入，使用租户id", "schema" : { "type" : "string", "example" : "ksj_J2Qa" } } ] } }, "/v3/alipay/iservice/ccm/role/get" : { "get" : { "tags" : [ "alipay.iservice.ccm.role" ], "summary" : "获取角色详情", "description" : "获取角色详情", "operationId" : "alipay.iservice.ccm.role.get", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmRoleGetResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmRoleGetErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "id", "in" : "query", "description" : "角色id", "schema" : { "type" : "string", "example" : "123" } }, { "name" : "ccs_instance_id", "in" : "query", "description" : "部门id，不传默认用租户ID", "schema" : { "type" : "string", "example" : "qi1_FAq1" } } ] } }, "/v3/alipay/iservice/ccm/role/modify" : { "post" : { "tags" : [ "alipay.iservice.ccm.role" ], "summary" : "更新角色", "description" : "更新角色", "operationId" : "alipay.iservice.ccm.role.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmRoleModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmRoleModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmRoleModifyModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/role/page/query" : { "get" : { "tags" : [ "alipay.iservice.ccm.role.page" ], "summary" : "分页查询角色", "description" : "分页查询角色", "operationId" : "alipay.iservice.ccm.role.page.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmRolePageQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmRolePageQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "name", "in" : "query", "description" : "角色名称", "schema" : { "type" : "string", "example" : "普通客服" } }, { "name" : "page_num", "in" : "query", "description" : "查询结果的页码，起始值为 1，默认值为 1", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "分页查询时设置的每页记录数，最大值 100 行，默认为 10", "schema" : { "type" : "integer", "example" : "10" } }, { "name" : "ccs_instance_id", "in" : "query", "description" : "部门id（即租户实例ID、数据权限ID）", "schema" : { "type" : "string", "example" : "kaj_9DA1" } } ] } }, "/v3/alipay/iservice/ccm/service/buy" : { "post" : { "tags" : [ "alipay.iservice.ccm.service" ], "summary" : "租户开通isv服务接口", "description" : "租户购买了isv服务后，通知ccm开通服务", "operationId" : "alipay.iservice.ccm.service.buy", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmServiceBuyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmServiceBuyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmServiceBuyModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/service/close" : { "post" : { "tags" : [ "alipay.iservice.ccm.service" ], "summary" : "关闭租户开通的isv服务接口", "description" : "租户购买的ISV服务到期后，isv通知ccm关闭服务", "operationId" : "alipay.iservice.ccm.service.close", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmServiceCloseResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmServiceCloseErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmServiceCloseModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/service/initialize" : { "post" : { "tags" : [ "alipay.iservice.ccm.service" ], "summary" : "isv服务初始化接口", "description" : "ISV调用此接口对接入CCM的服务代码、名称、描述等信息做初始化", "operationId" : "alipay.iservice.ccm.service.initialize", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmServiceInitializeResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmServiceInitializeErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmServiceInitializeModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/servicerecord/create" : { "post" : { "tags" : [ "alipay.iservice.ccm.servicerecord" ], "summary" : "创建服务记录", "description" : "提供给云客服租户自主创建服务记录", "operationId" : "alipay.iservice.ccm.servicerecord.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmServicerecordCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmServicerecordCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmServicerecordCreateModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/servicerecord/modify" : { "post" : { "tags" : [ "alipay.iservice.ccm.servicerecord" ], "summary" : "变更服务记录", "description" : "提供给云客服租户自主变更服务记录", "operationId" : "alipay.iservice.ccm.servicerecord.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmServicerecordModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmServicerecordModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmServicerecordModifyModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/sw/article/batchquery" : { "post" : { "tags" : [ "alipay.iservice.ccm.sw.article" ], "summary" : "知识库-问答-批量查询", "description" : "知识库-问答-批量查询", "operationId" : "alipay.iservice.ccm.sw.article.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwArticleBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmSwArticleBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwArticleBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/sw/article/create" : { "put" : { "tags" : [ "alipay.iservice.ccm.sw.article" ], "summary" : "知识库-问答-创建", "description" : "知识库-问答-创建", "operationId" : "alipay.iservice.ccm.sw.article.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwArticleCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmSwArticleCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwArticleCreateModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/sw/article/delete" : { "delete" : { "tags" : [ "alipay.iservice.ccm.sw.article" ], "summary" : "知识库-问答-删除", "description" : "知识库-问答-删除", "operationId" : "alipay.iservice.ccm.sw.article.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwArticleDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmSwArticleDeleteErrorResponseModel" } ] } } } } } } }, "/v3/alipay/iservice/ccm/sw/article/get" : { "get" : { "tags" : [ "alipay.iservice.ccm.sw.article" ], "summary" : "知识库-问答-获取", "description" : "知识库-问答-获取", "operationId" : "alipay.iservice.ccm.sw.article.get", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwArticleGetResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmSwArticleGetErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "ccs_instance_id", "in" : "query", "description" : "子部门ID，不传为默认部门", "schema" : { "type" : "string", "example" : "ZPNASDK" } }, { "name" : "id", "in" : "query", "description" : "文章ID", "schema" : { "type" : "integer", "example" : "1" } } ] } }, "/v3/alipay/iservice/ccm/sw/article/modify" : { "patch" : { "tags" : [ "alipay.iservice.ccm.sw.article" ], "summary" : "知识库-问答-修改", "description" : "知识库-问答-修改", "operationId" : "alipay.iservice.ccm.sw.article.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwArticleModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmSwArticleModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwArticleModifyModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/sw/knowledge/modify" : { "post" : { "tags" : [ "alipay.iservice.ccm.sw.knowledge" ], "summary" : "知识库问答管理", "description" : "知识库问答管理", "operationId" : "alipay.iservice.ccm.sw.knowledge.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwKnowledgeModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmSwKnowledgeModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwKnowledgeModifyModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/sw/library/batchquery" : { "get" : { "tags" : [ "alipay.iservice.ccm.sw.library" ], "summary" : "知识库-库-批量查询", "description" : "知识库-库-批量查询", "operationId" : "alipay.iservice.ccm.sw.library.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwLibraryBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmSwLibraryBatchqueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "ccs_instance_id", "in" : "query", "description" : "子部门ID，不传为默认部门", "schema" : { "type" : "string", "example" : "ZPNASDK" } } ] } }, "/v3/alipay/iservice/ccm/sw/library/create" : { "put" : { "tags" : [ "alipay.iservice.ccm.sw.library" ], "summary" : "知识库-库-创建", "description" : "知识库-库-创建", "operationId" : "alipay.iservice.ccm.sw.library.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwLibraryCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmSwLibraryCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwLibraryCreateModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/sw/library/delete" : { "delete" : { "tags" : [ "alipay.iservice.ccm.sw.library" ], "summary" : "知识库-库-删除", "description" : "知识库-库-删除", "operationId" : "alipay.iservice.ccm.sw.library.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwLibraryDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmSwLibraryDeleteErrorResponseModel" } ] } } } } } } }, "/v3/alipay/iservice/ccm/sw/library/modify" : { "patch" : { "tags" : [ "alipay.iservice.ccm.sw.library" ], "summary" : "知识库-库-修改", "description" : "知识库-库-修改", "operationId" : "alipay.iservice.ccm.sw.library.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwLibraryModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmSwLibraryModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwLibraryModifyModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/sw/order/sync" : { "post" : { "tags" : [ "alipay.iservice.ccm.sw.order" ], "summary" : "商品订单同步", "description" : "商品订单同步", "operationId" : "alipay.iservice.ccm.sw.order.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwOrderSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmSwOrderSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwOrderSyncModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/sw/spu/sync" : { "post" : { "tags" : [ "alipay.iservice.ccm.sw.spu" ], "summary" : "商品库-商品信息同步", "description" : "商品库-商品信息同步", "operationId" : "alipay.iservice.ccm.sw.spu.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwSpuSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmSwSpuSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwSpuSyncModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/sw/tree/batchquery" : { "get" : { "tags" : [ "alipay.iservice.ccm.sw.tree" ], "summary" : "知识库-类目-批量查询", "description" : "知识库-类目-批量查询", "operationId" : "alipay.iservice.ccm.sw.tree.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreeBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreeBatchqueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "ccs_instance_id", "in" : "query", "description" : "子部门ID，不传为默认部门", "schema" : { "type" : "string", "example" : "ZPNASDK" } } ] } }, "/v3/alipay/iservice/ccm/sw/tree/create" : { "put" : { "tags" : [ "alipay.iservice.ccm.sw.tree" ], "summary" : "知识库-类目-创建", "description" : "知识库-类目-创建", "operationId" : "alipay.iservice.ccm.sw.tree.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreeCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreeCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreeCreateModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/sw/tree/delete" : { "delete" : { "tags" : [ "alipay.iservice.ccm.sw.tree" ], "summary" : "知识库-类目-删除", "description" : "知识库-类目-删除", "operationId" : "alipay.iservice.ccm.sw.tree.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreeDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreeDeleteErrorResponseModel" } ] } } } } } } }, "/v3/alipay/iservice/ccm/sw/tree/get" : { "get" : { "tags" : [ "alipay.iservice.ccm.sw.tree" ], "summary" : "知识库-类目-获取", "description" : "知识库-类目-获取", "operationId" : "alipay.iservice.ccm.sw.tree.get", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreeGetResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreeGetErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "ccs_instance_id", "in" : "query", "description" : "子部门ID，不传为默认部门", "schema" : { "type" : "string", "example" : "ZPNASDK" } }, { "name" : "id", "in" : "query", "description" : "类目ID", "schema" : { "type" : "integer", "example" : "1" } } ] } }, "/v3/alipay/iservice/ccm/sw/tree/modify" : { "patch" : { "tags" : [ "alipay.iservice.ccm.sw.tree" ], "summary" : "知识库-类目-修改", "description" : "知识库-类目-修改", "operationId" : "alipay.iservice.ccm.sw.tree.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreeModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreeModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreeModifyModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/sw/tree/publish" : { "put" : { "tags" : [ "alipay.iservice.ccm.sw.tree" ], "summary" : "知识库-类目-发布", "description" : "知识库-类目-发布", "operationId" : "alipay.iservice.ccm.sw.tree.publish", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreePublishResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreePublishErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreePublishModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/sw/treecategory/batchquery" : { "get" : { "tags" : [ "alipay.iservice.ccm.sw.treecategory" ], "summary" : "知识库-节点-批量查询", "description" : "知识库-节点-批量查询", "operationId" : "alipay.iservice.ccm.sw.treecategory.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreecategoryBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreecategoryBatchqueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "ccs_instance_id", "in" : "query", "description" : "子部门ID，不传为默认部门", "schema" : { "type" : "string", "example" : "ZPNASDK" } }, { "name" : "library_id", "in" : "query", "description" : "知识库ID", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "name", "in" : "query", "description" : "节点名称", "schema" : { "type" : "string", "example" : "服务群" } }, { "name" : "page_num", "in" : "query", "description" : "页数，page_size不能为空", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "页显示大小，page_num不能为空", "schema" : { "type" : "integer", "example" : "10" } } ] } }, "/v3/alipay/iservice/ccm/sw/treecategory/create" : { "put" : { "tags" : [ "alipay.iservice.ccm.sw.treecategory" ], "summary" : "知识库-节点-创建", "description" : "知识库-节点-创建", "operationId" : "alipay.iservice.ccm.sw.treecategory.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreecategoryCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreecategoryCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreecategoryCreateModel" } } }, "required" : false } } }, "/v3/alipay/iservice/ccm/sw/treecategory/delete" : { "delete" : { "tags" : [ "alipay.iservice.ccm.sw.treecategory" ], "summary" : "知识库-节点-删除", "description" : "知识库-节点-删除", "operationId" : "alipay.iservice.ccm.sw.treecategory.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreecategoryDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreecategoryDeleteErrorResponseModel" } ] } } } } } } }, "/v3/alipay/iservice/ccm/sw/treecategory/modify" : { "patch" : { "tags" : [ "alipay.iservice.ccm.sw.treecategory" ], "summary" : "知识库-节点-修改", "description" : "知识库-节点-修改", "operationId" : "alipay.iservice.ccm.sw.treecategory.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreecategoryModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreecategoryModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayIserviceCcmSwTreecategoryModifyModel" } } }, "required" : false } } }, "/v3/alipay/marketing/activity/batchquery" : { "post" : { "tags" : [ "alipay.marketing.activity" ], "summary" : "条件查询活动列表", "description" : "通过此接口可查询多个活动的摘要信息。", "operationId" : "alipay.marketing.activity.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/marketing/activity/consult" : { "post" : { "tags" : [ "alipay.marketing.activity" ], "summary" : "活动领取咨询接口", "description" : "通过此接口可以咨询用户是否可以领取该活动优惠券，决定是否对用户展示该活动信息。", "operationId" : "alipay.marketing.activity.consult", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityConsultResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityConsultErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityConsultModel" } } }, "required" : false } } }, "/v3/alipay/marketing/activity/deliverychannel/query" : { "post" : { "tags" : [ "alipay.marketing.activity.deliverychannel" ], "summary" : "查询可推广渠道", "description" : "查询可推广渠道。该接口会返回可以投放的所有渠道的详细信息。\n其中每个渠道的boothCode含义：boothCode表达的是某个渠道可以投放的展位码。例如：支付结果页PAY_RESULT\n其中每个渠道的channel含义：表达的是某个固定的渠道。例如：在boothCode = PAY_RESULT 的情况下， channel = 商户的pid。 该channel就是一个可以投放的渠道，投放后可以在对应的商户的支付结果页看到优惠券。后续创建投放时根据返回的 channel 选择投放渠道", "operationId" : "alipay.marketing.activity.deliverychannel.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityDeliverychannelQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityDeliverychannelQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityDeliverychannelQueryModel" } } }, "required" : false } } }, "/v3/alipay/marketing/activity/ordervoucher/associate" : { "post" : { "tags" : [ "alipay.marketing.activity.ordervoucher" ], "summary" : "关联订单信息", "description" : "将已发放的商家券券码与订单信息关联，用于后续参与返佣激励等操作的统计。\n", "operationId" : "alipay.marketing.activity.ordervoucher.associate", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherAssociateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherAssociateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherAssociateModel" } } }, "required" : false } } }, "/v3/alipay/marketing/activity/ordervoucher/disassociate" : { "post" : { "tags" : [ "alipay.marketing.activity.ordervoucher" ], "summary" : "取消关联订单信息", "description" : "取消商家券与订单信息的关联关系.", "operationId" : "alipay.marketing.activity.ordervoucher.disassociate", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherDisassociateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherDisassociateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherDisassociateModel" } } }, "required" : false } } }, "/v3/alipay/marketing/activity/ordervoucher/query" : { "get" : { "tags" : [ "alipay.marketing.activity.ordervoucher" ], "summary" : "查询商家券活动", "description" : "商户通过该接口查询商家券活动详情。", "operationId" : "alipay.marketing.activity.ordervoucher.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "activity_id", "in" : "query", "description" : "活动id", "schema" : { "type" : "string", "example" : "2016042700826004508401111111" } }, { "name" : "merchant_access_mode", "in" : "query", "description" : "商户接入模式", "schema" : { "type" : "string", "example" : "AGENCY_MODE" } } ] } }, "/v3/alipay/marketing/activity/ordervoucher/user/batchqueryvoucher" : { "get" : { "tags" : [ "alipay.marketing.activity.user" ], "summary" : "条件查询用户券", "description" : "可通过该接口查询用户在某商户可用的全部券，可用于商户的小程序/H5中，用户\"我的优惠券\"或\"提交订单页\"展示优惠信息。只能查询商户配的券，无法查询平台优惠券。", "operationId" : "alipay.marketing.activity.user.batchqueryvoucher", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityUserBatchqueryvoucherResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityUserBatchqueryvoucherErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/AuthToken" }, { "name" : "user_id", "in" : "query", "description" : "支付宝用户 id", "schema" : { "type" : "string", "example" : "2088512417841101" } }, { "name" : "open_id", "in" : "query", "description" : "支付宝用户openId", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } }, { "name" : "activity_id", "in" : "query", "description" : "活动 id", "schema" : { "type" : "string", "example" : "2016042700826004508401111111" } }, { "name" : "belong_merchant_id", "in" : "query", "description" : "券归属商户", "schema" : { "type" : "string", "example" : "2088202967380463" } }, { "name" : "sender_merchant_id", "in" : "query", "description" : "券发放商户", "schema" : { "type" : "string", "example" : "2088102161342862" } }, { "name" : "voucher_status", "in" : "query", "description" : "券状态，其中已过期状态可查询6个月内的数据", "schema" : { "type" : "string", "example" : "SENDED" } }, { "name" : "page_num", "in" : "query", "description" : "分页查询页码", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "merchant_access_mode", "in" : "query", "description" : "商户接入模式", "schema" : { "type" : "string", "example" : "AGENCY_MODE" } }, { "name" : "page_size", "in" : "query", "description" : "分页查询单页数据条数", "schema" : { "type" : "integer", "example" : "20" } } ] } }, "/v3/alipay/marketing/activity/ordervoucher/user/voucher" : { "get" : { "tags" : [ "alipay.marketing.activity.user" ], "summary" : "查询用户券详情", "description" : "通过此接口可以查询用户券信息，包括用户券的基础信息、状态。", "operationId" : "alipay.marketing.activity.user.queryvoucher", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityUserQueryvoucherResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityUserQueryvoucherErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "merchant_id", "in" : "query", "description" : "商户 PID，默认为当前接口调用商户。", "schema" : { "type" : "string", "example" : "2088202967380463" } }, { "name" : "user_id", "in" : "query", "description" : "支付宝用户id", "schema" : { "type" : "string", "example" : "2088512417841101" } }, { "name" : "open_id", "in" : "query", "description" : "支付宝用户openId", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } }, { "name" : "activity_id", "in" : "query", "description" : "活动 id。", "schema" : { "type" : "string", "example" : "2016042700826004508401111111" } }, { "name" : "voucher_id", "in" : "query", "description" : "用户券 id。支付宝为用户优惠券唯一分配的 id。", "schema" : { "type" : "string", "example" : "2021072900073002214009F8QHR3" } }, { "name" : "voucher_code", "in" : "query", "description" : "用户领取的商家券券码。", "schema" : { "type" : "string", "example" : "ABE44" } }, { "name" : "merchant_access_mode", "in" : "query", "description" : "商户接入模式。", "schema" : { "type" : "string", "example" : "AGENCY_MODE" } } ] } }, "/v3/alipay/marketing/activity/voucher/append" : { "post" : { "tags" : [ "alipay.marketing.activity.voucher" ], "summary" : "追加支付券预算", "description" : "支付券激活成功后，调用该接口追加支付券预算。追加支付券预算接口同步返回请求受理结果，后续通过alipay.marketing.activity.message.appended消息接口异步发送追加支付券预算成功事件消息。\n\n如果成功消息长时间未送达，请联系相关技术人员。", "operationId" : "alipay.marketing.activity.voucher.append", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherAppendResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherAppendErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherAppendModel" } } }, "required" : false } } }, "/v3/alipay/marketing/activity/voucher/create" : { "post" : { "tags" : [ "alipay.marketing.activity.voucher" ], "summary" : "创建支付券", "description" : "商户通过调用此接口创建支付券，包括预充值&免充值支付券，接口同步返回创建处理结果。创建完成后将获得活动id，可用于各个营销场景的活动投放。", "operationId" : "alipay.marketing.activity.voucher.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherCreateModel" } } }, "required" : false } } }, "/v3/alipay/marketing/activity/voucher/modify" : { "post" : { "tags" : [ "alipay.marketing.activity.voucher" ], "summary" : "修改支付券基本信息", "description" : "商户可以通过该接口修改支付券基本信息。 接口同步返回修改请求受理结果，后续通过alipay.marketing.activity.message.modified消息接口异步发送修改活动成功事件消息。 \n\n特别注意：修改支付券接口返回结果并不代表活动修改成功，必须等待消息回调后才能确保成功。 如果成功消息长时间未送达，请联系相关技术人员。\n", "operationId" : "alipay.marketing.activity.voucher.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherModifyModel" } } }, "required" : false } } }, "/v3/alipay/marketing/activity/voucher/publish" : { "post" : { "tags" : [ "alipay.marketing.activity.voucher" ], "summary" : "激活支付券", "description" : "支付券创建成功后，通过调用此接口激活支付券。 激活支付券接口同步返回请求受理结果，后续通过alipay.marketing.activity.message.created消息接口异步发送激活支付券成功事件消息。 如果成功消息长时间未送达，请联系相关技术人员。\n", "operationId" : "alipay.marketing.activity.voucher.publish", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherPublishResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherPublishErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherPublishModel" } } }, "required" : false } } }, "/v3/alipay/marketing/activity/voucher/query" : { "get" : { "tags" : [ "alipay.marketing.activity.voucher" ], "summary" : "查询支付券详情", "description" : "通过此接口可查询支付券活动信息，包括活动的配置信息以及活动概况数据。", "operationId" : "alipay.marketing.activity.voucher.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "activity_id", "in" : "query", "description" : "活动 id", "schema" : { "type" : "string", "example" : "2016042700826004508401111111" } }, { "name" : "merchant_access_mode", "in" : "query", "description" : "商户接入模式。", "schema" : { "type" : "string", "example" : "AGENCY_MODE" } } ] } }, "/v3/alipay/marketing/activity/voucher/send" : { "post" : { "tags" : [ "alipay.marketing.activity.voucher" ], "summary" : "发放支付券", "description" : "API完成制券后，可使用发放支付券接口发券。通过调用此接口可发放支付券给指定用户，发券场景可以是小程序、H5、APP等。", "operationId" : "alipay.marketing.activity.voucher.send", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherSendResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherSendErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherSendModel" } } }, "required" : false } } }, "/v3/alipay/marketing/activity/voucher/stop" : { "post" : { "tags" : [ "alipay.marketing.activity.voucher" ], "summary" : "停止支付券", "description" : "商家调用该接口停止支付券。 停止支付券接口同步返回请求受理结果，后续通过alipay.marketing.activity.message.stopped消息接口异步发送停止活动成功事件。 如果成功消息长时间未送达，请联系相关技术人员。", "operationId" : "alipay.marketing.activity.voucher.stop", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherStopResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherStopErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherStopModel" } } }, "required" : false } } }, "/v3/alipay/marketing/activity/voucherpackage/batchquery" : { "post" : { "tags" : [ "alipay.marketing.activity.voucherpackage" ], "summary" : "券包批量查询", "description" : "券包批量查询", "operationId" : "alipay.marketing.activity.voucherpackage.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherpackageBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherpackageBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherpackageBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/marketing/activity/voucherpackage/consult" : { "post" : { "tags" : [ "alipay.marketing.activity.voucherpackage" ], "summary" : "券包购买咨询", "description" : "券包购买咨询，咨询当前用户是否可以购买指定的券包", "operationId" : "alipay.marketing.activity.voucherpackage.consult", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherpackageConsultResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherpackageConsultErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/AuthToken" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherpackageConsultModel" } } }, "required" : false } } }, "/v3/alipay/marketing/activity/voucherpackage/query" : { "get" : { "tags" : [ "alipay.marketing.activity.voucherpackage" ], "summary" : "券包详情查询", "description" : "查询券包详情，包括券包信息和券包下面券信息", "operationId" : "alipay.marketing.activity.voucherpackage.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherpackageQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityVoucherpackageQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "voucher_package_id", "in" : "query", "description" : "券包id", "schema" : { "type" : "string", "example" : "IP20220628016671405804297103167741" } } ] } }, "/v3/alipay/marketing/activity/{activity_id}" : { "get" : { "tags" : [ "alipay.marketing.activity" ], "summary" : "查询活动详情", "description" : "通过此接口可以查询活动详情，包括支付券和商家券活动。", "operationId" : "alipay.marketing.activity.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "activity_id", "in" : "path", "description" : "活动id", "required" : true, "schema" : { "type" : "string", "example" : "2016042700826004508401111111" } }, { "name" : "merchant_id", "in" : "query", "description" : "商户PID,默认为当前接口调用商户。", "schema" : { "type" : "string", "example" : "2088202967380463" } }, { "name" : "merchant_access_mode", "in" : "query", "description" : "商户接入模式。", "schema" : { "type" : "string", "example" : "AGENCY_MODE" } } ] } }, "/v3/alipay/marketing/activity/{activity_id}/app/batchquery" : { "get" : { "tags" : [ "alipay.marketing.activity.app" ], "summary" : "查询活动可用小程序", "description" : "通过此接口可查询活动的可用小程序,判断活动是否在该小程序可用，来决定是否展示。", "operationId" : "alipay.marketing.activity.app.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityAppBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityAppBatchqueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "merchant_id", "in" : "query", "description" : "商户PID,默认为当前接口调用商户 \t限制: \t接口调用者必须有商户代运营权限。 \t\t代运营授权流程https://opendocs.alipay.com/mini/01hm6i#%E4%BB%A3%E8%BF%90%E8%90%A5%E6%8E%88%E6%9D%83", "schema" : { "type" : "string", "example" : "2088202967380463" } }, { "name" : "activity_id", "in" : "path", "description" : "活动id", "required" : true, "schema" : { "type" : "string", "example" : "2016042700826004508401111111" } }, { "name" : "page_num", "in" : "query", "description" : "分页查询页码。 \t限制:\t必须为大于0的整数", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "分页查询单页数据条数。 \t限制: \t1.必须为大于0的整数 \t2.每页最大值为20", "schema" : { "type" : "string", "example" : "20" } }, { "name" : "merchant_access_mode", "in" : "query", "description" : "商户接入模式\t\t枚举值\tSELF_MODE 商户自接入模式\tAGENCY_MODE 服务商代接入模式", "schema" : { "type" : "string", "example" : "AGENCY_MODE" } } ] } }, "/v3/alipay/marketing/activity/{activity_id}/goods/batchquery" : { "get" : { "tags" : [ "alipay.marketing.activity.goods" ], "summary" : "查询活动适用商品", "description" : "通过此接口可查询活动的可用或不可用商品,判断是否在该商品可用，来决定是否展示。", "operationId" : "alipay.marketing.activity.goods.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityGoodsBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityGoodsBatchqueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "merchant_id", "in" : "query", "description" : "商户PID,默认为当前接口调用商户 \t限制: \t接口调用者必须有商户代运营权限。 \t\t代运营授权流程https://opendocs.alipay.com/mini/01hm6i#%E4%BB%A3%E8%BF%90%E8%90%A5%E6%8E%88%E6%9D%83", "schema" : { "type" : "string", "example" : "2088202967380463" } }, { "name" : "activity_id", "in" : "path", "description" : "活动id", "required" : true, "schema" : { "type" : "string", "example" : "2016042700826004508401111111" } }, { "name" : "goods_use_type", "in" : "query", "description" : "活动单品类型。\t枚举值:\tAVAILABLE 可用商品\tUNAVAILABLE 不可用商品", "schema" : { "type" : "string", "example" : "AVAILABLE" } }, { "name" : "page_num", "in" : "query", "description" : "分页查询页码。\t限制:\t必须为大于0的整数", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "分页查询单页数据条数。\t限制:\t1.必须为大于0的整数\t2.每页最大值为20", "schema" : { "type" : "integer", "example" : "20" } }, { "name" : "product_version", "in" : "query", "description" : "版本号\t\t枚举值:\t2.0.0", "schema" : { "type" : "string", "example" : "2.0.0" } }, { "name" : "merchant_access_mode", "in" : "query", "description" : "商户接入模式\t\t枚举值\tSELF_MODE 商户自接入模式\tAGENCY_MODE 服务商代接入模式", "schema" : { "type" : "string", "example" : "AGENCY_MODE" } } ] } }, "/v3/alipay/marketing/activity/{activity_id}/merchant/batchquery" : { "get" : { "tags" : [ "alipay.marketing.activity.merchant" ], "summary" : "查询活动可用商户", "description" : "通过此接口可查询活动的可用商户,判断活动是否在某商户可用，来决定是否展示。", "operationId" : "alipay.marketing.activity.merchant.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityMerchantBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityMerchantBatchqueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "merchant_id", "in" : "query", "description" : "商户PID,默认为当前接口调用商户 \t限制: \t接口调用者必须有商户代运营权限。 \t\t代运营授权流程https://opendocs.alipay.com/mini/01hm6i#%E4%BB%A3%E8%BF%90%E8%90%A5%E6%8E%88%E6%9D%83", "schema" : { "type" : "string", "example" : "2088202967380463" } }, { "name" : "activity_id", "in" : "path", "description" : "活动id", "required" : true, "schema" : { "type" : "string", "example" : "2016042700826004508401111111" } }, { "name" : "page_num", "in" : "query", "description" : "分页查询页码。 \t限制: \t必须为大于0的整数", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "分页查询单页数据条数。 \t限制: \t1.必须为大于0的整数 \t2.每页最大值为20", "schema" : { "type" : "integer", "example" : "20" } }, { "name" : "merchant_access_mode", "in" : "query", "description" : "商户接入模式\t\t枚举值\tSELF_MODE 商户自接入模式\tAGENCY_MODE 服务商代接入模式", "schema" : { "type" : "string", "example" : "AGENCY_MODE" } } ] } }, "/v3/alipay/marketing/activity/{activity_id}/shop/batchquery" : { "get" : { "tags" : [ "alipay.marketing.activity.shop" ], "summary" : "查询活动可用球房", "description" : "通过此接口可查询活动的可用球房，判断券是否在某球房可用，来决定是否展示。", "operationId" : "alipay.marketing.activity.shop.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityShopBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityShopBatchqueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "merchant_id", "in" : "query", "description" : "商户PID,默认为当前接口调用商户 \t限制: \t接口调用者必须有商户代运营权限。 \t\t代运营授权流程https://opendocs.alipay.com/mini/01hm6i#%E4%BB%A3%E8%BF%90%E8%90%A5%E6%8E%88%E6%9D%83", "schema" : { "type" : "string", "example" : "2088202967380463" } }, { "name" : "activity_id", "in" : "path", "description" : "活动id", "required" : true, "schema" : { "type" : "string", "example" : "2016042700826004508401111111" } }, { "name" : "page_num", "in" : "query", "description" : "分页查询页码。 \t限制: \t必须为大于0的整数", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "分页查询单页数据条数。 \t限制: \t1.必须为大于0的整数 \t2.每页最大值为20", "schema" : { "type" : "integer", "example" : "20" } }, { "name" : "product_version", "in" : "query", "description" : "版本号\t\t枚举值:\t2.0.0", "schema" : { "type" : "string", "example" : "2.0.0" } }, { "name" : "merchant_access_mode", "in" : "query", "description" : "商户接入模式\t\t枚举值\tSELF_MODE 商户自接入模式\tAGENCY_MODE 服务商代接入模式", "schema" : { "type" : "string", "example" : "AGENCY_MODE" } } ] } }, "/v3/alipay/marketing/campaign/cash/create" : { "post" : { "tags" : [ "alipay.marketing.campaign.cash" ], "summary" : "创建现金活动", "description" : "商户通过开放平台创建商户活动", "operationId" : "alipay.marketing.campaign.cash.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCampaignCashCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingCampaignCashCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCampaignCashCreateModel" } } }, "required" : false } } }, "/v3/alipay/marketing/campaign/cash/detail/query" : { "get" : { "tags" : [ "alipay.marketing.campaign.cash.detail" ], "summary" : "现金活动详情查询", "description" : "商户通过开放平台查询自己创建的现金活动详情", "operationId" : "alipay.marketing.campaign.cash.detail.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCampaignCashDetailQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingCampaignCashDetailQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "crowd_no", "in" : "query", "description" : "现金活动号，通过alipay.marketing.campaign.cash.create(创建现金活动)接口创建现金活动获取。", "schema" : { "type" : "string", "example" : "POYb84lfiKVdIfERAYsqPL_KQRIpfQbl47xfRmmPBlDMnSZ96O-zxUfKlHp5cxmx" } } ] } }, "/v3/alipay/marketing/campaign/cash/list/query" : { "get" : { "tags" : [ "alipay.marketing.campaign.cash.list" ], "summary" : "现金活动列表查询", "description" : "商户通过开放平台查询自己创建的现金活动列表", "operationId" : "alipay.marketing.campaign.cash.list.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCampaignCashListQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingCampaignCashListQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "camp_status", "in" : "query", "description" : "要查询的活动状态,不填默认为 ALL 返回所有类型。枚举支持:\t*ALL：所有类型的活动。\t*CREATED：已创建未打款。\t*PAID：已打款。\t*READY：活动已开始。\t*PAUSE：活动已暂停。\t*CLOSED：活动已结束。\t*SETTLE：活动已清算。", "schema" : { "type" : "string", "example" : "PAID" } }, { "name" : "page_size", "in" : "query", "description" : "分页查询时每页返回的列表大小，每页数据最大为 50。", "schema" : { "type" : "string", "example" : "10" } }, { "name" : "page_index", "in" : "query", "description" : "分页查询时的页码，从1开始", "schema" : { "type" : "string", "example" : "1" } } ] } }, "/v3/alipay/marketing/campaign/cash/status/modify" : { "post" : { "tags" : [ "alipay.marketing.campaign.cash.status" ], "summary" : "更改现金活动状态", "description" : "商户更改现金活动状态，启动/暂停/终止", "operationId" : "alipay.marketing.campaign.cash.status.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCampaignCashStatusModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingCampaignCashStatusModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCampaignCashStatusModifyModel" } } }, "required" : false } } }, "/v3/alipay/marketing/campaign/cash/trigger" : { "post" : { "tags" : [ "alipay.marketing.campaign.cash" ], "summary" : "触发现金红包活动", "description" : "用户通过开放平台参与现金活动", "operationId" : "alipay.marketing.campaign.cash.trigger", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCampaignCashTriggerResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingCampaignCashTriggerErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCampaignCashTriggerModel" } } }, "required" : false } } }, "/v3/alipay/marketing/campaign/order/voucher/consult" : { "post" : { "tags" : [ "alipay.marketing.campaign.order.voucher" ], "summary" : "订单优惠前置咨询", "description" : "本接口用于前置优惠咨询，包括本订单可享的优惠券列表，注意该列表并不等价于最终核销时使用的券列表，而是包含了咨询的那一刻该订单能用的所有券，且券满足叠加使用下的互斥等规则", "operationId" : "alipay.marketing.campaign.order.voucher.consult", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCampaignOrderVoucherConsultResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingCampaignOrderVoucherConsultErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/AuthToken" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCampaignOrderVoucherConsultModel" } } }, "required" : false } } }, "/v3/alipay/marketing/card/activateform/query" : { "get" : { "tags" : [ "alipay.marketing.card.activateform" ], "summary" : "查询用户提交的会员卡表单信息", "description" : "会员卡开卡场景下，用户确认领卡后，跳转到商户开卡处理页面，商户通过该接口查询用户表单信息。", "operationId" : "alipay.marketing.card.activateform.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardActivateformQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingCardActivateformQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/AuthToken" }, { "name" : "biz_type", "in" : "query", "description" : "开放表单信息查询业务类型，可选类型如下：\tMEMBER_CARD ：商家会员卡开卡", "schema" : { "type" : "string", "example" : "MEMBER_CARD" } }, { "name" : "template_id", "in" : "query", "description" : "会员卡模板id。使用会员卡模板创建接口(alipay.marketing.card.template.create)返回的结果", "schema" : { "type" : "string", "example" : "2071828288283883" } }, { "name" : "request_id", "in" : "query", "description" : "查询用户表单提交信息的请求id。\t\t网页移动应用&小程序应用：与auth_code 一起通过alipay.marketing.card.activateurl.apply(获取会员卡领卡投放链接)接口callback地址回传。\t\t注意：auth_code（用户授权码）用于换取用户授权令牌 accessToken，后续调用接口需传入accessToken。", "schema" : { "type" : "string", "example" : "2017021929993993992839493394" } } ] } }, "/v3/alipay/marketing/card/activateurl/apply" : { "post" : { "tags" : [ "alipay.marketing.card.activateurl" ], "summary" : "获取会员卡领卡投放链接", "description" : "会员卡开卡业务，开发者通过该接口获取用户开卡链接，用于会员卡投放。", "operationId" : "alipay.marketing.card.activateurl.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardActivateurlApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingCardActivateurlApplyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardActivateurlApplyModel" } } }, "required" : false } } }, "/v3/alipay/marketing/card/benefit/create" : { "post" : { "tags" : [ "alipay.marketing.card.benefit" ], "summary" : "会员卡模板外部权益创建", "description" : "会员卡模板外部权益创建，创建的权益内容信息将展示在卡包中卡详情页中部区域。", "operationId" : "alipay.marketing.card.benefit.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardBenefitCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingCardBenefitCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardBenefitCreateModel" } } }, "required" : false } } }, "/v3/alipay/marketing/card/benefit/delete" : { "delete" : { "tags" : [ "alipay.marketing.card.benefit" ], "summary" : "会员卡模板外部权益删除", "description" : "会员卡模板外部权益删除", "operationId" : "alipay.marketing.card.benefit.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardBenefitDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingCardBenefitDeleteErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "template_id", "in" : "query", "description" : "会员卡模板ID，通过 alipay.marketing.card.template.create（会员卡模板创建)接口创建会员卡模板获取。", "schema" : { "type" : "string", "example" : "20170322000000000068101000300041" } }, { "name" : "benefit_id", "in" : "query", "description" : "权益ID，通过 alipay.marketing.card.benefit.create(会员卡模板外部权益创建)接口创建获取。", "schema" : { "type" : "string", "example" : "20170322000000000068101000300041" } } ] } }, "/v3/alipay/marketing/card/benefit/modify" : { "post" : { "tags" : [ "alipay.marketing.card.benefit" ], "summary" : "会员卡模板外部权益修改", "description" : "会员卡模板外部权益修改", "operationId" : "alipay.marketing.card.benefit.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardBenefitModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingCardBenefitModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardBenefitModifyModel" } } }, "required" : false } } }, "/v3/alipay/marketing/card/benefit/query" : { "get" : { "tags" : [ "alipay.marketing.card.benefit" ], "summary" : "会员卡模板外部权益查询", "description" : "会员卡模板外部权益查询", "operationId" : "alipay.marketing.card.benefit.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardBenefitQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingCardBenefitQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "template_id", "in" : "query", "description" : "会员卡模板ID，通过 alipay.marketing.card.template.create（会员卡模板创建)接口创建会员卡模板获取。", "schema" : { "type" : "string", "example" : "20170322000000000068101000300041" } }, { "name" : "benefit_id", "in" : "query", "description" : "权益ID，通过 alipay.marketing.card.benefit.create(会员卡模板外部权益创建)接口创建获取。", "schema" : { "type" : "string", "example" : "20170322000000000068101000300041" } } ] } }, "/v3/alipay/marketing/card/consume/sync" : { "post" : { "tags" : [ "alipay.marketing.card.consume" ], "summary" : "会员卡消费记录同步", "description" : "会员卡消费记录同步", "operationId" : "alipay.marketing.card.consume.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardConsumeSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingCardConsumeSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardConsumeSyncModel" } } }, "required" : false } } }, "/v3/alipay/marketing/card/delete" : { "delete" : { "tags" : [ "alipay.marketing.card" ], "summary" : "会员卡删卡", "description" : "通过 API 接口删除商家会员卡。", "operationId" : "alipay.marketing.card.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingCardDeleteErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "out_serial_no", "in" : "query", "description" : "商户端删卡业务流水号，商户自定义且需确保流水号唯一性。", "schema" : { "type" : "string", "example" : "2016062700001" } }, { "name" : "target_card_no", "in" : "query", "description" : "支付宝业务卡号。即开卡接口返回结果中的card_info.biz_card_no。", "schema" : { "type" : "string", "example" : "0000001" } }, { "name" : "target_card_no_type", "in" : "query", "description" : "卡号ID类型\r\tBIZ_CARD：支付宝卡号", "schema" : { "type" : "string", "example" : "BIZ_CARD" } }, { "name" : "reason_code", "in" : "query", "description" : "删卡原因\r\tUSER_UNBUND：用户解绑（可以重新绑定）\r\tCANCEL：销户（完成销户后，就不能再重新绑定）\r\tPRESENT：转赠（可以重新绑定）", "schema" : { "type" : "string", "example" : "USER_UNBUND" } }, { "name" : "ext_info", "in" : "query", "description" : "删卡扩展参数，json格式。\r\t用于商户的特定业务信息的传递，只有商户与支付宝约定了传递此参数且约定了参数含义，此参数才有效。\r\t目前支持如下key：\r\tnew_card_no：新卡号\r\tdonee_user_id：受赠人userId", "schema" : { "type" : "string", "example" : "{\"new_card_no\":\"12345\",\" donee_user_id\":\"2088102130652460\"}" } } ] } }, "/v3/alipay/marketing/card/formtemplate/set" : { "post" : { "tags" : [ "alipay.marketing.card.formtemplate" ], "summary" : "会员卡开卡表单模板配置", "description" : "会员卡开卡、用户授权确认", "operationId" : "alipay.marketing.card.formtemplate.set", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardFormtemplateSetResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingCardFormtemplateSetErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardFormtemplateSetModel" } } }, "required" : false } } }, "/v3/alipay/marketing/card/message/notify" : { "post" : { "tags" : [ "alipay.marketing.card.message" ], "summary" : "会员卡消息通知", "description" : "商户触发消息通知用户", "operationId" : "alipay.marketing.card.message.notify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardMessageNotifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingCardMessageNotifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardMessageNotifyModel" } } }, "required" : false } } }, "/v3/alipay/marketing/card/open" : { "post" : { "tags" : [ "alipay.marketing.card" ], "summary" : "会员卡开卡", "description" : "商户通过API接口，进行会员卡开卡。", "operationId" : "alipay.marketing.card.open", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardOpenResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingCardOpenErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/AuthToken" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardOpenModel" } } }, "required" : false } } }, "/v3/alipay/marketing/card/query" : { "post" : { "tags" : [ "alipay.marketing.card" ], "summary" : "会员卡查询", "description" : "根据卡号或者持卡人信息查询会员卡信息", "operationId" : "alipay.marketing.card.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingCardQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardQueryModel" } } }, "required" : false } } }, "/v3/alipay/marketing/card/template/batchquery" : { "post" : { "tags" : [ "alipay.marketing.card.template" ], "summary" : "会员卡模板批量查询", "description" : "会员卡模板批量查询", "operationId" : "alipay.marketing.card.template.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardTemplateBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingCardTemplateBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardTemplateBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/marketing/card/template/create" : { "post" : { "tags" : [ "alipay.marketing.card.template" ], "summary" : "会员卡模板创建", "description" : "会员卡模板创建", "operationId" : "alipay.marketing.card.template.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardTemplateCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingCardTemplateCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardTemplateCreateModel" } } }, "required" : false } } }, "/v3/alipay/marketing/card/template/modify" : { "post" : { "tags" : [ "alipay.marketing.card.template" ], "summary" : "会员卡模板修改", "description" : "会员卡模板修改", "operationId" : "alipay.marketing.card.template.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardTemplateModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingCardTemplateModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardTemplateModifyModel" } } }, "required" : false } } }, "/v3/alipay/marketing/card/template/query" : { "get" : { "tags" : [ "alipay.marketing.card.template" ], "summary" : "会员卡模板查询接口", "description" : "会员卡模板查询接口", "operationId" : "alipay.marketing.card.template.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardTemplateQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingCardTemplateQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "template_id", "in" : "query", "description" : "会员卡模板id。调用alipay.marketing.card.template.create（会员卡模板创建接口）创建模板后同步返回。", "schema" : { "type" : "string", "example" : "20160718000000001" } } ] } }, "/v3/alipay/marketing/card/update" : { "post" : { "tags" : [ "alipay.marketing.card" ], "summary" : "会员卡更新", "description" : "会员卡更新", "operationId" : "alipay.marketing.card.update", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardUpdateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingCardUpdateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingCardUpdateModel" } } }, "required" : false } } }, "/v3/alipay/marketing/delivery" : { "post" : { "tags" : [ "alipay.marketing.activity.delivery" ], "summary" : "创建推广计划", "description" : "创建推广计划将内容推广到指定展位，用户可在指定展位领取推广内容。 不同展位支持的推广内容、推广规则、推广玩法、推广配置可能存在差异，使用时请仔细阅读接口说明文档。 创建推广成功后，请依据推广变更消息alipay.marketing.activity.delivery.message感知推广变更状态。", "operationId" : "alipay.marketing.activity.delivery.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityDeliveryCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityDeliveryCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityDeliveryCreateModel" } } }, "required" : false } } }, "/v3/alipay/marketing/delivery/{delivery_id}/query" : { "post" : { "tags" : [ "alipay.marketing.activity.delivery" ], "summary" : "查询推广计划", "description" : "查询推广计划详情信息。", "operationId" : "alipay.marketing.activity.delivery.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityDeliveryQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityDeliveryQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "delivery_id", "in" : "path", "description" : "推广计划id", "required" : true, "schema" : { "type" : "string", "example" : "20121231231242353" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityDeliveryQueryModel" } } }, "required" : false } } }, "/v3/alipay/marketing/delivery/{delivery_id}/stop" : { "patch" : { "tags" : [ "alipay.marketing.activity.delivery" ], "summary" : "停止推广计划", "description" : "停止推广计划。 \n注意：停止推广操作成功到推广内容停止生效，可能存在几分钟的延迟。", "operationId" : "alipay.marketing.activity.delivery.stop", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityDeliveryStopResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityDeliveryStopErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "delivery_id", "in" : "path", "description" : "推广计划id", "required" : true, "schema" : { "type" : "string", "example" : "20121231231242353" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityDeliveryStopModel" } } }, "required" : false } } }, "/v3/alipay/marketing/material/create" : { "post" : { "tags" : [ "alipay.marketing.material" ], "summary" : "创建支付宝素材", "description" : "用于创建支付宝素材", "operationId" : "alipay.marketing.material.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingMaterialCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingMaterialCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingMaterialCreateModel" } } }, "required" : false } } }, "/v3/alipay/marketing/material/image" : { "post" : { "tags" : [ "alipay.marketing.material.image" ], "summary" : "营销图片资源上传接口", "description" : "营销通用上传图片接口", "operationId" : "alipay.marketing.material.image.upload", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingMaterialImageUploadResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingMaterialImageUploadErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AlipayMarketingMaterialImageUploadModel" }, "file_content" : { "type" : "string", "format" : "binary" } } }, "encoding" : { "file_content" : { "contentType" : "*/*" }, "data" : { "contentType" : "application/json" } } } }, "required" : false } } }, "/v3/alipay/marketing/ordervoucher/activity" : { "post" : { "tags" : [ "alipay.marketing.activity.ordervoucher" ], "summary" : "创建商家券活动", "description" : "商家调用该接口创建商家券活动。\n创建商家券活动接口同步返回创建请求受理结果，后续通过alipay.marketing.activity.message.created消息接口异步发送活动创建成功事件消息。\n\n如果在code_mode=MERCHANT_UPLOAD的模式下，创建商家券活动后，还需要进行券码导入操作，以及预算追加操作，然后商家券才能进行发放。", "operationId" : "alipay.marketing.activity.ordervoucher.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherCreateModel" } } }, "required" : false } } }, "/v3/alipay/marketing/ordervoucher/activity/{activity_id}" : { "patch" : { "tags" : [ "alipay.marketing.activity.ordervoucher" ], "summary" : "修改商家券活动基本信息", "description" : "商家调用该接口修改商家券活动基本信息。\n修改商家券活动基本信息接口同步返回修改请求受理结果，后续通过alipay.marketing.activity.message.modified消息接口异步发送修改活动成功事件消息。", "operationId" : "alipay.marketing.activity.ordervoucher.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherModifyErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "activity_id", "in" : "path", "description" : "活动id1", "required" : true, "schema" : { "type" : "string", "example" : "2016042700826004508401111111" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherModifyModel" } } }, "required" : false } } }, "/v3/alipay/marketing/ordervoucher/activity/{activity_id}/append" : { "patch" : { "tags" : [ "alipay.marketing.activity.ordervoucher" ], "summary" : "修改商家券活动发券数量上限", "description" : "商家调用该接口修改商家券活动预算上限，以此来追加商家券活动预算。\n修改商家券活动预算上限同步返回追加请求受理结果，后续通过alipay.marketing.activity.message.appended消息接口异步发送发券数量上限修改成功事件消息。\ncode_mode=MERCHANT_UPLOAD场景下，必须先导入券码后，方可追加商家券预算。", "operationId" : "alipay.marketing.activity.ordervoucher.append", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherAppendResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherAppendErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "activity_id", "in" : "path", "description" : "活动id", "required" : true, "schema" : { "type" : "string", "example" : "2016042700826004508401111111" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherAppendModel" } } }, "required" : false } } }, "/v3/alipay/marketing/ordervoucher/activity/{activity_id}/stop" : { "patch" : { "tags" : [ "alipay.marketing.activity.ordervoucher" ], "summary" : "停止商家券活动", "description" : "商家调用该接口停止优惠券。\n停止优惠券接口同步返回停止请求受理结果，后续通过alipay.marketing.activity.message.stopped消息接口异步发送停止活动成功事件。\n如果成功消息长时间未送达，请联系相关技术人员。", "operationId" : "alipay.marketing.activity.ordervoucher.stop", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherStopResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherStopErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "activity_id", "in" : "path", "description" : "活动id", "required" : true, "schema" : { "type" : "string", "example" : "2016042700826004508401111111" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherStopModel" } } }, "required" : false } } }, "/v3/alipay/marketing/ordervoucher/activity/{activity_id}/voucher/codecount" : { "get" : { "tags" : [ "alipay.marketing.activity.ordervoucher" ], "summary" : "统计商家券券码数量", "description" : "商家调用该接口查询活动中的有效券码个数。接口同步返回查询结果。", "operationId" : "alipay.marketing.activity.ordervoucher.codecount", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherCodecountResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherCodecountErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "activity_id", "in" : "path", "description" : "活动id", "required" : true, "schema" : { "type" : "string", "example" : "2016042700826004508401111111" } }, { "name" : "merchant_access_mode", "in" : "query", "description" : "商户接入模式\t\t枚举值\tSELF_MODE 商户自接入模式\tAGENCY_MODE 服务商代接入模式", "schema" : { "type" : "string", "example" : "SELF_MODE" } } ] } }, "/v3/alipay/marketing/ordervoucher/activity/{activity_id}/voucher/codedeposit" : { "post" : { "tags" : [ "alipay.marketing.activity.ordervoucher" ], "summary" : "同步商家券券码", "description" : "商家调用该接口同步导入商家券券码，接口同步返回导入结果。请在接收alipay.marketing.activity.message.created消息后，再进行调用。", "operationId" : "alipay.marketing.activity.ordervoucher.codedeposit", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherCodedepositResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherCodedepositErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "activity_id", "in" : "path", "description" : "活动id\t\t限制\t请在接收alipay.marketing.activity.message.created消息后，再进行调用。", "required" : true, "schema" : { "type" : "string", "example" : "2016042700826004508401111111" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherCodedepositModel" } } }, "required" : false } } }, "/v3/alipay/marketing/ordervoucher/activity/{activity_id}/voucher/{voucher_code}/refund" : { "post" : { "tags" : [ "alipay.marketing.activity.ordervoucher" ], "summary" : "取消券核销状态", "description" : "商户调用该接口进行优惠券退券处理。接口同步返回结果。\n如果优惠券过期后，发起退券操作，该接口返回成功，优惠券退回后仍不可用。\n如果优惠券在支付宝卡包已删除，发起退券操作，该接口返回成功，优惠券在支付宝卡包仍然是删除状态。", "operationId" : "alipay.marketing.activity.ordervoucher.refund", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherRefundResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherRefundErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "activity_id", "in" : "path", "description" : "优惠券活动id", "required" : true, "schema" : { "type" : "string", "example" : "2016042700826004508401111111" } }, { "name" : "voucher_code", "in" : "path", "description" : "已核销待退券的券码", "required" : true, "schema" : { "type" : "string", "example" : "ABE44" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherRefundModel" } } }, "required" : false } } }, "/v3/alipay/marketing/ordervoucher/activity/{activity_id}/voucher/{voucher_code}/use" : { "post" : { "tags" : [ "alipay.marketing.activity.ordervoucher" ], "summary" : "同步券核销状态", "description" : "商户调用该接口，通过券码进行优惠券核销，接口同步返回核销结果。", "operationId" : "alipay.marketing.activity.ordervoucher.use", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherUseResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherUseErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "activity_id", "in" : "path", "description" : "优惠券活动id", "required" : true, "schema" : { "type" : "string", "example" : "2016042700826004508401111111" } }, { "name" : "voucher_code", "in" : "path", "description" : "待核销的券码。", "required" : true, "schema" : { "type" : "string", "example" : "ABE44" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingActivityOrdervoucherUseModel" } } }, "required" : false } } }, "/v3/alipay/marketing/recruit/enroll/close" : { "post" : { "tags" : [ "alipay.marketing.recruit.enroll" ], "summary" : "下线报名", "description" : "下线报名", "operationId" : "alipay.marketing.recruit.enroll.close", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingRecruitEnrollCloseResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingRecruitEnrollCloseErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingRecruitEnrollCloseModel" } } }, "required" : false } } }, "/v3/alipay/marketing/recruit/enroll/create" : { "post" : { "tags" : [ "alipay.marketing.recruit.enroll" ], "summary" : "招商报名提交", "description" : "创建报名后立即提交，审核通过后会以消息的形式通知调用方（需要接入消息接口alipay.marketing.enroll.status.changed）。在消息通知前可以尝试调用“报名详情查询接口（alipay.marketing.enroll.detail.query）”了解报名状态。", "operationId" : "alipay.marketing.recruit.enroll.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingRecruitEnrollCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingRecruitEnrollCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingRecruitEnrollCreateModel" } } }, "required" : false } } }, "/v3/alipay/marketing/recruit/enroll/query" : { "get" : { "tags" : [ "alipay.marketing.recruit.enroll" ], "summary" : "报名详情查询", "description" : "报名详情查询", "operationId" : "alipay.marketing.recruit.enroll.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingRecruitEnrollQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingRecruitEnrollQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "out_biz_no", "in" : "query", "description" : "外部操作流水号。由商家/ISV 自定义，仅支持字母、数字、下划线且需保证每次操作唯一。", "schema" : { "type" : "string", "example" : "21ba1e1c16456985463242192e4d" } }, { "name" : "enroll_id", "in" : "query", "description" : "报名ID，此参数和out_biz_no至少传一个，优先取enroll_id", "schema" : { "type" : "string", "example" : "2021041301000200000000000000" } } ] } }, "/v3/alipay/marketing/recruit/plan/query" : { "post" : { "tags" : [ "alipay.marketing.recruit.plan" ], "summary" : "招商方案详情查询", "description" : "招商方案详情查询", "operationId" : "alipay.marketing.recruit.plan.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingRecruitPlanQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingRecruitPlanQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingRecruitPlanQueryModel" } } }, "required" : false } } }, "/v3/alipay/marketing/recruit/planlist/query" : { "post" : { "tags" : [ "alipay.marketing.recruit.planlist" ], "summary" : "查询可报名的方案列表", "description" : "查询可报名的方案列表", "operationId" : "alipay.marketing.recruit.planlist.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingRecruitPlanlistQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingRecruitPlanlistQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingRecruitPlanlistQueryModel" } } }, "required" : false } } }, "/v3/alipay/marketing/xuanyitest/transfer" : { "post" : { "tags" : [ "alipay.marketing.xuanyitest" ], "summary" : "资源化测试4.0", "description" : "功能测试", "operationId" : "alipay.marketing.xuanyitest.transfer", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingXuanyitestTransferResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMarketingXuanyitestTransferErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMarketingXuanyitestTransferModel" } } }, "required" : false } } }, "/v3/alipay/merchant/anchor/query" : { "get" : { "tags" : [ "alipay.merchant.anchor.info" ], "summary" : "查询主播信息", "description" : "查询主播信息", "operationId" : "alipay.merchant.anchor.info.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantAnchorInfoQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMerchantAnchorInfoQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "user_id", "in" : "query", "description" : "蚂蚁统一会员ID", "schema" : { "type" : "string", "example" : "2088000011112222" } }, { "name" : "open_id", "in" : "query", "description" : "蚂蚁统一会员ID", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } }, { "name" : "public_id", "in" : "query", "description" : "生活号ID", "schema" : { "type" : "string", "example" : "2021000011112222" } } ] } }, "/v3/alipay/merchant/image/upload" : { "post" : { "tags" : [ "alipay.merchant.image" ], "summary" : "商户上传处理图片", "description" : "商户上传投诉处理、服务咨询的图片接口", "operationId" : "alipay.merchant.image.upload", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantImageUploadResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMerchantImageUploadErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AlipayMerchantImageUploadModel" }, "image_content" : { "type" : "string", "format" : "binary" } } }, "encoding" : { "data" : { "contentType" : "application/json" }, "image_content" : { "contentType" : "*/*" } } } }, "required" : false } } }, "/v3/alipay/merchant/indirect/authorder/close" : { "put" : { "tags" : [ "alipay.merchant.indirect.authorder" ], "summary" : "商家认证申请单撤销", "description" : "申请单处于审核中、审核失败、待确认等状态时，申请单可撤销，撤销后可重新调用提交申请单接口上传申请单信息", "operationId" : "alipay.merchant.indirect.authorder.close", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantIndirectAuthorderCloseResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMerchantIndirectAuthorderCloseErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantIndirectAuthorderCloseModel" } } }, "required" : false } } }, "/v3/alipay/merchant/indirect/authorder/create" : { "post" : { "tags" : [ "alipay.merchant.indirect.authorder" ], "summary" : "商家认证申请单提交", "description" : "间连商户认证申请单提交，用于支付宝间连商家认证", "operationId" : "alipay.merchant.indirect.authorder.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantIndirectAuthorderCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMerchantIndirectAuthorderCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantIndirectAuthorderCreateModel" } } }, "required" : false } } }, "/v3/alipay/merchant/indirect/authorder/querystatus" : { "post" : { "tags" : [ "alipay.merchant.indirect.authorder" ], "summary" : "查询商家认证申请单状态", "description" : "查询商家认证申请单状态，以及失败原因", "operationId" : "alipay.merchant.indirect.authorder.querystatus", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantIndirectAuthorderQuerystatusResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMerchantIndirectAuthorderQuerystatusErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantIndirectAuthorderQuerystatusModel" } } }, "required" : false } } }, "/v3/alipay/merchant/indirect/smidbind/query" : { "get" : { "tags" : [ "alipay.merchant.indirect.smidbind" ], "summary" : "获取商家认证状态", "description" : "获取商家认证状态，状态枚举：已确认/未确认/已注销", "operationId" : "alipay.merchant.indirect.smidbind.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantIndirectSmidbindQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMerchantIndirectSmidbindQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "sub_merchant_id", "in" : "query", "description" : "支付宝商户id", "schema" : { "type" : "string", "example" : "2088000000000001" } } ] } }, "/v3/alipay/merchant/iot/device/bind" : { "post" : { "tags" : [ "alipay.merchant.iot.device" ], "summary" : "IoT设备绑定球房", "description" : "同步IoT设备、商户和球房的绑定关系", "operationId" : "alipay.merchant.iot.device.bind", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantIotDeviceBindResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMerchantIotDeviceBindErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantIotDeviceBindModel" } } }, "required" : false } } }, "/v3/alipay/merchant/iot/device/query" : { "get" : { "tags" : [ "alipay.merchant.iot.device" ], "summary" : "IoT设备绑定关系查询", "description" : "通过设备唯一标识查询设备绑定关系", "operationId" : "alipay.merchant.iot.device.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantIotDeviceQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMerchantIotDeviceQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "device_id_type", "in" : "query", "description" : "可选方式 [ID,SN]。ID-使用biztid作为设备唯一识别标识；SN-使用supplier_id、device_sn联合作为设备唯一识别标识。由于不同机型的supplier_id不同，推荐使用 ID 。", "schema" : { "type" : "string", "example" : "SN" } }, { "name" : "biz_tid", "in" : "query", "description" : "设备 ID ，device_id_type 为 ID 时填写。", "schema" : { "type" : "string", "example" : "01017gV1CZ1XxASNbqkTJqchletNyVXtsKy1PAs4FKZ6tjRMqyMG2Zk" } }, { "name" : "supplier_id", "in" : "query", "description" : "设备供应商ID ，device_id_type 为 SN 时填写。需注意不同机型的供应商ID可能不同。", "schema" : { "type" : "string", "example" : "201812271300540049" } }, { "name" : "device_sn", "in" : "query", "description" : "设备序列号 ，device_id_type 为 SN 时填写。需配合supplier_id使用。", "schema" : { "type" : "string", "example" : "QCF420190316000107" } } ] } }, "/v3/alipay/merchant/iot/device/verify" : { "post" : { "tags" : [ "alipay.merchant.iot.device" ], "summary" : "IoT设备绑定校验", "description" : "校验IoT设备和商户收单账号的对应关系", "operationId" : "alipay.merchant.iot.device.verify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantIotDeviceVerifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMerchantIotDeviceVerifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantIotDeviceVerifyModel" } } }, "required" : false } } }, "/v3/alipay/merchant/item/file/upload" : { "post" : { "tags" : [ "alipay.merchant.item.file" ], "summary" : "商品文件上传接口", "description" : "商户把商品对应的图片文件、普通文件信息上传到支付宝，后续通过该接口返回的素材ID来和支付宝交互", "operationId" : "alipay.merchant.item.file.upload", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantItemFileUploadResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMerchantItemFileUploadErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AlipayMerchantItemFileUploadModel" }, "file_content" : { "type" : "string", "format" : "binary" } } }, "encoding" : { "file_content" : { "contentType" : "*/*" }, "data" : { "contentType" : "application/json" } } } }, "required" : false } } }, "/v3/alipay/merchant/live/channel/query" : { "get" : { "tags" : [ "alipay.merchant.live.channel" ], "summary" : "渠道信息查询", "description" : "根据直播等内容域跳转小程序下单时携带的orderStartId，回查业务主体信息(如操作人、主播、直播、文章等，用于外部业务信息补全、返佣等)。", "operationId" : "alipay.merchant.live.channel.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantLiveChannelQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMerchantLiveChannelQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "secret", "in" : "query", "description" : "渠道下单参数(orderStartId)", "schema" : { "type" : "string", "example" : "b07d6694341b69c406522d3ff28d9807" } } ] } }, "/v3/alipay/merchant/live/itemplan/modify" : { "post" : { "tags" : [ "alipay.merchant.live.itemplan" ], "summary" : "支付宝货品推广计划创建", "description" : "支付宝货品推广计划创建", "operationId" : "alipay.merchant.live.itemplan.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantLiveItemplanModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMerchantLiveItemplanModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantLiveItemplanModifyModel" } } }, "required" : false } } }, "/v3/alipay/merchant/order/sync" : { "post" : { "tags" : [ "alipay.merchant.order" ], "summary" : "订单数据同步接口", "description" : "商户可以调用此接口同步交易对应的订单数据", "operationId" : "alipay.merchant.order.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantOrderSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMerchantOrderSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantOrderSyncModel" } } }, "required" : false } } }, "/v3/alipay/merchant/tradecomplain/batchquery" : { "post" : { "tags" : [ "alipay.merchant.tradecomplain" ], "summary" : "查询交易投诉列表", "description" : "开发者根据其应用id查询用户在其应用（小程序、生活号）的投诉单列表记录。投诉单列表以分页查询方式返回。", "operationId" : "alipay.merchant.tradecomplain.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantTradecomplainBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMerchantTradecomplainBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantTradecomplainBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/merchant/tradecomplain/feedback" : { "post" : { "tags" : [ "alipay.merchant.tradecomplain.feedback" ], "summary" : "商家处理交易投诉", "description" : "商户请求交易投诉处理API，上传处理类型、处理内容描述及图片凭证。其中上传图片凭证需要先通过\"商户上传处理图片\"接口获取图片id，再将图片id设置到接口请求中。", "operationId" : "alipay.merchant.tradecomplain.feedback.submit", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantTradecomplainFeedbackSubmitResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMerchantTradecomplainFeedbackSubmitErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantTradecomplainFeedbackSubmitModel" } } }, "required" : false } } }, "/v3/alipay/merchant/tradecomplain/reply" : { "post" : { "tags" : [ "alipay.merchant.tradecomplain.reply" ], "summary" : "商家留言回复", "description" : "投诉单状态在“商家待处理”或“商家已反馈”或“商家处理超时”状态下，若有内容需要补充说明，可使用此接口提交文字或图片", "operationId" : "alipay.merchant.tradecomplain.reply.submit", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantTradecomplainReplySubmitResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMerchantTradecomplainReplySubmitErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantTradecomplainReplySubmitModel" } } }, "required" : false } } }, "/v3/alipay/merchant/tradecomplain/supplement" : { "post" : { "tags" : [ "alipay.merchant.tradecomplain.supplement" ], "summary" : "商家补充凭证", "description" : "投诉进入平台处理中状态时，为保证客服能准确判定责任方，可使用此接口补充文字或图片说明问题及处理经过", "operationId" : "alipay.merchant.tradecomplain.supplement.submit", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantTradecomplainSupplementSubmitResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMerchantTradecomplainSupplementSubmitErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantTradecomplainSupplementSubmitModel" } } }, "required" : false } } }, "/v3/alipay/merchant/tradecomplain/{complain_event_id}" : { "get" : { "tags" : [ "alipay.merchant.tradecomplain" ], "summary" : "查询单条交易投诉详情", "description" : "开发者根据支付宝侧投诉单号查询该笔投诉详细记录。", "operationId" : "alipay.merchant.tradecomplain.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMerchantTradecomplainQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMerchantTradecomplainQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "complain_event_id", "in" : "path", "description" : "支付宝侧投诉单号", "required" : true, "schema" : { "type" : "string", "example" : "2020092300102000000001459758" } } ] } }, "/v3/alipay/mobile/public/follow/list" : { "get" : { "tags" : [ "alipay.mobile.public.follow" ], "summary" : "获取关注者列表", "description" : "公众号可通过本接口来获取帐号的关注者列表，关注者列表由一串userId组成。一次拉取调用最多拉取10000个关注者的userId，可以通过多次拉取的方式来满足需求。\r\n公众号可通过本接口来获取帐号的关注者列表，关注者列表由一串userId组成。一次拉取调用最多拉取10000个关注者的userId，可以通过多次拉取的方式来满足需求。", "operationId" : "alipay.mobile.public.follow.list", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMobilePublicFollowListResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMobilePublicFollowListErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "biz_content", "in" : "query", "description" : "当nextUserId为空时,代表查询第一组,如果有值时以当前值为准查询下一组\r\t详情请见", "schema" : { "type" : "string", "example" : "{\"nextUserId\":\"2088102123322367\"}" } } ] } }, "/v3/alipay/mobile/public/info/query" : { "get" : { "tags" : [ "alipay.mobile.public.info" ], "summary" : "服务窗基础信息查询接口", "description" : "通过该接口查询服务窗名称、头像、欢迎语基础信息", "operationId" : "alipay.mobile.public.info.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMobilePublicInfoQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMobilePublicInfoQueryErrorResponseModel" } ] } } } } } } }, "/v3/alipay/mobile/public/menu/add" : { "post" : { "tags" : [ "alipay.mobile.public.menu" ], "summary" : "创建菜单", "description" : "通过POST一个特定的结构体，实现支付宝钱包客户端的服务窗创建自定义菜单。本接口只可以调用一次，菜单已存在无需再次创建，今后只需要调用更新接口。", "operationId" : "alipay.mobile.public.menu.add", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMobilePublicMenuAddResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMobilePublicMenuAddErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMobilePublicMenuAddModel" } } }, "required" : false } } }, "/v3/alipay/mobile/public/menu/get" : { "get" : { "tags" : [ "alipay.mobile.public.menu" ], "summary" : "查询菜单", "description" : "查询当前使用的自定义菜单", "operationId" : "alipay.mobile.public.menu.get", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMobilePublicMenuGetResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMobilePublicMenuGetErrorResponseModel" } ] } } } } } } }, "/v3/alipay/mobile/public/menu/update" : { "post" : { "tags" : [ "alipay.mobile.public.menu" ], "summary" : "更新菜单", "description" : "通过POST一个特定结构体，实现支付宝钱包客户端的公众账号更新自定义菜单。每一次的更新是针对全部自定义菜单的更新。", "operationId" : "alipay.mobile.public.menu.update", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMobilePublicMenuUpdateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMobilePublicMenuUpdateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMobilePublicMenuUpdateModel" } } }, "required" : false } } }, "/v3/alipay/mobile/public/message/custom/send" : { "post" : { "tags" : [ "alipay.mobile.public.message.custom" ], "summary" : "异步单发消息", "description" : "异步单发消息", "operationId" : "alipay.mobile.public.message.custom.send", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMobilePublicMessageCustomSendResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMobilePublicMessageCustomSendErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMobilePublicMessageCustomSendModel" } } }, "required" : false } } }, "/v3/alipay/mobile/public/message/single/send" : { "post" : { "tags" : [ "alipay.mobile.public.message.single" ], "summary" : "单发模板消息", "description" : "单发模板消息", "operationId" : "alipay.mobile.public.message.single.send", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMobilePublicMessageSingleSendResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMobilePublicMessageSingleSendErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMobilePublicMessageSingleSendModel" } } }, "required" : false } } }, "/v3/alipay/mobile/public/message/total/send" : { "post" : { "tags" : [ "alipay.mobile.public.message.total" ], "summary" : "群发消息", "description" : "群发消息", "operationId" : "alipay.mobile.public.message.total.send", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMobilePublicMessageTotalSendResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMobilePublicMessageTotalSendErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMobilePublicMessageTotalSendModel" } } }, "required" : false } } }, "/v3/alipay/mobile/public/qrcode/create" : { "post" : { "tags" : [ "alipay.mobile.public.qrcode" ], "summary" : "生成带参数的二维码", "description" : "为了满足用户渠道推广分析的需要，公众平台提供了生成带参数二维码的接口。使用该接口可以获得多个带不同场景值的二维码，用户扫描后，公众号可以接收到事件推送。目前有2种类型的二维码，分别是临时二维码、和永久二维码，前者有过期时间，最大为1800秒。\r\n每次创建二维码ticket需要提供一个开发者自行设定的参数（scene_id）。", "operationId" : "alipay.mobile.public.qrcode.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMobilePublicQrcodeCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMobilePublicQrcodeCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMobilePublicQrcodeCreateModel" } } }, "required" : false } } }, "/v3/alipay/mobile/public/shortlink/create" : { "post" : { "tags" : [ "alipay.mobile.public.shortlink" ], "summary" : "服务窗短链自主生成接口", "description" : "商户通过本接口生成带自有场景标识的短链接", "operationId" : "alipay.mobile.public.shortlink.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMobilePublicShortlinkCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMobilePublicShortlinkCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMobilePublicShortlinkCreateModel" } } }, "required" : false } } }, "/v3/alipay/mobile/public/template/message/delete" : { "post" : { "tags" : [ "alipay.mobile.public.template.message" ], "summary" : "模板消息删除接口", "description" : "模板消息删除接口", "operationId" : "alipay.mobile.public.template.message.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMobilePublicTemplateMessageDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMobilePublicTemplateMessageDeleteErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMobilePublicTemplateMessageDeleteModel" } } }, "required" : false } } }, "/v3/alipay/mobile/public/template/message/get" : { "get" : { "tags" : [ "alipay.mobile.public.template.message" ], "summary" : "模板消息领取接口", "description" : "帮助服务窗从服务窗平台（fuwu.alipay.com）公共模板库里领取一个行业的消息模板--消息模板是一种消息的样式，如消费提醒、账单提醒等", "operationId" : "alipay.mobile.public.template.message.get", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMobilePublicTemplateMessageGetResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMobilePublicTemplateMessageGetErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "template_id", "in" : "query", "description" : "消息母板id", "schema" : { "type" : "string", "example" : "TM000000223" } } ] } }, "/v3/alipay/mobile/public/template/message/query" : { "post" : { "tags" : [ "alipay.mobile.public.template.message" ], "summary" : "模板消息查询接口", "description" : "模板消息查询接口", "operationId" : "alipay.mobile.public.template.message.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMobilePublicTemplateMessageQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMobilePublicTemplateMessageQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/AuthToken" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMobilePublicTemplateMessageQueryModel" } } }, "required" : false } } }, "/v3/alipay/mobile/std/public/message/custom/send" : { "post" : { "tags" : [ "alipay.mobile.std.public.message.custom" ], "summary" : "异步单发消息", "description" : "商户给单个用户发送消息", "operationId" : "alipay.mobile.std.public.message.custom.send", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMobileStdPublicMessageCustomSendResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayMobileStdPublicMessageCustomSendErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayMobileStdPublicMessageCustomSendModel" } } }, "required" : false } } }, "/v3/alipay/offline/market/applyorder/batchquery" : { "post" : { "tags" : [ "alipay.offline.market.applyorder" ], "summary" : "业务流水批量查询接口", "description" : "通过该接口分页查询Leads、球房、商品相关操作流水信息", "operationId" : "alipay.offline.market.applyorder.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOfflineMarketApplyorderBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOfflineMarketApplyorderBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOfflineMarketApplyorderBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/offline/market/shop/batchquery" : { "post" : { "tags" : [ "alipay.offline.market.shop" ], "summary" : "查询商户的球房编号列表", "description" : "系统商通过该接口可以查询对应APPID下所有的球房编号（支付宝口碑球房编号）", "operationId" : "alipay.offline.market.shop.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOfflineMarketShopBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOfflineMarketShopBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOfflineMarketShopBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/offline/market/shop/category/query" : { "get" : { "tags" : [ "alipay.offline.market.shop.category" ], "summary" : "球房类目配置查询接口", "description" : "用于查询可用于开店的类目，以及类目上的配置约束信息", "operationId" : "alipay.offline.market.shop.category.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOfflineMarketShopCategoryQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOfflineMarketShopCategoryQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "category_id", "in" : "query", "description" : "类目ID，如果为空则查询全部类目。", "schema" : { "type" : "string", "example" : "2015050700000000" } }, { "name" : "op_role", "in" : "query", "description" : "表示接口业务的调用方身份,默认不填标识为ISV。", "schema" : { "type" : "string", "example" : "ISV" } } ] } }, "/v3/alipay/offline/market/shop/create" : { "post" : { "tags" : [ "alipay.offline.market.shop" ], "summary" : "创建球房信息", "description" : "系统商需要通过该接口在口碑平台帮助商户创建球房信息。", "operationId" : "alipay.offline.market.shop.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOfflineMarketShopCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOfflineMarketShopCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOfflineMarketShopCreateModel" } } }, "required" : false } } }, "/v3/alipay/offline/market/shop/modify" : { "post" : { "tags" : [ "alipay.offline.market.shop" ], "summary" : "修改球房信息", "description" : "系统商需要通过该接口在口碑平台帮助商户修改球房信息，所有的选项都为非必填项，需要修改什么信息就传入什么参数，不传入的参数，则保持不变。修改球房名、品牌名、品牌logo、首图、球房图片、营业执照、营业执照编号、营业执照名称、经营许可证、经营许可证有效期、球房授权函、是否在其它平台开店、在其它平台开店照片，会重新触发风控审核，修改其他字段不会触发风控审核。", "operationId" : "alipay.offline.market.shop.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOfflineMarketShopModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOfflineMarketShopModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOfflineMarketShopModifyModel" } } }, "required" : false } } }, "/v3/alipay/offline/market/shop/querydetail" : { "get" : { "tags" : [ "alipay.offline.market.shop" ], "summary" : "查询单个球房信息接口", "description" : "系统商通过该接口可以查询单个球房的详细信息，包括球房基础信息，球房状态等信息", "operationId" : "alipay.offline.market.shop.querydetail", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOfflineMarketShopQuerydetailResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOfflineMarketShopQuerydetailErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "shop_id", "in" : "query", "description" : "支付宝球房ID", "schema" : { "type" : "string", "example" : "2015052100077000000000120773" } }, { "name" : "op_role", "in" : "query", "description" : "服务商及商户调用情况下务必传递。操作人角色，默认商户操作:MERCHANT；服务商操作：PROVIDER；ISV: 不需要填写", "schema" : { "type" : "string", "example" : "MERCHANT或PROVIDER" } } ] } }, "/v3/alipay/offline/market/shop/summary/batchquery" : { "post" : { "tags" : [ "alipay.offline.market.shop.summary" ], "summary" : "球房摘要信息批量查询接口", "description" : "用于进行球房摘要信息批量查询接口。", "operationId" : "alipay.offline.market.shop.summary.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOfflineMarketShopSummaryBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOfflineMarketShopSummaryBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOfflineMarketShopSummaryBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/offline/material/image/upload" : { "post" : { "tags" : [ "alipay.offline.material.image" ], "summary" : "上传球房照片和视频接口", "description" : "系统商需要先将商户需要使用的图片和视频，上传支付宝服务器,生成对应的图片ID后才能够在口碑平台上配置相应图片", "operationId" : "alipay.offline.material.image.upload", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOfflineMaterialImageUploadResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOfflineMaterialImageUploadErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AlipayOfflineMaterialImageUploadModel" }, "image_content" : { "type" : "string", "format" : "binary" } } }, "encoding" : { "data" : { "contentType" : "application/json" }, "image_content" : { "contentType" : "*/*" } } } }, "required" : false } } }, "/v3/alipay/open/agent/cancel" : { "post" : { "tags" : [ "alipay.open.agent" ], "summary" : "取消代商户签约、创建应用事务", "description" : "取消代商户签约、创建应用事务", "operationId" : "alipay.open.agent.cancel", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAgentCancelResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAgentCancelErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAgentCancelModel" } } }, "required" : false } } }, "/v3/alipay/open/agent/common/sign" : { "post" : { "tags" : [ "alipay.open.agent.common" ], "summary" : "代签约产品通用接口", "description" : "三方应用代理签约产品，需要配合开启事务接口使用", "operationId" : "alipay.open.agent.common.sign", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAgentCommonSignResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAgentCommonSignErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "app_demo" : { "type" : "string", "format" : "binary" }, "business_license_auth_pic" : { "type" : "string", "format" : "binary" }, "business_license_pic" : { "type" : "string", "format" : "binary" }, "data" : { "$ref" : "#/components/schemas/AlipayOpenAgentCommonSignModel" }, "mini_app_screenshot" : { "type" : "string", "format" : "binary" }, "shop_scene_pic" : { "type" : "string", "format" : "binary" }, "shop_sign_board_pic" : { "type" : "string", "format" : "binary" }, "special_license_pic" : { "type" : "string", "format" : "binary" }, "web_home_screenshot" : { "type" : "string", "format" : "binary" }, "web_item_screenshot" : { "type" : "string", "format" : "binary" }, "web_pay_screenshot" : { "type" : "string", "format" : "binary" }, "web_sites_loa" : { "type" : "string", "format" : "binary" } } }, "encoding" : { "web_pay_screenshot" : { "contentType" : "*/*" }, "shop_sign_board_pic" : { "contentType" : "*/*" }, "special_license_pic" : { "contentType" : "*/*" }, "web_sites_loa" : { "contentType" : "*/*" }, "business_license_pic" : { "contentType" : "*/*" }, "mini_app_screenshot" : { "contentType" : "*/*" }, "data" : { "contentType" : "application/json" }, "shop_scene_pic" : { "contentType" : "*/*" }, "app_demo" : { "contentType" : "*/*" }, "business_license_auth_pic" : { "contentType" : "*/*" }, "web_home_screenshot" : { "contentType" : "*/*" }, "web_item_screenshot" : { "contentType" : "*/*" } } } }, "required" : false } } }, "/v3/alipay/open/agent/commonsign/confirm" : { "post" : { "tags" : [ "alipay.open.agent.commonsign" ], "summary" : "代商户签约，提交信息确认接口", "description" : "三方应用代理签约产品，上传商户信息后，确认提交信息。可以配合开启事务接口使用。", "operationId" : "alipay.open.agent.commonsign.confirm", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAgentCommonsignConfirmResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAgentCommonsignConfirmErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAgentCommonsignConfirmModel" } } }, "required" : false } } }, "/v3/alipay/open/agent/confirm" : { "post" : { "tags" : [ "alipay.open.agent" ], "summary" : "提交代商户签约、创建应用事务", "description" : "提交事务。只允许提交init状态的事务，submit|cancel|timeout 状态的都是终态，不允许提交，且不允许提交空事务，需要先调用代创建小程序、代签约当面付等业务接口，再提交事务。服务市场订购及授权，使用订单授权凭证order_ticket开启的事务，提交后会有应用授权令牌返回。", "operationId" : "alipay.open.agent.confirm", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAgentConfirmResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAgentConfirmErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAgentConfirmModel" } } }, "required" : false } } }, "/v3/alipay/open/agent/create" : { "post" : { "tags" : [ "alipay.open.agent" ], "summary" : "开启代商户签约、创建应用事务", "description" : "在 ISV 代商户进行应用创建、产品签约时，用于开启一个操作事务，必须是第一个调用的接口。场景1：ISV 代商户进行应用创建、产品签约，最后提交事务后需要商户确认才能完成流程；场景2：服务市场订购及授权，使用订单授权凭证order_ticket开启预授权模式，该模式下提交事务后无需商户确认。", "operationId" : "alipay.open.agent.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAgentCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAgentCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAgentCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/agent/facetoface/sign" : { "post" : { "tags" : [ "alipay.open.agent.facetoface" ], "summary" : "代签约当面付产品", "description" : "三方应用代理签约当面付产品，需要配合开启事务接口使用", "operationId" : "alipay.open.agent.facetoface.sign", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAgentFacetofaceSignResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAgentFacetofaceSignErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "business_license_auth_pic" : { "type" : "string", "format" : "binary" }, "business_license_pic" : { "type" : "string", "format" : "binary" }, "data" : { "$ref" : "#/components/schemas/AlipayOpenAgentFacetofaceSignModel" }, "shop_scene_pic" : { "type" : "string", "format" : "binary" }, "shop_sign_board_pic" : { "type" : "string", "format" : "binary" }, "special_license_pic" : { "type" : "string", "format" : "binary" } } }, "encoding" : { "shop_sign_board_pic" : { "contentType" : "*/*" }, "special_license_pic" : { "contentType" : "*/*" }, "business_license_pic" : { "contentType" : "*/*" }, "data" : { "contentType" : "application/json" }, "shop_scene_pic" : { "contentType" : "*/*" }, "business_license_auth_pic" : { "contentType" : "*/*" } } } }, "required" : false } } }, "/v3/alipay/open/agent/mini/create" : { "post" : { "tags" : [ "alipay.open.agent.mini" ], "summary" : "代商家创建小程序应用", "description" : "ISV 代商家创建小程序应用。该接口后续将不再更新迭代，请使用新接口对接开发。新接口介绍文档：https://opendocs.alipay.com/isv/03kqzh ；新接口对接文档：https://opendocs.alipay.com/mini/03l21u 。", "operationId" : "alipay.open.agent.mini.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAgentMiniCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAgentMiniCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "app_logo" : { "type" : "string", "format" : "binary" }, "data" : { "$ref" : "#/components/schemas/AlipayOpenAgentMiniCreateModel" } } }, "encoding" : { "app_logo" : { "contentType" : "*/*" }, "data" : { "contentType" : "application/json" } } } }, "required" : false } } }, "/v3/alipay/open/agent/mobilepay/sign" : { "post" : { "tags" : [ "alipay.open.agent.mobilepay" ], "summary" : "代签约APP支付产品", "description" : "三方应用代理签约APP支付产品，需要配合开启事务接口使用", "operationId" : "alipay.open.agent.mobilepay.sign", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAgentMobilepaySignResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAgentMobilepaySignErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "app_auth_pic" : { "type" : "string", "format" : "binary" }, "app_demo" : { "type" : "string", "format" : "binary" }, "business_license_auth_pic" : { "type" : "string", "format" : "binary" }, "business_license_pic" : { "type" : "string", "format" : "binary" }, "data" : { "$ref" : "#/components/schemas/AlipayOpenAgentMobilepaySignModel" }, "home_screenshot" : { "type" : "string", "format" : "binary" }, "in_app_screenshot" : { "type" : "string", "format" : "binary" }, "pay_screenshot" : { "type" : "string", "format" : "binary" }, "special_license_pic" : { "type" : "string", "format" : "binary" } } }, "encoding" : { "special_license_pic" : { "contentType" : "*/*" }, "business_license_pic" : { "contentType" : "*/*" }, "data" : { "contentType" : "application/json" }, "app_demo" : { "contentType" : "*/*" }, "business_license_auth_pic" : { "contentType" : "*/*" }, "in_app_screenshot" : { "contentType" : "*/*" }, "app_auth_pic" : { "contentType" : "*/*" }, "pay_screenshot" : { "contentType" : "*/*" }, "home_screenshot" : { "contentType" : "*/*" } } } }, "required" : false } } }, "/v3/alipay/open/agent/offlinepayment/sign" : { "post" : { "tags" : [ "alipay.open.agent.offlinepayment" ], "summary" : "代签约当面付快捷版产品", "description" : "三方应用代理签约当面付快捷版产品，需要配合开启事务接口使用", "operationId" : "alipay.open.agent.offlinepayment.sign", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAgentOfflinepaymentSignResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAgentOfflinepaymentSignErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "business_license_pic" : { "type" : "string", "format" : "binary" }, "data" : { "$ref" : "#/components/schemas/AlipayOpenAgentOfflinepaymentSignModel" }, "shop_scene_pic" : { "type" : "string", "format" : "binary" }, "shop_sign_board_pic" : { "type" : "string", "format" : "binary" }, "special_license_pic" : { "type" : "string", "format" : "binary" } } }, "encoding" : { "shop_sign_board_pic" : { "contentType" : "*/*" }, "special_license_pic" : { "contentType" : "*/*" }, "business_license_pic" : { "contentType" : "*/*" }, "data" : { "contentType" : "application/json" }, "shop_scene_pic" : { "contentType" : "*/*" } } } }, "required" : false } } }, "/v3/alipay/open/agent/order/query" : { "get" : { "tags" : [ "alipay.open.agent.order" ], "summary" : "查询申请单状态", "description" : "代签约产品提交后，查询对应申请单的情况", "operationId" : "alipay.open.agent.order.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAgentOrderQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAgentOrderQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "batch_no", "in" : "query", "description" : "ISV 代商户操作事务编号，通过调用alipay.open.agent.create(开启代商户签约、创建应用事务)接口返回，详见 https://opendocs.alipay.com/apis/api_50/alipay.open.agent.create/ 。", "schema" : { "type" : "string", "example" : "2017110616474516400082883" } } ] } }, "/v3/alipay/open/agent/signstatus/query" : { "post" : { "tags" : [ "alipay.open.agent.signstatus" ], "summary" : "查询商户某个产品的签约状态", "description" : "主要用在isv代理商户签约场景，用来查询商户签约某个产品的签约状态，可以配合\"第三方接入核心API\"功能包里的接口使用", "operationId" : "alipay.open.agent.signstatus.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAgentSignstatusQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAgentSignstatusQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAgentSignstatusQueryModel" } } }, "required" : false } } }, "/v3/alipay/open/app/api/field/apply" : { "post" : { "tags" : [ "alipay.open.app.api.field" ], "summary" : "申请获取接口用户敏感信息字段", "description" : "申请获取接口出参中用户敏感信息字段，应用使用视频或图片（至少选择一项上传），单个图片或视频不超过10M，最多可上传5张图片示例。", "operationId" : "alipay.open.app.api.field.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAppApiFieldApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAppApiFieldApplyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AlipayOpenAppApiFieldApplyModel" }, "picture_1" : { "type" : "string", "format" : "binary" }, "picture_2" : { "type" : "string", "format" : "binary" }, "picture_3" : { "type" : "string", "format" : "binary" }, "picture_4" : { "type" : "string", "format" : "binary" }, "picture_5" : { "type" : "string", "format" : "binary" }, "video" : { "type" : "string", "format" : "binary" } } }, "encoding" : { "data" : { "contentType" : "application/json" }, "picture_5" : { "contentType" : "*/*" }, "video" : { "contentType" : "*/*" }, "picture_2" : { "contentType" : "*/*" }, "picture_1" : { "contentType" : "*/*" }, "picture_4" : { "contentType" : "*/*" }, "picture_3" : { "contentType" : "*/*" } } } }, "required" : false } } }, "/v3/alipay/open/app/api/field/query" : { "get" : { "tags" : [ "alipay.open.app.api.field" ], "summary" : "用户信息申请记录查询", "description" : "查询用户信息申请记录，开发者发起请求时会基于当前发起请求的app_id进行查询，若为isv发起的三方代调用则以授权的商户app_id进行查询。", "operationId" : "alipay.open.app.api.field.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAppApiFieldQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAppApiFieldQueryErrorResponseModel" } ] } } } } } } }, "/v3/alipay/open/app/api/query" : { "get" : { "tags" : [ "alipay.open.app.api" ], "summary" : "查询应用可申请的接口出参敏感字段列表", "description" : "通过appId查询该应用下可申请的接口敏感字段信息", "operationId" : "alipay.open.app.api.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAppApiQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAppApiQueryErrorResponseModel" } ] } } } } } } }, "/v3/alipay/open/app/api/scene/query" : { "get" : { "tags" : [ "alipay.open.app.api.scene" ], "summary" : "查询接口字段使用场景", "description" : "在申请接口出参中用户敏感信息字段时，本接口用于获取所申请接口字段的使用场景", "operationId" : "alipay.open.app.api.scene.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAppApiSceneQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAppApiSceneQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "field_name", "in" : "query", "description" : "接口出参字段英文名。", "schema" : { "type" : "string", "example" : "mobile" } }, { "name" : "api_name", "in" : "query", "description" : "接口英文名。", "schema" : { "type" : "string", "example" : "alipay.user.info.share" } } ] } }, "/v3/alipay/open/app/members/create" : { "post" : { "tags" : [ "alipay.open.app.members" ], "summary" : "应用添加成员", "description" : "应用添加成员，目前只支持小程序类型的应用使用", "operationId" : "alipay.open.app.members.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAppMembersCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAppMembersCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAppMembersCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/app/members/delete" : { "delete" : { "tags" : [ "alipay.open.app.members" ], "summary" : "应用删除成员", "description" : "删除应用成员，目前只支持小程序类型的应用", "operationId" : "alipay.open.app.members.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAppMembersDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAppMembersDeleteErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "user_id", "in" : "query", "description" : "被删除成员的支付宝账户唯一标识，以2088开头。", "schema" : { "type" : "string", "example" : "2088222943898172" } }, { "name" : "open_id", "in" : "query", "description" : "被删除成员的openId。", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } }, { "name" : "role", "in" : "query", "description" : "被删除成员的角色类型，枚举支持：\tDEVELOPER：开发者。\tEXPERIENCER：体验者。", "schema" : { "type" : "string", "example" : "DEVELOPER" } } ] } }, "/v3/alipay/open/app/members/query" : { "get" : { "tags" : [ "alipay.open.app.members" ], "summary" : "应用查询成员列表", "description" : "应用查询成员列表，目前只支持小程序类型的应用", "operationId" : "alipay.open.app.members.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAppMembersQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAppMembersQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "role", "in" : "query", "description" : "查询的成员角色类型。\t枚举支持：\tDEVELOPER：开发者；\tEXPERIENCER：体验者。\t请选择其一传入", "schema" : { "type" : "string", "example" : "DEVELOPER" } } ] } }, "/v3/alipay/open/app/messagetemplate/subscribe/query" : { "post" : { "tags" : [ "alipay.open.app.messagetemplate.subscribe" ], "summary" : "模板订阅关系查询", "description" : "商户使用该接口可以查询用户对其消息模板的订阅关系，可以根据是否订阅引导用户进行订阅和精准触达消息", "operationId" : "alipay.open.app.messagetemplate.subscribe.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAppMessagetemplateSubscribeQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAppMessagetemplateSubscribeQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAppMessagetemplateSubscribeQueryModel" } } }, "required" : false } } }, "/v3/alipay/open/app/mini/templatemessage/send" : { "post" : { "tags" : [ "alipay.open.app.mini.templatemessage" ], "summary" : "小程序发送模板消息", "description" : "小程序通过openapi给用户触达消息，主要为支付后的触达（通过消费id）、用户提交表单后的触达（通过formId）、刷脸后的触达（通过ftoken）以及用户订阅消息模板后的触达。", "operationId" : "alipay.open.app.mini.templatemessage.send", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAppMiniTemplatemessageSendResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAppMiniTemplatemessageSendErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAppMiniTemplatemessageSendModel" } } }, "required" : false } } }, "/v3/alipay/open/app/qrcode/create" : { "post" : { "tags" : [ "alipay.open.app.qrcode" ], "summary" : "小程序生成推广二维码接口", "description" : "生成小程序推广二维码", "operationId" : "alipay.open.app.qrcode.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAppQrcodeCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAppQrcodeCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAppQrcodeCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/app/service/apply" : { "post" : { "tags" : [ "alipay.open.app.service" ], "summary" : "服务提报申请", "description" : "服务提报申请", "operationId" : "alipay.open.app.service.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAppServiceApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAppServiceApplyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAppServiceApplyModel" } } }, "required" : false } } }, "/v3/alipay/open/app/service/delete" : { "delete" : { "tags" : [ "alipay.open.app.service" ], "summary" : "服务失效接口", "description" : "服务失效", "operationId" : "alipay.open.app.service.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAppServiceDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAppServiceDeleteErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "service_code", "in" : "query", "description" : "服务id", "schema" : { "type" : "string", "example" : "12522641" } } ] } }, "/v3/alipay/open/app/service/list/query" : { "get" : { "tags" : [ "alipay.open.app.service.list" ], "summary" : "服务批量查询", "description" : "服务批量分页查询", "operationId" : "alipay.open.app.service.list.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAppServiceListQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAppServiceListQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "service_name", "in" : "query", "description" : "服务名称", "schema" : { "type" : "string", "example" : "肯德基" } }, { "name" : "category_id", "in" : "query", "description" : "类目", "schema" : { "type" : "string", "example" : "C15484611" } }, { "name" : "page_size", "in" : "query", "description" : "每页记录数", "schema" : { "type" : "integer", "example" : "10" } }, { "name" : "page_num", "in" : "query", "description" : "页码", "schema" : { "type" : "integer", "example" : "1" } } ] } }, "/v3/alipay/open/app/service/query" : { "get" : { "tags" : [ "alipay.open.app.service" ], "summary" : "服务查询", "description" : "服务查询", "operationId" : "alipay.open.app.service.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAppServiceQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAppServiceQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "service_code", "in" : "query", "description" : "服务id", "schema" : { "type" : "string", "example" : "s1111" } } ] } }, "/v3/alipay/open/app/service/schema/query" : { "get" : { "tags" : [ "alipay.open.app.service.schema" ], "summary" : "服务schema下发", "description" : "服务schema查询下发", "operationId" : "alipay.open.app.service.schema.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAppServiceSchemaQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAppServiceSchemaQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "category_id", "in" : "query", "description" : "类目id", "schema" : { "type" : "string", "example" : "c11111" } }, { "name" : "template_type", "in" : "query", "description" : "服务模版类型。若当前服务类目只有一个服务模版，可不填。", "schema" : { "type" : "string", "example" : "DEFAULT" } } ] } }, "/v3/alipay/open/app/test/gray/create" : { "post" : { "tags" : [ "alipay.open.app.test.gray" ], "summary" : "openapi-oas3.0灰度", "description" : "openapi，oas3.0灰度", "operationId" : "alipay.open.app.test.gray.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAppTestGrayCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAppTestGrayCreateErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "a", "in" : "query", "description" : "a", "schema" : { "type" : "string", "example" : "a1" } }, { "name" : "oid", "in" : "query", "description" : "1", "schema" : { "type" : "string", "example" : "111" } }, { "name" : "b", "in" : "query", "description" : "生", "schema" : { "type" : "string", "example" : "b2" } }, { "name" : "c", "in" : "query", "description" : "c1", "schema" : { "type" : "string", "example" : "c1" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAppTestGrayCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/app/test/gray/query" : { "get" : { "tags" : [ "alipay.open.app.test.gray" ], "summary" : "GET方法测试", "description" : "oas get", "operationId" : "alipay.open.app.test.gray.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAppTestGrayQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAppTestGrayQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "latitude", "in" : "query", "description" : "纬度", "schema" : { "type" : "string", "example" : "123" } }, { "name" : "city_id", "in" : "query", "description" : "1", "schema" : { "type" : "string", "example" : "1" } }, { "name" : "uid", "in" : "query", "description" : "1", "schema" : { "type" : "string", "example" : "1" } }, { "name" : "buy_open_id", "in" : "query", "description" : "1", "schema" : { "type" : "string", "example" : "1" } } ] } }, "/v3/alipay/open/auth/app/aes/get" : { "get" : { "tags" : [ "alipay.open.auth.app.aes" ], "summary" : "授权应用aes密钥查询", "description" : "商家应用授权给ISV服务商代管理应用场景下，ISV开发者使用三方应用appId发起调用，通过该接口获取商户应用的AES密钥。接口返回的商户应用aes密钥内容为加密内容，需要ISV使用三方应用的AES密钥对接口返回进行解密。java sdk内部会自动完成解密返回明文内容。SDK AES加解密支持", "operationId" : "alipay.open.auth.app.aes.get", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAuthAppAesGetResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAuthAppAesGetErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "merchant_app_id", "in" : "query", "description" : "商家应用appId", "schema" : { "type" : "string", "example" : "20191223601234564" } } ] } }, "/v3/alipay/open/auth/app/aes/set" : { "post" : { "tags" : [ "alipay.open.auth.app.aes" ], "summary" : "授权应用aes密钥设置", "description" : "商家应用授权给ISV服务商代管理应用场景下，ISV开发者使用三方应用appId发起调用，通过该接口设置商户应用的AES密钥。接口返回的商户应用aes密钥内容为加密内容，需要ISV使用三方应用的AES密钥对接口返回进行解密。java sdk内部会自动完成解密返回明文内容。SDK AES加解密支持。", "operationId" : "alipay.open.auth.app.aes.set", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAuthAppAesSetResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAuthAppAesSetErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAuthAppAesSetModel" } } }, "required" : false } } }, "/v3/alipay/open/auth/token/app" : { "post" : { "tags" : [ "alipay.open.auth.token" ], "summary" : "换取应用授权令牌", "description" : "换取应用授权令牌。在应用授权的场景下，商户把名下应用授权给ISV后，支付宝会给ISV颁发应用授权码app_auth_code，ISV可通过获取到的app_auth_code换取app_auth_token。app_auth_code作为换取app_auth_token的票据，每次用户授权带上的app_auth_code将不一样，app_auth_code只能使用一次，一天（从当前时间算起的24小时）未被使用自动过期。\r\n刷新应用授权令牌，ISV可通过获取到的refresh_token刷新app_auth_token，刷新后老的refresh_token会在一段时间后失效（失效时间为接口返回的re_expires_in）。", "operationId" : "alipay.open.auth.token.app", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAuthTokenAppResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAuthTokenAppErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAuthTokenAppModel" } } }, "required" : false } } }, "/v3/alipay/open/auth/token/app/query" : { "get" : { "tags" : [ "alipay.open.auth.token.app" ], "summary" : "查询某个应用授权AppAuthToken的授权信息", "description" : "当商户把服务窗、店铺等接口的权限授权给ISV之后，支付宝会给ISV颁发一个app_auth_token。如若授权成功之后，ISV想知道用户的授权信息，如授权者、授权接口列表等信息，可以调用本接口查询某个app_auth_token对应的授权信息", "operationId" : "alipay.open.auth.token.app.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAuthTokenAppQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAuthTokenAppQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "app_auth_token", "in" : "query", "description" : "应用授权令牌", "schema" : { "type" : "string", "example" : "201509BBeff9351ad1874306903e96b91d248A36" } } ] } }, "/v3/alipay/open/auth/userauth/relationship/query" : { "get" : { "tags" : [ "alipay.open.auth.userauth.relationship" ], "summary" : "用户授权关系查询", "description" : "校验本应用和用户的授权关系有效性", "operationId" : "alipay.open.auth.userauth.relationship.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenAuthUserauthRelationshipQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenAuthUserauthRelationshipQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "user_id", "in" : "query", "description" : "蚂蚁统一会员ID，如果未开启openid改造，则此值必传", "schema" : { "type" : "string", "example" : "2088123443211234" } }, { "name" : "open_id", "in" : "query", "description" : "蚂蚁统一会员ID，蚂蚁统一会员ID，如果已完成openid改造，则此值必传", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } }, { "name" : "scopes", "in" : "query", "description" : "查询授权关系所关联的scope，半角逗号分隔的列表，且不允许有重复值", "schema" : { "type" : "string", "example" : "auth_user,auth_zhima" } } ] } }, "/v3/alipay/open/biz/create" : { "post" : { "tags" : [ "alipay.open.biz" ], "summary" : "bizcontent测试12", "description" : "bizcontent测试12", "operationId" : "alipay.open.biz.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenBizCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenBizCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenBizCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/fee/adjust/apply" : { "post" : { "tags" : [ "alipay.open.fee.adjust" ], "summary" : "特殊费率申请", "description" : "服务商替代签约或交易传参的商户申请费率", "operationId" : "alipay.open.fee.adjust.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenFeeAdjustApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenFeeAdjustApplyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "attachment" : { "type" : "string", "format" : "binary" }, "cert_pic" : { "type" : "string", "format" : "binary" }, "data" : { "$ref" : "#/components/schemas/AlipayOpenFeeAdjustApplyModel" }, "shop_scene_pic" : { "type" : "string", "format" : "binary" }, "shop_sign_pic" : { "type" : "string", "format" : "binary" } } }, "encoding" : { "data" : { "contentType" : "application/json" }, "shop_scene_pic" : { "contentType" : "*/*" }, "attachment" : { "contentType" : "*/*" }, "shop_sign_pic" : { "contentType" : "*/*" }, "cert_pic" : { "contentType" : "*/*" } } } }, "required" : false } } }, "/v3/alipay/open/file/upload" : { "post" : { "tags" : [ "alipay.open.file" ], "summary" : "支付宝文件上传接口", "description" : "支付宝通用文件上传接口，支付宝开发者可以调用此接口上传文件，文件可以提供给其他业务使用，例如：上传素材（视频/图片），素材可以供给到生活号+/小程序等其他开放应用后正式发布。\n该接口支持使用支付宝SDK和HTTP POST请求，两种方式示例如下：\n1. 使用支付宝SDK时，可以直接使用FileItem上传，代码片段参考下文\n2. 使用直接使用http协议时，需要忽略file_content参数，文件放入表单中，其余参数放入URL中，其中将参数（不包括文件和file_content）按自行实现签名文档实现，示例：\ncurl --request POST 'http://openapi.alipay.com/gateway.do?charset=GBK&biz_content=%7B%22biz_code%22%3A%22content_creation%22%2C%22extra_parameters%22%3A%7B%22extern_upload%22%3A%22youku%22%2C%22alipay_user_id%22%3A%22xxxx%22%7D%7D&method=alipay.open.file.upload&format=json&sign=xxx&app_id=2014060600164699&version=1.0&sign_type=RSA2×tamp=xxx' --form 'file=@\"xx.mp4\"'", "operationId" : "alipay.open.file.upload", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenFileUploadResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenFileUploadErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AlipayOpenFileUploadModel" }, "file_content" : { "type" : "string", "format" : "binary" } } }, "encoding" : { "file_content" : { "contentType" : "*/*" }, "data" : { "contentType" : "application/json" } } } }, "required" : false } } }, "/v3/alipay/open/instantdelivery/account/create" : { "post" : { "tags" : [ "alipay.open.instantdelivery.account" ], "summary" : "即时配送商家账户创建", "description" : "商家入驻开放平台，接入即时配送服务，调用即时配送公司的接口创建账户", "operationId" : "alipay.open.instantdelivery.account.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenInstantdeliveryAccountCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenInstantdeliveryAccountCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenInstantdeliveryAccountCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/instantdelivery/account/query" : { "get" : { "tags" : [ "alipay.open.instantdelivery.account" ], "summary" : "即时配送商家账户查询", "description" : "即时配送业务，查询商家账户信息", "operationId" : "alipay.open.instantdelivery.account.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenInstantdeliveryAccountQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenInstantdeliveryAccountQueryErrorResponseModel" } ] } } } } } } }, "/v3/alipay/open/instantdelivery/merchantagreement/query" : { "get" : { "tags" : [ "alipay.open.instantdelivery.merchantagreement" ], "summary" : "协议签署查询api", "description" : "协议签署查询api, 提供isv查询商户物流代扣协议签署情况", "operationId" : "alipay.open.instantdelivery.merchantagreement.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenInstantdeliveryMerchantagreementQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenInstantdeliveryMerchantagreementQueryErrorResponseModel" } ] } } } } } } }, "/v3/alipay/open/instantdelivery/merchantagreement/sign" : { "post" : { "tags" : [ "alipay.open.instantdelivery.merchantagreement" ], "summary" : "即时配送中商家代扣协议签署", "description" : "即时配送中商家代扣协议签署", "operationId" : "alipay.open.instantdelivery.merchantagreement.sign", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenInstantdeliveryMerchantagreementSignResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenInstantdeliveryMerchantagreementSignErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenInstantdeliveryMerchantagreementSignModel" } } }, "required" : false } } }, "/v3/alipay/open/instantdelivery/merchantshop/batchquery" : { "post" : { "tags" : [ "alipay.open.instantdelivery.merchantshop" ], "summary" : "即时配送商家球房分页查询", "description" : "即时配送场景，商家球房信息分页查询", "operationId" : "alipay.open.instantdelivery.merchantshop.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenInstantdeliveryMerchantshopBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenInstantdeliveryMerchantshopBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenInstantdeliveryMerchantshopBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/open/instantdelivery/merchantshop/create" : { "post" : { "tags" : [ "alipay.open.instantdelivery.merchantshop" ], "summary" : "即时配送商家球房创建", "description" : "帮商家在即时配送公司创建球房。名称+地址必须全局唯一；pid下的shopNo必须唯一。", "operationId" : "alipay.open.instantdelivery.merchantshop.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenInstantdeliveryMerchantshopCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenInstantdeliveryMerchantshopCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenInstantdeliveryMerchantshopCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/instantdelivery/merchantshop/modify" : { "post" : { "tags" : [ "alipay.open.instantdelivery.merchantshop" ], "summary" : "即时配送商家球房更新", "description" : "帮商家更新在即时配送公司的球房", "operationId" : "alipay.open.instantdelivery.merchantshop.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenInstantdeliveryMerchantshopModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenInstantdeliveryMerchantshopModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenInstantdeliveryMerchantshopModifyModel" } } }, "required" : false } } }, "/v3/alipay/open/instantdelivery/merchantshop/query" : { "get" : { "tags" : [ "alipay.open.instantdelivery.merchantshop" ], "summary" : "即时配送商家球房详情查询", "description" : "即时配送场景，查询商家球房详情信息。", "operationId" : "alipay.open.instantdelivery.merchantshop.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenInstantdeliveryMerchantshopQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenInstantdeliveryMerchantshopQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "shop_no", "in" : "query", "description" : "商家球房编码。", "schema" : { "type" : "string", "example" : "1000" } } ] } }, "/v3/alipay/open/invite/order/query" : { "get" : { "tags" : [ "alipay.open.invite.order" ], "summary" : "查询签约申请单状态", "description" : "创建签约授权流程后，查询对应产品签约申请单的状态", "operationId" : "alipay.open.invite.order.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenInviteOrderQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenInviteOrderQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "isv_biz_id", "in" : "query", "description" : "isv业务系统单据编号", "schema" : { "type" : "string", "example" : "2017110616474516400082883" } }, { "name" : "alipay_logon_id", "in" : "query", "description" : "商家的支付宝账号，如果调用alipay.open.invite.order.create接口时有传入支付宝账号，则这里查询签约状态时必须要传", "schema" : { "type" : "string", "example" : "fykevbdz6766@alitest.com" } } ] } }, "/v3/alipay/open/mini/appdeploy/byappid/query" : { "get" : { "tags" : [ "alipay.open.mini.appdeploy.byappid" ], "summary" : "根据APPID分页查询小程序发布信息", "description" : "用于伙伴平台面向开发者提供查询小程序发布能力", "operationId" : "alipay.open.mini.appdeploy.byappid.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniAppdeployByappidQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniAppdeployByappidQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "mini_app_id", "in" : "query", "description" : "小程序应用ID", "schema" : { "type" : "string", "example" : "2018XXXXXX" } }, { "name" : "bundle_id", "in" : "query", "description" : "端标识", "schema" : { "type" : "string", "example" : "com.amap.app" } }, { "name" : "inst_code", "in" : "query", "description" : "租户标识", "schema" : { "type" : "string", "example" : "alipay" } }, { "name" : "page_num", "in" : "query", "description" : "当前页，从1开始", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "每页个数", "schema" : { "type" : "integer", "example" : "20" } } ] } }, "/v3/alipay/open/mini/appdeploy/byappversion/query" : { "get" : { "tags" : [ "alipay.open.mini.appdeploy.byappversion" ], "summary" : "通过版本查询小程序发布", "description" : "伙伴平台使用，用于向开发者展示小程序发布信息", "operationId" : "alipay.open.mini.appdeploy.byappversion.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniAppdeployByappversionQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniAppdeployByappversionQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "mini_app_id", "in" : "query", "description" : "小程序ID", "schema" : { "type" : "string", "example" : "2011XXXXXXX" } }, { "name" : "bundle_id", "in" : "query", "description" : "端标识", "schema" : { "type" : "string", "example" : "com.amap.app" } }, { "name" : "inst_code", "in" : "query", "description" : "租户", "schema" : { "type" : "string", "example" : "alipay" } }, { "name" : "app_version", "in" : "query", "description" : "小程序版本", "schema" : { "type" : "string", "example" : "0.0.1" } } ] } }, "/v3/alipay/open/mini/appdeploy/bydeployversion/query" : { "get" : { "tags" : [ "alipay.open.mini.appdeploy.bydeployversion" ], "summary" : "根据发布版本查询小程序发布信息", "description" : "用于伙伴向开发者展示小程序发布信息", "operationId" : "alipay.open.mini.appdeploy.bydeployversion.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniAppdeployBydeployversionQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniAppdeployBydeployversionQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "bundle_id", "in" : "query", "description" : "客户端标识", "schema" : { "type" : "string", "example" : "com.amap.app" } }, { "name" : "mini_app_id", "in" : "query", "description" : "小程序ID", "schema" : { "type" : "string", "example" : "2021XXXXXX" } }, { "name" : "inst_code", "in" : "query", "description" : "租户", "schema" : { "type" : "string", "example" : "alipay" } }, { "name" : "deploy_version", "in" : "query", "description" : "发布标识", "schema" : { "type" : "string", "example" : "0.2.201910101.2" } } ] } }, "/v3/alipay/open/mini/baseinfo/modify" : { "post" : { "tags" : [ "alipay.open.mini.baseinfo" ], "summary" : "小程序修改基础信息", "description" : "小程序修改基础信息。\n本接口暂不支持已经上过架的小程序调用（只支持小程序首次上架之前修改信息）", "operationId" : "alipay.open.mini.baseinfo.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniBaseinfoModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniBaseinfoModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "app_logo" : { "type" : "string", "format" : "binary" }, "data" : { "$ref" : "#/components/schemas/AlipayOpenMiniBaseinfoModifyModel" } } }, "encoding" : { "app_logo" : { "contentType" : "*/*" }, "data" : { "contentType" : "application/json" } } } }, "required" : false } } }, "/v3/alipay/open/mini/baseinfo/name/check" : { "get" : { "tags" : [ "alipay.open.mini.baseinfo.name" ], "summary" : "小程序名称检测", "description" : "小程序名称检测。包含小程序名称基础校验、名称重复、存在敏感信息、存在品牌词、名称宽泛等检测能力。若返回“check_code”：“NONE”，说明小程序名称未检测出异常。", "operationId" : "alipay.open.mini.baseinfo.name.check", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniBaseinfoNameCheckResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniBaseinfoNameCheckErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "app_name", "in" : "query", "description" : "小程序名字，长度限制 3~30 个字符，仅支持包含简体中文、数字、英文、下划线、+、-。", "schema" : { "type" : "string", "example" : "吱声小铺" } } ] } }, "/v3/alipay/open/mini/baseinfo/query" : { "get" : { "tags" : [ "alipay.open.mini.baseinfo" ], "summary" : "查询小程序基础信息", "description" : "查询小程序基础信息", "operationId" : "alipay.open.mini.baseinfo.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniBaseinfoQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniBaseinfoQueryErrorResponseModel" } ] } } } } } } }, "/v3/alipay/open/mini/category/query" : { "get" : { "tags" : [ "alipay.open.mini.category" ], "summary" : "小程序类目树查询", "description" : "小程序类目树查询", "operationId" : "alipay.open.mini.category.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniCategoryQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniCategoryQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "is_filter", "in" : "query", "description" : "是否过滤小程序不可用类目。枚举值如下：\t* true：表示过滤不可用类目。\t* false：表示不过滤不可用类目。", "schema" : { "type" : "boolean", "example" : "true" } } ] } }, "/v3/alipay/open/mini/category/require/query" : { "post" : { "tags" : [ "alipay.open.mini.category.require" ], "summary" : "查询类目所需资质信息", "description" : "查询类目所需资质信息", "operationId" : "alipay.open.mini.category.require.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniCategoryRequireQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniCategoryRequireQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniCategoryRequireQueryModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/experience/cancel" : { "post" : { "tags" : [ "alipay.open.mini.experience" ], "summary" : "小程序取消体验版", "description" : "版本号为空", "operationId" : "alipay.open.mini.experience.cancel", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniExperienceCancelResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniExperienceCancelErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniExperienceCancelModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/experience/create" : { "post" : { "tags" : [ "alipay.open.mini.experience" ], "summary" : "小程序生成体验版", "description" : "小程序生成体验版", "operationId" : "alipay.open.mini.experience.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniExperienceCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniExperienceCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniExperienceCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/experience/query" : { "get" : { "tags" : [ "alipay.open.mini.experience" ], "summary" : "小程序体验版状态查询接口", "description" : "小程序体验版状态查询接口", "operationId" : "alipay.open.mini.experience.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniExperienceQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniExperienceQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "app_version", "in" : "query", "description" : "商家小程序版本号。", "schema" : { "type" : "string", "example" : "0.0.1" } }, { "name" : "bundle_id", "in" : "query", "description" : "小程序客户端类型，默认为支付宝端。支持如下入参：\tcom.alipay.alipaywallet：支付宝端；\tcom.alibaba.android.rimet：DINGDING端；\tcom.amap.app：高德端；\tcom.alibaba.ailabs.genie.webapps：天猫精灵端；\tcom.alipay.iot.xpaas：支付宝IoT端。", "schema" : { "type" : "string", "example" : "com.alipay.alipaywallet" } } ] } }, "/v3/alipay/open/mini/individual/business/certify" : { "post" : { "tags" : [ "alipay.open.mini.individual.business" ], "summary" : "个人账户升级为个体工商户", "description" : "小程序场景下，个体工商户具有和企业账户相同的能力，通过本接口，可以将符合资质的个人账户升级为个体工商户", "operationId" : "alipay.open.mini.individual.business.certify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniIndividualBusinessCertifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniIndividualBusinessCertifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniIndividualBusinessCertifyModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/inner/experience/cancel" : { "post" : { "tags" : [ "alipay.open.mini.inner.experience" ], "summary" : "内部链路取消体验版", "description" : "提供给内部一二方用于取消体验版", "operationId" : "alipay.open.mini.inner.experience.cancel", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerExperienceCancelResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerExperienceCancelErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerExperienceCancelModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/inner/members/add" : { "post" : { "tags" : [ "alipay.open.mini.inner.members" ], "summary" : "内部链路添加开发成员", "description" : "添加开发成员", "operationId" : "alipay.open.mini.inner.members.add", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerMembersAddResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerMembersAddErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerMembersAddModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/inner/members/delete" : { "delete" : { "tags" : [ "alipay.open.mini.inner.members" ], "summary" : "内部链路删除开发成员", "description" : "删除开发成员", "operationId" : "alipay.open.mini.inner.members.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerMembersDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerMembersDeleteErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "mini_app_id", "in" : "query", "description" : "业务小程序id", "schema" : { "type" : "string", "example" : "2021154987463214" } }, { "name" : "app_origin", "in" : "query", "description" : "业务来源", "schema" : { "type" : "string", "example" : "ALIPAY" } }, { "name" : "domain_account", "in" : "query", "description" : "域账号（如传入则删除联系人）", "schema" : { "type" : "string", "example" : "域账号" } }, { "name" : "login_id", "in" : "query", "description" : "登陆支付宝账号", "schema" : { "type" : "string", "example" : "登陆支付宝账号" } }, { "name" : "type", "in" : "query", "description" : "成员类型", "schema" : { "type" : "string", "example" : "1" } } ] } }, "/v3/alipay/open/mini/inner/members/query" : { "get" : { "tags" : [ "alipay.open.mini.inner.members" ], "summary" : "内部链路查询开发成员", "description" : "内部链路查询开发成员", "operationId" : "alipay.open.mini.inner.members.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerMembersQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerMembersQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "mini_app_id", "in" : "query", "description" : "业务小程序id", "schema" : { "type" : "string", "example" : "2021125487896547" } }, { "name" : "app_origin", "in" : "query", "description" : "业务来源", "schema" : { "type" : "string", "example" : "ALIPAY" } } ] } }, "/v3/alipay/open/mini/innerapp/create" : { "post" : { "tags" : [ "alipay.open.mini.innerapp" ], "summary" : "内部链路小程序创建", "description" : "小程序提供一套针对一二方场景的开发者提供一套统一的内部能力开放体系，定向输出赋能", "operationId" : "alipay.open.mini.innerapp.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerapp/plugin/order" : { "post" : { "tags" : [ "alipay.open.mini.innerapp.plugin" ], "summary" : "小程序代商户订购插件", "description" : "提供给二方场景下，代商家小程序订购、授权与签约插件", "operationId" : "alipay.open.mini.innerapp.plugin.order", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappPluginOrderResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappPluginOrderErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappPluginOrderModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerapp/pluginrelation/query" : { "post" : { "tags" : [ "alipay.open.mini.innerapp.pluginrelation" ], "summary" : "查询插件引用关系", "description" : "查询插件引用关系", "operationId" : "alipay.open.mini.innerapp.pluginrelation.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappPluginrelationQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappPluginrelationQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappPluginrelationQueryModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerapp/pluginservice/publish" : { "post" : { "tags" : [ "alipay.open.mini.innerapp.pluginservice" ], "summary" : "插件发布能力中心", "description" : "插件发布能力中心", "operationId" : "alipay.open.mini.innerapp.pluginservice.publish", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappPluginservicePublishResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappPluginservicePublishErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappPluginservicePublishModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerapp/pluginsyncmode/modify" : { "post" : { "tags" : [ "alipay.open.mini.innerapp.pluginsyncmode" ], "summary" : "修改插件继承模式", "description" : "修改插件继承模式，模板和插件使用关系是否自动继承到宿主小程序上", "operationId" : "alipay.open.mini.innerapp.pluginsyncmode.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappPluginsyncmodeModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappPluginsyncmodeModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappPluginsyncmodeModifyModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerapp/pluginuseconfig/cancel" : { "post" : { "tags" : [ "alipay.open.mini.innerapp.pluginuseconfig" ], "summary" : "撤销插件端版本配置灰度", "description" : "结束插件端版本配置灰度", "operationId" : "alipay.open.mini.innerapp.pluginuseconfig.cancel", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappPluginuseconfigCancelResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappPluginuseconfigCancelErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappPluginuseconfigCancelModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerapp/pluginuseconfig/online" : { "post" : { "tags" : [ "alipay.open.mini.innerapp.pluginuseconfig" ], "summary" : "上线插件使用端版本配置", "description" : "小程序使用插件版本全量上线", "operationId" : "alipay.open.mini.innerapp.pluginuseconfig.online", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappPluginuseconfigOnlineResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappPluginuseconfigOnlineErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappPluginuseconfigOnlineModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerapp/pluginuseconfig/upgrade" : { "post" : { "tags" : [ "alipay.open.mini.innerapp.pluginuseconfig" ], "summary" : "灰度端版本配置", "description" : "升级/降级 端版本配置", "operationId" : "alipay.open.mini.innerapp.pluginuseconfig.upgrade", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappPluginuseconfigUpgradeResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappPluginuseconfigUpgradeErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappPluginuseconfigUpgradeModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerapp/service/publish" : { "post" : { "tags" : [ "alipay.open.mini.innerapp.service" ], "summary" : "小程序模板发布服务市场", "description" : "小程序提供一套针对一二方场景的开发者提供一套统一的内部能力开放体系，定向输出赋能", "operationId" : "alipay.open.mini.innerapp.service.publish", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappServicePublishResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappServicePublishErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappServicePublishModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerapp/service/query" : { "get" : { "tags" : [ "alipay.open.mini.innerapp.service" ], "summary" : "小程序服务市场搜索", "description" : "小程序服务市场搜索，包括搜索模板和插件", "operationId" : "alipay.open.mini.innerapp.service.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappServiceQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerappServiceQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "mini_app_id", "in" : "query", "description" : "插件id或模板id", "schema" : { "type" : "string", "example" : "2012211102012056" } }, { "name" : "app_sub_type", "in" : "query", "description" : "小程序应用子类型", "schema" : { "type" : "string", "example" : "TINYAPP_TEMPLATE、TINYAPP_PLUGIN" } }, { "name" : "show_type", "in" : "query", "description" : "是否在服务市场透出，SHOW展示、HIDE隐藏", "schema" : { "type" : "string", "example" : "SHOW" } }, { "name" : "keyword", "in" : "query", "description" : "关键词", "schema" : { "type" : "string", "example" : "xxxx插件" } }, { "name" : "page_num", "in" : "query", "description" : "页码，默认第一页", "schema" : { "type" : "string", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "分页数，默认每页10个", "schema" : { "type" : "string", "example" : "10" } }, { "name" : "app_origin", "in" : "query", "description" : "业务来源，新接入方需要向支付宝申请专用来源，否则不予接入。https://yuque.antfin-inc.com/tinyapp-all/qddncu/bidushixiang", "schema" : { "type" : "string", "example" : "https://yuque.antfin-inc.com/tinyapp-all/qddncu/bidushixiang" } }, { "name" : "include_offline", "in" : "query", "description" : "是否需要展示offline状态插件，不传默认为false（不展示）", "schema" : { "type" : "boolean", "example" : "true" } } ] } }, "/v3/alipay/open/mini/innerbaseinfo/applogo/upload" : { "post" : { "tags" : [ "alipay.open.mini.innerbaseinfo.applogo" ], "summary" : "内部小程序-小程序logo图片上传", "description" : "上传小程序logo图片", "operationId" : "alipay.open.mini.innerbaseinfo.applogo.upload", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerbaseinfoApplogoUploadResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerbaseinfoApplogoUploadErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "app_logo" : { "type" : "string", "format" : "binary" } } }, "encoding" : { "app_logo" : { "contentType" : "*/*" } } } }, "required" : false } } }, "/v3/alipay/open/mini/innerbaseinfo/query" : { "get" : { "tags" : [ "alipay.open.mini.innerbaseinfo" ], "summary" : "内部小程序-应用信息查询", "description" : "查询小程序应用信息", "operationId" : "alipay.open.mini.innerbaseinfo.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerbaseinfoQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerbaseinfoQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "mini_app_id", "in" : "query", "description" : "小程序ID，mini_app_id 和 mini_app_name 两个需要有其中一个必填，当填了mini_app_id时只使用id去进行查询。", "schema" : { "type" : "string", "example" : "2014060600164699" } }, { "name" : "inst_code", "in" : "query", "description" : "租户code，alipay or taobao", "schema" : { "type" : "string", "example" : "taobao" } }, { "name" : "mini_app_name", "in" : "query", "description" : "小程序name，mini_app_id 和 mini_app_name 两个需要有其中一个必填，当填了mini_app_id时只使用id去进行查询。", "schema" : { "type" : "string", "example" : "test" } }, { "name" : "app_sub_type", "in" : "query", "description" : "小程序类型，TINYAPP_TEMPLATE，TINYAPP_NORMAL，TINYAPP_PLUGIN，使用mini_app_name查询的时候，该字段要求必传。", "schema" : { "type" : "string", "example" : "TINYAPP_TEMPLATE" } } ] } }, "/v3/alipay/open/mini/innerversion/audit/cancel" : { "post" : { "tags" : [ "alipay.open.mini.innerversion.audit" ], "summary" : "内部链路撤销审核", "description" : "小程序提供一套针对一二方场景的开发者提供一套统一的内部能力开放体系，定向输出赋能", "operationId" : "alipay.open.mini.innerversion.audit.cancel", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionAuditCancelResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionAuditCancelErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionAuditCancelModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerversion/audit/submit" : { "post" : { "tags" : [ "alipay.open.mini.innerversion.audit" ], "summary" : "小程序版本提交审核", "description" : "小程序版本提交审核，审核申请完结后会通过From蚂蚁消息通知到开发者。", "operationId" : "alipay.open.mini.innerversion.audit.submit", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionAuditSubmitResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionAuditSubmitErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionAuditSubmitModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerversion/backdev/publish" : { "post" : { "tags" : [ "alipay.open.mini.innerversion.backdev" ], "summary" : "内部链路小程序退回开发", "description" : "小程序提供一套针对一二方场景的开发者提供一套统一的内部能力开放体系，定向输出赋能", "operationId" : "alipay.open.mini.innerversion.backdev.publish", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionBackdevPublishResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionBackdevPublishErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionBackdevPublishModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerversion/beta/confirm" : { "post" : { "tags" : [ "alipay.open.mini.innerversion.beta" ], "summary" : "确认邀测结果", "description" : "小程序确认邀测结果", "operationId" : "alipay.open.mini.innerversion.beta.confirm", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionBetaConfirmResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionBetaConfirmErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionBetaConfirmModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerversion/betainfo/query" : { "get" : { "tags" : [ "alipay.open.mini.innerversion.betainfo" ], "summary" : "查看可邀测状态接口", "description" : "查看插件可邀测版本状态,邀测结果", "operationId" : "alipay.open.mini.innerversion.betainfo.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionBetainfoQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionBetainfoQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "plugin_id", "in" : "query", "description" : "插件ID", "schema" : { "type" : "string", "example" : "2021xxxx" } }, { "name" : "bundle_id", "in" : "query", "description" : "端信息", "schema" : { "type" : "string", "example" : "com.alipay.alipaywallet" } }, { "name" : "plugin_version", "in" : "query", "description" : "查询版本号", "schema" : { "type" : "string", "example" : "0.0.1" } }, { "name" : "app_origin", "in" : "query", "description" : "业务来源", "schema" : { "type" : "string", "example" : "ASTORE" } } ] } }, "/v3/alipay/open/mini/innerversion/buildaudit/submit" : { "post" : { "tags" : [ "alipay.open.mini.innerversion.buildaudit" ], "summary" : "内部链路小程序构建并提审", "description" : "内部链路小程序构建并提审", "operationId" : "alipay.open.mini.innerversion.buildaudit.submit", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionBuildauditSubmitResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionBuildauditSubmitErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionBuildauditSubmitModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerversion/condition/batchquery" : { "post" : { "tags" : [ "alipay.open.mini.innerversion.condition" ], "summary" : "根据状态批量查询版本信息", "description" : "小程序提供一套针对一二方场景的开发者提供一套统一的内部能力开放体系，定向输出赋能", "operationId" : "alipay.open.mini.innerversion.condition.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionConditionBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionConditionBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionConditionBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerversion/content/rollback" : { "post" : { "tags" : [ "alipay.open.mini.innerversion.content" ], "summary" : "内部链路回滚版本", "description" : "针对一二方场景的开发者，小程序提供一套统一的内部能力体系，定向输出赋能，本接口主要用于回滚版本\n", "operationId" : "alipay.open.mini.innerversion.content.rollback", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionContentRollbackResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionContentRollbackErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionContentRollbackModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerversion/gray/finish" : { "post" : { "tags" : [ "alipay.open.mini.innerversion.gray" ], "summary" : "内部链路结束灰度", "description" : "小程序提供一套针对一二方场景的开发者提供一套统一的内部能力开放体系，定向输出赋能", "operationId" : "alipay.open.mini.innerversion.gray.finish", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionGrayFinishResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionGrayFinishErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionGrayFinishModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerversion/gray/publish" : { "post" : { "tags" : [ "alipay.open.mini.innerversion.gray" ], "summary" : "内部链路小程序灰度上架", "description" : "小程序提供一套针对一二方场景的开发者提供一套统一的内部能力开放体系，定向输出赋能", "operationId" : "alipay.open.mini.innerversion.gray.publish", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionGrayPublishResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionGrayPublishErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionGrayPublishModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerversion/info/delete" : { "delete" : { "tags" : [ "alipay.open.mini.innerversion.info" ], "summary" : "内部链路删除版本", "description" : "针对一二方场景的开发者，小程序提供一套统一的内部能力体系，定向输出赋能，本接口主要用于删除版本", "operationId" : "alipay.open.mini.innerversion.info.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionInfoDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionInfoDeleteErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "mini_app_id", "in" : "query", "description" : "小程序ID", "schema" : { "type" : "string", "example" : "2018********" } }, { "name" : "app_origin", "in" : "query", "description" : "业务场景来源", "schema" : { "type" : "string", "example" : "ASTORE" } }, { "name" : "bundle_id", "in" : "query", "description" : "端信息", "schema" : { "type" : "string", "example" : "com.alipay.alipaywallet" } }, { "name" : "app_version", "in" : "query", "description" : "小程序版本号", "schema" : { "type" : "string", "example" : "0.0.1" } }, { "name" : "pid", "in" : "query", "description" : "操作者ID，支付宝租户必填", "schema" : { "type" : "string", "example" : "2088*******" } }, { "name" : "inst_code", "in" : "query", "description" : "租户信息", "schema" : { "type" : "string", "example" : "alipay" } } ] } }, "/v3/alipay/open/mini/innerversion/info/query" : { "get" : { "tags" : [ "alipay.open.mini.innerversion.info" ], "summary" : "内部链路小程序版本信息查询", "description" : "小程序提供一套针对一二方场景的开发者提供一套统一的内部能力开放体系，定向输出赋能", "operationId" : "alipay.open.mini.innerversion.info.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionInfoQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionInfoQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "bundle_id", "in" : "query", "description" : "端信息", "schema" : { "type" : "string", "example" : "支付宝：com.alipay.alipaywallet 高德：com.amap.app" } }, { "name" : "mini_app_id", "in" : "query", "description" : "小程序ID", "schema" : { "type" : "string", "example" : "2019****" } }, { "name" : "app_version", "in" : "query", "description" : "查询版本号", "schema" : { "type" : "string", "example" : "0.0.1" } }, { "name" : "app_origin", "in" : "query", "description" : "业务来源，新接入方需要向支付宝申请专用来源，否则不予接入。https://yuque.antfin-inc.com/tinyapp-all/qddncu/bidushixiang", "schema" : { "type" : "string", "example" : "https://yuque.antfin-inc.com/tinyapp-all/qddncu/bidushixiang" } } ] } }, "/v3/alipay/open/mini/innerversion/instantiation/query" : { "get" : { "tags" : [ "alipay.open.mini.innerversion.instantiation" ], "summary" : "小程序实例化关系查询", "description" : "用于通过模板实例化的小程序版本查询实例化关系", "operationId" : "alipay.open.mini.innerversion.instantiation.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionInstantiationQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionInstantiationQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "app_origin", "in" : "query", "description" : "来源类型，新接入方需要向支付宝申请专用来源，否则不予接入，申请方式请参见接入手册。", "schema" : { "type" : "string", "example" : "AAA" } }, { "name" : "bundle_id", "in" : "query", "description" : "端id", "schema" : { "type" : "string", "example" : "com.alipay.alipaywallet" } }, { "name" : "mini_app_id", "in" : "query", "description" : "小程序ID，特殊场景专用，普通业务方无需关注该参数。", "schema" : { "type" : "string", "example" : "2021000116680014" } }, { "name" : "app_version", "in" : "query", "description" : "实例化小程序版本号", "schema" : { "type" : "string", "example" : "0.0.1" } } ] } }, "/v3/alipay/open/mini/innerversion/last/query" : { "get" : { "tags" : [ "alipay.open.mini.innerversion.last" ], "summary" : "内部链路查询最新版本号", "description" : "针对一二方场景的开发者，小程序提供一套统一的内部能力体系，定向输出赋能，本接口主要用于查询最新版本号\n", "operationId" : "alipay.open.mini.innerversion.last.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionLastQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionLastQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "mini_app_id", "in" : "query", "description" : "小程序ID，仅特殊场景使用，普通业务方无需关注该参数。", "schema" : { "type" : "string", "example" : "2018********" } }, { "name" : "bundle_id", "in" : "query", "description" : "端信息", "schema" : { "type" : "string", "example" : "com.alipay.alipaywallet" } }, { "name" : "app_origin", "in" : "query", "description" : "业务来源场景", "schema" : { "type" : "string", "example" : "AAA" } }, { "name" : "pid", "in" : "query", "description" : "小程序主体", "schema" : { "type" : "string", "example" : "2088*******" } } ] } }, "/v3/alipay/open/mini/innerversion/modelforoffline/query" : { "get" : { "tags" : [ "alipay.open.mini.innerversion.modelforoffline" ], "summary" : "小程序线上版本包数据同步线下场景查询", "description" : "用于查询线上的版本包数据，同步到线下", "operationId" : "alipay.open.mini.innerversion.modelforoffline.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionModelforofflineQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionModelforofflineQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "mini_app_id", "in" : "query", "description" : "小程序ID", "schema" : { "type" : "string", "example" : "2018********" } }, { "name" : "app_version", "in" : "query", "description" : "版本号", "schema" : { "type" : "string", "example" : "0.0.1" } }, { "name" : "bundle_id", "in" : "query", "description" : "com.alipay.alipaywallet:支付包", "schema" : { "type" : "string", "example" : "com.alipay.alipaywallet" } }, { "name" : "inst_code", "in" : "query", "description" : "alipay:支付宝", "schema" : { "type" : "string", "example" : "alipay" } } ] } }, "/v3/alipay/open/mini/innerversion/nobuild/upload" : { "post" : { "tags" : [ "alipay.open.mini.innerversion.nobuild" ], "summary" : "手淘小程序产物包免构建版本上传", "description" : "手淘小程序产物包免构建版本上传", "operationId" : "alipay.open.mini.innerversion.nobuild.upload", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionNobuildUploadResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionNobuildUploadErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionNobuildUploadModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerversion/offline/publish" : { "post" : { "tags" : [ "alipay.open.mini.innerversion.offline" ], "summary" : "内部链路小程序下架", "description" : "小程序提供一套针对一二方场景的开发者提供一套统一的内部能力开放体系，定向输出赋能", "operationId" : "alipay.open.mini.innerversion.offline.publish", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionOfflinePublishResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionOfflinePublishErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionOfflinePublishModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerversion/online" : { "post" : { "tags" : [ "alipay.open.mini.innerversion" ], "summary" : "内部小程序-上架", "description" : "内部小程序上架接口", "operationId" : "alipay.open.mini.innerversion.online", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionOnlineResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionOnlineErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionOnlineModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerversion/online/publish" : { "post" : { "tags" : [ "alipay.open.mini.innerversion.online" ], "summary" : "内部链路小程序上架", "description" : "小程序提供一套针对一二方场景的开发者提供一套统一的内部能力开放体系，定向输出赋能", "operationId" : "alipay.open.mini.innerversion.online.publish", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionOnlinePublishResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionOnlinePublishErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionOnlinePublishModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerversion/package/create" : { "post" : { "tags" : [ "alipay.open.mini.innerversion.package" ], "summary" : "单独构建包信息", "description" : "内部OPENAPI 单独构建包信息。将构建链路中打预发包逻辑抽离出来，成为单独的能力，让伙伴等业务自己来调用", "operationId" : "alipay.open.mini.innerversion.package.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionPackageCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionPackageCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionPackageCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerversion/sync" : { "post" : { "tags" : [ "alipay.open.mini.innerversion" ], "summary" : "小程序包信息推送", "description" : "小程序上架、回滚，因拉包机制，用户无法及时生效，拉到原版本的用户，过期才会失效，该接口能力可以推送新版本到用户", "operationId" : "alipay.open.mini.innerversion.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionSyncModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerversion/templated/upload" : { "post" : { "tags" : [ "alipay.open.mini.innerversion.templated" ], "summary" : "基于模板构建版本", "description" : "基于模板构建实例化小程序，同步接口，调用成功表示创建版本成功", "operationId" : "alipay.open.mini.innerversion.templated.upload", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionTemplatedUploadResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionTemplatedUploadErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionTemplatedUploadModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerversion/upgrade" : { "post" : { "tags" : [ "alipay.open.mini.innerversion" ], "summary" : "升级模板实例化小程序", "description" : "升级基于模板实例化的小程序，升级后不需要重新提交审核；同步接口。", "operationId" : "alipay.open.mini.innerversion.upgrade", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionUpgradeResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionUpgradeErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionUpgradeModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerversion/upload" : { "post" : { "tags" : [ "alipay.open.mini.innerversion" ], "summary" : "内部小程序-打包构建", "description" : "内部小程序，创建打包构建任务，异步返回，使用查询接口轮询构建结果", "operationId" : "alipay.open.mini.innerversion.upload", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionUploadResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionUploadErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionUploadModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/innerversion/uploadstatus/query" : { "get" : { "tags" : [ "alipay.open.mini.innerversion.uploadstatus" ], "summary" : "多端小程序-查询构建状态", "description" : "查询构建状态", "operationId" : "alipay.open.mini.innerversion.uploadstatus.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionUploadstatusQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniInnerversionUploadstatusQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "build_package_id", "in" : "query", "description" : "包管理ID，用于查询打包状态", "schema" : { "type" : "string", "example" : "34818" } }, { "name" : "mini_app_id", "in" : "query", "description" : "小程序ID", "schema" : { "type" : "string", "example" : "2018012201365222" } }, { "name" : "build_version", "in" : "query", "description" : "小程序版本", "schema" : { "type" : "string", "example" : "0.0.5" } }, { "name" : "inst_code", "in" : "query", "description" : "租户id", "schema" : { "type" : "string", "example" : "taobao" } }, { "name" : "bundle_id", "in" : "query", "description" : "端信息", "schema" : { "type" : "string", "example" : "com.taobao.app" } } ] } }, "/v3/alipay/open/mini/isv/create" : { "post" : { "tags" : [ "alipay.open.mini.isv" ], "summary" : "isv服务商代商户创建小程序", "description" : "服务商代商家创建小程序，待商家确认后服务商代创建的小程序才会生效，若商家超过确认时间则服务商创建的小程序会自动作废释放占用的小程序名称。\n将 is_individual 设置为 true，并且同时传入 license_pic。将同时对具备个体工商户营业执照的商家个人账号认证成为个体工商户账号（创建小程序+升级个体工商户账号一体化）。", "operationId" : "alipay.open.mini.isv.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniIsvCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniIsvCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniIsvCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/isv/fastregister/create" : { "post" : { "tags" : [ "alipay.open.mini.isv.fastregister" ], "summary" : "ISV代创建试用小程序", "description" : "ISV代商户创建试用小程序", "operationId" : "alipay.open.mini.isv.fastregister.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniIsvFastregisterCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniIsvFastregisterCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniIsvFastregisterCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/isv/fastregister/query" : { "get" : { "tags" : [ "alipay.open.mini.isv.fastregister" ], "summary" : "查询试用小程序", "description" : "查询试用小程序", "operationId" : "alipay.open.mini.isv.fastregister.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniIsvFastregisterQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniIsvFastregisterQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "order_no", "in" : "query", "description" : "代创建试用小程序单号", "schema" : { "type" : "string", "example" : "2202121278786786768" } } ] } }, "/v3/alipay/open/mini/isv/query" : { "get" : { "tags" : [ "alipay.open.mini.isv" ], "summary" : "isv查询代商家创建小程序记录", "description" : "isv查询代商家创建小程序记录", "operationId" : "alipay.open.mini.isv.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniIsvQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniIsvQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "order_no", "in" : "query", "description" : "服务商代商家创建小程序，由支付宝开放平台返回的订单号用于后续查询处理进展。", "schema" : { "type" : "string", "example" : "2394834823942343" } } ] } }, "/v3/alipay/open/mini/miniapp/brand/cancel" : { "post" : { "tags" : [ "alipay.open.mini.miniapp.brand" ], "summary" : "小程序品牌提交认证后取消品牌认证", "description" : "小程序品牌提交认证后取消品牌认证", "operationId" : "alipay.open.mini.miniapp.brand.cancel", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniMiniappBrandCancelResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniMiniappBrandCancelErrorResponseModel" } ] } } } } } } }, "/v3/alipay/open/mini/miniapp/brand/query" : { "get" : { "tags" : [ "alipay.open.mini.miniapp.brand" ], "summary" : "小程序品牌提交认证后查询品牌审核结果以及商户已有品牌", "description" : "小程序品牌提交认证后查询品牌审核结果以及商户已有品牌", "operationId" : "alipay.open.mini.miniapp.brand.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniMiniappBrandQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniMiniappBrandQueryErrorResponseModel" } ] } } } } } } }, "/v3/alipay/open/mini/miniapp/brand/submit" : { "post" : { "tags" : [ "alipay.open.mini.miniapp.brand" ], "summary" : "小程序品牌提交认证", "description" : "小程序品牌提交认证", "operationId" : "alipay.open.mini.miniapp.brand.submit", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniMiniappBrandSubmitResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniMiniappBrandSubmitErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniMiniappBrandSubmitModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/miniapp/brand/upload" : { "post" : { "tags" : [ "alipay.open.mini.miniapp.brand" ], "summary" : "小程序品牌提交认证时上传用户资质以及身份信息", "description" : "小程序品牌提交认证时上传用户资质以及身份信息", "operationId" : "alipay.open.mini.miniapp.brand.upload", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniMiniappBrandUploadResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniMiniappBrandUploadErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "file_content" : { "type" : "string", "format" : "binary" } } }, "encoding" : { "file_content" : { "contentType" : "*/*" } } } }, "required" : false } } }, "/v3/alipay/open/mini/miniapp/serviceconfig/modify" : { "post" : { "tags" : [ "alipay.open.mini.miniapp.serviceconfig" ], "summary" : "小程序设置客服方式", "description" : "小程序设置客服方式", "operationId" : "alipay.open.mini.miniapp.serviceconfig.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniMiniappServiceconfigModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniMiniappServiceconfigModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniMiniappServiceconfigModifyModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/qrcode/bind" : { "post" : { "tags" : [ "alipay.open.mini.qrcode" ], "summary" : "关联普通二维码", "description" : "商户可不需更换线下二维码，通过该接口完成配置后，用户用支付宝扫描普通二维码时打开小程序并跳转到指定页面，普通二维码关联小程序最多可设置20条规则。", "operationId" : "alipay.open.mini.qrcode.bind", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniQrcodeBindResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniQrcodeBindErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniQrcodeBindModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/qrcode/query" : { "get" : { "tags" : [ "alipay.open.mini.qrcode" ], "summary" : "查询普通二维码", "description" : "通过appId查询商户关联的普通二维码路由信息", "operationId" : "alipay.open.mini.qrcode.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniQrcodeQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniQrcodeQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "page_no", "in" : "query", "description" : "页码", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "每页条数，最大为10", "schema" : { "type" : "integer", "example" : "10" } } ] } }, "/v3/alipay/open/mini/qrcode/unbind" : { "post" : { "tags" : [ "alipay.open.mini.qrcode" ], "summary" : "删除已关联普通二维码", "description" : "删除已关联普通二维码", "operationId" : "alipay.open.mini.qrcode.unbind", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniQrcodeUnbindResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniQrcodeUnbindErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniQrcodeUnbindModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/resource/promotionsource/notify" : { "post" : { "tags" : [ "alipay.open.mini.resource.promotionsource" ], "summary" : "提供给淘联盟推广位信息接口", "description" : "淘联盟定制回调接口，用户流量插件账号打通场景", "operationId" : "alipay.open.mini.resource.promotionsource.notify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniResourcePromotionsourceNotifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniResourcePromotionsourceNotifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniResourcePromotionsourceNotifyModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/resource/record/notify" : { "post" : { "tags" : [ "alipay.open.mini.resource.record" ], "summary" : "提供给淘联盟备案信息接口", "description" : "淘联盟定制回调接口，用户流量插件账号打通场景", "operationId" : "alipay.open.mini.resource.record.notify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniResourceRecordNotifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniResourceRecordNotifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniResourceRecordNotifyModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/safedomain/create" : { "post" : { "tags" : [ "alipay.open.mini.safedomain" ], "summary" : "小程序添加域白名单", "description" : "小程序添加域白名单", "operationId" : "alipay.open.mini.safedomain.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniSafedomainCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniSafedomainCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniSafedomainCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/safedomain/delete" : { "delete" : { "tags" : [ "alipay.open.mini.safedomain" ], "summary" : "小程序删除域白名单", "description" : "小程序删除域白名单", "operationId" : "alipay.open.mini.safedomain.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniSafedomainDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniSafedomainDeleteErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "safe_domain", "in" : "query", "description" : "服务器域名白名单。支付宝小程序在HTTP请求、上传文件等场景只能与域名白名单中的域名进行通讯 。\t删除域白名单后需重新上传应用版本（模板模式下小程序模板及商家应用都需重新上传、实例化版本）才会生效。老版本应用继续使用老版本名单（即删除域名可继续使用）。", "schema" : { "type" : "string", "example" : "example.com" } } ] } }, "/v3/alipay/open/mini/template/marketing/create" : { "post" : { "tags" : [ "alipay.open.mini.template.marketing" ], "summary" : "小程序消息运营位创建", "description" : "小程序消息运营位创建", "operationId" : "alipay.open.mini.template.marketing.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniTemplateMarketingCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniTemplateMarketingCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniTemplateMarketingCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/template/usage/query" : { "get" : { "tags" : [ "alipay.open.mini.template.usage" ], "summary" : "查询使用模板的小程序列表", "description" : "查询使用模板的小程序列表", "operationId" : "alipay.open.mini.template.usage.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniTemplateUsageQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniTemplateUsageQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "template_id", "in" : "query", "description" : "小程序模板APPID", "schema" : { "type" : "string", "example" : "1" } }, { "name" : "page_num", "in" : "query", "description" : "查询的页数，起始为 1（第一页） 。默认第一页。", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "每页的数量，最多查询50个，默认查询10个", "schema" : { "type" : "integer", "example" : "10" } }, { "name" : "template_version", "in" : "query", "description" : "模板小程序的版本号", "schema" : { "type" : "string", "example" : "0.0.1" } }, { "name" : "bundle_id", "in" : "query", "description" : "小程序投放的端参数，例如投放到支付宝钱包是支付宝端。默认支付宝端。支持：\tcom.alipay.alipaywallet:支付宝端；\tcom.alipay.iot.xpaas：支付宝IoT端。", "schema" : { "type" : "string", "example" : "com.alipay.alipaywallet" } } ] } }, "/v3/alipay/open/mini/templatemessage/usertemplate/apply" : { "post" : { "tags" : [ "alipay.open.mini.templatemessage.usertemplate" ], "summary" : "小程序模板消息申请", "description" : "小程序模板消息申请，申请之后可以通过返回的user_template_id来发送模板消息", "operationId" : "alipay.open.mini.templatemessage.usertemplate.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniTemplatemessageUsertemplateApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniTemplatemessageUsertemplateApplyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniTemplatemessageUsertemplateApplyModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/templatemsg/maketing/batchquery" : { "post" : { "tags" : [ "alipay.open.mini.templatemsg.maketing" ], "summary" : "小程序模板消息营销投放详情分页批量查询", "description" : "小程序模板消息营销投放详情分页批量查询", "operationId" : "alipay.open.mini.templatemsg.maketing.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniTemplatemsgMaketingBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniTemplatemsgMaketingBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniTemplatemsgMaketingBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/templatemsg/maketingstatus/modify" : { "post" : { "tags" : [ "alipay.open.mini.templatemsg.maketingstatus" ], "summary" : "小程序模板消息营销投放详情状态修改", "description" : "小程序模板消息营销投放详情状态修改", "operationId" : "alipay.open.mini.templatemsg.maketingstatus.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniTemplatemsgMaketingstatusModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniTemplatemsgMaketingstatusModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniTemplatemsgMaketingstatusModifyModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/templatemsg/tinypayswitch/confirm" : { "post" : { "tags" : [ "alipay.open.mini.templatemsg.tinypayswitch" ], "summary" : "小程序支付消息确认接口", "description" : "小程序内触发的交易带来的支付消息，可通过确认动作完成小程序入口的添加。", "operationId" : "alipay.open.mini.templatemsg.tinypayswitch.confirm", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniTemplatemsgTinypayswitchConfirmResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniTemplatemsgTinypayswitchConfirmErrorResponseModel" } ] } } } } } } }, "/v3/alipay/open/mini/tips/delivery/batchquery" : { "post" : { "tags" : [ "alipay.open.mini.tips.delivery" ], "summary" : "小程序收藏引导投放活动配置批量查询", "description" : "小程序收藏引导投放活动配置批量查询接口，获取该小程序下所有活动配置及状态信息。", "operationId" : "alipay.open.mini.tips.delivery.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniTipsDeliveryBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniTipsDeliveryBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniTipsDeliveryBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/tips/delivery/create" : { "post" : { "tags" : [ "alipay.open.mini.tips.delivery" ], "summary" : "小程序收藏引导投放活动配置创建", "description" : "小程序收藏引导投放活动配置创建。通过配置有效的小程序收藏引导（tips）文案，创建小程序收藏引导活动。用户在活动有效期内等于相应页面，将展示配置的个性化文案，帮助用户收藏小程序。请结合您的小程序及页面，配置个性化文案。\n", "operationId" : "alipay.open.mini.tips.delivery.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniTipsDeliveryCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniTipsDeliveryCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniTipsDeliveryCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/tips/delivery/modify" : { "post" : { "tags" : [ "alipay.open.mini.tips.delivery" ], "summary" : "小程序收藏引导投放活动修改", "description" : "小程序收藏引导投放活动修改接口，目前支持活动状态的修改，包括暂停、恢复、终止单个收藏引导活动。", "operationId" : "alipay.open.mini.tips.delivery.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniTipsDeliveryModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniTipsDeliveryModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniTipsDeliveryModifyModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/tips/delivery/query" : { "get" : { "tags" : [ "alipay.open.mini.tips.delivery" ], "summary" : "小程序收藏引导投放活动详情查询", "description" : "小程序收藏引导投放活动配置详情查询接口，获取当前活动ID对应活动的配置及状态信息。", "operationId" : "alipay.open.mini.tips.delivery.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniTipsDeliveryQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniTipsDeliveryQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "delivery_id", "in" : "query", "description" : "收藏引导投放活动ID，查询收藏引导活动必填参数", "schema" : { "type" : "string", "example" : "20211114000003057595" } } ] } }, "/v3/alipay/open/mini/tips/statistic/query" : { "get" : { "tags" : [ "alipay.open.mini.tips.statistic" ], "summary" : "小程序收藏引导汇总数据查询", "description" : "小程序收藏引导tips文案投放汇总数据查询接口。可查询小程序维度或活动维度的tips曝光uv，收藏uv，以及收藏转化率。请先配置投放活动，否则查询结果返回参数为空。", "operationId" : "alipay.open.mini.tips.statistic.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniTipsStatisticQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniTipsStatisticQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "delivery_id", "in" : "query", "description" : "收藏引导投放活动ID，供查询收藏引导活动配置接口调用\t，当以小程序维度查询数据（query_type为app）时delivery_id为空", "schema" : { "type" : "string", "example" : "20220308000000934758" } }, { "name" : "query_type", "in" : "query", "description" : "查询类型，表示以当前维度进行数据聚合。\tapp：小程序维度；activity：活动维度；", "schema" : { "type" : "string", "example" : "app" } }, { "name" : "start_date", "in" : "query", "description" : "查询开始日期，精度为天", "schema" : { "type" : "string", "example" : "20220322" } }, { "name" : "end_date", "in" : "query", "description" : "查询截止日期，精度为天", "schema" : { "type" : "string", "example" : "20220328" } } ] } }, "/v3/alipay/open/mini/version/audit/apply" : { "post" : { "tags" : [ "alipay.open.mini.version.audit" ], "summary" : "小程序提交审核", "description" : "小程序提交审核。\n1、本接口中关于小程序基础信息的一些字段例如小程序名称、小程序logo、客服电话等，这些信息如果你前期已经设置过，平台将会在你本次调用接口的时候，将上一次设置的信息自动填入，所以允许你本次调用时不传入。如果你前期还未设置过这些信息，则本次调用是需要必传的。具体的字段要求详见每个字段的描述。你可以用alipay.open.mini.version.detail.query接口查询小程序信息之前是否已经设置。\n2、小程序版本信息例如小程序版本号、小程序版本描述，这些信息是需要你每次调用接口必传的。\n3、本接口涉及到“审核流程拆分”、“审核加急”、“自动上架”的功能，具体功能详见接口字段audit_rule、speed_up、auto_online描述。", "operationId" : "alipay.open.mini.version.audit.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniVersionAuditApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniVersionAuditApplyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "app_logo" : { "type" : "string", "format" : "binary" }, "data" : { "$ref" : "#/components/schemas/AlipayOpenMiniVersionAuditApplyModel" }, "fifth_license_pic" : { "type" : "string", "format" : "binary" }, "fifth_screen_shot" : { "type" : "string", "format" : "binary" }, "first_license_pic" : { "type" : "string", "format" : "binary" }, "first_screen_shot" : { "type" : "string", "format" : "binary" }, "first_special_license_pic" : { "type" : "string", "format" : "binary" }, "fourth_license_pic" : { "type" : "string", "format" : "binary" }, "fourth_screen_shot" : { "type" : "string", "format" : "binary" }, "out_door_pic" : { "type" : "string", "format" : "binary" }, "second_license_pic" : { "type" : "string", "format" : "binary" }, "second_screen_shot" : { "type" : "string", "format" : "binary" }, "second_special_license_pic" : { "type" : "string", "format" : "binary" }, "test_file_name" : { "type" : "string", "format" : "binary" }, "third_license_pic" : { "type" : "string", "format" : "binary" }, "third_screen_shot" : { "type" : "string", "format" : "binary" }, "third_special_license_pic" : { "type" : "string", "format" : "binary" } } }, "encoding" : { "fifth_license_pic" : { "contentType" : "*/*" }, "third_special_license_pic" : { "contentType" : "*/*" }, "data" : { "contentType" : "application/json" }, "fifth_screen_shot" : { "contentType" : "*/*" }, "first_license_pic" : { "contentType" : "*/*" }, "test_file_name" : { "contentType" : "*/*" }, "first_special_license_pic" : { "contentType" : "*/*" }, "first_screen_shot" : { "contentType" : "*/*" }, "second_screen_shot" : { "contentType" : "*/*" }, "second_license_pic" : { "contentType" : "*/*" }, "app_logo" : { "contentType" : "*/*" }, "third_screen_shot" : { "contentType" : "*/*" }, "fourth_screen_shot" : { "contentType" : "*/*" }, "third_license_pic" : { "contentType" : "*/*" }, "out_door_pic" : { "contentType" : "*/*" }, "second_special_license_pic" : { "contentType" : "*/*" }, "fourth_license_pic" : { "contentType" : "*/*" } } } }, "required" : false } } }, "/v3/alipay/open/mini/version/audit/cancel" : { "post" : { "tags" : [ "alipay.open.mini.version.audit" ], "summary" : "小程序撤销审核", "description" : "三方实例化小程序撤销审核", "operationId" : "alipay.open.mini.version.audit.cancel", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniVersionAuditCancelResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniVersionAuditCancelErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniVersionAuditCancelModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/version/audited/cancel" : { "post" : { "tags" : [ "alipay.open.mini.version.audited" ], "summary" : "小程序退回开发", "description" : "小程序退回开发", "operationId" : "alipay.open.mini.version.audited.cancel", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniVersionAuditedCancelResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniVersionAuditedCancelErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniVersionAuditedCancelModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/version/build/query" : { "get" : { "tags" : [ "alipay.open.mini.version.build" ], "summary" : "小程序查询版本构建状态", "description" : "小程序查询版本构建状态", "operationId" : "alipay.open.mini.version.build.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniVersionBuildQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniVersionBuildQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "app_version", "in" : "query", "description" : "小程序版本号", "schema" : { "type" : "string", "example" : "0.0.1" } }, { "name" : "bundle_id", "in" : "query", "description" : "小程序投放的端参数，默认为支付宝端。支持： \tcom.alipay.alipaywallet：支付宝端。\tcom.alipay.iot.xpaas：IOT端。\t例如：投放到支付宝钱包为支付宝端需传入 com.alipay.alipaywallet。", "schema" : { "type" : "string", "example" : "com.alipay.alipaywallet" } } ] } }, "/v3/alipay/open/mini/version/delete" : { "post" : { "tags" : [ "alipay.open.mini.version" ], "summary" : "小程序删除版本", "description" : "小程序删除版本", "operationId" : "alipay.open.mini.version.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniVersionDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniVersionDeleteErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniVersionDeleteModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/version/detail/query" : { "get" : { "tags" : [ "alipay.open.mini.version.detail" ], "summary" : "小程序版本详情查询", "description" : "小程序版本详情查询", "operationId" : "alipay.open.mini.version.detail.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniVersionDetailQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniVersionDetailQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "app_version", "in" : "query", "description" : "小程序版本号", "schema" : { "type" : "string", "example" : "0.0.1" } }, { "name" : "bundle_id", "in" : "query", "description" : "小程序投放的端参数，支持：\tcom.alipay.iot.xpaas（IoT端）。\tcom.alipay.alipaywallet（支付宝钱包端）。\t例如投放到支付宝钱包是支付宝端。该参数可选，默认支付宝端。", "schema" : { "type" : "string", "example" : "com.alipay.alipaywallet" } } ] } }, "/v3/alipay/open/mini/version/gray/cancel" : { "post" : { "tags" : [ "alipay.open.mini.version.gray" ], "summary" : "小程序结束灰度", "description" : "小程序结束灰度", "operationId" : "alipay.open.mini.version.gray.cancel", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniVersionGrayCancelResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniVersionGrayCancelErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniVersionGrayCancelModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/version/gray/online" : { "post" : { "tags" : [ "alipay.open.mini.version.gray" ], "summary" : "小程序灰度上架", "description" : "小程序灰度上架", "operationId" : "alipay.open.mini.version.gray.online", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniVersionGrayOnlineResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniVersionGrayOnlineErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniVersionGrayOnlineModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/version/list/query" : { "get" : { "tags" : [ "alipay.open.mini.version.list" ], "summary" : "小程序版本列表查询", "description" : "根据状态、端分页查询小程序版本基础信息列表，查询结果根据版本号大小降序排列，即0.0.2在前，0.0.1在后。", "operationId" : "alipay.open.mini.version.list.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniVersionListQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniVersionListQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "bundle_id", "in" : "query", "description" : "端参数，用于查询多端版本，不传默认为支付宝端。\t高德端：com.amap.app", "schema" : { "type" : "string", "example" : "com.alipay.alipaywallet" } }, { "name" : "version_status", "in" : "query", "description" : "版本状态列表，用英文逗号\",\"分割，可选；不填默认不返回，状态可选值以及说明如下-INIT: 开发中, AUDITING: 审核中, AUDIT_REJECT: 审核驳回, WAIT_RELEASE: 待上架, BASE_AUDIT_PASS: 准入不可营销, GRAY: 灰度中, RELEASE: 已上架, OFFLINE: 已下架, AUDIT_OFFLINE: 已下架;", "schema" : { "type" : "string", "example" : "AUDITING" } } ] } }, "/v3/alipay/open/mini/version/offline" : { "post" : { "tags" : [ "alipay.open.mini.version" ], "summary" : "小程序下架", "description" : "小程序下架", "operationId" : "alipay.open.mini.version.offline", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniVersionOfflineResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniVersionOfflineErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniVersionOfflineModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/version/online" : { "post" : { "tags" : [ "alipay.open.mini.version" ], "summary" : "小程序上架", "description" : "小程序上架", "operationId" : "alipay.open.mini.version.online", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniVersionOnlineResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniVersionOnlineErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniVersionOnlineModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/version/rollback" : { "post" : { "tags" : [ "alipay.open.mini.version" ], "summary" : "小程序回滚", "description" : "小程序回滚", "operationId" : "alipay.open.mini.version.rollback", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniVersionRollbackResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniVersionRollbackErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniVersionRollbackModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/version/upload" : { "post" : { "tags" : [ "alipay.open.mini.version" ], "summary" : "小程序基于模板上传版本", "description" : "小程序基于模板上传版本", "operationId" : "alipay.open.mini.version.upload", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniVersionUploadResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniVersionUploadErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniVersionUploadModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/widget/data/sync" : { "post" : { "tags" : [ "alipay.open.mini.widget.data" ], "summary" : "小程序橱窗数据同步", "description" : "面向商品售卖类的小程序橱窗，提供的橱窗内展示数据同步能力，同步后会进行文本和图片信息审核，审核完成后通知结果通过openmq消息通知", "operationId" : "alipay.open.mini.widget.data.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniWidgetDataSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniWidgetDataSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniWidgetDataSyncModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/widget/goods/modify" : { "patch" : { "tags" : [ "alipay.open.mini.widget.goods" ], "summary" : "小部件商品修改", "description" : "面向商品售卖类的小部件，提供的商品信息修改能力，修改后会进行文本和图片信息审核，审核完成后通知结果通过openmq消息通知", "operationId" : "alipay.open.mini.widget.goods.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniWidgetGoodsModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniWidgetGoodsModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniWidgetGoodsModifyModel" } } }, "required" : false } } }, "/v3/alipay/open/mini/widget/goods/query" : { "get" : { "tags" : [ "alipay.open.mini.widget.goods" ], "summary" : "小部件商品查询", "description" : "面向商品售卖类的小部件，提供商品信息查询能力，返回审核通过的商品信息", "operationId" : "alipay.open.mini.widget.goods.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniWidgetGoodsQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniWidgetGoodsQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "mini_app_id", "in" : "query", "description" : "根据承接品的商家小程序ID查询", "schema" : { "type" : "string", "example" : "2017072607907880" } }, { "name" : "pid", "in" : "query", "description" : "根据承接该品的小程序背后的商家查询", "schema" : { "type" : "string", "example" : "2088xxxxxxxxx" } }, { "name" : "goods_id", "in" : "query", "description" : "根据商品的唯一标识查询", "schema" : { "type" : "string", "example" : "8948968498" } }, { "name" : "page_num", "in" : "query", "description" : "查询第几页，最小值为1", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "查询页面数量，最大值为50", "schema" : { "type" : "integer", "example" : "10" } } ] } }, "/v3/alipay/open/mini/widget/goods/upload" : { "post" : { "tags" : [ "alipay.open.mini.widget.goods" ], "summary" : "小部件商品上传", "description" : "面向商品售卖类的小部件，提供的商品信息上传能力，上传后会进行文本和图片信息审核，审核完成后通知结果通过openmq消息通知", "operationId" : "alipay.open.mini.widget.goods.upload", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniWidgetGoodsUploadResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenMiniWidgetGoodsUploadErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenMiniWidgetGoodsUploadModel" } } }, "required" : false } } }, "/v3/alipay/open/operation/openbizmock/testpathkey/query/{keykey}/{a}" : { "post" : { "tags" : [ "alipay.open.operation.openbizmock.testpathkey" ], "summary" : "测试网关协议3.0key和path", "description" : "测试网关协议3.0key和path", "operationId" : "alipay.open.operation.openbizmock.testpathkey.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenOperationOpenbizmockTestpathkeyQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenOperationOpenbizmockTestpathkeyQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "keykey", "in" : "path", "description" : "ceshi", "required" : true, "schema" : { "type" : "string", "example" : "keykey" } }, { "name" : "a", "in" : "path", "description" : "测试", "required" : true, "schema" : { "type" : "string", "example" : "a" } }, { "name" : "b", "in" : "query", "description" : "ceshi", "schema" : { "type" : "string", "example" : "b" } }, { "name" : "c", "in" : "query", "description" : "测试", "schema" : { "type" : "string", "example" : "c" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenOperationOpenbizmockTestpathkeyQueryModel" } } }, "required" : false } } }, "/v3/alipay/open/public/account/create" : { "post" : { "tags" : [ "alipay.open.public.account" ], "summary" : "添加绑定商户会员号", "description" : "当用户成为商户的关注用户后，可以在商户的服务窗中点击“添加绑定商户会员号”功能，支付宝系统收到操作请求后将该动作通知给商户（使用用户发送信息到商户接口，其中eventType（事件类型）为click，actionParam（按钮标识）为authentication），商户根据此通知调用商户回复消息接口（其中须包含Url链接地址），支付宝收到商户的回复消息中的链接地址后，自动跳转至商户平台的上商户会员绑定界面中，让用户完成账户绑定。 当用户有效完成账户绑定后，商户调用本接口，把绑定结果数据通知给支付宝。", "operationId" : "alipay.open.public.account.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicAccountCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicAccountCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicAccountCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/public/account/delete" : { "delete" : { "tags" : [ "alipay.open.public.account" ], "summary" : "解除绑定商户会员号", "description" : "在支付宝服务窗中目前一共有三种解除绑定商户会员号的场景，具体如下：\r\n用户取消关注服务窗\r\n用户在服务窗内手动执行解除绑定操作\r\n开发者调用解除绑定商户会员号接口解除绑定", "operationId" : "alipay.open.public.account.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicAccountDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicAccountDeleteErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "agreement_id", "in" : "query", "description" : "协议号，商户会员在支付宝服务窗账号中的唯一标识，与bind_account_no不能同时为空", "schema" : { "type" : "string", "example" : "29022222" } }, { "name" : "bind_account_no", "in" : "query", "description" : "绑定帐号，建议在开发者的系统中保持唯一性，与agreement_id不能同时为空", "schema" : { "type" : "string", "example" : "test001" } }, { "name" : "from_user_id", "in" : "query", "description" : "绑定用户的支付宝userid，2088开头16位长度的字符串，与agreementId不能同时为空", "schema" : { "type" : "string", "example" : "2088656734541243" } }, { "name" : "open_id", "in" : "query", "description" : "支付宝用户的唯一标识", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } } ] } }, "/v3/alipay/open/public/account/query" : { "get" : { "tags" : [ "alipay.open.public.account" ], "summary" : "查询绑定商户会员号", "description" : "当用户成为商户的关注用户之后，则商户可以通过本接口查询关注者的绑定账户，以便补全异常情况下的单边账户数据。", "operationId" : "alipay.open.public.account.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicAccountQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicAccountQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "user_id", "in" : "query", "description" : "用户的支付宝用户号，2088开头。", "schema" : { "type" : "string", "example" : "2088123412341234" } }, { "name" : "open_id", "in" : "query", "description" : "支付宝用户的唯一标识", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } } ] } }, "/v3/alipay/open/public/account/reset" : { "post" : { "tags" : [ "alipay.open.public.account" ], "summary" : "重新设置绑定商家会员号", "description" : "如果商户想要重置已经添加的外部账户，可以通过该接口完成。重置后，原有的外部户将删除，新的外部户添加进去。", "operationId" : "alipay.open.public.account.reset", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicAccountResetResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicAccountResetErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicAccountResetModel" } } }, "required" : false } } }, "/v3/alipay/open/public/advert/batchquery" : { "post" : { "tags" : [ "alipay.open.public.advert" ], "summary" : "生活号广告位查询接口", "description" : "可以通过此接口查询所有广告位的配置信息", "operationId" : "alipay.open.public.advert.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicAdvertBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicAdvertBatchqueryErrorResponseModel" } ] } } } } } } }, "/v3/alipay/open/public/advert/create" : { "post" : { "tags" : [ "alipay.open.public.advert" ], "summary" : "生活号广告位添加接口", "description" : "可通过本接口在生活号主页添加广告位，根据业务需求配置不同的图片和跳转链接", "operationId" : "alipay.open.public.advert.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicAdvertCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicAdvertCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicAdvertCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/public/advert/delete" : { "delete" : { "tags" : [ "alipay.open.public.advert" ], "summary" : "生活号广告位删除接口", "description" : "可以通过此接口删除指定广告位的配置信息", "operationId" : "alipay.open.public.advert.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicAdvertDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicAdvertDeleteErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "advert_id", "in" : "query", "description" : "待删除的广告位id", "schema" : { "type" : "string", "example" : "123" } }, { "name" : "advert_group", "in" : "query", "description" : "待删除的广告位分组标识", "schema" : { "type" : "string", "example" : "CG202008041013200064690" } } ] } }, "/v3/alipay/open/public/advert/modify" : { "post" : { "tags" : [ "alipay.open.public.advert" ], "summary" : "生活号广告位修改接口", "description" : "可以通过此接口修改指定广告位的配置信息", "operationId" : "alipay.open.public.advert.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicAdvertModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicAdvertModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicAdvertModifyModel" } } }, "required" : false } } }, "/v3/alipay/open/public/articlesummary/data/batchquery" : { "post" : { "tags" : [ "alipay.open.public.articlesummary.data" ], "summary" : "图文分析-按时间查询数据接口", "description" : "开发者可以通过图文分析接口查询30天内，所有历史发布的图文消息的数据，包括送达人数、曝光人数、图文阅读人数、分享人数等信息。", "operationId" : "alipay.open.public.articlesummary.data.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicArticlesummaryDataBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicArticlesummaryDataBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicArticlesummaryDataBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/open/public/contact/follow/batchquery" : { "post" : { "tags" : [ "alipay.open.public.contact.follow" ], "summary" : "查询服务窗联系人关注列表", "description" : "查询服务窗联系人关注列表", "operationId" : "alipay.open.public.contact.follow.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicContactFollowBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicContactFollowBatchqueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/AuthToken" } ] } }, "/v3/alipay/open/public/default/extension/create" : { "post" : { "tags" : [ "alipay.open.public.default.extension" ], "summary" : "默认扩展区创建接口", "description" : "开发者可使用此接口创建默认扩展区", "operationId" : "alipay.open.public.default.extension.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicDefaultExtensionCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicDefaultExtensionCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicDefaultExtensionCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/public/follow/batchquery" : { "post" : { "tags" : [ "alipay.open.public.follow" ], "summary" : "获取关注者列表", "description" : "公众号可通过本接口来获取账号的关注者列表，关注者列表由一串userId组成。一次拉取调用最多拉取10000个关注者的userId，可以通过多次拉取的方式来满足需求。 公众号可通过本接口来获取账号的关注者列表，关注者列表由一串userId组成。一次拉取调用最多拉取10000个关注者的userId，可以通过多次拉取的方式来满足需求。", "operationId" : "alipay.open.public.follow.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicFollowBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicFollowBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicFollowBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/open/public/group/batchquery" : { "post" : { "tags" : [ "alipay.open.public.group" ], "summary" : "查询用户分组列表", "description" : "使用该接口查询分组列表，并配合其它分组管理接口使用，最多显示200条", "operationId" : "alipay.open.public.group.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicGroupBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicGroupBatchqueryErrorResponseModel" } ] } } } } } } }, "/v3/alipay/open/public/group/create" : { "post" : { "tags" : [ "alipay.open.public.group" ], "summary" : "用户分组创建接口", "description" : "开发者可使用此接口根据指定条件从关注用户中圈定人群生成分组，分组可用于组发消息等场景，分组圈定的人群必须大于50人。", "operationId" : "alipay.open.public.group.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicGroupCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicGroupCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicGroupCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/public/group/crowd/query" : { "post" : { "tags" : [ "alipay.open.public.group.crowd" ], "summary" : "人群数量查询", "description" : "用户可以指定自己创建的分组，调用接口查询对应的人群数量，人群必须大于50人才能正常返回，否则报错。", "operationId" : "alipay.open.public.group.crowd.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicGroupCrowdQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicGroupCrowdQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicGroupCrowdQueryModel" } } }, "required" : false } } }, "/v3/alipay/open/public/group/delete" : { "delete" : { "tags" : [ "alipay.open.public.group" ], "summary" : "用户分组删除接口", "description" : "调用接口删除用户分组", "operationId" : "alipay.open.public.group.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicGroupDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicGroupDeleteErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "group_id", "in" : "query", "description" : "分组ID，通过alipay.open.public.group.create（用户分组创建接口)\t创建用户分组获取。", "schema" : { "type" : "string", "example" : "100" } } ] } }, "/v3/alipay/open/public/group/modify" : { "post" : { "tags" : [ "alipay.open.public.group" ], "summary" : "用户分组修改接口", "description" : "调用改接口修改用户分组，仅支持修改分组名称。", "operationId" : "alipay.open.public.group.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicGroupModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicGroupModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicGroupModifyModel" } } }, "required" : false } } }, "/v3/alipay/open/public/info/modify" : { "post" : { "tags" : [ "alipay.open.public.info" ], "summary" : "生活号基础信息修改接口", "description" : "提供生活号基础信息修改，同时适用于口碑商户签约当面付2.0默认创建的服务窗，需上传相关资质材料。修改名称、头像、简介会触发风控审核，审核通过后修改生效，支持isv调用", "operationId" : "alipay.open.public.info.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicInfoModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicInfoModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicInfoModifyModel" } } }, "required" : false } } }, "/v3/alipay/open/public/info/query" : { "get" : { "tags" : [ "alipay.open.public.info" ], "summary" : "生活号基础信息查询接口", "description" : "提供名称、头像、简介、欢迎语、上下架、审核信息查询，支持isv调用", "operationId" : "alipay.open.public.info.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicInfoQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicInfoQueryErrorResponseModel" } ] } } } } } } }, "/v3/alipay/open/public/label/create" : { "post" : { "tags" : [ "alipay.open.public.label" ], "summary" : "公众号标签管理-添加标签", "description" : "开发者可以使用该接口创建一个标签，一个服务窗最多同时拥有500个标签，标签名不能重复。", "operationId" : "alipay.open.public.label.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicLabelCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicLabelCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicLabelCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/public/label/query" : { "get" : { "tags" : [ "alipay.open.public.label" ], "summary" : "公众号标签管理-查询标签", "description" : "开发者可以查询该服务窗所有标签值及拥有该标签的用户个数", "operationId" : "alipay.open.public.label.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicLabelQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicLabelQueryErrorResponseModel" } ] } } } } } } }, "/v3/alipay/open/public/label/user/query" : { "get" : { "tags" : [ "alipay.open.public.label.user" ], "summary" : "公众号标签管理-查询用户标签", "description" : "开发者可以使用该接口查询某个用户的所有标签", "operationId" : "alipay.open.public.label.user.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicLabelUserQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicLabelUserQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "user_id", "in" : "query", "description" : "支付宝用户的userid，2088开头长度为16位的字符串", "schema" : { "type" : "string", "example" : "2088283746283746" } }, { "name" : "open_id", "in" : "query", "description" : "支付宝用户的唯一标识", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } } ] } }, "/v3/alipay/open/public/life/aboard/apply" : { "post" : { "tags" : [ "alipay.open.public.life.aboard" ], "summary" : "上架生活号", "description" : "上架生活号", "operationId" : "alipay.open.public.life.aboard.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicLifeAboardApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicLifeAboardApplyErrorResponseModel" } ] } } } } } } }, "/v3/alipay/open/public/life/agentcreate/query" : { "get" : { "tags" : [ "alipay.open.public.life.agentcreate" ], "summary" : "isv代创建生活号申请状态查询接口", "description" : "isv可调用此接口查询代商户创建的生活号审核状态", "operationId" : "alipay.open.public.life.agentcreate.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicLifeAgentcreateQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicLifeAgentcreateQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "out_biz_no", "in" : "query", "description" : "由开发者创建的外部入驻申请单据号，需与alipay.open.public.life.agent.create(isv代创建生活号接口)的out_biz_no一致。", "schema" : { "type" : "string", "example" : "2016070788301823878" } } ] } }, "/v3/alipay/open/public/life/debark/apply" : { "post" : { "tags" : [ "alipay.open.public.life.debark" ], "summary" : "下架生活号", "description" : "下架生活号", "operationId" : "alipay.open.public.life.debark.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicLifeDebarkApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicLifeDebarkApplyErrorResponseModel" } ] } } } } } } }, "/v3/alipay/open/public/life/label/batchquery" : { "post" : { "tags" : [ "alipay.open.public.life.label" ], "summary" : "标签批量查询接口", "description" : "开发者可调用该接口查询生活号支持的标签列表，其中包括生活号通用标签、生活号自定义标签以及数据实验室标签。", "operationId" : "alipay.open.public.life.label.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicLifeLabelBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicLifeLabelBatchqueryErrorResponseModel" } ] } } } } } } }, "/v3/alipay/open/public/life/label/create" : { "post" : { "tags" : [ "alipay.open.public.life.label" ], "summary" : "创建标签接口", "description" : "开发者可使用该API创建自定义标签", "operationId" : "alipay.open.public.life.label.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicLifeLabelCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicLifeLabelCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicLifeLabelCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/public/life/label/delete" : { "delete" : { "tags" : [ "alipay.open.public.life.label" ], "summary" : "标签删除接口", "description" : "开发者可调用此API删除自定义标签", "operationId" : "alipay.open.public.life.label.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicLifeLabelDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicLifeLabelDeleteErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "label_id", "in" : "query", "description" : "标签 id，只支持生活号自定义标签。通过 alipay.open.public.life.label.create(创建标签接口)创建自定义标签后获取。", "schema" : { "type" : "string", "example" : "10000" } } ] } }, "/v3/alipay/open/public/life/label/modify" : { "post" : { "tags" : [ "alipay.open.public.life.label" ], "summary" : "标签修改接口", "description" : "开发者可调用此API修改自定义标签的名称", "operationId" : "alipay.open.public.life.label.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicLifeLabelModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicLifeLabelModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicLifeLabelModifyModel" } } }, "required" : false } } }, "/v3/alipay/open/public/life/msg/recall" : { "post" : { "tags" : [ "alipay.open.public.life.msg" ], "summary" : "生活号消息撤回接口", "description" : "生活号消息撤回接口", "operationId" : "alipay.open.public.life.msg.recall", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicLifeMsgRecallResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicLifeMsgRecallErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicLifeMsgRecallModel" } } }, "required" : false } } }, "/v3/alipay/open/public/life/msg/send" : { "post" : { "tags" : [ "alipay.open.public.life.msg" ], "summary" : "生活号广播消息发送接口", "description" : "媒体资讯生活号群发一篇图文或视频类消息，生活号主页以及客户端首页展示消息详情", "operationId" : "alipay.open.public.life.msg.send", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicLifeMsgSendResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicLifeMsgSendErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "cover" : { "type" : "string", "format" : "binary" }, "data" : { "$ref" : "#/components/schemas/AlipayOpenPublicLifeMsgSendModel" } } }, "encoding" : { "cover" : { "contentType" : "*/*" }, "data" : { "contentType" : "application/json" } } } }, "required" : false } } }, "/v3/alipay/open/public/matchuser/label/create" : { "post" : { "tags" : [ "alipay.open.public.matchuser.label" ], "summary" : "用户打标接口", "description" : "开发者可以使用此接口向匹配到的用户添加指定标签值，每个用户每个标签只能有一个标签值，当向同一个用户添加多个标签值时，最新的标签值会覆盖之前的标签值", "operationId" : "alipay.open.public.matchuser.label.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMatchuserLabelCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicMatchuserLabelCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMatchuserLabelCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/public/matchuser/label/delete" : { "post" : { "tags" : [ "alipay.open.public.matchuser.label" ], "summary" : "用户取消标签接口", "description" : "开发者可以使用此接口删除匹配到的支付宝用户的指定标签值", "operationId" : "alipay.open.public.matchuser.label.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMatchuserLabelDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicMatchuserLabelDeleteErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMatchuserLabelDeleteModel" } } }, "required" : false } } }, "/v3/alipay/open/public/menu/batchquery" : { "post" : { "tags" : [ "alipay.open.public.menu" ], "summary" : "菜单列表查询接口", "description" : "开发者可调用该接口查询自己创建的菜单列表", "operationId" : "alipay.open.public.menu.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMenuBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicMenuBatchqueryErrorResponseModel" } ] } } } } } } }, "/v3/alipay/open/public/menu/create" : { "post" : { "tags" : [ "alipay.open.public.menu" ], "summary" : "默认菜单创建接口", "description" : "开发者可调用该接口为生活号创建一套默认菜单，当用户进入生活号主页时，若没有命中任何个性化菜单，则会展示该默认菜单，每个生活号必须有一套默认菜单", "operationId" : "alipay.open.public.menu.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMenuCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicMenuCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMenuCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/public/menu/data/batchquery" : { "post" : { "tags" : [ "alipay.open.public.menu.data" ], "summary" : "菜单分析数据查询接口", "description" : "开发者可以根据本接口查询30天内菜单的相关数据，包括菜单点击人数和次数", "operationId" : "alipay.open.public.menu.data.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMenuDataBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicMenuDataBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMenuDataBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/open/public/menu/modify" : { "post" : { "tags" : [ "alipay.open.public.menu" ], "summary" : "默认菜单更新接口", "description" : "开发者可调用该接口更新默认菜单，菜单更新成功后实时生效", "operationId" : "alipay.open.public.menu.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMenuModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicMenuModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMenuModifyModel" } } }, "required" : false } } }, "/v3/alipay/open/public/menu/query" : { "get" : { "tags" : [ "alipay.open.public.menu" ], "summary" : "公众服务平台查询菜单", "description" : "开发者通过调用该接口查询菜单。", "operationId" : "alipay.open.public.menu.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMenuQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicMenuQueryErrorResponseModel" } ] } } } } } } }, "/v3/alipay/open/public/message/content/create" : { "post" : { "tags" : [ "alipay.open.public.message.content" ], "summary" : "创建图文消息内容接口", "description" : "开发者可使用该接口将富文本内容生成生活号图文消息内容链接", "operationId" : "alipay.open.public.message.content.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMessageContentCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicMessageContentCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMessageContentCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/public/message/content/modify" : { "post" : { "tags" : [ "alipay.open.public.message.content" ], "summary" : "更新图文消息内容接口", "description" : "开发者可使用该接口修改已经创建的生活号图文消息素材里的内容", "operationId" : "alipay.open.public.message.content.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMessageContentModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicMessageContentModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMessageContentModifyModel" } } }, "required" : false } } }, "/v3/alipay/open/public/message/custom/send" : { "post" : { "tags" : [ "alipay.open.public.message.custom" ], "summary" : "异步单发消息", "description" : "开发者可使用该接口向指定关注用户推送客服消息，一般用于开发者使用接口与用户进行实时信息交互，例如自动回答用户包含某些指定关键字的咨询等。注意：用户必须在48小时之内与该生活号有交互行为才能收到消息（交互行为包括进入生活号、点击菜单、向生活号发送消息等），每个生活号每天只能向1个用户推送100条消息，超过这个数目会报错频率超限", "operationId" : "alipay.open.public.message.custom.send", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMessageCustomSendResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicMessageCustomSendErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMessageCustomSendModel" } } }, "required" : false } } }, "/v3/alipay/open/public/message/group/send" : { "post" : { "tags" : [ "alipay.open.public.message.group" ], "summary" : "分组消息发送接口", "description" : "开发者可调用此接口向指定分组中的关注用户发送消息，该接口为异步接口，一般请求成功后一段时间用户才能收到消息。", "operationId" : "alipay.open.public.message.group.send", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMessageGroupSendResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicMessageGroupSendErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMessageGroupSendModel" } } }, "required" : false } } }, "/v3/alipay/open/public/message/label/send" : { "post" : { "tags" : [ "alipay.open.public.message.label" ], "summary" : "根据标签组发消息接口", "description" : "开发者可以通过标签运算圈定一批用户，并且向这批用户推送消息。关于标签组发有以下注意点：\r\n除了商户自定义标签，还支持支付宝用户标签，我们将陆续开放用户画像标签，目前支持的支付宝标签及说明请查看支付宝开放标签；\r\n用户及标签数据有1天的缓存时间，即昨天开发者给M用户打了a标签，今天给有a标签的用户组发消息，M能够收到消息；但是如果开发者今天给M用户打了a标签，然后向有a标签的用户组发消息，M不能收到消息；\r\n与群发消息接口类似，该接口调用之后，消息发送系统会处理一段时间，调用接口到发送成功存在一定的时延，几分钟到半个小时不等；\r\n对于同一个用户而言，一周只能收到一条群发或者标签组发的消息；\r\n消息组发接口一周最多调用5次。", "operationId" : "alipay.open.public.message.label.send", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMessageLabelSendResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicMessageLabelSendErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMessageLabelSendModel" } } }, "required" : false } } }, "/v3/alipay/open/public/message/single/send" : { "post" : { "tags" : [ "alipay.open.public.message.single" ], "summary" : "单发模板消息", "description" : "商户可使用该接口向用户推送制定模板的消息，如动账提醒、停车通知等消息，消息模板可在生活号后台(fuwu.alipay.com)领取，点击“模板消息”菜单，即可在模板库中领取行业对应的模板", "operationId" : "alipay.open.public.message.single.send", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMessageSingleSendResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicMessageSingleSendErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMessageSingleSendModel" } } }, "required" : false } } }, "/v3/alipay/open/public/message/total/send" : { "post" : { "tags" : [ "alipay.open.public.message.total" ], "summary" : "群发消息", "description" : "群发消息", "operationId" : "alipay.open.public.message.total.send", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMessageTotalSendResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicMessageTotalSendErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicMessageTotalSendModel" } } }, "required" : false } } }, "/v3/alipay/open/public/payee/bind/create" : { "post" : { "tags" : [ "alipay.open.public.payee.bind" ], "summary" : "添加收款账号接口", "description" : "允许开发者调用该接口将收款账号与当前生活号绑定，从而支持支付成功页引导推荐关注生活号", "operationId" : "alipay.open.public.payee.bind.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicPayeeBindCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicPayeeBindCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicPayeeBindCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/public/payee/bind/delete" : { "delete" : { "tags" : [ "alipay.open.public.payee.bind" ], "summary" : "解绑收款账号接口", "description" : "允许开发者调用该接口将收款账号与当前生活号解绑", "operationId" : "alipay.open.public.payee.bind.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicPayeeBindDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicPayeeBindDeleteErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "login_id", "in" : "query", "description" : "收款账号，需要绑定的收款支付宝账号，请勿与 pid 同时传入。", "schema" : { "type" : "string", "example" : "13434232322" } }, { "name" : "pid", "in" : "query", "description" : "支付宝用户id，2088开头的16位长度字符串，请勿与 login_id 同时传入。", "schema" : { "type" : "string", "example" : "208844738438439" } } ] } }, "/v3/alipay/open/public/personalized/extension/batchquery" : { "post" : { "tags" : [ "alipay.open.public.personalized.extension" ], "summary" : "扩展区批量查询接口", "description" : "开发者可使用此接口批量查询扩展区列表，包括默认扩展区和个性化扩展区", "operationId" : "alipay.open.public.personalized.extension.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicPersonalizedExtensionBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicPersonalizedExtensionBatchqueryErrorResponseModel" } ] } } } } } } }, "/v3/alipay/open/public/personalized/extension/create" : { "post" : { "tags" : [ "alipay.open.public.personalized.extension" ], "summary" : "个性化扩展区创建接口", "description" : "开发者可使用该接口创建一套个性化扩展区，符合该扩展区规则的用户进入生活号主页后会看到该个性化扩展区", "operationId" : "alipay.open.public.personalized.extension.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicPersonalizedExtensionCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicPersonalizedExtensionCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicPersonalizedExtensionCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/public/personalized/extension/delete" : { "delete" : { "tags" : [ "alipay.open.public.personalized.extension" ], "summary" : "扩展区删除接口", "description" : "开发者可调用该接口删除创建的一套扩展区，包括个性化扩展区和默认扩展区", "operationId" : "alipay.open.public.personalized.extension.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicPersonalizedExtensionDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicPersonalizedExtensionDeleteErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "extension_key", "in" : "query", "description" : "一套扩展区的key，删除默认扩展区时传入default ，查询扩展区列表可以获得每套扩展区的key", "schema" : { "type" : "string", "example" : "10000" } } ] } }, "/v3/alipay/open/public/personalized/menu/create" : { "post" : { "tags" : [ "alipay.open.public.personalized.menu" ], "summary" : "个性化菜单创建", "description" : "开发者可使用该接口创建个性化菜单，当生活号用户标签信息命中该菜单的标签规则时，用户将会看到该套菜单。个性化菜单创建完成后立即生效，用户支付宝客户端版本低于10.0.12时，若创建的是icon菜单，也会以文本菜单的形式展示。", "operationId" : "alipay.open.public.personalized.menu.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicPersonalizedMenuCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicPersonalizedMenuCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicPersonalizedMenuCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/public/personalized/menu/delete" : { "delete" : { "tags" : [ "alipay.open.public.personalized.menu" ], "summary" : "个性化菜单删除", "description" : "开发者可使用该接口删除个性化菜单", "operationId" : "alipay.open.public.personalized.menu.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicPersonalizedMenuDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicPersonalizedMenuDeleteErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "menu_key", "in" : "query", "description" : "要删除的个性化菜单key。通过 alipay.open.public.personalized.menu.create(个性化菜单创建)接口创建个性化菜单后获取。", "schema" : { "type" : "string", "example" : "100000" } } ] } }, "/v3/alipay/open/public/qrcode/create" : { "post" : { "tags" : [ "alipay.open.public.qrcode" ], "summary" : "带参推广二维码接口", "description" : "为了满足用户渠道推广分析的需要，公众平台提供了生成带参数二维码的接口。使用该接口可以获得多个带不同场景值的二维码，用户扫描后，公众号可以接收到事件推送。目前有2种类型的二维码，分别是临时二维码、和永久二维码，前者有过期时间，最大为1800秒。 每次创建二维码ticket需要提供一个开发者自行设定的参数（scene_id）。", "operationId" : "alipay.open.public.qrcode.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicQrcodeCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicQrcodeCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicQrcodeCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/public/setting/category/query" : { "get" : { "tags" : [ "alipay.open.public.setting.category" ], "summary" : "生活号查询行业设置接口", "description" : "查询生活号已设置的行业类型，支持isv调用", "operationId" : "alipay.open.public.setting.category.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicSettingCategoryQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicSettingCategoryQueryErrorResponseModel" } ] } } } } } } }, "/v3/alipay/open/public/shortlink/create" : { "post" : { "tags" : [ "alipay.open.public.shortlink" ], "summary" : "服务窗短链自主生成接口", "description" : "商户通过本接口生成带自有场景标识的短链接", "operationId" : "alipay.open.public.shortlink.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicShortlinkCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicShortlinkCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicShortlinkCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/public/singlearticle/data/batchquery" : { "post" : { "tags" : [ "alipay.open.public.singlearticle.data" ], "summary" : "图文分析-按文章查询数据接口", "description" : "开发者可以通过本接口查询最近30天内发布的图文消息的数据，数据包括：发布时间、送达人数、阅读人数、分享人数等。", "operationId" : "alipay.open.public.singlearticle.data.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicSinglearticleDataBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicSinglearticleDataBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicSinglearticleDataBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/open/public/template/message/get" : { "get" : { "tags" : [ "alipay.open.public.template.message" ], "summary" : "消息模板领取接口", "description" : "帮助服务窗开发者从服务窗平台（fuwu.alipay.com）公共模板库里领取一个行业的消息模板--消息模板是一种消息的样式，如消费提醒、账单提醒等，主要用于isv帮助商户领取消息模板。", "operationId" : "alipay.open.public.template.message.get", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicTemplateMessageGetResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicTemplateMessageGetErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "template_id", "in" : "query", "description" : "消息母板id，登陆生活号后台(fuwu.alipay.com)，点击菜单“模板消息”，点击“模板库”，即可看到相应模板的消息母板id", "schema" : { "type" : "string", "example" : "TM000000223" } } ] } }, "/v3/alipay/open/public/template/message/industry/modify" : { "post" : { "tags" : [ "alipay.open.public.template.message.industry" ], "summary" : "模板消息行业设置修改接口", "description" : "用于修改服务窗消息模板设置的行业信息，如：IT科技/IT软件与服务。", "operationId" : "alipay.open.public.template.message.industry.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicTemplateMessageIndustryModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicTemplateMessageIndustryModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicTemplateMessageIndustryModifyModel" } } }, "required" : false } } }, "/v3/alipay/open/public/topic/batchquery" : { "post" : { "tags" : [ "alipay.open.public.topic" ], "summary" : "营销位查询接口", "description" : "通过此接口,开发者可以查询已经在生活号主页配置的营销位具体信息，包括标题、描述、链接等信息。", "operationId" : "alipay.open.public.topic.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicTopicBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicTopicBatchqueryErrorResponseModel" } ] } } } } } } }, "/v3/alipay/open/public/topic/create" : { "post" : { "tags" : [ "alipay.open.public.topic" ], "summary" : "营销位添加接口", "description" : "开发者可以通过此接口，在生活号主页中配置营销位，支持展示4-8个营销位，满足商家对业务的需求，需要注意的是，当某个营销位需要显示为头图时，必须要配置以下三个参数：营销位描述 (sub_title)、营销位图片（img_url）、营销位链接地址（link_url），如不需要展示头图时，以上三个参数均不要传。", "operationId" : "alipay.open.public.topic.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicTopicCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicTopicCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicTopicCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/public/topic/delete" : { "delete" : { "tags" : [ "alipay.open.public.topic" ], "summary" : "营销位删除接口", "description" : "通过此接口,开发者可以根据营销位的id删除指定的营销位。", "operationId" : "alipay.open.public.topic.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicTopicDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicTopicDeleteErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "topic_id", "in" : "query", "description" : "营销位id", "schema" : { "type" : "string", "example" : "123" } } ] } }, "/v3/alipay/open/public/topic/modify" : { "post" : { "tags" : [ "alipay.open.public.topic" ], "summary" : "营销位修改接口", "description" : "通过此接口,开发者可以修改已经在生活号主页配置的营销位具体信息，包括标题、描述、链接等信息。需要注意的是，当某个营销位需要显示为头图时，必须要配置以下三个参数：营销位描述 (sub_title)、营销位图片（img_url）、营销位链接地址（link_url），如不需要展示头图时，以上三个参数均不要传。请注意修改是针对整套营销位，会覆盖之前的营销位。", "operationId" : "alipay.open.public.topic.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicTopicModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicTopicModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicTopicModifyModel" } } }, "required" : false } } }, "/v3/alipay/open/public/user/data/batchquery" : { "post" : { "tags" : [ "alipay.open.public.user.data" ], "summary" : "用户分析数据查询接口", "description" : "通过此接口，开发者可以根据时间查询30天内的关注用户人数、取消关注用户人数、净增关注人数、累计关注人数信息", "operationId" : "alipay.open.public.user.data.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicUserDataBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicUserDataBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicUserDataBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/open/public/user/follow/query" : { "get" : { "tags" : [ "alipay.open.public.user.follow" ], "summary" : "查询用户是否已经关注了生活号", "description" : "查询用户是否已经关注生活号，支持生活号、内容号、财富号", "operationId" : "alipay.open.public.user.follow.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenPublicUserFollowQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenPublicUserFollowQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "user_id", "in" : "query", "description" : "支付宝用户id，用户在支付宝的唯一标识，以 2088 开头的 16 位纯数字组成。", "schema" : { "type" : "string", "example" : "2088132324342243" } }, { "name" : "open_id", "in" : "query", "description" : "支付宝用户唯一的标识", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } } ] } }, "/v3/alipay/open/search/ability/batchquery" : { "post" : { "tags" : [ "alipay.open.search.ability" ], "summary" : "搜索运营列表分页查询", "description" : "搜索运营列表分页查询", "operationId" : "alipay.open.search.ability.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchAbilityBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchAbilityBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchAbilityBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/open/search/appkeyword/apply" : { "post" : { "tags" : [ "alipay.open.search.appkeyword" ], "summary" : "提报搜索关键词", "description" : "提报搜索关键词", "operationId" : "alipay.open.search.appkeyword.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchAppkeywordApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchAppkeywordApplyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchAppkeywordApplyModel" } } }, "required" : false } } }, "/v3/alipay/open/search/appkeyword/batchquery" : { "get" : { "tags" : [ "alipay.open.search.appkeyword" ], "summary" : "查询小程序已配置关键词", "description" : "查询小程序已配置关键词", "operationId" : "alipay.open.search.appkeyword.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchAppkeywordBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchAppkeywordBatchqueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "target_appid", "in" : "query", "description" : "小程序id", "schema" : { "type" : "string", "example" : "2021001120654127" } }, { "name" : "status", "in" : "query", "description" : "关键词的状态，枚举值，不传该字段表示查询所有状态", "schema" : { "type" : "string", "example" : "ONLINE" } }, { "name" : "page_number", "in" : "query", "description" : "当前页", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "每页显示条数", "schema" : { "type" : "integer", "example" : "10" } } ] } }, "/v3/alipay/open/search/appkeyword/delete" : { "post" : { "tags" : [ "alipay.open.search.appkeyword" ], "summary" : "删除搜索关键词", "description" : "删除搜索关键词", "operationId" : "alipay.open.search.appkeyword.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchAppkeywordDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchAppkeywordDeleteErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchAppkeywordDeleteModel" } } }, "required" : false } } }, "/v3/alipay/open/search/appkeyword/querystatus" : { "get" : { "tags" : [ "alipay.open.search.appkeyword" ], "summary" : "查询小程序搜索关键词的审核工单的状态", "description" : "查询小程序搜索关键词的审核工单的状态", "operationId" : "alipay.open.search.appkeyword.querystatus", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchAppkeywordQuerystatusResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchAppkeywordQuerystatusErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "target_appid", "in" : "query", "description" : "小程序id", "schema" : { "type" : "string", "example" : "2021001120654127" } }, { "name" : "apply_no", "in" : "query", "description" : "审核工单id，提报接口的返回值", "schema" : { "type" : "string", "example" : "20220519000000108026" } } ] } }, "/v3/alipay/open/search/appkeywordquota/query" : { "get" : { "tags" : [ "alipay.open.search.appkeywordquota" ], "summary" : "查询小程序可配置关键词数", "description" : "查询小程序可配置关键词数", "operationId" : "alipay.open.search.appkeywordquota.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchAppkeywordquotaQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchAppkeywordquotaQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "target_appid", "in" : "query", "description" : "小程序id", "schema" : { "type" : "string", "example" : "2021001120654127" } } ] } }, "/v3/alipay/open/search/baseorder/modify" : { "post" : { "tags" : [ "alipay.open.search.baseorder" ], "summary" : "搜索运营提报基础信息工单", "description" : "搜索运营提报基础信息工单", "operationId" : "alipay.open.search.baseorder.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchBaseorderModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchBaseorderModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchBaseorderModifyModel" } } }, "required" : false } } }, "/v3/alipay/open/search/box/apply" : { "post" : { "tags" : [ "alipay.open.search.box" ], "summary" : "申请创建搜索直达配置", "description" : "申请创建搜索直达配置，相关概念说明及准入条件详见 搜索直达 \n通过该接口创建搜索直达，满足准入门槛时，创建后立马生效。", "operationId" : "alipay.open.search.box.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchBoxApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchBoxApplyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchBoxApplyModel" } } }, "required" : false } } }, "/v3/alipay/open/search/box/batchquery" : { "post" : { "tags" : [ "alipay.open.search.box" ], "summary" : "批量查询搜索直达配置列表", "description" : "批量查询商户已开通搜索直达的小程序及直达信息（搜索直达名称和id）", "operationId" : "alipay.open.search.box.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchBoxBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchBoxBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchBoxBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/open/search/box/consult" : { "post" : { "tags" : [ "alipay.open.search.box" ], "summary" : "搜索直达创建预校验", "description" : "用于对搜索直达创建申请的入参和条件进行提前判断校验。\n具体准入条件参考搜索直达准入条件", "operationId" : "alipay.open.search.box.consult", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchBoxConsultResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchBoxConsultErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchBoxConsultModel" } } }, "required" : false } } }, "/v3/alipay/open/search/box/modify" : { "post" : { "tags" : [ "alipay.open.search.box" ], "summary" : "修改搜索直达配置", "description" : "修改搜索直达配置模块，配置对应的模块参考： 搜索直达模块说明 ", "operationId" : "alipay.open.search.box.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchBoxModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchBoxModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchBoxModifyModel" } } }, "required" : false } } }, "/v3/alipay/open/search/box/offline" : { "post" : { "tags" : [ "alipay.open.search.box" ], "summary" : "下架搜索直达", "description" : "若不需要运营搜索直达时，可调用次接口下架搜索直达", "operationId" : "alipay.open.search.box.offline", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchBoxOfflineResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchBoxOfflineErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchBoxOfflineModel" } } }, "required" : false } } }, "/v3/alipay/open/search/box/online" : { "post" : { "tags" : [ "alipay.open.search.box" ], "summary" : "上架搜索直达", "description" : "若搜索直达处于下架状态时，可通过此接口来重新上架直达，上架须满足搜索直达准入门槛，若不满足，则会上架失败并报错", "operationId" : "alipay.open.search.box.online", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchBoxOnlineResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchBoxOnlineErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchBoxOnlineModel" } } }, "required" : false } } }, "/v3/alipay/open/search/box/query" : { "get" : { "tags" : [ "alipay.open.search.box" ], "summary" : "查询搜索直达配置详情", "description" : "查询商户已开通搜索直达的小程序及直达信息（搜索直达名称和id），各模块说明详见 搜索直达 。", "operationId" : "alipay.open.search.box.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchBoxQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchBoxQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "box_id", "in" : "query", "description" : "搜索直达配置id", "schema" : { "type" : "string", "example" : "20220308000000128693" } }, { "name" : "merchant_id", "in" : "query", "description" : "商户id，代运营模式下传入。代运营模式，需要服务商已获得商家\"运营支付宝小程序\"授权。", "schema" : { "type" : "string", "example" : "2088xxxxxxxxxxxx" } } ] } }, "/v3/alipay/open/search/boxactivity/apply" : { "post" : { "tags" : [ "alipay.open.search.boxactivity" ], "summary" : "申请创建搜索直达活动配置", "description" : "当搜索直达处于上架状态时，通过该接口来创建banner活动。相关概念和说明详见 搜索直达 。", "operationId" : "alipay.open.search.boxactivity.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchBoxactivityApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchBoxactivityApplyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchBoxactivityApplyModel" } } }, "required" : false } } }, "/v3/alipay/open/search/boxactivity/batchquery" : { "post" : { "tags" : [ "alipay.open.search.boxactivity" ], "summary" : "批量查询搜索直达活动配置", "description" : "批量查询多个搜索直达banner的活动信息", "operationId" : "alipay.open.search.boxactivity.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchBoxactivityBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchBoxactivityBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchBoxactivityBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/open/search/boxactivity/modify" : { "post" : { "tags" : [ "alipay.open.search.boxactivity" ], "summary" : "修改搜索直达活动配置", "description" : "修改搜索直达活动配置", "operationId" : "alipay.open.search.boxactivity.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchBoxactivityModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchBoxactivityModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchBoxactivityModifyModel" } } }, "required" : false } } }, "/v3/alipay/open/search/boxactivity/offline" : { "post" : { "tags" : [ "alipay.open.search.boxactivity" ], "summary" : "下架搜索直达活动", "description" : "需要下架某个banner活动时，可通过此接口来进行下架操作", "operationId" : "alipay.open.search.boxactivity.offline", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchBoxactivityOfflineResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchBoxactivityOfflineErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchBoxactivityOfflineModel" } } }, "required" : false } } }, "/v3/alipay/open/search/boxactivity/query" : { "get" : { "tags" : [ "alipay.open.search.boxactivity" ], "summary" : "查询搜索直达活动配置详情", "description" : "查询单个搜索直达banner的活动信息", "operationId" : "alipay.open.search.boxactivity.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchBoxactivityQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchBoxactivityQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "box_activity_id", "in" : "query", "description" : "搜索直达活动id", "schema" : { "type" : "string", "example" : "20211223000000100000" } }, { "name" : "merchant_id", "in" : "query", "description" : "商户id，代运营模式下传入。代运营模式，需要服务商已获得商家\"运营支付宝小程序\"授权。", "schema" : { "type" : "string", "example" : "2088xxxxxxxxxxxx" } } ] } }, "/v3/alipay/open/search/orderdetail/query" : { "post" : { "tags" : [ "alipay.open.search.orderdetail" ], "summary" : "查询搜索服务工单的详细信息", "description" : "查询搜索服务工单的详细信息", "operationId" : "alipay.open.search.orderdetail.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchOrderdetailQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchOrderdetailQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchOrderdetailQueryModel" } } }, "required" : false } } }, "/v3/alipay/open/search/serviceorder/batchquery" : { "post" : { "tags" : [ "alipay.open.search.serviceorder" ], "summary" : "搜索运营服务查询接口", "description" : "搜索运营服务查询接口", "operationId" : "alipay.open.search.serviceorder.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchServiceorderBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchServiceorderBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchServiceorderBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/open/search/subservicekeyword/apply" : { "post" : { "tags" : [ "alipay.open.search.subservicekeyword" ], "summary" : "提报服务关键词", "description" : "小程序-服务推广-提报服务关键词", "operationId" : "alipay.open.search.subservicekeyword.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchSubservicekeywordApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchSubservicekeywordApplyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchSubservicekeywordApplyModel" } } }, "required" : false } } }, "/v3/alipay/open/search/subservicekeyword/batchquery" : { "get" : { "tags" : [ "alipay.open.search.subservicekeyword" ], "summary" : "服务关键词批量查询接口", "description" : "批量查询小程序的服务关键词", "operationId" : "alipay.open.search.subservicekeyword.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchSubservicekeywordBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchSubservicekeywordBatchqueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "target_appid", "in" : "query", "description" : "小程序id", "schema" : { "type" : "string", "example" : "2021001112626071" } }, { "name" : "status", "in" : "query", "description" : "审核状态，服务关键词的审核状态，枚举值，不传该字段表示查询所有状态", "schema" : { "type" : "string", "example" : "ONLINE" } }, { "name" : "page_number", "in" : "query", "description" : "分页参数，分页查询时使用", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "分页参数，分页查询时使用", "schema" : { "type" : "integer", "example" : "10" } } ] } }, "/v3/alipay/open/search/subservicekeyword/delete" : { "post" : { "tags" : [ "alipay.open.search.subservicekeyword" ], "summary" : "删除服务关键词", "description" : "删除服务关键词", "operationId" : "alipay.open.search.subservicekeyword.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchSubservicekeywordDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchSubservicekeywordDeleteErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchSubservicekeywordDeleteModel" } } }, "required" : false } } }, "/v3/alipay/open/search/subservicekeyword/querystatus" : { "get" : { "tags" : [ "alipay.open.search.subservicekeyword" ], "summary" : "查询小程序服务关键词的审核工单的状态", "description" : "查询小程序服务关键词的审核工单的状态", "operationId" : "alipay.open.search.subservicekeyword.querystatus", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSearchSubservicekeywordQuerystatusResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSearchSubservicekeywordQuerystatusErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "target_appid", "in" : "query", "description" : "小程序id", "schema" : { "type" : "string", "example" : "2021001112626071" } }, { "name" : "apply_no", "in" : "query", "description" : "审核工单id，提报接口的返回值", "schema" : { "type" : "string", "example" : "20220519000000108026" } } ] } }, "/v3/alipay/open/servicemarket/commodity/shop/offline" : { "post" : { "tags" : [ "alipay.open.servicemarket.commodity.shop" ], "summary" : "球房插件下架操作", "description" : "本接口需要商户授权服务商球房操作权限后，服务商可对商户球房上的插件进行下架操作", "operationId" : "alipay.open.servicemarket.commodity.shop.offline", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenServicemarketCommodityShopOfflineResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenServicemarketCommodityShopOfflineErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenServicemarketCommodityShopOfflineModel" } } }, "required" : false } } }, "/v3/alipay/open/servicemarket/commodity/shop/online" : { "post" : { "tags" : [ "alipay.open.servicemarket.commodity.shop" ], "summary" : "球房插件上架操作", "description" : "本接口用于上架商户球房订购的服务。", "operationId" : "alipay.open.servicemarket.commodity.shop.online", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenServicemarketCommodityShopOnlineResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenServicemarketCommodityShopOnlineErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenServicemarketCommodityShopOnlineModel" } } }, "required" : false } } }, "/v3/alipay/open/servicemarket/order/accept" : { "post" : { "tags" : [ "alipay.open.servicemarket.order" ], "summary" : "服务商接单操作", "description" : "商户订购服务插件之后，需要服务商接单，调用此接口可完成接单操作", "operationId" : "alipay.open.servicemarket.order.accept", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenServicemarketOrderAcceptResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenServicemarketOrderAcceptErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenServicemarketOrderAcceptModel" } } }, "required" : false } } }, "/v3/alipay/open/servicemarket/order/create" : { "post" : { "tags" : [ "alipay.open.servicemarket.order" ], "summary" : "服务市场代订购小程序", "description" : "第三方服务商可以创建服务市场的订单，并代为创建小程序应用，小程序应用授权给服务商", "operationId" : "alipay.open.servicemarket.order.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenServicemarketOrderCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenServicemarketOrderCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "app_logo" : { "type" : "string", "format" : "binary" }, "data" : { "$ref" : "#/components/schemas/AlipayOpenServicemarketOrderCreateModel" } } }, "encoding" : { "app_logo" : { "contentType" : "*/*" }, "data" : { "contentType" : "application/json" } } } }, "required" : false } } }, "/v3/alipay/open/servicemarket/order/item/cancel" : { "post" : { "tags" : [ "alipay.open.servicemarket.order.item" ], "summary" : "服务订单明细实施项单项取消", "description" : "服务商可以单个取消订单明细实施项", "operationId" : "alipay.open.servicemarket.order.item.cancel", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenServicemarketOrderItemCancelResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenServicemarketOrderItemCancelErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenServicemarketOrderItemCancelModel" } } }, "required" : false } } }, "/v3/alipay/open/servicemarket/order/item/complete" : { "post" : { "tags" : [ "alipay.open.servicemarket.order.item" ], "summary" : "服务商完成订单内单个明细实施项", "description" : "商户在订购插件后，服务商完成实施操作，此接口会检测当前订单必须所属当前操作服务商", "operationId" : "alipay.open.servicemarket.order.item.complete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenServicemarketOrderItemCompleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenServicemarketOrderItemCompleteErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenServicemarketOrderItemCompleteModel" } } }, "required" : false } } }, "/v3/alipay/open/servicemarket/order/item/confirm" : { "post" : { "tags" : [ "alipay.open.servicemarket.order.item" ], "summary" : "服务商代商家确认实施完成", "description" : "此接口需商家授权服务商应用权限后，服务商可代商家进行实施确认完成动作", "operationId" : "alipay.open.servicemarket.order.item.confirm", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenServicemarketOrderItemConfirmResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenServicemarketOrderItemConfirmErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenServicemarketOrderItemConfirmModel" } } }, "required" : false } } }, "/v3/alipay/open/servicemarket/order/notify" : { "post" : { "tags" : [ "alipay.open.servicemarket.order" ], "summary" : "服务市场商户确认订购通知", "description" : "服务市场当商户选择服务商提供产品并订购确认时，通知服务商订单消息。服务商可以通过通知的消息内容回查该订单明细。回查接口（alipay.open.servicemarket.order.query）", "operationId" : "alipay.open.servicemarket.order.notify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenServicemarketOrderNotifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenServicemarketOrderNotifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CommonNotifyUrlModel" } } }, "required" : false } } }, "/v3/alipay/open/servicemarket/order/query" : { "get" : { "tags" : [ "alipay.open.servicemarket.order" ], "summary" : "订购插件订单明细查询", "description" : "第三方服务商提供服务产品被商户订购后，服务市场会推送订单信息给服务商，服务商根据订单号回查该订单明细信息。", "operationId" : "alipay.open.servicemarket.order.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenServicemarketOrderQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenServicemarketOrderQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "commodity_order_id", "in" : "query", "description" : "订购服务订单ID，通过支付宝发送的 https://opendocs.alipay.com/apis/api_3/alipay.open.servicemarket.order.notify(服务市场商户确认订购通知) 通知获取。", "schema" : { "type" : "string", "example" : "20160010200000000033400" } }, { "name" : "start_page", "in" : "query", "description" : "查询开始页码，1 为第一页。", "schema" : { "type" : "string", "example" : "1" } } ] } }, "/v3/alipay/open/servicemarket/order/reject" : { "post" : { "tags" : [ "alipay.open.servicemarket.order" ], "summary" : "服务商拒绝接单", "description" : "服务商可以拒接商户购买服务插件订单", "operationId" : "alipay.open.servicemarket.order.reject", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenServicemarketOrderRejectResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenServicemarketOrderRejectErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenServicemarketOrderRejectModel" } } }, "required" : false } } }, "/v3/alipay/open/servicemarket/promotiontask/relation/query" : { "get" : { "tags" : [ "alipay.open.servicemarket.promotiontask.relation" ], "summary" : "服务商推广关系查询", "description" : "用于开发服务商查询已与其达成推广关系的地推服务商信息", "operationId" : "alipay.open.servicemarket.promotiontask.relation.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenServicemarketPromotiontaskRelationQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenServicemarketPromotiontaskRelationQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "commodity_id", "in" : "query", "description" : "服务商品ID", "schema" : { "type" : "string", "example" : "SS010101000000003954" } }, { "name" : "page_size", "in" : "query", "description" : "每页数量，范围(1-100)。默认：10", "schema" : { "type" : "integer", "example" : "10" } }, { "name" : "page_num", "in" : "query", "description" : "当前页码，从1开始。默认：1", "schema" : { "type" : "integer", "example" : "1" } } ] } }, "/v3/alipay/open/sp/blueseaactivity/create" : { "post" : { "tags" : [ "alipay.open.sp.blueseaactivity" ], "summary" : "服务商返佣活动报名申请", "description" : "服务商返佣活动报名", "operationId" : "alipay.open.sp.blueseaactivity.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpBlueseaactivityCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSpBlueseaactivityCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpBlueseaactivityCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/sp/blueseaactivity/modify" : { "post" : { "tags" : [ "alipay.open.sp.blueseaactivity" ], "summary" : "服务商返佣活动申请单修改", "description" : "服务商返佣活动", "operationId" : "alipay.open.sp.blueseaactivity.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpBlueseaactivityModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSpBlueseaactivityModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpBlueseaactivityModifyModel" } } }, "required" : false } } }, "/v3/alipay/open/sp/blueseaactivity/query" : { "get" : { "tags" : [ "alipay.open.sp.blueseaactivity" ], "summary" : "服务商返佣活动申请单详情查询", "description" : "服务商返佣活动", "operationId" : "alipay.open.sp.blueseaactivity.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpBlueseaactivityQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSpBlueseaactivityQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "order_id", "in" : "query", "description" : "申请单 id。通过 alipay.open.sp.blueseaactivity.create接口获取", "schema" : { "type" : "string", "example" : "5881" } } ] } }, "/v3/alipay/open/sp/image/upload" : { "post" : { "tags" : [ "alipay.open.sp.image" ], "summary" : "图片上传接口", "description" : "图片上传", "operationId" : "alipay.open.sp.image.upload", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpImageUploadResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSpImageUploadErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "image_content" : { "type" : "string", "format" : "binary" } } }, "encoding" : { "image_content" : { "contentType" : "*/*" } } } }, "required" : false } } }, "/v3/alipay/open/sp/isv/bill/sync" : { "post" : { "tags" : [ "alipay.open.sp.isv.bill" ], "summary" : "服务商账单数据回传", "description" : "针对SSB业务中，S1回传S2推广过程中，获得的分佣账单数据", "operationId" : "alipay.open.sp.isv.bill.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpIsvBillSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSpIsvBillSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpIsvBillSyncModel" } } }, "required" : false } } }, "/v3/alipay/open/sp/isv/operation/sync" : { "post" : { "tags" : [ "alipay.open.sp.isv.operation" ], "summary" : "服务商作业结果数据回传", "description" : "针对SSB业务中，S1回传S2推广过程中，获得的作业结果数据", "operationId" : "alipay.open.sp.isv.operation.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpIsvOperationSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSpIsvOperationSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpIsvOperationSyncModel" } } }, "required" : false } } }, "/v3/alipay/open/sp/isv/relation/query" : { "get" : { "tags" : [ "alipay.open.sp.isv.relation" ], "summary" : "spcenter服务商推广关系查询", "description" : "用于开发服务商查询已与其达成推广关系的地推服务商信息", "operationId" : "alipay.open.sp.isv.relation.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpIsvRelationQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSpIsvRelationQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "commodity_id", "in" : "query", "description" : "服务市场商品Code", "schema" : { "type" : "string", "example" : "SS010301000000001908" } }, { "name" : "page_size", "in" : "query", "description" : "每页数量，范围(1-100)。默认：10", "schema" : { "type" : "string", "example" : "10" } }, { "name" : "page_num", "in" : "query", "description" : "当前页码，从1开始。默认：1", "schema" : { "type" : "string", "example" : "1" } } ] } }, "/v3/alipay/open/sp/isv/sales/sync" : { "post" : { "tags" : [ "alipay.open.sp.isv.sales" ], "summary" : "商户销售数据回传接口", "description" : "针对SSB业务中，S2推广之后，推广的产品的销售数据回传", "operationId" : "alipay.open.sp.isv.sales.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpIsvSalesSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSpIsvSalesSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpIsvSalesSyncModel" } } }, "required" : false } } }, "/v3/alipay/open/sp/isv/signauth/create" : { "post" : { "tags" : [ "alipay.open.sp.isv.signauth" ], "summary" : "创建签约授权一体化订单", "description" : "针对签约授权一体化场景，创建签约授权一体化订单绑定签约单（可选）、绑定代运营授权单、应用授权单，跟踪整个签约授权一体化订单的状态", "operationId" : "alipay.open.sp.isv.signauth.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpIsvSignauthCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSpIsvSignauthCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpIsvSignauthCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/sp/isv/signauth/query" : { "get" : { "tags" : [ "alipay.open.sp.isv.signauth" ], "summary" : "查询签约授权一体化订单状态详情", "description" : "查询签约授权一体化订单状态详情（包含子任务信息）", "operationId" : "alipay.open.sp.isv.signauth.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpIsvSignauthQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSpIsvSignauthQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "order_id", "in" : "query", "description" : "签约授权一体化订单ID\t可通过alipay.open.sp.isv.signauth.create 接口获取", "schema" : { "type" : "string", "example" : "20211102034000100000047728652040" } } ] } }, "/v3/alipay/open/sp/leads/expand/create" : { "post" : { "tags" : [ "alipay.open.sp.leads.expand" ], "summary" : "在线写入商机库", "description" : "在线写入商机库", "operationId" : "alipay.open.sp.leads.expand.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpLeadsExpandCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSpLeadsExpandCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpLeadsExpandCreateModel" } } }, "required" : false } } }, "/v3/alipay/open/sp/merchant/inconsistent/approve" : { "post" : { "tags" : [ "alipay.open.sp.merchant.inconsistent" ], "summary" : "非同人商家进件资料审批", "description" : "针对服务优选扫码点餐小程序，用于收集并审核非同人商家的进件资料。", "operationId" : "alipay.open.sp.merchant.inconsistent.approve", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpMerchantInconsistentApproveResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSpMerchantInconsistentApproveErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpMerchantInconsistentApproveModel" } } }, "required" : false } } }, "/v3/alipay/open/sp/operation/apply" : { "post" : { "tags" : [ "alipay.open.sp.operation" ], "summary" : "向商户发起代运营操作", "description" : "服务商向商户发起代运营操作（账号绑定或者代运营授权）", "operationId" : "alipay.open.sp.operation.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpOperationApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSpOperationApplyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpOperationApplyModel" } } }, "required" : false } } }, "/v3/alipay/open/sp/operation/qrcode/query" : { "get" : { "tags" : [ "alipay.open.sp.operation.qrcode" ], "summary" : "查询代运营授权或者账号绑定二维码", "description" : "面向服务商，查询发起代运营授权或者账号绑定的二维码。代间联商户代运营时，推荐使用接口同步返回的recommend_accounts字段中的账号扫码确认。", "operationId" : "alipay.open.sp.operation.qrcode.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpOperationQrcodeQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSpOperationQrcodeQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "out_biz_no", "in" : "query", "description" : "外部操作流水，由服务商自定义，需确保每次操作唯一。仅支持数字、字母、下划线组合。", "schema" : { "type" : "string", "example" : "2020124234523465636345634" } }, { "name" : "operate_type", "in" : "query", "description" : "代运营操作类型。取值如下：\t* ACCOUNT_BIND：账号绑定，仅支持间连商户。\t* OPERATION_AUTH：代运营授权，支持间连、直连商户。", "schema" : { "type" : "string", "example" : "OPERATION_AUTH" } }, { "name" : "merchant_no", "in" : "query", "description" : "支付宝商户号。注意仅支持 2088 开头的间连商户。\t若被代运营者是间连商户，则 merchant_no 必填；\t若为直连商户，则 merchant_no 和 alipay_account 不能同时为空，都有值优先取 merchant_no。", "schema" : { "type" : "string", "example" : "2088XXXX" } }, { "name" : "alipay_account", "in" : "query", "description" : "支付宝登录账号。通常为手机号或者邮箱。\t若被代运营者是间连商户，该字段无需填写。\t若为直连商户，则 merchant_no 和 alipay_account 不能同时为空，都有值优先取 merchant_no。", "schema" : { "type" : "string", "example" : "xxx@gmail.com" } }, { "name" : "access_product_code", "in" : "query", "description" : "接入的产品编号。\t操作类型为绑定的，填OPENAPI_BIND_DEFAULT;\t操作类型为授权的，填OPENAPI_AUTH_DEFAULT", "schema" : { "type" : "string", "example" : "OPENAPI_AUTH_DEFAULT" } }, { "name" : "isv_scene_permissions", "in" : "query", "description" : "场景授权列表结构结构：场景codeA:权限code1,权限code2;场景codeB:权限code1,权限code2;", "schema" : { "type" : "string", "example" : "SHOP_MANAGE:SHOP_MANAGE_BASE;PROMOTION_MANAGE:PROMOTION_MANAGE_BASE" } } ] } }, "/v3/alipay/open/sp/operation/result/query" : { "get" : { "tags" : [ "alipay.open.sp.operation.result" ], "summary" : "查询服务商代运营操作结果", "description" : "查询服务商代运营操作（代运营授权或者账号绑定）结果。提供两种查询方式：\n方式一：operate_type + batch_no，提供基于操作批次的精确查询，只查询本操作批次的代运营操作结果，不反映最终代运营操作结果。 方式一查询方式优先级更高。\n方式二：operate_type + access_product_code + merchant_no + alipay_account 参数组合，可以查询代运营操作最终结果，任意一个操作批次成功都会体现在最终结果中。\n方式三：operate_type + isv_scene_permissions + merchant_no + alipay_account 参数组合，可以查询代运营操作最终结果，任意一个操作批次成功都会体现在最终结果中（仅支持查询授权结果）。", "operationId" : "alipay.open.sp.operation.result.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpOperationResultQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSpOperationResultQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "operate_type", "in" : "query", "description" : "代运营操作类型。取值如下 ACCOUNT_BIND：账号绑定； OPERATION_AUTH：代运营授权。", "schema" : { "type" : "string", "example" : "ACCOUNT_BIND" } }, { "name" : "batch_no", "in" : "query", "description" : "支付宝操作批次号。\tbatch_no提供基于操作批次的精确查询，只查询本操作批次的代运营操作结果，不反映最终代运营操作结果。\t注意：\t1.access_product_code、merchant_no、alipay_account三个参数组合与传入 batch_no 为两种查询方式，不可同时为空且以 batch_no 优先。\t2.access_product_code、merchant_no、alipay_account三个参数组合可以查询最终代运营操作结果。", "schema" : { "type" : "string", "example" : "2020222342342" } }, { "name" : "access_product_code", "in" : "query", "description" : "接入的产品编号。未传batch_no时必填，枚举如下：\tOPENAPI_BIND_DEFAULT：操作类型为账号绑定；\tOPENAPI_AUTH_DEFAULT：操作类型为代运营授权。", "schema" : { "type" : "string", "example" : "OPENAPI_BIND_DEFAULT" } }, { "name" : "merchant_no", "in" : "query", "description" : "支付宝商户号。支持间连、直连商户，值为2088开头。\t未传batch_no时需注意：\t若查询间连商户则 merchant_no 必填； \t若查询直连商户，则merchant_no和alipay_account不能同时为空，都有值优先取merchant_no。", "schema" : { "type" : "string", "example" : "2088912341234123" } }, { "name" : "alipay_account", "in" : "query", "description" : "支付宝登录账号，通常为手机号或者邮箱。未传batch_no时需注意：\t1.当查询merchant_no为间连商户时：\t * 若 operate_type=ACCOUNT_BIND，则alipay_account必填。\t * 若 operate_type=OPERATION_AUTH，则alipay_account无需传入。\t2.当查询merchant_no为直连商户时：\t * merchant_no和alipay_account不能同时为空，都有值优先取merchant_no。", "schema" : { "type" : "string", "example" : "testaccount@test.com" } }, { "name" : "isv_scene_permissions", "in" : "query", "description" : "场景授权列表结构结构：场景codeA:权限code1,权限code2;场景codeB:权限code1,权限code2;", "schema" : { "type" : "string", "example" : "SHOP_MANAGE:SHOP_MANAGE_BASE;PROMOTION_MANAGE:PROMOTION_MANAGE_BASE" } } ] } }, "/v3/alipay/open/sp/oppor/detail/query" : { "get" : { "tags" : [ "alipay.open.sp.oppor.detail" ], "summary" : "商机作业详情查询", "description" : "商机作业详情查询", "operationId" : "alipay.open.sp.oppor.detail.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpOpporDetailQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSpOpporDetailQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "isv_pid", "in" : "query", "description" : "服务商pid", "schema" : { "type" : "string", "example" : "2088501013445414" } }, { "name" : "oppor_id", "in" : "query", "description" : "商机作业Id", "schema" : { "type" : "string", "example" : "2022041403518351" } } ] } }, "/v3/alipay/open/sp/oppor/feedback/modify" : { "post" : { "tags" : [ "alipay.open.sp.oppor.feedback" ], "summary" : "商机拓展完成", "description" : "商机拓展完成", "operationId" : "alipay.open.sp.oppor.feedback.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpOpporFeedbackModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSpOpporFeedbackModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpOpporFeedbackModifyModel" } } }, "required" : false } } }, "/v3/alipay/open/sp/oppor/page/query" : { "get" : { "tags" : [ "alipay.open.sp.oppor.page" ], "summary" : "商机作业列表查询", "description" : "商机作业列表查询", "operationId" : "alipay.open.sp.oppor.page.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenSpOpporPageQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenSpOpporPageQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "isv_pid", "in" : "query", "description" : "服务商pid", "schema" : { "type" : "string", "example" : "2088302213873401" } }, { "name" : "status_list", "in" : "query", "description" : "作业记录状态列表,以,拼接传入", "schema" : { "type" : "string", "example" : "WAIT_MER_CONFIRM,MER_CONFIRMED,MER_REJECTED,EXPANDING,EXPANDED,EXPAND_FAILED" } }, { "name" : "page_size", "in" : "query", "description" : "页大小", "schema" : { "type" : "string", "example" : "10" } }, { "name" : "page_num", "in" : "query", "description" : "页数", "schema" : { "type" : "string", "example" : "1" } } ] } }, "/v3/alipay/open/violation/violationdetail/query" : { "get" : { "tags" : [ "alipay.open.violation.violationdetail" ], "summary" : "违规记录详情查询", "description" : "违规记录详情查询", "operationId" : "alipay.open.violation.violationdetail.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenViolationViolationdetailQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenViolationViolationdetailQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "violation_record_id", "in" : "query", "description" : "支付宝侧生成的违规记录唯一标识", "schema" : { "type" : "string", "example" : "202205240010200000000000000" } } ] } }, "/v3/alipay/open/violation/violationevent/batchquery" : { "post" : { "tags" : [ "alipay.open.violation.violationevent" ], "summary" : "违规记录列表查询", "description" : "违规记录列表查询", "operationId" : "alipay.open.violation.violationevent.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenViolationViolationeventBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayOpenViolationViolationeventBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayOpenViolationViolationeventBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/pcredit/huabei/auth/accumulation/query" : { "get" : { "tags" : [ "alipay.pcredit.huabei.auth.accumulation" ], "summary" : "花芝轻会员周期累计数据查询", "description" : "根据协议与对应的周期查询支付宝累计数据。", "operationId" : "alipay.pcredit.huabei.auth.accumulation.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayPcreditHuabeiAuthAccumulationQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayPcreditHuabeiAuthAccumulationQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "agreement_no", "in" : "query", "description" : "支付宝系统中用以唯一标识用户签约记录的编号。", "schema" : { "type" : "string", "example" : "20170502000610755993" } }, { "name" : "period", "in" : "query", "description" : "协议结算周期，使用支付宝端回传的周期信息。", "schema" : { "type" : "string", "example" : "20181223235059-20181230235010" } }, { "name" : "alipay_user_id", "in" : "query", "description" : "买家在支付宝的用户id", "schema" : { "type" : "string", "example" : "2088101117955611" } }, { "name" : "open_id", "in" : "query", "description" : "买家在支付宝的用户id", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } } ] } }, "/v3/alipay/pcredit/huabei/auth/agreement/close" : { "put" : { "tags" : [ "alipay.pcredit.huabei.auth.agreement" ], "summary" : "花芝协议关闭接口", "description" : "用户已经开通花芝先享后，商户可通过此接口提前关闭协议。", "operationId" : "alipay.pcredit.huabei.auth.agreement.close", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayPcreditHuabeiAuthAgreementCloseResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayPcreditHuabeiAuthAgreementCloseErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayPcreditHuabeiAuthAgreementCloseModel" } } }, "required" : false } } }, "/v3/alipay/pcredit/huabei/auth/agreement/query" : { "get" : { "tags" : [ "alipay.pcredit.huabei.auth.agreement" ], "summary" : "花芝轻会员协议查询接口", "description" : "花芝轻会员协议查询，返回协议的状态。如果协议处于签约状态，同时返回最新的资金池余额。\n有两种方式查询。优先使用agreement_no查询；其次是使用(out_sign_no, auth_scene)查询。\n如果商户不能保证out_sign_no的唯一性，慎用(out_sign_no, auth_scene)的查询方式，它优先返回仍处于签约状态的协议。", "operationId" : "alipay.pcredit.huabei.auth.agreement.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayPcreditHuabeiAuthAgreementQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayPcreditHuabeiAuthAgreementQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "agreement_no", "in" : "query", "description" : "支付宝系统中用以唯一标识用户签约记录的编号，即花芝轻会员。传入该参数，会忽略其它所有参数。", "schema" : { "type" : "string", "example" : "20185513447859192007" } }, { "name" : "alipay_user_id", "in" : "query", "description" : "买家在支付宝的用户id", "schema" : { "type" : "string", "example" : "2088101117955611" } }, { "name" : "open_id", "in" : "query", "description" : "买家在支付宝的用户id", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } }, { "name" : "out_sign_no", "in" : "query", "description" : "外部签约号，由商户提供，花芝轻会员协议中标识用户的唯一签约号（确保在商户系统中唯一）。", "schema" : { "type" : "string", "example" : "2018053100073208416400000002" } }, { "name" : "auth_scene", "in" : "query", "description" : "花芝轻会员签约场景，商户和支付宝签约时确定。该值需要与系统/页面签约接口调用时传入的值保持一致。", "schema" : { "type" : "string", "example" : "EXTERNAL_PCARD" } } ] } }, "/v3/alipay/pcredit/huabei/auth/order/query" : { "get" : { "tags" : [ "alipay.pcredit.huabei.auth.order" ], "summary" : "花呗先享订单查询接口", "description" : "查询花呗先享冻结、解冻订单内容及状态。有3种查询方式。推荐商户优先使用auth_opt_id查询；其次是按照(alipay_user_id,out_request_no)组合方式查询；最后是单独通过out_request_no方式查询。\r\n注意：最后一种方式，仅支持2019年2月15日开始的订单。", "operationId" : "alipay.pcredit.huabei.auth.order.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayPcreditHuabeiAuthOrderQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayPcreditHuabeiAuthOrderQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "auth_opt_id", "in" : "query", "description" : "支付宝侧花呗冻结、解冻操作单据id。在原先的冻结或者解冻接口调用中同步返回给商户，或者通过商户通知返回给商户。按订单号查询时，此字段不可为空。", "schema" : { "type" : "string", "example" : "2018081010020817070009689955" } }, { "name" : "alipay_user_id", "in" : "query", "description" : "买家在支付宝的用户id。通过userid+请求流水号组合查询时，此字段不可为空。", "schema" : { "type" : "string", "example" : "2088101117955611" } }, { "name" : "open_id", "in" : "query", "description" : "买家在支付宝的用户id", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } }, { "name" : "out_request_no", "in" : "query", "description" : "商户原先调用冻结、解冻接口传入的请求流水号。按照流水号查询订单时，此字段不能为空。", "schema" : { "type" : "string", "example" : "8077735255938032" } } ] } }, "/v3/alipay/pcredit/huabei/auth/order/unfreeze" : { "put" : { "tags" : [ "alipay.pcredit.huabei.auth.order" ], "summary" : "花呗先享解冻或解约接口", "description" : "用户已经开通花呗先享协议后，商户通过此接口解冻用户资金池金额，也可以解冻并解约。\r\n如果是解约操作，则要求传入的解冻金额必须等于用户资金池余额。\r\n注意：商户在发起解约前，请务必保证已经结算过用户会员费，一旦解约后，无法发起结算用户会员费操作。", "operationId" : "alipay.pcredit.huabei.auth.order.unfreeze", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayPcreditHuabeiAuthOrderUnfreezeResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayPcreditHuabeiAuthOrderUnfreezeErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayPcreditHuabeiAuthOrderUnfreezeModel" } } }, "required" : false } } }, "/v3/alipay/pcredit/huabei/auth/refund/apply" : { "put" : { "tags" : [ "alipay.pcredit.huabei.auth.refund" ], "summary" : "花芝结算扣款费用逆向退款申请", "description" : "用于1)芝麻GO会员费扣款逆向退款操作2）周期扣款每期扣款逆向退款操作", "operationId" : "alipay.pcredit.huabei.auth.refund.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayPcreditHuabeiAuthRefundApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayPcreditHuabeiAuthRefundApplyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayPcreditHuabeiAuthRefundApplyModel" } } }, "required" : false } } }, "/v3/alipay/pcredit/huabei/auth/settle/apply" : { "put" : { "tags" : [ "alipay.pcredit.huabei.auth.settle" ], "summary" : "花芝轻会员结算申请", "description" : "用户已经开通花芝轻会员协议后，商户通过此接口解冻转支付用户冻结金额。传入金额必须小于等于冻结金额", "operationId" : "alipay.pcredit.huabei.auth.settle.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayPcreditHuabeiAuthSettleApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayPcreditHuabeiAuthSettleApplyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayPcreditHuabeiAuthSettleApplyModel" } } }, "required" : false } } }, "/v3/alipay/security/data/sss/create/{a}" : { "post" : { "tags" : [ "alipay.security.data.sss" ], "summary" : "文档回归测试勿动openapi_openid_post多场景", "description" : "文档回归测试勿动openapi_openid_post多场景", "operationId" : "alipay.security.data.sss.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipaySecurityDataSssCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipaySecurityDataSssCreateErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "b", "in" : "query", "description" : "有枚举，必须，有openid，有注意事项", "schema" : { "type" : "string", "example" : "12" } }, { "name" : "b_open_id", "in" : "query", "description" : "有枚举，必须，有openid，有注意事项", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } }, { "name" : "a", "in" : "path", "description" : "path.数字，无枚举，有注意事项", "required" : true, "schema" : { "type" : "integer", "example" : "1" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipaySecurityDataSssCreateModel" } } }, "required" : false } } }, "/v3/alipay/security/prod/sss/query/{bbb}" : { "post" : { "tags" : [ "alipay.security.prod.sss" ], "summary" : "金柚测试3.0接口", "description" : "金柚测试3.0接口", "operationId" : "alipay.security.prod.sss.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipaySecurityProdSssQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipaySecurityProdSssQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "aaa", "in" : "query", "description" : "1", "schema" : { "type" : "string", "example" : "3333" } }, { "name" : "aaa_open_id", "in" : "query", "description" : "1", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } }, { "name" : "bbb", "in" : "path", "description" : "activity_id 词条描述", "required" : true, "schema" : { "type" : "string", "example" : "1" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipaySecurityProdSssQueryModel" } } }, "required" : false } } }, "/v3/alipay/security/prod/tianwutest/modify" : { "post" : { "tags" : [ "alipay.security.prod.tianwutest" ], "summary" : "tianwutest", "description" : "tianwutest", "operationId" : "alipay.security.prod.tianwutest.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipaySecurityProdTianwutestModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipaySecurityProdTianwutestModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipaySecurityProdTianwutestModifyModel" } } }, "required" : false } } }, "/v3/alipay/security/risk/customerrisk/send" : { "post" : { "tags" : [ "alipay.security.risk.customerrisk" ], "summary" : "商户数据同步", "description" : "判断商户有问题时，服务商将商户信息同步到支付宝", "operationId" : "alipay.security.risk.customerrisk.send", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipaySecurityRiskCustomerriskSendResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipaySecurityRiskCustomerriskSendErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipaySecurityRiskCustomerriskSendModel" } } }, "required" : false } } }, "/v3/alipay/security/risk/verifyidentity/miniapp/confirm" : { "post" : { "tags" : [ "alipay.security.risk.verifyidentity.miniapp" ], "summary" : "小程序核验服务结果确认接口", "description" : "确认身份核验结果接口", "operationId" : "alipay.security.risk.verifyidentity.miniapp.confirm", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipaySecurityRiskVerifyidentityMiniappConfirmResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipaySecurityRiskVerifyidentityMiniappConfirmErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipaySecurityRiskVerifyidentityMiniappConfirmModel" } } }, "required" : false } } }, "/v3/alipay/social/base/contentlib/standardcontent/batchquery" : { "post" : { "tags" : [ "alipay.social.base.contentlib.standardcontent" ], "summary" : "内容批量查询接口", "description" : "支付宝生活号+查询当前账号下发布过的内容及对应详情信息", "operationId" : "alipay.social.base.contentlib.standardcontent.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipaySocialBaseContentlibStandardcontentBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipaySocialBaseContentlibStandardcontentBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipaySocialBaseContentlibStandardcontentBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/system/oauth/token" : { "post" : { "tags" : [ "alipay.system.oauth" ], "summary" : "换取授权访问令牌", "description" : "换取授权访问令牌", "operationId" : "alipay.system.oauth.token", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipaySystemOauthTokenResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipaySystemOauthTokenErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipaySystemOauthTokenModel" } } }, "required" : false } } }, "/v3/alipay/trade/advance/consult" : { "get" : { "tags" : [ "alipay.trade.advance" ], "summary" : "订单咨询服务", "description" : "商户通过此接口咨询，当前用户是否满足垫资服务条件 或者 针对单笔订单的风险评估进行预咨询服务。", "operationId" : "alipay.trade.advance.consult", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeAdvanceConsultResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeAdvanceConsultErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "alipay_user_id", "in" : "query", "description" : "支付宝用户 id，2088开头的16为数字。\t除单笔订单风险预评估场景(即consult_scene指定ORDER_RISK_EVALUATION)外，其他场景必选。", "schema" : { "type" : "string", "example" : "2088302483540171" } }, { "name" : "consult_scene", "in" : "query", "description" : "订单咨询类型，用以选择咨询的服务。不传时默认为垫资咨询，其他的场景需要按照对接的服务传入指定的值。\tORDER_RISK_EVALUATION：表示单笔订单风险预评估。", "schema" : { "type" : "string", "example" : "ORDER_RISK_EVALUATION" } }, { "name" : "industry_product_code", "in" : "query", "description" : "行业产品信息，咨询时会从该产品对应的销售方案中获取相关垫资规则配置。", "schema" : { "type" : "string", "example" : "CAR_OWNERS_PARKINGPAY" } }, { "name" : "sub_merchant_id", "in" : "query", "description" : "子商户id", "schema" : { "type" : "string", "example" : "2088102122458832" } }, { "name" : "sub_merchant_type", "in" : "query", "description" : "子商户类型", "schema" : { "type" : "string", "example" : "PARTNER" } }, { "name" : "agreement_no", "in" : "query", "description" : "支付宝系统中用以唯一标识用户签约记录的编号（用户签约成功后的协议号 ） ，在进行单笔订单风险评估预咨询时必传。", "schema" : { "type" : "string", "example" : "20170322450983769228" } }, { "name" : "estimated_order_amount", "in" : "query", "description" : "预估订单总金额，单位为元，精确到小数点后两位，单笔订单风险预评估时使用，取值范围[0.01,100000000]。", "schema" : { "type" : "string", "example" : "9.00" } }, { "name" : "out_trade_no", "in" : "query", "description" : "商户请求时的外部订单号，在花芝场景下非空。", "schema" : { "type" : "string", "example" : "test20191100000001" } }, { "name" : "need_user_risk_prediction", "in" : "query", "description" : "是否需要进行用户风险预测", "schema" : { "type" : "string", "example" : "true" } }, { "name" : "trade_digest", "in" : "query", "description" : "交易信息摘要，需要进行用户风险预测时可传，用于结合场景的更加精细的预测。具体信息结构服务接入前咨询约定。", "schema" : { "type" : "string", "example" : "{{\"parking_city\":\"太原市\",\"vehicle_number\":\"辽7666666\"}}" } }, { "name" : "user_out_binding_phone", "in" : "query", "description" : "用户在外部域账号系统绑定的手机号，需要进行用户风险预测时必传，用于预测用户是否面临被二次放号的场景。使用时需要对请求加密，加密后请求在公网传输时为加密文本。详见：https://opendocs.alipay.com/open/common/104567；https://opendocs.alipay.com/isv/grefvl/getaes", "schema" : { "type" : "string", "example" : "1868888888888" } } ] } }, "/v3/alipay/trade/applepay/authentication/submit" : { "post" : { "tags" : [ "alipay.trade.applepay.authentication" ], "summary" : "ApplePay支付鉴权提交", "description" : "ApplePay定义的接口，支付宝进行适配。ApplePay端支付核身完毕后，提交到支付宝进行核身验证+支付推进。", "operationId" : "alipay.trade.applepay.authentication.submit", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeApplepayAuthenticationSubmitResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeApplepayAuthenticationSubmitErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeApplepayAuthenticationSubmitModel" } } }, "required" : false } } }, "/v3/alipay/trade/batch/settle" : { "post" : { "tags" : [ "alipay.trade.batch" ], "summary" : "批量结算", "description" : "买家付款成功之后，资金进入二级商户待结算户，支付宝等待平台的结算指令进行结算。平台可根据平台规则，发起批量结算请求，将资金结算到二级商户的结算账号。请款金额只要不超过待结算的总余额即可。", "operationId" : "alipay.trade.batch.settle", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeBatchSettleResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeBatchSettleErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeBatchSettleModel" } } }, "required" : false } } }, "/v3/alipay/trade/batch/settle/query" : { "post" : { "tags" : [ "alipay.trade.batch.settle" ], "summary" : "批量结算查询", "description" : "商户请求批量结算结果查询", "operationId" : "alipay.trade.batch.settle.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeBatchSettleQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeBatchSettleQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeBatchSettleQueryModel" } } }, "required" : false } } }, "/v3/alipay/trade/batch/transfer" : { "post" : { "tags" : [ "alipay.trade.batch" ], "summary" : "请款分账", "description" : "在红星美凯龙场景下，请款到不同主体的银行卡/账户中", "operationId" : "alipay.trade.batch.transfer", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeBatchTransferResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeBatchTransferErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeBatchTransferModel" } } }, "required" : false } } }, "/v3/alipay/trade/batch/transfer/query" : { "get" : { "tags" : [ "alipay.trade.batch.transfer" ], "summary" : "请款分账查询接口", "description" : "针对请款分账接口的查询功能", "operationId" : "alipay.trade.batch.transfer.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeBatchTransferQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeBatchTransferQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "out_request_no", "in" : "query", "description" : "批量结算时传入的外部流水号，与settle_no二者必填其一。 out_request_no和settle_no如果同时存在，优先取settle_no", "schema" : { "type" : "string", "example" : "20180101" } }, { "name" : "settle_no", "in" : "query", "description" : "结算单据号，与out_request_no二者必填其一", "schema" : { "type" : "string", "example" : "2019050510032002040000053220" } }, { "name" : "extend_params", "in" : "query", "description" : "扩展字段", "schema" : { "type" : "string", "example" : "{\"key\":\"value\"}" } } ] } }, "/v3/alipay/trade/cancel" : { "post" : { "tags" : [ "alipay.trade" ], "summary" : "统一收单交易撤销接口", "description" : "支付交易返回失败或支付系统超时，调用该接口撤销交易。如果此订单用户支付失败，支付宝系统会将此订单关闭；如果用户支付成功，支付宝系统会将此订单资金退还给用户。\r\n注意：只有发生支付系统超时或者支付结果未知时可调用撤销，其他正常支付的单如需实现相同功能请调用申请退款API。提交支付交易后调用【查询订单API】，没有明确的支付结果再调用【撤销订单API】。", "operationId" : "alipay.trade.cancel", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeCancelResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeCancelErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeCancelModel" } } }, "required" : false } } }, "/v3/alipay/trade/close" : { "post" : { "tags" : [ "alipay.trade" ], "summary" : "统一收单交易关闭接口", "description" : "用于交易创建后，用户在一定时间内未进行支付，可调用该接口直接将未付款的交易进行关闭。", "operationId" : "alipay.trade.close", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeCloseResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeCloseErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeCloseModel" } } }, "required" : false } } }, "/v3/alipay/trade/create" : { "post" : { "tags" : [ "alipay.trade" ], "summary" : "统一收单交易创建接口", "description" : "商户通过该接口进行交易的创建下单", "operationId" : "alipay.trade.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeCreateModel" } } }, "required" : false } } }, "/v3/alipay/trade/customs/declare" : { "post" : { "tags" : [ "alipay.trade.customs" ], "summary" : "统一收单报关接口", "description" : "境外商户的商品进口到国内时需要向海关中心报送支付、物流等信息，由海关审核，如果交易是由支付宝支付的话，需要商户可以调用此报关接口来请求支付宝将其指定交易报送支付单给海关。", "operationId" : "alipay.trade.customs.declare", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeCustomsDeclareResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeCustomsDeclareErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeCustomsDeclareModel" } } }, "required" : false } } }, "/v3/alipay/trade/customs/query" : { "get" : { "tags" : [ "alipay.trade.customs" ], "summary" : "查询报关详细信息", "description" : "境外商户的商品进口到国内时需要向海关中心报送支付、物流等信息，由海关审核，如果交易是由支付宝支付的话，需要商户调用支付宝报关接口来请求支付宝将其指定交易报送支付单给海关。商户可以通过该接口主动查询报关状态，了解报关详情以及进度。", "operationId" : "alipay.trade.customs.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeCustomsQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeCustomsQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "out_request_nos", "in" : "query", "description" : "报关请求号。需要查询的商户端报关请求号，支持批量查询，\r\t多个值用英文半角逗号分隔，单次请求最多10个;", "schema" : { "type" : "string", "example" : "201506010001,201506010002,201506010003" } } ] } }, "/v3/alipay/trade/fastpay/refund/query" : { "post" : { "tags" : [ "alipay.trade.fastpay.refund" ], "summary" : "统一收单交易退款查询", "description" : "商户可使用该接口查询自已通过alipay.trade.refund提交的退款请求是否执行成功。", "operationId" : "alipay.trade.fastpay.refund.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeFastpayRefundQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeFastpayRefundQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeFastpayRefundQueryModel" } } }, "required" : false } } }, "/v3/alipay/trade/order/pay" : { "post" : { "tags" : [ "alipay.trade.order" ], "summary" : "统一收单交易订单支付接口", "description" : "商户用已创建的交易进行支付（需要使用该接口请联系接口owner）", "operationId" : "alipay.trade.order.pay", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeOrderPayResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeOrderPayErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeOrderPayModel" } } }, "required" : false } } }, "/v3/alipay/trade/order/settle" : { "post" : { "tags" : [ "alipay.trade.order" ], "summary" : "统一收单交易结算接口", "description" : "用于在卖家交易成功之后，基于交易订单，进行卖家与第三方（如供应商或平台商）的资金再分配。一般用于第三方从卖家抽佣场景。", "operationId" : "alipay.trade.order.settle", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeOrderSettleResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeOrderSettleErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeOrderSettleModel" } } }, "required" : false } } }, "/v3/alipay/trade/order/settle/query" : { "get" : { "tags" : [ "alipay.trade.order.settle" ], "summary" : "交易分账查询接口", "description" : "根据分账请求号查询交易分账结果", "operationId" : "alipay.trade.order.settle.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeOrderSettleQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeOrderSettleQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "settle_no", "in" : "query", "description" : "支付宝分账请求单号，传入该字段，无需再传外部请求号和支付宝交易号", "schema" : { "type" : "string", "example" : "20210706002530020036530021395831" } }, { "name" : "out_request_no", "in" : "query", "description" : "外部请求号，需要和支付宝交易号一起传入", "schema" : { "type" : "string", "example" : "20210727001" } }, { "name" : "trade_no", "in" : "query", "description" : "支付宝交易号，传入该字段，需要和外部请求号一起传入", "schema" : { "type" : "string", "example" : "2021112611001004680 073956707" } } ] } }, "/v3/alipay/trade/orderinfo/sync" : { "post" : { "tags" : [ "alipay.trade.orderinfo" ], "summary" : "支付宝订单信息同步接口", "description" : "该接口用于商户向支付宝同步该笔订单相关业务信息", "operationId" : "alipay.trade.orderinfo.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeOrderinfoSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeOrderinfoSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeOrderinfoSyncModel" } } }, "required" : false } } }, "/v3/alipay/trade/overseas/settle" : { "post" : { "tags" : [ "alipay.trade.overseas" ], "summary" : "统一境内收单跨境结算接口", "description" : "境内收单跨境结算", "operationId" : "alipay.trade.overseas.settle", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeOverseasSettleResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeOverseasSettleErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeOverseasSettleModel" } } }, "required" : false } } }, "/v3/alipay/trade/pay" : { "post" : { "tags" : [ "alipay.trade" ], "summary" : "统一收单交易支付接口", "description" : "收银员使用扫码设备读取用户手机支付宝“付款码”获取设备（如扫码枪）读取用户手机支付宝的付款码信息后，将二维码或条码信息通过本接口上送至支付宝发起支付。", "operationId" : "alipay.trade.pay", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradePayResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradePayErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradePayModel" } } }, "required" : false } } }, "/v3/alipay/trade/precreate" : { "post" : { "tags" : [ "alipay.trade" ], "summary" : "统一收单线下交易预创建", "description" : "收银员通过收银台或商户后台调用支付宝接口，生成二维码后，展示给用户，由用户扫描二维码完成订单支付。", "operationId" : "alipay.trade.precreate", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradePrecreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradePrecreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradePrecreateModel" } } }, "required" : false } } }, "/v3/alipay/trade/query" : { "post" : { "tags" : [ "alipay.trade" ], "summary" : "统一收单交易查询", "description" : "该接口提供所有支付宝支付订单的查询，商户可以通过该接口主动查询订单状态，完成下一步的业务逻辑。\r\n需要调用查询接口的情况：\r\n当商户后台、网络、服务器等出现异常，商户系统最终未接收到支付通知；\r\n调用支付接口后，返回系统错误或未知交易状态情况；\r\n调用alipay.trade.pay，返回INPROCESS的状态；\r\n调用alipay.trade.cancel之前，需确认支付状态；", "operationId" : "alipay.trade.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeQueryModel" } } }, "required" : false } } }, "/v3/alipay/trade/refund" : { "post" : { "tags" : [ "alipay.trade" ], "summary" : "统一收单交易退款接口", "description" : "当交易发生之后一段时间内，由于买家或者卖家的原因需要退款时，卖家可以通过退款接口将支付款退还给买家，支付宝将在收到退款请求并且验证成功之后，按照退款规则将支付款按原路退到买家帐号上。\n交易超过约定时间（签约时设置的可退款时间）的订单无法进行退款。 \n支付宝退款支持单笔交易分多次退款，多次退款需要提交原支付订单的订单号和设置不同的退款请求号。一笔退款失败后重新提交，要保证重试时退款请求号不能变更，防止该笔交易重复退款。 \n同一笔交易累计提交的退款金额不能超过原始交易总金额。", "operationId" : "alipay.trade.refund", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeRefundResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeRefundErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeRefundModel" } } }, "required" : false } } }, "/v3/alipay/trade/refund/apply" : { "post" : { "tags" : [ "alipay.trade.refund" ], "summary" : "异步退款受理接口", "description" : "商户通过此接口提交异步退款请求，支付宝受理后，将会异步进行退款处理。退款完成后异步通知商户退款结果，商户可以通过alipay.trade.fastpay.refund.query接口查询退款状态。", "operationId" : "alipay.trade.refund.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeRefundApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeRefundApplyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeRefundApplyModel" } } }, "required" : false } } }, "/v3/alipay/trade/royalty/rate/query" : { "get" : { "tags" : [ "alipay.trade.royalty.rate" ], "summary" : "分账比例查询", "description" : "商户签约分账产品后，商户或其授权ISV可对分账比例进行查询。", "operationId" : "alipay.trade.royalty.rate.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeRoyaltyRateQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeRoyaltyRateQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "out_request_no", "in" : "query", "description" : "外部请求号，由商家自定义。32个字符以内，仅可包含字母、数字、下划线。需保证在商户端不重复。", "schema" : { "type" : "string", "example" : "20220823165400001" } } ] } }, "/v3/alipay/trade/royalty/relation/batchquery" : { "post" : { "tags" : [ "alipay.trade.royalty.relation" ], "summary" : "分账关系查询", "description" : "当商户签约分账产品后，授权ISV帮其进行分账关系的维护。本接口用于商户与分账方的关系查询。", "operationId" : "alipay.trade.royalty.relation.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeRoyaltyRelationBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeRoyaltyRelationBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeRoyaltyRelationBatchqueryModel" } } }, "required" : false } } }, "/v3/alipay/trade/royalty/relation/bind" : { "post" : { "tags" : [ "alipay.trade.royalty.relation" ], "summary" : "分账关系绑定", "description" : "当商户签约分账产品后，授权ISV帮其进行分账关系的维护。本接口用于商户与分账方的关系绑定。", "operationId" : "alipay.trade.royalty.relation.bind", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeRoyaltyRelationBindResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeRoyaltyRelationBindErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeRoyaltyRelationBindModel" } } }, "required" : false } } }, "/v3/alipay/trade/royalty/relation/unbind" : { "post" : { "tags" : [ "alipay.trade.royalty.relation" ], "summary" : "分账关系解绑", "description" : "当商户签约分账产品后，授权ISV帮其进行分账关系的维护。本接口用于商户与分账方的关系解绑。", "operationId" : "alipay.trade.royalty.relation.unbind", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeRoyaltyRelationUnbindResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeRoyaltyRelationUnbindErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeRoyaltyRelationUnbindModel" } } }, "required" : false } } }, "/v3/alipay/trade/settle/confirm" : { "post" : { "tags" : [ "alipay.trade.settle" ], "summary" : "统一收单确认结算接口", "description" : "用户付款后，平台上的卖家发货，用户收到商品确认收货后，平台通过确认结算接口，将交易款结算给指定的卖家账户。\n单笔结算到卖家余额的场景支持分账冻结。在确认结算时，传入冻结标识 royalty_freeze=true，资金结算到卖家支付宝余额后，会先冻结在不可用余额中，后续分账将自动从冻结余额划出，平台商可调用分账完结释放冻结资金，系统默认在冻结30天后自动解冻。解冻后，仍可以发起分账。为保证分账成功率，请尽可能在分账冻结期内分账。", "operationId" : "alipay.trade.settle.confirm", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeSettleConfirmResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeSettleConfirmErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeSettleConfirmModel" } } }, "required" : false } } }, "/v3/alipay/trade/settle/receivables/query" : { "post" : { "tags" : [ "alipay.trade.settle.receivables" ], "summary" : "待结算查询", "description" : "对外提供待结算资金查询的能力。", "operationId" : "alipay.trade.settle.receivables.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeSettleReceivablesQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayTradeSettleReceivablesQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayTradeSettleReceivablesQueryModel" } } }, "required" : false } } }, "/v3/alipay/user/agreement/executionplan/modify" : { "post" : { "tags" : [ "alipay.user.agreement.executionplan" ], "summary" : "周期性扣款协议执行计划修改接口", "description" : "周期性扣款产品，商户延期扣款接口", "operationId" : "alipay.user.agreement.executionplan.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserAgreementExecutionplanModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayUserAgreementExecutionplanModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserAgreementExecutionplanModifyModel" } } }, "required" : false } } }, "/v3/alipay/user/agreement/migrate" : { "post" : { "tags" : [ "alipay.user.agreement" ], "summary" : "代扣协议迁移", "description" : "由商户调用，将商户与用户签署的代扣协议内容进行迁移，包括协议主体迁移等", "operationId" : "alipay.user.agreement.migrate", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserAgreementMigrateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayUserAgreementMigrateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserAgreementMigrateModel" } } }, "required" : false } } }, "/v3/alipay/user/agreement/permission/create" : { "post" : { "tags" : [ "alipay.user.agreement.permission" ], "summary" : "支付宝协议支付许可创建、服务变更接口", "description" : "支付宝协议支付许可创建接口、服务变更发送消息提醒接口", "operationId" : "alipay.user.agreement.permission.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserAgreementPermissionCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayUserAgreementPermissionCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserAgreementPermissionCreateModel" } } }, "required" : false } } }, "/v3/alipay/user/agreement/query" : { "get" : { "tags" : [ "alipay.user.agreement" ], "summary" : "支付宝个人代扣协议查询接口", "description" : "支付宝个人代扣协议查询接口", "operationId" : "alipay.user.agreement.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserAgreementQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayUserAgreementQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "personal_product_code", "in" : "query", "description" : "协议产品码，商户和支付宝签约时确定，商户可咨询技术支持。", "schema" : { "type" : "string", "example" : "GENERAL_WITHHOLDING_P" } }, { "name" : "alipay_user_id", "in" : "query", "description" : "用户的支付宝账号对应 的支付宝唯一用户号，以 2088 开头的 16 位纯数字 组成。\t本参数与alipay_logon_id若都填写，则以本参数为准，优先级高于 alipay_logon_id。", "schema" : { "type" : "string", "example" : "2088101122675263" } }, { "name" : "alipay_open_id", "in" : "query", "description" : "用户的支付宝账号对应 的支付宝唯一用户号，\t本参数与alipay_logon_id若都填写，则以本参数为准，优先级高于 alipay_logon_id。", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } }, { "name" : "alipay_logon_id", "in" : "query", "description" : "用户的支付宝登录账号，支持邮箱或手机号码格式。本参数与alipay_open_id 或 alipay_user_id 同时填写，优先按照 alipay_open_id 或 alipay_user_id 处理。 ", "schema" : { "type" : "string", "example" : "abx@alitest.com" } }, { "name" : "sign_scene", "in" : "query", "description" : "签约场景码，该值需要与系统/页面签约接口调用时传入的值保持一 致。如：周期扣款场景与调用 alipay.user.agreement.page.sign(支付宝个人协议页面签约接口) 签约时的 sign_scene 相同。 \t注意：当传入商户签约号 external_agreement_no 时，该值不能为空或默认值 DEFAULT|DEFAULT。\t", "schema" : { "type" : "string", "example" : "INDUSTRY|MEDICAL" } }, { "name" : "external_agreement_no", "in" : "query", "description" : "代扣协议中标示用户的唯一签约号(确保在商户系统中\t唯一)。\t格式规则:支持大写小写字母和数字，最长 32 位。", "schema" : { "type" : "string", "example" : "test" } }, { "name" : "third_party_type", "in" : "query", "description" : "签约第三方主体类型。对于三方协议，表示当前用户和哪一类的第三方主体进行签约。\r\t取值范围:\r\t取值范围：\r\t1. PARTNER（平台商户）;\r\t2. MERCHANT（集团商户），集团下子商户可共享用户签约内容;\r\t默认为PARTNER。", "schema" : { "type" : "string", "example" : "PARTNER" } }, { "name" : "agreement_no", "in" : "query", "description" : "支付宝系统中用以唯一标识用户签约记录的编号（用户签约成功后的协议号 ） ，如果传了该参数，其他参数会被忽略", "schema" : { "type" : "string", "example" : "20170322450983769228" } } ] } }, "/v3/alipay/user/agreement/transfer" : { "post" : { "tags" : [ "alipay.user.agreement" ], "summary" : "协议由普通通用代扣协议产品转移到周期扣协议产品", "description" : "由商户调用，将商户之前通用代扣产品转移到周期扣的协议产品", "operationId" : "alipay.user.agreement.transfer", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserAgreementTransferResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayUserAgreementTransferErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserAgreementTransferModel" } } }, "required" : false } } }, "/v3/alipay/user/agreement/unsign" : { "post" : { "tags" : [ "alipay.user.agreement" ], "summary" : "支付宝个人代扣协议解约接口", "description" : "支付宝个人代扣协议解约接口", "operationId" : "alipay.user.agreement.unsign", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserAgreementUnsignResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayUserAgreementUnsignErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserAgreementUnsignModel" } } }, "required" : false } } }, "/v3/alipay/user/agreement/userverify/apply" : { "post" : { "tags" : [ "alipay.user.agreement.userverify" ], "summary" : "协议用户一致性验证", "description" : "验证协议对应的用户信息", "operationId" : "alipay.user.agreement.userverify.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserAgreementUserverifyApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayUserAgreementUserverifyApplyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserAgreementUserverifyApplyModel" } } }, "required" : false } } }, "/v3/alipay/user/agreement/userverify/query" : { "get" : { "tags" : [ "alipay.user.agreement.userverify" ], "summary" : "用户协议鉴权查询结果", "description" : "商户使用用户验证申请接口时，获取token，然后通过次接口回去验证状态", "operationId" : "alipay.user.agreement.userverify.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserAgreementUserverifyQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayUserAgreementUserverifyQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "agreement_no", "in" : "query", "description" : "协议号", "schema" : { "type" : "string", "example" : "20170502000610755993" } }, { "name" : "apply_token", "in" : "query", "description" : "申请时获取的token", "schema" : { "type" : "string", "example" : "MDEDUCT0068292ca377d1d44b65fa24ec9cd89132f" } } ] } }, "/v3/alipay/user/alipaypoint/budgetlib/query" : { "get" : { "tags" : [ "alipay.user.alipaypoint.budgetlib" ], "summary" : "查询集分宝预算库详情", "description" : "用于查询集分宝预算库详情", "operationId" : "alipay.user.alipaypoint.budgetlib.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserAlipaypointBudgetlibQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayUserAlipaypointBudgetlibQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "budget_code", "in" : "query", "description" : "集分宝预算库编码", "schema" : { "type" : "string", "example" : "20201107050844" } } ] } }, "/v3/alipay/user/alipaypoint/send" : { "post" : { "tags" : [ "alipay.user.alipaypoint" ], "summary" : "集分宝发放接口", "description" : "用于发放商户采购的集分宝给到支付宝用户", "operationId" : "alipay.user.alipaypoint.send", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserAlipaypointSendResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayUserAlipaypointSendErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserAlipaypointSendModel" } } }, "required" : false } } }, "/v3/alipay/user/certdoc/certverify/consult" : { "get" : { "tags" : [ "alipay.user.certdoc.certverify" ], "summary" : "实名证件信息比对验证咨询", "description" : "商户在预咨询接口（接口1）预先录入某用户的实名证件信息（例如姓名、身份证号等），获得用户授权后调用本咨询接口（接口2），将对比该用户的支付宝实名信息与（接口1）传入的信息是否一致。", "operationId" : "alipay.user.certdoc.certverify.consult", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserCertdocCertverifyConsultResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayUserCertdocCertverifyConsultErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/AuthToken" }, { "name" : "verify_id", "in" : "query", "description" : "信息校验验证ID。通过alipay.user.certdoc.certverify.preconsult(实名证件信息比对验证预咨询)接口获取。", "schema" : { "type" : "string", "example" : "671ffcda5447bc87e9ed2f669eb143d4" } } ] } }, "/v3/alipay/user/certdoc/certverify/preconsult" : { "post" : { "tags" : [ "alipay.user.certdoc.certverify" ], "summary" : "实名证件信息比对验证预咨询", "description" : "商户在该接口（接口1）预先录入某用户的实名证件信息（例如姓名、身份证号等），获得用户授权后调用咨询接口（接口2），将对比该用户的支付宝实名信息与该（接口1）传入的信息是否一致。", "operationId" : "alipay.user.certdoc.certverify.preconsult", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserCertdocCertverifyPreconsultResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayUserCertdocCertverifyPreconsultErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserCertdocCertverifyPreconsultModel" } } }, "required" : false } } }, "/v3/alipay/user/certify/open/initialize" : { "post" : { "tags" : [ "alipay.user.certify.open" ], "summary" : "身份认证初始化服务", "description" : "支付宝开放认证初始化服务，用于创建开放认证流程。注意：港澳台同胞身份验证服务仅支持在支付宝客户端内使用，外部 APP 使用该项服务需唤起支付宝客户端。", "operationId" : "alipay.user.certify.open.initialize", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserCertifyOpenInitializeResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayUserCertifyOpenInitializeErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserCertifyOpenInitializeModel" } } }, "required" : false } } }, "/v3/alipay/user/certify/open/query" : { "get" : { "tags" : [ "alipay.user.certify.open" ], "summary" : "身份认证记录查询", "description" : "商户在开放认证完成后，调用本接口查询认证状态和相关数据", "operationId" : "alipay.user.certify.open.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserCertifyOpenQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayUserCertifyOpenQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "certify_id", "in" : "query", "description" : "本次申请操作的唯一标识，通过alipay.user.certify.open.initialize(身份认证初始化服务)接口同步响应获取。", "schema" : { "type" : "string", "example" : "OC201809253000000393900404029253" } } ] } }, "/v3/alipay/user/info/share" : { "post" : { "tags" : [ "alipay.user.info" ], "summary" : "支付宝会员授权信息查询接口", "description" : "配合支付宝会员授权接口，查询授权信息。", "operationId" : "alipay.user.info.share", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserInfoShareResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayUserInfoShareErrorResponseModel" } ] } } } } }, "parameters" : [ { "$ref" : "#/components/parameters/AuthToken" } ] } }, "/v3/alipay/user/twostage/common/use" : { "post" : { "tags" : [ "alipay.user.twostage.common" ], "summary" : "通用当面付二阶段接口", "description" : "商家通过小程序/卡券开放权益(优惠券)，用户在小程序/卡券授权后，打开付款码时通过该接口获取用户信息。", "operationId" : "alipay.user.twostage.common.use", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserTwostageCommonUseResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayUserTwostageCommonUseErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserTwostageCommonUseModel" } } }, "required" : false } } }, "/v3/alipay/user/twostage/indirect/use" : { "post" : { "tags" : [ "alipay.user.twostage.indirect" ], "summary" : "双联二阶段", "description" : "间连模式通过双联向银行输出付款码查UID接口.\n双联二阶段里，授权之后调用该接口，进行解码并校验双联pid、银行orgId、isv sourceId及学校smid之间的级联关系；检查授权关系；解码并返回用户uid", "operationId" : "alipay.user.twostage.indirect.use", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserTwostageIndirectUseResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayUserTwostageIndirectUseErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserTwostageIndirectUseModel" } } }, "required" : false } } }, "/v3/alipay/user/userinfo/share" : { "post" : { "tags" : [ "alipay.user.userinfo" ], "summary" : "支付宝钱包用户信息共享", "description" : "外部应用上架到支付宝钱包，当支付宝用户从钱包访问外部应用时，会跳转到外部应用并带上用户的授权码。\r\n外部应用用授权码调用授权令牌交换API（alipay.system.oauth.token）可得到授权令牌。\r\n用授权令牌调用此接口得到支付宝会员相关信息。\r\n特别说明：此接口的不需要授权是指不需外部应用主动引导用户授权，支付宝钱包会在引导用户授权后，\r\n带上授权码再跳转到外部应用。", "operationId" : "alipay.user.userinfo.share", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlipayUserUserinfoShareResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AlipayUserUserinfoShareErrorResponseModel" } ] } } } } } } }, "/v3/ant/merchant/expand/apprecommend/account/create" : { "post" : { "tags" : [ "ant.merchant.expand.apprecommend.account" ], "summary" : "关联账号和小程序", "description" : "将账号与小程序进行绑定，用于支付推荐场景", "operationId" : "ant.merchant.expand.apprecommend.account.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandApprecommendAccountCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandApprecommendAccountCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandApprecommendAccountCreateModel" } } }, "required" : false } } }, "/v3/ant/merchant/expand/apprecommend/account/delete" : { "delete" : { "tags" : [ "ant.merchant.expand.apprecommend.account" ], "summary" : "取消关联账号和小程序", "description" : "取消账号与小程序的绑定，用于支付推荐场景", "operationId" : "ant.merchant.expand.apprecommend.account.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandApprecommendAccountDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandApprecommendAccountDeleteErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "app_no", "in" : "query", "description" : "待解绑小程序的app_id", "schema" : { "type" : "string", "example" : "2021000155639069" } }, { "name" : "acc_no", "in" : "query", "description" : "待解绑账号PID", "schema" : { "type" : "string", "example" : "2088001969784501" } } ] } }, "/v3/ant/merchant/expand/apprecommend/account/query" : { "get" : { "tags" : [ "ant.merchant.expand.apprecommend.account" ], "summary" : "查询已关联指定APP的账号列表", "description" : "查询已关联指定APP的账号列表，用于支付推荐场景", "operationId" : "ant.merchant.expand.apprecommend.account.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandApprecommendAccountQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandApprecommendAccountQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "app_no", "in" : "query", "description" : "已关联小程序的app_id", "schema" : { "type" : "string", "example" : "2021000155639069" } }, { "name" : "page_size", "in" : "query", "description" : "单页行数，不能超过100行", "schema" : { "type" : "integer", "example" : "10" } }, { "name" : "page_number", "in" : "query", "description" : "页码", "schema" : { "type" : "integer", "example" : "1" } } ] } }, "/v3/ant/merchant/expand/apprecommend/available/query" : { "get" : { "tags" : [ "ant.merchant.expand.apprecommend.available" ], "summary" : "查询可关联APP的账号列表", "description" : "查询可关联APP的账号列表，用于支付推荐场景", "operationId" : "ant.merchant.expand.apprecommend.available.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandApprecommendAvailableQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandApprecommendAvailableQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "page_size", "in" : "query", "description" : "单页行数，不能超过100行", "schema" : { "type" : "integer", "example" : "10" } }, { "name" : "page_number", "in" : "query", "description" : "页码", "schema" : { "type" : "integer", "example" : "1" } } ] } }, "/v3/ant/merchant/expand/info/query" : { "get" : { "tags" : [ "ant.merchant.expand.info" ], "summary" : "蚂蚁商户信息查询接口", "description" : "提供商户号查询商户基础信息", "operationId" : "ant.merchant.expand.info.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandInfoQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandInfoQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "merchant_no", "in" : "query", "description" : "商户号，目前是商户pid", "schema" : { "type" : "string", "example" : "2088123456788765" } } ] } }, "/v3/ant/merchant/expand/item/create" : { "post" : { "tags" : [ "ant.merchant.expand.item" ], "summary" : "商品创建接口", "description" : "用于服务商或商户创建商品", "operationId" : "ant.merchant.expand.item.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandItemCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandItemCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandItemCreateModel" } } }, "required" : false } } }, "/v3/ant/merchant/expand/item/delete" : { "delete" : { "tags" : [ "ant.merchant.expand.item" ], "summary" : "商品删除接口", "description" : "用于服务商或商户删除商品", "operationId" : "ant.merchant.expand.item.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandItemDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandItemDeleteErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "item_id", "in" : "query", "description" : "商品ID（item_id不为空则以item_id作为删除KEY,item_id为空则以external_item_id作为删除KEY,两者不能同时为空）", "schema" : { "type" : "string", "example" : "2018091300502200002600104169" } }, { "name" : "external_item_id", "in" : "query", "description" : "外部商品ID（item_id不为空则以item_id作为删除KEY,item_id为空则以external_item_id作为删除KEY,两者不能同时为空）", "schema" : { "type" : "string", "example" : "20190916123124123123123" } } ] } }, "/v3/ant/merchant/expand/item/modify" : { "post" : { "tags" : [ "ant.merchant.expand.item" ], "summary" : "商品修改接口", "description" : "用于服务商或商户修改商品", "operationId" : "ant.merchant.expand.item.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandItemModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandItemModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandItemModifyModel" } } }, "required" : false } } }, "/v3/ant/merchant/expand/item/open/batchquery" : { "post" : { "tags" : [ "ant.merchant.expand.item.open" ], "summary" : "批量查询商品接口", "description" : "用于ISV或商户批量查询商品", "operationId" : "ant.merchant.expand.item.open.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandItemOpenBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandItemOpenBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandItemOpenBatchqueryModel" } } }, "required" : false } } }, "/v3/ant/merchant/expand/item/open/create" : { "post" : { "tags" : [ "ant.merchant.expand.item.open" ], "summary" : "创建商品接口", "description" : "用于ISV或商户创建商品", "operationId" : "ant.merchant.expand.item.open.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandItemOpenCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandItemOpenCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandItemOpenCreateModel" } } }, "required" : false } } }, "/v3/ant/merchant/expand/item/open/delete" : { "delete" : { "tags" : [ "ant.merchant.expand.item.open" ], "summary" : "删除商品接口", "description" : "用于ISV或商户删除商品", "operationId" : "ant.merchant.expand.item.open.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandItemOpenDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandItemOpenDeleteErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "item_id", "in" : "query", "description" : "商品ID，通过创建商品接口 https://opendocs.alipay.com/apis/api_4/ant.merchant.expand.item.open.create 获取。", "schema" : { "type" : "string", "example" : "2019073100812219000000100000" } } ] } }, "/v3/ant/merchant/expand/item/open/modify" : { "post" : { "tags" : [ "ant.merchant.expand.item.open" ], "summary" : "修改商品接口", "description" : "用于ISV或商户修改商品", "operationId" : "ant.merchant.expand.item.open.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandItemOpenModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandItemOpenModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandItemOpenModifyModel" } } }, "required" : false } } }, "/v3/ant/merchant/expand/item/open/query" : { "get" : { "tags" : [ "ant.merchant.expand.item.open" ], "summary" : "查询商品接口", "description" : "用于ISV或商户查询商品", "operationId" : "ant.merchant.expand.item.open.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandItemOpenQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandItemOpenQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "target_id", "in" : "query", "description" : "商品归属主体ID\t例：商品归属主体类型target_type为店铺，则商品归属主体ID为店铺ID（支付宝侧店铺ID）；归属主体类型target_type为小程序，则归属主体ID为小程序ID", "schema" : { "type" : "string", "example" : "2018090600502000000022501261" } }, { "name" : "scene", "in" : "query", "description" : "场景码（具体值请参见产品文档）。\t小程序订单中心场景固定为 APP_ORDER。", "schema" : { "type" : "string", "example" : "APP_ORDER" } }, { "name" : "target_type", "in" : "query", "description" : "商品归属主体类型。枚举如下：\t5：店铺。\t8：小程序。", "schema" : { "type" : "string", "example" : "8" } }, { "name" : "status", "in" : "query", "description" : "商品状态：EFFECT（有效）、INVALID（无效）", "schema" : { "type" : "string", "example" : "EFFECT" } } ] } }, "/v3/ant/merchant/expand/item/query" : { "get" : { "tags" : [ "ant.merchant.expand.item" ], "summary" : "商品查询接口", "description" : "用于服务商或商户查询其商品信息", "operationId" : "ant.merchant.expand.item.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandItemQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandItemQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "target_type", "in" : "query", "description" : "商品归属主体类型:\r\t5: 店铺\r\t4: 主站MID\r\t3: 参与者\r\t2: 角色\r\t1: 联系人", "schema" : { "type" : "string", "example" : "5" } }, { "name" : "target_id", "in" : "query", "description" : "商品归属主体id", "schema" : { "type" : "string", "example" : "2018090600502000000022501261" } }, { "name" : "undefined_category", "in" : "query", "description" : "未分类类目: true 的时候 front_category_id 必须不填（null）", "schema" : { "type" : "boolean", "example" : "false" } }, { "name" : "front_category_id", "in" : "query", "description" : "商品前台类目id: null 表示所有分类", "schema" : { "type" : "string", "example" : "2018091300502200002600105884" } }, { "name" : "status", "in" : "query", "description" : "商品状态：EFFECT、INVALID、PAUSE；不填返回所有状态商品", "schema" : { "type" : "string", "example" : "EFFECT" } } ] } }, "/v3/ant/merchant/expand/item/status/modify" : { "post" : { "tags" : [ "ant.merchant.expand.item.status" ], "summary" : "商品状态修改接口", "description" : "用于服务商或商户修改商品状态", "operationId" : "ant.merchant.expand.item.status.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandItemStatusModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandItemStatusModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandItemStatusModifyModel" } } }, "required" : false } } }, "/v3/ant/merchant/expand/shop/consult" : { "post" : { "tags" : [ "ant.merchant.expand.shop" ], "summary" : "蚂蚁店铺创建咨询", "description" : "蚂蚁店铺创建咨询", "operationId" : "ant.merchant.expand.shop.consult", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandShopConsultResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandShopConsultErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandShopConsultModel" } } }, "required" : false } } }, "/v3/ant/merchant/expand/shop/receiptaccount/save" : { "post" : { "tags" : [ "ant.merchant.expand.shop.receiptaccount" ], "summary" : "店铺增加收单账号", "description" : "店铺增加收单账号", "operationId" : "ant.merchant.expand.shop.receiptaccount.save", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandShopReceiptaccountSaveResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandShopReceiptaccountSaveErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandShopReceiptaccountSaveModel" } } }, "required" : false } } }, "/v3/ant/merchant/indirect/image" : { "post" : { "tags" : [ "ant.merchant.expand.indirect.image" ], "summary" : "图片上传", "description" : "图片上传", "operationId" : "ant.merchant.expand.indirect.image.upload", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandIndirectImageUploadResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandIndirectImageUploadErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AntMerchantExpandIndirectImageUploadModel" }, "image_content" : { "type" : "string", "format" : "binary" } } }, "encoding" : { "data" : { "contentType" : "application/json" }, "image_content" : { "contentType" : "*/*" } } } }, "required" : false } } }, "/v3/ant/merchant/mcc/query" : { "get" : { "tags" : [ "ant.merchant.expand.mcc" ], "summary" : "商户mcc信息查询", "description" : "用于查询商户的新版本mcc行业信息", "operationId" : "ant.merchant.expand.mcc.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandMccQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandMccQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "mcc_code_list", "in" : "query", "description" : "传入需要查询的code列表，以分号分隔；注：如果需要查询完整类目树，可以传入ROOT", "schema" : { "type" : "string", "example" : "B0001,B0002" } } ] } }, "/v3/ant/merchant/order/{order_id}" : { "get" : { "tags" : [ "ant.merchant.expand.order" ], "summary" : "商户申请单查询", "description" : "服务商根据申请单id，查询自己提交的商户进件、管理等申请单", "operationId" : "ant.merchant.expand.order.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandOrderQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandOrderQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "order_id", "in" : "path", "description" : "申请单 id。\t1.蚂蚁球房管理场景：通过 ant.merchant.expand.shop.create(蚂蚁店铺创建)接口进件时返回的order_id。\t2.直付通二级商户进件场景：通过ant.merchant.expand.indirect.zft.create(直付通二级商户创建)接口进件时返回的order_id。", "required" : true, "schema" : { "type" : "string", "example" : "2017112200502000000004754299" } } ] } }, "/v3/ant/merchant/shop" : { "get" : { "tags" : [ "ant.merchant.expand.shop" ], "summary" : "店铺查询接口", "description" : "用于服务商或商户查询其自己的店铺信息", "operationId" : "ant.merchant.expand.shop.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandShopQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandShopQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "shop_id", "in" : "query", "description" : "蚂蚁店铺id。填写本参数的话，store_id和ip_role_id可以不填", "schema" : { "type" : "string", "example" : "2018011900502000000005124744" } }, { "name" : "store_id", "in" : "query", "description" : "球房编号，表示该球房在该商户角色id(直连pid，间连smid)下，由商户自己定义的外部球房编号。关店接口中，如果没传shop_id，则本字段与ip_role_id均必填", "schema" : { "type" : "string", "example" : "NO0001" } }, { "name" : "ip_role_id", "in" : "query", "description" : "商户角色id，表示将要开的店属于哪个商户角色。对于直连开店场景，填写商户pid；对于间连开店场景（线上、线下、直付通），填写商户smid。本接口中，如果没传shop_id，则本字段与store_id均必填", "schema" : { "type" : "string", "example" : "2088301155943087" } }, { "name" : "address_version", "in" : "query", "description" : "行政区划版本，当前可传空值(取默认版本)、2022Q2、UPTODATE(取最新版本)，其中空值默认为：2020Q1版本（ address_version=''或null），想要查看版本是2022年2季度版本则传入:(address_version='2022Q2')，想要获取最新版本则传入:(address_version ='UPTODATE')", "schema" : { "type" : "string", "example" : "2022Q2" } }, { "name" : "need_recommend", "in" : "query", "description" : "球房不置信时，是否需要返回shop_recommend_info", "schema" : { "type" : "string", "example" : "1-需要，0-不需要" } } ] }, "post" : { "tags" : [ "ant.merchant.expand.shop" ], "summary" : "蚂蚁店铺创建", "description" : "创建蚂蚁店铺", "operationId" : "ant.merchant.expand.shop.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandShopCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandShopCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandShopCreateModel" } } }, "required" : false } }, "patch" : { "tags" : [ "ant.merchant.expand.shop" ], "summary" : "修改蚂蚁店铺", "description" : "修改蚂蚁店铺，按信息项修改。若无特殊说明，如果某项存在但是没填写，则不会覆盖掉原来的值", "operationId" : "ant.merchant.expand.shop.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandShopModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandShopModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandShopModifyModel" } } }, "required" : false } } }, "/v3/ant/merchant/shop/close" : { "patch" : { "tags" : [ "ant.merchant.expand.shop" ], "summary" : "蚂蚁店铺关闭", "description" : "通过shop_id，关闭蚂蚁店铺。", "operationId" : "ant.merchant.expand.shop.close", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandShopCloseResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandShopCloseErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandShopCloseModel" } } }, "required" : false } } }, "/v3/ant/merchant/shop/pagequery" : { "get" : { "tags" : [ "ant.merchant.expand.shop.page" ], "summary" : "店铺分页查询接口", "description" : "用于服务商或商户查询其自己的店铺信息", "operationId" : "ant.merchant.expand.shop.page.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AntMerchantExpandShopPageQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AntMerchantExpandShopPageQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "ip_role_id", "in" : "query", "description" : "商户角色id，表示将要开的店属于哪个商户角色。对于直连开店场景，填写商户pid；对于间连开店场景（线上、线下、直付通），填写商户smid。特别说明：IoT设备三绑定场景统一填写商户pid", "schema" : { "type" : "string", "example" : "2088301155943087" } }, { "name" : "page_num", "in" : "query", "description" : "查询页数", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "每页查询大小，限制100以内", "schema" : { "type" : "integer", "example" : "10" } }, { "name" : "address_version", "in" : "query", "description" : "行政区划版本，当前可传空值(取默认版本)、2022Q2、UPTODATE(取最新版本)，其中空值默认为：2020Q1版本(address_version=''或null)，想要查看版本是2022年2季度版本则传入:(address_version='2022Q2')，想要获取最新版本则传入:(address_version ='UPTODATE')", "schema" : { "type" : "string", "example" : "2022Q2" } } ] } }, "/v3/anttech/oceanbase/testplatform/task/query" : { "post" : { "tags" : [ "anttech.oceanbase.testplatform.task" ], "summary" : "获取ob开源官网提测平台待执行任务接口", "description" : "获取ob开源官网提测平台待执行任务接口，用于测试任务", "operationId" : "anttech.oceanbase.testplatform.task.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AnttechOceanbaseTestplatformTaskQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/AnttechOceanbaseTestplatformTaskQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AnttechOceanbaseTestplatformTaskQueryModel" } } }, "required" : false } } }, "/v3/datadigital/fincloud/generalsaas/face/certify/initialize" : { "post" : { "tags" : [ "datadigital.fincloud.generalsaas.face.certify" ], "summary" : "H5人脸核身初始化", "description" : "人脸核身初始化服务，用于创建认证流程。供外部客户使用该项服务。", "operationId" : "datadigital.fincloud.generalsaas.face.certify.initialize", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasFaceCertifyInitializeResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasFaceCertifyInitializeErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasFaceCertifyInitializeModel" } } }, "required" : false } } }, "/v3/datadigital/fincloud/generalsaas/face/certify/query" : { "get" : { "tags" : [ "datadigital.fincloud.generalsaas.face.certify" ], "summary" : "H5人脸核身查询记录", "description" : "商户在用户使用支付宝完成刷脸之后，调用本接口查询核身结果状态及相关数据", "operationId" : "datadigital.fincloud.generalsaas.face.certify.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasFaceCertifyQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasFaceCertifyQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "certify_id", "in" : "query", "description" : "本次申请操作的唯一标识，通过datadigital.fincloud.generalsaas.face.certify.initialize\t接口同步响应获取。", "schema" : { "type" : "string", "example" : "03cdsfsss20048373" } } ] } }, "/v3/datadigital/fincloud/generalsaas/face/certify/verify" : { "post" : { "tags" : [ "datadigital.fincloud.generalsaas.face.certify" ], "summary" : "H5人脸核身开始认证", "description" : "H5人脸核身服务开始认证。请根据返回结果渲染页面。", "operationId" : "datadigital.fincloud.generalsaas.face.certify.verify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasFaceCertifyVerifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasFaceCertifyVerifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasFaceCertifyVerifyModel" } } }, "required" : false } } }, "/v3/datadigital/fincloud/generalsaas/face/check/initialize" : { "post" : { "tags" : [ "datadigital.fincloud.generalsaas.face.check" ], "summary" : "人脸检测初始化", "description" : "人脸检测业务单据初始化", "operationId" : "datadigital.fincloud.generalsaas.face.check.initialize", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasFaceCheckInitializeResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasFaceCheckInitializeErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasFaceCheckInitializeModel" } } }, "required" : false } } }, "/v3/datadigital/fincloud/generalsaas/face/check/query" : { "get" : { "tags" : [ "datadigital.fincloud.generalsaas.face.check" ], "summary" : "人脸检测结果数据查询", "description" : "用于查询人脸检测结果的数据。", "operationId" : "datadigital.fincloud.generalsaas.face.check.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasFaceCheckQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasFaceCheckQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "certify_id", "in" : "query", "description" : "传入初始化接口datadigital.fincloud.generalsaas.face.check.initialize 得到的certify_id", "schema" : { "type" : "string", "example" : "dddddfsss88833ssf" } }, { "name" : "need_alive_photo", "in" : "query", "description" : "是否需要返回活体结果图片，needAlivePhoto：Y_O （原始图片）、Y_M（虚化，背景马赛克）、N（不返图）。非必填，默认为N", "schema" : { "type" : "string", "example" : "Y_M" } }, { "name" : "need_score", "in" : "query", "description" : "该入参已经废弃。", "schema" : { "type" : "string", "example" : "Y" } }, { "name" : "need_quality_score", "in" : "query", "description" : "是否需要返回图片质量分，非必填，默认值为N。 N表示不需要，Y表示需要", "schema" : { "type" : "string", "example" : "N" } }, { "name" : "need_attack_result", "in" : "query", "description" : "该参数已废弃", "schema" : { "type" : "string", "example" : "N" } } ] } }, "/v3/datadigital/fincloud/generalsaas/face/source/certify" : { "post" : { "tags" : [ "datadigital.fincloud.generalsaas.face.source" ], "summary" : "权威核验源的核验接口", "description" : "上传人脸照片，调用权威核验源进行验证", "operationId" : "datadigital.fincloud.generalsaas.face.source.certify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasFaceSourceCertifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasFaceSourceCertifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasFaceSourceCertifyModel" }, "file_content" : { "type" : "string", "format" : "binary" } } }, "encoding" : { "file_content" : { "contentType" : "*/*" }, "data" : { "contentType" : "application/json" } } } }, "required" : false } } }, "/v3/datadigital/fincloud/generalsaas/face/verification/initialize" : { "post" : { "tags" : [ "datadigital.fincloud.generalsaas.face.verification" ], "summary" : "人脸核身初始化", "description" : "人脸核身初始化接口", "operationId" : "datadigital.fincloud.generalsaas.face.verification.initialize", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasFaceVerificationInitializeResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasFaceVerificationInitializeErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasFaceVerificationInitializeModel" } } }, "required" : false } } }, "/v3/datadigital/fincloud/generalsaas/face/verification/query" : { "get" : { "tags" : [ "datadigital.fincloud.generalsaas.face.verification" ], "summary" : "人脸核身结果查询", "description" : "查询核身结果", "operationId" : "datadigital.fincloud.generalsaas.face.verification.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasFaceVerificationQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasFaceVerificationQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "certify_id", "in" : "query", "description" : "填入人脸核身初始化阶段获取到的certify_id", "schema" : { "type" : "string", "example" : "adsfasdfasdf" } }, { "name" : "need_alive_photo", "in" : "query", "description" : "是否需要返回活体结果图片，needAlivePhoto：Y_O （原始图片）、Y_M（虚化，背景马赛克）、N（不返图），默认为N", "schema" : { "type" : "string", "example" : "N" } } ] } }, "/v3/datadigital/fincloud/generalsaas/ocr/mobile/initialize" : { "post" : { "tags" : [ "datadigital.fincloud.generalsaas.ocr.mobile" ], "summary" : "OCR端云一体化识别初始化", "description" : "OCR端云一体化识别", "operationId" : "datadigital.fincloud.generalsaas.ocr.mobile.initialize", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasOcrMobileInitializeResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasOcrMobileInitializeErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasOcrMobileInitializeModel" } } }, "required" : false } } }, "/v3/datadigital/fincloud/generalsaas/ocr/server/detect" : { "post" : { "tags" : [ "datadigital.fincloud.generalsaas.ocr.server" ], "summary" : "服务端OCR", "description" : "纯服务端OCR对接", "operationId" : "datadigital.fincloud.generalsaas.ocr.server.detect", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasOcrServerDetectResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasOcrServerDetectErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DatadigitalFincloudGeneralsaasOcrServerDetectModel" }, "file_content" : { "type" : "string", "format" : "binary" } } }, "encoding" : { "file_content" : { "contentType" : "*/*" }, "data" : { "contentType" : "application/json" } } } }, "required" : false } } }, "/v3/koubei/marketing/campaign/intelligent/promo/batchquery" : { "post" : { "tags" : [ "koubei.marketing.campaign.intelligent.promo" ], "summary" : "智能营销活动批量查询", "description" : "智能营销活动批量查询", "operationId" : "koubei.marketing.campaign.intelligent.promo.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KoubeiMarketingCampaignIntelligentPromoBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/KoubeiMarketingCampaignIntelligentPromoBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KoubeiMarketingCampaignIntelligentPromoBatchqueryModel" } } }, "required" : false } } }, "/v3/koubei/marketing/campaign/intelligent/shop/consult" : { "post" : { "tags" : [ "koubei.marketing.campaign.intelligent.shop" ], "summary" : "智能营销球房咨询", "description" : "咨询完智能营销活动模型后，可以查询商户的符合智能营销活动标准的球房", "operationId" : "koubei.marketing.campaign.intelligent.shop.consult", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KoubeiMarketingCampaignIntelligentShopConsultResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/KoubeiMarketingCampaignIntelligentShopConsultErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KoubeiMarketingCampaignIntelligentShopConsultModel" } } }, "required" : false } } }, "/v3/koubei/marketing/campaign/intelligent/template/consult" : { "post" : { "tags" : [ "koubei.marketing.campaign.intelligent.template" ], "summary" : "智能营销模板咨询", "description" : "咨询可使用的智能营销模板", "operationId" : "koubei.marketing.campaign.intelligent.template.consult", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KoubeiMarketingCampaignIntelligentTemplateConsultResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/KoubeiMarketingCampaignIntelligentTemplateConsultErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KoubeiMarketingCampaignIntelligentTemplateConsultModel" } } }, "required" : false } } }, "/v3/koubei/marketing/campaign/item/merchantactivity/batchquery" : { "post" : { "tags" : [ "koubei.marketing.campaign.item.merchantactivity" ], "summary" : "商户查询商品代金券列表", "description" : "商户查询商品代金券列表", "operationId" : "koubei.marketing.campaign.item.merchantactivity.batchquery", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityBatchqueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityBatchqueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityBatchqueryModel" } } }, "required" : false } } }, "/v3/koubei/marketing/campaign/item/merchantactivity/close" : { "post" : { "tags" : [ "koubei.marketing.campaign.item.merchantactivity" ], "summary" : "商户下架代金券", "description" : "商户下架代金券", "operationId" : "koubei.marketing.campaign.item.merchantactivity.close", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityCloseResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityCloseErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityCloseModel" } } }, "required" : false } } }, "/v3/koubei/marketing/campaign/item/merchantactivity/create" : { "post" : { "tags" : [ "koubei.marketing.campaign.item.merchantactivity" ], "summary" : "商户创建商品代金券", "description" : "商户创建商品代金券", "operationId" : "koubei.marketing.campaign.item.merchantactivity.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityCreateModel" } } }, "required" : false } } }, "/v3/koubei/marketing/campaign/item/merchantactivity/modify" : { "post" : { "tags" : [ "koubei.marketing.campaign.item.merchantactivity" ], "summary" : "商户修改商品代金券", "description" : "商户修改商品代金券", "operationId" : "koubei.marketing.campaign.item.merchantactivity.modify", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityModifyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityModifyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityModifyModel" } } }, "required" : false } } }, "/v3/koubei/marketing/campaign/item/merchantactivity/query" : { "get" : { "tags" : [ "koubei.marketing.campaign.item.merchantactivity" ], "summary" : "商户查询商品代金券详情", "description" : "商户查询商品代金券详情", "operationId" : "koubei.marketing.campaign.item.merchantactivity.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "activity_id", "in" : "query", "description" : "运营活动id", "schema" : { "type" : "string", "example" : "2018xxxx" } }, { "name" : "external_unique_id", "in" : "query", "description" : "外部id", "schema" : { "type" : "string", "example" : "2018xxxx" } } ] } }, "/v3/koubei/member/data/isv/create" : { "post" : { "tags" : [ "koubei.member.data.isv" ], "summary" : "isv 会员CRM数据回流", "description" : "isv 会员CRM数据回流：isv对接商户，回流会员信息", "operationId" : "koubei.member.data.isv.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KoubeiMemberDataIsvCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/KoubeiMemberDataIsvCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KoubeiMemberDataIsvCreateModel" } } }, "required" : false } } }, "/v3/koubei/trade/order/consult" : { "post" : { "tags" : [ "koubei.trade.order" ], "summary" : "口碑订单预咨询", "description" : "ISV下单前，可以通过此接口咨询用户优惠信息", "operationId" : "koubei.trade.order.consult", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KoubeiTradeOrderConsultResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/KoubeiTradeOrderConsultErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KoubeiTradeOrderConsultModel" } } }, "required" : false } } }, "/v3/monitor/heartbeat/syn" : { "post" : { "tags" : [ "monitor.heartbeat" ], "summary" : "验签接口", "description" : "本质上是金融云验签接口", "operationId" : "monitor.heartbeat.syn", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MonitorHeartbeatSynResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/MonitorHeartbeatSynErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MonitorHeartbeatSynModel" } } }, "required" : false } } }, "/v3/zhima/credit/payafteruse/creditagreement/query" : { "get" : { "tags" : [ "zhima.credit.payafteruse.creditagreement" ], "summary" : "查询服务开通/授权信息", "description" : "使用商户外部协议号或开通/授权协议号，查询服务开通/授权信息。", "operationId" : "zhima.credit.payafteruse.creditagreement.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCreditPayafteruseCreditagreementQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaCreditPayafteruseCreditagreementQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "out_agreement_no", "in" : "query", "description" : "商户外部协议号", "schema" : { "type" : "string", "example" : "2014070700166653" } }, { "name" : "credit_agreement_id", "in" : "query", "description" : "芝麻开通/授权协议号，out_agreement_no与credit_agreement_id必填一个，推荐使用credit_agreement_id。", "schema" : { "type" : "string", "example" : "ZMOP2020050722001440" } } ] } }, "/v3/zhima/credit/payafteruse/creditagreement/transfer" : { "post" : { "tags" : [ "zhima.credit.payafteruse.creditagreement" ], "summary" : "转换为芝麻先享", "description" : "其他产品功能（例如信用代扣），通过该接口，可以转换为芝麻先享", "operationId" : "zhima.credit.payafteruse.creditagreement.transfer", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCreditPayafteruseCreditagreementTransferResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaCreditPayafteruseCreditagreementTransferErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCreditPayafteruseCreditagreementTransferModel" } } }, "required" : false } } }, "/v3/zhima/credit/payafteruse/creditbizorder/finish" : { "post" : { "tags" : [ "zhima.credit.payafteruse.creditbizorder" ], "summary" : "结束信用服务订单", "description" : "结束信用服务订单", "operationId" : "zhima.credit.payafteruse.creditbizorder.finish", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCreditPayafteruseCreditbizorderFinishResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaCreditPayafteruseCreditbizorderFinishErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCreditPayafteruseCreditbizorderFinishModel" } } }, "required" : false } } }, "/v3/zhima/credit/payafteruse/creditbizorder/order" : { "post" : { "tags" : [ "zhima.credit.payafteruse.creditbizorder" ], "summary" : "芝麻先享信用服务下单（免用户确认场景）", "description" : "芝麻先享免密下单，不需要唤起支付宝APP，通过服务端调用完成下单", "operationId" : "zhima.credit.payafteruse.creditbizorder.order", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCreditPayafteruseCreditbizorderOrderResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaCreditPayafteruseCreditbizorderOrderErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCreditPayafteruseCreditbizorderOrderModel" } } }, "required" : false } } }, "/v3/zhima/credit/payafteruse/creditbizorder/query" : { "get" : { "tags" : [ "zhima.credit.payafteruse.creditbizorder" ], "summary" : "信用服务订单查询", "description" : "信用服务订单查询", "operationId" : "zhima.credit.payafteruse.creditbizorder.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCreditPayafteruseCreditbizorderQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaCreditPayafteruseCreditbizorderQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "credit_biz_order_id", "in" : "query", "description" : "信用服务订单号，out_order_no与credit_biz_order_id至少传一个", "schema" : { "type" : "string", "example" : "ZMCB20201021200102012" } }, { "name" : "out_order_no", "in" : "query", "description" : "商户外部单号，out_order_no与credit_biz_order_id至少传一个", "schema" : { "type" : "string", "example" : "20202010212001384" } } ] } }, "/v3/zhima/credit/pe/zmgo/agreement/query" : { "get" : { "tags" : [ "zhima.credit.pe.zmgo.agreement" ], "summary" : "芝麻Go协议查询接口", "description" : "用户已经开通芝麻GO后，通过此接口查询协议。", "operationId" : "zhima.credit.pe.zmgo.agreement.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCreditPeZmgoAgreementQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaCreditPeZmgoAgreementQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "agreement_id", "in" : "query", "description" : "支付宝系统中用以唯一标识用户签约记录的编号，即花芝轻会员。传入该参数，会忽略其它所有参数。", "schema" : { "type" : "string", "example" : "20185513447859192007" } }, { "name" : "alipay_user_id", "in" : "query", "description" : "买家在支付宝的用户id", "schema" : { "type" : "string", "example" : "2088101117955611" } }, { "name" : "open_id", "in" : "query", "description" : "买家在支付宝的用户id", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } } ] } }, "/v3/zhima/credit/pe/zmgo/agreement/unsign" : { "post" : { "tags" : [ "zhima.credit.pe.zmgo.agreement" ], "summary" : "芝麻GO协议解约", "description" : "芝麻GO协议解约", "operationId" : "zhima.credit.pe.zmgo.agreement.unsign", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCreditPeZmgoAgreementUnsignResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaCreditPeZmgoAgreementUnsignErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCreditPeZmgoAgreementUnsignModel" } } }, "required" : false } } }, "/v3/zhima/credit/pe/zmgo/bizopt/close" : { "post" : { "tags" : [ "zhima.credit.pe.zmgo.bizopt" ], "summary" : "芝麻GO签约关单", "description" : "签约芝麻GO时，在签约申请时会生初始状态的签约单，如果后续不进行签约确认，可通过此接口关闭签约单", "operationId" : "zhima.credit.pe.zmgo.bizopt.close", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCreditPeZmgoBizoptCloseResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaCreditPeZmgoBizoptCloseErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCreditPeZmgoBizoptCloseModel" } } }, "required" : false } } }, "/v3/zhima/credit/pe/zmgo/cumulation/sync" : { "post" : { "tags" : [ "zhima.credit.pe.zmgo.cumulation" ], "summary" : "芝麻go用户数据回传", "description" : "芝麻go商户通过此api接口，将用户行为数据回传到芝麻侧，数据包括：交易型数据（订单信息、优惠信息）和非交易型数据（用户完成任务次数）。芝麻侧将回传的数据在C端向用户展示，并且在结算时对结算金额进行校验（可选）。", "operationId" : "zhima.credit.pe.zmgo.cumulation.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCreditPeZmgoCumulationSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaCreditPeZmgoCumulationSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCreditPeZmgoCumulationSyncModel" } } }, "required" : false } } }, "/v3/zhima/credit/pe/zmgo/preorder/create" : { "put" : { "tags" : [ "zhima.credit.pe.zmgo.preorder" ], "summary" : "芝麻GO签约预创单", "description" : "芝麻GO签约三件套前预创建单据，预传入签约基本参数和自定义配置，并支持动态模板配置能力。", "operationId" : "zhima.credit.pe.zmgo.preorder.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCreditPeZmgoPreorderCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaCreditPeZmgoPreorderCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCreditPeZmgoPreorderCreateModel" } } }, "required" : false } } }, "/v3/zhima/credit/pe/zmgo/settle/apply" : { "post" : { "tags" : [ "zhima.credit.pe.zmgo.settle" ], "summary" : "芝麻GO结算申请", "description" : "用户已经开通芝麻GO后，商户通过此接口解冻转支付用户冻结金额。传入金额必须小于等于冻结金额", "operationId" : "zhima.credit.pe.zmgo.settle.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCreditPeZmgoSettleApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaCreditPeZmgoSettleApplyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCreditPeZmgoSettleApplyModel" } } }, "required" : false } } }, "/v3/zhima/credit/pe/zmgo/settle/refund" : { "post" : { "tags" : [ "zhima.credit.pe.zmgo.settle" ], "summary" : "芝麻GO结算退款接口", "description" : "芝麻GO结算金额逆向退款接口: 对zhima.credit.pe.zmgo.settle.apply(芝麻GO结算申请接口) 产生的结算交易发起退款操作", "operationId" : "zhima.credit.pe.zmgo.settle.refund", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCreditPeZmgoSettleRefundResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaCreditPeZmgoSettleRefundErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCreditPeZmgoSettleRefundModel" } } }, "required" : false } } }, "/v3/zhima/credit/pe/zmgo/settle/unfreeze" : { "put" : { "tags" : [ "zhima.credit.pe.zmgo.settle" ], "summary" : "芝麻GO解冻接口", "description" : "用户已经开通芝麻GO后，商户通过此接口解冻转支付用户冻结金额。传入金额必须小于等于冻结金额", "operationId" : "zhima.credit.pe.zmgo.settle.unfreeze", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCreditPeZmgoSettleUnfreezeResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaCreditPeZmgoSettleUnfreezeErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCreditPeZmgoSettleUnfreezeModel" } } }, "required" : false } } }, "/v3/zhima/customer/jobworth/authentication" : { "get" : { "tags" : [ "zhima.customer.jobworth.authentication" ], "summary" : "职得身份认证查询接口", "description" : "根据一次性token查询用户身份认证结果", "operationId" : "zhima.customer.jobworth.authentication.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCustomerJobworthAuthenticationQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaCustomerJobworthAuthenticationQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "conn_key", "in" : "query", "description" : "调用第一步创建接口的out_agreement_no，由外部传入", "schema" : { "type" : "string", "example" : "uuid" } }, { "name" : "once_token", "in" : "query", "description" : "查询身份认证结果的凭证，在认证结果到达终态后只允许查询成功一次，若需要再次查询，则需要调用第一个接口再拉起受理台", "schema" : { "type" : "string", "example" : "uuid" } }, { "name" : "query_type", "in" : "query", "description" : "exact:精确查询,dim:模糊查询", "schema" : { "type" : "string", "example" : "exact\\dim" } }, { "name" : "identity_type", "in" : "query", "description" : "01:医生，02:教师，具体参考文档", "schema" : { "type" : "string", "example" : "01，02，03" } }, { "name" : "service_id", "in" : "query", "description" : "信用服务id，商家接入产品功能包时有运营同学分配", "schema" : { "type" : "string", "example" : "2019120400000000000004450100" } }, { "name" : "user_id", "in" : "query", "description" : "蚂蚁统一会员ID\t和身份证任选一个传入", "schema" : { "type" : "string", "example" : "20881029102921" } }, { "name" : "open_id", "in" : "query", "description" : "蚂蚁统一会员ID\t和身份证任选一个传入", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } }, { "name" : "cert_no", "in" : "query", "description" : "证件号", "schema" : { "type" : "string", "example" : "420192931233123123" } }, { "name" : "cert_type", "in" : "query", "description" : "\"身份证 : 0\"，\"护照: 1\"，\"台湾往来通行证：4\",\"港澳往来通行证：3\", \"回乡证: 2\"；\"港澳证件：5\"", "schema" : { "type" : "string", "example" : "0" } } ] } }, "/v3/zhima/customer/jobworth/cloudresume/query" : { "get" : { "tags" : [ "zhima.customer.jobworth.cloudresume" ], "summary" : "智能简历基本数据查询", "description" : "用于查询工作证基本信息", "operationId" : "zhima.customer.jobworth.cloudresume.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCustomerJobworthCloudresumeQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaCustomerJobworthCloudresumeQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "conn_key", "in" : "query", "description" : "长效的认证令牌", "schema" : { "type" : "string", "example" : "uuid" } }, { "name" : "once_token", "in" : "query", "description" : "交换云简历的单次token", "schema" : { "type" : "string", "example" : "uuid" } } ] } }, "/v3/zhima/customer/jobworth/info/query" : { "get" : { "tags" : [ "zhima.customer.jobworth.info" ], "summary" : "职得工作证信息查询", "description" : "查询用户职得工作证信息\n查询方式3选1，都设置时uid优先\n1、支付宝uid查询：user_id\n2、身份证+姓名查询：cert_type+cert_no\n3、智能简历场景：conn_key", "operationId" : "zhima.customer.jobworth.info.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCustomerJobworthInfoQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaCustomerJobworthInfoQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "user_name", "in" : "query", "description" : "姓名", "schema" : { "type" : "string", "example" : "张三" } }, { "name" : "conn_key", "in" : "query", "description" : "外部订单号，zhima.credit.payafteruse.creditagreement.sign的入参 out_agreement_no智能简历场景支持只传该值", "schema" : { "type" : "string", "example" : "ttest11234" } }, { "name" : "cert_no", "in" : "query", "description" : "证件号 ，根据cert_type类型设置对应证件号码，选择身份证校验时必传", "schema" : { "type" : "string", "example" : "42011719880304XXXX" } }, { "name" : "user_id", "in" : "query", "description" : "蚂蚁统一会员ID ，为2088开头的唯一标识\t选择支付宝uid检验时必传，支付宝uid或身份证+身份证类型 查询2选1，都设置时uid优先", "schema" : { "type" : "string", "example" : "2088XXXXXXXX" } }, { "name" : "open_id", "in" : "query", "description" : "蚂蚁统一会员ID ，为2088开头的唯一标识\t选择支付宝uid检验时必传，支付宝uid或身份证+身份证类型 查询2选1，都设置时uid优先", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } }, { "name" : "back_url", "in" : "query", "description" : "若用户没有开通工作证或者芝麻，成功开通后回跳的链接 ，支持http或schema地址", "schema" : { "type" : "string", "example" : "www.123.com" } }, { "name" : "cert_type", "in" : "query", "description" : "证件类型 ，枚举值：\t0:身份证1:护照2:台湾同胞回乡证3:港澳居民往来内地通行证4:台湾居民通行证5:港澳居民通行证\t选择身份证校验时必传，支付宝uid或身份证+身份证类型 查询2选1，都设置时uid优先", "schema" : { "type" : "string", "example" : "0:身份证1:护照2:台湾同胞回乡证3:港澳居民往来内地通行证4:台湾居民通行证5:港澳居民通行证" } }, { "name" : "ka_visitor_id", "in" : "query", "description" : "商户内部的唯一id如果是需要返回h5页面必填", "schema" : { "type" : "string", "example" : "xxx" } }, { "name" : "visitor_type", "in" : "query", "description" : "访问类型\tC = company or P = person\t如果是需要返回h5页面必填", "schema" : { "type" : "string", "example" : "P" } }, { "name" : "visitor_name", "in" : "query", "description" : "商户侧配置访客名称\t如果是需要返回h5页面必填", "schema" : { "type" : "string", "example" : "访客名称" } }, { "name" : "company_certificate", "in" : "query", "description" : "公司社会统一代码h5页面访客展示使用", "schema" : { "type" : "string", "example" : "xxxx" } }, { "name" : "visitor_url", "in" : "query", "description" : "上传图片接口返回的id", "schema" : { "type" : "string", "example" : "xxxx" } }, { "name" : "has_button", "in" : "query", "description" : "在h5页面是否展示底部跳转按钮", "schema" : { "type" : "boolean", "example" : "true" } }, { "name" : "has_number", "in" : "query", "description" : "true or false\t是否展示", "schema" : { "type" : "boolean", "example" : "true" } }, { "name" : "has_qr_code", "in" : "query", "description" : "是否展示二维码", "schema" : { "type" : "boolean", "example" : "true" } }, { "name" : "has_html", "in" : "query", "description" : "是否需要返回h5页面", "schema" : { "type" : "boolean", "example" : "true" } }, { "name" : "job_id", "in" : "query", "description" : "对外使用的jobid", "schema" : { "type" : "string", "example" : "05A00" } }, { "name" : "industry_id", "in" : "query", "description" : "行业描述ID", "schema" : { "type" : "string", "example" : "05A21" } }, { "name" : "cloud_resume_scene", "in" : "query", "description" : "子场景", "schema" : { "type" : "string", "example" : "GREEN_HIRE" } } ] } }, "/v3/zhima/customer/jobworth/jobdata/add" : { "post" : { "tags" : [ "zhima.customer.jobworth.jobdata" ], "summary" : "工作证职业数据回流接口", "description" : "合作的三方伙伴通过该接口，将数据回传到工作证", "operationId" : "zhima.customer.jobworth.jobdata.add", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCustomerJobworthJobdataAddResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaCustomerJobworthJobdataAddErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCustomerJobworthJobdataAddModel" } } }, "required" : false } } }, "/v3/zhima/customer/jobworth/picture/upload" : { "post" : { "tags" : [ "zhima.customer.jobworth.picture" ], "summary" : "职得工作证图片上传", "description" : "工作证图片上传通用接口", "operationId" : "zhima.customer.jobworth.picture.upload", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCustomerJobworthPictureUploadResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaCustomerJobworthPictureUploadErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCustomerJobworthPictureUploadModel" } } }, "required" : false } } }, "/v3/zhima/customer/jobworth/position/add" : { "post" : { "tags" : [ "zhima.customer.jobworth.position" ], "summary" : "职得工作证岗位收集", "description" : "保存商户传入岗位信息，当接口调用成功，业务问题时返回subcode", "operationId" : "zhima.customer.jobworth.position.add", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCustomerJobworthPositionAddResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaCustomerJobworthPositionAddErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaCustomerJobworthPositionAddModel" } } }, "required" : false } } }, "/v3/zhima/merchant/subsidiaries/apply" : { "post" : { "tags" : [ "zhima.merchant.subsidiaries" ], "summary" : "子商户信息添加", "description" : "子商户信息添加", "operationId" : "zhima.merchant.subsidiaries.apply", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaMerchantSubsidiariesApplyResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaMerchantSubsidiariesApplyErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaMerchantSubsidiariesApplyModel" } } }, "required" : false } } }, "/v3/zhima/merchant/subsidiaries/close" : { "post" : { "tags" : [ "zhima.merchant.subsidiaries" ], "summary" : "关闭子商户信息工单", "description" : "关闭子商户信息工单", "operationId" : "zhima.merchant.subsidiaries.close", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaMerchantSubsidiariesCloseResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaMerchantSubsidiariesCloseErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaMerchantSubsidiariesCloseModel" } } }, "required" : false } } }, "/v3/zhima/merchant/zmgo/cumulate/query" : { "get" : { "tags" : [ "zhima.merchant.zmgo.cumulate" ], "summary" : "商家芝麻GO累计数据查询接口", "description" : "芝麻GO数据累计查询接口，包含汇总和明细信息", "operationId" : "zhima.merchant.zmgo.cumulate.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaMerchantZmgoCumulateQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaMerchantZmgoCumulateQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "agreement_id", "in" : "query", "description" : "芝麻go协议号，唯一标识一个芝麻go协议。", "schema" : { "type" : "string", "example" : "20195108518085620000" } }, { "name" : "user_id", "in" : "query", "description" : "用户 id，用户在支付宝的唯一标识，以 2088 开头的 16 位纯数字组成。", "schema" : { "type" : "string", "example" : "2088602002015001" } }, { "name" : "open_id", "in" : "query", "description" : "用户 id，用户在支付宝的唯一标识，以 2088 开头的 16 位纯数字组成。", "schema" : { "type" : "string", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } }, { "name" : "provider_pid", "in" : "query", "description" : "数据回传的商户 ID，即和用户发生业务来往的 PID 主体。商户账号在支付宝的唯一标识，以 2088 开头的 16 位纯数字组成。", "schema" : { "type" : "string", "example" : "2088621805983504" } }, { "name" : "need_detail", "in" : "query", "description" : "是否需要回传明细。枚举支持：\t* true：需要回传明细。\t* false：不需要回传明细。", "schema" : { "type" : "boolean", "example" : "false" } }, { "name" : "page_no", "in" : "query", "description" : "分页参数，当need_detail=true时需要，代表当前页数，从1开始。", "schema" : { "type" : "integer", "example" : "1" } }, { "name" : "page_size", "in" : "query", "description" : "分页参数，当need_detail=true时需要，代表每页大小，不能大于20。", "schema" : { "type" : "integer", "example" : "20" } } ] } }, "/v3/zhima/merchant/zmgo/cumulate/sync" : { "post" : { "tags" : [ "zhima.merchant.zmgo.cumulate" ], "summary" : "商家芝麻GO累计数据回传接口", "description" : "外部商家接入芝麻GO场景下，回传用户行为履约数据给芝麻。", "operationId" : "zhima.merchant.zmgo.cumulate.sync", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaMerchantZmgoCumulateSyncResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaMerchantZmgoCumulateSyncErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaMerchantZmgoCumulateSyncModel" } } }, "required" : false } } }, "/v3/zhima/merchant/zmgo/template/create" : { "post" : { "tags" : [ "zhima.merchant.zmgo.template" ], "summary" : "商户创建芝麻GO模板接口", "description" : "外部商家接入芝麻GO场景下，为商户提供自助创建芝麻GO模板的能力。\n", "operationId" : "zhima.merchant.zmgo.template.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaMerchantZmgoTemplateCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaMerchantZmgoTemplateCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaMerchantZmgoTemplateCreateModel" } } }, "required" : false } } }, "/v3/zhima/merchant/zmgo/template/query" : { "get" : { "tags" : [ "zhima.merchant.zmgo.template" ], "summary" : "芝麻GO模板查询", "description" : "芝麻GO模板查询", "operationId" : "zhima.merchant.zmgo.template.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZhimaMerchantZmgoTemplateQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZhimaMerchantZmgoTemplateQueryErrorResponseModel" } ] } } } } }, "parameters" : [ { "name" : "template_no", "in" : "query", "description" : "模板ID，由创建模板接口返回结果提供", "schema" : { "type" : "string", "example" : "ZMGO_TPL2021061601004538" } }, { "name" : "partner_id", "in" : "query", "description" : "商户ID", "schema" : { "type" : "string", "example" : "208830****697946" } } ] } }, "/v3/zoloz/authentication/customer/facemanage/create" : { "post" : { "tags" : [ "zoloz.authentication.customer.facemanage" ], "summary" : "热脸入库", "description" : "热脸入库", "operationId" : "zoloz.authentication.customer.facemanage.create", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZolozAuthenticationCustomerFacemanageCreateResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZolozAuthenticationCustomerFacemanageCreateErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZolozAuthenticationCustomerFacemanageCreateModel" } } }, "required" : false } } }, "/v3/zoloz/authentication/customer/facemanage/delete" : { "post" : { "tags" : [ "zoloz.authentication.customer.facemanage" ], "summary" : "热脸出库", "description" : "出库逻辑", "operationId" : "zoloz.authentication.customer.facemanage.delete", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZolozAuthenticationCustomerFacemanageDeleteResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZolozAuthenticationCustomerFacemanageDeleteErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZolozAuthenticationCustomerFacemanageDeleteModel" } } }, "required" : false } } }, "/v3/zoloz/authentication/customer/ftoken/query" : { "post" : { "tags" : [ "zoloz.authentication.customer.ftoken" ], "summary" : "人脸ftoken查询消费接口", "description" : "人脸ftoken查询消费接口", "operationId" : "zoloz.authentication.customer.ftoken.query", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZolozAuthenticationCustomerFtokenQueryResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZolozAuthenticationCustomerFtokenQueryErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZolozAuthenticationCustomerFtokenQueryModel" } } }, "required" : false } } }, "/v3/zoloz/authentication/customer/smilepay/initialize" : { "post" : { "tags" : [ "zoloz.authentication.customer.smilepay" ], "summary" : "人脸刷脸付初始化", "description" : "人脸刷脸付初始化", "operationId" : "zoloz.authentication.customer.smilepay.initialize", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZolozAuthenticationCustomerSmilepayInitializeResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZolozAuthenticationCustomerSmilepayInitializeErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZolozAuthenticationCustomerSmilepayInitializeModel" } } }, "required" : false } } }, "/v3/zoloz/authentication/smilepay/initialize" : { "post" : { "tags" : [ "zoloz.authentication.smilepay" ], "summary" : "刷脸支付初始化", "description" : "通过该接口获取刷脸支付服务的初始化信息，详细字段描述请参考产品说明文档", "operationId" : "zoloz.authentication.smilepay.initialize", "responses" : { "200" : { "description" : "common response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZolozAuthenticationSmilepayInitializeResponseModel" } } } }, "default" : { "description" : "请求失败", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/CommonErrorType" }, { "$ref" : "#/components/schemas/ZolozAuthenticationSmilepayInitializeErrorResponseModel" } ] } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZolozAuthenticationSmilepayInitializeModel" } } }, "required" : false } } } }, "components" : { "schemas" : { "AbilityPageQueryDTO" : { "type" : "object", "properties" : { "page_data" : { "type" : "array", "description" : "搜索运营列表的分页数据", "items" : { "$ref" : "#/components/schemas/SearchAbilityOrderData" } }, "page_num" : { "type" : "string", "description" : "当前页码，默认第一页", "example" : "1" }, "page_size" : { "type" : "string", "description" : "每页记录数，默认10", "example" : "10" }, "total_number" : { "type" : "integer", "description" : "记录总数", "example" : "10" } } }, "AccountLogItemResult" : { "type" : "object", "properties" : { "account_log_id" : { "type" : "string", "description" : "支付宝账务流水号。对账使用，不脱敏", "example" : "1***" }, "alipay_order_no" : { "type" : "string", "description" : "支付宝订单号。对账使用，不脱敏", "example" : "20190101***" }, "balance" : { "type" : "string", "description" : "余额，仅供参考。由于架构原因，余额变动并不保证连续。也就是余额不一定等于上一笔余额减去当笔金额。但是会保证最终一致。", "example" : "10000.00" }, "bill_source" : { "type" : "string", "description" : "业务账单来源，资金收支对应的上游业务订单数据来源，确认业务订单出处。此字段供商户对账使用，不脱敏。", "example" : "商家中心" }, "biz_desc" : { "type" : "string", "description" : "业务描述，资金收支对应的详细业务场景信息。此字段供商户对账使用，不脱敏。", "example" : "002***|交易退款" }, "biz_nos" : { "type" : "string", "description" : "业务订单号，资金收支相关的业务场景订单号明细，字母大写；M：平台交易主单号，S：平台交易子单号，O：业务系统单据号（如退款订单号）。此字段供商户对账使用，不脱敏。", "example" : "M{330***}|S{330***}|O{192***}" }, "biz_orig_no" : { "type" : "string", "description" : "业务基础订单号，资金收支对应的原始业务订单唯一识别编号。此字段供商户对账使用，不脱敏。", "example" : "330***" }, "complement_info" : { "type" : "string", "description" : "账单的补全信息，用于特殊场景，普通商户不需要传值，对账时可忽略。", "example" : "商家中心" }, "direction" : { "type" : "string", "description" : "收入/支出。表示收支。amount是正数，返回“收入”。amount是负数，返回“支出”", "example" : "收入" }, "merchant_order_no" : { "type" : "string", "description" : "商户订单号，创建支付宝交易时传入的信息。对账使用，不脱敏", "example" : "TX***" }, "merchant_out_refund_no" : { "type" : "string", "description" : "支付宝交易商户退款请求号。对应商户在调用收单退款接口openApi请求传入的outRequestNo参数值", "example" : "20211119***" }, "other_account" : { "type" : "string", "description" : "对方账户", "example" : "张*(a*@alipay.com)" }, "store_name" : { "type" : "string", "description" : "球房信息", "example" : "杭州一店" }, "trans_amount" : { "type" : "string", "description" : "金额", "example" : "1000.00" }, "trans_dt" : { "type" : "string", "description" : "入账时间", "example" : "2019-01-01 00:00:00" }, "trans_memo" : { "type" : "string", "description" : "账务备注。由上游业务决定，不可依赖此字段进行对账", "example" : "备注1" }, "type" : { "type" : "string", "description" : "账务记录的类型，仅供参考", "example" : "交易" } } }, "AccountQuotaDetail" : { "type" : "object", "properties" : { "quota_amount" : { "type" : "integer", "description" : "周期内的额度上限", "example" : "50000" }, "quota_dimension" : { "type" : "string", "description" : "额度周期，有限枚举", "example" : "DAY" }, "role" : { "type" : "string", "description" : "角色", "example" : "PAYER" } } }, "ActivityAppInfo" : { "type" : "object", "properties" : { "mini_app_id" : { "type" : "string", "description" : "小程序id", "example" : "2021238412323412" } } }, "ActivityBaseInfo" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "活动id" }, "activity_name" : { "type" : "string", "description" : "活动名称。 不对用户进行展示，仅供商家在后台管理活动使用。" }, "activity_operation_status" : { "type" : "string", "description" : "活动操作状态。" }, "activity_product_type" : { "type" : "string", "description" : "券活动产品类型" }, "activity_status" : { "type" : "string", "description" : "活动状态。 已激活状态表示活动正常运行。已终止状态表示商家终止活动，不可再发放。" }, "belong_merchant_info" : { "$ref" : "#/components/schemas/BelongMerchantInfo" }, "code_mode" : { "type" : "string", "description" : "码模式。 MERCHANT_UPLOAD：商户上传自定义code，发券时系统随机选取上传的券code发放 MERCHANT_API：发奖时指定券码发奖，此模式无须提前上传券码。" }, "out_activity_id" : { "type" : "string", "description" : "外部活动ID" } } }, "ActivityDiscountVoucher" : { "type" : "object", "properties" : { "ceiling_amount" : { "type" : "string", "description" : "封顶金额。" }, "discount" : { "type" : "string", "description" : "折扣率。" }, "floor_amount" : { "type" : "string", "description" : "门槛金额。" }, "goods_name" : { "type" : "string", "description" : "商品名称。说明：该字段可不填，填入 origin_amount 则必填。" }, "origin_amount" : { "type" : "string", "description" : "原价。" } } }, "ActivityExchangeVoucher" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "券的价值。" }, "floor_amount" : { "type" : "string", "description" : "优惠门槛金额，表示只有当订单金额大于等于门槛金额时券才能使用。该字段为空时表示无门槛。 门槛金额的校验由服务商(商户)核销时自行校验，支付宝侧只做展示使用。 币种为人民币，单位为元。小数点以后最多保留两位。 设置门槛：取值范围:0.1<=x<= 50000。如果设置了门槛金额，则必须大于等于0.1，不可以等于0。" }, "overdue_refundable" : { "type" : "boolean", "description" : "是否支持优惠券过期后，自动退款给用户。 不填默认否，枚举值： true：是 false：否 自动退款功能需要服务商在优惠券过期时，主动调用alipay.marketing.activity.order.refund接口进行退款。 如果配置优惠券时选择了过期自动退款，但是实际券过期后，服务商没有进行退款，那么用户投诉后，需要服务商进行解决。" }, "refundable" : { "type" : "boolean", "description" : "购买的优惠券是否允许退款。 不填默认否，枚举值： true：是 false：否" }, "sale_amount" : { "type" : "string", "description" : "用户购买优惠券需要支付的金额。" } } }, "ActivityFixVoucher" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "面额，每张代金券可以抵扣的金额。" }, "floor_amount" : { "type" : "string", "description" : "门槛金额。该字段不填写，认为无门槛。" }, "goods_name" : { "type" : "string", "description" : "商品名称。" } } }, "ActivityGoodsInfo" : { "type" : "object", "properties" : { "goods_id" : { "type" : "string", "description" : "商品编码", "example" : "111" }, "goods_use_type" : { "type" : "string", "description" : "活动单品类型。 枚举值: AVAILABLE可用单品 UNAVAILABLE不可用单品", "example" : "AVAILABLE" } } }, "ActivityLiteInfo" : { "type" : "object", "properties" : { "activity_base_info" : { "$ref" : "#/components/schemas/ActivityBaseInfo" }, "activity_id" : { "type" : "string", "description" : "活动 id。", "example" : "2016042700826004508401111111" }, "activity_name" : { "type" : "string", "description" : "活动名称。 不对支付宝用户进行展示，仅供商家在后台管理活动使用。", "example" : "满10减1活动" }, "activity_status" : { "type" : "string", "description" : "活动状态。", "example" : "ACTIVE" }, "belong_merchant_id" : { "type" : "string", "description" : "归属商户 PID。", "example" : "2088202967380463" }, "create_time" : { "type" : "string", "description" : "活动创建时间。", "example" : "2017-01-01 00:00:01" }, "publish_end_time" : { "type" : "string", "description" : "券发放结束时间。格式为：yyyy-MM-dd HH:mm:ss。", "example" : "2017-01-29 23:59:59" }, "publish_start_time" : { "type" : "string", "description" : "券发放开始时间。格式为：yyyy-MM-dd HH:mm:ss。", "example" : "2017-01-01 00:00:01" }, "voucher_available_scope_info" : { "$ref" : "#/components/schemas/VoucherAvailableScopeInfo" }, "voucher_customer_guide_info" : { "$ref" : "#/components/schemas/VoucherCustomerGuideInfo" }, "voucher_deduct_info" : { "$ref" : "#/components/schemas/VoucherDeductInfo" }, "voucher_display_lite_info" : { "$ref" : "#/components/schemas/CommonVoucherDisplayLiteInfo" }, "voucher_display_pattern_info" : { "$ref" : "#/components/schemas/VoucherDisplayPatternInfo" }, "voucher_send_mode_info" : { "$ref" : "#/components/schemas/VoucherSendModeInfo" }, "voucher_type" : { "type" : "string", "description" : "券类型。", "example" : "FIX_VOUCHER" }, "voucher_use_rule_info" : { "$ref" : "#/components/schemas/VoucherUseRuleInfo" }, "voucher_use_rule_lite_info" : { "$ref" : "#/components/schemas/CommonVoucherUseRuleLiteInfo" } } }, "ActivityMerchantInfo" : { "type" : "object", "properties" : { "merchant_id" : { "type" : "string", "description" : "商户支付宝id", "example" : "2088xx" }, "merchant_id_type" : { "type" : "string", "description" : "商户支付宝id类型。\t枚举值\tPID 直连pid\tSMID 间连SMID", "example" : "PID" } } }, "ActivityShopInfo" : { "type" : "object", "properties" : { "latitude" : { "type" : "string", "description" : "纬度，浮点型,小数点后最多保留6位", "example" : "60.270001" }, "longitude" : { "type" : "string", "description" : "经度，浮点型, 小数点后最多保留6位。", "example" : "120.760001" }, "shop_id" : { "type" : "string", "description" : "支付宝侧蚂蚁店铺 id。", "example" : "2018011900502000000005124744" }, "shop_name" : { "type" : "string", "description" : "店铺名称。", "example" : "肯德基中关村店" }, "shop_type" : { "type" : "string", "description" : "球房类型\tPAYMENT_SHOP 支付球房\tREAL_SHOP 代运营商业关系球房", "example" : "PAYMENT_SHOP" } } }, "ActivitySpecialVoucher" : { "type" : "object", "properties" : { "floor_amount" : { "type" : "string", "description" : "门槛金额。" }, "goods_name" : { "type" : "string", "description" : "商品名称。说明：该字段可不填，填入 origin_amount 则必填。" }, "origin_amount" : { "type" : "string", "description" : "原价。" }, "special_amount" : { "type" : "string", "description" : "特价，即：原价-特价=优惠金额。" } } }, "AddressInfo" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "地址。商户详细经营地址或人员所在地点" }, "city_code" : { "type" : "string", "description" : "城市编码。\t蚂蚁店铺请按照蚂蚁店铺地区码 表格中填写。\t直付通商户请按照直付通商户地区码 表格中内容填写。" }, "district_code" : { "type" : "string", "description" : "区县编码。\t蚂蚁店铺请按照蚂蚁店铺地区码 表格中填写。\t直付通商户请按照直付通商户地区码 表格中内容填写。" }, "latitude" : { "type" : "string", "description" : "纬度，浮点型,小数点后最多保留6位\r\t如需要录入经纬度，请以高德坐标系为准，录入时请确保经纬度参数准确。高德经纬度查询：http://lbs.amap.com/console/show/picker" }, "longitude" : { "type" : "string", "description" : "经度，浮点型, 小数点后最多保留6位。\r\t如需要录入经纬度，请以高德坐标系为准，录入时请确保经纬度参数准确。高德经纬度查询：http://lbs.amap.com/console/show/picker" }, "poiid" : { "type" : "string", "description" : "高德poiid" }, "province_code" : { "type" : "string", "description" : "省份编码。\t蚂蚁店铺请按照蚂蚁店铺地区码 表格中填写。\t直付通商户请按照直付通商户地区码 表格中内容填写。" }, "type" : { "type" : "string", "description" : "地址类型。取值范围：BUSINESS_ADDRESS：经营地址（默认）" } } }, "AddressInfoDTO" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户id，当入参传入共同账户id时返回该值", "example" : "2088501312695783" }, "address" : { "type" : "string", "description" : "详细地址", "example" : "西溪路569号蚂蚁A空间6楼601" }, "address_id" : { "type" : "string", "description" : "地址id", "example" : "190303094020" }, "city_code" : { "type" : "string", "description" : "市(国家统一行政规划编码)", "example" : "330100" }, "city_name" : { "type" : "string", "description" : "城市", "example" : "杭州市" }, "community" : { "type" : "string", "description" : "小区/楼宇", "example" : "蚂蚁A空间" }, "enterprise_id" : { "type" : "string", "description" : "企业id，当入参传入企业id时返回该值", "example" : "2088501312695783" }, "latitude" : { "type" : "string", "description" : "纬度", "example" : "30.261121" }, "longitude" : { "type" : "string", "description" : "经度", "example" : "120.104735" }, "mark" : { "type" : "string", "description" : "备注", "example" : "备注" }, "poi_id" : { "type" : "string", "description" : "地图poi", "example" : "B0GKN4522Z" } } }, "Advert" : { "type" : "object", "properties" : { "advert_group" : { "type" : "string", "description" : "广告组标识", "example" : "CG202008041013200064690" }, "advert_id" : { "type" : "string", "description" : "广告位id", "example" : "123" }, "advert_items" : { "type" : "array", "description" : "广告位轮播内容列表", "items" : { "$ref" : "#/components/schemas/AdvertItem" } }, "group_id" : { "type" : "string", "description" : "投放人群分组id", "example" : "RQ20191025100100595279" }, "mobile_client_type" : { "type" : "string", "description" : "手机客户端类型，iphone、android、wp,空为不区分机型", "example" : "android" } } }, "AdvertItem" : { "type" : "object", "properties" : { "img_url" : { "type" : "string", "description" : "广告图片url, 尺寸为996*240，最大不超过5M，支持格式:.jpg、.png ，请先调用 图片上传接口获得图片url" }, "link_type" : { "type" : "string", "description" : "跳转类型，网页:HTTP、小程序:APP，不传默认HTTP" }, "link_url" : { "type" : "string", "description" : "跳转链接，点击广告图片跳到的链接url" }, "name" : { "type" : "string", "description" : "广告帧名称，可选" } } }, "AgentChatInfo" : { "type" : "object", "properties" : { "ccs_instance_id" : { "type" : "string", "description" : "数据权限id(租户实例id)" }, "extended_group_ids" : { "type" : "array", "description" : "在线扩展技能组id列表", "items" : { "type" : "string" } }, "group_id" : { "type" : "string", "description" : "在线技能组id" }, "level_id" : { "type" : "string", "description" : "在线服务等级" } } }, "AgentHotlineInfo" : { "type" : "object", "properties" : { "ccs_instance_id" : { "type" : "string", "description" : "数据权限id(租户实例id)" }, "group_ids" : { "type" : "array", "description" : "热线技能组id", "items" : { "type" : "string" } } } }, "AgentScheduleLog" : { "type" : "object", "properties" : { "agent_id" : { "type" : "string", "description" : "客服id", "example" : "2018101801902073" }, "agent_name" : { "type" : "string", "description" : "客服名称", "example" : "张三" }, "create_time" : { "type" : "string", "description" : "状态变更发生时间,采用UTC时间，按照ISO8601标准表示，格式为：yyyy-MM-dd'T'HH:mm:ss'Z'", "example" : "2020-10-23 09:10:23" }, "duration" : { "type" : "integer", "description" : "状态持续时长,单位秒", "example" : "120" }, "end_time" : { "type" : "string", "description" : "状态变更结束时间,采用UTC时间，按照ISO8601标准表示，格式为：yyyy-MM-dd'T'HH:mm:ss'Z'", "example" : "2020-10-23 09:20:53" }, "external_user_no" : { "type" : "string", "description" : "isv或商户系统中对应的客服工号", "example" : "0012" }, "id" : { "type" : "string", "description" : "客服状态变更流水id", "example" : "10223" }, "last_status" : { "type" : "string", "description" : "变更前状态", "example" : "离线" }, "start_time" : { "type" : "string", "description" : "状态变更开始时间,采用UTC时间，按照ISO8601标准表示，格式为：yyyy-MM-dd'T'HH:mm:ss'Z'", "example" : "2020-10-23 09:10:23" }, "status" : { "type" : "string", "description" : "变更后状态", "example" : "上线" } } }, "AgentVO" : { "type" : "object", "properties" : { "answering_mode" : { "type" : "string", "description" : "热线接入方式", "example" : "0" }, "avatar" : { "type" : "string", "description" : "头像的oss file key", "example" : "testfile" }, "ccs_instance_ids" : { "type" : "array", "description" : "客服归属的部门id列表", "items" : { "type" : "string" }, "example" : "[\"XAHSNRBS\"]" }, "chat_config" : { "type" : "array", "description" : "在线技能组信息", "items" : { "$ref" : "#/components/schemas/AgentChatInfo" } }, "create_time" : { "type" : "string", "description" : "创建时间， 标准时间格式：yyyy-MM-dd HH:mm:ss", "example" : "2020-10-01 11:11:11" }, "creator_id" : { "type" : "string", "description" : "创建人id", "example" : "2019032101896769" }, "dingtalk_user_id" : { "type" : "string", "description" : "钉钉user_id（绑定钉钉的用户该字段非空）", "example" : "1293894912" }, "email" : { "type" : "string", "description" : "客服邮箱", "example" : "test@163.com" }, "external_id" : { "type" : "string", "description" : "外部系统用户,比如金融云的用户id、支付宝账号id", "example" : "2088xxx" }, "hotline_config" : { "type" : "array", "description" : "热线技能组信息", "items" : { "$ref" : "#/components/schemas/AgentHotlineInfo" } }, "id" : { "type" : "string", "description" : "客服唯一标识id", "example" : "2019032101896769" }, "job_number" : { "type" : "string", "description" : "客服工号", "example" : "0002" }, "last_login_time" : { "type" : "string", "description" : "最后登录时间,标准时间格式：yyyy-MM-dd HH:mm:ss", "example" : "2020-10-20 07:40:31" }, "mobile" : { "type" : "string", "description" : "客服手机号", "example" : "13812345678" }, "nick_name" : { "type" : "string", "description" : "客服昵称", "example" : "风清扬" }, "profile" : { "type" : "string", "description" : "个人简介", "example" : "我是玉树临风一表人才的张三" }, "real_name" : { "type" : "string", "description" : "客服姓名", "example" : "张三" }, "role_ids" : { "type" : "array", "description" : "客服角色id列表", "items" : { "$ref" : "#/components/schemas/RoleId" } }, "status" : { "type" : "string", "description" : "状态：NORMAL，DELETE", "example" : "NORMAL" }, "type" : { "type" : "string", "description" : "用户类型：NORMAL（普通客服），ADMIN（超级管理员，不能被删除）", "example" : "NORMAL" }, "update_time" : { "type" : "string", "description" : "最后修改时间， 标准时间格式：yyyy-MM-dd HH:mm:ss", "example" : "2020-10-01 11:11:11" }, "updater_id" : { "type" : "string", "description" : "最后修改人id", "example" : "2019032101896769" } } }, "AgreementDetail" : { "type" : "object", "properties" : { "agreement_no" : { "type" : "string", "description" : "协议号", "example" : "20120000000000000000" }, "status" : { "type" : "string", "description" : "协议状态", "example" : "NORMAL" } } }, "AgreementParams" : { "type" : "object", "properties" : { "agreement_no" : { "type" : "string", "description" : "支付宝系统中用以唯一标识用户签约记录的编号（用户签约成功后的协议号 ）", "example" : "20170322450983769228" }, "apply_token" : { "type" : "string", "description" : "鉴权申请token，其格式和内容，由支付宝定义。在需要做支付鉴权校验时，该参数不能为空。", "example" : "MDEDUCT0068292ca377d1d44b65fa24ec9cd89132f" }, "auth_confirm_no" : { "type" : "string", "description" : "鉴权确认码，在需要做支付鉴权校验时，该参数不能为空", "example" : "423979" }, "deduct_permission" : { "type" : "string", "description" : "商户代扣扣款许可", "example" : "2021571176714791277815457854545" } } }, "AgreementQuotaModifyList" : { "type" : "object", "properties" : { "agreement_no" : { "type" : "string", "description" : "授权协议号", "example" : "20205321001042231004" }, "quota_details" : { "type" : "array", "description" : "设置额度明细", "items" : { "$ref" : "#/components/schemas/ModifyQuotaDetails" } } } }, "AliosOpenAutoInfoQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ISV_VERIFICATION_FAILED", "NOT_FOUND", "BIZ_ERROR", "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AliosOpenAutoInfoQueryResponseModel" : { "type" : "object", "properties" : { "engine_no" : { "type" : "string", "description" : "发动机号", "example" : "234534634523" }, "license_no" : { "type" : "string", "description" : "车牌号", "example" : "京FW12A7" }, "user_activation_time" : { "type" : "string", "description" : "用户激活时间", "example" : "2020-04-29 15:53:11" }, "vehicle_type" : { "type" : "string", "description" : "车辆类型", "example" : "02" }, "vin" : { "type" : "string", "description" : "车辆识别号码", "example" : "T1D234E567A890H" } } }, "AlipayBossFncInvoiceApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayBossFncInvoiceApplyModel" : { "type" : "object", "properties" : { "biz_id" : { "type" : "string", "description" : "调用方身份识别标记(应用名称) 与业务单据号联合唯一", "example" : "SETTLE_MIDDLE_GROUND" }, "biz_no" : { "type" : "string", "description" : "业务单据号，业务流水号", "example" : "47674d29cadd425a7eeb3ae4b51af7d5_765915" }, "invoice_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "invoice_type" : { "type" : "string", "description" : "申请开票类型，01：专票；02：普票", "example" : "01" }, "memo" : { "type" : "string", "description" : "备注", "example" : "备注" }, "mthtly_bill_nos" : { "type" : "array", "description" : "需开票的应收月账单号", "items" : { "type" : "string" }, "example" : "2018060510122000040400841100996001" }, "operator" : { "type" : "string", "description" : "申请人的uid号", "example" : "208812345677" }, "out_biz_type" : { "type" : "string", "description" : "01主站，02芝麻，03金融云", "example" : "03" } } }, "AlipayBossFncInvoiceApplyResponseModel" : { "type" : "object", "properties" : { "result_set" : { "type" : "string", "description" : "开票申请ID，唯一性ID", "example" : "2017090710122000473800320000049574" } } }, "AlipayBossFncInvoiceBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayBossFncInvoiceBatchqueryModel" : { "type" : "object", "properties" : { "apply_order_id" : { "type" : "string", "description" : "开票申请ID，唯一标识开票申请表的ID", "example" : "2017090710122000473800320000049574" }, "buyer_invoice_title" : { "type" : "string", "description" : "买方发票抬头，用于打印在发票上", "example" : "联想 ( 上海 ) 电子科技有限公司" }, "buyer_ipid" : { "type" : "string", "description" : "对应发票商户的ipId，在主站标示mid，在其他环境标示ip_id。", "example" : "10000004" }, "buyer_ipids" : { "type" : "array", "description" : "购方商户ID集合", "items" : { "type" : "string" }, "example" : "2345643" }, "buyer_iprole_id" : { "type" : "string", "description" : "商户结算的ipRoleId，表示商户的结算对象，在主站表示pid。", "example" : "2088621524618252" }, "buyer_iprole_ids" : { "type" : "array", "description" : "购方PID集合", "items" : { "type" : "string" }, "example" : "2088621524618252" }, "inst_id" : { "type" : "string", "description" : "对应发票所在OU的id，用于标示该发票所述的OU。", "example" : "Z50" }, "invoice_channel" : { "type" : "string", "description" : "开票渠道 01 线上;02 线下", "example" : "01" }, "invoice_code" : { "type" : "string", "description" : "发票代码，税务部门给予发票的编码", "example" : "031001600211" }, "invoice_create_date_begin" : { "type" : "string", "description" : "发票创建日期【起始日期，格式yyyyMMdd】", "example" : "20180723" }, "invoice_create_date_end" : { "type" : "string", "description" : "发票创建日期【结束日期，格式yyyyMMdd】", "example" : "20180723" }, "invoice_ids" : { "type" : "array", "description" : "发票ID集合，发票ID，唯一标示一张发票的ID", "items" : { "type" : "string" }, "example" : "2017011210122000494000670000000001" }, "invoice_material" : { "type" : "string", "description" : "开票介质 01电子 02纸质", "example" : "01" }, "invoice_no" : { "type" : "string", "description" : "发票号码，税务部门给予发票的编码", "example" : "86230814" }, "invoice_open_date_begin" : { "type" : "string", "description" : "发票开票日期【起始日期，格式yyyyMMdd】", "example" : "20180723" }, "invoice_open_date_end" : { "type" : "string", "description" : "发票开票日期【结束日期，格式yyyyMMdd】", "example" : "20180723" }, "invoice_status" : { "type" : "array", "description" : "发票状态：用于标示发票当前的状态，状态类型以及相关含义：01 待开票;02 开票中;03 已开票;04 作废中;05 已作废;06 红冲中;07 已红冲;08 部分红冲;09 无效", "items" : { "type" : "string" }, "example" : "01" }, "invoice_types" : { "type" : "array", "description" : "发票类型,01专票 02普票 03营业税发票 04国际形式发票 05其它发票", "items" : { "type" : "string" }, "example" : "01" }, "is_online" : { "type" : "string", "description" : "是否能在线开票 Y能 N不能", "example" : "Y" }, "is_red" : { "type" : "string", "description" : "是否红字 Y红字 N蓝字", "example" : "N" }, "mail_status" : { "type" : "array", "description" : "邮寄状态 01 待邮寄;02 已邮寄;03 退回中;04 已退回", "items" : { "type" : "string" }, "example" : "01" }, "monthly_bill_no" : { "type" : "string", "description" : "月账单号", "example" : "2017090510122000040400320000017749" }, "page_no" : { "type" : "integer", "description" : "起始页，分页时必须提供", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "每页显示数，分页时必须提供", "example" : "20" }, "tracking_no" : { "type" : "string", "description" : "快递单号", "example" : "20170112101" } } }, "AlipayBossFncInvoiceBatchqueryResponseModel" : { "type" : "object", "properties" : { "amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "current_page" : { "type" : "integer", "description" : "当前页码", "example" : "123456" }, "items_page" : { "type" : "integer", "description" : "每页条数", "example" : "123456" }, "result_set" : { "type" : "array", "description" : "结果对象,发票对象的集合", "items" : { "$ref" : "#/components/schemas/ArInvoiceOpenApiResponse" } }, "total_items" : { "type" : "integer", "description" : "查询到的结果总数", "example" : "123456" }, "total_pages" : { "type" : "integer", "description" : "总页数", "example" : "123456" } } }, "AlipayBossFncInvoiceQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayBossFncInvoiceQueryResponseModel" : { "type" : "object", "properties" : { "result_set" : { "$ref" : "#/components/schemas/ArInvoiceOpenApiResponse" } } }, "AlipayBossFncInvoicereceiptBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayBossFncInvoicereceiptBatchqueryModel" : { "type" : "object", "properties" : { "bill_nos" : { "type" : "array", "description" : "月账单号集合，唯一性ID集合，月账单表唯一主键ID集合", "items" : { "type" : "string" }, "example" : "2015050910120900000001120000000001" }, "out_biz_type" : { "type" : "string", "description" : "来源类型，01：主站；02：芝麻；03：金融云；04：微贷", "example" : "03" } } }, "AlipayBossFncInvoicereceiptBatchqueryResponseModel" : { "type" : "object", "properties" : { "result_set" : { "type" : "array", "description" : "返回结果对象：可开票单据", "items" : { "$ref" : "#/components/schemas/ArInvoiceReceiptOpenApiResponse" } }, "total_inv_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "total_inved_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "total_link_invoice_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" } } }, "AlipayBossFncInvoicereceiptCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayBossFncInvoicereceiptCreateModel" : { "type" : "object", "properties" : { "event_code" : { "type" : "string", "description" : "账单金额变更消息事件码\r\tAR_MTHLY_BILL_CREATE:应收账单创建,\r\tAR_MTHLY_BILL_CHANGE:应收金额更新", "example" : "AR_MTHLY_BILL_CREATE" }, "event_type" : { "type" : "string", "description" : "账单金额变更消息事件类型\r\tCREATE:创建事件,UPDATE:更新事件", "example" : "CREATE" }, "monthly_bill" : { "$ref" : "#/components/schemas/ArMonthlyBillDTO" }, "msg_id" : { "type" : "string", "description" : "事件全局id，可以使用uuid", "example" : "12345678996434444" }, "out_biz_type" : { "type" : "string", "description" : "消息来源 01:主站，02：芝麻，03:金融云,04:微贷", "example" : "03" } } }, "AlipayBossFncInvoicereceiptCreateResponseModel" : { "type" : "object" }, "AlipayBossFncUserinvoiceinfoCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayBossFncUserinvoiceinfoCreateModel" : { "type" : "object", "properties" : { "accept_electronic" : { "type" : "boolean", "description" : "是否接受电子票 true:是，false:否", "example" : "false" }, "address" : { "type" : "string", "description" : "公司注册地址，公司营业执照上登记的住址，一般纳税人必须填写，小规模纳税人无需填写", "example" : "武汉市武昌区中北路7号" }, "addressing" : { "type" : "boolean", "description" : "开票资料pid寻址方式 true:pid寻址mid,优先以mid维度保存开票资料,若无mid则以pid维度保存开票资料 false:不寻址mid,以pid维度保存开票资料;非主站商户体系都是以pid（ipRoleId）维度保存开票资料，该值直接填为false", "example" : "false" }, "auto" : { "type" : "boolean", "description" : "是否自动申请开票 true:是，false:否", "example" : "false" }, "bank_account" : { "type" : "string", "description" : "银行账户，公司银行账号\r\t一般纳税人必须填写，小规模纳税人无需填写", "example" : "3602201309100137669" }, "bank_name" : { "type" : "string", "description" : "开户行，办理银行开户手续的营业网点\r\t一般纳税人必须填写，小规模纳税人无需填写", "example" : "中国工商银行广州市第二支行" }, "business_licence_url" : { "type" : "string", "description" : "营业执照地址，营业执照上传oss上的地址", "example" : "gfcenter/inv/userinvoicefile/aruserprofilepic_2088721075211978_15133031297372951.jpg" }, "hold" : { "type" : "boolean", "description" : "是否暂停开票，商户添加的开票资料就是不暂停开票，如果后续要暂停开票，只能去结算中台处理。", "example" : "false" }, "ip_role_id" : { "type" : "string", "description" : "商户的pid（ipRoleId）", "example" : "2088001007243670" }, "open_account_permit_url" : { "type" : "string", "description" : "银行开户许可证附件，银行开户许可证上传oss上的地址", "example" : "gfcenter/inv/userinvoicefile/aruserprofilepic_2088721075211978_15133031297372951.jpg" }, "operator" : { "type" : "string", "description" : "当前操作人", "example" : "李某某" }, "operator_type" : { "type" : "string", "description" : "当前操作人类型,01:商户 02:管理员(小二)", "example" : "02" }, "other_qualification_url" : { "type" : "string", "description" : "其它资质证明地址，其他资质证明附件上传oss上的地址", "example" : "gfcenter/inv/userinvoicefile/aruserprofilepic_2088721075211978_15133031297372951.jpg" }, "ou" : { "type" : "boolean", "description" : "外部只允许添加商户开票资料，该值填写为false", "example" : "false" }, "tax_no" : { "type" : "string", "description" : "纳税人识别号，税务登记证上的号码。一般纳税人必须填写，小规模纳税人如果是商户也必须填写，个人无需填写", "example" : "310113000782689" }, "tax_payer_quali_valid" : { "type" : "string", "description" : "纳税人资格开始时间 （格式：时间戳）\r\t一般纳税人必须填写，小规模纳税人无需填写", "example" : "1533039333744" }, "tax_payer_qualification" : { "type" : "string", "description" : "纳税人资格种类，01：一般纳税人；02：小规模纳税人；03：国际商户", "example" : "01" }, "tax_qualification_url" : { "type" : "string", "description" : "一般纳税人资格证书地址，一般纳税人资格证书上传oss上的地址", "example" : "gfcenter/inv/userinvoicefile/aruserprofilepic_2088721075211978_15133031297372951.jpg" }, "tax_reg_cert_url" : { "type" : "string", "description" : "税务登记证地址，税务登记证上传oss上的地址", "example" : "gfcenter/inv/userinvoicefile/aruserprofilepic_2088721075211978_15133031297372951.jpg" }, "telephone" : { "type" : "string", "description" : "公司注册电话（手机号和座机均可）\r\t一般纳税人必须填写，小规模纳税人无需填写", "example" : "021-56518888" }, "title" : { "type" : "string", "description" : "发票抬头，票面信息上的抬头信息", "example" : "上海大众汽车有限公司" }, "user_mail_info_order_list" : { "type" : "array", "description" : "收件人列表,若不修改此项可以不填\r\t选择非电子票时，邮寄信息必填，且保证邮寄信息的ipRoleId和开票资料的ipRoleId相等", "items" : { "$ref" : "#/components/schemas/UserMailInfoOrder" } } } }, "AlipayBossFncUserinvoiceinfoCreateResponseModel" : { "type" : "object", "properties" : { "result_set" : { "type" : "string", "description" : "开票资料id，唯一性ID", "example" : "2018060810122000544800670000008977" } } }, "AlipayBossFncUserinvoiceinfoModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayBossFncUserinvoiceinfoModifyModel" : { "type" : "object", "properties" : { "accept_electronic" : { "type" : "boolean", "description" : "是否接受电子票 true:是，false:否", "example" : "true" }, "address" : { "type" : "string", "description" : "公司注册地址，公司营业执照上登记的住址，一般纳税人必须填写，小规模纳税人无需填写", "example" : "武汉市武昌区中北路7号" }, "auto" : { "type" : "boolean", "description" : "是否自动申请开票 true:是；false:否", "example" : "true" }, "bank_account" : { "type" : "string", "description" : "银行账户，公司银行账号\r\t一般纳税人必须填写，小规模纳税人无需填写", "example" : "3602201309100137789" }, "bank_name" : { "type" : "string", "description" : "开户行，办理银行开户手续的营业网点\r\t一般纳税人必须填写，小规模纳税人无需填写", "example" : "中国工商银行广州市第二支行" }, "business_licence_url" : { "type" : "string", "description" : "营业执照地址，营业执照上传oss上的地址", "example" : "gfcenter/inv/userinvoicefile/aruserprofilepic_2088421504368153_15138457060231013.jpg" }, "hold" : { "type" : "boolean", "description" : "是否暂停开票，商户修改无效，如果要暂停开票，只能去结算中台处理。", "example" : "true" }, "id" : { "type" : "string", "description" : "开票资料ID", "example" : "10000004" }, "open_account_permit_url" : { "type" : "string", "description" : "银行开户许可证附件，银行开户许可证上传oss上的地址", "example" : "gfcenter/inv/userinvoicefile/aruserprofilepic_2088421504368153_151384570602313.jpg" }, "operator" : { "type" : "string", "description" : "当前操作人", "example" : "2088123456789776" }, "operator_type" : { "type" : "string", "description" : "当前操作人类型,01:商户；02:管理员(小二)", "example" : "01" }, "other_qualification_url" : { "type" : "string", "description" : "其它资质证明地址，其他资质证明附件上传oss上的地址", "example" : "gfcenter/inv/userinvoicefile/aruserprofilepic_2088421504368153_151384570602333.jpg" }, "tax_no" : { "type" : "string", "description" : "纳税人识别号，税务登记证上的号码。一般纳税人必须填写，小规模纳税人如果是商户也必须填写，个人无需填写", "example" : "310113000782689" }, "tax_payer_quali_valid" : { "type" : "string", "description" : "纳税人资格开始时间 （格式：时间戳）\r\t一般纳税人必须填写，小规模纳税人无需填写", "example" : "1533039333744" }, "tax_payer_qualification" : { "type" : "string", "description" : "纳税人资格种类，01：一般纳税人；02：小规模纳税人；03：国际商户", "example" : "01" }, "tax_qualification_url" : { "type" : "string", "description" : "一般纳税人资格证书地址，一般纳税人资格证书上传oss上的地址", "example" : "gfcenter/inv/userinvoicefile/aruserprofilepic_2088721075211978_15133031297372951.jpg" }, "tax_reg_cert_url" : { "type" : "string", "description" : "税务登记证地址，税务登记证上传oss上的地址", "example" : "gfcenter/inv/userinvoicefile/aruserprofilepic_2088421504368153_15138457060231013.jpg" }, "telephone" : { "type" : "string", "description" : "公司注册电话\r\t一般纳税人必须填写，小规模纳税人无需填写", "example" : "021-56518888" }, "title" : { "type" : "string", "description" : "发票抬头，票面信息上的抬头信息", "example" : "上海大众汽车有限公司" }, "user_mail_info_order_list" : { "type" : "array", "description" : "收件人列表,若不修改此项可以不填\r\t选择非电子票时，邮寄信息必填，且保证邮寄信息的ipRoleId和开票资料的ipRoleId相等", "items" : { "$ref" : "#/components/schemas/UserMailInfoOrder" } } } }, "AlipayBossFncUserinvoiceinfoModifyResponseModel" : { "type" : "object" }, "AlipayBossFncUserinvoiceinfoQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayBossFncUserinvoiceinfoQueryResponseModel" : { "type" : "object", "properties" : { "result_set" : { "$ref" : "#/components/schemas/UserInvoiceInfoOpenApiResponse" } } }, "AlipayBossProdMyTestQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayBossProdMyTestQueryResponseModel" : { "type" : "object", "properties" : { "longitude" : { "type" : "string", "description" : "经度", "example" : "dshuids" } } }, "AlipayCommerceCityfacilitatorStationQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "ILLEGAL_BIZ_PARAMS", "NO_RIGHT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceCityfacilitatorStationQueryResponseModel" : { "type" : "object", "properties" : { "support_starts" : { "type" : "array", "description" : "支持设为起点的站点列表", "items" : { "$ref" : "#/components/schemas/StationDetailInfo" } } } }, "AlipayCommerceCityfacilitatorVoucherBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "ILLEGAL_BIZ_PARAMS", "NO_RIGHT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceCityfacilitatorVoucherBatchqueryModel" : { "type" : "object", "properties" : { "city_code" : { "type" : "string", "description" : "城市编码请参考查询 中华人民共和国行政区划代码。\t已支持城市：广州 440100，深圳 440300，杭州330100。", "example" : "440300" }, "trade_nos" : { "type" : "array", "description" : "支付宝交易号列表", "items" : { "type" : "string" }, "example" : "0123456789" } } }, "AlipayCommerceCityfacilitatorVoucherBatchqueryResponseModel" : { "type" : "object", "properties" : { "tickets" : { "type" : "array", "description" : "查询到的订单信息列表", "items" : { "$ref" : "#/components/schemas/TicketDetailInfo" } } } }, "AlipayCommerceCityfacilitatorVoucherGenerateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SUCCESS", "SYSTEM_ERROR", "ILLEGAL_BIZ_PARAMS", "NO_RIGHT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceCityfacilitatorVoucherGenerateModel" : { "type" : "object", "properties" : { "city_code" : { "type" : "string", "description" : "城市编码请参考查询 中华人民共和国行政区划代码。\t已支持城市：广州 440100，深圳 440300，杭州330100。", "example" : "440300" }, "site_begin" : { "type" : "string", "description" : "起点站站点编码", "example" : "02490301" }, "site_end" : { "type" : "string", "description" : "终点站站点编码", "example" : "02490305" }, "ticket_num" : { "type" : "string", "description" : "地铁票购票数量", "example" : "5" }, "ticket_price" : { "type" : "string", "description" : "单张票价，元为单价", "example" : "5.00" }, "ticket_type" : { "type" : "string", "description" : "地铁票种类，枚举支持：\t*oneway。", "example" : "oneway" }, "total_fee" : { "type" : "string", "description" : "订单总金额，元为单位", "example" : "10.00" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号（交易支付时，必须通过指定sellerId：2088121612215201，将钱支付到指定的中间户中）", "example" : "2016031521001004390263523925" } } }, "AlipayCommerceCityfacilitatorVoucherGenerateResponseModel" : { "type" : "object", "properties" : { "expired_date" : { "type" : "string", "description" : "核销码过期时间", "example" : "2016-03-18 00:00:00" }, "qr_code_no" : { "type" : "string", "description" : "地铁购票二维码编码，可自定义", "example" : "site_begin=6018&site_end=0608&ticket_num=2&ticket_price=3.00&total_fee=6.00&trade_no=201603182100&ticket_no=546600&source=alipay" }, "ticket_no" : { "type" : "string", "description" : "地铁购票的核销码", "example" : "0243567832" } } }, "AlipayCommerceCityfacilitatorVoucherRefundErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "ILLEGAL_BIZ_PARAMS", "NO_RIGHT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceCityfacilitatorVoucherRefundModel" : { "type" : "object", "properties" : { "city_code" : { "type" : "string", "description" : "城市编码请参考查询 中华人民共和国行政区划代码。\t已支持城市：广州 440100，深圳 440300，杭州330100。", "example" : "440300" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号", "example" : "2016031521001004390263523925" } } }, "AlipayCommerceCityfacilitatorVoucherRefundResponseModel" : { "type" : "object" }, "AlipayCommerceEcBalanceDownloadurlQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PERMISSION_DENIED", "PARAMETER_ILLEGAL", "MONTH_BALANCE_RECORD_NOT_EXIST", "BALANCE_HAS_NO_CONSUME", "DAILY_BALANCE_RECORD_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcBalanceDownloadurlQueryResponseModel" : { "type" : "object", "properties" : { "bill_download_url" : { "type" : "string", "description" : "对账单下载地址链接", "example" : "https://mdgwdev.alipay.net/induspt_invoice/afts/file/A*hmt6Trd6OpUAAAAAAAAAAAAAAUYnAA?t=GWVhXq9S4K55nzCCaDB_fgAAAABkJ0ZiucEy&af_fileName=%E6%9C%88%E5%AF%B9%E8%B4%A6%E5%8D%95_2022-05-15.xlsx" } } }, "AlipayCommerceEcBalancePeriodModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PERMISSION_DENIED", "PARAMETER_ILLEGAL", "BALANCE_PERIOD_INVALID", "LOCK_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcBalancePeriodModifyModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户id - 适用于在企业码小程序创建的共同账户，和agreement_no搭配使用", "example" : "2088000194958956" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "bill_day" : { "type" : "integer", "description" : "月账单账期", "example" : "31" }, "enterprise_id" : { "type" : "string", "description" : "企业ID - 适用于在企业码PC端创建的企业账号", "example" : "2088000194958956" } } }, "AlipayCommerceEcBalancePeriodModifyResponseModel" : { "type" : "object", "properties" : { "result" : { "type" : "boolean", "description" : "修改结果", "example" : "true" } } }, "AlipayCommerceEcConsumeDetailQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PERMISSION_DENIED", "CONSUME_NOT_EXIST", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcConsumeDetailQueryModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户ID", "example" : "2088123456789000" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20205820659822371223" }, "enterprise_id" : { "type" : "string", "description" : "企业ID", "example" : "2088123456789000" }, "pay_no" : { "type" : "string", "description" : "支付宝账单号", "example" : "2020123100152601930000003650" }, "query_options" : { "type" : "array", "description" : "查询选项", "items" : { "type" : "string" }, "example" : "[\"Refund\"]" } } }, "AlipayCommerceEcConsumeDetailQueryResponseModel" : { "type" : "object", "properties" : { "consume_info" : { "$ref" : "#/components/schemas/EcConsumeInfo" }, "related_order_info" : { "$ref" : "#/components/schemas/EcOrderInfo" }, "related_refund_list" : { "type" : "array", "description" : "关联账单列表", "items" : { "$ref" : "#/components/schemas/EcConsumeInfo" } }, "related_voucher_list" : { "type" : "array", "description" : "关联凭证详情列表", "items" : { "$ref" : "#/components/schemas/EcVoucherInfo" } } } }, "AlipayCommerceEcDepartmentCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PARAMETER_ERROR", "NO_AGREEMENT", "ENTERPRISE_NOT_EXIST", "DEPARTMENT_CODE_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcDepartmentCreateModel" : { "type" : "object", "properties" : { "department_code" : { "type" : "string", "description" : "部门编码，不同部门的编码不可重复，如果为空则生成默认部门编码", "example" : "D00001" }, "department_name" : { "type" : "string", "description" : "部门名称", "example" : "财务部" }, "enterprise_id" : { "type" : "string", "description" : "企业id", "example" : "2088501412314698" }, "parent_department_id" : { "type" : "string", "description" : "上级部门id，如果为空则默认设置上级部门为根部门", "example" : "1001169000136660" } } }, "AlipayCommerceEcDepartmentCreateResponseModel" : { "type" : "object", "properties" : { "department_id" : { "type" : "string", "description" : "新创建的部门id", "example" : "1001169000136660" } } }, "AlipayCommerceEcDepartmentDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PARAMETER_ERROR", "NO_AGREEMENT", "ENTERPRISE_NOT_EXIST", "ROOT_DEPARTMENT_CANNOT_DELETE", "DEPARTMENT_EMPLOYEE_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcDepartmentDeleteModel" : { "type" : "object", "properties" : { "department_id" : { "type" : "string", "description" : "部门id", "example" : "1001169000136660" }, "enterprise_id" : { "type" : "string", "description" : "企业id", "example" : "2088501412314698" } } }, "AlipayCommerceEcDepartmentDeleteResponseModel" : { "type" : "object" }, "AlipayCommerceEcDepartmentInfoModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PARAMETER_ERROR", "NO_AGREEMENT", "ENTERPRISE_NOT_EXIST", "DEPARTMENT_NOT_EXIST", "PARENT_DEPARTMENT_NOT_EXIST", "DEPARTMENT_DEPTH_EXCEED_MAX", "PARENT_DEPARTMENT_CANNOT_BE_ITSELF", "DEPARTMENT_NAME_EXIST", "DEPARTMENT_CODE_EXIST", "DEPARTMENT_MODIFY_FAIL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcDepartmentInfoModifyModel" : { "type" : "object", "properties" : { "department_code" : { "type" : "string", "description" : "部门编码，不同部门的编码不能相同，为空则代表不修改", "example" : "D00001" }, "department_id" : { "type" : "string", "description" : "待修改部门的部门id", "example" : "1001169000136660" }, "department_name" : { "type" : "string", "description" : "部门名称，为空则代表不修改", "example" : "财务部" }, "enterprise_id" : { "type" : "string", "description" : "企业id", "example" : "2088501412314698" }, "parent_department_id" : { "type" : "string", "description" : "上级部门id，为空则代表不修改", "example" : "1001169000136660" } } }, "AlipayCommerceEcDepartmentInfoModifyResponseModel" : { "type" : "object" }, "AlipayCommerceEcDepartmentInfoQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "NO_AGREEMENT", "DEPT_NOT_EXIST", "ENTERPRISE_NOT_EXIST", "PARAM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcDepartmentInfoQueryResponseModel" : { "type" : "object", "properties" : { "department_info" : { "$ref" : "#/components/schemas/DepartmentInfoDTO" } } }, "AlipayCommerceEcDepartmentSublistQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "NO_AGREEMENT", "DEPT_NOT_EXIST", "ENTERPRISE_STATUS_ERROR", "ENTERPRISE_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcDepartmentSublistQueryResponseModel" : { "type" : "object", "properties" : { "department_id_list" : { "type" : "array", "description" : "部门id列表", "items" : { "type" : "string" }, "example" : "[\"1001094000052875\",\"1001094000052876\"]" } } }, "AlipayCommerceEcEmployeeAddErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMETER_ERROR", "SYSTEM_ERROR", "ENTERPRISE_NOT_EXIST", "USER_NOT_EXIST", "USER_UNREAL_NAME", "INVITE_MEMBER_FAIL", "ENTERPRISE_MEMBER_NUM_EXCEED_MAX", "JOINED_ACCOUNT_NUM_EXCEED_MAX", "NO_AGREEMENT", "EMPLOYEE_HAS_ACTIVATED", "ENTERPRISE_NOT_SIGNED", "EMPLOYEE_NO_EXIST", "EMPLOYEE_ALIPAY_OCCUPIED", "EMPLOYEE_MOBILE_EXIST", "EMPLOYEE_FREQUENCY_OVER_LIMIT", "EMPLOYEE_IS_SUPER_ADMIN", "EMPLOYEE_OVER_LIMIT", "NODE_NOT_EXIST", "NEED_TO_SET_PPW" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcEmployeeAddModel" : { "type" : "object", "properties" : { "department_ids" : { "type" : "array", "description" : "员工所属部门", "items" : { "type" : "string" }, "example" : "[\"1001069000162569\"]" }, "employee_cert_no" : { "type" : "string", "description" : "证件号码，根据employee_cert_type指定的证件类型，传入对应的证件号码，用于企业人脸库员工刷脸开通时的核验。", "example" : "260104197909275964" }, "employee_cert_type" : { "type" : "string", "description" : "证件类型，用于企业人脸库员工刷脸开通时的核验，\t枚举支持：IDENTITY_CARD身份证，PASS_PORT护照，STU_NUM学生学号，COMPANY_NUM工号，TAIWAN_CARD台胞证，HK_MC_CARD港澳证件", "example" : "IDENTITY_CARD" }, "employee_email" : { "type" : "string", "description" : "员工邮箱", "example" : "19929@email.com" }, "employee_mobile" : { "type" : "string", "description" : "员工手机号\t1.和identity二选一", "example" : "15757172245" }, "employee_name" : { "type" : "string", "description" : "员工姓名", "example" : "张三" }, "employee_no" : { "type" : "string", "description" : "员工编号", "example" : "D28339" }, "enterprise_id" : { "type" : "string", "description" : "企业id", "example" : "20887448493929" }, "identity" : { "type" : "string", "description" : "身份\t1.和employee_mobile二选一\t2.对应身份类型进行传参，企业支付宝登录账号(支持手机号或者邮箱)或企业支付宝会员id(对应2088开头的支付宝会员id)", "example" : "20889939994000" }, "identity_open_id" : { "type" : "string", "description" : "当identity_type为ALIPAY_USER_ID时，此字段传入open_id", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "identity_type" : { "type" : "string", "description" : "身份类型\tALIPAY_LOGON_ID(企业支付宝登录账号)\tALIPAY_USER_ID(企业支付宝会员id)", "example" : "ALIPAY_USER_ID" }, "iot_check_type" : { "type" : "string", "description" : "员工刷脸加入企业人脸库时的核验方式，如果设置为business_facepay_checkall，则employee_name、employee_cert_type、employee_cert_no必传，如果不传则默认不核验。", "example" : "business_facepay_checkall" }, "iot_vid" : { "type" : "string", "description" : "员工在企业人脸库的人脸唯一标识（该字段已作废，不支持自定义传入）", "example" : "2109b5e671aa3ff2eb4851816c65828f" }, "role_list" : { "type" : "array", "description" : "角色列表，目前只支持填一种角色，默认为USER\tUSER：普通员工\tADMIN：管理员", "items" : { "type" : "string" }, "example" : "[\"USER\"]" } } }, "AlipayCommerceEcEmployeeAddResponseModel" : { "type" : "object", "properties" : { "employee_id" : { "type" : "string", "description" : "员工id", "example" : "2288033000090876" }, "sign_url" : { "type" : "string", "description" : "资金代付签约链接 1.员工未绑支付宝，拉起员工绑定页面 2.员工已绑支付宝，拉起资金签约页面", "example" : "https://ur.alipay.com/3I2tPbLkAiktIoqe2dseZUzT" } } }, "AlipayCommerceEcEmployeeDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMETER_ERROR", "SYSTEM_ERROR", "NO_AGREEMENT", "ENTERPRISE_NOT_EXIST", "EMPLOYEE_NOT_EXIST", "MSG_SEND_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcEmployeeDeleteModel" : { "type" : "object", "properties" : { "employee_id" : { "type" : "string", "description" : "员工id", "example" : "2288839494040404" }, "enterprise_id" : { "type" : "string", "description" : "企业id", "example" : "2088993848994994" } } }, "AlipayCommerceEcEmployeeDeleteResponseModel" : { "type" : "object" }, "AlipayCommerceEcEmployeeIdlistQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "NO_AGREEMENT", "DEPT_NOT_EXIST", "ENTERPRISE_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcEmployeeIdlistQueryResponseModel" : { "type" : "object", "properties" : { "current_page" : { "type" : "integer", "description" : "当前页数", "example" : "1" }, "employee_id_list" : { "type" : "array", "description" : "员工id列表", "items" : { "type" : "string" }, "example" : "[\"228420000000057942506\",\"228420000000057942507\"]" }, "total_num" : { "type" : "integer", "description" : "员工总数", "example" : "566" }, "total_pages" : { "type" : "integer", "description" : "总页数", "example" : "1" } } }, "AlipayCommerceEcEmployeeInfoModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMETER_ERROR", "SYSTEM_ERROR", "ENTERPRISE_NOT_EXIST", "EMPLOYEE_NOT_EXIST", "DEPT_NOT_EXIST", "OPEN_EMPLOYEE_ROLE_MODIFY_FAIL", "NO_AGREEMENT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcEmployeeInfoModifyModel" : { "type" : "object", "properties" : { "department_ids" : { "type" : "array", "description" : "员工所属部门", "items" : { "type" : "string" }, "example" : "[\"1023993000\"]" }, "employee_email" : { "type" : "string", "description" : "员工邮箱", "example" : "aajka@email.com" }, "employee_id" : { "type" : "string", "description" : "员工id", "example" : "22887387848484" }, "employee_name" : { "type" : "string", "description" : "员工姓名", "example" : "张三" }, "employee_no" : { "type" : "string", "description" : "员工工号", "example" : "D83030" }, "enterprise_id" : { "type" : "string", "description" : "企业id", "example" : "2088474883838" }, "role_list" : { "type" : "array", "description" : "角色列表，目前只支持填一种角色\tUSER 普通员工\tADMIN 管理员", "items" : { "type" : "string" }, "example" : "[\"USER\"]" } } }, "AlipayCommerceEcEmployeeInfoModifyResponseModel" : { "type" : "object", "properties" : { "employee_id" : { "type" : "string", "description" : "员工id", "example" : "2288738383939" } } }, "AlipayCommerceEcEmployeeInfoQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "NO_AGREEMENT", "EMPLOYEE_NOT_EXIST", "ENTERPRISE_NOT_EXIST", "PARAM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcEmployeeInfoQueryResponseModel" : { "type" : "object", "properties" : { "employee_info" : { "$ref" : "#/components/schemas/EmployeeInfoDTO" } } }, "AlipayCommerceEcEmployeeInviteQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMETER_ERROR", "ENTERPRISE_NOT_EXIST", "NO_AGREEMENT", "SYSTEM_ERROR", "GET_UNSIGN_URL_ERROR", "ENTERPRISE_NOT_SIGNED", "EMPLOYEE_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcEmployeeInviteQueryResponseModel" : { "type" : "object", "properties" : { "enterprise_id" : { "type" : "string", "description" : "企业id", "example" : "208847489339" }, "mini_app_sign_url" : { "type" : "string", "description" : "支付宝服务商小程序跳入企业码小程序签约链接", "example" : "pages/open/authorize/individual-auth/index?token=xxxxea2ac30656af68522fa596335a3642364d9994270ba&scene=PCC_STANDARD" }, "sign_url" : { "type" : "string", "description" : "邀请链接", "example" : "http://sjddkk.com" } } }, "AlipayCommerceEcEmployeeTitleCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "OVER_MAXIMUM_CAPACITY", "ECEIF_ENTERPRISE_NOT_EXIST", "ENTERPRISE_ID_IS_BLANK", "TITLE_ENTERPRISE_NOT_MATCH", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcEmployeeTitleCreateModel" : { "type" : "object", "properties" : { "employee_title_list" : { "type" : "array", "description" : "员工与抬头关系列表", "items" : { "$ref" : "#/components/schemas/EmployeeTitleDTO" } } } }, "AlipayCommerceEcEmployeeTitleCreateResponseModel" : { "type" : "object" }, "AlipayCommerceEcEmployeeTitleDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "OVER_MAXIMUM_CAPACITY", "ENTERPRISE_NOT_EXIST", "TITLE_ENTERPRISE_NOT_MATCH", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcEmployeeTitleDeleteModel" : { "type" : "object", "properties" : { "employee_title_list" : { "type" : "array", "description" : "员工抬头列表", "items" : { "$ref" : "#/components/schemas/EmployeeTitleDTO" } } } }, "AlipayCommerceEcEmployeeTitleDeleteResponseModel" : { "type" : "object" }, "AlipayCommerceEcEmployeeTitleModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "TITLE_ENTERPRISE_NOT_MATCH", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcEmployeeTitleModifyModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账号id，与enterprise_id两者必填其一", "example" : "2088000397722031" }, "create_by" : { "type" : "string", "description" : "创建人", "example" : "昭运" }, "employee_id" : { "type" : "string", "description" : "企业域定义的员工id，与user_id两者必填其一", "example" : "228800000000002000002" }, "enterprise_id" : { "type" : "string", "description" : "企业域定义下的企业id，与accountId两者必填其一", "example" : "2088000230921202" }, "modify_by" : { "type" : "string", "description" : "修改人", "example" : "昭运" }, "new_title_id" : { "type" : "string", "description" : "修改后的抬头id", "example" : "2022060900801711450000073478" }, "old_title_id" : { "type" : "string", "description" : "修改前的抬头id", "example" : "2022060900801711450000073478" }, "open_id" : { "type" : "string", "description" : "支付宝open_id，与employee_id两者必填其一", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "title_tag" : { "type" : "string", "description" : "员工抬头关系标", "example" : "au" }, "user_id" : { "type" : "string", "description" : "支付宝id2088，与employee_id两者必填其一", "example" : "2088502255168118" } } }, "AlipayCommerceEcEmployeeTitleModifyResponseModel" : { "type" : "object" }, "AlipayCommerceEcEnterpriseAddressAddErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMETER_ERROR", "SYSTEM_ERROR", "ENTERPRISE_NOT_EXIST", "SENSITIVE_WORDS_EXIST", "NO_AGREEMENT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcEnterpriseAddressAddModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户id和enterprise_id二选一", "example" : "208893930030" }, "address" : { "type" : "string", "description" : "详细地址最长50个字符", "example" : "西溪路569号蚂蚁A空间6楼601" }, "agreement_no" : { "type" : "string", "description" : "协议号，如果填共同账户id，则该字段必填", "example" : "182932939903" }, "city_code" : { "type" : "string", "description" : "市(国家统一行政规划编码)", "example" : "330100" }, "city_name" : { "type" : "string", "description" : "市", "example" : "杭州市" }, "community" : { "type" : "string", "description" : "小区/楼宇", "example" : "蚂蚁A空间" }, "enterprise_id" : { "type" : "string", "description" : "企业id和account_id二选一", "example" : "208898734567" }, "latitude" : { "type" : "string", "description" : "维度", "example" : "30.261121" }, "longitude" : { "type" : "string", "description" : "经度", "example" : "120.104735" }, "mark" : { "type" : "string", "description" : "备注最长50个字符", "example" : "备注" }, "poi_id" : { "type" : "string", "description" : "高德地图poi", "example" : "B0GKN4522Z" } } }, "AlipayCommerceEcEnterpriseAddressAddResponseModel" : { "type" : "object", "properties" : { "address_id" : { "type" : "string", "description" : "地址id", "example" : "19200289393" } } }, "AlipayCommerceEcEnterpriseAddressModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMETER_ERROR", "SYSTEM_ERROR", "ENTERPRISE_NOT_EXIST", "SENSITIVE_WORDS_EXIST", "NO_AGREEMENT", "ADDRESS_NOT_EXIST", "ADDRESS_HAS_USED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcEnterpriseAddressModifyModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户id和enterprise_id二选一", "example" : "20884949030030" }, "address" : { "type" : "string", "description" : "详细地址最长50个字符", "example" : "西溪路569号蚂蚁A空间6楼601" }, "address_id" : { "type" : "string", "description" : "地址id", "example" : "19393030303" }, "agreement_no" : { "type" : "string", "description" : "协议号，如果填共同账户id，则该字段必填", "example" : "182930033030" }, "city_code" : { "type" : "string", "description" : "市(国家统一行政规划编码)", "example" : "330100" }, "city_name" : { "type" : "string", "description" : "城市名称", "example" : "杭州市" }, "community" : { "type" : "string", "description" : "小区/楼宇", "example" : "蚂蚁A空间" }, "enterprise_id" : { "type" : "string", "description" : "企业id和account_id二选一", "example" : "208839393939" }, "latitude" : { "type" : "string", "description" : "纬度", "example" : "30.261121" }, "longitude" : { "type" : "string", "description" : "经度", "example" : "120.104735" }, "mark" : { "type" : "string", "description" : "备注", "example" : "备注" }, "poi_id" : { "type" : "string", "description" : "高德地图poi", "example" : "B0GKN4522Z" }, "status" : { "type" : "string", "description" : "状态(生效/失效)\tNORMAL\tINVALID", "example" : "NORMAL" } } }, "AlipayCommerceEcEnterpriseAddressModifyResponseModel" : { "type" : "object", "properties" : { "address_id" : { "type" : "string", "description" : "地址id", "example" : "19300392390" } } }, "AlipayCommerceEcEnterpriseAddressQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMETER_ERROR", "SYSTEM_ERROR", "NO_AGREEMENT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcEnterpriseAddressQueryResponseModel" : { "type" : "object", "properties" : { "current_page" : { "type" : "integer", "description" : "页码", "example" : "1" }, "enterprise_address_info_list" : { "type" : "array", "description" : "地址列表", "items" : { "$ref" : "#/components/schemas/AddressInfoDTO" } }, "total_num" : { "type" : "integer", "description" : "总数量", "example" : "10" }, "total_pages" : { "type" : "integer", "description" : "总页数", "example" : "2" } } }, "AlipayCommerceEcEnterpriseAgreementQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "ENTERPRISE_NOT_EXIST", "PERMISSION_DENIED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcEnterpriseAgreementQueryResponseModel" : { "type" : "object", "properties" : { "enterprise_agreement_dto" : { "$ref" : "#/components/schemas/EnterpriseAgreementDTO" } } }, "AlipayCommerceEcEnterpriseCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMETER_ERROR", "SYSTEM_ERROR", "ENTERPRISE_NO_AUTH", "ENTERPRISE_SETTLED_IN_FINISHED", "USER_NOT_EXIST", "GET_SIGN_URL_ERROR", "MSG_SEND_ERROR", "SENSITIVE_WORDS_EXIST", "ENTERPRISE_CREATE_NOT_SUPPORT", "ENTERPRISE_CREATE_ING", "ECEIF_ENTERPRISE_CREATE_OVER_LIMIT", "ECEIF_ENTERPRISE_CREATE_FAIL", "IOT_FACE_GROUP_NAME_ERROR", "IOT_FACE_GROUP_CREATE_FAIL", "IOT_USER_CREATE_ERROR", "IOT_GROUP_ID_QUERY_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcEnterpriseCreateModel" : { "type" : "object", "properties" : { "biz_scene" : { "type" : "string", "description" : "场景码，联系支付宝分配", "example" : "ISV_QYM" }, "create_iot_group" : { "type" : "boolean", "description" : "是否创建企业人脸库，适用于对接团餐刷脸付、门禁刷脸通行等场景；不传默认创建，创建失败不会阻塞企业的创建；如果传true且创建失败，则会阻塞企业的创建。", "example" : "false" }, "enterprise_alias" : { "type" : "string", "description" : "企业简称", "example" : "企业码测试" }, "enterprise_name" : { "type" : "string", "description" : "企业名称", "example" : "企业码测试有限公司" }, "identity" : { "type" : "string", "description" : "身份，对应身份类型进行传参，例如：\t企业支付宝登录账号(支持手机号或者邮箱)或企业支付宝会员id(对应2088开头的支付宝会员id)", "example" : "2088501412314698" }, "identity_open_id" : { "type" : "string", "description" : "当identity_type为ALIPAY_USER_ID时，此字段传入open_id", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "identity_type" : { "type" : "string", "description" : "身份类型,目前支持传参如下：\tALIPAY_LOGON_ID(企业支付宝登录账号)\tALIPAY_USER_ID(企业支付宝会员id)", "example" : "ALIPAY_USER_ID" }, "out_biz_no" : { "type" : "string", "description" : "外部业务号\t1.作为创建该企业的唯一幂等标识，不传默认使用identity幂等\t2.传入out_biz_no创建返回结果成功后，如需再新建其他企业，则out_biz_no传不同的参数，否则会被幂等\t3.如果调用失败或者超时，可以使用相同的outBizNo进行重试处理\t4.并发使用相同outBizNo调用，会返回企业创建中，不要重复操作的错误信息", "example" : "28839390030030" } } }, "AlipayCommerceEcEnterpriseCreateResponseModel" : { "type" : "object", "properties" : { "enterprise_id" : { "type" : "string", "description" : "企业id", "example" : "2088501412314698" }, "iot_group_id" : { "type" : "string", "description" : "封闭场景（如班车）的人脸库id，如果入参create_iot_group传false，则不会创建企业人脸库，该字段为空。", "example" : "BUSINESS_898263530536960" }, "iot_logic_group_id" : { "type" : "string", "description" : "开放场景（如团餐）的人脸库id，如果入参create_iot_group传false，则不会创建企业人脸库，该字段为空。", "example" : "BUSINESS_898263530536960" }, "sign_url" : { "type" : "string", "description" : "资金代付签约链接", "example" : "http://business-site-default.dev.alipay.net/page/EnterprisePay/Account?signToken=12324" } } }, "AlipayCommerceEcEnterpriseDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMETER_ERROR", "SYSTEM_ERROR", "ENTERPRISE_NOT_EXIST", "ENTERPRISE_HAS_DELETE", "NO_AGREEMENT", "ACCOUNT_NORMAL_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcEnterpriseDeleteModel" : { "type" : "object", "properties" : { "enterprise_id" : { "type" : "string", "description" : "企业id", "example" : "208839030030" } } }, "AlipayCommerceEcEnterpriseDeleteResponseModel" : { "type" : "object", "properties" : { "enterprise_id" : { "type" : "string", "description" : "企业ID", "example" : "2088738399393" } } }, "AlipayCommerceEcEnterpriseInfoModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PARAMETER_ERROR", "NO_AGREEMENT", "ENTERPRISE_NOT_EXIST", "ONLY_NOAUTH_CAN_MODIFY_NAME" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcEnterpriseInfoModifyModel" : { "type" : "object", "properties" : { "enterprise_alias" : { "type" : "string", "description" : "企业简称", "example" : "企业码测试" }, "enterprise_id" : { "type" : "string", "description" : "企业id", "example" : "2088501412314698" }, "enterprise_name" : { "type" : "string", "description" : "企业名称", "example" : "企业码测试有限公司" } } }, "AlipayCommerceEcEnterpriseInfoModifyResponseModel" : { "type" : "object" }, "AlipayCommerceEcEnterpriseInfoQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMETER_ERROR", "SYSTEM_ERROR", "ENTERPRISE_NOT_EXIST", "NO_AGREEMENT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcEnterpriseInfoQueryResponseModel" : { "type" : "object", "properties" : { "enterprise_info" : { "$ref" : "#/components/schemas/EnterpriseInfoDTO" } } }, "AlipayCommerceEcEnterpriseUnsignErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMETER_ERROR", "SYSTEM_ERROR", "NO_AGREEMENT", "GET_UNSIGN_URL_ERROR", "ENTERPRISE_NOT_EXIST", "ENTERPRISE_HAS_UNSIGN" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcEnterpriseUnsignResponseModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "入参传的共同账户id，出参也会返回共同账户id", "example" : "2088390300034" }, "enterprise_id" : { "type" : "string", "description" : "企业id", "example" : "208893993930" }, "unsign_url" : { "type" : "string", "description" : "解约链接", "example" : "http://business-site-default.dev.alipay.net/page/EnterprisePay/Account?signToken=12324" } } }, "AlipayCommerceEcJointaccountbillDetailBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PERMISSION_DENIED", "INVALID_PARAMETER", "EMPLOYEE_INFO_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcJointaccountbillDetailBatchqueryResponseModel" : { "type" : "object", "properties" : { "bill_list" : { "type" : "array", "description" : "返回账单列表", "items" : { "$ref" : "#/components/schemas/JointAccountBillDetail" } }, "biz_scene" : { "type" : "string", "description" : "业务场景", "example" : "ISV_DEFAULT" }, "enterprise_id" : { "type" : "string", "description" : "企业ID，和接口入参一致", "example" : "2088123456789000" }, "has_next_page" : { "type" : "boolean", "description" : "是否有下一页", "example" : "true" }, "page_num" : { "type" : "string", "description" : "当期页数", "example" : "1" }, "page_size" : { "type" : "string", "description" : "当期页记录数", "example" : "20" } } }, "AlipayCommerceEcUserEnterpriseQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMETER_ERROR", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEcUserEnterpriseQueryResponseModel" : { "type" : "object", "properties" : { "enterprise_info_list" : { "type" : "array", "description" : "用户所属企业列表", "items" : { "$ref" : "#/components/schemas/EnterpriseInfoDTO" } } } }, "AlipayCommerceEducateCampusInstitutionsAddErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ISV_DECLARE_UPDATE_UNAUTHORIZED", "ISV_SCHOOL_MAINTAINING", "ILLEGAL_PARAM", "SCHOOL_NAME_ILLEGAL", "INVALID_PARAMETER_PROVINCE_CODE", "INVALID_PARAMETER_CITY_CODE", "INVALID_PARAMETER_SCHOOL_STD_CODE", "LEARNING_STAGE_ERROR", "INVALID_PARAMETER_SCHOOL_PROPERTY", "SYSTEM_ERROR", "SCHOOL_EXIST", "INVALID_PARAMETER", "SCHOOL_NOT_SUBJECT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEducateCampusInstitutionsAddModel" : { "type" : "object", "properties" : { "card_pict_url" : { "type" : "string", "description" : "事业单位法人证书或办学许可证的图片。入驻学校时，如果流入人工审核，会根据此图片进行辅助验证。", "example" : "A*HZ9NTamTmx4AAAAAAAAAAAAAAQAAAQ" }, "city_code" : { "type" : "string", "description" : "市", "example" : "370800" }, "inst_name" : { "type" : "string", "description" : "入驻的学校名称，必须是完整的学校全称", "example" : "复旦大学" }, "inst_std_code" : { "type" : "string", "description" : "学校外标，使用统一社会信用编码", "example" : "3451000031" }, "learning_stage" : { "type" : "string", "description" : "办学阶段。\t枚举值如下：\tKINDERGARTEN（幼儿园）\tPRIMARY_SCHOOL（小学） \tMIDDLE_SCHOOL（初中） \tHIGH_SCHOOL（高中）\tSECONDARY_VOCATIONAL_SCHOOL（中职中专） \t注意：如果学校兼有多种属性，可以连写用英文逗号拆分，如：MIDDLE_SCHOOL,HIGH_SCHOOL 代表兼有初中部和高中部；", "example" : "MIDDLE_SCHOOL,HIGH_SCHOOL" }, "province_code" : { "type" : "string", "description" : "省份", "example" : "370000" }, "school_property" : { "type" : "string", "description" : "学校性质.枚举值如下：\t 1：公立 \t2：民办", "example" : "1" } } }, "AlipayCommerceEducateCampusInstitutionsAddResponseModel" : { "type" : "object", "properties" : { "inst_id" : { "type" : "string", "description" : "学校内标。如果入驻成功，返回学校内标；入驻失败则不返回学校内标。", "example" : "2088000305455592" }, "inst_std_code" : { "type" : "string", "description" : "学校外标。如果入驻成功，返回学校外标；入驻失败则不返回学校外标。", "example" : "3451000031" }, "reason" : { "type" : "string", "description" : "入驻失败原因", "example" : "学校已存在或检测到类似学校，请联系支付宝业务人员处理" } } }, "AlipayCommerceEducateCampusInstitutionsQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "QUERY_TOO_FREQUENCY", "ILLEGAL_PARAM", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEducateCampusInstitutionsQueryResponseModel" : { "type" : "object", "properties" : { "school_info" : { "$ref" : "#/components/schemas/SchoolSimpleInfo" }, "school_info_list" : { "type" : "array", "description" : "学校基础信息列表", "items" : { "$ref" : "#/components/schemas/SchoolBaseInfo" } } } }, "AlipayCommerceEducateSchoolcardOrderSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "ILLEGAL_PARAM", "SCHOOL_NOT_EXIST", "CHECK_SCHOOL_SIGN_FAIL", "TRADE_SYNC_TEMPLATE_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceEducateSchoolcardOrderSyncModel" : { "type" : "object", "properties" : { "actual_amount" : { "type" : "string", "description" : "实际金额（总支付金额）", "example" : "0.60" }, "applet_app_id" : { "type" : "string", "description" : "小程序appid", "example" : "2022xxxx" }, "card_balance" : { "type" : "string", "description" : "校园卡余额", "example" : "20.32" }, "card_no" : { "type" : "string", "description" : "卡号", "example" : "2022xxxx" }, "card_type" : { "type" : "string", "description" : "卡类型", "example" : "学生：1；教职工：2" }, "create_time" : { "type" : "string", "description" : "该笔订单真实的创建时间，需精确到毫秒。时间格式为 yyyy-MM-dd HH:mm:ss.SSS。同一笔订单保持不变", "example" : "2022-09-16 10:12:12.910" }, "discount_amount" : { "type" : "string", "description" : "优惠金额", "example" : "0.70" }, "goods_orders" : { "$ref" : "#/components/schemas/GoodsOrder" }, "merchant_name" : { "type" : "string", "description" : "商家名称，不传默认展示学校名称", "example" : "温州医科大食堂" }, "modified_time" : { "type" : "string", "description" : "订单修改时间，时间格式为 yyyy-MM-dd HH:mm:ss.SSS。用于订单状态或数据变化较快的顺序控制，防止乱序。order_modified_time较晚的同步会被最终存储，order_modified_time相同的两次同步会被幂等处理。", "example" : "2022-09-16 10:12:12.910" }, "open_id" : { "type" : "string", "description" : "蚂蚁统一会员ID", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "order_amount" : { "type" : "string", "description" : "订单金额", "example" : "1.30" }, "order_detail_url" : { "type" : "string", "description" : "订单详情链接", "example" : "传完整链接page=后面需做encode\talipays://platformapi/startapp?appId=2021002126602599&page=%2fpages%2forder-details%2forder-details%3fticketOrderId%3d20210376854" }, "order_status" : { "type" : "string", "description" : "订单状态\t消费成功 CONSUME_S ；已退款：REFUNDED；\t开卡成功 CARD_ACTIVED；消费失败：UN_CHARGE\t充值成功 RECHARGE_S", "example" : "CONSUME_S 消费成功" }, "out_biz_no" : { "type" : "string", "description" : "外部业务号", "example" : "2022xxxx" }, "pay_address" : { "type" : "string", "description" : "支付地点", "example" : "1餐厅-3楼1号机" }, "pay_mode" : { "type" : "string", "description" : "付款方式，不传默认展示学校名称+校园卡+（卡号后四位）", "example" : "电子校园卡(卡号后四位)" }, "rake_back_pid" : { "type" : "string", "description" : "返佣pid", "example" : "2088xxxx" }, "school_id" : { "type" : "string", "description" : "学校内标", "example" : "2088xxxxx" }, "school_pid" : { "type" : "string", "description" : "学校pid", "example" : "2088xxx" }, "service_provider_name" : { "type" : "string", "description" : "服务提供者名称", "example" : "完美校园" }, "type" : { "type" : "string", "description" : "业务类型", "example" : "SCHOOL_PAY 校园团餐" }, "user_id" : { "type" : "string", "description" : "蚂蚁统一会员ID", "example" : "2088xxxx" } } }, "AlipayCommerceEducateSchoolcardOrderSyncResponseModel" : { "type" : "object", "properties" : { "order_id" : { "type" : "string", "description" : "订单号", "example" : "2022xxxx" } } }, "AlipayCommerceIotDeviceReportUploadErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "DEVICE_REPORT_UPLOAD_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceIotDeviceReportUploadModel" : { "type" : "object", "properties" : { "report_content" : { "type" : "string", "description" : "设备检测报告详情", "example" : "设备检测报告详情JSON字符串" }, "sn" : { "type" : "string", "description" : "设备唯一标识", "example" : "SMIT1D2020108003872" } } }, "AlipayCommerceIotDeviceReportUploadResponseModel" : { "type" : "object", "properties" : { "status" : { "type" : "boolean", "description" : "是否上传成功", "example" : "true" } } }, "AlipayCommerceIotSdarttoolMessageQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PARAM_INVALID", "NOT_FOUND_DATA" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceIotSdarttoolMessageQueryResponseModel" : { "type" : "object", "properties" : { "consume_err_code" : { "type" : "string", "description" : "消息消费返回码，不用的消息类型返回码不一样", "example" : "PRINT_FAIL" }, "consume_err_msg" : { "type" : "string", "description" : "消息消费错误原因", "example" : "消息消费错误原因" }, "consume_state" : { "type" : "integer", "description" : "消息消费状态1-未消费; 2-消费成功；3-消费失败", "example" : "1" }, "deliver_cnt" : { "type" : "integer", "description" : "消息投递次数", "example" : "1" }, "deliver_status" : { "type" : "string", "description" : "消息投递状态\t1: 未投递 2: 投递中 3: 投递成功 4: 投递失败 5: 消息失效不再发送", "example" : "1" }, "last_deliver_at" : { "type" : "integer", "description" : "消息最后一次发送时间", "example" : "1574752505481" }, "msg_ack_time" : { "type" : "integer", "description" : "消息确认消费时间(ms)", "example" : "1574752506609" }, "msg_bida" : { "type" : "integer", "description" : "消息必达类型 1-非必达; 2-必达.", "example" : "1" }, "msg_expire_time" : { "type" : "integer", "description" : "消息过期时间(ms)", "example" : "1575011705405" }, "msg_gmt_create" : { "type" : "integer", "description" : "消息创建时间(ms)", "example" : "1575028811454" }, "msg_priority" : { "type" : "integer", "description" : "消息投递优先级", "example" : "0" } } }, "AlipayCommerceIotSdarttoolMessageSendErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAM_INVALID", "BIZ_ERROR", "SYSTEM_ERROR", "DEVICE_AUTH_FAIL", "PRINT_CONTEN_OVER_LENGTH", "NOT_FOUND_DEVICE", "DEVICE_NOT_ONLINE", "NO_SUB_INFO", "LOW_SYSTEM_VERSION", "MSG_TYPE_INVALID" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceIotSdarttoolMessageSendModel" : { "type" : "object", "properties" : { "bi_da" : { "type" : "boolean", "description" : "消息是否必达(immediate_msg为false时此字段设置有效)，消息过期时间顺延3*24h. 建议使用expire_time设置消息过期时间", "example" : "false" }, "device_query_type" : { "type" : "string", "description" : "设备查询条件类型 ；SUPPLIERID_SN:supplierid+sn ;\t ITEMID_SN:itemid + sn;\tSN:sn", "example" : "ITEMID_SN" }, "immediate_msg" : { "type" : "boolean", "description" : "是否即时消息; true-校验设备是否在线，false-不校验设备是否在线", "example" : "true" }, "item_id" : { "type" : "string", "description" : "产品ID", "example" : "2019111304877238" }, "msg_content" : { "type" : "string", "description" : "消息内容", "example" : "{\"contentParams\":[\"消息内容\"]}" }, "msg_content_type" : { "type" : "string", "description" : "消息内容格式", "example" : "text" }, "msg_expire" : { "type" : "integer", "description" : "消息过期时间戳(ms)， 默认为当前时间顺延24h有效。当设备在线时消息服务过期之前尝试推送。最大过期时间顺延3*24h", "example" : "1573107942000" }, "msg_priority" : { "type" : "integer", "description" : "消息优先级（immediate_msg为false此字段设置有效）数字越大优先发送。", "example" : "0" }, "msg_type" : { "type" : "string", "description" : "消息类型：\txpaas_common-小程序消息；\truyi_ordermsg-如意订单消息", "example" : "xpaas_common" }, "service_id" : { "type" : "string", "description" : "服务ID，当小程序消费消息时必传(传入的是小程序ID)", "example" : "201808903221" }, "sn" : { "type" : "string", "description" : "设备sn号", "example" : "10000000001" }, "supplier_id" : { "type" : "string", "description" : "厂商ID", "example" : "20000000001" } } }, "AlipayCommerceIotSdarttoolMessageSendResponseModel" : { "type" : "object", "properties" : { "message_no" : { "type" : "string", "description" : "消息ID", "example" : "201911010000001" } } }, "AlipayCommerceLogisticsInvoiceIstdwaybillCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAM_ILLEGAL", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceLogisticsInvoiceIstdwaybillCreateModel" : { "type" : "object", "properties" : { "invoice" : { "$ref" : "#/components/schemas/Invoice" }, "logistics_code" : { "type" : "string", "description" : "即时配送公司编码", "example" : "FENGNIAO" }, "out_invoice_request_no" : { "type" : "string", "description" : "开票请求流水号", "example" : "out_invoice_no_00001" }, "waybill_invoices" : { "type" : "array", "description" : "即时配送运单列表", "items" : { "$ref" : "#/components/schemas/WaybillInvoice" } } } }, "AlipayCommerceLogisticsInvoiceIstdwaybillCreateResponseModel" : { "type" : "object", "properties" : { "invoice_fee" : { "type" : "string", "description" : "开票金额", "example" : "100.00" }, "status" : { "type" : "integer", "description" : "整体的运单开票状态，0：处理中 1：开票成功 2：开票失败", "example" : "0" }, "waybill_invoices" : { "type" : "array", "description" : "即时配送运单列表", "items" : { "$ref" : "#/components/schemas/WaybillInvoiceIstd" } } } }, "AlipayCommerceLogisticsInvoiceIstdwaybillQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAM_ILLEGAL", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceLogisticsInvoiceIstdwaybillQueryResponseModel" : { "type" : "object", "properties" : { "status" : { "type" : "integer", "description" : "整体的运单开票状态，0：处理中 1：开票成功 2：开票失败", "example" : "0" }, "waybill_invoices" : { "type" : "array", "description" : "即时配送运单列表", "items" : { "$ref" : "#/components/schemas/WaybillInvoiceQueryIstd" } } } }, "AlipayCommerceLogisticsLogisticscompanyInstantdeliveryQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceLogisticsLogisticscompanyInstantdeliveryQueryResponseModel" : { "type" : "object", "properties" : { "logistics_companies" : { "type" : "array", "description" : "即时配送公司列表", "items" : { "$ref" : "#/components/schemas/LogisticsCompanyResult" } } } }, "AlipayCommerceLogisticsOrderInstantdeliveryCancelErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAM_ILLEGAL", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceLogisticsOrderInstantdeliveryCancelModel" : { "type" : "object", "properties" : { "cancel_reason" : { "type" : "string", "description" : "取消原因，取消原因id为i_6时必填", "example" : "其他原因取消运单" }, "cancel_reason_id" : { "type" : "string", "description" : "取消原因id", "example" : "i_6" }, "logistics_code" : { "type" : "string", "description" : "即时配送公司编码", "example" : "FENGNIAO" }, "order_no" : { "type" : "string", "description" : "支付宝订单流水号", "example" : "2020090411130000000000772400280352" }, "out_order_no" : { "type" : "string", "description" : "商家订单号，与order_no不能同时为空", "example" : "2020090411140000000000777000216122" }, "waybill_no" : { "type" : "string", "description" : "即时配送运单编号", "example" : "waybillno001" } } }, "AlipayCommerceLogisticsOrderInstantdeliveryCancelResponseModel" : { "type" : "object", "properties" : { "cancel_fee" : { "type" : "string", "description" : "取消金额", "example" : "100.00" } } }, "AlipayCommerceLogisticsOrderInstantdeliveryCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PARAM_ILLEGAL", "LOGISTICS_COMPANY_CONFIG_EXCEPTION", "NOT_REGISTER_LOGISTICS_ACCOUNT_OR_SHOP", "MRCH_DEDUCT_AGREEMENT_NOT_EXIST", "OUT_ORDER_NO_REPEAT", "WAYBILL_NO_REPEAT", "PAY_FAIL", "PAY_UNKNOWN", "THIRD_BIZ_EXCEPTION" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceLogisticsOrderInstantdeliveryCreateModel" : { "type" : "object", "properties" : { "consumer_id" : { "type" : "string", "description" : "消费者id， 如果consumer_source是alipay，则consumer_id必须是支付宝用户uid；如果consumer_source是wx，则consumer_id可以为空", "example" : "2088xxx" }, "consumer_notify" : { "$ref" : "#/components/schemas/ConsumerNotifyIstd" }, "consumer_source" : { "type" : "string", "description" : "消费者来源,支付宝：alipay; 微信：wx", "example" : "alipay" }, "goods_details" : { "type" : "array", "description" : "商品明细", "items" : { "$ref" : "#/components/schemas/GoodsDetailIstd" } }, "goods_info" : { "$ref" : "#/components/schemas/GoodsInfoIstd" }, "logistics_code" : { "type" : "string", "description" : "即时配送公司编码", "example" : "FENGNIAO" }, "logistics_token" : { "type" : "string", "description" : "下即时配送订单token, 配送公司可以返回此字段，当商家下单时候带上这个字段，保证在一段时间内运费不变", "example" : "token001" }, "open_id" : { "type" : "string", "description" : "消费者id， 如果consumer_source是alipay，则consumer_id必须是支付宝用户openId；如果consumer_source是wx，则consumer_id可以为空", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "order_ext_istd" : { "$ref" : "#/components/schemas/OrderExtIstd" }, "out_order_no" : { "type" : "string", "description" : "商家订单号", "example" : "2020090411140000000000777000216122" }, "receiver" : { "$ref" : "#/components/schemas/ReceiverIstd" }, "sender" : { "$ref" : "#/components/schemas/SenderIstd" }, "shop_no" : { "type" : "string", "description" : "商家球房编号", "example" : "shopno001" } } }, "AlipayCommerceLogisticsOrderInstantdeliveryCreateResponseModel" : { "type" : "object", "properties" : { "coupon_fee" : { "type" : "string", "description" : "优惠券费用", "example" : "1.00" }, "deliver_fee" : { "type" : "string", "description" : "运费", "example" : "10.00" }, "dispatch_duration" : { "type" : "integer", "description" : "预计骑手还剩多久接单，单位：秒", "example" : "60" }, "distance" : { "type" : "integer", "description" : "配送距离", "example" : "300" }, "fee" : { "type" : "string", "description" : "实际运费", "example" : "9.00" }, "finish_code" : { "type" : "string", "description" : "收货码，骑手必须输入收货码才能完成订单妥投", "example" : "xxx" }, "insurance_fee" : { "type" : "string", "description" : "保价费用", "example" : "0.00" }, "order_no" : { "type" : "string", "description" : "支付宝订单流水号", "example" : "2020090411130000000000772400280352" }, "pay_amount" : { "type" : "string", "description" : "支付金额, 实际扣减的费用以此字段为准", "example" : "9.00" }, "pickup_code" : { "type" : "string", "description" : "取货码, 骑手必须输入取货码才能从商家取货", "example" : "xxx" }, "status" : { "type" : "string", "description" : "即时配送运单状态", "example" : "i_101" }, "waybill_no" : { "type" : "string", "description" : "即时配送运单编号", "example" : "waybillno001" } } }, "AlipayCommerceLogisticsOrderInstantdeliveryPrecreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PARAM_ILLEGAL", "LOGISTICS_COMPANY_CONFIG_EXCEPTION", "MRCH_ACCOUNT_AVAILABLE_AMOUNT_NOT_ENOUGH", "MRCH_PID_ACCOUNT_NOT_EXIST", "NOT_REGISTER_LOGISTICS_ACCOUNT_OR_SHOP" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceLogisticsOrderInstantdeliveryPrecreateModel" : { "type" : "object", "properties" : { "consumer_id" : { "type" : "string", "description" : "消费者id， 如果consumer_source是alipay，则consumer_id必须是支付宝用户uid；如果consumer_source是wx，则consumer_id可以为空", "example" : "2088xxx" }, "consumer_notify" : { "$ref" : "#/components/schemas/ConsumerNotifyIstd" }, "consumer_source" : { "type" : "string", "description" : "消费者来源, 支付宝：alipay, 微信：wx", "example" : "alipay" }, "goods_details" : { "type" : "array", "description" : "商品明细", "items" : { "$ref" : "#/components/schemas/GoodsDetailIstd" } }, "goods_info" : { "$ref" : "#/components/schemas/GoodsInfoIstd" }, "logistics_companies" : { "type" : "array", "description" : "即时配送公司配置列表", "items" : { "$ref" : "#/components/schemas/LogisticsCompanyIstd" } }, "open_id" : { "type" : "string", "description" : "消费者id， 如果consumer_source是alipay，则consumer_id必须是支付宝的openId；如果consumer_source是wx，则consumer_id可以为空", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "order_ext_istd" : { "$ref" : "#/components/schemas/OrderExtIstdForPreOrder" }, "out_order_no" : { "type" : "string", "description" : "商家订单号", "example" : "2020090411140000000000777000216122" }, "receiver" : { "$ref" : "#/components/schemas/ReceiverIstd" }, "sender" : { "$ref" : "#/components/schemas/SenderIstd" }, "shop_no" : { "type" : "string", "description" : "商家球房编号", "example" : "shopno001" } } }, "AlipayCommerceLogisticsOrderInstantdeliveryPrecreateResponseModel" : { "type" : "object", "properties" : { "waybills" : { "type" : "array", "description" : "即时配送运单列表", "items" : { "$ref" : "#/components/schemas/PreCreateWaybillIstd" } } } }, "AlipayCommerceLogisticsOrderIstdcancelPreconsultErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAM_ILLEGAL", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceLogisticsOrderIstdcancelPreconsultModel" : { "type" : "object", "properties" : { "cancel_reason" : { "type" : "string", "description" : "取消原因，取消原因id为i_6时必填", "example" : "其他原因取消运单" }, "cancel_reason_id" : { "type" : "string", "description" : "取消原因id", "example" : "i_6" }, "logistics_code" : { "type" : "string", "description" : "即时配送公司编码", "example" : "FENGNIAO" }, "order_no" : { "type" : "string", "description" : "支付宝订单流水号", "example" : "2020090411130000000000772400280352" }, "out_order_no" : { "type" : "string", "description" : "商家订单号，与order_no不能同时为空", "example" : "2020090411140000000000777000216122" }, "waybill_no" : { "type" : "string", "description" : "即时配送运单编号", "example" : "waybillno001" } } }, "AlipayCommerceLogisticsOrderIstdcancelPreconsultResponseModel" : { "type" : "object", "properties" : { "allow_cancel" : { "type" : "boolean", "description" : "是否允许取消", "example" : "true" }, "cancel_fee" : { "type" : "string", "description" : "取消金额", "example" : "100.00" } } }, "AlipayCommerceLogisticsOrderIstdretryCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PARAM_ILLEGAL", "LOGISTICS_COMPANY_CONFIG_EXCEPTION", "NOT_REGISTER_LOGISTICS_ACCOUNT_OR_SHOP", "MRCH_DEDUCT_AGREEMENT_NOT_EXIST", "OUT_ORDER_NO_REPEAT", "WAYBILL_NO_REPEAT", "PAY_FAIL", "PAY_UNKNOWN", "THIRD_BIZ_EXCEPTION" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceLogisticsOrderIstdretryCreateModel" : { "type" : "object", "properties" : { "consumer_id" : { "type" : "string", "description" : "消费者id， 如果consumer_source是alipay，则consumer_id必须是支付宝用户uid；如果consumer_source是wx，则consumer_id可以为空", "example" : "2088xxx" }, "consumer_notify" : { "$ref" : "#/components/schemas/ConsumerNotifyIstd" }, "consumer_source" : { "type" : "string", "description" : "消费者来源, 支付宝：alipay, 微信：wx", "example" : "alipay" }, "goods_details" : { "type" : "array", "description" : "商品明细", "items" : { "$ref" : "#/components/schemas/GoodsDetailIstd" } }, "goods_info" : { "$ref" : "#/components/schemas/GoodsInfoIstd" }, "logistics_code" : { "type" : "string", "description" : "即时配送公司编码", "example" : "FENGNIAO" }, "logistics_token" : { "type" : "string", "description" : "下即时配送订单token, 配送公司可以返回此字段，当商家下单时候带上这个字段，保证在一段时间内运费不变", "example" : "token001" }, "open_id" : { "type" : "string", "description" : "消费者id， 如果consumer_source是alipay，则consumer_id必须是支付宝用户openId；如果consumer_source是wx，则consumer_id可以为空", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "order_ext_istd" : { "$ref" : "#/components/schemas/OrderExtIstd" }, "out_order_no" : { "type" : "string", "description" : "商家订单号", "example" : "2020090411140000000000777000216122" }, "receiver" : { "$ref" : "#/components/schemas/ReceiverIstd" }, "sender" : { "$ref" : "#/components/schemas/SenderIstd" }, "shop_no" : { "type" : "string", "description" : "商家球房编号", "example" : "shopno001" } } }, "AlipayCommerceLogisticsOrderIstdretryCreateResponseModel" : { "type" : "object", "properties" : { "coupon_fee" : { "type" : "string", "description" : "优惠券费用", "example" : "1.00" }, "deliver_fee" : { "type" : "string", "description" : "运费", "example" : "10.00" }, "dispatch_duration" : { "type" : "integer", "description" : "预计骑手还剩多久接单，单位：秒", "example" : "60" }, "distance" : { "type" : "integer", "description" : "配送距离(单位：米)", "example" : "300" }, "fee" : { "type" : "string", "description" : "实际运费", "example" : "9.00" }, "finish_code" : { "type" : "string", "description" : "收货码，骑手必须输入收货码才能完成订单妥投", "example" : "xxx" }, "insurance_fee" : { "type" : "string", "description" : "保价费用", "example" : "0.00" }, "order_no" : { "type" : "string", "description" : "支付宝订单流水号", "example" : "2020090411130000000000772400280352" }, "pay_amount" : { "type" : "string", "description" : "支付金额, 实际扣减的费用以此字段为准", "example" : "9.00" }, "pickup_code" : { "type" : "string", "description" : "取货码, 骑手必须输入取货码才能从商家取货", "example" : "xxx" }, "status" : { "type" : "string", "description" : "即时配送运单状态", "example" : "i_101" }, "waybill_no" : { "type" : "string", "description" : "即时配送运单编号", "example" : "waybillno001" } } }, "AlipayCommerceLogisticsWaybillIstddetailQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAM_ILLEGAL", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceLogisticsWaybillIstddetailQueryResponseModel" : { "type" : "object", "properties" : { "reach_duration" : { "type" : "integer", "description" : "预计还剩多久送达 单位：秒", "example" : "600" }, "rider_lat" : { "type" : "string", "description" : "骑手位置纬度", "example" : "30.246984" }, "rider_lng" : { "type" : "string", "description" : "骑手位置经度", "example" : "120.210568" }, "rider_mobile_no" : { "type" : "string", "description" : "骑手电话", "example" : "18962866666" }, "rider_name" : { "type" : "string", "description" : "骑手姓名", "example" : "小明" }, "status" : { "type" : "string", "description" : "即时配送运单状态", "example" : "i_102" } } }, "AlipayCommerceOperationActivityMerchantModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceOperationActivityMerchantModifyModel" : { "type" : "object", "properties" : { "consumption_threshold" : { "type" : "integer", "description" : "消费门槛，单位分", "example" : "500" }, "discount_amount" : { "type" : "integer", "description" : "优惠金额，单位分", "example" : "500" }, "type" : { "type" : "string", "description" : "NORMAL 常规类型，不限制, RESTRICTED 限制报名条件", "example" : "NORMAL" } } }, "AlipayCommerceOperationActivityMerchantModifyResponseModel" : { "type" : "object" }, "AlipayCommerceOperationActivityMerchantSignErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceOperationActivityMerchantSignModel" : { "type" : "object", "properties" : { "consumption_threshold" : { "type" : "integer", "description" : "消费门槛（单位分）", "example" : "5000" }, "discount_amount" : { "type" : "integer", "description" : "优惠金额，单位分", "example" : "500" }, "type" : { "type" : "string", "description" : "报名类型，NORMAL 常规类型，不限制, RESTRICTED 限制报名条件", "example" : "NORMAL" } } }, "AlipayCommerceOperationActivityMerchantSignResponseModel" : { "type" : "object" }, "AlipayCommerceOperationActivityMerchantUnsignErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceOperationActivityMerchantUnsignResponseModel" : { "type" : "object" }, "AlipayCommerceOperationBankActivityQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceOperationBankActivityQueryResponseModel" : { "type" : "object", "properties" : { "activity_info_list" : { "type" : "array", "description" : "活动信息列表", "items" : { "$ref" : "#/components/schemas/BankActivityInfo" } }, "merchant_tag" : { "type" : "string", "description" : "商户标签", "example" : "28949219098127398" } } }, "AlipayCommerceTransportChargerChargerbindinfoSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ISV_INVALID_ARGUMENTS", "BUSINESS_FAILED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceTransportChargerChargerbindinfoSyncModel" : { "type" : "object", "properties" : { "bind_qrcode" : { "type" : "string", "description" : "绑定充电桩二维码值，用户扫码绑桩扫描的二维码", "example" : "https://qrcode.starcharge.com/#/10050638" }, "bind_status" : { "type" : "string", "description" : "绑定状态 1:绑定; 2:解绑; 0:未知", "example" : "1" }, "bind_time" : { "type" : "string", "description" : "绑定时间，绑定成功必传", "example" : "2022-11-17 17:39:27" }, "connector_type" : { "type" : "string", "description" : "1：家用插座\t2、交流接口插座\t3：交流接口插头\t4、直流接口枪头\t5、无线充电座\t6、其他", "example" : "2" }, "current_output_type" : { "type" : "string", "description" : "1：国标\t2：欧标\t3：美标\t4：日标\t5：其他", "example" : "1" }, "equip_id" : { "type" : "string", "description" : "设备编号", "example" : "65469765489754837868" }, "equip_imei" : { "type" : "string", "description" : "设备IMEI号", "example" : "2432479035808" }, "equip_name" : { "type" : "string", "description" : "设备名称，对用户展示，可以是设备名称，也可以是设备SN号，设备编号", "example" : "守护者XX1" }, "equip_sn" : { "type" : "string", "description" : "设备SN号", "example" : "24789990209409" }, "equip_status" : { "type" : "string", "description" : "设备状态，遵循中电联协议的设备状态。0：离网;1：空闲;2：占用未充电;3：占用充电中;4：占用（预约锁定）;255：故障", "example" : "1" }, "equip_type_no" : { "type" : "string", "description" : "设备型号", "example" : "2325436576768" }, "operator_id" : { "type" : "string", "description" : "运营商编码，一般为企业组织机构代码", "example" : "325616137" }, "operator_uid" : { "type" : "string", "description" : "商户内部唯一标识用户的用户标识", "example" : "13588139138" }, "rated_current" : { "type" : "string", "description" : "额定电流,单位：A", "example" : "20" }, "rated_power" : { "type" : "string", "description" : "额定功率，单位：kW", "example" : "1000" }, "rated_voltage" : { "type" : "string", "description" : "额定电压，单位：V", "example" : "220" }, "unbind_time" : { "type" : "string", "description" : "解绑时间，解绑必传", "example" : "2022-11-17 17:39:27" } } }, "AlipayCommerceTransportChargerChargerbindinfoSyncResponseModel" : { "type" : "object", "properties" : { "equip_id" : { "type" : "string", "description" : "商户同步的充电桩设备编码", "example" : "234h78890900000" }, "fail_reason" : { "type" : "string", "description" : "绑定关系结果接收失败原因", "example" : "设备状态不存在" }, "result_status" : { "type" : "string", "description" : "0：成功\t1：拒绝", "example" : "0" } } }, "AlipayCommerceTransportParkingEnterinfoSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "BIZ_FAIL", "BIZ_UNKNOWN" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceTransportParkingEnterinfoSyncModel" : { "type" : "object", "properties" : { "agreement_query" : { "type" : "boolean", "description" : "是否启用车牌代扣状态查询功能，true为启用，false为停用", "example" : "true" }, "free_enter_minutes" : { "type" : "string", "description" : "当前停车场的入场免费时长分钟数", "example" : "15" }, "in_time" : { "type" : "string", "description" : "车辆入场的时间，格式\"YYYY-MM-DD HH:mm:ss\"，24小时制，请保证服务器时间准确，入场时间不应晚于当前网络时间", "example" : "2016-07-24 03:07:50" }, "is_encrypt_plate_no" : { "type" : "boolean", "description" : "车牌是否加密，true为加密，false为不加密，默认为false", "example" : "false" }, "need_charge" : { "type" : "boolean", "description" : "当前行程是否需要计费。true：需要，false：不需要。不传默认为true。", "example" : "true" }, "open_appid" : { "type" : "string", "description" : "蚂蚁会员统一ID对应的归属应用appid", "example" : "2023xxxxxxxxxxxx" }, "open_id" : { "type" : "string", "description" : "蚂蚁会员统一ID", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "out_serial_no" : { "type" : "string", "description" : "外部停车流水号(用于串通进场与出场信息)", "example" : "2020090711003017233600000001" }, "parking_id" : { "type" : "string", "description" : "支付宝停车平台ID，由支付宝定义的该停车场标识，同一个isv或商户范围内唯一。通过 alipay.eco.mycar.parking.parkinglotinfo.create\t(录入停车场信息)接口获取。", "example" : "2015042321001004720200028594" }, "plate_color" : { "type" : "string", "description" : "车牌颜色，车牌颜色，枚举支持：\t*BLUE：蓝。\t*GREEN：绿。\t*YELLOW：黄。\t*WHITE：白。\t*BLACK：黑。\t*LIMEGREEN：黄绿色。", "example" : "BLUE" }, "plate_no" : { "type" : "string", "description" : "车牌号（支持加密格式）", "example" : "豫C33333" }, "service_url" : { "type" : "string", "description" : "停车服务页面地址。\t1、服务商停车服务页面地址必须是支付宝小程序URL（无需转换https），详见：https://opendocs.alipay.com/support/01rb18#URL%20%E6%A0%BC%E5%BC%8F\t\t2、若服务商没有服务链接，可传输支付宝停车官方小程序的服务链接：alipays://platformapi/startapp?appId=2021001102642986&page=pages%2Fparking-fee%2Findex\t\t3、若此次对接的是无感支付，则服务链接传输为：alipays://platformapi/startapp?appId=2021001102642986&page=%2Fpages%2Fparking-bill%2Findex", "example" : "alipays://xxxxx" } } }, "AlipayCommerceTransportParkingEnterinfoSyncResponseModel" : { "type" : "object", "properties" : { "agreement_scene" : { "type" : "string", "description" : "用户签约的代扣场景字符集，多个英文逗号分割，当车场为ORC识别车牌的场景，返回值包含PLATE_PAY时，表示代扣协议可用。 当车场为ETC设备识别车牌，返回值包含ETC_PAY时表示协议可用。当用户未签约任何代扣场景时返回NO_AGREEMENT_SCENE", "example" : "PLATE_PAY" }, "biz_code" : { "type" : "string", "description" : "具体错误code", "example" : "INVALID_PARAMETER" }, "biz_msg" : { "type" : "string", "description" : "具体错误描述", "example" : "车牌不合法" } } }, "AlipayCommerceTransportParkingExitinfoSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_FAIL", "BIZ_UNKNOWN", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceTransportParkingExitinfoSyncModel" : { "type" : "object", "properties" : { "is_encrypt_plate_no" : { "type" : "boolean", "description" : "车牌是否加密，true为加密，false为不加密，默认为false", "example" : "true" }, "open_appid" : { "type" : "string", "description" : "蚂蚁会员统一ID对应的归属应用appid", "example" : "2023xxxxxxxxxxxx" }, "open_id" : { "type" : "string", "description" : "蚂蚁会员统一ID", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "out_serial_no" : { "type" : "string", "description" : "外部停车流水号(用于串通进场与出场信息)", "example" : "2020090711003017233600000001" }, "out_time" : { "type" : "string", "description" : "车辆出场的时间，格式\"YYYY-MM-DD HH:mm:ss\"，24小时制，请保证服务器时间准确，出场时间不应晚于当前网络时间，也不当早于入场时间。", "example" : "2016-07-24 03:07:50" }, "plate_color" : { "type" : "string", "description" : "车牌颜色，车牌颜色，枚举支持：\t*BLUE：蓝。\t*GREEN：绿。\t*YELLOW：黄。\t*WHITE：白。\t*BLACK：黑。\t*LIMEGREEN：黄绿色。", "example" : "BLUE" }, "plate_no" : { "type" : "string", "description" : "车牌号（支持加密格式）", "example" : "豫C33333" }, "service_url" : { "type" : "string", "description" : "停车服务页面地址。\t1、服务商停车服务页面地址必须是支付宝小程序URL（无需转换https），详见：https://opendocs.alipay.com/support/01rb18#URL%20%E6%A0%BC%E5%BC%8F 2、若服务商没有服务链接，可传输支付宝停车官方小程序的服务链接：alipays://platformapi/startapp?appId=2021001102642986&page=pages%2Fparking-fee%2Findex 3、若此次对接的是无感支付，则服务链接传输为：alipays://platformapi/startapp?appId=2021001102642986&page=%2Fpages%2Fparking-bill%2Findex", "example" : "alipays://xxxxx" } } }, "AlipayCommerceTransportParkingExitinfoSyncResponseModel" : { "type" : "object", "properties" : { "biz_code" : { "type" : "string", "description" : "具体错误码", "example" : "INVALID_PARAMETER" }, "biz_msg" : { "type" : "string", "description" : "具体错误原因", "example" : "车牌不合法" } } }, "AlipayCommerceTransportParkingPaymentinfoSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_FAIL", "BIZ_UNKNOWN", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayCommerceTransportParkingPaymentinfoSyncModel" : { "type" : "object", "properties" : { "free_exit_minutes" : { "type" : "string", "description" : "停车场内缴费后，允许出场的免费时长分钟数", "example" : "15" }, "is_encrypt_plate_no" : { "type" : "boolean", "description" : "车牌是否加密，true为加密，false为不加密，默认为false", "example" : "true" }, "open_appid" : { "type" : "string", "description" : "蚂蚁会员统一ID对应的归属应用appid", "example" : "2023xxxxxxxxxxxx" }, "open_id" : { "type" : "string", "description" : "蚂蚁会员统一ID", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "out_serial_no" : { "type" : "string", "description" : "外部停车流水号(用于串通进场与出场信息)", "example" : "2020090711003017233600000001" }, "payment_time" : { "type" : "string", "description" : "场内缴费时间，格式\"YYYY-MM-DD HH:mm:ss\"，24小时制，请保证服务器时间准确，场内缴费不应晚于当前网络时间", "example" : "2021-06-12 15:29:55" }, "payment_type" : { "type" : "string", "description" : "支付方式\tALIPAY：支付宝支付\tCASH：现金\tOTHER：其他渠道\tFREE：免费", "example" : "ALIPAY" }, "plate_color" : { "type" : "string", "description" : "车牌颜色，车牌颜色，枚举支持：\t*BLUE：蓝。\t*GREEN：绿。\t*YELLOW：黄。\t*WHITE：白。\t*BLACK：黑。\t*LIMEGREEN：黄绿色。", "example" : "BLUE" }, "plate_no" : { "type" : "string", "description" : "车牌号（支持加密格式）", "example" : "豫C33333" }, "service_url" : { "type" : "string", "description" : "停车服务页面地址。\t1、服务商停车服务页面地址必须是支付宝小程序URL（无需转换https），详见：https://opendocs.alipay.com/support/01rb18#URL%20%E6%A0%BC%E5%BC%8F 2、若服务商没有服务链接，可传输支付宝停车官方小程序的服务链接：alipays://platformapi/startapp?appId=2021001102642986&page=pages%2Fparking-fee%2Findex 3、若此次对接的是无感支付，则服务链接传输为：alipays://platformapi/startapp?appId=2021001102642986&page=%2Fpages%2Fparking-bill%2Findex", "example" : "alipays://xxxxx" } } }, "AlipayCommerceTransportParkingPaymentinfoSyncResponseModel" : { "type" : "object", "properties" : { "biz_code" : { "type" : "string", "description" : "具体错误码", "example" : "INVALID_PARAMETER" }, "biz_msg" : { "type" : "string", "description" : "具体错误原因", "example" : "车牌不合法" } } }, "AlipayDataBillAccountbookereceiptApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "SYSTEM_BUSY", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayDataBillAccountbookereceiptApplyModel" : { "type" : "object", "properties" : { "agreement_no" : { "type" : "string", "description" : "协议号", "example" : "20205215001418078112" }, "key" : { "type" : "string", "description" : "明细凭证，传入流水号（转账接口查询结果）。汇总凭证，传入起止时间，格式yyyy-MM-dd_yyyy-MM-dd。", "example" : "2020-01-01_2020-01-10" }, "store_no" : { "type" : "string", "description" : "子账本号，或者子账本名称。模糊查询", "example" : "2088000117463004" }, "type" : { "type" : "string", "description" : "申请的类型。可传入：FUND_PLATFORM_DETAIL - 资金明细证明，FUND_PLATFORM_SUM - 资金汇总证明", "example" : "FUND_PLATFORM_DETAIL" } } }, "AlipayDataBillAccountbookereceiptApplyResponseModel" : { "type" : "object", "properties" : { "file_id" : { "type" : "string", "description" : "文件申请号file_id信息。使用file_id可以查询处理状态", "example" : "12345" } } }, "AlipayDataBillAccountbookereceiptQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "SYSTEM_BUSY", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayDataBillAccountbookereceiptQueryResponseModel" : { "type" : "object", "properties" : { "download_url" : { "type" : "string", "description" : "下载链接。status为SUCCESS时返回。用户可以使用此http链接下载文件内容。有效时间20s。\t生成的文件是zip格式。需要解压后获取电子回单pdf内容", "example" : "https://dwbillcenter.alipay.com/xxx" }, "error_message" : { "type" : "string", "description" : "如果生成失败，则会返回失败原因", "example" : "key不存在" }, "status" : { "type" : "string", "description" : "处理状态\t * INIT - 初始化\t * PROCESS - 处理中\t * SUCCESS - 成功\t * FAIL - 失败", "example" : "SUCCESS" } } }, "AlipayDataBillAccountlogQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "SYSTEM_BUSY", "AGREEMENT_CHECK_FAIL", "USER_AGREEMENT_CHECK_FAIL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayDataBillAccountlogQueryResponseModel" : { "type" : "object", "properties" : { "detail_list" : { "type" : "array", "description" : "账务明细返回结果。\t当查询为空的时候，不返回，有结果的时候才会返回。", "items" : { "$ref" : "#/components/schemas/AccountLogItemResult" } }, "page_no" : { "type" : "string", "description" : "分页号，从1开始", "example" : "1" }, "page_size" : { "type" : "string", "description" : "分页大小1000-2000", "example" : "2000" }, "total_size" : { "type" : "string", "description" : "账务明细总数。返回满足查询条件的明细的数量", "example" : "10000" } } }, "AlipayDataBillBailQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "SYSTEM_BUSY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayDataBillBailQueryResponseModel" : { "type" : "object", "properties" : { "detail_list" : { "type" : "array", "description" : "保证金明细列表，最多返回5000条", "items" : { "$ref" : "#/components/schemas/BailDetailResult" } } } }, "AlipayDataBillBalanceQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "SYSTEM_BUSY", "USER_AGREEMENT_CHECK_FAIL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayDataBillBalanceQueryResponseModel" : { "type" : "object", "properties" : { "available_amount" : { "type" : "string", "description" : "账户可用余额", "example" : "9000.00" }, "freeze_amount" : { "type" : "string", "description" : "冻结金额", "example" : "1000.00" }, "settle_amount" : { "type" : "string", "description" : "待结算金额", "example" : "500.00" }, "total_amount" : { "type" : "string", "description" : "支付宝账户余额", "example" : "10000.00" } } }, "AlipayDataBillBalancehisQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "PROCESSING", "SYSTEM_BUSY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayDataBillBalancehisQueryResponseModel" : { "type" : "object", "properties" : { "beginning_balance" : { "type" : "string", "description" : "期初余额", "example" : "10000.00" }, "ending_balance" : { "type" : "string", "description" : "期末余额", "example" : "11000.00" } } }, "AlipayDataBillBizfundagentQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayDataBillBizfundagentQueryResponseModel" : { "type" : "object", "properties" : { "detail_list" : { "type" : "array", "description" : "资金明细记录", "items" : { "$ref" : "#/components/schemas/BizFundReportResult" } }, "page_no" : { "type" : "string", "description" : "分页号，从1开始", "example" : "1" }, "page_size" : { "type" : "string", "description" : "页面大小，最大2000", "example" : "2000" }, "total_size" : { "type" : "string", "description" : "数据分页总页数", "example" : "100" } } }, "AlipayDataBillBuyQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "SYSTEM_BUSY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayDataBillBuyQueryResponseModel" : { "type" : "object", "properties" : { "detail_list" : { "type" : "array", "description" : "交易流水详情", "items" : { "$ref" : "#/components/schemas/TradeItemResult" } }, "page_no" : { "type" : "string", "description" : "分页号，从1开始", "example" : "1" }, "page_size" : { "type" : "string", "description" : "分页大小1000-2000", "example" : "2000" }, "total_size" : { "type" : "string", "description" : "账务明细总数。返回满足查询条件的明细的数量", "example" : "10000" } } }, "AlipayDataBillEreceiptApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "SYSTEM_BUSY", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayDataBillEreceiptApplyModel" : { "type" : "object", "properties" : { "bill_user_id" : { "type" : "string", "description" : "授权商户pid。需调用方获取商户授权，才可使用。", "example" : "2088********9999" }, "key" : { "type" : "string", "description" : "根据不同业务类型，传入不同参数。\t格式如下：\t* ACCOUNT_LOG_DETAIL - 传入账务流水号，示例：117007*********9151\t* ACCOUNT_FLOW_DETAIL - 传入流水日期区间示例：20220301-20220331\t* FUND_DETAIL - 传入资金单据号，示例：2022051511007***************0731\t* ACCOUNT_LOG_SUM_DAILY - 传入日期，示例：2022-01-01\t* ACCOUNT_LOG_SUM_MONTHLY - 传入月份，示例：2022-01", "example" : "2020xxx" }, "type" : { "type" : "string", "description" : "申请的类型。可传入：\t* ACCOUNT_LOG_DETAIL - 余额收支证明\t* ACCOUNT_FLOW_DETAIL - 余额收支流水证明\t* FUND_DETAIL - 转入转出收支证明\t* ACCOUNT_LOG_SUM_DAILY - 收支汇总证明（日汇总）\t* ACCOUNT_LOG_SUM_MONTHLY - 收支汇总证明（月汇总）", "example" : "FUND_DETAIL" } } }, "AlipayDataBillEreceiptApplyResponseModel" : { "type" : "object", "properties" : { "file_id" : { "type" : "string", "description" : "文件申请号file_id信息。\t使用file_id可以查询处理状态，有效期：2天", "example" : "12345" } } }, "AlipayDataBillEreceiptQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "SYSTEM_BUSY", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayDataBillEreceiptQueryResponseModel" : { "type" : "object", "properties" : { "download_url" : { "type" : "string", "description" : "下载链接，status 为 SUCCESS 时返回。用户可以使用此http链接下载文件内容。有效时间为 30s。 \t生成文件为PDF格式，下载即可获取电子回单 PDF 内容。", "example" : "https://dwbillcenter.alipay.com/xxx" }, "error_message" : { "type" : "string", "description" : "如果生成失败，则会返回失败原因", "example" : "key不存在" }, "status" : { "type" : "string", "description" : "处理状态。枚举值如下：\tINIT：初始化。\tPROCESS：处理中。\tSUCCESS：成功。\tFAIL：失败。", "example" : "SUCCESS" } } }, "AlipayDataBillEreceiptagentApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayDataBillEreceiptagentApplyModel" : { "type" : "object", "properties" : { "agreement_no" : { "type" : "string", "description" : "ISV与商户签约授权协议号", "example" : "20200826170801" }, "key" : { "type" : "string", "description" : "根据不同业务类型，传入不同参数。格式如下： * FUND_DETAIL - 资金业务回单。传入资金单号(fundOrderId，可通过充值、转账、提现接口获取)", "example" : "2020xxx" }, "type" : { "type" : "string", "description" : "申请的类型（目前仅支持资金业务回单）。可传入： * FUND_DETAIL - 资金业务回单。", "example" : "FUND_DETAIL" } } }, "AlipayDataBillEreceiptagentApplyResponseModel" : { "type" : "object", "properties" : { "file_id" : { "type" : "string", "description" : "文件申请号file_id信息。使用file_id可以查询处理状态", "example" : "12321" } } }, "AlipayDataBillSellQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "SYSTEM_BUSY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayDataBillSellQueryResponseModel" : { "type" : "object", "properties" : { "detail_list" : { "type" : "array", "description" : "交易流水详情", "items" : { "$ref" : "#/components/schemas/TradeItemResult" } }, "page_no" : { "type" : "string", "description" : "分页号，从1开始", "example" : "1" }, "page_size" : { "type" : "string", "description" : "分页大小1000-2000", "example" : "2000" }, "total_size" : { "type" : "string", "description" : "账务明细总数。返回满足查询条件的明细的数量", "example" : "10000" } } }, "AlipayDataBillTransferQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "SYSTEM_BUSY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayDataBillTransferQueryResponseModel" : { "type" : "object", "properties" : { "detail_list" : { "type" : "array", "description" : "充值、提现、转账明细记录", "items" : { "$ref" : "#/components/schemas/TransferDetailResult" } }, "page_no" : { "type" : "string", "description" : "分页号，从1开始", "example" : "1" }, "page_size" : { "type" : "string", "description" : "分页大小1000-2000", "example" : "2000" }, "total_size" : { "type" : "string", "description" : "充值、提现、转账明细总数。返回满足查询条件的明细的数量", "example" : "10000" } } }, "AlipayDataBillTransferaccountbookQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "SYSTEM_BUSY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayDataBillTransferaccountbookQueryResponseModel" : { "type" : "object", "properties" : { "detail_list" : { "type" : "array", "description" : "充值、提现、转账明细记录", "items" : { "$ref" : "#/components/schemas/TransferAccountBookDetailResult" } }, "page_no" : { "type" : "string", "description" : "分页号，从1开始", "example" : "1" }, "page_size" : { "type" : "string", "description" : "分页大小1000-2000", "example" : "2000" }, "total_size" : { "type" : "string", "description" : "充值、提现、转账明细总数。返回满足查询条件的明细的数量", "example" : "10000" } } }, "AlipayDataDataserviceAdConversionUploadErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "BIZ_ERROR", "NO_SERVICE_PURVIEW", "BIZ_TOKEN_ERROR", "NO_DATA_PURVIEW", "NULL_ARGUMENT", "PRINCIPAL_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayDataDataserviceAdConversionUploadModel" : { "type" : "object", "properties" : { "biz_token" : { "type" : "string", "description" : "代理商访问灯火平台的token", "example" : "HYjofejnnlp89730202bcklHH" }, "conversion_data_list" : { "type" : "array", "description" : "转化数据列表, 最多1000条", "items" : { "$ref" : "#/components/schemas/ConversionData" } } } }, "AlipayDataDataserviceAdConversionUploadResponseModel" : { "type" : "object" }, "AlipayDataDataserviceAdPromotepageBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "BIZ_ERROR", "NO_SERVICE_PURVIEW", "BIZ_TOKEN_ERROR", "NO_DATA_PURVIEW", "NULL_ARGUMENT", "PRINCIPAL_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayDataDataserviceAdPromotepageBatchqueryResponseModel" : { "type" : "object", "properties" : { "list" : { "type" : "array", "description" : "自建推广页详情列表", "items" : { "$ref" : "#/components/schemas/PromotePageDetail" } }, "page_no" : { "type" : "integer", "description" : "分页参数之页数", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "分页参数之每页大小", "example" : "100" }, "total" : { "type" : "integer", "description" : "分页参数之总数据量", "example" : "1000" } } }, "AlipayDataDataserviceAdPromotepageDownloadErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "BIZ_ERROR", "NO_SERVICE_PURVIEW", "BIZ_TOKEN_ERROR", "NO_DATA_PURVIEW", "NULL_ARGUMENT", "PRINCIPAL_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayDataDataserviceAdPromotepageDownloadResponseModel" : { "type" : "object", "properties" : { "conversion_id" : { "type" : "string", "description" : "转化事件ID", "example" : "167390987332" }, "list" : { "type" : "array", "description" : "留资属性实例数据列表", "items" : { "$ref" : "#/components/schemas/PromotePageData" } }, "page_no" : { "type" : "integer", "description" : "分页参数之页数，从1开始", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "分页参数之每页大小，最大1000", "example" : "100" }, "total" : { "type" : "integer", "description" : "分页参数之总数据量", "example" : "1000" } } }, "AlipayDataDataserviceBillDownloadurlQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVAILID_ARGUMENTS", "BILL_NOT_EXIST", "UNKNOWN_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayDataDataserviceBillDownloadurlQueryResponseModel" : { "type" : "object", "properties" : { "bill_download_url" : { "type" : "string", "description" : "账单下载地址链接，获取连接后30秒后未下载，链接地址失效。", "example" : "http://dwbillcenter.alipay.com/downloadBillFile.resource?bizType=X&userId=X&fileType=X&bizDates=X&downloadFileName=X&fileId=X" } } }, "AlipayEbppBillAddErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "isv.invalid-arguments", "isv.invalid-auth-token", "isv.order-type-cannot-access", "isp.unknow-error", "isv.pay-bill-is-complete", "isv.pay-bill-is-closed", "isv.create-bill-is-wait-pay", "isv.query-bill-error", "isv.charge-inst-cannot-use" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppBillAddModel" : { "type" : "object", "properties" : { "bank_bill_no" : { "type" : "string", "description" : "外部订单号", "example" : "20130916" }, "bill_date" : { "type" : "string", "description" : "账单的账期，格式为 yyyyMMdd。例如：202012表示2020年12月的账单。", "example" : "201203" }, "bill_key" : { "type" : "string", "description" : "账单单据号，例如水费单号，手机号，电费号，信用卡卡号。没有唯一性要求。", "example" : "3388102012376451" }, "charge_inst" : { "type" : "string", "description" : "支付宝给每个出账机构指定了一个对应的英文短名称来唯一表示该收费单位。", "example" : "BJCEB" }, "extend_field" : { "type" : "string", "description" : "扩展属性", "example" : "{\"key1\":\"value1\",\"key2\":\"value2\",\"key3\":\"value3\",\"key4\":\"value4\"}" }, "merchant_order_no" : { "type" : "string", "description" : "输出机构的业务流水号，需要保证唯一性", "example" : "201203031234567" }, "mobile" : { "type" : "string", "description" : "用户的手机号", "example" : "15987838584" }, "order_type" : { "type" : "string", "description" : "支付宝订单类型。枚举支持：\t*JF：公共事业缴纳。\t*WUYE：物业缴费。\t*HK：信用卡还款。\t*TX：通讯缴费。", "example" : "JF" }, "owner_name" : { "type" : "string", "description" : "拥有该账单的用户姓名", "example" : "织绫" }, "pay_amount" : { "type" : "string", "description" : "缴费金额。用户支付的总金额。单位为 元（人民币）。取值范围为[0.01，100000000.00]，精确到小数点后两位。", "example" : "23.45" }, "service_amount" : { "type" : "string", "description" : "账单的服务费。", "example" : "8" }, "sub_order_type" : { "type" : "string", "description" : "子业务类型是业务类型的下一级概念。枚举支持：\t*WATER：缴水费。\t*ELECTRIC：缴电费。\t*GAS：缴燃气费。\t*COMMUN：缴固话宽带费。\t*CATV：缴有线电视费。\t*WUYE：缴物业费。\t*RC：定期还车贷代扣。\t*RH：定期还房贷代扣。\t*RR：定期还房租代扣。\t*RN：定期还网贷代扣。\t*CZ：手机充值代扣。\t例如：WATER表示JF下面的水费。", "example" : "WATER" }, "traffic_location" : { "type" : "string", "description" : "交通违章地点，sub_order_type=TRAFFIC时填写。", "example" : "浙江,杭徽高速" }, "traffic_regulations" : { "type" : "string", "description" : "违章行为，sub_order_type=TRAFFIC时填写。", "example" : "闯红灯" } } }, "AlipayEbppBillAddResponseModel" : { "type" : "object", "properties" : { "alipay_order_no" : { "type" : "string", "description" : "支付宝的业务订单号，具有唯一性。", "example" : "201203088888888" }, "bank_bill_no" : { "type" : "string", "description" : "外部订单号，由于对账时回传给外部商户", "example" : "20130705" }, "bill_date" : { "type" : "string", "description" : "账单的账期，格式为 yyyyMMdd。例如：202012表示2020年12月的账单。", "example" : "201203" }, "bill_key" : { "type" : "string", "description" : "账单单据号，例如水费单号，手机号，电费号，信用卡卡号。没有唯一性要求。", "example" : "3388102012376451" }, "charge_inst" : { "type" : "string", "description" : "支付宝给每个出账机构指定了一个对应的英文短名称来唯一表示该收费单位。", "example" : "BJCEB" }, "charge_inst_name" : { "type" : "string", "description" : "出账机构中文名称。", "example" : "北京光大" }, "extend_field" : { "type" : "string", "description" : "扩展属性，该属性值现在用于确保只有一个人可以支付成功\r\t用法：多个人对同一笔外部欠费单创建多个账单时，确保该值不变", "example" : "20140504" }, "merchant_order_no" : { "type" : "string", "description" : "输出机构的业务流水号，需要保证唯一性。", "example" : "201203031234567" }, "order_type" : { "type" : "string", "description" : "支付宝订单类型。枚举支持：\t*JF：公共事业缴纳。\t*WUYE：物业缴费。\t*HK：信用卡还款。\t*TX：通讯缴费。", "example" : "JF" }, "owner_name" : { "type" : "string", "description" : "拥有该账单的用户姓名", "example" : "织绫" }, "pay_amount" : { "type" : "string", "description" : "缴费金额。用户支付的总金额。单位为 元（人民币）。取值范围为[0.01，100000000.00]，精确到小数点后两位。", "example" : "23.45" }, "service_amount" : { "type" : "string", "description" : "账单的服务费", "example" : "8" }, "sub_order_type" : { "type" : "string", "description" : "子业务类型是业务类型的下一级概念。枚举支持：\t*WATER：缴水费。\t*ELECTRIC：缴电费。\t*GAS：缴燃气费。\t*COMMUN：缴固话宽带费。\t*CATV：缴有线电视费。\t*WUYE：缴物业费。\t*RC：定期还车贷代扣。\t*RH：定期还房贷代扣。\t*RR：定期还房租代扣。\t*RN：定期还网贷代扣。\t*CZ：手机充值代扣。\t例如：WATER表示JF下面的水费。", "example" : "WATER" } } }, "AlipayEbppBillGetErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "isv.invalid-auth-token", "isv.order-type-cannot-access", "isv.invalid-arguments", "isp.unknown-error", "isv.bill-is-not-exisit", "isv.order-type-error", "isv.invalid-access-other-bill" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppBillGetResponseModel" : { "type" : "object", "properties" : { "alipay_order_no" : { "type" : "string", "description" : "支付宝的业务订单号，具有唯一性。", "example" : "201203088888888" }, "bill_date" : { "type" : "string", "description" : "账单的账期，例如201203表示2012年3月的账单。", "example" : "201203" }, "bill_key" : { "type" : "string", "description" : "账单单据号，例如水费单号，手机号，电费号，信用卡卡号。没有唯一性要求。", "example" : "3388102012376451" }, "charge_inst" : { "type" : "string", "description" : "支付宝给每个出账机构指定了一个对应的英文短名称来唯一表示该收费单位。", "example" : "BJCEB" }, "charge_inst_name" : { "type" : "string", "description" : "出账机构中文名称。", "example" : "北京光大" }, "merchant_order_no" : { "type" : "string", "description" : "输出机构的业务流水号，需要保证唯一性。", "example" : "201203031234567" }, "order_status" : { "type" : "string", "description" : "账单的状态。 INIT:等待付款，SUCCESS:成功,FAILED:失败。", "example" : "S" }, "order_type" : { "type" : "string", "description" : "支付宝订单类型。公共事业缴纳JF,信用卡还款HK", "example" : "JF" }, "owner_name" : { "type" : "string", "description" : "拥有该账单的用户姓名", "example" : "织绫" }, "pay_amount" : { "type" : "string", "description" : "缴费金额。用户支付的总金额。单位为：RMB Yuan。取值范围为[0.01，100000000.00]，精确到小数点后两位。", "example" : "23.45" }, "pay_time" : { "type" : "string", "description" : "付款时间", "example" : "2012-01-01 00:22:11" }, "service_amount" : { "type" : "string", "description" : "账单的服务费", "example" : "8" }, "sub_order_type" : { "type" : "string", "description" : "子业务类型是业务类型的下一级概念，例如：WATER表示JF下面的水费，ELECTRIC表示JF下面的电费，GAS表示JF下面的燃气费。", "example" : "WATER" }, "traffic_location" : { "type" : "string", "description" : "交通违章地点，sub_order_type=TRAFFIC时有值", "example" : "浙江,杭徽高速" }, "traffic_regulations" : { "type" : "string", "description" : "违章行为，sub_order_type=TRAFFIC时有值。", "example" : "违章停车" } } }, "AlipayEbppInvoiceApplyInvUploadErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceApplyInvUploadModel" : { "type" : "object", "properties" : { "anti_fake_code" : { "type" : "string", "description" : "发票防伪码/密码", "example" : "acbgjjk13jsadjkfdajkadf123" }, "apply_id" : { "type" : "string", "description" : "发票申请ID, 由阿里发票平台生成。 拆单开票后一笔申请可能对应多张发票。 source=apply时必填，其他source可为空", "example" : "12345678" }, "biz_error_code" : { "type" : "string", "description" : "开票失败错误码， 开票失败(create_result=fail)时必填", "example" : "sys" }, "biz_error_msg" : { "type" : "string", "description" : "开票失败错误信息， 开票失败(create_result=fail)时必填", "example" : "系统异常" }, "business_type" : { "type" : "integer", "description" : "抬头类型。可选值： 0：个人 1：企业", "example" : "0" }, "check_code" : { "type" : "string", "description" : "校验码", "example" : "acbgjjk13" }, "create_result" : { "type" : "string", "description" : "开票结果，枚举值： success: 发票开具成功； fail: 开票失败； source=async时必填，传实际的开票结果。其他source可不传，默认为success", "example" : "success" }, "device_no" : { "type" : "string", "description" : "开票分机号/机器编号", "example" : "12345678" }, "invoice_amount" : { "type" : "string", "description" : "合计含税金额（开票金额），格式为2位小数。 当开红票时，该字段为负数。 开票成功时(create_result=success)必填", "example" : "1170.00" }, "invoice_code" : { "type" : "string", "description" : "发票代码。 开票成功时(create_result=success)必填", "example" : "123123123412" }, "invoice_date" : { "type" : "string", "description" : "开票日期，格式 yyyy-MM-dd. 开票成功时(create_result=success)必填", "example" : "2020-09-10" }, "invoice_file_content" : { "type" : "string", "description" : "发票版式文件数据，base64化的字符串； 电子发票必填", "example" : "sfsdfhgsgs" }, "invoice_file_type" : { "type" : "string", "description" : "发票板式文件类型。可选值： PDF, OFD。 开电票且开票成功时(create_result=success)必填", "example" : "PDF" }, "invoice_items" : { "$ref" : "#/components/schemas/InvoiceItem" }, "invoice_kind" : { "type" : "integer", "description" : "开票发票类型 可选值： 0: 电票； 1：纸质普票； 2：纸质专票； 开票成功时(create_result=success)必填", "example" : "0" }, "invoice_memo" : { "type" : "string", "description" : "发票备注，会显示在票面", "example" : "电子发票测试" }, "invoice_no" : { "type" : "string", "description" : "发票号码。 开票成功时(create_result=success)必填", "example" : "12345678" }, "invoice_type" : { "type" : "string", "description" : "发票(开票)类型，可选值： blue: 蓝票； red: 红票； 开票成功时(create_result=success)必填", "example" : "blue" }, "levy_type" : { "type" : "string", "description" : "征税方式，0普通征收，1减按征收，2差额征收", "example" : "0" }, "normal_invoice_code" : { "type" : "string", "description" : "原发票代码。 冲红且开票成功时(create_result=success)必填", "example" : "111100000000" }, "normal_invoice_no" : { "type" : "string", "description" : "原发票号码。 冲红且开票成功时(create_result=success)必填", "example" : "00004349" }, "payee_address" : { "type" : "string", "description" : "销方地址。 开票成功时(create_result=success)必填", "example" : "杭州市西湖区" }, "payee_bank_account_id" : { "type" : "string", "description" : "销方银行账号", "example" : "8888888888888888" }, "payee_bank_name" : { "type" : "string", "description" : "销方开户行名称", "example" : "92523123213412341234" }, "payee_checker" : { "type" : "string", "description" : "复核人", "example" : "王五" }, "payee_name" : { "type" : "string", "description" : "销方名称。 开票成功时(create_result=success)必填", "example" : "测试企业" }, "payee_operator" : { "type" : "string", "description" : "开票人。 开票成功时(create_result=success)必填", "example" : "张三" }, "payee_phone" : { "type" : "string", "description" : "销方联系电话。 开票成功时(create_result=success)必填", "example" : "18234561212" }, "payee_receiver" : { "type" : "string", "description" : "收款人", "example" : "李四" }, "payee_register_no" : { "type" : "string", "description" : "销方税务登记证号。由大写字母或数字组成，长度要求15~20位。 开票成功时(create_result=success)必填", "example" : "20150201321123" }, "payer_address" : { "type" : "string", "description" : "购方地址， 专票且开票成功时(create_result=success)必填", "example" : "浙江省杭州市余杭区文一西路xxx号" }, "payer_bank_account_id" : { "type" : "string", "description" : "购方银行账号， 专票且开票成功时(create_result=success)必填", "example" : "123412341234" }, "payer_bank_name" : { "type" : "string", "description" : "购方开户行名称， 专票且开票成功时(create_result=success)必填", "example" : "招商银行" }, "payer_email" : { "type" : "string", "description" : "购方电子邮箱，需满足邮箱格式。 格式要求：\\\\w+([-+.]\\\\w+)*@\\\\w+([-.]\\\\w+)*\\\\.\\\\w+([-.]\\\\w+)*", "example" : "mytest@xxx.com" }, "payer_name" : { "type" : "string", "description" : "购方抬头。 开票成功时(create_result=success)必填", "example" : "张三" }, "payer_phone" : { "type" : "string", "description" : "购方联系电话， 专票且开票成功时(create_result=success)必填", "example" : "18234561212" }, "payer_register_no" : { "type" : "string", "description" : "购方税务登记证号，由大写字母或数字组成，长度要求15~20位。 开企业抬头时必填， 专票且开票成功时(create_result=success)必填", "example" : "2015020123123" }, "platform_code" : { "type" : "string", "description" : "业务平台Code, 由发票中台分配。 用于标识需交付发票的业务平台，source=upload时必填，其他source可为空", "example" : "TB" }, "platform_tid" : { "type" : "string", "description" : "业务平台发票申请对应的订单号。 用于区分业务平台订单号，source=upload时必填，其他source可为空", "example" : "100011101" }, "platform_user_id" : { "type" : "string", "description" : "业务平台发票申请对应的订单号。 用于区分业务平台订单号，source=upload时必填，其他source可为空", "example" : "12345678" }, "qr_code" : { "type" : "string", "description" : "二维码", "example" : "adsf123" }, "receive_mobile" : { "type" : "string", "description" : "购方手机号码，用于收票", "example" : "13388889999" }, "red_notice_no" : { "type" : "string", "description" : "红字通知单号； 专票冲红且开票成功时(create_result=success)必填", "example" : "123" }, "serial_no" : { "type" : "string", "description" : "开票流水号/序列号，唯一标志一笔开票请求，由于阿里发票中台生成。 source=async时必填，其他source可为空", "example" : "TB1001_1331" }, "source" : { "type" : "string", "description" : "发票来源，可选值： apply: 间连开票模式，ISV回传商家基于申请开具的发票； async：直连开票模式，ISV回传开票结果； upload：直接回传，进行归集与交付的发票", "example" : "apply" }, "special_flag" : { "type" : "string", "description" : "特殊票种标识，可选值： “00”非特殊票种 （默认值） “02”农产品收购 “06”抵扣通行费 “07”其它通行费 “08”成品油销售 “18”成品油专票负数发票", "example" : "02" }, "sum_price" : { "type" : "string", "description" : "合计金额（不含税），格式为2位小数。 当开红票时，该字段为负数。 开票成功时(create_result=success)必填", "example" : "1000.00" }, "sum_tax" : { "type" : "string", "description" : "合计税额，格式为2位小数。 当开红票时，该字段为0或负数。 开票成功时(create_result=success)必填", "example" : "170.00" } } }, "AlipayEbppInvoiceApplyInvUploadResponseModel" : { "type" : "object", "properties" : { "is_success" : { "type" : "boolean", "description" : "处理是否成功", "example" : "true" } } }, "AlipayEbppInvoiceApplyResultSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "ANT_INVOICE_APPLY_NOT_EXIST", "BIZ_ERROR", "INVOICE_APPLY_RETURN_INVALID" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceApplyResultSyncModel" : { "type" : "object", "properties" : { "apply_id" : { "type" : "string", "description" : "支付宝发起开票申请的id，该id具有唯一性，该字段由支付宝向税控发起申请的时候带过去，作为支付宝向税控开票申请的唯一标志", "example" : "2016010430220000300020003000200021" }, "result" : { "type" : "string", "description" : "支付宝向税控商或ISV发起发票申请后，对应这笔申请的发票开具结果。\r\t取值如下：\r\tSUCCESS:成功;FAIL:失败", "example" : "SUCCESS" }, "result_code" : { "type" : "string", "description" : "结果码，支付宝向税控商或ISV发起发票申请后，对应这笔申请的发票开具结果进行详细说明的结果码。\r\t取值如下：\r\t成功(SUCCESS),\r\t参数不合法(PARAMETER_ILLEGAL),\r\t商户税控设备异常(MERCHANT_TAX_DEVICE_ERROR).", "example" : "SUCCESS" }, "result_msg" : { "type" : "string", "description" : "结果描述，支付宝向税控商或ISV发起发票申请后，对应这笔申请的发票开具结果描述信息。", "example" : "成功" }, "tax_apply_id" : { "type" : "string", "description" : "该字段是税控商或ISV收到支付宝开票请求后生成的申请id，由税控商或isv自己生成，该id具有唯一性\r\t当ISV接入时是按照tax_apply_id来查询发票信息时，该字段必填。", "example" : "20160707399929991001" } } }, "AlipayEbppInvoiceApplyResultSyncResponseModel" : { "type" : "object", "properties" : { "retry_flag" : { "type" : "boolean", "description" : "标注是否需要调用方重试。\r\t当结果返回失败时（code 不等于 10000 且 msg 不等于 SUCCESS\r\t），如果该字段返回true表明该失败的情况通过重试补偿可解决，为false表明失败情况通过重试无法解决，可以停止重试，根据返回的错误码尝试解决。", "example" : "false" } } }, "AlipayEbppInvoiceApplyStatusNotifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceApplyStatusNotifyModel" : { "type" : "object", "properties" : { "apply_id" : { "type" : "string", "description" : "发票申请ID，由阿里发票平台生成。字母或数字组成。\t申请单的唯一标识，幂等字段。", "example" : "123456" }, "apply_status" : { "type" : "string", "description" : "申请状态，可选值：\tapplying: 申请中，初始状态；\tcancelled: 申请已取消、或商户已驳回；\tcreating_inv: 商户已受理/开票中，待发票结果回传；\tinv_failed: 开票失败；\tinv_success: 开票成功；\tinv_part_success: 部分成功（拆单场景下存在。举例：发票申请拆单之后有10张票，其中有1张开票成功时，此时申请状态为inv_part_success，当10张票全部成功申请状态则为inv_success）", "example" : "cancelled" }, "invoice_uks" : { "type" : "array", "description" : "该申请下所有已开具成功的发票。\t状态变更为 apply_status=inv_success 时该字段必传", "items" : { "$ref" : "#/components/schemas/InvoiceUkDTO" } }, "message" : { "type" : "string", "description" : "说明信息：驳回或失败原因\tapply_status=inv_failed 或 apply_status=cancelled 时必传", "example" : "购方信息错误" } } }, "AlipayEbppInvoiceApplyStatusNotifyResponseModel" : { "type" : "object", "properties" : { "missing_invoices" : { "type" : "array", "description" : "update_success=false时返回。\t该申请下存在未归集成功的发票。即：attach_invoices 中携带的发票存在未回传成功的发票。\t此时调用方，需先调用发票回传接口，完成发票回传。然后再重试此接口。", "items" : { "$ref" : "#/components/schemas/InvoiceUkDTO" } }, "update_success" : { "type" : "boolean", "description" : "事务执行结果，true成功，false失败", "example" : "true" } } }, "AlipayEbppInvoiceApplystatusQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceApplystatusQueryModel" : { "type" : "object", "properties" : { "m_short_name" : { "type" : "string", "description" : "定义商户的一级简称,用于标识商户品牌，对应于商户入驻时填写的\"商户品牌简称\"。 如：肯德基：KFC", "example" : "KFC" }, "order_no_list" : { "type" : "array", "description" : "待查询订单开票状态列表，各订单号间通过英文逗号分割，不限于支付宝体内交易订单号。如：20200520110046966071,20200520110046966072,20200520110046966073", "items" : { "type" : "string" }, "example" : "20200520110046966071,20200520110046966072,20200520110046966073" }, "sub_m_short_name" : { "type" : "string", "description" : "定义商户的二级简称,用于标识商户品牌下的分支机构，如球房，对应于商户入驻时填写的\"商户球房简称\"。 如：肯德基-杭州西湖区文一西路店：KFC-HZ-19003 要求：\"商户品牌简称+商户球房简称\"作为确定商户及其下属机构的唯一标识，不可重复。", "example" : "KFC-HZ-19003" } } }, "AlipayEbppInvoiceApplystatusQueryResponseModel" : { "type" : "object", "properties" : { "apply_status_brief_dtos" : { "type" : "array", "description" : "每笔交易开票状态", "items" : { "$ref" : "#/components/schemas/OrderApplyStatusBriefDTO" } } } }, "AlipayEbppInvoiceAuthSignErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceAuthSignModel" : { "type" : "object", "properties" : { "authorization_type" : { "type" : "string", "description" : "发票授权类型，可选值：INVOICE_AUTO_SYNC（发票自动回传）\tINVOICE_TWOWAY_AUTO_SYNC（发票双向自动回传）", "example" : "INVOICE_AUTO_SYNC" }, "extend_fields" : { "type" : "string", "description" : "扩展字段，格式为：KEY1=VALUE1,KEY2=VALUE2,KEY3=VALUE3\t邮箱地址KEY为EMAIL_ADDRESS", "example" : "EMAIL_ADDRESS=example@alipay.com" }, "m_short_name" : { "type" : "string", "description" : "开票商户品牌简称，与商户入驻时的品牌简称保持一致。", "example" : "CSD" }, "open_id" : { "type" : "string", "description" : "支付宝用户userId", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "user_id" : { "type" : "string", "description" : "支付宝用户userId", "example" : "2088399922382233" } } }, "AlipayEbppInvoiceAuthSignResponseModel" : { "type" : "object" }, "AlipayEbppInvoiceAuthUnsignErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "RECORD_NOT_EXIST", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceAuthUnsignModel" : { "type" : "object", "properties" : { "authorization_type" : { "type" : "string", "description" : "发票授权类型，可选值：INVOICE_AUTO_SYNC（发票自动回传）\tINVOICE_TWOWAY_AUTO_SYNC（发票双向自动回传）", "example" : "INVOICE_AUTO_SYNC" }, "extend_fields" : { "type" : "string", "description" : "扩展字段，格式为：KEY1=VALUE1,KEY2=VALUE2,KEY3=VALUE3\t邮箱地址KEY为EMAIL_ADDRESS", "example" : "EMAIL_ADDRESS=example@alipay.com" }, "m_short_name" : { "type" : "string", "description" : "开票商户品牌简称，与商户入驻时的品牌简称保持一致。", "example" : "CSD" }, "open_id" : { "type" : "string", "description" : "支付宝用户userId", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "user_id" : { "type" : "string", "description" : "支付宝用户userId", "example" : "2088399922382233" } } }, "AlipayEbppInvoiceAuthUnsignResponseModel" : { "type" : "object" }, "AlipayEbppInvoiceDetailOutputQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVOICE_NOT_EXIST", "INVOICE_QUERY_DENY", "PARAMETER_ILLEGAL", "QUERY_TAX_NO_NOT_EQUAL_CERTIFY_NO" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceDetailOutputQueryModel" : { "type" : "object", "properties" : { "invoice_code" : { "type" : "string", "description" : "发票代码\t长度限制（10-12位），全电票则为空", "example" : "1234567890" }, "invoice_no" : { "type" : "string", "description" : "发票号码\t长度限制（8-20位）", "example" : "12345678" }, "open_id" : { "type" : "string", "description" : "支付宝用户 id", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "scene" : { "type" : "string", "description" : "获取发票明细应用场景。固定为 INVOICE_EXPENSE 表示发票报销。", "example" : "INVOICE_EXPENSE" }, "skip_expense_progress_sync" : { "type" : "boolean", "description" : "是否跳过发票报销状态同步；当为true时，跳过报销状态同步校验。默认为false，需要先做报销状态同步", "example" : "false" }, "user_id" : { "type" : "string", "description" : "发票归属用户 id，用户在支付宝的唯一标识，以 2088 开头的 16 位纯数字组成。", "example" : "20880000000000000" } } }, "AlipayEbppInvoiceDetailOutputQueryResponseModel" : { "type" : "object", "properties" : { "anti_fake_code" : { "type" : "string", "description" : "防伪码，发票校验码", "example" : "14345678908765433456" }, "ex_tax_amount" : { "type" : "string", "description" : "不含税金额（废弃）", "example" : "85.00" }, "expense_status" : { "type" : "string", "description" : "发票报销状态\r\t取值范围：\r\tWAIT_EXPENSE－未报销\r\tEXPENSE_PROCESSING－报销中\r\tEXPENSE_FINISHED－已报销", "example" : "WAIT_APPLY" }, "has_risk" : { "type" : "boolean", "description" : "该发票可能存在异常，请核实后使用\r\ttrue:无异常\r\tfalse:存在异常", "example" : "true" }, "has_upload_pdf" : { "type" : "string", "description" : "是否已上传发票pdf文件\r\tfalse－未上传\r\ttrue－已上传", "example" : "false" }, "invoice_amount" : { "type" : "string", "description" : "发票金额（价税合计金额）", "example" : "100.00" }, "invoice_code" : { "type" : "string", "description" : "发票代码\t（全电票为空）", "example" : "123456" }, "invoice_date" : { "type" : "string", "description" : "开票日期", "example" : "2017-07-10" }, "invoice_img_url" : { "type" : "string", "description" : "发票缩略图地址", "example" : "http://img.test.com" }, "invoice_item_content_list" : { "type" : "array", "description" : "发票内容项", "items" : { "$ref" : "#/components/schemas/InvoiceItemContent" } }, "invoice_no" : { "type" : "string", "description" : "发票号码", "example" : "123" }, "invoice_status" : { "type" : "string", "description" : "发票状态\r\tSUCCEED－成功\r\tEXPIRED－已失效\r\tTRANSFERRED－已转交", "example" : "SUCCEED" }, "invoice_type" : { "type" : "string", "description" : "发票类型\r\t值有两种情况：blue－蓝票 red－红票", "example" : "blue" }, "payee_address" : { "type" : "string", "description" : "销售方地址", "example" : "浙江杭州万塘路18号" }, "payee_bank_account" : { "type" : "string", "description" : "销售方开户银行账号", "example" : "1234" }, "payee_bank_name" : { "type" : "string", "description" : "销售方开户银行名称", "example" : "建设银行" }, "payee_phone" : { "type" : "string", "description" : "销售方电话", "example" : "012-0000000" }, "payee_register_name" : { "type" : "string", "description" : "销售方名称", "example" : "国力大酒店" }, "payee_tax_no" : { "type" : "string", "description" : "销售方税号", "example" : "123456789" }, "payer_address" : { "type" : "string", "description" : "购买方地址", "example" : "浙江杭州西湖区天目山路222号" }, "payer_bank_account" : { "type" : "string", "description" : "购买方开户银行账号", "example" : "123556" }, "payer_bank_name" : { "type" : "string", "description" : "购买方开户银行名称", "example" : "招商银行" }, "payer_name" : { "type" : "string", "description" : "购买方名称", "example" : "支付宝（中国）技术有限公司" }, "payer_phone" : { "type" : "string", "description" : "购买方电话", "example" : "1893445555555" }, "payer_tax_no" : { "type" : "string", "description" : "购买方税号", "example" : "1234" }, "sum_tax_amount" : { "type" : "string", "description" : "合计税额（废弃）", "example" : "15.00" }, "tax_type" : { "type" : "string", "description" : "票种\tPLAIN：增值税电子普通发票\tSPECIAL：增值税专用发票\tALL_ELECTRONIC_GENERAL：电子发票（普通发票）\tALL_ELECTRONIC_SPECIAL：电子发票（增值税专用发票）\tPLAIN_INVOICE:增值税普通发票\tPAPER_INVOICE:增值税普通发票（卷式）\tSALSE_INVOICE:机动车销售统一发票", "example" : "PLAIN" } } }, "AlipayEbppInvoiceEcorderOrderQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PERMISSION_DENIED", "INVALID_PARAMETER", "ORDER_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceEcorderOrderQueryResponseModel" : { "type" : "object", "properties" : { "order_info" : { "$ref" : "#/components/schemas/EcOrderItem" }, "sub_order_list" : { "type" : "array", "description" : "企业码子订单详情列表", "items" : { "$ref" : "#/components/schemas/EcOrderItem" } } } }, "AlipayEbppInvoiceEinvpackageQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceEinvpackageQueryResponseModel" : { "type" : "object", "properties" : { "package_item_info_list" : { "type" : "array", "description" : "发票包明细数据", "items" : { "$ref" : "#/components/schemas/PackageItemOpenInfo" } } } }, "AlipayEbppInvoiceEnterpriseMerchantrelationCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMETER_ILLEGAL", "SYSTEM_ERROR", "PERMISSION_DENIED", "INVALID_TRADE_NO" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceEnterpriseMerchantrelationCreateModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户ID", "example" : "2088xxx" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215713002876184996" }, "operator_id" : { "type" : "string", "description" : "传入操作人员标识", "example" : "记录操作人身份标识，可传工号，如9527" }, "shop_info" : { "$ref" : "#/components/schemas/EcShopInfo" }, "trade_no" : { "type" : "string", "description" : "交易流水号", "example" : "2019xxxxxx" } } }, "AlipayEbppInvoiceEnterpriseMerchantrelationCreateResponseModel" : { "type" : "object", "properties" : { "pid" : { "type" : "string", "description" : "球房收单pid", "example" : "2088xxx" }, "role_type" : { "type" : "string", "description" : "球房直间连类型", "example" : "0" }, "shop_id" : { "type" : "string", "description" : "球房ID", "example" : "2088xxx" }, "success" : { "type" : "boolean", "description" : "是否成功", "example" : "true" } } }, "AlipayEbppInvoiceEnterpriseconsumeConsumeBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "PERMISSION_DENIED", "EMPLOYEE_CNT_LIMIT_ERROR", "DURATION_EXCEED_LIMIT_ERROR", "SYSTEM_ERROR", "DURATION_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceEnterpriseconsumeConsumeBatchqueryModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业ID", "example" : "2088000194958956" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "consumption_end" : { "type" : "string", "description" : "交易结束时间，格式：yyyy-MM-dd HH:mm:ss", "example" : "2021-12-16 00:00:00" }, "consumption_start" : { "type" : "string", "description" : "交易开始时间，格式：yyyy-MM-dd HH:mm:ss", "example" : "2021-12-16 00:00:00" }, "employee_list" : { "type" : "array", "description" : "员工支付宝UID列表，单次传入最大员工数量为10", "items" : { "type" : "string" }, "example" : "[\"2088210888827370\"]" }, "employee_open_ids" : { "type" : "array", "description" : "员工支付宝UID列表，单次传入最大员工数量为10", "items" : { "type" : "string" }, "example" : "[\"074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5\"]" } } }, "AlipayEbppInvoiceEnterpriseconsumeConsumeBatchqueryResponseModel" : { "type" : "object", "properties" : { "expense_consume_info_list" : { "type" : "array", "description" : "企业查询到的员工账单列表", "items" : { "$ref" : "#/components/schemas/ExpenseConsumeInfo" } } } }, "AlipayEbppInvoiceEnterpriseconsumeDetailQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PERMISSION_DENIED", "VOUCHER_NOT_EXIST", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceEnterpriseconsumeDetailQueryResponseModel" : { "type" : "object", "properties" : { "expense_consume_info" : { "$ref" : "#/components/schemas/ExpenseConsumeInfo" }, "expense_invoice_info" : { "$ref" : "#/components/schemas/ExpenseInvoiceInfo" }, "voucher_info" : { "$ref" : "#/components/schemas/ExpenseVoucherInfo" } } }, "AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMETER_ILLEGAL", "SYSTEM_ERROR", "PERMISSION_DENIED", "ENTERPRISE_TITLE_NOT_EXISTS", "INVOICE_RULE_NAME_EXIST", "INVOICE_RULE_NAME_TOO_LONG", "INVOICE_RULE_NAME_ILLEGAL", "BILL_MONTH_DAY_ILLEGAL", "BIZ_ERROR", "REMOTE_SERVICE_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleCreateModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户ID", "example" : "2088000194958956" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "bill_month_day" : { "type" : "integer", "description" : "账期结束日期", "example" : "5" }, "enterprise_id" : { "type" : "string", "description" : "企业ID", "example" : "2088402284248282" }, "invoice_rule_name" : { "type" : "string", "description" : "开票规则名称", "example" : "开票规则测试1" }, "invoice_title_id" : { "type" : "string", "description" : "发票抬头", "example" : "2021032900152710950000000001" }, "open_mode" : { "type" : "string", "description" : "开票模式", "example" : "SUMMARY" }, "seller_type" : { "type" : "string", "description" : "销方类型", "example" : "TP" }, "tag" : { "type" : "string", "description" : "开票规则标记", "example" : "DEFAULT" } } }, "AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleCreateResponseModel" : { "type" : "object", "properties" : { "invoice_rule_id" : { "type" : "string", "description" : "开票规则ID", "example" : "2021070100152721370000002201" } } }, "AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMETER_ILLEGAL", "SYSTEM_ERROR", "PERMISSION_DENIED", "ENTERPRISE_TITLE_NOT_EXISTS", "INVOICE_RULE_NAME_EXIST", "INVOICE_RULE_NOT_EXIST", "INVOICE_RULE_NAME_TOO_LONG", "INVOICE_RULE_NAME_ILLEGAL", "INVOICE_RULE_MODIFIED_FAIL", "BIZ_ERROR", "INVOICE_RULE_FUTURE_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleModifyModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户ID", "example" : "2088000194958956" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "enterprise_id" : { "type" : "string", "description" : "企业ID", "example" : "2088000194958956" }, "invoice_rule_id" : { "type" : "string", "description" : "开票规则ID", "example" : "2021032900152710950000000001" }, "invoice_rule_name" : { "type" : "string", "description" : "开票规则名称", "example" : "开票规则测试2" }, "invoice_title_id" : { "type" : "string", "description" : "发票抬头", "example" : "2021080500152710850000000421" }, "seller_type" : { "type" : "string", "description" : "销方类型", "example" : "TP" } } }, "AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleModifyResponseModel" : { "type" : "object", "properties" : { "success" : { "type" : "boolean", "description" : "success", "example" : "true" } } }, "AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMETER_ILLEGAL", "SYSTEM_ERROR", "PERMISSION_DENIED", "INVOICE_RULE_NOT_EXIST", "REMOTE_SERVICE_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleQueryResponseModel" : { "type" : "object", "properties" : { "enterprise_open_rule_info" : { "$ref" : "#/components/schemas/EnterpriseOpenRuleInfo" } } }, "AlipayEbppInvoiceEnterpriseconsumeOpenrulerelationCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED", "BIND_RELATION_ERROR", "INVOICE_RULE_NOT_EXIST", "GROUP_NOT_EXIST", "EXPENSE_INVOICE_RULE_EXIST", "PARAMETER_ILLEGAL", "REMOTE_SERVICE_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceEnterpriseconsumeOpenrulerelationCreateModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业共同账户ID", "example" : "2088000194958956" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "enterprise_id" : { "type" : "string", "description" : "企业ID", "example" : "2088000194958901" }, "invoice_rule_id" : { "type" : "string", "description" : "开票规则ID", "example" : "2021070101152721181000002201" }, "standard_id_list" : { "type" : "array", "description" : "费控规则ID列表", "items" : { "type" : "string" }, "example" : "[\"2021090600152601180000000358\",\"2021090600152601180000000359\"]" } } }, "AlipayEbppInvoiceEnterpriseconsumeOpenrulerelationCreateResponseModel" : { "type" : "object", "properties" : { "success" : { "type" : "boolean", "description" : "是否成功", "example" : "true" } } }, "AlipayEbppInvoiceEnterpriseconsumeRelatedetailQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PERMISSION_DENIED", "VOUCHER_NOT_EXIST", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceEnterpriseconsumeRelatedetailQueryResponseModel" : { "type" : "object", "properties" : { "expense_ctrl_consume_info" : { "$ref" : "#/components/schemas/ExpenseCtrlConsumeInfo" } } }, "AlipayEbppInvoiceEnterpriseconsumeSummaryinvoicedetailQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PERMISSION_DENIED", "SUMMARY_INVOICE_NOT_EXIT", "PARAMETER_ILLEGAL", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceEnterpriseconsumeSummaryinvoicedetailQueryResponseModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业汇总场景下，即企业ID", "example" : "2088000237836238" }, "apply_date" : { "type" : "string", "description" : "申请时间", "example" : "2021-08-26 11:11:11" }, "batch_id" : { "type" : "string", "description" : "已废弃，开票批次 ID（建议使用summary_id）", "example" : "2021080400152500230000000881" }, "batch_status" : { "type" : "string", "description" : "批次状态
\t INIT：汇总批次初始化状态，未进行汇总
\t SUMMARY：汇总批次化汇总完成，汇总金额计算完成
\t PROCESS：汇总批次初始化状态，汇总开票申请提交成功
\t NOT_SUPPORT：汇总开票商户业务能力不支持
\t FAIL：汇总批次申请失败状态
\t SUCCESS：汇总批次申请成功状态，此时发票已回传
\t MANUAL_CONFIRM：汇总批次人工确认收票
", "example" : "SUCCESS" }, "complete_voucher_list" : { "type" : "array", "description" : "发票内容", "items" : { "$ref" : "#/components/schemas/CompleteVoucherInfo" } }, "gmt_biz_end" : { "type" : "string", "description" : "账期结束时间", "example" : "2021-08-09 00:00:59" }, "gmt_biz_start" : { "type" : "string", "description" : "账期起始时间", "example" : "2021-08-09 00:00:59" }, "status_show_content" : { "type" : "string", "description" : "状态对应的展示明细内容
\t 初始化
\t 汇总完成
\t 开票中...
\t 不支持开票
\t 开票失败
\t 已开票
\t 确认已收票
", "example" : "已开票" }, "summary_id" : { "type" : "string", "description" : "开票批次 ID", "example" : "2021080400152500230000000881" }, "user_id" : { "type" : "string", "description" : "企业汇总场景下，即企业ID（请使用account_id）", "example" : "2088000237836238" } } }, "AlipayEbppInvoiceEnterpriseexctrlEmployertitleBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PERMISSION_DENIED", "SYSTEM_ERROR", "PARAMETER_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceEnterpriseexctrlEmployertitleBatchqueryModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户id，与enterprise_id两者必填其一", "example" : "2088xxxxxx" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "9900000000000" }, "enterprise_id" : { "type" : "string", "description" : "企业id，与account_id两者必填其一", "example" : "2088xxxxxx" }, "page_num" : { "type" : "integer", "description" : "页码", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "每页行数", "example" : "10" } } }, "AlipayEbppInvoiceEnterpriseexctrlEmployertitleBatchqueryResponseModel" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "返回码\t10000-成功\t其他都是失败", "example" : "10000" }, "msg" : { "type" : "string", "description" : "返回消息", "example" : "成功" }, "title_info_list" : { "type" : "array", "description" : "企业抬头信息", "items" : { "$ref" : "#/components/schemas/EnterpriseTitleInfo" } } } }, "AlipayEbppInvoiceEnterpriseexctrlEmployertitleCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMETER_ILLEGAL", "PERMISSION_DENIED", "SYSTEM_ERROR", "ENTERPRISE_TITLE_EXISTS", "ENTERPRISE_TITLE_EXCEED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceEnterpriseexctrlEmployertitleCreateModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户id，与enterprise_id两者必填其一", "example" : "2088xxxxxx" }, "address" : { "type" : "string", "description" : "详细地址", "example" : "***省***市****区" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "9900000000000" }, "bank_account" : { "type" : "string", "description" : "开户行账号", "example" : "622000********" }, "bank_name" : { "type" : "string", "description" : "开户行名称", "example" : "******" }, "enterprise_id" : { "type" : "string", "description" : "企业id，与account_id两者必填其一", "example" : "2088xxxxxx" }, "tax_register_no" : { "type" : "string", "description" : "税号", "example" : "********" }, "telephone" : { "type" : "string", "description" : "电话", "example" : "0739-56*****" }, "title_name" : { "type" : "string", "description" : "企业抬头名称", "example" : "*****有限公司" } } }, "AlipayEbppInvoiceEnterpriseexctrlEmployertitleCreateResponseModel" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "返回码\t10000-成功\t其他都是失败", "example" : "10000" }, "msg" : { "type" : "string", "description" : "返回消息", "example" : "成功" }, "success" : { "type" : "boolean", "description" : "是否成功", "example" : "true" }, "title_id" : { "type" : "string", "description" : "抬头ID", "example" : "2021090100152710300000000729" } } }, "AlipayEbppInvoiceEnterpriseexctrlEmployertitleModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMETER_ILLEGAL", "SYSTEM_ERROR", "PERMISSION_DENIED", "ENTERPRISE_TITLE_EXISTS", "ENTERPRISE_TITLE_NOT_EXISTS" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceEnterpriseexctrlEmployertitleModifyModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户id，与enterprise_id两者必填其一", "example" : "2088xxxxxx" }, "address" : { "type" : "string", "description" : "详细地址", "example" : "***省***市****区" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "9900000000000" }, "bank_account" : { "type" : "string", "description" : "开户行账号", "example" : "622000********" }, "bank_name" : { "type" : "string", "description" : "开户行", "example" : "******" }, "enterprise_id" : { "type" : "string", "description" : "企业id，与account_id两者必填其一", "example" : "2088xxxxxx" }, "tax_register_no" : { "type" : "string", "description" : "税号", "example" : "20" }, "telephone" : { "type" : "string", "description" : "电话", "example" : "0739-56*****" }, "title_id" : { "type" : "string", "description" : "抬头ID", "example" : "****" }, "title_name" : { "type" : "string", "description" : "企业抬头名称", "example" : "*****有限公司" } } }, "AlipayEbppInvoiceEnterpriseexctrlEmployertitleModifyResponseModel" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "返回码\t10000-成功\t其他都是失败", "example" : "10000" }, "msg" : { "type" : "string", "description" : "返回信息", "example" : "成功" }, "success" : { "type" : "boolean", "description" : "是否成功", "example" : "true" }, "title_id" : { "type" : "string", "description" : "抬头ID", "example" : "2021090100152710300000000731" } } }, "AlipayEbppInvoiceEnterpriseexctrlEmployertitleQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PERMISSION_DENIED", "SYSTEM_ERROR", "PARAMETER_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceEnterpriseexctrlEmployertitleQueryResponseModel" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "返回码\t10000-成功\t其他都是失败", "example" : "10000" }, "msg" : { "type" : "string", "description" : "返回消息", "example" : "成功" }, "title_info" : { "$ref" : "#/components/schemas/EnterpriseTitleInfo" } } }, "AlipayEbppInvoiceExpenseProgressSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVOICE_NOT_EXIST", "INVOICE_EXPENSE_STATUS_REPEAT", "PERMISSION_DENIED", "EXPENSE_INVOICE_DETAIL_URL_CHECK", "INVOICE_HAVE_PROCESSING_EXPENSE", "INVOICE_HAVE_EXPENSE", "EXPENSE_ORDER_NO_DISAGREE", "EXPENSE_INVOICE_DISABLE", "EXPENSE_NOT_REACH_PROCESSING", "EXPENSE_APPLY_ID_REPEAT", "PARAMETER_ILLEGAL", "EXPENSE_BUSINESS_TIME_ERROR", "SYSTEM_ERROR", "QUERY_TAX_NO_NOT_EQUAL_CERTIFY_NO", "PRODUCT_IS_EMPTY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceExpenseProgressSyncModel" : { "type" : "object", "properties" : { "apply_id" : { "type" : "string", "description" : "同步申请id，每次发起同步时生成，isv每次请求需要保证唯一", "example" : "BxpO0dtPbcLLpwD8h5H47ehQXkBdI" }, "business_time" : { "type" : "string", "description" : "报销状态变更执行时间", "example" : "2017-08-14 10:10:00" }, "expense_detail_url" : { "type" : "string", "description" : "报销详情地址，提供用户通过发票管家查看报销进度的地址\r\t如果报销企业入驻发票管家时需要isv传入报销详情地址，则必须提供", "example" : "http://www.baidu.com" }, "expense_order_no" : { "type" : "string", "description" : "报销单据号", "example" : "123" }, "expense_tax_no" : { "type" : "string", "description" : "报销企业税号", "example" : "123456" }, "invoice_code" : { "type" : "string", "description" : "发票代码", "example" : "1234567890" }, "invoice_no" : { "type" : "string", "description" : "发票号码", "example" : "12345678" }, "memo" : { "type" : "string", "description" : "备注", "example" : "财务已打款" }, "open_id" : { "type" : "string", "description" : "open_id，支付宝用户id", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "status" : { "type" : "string", "description" : "报销操作。枚举值如下：\t*EXPENSE_APPLY：用户已提交申请。*EXPENSE_APPROVAL_PASS：报销审核通过。\t*EXPENSE_FINISHED：报销完结。\t*EXPENSE_CANCEL：报销撤回。", "example" : "EXPENSE_APPLY" }, "user_id" : { "type" : "string", "description" : "发票归属用户 id，用户在支付宝的唯一标识，以 2088 开头的 16 位纯数字组成。", "example" : "20880000000000000" } } }, "AlipayEbppInvoiceExpenseProgressSyncResponseModel" : { "type" : "object" }, "AlipayEbppInvoiceExpensecomsueOutsourceNotifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "PERMISSION_DENIED", "WORK_NO_NOT_FIND", "QUOTA_DEAL_ERROR", "PLATFORM_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceExpensecomsueOutsourceNotifyModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业共同账户id", "example" : "2088000194958956" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "amount" : { "type" : "integer", "description" : "消费金额", "example" : "200" }, "deal_time" : { "type" : "string", "description" : "交易发生时间", "example" : "2021-01-01 12:00:00" }, "employee_id" : { "type" : "string", "description" : "员工id", "example" : "2088210888827370" }, "employee_id_type" : { "type" : "integer", "description" : "员工账号类型", "example" : "0" }, "employee_open_id" : { "type" : "string", "description" : "员工开放id", "example" : "abcdxxxx" }, "enterprise_id" : { "type" : "string", "description" : "企业id", "example" : "2088000194958956" }, "extend" : { "type" : "string", "description" : "拓展参数", "example" : "{\\\"adcode\\\":\\\"310000\\\"}" }, "is_off_set" : { "type" : "integer", "description" : "交易类型", "example" : "0" }, "out_source_id" : { "type" : "string", "description" : "外部交易支付单号", "example" : "TN00000000000001" }, "platform" : { "type" : "string", "description" : "外部平台编码", "example" : "DAO_AN" }, "relate_no" : { "type" : "string", "description" : "外部交易退款单号", "example" : "200222222222" }, "standard_id" : { "type" : "string", "description" : "费控规则ID", "example" : "2021082700152601730000003677" } } }, "AlipayEbppInvoiceExpensecomsueOutsourceNotifyResponseModel" : { "type" : "object", "properties" : { "success" : { "type" : "boolean", "description" : "是否成功", "example" : "true" } } }, "AlipayEbppInvoiceExpensecontrolAggregationCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceExpensecontrolAggregationCreateModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业ID", "example" : "2088000194958956" }, "aggregation_name" : { "type" : "string", "description" : "聚合关系名称\t特殊说明：敏感词校验", "example" : "测试聚合关系" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "standard_id_list" : { "type" : "array", "description" : "费控规则ID列表", "items" : { "type" : "string" }, "example" : "[\"2021082700152601730000003677\",\"2021082700152601730000003679\"]" } } }, "AlipayEbppInvoiceExpensecontrolAggregationCreateResponseModel" : { "type" : "object", "properties" : { "aggregation_id" : { "type" : "string", "description" : "费控聚合关系ID", "example" : "2021082700152602730000003677" } } }, "AlipayEbppInvoiceExpensecontrolEmployeequotaCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED", "QUOTA_EXISTS", "NO_RULE_AVAILABLE", "REQUEST_REPEAT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceExpensecontrolEmployeequotaCreateModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账号ID", "example" : "2088000194958956" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "effective_end_date" : { "type" : "string", "description" : "余额失效时间（默认有效期100年）", "example" : "2021-10-01 00:00:00" }, "effective_start_date" : { "type" : "string", "description" : "余额生效时间(默认当前时间)", "example" : "2021-01-01 00:00:00" }, "outer_source_id" : { "type" : "string", "description" : "外部操作幂等ID（接入方接口调用幂等控制ID）", "example" : "TN00000000000001" }, "owner_id" : { "type" : "string", "description" : "切换open_id前请使用：余额所属者ID\towner_type为员工时为员工支付宝ID", "example" : "2088210888827370" }, "owner_open_id" : { "type" : "string", "description" : "切换open_id后请使用：余额所属者ID owner_type为员工时为员工open_id", "example" : "abcdxxxx" }, "owner_type" : { "type" : "string", "description" : "余额所属者类型\tEMPLOYEE: 员工", "example" : "EMPLOYEE" }, "platform" : { "type" : "string", "description" : "外部平台编码（通常为接入方大写英文缩写）", "example" : "RJ" }, "quota_model" : { "type" : "string", "description" : "余额同步模式，默认 DEFAULT_STANDARD", "example" : "DEFAULT_STANDARD" }, "quota_value" : { "type" : "string", "description" : "余额，以（分）为单位\t特殊说明：余额不超过100000元", "example" : "10" } } }, "AlipayEbppInvoiceExpensecontrolEmployeequotaCreateResponseModel" : { "type" : "object", "properties" : { "quota_id" : { "type" : "string", "description" : "新增的余额ID", "example" : "2021062800152601350000001468" } } }, "AlipayEbppInvoiceExpensecontrolIssuebatchCancelErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "ISSUE_BATCH_IS_INVALID", "ISSUE_BATCH_REVOKING", "ISSUE_BATCH_IN_PROGRESS", "PERMISSION_DENIED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceExpensecontrolIssuebatchCancelModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户id", "example" : "2088000194958956" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "enterprise_id" : { "type" : "string", "description" : "企业ID", "example" : "2088000194958956" }, "institution_id" : { "type" : "string", "description" : "制度id", "example" : "2022070500152608330000012007" }, "issue_batch_id" : { "type" : "string", "description" : "发放批次id", "example" : "2022062800152622440000009966" } } }, "AlipayEbppInvoiceExpensecontrolIssuebatchCancelResponseModel" : { "type" : "object", "properties" : { "result" : { "type" : "boolean", "description" : "是否成功", "example" : "true" } } }, "AlipayEbppInvoiceExpensecontrolIssuebatchCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "ISSUE_NAME_DUPLICATE", "ISSUE_BATCH_NO_DUPLICATE", "EMPLOYEE_NOT_IN_INSTITUTION_SCOPE", "BUSINESS_VALIDATE_ERROR", "INSTITUTION_START_DATE_NOT_REACHED", "PERMISSION_DENIED", "INSTITUTION_IS_INVALID", "INSTITUTION_ACTIVE_DATE_NOT_REACHED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceExpensecontrolIssuebatchCreateModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户id", "example" : "2088000194958956" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "batch_no" : { "type" : "string", "description" : "发放批次号，用于幂等校验本次发放", "example" : "2022062800152622440000009966" }, "effective_end_date" : { "type" : "string", "description" : "额度有效结束时间", "example" : "2021-01-01 12:00:00" }, "effective_start_date" : { "type" : "string", "description" : "额度有效起始时间", "example" : "2021-01-01 12:00:00" }, "enterprise_id" : { "type" : "string", "description" : "企业ID", "example" : "2088000194958956" }, "institution_id" : { "type" : "string", "description" : "制度id", "example" : "2022052000152618690000000005" }, "issue_desc" : { "type" : "string", "description" : "发放说明", "example" : "发放餐补" }, "issue_name" : { "type" : "string", "description" : "发放名称", "example" : "发放餐补" }, "issue_target_info_list" : { "type" : "array", "description" : "员工发放信息列表", "items" : { "$ref" : "#/components/schemas/IssueTargetInfoContent" } }, "quota_type" : { "type" : "string", "description" : "额度类型", "example" : "COUPON" }, "share_mode" : { "type" : "string", "description" : "是否可转赠", "example" : "1" } } }, "AlipayEbppInvoiceExpensecontrolIssuebatchCreateResponseModel" : { "type" : "object", "properties" : { "issue_batch_id" : { "type" : "string", "description" : "发放批次id", "example" : "2022070500152622690000017754" }, "issue_quota_check_failed_list" : { "type" : "array", "description" : "校验失败的数据", "items" : { "$ref" : "#/components/schemas/IssueQuotaCheckInfo" } } } }, "AlipayEbppInvoiceExpensecontrolQuotaCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED", "QUOTA_EXISTS", "REQUEST_REPEAT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceExpensecontrolQuotaCreateModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账号id", "example" : "2088000194958956" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "effective_end_date" : { "type" : "string", "description" : "额度失效时间（格式：yyyy-MM-dd HH:mm:ss）", "example" : "2021-10-01 00:00:00" }, "effective_start_date" : { "type" : "string", "description" : "额度生效时间（格式：yyyy-MM-dd HH:mm:ss）", "example" : "2021-01-01 00:00:00" }, "enterprise_id" : { "type" : "string", "description" : "企业ID", "example" : "2088000194958956" }, "outer_source_id" : { "type" : "string", "description" : "外部操作幂等ID（接入方接口调用幂等控制ID）", "example" : "TN00000000000001" }, "owner_id" : { "type" : "string", "description" : "额度所属者ID（未切换open_id请使用此字段）：", "example" : "2088210888827370" }, "owner_open_id" : { "type" : "string", "description" : "额度所属者ID（切换open_id后请使用此字段）：", "example" : "2088210888827370" }, "owner_type" : { "type" : "string", "description" : "额度所属者类型", "example" : "EMPLOYEE" }, "platform" : { "type" : "string", "description" : "外部平台编码（通常为接入方大写英文缩写）", "example" : "RJ" }, "quota_type" : { "type" : "string", "description" : "创建额度类型", "example" : "COUPON" }, "quota_value" : { "type" : "string", "description" : "额度值，以（分）为单位", "example" : "50" }, "share_mode" : { "type" : "string", "description" : "0:不可转赠\t1:可以转增", "example" : "0" }, "target_id" : { "type" : "string", "description" : "额度维度ID", "example" : "MEAL" }, "target_type" : { "type" : "string", "description" : "额度维度\t枚举值：\tEXPENSE_TYPE（费用类型维度），\tRULE_GROUP_AGGREGATION（规则聚合维度），\tINSTITUTION（制度维度）", "example" : "EXPENSE_TYPE" } } }, "AlipayEbppInvoiceExpensecontrolQuotaCreateResponseModel" : { "type" : "object", "properties" : { "quota_id" : { "type" : "string", "description" : "新增的额度ID", "example" : "1234" } } }, "AlipayEbppInvoiceExpensecontrolQuotaModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED", "QUOTA_LOCKED", "QUOTA_INSUFFICIENT", "QUOTA_NO_EXISTS", "REQUEST_REPEAT", "QUOTA_EXCEED", "QUOTA_TYPE_NOT_MODIFY", "QUOTA_USED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceExpensecontrolQuotaModifyModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业共同账户ID", "example" : "2088000194958956" }, "action" : { "type" : "string", "description" : "变更模式", "example" : "ADD" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "amount" : { "type" : "string", "description" : "变更的金额/余额，以（分）为单位", "example" : "10" }, "enterprise_id" : { "type" : "string", "description" : "企业ID", "example" : "2088000194958956" }, "outer_source_id" : { "type" : "string", "description" : "外部操作幂等ID（接入方接口调用幂等控制ID）", "example" : "TN00000000000001" }, "platform" : { "type" : "string", "description" : "外部平台编码", "example" : "RJ" }, "quota_id" : { "type" : "string", "description" : "额度ID", "example" : "2021062800152601350000001468" } } }, "AlipayEbppInvoiceExpensecontrolQuotaModifyResponseModel" : { "type" : "object", "properties" : { "success" : { "type" : "boolean", "description" : "是否成功", "example" : "true" } } }, "AlipayEbppInvoiceExpensecontrolQuotaQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceExpensecontrolQuotaQueryModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业共同账户ID", "example" : "2088000194958956" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "enterprise_id" : { "type" : "string", "description" : "企业id", "example" : "2088000194958956" }, "owner_id" : { "type" : "string", "description" : "额度所属者ID", "example" : "2088210888827370" }, "owner_open_id" : { "type" : "string", "description" : "额度所属者开放ID", "example" : "abcdxxxx" }, "owner_type" : { "type" : "string", "description" : "额度所属者类型", "example" : "EMPLOYEE" }, "page_num" : { "type" : "integer", "description" : "页码", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "每页条数", "example" : "20" }, "quota_id_list" : { "type" : "array", "description" : "额度ID列表", "items" : { "type" : "string" }, "example" : "[\"2021062xxx\"]" }, "target_id" : { "type" : "string", "description" : "额度维度ID", "example" : "MEAL" }, "target_type" : { "type" : "string", "description" : "额度维度", "example" : "EXPENSE_TYPE" } } }, "AlipayEbppInvoiceExpensecontrolQuotaQueryResponseModel" : { "type" : "object", "properties" : { "expense_quota_info_list" : { "type" : "array", "description" : "额度列表", "items" : { "$ref" : "#/components/schemas/ExpenseQuotaInfo" } }, "page_num" : { "type" : "integer", "description" : "当前页数", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "当前记录数", "example" : "20" }, "total_page_count" : { "type" : "integer", "description" : "总页数", "example" : "5" } } }, "AlipayEbppInvoiceExpenserulesEmployeeQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceExpenserulesEmployeeQueryResponseModel" : { "type" : "object", "properties" : { "employee_list" : { "type" : "array", "description" : "切换open_id前请使用此字段：员工列表", "items" : { "type" : "string" }, "example" : "[\"2088402331504664\",\"2088402331504664\",\"2088402331504664\"]" }, "employee_open_id_list" : { "type" : "array", "description" : "切换open_id后请使用此字段：员工open_id列表", "items" : { "type" : "string" }, "example" : "[\"abcdxxxx\"]" }, "page_num" : { "type" : "integer", "description" : "当前页数", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "当前记录数", "example" : "20" }, "total_page_count" : { "type" : "integer", "description" : "总页数", "example" : "100" } } }, "AlipayEbppInvoiceExpenserulesEmployeerulesQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PERMISSION_DENIED", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceExpenserulesEmployeerulesQueryResponseModel" : { "type" : "object", "properties" : { "employee_rules" : { "type" : "array", "description" : "员工已绑定费控规则列表", "items" : { "$ref" : "#/components/schemas/ExpenseCtrlEmployeeRuleInfo" } }, "page_num" : { "type" : "integer", "description" : "客户端输入的页码", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "客户端输入的每页行数", "example" : "20" }, "total_count" : { "type" : "integer", "description" : "查询到的实例总数", "example" : "100" } } }, "AlipayEbppInvoiceExpenserulesGroupemployeeModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "GROUP_NOT_EXIST", "PERMISSION_DENIED", "EMPLOYEE_MAX_RULE_COUNT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceExpenserulesGroupemployeeModifyModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业共同账户id", "example" : "2088000194958956" }, "add_employee_list" : { "type" : "array", "description" : "未切换 open_id 时请使用此字段：\t需要添加的员工UID列表\t特殊说明：一次最多50个", "items" : { "type" : "string" }, "example" : "[\"2088402266061144\",\"2088402266063146\"]" }, "add_employee_open_id_list" : { "type" : "array", "description" : "切换 open_id 后请使用此字段：\t需要添加的open_id/企业码员工ID列表 特殊说明：一次最多50个", "items" : { "type" : "string" }, "example" : "[\"abcdxxx\"]" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "enterprise_id" : { "type" : "string", "description" : "企业码企业id", "example" : "2088000194958956" }, "group_id_list" : { "type" : "array", "description" : "费控规则ID列表", "items" : { "type" : "string" }, "example" : "[\"2021062800152601350000001466\"]" }, "remove_employee_list" : { "type" : "array", "description" : "未切换 open_id 时请使用此字段：\t需要移除的员工UID列表\t特殊说明：一次最多50个", "items" : { "type" : "string" }, "example" : "[\"2088402266062862\",\"2088402266060390\"]" }, "remove_employee_open_id_list" : { "type" : "array", "description" : "切换 open_id 后请使用此字段：\t需要移除的open_id/企业码员工ID列表 特殊说明：一次最多50个", "items" : { "type" : "string" }, "example" : "[\"abcdxxx\"]" } } }, "AlipayEbppInvoiceExpenserulesGroupemployeeModifyResponseModel" : { "type" : "object", "properties" : { "success" : { "type" : "boolean", "description" : "是否成功", "example" : "true" } } }, "AlipayEbppInvoiceExpenserulesProjectemployeeModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PROJECT_NOT_EXIST", "EMPLOYEE_RULE_CONFLICT", "PERMISSION_DENIED", "EMPLOYEE_MAX_RULE_COUNT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceExpenserulesProjectemployeeModifyModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户ID", "example" : "2088000194958956" }, "add_employee_list" : { "type" : "array", "description" : "切换open_id前使用此字段：\t需要添加的员工UID列表\t约束：一次最多50个", "items" : { "type" : "string" }, "example" : "[\"2088402266061144\",\"2088402266063146\"]" }, "add_employee_open_id_list" : { "type" : "array", "description" : "切换open_id后使用此字段：\t需要添加的员工open_id列表\t约束：一次最多50个", "items" : { "type" : "string" }, "example" : "[\"abcdxxxx\"]" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "project_id" : { "type" : "string", "description" : "项目ID", "example" : "2021040900152700950000000862" }, "remove_employee_list" : { "type" : "array", "description" : "切换open_id前使用此字段：\t需要移除的员工UID列表\t约束：一次最多50个", "items" : { "type" : "string" }, "example" : "[\"2088402266062862\",\"2088402266060390\"]" }, "remove_employee_open_id_list" : { "type" : "array", "description" : "切换open_id后前使用此字段： 需要移除的员工open_id列表 约束：一次最多50个", "items" : { "type" : "string" }, "example" : "[\"abcdxxxx\"]" } } }, "AlipayEbppInvoiceExpenserulesProjectemployeeModifyResponseModel" : { "type" : "object", "properties" : { "success" : { "type" : "boolean", "description" : "是否成功", "example" : "true" } } }, "AlipayEbppInvoiceExpenserulesProjectinfoModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED", "PROJECT_NOT_EXIST", "PROJECT_NAME_EXIST_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceExpenserulesProjectinfoModifyModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业ID", "example" : "2088000166192438" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425123412341234" }, "effective_end_date" : { "type" : "string", "description" : "有效期截止（yyyy-MM-dd HH:mm:ss）\t特殊说明：\t1）与起始时间必须同时传，且大于起始时间\t2）不传则默认不修改", "example" : "2021-04-30 23:59:59" }, "effective_start_date" : { "type" : "string", "description" : "有效期起始（yyyy-MM-dd HH:mm:ss）\t特殊说明：\t1）与截止时间必须同时传，且小于截止时间\t2）不传入则默认不修改", "example" : "2020-04-01 00:00:00" }, "project_id" : { "type" : "string", "description" : "项目ID", "example" : "2021041500152700430000004790" }, "project_name" : { "type" : "string", "description" : "项目名\t特殊说明：不传入则默认不修改", "example" : "修改项目名" } } }, "AlipayEbppInvoiceExpenserulesProjectinfoModifyResponseModel" : { "type" : "object", "properties" : { "success" : { "type" : "boolean", "description" : "是否成功", "example" : "true" } } }, "AlipayEbppInvoiceExpenserulesProjectruleCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED", "EMPLOYEE_LIST_ERROR", "PROJECT_NAME_EXIST_ERROR", "EMPLOYEE_CNT_LIMIT_ERROR", "EMPLOYEE_RULE_CONFLICT", "EXPENSE_RULE_CREATE_FAIL", "GROUP_NAME_EXIST", "EMPLOYEE_MAX_RULE_COUNT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceExpenserulesProjectruleCreateModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户id", "example" : "2088000194958956" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "effective_end_date" : { "type" : "string", "description" : "有效期截止（yyyy-MM-dd HH:mm:ss，必须大于起始时间）", "example" : "2021-03-01 00:00:00" }, "effective_start_date" : { "type" : "string", "description" : "有效期起始（yyyy-MM-dd HH:mm:ss，必须小于截止时间）", "example" : "2021-03-01 00:00:00" }, "employee_list" : { "type" : "array", "description" : "切换open_id前使用此字段：员工支付宝ID列表\t特殊说明：单次传入的最大员工数为50，后续通过修改项目的员工列表接口进行员工调整", "items" : { "type" : "string" }, "example" : "[\"2088123412341234\",\"2088123412342234\"]" }, "employee_open_id_list" : { "type" : "array", "description" : "切换open_id后使用此字段：员工open_id列表 特殊说明：单次传入的最大员工数为50，后续通过修改项目的员工列表接口进行员工调整", "items" : { "type" : "string" }, "example" : "[\"abcdxxxx\"]" }, "expense_ctrl_rule_info_group_list" : { "type" : "array", "description" : "费控规则列表", "items" : { "$ref" : "#/components/schemas/ExpenseCtrRuleGroupInfo" } }, "project_name" : { "type" : "string", "description" : "项目名称\t约束：\t1）敏感词校验\t2）不能重复", "example" : "项目" } } }, "AlipayEbppInvoiceExpenserulesProjectruleCreateResponseModel" : { "type" : "object", "properties" : { "project_id" : { "type" : "string", "description" : "项目ID", "example" : "2021070700152700030000000681" } } }, "AlipayEbppInvoiceExpenserulesProjectruleQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED", "PROJECT_NOT_EXIST_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceExpenserulesProjectruleQueryResponseModel" : { "type" : "object", "properties" : { "page_num" : { "type" : "string", "description" : "当前页数", "example" : "1" }, "page_size" : { "type" : "string", "description" : "当前记录数", "example" : "10" }, "project_rule_info_list" : { "type" : "array", "description" : "项目规则列表", "items" : { "$ref" : "#/components/schemas/ProjectRuleInfo" } }, "total_count" : { "type" : "string", "description" : "总记录数", "example" : "50" }, "total_page_count" : { "type" : "string", "description" : "总页数", "example" : "1" } } }, "AlipayEbppInvoiceExpenserulesProjectrulesModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED", "PROJECT_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceExpenserulesProjectrulesModifyModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业ID", "example" : "2088000194958956" }, "action" : { "type" : "string", "description" : "修改操作\t枚举值：MODIFY_RULE（修改费控条件），仅支持MODIFY_RULE", "example" : "MODIFY_RULE" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "expense_ctrl_rule_info_group_list" : { "type" : "array", "description" : "费控规则列表", "items" : { "$ref" : "#/components/schemas/ExpenseCtrRuleGroupInfo" } }, "project_id" : { "type" : "string", "description" : "项目ID", "example" : "2021041300152700950000001050" } } }, "AlipayEbppInvoiceExpenserulesProjectrulesModifyResponseModel" : { "type" : "object", "properties" : { "success" : { "type" : "string", "description" : "是否成功", "example" : "true" } } }, "AlipayEbppInvoiceExpenserulesSceneruleCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED", "STANDARD_NAME_EXIST_ERROR", "EMPLOYEE_CNT_LIMIT_ERROR", "EXPENSE_RULE_CREATE_FAIL", "EMPLOYEE_MAX_RULE_COUNT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceExpenserulesSceneruleCreateModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账号ID", "example" : "2088000194958956" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "effective_end_date" : { "type" : "string", "description" : "有效期截止", "example" : "2021-08-27 00:00:00" }, "effective_start_date" : { "type" : "string", "description" : "有效期起始", "example" : "2021-08-26 00:00:00" }, "employee_list" : { "type" : "array", "description" : "切换open_id前请使用：员工支付宝uid列表\t特殊说明：单次传入的最大员工数为50，后续通过修改费控规则员工接口进行员工调整", "items" : { "type" : "string" }, "example" : "[\"2088210888827370\"]" }, "employee_open_id_list" : { "type" : "array", "description" : "切换open_id后请使用：员工open_id/企业码员工ID列表 特殊说明：单次传入的最大员工数为50，后续通过修改费控规则员工接口进行员工调整", "items" : { "type" : "string" }, "example" : "[\"abcdxxxx\"]" }, "enterprise_id" : { "type" : "string", "description" : "企业码企业id", "example" : "2088000194958956" }, "expense_ctrl_rule_info_list" : { "type" : "array", "description" : "费控条件列表\t特殊说明：\t1）至少存在日额度（QUOTA_DAY）、月额度（QUOTA_MONTH）、有效期总额度（QUOTA_TOTAL）三者中的一个额度条件；\t2）如果费用类型为MEAL，费控维度商户（MEAL_MERCHANT）和商户类型（MCC）对应的费控条件必须存在其一且不能同时存在；\t3）如果费用类型为METRO，费控维度地铁卡类型（CARD_TYPE）对应的费控条件必须存在；\t4）如果因公场景为OVERTIME，费控维度时间段（ALARM_CLOCK_TIME）对应的费控条件必须存在；\t5）不能存在重复的费控维度对应的费控条件；\t6）非MEAL费用类型，商户仅支持MERCHANT，不支持MEAL_MERCHANT", "items" : { "$ref" : "#/components/schemas/ExpenseCtrRuleInfo" } }, "expense_type" : { "type" : "string", "description" : "费用类型\t枚举值：MEAL（餐饮），METRO（地铁）", "example" : "MEAL" }, "payment_policy" : { "type" : "string", "description" : "当笔消费金额大于规则可用余额时，用于控制支付策略，该字段缺省时采取因公账户和个人账户组合支付策略， 枚举值：PERSONAL（全部个人账户支付）, COMBINATION（因公账户和个人账户组合支付）", "example" : "PERSONAL" }, "scene_type" : { "type" : "string", "description" : "因公场景\t枚举值：OVERTIME（加班），SUBSIDY（补贴福利），TRAVEL（差旅）", "example" : "OVERTIME" }, "standard_desc" : { "type" : "string", "description" : "费控规则说明\t特殊说明：敏感词校验", "example" : "福利餐费控规则说明" }, "standard_name" : { "type" : "string", "description" : "费控规则名称\t特殊说明：\t1）敏感词校验\t2）不能重复，若需要重复联系支持人员定向放开", "example" : "福利餐费控规则" } } }, "AlipayEbppInvoiceExpenserulesSceneruleCreateResponseModel" : { "type" : "object", "properties" : { "standard_id" : { "type" : "string", "description" : "费控规则ID", "example" : "2021091000152601200000006167" } } }, "AlipayEbppInvoiceExpenserulesSceneruleModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED", "STANDARD_EXIST_ERROR", "STANDARD_NAME_EXIST_ERROR", "EXPENSE_RULE_CREATE_FAIL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceExpenserulesSceneruleModifyModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业ID", "example" : "2088000194958956" }, "action" : { "type" : "string", "description" : "修改操作\t枚举值：\tADD_RULE（新增费控条件），DELETE_RULE（删除费控条件），MODIFY_RULE（修改费控条件），MODIFY_STANDARD（修改费控规则基本信息）", "example" : "ADD_RULE" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "effective_end_date" : { "type" : "string", "description" : "有效期截止\t特殊说明：修改费控规则基本信息时必传", "example" : "2021-08-27 00:00:00" }, "effective_start_date" : { "type" : "string", "description" : "有效期起始\t特殊说明：修改费控规则基本信息时必传", "example" : "2021-08-26 00:00:00" }, "enterprise_id" : { "type" : "string", "description" : "企业码企业id", "example" : "2088000194958956" }, "expense_ctrl_rule_info_list" : { "type" : "array", "description" : "费控规则条件列表 特殊说明：新增费控条件/修改费控条件/删除费控条件操作时必填", "items" : { "$ref" : "#/components/schemas/ExpenseCtrRuleInfo" } }, "payment_policy" : { "type" : "string", "description" : "当笔消费金额大于规则可用余额时，用于控制支付策略，该字段缺省时采取因公账户和个人账户组合支付策略， 枚举值：PERSONAL（全部个人账户支付）, COMBINATION（因公账户和个人账户组合支付）", "example" : "PERSONAL" }, "standard_desc" : { "type" : "string", "description" : "费控规则说明\t特殊说明：\t1）敏感词校验\t2）修改费控规则基本信息时必传", "example" : "费控规则说明" }, "standard_id" : { "type" : "string", "description" : "费控规则ID", "example" : "2021062800152601350000001466" }, "standard_name" : { "type" : "string", "description" : "费控规则名称\t特殊说明：\t1）敏感词校验\t2）修改费控规则基本信息时必传\t3）不能重复，若需要重复联系支持人员定向放开", "example" : "费控规则名称" } } }, "AlipayEbppInvoiceExpenserulesSceneruleModifyResponseModel" : { "type" : "object", "properties" : { "success" : { "type" : "boolean", "description" : "是否成功", "example" : "true" } } }, "AlipayEbppInvoiceExpenserulesSceneruleQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMETER_ILLEGAL", "SYSTEM_ERROR", "PERMISSION_DENIED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceExpenserulesSceneruleQueryResponseModel" : { "type" : "object", "properties" : { "page_num" : { "type" : "integer", "description" : "当前页数", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "当前记录数", "example" : "10" }, "standard_rule_info_list" : { "type" : "array", "description" : "费控规则列表", "items" : { "$ref" : "#/components/schemas/StandardRuleInfo" } }, "total_page_count" : { "type" : "integer", "description" : "总页数", "example" : "10" } } }, "AlipayEbppInvoiceExpensesceneMerchantQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED", "PARAMETER_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceExpensesceneMerchantQueryResponseModel" : { "type" : "object", "properties" : { "expense_merchant_info_list" : { "type" : "array", "description" : "商户信息", "items" : { "$ref" : "#/components/schemas/ExpenseMerchantInfo" } }, "page_num" : { "type" : "integer", "description" : "当前页数", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "当前记录数", "example" : "20" }, "total_page_count" : { "type" : "integer", "description" : "总页数", "example" : "3" } } }, "AlipayEbppInvoiceFileOutputQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVOICE_NOT_EXIST", "INVOICE_QUERY_DENY", "SYSTEM_ERROR", "PARAMETER_ILLEGAL", "PDF_NOT_EXIST", "QUERY_TAX_NO_NOT_EQUAL_CERTIFY_NO" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceFileOutputQueryResponseModel" : { "type" : "object", "properties" : { "file_type" : { "type" : "string", "description" : "发票文件类型pdf或ofd", "example" : "pdf" }, "invoice_file_content" : { "type" : "string", "description" : "发票文件内容,需要先base64解码，获取原始byte[]类型文件流", "example" : "SEWHBFR2GKMBJNY52JBM56N" } } }, "AlipayEbppInvoiceInfoSendErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "MERCHANT_NOT_SUPPORT", "BIZ_ERROR", "RECORD_ALREADY_EXIST", "INVOICE_INFOSEC_CHECK_FAIL", "COLLECTION_NON_USER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceInfoSendModel" : { "type" : "object", "properties" : { "invoice_info_list" : { "type" : "array", "description" : "发票信息列表", "items" : { "$ref" : "#/components/schemas/InvoiceSendOpenModel" } }, "m_short_name" : { "type" : "string", "description" : "开票商户品牌简称，与商户入驻时的品牌简称保持一致。", "example" : "XSD" }, "sub_m_short_name" : { "type" : "string", "description" : "开票商户球房简称，与商户入驻时的球房简称保持一致。", "example" : "XSD_HL" } } }, "AlipayEbppInvoiceInfoSendResponseModel" : { "type" : "object", "properties" : { "url" : { "type" : "string", "description" : "发票访问地址，同步红票的情况下不返回该字段，同步蓝票的情况下如果同步单张发票，返回发票详情链接地址，如果同步的是多张发票，返回发票列表地址", "example" : "alipays://platformapi/startapp?appId=20000920&url=%2Fwww%2Flist.htm%3Ffrom%3Doffline" } } }, "AlipayEbppInvoiceInstitutionCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED", "INSTITUTION_CREATE_FAIL", "ENTERPRISE_SYNC_EXTERIOR_EXCEPTION" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceInstitutionCreateModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业共同账户id", "example" : "2088000194958956" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20225415889003553" }, "consult_mode" : { "type" : "string", "description" : "费控咨询模式，默认为0。", "example" : "0" }, "effective_end_date" : { "type" : "string", "description" : "制度生效结束时间", "example" : "2022-09-30 23:59:59" }, "effective_start_date" : { "type" : "string", "description" : "制度生效起始时间", "example" : "2022-09-10 00:00:00" }, "enterprise_id" : { "type" : "string", "description" : "企业id", "example" : "2088123412341234" }, "expense_type" : { "type" : "string", "description" : "费用类型", "example" : "MEAL" }, "institution_desc" : { "type" : "string", "description" : "制度描述", "example" : "餐补制度" }, "institution_name" : { "type" : "string", "description" : "制度名称", "example" : "费用制度" }, "issue_rule_info_list" : { "type" : "array", "description" : "发放规则列表", "items" : { "$ref" : "#/components/schemas/IssueRuleInfo" } }, "scene_type" : { "type" : "string", "description" : "因公场景", "example" : "OVERTIME" }, "standard_info_list" : { "type" : "array", "description" : "使用规则列表", "items" : { "$ref" : "#/components/schemas/StandardInfo" } } } }, "AlipayEbppInvoiceInstitutionCreateResponseModel" : { "type" : "object", "properties" : { "institution_id" : { "type" : "string", "description" : "制度id", "example" : "2022031000152617000000000001" }, "issue_rule_id_info_list" : { "type" : "array", "description" : "发放规则id列表", "items" : { "$ref" : "#/components/schemas/IssueRuleIdInfo" } }, "standard_id_info_list" : { "type" : "array", "description" : "使用规则id列表", "items" : { "$ref" : "#/components/schemas/StandardIdInfo" } } } }, "AlipayEbppInvoiceInstitutionDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED", "INSTITUTION_NOT_EXIST_ERROR", "INSTITUTION_DELETE_FAIL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceInstitutionDeleteResponseModel" : { "type" : "object", "properties" : { "result" : { "type" : "boolean", "description" : "删除结果是否成功", "example" : "true" } } }, "AlipayEbppInvoiceInstitutionDetailinfoQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED", "INSTITUTION_NOT_EXIST_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceInstitutionDetailinfoQueryResponseModel" : { "type" : "object", "properties" : { "consult_mode" : { "type" : "string", "description" : "费控咨询模式", "example" : "0" }, "effective" : { "type" : "string", "description" : "制度启用停用状态", "example" : "0" }, "effective_end_date" : { "type" : "string", "description" : "制度生效结束时间", "example" : "2001-01-01 23:59:59" }, "effective_start_date" : { "type" : "string", "description" : "制度生效起始时间", "example" : "2000-01-01 00:00:00" }, "expense_type" : { "type" : "string", "description" : "费用类型", "example" : "MEAL" }, "institution_desc" : { "type" : "string", "description" : "制度描述", "example" : "工作餐制度" }, "institution_id" : { "type" : "string", "description" : "制度id", "example" : "2023042600152617860000076700" }, "institution_name" : { "type" : "string", "description" : "制度名称", "example" : "餐补制度" }, "issue_rule_info_list" : { "type" : "array", "description" : "发放规则信息列表", "items" : { "$ref" : "#/components/schemas/IssueRuleInfo" } }, "scene_type" : { "type" : "string", "description" : "因公场景", "example" : "OVERTIME" }, "standard_info_detail_list" : { "type" : "array", "description" : "使用规则列表", "items" : { "$ref" : "#/components/schemas/StandardInfo" } }, "standard_info_list" : { "$ref" : "#/components/schemas/StandardInfo" } } }, "AlipayEbppInvoiceInstitutionExpenseruleCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED", "INSTITUTION_NOT_EXIST_ERROR", "BIND_INVOICE_RULE_FAILED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceInstitutionExpenseruleCreateModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业共同账户id，和授权签约协议号共同使用。", "example" : "2088000194958956" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号，可通过签约消息获取。配合企业共同账户id使用，当填写企业共同账户id时，此字段必填。", "example" : "20215425001112341234" }, "consume_mode" : { "type" : "string", "description" : "消费模式，该使用规则支持消费的资产类型，不填为默认模式，默认模式为优先消费余额，没有余额则根据规则中设置的限额控制消费金额", "example" : "DEFAULT" }, "enterprise_id" : { "type" : "string", "description" : "企业码id", "example" : "2088000194958956" }, "expense_ctrl_rule_info_list" : { "$ref" : "#/components/schemas/ExpenseCtrRuleInfo" }, "expense_type_sub_category" : { "type" : "string", "description" : "费用类型子类，当制度的费用类型为MEAL时，支持到店、外卖；当费用类型为非MEAL时，与费用类型保持一致", "example" : "TAKE_AWAY" }, "institution_id" : { "type" : "string", "description" : "制度id", "example" : "2022051900152617290000002725" }, "open_rule_id" : { "type" : "string", "description" : "开票规则id，若使用途径是外卖的使用规则需要开票，需要在创建使用规则时关联开票规则，后续变更关联开票规则不生效", "example" : "2022070600152721390000011371" }, "payment_policy" : { "type" : "string", "description" : "当笔消费金额大于规则可用余额时，用于控制支付策略，该字段缺省时采取因公账户和个人账户组合支付策略", "example" : "COMBINATION" }, "standard_condition_info_list" : { "type" : "array", "description" : "使用规则条件列表", "items" : { "$ref" : "#/components/schemas/StandardConditionInfo" } }, "standard_desc" : { "type" : "string", "description" : "使用规则描述(敏感词校验)", "example" : "福利餐说明" }, "standard_name" : { "type" : "string", "description" : "费控规则名称 特殊说明： 1）敏感词校验", "example" : "福利餐费控规则" } } }, "AlipayEbppInvoiceInstitutionExpenseruleCreateResponseModel" : { "type" : "object", "properties" : { "standard_id" : { "type" : "string", "description" : "使用规则id", "example" : "2022070600152617780000000001" } } }, "AlipayEbppInvoiceInstitutionExpenseruleDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED", "INSTITUTION_NOT_EXIST_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceInstitutionExpenseruleDeleteModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业共同账户id", "example" : "2088000194958956" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "enterprise_id" : { "type" : "string", "description" : "企业id", "example" : "2088000194958956" }, "institution_id" : { "type" : "string", "description" : "制度id", "example" : "2022070600152617780000000001" }, "standard_id_list" : { "type" : "array", "description" : "删除的使用规则id列表", "items" : { "type" : "string" }, "example" : "[\"2021062800152601350000001468\"]" } } }, "AlipayEbppInvoiceInstitutionExpenseruleDeleteResponseModel" : { "type" : "object", "properties" : { "result" : { "type" : "boolean", "description" : "删除是否成功", "example" : "true" } } }, "AlipayEbppInvoiceInstitutionExpenseruleModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED", "INSTITUTION_NOT_EXIST_ERROR", "EXPENSE_RULE_MODIFY_FAIL", "BIND_INVOICE_RULE_FAILED", "STANDARD_NOT_EXIST_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceInstitutionExpenseruleModifyModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业共同账户id", "example" : "2088000194958956" }, "action" : { "type" : "string", "description" : "修改使用规则", "example" : "MODIFY_BASIC_INFO" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "asset_share_source_info" : { "$ref" : "#/components/schemas/AssetShareSourceInfo" }, "consume_mode" : { "type" : "string", "description" : "该使用规则支持的资产消费模式，不填写则为默认模式，默认模式下有余额时使用余额，没有余额则使用规则中的限额，点券模式为只能使用点券，点券+余额模式为可以使用点券和余额。", "example" : "DEFAULT" }, "enterprise_id" : { "type" : "string", "description" : "企业id", "example" : "2088000194958956" }, "expense_ctrl_rule_info_list" : { "type" : "array", "description" : "使用规则条件列表（已废弃）", "items" : { "$ref" : "#/components/schemas/ExpenseCtrRuleInfo" } }, "institution_id" : { "type" : "string", "description" : "制度id", "example" : "2022070600152617780000000001" }, "open_rule_id" : { "type" : "string", "description" : "开票规则id", "example" : "2022070600152608780000000001" }, "payment_policy" : { "type" : "string", "description" : "当笔消费金额大于规则可用余额时，用于控制支付策略", "example" : "COMBINATION" }, "standard_condition_info_list" : { "type" : "array", "description" : "规则条件列表", "items" : { "$ref" : "#/components/schemas/StandardConditionInfo" } }, "standard_desc" : { "type" : "string", "description" : "规则描述", "example" : "当前规则为午餐餐补规则" }, "standard_id" : { "type" : "string", "description" : "使用规则id", "example" : "2022070600152621780000000001" }, "standard_name" : { "type" : "string", "description" : "规则名称", "example" : "午餐规则" } } }, "AlipayEbppInvoiceInstitutionExpenseruleModifyResponseModel" : { "type" : "object", "properties" : { "result" : { "type" : "boolean", "description" : "编辑结果是否成功", "example" : "true" } } }, "AlipayEbppInvoiceInstitutionModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED", "INSTITUTION_NOT_EXIST_ERROR", "INSTITUTION_MODIFY_FAIL", "MODIFY_CONSULT_FAILED_ISSUE", "MODIFY_CONSULT_FAILED_CONSUME" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceInstitutionModifyModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业共同账户id", "example" : "2088000194958956" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001181407500" }, "consult_mode" : { "type" : "string", "description" : "费控咨询模式：\t0-支付宝内部计算规则可用金额\t1-咨询外部服务商规则可用金额", "example" : "0" }, "effective" : { "type" : "string", "description" : "制度是否启用", "example" : "0" }, "effective_end_date" : { "type" : "string", "description" : "制度生效结束时间（可空），最小粒度为天，最早是当日", "example" : "2022-09-30 23:59:59" }, "effective_start_date" : { "type" : "string", "description" : "制度生效起始时间", "example" : "2022-09-10 00:00:00" }, "enterprise_id" : { "type" : "string", "description" : "企业id", "example" : "2088123412341234" }, "institution_desc" : { "type" : "string", "description" : "制度描述", "example" : "餐补制度" }, "institution_id" : { "type" : "string", "description" : "制度id", "example" : "2022031000152617000000000001" }, "institution_name" : { "type" : "string", "description" : "制度名称", "example" : "费用制度" } } }, "AlipayEbppInvoiceInstitutionModifyResponseModel" : { "type" : "object", "properties" : { "result" : { "type" : "boolean", "description" : "修改是否成功", "example" : "true" } } }, "AlipayEbppInvoiceInstitutionPageinfoQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceInstitutionPageinfoQueryResponseModel" : { "type" : "object", "properties" : { "institution_basic_info_list" : { "type" : "array", "description" : "制度基本信息列表", "items" : { "$ref" : "#/components/schemas/InstitutionBasicInfo" } }, "page_num" : { "type" : "string", "description" : "页码", "example" : "10" }, "page_size" : { "type" : "integer", "description" : "页大小", "example" : "10" }, "total_page_count" : { "type" : "integer", "description" : "总页数", "example" : "10" } } }, "AlipayEbppInvoiceInstitutionScopeModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceInstitutionScopeModifyModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业共同账户id", "example" : "2088000194958956" }, "adapter_type" : { "type" : "string", "description" : "制度适用范围类型", "example" : "EMPLOYEE_SELECT" }, "add_owner_id_list" : { "type" : "array", "description" : "增加适配id列表", "items" : { "type" : "string" }, "example" : "[\"2088402266061144\",\"2088402266063146\"]" }, "add_owner_open_id_list" : { "type" : "array", "description" : "增加适配开放id列表", "items" : { "type" : "string" }, "example" : "[\"abcdxxxx\"]" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "enterprise_id" : { "type" : "string", "description" : "企业id", "example" : "2088000194958956" }, "institution_id" : { "type" : "string", "description" : "制度id", "example" : "2022072800152617760000002797" }, "owner_type" : { "type" : "string", "description" : "归属类型", "example" : "ENTERPRISE_PAY_UID" }, "remove_owner_id_list" : { "type" : "array", "description" : "删除适配id列表", "items" : { "type" : "string" }, "example" : "[\"2088402266062862\",\"2088402266060390\"]" }, "remove_owner_open_id_list" : { "type" : "array", "description" : "删除适配开放id列表", "items" : { "type" : "string" }, "example" : "[\"abcdxxxx\"]" } } }, "AlipayEbppInvoiceInstitutionScopeModifyResponseModel" : { "type" : "object", "properties" : { "result" : { "type" : "boolean", "description" : "操作是否成功", "example" : "true" } } }, "AlipayEbppInvoiceInstitutionScopepageinfoQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED", "INSTITUTION_NOT_EXIST_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceInstitutionScopepageinfoQueryResponseModel" : { "type" : "object", "properties" : { "adapter_type" : { "type" : "string", "description" : "制度适用范围类型", "example" : "EMPLOYEE_ALL" }, "onwer_open_id_list" : { "type" : "array", "description" : "适配开放id列表", "items" : { "type" : "string" }, "example" : "[\"asdfxxxx\"]" }, "owner_id_list" : { "type" : "array", "description" : "适配id列表", "items" : { "type" : "string" }, "example" : "[\"2288078000164693\"]" }, "page_num" : { "type" : "integer", "description" : "页码", "example" : "10" }, "page_size" : { "type" : "integer", "description" : "页大小", "example" : "100" }, "total_page_count" : { "type" : "integer", "description" : "总页数", "example" : "100" } } }, "AlipayEbppInvoiceIssueruleCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED", "SENSITIVE_CHECK_FAIL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceIssueruleCreateModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户id", "example" : "2088000194958956" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "effective" : { "type" : "string", "description" : "是否启用，\"0\"为停用，\"1\"为启用；\t如果target_type指定INSTITUTION，则与制度一致,无需填写", "example" : "1" }, "effective_period" : { "type" : "string", "description" : "生效周期，时间不限格式：\"{\\\"all\\\":true}\"", "example" : "{\\\"all\\\":true}" }, "enterprise_id" : { "type" : "string", "description" : "企业ID", "example" : "2088000194958956" }, "invalid_mode" : { "type" : "integer", "description" : "是否可累计，枚举：0（不可累计）、1（可累计），2（累计天数）、3（累计到指定日期）余额只允许可累计，按城市发放只允许不可累计，设置了生效周期只允许不可累计", "example" : "0" }, "invalid_mode_value" : { "type" : "string", "description" : "累计值（预留字段）", "example" : "预留" }, "issue_amount_value" : { "type" : "string", "description" : "发放金额；\t按城市不同发放标准示例值：\"[{\\\"cities\\\":[\\\"321000\\\",\\\"321100\\\"],\\\"amount\\\":\\\"50\\\"},{\\\"cities\\\":[\\\"321200\\\",\\\"321300\\\"],\\\"amount\\\":\\\"150\\\"}]\"\t统一标准发放示例值：\"200\"", "example" : "200" }, "issue_end_date" : { "type" : "string", "description" : "发放规则的截止时间\t如果target_type指定INSTITUTION，则使用制度有效期结束时间，无需填写", "example" : "2021-01-01 12:00:00" }, "issue_rule_name" : { "type" : "string", "description" : "发放规则名称", "example" : "晚餐发放" }, "issue_start_date" : { "type" : "string", "description" : "发放规则的开始时间\t如果target_type指定INSTITUTION，则使用制度有效期起始时间，无需填写", "example" : "2021-01-01 12:00:00" }, "issue_type" : { "type" : "string", "description" : "发放类型", "example" : "ISSUE_MONTH" }, "quota_type" : { "type" : "string", "description" : "额度类型，枚举：COUPON（点券）、CAP（余额）、ISV（外算额度）", "example" : "COUPON" }, "share_mode" : { "type" : "integer", "description" : "是否可转赠，枚举：0（不可转赠）、1（可转赠）", "example" : "0" }, "target_id" : { "type" : "string", "description" : "发放规则关联的目标值\ttarget_type为制度时：制度id", "example" : "2022052000152618690000000005" }, "target_type" : { "type" : "string", "description" : "发放规则关联的目标类型，枚举值：INSTITUTION(制度)", "example" : "INSTITUTION" } } }, "AlipayEbppInvoiceIssueruleCreateResponseModel" : { "type" : "object", "properties" : { "issue_rule_id" : { "type" : "string", "description" : "创建的发放规则ID", "example" : "2022070500152622690000017754" } } }, "AlipayEbppInvoiceIssueruleDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceIssueruleDeleteModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户id", "example" : "2088000194958956" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "enterprise_id" : { "type" : "string", "description" : "企业ID", "example" : "2088000194958956" }, "issue_rule_id_list" : { "type" : "array", "description" : "需要删除的发放规则id列表", "items" : { "type" : "string" }, "example" : "[\"2022052000152618690000000005\"]" }, "target_id" : { "type" : "string", "description" : "目标值id", "example" : "2022052000152618690000000005" }, "target_type" : { "type" : "string", "description" : "发放规则关联的目标类型", "example" : "INSTITUTION" } } }, "AlipayEbppInvoiceIssueruleDeleteResponseModel" : { "type" : "object", "properties" : { "result" : { "type" : "boolean", "description" : "删除结果", "example" : "true" } } }, "AlipayEbppInvoiceIssueruleModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "PERMISSION_DENIED", "SENSITIVE_CHECK_FAIL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceIssueruleModifyModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户id", "example" : "2088000194958956" }, "action" : { "type" : "string", "description" : "修改类型，枚举：\tMODIFY_BASIC_INFO（修改发放规则基本信息）", "example" : "MODIFY_BASIC_INFO" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20215425001112341234" }, "effective" : { "type" : "string", "description" : "是否启用，\"0\"为停用，\"1\"为启用；", "example" : "1" }, "effective_period" : { "type" : "string", "description" : "生效周期（不传则不修改），不限：\"{\\\"all\\\":true}\"", "example" : "{\\\"all\\\":true}" }, "enterprise_id" : { "type" : "string", "description" : "企业ID", "example" : "2088000194958956" }, "invalid_mode" : { "type" : "integer", "description" : "是否可累计（不传则不修改），枚举：0（不可累计）、1（可累计），2（累计天数），3（累计到固定时间）", "example" : "0" }, "invalid_mode_value" : { "type" : "string", "description" : "累计值", "example" : "10" }, "issue_amount_value" : { "type" : "string", "description" : "发放金额（不传则不修改）", "example" : "200" }, "issue_end_date" : { "type" : "string", "description" : "发放规则的截止时间", "example" : "2021-01-01 12:00:00" }, "issue_rule_id" : { "type" : "string", "description" : "发放规则id", "example" : "2022052000152618690000000005" }, "issue_rule_name" : { "type" : "string", "description" : "发放规则名称（不传则不修改）", "example" : "晚餐发放" }, "issue_start_date" : { "type" : "string", "description" : "发放规则的开始时间", "example" : "2021-01-01 12:00:00" }, "issue_type" : { "type" : "string", "description" : "发放类型", "example" : "ISSUE_MONTH" }, "quota_type" : { "type" : "string", "description" : "额度类型", "example" : "COUPON" }, "share_mode" : { "type" : "integer", "description" : "是否可转赠（不传则不修改），枚举：0（不可转赠）、1（可转赠），默认为0，余额不支持可转赠，按城市发放不支持可转赠", "example" : "0" }, "target_id" : { "type" : "string", "description" : "发放规则关联的目标值 target_type为制度时：制度id", "example" : "2022052000152618690000000005" }, "target_type" : { "type" : "string", "description" : "发放规则关联的目标类型，枚举值：INSTITUTION(制度)", "example" : "INSTITUTION" } } }, "AlipayEbppInvoiceIssueruleModifyResponseModel" : { "type" : "object", "properties" : { "result" : { "type" : "boolean", "description" : "修改结果", "example" : "true" } } }, "AlipayEbppInvoiceIsvtokenReimApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceIsvtokenReimApplyModel" : { "type" : "object", "properties" : { "isv_app_code" : { "type" : "string", "description" : "报销软件app对应的isv app code，由支付宝进行分配。详情参见 \"推\"模式发票报销", "example" : "ekuaibao_tinyapp" } } }, "AlipayEbppInvoiceIsvtokenReimApplyResponseModel" : { "type" : "object", "properties" : { "isv_token" : { "type" : "string", "description" : "支付宝分配给报销软件的授权token，当前设置有效时间为20分钟", "example" : "9232d035c6b547f8a2023a399b1e8fe2" }, "serial_no" : { "type" : "string", "description" : "该次请求的唯一标志，当前设置有效时间为20分钟", "example" : "1730d660f1d" } } }, "AlipayEbppInvoiceListExpenseSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "EXPENSE_INVOICE_DETAIL_URL_CHECK", "PERMISSION_DENIED", "EXPENSE_NOT_REACH_PROCESSING", "EXPENSE_BUSINESS_TIME_ERROR", "INVOICE_HAVE_PROCESSING_EXPENSE", "EXPENSE_APPLY_ID_REPEAT", "INVOICE_HAVE_EXPENSE", "INVOICE_HAVE_CANCLE", "INVOICE_NOT_EXIST", "INVOICE_EXPENSE_STATUS_REPEAT", "EXPENSE_ORDER_NO_DISAGREE", "QUERY_TAX_NO_NOT_EQUAL_CERTIFY_NO" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceListExpenseSyncModel" : { "type" : "object", "properties" : { "business_time" : { "type" : "string", "description" : "报销进度变更时间", "example" : "2017-08-14 10:10:00" }, "expense_order_no" : { "type" : "string", "description" : "商户报销单据号", "example" : "20180808128739874213" }, "expense_tax_no" : { "type" : "string", "description" : "报销企业税号", "example" : "113071TRDX8RQU8" }, "invoice_element_list" : { "type" : "array", "description" : "需要同步报销状态的发票列表", "items" : { "$ref" : "#/components/schemas/InvoiceElementStatusSyncOpenModel" } }, "memo" : { "type" : "string", "description" : "报销审批备注", "example" : "财务已打款" }, "open_id" : { "type" : "string", "description" : "用户uid", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "status" : { "type" : "string", "description" : "EXPENSE_APPLY:报销申请提交;EXPENSE_APPROVAL_PASS:报销申请审核通过;EXPENSE_FINISHED:报销申请完成;EXPENSE_CANCEL:报销申请撤回", "example" : "EXPENSE_APPLY" }, "user_id" : { "type" : "string", "description" : "用户uid", "example" : "2088002000321000" } } }, "AlipayEbppInvoiceListExpenseSyncResponseModel" : { "type" : "object" }, "AlipayEbppInvoiceMerchantEnterstatusQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "BIZ_ERROR", "RECORD_NOT_EXIST", "PERMISSION_DENIED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceMerchantEnterstatusQueryResponseModel" : { "type" : "object", "properties" : { "status" : { "type" : "string", "description" : "工单状态，审核中：AUDITING，验收中：ACCEPTING，成功：SUCCESS，失败：FAIL", "example" : "SUCCESS" } } }, "AlipayEbppInvoiceMerchantlistEnterApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "MERCHANT_ENTER_DENY", "MERCHANT_NAME_OCCUPIED", "SERVER_NOT_EXIST", "SERVER_ABILITY_NOT_SATIF", "TAX_NUM_OCCUPIED", "BIZ_ERROR", "MERCHANT_LOGO_UPLOAD_FAIL", "MERCHANT_ENTER_PID_MOD_DUPLICATE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceMerchantlistEnterApplyModel" : { "type" : "object", "properties" : { "merchant_base" : { "$ref" : "#/components/schemas/MerchantBaseEnterOpenModel" }, "sub_merchant_common_info" : { "$ref" : "#/components/schemas/SubMerchantCommonEnterOpenModel" }, "sub_merchant_list" : { "type" : "array", "description" : "商户球房列表信息，最多传入30个球房信息", "items" : { "$ref" : "#/components/schemas/SubMerchantEnterOpenModel" } } } }, "AlipayEbppInvoiceMerchantlistEnterApplyResponseModel" : { "type" : "object", "properties" : { "process_id" : { "type" : "string", "description" : "工单流水号，支付开票PID模式当前不会返回流水号。", "example" : "1234567" } } }, "AlipayEbppInvoiceOrderQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceOrderQueryResponseModel" : { "type" : "object", "properties" : { "invoice_element_model" : { "$ref" : "#/components/schemas/InvoiceElementModel" }, "order_no" : { "type" : "string", "description" : "开票申请时传入订单号（支持主单号、子单号），不限是否为支付宝体内交易单号", "example" : "20200520110046966071" } } }, "AlipayEbppInvoiceSycnErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMETER_ILLEGAL", "MERCHANT_NOT_SUPPORTED", "SYSTEM_ERROR", "RECORD_ALREADY_EXIST", "COLLECTION_NON_USER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceSycnModel" : { "type" : "object", "properties" : { "invoice_info" : { "type" : "array", "description" : "同步发票信息模型", "items" : { "$ref" : "#/components/schemas/InvoiceModelContent" } }, "m_short_name" : { "type" : "string", "description" : "商户的品牌名称简称,该字段需要接入前向发票管家申请，\r\tm_short_name+sub_m_short_name具有唯一约束\r\t如：肯德基：KFC", "example" : "KFC" }, "sub_m_short_name" : { "type" : "string", "description" : "支付宝为商户分配的商户球房简称，该字段需要接入前在发票管家申请\r\t如：肯德基-杭州西湖区文一西路店：KFC-HZ-XH001", "example" : "KFC_HZ_XH001" } } }, "AlipayEbppInvoiceSycnResponseModel" : { "type" : "object", "properties" : { "url" : { "type" : "string", "description" : "支付宝发票管家发票详情页链接地址\r\t如果同步的发票是多张时，此链接为当前用户的已开立发票列表地址", "example" : "alipays://platformapi/startapp?appId=20000920&url=%2Fwww%2Fdetail.htm%3Ffrom%3Doffline%26code%3D201606210015200108000" } } }, "AlipayEbppInvoiceSyncSimpleSendErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "BIZ_ERROR", "PDF_DOWNLOAD_EXCEPTION", "PDF_DOWNLOAD_FUNC_CLOSED", "PERMISSION_DENIED", "INVALID_PARAMETER", "PDF_TYPE_ILLEGAL", "COMPRESS_TYPE_NOT_SUPPORT", "INVOICE_ALREADY_EXIST", "SYSTEM_ERROR", "ANT_INVOICE_APPLY_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceSyncSimpleSendModel" : { "type" : "object", "properties" : { "invoice_info" : { "$ref" : "#/components/schemas/InvoicePDFSynModel" }, "m_short_name" : { "type" : "string", "description" : "开票商户品牌简称，与商户入驻时的品牌简称保持一致。详情参见 电子发票", "example" : "XSD" }, "sub_m_short_name" : { "type" : "string", "description" : "开票商户球房简称，与商户入驻时的球房简称保持一致。", "example" : "XSD_HL" } } }, "AlipayEbppInvoiceSyncSimpleSendResponseModel" : { "type" : "object" }, "AlipayEbppInvoiceTaxnoBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PARAMETER_ILLEGAL", "PERMISSION_DENIED", "QUERY_TAX_NO_NOT_EQUAL_CERTIFY_NO" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceTaxnoBatchqueryModel" : { "type" : "object", "properties" : { "enable_trade_out" : { "type" : "string", "description" : "默认值为false。true为输出交易信息，false为不输出交易信息。", "example" : "true" }, "end_invoice_date" : { "type" : "string", "description" : "查询结束时间，精确到天（按开票日期查询）\tstart_invoice_date和end_invoice_date传值要求\t1.同时为空时，返回最近半年200条数据\t2.必须同时为空 或 同时不为空\t3.结束日期不能大于当前日期\t4.开始时间和结束时间跨度不能超过6个月", "example" : "2017-07-11" }, "invoice_kind_list" : { "type" : "array", "description" : "查询票种列表。枚举值如下：\t*PLAIN：增值税电子普通发票；\t*SPECIAL：增值税专用发票；\t*ALL_ELECTRONIC_GENERAL： \"电子发票（普通发票）;\t*ALL_ELECTRONIC_SPECIAL： \"电子发票（专用发票）;\t*PLAIN_INVOICE：增值税普通发票；\t*PAPER_INVOICE：增值税普通发票（卷式）；\t*SALSE_INVOICE：机动车销售统一发票。", "items" : { "type" : "string" }, "example" : "PLAIN" }, "limit_size" : { "type" : "integer", "description" : "查询结果上限笔数，最大值20", "example" : "20" }, "page_num" : { "type" : "integer", "description" : "当前页码，为空时默认第一页", "example" : "1" }, "scene" : { "type" : "string", "description" : "发票要素获取应用场景。\"拉\"模式报销 固定为 INVOICE_EXPENSE 表示发票报销。", "example" : "INVOICE_EXPENSE" }, "start_invoice_date" : { "type" : "string", "description" : "查询起始时间，精确到天（按开票日期查询）\tstart_invoice_date和end_invoice_date传值要求\t1.同时为空时，返回最近半年200条数据\t2.必须同时为空 或 同时不为空\t3.结束日期不能大于当前日期\t4.开始时间和结束时间跨度不能超过6个月", "example" : "2017-01-11" }, "tax_no" : { "type" : "string", "description" : "企业税号", "example" : "123" } } }, "AlipayEbppInvoiceTaxnoBatchqueryResponseModel" : { "type" : "object", "properties" : { "invoice_element_list" : { "type" : "array", "description" : "发票要素列表", "items" : { "$ref" : "#/components/schemas/InvoiceElementModel" } }, "open_id" : { "type" : "string", "description" : "支付宝用户id", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "user_id" : { "type" : "string", "description" : "支付宝用户id", "example" : "2088000000000000" } } }, "AlipayEbppInvoiceTitleDynamicGetErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "TITLE_NOT_EXIST", "ACCESS_FREQUENCY_TOO_HIGH", "PARAMETER_ILLEGAL", "SYSTEM_ERROR", "BAR_CODE_EXPIRED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceTitleDynamicGetResponseModel" : { "type" : "object", "properties" : { "title" : { "$ref" : "#/components/schemas/InvoiceTitleModel" } } }, "AlipayEbppInvoiceTitleListGetErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "TITLE_LIST_NOT_EXIST", "PARAMETER_ILLEGAL", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceTitleListGetResponseModel" : { "type" : "object", "properties" : { "title_list" : { "type" : "array", "description" : "抬头列表", "items" : { "$ref" : "#/components/schemas/InvoiceTitleModel" } } } }, "AlipayEbppInvoiceTokenBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVOICE_INVALID_TOKEN", "PERMISSION_DENIED", "PARAMETER_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppInvoiceTokenBatchqueryResponseModel" : { "type" : "object", "properties" : { "invoice_element_list" : { "type" : "array", "description" : "发票要素列表", "items" : { "$ref" : "#/components/schemas/InvoiceElementModel" } }, "open_id" : { "type" : "string", "description" : "支付宝用户id", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "user_id" : { "type" : "string", "description" : "支付宝用户id", "example" : "20880000000000000" } } }, "AlipayEbppPdeductAsyncPayErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SUBMIT_REQUEST_FAILURE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppPdeductAsyncPayModel" : { "type" : "object", "properties" : { "agent_channel" : { "type" : "string", "description" : "分配给外部机构发起扣款时的渠道码。朗新为LANGXIN", "example" : "LANGXIN" }, "agent_code" : { "type" : "string", "description" : "二级渠道码，预留字段", "example" : "SECOND" }, "agreement_id" : { "type" : "string", "description" : "支付宝代扣协议Id", "example" : "1234557890" }, "bill_date" : { "type" : "string", "description" : "账期", "example" : "201605" }, "bill_key" : { "type" : "string", "description" : "户号", "example" : "03932134" }, "extend_field" : { "type" : "string", "description" : "扩展字段", "example" : "{\"key1\":\"value1\",\"key2\":\"value2\", \"key3\":\"value3\",\"key4\":\"value4\"}" }, "fine_amount" : { "type" : "string", "description" : "滞纳金", "example" : "2.00" }, "memo" : { "type" : "string", "description" : "备注信息", "example" : "memo" }, "open_id" : { "type" : "string", "description" : "用户UserId在应用AppId下的唯一用户标识", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "out_order_no" : { "type" : "string", "description" : "商户外部业务流水号", "example" : "1888232932" }, "pay_amount" : { "type" : "string", "description" : "扣款金额，支付总金额，包含滞纳金", "example" : "23.00" }, "pid" : { "type" : "string", "description" : "商户partnerId", "example" : "2088131312" }, "user_id" : { "type" : "string", "description" : "用户ID", "example" : "208811233144123" } } }, "AlipayEbppPdeductAsyncPayResponseModel" : { "type" : "object", "properties" : { "agreement_id" : { "type" : "string", "description" : "支付宝代扣协议ID", "example" : "42132131" }, "out_order_no" : { "type" : "string", "description" : "商户代扣业务流水", "example" : "312312" }, "result_status" : { "type" : "string", "description" : "扣款流水状态", "example" : "I" } } }, "AlipayEbppPdeductBillPayStatusErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "BILL_NOT_EXIST", "PARAMETER_ILLEGAL", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppPdeductBillPayStatusResponseModel" : { "type" : "object", "properties" : { "agreement_id" : { "type" : "string", "description" : "支付宝协议流水", "example" : "2919219429194" }, "open_id" : { "type" : "string", "description" : "用户UserId在应用AppId下的唯一用户标识", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "order_no" : { "type" : "string", "description" : "支付宝流billNo", "example" : "2015010122003385" }, "order_result_code" : { "type" : "string", "description" : "订单的结果码", "example" : "PAY_FAIL" }, "order_result_msg" : { "type" : "string", "description" : "订单的结果描述", "example" : "AE0110270001_支付金额不足" }, "out_order_no" : { "type" : "string", "description" : "外部订单流水", "example" : "21929910124" }, "status" : { "type" : "string", "description" : "支付宝订单支付状态。\r\t0：未知状态。\r\t1：支付成功。\r\t2：支付失败。", "example" : "0" } } }, "AlipayEbppPdeductPayErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "AGREEMENT_ID_IS_NULL", "AGENT_CHANNEL_IS_NULL", "BILL_KEY_IS_NULL", "INST_ORDER_NO_IS_NULL", "DEDUCT_SIGN_INFO_NOT_EXIST", "QUERY_DEDUCT_SIGN_INFO_ERROR", "INVOKE_PAYACCEPTANCE_EXCEPTION" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppPdeductPayModel" : { "type" : "object", "properties" : { "agent_channel" : { "type" : "string", "description" : "渠道码，如用户通过机构通过服务窗进来签约则是PUBLICFORM，此值可随意传，只要不空就行", "example" : "PUBLICFORM" }, "agent_code" : { "type" : "string", "description" : "二级渠道码，预留字段", "example" : "SECOND" }, "agreement_id" : { "type" : "string", "description" : "支付宝代扣协议Id", "example" : "1234557890" }, "bill_date" : { "type" : "string", "description" : "账期", "example" : "201410" }, "bill_key" : { "type" : "string", "description" : "户号，缴费单位用于标识每一户的唯一性的", "example" : "262327843" }, "extend_field" : { "type" : "string", "description" : "扩展参数。必须以key value形式定义，\r\t转为json为格式：{\"key1\":\"value1\",\"key2\":\"value2\",\r\t\"key3\":\"value3\",\"key4\":\"value4\"}\r\t 后端会直接转换为MAP对象，转换异常会报参数格式错误", "example" : "{\"key1\":\"value1\",\"key2\":\"value2\",\r\n\"key3\":\"value3\",\"key4\":\"value4\"}" }, "fine_amount" : { "type" : "string", "description" : "滞纳金", "example" : "2.00" }, "memo" : { "type" : "string", "description" : "备注信息", "example" : "memo" }, "open_id" : { "type" : "string", "description" : "用户UserId在应用AppId下的唯一用户标识", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "out_order_no" : { "type" : "string", "description" : "商户外部业务流水号", "example" : "18882329324" }, "pay_amount" : { "type" : "string", "description" : "扣款金额，支付总金额，包含滞纳金", "example" : "23.00" }, "pid" : { "type" : "string", "description" : "商户PartnerId", "example" : "2088611103588892" }, "user_id" : { "type" : "string", "description" : "用户ID", "example" : "2088123411243554" } } }, "AlipayEbppPdeductPayResponseModel" : { "type" : "object", "properties" : { "agreement_id" : { "type" : "string", "description" : "支付宝代扣协议ID", "example" : "1231232132" }, "bill_no" : { "type" : "string", "description" : "支付宝订单流水号", "example" : "201323423234" }, "extend_field" : { "type" : "string", "description" : "扩展参数", "example" : "{\"school_no\":\"SHNU\",\r\n\"student_id\":\"20130516\"}" }, "out_order_no" : { "type" : "string", "description" : "商户代扣业务流水", "example" : "213134234" }, "result_code" : { "type" : "string", "description" : "针对于支付失败时，给的对应错误明细，如果判断外围的错误码是INVOKE_PAYACCEPTANCE_EXCEPTION需要近一步再结合着结果模型中的result_code, result_msg来判断", "example" : "AE0110270001" }, "result_msg" : { "type" : "string", "description" : "针对于支付失败时，给的对应错误明细，如果判断外围的错误码是INVOKE_PAYACCEPTANCE_EXCEPTION需要近一步再结合着结果模型中的result_code, result_msg来判断", "example" : "支付金额不足" }, "result_status" : { "type" : "string", "description" : "订单支付状态。\r\t0：未知\r\t1：成功\r\t2：失败", "example" : "1" } } }, "AlipayEbppPdeductSignAddErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "isv.arguments-error", "isp.unknow-error", "isv.charge-no-direct-deduct", "isv.deduct-user-no-auth", "isv.deduct-paypassword-error", "isv.deduct-balance-is-not-payment", "isv.deduct-deplicated-self", "isv.deduct-sign-no-exist", "isv.deduct-billkey-sign-exit", "isv.deduct-no-autherity-by-realnamed", "isv.deduct-no-autherity-by-q" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppPdeductSignAddModel" : { "type" : "object", "properties" : { "agent_channel" : { "type" : "string", "description" : "机构签约代扣来源渠道\r\tPUBLICPLATFORM：服务窗", "example" : "PUBLICPLATFORM" }, "agent_code" : { "type" : "string", "description" : "从服务窗发起则为publicId的值", "example" : "123456" }, "bill_key" : { "type" : "string", "description" : "户号，机构针对于每户的水、电都会有唯一的标识户号", "example" : "02659981" }, "biz_type" : { "type" : "string", "description" : "业务类型。枚举支持：\t*JF：公共事业缴纳。\t*WUYE：物业缴费。\t*HK：信用卡还款。\t*TX：通讯缴费。\t*IND：保险缴费。", "example" : "JF" }, "charge_inst" : { "type" : "string", "description" : "支付宝缴费系统中的出账机构ID", "example" : "CQCENTERELECTRIC" }, "deduct_prod_code" : { "type" : "string", "description" : "代扣产品码。 缴费业务场景中，传入INST_DIRECT_DEDUCT。保险业务场景中, 传入INSURANCE_MERCHANT_DEDUCT。", "example" : "INSURANCE_MERCHANT_DEDUCT" }, "deduct_type" : { "type" : "string", "description" : "签约类型可为空", "example" : "direct_sign_deduct" }, "ext_user_info" : { "type" : "string", "description" : "外部用户实名认证相关信息, 用于做签约时的实名校验。 \r\t注： \r\t\r\tname: 姓名\r\tcert_type: 身份证：IDENTITY_CARD、护照：PASSPORT、军官证：OFFICER_CARD、士兵证：SOLDIER_CARD、户口本：HOKOU等\r\tcert_no: 证件号码\r\tneed_check_info取值 T/F，只有为T时才做强制校验。\r\tmobile:手机号，目前暂不使用此字段做校验\r\tmin_age: 允许的最小买家年龄,min_age为整数，必须大于等于0.", "example" : "{\"name\":\"张三\",\"cert_type\":\"IDENTITY_CARD\",\"cert_no\":\"362334768769238881\",\"need_check_info\":\"F\",\"min_age\":\"18\",\"mobile\":\"\"}" }, "extend_field" : { "type" : "string", "description" : "扩展字段", "example" : "null" }, "notify_config" : { "type" : "string", "description" : "通知方式设置，可为空", "example" : "null" }, "open_id" : { "type" : "string", "description" : "用户UserId在应用AppId下的唯一用户标识", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "out_agreement_id" : { "type" : "string", "description" : "外部产生的协议ID", "example" : "123456" }, "owner_name" : { "type" : "string", "description" : "户名，户主真实姓名", "example" : "王海龙" }, "pay_config" : { "type" : "string", "description" : "支付工具设置，目前可为空", "example" : "null" }, "pay_password_token" : { "type" : "string", "description" : "支付密码鉴权token，需要用户首先处于登陆态，然后访问https://ebppprod.alipay.com/deduct/enterMobileicPayPassword.htm?cb=自己指定的回跳连接地址，访问页面后会进到独立密码校验页，用户输入密码校验成功后，会生成token回调到指定的回跳地址，如果设置cb=www.alipay.com则最后回调的内容是www.alipay.com?token=312314ADFDSFAS，然后签约时直接取得地址后token的值即可。", "example" : "11505a6f41688644a4b85f9bf80ef071" }, "pid" : { "type" : "string", "description" : "商户id，商户在支付宝的唯一标识，以 2088 开头的 16 位纯数字组成。", "example" : "2088102118849556" }, "sign_expire_date" : { "type" : "string", "description" : "签约到期时间。空表示无限期，一期固定传空。", "example" : "2015-03-12" }, "sub_biz_type" : { "type" : "string", "description" : "业务子类型。业务子类型是业务类型的下一级概念。枚举支持：\t*WATER：缴水费。\t*ELECTRIC：缴电费。\t*GAS：缴燃气费。\t*COMMUN：缴固话宽带费。\t*CATV：缴有线电视费。\t*TRAFFIC：缴交通罚款。\t*WUYE：缴物业费。\t*RC：定期还车贷代扣。\t*RH：定期还房贷代扣。\t*RR：定期还房租代扣。\t*RN：定期还网贷代扣。\t*CZ：手机充值代扣。\t*CAR：车险。\t*LIFE：寿险。\t*HEALTH：健康险。\t例如：WATER表示JF下面的水费。", "example" : "ELECTRIC" }, "user_id" : { "type" : "string", "description" : "用户 id，用户在支付宝的唯一标识，以 2088 开头的 16 位纯数字组成。", "example" : "2088111133334134" } } }, "AlipayEbppPdeductSignAddResponseModel" : { "type" : "object", "properties" : { "agreement_id" : { "type" : "string", "description" : "支付宝代扣协议ID", "example" : "20141028000363828663" }, "agreement_status" : { "type" : "string", "description" : "支付宝协议状态。签约成功则返回success", "example" : "success" }, "extend_field" : { "type" : "string", "description" : "扩展参数，可为空", "example" : "null" }, "notify_config" : { "type" : "string", "description" : "通知方式设置。", "example" : "通知方式文案" }, "out_agreement_id" : { "type" : "string", "description" : "商户生成的代扣协议ID", "example" : "123123" }, "pay_config" : { "type" : "array", "description" : "支付方式设置", "items" : { "type" : "string" }, "example" : "BALANCE" }, "sign_date" : { "type" : "string", "description" : "签约时间", "example" : "2014-01-21" } } }, "AlipayEbppPdeductSignCancelErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "isp.unknow-error", "isv.arguments-error", "isv.sign-info-not-exist", "isv.cancel-sign-failure", "DEDUCT_SIGN_INFO_NOT_EXIST", "QUERY_DEDUCT_SIGN_INFO_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppPdeductSignCancelModel" : { "type" : "object", "properties" : { "agent_channel" : { "type" : "string", "description" : "此值只是供代扣中心做最后的渠道统计用，并不做值是什么的强校验，只要不为空就可以", "example" : "操作来源\r\nPUBLICPLATFORM：服务窗" }, "agent_code" : { "type" : "string", "description" : "标识发起方的ID，从服务窗发起则为appId的值，appId即开放平台分配给接入ISV的id，此处也可以随便真其它值，只要能标识唯一即可", "example" : "201603012984123" }, "agreement_id" : { "type" : "string", "description" : "支付宝代扣协议ID", "example" : "20160512331244123124421" }, "open_id" : { "type" : "string", "description" : "用户UserId在应用AppId下的唯一用户标识", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "pay_password_token" : { "type" : "string", "description" : "需要用户首先处于登陆态，然后访问https://ebppprod.alipay.com/deduct/enterMobileicPayPassword.htm?cb=自己指定的回跳连接地址,访问页面后会进到独立密码校验页，用户输入密码校验成功后，会生成token回调到指定的回跳地址，如果设置cb=www.baidu.com则最后回调的内容是www.baidu.com?token=312314ADFDSFAS,然后签约时直接取得地址后token的值即可", "example" : "11505a6f41688644a4b85f9bf80ef071" }, "user_id" : { "type" : "string", "description" : "用户ID", "example" : "2088123411112222" } } }, "AlipayEbppPdeductSignCancelResponseModel" : { "type" : "object", "properties" : { "agreement_id" : { "type" : "string", "description" : "支付宝代扣协议ID", "example" : "20441111111" }, "agreement_status" : { "type" : "string", "description" : "支付宝协议状态。解约成功则返回success", "example" : "success" }, "out_agreement_id" : { "type" : "string", "description" : "商户代扣协议ID", "example" : "23433333333" } } }, "AlipayEbppPdeductSignQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "QUERY_DEDUCT_SIGN_INFO_ERROR", "DEDUCT_SIGN_INFO_NOT_EXIST", "PARAMETER_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppPdeductSignQueryResponseModel" : { "type" : "object", "properties" : { "agreement_id" : { "type" : "string", "description" : "协议ID", "example" : "20160331000700130000930600556911" }, "bill_key" : { "type" : "string", "description" : "户号", "example" : "03983123" }, "charge_inst" : { "type" : "string", "description" : "出账机构", "example" : "HZYHWATER" }, "out_agreement_id" : { "type" : "string", "description" : "朗新协议ID", "example" : "738F4D9B6F825FDE9D07773E08BD0A2E" }, "sign_date" : { "type" : "string", "description" : "签约时间", "example" : "2016-02-03 18:00:00" }, "user_id" : { "type" : "string", "description" : "用户ID", "example" : "2088022621144305" } } }, "AlipayEbppPdeductSignValidateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "USER_IS_NOT_EXITS", "NO_AUTHERITY", "NO_AUTHERITY_BY_REALNAMED", "DEDUCT_BALANCE_IS_NOT_PAYMENT", "DEDUCT_INST_IS_NOT_EXIST", "DEDUCT_INST_PROD_IS_CLOSED", "DEDUCT_SIGN_DUPLICATED_SELF", "DEDUCT_SIGN_DUPLICATED_OTHER", "DEDUCT_SIGN_CTU_CHECK_FAILED", "INVALID_CARD_NO", "UNKNOW_ERROR", "INVOKE_EBILL_CENTER_EXCEPTION" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEbppPdeductSignValidateModel" : { "type" : "object", "properties" : { "agent_channel" : { "type" : "string", "description" : "机构签约代扣来源渠道\r\tPUBLICPLATFORM：服务窗", "example" : "PUBLICPLATFORM" }, "agent_code" : { "type" : "string", "description" : "从服务窗发起则为该服务窗的appid的值", "example" : "123456" }, "bill_key" : { "type" : "string", "description" : "户号，机构针对于每户的水、电都会有唯一的标识户号", "example" : "02659981" }, "biz_type" : { "type" : "string", "description" : "业务类型。\r\tJF：缴水、电、燃气、固话宽带、有线电视、交通罚款费用\r\tWUYE：缴物业费\r\tHK：信用卡还款\r\tTX：手机充值", "example" : "JF" }, "charge_inst" : { "type" : "string", "description" : "支付宝缴费系统中的出账机构ID", "example" : "CQCENTERELECTRIC" }, "deduct_type" : { "type" : "string", "description" : "签约类型,可为空。目前类型有INST_DIRECT_DEDUCT", "example" : "direct_sign_deduct" }, "extend_field" : { "type" : "string", "description" : "扩展字段", "example" : "null" }, "notify_config" : { "type" : "string", "description" : "通知方式设置，本期预留字段，固定传空。", "example" : "null" }, "open_id" : { "type" : "string", "description" : "用户UserId在应用AppId下的唯一用户标识", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "out_agreement_id" : { "type" : "string", "description" : "外部机构签约的协议id", "example" : "123456" }, "owner_name" : { "type" : "string", "description" : "户名，户主真实姓名", "example" : "王龙海" }, "pay_config" : { "type" : "string", "description" : "支付工具设置，目前可为空。类型有：BALANCE;CARTOON;BIGAMOUNT_CREDIT_CARTOON;DEBIT_EXPRESS;OPTIMIZED_MOTO;PCREDIT_PAY;MONEY_FUND", "example" : "null" }, "pid" : { "type" : "string", "description" : "商户签约支付宝账号的userid，2088开头16位长度的字符串，在支付宝系统中唯一", "example" : "2088102118849556" }, "sign_expire_date" : { "type" : "string", "description" : "签约到期时间。空表示无限期，一期固定传空。", "example" : "2015-03-12" }, "sub_biz_type" : { "type" : "string", "description" : "业务子类型。\r\tWATER：缴水费\r\tELECTRIC：缴电费\r\tGAS：缴燃气费\r\tCOMMUN：缴固话宽带\r\tCATV：缴有线电视费\r\tTRAFFIC：缴交通罚款\r\tWUYE：缴物业费\r\tHK：信用卡还款\r\tCZ：手机充值", "example" : "ELECTRIC" }, "user_id" : { "type" : "string", "description" : "用户支付宝账号id，2088开头16位长度的字符串，在支付宝系统中唯一", "example" : "2088111133334134" } } }, "AlipayEbppPdeductSignValidateResponseModel" : { "type" : "object" }, "AlipayEcoContractSignflowsCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PARAM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoContractSignflowsCreateModel" : { "type" : "object", "properties" : { "attachments" : { "type" : "array", "description" : "附件信息（附件可作为合同的辅助证明材料，无需签署。需通过文件直传接口上传附件，获取文件id后添加）。注意事项参见 文件流上传方法。", "items" : { "$ref" : "#/components/schemas/Attachment" } }, "business_scene" : { "type" : "string", "description" : "流程主题（简要概括合同的签署内容）", "example" : "爱租机手机交付单；某某公司劳动合同等" }, "config_info" : { "$ref" : "#/components/schemas/ConfigInfoBean" }, "template_infos" : { "type" : "array", "description" : "模板信息（基于合同模板填充内容生成待签文件，并指定签署人）", "items" : { "$ref" : "#/components/schemas/TemplateInfoBean" } } } }, "AlipayEcoContractSignflowsCreateResponseModel" : { "type" : "object", "properties" : { "flow_id" : { "type" : "string", "description" : "电子合同流程id（需记录到业务系统中，后续相关服务调用都基于此ID）", "example" : "56b75290982d472b8d60133cd9a747a3" } } }, "AlipayEcoDocTemplateCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PARAM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoDocTemplateCreateModel" : { "type" : "object", "properties" : { "content_md_5" : { "type" : "string", "description" : "模版文件的md5值。示例代码参见 创建合同模板", "example" : "L+K1FXfqwcY6LJ0LFXb7gQ==" }, "content_type" : { "type" : "string", "description" : "目标文件的MIME类型。示例代码参见 创建合同模板", "example" : "application/octet-stream" }, "convert_to_pdf" : { "type" : "string", "description" : "是否需要转成pdf，如果模板文件为.doc/.docx 传true，为pdf传false", "example" : "false" }, "file_name" : { "type" : "string", "description" : "文件名称，必须带上文件扩展名如 .pdf、.doc、.docx，否则会导致后续发起流程校验异常。", "example" : "劳动合同.PDF" } } }, "AlipayEcoDocTemplateCreateResponseModel" : { "type" : "object", "properties" : { "template_id" : { "type" : "string", "description" : "模板id（请记录模板ID（templateId），后续发起合同签署需要使用到）", "example" : "049d33945cde46b7953bf377fe2a7608" }, "upload_url" : { "type" : "string", "description" : "文件直传地址，需要用此上传地址使用PUT方式上传文件，只有文件上传后模板才可用", "example" : "https://esignoss.oss-cn-hangzhou.aliyuncs.com/1111563786/d8d35867-744b-47f3-890f-e3650efd99e1/%E9%99%84%E4%BB%B6.zip?Expires=1561472338&OSSAccess..." } } }, "AlipayEcoDoctemplateSettingurlQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PARAM_ERROR", "TEMPLATE_FILE_IS_NOT_CONVERT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoDoctemplateSettingurlQueryResponseModel" : { "type" : "object", "properties" : { "setting_url" : { "type" : "string", "description" : "模板设置地址", "example" : "https://t.tsign.cn/9rT0KvuVQdDJ" } } }, "AlipayEcoEduKtBillingModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "BIZ_ERROR", "EDU_ISV_NOT_EXIST", "SCHOOL_NOT_EXIST", "EDU_ISV_SCHOOL_NOT_EXIST", "ALIPAY_QUERY_ORDER_FAIL", "USER_INFO_ERROR", "ILLEGAL_PARAM", "INVALID_PARAMETER_REFUND_FAILED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoEduKtBillingModifyModel" : { "type" : "object", "properties" : { "bank_success" : { "type" : "string", "description" : "成功Y，失败N", "example" : "Y" }, "buyer_logon_id" : { "type" : "string", "description" : "退款时，支付宝返回的用户的登录id", "example" : "159****5620" }, "buyer_user_id" : { "type" : "string", "description" : "支付宝返回的买家支付宝用户id", "example" : "2088101117955611" }, "buyer_user_open_id" : { "type" : "string", "description" : "支付宝返回的买家支付宝用户id加密后信息", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "fund_change" : { "type" : "string", "description" : "本次退款是否发生了资金变化", "example" : "Y" }, "gmt_refund" : { "type" : "string", "description" : "支付宝返回的退款时间，而不是商户退款申请的时间", "example" : "2015-11-27 15:45:57" }, "out_request_no" : { "type" : "string", "description" : "标识一次退款请求，同一笔交易多次退款需要保证唯一，如需部分退款，则此参数必传。（若退款时填写，则同步退款状态时也必须填写）", "example" : "HZ01RF001" }, "out_trade_no" : { "type" : "string", "description" : "isv系统的订单号", "example" : "20160101909909354354354" }, "refund_amount" : { "type" : "string", "description" : "需要退款的金额，该金额不能大于订单金额,单位为元，支持两位小数", "example" : "200.12" }, "refund_detail_item_list" : { "type" : "string", "description" : "支付宝返回的退款资金渠道，json格式字符串", "example" : "{\r\n\t\"fund_channel\":\"ALIPAYACCOUNT\",\r\n\t\"amount\":12.00,\r\n\t\"real_amount\":12.00\r\n\t\r\n}" }, "refund_reason" : { "type" : "string", "description" : "退款原因，商家根据客户实际退款原因填写（若退款时填写，则同步退款状态时也必须填写）", "example" : "正常退款" }, "status" : { "type" : "string", "description" : "状态：1:缴费成功，2:关闭账单，3、退费\r\t如果为退款状态，需要填写fund_change, \r\trefund_amount, refund_reason,\r\tout_request_no, buyer_logon_id,\r\tgmt_refund,\r\tbuyer_user_id, refund_detail_item_list;\r\t4、同步网商返回的状态,如果是网商银行的账单，bank_success这个字段必填", "example" : "1" }, "trade_no" : { "type" : "string", "description" : "支付宝返回的交易号", "example" : "2014112611001004680073956707" } } }, "AlipayEcoEduKtBillingModifyResponseModel" : { "type" : "object", "properties" : { "status" : { "type" : "string", "description" : "如果成功，返回Y", "example" : "Y" } } }, "AlipayEcoEduKtBillingQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "ILLEGAL_PARAM" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoEduKtBillingQueryResponseModel" : { "type" : "object", "properties" : { "order_status" : { "type" : "string", "description" : "NOT_PAY 待缴费\r\tPAYING 支付中\r\tPAY_SUCCESS 支付成功，处理中\r\tBILLING_SUCCESS 缴费成功\r\tTIMEOUT_CLOSED 逾期关闭账单\r\tISV_CLOSED 账单关闭", "example" : "NOT_PAY" }, "out_trade_no" : { "type" : "string", "description" : "ISV发送账单时输入ISV端的账单号", "example" : "2017097634092" } } }, "AlipayEcoEduKtBillingSendErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "BIZ_ERROR", "ILLEGAL_PARAM" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoEduKtBillingSendModel" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "总金额，单位为元，精确到小数点后两位，取值范围[0.01,100000000]，\r\t如果是非多选项，是要和缴费项的总和相同，多选模式不做验证", "example" : "88.88" }, "charge_bill_title" : { "type" : "string", "description" : "缴费账单名称", "example" : "学生开学收费项" }, "charge_item" : { "type" : "array", "description" : "缴费详情：输入json格式字符串。Json定义：key填写缴费项名称，value填写缴费项金额，金额保留2位小数", "items" : { "$ref" : "#/components/schemas/ChargeItems" } }, "charge_type" : { "type" : "string", "description" : "缴费项模式：空或\"N\"，表示缴费项不可选，\r\t\"M\"表示缴费项为可选 ，支持单选和多选。", "example" : "M" }, "child_name" : { "type" : "string", "description" : "孩子名字", "example" : "张晓晓" }, "class_in" : { "type" : "string", "description" : "孩子所在班级", "example" : "3班" }, "end_enable" : { "type" : "string", "description" : "截止日期是否生效，与gmt_end发布配合使用,N为gmt_end不生效，用户过期后仍可以缴费；Y为gmt_end生效，用户过期后，不能再缴费。", "example" : "Y" }, "ext_info" : { "$ref" : "#/components/schemas/BillSendExtInfo" }, "gmt_end" : { "type" : "string", "description" : "缴费截止时间，格式\"yyyy-MM-dd HH:mm:ss\"，日期要大于当前时间。请注意，过期时间不宜设置过短。", "example" : "2016-01-01 13:13:13" }, "grade" : { "type" : "string", "description" : "孩子所在年级", "example" : "高一" }, "out_trade_no" : { "type" : "string", "description" : "ISV端的缴费账单编号", "example" : "20160232343253253453" }, "partner_id" : { "type" : "string", "description" : "Isv支付宝pid, 支付宝签约后，返回给ISV编号", "example" : "201600129391238873" }, "school_no" : { "type" : "string", "description" : "学校编码，录入学校接口返回的参数", "example" : "11010100000002" }, "school_pid" : { "type" : "string", "description" : "学校支付宝pid,直付通填写smid", "example" : "20880012939123234423" }, "student_code" : { "type" : "string", "description" : "学生的学号，只支持字母和数字类型，一般以教育局学号为准，作为学生的唯一标识。此字段与student_identify、家长user_mobile至少选一个", "example" : "2098453900091" }, "student_identify" : { "type" : "string", "description" : "学生的身份证号，如果ISV有学生身份证号，则同步身份证号作为学生唯一标识。此字段与student_code、家长user_mobile至少选一个。\r\t大陆身份证必须是18位 ， 其它地区或国家的身份证开头需要加\"IC\"开头区分并且不超过18位，但查询账单的时候不要带\"IC\"", "example" : "310193199905289483" }, "users" : { "type" : "array", "description" : "孩子的家长信息，最多一次输入10个家长，此字段做为识别家长的孩子用，与student_identify、student_code至少选一个", "items" : { "$ref" : "#/components/schemas/UserDetails" } } } }, "AlipayEcoEduKtBillingSendResponseModel" : { "type" : "object", "properties" : { "order_no" : { "type" : "string", "description" : "支付宝－中小学－教育缴费的账单号", "example" : "20160101909909354354354" } } }, "AlipayEcoEduKtParentQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoEduKtParentQueryResponseModel" : { "type" : "object", "properties" : { "status" : { "type" : "string", "description" : "如果用户已经添加过这个孩子，则返回SUCCESS ， 失败返回FAIL。", "example" : "SUCCESS" } } }, "AlipayEcoEduKtSchoolinfoModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "BIZ_ERROR", "INVALID_PARAMETER_COLLEGE_SCHOOL_TYPE_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoEduKtSchoolinfoModifyModel" : { "type" : "object", "properties" : { "bank_notify_url" : { "type" : "string", "description" : "与浙江网商交易见证平台有交互ISV输入网商交易异步通知回调URL，教育缴费同步账单信息给网商，网商会回调此url，ISV即可获取网商相关的参数，根据教育缴费平台账单发送接口返回的 order_no和网商返回的outer_trade_no来对应账单信息。", "example" : "https://www.xxx.xxx/xx" }, "bank_partner_id" : { "type" : "string", "description" : "与浙江网商交易见证平台有交互的ISV,由交易见证平台分配给合作方业务平台 签约唯一ID ，由网商分配给ISV的渠道参数", "example" : "200002924334" }, "bank_uid" : { "type" : "string", "description" : "与浙江网商交易见证平台有交互的ISV在创建账户时的uid，也就是ISV平台上的用户ID（字母或数字）", "example" : "20000293230232" }, "bankcard_no" : { "type" : "string", "description" : "对应集团到卡模式的银行编号.学校与支付宝后台签约时，由学校提交给支付宝的编号", "example" : "P0004" }, "batch_no" : { "type" : "string", "description" : "集团收单模式：分账批次号，支付宝配置后提供的银行卡批次号", "example" : "201812180111030000034567270022" }, "card_alias_no" : { "type" : "string", "description" : "学校开通直付通卡编号，smid与card_alias_no必须同时填写", "example" : "c6c0c7a1b9d54e5db9d49eed39f00e65" }, "city_code" : { "type" : "string", "description" : "城市的国家编码。参见 国家统计局出版的行政区划代码。", "example" : "330100" }, "city_name" : { "type" : "string", "description" : "城市名称", "example" : "杭州市" }, "corporate_branch_pid" : { "type" : "string", "description" : "集团收单模式：BD批量上传银行卡信息后，支付宝系统分配给ISV的每个卡分配的唯一标识", "example" : "2088301031335812" }, "district_code" : { "type" : "string", "description" : "区县的国家编码。参见 国家统计局出版的行政区划代码。", "example" : "330106" }, "district_name" : { "type" : "string", "description" : "区县名称", "example" : "西湖区" }, "isv_name" : { "type" : "string", "description" : "ISV公司名称 ， 会在账单详情页面展示给用户", "example" : "杭州少年宫" }, "isv_no" : { "type" : "string", "description" : "注意：本参数于2017-08-03开始已经废弃，不再需要传递。\t由支付宝提供的给已经签约的isv的编码，业务上一般直接采用isv的支付宝PID。", "example" : "201600129391238873" }, "isv_notify_url" : { "type" : "string", "description" : "此通知地址是为了保持教育缴费平台与ISV商户支付状态一致性。用户支付成功后，支付宝会根据本isv_notify_url(异步通知说明https://docs.open.alipay.com/203/105286/)，通过POST请求的形式将支付结果作为参数通知到商户系统，ISV商户可以根据返回的参数更新账单状态。", "example" : "https://isv.com/xxx" }, "isv_phone" : { "type" : "string", "description" : "ISV的联系方式 ， 会在账单详情页面展示给用户，用户有问题可以直接联系此电话获取帮助", "example" : "13300000000" }, "isv_pid" : { "type" : "string", "description" : "填写已经签约教育缴费的isv的支付宝PID", "example" : "2088121212121212" }, "province_code" : { "type" : "string", "description" : "省份的国家编码，参见 国家统计局出版的行政区划代码。", "example" : "330000" }, "province_name" : { "type" : "string", "description" : "省名称", "example" : "浙江省" }, "school_icon" : { "type" : "string", "description" : "学校的校徽或logo，在学校展示页面作为学校的标识。该字段为图片的链接地址，只支持png或jpg图片格式，图片高度为108，宽度为108 ，不大于20k。\r\t注意：此链接要求公网可以访问，否则无法正常展示。", "example" : "http://ecopublic-dev.oss-cn-hangzhou.aliyuncs.com/eco/edu_alipay/school/school.png" }, "school_icon_type" : { "type" : "string", "description" : "如果填写了school_icon参数，则此字段不能为空。目前只支持png和jpg两种格式", "example" : "png" }, "school_name" : { "type" : "string", "description" : "学校名称", "example" : "杭州市西湖第一实验学校" }, "school_pid" : { "type" : "string", "description" : "学校签约支付宝教育缴费支付宝pid,如果是直付通学校，填写直付通返回的smid", "example" : "20880012939123234423" }, "school_stdcode" : { "type" : "string", "description" : "学校(机构)标识码（由教育部按照国家标准及编码规则编制，可以在教育局官网查询）", "example" : "3133005132" }, "school_type" : { "type" : "string", "description" : "学校的类型。枚举值如下：\t*1：代表托儿所。\t*2：代表幼儿园。\t*3：代表小学。\t*4：代表初中。\t*5：代表高中。\t注意：如果学校兼有多种属性，可以连写，比如：45：代表兼有初中部高中部；34：代表兼有小学部初中部。", "example" : "4" }, "smid" : { "type" : "string", "description" : "学校开通直付通返回的二级商户id，smid与card_alias_no必须同时填写", "example" : "2088301031335814" }, "trans_in" : { "type" : "string", "description" : "集团收单模式：分账批次号，支付宝配置后提供的银行卡批次号", "example" : "4325353" }, "white_channel_code" : { "type" : "string", "description" : "与浙江网商交易见证平台有交互的ISV,由网商分配给ISV的渠道参数", "example" : "TESTBANK10301" } } }, "AlipayEcoEduKtSchoolinfoModifyResponseModel" : { "type" : "object", "properties" : { "school_no" : { "type" : "string", "description" : "支付宝分配给学校的编码，作为学校在支付宝的标识", "example" : "11010100000002" }, "status" : { "type" : "string", "description" : "Y：代表成功；N：代表失败", "example" : "Y" } } }, "AlipayEcoEduKtStudentModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoEduKtStudentModifyModel" : { "type" : "object", "properties" : { "child_name" : { "type" : "string", "description" : "修改后的学生姓名\r\t本接口调用时，child_name、student_code、student_identify、users这几个参数至少需要填写其中一个，不能同时为空", "example" : "张三" }, "isv_pid" : { "type" : "string", "description" : "已经签约教育缴费的isv的支付宝PID", "example" : "2088121212121212" }, "school_no" : { "type" : "string", "description" : "学校编号，调用alipay.eco.edu.kt.schoolinfo.modify接口录入学校信息时，接口返回的编号", "example" : "11010100000001" }, "school_pid" : { "type" : "string", "description" : "学校用来签约支付宝教育缴费的支付宝PID", "example" : "2088101117955611" }, "status" : { "type" : "string", "description" : "区分ISV操作，“D”表示删除，“U”表示更新，区分大小写。\r\t如果为U，则学生名字，学号，身份证至少填写一项", "example" : "U" }, "student_code" : { "type" : "string", "description" : "修改后的学号\r\t本接口调用时，child_name、student_code、student_identify、users这几个参数至少需要填写其中一个，不能同时为空", "example" : "6589154" }, "student_identify" : { "type" : "string", "description" : "修改后的身份证号码\r\t本接口调用时，child_name、student_code、student_identify、users这几个参数至少需要填写其中一个，不能同时为空", "example" : "610824197812044680" }, "student_no" : { "type" : "string", "description" : "支付宝-中小学-教育缴费生成的学生唯一编号", "example" : "57de63cb1ef157595c005467" }, "users" : { "type" : "array", "description" : "孩子的家长信息，最多一次输入20个家长。如果输入的家长信息不存在，则该改学生增加家长信息\r\t本接口调用时，child_name、student_code、student_identify、users这几个参数至少需要填写其中一个，不能同时为空", "items" : { "$ref" : "#/components/schemas/UserDetails" } } } }, "AlipayEcoEduKtStudentModifyResponseModel" : { "type" : "object", "properties" : { "status" : { "type" : "string", "description" : "Y：代表成功；N：代表失败", "example" : "Y" } } }, "AlipayEcoFilePathQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAM_ERROR", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoFilePathQueryResponseModel" : { "type" : "object", "properties" : { "file_id" : { "type" : "string", "description" : "文件Id", "example" : "049d33945cde46b7953bf377fe2a7608" }, "upload_url" : { "type" : "string", "description" : "文件直传地址, 可以重复使用，但是只能传一样的文件，有效期一小时", "example" : "https://esignoss.oss-cn-hangzhou.aliyuncs.com/1111563786/d8d35867-744b-47f3-890f-e3650efd99e1/%E9%99%84%E4%BB%B6.zip?Expires=1561472338&OSSAccess..." } } }, "AlipayEcoMycarParkingChargeinfoSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "BIZ_ERROR", "INVALID_PARAMETER", "MERCHANT_VERIFY_FAILED", "EMPTY_PARAMETER", "PARAMETER_FORMAT_ERR", "PARKING_ID_EMPTY", "IS_CHARGE_EMPTY", "IS_CHARGE_INVALID", "PARKING_SPACE_COUNT_EMPTY", "BUSINESS_HOURS_EMPTY", "HAS_CHARGING_PILE_EMPTY", "HAS_CHARGING_PILE_INVALID", "FREE_PERIOD_EMPTY", "DAILY_PRICE_UPPERBOUND_EMPTY", "DAYLIGHT_BUSINESS_HOURS_EMPTY", "NIGHT_BUSINESS_HOURS_EMPTY", "CAR_DAYLIGHT_BASE_PRICE_EMPTY", "CAR_DAYLIGHT_ADVANCED_PRICE_EMPT", "CAR_NIGHT_BASE_PRICE_EMPTY", "CAR_NIGHT_ADVANCED_PRICE_EMPTY", "TRUCK_DAYLIGHT_BASE_PRICE_EMPTY", "TRUCK_DAYLIGHT_ADVANCED_PRICE_EM", "TRUCK_NIGHT_BASE_PRICE_EMPTY", "TRUCK_NIGHT_ADVANCED_PRICE_EMPTY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoMycarParkingChargeinfoSyncModel" : { "type" : "object", "properties" : { "business_hours" : { "type" : "string", "description" : "营业时间", "example" : "24小时" }, "car_daylight_advanced_price" : { "type" : "string", "description" : "小车-白天 非首个计费单元价格", "example" : "3元/小时或1.5元/30分钟" }, "car_daylight_base_price" : { "type" : "string", "description" : "小车-白天 首个计费单元价格", "example" : "10元/1小时或5元/30分钟" }, "car_night_advanced_price" : { "type" : "string", "description" : "小车-夜间 非首个计费单元价格", "example" : "3元/小时或1.5元/30分钟" }, "car_night_base_price" : { "type" : "string", "description" : "小车-夜间 首个计费单元价格", "example" : "10元/1小时或5元/30分钟" }, "car_onetime_price" : { "type" : "string", "description" : "小车 计次收费价格\r\txx元 / 次，按次收费的车场填写", "example" : "20元/次" }, "daily_price_upperbound" : { "type" : "string", "description" : "单日停车封顶价格：具体值或“不封顶”", "example" : "260元或不封顶" }, "daylight_business_hours" : { "type" : "string", "description" : "车场白天（收费）营业时间段", "example" : "9:00-21:00" }, "free_period" : { "type" : "string", "description" : "单次停车免费时长", "example" : "30分钟" }, "has_charging_pile" : { "type" : "string", "description" : "是否有充电桩: -1 未知,0 否,1 是", "example" : "1" }, "is_charge" : { "type" : "string", "description" : "是否收费：-1 未知,0 否,1 是", "example" : "1" }, "night_business_hours" : { "type" : "string", "description" : "车场夜间（收费）营业时间段", "example" : "21:00-9:00" }, "parking_id" : { "type" : "string", "description" : "停车场ID", "example" : "PI20190506152394234234" }, "parking_space_count" : { "type" : "integer", "description" : "总车位数", "example" : "1600" }, "remark" : { "type" : "string", "description" : "复杂计费补充描述\r\t收费复杂无法格式化的车场填写，以文本形式表述", "example" : "前3小时XXX，3-6小时之间XXX，超过6小时XXXX" }, "truck_daylight_advanced_price" : { "type" : "string", "description" : "大车-白天 非首个计费单元价格", "example" : "3元/小时或1.5元/30分钟" }, "truck_daylight_base_price" : { "type" : "string", "description" : "大车-白天 首个计费单元价格", "example" : "10元/1小时或5元/30分钟" }, "truck_night_advanced_price" : { "type" : "string", "description" : "大车-夜间 非首个计费单元价格", "example" : "4元/次" }, "truck_night_base_price" : { "type" : "string", "description" : "大车-夜间 首个计费单元价格", "example" : "3元/小时或1.5元/30分钟" }, "truck_onetime_price" : { "type" : "string", "description" : "大车 计次收费价格\r\txx元 / 次，按次收费的车场填写", "example" : "30元/次" } } }, "AlipayEcoMycarParkingChargeinfoSyncResponseModel" : { "type" : "object", "properties" : { "sync_result" : { "type" : "string", "description" : "同步结果：0 成功，1 失败", "example" : "0" } } }, "AlipayEcoMycarParkingCharginginfoSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "BIZ_ERROR", "INVALID_PARAMETER", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoMycarParkingCharginginfoSyncModel" : { "type" : "object", "properties" : { "car_number" : { "type" : "string", "description" : "车牌号", "example" : "浙Axxxxx" }, "isv_url" : { "type" : "string", "description" : "智能助理当前的跳转链接", "example" : "http://xxxxxx" }, "parking_id" : { "type" : "string", "description" : "支付宝停车平台ID，由支付宝定义的该停车场标识，同一个isv或商户范围内唯一。通过 alipay.eco.mycar.parking.parkinglotinfo.create(录入停车场信息)接口获取。", "example" : "2015042321001004720200028594" }, "serial_no" : { "type" : "string", "description" : "支付宝业务流水号，用于记录车辆从驶入到驶出的全流程。通过 alipay.eco.mycar.parking.enterinfo.sync\t(车辆驶入接口)接口获取。", "example" : "2020090711003017233600000001" } } }, "AlipayEcoMycarParkingCharginginfoSyncResponseModel" : { "type" : "object" }, "AlipayEcoMycarParkingConfigQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INTERFACE_TYPE_IS_ILLEGAL", "MERCHANT_INFO_IS_EMPTY", "INTERFACE_INFO_IS_EMPTY", "SERVICE_NAME_IS_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoMycarParkingConfigQueryResponseModel" : { "type" : "object", "properties" : { "account_no" : { "type" : "string", "description" : "签约支付宝账号，开发者通过ISV系统配置信息注册接口(alipay.eco.mycar.parking.config.set)传入的参数值", "example" : "1234567@126.com" }, "interface_info_list" : { "$ref" : "#/components/schemas/InterfaceInfoList" }, "merchant_logo" : { "type" : "string", "description" : "商户在停车平台首页露出的LOGO链接地址，开发者通过ISV系统配置信息注册接口(alipay.eco.mycar.parking.config.set)调用自动生成该链接", "example" : "http://ecopublic.oss-cn-hangzhou.aliyuncs.com/eco/carlife/parking/merchantlogo/xiaoshanjichang.png" }, "merchant_name" : { "type" : "string", "description" : "商户简称，开发者通过ISV系统配置信息注册接口(alipay.eco.mycar.parking.config.set)传入的参数值", "example" : "杭州立方" }, "merchant_service_phone" : { "type" : "string", "description" : "商户客服电话，开发者通过ISV系统配置信息注册接口(alipay.eco.mycar.parking.config.set)传入的参数值", "example" : "021-25413215" } } }, "AlipayEcoMycarParkingConfigSetErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "MERCHANT_NAME_IS_EMPTY", "MERCHANT_PHONE_IS_EMPTY", "ACCOUNT_NO_IS_EMPTY", "INTERFACE_TYPE_IS_EMPTY", "INTERFACE_TYPE_IS_ILLEGAL", "INTERFACE_URL_IS_EMPTY", "INTERFACE_URL_IS_ILLEGAL", "SERVICE_NAME_IS_EMPTY", "SERVICE_NAME_IS_ILLEGAL", "INTERFACE_LIST_IS_EMPTY", "SYSTEM_ERROR", "MERCHANT_LOGO_FORMAT_ERROR", "MERCHANT_LOGO_IS_ILLEGAL", "MERCHANT_LOGO_UPLOAD_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoMycarParkingConfigSetModel" : { "type" : "object", "properties" : { "account_no" : { "type" : "string", "description" : "签约支付宝账号", "example" : "1234567@126.com" }, "interface_info_list" : { "type" : "array", "description" : "接口信息列表，停车业务需要配置的接口列表，该值为JSON数据格式的LIST对象，现阶段只需要配置一个页面接口即可 。每次请将所有的接口配置信息都传入，未传的接口信息将会被置空。", "items" : { "$ref" : "#/components/schemas/InterfaceInfoList" } }, "merchant_logo" : { "type" : "string", "description" : "商户在停车平台首页露出的LOGO。\t注意：\t*该图片为PNG格式，内容为BASE64的字符串，建议图片尺寸27px*27px，大小不要超过60K。\t*若为空则停车平台首页将不露出商户LOGO。", "example" : "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAIAAAACCAYAAABytg0kAAAAE0lEQVQImWP81mfxn4GJAYQgAAAqvgLBUG4ufAAAAABJRU5ErkJggg==" }, "merchant_name" : { "type" : "string", "description" : "商户简称，由开发者提供", "example" : "杭州立方" }, "merchant_service_phone" : { "type" : "string", "description" : "商户客服电话", "example" : "021-25413215" } } }, "AlipayEcoMycarParkingConfigSetResponseModel" : { "type" : "object" }, "AlipayEcoMycarParkingEnterinfoSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR", "CALL_TOO_OFFTEN", "ISV_APP_ID_ILLEGAL", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoMycarParkingEnterinfoSyncModel" : { "type" : "object", "properties" : { "agreement_query" : { "type" : "boolean", "description" : "是否启用车牌代扣状态查询功能，true为启用，false为停用", "example" : "true" }, "car_color" : { "type" : "string", "description" : "车牌颜色，车牌颜色，枚举支持：\t*BLUE：蓝。\t*GREEN：绿。\t*YELLOW：黄。\t*WHITE：白。\t*BLACK：黑。\t*LIMEGREEN：黄绿色。", "example" : "BLUE" }, "car_number" : { "type" : "string", "description" : "车牌号", "example" : "豫C33333" }, "entrance_id" : { "type" : "string", "description" : "用于识别车辆进口，多出入口车场适用", "example" : "SN001" }, "free_minutes" : { "type" : "integer", "description" : "当前停车场的入场免费时长分钟数", "example" : "15" }, "in_time" : { "type" : "string", "description" : "车辆入场的时间，格式\"YYYY-MM-DD HH:mm:ss\"，24小时制，请保证服务器时间准确，入场时间不应晚于当前网络时间", "example" : "2016-07-24 03:07:50" }, "is_encrypt_car_number" : { "type" : "boolean", "description" : "是否加密，默认为false", "example" : "true" }, "isv_url" : { "type" : "string", "description" : "智能助理当前的跳转链接。为ISV/商家小程序scheme地址或H5页面地址。", "example" : "http://xxxxx" }, "out_serial_no" : { "type" : "string", "description" : "外部停车流水号(用于串通进场与出场信息)", "example" : "2020090711003017233600000001" }, "parking_id" : { "type" : "string", "description" : "支付宝停车平台ID，由支付宝定义的该停车场标识，同一个isv或商户范围内唯一。通过 alipay.eco.mycar.parking.parkinglotinfo.create(录入停车场信息)接口获取。", "example" : "2015042321001004720200028594" }, "space_number" : { "type" : "string", "description" : "用于标识车辆停放车位编号，路侧适用", "example" : "PK001" }, "store_id" : { "type" : "string", "description" : "与parking_id对应的外部停车场编号，在球房中维护", "example" : "360xx" } } }, "AlipayEcoMycarParkingEnterinfoSyncResponseModel" : { "type" : "object", "properties" : { "agreement_scene" : { "type" : "string", "description" : "用户签约的代扣场景字符集，多个英文逗号分割，当车场为ORC识别车牌的场景，返回值包含PLATE_PAY时，表示代扣协议可用。 当车场为ETC设备识别车牌，返回值包含ETC_PAY时表示协议可用。当用户未签约任何代扣场景时返回NO_AGREEMENT_SCENE", "example" : "PLATE_PAY,ETC_PAY" }, "agreement_status" : { "type" : "string", "description" : "该字段已废弃,请使用agreement_scene字段", "example" : "0：已签约无感代扣 1：未签约" }, "car_status" : { "type" : "string", "description" : "当前车辆在支付宝侧的信息，是否可以使用无感支付，可选返回项为： NORMAL：正常缴费用户 NON-SENSE-PAY：可无感支付用户", "example" : "NORMAL" }, "current_time" : { "type" : "string", "description" : "当前时间戳(查询签约状态和是否支持无感支付仅代表当前时间点查询结果，不作为最后代扣结果，应在发起代扣前再次查询)", "example" : "2020-11-27 15:40:00" }, "serial_no" : { "type" : "string", "description" : "支付宝业务流水号，用于记录车辆从驶入到驶出的全流程", "example" : "2020090711003017233600000001" } } }, "AlipayEcoMycarParkingExitinfoSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "BIZ_ERROR", "CALL_TOO_OFFTEN", "SERIAL_NO_ENTER_NO_RECORD", "SERIAL_NO_DOUBLE_ENTER_NO_RECORD" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoMycarParkingExitinfoSyncModel" : { "type" : "object", "properties" : { "actual_amount" : { "type" : "string", "description" : "实际金额", "example" : "10.00" }, "car_color" : { "type" : "string", "description" : "车牌颜色，枚举支持：\t*BLUE：蓝。\t*GREEN：绿。\t*YELLOW：黄。\t*WHITE：白。\t*BLACK：黑。\t*LIMEGREEN：黄绿色。", "example" : "BLUE" }, "car_number" : { "type" : "string", "description" : "车牌号", "example" : "豫C33333" }, "discount_amount" : { "type" : "string", "description" : "折扣金额", "example" : "10.00" }, "exit_id" : { "type" : "string", "description" : "用于识别车辆出口，多出入口车场适用", "example" : "SN001" }, "is_encrypt_car_number" : { "type" : "boolean", "description" : "是否加密，默认为false", "example" : "false" }, "isv_url" : { "type" : "string", "description" : "智能助理当前的跳转链接", "example" : "http://xxxxx" }, "order_amount" : { "type" : "string", "description" : "订单总金额", "example" : "10.00" }, "out_serial_no" : { "type" : "string", "description" : "外部停车流水号(用于串通进场与出场信息)", "example" : "2020090711003017233600000001" }, "out_time" : { "type" : "string", "description" : "车辆离场时间，格式\"YYYY-MM-DD HH:mm:ss\"，24小时制", "example" : "2016-07-24 03:07:50" }, "parking_id" : { "type" : "string", "description" : "支付宝停车平台ID，由支付宝定义的该停车场标识，同一个ISV或商户范围内唯一。通过 alipay.eco.mycar.parking.parkinglotinfo.create(录入停车场信息)接口获取。", "example" : "PI1592907192010409114" }, "serial_no" : { "type" : "string", "description" : "支付宝业务流水号，用于记录车辆从驶入到驶出的全流程。通过 alipay.eco.mycar.parking.enterinfo.sync(车辆驶入接口)接口获取。", "example" : "2020090711003017233600000001" }, "space_number" : { "type" : "string", "description" : "用于标识车辆停放车位编号，路侧适用", "example" : "PK001" }, "store_id" : { "type" : "string", "description" : "与parking_id对应的外部停车场编号，在球房中维护", "example" : "360xx" } } }, "AlipayEcoMycarParkingExitinfoSyncResponseModel" : { "type" : "object" }, "AlipayEcoMycarParkingOrderSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "BIZ_ERROR", "INVALID_PARAMETER", "PARKING_USER_ID_IS_EMPTY", "PARKING_USER_ID_FORMAT_ERROR", "PARKING_OUT_ORDER_NO_IS_EMPTY", "PARKING_ORDER_STATUS_IS_EMPTY", "PARKING_ORDER_TIME_IS_EMPTY", "PARKING_ORDER_TIME_FORMAT_ERROR", "PARKING_ORDER_NO_IS_EMPTY", "PARKING_PAY_TIME_IS_EMPTY", "PARKING_PAY_TIME_FORMAT_ERROR", "PARKING_PAY_TYPE_IS_EMPTY", "PARKING_PAY_TYPE_ILLEGAL", "PARKING_PAY_MONEY_IS_EMPTY", "PARKING_PAY_MONEY_ILLEGAL", "PARKING_IN_TIME_IS_EMPTY", "PARKING_IN_TIME_FORMAT_ERROR", "PARKING_IN_DURATION_IS_EMPTY", "PARKING_CAR_NUMBER_IS_EMPTY", "PARKING_CAR_NUMBER_FORMAT_ERROR", "PARKING_NAME_LENGTH_TOO_LONG", "PARKING_ID_IS_EMPTY", "PARKING_LOT_NOT_EXIST", "ISV_APP_ID_ILLEGAL", "SYSTEM_ERROR", "PARKING_ORDER_STATUS_ILLEGAL", "PARKING_DEDUCT_ORDER_HAS_SYNCED", "NO_PERMISSION_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoMycarParkingOrderSyncModel" : { "type" : "object", "properties" : { "agent_pid" : { "type" : "string", "description" : "该笔停车交易需要返佣的对象实体PID，可能是商户，可能是ISV；只做下沉，用于离线表层面对账。", "example" : "2088xxxxxx" }, "car_number" : { "type" : "string", "description" : "车牌", "example" : "浙Axxxxx" }, "card_number" : { "type" : "string", "description" : "如果是停车卡缴费，则填入停车卡卡号，否则为'*'", "example" : "2357868977445645645656" }, "in_duration" : { "type" : "string", "description" : "停车时长（以分为单位）", "example" : "320" }, "in_time" : { "type" : "string", "description" : "入场时间，格式\"YYYY-MM-DD HH:mm:ss\"，24小时制", "example" : "2016-08-12 20:20:13" }, "open_id" : { "type" : "string", "description" : "应用用户ID，唯一标识", "example" : "021uU2O6oUtUsckXA1rpUpiWpFWNTOFZXoOgVOPIrkW2Dgb" }, "order_no" : { "type" : "string", "description" : "支付宝支付流水，系统唯一", "example" : "7674879087745646586" }, "order_status" : { "type" : "string", "description" : "设备商订单状态，枚举支持：\t* 0：成功。\t* 1：失败。", "example" : "1" }, "order_time" : { "type" : "string", "description" : "订单创建时间，格式\"YYYY-MM-DD HH:mm:ss\"，24小时制", "example" : "2016-08-12 20:27:30" }, "out_order_no" : { "type" : "string", "description" : "设备商订单号，由ISV系统生成", "example" : "201605061278654435466567" }, "out_parking_id" : { "type" : "string", "description" : "ISV停车场ID，由ISV定义的停车场标识，同一个isv或商户范围内唯一。需与 alipay.eco.mycar.parking.parkinglotinfo.create(录入停车场信息)接口传入值一致。", "example" : "201605061278654" }, "out_time" : { "type" : "string", "description" : "出场时间，格式\"YYYY-MM-DD HH:mm:ss\"，24小时制", "example" : "2021-03-04 15:04:05" }, "parking_id" : { "type" : "string", "description" : "支付宝停车平台ID，由支付宝定义的该停车场标识，同一个isv或商户范围内唯一。通过 alipay.eco.mycar.parking.parkinglotinfo.create(录入停车场信息)接口获取。", "example" : "1234567890123456" }, "parking_name" : { "type" : "string", "description" : "停车场名称，需与alipay.eco.mycar.parking.parkinglotinfo.create(录入停车场信息)接口传入值一致。", "example" : "上海证大五道口地下停车场" }, "parking_record_id" : { "type" : "string", "description" : "支付宝业务流水号，用于记录车辆从驶入到驶出的全流程。通过 alipay.eco.mycar.parking.enterinfo.sync(车辆驶入接口)接口获取。", "example" : "2020090711003017233600000001" }, "pay_money" : { "type" : "string", "description" : "缴费金额，保留小数点后两位", "example" : "20.00" }, "pay_scene" : { "type" : "string", "description" : "支付场景：INPARKINGLOT_PAY：场内在线缴费；ENTRANCE_EXIT_PAY：出入口缴费、VEH_DEVICE_PAY：车机缴费；会根据场景判断是否发放能量，当前只有场内支付场景会发能量，需要能量发放请与服务接入支持同学提前沟通。", "example" : "INPARKINGLOT_PAY" }, "pay_time" : { "type" : "string", "description" : "缴费时间, 格式\"YYYYMM-DD HH:mm:ss\"，24小时制", "example" : "2016-08-12 23:20:23" }, "pay_type" : { "type" : "string", "description" : "付款方式，枚举支持：\t*1：支付宝在线缴费。", "example" : "1" }, "smid" : { "type" : "string", "description" : "间连商户ID", "example" : "12345678900" }, "user_id" : { "type" : "string", "description" : "停车缴费用户 id，用户在支付宝的唯一标识，以 2088 开头的 16 位纯数字组成。\t注意：ISV需保证用户 id的正确性，以免导致用户在停车平台查询不到相关的订单信息。", "example" : "2088006362935583" } } }, "AlipayEcoMycarParkingOrderSyncResponseModel" : { "type" : "object" }, "AlipayEcoMycarParkingOrderUpdateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "BIZ_ERROR", "INVALID_PARAMETER", "PARKING_DEDUCT_ORDER_NOT_SUPPORT_UPDATE", "PARKING_USER_ID_IS_EMPTY", "PARKING_USER_ID_FORMAT_ERROR", "PARKING_ORDER_STATUS_IS_EMPTY", "PARKING_ORDER_NO_IS_EMPTY", "PARKING_ORDER_STATUS_ILLEGAL", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoMycarParkingOrderUpdateModel" : { "type" : "object", "properties" : { "open_id" : { "type" : "string", "description" : "应用用户ID，唯一标识", "example" : "021uU2O6oUtUsckXA1rpUpiWpFWNTOFZXoOgVOPIrkW2Dgb" }, "order_no" : { "type" : "string", "description" : "支付宝支付流水号，系统唯一", "example" : "PO20160805204323394865" }, "order_status" : { "type" : "string", "description" : "用户停车订单状态，枚举支持：\t*0：成功。\t*1：失败。", "example" : "1" }, "user_id" : { "type" : "string", "description" : "停车缴费用户 id，用户在支付宝的唯一标识，以 2088 开头的 16 位纯数字组成。\t注意：ISV需保证用户 id 的正确性，以免导致用户在停车平台查询不到相关的订单信息。", "example" : "2088006362935583" } } }, "AlipayEcoMycarParkingOrderUpdateResponseModel" : { "type" : "object" }, "AlipayEcoMycarParkingOvertimecharginginfoSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "BIZ_ERROR", "INVALID_PARAMETER", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoMycarParkingOvertimecharginginfoSyncModel" : { "type" : "object", "properties" : { "car_number" : { "type" : "string", "description" : "车牌号", "example" : "浙Axxxxx" }, "isv_url" : { "type" : "string", "description" : "智能助理当前的跳转链接", "example" : "http://xxxxx" }, "parking_id" : { "type" : "string", "description" : "支付宝停车平台ID，由支付宝定义的该停车场标识，同一个isv或商户范围内唯一。通过 alipay.eco.mycar.parking.parkinglotinfo.create(录入停车场信息)接口获取。", "example" : "2015042321001004720200028594" }, "serial_no" : { "type" : "string", "description" : "支付宝业务流水号，用于记录车辆从驶入到驶出的全流程", "example" : "2020090711003017233600000001" } } }, "AlipayEcoMycarParkingOvertimecharginginfoSyncResponseModel" : { "type" : "object" }, "AlipayEcoMycarParkingParkinglotbizTransferErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "NOT_PARKING", "NOT_PARKING_PERMISSIONS", "ONLINET_ACCOUNT_BAD_NOT_APPS", "AGREEMENT_ACCOUNT_BAD_NOT_APPS", "AGREEMENT_ACCOUNT_BAD_NOT_SIGN" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoMycarParkingParkinglotbizTransferModel" : { "type" : "object", "properties" : { "business_isv" : { "type" : "array", "description" : "车场业务归属关系列表", "items" : { "$ref" : "#/components/schemas/BusinessItem" } }, "parking_id" : { "type" : "string", "description" : "车场创建返回的parking_id字段", "example" : "PI1480989659571286385" } } }, "AlipayEcoMycarParkingParkinglotbizTransferResponseModel" : { "type" : "object" }, "AlipayEcoMycarParkingParkinglotinfoCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR", "MERCHANT_ID_IS_EMPTY", "MERCHANT_ID_FORMAT_ERROR", "PARKING_POI_ID_IS_EMPTY", "ISV_PID_IS_EMPTY", "PARKING_SUPPORT_AFTER_PAY_ILLEGAL", "PARKING_TIME_OUT_ILLEGAL", "PARKING_POI_NOT_FIND", "PARKING_POI_TYPE_NOT_MATCH", "PARKING_LEADS_HAS_REGISTERED", "PARKING_POI_HAS_REGISTERED", "PARKING_IS_SUPPORT_INVOICE_ILLEGAL", "PARKING_BIZ_TAGS_ILLEGAL", "PARKING_SUM_SPACE_ILLEGAL", "PARKING_ISV_MOBILE_FORMAT_ERROR", "PARKING_ORIGINAL_ISV_MOBILE_FORMAT_ERROR", "PARKING_FEE_DESC_IMG_ILLEGAL", "PARKING_FEE_DESC_IMG_UPLOAD_ERROR", "SYSTEM_ERROR", "INVALID_PARAMETER_BUSINESS_ID", "INVALID_PARAMETER_BUSINESS_TYPE", "ONLINET_ACCOUNT_BAD_NOT_APPS", "AGREEMENT_ACCOUNT_BAD_NOT_APPS", "AGREEMENT_ACCOUNT_BAD_NOT_SIGN", "AGREEMENT_ACCOUNT_BAD_INVALID_PAYEE_ID", "PARKINGLOT_HAS_REGISTERED", "PARKINGLOT_TYPE_ERROR", "PARKINGLOT_BIZ_TYPE_ERROR", "PARKINGLOT_ONLINET_ACCOUNT_NOT_APPS", "PARKINGLOT_AGREEMENT_ACCOUNT_NOT_APPS", "PARKINGLOT_AGREEMENT_ACCOUNT_BAD_SIGN", "PARKINGLOT_POI_TYPE_NOT_MATCH", "PARKINGLOT_ISV_APP_ID_ILLEGAL", "PARKINGLOT_POI_NOT_FIND", "PARKINGLOT_POI_PARSE_ERROR", "PARKINGLOT_IMPORT_DELETE_ERROR", "NO_PERMISSION_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoMycarParkingParkinglotinfoCreateModel" : { "type" : "object", "properties" : { "agent_id" : { "type" : "string", "description" : "服务商的支付宝账号ID（2088开头的16位纯数字，获取方式），由服务商提供给ISV", "example" : "2088456825942563" }, "business_isv" : { "type" : "array", "description" : "车场业务归属列表", "items" : { "$ref" : "#/components/schemas/BusinessItem" } }, "city_id" : { "type" : "string", "description" : "该参数废弃", "example" : "110101" }, "contact_alipay" : { "type" : "string", "description" : "该参数废弃", "example" : "189xxxxxxxx" }, "contact_emali" : { "type" : "string", "description" : "该参数废弃", "example" : "alipay@alipay.com" }, "contact_mobile" : { "type" : "string", "description" : "该参数废弃", "example" : "189xxxxxxxx" }, "contact_name" : { "type" : "string", "description" : "该参数废弃", "example" : "张三" }, "contact_tel" : { "type" : "string", "description" : "该参数废弃", "example" : "0571xxxxxxxx" }, "contact_weixin" : { "type" : "string", "description" : "该参数废弃", "example" : "923422342" }, "equipment_name" : { "type" : "string", "description" : "该参数废弃", "example" : "杭州立方" }, "is_support_invoice" : { "type" : "string", "description" : "是否支持电子发票。枚举支持：\t0：表示不支持。\t1：表示支持。", "example" : "1" }, "isv_mobile" : { "type" : "string", "description" : "ISV电话，传入original_isv_pid、original_isv_appid时，此处为服务商电话", "example" : "571-8643-2799" }, "latitude" : { "type" : "string", "description" : "纬度", "example" : "30.548828" }, "longitude" : { "type" : "string", "description" : "经度", "example" : "114.266418" }, "mchnt_id" : { "type" : "string", "description" : "收款方的支付宝账号ID（2088开头的16位纯数字，获取方式），由停车场收款的业主方提供给ISV，该字段暂用于机具和物料申领", "example" : "2088456825942563" }, "original_isv_appid" : { "type" : "string", "description" : "ISV的APPID,服务商调用必传，由ISV提供给服务商", "example" : "2021002108619277" }, "original_isv_mobile" : { "type" : "string", "description" : "ISV电话，此值与isv_mobile组合使用", "example" : "571-8643-2799" }, "original_isv_name" : { "type" : "string", "description" : "ISV的名称，服务商调用必传，由ISV提供给服务商", "example" : "杭州立方" }, "original_isv_pid" : { "type" : "string", "description" : "ISV的PID，服务商调用必传,由ISV提供给服务商", "example" : "2088456825942563" }, "out_parking_id" : { "type" : "string", "description" : "ISV停车场ID，由ISV 自定义，同一个isv或商户范围内唯一", "example" : "10000110001" }, "parking_address" : { "type" : "string", "description" : "停车场地址", "example" : "浙江省杭州市古墩路与疏港公路的交汇处" }, "parking_end_time" : { "type" : "string", "description" : "该参数废弃", "example" : "03:07:50" }, "parking_fee_description" : { "type" : "string", "description" : "收费说明", "example" : "小车一小时10元" }, "parking_fee_description_img" : { "type" : "string", "description" : "商户在停车平台露出的停车价格图片；注意：该图片为PNG格式内容为BASE64的字符串，大小不要超过1MB", "example" : "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAIAAAACCAYAAABytg0kAAAAE0lEQVQImWP81mfxn4GJAYQgAAAqvgLBUG4ufAAAAABJRU5ErkJggg==" }, "parking_lot_type" : { "type" : "string", "description" : "停车场类型，1为居民小区、2为商圈停车场（购物中心商业广场商场等）、3为路侧停车、4为公园景点（景点乐园公园老街古镇等）、5为商务楼宇（酒店写字楼商务楼园区等）、6为其他、7为交通枢纽（机场火车站汽车站码头港口等）、8为市政设施（体育场博物图书馆医院学校等）", "example" : "1" }, "parking_mobile" : { "type" : "string", "description" : "停车场客服电话", "example" : "189XXXXXXXX" }, "parking_name" : { "type" : "string", "description" : "停车场名称，由ISV定义，尽量与高德地图上的一致。", "example" : "城西停车场" }, "parking_number" : { "type" : "string", "description" : "该参数废弃", "example" : "10000" }, "parking_poiid" : { "type" : "string", "description" : "如何获取parking_poiid（高德地图唯一标标识）参考文档 https://opendocs.alipay.com/support/01rghx；若无法成功获取高德POI时，也可选用经纬度的方式注册。", "example" : "B000A9JM2H" }, "parking_start_time" : { "type" : "string", "description" : "该参数废弃", "example" : "07:00:00" }, "parking_type" : { "type" : "string", "description" : "该参数废弃", "example" : "2" }, "pay_type" : { "type" : "string", "description" : "支付方式。枚举支持：\t1：表示支付宝在线缴费。\t2：表示支付宝代扣缴费。\t3：表示当面付。\t说明：如支持多种方式以 ',' 进行分隔。", "example" : "2" }, "payment_mode" : { "type" : "string", "description" : "该参数废弃", "example" : "1" }, "shopingmall_id" : { "type" : "string", "description" : "商圈id", "example" : "100001008" }, "sum_space" : { "type" : "string", "description" : "停车场车位数", "example" : "3000" }, "support_after_pay" : { "type" : "string", "description" : "是否支持先离后付。枚举支持：\tY：支持。\tN：不支持。\t说明：默认为空不支持，此参数适用于签约信用代扣的商户。", "example" : "Y" }, "time_out" : { "type" : "string", "description" : "用户支付未离场的超时时间(以分钟为单位)", "example" : "13" } } }, "AlipayEcoMycarParkingParkinglotinfoCreateResponseModel" : { "type" : "object", "properties" : { "parking_id" : { "type" : "string", "description" : "支付宝返回停车场id。成功不为空，失败返回空", "example" : "2014072300007148" } } }, "AlipayEcoMycarParkingParkinglotinfoQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR", "SYSTEM_ERROR", "PARKING_ID_FORMAT_ERROR", "BIZ_PARAM_ISNULL", "PARKING_LOT_NOT_EXIST", "PARKINGLOT_NOT_FIND", "NO_PERMISSION_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoMycarParkingParkinglotinfoQueryResponseModel" : { "type" : "object", "properties" : { "address_id" : { "type" : "string", "description" : "地区编码", "example" : "110105" }, "agent_id" : { "type" : "string", "description" : "服务商ID（2088开头的16位纯数字），由服务商提供给ISV", "example" : "2088456825942563" }, "business_isv" : { "type" : "array", "description" : "车场业务归属列表", "items" : { "$ref" : "#/components/schemas/BusinessItem" } }, "city_id" : { "type" : "string", "description" : "城市编码", "example" : "010" }, "map_poi_address" : { "type" : "string", "description" : "高德检索地址", "example" : "望京街4号望京SOHO" }, "map_poi_name" : { "type" : "string", "description" : "高德检索名称", "example" : "望京SOHO停车场" }, "mchnt_id" : { "type" : "string", "description" : "收款方ID（2088开头的16位纯数字），由停车场收款的业主方提供给ISV，该字段暂用于机具和物料申领", "example" : "2088456825942563" }, "out_parking_id" : { "type" : "string", "description" : "ISV停车场ID，由ISV提供，同一个isv或商户范围内唯一", "example" : "10000110001" }, "parking_address" : { "type" : "string", "description" : "停车场地址", "example" : "北京市朝阳区望京街与阜安西路交叉路口" }, "parking_fee_description" : { "type" : "string", "description" : "收费说明", "example" : "小车一小时10元" }, "parking_fee_description_img" : { "type" : "string", "description" : "停车场价格明细图片", "example" : "https://mdgwdev.alipay.net/afts/img/A*617CRpBdj_fJCs1NmMi4dQAAAa4wAA/original?bz=industry_etc&t=-NhhRTMCAllKiM3Vj1mNcQAAAABkMK5ft-HF" }, "parking_id" : { "type" : "string", "description" : "支付宝返回停车场id，系统唯一", "example" : "PI1532313981415143356" }, "parking_latitude" : { "type" : "string", "description" : "停车场位置经度（优先高德坐标获取结果）", "example" : "39.998001" }, "parking_longitude" : { "type" : "string", "description" : "停车场位置经度（优先高德坐标获取结果）", "example" : "116.480654" }, "parking_lot_type" : { "type" : "string", "description" : "停车场类型，1为居民小区、2为商圈停车场（购物中心商业广场商场等）、3为路侧停车、4为公园景点（景点乐园公园老街古镇等）、5为商务楼宇（酒店写字楼商务楼园区等）、6为其他、7为交通枢纽（机场火车站汽车站码头港口等）、8为市政设施（体育场博物图书馆医院学校等）", "example" : "2为商圈停车场（购物中心商业广场商场等）" }, "parking_mobile" : { "type" : "string", "description" : "停车场客服电话", "example" : "189XXXXXXXX" }, "parking_name" : { "type" : "string", "description" : "停车场名称，由ISV定义，尽量与高德地图上的一致", "example" : "望京SOHO停车场" }, "parking_poiid" : { "type" : "string", "description" : "高德地图唯一标识", "example" : "B0FFFAIBGG" }, "pay_type" : { "type" : "string", "description" : "支付方式（1为支付宝在线缴费，2为支付宝代扣缴费，3当面付)，如支持多种方式以','进行间隔", "example" : "2为支付宝代扣缴费" }, "province_id" : { "type" : "string", "description" : "省份编码", "example" : "110000" }, "shopingmall_id" : { "type" : "string", "description" : "商圈id", "example" : "100001008" }, "time_out" : { "type" : "string", "description" : "用户支付未离场的超时时间(以分钟为单位)", "example" : "13" } } }, "AlipayEcoMycarParkingParkinglotinfoUpdateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR", "MERCHANT_ID_IS_EMPTY", "MERCHANT_ID_FORMAT_ERROR", "PARKING_POI_ID_IS_EMPTY", "PARKING_POI_NOT_FIND", "PARKING_POI_TYPE_NOT_MATCH", "PARKING_LEADS_HAS_REGISTERED", "PARKING_POI_HAS_REGISTERED", "PARKING_ID_FORMAT_ERROR", "PARKING_MOBILE_IS_EMPTY", "PARKING_IS_SUPPORT_INVOICE_ILLEGAL", "PARKING_BIZ_TAGS_ILLEGAL", "PARKING_SUM_SPACE_ILLEGAL", "PARKING_ISV_MOBILE_FORMAT_ERROR", "PARKING_ORIGINAL_ISV_MOBILE_FORMAT_ERROR", "PARKING_FEE_DESC_IMG_ILLEGAL", "PARKING_FEE_DESC_IMG_UPLOAD_ERROR", "PARKING_LOT_HAS_REGISTERED", "PARKING_LOT_NOT_EXIST", "PARKING_ISV_NOT_ALLOWED", "INVALID_UPDATE_IN_BASE_STATUS", "SYSTEM_ERROR", "INVALID_PARAMETER_BUSINESS_ID", "INVALID_PARAMETER_BUSINESS_TYPE", "ONLINET_ACCOUNT_BAD_NOT_APPS", "AGREEMENT_ACCOUNT_BAD_NOT_APPS", "AGREEMENT_ACCOUNT_BAD_NOT_SIGN", "AGREEMENT_ACCOUNT_BAD_INVALID_PAYEE_ID", "PARKINGLOT_TYPE_ERROR", "PARKINGLOT_BIZ_TYPE_ERROR", "PARKINGLOT_ONLINET_ACCOUNT_NOT_APPS", "PARKINGLOT_AGREEMENT_ACCOUNT_NOT_APPS", "PARKINGLOT_AGREEMENT_ACCOUNT_BAD_SIGN", "PARKINGLOT_POI_TYPE_NOT_MATCH", "PARKINGLOT_ISV_APP_ID_ILLEGAL", "PARKINGLOT_POI_NOT_FIND", "PARKINGLOT_POI_PARSE_ERROR", "PARKINGLOT_ISV_NOT_MATCH", "PARKINGLOT_INVALID_UPDATE_IN_BASE_STATUS", "PARKINGLOT_MODIFY_ERROR", "PARKINGLOT_SEND_UPDATE_EVENT_FAIL", "PARKINGLOT_NOT_FIND", "NO_PERMISSION_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoMycarParkingParkinglotinfoUpdateModel" : { "type" : "object", "properties" : { "agent_id" : { "type" : "string", "description" : "服务商ID（2088开头的16位纯数字），由服务商提供给ISV", "example" : "2088456825942563" }, "business_isv" : { "type" : "array", "description" : "车场业务归属列表", "items" : { "$ref" : "#/components/schemas/BusinessItem" } }, "city_id" : { "type" : "string", "description" : "该参数废弃", "example" : "110101" }, "contact_alipay" : { "type" : "string", "description" : "该参数废弃", "example" : "189xxxxxxxxxxx" }, "contact_email" : { "type" : "string", "description" : "该参数废弃", "example" : "alipay@alipay.com" }, "contact_mobile" : { "type" : "string", "description" : "该参数废弃", "example" : "18912345678" }, "contact_name" : { "type" : "string", "description" : "该参数废弃", "example" : "张三" }, "contact_tel" : { "type" : "string", "description" : "该参数废弃", "example" : "0571xxxxxxxx" }, "contact_weixin" : { "type" : "string", "description" : "该参数废弃", "example" : "923422342" }, "equipment_name" : { "type" : "string", "description" : "该参数废弃", "example" : "杭州立方" }, "is_support_invoice" : { "type" : "string", "description" : "是否支持电子发票。枚举支持： \t*0：表示不支持。 \t*1：表示支持。", "example" : "1" }, "isv_mobile" : { "type" : "string", "description" : "ISV电话，传入original_isv_pid、original_isv_appid时，此处为服务商电话", "example" : "571-8643-2799" }, "latitude" : { "type" : "string", "description" : "纬度", "example" : "30.548828" }, "longitude" : { "type" : "string", "description" : "经度", "example" : "114.266418" }, "mchnt_id" : { "type" : "string", "description" : "收款方ID（2088开头的16位纯数字），由停车场收款的业主方提供给ISV，该字段暂用于机具和物料申领，更新时不影响交易接口中的收款方值。", "example" : "2088456825942563" }, "original_isv_appid" : { "type" : "string", "description" : "ISV的APPID,服务商调用必传，由ISV提供给服务商", "example" : "2021002108619277" }, "original_isv_mobile" : { "type" : "string", "description" : "ISV电话，此值与isv_mobile组合使用", "example" : "571-8643-2799" }, "original_isv_name" : { "type" : "string", "description" : "ISV的名称，服务商调用必传，由ISV提供给服务商", "example" : "杭州立方" }, "original_isv_pid" : { "type" : "string", "description" : "ISV的PID，服务商调用必传,由ISV提供给服务商", "example" : "2088456825942563" }, "out_parking_id" : { "type" : "string", "description" : "该参数废弃", "example" : "10000110001" }, "parking_address" : { "type" : "string", "description" : "停车场地址", "example" : "浙江省杭州市古墩路与疏港公路的交汇处" }, "parking_end_time" : { "type" : "string", "description" : "该参数废弃", "example" : "03:07:50" }, "parking_fee_description" : { "type" : "string", "description" : "收费说明", "example" : "小车一小时10元" }, "parking_fee_description_img" : { "type" : "string", "description" : "商户在停车平台露出的停车价格图片；注意：该图片为PNG格式内容为BASE64的字符串，大小不要超过1MB", "example" : "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAIAAAACCAYAAABytg0kAAAAE0lEQVQImWP81mfxn4GJAYQgAAAqvgLBUG4ufAAAAABJRU5ErkJggg==" }, "parking_id" : { "type" : "string", "description" : "支付宝返回停车场id，系统唯一", "example" : "2014072300007148" }, "parking_lot_type" : { "type" : "string", "description" : "停车场类型，1为居民小区、2为商圈停车场（购物中心商业广场商场等）、3为路侧停车、4为公园景点（景点乐园公园老街古镇等）、5为商务楼宇（酒店写字楼商务楼园区等）、6为其他、7为交通枢纽（机场火车站汽车站码头港口等）、8为市政设施（体育场博物图书馆医院学校等）", "example" : "1" }, "parking_mobile" : { "type" : "string", "description" : "停车场客服电话", "example" : "189XXXXXXXX" }, "parking_name" : { "type" : "string", "description" : "停车场名称，由ISV定义，尽量与高德地图上的一致", "example" : "城西停车场" }, "parking_number" : { "type" : "string", "description" : "该参数废弃", "example" : "10000" }, "parking_poiid" : { "type" : "string", "description" : "高德地图唯一标识。新增高德兴趣点流程 点此查看详情 。\t获取高德兴趣点流程 点此查看详情。", "example" : "B000A9JM2H" }, "parking_start_time" : { "type" : "string", "description" : "该参数废弃", "example" : "03:07:50" }, "parking_type" : { "type" : "string", "description" : "该参数废弃", "example" : "1" }, "pay_type" : { "type" : "string", "description" : "支付方式。枚举支持：\t*1：表示支付宝在线缴费。 \t*2：表示支付宝代扣缴费。 \t*3：表示当面付。 \t说明：如支持多种方式以 ',' 进行分隔。", "example" : "2" }, "payment_mode" : { "type" : "string", "description" : "该参数废弃", "example" : "1" }, "shopingmall_id" : { "type" : "string", "description" : "商圈id", "example" : "100001008" }, "sum_space" : { "type" : "string", "description" : "停车场车位数", "example" : "3000" }, "support_after_pay" : { "type" : "string", "description" : "是否支持先离后付。枚举支持： \t*Y：支持。 \t*N：不支持。 \t说明：默认为空不支持，此参数适用于签约信用代扣的商户。", "example" : "Y" }, "time_out" : { "type" : "string", "description" : "用户支付未离场的超时时间(以分钟为单位)", "example" : "13" } } }, "AlipayEcoMycarParkingParkinglotinfoUpdateResponseModel" : { "type" : "object" }, "AlipayEcoMycarParkingPaymentinfoSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "BIZ_ERROR", "INVALID_PARAMETER", "SYSTEM_ERROR", "RECORD_NOT_FOUND" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoMycarParkingPaymentinfoSyncModel" : { "type" : "object", "properties" : { "car_number" : { "type" : "string", "description" : "车牌号", "example" : "浙Axxxxx" }, "isv_url" : { "type" : "string", "description" : "停车消息透出后，消息详情的落地承接页链接，可配置ISV维度的统一值", "example" : "http://xxxxx" }, "out_serial_no" : { "type" : "string", "description" : "外部业务停车流水号(用于串通进场与出场信息)。如果\tout_serial_no与serial_no都传递，则一起校验。\t● serial_no与out_serial_no二选一必填。\t● 入参有serial_no和out_serial_no，则优先根据serial_no和out_serial_no一起匹配进出场事件\t● 入参仅有serial_no，则优先根据serial_no匹配进出场事件\t● 入参仅有out_serial_no，则根据out_serial_no匹配进出场事件", "example" : "2020090711003017233600000001" }, "parking_id" : { "type" : "string", "description" : "支付宝停车平台ID，由支付宝定义的该停车场标识，同一个isv或商户范围内唯一。通过 alipay.eco.mycar.parking.parkinglotinfo.create(录入停车场信息)接口获取。", "example" : "2015042321001004720200028594" }, "payment_free_minutes" : { "type" : "integer", "description" : "停车场内缴费后，允许出场的免费时长分钟数", "example" : "15" }, "payment_time" : { "type" : "string", "description" : "场内缴费时间，格式\"YYYY-MM-DD HH:mm:ss\"，24小时制，请保证服务器时间准确，场内缴费不应晚于当前网络时间", "example" : "2021-06-12 15:29:55" }, "serial_no" : { "type" : "string", "description" : "支付宝业务流水号(用于串通进场与出场信息)。可通过 alipay.eco.mycar.parking.enterinfo.sync\t(车辆驶入接口)接口获取。\t● serial_no与out_serial_no二选一必填。\t● 入参有serial_no和out_serial_no，则优先根据serial_no和out_serial_no一起匹配进出场事件\t● 入参仅有serial_no，则优先根据serial_no匹配进出场事件\t● 入参仅有out_serial_no，则根据out_serial_no匹配进出场事件", "example" : "2020090711003017233600000001" } } }, "AlipayEcoMycarParkingPaymentinfoSyncResponseModel" : { "type" : "object" }, "AlipayEcoMycarParkingSpaceinfoSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "MERCHANT_VERIFY_FAILED", "EMPTY_PARAMETER", "PARAMETER_FORMAT_ERR", "PARKING_ID_EMPTY", "PARKING_FREE_SPACE_EMPTY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoMycarParkingSpaceinfoSyncModel" : { "type" : "object", "properties" : { "free_charging_pile" : { "type" : "integer", "description" : "空闲充电桩车位数", "example" : "30" }, "free_parking_space" : { "type" : "integer", "description" : "车场空闲可用的车位数", "example" : "500" }, "parking_id" : { "type" : "string", "description" : "停车场ID", "example" : "PI20190506152394234234" }, "parking_space_status" : { "type" : "string", "description" : "停车场实时状态: 0 拥堵,1 正常，2 空闲", "example" : "1" } } }, "AlipayEcoMycarParkingSpaceinfoSyncResponseModel" : { "type" : "object", "properties" : { "sync_result" : { "type" : "string", "description" : "同步结果：0 成功，1 失败", "example" : "1" } } }, "AlipayEcoMycarParkingVehicleQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoMycarParkingVehicleQueryResponseModel" : { "type" : "object", "properties" : { "car_number" : { "type" : "string", "description" : "车牌信息（utf-8编码）", "example" : "川Axxxxxx" } } }, "AlipayEcoSignFlowCancelErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "NOT_ALLOW_REVOKE", "PARAM_ERROR", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoSignFlowCancelModel" : { "type" : "object", "properties" : { "flow_id" : { "type" : "string", "description" : "流程id，通过 创建电子合同签署流程(alipay.eco.contract.signflows.create)接口获取。", "example" : "429b1d3038854cabbcdac0a63d7e4c0d" }, "revoke_reason" : { "type" : "string", "description" : "撤销原因，默认为\"撤销\"。商家可自定义。", "example" : "合同内容不符，拒签" } } }, "AlipayEcoSignFlowCancelResponseModel" : { "type" : "object" }, "AlipayEcoSignFlowCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAM_ERROR", "SYSTEM_ERROR", "SERIAL_NO_IS_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoSignFlowCreateModel" : { "type" : "object", "properties" : { "attachments" : { "type" : "array", "description" : "附件信息", "items" : { "$ref" : "#/components/schemas/Attachment" } }, "business_scene" : { "type" : "string", "description" : "流程主题", "example" : "商品签收" }, "config_info" : { "$ref" : "#/components/schemas/ConfigInfo" }, "template_infos" : { "type" : "array", "description" : "模板信息", "items" : { "$ref" : "#/components/schemas/TemplateInfo" } } } }, "AlipayEcoSignFlowCreateResponseModel" : { "type" : "object", "properties" : { "flow_id" : { "type" : "string", "description" : "流程Id", "example" : "56b75290982d472b8d60133cd9a747a3" } } }, "AlipayEcoSignFlowFinishErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAM_ERROR", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoSignFlowFinishModel" : { "type" : "object", "properties" : { "flow_id" : { "type" : "string", "description" : "流程id", "example" : "429b1d3038854cabbcdac0a63d7e4c0d" } } }, "AlipayEcoSignFlowFinishResponseModel" : { "type" : "object" }, "AlipayEcoSignFlowQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAM_ERROR", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoSignFlowQueryResponseModel" : { "type" : "object", "properties" : { "business_scene" : { "type" : "string", "description" : "文件主题", "example" : "合同名称" }, "contract_validity" : { "type" : "integer", "description" : "文件有效截止日期", "example" : "1592386042000" }, "flow_desc" : { "type" : "string", "description" : "流程描述, 如果流程已拒签或已撤回, 并且存在拒签或撤回原因, 流程描述显示为原因, 否则默认为流程状态描述", "example" : "完成" }, "flow_end_time" : { "type" : "integer", "description" : "流程结束时间", "example" : "1560764486000" }, "flow_id" : { "type" : "string", "description" : "流程Id", "example" : "429b1d3038854cabbcdac0a63d7e4c0d" }, "flow_start_time" : { "type" : "integer", "description" : "流程开始时间", "example" : "1560764486000" }, "flow_status" : { "type" : "integer", "description" : "流程状态,0-草稿 1-签署中 2-完成 3-撤销 4-终止 5-过期 6-删除 7-拒签", "example" : "2" }, "notice_developer_url" : { "type" : "string", "description" : "通知开发者地址", "example" : "http://127.0.0.1:9110/notice" }, "sign_validity" : { "type" : "integer", "description" : "签署有效截止日期", "example" : "1592386042000" }, "signers" : { "type" : "array", "description" : "签署人列表及签署状态", "items" : { "$ref" : "#/components/schemas/FlowSigner" } } } }, "AlipayEcoSignflowsDetailQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PARAM_ERROR", "UNABLE_DOWNLOAD_FILE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoSignflowsDetailQueryResponseModel" : { "type" : "object", "properties" : { "attachments" : { "$ref" : "#/components/schemas/AttachmentDetail" }, "docs" : { "$ref" : "#/components/schemas/DocInfo" } } }, "AlipayEcoSignflowsUrlQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PARAM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayEcoSignflowsUrlQueryResponseModel" : { "type" : "object", "properties" : { "preview_short_url" : { "type" : "string", "description" : "预览短链地址（30天有效）", "example" : "http://testfront.tsign.cn" }, "preview_url" : { "type" : "string", "description" : "预览长链地址(永久有效)", "example" : "https://testt.tsign.cn/55vebd3omU7k" }, "sign_short_url" : { "type" : "string", "description" : "签署短链地址（30天有效）", "example" : "http://testfront.tsign.cn:8821" }, "sign_url" : { "type" : "string", "description" : "签署长链地址(永久有效)", "example" : "https://testt.tsign.cn/55vebd3omU7k" } } }, "AlipayFundAccountQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "NO_PERMISSION_ACCOUNT", "TRUSTEESHIP_ACCOUNT_NOT_EXIST", "USER_AGREEMENT_VERIFY_FAIL", "AUTH_USERID_IS_NOT_MATCH", "AUTHOREE_IS_NOT_MATCH", "USER_AGREEMENT_STATUS_ABNORMAL", "USER_AGREEMENT_IS_OUT_OF_DATE", "MERCHANT_AGREEMENT_VERIFY_FAIL", "AUTH_INFO_NOT_EXISTS", "ALIPAY_ACCOUNT_NOT_EXIST", "AUTH_CODE_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundAccountQueryResponseModel" : { "type" : "object", "properties" : { "available_amount" : { "type" : "string", "description" : "账户可用余额，单位元，精确到小数点后两位。", "example" : "26.45" }, "ext_card_info" : { "$ref" : "#/components/schemas/ExtCardInfo" }, "freeze_amount" : { "type" : "string", "description" : "当前支付宝账户的实时冻结余额", "example" : "11.11" } } }, "AlipayFundAccountbookCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "USER_AGREEMENT_VERIFY_FAIL", "OPEN_ACCOUNT_BOOK_ERROR", "MERCHANT_PRODUCT_NOT_SIGN" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundAccountbookCreateModel" : { "type" : "object", "properties" : { "ext_info" : { "type" : "string", "description" : "JSON格式，传递业务扩展参数", "example" : "{\"agreement_no\":\"2019000000000\",\"cert_no\":\"61102619921108888\"}" }, "merchant_user_id" : { "type" : "string", "description" : "外部商户系统会员的唯一标识，自定义传入", "example" : "10000001" }, "merchant_user_type" : { "type" : "string", "description" : "外部商户用户类型:BUSINESS_EMPLOYEE", "example" : "BUSINESS_ORGANIZATION" }, "scene_code" : { "type" : "string", "description" : "资金记账本的业务场景", "example" : "SATF_FUND_BOOK" } } }, "AlipayFundAccountbookCreateResponseModel" : { "type" : "object", "properties" : { "account_book_id" : { "type" : "string", "description" : "开通的资金记账本id", "example" : "2088123412341234" }, "ext_card_info" : { "$ref" : "#/components/schemas/ExtCardInfo" } } }, "AlipayFundAccountbookNotifyQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SUBSCRIPTION_RELATION_NOT_EXIST", "ACCOUNTBOOK_AGREEMENT_REQUIRED", "AGREEMENT_NOT_EXIST", "AGREEMENT_IS_INVALID", "AGREEMENT_STATUS_IS_NOT_NORMAL", "AGREEMENT_IS_OUT_OF_DATE", "ACCOUNT_BOOK_INFO_QUERY_FAIL", "ILLEGAL_ARGUMENT", "MAX_VISIT_LIMIT", "SYSTEM_ERROR", "BIZ_PRODUCT_CODE_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundAccountbookNotifyQueryResponseModel" : { "type" : "object", "properties" : { "account_book_id" : { "type" : "string", "description" : "记账本ID", "example" : "2088000147677710" }, "code" : { "type" : "string", "description" : "响应code。 成功为10000； 业务异常为40004；", "example" : "10000" }, "msg" : { "type" : "string", "description" : "响应描述。 成功为Success； 业务异常为Business Failed；", "example" : "Success" }, "subscribe_status" : { "type" : "string", "description" : "订阅关系状态， VALID：有效的； INVALID：失效的；", "example" : "VALID" } } }, "AlipayFundAccountbookNotifySubscribeErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SUBSCRIPTION_RELATION_NOT_EXIST", "ACCOUNTBOOK_AGREEMENT_REQUIRED", "AGREEMENT_NOT_EXIST", "AGREEMENT_IS_INVALID", "AGREEMENT_STATUS_IS_NOT_NORMAL", "AGREEMENT_IS_OUT_OF_DATE", "ACCOUNT_BOOK_INFO_QUERY_FAIL", "ILLEGAL_ARGUMENT", "MAX_VISIT_LIMIT", "SYSTEM_ERROR", "BIZ_PRODUCT_CODE_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundAccountbookNotifySubscribeModel" : { "type" : "object", "properties" : { "account_book_id" : { "type" : "string", "description" : "记账本ID", "example" : "2088000147677710" }, "agreement_no" : { "type" : "string", "description" : "协议号。 若是基于协议的记账本，则agreement_no必传； 若是自创建的记账本，则agreement_no不传；", "example" : "20205724001102186227" }, "biz_scene" : { "type" : "string", "description" : "场景码。固定为DEFAULT", "example" : "DEFAULT" }, "product_code" : { "type" : "string", "description" : "产品码。固定为SATF_FUND_BOOK", "example" : "SATF_FUND_BOOK" } } }, "AlipayFundAccountbookNotifySubscribeResponseModel" : { "type" : "object", "properties" : { "account_book_id" : { "type" : "string", "description" : "记账本ID", "example" : "2088**********0378" }, "code" : { "type" : "string", "description" : "响应code。 成功为10000； 业务异常为40004；", "example" : "10000" }, "msg" : { "type" : "string", "description" : "响应描述。 成功为Success； 业务异常为Business Failed；", "example" : "Success" }, "subscribe_status" : { "type" : "string", "description" : "订阅关系状态， VALID：有效的； INVALID：失效的；", "example" : "VALID" } } }, "AlipayFundAccountbookNotifyUnsubscribeErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SUBSCRIPTION_RELATION_NOT_EXIST", "ACCOUNTBOOK_AGREEMENT_REQUIRED", "AGREEMENT_NOT_EXIST", "AGREEMENT_IS_INVALID", "AGREEMENT_STATUS_IS_NOT_NORMAL", "AGREEMENT_IS_OUT_OF_DATE", "ACCOUNT_BOOK_INFO_QUERY_FAIL", "ILLEGAL_ARGUMENT", "MAX_VISIT_LIMIT", "SYSTEM_ERROR", "BIZ_PRODUCT_CODE_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundAccountbookNotifyUnsubscribeModel" : { "type" : "object", "properties" : { "account_book_id" : { "type" : "string", "description" : "记账本ID", "example" : "2088000147677710" }, "agreement_no" : { "type" : "string", "description" : "协议号。\t若是基于协议的记账本，则agreement_no必传；\t若是自创建的记账本，则agreement_no不传；", "example" : "20205724001102186227" }, "biz_scene" : { "type" : "string", "description" : "场景码。固定为DEFAULT", "example" : "DEFAULT" }, "product_code" : { "type" : "string", "description" : "产品码。固定为SATF_FUND_BOOK", "example" : "SATF_FUND_BOOK" } } }, "AlipayFundAccountbookNotifyUnsubscribeResponseModel" : { "type" : "object", "properties" : { "account_book_id" : { "type" : "string", "description" : "记账本ID", "example" : "2088000147677710" }, "code" : { "type" : "string", "description" : "响应code。\t成功为10000；\t业务异常为40004；", "example" : "10000" }, "msg" : { "type" : "string", "description" : "响应描述。 成功为Success； 业务异常为Business Failed；", "example" : "Success" }, "subscribe_status" : { "type" : "string", "description" : "订阅关系状态， \tVALID：有效的； \tINVALID：失效的；", "example" : "VALID" } } }, "AlipayFundAccountbookQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "TRUSTEESHIP_ACCOUNT_NOT_EXIST", "USER_AGREEMENT_VERIFY_FAIL", "AUTHOREE_IS_NOT_MATCH", "MERCHANT_AGREEMENT_VERIFY_FAIL", "NO_PERMISSION_ACCOUNT", "MERCHANT_PRODUCT_NOT_SIGN", "ACCOUNTBOOK_QUERY_NOT_SAME_USER", "TRUSTEESHIP_PARENT_ACCOUNT_NOT_EXIST", "AUTH_CODE_ERROR", "SYSTEM_ERROR", "NO_ACCOUNTBOOK_PERMISSION" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundAccountbookQueryResponseModel" : { "type" : "object", "properties" : { "account_book_id" : { "type" : "string", "description" : "记账账簿id", "example" : "2088001409188095" }, "auth_info" : { "$ref" : "#/components/schemas/AuthInfoDTO" }, "available_amount" : { "type" : "string", "description" : "可用余额", "example" : "26.45" }, "ext_card_info" : { "$ref" : "#/components/schemas/ExtCardInfo" } } }, "AlipayFundAgreementQuotaModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "PRODUCT_NOT_SIGN", "NOT_SUPPORT_PRODUCT_SCENE", "NOT_SUPPORT_QUOTA_ROLE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundAgreementQuotaModifyModel" : { "type" : "object", "properties" : { "agreement_quota_modify_list" : { "type" : "array", "description" : "协议额度设置信息", "items" : { "$ref" : "#/components/schemas/AgreementQuotaModifyList" } }, "biz_scene" : { "type" : "string", "description" : "场景码，非固定值，使用的对应的资金场景码保持一致", "example" : "ENTRUST_TRANSFER" }, "product_code" : { "type" : "string", "description" : "额度产品码，非固定值，使用的对应的资金产品码保持一致", "example" : "BATCH_API_TO_ACC_NO_PWD" } } }, "AlipayFundAgreementQuotaModifyResponseModel" : { "type" : "object", "properties" : { "quota_modify_detail_list" : { "type" : "array", "description" : "额度变更结果集合", "items" : { "$ref" : "#/components/schemas/QuotaModifyDetail" } } } }, "AlipayFundAgreementQuotaQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "PRODUCT_NOT_SIGN", "NOT_SUPPORT_PRODUCT_SCENE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundAgreementQuotaQueryModel" : { "type" : "object", "properties" : { "agreement_no_list" : { "type" : "array", "description" : "授权协议号", "items" : { "type" : "string" }, "example" : "[\"20205321001042231004\"]" }, "biz_scene" : { "type" : "string", "description" : "场景码，非固定值，使用的对应的资金场景码保持一致", "example" : "ENTRUST_TRANSFER" }, "product_code" : { "type" : "string", "description" : "额度产品码，非固定值，使用的对应的资金产品码保持一致", "example" : "BATCH_API_TO_ACC_NO_PWD" } } }, "AlipayFundAgreementQuotaQueryResponseModel" : { "type" : "object", "properties" : { "quota_query_response_list" : { "type" : "array", "description" : "单个协议的额度查询结果", "items" : { "$ref" : "#/components/schemas/QuotaQueryResponse" } } } }, "AlipayFundAuthOperationCancelErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_ARGUMENT", "ACCESS_FORBIDDEN", "PAYER_USER_STATUS_LIMIT", "ORDER_ALREADY_FINISH", "CANCEL_OPERATION_TIME_OUT", "REQUEST_AMOUNT_EXCEED", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundAuthOperationCancelModel" : { "type" : "object", "properties" : { "auth_no" : { "type" : "string", "description" : "支付宝授权资金订单号。\t与商户的授权资金订单号不能同时为空，二者都传入时，以支付宝资金授权订单号为准，该参数与支付宝授权资金操作流水号配对使用。", "example" : "2014070800002001550000014417" }, "notify_url" : { "type" : "string", "description" : "通知地址" }, "operation_id" : { "type" : "string", "description" : "支付宝的授权资金操作流水号。\t与商户的授权资金操作流水号不能同时为空，二者都传入时，以支付宝的授权资金操作流水号为准，该参数与支付宝授权资金订单号配对使用。", "example" : "20161012405744018102" }, "out_order_no" : { "type" : "string", "description" : "商户的授权资金订单号。\t与支付宝的授权资金订单号不能同时为空，二者都传入时，以支付宝的授权资金订单号为准，该参数与商户的授权资金操作流水号配对使用。\t该值与资金冻结时 out_order_no一致。", "example" : "4977164666634053" }, "out_request_no" : { "type" : "string", "description" : "商户的授权资金操作流水号。\t与支付宝的授权资金操作流水号不能同时为空，二者都传入时，以支付宝的授权资金操作流水号为准，该参数与商户的授权资金订单号配对使用。\t该值与资金冻结时out_request_no一致", "example" : "2016100810000003551" }, "remark" : { "type" : "string", "description" : "商户对本次撤销操作的附言描述。\t长度不超过100个字母或50个汉字。", "example" : "授权撤销" } } }, "AlipayFundAuthOperationCancelResponseModel" : { "type" : "object", "properties" : { "action" : { "type" : "string", "description" : "本次撤销触发的资金动作\r\tclose：关闭冻结明细，无资金解冻\r\tunfreeze：产生了资金解冻", "example" : "close" }, "auth_no" : { "type" : "string", "description" : "支付宝资金授权订单号。", "example" : "2016101210002001810258115912" }, "operation_id" : { "type" : "string", "description" : "支付宝的冻结操作流水号。", "example" : "20161012405744018102" }, "out_order_no" : { "type" : "string", "description" : "商户的授权资金订单号。", "example" : "4977164666634053" }, "out_request_no" : { "type" : "string", "description" : "商户的冻结操作流水号 。", "example" : "234555553333444334" } } }, "AlipayFundAuthOperationDetailQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_ARGUMENT", "AUTH_ORDER_NOT_EXIST", "AUTH_OPERATION_NOT_EXIST", "ACCESS_FORBIDDEN", "SYSTEM_ERROR", "ENTERPRISE_PAY_BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundAuthOperationDetailQueryModel" : { "type" : "object", "properties" : { "auth_no" : { "type" : "string", "description" : "支付宝授权资金订单号。\t与商户的授权资金订单号不能同时为空，二者都传入时，以支付宝资金授权订单号为准，该参数与支付宝授权资金操作流水号配对使用。", "example" : "2014021601002000640012345678" }, "operation_id" : { "type" : "string", "description" : "支付宝的授权资金操作流水号。\t与商户的授权资金操作流水号不能同时为空，二者都传入时，以支付宝的授权资金操作流水号为准，该参数与支付宝授权资金订单号配对使用。", "example" : "20140216010020006400" }, "operation_type" : { "type" : "string", "description" : "需要查询的授权资金操作类型。\t可选值FREEZE/UNFREEZE/PAY，分别对应冻结、解冻、支付明细类型；\t未传入本参数时，如果仅查询出单笔明细则直接返回，如果查询出多笔则优先返回冻结明细、无冻结明细时返回解冻明细；\t当传入本参数时，则严格按照该操作类型返回对应明细", "example" : "FREEZE" }, "out_order_no" : { "type" : "string", "description" : "商户的授权资金订单号。\t与支付宝的授权资金订单号不能同时为空，二者都传入时，以支付宝的授权资金订单号为准，该参数与商户的授权资金操作流水号配对使用。\t该值与资金冻结时 out_order_no一致。", "example" : "8077735255938023" }, "out_request_no" : { "type" : "string", "description" : "商户的授权资金操作流水号。\t与支付宝的授权资金操作流水号不能同时为空，二者都传入时，以支付宝的授权资金操作流水号为准，该参数与商户的授权资金订单号配对使用。\t查询冻结明细时，该值与发起冻结操作时传入的out_request_no一致；\t查询解冻明细时，该值与发起解冻操作时传入的out_request_no一致；\t查询支付明细时，该值与发起转支付操作时传入的out_trade_no一致。", "example" : "20140216001001" }, "query_options" : { "type" : "array", "description" : "需要查询的额外信息", "items" : { "type" : "string" }, "example" : "[\"credit_risk_info\"]" } } }, "AlipayFundAuthOperationDetailQueryResponseModel" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "该笔资金操作流水operation_id对应的操作金额，单位为：元（人民币）", "example" : "200.00" }, "auth_no" : { "type" : "string", "description" : "支付宝资金授权订单号", "example" : "2014031600002001260000001000" }, "credit_amount" : { "type" : "string", "description" : "该笔资金操作流水operation_id对应的操作信用金额", "example" : "0.01" }, "credit_merchant_ext" : { "type" : "string", "description" : "芝麻透出给商户的信息，具体内容由商户与芝麻约定后返回", "example" : "{\"1003190\":\"true\"}" }, "credit_risk_info" : { "$ref" : "#/components/schemas/CreditRiskInfo" }, "enterprise_pay_info" : { "type" : "string", "description" : "因公付业务信息", "example" : "{\"biz_info\":\"{\\\"enterprisePayAmount\\\":\\\"0.01\\\"}\"}" }, "extra_param" : { "type" : "string", "description" : "商户请求创建预授权订单时传入的扩展参数，仅返回商户自定义的扩展信息（merchantExt）", "example" : "{\"merchantExt\":\"key1=value1,key2=value2\"}" }, "fund_amount" : { "type" : "string", "description" : "该笔资金操作流水operation_id对应的操作自有资金金额", "example" : "0.01" }, "gmt_create" : { "type" : "string", "description" : "资金授权单据操作流水创建时间，\r\t格式：YYYY-MM-DD HH:MM:SS", "example" : "2014-01-01 20:00:00" }, "gmt_trans" : { "type" : "string", "description" : "支付宝账务处理成功时间，\r\t格式：YYYY-MM-DD HH:MM:SS", "example" : "2014-01-01 20:00:00" }, "operation_id" : { "type" : "string", "description" : "支付宝资金操作流水号", "example" : "20140216355864862002" }, "operation_type" : { "type" : "string", "description" : "支付宝资金操作类型，表示当前查询到的这笔明细的操作类型。\t目前支持： \tFREEZE：冻结\tUNFREEZE：解冻\tPAY：支付", "example" : "UNFREEZE" }, "order_status" : { "type" : "string", "description" : "授权单状态：INIT（初始状态：已创建未授权）、AUTHORIZED（已授权状态：授权成功，可以进行转支付或解冻操作）、FINISH（完成状态：转支付完成且无剩余冻结资金）、CLOSED（关闭状态：授权未完成超时关闭或冻结资金全额解冻）", "example" : "AUTHORIZED" }, "order_title" : { "type" : "string", "description" : "业务订单的简单描述，如商品名称等", "example" : "0元购土豪金" }, "out_order_no" : { "type" : "string", "description" : "商户的授权资金订单号", "example" : "20140216001" }, "out_request_no" : { "type" : "string", "description" : "商户资金操作的请求流水号", "example" : "20140216001001" }, "payer_logon_id" : { "type" : "string", "description" : "付款方支付宝账号（Email或手机号），仅作展示使用，默认会加“*”号处理", "example" : "ali*@alipay.com" }, "payer_open_id" : { "type" : "string", "description" : "支付宝openId，用户（userId）在应用（appId）下的唯一标识。", "example" : "03914IMEfXsS9K-tSvHy-IisrLlOfthFgDVo-hU30XtKPg9" }, "payer_user_id" : { "type" : "string", "description" : "付款方支付宝账号对应的支付宝唯一用户号，以2088开头的16位纯数字组成", "example" : "2088402019148643" }, "pre_auth_type" : { "type" : "string", "description" : "预授权类型，信用预授权情况下值为 CREDIT_AUTH，表示该笔预授权为信用预授权，实际没有冻结用户资金；其它情况均不返回该字段。", "example" : "CREDIT_AUTH" }, "remark" : { "type" : "string", "description" : "商户对本次操作的附言描述，长度不超过100个字母或50个汉字", "example" : "2014-05期解冻200.00元" }, "rest_amount" : { "type" : "string", "description" : "订单当前剩余冻结金额，单位为：元（人民币）。", "example" : "4600.00" }, "rest_credit_amount" : { "type" : "string", "description" : "剩余冻结信用金额，单位为：元（人民币），精确到小数点后两位", "example" : "0.01" }, "rest_fund_amount" : { "type" : "string", "description" : "剩余冻结自有资金金额，单位为：元（人民币），精确到小数点后两位", "example" : "0.01" }, "status" : { "type" : "string", "description" : "资金操作流水的状态，\r\t目前支持： \r\tINIT：初始\r\tSUCCESS：成功\r\tCLOSED：关闭", "example" : "SUCCESS" }, "total_freeze_amount" : { "type" : "string", "description" : "订单累计的冻结金额，单位为：元（人民币）", "example" : "4800.00" }, "total_freeze_credit_amount" : { "type" : "string", "description" : "累计冻结信用金额，单位为：元（人民币），精确到小数点后两位", "example" : "0.01" }, "total_freeze_fund_amount" : { "type" : "string", "description" : "累计冻结自有资金金额，单位为：元（人民币），精确到小数点后两位", "example" : "0.01" }, "total_pay_amount" : { "type" : "string", "description" : "订单累计用于支付的金额，单位为：元（人民币）", "example" : "0.00" }, "total_pay_credit_amount" : { "type" : "string", "description" : "累计支付信用金额，单位为：元（人民币），精确到小数点后两位", "example" : "0.01" }, "total_pay_fund_amount" : { "type" : "string", "description" : "累计支付自有资金金额，单位为：元（人民币），精确到小数点后两位", "example" : "0.01" }, "trans_currency" : { "type" : "string", "description" : "标价币种, amount 对应的币种单位。支持澳元：AUD, 新西兰元：NZD, 台币：TWD, 美元：USD, 欧元：EUR, 英镑：GBP", "example" : "USD" } } }, "AlipayFundAuthOrderAppFreezeErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ORDER_ALREADY_CLOSED", "FREEZE_ALREADY_SUCCESS", "SYSTEM_ERROR", "ORDER_ALREADY_FINISH", "EXIST_FORBIDDEN_WORD", "ILLEGAL_ARGUMENT", "ACCESS_FORBIDDEN", "PAYEE_NOT_EXIST", "PAYER_NOT_EXIST", "PAYER_USER_STATUS_LIMIT", "PAYEE_USER_STATUS_LIMIT", "CURRENCY_VERIFICATION_FAIL", "RESTRICTED_MERCHANT_INDUSTRY", "FOREX_ID_VERIFICATION_FAIL", "PRODUCT_AMOUNT_LIMIT_ERROR", "SECONDARY_MERCHANT_STATUS_ERROR", "USER_IDENTITY_INFO_VALIDATE_FAIL", "USER_ACCOUNT_VALIDATE_FAIL", "SUB_MERCHANT_ORG_ID_ERROR", "SUB_MERCHANT_LEVEL_ERROR", "SUB_MERCHANT_NO_PERMISSION", "MERCHANT_STATUS_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundAuthOrderAppFreezeModel" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "需要冻结的金额，单位为：元（人民币），精确到小数点后两位。\t取值范围：[0.01,100000000.00]", "example" : "0.01" }, "business_params" : { "type" : "string", "description" : "业务参数，如风控参数outRiskInfo等。", "example" : "{\"outRiskInfo\":\"{\\\"mcCreateTradeTime\\\":\\\"2022-03-11 12:46:09\\\",\\\"extraAccountCertnoLastSix\\\":\\\"000011\\\",\\\"mobileOperatingPlatform\\\":\\\"ios\\\",\\\"sysVersion\\\":\\\"15.4.2\\\",\\\"mcCreateTradeIp\\\":\\\"11.110.111.43\\\"}\"}" }, "disable_pay_channels" : { "type" : "string", "description" : "无特殊需要请勿传入；商户可用该参数禁用支付渠道。\t传入后用户不可使用列表中的渠道进行支付，目前支持两种禁用渠道：信用卡快捷（OPTIMIZED_MOTO）、信用卡卡通（BIGAMOUNT_CREDIT_CARTOON）。与可用支付渠道不能同时传入", "example" : "[{\"payChannelType\":\"OPTIMIZED_MOTO\"},{\"payChannelType\":\"BIGAMOUNT_CREDIT_CARTOON\"}]" }, "enable_pay_channels" : { "type" : "string", "description" : "无特殊需要请勿传入；商户可用该参数指定支付渠道。\t传入后用户仅能使用列表中的渠道进行支付，目前支持三种渠道，余额宝（MONEY_FUND）、花呗（PCREDIT_PAY）以及芝麻信用（CREDITZHIMA）。与禁用支付渠道不可同时传入", "example" : "[{\"payChannelType\":\"PCREDIT_PAY\"},{\"payChannelType\":\"MONEY_FUND\"}]" }, "extra_param" : { "type" : "string", "description" : "业务扩展参数，用于特定业务信息的传递，json格式。\t1、category，信用类目，信用预授权场景必传，具体类目信息见https://opendocs.alipay.com/open/10719；\t2、serviceId，信用服务id，信用预授权场景必传，需要联系芝麻客服获取，https://cshall.alipay.com/enterprise/index.htm?sourceId=pc_zhima（右上角“有问题点我”进入咨询）；\t3、creditExtInfo，信用参数，可选，如有需要请与芝麻约定后传入，信用服务说明见https://opendocs.alipay.com/open/11157/qlsxya", "example" : "{\"category\":\"CHARGE_PILE_CAR\",\"serviceId\":\"2020042800000000000001450466\"}" }, "identity_params" : { "type" : "string", "description" : "无特殊需要请勿传入；买家实名信息。\t传入后支付宝会比对买家在支付宝端的实名信息。包含两个可选key：\t1.identity_hash，买家姓名拼接身份证号后，使用SHA256摘要方式与UTF8编码后的hash值，返回的十六进制字符串，例如 “张三4566498798498498498498”对应的identity_hash应为“acc2b92ffc5ed9b472faa19748f10045c30434132784f774b00216a56b8841c6”\t2.alipay_user_id，买家uid", "example" : "{\"identity_hash\":\"acc2b92ffc5ed9b472faa19748f10045c30434132784f774b00216a56b8841c6\"}" }, "notify_url" : { "type" : "string", "description" : "通知地址" }, "order_title" : { "type" : "string", "description" : "订单标题。\t业务订单的简单描述，如商品名称等", "example" : "XX租车押金" }, "out_order_no" : { "type" : "string", "description" : "商户授权资金订单号。\t商家自定义需保证在商户端不重复。仅支持字母、数字、下划线。", "example" : "8077735255938023" }, "out_request_no" : { "type" : "string", "description" : "商户本次资金操作的请求流水号，用于标示请求流水的唯一性。\t可与out_order_no相同，仅支持字母、数字、下划线。", "example" : "8077735255938032" }, "pay_timeout" : { "type" : "string", "description" : "预授权订单相对超时时间。从商户客户端请求时间开始计算。\t预授权订单允许的最晚授权时间，逾期将关闭该笔订单。取值范围：1m～15d。m-分钟，h-小时，d-天。 该参数数值不接受小数点， 如 1.5h，可转换为90m。\t默认为15m。", "example" : "2d" }, "payee_logon_id" : { "type" : "string", "description" : "收款账户的支付宝登录号（email或手机号）。\t如果传入则会校验该登录号对应的账号是否具备当前商户收款权限，如果商户希望用户能够使用花呗，则用户号(payee_user_id)和登录号(payee_logon_id)两者必须传入其一", "example" : "159****5620" }, "payee_user_id" : { "type" : "string", "description" : "收款账户的支付宝用户号。\t以2088开头的16位纯数字，如果传入则会校验该账号是否具备当前商户收款权限，如果商户希望用户能够使用花呗，则用户号(payee_user_id)和登录号(payee_logon_id)两者必须传入其一", "example" : "2088102000275795" }, "product_code" : { "type" : "string", "description" : "销售产品码。\t支付宝预授权产品固定为 PRE_AUTH_ONLINE", "example" : "PRE_AUTH_ONLINE" }, "scene_code" : { "type" : "string", "description" : "场景码，用于区分预授权不同业务场景。如：当面预授权通用场景（O2O_AUTH_COMMON_SCENE）、支付宝预授权通用场景（ONLINE_AUTH_COMMON_SCENE）、境外当面预授权通用场景（OVERSEAS_O2O_AUTH_COMMON_SCENE）、境外支付预授权通用场景（OVERSEAS_ONLINE_AUTH_COMMON_SCENE）等", "example" : "OVERSEAS_ONLINE_AUTH_COMMON_SCENE" }, "settle_currency" : { "type" : "string", "description" : "商户指定的结算币种。支持澳元：AUD, 新西兰元：NZD, 台币：TWD, 美元：USD, 欧元：EUR, 英镑：GBP", "example" : "USD" }, "timeout_express" : { "type" : "string", "description" : "预授权订单相对超时时间。从商户客户端请求时间开始计算。\t预授权订单允许的最晚授权时间，逾期将关闭该笔订单。取值范围：1m～15d。m-分钟，h-小时，d-天。 该参数数值不接受小数点， 如 1.5h，可转换为90m。\t默认为15m。", "example" : "2d" }, "trans_currency" : { "type" : "string", "description" : "标价币种, amount 对应的币种单位。支持澳元：AUD, 新西兰元：NZD, 台币：TWD, 美元：USD, 欧元：EUR, 英镑：GBP, 人民币：CNY", "example" : "USD" } } }, "AlipayFundAuthOrderAppFreezeResponseModel" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "本次操作冻结的金额，单位为：元（人民币），精确到小数点后两位", "example" : "0.01" }, "auth_no" : { "type" : "string", "description" : "支付宝的资金授权订单号", "example" : "2014070800002001550000014417" }, "credit_amount" : { "type" : "string", "description" : "本次冻结操作中信用冻结金额，单位为：元（人民币），精确到小数点后两位", "example" : "0.01" }, "fund_amount" : { "type" : "string", "description" : "本次冻结操作中自有资金冻结金额，单位为：元（人民币），精确到小数点后两位", "example" : "0.01" }, "gmt_trans" : { "type" : "string", "description" : "资金授权成功时间\r\t格式：YYYY-MM-DD HH:MM:SS", "example" : "2014-09-15 11:23:04" }, "operation_id" : { "type" : "string", "description" : "支付宝的资金操作流水号", "example" : "2014070800032850551" }, "out_order_no" : { "type" : "string", "description" : "商户的授权资金订单号", "example" : "4977164666634053" }, "out_request_no" : { "type" : "string", "description" : "商户本次资金操作的请求流水号", "example" : "2014070700166653" }, "payer_open_id" : { "type" : "string", "description" : "支付宝openId，用户（userId）在应用（appId）下的唯一用户标识。", "example" : "03914IMEfXsS9K-tSvHy-IisrLlOfthFgDVo-hU30XtKPg9" }, "payer_user_id" : { "type" : "string", "description" : "付款方支付宝用户号", "example" : "2088102000275885" }, "pre_auth_type" : { "type" : "string", "description" : "预授权类型，目前支持 CREDIT_AUTH(信用预授权);\r\t商户可根据该标识来判断该笔预授权的类型，当返回值为\"CREDIT_AUTH\"表明该笔预授权为信用预授权，没有真实冻结资金；当返回值为空或者不为\"CREDIT_AUTH\"则表明该笔预授权为普通资金预授权，会冻结用户资金。", "example" : "CREDIT_AUTH" }, "status" : { "type" : "string", "description" : "资金预授权明细的状态\r\t目前支持： \r\tINIT：初始\r\tSUCCESS: 成功\r\tCLOSED：关闭", "example" : "SUCCESS" }, "trans_currency" : { "type" : "string", "description" : "标价币种, amount 对应的币种单位。支持澳元：AUD, 新西兰元：NZD, 台币：TWD, 美元：USD, 欧元：EUR, 英镑：GBP, 人民币：CNY", "example" : "USD" } } }, "AlipayFundAuthOrderFreezeErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_ARGUMENT", "EXIST_FORBIDDEN_WORD", "ACCESS_FORBIDDEN", "UNIQUE_VIOLATION", "PAYER_USER_STATUS_LIMIT", "PAYER_NOT_EXIST", "PAYMENT_AUTH_CODE_INVALID", "MONEY_NOT_ENOUGH", "ORDER_ALREADY_CLOSED", "FREEZE_ALREADY_SUCCESS", "ERROR_BALANCE_PAYMENT_DISABLE", "PULL_MOBILE_CASHIER_FAIL", "USER_FACE_PAYMENT_SWITCH_OFF", "SYSTEM_ERROR", "ORDER_ALREADY_FINISH", "PAYEE_NOT_EXIST", "PAYEE_USER_STATUS_LIMIT", "PAYER_PAYEE_EQUAL", "NO_PAYMENT_INSTRUMENTS_AVAILABLE", "CLIENT_VERSION_NOT_MATCH", "UNSUPPORT_ORDER_AMOUNT", "FORBIDDEN_MERCHANT_INDUSTRY", "CURRENCY_VERIFICATION_FAIL", "RESTRICTED_MERCHANT_INDUSTRY", "FOREX_ID_VERIFICATION_FAIL", "PRODUCT_AMOUNT_LIMIT_ERROR", "SECONDARY_MERCHANT_STATUS_ERROR", "USER_IDENTITY_INFO_VALIDATE_FAIL", "USER_ACCOUNT_VALIDATE_FAIL", "SUB_MERCHANT_ORG_ID_ERROR", "SUB_MERCHANT_LEVEL_ERROR", "SUB_MERCHANT_NO_PERMISSION", "MERCHANT_STATUS_ERROR", "UNSUPPORTED_BIZ_TYPE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundAuthOrderFreezeModel" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "需要冻结的金额，单位为：元（人民币），精确到小数点后两位。\t取值范围：[0.01,100000000.00]", "example" : "0.01" }, "auth_code" : { "type" : "string", "description" : "用户付款码。\t1.条码场景：25~30开头的长度为16~24位的数字，实际字符串长度以开发者获取的付款码长度为准；\t2.刷脸场景：\t1）fp开头的35位字符串；\t2）300-700字符的随机字符串；\t注：刷脸场景考虑到未来可能拓展更多格式，建议外围不必做规则拦截，由支付宝统一做有效性校验", "example" : "付款码场景：28763443825664394，\n刷脸场景1)示例：fp1394da8bfc3e299a2128b8bda17456h84" }, "auth_code_type" : { "type" : "string", "description" : "付款码类型。\t1.条码场景：bar_code\t2.刷脸场景：security_code", "example" : "bar_code" }, "business_params" : { "type" : "string", "description" : "业务参数，如风控参数outRiskInfo等。", "example" : "{\"outRiskInfo\":\"{\\\"mcCreateTradeTime\\\":\\\"2022-03-11 12:46:09\\\",\\\"extraAccountCertnoLastSix\\\":\\\"000011\\\",\\\"mobileOperatingPlatform\\\":\\\"ios\\\",\\\"sysVersion\\\":\\\"15.4.2\\\",\\\"mcCreateTradeIp\\\":\\\"11.110.111.43\\\"}\"}" }, "disable_pay_channels" : { "type" : "string", "description" : "无特殊需要请勿传入；商户可用该参数禁用支付渠道。\t传入后用户不可使用列表中的渠道进行支付，目前支持两种禁用渠道：信用卡快捷（OPTIMIZED_MOTO）、信用卡卡通（BIGAMOUNT_CREDIT_CARTOON）。与可用支付渠道不能同时传入", "example" : "[{\"payChannelType\":\"OPTIMIZED_MOTO\"},{\"payChannelType\":\"BIGAMOUNT_CREDIT_CARTOON\"}]" }, "enable_pay_channels" : { "type" : "string", "description" : "无特殊需要请勿传入；商户可用该参数指定支付渠道。\t传入后用户仅能使用列表中的渠道进行支付，目前支持三种渠道，余额宝（MONEY_FUND）、花呗（PCREDIT_PAY）以及芝麻信用（CREDITZHIMA）。与禁用支付渠道不可同时传入", "example" : "[{\"payChannelType\":\"PCREDIT_PAY\"},{\"payChannelType\":\"MONEY_FUND\"}]" }, "extra_param" : { "type" : "string", "description" : "业务扩展参数，用于特定业务信息的传递，json格式，key值如下：\t1、category，信用类目，信用预授权场景必传，具体类目信息见https://opendocs.alipay.com/open/10719\t2、serviceId，信用服务id，信用预授权场景必传，需要联系芝麻客服获取，https://cshall.alipay.com/enterprise/index.htm?sourceId=pc_zhima（右上角“有问题点我”进入咨询）\t3、creditExtInfo，信用参数，如有需要请与芝麻约定后传入，信用服务说明见https://opendocs.alipay.com/open/11157/qlsxya", "example" : "{\"category\":\"CHARGE_PILE_CAR\",\"serviceId\":\"2020042800000000000001450466\"}" }, "identity_params" : { "type" : "string", "description" : "用户实名信息参数，包含：姓名+身份证号的hash值、指定用户的uid。商户传入用户实名信息参数，支付宝会对比用户在支付宝端的实名信息。\t姓名+身份证号hash值使用SHA256摘要方式与UTF8编码,返回十六进制的字符串。\tidentity_hash和alipay_user_id都是可选的，如果两个都传，则会先校验identity_hash，然后校验alipay_user_id。其中identity_hash的待加密字样如\"张三4566498798498498498498\"", "example" : "{\"identity_hash\":\"ABCDEFDxxxxxx\",\"alipay_user_id\":\"2088xxx\"}" }, "notify_url" : { "type" : "string", "description" : "通知地址" }, "order_title" : { "type" : "string", "description" : "订单标题。\t业务订单的简单描述，如商品名称等", "example" : "XX租车押金" }, "out_order_no" : { "type" : "string", "description" : "商户授权资金订单号。\t商家自定义需保证在商户端不重复。仅支持字母、数字、下划线。", "example" : "8077735255938023" }, "out_request_no" : { "type" : "string", "description" : "商户本次资金操作的请求流水号，用于标示请求流水的唯一性。\t可与out_order_no相同，仅支持字母、数字、下划线。", "example" : "8077735255938032" }, "pay_timeout" : { "type" : "string", "description" : "预授权订单相对超时时间，从商户请求时间开始计算。\t预授权订单允许的最晚授权时间，逾期将关闭该笔订单。取值范围：1m～15d。m-分钟，h-小时，d-天。 该参数数值不接受小数点， 如 1.5h，可转换为90m。\t默认为15m。", "example" : "2d" }, "payee_logon_id" : { "type" : "string", "description" : "收款账户的支付宝登录号（email或手机号）。\t如果传入则会校验该登录号对应的账号是否具备当前商户收款权限，如果商户希望用户能够使用花呗，则用户号(payee_user_id)和登录号(payee_logon_id)两者必须传入其一", "example" : "159****5620" }, "payee_user_id" : { "type" : "string", "description" : "收款账户的支付宝用户号。\t以2088开头的16位纯数字，如果传入则会校验该账号是否具备当前商户收款权限，如果商户希望用户能够使用花呗，则用户号(payee_user_id)和登录号(payee_logon_id)两者必须传入其一", "example" : "2088102000275795" }, "product_code" : { "type" : "string", "description" : "销售产品码。\t当面资金预授权固定为 PRE_AUTH", "example" : "PRE_AUTH" }, "scene_code" : { "type" : "string", "description" : "场景码。\t刷脸场景下传入HOTEL，其他情况下无需传入", "example" : "HOTEL" }, "settle_currency" : { "type" : "string", "description" : "商户指定的结算币种。支持澳元：AUD, 新西兰元：NZD, 台币：TWD, 美元：USD, 欧元：EUR, 英镑：GBP", "example" : "USD" }, "terminal_params" : { "type" : "string", "description" : "机具管控sdk加签参数，参数示例 \"terminal_params\":\"{\"terminalType\":\"IOT\",\"signature\":\"QIIAX8DqbFbNf2oe97FI1RSLAycC/tU4GVjer3bN8K4qLtAB\",\"apdidToken\":\"xPA3ptuArwYc3F6Va_pjVwv7Qx7Tg5TJdrA_Jb_moYte9AqGZgEAAA==\",\"hardToken\":\"\",\"time\":\"1539847253\",\"bizCode\":\"11000200040004000121\",\"bizTid\":\"010100F01i1XyacMgpOinHerfdBw1xA9dNDocctlnqhLD8lfODr1A7Q\",\"signedKeys\":\"authCode,totalAmount,apdidToken,hardToken,time,bizCode,bizTid\"}\"", "example" : "{\"terminalType\":\"IOT\",\"signature\":\"QIIAX8DqbFbNf2oe97FI1RSL\",\"apdidToken\":\"xPA3ptuArwYc3F6Va\",\"signedKeys\":\"auth,apdidToken\"}" }, "timeout_express" : { "type" : "string", "description" : "预授权订单相对超时时间，从商户请求时间开始计算。\t预授权订单允许的最晚授权时间，逾期将关闭该笔订单。取值范围：1m～15d。m-分钟，h-小时，d-天。 该参数数值不接受小数点， 如 1.5h，可转换为90m。\t默认为15m。", "example" : "2d" }, "trans_currency" : { "type" : "string", "description" : "标价币种, amount 对应的币种单位。支持澳元：AUD, 新西兰元：NZD, 台币：TWD, 美元：USD, 欧元：EUR, 英镑：GBP", "example" : "USD" } } }, "AlipayFundAuthOrderFreezeResponseModel" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "本次操作冻结的金额，单位为：元（人民币），精确到小数点后两位", "example" : "0.01" }, "auth_no" : { "type" : "string", "description" : "支付宝的资金授权订单号", "example" : "2014070800002001550000014417" }, "credit_amount" : { "type" : "string", "description" : "本次冻结操作中信用冻结金额，单位为：元（人民币），精确到小数点后两位", "example" : "0.01" }, "fund_amount" : { "type" : "string", "description" : "本次冻结操作中自有资金冻结金额，单位为：元（人民币），精确到小数点后两位", "example" : "0.01" }, "gmt_trans" : { "type" : "string", "description" : "资金授权成功时间\r\t格式：YYYY-MM-DD HH:MM:SS", "example" : "2014-09-15 11:23:04" }, "operation_id" : { "type" : "string", "description" : "支付宝的资金操作流水号", "example" : "2014070800032850551" }, "out_order_no" : { "type" : "string", "description" : "商户的授权资金订单号", "example" : "4977164666634053" }, "out_request_no" : { "type" : "string", "description" : "商户本次资金操作的请求流水号", "example" : "2014070700166653" }, "payer_logon_id" : { "type" : "string", "description" : "付款方支付宝账号（Email或手机号）", "example" : "test***@alitest.com" }, "payer_open_id" : { "type" : "string", "description" : "支付宝openId，用户（userId）在应用（appId）下的唯一用户标识。", "example" : "03914IMEfXsS9K-tSvHy-IisrLlOfthFgDVo-hU30XtKPg9" }, "payer_user_id" : { "type" : "string", "description" : "付款方支付宝用户号", "example" : "2088102000275885" }, "pre_auth_type" : { "type" : "string", "description" : "预授权类型，目前支持 CREDIT_AUTH(信用预授权);\r\t商户可根据该标识来判断该笔预授权的类型，当返回值为\"CREDIT_AUTH\"表明该笔预授权为信用预授权，没有真实冻结资金；当返回值为空或者不为\"CREDIT_AUTH\"则表明该笔预授权为普通资金预授权，会冻结用户资金。", "example" : "CREDIT_AUTH" }, "status" : { "type" : "string", "description" : "资金预授权明细的状态\r\t目前支持： \r\tINIT：初始\r\tSUCCESS: 成功\r\tCLOSED：关闭", "example" : "SUCCESS" }, "trans_currency" : { "type" : "string", "description" : "标价币种, amount 对应的币种单位。支持澳元：AUD, 新西兰元：NZD, 台币：TWD, 美元：USD, 欧元：EUR, 英镑：GBP", "example" : "USD" } } }, "AlipayFundAuthOrderUnfreezeErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_ARGUMENT", "UNIQUE_VIOLATION", "SYSTEM_ERROR", "PAYER_USER_STATUS_LIMIT", "AUTH_ORDER_NOT_EXIST", "REQUEST_AMOUNT_EXCEED", "ILLEGAL_STATUS", "ORDER_ALREADY_FINISH", "ORDER_ALREADY_CLOSED", "PAYER_NOT_EXIST", "BIZ_ERROR", "ACCESS_FORBIDDEN" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundAuthOrderUnfreezeModel" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "本次操作解冻的金额，单位为：元（人民币），精确到小数点后两位。\t取值范围：[0.01,100000000.00]", "example" : "20.11" }, "auth_no" : { "type" : "string", "description" : "支付宝资金授权订单号。", "example" : "2016101210002001810258115912" }, "extra_param" : { "type" : "string", "description" : "解冻扩展信息。map的json格式，目前支持如下key：\tunfreezeBizInfo：由芝麻消费，当前支持value如下：\t\"bizComplete\":\"true\"——标识本次解冻用户已履约，true表示信用单履约完结", "example" : "{\"unfreezeBizInfo\": \"{\\\"bizComplete\\\":\\\"true\\\"}\"}" }, "notify_url" : { "type" : "string", "description" : "通知地址" }, "out_request_no" : { "type" : "string", "description" : "解冻请求流水号。\t如果是针对同一笔授权单不同的解冻请求，如第一次解冻1元，第二次解冻2元，则解冻请求流水号必须不重复；\t如果是针对同一笔解冻请求的多次发起，则需要保证每次发起，解冻请求流水号和解冻金额都相同", "example" : "2016101200104001110081001" }, "remark" : { "type" : "string", "description" : "商户对本次解冻操作的附言描述", "example" : "2014-05期解冻200.00元" } } }, "AlipayFundAuthOrderUnfreezeResponseModel" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "本次操作解冻的金额，单位为：元（人民币），精确到小数点后两位，取值范围：[0.01,100000000.00]", "example" : "20.81" }, "auth_no" : { "type" : "string", "description" : "支付宝资金授权订单号", "example" : "2014070800002001550000014417" }, "credit_amount" : { "type" : "string", "description" : "本次解冻操作中信用解冻金额，单位为：元（人民币），精确到小数点后两位", "example" : "0.01" }, "fund_amount" : { "type" : "string", "description" : "本次解冻操作中自有资金解冻金额，单位为：元（人民币），精确到小数点后两位", "example" : "0.01" }, "gmt_trans" : { "type" : "string", "description" : "授权资金解冻成功时间，格式：YYYY-MM-DD HH:MM:SS", "example" : "2014-09-15 11:23:04" }, "operation_id" : { "type" : "string", "description" : "支付宝资金操作流水号", "example" : "2014070800032850551" }, "out_order_no" : { "type" : "string", "description" : "商户的授权资金订单号", "example" : "4977164666634053" }, "out_request_no" : { "type" : "string", "description" : "商户本次资金操作的请求流水号", "example" : "20140707001555633" }, "status" : { "type" : "string", "description" : "资金操作流水的状态\t目前支持：SUCCESS：成功", "example" : "SUCCESS" } } }, "AlipayFundAuthOrderVoucherCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_ARGUMENT", "UNIQUE_VIOLATION", "EXIST_FORBIDDEN_WORD", "ACCESS_FORBIDDEN", "PAYEE_NOT_EXIST", "PAYEE_USER_STATUS_LIMIT", "PAYER_USER_STATUS_LIMIT", "ORDER_ALREADY_FINISH", "ORDER_ALREADY_CLOSED", "FREEZE_ALREADY_SUCCESS", "ERROR_BALANCE_PAYMENT_DISABLE", "SYSTEM_ERROR", "MONEY_NOT_ENOUGH", "NO_PAYMENT_INSTRUMENTS_AVAILABLE", "PAYER_PAYEE_EQUAL", "CURRENCY_VERIFICATION_FAIL", "SECONDARY_MERCHANT_STATUS_ERROR", "USER_IDENTITY_INFO_VALIDATE_FAIL", "USER_ACCOUNT_VALIDATE_FAIL", "SUB_MERCHANT_ORG_ID_ERROR", "SUB_MERCHANT_LEVEL_ERROR", "SUB_MERCHANT_NO_PERMISSION", "MERCHANT_STATUS_ERROR", "UNSUPPORTED_BIZ_TYPE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundAuthOrderVoucherCreateModel" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "需要冻结的金额，单位为：元（人民币），精确到小数点后两位。\t取值范围：[0.01,100000000.00]", "example" : "100.00" }, "business_params" : { "type" : "string", "description" : "业务参数，如风控参数outRiskInfo等。", "example" : "{\"outRiskInfo\":\"{\\\"mcCreateTradeTime\\\":\\\"2022-03-11 12:46:09\\\",\\\"extraAccountCertnoLastSix\\\":\\\"000011\\\",\\\"mobileOperatingPlatform\\\":\\\"ios\\\",\\\"sysVersion\\\":\\\"15.4.2\\\",\\\"mcCreateTradeIp\\\":\\\"11.110.111.43\\\"}\"}" }, "disable_pay_channels" : { "type" : "string", "description" : "无特殊需要请勿传入；商户可用该参数禁用支付渠道。\t传入后用户不可使用列表中的渠道进行支付，目前支持两种禁用渠道：信用卡快捷（OPTIMIZED_MOTO）、信用卡卡通（BIGAMOUNT_CREDIT_CARTOON）。与可用支付渠道不能同时传入", "example" : "[{\"payChannelType\":\"OPTIMIZED_MOTO\"},{\"payChannelType\":\"BIGAMOUNT_CREDIT_CARTOON\"}]" }, "enable_pay_channels" : { "type" : "string", "description" : "无特殊需要请勿传入；商户可用该参数指定支付渠道。\t传入后用户仅能使用列表中的渠道进行支付，目前支持三种渠道，余额宝（MONEY_FUND）、花呗（PCREDIT_PAY）以及芝麻信用（CREDITZHIMA）。与禁用支付渠道不可同时传入", "example" : "[{\"payChannelType\":\"PCREDIT_PAY\"},{\"payChannelType\":\"MONEY_FUND\"}]" }, "extra_param" : { "type" : "string", "description" : "业务扩展参数，用于特定业务信息的传递，json格式，key值如下：\t1、category，信用类目，信用预授权场景必传，具体类目信息见https://opendocs.alipay.com/open/10719\t2、serviceId，信用服务id，信用预授权场景必传，需要联系芝麻客服获取，https://cshall.alipay.com/enterprise/index.htm?sourceId=pc_zhima（右上角“有问题点我”进入咨询）\t3、creditExtInfo，信用参数，如有需要请与芝麻约定后传入，信用服务说明见https://opendocs.alipay.com/open/11157/qlsxya", "example" : "{\"category\":\"CHARGE_PILE_CAR\",\"serviceId\":\"2020042800000000000001450466\"}" }, "identity_params" : { "type" : "string", "description" : "无特殊需要请勿传入；买家实名信息。\t传入后支付宝会比对买家在支付宝端的实名信息。包含两个可选key：\t1.identity_hash，买家姓名拼接身份证号后，使用SHA256摘要方式与UTF8编码后的hash值，返回的十六进制字符串，例如 “张三4566498798498498498498”对应的identity_hash应为“acc2b92ffc5ed9b472faa19748f10045c30434132784f774b00216a56b8841c6”\t2.alipay_open_id，买家支付宝openId\t3.alipay_user_id，买家支付宝uid", "example" : "{\"identity_hash\":\"acc2b92ffc5ed9b472faa19748f10045c30434132784f774b00216a56b8841c6\",\"alipay_open_id\":\"xxxxxx\",\"alipay_user_id\":\"2088xxx\"}" }, "notify_url" : { "type" : "string", "description" : "通知地址" }, "order_title" : { "type" : "string", "description" : "订单标题。\t业务订单的简单描述，如商品名称等", "example" : "预授权发码" }, "out_order_no" : { "type" : "string", "description" : "商户授权资金订单号。\t商家自定义需保证在商户端不重复。仅支持字母、数字、下划线。", "example" : "8077735255938023" }, "out_request_no" : { "type" : "string", "description" : "商户本次资金操作的请求流水号，用于标示请求流水的唯一性。\t可与out_order_no相同，仅支持字母、数字、下划线。", "example" : "8077735255938032" }, "pay_timeout" : { "type" : "string", "description" : "预授权订单相对超时时间，从商户请求时间开始计算。\t预授权订单允许的最晚授权时间，逾期将关闭该笔订单。取值范围：1m～15d。m-分钟，h-小时，d-天。 该参数数值不接受小数点， 如 1.5h，可转换为90m。\t默认为15m。", "example" : "2d" }, "payee_logon_id" : { "type" : "string", "description" : "收款账户的支付宝登录号（email或手机号）。\t如果传入则会校验该登录号对应的账号是否具备当前商户收款权限，如果商户希望用户能够使用花呗，则用户号(payee_user_id)和登录号(payee_logon_id)两者必须传入其一，二者无需同时传入", "example" : "159****5620" }, "payee_user_id" : { "type" : "string", "description" : "收款账户的支付宝用户号。\t以2088开头的16位纯数字，如果传入则会校验该账号是否具备当前商户收款权限，如果商户希望用户能够使用花呗，则用户号(payee_user_id)和登录号(payee_logon_id)两者必须传入其一，二者无需同时传入", "example" : "2088102000275795" }, "product_code" : { "type" : "string", "description" : "销售产品码。\t当面资金预授权固定为 PRE_AUTH", "example" : "PRE_AUTH" }, "settle_currency" : { "type" : "string", "description" : "商户指定的结算币种。支持澳元：AUD, 新西兰元：NZD, 台币：TWD, 美元：USD, 欧元：EUR, 英镑：GBP", "example" : "USD" }, "timeout_express" : { "type" : "string", "description" : "预授权订单相对超时时间，从商户请求时间开始计算。\t预授权订单允许的最晚授权时间，逾期将关闭该笔订单。取值范围：1m～15d。m-分钟，h-小时，d-天。 该参数数值不接受小数点， 如 1.5h，可转换为90m。\t默认为15m。", "example" : "2d" }, "trans_currency" : { "type" : "string", "description" : "标价币种, amount 对应的币种单位。支持澳元：AUD, 新西兰元：NZD, 台币：TWD, 美元：USD, 欧元：EUR, 英镑：GBP", "example" : "USD" } } }, "AlipayFundAuthOrderVoucherCreateResponseModel" : { "type" : "object", "properties" : { "code_type" : { "type" : "string", "description" : "码类型，分为 barCode：条形码 (一维码) 和 qrCode:二维码(qrCode) ；\r\t目前发码只支持 qrCode", "example" : "qrCode" }, "code_url" : { "type" : "string", "description" : "生成的带有支付宝logo的二维码地址，如：http://mobilecodec.alipay.com/show.htm?code=aeparsv2dknkqf3018556a；商户端通过在末尾追加picSize来指定要显示的图片大小，如\r\t显示1280大小的URL:http://mobilecodec.alipay.com/show.htm?code=aeparsv2dknkqf3018556a&picSize=1280；目前支持的大小有：256, 227, 270, 344, 430, 512, 570, 860, 1280, 1546；", "example" : "http://mobilecodec.alipay.com/show.htm?code=aeparsv2dknkqf3018556a" }, "code_value" : { "type" : "string", "description" : "当前发码请求生成的二维码码串，商户端可以利用二维码生成工具根据该码串值生成对应的二维码", "example" : "https://qr.alipay.com/aax017928umnzqo0uswmzd3" }, "out_order_no" : { "type" : "string", "description" : "商户的授权资金订单号", "example" : "8077735255938023" }, "out_request_no" : { "type" : "string", "description" : "商户本次资金操作的请求流水号", "example" : "8077735255938032" } } }, "AlipayFundEnterprisepayGroupAddErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "ILLEGAL_ARGUMENT", "CREATE_ACCOUNT_GROUP_FAIL", "OUT_GROUP_EXIST", "USER_AGREEMENT_DELETE_USELESS_FAIL", "AGREEMENT_NOT_EXIST", "ACCOUNT_NO_MULTI_FUND_PERMISSION", "FUND_IDENTITY_NOT_ALLOWED", "AGREEMENT_IS_INVALID", "USER_UNREAL_NAME", "CERT_TYPE_ERROR", "NEED_TO_SET_PPW", "USER_STATUS_ERROR", "USER_AGREEMENT_SIGN_FAIL", "FUND_IDENTITY_PARAM_ERROR", "JOINT_ACCOUNT_NOT_EXIST", "BIZ_SCENE_NOT_ADMIT", "COMMON_RPC_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundEnterprisepayGroupAddModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业签约账户ID", "example" : "2088888888" }, "agreement_no" : { "type" : "string", "description" : "平台和企业的三方授权协议号", "example" : "1231231321323" }, "biz_scene" : { "type" : "string", "description" : "场景码，联系支付宝分配", "example" : "ANT_GROUP" }, "fund_ext_info" : { "$ref" : "#/components/schemas/FundExtInfo" }, "name" : { "type" : "string", "description" : "群组名称", "example" : "后勤组" }, "out_biz_no" : { "type" : "string", "description" : "外部业务号，外部群组号", "example" : "12312313" }, "product_code" : { "type" : "string", "description" : "产品码，默认值\tENTERPRISE_PAY", "example" : "ENTERPRISE_PAY" } } }, "AlipayFundEnterprisepayGroupAddResponseModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "因公付账户ID", "example" : "2088123123" }, "fund_group_id" : { "type" : "string", "description" : "资金群组号", "example" : "2088123123" }, "out_group_id" : { "type" : "string", "description" : "外部群组号，业务号", "example" : "out_001" } } }, "AlipayFundEnterprisepayGroupDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "ILLEGAL_ARGUMENT", "FUND_GROUP_NOT_EXIST", "USER_AGREEMENT_DELETE_USELESS_FAIL", "AGREEMENT_NOT_EXIST", "HORIZONTAL_AUTHORITY_EXCEPTION", "AGREEMENT_IS_INVALID", "AGREEMENT_STATUS_IS_NOT_NORMAL", "AGREEMENT_IS_OUT_OF_DATE", "BIZ_SCENE_NOT_ADMIT", "JOINT_ACCOUNT_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundEnterprisepayGroupDeleteResponseModel" : { "type" : "object" }, "AlipayFundEnterprisepayGroupModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "AGREEMENT_NOT_EXIST", "ILLEGAL_ARGUMENT", "HORIZONTAL_AUTHORITY_EXCEPTION", "FUND_GROUP_NOT_EXIST", "UPDATE_ACCOUNT_GROUP_FAIL", "ACCOUNT_NO_MULTI_FUND_PERMISSION", "FUND_IDENTITY_NOT_ALLOWED", "UN_SUPPORT_UPDATE_SCENE", "AGREEMENT_IS_INVALID", "AGREEMENT_STATUS_IS_NOT_NORMAL", "AGREEMENT_IS_OUT_OF_DATE", "USER_AGREEMENT_UPDATE_FAIL", "FUND_IDENTITY_PARAM_ERROR", "BIZ_SCENE_NOT_ADMIT", "USER_UNREAL_NAME", "CERT_TYPE_ERROR", "NEED_TO_SET_PPW", "USER_STATUS_ERROR", "JOINT_ACCOUNT_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundEnterprisepayGroupModifyModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业签约账户ID", "example" : "2088888888" }, "agreement_no" : { "type" : "string", "description" : "平台和企业的三方授权协议号", "example" : "1231231321323" }, "biz_scene" : { "type" : "string", "description" : "场景码，联系支付宝分配", "example" : "ANT_GROUP" }, "fund_ext_info" : { "$ref" : "#/components/schemas/FundExtInfo" }, "name" : { "type" : "string", "description" : "群组名称", "example" : "后勤组" }, "operation_type_list" : { "type" : "array", "description" : "更新操作类型：多个时逗号分隔\tNAME-群组名称\tFUND-出资信息\t字段不传时，默认全量更新", "items" : { "type" : "string" }, "example" : "[\"NAME\",\"FUND\"]" }, "out_biz_no" : { "type" : "string", "description" : "外部业务号", "example" : "12123123" }, "product_code" : { "type" : "string", "description" : "产品码，默认值\tENTERPRISE_PAY", "example" : "ENTERPRISE_PAY" } } }, "AlipayFundEnterprisepayGroupModifyResponseModel" : { "type" : "object" }, "AlipayFundEnterprisepayGroupQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "AGREEMENT_NOT_EXIST", "AGREEMENT_IS_INVALID", "AGREEMENT_STATUS_IS_NOT_NORMAL", "AGREEMENT_IS_OUT_OF_DATE", "HORIZONTAL_AUTHORITY_EXCEPTION", "FUND_GROUP_NOT_EXIST", "SYSTEM_ERROR", "JOINT_ACCOUNT_NOT_EXIST", "BIZ_SCENE_NOT_ADMIT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundEnterprisepayGroupQueryResponseModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业签约账户ID", "example" : "2088888888" }, "fund_group_id" : { "type" : "string", "description" : "内部群组号", "example" : "2088888888" }, "fund_identity" : { "type" : "string", "description" : "该群所对应的出资主体账号", "example" : "20888888" }, "group_name" : { "type" : "string", "description" : "群组名称", "example" : "群组" }, "out_group_id" : { "type" : "string", "description" : "外部群组号", "example" : "1231231" } } }, "AlipayFundEnterprisepayMemberModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "AGREEMENT_NOT_EXIST", "ILLEGAL_ARGUMENT", "HORIZONTAL_AUTHORITY_EXCEPTION", "NOT_REGISTER_MEMBER", "FUND_GROUP_NOT_EXIST", "FUND_IDENTITY_NOT_ALLOWED", "ACCOUNT_NO_MULTI_FUND_PERMISSION", "AGREEMENT_IS_INVALID", "AGREEMENT_STATUS_IS_NOT_NORMAL", "AGREEMENT_IS_OUT_OF_DATE", "USER_AGREEMENT_SIGN_FAIL", "UN_SUPPORT_UPDATE_SCENE", "USER_AGREEMENT_UPDATE_FAIL", "FUND_IDENTITY_PARAM_ERROR", "BIZ_SCENE_NOT_ADMIT", "MEMBER_FUND_MODIFY_FAIL", "JA_IDENTITY_INVALID" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundEnterprisepayMemberModifyModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业签约账户ID", "example" : "2088888888" }, "agreement_no" : { "type" : "string", "description" : "平台和企业的三方授权协议号", "example" : "1231231321323" }, "biz_scene" : { "type" : "string", "description" : "场景码，联系支付宝分配", "example" : "ANT_GROUP" }, "fund_ext_info" : { "$ref" : "#/components/schemas/FundExtInfo" }, "group_id_list" : { "type" : "array", "description" : "员工当前关联的群组ID，支持多个", "items" : { "type" : "string" }, "example" : "[\"11\",\"22\",\"33\"]" }, "open_id" : { "type" : "string", "description" : "蚂蚁统一会员openId", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "operation_type_list" : { "type" : "array", "description" : "更新操作类型：多个时逗号分隔\tGROUP-群组信息\tFUND-出资信息\t字段不传时，默认全量更新", "items" : { "type" : "string" }, "example" : "[\"GROUP\",\"FUND\"]" }, "product_code" : { "type" : "string", "description" : "产品码，默认值\tENTERPRISE_PAY", "example" : "ENTERPRISE_PAY" }, "user_id" : { "type" : "string", "description" : "蚂蚁统一会员ID", "example" : "2088123123" } } }, "AlipayFundEnterprisepayMemberModifyResponseModel" : { "type" : "object" }, "AlipayFundEnterprisepaySignErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PRODUCT_NOT_SIGN", "ILLEGAL_ARGUMENT", "INVALID_ACCOUNT_OUT_SOURCE", "PARAM_NAME_NOT_BLANK", "ACCOUNT_OUTBIZNO_EXIST", "AGREEMENT_NOT_EXIST", "HORIZONTAL_AUTHORITY_EXCEPTION", "GEN_SIGN_TOKEN_FAIL", "MERCHANT_SYSTEM_FAILURE", "SYSTEM_ERROR", "MERCHANT_CARD_NOT_EXISTS", "NEED_TO_SET_PPW", "USER_UNREAL_NAME", "USER_STATUS_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundEnterprisepaySignModel" : { "type" : "object", "properties" : { "account_name" : { "type" : "string", "description" : "企业简称，传空采用默认规则命名，使用公司名称", "example" : "Anonymity" }, "appoint_sign_terminal" : { "type" : "string", "description" : "指定签约终端类型\tPC-电脑浏览器\tMOBILE-手机端", "example" : "PC" }, "biz_scene" : { "type" : "string", "description" : "业务场景，联系支付宝分配", "example" : "DEFAULT" }, "ext_params" : { "type" : "string", "description" : "特殊场景下扩展字段", "example" : "\"{\\\"key\\\":\\\"value\\\"}\"" }, "identity" : { "type" : "string", "description" : "开户账号：\t当identity_type是ALIPAY_USER_ID时填支付宝会员ID（2088开头）；\t当identity_type是ALIPAY_LOGON_ID 时填支付宝登录号；\t当identity_type是OUT_USER_ID时填外部平台的用户uid;\t当identity_type是ALIPAY_OPEN_ID时填用户openId", "example" : "name@email.com" }, "identity_name" : { "type" : "string", "description" : "开户用户名称，identity_type为ALIPAY_LOGON_ID时必填", "example" : "张三" }, "identity_type" : { "type" : "string", "description" : "账号类型，目前支持如下类型：\t1、ALIPAY_USER_ID 支付宝的会员ID\t2、ALIPAY_LOGON_ID：支付宝登录号，支持邮箱和手机号格式\t3、OUT_USER_ID：外部用户uid", "example" : "ALIPAY_LOGON_ID" }, "out_biz_no" : { "type" : "string", "description" : "商户侧单号（幂等字段）\t，补充说明：幂等逻辑（商户appid+out_biz_no），商户集成时需注意，如换号重复发起，则认为是一笔新的请求", "example" : "1650353507572" }, "out_entity_id" : { "type" : "string", "description" : "外部实体ID，一般表述为外部操作人操作某个外部实体。比如企业码2284号", "example" : "2488888888" }, "out_source" : { "type" : "string", "description" : "ISV平台定义的共同账户开户来源", "example" : "DINGDING" }, "product_code" : { "type" : "string", "description" : "产品码", "example" : "ENTERPRISE_PAY" } } }, "AlipayFundEnterprisepaySignResponseModel" : { "type" : "object", "properties" : { "sign_token" : { "type" : "string", "description" : "签约凭证", "example" : "signToken" }, "sign_url" : { "type" : "string", "description" : "签约链接，用于跳转到开户页面", "example" : "http://business-site-default.dev.alipay.net/page/EnterprisePay/Account?signToken=12324" } } }, "AlipayFundEnterprisepayUnsignErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ENTERPRISE_ACCOUNT_UNSIGNED", "AGREEMENT_NOT_EXIST", "HORIZONTAL_AUTHORITY_EXCEPTION", "PRODUCT_NOT_SIGN", "GEN_UNSIGN_TOKEN_FAIL", "ILLEGAL_ARGUMENT", "AGREEMENT_ACCOUNT_NOT_MATCH", "MERCHANT_SYSTEM_FAILURE", "AGREEMENT_IS_INVALID", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundEnterprisepayUnsignModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业账号", "example" : "2088xxx" }, "agreement_no" : { "type" : "string", "description" : "授权协议号", "example" : "2088xxx" }, "biz_scene" : { "type" : "string", "description" : "业务场景", "example" : "ISV_ALIYUN" }, "product_code" : { "type" : "string", "description" : "销售产品码", "example" : "ENTERPRISE_PAY" } } }, "AlipayFundEnterprisepayUnsignResponseModel" : { "type" : "object", "properties" : { "unsign_token" : { "type" : "string", "description" : "解约凭证", "example" : "700e15fc014d463eb84600676f1976b4" }, "unsign_url" : { "type" : "string", "description" : "解约链接", "example" : "http://business-site-default.dev.alipay.net/page/EnterprisePay/Account?unsignToken=12324" } } }, "AlipayFundJointaccountBillQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PRODUCT_NOT_SIGN", "AGREEMENT_IS_INVALID", "ILLEGAL_ARGUMENT", "START_AFTER_END_DATE", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundJointaccountBillQueryResponseModel" : { "type" : "object", "properties" : { "bill_list" : { "type" : "array", "description" : "返回账单列表。账单列表为空时，返回为空", "items" : { "$ref" : "#/components/schemas/JointAccountBillDetailDTO" } }, "biz_scene" : { "type" : "string", "description" : "场景", "example" : "DEFAULT" }, "has_next_page" : { "type" : "boolean", "description" : "是否有下一页", "example" : "true" }, "page_num" : { "type" : "string", "description" : "当期页数", "example" : "1" }, "page_size" : { "type" : "string", "description" : "当期页记录数", "example" : "10" }, "product_code" : { "type" : "string", "description" : "产品码", "example" : "ENTERPRISE_PAY" } } }, "AlipayFundJointaccountDetailQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PRODUCT_NOT_SIGN", "AGREEMENT_IS_INVALID", "AGREEMENT_NOT_EXIST", "JOINT_ACCOUNT_NO_EXIST", "ILLEGAL_ARGUMENT", "SYSTEM_ERROR", "ACCOUNT_NOT_EXIST", "JA_ASSET_NOT_EXIST", "AGREEMENT_STATUS_IS_NOT_NORMAL", "AGREEMENT_IS_OUT_OF_DATE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundJointaccountDetailQueryResponseModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "合花群ID（支付宝侧生成）", "example" : "2088xxx" }, "account_name" : { "type" : "string", "description" : "账户名称（支付宝侧生成）", "example" : "企业代付" }, "account_quota" : { "type" : "array", "description" : "额度模型", "items" : { "$ref" : "#/components/schemas/JointAccountQuotaRespDTO" } }, "account_status" : { "type" : "string", "description" : "账户状态
\t-NORMAL：正常
\t-RELEASING：注销中
\t-RELEASED：已注销
\t- FREEZE：冻结", "example" : "NORMAL" }, "agreement_no" : { "type" : "string", "description" : "授权协议号（支付宝侧生成）", "example" : "2088xxx" }, "authorized_rule" : { "$ref" : "#/components/schemas/AuthorizedRuleDTO" }, "available_balance" : { "type" : "string", "description" : "当前可用金额（单位为元，必须大于0且最多小数点后两位）", "example" : "13.14" }, "biz_scene" : { "type" : "string", "description" : "业务场景码", "example" : "DEFAULT" }, "creator_id" : { "type" : "string", "description" : "（创建人）支付宝侧用户唯一标识", "example" : "2088900976740001" }, "creator_open_id" : { "type" : "string", "description" : "（创建人）支付宝侧用户唯一标识", "example" : "095PJtAPYb2Uk" }, "creator_out_id" : { "type" : "string", "description" : "（创建人）商户侧用户唯一标识
\t补充说明：
\t-如果签约时，发起人标识传递的是商户侧用户唯一标识，则该字段会返回
\t-如果签约时，发起人标识传递的是支付宝侧用户唯一标识，则该字段为空", "example" : "12345678" }, "freeze_balance" : { "type" : "string", "description" : "当前冻结金额（单位为元，必须大于0且最多小数点后两位）", "example" : "5.20" }, "invite_result_list" : { "type" : "array", "description" : "签约时邀请的成员列表（快照）", "items" : { "$ref" : "#/components/schemas/InviteResultDTO" } }, "member_list" : { "type" : "array", "description" : "已加入合花群的成员列表", "items" : { "$ref" : "#/components/schemas/JointAccountMemberInfoRespDTO" } }, "product_code" : { "type" : "string", "description" : "销售产品码", "example" : "ENTERPRISE_PAY" }, "profit_status" : { "type" : "string", "description" : "生息状态：
\t- MAKING ：开启中
\t- MADE. ：已开启
\t- CLEARING：关闭中
\t- NONE. ：未生息", "example" : "MADE" }, "yesterday_profit" : { "type" : "string", "description" : "昨日收益", "example" : "0.45" } } }, "AlipayFundJointaccountListQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PRODUCT_NOT_SIGN" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundJointaccountListQueryResponseModel" : { "type" : "object", "properties" : { "account_list" : { "type" : "array", "description" : "共同账户列表", "items" : { "$ref" : "#/components/schemas/JointAccountDTO" } }, "biz_scene" : { "type" : "string", "description" : "场景", "example" : "DEFAULT" }, "product_code" : { "type" : "string", "description" : "产品码", "example" : "ENTERPRISE_PAY" } } }, "AlipayFundJointaccountMemberBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PRODUCT_NOT_SIGN", "ILLEGAL_ARGUMENT", "IDENTITY_CHECK_ERROR", "AGREEMENT_IS_INVALID", "AGREEMENT_NOT_EXIST", "SYSTEM_ERROR", "USER_NOT_MATCH", "CONFIG_ERROR", "LAST_USER_ID_PARAM_ERROR", "PAGE_SIZE_PARAM_ERROR", "OPEN_ID_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundJointaccountMemberBatchqueryModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户ID", "example" : "20888888888" }, "agreement_no" : { "type" : "string", "description" : "三方授权协议号", "example" : "3424324324324" }, "biz_scene" : { "type" : "string", "description" : "业务场景", "example" : "ISV_DEFAULT" }, "identity" : { "type" : "string", "description" : "企业账号：identity_type是ALIPAY_USER_ID填支付宝会员ID（2088开头）；\t是ALIPAY_LOGON_ID 填支付宝登录号", "example" : "name@email.com" }, "identity_type" : { "type" : "string", "description" : "账号类型，目前支持如下类型： 1、ALIPAY_USER_ID 支付宝的会员ID 2、ALIPAY_LOGON_ID：支付宝登录号，支持邮箱和手机号格式", "example" : "ALIPAY_LOGON_ID" }, "last_open_id" : { "type" : "string", "description" : "按游标查询，传入上次查询最后一个用户的openId", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "last_user_id" : { "type" : "string", "description" : "按游标查询，传入上次查询最后一个用户ID，适用于逐页查询。优先级大于page_num", "example" : "2088900976746215" }, "page_num" : { "type" : "string", "description" : "采用分页查询，本参数为空或0默认显示第一页。如果输入的值大于总页数，则支付宝返回最后一页数据。", "example" : "1" }, "page_size" : { "type" : "string", "description" : "每页大小，不传的情况下默认20条，上限100；不足20条则按实际记录数返回", "example" : "20" }, "product_code" : { "type" : "string", "description" : "销售产品码", "example" : "ENTERPRISE_PAY" } } }, "AlipayFundJointaccountMemberBatchqueryResponseModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户ID", "example" : "2088900976746215" }, "member_list" : { "type" : "array", "description" : "员工列表", "items" : { "$ref" : "#/components/schemas/JointAccountMemberDTO" } }, "page_num" : { "type" : "string", "description" : "当前页数，使用游标方式查询时，没有该字段", "example" : "1" }, "page_size" : { "type" : "string", "description" : "当前记录数", "example" : "1" }, "total_count" : { "type" : "string", "description" : "总条数", "example" : "100" }, "total_page_count" : { "type" : "string", "description" : "总页数", "example" : "50" } } }, "AlipayFundJointaccountMemberBindErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PRODUCT_NOT_SIGN", "ANALYSIS_PARAM_ERROR", "PARAM_NAME_NOT_BLANK", "AGREEMENT_NOT_EXIST", "AGREEMENT_IS_INVALID", "AGREEMENT_STATUS_IS_NOT_NORMAL", "AGREEMENT_IS_OUT_OF_DATE", "HORIZONTAL_AUTHORITY_EXCEPTION", "USER_NOT_EXIST", "USER_TYPE_NOT_ALLOWED", "USER_UNREAL_NAME", "CERT_TYPE_ERROR", "NEED_TO_SET_PPW", "USER_STATUS_ERROR", "INVITE_MEMBER_FAIL", "JOINT_ACCOUNT_DUPLICATE_INVITE", "ALREADY_REGISTER_MEMBER", "JOINT_ACCOUNT_APPLY_STATUS_ERROR", "ENTERPRISE_MEMBER_NUM_EXCEED_MAX", "JOINED_ACCOUNT_NUM_EXCEED_MAX", "USER_GROUP_OVER_MAX", "FUND_GROUP_NOT_EXIST", "FUND_IDENTITY_NOT_ALLOWED", "ACCOUNT_NO_MULTI_FUND_PERMISSION", "FUND_IDENTITY_PARAM_ERROR", "COMMON_LOCK_CONFLICT", "ILLEGAL_ARGUMENT", "SYSTEM_ERROR", "COMMON_RPC_ERROR", "OPEN_ID_TRANSFORM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundJointaccountMemberBindModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "账本ID", "example" : "2088000166406784" }, "account_quota" : { "$ref" : "#/components/schemas/JointAccountQuotaDTO" }, "agreement_no" : { "type" : "string", "description" : "授权签约协议号", "example" : "20214922001380716008" }, "biz_scene" : { "type" : "string", "description" : "业务场景，联系支付宝分配", "example" : "ISV_STANDARD" }, "business_params" : { "$ref" : "#/components/schemas/InviteMemberBusinessParamsDTO" }, "identity" : { "type" : "string", "description" : "成员账号：\tidentity_type是ALIPAY_USER_ID填支付宝会员ID（2088开头）；\t是ALIPAY_LOGON_ID 填支付宝登录号；\t是ALIPAY_OPEN_ID 填支付宝openId", "example" : "name@email.com" }, "identity_type" : { "type" : "string", "description" : "账号类型，目前支持如下类型：\t1、ALIPAY_USER_ID 支付宝的会员ID \t2、ALIPAY_LOGON_ID：支付宝登录号，支持邮箱和手机号格式\t3、ALIPAY_OPEN_ID：支付宝openId", "example" : "ALIPAY_LOGON_ID" }, "identity_verified_info" : { "$ref" : "#/components/schemas/IdentityVerifiedInfoDTO" }, "name" : { "type" : "string", "description" : "成员姓名，账号类型为ALIPAY_LOGON_ID时必填", "example" : "张三" }, "product_code" : { "type" : "string", "description" : "产品码", "example" : "ENTERPRISE_PAY" } } }, "AlipayFundJointaccountMemberBindResponseModel" : { "type" : "object", "properties" : { "reply_url" : { "type" : "string", "description" : "员工回应邀请链接", "example" : "http://www.baidu.com" } } }, "AlipayFundJointaccountMemberConsultErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PRODUCT_NOT_SIGN", "AGREEMENT_IS_INVALID", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundJointaccountMemberConsultModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业ID", "example" : "2088900976746215" }, "agreement_no" : { "type" : "string", "description" : "协议号", "example" : "20205820659822371223" }, "business_params" : { "type" : "string", "description" : "扩展参数，如需使用请联系支付宝开放同学", "example" : "{\"k\":\"v\"}" }, "open_id_list" : { "type" : "array", "description" : "要检查的员工openId", "items" : { "type" : "string" }, "example" : "[\"074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5\"]" }, "user_id_list" : { "type" : "array", "description" : "要检查的员工ID", "items" : { "type" : "string" }, "example" : "[\"2088900976746215\"]" } } }, "AlipayFundJointaccountMemberConsultResponseModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业ID", "example" : "2088900976746215" }, "code" : { "type" : "string", "description" : "返回码\t10000-成功\t其他都是失败", "example" : "10000" }, "member_list" : { "type" : "array", "description" : "员工列表", "items" : { "$ref" : "#/components/schemas/MemberStatusRespDTO" } }, "msg" : { "type" : "string", "description" : "描述信息", "example" : "Success" } } }, "AlipayFundJointaccountMemberQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PRODUCT_NOT_SIGN", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundJointaccountMemberQueryResponseModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户ID", "example" : "2088900976746215" }, "biz_scene" : { "type" : "string", "description" : "场景码", "example" : "DEFAULT" }, "member_list" : { "type" : "array", "description" : "成员列表", "items" : { "$ref" : "#/components/schemas/JointAccountMemberRespDTO" } }, "page_num" : { "type" : "string", "description" : "页码", "example" : "1" }, "page_size" : { "type" : "string", "description" : "页面记录数", "example" : "10" }, "product_code" : { "type" : "string", "description" : "产品码", "example" : "ENTERPRISE_PAY" }, "total_page_count" : { "type" : "string", "description" : "总页数", "example" : "10" } } }, "AlipayFundJointaccountMemberUnbindErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PRODUCT_NOT_SIGN", "ANALYSIS_PARAM_ERROR", "PARAM_NAME_NOT_BLANK", "AGREEMENT_NOT_EXIST", "AGREEMENT_IS_INVALID", "AGREEMENT_STATUS_IS_NOT_NORMAL", "AGREEMENT_IS_OUT_OF_DATE", "HORIZONTAL_AUTHORITY_EXCEPTION", "USER_NOT_EXIST", "USER_TYPE_NOT_ALLOWED", "USER_UNREAL_NAME", "CERT_TYPE_ERROR", "NEED_TO_SET_PPW", "USER_STATUS_ERROR", "MEMBER_NOT_IN_ACCOUNT", "CANCEL_INVITE_MEMBER_FAIL", "DELETE_INVITE_MEMBER_FAIL", "NON_EXISTENT_INVITE_RECORD", "PASSIVE_DELETE_ADMIN", "QUERY_ACCOUNT_INFO_FAIL", "DELETE_MASTER_SELF", "PASSIVE_BECOME_ADMIN", "JOINT_ACCOUNT_NOT_EXIST", "HAS_DELETED", "DELETE_MEMBER_PERMISSION_DENIED", "DELETE_FAIL", "JOINT_ACCOUNT_INVITE_STATUS_INVALID", "JOINT_ACCOUNT_NO_PERMISSION", "ILLEGAL_ARGUMENT", "CONSULT_MEMBER_FAIL", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundJointaccountMemberUnbindModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "账本id", "example" : "2088000166406784" }, "agreement_no" : { "type" : "string", "description" : "授权协议号", "example" : "20214922001380716008" }, "biz_scene" : { "type" : "string", "description" : "场景码", "example" : "DEFAULT" }, "identity" : { "type" : "string", "description" : "成员账号：\tidentity_type是ALIPAY_USER_ID填支付宝会员ID（2088开头）；\t是ALIPAY_LOGON_ID 填支付宝登录号", "example" : "name@email.com" }, "identity_type" : { "type" : "string", "description" : "账号类型，目前支持如下类型： 1、ALIPAY_USER_ID 支付宝的会员ID 2、ALIPAY_LOGON_ID：支付宝登录号，支持邮箱和手机号格式", "example" : "ALIPAY_LOGON_ID" }, "name" : { "type" : "string", "description" : "姓名，账号类型为ALIPAY_LOGON_ID时必填", "example" : "张三" }, "product_code" : { "type" : "string", "description" : "产品码", "example" : "ENTERPRISE_PAY" }, "status" : { "type" : "string", "description" : "成员当前状态：\t邀请中（PROCESSING）、正常（NORMAL）", "example" : "NORMAL" } } }, "AlipayFundJointaccountMemberUnbindResponseModel" : { "type" : "object" }, "AlipayFundJointaccountMemberruleModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PRODUCT_NOT_SIGN", "MAX_QUOTA_CONFIG_MISSING" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundJointaccountMemberruleModifyModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "账户ID", "example" : "2088900976746215" }, "agreement_no" : { "type" : "string", "description" : "授权协议号", "example" : "20889009767462151233" }, "biz_scene" : { "type" : "string", "description" : "业务场景", "example" : "DEFAULT" }, "member_list" : { "$ref" : "#/components/schemas/JointAccountMemberList" }, "product_code" : { "type" : "string", "description" : "产品码", "example" : "ENTERPRISE_PAY" } } }, "AlipayFundJointaccountMemberruleModifyResponseModel" : { "type" : "object" }, "AlipayFundJointaccountQuotaQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PRODUCT_NOT_SIGN", "AGREEMENT_NOT_EXIST", "AGREEMENT_STATUS_IS_NOT_NORMAL", "AGREEMENT_IS_OUT_OF_DATE", "AGREEMENT_IS_INVALID", "ILLEGAL_ARGUMENT", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundJointaccountQuotaQueryResponseModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户ID", "example" : "2088900976746215" }, "account_quota" : { "type" : "array", "description" : "共同账户额度模型", "items" : { "$ref" : "#/components/schemas/JointAccountQuotaRespDTO" } }, "biz_scene" : { "type" : "string", "description" : "场景码", "example" : "DEFAULT" }, "member_id" : { "type" : "string", "description" : "成员ID（如果查询员工才返回）", "example" : "2088900976746215" }, "member_open_id" : { "type" : "string", "description" : "员工openId", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "product_code" : { "type" : "string", "description" : "产品码", "example" : "ENTERPRISE_PAY" } } }, "AlipayFundJointaccountRuleModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PRODUCT_NOT_SIGN" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundJointaccountRuleModifyModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "账本ID", "example" : "2088402123951081" }, "account_name" : { "type" : "string", "description" : "账本名称", "example" : "账本名称" }, "account_quota" : { "type" : "array", "description" : "账户额度", "items" : { "$ref" : "#/components/schemas/JointAccountQuotaDTO" } }, "agreement_no" : { "type" : "string", "description" : "授权协议号", "example" : "2088402124305476" }, "authorized_rule" : { "$ref" : "#/components/schemas/AuthorizedRuleDTO" }, "biz_scene" : { "type" : "string", "description" : "场景码", "example" : "DEFAULT" }, "product_code" : { "type" : "string", "description" : "产品码", "example" : "ENTERPRISE_PAY" } } }, "AlipayFundJointaccountRuleModifyResponseModel" : { "type" : "object" }, "AlipayFundJointaccountSignQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_ARGUMENT", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundJointaccountSignQueryResponseModel" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业签约的账户ID", "example" : "2088123123123" }, "agreement_no" : { "type" : "string", "description" : "企业授权平台的三方授权协议号", "example" : "121212121212" }, "status" : { "type" : "string", "description" : "账户状态，NORMAL-生效中，RELEASED-已销户", "example" : "NORMAL" } } }, "AlipayFundJointaccountTradeQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PRODUCT_NOT_SIGN", "TRADE_NOT_EXSIT", "MEMBER_NOT_IN_ACCOUNT", "TRADE_DO_NOT_BELONG_USER", "ILLEGAL_ARGUMENT", "AGREEMENT_IS_INVALID", "AGREEMENT_NOT_EXIST", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundJointaccountTradeQueryResponseModel" : { "type" : "object", "properties" : { "buyer_id" : { "type" : "string", "description" : "买家ID", "example" : "2088888888" }, "buyer_open_id" : { "type" : "string", "description" : "买家的openId", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "create_time" : { "type" : "string", "description" : "交易创建时间", "example" : "2010-11-11 11:11:11" }, "total_amount" : { "type" : "string", "description" : "订单总金额", "example" : "2" }, "trade_fund_bill_list" : { "type" : "array", "description" : "资金单明细", "items" : { "$ref" : "#/components/schemas/TradeFundBillDetail" } }, "trade_info_list" : { "type" : "array", "description" : "交易信息集合。查询为批量查询时，使用该结果返回", "items" : { "$ref" : "#/components/schemas/TradeInfoDTO" } }, "trade_no" : { "type" : "string", "description" : "交易单号", "example" : "1231231321321" }, "trade_status" : { "type" : "string", "description" : "交易状态：WAIT_BUYER_PAY（交易创建，等待买家付款）、TRADE_CLOSED（未付款交易超时关闭，或支付完成后全额退款）、TRADE_SUCCESS（交易支付成功）、TRADE_FINISHED（交易结束，不可退款）", "example" : "TRADE_SUCCESS" } } }, "AlipayFundTransCommonQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ORDER_NOT_EXIST", "INVALID_PARAMETER", "SYSTEM_ERROR", "NO_ORDER_PERMISSION" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundTransCommonQueryResponseModel" : { "type" : "object", "properties" : { "arrival_time_end" : { "type" : "string", "description" : "预计到账时间，转账到银行卡专用，格式为yyyy-MM-dd HH:mm:ss，转账受理失败不返回。\r\t注意：\r\t此参数为预计时间，可能与实际到账时间有较大误差，不能作为实际到账时间使用，仅供参考用途。", "example" : "2013-01-01 08:08:08" }, "deduct_bill_info" : { "type" : "string", "description" : "商户查询代扣订单信息时返回其在代扣请求中传入的账单属性", "example" : "{\"bizDesc\":\"代扣账单属性\",\"bizNos\":\"M{529316162343612472}\",\"billSource\":\"账房\",\"bizOrigNo\":\"529316162343612472\",\"reqSystem\":\"PointCenter\"}" }, "error_code" : { "type" : "string", "description" : "查询到的订单状态为FAIL失败或REFUND退票时，返回错误代码", "example" : "PAYEE_CARD_INFO_ERROR" }, "fail_reason" : { "type" : "string", "description" : "查询到的订单状态为FAIL失败或REFUND退票时，返回具体的原因。", "example" : "收款方银行卡信息有误" }, "order_fee" : { "type" : "string", "description" : "预计收费金额（元），转账到银行卡专用，数字格式，精确到小数点后2位，转账失败或转账受理失败不返回。", "example" : "0.02" }, "order_id" : { "type" : "string", "description" : "支付宝转账单据号，查询失败不返回。", "example" : "20190801110070000006380000250621" }, "out_biz_no" : { "type" : "string", "description" : "商户订单号", "example" : "201808080001" }, "passback_params" : { "type" : "string", "description" : "商户回传参数", "example" : "{\"merchantBizType\":\"peerPay\"}" }, "pay_date" : { "type" : "string", "description" : "支付时间，格式为yyyy-MM-dd HH:mm:ss，转账失败不返回。", "example" : "2013-01-01 08:08:08" }, "pay_fund_order_id" : { "type" : "string", "description" : "支付宝支付资金流水号，转账失败不返回。", "example" : "20190801110070001506380000251556" }, "status" : { "type" : "string", "description" : "转账单据状态。可能出现的状态如下： SUCCESS：转账成功； WAIT_PAY：等待支付； CLOSED：订单超时关闭； FAIL：失败（适用于\"单笔转账到银行卡\"）； DEALING：处理中（适用于\"单笔转账到银行卡\"）； REFUND：退票（适用于\"单笔转账到银行卡\"）； alipay.fund.trans.app.pay涉及的状态： WAIT_PAY、SUCCESS、CLOSED alipay.fund.trans.refund涉及的状态：SUCCESS alipay.fund.trans.uni.transfer涉及的状态：SUCCESS、FAIL、DEALING、REFUND", "example" : "SUCCESS" }, "sub_order_error_code" : { "type" : "string", "description" : "特殊场景提供，当子单出现异常导致主单失败或者退款时，会提供此字段，用于透出子单具体的错误场景", "example" : "MID_ACCOUNT_CARD_INFO_ERROR" }, "sub_order_fail_reason" : { "type" : "string", "description" : "特殊场景提供，当子单出现异常导致主单失败或者退款时，会提供此字段，用于透出子单具体的错误场景", "example" : "收款方银行卡信息有误" }, "sub_order_status" : { "type" : "string", "description" : "退款子单失败状态", "example" : "FAIL" }, "trans_amount" : { "type" : "string", "description" : "付款金额，收银台场景下付款成功后的支付金额，订单状态为SUCCESS才返回，其他状态不返回。", "example" : "付款金额，单位为元，精确到小数点后两位：32.00" }, "transfer_bill_info" : { "type" : "string", "description" : "商户在查询代发订单信息时返回其在代发请求中传入的账单属性。", "example" : "{\"bizDesc\":\"代扣账单属性\",\"bizNos\":\"M{529316162343612472}\",\"billSource\":\"账房\",\"bizOrigNo\":\"529316162343612472\",\"reqSystem\":\"PointCenter\"}" } } }, "AlipayFundTransOrderQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ORDER_NOT_EXIST", "NO_ORDER_PERMISSION", "INVALID_PARAMETER", "ILLEGAL_ACCOUNT_STATUS_EXCEPTION", "SYSTEM_ERROR", "ORDER_ID_INVALID" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundTransOrderQueryResponseModel" : { "type" : "object", "properties" : { "arrival_time_end" : { "type" : "string", "description" : "预计到账时间，转账到银行卡专用，格式为yyyy-MM-dd HH:mm:ss，转账受理失败不返回。\r\t 注意：\r\t此参数为预计时间，可能与实际到账时间有较大误差，不能作为实际到账时间使用，仅供参考用途。", "example" : "2013-01-01 08:08:08" }, "error_code" : { "type" : "string", "description" : "查询失败时，本参数为错误代 码。\r\t 查询成功不返回。 对于退票订单，不返回该参数。", "example" : "EXCEED_LIMIT_SM_AMOUNT" }, "fail_reason" : { "type" : "string", "description" : "查询到的订单状态为FAIL失败或REFUND退票时，返回具体的原因。", "example" : "单笔额度超限" }, "order_fee" : { "type" : "string", "description" : "预计收费金额（元），转账到银行卡专用，数字格式，精确到小数点后2位，转账失败或转账受理失败不返回。", "example" : "0.02" }, "order_id" : { "type" : "string", "description" : "支付宝转账单据号，查询失败不返回。", "example" : "20181225110070001502260000212207" }, "out_biz_no" : { "type" : "string", "description" : "发起转账来源方定义的转账单据号。 \r\t该参数的赋值均以查询结果中 的 out_biz_no 为准。 \r\t如果查询失败，不返回该参数。", "example" : "3142321423432" }, "pay_date" : { "type" : "string", "description" : "支付时间，格式为yyyy-MM-dd HH:mm:ss，转账失败不返回。", "example" : "2013-01-01 08:08:08" }, "status" : { "type" : "string", "description" : "转账单据状态。\r\t\tSUCCESS：成功（配合\"单笔转账到银行账户接口\"产品使用时, 同一笔单据多次查询有可能从成功变成退票状态）；\r\t\tFAIL：失败（具体失败原因请参见error_code以及fail_reason返回值）；\r\t\tINIT：等待处理；\r\t\tDEALING：处理中；\r\t\tREFUND：退票（仅配合\"单笔转账到银行账户接口\"产品使用时会涉及, 具体退票原因请参见fail_reason返回值）；\r\t\tUNKNOWN：状态未知。", "example" : "SUCCESS" } } }, "AlipayFundTransPayErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PRODUCT_NOT_SIGN", "NO_PERMISSION_ACCOUNT", "PAYMENT_TIME_EXPIRE", "PAYER_USERINFO_NOT_EXSIT", "PAYER_NOT_RELNAME_CERTIFY", "PAYER_NOT_EXIST", "PAYEE_NOT_EXIST", "PAYER_STATUS_ERROR", "PAYEE_ACCOUNT_STATUS_ERROR", "NO_ACCOUNT_RECEIVE_PERMISSION", "MEMO_REQUIRED_IN_TRANSFER_ERROR", "SYSTEM_ERROR", "PERMIT_NON_BANK_LIMIT_PAYEE", "PAYER_PAYEE_CANNOT_SAME", "REMARK_HAS_SENSITIVE_WORD", "PAYEE_ACCOUNT_NOT_EXSIT", "TRUSTEESHIP_RECIEVE_QUOTA_LIMIT", "EXCEED_LIMIT_SM_AMOUNT", "EXCEED_LIMIT_DM_AMOUNT", "REFUND_TIME_INVALID", "AUTH_CODE_ERROR", "PAYMENT_TIME_INVALID", "INVALID_PARAMETER", "MONEY_PAY_CLOSED", "USER_BALANCE_NOT_ENOUGH", "USER_BANKCARD_BALANCE_NOT_ENOUGH", "SECURITY_CHECK_FAILED", "PERMIT_CHECK_FAIL", "ORDER_PAY_SUCCESS", "NO_AVAILABLE_PAYMENT_TOOLS", "PAYMENT_INFO_INCONSISTENCY", "ORDER_STATUS_INVALID", "ORDER_PAY_SUCCESS_PAYEE_ERROR", "UNKNOWN_ERROR", "USER_BLOCKED", "ORDER_OTHER_PAY_SUCCESS", "TRUSTEESHIP_ACCOUNT_NOT_EXIST", "NO_ACCOUNT_PAYMENT_PERMISSION", "PAYMENT_FAIL", "AUTHOREE_IS_NOT_MATCH", "USER_AGREEMENT_STATUS_ABNORMAL", "USER_AGREEMENT_IS_OUT_OF_DATE", "USER_AGREEMENT_VERIFY_FAIL", "MERCHANT_AGREEMENT_VERIFY_FAIL", "RESOURCE_LIMIT_EXCEED", "INVALID_PAYEE_ACCOUNT", "PAYER_IS_NOT_SAME_PAYEE", "ILLEGAL_REQUEST_USER_ID", "FREEZE_AMOUNT_IS_NOT_ENOUGH", "AGREEMENT_SCENE_VERIFY_FAIL", "AUTH_USERID_IS_NOT_MATCH", "RELEASE_USER_FORBBIDEN_RECIEVE", "AMOUNT_COMPARE_INCONSISTENCY", "PAYEE_USERINFO_STATUS_ERROR", "PAYER_BALANCE_NOT_ENOUGH", "BIZ_UNIQUE_EXCEPTION", "BLOCK_USER_FORBBIDEN_RECIEVE", "NO_ACCOUNT_USER_FORBBIDEN_RECIEVE", "SUB_BIZ_SCENE_ERROR", "PAYER_NOT_ADMIT_ERROR", "PAYEE_CARD_INFO_ERROR", "PERM_AML_NOT_REALNAME_REV", "EXCEED_LIMIT_MM_AMOUNT", "CARD_BIN_ERROR", "INST_PAY_UNABLE", "PERMIT_CHECK_PERM_IDENTITY_THEFT", "BALANCE_IS_NOT_ENOUGH", "INVALID_CARDNO", "PAYEE_TRUSTEESHIP_ACC_OVER_LIMIT", "EXCEED_LIMIT_DC_RECEIVED", "PAYER_PERMLIMIT_CHECK_FAILURE", "PAYEE_ACC_OCUPIED", "PERMIT_CHECK_PERM_LIMITED", "EXCEED_LIMIT_DM_MAX_AMOUNT", "EXCEED_LIMIT_PERSONAL_SM_AMOUNT", "EXCEED_LIMIT_UNRN_DM_AMOUNT", "PAYEE_USER_TYPE_ERROR", "EXCEED_LIMIT_SM_MIN_AMOUNT", "PERMIT_CHECK_RECEIVE_LIMIT", "PAYEE_NOT_RELNAME_CERTIFY", "BANK_CARD_BALANCE_NOT_ENOUGH", "MAX_VISIT_LIMIT", "COMMON_RPC_ERROR", "MONTH_LIMIT_EXCEED", "DAILY_LIMIT_EXCEED", "PERM_RECEIVE_CUSTOMER_ALMS_LIMIT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundTransPayModel" : { "type" : "object", "properties" : { "auth_info" : { "$ref" : "#/components/schemas/AuthInfo" }, "biz_scene" : { "type" : "string", "description" : "业务场景，比如群收款、红包等", "example" : "PARTY_MEMBERSHIP_DUES" }, "business_params" : { "type" : "string", "description" : "JSON格式，传递业务扩展参数，使用前请与支付宝工程师联系！", "example" : "{\"MERCHANT_PAYER_ID\":\"1234567890\",\"MERCHANT_PAYER_PHONE:\"15012341234\"}" }, "order_title" : { "type" : "string", "description" : "订单的标题，用于在收银台和消费记录展示", "example" : "钉钉红包" }, "out_biz_no" : { "type" : "string", "description" : "商户端的唯一订单号，对于同一笔转账请求，商户需保证该订单号唯一。", "example" : "201806300001" }, "passback_params" : { "type" : "string", "description" : "回传参数，如果请求时传递了该参数，则异步通知商户时会回传该参数。", "example" : "{\"merchantBizType\":\"peerPay\"}" }, "payee_info" : { "$ref" : "#/components/schemas/Participant" }, "payer_info" : { "$ref" : "#/components/schemas/Participant" }, "product_code" : { "type" : "string", "description" : "销售产品码，商家和支付宝签约的产品码", "example" : "STD_APP_TRANSFER" }, "refund_time_expire" : { "type" : "string", "description" : "退款超时时间，格式yyyy-MM-dd HH:mm。到指定时间后，系统会自动触发退款，并原路退回到付款账户。如果指定了退款时间，必须早于销售方案里设置的最晚退款时间。", "example" : "2018-11-08 10:00" }, "remark" : { "type" : "string", "description" : "备注", "example" : "报销付款" }, "time_expire" : { "type" : "string", "description" : "绝对超时时间，格式为yyyy-MM-dd HH:mm", "example" : "2018-03-23 19:15" }, "trans_amount" : { "type" : "string", "description" : "订单总金额，单位为元，精确到小数点后两位，取值范围[0.01,100000000]", "example" : "8.88" } } }, "AlipayFundTransPayResponseModel" : { "type" : "object", "properties" : { "order_id" : { "type" : "string", "description" : "该笔转账在支付宝系统内部的单据ID", "example" : "20180629110070001502040007320562" }, "out_biz_no" : { "type" : "string", "description" : "商户端的唯一订单号", "example" : "201806300001" }, "pay_fund_order_id" : { "type" : "string", "description" : "支付宝支付资金流水号", "example" : "20190801110070001506380000251556" }, "status" : { "type" : "string", "description" : "SUCCESS：支付成功；\r\tFAIL：支付失败；\r\tUNKNOWN：未知；建议通过查询确认最新状态", "example" : "SUCCESS" }, "trans_pay_time" : { "type" : "string", "description" : "订单支付时间，格式为yyyy-MM-dd HH:mm:ss", "example" : "2019-08-21 00:00:00" } } }, "AlipayFundTransPayeeBindQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "NOT_IN_WHITE_LIST", "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundTransPayeeBindQueryResponseModel" : { "type" : "object", "properties" : { "bind" : { "type" : "string", "description" : "是否绑定收款账号。true：已绑定；false：未绑定", "example" : "true" } } }, "AlipayFundTransRefundErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "NO_ORDER_PERMISSION", "PRODUCT_NOT_ALLOW_REFUND", "ORDER_STATUS_ERROR", "REFUND_MONEY_NOT_ENOUGH", "REFUND_INFO_INCONSISTENCY", "ORDER_NOT_EXIST", "ORDER_STATUS_INVALID", "MAX_VISIT_LIMIT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundTransRefundModel" : { "type" : "object", "properties" : { "business_params" : { "type" : "string", "description" : "JSON格式，传递业务扩展参数，使用前请与支付宝工程师联系！", "example" : "{\"MERCHANT_PAYER_ID\":\"1234567890\",\"MERCHANT_PAYER_PHONE:\"15012341234\"}" }, "order_id" : { "type" : "string", "description" : "发红包时支付宝返回的支付宝订单号order_id。", "example" : "20190703110075000006530004756875" }, "out_request_no" : { "type" : "string", "description" : "标识一次资金退回请求，一笔资金退回失败后重新提交，要采用原来的资金退回单号。总退款金额不能超过用户实际支付金额。", "example" : "2018999960760005838333" }, "passback_params" : { "type" : "string", "description" : "公用回传参数，如果请求时传递了该参数，则异步通知商户时会回传该参数。", "example" : "{\"merchantBizType\":\"peerPay\"}" }, "refund_amount" : { "type" : "string", "description" : "需要退款的金额，该金额不能大于订单金额,单位为元，支持两位小数", "example" : "8.88" }, "remark" : { "type" : "string", "description" : "资金退回备注", "example" : "红包超时退回" } } }, "AlipayFundTransRefundResponseModel" : { "type" : "object", "properties" : { "order_id" : { "type" : "string", "description" : "发红包时支付宝返回的支付宝订单号order_id。", "example" : "20881030507841230156" }, "out_request_no" : { "type" : "string", "description" : "标识一次资金退回请求，一笔资金退回失败后重新提交，要采用原来的资金退回单号。总退款金额不能超过用户实际支付金额。", "example" : "2019063050784123" }, "refund_amount" : { "type" : "string", "description" : "本次退款的金额，单位为元，支持两位小数", "example" : "8.88" }, "refund_date" : { "type" : "string", "description" : "退款资金退回", "example" : "2019-01-01 08:08:08" }, "refund_order_id" : { "type" : "string", "description" : "退款的支付宝系统内部单据id", "example" : "2088000000300210312" }, "status" : { "type" : "string", "description" : "SUCCESS：退款成功", "example" : "SUCCESS" } } }, "AlipayFundTransToaccountTransferErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "EXCEED_LIMIT_SM_AMOUNT", "EXCEED_LIMIT_DM_AMOUNT", "PERMIT_CHECK_PERM_LIMITED", "PAYCARD_UNABLE_PAYMENT", "PAYEE_NOT_EXIST", "PAYER_DATA_INCOMPLETE", "PERM_AML_NOT_REALNAME_REV", "PAYER_STATUS_ERROR", "PAYEE_USER_INFO_ERROR", "PAYER_USER_INFO_ERROR", "PAYER_BALANCE_NOT_ENOUGH", "PAYMENT_INFO_INCONSISTENCY", "CERT_MISS_TRANS_LIMIT", "CERT_MISS_ACC_LIMIT", "PAYEE_ACC_OCUPIED", "MEMO_REQUIRED_IN_TRANSFER_ERROR", "PERMIT_NON_BANK_LIMIT_PAYEE", "PERMIT_PAYER_LOWEST_FORBIDDEN", "PERMIT_PAYER_FORBIDDEN", "PERMIT_CHECK_PERM_IDENTITY_THEFT", "REMARK_HAS_SENSITIVE_WORD", "ACCOUNT_NOT_EXIST", "PAYER_CERT_EXPIRED", "EXCEED_LIMIT_PERSONAL_SM_AMOUNT", "EXCEED_LIMIT_ENT_SM_AMOUNT", "EXCEED_LIMIT_SM_MIN_AMOUNT", "EXCEED_LIMIT_DM_MAX_AMOUNT", "EXCEED_LIMIT_UNRN_DM_AMOUNT", "PAYER_PAYEE_CANNOT_SAME", "SYNC_SECURITY_CHECK_FAILED", "MAX_VISIT_LIMIT", "RELEASE_USER_FORBBIDEN_RECIEVE", "PAYEE_USER_TYPE_ERROR", "BLOCK_USER_FORBBIDEN_RECIEVE", "REQUEST_PROCESSING", "EXCEED_LIMIT_MM_AMOUNT", "PERM_RECEIVE_CUSTOMER_ALMS_LIMIT", "PERM_PAY_CUSTOMER_MONTH_QUOTA_ORG_BALANCE_LIMIT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundTransToaccountTransferModel" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "转账金额，单位：元。\r\t只支持2位小数，小数点前最大支持13位，金额必须大于等于0.1元。 \r\t最大转账金额以实际签约的限额为准。", "example" : "12.23" }, "ext_param" : { "type" : "string", "description" : "扩展参数，json字符串格式，目前仅支持的key=order_title，表示收款方的转账账单标题，value可以根据自己的业务定制。", "example" : "{\"order_title\":\"兑奖红包\"}" }, "out_biz_no" : { "type" : "string", "description" : "商户转账唯一订单号。发起转账来源方定义的转账单据ID，用于将转账回执通知给来源方。\r\t不同来源方给出的ID可以重复，同一个来源方必须保证其ID的唯一性。\r\t只支持半角英文、数字，及“-”、“_”。", "example" : "3142321423432" }, "payee_account" : { "type" : "string", "description" : "收款方账户。与payee_type配合使用。付款方和收款方不能是同一个账户。", "example" : "abc@sina.com" }, "payee_real_name" : { "type" : "string", "description" : "收款方真实姓名（最长支持100个英文/50个汉字）。\r\t如果本参数不为空，则会校验该账户在支付宝登记的实名是否与收款方真实姓名一致。", "example" : "张三" }, "payee_type" : { "type" : "string", "description" : "收款方账户类型。可取值：\t1、ALIPAY_USERID：支付宝账号对应的支付宝唯一用户号。以2088开头的16位纯数字组成。\t2、ALIPAY_LOGONID：支付宝登录号，支持邮箱和手机号格式。\t2、ALIPAY_OPENID：支付宝openid", "example" : "ALIPAY_LOGONID" }, "payer_real_name" : { "type" : "string", "description" : "付款方真实姓名（最长支持100个英文/50个汉字）。\r\t如果本参数不为空，则会校验该账户在支付宝登记的实名是否与付款方真实姓名一致。", "example" : "上海交通卡公司" }, "payer_show_name" : { "type" : "string", "description" : "付款方姓名（最长支持100个英文/50个汉字）。显示在收款方的账单详情页。如果该字段不传，则默认显示付款方的支付宝认证姓名或单位名称。", "example" : "上海交通卡退款" }, "remark" : { "type" : "string", "description" : "转账备注（支持200个英文/100个汉字）。\r\t当付款方为企业账户，且转账金额达到（大于等于）50000元，remark不能为空。收款方可见，会展示在收款用户的收支详情中。", "example" : "转账备注" } } }, "AlipayFundTransToaccountTransferResponseModel" : { "type" : "object", "properties" : { "order_id" : { "type" : "string", "description" : "支付宝转账单据号，成功一定返回，失败可能不返回也可能返回。", "example" : "20160627110070001502260006780837" }, "out_biz_no" : { "type" : "string", "description" : "商户转账唯一订单号：发起转账来源方定义的转账单据号。请求时对应的参数，原样返回。", "example" : "3142321423432" }, "pay_date" : { "type" : "string", "description" : "支付时间：格式为yyyy-MM-dd HH:mm:ss，仅转账成功返回。", "example" : "2013-01-01 08:08:08" } } }, "AlipayFundTransUniTransferErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "EXCEED_LIMIT_SM_AMOUNT", "EXCEED_LIMIT_MM_AMOUNT", "PAYCARD_UNABLE_PAYMENT", "PAYER_STATUS_ERROR", "PAYER_CERTIFY_CHECK_FAIL", "PAYER_BALANCE_NOT_ENOUGH", "PAYER_USER_INFO_ERROR", "PAYMENT_INFO_INCONSISTENCY", "CARD_BIN_ERROR", "PAYEE_CARD_INFO_ERROR", "INST_PAY_UNABLE", "MEMO_REQUIRED_IN_TRANSFER_ERROR", "PERMIT_CHECK_PERM_IDENTITY_THEFT", "REMARK_HAS_SENSITIVE_WORD", "EXCEED_LIMIT_DM_AMOUNT", "NO_ACCOUNT_RECEIVE_PERMISSION", "BALANCE_IS_NOT_ENOUGH", "NO_ACCOUNT_PAYMENT_PERMISSION", "PAYER_NOT_EXIST", "PRODUCT_NOT_SIGN", "PAYMENT_TIME_EXPIRE", "PAYEE_NOT_EXIST", "PAYEE_ACCOUNT_STATUS_ERROR", "PERMIT_NON_BANK_LIMIT_PAYEE", "PAYEE_TRUSTEESHIP_ACC_OVER_LIMIT", "NO_PERMISSION_ACCOUNT", "TRUSTEESHIP_ACCOUNT_NOT_EXIST", "PAYEE_ACCOUNT_NOT_EXSIT", "ORDER_NOT_EXIST", "PAYEE_USERINFO_STATUS_ERROR", "PAYMENT_MONEY_NOT_ENOUGH", "TRUSTEESHIP_RECIEVE_QUOTA_LIMIT", "SECURITY_CHECK_FAILED", "NO_ORDER_PERMISSION", "ORDER_STATUS_INVALID", "PERM_AML_NOT_REALNAME_REV", "USER_AGREEMENT_VERIFY_FAIL", "PAYER_NOT_EQUAL_PAYEE_ERROR", "EXCEED_LIMIT_DC_RECEIVED", "PAYER_PERMLIMIT_CHECK_FAILURE", "PAYEE_ACC_OCUPIED", "PAYER_PAYEE_CANNOT_SAME", "PERMIT_CHECK_PERM_LIMITED", "RESOURCE_LIMIT_EXCEED", "INVALID_PAYER_ACCOUNT", "EXCEED_LIMIT_DM_MAX_AMOUNT", "EXCEED_LIMIT_PERSONAL_SM_AMOUNT", "EXCEED_LIMIT_UNRN_DM_AMOUNT", "INVALID_CARDNO", "RELEASE_USER_FORBBIDEN_RECIEVE", "PAYEE_USER_TYPE_ERROR", "EXCEED_LIMIT_SM_MIN_AMOUNT", "PERMIT_CHECK_RECEIVE_LIMIT", "NOT_IN_WHITE_LIST", "MONEY_PAY_CLOSED", "NO_AVAILABLE_PAYMENT_TOOLS", "PAYEE_NOT_RELNAME_CERTIFY", "OVERSEA_TRANSFER_CLOSE", "PAYMENT_FAIL", "ALREADY_WITHDRAW_STD_RED_PACKET", "BLOCK_USER_FORBBIDEN_RECIEVE", "REQUEST_PROCESSING", "USER_NOT_EXIST", "PARAM_ILLEGAL", "PROCESS_FAIL", "CURRENCY_NOT_SUPPORT", "PAYER_REQUESTER_RELATION_INVALID", "AUTHOREE_IS_NOT_MATCH", "NO_ACCOUNT_USER_FORBBIDEN_RECIEVE", "SIGN_INVALID", "SIGN_INVOKE_PID_INCONSISTENT", "SIGN_QUERY_APP_INFO_ERROR", "SIGN_QUERY_AGGREMENT_ERROR", "SIGN_AGREEMENT_NO_INCONSISTENT", "SIGN_PARAM_INVALID", "SIGN_NOT_ALLOW_SKIP", "EXCEED_LIMIT_ENT_SM_AMOUNT", "ISV_AUTH_ERROR", "PAYER_USERINFO_NOT_EXSIT", "BLOCK_USER_FORBBIDEN_SEND", "BANK_RESPONSE_ERROR", "BIZ_UNIQUE_EXCEPTION", "NO_ACCOUNTBOOK_PERMISSION", "PERMIT_CHECK_PERM_AML_CERT_EXPIRED", "MRCHPROD_QUERY_ERROR", "PERMIT_PAYER_FORBIDDEN", "IDENTITY_FUND_RELATION_NOT_FOUND", "INST_PAY_REMARK_UNVALID_CHARS", "PERMIT_LIMIT_PAYEE", "INVALID_TAX_BILL_AGREEMENT", "PAY_SALARY_MODE_NOT_SUPPORT", "CONTRACTOR_ACCOUNT_BOOK_NOT_FUND", "BANKCODE_OR_BRANCHNAME_INFO_ERROR", "PAYEE_OUT_PERMLIMIT_CHECK_FAILURE", "MID_ACCOUNT_STATUS_ERROR", "MID_ACCOUNT_TYPE_ERROR", "PAYEE_MID_CANNOT_SAME", "PAYER_MID_CANNOT_SAME", "MID_ACCOUNT_CHECK_ERROR", "PERM_PAY_USER_DAILY_QUOTA_ORG_BALANCE_LIMIT", "PERM_PAY_USER_MONTH_QUOTA_ORG_BALANCE_LIMIT", "PERM_PAY_CUSTOMER_DAILY_QUOTA_ORG_BALANCE_LIMIT", "PERM_PAY_CUSTOMER_MONTH_QUOTA_ORG_BALANCE_LIMIT", "NOT_SUPPORT_PAYER_ACCOUNT_TYPE", "EXCEED_LIMIT_MM_MAX_AMOUNT", "REP_INCONSISTENT", "ILLEGAL_OPERATION", "PERM_RECEIVE_CUSTOMER_ALMS_LIMIT", "PAYEE_IDENTITY_NOT_MATCH", "FLEXIBLE_STAFFING_RISK_CONSULT_UNSIGNED_MERCHANT", "FLEXIBLE_STAFFING_RISK_CONSULT_UNAUTHORIZED_CONSULT", "FLEXIBLE_STAFFING_RISK_CONSULT_USER_NOT_EXIST", "FLEXIBLE_STAFFING_RISK_CONSULT_RISK_RECEIVER", "PAYEE_USERINFO_ERROR", "FLEXIBLE_STAFFING_HIGH_RISK_RECEIVER", "FLEXIBLE_STAFFING_POTENTIAL_RISK_RECEIVER", "PAYER_ACCOUNT_BOOK_INFO_EXCEPTION", "RECEIVER_ACCOUNT_BOOK_INFO_EXCEPTION", "ACCOUNT_BOOK_SCENE_CODE_EXCEPTION", "TRUSTEESHIP_ACCOUNT_STATUS_ERROR", "PAYER_NOT_EQUAL_PAYEE_FOR_BIZ_SCENE_REQUIRED", "PERMIT_PAYER_LEVEL_FORBIDDEN", "FLEXIBLE_STAFFING_UN_KNOWN_RISK_RECEIVER", "JUDICIAL_FREEZE", "TRANS_AMOUNT_NOT_IN_PRIZE_LIMIT", "PROMO_CAMP_RELATION_CONFIG_MISSED", "PAYEE_RECEIVE_COUNT_EXCEED_LIMIT", "PROMO_TRANS_ORDER_DEALING", "FUND_PROTITOPN_NOT_MATCH", "FUND_WALLET_INST_NOT_EXIST", "FUND_WALLET_UNAVAILABLE", "PARTITION_FORMAT_ERROR", "CURREBT_AFTER_INVALID_TIME", "UNAUTHORIZED_CONSULT", "TAX_BILL_AGREEMENT_MISS", "FORBID_OPERATION_USER_WALLET", "USER_RISK_FREEZE", "BALANCE_NOT_ENOUGH_FOR_CARD_FEE", "TRANS_ORDER_DEALING", "PAYEE_USER_IS_INST", "PAYER_NOT_RELNAME_CERTIFY", "BALANCE_NOT_ENOUGH", "EMPLOYEE_SERVICE_NOT_EXIST", "UN_SUPPORT_EMPLOYEE_SERVICE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundTransUniTransferModel" : { "type" : "object", "properties" : { "biz_scene" : { "type" : "string", "description" : "描述特定的业务场景，可传的参数如下：\tDIRECT_TRANSFER：单笔无密转账到支付宝，B2C现金红包;\tPERSONAL_COLLECTION：C2C现金红包-领红包", "example" : "DIRECT_TRANSFER" }, "business_params" : { "type" : "string", "description" : "转账业务请求的扩展参数，支持传入的扩展参数如下：\tsub_biz_scene 子业务场景，红包业务必传，取值REDPACKET，C2C现金红包、B2C现金红包均需传入", "example" : "{\"sub_biz_scene\":\"REDPACKET\"}" }, "mutiple_currency_detail" : { "$ref" : "#/components/schemas/MutipleCurrencyDetail" }, "order_title" : { "type" : "string", "description" : "转账业务的标题，用于在支付宝用户的账单里显示", "example" : "转账标题" }, "original_order_id" : { "type" : "string", "description" : "原支付宝业务单号。C2C现金红包-红包领取时，传红包支付时返回的支付宝单号；B2C现金红包、单笔无密转账到支付宝不需要该参数。", "example" : "20190620110075000006640000063056" }, "out_biz_no" : { "type" : "string", "description" : "商家侧唯一订单号，由商家自定义。对于不同转账请求，商家需保证该订单号在自身系统唯一。", "example" : "201806300001" }, "passback_params" : { "type" : "string", "description" : "公用回传参数，如果请求时传递了该参数，则异步通知商户时会回传该参数。", "example" : "{\"merchantBizType\":\"peerPay\"}" }, "payee_info" : { "$ref" : "#/components/schemas/Participant" }, "payer_info" : { "$ref" : "#/components/schemas/Participant" }, "product_code" : { "type" : "string", "description" : "业务产品码，\t单笔无密转账到支付宝账户固定为:\tTRANS_ACCOUNT_NO_PWD；\t收发现金红包固定为:\tSTD_RED_PACKET；", "example" : "TRANS_ACCOUNT_NO_PWD" }, "remark" : { "type" : "string", "description" : "业务备注", "example" : "单笔转账" }, "sign_data" : { "$ref" : "#/components/schemas/SignData" }, "trans_amount" : { "type" : "string", "description" : "订单总金额，单位为元，精确到小数点后两位，STD_RED_PACKET产品取值范围[0.01,100000000]；\tTRANS_ACCOUNT_NO_PWD产品取值范围[0.1,100000000]", "example" : "23.00" } } }, "AlipayFundTransUniTransferResponseModel" : { "type" : "object", "properties" : { "order_id" : { "type" : "string", "description" : "支付宝转账订单号", "example" : "20190801110070000006380000250621" }, "out_biz_no" : { "type" : "string", "description" : "商户订单号", "example" : "201808080001" }, "pay_fund_order_id" : { "type" : "string", "description" : "支付宝支付资金流水号", "example" : "20190801110070001506380000251556" }, "status" : { "type" : "string", "description" : "转账单据状态。\tSUCCESS（该笔转账交易成功）：成功；\tFAIL：失败（具体失败原因请参见error_code以及fail_reason返回值）；\tDEALING：处理中（转账到支付宝账户不涉及）；\tREFUND：退票（转账到支付宝账户不涉及）；", "example" : "SUCCESS" }, "trans_date" : { "type" : "string", "description" : "订单支付时间，格式为yyyy-MM-dd HH:mm:ss", "example" : "2019-08-21 00:00:00" } } }, "AlipayFundUsertradeBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INNER_RPC_INVOKE_FAIL", "USER_UNAUTHORIZED", "CONFIG_ERROR", "MAX_VISIT_LIMIT", "AOP_SERVICE_UNAVAILABLE", "USER_INFO_VALIDATE_ERROR", "INVALID_PARAMETER", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayFundUsertradeBatchqueryModel" : { "type" : "object", "properties" : { "biz_scene" : { "type" : "string", "description" : "查询交易数据场景码", "example" : "BRAND_MARKET_PROMOTION" }, "end_time" : { "type" : "string", "description" : "拉取的结算时间，格式yyyy-MM-dd HH:mm:ss，拉取逻辑包含该时刻。", "example" : "2022-02-11 00:00:00" }, "page_index" : { "type" : "string", "description" : "分页页码，从1开始，必须大于0", "example" : "1" }, "page_size" : { "type" : "string", "description" : "分页大小，必须大于0，最大设置100", "example" : "100" }, "product_code" : { "type" : "string", "description" : "查询交易数据产品码", "example" : "MARKET_PROMOTION" }, "start_time" : { "type" : "string", "description" : "拉取的起始时间，格式yyyy-MM-dd HH:mm:ss，时间必须早于拉取的截止时间，并且，接口仅限查询用户30天内交易数据，拉取逻辑包含该时刻。", "example" : "2022-02-10 00:00:00" } } }, "AlipayFundUsertradeBatchqueryResponseModel" : { "type" : "object", "properties" : { "end_time" : { "type" : "string", "description" : "拉取的结束时间，格式yyyy-MM-dd HH:mm:ss", "example" : "2022-02-11 00:00:00" }, "has_next" : { "type" : "boolean", "description" : "是否有下一页", "example" : "true" }, "page_index" : { "type" : "string", "description" : "入参中的分页页码", "example" : "1" }, "page_size" : { "type" : "string", "description" : "入参中的分页大小", "example" : "100" }, "start_time" : { "type" : "string", "description" : "拉取的起始时间，格式yyyy-MM-dd HH:mm:ss", "example" : "2022-02-10 00:00:00" }, "total_count" : { "type" : "integer", "description" : "交易时间区间内的总交易数", "example" : "120" }, "trade_info_list" : { "type" : "array", "description" : "用户交易数据", "items" : { "$ref" : "#/components/schemas/UserTradeInfoDTO" } } } }, "AlipayIserviceCcmAgentCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "INTERNAL_ERROR", "TENENT_NOT_FOUND", "AGENT_CREATORID_IS_NULL", "AGENT_NICKNAME_IS_NULL", "AGENT_REALNAME_IS_NULL", "AGENT_JOBNUMBER_IS_NULL", "AGENT_USERCHANNEL_INVALID", "AGENT_EXTERNALUSERID_IS_NULL", "AGENT_ROLLIDS_IS_NULL", "AGENT_CCSINSTANCEIDS_IS_NULL", "INVALID_JOB_NUMBER", "DUPLICATE_JOB_NUMBER", "INVALID_HOTLINE_ANSWERING_MODE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmAgentCreateModel" : { "type" : "object", "properties" : { "answering_mode" : { "type" : "string", "description" : "热线接入方式，取值0，1，2", "example" : "0" }, "ccs_instance_ids" : { "type" : "array", "description" : "部门id列表", "items" : { "type" : "string" }, "example" : "[\"XAHSNRBS\"]" }, "chat_configs" : { "type" : "array", "description" : "在线技能组设置，技能组部门间隔离，此设置应与ccs_instance_ids对应", "items" : { "$ref" : "#/components/schemas/AgentChatInfo" } }, "creator_id" : { "type" : "string", "description" : "操作人客服id", "example" : "2019032101896769" }, "email" : { "type" : "string", "description" : "客服邮箱", "example" : "test@163.com" }, "external_user_id" : { "type" : "string", "description" : "客服账号id，当user_channel=ALIPAY时，external_user_id为支付宝账号id", "example" : "2088xxx" }, "hotline_configs" : { "type" : "array", "description" : "热线技能组设置，技能组部门间隔离，此设置应与ccs_instance_ids对应", "items" : { "$ref" : "#/components/schemas/AgentHotlineInfo" } }, "job_number" : { "type" : "string", "description" : "客服工号，新增后不可变更。4位数字，不可重复", "example" : "0002" }, "mobile" : { "type" : "string", "description" : "客服手机号", "example" : "13812345678" }, "nick_name" : { "type" : "string", "description" : "客服昵称", "example" : "风清扬" }, "real_name" : { "type" : "string", "description" : "客服姓名", "example" : "张三" }, "role_ids" : { "type" : "array", "description" : "角色id列表", "items" : { "$ref" : "#/components/schemas/RoleId" } }, "user_channel" : { "type" : "string", "description" : "客服账号渠道 ALIPAY:支付宝账号", "example" : "ALIPAY" } } }, "AlipayIserviceCcmAgentCreateResponseModel" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "CCM客服id", "example" : "2019032101896769" } } }, "AlipayIserviceCcmAgentDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "INTERNAL_ERROR", "TENENT_NOT_FOUND", "AGENT_NOT_EXISTS" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmAgentDeleteResponseModel" : { "type" : "object" }, "AlipayIserviceCcmAgentGetErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "AGENT_NOT_EXISTS", "INTERNAL_ERROR", "TENENT_NOT_FOUND" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmAgentGetResponseModel" : { "type" : "object", "properties" : { "answering_mode" : { "type" : "string", "description" : "热线接入方式： 0：话机 1：电脑耳机；2：webrtc", "example" : "0" }, "avatar" : { "type" : "string", "description" : "头像的oss file key", "example" : "12345" }, "ccs_instance_ids" : { "type" : "array", "description" : "客服关联的数据权限id列表", "items" : { "type" : "string" }, "example" : "ZPASFSCN,QWT_SADLD" }, "chat_config" : { "type" : "array", "description" : "客服在线信息", "items" : { "$ref" : "#/components/schemas/AgentChatInfo" } }, "create_time" : { "type" : "string", "description" : "创建时间，采用UTC时间，按照ISO8601标准表示，格式为：yyyy-MM-dd'T'HH:mm:ss'Z", "example" : "2020-07-15 17:58:27" }, "creator_id" : { "type" : "string", "description" : "创建人id", "example" : "246534573" }, "dingtalk_user_id" : { "type" : "string", "description" : "钉钉user_id", "example" : "1293894912" }, "email" : { "type" : "string", "description" : "邮箱", "example" : "abc@alipay.com" }, "external_id" : { "type" : "string", "description" : "外部系统用户id,比如：金融云的用户id", "example" : "112133" }, "hotline_config" : { "type" : "array", "description" : "客服热线信息", "items" : { "$ref" : "#/components/schemas/AgentHotlineInfo" } }, "id" : { "type" : "string", "description" : "客服id", "example" : "2018101801902073" }, "job_number" : { "type" : "string", "description" : "工号", "example" : "0001" }, "last_login_time" : { "type" : "string", "description" : "客服上次登录时间\t采用UTC时间，按照ISO8601标准表示，格式为：yyyy-MM-dd'T'HH:mm:ss'Z'", "example" : "2020-07-15 17:58:27" }, "mobile" : { "type" : "string", "description" : "手机号", "example" : "17712341234" }, "nick_name" : { "type" : "string", "description" : "客服昵称", "example" : "风清扬" }, "profile" : { "type" : "string", "description" : "个人简介", "example" : "我是玉树临风一表人才的张三" }, "real_name" : { "type" : "string", "description" : "客服姓名", "example" : "张三" }, "role_ids" : { "type" : "array", "description" : "角色id列表", "items" : { "$ref" : "#/components/schemas/RoleId" } }, "status" : { "type" : "string", "description" : "客服状态：NORMAL，DELETE", "example" : "NORMAL" }, "type" : { "type" : "string", "description" : "用户类型：NORMAL（普通客服），ADMIN（超级管理员，不能被删除）", "example" : "NORMAL" }, "update_time" : { "type" : "string", "description" : "最后修改时间，采用UTC时间，按照ISO8601标准表示，格式为：yyyy-MM-dd'T'HH:mm:ss'Z'", "example" : "2020-07-15 17:58:27" }, "updater_id" : { "type" : "string", "description" : "最后修改人id", "example" : "246534573" } } }, "AlipayIserviceCcmAgentModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "INTERNAL_ERROR", "TENENT_NOT_FOUND", "DUPLICATE_NICK_NAME", "INVALID_HOTLINE_ANSWERING_MODE", "AGENT_NOT_EXISTS" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmAgentModifyModel" : { "type" : "object", "properties" : { "answering_mode" : { "type" : "string", "description" : "热线接入方式，取值0，1，2", "example" : "0" }, "ccs_instance_ids" : { "type" : "array", "description" : "部门id列表", "items" : { "type" : "string" }, "example" : "[\"XAHSNRBS\"]" }, "chat_configs" : { "type" : "array", "description" : "在线技能组设置，技能组部门间隔离，此设置应与ccs_instance_ids对应", "items" : { "$ref" : "#/components/schemas/AgentChatInfo" } }, "email" : { "type" : "string", "description" : "客服邮箱", "example" : "test@163.com" }, "hotline_configs" : { "type" : "array", "description" : "热线技能组设置，技能组部门间隔离，此设置应与ccs_instance_ids对应", "items" : { "$ref" : "#/components/schemas/AgentHotlineInfo" } }, "id" : { "type" : "string", "description" : "客服id", "example" : "2019032101896769" }, "mobile" : { "type" : "string", "description" : "客服手机号", "example" : "13812345678" }, "nick_name" : { "type" : "string", "description" : "客服昵称", "example" : "风清扬" }, "real_name" : { "type" : "string", "description" : "客服姓名", "example" : "张三" }, "role_ids" : { "type" : "array", "description" : "客服角色id列表", "items" : { "$ref" : "#/components/schemas/RoleId" } }, "updater_id" : { "type" : "string", "description" : "操作人客服id", "example" : "2019032101896769" } } }, "AlipayIserviceCcmAgentModifyResponseModel" : { "type" : "object" }, "AlipayIserviceCcmAgentQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INTERNAL_ERROR", "TENENT_NOT_FOUND", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmAgentQueryModel" : { "type" : "object", "properties" : { "answering_mode" : { "type" : "string", "description" : "热线接入方式", "example" : "0" }, "ccs_instance_id" : { "type" : "string", "description" : "部门id", "example" : "XAHSNRBS" }, "chat_ext_group_ids" : { "type" : "array", "description" : "在线扩展技能组id", "items" : { "type" : "string" }, "example" : "[\"123\"]" }, "chat_group_ids" : { "type" : "array", "description" : "在线技能组id", "items" : { "type" : "string" }, "example" : "[\"123\"]" }, "chat_level_ids" : { "type" : "array", "description" : "在线服务等级", "items" : { "type" : "string" }, "example" : "[\"123\"]" }, "email" : { "type" : "string", "description" : "客服邮箱", "example" : "test@163.com" }, "hotline_group_ids" : { "type" : "array", "description" : "热线扩展技能组id", "items" : { "type" : "string" }, "example" : "[\"123\"]" }, "page_num" : { "type" : "integer", "description" : "查询结果的页码，起始值为 1，默认值为 1", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "分页查询时设置的每页记录数，最大值 100 行，默认为 10", "example" : "10" }, "real_name" : { "type" : "string", "description" : "客服姓名", "example" : "张三" }, "role_ids" : { "type" : "array", "description" : "客服角色id", "items" : { "type" : "string" }, "example" : "[\"123\"]" } } }, "AlipayIserviceCcmAgentQueryResponseModel" : { "type" : "object", "properties" : { "agents" : { "type" : "array", "description" : "客服列表", "items" : { "$ref" : "#/components/schemas/AgentVO" } }, "page_num" : { "type" : "integer", "description" : "查询结果的页码，起始值为 1，默认值为 1", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "分页查询时设置的每页记录数，最大值 100 行，默认为 10", "example" : "10" }, "total_count" : { "type" : "integer", "description" : "总条目数", "example" : "99" } } }, "AlipayIserviceCcmAgentSchedulelogQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMS", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmAgentSchedulelogQueryModel" : { "type" : "object", "properties" : { "agent_ids" : { "type" : "array", "description" : "客服id集合,限制最多100个id,不传查询部门下所有客服的状态变更流水日志", "items" : { "type" : "string" }, "example" : "[\"2018101801902073\",\"2018101801902090\"]" }, "ccs_instance_id" : { "type" : "string", "description" : "部门id（即租户实例ID、数据权限ID）", "example" : "kaj_9DA1" }, "end_time" : { "type" : "string", "description" : "客服状态变更结束时间,开始时间与结束时间间隔不能超过1天,采用UTC时间，按照ISO8601标准表示，格式为：yyyy-MM-dd'T'HH:mm:ss'Z'", "example" : "2020-10-24 00:00:00" }, "limit" : { "type" : "integer", "description" : "查询条数,最大100, 不传默认100", "example" : "100" }, "page_num" : { "type" : "integer", "description" : "查询结果的页码，起始值为 1，默认值为 1", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "分页查询时设置的每页记录数，最大值 100 行，默认为 100", "example" : "10" }, "start_id" : { "type" : "integer", "description" : "起始id,分页导出的起始客服状态变更流水id,第一页传0,翻页时传上一页结果的最大id", "example" : "10223" }, "start_time" : { "type" : "string", "description" : "客服状态变更开始时间,采用UTC时间，按照ISO8601标准表示，格式为：yyyy-MM-dd'T'HH:mm:ss'Z'", "example" : "2020-10-23 00:00:00" } } }, "AlipayIserviceCcmAgentSchedulelogQueryResponseModel" : { "type" : "object", "properties" : { "agent_schedule_logs" : { "$ref" : "#/components/schemas/AgentScheduleLog" }, "page_num" : { "type" : "integer", "description" : "查询结果的页码", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "分页查询时设置的每页记录数", "example" : "10" }, "total_count" : { "type" : "integer", "description" : "总条目数", "example" : "125" } } }, "AlipayIserviceCcmFunctionQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INTERNAL_ERROR", "TENENT_NOT_FOUND" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmFunctionQueryResponseModel" : { "type" : "object", "properties" : { "functions" : { "type" : "array", "description" : "功能点列表", "items" : { "$ref" : "#/components/schemas/Function" } } } }, "AlipayIserviceCcmInstanceCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "INTERNAL_ERROR", "TENENT_NOT_FOUND" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmInstanceCreateModel" : { "type" : "object", "properties" : { "creator_id" : { "type" : "string", "description" : "创建人id", "example" : "246534573" }, "description" : { "type" : "string", "description" : "租户实例（数据权限）描述信息", "example" : "我是租户实例（数据权限）描述" }, "external_id" : { "type" : "string", "description" : "外部id", "example" : "29488293" }, "name" : { "type" : "string", "description" : "租户实例（数据权限）名称，如果名称已经存在，将创建失败", "example" : "测试租户实例（数据权限）" } } }, "AlipayIserviceCcmInstanceCreateResponseModel" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "租户实例（数据权限）ID", "example" : "pYv_gs0m" } } }, "AlipayIserviceCcmInstanceGetErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "INTERNAL_ERROR", "TENENT_NOT_FOUND" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmInstanceGetResponseModel" : { "type" : "object", "properties" : { "create_time" : { "type" : "string", "description" : "创建时间", "example" : "2020-11-10 20:56:00" }, "creator_id" : { "type" : "string", "description" : "创建人id", "example" : "2018051101015016" }, "description" : { "type" : "string", "description" : "描述", "example" : "我是部门描述" }, "external_id" : { "type" : "string", "description" : "外部id", "example" : "392435002" }, "id" : { "type" : "string", "description" : "部门id（即租户实例ID、数据权限ID）", "example" : "pYv_gs0m" }, "name" : { "type" : "string", "description" : "租户实例（数据权限）名称", "example" : "XXX租户实例" }, "status" : { "type" : "string", "description" : "租户实例（数据权限）状态，所有可能的状态如下：INIT（初始化）、STARTED（准备完成）、START_FAILED（准备失败）、STOPPING（停用中）、STOPPED（已停用）、RELEASING（释放中）、RELEASED（已释放）、RESUMING（重新启动）、MODIFING（修改规格中）、DELETED（已删除）。", "example" : "STARTED" }, "update_time" : { "type" : "string", "description" : "最后修改时间", "example" : "2020-11-10 21:01:00" }, "updater_id" : { "type" : "string", "description" : "最后修改人id", "example" : "2018051101015016" } } }, "AlipayIserviceCcmInstanceQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INTERNAL_ERROR", "TENENT_NOT_FOUND" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmInstanceQueryResponseModel" : { "type" : "object", "properties" : { "instances" : { "type" : "array", "description" : "租户实例列表", "items" : { "$ref" : "#/components/schemas/Instance" } }, "page_num" : { "type" : "integer", "description" : "查询结果的页码", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "分页查询时设置的每页记录数", "example" : "10" }, "total_count" : { "type" : "integer", "description" : "总条目数", "example" : "100" } } }, "AlipayIserviceCcmIsvInitializeErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "PUBKEY_IMPORT_FAILED", "PUBKEY_HAS_EXIST", "CCM_KEY_GENERATE_FAILED", "INTERNAL_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmIsvInitializeModel" : { "type" : "object", "properties" : { "isv_pub_key" : { "type" : "string", "description" : "用于接入CCM iframe接口安全认证的 ISV 公钥，采用 base64 编码，秘钥对生成算法为 RSA2048。", "example" : "MIIBIjANBgkqhkiG9wxxxx" } } }, "AlipayIserviceCcmIsvInitializeResponseModel" : { "type" : "object", "properties" : { "ccm_pub_key" : { "type" : "string", "description" : "Base64编码CCM公钥：CCM公私钥对由CCM自动生成，用于Iframe spi接口安全认证", "example" : "MIIBIjANBgkqhkiG9w0BAQxxxx" } } }, "AlipayIserviceCcmOlsChatrecordQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmOlsChatrecordQueryResponseModel" : { "type" : "object", "properties" : { "agent_id" : { "type" : "string", "description" : "客服id", "example" : "2008123455" }, "agent_name" : { "type" : "string", "description" : "客服昵称", "example" : "客服003" }, "categories" : { "type" : "string", "description" : "多个层级类目信息", "example" : "[[{\\\"id\\\":111,\\\"name\\\":\\\"保险\\\"},{\\\"id\\\":122,\\\"name\\\":\\\"财保\\\"},{\\\"id\\\":133,\\\"name\\\":\\\"车险\\\"}],[{\\\"id\\\":211,\\\"name\\\":\\\"售后\\\"},{\\\"id\\\":222,\\\"name\\\":\\\"出险\\\"},{\\\"id\\\":233,\\\"name\\\":\\\"理赔\\\"}]]" }, "group_id" : { "type" : "string", "description" : "在线技能组id", "example" : "1" }, "group_name" : { "type" : "string", "description" : "在线技能组名称", "example" : "基础技能组" }, "memo" : { "type" : "string", "description" : "备注信息", "example" : "该问题可通过xx手段解决，请回复客户xxxxxx。" }, "messages" : { "type" : "array", "description" : "聊天消息列表", "items" : { "$ref" : "#/components/schemas/ChatMessage" } }, "satisfaction" : { "type" : "string", "description" : "满意度。 0：非常满意 1：满意 2：一般 3：不满意 4：非常不满意", "example" : "0" }, "status" : { "type" : "string", "description" : "服务记录状态。1：待处理 2：暂存 3：完结 4：废除 5：无效 6：未知", "example" : "1" }, "talk_duration" : { "type" : "integer", "description" : "在线服务时长，单位秒", "example" : "3600" }, "visitor_province" : { "type" : "string", "description" : "访客归属地", "example" : "浙江" } } }, "AlipayIserviceCcmRobotAvatarbaseQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmRobotAvatarbaseQueryModel" : { "type" : "object", "properties" : { "method_params" : { "type" : "string", "description" : "method_params:对应target_method请求方法的具体传参值k-v map", "example" : "{\"key1\":\"name\",}" }, "target_method" : { "type" : "string", "description" : "targetMethod；数字人目标方法调用", "example" : "init.json" }, "tenant_code" : { "type" : "string", "description" : "租户code&租户id，对于子部门客户需要上传子部门id", "example" : "bUC_Weh3" } } }, "AlipayIserviceCcmRobotAvatarbaseQueryResponseModel" : { "type" : "object", "properties" : { "result" : { "type" : "string", "description" : "result:方法调用返回值响应 k-v map", "example" : "{\"key1\":\"xxx\",\"key2\":\"xxxx\"}" } } }, "AlipayIserviceCcmRoleCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "DUPLICATE_ROLE", "INTERNAL_ERROR", "TENENT_NOT_FOUND" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmRoleCreateModel" : { "type" : "object", "properties" : { "ccs_instance_id" : { "type" : "string", "description" : "部门id（即租户实例ID、数据权限ID）", "example" : "jwa_8J2l" }, "creator_id" : { "type" : "string", "description" : "创建人id", "example" : "201835445454546" }, "description" : { "type" : "string", "description" : "角色描述信息", "example" : "我是角色描述..." }, "function_ids" : { "type" : "array", "description" : "角色关联额功能点id", "items" : { "type" : "string" }, "example" : "[\"123\",\"456\"]" }, "name" : { "type" : "string", "description" : "角色名", "example" : "保险类角色" } } }, "AlipayIserviceCcmRoleCreateResponseModel" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "角色id", "example" : "123" } } }, "AlipayIserviceCcmRoleDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INTERNAL_ERROR", "TENENT_NOT_FOUND" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmRoleDeleteResponseModel" : { "type" : "object" }, "AlipayIserviceCcmRoleGetErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ROLE_NOT_EXIST", "INTERNAL_ERROR", "TENENT_NOT_FOUND" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmRoleGetResponseModel" : { "type" : "object", "properties" : { "ccs_instance_id" : { "type" : "string", "description" : "部门id（即租户实例ID、数据权限ID）", "example" : "ZPASFSCN" }, "create_time" : { "type" : "string", "description" : "创建时间", "example" : "2020-11-10 21:52:00" }, "creator_id" : { "type" : "string", "description" : "创建人id", "example" : "201855445857455" }, "description" : { "type" : "string", "description" : "描述信息", "example" : "我是描述信息..." }, "function_ids" : { "type" : "array", "description" : "角色关联的功能点id", "items" : { "type" : "string" }, "example" : "[\"123\",\"456\"]" }, "id" : { "type" : "string", "description" : "角色id", "example" : "123" }, "name" : { "type" : "string", "description" : "角色名称", "example" : "XX角色" }, "update_time" : { "type" : "string", "description" : "最后修改时间", "example" : "2020-11-10 21:56:00" }, "updater_id" : { "type" : "string", "description" : "最后修改人id", "example" : "20185512254425" } } }, "AlipayIserviceCcmRoleModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ROLE_NOT_EXIST", "INTERNAL_ERROR", "TENENT_NOT_FOUND" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmRoleModifyModel" : { "type" : "object", "properties" : { "ccs_instance_id" : { "type" : "string", "description" : "部门id（即租户实例ID、数据权限ID），不传默认使用租户id", "example" : "alw_J1Ds" }, "description" : { "type" : "string", "description" : "描述信息", "example" : "我是角色描述" }, "function_ids" : { "type" : "array", "description" : "角色关联额功能点id", "items" : { "type" : "string" }, "example" : "[\"123\",\"456\"]" }, "id" : { "type" : "string", "description" : "角色id", "example" : "123" }, "updater_id" : { "type" : "string", "description" : "最后修改人id", "example" : "20181422342134" } } }, "AlipayIserviceCcmRoleModifyResponseModel" : { "type" : "object" }, "AlipayIserviceCcmRolePageQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "INTERNAL_ERROR", "TENENT_NOT_FOUND" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmRolePageQueryResponseModel" : { "type" : "object", "properties" : { "page_num" : { "type" : "integer", "description" : "查询结果的页码", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "分页查询时设置的每页记录数", "example" : "10" }, "roles" : { "type" : "array", "description" : "角色列表", "items" : { "$ref" : "#/components/schemas/Role" } }, "total_count" : { "type" : "integer", "description" : "总条目数", "example" : "125" } } }, "AlipayIserviceCcmServiceBuyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "TENENT_NOT_FOUND", "APP_NOT_INITIALIAZED", "SERVICE_NOT_INITIALIAZED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmServiceBuyModel" : { "type" : "object", "properties" : { "service_code" : { "type" : "string", "description" : "服务代码。通过alipay.iservice.ccm.service.initialize(isv服务初始化接口) 获取。", "example" : "testCode" } } }, "AlipayIserviceCcmServiceBuyResponseModel" : { "type" : "object", "properties" : { "service_instance_id" : { "type" : "integer", "description" : "服务实例id", "example" : "1" }, "tenant_id" : { "type" : "string", "description" : "商户在CCM的租户id", "example" : "qHT_sTlI" } } }, "AlipayIserviceCcmServiceCloseErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "TENENT_NOT_FOUND", "APP_NOT_INITIALIAZED", "SERVICE_NOT_INITIALIAZED", "SERVICE_NOT_OPEN" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmServiceCloseModel" : { "type" : "object", "properties" : { "service_code" : { "type" : "string", "description" : "服务代码。通过alipay.iservice.ccm.service.initialize(isv服务初始化接口) 获取。", "example" : "testCode" } } }, "AlipayIserviceCcmServiceCloseResponseModel" : { "type" : "object" }, "AlipayIserviceCcmServiceInitializeErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INTERNAL_ERROR", "INVALID_PARAMETER", "APP_NOT_INITIALIAZED", "SPI_KEY_UNDEFINED", "SERVICE_CODE_INVALID" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmServiceInitializeModel" : { "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "服务描述", "example" : "热线工作台" }, "icon" : { "type" : "string", "description" : "服务图标url。支持 http(s) 链接。", "example" : "http://127.0.0.1/" }, "service_code" : { "type" : "string", "description" : "服务编码。可在服务上架后，在服务市场上查询此信息。", "example" : "testCode" }, "service_name" : { "type" : "string", "description" : "服务名称。可在服务上架后，在服务市场上查询此信息。", "example" : "热线工作台" }, "service_order_url" : { "type" : "string", "description" : "服务订购二维码链接", "example" : "http://127.0.0.1/" }, "spis" : { "type" : "array", "description" : "spi定义列表", "items" : { "$ref" : "#/components/schemas/IsvSpiDefinition" } } } }, "AlipayIserviceCcmServiceInitializeResponseModel" : { "type" : "object", "properties" : { "spi_ids" : { "type" : "array", "description" : "spi在ccm中的唯一标识，与biz_code一一对应", "items" : { "$ref" : "#/components/schemas/SpiResult" } } } }, "AlipayIserviceCcmServicerecordCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmServicerecordCreateModel" : { "type" : "object", "properties" : { "acid" : { "type" : "string", "description" : "来电唯一标识", "example" : "CCC/2459691380492662222224097452" }, "aid" : { "type" : "string", "description" : "客服坐席号(软电话中定义的)", "example" : "20000105" }, "ani" : { "type" : "string", "description" : "主叫号码", "example" : "15123090087" }, "asid" : { "type" : "string", "description" : "恒生专用来电唯一标识", "example" : "29de02050ce1403db710a0b1f4daad6d" }, "category_list" : { "type" : "array", "description" : "类目信息(详细信息请参考具体类型描述)", "items" : { "$ref" : "#/components/schemas/ServiceRecordCatRequest" } }, "chat_begin_time" : { "type" : "string", "description" : "标准时间格式：yyyy-MM-dd HH:mm:ss", "example" : "2018-11-20 11:37:26" }, "chat_end_time" : { "type" : "string", "description" : "标准时间格式：yyyy-MM-dd HH:mm:ss", "example" : "2018-11-20 11:38:49" }, "city" : { "type" : "string", "description" : "来电地址", "example" : "山东" }, "creator_id" : { "type" : "string", "description" : "创建者ID", "example" : "2020042801917879" }, "discon_symbol" : { "type" : "string", "description" : "先挂断方\tAGENT:客服\tCUSTOMER:客户", "example" : "AGENT" }, "dnis" : { "type" : "string", "description" : "被叫号码", "example" : "15925998721" }, "file_size" : { "type" : "integer", "description" : "文件大小", "example" : "1222000" }, "gmt_create" : { "type" : "string", "description" : "创建时间(yyyy-MM-dd HH:mm:ss)", "example" : "2010-11-11 11:11:11" }, "gmt_modified" : { "type" : "string", "description" : "修改时间", "example" : "2010-11-11 11:11:11" }, "memo" : { "type" : "string", "description" : "服务记录备注信息", "example" : "亲，昨天已经寄给你了呢" }, "modifier_id" : { "type" : "string", "description" : "修改人ID", "example" : "2020042801917879" }, "outbound_task_id" : { "type" : "string", "description" : "外呼任务ID", "example" : "10.253.104.12_1d5d40fd-aa5e-4f23-9247-14cd28e125f2" }, "satisfaction" : { "type" : "string", "description" : "满意度\t0:非常满意\t1:满意\t2:一般\t3:不满意\t4:非常不满意", "example" : "0" }, "satisfaction_memo" : { "type" : "string", "description" : "满意度补充信息", "example" : "其它:非常不满意，完全都是我在自问自答;" }, "service_source" : { "type" : "string", "description" : "1:客户来电\t4:电话回访\t5:网点服务\t6:在线服务\t7:外呼任务\t8:手动外呼\t9:在线离线留言", "example" : "1" }, "service_time" : { "type" : "integer", "description" : "服务时长(单位:秒)", "example" : "1924" }, "skillgroup_id" : { "type" : "string", "description" : "技能组ID", "example" : "100000000001" }, "skillgroup_name" : { "type" : "string", "description" : "技能组名称(技能组ID对应的技能组名称)", "example" : "融资业务还款组" }, "tnt_inst_id" : { "type" : "string", "description" : "业务租户", "example" : "TTTKPICN" }, "user_id" : { "type" : "string", "description" : "来访用户唯一标识ID", "example" : "202007011113010526000000035332" }, "verify_result" : { "type" : "string", "description" : "IVR验证结果\tROLE_N:未定位到用户\tCERTNO_Y_PWD_Y:证件号码+交易密码验证通过\tCERTNO_Y_PWD_N:证件号码验证通过+交易密码不通过\tCERTNO_Y_PWD_UNKNOW:证件号码验证通过\tPHONE_Y_PWD_Y:来电手机+交易密码验证通过\tPHONE_Y_PWD_N:来电手机+交易密码未通过\tPHONE_Y_PWD_UNKNOW:来电手机账户\tSEARCH_Y_PWD_Y:搜索定位用户+推屏交易密码通过\tSEARCH_Y_PWD_N:搜索定位用户+推屏交易密码未通过\tSEARCH_Y_PWD_UNKNOW:搜索定位用户", "example" : "ROLE_N" } } }, "AlipayIserviceCcmServicerecordCreateResponseModel" : { "type" : "object", "properties" : { "service_record_id" : { "type" : "string", "description" : "服务记录ID", "example" : "201709271113010100000000000001" } } }, "AlipayIserviceCcmServicerecordModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SERVICE_RECORD_NOT_EXISIT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmServicerecordModifyModel" : { "type" : "object", "properties" : { "acid" : { "type" : "string", "description" : "来电唯一标识", "example" : "CCC/2459691380492662222224097452" }, "aid" : { "type" : "string", "description" : "客服坐席号(软电话中定义的)", "example" : "20000105" }, "ani" : { "type" : "string", "description" : "主叫号码", "example" : "15123090087" }, "asid" : { "type" : "string", "description" : "恒生专用来电唯一标识", "example" : "29de02050ce1403db710a0b1f4daad6d" }, "category_list" : { "$ref" : "#/components/schemas/ServiceRecordCatRequest" }, "chat_begin_time" : { "type" : "string", "description" : "标准时间格式：yyyy-MM-dd HH:mm:ss", "example" : "2018-11-20 11:37:26" }, "chat_end_time" : { "type" : "string", "description" : "标准时间格式：yyyy-MM-dd HH:mm:ss", "example" : "2018-11-20 11:38:49" }, "city" : { "type" : "string", "description" : "来电地址", "example" : "山东" }, "creator_id" : { "type" : "string", "description" : "创建者ID", "example" : "2020042801917879" }, "discon_symbol" : { "type" : "string", "description" : "先挂断方 AGENT:客服 CUSTOMER:客户", "example" : "AGENT" }, "dnis" : { "type" : "string", "description" : "被叫号码", "example" : "15925998721" }, "file_size" : { "type" : "integer", "description" : "文件大小", "example" : "1222000" }, "gmt_create" : { "type" : "string", "description" : "创建时间(yyyy-MM-dd HH:mm:ss)", "example" : "2010-11-11 11:11:11" }, "gmt_modified" : { "type" : "string", "description" : "修改时间", "example" : "2010-11-11 11:11:11" }, "id" : { "type" : "string", "description" : "云客服服务记录ID", "example" : "202011161113010100000000739715" }, "memo" : { "type" : "string", "description" : "服务记录备注信息", "example" : "亲，昨天已经寄给你了呢" }, "modifier_id" : { "type" : "string", "description" : "修改人ID", "example" : "2020042801917879" }, "outbound_task_id" : { "type" : "string", "description" : "外呼任务ID", "example" : "10.253.104.12_1d5d40fd-aa5e-4f23-9247-14cd28e125f2" }, "satisfaction" : { "type" : "string", "description" : "满意度 0:非常满意 1:满意 2:一般 3:不满意 4:非常不满意", "example" : "0" }, "satisfaction_memo" : { "type" : "string", "description" : "满意度补充信息", "example" : "其它:非常不满意，完全都是我在自问自答;" }, "service_source" : { "type" : "string", "description" : "1:客户来电 4:电话回访 5:网点服务 6:在线服务 7:外呼任务 8:手动外呼 9:在线离线留言", "example" : "1" }, "service_time" : { "type" : "integer", "description" : "服务时长(单位:秒)", "example" : "1924" }, "skillgroup_id" : { "type" : "string", "description" : "技能组ID", "example" : "100000000001" }, "skillgroup_name" : { "type" : "string", "description" : "技能组名称(技能组ID对应的技能组名称)", "example" : "融资业务还款组" }, "status" : { "type" : "string", "description" : "1:待处理\t2:暂存\t3:完结\t4:废除\t5:无效\t6:未知", "example" : "1" }, "tnt_inst_id" : { "type" : "string", "description" : "业务租户", "example" : "ORGJC1CN" }, "user_id" : { "type" : "string", "description" : "来访用户唯一标识ID", "example" : "202007011113010526000000035332" }, "verify_result" : { "type" : "string", "description" : "IVR验证结果 ROLE_N:未定位到用户 CERTNO_Y_PWD_Y:证件号码+交易密码验证通过 CERTNO_Y_PWD_N:证件号码验证通过+交易密码不通过 CERTNO_Y_PWD_UNKNOW:证件号码验证通过 PHONE_Y_PWD_Y:来电手机+交易密码验证通过 PHONE_Y_PWD_N:来电手机+交易密码未通过 PHONE_Y_PWD_UNKNOW:来电手机账户 SEARCH_Y_PWD_Y:搜索定位用户+推屏交易密码通过 SEARCH_Y_PWD_N:搜索定位用户+推屏交易密码未通过 SEARCH_Y_PWD_UNKNOW:搜索定位用户", "example" : "ROLE_N" } } }, "AlipayIserviceCcmServicerecordModifyResponseModel" : { "type" : "object" }, "AlipayIserviceCcmSwArticleBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmSwArticleBatchqueryModel" : { "type" : "object", "properties" : { "category_id" : { "type" : "integer", "description" : "所属类目ID，如果search_all_category为true则不用填", "example" : "12" }, "ccs_instance_id" : { "type" : "string", "description" : "子部门ID，不传为默认部门", "example" : "ZPNASDK" }, "end_time" : { "type" : "string", "description" : "结束时间，并且开始时间不能为空", "example" : "2020-12-31 23:59:59" }, "ids" : { "type" : "array", "description" : "文章ID集合", "items" : { "type" : "integer" }, "example" : "[1,12]" }, "keyword" : { "type" : "string", "description" : "关键字", "example" : "支付宝" }, "keywords" : { "type" : "array", "description" : "标签", "items" : { "type" : "string" }, "example" : "[\"关键\",\"核心\"]" }, "library_id" : { "type" : "integer", "description" : "知识库ID", "example" : "1" }, "page_num" : { "type" : "integer", "description" : "页数，page_size不能为空", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "页大小，page_num不能为空", "example" : "20" }, "search_all_category" : { "type" : "boolean", "description" : "是否搜索所有类目，如果为true则不用填写category_id值", "example" : "true" }, "search_category_type" : { "type" : "string", "description" : "Current（搜索当前节点）；\tChildren（搜索当前节点以及子节点）", "example" : "Current" }, "start_time" : { "type" : "string", "description" : "开始时间，并且结束时间不能为空", "example" : "2020-12-31 00:00:01" }, "status" : { "type" : "string", "description" : "状态，PUBLISHED（已发布），UNPUBLISH（未发布），EXPIRED（失效），DELETED（已删除）", "example" : "PUBLISHED" } } }, "AlipayIserviceCcmSwArticleBatchqueryResponseModel" : { "type" : "object", "properties" : { "articles" : { "type" : "array", "description" : "文章信息", "items" : { "$ref" : "#/components/schemas/ArticleInfo" } } } }, "AlipayIserviceCcmSwArticleCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmSwArticleCreateModel" : { "type" : "object", "properties" : { "category_id" : { "type" : "integer", "description" : "所属类目ID，如果search_all_category为true则不用填", "example" : "12" }, "ccs_instance_id" : { "type" : "string", "description" : "子部门ID，不传为默认部门", "example" : "ZPNASDK" }, "content" : { "type" : "string", "description" : "内容", "example" : "这是一个普通的内容文本" }, "extend_titles" : { "type" : "array", "description" : "扩展标题", "items" : { "type" : "string" }, "example" : "[\"支付宝\",\"知识库\"]" }, "keywords" : { "type" : "array", "description" : "标签", "items" : { "type" : "string" }, "example" : "[\"关键\",\"核心\"]" }, "library_id" : { "type" : "string", "description" : "知识库ID", "example" : "1" }, "scene_codes" : { "type" : "array", "description" : "场景ID。KNOWLEDGE（内部知识库）；ROBOT（机器人）;HELP（帮助中心）；WHELP（无线帮助中心）", "items" : { "type" : "string" }, "example" : "[\"KNOWLEDGE\",\"ROBOT\",\"HELP\",\"WHELP\"]" }, "title" : { "type" : "string", "description" : "标题", "example" : "这是一个普通的标题" } } }, "AlipayIserviceCcmSwArticleCreateResponseModel" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "文章ID", "example" : "1" } } }, "AlipayIserviceCcmSwArticleDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmSwArticleDeleteResponseModel" : { "type" : "object" }, "AlipayIserviceCcmSwArticleGetErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmSwArticleGetResponseModel" : { "type" : "object", "properties" : { "attachments" : { "type" : "array", "description" : "文章对应附件集合", "items" : { "$ref" : "#/components/schemas/ArticleAttachmentInfo" } }, "category_id" : { "type" : "integer", "description" : "所属类目ID", "example" : "12" }, "category_name_path" : { "type" : "string", "description" : "类目名称路径", "example" : "知识库-演示" }, "category_path" : { "type" : "array", "description" : "类目路径", "items" : { "$ref" : "#/components/schemas/ArticleCategoryInfo" } }, "content" : { "type" : "string", "description" : "内容", "example" : "我是文章内容" }, "create_time" : { "type" : "string", "description" : "创建时间", "example" : "2020-12-31 23:59:59" }, "creator_id" : { "type" : "string", "description" : "创建人", "example" : "10001" }, "extend_titles" : { "type" : "array", "description" : "扩展标题", "items" : { "type" : "string" }, "example" : "[\"支付宝\",\"知识库\"]" }, "id" : { "type" : "integer", "description" : "文章ID", "example" : "1" }, "keywords" : { "type" : "array", "description" : "标签", "items" : { "type" : "string" }, "example" : "[\"标签\"]" }, "library_id" : { "type" : "integer", "description" : "知识库ID", "example" : "1" }, "order_no" : { "type" : "integer", "description" : "排序值", "example" : "5" }, "pictures" : { "type" : "array", "description" : "文章对应图片集合", "items" : { "$ref" : "#/components/schemas/ArticleAttachmentInfo" } }, "publish_end" : { "type" : "string", "description" : "有效期止", "example" : "2022-06-11 16:14:58" }, "publish_start" : { "type" : "string", "description" : "有效期起始", "example" : "2020-06-11 16:14:58" }, "scene_codes" : { "type" : "array", "description" : "场景ID。1（内部知识库）；2（机器人）;3（帮助中心）；4（无线帮助中心）", "items" : { "type" : "string" }, "example" : "[\"1\",\"2\",\"3\",\"4\"]" }, "source" : { "type" : "string", "description" : "来源", "example" : "网关录入" }, "status" : { "type" : "string", "description" : "文章状态", "example" : "已发布" }, "status_code" : { "type" : "string", "description" : "文章状态码", "example" : "PUBLISHED" }, "title" : { "type" : "string", "description" : "标题", "example" : "我是文章标题" }, "update_time" : { "type" : "string", "description" : "修改时间", "example" : "2020-12-31 23:59:59" }, "updater_id" : { "type" : "string", "description" : "修改人", "example" : "10001" }, "updater_name" : { "type" : "string", "description" : "修改人名称", "example" : "admin" } } }, "AlipayIserviceCcmSwArticleModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmSwArticleModifyModel" : { "type" : "object", "properties" : { "category_id" : { "type" : "integer", "description" : "所属类目ID，如果search_all_category为true则不用填", "example" : "12" }, "ccs_instance_id" : { "type" : "string", "description" : "子部门ID，不传为默认部门", "example" : "ZPNASDK" }, "content" : { "type" : "string", "description" : "内容", "example" : "这是一个普通的内容文本" }, "extend_titles" : { "type" : "array", "description" : "扩展标题", "items" : { "type" : "string" }, "example" : "[\"支付宝\",\"知识库\"]" }, "id" : { "type" : "integer", "description" : "文章ID", "example" : "1" }, "keywords" : { "type" : "array", "description" : "标签", "items" : { "type" : "string" }, "example" : "[\"关键\",\"核心\"]" }, "scene_codes" : { "type" : "array", "description" : "场景ID。1（内部知识库）；2（机器人）;3（帮助中心）；4（无线帮助中心）", "items" : { "type" : "string" }, "example" : "[\"1\",\"2\",\"3\",\"4\"]" }, "title" : { "type" : "string", "description" : "标题", "example" : "这是一个普通的标题" } } }, "AlipayIserviceCcmSwArticleModifyResponseModel" : { "type" : "object" }, "AlipayIserviceCcmSwKnowledgeModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmSwKnowledgeModifyModel" : { "type" : "object", "properties" : { "category_id" : { "type" : "integer", "description" : "所属类目ID", "example" : "12" }, "category_name" : { "type" : "string", "description" : "知识点所属类目", "example" : "平板电脑" }, "content" : { "type" : "string", "description" : "知识点答案内容", "example" : "商品的发货地是广东佛山" }, "ext_id" : { "type" : "string", "description" : "外部知识点ID", "example" : "qa0002003004005006" }, "extend_titles" : { "type" : "array", "description" : "扩展标题（问法）", "items" : { "type" : "string" }, "example" : "[\"商品从哪里发货\"]" }, "icon" : { "type" : "string", "description" : "问答关联图片附件地址", "example" : "https://image.baidu.com/search/detail?ct=503316480&z=0" }, "id" : { "type" : "integer", "description" : "知识点ID", "example" : "123456" }, "is_delete" : { "type" : "boolean", "description" : "默认为false，为true且id非空时，表示删除知识点", "example" : "false" }, "is_searchable" : { "type" : "boolean", "description" : "是否被检索到，默认false，系统希望为true", "example" : "true" }, "library_id" : { "type" : "integer", "description" : "知识库ID", "example" : "23" }, "library_name" : { "type" : "string", "description" : "知识库名称", "example" : "商品知识库" }, "spu" : { "$ref" : "#/components/schemas/SpuDetail" }, "tags" : { "type" : "array", "description" : "以逗号分割的字符串列表", "items" : { "type" : "string" }, "example" : "[\"发货地\",\"发货点\"]" }, "title" : { "type" : "string", "description" : "知识点标题", "example" : "商品的发货地是哪里?" } } }, "AlipayIserviceCcmSwKnowledgeModifyResponseModel" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "知识点ID", "example" : "12345" } } }, "AlipayIserviceCcmSwLibraryBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmSwLibraryBatchqueryResponseModel" : { "type" : "object", "properties" : { "libraries" : { "type" : "array", "description" : "知识库集合", "items" : { "$ref" : "#/components/schemas/LibraryInfo" } } } }, "AlipayIserviceCcmSwLibraryCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmSwLibraryCreateModel" : { "type" : "object", "properties" : { "ccs_instance_id" : { "type" : "string", "description" : "子部门ID，不传为默认部门", "example" : "ZPNASDK" }, "instance_code" : { "type" : "string", "description" : "知识库对应的类目树名称，与treeId不可同时为空", "example" : "TREE_cVE_MHk8_1532332260914" }, "name" : { "type" : "string", "description" : "知识库名称", "example" : "商品库" }, "tree_id" : { "type" : "integer", "description" : "知识库对应的类目树Id，与instanceCode不可同时为空", "example" : "12" } } }, "AlipayIserviceCcmSwLibraryCreateResponseModel" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "知识库Id", "example" : "1" } } }, "AlipayIserviceCcmSwLibraryDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmSwLibraryDeleteResponseModel" : { "type" : "object" }, "AlipayIserviceCcmSwLibraryModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmSwLibraryModifyModel" : { "type" : "object", "properties" : { "ccs_instance_id" : { "type" : "string", "description" : "子部门ID，不传为默认部门", "example" : "ZPNASDK" }, "id" : { "type" : "string", "description" : "知识库Id", "example" : "1" }, "name" : { "type" : "string", "description" : "知识库名称", "example" : "商品库" } } }, "AlipayIserviceCcmSwLibraryModifyResponseModel" : { "type" : "object" }, "AlipayIserviceCcmSwOrderSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmSwOrderSyncModel" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "订单金额", "example" : "12234.33" }, "link_url" : { "type" : "string", "description" : "订单链接", "example" : "http://taobao.com/order/1214134234" }, "logistic_count" : { "type" : "integer", "description" : "订单物流数量", "example" : "1" }, "logistics" : { "type" : "array", "description" : "物流信息列表", "items" : { "$ref" : "#/components/schemas/LogisticInfo" } }, "order_create_time" : { "type" : "string", "description" : "订单创建时间", "example" : "2022-04-04 09:09:09" }, "order_id" : { "type" : "string", "description" : "订单id", "example" : "123121414" }, "order_type" : { "type" : "string", "description" : "普通订单：NORMAL\t预售订单：PRE_SALE", "example" : "NORMAL" }, "spu_count" : { "type" : "integer", "description" : "订单商品种类", "example" : "1" }, "spus" : { "type" : "array", "description" : "订单商品信息", "items" : { "$ref" : "#/components/schemas/SpuInfo" } }, "status" : { "type" : "string", "description" : "订单状态，目前支持以下几种状态\t下单未支付\tWAIT_PAY\t支付未发货\tPAIED\t已发货\tIN_DELIVERY\t售后中\tIN_AFTER_SALE\t订单完成\tFINISHED", "example" : "WAIT_PAY" }, "sub_status" : { "type" : "string", "description" : "订单子状态", "example" : "SIGNED" }, "user_id" : { "type" : "string", "description" : "下单用户id(外部系统ID)", "example" : "90932423423" } } }, "AlipayIserviceCcmSwOrderSyncResponseModel" : { "type" : "object", "properties" : { "order_id" : { "type" : "string", "description" : "订单id", "example" : "124121453" } } }, "AlipayIserviceCcmSwSpuSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmSwSpuSyncModel" : { "type" : "object", "properties" : { "attribute" : { "type" : "array", "description" : "商品属性列表", "items" : { "$ref" : "#/components/schemas/SpuAttribute" } }, "brand" : { "type" : "string", "description" : "商品品牌", "example" : "米其林" }, "category" : { "type" : "string", "description" : "商品类目，用于商品库中分类", "example" : "美妆" }, "description" : { "type" : "string", "description" : "商品描述", "example" : "商品质量符合XX标准，支持7天无理由退换" }, "icon" : { "type" : "string", "description" : "商品图片链接\t特殊可选规则：is_delete=false的情况下必填", "example" : "https://image.baidu.com/search/detail?ct=503316480&z=0&ipn=d" }, "is_delete" : { "type" : "string", "description" : "默认为false，为true，表示删除知识点", "example" : "false" }, "library_id" : { "type" : "integer", "description" : "知识库id", "example" : "23" }, "library_name" : { "type" : "string", "description" : "知识库名称", "example" : "商品知识库" }, "link_url" : { "type" : "string", "description" : "商品链接\t特殊可选规则：is_delete=false的情况下必填", "example" : "https://detail.tmall.com/item.htm?id=530187047412&ali_trackid=2:mm_26632614_0_0:1603785697_244_935652742" }, "original_price" : { "type" : "string", "description" : "商品原价", "example" : "123.58" }, "price" : { "type" : "string", "description" : "商品售价\t特殊可选规则：is_delete=false的情况下必填", "example" : "99.99" }, "spu_id" : { "type" : "string", "description" : "商品ID", "example" : "spu1212391923" }, "status" : { "type" : "string", "description" : "商品状态：AVAILABLE 表示可售卖,SOLD_OUT为售罄/不可卖，默认可售卖", "example" : "AVAILABLE" }, "title" : { "type" : "string", "description" : "商品名称\t特殊可选规则：is_delete=false的情况下必填", "example" : "汽车盲点BSD并线辅助系统盲点监测变道后视镜盲区监控雷达预警" } } }, "AlipayIserviceCcmSwSpuSyncResponseModel" : { "type" : "object", "properties" : { "spu_id" : { "type" : "string", "description" : "商品id", "example" : "spu12434234234" } } }, "AlipayIserviceCcmSwTreeBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmSwTreeBatchqueryResponseModel" : { "type" : "object", "properties" : { "trees" : { "type" : "array", "description" : "类目集合", "items" : { "$ref" : "#/components/schemas/TreeInfo" } } } }, "AlipayIserviceCcmSwTreeCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmSwTreeCreateModel" : { "type" : "object", "properties" : { "ccs_instance_id" : { "type" : "string", "description" : "子部门ID，不传为默认部门", "example" : "ZPNASDK" }, "name" : { "type" : "string", "description" : "类目名称", "example" : "蚂蚁科技" } } }, "AlipayIserviceCcmSwTreeCreateResponseModel" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "类目ID", "example" : "1" } } }, "AlipayIserviceCcmSwTreeDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmSwTreeDeleteResponseModel" : { "type" : "object" }, "AlipayIserviceCcmSwTreeGetErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmSwTreeGetResponseModel" : { "type" : "object", "properties" : { "tree" : { "type" : "string", "description" : "类目树字符串", "example" : "{\"description\":\"\",\"fatherId\":0,\"id\":47250,\"name\":\"OpenAPI测试\",\"tags\":[\"KNOWLEDGE\",\"HELP\",\"PLATFORM\"]}" } } }, "AlipayIserviceCcmSwTreeModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmSwTreeModifyModel" : { "type" : "object", "properties" : { "ccs_instance_id" : { "type" : "string", "description" : "子部门ID，不传为默认部门", "example" : "ZPNASDK" }, "id" : { "type" : "integer", "description" : "类目ID", "example" : "1" }, "name" : { "type" : "string", "description" : "类目名称", "example" : "蚂蚁科技" } } }, "AlipayIserviceCcmSwTreeModifyResponseModel" : { "type" : "object" }, "AlipayIserviceCcmSwTreePublishErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmSwTreePublishModel" : { "type" : "object", "properties" : { "ccs_instance_id" : { "type" : "string", "description" : "子部门ID，不传为默认部门", "example" : "ZPNASDK" }, "id" : { "type" : "integer", "description" : "类目ID", "example" : "1" } } }, "AlipayIserviceCcmSwTreePublishResponseModel" : { "type" : "object" }, "AlipayIserviceCcmSwTreecategoryBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmSwTreecategoryBatchqueryResponseModel" : { "type" : "object", "properties" : { "categories" : { "type" : "array", "description" : "节点集合", "items" : { "$ref" : "#/components/schemas/ArticleCategoryInfo" } }, "page_num" : { "type" : "integer", "description" : "页数", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "页显示大小", "example" : "10" }, "total_count" : { "type" : "integer", "description" : "总行数", "example" : "1" } } }, "AlipayIserviceCcmSwTreecategoryCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmSwTreecategoryCreateModel" : { "type" : "object", "properties" : { "ccs_instance_id" : { "type" : "string", "description" : "子部门ID，不传为默认部门", "example" : "ZPNASDK" }, "description" : { "type" : "string", "description" : "描述", "example" : "这是一段描述" }, "father_id" : { "type" : "integer", "description" : "父节点ID", "example" : "12" }, "name" : { "type" : "string", "description" : "节点名称", "example" : "服务群" }, "tags" : { "type" : "array", "description" : "标签。KNOWLEDGE（知识库）；PLATFORM（公有云工作台）；HELP（公有云帮助中心）", "items" : { "type" : "string" }, "example" : "[\"KNOWLEDGE\",\"PLATFORM\",\"HELP\"]" } } }, "AlipayIserviceCcmSwTreecategoryCreateResponseModel" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "节点ID", "example" : "1" } } }, "AlipayIserviceCcmSwTreecategoryDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmSwTreecategoryDeleteResponseModel" : { "type" : "object" }, "AlipayIserviceCcmSwTreecategoryModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayIserviceCcmSwTreecategoryModifyModel" : { "type" : "object", "properties" : { "ccs_instance_id" : { "type" : "string", "description" : "子部门ID，不传为默认部门", "example" : "ZPNASDK" }, "description" : { "type" : "string", "description" : "描述", "example" : "这是一段描述" }, "father_id" : { "type" : "string", "description" : "父节点ID", "example" : "12" }, "id" : { "type" : "integer", "description" : "节点ID", "example" : "1" }, "name" : { "type" : "string", "description" : "节点名称", "example" : "服务群" }, "tags" : { "type" : "string", "description" : "标签。KNOWLEDGE（知识库）；PLATFORM（公有云工作台）；HELP（公有云帮助中心）", "example" : "[\"KNOWLEDGE\",\"PLATFORM\",\"HELP\"]" } } }, "AlipayIserviceCcmSwTreecategoryModifyResponseModel" : { "type" : "object" }, "AlipayMarketingActivityAppBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityAppBatchqueryResponseModel" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "活动id", "example" : "2016042700826004508401111111" }, "app_infos" : { "type" : "array", "description" : "可用小程序列表", "items" : { "$ref" : "#/components/schemas/ActivityAppInfo" } }, "page_num" : { "type" : "integer", "description" : "分页查询页码。", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "分页查询单页数据条数。", "example" : "20" }, "total_size" : { "type" : "integer", "description" : "可用小程序总数量", "example" : "200" } } }, "AlipayMarketingActivityBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityBatchqueryModel" : { "type" : "object", "properties" : { "activity_status" : { "type" : "string", "description" : "活动状态 。 ACTIVE:活动已激活，表示活动已经生效，等到活动开始(publish_start_time)之后用户就可以参与活动。 PAUSE:活动已暂停，表示商户临时暂停该活动，该状态下用户不能参与活动。", "example" : "ACTIVE" }, "merchant_access_mode" : { "type" : "string", "description" : "商户接入模式。", "example" : "AGENCY_MODE" }, "merchant_id" : { "type" : "string", "description" : "商户PID,默认为当前接口调用商户。", "example" : "2088202967380463" }, "page_num" : { "type" : "integer", "description" : "分页查询页码。", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "分页查询单页数据条数。", "example" : "20" } } }, "AlipayMarketingActivityBatchqueryResponseModel" : { "type" : "object", "properties" : { "activity_lite_infos" : { "type" : "array", "description" : "活动摘要信息", "items" : { "$ref" : "#/components/schemas/ActivityLiteInfo" } }, "page_num" : { "type" : "integer", "description" : "分页查询页码。", "example" : "2" }, "page_size" : { "type" : "integer", "description" : "分页查询单页数据条数。", "example" : "20" }, "total_size" : { "type" : "string", "description" : "经过条件筛选，查询到的活动总数量", "example" : "200" } } }, "AlipayMarketingActivityConsultErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityConsultModel" : { "type" : "object", "properties" : { "consult_activity_info_list" : { "type" : "array", "description" : "待咨询的活动信息列表", "items" : { "$ref" : "#/components/schemas/ConsultActivityInfo" } }, "merchant_access_mode" : { "type" : "string", "description" : "商户接入模式", "example" : "AGENCY_MODE" }, "merchant_id" : { "type" : "string", "description" : "商户PID,默认为当前接口调用商户 \t限制: \t接口调用者必须有商户代运营权限。 \t\t代运营授权流程https://opendocs.alipay.com/mini/01hm6i#%E4%BB%A3%E8%BF%90%E8%90%A5%E6%8E%88%E6%9D%83", "example" : "2088102111111111" }, "open_id" : { "type" : "string", "description" : "领券的用户openId", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "user_id" : { "type" : "string", "description" : "领券的用户uid", "example" : "2088xxxx" } } }, "AlipayMarketingActivityConsultResponseModel" : { "type" : "object", "properties" : { "consult_result_info_list" : { "type" : "array", "description" : "咨询后的活动结果信息", "items" : { "$ref" : "#/components/schemas/ConsultActivityResultInfo" } }, "open_id" : { "type" : "string", "description" : "领券的用户openId", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "user_id" : { "type" : "string", "description" : "领券的用户uid", "example" : "2088xxxxx" } } }, "AlipayMarketingActivityDeliveryCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityDeliveryCreateModel" : { "type" : "object", "properties" : { "belong_merchant_info" : { "$ref" : "#/components/schemas/DeliveryAgencyMerchantInfo" }, "delivery_base_info" : { "$ref" : "#/components/schemas/DeliveryBaseInfo" }, "delivery_booth_code" : { "type" : "string", "description" : "投放的展位编码。", "example" : "PUBLIC_UNION" }, "delivery_config_list" : { "type" : "array", "description" : "[已废弃]\t待创建的投放配置列表。\t最大数量限制20个。", "items" : { "$ref" : "#/components/schemas/DeliveryConfig" } }, "delivery_play_config" : { "$ref" : "#/components/schemas/DeliveryPlayConfig" }, "delivery_target_rule" : { "$ref" : "#/components/schemas/DeliveryTargetRule" }, "merchant_access_mode" : { "type" : "string", "description" : "商户接入模式\t\t枚举值\tSELF_MODE 商户自接入模式\tAGENCY_MODE 服务商代接入模式", "example" : "SELF_MODE" }, "out_biz_no" : { "type" : "string", "description" : "外部业务单号，用作幂等控制。 幂等作用：请求返回与上一次相同的结果。 外部接入方需保证业务单号唯一。", "example" : "20170101000001654bb46ba" } } }, "AlipayMarketingActivityDeliveryCreateResponseModel" : { "type" : "object", "properties" : { "delivery_guide_preview_url" : { "type" : "string", "description" : "预览链接。\t可用于预览用户在承接页面领券的流程。", "example" : "alipays://platformapi/startapp?appId=xxxx" }, "delivery_id" : { "type" : "string", "description" : "投放计划id。", "example" : "20121231231242353" }, "error_delivery_config_list" : { "type" : "array", "description" : "[已废弃]\t创建失败的投放信息列表\t\t失败的投放配置列表中，会返回对应的deliveryConfig对象。", "items" : { "$ref" : "#/components/schemas/ErrorDeliveryConfig" } }, "success_delivery_config_list" : { "type" : "array", "description" : "[已废弃]\t创建成功的投放信息列表\t\t成功的投放配置列表中，会返回对应的deliveryConfig对象。", "items" : { "$ref" : "#/components/schemas/SuccessDeliveryConfig" } } } }, "AlipayMarketingActivityDeliveryQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "BIZ_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityDeliveryQueryModel" : { "type" : "object", "properties" : { "belong_merchant_info" : { "$ref" : "#/components/schemas/DeliveryAgencyMerchantInfo" }, "delivery_config_list" : { "type" : "array", "description" : "[已废弃]\t待查询的投放配置列表。\t最大数量限制20个。", "items" : { "$ref" : "#/components/schemas/DeliveryConfig" } }, "merchant_access_mode" : { "type" : "string", "description" : "商户接入模式\t\t枚举值\tSELF_MODE 商户自接入模式\tAGENCY_MODE 服务商代接入模式", "example" : "SELF_MODE" } } }, "AlipayMarketingActivityDeliveryQueryResponseModel" : { "type" : "object", "properties" : { "delivery_base_info" : { "$ref" : "#/components/schemas/DeliveryBaseInfo" }, "delivery_booth_code" : { "type" : "string", "description" : "运营计划的展位编码。 枚举值： SERVICE_MESSAGE：商家消息（包含订单、订阅、其他消息）", "example" : "SERVICE_MESSAGE" }, "delivery_error_msg" : { "type" : "string", "description" : "投放计划错误信息描述，如投放计划审核失败时为审核失败原因。", "example" : "素材审核失败：素材存在敏感信息。" }, "delivery_id" : { "type" : "string", "description" : "投放计划id", "example" : "20121231231242353" }, "delivery_info_list" : { "type" : "array", "description" : "[已废弃]\t投放信息列表", "items" : { "$ref" : "#/components/schemas/PromoDeliveryInfo" } }, "delivery_play_config" : { "$ref" : "#/components/schemas/DeliveryPlayConfig" }, "delivery_status" : { "type" : "string", "description" : "投放计划状态。 枚举值： ACTIVE：生效中 INACTIVE：失效状态 AUDITING：审核中 AUDIT_NO_PASS：审核不通过。", "example" : "ACTIVE" }, "delivery_target_rule" : { "$ref" : "#/components/schemas/DeliveryTargetRule" } } }, "AlipayMarketingActivityDeliveryStopErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityDeliveryStopModel" : { "type" : "object", "properties" : { "belong_merchant_info" : { "$ref" : "#/components/schemas/DeliveryAgencyMerchantInfo" }, "delivery_config_list" : { "type" : "array", "description" : "[已废弃]\t待停止的投放配置列表。\t最大数量限制20个。", "items" : { "$ref" : "#/components/schemas/DeliveryConfig" } }, "merchant_access_mode" : { "type" : "string", "description" : "商户接入模式\t\t枚举值\tSELF_MODE 商户自接入模式\tAGENCY_MODE 服务商代接入模式", "example" : "SELF_MODE" }, "out_biz_no" : { "type" : "string", "description" : "外部业务单号，用作幂等控制。 幂等作用： 再次请求返回与上一次相同的结果。 外部接入方需保证业务单号唯一。", "example" : "20170101000001654bb46ba" } } }, "AlipayMarketingActivityDeliveryStopResponseModel" : { "type" : "object", "properties" : { "delivery_id" : { "type" : "string", "description" : "推广计划id。", "example" : "20121231231242353" }, "error_delivery_config_list" : { "type" : "array", "description" : "[已废弃]\t停止失败的投放配置列表", "items" : { "$ref" : "#/components/schemas/ErrorDeliveryConfig" } }, "success_delivery_config_list" : { "type" : "array", "description" : "[已废弃]\t停止成功的投放配置列表", "items" : { "$ref" : "#/components/schemas/SuccessDeliveryConfig" } } } }, "AlipayMarketingActivityDeliverychannelQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "BIZ_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityDeliverychannelQueryModel" : { "type" : "object", "properties" : { "belong_merchant_info" : { "$ref" : "#/components/schemas/DeliveryAgencyMerchantInfo" }, "booth_code" : { "type" : "string", "description" : "展位码。\t\tboothCode含义：boothCode表达的是某个渠道可以投放的展位码。例如：支付结果页PAY_RESULT\t\t枚举值：\tPAY_RESULT：支付结果页。\t\t后续新增可投放的展位后，会在文档中新增描述信息", "example" : "PAY_RESULT" }, "page_num" : { "type" : "integer", "description" : "查询的页码。\t\t特别说明：\t页码从1开始。", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "每页查询的个数，最大值为 100。", "example" : "2" } } }, "AlipayMarketingActivityDeliverychannelQueryResponseModel" : { "type" : "object", "properties" : { "delivery_channel_info_list" : { "type" : "array", "description" : "可投放的渠道信息列表。\t用于表达当前可以投放的渠道列表信息", "items" : { "$ref" : "#/components/schemas/DeliveryChannelInfo" } }, "page_num" : { "type" : "string", "description" : "查询的页码。 特别说明： 页码从1开始。", "example" : "1" }, "page_size" : { "type" : "string", "description" : "每页查询个数", "example" : "2" }, "total_size" : { "type" : "string", "description" : "可返回的渠道总数", "example" : "6" } } }, "AlipayMarketingActivityGoodsBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityGoodsBatchqueryResponseModel" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "活动id", "example" : "2016042700826004508401111111" }, "goods_infos" : { "type" : "array", "description" : "商品编码列表", "items" : { "$ref" : "#/components/schemas/ActivityGoodsInfo" } }, "page_num" : { "type" : "integer", "description" : "分页查询页码。", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "分页查询单页数据条数。", "example" : "20" }, "total_size" : { "type" : "integer", "description" : "商品编码总数量", "example" : "200" } } }, "AlipayMarketingActivityMerchantBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityMerchantBatchqueryResponseModel" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "活动id", "example" : "2016042700826004508401111111" }, "merchant_infos" : { "type" : "array", "description" : "可用商户列表", "items" : { "$ref" : "#/components/schemas/ActivityMerchantInfo" } }, "page_num" : { "type" : "integer", "description" : "分页查询页码。", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "分页查询单页数据条数。", "example" : "20" }, "total_size" : { "type" : "integer", "description" : "可用商户总数量", "example" : "200" } } }, "AlipayMarketingActivityOrdervoucherAppendErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityOrdervoucherAppendModel" : { "type" : "object", "properties" : { "merchant_access_mode" : { "type" : "string", "description" : "商户接入模式\t\t枚举值\tSELF_MODE 商户自接入模式\tAGENCY_MODE 服务商代接入模式", "example" : "SELF_MODE" }, "out_biz_no" : { "type" : "string", "description" : "外部业务单号，用作幂等控制。\t\t幂等作用：\t参数不变的情况下，再次请求返回与上一次相同的结果。\t\t外部接入方需保证业务单号唯一。", "example" : "20170101000001654bb46ba" }, "voucher_quantity" : { "type" : "integer", "description" : "券总预算值。\t\t限制：\t券总预算<= 999999\t\t特别说明：\t该字段的含义是追加到的数量。\t不可减少，只能增加。\t\tcode_mode=\tMERCHANT_UPLOAD 的情况下，voucher_quantity 需要与导入码的总数量保持一致（即历史导入数量 + 追加导入数量）。", "example" : "15" } } }, "AlipayMarketingActivityOrdervoucherAppendResponseModel" : { "type" : "object" }, "AlipayMarketingActivityOrdervoucherAssociateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "ACTIVITY_NOT_EXIST", "VOUCHER_NOT_EXIST", "ACTIVITY_NOT_PERMISSION", "VOUCHER_ASSOCIATE_OTHER_TRADE_NO" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityOrdervoucherAssociateModel" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "活动id", "example" : "2016042700826004508401111111" }, "merchant_access_mode" : { "type" : "string", "description" : "商户接入模式\t\t枚举值\tSELF_MODE 商户自接入模式\tAGENCY_MODE 服务商代接入模式", "example" : "AGENCY_MODE" }, "out_biz_no" : { "type" : "string", "description" : "外部业务单号，用作幂等控制。 幂等作用： 参数不变的情况下，再次请求返回与上一次相同的结果。 外部接入方需保证业务单号唯一。", "example" : "20170101000001654bb46ba" }, "trade_no" : { "type" : "string", "description" : "支付宝支付下单时的商户订单号，欲与该商家券关联的支付宝支付", "example" : "2021042322001426261436764012" }, "voucher_code" : { "type" : "string", "description" : "商家券券码。\t限制:\t券码必须已发放给用户。", "example" : "ABE44" } } }, "AlipayMarketingActivityOrdervoucherAssociateResponseModel" : { "type" : "object", "properties" : { "associate_time" : { "type" : "string", "description" : "支付宝系统关联订单成功的时间。 格式为：yyyy-MM-dd HH:mm:ss", "example" : "2017-01-01 00:00:01" } } }, "AlipayMarketingActivityOrdervoucherCodecountErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityOrdervoucherCodecountResponseModel" : { "type" : "object", "properties" : { "success_count" : { "type" : "integer", "description" : "已经导入的券码数量", "example" : "100" } } }, "AlipayMarketingActivityOrdervoucherCodedepositErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityOrdervoucherCodedepositModel" : { "type" : "object", "properties" : { "merchant_access_mode" : { "type" : "string", "description" : "商户接入模式\t\t枚举值\tSELF_MODE 商户自接入模式\tAGENCY_MODE 服务商代接入模式", "example" : "SELF_MODE" }, "out_biz_no" : { "type" : "string", "description" : "外部业务单号，用作幂等控制。\t\t幂等作用：\t参数不变的情况下，再次请求返回与上一次相同的结果。\t\t外部接入方需保证业务单号唯一。", "example" : "20170101000001654bb46ba" }, "voucher_codes" : { "type" : "array", "description" : "券码的数量列表。接口参数为列表类型。\t\t限制：\t目前最大上传 1000 个。\t\t单个code最长64位。\t\t商户上传的券code列表，code允许包含的字符有0-9、a-z、A-Z、-、_、+、=、|。", "items" : { "type" : "string" }, "example" : "[\"123AB\",\"45zz6\",\"789CE\"]" } } }, "AlipayMarketingActivityOrdervoucherCodedepositResponseModel" : { "type" : "object", "properties" : { "fail_count" : { "type" : "integer", "description" : "导入失败的券码数量", "example" : "1" }, "fail_voucher_code_detail_list" : { "type" : "array", "description" : "上传失败券码详情列表，包括上传失败的券码及对应的错误码和错误原因", "items" : { "$ref" : "#/components/schemas/FailVoucherCodeDetail" } }, "success_count" : { "type" : "integer", "description" : "导入成功的券码数量", "example" : "2" }, "success_voucher_code_list" : { "type" : "array", "description" : "上传成功的券码列表", "items" : { "type" : "string" }, "example" : "[\"123AB\",\"45zz6\"]" } } }, "AlipayMarketingActivityOrdervoucherCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "BIZ_ERROR", "DISCOUNT_AMOUNT_INSUFFICIENT", "BUSINESS_HAS_RISK" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityOrdervoucherCreateModel" : { "type" : "object", "properties" : { "activity_base_info" : { "$ref" : "#/components/schemas/ActivityBaseInfo" }, "activity_name" : { "type" : "string", "description" : "活动名称。不对用户进行展示，仅供商家在后台管理活动使用。", "example" : "满10减1活动" }, "belong_merchant_info" : { "$ref" : "#/components/schemas/BelongMerchantInfo" }, "biz_tag" : { "type" : "string", "description" : "该字段废弃！后续不要使用该字段！商家券业务标签，影响商家券对C端用户的展示形式。", "example" : "GROUP_BUY_EXCHANGE_VOUCHER" }, "code_mode" : { "type" : "string", "description" : "码模式。MERCHANT_UPLOAD：商户上传自定义code，发券时系统随机选取上传的券code发放。MERCHANT_API：发奖时指定券码发奖，此模式无须提前上传券码。", "example" : "MERCHANT_UPLOAD" }, "customer_guide" : { "$ref" : "#/components/schemas/CustomerGuide" }, "merchant_access_mode" : { "type" : "string", "description" : "商户接入模式", "example" : "AGENCY_MODE" }, "out_biz_no" : { "type" : "string", "description" : "外部业务单号，用作幂等控制。\t幂等作用：参数不变的情况下，再次请求返回与上一次相同的结果。", "example" : "20170101000001654bb46ba" }, "publish_end_time" : { "type" : "string", "description" : "券发放结束时间。格式为：yyyy-MM-dd HH:mm:ss", "example" : "2017-01-29 23:59:59" }, "publish_start_time" : { "type" : "string", "description" : "券发放开始时间。格式为：yyyy-MM-dd HH:mm:ss", "example" : "2017-01-01 00:00:01" }, "voucher_available_scope_info" : { "$ref" : "#/components/schemas/VoucherAvailableScopeInfo" }, "voucher_customer_guide_info" : { "$ref" : "#/components/schemas/VoucherCustomerGuideInfo" }, "voucher_deduct_info" : { "$ref" : "#/components/schemas/VoucherDeductInfo" }, "voucher_display_info" : { "$ref" : "#/components/schemas/VoucherDisplayInfo" }, "voucher_display_pattern_info" : { "$ref" : "#/components/schemas/VoucherDisplayPatternInfo" }, "voucher_send_mode_info" : { "$ref" : "#/components/schemas/VoucherSendModeInfo" }, "voucher_send_rule" : { "$ref" : "#/components/schemas/VoucherSendRuleDetail" }, "voucher_type" : { "type" : "string", "description" : "券类型。商家券支持三类券类型：\tFIX_VOUCHER：满减券；\tDISCOUNT_VOUCHER：折扣券；\tSPECIAL_VOUCHER：特价券；\t兑换券仅支持一类券类型：EXCHANGE_VOUCHER: 兑换券；", "example" : "FIX_VOUCHER" }, "voucher_use_rule" : { "$ref" : "#/components/schemas/VoucherUseRule" }, "voucher_use_rule_info" : { "$ref" : "#/components/schemas/VoucherUseRuleInfo" } } }, "AlipayMarketingActivityOrdervoucherCreateResponseModel" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "活动id", "example" : "2016042700826004508401111111" }, "voucher_available_scope_result_info" : { "$ref" : "#/components/schemas/VoucherAvailableScopeResultInfo" }, "voucher_use_rule_result" : { "$ref" : "#/components/schemas/OrderVoucherUseRuleResult" } } }, "AlipayMarketingActivityOrdervoucherDisassociateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "ACTIVITY_NOT_EXIST", "VOUCHER_NOT_EXIST", "ACTIVITY_NOT_PERMISSION", "VOUCHER_ASSOCIATE_TRADE_NO_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityOrdervoucherDisassociateModel" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "活动id", "example" : "2016042700826004508401111111" }, "merchant_access_mode" : { "type" : "string", "description" : "商户接入模式\t\t枚举值\tSELF_MODE 商户自接入模式\tAGENCY_MODE 服务商代接入模式", "example" : "AGENCY_MODE" }, "out_biz_no" : { "type" : "string", "description" : "外部业务单号，用作幂等控制。 幂等作用： 参数不变的情况下，再次请求返回与上一次相同的结果。 外部接入方需保证业务单号唯一。", "example" : "20170101000001654bb46ba" }, "trade_no" : { "type" : "string", "description" : "该交易在支付宝系统中的交易流水号。", "example" : "2021042322001426261436764012" }, "voucher_code" : { "type" : "string", "description" : "券码。 限制: 券码必须已发放给用户。", "example" : "ABE44" } } }, "AlipayMarketingActivityOrdervoucherDisassociateResponseModel" : { "type" : "object", "properties" : { "disassociate_time" : { "type" : "string", "description" : "支付宝系统取消关联订单成功的时间。 格式为：yyyy-MM-dd HH:mm:ss", "example" : "2017-01-01 00:00:01" } } }, "AlipayMarketingActivityOrdervoucherModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityOrdervoucherModifyModel" : { "type" : "object", "properties" : { "activity_base_info" : { "$ref" : "#/components/schemas/ActivityBaseInfo" }, "activity_name" : { "type" : "string", "description" : "活动名称。", "example" : "满10减1活动" }, "customer_guide" : { "$ref" : "#/components/schemas/CustomerGuideModify" }, "merchant_access_mode" : { "type" : "string", "description" : "商户接入模式", "example" : "SELF_MODE" }, "out_biz_no" : { "type" : "string", "description" : "外部业务单号，用作幂等控制。\t幂等作用：\t参数不变的情况下，再次请求返回与上一次相同的结果。", "example" : "20170101000001654bb46ba" }, "publish_end_time" : { "type" : "string", "description" : "券发放结束时间。该值为空表示不修改\t格式为：yyyy-MM-dd HH:mm:ss", "example" : "2017-01-29 23:59:59" }, "publish_start_time" : { "type" : "string", "description" : "券发放开始时间。 格式为：yyyy-MM-dd HH:mm:ss", "example" : "2017-01-01 00:00:01" }, "voucher_available_scope_info" : { "$ref" : "#/components/schemas/VoucherAvailableScopeInfo" }, "voucher_available_scope_modify_type" : { "type" : "string", "description" : "可用范围修改类型。", "example" : "ADD" }, "voucher_customer_guide_info" : { "$ref" : "#/components/schemas/VoucherCustomerGuideInfo" }, "voucher_display_info" : { "$ref" : "#/components/schemas/VoucherDisplayInfoModify" }, "voucher_display_pattern_info" : { "$ref" : "#/components/schemas/VoucherDisplayPatternInfo" }, "voucher_send_mode_info" : { "$ref" : "#/components/schemas/VoucherSendModeInfo" }, "voucher_send_rule" : { "$ref" : "#/components/schemas/VoucherSendRuleDetailModify" }, "voucher_use_rule" : { "$ref" : "#/components/schemas/VoucherUseRuleModify" }, "voucher_use_rule_info" : { "$ref" : "#/components/schemas/VoucherUseRuleInfo" } } }, "AlipayMarketingActivityOrdervoucherModifyResponseModel" : { "type" : "object", "properties" : { "voucher_available_scope_result_info" : { "$ref" : "#/components/schemas/VoucherAvailableScopeResultInfo" }, "voucher_use_rule_result" : { "$ref" : "#/components/schemas/OrderVoucherUseRuleResult" } } }, "AlipayMarketingActivityOrdervoucherQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityOrdervoucherQueryResponseModel" : { "type" : "object", "properties" : { "activity_base_info" : { "$ref" : "#/components/schemas/ActivityBaseInfo" }, "activity_id" : { "type" : "string", "description" : "活动id", "example" : "2016042700826004508401111111" }, "activity_name" : { "type" : "string", "description" : "活动名称。不对用户进行展示，仅供商家在后台管理活动使用。", "example" : "满10减1优惠券" }, "activity_operation_status" : { "type" : "string", "description" : "活动操作状态", "example" : "MODIFYING" }, "activity_status" : { "type" : "string", "description" : "活动状态。已激活状态代表活动正常运行，已终止状态代表商家终止活动，不可再发放。", "example" : "ACTIVE" }, "belong_merchant_info" : { "$ref" : "#/components/schemas/BelongMerchantInfo" }, "biz_tag" : { "type" : "string", "description" : "商家券业务标签，影响商家券对C端用户的展示形式。", "example" : "GROUP_BUY_EXCHANGE_VOUCHER" }, "customer_guide" : { "$ref" : "#/components/schemas/CustomerGuide" }, "publish_end_time" : { "type" : "string", "description" : "券发放结束时间。格式为：yyyy-MM-dd HH:mm:ss", "example" : "2017-01-29 23:59:59" }, "publish_start_time" : { "type" : "string", "description" : "券发放开始时间。格式为：yyyy-MM-dd HH:mm:ss", "example" : "2017-01-01 00:00:01" }, "summary" : { "$ref" : "#/components/schemas/VoucherSummary" }, "voucher_available_scope_info" : { "$ref" : "#/components/schemas/VoucherAvailableScopeInfo" }, "voucher_customer_guide_info" : { "$ref" : "#/components/schemas/VoucherCustomerGuideInfo" }, "voucher_deduct_info" : { "$ref" : "#/components/schemas/VoucherDeductInfo" }, "voucher_display_info" : { "$ref" : "#/components/schemas/VoucherDisplayInfo" }, "voucher_display_pattern_info" : { "$ref" : "#/components/schemas/VoucherDisplayPatternInfo" }, "voucher_inventory_info" : { "$ref" : "#/components/schemas/VoucherInventoryInfo" }, "voucher_send_mode_info" : { "$ref" : "#/components/schemas/VoucherSendModeInfo" }, "voucher_send_rule" : { "$ref" : "#/components/schemas/VoucherSendRuleDetail" }, "voucher_type" : { "type" : "string", "description" : "券类型", "example" : "FIX_VOUCHER" }, "voucher_use_rule" : { "$ref" : "#/components/schemas/VoucherUseRule" }, "voucher_use_rule_info" : { "$ref" : "#/components/schemas/VoucherUseRuleInfo" } } }, "AlipayMarketingActivityOrdervoucherRefundErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityOrdervoucherRefundModel" : { "type" : "object", "properties" : { "biz_dt" : { "type" : "string", "description" : "当前订单的退券时间。\t\t\t\t格式为：yyyy-MM-dd HH:mm:ss\t\t\t\t特别说明：\t\t支付宝的退款时间按照外部退款的时间为准。", "example" : "2017-01-01 00:00:01" }, "merchant_access_mode" : { "type" : "string", "description" : "商户接入模式\t\t枚举值\tSELF_MODE 商户自接入模式\tAGENCY_MODE 服务商代接入模式", "example" : "AGENCY_MODE" }, "out_biz_no" : { "type" : "string", "description" : "外部业务单号，用作幂等控制。\t\t\t\t幂等作用：\t\t参数不变的情况下，再次请求返回与上一次相同的结果。\t\t\t\t外部接入方需保证业务单号唯一", "example" : "1002600620019090123143254436" }, "total_fee" : { "type" : "string", "description" : "当前订单的退款总金额(包含优惠券金额)，单位为元。\t\t限制：\t\t该笔订单的资金总额，取值范围[0.01,100000000]，精确到小数点后2位。", "example" : "999.99" }, "voucher_refund_detail_info" : { "$ref" : "#/components/schemas/VoucherRefundDetailInfo" } } }, "AlipayMarketingActivityOrdervoucherRefundResponseModel" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "优惠券活动id", "example" : "2022113000826004726607680740" }, "voucher_use_detail_result_info" : { "$ref" : "#/components/schemas/VoucherUseDetailResultInfo" } } }, "AlipayMarketingActivityOrdervoucherStopErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityOrdervoucherStopModel" : { "type" : "object", "properties" : { "merchant_access_mode" : { "type" : "string", "description" : "商户接入模式\t\t枚举值\tSELF_MODE 商户自接入模式\tAGENCY_MODE 服务商代接入模式", "example" : "SELF_MODE" }, "out_biz_no" : { "type" : "string", "description" : "外部业务单号，用作幂等控制。\t\t幂等作用：\t参数不变的情况下，再次请求返回与上一次相同的结果。\t\t外部接入方需保证业务单号唯一。", "example" : "20170101000001654bb46ba" } } }, "AlipayMarketingActivityOrdervoucherStopResponseModel" : { "type" : "object" }, "AlipayMarketingActivityOrdervoucherUseErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "BIZ_ERROR", "ACTIVITY_NOT_PERMISSION" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityOrdervoucherUseModel" : { "type" : "object", "properties" : { "biz_dt" : { "type" : "string", "description" : "外部优惠券的核销时间，用于流水记录。 格式为：yyyy-MM-dd HH:mm:ss", "example" : "2017-01-01 00:00:01" }, "goods_detail" : { "type" : "array", "description" : "商品明细信息。\t\t\t\t限制：\t\t当前交易中存在商品信息，则建议传入商品明细信息。", "items" : { "$ref" : "#/components/schemas/GoodsDetailDTO" } }, "merchant_access_mode" : { "type" : "string", "description" : "商户接入模式\t\t枚举值\tSELF_MODE 商户自接入模式\tAGENCY_MODE 服务商代接入模式", "example" : "AGENCY_MODE" }, "out_biz_no" : { "type" : "string", "description" : "外部业务单号，用作幂等控制。\t\t\t\t幂等作用：\t\t参数不变的情况下，再次请求返回与上一次相同的结果。\t\t\t\t外部接入方需保证业务单号唯一。", "example" : "20170101000001654bb46ba" }, "real_shop_id" : { "type" : "string", "description" : "用户核销优惠券的代运营商业关系球房id，调用接口alipay.business.relation.shop.create创建球房返回的real_shop_id。\t限制:\t传入的球房id必须是创建商家券voucher_use_rule. voucher_available_scope. order_voucher_available_shop对象中real_shop_ids中的球房id", "example" : "2018051000502000000011111111" }, "store_id" : { "type" : "string", "description" : "用户核销优惠券的支付球房id,调用接口ant.merchant.expand.shop.create创建球房返回的球房id。\t限制:\t传入的球房id必须是创建商家券voucher_use_rule. voucher_available_scope. order_voucher_available_shop对象中shop_ids中的球房id", "example" : "2018051000502000000011111111" }, "total_fee" : { "type" : "string", "description" : "订单优惠前的总金额\t\t\t\t限制：\t\t该笔订单的资金总额，取值范围[0.01,100000000]，精确到小数点后2位。", "example" : "999.99" }, "trade_channel" : { "type" : "string", "description" : "交易渠道。\t\t\t\t枚举值：\t\tZHIFUBAO_TRADE_CHANNEL：\t\t支付宝交易渠道\t\t\t\tWX_TRADE_CHANNEL：\t\t微信交易渠道\t\t\t\tOTHER_TRADE_CHANNEL：\t\t其他交易渠道", "example" : "ZHIFUBAO_TRADE_CHANNEL" }, "trade_no" : { "type" : "string", "description" : "该交易在支付宝系统中的交易流水号。\t注意：若用户使用支付宝为交易的渠道，本参数必填。", "example" : "2021042322001426261436764012" }, "voucher_use_detail_info" : { "$ref" : "#/components/schemas/VoucherUseDetailInfo" } } }, "AlipayMarketingActivityOrdervoucherUseResponseModel" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "优惠券活动id", "example" : "2016042700826004508401111111" }, "voucher_use_detail_result_info" : { "$ref" : "#/components/schemas/VoucherUseDetailResultInfo" } } }, "AlipayMarketingActivityQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "ACTIVITY_NOT_ACTIVE", "ACTIVITY_NOT_PERMISSION" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityQueryResponseModel" : { "type" : "object", "properties" : { "activity_base_info" : { "$ref" : "#/components/schemas/ActivityBaseInfo" }, "activity_id" : { "type" : "string", "description" : "活动id", "example" : "2016042700826004508401111111" }, "activity_name" : { "type" : "string", "description" : "活动名称。 不对用户进行展示，仅供商家在后台管理活动使用。", "example" : "满10减1活动" }, "activity_status" : { "type" : "string", "description" : "活动状态。活动已激活，表示活动已经生效，等到活动开始(publish_start_time)之后用户就可以参与活动。活动已暂停，表示商户临时暂停该活动，该状态下用户不能参与活动。活动已结束，表示商户主动停止活动或活动到期结束(publish_end_time)不能再进行领取或修改等操作。", "example" : "ACTIVE" }, "belong_merchant_id" : { "type" : "string", "description" : "归属商户PID", "example" : "2088202967380463" }, "publish_end_time" : { "type" : "string", "description" : "券发放结束时间。 格式为：yyyy-MM-dd HH:mm:ss", "example" : "2017-01-29 23:59:59" }, "publish_start_time" : { "type" : "string", "description" : "券发放开始时间。 格式为：yyyy-MM-dd HH:mm:ss", "example" : "2017-01-01 00:00:01" }, "voucher_available_scope_info" : { "$ref" : "#/components/schemas/VoucherAvailableScopeInfo" }, "voucher_customer_guide_info" : { "$ref" : "#/components/schemas/VoucherCustomerGuideInfo" }, "voucher_deduct_info" : { "$ref" : "#/components/schemas/VoucherDeductInfo" }, "voucher_display_info" : { "$ref" : "#/components/schemas/CommonVoucherDisplayInfo" }, "voucher_display_pattern_info" : { "$ref" : "#/components/schemas/VoucherDisplayPatternInfo" }, "voucher_send_mode_info" : { "$ref" : "#/components/schemas/VoucherSendModeInfo" }, "voucher_send_rule" : { "$ref" : "#/components/schemas/CommonVoucherSendRule" }, "voucher_type" : { "type" : "string", "description" : "券类型。", "example" : "FIX_VOUCHER" }, "voucher_use_rule" : { "$ref" : "#/components/schemas/CommonVoucherUseRule" }, "voucher_use_rule_info" : { "$ref" : "#/components/schemas/VoucherUseRuleInfo" } } }, "AlipayMarketingActivityShopBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityShopBatchqueryResponseModel" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "活动id", "example" : "2016042700826004508401111111" }, "page_num" : { "type" : "integer", "description" : "分页查询页码。", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "分页查询单页数据条数。", "example" : "20" }, "shop_infos" : { "type" : "array", "description" : "可用球房列表", "items" : { "$ref" : "#/components/schemas/ActivityShopInfo" } }, "total_size" : { "type" : "integer", "description" : "可用球房总数量", "example" : "200" } } }, "AlipayMarketingActivityUserBatchqueryvoucherErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityUserBatchqueryvoucherResponseModel" : { "type" : "object", "properties" : { "page_num" : { "type" : "integer", "description" : "分页查询页码", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "分页查询单页数据条数", "example" : "20" }, "total_size" : { "type" : "integer", "description" : "总数量", "example" : "200" }, "user_voucher_infos" : { "type" : "array", "description" : "用户券实例", "items" : { "$ref" : "#/components/schemas/UserVoucherInfo" } } } }, "AlipayMarketingActivityUserQueryvoucherErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "VOUCHER_NOT_EXIST", "ACTIVITY_NOT_PERMISSION", "MERCHANT_RELATION_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityUserQueryvoucherResponseModel" : { "type" : "object", "properties" : { "activity_base_info" : { "$ref" : "#/components/schemas/ActivityBaseInfo" }, "activity_id" : { "type" : "string", "description" : "活动 id", "example" : "2016042700826004508401111111" }, "associate_trade_no" : { "type" : "string", "description" : "若商家券操作过关联商户订单信息，则该字段返回商家券已关联的商户订单号。", "example" : "2021042322001426261436764012" }, "available_begin_time" : { "type" : "string", "description" : "券可用开始时间", "example" : "2017-01-01 00:00:01" }, "available_end_time" : { "type" : "string", "description" : "券可用结束时间", "example" : "2017-01-01 00:00:01" }, "belong_merchant_id" : { "type" : "string", "description" : "券归属 pid", "example" : "2088202967380463" }, "create_time" : { "type" : "string", "description" : "领券时间", "example" : "2017-01-01 00:00:01" }, "user_voucher_base_info" : { "$ref" : "#/components/schemas/UserVoucherBaseInfo" }, "voucher_deduct_info" : { "$ref" : "#/components/schemas/VoucherDeductInfo" }, "voucher_display_info" : { "$ref" : "#/components/schemas/CommonVoucherDisplayInfo" }, "voucher_display_pattern_info" : { "$ref" : "#/components/schemas/VoucherDisplayPatternInfo" }, "voucher_name" : { "type" : "string", "description" : "券名称", "example" : "满10减1" }, "voucher_send_mode_info" : { "$ref" : "#/components/schemas/VoucherSendModeInfo" }, "voucher_send_rule" : { "$ref" : "#/components/schemas/CommonVoucherSendRule" }, "voucher_status" : { "type" : "string", "description" : "券状态。", "example" : "SENDED" }, "voucher_type" : { "type" : "string", "description" : "券类型。", "example" : "FIX_VOUCHER" }, "voucher_use_rule" : { "$ref" : "#/components/schemas/CommonVoucherUseRule" }, "voucher_use_rule_info" : { "$ref" : "#/components/schemas/VoucherUseRuleInfo" } } }, "AlipayMarketingActivityVoucherAppendErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityVoucherAppendModel" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "活动id", "example" : "2016042700826004508401111111" }, "merchant_access_mode" : { "type" : "string", "description" : "商户接入模式\t\t枚举值\tSELF_MODE 商户自接入模式\tAGENCY_MODE 服务商代接入模式", "example" : "AGENCY_MODE" }, "out_biz_no" : { "type" : "string", "description" : "外部业务单号，用作幂等控制。\t\t幂等作用：\t参数不变的情况下，再次请求返回与上一次相同的结果。\t\t外部接入方需保证业务单号唯一。", "example" : "20170101000001654bb46ba" }, "voucher_quantity" : { "type" : "integer", "description" : "券总预算值。 限制： 券总预算<= 99999999 特别说明： 该字段的含义是追加到的数量。 不可减少，只能增加。", "example" : "100" } } }, "AlipayMarketingActivityVoucherAppendResponseModel" : { "type" : "object", "properties" : { "recharge_url" : { "type" : "string", "description" : "预充值链接\t\t限制\t有效时间3天", "example" : "https://voucherprod.alipay.com/coupon/templatepayment.htm?templateId=20210829000730015448005XXOO&authNo=2021082910002001170507729XX5&operationId=202X0829X45X35X1170X" } } }, "AlipayMarketingActivityVoucherCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "BIZ_ERROR", "MATERIAL_AUDIT_WAITING" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityVoucherCreateModel" : { "type" : "object", "properties" : { "activity_base_info" : { "$ref" : "#/components/schemas/ActivityBaseInfo" }, "activity_name" : { "type" : "string", "description" : "活动名称。 不对用户进行展示，仅供商家在后台管理活动使用。", "example" : "满10减1活动" }, "belong_merchant_info" : { "$ref" : "#/components/schemas/PaymentVoucherBelongMerchantInfo" }, "merchant_access_mode" : { "type" : "string", "description" : "商户接入模式", "example" : "AGENCY_MODE" }, "out_biz_no" : { "type" : "string", "description" : "用作幂等控制。\t\t幂等作用：\t参数不变的情况下，再次请求返回与上一次相同的结果。\t\t外部接入方需保证业务单号唯一。", "example" : "asdh12394nb23941234xasd2021" }, "publish_end_time" : { "type" : "string", "description" : "券发放结束时间。 格式为：yyyy-MM-dd HH:mm:ss 限制： 券发放结束时间 publish_end_time 与 券发放开始时间 publish_start_time 间隔必须小于等于180天", "example" : "2017-01-29 23:59:59" }, "publish_start_time" : { "type" : "string", "description" : "券发放开始时间。 格式为：yyyy-MM-dd HH:mm:ss", "example" : "2017-01-01 00:00:01" }, "voucher_available_scope_info" : { "$ref" : "#/components/schemas/VoucherAvailableScopeInfo" }, "voucher_budget_info" : { "$ref" : "#/components/schemas/PaymentVoucherBudgetInfo" }, "voucher_budget_supply_info" : { "$ref" : "#/components/schemas/VoucherBudgetSupplyInfo" }, "voucher_customer_guide_info" : { "$ref" : "#/components/schemas/VoucherCustomerGuideInfo" }, "voucher_deduct_info" : { "$ref" : "#/components/schemas/VoucherDeductInfo" }, "voucher_display_info" : { "$ref" : "#/components/schemas/PaymentVoucherDisplayInfo" }, "voucher_display_pattern_info" : { "$ref" : "#/components/schemas/VoucherDisplayPatternInfo" }, "voucher_send_mode_info" : { "$ref" : "#/components/schemas/VoucherSendModeInfo" }, "voucher_send_rule" : { "$ref" : "#/components/schemas/PaymentVoucherSendRule" }, "voucher_type" : { "type" : "string", "description" : "优惠类型\t\t枚举值：\tFIX_VOUCHER：固定面额满减券", "example" : "FIX_VOUCHER" }, "voucher_use_rule" : { "$ref" : "#/components/schemas/PaymentVoucherUseRule" }, "voucher_use_rule_info" : { "$ref" : "#/components/schemas/VoucherUseRuleInfo" } } }, "AlipayMarketingActivityVoucherCreateResponseModel" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "活动id", "example" : "2016042700826004508401111111" } } }, "AlipayMarketingActivityVoucherModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityVoucherModifyModel" : { "type" : "object", "properties" : { "activity_base_info" : { "$ref" : "#/components/schemas/ActivityBaseInfo" }, "activity_id" : { "type" : "string", "description" : "活动id", "example" : "2016042700826004508401111111" }, "merchant_access_mode" : { "type" : "string", "description" : "商户接入模式", "example" : "AGENCY_MODE" }, "out_biz_no" : { "type" : "string", "description" : "外部业务单号，用作幂等控制。 幂等作用： 参数不变的情况下，再次请求返回与上一次相同的结果。", "example" : "20170101000001654bb46ba" }, "publish_end_time" : { "type" : "string", "description" : "券发放结束时间。格式为：yyyy-MM-dd HH:mm:ss", "example" : "2017-01-29 23:59:59" }, "voucher_available_scope_info" : { "$ref" : "#/components/schemas/VoucherAvailableScopeInfo" }, "voucher_send_mode_info" : { "$ref" : "#/components/schemas/VoucherSendModeInfo" }, "voucher_use_rule" : { "$ref" : "#/components/schemas/PaymentVoucherUseRuleModify" }, "voucher_use_rule_info" : { "$ref" : "#/components/schemas/VoucherUseRuleInfo" } } }, "AlipayMarketingActivityVoucherModifyResponseModel" : { "type" : "object" }, "AlipayMarketingActivityVoucherPublishErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityVoucherPublishModel" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "活动id", "example" : "2016042700826004508401111111" }, "merchant_access_mode" : { "type" : "string", "description" : "商户接入模式", "example" : "AGENCY_MODE" }, "out_biz_no" : { "type" : "string", "description" : "用作幂等控制\t\t幂等作用：\t参数不变的情况下，再次请求返回与上一次相同的结果。\t外部接入方需保证业务单号唯一。", "example" : "20170101000001654bb46ba" } } }, "AlipayMarketingActivityVoucherPublishResponseModel" : { "type" : "object", "properties" : { "recharge_url" : { "type" : "string", "description" : "预充值链接", "example" : "https://voucherprod.alipay.com/coupon/templatepayment.htm?templateId=20210829000730015448005XXOO&authNo=2021082910002001170507729XX5&operationId=202X0829X45X35X1170X" } } }, "AlipayMarketingActivityVoucherQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityVoucherQueryResponseModel" : { "type" : "object", "properties" : { "activity_base_info" : { "$ref" : "#/components/schemas/ActivityBaseInfo" }, "activity_id" : { "type" : "string", "description" : "活动 ID", "example" : "2016042700826004508401111111" }, "activity_name" : { "type" : "string", "description" : "活动名称。 不对用户进行展示，仅供商家在后台管理活动使用。", "example" : "满10减1活动" }, "activity_status" : { "type" : "string", "description" : "活动状态。\t如果该值为空，说明活动还未创建成功。", "example" : "ACTIVE" }, "belong_merchant_info" : { "$ref" : "#/components/schemas/PaymentVoucherBelongMerchantInfo" }, "publish_end_time" : { "type" : "string", "description" : "券发放结束时间。 格式为：yyyy-MM-dd HH:mm:ss。", "example" : "2017-01-29 23:59:59" }, "publish_start_time" : { "type" : "string", "description" : "券发放开始时间。 格式为：yyyy-MM-dd HH:mm:ss", "example" : "2017-01-01 00:00:01" }, "summary" : { "$ref" : "#/components/schemas/VoucherSummary" }, "voucher_available_scope_info" : { "$ref" : "#/components/schemas/VoucherAvailableScopeInfo" }, "voucher_budget_info" : { "$ref" : "#/components/schemas/PaymentVoucherBudgetInfo" }, "voucher_budget_supply_info" : { "$ref" : "#/components/schemas/VoucherBudgetSupplyInfo" }, "voucher_customer_guide_info" : { "$ref" : "#/components/schemas/VoucherCustomerGuideInfo" }, "voucher_deduct_info" : { "$ref" : "#/components/schemas/VoucherDeductInfo" }, "voucher_display_info" : { "$ref" : "#/components/schemas/PaymentVoucherDisplayInfo" }, "voucher_display_pattern_info" : { "$ref" : "#/components/schemas/VoucherDisplayPatternInfo" }, "voucher_inventory_info" : { "$ref" : "#/components/schemas/VoucherInventoryInfo" }, "voucher_send_mode_info" : { "$ref" : "#/components/schemas/VoucherSendModeInfo" }, "voucher_send_rule" : { "$ref" : "#/components/schemas/PaymentVoucherSendRule" }, "voucher_type" : { "type" : "string", "description" : "优惠类型。", "example" : "FIX_VOUCHER" }, "voucher_use_rule" : { "$ref" : "#/components/schemas/PaymentVoucherUseRuleDetail" }, "voucher_use_rule_info" : { "$ref" : "#/components/schemas/VoucherUseRuleInfo" } } }, "AlipayMarketingActivityVoucherSendErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "ACTIVITY_NOT_ACTIVE", "ACTIVITY_NOT_START", "ACTIVITY_IS_END", "ACTIVITY_IS_STOPED", "BUDGET_NOT_ENOUGH", "COUNT_OVER_LIMIT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityVoucherSendModel" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "优惠券活动id", "example" : "2016042700826004508401111111" }, "merchant_access_mode" : { "type" : "string", "description" : "商户接入模式\t\t枚举值\tSELF_MODE 商户自接入模式\tAGENCY_MODE 服务商代接入模式", "example" : "AGENCY_MODE" }, "open_id" : { "type" : "string", "description" : "领券的支付宝用户openId", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "out_biz_no" : { "type" : "string", "description" : "外部业务单号，用作幂等控制。\t\t幂等作用：\t参数不变的情况下，再次请求返回与上一次相同的结果。\t\t外部接入方需保证业务单号唯一。", "example" : "20170101000001654bb46ba" }, "user_id" : { "type" : "string", "description" : "领券的支付宝user_id账号", "example" : "2088XXXX" } } }, "AlipayMarketingActivityVoucherSendResponseModel" : { "type" : "object", "properties" : { "voucher_id" : { "type" : "string", "description" : "本次发放的支付券id", "example" : "2021072600073002785300065Q39" } } }, "AlipayMarketingActivityVoucherStopErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityVoucherStopModel" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "活动id", "example" : "2016042700826004508401111111" }, "merchant_access_mode" : { "type" : "string", "description" : "商户接入模式\t\t枚举值\tSELF_MODE 商户自接入模式\tAGENCY_MODE 服务商代接入模式", "example" : "AGENCY_MODE" }, "out_biz_no" : { "type" : "string", "description" : "64\t外部业务单号，用作幂等控制。\t\t幂等作用：\t参数不变的情况下，再次请求返回与上一次相同的结果。\t\t外部接入方需保证业务单号唯一。", "example" : "20170101000001654bb46ba" } } }, "AlipayMarketingActivityVoucherStopResponseModel" : { "type" : "object" }, "AlipayMarketingActivityVoucherpackageBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityVoucherpackageBatchqueryModel" : { "type" : "object", "properties" : { "page_num" : { "type" : "integer", "description" : "分页参数，需要查询的页码，起始页是1", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "分页参数，每页记录数，最大不可超过30", "example" : "10" }, "voucher_package_purchase_start_time" : { "type" : "string", "description" : "券包购买开始时间。 格式为：yyyy-MM-dd HH:mm:ss", "example" : "2017-01-01 00:00:01" }, "voucher_package_status" : { "type" : "string", "description" : "券包状态：不指定可查全部状态，指定时只支持查单个状态\t枚举值：\tCREATED：已创建,\tENABLE：已发布（包含过期）,\tPAUSED：已暂停,\tDISABLE：已停止;", "example" : "ENABLE" } } }, "AlipayMarketingActivityVoucherpackageBatchqueryResponseModel" : { "type" : "object", "properties" : { "page_num" : { "type" : "integer", "description" : "分页参数，当前所在的页码", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "分页参数，每页记录数，最大不可超过30", "example" : "10" }, "total_size" : { "type" : "integer", "description" : "券包总数量", "example" : "100" }, "voucher_package_info" : { "type" : "array", "description" : "券包信息", "items" : { "$ref" : "#/components/schemas/VoucherPackageInfo" } } } }, "AlipayMarketingActivityVoucherpackageConsultErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityVoucherpackageConsultModel" : { "type" : "object", "properties" : { "voucher_package_id_list" : { "type" : "array", "description" : "券包id列表", "items" : { "type" : "string" }, "example" : "[\"IP20220628016671405804297103167741\"]" } } }, "AlipayMarketingActivityVoucherpackageConsultResponseModel" : { "type" : "object", "properties" : { "voucher_package_consult_result" : { "type" : "array", "description" : "券包购买咨询结果", "items" : { "$ref" : "#/components/schemas/VoucherPackageConsultResult" } } } }, "AlipayMarketingActivityVoucherpackageQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "VOUCHER_PACKAGE_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingActivityVoucherpackageQueryResponseModel" : { "type" : "object", "properties" : { "voucher_package_activity_info" : { "type" : "array", "description" : "券包活动信息", "items" : { "$ref" : "#/components/schemas/VoucherPackageActivityInfo" } }, "voucher_package_base_info" : { "$ref" : "#/components/schemas/VoucherPackageBaseInfo" }, "voucher_package_sales_info" : { "$ref" : "#/components/schemas/VoucherPackageSalesInfo" }, "voucher_package_use_rule" : { "$ref" : "#/components/schemas/VoucherPackageUseRule" } } }, "AlipayMarketingCampaignCashCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "UNKNOW_SYSTEM_ERROR", "SENSITIVE_WORD_CHECK_FAILED", "CASH_PRIZE_TYPE_ERROR", "CASH_TIME_CHECK_FAILED", "CASH_COUNT_TOO_SMALL", "CASH_AMOUNT_TOO_MUCH", "CASH_PER_AMOUNT_TOO_MUCH", "CASH_COUNT_TOO_MUCH", "CASH_AMOUNT_TOO_SMALL", "CASH_COUPON_NAME_CHECK_FAILED", "CASH_PRIZE_MSG_CHECK_FAILED", "BIZ_CONTENT_IS_EMPTY", "BIZ_CONTENT_FORMAT_ERROR", "PRODUCT_IS_NOT_OPENED", "CALL_TOO_FREQUENCY", "CREATOR_LIMIT_ERROR", "CREATOR_NOT_REALNAME", "SYSTEM_LIMIT_ERROR", "CASH_MERCHANT_LINK_CHECK_FAILED", "CASH_PER_AMOUNT_TOO_SMALL", "CASH_SEND_FREQUENCY_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingCampaignCashCreateModel" : { "type" : "object", "properties" : { "coupon_name" : { "type" : "string", "description" : "红包名称,商户在查询列表、详情看到的名字,同时也会显示在商户付款页面。", "example" : "XXX周年庆红包" }, "end_time" : { "type" : "string", "description" : "活动结束时间,必须大于活动开始时间, 基本格式:yyyy-MM-dd HH:mm:ss,活动有效时间最长为6个月，过期后需要创建新的活动。", "example" : "2016-09-20 22:48:30" }, "merchant_link" : { "type" : "string", "description" : "商户打款后的跳转链接，从支付宝收银台打款成功后的跳转链接。不填时，打款后停留在支付宝支付成功页。商户实际跳转会自动添加crowdNo作为跳转参数。示例: http://www.yourhomepage.com?crowdNo=XXX", "example" : "http://www.weibo.com" }, "prize_msg" : { "type" : "string", "description" : "活动文案，用户在账单、红包中看到的账单描述、红包描述。", "example" : "XXX送您大红包" }, "prize_type" : { "type" : "string", "description" : "现金红包的发放形式,。枚举支持：\t*fixed：固定金额。\t*random：随机金额。选择随机金额时，单个红包的金额在平均金额的0.5~1.5倍之间浮动。\t", "example" : "random" }, "send_freqency" : { "type" : "string", "description" : "用户在当前活动参与次数、频率限制。支持日(D)、周(W)、月(M)、终身(L)维度的限制，整个字段不填时默认值为L1（即用户终生仅能参与1次）。\t注意：\t 1. 终身(L)限制必选且最大值为 100。\t 2. 日(D)、周(W)、月(M)限制可选且最多只能选择一个（即限制日领取次数就不能再限制月领取次数），频率设置必须小于等于终身(L)的次数。\t 3. 多个配置之间使用\"|\"进行分隔。如 D3|L4（表示限制用户终生只能参与4次，单日只能参与3次）。\t 4. 允许多次领取时，活动触发接口需要传入out_biz_no来配合。", "example" : "D3|L10" }, "start_time" : { "type" : "string", "description" : "活动开始时间，必须大于活动创建的时间。入参支持如下两种形式：\t 1. 填入固定时间，时间格式为 yyyy-MM-dd HH:mm:ss，如 2020-12-10 22:28:30\t 2. 填字符串 NowTime，表示创建即生效。", "example" : "NowTime" }, "total_money" : { "type" : "string", "description" : "活动发放的现金总金额,最小金额1.00元,最大金额10000000.00元。每个红包的最大金额不允许超过200元,最小金额不得低于0.20元。 实际的金额限制可能会根据业务进行动态调整。", "example" : "10000000.00" }, "total_num" : { "type" : "string", "description" : "红包发放个数，最小为 1 个，最大10000000个。\t说明：不同的发放形式（即prize_type）会使得发放个数含义不同：\t 1. 若prize_type 为 fixed（固定金额），则每个用户领取的红包金额为total_money除以total_num得到固定金额。\t 2. 若prize_type为 random（随机金额），则每个用户领取的红包金额为total_money除以total_num得到的平均金额值的0.5~1.5倍。由于金额是随机的，在红包金额全部被领取完时，有可能total_num有所剩余、或者大于设置值的情况。", "example" : "1000" } } }, "AlipayMarketingCampaignCashCreateResponseModel" : { "type" : "object", "properties" : { "crowd_no" : { "type" : "string", "description" : "生成的现金红包活动号", "example" : "EPOJZsBg3A-CZOJE4qlbAueA7By4oJLDwEeYZlAiAnbMnSZ96O-zxUfKlHp5cxmx" }, "origin_crowd_no" : { "type" : "string", "description" : "原始活动号,商户排查问题时提供的活动依据", "example" : "20160901109410190092922300444004" }, "pay_url" : { "type" : "string", "description" : "活动创建后的付款链接，返回的是urlencode编码后的字符串。需要先进行urldecode解码，然后在浏览器中进行访问，会先进行支付宝登录引导，然后商户进行付款，付款有效期24小时。", "example" : "http%3a%2f%2fcashier.stable.alipay.net%2fstandard%2flightpay%2flightPayCashier.htm%3forderId%3d0826e2e3984d6fa7b92046.rz0NN4263%" } } }, "AlipayMarketingCampaignCashDetailQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "UNKNOW_SYSTEM_ERROR", "CASH_CAMPAIGN_NOT_EXIST", "BIZ_CONTENT_IS_EMPTY", "BIZ_CONTENT_FORMAT_ERROR", "PRODUCT_IS_NOT_OPENED", "CALL_TOO_FREQUENCY", "CAMP_OPERATOR_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingCampaignCashDetailQueryResponseModel" : { "type" : "object", "properties" : { "camp_status" : { "type" : "string", "description" : "活动状态，CREATED: 已创建未打款\tPAID:已打款\tREADY:活动已开始\tPAUSE:活动已暂停\tCLOSED:活动已结束\tSETTLED:活动已清算", "example" : "CREATED、PAID、READY、PAUSE、CLOSED、SETTLED" }, "coupon_name" : { "type" : "string", "description" : "红包名称", "example" : "XXX周年庆红包" }, "crowd_no" : { "type" : "string", "description" : "活动号", "example" : "POYb84lfiKVdIfERAYsqPL_KQRIpfQbl47xfRmmPBlDMnSZ96O-zxUfKlHp5cxmx" }, "end_time" : { "type" : "string", "description" : "活动结束时间", "example" : "2016-08-10 22:28:30" }, "origin_crowd_no" : { "type" : "string", "description" : "原始活动号,商户排查问题时提供的活动依据", "example" : "20160901029410190092922308762004" }, "prize_msg" : { "type" : "string", "description" : "活动文案,用户在账单中看到的红包描述", "example" : "XX送您大红包" }, "prize_type" : { "type" : "string", "description" : "现金红包的发放形式, fixed为固定金额,random为随机金额", "example" : "random" }, "send_amount" : { "type" : "string", "description" : "活动已发放金额", "example" : "200000.00" }, "start_time" : { "type" : "string", "description" : "活动开始时间", "example" : "2016-08-10 22:28:30" }, "total_amount" : { "type" : "string", "description" : "活动总金额", "example" : "20000.00" }, "total_count" : { "type" : "integer", "description" : "红包总个数", "example" : "1000" }, "total_num" : { "type" : "integer", "description" : "红包总个数(废弃)", "example" : "1000" } } }, "AlipayMarketingCampaignCashListQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "BIZ_CONTENT_IS_EMPTY", "CASH_LIST_PAGE_CHECK_FAILED", "BIZ_CONTENT_FORMAT_ERROR", "CALL_TOO_FREQUENCY", "PRODUCT_IS_NOT_OPENED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingCampaignCashListQueryResponseModel" : { "type" : "object", "properties" : { "camp_list" : { "type" : "array", "description" : "活动列表", "items" : { "$ref" : "#/components/schemas/CashCampaignInfo" } }, "page_index" : { "type" : "string", "description" : "分页的页码,起始从1开始", "example" : "1" }, "page_size" : { "type" : "string", "description" : "分页每页大小", "example" : "10" }, "total_size" : { "type" : "string", "description" : "活动总个数", "example" : "20" } } }, "AlipayMarketingCampaignCashStatusModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "UNKNOW_SYSTEM_ERROR", "CASH_CURRENT_STATE_CANNOT_MODIFY", "CASH_TARGET_STATE_NOT_ILLEGAL", "CASH_CAMPAIGN_NOT_EXIST", "BIZ_CONTENT_IS_EMPTY", "BIZ_CONTENT_FORMAT_ERROR", "PRODUCT_IS_NOT_OPENED", "CALL_TOO_FREQUENCY", "CAMPAIGN_CREATE_OVER_LIMIT", "CAMP_OPERATOR_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingCampaignCashStatusModifyModel" : { "type" : "object", "properties" : { "camp_status" : { "type" : "string", "description" : "金活动修改后的状态。支持修改为：\t*PAUSE：活动暂停。\t*READY：活动开始。\t*CLOSED：活动结束。", "example" : "PAUSE" }, "crowd_no" : { "type" : "string", "description" : "现金活动号，通过alipay.marketing.campaign.cash.create(创建现金活动)接口创建现金活动获取。", "example" : "HHV-vl7IKtHddoWgpHTOdL_KQRIpfQbl47xfRmmPBlDMnSZ96O-zxUfKlHp5cxmx" } } }, "AlipayMarketingCampaignCashStatusModifyResponseModel" : { "type" : "object" }, "AlipayMarketingCampaignCashTriggerErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "BIZ_CONTENT_IS_EMPTY", "BIZ_CONTENT_FORMAT_ERROR", "PRODUCT_IS_NOT_OPENED", "CASH_CROWD_NO_ILLEGAL", "CASH_CAMPAIGN_NOT_EXIST", "CASH_CAMPAIGN_NOT_START", "CASH_CAMPAIGN_IS_OVER", "CASH_CAMP_BUDGET_INSUFFICIENT", "CASH_CAMP_NOT_ALLOW_TRIGGER_OWN", "CASH_CAMPAIGN_SEND_LOG_ILLEGAL", "UNKNOW_SYSTEM_ERROR", "USER_ID_ILLEGAL", "USER_NOT_EXIST", "ENTERPRISE_USER_NOT_SUPPORT", "CASH_CAMPAIGN_EMERGENCY_STOP", "CAMP_OPERATOR_ILLEGAL", "CTU_HAS_RISK", "USER_ACCESS_TOTAL_LIMIT", "USER_ACCESS_FREQUENCY_LIMIT", "OUT_BIZ_NO_ILLEGAL", "CALL_TOO_FREQUENCY", "USER_CERT_NOT_PASS" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingCampaignCashTriggerModel" : { "type" : "object", "properties" : { "crowd_no" : { "type" : "string", "description" : "现金活动号，通过alipay.marketing.campaign.cash.create(创建现金活动)接口创建现金活动获取。", "example" : "3DpriXtAGxmDPi7QyeoKeX8wwS3qbKCcnigowys220Lxs" }, "login_id" : { "type" : "string", "description" : "用户登录账号名，一般为邮箱或手机号。\t注意：user_id与login_id二选一必填，同时传入时以user_id为准。", "example" : "username@gmail.com" }, "open_id" : { "type" : "string", "description" : "open_id", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "order_price" : { "type" : "string", "description" : "此字段如果传入金额，就忽略prize_type算法，按照传入的金额发奖。如果不传或者小于等于0，则按照活动创建时指定的prize_type为fixed或者random算法发奖", "example" : "100，单位为分，代表1元" }, "out_biz_no" : { "type" : "string", "description" : "领取红包的外部业务号，只由可由字母、数字、下划线组成。同一个活动中不可重复，相同的外部业务号会被幂等并返回之前的结果。不填时，系统会生成一个默认固定的外部业务号。", "example" : "201702101356" }, "user_id" : { "type" : "string", "description" : "用户支付宝唯一标识，2088开头。\t注意：user_id与login_id二选一必填，同时传入时以user_id为准。", "example" : "2088102164186692" } } }, "AlipayMarketingCampaignCashTriggerResponseModel" : { "type" : "object", "properties" : { "biz_no" : { "type" : "string", "description" : "支付宝业务号,发奖成功时返回,调用者可提供此字符串进行问题排查与核对等", "example" : "20170117110070001502640004976114" }, "coupon_name" : { "type" : "string", "description" : "红包名称,创建活动时设置，用于账单列表和详情、红包列表和详情的展示", "example" : "***周年庆红包" }, "error_msg" : { "type" : "string", "description" : "用户领取失败的错误信息描述", "example" : "用户实名验证不通过" }, "merchant_logo" : { "type" : "string", "description" : "商户头像logo的图片url地址，用于账单和红包列表、详情的展示", "example" : "http://tfs.alipay.com/images/partner/1111111xxxxxxx_160x160" }, "out_biz_no" : { "type" : "string", "description" : "外部业务号,回填请求中的out_biz_no,请求参数中传了out_biz_no就会回传回去，如果不传就回传默认的\"default_out_biz_no\"，请求者可用于日志记录与核对等", "example" : "2017021319450001" }, "partner_id" : { "type" : "string", "description" : "发送红包商户签约pid，发奖成功时非空", "example" : "2088123456789012" }, "prize_amount" : { "type" : "string", "description" : "现金红包金额，发奖成功时非空，单位为元，保留两位小数", "example" : "234.40" }, "prize_msg" : { "type" : "string", "description" : "活动文案,用于账单的备注展示、红包详情页的文案展示", "example" : "XXX送您大红包,祝您中秋快乐" }, "repeat_trigger_flag" : { "type" : "string", "description" : "用户是否重复领取，如果重复领取，返回的是之前的中奖结果，如果是首次领取，则走发奖流程", "example" : "true或false" }, "trigger_result" : { "type" : "string", "description" : "是否中奖结果状态，取值为true或false。如果为true表示发奖成功，这时返回的结果中的其他字段非空；如果为false表示发奖失败，这时返回的其他字段为空", "example" : "true" } } }, "AlipayMarketingCampaignOrderVoucherConsultErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_ARGUMENT_EXCEPTION", "CONSULT_EXCEPTION" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingCampaignOrderVoucherConsultModel" : { "type" : "object", "properties" : { "business_param" : { "type" : "string", "description" : "业务参数大字段，优惠咨询的控制参数，json格式；目前支持传入useBigAmountSkipOrderThold为N来控制不使用大金额跳过优惠的订单门槛检查；默认不传；", "example" : "{\"useBigAmountSkipOrderThold\":\"N\"}" }, "item_consult_list" : { "type" : "array", "description" : "商品咨询请求列表（当需要咨询单品券时必传，如果某商品不希望参与本次单品优惠咨询则不传递对应信息即可）", "items" : { "$ref" : "#/components/schemas/ItemConsultRequest" } }, "order_amount" : { "type" : "string", "description" : "订单金额（如同时享受商户自有优惠请先扣除后传入），单位为元，最多2位小数", "example" : "120.87" }, "scene_code" : { "type" : "array", "description" : "场景码：默认(DEFAULT)", "items" : { "type" : "string" }, "example" : "[\"DEFAULT\"]" }, "specified_app_id" : { "type" : "string", "description" : "券指定的核销appid（如果配券时指定了核销范围为线上小程序及相应的appid则此处必传）", "example" : "2021001159604390" } } }, "AlipayMarketingCampaignOrderVoucherConsultResponseModel" : { "type" : "object", "properties" : { "optimal_total_promo_amount" : { "type" : "string", "description" : "最优券叠加总优惠金额，单位为元", "example" : "15.50" }, "voucher_consult_list" : { "type" : "array", "description" : "优惠券咨询结果列表", "items" : { "$ref" : "#/components/schemas/VoucherConsultInfo" } } } }, "AlipayMarketingCardActivateformQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "OPEN_PROFILE_QUERY_FAIL", "REQUEST_ID_EXPIRE", "REQUEST_ID_INVALID", "ILLEGAL_NULL_ARGUMENT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingCardActivateformQueryResponseModel" : { "type" : "object", "properties" : { "infos" : { "type" : "string", "description" : "表单提交信息各个字段的值JSON数组\r\t\r\t通用表单字段名称如下示例：\r\tOPEN_FORM_FIELD_MOBILE – 手机号\r\tOPEN_FORM_FIELD_GENDER – 性别\r\tOPEN_FORM_FIELD_NAME – 姓名\r\tOPEN_FORM_FIELD_BIRTHDAY – 生日\r\tOPEN_FORM_FIELD_IDCARD – 身份证\r\tOPEN_FORM_FIELD_EMAIL – 邮箱\r\tOPEN_FORM_FIELD_ADDRESS – 地址\r\t\r\t详细字段名称列表见会员卡开卡表单模板配置接口：alipay.marketing.card.formtemplate.set\r\t\r\t注：\r\t1. 证件类型字段(OPEN_FORM_FIELD_CERT_TYPE)返回结果取值如下:\r\t 0 -- 身份证\r\t 1 -- 护照\r\t 2 -- 港澳居民通行证\r\t 3 -- 台湾居民通行证", "example" : "[{\"OPEN_FORM_FIELD_GENDER\":\"男\"},{\"OPEN_FORM_FIELD_MOBILE\":\"13888888888\"},{\"OPEN_FORM_FIELD_NAME\":\"李四\"}]" } } }, "AlipayMarketingCardActivateurlApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "CARD_TEMPLATE_NOT_EXIST", "OPEN_FORM_TEMPLATE_NOT_EXIST", "ILLEGAL_ARGUMENT_OUT_STRING", "ILLEGAL_NULL_ARGUMENT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingCardActivateurlApplyModel" : { "type" : "object", "properties" : { "callback" : { "type" : "string", "description" : "会员卡开卡表单提交后回调地址。要求必须是单纯的服务端接收回调。\t说明：\t1.该地址不可带参数，如需回传参数，可设置out_string入参。", "example" : "https://alipay.com/card/demo.htm" }, "follow_app_id" : { "type" : "string", "description" : "需要关注的生活号AppId。若需要在领卡页面展示“关注生活号”提示，需开通生活号并绑定会员卡。生活号快速接入详见：https://doc.open.alipay.com/docs/doc.htm?treeId=193&articleId=105933&docType=1", "example" : "20150000000000000" }, "out_string" : { "type" : "string", "description" : "该值为商家拉起开卡组件的传递的 out_string 值。通常可用于区分不同业务场景，禁止将该字段作为开卡流程的必要字段，否则会导致会员推广场景下的入会失败", "example" : "201928393932" }, "template_id" : { "type" : "string", "description" : "会员卡模板id。使用会员卡模板创建接口(alipay.marketing.card.template.create)返回的结果", "example" : "20170228000000000210102000300974" } } }, "AlipayMarketingCardActivateurlApplyResponseModel" : { "type" : "object", "properties" : { "apply_card_url" : { "type" : "string", "description" : "会员卡领卡链接(使用时需URLDecode解码)。商户获取此链接后可投放到服务窗消息、店铺二维码等。", "example" : "https%3A%2F%2Fmemberprod.alipay.com%2Faccount%2Fopenform%2Factivecard.htm%3Fapp_id%3D2017051007191443%26template_id%3D2017053100" } } }, "AlipayMarketingCardBenefitCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "TEMPLATE_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingCardBenefitCreateModel" : { "type" : "object", "properties" : { "mcard_template_benefit" : { "$ref" : "#/components/schemas/McardTemplateBenefit" } } }, "AlipayMarketingCardBenefitCreateResponseModel" : { "type" : "object", "properties" : { "benefit_id" : { "type" : "string", "description" : "权益ID", "example" : "2017040600077000000002409504" } } }, "AlipayMarketingCardBenefitDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "TEMPLATE_NOT_EXIST", "BENEFIT_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingCardBenefitDeleteResponseModel" : { "type" : "object", "properties" : { "result" : { "type" : "boolean", "description" : "权益删除结果；true成功，false失败", "example" : "true" } } }, "AlipayMarketingCardBenefitModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "TEMPLATE_NOT_EXIST", "BENEFIT_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingCardBenefitModifyModel" : { "type" : "object", "properties" : { "benefit_id" : { "type" : "string", "description" : "权益ID，通过 alipay.marketing.card.benefit.create(会员卡模板外部权益创建)接口创建获取。", "example" : "2017040600077000000002409504" }, "mcard_template_benefit" : { "$ref" : "#/components/schemas/McardTemplateBenefit" } } }, "AlipayMarketingCardBenefitModifyResponseModel" : { "type" : "object", "properties" : { "result" : { "type" : "boolean", "description" : "权益修改结果；true成功：false失败", "example" : "true" } } }, "AlipayMarketingCardBenefitQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "TEMPLATE_NOT_EXIST", "BENEFIT_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingCardBenefitQueryResponseModel" : { "type" : "object", "properties" : { "mcard_template_benefit_query" : { "type" : "array", "description" : "会员卡模板外部权益列表", "items" : { "$ref" : "#/components/schemas/McardTemplateBenefitQuery" } } } }, "AlipayMarketingCardConsumeSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "CARD_NOT_EXIT", "NO_CARD_TYPE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingCardConsumeSyncModel" : { "type" : "object", "properties" : { "act_pay_amount" : { "type" : "string", "description" : "用户实际付的现金金额\r\t1.针对预付卡面额的核销金额在use_benefit_list展现，作为权益金额\r\t2.权益金额不叠加在该金额上", "example" : "23.9" }, "card_info" : { "$ref" : "#/components/schemas/MerchantCard" }, "gain_benefit_list" : { "type" : "array", "description" : "获取权益列表", "items" : { "$ref" : "#/components/schemas/BenefitInfoDetail" } }, "memo" : { "type" : "string", "description" : "备注信息，现有直接填写球房信息", "example" : "用户球房充值100" }, "shop_code" : { "type" : "string", "description" : "球房编号", "example" : "201606270000001" }, "swipe_cert_type" : { "type" : "string", "description" : "产生该笔交易时，用户出具的凭证类型。枚举支持：\t*ALIPAY：支付宝电子卡；\t*ENTITY：实体卡；\t*OTHER：其他。", "example" : "ALIPAY" }, "target_card_no" : { "type" : "string", "description" : "支付宝业务卡号，即通过alipay.marketing.card.open(会员卡开卡)接口开卡后获取的 card_info.biz_card_no 值。", "example" : "0000001" }, "target_card_no_type" : { "type" : "string", "description" : "卡号ID类型。支持：\t*BIZ_CARD：支付宝业务卡号（商户会员卡场景使用）。", "example" : "BIZ_CARD" }, "trade_amount" : { "type" : "string", "description" : "交易金额：本次交易的实际总金额（可认为标价金额）", "example" : "67.5" }, "trade_name" : { "type" : "string", "description" : "交易名称。为空时支付宝将根据交易类型提供默认名称。", "example" : "预付卡充值100元" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号", "example" : "201606270000000001" }, "trade_time" : { "type" : "string", "description" : "线下交易时间，为用户付款的交易时间。\t说明：当交易时间晚于上次消费记录同步时间时，将变更会员卡信息。", "example" : "2012-11-22 10:47:20" }, "trade_type" : { "type" : "string", "description" : "交易类型。枚举支持：\t*开卡：OPEN；\t*消费：TRADE；\t*充值：DEPOSIT；\t*退卡：RETURN。", "example" : "DEPOSIT" }, "use_benefit_list" : { "type" : "array", "description" : "实际消耗的权益", "items" : { "$ref" : "#/components/schemas/BenefitInfoDetail" } } } }, "AlipayMarketingCardConsumeSyncResponseModel" : { "type" : "object", "properties" : { "external_card_no" : { "type" : "string", "description" : "外部卡号", "example" : "EXT10000001" } } }, "AlipayMarketingCardDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "CARD_NOT_EXIT", "NO_CARD_TYPE", "CARD_IS_DELETED_ALREADY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingCardDeleteResponseModel" : { "type" : "object", "properties" : { "biz_serial_no" : { "type" : "string", "description" : "支付宝端删卡业务流水号", "example" : "2016062700001" } } }, "AlipayMarketingCardFormtemplateSetErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "CARD_TEMPLATE_NOT_EXIST", "DUPLICATE_FORM_FIELD", "FORM_FIELD_INVALID", "OPEN_FORM_SET_FAIL", "DUPLICATE_BIRTHDAY_FIELD", "DUPLICATE_CERT_NO", "INVALID_CERT_TYPE_AND_NO", "ILLEGAL_NULL_ARGUMENT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingCardFormtemplateSetModel" : { "type" : "object", "properties" : { "fields" : { "$ref" : "#/components/schemas/OpenFormFieldDO" }, "template_id" : { "type" : "string", "description" : "会员卡模板id。调用alipay.marketing.card.template.create（会员卡模板创建接口）创建模板后同步返回。", "example" : "20170228000000000210102000300974" } } }, "AlipayMarketingCardFormtemplateSetResponseModel" : { "type" : "object" }, "AlipayMarketingCardMessageNotifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "CARD_NOT_EXIT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingCardMessageNotifyModel" : { "type" : "object", "properties" : { "notify_info" : { "type" : "string", "description" : "消息通知详情，包含消息通知需要的信息，map 格式存储。\t积分过期提醒：\t
expired_point 过期积分值\t
expired_time 过期时间", "example" : "{\"expired_point\":\"121\"}" }, "notify_no" : { "type" : "string", "description" : "消息通知幂等标识，业务流水号", "example" : "2000000000001" }, "notify_type" : { "type" : "string", "description" : "消息通知类型,\t
POINT_REMIND 积分过期提醒", "example" : "POINT_REMIND" }, "occur_time" : { "type" : "string", "description" : "标识业务发生时间，时间格式为\"yyyy-MM-dd HH:mm:ss\"。", "example" : "2020-12-27 12:12:12" }, "target_card_no" : { "type" : "string", "description" : "支付宝业务卡号，即通过 alipay.marketing.card.open 接口开卡后获取的 card_info.biz_card_no 值。", "example" : "000001" }, "target_card_no_type" : { "type" : "string", "description" : "卡号ID类型。支持： BIZ_CARD：支付宝业务卡号（商户会员卡场景使用）。", "example" : "BIZ_CARD" } } }, "AlipayMarketingCardMessageNotifyResponseModel" : { "type" : "object", "properties" : { "result_code" : { "type" : "string", "description" : "二级错误处理结果（如果公用返回结果为false，则可以看这个接口判断明细原因） 如果公用返回为true，则该字段为空", "example" : "isv.update-usercard-fail" } } }, "AlipayMarketingCardOpenErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "TEMPLATE_NOT_EXIT", "NO_CARD_TYPE", "OPEN_CARD_NEED_OPENFORM", "OPEN_CARD_CONCURRENTLY", "USER_AUTH_FAIL", "CARD_HAS_OPENED", "PAID_OUTER_CARD_LACK_TEMPLATE_CONFIG" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingCardOpenModel" : { "type" : "object", "properties" : { "card_ext_info" : { "$ref" : "#/components/schemas/MerchantCard" }, "card_template_id" : { "type" : "string", "description" : "支付宝分配的卡模板Id（卡模板创建接口返回的模板ID）", "example" : "201606270000001" }, "card_user_info" : { "$ref" : "#/components/schemas/CardUserInfo" }, "member_ext_info" : { "$ref" : "#/components/schemas/MerchantMenber" }, "open_card_channel" : { "type" : "string", "description" : "领卡渠道，用于记录外部商户端领卡来源的渠道信息，渠道值可自行定义（仅限数字、字母、下划线） \r\t可直接标识领卡渠道，也可配合open_card_channel_id标识领卡渠道类型：\r\t例如：\r\t线下球房领取:20161534000000000008863（直接标识领卡渠道，球房shopId）\r\t线下扫二维码领取:QR（标识领卡类型）;\r\t线下活动领取:20170522000000000003609（直接标识领卡渠道，商户活动ID）", "example" : "20161534000000000008863" }, "open_card_channel_id" : { "type" : "string", "description" : "领卡来源的渠道id，注意区别于open_card_channel领卡渠道；\r\t一般使用场景：\r\topen_card_channel用于区分渠道类型，例如取值为\"SHOP\"（球房），\"ACTIVITY\"（活动）；\r\t则open_card_channel_id可用于区分同渠道的不同实体，对应取各球房ID或各活动的标识ID等；", "example" : "123123123123" }, "out_serial_no" : { "type" : "string", "description" : "外部商户流水号。由商户自定义，需保证商户系统中唯一。", "example" : "201606270000001" }, "paid_outer_card_info" : { "$ref" : "#/components/schemas/PaidOuterCardExtraInfoDTO" } } }, "AlipayMarketingCardOpenResponseModel" : { "type" : "object", "properties" : { "card_info" : { "$ref" : "#/components/schemas/MerchantCard" }, "open_card_channel" : { "type" : "string", "description" : "实际记录的领卡渠道（可能跟商户传入值不同）；\r\t可直接标识领卡渠道，也可配合open_card_channel_id标识领卡渠道类型：\r\t例如：\r\t线下球房领取:20161534000000000008863（直接标识领卡渠道，球房shopId）\r\t线下扫二维码领取:QR（标识领卡类型）;\r\t线下活动领取:20170522000000000003609（直接标识领卡渠道，商户活动ID）", "example" : "QR" }, "open_card_channel_id" : { "type" : "string", "description" : "实际记录的领卡来源渠道id（可能跟商户传入值不同）；\r\t区别于open_card_channel领卡渠道；\r\t一般使用场景：\r\topen_card_channel用于区分渠道类型，例如取值为\"SHOP\"（球房），\"ACTIVITY\"（活动）；\r\t则open_card_channel_id可用于区分同渠道的不同实体，对应取各球房ID或各活动的标识ID等；", "example" : "123123123123" } } }, "AlipayMarketingCardQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "CARD_NOT_EXIT", "NO_CARD_TYPE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingCardQueryModel" : { "type" : "object", "properties" : { "card_user_info" : { "$ref" : "#/components/schemas/CardUserInfo" }, "ext_info" : { "type" : "string", "description" : "扩展信息，暂时没有", "example" : "\"\"" }, "target_card_no" : { "type" : "string", "description" : "操作卡号。\t若target_card_no_type为 BIZ_CARD，则该值为业务卡号，即alipay.marketing.card.open(会员卡开卡)返回结果中的card_info#biz_card_no。\t若target_card_no_type为 D_QR_CODE 或D_BAR_CODE，则该值为动态码值。\t若target_card_no_type为 EXTERNAL_CARD，则该值为外部卡号。", "example" : "0000001" }, "target_card_no_type" : { "type" : "string", "description" : "卡号ID类型（会员卡查询，只能提供支付宝端的卡号）\tBIZ_CARD：支付宝卡号\tD_QR_CODE：动态二维码（业务卡号对应的）\tD_BAR_CODE：动态条码（业务卡号对应的）\tEXTERNAL_CARD：外部卡号（业务卡号对应的）", "example" : "BIZ_CARD" } } }, "AlipayMarketingCardQueryResponseModel" : { "type" : "object", "properties" : { "card_info" : { "$ref" : "#/components/schemas/MerchantCard" }, "paid_outer_card_info" : { "$ref" : "#/components/schemas/PaidOuterCardExtraInfoDTO" }, "pass_id" : { "type" : "string", "description" : "商家会员卡页面跳转到支付宝卡券详情页的pass_id，对应schema地址中的参数p，\t主要用于小程序跳往会员卡详情的链接拼接", "example" : "21942125" }, "schema_url" : { "type" : "string", "description" : "商家会员卡页面跳转到支付宝卡券详情页面的schema地址", "example" : "alipays://platformapi/startapp?appId=20000021&b=m&p=111" } } }, "AlipayMarketingCardTemplateBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingCardTemplateBatchqueryModel" : { "type" : "object", "properties" : { "page_no" : { "type" : "integer", "description" : " 查询起始页码，第一页为 1。", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "每页数据大小，默认 20条，最大支持20条。", "example" : "20" } } }, "AlipayMarketingCardTemplateBatchqueryResponseModel" : { "type" : "object", "properties" : { "mcard_template" : { "type" : "array", "description" : "会员卡模板基本信息", "items" : { "$ref" : "#/components/schemas/McardTemplate" } }, "template_total" : { "type" : "integer", "description" : "会员卡模板总数", "example" : "10" } } }, "AlipayMarketingCardTemplateCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "TEMPLATE_NOT_EXIT", "NO_CARD_TYPE", "TEMPLATE_OVER_LIMIT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingCardTemplateCreateModel" : { "type" : "object", "properties" : { "biz_no_prefix" : { "type" : "string", "description" : "业务卡号前缀，由商户指定\r\t支付宝业务卡号生成规则：biz_no_prefix(商户指定)卡号前缀 + biz_no_suffix(实时生成）卡号后缀", "example" : "prex" }, "biz_no_suffix_len" : { "type" : "string", "description" : "业务卡号后缀长度，与biz_no_prefix配合，扣除系统预留2位，剩下对应seq长度。在生成卡号时，若seq位数不足前置补0，若seq位数超出则以实际为准。举例：设为10，其中8位用于生成seq，可覆盖1亿用户，即使seq超过1亿，生成卡号也不报错，但总长度不得超过32位。建议按需设置合适的值，以获得长度一致的业务卡号，建议长度20，性能更好。", "example" : "20" }, "card_action_list" : { "type" : "array", "description" : "卡行动点配置；\t行动点，即用户可点击跳转的区块，类似按钮控件的交互；\t单张卡最多定制3个行动点。如果各项的配置内容完全一样，展示时会进行去重。", "items" : { "$ref" : "#/components/schemas/TemplateActionInfoDTO" } }, "card_level_conf" : { "type" : "array", "description" : "卡级别配置", "items" : { "$ref" : "#/components/schemas/TemplateCardLevelConfDTO" } }, "card_spec_tag" : { "type" : "string", "description" : "卡特定标签，只供特定业务使用，通常接入无需关注", "example" : "NONE" }, "card_type" : { "type" : "string", "description" : "卡类型。可选类型如下：\tOUT_MEMBER_CARD：外部权益卡", "example" : "OUT_MEMBER_CARD" }, "column_info_list" : { "type" : "array", "description" : "栏位信息", "items" : { "$ref" : "#/components/schemas/TemplateColumnInfoDTO" } }, "field_rule_list" : { "type" : "array", "description" : "字段规则列表，会员卡开卡过程中，会员卡信息的生成规则，\r\t例如：卡有效期为开卡后两年内有效，则设置为：DATE_IN_FUTURE", "items" : { "$ref" : "#/components/schemas/TemplateFieldRuleDTO" } }, "mdcode_notify_conf" : { "$ref" : "#/components/schemas/TemplateMdcodeNotifyConfDTO" }, "notify_url" : { "type" : "string", "description" : "通知地址" }, "open_card_conf" : { "$ref" : "#/components/schemas/TemplateOpenCardConfDTO" }, "paid_outer_card_conf" : { "$ref" : "#/components/schemas/PaidOuterCardTemplateConfDTO" }, "pub_channels" : { "type" : "array", "description" : "卡模板投放渠道", "items" : { "$ref" : "#/components/schemas/PubChannelDTO" } }, "request_id" : { "type" : "string", "description" : "请求ID，商家自定义且并保证唯一性。", "example" : "2016072600000000000000001" }, "service_label_list" : { "type" : "array", "description" : "服务Code\r\tHUABEI_FUWU：花呗服务（只有需要花呗服务时，才需要加入该标识）", "items" : { "type" : "string" }, "example" : "HUABEI_FUWU" }, "shop_ids" : { "type" : "array", "description" : "会员卡上架球房id（支付宝球房id），即发放会员卡的商家球房id", "items" : { "type" : "string" }, "example" : "2015122900077000000002409504" }, "spi_app_id" : { "type" : "string", "description" : "spi_app_id:若使用openspi模式开卡，该字段必填，为实现spi.alipay.user.opencard.get接口的app_id", "example" : "2021001160639010" }, "template_benefit_info" : { "type" : "array", "description" : "权益信息，\r\t1、在卡包的卡详情页面会自动添加“会员权益”栏位，展现此字段配置的会员卡权益信息，\r\t2、如果添加球房渠道，则可在球房页展现会员卡的权益", "items" : { "$ref" : "#/components/schemas/TemplateBenefitInfoDTO" } }, "template_style_info" : { "$ref" : "#/components/schemas/TemplateStyleInfoDTO" }, "write_off_type" : { "type" : "string", "description" : "卡包详情页面中展现出的卡码（可用于扫码核销）\t\t(1) 静态码\tqrcode: 二维码，扫码得商户开卡传入的external_card_no\tbarcode: 条形码，扫码得商户开卡传入的external_card_no\t\t(2) 动态码-支付宝生成码值(动态码会在2分钟左右后过期)\tdqrcode: 动态二维码，扫码得到的码值可配合会员卡查询接口使用\tdbarcode: 动态条形码，扫码得到的码值可配合会员卡查询接口使用\t\t(3) 动态码-商家自主生成码值（码值、时效性都由商户控制）\tmdqrcode: 商户动态二维码，扫码得商户自主传入的码值\tmdbarcode: 商户动态条码，扫码得商户自主传入的码值\t如需使用商户动态码，对接详情参见 商户动态发码。", "example" : "qrcode" } } }, "AlipayMarketingCardTemplateCreateResponseModel" : { "type" : "object", "properties" : { "template_id" : { "type" : "string", "description" : "支付宝卡模板ID", "example" : "201607180000001" } } }, "AlipayMarketingCardTemplateModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "TEMPLATE_NOT_EXIT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingCardTemplateModifyModel" : { "type" : "object", "properties" : { "biz_no_prefix" : { "type" : "string", "description" : "业务卡号前缀，由商户指定\r\t支付宝业务卡号生成规则：biz_no_prefix(商户指定)卡号前缀 + biz_no_suffix(实时生成）卡号后缀", "example" : "prex" }, "biz_no_suffix_len" : { "type" : "string", "description" : "业务卡号后缀长度，与biz_no_prefix配合，扣除系统预留2位，剩下对应seq长度。在生成卡号时，若seq位数不足前置补0，若seq位数超出则以实际为准。举例：设为10，其中8位用于生成seq，可覆盖1亿用户，即使seq超过1亿，生成卡号也不报错，但总长度不得超过32位。建议按需设置合适的值，以获得长度一致的业务卡号，建议长度20，性能更好。", "example" : "20" }, "card_action_list" : { "type" : "array", "description" : "卡行动点配置；\r\t行动点，即用户可点击跳转的区块，类似按钮控件的交互；\r\t单张卡最多定制4个行动点。", "items" : { "$ref" : "#/components/schemas/TemplateActionInfoDTO" } }, "card_level_conf" : { "type" : "array", "description" : "卡级别配置", "items" : { "$ref" : "#/components/schemas/TemplateCardLevelConfDTO" } }, "card_spec_tag" : { "type" : "string", "description" : "卡特定标签，只供特定业务使用，通常接入无需关注", "example" : "NONE" }, "column_info_list" : { "type" : "array", "description" : "栏位信息（卡包详情页面展现的栏位）", "items" : { "$ref" : "#/components/schemas/TemplateColumnInfoDTO" } }, "field_rule_list" : { "type" : "array", "description" : "字段规则列表，会员卡开卡过程中，会员卡信息的生成规则，\t例如：卡有效期为开卡后两年内有效，则设置为：DATE_IN_FUTURE\t注意：商家会员卡场景不支持修改该内容。\t", "items" : { "$ref" : "#/components/schemas/TemplateFieldRuleDTO" } }, "mdcode_notify_conf" : { "$ref" : "#/components/schemas/TemplateMdcodeNotifyConfDTO" }, "open_card_conf" : { "$ref" : "#/components/schemas/TemplateOpenCardConfDTO" }, "paid_outer_card_conf" : { "$ref" : "#/components/schemas/PaidOuterCardTemplateConfDTO" }, "pub_channels" : { "type" : "array", "description" : "卡模板投放渠道", "items" : { "$ref" : "#/components/schemas/PubChannelDTO" } }, "request_id" : { "type" : "string", "description" : "请求 ID，商户自定义且需确保每次请求唯一。", "example" : "2016072100000000001" }, "shop_ids" : { "type" : "array", "description" : "会员卡上架球房 id（支付宝球房id），即发放会员卡的商家球房id。不传则保持创建模板时信息。\t注意：不支持删除已有shop_id，仅支持新增。", "items" : { "type" : "string" }, "example" : "2015122900077000000002409504" }, "spi_app_id" : { "type" : "string", "description" : "spi_app_id：若使用openspi模式开卡，该字段必填，为实现spi.alipay.user.opencard.get接口的app_id", "example" : "2014072300007148" }, "template_benefit_info" : { "type" : "array", "description" : "权益信息，\r\t1、在卡包的卡详情页面会自动添加权益栏位，展现会员卡特权，\r\t2、如果添加球房渠道，则可在球房页展现会员卡的权益", "items" : { "$ref" : "#/components/schemas/TemplateBenefitInfoDTO" } }, "template_id" : { "type" : "string", "description" : "会员卡模板id。调用alipay.marketing.card.template.create（会员卡模板创建接口）创建模板后同步返回。", "example" : "201607180000001" }, "template_style_info" : { "$ref" : "#/components/schemas/TemplateStyleInfoDTO" }, "write_off_type" : { "type" : "string", "description" : "卡包详情页面中展现出的卡码（可用于扫码核销）\t\t(1) 静态码\tqrcode: 二维码，扫码得商户开卡传入的external_card_no\tbarcode: 条形码，扫码得商户开卡传入的external_card_no\t\t(2) 动态码-支付宝生成码值(动态码会在2分钟左右后过期)\tdqrcode: 动态二维码，扫码得到的码值可配合会员卡查询接口使用\tdbarcode: 动态条形码，扫码得到的码值可配合会员卡查询接口使用\t\t(3) 动态码-商家自主生成码值（码值、时效性都由商户控制）\tmdqrcode: 商户动态二维码，扫码得商户自主传入的码值\tmdbarcode: 商户动态条码，扫码得商户自主传入的码值。\t如需使用商户动态码，请联系支付宝技术支持获取相关文档。", "example" : "qrcode" } } }, "AlipayMarketingCardTemplateModifyResponseModel" : { "type" : "object", "properties" : { "template_id" : { "type" : "string", "description" : "模板ID", "example" : "2016071800000000001" } } }, "AlipayMarketingCardTemplateQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "TEMPLATE_NOT_EXIT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingCardTemplateQueryResponseModel" : { "type" : "object", "properties" : { "biz_no_prefix" : { "type" : "string", "description" : "业务卡号前缀，由商户指定\r\t支付宝业务卡号生成规则：biz_no_prefix(商户指定)卡号前缀 + biz_no_suffix(实时生成）卡号后缀", "example" : "prex" }, "biz_no_suffix_len" : { "type" : "string", "description" : "业务卡号后缀的长度\r\t支付宝业务卡号生成规则：biz_no_prefix(商户指定)卡号前缀 + biz_no_suffix(实时生成）卡号后缀", "example" : "10" }, "card_action_list" : { "type" : "array", "description" : "卡行动点配置；\r\t行动点，即用户可点击跳转的区块，类似按钮控件的交互；\r\t单张卡最多4个行动点。", "items" : { "$ref" : "#/components/schemas/TemplateActionInfoDTO" } }, "card_level_confs" : { "type" : "array", "description" : "卡等级配置", "items" : { "$ref" : "#/components/schemas/TemplateCardLevelConfDTO" } }, "card_spec_tag" : { "type" : "string", "description" : "卡特定标签，只供特定业务使用，通常接入无需关注", "example" : "NONE" }, "card_type" : { "type" : "string", "description" : "会员卡类型：\r\tOUT_MEMBER_CARD：外部权益卡", "example" : "OUT_MEMBER_CARD" }, "column_info_list" : { "type" : "array", "description" : "栏位信息（卡包详情页面展现的栏位）", "items" : { "$ref" : "#/components/schemas/TemplateColumnInfoDTO" } }, "field_rule_list" : { "type" : "array", "description" : "字段规则列表，会员卡开卡过程中，会员卡信息的生成规则，\r\t例如：卡有效期为开卡后两年内有效，则设置为：DATE_IN_FUTURE", "items" : { "$ref" : "#/components/schemas/TemplateFieldRuleDTO" } }, "mdcode_notify_conf" : { "$ref" : "#/components/schemas/TemplateMdcodeNotifyConfDTO" }, "open_card_conf" : { "$ref" : "#/components/schemas/TemplateOpenCardConfDTO" }, "paid_outer_card_conf" : { "$ref" : "#/components/schemas/PaidOuterCardTemplateConfDTO" }, "pub_channels" : { "type" : "array", "description" : "卡模板投放渠道", "items" : { "$ref" : "#/components/schemas/PubChannelDTO" } }, "service_label_list" : { "type" : "array", "description" : "服务标签列表", "items" : { "type" : "string" }, "example" : "Checklater" }, "shop_ids" : { "type" : "array", "description" : "球房ids", "items" : { "type" : "string" }, "example" : "[\"2015122900077000000002409504\"]" }, "spi_app_id" : { "type" : "string", "description" : "spi_app_id：若使用openspi模式开卡，该字段为创建模版时，设置的实现spi.alipay.user.opencard.get接口的app_id", "example" : "2014072300007148" }, "template_benefit_info" : { "type" : "array", "description" : "权益信息，\r\t1、在卡包的卡详情页面会自动添加权益栏位，展现会员卡特权，\r\t2、如果添加球房渠道，则可在球房页展现会员卡的权益", "items" : { "$ref" : "#/components/schemas/TemplateBenefitInfoDTO" } }, "template_style_info" : { "$ref" : "#/components/schemas/TemplateStyleInfoDTO" } } }, "AlipayMarketingCardUpdateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "NO_CARD_TYPE", "CARD_NOT_EXIT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingCardUpdateModel" : { "type" : "object", "properties" : { "card_info" : { "$ref" : "#/components/schemas/MerchantCard" }, "ext_info" : { "type" : "string", "description" : "扩展信息(暂时无用)", "example" : "\"\"" }, "mcard_style_info" : { "$ref" : "#/components/schemas/McardStylInfo" }, "merchant_card_msg_info" : { "$ref" : "#/components/schemas/MerchantCardMsgInfo" }, "notify_messages" : { "type" : "array", "description" : "注意：此字段已废弃。\t卡信息变更通知消息\t1、在列表中定义的消息，才会发送给用户，消息格式一定。\t2、根据卡信息变更情况，一次可发送多个消息", "items" : { "$ref" : "#/components/schemas/McardNotifyMessage" } }, "occur_time" : { "type" : "string", "description" : "标识业务发生时间，时间格式为\"yyyy-MM-dd HH:mm:ss\"。", "example" : "2020-12-27 12:12:12" }, "paid_outer_card_info" : { "$ref" : "#/components/schemas/PaidOuterCardExtraInfoDTO" }, "target_card_no" : { "type" : "string", "description" : "支付宝业务卡号，即通过alipay.marketing.card.open(会员卡开卡)接口开卡后获取的 card_info.biz_card_no 值。", "example" : "000001" }, "target_card_no_type" : { "type" : "string", "description" : "卡号ID类型。支持：\tBIZ_CARD：支付宝业务卡号（商家会员卡场景使用）。", "example" : "BIZ_CARD" } } }, "AlipayMarketingCardUpdateResponseModel" : { "type" : "object", "properties" : { "result_code" : { "type" : "string", "description" : "二级错误处理结果（如果公用返回结果为false，则可以看这个接口判断明细原因）\r\t如果公用返回为true，则该字段为空", "example" : "isv.update-usercard-fail" } } }, "AlipayMarketingMaterialCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "MATERIALSPECID_NOT_EXIST", "INVALID_PARAMETER", "MATERIALSPEC_CHECK_FAILED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingMaterialCreateModel" : { "type" : "object", "properties" : { "material_fields" : { "type" : "array", "description" : "素材字段列表，素材提报的具体内容，包含三种类型：图片、文本、链接。图片类型，则根据“图片资源上传接口（https://opendocs.alipay.com/pre-open/02bhlj）”中返回的resource_id字段值进行素材字段的设值。文本或链接类型，则按照实际需要设值即可，需满足具体的规范要求。规范要求详情请参见产品文档。", "items" : { "$ref" : "#/components/schemas/MaterialField" } }, "material_name" : { "type" : "string", "description" : "素材名称，接入方自行生成，建议命名时遵循一定的规律以方便管理。", "example" : "测试素材名称" }, "material_spec_id" : { "type" : "string", "description" : "素材规范ID，用于标识具体场景下的素材规范，根据具体的使用场景获取对应的素材规范ID。", "example" : "2019041301000200000077970001" }, "out_biz_no" : { "type" : "string", "description" : "外部业务单号，用作幂等控制，相同单号会返回上一次的结果，接入方需保证单号唯一。", "example" : "21ba1e1c16456985463242192e4d" } } }, "AlipayMarketingMaterialCreateResponseModel" : { "type" : "object", "properties" : { "material_id" : { "type" : "string", "description" : "素材id", "example" : "2019070100903002019700470001" } } }, "AlipayMarketingMaterialImageUploadErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "FILE_SIZE_OUT_OF_RANGE", "PIC_SUFFIX_ILLEGAL", "FILE_TYPE_ERROR", "MATERIAL_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingMaterialImageUploadModel" : { "type" : "object", "properties" : { "belong_merchant_info" : { "$ref" : "#/components/schemas/BelongMerchantInfo" }, "file_key" : { "type" : "string", "description" : "文件业务标识。\t\t枚举值\talipay.marketing.activity.delivery.create接口中\tdelivery_base_info.delivery_material.delivery_single_material.delivery_image\t当delivery_booth_code=PUBLIC_UNION，上传图片接口需指定file_key=PUBLIC_UNION_CHANNEL_PIC。上传图片尺寸600*600，支持格式：png、jpg、jpeg、bmp，大小不超过200kb；\t当delivery_booth_code=PAYMENT_RESULT，上传图片接口需指定file_key=DELIVERY_CHANNEL_PIC。上传图片尺寸600*600，支持格式：png、jpg、jpeg、bmp，大小不超过200kb。\t上传图片更多要求参考文档： https://render.alipay.com/p/c/18tpirlg12e8?operateFrom=BALIPAY\t\talipay.marketing.activity.ordervoucher.create接口中\tvoucher_display_info.brand_logo字段,file_key=PROMO_BRAND_LOGO，上传图片尺寸600*600，支持格式：png、jpg、jpeg、bmp，大小不超过2MB\tvoucher_display_info.voucher_image字段,file_key=PROMO_VOUCHER_IMAGE,上传图片尺寸600*600，支持格式：png、jpg、jpeg、bmp，大小不超过2MB", "example" : "PROMO_VOUCHER_IMAGE" }, "merchant_access_mode" : { "type" : "string", "description" : "商户接入模式\t\t枚举值\tSELF_MODE 商户自接入模式\tAGENCY_MODE 服务商代接入模式", "example" : "SELF_MODE" } } }, "AlipayMarketingMaterialImageUploadResponseModel" : { "type" : "object", "properties" : { "resource_enhance" : { "type" : "boolean", "description" : "图片是否优化过。系统会根据要求，若上传的图片不符合要求的尺寸，会对上传的图片做尺寸的优化。", "example" : "false" }, "resource_id" : { "type" : "string", "description" : "图片唯一资源ID", "example" : "adeDSktiQO-u5vJUqVbcQwAAACMAAQED" }, "resource_url" : { "type" : "string", "description" : "上传后图片的url地址", "example" : "https://mdn.alipayobjects.com/afts/img/A*o-BSQa2Pnq4mIFdCjUnmqAAAARwnAQ/original?bz=promo_merchant" } } }, "AlipayMarketingRecruitEnrollCloseErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingRecruitEnrollCloseModel" : { "type" : "object", "properties" : { "enroll_id" : { "type" : "string", "description" : "报名ID", "example" : "2021042101000200000001330047" } } }, "AlipayMarketingRecruitEnrollCloseResponseModel" : { "type" : "object" }, "AlipayMarketingRecruitEnrollCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingRecruitEnrollCreateModel" : { "type" : "object", "properties" : { "enroll_info" : { "$ref" : "#/components/schemas/RecruitEnrollInfo" }, "enroll_scene_type" : { "type" : "string", "description" : "活动报名场景配置。\t枚举值：\tVOUCHER：券报名场景的报名；\tMINI_APP：小程序报名场景的报名；", "example" : "VOUCHER" }, "out_biz_no" : { "type" : "string", "description" : "外部操作流水号。由商家/ISV 自定义，仅支持字母、数字、下划线且需保证每次操作唯一。", "example" : "21ba1e1c16456985463242192e4d" }, "plan_id" : { "type" : "string", "description" : "要报名的招商方案ID", "example" : "2021041301000200000077974217" } } }, "AlipayMarketingRecruitEnrollCreateResponseModel" : { "type" : "object", "properties" : { "enroll_id" : { "type" : "string", "description" : "报名ID", "example" : "2021041301000200000077974217" }, "out_biz_no" : { "type" : "string", "description" : "外部操作流水号。由商家/ISV 自定义，仅支持字母、数字、下划线且需保证每次操作唯一。", "example" : "21ba1e1c16456985463242192e4d" } } }, "AlipayMarketingRecruitEnrollQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingRecruitEnrollQueryResponseModel" : { "type" : "object", "properties" : { "enroll_id" : { "type" : "string", "description" : "报名ID", "example" : "2021041301000200000000000000" }, "enroll_info" : { "$ref" : "#/components/schemas/RecruitEnrollInfo" }, "enroll_scene_type" : { "type" : "string", "description" : "报名所属的活动报名场景。\t枚举值： VOUCHER：属于券报名场景；\tMINI_APP：属于小程序报名场景；", "example" : "VOUCHER" }, "enroll_time" : { "type" : "string", "description" : "报名时间", "example" : "2020-10-10 10:10:10" }, "memo" : { "type" : "string", "description" : "备注字段", "example" : "报名审核不通过" }, "out_biz_no" : { "type" : "string", "description" : "外部操作流水号。由商家/ISV 自定义，仅支持字母、数字、下划线且需保证每次操作唯一。", "example" : "21ba1e1c16456985463242192e4d" }, "plan_id" : { "type" : "string", "description" : "招商方案ID", "example" : "2021041301000200000000000000" }, "status" : { "type" : "string", "description" : "报名状态： AUDITING 审核中； ENABLED 通过 ； REJECTED 不通过 ； CLOSING 下线审核中 ； CLOSED 已下线；", "example" : "ENABLED" } } }, "AlipayMarketingRecruitPlanQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "BUSINESS_FAILED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingRecruitPlanQueryModel" : { "type" : "object", "properties" : { "enroll_merchant" : { "$ref" : "#/components/schemas/RecruitEnrollMerchant" }, "plan_id" : { "type" : "string", "description" : "招商方案ID", "example" : "2021042001000100000000668277" } } }, "AlipayMarketingRecruitPlanQueryResponseModel" : { "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "招商方案描述：富文本内容，可能包含html标签", "example" : "

招商规则说明

" }, "enroll_end_time" : { "type" : "string", "description" : "报名结束时间", "example" : "2021-01-01 01:01:01" }, "enroll_rules" : { "type" : "array", "description" : "招商报名规则。\t说明：\t1. 查询到的规则将用于 alipay.marketing.recruit.enroll.create(招商报名提交)接口。\t2. enroll_rules.required 为 true 时，enroll_rules.type 对应的内容类型在报名提交时必填。", "items" : { "$ref" : "#/components/schemas/RecruitEnrollRule" } }, "enroll_scene_type" : { "type" : "string", "description" : "招商方案所属报名场景 枚举值： VOUCHER：券报名场景； MINI_APP：小程序报名场景；", "example" : "VOUCHER" }, "enroll_start_time" : { "type" : "string", "description" : "报名开始时间", "example" : "2021-01-01 01:01:01" }, "logo" : { "type" : "string", "description" : "方案头图链接，150x150 以上尺寸的方形图片", "example" : "https://xxxx" }, "plan_id" : { "type" : "string", "description" : "招商方案ID", "example" : "2021042001000100000000668277" }, "plan_name" : { "type" : "string", "description" : "招商方案名称", "example" : "招商方案名称" }, "status" : { "type" : "string", "description" : "方案状态: 不可用:DISABLED;可用:ENABLED", "example" : "ENABLED" } } }, "AlipayMarketingRecruitPlanlistQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "BUSINESS_FAILED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingRecruitPlanlistQueryModel" : { "type" : "object", "properties" : { "enroll_merchant" : { "$ref" : "#/components/schemas/RecruitEnrollMerchant" }, "enroll_scene_type" : { "type" : "string", "description" : "活动报名场景配置。 \t枚举值：\tVOUCHER：券报名场景查询；\tMINI_APP：小程序报名场景查询；\tVOUCHER,MINI_APP：同时进行券报名场景和小程序报名场景的查询；", "example" : "VOUCHER" }, "page_num" : { "type" : "integer", "description" : "第几页，默认1（需要在1和999之间）", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "每页记录条数，默认20，需要在1和100之间", "example" : "20" } } }, "AlipayMarketingRecruitPlanlistQueryResponseModel" : { "type" : "object", "properties" : { "data" : { "type" : "array", "description" : "方案列表", "items" : { "$ref" : "#/components/schemas/RecruitPlanLight" } }, "page_num" : { "type" : "integer", "description" : "第几页，默认1（从1开始计数）", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "每页记录条数，默认20", "example" : "20" }, "total" : { "type" : "integer", "description" : "总数", "example" : "15" } } }, "AlipayMarketingXuanyitestTransferErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMarketingXuanyitestTransferModel" : { "type" : "object", "properties" : { "test" : { "type" : "array", "description" : "测试的基础描述", "items" : { "type" : "string" }, "example" : "[\"11\",\"12\"]" }, "test_21" : { "type" : "array", "description" : "测试复杂类型描述", "items" : { "$ref" : "#/components/schemas/Marketingtest" } }, "test_22" : { "$ref" : "#/components/schemas/Marketingtestt" } } }, "AlipayMarketingXuanyitestTransferResponseModel" : { "type" : "object", "properties" : { "test" : { "type" : "array", "description" : "12", "items" : { "type" : "string" }, "example" : "[\"11\",\"12\"]" }, "test_21" : { "type" : "array", "description" : "测试复杂类型描述", "items" : { "$ref" : "#/components/schemas/Marketingtest" } } } }, "AlipayMerchantAnchorInfoQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "NO_ACCESS_TO_MESSAGE", "APPID_NOT_AUTHENTICATION", "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMerchantAnchorInfoQueryResponseModel" : { "type" : "object", "properties" : { "anchor_id" : { "type" : "string", "description" : "主播ID+唯一+天猫好房带货+根据uid获取", "example" : "2242419387" } } }, "AlipayMerchantImageUploadErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "IMAGE_SIZE_OVERRANGE", "PARAM_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMerchantImageUploadModel" : { "type" : "object", "properties" : { "image_type" : { "type" : "string", "description" : "图片格式，支持格式：jpg、jpeg、png", "example" : "jpg" } } }, "AlipayMerchantImageUploadResponseModel" : { "type" : "object", "properties" : { "image_id" : { "type" : "string", "description" : "图片在文件存储平台的标识", "example" : "ySYHS5CtTCmag14Wk8jeNAAAACMAAQED" } } }, "AlipayMerchantIndirectAuthorderCloseErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_PARAMETER", "AUTH_ORDER_NOT_EXIST", "DEPEND_FAILURE", "AUTH_ORDER_CANCEL_ILLEGAL", "AUTH_ORDER_CANCEL_FAILED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMerchantIndirectAuthorderCloseModel" : { "type" : "object", "properties" : { "order_no" : { "type" : "string", "description" : "意愿申请单号，参数二选一", "example" : "20220000666660001" }, "out_biz_no" : { "type" : "string", "description" : "外部业务号，参数二选一，业务自定义，保证唯一", "example" : "0000001" } } }, "AlipayMerchantIndirectAuthorderCloseResponseModel" : { "type" : "object" }, "AlipayMerchantIndirectAuthorderCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "AUTH_IDENTITY_TYPE_ILLEGAL", "AUTH_ORDER_CREATE_FAILED", "AUTH_ORDER_ISV_HAS_RISK", "DEPEND_FAILURE", "CREATE_ORDER_INFO_FAIL", "SERVICE_UNAVAILABLE", "INVALID_PARAMETER", "LEGAL_PERSON_NAME_NOT_EQUAL", "BIZ_CERT_ILLEGAL_CERT_NO" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMerchantIndirectAuthorderCreateModel" : { "type" : "object", "properties" : { "auth_identity_info" : { "$ref" : "#/components/schemas/AuthIdentityInfo" }, "benefit_person_info" : { "$ref" : "#/components/schemas/IndirectBenefitPersonInfo" }, "contact_person_info" : { "$ref" : "#/components/schemas/IndirectContactPersonInfo" }, "extra_credentials" : { "$ref" : "#/components/schemas/IndirectExtraCredentials" }, "legal_person_info" : { "$ref" : "#/components/schemas/IndirectLegalPersonInfo" }, "out_biz_no" : { "type" : "string", "description" : "外部业务号", "example" : "00000001" }, "source" : { "type" : "string", "description" : "1. 收单机构调用API提交申请单时，可选择是否指定单个服务商范围。非收单机构无需填写此字段。\t2. 此字段填写单个服务商pid信息：填写（即：单服务商提交认证方式），查询申请单返回的认证二维码qr_code和填写服务商对应，仅能认证填写服务商下的商户；不填写（即：全服务商提交认证方式），查询申请单返回的认证二维码qr_code和收单机构对应，可认证收单机构下全部商户。", "example" : "2088000000000001" } } }, "AlipayMerchantIndirectAuthorderCreateResponseModel" : { "type" : "object", "properties" : { "order_no" : { "type" : "string", "description" : "申请单号", "example" : "20001101" }, "order_status" : { "type" : "string", "description" : "意愿申请单状态，枚举值：审核中(AUDITING)、待联系人确认（CONTACT_CONFIRM），待法人确认（LEGAL_CONFIRM）、审核通过(AUDIT_PASS)、审核失败(AUDIT_REJECT)、已冻结(AUDIT_FREEZE)、已撤回(CANCELED)、联系人处理中(CONTACT_PROCESSING)", "example" : "AUDITING" } } }, "AlipayMerchantIndirectAuthorderQuerystatusErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_PARAMETER", "AUTH_ORDER_NOT_EXIST", "DEPEND_FAILURE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMerchantIndirectAuthorderQuerystatusModel" : { "type" : "object", "properties" : { "order_no" : { "type" : "string", "description" : "商家认证申请单号，参数二选一", "example" : "20220000666660001" }, "out_biz_no" : { "type" : "string", "description" : "外部业务号，参数二选一，业务自定义，保证唯一", "example" : "0000001" }, "source" : { "type" : "string", "description" : "1. 收单机构调用API提交申请单时，可选择是否指定单个服务商范围。非收单机构无需填写此字段。\t2. 此字段填写单个服务商pid信息：填写（即：单服务商提交认证方式），查询申请单返回的认证二维码qr_code和填写服务商对应，仅能认证填写服务商下的商户；不填写（即：全服务商提交认证方式），查询申请单返回的认证二维码qr_code和收单机构对应，可认证收单机构下全部商户。", "example" : "2088000000000001" } } }, "AlipayMerchantIndirectAuthorderQuerystatusResponseModel" : { "type" : "object", "properties" : { "order_no" : { "type" : "string", "description" : "商家认证申请单号", "example" : "20220000666660001" }, "order_status" : { "type" : "string", "description" : "商家认证申请单状态，枚举值：审核中(AUDITING)、待联系人确认（CONTACT_CONFIRM），待法人确认（LEGAL_CONFIRM）、审核通过(AUDIT_PASS)、审核失败(AUDIT_REJECT)、已冻结(AUDIT_FREEZE)、已撤回(CANCELED)、联系人处理中（CONTACT_PROCESSING）", "example" : "AUDITING" }, "qr_code" : { "type" : "string", "description" : "商家认证小程序二维码图片链接，申请单状态处于审核通过、待联系人确认、待法人确认、已冻结、审核失败时返回，商户使用支付宝APP扫码后完成后续确认、修改信息等动作。\t此字段是平台生成并返回的二维码码值，通过浏览器访问即可获得一个二维码的图片。服务商在推广过程中，可引导商家使用支付宝APP扫描此二维码，进入认证申请单页面，完成认证申请的后续确认操作。", "example" : "https://qrcode.alipay.com/token/test" }, "verify_list" : { "type" : "array", "description" : "申请单审核失败时的原因描述列表", "items" : { "$ref" : "#/components/schemas/IndirectAuthOrderFailedReason" } } } }, "AlipayMerchantIndirectSmidbindQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_PARAMETER", "DEPEND_FAILURE", "SMID_QUERY_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMerchantIndirectSmidbindQueryResponseModel" : { "type" : "object", "properties" : { "check_result" : { "type" : "string", "description" : "确认状态，枚举：已确认（AUTHORIZED）/未确认（UNAUTHORIZED）/已销户（CLOSED）/smid不存在（SMID_NOT_EXIST）", "example" : "AUTHORIZED" } } }, "AlipayMerchantIotDeviceBindErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "DEVICE_NOT_EXIST", "TRADE_NOT_EXIST", "MERCHANT_ID_UNMATCHED", "SMID_UNMATCHED", "SHOP_ID_UNMATCHED", "BIND_FAIL", "OPERATION_PERMISSION_DENIED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMerchantIotDeviceBindModel" : { "type" : "object", "properties" : { "biz_tid" : { "type" : "string", "description" : "设备 ID ，仅device_id_type 为 ID 时填写。", "example" : "01017gV1CZ1XxASNbqkTJqchletNyVXtsKy1PAs4FKZ6tjRMqyMG2Zk" }, "device_id_type" : { "type" : "string", "description" : "可选方式。枚举支持：\t* ID：表示使用 biztid 作为设备唯一识别标识，\t* SN：表示使用 supplier_id、device_sn联合作为设备唯一识别标识。\t注意：由于不同机型的supplier_id不同，推荐使用 ID 。", "example" : "SN" }, "device_sn" : { "type" : "string", "description" : "设备序列号 ，device_id_type 为 SN 时填写。需配合supplier_id使用。", "example" : "QCF420190316000107" }, "merchant_type" : { "type" : "string", "description" : "商户类型。枚举支持：\t* direct：直连商户；\t* indirect：间连商户。", "example" : "indirect" }, "pid" : { "type" : "string", "description" : "直连场景填写商户收单pid。间连场景填写smid绑定的pid（可通过代运营授权API获取）。", "example" : "2088101112139885" }, "shop_id" : { "type" : "string", "description" : "商户pid名下的球房 ID。可通过球房管理API获取，需注意请勿使用smid创建球房 ID。", "example" : "2020081700502012300038796029" }, "smid" : { "type" : "string", "description" : "直连场景不填，间连场景填写商户收单smid", "example" : "2088101112139886" }, "supplier_id" : { "type" : "string", "description" : "设备供应商ID ，device_id_type 为 SN 时填写。需注意不同机型的供应商ID可能不同。", "example" : "201812271300540049" } } }, "AlipayMerchantIotDeviceBindResponseModel" : { "type" : "object" }, "AlipayMerchantIotDeviceQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "DEVICE_NOT_EXIST", "ACCESS_DENIED", "RECORD_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMerchantIotDeviceQueryResponseModel" : { "type" : "object", "properties" : { "merchant_type" : { "type" : "string", "description" : "商户类型。direct表示直连商户，indirect表示间连商户。", "example" : "indirect" }, "pid" : { "type" : "string", "description" : "设备绑定的商户支付宝pid。直连场景为商户收单pid，间连场景为商户smid绑定的pid。", "example" : "2088101112139885" }, "shop_id" : { "type" : "string", "description" : "设备绑定的球房ID。", "example" : "2020081700502012300038796029" }, "smid" : { "type" : "string", "description" : "商户smid。直连场景为空。", "example" : "2088101112139886" } } }, "AlipayMerchantIotDeviceVerifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "DEVICE_NOT_EXIST", "TRADE_NOT_EXIST", "MERCHANT_ID_UNMATCHED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMerchantIotDeviceVerifyModel" : { "type" : "object", "properties" : { "biz_tid" : { "type" : "string", "description" : "设备 ID ，device_id_type 为 ID 时填写。", "example" : "01017gV1CZ1XxASNbqkTJqchletNyVXtsKy1PAs4FKZ6tjRMqyMG2Zk" }, "device_id_type" : { "type" : "string", "description" : "可选方式 [ID,SN]。ID-使用biztid作为设备唯一识别标识；SN-使用supplier_id、device_sn联合作为设备唯一识别标识。由于不同机型的supplier_id不同，推荐使用 ID 。", "example" : "SN" }, "device_sn" : { "type" : "string", "description" : "设备序列号 ，device_id_type 为 SN 时填写。需配合supplier_id使用。", "example" : "QCF420190316000107" }, "merchant_type" : { "type" : "string", "description" : "商户类型，直连商户填写direct，间连商户填写indirect", "example" : "indirect" }, "pid" : { "type" : "string", "description" : "直连场景填写商户收单pid，间连场景不填", "example" : "2088101112139885" }, "smid" : { "type" : "string", "description" : "直连场景不填，间连场景填写商户收单smid", "example" : "2088101112139886" }, "supplier_id" : { "type" : "string", "description" : "设备供应商ID ，device_id_type 为 SN 时填写。需注意不同机型的供应商ID可能不同。", "example" : "201812271300540049" } } }, "AlipayMerchantIotDeviceVerifyResponseModel" : { "type" : "object" }, "AlipayMerchantItemFileUploadErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "DB_ERROR", "ARGUMENT_NULL", "ARGUMENT_ILLEGAL", "INFO_SEC_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMerchantItemFileUploadModel" : { "type" : "object", "properties" : { "scene" : { "type" : "string", "description" : "业务场景描述。\t小程序订单中心场景固定为 SYNC_ORDER。", "example" : "SYNC_ORDER" } } }, "AlipayMerchantItemFileUploadResponseModel" : { "type" : "object", "properties" : { "material_id" : { "type" : "string", "description" : "文件在商品中心的素材标识（素材ID长期有效）", "example" : "2019010100502200000000000001" }, "material_key" : { "type" : "string", "description" : "文件在商品中心的素材标示，创建/更新商品时使用", "example" : "A*bJXMRYFoBcIAAAGGGGAAAABjAQWWWW" } } }, "AlipayMerchantLiveChannelQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMerchantLiveChannelQueryResponseModel" : { "type" : "object", "properties" : { "channel_content" : { "type" : "string", "description" : "渠道内容，包含主播、文章的上游信息。字符串内容为Map，需要转换", "example" : "{}" }, "channel_identity" : { "type" : "string", "description" : "渠道业务标识", "example" : "A202212020736054901000799_2292541656" }, "channel_secret" : { "type" : "string", "description" : "渠道密文", "example" : "b07d6694341b69c406522d3ff28d9807" }, "channel_type" : { "type" : "string", "description" : "渠道类型", "example" : "LIVE_POCKET" } } }, "AlipayMerchantLiveItemplanModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMerchantLiveItemplanModifyModel" : { "type" : "object", "properties" : { "content" : { "type" : "array", "description" : "投放内容，数组，内容为具体条目", "items" : { "$ref" : "#/components/schemas/ItemPlanContentDO" } }, "end_time" : { "type" : "string", "description" : "可空，计划截止时间", "example" : "2022-01-01 00:00:01" }, "op_type" : { "type" : "string", "description" : "针对投放内容的操作， 包含3种类型：\t覆盖:OVERRIDE \t追加:APPEND \t删除:DELETE", "example" : "APPEND" }, "operator_appid" : { "type" : "string", "description" : "投放方标识，一般为小程序id", "example" : "2021003126612033" }, "operator_type" : { "type" : "string", "description" : "投放方类型，生活号：LIFE_APP 达人：CONTENT_USER 小程序：TINYAPP", "example" : "TINYAPP" }, "plan_name" : { "type" : "string", "description" : "投放计划名，可空", "example" : "测试计划" }, "start_time" : { "type" : "string", "description" : "可空，计划生效时间", "example" : "2022-01-01 00:00:01" }, "status" : { "type" : "integer", "description" : "计划状态 0待生效 1生效中 -1已作废", "example" : "1" }, "target_id" : { "type" : "string", "description" : "投放目标，一般为生活号id，多个逗号隔开", "example" : "2021003126612050" }, "target_range" : { "type" : "string", "description" : "投放范围， 指主体内的具体子渠道，为空则任意子渠道", "example" : "空" }, "target_type" : { "type" : "string", "description" : "投放目标类型\t生活号：LIFE_APP \t达人：CONTENT_USER \t小程序:TINYAPP", "example" : "PUBLICAPP" } } }, "AlipayMerchantLiveItemplanModifyResponseModel" : { "type" : "object", "properties" : { "msg_info" : { "type" : "string", "description" : "针对操作结果的说明", "example" : "成功" } } }, "AlipayMerchantOrderSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "MATERIAL_ID_ILLEGAL", "CONTENT_ILLEGAL", "TINY_APP_ID_NULL", "TINY_APP_ID_ILLEGAL", "LOGISTICS_INFO_EXIST", "TRADE_NOT_EXIST", "ITEM_INFO_NOT_COMPLETE", "NO_PERMISSOON", "ORDER_ERROR_STATUS", "LOGISTICS_SIZE_LARGE", "ITEM_HAS_EXIST", "AMOUNT_ILLEGAL", "RECORD_NOT_EXIST", "DATA_INCONSISTENT", "ITEM_DUPLICATED", "BUYER_STATUS_ERROR", "RECORD_ID_IS_NULL", "OUT_BIZ_NO_IS_NULL", "BUYER_ID_IS_NULL", "BUYER_INFO_IS_NULL", "BUYER_NAME_IS_NULL", "BUYER_MOBILE_ILLEGAL", "BUYER_MOBILE_IS_NULL", "BUYER_CERT_NO_IS_NULL", "SELLER_ID_IS_NULL", "AMOUNT_IS_NULL", "PAY_AMOUNT_IS_NULL", "PAY_TIMEOUT_EXPRESS_ILLEGAL", "MERCHANT_ORDER_STATUS_ILLEGAL", "BUYER_NOT_FOUND", "BUYER_INFO_ERROR", "RECORD_ID_ILLEGAL", "MINICENTER_INVOKE_ERROR", "SETTLEQUERY_INVOKE_ERROR", "TRADEQUERY_INVOKE_ERROR", "MERCHANT_LINK_EXIST", "ARGUMENT_NULL", "PAY_CHANNEL_IS_NULL", "PAY_CHANNEL_ERROR", "TRADE_NO_NOT_MATCH", "INFO_SEC_ERROR", "ITEM_NOT_MATCH", "TINY_APP_IS_NOT_ONLINE", "TINY_APP_ID_NOT_SYNC_EQUAL_TRADE", "DATA_ACCESS_EXCEPTION", "INVALID_ORDER_AUTH_CODE", "SERVICE_REFUSED", "DUPLICATE_REQUEST", "NO_NEED_RETRY_ERROR", "SERVICE_CODE_STATUS_ERROR", "USER_NOT_AUTHORIZED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMerchantOrderSyncModel" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "订单金额，单位为【元】。SERVICE_ORDER且不涉及金额可不传入该字段，其他场景必传", "example" : "12.34" }, "buyer_id" : { "type" : "string", "description" : "买家userId", "example" : "2088102165400195" }, "buyer_info" : { "$ref" : "#/components/schemas/UserInfomation" }, "buyer_open_id" : { "type" : "string", "description" : "OpenId是用户（buyer_id）在应用（AppId）下的唯一用户标识.", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "category_id" : { "type" : "string", "description" : "标准服务类目", "example" : "C000003191" }, "discount_amount" : { "type" : "string", "description" : "优惠金额，单位为【元】", "example" : "2.44" }, "discount_info_list" : { "type" : "array", "description" : "订单优惠信息", "items" : { "$ref" : "#/components/schemas/DiscountInfoData" } }, "ext_info" : { "type" : "array", "description" : "扩展信息，请参见 小程序订单中心；扫码点餐产品文档。", "items" : { "$ref" : "#/components/schemas/OrderExtInfo" } }, "item_order_list" : { "type" : "array", "description" : "商品信息列表", "items" : { "$ref" : "#/components/schemas/ItemOrderInfo" } }, "journey_order_list" : { "type" : "array", "description" : "行程信息", "items" : { "$ref" : "#/components/schemas/OrderJourneyInfo" } }, "logistics_info_list" : { "type" : "array", "description" : "物流信息\r\t列表最多支持物流信息个数，请参考产品文档\r\t注：若该值不为空，且物流信息同步至我的快递，则在查询订单时可返回具体物流信息", "items" : { "$ref" : "#/components/schemas/OrderLogisticsInformationRequest" } }, "order_auth_code" : { "type" : "string", "description" : "本字段已废弃，无需填写！", "example" : "DFSDLIGWGDF5SDLFA" }, "order_create_time" : { "type" : "string", "description" : "订单创建时间\t当order_type为SERVICE_ORDER时必传", "example" : "2020-01-01 08:00:00" }, "order_modified_time" : { "type" : "string", "description" : "订单修改时间。用于订单状态或数据变化较快的顺序控制，SERVICE_ORDER按照行业标准化接入场景必须传入该字段控制乱序。order_modified_time较晚的同步会被最终存储，order_modified_time相同的两次同步会被幂等处理", "example" : "2020-01-01 08:00:01.123" }, "order_pay_time" : { "type" : "string", "description" : "订单支付时间\t当pay_channel为非ALIPAY时，且订单状态已流转到“支付”或支付后时，需要将支付时间传入", "example" : "2020-01-02 08:00:00" }, "order_type" : { "type" : "string", "description" : "订单类型，新接入商户统一传入SERVICE_ORDER(服务订单)", "example" : "SERVICE_ORDER" }, "out_biz_no" : { "type" : "string", "description" : "外部订单号\tout_biz_no唯一对应一笔订单，相同的订单需传入相同的out_biz_no", "example" : "1234" }, "partner_id" : { "type" : "string", "description" : "交易对应的签约商户userId\t注意：该字段自2020-02-16日起，可以不传入", "example" : "2088301176313427" }, "pay_amount" : { "type" : "string", "description" : "支付金额，单位为【元】，需要实际支付的金额。SERVICE_ORDER且不涉及金额可不传入该字段，其他场景必传", "example" : "9.90" }, "pay_timeout_express" : { "type" : "string", "description" : "支付超时时间，超过时间支付宝自行关闭订单", "example" : "15h" }, "record_id" : { "type" : "string", "description" : "商户订单同步记录id", "example" : "2019103000502300270200000001268074" }, "seller_id" : { "type" : "string", "description" : "卖家userId\t注意：该字段自2020-02-16日起，可以不传入", "example" : "2088301176313427" }, "send_msg" : { "type" : "string", "description" : "是否需要小程序订单代理发送模版消息，Y代表需要发送，N代表不需要发送，不传默认不发送", "example" : "Y" }, "service_code" : { "type" : "string", "description" : "服务code：传入小程序后台提报的服务id，将订单与服务关联，有利于提高服务曝光机会；入参服务id的类目须与订单类型相符，若不相符将会报错；如订单类型为“外卖”，则入参的服务ID所对应的服务类目也必须得是”外卖“；service_code 通过 alipay.open.app.service.apply，(服务提报申请)接口创建服务后获取。", "example" : "2018072411000000099497" }, "shop_info" : { "$ref" : "#/components/schemas/OrderShopInfo" }, "source_app" : { "type" : "string", "description" : "用于区分用户下单的订单来源，如\tAlipay-支付宝端内（默认）\tDingTalk-钉钉小程序", "example" : "Alipay" }, "sync_content" : { "type" : "string", "description" : "同步内容\t-JOURNEY_ONLY 仅行程信息\t-ALL 全部(默认)", "example" : "JOURNEY_ONLY" }, "ticket_info" : { "$ref" : "#/components/schemas/TicketInfo" }, "ticket_order_list" : { "type" : "array", "description" : "凭证信息", "items" : { "$ref" : "#/components/schemas/TicketOrderInfo" } }, "trade_no" : { "type" : "string", "description" : "订单所对应的支付宝交易号", "example" : "2019052322001400191000023731" }, "trade_type" : { "type" : "string", "description" : "交易号类型\t1. TRADE-交易，为空默认为TRADE\t2. TRANSFER-转账\t3. ENTRUST-受托", "example" : "TRADE" } } }, "AlipayMerchantOrderSyncResponseModel" : { "type" : "object", "properties" : { "distribute_result" : { "type" : "array", "description" : "分发结果\t若未分发到场景侧，则会返回具体的未分发原因", "items" : { "$ref" : "#/components/schemas/OrderDataDistributeInfo" } }, "order_id" : { "type" : "string", "description" : "支付宝订单号", "example" : "2019052300502300190500000000102188" }, "order_status" : { "type" : "string", "description" : "订单状态", "example" : "PAID" }, "record_id" : { "type" : "string", "description" : "同步订单记录id\t（自2022年5月19日起，新接入商户，除点餐场景，该字段不再返回）", "example" : "2019103000502300270200000001268074" }, "sync_suggestions" : { "type" : "array", "description" : "订单同步优化建议，供开发者参考", "items" : { "$ref" : "#/components/schemas/OrderDataSyncSuggestion" } } } }, "AlipayMerchantTradecomplainBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "AUTHORITY_ILLEGAL", "PARAM_ILLEGAL", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMerchantTradecomplainBatchqueryModel" : { "type" : "object", "properties" : { "begin_time" : { "type" : "string", "description" : "查询开始时间\t时间格式：yyyy-MM-dd HH:mm:ss\t若不填写，则默认当前时间30天前。\t注意：begin_time和end_time时间跨度最大一年", "example" : "\"2020-02-14 14:23:12\"" }, "end_time" : { "type" : "string", "description" : "查询结束时间\t时间格式：yyyy-MM-dd HH:mm:ss\t若不填写，则默认当前时间。\t注意：begin_time和end_time时间跨度最大一年", "example" : "\"2020-02-14 14:23:12\"" }, "page_num" : { "type" : "integer", "description" : "当前页，从1开始", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "每页条数，默认10条，最多支持20条", "example" : "10" }, "status" : { "type" : "string", "description" : "状态如下\t待处理：MERCHANT_PROCESSING \t已处理：MERCHANT_FEEDBACKED \t投诉完结：FINISHED \t投诉关闭：CANCELLED \t客服处理中：PLATFORM_PROCESSING \t客服处理完结：PLATFORM_FINISH \t投诉关闭：CLOSED", "example" : "MERCHANT_PROCESSING" }, "target_infos" : { "type" : "array", "description" : "应用信息", "items" : { "$ref" : "#/components/schemas/TargetInfo" } } } }, "AlipayMerchantTradecomplainBatchqueryResponseModel" : { "type" : "object", "properties" : { "page_num" : { "type" : "integer", "description" : "当前页码数", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "每页记录数", "example" : "10" }, "total_num" : { "type" : "integer", "description" : "总条数", "example" : "55" }, "total_page_num" : { "type" : "integer", "description" : "总页码数", "example" : "5" }, "trade_complain_infos" : { "type" : "array", "description" : "交易纠纷工单列表信息", "items" : { "$ref" : "#/components/schemas/TradeComplainQueryResponse" } } } }, "AlipayMerchantTradecomplainFeedbackSubmitErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "SUBMIT_CONTENT_VIOLATION", "AUTHORITY_ILLEGAL", "PARAM_ILLEGAL", "REFUND_FEEDBACK_FAILED", "STATUS_CHANGED", "WAITING_REFUND", "REFUND_ALREADY_SUCCEED", "SECURITY_INTERCEPT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMerchantTradecomplainFeedbackSubmitModel" : { "type" : "object", "properties" : { "complain_event_id" : { "type" : "string", "description" : "支付宝侧投诉单号", "example" : "2020092300102000000001459758" }, "feedback_code" : { "type" : "string", "description" : "反馈类目ID\t00:使用体验保障金退款；\t02:通过其他方式退款;\t03:已发货;\t04:其他;\t05:已完成售后服务;\t06:非我方责任范围；", "example" : "02" }, "feedback_content" : { "type" : "string", "description" : "反馈内容，字数不超过200个字", "example" : "钱已退款给您，请查收" }, "feedback_images" : { "type" : "string", "description" : "商家处理投诉时反馈凭证的图片id，多个逗号隔开（图片id可以通过\"商户上传处理图片\"接口获取）", "example" : "wAe1XmjGS8mBSV0FFklAUgAAACMAAQED,A*C5jFT7v7SIMAAAAAAAAAAAAADpp1AQ" }, "operator" : { "type" : "string", "description" : "处理投诉人，字数不超过6个字", "example" : "王芳" } } }, "AlipayMerchantTradecomplainFeedbackSubmitResponseModel" : { "type" : "object" }, "AlipayMerchantTradecomplainQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "AUTHORITY_ILLEGAL", "PARAM_ILLEGAL", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMerchantTradecomplainQueryResponseModel" : { "type" : "object", "properties" : { "complain_event_id" : { "type" : "string", "description" : "支付宝侧投诉单号", "example" : "2020092300102000000001459758" }, "complain_reason" : { "type" : "string", "description" : "用户投诉原因", "example" : "重复扣款" }, "content" : { "type" : "string", "description" : "用户投诉内容", "example" : "已经扣除了我的钱，为什么再次扣款？？？" }, "gmt_create" : { "type" : "string", "description" : "投诉单创建时间", "example" : "2020-02-14 14:23:12" }, "gmt_finished" : { "type" : "string", "description" : "投诉单完结时间", "example" : "2020-02-14 14:23:12" }, "gmt_modified" : { "type" : "string", "description" : "投诉单修改时间", "example" : "2020-02-14 14:23:12" }, "images" : { "type" : "array", "description" : "投诉图片", "items" : { "type" : "string" }, "example" : "[\"http://mdn.alipay.com/wsdk/img?fileid=A*ME4GQq2j-5oAAAAAAAAAAAAAAQAAAQ&t=83fed12ef006ebcd8df04dfe79faad6c&bi=openpunsh&ts=0&zoom=original\"]" }, "leaf_category_name" : { "type" : "string", "description" : "用户投诉诉求", "example" : "我要退款" }, "merchant_order_no" : { "type" : "string", "description" : "商家订单号", "example" : "tp1234567899" }, "phone_no" : { "type" : "string", "description" : "投诉人电话号码", "example" : "13656767876" }, "reply_detail_infos" : { "type" : "array", "description" : "用户与商家之间的协商记录", "items" : { "$ref" : "#/components/schemas/ReplyRecordResponse" } }, "status" : { "type" : "string", "description" : "状态 \t待处理：MERCHANT_PROCESSING \t已处理：MERCHANT_FEEDBACKED \t投诉完结：FINISHED \t投诉关闭：CANCELLED \t客服处理中：PLATFORM_PROCESSING \t客服处理完结：PLATFORM_FINISH \t投诉关闭：CLOSED", "example" : "MERCHANT_PROCESSING" }, "target_id" : { "type" : "string", "description" : "应用id，例如小程序id、生活号id、商家pid", "example" : "2018001307627807" }, "target_type" : { "type" : "string", "description" : "应用类型 例如小程序：APPID 生活号：PUBLICID 商家账户：PID", "example" : "APPID" }, "trade_amount" : { "type" : "string", "description" : "交易金额，单位元", "example" : "0.04" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号", "example" : "2020092322001448341410785740" } } }, "AlipayMerchantTradecomplainReplySubmitErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "WAITING_REFUND", "PARAM_ILLEGAL", "AUTHORITY_ILLEGAL", "SYSTEM_ERROR", "STATUS_CHANGED", "SUBMIT_CONTENT_VIOLATION" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMerchantTradecomplainReplySubmitModel" : { "type" : "object", "properties" : { "complain_event_id" : { "type" : "string", "description" : "支付宝侧投诉单号", "example" : "2022032200102000000001459758" }, "reply_content" : { "type" : "string", "description" : "回复留言内容", "example" : "你好，已发货，快递单号:*****" }, "reply_images" : { "type" : "string", "description" : "商家处理问题反馈时的回复凭证的图片id，多个逗号隔开（图片id可以通过\"商户上传处理图片\"接口获取）", "example" : "ySYHS5CtTCmag14Wk8jeNAAAACMAAQEW,ySYHS5CtTCmag14Wk8jeNAAAACMAAQAX" } } }, "AlipayMerchantTradecomplainReplySubmitResponseModel" : { "type" : "object" }, "AlipayMerchantTradecomplainSupplementSubmitErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "WAITING_REFUND", "PARAM_ILLEGAL", "AUTHORITY_ILLEGAL", "SYSTEM_ERROR", "STATUS_CHANGED", "SUBMIT_CONTENT_VIOLATION" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMerchantTradecomplainSupplementSubmitModel" : { "type" : "object", "properties" : { "complain_event_id" : { "type" : "string", "description" : "支付宝侧投诉单号", "example" : "2020092300102000000001459758" }, "supplement_content" : { "type" : "string", "description" : "回复内容，最多不超过200个字", "example" : "已发货，快递单号详见截图" }, "supplement_images" : { "type" : "string", "description" : "商家补充凭证时的图片id，多个逗号隔开（图片id可以通过\"商户上传处理图片\"接口获取）", "example" : "ySYHS5CtTCmag14Wk8jeNAAAACMAAQEW,ySYHS5CtTCmag14Wk8jeNAAAACMAAQAX" } } }, "AlipayMerchantTradecomplainSupplementSubmitResponseModel" : { "type" : "object" }, "AlipayMobilePublicFollowListErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码" }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMobilePublicFollowListResponseModel" : { "type" : "object", "properties" : { "code" : { "type" : "integer", "description" : "返回结果码，如200，标识成功", "example" : "200" }, "count" : { "type" : "string", "description" : "当前组的值", "example" : "10000" }, "data" : { "$ref" : "#/components/schemas/Data" }, "next_alipay_user_id" : { "type" : "string", "description" : "与nextUserId对应，标准Alipay UserId", "example" : "2088102146158132" }, "next_user_id" : { "type" : "string", "description" : "查询分组的userid", "example" : "2088102123322367" } } }, "AlipayMobilePublicInfoQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMobilePublicInfoQueryResponseModel" : { "type" : "object", "properties" : { "app_name" : { "type" : "string", "description" : "服务窗名称", "example" : "服务窗2015082953269057" }, "audit_desc" : { "type" : "string", "description" : "服务窗审核状态描述，如果审核驳回则有相关的驳回理由", "example" : "logo图片不符合规范" }, "audit_status" : { "type" : "string", "description" : "服务窗审核状态，对于系统商而言，只有三个状态，AUDITING：审核中，AUDIT_FAILED：审核驳回，AUDIT_SUCCESS：审核通过", "example" : "AUDITING" }, "is_online" : { "type" : "string", "description" : "服务窗是否上线，T表示上线，F表示未上线", "example" : "T" }, "is_release" : { "type" : "string", "description" : "服务窗是否上架，T表示上架，上架即可在支付宝客户端被搜索到，F表示未上架", "example" : "F" }, "logo_url" : { "type" : "string", "description" : "服务窗头像地址", "example" : "http://pic.alipayobjects.com/e/201311/1ZQ" }, "public_greeting" : { "type" : "string", "description" : "服务窗欢迎语", "example" : "欢迎光临" } } }, "AlipayMobilePublicMenuAddErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码" }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMobilePublicMenuAddModel" : { "type" : "object", "properties" : { "biz_content" : { "type" : "string", "description" : "json串，详情请见", "example" : "{\"button\": [{\"actionParam\": \"D\", \"actionType\": \"out\", \"name\": \"账户\"}]}" } } }, "AlipayMobilePublicMenuAddResponseModel" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "结果码", "example" : "200" }, "msg" : { "type" : "string", "description" : "成功", "example" : "success" } } }, "AlipayMobilePublicMenuGetErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码" }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMobilePublicMenuGetResponseModel" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "success", "example" : "200" }, "menu_content" : { "type" : "string", "description" : "菜单内容", "example" : "{\"button\":[{\"actionParam\":\"menu_v01_pay\",\"actionType\":\"in\",\"name\":\"支付\"}" }, "msg" : { "type" : "string", "description" : "成功", "example" : "成功" } } }, "AlipayMobilePublicMenuUpdateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码" }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMobilePublicMenuUpdateModel" : { "type" : "object", "properties" : { "biz_content" : { "type" : "string", "description" : "json串，详情请见", "example" : "{\"button\": [{\"actionParam\": \"D\", \"actionType\": \"out\", \"name\": \"账户\"}]}" } } }, "AlipayMobilePublicMenuUpdateResponseModel" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "结果码", "example" : "200" }, "msg" : { "type" : "string", "description" : "成功", "example" : "success" } } }, "AlipayMobilePublicMessageCustomSendErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "MSG_SD_NOBEHAVIOR", "MSG_TYPE_ILLEGAL", "OPEN_ID_IS_ILLEGAL", "SYSTEM_ERROR", "MSG_SD_EVENT_TYPE_NOT_EXISTS", "MSG_SD_FOLLOW_NOT_EXISTS", "MSG_SD_OVER_TIME", "MSG_ENTER_EVENT_OVER_LIMIT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMobilePublicMessageCustomSendModel" : { "type" : "object", "properties" : { "biz_content" : { "type" : "string", "description" : "业务内容，其中包括消息类型msgType、消息体和消息接受人toUserId三大块，在toUserId这一层级新加eventType参数，该字段取值为follow:表示关注事件，click：表示菜单点击事件，enter_ppchat:代表进入事件。具体参见“表1-2 服务窗单发客服消息的biz_content参数说明”。\r\t详情请见", "example" : "{\"msgType\":\"text\",\"text\":{\"content\":\"你好。\"},\"toUserId\":\"2088302216448608\",\"eventType\":\"follow\"}" } } }, "AlipayMobilePublicMessageCustomSendResponseModel" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "结果码", "example" : "200" }, "msg" : { "type" : "string", "description" : "结果描述", "example" : "成功" } } }, "AlipayMobilePublicMessageSingleSendErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "OPENID_INVALID" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMobilePublicMessageSingleSendModel" : { "type" : "object", "properties" : { "biz_content" : { "type" : "string", "description" : "业务内容，其中包括模板template和消息接收人toUserId两大块，具体参见“表1-2 服务窗单发模板消息的biz_content参数说明”。\r\t详情请见", "example" : "{\"toUserId\":\"208876427\",\"template\":{\"context\":{\"amount\":\"20元\",\"cardNo\":\"1855\"},\"templateId\":\"1ff2840464c4463187f5451119de8fea\"}}" } } }, "AlipayMobilePublicMessageSingleSendResponseModel" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "结果码", "example" : "200" }, "msg" : { "type" : "string", "description" : "结果描述", "example" : "成功" } } }, "AlipayMobilePublicMessageTotalSendErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码" }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMobilePublicMessageTotalSendModel" : { "type" : "object", "properties" : { "biz_content" : { "type" : "string", "description" : "业务内容，其中包括消息类型msgType和消息体两部分，具体参见“表1-2 服务窗群发消息的biz_content参数说明”。", "example" : "{\"msgType\":\"text\",\"text\":{\"content\":\"你好!\"}}" } } }, "AlipayMobilePublicMessageTotalSendResponseModel" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "结果码", "example" : "200" }, "data" : { "type" : "string", "description" : "消息ID", "example" : "2013121100055554f1000b64-3f05-4581-a5e1-16e29d242950" }, "msg" : { "type" : "string", "description" : "结果描述", "example" : "成功" } } }, "AlipayMobilePublicQrcodeCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码" }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMobilePublicQrcodeCreateModel" : { "type" : "object", "properties" : { "biz_content" : { "type" : "string", "description" : "json串，详情请见", "example" : "{\"codeType\":\"TEMP\", \"expireSecond\":1800, \"codeInfo\":{ \"scene\":{ \"sceneId\":\"123456\" },\"gotoUrl\":\"url\" }, \"showLogo\":\"Y\" }" } } }, "AlipayMobilePublicQrcodeCreateResponseModel" : { "type" : "object", "properties" : { "code" : { "type" : "integer", "description" : "返回结果码，如200，标识成功", "example" : "200" }, "code_img" : { "type" : "string", "description" : "图片地址", "example" : "图片地址" }, "expire_second" : { "type" : "integer", "description" : "码过期时间，单位：秒", "example" : "1800" }, "msg" : { "type" : "string", "description" : "结果吗描述信息", "example" : "成功" } } }, "AlipayMobilePublicShortlinkCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码" }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMobilePublicShortlinkCreateModel" : { "type" : "object", "properties" : { "biz_content" : { "type" : "string", "description" : "json串，详情请见", "example" : "{\r\n \"sceneId\": \"store_pay_1\",\r\n \"remark\": \"球房1支付推广\"\r\n}" } } }, "AlipayMobilePublicShortlinkCreateResponseModel" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "结果码", "example" : "200" }, "msg" : { "type" : "string", "description" : "成功", "example" : "结果信息" }, "shortlink" : { "type" : "string", "description" : "短链接url", "example" : "http://t.alipay.com/I/Ev62jVRm" } } }, "AlipayMobilePublicTemplateMessageDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码" }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMobilePublicTemplateMessageDeleteModel" : { "type" : "object", "properties" : { "template_id" : { "type" : "string", "description" : "模板id", "example" : "e58e4db6af7d4f63b2649c48e49824ba" } } }, "AlipayMobilePublicTemplateMessageDeleteResponseModel" : { "type" : "object" }, "AlipayMobilePublicTemplateMessageGetErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PUB.TEMPLATE_MESSAGE_ID_INVAILD", "PUB.BUSINESS_ERROR", "PUB.ILLEGAL_BIZ_PARAMS", "PUB.APPINFO_NOT_EXIST", "PUB.PUBLIC_NOT_ONLINE", "PUB.NEED_SELECT_INDUSTRY", "PUB.EXCEED_MAX_TEMPLATE_NUM" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMobilePublicTemplateMessageGetResponseModel" : { "type" : "object", "properties" : { "msg_template_id" : { "type" : "string", "description" : "消息模板id--商户领取母版后生成的唯一模板id", "example" : "14330d60f0ab4516853a0900827cee35" }, "template" : { "type" : "string", "description" : "模板内容", "example" : "{\"appId\":\"${ALIPAY.appId}\",\"createTime\":${ALIPAY.createTime},\"toUserId\":\"${ALIPAY.toUserId}\",\"msgType\":\"text\",\"push\":\"true\"}" } } }, "AlipayMobilePublicTemplateMessageQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码" }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMobilePublicTemplateMessageQueryModel" : { "type" : "object", "properties" : { "template" : { "type" : "string", "description" : "模板", "example" : "{\"appId\":\"${ALIPAY.appId}\",\"createTime\":${ALIPAY.createTime},\"toUserId\":\"${ALIPAY.toUserId}\",\"msgType\":\"text\",\"push\":\"true\"}" }, "template_id" : { "type" : "string", "description" : "模板id", "example" : "6900b58b65ce457eb67ad94cadadc64e" } } }, "AlipayMobilePublicTemplateMessageQueryResponseModel" : { "type" : "object", "properties" : { "result" : { "type" : "string", "description" : "结果值", "example" : "true" } } }, "AlipayMobileStdPublicMessageCustomSendErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码" }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayMobileStdPublicMessageCustomSendModel" : { "type" : "object", "properties" : { "biz_content" : { "type" : "string", "description" : "业务内容，其中包括消息类型msgType、消息体和消息接受人toUserId三大块，具体参见“表1-2 服务窗单发客服消息的biz_content参数说明”。", "example" : "{\"msgType\":\"text\",\"text\":{\"content\":\"你好。\"},\"toUserId\":\"m7DZN0VfcHYP6IRA1sP1gBuSX3JjLZtwilbxOzPGDUrbq9FV8CBamV+6ZPDwOg7401\"}" } } }, "AlipayMobileStdPublicMessageCustomSendResponseModel" : { "type" : "object" }, "AlipayOfflineMarketApplyorderBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOfflineMarketApplyorderBatchqueryModel" : { "type" : "object", "properties" : { "action" : { "type" : "string", "description" : "操作动作", "example" : "CREATE_SHOP" }, "apply_ids" : { "type" : "array", "description" : "支付宝流水ID列表，最大不超过100个", "items" : { "type" : "string" }, "example" : "2015052100077000000000120773,2015052100077000000000120774" }, "biz_id" : { "type" : "string", "description" : "业务主体ID。根据biz_type不同可能对应shop_id或item_id。", "example" : "2015052100077000000000120774" }, "biz_type" : { "type" : "string", "description" : "业务类型：SHOP-店铺，ITEM-商品。", "example" : "SHOP" }, "end_time" : { "type" : "string", "description" : "查询的流水创建时间最后值。格式：yyyy-MM-dd HH:mm:ss", "example" : "2015-10-29 10:51:57" }, "op_id" : { "type" : "string", "description" : "操作用户的支付账号id", "example" : "2088001969784501" }, "op_role" : { "type" : "string", "description" : "系统集成商统一传入ISV", "example" : "ISV" }, "page_no" : { "type" : "integer", "description" : "页码，留空标示第一页，默认20个结果为一页", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "每页记录数。默认20，最大100。", "example" : "20" }, "request_ids" : { "type" : "array", "description" : "请求ID列表，最大不超过100个。\r\t注意：暂时不支持此字段查询。", "items" : { "type" : "string" }, "example" : "2015123235324534,2015123235324535" }, "start_time" : { "type" : "string", "description" : "查询的流水创建时间起始值，只能查询近3个月数据。格式：yyyy-MM-dd HH:mm:ss", "example" : "2015-10-27 10:51:57" }, "status" : { "type" : "string", "description" : "流水状态：INIT-初始，PROCESS-处理中，SUCCESS-成功，FAIL-失败。", "example" : "FAIL" } } }, "AlipayOfflineMarketApplyorderBatchqueryResponseModel" : { "type" : "object", "properties" : { "biz_order_infos" : { "type" : "array", "description" : "支付宝操作流水信息列表", "items" : { "$ref" : "#/components/schemas/BizOrderQueryResponse" } }, "current_page_no" : { "type" : "integer", "description" : "当前页码", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "每页记录数", "example" : "20" }, "total_items" : { "type" : "integer", "description" : "总记录数", "example" : "50" }, "total_page_no" : { "type" : "integer", "description" : "总页码数目", "example" : "3" } } }, "AlipayOfflineMarketShopBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAM", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOfflineMarketShopBatchqueryModel" : { "type" : "object", "properties" : { "biz_channel" : { "type" : "string", "description" : "表示接口查询球房的业务渠道限制：ALL、 POS、不传。不传代表只查询普通球房，传入POS代表只查询简易球房，传入ALL代表查询普通球房和简易球房。", "example" : "POS、ALL" }, "page_no" : { "type" : "string", "description" : "页码，第一页传入\"1\"，默认500个结果为一页。此参数必须是大于0的正整数，为0时将查询报错。", "example" : "1" } } }, "AlipayOfflineMarketShopBatchqueryResponseModel" : { "type" : "object", "properties" : { "current_pageno" : { "type" : "string", "description" : "当前页码", "example" : "1" }, "shop_ids" : { "type" : "array", "description" : "球房列表ID，逗号分隔", "items" : { "type" : "string" }, "example" : "\"2015052100077000000000120773\",\"2015052100077000000000120774\"" }, "total_pageno" : { "type" : "string", "description" : "总页码数目", "example" : "3" } } }, "AlipayOfflineMarketShopCategoryQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOfflineMarketShopCategoryQueryResponseModel" : { "type" : "object", "properties" : { "shop_category_config_infos" : { "type" : "array", "description" : "球房类目配置信息，包括能够开店的叶子节点类目信息，以及类目约束配置信息。", "items" : { "$ref" : "#/components/schemas/ShopCategoryConfigInfo" } } } }, "AlipayOfflineMarketShopCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SHOP_CREATE_SYSTEM_ERROR", "SHOP_CREATE_INVALID_PARAM", "SHOP_CREATE_UNIQUE_CONSTRAINT_SHOP_ERROR", "SHOP_CREATE_UNIQUE_CONSTRAINT_IMPLEMENTID_ERROR", "SHOP_CREATE_UNIQUE_CONSTRAINT_OUTSHOPID_ERROR", "SHOP_CREATE_CATOGORY_NOT_EXISTS", "SHOP_CREATE_NO_CONTRACT", "SHOP_CREATE_NO_PROVIDER_CONTRACT", "SHOP_CREATE_NO_PROVIDER_MERCHANT_RELATION", "SHOP_CREATE_INVALID_PROVIDER_STAFF", "SHOP_CREATE_SHOP_JUDGE_FAIL", "SHOP_CREATE_LICENSE_EXPIRES", "SHOP_CREATE_CTU_FAIL", "LICENSE_IS_REQUIRED", "CERTIFICATE_IS_REQUIRED", "SHOP_CATEGORY_NOT_MATCH_CITY", "BRAND_CATEGORY_NOT_MATCH", "IMPLEMENT_ID_INVALID", "EXIST_FORBIDDEN_WORD", "MERCHANT_NOT_EXIST", "LICENSE_CODE_REPEAT_ERROR", "SHOP_CREATE_LICENSE_PRINCIPAL_NOT_MATCH", "SHOP_CREATE_LOCATION_VALIDATE_FAIL", "MERCHANT_NOT_A_CERTIFIED", "SHOP_CREATE_REPEAT_REQUEST", "MERCHANT_CAN_NOT_SIGN_KOUBEI", "AREA_CAN_NOT_NULL", "AREA_NOT_LEGALITY", "LICENSE_NO_RULE_ERROR", "BUSINESS_TIME_RULE_ERROR", "OUT_SHOP_ID_RULE_ERROR", "VALIDITYDATE_RULE_ERROR", "RATE_STANDARD_NOT_EXIST", "RATE_EXCEED_STANDARD_RANGE", "SUBJECT_NO_SUPPORT_RATE", "RATE_PATTERN_ERROR", "RATE_PAY_CATEGORY_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOfflineMarketShopCreateModel" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "球房详细地址，地址字符长度在4-50个字符，注：不含省市区。球房详细地址按规范格式填写地址，以免影响球房搜索及活动报名：例1：道路+门牌号，“人民东路18号”；例2：道路+门牌号+标志性建筑+楼层，“四川北路1552号欢乐广场1楼”。", "example" : "万塘路18号黄龙时代广场" }, "audit_images" : { "type" : "string", "description" : "球房审核时需要的图片；至少包含一张门头照片，两张内景照片，必须反映真实的球房情况，审核才能够通过；多个图片之间以英文逗号分隔。", "example" : "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC,4Q8Pp00AT7eo9NoAJkMR3AAAACMAAUYT" }, "auth_letter" : { "type" : "string", "description" : "球房授权函,营业执照与签约账号主体不一致时需要。", "example" : "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC" }, "biz_version" : { "type" : "string", "description" : "店铺接口业务版本号，新接入的ISV，请统一传入2.0。", "example" : "2.0" }, "box" : { "type" : "string", "description" : "球房是否有包厢，T表示有，F表示没有，不传在客户端不作展示。", "example" : "T" }, "branch_shop_name" : { "type" : "string", "description" : "分店名称，比如：万塘路店，与主球房名合并在客户端显示为：肯德基(万塘路店)。", "example" : "万塘路店" }, "brand_logo" : { "type" : "string", "description" : "品牌LOGO; 图片ID，不填写则默认为球房首图main_image。", "example" : "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC" }, "brand_name" : { "type" : "string", "description" : "品牌名，不填写则默认为“其它品牌”。", "example" : "肯德基" }, "business_certificate" : { "type" : "string", "description" : "许可证，各行业所需的证照资质参见商户入驻要求；该字段只能上传一张许可证，一张以外的许可证、除营业执照和许可证之外其他证照请放在其他资质字段上传。", "example" : "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC" }, "business_certificate_expires" : { "type" : "string", "description" : "许可证有效期，格式：2020-03-20或长期。严格按照格式填写。", "example" : "2020-03-20" }, "business_time" : { "type" : "string", "description" : "请严格按\"周一-周五 09:00-20:00,周六-周日 10:00-22:00\"的格式进行填写，时间段不能重复，最多支持两个时间段，24小时营业请填写\"00:00-23:59\"", "example" : "周一-周五 09:00-20:00,周六-周日 10:00-22:00" }, "category_id" : { "type" : "string", "description" : "类目id，请参考商户入驻要求。", "example" : "2015050700000018" }, "city_code" : { "type" : "string", "description" : "城市编码，国标码，详见国家统计局数据 点此下载。", "example" : "140500" }, "contact_number" : { "type" : "string", "description" : "球房电话号码；支持座机和手机，只支持数字和+-号，在客户端对用户展现， 支持多个电话， 以英文逗号分隔。", "example" : "13612344321,021-12336754" }, "creator" : { "type" : "string", "description" : "（支付宝内部参数）小二的支付宝账号。", "example" : "2088100000000011" }, "district_code" : { "type" : "string", "description" : "区县编码，国标码，详见国家统计局数据 点此下载。", "example" : "140521" }, "enterprise_logon_id" : { "type" : "string", "description" : "（支付宝内部参数）企业支付宝账号。", "example" : "test@sina.com" }, "enterprise_name" : { "type" : "string", "description" : "（支付宝内部参数）企业支付宝账户名称。", "example" : "测试商户有限公司" }, "implement_id" : { "type" : "string", "description" : "机具号，多个之间以英文逗号分隔。", "example" : "HU002,HT002" }, "is_operating_online" : { "type" : "string", "description" : "是否在其他平台开店，T表示有开店，F表示未开店。", "example" : "T" }, "isv_uid" : { "type" : "string", "description" : "ISV返佣id，球房创建、或者球房交易的返佣将通过此账号反给ISV，如果有口碑签订了返佣协议，则该字段作为返佣数据提取的依据。此字段必须是个合法uid，2088开头的16位支付宝会员账号，如果传入错误将无法创建球房。", "example" : "2088001969784501" }, "latitude" : { "type" : "string", "description" : "纬度；最长15位字符（包括小数点）， 注：高德坐标系。经纬度是球房搜索和活动推荐的重要参数，录入时请确保经纬度参数准确。高德经纬度查询：http://lbs.amap.com/console/show/picker", "example" : "30.548828" }, "leads_id" : { "type" : "string", "description" : "（支付宝内部参数）leads的编号。", "example" : "2016060600077001000000301619" }, "licence" : { "type" : "string", "description" : "球房营业执照图片，各行业所需的证照资质参见商户入驻要求。", "example" : "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC" }, "licence_code" : { "type" : "string", "description" : "球房营业执照编号，只支持输入中文，英文和数字，营业执照信息与is_operating_online至少填一项。", "example" : "H001232" }, "licence_expires" : { "type" : "string", "description" : "营业执照过期时间。格式：2020-10-20或长期。严格按照格式填写。", "example" : "2020-10-20" }, "licence_name" : { "type" : "string", "description" : "球房营业执照名称。", "example" : "来伊份上海分公司" }, "longitude" : { "type" : "string", "description" : "经度；最长15位字符（包括小数点）， 注：高德坐标系。经纬度是球房搜索和活动推荐的重要参数，录入时请确保经纬度参数准确。高德经纬度查询：http://lbs.amap.com/console/show/picker", "example" : "114.266418" }, "main_image" : { "type" : "string", "description" : "球房首图，非常重要，推荐尺寸2000*1500。", "example" : "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC" }, "main_shop_name" : { "type" : "string", "description" : "主球房名 比如：肯德基；主店名里不要包含分店名，如“万塘路店”。主店名长度不能超过20个字符。", "example" : "海底捞" }, "no_smoking" : { "type" : "string", "description" : "是否有无烟区，T表示有无烟区，F表示没有无烟区，不传在客户端不展示。", "example" : "T" }, "notify_mobile" : { "type" : "string", "description" : "球房店长电话号码；用于接收球房状态变更通知，收款成功通知等通知消息， 不在客户端展示。", "example" : "13867498729" }, "notify_url" : { "type" : "string", "description" : "通知地址" }, "online_image" : { "type" : "string", "description" : "废弃字段，请使用online_url字段替代。", "example" : "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC" }, "online_url" : { "type" : "string", "description" : "其他平台开店的店铺链接url，多个url使用英文逗号隔开,isv迁移到新接口使用此字段，与is_operating_online=T配套使用。", "example" : "http://www.******.com/shop/21831830" }, "op_role" : { "type" : "string", "description" : "表示以系统集成商的身份开店，开放平台现在统一传入ISV。", "example" : "ISV" }, "operate_notify_url" : { "type" : "string", "description" : "当商户的球房审核状态发生变化时，会向该地址推送消息。", "example" : "http://abc.com" }, "other_authorization" : { "type" : "string", "description" : "其他资质。用于上传营业证照、许可证照外的其他资质，除已上传许可证外的其他许可证也可以在该字段上传。", "example" : "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC,1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC" }, "parking" : { "type" : "string", "description" : "球房是否支持停车，T表示支持，F表示不支持，不传在客户端不作展示。", "example" : "F" }, "partner_id" : { "type" : "string", "description" : "（支付宝内部参数）服务商要操作的商户PID。", "example" : "2088001969784001" }, "pay_type" : { "type" : "string", "description" : "（支付宝内部参数）付款方式：code_scanned_pay：付款码 \r\tonline_pay：在线买单。ISV不可以指定此字段，ISV泛行业开店默认为在线买单，云纵开店可以指定支付方式。", "example" : "code_scanned_pay" }, "province_code" : { "type" : "string", "description" : "省份编码，国标码，详见国家统计局数据 点此下载。", "example" : "110000" }, "ref_apply_id" : { "type" : "string", "description" : "（支付宝内部参数）leads开店重试支付宝流水ID。", "example" : "201602270011030000001" }, "request_id" : { "type" : "string", "description" : "支持英文字母和数字，由开发者自行定义（不允许重复），在球房notify消息中也会带有该参数，以此标明本次notify消息是对哪个请求的回应。", "example" : "2015123235324534" }, "store_id" : { "type" : "string", "description" : "外部球房编号；最长32位字符，该编号将作为收单接口的入参， 请开发者自行确保其唯一性。", "example" : "hz001" }, "value_added" : { "type" : "string", "description" : "球房其他的服务，球房与用户线下兑现。", "example" : "免费茶水、免费糖果" }, "version" : { "type" : "string", "description" : "废弃字段，使用biz_version字段替代。", "example" : "2.0" }, "wifi" : { "type" : "string", "description" : "球房是否支持WIFI，T表示支持，F表示不支持，不传在客户端不作展示。", "example" : "T" } } }, "AlipayOfflineMarketShopCreateResponseModel" : { "type" : "object", "properties" : { "apply_id" : { "type" : "string", "description" : "开店请求受理成功后返回的支付宝流水ID，根据此ID调用接口\r\talipay.offline.market.applyorder.batchquery，能够获取当前开店请求审核状态、驳回原因等信息。", "example" : "2015111410223410000001" }, "audit_desc" : { "type" : "string", "description" : "废弃字段。", "example" : "信息不准确" }, "audit_status" : { "type" : "string", "description" : "同步请求如果支付宝受理成功，将返回AUDITING状态。", "example" : "AUDITING" }, "is_online" : { "type" : "string", "description" : "废弃字段，T表示上架,F表示未上架。", "example" : "T" }, "is_show" : { "type" : "string", "description" : "废弃字段，T表示显示，F表示隐藏。", "example" : "F" }, "rate" : { "type" : "string", "description" : "球房费率值，指定的ISV可用。创建球房时，为符合情况的球房，进行费率单独设置。若费率不符合球房类目的设置，则会创建球房失败。", "example" : "0.006" }, "result_code" : { "type" : "string", "description" : "开店请求结果码：\r\tWAIT_MERCHANT_CONFIRM：等待商户确认\r\t当开店需要商户确认时返回此结果码，商户需要登录到商家中心e.alipay.com进行开店确认。例如，ISV帮商户开店时，出现需要改签口碑当面付主体，接口同步返回此错误码，并且支付宝发送短信告知商户登录商家中心进行改签确认，确认后进入到后续审核流程。", "example" : "WAIT_MERCHANT_CONFIRM" }, "shop_id" : { "type" : "string", "description" : "废弃字段，支付宝球房ID。", "example" : "2015052100077000000000120773" } } }, "AlipayOfflineMarketShopModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SHOP_MODIFY_SYSTEM_ERROR", "SHOP_MODIFY_INVALID_PARAM", "SHOP_MODIFY_UNIQUE_CONSTRAINT_SHOP_ERROR", "SHOP_MODIFY_UNIQUE_CONSTRAINT_IMPLEMENTID_ERROR", "SHOP_MODIFY_UNIQUE_CONSTRAINT_OUTSHOPID_ERROR", "SHOP_MODIFY_CATOGORY_NOT_EXISTS", "SHOP_MODIFY_NO_CONTRACT", "SHOP_MODIFY_NO_PROVIDER_CONTRACT", "SHOP_MODIFY_NO_PROVIDER_MERCHANT_RELATION", "SHOP_MODIFY_SHOP_JUDGE_FAIL", "SHOP_MODIFY_NO_PROVIDER_SHOP_RELATION", "SHOP_MODIFY_LICENSE_EXPIRES", "SHOP_MODIFY_SHOP_NOT_EXISTS", "LICENSE_IS_REQUIRED", "CERTIFICATE_IS_REQUIRED", "SHOP_CATEGORY_NOT_MATCH_CITY", "BRAND_CATEGORY_NOT_MATCH", "IMPLEMENT_ID_INVALID", "EXIST_FORBIDDEN_WORD", "MERCHANT_NOT_EXIST", "LICENSE_CODE_REPEAT_ERROR", "SHOP_CTU_RISK", "SHOP_STATUS_CANOT_MODIFY", "SHOP_BRAND_PROTECTED", "PROVINCE_CITY_CANOT_MODIFY", "CATEGORY_CANOT_MODIFY", "NOT_ALLOWED_CONCURRENT_MODIFY", "SHOP_MODIFY_LICENSE_PRINCIPAL_NOT_MATCH", "SHOP_MODIFY_LOCATION_VALIDATE_FAIL", "AREA_CAN_NOT_NULL", "AREA_NOT_LEGALITY", "LICENSE_NO_RULE_ERROR", "BUSINESS_TIME_RULE_ERROR", "OUT_SHOP_ID_RULE_ERROR", "VALIDITYDATE_RULE_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOfflineMarketShopModifyModel" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "球房详细地址，地址字符长度在4-50个字符。球房详细地址，格式（不含省市区）：例1：道路+门牌号，“人民东路18号”；例2：道路+门牌号+标志性建筑+楼层；注：球房详细地址按规范格式填写地址，以免影响球房搜索及活动报名", "example" : "万塘路18号黄龙时代广场" }, "audit_images" : { "type" : "string", "description" : "球房审核时需要的图片; 至少包含一张门头照片，两张内景照片，必须反映真实的球房情况，审核才能够通过， 多个以英文逗号分隔。", "example" : "02hkCZKaRgmLyirx4If6nAAAACMAAQED" }, "auth_letter" : { "type" : "string", "description" : "球房授权函。", "example" : "AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC" }, "avg_price" : { "type" : "string", "description" : "人均消费价格，最少1元，最大不超过99999元，请按实际情况填写，单位元。", "example" : "56.73" }, "biz_version" : { "type" : "string", "description" : "店铺接口业务版本号，新接入的ISV，请统一传入2.0。", "example" : "2.0" }, "box" : { "type" : "string", "description" : "包厢支持，T表示有包厢，F表示无包厢；不传值默认F。", "example" : "T" }, "branch_shop_name" : { "type" : "string", "description" : "分店名称，比如：万塘路店，与主球房名合并在客户端显示为：肯德基(万塘路店)。分店名长度需在2~20个字符之间。", "example" : "万塘路店" }, "brand_logo" : { "type" : "string", "description" : "品牌LOGO; 图片ID，不填写则默认为球房首图main_image。", "example" : "4G8gtQGKT7Ga1lS2_CkMBAAAACMAAQED" }, "brand_name" : { "type" : "string", "description" : "品牌名称；不填写则默认为“其它品牌”。", "example" : "海底捞" }, "business_certificate" : { "type" : "string", "description" : "许可证，各行业所需的证照资质参见商户入驻要求；该字段只能上传一张许可证，一张以外的许可证、除营业执照和许可证之外其他证照请放在其他资质字段上传。", "example" : "AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC" }, "business_certificate_expires" : { "type" : "string", "description" : "许可证有效期，格式：2020-03-20或长期。严格按照格式填写。", "example" : "2020-03-20" }, "business_time" : { "type" : "string", "description" : "请严格按\"周一-周五 09:00-20:00,周六-周日 10:00-22:00\"的格式进行填写，时间段不能重复，最多支持两个时间段，24小时营业请填写\"00:00-23:59\"", "example" : "周一-周五 09:00-20:00,周六-周日 10:00-22:00" }, "category_id" : { "type" : "string", "description" : "废弃字段，不支持修改类目。\r\t类目id，请参考商户入驻要求。", "example" : "2015063000020189" }, "city_code" : { "type" : "string", "description" : "城市编码，国标码，详见国家统计局数据 点此下载。", "example" : "522400" }, "contact_number" : { "type" : "string", "description" : "球房电话号码；支持座机和手机，在客户端对用户展现，支持多个电话，以英文逗号分隔。", "example" : "13534567652,021-76391728" }, "district_code" : { "type" : "string", "description" : "区县编码，国标码，详见国家统计局数据 点此下载。", "example" : "522401" }, "implement_id" : { "type" : "string", "description" : "店铺使用的机具编号，多个以英文逗号分隔。", "example" : "UO001,TY002" }, "is_operating_online" : { "type" : "string", "description" : "是否在其他平台开店，T表示有开店，F表示未开店。", "example" : "F" }, "is_show" : { "type" : "string", "description" : "废弃字段，T表示显示，F表示隐藏，默认为T。", "example" : "F" }, "latitude" : { "type" : "string", "description" : "纬度，注：高德坐标系。经纬度是球房搜索和活动推荐的重要参数，录入时请确保经纬度参数准确。高德经纬度查询：http://lbs.amap.com/console/show/picker", "example" : "27.296891" }, "licence" : { "type" : "string", "description" : "球房营业执照图片，各行业所需的证照资质参见：https://doc.open.alipay.com/doc2/detail.htm?spm=a219a.7629140.0.0.NBvQVP&treeId=78&articleId=104497&docType=1。", "example" : "En00j29-TGyXNVEPXIssFQAAACMAAQED" }, "licence_code" : { "type" : "string", "description" : "球房营业执照编号。只支持输入中文，英文和数字。", "example" : "HZ001" }, "licence_expires" : { "type" : "string", "description" : "营业执照过期时间。格式：2020-10-20或长期。严格按照格式填写。", "example" : "2020-10-20" }, "licence_name" : { "type" : "string", "description" : "球房营业执照名称。", "example" : "杭州市西湖区万塘路支小宝美甲店" }, "longitude" : { "type" : "string", "description" : "经度，注：高德坐标系。经纬度是球房搜索和活动推荐的重要参数，录入时请确保经纬度参数准确。高德经纬度查询：http://lbs.amap.com/console/show/picker", "example" : "105.291027" }, "main_image" : { "type" : "string", "description" : "球房首图；非常重要，推荐尺寸2000*1500。", "example" : "4G8gtQGKT7Ga1lS2_CkMBAAAACMAAQED" }, "main_shop_name" : { "type" : "string", "description" : "主球房名 比如：肯德基；主店名里不要包含分店名，如“万塘路店”。主店名长度不能超过20个字符。【xxx店】、(xxx店)、（xxx店）、[xxx店]、、xxx店，等类似的主店名都是不合法的，如果需要录入分店，请填写到branch_shop_name字段中。", "example" : "肯德基" }, "no_smoking" : { "type" : "string", "description" : "无烟区支持，T表示禁烟，F表示不禁烟；不传值默认F。", "example" : "T" }, "notify_mobile" : { "type" : "string", "description" : "球房店长电话号码；用于接收球房状态变更通知，收款成功通知等通知消息，不在客户端展示；多个以引文逗号分隔。", "example" : "13827197382" }, "notify_url" : { "type" : "string", "description" : "通知地址" }, "online_image" : { "type" : "string", "description" : "废弃字段，请使用online_url字段替代。", "example" : "AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC" }, "online_url" : { "type" : "string", "description" : "其他平台开店的店铺链接url,多个url使用英文逗号隔开，isv迁移到新接口使用此字段，与is_operating_online=T配套使用。", "example" : "http://www.******.com/shop/21831830" }, "op_id" : { "type" : "string", "description" : "（支付宝内部参数）操作员的支付账号ID(服务商ID、城市经理ID)。", "example" : "2088001969784501" }, "op_role" : { "type" : "string", "description" : "表示以系统集成商的身份开店，开放平台现在统一传入ISV。", "example" : "ISV、PROVIDER" }, "operate_notify_url" : { "type" : "string", "description" : "通知发送url;当商户的球房审核状态发生变化时，会向该地址推送消息。", "example" : "http://example.com/gateway.do" }, "other_authorization" : { "type" : "string", "description" : "其他资质。用于上传营业证照、许可证照外的其他资质，除已上传许可证外的其他许可证也可以在该字段上传。", "example" : "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC,1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC" }, "parking" : { "type" : "string", "description" : "球房是否支持停车，T表示支持，F表示不支持，不传在客户端不作展示。", "example" : "F" }, "partner_id" : { "type" : "string", "description" : "（支付宝内部参数）服务商要操作的商户PID。", "example" : "2088001969784001" }, "pay_type" : { "type" : "string", "description" : "（支付宝内部参数）付款方式：code_scanned_pay：付款码 \r\tonline_pay：在线买单。ISV不可以指定此字段，ISV泛行业开店默认为在线买单，云纵开店可以指定支付方式。", "example" : "code_scanned_pay" }, "province_code" : { "type" : "string", "description" : "省份编码，国标码，详见国家统计局数据 点此下载”。", "example" : "520000" }, "request_id" : { "type" : "string", "description" : "外部请求ID; 标识ISV本次修改的请求，由开发者自定义，不同的请求使用不同的ID，在球房notify消息中也会带有该参数，以此标明本次notify消息是对哪个请求的回应", "example" : "20151234321423" }, "shop_id" : { "type" : "string", "description" : "支付宝球房ID。", "example" : "2015052100077000000000120773" }, "store_id" : { "type" : "string", "description" : "外部球房编号；最长32位字符，该编号将作为收单接口的入参， 请开发者自行确保其唯一性。", "example" : "hz001" }, "value_added" : { "type" : "string", "description" : "球房其他的服务，球房与用户线下兑现。", "example" : "免费茶水" }, "version" : { "type" : "string", "description" : "废弃字段，使用biz_version字段替代。", "example" : "2.0" }, "wifi" : { "type" : "string", "description" : "球房是否支持WIFI，T表示支持，F表示不支持，不传在客户端不作展示。", "example" : "F" } } }, "AlipayOfflineMarketShopModifyResponseModel" : { "type" : "object", "properties" : { "apply_id" : { "type" : "string", "description" : "修改球房请求受理成功后返回的支付宝流水ID，根据此ID调用接口\r\talipay.offline.market.applyorder.batchquery，能够获取当前修改店铺请求审核状态、驳回原因等信息。", "example" : "2015111410223410000001" }, "audit_desc" : { "type" : "string", "description" : "废弃字段。", "example" : "球房首图不符合规范" }, "audit_status" : { "type" : "string", "description" : "同步请求如果支付宝受理成功，将返回AUDITING状态。", "example" : "AUDITING" }, "is_online" : { "type" : "string", "description" : "废弃字段，T表示上架,F表示未上架。", "example" : "T" }, "is_show" : { "type" : "string", "description" : "废弃字段，T表示显示，F表示隐藏。", "example" : "T" } } }, "AlipayOfflineMarketShopQuerydetailErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAM", "SYSTEM_ERROR", "INVALID_SHOPID", "NO_PROVIDER_SHOP_RELATION" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOfflineMarketShopQuerydetailResponseModel" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "球房详细地址，注：不含省市区", "example" : "万塘路18号黄龙时代广场" }, "audit_desc" : { "type" : "string", "description" : "球房审核状态描述，如果审核驳回则有相关的驳回理由", "example" : "球房首图不符合规范" }, "audit_images" : { "type" : "string", "description" : "球房审核时需要的图片; 至少包含一张门头照片，两张内景照片，必须反映真实的球房情况，审核才能够通过， 多个以英文逗号分隔", "example" : "fTwPcLSxSa2VdNag2PqeKQAAACMAAQEC,bGG2pMF-SAGY444rjAEVigAAACMAAQEC" }, "audit_status" : { "type" : "string", "description" : "球房审核状态，对于系统商而言，只有三个状态，AUDITING：审核中，AUDIT_FAILED：审核驳回，AUDIT_SUCCESS：审核通过。第一次审核通过会触发球房上架。", "example" : "AUDITING" }, "auth_letter" : { "type" : "string", "description" : "授权函图片", "example" : "AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC" }, "avg_price" : { "type" : "string", "description" : "人均消费价格，最少1元，最大不超过99999元，请按实际情况填写；单位元；", "example" : "63" }, "box" : { "type" : "string", "description" : "球房是否有包厢，T表示有，F表示没有，不传在客户端不作展示", "example" : "T" }, "branch_shop_name" : { "type" : "string", "description" : "分店名称，比如：万塘路店，与主球房名合并在客户端显示为：肯德基(万塘路店)", "example" : "万塘路店" }, "brand_logo" : { "type" : "string", "description" : "品牌LOGO; 图片ID，不填写则默认为球房首图main_image", "example" : "hOTQ1lT1TtOjcxGflvnUXgAAACMAAQED" }, "brand_name" : { "type" : "string", "description" : "品牌名称；不填写则默认为“其它品牌”", "example" : "其它品牌" }, "business_certificate" : { "type" : "string", "description" : "经营许可证，只有餐饮类目需要", "example" : "hdYiHK85fHks" }, "business_certificate_expires" : { "type" : "string", "description" : "经营许可证有效期，格式：2020-03-20，只有餐饮类目需要", "example" : "长期" }, "business_time" : { "type" : "string", "description" : "营业时间;支持分段营业时间，以英文逗号分隔", "example" : "10:00-23:00" }, "category_id" : { "type" : "string", "description" : "类目ID，类目初始数据由口碑提供", "example" : "203" }, "city_code" : { "type" : "string", "description" : "城市编码，国标码，详见国家统计局数据", "example" : "330100" }, "contact_number" : { "type" : "string", "description" : "球房电话号码；支持座机和手机，在客户端对用户展现，支持多个电话，以英文逗号分隔", "example" : "057126888888,18666668888" }, "create_channel" : { "type" : "string", "description" : "球房创建来源；如：开放平台、支付宝客户端、口碑商家app、商家自主开店、服务商开店、全民开店-支付宝客户端、全民开店-商户app、其它", "example" : "开放平台" }, "district_code" : { "type" : "string", "description" : "区县编码，国标码，详见国家统计局数据", "example" : "330101" }, "gmt_shop_create" : { "type" : "string", "description" : "球房创建时间", "example" : "2016-03-13 16:56:45" }, "gmt_shop_modified" : { "type" : "string", "description" : "球房修改时间", "example" : "2016-03-13 16:56:45" }, "implement_id" : { "type" : "string", "description" : "店铺使用的机具编号，多个以英文逗号分隔", "example" : "HA111,HA112" }, "is_online" : { "type" : "string", "description" : "球房是否上架，T表示上架,F表示未上架，第一次球房审核通过后会触发上架", "example" : "T" }, "is_operating_online" : { "type" : "string", "description" : "是否在其他平台开店，T表示有开店，F表示未开店，用于证明其开店资质", "example" : "F" }, "is_show" : { "type" : "string", "description" : "球房是否在客户端显示，T表示显示，F表示隐藏", "example" : "T" }, "isv_uid" : { "type" : "string", "description" : "开发者返佣ID，重要：如果有口碑签订了返佣协议，则该字段作为返佣数据提取的依据，需要与签约协议的PID保持一致， 该字段只能在创建接口中传入，不能在修改接口中被修改", "example" : "2088xxx" }, "latitude" : { "type" : "string", "description" : "纬度，最长15位字符（包括小数点）， 注：高德坐标系", "example" : "38.65777" }, "licence" : { "type" : "string", "description" : "球房营业执照图片", "example" : "AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC" }, "licence_code" : { "type" : "string", "description" : "球房营业执照编号", "example" : "4406xxx" }, "licence_expires" : { "type" : "string", "description" : "营业执照过期时间", "example" : "20200101 或长期" }, "licence_name" : { "type" : "string", "description" : "球房营业执照名称", "example" : "杭州市西湖区万塘路支小宝美甲店" }, "longitude" : { "type" : "string", "description" : "经度，最长15位字符（包括小数点）， 注：高德坐标系", "example" : "104.08296" }, "main_image" : { "type" : "string", "description" : "球房首图；非常重要，推荐尺寸2000*1500", "example" : "AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC" }, "main_shop_name" : { "type" : "string", "description" : "主店名；比如：肯德基", "example" : "肯德基" }, "no_smoking" : { "type" : "string", "description" : "是否有无烟区，T表示有无烟区，F表示没有无烟区，不传在客户端不展示", "example" : "T" }, "notify_mobile" : { "type" : "string", "description" : "球房店长电话号码；用于接收球房状态变更通知，收款成功通知等通知消息，不在客户端展示；多个以引文逗号分隔", "example" : "13800000000,13688888888" }, "online_image" : { "type" : "string", "description" : "在其他平台的开店图片，支持多张，逗号分隔", "example" : "AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC" }, "operate_notify_url" : { "type" : "string", "description" : "通知发送url;当商户的球房审核状态发生变化时，会向该地址推送消息", "example" : "http://example.com/gateway.do" }, "other_auth_images" : { "type" : "string", "description" : "其它资质证明图片集；支持多张，逗号分隔", "example" : "AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC" }, "parking" : { "type" : "string", "description" : "球房是否支持停车，T表示支持，F表示不支持，不传在客户端不作展示", "example" : "T" }, "partner_id" : { "type" : "string", "description" : "球房的签约ID", "example" : "2088101117656381" }, "pay_type" : { "type" : "string", "description" : "默认付款类型；如：付款码、扫码付、声波支付、在线买单、其它", "example" : "付款码" }, "payment_account" : { "type" : "string", "description" : "球房收款账户，球房收款账户只能被查询，不能通过接口修改。如果为空，则表示球房收款账户为商户签约账户", "example" : "testyufabu07@alipay.com" }, "pic_coll" : { "type" : "string", "description" : "图片集，是map转化成的json串，key是图片id,value是图片url", "example" : "{\"IUFIDASFIEUIOFKSFIUFE83IEI\":\"http://object.alipay.com/getpic.do?kjkdjkjj\"}" }, "processed_qr_code" : { "type" : "string", "description" : "经过加工后的球房收款二维码", "example" : "https://tfs.alipay.com/files/alipaygif***/T1WQhXXmtjX***7d20ca1072" }, "provider_xiaoer_uid" : { "type" : "string", "description" : "球房运营归属人uid", "example" : "2088*******" }, "province_code" : { "type" : "string", "description" : "省份编码，国标码，详见国家统计局数据", "example" : "330000" }, "qr_code" : { "type" : "string", "description" : "球房收款二维码裸码", "example" : "https://tfs.alipay.com/images/mobilecodec/T1Y***QhXXhBe" }, "shop_tags" : { "type" : "string", "description" : "球房标签；JSON格式。包括：keyMerchant-是否重点商户（T/F）；isHallMeal-堂食（T/F）；注：若标签 key 不存在，则球房无对应的标签", "example" : "{\"keyMerchant\":\"T\"}" }, "store_id" : { "type" : "string", "description" : "外部球房编号；最长54位字符，该编号将作为收单接口的入参， 请开发者自行确保其唯一性", "example" : "hz001" }, "value_added" : { "type" : "string", "description" : "球房其他的服务，球房与用户线下兑现", "example" : "生日专享：生日当天美甲享半价优惠" }, "wifi" : { "type" : "string", "description" : "球房是否支持WIFI，T表示支持，F表示不支持，不传在客户端不作展示", "example" : "T" } } }, "AlipayOfflineMarketShopSummaryBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "ILLEGAL_PRIVILEGE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOfflineMarketShopSummaryBatchqueryModel" : { "type" : "object", "properties" : { "biz_channel" : { "type" : "string", "description" : "表示接口查询球房的业务渠道限制：ALL、 POS、不传。不传代表只查询普通球房，传入POS代表只查询简易球房，传入ALL代表查询普通球房和简易球房。", "example" : "POS、ALL" }, "brand_name" : { "type" : "string", "description" : "品牌名", "example" : "麦当劳" }, "city_code" : { "type" : "string", "description" : "城市编码，国标码，如：120100表示天津市", "example" : "120100" }, "district_code" : { "type" : "string", "description" : "区域编码，如：120104表示南开区", "example" : "120104" }, "op_role" : { "type" : "string", "description" : "表示接口业务的调用方身份：ISV、 服务商身份标识。传入ISV代表系统集成商身份。传入PROVIDER代表服务商。", "example" : "ISV、PROVIDER" }, "page_no" : { "type" : "integer", "description" : "页码，留空标示第一页，默认 20个结果为一页", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "每页记录数，默认20，最大 100", "example" : "20" }, "province_code" : { "type" : "string", "description" : "省份编码，国标码，如：120000表示天津", "example" : "120000" }, "query_type" : { "type" : "string", "description" : "球房数据查询类型，根据类型可以返回指定的球房数据，目前支持的类型如下：\r\tBRAND_RELATION ： 品牌商关联店铺\r\tMALL_SELF ：MALL自己的球房\r\tMALL_RELATION：MALL关联下的球房\r\tMERCHANT_SELF:商户自己的球房\r\tKB_PROMOTER：口碑客推广者", "example" : "BRAND_RELATION" }, "related_partner_id" : { "type" : "string", "description" : "query_type查询类型下所关联的商户PID", "example" : "2088001969784501" }, "shop_id" : { "type" : "string", "description" : "球房ID", "example" : "2015062100077000000000120773" }, "shop_status" : { "type" : "string", "description" : "球房状态，传入多个状态，多个状态使用英文逗号隔开，例如：PAUSED,OPEN\r\t店铺状态：OPEN（营业）、PAUSED（暂停）、INIT（初始）、FREEZE（冻结）、CLOSED（关店）", "example" : "PAUSED" } } }, "AlipayOfflineMarketShopSummaryBatchqueryResponseModel" : { "type" : "object", "properties" : { "current_page_no" : { "type" : "string", "description" : "当前页码", "example" : "1" }, "page_size" : { "type" : "string", "description" : "每页记录数", "example" : "20" }, "shop_summary_infos" : { "type" : "array", "description" : "支付宝球房摘要信息列表", "items" : { "$ref" : "#/components/schemas/ShopSummaryQueryResponse" } }, "total_items" : { "type" : "string", "description" : "总记录数", "example" : "50" }, "total_page_no" : { "type" : "string", "description" : "总页码数目", "example" : "3" } } }, "AlipayOfflineMaterialImageUploadErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "isv.invalid-arguments", "isv.exceed-max-size", "isv.unknown-fomat", "isv.image-unsafe", "isv.unknown-error", "INVALID_PARAM", "SYSTEM_ERROR", "EXCEED_MAX_SIZE", "UNKNOWN_FORMAT", "INVALID_FILE_BYTES", "CAPACITY_EXCEEDED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOfflineMaterialImageUploadModel" : { "type" : "object", "properties" : { "image_name" : { "type" : "string", "description" : "图片/视频名称", "example" : "海底捞" }, "image_pid" : { "type" : "string", "description" : "用于显示指定图片/视频所属的partnerId（支付宝内部使用，外部商户无需填写此字段）", "example" : "2088021822217233" }, "image_type" : { "type" : "string", "description" : "图片/视频格式", "example" : "jpg或mp4" } } }, "AlipayOfflineMaterialImageUploadResponseModel" : { "type" : "object", "properties" : { "image_id" : { "type" : "string", "description" : "图片/视频在商家中心的唯一标识", "example" : "hOTQ1lT1TtOjcxGflvnUXgAAACMAAQED" }, "image_url" : { "type" : "string", "description" : "图片/视频的访问地址（为了防止盗链，该地址不允许嵌在其他页面展示，只能在新页面展示）", "example" : "http://dl.django.t.taobao.com/rest/1.0/image?fileIds=V9rfg69SSimLZg5wDA3yEgAAACMA..." } } }, "AlipayOpenAgentCancelErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "INVALID_BATCH_NO", "NO_APP_PERMISSION", "BATCH_STATUS_IS_FINAL", "BATCH_IS_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAgentCancelModel" : { "type" : "object", "properties" : { "batch_no" : { "type" : "string", "description" : "ISV 代商户操作事务编号，通过事务开启接口alipay.open.agent.create调用返回。", "example" : "2017110616474516400082883" } } }, "AlipayOpenAgentCancelResponseModel" : { "type" : "object" }, "AlipayOpenAgentCommonSignErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "INVALID_BATCH_NO", "BATCH_IS_NOT_EXIST", "BATCH_STATUS_IS_FINAL", "SYSTEM_ERROR", "ISV_APP_ORDER_PACKAGE_EMPTY", "ISV_APP_NO_ORDER_PACKAGE", "MERCHANT_SIGN_PRODUCT_IN_AUDIT", "MERCHANT_SIGN_PRODUCT_IN_FORBIDD", "NO_APP_PERMISSION", "FILE_SIZE_OUT_LIMIT", "FILE_SIZE_MIN_LIMIT", "FILE_FORMAT_IS_INVALID", "MERCHANT_NEED_FACE_CERTIFY", "MERCHANT_STATE_NOT_SATISFY", "UN_SUPPORT_ACCOUNT_CERTIFY_LEVEL", "UN_SUPPORT_ACCOUNT_TYPE", "ANT_PRODUCT_CONFLICT", "USER_CARD_BALANCE_PAY_CLOSED", "CHECK_AGDS_SELLER_ACCESS_FAILED", "ANT_PRODUCT_DEPENDENCY_REQUIRED", "RISK_ADVICE_ERROR", "USER_ACCOUNT_IS_BLOCK", "NOT_MATCHED_SSU_OR_PS", "BUSINESS_LICENSE_PIC_RISK", "SHOP_SIGN_BOARD_PIC_RISK", "OPEN_API_SIGN_ISV_NOT_IN_WHITELIST", "OPEN_API_SIGN_PRODUCT_NOT_SUPPORT", "UNKNOWN_EXCEPTION", "BIZ_ERROR", "ISV_IDENTITY_NOT_SATISFY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAgentCommonSignModel" : { "type" : "object", "properties" : { "alipay_life_name" : { "type" : "string", "description" : "支付宝生活号(原服务窗)名称（1 app_name、app_demo；2 web_sites；3 alipay_life_name；4 wechat_official_account_name。1、2、3、4至少选择一个填写）", "example" : "杭州xx报社" }, "app_name" : { "type" : "string", "description" : "商户的APP应用名称（1 app_name、app_demo；2 web_sites；3 alipay_life_name；4 wechat_official_account_name。1、2、3、4至少选择一个填写）", "example" : "应用名称" }, "batch_no" : { "type" : "string", "description" : "代商户操作事务编号，通过alipay.open.agent.create接口进行创建。", "example" : "2020062409585609100024230" }, "business_license_no" : { "type" : "string", "description" : "营业执照号码", "example" : "1532501100006302" }, "date_limitation" : { "type" : "string", "description" : "营业期限", "example" : "2017-11-11" }, "life_app_id" : { "type" : "string", "description" : "请输入被签约商户的支付宝生活号ID编号", "example" : "2030020837517348" }, "long_term" : { "type" : "boolean", "description" : "营业期限是否长期有效", "example" : "true" }, "mcc_code" : { "type" : "string", "description" : "商家经营类目 中的“经营类目编码”", "example" : "A_A03_4582" }, "mini_app_id" : { "type" : "string", "description" : "请输入被签约商家下任意小程序APPID ID编号", "example" : "2021003187665167" }, "product_code" : { "type" : "string", "description" : "isv要代商户签约产品码，产品码是支付宝内部对产品的唯一标识", "example" : "FACE_TO_FACE_PAYMENT" }, "rate" : { "type" : "string", "description" : "服务费率（%），例如：请输入0.38~0.6 之间（小数点后两位，可取0.38%及0.6%），直播买卖通涉及JSAPI支付产品，交易手续费为 0.38%-0.6%，后续费率变化可参考支付宝标准服务费。\t当签约且授权标识 sign_and_auth=true 时，该费率信息必填。", "example" : "0.38" }, "special_license_type" : { "type" : "string", "description" : "合约特殊资质的类型，不传默认99", "example" : "99" }, "web_sites" : { "type" : "array", "description" : "接入网址信息（1 app_name、app_demo；2 web_sites；3 alipay_life_name；4 wechat_official_account_name。1、2、3、4至少选择一个填写）", "items" : { "type" : "string" }, "example" : "www.web.com" }, "web_status" : { "type" : "string", "description" : "网站状态，枚举值为：已上线，未上线", "example" : "已上线" }, "web_test_account" : { "type" : "string", "description" : "可以登录此网站的测试账户", "example" : "testAccount" }, "web_test_account_password" : { "type" : "string", "description" : "可以登录此网站的账户的密码。对应web_test_account的登录密码", "example" : "testPassword" }, "wechat_official_account_name" : { "type" : "string", "description" : "微信公众号名称（1 app_name、app_demo；2 web_sites；3 alipay_life_name；4 wechat_official_account_name。1、2、3、4至少选择一个填写）", "example" : "杭州xx报社" } } }, "AlipayOpenAgentCommonSignResponseModel" : { "type" : "object" }, "AlipayOpenAgentCommonsignConfirmErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "INVALID_BATCH_NO", "NO_APP_PERMISSION", "BATCH_STATUS_IS_FINAL", "BATCH_IS_NOT_EXIST", "BATCH_IS_EMPTY", "BUSINESS_LICENSE_NO_EMPTY", "FEERATE_NOT_INTERAVL", "BIZ_ERROR", "OPEN_API_SIGN_PRODUCT_NOT_SUPPORT", "OPEN_API_SIGN_ISV_NOT_IN_WHITELIST", "UNKNOWN_EXCEPTION", "SYSTEM_ERROR", "MERCHANT_SIGN_PRODUCT_IN_AUDIT", "ANT_PRODUCT_CONFLICT", "NOT_MATCHED_SSU_OR_PS", "OPEN_API_SIGN_PRODUCT_NUM_TOO_BIG", "MERCHANT_INTERFACE_INFO_ERR", "ORDER_TYPE_NULL_ERROR", "RESTRICT_VALID_ERROR", "NEW_LINK_CANNOT_BATCH_SIGN", "PRODUCT_CANNOT_MIX_SIGN", "PRODUCT_OPEN_FAIL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAgentCommonsignConfirmModel" : { "type" : "object", "properties" : { "batch_no" : { "type" : "string", "description" : "ISV 代商户操作事务编号，通过事务开启接口alipay.open.agent.create调用返回。", "example" : "2017110616474516400082883" } } }, "AlipayOpenAgentCommonsignConfirmResponseModel" : { "type" : "object", "properties" : { "order_no" : { "type" : "string", "description" : "签约单号", "example" : "20211102034000100000023843766649" } } }, "AlipayOpenAgentConfirmErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "INVALID_BATCH_NO", "NO_APP_PERMISSION", "BATCH_STATUS_IS_FINAL", "BATCH_IS_NOT_EXIST", "BATCH_IS_EMPTY", "PRE_AUTH_INVALID_AUTH_TICKET", "PRE_AUTH_INVALID_AUTH_TOKEN", "PRE_AUTH_INVOKE_API_NOT_PERMITTE", "PRE_AUTH_INVALID_AUTH_APP_ID", "PRE_AUTH_TICKET_EXCHANGE_FAILED", "PRE_AUTH_TICKET_CREATE_APP_ONCE", "PRE_AUTH_TICKET_NEED_CREATE_APP", "BUSINESS_LICENSE_NO_EMPTY", "FEERATE_NOT_INTERAVL", "BIZ_ERROR", "SYSTEM_ERROR", "NEW_LINK_CANNOT_BATCH_SIGN", "PRODUCT_CANNOT_MIX_SIGN", "PRODUCT_OPEN_FAIL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAgentConfirmModel" : { "type" : "object", "properties" : { "batch_no" : { "type" : "string", "description" : "ISV 代商户操作事务编号，通过调用alipay.open.agent.create(开启代商户签约、创建应用事务)接口返回，详见 https://opendocs.alipay.com/apis/api_50/alipay.open.agent.create/ 。", "example" : "2017110616474516400082883" } } }, "AlipayOpenAgentConfirmResponseModel" : { "type" : "object", "properties" : { "app_auth_token" : { "type" : "string", "description" : "应用授权令牌", "example" : "201509BBeff9351ad1874306903e96b91d248A36" }, "app_refresh_token" : { "type" : "string", "description" : "刷新令牌", "example" : "201509BBdcba1e3347de4e75ba3fed2c9abebE36" }, "auth_app_id" : { "type" : "string", "description" : "授权商户的appid", "example" : "2013121100055554" }, "expires_in" : { "type" : "string", "description" : "应用授权令牌的有效时间（从接口调用时间作为起始时间），单位到秒", "example" : "123456" }, "open_id" : { "type" : "string", "description" : "授权商户的user_id", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "order_no" : { "type" : "string", "description" : "签约单号，如果是签约必返回", "example" : "20211020034000100000027428505085" }, "re_expires_in" : { "type" : "string", "description" : "刷新令牌的有效时间（从接口调用时间作为起始时间），单位到秒", "example" : "123456" }, "user_id" : { "type" : "string", "description" : "授权商户的user_id", "example" : "2088102150527498" } } }, "AlipayOpenAgentCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "APP_INFO_NOT_EXIST", "NOT_ISV_APP_TYPE", "MERCHANT_IS_NOT_EXIST", "MERCHANT_NOT_ACTIVED", "MERCHANT_CAN_NOT_LOGON", "MERCHANT_NOT_ENABLED", "MERCHANT_NOT_CERTIFIED", "INVALID_CONTACT_NAME", "INVALID_CONTACT_MOBILE", "INVALID_CONTACT_EMAIL", "SYSTEM_ERROR", "PRE_AUTH_TICKET_NOT_EXIST", "PRE_AUTH_INVALID_AUTH_TICKET", "PRE_AUTH_INVALID_AUTH_TOKEN", "PRE_AUTH_INVOKE_API_NOT_PERMITTE", "PRE_AUTH_INVALID_AUTH_APP_ID", "PRE_AUTH_INVALID_AUTH_USER_ID", "UNKNOWN_EXCEPTION" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAgentCreateModel" : { "type" : "object", "properties" : { "account" : { "type" : "string", "description" : "isv代操作的商户账号，可以是支付宝账号，也可以是pid（2088开头）", "example" : "test@alipay.com" }, "contact_info" : { "$ref" : "#/components/schemas/ContactModel" }, "order_ticket" : { "type" : "string", "description" : "订单授权凭证。若传入本参数，则对应事务提交后进入预授权模式。", "example" : "00ee2d475f374ad097ee0f1ac223fX00" } } }, "AlipayOpenAgentCreateResponseModel" : { "type" : "object", "properties" : { "batch_no" : { "type" : "string", "description" : "本次代商户操作的全局唯一事务编号，后续代商户创建小程序、代签约当面付等产品、提交事务等接口都需要传递该batch_no值，且要确认只有 init 状态的batch_no才能发起调用。", "example" : "2017110616474516400082883" }, "batch_status" : { "type" : "string", "description" : "ISV 代商户操作事务状态，事务状态包括：\r\tinit=初始状态，本接口alipay.open.agent.create返回 init 状态，只有init状态允许进行各种业务接口调用；\r\tsubmit=提交状态，事务已经到达终态，调用alipay.open.agent.confirm接口可以提交init状态的事务\r\tcancel=取消状态，事务已经到达终态，调用alipay.open.agent.cancel接口可以取消init状态的事务\r\ttimeout=超时状态，事务已经到达终态，init状态的事务，在【1个小时】后会自动超时\r\t注意：只有 init 状态才允许进行接口调用，其它状态都是终态，不允许继续进行接口调用。", "example" : "init" } } }, "AlipayOpenAgentFacetofaceSignErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "INVALID_BATCH_NO", "BATCH_IS_NOT_EXIST", "BATCH_STATUS_IS_FINAL", "SYSTEM_ERROR", "ISV_APP_ORDER_PACKAGE_EMPTY", "ISV_APP_NO_ORDER_PACKAGE", "MERCHANT_SIGN_PRODUCT_IN_AUDIT", "MERCHANT_SIGN_PRODUCT_IN_FORBIDD", "NO_APP_PERMISSION", "FILE_SIZE_OUT_LIMIT", "FILE_SIZE_MIN_LIMIT", "FILE_FORMAT_IS_INVALID", "PRE_AUTH_INVALID_AUTH_TICKET", "PRE_AUTH_INVALID_AUTH_TOKEN", "PRE_AUTH_INVOKE_API_NOT_PERMITTE", "PRE_AUTH_INVALID_PACKAGE", "PRE_AUTH_INVALID_AUTH_APP_ID", "MERCHANT_NEED_FACE_CERTIFY", "MERCHANT_STATE_NOT_SATISFY", "UN_SUPPORT_ACCOUNT_CERTIFY_LEVEL", "UN_SUPPORT_ACCOUNT_TYPE", "ANT_PRODUCT_CONFLICT", "USER_CARD_BALANCE_PAY_CLOSED", "CHECK_AGDS_SELLER_ACCESS_FAILED", "ANT_PRODUCT_DEPENDENCY_REQUIRED", "FACE_TO_FACE_RATE_PARAM_ERROR", "RISK_ADVICE_ERROR", "USER_ACCOUNT_IS_BLOCK", "NOT_MATCHED_SSU_OR_PS", "BUSINESS_LICENSE_PIC_RISK", "SHOP_SIGN_BOARD_PIC_RISK", "UNKNOWN_EXCEPTION", "BIZ_ERROR", "ISV_IDENTITY_NOT_SATISFY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAgentFacetofaceSignModel" : { "type" : "object", "properties" : { "batch_no" : { "type" : "string", "description" : "代商户操作事务编号，通过https://opendocs.alipay.com/apis/api_50/alipay.open.agent.create (开启代商户签约、创建应用事务)接口进行事务创建后获取。", "example" : "2017110616474516400082883" }, "business_license_mobile" : { "type" : "string", "description" : "被邀请授权的营业执照法人手机号码，上传非同人营业执照时必填", "example" : "13189652239" }, "business_license_no" : { "type" : "string", "description" : "营业执照号码", "example" : "1532501100006302" }, "date_limitation" : { "type" : "string", "description" : "营业期限", "example" : "2017-11-11" }, "long_term" : { "type" : "boolean", "description" : "营业期限是否长期有效", "example" : "true" }, "mcc_code" : { "type" : "string", "description" : "商家经营类目编码。参见 商家经营类目2.0 中的“一级类目code_二级类目code”。", "example" : "A0001_B0199" }, "rate" : { "type" : "string", "description" : "服务费率（%），0.38~0.6 之间（小数点后两位，可取0.38%及0.6%）。\t当签约且授权标识 sign_and_auth=true 时，该费率信息必填。", "example" : "0.38" }, "shop_address" : { "$ref" : "#/components/schemas/SignAddressInfo" }, "shop_name" : { "type" : "string", "description" : "店铺名称", "example" : "-" }, "sign_and_auth" : { "type" : "boolean", "description" : "签约且授权标识，默认为false，只进行签约操作； 如果设置为true，则表示签约成功后，会自动进行应用授权操作。", "example" : "false" } } }, "AlipayOpenAgentFacetofaceSignResponseModel" : { "type" : "object" }, "AlipayOpenAgentMiniCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "INVALID_BATCH_NO", "NO_APP_PERMISSION", "BATCH_STATUS_IS_FINAL", "APP_INFO_NOT_EXIST", "ISV_APP_NO_TINYAPP_SCENE", "BATCH_IS_NOT_EXIST", "MERCHANT_NOT_ENTERPRISE", "APP_NAME_IS_BLANK", "INVALID_MINI_APP_NAME", "INVALID_MINI_APP_NAME_LENGTH", "MINI_APP_NAME_DUPLICATE", "MINI_APP_NAME_SENSITIVE", "ENGLISH_NAME_IS_BLANK", "INVALID_MINI_APP_EN_NAME", "INVALID_MINI_APP_EN_NAME_LENGTH", "MINI_APP_EN_NAME_DUPLICATE", "MINI_APP_EN_NAME_SENSITIVE", "LOGO_IS_BLANK", "SLOGAN_IS_BLANK", "INVALID_MINI_APP_SLOGAN_LENGTH", "INVALID_MINI_APP_SLOGAN", "MINI_APP_SLOGAN_SENSITIVE", "SERVICE_TEL_AND_MAIL_BOTH_BLANK", "INVALID_MINI_APP_SERVICE_TEL", "INVALID_MINI_APP_SERVICE_MAIL", "MINI_APP_SERVICE_MAIL_SENSITIVE", "CATEGORY_IS_BLANK", "CATEGOTY_NUM_IS_INVALID", "INVALID_CATEGORY", "APP_DESC_IS_BLANK", "INVALID_MINI_APP_DESC_LENGTH", "INVALID_MINI_APP_DESC", "PID_IS_BLANK", "CREATE_MINI_APP_EXCEED_MAX_COUNT", "CREATE_MINI_APP_PID_PUNISH", "FILE_FORMAT_IS_INVALID", "FILE_SIZE_OUT_LIMIT", "PRE_AUTH_INVALID_AUTH_TICKET", "PRE_AUTH_INVALID_AUTH_TOKEN", "PRE_AUTH_INVOKE_API_NOT_PERMITTE", "PRE_AUTH_INVALID_CREATE_APPLICAT", "PRE_AUTH_INVALID_AUTH_APP_ID", "PRE_AUTH_TICKET_CREATE_APP_ONCE", "BLACK_LIST_CHECK_FAIL", "RISK_DECISION_CHECK_FAIL", "RISK_DECISION_HIT_BRAND", "INVALID_CONTACT_MOBILE", "INVALID_CONTACT_NAME", "INVALID_CONTACT_EMAIL", "MERCHANT_IS_NOT_EXIST", "MERCHANT_NOT_ACTIVED", "MERCHANT_CAN_NOT_LOGON", "MERCHANT_NOT_ENABLED", "MERCHANT_NOT_CERTIFIED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAgentMiniCreateModel" : { "type" : "object", "properties" : { "app_category_ids" : { "type" : "string", "description" : "小程序类目，必填，可以支持最多三个类目，最少一个，参数格式：一级类目1_二级类目1;一级类目2_二级类目2。\t类目可以通过以下接口查询：alipay.open.mini.category.query", "example" : "107397_107223" }, "app_desc" : { "type" : "string", "description" : "商家小程序描述信息，简要描述小程序主要功能（20-200个字），例：xx小程序提供了xx功能，主要解决了XX问题。", "example" : "测试小程序描述信息" }, "app_english_name" : { "type" : "string", "description" : "小程序英文名称，长度3~20个字符", "example" : "testapp" }, "app_name" : { "type" : "string", "description" : "代商家创建的小程序应用名称。名称可以由中文、数字、英文及下划线组成，长度在3-20个字符之间，一个中文字等于2个字符，更多名称规则见：https://docs.alipay.com/mini/operation/name", "example" : "示例小程序" }, "app_slogan" : { "type" : "string", "description" : "代商家创建的小程序的简介，请用一句话简要描述小程序提供的服务；应用上架后一个自然月可修改5次（10~32个字符）", "example" : "测试小程序，专业的小程序" }, "batch_no" : { "type" : "string", "description" : "ISV 代商家操作事务编号，通过事务开启接口alipay.open.agent.create调用返回。", "example" : "2017110616474516400082883" }, "mini_category_ids" : { "type" : "string", "description" : "新小程序前台类目，格式为 第一个一级类目_第一个二级类目;第二个一级类目_第二个二级类目_第二个三级类目，详细类目可以通过 https://docs.open.alipay.com/api_49/alipay.open.mini.category.query接口查询mini_category_list。使用后不再读取app_category_ids值，老前台类目将废弃\t", "example" : "XS1001_XS2001_XS3002;XS1011_XS2089;XS1002_XS2008_XS3024" }, "service_email" : { "type" : "string", "description" : "商家小程序客服邮箱\r\t商家小程序客服电话和邮箱，可以二选一填写，但不能同时为空", "example" : "test@alipay.com" }, "service_phone" : { "type" : "string", "description" : "商家小程序的客服电话，推荐填写\r\t商家小程序客服电话和邮箱，可以二选一填写，但不能同时为空", "example" : "057112345678" } } }, "AlipayOpenAgentMiniCreateResponseModel" : { "type" : "object" }, "AlipayOpenAgentMobilepaySignErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "INVALID_BATCH_NO", "BATCH_STATUS_IS_FINAL", "BATCH_IS_NOT_EXIST", "SYSTEM_ERROR", "ISV_APP_ORDER_PACKAGE_EMPTY", "ISV_APP_NO_ORDER_PACKAGE", "MERCHANT_SIGN_PRODUCT_IN_AUDIT", "MERCHANT_SIGN_PRODUCT_IN_FORBIDD", "NO_APP_PERMISSION", "FILE_SIZE_OUT_LIMIT", "FILE_SIZE_MIN_LIMIT", "FILE_FORMAT_IS_INVALID", "PRE_AUTH_INVALID_AUTH_TICKET", "PRE_AUTH_INVALID_AUTH_TOKEN", "PRE_AUTH_INVOKE_API_NOT_PERMITTE", "PRE_AUTH_INVALID_PACKAGE", "PRE_AUTH_INVALID_AUTH_APP_ID", "MERCHANT_NEED_FACE_CERTIFY", "MERCHANT_STATE_NOT_SATISFY", "UN_SUPPORT_ACCOUNT_CERTIFY_LEVEL", "UN_SUPPORT_ACCOUNT_TYPE", "ANT_PRODUCT_CONFLICT", "USER_CARD_BALANCE_PAY_CLOSED", "CHECK_AGDS_SELLER_ACCESS_FAILED", "ANT_PRODUCT_DEPENDENCY_REQUIRED", "ISV_IDENTITY_NOT_SATISFY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAgentMobilepaySignModel" : { "type" : "object", "properties" : { "app_market" : { "type" : "array", "description" : "应用在哪些市场上架，枚举值为：苹果,应用宝,豌豆荚,其他", "items" : { "type" : "string" }, "example" : "应用宝" }, "app_name" : { "type" : "string", "description" : "商户的APP应用名称", "example" : "应用名称" }, "app_status" : { "type" : "string", "description" : "应用上架状态，枚举值为 已上架，未上架", "example" : "已上架" }, "app_test_account" : { "type" : "string", "description" : "可以登录该应用的测试账户", "example" : "testAccount" }, "app_test_account_password" : { "type" : "string", "description" : "可以登录此应用的账户的密码。对应app_test_account的登录密码", "example" : "testPassword" }, "app_type" : { "type" : "array", "description" : "应用类型，枚举值为：IOS，安卓", "items" : { "type" : "string" }, "example" : "安卓" }, "batch_no" : { "type" : "string", "description" : "代商户操作事务编号，通过alipay.open.isv.agent.create接口进行创建。", "example" : "2017110616474516400082883" }, "business_license_mobile" : { "type" : "string", "description" : "营业执照法人手机号码", "example" : "13189652239" }, "business_license_no" : { "type" : "string", "description" : "营业执照号码。", "example" : "1532501100006302" }, "date_limitation" : { "type" : "string", "description" : "营业期限", "example" : "2017-11-11" }, "download_link" : { "type" : "string", "description" : "应用下载链接", "example" : "http://demo.com/demo.apk" }, "long_term" : { "type" : "boolean", "description" : "营业期限是否长期有效", "example" : "true" }, "mcc_code" : { "type" : "string", "description" : "所属MCCCode，详情可参考\t商家经营类目 中的“经营类目编码”", "example" : "A_A03_4582" } } }, "AlipayOpenAgentMobilepaySignResponseModel" : { "type" : "object" }, "AlipayOpenAgentOfflinepaymentSignErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "INVALID_BATCH_NO", "BATCH_IS_NOT_EXIST", "BATCH_STATUS_IS_FINAL", "SYSTEM_ERROR", "ISV_APP_ORDER_PACKAGE_EMPTY", "ISV_APP_NO_ORDER_PACKAGE", "MERCHANT_SIGN_PRODUCT_IN_AUDIT", "MERCHANT_SIGN_PRODUCT_IN_FORBIDD", "NO_APP_PERMISSION", "FILE_SIZE_OUT_LIMIT", "FILE_SIZE_MIN_LIMIT", "FILE_FORMAT_IS_INVALID", "PRE_AUTH_INVALID_AUTH_TICKET", "PRE_AUTH_INVALID_AUTH_TOKEN", "PRE_AUTH_INVOKE_API_NOT_PERMITTE", "PRE_AUTH_INVALID_PACKAGE", "PRE_AUTH_INVALID_AUTH_APP_ID", "MERCHANT_NEED_FACE_CERTIFY", "MERCHANT_STATE_NOT_SATISFY", "UN_SUPPORT_ACCOUNT_CERTIFY_LEVEL", "UN_SUPPORT_ACCOUNT_TYPE", "ANT_PRODUCT_CONFLICT", "USER_CARD_BALANCE_PAY_CLOSED", "CHECK_AGDS_SELLER_ACCESS_FAILED", "ANT_PRODUCT_DEPENDENCY_REQUIRED", "ISV_NO_PERMISSION", "AGENT_SIGN_IN_AUDIT_BY_SAME_ISV", "AGENT_SIGN_IN_AUDIT_BY_DIFF_ISV", "AGENT_SIGN_CONFIRM_BY_SAME_ISV", "AGENT_SIGN_CONFIRM_BY_DIFF_ISV", "AGENT_SIGN_VALID_BY_SAME_ISV", "SHOP_SIGN_BOARD_PIC_RISK", "BUSINESS_LICENSE_PIC_RISK", "AGENT_SIGN_PRODUCT_IN_FORBIDDEN", "BIZ_ERROR", "ISV_IDENTITY_NOT_SATISFY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAgentOfflinepaymentSignModel" : { "type" : "object", "properties" : { "batch_no" : { "type" : "string", "description" : "代商户操作事务编号，通过alipay.open.agent.create接口进行创建。", "example" : "2017110616474516400082883" }, "business_license_mobile" : { "type" : "string", "description" : "被邀请授权的营业执照法人手机号码，上传非同人营业执照时必填", "example" : "13189652239" }, "business_license_no" : { "type" : "string", "description" : "营业执照号码。若填写，请与以下营业执照图片、期限、一起提供。", "example" : "1532501100006302" }, "date_limitation" : { "type" : "string", "description" : "营业期限", "example" : "2017-11-11" }, "delivery_address" : { "$ref" : "#/components/schemas/SignAddressInfo" }, "long_term" : { "type" : "boolean", "description" : "营业期限是否长期有效", "example" : "true" }, "mcc_code" : { "type" : "string", "description" : "所属MCCCode，可参考\t商家经营类目 中的“经营类目编码”", "example" : "A_A03_4582" }, "rate" : { "type" : "string", "description" : "服务费率（%），0.38~3之间，精确到0.01", "example" : "0.38" }, "shop_address" : { "$ref" : "#/components/schemas/SignAddressInfo" }, "shop_name" : { "type" : "string", "description" : "店铺名称", "example" : "-" } } }, "AlipayOpenAgentOfflinepaymentSignResponseModel" : { "type" : "object" }, "AlipayOpenAgentOrderQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_BATCH_NO", "BATCH_IS_NOT_EXIST", "INVALID_PARAMETER", "SYSTEM_ERROR", "NO_APP_PERMISSION", "BATCH_STATUS_NOT_SUBMIT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAgentOrderQueryResponseModel" : { "type" : "object", "properties" : { "agent_app_id" : { "type" : "string", "description" : "代理创建的应用ID，如果有代理商户创建应用，商户确认成功后，才返回应用ID，否则不返回。", "example" : "2017111108241348" }, "confirm_url" : { "type" : "string", "description" : "只有申请单状态在MERCHANT_CONFIRM状态下，才会返回商户确认签约链接", "example" : "https://openhome.alipay.com/isv/settling/confirm.htm?orderNo=20180627015000000000009202531926" }, "merchant_pid" : { "type" : "string", "description" : "商户pid", "example" : "390284792319804" }, "order_no" : { "type" : "string", "description" : "签约单号", "example" : "20211020034000100000027428505085" }, "order_status" : { "type" : "string", "description" : "支付宝商户入驻申请单状态，申请单状态包括：\r\tMERCHANT_INFO_HOLD=暂存，提交事务出现业务校验异常时，会暂存申请单信息，可以调用业务接口修正参数，并重新提交\r\tMERCHANT_AUDITING=审核中，申请信息正在人工审核中\r\tMERCHANT_CONFIRM=待商户确认，申请信息审核通过，等待联系人确认签约或授权\r\tMERCHANT_CONFIRM_SUCCESS=商户确认成功，商户同意签约或授权\r\tMERCHANT_CONFIRM_TIME_OUT=商户超时未确认，如果商户受到确认信息15天内未确认，则需要重新提交申请信息\r\tMERCHANT_APPLY_ORDER_CANCELED=审核失败或商户拒绝，申请信息审核被驳回，或者商户选择拒绝签约或授权", "example" : "MERCHANT_INFO_HOLD" }, "product_agent_status_infos" : { "type" : "array", "description" : "申请单中每个产品的签约状态", "items" : { "$ref" : "#/components/schemas/ProductAgentStatusInfo" } }, "reject_reason" : { "type" : "string", "description" : "审核失败的拒绝原因，只有审核失败才会返回该值", "example" : "图片涉黄" }, "restrict_infos" : { "type" : "array", "description" : "受限信息", "items" : { "$ref" : "#/components/schemas/SignRestrictInfo" } } } }, "AlipayOpenAgentSignstatusQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "QUERY_SIGN_STATUS_AUTH_NOT_MATCH", "QUERY_SIGN_STATUS_NOT_AUTH", "MERCHANT_IS_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAgentSignstatusQueryModel" : { "type" : "object", "properties" : { "pid" : { "type" : "string", "description" : "isv要查询签约状态的商户账号，可以是支付宝账号pid（2088开头），也可以是商户的登录账号（邮箱或手机号）", "example" : "支付宝账号：2088123451234543或手机号：13811111111或邮箱：123@xxx.com" }, "product_codes" : { "type" : "array", "description" : "isv要查询商户签约状态的产品码，产品码是支付宝内部对产品的唯一标识。目前支持查询产品及产品码详情参见 https://opendocs.alipay.com/isv/01cv77#%E8%83%BD%E5%8A%9B%E4%BA%A7%E5%93%81%E7%A0%81 。\t", "items" : { "type" : "string" }, "example" : "I1011000100000000001" } } }, "AlipayOpenAgentSignstatusQueryResponseModel" : { "type" : "object", "properties" : { "sign_status_list" : { "type" : "array", "description" : "商户产品签约状态结果对象数组，返回本次查询的产品的签约状态", "items" : { "$ref" : "#/components/schemas/ProductSignStatusInfo" } } } }, "AlipayOpenAppApiFieldApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "BIZ_ERROR", "SYSTEM_ERROR", "APP_ID_IS_BLANK", "APP_INFO_NOT_EXIST", "AUTHFIELDAPPLY_IS_BLANK", "API_NAME_IS_BLANK", "FIELD_NAME_IS_BLANK", "PACKAGE_CODE_IS_BLANK", "SCENE_CODE_IS_BLANK", "QPS_ANSWER_IS_BLANK", "CUSTOMER_ANSWER_IS_BLANK", "FILE_ITEMS_IS_BLANK", "AUTH_FIELD_SCENE_IS_BLANK", "SCENE_CODE_ERROR", "USER_ID_NO_PERMISSION", "SHOW_PACKAGE_IS_BLANK", "PACKAGE_CODE_ERROR", "TINYAPP_HEALTH_CHECK_INVALID", "TINYAPP_SAFETY_CHECK_INVALID", "API_NAME_ERROR", "AUTH_API_FIELD_IS_BLANK", "AUTH_API_APPLY_IS_PASS", "FILE_FORMAT_IS_INVALID", "FILE_SIZE_MIN_LIMIT", "FILE_SIZE_OUT_LIMIT", "FILE_QUALITY_IS_INVALID", "AUTH_API_FIELD_IS_AUDITING", "ACCOUNT_TYPE_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAppApiFieldApplyModel" : { "type" : "object", "properties" : { "auth_field_apply" : { "$ref" : "#/components/schemas/AuthFieldApply" } } }, "AlipayOpenAppApiFieldApplyResponseModel" : { "type" : "object" }, "AlipayOpenAppApiFieldQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAM", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAppApiFieldQueryResponseModel" : { "type" : "object", "properties" : { "auth_field_response" : { "$ref" : "#/components/schemas/AuthFieldResponse" } } }, "AlipayOpenAppApiQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAppApiQueryResponseModel" : { "type" : "object", "properties" : { "apis" : { "type" : "array", "description" : "应用可申请的接口出参敏感字段列表", "items" : { "$ref" : "#/components/schemas/AuthApiDTO" } } } }, "AlipayOpenAppApiSceneQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAM", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAppApiSceneQueryResponseModel" : { "type" : "object", "properties" : { "auth_field_scene" : { "type" : "array", "description" : "接口信息字段应用场景", "items" : { "$ref" : "#/components/schemas/AuthFieldSceneDTO" } } } }, "AlipayOpenAppMembersCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_LOGON_ID", "INVALID_ROLE", "USER_INFO_NOT_EXIST", "APPLICATION_TYPE_NOT_MINIAPP", "CANNOT_INVITE_MANAGER", "EXPERIENCER_ALREADY_REFUSED", "EXPERIENCER_ALREADY_EXIST", "DEVELOPER_ALREADY_REFUSED", "DEVELOPER_ALREADY_EXSIT", "DEV_MANAGER_ALREADY_EXIST", "ROLE_OVER_LIMIT", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAppMembersCreateModel" : { "type" : "object", "properties" : { "logon_id" : { "type" : "string", "description" : "支付宝登录账号。", "example" : "test@alipay.com" }, "role" : { "type" : "string", "description" : "为成员添加的角色类型，支持：\tDEVELOPER-开发者；\tEXPERIENCER-体验者。", "example" : "DEVELOPER" } } }, "AlipayOpenAppMembersCreateResponseModel" : { "type" : "object" }, "AlipayOpenAppMembersDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "USER_ID_IS_BLANK", "INVALID_ROLE", "APPLICATION_TYPE_NOT_MINIAPP", "ROLE_NOT_EXSIT", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAppMembersDeleteResponseModel" : { "type" : "object" }, "AlipayOpenAppMembersQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_ROLE", "APPLICATION_TYPE_NOT_MINIAPP" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAppMembersQueryResponseModel" : { "type" : "object", "properties" : { "app_member_info_list" : { "type" : "array", "description" : "小程序成员模型", "items" : { "$ref" : "#/components/schemas/AppMemberInfo" } } } }, "AlipayOpenAppMessagetemplateSubscribeQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "MSG_TEMPLATE_INVALID", "OPENID_INVALID", "ILLEGAL_ARGUMENT_PARAMS", "SYSTEM_ERROR", "SUBSCRIBE_TEMPLATE_OVER_LIMIT", "MSG_TEMPLATE_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAppMessagetemplateSubscribeQueryModel" : { "type" : "object", "properties" : { "open_id" : { "type" : "string", "description" : "支付宝openId，用于支付宝用户在当前应用下的用户标识。", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "template_id_list" : { "type" : "array", "description" : "消息模板id，可以填写多个，最多不超过3个。模板id需要保持同一个应用主体，并且展示在同一个订阅组件中的模板id。\t模板id获取详情参见模板消息。", "items" : { "type" : "string" }, "example" : "[\"6511999536b14ba5830e3a0289ea69a\",\"0b1fcca882aa435382ae98641e14d37\",\"a3b396be6fd345579221af5dea35028\"]" }, "user_id" : { "type" : "string", "description" : "订阅消息模板用户的支付宝唯一标识，2088开头。", "example" : "2088202882050410" } } }, "AlipayOpenAppMessagetemplateSubscribeQueryResponseModel" : { "type" : "object", "properties" : { "show_component" : { "type" : "boolean", "description" : "是否显示订阅组件。枚举值：\ttrue：显示订阅组件。\tfalse：不显示订阅组件", "example" : "true" }, "subscribe_relations" : { "type" : "array", "description" : "用户对消息模板的订阅关系列表，为入参中的用户id对消息模板id的订阅关系。\t限制：用户未订阅消息，该参数不返回。", "items" : { "$ref" : "#/components/schemas/SubscribeRelation" } } } }, "AlipayOpenAppMiniTemplatemessageSendErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "FORM_ID_SEND_LIMIT", "TEMPLATE_ILLEGAL", "MESSAGE_TEMPLATE_KEYWORD_ILLEGAL", "USER_TEMPLATE_ILLEGAL", "USER_TEMPLATE_LACK_KEYWORD", "FORM_ID_INVALID", "FORM_ID_NOT_MATCH_APPID", "FORM_ID_OVER_TIME", "USER_KEYWORD_LENGTH_ERROR", "PAGE_OVER_LIMIT", "TRADE_NO_NOT_MATCH_USERID", "QUERY_CONSUMER_REQEUST_ERROR", "BIZ_CONTENT_FORMAT_ERROR", "DATA_CONTENT_FORMAT_ERROR", "DATA_SENSITIVE", "USER_ID_INVALID", "NO_BIND_PUBLIC_APP", "MESSAGE_SEND_AUTH_ERROR", "USER_TEMPLATE_STATUS_ILLEGAL", "APP_TYPE_ERROR", "MSG_SEND_ERROR", "ILLEGAL_ARGUMENT_PARAMS", "NO_RECENT_VISIT_RECORD", "MSG_SINGLE_SD_OVER", "NO_PLACE_ORDER_RECORD", "MSG_UNSUBSCRIBED", "MSG_CONTENT_NOT_INTERESTED", "MSG_REJECTED", "MSG_TEMPLATE_ID_VALID", "DATA_IS_EMPTY", "MSG_UNAUTHORIZED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAppMiniTemplatemessageSendModel" : { "type" : "object", "properties" : { "data" : { "type" : "string", "description" : "模板消息内容。商家/开发者将模板占位符替换为自定义内容。\t\t注意：\t* 选用模板时配置的关键字顺序与keyword_ X相互对应，填写时需注意。\t\t* 自定义消息内容仅需替换 value 后内容即可，其余内容请勿修改。如 {\"keyword1\": {\"value\" : \"2021年01月\"}。表示第一个关键字数据为\"2021年01月\" 。\t\t* value 最长为 50 个字符。", "example" : "{\"keyword1\": {\"value\" : \"12:00\"},\"keyword2\": {\"value\" : \"20180808\"},\"keyword3\": {\"value\" : \"支付宝\"}}" }, "form_id" : { "type" : "string", "description" : "*支付消息模板：需传入用户发生的交易行为的支付宝交易号 trade_no；\t*表单提交模板：需传入用户在小程序触发表单提交事件获得的表单号；\t*刷脸消息模板：需传入在IOT刷脸后得到的ftoken等，用于信息发送的校验。\t说明：订阅消息模板无需传入本参数。", "example" : "2017010100000000580012345678" }, "page" : { "type" : "string", "description" : "小程序的跳转页面。用于用户点击模板消息 进入小程序查看 按钮后，跳转至商家小程序对应页面。", "example" : "page/component/index" }, "to_open_id" : { "type" : "string", "description" : "支付宝openId，用于支付宝用户在当前应用下的用户标识。", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "to_user_id" : { "type" : "string", "description" : "接收模板消息的用户 user_id，一般为2088开头的16为数字。\t注意：需为实际支付/提交表单/刷脸/订阅消息的用户。", "example" : "2088102122458832" }, "user_template_id" : { "type" : "string", "description" : "商家在商家自运营中心选用的消息模板ID，详情参见 选用消息模板 。", "example" : "MDI4YzIxMDE2M2I5YTQzYjUxNWE4MjA4NmU1MTIyYmM=" } } }, "AlipayOpenAppMiniTemplatemessageSendResponseModel" : { "type" : "object" }, "AlipayOpenAppQrcodeCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "APPQRCODE_NOT_TINYAPP", "SYSTEM_ERROR", "APP_QUERY_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAppQrcodeCreateModel" : { "type" : "object", "properties" : { "color" : { "type" : "string", "description" : "圆形二维码颜色（十六进制颜色色值），仅圆形二维码支持颜色设置，方形二维码默认为黑色。", "example" : "0x00BFFF" }, "describe" : { "type" : "string", "description" : "对应的二维码描述", "example" : "二维码描述" }, "query_param" : { "type" : "string", "description" : "小程序的启动参数，打开小程序的query ，在小程序 onLaunch的方法中获取。可查看 如何获取各种场景的启动参数。", "example" : "x=1" }, "size" : { "type" : "string", "description" : "合成后图片的大小\t(s -- 8cm, m -- 12cm, l -- 30cm)", "example" : "s" }, "url_param" : { "type" : "string", "description" : "page/component/component-pages/view/view为小程序中能访问到的页面路径", "example" : "page/component/component-pages/view/view" } } }, "AlipayOpenAppQrcodeCreateResponseModel" : { "type" : "object", "properties" : { "qr_code_url" : { "type" : "string", "description" : "方形二维码图片链接地址", "example" : "http://mmtcdp.stable.alipay.net/wsdk/img?fileid=A*lSbPT5i9C1wAAAAAAAAAAABjAQAAAA&t=9005d7f574f30246b89c20c17302115f&bz=mmtcafts&" }, "qr_code_url_circle_blue" : { "type" : "string", "description" : "圆形二维码地址，蓝色slogan", "example" : "https://mdgwdev.alipay.net/wsdk/img?fileid=A*KUfuQrWzFdsAAAAAAAAAAAAAAQAAAQ&bz=am_afts_openhome&zoom=800w_800h" }, "qr_code_url_circle_white" : { "type" : "string", "description" : "圆形二维码地址，白色slogan", "example" : "https://mdgwdev.alipay.net/wsdk/img?fileid=A*fRfsRq-nXbkAAAAAAAAAAAAAAQAAAQ&bz=am_afts_openhome&zoom=800w_800h" } } }, "AlipayOpenAppServiceApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "XML_FORMAT_ERROR", "ATTR_MISS_ID", "ATTR_MISS_TYPE", "ATTR_TYPE_ERROR", "ATTR_VALUE_ERROR", "ATTR_VALUETYPE_ERROR", "ATTR_RULE_NAME_ERROR", "ATTR_RULE_VALUE_ERROR", "ATTR_RULE_TYPE_ERROR", "OPTION_NAME_ERROR", "OPTION_VALUE_ERROR", "ADDRESS_OR_CITYCODE_ERROR", "SHOP_ID_IS_ERROR", "ATTR_NOT_MATCH_SERVICE_SCHEMA", "MINI_APP_NOT_ONLINE", "SERVICE_URL_REPEAT_ERROR", "SERVICE_NAME_REPEAT_ERROR", "PERMISSION_CHECK_ERROR", "SERVICE_NULL", "SERVICE_IS_INVALID", "SERVICE_URL_ERROR", "ATTR_RULE_CHECK_ERROR", "BIZ_ERROR", "INVALID_PARAMETER", "AREA_CODE_ERROR", "IDEMPOTENT_CONFLICTED", "SERVICE_APPID_NOT_IN_URL", "SERVICE_NOT_EXIST", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAppServiceApplyModel" : { "type" : "object", "properties" : { "category_id" : { "type" : "string", "description" : "行业类目id", "example" : "C102423081" }, "out_biz_no" : { "type" : "string", "description" : "外部业务编号,平台会基于appId+out_biz_no做幂等控制，如果出现幂等，会返回幂等的service_code", "example" : "12345678" }, "schema_version" : { "type" : "string", "description" : "服务schema版本", "example" : "1" }, "service_code" : { "type" : "string", "description" : "服务编码, 首次提报时设置空值，支付宝侧返回ServiceCode；当传入serviceCode，则对已提报服务做编辑操作。", "example" : "2021011521000858813900" }, "service_xml" : { "type" : "string", "description" : "服务xml", "example" : "" }, "template_type" : { "type" : "string", "description" : "服务模版。若当前服务类目只有一个服务模版，可不填。", "example" : "DEFAULT" } } }, "AlipayOpenAppServiceApplyResponseModel" : { "type" : "object", "properties" : { "service_code" : { "type" : "string", "description" : "服务id", "example" : "1111" } } }, "AlipayOpenAppServiceDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PERMISSION_CHECK_ERROR", "SERVICE_CAN_NOT_INVALID", "SERVICE_STATUS_IS_AUDITING", "SERVICE_NULL", "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAppServiceDeleteResponseModel" : { "type" : "object" }, "AlipayOpenAppServiceListQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "PERMISSION_CHECK_ERROR", "MINI_APP_NOT_ONLINE", "SERVICE_IS_INVALID" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAppServiceListQueryResponseModel" : { "type" : "object", "properties" : { "page_num" : { "type" : "integer", "description" : "页码", "example" : "2" }, "page_size" : { "type" : "integer", "description" : "每页记录数", "example" : "10" }, "records" : { "type" : "array", "description" : "服务列表", "items" : { "$ref" : "#/components/schemas/StandardServiceBaseInfo" } }, "total" : { "type" : "integer", "description" : "总记录数", "example" : "500" } } }, "AlipayOpenAppServiceQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "SERVICE_NOT_EXIST", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAppServiceQueryResponseModel" : { "type" : "object", "properties" : { "reject_reason" : { "type" : "string", "description" : "驳回理由", "example" : "不符合运营规范" }, "service_code" : { "type" : "string", "description" : "服务id", "example" : "s1111" }, "service_xml" : { "type" : "string", "description" : "服务描述xml格式", "example" : "..." }, "status" : { "type" : "string", "description" : "服务状态，EDITING(编辑中)/AUDITING(审核中)/AUDIT_REJECT(审核驳回)/PROMOTION(可推广)/STOP_PROMOTION(停止推广)/INVALID(失效)/PUNISHED(处罚)", "example" : "AUDITING" }, "template_type" : { "type" : "string", "description" : "服务模板类型", "example" : "DEFAULT" } } }, "AlipayOpenAppServiceSchemaQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "SERVICE_SCHEMA_NOT_EXIST", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAppServiceSchemaQueryResponseModel" : { "type" : "object", "properties" : { "category_id" : { "type" : "string", "description" : "类目id", "example" : "c11111" }, "schema_version" : { "type" : "string", "description" : "服务schema版本", "example" : "v1.0" }, "schema_xml" : { "type" : "string", "description" : "服务schema", "example" : "" }, "template_type" : { "type" : "string", "description" : "服务模版类型", "example" : "DEFAULT" } } }, "AlipayOpenAppTestGrayCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAppTestGrayCreateModel" : { "type" : "object", "properties" : { "body" : { "type" : "string", "description" : "b1", "example" : "b1" }, "body_1" : { "type" : "string", "description" : "body", "example" : "1" }, "complex_param" : { "$ref" : "#/components/schemas/OpenidComplex" }, "open_id" : { "type" : "string", "description" : "xx", "example" : "xxx" }, "user_id" : { "type" : "string", "description" : "1", "example" : "2088001159940003" } } }, "AlipayOpenAppTestGrayCreateResponseModel" : { "type" : "object", "properties" : { "zone_name" : { "type" : "string", "description" : "1", "example" : "cz00b" } } }, "AlipayOpenAppTestGrayQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "MANJIANG_UNIFY_TEST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAppTestGrayQueryResponseModel" : { "type" : "object", "properties" : { "res" : { "type" : "string", "description" : "1", "example" : "1" } } }, "AlipayOpenAuthAppAesGetErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "ACCESS_DENIED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAuthAppAesGetResponseModel" : { "type" : "object", "properties" : { "aes_key" : { "type" : "string", "description" : "商家应用AES KEY密文，需要ISV使用三方应用配置的AES密钥内容进行解密。详情参见 应用AES密钥管理。", "example" : "s6p0cLTHCy7jtJyTKnh" } } }, "AlipayOpenAuthAppAesSetErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "ACCESS_DENIED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAuthAppAesSetModel" : { "type" : "object", "properties" : { "merchant_app_id" : { "type" : "string", "description" : "商家应用appId", "example" : "20191223601234564" } } }, "AlipayOpenAuthAppAesSetResponseModel" : { "type" : "object", "properties" : { "aes_key" : { "type" : "string", "description" : "商家应用AES KEY密文，需要ISV使用三方应用配置的AES密钥内容进行解密。详情参见 应用AES密钥管理。", "example" : "s6p0cLTHCy7jtJyTKnh" } } }, "AlipayOpenAuthTokenAppErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "APP_NOT_ISV", "REFRESH_TOKEN_NOT_VALID", "GRANT_TYPE_INVALID", "AUTH_CODE_NOT_EXIST", "APP_ID_NOT_CONSISTENT", "AUTH_CODE_NOT_VALID", "AUTH_TOKEN_NOT_FOUND", "REFRESH_TOKEN_NOT_EXIST", "REFRESH_TOKEN_TIME_OUT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAuthTokenAppModel" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "应用授权码，传入应用授权后得到的 app_auth_code。\t说明：\tgrant_type 为 authorization_code 时，本参数必填；\tgrant_type 为 refresh_token 时不填。", "example" : "1cc19911172e4f8aaa509c8fb5d12F56" }, "grant_type" : { "type" : "string", "description" : "授权方式。支持：\tauthorization_code：使用应用授权码换取应用授权令牌app_auth_token。\trefresh_token：使用app_refresh_token刷新获取新授权令牌。\t", "example" : "authorization_code或者refresh_token" }, "refresh_token" : { "type" : "string", "description" : "刷新令牌，上次换取访问令牌时得到。本参数在 grant_type 为 authorization_code 时不填；为 refresh_token 时必填，且该值来源于此接口的返回值 app_refresh_token（即至少需要通过 grant_type=authorization_code 调用此接口一次才能获取）。", "example" : "201509BBdcba1e3347de4e75ba3fed2c9abebE36" } } }, "AlipayOpenAuthTokenAppQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_PARAM", "APP_NOT_ISV", "AUTH_TOKEN_NOT_EXISTED", "SYSTEM_ERROR", "AUTH_TOKEN_NOT_CONSISTENT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAuthTokenAppQueryResponseModel" : { "type" : "object", "properties" : { "auth_app_id" : { "type" : "string", "description" : "授权商户的appid", "example" : "2013121100055554" }, "auth_end" : { "type" : "string", "description" : "授权失效时间", "example" : "2016-11-03 01:59:57" }, "auth_methods" : { "type" : "array", "description" : "当前app_auth_token的授权接口列表", "items" : { "type" : "string" }, "example" : "\"alipay.open.auth.token.app.query\",\"alipay.system.oauth.token\",\"alipay.open.auth.token.app\"" }, "auth_start" : { "type" : "string", "description" : "授权生效时间", "example" : "2015-11-03 01:59:57" }, "expires_in" : { "type" : "integer", "description" : "应用授权令牌失效时间，单位到秒", "example" : "31536000" }, "is_by_app_auth" : { "type" : "boolean", "description" : "当商家选择全权委托授权时值为true，未选择时为false。", "example" : "true" }, "status" : { "type" : "string", "description" : "valid：有效状态；invalid：无效状态", "example" : "valid" }, "user_id" : { "type" : "string", "description" : "授权商户的user_id", "example" : "2088102150527498" } } }, "AlipayOpenAuthTokenAppResponseModel" : { "type" : "object", "properties" : { "app_auth_token" : { "type" : "string", "description" : "应用授权令牌", "example" : "201509BBeff9351ad1874306903e96b91d248A36" }, "app_refresh_token" : { "type" : "string", "description" : "刷新令牌", "example" : "201509BBdcba1e3347de4e75ba3fed2c9abebE36" }, "auth_app_id" : { "type" : "string", "description" : "授权商户的appid", "example" : "2013121100055554" }, "expires_in" : { "type" : "string", "description" : "该字段已作废，应用令牌长期有效，接入方不需要消费该字段", "example" : "123456" }, "re_expires_in" : { "type" : "string", "description" : "刷新令牌的有效时间（从接口调用时间作为起始时间），单位到秒", "example" : "123456" }, "tokens" : { "type" : "array", "description" : "批量授权换码访问令牌列表", "items" : { "$ref" : "#/components/schemas/AppTokenExchangeSubElement" } }, "user_id" : { "type" : "string", "description" : "授权商户的user_id", "example" : "2088102150527498" } } }, "AlipayOpenAuthUserauthRelationshipQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenAuthUserauthRelationshipQueryResponseModel" : { "type" : "object", "properties" : { "query_detail" : { "type" : "string", "description" : "授权结果查询结果，可以转换为为Map格式", "example" : "{\"auth_user\":true,\"auth_zhima\":false}" } } }, "AlipayOpenBizCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenBizCreateModel" : { "type" : "object", "properties" : { "a" : { "$ref" : "#/components/schemas/Gavintest" }, "b" : { "type" : "string", "description" : "1", "example" : "21" }, "de" : { "$ref" : "#/components/schemas/GavintestNewLeveaOne" }, "stringbuff" : { "type" : "string", "description" : "1", "example" : "1" } } }, "AlipayOpenBizCreateResponseModel" : { "type" : "object", "properties" : { "a" : { "type" : "string", "description" : "1", "example" : "1" }, "b" : { "$ref" : "#/components/schemas/GavintestNewonline" }, "c" : { "type" : "string", "description" : "1", "example" : "21" } } }, "AlipayOpenFeeAdjustApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "SIZE_OUT_LIMIT", "SIZE_MIN_LIMIT", "FILE_FORMAT_INVALID", "INVALID_PARAMS", "NO_PERMISSION", "CERT_TYPE_ILLEGAL", "CERT_PIC_NULL", "ATTACHMENT_IS_NULL", "MERCHANT_ACCOUNT_ERROR", "PRODUCT_NOT_SUPPORT", "DAYS_LIMIT_ERROR", "MERCHANT_REALTION_ERROR", "CHANGE_RATE_ERROR", "RATE_LIMIT_ERROR", "MERCHANT_NOT_SUPPORT", "PRODUCT_UN_VALID", "ARRANGEMENT_INEFFECTIVE_ERROR", "APPLY_IS_PROCESSING", "NKA_MERCHANT_NOT_SUPPORT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenFeeAdjustApplyModel" : { "type" : "object", "properties" : { "account" : { "type" : "string", "description" : "服务商代申请特殊费率的商家支付宝账户", "example" : "test@alipay.com" }, "application_fee" : { "type" : "string", "description" : "服务商代商家申请特殊费率的费率值（%），如0.38表示0.38%", "example" : "0.38" }, "cert_no" : { "type" : "string", "description" : "对应证件类型（certType）的证件号，如营业执照为营业执照号", "example" : "1532501100006302" }, "cert_type" : { "type" : "string", "description" : "证件类型，枚举值为\t餐饮服务许可证 FOOD_SERVICE_LICENSE，\t食品卫生许可证 FOOD_HEALTH_LICENSE，\t食品经营许可证 FOOD_BUSINESS_LICENSE，\t食品流通许可证 FOOD_CIRCULATE_LICENSE，\t食品生产许可证 FOOD_PRODUCTION_LICENS，\t营业执照 DEFAULT_LICENSE，\t烟草资质 TOBACCO_PRODUCTION_LICENSE", "example" : "DEFAULT_LICENSE" }, "city_code" : { "type" : "string", "description" : "市", "example" : "370900" }, "detail_address" : { "type" : "string", "description" : "详细地址", "example" : "人民路10号" }, "district_code" : { "type" : "string", "description" : "区/县", "example" : "370902" }, "product_code" : { "type" : "string", "description" : "服务商代商家申请调整费率的产品码", "example" : "FACE_TO_FACE_PAYMENT" }, "province_code" : { "type" : "string", "description" : "省份", "example" : "370000" } } }, "AlipayOpenFeeAdjustApplyResponseModel" : { "type" : "object" }, "AlipayOpenFileUploadErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "FILE_CHECK_FAIL", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenFileUploadModel" : { "type" : "object", "properties" : { "biz_code" : { "type" : "string", "description" : "素材使用场景，请关联其他开放平台接口联合使用。如果素材用于内容发布，请必传入content_creation", "example" : "content_creation" }, "extra_parameters" : { "$ref" : "#/components/schemas/FileUploadExtraParam" }, "md5" : { "type" : "string", "description" : "文件的md5值，如果不传则不校验md5", "example" : "9cff2d79bc81acf12abbaca7328a4dc5" } } }, "AlipayOpenFileUploadResponseModel" : { "type" : "object", "properties" : { "extern_id" : { "type" : "string", "description" : "视频资源id，同步外部渠道后，外部渠道返回的id。目前支持同步优酷场景，返回优酷视频id，用于支付宝客户端播放视频使用", "example" : "XNTk0NjE5NjI4OA==" }, "file_id" : { "type" : "string", "description" : "文件id，用于提供后后续业务调用使用", "example" : "A*6XqwQKpS1t0AAAAAAAAAAAAADi92AA" } } }, "AlipayOpenInstantdeliveryAccountCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "UNKNOWN_EXCEPTION", "INVALID_PARAMETER", "RESULT_IS_NOT_EXPECTED", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenInstantdeliveryAccountCreateModel" : { "type" : "object", "properties" : { "logistics_codes" : { "type" : "array", "description" : "配送公司编码", "items" : { "type" : "string" }, "example" : "ISTD" }, "out_biz_no" : { "type" : "string", "description" : "外部业务号", "example" : "out_biz_no_202008311750000" } } }, "AlipayOpenInstantdeliveryAccountCreateResponseModel" : { "type" : "object", "properties" : { "logistics_account_status" : { "type" : "array", "description" : "配送公司账户创建结果列表", "items" : { "$ref" : "#/components/schemas/LogisticsAccountStatusDTO" } } } }, "AlipayOpenInstantdeliveryAccountQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "UNKNOWN_EXCEPTION", "INVALID_PARAMETER", "RESULT_IS_NOT_EXPECTED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenInstantdeliveryAccountQueryResponseModel" : { "type" : "object", "properties" : { "balance" : { "type" : "string", "description" : "账户余额", "example" : "1.3" }, "business_license" : { "type" : "string", "description" : "企业营业执照图片正反面", "example" : "http://xxx" }, "business_scope" : { "type" : "string", "description" : "经营范围", "example" : "XXX" }, "credit_code" : { "type" : "string", "description" : "统一社会信用代码", "example" : "XXX" }, "email" : { "type" : "string", "description" : "联系人邮箱", "example" : "xxx@alipay.com" }, "enterprise_address" : { "type" : "string", "description" : "企业地址", "example" : "XXX街道108号" }, "enterprise_city" : { "type" : "string", "description" : "企业所在地，市编码", "example" : "XX" }, "enterprise_district" : { "type" : "string", "description" : "企业所在地，区编码", "example" : "XX" }, "enterprise_name" : { "type" : "string", "description" : "企业全称", "example" : "淘宝" }, "enterprise_province" : { "type" : "string", "description" : "企业所在地，省编码", "example" : "XX" }, "enterprise_type" : { "type" : "string", "description" : "企业类型", "example" : "01" }, "logistics_account_status" : { "type" : "array", "description" : "在配送公司的账户状态信息", "items" : { "$ref" : "#/components/schemas/LogisticsAccountStatusDTO" } }, "phone" : { "type" : "string", "description" : "联系人手机号", "example" : "138xxxxxxxx" } } }, "AlipayOpenInstantdeliveryMerchantagreementQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenInstantdeliveryMerchantagreementQueryResponseModel" : { "type" : "object", "properties" : { "agreement_detail" : { "$ref" : "#/components/schemas/AgreementDetail" } } }, "AlipayOpenInstantdeliveryMerchantagreementSignErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenInstantdeliveryMerchantagreementSignModel" : { "type" : "object", "properties" : { "open_id" : { "type" : "string", "description" : "蚂蚁统一会员ID", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "user_id" : { "type" : "string", "description" : "蚂蚁统一会员ID", "example" : "2088000000000000" } } }, "AlipayOpenInstantdeliveryMerchantagreementSignResponseModel" : { "type" : "object", "properties" : { "sign_url" : { "type" : "string", "description" : "授权二维码的url, 必须用传入的uid进行扫码", "example" : "https://openapi.alipay.com/gateway.do?***" } } }, "AlipayOpenInstantdeliveryMerchantshopBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "UNKNOWN_EXCEPTION", "INVALID_PARAMETER", "RESULT_IS_NOT_EXPECTED", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenInstantdeliveryMerchantshopBatchqueryModel" : { "type" : "object", "properties" : { "page_no" : { "type" : "integer", "description" : "当前页码", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "分页数量, 最大50。", "example" : "20" }, "shop_name" : { "type" : "string", "description" : "球房名称", "example" : "球房1" }, "shop_no" : { "type" : "string", "description" : "商家球房编码。", "example" : "10000" } } }, "AlipayOpenInstantdeliveryMerchantshopBatchqueryResponseModel" : { "type" : "object", "properties" : { "page_no" : { "type" : "integer", "description" : "当前页码", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "分页数量, 最大50。", "example" : "20" }, "records" : { "type" : "array", "description" : "球房列表数据。", "items" : { "$ref" : "#/components/schemas/MerchantShopDTO" } }, "total_no" : { "type" : "integer", "description" : "总数量", "example" : "100" } } }, "AlipayOpenInstantdeliveryMerchantshopCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "UNKNOWN_EXCEPTION", "INVALID_PARAMETER", "RESULT_IS_NOT_EXPECTED", "SYSTEM_ERROR", "SYSTEM_EXCEPTION", "NO_ACCOUNT", "ACCOUNT_CREATING", "ACCOUNT_AUDITING" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenInstantdeliveryMerchantshopCreateModel" : { "type" : "object", "properties" : { "contact_name" : { "type" : "string", "description" : "联系人姓名", "example" : "张三" }, "detail_address" : { "type" : "string", "description" : "地址。商户详细经营地址或人员所在地点", "example" : "万塘路18号黄龙时代广场B座" }, "enterprise_city" : { "type" : "string", "description" : "城市编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 （参考资料： http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/）", "example" : "371000" }, "enterprise_district" : { "type" : "string", "description" : "区县编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 （参考资料： http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/）", "example" : "371002" }, "enterprise_province" : { "type" : "string", "description" : "省份编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 （参考资料： http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/）", "example" : "370000" }, "latitude" : { "type" : "string", "description" : "纬度，浮点型,小数点后最多保留6位 如需要录入经纬度，请以高德坐标系为准，录入时请确保经纬度参数准确。高德经纬度查询：http://lbs.amap.com/console/show/picker", "example" : "60.270001" }, "longitude" : { "type" : "string", "description" : "经度，浮点型, 小数点后最多保留6位。 如需要录入经纬度，请以高德坐标系为准，录入时请确保经纬度参数准确。高德经纬度查询：http://lbs.amap.com/console/show/picker", "example" : "120.760001" }, "out_biz_no" : { "type" : "string", "description" : "外部业务号", "example" : "out_biz_no_202008311750003" }, "phone" : { "type" : "string", "description" : "联系人电话/手机号", "example" : "13888888888" }, "poiid" : { "type" : "string", "description" : "高德poiid", "example" : "B0FFIVU189" }, "shop_category" : { "type" : "string", "description" : "店铺类目，取值参见文件https://mif-pub.alipayobjects.com/ShopCategory.xlsx 中的三级球房类目", "example" : "1001" }, "shop_name" : { "type" : "string", "description" : "球房名称，最长不超过256个字符。名称+地址需要全局唯一。", "example" : "球房1" }, "shop_no" : { "type" : "string", "description" : "商家球房编码，可自定义，但必须唯一", "example" : "1000" } } }, "AlipayOpenInstantdeliveryMerchantshopCreateResponseModel" : { "type" : "object", "properties" : { "logistics_shop_status" : { "type" : "array", "description" : "球房创建返回的结果。", "items" : { "$ref" : "#/components/schemas/LogisticsShopStatusDTO" } } } }, "AlipayOpenInstantdeliveryMerchantshopModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "UNKNOWN_EXCEPTION", "INVALID_PARAMETER", "SHOP_CREATING", "SYSTEM_ERROR", "SHOP_AUDITING", "SHOP_UPDATING", "NO_ACCOUNT", "ACCOUNT_CREATING", "ACCOUNT_AUDITING" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenInstantdeliveryMerchantshopModifyModel" : { "type" : "object", "properties" : { "contact_name" : { "type" : "string", "description" : "联系人姓名", "example" : "张三" }, "logistics_codes" : { "type" : "array", "description" : "要更新的配送公司列表，必须包含已经创建过该球房的配送公司，可以新增开通了账户的配送公司", "items" : { "type" : "string" }, "example" : "ISTD" }, "out_biz_no" : { "type" : "string", "description" : "外部业务号", "example" : "out_biz_no_202008311750004" }, "phone" : { "type" : "string", "description" : "联系人电话/手机号", "example" : "13666666666" }, "shop_no" : { "type" : "string", "description" : "商家球房编码", "example" : "1000" } } }, "AlipayOpenInstantdeliveryMerchantshopModifyResponseModel" : { "type" : "object", "properties" : { "logistics_shop_status" : { "type" : "array", "description" : "球房创建返回的结果", "items" : { "$ref" : "#/components/schemas/LogisticsShopStatusDTO" } } } }, "AlipayOpenInstantdeliveryMerchantshopQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "UNKNOWN_EXCEPTION", "INVALID_PARAMETER", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenInstantdeliveryMerchantshopQueryResponseModel" : { "type" : "object", "properties" : { "contact_name" : { "type" : "string", "description" : "联系人姓名", "example" : "张三" }, "detail_address" : { "type" : "string", "description" : "地址。商户详细经营地址或人员所在地点。", "example" : "万塘路18号黄龙时代广场B座" }, "enterprise_city" : { "type" : "string", "description" : "城市编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 （参考资料： http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/）", "example" : "371000" }, "enterprise_district" : { "type" : "string", "description" : "区县编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 （参考资料： http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/）", "example" : "371002" }, "enterprise_province" : { "type" : "string", "description" : "省份编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 （参考资料： http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/）", "example" : "370000" }, "latitude" : { "type" : "string", "description" : "纬度，浮点型,小数点后最多保留6位 如需要录入经纬度，请以高德坐标系为准，录入时请确保经纬度参数准确。高德经纬度查询：http://lbs.amap.com/console/show/picker", "example" : "60.270001" }, "logistics_shop_status" : { "type" : "array", "description" : "在配送公司的球房状态。", "items" : { "$ref" : "#/components/schemas/LogisticsShopStatusDTO" } }, "longitude" : { "type" : "string", "description" : "经度，浮点型, 小数点后最多保留6位。 如需要录入经纬度，请以高德坐标系为准，录入时请确保经纬度参数准确。高德经纬度查询：http://lbs.amap.com/console/show/picker", "example" : "120.760001" }, "phone" : { "type" : "string", "description" : "联系人电话/手机号。", "example" : "13888888888" }, "poiid" : { "type" : "string", "description" : "高德poiid", "example" : "B0FFIVU189" }, "shop_category" : { "type" : "string", "description" : "店铺类目，取值参见文件https://mif-pub.alipayobjects.com/ShopCategory.xlsx 中的三级球房类目", "example" : "1001" }, "shop_name" : { "type" : "string", "description" : "球房名称，最长不超过256个字符", "example" : "球房1" }, "shop_no" : { "type" : "string", "description" : "商家球房编码。", "example" : "1000" } } }, "AlipayOpenInviteOrderQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMS", "INVITE_ISV_BIZ_ID_INVALID", "INVITE_ISV_BIZ_ID_NOT_EXIST", "MERCHANT_LOGON_ID_NOT_MATCH" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenInviteOrderQueryResponseModel" : { "type" : "object", "properties" : { "merchant_pid" : { "type" : "string", "description" : "商家支付宝账号对应的ID，2088开头", "example" : "2088532075393645" }, "sign_status_list" : { "type" : "array", "description" : "产品签约状态对象", "items" : { "$ref" : "#/components/schemas/ProductInviteStatusInfo" } } } }, "AlipayOpenMiniAppdeployByappidQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码" }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniAppdeployByappidQueryResponseModel" : { "type" : "object", "properties" : { "deploys" : { "type" : "array", "description" : "小程序发布信息", "items" : { "$ref" : "#/components/schemas/MiniAppDeployResponse" } }, "total" : { "type" : "integer", "description" : "总数", "example" : "245" } } }, "AlipayOpenMiniAppdeployByappversionQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码" }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniAppdeployByappversionQueryResponseModel" : { "type" : "object", "properties" : { "deploys" : { "type" : "array", "description" : "发布信息", "items" : { "$ref" : "#/components/schemas/MiniAppDeployResponse" } } } }, "AlipayOpenMiniAppdeployBydeployversionQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码" }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniAppdeployBydeployversionQueryResponseModel" : { "type" : "object", "properties" : { "deploys" : { "type" : "array", "description" : "小程序发布信息", "items" : { "$ref" : "#/components/schemas/MiniAppDeployResponse" } } } }, "AlipayOpenMiniBaseinfoModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "MODIFY_PARAMS_ARE_BLANK", "CAN_NOT_MODIFY_BASE_INFO", "INVALID_MINI_APP_NAME", "INVALID_MINI_APP_NAME_LENGTH", "MINI_APP_NAME_DUPLICATE", "MINI_APP_NAME_SENSITIVE", "INVALID_MINI_APP_EN_NAME", "INVALID_MINI_APP_EN_NAME_LENGTH", "MINI_APP_EN_NAME_DUPLICATE", "MINI_APP_EN_NAME_SENSITIVE", "INVALID_MINI_APP_SLOGAN_LENGTH", "MINI_APP_SLOGAN_SENSITIVE", "CATEGOTY_NUM_IS_INVALID", "INVALID_CATEGOTY", "INVALID_LOGO_EXT", "LOGO_EXCEED_MAX_SIZE", "LOGO_HEIGHT_NOT_EQUAL_WIDTH", "MINI_APP_DESC_SENSITIVE", "INVALID_MINI_APP_DESC_LENGTH", "INVALID_MINI_APP_SERVICE_PHONE", "INVALID_MINI_APP_SERVICE_EMAIL", "MINI_APP_SERVICE_EMAIL_SENSITIVE", "APPLICATION_TYPE_NOT_MINIAPP", "INVALID_MINI_APP_DESC", "INVALID_MINI_APP_SLOGAN", "RISK_DECISION_CHECK_FAIL", "RISK_DECISION_HIT_BRAND", "SERVICE_TEL_AND_MAIL_BOTH_BLANK", "APP_DESC_IS_BLANK", "MINI_APP_NOT_ONLINE", "LOGO_SIZE_EXCEED", "CATEGORY_IS_BLANK", "PRIVATE_NOT_ALLOW_CATEGORY", "CANNOT_MODIFY_CATEGORY_WITH_RELATION_VERSION", "MINI_APP_INFO_AUDIT_CONTAINS", "CATEGORY_NUM_IS_INVALID", "SLOGAN_IS_BLANK", "OP_FREQUENCY_LIMIT", "LOGO_IS_BLANK", "INVALID_LOGO", "INVALID_PARAMETER", "NOT_ALLOW_BETA_CATEGORY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniBaseinfoModifyModel" : { "type" : "object", "properties" : { "app_category_ids" : { "type" : "string", "description" : "11_12;12_13。小程序类目，格式为 第一个一级类目_第一个二级类目;第二个一级类目_第二个二级类目，详细类目可以参考https://docs.open.alipay.com/api_49/alipay.open.mini.category.query接口查询mini_category_list 。", "example" : "11_12;12_13" }, "app_desc" : { "type" : "string", "description" : "小程序描述，长度限制 20~400 个字符。\t如果前期已经设置过该信息，本次可不填，平台将会为你默认上传该信息。如果前期没有设置过该信息，则本次为必填。可通过https://opendocs.alipay.com/mini/03l21r查询当前小程序信息\t", "example" : "这是一个小程序的描述这是一个小程序的描述这是一个小程序的描述这是一个小程序的描述" }, "app_english_name" : { "type" : "string", "description" : "小程序应用英文名称。长度限制 3~30 个字符，仅支持包含中文、数字、英文、下划线、+、-。\t如果前期已经设置过该信息，本次可不填，平台将会为你默认上传该信息。如果前期没有设置过该信息，则本次为必填。可通过alipay.open.mini.baseinfo.query查询当前小程序信息", "example" : "demoexample" }, "app_name" : { "type" : "string", "description" : "小程序名称。长度限制 3~30 个字符，仅支持包含中文、数字、英文、下划线、+、-。\t如果前期已经设置过该信息，本次可不填，平台将会为你默认上传该信息。如果前期没有设置过该信息，则本次为必填。可通过alipay.open.mini.baseinfo.query查询当前小程序信息", "example" : "杭州支小宝潮流女装店" }, "app_slogan" : { "type" : "string", "description" : "小程序简介，一句话描述小程序功能，长度限制 10~32个字符。\t如果前期已经设置过该信息，本次可不填，平台将会为你默认上传该信息。如果前期没有设置过该信息，则本次为必填。可通过alipay.open.mini.baseinfo.query查询当前小程序信息", "example" : "专注潮流女装20年" }, "mini_category_ids" : { "type" : "string", "description" : "新小程序前台类目，格式为 第一个一级类目_第一个二级类目;第二个一级类目_第二个二级类目_第二个三级类目，详细类目可以通过 https://docs.open.alipay.com/api_49/alipay.open.mini.category.query\t接口查询mini_category_list。\t如果前期已经设置过该信息，本次可不填，平台将会为你默认上传该信息。如果前期没有设置过该信息，则本次为必填。可通过https://opendocs.alipay.com/mini/03l21r查询当前小程序信息\t注意：个人开发者不得使用企业类目。", "example" : "XS1001_XS2001_XS3002;XS1011_XS2089;XS1002_XS2008_XS3024" }, "service_email" : { "type" : "string", "description" : "小程序客服邮箱，如果不填默认采用当前小程序的应用客服邮箱，小程序客服电话和邮箱至少输入一个。如果前期已经设置过该信息，本次可不填，平台将会为你默认上传该信息。\t注意：2021年7月1日后，该字段将逐步灰度为可选字段，请按可选开发。", "example" : "example@mail.com" }, "service_phone" : { "type" : "string", "description" : "小程序客服电话，长度限制5~30个字符，仅支持包含数字和-。如果不填默认采用当前小程序的应用客服电话，小程序客服电话和邮箱至少输入一个。如果前期已经设置过该信息，本次可不填，平台将会为你默认上传该信息。\t注意：2021年7月1日后，该字段将逐步灰度为必填字段，请按必填开发。", "example" : "13110101010" } } }, "AlipayOpenMiniBaseinfoModifyResponseModel" : { "type" : "object" }, "AlipayOpenMiniBaseinfoNameCheckErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_LIMIT", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniBaseinfoNameCheckResponseModel" : { "type" : "object", "properties" : { "check_code" : { "type" : "string", "description" : "校验结果code", "example" : "NONE" }, "check_memo" : { "type" : "string", "description" : "校验说明", "example" : "无" } } }, "AlipayOpenMiniBaseinfoQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "APPLICATION_TYPE_NOT_MINIAPP", "APP_INFO_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniBaseinfoQueryResponseModel" : { "type" : "object", "properties" : { "app_desc" : { "type" : "string", "description" : "小程序应用描述", "example" : "小程序官方示例Demo，展示已支持的接口能力及组件。" }, "app_english_name" : { "type" : "string", "description" : "小程序应用英文名称", "example" : "demoexample" }, "app_logo" : { "type" : "string", "description" : "小程序应用logo图标", "example" : "https://appstoreisvpic.alipayobjects.com/prod/04843e84-f1fd-4717-a230-1c72de99aa5d.png" }, "app_name" : { "type" : "string", "description" : "小程序应用名称", "example" : "小程序示例" }, "app_slogan" : { "type" : "string", "description" : "小程序应用简介，一句话描述小程序功能", "example" : "提供小程序示例功能" }, "category_names" : { "type" : "string", "description" : "类目名称，格式为第一个一级类目_第一个二级类目;第二个一级类目_第二个二级类目;", "example" : "航空票务_航空公司;生活服务_室内清洁服务;" }, "package_names" : { "type" : "array", "description" : "功能包名称", "items" : { "type" : "string" }, "example" : "小程序基础功能" }, "safe_domains" : { "type" : "array", "description" : "域白名单", "items" : { "type" : "string" }, "example" : "example.com" }, "service_email" : { "type" : "string", "description" : "小程序客服邮箱", "example" : "example@mail.com" }, "service_phone" : { "type" : "string", "description" : "小程序客服电话", "example" : "13110101010" } } }, "AlipayOpenMiniCategoryQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniCategoryQueryResponseModel" : { "type" : "object", "properties" : { "category_list" : { "type" : "array", "description" : "小程序类目列表", "items" : { "$ref" : "#/components/schemas/MiniAppCategory" } }, "mini_category_list" : { "type" : "array", "description" : "小程序新类目列表。小程序新类目列表，为三级类目。创建、修改、提审传入mini_category_ids，资质相关请参考https://opendocs.alipay.com/mini/operation/material\t", "items" : { "$ref" : "#/components/schemas/MiniAppCategory" } } } }, "AlipayOpenMiniCategoryRequireQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "CATEGORY_IS_BLANK", "PARAMETER_ERROR", "SYSTEM_ERROR", "CATEGORY_ERROR", "INVALID_PARAMS" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniCategoryRequireQueryModel" : { "type" : "object", "properties" : { "category_code_list" : { "type" : "array", "description" : "类目列表，不超过五个", "items" : { "type" : "string" }, "example" : "[ \"XS1001_XS2002_XS3008\",\"XS1022_XS2182\"]" } } }, "AlipayOpenMiniCategoryRequireQueryResponseModel" : { "type" : "object", "properties" : { "category_require_info_list" : { "type" : "array", "description" : "类目对应资质列表", "items" : { "$ref" : "#/components/schemas/CategoryRequireInfo" } } } }, "AlipayOpenMiniExperienceCancelErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "APP_VERSION_IS_BLANK", "APPLICATION_TYPE_NOT_MINIAPP", "MINI_APP_PACKAGE_INFO_NOT_EXIST", "CAN_NOT_CANCEL_WITHOUT_PACKAGED", "MINI_APP_NOT_ONLINE", "APPID_IS_BLANK", "BUNDLE_ID_NOT_EXIST", "CAN_NOT_CANCEL_EXP_WITH_INVALID_STATUS", "INVALID_PARAMS" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniExperienceCancelModel" : { "type" : "object", "properties" : { "app_version" : { "type" : "string", "description" : "小程序版本号", "example" : "0.0.1" }, "bundle_id" : { "type" : "string", "description" : "小程序客户端类型，默认为支付宝端。支付宝端：com.alipay.alipaywallet,DINGDING端：com.alibaba.android.rimet,高德端:com.amap.app,天猫精灵端:com.alibaba.ailabs.genie.webapps,支付宝IOT:com.alipay.iot.xpaas", "example" : "com.alipay.alipaywallet" } } }, "AlipayOpenMiniExperienceCancelResponseModel" : { "type" : "object" }, "AlipayOpenMiniExperienceCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "APP_VERSION_IS_BLANK", "APPLICATION_TYPE_NOT_MINIAPP", "MINI_APP_PACKAGE_INFO_NOT_EXIST", "CAN_NOT_SET_EXP_REPEAT", "CAN_NOT_SET_EXP_INVALID_STATUS", "CAN_NOT_SET_WITHOUT_SCAN_PASS", "INVALID_PARAMS", "APP_INFO_NOT_EXIST", "MINI_APP_NOT_ONLINE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniExperienceCreateModel" : { "type" : "object", "properties" : { "app_version" : { "type" : "string", "description" : "商家小程序版本号。", "example" : "0.0.1" }, "bundle_id" : { "type" : "string", "description" : "小程序客户端类型，默认为支付宝端。支持如下客户端：\tcom.alipay.alipaywallet：支付宝端；\tcom.alibaba.android.rimet：DINGDING端；\tcom.amap.app：高德端；\tcom.alibaba.ailabs.genie.webapps：天猫精灵端；\tcom.alipay.iot.xpaas：支付宝IoT端。", "example" : "com.alipay.alipaywallet" } } }, "AlipayOpenMiniExperienceCreateResponseModel" : { "type" : "object" }, "AlipayOpenMiniExperienceQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "APP_VERSION_IS_BLANK", "APPLICATION_TYPE_NOT_MINIAPP", "MINI_APP_PACKAGE_INFO_NOT_EXIST", "INVALID_PARAMS" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniExperienceQueryResponseModel" : { "type" : "object", "properties" : { "exp_qr_code_url" : { "type" : "string", "description" : "小程序体验版二维码地址", "example" : "https://mobilecodec.alipay.com/show.htm?code=s4x06980mfxeaok1f3zvq8d" }, "exp_schema_url" : { "type" : "string", "description" : "体验版schema", "example" : "alipays://xxx" }, "status" : { "type" : "string", "description" : "体验版打包状态。状态枚举如下：\texpVersionPackged：体验版打包成功；\texpVersionPackaging：体验版打包中；\tnotExpVersion：非体验版。", "example" : "notExpVersion" } } }, "AlipayOpenMiniIndividualBusinessCertifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "NOT_PRIVATE", "INVALID_PARAMS", "DUPLICATED_CERTIFY", "SYSTEM_ERROR", "PRIVATE_NOT_CERTIFY", "BIZ_ERROR", "INVALID_PARAMETER", "USER_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniIndividualBusinessCertifyModel" : { "type" : "object", "properties" : { "license_no" : { "type" : "string", "description" : "营业执照注册号即营业执照的编号。", "example" : "1235234234123124234234" }, "license_pic" : { "type" : "string", "description" : "营业执照图片的Base64编码字符串，图片大小不能超过2M", "example" : "/9j/Qnl0ZUFycmF5T3V0cHV0U3RyZWFtIG91dHB1dCA9IG5ldyBCeXRlQ中间缩略Skge30=" } } }, "AlipayOpenMiniIndividualBusinessCertifyResponseModel" : { "type" : "object", "properties" : { "certify_result" : { "type" : "boolean", "description" : "个体工商户认证结果，true代表认证成功，false代表认证失败", "example" : "true" } } }, "AlipayOpenMiniInnerExperienceCancelErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INNER_APP_ID_IS_BLANK", "INNER_VERSION_IS_BLANK", "INNER_APP_ORIGIN_IS_BLANK", "INNER_APP_ORIGIN_NOT_EXIT", "APPID_NOT_EXIST", "NOT_TINYAPP" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerExperienceCancelModel" : { "type" : "object", "properties" : { "app_origin" : { "type" : "string", "description" : "业务来源", "example" : "alipay" }, "app_version" : { "type" : "string", "description" : "小程序版本号", "example" : "0.0.1" }, "bundle_id" : { "type" : "string", "description" : "端id", "example" : "com.alipay.alipaywallet" }, "mini_app_id" : { "type" : "string", "description" : "业务小程序appid", "example" : "2021001129671018" }, "oid" : { "type" : "string", "description" : "oid", "example" : "2088xxxxxxxxxxxx" }, "operator_id" : { "type" : "string", "description" : "操作员id", "example" : "操作员id" } } }, "AlipayOpenMiniInnerExperienceCancelResponseModel" : { "type" : "object" }, "AlipayOpenMiniInnerMembersAddErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "APPID_NOT_EXIST", "NOT_TINYAPP", "INNER_APP_ORIGIN_IS_BLANK", "INNER_APP_ORIGIN_NOT_EXIT", "INVALID_PARAMS" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerMembersAddModel" : { "type" : "object", "properties" : { "app_origin" : { "type" : "string", "description" : "业务来源", "example" : "ALIPAY" }, "domain_account" : { "type" : "string", "description" : "域账号（不为空时会添加联系人）", "example" : "域账号" }, "login_id" : { "type" : "string", "description" : "支付宝登陆账号", "example" : "支付宝登陆账号" }, "mini_app_id" : { "type" : "string", "description" : "业务appId", "example" : "2021125678974521" }, "type" : { "type" : "string", "description" : "成员类型", "example" : "DEVELOPER" } } }, "AlipayOpenMiniInnerMembersAddResponseModel" : { "type" : "object" }, "AlipayOpenMiniInnerMembersDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "APPID_NOT_EXIST", "NOT_TINYAPP", "INNER_APP_ORIGIN_IS_BLANK", "INNER_APP_ORIGIN_NOT_EXIT", "INVALID_PARAMS" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerMembersDeleteResponseModel" : { "type" : "object" }, "AlipayOpenMiniInnerMembersQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "APPID_NOT_EXIST", "NOT_TINYAPP", "INNER_APP_ORIGIN_IS_BLANK", "INNER_APP_ORIGIN_NOT_EXIT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerMembersQueryResponseModel" : { "type" : "object", "properties" : { "open_app_operator_vo" : { "type" : "array", "description" : "查询结果", "items" : { "$ref" : "#/components/schemas/OpenAppOperatorVo" } } } }, "AlipayOpenMiniInnerappCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMS_WARN", "APP_NAME_IS_BLANK", "INVALID_MINI_APP_NAME", "INVALID_MINI_APP_NAME_LENGTH", "ENGLISH_NAME_IS_BLANK", "INVALID_MINI_APP_EN_NAME", "INVALID_MINI_APP_EN_NAME_LENGTH", "SLOGAN_IS_BLANK", "INVALID_MINI_APP_SLOGAN_LENGTH", "SERVICE_TEL_IS_BLANK", "INVALID_MINI_APP_SERVICE_TEL", "CATEGORY_IS_BLANK", "CATEGORY_NUM_IS_INVALID", "APP_DESC_IS_BLANK", "MINI_APP_NAME_DUPLICATE", "MINI_APP_EN_NAME_DUPLICATE", "INVALID_CATEGORY", "INVALID_MINI_APP_DESC_LENGTH", "SUB_APPLICATION_TYPE_ERROR", "INVALID_PARAMS", "APP_ORIGIN_NOT_EXIST", "RISK_DECISION_CHECK_FAIL", "LOGO_IS_BLANK", "DESCRIPTION_IS_BLANK", "SERVICE_TEL_AND_MAIL_BOTH_BLANK", "ISV_APP_ID_IS_BLANK", "MINI_APP_ID_EXIST", "CREATE_MINI_APP_EXCEED_MAX_COUNT", "APP_ID_ILLEGAL", "APP_ID_EXIST", "INVALID_MINI_PLUGIN_NAME" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerappCreateModel" : { "type" : "object", "properties" : { "app_category_ids" : { "type" : "string", "description" : "小程序类目，二级类目与三级类目下划线隔开，最多可以选择3个类目，类目之间以;隔开", "example" : "107211_107236" }, "app_desc" : { "type" : "string", "description" : "小程序描述，20-200个字符", "example" : "我的一个计算小程序，这里注意长度是20-200个字符，10-100中文字" }, "app_english_name" : { "type" : "string", "description" : "小程序英文名称，插件不填", "example" : "tinyName" }, "app_logo" : { "type" : "string", "description" : "小程序logo", "example" : "http://appstoreisvpic.alipayobjects.com/0aef2a4a-0b90-444d-916b-e8b25cd787c9.png" }, "app_name" : { "type" : "string", "description" : "小程序名称", "example" : "我的小程序" }, "app_origin" : { "type" : "string", "description" : "来源的业务方,接入文档中申请的业务来源", "example" : "AAA" }, "app_slogan" : { "type" : "string", "description" : "小程序简介，在搜索透出,插件不需要填", "example" : "我的小程序" }, "app_sub_type" : { "type" : "string", "description" : "应用子类型", "example" : "TINYAPP_NORMAL，TINYAPP_TEMPLATE，TINYAPP_PLUGIN" }, "app_type" : { "type" : "string", "description" : "应用类型", "example" : "TINYAPP" }, "isv_app_id" : { "type" : "string", "description" : "三方应用ID，仅在创建模板小程序时需要传入", "example" : "2019****" }, "mini_app_id" : { "type" : "string", "description" : "小程序ID，仅特殊场景使用，普通业务方无需关注该参数", "example" : "300*****" }, "mini_category_ids" : { "type" : "string", "description" : "新小程序前台类目，格式为 第一个一级类目_第一个二级类目;第二个一级类目_第二个二级类目_第二个三级类目，详细类目可以通过 https://docs.open.alipay.com/api_49/alipay.open.mini.category.query接口查询mini_category_list。使用后不再读取app_category_ids值，老前台类目将废弃", "example" : "XS1001_XS2001_XS3002;XS1011_XS2089;XS1002_XS2008_XS3024" }, "pid" : { "type" : "string", "description" : "创建的小程序所属的PID", "example" : "2088****" }, "service_email" : { "type" : "string", "description" : "邮箱，与客服电话二选一", "example" : "123@alibaba.cn" }, "service_phone" : { "type" : "string", "description" : "客服电话，插件不需要", "example" : "021-333333" } } }, "AlipayOpenMiniInnerappCreateResponseModel" : { "type" : "object", "properties" : { "mini_app_id" : { "type" : "string", "description" : "小程序ID", "example" : "2018****" } } }, "AlipayOpenMiniInnerappPluginOrderErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "PLUGIN_CAN_NOT_ORDER", "SYSTEM_ERROR", "APP_ORIGIN_NOT_EXIST", "INVALID_PARAMS", "APP_INFO_NOT_EXIST", "APPLICATION_TYPE_NOT_MINIAPP", "MINI_APP_NOT_ONLINE", "SUB_APPLICATION_TYPE_ERROR", "NO_PERMISSION", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerappPluginOrderModel" : { "type" : "object", "properties" : { "app_origin" : { "type" : "string", "description" : "业务来源", "example" : "ASTORE" }, "merchandise_id" : { "type" : "string", "description" : "订购的服务商品ID", "example" : "I1060100001000050367,插件发布接口返回的商品ID" }, "mini_app_id" : { "type" : "string", "description" : "一二方支持传入appId", "example" : "123123" }, "request_id" : { "type" : "string", "description" : "业务幂等号，规则为商品id+appOrigin+requestId 作为幂等流水号\t非必填,不传则默认生成一个8位requestId", "example" : "fd434frr" } } }, "AlipayOpenMiniInnerappPluginOrderResponseModel" : { "type" : "object", "properties" : { "order_id" : { "type" : "string", "description" : "订单号", "example" : "2018071900000015585789" } } }, "AlipayOpenMiniInnerappPluginrelationQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMS" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerappPluginrelationQueryModel" : { "type" : "object", "properties" : { "mini_app_id_list" : { "type" : "array", "description" : "应用ID列表", "items" : { "type" : "string" }, "example" : "['2012211102012056','2012211102012057']" }, "page_num" : { "type" : "integer", "description" : "页码", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "页大小", "example" : "10" }, "plugin_id" : { "type" : "string", "description" : "插件ID", "example" : "2012211102012088" }, "plugin_relation_status_list" : { "type" : "array", "description" : "插件使用关系状态，取值包括WORKING/WAIT_WORKING/STOP_WORKING/EXECUTING", "items" : { "type" : "string" }, "example" : "[\"WORKING\"]" }, "run_model_type" : { "type" : "string", "description" : "运行类型，取值包括ONLINE/TRIAL/REVIEW/DEBUG", "example" : "ONLINE" }, "show_beta_info" : { "type" : "boolean", "description" : "是否展示邀测信息", "example" : "true" } } }, "AlipayOpenMiniInnerappPluginrelationQueryResponseModel" : { "type" : "object", "properties" : { "page" : { "type" : "integer", "description" : "页码", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "页大小", "example" : "10" }, "plugin_relation_info_list" : { "type" : "array", "description" : "插件关联关系信息", "items" : { "$ref" : "#/components/schemas/PluginUseRelationInfo" } }, "total_count" : { "type" : "integer", "description" : "总数", "example" : "10" } } }, "AlipayOpenMiniInnerappPluginservicePublishErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "APP_ORIGIN_NOT_EXIST", "APP_INFO_NOT_EXIST", "APPLICATION_TYPE_NOT_MINIAPP", "MINI_APP_NOT_ONLINE", "SYSTEM_ERROR", "APPID_IS_BLANK", "PUBLISH_PLUGIN_FAIL", "PLUGIN_HAS_NO_ONLINE_VERSION", "NOT_NORMAL_PLUGIN", "PUBLISH_PLUGIN_DUPLICATE_FAIL", "INVALID_SERVICE_TITLE_LENGTH", "LOGO_IS_BLANK", "INVALID_SERVICE_DESCRIPTION_LENGTH", "ABILITY_TYPE_LIST_IS_BLANK", "SELL_CROWD_INVALID", "SHOW_TYPE_INVALID", "INVALID_SERVICE_DETAIL_PC_LENGTH", "INVALID_SERVICE_DETAIL_MOBILE_LENGTH", "INVALID_PARAMS" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerappPluginservicePublishModel" : { "type" : "object", "properties" : { "ability_type_list" : { "type" : "array", "description" : "功能类型，目前支持的有：1039支付, 1040会员, 1041基础, 1056资金, 1058信用, 1111口碑, 330120安全, 360101营销", "items" : { "type" : "string" }, "example" : "1040" }, "app_logo" : { "type" : "string", "description" : "服务发布logo", "example" : "https://appstoreisvpic.alipayobjects.com/prod/f9e291ed-0de5-4f5e-97ec-f76b8414a3e0.png" }, "app_origin" : { "type" : "string", "description" : "业务来源", "example" : "TAOBAO" }, "description" : { "type" : "string", "description" : "服务描述", "example" : "这是一段关于插件的描述" }, "detail_for_client" : { "type" : "string", "description" : "移动端详情，用于能力中心展示", "example" : "

client detail

" }, "detail_for_pc" : { "type" : "string", "description" : "pc端详情，用于能力中心展示", "example" : "

pc detail

" }, "mini_app_id" : { "type" : "string", "description" : "插件id", "example" : "2012211102012056" }, "sell_crowd" : { "type" : "string", "description" : "可订购人群，1003个人, 1004企业，-1无限制", "example" : "-1" }, "show_type" : { "type" : "string", "description" : "发布后是否展示，01展示（默认）、02隐藏", "example" : "01" }, "title" : { "type" : "string", "description" : "服务标题", "example" : "互投插件" }, "visit_url_for_pc" : { "type" : "string", "description" : "pc端url地址，不需要则为空", "example" : "https://nengli.alipay.com/abilityprod/detail?abilityCode=SM010000000000001100" } } }, "AlipayOpenMiniInnerappPluginservicePublishResponseModel" : { "type" : "object", "properties" : { "ability_id" : { "type" : "string", "description" : "PL2012211102012056", "example" : "能力中心id" } } }, "AlipayOpenMiniInnerappPluginsyncmodeModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMS", "UPDATE_PLUGIN_SERVICE_FAIL", "SUB_APPLICATION_TYPE_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerappPluginsyncmodeModifyModel" : { "type" : "object", "properties" : { "app_origin" : { "type" : "string", "description" : "来源", "example" : "-" }, "mini_app_id" : { "type" : "string", "description" : "小程序应用 ID，", "example" : "2021001177654214" }, "plugin_id" : { "type" : "string", "description" : "插件id", "example" : "2021002146679702" }, "sync_mode" : { "type" : "string", "description" : "模式，SYNC/NONE", "example" : "SYNC" } } }, "AlipayOpenMiniInnerappPluginsyncmodeModifyResponseModel" : { "type" : "object" }, "AlipayOpenMiniInnerappPluginuseconfigCancelErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "CAN_NOT_GRAY_EXIST_VERSION", "CURRENT_VERSION_IS_ONLINE", "APP_INFO_NOT_EXIST", "PLUGIN_NOT_ORDERED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerappPluginuseconfigCancelModel" : { "type" : "object", "properties" : { "app_origin" : { "type" : "string", "description" : "来源", "example" : "-" }, "bundle_id" : { "type" : "string", "description" : "端id", "example" : "com.alipay.alipaywallet" }, "mini_app_id" : { "type" : "string", "description" : "小程序应用 ID", "example" : "2021002146679701" }, "plugin_dev_version" : { "type" : "string", "description" : "插件研发版本", "example" : "0.0.3" }, "plugin_id" : { "type" : "string", "description" : "插件id", "example" : "2021002146679702" } } }, "AlipayOpenMiniInnerappPluginuseconfigCancelResponseModel" : { "type" : "object" }, "AlipayOpenMiniInnerappPluginuseconfigOnlineErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMS", "PLUGIN_NOT_ORDERED", "APP_INFO_NOT_EXIST", "CAN_NOT_GRAY_EXIST_VERSION", "CURRENT_VERSION_IS_ONLINE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerappPluginuseconfigOnlineModel" : { "type" : "object", "properties" : { "app_origin" : { "type" : "string", "description" : "来源", "example" : "-" }, "bundle_id" : { "type" : "string", "description" : "端id", "example" : "com.alipay.alipaywallet" }, "mini_app_id" : { "type" : "string", "description" : "小程序应用 ID", "example" : "2021002146679701" }, "plugin_dev_version" : { "type" : "string", "description" : "插件研发版本", "example" : "0.0.3" }, "plugin_id" : { "type" : "string", "description" : "插件id", "example" : "2021002146679702" } } }, "AlipayOpenMiniInnerappPluginuseconfigOnlineResponseModel" : { "type" : "object" }, "AlipayOpenMiniInnerappPluginuseconfigUpgradeErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMS", "PLUGIN_NOT_ORDERED", "APP_INFO_NOT_EXIST", "CAN_NOT_GRAY_EXIST_VERSION", "CURRENT_VERSION_IS_ONLINE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerappPluginuseconfigUpgradeModel" : { "type" : "object", "properties" : { "app_origin" : { "type" : "string", "description" : "来源", "example" : "-" }, "bundle_id" : { "type" : "string", "description" : "端id", "example" : "com.alipay.alipaywallet" }, "mini_app_id" : { "type" : "string", "description" : "小程序应用 ID", "example" : "2021002146679701" }, "plugin_dev_version" : { "type" : "string", "description" : "插件研发版本", "example" : "0.0.3" }, "plugin_id" : { "type" : "string", "description" : "插件id", "example" : "2021002146679702" }, "strategy_value" : { "type" : "string", "description" : "灰度值", "example" : "p50" } } }, "AlipayOpenMiniInnerappPluginuseconfigUpgradeResponseModel" : { "type" : "object" }, "AlipayOpenMiniInnerappServicePublishErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "APP_ORIGIN_NOT_EXIST", "APP_INFO_NOT_EXIST", "APPLICATION_TYPE_NOT_MINIAPP", "MINI_APP_NOT_ONLINE", "BUNDLE_ID_NOT_EXIST", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerappServicePublishModel" : { "type" : "object", "properties" : { "app_logo" : { "type" : "string", "description" : "服务发布logo", "example" : "https://appstoreisvpic.alipayobjects.com/prod/f9e291ed-0de5-4f5e-97ec-f76b8414a3e0.png" }, "app_origin" : { "type" : "string", "description" : "业务来源", "example" : "AAA" }, "mini_app_id" : { "type" : "string", "description" : "小程序ID，仅特殊场景使用，普通业务方无需关注该参数。", "example" : "2019****" }, "pid" : { "type" : "string", "description" : "小程序模板所属PID", "example" : "2088****" }, "sub_title" : { "type" : "string", "description" : "服务子标题", "example" : "服务子标题" }, "title" : { "type" : "string", "description" : "服务名称", "example" : "服务名称" } } }, "AlipayOpenMiniInnerappServicePublishResponseModel" : { "type" : "object", "properties" : { "merchandise_id" : { "type" : "string", "description" : "服务ID", "example" : "I1060100001000050361" } } }, "AlipayOpenMiniInnerappServiceQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PAGE_NUM", "INVALID_PAGE_SIZE", "INVALID_PARAMS", "BIZ_ERROR", "APP_ORIGIN_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerappServiceQueryResponseModel" : { "type" : "object", "properties" : { "mini_app_service_info_list" : { "type" : "array", "description" : "小程序服务信息", "items" : { "$ref" : "#/components/schemas/MiniAppServiceInfo" } }, "page" : { "type" : "integer", "description" : "当前页数", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "页大小", "example" : "10" }, "total_count" : { "type" : "integer", "description" : "总数", "example" : "100" } } }, "AlipayOpenMiniInnerbaseinfoApplogoUploadErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_LOGO_EXT", "LOGO_IS_BLANK", "LOGO_SIZE_EXCEED", "LOGO_HEIGHT_NOT_EQUAL_WIDTH" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerbaseinfoApplogoUploadModel" : { "type" : "object" }, "AlipayOpenMiniInnerbaseinfoApplogoUploadResponseModel" : { "type" : "object", "properties" : { "app_logo" : { "type" : "string", "description" : "上传图片结果地址。\t图片要求：\t1、不能超过256kb 2、支持的图片格式为jpg、jpeg、png 3、长宽比例必须为为1:1", "example" : "http://appstoreisvpic.alipayobjects.com/6c19accf-1343-4c5d-be62-3964144b3944.png" } } }, "AlipayOpenMiniInnerbaseinfoQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "APPID_IS_BLANK", "APP_INFO_NOT_EXIST", "DEVELOPER_INFO_NOT_EXIST", "SYSTEM_ERROR", "MERCHANT_NOT_EXESIT", "INVALID_PARAMS" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerbaseinfoQueryResponseModel" : { "type" : "object", "properties" : { "app_alias_name" : { "type" : "string", "description" : "小程序别名，简称", "example" : "小程序别名，简称" }, "app_category_ids" : { "type" : "string", "description" : "类目Id列表", "example" : "107209_107226;107209_107227" }, "app_desc" : { "type" : "string", "description" : "小程序应用描述", "example" : "小程序官方示例Demo，展示已支持的接口能力及组件。" }, "app_english_name" : { "type" : "string", "description" : "小程序英文名称", "example" : "tinyapp" }, "app_key" : { "type" : "string", "description" : "手淘开放平台鉴权key，支付宝不需要", "example" : "test" }, "app_logo" : { "type" : "string", "description" : "小程序应用logo图标", "example" : "https://appstoreisvpic.alipayobjects.com/prod/04843e84-f1fd-4717-a230-1c72de99aa5d.png" }, "app_name" : { "type" : "string", "description" : "小程序名称", "example" : "小程序名称" }, "app_slogan" : { "type" : "string", "description" : "小程序简介", "example" : "小程序简介" }, "app_sub_type" : { "type" : "string", "description" : "小程序类型，TINYAPP_TEMPLATE，TINYAPP_NORMAL，TINYAPP_PLUGIN", "example" : "TINYAPP_TEMPLATE" }, "dev_id" : { "type" : "string", "description" : "小程序所属主体信息", "example" : "2088301139347331" }, "gmt_create" : { "type" : "string", "description" : "小程序主体创建时间", "example" : "2017-12-12 12:00:00" }, "gmt_modified" : { "type" : "string", "description" : "小程序主体更新时间", "example" : "2017-12-12 12:00:00" }, "mini_app_id" : { "type" : "string", "description" : "小程序Id", "example" : "3000000000001501" }, "mini_category_ids" : { "type" : "string", "description" : "新小程序前台类目，一级与二级、三级用下划线隔开，最多可以选四个类目，类目之间;隔开。使用后不再读取app_category_ids值，老前台类目将废弃", "example" : "XS1001_XS2001_XS3002;XS1011_XS2089;XS1002_XS2008_XS3024" }, "origin" : { "type" : "string", "description" : "应用创建来源，alipay = 支付宝，taobao = 淘宝", "example" : "alipay" }, "owner_entity" : { "type" : "string", "description" : "小程序主体信息", "example" : "0001" }, "owner_portrait" : { "type" : "string", "description" : "小程序主体头像信息", "example" : "http://www.alipay.icon.com" }, "plugin_refresh_type" : { "type" : "string", "description" : "AUTO/自动更新、MANUAL/手动更新", "example" : "MANUAL" }, "service_email" : { "type" : "string", "description" : "小程序客服邮箱", "example" : "example@mail.com" }, "service_phone" : { "type" : "string", "description" : "小程序客服电话", "example" : "13110101010" } } }, "AlipayOpenMiniInnerversionAuditCancelErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "APPID_IS_BLANK", "VERSION_IS_BLANK", "APP_INFO_NOT_EXIST", "APPLICATION_TYPE_NOT_MINIAPP", "MINI_APP_NOT_ONLINE", "MINI_APP_PACKAGE_INFO_NOT_EXIST", "TINYAPP_STATUS_INVALID", "MULTI_CLIENT_NOT_PACKAGED_STATUS", "APPSTORE_RPC_INVOKE_ERROR", "NO_PERMISSION", "APP_ORIGIN_NOT_EXIST", "BUNDLE_ID_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionAuditCancelModel" : { "type" : "object", "properties" : { "app_origin" : { "type" : "string", "description" : "业务来源", "example" : "AAA" }, "app_version" : { "type" : "string", "description" : "小程序版本", "example" : "0.0.1" }, "bundle_id" : { "type" : "string", "description" : "端信息", "example" : "支付宝：com.alipay.alipaywallet 高德：com.amap.app" }, "mini_app_id" : { "type" : "string", "description" : "小程序ID，仅特殊场景使用，普通业务方无需关注该参数", "example" : "2019****" }, "pid" : { "type" : "string", "description" : "小程序所属PID", "example" : "2088****" } } }, "AlipayOpenMiniInnerversionAuditCancelResponseModel" : { "type" : "object" }, "AlipayOpenMiniInnerversionAuditSubmitErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_MINI_APP_NAME_LENGTH", "SPECIAL_LICENSE_PICS_ARE_BLANK", "INVALID_MINI_APP_NAME", "INVALID_MINI_APP_EN_NAME", "INVALID_MINI_APP_EN_NAME_LENGTH", "INVALID_MINI_APP_SLOGAN", "SERVICE_TEL_AND_MAIL_BOTH_BLANK", "INVALID_MINI_APP_SERVICE_TEL", "INVALID_MINI_APP_SERVICE_MAIL", "CATEGORY_NUM_IS_INVALID", "CATEGORY_IS_BLANK", "APP_DESC_IS_BLANK", "INVALID_MINI_APP_DESC_LENGTH", "INVALID_MINI_APP_DESC", "APP_VERSION_IS_BLANK", "VERSION_DESC_IS_BLANK", "INVALID_VERSION_DESC_LENGTH", "INVALID_MINI_APP_VERSION_DESC", "SCREEN_SHOTS_ARE_BLANK", "SCREEN_SHOT_NUM_IS_INVALID", "INVALID_MINI_APP_MEMO_LENGTH", "APPLICATION_TYPE_NOT_MINIAPP", "INVALID_MINI_APP_SAFE_DOMAIN", "CAN_NOT_SUBMIT_WITH_ALI_CLOUD", "MINI_APP_NAME_DUPLICATE", "MINI_APP_EN_NAME_DUPLICATE", "INVALID_CATEGORY", "MINI_APP_NAME_SENSITIVE", "MINI_APP_EN_NAME_SENSITIVE", "MINI_APP_SLOGAN_SENSITIVE", "MINI_APP_MEMO_SENSITIVE", "MINI_APP_DESC_SENSITIVE", "MINI_APP_SERVICE_MAIL_SENSITIVE", "MINI_APP_VERSION_DESC_SENSITIVE", "MINI_APP_PACKAGE_INFO_NOT_EXIST", "CAN_NOT_MODIFY_NAME_ONCE_ONLINE", "CAN_NOT_MODIFY_EN_ONCE_ONLINE", "MODIFY_SLOGAN_EXCEED_COUNT", "MODIFY_CATEGORY_ID_EXCEED_COUNT", "MODIFY_DESC_EXCEED_COUNT", "CAN_NOT_SUBMIT_WITH_AUDIT", "CAN_NOT_SUBMIT_WITHOUT_INIT", "CAN_NOT_SUBMIT_WITHOUT_SCAN_PASS", "CAN_NOT_SUBMIT_WITH_AUDIT_GRAY", "EXIST_LARGER_ONLINED_VERSION", "LICENSE_NO_IS_BLANK", "LICENSE_VALID_DATE_IS_BLANK", "LICENSE_VALID_DATE_IS_INVALID", "OUT_DOOR_PIC_IS_BLANK", "LICENSE_PICS_ARE_BLANK", "LICENSE_PIC_NUM_IS_INVALID", "LICENSE_CHECK_FAIL", "LOGO_HEIGHT_NOT_EQUAL_WIDTH", "INVALID_SCREEN_SHOT_EXT", "SCREEN_SHOT_EXCEED_MAX_SIZE", "INVALID_LICENSE_PIC_EXT", "LICENSE_PIC_EXCEED_MAX_SIZE", "INVALID_OUT_DOOR_PIC_EXT", "OUT_DOOR_PIC_EXCEED_MAX_SIZE", "LOGO_EXCEED_MAX_SIZE", "INVALID_LOGO_EXT", "INVALID_PARAMS", "INVALID_LOGO", "INVALID_IMAGE", "RISK_DECISION_CHECK_FAIL", "TINY_APP_AUDIT_NOT_PERMIT", "APP_ORIGIN_NOT_EXIST", "DEFAULT_LOGO", "SLOGAN_IS_BLANK", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionAuditSubmitModel" : { "type" : "object", "properties" : { "app_category_ids" : { "type" : "string", "description" : "小程序类目，格式为 第一个一级类目_第一个二级类目;第二个一级类目_第二个二级类目，详细类目可以参考开放服务类目，如果不填默认采用当前小程序应用类目。使用默认应用类目后不需要再次上传营业执照号、营业执照名、营业执照截图、营业执照有效期。", "example" : "107211_ 107427" }, "app_desc" : { "type" : "string", "description" : "小程序应用描述，20-200个字，如果不填默认采用当前小程序的应用描述", "example" : "这是一个小程序的描述这是一个小程序的描述这是一个小程序的描述这是一个小程序的描述" }, "app_english_name" : { "type" : "string", "description" : "小程序应用英文名称，如果不填默认采用当前小程序应用英文名称，3～30个字符。插件不填", "example" : "demoenname" }, "app_logo" : { "type" : "string", "description" : "小程序logo图标，图片格式必须为：png、jpeg、jpg，比例必须为1:1，建议上传像素为180*180，不超过256kb， 如果不填默认采用当前小程序应用logo图标", "example" : "https://appstoreisvpic.alipayobjects.com/prod/f9e291ed-0de5-4f5e-97ec-f76b8414a3e0.png" }, "app_name" : { "type" : "string", "description" : "小程序应用名称，如果不填默认采用当前小程序应用名称，名称3-40个字符，一个中文算两个字符", "example" : "XXX的应用" }, "app_origin" : { "type" : "string", "description" : "来源类型，新接入方需要向支付宝申请专用来源，否则不予接入，申请方式请参见接入手册。", "example" : "AAA" }, "app_slogan" : { "type" : "string", "description" : "小程序应用简介，一句话描述小程序功能，如果不填默认采用当前小程序应用简介，10~32个字符", "example" : "示例slogan" }, "app_version" : { "type" : "string", "description" : "需要提交审核的小程序版本号，格式为: x.y.z，其中x、y、z均为整型数字，一个应用最多只能有一个审核中、审核通过或者审核驳回的版本。", "example" : "0.0.1" }, "bundle_id" : { "type" : "string", "description" : "端ID，多端场景下区分不同端", "example" : "com.alipay.alipaywallet" }, "license_info" : { "$ref" : "#/components/schemas/AuditLicenseInfo" }, "memo" : { "type" : "string", "description" : "小程序备注", "example" : "小程序备注示例" }, "mini_app_id" : { "type" : "string", "description" : "小程序ID，特殊场景专用，普通业务方无需关注该参数。", "example" : "2019051464523527" }, "mini_category_ids" : { "type" : "string", "description" : "新小程序前台类目，格式为 第一个一级类目_第一个二级类目;第二个一级类目_第二个二级类目_第二个三级类目，详细类目可以通过 alipay.open.mini.category.query（小程序类目树查询接口）查询mini_category_list，如果不填默认采用当前小程序应用类目。使用默认应用类目后不需要再次上传营业执照号、营业执照名、营业执照截图、营业执照有效期。使用后不再读取app_category_ids值，老前台类目将废弃", "example" : "XS1001_XS2001_XS3002;XS1011_XS2089;XS1002_XS2008_XS3024" }, "open_id" : { "type" : "string", "description" : "小程序所属PID", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "out_door_pic" : { "type" : "string", "description" : "门头照图片地址，部分小程序类目需要提交，参照 开放服务类目 中是否需要营业执照信息，如果不填默认采用当前小程序门头照图片", "example" : "https://appstoreisvpic.alipayobjects.com/prod/c74a6310-4695-48d7-8f1b-4e5cc11c7615.jpg" }, "pid" : { "type" : "string", "description" : "小程序所属PID", "example" : "2088****" }, "screen_shot_list" : { "type" : "array", "description" : "小程序应用截图列表，逗号分割，需要2-5张图片，单张图片不能超过4MB，图片格式只支持jpg，png；通过模板实例化小程序不需要传递此参数。", "items" : { "type" : "string" }, "example" : "https://appstoreisvpic.alipayobjects.com/prod/c74a6310-4695-48d7-8f1b-4e5cc11c7615.jpg,https://app.alipayobjects.com/ss.jpg" }, "service_email" : { "type" : "string", "description" : "小程序客服邮箱，如果不填默认采用当前小程序的应用客服邮箱，和客服电话至少填写一个", "example" : "example@mail.com" }, "service_phone" : { "type" : "string", "description" : "小程序客服电话，如果不填默认采用当前小程序的应用客服电话，和客服邮箱至少填写一个。插件不填", "example" : "13110101010" }, "special_license_pic_list" : { "type" : "string", "description" : "特殊资质图片地址列表，逗号分隔；部分类目需要特殊资质，如果需要特殊资质，最少一张，最多三张。模板和插件不需要特殊资质", "example" : "https://appstoreisvpic.alipayobjects.com/prod/c74a6310-4695-48d7-8f1b-4e5cc11c7615.jpg,https://appstoreisvpic.alipayobjects.com/prod/c74a6310-4695-48d7-8f1b-4e5cc11c7615.jpg" }, "version_desc" : { "type" : "string", "description" : "小程序版本变更描述，30-500个字符，区分于app_desc", "example" : "本版本主要新增了XXX功能：1、xxxxxxx； 2、xxxxxx；修复了XXXbug：1、xxxxxx；2、xxxxxx" } } }, "AlipayOpenMiniInnerversionAuditSubmitResponseModel" : { "type" : "object" }, "AlipayOpenMiniInnerversionBackdevPublishErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "APP_VERSION_IS_BLANK", "APPLICATION_TYPE_NOT_MINIAPP", "MINI_APP_PACKAGE_INFO_NOT_EXIST", "CAN_NOT_BACK_DEV_WITHOUT_AUDIT", "APP_ORIGIN_NOT_EXIST", "BUNDLE_ID_NOT_EXIST", "APP_INFO_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionBackdevPublishModel" : { "type" : "object", "properties" : { "app_origin" : { "type" : "string", "description" : "业务来源", "example" : "AAA" }, "app_version" : { "type" : "string", "description" : "小程序版本", "example" : "0.0.1" }, "bundle_id" : { "type" : "string", "description" : "端信息", "example" : "支付宝：com.alipay.alipaywallet 高德：com.amap.app" }, "mini_app_id" : { "type" : "string", "description" : "小程序ID，仅特殊场景使用，普通业务方无需关注该参数", "example" : "2019****" }, "pid" : { "type" : "string", "description" : "小程序所属PID", "example" : "2088****" } } }, "AlipayOpenMiniInnerversionBackdevPublishResponseModel" : { "type" : "object" }, "AlipayOpenMiniInnerversionBetaConfirmErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PLUGIN_BETA_RELATION_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionBetaConfirmModel" : { "type" : "object", "properties" : { "app_origin" : { "type" : "string", "description" : "业务来源", "example" : "AAA" }, "memo" : { "type" : "string", "description" : "拒绝理由", "example" : "业务验证不通过" }, "mini_app_id" : { "type" : "string", "description" : "小程序ID，仅特殊场景使用，普通业务方无需关注该参数", "example" : "2019*****" }, "operate" : { "type" : "string", "description" : "操作：pass/reject。接受或者拒绝", "example" : "pass" }, "pid" : { "type" : "string", "description" : "小程序所属PID", "example" : "2088****" }, "plugin_id" : { "type" : "string", "description" : "要确认邀测结果的插件appid", "example" : "2019*****" } } }, "AlipayOpenMiniInnerversionBetaConfirmResponseModel" : { "type" : "object" }, "AlipayOpenMiniInnerversionBetainfoQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PACKAGE_VERSION_IS_BLANK", "PLUGINID_IS_BLANK", "APP_ORIGIN_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionBetainfoQueryResponseModel" : { "type" : "object", "properties" : { "plugin_beta_item_list" : { "type" : "array", "description" : "邀测结果列表", "items" : { "$ref" : "#/components/schemas/PluginBetaItemInfo" } }, "status" : { "type" : "string", "description" : "邀测状态，待确认WAITCHECK/确认CHECKED/拒绝REJECT", "example" : "WAITCHECK" } } }, "AlipayOpenMiniInnerversionBuildauditSubmitErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_MINI_APP_NAME_LENGTH", "SPECIAL_LICENSE_PICS_ARE_BLANK", "INVALID_MINI_APP_NAME", "INVALID_MINI_APP_EN_NAME", "INVALID_MINI_APP_EN_NAME_LENGTH", "INVALID_MINI_APP_SLOGAN", "SERVICE_TEL_AND_MAIL_BOTH_BLANK", "INVALID_MINI_APP_SERVICE_TEL", "CATEGORY_NUM_IS_INVALID", "CATEGORY_IS_BLANK", "APP_DESC_IS_BLANK", "INVALID_MINI_APP_DESC_LENGTH", "INVALID_MINI_APP_DESC", "APP_VERSION_IS_BLANK", "VERSION_DESC_IS_BLANK", "INVALID_VERSION_DESC_LENGTH", "INVALID_MINI_APP_VERSION_DESC", "SCREEN_SHOTS_ARE_BLANK", "SCREEN_SHOT_NUM_IS_INVALID", "INVALID_MINI_APP_MEMO_LENGTH", "APPLICATION_TYPE_NOT_MINIAPP", "INVALID_MINI_APP_SAFE_DOMAIN", "CAN_NOT_SUBMIT_WITH_ALI_CLOUD", "MINI_APP_NAME_DUPLICATE", "MINI_APP_EN_NAME_DUPLICATE", "INVALID_CATEGORY", "INVALID_REGION", "MINI_APP_NAME_SENSITIVE", "MINI_APP_EN_NAME_SENSITIVE", "MINI_APP_SLOGAN_SENSITIVE", "MINI_APP_MEMO_SENSITIVE", "MINI_APP_DESC_SENSITIVE", "MINI_APP_SERVICE_MAIL_SENSITIVE", "MINI_APP_VERSION_DESC_SENSITIVE", "MINI_APP_PACKAGE_INFO_NOT_EXIST", "CAN_NOT_MODIFY_NAME_ONCE_ONLINE", "CAN_NOT_MODIFY_EN_ONCE_ONLINE", "MODIFY_SLOGAN_EXCEED_COUNT", "MODIFY_CATEGORY_ID_EXCEED_COUNT", "MODIFY_DESC_EXCEED_COUNT", "CAN_NOT_SUBMIT_WITH_AUDIT", "CAN_NOT_SUBMIT_WITHOUT_INIT", "CAN_NOT_SUBMIT_WITHOUT_SCAN_PASS", "CAN_NOT_SUBMIT_WITH_AUDIT_GRAY", "EXIST_LARGER_ONLINED_VERSION", "LICENSE_NO_IS_BLANK", "LICENSE_VALID_DATE_IS_BLANK", "LICENSE_VALID_DATE_IS_INVALID", "OUT_DOOR_PIC_IS_BLANK", "LICENSE_PICS_ARE_BLANK", "LICENSE_PIC_NUM_IS_INVALID", "LICENSE_CHECK_FAIL", "LOGO_HEIGHT_NOT_EQUAL_WIDTH", "INVALID_SCREEN_SHOT_EXT", "SCREEN_SHOT_EXCEED_MAX_SIZE", "INVALID_LICENSE_PIC_EXT", "LICENSE_PIC_EXCEED_MAX_SIZE", "INVALID_OUT_DOOR_PIC_EXT", "OUT_DOOR_PIC_EXCEED_MAX_SIZE", "LOGO_EXCEED_MAX_SIZE", "INVALID_LOGO_EXT", "INVALID_PARAMS", "INVALID_LOGO", "INVALID_IMAGE", "RISK_DECISION_CHECK_FAIL", "TINY_APP_AUDIT_NOT_PERMIT", "RISK_DECISION_HIT_BRAND", "BRAND_TORT_NOT_END", "SYSTEM_ERROR", "MINI_APP_INFO_AUDIT_CONTAINS", "DEFAULT_LOGO" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionBuildauditSubmitModel" : { "type" : "object", "properties" : { "app_category_ids" : { "type" : "string", "description" : "小程序类目，可不传，不传取基础信息中的小程序类目", "example" : "107209_107226" }, "app_desc" : { "type" : "string", "description" : "小程序描述，可不传，不传取基础信息中的小程序描述", "example" : "小程序描述" }, "app_english_name" : { "type" : "string", "description" : "小程序在从未上架过版本之前，英文名称是可以修改的，该字段用于在提交审核时候修改小程序英文名称。注意：小程序一旦有过上架版本之后就不可以修改英文名称。", "example" : "小程序英文名称" }, "app_logo" : { "type" : "string", "description" : "小程序logo，可不传，不传取基础信息中的小程序logo，请调用专用的logo上传接口上传logo文件，并将返回的地址作为本字段传入", "example" : "https://appstoreisvpic.alipayobjects.com/prod/e2bcf04b-da46-4b7f-a020-e9d224df7689.png" }, "app_name" : { "type" : "string", "description" : "小程序在从未上架过版本之前，中文名称是可以修改的，该字段用于在提交审核时候修改小程序中文名称。注意：小程序一旦有过上架版本之后就不可以修改中文名称。", "example" : "小程序名称" }, "app_origin" : { "type" : "string", "description" : "来源类型，新接入方需要向支付宝申请专用来源，否则不予接入，申请方式请参见接入手册。", "example" : "AAA" }, "app_slogan" : { "type" : "string", "description" : "小程序应用简介，一句话描述小程序功能，如果不填默认采用当前小程序应用简介，10~32个字符", "example" : "小程序简介" }, "app_version" : { "type" : "string", "description" : "小程序版本号", "example" : "1.0.1" }, "build_ext" : { "type" : "string", "description" : "构建扩展参数", "example" : "{\"ext\":{\"appId\":\"2019********\",\"pid\":\"2088*******\"},\"extEnable\":true}" }, "bundle_id" : { "type" : "string", "description" : "端信息", "example" : "com.alipay.alipaywallet" }, "isv_app_id" : { "type" : "string", "description" : "三方应用ID", "example" : "2018********" }, "license_info" : { "$ref" : "#/components/schemas/AuditLicenseInfo" }, "mini_app_id" : { "type" : "string", "description" : "小程序ID，特殊场景专用，普通业务方无需关注该参数。", "example" : "2018********" }, "mini_category_ids" : { "type" : "string", "description" : "新小程序前台类目，格式为 第一个一级类目_第一个二级类目;第二个一级类目_第二个二级类目_第二个三级类目，详细类目可以通过 https://docs.open.alipay.com/api_49/alipay.open.mini.category.query接口查询mini_category_list，如果不填默认采用当前小程序应用类目。使用默认应用类目后不需要再次上传营业执照号、营业执照名、营业执照截图、营业执照有效期。使用后不再读取app_category_ids值，老前台类目将废弃", "example" : "XS1001_XS2001_XS3002;XS1011_XS2089;XS1002_XS2008_XS3024" }, "pid" : { "type" : "string", "description" : "小程序开发者ID，可不传，不传取基础信息中的小程序开发者ID", "example" : "2088********" }, "region_type" : { "type" : "string", "description" : "服务区域类型,可不传，不传取基础信息中的小程序服务区域类型", "example" : "GLOBAL" }, "screen_shot_list" : { "type" : "string", "description" : "版本截图，最少2张，最多5张，必传", "example" : "https://appstoreisvpic.alipayobjects.com/prod/e2bcf04b-da46-4b7f-a020-e9d224df7689.png,https://appstoreisvpic.alipayobjects.com/prod/e2bcf04b-da46-4b7f-a020-e9d224df7689.png" }, "service_phone" : { "type" : "string", "description" : "客服电话，可不传，不传取基础信息中的小程序客服电话", "example" : "021-2222222" }, "special_license_pic_list" : { "type" : "string", "description" : "特殊资质图片地址列表，逗号分割,", "example" : "https://appstoreisvpic.alipayobjects.com/prod/f2e32236-b537-405b-8764-613ea50c2f6b.png,https://appstoreisvpic.alipayobjects.com/prod/f2e32236-b537-405b-8764-613ea50c2f6b.png" }, "template_id" : { "type" : "string", "description" : "小程序模板ID", "example" : "2018********" }, "template_version" : { "type" : "string", "description" : "模板的版本号，如果不填写，则默认用模板当前最新的在架版本", "example" : "1.0.0" }, "version_desc" : { "type" : "string", "description" : "小程序版本描述，30-500个字符，一个中文占两个字符，一个英文或者数字占一个字符", "example" : "本版本新增了XXX功能，修复了XXXbug，解决了XXX问题，欢迎大家体验提出意见。" } } }, "AlipayOpenMiniInnerversionBuildauditSubmitResponseModel" : { "type" : "object" }, "AlipayOpenMiniInnerversionConditionBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "APPID_IS_BLANK", "VERSION_STATUS_LIST_IS_BLANK", "APP_ORIGIN_IS_BLANK", "BUNDLE_ID_IS_BLANK", "NO_PERMISSION", "INVALID_PAGE_NUM", "INVALID_PAGE_SIZE", "PAGE_NUM_LESS_ONE", "PAGE_SIZE_MORE_TEN", "PAGE_SIZE_LESS_ZERO", "INVALID_VERSION_STATUS", "MINICORE_INVOKE_ERROR", "PAGE_NUM_LESS_ZERO", "BUNDLE_ID_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionConditionBatchqueryModel" : { "type" : "object", "properties" : { "app_origin" : { "type" : "string", "description" : "业务来源", "example" : "AAA" }, "bundle_id" : { "type" : "string", "description" : "com.alipay.alipaywallet:支付宝，com.amap.app:高德", "example" : "com.alipay.alipaywallet" }, "mini_app_id" : { "type" : "string", "description" : "小程序ID，仅特殊场景使用，普通业务方无需关注该参数。", "example" : "2019*********" }, "page_num" : { "type" : "string", "description" : "页码", "example" : "1" }, "page_size" : { "type" : "string", "description" : "分页数", "example" : "10" }, "version_status" : { "type" : "string", "description" : "INIT:开发中，RELEASE:上架，OFFLINE:下架，AUDITING:审核中，AUDIT_REJECT:审核驳回，WAIT_RELEASE:待上架，GRAY:灰度中，以,号隔开", "example" : "INIT" } } }, "AlipayOpenMiniInnerversionConditionBatchqueryResponseModel" : { "type" : "object", "properties" : { "mini_version_base_info_list" : { "type" : "array", "description" : "小程序版本信息", "items" : { "$ref" : "#/components/schemas/MiniVersionBaseInfo" } } } }, "AlipayOpenMiniInnerversionContentRollbackErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "APP_ORIGIN_IS_BLANK", "APP_ORIGIN_NOT_EXIST", "BUNDLE_ID_NOT_EXIST", "BUNDLE_ID_IS_BLANK", "PID_IS_BLANK", "APPID_IS_BLANK" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionContentRollbackModel" : { "type" : "object", "properties" : { "app_origin" : { "type" : "string", "description" : "业务场景来源", "example" : "AAA" }, "app_version" : { "type" : "string", "description" : "小程序当前上架版本号", "example" : "1.0.0" }, "bundle_id" : { "type" : "string", "description" : "端", "example" : "com.alipay.alipaywallet" }, "mini_app_id" : { "type" : "string", "description" : "小程序ID，仅特殊场景使用，普通业务方无需关注该参数。", "example" : "2018********" }, "pid" : { "type" : "string", "description" : "小程序所属主体", "example" : "2088********" } } }, "AlipayOpenMiniInnerversionContentRollbackResponseModel" : { "type" : "object" }, "AlipayOpenMiniInnerversionGrayFinishErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "APP_VERSION_IS_BLANK", "APPLICATION_TYPE_NOT_MINIAPP", "MINI_APP_PACKAGE_INFO_NOT_EXIST", "CAN_NOT_END_GRAY_WITHOUT_GRAY", "MINI_APP_NOT_ONLINE", "NO_PERMISSION", "APP_ORIGIN_NOT_EXIST", "BUNDLE_ID_NOT_EXIST", "APP_INFO_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionGrayFinishModel" : { "type" : "object", "properties" : { "app_origin" : { "type" : "string", "description" : "业务来源", "example" : "AAA" }, "app_version" : { "type" : "string", "description" : "小程序版本", "example" : "0.0.1" }, "bundle_id" : { "type" : "string", "description" : "端信息", "example" : "支付宝：com.alipay.alipaywallet 高德：com.amap.app" }, "mini_app_id" : { "type" : "string", "description" : "小程序ID，仅特殊场景使用，普通业务方无需关注该参数", "example" : "2019****" }, "pid" : { "type" : "string", "description" : "小程序所属PID", "example" : "2088****" } } }, "AlipayOpenMiniInnerversionGrayFinishResponseModel" : { "type" : "object" }, "AlipayOpenMiniInnerversionGrayPublishErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "GRAY_ONLINE_FAILURE", "PARAMS_VALID_ERROR", "APP_INFO_NOT_EXISTS", "APP_VERSION_NOT_EXIST", "NO_PERMISSION", "APP_ORIGIN_NOT_EXIST", "BUNDLE_ID_NOT_EXIST", "CAN_NOT_GRAY_ALIBABA_PASS", "CAN_NOT_GRAY_WITHOUT_AUDIT_PASS", "PLUGIN_NOT_ALLOWED_GRAY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionGrayPublishModel" : { "type" : "object", "properties" : { "app_origin" : { "type" : "string", "description" : "业务来源", "example" : "AAA" }, "app_version" : { "type" : "string", "description" : "小程序版本", "example" : "0.0.1" }, "beta_app_id_list" : { "type" : "array", "description" : "待邀测应用列表，灰度插件时使用，如无邀测必要请不要传入", "items" : { "type" : "string" }, "example" : "[\"2021xxxxx\"]" }, "bundle_id" : { "type" : "string", "description" : "端信息", "example" : "支付宝：com.alipay.alipaywallet 高德：com.amap.app" }, "gray_strategy" : { "type" : "string", "description" : "灰度值", "example" : "gray_mayi_rule、gray_alibaba_rule" }, "mini_app_id" : { "type" : "string", "description" : "小程序ID，仅特殊场景使用，普通业务方无需关注该参数", "example" : "2019****" }, "pid" : { "type" : "string", "description" : "小程序所属PID", "example" : "2088****" } } }, "AlipayOpenMiniInnerversionGrayPublishResponseModel" : { "type" : "object" }, "AlipayOpenMiniInnerversionInfoDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "APPID_IS_BLANK", "PACKAGE_VERSION_IS_BLANK", "BUNDLE_ID_IS_BLANK", "PID_IS_BLANK", "BUNDLE_ID_NOT_EXIST", "VERSION_LENGTH_ERROR", "VERSION_EXCEEDED_LENGTH", "APP_ORIGIN_NOT_EXIST", "APP_INFO_NOT_EXIST", "APPLICATION_TYPE_NOT_MINIAPP", "MINI_APP_NOT_ONLINE", "SYSTEM_ERROR", "MINI_APP_PACKAGE_INFO_NOT_EXIST", "CAN_NOT_DELETE_WITH_SCANNING", "CAN_NOT_DELETE_WITH_EXPERIENCE", "CAN_NOT_DELETE_WITHOUT_DEV" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionInfoDeleteResponseModel" : { "type" : "object" }, "AlipayOpenMiniInnerversionInfoQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PARAMS_VALID_ERROR", "APP_ORIGIN_NOT_EXIST", "BUNDLE_ID_NOT_EXIST", "APP_INFO_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionInfoQueryResponseModel" : { "type" : "object", "properties" : { "app_version" : { "type" : "string", "description" : "版本号", "example" : "0.0.1" }, "build_source" : { "type" : "string", "description" : "版本构建类型", "example" : "01 自创建 02 模板构建" }, "bundle_id" : { "type" : "string", "description" : "端信息", "example" : "支付宝：com.alipay.alipaywallet 高德：com.amap.app" }, "create_time" : { "type" : "string", "description" : "版本创建时间", "example" : "2019-01-01 12:00:22" }, "description" : { "type" : "string", "description" : "版本描述", "example" : "我是小程序版本描述" }, "ext_json" : { "type" : "string", "description" : "实例化模板参数", "example" : "{}" }, "gmt_modified" : { "type" : "string", "description" : "版本更新时间", "example" : "2019-01-01 12:12:12" }, "gray_start_time" : { "type" : "string", "description" : "版本灰度时间", "example" : "2019-01-01 12:00:22" }, "gray_strategy" : { "type" : "string", "description" : "小程序灰度比例值", "example" : "p10-10%的用户，p30-30%的用户，p50-50%的用户" }, "mini_app_id" : { "type" : "string", "description" : "小程序ID", "example" : "2019****" }, "offline_time" : { "type" : "string", "description" : "版本下架时间", "example" : "2019-01-01 12:00:22" }, "package_url" : { "type" : "string", "description" : "包地址", "example" : "http://alipay-offline.cn-hangzhou.alipay.aliyun-inc.com/pkgcore/pMugqXnuGsXecwEvlsuQ.amr" }, "plugin_refs" : { "type" : "array", "description" : "引用插件信息", "items" : { "$ref" : "#/components/schemas/MiniAppPluginInfo" } }, "process_task_id" : { "type" : "string", "description" : "流程id", "example" : "123" }, "reject_reason" : { "type" : "string", "description" : "审核失败原因", "example" : "名称过于宽泛" }, "rollback_time" : { "type" : "string", "description" : "版本回滚时间", "example" : "2019-01-01 12:00:22" }, "scan_result" : { "type" : "string", "description" : "安全扫描结果", "example" : "True" }, "screen_shot_list" : { "type" : "string", "description" : "小程序版本截图，多个截图以逗号隔开", "example" : "http://image.aaa.alipay.com" }, "shelf_time" : { "type" : "string", "description" : "版本上架时间", "example" : "2019-01-01 12:00:22" }, "source_url" : { "type" : "string", "description" : "源码包地址", "example" : "http://alipay-offline.cn-hangzhou.alipay.aliyun-inc.com/pkgcore/pMugqXnuGsXecwEvlsuQ.amr" }, "status" : { "type" : "string", "description" : "版本状态", "example" : "小程序版本状态，INIT-开发中，AUDITING-审核中，WAIT_RELEASE-审核通过，AUDIT_REJECT-审核驳回，RELEASE-已上架，GRAY-灰度中，OFFLINE-下架" }, "template_extra" : { "type" : "string", "description" : "模板构建参数", "example" : "{\"tinycliversion\":\"1.1.1\"}" }, "template_version" : { "type" : "string", "description" : "模板版本号", "example" : "0.0.1" } } }, "AlipayOpenMiniInnerversionInstantiationQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "APPID_IS_BLANK", "BUNDLE_ID_IS_BLANK", "MINI_APP_VERSION_IS_BLANK", "VERSION_LENGTH_ERROR", "VERSION_EXCEEDED_LENGTH", "APP_ORIGIN_NOT_EXIST", "APP_INFO_NOT_EXIST", "SUB_APPLICATION_TYPE_ERROR", "APPLICATION_TYPE_NOT_MINIAPP" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionInstantiationQueryResponseModel" : { "type" : "object", "properties" : { "app_version" : { "type" : "string", "description" : "小程序版本号", "example" : "0.0.1" }, "bundle_id" : { "type" : "string", "description" : "端id", "example" : "com.alipay.alipaywallet" }, "mini_app_id" : { "type" : "string", "description" : "小程序appId", "example" : "2021000116680014" }, "template_id" : { "type" : "string", "description" : "模板id", "example" : "2019042861090647" }, "template_version" : { "type" : "string", "description" : "模板的版本号", "example" : "0.0.3" } } }, "AlipayOpenMiniInnerversionLastQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "MINICORE_INVOKE_ERROR", "OPENCORE_RPC_INVOKE_ERROR", "APP_ORIGIN_IS_BLANK", "APP_ORIGIN_NOT_EXIST", "BUNDLE_ID_NOT_EXIST", "BUNDLE_ID_IS_BLANK", "PID_IS_BLANK", "APPID_IS_BLANK" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionLastQueryResponseModel" : { "type" : "object", "properties" : { "app_desc" : { "type" : "string", "description" : "小程序应用描述", "example" : "小程序官方示例Demo，展示已支持的接口能力及组件" }, "app_name" : { "type" : "string", "description" : "小程序的名称", "example" : "小程序名称" }, "app_version" : { "type" : "string", "description" : "版本号", "example" : "1.0.1" }, "bundle_id" : { "type" : "string", "description" : "端信息", "example" : "支付宝：com.alipay.alipaywallet 高德：com.amap.app" }, "category_ids" : { "type" : "string", "description" : "小程序所属类目", "example" : "107209_107226" }, "english_name" : { "type" : "string", "description" : "小程序英文名称", "example" : "xiaochengxu" }, "logo_url" : { "type" : "string", "description" : "小程序应用logo图标", "example" : "https://appstoreisvpic.alipayobjects.com/prod/04843e84-f1fd-4717-a230-1c72de99aa5d.png" }, "mini_app_id" : { "type" : "string", "description" : "小程序ID", "example" : "2018********" }, "service_phone" : { "type" : "string", "description" : "小程序客服电话", "example" : "13110101010" }, "slogan" : { "type" : "string", "description" : "小程序应用简介，一句话描述小程序功能", "example" : "提供小程序示例功能" }, "status" : { "type" : "string", "description" : "版本状态", "example" : "INIT" }, "sub_application_type" : { "type" : "string", "description" : "小程序子类型，自研、模板类型", "example" : "TINY_NORMAL" } } }, "AlipayOpenMiniInnerversionModelforofflineQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionModelforofflineQueryResponseModel" : { "type" : "object", "properties" : { "model_json" : { "type" : "string", "description" : "线上版本包数据", "example" : "{}" }, "sync_id" : { "type" : "string", "description" : "同步ID，同步失败时便于去线上追溯", "example" : "abcasdasda1217893189389asdasda98" } } }, "AlipayOpenMiniInnerversionNobuildUploadErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "DEV_VERSION_EXCEED_MAX_COUNT", "APP_NOT_EXSIT", "VERSION_EXCEEDED_LENGTH", "PACKAGE_VERSION_IS_BLANK", "BUILD_VERSION_ALREADY_EXIST", "BIZ_ERROR", "PLUGIN_REF_OVER_LIMIT", "DATA_DUPLICATE_WITH_BUILD", "APP_INFO_NOT_EXIST", "PLUGIN_NOT_EXIST", "PLUGIN_PACKAGE_NOT_FOUND", "PACKAGE_SIZE_IS_BLANK", "SUB_PACKAGE_PARAM_EXIST_EMPTY", "BUILD_VERSION_COMPARE_ERROR", "START_BUILD_ERROR", "BUNDLE_ID_NOT_EXIST", "INVALID_PARAMS", "PACKAGE_URL_IS_BLANK" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionNobuildUploadModel" : { "type" : "object", "properties" : { "build_extra_info" : { "type" : "string", "description" : "扩展信息，比如adaptorName、tinycliVersion、tinycliName、import-module、allowPrecompile、extJson、allowInstallDependency、aggregationMainAppId，如果没有特殊要求，tinycliVersion版本请用最新的： https://registry.npm.alibaba-inc.com/@alipay/tiny-cli/huoban-prod", "example" : "{\"tinycliVersion\":\"1.5.20200213201649\"}" }, "build_js_permission" : { "type" : "string", "description" : "jsapi权限文件", "example" : "{\"permissionJSON\":[1, 2, 3, 4, 5]}" }, "build_main_url" : { "type" : "string", "description" : "小程序页面主入口。/index.html#page/component/index，该值需要和extendInfo中的page参数保持一致", "example" : "/index.html#page/component/index" }, "build_qcloud_info" : { "type" : "string", "description" : "打包平台扩展信息", "example" : "{\"launchParams\":{\"enableTabBar\":\"YES\",\"enableJSC\":\"YES\",\"page\":\"page/component/index\",\"enableKeepAlive\":\"YES\",\"enableWK\":\"YES\"}}" }, "build_version" : { "type" : "string", "description" : "小程序版本", "example" : "0.0.1" }, "builded_package_size" : { "type" : "string", "description" : "已经构建过的amr包大小，单位是字节，建议如实填写", "example" : "20" }, "builded_package_url" : { "type" : "string", "description" : "已经构建的包地址，目前主要自行构建的场景使用", "example" : "产物包地址" }, "builded_plugin_size" : { "type" : "string", "description" : "构建好的插件包amr大小", "example" : "100" }, "builded_plugin_url" : { "type" : "string", "description" : "构建好的插件包地址", "example" : "构建好的插件包地址" }, "bundle_id" : { "type" : "string", "description" : "一个端的标识，用于区分不同的客户端，每接入一个客户端，都需要向小程序应用中心申请bundleId入驻", "example" : "com.alipay.alipaywallet" }, "components" : { "type" : "string", "description" : "组件参数", "example" : "{}" }, "inst_code" : { "type" : "string", "description" : "上传调试版的接入租户类型", "example" : "taobao" }, "mini_app_id" : { "type" : "string", "description" : "小程序id", "example" : "2017122101357757" }, "new_builded_package_size" : { "type" : "string", "description" : "2.0已经构建过的amr包大小，单位是字节，主要是给自行构建的场景使用", "example" : "100" }, "new_builded_package_url" : { "type" : "string", "description" : "2.0产物包地址", "example" : "2.0产物包地址" }, "new_builded_plugin_size" : { "type" : "string", "description" : "构建好的插件包amr大小", "example" : "100" }, "new_builded_plugin_url" : { "type" : "string", "description" : "构建好的插件包地址", "example" : "构建好的插件包地址" }, "no_sign" : { "type" : "boolean", "description" : "否免加签, true的时候代表传过来的是加签后的包地址", "example" : "true" }, "plugin_refs" : { "type" : "array", "description" : "小程序代码中引用的插件列表，包含插件id和插件版本信息，业务方需要自行解析源码包的app.json里面的plugins信息", "items" : { "$ref" : "#/components/schemas/MiniAppPluginReference" } }, "sub_packages" : { "type" : "array", "description" : "构建好的分包信息", "items" : { "$ref" : "#/components/schemas/SubPackageInfo" } } } }, "AlipayOpenMiniInnerversionNobuildUploadResponseModel" : { "type" : "object" }, "AlipayOpenMiniInnerversionOfflinePublishErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "APP_VERSION_IS_BLANK", "APPLICATION_TYPE_NOT_MINIAPP", "MINI_APP_PACKAGE_INFO_NOT_EXIST", "MINI_APP_NOT_ONLINE", "NO_PERMISSION", "APP_ORIGIN_NOT_EXIST", "BUNDLE_ID_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionOfflinePublishModel" : { "type" : "object", "properties" : { "app_origin" : { "type" : "string", "description" : "业务来源", "example" : "AAA" }, "app_version" : { "type" : "string", "description" : "版本号", "example" : "0.0.1" }, "bundle_id" : { "type" : "string", "description" : "端信息", "example" : "支付宝：com.alipay.alipaywallet 高德：com.amap.app" }, "mini_app_id" : { "type" : "string", "description" : "小程序ID，仅特殊场景使用，普通业务方无需关注该参数", "example" : "2019****" }, "pid" : { "type" : "string", "description" : "小程序所属PID", "example" : "2088*****" } } }, "AlipayOpenMiniInnerversionOfflinePublishResponseModel" : { "type" : "object" }, "AlipayOpenMiniInnerversionOnlineErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "ONLINE_FAILURE", "PARAMS_VALID_ERROR", "MINI_APP_VERSION_NOT_EXISTS", "MINI_APP_VERSION_STATUS_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionOnlineModel" : { "type" : "object", "properties" : { "app_offline_version" : { "type" : "string", "description" : "下架版本", "example" : "0.0.5" }, "app_online_version" : { "type" : "string", "description" : "上架版本", "example" : "0.0.6" }, "app_origin" : { "type" : "string", "description" : "业务来源", "example" : "ASTORE" }, "bundle_id" : { "type" : "string", "description" : "一个端的标识，用于区分不同的客户端，每接入一个客户端，都需要向小程序应用中心申请bundelId入驻", "example" : "com.alipay.alipaywallet" }, "inst_code" : { "type" : "string", "description" : "租户code，alipay or taobao", "example" : "taobao" }, "mini_app_id" : { "type" : "string", "description" : "小程序ID", "example" : "2018012201365222" } } }, "AlipayOpenMiniInnerversionOnlinePublishErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "APP_VERSION_IS_BLANK", "APPLICATION_TYPE_NOT_MINIAPP", "MINI_APP_PACKAGE_INFO_NOT_EXIST", "CAN_NOT_ONLINE_WITHOUT_GRAY", "MINI_APP_NOT_ONLINE", "NO_PERMISSION", "APP_ORIGIN_NOT_EXIST", "BUNDLE_ID_NOT_EXIST", "CAN_NOT_ONLINE_WITHOUT_AUDIT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionOnlinePublishModel" : { "type" : "object", "properties" : { "app_origin" : { "type" : "string", "description" : "业务来源", "example" : "AAA" }, "app_version" : { "type" : "string", "description" : "小程序版本", "example" : "0.0.1" }, "bundle_id" : { "type" : "string", "description" : "端信息", "example" : "支付宝：com.alipay.alipaywallet 高德：com.amap.app" }, "downgrade" : { "type" : "boolean", "description" : "否服务降级，如果降级，拉包策略如果端上有本地包，则使用本地包打开，同时异步下载新包，待下次打开则使用新包", "example" : "true" }, "mini_app_id" : { "type" : "string", "description" : "小程序ID，仅特殊场景使用，普通业务方无需关注该参数", "example" : "2019*****" }, "pid" : { "type" : "string", "description" : "小程序所属PID", "example" : "2088****" }, "release_type" : { "type" : "string", "description" : "normal默认普通发布，high 高保发布", "example" : "normal/high" } } }, "AlipayOpenMiniInnerversionOnlinePublishResponseModel" : { "type" : "object" }, "AlipayOpenMiniInnerversionOnlineResponseModel" : { "type" : "object" }, "AlipayOpenMiniInnerversionPackageCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PACKAGE_TYPE_NOT_EXIST", "PARAMS_VALID_ERROR", "APP_INFO_NOT_EXIST", "APPLICATION_TYPE_NOT_MINIAPP", "MINI_APP_NOT_ONLINE", "NO_PERMISSION", "PACKAGE_VERSION_IS_BLANK", "VERSION_LENGTH_ERROR", "VERSION_EXCEEDED_LENGTH", "BUNDLE_ID_NOT_EXIST", "INVALID_PARAMS_WARN", "MINI_APP_VERSION_NOT_EXIST", "APP_ORIGIN_IS_BLANK", "APP_ORIGIN_NOT_EXIST", "APP_IS_NOT_HUOBAN", "APP_IS_BUILD_BY_TEMPLATE", "MINI_APP_VERSION_NOT_INIT", "BUNDLE_ID_IS_BLANK", "NOT_CREATE_COVERAGE_NOT_ALIPAY", "APP_IS_NOT_INNER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionPackageCreateModel" : { "type" : "object", "properties" : { "app_origin" : { "type" : "string", "description" : "业务来源", "example" : "AAA" }, "app_version" : { "type" : "string", "description" : "小程序版本", "example" : "0.0.1" }, "bundle_id" : { "type" : "string", "description" : "端信息", "example" : "支付宝：com.alipay.alipaywallet 高德：com.amap.app" }, "mini_app_id" : { "type" : "string", "description" : "小程序ID，仅特殊场景使用，普通业务方无需关注该参数。", "example" : "2019****" }, "package_type" : { "type" : "string", "description" : "打包类型。预发包和覆盖率包", "example" : "PRE_ONLINE" }, "pid" : { "type" : "string", "description" : "pid. 伙伴链路（app_origin='HUOBAN'）时必填", "example" : "2019****" } } }, "AlipayOpenMiniInnerversionPackageCreateResponseModel" : { "type" : "object" }, "AlipayOpenMiniInnerversionSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "APP_INFO_NOT_EXIST", "APPLICATION_TYPE_NOT_MINIAPP", "MINI_APP_NOT_ONLINE", "APP_ORIGIN_IS_BLANK", "APP_ORIGIN_NOT_EXIST", "SYNC_TYPE_IS_BLANK", "SYNC_TYPE_NOT_EXIST", "BUNDLE_ID_IS_BLANK", "BUNDLE_ID_NOT_EXIST", "BUNDLE_ID_NOT_IN_SYNC", "SYNC_WITHOUT_ONLINE_ERROR", "PKGCORE_INVOKE_ERROR", "SYSTEM_ERROR", "MINICORE_INVOKE_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionSyncModel" : { "type" : "object", "properties" : { "app_origin" : { "type" : "string", "description" : "业务参数来源", "example" : "AAA" }, "app_version" : { "type" : "string", "description" : "推送的小程序版本号", "example" : "1.0.0" }, "bundle_id" : { "type" : "string", "description" : "端信息", "example" : "com.alipay.alipaywallet" }, "dev_id" : { "type" : "string", "description" : "操作人ID", "example" : "2088******" }, "mini_app_id" : { "type" : "string", "description" : "小程序ID，仅特殊场景使用，普通业务方无需关注该参数。", "example" : "2019*******" }, "sync_type" : { "type" : "string", "description" : "同送方式", "example" : "global：全量，recent：定向" } } }, "AlipayOpenMiniInnerversionSyncResponseModel" : { "type" : "object" }, "AlipayOpenMiniInnerversionTemplatedUploadErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "APP_VERSION_IS_BLANK", "TEMPLATE_ID_IS_BLANK", "VERSION_HAS_EXISTED", "LARGER_VERSION_HAS_EXISTED", "APPLICATION_TYPE_NOT_MINIAPP", "INVALID_VERSION", "DEV_VERSION_EXCEED_MAX_COUNT", "TEMPLATE_NOT_ONLINE_OR_OFFLINE", "MINI_APP_PACKAGE_INFO_NOT_EXIST", "TEMPLATE_MINIAPP_NOT_ALLOWED", "VERSION_EXCEEDED_LENGTH", "INVALID_EXT_JSON", "TEMPLATE_ID_ISVAPPID_NOT_MATCH", "NO_AUTH_RELATION" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionTemplatedUploadModel" : { "type" : "object", "properties" : { "app_origin" : { "type" : "string", "description" : "来源类型，新接入方需要向支付宝申请专用来源，否则不予接入。", "example" : "AAA" }, "app_version" : { "type" : "string", "description" : "格式为: x.y.z，其中x、y、z均为整型数字，版本不能重复构建，且新版本号必须高于旧版本", "example" : "0.0.1" }, "bundle_id" : { "type" : "string", "description" : "端id", "example" : "com.alipay.alipaywallet" }, "ext" : { "type" : "string", "description" : "模板的配置参数，完整内容请参见：https://docs.alipay.com/mini/isv/ortga1", "example" : "{\"extEnable\": true, \"extPages\": {\"pages/face/index\": {\"defaultTitle\": \"默认页面标题\"}},\"window\": {\"defaultTitle\": \"默认标题\"}}" }, "mini_app_id" : { "type" : "string", "description" : "小程序ID，特殊场景专用，普通业务方无需关注该参数。", "example" : "2019051464523527" }, "template_id" : { "type" : "string", "description" : "模板id，模板必须已经处于上架/下架状态", "example" : "2019032163637014" }, "template_version" : { "type" : "string", "description" : "模板版本，必须处于上架/下架状态。如果为空，默认取当前在架，或者最新下架的版本。", "example" : "0.0.1" } } }, "AlipayOpenMiniInnerversionTemplatedUploadResponseModel" : { "type" : "object" }, "AlipayOpenMiniInnerversionUpgradeErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMS", "TEMPLATE_NOT_ONLINE_OR_OFFLINE", "MINI_APP_AUDITING", "TEMPLATE_VERSION_NOT_EXIST", "CAN_NOT_BATCH_UPGRADE_WITHOUT_ONLINE_OR_OFFLINE", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionUpgradeModel" : { "type" : "object", "properties" : { "app_origin" : { "type" : "string", "description" : "来源类型，新接入方需要向支付宝申请专用来源，否则不予接入。", "example" : "AAA" }, "bundle_id" : { "type" : "string", "description" : "端ID，多端场景下区分不同端", "example" : "com.alipay.alipaywallet" }, "mini_app_id" : { "type" : "string", "description" : "小程序ID，特殊场景专用，普通业务方无需关注该参数。", "example" : "2019032163637016" }, "template_id" : { "type" : "string", "description" : "用于升级的模板id", "example" : "2019032163637014" }, "template_version" : { "type" : "string", "description" : "用于升级的模板版本号，版本号必须满足 x.y.z, 且均为数字", "example" : "0.0.3" } } }, "AlipayOpenMiniInnerversionUpgradeResponseModel" : { "type" : "object" }, "AlipayOpenMiniInnerversionUploadErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "DEV_VERSION_EXCEED_MAX_COUNT", "APP_NOT_EXSIT", "START_BUILD_ERROR", "BUILD_DATA_ERROR", "VERSION_EXCEEDED_LENGTH", "PACKAGE_VERSION_IS_BLANK", "CLIENT_VERSION_HAS_NULL", "MIN_CLIENT_VERSION_GREATER_THAN_", "INVALID_MAX_CLIENT_VERSION", "INVALID_CLIENT_VERSION", "BUILD_VERSION_ALREADY_EXIST", "BIZ_ERROR", "PLUGIN_REF_OVER_LIMIT", "DATA_DUPLICATE_WITH_BUILD", "PLUGIN__NOT_ORDERED", "APP_INFO_NOT_EXIST", "PLUGIN_NOT_EXIST", "PLUGIN_PACKAGE_NOT_FOUND" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionUploadModel" : { "type" : "object", "properties" : { "app_origin" : { "type" : "string", "description" : "业务来源，新接入方需要向支付宝申请专用来源，否则不予接入。https://yuque.antfin-inc.com/tinyapp-all/qddncu/bidushixiang", "example" : "https://yuque.antfin-inc.com/tinyapp-all/qddncu/bidushixiang" }, "build_app_type" : { "type" : "string", "description" : "IDE开发打包类型，写死tinyApp", "example" : "tinyApp" }, "build_extra_info" : { "type" : "string", "description" : "扩展信息，比如adaptorName、tinycliVersion、tinycliName、import-module、allowPrecompile、extJson、allowInstallDependency、aggregationMainAppId，如果没有特殊要求，tinycliVersion版本请用最新的：\thttps://registry.npm.alibaba-inc.com/@alipay/tiny-cli/huoban-prod", "example" : "{\"tinycliVersion\":\"1.5.20200213201649\"}" }, "build_extra_mini_project_config" : { "type" : "string", "description" : "用于覆盖开发者配置字段，实现止血和灰度逻辑", "example" : "{\"enableAppxNg\":\"YES\"}" }, "build_js_permission" : { "type" : "string", "description" : "jsapi 权限文件,钉钉外请勿传", "example" : "{\"permissionJSON\":[1, 2, 3, 4, 5]}" }, "build_main_url" : { "type" : "string", "description" : "小程序页面主入口。/index.html#page/component/index，该值需要和extendInfo中的page参数保持一致", "example" : "/index.html#page/component/index" }, "build_max_android_client_version" : { "type" : "string", "description" : "最大Android客户端版本号，禁止使用，如果需要使用请联系小程序平台评估，否则端上会出现问题", "example" : "100.0.0" }, "build_max_ios_client_version" : { "type" : "string", "description" : "最大iOS客户单版本号，禁止使用，如果需要使用请联系小程序平台评估，否则端上会出现问题", "example" : "100.0.0" }, "build_min_android_client_version" : { "type" : "string", "description" : "最小Android客户端版本号，禁止使用，如果需要使用请联系小程序平台评估，否则端上会出现问题", "example" : "10.1.35" }, "build_min_ios_client_version" : { "type" : "string", "description" : "最小iOS客户单版本号，禁止使用，如果需要使用请联系小程序平台评估，否则端上会出现问题", "example" : "10.1.35" }, "build_package_md_5" : { "type" : "string", "description" : "源码包文件流的MD5字符串", "example" : "源码包" }, "build_package_name" : { "type" : "string", "description" : "包名称", "example" : "dist.amr" }, "build_package_stream" : { "type" : "string", "description" : "base64编码后的小程序源码包文件流", "example" : "小程序源码包" }, "build_qcloud_info" : { "type" : "string", "description" : "打包平台扩展信息", "example" : "{\"launchParams\":{\"enableTabBar\":\"YES\",\"enableJSC\":\"YES\",\"page\":\"page/component/index\",\"enableKeepAlive\":\"YES\",\"enableWK\":\"YES\"}}" }, "build_signed_pkg_url" : { "type" : "string", "description" : "已经构建加签过的包地址", "example" : "已经构建加签过的包地址" }, "build_source_pkg_size" : { "type" : "string", "description" : "源码包大小", "example" : "10000" }, "build_source_pkg_url" : { "type" : "string", "description" : "源码包地址，源码包大小不能超过20M且地址必须永久有效，若超20M，将限制业务来源调用。将源码文件夹整个用zip格式压缩成后缀amr文件传至文件服务器", "example" : "http://alipay-offline.cn-hangzhou.alipay.aliyun-inc.com/pkgcore/DMDjCdOCtERoGgyrJZzq.amr" }, "build_sub_url" : { "type" : "string", "description" : "子入口", "example" : "/index.html#pages/todos/todos" }, "build_version" : { "type" : "string", "description" : "小程序版本", "example" : "0.0.1" }, "builded_package_size" : { "type" : "string", "description" : "已经构建过的包大小，单位是字节，主要是给自行构建的场景使用", "example" : "10000" }, "builded_package_url" : { "type" : "string", "description" : "已经构建的包地址，目前主要自行构建的场景使用", "example" : "已经构建的包地址" }, "bundle_id" : { "type" : "string", "description" : "一个端的标识，用于区分不同的客户端，每接入一个客户端，都需要向小程序应用中心申请bundleId入驻", "example" : "com.alipay.alipaywallet" }, "client_type" : { "type" : "string", "description" : "多端类型，除了钉钉外其他业务方禁止使用", "example" : "DINGDING" }, "inst_code" : { "type" : "string", "description" : "上传调试版的接入租户类型。", "example" : "taobao" }, "mini_app_id" : { "type" : "string", "description" : "小程序ID", "example" : "2017122101357757" }, "plugin_refs" : { "type" : "array", "description" : "小程序代码中引用的插件列表，包含插件id和插件版本信息，业务方需要自行解析源码包的app.json里面的plugins信息", "items" : { "$ref" : "#/components/schemas/MiniAppPluginReference" } } } }, "AlipayOpenMiniInnerversionUploadResponseModel" : { "type" : "object", "properties" : { "build_info" : { "type" : "string", "description" : "构建信息", "example" : "构建信息" }, "build_package_url" : { "type" : "string", "description" : "包地址", "example" : "http://alipay-rmsdeploy-image.cn-hangzhou.alipay.aliyun-inc.com/qcloud/build-target-c1d90a3bcf354803ad01b28cdccd83a4.tar" }, "build_status" : { "type" : "string", "description" : "构建状态", "example" : "构建状态" }, "build_version" : { "type" : "string", "description" : "构建版本", "example" : "0.0.5" }, "need_rotation" : { "type" : "string", "description" : "是否需要轮询", "example" : "TRUE" }, "new_build_package_url" : { "type" : "string", "description" : "appx构建返回值", "example" : "http://alipay-rmsdeploy-image.cn-hangzhou.alipay.aliyun-inc.com/qcloud/build-target-c1d90a3bcf354803ad01b28cdccd83a4.tar" }, "package_id" : { "type" : "string", "description" : "包管理包ID", "example" : "34845" }, "version_created" : { "type" : "string", "description" : "版本创建结果", "example" : "TRUE" } } }, "AlipayOpenMiniInnerversionUploadstatusQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "POLLING_BUILD_VERSION_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniInnerversionUploadstatusQueryResponseModel" : { "type" : "object", "properties" : { "build_info" : { "type" : "string", "description" : "构建信息", "example" : "构建信息" }, "build_package_url" : { "type" : "string", "description" : "构建好的包地址", "example" : "http://alipay-rmsdeploy-image.cn-hangzhou.alipay.aliyun-inc.com/qcloud/build-target-c1d90a3bcf354803ad01b28cdccd83a4.tar" }, "build_status" : { "type" : "string", "description" : "构建状态", "example" : "构建状态" }, "log_url" : { "type" : "string", "description" : "构建日志地址", "example" : "https://tfapi.alipay.com/logs/5c1ac74d0c5e1d85b8c618dd" }, "need_rotation" : { "type" : "string", "description" : "是否需要轮询", "example" : "TRUE" }, "new_build_package_url" : { "type" : "string", "description" : "构建好的appx2.0包地址", "example" : "http://alipay-rmsdeploy-image.cn-hangzhou.alipay.aliyun-inc.com/qcloud/build-target-c1d90a3bcf354803ad01b28cdccd83a4.tar" }, "new_result_url" : { "type" : "string", "description" : "构建的结果地址", "example" : "https://tfapi.alipay.com/logs/5c1ac75f4b6ce5884ced6f00" }, "result_url" : { "type" : "string", "description" : "构建的结果地址", "example" : "https://tfapi.alipay.com/logs/5c1ac75f4b6ce5884ced6f00" }, "version_created" : { "type" : "string", "description" : "创建版本结果", "example" : "TRUE" } } }, "AlipayOpenMiniIsvCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMS", "SYSTEM_ERROR", "ONGOING_ORDER_EXIST", "DAILY_REJECT_EXCEEDS", "PROVIDER_ROLE_INVALID", "APP_NAME_DUPLICATED", "CERTIFICATE_INVALID", "PERMISSION_DENIED", "REJECT_COUNTS_EXCEEDS", "NOT_UNIQUE", "OPERATION_INVALID", "HAS_RISK", "ORDER_FINISHED", "INVALID_MINI_APP_NAME_LENGTH", "PARAM_INVALID" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniIsvCreateModel" : { "type" : "object", "properties" : { "create_mini_request" : { "$ref" : "#/components/schemas/CreateMiniRequest" } } }, "AlipayOpenMiniIsvCreateResponseModel" : { "type" : "object", "properties" : { "order_no" : { "type" : "string", "description" : "小程序代创建订单号", "example" : "2387429847238743" } } }, "AlipayOpenMiniIsvFastregisterCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_MINI_APP_NAME_LENGTH", "ILLEGAL_PARAMS", "PRECREATE_MINI_ERROR", "OPENCORE_APP_NAME_EXIST", "PROVIDER_ROLE_INVALID", "SYSTEM_ERROR", "OPENID_QUERY_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniIsvFastregisterCreateModel" : { "type" : "object", "properties" : { "app_name" : { "type" : "string", "description" : "小程序名称，昵称半自动设定，强制后缀“的试用小程序”。且该参数会进行关键字检查，如果命中品牌关键字则会报错。\t如遇到品牌大客户要用试用小程序，建议用户先换个名字，认证后再修改成品牌名。", "example" : "张三的小程序" }, "auth_notify_url" : { "type" : "string", "description" : "授权确认成功后回调h5链接或小程序页面", "example" : "pages/notify/index" }, "out_order_no" : { "type" : "string", "description" : "外部订单号", "example" : "202132131232131231231231231" }, "uid" : { "type" : "string", "description" : "商户2088", "example" : "20881232424234234234234" } } }, "AlipayOpenMiniIsvFastregisterCreateResponseModel" : { "type" : "object", "properties" : { "authorize_url" : { "type" : "string", "description" : "授权确认跳转url", "example" : "alipays://xxxxxxxxxxxxxxxx" }, "order_no" : { "type" : "string", "description" : "代创建试用小程序单号", "example" : "2022120716532186600070121" } } }, "AlipayOpenMiniIsvFastregisterQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "NO_PERMISSION", "ILLEGAL_PARAMS", "SYSTEM_ERROR", "ORDER_NOT_EXIST", "ORDER_TYPE_NOT_MATCH" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniIsvFastregisterQueryResponseModel" : { "type" : "object", "properties" : { "app_name" : { "type" : "string", "description" : "小程序应用名", "example" : "张三的试用小程序" }, "isv_app_id" : { "type" : "string", "description" : "appid", "example" : "202212121324324343" }, "mini_app_id" : { "type" : "string", "description" : "小程序appid", "example" : "20212323243534535" }, "order_no" : { "type" : "string", "description" : "代创建试用小程序单号", "example" : "2202324344343435353" }, "out_order_no" : { "type" : "string", "description" : "商户传入的外部订单号", "example" : "23948392483253534535" }, "status" : { "type" : "string", "description" : "WAIT_CONFIRM待确认创建，\tCONFIRM_TIMEOUT待创建确认授权超时，\tCREATE_MINI_APP_SUCCESS创建应用成功，CREATE_MINI_APP_FAILED创建应用失败，CANCELLED已注销，CERTIFY_SUCCESS认证成功，CERTIFY_FAILED认证失败，CERTIFY_OPERATOR管理员认证中，CERTIFY_MERCHANT法人认证中", "example" : "WAIT_CONFIRM" } } }, "AlipayOpenMiniIsvQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMS", "SYSTEM_ERROR", "PERMISSION_DENIED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniIsvQueryResponseModel" : { "type" : "object", "properties" : { "min_app_id" : { "type" : "string", "description" : "小程序appId，商家确认后非空，若商家未确认或超时返回空", "example" : "20218324729872" }, "order_no" : { "type" : "string", "description" : "订单号", "example" : "239238834234344" }, "out_order_no" : { "type" : "string", "description" : "外部订单号，开发者帐号+外部订单号维度来控制请求务幂等", "example" : "23948392483253534535" }, "pid" : { "type" : "string", "description" : "商户pid", "example" : "2088002306330746" }, "status" : { "type" : "string", "description" : "PROCESS处理中，TIMEOUT超时，AGREED同意， REJECTED拒绝", "example" : "PROCESS" } } }, "AlipayOpenMiniMiniappBrandCancelErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniMiniappBrandCancelResponseModel" : { "type" : "object" }, "AlipayOpenMiniMiniappBrandQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniMiniappBrandQueryResponseModel" : { "type" : "object", "properties" : { "merchant_brand_list_result" : { "$ref" : "#/components/schemas/MerchantBrandListResult" }, "miniapp_brand_audit_result" : { "$ref" : "#/components/schemas/MiniappBrandAuditResult" } } }, "AlipayOpenMiniMiniappBrandSubmitErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniMiniappBrandSubmitModel" : { "type" : "object", "properties" : { "apply_type" : { "type" : "string", "description" : "申请的资质类型\tSELF_BRAND_APPLY 自有品牌申请(当需要一个新的品牌时选择此项)\tAUTHORIZE_BRAND_APPLY 授权品牌申请(当需要授权一个已有的品牌给商户时选择此项)\tEXIST_BRAND_BIND 品牌绑定，适用于品牌已申请成功的情况(当需要将已有品牌绑定到无品牌小程序时选择此项)", "example" : "AUTHORIZE_BRAND_APPLY" }, "authorize_info" : { "$ref" : "#/components/schemas/AuthorizeInfo" }, "brand_id" : { "type" : "string", "description" : "商户已有品牌Id(只有申请的资质类型为EXIST_BRAND_BIND 时需要填写)", "example" : "brand2020091614782813" }, "brand_name" : { "type" : "string", "description" : "品牌名称", "example" : "CR7合作" }, "brand_registration_info" : { "$ref" : "#/components/schemas/BrandRegistrationInfo" }, "id_materials" : { "type" : "array", "description" : "申请人身份证明材料(当前只支持图片类型，请调用alipay.open.mini.miniapp.brand.upload接口上传图片，可以上传多个身份证明材料)", "items" : { "type" : "string" }, "example" : "[\"ua2qD53TRpyfX-UYYin6sQAAACMAAQED\",\"ua2qD53TRpyfX-UYYin6sQAAACMAAQED\"]" } } }, "AlipayOpenMiniMiniappBrandSubmitResponseModel" : { "type" : "object" }, "AlipayOpenMiniMiniappBrandUploadErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniMiniappBrandUploadModel" : { "type" : "object" }, "AlipayOpenMiniMiniappBrandUploadResponseModel" : { "type" : "object", "properties" : { "file_key" : { "type" : "string", "description" : "图片上传成功后的图片存储键(可用于填写调用alipay.open.mini.miniapp.brand.submit时需要的图片类型的字段)", "example" : "A*BTRVJSTHEBRE784685" } } }, "AlipayOpenMiniMiniappServiceconfigModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "BIZ_ERROR", "INVALID_PARAMETER", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniMiniappServiceconfigModifyModel" : { "type" : "object", "properties" : { "home_open" : { "type" : "boolean", "description" : "云客服是否在小程序首页透出，true-开启，false-不开启", "example" : "true" }, "service_config" : { "type" : "string", "description" : "客服方式，目前支持ANTCLOUD-云客服", "example" : "ANTCLOUD" } } }, "AlipayOpenMiniMiniappServiceconfigModifyResponseModel" : { "type" : "object" }, "AlipayOpenMiniQrcodeBindErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "APP_IS_NOT_EXIST", "ROUTE_CREATE_NEED_VERSION", "ROUTE_OVER_LIMIT", "ROUTE_RULE_CONFLICT", "HOST_VERIFY_FAILD", "INVALID_PARAM", "APPQRCODE_NOT_TINYAPP", "ONLINE_VERSION_NOT_EXIST", "TEMPLATE_NOT_HAVE_HOST", "TEMPLATE_MISMATCH_ISVAPPID", "BUILDED_NOT_BY_TEMPLATE", "NOT_CURRENTLY_AVALIALBE", "ROUTE_RULE_CONFLICT_OTHER", "QRCODE_ROUTE_URL_INVALID", "APP_IS_NOT_ONLINE", "QRCODE_ROUTE_PATTERN_NOT_MATCH", "QRCODE_ROUTE_PATTERN_NOT_EXIST", "QRCODE_ROUTE_PATTERN_NOT_PERMISSION" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniQrcodeBindModel" : { "type" : "object", "properties" : { "mode" : { "type" : "string", "description" : "匹配规则，仅支持EXACT（精确匹配）、FUZZY（模糊匹配）两个值。\r\t精确匹配：根据填写的二维码地址精确匹配，地址完全一致时才能唤起小程序（如：配置二维码地址为https://www.alipay.com/my?id=123，当用户扫这个地址的二维码可唤起小程序）。\r\t模糊匹配：根据填写的二维码地址模糊匹配，只要地址前缀匹配即可唤起小程序（如：配置二维码地址为https://www.alipay.com/my/，当用户扫的二维码地址为https://www.alipay.com/my/id=123,可唤起小程序）。", "example" : "FUZZY" }, "page_redirection" : { "type" : "string", "description" : "小程序功能页，配置扫描二维码后打开的小程序功能页面路径", "example" : "pages/index/index" }, "route_pattern" : { "type" : "string", "description" : "模式，用于描述通用的路由url格式，适用于同一个host下面存在大量路由的场景，主要用于提升路由性能，其中{0}、{1} 代表路径中的变量", "example" : "http://yoursite.com/merchant/{0}/shop/{1}" }, "route_url" : { "type" : "string", "description" : "二维码域名，须通过ICP备案验证，支持http、https、ftp开头的链接", "example" : "https://www.yoursite.com/" } } }, "AlipayOpenMiniQrcodeBindResponseModel" : { "type" : "object", "properties" : { "route_group" : { "type" : "string", "description" : "路由规则组，用于唯一标记一条路由规则", "example" : "78b59c5b6b2946448bc77e17e544b813" } } }, "AlipayOpenMiniQrcodeQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PAGE_PARAM_NULL_FAIL", "PAGE_SIZE_OUT_LIMIT_FAIL", "PAGE_PARAM_MIN_LIMIT_FAIL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniQrcodeQueryResponseModel" : { "type" : "object", "properties" : { "qr_code_route_groups" : { "type" : "array", "description" : "规则路由数据列表", "items" : { "$ref" : "#/components/schemas/QrCodeRouteGroup" } }, "total_items" : { "type" : "integer", "description" : "数据总数", "example" : "20" } } }, "AlipayOpenMiniQrcodeUnbindErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAM", "TINY_APP_NOT_EXIST", "ROUTE_GROUP_NOT_EXIST", "NO_PERMISSION", "QRCODE_ROUTE_PATTERN_DELETE_NOT_SUPPORT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniQrcodeUnbindModel" : { "type" : "object", "properties" : { "route_group" : { "type" : "string", "description" : "路由规则组，用于唯一标记一条路由规则。调用 https://opendocs.alipay.com/apis/00rkye 接口关联普通二维码后的返回值。", "example" : "78b59c5b6b2946448bc77e17e544b813" } } }, "AlipayOpenMiniQrcodeUnbindResponseModel" : { "type" : "object" }, "AlipayOpenMiniResourcePromotionsourceNotifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAM_APP_ID_IS_BLANK", "PARAM_PROMOTION_ID_IS_BLANK", "PARAM_PROMOTION_NAME_IS_BLANK", "RESOURCE_SOURCE_IS_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniResourcePromotionsourceNotifyModel" : { "type" : "object", "properties" : { "author_id" : { "type" : "string", "description" : "媒体唤起时传入的支付宝id", "example" : "201***********" }, "params" : { "type" : "string", "description" : "媒体唤起时提供的额外参数值列表，这里可能有多个值，打平以后拼入。即url_decode(authcbparams)", "example" : "app_id=1024562&a=1&b=2&c=3&bind_entry=12" }, "promotion_id" : { "type" : "string", "description" : "推广位id", "example" : "mm_mm_123213123123131_21" }, "promotion_name" : { "type" : "string", "description" : "推广位名称", "example" : "推广位名称" }, "source" : { "type" : "string", "description" : "媒体来源，标识调用方", "example" : "zfb_xcx" } } }, "AlipayOpenMiniResourcePromotionsourceNotifyResponseModel" : { "type" : "object" }, "AlipayOpenMiniResourceRecordNotifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAM_APP_ID_IS_BLANK", "PARAM_TAOBAO_ID_IS_BLANK", "PARAM_TAOBAO_NICK_IS_BLANK", "RESOURCE_SOURCE_IS_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniResourceRecordNotifyModel" : { "type" : "object", "properties" : { "author_id" : { "type" : "string", "description" : "媒体唤起时传入的支付宝id", "example" : "2121******" }, "mini_app_id" : { "type" : "string", "description" : "支付宝appid，代表一个小程序的唯一标识", "example" : "201***********" }, "params" : { "type" : "string", "description" : "媒体唤起时提供的额外参数值列表，这里可能有多个值，打平以后拼入。即url_decode(authcbparams)", "example" : "app_id=1024562&a=1&b=2&c=3&bind_entry=12" }, "site_id" : { "type" : "string", "description" : "回调的siteid 淘宝账号唯一", "example" : "12323232" }, "source" : { "type" : "string", "description" : "媒体来源，标识调用方", "example" : "zfb_xcx" }, "taobao_id" : { "type" : "string", "description" : "淘宝id", "example" : "1***********" }, "taobao_nick" : { "type" : "string", "description" : "淘宝昵称", "example" : "**昵称" } } }, "AlipayOpenMiniResourceRecordNotifyResponseModel" : { "type" : "object" }, "AlipayOpenMiniSafedomainCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "SAFE_DOMAIN_IS_BLANK", "APPLICATION_TYPE_NOT_MINIAPP", "SAFEDOMAIN_FORBID", "SAFEDOMAIN_EXCEED_LENGTH", "SAFEDOMAIN_VOER_LIMIT", "SAFEDOMAIN_EXSIT", "ANTI_PHISHING_EXIST", "INVALID_SAFE_DOMAIN" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniSafedomainCreateModel" : { "type" : "object", "properties" : { "safe_domain" : { "type" : "string", "description" : "服务器域名白名单。支付宝小程序在HTTP请求、上传文件等场景只能与域名白名单中的域名进行通讯 。\t新添加域白名单后需重新上传应用版本（模板模式下小程序模板及商家应用都需重新上传、实例化版本）才会生效。老版本应用继续使用老版本名单。\t每个应用最多可添加30个 URL。", "example" : "example.com" } } }, "AlipayOpenMiniSafedomainCreateResponseModel" : { "type" : "object" }, "AlipayOpenMiniSafedomainDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "APPLICATION_TYPE_NOT_MINIAPP", "SAFE_DOMAIN_IS_BLANK" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniSafedomainDeleteResponseModel" : { "type" : "object" }, "AlipayOpenMiniTemplateMarketingCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ACTIVITY_ID_IS_NULL", "TEMPLATE_ID_IS_NULL", "END_TIME_IS_VALID", "TEMPLATE_ID_OVER_LIMIT", "ACTIVITY_IS_NOT_EXIST", "HAS_NO_AUTH_FOR_ACTIVITY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniTemplateMarketingCreateModel" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "营销活动id", "example" : "2022xxxx" }, "gmt_end" : { "type" : "string", "description" : "活动结束时间", "example" : "2022-01-10 22:00:00" }, "gmt_start" : { "type" : "string", "description" : "活动开始时间", "example" : "2022-01-01 10:00:00" }, "template_ids" : { "type" : "array", "description" : "消息模板id列表，最多50个模板id", "items" : { "type" : "string" }, "example" : "[\"a\",\"b\",\"c\"]" }, "title" : { "type" : "string", "description" : "消息运营位名称，不填默认使用券名称", "example" : "优惠活动xxx" } } }, "AlipayOpenMiniTemplateMarketingCreateResponseModel" : { "type" : "object", "properties" : { "detail_id" : { "type" : "string", "description" : "投放详情主键id", "example" : "MDDdejifjeifjoe30fr4j3ifo3f3f3" } } }, "AlipayOpenMiniTemplateUsageQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PAGE_NUM", "INVALID_PAGE_SIZE", "PAGE_SIZE_EXCEED_MAX_QUERY_SIZE", "APPLICATION_TYPE_NOT_ISVAPP", "TEMPLATE_ID_IS_BLANK", "ISV_APP_ID_IS_BLANK", "TEMPLATE_ID_ISVAPPID_NOT_MATCH", "BUNDLE_ID_NOT_EXIST", "TEMPLATE_NO_RELATION_ERROR", "INVALID_PARAMS" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniTemplateUsageQueryResponseModel" : { "type" : "object", "properties" : { "app_ids" : { "type" : "array", "description" : "小程序appId列表", "items" : { "type" : "string" }, "example" : "208812345678" }, "template_usage_info_list" : { "type" : "array", "description" : "模板使用信息", "items" : { "$ref" : "#/components/schemas/TemplateUsageInfo" } } } }, "AlipayOpenMiniTemplatemessageUsertemplateApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "MESSAGE_LIBRARY_ILLEGAL", "MESSAGE_TEMPLATE_KEYWORD_ILLEGAL", "KEYWORDS_NUMBER_INVALID", "USER_TEMPLATE_OVER_LIMIT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniTemplatemessageUsertemplateApplyModel" : { "type" : "object", "properties" : { "keyword_list" : { "type" : "string", "description" : "开发者自行组合好的模板关键词列表，关键词之间使用英文的逗号“,”进行分割，关键词顺序可以自由搭配，最多支持10个关键词组合,这里组织的关键词，在发送模板消息接口中，按照这里的顺序进行占位符替换", "example" : "1,2,3" }, "template_library_id" : { "type" : "string", "description" : "模板库id，可登录小程序后台查看获取", "example" : "AT0001" } } }, "AlipayOpenMiniTemplatemessageUsertemplateApplyResponseModel" : { "type" : "object", "properties" : { "user_template_id" : { "type" : "string", "description" : "开发者申请的模板id号，使用该模板id号，开发者可以调用alipay.open.app.mini.templatemessage.send接口进行模板消息发送", "example" : "MDI4YzIxMDE2M2I5YTQzYjUxNWE4MjA4NmU1MTIyYmM=" } } }, "AlipayOpenMiniTemplatemsgMaketingBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PAG_NUM_NOT_VALID", "PAG_SIZE_NOT_VALID", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniTemplatemsgMaketingBatchqueryModel" : { "type" : "object", "properties" : { "page_num" : { "type" : "integer", "description" : "分页查询页码", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "每页展示条数，最大支持50个", "example" : "10" } } }, "AlipayOpenMiniTemplatemsgMaketingBatchqueryResponseModel" : { "type" : "object", "properties" : { "marketing_delivery_detail_list" : { "type" : "array", "description" : "投放详情列表", "items" : { "$ref" : "#/components/schemas/MarketingDeliveryDetail" } }, "total" : { "type" : "integer", "description" : "投放详情总条数", "example" : "100" } } }, "AlipayOpenMiniTemplatemsgMaketingstatusModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "DELIVERY_DETAIL_ID_IS_NULL", "DELIVERY_DETAIL_STATUS_NOT_VALID", "DELIVERY_APP_AUTH_NOT_VALID", "DELETE_STATUS_CANNOT_UPDATE", "DELIVERY_STATUS_IS_ONLINE", "DELIVERY_STATUS_IS_INIT", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniTemplatemsgMaketingstatusModifyModel" : { "type" : "object", "properties" : { "detail_id" : { "type" : "string", "description" : "营销投放详情id", "example" : "MDDadsfeeijdfiedfef32r3jkdeaqee" }, "status" : { "type" : "string", "description" : "投放详情状态值，如：INIT:下线状态，ON_LINE:上线状态，DELETED:删除状态", "example" : "DELETED" } } }, "AlipayOpenMiniTemplatemsgMaketingstatusModifyResponseModel" : { "type" : "object" }, "AlipayOpenMiniTemplatemsgTinypayswitchConfirmErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "APPINFO_NOT_EXIST", "BIZ_CONTENT_IS_NULL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniTemplatemsgTinypayswitchConfirmResponseModel" : { "type" : "object" }, "AlipayOpenMiniTipsDeliveryBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniTipsDeliveryBatchqueryModel" : { "type" : "object", "properties" : { "page_number" : { "type" : "string", "description" : "每页记录条数，最小1，最大20", "example" : "1" }, "page_size" : { "type" : "string", "description" : "查询的页数，从1开始，最大1000", "example" : "5" } } }, "AlipayOpenMiniTipsDeliveryBatchqueryResponseModel" : { "type" : "object", "properties" : { "tips_delivery_list" : { "type" : "array", "description" : "收藏引导活动信息列表。根据活动状态排序，顺序为：生效中，暂停，审核中，白名单生效中，初始化，审核失败，结束。相同状态优先展示状态更新时间最迟的活动。", "items" : { "$ref" : "#/components/schemas/TipsDelivery" } }, "total_pages" : { "type" : "integer", "description" : "总页数", "example" : "1" }, "total_size" : { "type" : "integer", "description" : "收藏引导数据总数量", "example" : "20" } } }, "AlipayOpenMiniTipsDeliveryCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "EXIST_INDEX_TIPS_DELIVERY", "EXIST_TARGET_TIPS_DELIVERY", "TIPS_DELIVERY_EXCEED_LIMIT", "SYSTEM_ERROR", "INVALID_DELIVERY_TIME", "INVALID_MATCH_URL", "INVALID_MATCH_TYPE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniTipsDeliveryCreateModel" : { "type" : "object", "properties" : { "delivery_content" : { "type" : "string", "description" : "收藏引导文案内容，不得超过14个字", "example" : "点击收藏，下次使用更方便" }, "delivery_name" : { "type" : "string", "description" : "收藏引导活动名称", "example" : "收藏引导首页投放活动" }, "end_time" : { "type" : "string", "description" : "活动结束时间", "example" : "2022-12-31 15:23:43" }, "match_type" : { "type" : "string", "description" : "匹配类型：GLOBAL为全局生效，TARGETURL为目标页面生效，需配置相应页面地址match_url。", "example" : "TARGETURL" }, "match_url" : { "type" : "string", "description" : "目标页面地址", "example" : "/page/web" }, "start_time" : { "type" : "string", "description" : "活动开始时间", "example" : "2021-11-25 15:23:43" } } }, "AlipayOpenMiniTipsDeliveryCreateResponseModel" : { "type" : "object", "properties" : { "delivery_id" : { "type" : "string", "description" : "收藏引导活动ID", "example" : "20211111000000797023" } } }, "AlipayOpenMiniTipsDeliveryModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "DELIVER_NOT_EXIST", "TIPS_DELIVERY_AUDITING", "SAME_MODIFY_OPERATION_TYPE", "INVALID_OPERATE_TYPE", "STATUS_NOT_ALLOWED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniTipsDeliveryModifyModel" : { "type" : "object", "properties" : { "delivery_id" : { "type" : "string", "description" : "收藏引导投放活动ID", "example" : "20211114000003057595" }, "operate_type" : { "type" : "string", "description" : "活动投放操作类型。枚举值：恢复-RESUME,暂停-PAUSE,终止-STOP", "example" : "RESUME" } } }, "AlipayOpenMiniTipsDeliveryModifyResponseModel" : { "type" : "object" }, "AlipayOpenMiniTipsDeliveryQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "DELIVER_NOT_EXIST", "NO_PERMISSION" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniTipsDeliveryQueryResponseModel" : { "type" : "object", "properties" : { "delivery_content" : { "type" : "string", "description" : "收藏引导文案内容", "example" : "点击收藏，下次访问更方便" }, "delivery_id" : { "type" : "string", "description" : "收藏引导投放活动ID", "example" : "20211114000003057595" }, "delivery_name" : { "type" : "string", "description" : "收藏引导配置投放活动的名称", "example" : "收藏引导配置投放活动" }, "end_time" : { "type" : "string", "description" : "活动结束时间", "example" : "2021-11-12 14:31:13" }, "fail_reason" : { "type" : "string", "description" : "文案审核驳回理由，仅AUDIT_REJECTED生效", "example" : "当前文案语义不通顺，请修改" }, "match_type" : { "type" : "string", "description" : "匹配类型：GLOBAL为全局生效，TARGETURL为目标页面生效，需配置相应页面地址match_url", "example" : "TARGETURL" }, "match_url" : { "type" : "string", "description" : "目标页面地址", "example" : "/page/web" }, "start_time" : { "type" : "string", "description" : "活动开始时间", "example" : "2021-11-11 14:31:13" }, "status" : { "type" : "string", "description" : "活动状态。 枚举值： INIT: 初始化；AUDITING: 审核中；AUDIT_REJECTED:审核驳回；WORKING: 生效中；PUASE: 暂停；FINISHED 已结束；", "example" : "WORKING" } } }, "AlipayOpenMiniTipsStatisticQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "NO_QUERY_DELIVERY_ID", "INVALID_QUERY_TYPE", "INVALID_QUERY_TIME", "DELIVER_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniTipsStatisticQueryResponseModel" : { "type" : "object", "properties" : { "app_collect_cnt" : { "type" : "integer", "description" : "昨日（接口调用当日的前一天）小程序收藏人数，时间内未创建投放活动，则响应时不传出参数。", "example" : "4798780" }, "app_uv" : { "type" : "integer", "description" : "昨日（接口调用当日的前一天）小程序访问人数。当小程序日访问量为0，或以活动维度查询，或时间内未创建投放活动，则响应时不传出参数。", "example" : "3080000" }, "delivery_content" : { "type" : "string", "description" : "收藏文案内容（仅以app维度查询时为空）,仅活动维度查询成功时返回。", "example" : "点击收藏，下次使用更方便" }, "delivery_id" : { "type" : "string", "description" : "收藏引导投放活动ID（仅以app维度查询时为空）,仅活动维度查询成功时返回。", "example" : "2018092061468502" }, "tips_collect_rate" : { "type" : "string", "description" : "昨日（接口调用当日的前一天）收藏引导文案收藏转化率，数据为小数字符串类型，取小数点后两位，单位为百分比。小程序曝光数为0，或时间内未创建投放活动，则响应时不传出参数。", "example" : "33.33" }, "tips_collect_uv" : { "type" : "integer", "description" : "昨日（接口调用当日的前一天）收藏引导文案收藏用户数，时间内未创建投放活动，则响应时不传出参数。", "example" : "440000" }, "tips_expo_uv" : { "type" : "integer", "description" : "昨日（接口调用当日的前一天）收藏引导文案曝光用户数，时间内未创建投放活动，则响应时不传出参数。", "example" : "434000" }, "total_app_collect_cnt" : { "type" : "integer", "description" : "时间段内累计小程序收藏人数，时间内未创建投放活动，则响应时不传出参数。", "example" : "7800000" }, "total_app_uv" : { "type" : "integer", "description" : "时间段内累计小程序访问人数。当小程序日访问量为0，或以活动维度查询，或时间内未创建投放活动，则响应时不传出参数。", "example" : "79980000" }, "total_tips_collect_rate" : { "type" : "string", "description" : "时间段内收藏引导文案收藏转化率，数据为小数字符串类型，取小数点后两位，单位为百分比。小程序曝光数为0，或时间内未创建投放活动，则响应时不传出参数。", "example" : "33.33" }, "total_tips_collect_uv" : { "type" : "integer", "description" : "时间段内累计收藏引导文案收藏用户数，时间内未创建投放活动，则响应时不传出参数。", "example" : "5030000" }, "total_tips_expo_uv" : { "type" : "integer", "description" : "时间段内累计收藏引导文案曝光用户数，仅当小程序/活动投放活动时返回。时间内未创建投放活动，则响应时不传出参数。", "example" : "2333900" } } }, "AlipayOpenMiniVersionAuditApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "APP_NAME_IS_BLANK", "INVALID_MINI_APP_NAME_LENGTH", "INVALID_MINI_APP_NAME", "ENGLISH_NAME_IS_BLANK", "INVALID_MINI_APP_EN_NAME", "INVALID_MINI_APP_EN_NAME_LENGTH", "SLOGAN_IS_BLANK", "INVALID_MINI_APP_SLOGAN_LENGTH", "INVALID_MINI_APP_SLOGAN", "SERVICE_TEL_AND_MAIL_BOTH_BLANK", "INVALID_MINI_APP_SERVICE_TEL", "INVALID_MINI_APP_SERVICE_MAIL", "CATEGORY_IS_BLANK", "CATEGORY_NUM_IS_INVALID", "APP_DESC_IS_BLANK", "INVALID_MINI_APP_DESC_LENGTH", "INVALID_MINI_APP_DESC", "REGION_TYPE_IS_BLANK", "REGION_TYPE_IS_INVALID", "REGION_CODE_IS_BLANK", "APP_VERSION_IS_BLANK", "VERSION_DESC_IS_BLANK", "INVALID_VERSION_DESC_LENGTH", "INVALID_MINI_APP_VERSION_DESC", "SCREEN_SHOTS_ARE_BLANK", "SCREEN_SHOT_NUM_IS_INVALID", "INVALID_MINI_APP_MEMO_LENGTH", "APPLICATION_TYPE_NOT_MINIAPP", "INVALID_MINI_APP_SAFE_DOMAIN", "CAN_NOT_SUBMIT_WITH_ALI_CLOUD", "MINI_APP_NAME_DUPLICATE", "MINI_APP_EN_NAME_DUPLICATE", "INVALID_CATEGORY", "INVALID_REGION", "MINI_APP_NAME_SENSITIVE", "MINI_APP_EN_NAME_SENSITIVE", "MINI_APP_SLOGAN_SENSITIVE", "MINI_APP_MEMO_SENSITIVE", "MINI_APP_DESC_SENSITIVE", "MINI_APP_SERVICE_MAIL_SENSITIVE", "MINI_APP_VERSION_DESC_SENSITIVE", "MINI_APP_PACKAGE_INFO_NOT_EXIST", "CAN_NOT_MODIFY_NAME_ONCE_ONLINE", "CAN_NOT_MODIFY_EN_ONCE_ONLINE", "MODIFY_SLOGAN_EXCEED_COUNT", "MODIFY_CATEGORY_ID_EXCEED_COUNT", "MODIFY_DESC_EXCEED_COUNT", "CAN_NOT_SUBMIT_WITH_AUDIT", "CAN_NOT_SUBMIT_WITHOUT_INIT", "CAN_NOT_SUBMIT_WITHOUT_SCAN_PASS", "CAN_NOT_SUBMIT_WITH_AUDIT_GRAY", "EXIST_LARGER_ONLINED_VERSION", "LICENSE_NO_IS_BLANK", "LICENSE_VALID_DATE_IS_BLANK", "LICENSE_VALID_DATE_IS_INVALID", "OUT_DOOR_PIC_IS_BLANK", "LICENSE_PICS_ARE_BLANK", "LICENSE_PIC_NUM_IS_INVALID", "LICENSE_CHECK_FAIL", "LOGO_HEIGHT_NOT_EQUAL_WIDTH", "INVALID_SCREEN_SHOT_EXT", "SCREEN_SHOT_EXCEED_MAX_SIZE", "INVALID_PARAMETER", "LOGO_EXCEED_MAX_SIZE", "INVALID_LOGO_EXT", "INVALID_PARAMS", "INVALID_LOGO", "RISK_DECISION_CHECK_FAIL", "TINY_APP_AUDIT_NOT_PERMIT", "RISK_DECISION_HIT_BRAND", "BRAND_TORT_NOT_END", "SPECIAL_LICENSE_PICS_ARE_BLANK", "FILE_IS_BLANK", "INVALID_FILE_EXT", "FILE_SIZE_EXCEED", "INVALID_SPECIAL_LICENSE_NUM", "BUNDLE_ID_NOT_EXIST", "DEFAULT_LOGO", "SUBMIT_REPEAT", "PRIVATE_NOT_ALLOW_CATEGORY", "MINI_APP_INFO_AUDIT_CONTAINS", "MINI_VERSION_NAME_DUPLICATE", "LOGO_SIZE_EXCEED", "APP_INFO_NOT_EXIST", "USER_NOT_EXIST", "REGION_CODE_IS_INVALID", "SERVICE_TEL_IS_BLANK", "INVALID_MINI_APP_NAME_PREFIX", "SYSTEM_LIMIT", "LOGO_IS_BLANK" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniVersionAuditApplyModel" : { "type" : "object", "properties" : { "app_category_ids" : { "type" : "string", "description" : "小程序类目，格式为 第一个一级类目_第一个二级类目;第二个一级类目_第二个二级类目，详细类目可以通过 https://docs.open.alipay.com/api_49/alipay.open.mini.category.query接口查询，如果不填默认采用当前小程序应用类目。使用默认应用类目后不需要再次上传营业执照号、营业执照名、营业执照截图、营业执照有效期。", "example" : "11_12;12_13" }, "app_desc" : { "type" : "string", "description" : "小程序描述，长度限制 20~400 个字符。\t如果前期已经设置过该信息，本次可不填，平台将会为你默认上传该信息。如果前期没有设置过该信息，则本次为必填。可通过https://opendocs.alipay.com/mini/03l21r查询当前小程序信息", "example" : "一家专注做潮流女装的店铺，带给消费者价格便宜、质量上乘的衣服" }, "app_english_name" : { "type" : "string", "description" : "小程序应用英文名称，长度限制 3～30 个字符；仅支持英文和数字。\t如果不填默认采用当前小程序应用英文名称，如无默认值则必填，不可为空。", "example" : "demoexample" }, "app_name" : { "type" : "string", "description" : "小程序名称，长度限制 3~30 个字符，仅支持包含中文、数字、英文、下划线、+、-。\t如果不填默认采用当前小程序应用名称，如无默认值则必填，不可为空。\t如果前期已经设置过该信息，本次可不填，平台将会为你默认上传该信息。如果前期没有设置过该信息，则本次为必填。可通过https://opendocs.alipay.com/mini/03l21r查询当前小程序信息", "example" : "杭州支小宝潮流女装店" }, "app_slogan" : { "type" : "string", "description" : "小程序简介，一句话描述小程序功能，长度限制 10~32个字符。\t如果前期已经设置过该信息，本次可不填，平台将会为你默认上传该信息。如果前期没有设置过该信息，则本次为必填。可通过https://opendocs.alipay.com/mini/03l21r查询当前小程序信息", "example" : "专注潮流女装20年" }, "app_version" : { "type" : "string", "description" : "小程序版本号，请选择开发版本执行提交审核操作。", "example" : "0.0.1" }, "audit_rule" : { "type" : "string", "description" : "审核类型：\tNONE： 不拆分准入、营销（默认）\tBASE_PROMOTE：准入、营销拆分审核\t建议设置成“BASE_PROMOTE”，小程序将会更容易上架。将小程序发布审核拆分成“准入”、“营销”。原先小程序需要两个环节都审核通过才能上架，现在小程序只需要准入通过即可上架，但是无法在营销场景（支付宝泛搜、支付宝首页推荐等）展现给用户，小程序可通过精搜或者扫码等方式使用。如果小程序需要进行营销，可发布新版本，当准入&营销都通过后，小程序也可被营销。点击查看支付宝小程序营销规范：https://opendocs.alipay.com/b/03al2q", "example" : "BASE_PROMOTE" }, "auto_online" : { "type" : "string", "description" : "审核通过后是否自动上架，\t自动上架：true；不自动上架（默认）：false。\t如果小程序上架前无需特殊处理，建议设置成true，平台将会在小程序审核通过时自动将其上架", "example" : "true" }, "bundle_id" : { "type" : "string", "description" : "小程序投放的端参数。例如投放到支付宝钱包是支付宝端。默认支付宝端。支持：\tcom.alipay.alipaywallet:支付宝端；\tcom.alipay.iot.xpaas：支付宝IoT端。", "example" : "com.alipay.alipaywallet" }, "license_name" : { "type" : "string", "description" : "营业执照名称，部分小程序类目需要提交，可通过https://opendocs.alipay.com/mini/03l8c8 查询类目是否需要上传营业执照信息。参照https://opendocs.alipay.com/mini/operation/material 要求填写营业执照信息。\t如果选择的类目不需要该信息，则可不填。如果选择的类目需要该信息，如果商户之前在平台上传过该信息，也允许不填", "example" : "营业执照名称" }, "license_no" : { "type" : "string", "description" : "营业执照证件号，部分小程序类目需要提交，可通过https://opendocs.alipay.com/mini/03l8c8 查询类目是否需要上传营业执照信息。参照https://opendocs.alipay.com/mini/operation/material 要求填写营业执照信息。\t\t如果选择的类目不需要该信息，则可不填。如果选择的类目需要该信息，如果商户之前在平台上传过该信息，也允许不填", "example" : "licenseNo" }, "license_valid_date" : { "type" : "string", "description" : "营业执照有效期，格式为 yyyy-MM-dd，9999-12-31表示长期有效。\t部分小程序类目需要提交，可通过https://opendocs.alipay.com/mini/03l8c8 查询类目是否需要上传营业执照信息。参照https://opendocs.alipay.com/mini/operation/material 要求填写营业执照信息。\t如果选择的类目不需要该信息，则可不填。如果选择的类目需要该信息，如果商户之前在平台上传过该信息，也允许不填", "example" : "9999-12-31" }, "memo" : { "type" : "string", "description" : "小程序备注，小程序备注最多500字符。", "example" : "小程序示例" }, "mini_category_ids" : { "type" : "string", "description" : "新小程序前台类目，格式为 第一个一级类目_第一个二级类目;第二个一级类目_第二个二级类目_第二个三级类目，详细类目可以通过 https://docs.open.alipay.com/api_49/alipay.open.mini.category.query\t接口查询mini_category_list。\t如果前期已经设置过该信息，本次可不填，平台将会为你默认上传该信息。如果前期没有设置过该信息，则本次为必填。可通过https://opendocs.alipay.com/mini/03l21r查询当前小程序信息\t注意：个人开发者不得使用企业类目。", "example" : "XS1001_XS2001_XS3002;XS1011_XS2089;XS1002_XS2008_XS3024" }, "region_type" : { "type" : "string", "description" : "小程序服务区域类型，支持：\tGLOBAL-全球\tCHINA-中国\t如果前期已经设置过该信息，本次可不填，平台将会为你默认上传该信息。如果前期没有设置过该信息，则本次为必填。\tLOCATION-指定区域", "example" : "CHINA" }, "service_email" : { "type" : "string", "description" : "小程序客服邮箱，如果不填默认采用当前小程序的应用客服邮箱，小程序客服电话和邮箱至少输入一个。如果前期已经设置过该信息，本次可不填，平台将会为你默认上传该信息。\t注意：2021年7月1日后，该字段将逐步灰度为可选字段，请按可选开发。", "example" : "example@mail.com" }, "service_phone" : { "type" : "string", "description" : "小程序客服电话，长度限制5~30个字符，仅支持包含数字和-。如果不填默认采用当前小程序的应用客服电话，小程序客服电话和邮箱至少输入一个。如果前期已经设置过该信息，本次可不填，平台将会为你默认上传该信息。\t注意：2021年7月1日后，该字段将逐步灰度为必填字段，请按必填开发。", "example" : "13110101010" }, "service_region_info" : { "type" : "array", "description" : "省市区信息。当region_type为LOCATION或传入city_code时，province_code不能为空；填写area_code时，province_code和city_code不能为空。只填province_code则全选该省；填写province_code和city_code则全选该市，以此类推。省市区code参见https://gw.alipayobjects.com/os/bmw-prod/0aab0319-13de-42b9-85cf-13877a5f78ed.xlsx\t如果前期已经设置过该信息，本次可不填，平台将会为你默认上传该信息。如果前期没有设置过该信息，则本次为必填。", "items" : { "$ref" : "#/components/schemas/RegionInfo" } }, "speed_up" : { "type" : "string", "description" : "如果有审核加急权益，是否使用审核加急权益加速审核：\t加速（默认）：true\t不加速：false", "example" : "true" }, "test_accout" : { "type" : "string", "description" : "测试账号，是否需要填写请参见https://opendocs.alipay.com/mini/operation/standard/case/akxg6r#3.%20%E6%B5%8B%E8%AF%95%E5%86%85%E5%AE%B9%E6%8F%90%E4%BA%A4%E4%B8%8D%E5%AE%8C%E6%95%B4", "example" : "12122" }, "test_password" : { "type" : "string", "description" : "测试账号密码", "example" : "12121" }, "version_desc" : { "type" : "string", "description" : "小程序版本描述，30-500个字符。", "example" : "本次版本更新优化了3项功能，修复了5个BUG" } } }, "AlipayOpenMiniVersionAuditApplyResponseModel" : { "type" : "object", "properties" : { "speed_up" : { "type" : "string", "description" : "是否加速审核\t加速：true；\t不加速：false", "example" : "true" }, "speed_up_memo" : { "type" : "string", "description" : "提审加速审核说明", "example" : "绿通权益使用限流" } } }, "AlipayOpenMiniVersionAuditCancelErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "APPID_IS_BLANK", "AUDITING_VERSION_NOT_EXIST", "APP_INFO_NOT_EXIST", "APPLICATION_TYPE_NOT_MINIAPP", "MINI_APP_NOT_ONLINE", "MINI_APP_PACKAGE_INFO_NOT_EXIST", "TINYAPP_STATUS_INVALID", "MULTI_CLIENT_NOT_PACKAGED_STATUS", "APPSTORE_RPC_INVOKE_ERROR", "BUNDLE_ID_NOT_EXIST", "INVALID_VERSION_STATUS", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniVersionAuditCancelModel" : { "type" : "object", "properties" : { "app_version" : { "type" : "string", "description" : "商家小程序审核中的版本号, 不传默认撤消正在审核中的版本。", "example" : "0.0.1" }, "bundle_id" : { "type" : "string", "description" : "小程序投放的端参数，例如投放到支付宝钱包是支付宝端。默认支付宝端。支持：\tcom.alipay.alipaywallet:支付宝端；\tcom.alipay.iot.xpaas：支付宝IoT端。", "example" : "com.alipay.alipaywallet" } } }, "AlipayOpenMiniVersionAuditCancelResponseModel" : { "type" : "object" }, "AlipayOpenMiniVersionAuditedCancelErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "APP_VERSION_IS_BLANK", "APPLICATION_TYPE_NOT_MINIAPP", "MINI_APP_PACKAGE_INFO_NOT_EXIST", "CAN_NOT_BACK_DEV_WITHOUT_AUDIT", "BUNDLE_ID_NOT_EXIST", "MINIAPP_VERSION_NOT_EXSIT", "APP_INFO_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniVersionAuditedCancelModel" : { "type" : "object", "properties" : { "app_version" : { "type" : "string", "description" : "商家小程序版本号。可将已过审、审核被驳回的小程序版本退回到开发中的状态。", "example" : "0.0.1" }, "bundle_id" : { "type" : "string", "description" : "小程序投放的端参数，例如投放到支付宝钱包是支付宝端。默认支付宝端。支持：\tcom.alipay.alipaywallet:支付宝端；\tcom.alipay.iot.xpaas：支付宝IoT端。", "example" : "com.alipay.alipaywallet" } } }, "AlipayOpenMiniVersionAuditedCancelResponseModel" : { "type" : "object" }, "AlipayOpenMiniVersionBuildQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "APP_VERSION_IS_BLANK", "CODE_TEMPLATE_NOT_EXIST", "NO_AUTH_RELATION", "APPLICATION_TYPE_NOT_MINIAPP", "MINI_APP_NOT_ONLINE", "ISV_APP_ID_IS_BLANK", "BUILD_VERSION_NOT_EXISTED", "BUNDLE_ID_NOT_EXIST", "APPLICATION_TYPE_ILLEGAL", "NO_TEMPLATE_INSTANTIATE_RELATION", "PACKAGE_ID_IS_BLANK", "POLLING_BUILDING_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniVersionBuildQueryResponseModel" : { "type" : "object", "properties" : { "build_status" : { "type" : "string", "description" : "构建的状态，0-构建排队中；1-正在构建；2-构建成功；3-构建失败；5-构建超时", "example" : "0" }, "create_status" : { "type" : "string", "description" : "创建版本的状态，状态说明如下：\t0：构建排队中；\t1：正在构建；\t2：构建成功；\t3：构建失败；\t5：构建超时；\t6：版本创建成功。", "example" : "6" }, "need_rotation" : { "type" : "string", "description" : "是否需要轮询", "example" : "\"true\"" }, "version_created" : { "type" : "string", "description" : "是否创建版本", "example" : "\"true\"" } } }, "AlipayOpenMiniVersionDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "APP_VERSION_IS_BLANK", "APPLICATION_TYPE_NOT_MINIAPP", "MINI_APP_NOT_ONLINE", "CAN_NOT_DELETE_WITHOUT_DEV", "CAN_NOT_DELETE_WITH_SCANNING", "CAN_NOT_DELETE_WITH_EXPERIENCE", "BUNDLE_ID_NOT_EXIST", "MINI_APP_PACKAGE_INFO_NOT_EXIST", "CAN_NOT_DELETE_WITH_INSTANTIATE", "APP_INFO_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniVersionDeleteModel" : { "type" : "object", "properties" : { "app_version" : { "type" : "string", "description" : " 小程序版本号。只有状态为开发中的版本才能被删除。", "example" : "0.0.1" }, "bundle_id" : { "type" : "string", "description" : "小程序投放的端参数，例如投放到支付宝钱包是支付宝端。默认支付宝端。支持：\tcom.alipay.alipaywallet:支付宝端；\tcom.alipay.iot.xpaas：支付宝IoT端。", "example" : "com.alipay.alipaywallet" } } }, "AlipayOpenMiniVersionDeleteResponseModel" : { "type" : "object" }, "AlipayOpenMiniVersionDetailQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "APPLICATION_TYPE_NOT_MINIAPP", "APP_VERSION_IS_BLANK", "BUNDLE_ID_NOT_EXIST", "VERSION_IS_BLANK" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniVersionDetailQueryResponseModel" : { "type" : "object", "properties" : { "app_desc" : { "type" : "string", "description" : "小程序应用描述", "example" : "小程序demo的相关示例" }, "app_english_name" : { "type" : "string", "description" : "小程序应用英文名称", "example" : "demoexample" }, "app_logo" : { "type" : "string", "description" : "小程序应用logo图标", "example" : "http://image.aaaa.alipay.com" }, "app_name" : { "type" : "string", "description" : "小程序应用名称", "example" : "小程序demo" }, "app_slogan" : { "type" : "string", "description" : "小程序应用简介，一句话描述小程序功能", "example" : "小程序demo简介" }, "app_version" : { "type" : "string", "description" : "小程序版本号", "example" : "0.0.1" }, "base_audit" : { "type" : "string", "description" : "准入审核结果：\tPASS：通过\tREJECT：驳回\t（提审时 audit_rule 传 BASE_PROMOTE 时有该字段）", "example" : "PASS" }, "base_audit_record" : { "$ref" : "#/components/schemas/MiniAppAuditReason" }, "can_release" : { "type" : "string", "description" : "是否可上架-true/false\t（提审时 audit_rule 传 BASE_PROMOTE 时有该字段）", "example" : "true" }, "gmt_apply_audit" : { "type" : "string", "description" : "小程序版本提交审核的时间", "example" : "2017-12-12 12:00:00" }, "gmt_audit_end" : { "type" : "string", "description" : "小程序版本审核结束时间", "example" : "2017-12-12 12:00:00" }, "gmt_create" : { "type" : "string", "description" : "小程序版本创建时间", "example" : "2017-12-12 12:00:00" }, "gmt_offline" : { "type" : "string", "description" : "小程序版本下架时间", "example" : "2017-12-12 12:00:00" }, "gmt_online" : { "type" : "string", "description" : "小程序版本上架时间", "example" : "2017-12-12 12:00:00" }, "gray_strategy" : { "type" : "string", "description" : "小程序灰度比例值，p10-10%的用户，p30-30%的用户，p50-50%的用户", "example" : "p10" }, "memo" : { "type" : "string", "description" : "小程序备注", "example" : "这是一个demo示例" }, "mini_app_category_info_list" : { "type" : "array", "description" : "小程序类目列表", "items" : { "$ref" : "#/components/schemas/MiniAppCategoryInfo" } }, "mini_category_info_list" : { "type" : "array", "description" : "新小程序类目列表", "items" : { "$ref" : "#/components/schemas/MiniAppCategoryInfo" } }, "package_info_list" : { "type" : "array", "description" : "小程序功能包列表", "items" : { "$ref" : "#/components/schemas/MiniPackageInfo" } }, "promote_audit" : { "type" : "string", "description" : "营销审核结果：\tPASS：通过\tREJECT：驳回\t（提审时 audit_rule 传 BASE_PROMOTE 时有该字段）", "example" : "PASS" }, "promote_audit_record" : { "$ref" : "#/components/schemas/MiniAppAuditReason" }, "reject_reason" : { "type" : "string", "description" : "审核驳回原因", "example" : "名称太宽泛" }, "scan_result" : { "type" : "string", "description" : "安全扫描结果，True-安全扫描通过，False-安全扫描不通过，NAN-扫描中", "example" : "True" }, "screen_shot_list" : { "type" : "array", "description" : "小程序版本截图，多个截图以逗号隔开", "items" : { "type" : "string" }, "example" : "http://image.aaa.alipay.com" }, "service_email" : { "type" : "string", "description" : "客服邮箱", "example" : "example@mail.com" }, "service_phone" : { "type" : "string", "description" : "客服电话", "example" : "13110101010" }, "service_region_info" : { "type" : "array", "description" : "小程序服务区域信息，当服务区域类型是LOCATION时，这里明确指出具体的服务区域信息", "items" : { "$ref" : "#/components/schemas/RegionInfo" } }, "service_region_type" : { "type" : "string", "description" : "小程序服务区域类型，GLOBLE-全球，CHINA-中国，LOCATION-指定区域", "example" : "LOCATION" }, "status" : { "type" : "string", "description" : "小程序版本状态，INIT-开发中，AUDITING-审核中，WAIT_RELEASE-待上架，BASE_AUDIT_PASS-准入不可营销，AUDIT_REJECT-审核驳回，RELEASE-已上架，GRAY-灰度中，OFFLINE-已下架，AUDIT_OFFLINE-已被强制下架", "example" : "INIT" }, "version_desc" : { "type" : "string", "description" : "小程序版本描述", "example" : "这是一个简单的版本描述" } } }, "AlipayOpenMiniVersionGrayCancelErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "APP_VERSION_IS_BLANK", "APPLICATION_TYPE_NOT_MINIAPP", "MINI_APP_PACKAGE_INFO_NOT_EXIST", "CAN_NOT_END_GRAY_WITHOUT_GRAY", "MINI_APP_NOT_ONLINE", "BUNDLE_ID_NOT_EXIST", "MINI_APP_VERSION_NOT_EXIST", "MINI_APP_VERSION_STATUS_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniVersionGrayCancelModel" : { "type" : "object", "properties" : { "app_version" : { "type" : "string", "description" : "商家灰度中的小程序版本号，结束灰度后小程序将回到审核通过状态。", "example" : "0.0.1" }, "bundle_id" : { "type" : "string", "description" : "小程序投放的端参数，例如投放到支付宝钱包是支付宝端。默认支付宝端。支持：\tcom.alipay.alipaywallet:支付宝端；\tcom.alipay.iot.xpaas：支付宝IoT端。", "example" : "com.alipay.alipaywallet" } } }, "AlipayOpenMiniVersionGrayCancelResponseModel" : { "type" : "object" }, "AlipayOpenMiniVersionGrayOnlineErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "APP_VERSION_IS_BLANK", "GRAY_STRATEGY_IS_BLANK", "GRAY_STRATEGY_IS_INVALID", "APPLICATION_TYPE_NOT_MINIAPP", "MINI_APP_PACKAGE_INFO_NOT_EXIST", "MINI_APP_NOT_ONLINE", "GRAY_STRATEGY_NOT_ALLOW_REDUCE", "CAN_NOT_GRAY_WITHOUT_AUDIT_PASS", "BUNDLE_ID_NOT_EXIST", "CAN_NOT_GRAY_WITHOUT_INNER_PASS", "MINIAPP_VERSION_NOT_EXSIT", "CAN_NOT_GRAY_WITH_RISK_VERSION", "APP_OPERATOR_QUERY_ERROR", "CREATE_GRAY_RULE_ERROR", "EXECUTE_GRAY_FAILED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniVersionGrayOnlineModel" : { "type" : "object", "properties" : { "app_version" : { "type" : "string", "description" : "商家小程序版本号，需为审核通过状态的小程序版本。", "example" : "0.0.1" }, "bundle_id" : { "type" : "string", "description" : "小程序投放的端参数，例如投放到支付宝钱包是支付宝端。默认支付宝端。支持：\tcom.alipay.alipaywallet:支付宝端；\tcom.alipay.iot.xpaas：支付宝IoT端。", "example" : "com.alipay.alipaywallet" }, "gray_strategy" : { "type" : "string", "description" : "小程序灰度策略值。枚举支持：p10、p30、p50。其中 p10 代表 10% 的用户，p30 代表 30% 的用户，p50 代表 50% 的用户。", "example" : "p10" } } }, "AlipayOpenMiniVersionGrayOnlineResponseModel" : { "type" : "object" }, "AlipayOpenMiniVersionListQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "APPLICATION_TYPE_NOT_MINIAPP", "NO_TEMPLATE_INSTANTIATE_RELATION" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniVersionListQueryResponseModel" : { "type" : "object", "properties" : { "app_version_infos" : { "type" : "array", "description" : "版本列表，根据版本号倒叙排列，即版本号大的在前面；如果不存在任何版本，返回空列表", "items" : { "$ref" : "#/components/schemas/AppVersionInfo" } }, "app_versions" : { "type" : "array", "description" : "小程序支付宝端每个状态的最新版本号列表(历史返回值，已不推荐使用，逐渐废弃)", "items" : { "type" : "string" }, "example" : "0.0.1" } } }, "AlipayOpenMiniVersionOfflineErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "APP_VERSION_IS_BLANK", "APPLICATION_TYPE_NOT_MINIAPP", "MINI_APP_PACKAGE_INFO_NOT_EXIST", "CAN_NOT_OFFLINE_WITHOUT_ONLINE", "CAN_NOT_OFFLINE_WITH_GRAY", "MINI_APP_NOT_ONLINE", "BUNDLE_ID_NOT_EXIST", "APP_INFO_NOT_EXIST", "MINI_APP_VERSION_NOT_EXIST", "TEMPLATE_NOT_ALLOWED_OFFLINE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniVersionOfflineModel" : { "type" : "object", "properties" : { "app_version" : { "type" : "string", "description" : "商家小程序已上架版本号。", "example" : "0.0.1" }, "bundle_id" : { "type" : "string", "description" : "小程序投放的端参数，例如投放到支付宝钱包是支付宝端。默认支付宝端。支持：\tcom.alipay.alipaywallet:支付宝端；\tcom.alipay.iot.xpaas：支付宝IoT端。", "example" : "com.alipay.alipaywallet" } } }, "AlipayOpenMiniVersionOfflineResponseModel" : { "type" : "object" }, "AlipayOpenMiniVersionOnlineErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "APP_VERSION_IS_BLANK", "APPLICATION_TYPE_NOT_MINIAPP", "MINI_APP_PACKAGE_INFO_NOT_EXIST", "CAN_NOT_ONLINE_WITHOUT_GRAY", "MINI_APP_NOT_ONLINE", "CAN_NOT_ONLINE_WITHOUT_AUDIT", "MINI_APP_VERSION_NOT_EXIST", "CAN_NOT_ONLINE_NOT_GRAY_OR_WAITRELEASE", "CAN_NOT_ONLINE_NO_PROMOTE", "APP_INFO_NOT_EXIST", "MERCHANT_NOT_EXESIT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniVersionOnlineModel" : { "type" : "object", "properties" : { "app_version" : { "type" : "string", "description" : "商家小程序版本号，需为审核通过状态或灰度中版本。", "example" : "0.0.1" }, "bundle_id" : { "type" : "string", "description" : "小程序投放的端参数，例如投放到支付宝钱包是支付宝端。默认支付宝端。支持：\tcom.alipay.alipaywallet:支付宝端；\tcom.alipay.iot.xpaas：支付宝IoT端。", "example" : "com.alipay.alipaywallet" } } }, "AlipayOpenMiniVersionOnlineResponseModel" : { "type" : "object" }, "AlipayOpenMiniVersionRollbackErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "APP_VERSION_IS_BLANK", "APPLICATION_TYPE_NOT_MINIAPP", "MINI_APP_PACKAGE_INFO_NOT_EXIST", "MINI_APP_NOT_ONLINE", "CAN_NOT_ROLLBACK_WITHOUT_ONLINE", "CAN_NOT_CONTINUOUS_ROLLBACK", "CAN_NOT_ROLLBACK_WITH_GRAY", "CAN_NOT_ROLLBACK_WITHOUT_OFFLINE", "CAN_NOT_ROLLBACK_PUNISH", "BUNDLE_ID_NOT_EXIST", "APP_INFO_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniVersionRollbackModel" : { "type" : "object", "properties" : { "app_version" : { "type" : "string", "description" : "商家小程序已上架版本。下架后将自动回滚至上一（已上架）小程序版本。\t例如：商家小程序有 0.01（上一上架版本）、0.02（未上架版本）、0.03（当前上架版本） 三个版本，回滚时需传入商家小程序版本 0.03 表示将 0.03 版本回滚至上一个已上架版本即此处 0.01 版本，同时 0.03 版本将自动下架，0.01 版本自动上架（无需审核）。", "example" : "0.0.1" }, "bundle_id" : { "type" : "string", "description" : "小程序投放的端参数，例如投放到支付宝钱包是支付宝端。默认支付宝端。支持：\tcom.alipay.alipaywallet:支付宝端；\tcom.alipay.iot.xpaas：支付宝IoT端。", "example" : "com.alipay.alipaywallet" } } }, "AlipayOpenMiniVersionRollbackResponseModel" : { "type" : "object" }, "AlipayOpenMiniVersionUploadErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "APP_VERSION_IS_BLANK", "TEMPLATE_ID_IS_BLANK", "CODE_TEMPLATE_NOT_EXIST", "CODE_TEMPLATE_NOT_SAFE", "CODE_TEMPLATE_DELETED", "NO_AUTH_RELATION", "VERSION_HAS_EXISTED", "LARGER_VERSION_HAS_EXISTED", "APPLICATION_TYPE_NOT_MINIAPP", "ISV_APP_ID_IS_BLANK", "INVALID_VERSION", "DEV_VERSION_EXCEED_MAX_COUNT", "TEMPLATE_NOT_ONLINE_OR_OFFLINE", "MINI_APP_PACKAGE_INFO_NOT_EXIST", "TEMPLATE_MINIAPP_NOT_ALLOWED", "VERSION_EXCEEDED_LENGTH", "TEMPLATE_ID_ISVAPPID_NOT_MATCH", "BUNDLE_ID_NOT_EXIST", "INVALID_EXT_JSON", "APP_INFO_NOT_EXIST", "APP_TYPE_ERROR", "TEMPLATE_STATUS_PUNISHED", "TEMPLATE_STATUS_CAN_NOT_BUILD", "INVALID_PARAMS", "TEMPLATE_EXTRA_INFO_INVALID" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniVersionUploadModel" : { "type" : "object", "properties" : { "app_version" : { "type" : "string", "description" : "商家小程序版本号。版本号必须满足 x.y.z, 且均为数字。要求版本号比商户之前最新的版本号高。", "example" : "0.0.1" }, "bundle_id" : { "type" : "string", "description" : "小程序投放的端参数，默认支付宝端 。支持：com.alipay.alipaywallet：支付宝端。\tcom.alipay.iot.xpaas：支付宝IoT端。\t例如投放到支付宝钱包是支付宝端。", "example" : "com.alipay.alipaywallet" }, "ext" : { "type" : "string", "description" : "自定义参数，用于配置商家小程序的个性化内容，具体使用方法参见示例代码。\t在小程序中可以通过 my.getExtConfig() 或 my.getExtConfigSync() 获取 ext 参数内容（建议支付宝版本 > 10.1.38，并使用 my.canIUse 做兼容处理）。", "example" : "{\"extEnable\": true, \"extPages\": {\"pages/face/index\": {\"defaultTitle\": \"哈哈哈哈\"}},\"window\": {\"defaultTitle\": \"AI2\"}}" }, "template_id" : { "type" : "string", "description" : "小程序模板 APPID。", "example" : "1" }, "template_version" : { "type" : "string", "description" : "小程序模板版本号。版本号必须满足 x.y.z, 且均为数字。不传默认使用最新在架（已上架）模板版本。", "example" : "0.0.1" } } }, "AlipayOpenMiniVersionUploadResponseModel" : { "type" : "object", "properties" : { "build_status" : { "type" : "string", "description" : "构建的状态，0-构建排队中；1-正在构建；2-构建成功；3-构建失败；5-构建超时", "example" : "0" }, "create_status" : { "type" : "string", "description" : "创建版本的状态，0-构建排队中；1-正在构建；2-构建成功；3-构建失败；5-构建超时；6-版本创建成功", "example" : "6" }, "need_rotation" : { "type" : "string", "description" : "是否需要轮询", "example" : "\"true\"" }, "version_created" : { "type" : "string", "description" : "是否创建了版本", "example" : "true" } } }, "AlipayOpenMiniWidgetDataSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "MINI_APP_ID_ILLEGAL", "PID_ILLEGAL", "APP_INFO_NOT_EXIST", "APP_IS_NOT_WIDGET", "AUDITING_VERSION_EXIST", "WIDGET_DATA_UPLOAD_FREQUENCY", "WIDGET_DATA_MAX_SIZE_LIMIT", "APP_ID_NOT_EXIST", "APP_TYPE_INVALID", "PICTURE_SIZE_MORETHEN_MAX", "CLICK_URL_SIZE_MORETHEN_MAX" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniWidgetDataSyncModel" : { "type" : "object", "properties" : { "activity_list" : { "type" : "array", "description" : "活动信息列表", "items" : { "$ref" : "#/components/schemas/WidgetActivityInfo" } }, "data_type" : { "type" : "string", "description" : "数据类型，可选值：ACTIVITY(活动数据)、GOODS(商品数据)", "example" : "ACTIVITY" }, "goods_list" : { "type" : "array", "description" : "商品信息列表", "items" : { "$ref" : "#/components/schemas/WidgetGoodsInfo" } }, "mini_app_id" : { "type" : "string", "description" : "商家小程序ID", "example" : "2017072607907880" }, "pid" : { "type" : "string", "description" : "小程序背后的商家，和mini_app_id要求对应", "example" : "2088xxxxxxxxx" } } }, "AlipayOpenMiniWidgetDataSyncResponseModel" : { "type" : "object", "properties" : { "commit_id" : { "type" : "string", "description" : "同步接口生成的唯一标识，用于查询提交数据的审核状态", "example" : "20220829000000000101" } } }, "AlipayOpenMiniWidgetGoodsModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "GOODS_NOT_EXIST", "AUDITING_VERSION_EXIST", "APP_IS_NOT_WIDGET", "PARSE_JSON_ERROR", "APP_INFO_NOT_EXIST", "PARAM_IS_NULL", "WIDGET_DATA_UPLOAD_FREQUENCY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniWidgetGoodsModifyModel" : { "type" : "object", "properties" : { "buying_url" : { "type" : "string", "description" : "需要修改的商品小程序购买链接", "example" : "alipays://platformapi/startapp?appId= 2017072607907880&page=pages/index/index?param=xxxx" }, "goods_brand" : { "type" : "string", "description" : "需要修改的商品品牌", "example" : "肯德基" }, "goods_comment" : { "type" : "string", "description" : "需要修改的商品辅助说明文案", "example" : "这是一个商品辅助说明文案" }, "goods_description_label" : { "type" : "string", "description" : "需要修改的商品说明标签（如-随心退）", "example" : "随心退" }, "goods_id" : { "type" : "string", "description" : "商品的唯一标识，根据该字段修改商品", "example" : "8948968498" }, "goods_label" : { "type" : "string", "description" : "需要修改的商品营销标签（如-限量特价），每个商品仅支持一个营销标签", "example" : "限量特价" }, "goods_name" : { "type" : "string", "description" : "需要修改的商品名称", "example" : "这是一个商品名称" }, "goods_type" : { "type" : "string", "description" : "需要修改的商品所属品类", "example" : "服装" }, "main_pic_url" : { "type" : "string", "description" : "需要修改的商品主图片地址", "example" : "https://xxx.xxx.com/xxx.jpg" }, "need_public_promo" : { "type" : "boolean", "description" : "是否需要进行公域推广", "example" : "true" }, "order_number" : { "type" : "integer", "description" : "需要修改的商品排序，自然整数, 数字越小越靠前", "example" : "1" }, "original_price" : { "type" : "string", "description" : "需要修改的商品原价，单位\"元\"，传入数字，不需要传入\"元\"", "example" : "88.88" }, "publish_cities" : { "type" : "string", "description" : "需要修改的商品投放城市的列表，详见https://www.mca.gov.cn/article/sj/xzqh/2020/2020/202007170301.html，有多个用英文,分隔。如果没有限制则不传入", "example" : "110000" }, "sell_price" : { "type" : "string", "description" : "需要修改的商品售价，位\"元\"，传入数字，不需要传入\"元\"", "example" : "66.66" }, "sell_tag_list" : { "type" : "array", "description" : "需要修改的商品卖点标签", "items" : { "type" : "string" }, "example" : "[\"特惠\",\"热卖\"]" } } }, "AlipayOpenMiniWidgetGoodsModifyResponseModel" : { "type" : "object", "properties" : { "commit_id" : { "type" : "string", "description" : "商品修改返回的提交ID，用于查询商品信息的审核状态", "example" : "20220829000000000101" } } }, "AlipayOpenMiniWidgetGoodsQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "GOODS_PAGE_SIZE_LIMIT", "PAGE_NUM_NO_LESS_ONE", "PARAM_IS_NULL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniWidgetGoodsQueryResponseModel" : { "type" : "object", "properties" : { "data_list" : { "type" : "array", "description" : "商品信息列表", "items" : { "$ref" : "#/components/schemas/GoodsQueryResponse" } }, "page_num" : { "type" : "integer", "description" : "查询第几页", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "查询页面数量", "example" : "10" }, "total" : { "type" : "integer", "description" : "查询结果总数", "example" : "10" } } }, "AlipayOpenMiniWidgetGoodsUploadErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "MINI_APP_ID_ILLEGAL", "PID_ILLEGAL", "GOODS_INFO_ILLEGAL", "PARSE_JSON_ERROR", "PARAM_IS_NULL", "APP_INFO_NOT_EXIST", "GOODS_UPLOAD_FREQUENCY", "APP_IS_NOT_WIDGET", "AUDITING_VERSION_EXIST", "GOODS_EXIST", "WIDGET_DATA_UPLOAD_FREQUENCY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenMiniWidgetGoodsUploadModel" : { "type" : "object", "properties" : { "goods_list" : { "type" : "array", "description" : "商品信息列表", "items" : { "$ref" : "#/components/schemas/WidgetGoodsInfo" } }, "mini_app_id" : { "type" : "string", "description" : "用于承接品的商家小程序ID", "example" : "2017072607907880" }, "pid" : { "type" : "string", "description" : "品的售卖商家，即承接该品的小程序背后的商家。和mini_app_id要求对应", "example" : "2088xxxxxxxxx" } } }, "AlipayOpenMiniWidgetGoodsUploadResponseModel" : { "type" : "object", "properties" : { "commit_id" : { "type" : "string", "description" : "商品提交生成的唯一标识，用于查询商品信息的审核状态", "example" : "20220829000000000101" } } }, "AlipayOpenOperationOpenbizmockTestpathkeyQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "LALALA" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenOperationOpenbizmockTestpathkeyQueryModel" : { "type" : "object", "properties" : { "d" : { "type" : "string", "description" : "4", "example" : "d" } } }, "AlipayOpenOperationOpenbizmockTestpathkeyQueryResponseModel" : { "type" : "object", "properties" : { "result" : { "type" : "string", "description" : "测试", "example" : "success" } } }, "AlipayOpenPublicAccountCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "MENUKEY_NOT_EXIST", "OPEN_ID_IS_ILLEGAL", "BIND_ACCOUNT_FORMAT_ERROR", "APP_INFO_ILLEGAL", "FROM_USER_ID_NULL", "ADD_BIND_ACCOUNT_FAIL", "SAVE_THIRD_ACCOUNT_FAIL", "USERINFO_NOT_EXIST", "BIND_ACCOUNT_NO_NULL", "DISPLAY_NAME_IS_NULL", "DISPLAY_NAME_EXCEED_LENGTH", "REAL_NAME_EXCEED_LENGTH", "EXCEED_THIRD_ACCOUNT_LIMIT", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicAccountCreateModel" : { "type" : "object", "properties" : { "agreement_id" : { "type" : "string", "description" : "账户添加成功，在支付宝与其对应的协议号。如果账户重复添加，接口保证幂等依然视为添加成功，返回此前该账户在支付宝对应的协议号。其他异常该字段不存在。", "example" : "29022222" }, "bind_account_no" : { "type" : "string", "description" : "绑定帐号，建议在开发者的系统中保持唯一性", "example" : "test001" }, "display_name" : { "type" : "string", "description" : "开发者期望在服务窗首页看到的关于该用户的显示信息，最长10个字符", "example" : "test001" }, "from_user_id" : { "type" : "string", "description" : "要绑定的商户会员对应的支付宝userid，2088开头长度为16位的字符串", "example" : "2088801234567890" }, "open_id" : { "type" : "string", "description" : "支付宝用户的唯一标识", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "real_name" : { "type" : "string", "description" : "要绑定的商户会员的真实姓名，最长10个汉字", "example" : "张三" }, "remark" : { "type" : "string", "description" : "备注信息，开发者可以通过该字段纪录其他的额外信息", "example" : "备注信息" } } }, "AlipayOpenPublicAccountCreateResponseModel" : { "type" : "object", "properties" : { "agreement_id" : { "type" : "string", "description" : "协议号，商户会员在支付宝服务窗账号中的唯一标识", "example" : "29022222" } } }, "AlipayOpenPublicAccountDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "OPEN_ID_IS_ILLEGAL", "ACCOUNT_PARAMS_NOT_ENOUGH", "FORBIT_REMOVE_BIND_ACCOUNT", "REMOVE_BIND_ACCOUNT_FAIL", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicAccountDeleteResponseModel" : { "type" : "object" }, "AlipayOpenPublicAccountQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "OPEN_ID_IS_ILLEGAL", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicAccountQueryResponseModel" : { "type" : "object", "properties" : { "public_bind_accounts" : { "type" : "array", "description" : "绑定账户列表", "items" : { "$ref" : "#/components/schemas/StdPublicBindAccount" } } } }, "AlipayOpenPublicAccountResetErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "MENUKEY_NOT_EXIST", "OPEN_ID_IS_ILLEGAL", "BIND_ACCOUNT_FORMAT_ERROR", "APP_INFO_ILLEGAL", "AGREEMENT_ID_NULL", "FROM_USER_ID_NULL", "FORBIT_REMOVE_BIND_ACCOUNT", "REMOVE_BIND_ACCOUNT_FAIL", "DELETE_THIRD_ACCOUNT_FAIL", "FORBIT_REMOVE_OTHER_USER_BIND_AC", "SAVE_THIRD_ACCOUNT_FAIL", "ADD_BIND_ACCOUNT_FAIL", "BIND_ACCOUNT_NO_NULL", "DISPLAY_NAME_IS_NULL", "DISPLAY_NAME_EXCEED_LENGTH", "REAL_NAME_EXCEED_LENGTH", "EXCEED_THIRD_ACCOUNT_LIMIT", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicAccountResetModel" : { "type" : "object", "properties" : { "agreement_id" : { "type" : "string", "description" : "需要重置的协议号，商户会员在支付宝生活号账号中的唯一标识。", "example" : "29022222" }, "bind_account_no" : { "type" : "string", "description" : "绑定帐号，建议在开发者的系统中保持唯一性", "example" : "test002" }, "display_name" : { "type" : "string", "description" : "商户期望在生活号首页看到的关于该用户的显示信息，最长10个字符。\t", "example" : "test002" }, "from_user_id" : { "type" : "string", "description" : "要绑定的商户会员对应的支付宝唯一标识，2088开头长度为16位的字符串。\t", "example" : "2088801234567890" }, "open_id" : { "type" : "string", "description" : "支付宝用户的唯一标识", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "real_name" : { "type" : "string", "description" : "要绑定的商户会员的真实姓名，最长10个汉字", "example" : "张三" }, "remark" : { "type" : "string", "description" : "备注信息，开发者可以通过该字段纪录其他的额外信息", "example" : "备注信息" } } }, "AlipayOpenPublicAccountResetResponseModel" : { "type" : "object", "properties" : { "agreement_id" : { "type" : "string", "description" : "重置后的协议号，商户会员在支付宝服务窗账号中的唯一标识", "example" : "29022223" } } }, "AlipayOpenPublicAdvertBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "BUSINESS_ERROR", "APP_NO_AVAIABLE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicAdvertBatchqueryResponseModel" : { "type" : "object", "properties" : { "advert_list" : { "type" : "array", "description" : "广告位列表 。目前只有一个广告位。", "items" : { "$ref" : "#/components/schemas/Advert" } }, "count" : { "type" : "integer", "description" : "广告组数量", "example" : "1" } } }, "AlipayOpenPublicAdvertCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "PUBLIC_ADVERT_SIZE_INVALID", "PUBLIC_ADVERT_IMGURL_IS_BLANK", "PUBLIC_ADVERT_IMGURL_ILLEGAL", "PUBLIC_ADVERT_LINKURL_IS_BLANK", "PUBLIC_ADVERT_LINKURL_ILLEGAL", "PUBLIC_ADVERT_IMGURL_OVERSIZE", "PUBLIC_ADVERT_LINKURL_OVERSIZE", "LIFE_APP_FILE_TOO_LARGE", "PUBLIC_IMG_TYPE_INVALID", "PUBLIC_ADVERT_EXISTS", "SYSTEM_ERROR", "BUSINESS_ERROR", "SECURITY_CHECK_FAILED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicAdvertCreateModel" : { "type" : "object", "properties" : { "advert_items" : { "type" : "array", "description" : " 广告位轮播内容列表。数量限制：大于1个，小于5个。广告位轮播内容顺序：与接口传入的顺序排列一致。", "items" : { "$ref" : "#/components/schemas/AdvertItem" } } } }, "AlipayOpenPublicAdvertCreateResponseModel" : { "type" : "object", "properties" : { "advert_group" : { "type" : "string", "description" : "广告分组标识", "example" : "default" }, "advert_id" : { "type" : "string", "description" : "广告位id", "example" : "123" } } }, "AlipayOpenPublicAdvertDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_BIZ_PARAMS", "PUBLIC_ADVERT_ID_INVALID", "PUBLIC_ADVERT_NOT_EXISTS", "SYSTEM_ERROR", "BUSINESS_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicAdvertDeleteResponseModel" : { "type" : "object" }, "AlipayOpenPublicAdvertModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "PUBLIC_ADVERT_SIZE_INVALID", "PUBLIC_ADVERT_IMGURL_IS_BLANK", "PUBLIC_ADVERT_IMGURL_ILLEGAL", "PUBLIC_ADVERT_LINKURL_IS_BLANK", "PUBLIC_ADVERT_LINKURL_ILLEGAL", "PUBLIC_ADVERT_IMGURL_OVERSIZE", "PUBLIC_ADVERT_LINKURL_OVERSIZE", "LIFE_APP_FILE_TOO_LARGE", "PUBLIC_IMG_TYPE_INVALID", "PUBLIC_ADVERT_EXISTS", "PUBLIC_ADVERT_ID_INVALID", "PUBLIC_ADVERT_NOT_EXISTS", "SYSTEM_ERROR", "BUSINESS_ERROR", "SECURITY_CHECK_FAILED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicAdvertModifyModel" : { "type" : "object", "properties" : { "advert_id" : { "type" : "string", "description" : "广告位id，通过alipay.open.public.advert.create(生活号广告位添加接口)添加广告位获取。", "example" : "123" }, "advert_items" : { "type" : "array", "description" : "广告位轮播内容列表。数量限制：大于1个，小于5个。广告位轮播内容顺序：与接口传入的顺序排列一致。", "items" : { "$ref" : "#/components/schemas/AdvertItem" } } } }, "AlipayOpenPublicAdvertModifyResponseModel" : { "type" : "object" }, "AlipayOpenPublicArticlesummaryDataBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_BIZ_PARAMS", "SYSTEM_ERROR", "BUSINESS_ERROR", "QUERY_DATE_INVALID" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicArticlesummaryDataBatchqueryModel" : { "type" : "object", "properties" : { "begin_date" : { "type" : "string", "description" : "数据开始日期，时间格式为 \"yyyyMMdd\" 。", "example" : "20171101" }, "end_date" : { "type" : "string", "description" : "数据结束日期，时间格式为\"yyyyMMdd\"。查询数据开始日期/结束日期时间跨度最大30天。", "example" : "20171108" } } }, "AlipayOpenPublicArticlesummaryDataBatchqueryResponseModel" : { "type" : "object", "properties" : { "data_list" : { "type" : "array", "description" : "文章分析数据列表", "items" : { "$ref" : "#/components/schemas/ArticleSummaryAnalysisData" } } } }, "AlipayOpenPublicContactFollowBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_BIZ_PARAMS", "QUERY_CONTACT_FOLLOWER_FORBIDDEN", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicContactFollowBatchqueryResponseModel" : { "type" : "object", "properties" : { "contact_follow_list" : { "type" : "array", "description" : "联系人关注者列表", "items" : { "$ref" : "#/components/schemas/ContactFollower" } } } }, "AlipayOpenPublicDefaultExtensionCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "EXTENSION_AREAS_IS_EMPTY", "AREA_COUNT_INVALID", "ILLEGAL_BIZ_PARAMS", "EXTENSION_PARAM_URL_ERROR", "EXTENSION_PARAM_TYPE_ERROR", "AREA_HEIGHT_IS_INVALID", "GOTO_URL_IS_INVALID", "DEFAULT_EXTENSION_EXIST", "EXTENSION_NAME_TOO_LONG" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicDefaultExtensionCreateModel" : { "type" : "object", "properties" : { "areas" : { "type" : "array", "description" : "默认扩展区列表，最多包含3个扩展区", "items" : { "$ref" : "#/components/schemas/ExtensionArea" } } } }, "AlipayOpenPublicDefaultExtensionCreateResponseModel" : { "type" : "object", "properties" : { "extension_key" : { "type" : "string", "description" : "一套扩展区的key，创建一套扩展区成功后，支付宝会将该字段返回，后续对扩展区进行删除等操作都会用到这个值。", "example" : "10000" } } }, "AlipayOpenPublicFollowBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "QUERY_FOLLOWER_FORBIDDEN", "OPENID_INVALID", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicFollowBatchqueryModel" : { "type" : "object", "properties" : { "next_user_id" : { "type" : "string", "description" : "当关注者数量超过10000时使用，本次拉取数据中第一个用户的userId，从上次接口调用返回值中获取。第一次调用置空", "example" : "2088102146158132" }, "open_id" : { "type" : "string", "description" : "支付宝用户的唯一标识", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } } }, "AlipayOpenPublicFollowBatchqueryResponseModel" : { "type" : "object", "properties" : { "count" : { "type" : "string", "description" : "本次调用获取的userId个数，最大值为10000", "example" : "10000" }, "next_user_id" : { "type" : "string", "description" : "查询分组的userid", "example" : "2088102123322367" }, "open_id" : { "type" : "string", "description" : "支付宝用户的", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "open_id_list" : { "type" : "array", "description" : "支付宝用户的唯一标识列表", "items" : { "type" : "string" }, "example" : "[\"074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5\"]" }, "user_id_list" : { "type" : "array", "description" : "用户的userId列表", "items" : { "type" : "string" }, "example" : "[\"2088102146158132\",\"2088102150429794\",\"2088102150477652\" ]" } } }, "AlipayOpenPublicGroupBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicGroupBatchqueryResponseModel" : { "type" : "object", "properties" : { "groups" : { "type" : "array", "description" : "用户分组列表，包含每个分组的id、name、以及规则模型", "items" : { "$ref" : "#/components/schemas/QueryGroup" } } } }, "AlipayOpenPublicGroupCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "GROUP_CROWD_TOO_SMALL", "GROUP_NAME_IS_EMPTY", "GROUP_NAME_TOO_LONG", "GROUP_NAME_IS_INVALID", "GROUP_NAME_EXISTED", "LABEL_IS_REUSED", "LABEL_ID_IS_EMPTY", "OPERATOR_IS_EMPTY", "OPERATOR_IS_INVALID", "LABEL_VALUE_IS_EMPTY", "LABEL_VALUE_INVALID", "LABEL_NOT_EXISTS" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicGroupCreateModel" : { "type" : "object", "properties" : { "label_rule" : { "type" : "array", "description" : "标签规则，满足该规则的粉丝将被圈定，标签id不能重复", "items" : { "$ref" : "#/components/schemas/ComplexLabelRule" } }, "name" : { "type" : "string", "description" : "分组名称，仅支持中文、字母、数字、下划线的组合。", "example" : "测试分组" } } }, "AlipayOpenPublicGroupCreateResponseModel" : { "type" : "object", "properties" : { "group_id" : { "type" : "string", "description" : "分组id", "example" : "10000" } } }, "AlipayOpenPublicGroupCrowdQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "GROUP_CROWD_TOO_SMALL", "LABEL_IS_REUSED", "LABEL_ID_IS_EMPTY", "OPERATOR_IS_EMPTY", "OPERATOR_IS_INVALID", "LABEL_VALUE_IS_EMPTY", "LABEL_VALUE_INVALID", "LABEL_NOT_EXISTS" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicGroupCrowdQueryModel" : { "type" : "object", "properties" : { "label_rule" : { "type" : "array", "description" : "用户分组的规则项列表，规则项之间元素是与的逻辑，每个规则项内部用多个值表示或的逻辑", "items" : { "$ref" : "#/components/schemas/ComplexLabelRule" } } } }, "AlipayOpenPublicGroupCrowdQueryResponseModel" : { "type" : "object", "properties" : { "count" : { "type" : "string", "description" : "分组圈出的人群数量", "example" : "2000000" } } }, "AlipayOpenPublicGroupDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "GROUP_ID_INVALID", "GROUP_NOT_EXISTED", "GROUP_NOT_ALLOW_DELETE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicGroupDeleteResponseModel" : { "type" : "object" }, "AlipayOpenPublicGroupModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "GROUP_CROWD_TOO_SMALL", "GROUP_NOT_EXISTED", "GROUP_ID_INVALID", "GROUP_NAME_IS_EMPTY", "GROUP_NAME_TOO_LONG", "GROUP_NAME_IS_INVALID", "GROUP_NAME_EXISTED", "LABEL_IS_REUSED", "LABEL_ID_IS_EMPTY", "OPERATOR_IS_EMPTY", "OPERATOR_IS_INVALID", "LABEL_VALUE_IS_EMPTY", "LABEL_VALUE_INVALID", "LABEL_NOT_EXISTS", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicGroupModifyModel" : { "type" : "object", "properties" : { "group_id" : { "type" : "string", "description" : "分组ID，通过alipay.open.public.group.create（用户分组创建接口)\t创建用户分组获取。", "example" : "100" }, "label_rule" : { "type" : "array", "description" : "标签规则，满足该规则的粉丝将被圈定，标签id不能重复", "items" : { "$ref" : "#/components/schemas/ComplexLabelRule" } }, "name" : { "type" : "string", "description" : "分组名称，仅支持中文、字母、数字、下划线的组合。", "example" : "测试分组" } } }, "AlipayOpenPublicGroupModifyResponseModel" : { "type" : "object" }, "AlipayOpenPublicInfoModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PUBLIC_MODIFY_PARAM_ILLEGAL", "APPINFO_NOT_EXIST", "PUBLIC_GREETING_OVERLIMT", "APP_ORDER_AUDING_EXIST", "PUBLIC_ORDER_DAY_LIMIT", "ILLEGAL_LOGO_URL", "PUBLIC_LOGO_NOT_NULL", "ILLEGAL_LICENSE_URL", "PUBLIC_GREETING_ILLEGAL", "APP_NAME_LENGTH_LIMIT", "APP_NAME_ILLEGAL", "APP_NAME_EXIST", "SYSTEM_ERROR", "PUBLIC_NAME_MODIFY_LIMIT", "INTRODUCTION_LENGTH_LIMIT", "ILLEGAL_BACKGROUND_URL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicInfoModifyModel" : { "type" : "object", "properties" : { "app_name" : { "type" : "string", "description" : "生活号名称，2-20个字之间。注意：\t* 不得含有违反法律法规和公序良俗的相关信息；\t* 不得侵害他人名誉权、知识产权、商业秘密等合法权利；\t* 不得以太过广泛的、或产品、行业词组来命名，如：女装、皮革批发；\t* 不得以实名认证的媒体资质账号创建服务窗，或媒体相关名称命名服务窗，如：XX电视台、XX杂志等。", "example" : "生活号名称" }, "auth_pic" : { "type" : "string", "description" : "授权运营书图片地址，企业商户若为被经营方授权，需上传加盖公章的扫描件。支持 .jpg、 .jpeg、 .png 格式，需小于1M。使用 alipay.offline.material.image.upload(上传球房照片和视频接口)上传图片后，将得到的image_url回填与此处。", "example" : "http://pic.alipayobjects.com/e/201311/1ZQ" }, "background_url" : { "type" : "string", "description" : "背景图片地址，建议尺寸 1600 x 1000px，支持.jpg .jpeg .png格式，小于1M。使用 alipay.offline.material.image.upload(上传球房照片和视频接口)上传图片后，将得到的image_url回填与此处。", "example" : "http://pic.alipayobjects.com/e/201311/1ZQ" }, "introduction" : { "type" : "string", "description" : "简介", "example" : "生活号简介" }, "license_url" : { "type" : "string", "description" : "营业执照地址，建议尺寸 320*320 px，支持 .jpg、 .jpeg、 .png 格式，需小于1M。\t使用 alipay.offline.material.image.upload(上传球房照片和视频接口)上传图片后，将得到的image_url回填与此处。", "example" : "http://pic.alipayobjects.com/e/201311/1ZQ" }, "logo_url" : { "type" : "string", "description" : "生活号头像地址，建议尺寸 320*320 px，支持 .jpg、 .jpeg、 .png 格式，需小于1M。\t使用 alipay.offline.material.image.upload(上传球房照片和视频接口)上传图片后，将得到的image_url回填与此处。", "example" : "http://pic.alipayobjects.com/e/201311/1ZQ" }, "notify_url" : { "type" : "string", "description" : "通知地址" }, "public_greeting" : { "type" : "string", "description" : "欢迎语", "example" : "欢迎光临" }, "shop_pics" : { "type" : "array", "description" : "球房照片地址，支持 .jpg、 .jpeg、 .png 格式，需小于1M。\t使用 alipay.offline.material.image.upload(上传球房照片和视频接口)上传图片后，将得到的image_url回填与此处。", "items" : { "type" : "string" }, "example" : "http://pic.alipayobjects.com/e/201311/1ZQ" } } }, "AlipayOpenPublicInfoModifyResponseModel" : { "type" : "object", "properties" : { "audit_desc" : { "type" : "string", "description" : "服务窗审核状态描述", "example" : "审核中" }, "audit_status" : { "type" : "string", "description" : "服务窗审核状态，申请成功后返回AUDITING，等待风控审核", "example" : "AUDITING" } } }, "AlipayOpenPublicInfoQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "APP_NOT_PUBLICAPP" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicInfoQueryResponseModel" : { "type" : "object", "properties" : { "app_name" : { "type" : "string", "description" : "生活号名称", "example" : "生活号名称" }, "audit_desc" : { "type" : "string", "description" : "最新审核状态描述，如果审核驳回则有相关的驳回理由", "example" : "logo图片不符合规范" }, "audit_status" : { "type" : "string", "description" : "最新审核状态，对于系统商而言，只有四个状态，AUDITING：审核中，AUDIT_FAILED：审核驳回，AUDIT_SUCCESS：审核通过，AUDIT_NORMAL：无审核状态（当前没有处于审核过程的工单）", "example" : "AUDITING" }, "audit_status_list" : { "type" : "array", "description" : "审核状态表，目前支持名称、头像、名称与头像、简介审核状态", "items" : { "$ref" : "#/components/schemas/PublicAuditStatus" } }, "background_url" : { "type" : "string", "description" : "背景图片地址", "example" : "http://dl.django.t.taobao.com/rest/1.0/image?fileIds=V9rfg69SSimLZg5wDA3yEgAAACMA" }, "introduction" : { "type" : "string", "description" : "生活号简介", "example" : "简介" }, "is_online" : { "type" : "string", "description" : "生活号是否上线，T表示上线，F表示未上线", "example" : "T" }, "is_release" : { "type" : "string", "description" : "生活号是否上架，T表示上架，上架即可在支付宝客户端被搜索到，F表示未上架", "example" : "F" }, "logo_url" : { "type" : "string", "description" : "生活号头像地址", "example" : "http://pic.alipayobjects.com/e/201311/1ZQ" }, "mcc_code_desc" : { "type" : "string", "description" : "商家经营类目，详情参见 商家经营类目", "example" : "房地产开发商" }, "public_greeting" : { "type" : "string", "description" : "欢迎语", "example" : "欢迎光临" } } }, "AlipayOpenPublicLabelCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_BIZ_PARAMS", "PUBLIC_ID_IS_EMPTY", "LABEL_NAME_IS_EMPTY", "LABEL_NAME_HAS_SPACE", "LABEL_NAME_HAS_COMMA", "LABEL_NAME_TOO_LONG", "LABEL_NAME_ALREADY_EXISTS", "LABEL_COUNT_LIMIT", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicLabelCreateModel" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "标签名", "example" : "测试标签01" } } }, "AlipayOpenPublicLabelCreateResponseModel" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "支付宝返回的标签ID，开发者后续通过该ID进行标签的查询、修改、删除等操作", "example" : "100513" }, "name" : { "type" : "string", "description" : "开发者传入name的值", "example" : "测试标签01" } } }, "AlipayOpenPublicLabelQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicLabelQueryResponseModel" : { "type" : "object", "properties" : { "label_list" : { "type" : "array", "description" : "该服务窗拥有的标签列表", "items" : { "$ref" : "#/components/schemas/PublicLabel" } } } }, "AlipayOpenPublicLabelUserQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_BIZ_PARAMS", "OPEN_ID_IS_ILLEGAL", "FORBIT_QUERY_USER_LABEL", "PUBLIC_ID_IS_EMPTY", "USER_ID_IS_EMPTY", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicLabelUserQueryResponseModel" : { "type" : "object", "properties" : { "label_ids" : { "type" : "string", "description" : "用户标签id列表，以英文逗号分隔", "example" : "100509,100510,100511,100512" } } }, "AlipayOpenPublicLifeAboardApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "LIFE_ALREADY_ON_PLATFORM", "LIFE_ILLEGAL_ISV_APP_ID", "LIFE_NEED_SET_OTHERS", "LIFE_NEED_SET_MENU", "LIFE_HAS_MENU_LINK_ERROR", "LIFE_STATUS_ERROR", "LIFE_NO_SET_NAME", "LIFE_NO_SET_LOGO", "BUSINESS_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicLifeAboardApplyResponseModel" : { "type" : "object", "properties" : { "result" : { "type" : "string", "description" : "上架成功后返回的提示", "example" : "上架成功" } } }, "AlipayOpenPublicLifeAgentcreateQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_OUT_BIZ_NO", "LIFE_NO_EXIST_OUT_BIZ_NO", "LIFE_ILLEGAL_ISV_APP_ID", "BUSINESS_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicLifeAgentcreateQueryResponseModel" : { "type" : "object", "properties" : { "life_app_id" : { "type" : "string", "description" : "只有审核通过，且商户在支付宝发送的授权邮件中确认授权，此时生活号才会正式创建，查询才会返回该值", "example" : "2017062501320531" }, "merchant_pid" : { "type" : "string", "description" : "商户pid", "example" : "2088302109396986" }, "order_status_biz_desc" : { "type" : "string", "description" : "支付宝商户入驻申请单状态，申请单状态包括：暂存、审核中、待商户确认、成功、失败。\t说明：暂存是审核前的中间状态，如出现暂存状态请再次提交代创建生活号申请。", "example" : "审核成功" }, "out_biz_no" : { "type" : "string", "description" : "由开发者创建的外部入驻申请单据号", "example" : "2016070788301823878" }, "refused_reason" : { "type" : "string", "description" : "只有审核失败才会返回该值", "example" : "提供的资质证明不符合要求，请重新上传再试" } } }, "AlipayOpenPublicLifeDebarkApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "LIFE_ALREADY_DEBARK", "LIFE_ILLEGAL_ISV_APP_ID", "BUSINESS_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicLifeDebarkApplyResponseModel" : { "type" : "object", "properties" : { "result" : { "type" : "string", "description" : "下架成功后返回的提示", "example" : "下架成功" } } }, "AlipayOpenPublicLifeLabelBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicLifeLabelBatchqueryResponseModel" : { "type" : "object", "properties" : { "labels" : { "type" : "array", "description" : "标签列表", "items" : { "$ref" : "#/components/schemas/LifeLabel" } } } }, "AlipayOpenPublicLifeLabelCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_BIZ_PARAMS", "ADD_LABEL_NAME_IS_EMPTY", "LABEL_NAME_HAS_SPACE", "LABEL_NAME_HAS_COMMA", "LABEL_NAME_TOO_LONG", "DATA_TYPE_INVALID", "LABEL_NAME_ALREADY_EXISTS", "LABEL_COUNT_LIMIT", "SYSTEM_ERROR", "APP_NO_AVAIABLE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicLifeLabelCreateModel" : { "type" : "object", "properties" : { "data_type" : { "type" : "string", "description" : "标签值类型，不填默认为 string 类型。\t注意：目前只支持 string（字符串类型）。", "example" : "string" }, "label_name" : { "type" : "string", "description" : "自定义标签名。\t注意：每个生活号最多创建 100 个自定义标签。", "example" : "职业" } } }, "AlipayOpenPublicLifeLabelCreateResponseModel" : { "type" : "object", "properties" : { "label_id" : { "type" : "string", "description" : "标签id", "example" : "10000" } } }, "AlipayOpenPublicLifeLabelDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "DEL_LABEL_ID_IS_EMPTY", "LABEL_NOT_EXISTS", "LABEL_IS_USED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicLifeLabelDeleteResponseModel" : { "type" : "object" }, "AlipayOpenPublicLifeLabelModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "MOD_LABEL_ID_IS_EMPTY", "MOD_LABEL_NAME_IS_EMPTY", "LABEL_NAME_HAS_SPACE", "LABEL_NAME_HAS_COMMA", "LABEL_NAME_TOO_LONG", "LABEL_NOT_EXISTS", "LABEL_NAME_ALREADY_EXISTS" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicLifeLabelModifyModel" : { "type" : "object", "properties" : { "label_id" : { "type" : "string", "description" : "标签 id，只支持生活号自定义标签。通过 alipay.open.public.life.label.create(创建标签接口)创建自定义标签后获取。", "example" : "10000" }, "label_name" : { "type" : "string", "description" : "标签名", "example" : "职业" } } }, "AlipayOpenPublicLifeLabelModifyResponseModel" : { "type" : "object" }, "AlipayOpenPublicLifeMsgRecallErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码" }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicLifeMsgRecallModel" : { "type" : "object", "properties" : { "message_id" : { "type" : "string", "description" : "消息id，可在调用群发消息、组发消息接口时会返回，请注意保存留用。", "example" : "2016000000000000" } } }, "AlipayOpenPublicLifeMsgRecallResponseModel" : { "type" : "object" }, "AlipayOpenPublicLifeMsgSendErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_BIZ_PARAMS", "LIFE_APP_NOT_EXISTED", "INVALID_LIFE_APP_MSG_TYPE", "LIFE_APP_MSG_TITLE_EMPTY", "LIFE_APP_COVER_UPLOAD_ERROR", "LIFE_APP_VIDEIO_INFO_MISSED", "LIFE_APP_MSG_CONTENT_EMPTY", "LIFE_APP_MSG_RAW_URL_EMPTY", "LIFE_APP_MSG_CATEGORY_EMPTY", "LIFE_APP_FILE_TOO_LARGE", "LIFE_APP_INVALID_IMAGE_BYTES", "LIFE_APP_MSG_CONTENT_ILLEGAL", "LIFE_APP_MSG_SEND_ERROR", "LIFE_APP_MSG_DESC_EMPTY", "LIFE_APP_MSG_TITLE_TOO_LONG", "LIFE_APP_VIDEO_SOURCE_NOT_EXIST", "LIFE_APP_VIDEO_LENGTH_NOT_RIGHT", "LIFE_MSG_VIDEO_SAMPLES_MISSING", "LIFE_APP_VIDEO_LACK_TEMP_URL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicLifeMsgSendModel" : { "type" : "object", "properties" : { "category" : { "type" : "string", "description" : "消息分类，请传入对应分类编码值", "example" : "c001" }, "content" : { "type" : "string", "description" : "消息正文，html原文或纯文本", "example" : "多云转晴，10°-21°" }, "desc" : { "type" : "string", "description" : "消息概述", "example" : "多云转晴，13-21°" }, "msg_type" : { "type" : "string", "description" : "媒体资讯类生活号消息类型", "example" : "IMAGE-CONTENT： 生活号新图文消息（单条），VIDEO：生活号视频消息（单条）" }, "source_ext_info" : { "type" : "string", "description" : "消息来源方附属信息，供搜索、推荐使用\r\tpublish_time（int）：消息发布时间，单位秒\r\tkeyword_list（String）: 文章的标签列表，英文逗号分隔\r\tcomment（int）：消息来源处评论次数\r\treward（int）：消息来源处打赏次数\r\tis_recommended（boolean）：消息在来源处是否被推荐\r\tis_news（boolean）：消息是否实时性内容\r\tread（int）：消息在来源处被阅读次数\r\tlike（int）：消息在来源处被点赞次数\r\tis_hot（boolean）：消息在来源平台是否是热门内容\r\tshare（int）：文章在来源平台的分享次数\r\tdeadline（int）：文章的失效时间，单位秒", "example" : "{\"is_recommended\":\"true\",\"is_news\":\"true\"}" }, "title" : { "type" : "string", "description" : "消息标题", "example" : "杭州天气预报" }, "unique_msg_id" : { "type" : "string", "description" : "来源方消息唯一标识；若不为空，根据此id和生活号id对消息去重；若为空，不去重", "example" : "2016042810221362" }, "video_length" : { "type" : "string", "description" : "生活号消息视频时长，单位：秒（视频类消息必填）", "example" : "120" }, "video_samples" : { "type" : "array", "description" : "视频类型消息中视频抽样关键帧截图，视频类消息选填", "items" : { "type" : "string" }, "example" : "https://os.alipayobjects.com/rmsportal/SbMPIcOBQLFUXGg.jpg" }, "video_size" : { "type" : "string", "description" : "视频大小，单位：KB（视频类消息必填）", "example" : "1024" }, "video_source" : { "type" : "string", "description" : "视频资源来源id（视频类消息必填），取值限定youku, miaopai, taobao, sina中的一个", "example" : "youku" }, "video_temporary_url" : { "type" : "string", "description" : "视频的临时链接（优酷来源的视频消息，该字段不能为空）", "example" : "https://openhome.alipay.com/platform/home.htm" }, "video_url" : { "type" : "string", "description" : "生活号视频类消息视频id或url（视频类消息必填，根据来源区分）", "example" : "https://open.alipay.com/platform/home.htm" } } }, "AlipayOpenPublicLifeMsgSendResponseModel" : { "type" : "object", "properties" : { "alipay_msg_id" : { "type" : "string", "description" : "生活号消息唯一标识", "example" : "2016042811340001" } } }, "AlipayOpenPublicMatchuserLabelCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_BIZ_PARAMS", "MSG_MATCHER_INVALID", "LABEL_ID_IS_EMPTY", "LABEL_VALUE_IS_EMPTY", "LABEL_VALUE_TOO_LONG", "MATCHER_PARAMS_IS_EMPTY", "MOBILE_NO_INVALID", "IDENTITY_CARD_INVALID", "LABEL_NOT_EXISTS", "DATA_TYPE_INVALID", "NOT_MATCHED_ACCOUNT", "OPEN_ID_IS_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicMatchuserLabelCreateModel" : { "type" : "object", "properties" : { "label_id" : { "type" : "string", "description" : "标签 id，只支持生活号自定义标签。通过 alipay.open.public.life.label.create(创建标签接口)创建自定义标签后获取。", "example" : "10000" }, "label_value" : { "type" : "string", "description" : "标签值，由开发者自主指定，标签值类型要满足 alipay.open.public.life.label.create(创建标签接口)中data_type参数的限定。", "example" : "浙江" }, "matchers" : { "type" : "array", "description" : "支付宝用户匹配器列表，最多传入10条", "items" : { "$ref" : "#/components/schemas/Matcher" } } } }, "AlipayOpenPublicMatchuserLabelCreateResponseModel" : { "type" : "object", "properties" : { "error_count" : { "type" : "integer", "description" : "用户打标失败数量", "example" : "1" }, "error_matchers" : { "type" : "array", "description" : "出错的匹配器列表", "items" : { "$ref" : "#/components/schemas/ErrorMatcher" } } } }, "AlipayOpenPublicMatchuserLabelDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_BIZ_PARAMS", "MSG_MATCHER_INVALID", "LABEL_ID_IS_EMPTY", "MATCHER_PARAMS_IS_EMPTY", "MOBILE_NO_INVALID", "IDENTITY_CARD_INVALID", "LABEL_NOT_EXISTS", "NOT_MATCHED_ACCOUNT", "OPEN_ID_IS_ILLEGAL", "USER_LABEL_NOT_EXISTS" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicMatchuserLabelDeleteModel" : { "type" : "object", "properties" : { "label_id" : { "type" : "string", "description" : "标签 id，只支持生活号自定义标签。通过 alipay.open.public.life.label.create(创建标签接口)创建自定义标签后获取。", "example" : "10000" }, "matchers" : { "type" : "array", "description" : "支付宝用户匹配器列表，最多传入10条", "items" : { "$ref" : "#/components/schemas/Matcher" } } } }, "AlipayOpenPublicMatchuserLabelDeleteResponseModel" : { "type" : "object", "properties" : { "error_count" : { "type" : "integer", "description" : "用户打标失败数量", "example" : "1" }, "error_matchers" : { "type" : "array", "description" : "出错的匹配器列表", "items" : { "$ref" : "#/components/schemas/ErrorMatcher" } } } }, "AlipayOpenPublicMenuBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码" }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicMenuBatchqueryResponseModel" : { "type" : "object", "properties" : { "count" : { "type" : "string", "description" : "菜单数量，包括默认菜单和个性化菜单", "example" : "5" }, "menus" : { "type" : "array", "description" : "菜单列表", "items" : { "$ref" : "#/components/schemas/QueryMenu" } } } }, "AlipayOpenPublicMenuCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_BIZ_PARAMS", "BUTTON_IS_EMPTY", "ICON_IS_EMPTY", "ICON_IS_INVALID", "ILLEGAL_ARGUMENT_PARAMS", "BUSINESS_ERROR", "SYSTEM_ERROR", "MENU_FORMAT_ERROR", "ICON_SIZE_ERROR", "MENU_CHAT_NUMBER_LIMIT", "BUTTON_COUNT_LIMIT", "MENU_TITLE_EMPTY", "ICON_TOO_LARGE", "MENU_TITLE_OUT_OF_LENGTH", "ICON_TYPE_INVALID", "MENU_TYPE_NOTFOUND", "ACTION_PARAM_IS_EMPTY", "MENU_AUTH_NOT_ILLEGAL", "MENU_SECURITY_FORBID", "MENU_SUB_OUT_OF_NUM" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicMenuCreateModel" : { "type" : "object", "properties" : { "button" : { "type" : "array", "description" : "一级菜单列表。说明：\t* 如果是文本菜单，最多有4个一级菜单，若开发者在后台打开了\"咨询反馈\"的开关，则只能有3个一级菜单。\t* 如果是 ICON 菜单信息，最多有80个一级菜单(忽略二级菜单)。", "items" : { "$ref" : "#/components/schemas/ButtonObject" } }, "type" : { "type" : "string", "description" : "菜单类型，不填时默认为 text（文本型菜单）。枚举值如下：\t* text：文本型菜单。\t* icon：表示 icon 型菜单，当传值为\"icon\"时，菜单节点的icon字段必传。", "example" : "text" } } }, "AlipayOpenPublicMenuCreateResponseModel" : { "type" : "object", "properties" : { "menu_key" : { "type" : "string", "description" : "默认菜单菜单key，文本菜单为“default”，icon菜单为“iconDefault”", "example" : "default" } } }, "AlipayOpenPublicMenuDataBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_BIZ_PARAMS", "SYSTEM_ERROR", "BUSINESS_ERROR", "QUERY_DATE_INVALID" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicMenuDataBatchqueryModel" : { "type" : "object", "properties" : { "begin_date" : { "type" : "string", "description" : "数据开始日期，时间格式为 \"yyyyMMdd\" 。", "example" : "20171101" }, "end_date" : { "type" : "string", "description" : "数据结束日期，时间格式为\"yyyyMMdd\"。查询数据开始日期/结束日期时间跨度最大30天。", "example" : "20171108" } } }, "AlipayOpenPublicMenuDataBatchqueryResponseModel" : { "type" : "object", "properties" : { "data_list" : { "type" : "array", "description" : "菜单分析数据列表", "items" : { "$ref" : "#/components/schemas/MenuAnalysisData" } } } }, "AlipayOpenPublicMenuModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_BIZ_PARAMS", "BUTTON_IS_EMPTY", "ICON_IS_EMPTY", "MENU_MODIFY_NOT_EXIST", "SYSTEM_ERROR", "ICON_IS_INVALID", "MENU_NO_BODY", "MENU_CHAT_NUMBER_LIMIT", "BUTTON_COUNT_LIMIT", "MENU_TITLE_EMPTY", "ICON_TOO_LARGE", "MENU_TITLE_OUT_OF_LENGTH", "ICON_TYPE_INVALID", "MENU_TYPE_NOTFOUND", "ACTION_PARAM_IS_EMPTY", "MENU_AUTH_NOT_ILLEGAL", "MENU_SECURITY_FORBID", "MENU_SUB_OUT_OF_NUM" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicMenuModifyModel" : { "type" : "object", "properties" : { "button" : { "type" : "array", "description" : "一级菜单列表。说明：\t* 如果是文本菜单，最多有4个一级菜单，若开发者在后台打开了\"咨询反馈\"的开关，则只能有3个一级菜单。\t* 如果是 ICON 菜单信息，最多有80个一级菜单(忽略二级菜单)。", "items" : { "$ref" : "#/components/schemas/ButtonObject" } }, "type" : { "type" : "string", "description" : "菜单类型，不填时默认为 text（文本型菜单）。枚举值如下：\t* text：文本型菜单。\t* icon：表示 icon 型菜单，当传值为\"icon\"时，菜单节点的icon字段必传。", "example" : "icon" } } }, "AlipayOpenPublicMenuModifyResponseModel" : { "type" : "object" }, "AlipayOpenPublicMenuQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "MENU_NOT_SET", "MENU_NOT_EXIST", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicMenuQueryResponseModel" : { "type" : "object", "properties" : { "menu_content" : { "type" : "string", "description" : "一级菜单数组，个数应为1~4个", "example" : "{\"button\":[{\"actionParam\":\"menu_v01_pay\",\"actionType\":\"in\",\"name\":\"支付\"}]}" } } }, "AlipayOpenPublicMessageContentCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "MSG_CONTENT_TITLE_INVALID", "MSG_CONTENT_COVER_INVALID", "MSG_CONTENT_BODY_INVALID", "MSG_CONTENT_EXTTAGS_INVALID", "MSG_CONTENT_ACTIVITY_INVALID", "MSG_CONTENT_BENEFIT_INVALID", "MSG_CONTENT_PREVIEWIDS_INVALID", "ILLEGAL_BIZ_PARAMS", "SYSTEM_ERROR", "BUSINESS_ERROR", "MSG_CONTENT_SECURITY_INVALID", "MSG_CONTENT_COULDCOMMENT_INVALID", "MSG_CONTENT_ADD_HAS_CONTENTID" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicMessageContentCreateModel" : { "type" : "object", "properties" : { "benefit" : { "type" : "string", "description" : "活动利益点，最多10个字符。仅 ctype 为 activity 类型时才需传入。", "example" : "满**减**" }, "content" : { "type" : "string", "description" : "消息正文（支持富文本）", "example" : "示例" }, "could_comment" : { "type" : "string", "description" : "是否允许评论。枚举支持：\t*T：允许。\t*F：不允许，默认不允许。", "example" : "T" }, "cover" : { "type" : "string", "description" : "封面图url，需传入 图片上传接口上传图片获取的 image_url。\t注意：尺寸为 996*450，最大不超过3M，支持格式：jpg、.png 。", "example" : "https://oalipay-dl-django.alicdn.com/rest/1.0/image?fileIds=xxx&zoom=xxx" }, "ctype" : { "type" : "string", "description" : "图文类型，不填默认普通图文。还支持 activity（活动图文）。", "example" : "activity" }, "ext_tags" : { "type" : "string", "description" : "关键词列表，英文逗号分隔，最多不超过5个", "example" : "关键,热度" }, "login_ids" : { "type" : "string", "description" : "可预览支付宝账号列表，需要预览时才填写， 英文逗号分隔，最多不超过10个", "example" : "13434343432,xxx@163.com" }, "title" : { "type" : "string", "description" : "标题", "example" : "标题" } } }, "AlipayOpenPublicMessageContentCreateResponseModel" : { "type" : "object", "properties" : { "content_id" : { "type" : "string", "description" : "内容id", "example" : "201410323232dsadjada-dsa-1234dsada" }, "content_url" : { "type" : "string", "description" : "内容详情内链url", "example" : "alipays://xxxx" } } }, "AlipayOpenPublicMessageContentModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "MSG_CONTENT_TITLE_INVALID", "MSG_CONTENT_COVER_INVALID", "MSG_CONTENT_BODY_INVALID", "MSG_CONTENT_EXTTAGS_INVALID", "MSG_CONTENT_ACTIVITY_INVALID", "MSG_CONTENT_BENEFIT_INVALID", "MSG_CONTENT_PREVIEWIDS_INVALID", "MSG_CONTENT_ID_INVALID", "MSG_CONTENT_NOT_EXISTS", "MSG_CONTENT_NOT_ALLOW_UPDATE", "ILLEGAL_BIZ_PARAMS", "SYSTEM_ERROR", "BUSINESS_ERROR", "MSG_CONTENT_SECURITY_INVALID", "MSG_CONTENT_COULDCOMMENT_INVALID" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicMessageContentModifyModel" : { "type" : "object", "properties" : { "benefit" : { "type" : "string", "description" : "活动利益点，图文类型ctype为activity类型时才需要传，最多10个字符", "example" : "满**减**" }, "content" : { "type" : "string", "description" : "消息正文（支持富文本）", "example" : "示例" }, "content_id" : { "type" : "string", "description" : "内容id", "example" : "20141032434dsdsada-dsadas-2e32" }, "could_comment" : { "type" : "string", "description" : "是否允许评论 T:允许 F:不允许，默认不允许", "example" : "T" }, "cover" : { "type" : "string", "description" : "封面图url, 尺寸为996*450，最大不超过3M，支持格式:.jpg、.png ，请先调用 图片上传接口获得图片url。", "example" : "https://oalipay-dl-django.alicdn.com/rest/1.0/image?fileIds=xxx&zoom=xxx" }, "ctype" : { "type" : "string", "description" : "图文类型 activity: 活动图文，不填默认普通图文", "example" : "activity" }, "ext_tags" : { "type" : "string", "description" : "关键词列表，英文逗号分隔，最多不超过5个", "example" : "关键,热度" }, "login_ids" : { "type" : "string", "description" : "可预览支付宝账号列表，需要预览时才填写， 英文逗号分隔，最多不超过10个", "example" : "13434343432,xxx@163.com" }, "title" : { "type" : "string", "description" : "标题", "example" : "标题" } } }, "AlipayOpenPublicMessageContentModifyResponseModel" : { "type" : "object", "properties" : { "content_id" : { "type" : "string", "description" : "内容id", "example" : "201410323232dsadjada-dsa-1234dsada" }, "content_url" : { "type" : "string", "description" : "内容详情内链url", "example" : "alipays://xxxx" } } }, "AlipayOpenPublicMessageCustomSendErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PUBLIC_CHANNELS_CONFIG_INVAILD", "MSG_TYPE_ILLEGAL", "OPEN_ID_IS_ILLEGAL", "MSG_SD_NOBEHAVIOR", "SYSTEM_ERROR", "MSG_SD_EVENT_TYPE_NOT_EXISTS", "MSG_SD_FOLLOW_NOT_EXISTS", "MSG_SD_OVER_TIME", "MSG_ENTER_EVENT_OVER_LIMIT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicMessageCustomSendModel" : { "type" : "object", "properties" : { "articles" : { "type" : "array", "description" : "msg_type为image-text，本参数必填。\t", "items" : { "$ref" : "#/components/schemas/Article" } }, "chat" : { "type" : "string", "description" : "是否为聊天消息。枚举支持：\t*0：代表非聊天消息，消息显示在生活号主页，默认为 0。\t*1：代表是聊天消息，消息显示在咨询反馈列表页。", "example" : "0" }, "event_type" : { "type" : "string", "description" : "触发消息的事件类型，默认为空。代表商户未改造。如果是follow，代表关注消息。click代表菜单点击，enter_ppchat代表进入事件；请注意事件类型的大小写", "example" : "follow" }, "msg_type" : { "type" : "string", "description" : "消息类型。枚举支持：\t* text：表示文本消息；\t* image-text：表示图文消息。", "example" : "text" }, "open_id" : { "type" : "string", "description" : "支付宝用户的唯一标识", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "text" : { "$ref" : "#/components/schemas/Text" }, "to_user_id" : { "type" : "string", "description" : "消息接收用户的userid", "example" : "2088283746283746" } } }, "AlipayOpenPublicMessageCustomSendResponseModel" : { "type" : "object" }, "AlipayOpenPublicMessageGroupSendErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "GROUP_EMPTY_ERROR", "ILLEGAL_BIZ_PARAMS", "MSG_BATCH_SD_OVER", "MSG_SEND_ILLEGAL", "IMAGE_SIZE_ERROR", "IMAGE_TOO_LARGE", "ILLEGAL_IMAGE_FORMAT", "MESSAGE_IS_EMPTY", "MESSAGE_IS_INCOMPLETE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicMessageGroupSendModel" : { "type" : "object", "properties" : { "articles" : { "type" : "array", "description" : "图文消息，当 msg_type为image-text，本参数必填。", "items" : { "$ref" : "#/components/schemas/Article" } }, "group_id" : { "type" : "string", "description" : "分组ID，通过alipay.open.public.group.create（用户分组创建接口)\t创建用户分组获取。", "example" : "10000" }, "image" : { "$ref" : "#/components/schemas/Image" }, "msg_type" : { "type" : "string", "description" : "消息类型。枚举支持：\t* text：表示文本消息；\t* image-text：表示图文消息。\t", "example" : "text" }, "text" : { "$ref" : "#/components/schemas/Text" } } }, "AlipayOpenPublicMessageGroupSendResponseModel" : { "type" : "object", "properties" : { "message_id" : { "type" : "string", "description" : "2013121100055554f1000b64-3f05-4581-a5e1-16e29d242950", "example" : "消息ID" } } }, "AlipayOpenPublicMessageLabelSendErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_BIZ_PARAMS", "LABEL_GROUP_FILTER_EMPTY", "LABEL_GROUP_LABEL_OVER_LIMIT", "LABEL_GROUP_KEY_EMPTY", "LABEL_GROUP_ITEM_EMPTY", "LABEL_GROUP_VALUES_EMPTY", "LABEL_GROUP_TPL_EMPTY", "LABEL_GROUP_NO_CONDITION", "LABEL_GROUP_VALUE_NOT_NUMBER", "LABEL_GROUP_LABEL_NOT_EXISTS", "MSG_TYPE_ILLEGAL", "OPEN_ID_IS_ILLEGAL", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicMessageLabelSendModel" : { "type" : "object", "properties" : { "filter" : { "$ref" : "#/components/schemas/Filter" }, "material" : { "$ref" : "#/components/schemas/Material" } } }, "AlipayOpenPublicMessageLabelSendResponseModel" : { "type" : "object" }, "AlipayOpenPublicMessageSingleSendErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "MSG_TEMPLATE_INVALID", "MSG_TEMPLATE_ID_INVALID", "MSG_TEMPLATE_KEY_INVALID", "OPENID_INVALID", "MSG_TEMPLATE_NOT_EXIST", "MSG_TEMPLATE_NOT_STARTED", "MSG_TEMPLATE_CONTEXT_LACK_KEY", "ILLEGAL_ARGUMENT_PARAMS", "SYSTEM_ERROR", "MSG_SD_NOFOLLOW", "APP_NO_AVAIABLE", "BIZ_CONTENT_IS_NULL", "UNFOLLOW_REFUSE_RECOMMONED", "MSG_SEND_FORBIDDEN", "TYPEATEMPLATE_SWITCH_UNSUBSCRIBED", "MSG_SEND_ILLEGAL", "MSG_SINGLE_SD_OVER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicMessageSingleSendModel" : { "type" : "object", "properties" : { "template" : { "$ref" : "#/components/schemas/Template" }, "to_open_id" : { "type" : "string", "description" : "支付宝openId，用于支付宝用户在当前应用下的用户标识。", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "to_user_id" : { "type" : "string", "description" : "消息接收用户的支付宝用户id，用户在支付宝的唯一标识，以 2088 开头的 16 位纯数字组成。", "example" : "2088202882050410" } } }, "AlipayOpenPublicMessageSingleSendResponseModel" : { "type" : "object" }, "AlipayOpenPublicMessageTotalSendErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "MSG_TYPE_ILLEGAL", "OPEN_ID_IS_ILLEGAL", "ILLEGAL_ARGUMENT_PARAMS", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicMessageTotalSendModel" : { "type" : "object", "properties" : { "articles" : { "type" : "array", "description" : "图文消息，当 msg_type为image-text，本参数必填。\t", "items" : { "$ref" : "#/components/schemas/Article" } }, "msg_type" : { "type" : "string", "description" : "消息类型。枚举支持：\t* text：表示文本消息；\t* image-text：表示图文消息。", "example" : "text" }, "text" : { "$ref" : "#/components/schemas/Text" } } }, "AlipayOpenPublicMessageTotalSendResponseModel" : { "type" : "object", "properties" : { "message_id" : { "type" : "string", "description" : "消息ID", "example" : "2013121100055554f1000b64-3f05-4581-a5e1-16e29d242950" } } }, "AlipayOpenPublicPayeeBindCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "AYEEBIND_USER_INVALID", "PAYEEBIND_APP_INVALID", "PAYEEBIND_NOT_SAME_SUBJECT", "PAYEEBIND_LOGIN_ID_HAS_BIND", "PAYEEBIND_COUNT_OVER", "PARAM_NOT_ALLOW_COEXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicPayeeBindCreateModel" : { "type" : "object", "properties" : { "login_id" : { "type" : "string", "description" : "收款账号，需要绑定的收款支付宝账号，请勿与 pid 同时传入。", "example" : "13429393030" }, "pid" : { "type" : "string", "description" : "支付宝用户id，2088开头的16位长度字符串，请勿与 login_id 同时传入。", "example" : "2088344343289143" } } }, "AlipayOpenPublicPayeeBindCreateResponseModel" : { "type" : "object" }, "AlipayOpenPublicPayeeBindDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PAYEEBIND_BIND_NOT_EXIST", "PARAM_NOT_ALLOW_COEXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicPayeeBindDeleteResponseModel" : { "type" : "object" }, "AlipayOpenPublicPersonalizedExtensionBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码" }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicPersonalizedExtensionBatchqueryResponseModel" : { "type" : "object", "properties" : { "count" : { "type" : "integer", "description" : "扩展区套数", "example" : "10" }, "extensions" : { "type" : "array", "description" : "扩展区信息", "items" : { "$ref" : "#/components/schemas/QueryExtension" } } } }, "AlipayOpenPublicPersonalizedExtensionCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "EXTENSION_AREAS_IS_EMPTY", "AREA_COUNT_INVALID", "LABEL_RULES_IS_EMPTY", "RULE_COUNT_INVALID", "ILLEGAL_BIZ_PARAMS", "EXTENSION_PARAM_URL_ERROR", "EXTENSION_PARAM_TYPE_ERROR", "AREA_HEIGHT_IS_INVALID", "GOTO_URL_IS_INVALID", "LABEL_ID_IS_EMPTY", "LABEL_VALUE_IS_EMPTY", "LABEL_VALUE_INVALID", "LABEL_NOT_EXISTS", "RULE_CONTENT_INVALID" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicPersonalizedExtensionCreateModel" : { "type" : "object", "properties" : { "areas" : { "type" : "array", "description" : "扩展区列表，最大条数为3", "items" : { "$ref" : "#/components/schemas/ExtensionArea" } }, "label_rule" : { "type" : "array", "description" : "标签规则，目前限定只能传入1条，在扩展区上线后，满足该标签规则的用户进入生活号首页，将看到该套扩展区。生成标签及打标详情参见标签管理。", "items" : { "$ref" : "#/components/schemas/LabelRule" } } } }, "AlipayOpenPublicPersonalizedExtensionCreateResponseModel" : { "type" : "object", "properties" : { "extension_key" : { "type" : "string", "description" : "扩展区套id。创建个性化扩展区成功后，支付宝会将该字段返回，后续扩展区上下线或者扩展区删除都会用到这个值。", "example" : "10000" } } }, "AlipayOpenPublicPersonalizedExtensionDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "EXTENSION_KEY_IS_EMPTY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicPersonalizedExtensionDeleteResponseModel" : { "type" : "object" }, "AlipayOpenPublicPersonalizedMenuCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BUTTON_IS_EMPTY", "BUTTON_COUNT_LIMIT", "MENU_TITLE_EMPTY", "MENU_TITLE_OUT_OF_LENGTH", "MENU_TYPE_NOTFOUND", "MENU_SUB_OUT_OF_NUM", "ICON_IS_EMPTY", "ACTION_PARAM_IS_EMPTY", "ICON_IS_INVALID", "ICON_SIZE_ERROR", "ICON_TOO_LARGE", "ICON_TYPE_INVALID", "LABEL_RULES_IS_EMPTY", "RULE_COUNT_INVALID", "LABEL_ID_IS_EMPTY", "LABEL_VALUE_IS_EMPTY", "LABEL_VALUE_INVALID", "LABEL_NOT_EXISTS", "MENU_SECURITY_FORBID", "LABEL_IS_REUSED", "OPERATOR_IS_EMPTY", "OPERATOR_IS_INVALID", "GROUP_ID_IS_INVALID", "GROUP_NOT_READY", "GROUP_NOT_EXISTED", "NOT_SUPPORT_GROUP", "MENU_NUMBER_LIMIT", "ICON_NOT_SUPPORT_SUB_MENU", "SECURITY_CHECK_FAILED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicPersonalizedMenuCreateModel" : { "type" : "object", "properties" : { "button" : { "type" : "array", "description" : "一级菜单列表。说明：\t* 如果是文本菜单，最多有4个一级菜单，若开发者在后台打开了\"咨询反馈\"的开关，则只能有3个一级菜单。\t* 如果是 ICON 菜单信息，最多有80个一级菜单(忽略二级菜单)。", "items" : { "$ref" : "#/components/schemas/ButtonObject" } }, "group_id" : { "type" : "string", "description" : "人群分组id。分组创建及管理接入详情参见 分组管理。\t注意：group_id 与 label_rule（标签规则）不能同时为空。", "example" : "RQ20190917100100000001" }, "label_rule" : { "type" : "array", "description" : "标签规则，目前限定只能传入1条，在个性化菜单创建成功后，满足该标签规则的用户进入生活号首页，将看到该套菜单。生成标签及打标详情参见标签管理。\t注意：group_id（人群分组id） 与 label_rule 不能同时为空。", "items" : { "$ref" : "#/components/schemas/LabelRule" } }, "mobile_client_type" : { "type" : "string", "description" : "手机客户端类型，枚举支持：\t*iphone；\t*android；\t*wp；\t说明：不填为不区分机型。", "example" : "android" }, "type" : { "type" : "string", "description" : "菜单类型，不填时默认为 text（文本型菜单）。枚举值如下：\t* text：文本型菜单。\t* icon：表示 icon 型菜单，当传值为\"icon\"时，菜单节点的icon字段必传。", "example" : "text" } } }, "AlipayOpenPublicPersonalizedMenuCreateResponseModel" : { "type" : "object", "properties" : { "menu_key" : { "type" : "string", "description" : "该套个性化菜单key", "example" : "100000" } } }, "AlipayOpenPublicPersonalizedMenuDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_BIZ_PARAMS", "MENU_KEY_IS_EMPTY", "MENU_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicPersonalizedMenuDeleteResponseModel" : { "type" : "object" }, "AlipayOpenPublicQrcodeCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARSE_XML_JSON_ERROR", "ILLEGAL_BIZ_PARAMS", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicQrcodeCreateModel" : { "type" : "object", "properties" : { "code_info" : { "$ref" : "#/components/schemas/CodeInfo" }, "code_type" : { "type" : "string", "description" : "二维码类型，目前只支持两种类型：\r\tTEMP：临时的（默认）；\r\tPERM：永久的", "example" : "TEMP" }, "expire_second" : { "type" : "string", "description" : "临时码过期时间，以秒为单位，最大不超过1800秒；\r\t永久码置空", "example" : "1000" }, "show_logo" : { "type" : "string", "description" : "二维码中间是否显示服务窗logo，Y：显示；N：不显示（默认）", "example" : "N" } } }, "AlipayOpenPublicQrcodeCreateResponseModel" : { "type" : "object", "properties" : { "code_img" : { "type" : "string", "description" : "二维码图片地址，可跳转到实际图片", "example" : "https://mobilecodec.alipay.com/show.htm?code=ppx086640jutnzjgx5ghxf7&picSize=M" }, "expire_second" : { "type" : "string", "description" : "二维码有效时间，单位（秒）。永久码暂时忽略该信息", "example" : "1800" } } }, "AlipayOpenPublicSettingCategoryQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicSettingCategoryQueryResponseModel" : { "type" : "object", "properties" : { "primary_category" : { "type" : "string", "description" : "已设置的一级行业分类名称。\t", "example" : "电子商务" }, "secondary_category" : { "type" : "string", "description" : "已设置的二级行业分类名称。", "example" : "酒店" } } }, "AlipayOpenPublicShortlinkCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARSE_XML_JSON_ERROR", "PUBLIC_ID_IS_NULL", "SCENE_ID_IS_NULL", "INVALID_SCENE_ID", "APP_NOT_EXIST", "SHORT_LINK_GENERATE_FAIL", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicShortlinkCreateModel" : { "type" : "object", "properties" : { "remark" : { "type" : "string", "description" : "对于场景 ID 的描述，由商户自定义。", "example" : "球房1支付推广" }, "scene_id" : { "type" : "string", "description" : "短链接对应的场景 ID。由商户自定义，仅支持数字、字母及下划线。", "example" : "store_pay_01" } } }, "AlipayOpenPublicShortlinkCreateResponseModel" : { "type" : "object", "properties" : { "shortlink" : { "type" : "string", "description" : "生成的带参推广短链接", "example" : "http://t.alipay.com/I/Ev62jVRm" } } }, "AlipayOpenPublicSinglearticleDataBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_BIZ_PARAMS", "SYSTEM_ERROR", "BUSINESS_ERROR", "QUERY_DATE_INVALID" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicSinglearticleDataBatchqueryModel" : { "type" : "object", "properties" : { "begin_date" : { "type" : "string", "description" : "数据开始日期，时间格式为 \"yyyyMMdd\" 。", "example" : "20171101" }, "end_date" : { "type" : "string", "description" : "数据结束日期，时间格式为\"yyyyMMdd\"。查询数据开始日期/结束日期时间跨度最大30天。", "example" : "20171108" } } }, "AlipayOpenPublicSinglearticleDataBatchqueryResponseModel" : { "type" : "object", "properties" : { "data_list" : { "type" : "array", "description" : "单篇文章分析数据列表", "items" : { "$ref" : "#/components/schemas/SingleArticleAnalysisData" } } } }, "AlipayOpenPublicTemplateMessageGetErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "TEMPLATE_MESSAGE_ID_INVAILD", "BUSINESS_ERROR", "ILLEGAL_BIZ_PARAMS", "APPINFO_NOT_EXIST", "PUBLIC_NOT_ONLINE", "NEED_SELECT_INDUSTRY", "EXCEED_MAX_TEMPLATE_NUM", "APP_NOT_PUBLICAPP" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicTemplateMessageGetResponseModel" : { "type" : "object", "properties" : { "msg_template_id" : { "type" : "string", "description" : "消息模板id--商户领取母版后生成的唯一模板id", "example" : "14330d60f0ab4516853a0900827cee35" }, "template" : { "type" : "string", "description" : "模板内容", "example" : "{\"appId\":\"${ALIPAY.appId}\",\"createTime\":${ALIPAY.createTime},\"toUserId\":\"${ALIPAY.toUserId}\",\"msgType\":\"text\",\"push\":\"true\"}" } } }, "AlipayOpenPublicTemplateMessageIndustryModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PUB.ILLEGAL_BIZ_PARAMS", "PUB.BIZ_CONTENT_IS_NULL", "PUB.APPINFO_NOT_EXIST", "PUB.PUBLIC_NOT_ONLINE", "PUB.MODIFY_OVER_LIMIT", "PUB.NEED_DELETE_MSG_TEMPLATES" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicTemplateMessageIndustryModifyModel" : { "type" : "object", "properties" : { "primary_industry_code" : { "type" : "string", "description" : "服务窗消息模板所属主行业一/二级编码，参见 查看行业信息。", "example" : "10001/20102" }, "primary_industry_name" : { "type" : "string", "description" : "服务窗消息模板所属主行业一/二级名称，参见 查看行业信息。", "example" : "IT科技/IT软件与服务" }, "secondary_industry_code" : { "type" : "string", "description" : "服务窗消息模板所属副行业一/二级编码，参见 查看行业信息。", "example" : "10001/20102" }, "secondary_industry_name" : { "type" : "string", "description" : "服务窗消息模板所属副行业一/二级名称，参见 查看行业信息。", "example" : "IT科技/IT软件与服务" } } }, "AlipayOpenPublicTemplateMessageIndustryModifyResponseModel" : { "type" : "object" }, "AlipayOpenPublicTopicBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "BUSINESS_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicTopicBatchqueryResponseModel" : { "type" : "object", "properties" : { "topic_list" : { "type" : "array", "description" : "营销位列表", "items" : { "$ref" : "#/components/schemas/Topic" } } } }, "AlipayOpenPublicTopicCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_BIZ_PARAMS", "TOPIC_SIZE_INVALID", "TOPIC_TITLE_INVALID", "TOPIC_SHOW_IMG_PARAM_INVALID", "TOPIC_SUBTITLE_INVALID", "TOPIC_IMGURL_INVALID", "TOPIC_LINKURL_INVALID", "TOPIC_ITEM_IMGURL_INVALID", "TOPIC_ITEM_LINKURL_INVALID", "TOPIC_ITEM_TITLE_INVALID", "TOPIC_ITEM_SUBTITLE_INVALID", "LIFE_APP_FILE_TOO_LARGE", "PUBLIC_IMG_TYPE_INVALID", "TOPIC_EXISTS", "BUSINESS_ERROR", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicTopicCreateModel" : { "type" : "object", "properties" : { "img_url" : { "type" : "string", "description" : "营销位图片url, 尺寸为996*450，最大不超过5M，支持格式:.jpg、.png ，请先调用 图片上传接口获得图片url。营销位需要展示头图时，必须填写该参数。", "example" : "https://oalipay-dl-django.alicdn.com/rest/1.0/image?fileIds=xxx&zoom=xxx" }, "link_type" : { "type" : "string", "description" : "跳转类型，网页:HTTP、小程序:APP，不传默认HTTP", "example" : "HTTP" }, "link_url" : { "type" : "string", "description" : "营销位跳转地址，点击营销位头图跳到的链接url。营销位需要展示头图时，必须填写该参数。", "example" : "https://www.alipay.com" }, "sub_title" : { "type" : "string", "description" : "营销位描述。营销位需要展示头图时，必须填写该参数。", "example" : "营销位描述" }, "title" : { "type" : "string", "description" : "营销位名称", "example" : "营销位名称" }, "topic_items" : { "type" : "array", "description" : "营销位内容，数量限制：大于4个，小于8个", "items" : { "$ref" : "#/components/schemas/TopicItem" } } } }, "AlipayOpenPublicTopicCreateResponseModel" : { "type" : "object", "properties" : { "topic_id" : { "type" : "string", "description" : "营销位id", "example" : "123" } } }, "AlipayOpenPublicTopicDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_BIZ_PARAMS", "TOPIC_ID_INVALID", "TOPIC_NOT_EXISTS", "SYSTEM_ERROR", "BUSINESS_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicTopicDeleteResponseModel" : { "type" : "object" }, "AlipayOpenPublicTopicModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_BIZ_PARAMS", "TOPIC_SIZE_INVALID", "TOPIC_TITLE_INVALID", "TOPIC_SHOW_IMG_PARAM_INVALID", "TOPIC_SUBTITLE_INVALID", "TOPIC_IMGURL_INVALID", "TOPIC_LINKURL_INVALID", "TOPIC_ITEM_IMGURL_INVALID", "TOPIC_ITEM_LINKURL_INVALID", "TOPIC_ITEM_TITLE_INVALID", "TOPIC_ITEM_SUBTITLE_INVALID", "LIFE_APP_FILE_TOO_LARGE", "PUBLIC_IMG_TYPE_INVALID", "BUSINESS_ERROR", "SYSTEM_ERROR", "TOPIC_ID_INVALID", "TOPIC_NOT_EXISTS" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicTopicModifyModel" : { "type" : "object", "properties" : { "img_url" : { "type" : "string", "description" : "营销位图片url, 尺寸为996*450，最大不超过5M，支持格式:.jpg、.png ，请先调用 图片上传接口获得图片url。营销位需要展示头图时，必须填写该参数。", "example" : "https://oalipay-dl-django.alicdn.com/rest/1.0/image?fileIds=xxx&zoom=xxx" }, "link_type" : { "type" : "string", "description" : "跳转类型，网页:HTTP、小程序:APP，不传默认HTTP", "example" : "HTTP" }, "link_url" : { "type" : "string", "description" : "营销位跳转地址，点击营销位头图跳到的链接url。营销位需要展示头图时，必须填写该参数。", "example" : "https://www.alipay.com" }, "sub_title" : { "type" : "string", "description" : "营销位描述。营销位需要展示头图时，必须填写该参数", "example" : "营销位描述" }, "title" : { "type" : "string", "description" : "营销位名称", "example" : "营销位名称" }, "topic_id" : { "type" : "string", "description" : "营销位id", "example" : "123" }, "topic_items" : { "$ref" : "#/components/schemas/TopicItem" } } }, "AlipayOpenPublicTopicModifyResponseModel" : { "type" : "object" }, "AlipayOpenPublicUserDataBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_BIZ_PARAMS", "SYSTEM_ERROR", "BUSINESS_ERROR", "QUERY_DATE_INVALID" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicUserDataBatchqueryModel" : { "type" : "object", "properties" : { "begin_date" : { "type" : "string", "description" : "数据开始日期，时间格式为 \"yyyyMMdd\" 。\t", "example" : "20171101" }, "end_date" : { "type" : "string", "description" : "数据结束日期，时间格式为\"yyyyMMdd\"。查询数据开始日期/结束日期时间跨度最大30天。", "example" : "20171108" } } }, "AlipayOpenPublicUserDataBatchqueryResponseModel" : { "type" : "object", "properties" : { "data_list" : { "type" : "array", "description" : "用户分析数据", "items" : { "$ref" : "#/components/schemas/UserAnalysisData" } } } }, "AlipayOpenPublicUserFollowQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_BIZ_PARAMS", "SYSTEM_ERROR", "BUSINESS_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenPublicUserFollowQueryResponseModel" : { "type" : "object", "properties" : { "is_follow" : { "type" : "string", "description" : "用户是否关注。枚举值如下：\t*T：代表已关注。\t*F：代表未关注。", "example" : "T" } } }, "AlipayOpenSearchAbilityBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "BIZ_ERROR", "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchAbilityBatchqueryModel" : { "type" : "object", "properties" : { "biz_data" : { "$ref" : "#/components/schemas/SearchOperPageQueryRequest" }, "biz_type" : { "type" : "string", "description" : "表示修改内容的业务类型", "example" : "SEARCH_ABILITY_BATCH_QUERY" }, "opt_type" : { "type" : "string", "description" : "进行具体操作的类型比如：query", "example" : "query" } } }, "AlipayOpenSearchAbilityBatchqueryResponseModel" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AbilityPageQueryDTO" } } }, "AlipayOpenSearchAppkeywordApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "NO_PERMISSION", "APP_NOT_ONLINE", "MINI_APP_CAN_NOT_SEARCH", "KEYWORDS_EXCEED_MAX_LIMIT", "INVALID_PARAMETER", "SYSTEM_ERROR", "OPERATE_TOO_FAST", "SYSTEM_BUSY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchAppkeywordApplyModel" : { "type" : "object", "properties" : { "config_id" : { "type" : "string", "description" : "关键词id，（仅修改时传入，修改时仅能传一个关键词）", "example" : "20221108000000245181" }, "key_words" : { "type" : "array", "description" : "提报的关键词", "items" : { "type" : "string" }, "example" : "[\"关键词1\",\"关键词2\"]" }, "target_appid" : { "type" : "string", "description" : "小程序id", "example" : "2021001120654127" } } }, "AlipayOpenSearchAppkeywordApplyResponseModel" : { "type" : "object", "properties" : { "apply_no" : { "type" : "string", "description" : "提报之后的后台审核工单的id", "example" : "20220524000000113288" } } }, "AlipayOpenSearchAppkeywordBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "NO_PERMISSION", "APP_NOT_ONLINE", "MINI_APP_CAN_NOT_SEARCH", "SYSTEM_ERROR", "INVALID_PARAMETER", "OPERATE_TOO_FAST", "SYSTEM_BUSY", "UN_SUPPORT_SEARCH_BOX_STATUS" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchAppkeywordBatchqueryResponseModel" : { "type" : "object", "properties" : { "key_word_info" : { "type" : "array", "description" : "审核通过关键词明细", "items" : { "$ref" : "#/components/schemas/KeyWordInfo" } }, "page_number" : { "type" : "integer", "description" : "第几页", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "每页条数", "example" : "10" }, "total_count" : { "type" : "integer", "description" : "总条数", "example" : "1234" }, "total_page_count" : { "type" : "integer", "description" : "总页数", "example" : "123" } } }, "AlipayOpenSearchAppkeywordDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "NO_PERMISSION", "APP_NOT_ONLINE", "MINI_APP_CAN_NOT_SEARCH", "SYSTEM_ERROR", "INVALID_PARAMETER", "INVALID_STATUS", "SYSTEM_BUSY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchAppkeywordDeleteModel" : { "type" : "object", "properties" : { "config_id" : { "type" : "string", "description" : "关键词配置ID", "example" : "20220513000000165607" }, "key_words" : { "type" : "array", "description" : "需要删除的生效关键词", "items" : { "type" : "string" }, "example" : "[\"关键词1\",\"关键词2\"]" }, "target_appid" : { "type" : "string", "description" : "小程序id", "example" : "2021001120654127" } } }, "AlipayOpenSearchAppkeywordDeleteResponseModel" : { "type" : "object" }, "AlipayOpenSearchAppkeywordQuerystatusErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "NO_PERMISSION", "APP_NOT_ONLINE", "MINI_APP_CAN_NOT_SEARCH", "SYSTEM_ERROR", "INVALID_PARAMETER", "OPERATE_TOO_FAST", "SYSTEM_BUSY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchAppkeywordQuerystatusResponseModel" : { "type" : "object", "properties" : { "key_words" : { "type" : "array", "description" : "关键词工单审核状态返回值", "items" : { "$ref" : "#/components/schemas/KeyWordInfo" } } } }, "AlipayOpenSearchAppkeywordquotaQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "NO_PERMISSION", "APP_NOT_ONLINE", "MINI_APP_CAN_NOT_SEARCH", "SYSTEM_ERROR", "INVALID_PARAMETER", "OPERATE_TOO_FAST", "SYSTEM_BUSY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchAppkeywordquotaQueryResponseModel" : { "type" : "object", "properties" : { "quota_num" : { "type" : "string", "description" : "剩余可配置额度数量，返回具体数字", "example" : "1" } } }, "AlipayOpenSearchBaseorderModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "BIZ_ERROR", "SYSTEM_ERROR", "INVALID_PARAMETER", "SYSTEM_BUSY", "NOT_ALLOWED_OPERATE", "SEARCH_KEYWORD_CONFIG_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchBaseorderModifyModel" : { "type" : "object", "properties" : { "biz_data" : { "$ref" : "#/components/schemas/SearchBaseOrderCreateApiRequest" }, "biz_type" : { "type" : "string", "description" : "表示修改内容的业务类型", "example" : "SEARCH_ORDER_CREATE" }, "opt_type" : { "type" : "string", "description" : "操作的具体类型", "example" : "set" } } }, "AlipayOpenSearchBaseorderModifyResponseModel" : { "type" : "object", "properties" : { "apply_id" : { "type" : "string", "description" : "工单id", "example" : "23343434********" } } }, "AlipayOpenSearchBoxApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "NO_PERMISSION", "BRAND_HAS_CONFIG_SEARCH_BOX", "APP_HAS_CONFIG_SEARCH_BOX", "INVALID_PARAMETER", "ISV_NOT_AUTH", "RELATED_ACCOUNT_NO_TINY_APP", "SYSTEM_ERROR", "SEARCH_BOX_ACCESS_CHECK_FAIL", "MERCHANT_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchBoxApplyModel" : { "type" : "object", "properties" : { "area_keywords" : { "type" : "array", "description" : "小程序直达配置的常用服务中带有球房信息时，可添加简称触发词", "items" : { "type" : "string" }, "example" : "[\"简称触发词\"]" }, "box_desc" : { "type" : "string", "description" : "品牌介绍，5-15个中文字符。\t小程序直达不支持设置此项", "example" : "品牌介绍" }, "brand_id" : { "type" : "string", "description" : "品牌id，参考 品牌认证说明 ", "example" : "1000467882" }, "business_benefit_switch" : { "type" : "boolean", "description" : "可通过配置来开启商圈权益模块，关闭后搜索直达不展示商圈权益模块", "example" : "true" }, "business_district_ids" : { "type" : "array", "description" : "小程序已关联商圈时，可添加商圈id（目前仅对品牌直达开放，小程序直达暂未开放）", "items" : { "type" : "string" }, "example" : "[\"商圈id\"]" }, "custom_keywords" : { "type" : "array", "description" : "自定义触发词，最多可配置6个，限1-8个中文字符。\t小程序直达不支持设置此项", "items" : { "type" : "string" }, "example" : "[\"自定义触发词\"]" }, "image_id" : { "type" : "string", "description" : "氛围图片id，调用 支付宝文件上传接口 上传图片获取图片id(bizCode：search_box_atmosphere)。 图片规范 \t小程序直达不支持设置此项。", "example" : "A*oZQmT4xTBPUAAAAAAAAAAAAAAQAAAQ" }, "image_name" : { "type" : "string", "description" : "氛围图片名。\t小程序直达不支持设置此项", "example" : "氛围图1" }, "merchant_id" : { "type" : "string", "description" : "商户id，代运营模式下传入。代运营模式，需要服务商已获得商家\"运营支付宝小程序\"授权。", "example" : "2088xxxxxxxxxxxx" }, "related_accounts" : { "type" : "array", "description" : "关联账号信息，1-2个。\t内部字段均需设置。当为品牌直达时，数组中的第1个账号会被设置为\"账号1\"，也就是将作为搜索直达专区头部的跳转地址", "items" : { "$ref" : "#/components/schemas/SearchBoxAppInfo" } }, "service_infos" : { "type" : "array", "description" : "服务信息，服务必须审核通过才能申请搜索直达。品牌直达最多可配置同一品牌认证下的小程序4个，小程序直达最多可配置2个。\t内部字段均需设置。", "items" : { "$ref" : "#/components/schemas/SearchBoxServiceInfo" } }, "target_appid" : { "type" : "string", "description" : "小程序id，小程序直达时必传，需要和申请的商户主体保持一致，且符合 准入类目 ", "example" : "2018092561507369" } } }, "AlipayOpenSearchBoxApplyResponseModel" : { "type" : "object", "properties" : { "box_id" : { "type" : "string", "description" : "搜索直达配置id", "example" : "20220117000000112680" } } }, "AlipayOpenSearchBoxBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INPUT_ARGUMENT_NULL", "INPUT_ARGUMENT_ILLEGAL", "ISV_NOT_AUTH", "NO_PERMISSION", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchBoxBatchqueryModel" : { "type" : "object", "properties" : { "merchant_id" : { "type" : "string", "description" : "商户id，代运营模式下传入。代运营模式，需要服务商已获得商家\"运营支付宝小程序\"授权。", "example" : "2088xxxxxxxxxxxx" }, "page_number" : { "type" : "integer", "description" : "分页查询的当前页号,从1开始", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "每页查询的数量，默认10，不得超过50", "example" : "10" } } }, "AlipayOpenSearchBoxBatchqueryResponseModel" : { "type" : "object", "properties" : { "box_infos" : { "type" : "array", "description" : "搜索直达基础信息", "items" : { "$ref" : "#/components/schemas/SearchBoxBasicInfo" } }, "page_number" : { "type" : "integer", "description" : "当前页码", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "每页记录数", "example" : "10" }, "total_count" : { "type" : "integer", "description" : "总记录数", "example" : "100" }, "total_page_count" : { "type" : "integer", "description" : "总页数", "example" : "5" } } }, "AlipayOpenSearchBoxConsultErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "ISV_NOT_AUTH", "INPUT_ARGUMENT_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchBoxConsultModel" : { "type" : "object", "properties" : { "area_keywords" : { "type" : "string", "description" : "小程序直达配置的常用服务中带有球房信息时，可添加简称触发词", "example" : "简称触发词" }, "box_desc" : { "type" : "string", "description" : "品牌介绍，5-15个中文字符。 \t小程序直达不支持设置此项", "example" : "品牌介绍" }, "brand_id" : { "type" : "string", "description" : "品牌id，参考品牌认证说明", "example" : "1000467882" }, "business_benefit_switch" : { "type" : "boolean", "description" : "可通过配置来开启商圈权益模块，关闭后搜索直达不展示商圈权益模块", "example" : "true" }, "business_district_ids" : { "type" : "array", "description" : "小程序已关联商圈时，可添加商圈id（目前仅对品牌直达开放，小程序直达暂未开放）", "items" : { "type" : "string" }, "example" : "[\"商圈id\"]" }, "custom_keywords" : { "type" : "array", "description" : "自定义触发词，最多可配置6个，限1-8个中文字符。 \t小程序直达不支持设置此项", "items" : { "type" : "string" }, "example" : "[\"自定义触发词\"]" }, "image_id" : { "type" : "string", "description" : "氛围图片id，调用 支付宝文件上传接口 上传图片获取图片id(bizCode：search_box_atmosphere)。 图片规范 \t小程序直达不支持设置此项。", "example" : "A*oZQmT4xTBPUAAAAAAAAAAAAAAQAAAQ" }, "image_name" : { "type" : "string", "description" : "氛围图片名。 \t小程序直达不支持设置此项", "example" : "氛围图1" }, "merchant_id" : { "type" : "string", "description" : "商户id，代运营模式下传入。代运营模式，需要服务商已获得商家\"运营支付宝小程序\"授权。", "example" : "2088xxxxxxxxxxxx" }, "related_accounts" : { "type" : "array", "description" : "关联账号信息，1-2个。 内部字段均需设置。", "items" : { "$ref" : "#/components/schemas/SearchBoxAppInfo" } }, "service_infos" : { "type" : "array", "description" : "服务信息，服务必须审核通过才能申请搜索直达。 内部字段均需设置。", "items" : { "$ref" : "#/components/schemas/SearchBoxServiceInfo" } }, "target_appid" : { "type" : "string", "description" : "小程序id，小程序直达时必传，需要和申请的商户主体保持一致，且符合准入类目", "example" : "2018092561XXXXXX" } } }, "AlipayOpenSearchBoxConsultResponseModel" : { "type" : "object", "properties" : { "access" : { "type" : "boolean", "description" : "是否准入，false代表不准入", "example" : "true" }, "not_pass_items" : { "type" : "array", "description" : "不准入项列表。不准入项用字符串描述，可参照接口文档和准入条件，进行调整以达到申请要求", "items" : { "type" : "string" }, "example" : "[\"小程序未设置搜索可见\"]" } } }, "AlipayOpenSearchBoxModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "NO_PERMISSION", "SYSTEM_ERROR", "ISV_NOT_AUTH", "RELATED_ACCOUNT_NO_TINY_APP", "STATUS_NOT_ALLOWED_OPERATE", "APP_HAS_CONFIG_SEARCH_BOX", "BUSINESS_DISTRICT_HAS_SEARCH_BOX" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchBoxModifyModel" : { "type" : "object", "properties" : { "area_keywords" : { "type" : "array", "description" : "小程序直达配置的常用服务中带有球房信息时，可添加简称触发词", "items" : { "type" : "string" }, "example" : "[\"简称触发词\"]" }, "box_desc" : { "type" : "string", "description" : "品牌介绍，5-15个中文字符。当修改品牌介绍模块(module_type=BOX_EXCLUSIVE_BASE)时传入。\t小程序直达时不支持设置", "example" : "品牌介绍" }, "box_id" : { "type" : "string", "description" : "搜索直达配置id", "example" : "20220308000000128693" }, "brand_id" : { "type" : "string", "description" : "品牌id，参考 品牌认证说明 ", "example" : "1000467882" }, "business_benefit_switch" : { "type" : "boolean", "description" : "可通过配置来开启商圈权益模块，关闭后搜索直达不展示商圈权益模块", "example" : "false" }, "business_district_ids" : { "type" : "array", "description" : "小程序已关联商圈时，可添加商圈id（目前仅对品牌直达开放，小程序直达暂未开放）", "items" : { "type" : "string" }, "example" : "[\"商圈id\"]" }, "custom_keywords" : { "type" : "string", "description" : "自定义关键词，最多可配置6个，限1-8个中文字符。当修改触发词模块时(module_type=BOX_EXCLUSIVE_KEYWORD)传入。\t小程序直达不支持设置", "example" : "[\"自定义关键词\"]" }, "image_id" : { "type" : "string", "description" : "氛围图片id，调用 支付宝文件上传接口 上传图片获取图片id(bizCode：search_box_atmosphere)。 图片规范 \t小程序直达不支持设置此项。", "example" : "A*oZQmT4xTBPUAAAAAAAAAAAAAAQAAAQ" }, "image_name" : { "type" : "string", "description" : "氛围图片名，当修改氛围图模块(module_type=BOX_ATMOSPHERE_IMAGE)时传入。\t小程序直达不支持设置", "example" : "搜索直达氛围图1" }, "merchant_id" : { "type" : "string", "description" : "商户id，代运营模式下传入。代运营模式，需要服务商已获得商家\"运营支付宝小程序\"授权。", "example" : "2088xxxxxxxxxxxx" }, "module_id" : { "type" : "string", "description" : "搜索直达模块配置id，新增模块时可不传，更新模块时必传。从alipay.open.search.box.query详情接口查询可获取已存在模块的配置id", "example" : "20220308000000168465" }, "module_type" : { "type" : "string", "description" : "搜索直达模块类型，参考 搜索直达模块说明 。取值范围：BOX_EXCLUSIVE_BASE-品牌介绍/BOX_EXCLUSIVE_KEYWORD-触发词/BOX_EXCLUSIVE_FUNCTIONS-常用服务/BOX_EXCLUSIVE_ACCOUNTS-官方账号/BOX_ATMOSPHERE_IMAGE-氛围图", "example" : "BOX_EXCLUSIVE_KEYWORD" }, "related_accounts" : { "type" : "array", "description" : "关联账号信息，可配置1-2个。传入账号需归属于商家主体。品牌直达修改官方账号(module_type=BOX_EXCLUSIVE_ACCOUNTS)时传入，小程序直达修改常用服务模块时也需传值。\t当为品牌直达时，数组中的第1个账号会被设置为\"账号1\"，也就是将作为搜索直达专区头部的跳转地址。", "items" : { "$ref" : "#/components/schemas/SearchBoxAppInfo" } }, "service_infos" : { "type" : "array", "description" : "服务信息，服务必须审核通过才能申请搜索直达，可配置1-4个。当修改常用服务模块(module_type=BOX_EXCLUSIVE_FUNCTIONS)时传入", "items" : { "$ref" : "#/components/schemas/SearchBoxServiceInfo" } }, "target_appid" : { "type" : "string", "description" : "小程序id，小程序直达时必传，需要和申请的商户主体保持一致，且符合 准入类目 ", "example" : "2018092561507369" } } }, "AlipayOpenSearchBoxModifyResponseModel" : { "type" : "object", "properties" : { "module_id" : { "type" : "string", "description" : "搜索直达模块配置id", "example" : "20220116000000130147" } } }, "AlipayOpenSearchBoxOfflineErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INPUT_ARGUMENT_ILLEGAL", "INPUT_ARGUMENT_NULL", "ISV_NOT_AUTH", "NO_PERMISSION", "RELATED_ACCOUNT_NO_TINY_APP", "SYSTEM_ERROR", "STATUS_NOT_ALLOWED_OPERATE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchBoxOfflineModel" : { "type" : "object", "properties" : { "box_id" : { "type" : "string", "description" : "搜索直达配置id", "example" : "20211130000000100415" }, "merchant_id" : { "type" : "string", "description" : "商户id，代运营模式下传入。代运营模式，需要服务商已获得商家\"运营支付宝小程序\"授权。", "example" : "2088xxxxxxxxxxxx" } } }, "AlipayOpenSearchBoxOfflineResponseModel" : { "type" : "object" }, "AlipayOpenSearchBoxOnlineErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INPUT_ARGUMENT_ILLEGAL", "INPUT_ARGUMENT_NULL", "ISV_NOT_AUTH", "NO_PERMISSION", "RELATED_ACCOUNT_NO_TINY_APP", "SYSTEM_ERROR", "STATUS_NOT_ALLOWED_OPERATE", "BRAND_HAS_CONFIG_SEARCH_BOX", "APP_HAS_CONFIG_SEARCH_BOX", "SEARCH_BOX_ACCESS_CHECK_FAIL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchBoxOnlineModel" : { "type" : "object", "properties" : { "box_id" : { "type" : "string", "description" : "搜索直达配置id", "example" : "20211130000000100415" }, "merchant_id" : { "type" : "string", "description" : "商户id，代运营模式下传入。代运营模式，需要服务商已获得商家\"运营支付宝小程序\"授权。", "example" : "2088xxxxxxxxxxxx" } } }, "AlipayOpenSearchBoxOnlineResponseModel" : { "type" : "object" }, "AlipayOpenSearchBoxQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "NO_PERMISSION", "SYSTEM_ERROR", "ISV_NOT_AUTH", "INPUT_ARGUMENT_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchBoxQueryResponseModel" : { "type" : "object", "properties" : { "account_module" : { "$ref" : "#/components/schemas/SearchBoxAccountModule" }, "area_keyword_module" : { "$ref" : "#/components/schemas/SearchBoxAreaKeyWordModule" }, "basic_info_module" : { "$ref" : "#/components/schemas/SearchBoxBasicInfoModule" }, "box_id" : { "type" : "string", "description" : "搜索直达配置id", "example" : "20220308000000128693" }, "box_status" : { "type" : "string", "description" : "搜索直达配置状态，AUDIT-审核中/ONLINE-已上架/REJECT-驳回/OFFLINE-已下架", "example" : "ONLINE" }, "business_district_module" : { "$ref" : "#/components/schemas/BoxBusinessDistrictModule" }, "default_keywords" : { "type" : "array", "description" : "搜索直达默认触发词，由系统生成，无法修改", "items" : { "type" : "string" }, "example" : "[\"默认触发词\"]" }, "keyword_module" : { "$ref" : "#/components/schemas/SearchBoxKeyWordModule" }, "latest_audit_image" : { "$ref" : "#/components/schemas/SearchBoxImageModule" }, "service_module" : { "$ref" : "#/components/schemas/SearchBoxServiceModule" }, "valid_image" : { "$ref" : "#/components/schemas/SearchBoxImageModule" } } }, "AlipayOpenSearchBoxactivityApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "OVER_ACT_MAX_LIMIT", "INPUT_ARGUMENT_NULL", "APPXPROD_RPC_INVOKE_ERROR", "NO_PERMISSION", "STATUS_NOT_ALLOWED_OPERATE", "DELIVERY_TIME_OVERLAPPING", "SYSTEM_ERROR", "ISV_NOT_AUTH", "INPUT_ARGUMENT_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchBoxactivityApplyModel" : { "type" : "object", "properties" : { "action_url" : { "type" : "string", "description" : "活动链接，必须为关联的小程序的页面链接（链接以 alipays 开头），可参考 小程序scheme链接介绍 ", "example" : "alipays://platformapi/startapp?appId=2021001198637195&pages/kaq_maid/kaq_maid" }, "background_word" : { "type" : "string", "description" : "创建banner活动时，可添加底纹推广词，有机会在首页搜索框内展示，提升banner活动曝光机会", "example" : "搜索底纹推广词" }, "box_id" : { "type" : "string", "description" : "搜索直达配置id", "example" : "20211130000000100415" }, "end_time" : { "type" : "string", "description" : "活动结束时间，开始和结束时间之间不得超过90天", "example" : "2022-09-30 23:59:59" }, "material_id" : { "type" : "string", "description" : "当material_type=\"IMAGE\"时，为图片id；当material_type=\"VIDEO\"时，为视频id。小程序直达仅支持图片类型。图片id可以通过调用 支付宝文件上传接口 上传图片，获取图片id(bizCode：search_box_banner)。 图片规范 ", "example" : "A*oZQmT4xTBPUAAAAAAAAAAAAAAQAAAQ" }, "material_type" : { "type" : "string", "description" : "IMAGE-图片/VIDEO-视频", "example" : "IMAGE" }, "merchant_id" : { "type" : "string", "description" : "商户id，代运营模式下传入。代运营模式，需要服务商已获得商家\"运营支付宝小程序\"授权。", "example" : "2088xxxxxxxxxxxx" }, "start_time" : { "type" : "string", "description" : "活动开始时间，开始和结束时间之间不得超过90天", "example" : "2022-02-10 08:00:00" }, "target_appid" : { "type" : "string", "description" : "跳转应用ID", "example" : "2021001191699651" }, "target_appname" : { "type" : "string", "description" : "跳转小程序名称", "example" : "跳转小程序名称" }, "target_regions" : { "type" : "array", "description" : "投放目标区域列表", "items" : { "$ref" : "#/components/schemas/DeliveryTargetRegion" } }, "title" : { "type" : "string", "description" : "活动标题", "example" : "活动标题" }, "video_info" : { "$ref" : "#/components/schemas/SearchBoxActivityVideoInfo" } } }, "AlipayOpenSearchBoxactivityApplyResponseModel" : { "type" : "object", "properties" : { "box_activity_id" : { "type" : "string", "description" : "搜索直达活动ID", "example" : "20211223000000100000" } } }, "AlipayOpenSearchBoxactivityBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INPUT_ARGUMENT_ILLEGAL", "INPUT_ARGUMENT_NULL", "ISV_NOT_AUTH", "NO_PERMISSION", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchBoxactivityBatchqueryModel" : { "type" : "object", "properties" : { "box_id" : { "type" : "string", "description" : "搜索直达id", "example" : "20211130000000100415" }, "merchant_id" : { "type" : "string", "description" : "商户id，代运营模式下传入。代运营模式，需要服务商已获得商家\"运营支付宝小程序\"授权。", "example" : "2088xxxxxxxxxxxx" }, "page_number" : { "type" : "integer", "description" : "分页查询的当前页号,从1开始", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "每页查询的数量，默认10，不超过50", "example" : "10" } } }, "AlipayOpenSearchBoxactivityBatchqueryResponseModel" : { "type" : "object", "properties" : { "models" : { "type" : "array", "description" : "活动明细列表", "items" : { "$ref" : "#/components/schemas/SearchBoxActivity" } }, "page_number" : { "type" : "string", "description" : "当前页码", "example" : "1" }, "page_size" : { "type" : "string", "description" : "每页记录数", "example" : "10" }, "total_count" : { "type" : "integer", "description" : "总记录数", "example" : "100" }, "total_page_count" : { "type" : "integer", "description" : "总页数", "example" : "5" } } }, "AlipayOpenSearchBoxactivityModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INPUT_ARGUMENT_ILLEGAL", "OVER_ACT_MAX_LIMIT", "INPUT_ARGUMENT_NULL", "NO_PERMISSION", "STATUS_NOT_ALLOWED_OPERATE", "DELIVERY_TIME_OVERLAPPING", "SYSTEM_ERROR", "ISV_NOT_AUTH" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchBoxactivityModifyModel" : { "type" : "object", "properties" : { "action_url" : { "type" : "string", "description" : "活动链接，必须为关联的小程序的页面链接（链接以 alipays 开头），可参考 小程序scheme链接介绍 ", "example" : "alipays://platformapi/startapp?appId=2021001198637195&pages/kaq_maid/kaq_maid" }, "background_word" : { "type" : "string", "description" : "创建banner活动时，可添加底纹推广词，有机会在首页搜索框内展示，提升banner活动曝光机会", "example" : "搜索底纹推广词" }, "box_activity_id" : { "type" : "string", "description" : "搜索直达活动id", "example" : "20220308000000168465" }, "end_time" : { "type" : "string", "description" : "活动结束时间，开始时间和结束时间之间不能超过90天", "example" : "2022-09-30 23:59:59" }, "material_id" : { "type" : "string", "description" : "当material_type=\"IMAGE\"时，为图片id；当material_type=\"VIDEO\"时，为视频id。图片id可以通过调用接口alipay.open.file.upload上传图片，获取图片id(bizCode：search_box_banner)。规范详情可查看 图片规范 。", "example" : "20211206OB020010034807196034" }, "material_type" : { "type" : "string", "description" : "IMAGE-图片/VIDEO-视频", "example" : "IMAGE" }, "merchant_id" : { "type" : "string", "description" : "商户id，代运营模式下传入。代运营模式，需要服务商已获得商家\"运营支付宝小程序\"授权。", "example" : "2088xxxxxxxxxxxx" }, "start_time" : { "type" : "string", "description" : "活动开始时间，开始时间和结束时间之间不能超过90天", "example" : "2022-02-10 08:00:00" }, "target_appid" : { "type" : "string", "description" : "跳转应用ID", "example" : "2021001191699651" }, "target_appname" : { "type" : "string", "description" : "跳转小程序名称", "example" : "跳转小程序名称" }, "target_regions" : { "type" : "array", "description" : "投放目标区域列表", "items" : { "$ref" : "#/components/schemas/DeliveryTargetRegion" } }, "title" : { "type" : "string", "description" : "活动标题", "example" : "活动标题" }, "video_info" : { "$ref" : "#/components/schemas/SearchBoxActivityVideoInfo" } } }, "AlipayOpenSearchBoxactivityModifyResponseModel" : { "type" : "object" }, "AlipayOpenSearchBoxactivityOfflineErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INPUT_ARGUMENT_ILLEGAL", "INPUT_ARGUMENT_NULL", "NO_PERMISSION", "STATUS_NOT_ALLOWED_OPERATE", "SYSTEM_ERROR", "ISV_NOT_AUTH" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchBoxactivityOfflineModel" : { "type" : "object", "properties" : { "box_activity_id" : { "type" : "string", "description" : "搜索直达活动id", "example" : "20211223000000100000" }, "merchant_id" : { "type" : "string", "description" : "商户id，代运营模式下传入。代运营模式，需要服务商已获得商家\"运营支付宝小程序\"授权。", "example" : "2088xxxxxxxxxxxx" } } }, "AlipayOpenSearchBoxactivityOfflineResponseModel" : { "type" : "object" }, "AlipayOpenSearchBoxactivityQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INPUT_ARGUMENT_ILLEGAL", "INPUT_ARGUMENT_NULL", "ISV_NOT_AUTH", "NO_PERMISSION", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchBoxactivityQueryResponseModel" : { "type" : "object", "properties" : { "background_word" : { "type" : "string", "description" : "底纹词", "example" : "底纹词" }, "background_word_info" : { "$ref" : "#/components/schemas/BackgroundWordInfo" }, "box_activity_id" : { "type" : "string", "description" : "搜索直达活动id", "example" : "20211223000000100000" }, "box_id" : { "type" : "string", "description" : "搜索直达id", "example" : "20211130000000100415" }, "end_time" : { "type" : "string", "description" : "活动结束时间", "example" : "2022-09-30 23:59:59" }, "fail_reason" : { "type" : "string", "description" : "审核失败原因", "example" : "审核失败原因" }, "gmt_modified" : { "type" : "string", "description" : "更新时间", "example" : "2022-02-10 08:00:00" }, "material_type" : { "type" : "string", "description" : "IMAGE-图片/VIDEO-视频", "example" : "IMAGE" }, "material_url" : { "type" : "string", "description" : "当material_type=\"IMAGE\"时，为图片url；当material_type=\"VIDEO\"时，为视频url", "example" : "http://mdn.alipayobjects.com/mrch_spc/afts/img/A*0XA2Qo_omj4AAAAAAAAAAAAADsF1AQ/original" }, "run_status" : { "type" : "string", "description" : "运行状态，INITIAL-初始/ONLINE-已上架/EXPIRE-已失效/OFFLINE-已下架", "example" : "ONLINE" }, "start_time" : { "type" : "string", "description" : "活动开始时间", "example" : "2022-02-10 08:00:00" }, "status" : { "type" : "string", "description" : "配置状态，INITIAL-初始/AUDIT-审核中/CANCEL-已取消/ONLINE-已上架/REJECT-驳回/OFFLINE-已下架/EXPIRE-已失效", "example" : "AUDIT" }, "target_appid" : { "type" : "string", "description" : "跳转应用ID", "example" : "2021001191699651" }, "target_appname" : { "type" : "string", "description" : "目标小程序名", "example" : "目标小程序名" }, "target_regions" : { "type" : "array", "description" : "投放目标区域", "items" : { "$ref" : "#/components/schemas/DeliveryTargetRegion" } }, "title" : { "type" : "string", "description" : "活动标题", "example" : "活动标题" }, "video_info" : { "$ref" : "#/components/schemas/SearchBoxActivityVideoInfo" } } }, "AlipayOpenSearchOrderdetailQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "BIZ_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchOrderdetailQueryModel" : { "type" : "object", "properties" : { "biz_data" : { "$ref" : "#/components/schemas/SearchOrderRequest" }, "biz_type" : { "type" : "string", "description" : "表示修改内容的业务类型", "example" : "SEARCH_ORDER_DETAIL_QUERY" }, "opt_type" : { "type" : "string", "description" : "进行具体操作的类型比如：create、mod、cancel", "example" : "query" } } }, "AlipayOpenSearchOrderdetailQueryResponseModel" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/SearchOrderDetailData" } } }, "AlipayOpenSearchServiceorderBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "BIZ_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchServiceorderBatchqueryModel" : { "type" : "object", "properties" : { "biz_data" : { "$ref" : "#/components/schemas/SearchApplyPageQueryRequest" }, "biz_type" : { "type" : "string", "description" : "表示查询内容的类型", "example" : "SEARCH_ORDER_BATCH_QUERY" }, "opt_type" : { "type" : "string", "description" : "操作的类型，如query", "example" : "query" } } }, "AlipayOpenSearchServiceorderBatchqueryResponseModel" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/OrderPageQueryDTO" } } }, "AlipayOpenSearchSubservicekeywordApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "APP_NOT_ONLINE", "APP_NOT_SEARCH_VISIBLE", "INVALID_PARAMETER", "KEYWORDS_EXCEED_MAX_LIMIT", "SYSTEM_ERROR", "APP_NOT_EXSIT", "INVALID_STATUS", "SYSTEM_BUSY", "SUB_SERVICE_CAN_NOT_SEARCH" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchSubservicekeywordApplyModel" : { "type" : "object", "properties" : { "config_id" : { "type" : "string", "description" : "关键词id，（仅修改时传入，修改时仅能传一个关键词）", "example" : "20221108000000245181" }, "key_words" : { "type" : "array", "description" : "关键词，提报服务关键词，人工录入", "items" : { "type" : "string" }, "example" : "[\"a\",\"b\"]" }, "sub_service_code" : { "type" : "string", "description" : "子服务code，提报服务关键词，alipay.open.app.service.list.query(服务批量查询)这个接口可以获取", "example" : "2020071621000604578858" }, "target_appid" : { "type" : "string", "description" : "小程序id", "example" : "2021001112626071" } } }, "AlipayOpenSearchSubservicekeywordApplyResponseModel" : { "type" : "object", "properties" : { "apply_no" : { "type" : "string", "description" : "审核工单id，唯一，提报服务关键词，提报服务关键词返回该id", "example" : "20220524000000113287" } } }, "AlipayOpenSearchSubservicekeywordBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "UN_SUPPORT_SEARCH_BOX_STATUS", "NO_PERMISSION", "INVALID_PARAMETER", "SYSTEM_ERROR", "SYSTEM_BUSY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchSubservicekeywordBatchqueryResponseModel" : { "type" : "object", "properties" : { "page_number" : { "type" : "integer", "description" : "第几页", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "每页条数", "example" : "2" }, "subservice_keyword_info" : { "type" : "array", "description" : "关键词明细", "items" : { "$ref" : "#/components/schemas/SubServiceKeyWordInfo" } }, "total_count" : { "type" : "integer", "description" : "总条数", "example" : "12" }, "total_page_count" : { "type" : "integer", "description" : "总页数", "example" : "6" } } }, "AlipayOpenSearchSubservicekeywordDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "NO_PERMISSION", "APP_NOT_ONLINE", "MINI_APP_CAN_NOT_SEARCH", "SYSTEM_ERROR", "INVALID_PARAMETER", "OPERATE_TOO_FAST", "INVALID_STATUS", "SYSTEM_BUSY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchSubservicekeywordDeleteModel" : { "type" : "object", "properties" : { "config_id" : { "type" : "string", "description" : "关键词配置ID", "example" : "20220513000000165607" }, "target_appid" : { "type" : "string", "description" : "小程序id", "example" : "2021001112626071" } } }, "AlipayOpenSearchSubservicekeywordDeleteResponseModel" : { "type" : "object" }, "AlipayOpenSearchSubservicekeywordQuerystatusErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "NO_PERMISSION", "APP_NOT_ONLINE", "MINI_APP_CAN_NOT_SEARCH", "SYSTEM_ERROR", "INVALID_PARAMETER", "OPERATE_TOO_FAST", "SYSTEM_BUSY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSearchSubservicekeywordQuerystatusResponseModel" : { "type" : "object", "properties" : { "key_words" : { "type" : "array", "description" : "关键词工单审核状态返回值", "items" : { "$ref" : "#/components/schemas/KeyWordInfo" } } } }, "AlipayOpenServicemarketCommodityShopOfflineErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMS_ERROR", "NO_PERMISSION_OFFLINE_SHOP", "COMMODITY_SHOP_NOT_EXIST", "SYSTEM_ERROR", "SHOP_STATUS_NOT_SUPPORT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenServicemarketCommodityShopOfflineModel" : { "type" : "object", "properties" : { "commodity_id" : { "type" : "string", "description" : "服务商户ID", "example" : "20160010200000000033400" }, "shop_id" : { "type" : "string", "description" : "球房ID", "example" : "2015052000077000000000182140" } } }, "AlipayOpenServicemarketCommodityShopOfflineResponseModel" : { "type" : "object" }, "AlipayOpenServicemarketCommodityShopOnlineErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "NO_PERMISSION_ONLINE_SHOP", "SHOP_TYPE_ALREADY_ONLINE", "COMMODITY_SHOP_NOT_EXIST", "PARAMS_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenServicemarketCommodityShopOnlineModel" : { "type" : "object", "properties" : { "commodity_id" : { "type" : "string", "description" : "服务插件ID", "example" : "201511020002630060" }, "shop_id" : { "type" : "string", "description" : "店铺ID", "example" : "2015052000077000000000182140" } } }, "AlipayOpenServicemarketCommodityShopOnlineResponseModel" : { "type" : "object" }, "AlipayOpenServicemarketOrderAcceptErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "NO_PERMISSION_ACCETP_ORDER", "COMMODITY_ORDER_STATUS_INVALID", "ORDER_NOT_EXIST", "PARAMS_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenServicemarketOrderAcceptModel" : { "type" : "object", "properties" : { "commodity_order_id" : { "type" : "string", "description" : "服务商品订单ID", "example" : "201604060043410106" } } }, "AlipayOpenServicemarketOrderAcceptResponseModel" : { "type" : "object" }, "AlipayOpenServicemarketOrderCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "BIZ_ERROR", "AGENT_AUTH_FAIL", "NOT_SUPPORT_ORDER_BY_OPENAPI", "USER_INVALID_STATUS", "USER_NOT_EXIST", "SIGN_AGREEMENT_FAILED", "MINI_APP_NAME_DUPLICATE", "ENGLISH_NAME_IS_BLANK", "INVALID_MINI_APP_EN_NAME", "MINI_APP_NAME_SENSITIVE", "INVALID_MINI_APP_EN_NAME_LENGTH", "APP_NAME_IS_BLANK", "INVALID_MINI_APP_NAME", "INVALID_MINI_APP_NAME_LENGTH", "CREATE_MINI_APP_EXCEED_MAX_COUNT", "INVALID_CATEGORY", "RISK_DECISION_CHECK_FAIL", "BLACK_LIST_CHECK_FAIL", "MINI_APP_EN_NAME_SENSITIVE", "MINI_APP_SLOGAN_SENSITIVE", "MINI_APP_DESC_SENSITIVE", "MINI_APP_SERVICE_MAIL_SENSITIVE", "CREATE_MINI_APP_PID_PUNISH", "MINI_APP_EN_NAME_DUPLICATE", "APP_ID_EXIST", "APP_ID_ILLEGAL", "INVALID_MINI_APP_DESC_LENGTH", "RISK_DECISION_HIT_BRAND", "INVALID_MINI_APP_SLOGAN_LENGTH" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenServicemarketOrderCreateModel" : { "type" : "object", "properties" : { "app_category_ids" : { "type" : "string", "description" : "11_12;12_13。小程序类目，格式为 第一个一级类目_第一个二级类目;第二个一级类目_第二个二级类目，详细类目可以参考https://docs.alipay.com/isv/10325", "example" : "107397_107223" }, "app_desc" : { "type" : "string", "description" : "小程序官方示例Demo，展示已支持的接口能力及组件。", "example" : "小程序应用描述" }, "app_english_name" : { "type" : "string", "description" : "小程序应用英文名称", "example" : "demoexample" }, "app_name" : { "type" : "string", "description" : "小程序应用名称", "example" : "小程序示例" }, "app_origin" : { "type" : "string", "description" : "来源的业务方，需要申请", "example" : "AA" }, "app_slogan" : { "type" : "string", "description" : "小程序应用简介，一句话描述小程序功能", "example" : "提供小程序示例功能" }, "market_code" : { "type" : "string", "description" : "订购的服务商品ID所在的市场编码。新接入场景必须传递，具体值请联系产品分配。", "example" : "SERVICE_MAEKET" }, "merchandise_id" : { "type" : "string", "description" : "订购的服务商品ID", "example" : "I1060100001000050361" }, "merchant_pid" : { "type" : "string", "description" : "商户PID", "example" : "2088101118588888" }, "mini_app_id" : { "type" : "string", "description" : "一二方支持传入appId", "example" : "123123" }, "mini_category_ids" : { "type" : "string", "description" : "新小程序前台类目，格式为 第一个一级类目_第一个二级类目;第二个一级类目_第二个二级类目_第二个三级类目，详细类目可以通过 https://docs.open.alipay.com/api_49/alipay.open.mini.category.query接口查询mini_category_list，如果不填默认采用当前小程序应用类目。使用默认应用类目后不需要再次上传营业执照号、营业执照名、营业执照截图、营业执照有效期。使用后不再读取app_category_ids值，老前台类目将废弃", "example" : "XS1001_XS2001_XS3002;XS1011_XS2089;XS1002_XS2008_XS3024" }, "out_biz_no" : { "type" : "string", "description" : "比如某种业务标准外部订单号,比如交易外部订单号，代表商户端自己订单号", "example" : "2018072600000015692246" }, "service_email" : { "type" : "string", "description" : "小程序客服邮箱", "example" : "example@mail.com" }, "service_phone" : { "type" : "string", "description" : "小程序客服电话", "example" : "13110101010" } } }, "AlipayOpenServicemarketOrderCreateResponseModel" : { "type" : "object", "properties" : { "commodity_order_id" : { "type" : "string", "description" : "订单号", "example" : "2018071900000015585789" }, "mini_app_id" : { "type" : "string", "description" : "支付宝分配给开发者的应用ID", "example" : "2014072300007148" } } }, "AlipayOpenServicemarketOrderItemCancelErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMS_ERROR", "NO_PERMISSION_CANCEL_ORDER_ITEM", "COMMODITY_ORDER_ITEM_NOT_EXIST", "ITEM_STATUS_NOT_ALLOW" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenServicemarketOrderItemCancelModel" : { "type" : "object", "properties" : { "cancel_reason" : { "type" : "string", "description" : "当前球房区域不支持实施", "example" : "该球房暂无法实施完成" }, "commodity_order_id" : { "type" : "string", "description" : "订购服务订单ID，通过支付宝发送的 https://opendocs.alipay.com/apis/api_3/alipay.open.servicemarket.order.notify(服务市场商户确认订购通知) 通知获取。", "example" : "20160010200000000033400" }, "mini_app_id" : { "type" : "string", "description" : "商家订购服务选择的某一小程序的APPID，如果该订单为蚂蚁服务市场发布的小程序插件服务所产生的订单，则此字段必填", "example" : "2017121800945174" }, "shop_id" : { "type" : "string", "description" : "商家订购服务选择的某一球房的ID。若该订单： \t为支付宝服务市场发布的服务所产生订单则该参数可选。 \t为口碑服务市场发布的服务所产生的订单，则此字段必填。口碑服务市场参见 http://fuwu.koubei.com/commodity/v2/merchandise/index.htm。", "example" : "2015052000077000000000182140" } } }, "AlipayOpenServicemarketOrderItemCancelResponseModel" : { "type" : "object" }, "AlipayOpenServicemarketOrderItemCompleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMS_ERROR", "NO_PERMISSION_OPERATION", "COMMODITY_ORDER_ITEM_NOT_EXIST", "ITEM_STATUS_NOT_ALLOW", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenServicemarketOrderItemCompleteModel" : { "type" : "object", "properties" : { "commodity_order_id" : { "type" : "string", "description" : "订购服务插件订单号", "example" : "20160010200000000033400" }, "mini_app_id" : { "type" : "string", "description" : "商家订购服务选择的某一小程序的APPID，如果该订单为蚂蚁服务市场发布的小程序插件服务所产生的订单，则此字段必填", "example" : "2017121800945174" }, "shop_id" : { "type" : "string", "description" : "商家订购服务选择的某一球房的ID。若该订单：\t为支付宝服务市场发布的服务所产生订单则该参数可选。\t为口碑服务市场发布的服务所产生的订单，则此字段必填。口碑服务市场参见 http://fuwu.koubei.com/commodity/v2/merchandise/index.htm。", "example" : "2015052000077000000000182140" } } }, "AlipayOpenServicemarketOrderItemCompleteResponseModel" : { "type" : "object" }, "AlipayOpenServicemarketOrderItemConfirmErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "NO_PERMISSION_COMFIRM_ORDERITEM", "ITEM_STATUS_NOT_ALLOW", "COMMODITY_ORDER_ITEM_NOT_EXIST", "PARAMS_ERROR", "SYSTEM_ERROR", "CONFIRM_CHARGE_ITEM_NOT_ALLOW" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenServicemarketOrderItemConfirmModel" : { "type" : "object", "properties" : { "commodity_order_id" : { "type" : "string", "description" : "订购服务插件订单号", "example" : "20160010200000000033400" }, "mini_app_id" : { "type" : "string", "description" : "商家订购服务选择的某一小程序的APPID，如果该订单为蚂蚁服务市场发布的小程序插件服务所产生的订单，则此字段必填", "example" : "2017121800945174" }, "shop_id" : { "type" : "string", "description" : "商家订购服务选择的某一球房的ID。若该订单： \t为支付宝(蚂蚁)服务市场发布的服务所产生订单则该参数可选。 \t为口碑服务市场发布的服务所产生的订单，则此字段必填。口碑服务市场参见 http://fuwu.koubei.com/commodity/v2/merchandise/index.htm。", "example" : "2015052000077000000000182140" } } }, "AlipayOpenServicemarketOrderItemConfirmResponseModel" : { "type" : "object" }, "AlipayOpenServicemarketOrderNotifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenServicemarketOrderNotifyResponseModel" : { "type" : "object" }, "AlipayOpenServicemarketOrderQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "QUERY_FAILD", "NOPERMISSION_QUERY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenServicemarketOrderQueryResponseModel" : { "type" : "object", "properties" : { "auto_upgrade" : { "type" : "boolean", "description" : "true：开启；false：关闭；需要同步校验commodity_id，如果没有查询到订购信息的话，忽略该字段返回值", "example" : "true" }, "commodity_id" : { "type" : "string", "description" : "订购服务商品ID", "example" : "201604290086730119" }, "current_page" : { "type" : "integer", "description" : "当前查询页（本接口支持最多查询100条记录）", "example" : "1" }, "order_items" : { "type" : "array", "description" : "订单明细列表", "items" : { "$ref" : "#/components/schemas/OrderItem" } }, "specifications" : { "type" : "string", "description" : "用于区分同一个服务的不同版本", "example" : "标准版、试用版" }, "status" : { "type" : "string", "description" : "MERCHANT_ORDED（待服务商接单）", "example" : "MERCHANT_ORDED" }, "total_size" : { "type" : "integer", "description" : "总记录数", "example" : "1000" } } }, "AlipayOpenServicemarketOrderRejectErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMS_ERROR", "NO_PERMISSION_REJECT_ORDER", "ORDER_NOT_EXIST", "COMMODITY_ORDER_STATUS_INVALID" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenServicemarketOrderRejectModel" : { "type" : "object", "properties" : { "commodity_order_id" : { "type" : "string", "description" : "订购服务商品订单ID", "example" : "20160010200000000033400" }, "reject_reason" : { "type" : "string", "description" : "拒绝接单原因", "example" : "暂不支持该地区服务" } } }, "AlipayOpenServicemarketOrderRejectResponseModel" : { "type" : "object" }, "AlipayOpenServicemarketPromotiontaskRelationQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAMS_ERROR", "QUERY_FAILD" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenServicemarketPromotiontaskRelationQueryResponseModel" : { "type" : "object", "properties" : { "current_page" : { "type" : "integer", "description" : "当前页码", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "每页数量", "example" : "10" }, "promotion_relations" : { "type" : "array", "description" : "推广服务商信息列表", "items" : { "$ref" : "#/components/schemas/PromotionTaskRelation" } }, "total_size" : { "type" : "integer", "description" : "总记录数", "example" : "1000" } } }, "AlipayOpenSpBlueseaactivityCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_PARAMS", "BLUESEA_BIZSCENE_ILLEGAL", "ALIPAY_LOGON_INVALID", "ACTIVITY_APPLYORDER_EXIST", "MERCHANT_INVALID", "RELATION_CHECK_FAILED", "MERCHANT_ACTIVITY_APPLIED", "BLUESEA_MCC_LIMITED", "BLUESEA_QUALIFICATIONLICENSE_INCOMPLETE", "BLUESEA_ADDRESS_INCOMPLETE", "SYSTEM_ERROR", "INDIRECT_MERCHANT_NOTEXIST", "INDIRECT_RELATION_NOTEXIST", "INDIRECT_MERCHANT_NOTDIRECT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSpBlueseaactivityCreateModel" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "详细地址。\t该资质是否必传请参见报名资质要求。", "example" : "万塘路18号黄龙时代广场B座" }, "biz_scene" : { "type" : "string", "description" : "蓝海活动的场景，支持场景如下：\t* 直连餐饮（BLUE_SEA_FOOD_APPLY）；\t* 直连快消（BLUE_SEA_FMCG_APPLY）；\t* 间连餐饮（BLUE_SEA_FOOD_INDIRECT_APPLY）；\t* 间连快消（BLUE_SEA_FMCG_INDIRECT_APPLY）。", "example" : "BLUE_SEA_FOOD_APPLY" }, "business_lic" : { "type" : "string", "description" : "营业执照，要求证件文本信息清晰可见，图片文件大小在 50K-5M 之间，不限制长宽，支持 png、bmp、gif、jpg、jpeg 格式。\t请传入alipay.open.sp.image.upload(图片上传接口) 返回的 image_id。\t该资质是否必传请参见报名资质要求。", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "city_code" : { "type" : "string", "description" : "城市编码。请按照表格 中内容填写。 （请参考资料： 统计用区划和城乡划分代码）", "example" : "310001" }, "district_code" : { "type" : "string", "description" : "区县编码。请按照表格 中内容填写。 （请参考资料： 统计用区划和城乡划分代码）", "example" : "310006" }, "food_business_lic" : { "type" : "string", "description" : "食品经营许可证，要求证件文本信息清晰可见，图片文件大小在 50K-5M 之间，不限制长宽，支持 png、bmp、gif、jpg、jpeg 格式。\t请传入alipay.open.sp.image.upload(图片上传接口) 返回的 image_id。\t该资质是否必传请参见报名资质要求。", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "food_circulate_lic" : { "type" : "string", "description" : "食品流通许可证，要求证件文本信息清晰可见，图片文件大小在 50K-5M 之间，不限制长宽，支持 png、bmp、gif、jpg、jpeg 格式。\t请传入alipay.open.sp.image.upload(图片上传接口) 返回的 image_id。\t该资质是否必传请参见报名资质要求。", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "food_health_lic" : { "type" : "string", "description" : "食品卫生许可证，要求证件文本信息清晰可见，图片文件大小在 50K-5M 之间，不限制长宽，支持 png、bmp、gif、jpg、jpeg 格式。\t请传入alipay.open.sp.image.upload(图片上传接口) 返回的 image_id。 \t该资质是否必传请参见报名资质要求。", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "food_production_lic" : { "type" : "string", "description" : "食品生产许可证，要求证件文本信息清晰可见，图片文件大小在 50K-5M 之间，不限制长宽，支持 png、bmp、gif、jpg、jpeg 格式。\t请传入alipay.open.sp.image.upload(图片上传接口) 返回的 image_id。\t该资质是否必传请参见报名资质要求。", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "food_service_lic" : { "type" : "string", "description" : "餐饮服务许可证，要求证件文本信息清晰可见，图片文件大小在 50K-5M 之间，不限制长宽，支持 png、bmp、gif、jpg、jpeg 格式。\t请传入alipay.open.sp.image.upload(图片上传接口) 返回的 image_id。\t该资质是否必传请参见报名资质要求。", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "indoor_pic" : { "type" : "string", "description" : "内景照，要求图片清晰可见，图片文件大小在 50K-5M 之间，不限制长宽，支持 png、bmp、gif、jpg、jpeg 格式。\t请传入alipay.open.sp.image.upload(图片上传接口) 返回的 image_id。\t该资质是否必传请参见报名资质要求。", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "merchant_logon" : { "type" : "string", "description" : "参与蓝海活动的商户支付宝账号，只有当参与直连蓝海活动场景（BLUE_SEA_FOOD_APPLY/BLUE_SEA_FMCG_APPLY）时必填，间连场景可空。", "example" : "13200132000" }, "province_code" : { "type" : "string", "description" : "省份编码。请按照表格 中内容填写。 （请参考资料： 统计用区划和城乡划分代码）", "example" : "310000" }, "shop_entrance_pic" : { "type" : "string", "description" : "门头照，要求图片清晰可见，图片文件大小在 50K-5M 之间，不限制长宽，支持 png、bmp、gif、jpg、jpeg 格式。\t请传入alipay.open.sp.image.upload(图片上传接口) 返回的 image_id。\t该资质是否必传请参见报名资质要求。", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "sub_merchant_id" : { "type" : "string", "description" : "参与蓝海活动的间连商户账号，只有当参与间连蓝海活动场景（BLUE_SEA_FOOD_INDIRECT_APPLY/BLUE_SEA_FMCG_INDIRECT_APPLY）时必填，直连场景可空。", "example" : "2088100010001000" }, "tobacco_lic" : { "type" : "string", "description" : "烟草专卖零售许可证，要求证件文本信息清晰可见，图片文件大小在 50K-5M 之间，不限制长宽，支持 png、bmp、gif、jpg、jpeg 格式。\t请传入alipay.open.sp.image.upload(图片上传接口) 返回的 image_id。 \t该资质是否必传请参见报名资质要求。", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" } } }, "AlipayOpenSpBlueseaactivityCreateResponseModel" : { "type" : "object", "properties" : { "order_id" : { "type" : "string", "description" : "申请单Id", "example" : "0581" } } }, "AlipayOpenSpBlueseaactivityModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_PARAMS", "ACTIVITY_APPLYORDER_NOTEXIST", "MERCHANT_ACTIVITY_APPLIED", "BLUESEA_MCC_LIMITED", "BLUESEA_QUALIFICATIONLICENSE_INCOMPLETE", "BLUESEA_ADDRESS_INCOMPLETE", "SYSTEM_ERROR", "ACTIVITY_APPLYORDER_CANNOTEDIT", "NO_PERMISSION", "BLUESEA_ORDER_INVALID" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSpBlueseaactivityModifyModel" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "详细地址", "example" : "万塘路18号黄龙时代广场B座" }, "business_lic" : { "type" : "string", "description" : "营业执照，要求证件文本信息清晰可见。 请上传照片的image_id，传参明细请参见报名资质要求", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "city_code" : { "type" : "string", "description" : "城市编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 （参考资料： http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/）", "example" : "310001" }, "district_code" : { "type" : "string", "description" : "区县编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 （参考资料： http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/）", "example" : "310006" }, "food_business_lic" : { "type" : "string", "description" : "食品经营许可证，要求证件文本信息清晰可见。请上传照片的image_id，传参明细请参见报名资质要求", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "food_circulate_lic" : { "type" : "string", "description" : "食品流通许可证，要求证件文本信息清晰可见。请上传照片的image_id，传参明细请参见报名资质要求", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "food_health_lic" : { "type" : "string", "description" : "食品卫生许可证，要求证件文本信息清晰可见。请上传照片的image_id，传参明细请参见报名资质要求", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "food_production_lic" : { "type" : "string", "description" : "食品生产许可证，要求证件文本信息清晰可见。请上传照片的image_id，传参明细请参见报名资质要求", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "food_service_lic" : { "type" : "string", "description" : "餐饮服务许可证，要求证件文本信息清晰可见。请上传照片的image_id，传参明细请参见报名资质要求", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "indoor_pic" : { "type" : "string", "description" : "门头照，要求内景照片清晰可见。请上传照片的image_id，传参明细请参见报名资质要求", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "order_id" : { "type" : "string", "description" : "申请单 id。通过 alipay.open.sp.blueseaactivity.create接口获取。", "example" : "0581" }, "province_code" : { "type" : "string", "description" : "省份编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 （参考资料： http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/）", "example" : "310000" }, "shop_entrance_pic" : { "type" : "string", "description" : "门头照，要求店铺外观照片清晰可见。请上传照片的image_id，传参明细请参见报名资质要求", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "tobacco_lic" : { "type" : "string", "description" : "烟草专卖零售许可证，要求证件文本信息清晰可见。请上传照片的image_id，传参明细请参见报名资质要求", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" } } }, "AlipayOpenSpBlueseaactivityModifyResponseModel" : { "type" : "object" }, "AlipayOpenSpBlueseaactivityQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_PARAMS", "SYSTEM_ERROR", "NO_PERMISSION", "BLUESEA_ORDER_INVALID" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSpBlueseaactivityQueryResponseModel" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "详细地址", "example" : "万塘路18号黄龙时代广场B座" }, "biz_scene" : { "type" : "string", "description" : "蓝海活动的场景，包括直连餐饮（BLUE_SEA_FOOD_APPLY）、直连快消（BLUE_SEA_FMCG_APPLY）、间连餐饮（BLUE_SEA_FOOD_INDIRECT_APPLY）、间连快消（BLUE_SEA_FMCG_INDIRECT_APPLY）场景", "example" : "BLUE_SEA_FOOD_APPLY" }, "business_lic" : { "type" : "string", "description" : "营业执照，要求证件文本信息清晰可见。 资质信息请参见报名资质要求", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "city_code" : { "type" : "string", "description" : "城市编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 （参考资料： http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/）", "example" : "310001" }, "district_code" : { "type" : "string", "description" : "区县编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 （参考资料： http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/）", "example" : "310006" }, "food_business_lic" : { "type" : "string", "description" : "食品经营许可证，要求证件文本信息清晰可见。资质信息请参见报名资质要求", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "food_circulate_lic" : { "type" : "string", "description" : "食品流通许可证，要求证件文本信息清晰可见。资质信息请参见报名资质要求", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "food_health_lic" : { "type" : "string", "description" : "食品卫生许可证，要求证件文本信息清晰可见。资质信息请参见报名资质要求", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "food_production_lic" : { "type" : "string", "description" : "食品生产许可证，要求证件文本信息清晰可见。资质信息请参见报名资质要求", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "food_service_lic" : { "type" : "string", "description" : "餐饮服务许可证，要求证件文本信息清晰可见。资质信息请参见报名资质要求", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "indoor_pic" : { "type" : "string", "description" : "门头照，要求内景照片清晰可见。资质信息请参见报名资质要求", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "memo" : { "type" : "string", "description" : "审核驳回原因，在订单状态为失败时有效", "example" : "资质照片和商户名称不一致，请修改一致后，重新申请;其他原因;" }, "merchant_logon" : { "type" : "string", "description" : "参与蓝海活动的商户支付宝账号，只有当参与直连蓝海活动场景（BLUE_SEA_FOOD_APPLY/BLUE_SEA_FMCG_APPLY）时才返回", "example" : "13200132000" }, "province_code" : { "type" : "string", "description" : "省份编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 （参考资料： http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/）", "example" : "310000" }, "shop_entrance_pic" : { "type" : "string", "description" : "门头照，要求店铺外观照片清晰可见。资质信息请参见报名资质要求", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "status" : { "type" : "string", "description" : "申请单状态，状态机参考（AUDITING:审核中，FAIL:报名失败，PASS:报名成功）", "example" : "AUDITING" }, "sub_merchant_id" : { "type" : "string", "description" : "参与蓝海活动的间连商户账号，只有当参与间连蓝海活动场景（BLUE_SEA_FOOD_INDIRECT_APPLY/BLUE_SEA_FMCG_INDIRECT_APPLY）时才返回", "example" : "2088100010001000" }, "tobacco_lic" : { "type" : "string", "description" : "烟草专卖零售许可证，要求证件文本信息清晰可见。资质信息请参见报名资质要求", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" } } }, "AlipayOpenSpImageUploadErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "FILE_SIZE_OUT_LIMIT", "SYSTEM_ERROR", "FILE_SIZE_MIN_LIMIT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSpImageUploadModel" : { "type" : "object" }, "AlipayOpenSpImageUploadResponseModel" : { "type" : "object", "properties" : { "image_id" : { "type" : "string", "description" : "图片在文件存储平台的标识", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" } } }, "AlipayOpenSpIsvBillSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "BIZ_ERROR_BILL_NOT_MATCH", "BIZ_ERROR_INVALID_STATUS", "BIZ_ERROR_BILL_REDUPLICATE_RETURN" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSpIsvBillSyncModel" : { "type" : "object", "properties" : { "end_time" : { "type" : "string", "description" : "账单结束时间", "example" : "2021-11-10" }, "generate_time" : { "type" : "string", "description" : "出账时间，回传出账信息时，必须传递", "example" : "2021-10-14 00:00:00" }, "item_code" : { "type" : "string", "description" : "服务优选商品编码", "example" : "SS010301000000001234" }, "out_biz_no" : { "type" : "string", "description" : "外部业务号，传isv系统生成的账单号，需要保证唯一", "example" : "2021000000000" }, "pay_time" : { "type" : "string", "description" : "账单支付时间，回传支付数时，必须传递", "example" : "2021-10-14 00:00:00" }, "price" : { "type" : "string", "description" : "账单金额，这里填写的是整数，单位为分，比如1元，那么输入100", "example" : "100" }, "promotor_pid" : { "type" : "string", "description" : "推广服务商(S2)pid", "example" : "2088301912341234" }, "start_time" : { "type" : "string", "description" : "账单开始时间", "example" : "2021-10-10" }, "status" : { "type" : "string", "description" : "GENERATE_BILL代表”已出账“，PAID_BILL代表”已支付“，选择这两者之一", "example" : "GENERATE_BILL" }, "sub_promotor_pid" : { "type" : "string", "description" : "S1回传的S2的操作员工子账号，如果是子账号操作，请回传", "example" : "20211011000000" } } }, "AlipayOpenSpIsvBillSyncResponseModel" : { "type" : "object", "properties" : { "success" : { "type" : "boolean", "description" : "返回true或者flase，ture代表账单回传成功，false表示账单回传失败", "example" : "true" } } }, "AlipayOpenSpIsvOperationSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PROMOTION_RELATION_NOT_EXIST", "ILLEGAL_PARAMS", "OPERATION_RESULT_REPEAT", "ISV_NOT_IN_WHITELIST", "ILLEGAL_ISV_USER", "IMPLEMENT_RESULT_ILLEGAL", "IMPLEMENT_TIME_ILLEGAL", "EXT_INFO_PARSE_FAIL", "OPPOR_NOT_EXIST", "OPPOR_REPEAT", "CUSTOMER_TYPE_ILLEGAL", "ORDER_ID_ILLEGAL", "ORDER_NOT_EXIT", "ORDER_STATUS_ILLEGAL", "SHOP_ID_ILLEGAL", "DEVICE_NO_ILLEGAL", "ACTIVATION_TIME_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSpIsvOperationSyncModel" : { "type" : "object", "properties" : { "customer_type" : { "type" : "string", "description" : "客户类型，PERSONAL表示个人，ALIPAY_RECOMMEND表示支付宝推荐", "example" : "PERSONAL" }, "ext_info" : { "$ref" : "#/components/schemas/OperationResultExtInfo" }, "implement_end_time" : { "type" : "string", "description" : "实施结束时间", "example" : "2021-10-11 00:00:00" }, "implement_object_name" : { "type" : "string", "description" : "实施对象名称", "example" : "浙江省杭州市西湖区西溪路黄焖鸡米饭" }, "implement_place" : { "type" : "string", "description" : "实施地点", "example" : "浙江省杭州市西湖区蚂蚁A空间" }, "implement_result" : { "type" : "string", "description" : "实施结果，SUCCESS表示实施成功，FAIL表示实施失败", "example" : "SUCCESS" }, "implement_result_image" : { "type" : "string", "description" : "实施结果的照片", "example" : "https://os.alipayobjects.com/rmsportal/JxAjrvPKriKOpjf.png" }, "implement_result_remark" : { "type" : "string", "description" : "实施结果的备注", "example" : "失败原因：商户取消购买" }, "implement_start_time" : { "type" : "string", "description" : "实施开始时间", "example" : "2021-10-10 00:00:00" }, "item_code" : { "type" : "string", "description" : "服务优选商品编码", "example" : "SS010301000000001234" }, "item_price" : { "type" : "string", "description" : "商品价格，这里填写的是整数，单位为分，比如1元，那么输入100", "example" : "100" }, "merchant_pid" : { "type" : "string", "description" : "商户pid", "example" : "2088301912341234" }, "mini_appid" : { "type" : "string", "description" : "商品小程序appid，若推广的商品不为小程序，则不传此参数", "example" : "2018082861168647" }, "oppor_id" : { "type" : "string", "description" : "拓展助手中的商机id", "example" : "2021101809775931" }, "order_id" : { "type" : "string", "description" : "下单订单号", "example" : "201811190000000000001100" }, "out_biz_no" : { "type" : "string", "description" : "外部业务号，传isv系统生成的账单号，需要保证唯一", "example" : "2021000000000" }, "promotor_pid" : { "type" : "string", "description" : "推广服务商(S2)pid", "example" : "2088301912341234" }, "shop_id" : { "type" : "string", "description" : "店铺id", "example" : "2019081500502000000025130577" }, "sub_promotor_pid" : { "type" : "string", "description" : "推广服务商(S2)子账号pid", "example" : "2088301912341234" } } }, "AlipayOpenSpIsvOperationSyncResponseModel" : { "type" : "object" }, "AlipayOpenSpIsvRelationQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_PARAMS", "NO_PERMIT_FOR_OPERATOR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSpIsvRelationQueryResponseModel" : { "type" : "object", "properties" : { "current_page" : { "type" : "integer", "description" : "当前页码", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "每页数量", "example" : "10" }, "promotion_relations" : { "type" : "array", "description" : "推广服务商信息列表", "items" : { "$ref" : "#/components/schemas/PromotionRelationDTO" } }, "total_size" : { "type" : "integer", "description" : "总记录数", "example" : "1000" } } }, "AlipayOpenSpIsvSalesSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "OPERATION_RESULT_RELATED_FAIL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSpIsvSalesSyncModel" : { "type" : "object", "properties" : { "merchant_sales_detail" : { "type" : "array", "description" : "商户销售数据回传的参数对象，形式为一个列表，每天回传昨日商户的销售数据。", "items" : { "$ref" : "#/components/schemas/IsvMerchantSalesDetailRequest" } } } }, "AlipayOpenSpIsvSalesSyncResponseModel" : { "type" : "object" }, "AlipayOpenSpIsvSignauthCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_PARAMS", "SIGNAUTH_MERCHANT_NOT_EXIST", "SIGNAUTH_ISV_NOT_EXIST", "SIGNORDER_NOT_EXSIT", "SIGNORDER_ABNORMAL", "SIGNORDER_ISV_NOT_MATCH", "SIGNORDER_MERCHANT_NOT_MATCH", "ISVAUTH_SCENE_NOT_EXIST", "ISVAUTH_SCENE_PERMISSION_NOT_MATCH", "SYSTEM_ERROR", "SIGNORDER_BINDED", "APPLY_ORDER_NOT_EXIST", "SP_DISCARD", "ILLEGAL_ISV_USER", "SP_PAUSE_OR_DELETE", "NOTICE_MERCHANT_FAIL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSpIsvSignauthCreateModel" : { "type" : "object", "properties" : { "isv_auth_scene_infos" : { "type" : "array", "description" : "代运营授权场景信息", "items" : { "$ref" : "#/components/schemas/IsvAuthSceneInfo" } }, "merchant_logon_id" : { "type" : "string", "description" : "商户登录账号\t支持手机号和邮箱账号；不支持pid", "example" : "13181141917" }, "need_app_auth" : { "type" : "string", "description" : "1表示需要，0表示不需要\t不传参数默认是需要（1）\t是否创建三方应用授权子任务，也就是是否需要给三方应用授权", "example" : "1" }, "sign_order_no" : { "type" : "string", "description" : "签约单号\t可通过alipay.open.agent.confirm接口获取签约单号", "example" : "20211015034000100000052128459671" } } }, "AlipayOpenSpIsvSignauthCreateResponseModel" : { "type" : "object", "properties" : { "order_id" : { "type" : "string", "description" : "签约授权一体化主单ID", "example" : "20211102034000100000047728652233" } } }, "AlipayOpenSpIsvSignauthQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_PARAMS", "SIGNAUTH_ORDER_NOT_EXIST", "SIGNAUTH_ISV_NOT_MATCH", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSpIsvSignauthQueryResponseModel" : { "type" : "object", "properties" : { "order_id" : { "type" : "string", "description" : "签约授权一体化订单ID", "example" : "20211102034000100000047728652040" }, "status" : { "type" : "string", "description" : "签约授权一体化订单状态\tINIT:初始化\tUNCONFIRM:待确认\tFAILURE:失败\tFINISH:成功", "example" : "INIT" }, "task_infos" : { "type" : "array", "description" : "签约授权一体化订单子任务单信息", "items" : { "$ref" : "#/components/schemas/SubTaskInfo" } } } }, "AlipayOpenSpLeadsExpandCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "ISV_NOT_IN_WHITELIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSpLeadsExpandCreateModel" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "拓展助手商机地址", "example" : "紫金港路与文二西路交叉口向西500米西城广场" }, "city_code" : { "type" : "string", "description" : "拓展助手商机地址市code", "example" : "330100" }, "city_name" : { "type" : "string", "description" : "拓展助手商机地址市名称", "example" : "杭州市" }, "district_code" : { "type" : "string", "description" : "拓展助手商机地址区code", "example" : "330111" }, "district_name" : { "type" : "string", "description" : "拓展助手商机地址区名称", "example" : "西湖区" }, "email" : { "type" : "string", "description" : "拓展助手商机邮箱", "example" : "xxx@qq.com" }, "latitude" : { "type" : "string", "description" : "拓展助手商机地址纬度", "example" : "30.259247" }, "longitude" : { "type" : "string", "description" : "拓展助手商机地址经度", "example" : "120.13042700000001" }, "mcc" : { "type" : "string", "description" : "mcc行业", "example" : "MARKET" }, "merchant_pid" : { "type" : "string", "description" : "2088账号", "example" : "2088401299710003" }, "name" : { "type" : "string", "description" : "拓展助手商机名称", "example" : "名称" }, "out_biz_no" : { "type" : "string", "description" : "外部幂等唯一键", "example" : "out_biz_no" }, "phone" : { "type" : "string", "description" : "拓展助手商机联系电话", "example" : "13812312323" }, "province_code" : { "type" : "string", "description" : "拓展助手商机地址省code", "example" : "330000" }, "province_name" : { "type" : "string", "description" : "拓展助手商机地址省名称", "example" : "浙江省" }, "scene" : { "type" : "string", "description" : "拓展助手场景，参数约定", "example" : "IOT_RUYI_EXPAND" } } }, "AlipayOpenSpLeadsExpandCreateResponseModel" : { "type" : "object", "properties" : { "leads_id" : { "type" : "string", "description" : "商机id", "example" : "商机id" } } }, "AlipayOpenSpMerchantInconsistentApproveErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "MERCHANT_AUDITING", "ISV_NOT_IN_WHITELIST", "MERCHANT_AUDIT_PASS", "MINIAPP_NOT_BELONG_TO_MERCHANT", "ITEM_NOT_BELONG_TO_ISV", "ITEM_NOT_EXIST", "MINIAPP_NOT_EXIST", "MERCHANT_PID_NOT_EXIST", "PROMOTORP_ID_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSpMerchantInconsistentApproveModel" : { "type" : "object", "properties" : { "back_card" : { "type" : "string", "description" : "身份证背面照，图片文件大小在 50K-5M 之间，不限制长宽，支持 png、bmp、gif、jpg、jpeg 格式。 请传入alipay.open.sp.image.upload(图片上传接口) 返回的 image_id。", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "commitment_letter" : { "type" : "string", "description" : "实际经营人承诺函照片，要求证件文本信息清晰可见，图片文件大小在 50K-5M 之间，不限制长宽，支持 png、bmp、gif、jpg、jpeg 格式。 请传入alipay.open.sp.image.upload(图片上传接口) 返回的 image_id。 该资质是否必传请参见报名资质要求。", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "front_card" : { "type" : "string", "description" : "身份证正面照，要求证件文本信息清晰可见，图片文件大小在 50K-5M 之间，不限制长宽，支持 png、bmp、gif、jpg、jpeg 格式. 请传alipay.open.sp.image.upload(图片上传接口) 返回的 image_id。", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "handheld_business_license" : { "type" : "string", "description" : "手持营业执照合照，要求证件文本信息清晰可见，图片文件大小在 50K-5M 之间，不限制长宽，支持 png、bmp、gif、jpg、jpeg 格式。 请传入alipay.open.sp.image.upload(图片上传接口) 返回的 image_id。 该资质是否必传请参见报名资质要求。", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "handheld_card" : { "type" : "string", "description" : "手持身份证合照，要求证件文本信息清晰可见，图片文件大小在 50K-5M 之间，不限制长宽，支持 png、bmp、gif、jpg、jpeg 格式。 请传入alipay.open.sp.image.upload(图片上传接口) 返回的 image_id。 该资质是否必传请参见报名资质要求。", "example" : "A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA" }, "item_code" : { "type" : "string", "description" : "服务优选商品编码", "example" : "SS010301000000001234" }, "merchant_pid" : { "type" : "string", "description" : "商家pid", "example" : "2088301912341234" }, "mini_appid" : { "type" : "string", "description" : "商家小程序appId", "example" : "2021060612341234" }, "out_biz_no" : { "type" : "string", "description" : "外部业务号，需不重复", "example" : "2088100010001000" }, "promotor_pid" : { "type" : "string", "description" : "推广服务商(S2)pid", "example" : "2088301912341234" } } }, "AlipayOpenSpMerchantInconsistentApproveResponseModel" : { "type" : "object", "properties" : { "apply_no" : { "type" : "string", "description" : "申请单据编号", "example" : "2021090912341234" } } }, "AlipayOpenSpOperationApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "ILLEGAL_MERCHANT_NO", "ILLEGAL_ALIPAY_ACCOUNT", "ILLEGAL_OPERATE_TYPE", "ILLEGAL_PRODUCT_CODE", "ILLEGAL_ISV_USER", "ILLEGAL_BIND_ACCOUNT", "ILLEGAL_INDIRECT_MERCHANT", "MERCHANT_HAS_BOUND", "MERCHANT_INFO_UNCOMPLETE", "SMID_WAIT_BIND_ACCOUNT_EMPTY", "WAIT_BIND_ACCOUNT_NO_MATCH", "SP_DISCARD", "ILLEGAL_PRODUCT_CODE_PERMISSIONS", "ILLEGAL_SCENE_OR_PERMISSIONS", "SECURITY_SYSTEM_ERROR", "SP_MERCHANT_RISK_FAIL", "SP_PAUSE_OR_DELETE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSpOperationApplyModel" : { "type" : "object", "properties" : { "access_product_code" : { "type" : "string", "description" : "接入的产品编号。 枚举如下：\t* OPENAPI_BIND_DEFAULT：操作类型为账号绑定。\t* OPENAPI_AUTH_DEFAULT：操作类型为代运营授权时。", "example" : "OPENAPI_BIND_DEFAULT" }, "alipay_account" : { "type" : "string", "description" : "支付宝登录账号，通常为手机号或者邮箱。\t间连场景必填。\t直连场景选填，特别注意merchant_no和alipay_account不能同时为空，都有值优先取merchant_no。", "example" : "xxx@gmail.com" }, "isv_scene_permissions" : { "type" : "string", "description" : "场景授权列表结构结构：场景codeA:权限code1,权限code2;场景codeB:权限code1,权限code2;\t说明：\t* 本参数和access_product_code只需要传一个。\t* 场景 + 权限Code含义：\t SHOP_MANAGE:SHOP_MANAGE_BASE：管理球房信息\t MINI_APP_OPER:MINI_APP_OPER_BASE：运营支付宝小程序\t PROMOTION_MANAGE:PROMOTION_MANAGE_BASE：运营营销活动\t OPERATION_POINTS:OPERATION_POINTS_BASE：管理运营积分\t INCENTIVE_POINT_MANAGE:INCENTIVE_POINT_MANAGE_BASE：管理激励点数", "example" : "SHOP_MANAGE:SHOP_MANAGE_BASE;MINI_APP_OPER:MINI_APP_OPER_BASE;PROMOTION_MANAGE:PROMOTION_MANAGE_BASE;OPERATION_POINTS:OPERATION_POINTS_BASE" }, "merchant_no" : { "type" : "string", "description" : "支付宝商户号。\t间连场景，merchant_no必填，传入商户smid，特别注意仅支持2088开头的间连商户。\t直连场景，merchant_no选填，传入商户支付宝pid，特别注意merchant_no和alipay_account不能同时为空，优先取merchant_no。", "example" : "2088XXXX" }, "operate_type" : { "type" : "string", "description" : "代运营操作类型。枚举如下：\t* ACCOUNT_BIND：代表绑定支付宝账号，仅对于间连商户。\t* OPERATION_AUTH：代表代运营授权，支持间连和直连商户，其中间连场景包含绑定支付宝账号。", "example" : "ACCOUNT_BIND" }, "out_biz_no" : { "type" : "string", "description" : "外部操作流水，ISV自定义。每次操作需要确保唯一。", "example" : "2020124234523465636345634" } } }, "AlipayOpenSpOperationApplyResponseModel" : { "type" : "object", "properties" : { "batch_no" : { "type" : "string", "description" : "支付宝操作批次号", "example" : "2020222342342" }, "bind_account" : { "$ref" : "#/components/schemas/RecommendAccountDTO" }, "recommend_accounts" : { "type" : "array", "description" : "只针对服务商代间连商家发起代运营绑定、授权时，如果传递的alipay_account不符合绑定或授权要求，这个字段会返回推荐的商家支付宝账号列表，包括：支付宝账号和名称，为保护商家信息，账号和名称都按照规范脱敏。", "items" : { "$ref" : "#/components/schemas/RecommendAccountDTO" } } } }, "AlipayOpenSpOperationQrcodeQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "ILLEGAL_MERCHANT_NO", "ILLEGAL_ALIPAY_ACCOUNT", "ILLEGAL_OPERATE_TYPE", "ILLEGAL_PRODUCT_CODE", "ILLEGAL_ISV_USER", "ILLEGAL_BIND_ACCOUNT", "ILLEGAL_INDIRECT_MERCHANT", "MERCHANT_HAS_BOUND", "MERCHANT_INFO_UNCOMPLETE", "SMID_WAIT_BIND_ACCOUNT_EMPTY", "SP_DISCARD", "ILLEGAL_PRODUCT_CODE_PERMISSIONS", "ILLEGAL_SCENE_OR_PERMISSIONS", "SP_MERCHANT_RISK_FAIL", "SECURITY_SYSTEM_ERROR", "SP_PAUSE_OR_DELETE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSpOperationQrcodeQueryResponseModel" : { "type" : "object", "properties" : { "batch_no" : { "type" : "string", "description" : "支付宝操作批次号", "example" : "2020222342342" }, "bind_account" : { "$ref" : "#/components/schemas/RecommendAccountDTO" }, "qr_code_url" : { "type" : "string", "description" : "二维码图片地址，urlEncode处理过。\t注意：\t1.有效期为24h;\t2.用户扫码确认授权操作（同意/拒绝）后，支付宝将通过alipay.open.sp.operation.result.notify接口发送异步通知给服务商。", "example" : "http://qrcode.alipay.com/adadadad.jpg" }, "recommend_account_list" : { "type" : "array", "description" : "只针对服务商代间连商家发起代运营绑定、授权时，如果传递的alipay_account不符合绑定或授权要求，这个字段会返回推荐的商家支付宝账号列表，包括：支付宝账号和名称，为保护商家信息，账号和名称都按照规范脱敏。", "items" : { "$ref" : "#/components/schemas/RecommendAccountDTO" } }, "recommend_accounts" : { "$ref" : "#/components/schemas/RecommendAccountDTO" } } }, "AlipayOpenSpOperationResultQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "NO_PERMISSION", "AUTH_RECORD_LOSE", "BIND_RECORD_LOSE", "ILLEGAL_ISV_USER", "WAIT_BIND_ACCOUNT_NO_MATCH", "SMID_WAIT_BIND_ACCOUNT_EMPTY", "ILLEGAL_INDIRECT_MERCHANT", "ILLEGAL_ALIPAY_ACCOUNT", "ILLEGAL_PRODUCT_CODE", "ILLEGAL_BIND_ACCOUNT", "ILLEGAL_OPERATE_TYPE", "ILLEGAL_MERCHANT_NO", "SP_DISCARD", "ILLEGAL_PRODUCT_CODE_PERMISSIONS", "ILLEGAL_SCENE_OR_PERMISSIONS", "SP_PAUSE_OR_DELETE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSpOperationResultQueryResponseModel" : { "type" : "object", "properties" : { "bind_user_id" : { "type" : "string", "description" : "商户支付宝pid。仅间连场景，且存在绑定关系时返回值。", "example" : "2088XXXX" }, "handle_status" : { "type" : "string", "description" : "代运营操作结果。\tSUCCESS：代表成功。\tPROCESS：待商家确认中。\tNO_PERMISSION：表示当前商家支付宝账号无权限操作。需要提醒商家切换成发起授权时指定的支付宝账号。\tNONE：表示不存在代运营绑定或授权关系。\tNONE_ACCOUNT：间连商家推荐支付宝账号列表为空。", "example" : "SUCCESS" }, "merchant_no" : { "type" : "string", "description" : "支付宝商户号。间连场景为商户smid，直连场景为商户支付宝pid", "example" : "2088XXX" } } }, "AlipayOpenSpOpporDetailQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "ISV_NOT_IN_WHITELIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSpOpporDetailQueryResponseModel" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "商机地址", "example" : "紫金港路与文二西路交叉口向西500米西城广场" }, "leads_id" : { "type" : "string", "description" : "商机Id", "example" : "2022032304216502" }, "name" : { "type" : "string", "description" : "商机名称", "example" : "智能美业" }, "oppor_id" : { "type" : "string", "description" : "商机作业Id", "example" : "2022041403518351" }, "out_biz_no" : { "type" : "string", "description" : "外部幂等唯一键", "example" : "2021110900796459" }, "phone" : { "type" : "string", "description" : "商机联系电话", "example" : "17003802762" }, "status" : { "type" : "string", "description" : "商机作业状态", "example" : "EXPAND_FAILED" } } }, "AlipayOpenSpOpporFeedbackModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "ISV_NOT_IN_WHITELIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSpOpporFeedbackModifyModel" : { "type" : "object", "properties" : { "expand_result" : { "type" : "string", "description" : "拓展助手商机拓展结果", "example" : "EXPANDED/EXPAND_FAILED" }, "isv_pid" : { "type" : "string", "description" : "服务商pid", "example" : "2088501013445414" }, "leads_id" : { "type" : "string", "description" : "商机id", "example" : "2022032304216502" }, "merchant_pid" : { "type" : "string", "description" : "拓展助手商机商家pid", "example" : "2088341444815673" }, "oppor_id" : { "type" : "string", "description" : "商机作业id", "example" : "2022041403518351" }, "sn" : { "type" : "string", "description" : "拓展设备sn号", "example" : "sn" } } }, "AlipayOpenSpOpporFeedbackModifyResponseModel" : { "type" : "object", "properties" : { "msg" : { "type" : "string", "description" : "商机拓展结果反馈结果失败描述", "example" : "msg" }, "success" : { "type" : "boolean", "description" : "商机拓展结果反馈结果是否成功", "example" : "true" } } }, "AlipayOpenSpOpporPageQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "ISV_NOT_IN_WHITELIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenSpOpporPageQueryResponseModel" : { "type" : "object", "properties" : { "current_page" : { "type" : "integer", "description" : "当前页码", "example" : "1" }, "oppor_list" : { "type" : "array", "description" : "商机作业记录列表", "items" : { "$ref" : "#/components/schemas/IsvExpandOpporDTO" } }, "page_size" : { "type" : "integer", "description" : "每页数量", "example" : "10" }, "total_size" : { "type" : "integer", "description" : "总记录数", "example" : "10" } } }, "AlipayOpenViolationViolationdetailQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "AUTHORITY_ILLEGAL", "ILLEGAL_PARAMS", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenViolationViolationdetailQueryResponseModel" : { "type" : "object", "properties" : { "appeal_dead_line" : { "type" : "string", "description" : "申诉截止日期。\t即商户可进行申诉的截止日期，若超过该时间未申诉或申诉不通过，平台不提供申诉机会，维持原处罚结果；若该时间内完成申诉且申诉通过，平台将撤销对商户的处罚", "example" : "2020-01-01 00:00:01" }, "appeal_reply_records" : { "type" : "array", "description" : "商家申诉记录", "items" : { "$ref" : "#/components/schemas/ReplyRecord" } }, "can_appeal" : { "type" : "boolean", "description" : "商家是否可以申诉", "example" : "true" }, "can_rectify" : { "type" : "boolean", "description" : "商家是否可以整改", "example" : "true" }, "punish_action" : { "type" : "array", "description" : "处罚动作及有效期", "items" : { "type" : "string" }, "example" : "[ \"警告_2020-02-14 14:23:12-2020-03-14 14:23:12\",\"小程序应用下架_2020-02-14 14:23:12-2020-03-14 14:23:12\"]" }, "rectify_dead_line" : { "type" : "string", "description" : "截止整改时间。即商户可进行整改的截止日期，若超过该时间未整改或整改不通过，平台将对商户进行处罚，若该时间内完成整改且整改通过，平台对商户不处罚", "example" : "2020-01-01 00:00:01" }, "rectify_reply_records" : { "type" : "array", "description" : "商家整改记录", "items" : { "$ref" : "#/components/schemas/ReplyRecord" } }, "status" : { "type" : "string", "description" : "违规工单状态枚举：\tPUNISH_DONE：处罚生效中\tPUNISH_APPEAL_REVOKED：处罚已撤销\tPUNISH_INVALID_REVOKED：处罚已到期\tWAITING_RECTIFY：待整改 \tRECTIFY_AUDITOR_PROCESSING：整改审核中\tRECTIFY_REJECTED：整改不通过\tRECTIFY_PASSED：整改通过\tRECTIFY_TIMEOUT ：整改已超时", "example" : "PUNISH_DONE" }, "surplus_appeal_cnt" : { "type" : "string", "description" : "剩余申诉次数。\t即在申诉截止日期内，平台允许商家申诉的次数，当商户提交申诉但申诉未通过时，剩余申诉次数减1，当整改次数为0，不管是否在整改截止日期内，平台将对商户进行处罚", "example" : "3" }, "surplus_rectify_cnt" : { "type" : "string", "description" : "剩余整改次数。即在整改截止日期内，平台允许商家整改的次数，当商户提交整改但整改未通过时，剩余整改次数减1，当整改次数为0，不管是否在整改截止日期内，平台将对商户进行处罚", "example" : "3" }, "target_id" : { "type" : "string", "description" : "违规对象ID", "example" : "2022000000000011" }, "target_name" : { "type" : "string", "description" : "违规对象名称", "example" : "xxx测试小程序" }, "target_type" : { "type" : "string", "description" : "违规对象类型\t小程序ID:APPID\t生活号ID:PUBLICID", "example" : "APPID" }, "violation_evidence" : { "type" : "array", "description" : "平台判定商家违规凭证", "items" : { "$ref" : "#/components/schemas/AuditEvidenceInfo" } }, "violation_reason" : { "type" : "string", "description" : "违规原因", "example" : "营销推广内容中出现的原价或参考价并无实际销售记录，诱导用户参与或下单交易/服务的行为。" }, "violation_record_id" : { "type" : "string", "description" : "支付宝侧生成的违规记录唯一标识", "example" : "20220524001020000000000001" }, "violation_time" : { "type" : "string", "description" : "违规时间", "example" : "2020-01-01 00:00:01" }, "violation_type" : { "type" : "string", "description" : "即平台依据平台规范/规则，判定商户的违规类型", "example" : "数据和系统安全/敏感参数泄露风险" } } }, "AlipayOpenViolationViolationeventBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "AUTHORITY_ILLEGAL", "ILLEGAL_PARAMS", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayOpenViolationViolationeventBatchqueryModel" : { "type" : "object", "properties" : { "begin_time" : { "type" : "string", "description" : "查询开始时间 时间格式：yyyy-MM-dd HH:mm:ss 若不填写，则默认当前时间30天前。 注意：begin_time和end_time时间跨度最大一年", "example" : "2020-01-01 00:00:01" }, "end_time" : { "type" : "string", "description" : "查询结束时间 时间格式：yyyy-MM-dd HH:mm:ss 若不填写，则默认当前时间。 注意：begin_time和end_time时间跨度最大一年", "example" : "2020-01-01 00:00:01" }, "status" : { "type" : "string", "description" : "违规工单状态枚举：\tPUNISH_DONE：处罚生效中\tPUNISH_APPEAL_REVOKED：处罚已撤销\tPUNISH_INVALID_REVOKED：处罚已到期\tWAITING_RECTIFY：待整改 \tRECTIFY_AUDITOR_PROCESSING：整改审核中\tRECTIFY_REJECTED：整改不通过\tRECTIFY_PASSED：整改通过\tRECTIFY_TIMEOUT ：整改已超时", "example" : "PUNISH_DONE" } } }, "AlipayOpenViolationViolationeventBatchqueryResponseModel" : { "type" : "object", "properties" : { "violation_record_infos" : { "$ref" : "#/components/schemas/ViolationEvent" } } }, "AlipayPcreditHuabeiAuthAccumulationQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "AGREEMENT_NOT_EXIST", "CALL_LIMITED", "INVALID_PERIOD" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayPcreditHuabeiAuthAccumulationQueryResponseModel" : { "type" : "object", "properties" : { "pay_amount" : { "type" : "string", "description" : "本周期内支付宝端根据用户消费情况试算出的应付费用，仅供参考使用。", "example" : "3.75" }, "total_discount_amount" : { "type" : "string", "description" : "本周期内用户累计享受的优惠金额", "example" : "2.15" }, "total_pay_count" : { "type" : "string", "description" : "本周期内用户总的消费次数", "example" : "2" }, "total_real_pay_amount" : { "type" : "string", "description" : "本周期内用户累计支付宝付款金额", "example" : "3.75" } } }, "AlipayPcreditHuabeiAuthAgreementCloseErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "AGREEMENT_NOT_EXIST", "NOT_ALLOW_CLOSE", "AGREEMENT_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayPcreditHuabeiAuthAgreementCloseModel" : { "type" : "object", "properties" : { "agreement_no" : { "type" : "string", "description" : "花芝协议号，支付宝系统中用以唯一标识用户签约记录的编号，即花芝协议号。", "example" : "20195609549841482443" }, "alipay_user_id" : { "type" : "string", "description" : "买家在支付宝的用户id", "example" : "2088101117955611" }, "open_id" : { "type" : "string", "description" : "买家在支付宝的用户id", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "out_request_no" : { "type" : "string", "description" : "外部请求号", "example" : "2019080910020821390001569835" }, "partner_id" : { "type" : "string", "description" : "商户ID", "example" : "2088101117955611" }, "quit_type" : { "type" : "string", "description" : "用户主动意愿退出：USER_CANCEL_QUIT; 商户结算退出：SETTLE_APPLY_QUIT; 默认值为SETTLE_APPLY_QUIT；这个字段会影响用户在芝麻信用合约的状态", "example" : "SETTLE_APPLY_QUIT" } } }, "AlipayPcreditHuabeiAuthAgreementCloseResponseModel" : { "type" : "object", "properties" : { "out_request_no" : { "type" : "string", "description" : "外部请求号", "example" : "2019080910020821390001569835" } } }, "AlipayPcreditHuabeiAuthAgreementQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "AGREEMENT_NOT_EXIST", "CALL_LIMITED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayPcreditHuabeiAuthAgreementQueryResponseModel" : { "type" : "object", "properties" : { "agreement_name" : { "type" : "string", "description" : "协议名称", "example" : "花呗先享会员" }, "agreement_no" : { "type" : "string", "description" : "支付宝系统中用以唯一标识用户签约记录的编号，即花芝轻会员协议号。", "example" : "20185513447859192007" }, "agreement_status" : { "type" : "string", "description" : "协议状态。Y表示状态有效，N表示状态失效", "example" : "Y" }, "alipay_user_id" : { "type" : "string", "description" : "支付宝用户userId", "example" : "2088302424419340" }, "auth_scene" : { "type" : "string", "description" : "花芝轻会员签约场景，商户和支付宝签约时确定，商户接入时需要咨询技术支持。", "example" : "EXTERNAL_PCARD" }, "external_logon_id" : { "type" : "string", "description" : "用户在商户网站的登录账号", "example" : "sample@126.com" }, "gmt_sign" : { "type" : "string", "description" : "签约时间。如果是在签状态，返回签约时间。", "example" : "2018-09-15 11:23:04" }, "gmt_unsign" : { "type" : "string", "description" : "花芝轻会员协议解约时间。如果是解约状态，才返回该字段。", "example" : "2018-09-15 11:23:04" }, "open_id" : { "type" : "string", "description" : "支付宝用户userId", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "out_biz_type" : { "type" : "string", "description" : "外部业务类型，用于区分本次业务交互在商户侧具体的业务类别，提供给商家进行特定逻辑的处理", "example" : "NORMAL_BIZ_TYPE" }, "out_sign_no" : { "type" : "string", "description" : "外部签约号，由商户提供，花芝轻会员协议中标识用户的唯一签约号（确保在商户系统中唯一）。由商户签约时传入，最终返回给商户。", "example" : "2018053100073208416400000002" }, "rest_freeze_amount" : { "type" : "string", "description" : "用户在本花芝轻会员协议中，剩余的总冻结额度（资金池总余额），数值能实时准确，可以用于核对。两位小数，单位元。", "example" : "200.00" } } }, "AlipayPcreditHuabeiAuthOrderQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "ORDER_NOT_EXIST", "CALL_LIMITED", "UNSUPPORT_OPERATION" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayPcreditHuabeiAuthOrderQueryResponseModel" : { "type" : "object", "properties" : { "agreement_no" : { "type" : "string", "description" : "支付宝系统中用以唯一标识用户签约记录的编号，即花呗先享协议号。", "example" : "20185513447859192007" }, "alipay_user_id" : { "type" : "string", "description" : "支付宝用户userId", "example" : "2088302424419340" }, "auth_opt_id" : { "type" : "string", "description" : "支付宝侧花呗冻结解冻操作单据id", "example" : "2018081010020817070009689955" }, "gmt_trans" : { "type" : "string", "description" : "业务操作完成时间", "example" : "2018-09-15 11:23:04" }, "open_id" : { "type" : "string", "description" : "支付宝用户userId", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "order_title" : { "type" : "string", "description" : "商户业务订单的简单描述，如商品名称等，长度不超过100个字母或50个汉字", "example" : "饿了么花呗先享超级会员续费冻结" }, "out_request_no" : { "type" : "string", "description" : "商户本次操作的请求流水号", "example" : "8077735255938032" }, "rest_freeze_amount" : { "type" : "string", "description" : "完成本次操作时，用户资金池余额快照。仅作提示用，请勿用于核对，并发情况下数值有可能不准确。两位小数，单位元。", "example" : "200.00" }, "seller_id" : { "type" : "string", "description" : "商户的支付宝用户id", "example" : "2088102146225135" }, "trans_amount" : { "type" : "string", "description" : "冻结或者解冻金额", "example" : "操作金额" }, "trans_status" : { "type" : "string", "description" : "业务操作状态，Y表示成功结束；N表示失败结束；I表示进行中。", "example" : "Y" }, "trans_type" : { "type" : "string", "description" : "操作类型，FREEZE表示冻结操作；UNFREEZE表示解冻操作；PAY表示支付操作；SETTLE表示结算操作", "example" : "FREEZE" } } }, "AlipayPcreditHuabeiAuthOrderUnfreezeErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "MERCHANT_STATUS_IS_NOT_NORMAL", "AGREEMENT_NOT_EXIST", "BALANCE_CHECK_ERROR", "AGREEMENT_EXPIRED", "SELLER_NOT_MATCH", "BUYER_SELLER_EQUAL", "CALL_LIMITED", "ORDER_IDEMPOTENT_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayPcreditHuabeiAuthOrderUnfreezeModel" : { "type" : "object", "properties" : { "agreement_no" : { "type" : "string", "description" : "支付宝系统中用以唯一标识用户签约记录的编号，即花呗先享协议号", "example" : "20185513447859192007" }, "alipay_user_id" : { "type" : "string", "description" : "买家在支付宝的用户id", "example" : "2088101117955611" }, "need_terminated" : { "type" : "string", "description" : "true表示需要解约。false或者不填写表示仅解冻。", "example" : "'false'" }, "open_id" : { "type" : "string", "description" : "买家在支付宝的用户id", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "order_title" : { "type" : "string", "description" : "商户业务订单的简单描述，如商品名称等，长度不超过100个字母或50个汉字", "example" : "饿了么花呗先享超级会员撤销" }, "out_request_no" : { "type" : "string", "description" : "商户本次操作的请求流水号，用于标识请求流水的唯一性，不能包含除中文、英文、数字以外的字符，需要保证在商户端不重复。", "example" : "8077735255938032" }, "seller_id" : { "type" : "string", "description" : "商户的支付宝用户id。如果该值为空，则默认为商户签约账号对应的支付宝用户ID。", "example" : "2088102146225135" }, "unfreeze_amount" : { "type" : "string", "description" : "需要解冻的金额，单位为：元（人民币），精确到小数点后两位", "example" : "3.00" } } }, "AlipayPcreditHuabeiAuthOrderUnfreezeResponseModel" : { "type" : "object", "properties" : { "agreement_no" : { "type" : "string", "description" : "支付宝系统中用以唯一标识用户签约记录的编号，即花呗先享协议号", "example" : "20185513447859192007" }, "agreement_status" : { "type" : "string", "description" : "协议状态。Y表示状态有效，N表示状态失效", "example" : "Y" }, "alipay_user_id" : { "type" : "string", "description" : "买家在支付宝的用户id", "example" : "2088101117955611" }, "auth_opt_id" : { "type" : "string", "description" : "支付宝侧花呗冻结解冻操作单据id", "example" : "2018081010020817070009689955" }, "gmt_trans" : { "type" : "string", "description" : "解冻成功时间", "example" : "2014-09-15 11:23:04" }, "open_id" : { "type" : "string", "description" : "买家在支付宝的用户id", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "out_request_no" : { "type" : "string", "description" : "商户本次操作的请求流水号，用于标识请求流水的唯一性，不能包含除中文、英文、数字以外的字符，需要保证在商户端不重复。由商户传入，最终返回给商户。", "example" : "8077735255938032" }, "rest_freeze_amount" : { "type" : "string", "description" : "完成本次操作时，用户资金池余额快照。仅作提示用，请勿用于核对，并发情况下数值有可能不准确。两位小数，单位元。", "example" : "200.00" }, "seller_id" : { "type" : "string", "description" : "商户的支付宝用户id", "example" : "2088411663864410" }, "trans_status" : { "type" : "string", "description" : "业务操作状态，Y表示成功；N表示失败。", "example" : "Y" }, "unfreeze_amount" : { "type" : "string", "description" : "解冻金额", "example" : "3.00" } } }, "AlipayPcreditHuabeiAuthRefundApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "AGREEMENT_NOT_EXIST", "REFUND_AMOUNT_CHECK_ERROR", "REQUEST_PARAM_ILLEGAL", "REQUEST_ACCESS_ILLEGAL", "REFUND_PARAM_IS_ERROR", "REFUND_AGREEMENT_STATUS_NOT_SUPPORT", "AUTH_OPT_ORDER_NOT_EXIST", "REFUND_OPT_ORDER_NOT_UNIQUE", "REFUND_OPT_ORDER_NOT_EXIST", "REFUND_TRADE_NO_NOT_EXIST", "REFUND_REQUEST_NO_IDEMPOTENT_FAIL", "REFUND_AGREEMENT_AND_USER_NOT_MATCH", "REFUND_AMOUNT_IS_ILLEGAL", "REFUND_PAY_AMOUNT_IS_EMPTY", "REFUND_AMOUNT_IS_ZERO", "REFUND_TRADE_NO_AND_AUTH_OPT_NOT_MATCH", "REFUND_PARAM_OPT_ORDER_AND_TRADE_NO_ALL_EMPTY", "REFUND_AGREEMENT_AND_PARTNER_NOT_MATCH", "REFUND_LAST_TIME_SUCCESS", "REFUND_LAST_TIME_FAIL", "REFUND_LAST_TIME_INIT", "REFUND_AGREEMENT_NOT_EXIST", "UNITRADEPROD_EXECUTE_ERROR", "TRADE_HAS_CLOSE", "SELLER_BALANCE_NOT_ENOUGH", "REFUND_AMT_NOT_EQUAL_TOTAL", "TRADE_NOT_EXIST", "TRADE_HAS_FINISHED", "REASON_TRADE_REFUND_FEE_ERR", "TRADE_NOT_ALLOW_REFUND", "REFUND_FEE_ERROR", "REASON_TRADE_BEEN_FREEZEN", "TRADE_STATUS_ERROR", "PARAM_ERROR", "REFUND_LAST_TIME_ACCEPT", "REFUND_PAY_AMOUNT_IS_ZERO" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayPcreditHuabeiAuthRefundApplyModel" : { "type" : "object", "properties" : { "agreement_no" : { "type" : "string", "description" : "签约花芝的业务协议号，在签约成功、结算成功等通知中回回传给商户。", "example" : "20205105001164318008" }, "alipay_user_id" : { "type" : "string", "description" : "支付宝用户ID", "example" : "2088302841345600" }, "auth_opt_id" : { "type" : "string", "description" : "支付宝侧授权操作单据id,在结算扣款成功的通知消息中会回传。在周期扣款场景下，和trade_no必传其中一个值。", "example" : "2018041721001001230571065758" }, "memo" : { "type" : "string", "description" : "本次退款说明", "example" : "退款" }, "open_id" : { "type" : "string", "description" : "支付宝用户ID", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "out_request_no" : { "type" : "string", "description" : "外部请求号", "example" : "99202005050100930053707258" }, "partner_id" : { "type" : "string", "description" : "商户ID", "example" : "2088302424614288" }, "refund_amount" : { "type" : "string", "description" : "退款金额，单位为：元（人民币），精确到小数点后两位", "example" : "3.00" }, "refund_type" : { "type" : "string", "description" : "MEMBER_FEE_REFUND 会员费结算退款\tWITHHOLD_FEE_REFUND 周期扣款金额退款\t默认为MEMBER_FEE_REFUND", "example" : "MEMBER_FEE_REFUND" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号,在结算扣款成功的通知中会回传。\t在周期扣款场景下，和auth_opt_id必传其中一个值。", "example" : "2013112011001004330000121536" } } }, "AlipayPcreditHuabeiAuthRefundApplyResponseModel" : { "type" : "object", "properties" : { "auth_opt_id" : { "type" : "string", "description" : "授权支付单ID", "example" : "2018041721001001230571065758" }, "fail_reason" : { "type" : "string", "description" : "退款操作错误原因描述", "example" : "退款金额超限" }, "out_request_no" : { "type" : "string", "description" : "外部请求号", "example" : "99202005050100930053707258" }, "retry" : { "type" : "boolean", "description" : "是否可重试", "example" : "true" } } }, "AlipayPcreditHuabeiAuthSettleApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "AGREEMENT_NOT_EXIST", "AGREEMENT_EXPIRED", "PAY_AMOUNT_CHECK_ERROR", "AUTH_SCENE_NOT_SUPPORTED_ERROR", "ORDER_IDEMPOTENT_ERROR", "ORDER_ALREADY_DEAL", "ORDER_NOT_EXIST", "PAY_AMOUNT_IDEMPOTENT_ERROR", "BEYOND_PAY_RESTRICTION", "ACCESS_FORBIDDEN", "BUYER_ENABLE_STATUS_FORBID", "TOTAL_FEE_EXCEED", "INVALID_RECEIVE_ACCOUNT", "BUYER_PAYMENT_AMOUNT_DAY_LIMIT", "CONTEXT_INCONSISTENT", "BUYER_PAYMENT_AMOUNT_MONTH_LIMIT", "PAYMENT_REQUEST_HAS_RISK", "AGREEMENT_INVALID", "AGREEMENT_ERROR", "BUSINESS_ERROR", "PRODUCT_AMOUNT_LIMIT_ERROR", "CALL_LIMITED", "CONCURRENT_OPERATION_ERROR", "INVALID_SETTLEMENT_INFO", "INVALID_SETTLE_TIME" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayPcreditHuabeiAuthSettleApplyModel" : { "type" : "object", "properties" : { "action_type" : { "type" : "string", "description" : "操作类型，默认为 MERCHANT_SETTLE（结算）。枚举值如下：\t* MERCHANT_SETTLE：结算（需要主动退出在发起结算）;\t* QUIT_SETTLE：退出协议（解约协议）;\t* PERIOD_SETTLE：分阶段结算（不解约协议）。", "example" : "PERIOD_SETTLE" }, "agreement_no" : { "type" : "string", "description" : "支付宝系统中用以唯一标识用户签约记录的编号。", "example" : "20170502000610755993" }, "alipay_user_id" : { "type" : "string", "description" : "用户在支付宝的唯一标识，以 2088 开头的 16 位纯数字组成。", "example" : "2088101117955611" }, "extend_params" : { "$ref" : "#/components/schemas/ExtraParams" }, "need_terminated" : { "type" : "string", "description" : "是否解约，该参数控制结算完成之后的操作，为空则表示结算后解约。枚举值如下：\t* true：代表解约，默认为true。\t* false：代表不解约。", "example" : "true" }, "open_id" : { "type" : "string", "description" : "用户在支付宝的唯一标识", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "out_request_no" : { "type" : "string", "description" : "商户本次操作的请求流水号，用于标示请求流水的唯一性，不能包含除中文、英文、数字以外的字符，需要保证在商户端不重复。", "example" : "8077735255938032" }, "pay_amount" : { "type" : "string", "description" : "需要支付的金额，单位为：元（人民币），精确到小数点后两位", "example" : "3.00" }, "seller_id" : { "type" : "string", "description" : "支付宝商家ID，即商家账号在支付宝的唯一标识，以 2088 开头的 16 位纯数字组成。\t说明：若该值为空，则默认为商户签约账号对应的支付宝用户ID。", "example" : "2088102146225135" } } }, "AlipayPcreditHuabeiAuthSettleApplyResponseModel" : { "type" : "object", "properties" : { "fail_reason" : { "type" : "string", "description" : "根据商户传入的轻会员协议结算周期内累计消费数据与支付宝端轻会员协议结算周期内消费数据比对之后，若数据不一致，则会返回对应的异常数据比对结果。", "example" : "累计支付宝支付金额不一致,支付宝:100.00元,商户:150.00元" }, "out_request_no" : { "type" : "string", "description" : "商户本次操作的请求流水号，用于标示请求流水的唯一性，不能包含除中文、英文、数字以外的字符，需要保证在商户端不重复。", "example" : "8077735255938032" } } }, "AlipaySecurityDataSssCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "MANJIANG_UNIFY_TEST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipaySecurityDataSssCreateModel" : { "type" : "object", "properties" : { "area_code" : { "type" : "string", "description" : "body,可选，无openid，有枚举值，注意事项", "example" : "aaa" }, "f" : { "$ref" : "#/components/schemas/JinyoutestopenidThree" } } }, "AlipaySecurityDataSssCreateResponseModel" : { "type" : "object", "properties" : { "c" : { "type" : "string", "description" : "区", "example" : "1" }, "c_open_id" : { "type" : "string", "description" : "区", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } } }, "AlipaySecurityProdSssQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SECURITY_CHECK_FAILED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipaySecurityProdSssQueryModel" : { "type" : "object", "properties" : { "tesst" : { "type" : "array", "description" : "stst", "items" : { "$ref" : "#/components/schemas/PromiseDetail" } }, "xxx" : { "$ref" : "#/components/schemas/JinyouTestFive" } } }, "AlipaySecurityProdSssQueryResponseModel" : { "type" : "object", "properties" : { "ccc" : { "type" : "string", "description" : "1", "example" : "23" }, "ccc_open_id" : { "type" : "string", "description" : "1", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } } }, "AlipaySecurityProdTianwutestModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "XXX" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipaySecurityProdTianwutestModifyModel" : { "type" : "object", "properties" : { "tianwutest" : { "type" : "string", "description" : "测试", "example" : "1" } } }, "AlipaySecurityProdTianwutestModifyResponseModel" : { "type" : "object", "properties" : { "ceshi" : { "type" : "string", "description" : "测试", "example" : "test" } } }, "AlipaySecurityRiskCustomerriskSendErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipaySecurityRiskCustomerriskSendModel" : { "type" : "object", "properties" : { "bank_card_no" : { "type" : "string", "description" : "交易对应的银行卡的卡号（支付宝直连和间连合作伙伴均可回传此参数）", "example" : "421234234234234000" }, "business_license_no" : { "type" : "string", "description" : "该账号对应的营业执照号码（支付宝直连和间连合作伙伴均可回传此参数）", "example" : "34xggdf345" }, "cert_no" : { "type" : "string", "description" : "该用户对应的身份证号码（支付宝直连和间连合作伙伴均可回传此参数）", "example" : "659004198009128344" }, "email_address" : { "type" : "string", "description" : "账户注册时填写的邮箱地址(适用于支付宝直连商户回传此信息)", "example" : "12345@abcd.com" }, "external_id" : { "type" : "string", "description" : "适用于间连业务场景下，商户在银行被分配的ID（适用于支付宝间连合作伙伴回传此信息）", "example" : "2088011993690428" }, "merch_name" : { "type" : "string", "description" : "该笔风险交易购买的具体商品名称（适用于支付宝直连商户回传此信息）", "example" : "游戏道具" }, "mobile" : { "type" : "string", "description" : "手机（支付宝直连和间连合作伙伴均可回传此参数）", "example" : "1359892324" }, "mobile_ip" : { "type" : "string", "description" : "该账号登录合作伙伴平台时的IP地址（适用于支付宝直连商户回传此信息）", "example" : "10.253.231.22" }, "order_ip" : { "type" : "string", "description" : "该账户在商户平台下单时的MAC地址或IP地址（适用于支付宝直连商户回传此信息）", "example" : "00000000-01010000-10111010" }, "pid" : { "type" : "string", "description" : "适用于直连商户场景下的支付宝合作伙伴ID（适用于支付宝直连合作伙伴回传此信息）", "example" : "2088123456789012" }, "plat_account" : { "type" : "string", "description" : "指第三方在商户平台注册成功后，平台给予的账户号（适用于支付宝直连商户回传此信息）", "example" : "abc123" }, "process_code" : { "type" : "string", "description" : "直连场景下，商户对该账户采取的措施：\r\t多种处理结果可调用多次，每次回传一种处理结果。\r\t（01：暂停发货；\r\t02：延迟结算；\r\t03：关停账户；\r\t04：暂停发货+关停账户；\r\t05：延迟结算+关停账户；\r\t06：其他；\r\t07：平台进行退款退订；\r\t08：平台跟用户沟通后，用户撤诉。\r\t间连场景下，商户回传处理结果：\r\t对商户的处理情况：\r\t01：已延迟结算，02：关停商户，99：其他\r\t多重处理结果可调用多次，每次回传一种处理结果", "example" : "01" }, "smid" : { "type" : "string", "description" : "指间连交易场景下商家被支付宝分配的ID（适用于支付宝间连合作伙伴回传此信息）", "example" : "17022079254" }, "trade_no" : { "type" : "string", "description" : "支付宝推送的风险消息中的交易号（支付宝直连和间连合作伙伴均需回传此参数）", "example" : "2017113021001004640000000000" } } }, "AlipaySecurityRiskCustomerriskSendResponseModel" : { "type" : "object" }, "AlipaySecurityRiskVerifyidentityMiniappConfirmErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PARAM_TAMPERED", "INVALID_ARGUMENTS", "SYSTEM_ERROR", "VERIFY_STATE_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipaySecurityRiskVerifyidentityMiniappConfirmModel" : { "type" : "object", "properties" : { "challenge" : { "type" : "string", "description" : "业务的业务流水号，例如订单id", "example" : "00123456" }, "open_id" : { "type" : "string", "description" : "蚂蚁统一会员ID，验证时会与做身份认证时候会话中的openid做比对，如不相符核验结果不通过", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "user_id" : { "type" : "string", "description" : "蚂蚁统一会员ID，验证时会与做身份认证时候会话中的userId做比对，如不相符核验结果不通过", "example" : "2088302857831249" }, "verify_id" : { "type" : "string", "description" : "核身校验id，是一次核身校验服务中唯一性的id", "example" : "0xa213nfdajbav17521" } } }, "AlipaySecurityRiskVerifyidentityMiniappConfirmResponseModel" : { "type" : "object", "properties" : { "error_code" : { "type" : "string", "description" : "身份核实校验结果失败时，返回的失败错误码", "example" : "SYSTEM_ERROR" }, "error_msg" : { "type" : "string", "description" : "身份核实校验结果失败时，返回的失败错误原因说明", "example" : "系统繁忙，请稍后再试" }, "verify_result" : { "type" : "boolean", "description" : "身份核验结果", "example" : "true" } } }, "AlipaySocialBaseContentlibStandardcontentBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "CONTENT_NOT_EXISTS", "NO_PERMISSION", "SYSTEM_ERROR", "PUBLIC_NOT_UPGRADE", "PUBLIC_NOT_EXISTS", "BUSINESS_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipaySocialBaseContentlibStandardcontentBatchqueryModel" : { "type" : "object", "properties" : { "need_detail" : { "type" : "boolean", "description" : "指示是否返回内容详情, 默认为false\tfalse: 仅返回内容ID列表\ttrue:返回 content_details", "example" : "true" }, "page_num" : { "type" : "integer", "description" : "当页分页,默认为1", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "分页记录数，最大20,默认20", "example" : "20" }, "public_id" : { "type" : "string", "description" : "生活号+号ID，只有MCN机构为达人号ID查询内容才需要传入", "example" : "2030000013518xxx" }, "status" : { "type" : "string", "description" : "内容状态，默认查询所有状态\t0-审核中 \t1-发布成功 \t2-审核不通过 \t3-己删除", "example" : "1" } } }, "AlipaySocialBaseContentlibStandardcontentBatchqueryResponseModel" : { "type" : "object", "properties" : { "content_details" : { "type" : "array", "description" : "内容详情列表", "items" : { "$ref" : "#/components/schemas/SourceContentInfo" } }, "content_ids" : { "type" : "array", "description" : "内容ID列表", "items" : { "type" : "string" }, "example" : "[\"20211022OB02001003220004xxxx\"]" }, "page_num" : { "type" : "integer", "description" : "当前分页", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "每页记录数", "example" : "20" }, "total" : { "type" : "integer", "description" : "总记录数", "example" : "100" } } }, "AlipaySystemOauthTokenErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "isv.grant-type-invalid", "isv.code-invalid", "isv.refresh-token-invalid", "isv.refresh-token-time-out", "isv.refreshed-token-invalid", "isv.unmatched-app-id", "isp.unknow-error" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipaySystemOauthTokenModel" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "授权码，用户对应用授权后得到。本参数在 grant_type 为 authorization_code 时必填；为 refresh_token 时不填。", "example" : "4b203fe6c11548bcabd8da5bb087a83b" }, "grant_type" : { "type" : "string", "description" : "授权方式。支持：\t1.authorization_code，表示换取使用用户授权码code换取授权令牌access_token。\t2.refresh_token，表示使用refresh_token刷新获取新授权令牌。", "example" : "authorization_code" }, "refresh_token" : { "type" : "string", "description" : "刷新令牌，上次换取访问令牌时得到。本参数在 grant_type 为 authorization_code 时不填；为 refresh_token 时必填，且该值来源于此接口的返回值 app_refresh_token（即至少需要通过 grant_type=authorization_code 调用此接口一次才能获取）。", "example" : "201208134b203fe6c11548bcabd8da5bb087a83b" } } }, "AlipaySystemOauthTokenResponseModel" : { "type" : "object", "properties" : { "access_token" : { "type" : "string", "description" : "访问令牌。通过该令牌调用需要授权类接口", "example" : "20120823ac6ffaa4d2d84e7384bf983531473993" }, "alipay_user_id" : { "type" : "string", "description" : "已废弃，请勿使用", "example" : "已废弃，请勿使用" }, "auth_start" : { "type" : "string", "description" : "授权token开始时间，作为有效期计算的起点", "example" : "2010-11-11 11:11:11" }, "auth_token_type" : { "type" : "string", "description" : "令牌类型，permanent表示返回的access_token和refresh_token永久有效，非永久令牌不返回该字段", "example" : "permanent" }, "expires_in" : { "type" : "string", "description" : "访问令牌的有效时间，单位是秒。", "example" : "3600" }, "open_id" : { "type" : "string", "description" : "支付宝用户唯一标识", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "re_expires_in" : { "type" : "string", "description" : "刷新令牌的有效时间，单位是秒。", "example" : "3600" }, "refresh_token" : { "type" : "string", "description" : "刷新令牌。通过该令牌可以刷新access_token", "example" : "20120823ac6ffdsdf2d84e7384bf983531473993" }, "union_id" : { "type" : "string", "description" : "union_id是支付宝用户在开放平台的唯一标识符，在配置应用分组后会返回该值。\t同一用户的union_id在同一分组内应用保持一致。", "example" : "092aSPrsmhTbexLh9zgoYb2uvZNC4D8izCpGKTem8QiIOQb" }, "user_id" : { "type" : "string", "description" : "支付宝用户的唯一标识。以2088开头的16位数字。", "example" : "2088102150477652" } } }, "AlipayTradeAdvanceConsultErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "USER_STAUTS_ERROR", "USER_NOT_EXIST", "BUYER_NOT_SUPPORT_ADVANCEPAY", "ILLEGAL_AGREEMENT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeAdvanceConsultResponseModel" : { "type" : "object", "properties" : { "refer_result" : { "type" : "boolean", "description" : "true 代表当前时间点，用户允许垫资\tfalse 代表当前时间，用户不允许垫资", "example" : "true" }, "result_code" : { "type" : "string", "description" : "用户被注销", "example" : "USER_NOT_EXIST" }, "result_message" : { "type" : "string", "description" : "返回用户不准入原因", "example" : "用户不准入" }, "risk_level" : { "type" : "string", "description" : "订单风险评估等级，在单笔订单风险预评估时返回。当基础风险校验通过时，可通过该值获取业务风险评估等级。取值：2-高风险；1-低风险。", "example" : "1" }, "user_risk_prediction" : { "$ref" : "#/components/schemas/UserRiskPrediction" }, "wait_repayment_amount" : { "type" : "string", "description" : "用户剩余的总待还金额，无论当前用户是否允许垫资，都会返回该属性。", "example" : "2.48" }, "wait_repayment_order_count" : { "type" : "integer", "description" : "用户总的未还的垫资笔数，无论用户是否允许垫资，都会返回该属性", "example" : "6" }, "wait_repayment_order_infos" : { "type" : "array", "description" : "待还订单列表，无论用户当前状态是否允许垫资，都会返回当前用户在商户下的待还订单信息", "items" : { "$ref" : "#/components/schemas/WaitRepaymentOrderInfo" } } } }, "AlipayTradeApplepayAuthenticationSubmitErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码" }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeApplepayAuthenticationSubmitModel" : { "type" : "object", "properties" : { "authentication_results" : { "type" : "array", "description" : "ApplePay核身鉴权结果，包括：支付密码、用户确认、数字签名", "items" : { "$ref" : "#/components/schemas/AuthenticationResult" } }, "device_identifier" : { "type" : "string", "description" : "Apple端的设备ID", "example" : "mKS9uBWMBT4Vv4+mgVLy7ZbMYer0XMHMfdqnOBVVr+b/iqNagFVjVWSGeSGOhDBi" }, "dpan_identifier" : { "type" : "string", "description" : "Apple绑定的BundleId", "example" : "DAPLSM20191217003050010000320000001002" }, "transaction_identifier" : { "type" : "string", "description" : "交易标识", "example" : "2020040422001424181400075556" } } }, "AlipayTradeApplepayAuthenticationSubmitResponseModel" : { "type" : "object", "properties" : { "authentication_error" : { "type" : "string", "description" : "核身错误信息", "example" : "PINMaximumTriesExceeded" }, "fallback_authentication_mechanisms" : { "type" : "array", "description" : "失败时的鉴权重试机制", "items" : { "type" : "string" }, "example" : "PaymentPINInput" }, "response_header" : { "$ref" : "#/components/schemas/OpenApiResponseHeader" }, "retry_authentication_mechanisms" : { "type" : "array", "description" : "鉴权重试机制", "items" : { "type" : "string" }, "example" : "PaymentPINInput" }, "signing_certificate" : { "type" : "string", "description" : "base64之后的证书", "example" : "R2VuZXJhdGVkIENlcnRpZmljYXRlIERhdGE=" }, "updated_authentication_details" : { "$ref" : "#/components/schemas/UpdatedAuthenticationDetails" }, "updated_transaction_status" : { "type" : "string", "description" : "交易状态", "example" : "Pending" } } }, "AlipayTradeBatchSettleErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "REQUEST_ID_REPEAT", "USER_BALANCE_NOT_ENOUGH", "CARD_BIN_CHECKER_ERROR", "DEFAULT_SETTLE_RULE_NOT_EXIST", "INVALID_STORE_ID", "SECONDARY_MERCHANT_ID_INVALID", "SETTLE_ENTITY_ID_INVALID", "SETTLE_ACCOUNT_NO_USER_INFO", "CREDIT_NOT_ALLOW", "NO_SIGN_QUICK_SETTLEMENT", "CUSTOMER_VALIDATE_ERROR", "SETTLE_ACCOUNT_INVALID", "USER_LOGONID_DUP", "QUICK_SETTLEMENT_LEFT_CREDIT_QUOTA_NOT_ENOUGH", "SETTLE_ACCOUNT_NOT_CERTIFY", "SETTLE_ACCOUNT_NOT_EXIST", "SETTLE_ACCOUNT_NO_BALANCE", "RISK_SETTLE_SUSPEND", "FREQUENCY_LIMITED", "SUB_MERCHANT_BELONG_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeBatchSettleModel" : { "type" : "object", "properties" : { "biz_product" : { "type" : "string", "description" : "收单产品码，商家和支付宝签约的产品码", "example" : "FACE_TO_FACE_PAYMENT" }, "extend_params" : { "type" : "string", "description" : "扩展参数", "example" : "{\"key\":\"value\"}" }, "out_request_no" : { "type" : "string", "description" : "结算请求外部流水号，32个字符以内、可包含字母、数字、下划线；需保证在商户端不重复，如果重复则返回该流水号对应的结算单据的状态。", "example" : "20180101" }, "settle_clauses" : { "type" : "array", "description" : "结算明细条款", "items" : { "$ref" : "#/components/schemas/SettleClause" } }, "settle_type" : { "type" : "string", "description" : "结算方式，目前仅支持提前放款结算quickSettlement，提前放款结算需要商户开通快收服务，不填则为普通结算方式", "example" : "quickSettlement" } } }, "AlipayTradeBatchSettleQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BATCH_SETTLE_NOT_EXIST", "SYSTEM_ERROR", "OPENID_APPID_NOT_MATCH" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeBatchSettleQueryModel" : { "type" : "object", "properties" : { "extend_params" : { "type" : "string", "description" : "扩展参数", "example" : "{\"key\":\"value\"}" }, "out_request_no" : { "type" : "string", "description" : "批量结算时传入的外部流水号，与settle_no二者必填其一。 out_request_no和settle_no如果同时存在，优先取settle_no", "example" : "20180101" }, "settle_no" : { "type" : "string", "description" : "结算单据号，与out_request_no二者必填其一", "example" : "2019050510032002040000053220" } } }, "AlipayTradeBatchSettleQueryResponseModel" : { "type" : "object", "properties" : { "out_request_no" : { "type" : "string", "description" : "批量结算时传入的外部流水号", "example" : "20190101" }, "settle_detail" : { "type" : "array", "description" : "批量结算详情", "items" : { "$ref" : "#/components/schemas/BatchSettleDetail" } }, "settle_no" : { "type" : "string", "description" : "结算单据号", "example" : "2019050510032002040000053220" } } }, "AlipayTradeBatchSettleResponseModel" : { "type" : "object", "properties" : { "gmt_create" : { "type" : "string", "description" : "结算受理时间", "example" : "2014-11-27 15:45:57" }, "out_request_no" : { "type" : "string", "description" : "结算请求外部流水号", "example" : "201811" }, "result_code" : { "type" : "string", "description" : "业务结果码。\r\t\r\tACCEPT_SUCCESS：受理成功；\r\tACCEPT_FAIL：受理失败；\r\tSUCCESS：结算处理成功；\r\tFAIL：结算处理失败；\r\tSYSTEM_EXCEPTION：系统异常", "example" : "ACCEPT_SUCCESS" }, "settle_no" : { "type" : "string", "description" : "结算单据号。仅当业务结果码为ACCEPT_SUCCESS 或 SUCCESS时，settle_no有效", "example" : "2018032310032002040000053220" } } }, "AlipayTradeBatchTransferErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "REQUEST_ID_REPEAT", "USER_BALANCE_NOT_ENOUGH", "CARD_BIN_CHECKER_ERROR", "DEFAULT_SETTLE_RULE_NOT_EXIST", "INVALID_STORE_ID", "SECONDARY_MERCHANT_ID_INVALID", "SETTLE_ENTITY_ID_INVALID", "SETTLE_ACCOUNT_NO_USER_INFO", "SETTLE_ACCOUNT_NOT_EXIST", "SETTLE_ACCOUNT_NOT_CERTIFY", "SETTLE_ACCOUNT_NO_BALANCE", "USER_LOGONID_DUP", "SETTLE_ACCOUNT_INVALID", "MERCHANT_RISK_LIMIT", "OPENID_APPID_NOT_MATCH" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeBatchTransferModel" : { "type" : "object", "properties" : { "extend_params" : { "type" : "string", "description" : "业务扩展参数", "example" : "{\"key\":\"value\"}" }, "out_request_no" : { "type" : "string", "description" : "结算请求外部流水号，32个字符以内、可包含字母、数字、下划线；需保证在商户端不重复", "example" : "20180101" }, "royalty_parameters" : { "type" : "array", "description" : "分账条款明细\t特别注意：最好一次只传一个分账条款。\t如果传多个，则要求出账方只能有一个，\t举例：A分给B+A分给C+A分给D=OK\tA分给B+C分给D=不行", "items" : { "$ref" : "#/components/schemas/RoyaltyDetailInfo" } } } }, "AlipayTradeBatchTransferQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "BATCH_SETTLE_NOT_EXIST", "SYSTEM_ERROR", "OPENID_APPID_NOT_MATCH" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeBatchTransferQueryResponseModel" : { "type" : "object", "properties" : { "out_request_no" : { "type" : "string", "description" : "批量结算时传入的外部流水号", "example" : "20008" }, "royalty_detail" : { "type" : "array", "description" : "批量结算详情", "items" : { "$ref" : "#/components/schemas/BatchRoyaltyDetail" } }, "settle_no" : { "type" : "string", "description" : "结算单据号", "example" : "2019050510032002040000053220" } } }, "AlipayTradeBatchTransferResponseModel" : { "type" : "object", "properties" : { "gmt_create" : { "type" : "string", "description" : "分账受理时间", "example" : "2014-11-27 15:45:57" }, "out_request_no" : { "type" : "string", "description" : "分账请求外部流水号", "example" : "2008121" }, "result_code" : { "type" : "string", "description" : "业务结果码。 ACCEPT_SUCCESS：受理成功； ACCEPT_FAIL：受理失败； SUCCESS：结算处理成功； FAIL：结算处理失败； SYSTEM_EXCEPTION：系统异常", "example" : "ACCEPT_SUCCESS" }, "settle_no" : { "type" : "string", "description" : "分账单据号", "example" : "2018032310032002040000053220" } } }, "AlipayTradeCancelErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "AQC.SYSTEM_ERROR", "ACQ.INVALID_PARAMETER", "ACQ.SELLER_BALANCE_NOT_ENOUGH", "ACQ.REASON_TRADE_BEEN_FREEZEN", "ACQ.SYSTEM_ERROR", "ACQ.TRADE_HAS_FINISHED", "ACQ.TRADE_CANCEL_TIME_OUT", "ACQ.REASON_TRADE_REFUND_FEE_ERR", "ACQ.CANCEL_NOT_ALLOWED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeCancelModel" : { "type" : "object", "properties" : { "out_trade_no" : { "type" : "string", "description" : "原支付请求的商户订单号,和支付宝交易号不能同时为空", "example" : "20150320010101001" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号，和商户订单号不能同时为空", "example" : "2014112611001004680073956707" } } }, "AlipayTradeCancelResponseModel" : { "type" : "object", "properties" : { "action" : { "type" : "string", "description" : "本次撤销触发的交易动作,接口调用成功且交易存在时返回。可能的返回值：\tclose：交易未支付，触发关闭交易动作，无退款；\trefund：交易已支付，\b触发交易退款动作；\t未返回：未查询到交易，或接口调用失败；", "example" : "close" }, "gmt_refund_pay" : { "type" : "string", "description" : "当撤销产生了退款时，返回退款时间；\t 只在银行间联交易场景下返回该信息；", "example" : "2016-11-27 15:45:57" }, "out_trade_no" : { "type" : "string", "description" : "商户订单号", "example" : "6823789339978248" }, "refund_settlement_id" : { "type" : "string", "description" : "当撤销产生了退款时，返回的退款清算编号，用于清算对账使用；\r\t只在银行间联交易场景下返回该信息；", "example" : "2018101610032004620239146945" }, "retry_flag" : { "type" : "string", "description" : "是否需要重试", "example" : "N" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号;\t当发生交易关闭或交易退款时返回；", "example" : "2013112011001004330000121536" } } }, "AlipayTradeCloseErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ACQ.SYSTEM_ERROR", "ACQ.TRADE_NOT_EXIST", "ACQ.TRADE_STATUS_ERROR", "ACQ.INVALID_PARAMETER", "ACQ.REASON_TRADE_STATUS_INVALID", "ACQ.REASON_ILLEGAL_STATUS" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeCloseModel" : { "type" : "object", "properties" : { "notify_url" : { "type" : "string", "description" : "通知地址" }, "operator_id" : { "type" : "string", "description" : "商家操作员编号 id，由商家自定义。", "example" : "YX01" }, "out_trade_no" : { "type" : "string", "description" : "订单支付时传入的商户订单号,和支付宝交易号不能同时为空。 trade_no,out_trade_no如果同时存在优先取trade_no", "example" : "HZ0120131127001" }, "trade_no" : { "type" : "string", "description" : "该交易在支付宝系统中的交易流水号。最短 16 位，最长 64 位。和out_trade_no不能同时为空，如果同时传了 out_trade_no和 trade_no，则以 trade_no为准。", "example" : "2013112611001004680073956707" } } }, "AlipayTradeCloseResponseModel" : { "type" : "object", "properties" : { "out_trade_no" : { "type" : "string", "description" : "创建交易传入的商户订单号", "example" : "YX_001" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号", "example" : "2013112111001004500000675971" } } }, "AlipayTradeCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ACQ.SYSTEM_ERROR", "ACQ.INVALID_PARAMETER", "ACQ.ACCESS_FORBIDDEN", "ACQ.EXIST_FORBIDDEN_WORD", "ACQ.PARTNER_ERROR", "ACQ.TOTAL_FEE_EXCEED", "ACQ.CONTEXT_INCONSISTENT", "ACQ.TRADE_HAS_SUCCESS", "ACQ.TRADE_HAS_CLOSE", "ACQ.BUYER_SELLER_EQUAL", "ACQ.TRADE_BUYER_NOT_MATCH", "ACQ.BUYER_ENABLE_STATUS_FORBID", "ACQ.SELLER_BEEN_BLOCKED", "ACQ.ERROR_BUYER_CERTIFY_LEVEL_LIMIT", "ACQ.SUB_MERCHANT_CREATE_FAIL", "ACQ.SUB_MERCHANT_TYPE_INVALID", "ACQ.SECONDARY_MERCHANT_STATUS_ERROR", "ACQ.BUYER_NOT_EXIST", "ACQ.PAYER_UNMATCHED", "ACQ.SECONDARY_MERCHANT_NOT_MATCH", "ACQ.TRADE_SETTLE_ERROR", "ACQ.SECONDARY_MERCHANT_ID_BLANK", "ACQ.INVALID_RECEIVE_ACCOUNT", "ACQ.SECONDARY_MERCHANT_ID_INVALID", "ACQ.BEYOND_PER_RECEIPT_SINGLE_RESTRICTION", "ACQ.SECONDARY_MERCHANT_ALIPAY_ACCOUNT_INVALID", "ACQ.SECONDARY_MERCHANT_ISV_PUNISH_INDIRECT", "ACQ.USER_LOGONID_DUP", "ACQ.CUSTOMER_VALIDATE_ERROR", "ACQ.INVALID_STORE_ID", "ACQ.SECONDARY_MERCHANT_CARD_ALIAS_NO_INVALID", "ACQ.NOT_SUPPORT_PAYMENT_INST", "ACQ.SELLER_NOT_EXIST", "ACQ.NOW_TIME_AFTER_EXPIRE_TIME_ERROR", "ACQ.ILLEGAL_ARGUMENT", "ACQ.SUB_GOODS_SIZE_MAX_COUNT", "ACQ.PLATFORM_BUSINESS_ACQUIRE_MODE_MUST_MERCHANT_ID", "ACQ.ERROR_SELLER_CERTIFY_LEVEL_LIMIT", "ACQ.STORE_INFO_INVALID", "ACQ.DEFAULT_SETTLE_RULE_NOT_EXIST", "ACQ.MERCHANT_PERM_RECEIPT_SUSPEND_LIMIT", "ACQ.MERCHANT_PERM_RECEIPT_SINGLE_LIMIT", "ACQ.MERCHANT_PERM_RECEIPT_DAY_LIMIT", "ACQ.OPEN_ID_NOT_TINY_APP", "ACQ.RISK_MERCHANT_IP_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeCreateModel" : { "type" : "object", "properties" : { "alipay_store_id" : { "type" : "string", "description" : "支付宝店铺编号。\t指商户创建球房后支付宝生成的球房ID。", "example" : "2016041400077000000003314986" }, "bkagent_req_info" : { "$ref" : "#/components/schemas/BkAgentReqInfo" }, "body" : { "type" : "string", "description" : "订单附加信息。\t如果请求时传递了该参数，将在异步通知、对账单中原样返回，同时会在商户和用户的pc账单详情中作为交易描述展示", "example" : "Iphone6 16G" }, "business_params" : { "$ref" : "#/components/schemas/BusinessParams" }, "buyer_id" : { "type" : "string", "description" : "买家支付宝用户ID。\t2088开头的16位纯数字，小程序场景下获取用户ID请参考：用户授权;\t其它场景下获取用户ID请参考：网页授权获取用户信息;\t注：交易的买家与卖家不能相同。", "example" : "2088102146225135" }, "buyer_logon_id" : { "type" : "string", "description" : "买家支付宝登录账号。\tbuyer_logon_id和buyer_id两者传其一，和buyer_id不能同时为空，建议通过buyer_id来传递买家信息。", "example" : "15901825620" }, "buyer_open_id" : { "type" : "string", "description" : "买家支付宝用户唯一标识", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "disable_pay_channels" : { "type" : "string", "description" : "禁用渠道,用户不可用指定渠道支付，多个渠道以逗号分割\r\t注，与enable_pay_channels互斥\r\t渠道列表", "example" : "pcredit,moneyFund,debitCardExpress" }, "discountable_amount" : { "type" : "string", "description" : "可打折金额。\t参与优惠计算的金额，单位为元，精确到小数点后两位，取值范围[0.01,100000000]。 \t如果同时传入了【可打折金额】、【不可打折金额】和【订单总金额】，则必须满足如下条件：【订单总金额】=【可打折金额】+【不可打折金额】。\t如果订单金额全部参与优惠计算，则【可打折金额】和【不可打折金额】都无需传入。", "example" : "80.00" }, "enable_pay_channels" : { "type" : "string", "description" : "指定支付渠道。\t用户只能使用指定的渠道进行支付，多个渠道以逗号分割。\t与disable_pay_channels互斥，支持传入的值：渠道列表。\t注：如果传入了指定支付渠道，则用户只能用指定内的渠道支付，包括营销渠道也要指定才能使用。该参数可能导致用户支付受限，慎用。", "example" : "pcredit,moneyFund,debitCardExpress" }, "ext_user_info" : { "$ref" : "#/components/schemas/ExtUserInfo" }, "extend_params" : { "$ref" : "#/components/schemas/ExtendParams" }, "goods_detail" : { "type" : "array", "description" : "订单包含的商品列表信息，json格式。", "items" : { "$ref" : "#/components/schemas/GoodsDetail" } }, "logistics_detail" : { "$ref" : "#/components/schemas/LogisticsDetail" }, "merchant_order_no" : { "type" : "string", "description" : "商户的原始订单号", "example" : "20161008001" }, "notify_url" : { "type" : "string", "description" : "通知地址" }, "operator_id" : { "type" : "string", "description" : "商户操作员编号。", "example" : "Yx_001" }, "out_trade_no" : { "type" : "string", "description" : "商户订单号。\t由商家自定义，64个字符以内，仅支持字母、数字、下划线且需保证在商户端不重复。", "example" : "20150320010101001" }, "passback_params" : { "type" : "string", "description" : "公用回传参数。\t如果请求时传递了该参数，支付宝会在异步通知时将该参数原样返回。", "example" : "merchantBizType%3d3C%26merchantBizNo%3d2016010101111" }, "product_code" : { "type" : "string", "description" : "产品码。\t商家和支付宝签约的产品码。 枚举值（点击查看签约情况）：\tFACE_TO_FACE_PAYMENT：当面付产品；\t默认值为FACE_TO_FACE_PAYMENT。", "example" : "FACE_TO_FACE_PAYMENT" }, "query_options" : { "type" : "array", "description" : "返回参数选项。 商户通过传递该参数来定制需要额外返回的信息字段，数组格式。包括但不限于：[\"enterprise_pay_info\",\"hyb_amount\"]", "items" : { "type" : "string" }, "example" : "[\"enterprise_pay_info\",\"hyb_amount\"]" }, "receiver_address_info" : { "$ref" : "#/components/schemas/ReceiverAddressInfo" }, "royalty_info" : { "$ref" : "#/components/schemas/RoyaltyInfo" }, "seller_id" : { "type" : "string", "description" : "卖家支付宝用户ID。\t当需要指定收款账号时，通过该参数传入，如果该值为空，则默认为商户签约账号对应的支付宝用户ID。\t收款账号优先级规则：球房绑定的收款账户>请求传入的seller_id>商户签约账号对应的支付宝用户ID；\t注：直付通和机构间联场景下seller_id无需传入或者保持跟pid一致；\t如果传入的seller_id与pid不一致，需要联系支付宝小二配置收款关系；", "example" : "2088102146225135" }, "settle_info" : { "$ref" : "#/components/schemas/SettleInfo" }, "store_id" : { "type" : "string", "description" : "商户球房编号。\t指商户创建球房时输入的球房编号。", "example" : "NJ_001" }, "sub_merchant" : { "$ref" : "#/components/schemas/SubMerchant" }, "subject" : { "type" : "string", "description" : "订单标题。\t注意：不可使用特殊字符，如 /，=，& 等。", "example" : "Iphone6 16G" }, "terminal_id" : { "type" : "string", "description" : "商户机具终端编号。", "example" : "NJ_T_001" }, "time_expire" : { "type" : "string", "description" : "订单绝对超时时间。\t格式为yyyy-MM-dd HH:mm:ss。\t注：time_expire和timeout_express两者只需传入一个或者都不传，如果两者都传，优先使用time_expire。", "example" : "2021-12-31 10:05:00" }, "timeout_express" : { "type" : "string", "description" : "订单相对超时时间。从交易创建时间开始计算。\t该笔订单允许的最晚付款时间，逾期将关闭交易。取值范围：1m～15d。m-分钟，h-小时，d-天，1c-当天（1c-当天的情况下，无论交易何时创建，都在0点关闭）。 该参数数值不接受小数点， 如 1.5h，可转换为 90m。\t当面付场景默认值为3h。\t注：time_expire和timeout_express两者只需传入一个或者都不传，如果两者都传，优先使用time_expire。", "example" : "90m" }, "total_amount" : { "type" : "string", "description" : "订单总金额。\t单位为元，精确到小数点后两位，取值范围：[0.01,100000000] 。", "example" : "88.88" }, "undiscountable_amount" : { "type" : "string", "description" : "不可打折金额。\t不参与优惠计算的金额，单位为元，精确到小数点后两位，取值范围[0.01,100000000]。 \t如果同时传入了【可打折金额】、【不可打折金额】和【订单总金额】，则必须满足如下条件：【订单总金额】=【可打折金额】+【不可打折金额】。\t如果订单金额全部参与优惠计算，则【可打折金额】和【不可打折金额】都无需传入。", "example" : "8.88" } } }, "AlipayTradeCreateResponseModel" : { "type" : "object", "properties" : { "out_trade_no" : { "type" : "string", "description" : "商户订单号", "example" : "20150423001001" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号", "example" : "2015042321001004720200028594" } } }, "AlipayTradeCustomsDeclareErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "TRADE_NOT_EXIST", "TRADE_STATUS_ERROR", "INVALID_PARAMETER", "CONTEXT_INCONSISTENT", "SAME_CUSTOMS_DECLARE_ONCE", "REQUEST_AMOUNT_EXCEED", "PARTNER_ERROR", "PAYER_ENABLE_STATUS_FORBID", "SYSTEM_ERROR", "PAYER_BUYER_MISMATCH", "DEPOSIT_TRADE_NOT_EXIST", "NOT_SUPPORT_SPLIT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeCustomsDeclareModel" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "报关金额，单位为人民币“元”，精确到小数点后2位。", "example" : "2" }, "buyer_info" : { "$ref" : "#/components/schemas/CustomsDeclareBuyerInfo" }, "customs_place" : { "type" : "string", "description" : "海关编号（大小写皆可）。参见“ 海关编号”。", "example" : "ZONGSHU" }, "declare_mode" : { "type" : "integer", "description" : "报关模式，默认可空，1表示需要强校验买家和支付人的身份信息。", "example" : "1" }, "deposit_trade_no" : { "type" : "string", "description" : "定金在支付宝系统中的交易流水号，最长64位。当该参数不为空时，代表为”定金+尾款“报关场景。", "example" : "2022110322001431071435352949" }, "is_split" : { "type" : "string", "description" : "商户控制本单是否拆单的报关参数。\r\t仅当该参数传值为T或者t时，才会触发拆单。", "example" : "T" }, "merchant_customs_code" : { "type" : "string", "description" : "商户在海关备案的编号。", "example" : "737203458" }, "merchant_customs_name" : { "type" : "string", "description" : "商户海关备案名称。", "example" : "龙腾国际贸易有限公司" }, "merchant_id" : { "type" : "string", "description" : "国际站商户标识", "example" : "2188120005907173" }, "out_request_no" : { "type" : "string", "description" : "报关流水号。商户生成的用于唯一标识一次报关操作的业务编号。\t建议生成规则：yyyymmdd型8位日期拼接4位序列号。每个报关请求号仅允许传入：数字、英文字母、下划线”_”、短横线”－” 。长度6-64位前后不能有空格", "example" : "9193457120563834" }, "out_trade_no" : { "type" : "string", "description" : "国际站外部订单号", "example" : "1422534255340818295" }, "sub_out_biz_no" : { "type" : "string", "description" : "拆单报关的商户子订单号。 用于区别拆单时不同子单。拆单时必须传入，否则会报INVALID_PARAMETER错误码。", "example" : "2015080811223212345453" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号。该交易在支付宝系统中的交易流水号，最长64位。", "example" : "2015051446800462" } } }, "AlipayTradeCustomsDeclareResponseModel" : { "type" : "object", "properties" : { "alipay_declare_no" : { "type" : "string", "description" : "支付宝报关流水号。", "example" : "2013112611001004680073956707" }, "currency" : { "type" : "string", "description" : "币种", "example" : "142" }, "identity_check" : { "type" : "string", "description" : "订购人身份信息和支付人的身份信息验证结果。T表示商户传入的订购人姓名和身份证号和支付人的姓名和身份证号一致。F代表商户传入的订购人姓名和身份证号和支付人的姓名和身份证号不一致。对于同一笔报关单支付宝只会校验一次，如果多次重推不会返回此参数。", "example" : "T" }, "out_trade_no" : { "type" : "string", "description" : "国际站外部订单号", "example" : "1422534255340818295" }, "pay_code" : { "type" : "string", "description" : "支付机构注册号", "example" : "31222699S7" }, "pay_transaction_id" : { "type" : "string", "description" : "清算流水号", "example" : "2019032011082610277150475" }, "total_amount" : { "type" : "string", "description" : "交易总金额(单位:分)", "example" : "133000" }, "trade_no" : { "type" : "string", "description" : "支付宝推送到海关的支付单据号。", "example" : "2013111511001004390000105126" }, "ver_dept" : { "type" : "string", "description" : "清算机构标志（1-cup,2-null,3-other）", "example" : "1" } } }, "AlipayTradeCustomsQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "MAX_OUT_REQUEST_NO_EXCEEDED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeCustomsQueryResponseModel" : { "type" : "object", "properties" : { "not_found" : { "type" : "string", "description" : "不存在记录的报关请求号。多个值用逗号分隔，单次最多10个;每个报关请求号String(32)", "example" : "201506010001,201506010002,201506010003" }, "records" : { "type" : "array", "description" : "匹配到的列表。每个记录代表一条报关记录", "items" : { "$ref" : "#/components/schemas/CustomsDeclareRecordInfo" } } } }, "AlipayTradeFastpayRefundQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ACQ.SYSTEM_ERROR", "ACQ.INVALID_PARAMETER", "TRADE_NOT_EXIST", "ACQ.TRADE_NOT_EXIST", "ACQ.ENTERPRISE_PAY_BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeFastpayRefundQueryModel" : { "type" : "object", "properties" : { "org_pid" : { "type" : "string", "description" : "银行间联模式下有用，其它场景请不要使用；\r\t双联通过该参数指定需要查询的交易所属收单机构的pid;", "example" : "2088101117952222" }, "out_request_no" : { "type" : "string", "description" : "退款请求号。\t请求退款接口时，传入的退款请求号，如果在退款请求时未传入，则该值为创建交易时的商户订单号。", "example" : "HZ01RF001" }, "out_trade_no" : { "type" : "string", "description" : "商户订单号。\t订单支付时传入的商户订单号,和支付宝交易号不能同时为空。 trade_no,out_trade_no如果同时存在优先取trade_no", "example" : "2014112611001004680073956707" }, "query_options" : { "type" : "array", "description" : "查询选项，商户通过上送该参数来定制同步需要额外返回的信息字段，数组格式。枚举支持：\trefund_detail_item_list：本次退款使用的资金渠道；\tgmt_refund_pay：退款执行成功的时间；\tdeposit_back_info：银行卡冲退信息；", "items" : { "type" : "string" }, "example" : "refund_detail_item_list" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号。\t和商户订单号不能同时为空", "example" : "2021081722001419121412730660" } } }, "AlipayTradeFastpayRefundQueryResponseModel" : { "type" : "object", "properties" : { "deposit_back_info" : { "$ref" : "#/components/schemas/DepositBackInfo" }, "enterprise_pay_info" : { "$ref" : "#/components/schemas/EnterprisePayInfo" }, "error_code" : { "type" : "string", "description" : "退款失败错误码。只在使用异步退款接口情况下才会返回该字段", "example" : "SELLER_BALANCE_NOT_ENOUGH" }, "gmt_refund_pay" : { "type" : "string", "description" : "退款时间。默认不返回该信息，需要在入参的query_options中指定\"gmt_refund_pay\"值时才返回该字段信息。", "example" : "2014-11-27 15:45:57" }, "industry_sepc_detail" : { "type" : "string", "description" : "行业特殊信息（例如在医保卡支付退款中，医保局向商户返回医疗信息）。", "example" : "[{\"bizType\":\"REFUND\",\"modelName\":\"tradeCancelContext\",\"contextData\":{\"response_content\":\"{\\\"WxResToll\\\":{\\\"dealID\\\":\\\"\\\",}}\"}}]" }, "out_request_no" : { "type" : "string", "description" : "本笔退款对应的退款请求号", "example" : "20150320010101001" }, "out_trade_no" : { "type" : "string", "description" : "创建交易传入的商户订单号", "example" : "20150320010101001" }, "present_refund_buyer_amount" : { "type" : "string", "description" : "本次退款金额中买家退款金额。单位：元。\t该字段默认不返回；", "example" : "88.88" }, "present_refund_discount_amount" : { "type" : "string", "description" : "本次退款金额中平台优惠退款金额。单位：元。\t该字段默认不返回；", "example" : "88.88" }, "present_refund_mdiscount_amount" : { "type" : "string", "description" : "本次退款金额中商家优惠退款金额。单位：元。\t该字段默认不返回；", "example" : "88.88" }, "refund_amount" : { "type" : "string", "description" : "本次退款请求，对应的退款金额。单位：元。", "example" : "12.33" }, "refund_channel_list" : { "type" : "string", "description" : "若支付渠道包含医保统筹、个账，则显示退款的渠道信息。如统筹OUTSIDEGOVCARD，个账OUTSIDEACCCARD", "example" : "OUTSIDEGOVCARD" }, "refund_channel_status" : { "type" : "string", "description" : "若支付渠道包含医保统筹、个账，全渠道退款成功时返回SUCCESS，全失败时返回FAIL，部分成功时返回PART_SUCCESS", "example" : "SUCCESS" }, "refund_charge_amount" : { "type" : "string", "description" : "本次退款针对收款方的退收费金额；单位：元。\t只在机构间联模式下返回，其它场景下不返回该字段；", "example" : "8.88" }, "refund_charge_info_list" : { "type" : "array", "description" : "退费信息", "items" : { "$ref" : "#/components/schemas/RefundChargeInfo" } }, "refund_detail_item_list" : { "type" : "array", "description" : "本次退款使用的资金渠道；\t默认不返回该信息，需要在入参的query_options中指定\"refund_detail_item_list\"值时才返回该字段信息。", "items" : { "$ref" : "#/components/schemas/TradeFundBill" } }, "refund_hyb_amount" : { "type" : "string", "description" : "本次退款金额中退惠营宝的金额。单位：元。", "example" : "10.24" }, "refund_reason" : { "type" : "string", "description" : "发起退款时，传入的退款原因", "example" : "用户退款请求" }, "refund_royaltys" : { "type" : "array", "description" : "退分账明细信息，当前仅在直付通产品中返回。", "items" : { "$ref" : "#/components/schemas/RefundRoyaltyResult" } }, "refund_settlement_id" : { "type" : "string", "description" : "退款清算编号，用于清算对账使用；\t只在机构间联模式下返回，其它场景下不返回该字段；", "example" : "2018101610032004620239146945" }, "refund_status" : { "type" : "string", "description" : "退款状态。枚举值：\tREFUND_SUCCESS 退款处理成功；\t未返回该字段表示退款请求未收到或者退款失败；\t注：如果退款查询发起时间早于退款时间，或者间隔退款发起时间太短，可能出现退款查询时还没处理成功，后面又处理成功的情况，建议商户在退款发起后间隔10秒以上再发起退款查询请求。", "example" : "REFUND_SUCCESS" }, "send_back_fee" : { "type" : "string", "description" : "本次商户实际退回金额；单位：元。\t默认不返回该信息，需要在入参的query_options中指定\"refund_detail_item_list\"值时才返回该字段信息。", "example" : "88" }, "total_amount" : { "type" : "string", "description" : "该笔退款所对应的交易的订单金额。单位：元。", "example" : "100.20" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号", "example" : "2014112611001004680073956707" } } }, "AlipayTradeOrderPayErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ACQ.SYSTEM_ERROR", "ACQ.INVALID_PARAMETER", "ACQ.ACCESS_FORBIDDEN", "ACQ.PARTNER_ERROR", "ACQ.TOTAL_FEE_EXCEED", "ACQ.CONTEXT_INCONSISTENT", "ACQ.TRADE_HAS_SUCCESS", "ACQ.TRADE_HAS_CLOSE", "ACQ.TRADE_BUYER_NOT_MATCH", "ACQ.AMOUNT_OR_CURRENCY_ERROR", "ACQ.AGREEMENT_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeOrderPayModel" : { "type" : "object", "properties" : { "advance_payment_type" : { "type" : "string", "description" : "垫资支付模式。支付时需要垫资的场景才传入。具体传参需与支付宝约定。\tCREDIT_FULFILLMENT_ZM 表示先用后付产品履约动作支持芝麻垫资。", "example" : "CREDIT_FULFILLMENT_ZM" }, "buyer_id" : { "type" : "string", "description" : "买家的支付宝用户id\r\t\r\t注：\r\t1.用于校验与已存交易中的买家是否相等", "example" : "2088202954065786" }, "buyer_open_id" : { "type" : "string", "description" : "买家支付宝用户唯一标识\t\t注：\t1.用于校验与已存交易中的买家是否相等", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "buyer_pay_detail" : { "type" : "array", "description" : "买家支付明细\r\t\r\t目前支持的支付渠道为：\r\t- offline_pos：本次买家使用的是pos刷卡支付\r\t\r\t注：\r\t各支付工具金额总和=订单总金额", "items" : { "$ref" : "#/components/schemas/BuyerPayDetail" } }, "fulfillment_amount" : { "type" : "string", "description" : "本次履约支付金额，单位为元，精确到小数点后两位。履约支付场景才需要传入。", "example" : "88.88" }, "is_async_pay" : { "type" : "boolean", "description" : "是否异步支付，传入true时，表明本次期望走异步支付，会先将支付请求受理下来，再异步推进。商户可以通过交易的异步通知或者轮询交易的状态来确定最终的交易结果", "example" : "true" }, "order_pay_mode" : { "type" : "string", "description" : "订单支付模式。特殊支付场景才需要传入。具体传参需与支付宝约定。\tCREDIT_FULFILLMENT_ZM表示基于芝麻授信的履约支付模式，比如芝麻先用后付产品。", "example" : "CREDIT_FULFILLMENT_ZM" }, "out_request_no" : { "type" : "string", "description" : "商户请求号，标识一次请求的唯一id，用于幂等控制。", "example" : "20200320010101001" }, "product_code" : { "type" : "string", "description" : "销售产品码", "example" : "SETTLE_OFFLINE_GROUP" }, "total_amount" : { "type" : "string", "description" : "订单总金额，单位为元，精确到小数点后两位，取值范围[0.01,100000000]\r\t\r\t注：\r\t1.用于校验与已存交易中的金额是否相等", "example" : "88.88" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号", "example" : "2018062721001004150200645134" } } }, "AlipayTradeOrderPayResponseModel" : { "type" : "object", "properties" : { "async_payment_mode" : { "type" : "string", "description" : "异步支付模式。订单使用异步支付模式时才有值。\t目前有五种值： ASYNC_DELAY_PAY(异步延时付款); ASYNC_REALTIME_PAY(异步准实时付款); SYNC_DIRECT_PAY(同步直接扣款); NORMAL_ASYNC_PAY(纯异步付款); QUOTA_OCCUPYIED_ASYNC_PAY(异步支付并且预占了先享后付额度);", "example" : "NORMAL_ASYNC_PAY" }, "gmt_payment" : { "type" : "string", "description" : "交易支付时间", "example" : "2021-03-17 09:45:57" }, "out_request_no" : { "type" : "string", "description" : "商户请求号", "example" : "20180623001001" }, "out_trade_no" : { "type" : "string", "description" : "商户订单号", "example" : "20180623001001" }, "total_amount" : { "type" : "string", "description" : "订单总金额。元为单元，精确到2位小数。", "example" : "120.88" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号", "example" : "2018062721001004150200645134" } } }, "AlipayTradeOrderSettleErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ACQ.SYSTEM_ERROR", "ACQ.INVALID_PARAMETER", "ACQ.TRADE_NOT_EXIST", "ACQ.TRADE_STATUS_ERROR", "ACQ.PARTNER_ERROR", "ACQ.DISCORDANT_REPEAT_REQUEST", "ACQ.TRADE_SETTLE_ERROR", "ACQ.USER_LOGONID_DUP", "ACQ.ROYALTY_RECEIVER_INVALID", "ACQ.ALLOC_AMOUNT_VALIDATE_ERROR", "ACQ.FREQUENCY_LIMITED", "ACQ.CUSTOMER_VALIDATE_ERROR", "ACQ.USER_ACCOUNT_HAD_FREEZEN", "ACQ.ILLEGAL_SETTLE_STATE", "ACQ.TXN_RESULT_ACCOUNT_BALANCE_NOT_ENOUGH", "ACQ.REASON_TRADE_STATUS_INVALID", "ACQ.NOT_SUPPORT_ROYALTY", "ACQ.ROYALTY_ACCOUNT_NOT_EXIST", "ACQ.ROYALTY_ACCOUNT_INVALID", "ACQ.SETTLE_ENTITY_ID_INVALID", "ACQ.ROYALTY_ACCOUNTS_EQUAL", "ACQ.DUP_OUT_REQUEST_NO", "ACQ.MERCHANT_RISK_LIMIT", "ACQ.ROYALTY_PAYER_ACCOUNT_NOT_EXIST", "ACQ.ROYALTY_RECEIVER_ACCOUNT_NOT_EXIST", "ACQ.ROYALTY_PAYER_ACCOUNT_NOT_CERTIFY", "ACQ.ROYALTY_RECEIVER_ACCOUNT_NOT_CERTIFY", "ACQ.ROYALTY_PAYER_ACCOUNT_NO_BALANCE", "ACQ.ROYALTY_RECEIVER_ACCOUNT_NO_BALANCE", "ACQ.ROYALTY_ACCOUNT_NAME_NOT_MATCH", "ACQ.SETTLE_TO_CARD_NOT_SUPPORT", "ACQ.REPLENISH_ACCOUNT_INVALID", "ACQ.INVALID_REPLENISH_AMOUNT", "ACQ.ASYNC_ALLOC_NOT_SUPPORT_IN_PERIOD", "ACQ.SECONDARY_MERCHANT_ID_INVALID", "ACQ.MUST_ALLOC_FROM_ROOT_ACCOUNT", "ACQ.UN_SUPPORT_BIZ_TYPE", "ACQ.ACCESS_FORBIDDEN" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeOrderSettleModel" : { "type" : "object", "properties" : { "extend_params" : { "$ref" : "#/components/schemas/SettleExtendParams" }, "operator_id" : { "type" : "string", "description" : "操作员 ID，商家自定义操作员编号。", "example" : "A0001" }, "out_request_no" : { "type" : "string", "description" : "结算请求流水号，由商家自定义。32个字符以内，仅可包含字母、数字、下划线。需保证在商户端不重复。", "example" : "20160727001" }, "royalty_mode" : { "type" : "string", "description" : "分账模式，目前有两种分账同步执行sync，分账异步执行async，不传默认同步执行", "example" : "async" }, "royalty_parameters" : { "type" : "array", "description" : "分账明细信息。\t注意：商家分账场景下分账收入方 trans_in 只支持支付宝账户，不支持使用 cardAliasNo 卡编号。", "items" : { "$ref" : "#/components/schemas/OpenApiRoyaltyDetailInfoPojo" } }, "trade_no" : { "type" : "string", "description" : "支付宝订单号", "example" : "2014030411001007850000672009" } } }, "AlipayTradeOrderSettleQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "MERCHANT_TRADE_NOT_MATCH", "OPENID_APPID_NOT_MATCH" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeOrderSettleQueryResponseModel" : { "type" : "object", "properties" : { "operation_dt" : { "type" : "string", "description" : "分账受理时间", "example" : "2021-07-30 12:00:00" }, "out_request_no" : { "type" : "string", "description" : "商户分账请求单号", "example" : "20210727001" }, "royalty_detail_list" : { "type" : "array", "description" : "分账明细", "items" : { "$ref" : "#/components/schemas/RoyaltyDetail" } } } }, "AlipayTradeOrderSettleResponseModel" : { "type" : "object", "properties" : { "settle_no" : { "type" : "string", "description" : "支付宝分账单号，可以根据该单号查询单次分账请求执行结果", "example" : "20210718002530070036530006474222" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号", "example" : "2015070921001004130000127422" } } }, "AlipayTradeOrderinfoSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ACQ.SYSTEM_ERROR", "ACQ.INVALID_PARAMETER", "ACQ.TRADE_NOT_EXIST", "ACQ.NOTIFY_STATUS_INVALID" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeOrderinfoSyncModel" : { "type" : "object", "properties" : { "biz_type" : { "type" : "string", "description" : "交易信息同步对应的业务类型，具体值与支付宝约定；\r\t信用授权场景下传CREDIT_AUTH\r\t信用代扣场景下传CREDIT_DEDUCT", "example" : "CREDIT_AUTH" }, "order_biz_info" : { "type" : "string", "description" : "商户传入同步信息，具体值要和支付宝约定；用于芝麻信用租车、单次授权等信息同步场景，格式为json格式。\r\t状态枚举如下：\r\t\r\tCOMPLETE：同步用户已履约\r\t适用场景：发起扣款后，芝麻生成待履约记录，如果用户通过其他方式完成订单支付，请反馈该状态，芝麻将完结待履约记录对用户形成一条良好履约记录；\r\t\r\tCLOSED： 同步履约已取消\r\t适用场景：发起扣款后，芝麻生成待履约记录，如果发现该笔扣款无效需要取消，请反馈该状态，芝麻将取消用户待履约记录；\r\t\r\tVIOLATED： 用户已违约\r\t适用场景：如果用户在约定时间（具体根据行业约定，有一定宽限期）内未完成订单支付，反馈该状态，芝麻将对用户记录一条负面记录，请谨慎使用；", "example" : "{\"status\":\"COMPLETE\"}" }, "orig_request_no" : { "type" : "string", "description" : "原始业务请求单号。如对某一次退款进行履约时，该字段传退款时的退款请求号", "example" : "HZ01RF001" }, "out_request_no" : { "type" : "string", "description" : "外部请求号，商家自定义。标识一笔交易多次请求，同一笔交易多次信息同步时需要保证唯一。", "example" : "HZ01RF001" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号", "example" : "2018061021001004680073956707" } } }, "AlipayTradeOrderinfoSyncResponseModel" : { "type" : "object", "properties" : { "buyer_open_id" : { "type" : "string", "description" : "买家支付宝用户唯一标识", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "buyer_user_id" : { "type" : "string", "description" : "买家在支付宝的用户id", "example" : "2088101117955611" }, "out_trade_no" : { "type" : "string", "description" : "商户订单号", "example" : "20180610010101001" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号", "example" : "20180610121001004680073956707" } } }, "AlipayTradeOverseasSettleErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "TRADE_NOT_EXIST", "PARTNER_ERROR", "DUP_OUT_REQUEST_NO", "TRADE_SETTLE_ERROR", "ILLEGAL_SETTLE_STATE", "REASON_ILLEGAL_STATUS", "REASON_TRADE_STATUS_INVALID", "FREQUENCY_LIMITED", "USER_ACCOUNT_HAD_FREEZEN", "DISCORDANT_REPEAT_REQUEST", "SETTLE_AMOUNT_VALIDATE_ERROR", "MINIMUM_EXCHANGE_AMOUNT_LIMIT", "TOTAL_FEE_EXCEED", "MERCHANT_AGREEMENT_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeOverseasSettleModel" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "跨境结算的人民币金额，单位为元；等于交易金额 (实际为实收金额)，加上净补差金额，减去已退款金额，减去净收费金额，再减去净分账金额，", "example" : "3.14" }, "extend_params" : { "$ref" : "#/components/schemas/OverseasExtendParams" }, "foreign_settle_currency" : { "type" : "string", "description" : "跨境结算的外币币种", "example" : "USD" }, "out_request_no" : { "type" : "string", "description" : "外部请求号，开发者自行生成并保证唯一性，作为业务幂等性控制", "example" : "20160727001" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号", "example" : "2020121921001004130000127421" } } }, "AlipayTradeOverseasSettleResponseModel" : { "type" : "object", "properties" : { "exchange_rate" : { "type" : "string", "description" : "本笔跨境结算使用的汇率，精度 8 位小数", "example" : "6.83950000" }, "foreign_settle_amount" : { "type" : "string", "description" : "本次跨境结算的实际结算外币金额", "example" : "1.00" }, "foreign_settle_currency" : { "type" : "string", "description" : "本笔跨境结算实际结算的外币币种", "example" : "USD" }, "out_request_no" : { "type" : "string", "description" : "请求流水号，开发者自行生成并保证唯一性，作为业务幂等性控制", "example" : "20160727001" }, "settle_amount" : { "type" : "string", "description" : "本次跨境结算的实际结算人民币金额", "example" : "6.00" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号", "example" : "2020121921001004130000127421" } } }, "AlipayTradePayErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ACQ.SYSTEM_ERROR", "ACQ.INVALID_PARAMETER", "ACQ.ACCESS_FORBIDDEN", "ACQ.EXIST_FORBIDDEN_WORD", "ACQ.PARTNER_ERROR", "ACQ.TOTAL_FEE_EXCEED", "ACQ.PAYMENT_AUTH_CODE_INVALID", "ACQ.CONTEXT_INCONSISTENT", "ACQ.TRADE_HAS_SUCCESS", "ACQ.TRADE_HAS_CLOSE", "ACQ.BUYER_BALANCE_NOT_ENOUGH", "ACQ.BUYER_BANKCARD_BALANCE_NOT_ENOUGH", "ACQ.ERROR_BALANCE_PAYMENT_DISABLE", "ACQ.BUYER_SELLER_EQUAL", "ACQ.TRADE_BUYER_NOT_MATCH", "ACQ.BUYER_ENABLE_STATUS_FORBID", "ACQ.PULL_MOBILE_CASHIER_FAIL", "ACQ.MOBILE_PAYMENT_SWITCH_OFF", "ACQ.PAYMENT_FAIL", "ACQ.BUYER_PAYMENT_AMOUNT_DAY_LIMIT_ERROR", "ACQ.BEYOND_PAY_RESTRICTION", "ACQ.BEYOND_PER_RECEIPT_RESTRICTION", "ACQ.BUYER_PAYMENT_AMOUNT_MONTH_LIMIT_ERROR", "ACQ.SELLER_BEEN_BLOCKED", "ACQ.ERROR_BUYER_CERTIFY_LEVEL_LIMIT", "ACQ.PAYMENT_REQUEST_HAS_RISK", "ACQ.NO_PAYMENT_INSTRUMENTS_AVAILABLE", "ACQ.USER_FACE_PAYMENT_SWITCH_OFF", "ACQ.INVALID_STORE_ID", "ACQ.SUB_MERCHANT_CREATE_FAIL", "ACQ.SUB_MERCHANT_TYPE_INVALID", "ACQ.AGREEMENT_NOT_EXIST", "ACQ.AGREEMENT_INVALID", "ACQ.AGREEMENT_STATUS_NOT_NORMAL", "ACQ.MERCHANT_AGREEMENT_NOT_EXIST", "ACQ.MERCHANT_AGREEMENT_INVALID", "ACQ.MERCHANT_STATUS_NOT_NORMAL", "ACQ.CARD_USER_NOT_MATCH", "ACQ.CARD_TYPE_ERROR", "ACQ.CERT_EXPIRED", "ACQ.AMOUNT_OR_CURRENCY_ERROR", "ACQ.CURRENCY_NOT_SUPPORT", "ACQ.MERCHANT_UNSUPPORT_ADVANCE", "ACQ.BUYER_UNSUPPORT_ADVANCE", "ACQ.ORDER_UNSUPPORT_ADVANCE", "ACQ.CYCLE_PAY_DATE_NOT_MATCH", "ACQ.CYCLE_PAY_SINGLE_FEE_EXCEED", "ACQ.CYCLE_PAY_TOTAL_FEE_EXCEED", "ACQ.CYCLE_PAY_TOTAL_TIMES_EXCEED", "ACQ.SECONDARY_MERCHANT_STATUS_ERROR", "ACQ.AUTH_NO_ERROR", "ACQ.BUYER_NOT_EXIST", "ACQ.PRODUCT_AMOUNT_LIMIT_ERROR", "ACQ.SECONDARY_MERCHANT_ALIPAY_ACCOUNT_INVALID", "ACQ.INVALID_RECEIVE_ACCOUNT", "ACQ.SELLER_NOT_EXIST", "ACQ.AUTH_AMOUNT_NOT_ENOUGH", "ACQ.AGREEMENT_ERROR", "ACQ.BEYOND_PER_RECEIPT_SINGLE_RESTRICTION", "ACQ.PAYER_UNMATCHED", "ACQ.PRE_AUTH_PROD_CODE_INCONSISTENT", "ACQ.SECONDARY_MERCHANT_ID_INVALID", "ACQ.NOW_TIME_AFTER_EXPIRE_TIME_ERROR", "ACQ.SECONDARY_MERCHANT_NOT_MATCH", "ACQ.REQUEST_AMOUNT_EXCEED", "ACQ.SUB_GOODS_SIZE_MAX_COUNT", "ACQ.NOT_SUPPORT_PAYMENT_INST", "ACQ.BUYER_NOT_MAINLAND_CERT", "ACQ.SECONDARY_MERCHANT_ID_BLANK", "ACQ.TRADE_SETTLE_ERROR", "ACQ.AUTH_TOKEN_IS_NOT_EXIST", "ACQ.SMILE_PAY_MERCHANT_NOT_MATCH", "ACQ.NOT_CERTIFIED_USER", "ACQ.SECONDARY_MERCHANT_ISV_PUNISH_INDIRECT", "ACQ.RESTRICTED_MERCHANT_INDUSTRY", "ACQ.PLATFORM_BUSINESS_ACQUIRE_MODE_MUST_MERCHANT_ID", "ACQ.BEYOND_PER_RECEIPT_DAY_RESTRICTION", "ACQ.TRADE_STATUS_ERROR", "ACQ.MERCHANT_PERM_RECEIPT_SUSPEND_LIMIT", "ACQ.MERCHANT_PERM_RECEIPT_SINGLE_LIMIT", "ACQ.MERCHANT_PERM_RECEIPT_DAY_LIMIT", "ACQ.USER_LOGONID_DUP", "ACQ.AUTH_ORDER_NOT_PAID", "ACQ.AUTH_ORDER_HAS_FINISHED", "ACQ.AUTH_ORDER_HAS_CLOSED", "ACQ.ZM_AUTH_AMOUNT_EXCEED", "ACQ.ZM_CREDIT_AUTH_FAIL", "ACQ.ZM_AUTH_RULE_LIMIT", "ACQ.ROYALTY_ACCOUNT_NOT_EXIST", "ACQ.RISK_MERCHANT_IP_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradePayModel" : { "type" : "object", "properties" : { "advance_payment_type" : { "type" : "string", "description" : "支付模式类型,若值为ENJOY_PAY_V2表示当前交易允许走先享后付2.0垫资", "example" : "ENJOY_PAY_V2" }, "agreement_params" : { "$ref" : "#/components/schemas/AgreementParams" }, "alipay_store_id" : { "type" : "string", "description" : "支付宝店铺编号。\t指商户创建球房后支付宝生成的球房ID。", "example" : "2016041400077000000003314986" }, "auth_code" : { "type" : "string", "description" : "支付授权码。\t当面付场景传买家的付款码（25~30开头的长度为16~24位的数字，实际字符串长度以开发者获取的付款码长度为准）或者刷脸标识串（fp开头的35位字符串）；\t周期扣款或代扣场景无需传入，协议号通过agreement_params参数传递； \t支付宝预授权和新当面资金授权场景无需传入，授权订单号通过 auth_no字段传入。\t注：交易的买家与卖家不能相同。", "example" : "28763443825664394" }, "auth_confirm_mode" : { "type" : "string", "description" : "预授权确认模式。\t适用于支付宝预授权和新当面资金授权场景。枚举值：\tCOMPLETE：转交易完成后解冻剩余冻结金额；\tNOT_COMPLETE：转交易完成后不解冻剩余冻结金额；\t默认值为NOT_COMPLETE。", "example" : "COMPLETE" }, "auth_no" : { "type" : "string", "description" : "资金预授权单号。\t支付宝预授权和新当面资金授权场景下必填。", "example" : "2016110310002001760201905725" }, "bkagent_req_info" : { "$ref" : "#/components/schemas/BkAgentReqInfo" }, "body" : { "type" : "string", "description" : "订单附加信息。\t如果请求时传递了该参数，将在异步通知、对账单中原样返回，同时会在商户和用户的pc账单详情中作为交易描述展示", "example" : "Iphone6 16G" }, "business_params" : { "$ref" : "#/components/schemas/BusinessParams" }, "buyer_id" : { "type" : "string", "description" : "买家支付宝用户ID。\t支付宝预授权和新当面资金授权场景下必填，其它场景不需要传入。", "example" : "2088202954065786" }, "buyer_open_id" : { "type" : "string", "description" : "买家支付宝用户唯一标识", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "disable_pay_channels" : { "type" : "string", "description" : "禁用支付渠道。\t多个渠道以逗号分割，如同时禁用信用支付类型和积分，则传入：\"credit_group,point\"。\t支持传入的值：渠道列表", "example" : "credit_group" }, "discountable_amount" : { "type" : "string", "description" : "可打折金额。\t参与优惠计算的金额，单位为元，精确到小数点后两位，取值范围[0.01,100000000]。 \t如果同时传入了【可打折金额】、【不可打折金额】和【订单总金额】，则必须满足如下条件：【订单总金额】=【可打折金额】+【不可打折金额】。\t如果订单金额全部参与优惠计算，则【可打折金额】和【不可打折金额】都无需传入。", "example" : "80.00" }, "ext_user_info" : { "$ref" : "#/components/schemas/ExtUserInfo" }, "extend_params" : { "$ref" : "#/components/schemas/ExtendParams" }, "goods_detail" : { "type" : "array", "description" : "订单包含的商品列表信息，json格式。", "items" : { "$ref" : "#/components/schemas/GoodsDetail" } }, "is_async_pay" : { "type" : "boolean", "description" : "是否异步支付，传入true时，表明本次期望走异步支付，会先将支付请求受理下来，再异步推进。商户可以通过交易的异步通知或者轮询交易的状态来确定最终的交易结果。\t只在代扣场景下有效，其它场景无需传入。", "example" : "false" }, "merchant_order_no" : { "type" : "string", "description" : "商户的原始订单号", "example" : "201008123456789" }, "notify_url" : { "type" : "string", "description" : "通知地址" }, "operator_id" : { "type" : "string", "description" : "商户操作员编号。", "example" : "yx_001" }, "out_trade_no" : { "type" : "string", "description" : "商户订单号。\t由商家自定义，64个字符以内，仅支持字母、数字、下划线且需保证在商户端不重复。", "example" : "20150320010101001" }, "passback_params" : { "type" : "string", "description" : "公用回传参数。\t如果请求时传递了该参数，支付宝会在异步通知时将该参数原样返回。", "example" : "merchantBizType%3d3C%26merchantBizNo%3d2016010101111" }, "pay_params" : { "$ref" : "#/components/schemas/PayParams" }, "product_code" : { "type" : "string", "description" : "产品码。\t商家和支付宝签约的产品码。 枚举值（点击查看签约情况）：\tFACE_TO_FACE_PAYMENT：当面付产品；\tCYCLE_PAY_AUTH：周期扣款产品；\tGENERAL_WITHHOLDING：代扣产品；\tPRE_AUTH_ONLINE：支付宝预授权产品；\tPRE_AUTH：新当面资金授权产品；\t默认值为FACE_TO_FACE_PAYMENT。\t注意：非当面付产品使用本接口时，本参数必填。请传入对应产品码。", "example" : "FACE_TO_FACE_PAYMENT" }, "promo_params" : { "$ref" : "#/components/schemas/PromoParam" }, "query_options" : { "type" : "array", "description" : "返回参数选项。\t商户通过传递该参数来定制同步需要额外返回的信息字段，数组格式。包括但不限于：[\"fund_bill_list\",\"voucher_detail_list\",\"enterprise_pay_info\",\"discount_goods_detail\",\"discount_amount\",\"mdiscount_amount\"]", "items" : { "type" : "string" }, "example" : "voucher_detail_list" }, "request_org_pid" : { "type" : "string", "description" : "收单机构(例如银行）的标识，填写该机构在支付宝的pid。只在机构间联场景下传递该值。", "example" : "2088201916734621" }, "royalty_info" : { "$ref" : "#/components/schemas/RoyaltyInfo" }, "scene" : { "type" : "string", "description" : "支付场景。枚举值：\tbar_code：当面付条码支付场景；\tsecurity_code：当面付刷脸支付场景，对应的auth_code为fp开头的刷脸标识串；\t周期扣款或代扣场景无需传入，协议号通过agreement_params参数传递； \t支付宝预授权和新当面资金授权场景无需传入，授权订单号通过 auth_no字段传入。\t默认值为bar_code。", "example" : "bar_code" }, "seller_id" : { "type" : "string", "description" : "卖家支付宝用户ID。\t当需要指定收款账号时，通过该参数传入，如果该值为空，则默认为商户签约账号对应的支付宝用户ID。\t收款账号优先级规则：球房绑定的收款账户>请求传入的seller_id>商户签约账号对应的支付宝用户ID；\t注：直付通和机构间联场景下seller_id无需传入或者保持跟pid一致；\t如果传入的seller_id与pid不一致，需要联系支付宝小二配置收款关系；\t支付宝预授权和新当面资金授权场景下必填。", "example" : "2088102146225135" }, "settle_currency" : { "type" : "string", "description" : "商户指定的结算币种，支持英镑：GBP、港币：HKD、美元：USD、新加坡元：SGD、日元：JPY、加拿大元：CAD、澳元：AUD、欧元：EUR、新西兰元：NZD、韩元：KRW、泰铢：THB、瑞士法郎：CHF、瑞典克朗：SEK、丹麦克朗：DKK、挪威克朗：NOK、马来西亚林吉特：MYR、印尼卢比：IDR、菲律宾比索：PHP、毛里求斯卢比：MUR、以色列新谢克尔：ILS、斯里兰卡卢比：LKR、俄罗斯卢布：RUB、阿联酋迪拉姆：AED、捷克克朗：CZK、南非兰特：ZAR、人民币：CNY", "example" : "USD" }, "settle_info" : { "$ref" : "#/components/schemas/SettleInfo" }, "store_id" : { "type" : "string", "description" : "商户球房编号。\t指商户创建球房时输入的球房编号。", "example" : "NJ_001" }, "sub_merchant" : { "$ref" : "#/components/schemas/SubMerchant" }, "subject" : { "type" : "string", "description" : "订单标题。\t注意：不可使用特殊字符，如 /，=，& 等。", "example" : "Iphone6 16G" }, "terminal_id" : { "type" : "string", "description" : "商户机具终端编号。", "example" : "NJ_T_001" }, "terminal_params" : { "type" : "string", "description" : "IOT设备信息。\t通过集成IOTSDK的机具发起的交易时传入，取值为IOTSDK生成的业务签名值。", "example" : "{\"terminalType\":\"IOT\",\"signature\":\"EXXXX\",\"apdidToken\":\"iBfdgYbXXX\",\"hardToken\":\"06014698AEFXXX\",\"time\":\"1533061133\",\"bizCode\":\"11002200020\",\"bizTid\":\"0100200mWXXX\",\"signedKeys\":\"authCode,totalAmount,apdidToken,hardToken,time,bizCode,bizTid\"}" }, "time_expire" : { "type" : "string", "description" : "订单绝对超时时间。\t格式为yyyy-MM-dd HH:mm:ss。超时时间范围：1m~15d。\t注：time_expire和timeout_express两者只需传入一个或者都不传，如果两者都传，优先使用time_expire。", "example" : "2021-12-31 10:05:00" }, "timeout_express" : { "type" : "string", "description" : "订单相对超时时间。从交易创建时间开始计算。\t\t该笔订单允许的最晚付款时间，逾期将关闭交易。取值范围：1m～15d。m-分钟，h-小时，d-天，1c-当天（1c-当天的情况下，无论交易何时创建，都在0点关闭）。 该参数数值不接受小数点， 如 1.5h，可转换为 90m。\t\t当面付场景默认值为3h；\t\t其它场景默认值为15d;", "example" : "90m" }, "total_amount" : { "type" : "string", "description" : "订单总金额。\t单位为元，精确到小数点后两位，取值范围：[0.01,100000000] 。", "example" : "88.88" }, "trans_currency" : { "type" : "string", "description" : "标价币种, total_amount 对应的币种单位。支持英镑：GBP、港币：HKD、美元：USD、新加坡元：SGD、日元：JPY、加拿大元：CAD、澳元：AUD、欧元：EUR、新西兰元：NZD、韩元：KRW、泰铢：THB、瑞士法郎：CHF、瑞典克朗：SEK、丹麦克朗：DKK、挪威克朗：NOK、马来西亚林吉特：MYR、印尼卢比：IDR、菲律宾比索：PHP、毛里求斯卢比：MUR、以色列新谢克尔：ILS、斯里兰卡卢比：LKR、俄罗斯卢布：RUB、阿联酋迪拉姆：AED、捷克克朗：CZK、南非兰特：ZAR、人民币：CNY", "example" : "USD" }, "undiscountable_amount" : { "type" : "string", "description" : "不可打折金额。\t不参与优惠计算的金额，单位为元，精确到小数点后两位，取值范围[0.01,100000000]。 \t如果同时传入了【可打折金额】、【不可打折金额】和【订单总金额】，则必须满足如下条件：【订单总金额】=【可打折金额】+【不可打折金额】。\t如果订单金额全部参与优惠计算，则【可打折金额】和【不可打折金额】都无需传入。", "example" : "8.88" } } }, "AlipayTradePayResponseModel" : { "type" : "object", "properties" : { "advance_amount" : { "type" : "string", "description" : "先享后付2.0垫资金额,不返回表示没有走垫资，非空表示垫资支付的金额", "example" : "88.8" }, "async_payment_mode" : { "type" : "string", "description" : "异步支付模式，目前有五种值：\tASYNC_DELAY_PAY(异步延时付款);\tASYNC_REALTIME_PAY(异步准实时付款);\tSYNC_DIRECT_PAY(同步直接扣款);\tNORMAL_ASYNC_PAY(纯异步付款);\tQUOTA_OCCUPYIED_ASYNC_PAY(异步支付并且预占了先享后付额度);", "example" : "SYNC_DIRECT_PAY" }, "auth_trade_pay_mode" : { "type" : "string", "description" : "预授权支付模式，该参数仅在信用预授权支付场景下返回。信用预授权支付：CREDIT_PREAUTH_PAY", "example" : "CREDIT_PREAUTH_PAY" }, "bkagent_resp_info" : { "$ref" : "#/components/schemas/BkAgentRespInfo" }, "business_params" : { "type" : "string", "description" : "商户传入业务信息，具体值要和支付宝约定\r\t将商户传入信息分发给相应系统，应用于安全，营销等参数直传场景\r\t格式为json格式", "example" : "{\"data\":\"123\"}" }, "buyer_logon_id" : { "type" : "string", "description" : "买家支付宝账号", "example" : "159****5620" }, "buyer_open_id" : { "type" : "string", "description" : "买家支付宝用户唯一标识", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "buyer_pay_amount" : { "type" : "string", "description" : "买家付款的金额", "example" : "8.88" }, "buyer_user_id" : { "type" : "string", "description" : "买家在支付宝的用户id", "example" : "2088101117955611" }, "buyer_user_name" : { "type" : "string", "description" : "买家名称；\r\t买家为个人用户时为买家姓名，买家为企业用户时为企业名称；\r\t默认不返回该信息，需与支付宝约定后配置返回；", "example" : "菜鸟网络有限公司" }, "buyer_user_type" : { "type" : "string", "description" : "买家用户类型。CORPORATE:企业用户；PRIVATE:个人用户。", "example" : "PRIVATE" }, "can_turn_to_app_pay" : { "type" : "string", "description" : "是否可以转为app支付，仅当商户代扣失败场景才会返回该字段信息", "example" : "true" }, "card_balance" : { "type" : "string", "description" : "支付宝卡余额", "example" : "98.23" }, "charge_amount" : { "type" : "string", "description" : "该笔交易针对收款方的收费金额；\t只在机构间联模式下返回，其它场景下不返回该字段；", "example" : "8.88" }, "charge_flags" : { "type" : "string", "description" : "费率活动标识。\t当交易享受特殊行业或活动费率时，返回该场景的标识。具体场景如下：\ttrade_special_00：订单优惠费率；\tindustry_special_on_00：线上行业特殊费率0；\tindustry_special_on_01：线上行业特殊费率1；\tindustry_special_00：线下行业特殊费率0；\tindustry_special_01：线下行业特殊费率1；\tbluesea_1：蓝海活动优惠费率标签；\t注：只在机构间联模式下返回，其它场景下不返回该字段；", "example" : "industry_special_00" }, "charge_info_list" : { "$ref" : "#/components/schemas/ChargeInfo" }, "credit_biz_order_id" : { "type" : "string", "description" : "信用业务单号。信用支付场景才有值。先用后付产品里是芝麻订单号。", "example" : "ZMCB99202103310000450000041833" }, "credit_pay_mode" : { "type" : "string", "description" : "信用支付模式。表示订单是采用信用支付方式（支付时买家没有出资，需要后续履约）。\"creditAdvanceV2\"表示芝麻先用后付模式，用户后续需要履约扣款。 此字段只有信用支付场景才有值，商户需要根据字段值单独处理。此字段以后可能扩展其他值，建议商户使用白名单方式识别，对于未识别的值做失败处理，并联系支付宝技术支持人员。", "example" : "creditAdvanceV2" }, "discount_amount" : { "type" : "string", "description" : "平台优惠金额", "example" : "88.88" }, "discount_goods_detail" : { "type" : "string", "description" : "本次交易支付所使用的单品券优惠的商品优惠信息。\t只有在query_options中指定时才返回该字段信息。", "example" : "[{\"goods_id\":\"STANDARD1026181538\",\"goods_name\":\"雪碧\",\"discount_amount\":\"100.00\",\"voucher_id\":\"2015102600073002039000002D5O\"}]" }, "enterprise_pay_info" : { "$ref" : "#/components/schemas/EnterprisePayInfo" }, "fund_bill_list" : { "type" : "array", "description" : "交易支付使用的资金渠道。\t只有在签约中指定需要返回资金明细，或者入参的query_options中指定时才返回该字段信息。", "items" : { "$ref" : "#/components/schemas/TradeFundBill" } }, "gmt_payment" : { "type" : "string", "description" : "交易支付时间", "example" : "2014-11-27 15:45:57" }, "hyb_amount" : { "type" : "string", "description" : "惠营宝回票金额", "example" : "10.24" }, "invoice_amount" : { "type" : "string", "description" : "交易中可给用户开具发票的金额", "example" : "12.50" }, "mdiscount_amount" : { "type" : "string", "description" : "商家优惠金额", "example" : "88.88" }, "open_id" : { "type" : "string", "description" : "买家支付宝用户号,该参数已废弃，请不要使用", "example" : "2088102122524333" }, "out_trade_no" : { "type" : "string", "description" : "商户订单号", "example" : "6823789339978248" }, "pay_amount" : { "type" : "string", "description" : "支付币种订单金额", "example" : "580.04" }, "pay_currency" : { "type" : "string", "description" : "支付币种", "example" : "CNY" }, "point_amount" : { "type" : "string", "description" : "使用集分宝付款的金额", "example" : "8.12" }, "receipt_amount" : { "type" : "string", "description" : "实收金额", "example" : "88.88" }, "receipt_currency_type" : { "type" : "string", "description" : "收款资金类型，当交易收款资金为数字人民币时返回值为“DC”，否则不返回该字段。", "example" : "DC" }, "settle_amount" : { "type" : "string", "description" : "结算币种订单金额", "example" : "88.88" }, "settle_currency" : { "type" : "string", "description" : "商户指定的结算币种，目前支持英镑：GBP、港币：HKD、美元：USD、新加坡元：SGD、日元：JPY、加拿大元：CAD、澳元：AUD、欧元：EUR、新西兰元：NZD、韩元：KRW、泰铢：THB、瑞士法郎：CHF、瑞典克朗：SEK、丹麦克朗：DKK、挪威克朗：NOK、马来西亚林吉特：MYR、印尼卢比：IDR、菲律宾比索：PHP、毛里求斯卢比：MUR、以色列新谢克尔：ILS、斯里兰卡卢比：LKR、俄罗斯卢布：RUB、阿联酋迪拉姆：AED、捷克克朗：CZK、南非兰特：ZAR、人民币：CNY", "example" : "USD" }, "settle_trans_rate" : { "type" : "string", "description" : "结算币种兑换标价币种汇率", "example" : "1" }, "settlement_id" : { "type" : "string", "description" : "支付清算编号，用于清算对账使用；\t只在机构间联模式下返回，其它场景下不返回该字段；", "example" : "2018101610032004620239146945" }, "store_name" : { "type" : "string", "description" : "发生支付交易的商户球房名称", "example" : "证大五道口店" }, "total_amount" : { "type" : "string", "description" : "交易金额", "example" : "120.88" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号", "example" : "2013112011001004330000121536" }, "trans_currency" : { "type" : "string", "description" : "标价币种, total_amount对应的币种单位。目前支持英镑：GBP、港币：HKD、美元：USD、新加坡元：SGD、日元：JPY、加拿大元：CAD、澳元：AUD、欧元：EUR、新西兰元：NZD、韩元：KRW、泰铢：THB、瑞士法郎：CHF、瑞典克朗：SEK、丹麦克朗：DKK、挪威克朗：NOK、马来西亚林吉特：MYR、印尼卢比：IDR、菲律宾比索：PHP、毛里求斯卢比：MUR、以色列新谢克尔：ILS、斯里兰卡卢比：LKR、俄罗斯卢布：RUB、阿联酋迪拉姆：AED、捷克克朗：CZK、南非兰特：ZAR、人民币：CNY", "example" : "USD" }, "trans_pay_rate" : { "type" : "string", "description" : "标价币种兑换支付币种汇率", "example" : "6.5261" }, "voucher_detail_list" : { "type" : "array", "description" : "本交易支付时使用的所有优惠券信息。\t只有在query_options中指定时才返回该字段信息。", "items" : { "$ref" : "#/components/schemas/VoucherDetail" } } } }, "AlipayTradePrecreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ACQ.SYSTEM_ERROR", "ACQ.INVALID_PARAMETER", "ACQ.ACCESS_FORBIDDEN", "ACQ.EXIST_FORBIDDEN_WORD", "ACQ.PARTNER_ERROR", "ACQ.TOTAL_FEE_EXCEED", "ACQ.CONTEXT_INCONSISTENT", "ACQ.TRADE_HAS_SUCCESS", "ACQ.TRADE_HAS_CLOSE", "ACQ.BUYER_SELLER_EQUAL", "ACQ.TRADE_BUYER_NOT_MATCH", "ACQ.BUYER_ENABLE_STATUS_FORBID", "ACQ.BUYER_PAYMENT_AMOUNT_DAY_LIMIT_ERROR", "ACQ.BEYOND_PAY_RESTRICTION", "ACQ.BEYOND_PER_RECEIPT_RESTRICTION", "ACQ.BUYER_PAYMENT_AMOUNT_MONTH_LIMIT_ERROR", "ACQ.SELLER_BEEN_BLOCKED", "ACQ.ERROR_BUYER_CERTIFY_LEVEL_LIMIT", "ACQ.INVALID_STORE_ID", "ACQ.APPLY_PC_MERCHANT_CODE_ERROR", "ACQ.SECONDARY_MERCHANT_STATUS_ERROR", "ACQ.BEYOND_PER_RECEIPT_DAY_RESTRICTION", "ACQ.BEYOND_PER_RECEIPT_SINGLE_RESTRICTION", "ACQ.TRADE_SETTLE_ERROR", "ACQ.SECONDARY_MERCHANT_ID_INVALID", "ACQ.SECONDARY_MERCHANT_ISV_PUNISH_INDIRECT", "ACQ.SELLER_NOT_EXIST", "ACQ.SECONDARY_MERCHANT_ALIPAY_ACCOUNT_INVALID", "ACQ.INVALID_RECEIVE_ACCOUNT", "ACQ.SECONDARY_MERCHANT_ID_BLANK", "ACQ.NOW_TIME_AFTER_EXPIRE_TIME_ERROR", "ACQ.SECONDARY_MERCHANT_NOT_MATCH", "ACQ.BUYER_NOT_EXIST", "ACQ.SUB_GOODS_SIZE_MAX_COUNT", "ACQ.DEFAULT_SETTLE_RULE_NOT_EXIST", "ACQ.MERCHANT_PERM_RECEIPT_SUSPEND_LIMIT", "ACQ.MERCHANT_PERM_RECEIPT_SINGLE_LIMIT", "ACQ.MERCHANT_PERM_RECEIPT_DAY_LIMIT", "ACQ.RISK_MERCHANT_IP_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradePrecreateModel" : { "type" : "object", "properties" : { "alipay_store_id" : { "type" : "string", "description" : "支付宝店铺编号。\t指商户创建球房后支付宝生成的球房ID。", "example" : "2016052600077000000015640104" }, "bkagent_req_info" : { "$ref" : "#/components/schemas/BkAgentReqInfo" }, "body" : { "type" : "string", "description" : "订单附加信息。\t如果请求时传递了该参数，将在异步通知、对账单中原样返回，同时会在商户和用户的pc账单详情中作为交易描述展示", "example" : "Iphone6 16G" }, "business_params" : { "$ref" : "#/components/schemas/BusinessParams" }, "buyer_logon_id" : { "type" : "string", "description" : "买家支付宝账号", "example" : "15901825620" }, "code_type" : { "type" : "string", "description" : "码类型，如果请求时传入了share_code，将在响应参数返回吱口令；如果为空，则默认为订单码", "example" : "share_code" }, "disable_pay_channels" : { "type" : "string", "description" : "禁用渠道,用户不可用指定渠道支付，多个渠道以逗号分割\t注，与enable_pay_channels互斥\t渠道列表", "example" : "pcredit,moneyFund,debitCardExpress" }, "discountable_amount" : { "type" : "string", "description" : "可打折金额。\t参与优惠计算的金额，单位为元，精确到小数点后两位，取值范围[0.01,100000000]。 \t如果同时传入了【可打折金额】、【不可打折金额】和【订单总金额】，则必须满足如下条件：【订单总金额】=【可打折金额】+【不可打折金额】。\t如果订单金额全部参与优惠计算，则【可打折金额】和【不可打折金额】都无需传入。", "example" : "80.00" }, "enable_pay_channels" : { "type" : "string", "description" : "指定支付渠道。\t用户只能使用指定的渠道进行支付，多个渠道以逗号分割。\t与disable_pay_channels互斥，支持传入的值：渠道列表。\t注：如果传入了指定支付渠道，则用户只能用指定内的渠道支付，包括营销渠道也要指定才能使用。该参数可能导致用户支付受限，慎用。", "example" : "pcredit,moneyFund,debitCardExpress" }, "ext_user_info" : { "$ref" : "#/components/schemas/ExtUserInfo" }, "extend_params" : { "$ref" : "#/components/schemas/ExtendParams" }, "goods_detail" : { "type" : "array", "description" : "订单包含的商品列表信息.json格式. 其它说明详见：“商品明细说明”", "items" : { "$ref" : "#/components/schemas/GoodsDetail" } }, "merchant_order_no" : { "type" : "string", "description" : "商户的原始订单号", "example" : "20161008001" }, "notify_url" : { "type" : "string", "description" : "通知地址" }, "operator_id" : { "type" : "string", "description" : "商户操作员编号。", "example" : "yx_001" }, "out_trade_no" : { "type" : "string", "description" : "商户订单号。\t由商家自定义，64个字符以内，仅支持字母、数字、下划线且需保证在商户端不重复。", "example" : "20150320010101001" }, "passback_params" : { "type" : "string", "description" : "公用回传参数。\t如果请求时传递了该参数，支付宝会在异步通知时将该参数原样返回。", "example" : "merchantBizType%3d3C%26merchantBizNo%3d2016010101111" }, "product_code" : { "type" : "string", "description" : "产品码。\t商家和支付宝签约的产品码。 枚举值（点击查看签约情况）：\tFACE_TO_FACE_PAYMENT：当面付产品；\t默认值为FACE_TO_FACE_PAYMENT。", "example" : "FACE_TO_FACE_PAYMENT" }, "qr_code_timeout_express" : { "type" : "string", "description" : "二维码订单相对超时时间。\t该笔订单允许的最晚付款时间，逾期将关闭交易，从生成二维码开始计时。 取值范围：1m～15d。m-分钟，h-小时，d-天，1c-当天（1c-当天的情况下，无论交易何时创建，都在0点关闭）。 该参数数值不接受小数点， 如 1.5h，可转换为 90m。\t注：二维码最长有效期是2小时，不管该参数传递的值是多少，超过2小时后二维码都将失效不能再进行扫码支付。", "example" : "90m" }, "query_options" : { "type" : "array", "description" : "返回参数选项。 商户通过传递该参数来定制需要额外返回的信息字段，数组格式。包括但不限于：[\"hyb_amount\",\"enterprise_pay_info\"]", "items" : { "type" : "string" }, "example" : "[\"hyb_amount\",\"enterprise_pay_info\"]" }, "royalty_info" : { "$ref" : "#/components/schemas/RoyaltyInfo" }, "seller_id" : { "type" : "string", "description" : "卖家支付宝用户ID。\t当需要指定收款账号时，通过该参数传入，如果该值为空，则默认为商户签约账号对应的支付宝用户ID。\t收款账号优先级规则：球房绑定的收款账户>请求传入的seller_id>商户签约账号对应的支付宝用户ID；\t注：直付通和机构间联场景下seller_id无需传入或者保持跟pid一致；\t如果传入的seller_id与pid不一致，需要联系支付宝小二配置收款关系；", "example" : "2088102146225135" }, "settle_info" : { "$ref" : "#/components/schemas/SettleInfo" }, "store_id" : { "type" : "string", "description" : "商户球房编号。\t指商户创建球房时输入的球房编号。", "example" : "NJ_001" }, "sub_merchant" : { "$ref" : "#/components/schemas/SubMerchant" }, "subject" : { "type" : "string", "description" : "订单标题。\t注意：不可使用特殊字符，如 /，=，& 等。", "example" : "Iphone6 16G" }, "terminal_id" : { "type" : "string", "description" : "商户机具终端编号。", "example" : "NJ_T_001" }, "time_expire" : { "type" : "string", "description" : "订单绝对超时时间。\t格式为yyyy-MM-dd HH:mm:ss。\t注：time_expire和timeout_express两者只需传入一个或者都不传，如果两者都传，优先使用time_expire。", "example" : "2021-12-31 10:05:00" }, "timeout_express" : { "type" : "string", "description" : "订单相对超时时间。 从预下单请求时间开始计算。\t该笔订单允许的最晚付款时间，逾期将关闭交易。取值范围：1m～15d。m-分钟，h-小时，d-天，1c-当天（1c-当天的情况下，无论交易何时创建，都在0点关闭）。 该参数数值不接受小数点， 如 1.5h，可转换为 90m。 \t当面付场景默认值为3h； \t\t注：\t1. 二维码最长有效期是2小时，不管该参数传递的值是多少，超过2小时后二维码都将失效不能再进行扫码支付。\t2. time_expire和timeout_express两者只需传入一个或者都不传，如果两者都传，优先使用time_expire。", "example" : "90m" }, "total_amount" : { "type" : "string", "description" : "订单总金额。\t单位为元，精确到小数点后两位，取值范围：[0.01,100000000] 。", "example" : "88.88" }, "undiscountable_amount" : { "type" : "string", "description" : "不可打折金额。\t不参与优惠计算的金额，单位为元，精确到小数点后两位，取值范围[0.01,100000000]。 \t如果同时传入了【可打折金额】、【不可打折金额】和【订单总金额】，则必须满足如下条件：【订单总金额】=【可打折金额】+【不可打折金额】。\t如果订单金额全部参与优惠计算，则【可打折金额】和【不可打折金额】都无需传入。", "example" : "8.88" } } }, "AlipayTradePrecreateResponseModel" : { "type" : "object", "properties" : { "out_trade_no" : { "type" : "string", "description" : "商户的订单号", "example" : "6823789339978248" }, "qr_code" : { "type" : "string", "description" : "当前预下单请求生成的二维码码串，有效时间2小时，可以用二维码生成工具根据该码串值生成对应的二维码", "example" : "https://qr.alipay.com/bavh4wjlxf12tper3a" }, "share_code" : { "type" : "string", "description" : "当前预下单请求生成的吱口令码串，有效时间2小时，可以在支付宝app端访问对应内容", "example" : "chb4n8A94Qc" } } }, "AlipayTradeQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ACQ.SYSTEM_ERROR", "ACQ.INVALID_PARAMETER", "ACQ.TRADE_NOT_EXIST", "ACQ.ENTERPRISE_PAY_BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeQueryModel" : { "type" : "object", "properties" : { "org_pid" : { "type" : "string", "description" : "银行间联模式下有用，其它场景请不要使用；\r\t双联通过该参数指定需要查询的交易所属收单机构的pid;", "example" : "2088101117952222" }, "out_trade_no" : { "type" : "string", "description" : "订单支付时传入的商户订单号,和支付宝交易号不能同时为空。\r\ttrade_no,out_trade_no如果同时存在优先取trade_no", "example" : "20150320010101001" }, "query_options" : { "type" : "array", "description" : "查询选项，商户传入该参数可定制本接口同步响应额外返回的信息字段，数组格式。支持枚举如下：trade_settle_info：返回的交易结算信息，包含分账、补差等信息；\tfund_bill_list：交易支付使用的资金渠道；\tvoucher_detail_list：交易支付时使用的所有优惠券信息；\tdiscount_goods_detail：交易支付所使用的单品券优惠的商品优惠信息；\tmdiscount_amount：商家优惠金额；", "items" : { "type" : "string" }, "example" : "trade_settle_info" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号，和商户订单号不能同时为空", "example" : "2014112611001004680 073956707" } } }, "AlipayTradeQueryResponseModel" : { "type" : "object", "properties" : { "alipay_store_id" : { "type" : "string", "description" : "支付宝店铺编号", "example" : "2015040900077001000100001232" }, "alipay_sub_merchant_id" : { "type" : "string", "description" : "间连商户在支付宝端的商户编号；\t 只在银行间联交易场景下返回该信息；", "example" : "2088301372182171" }, "auth_trade_pay_mode" : { "type" : "string", "description" : "预授权支付模式，该参数仅在信用预授权支付场景下返回。信用预授权支付：CREDIT_PREAUTH_PAY", "example" : "CREDIT_PREAUTH_PAY" }, "bkagent_resp_info" : { "$ref" : "#/components/schemas/BkAgentRespInfo" }, "body" : { "type" : "string", "description" : "订单描述；\t只在银行间联交易场景下返回该信息；", "example" : "Iphone6 16G" }, "buyer_logon_id" : { "type" : "string", "description" : "买家支付宝账号", "example" : "159****5620" }, "buyer_open_id" : { "type" : "string", "description" : "买家支付宝用户唯一标识", "example" : "01501o8f93I3nJAGB1jG4ONxtxV25DCN3Gec3uggnC4CJU0" }, "buyer_pay_amount" : { "type" : "string", "description" : "买家实付金额，单位为元，两位小数。该金额代表该笔交易买家实际支付的金额，不包含商户折扣等金额", "example" : "8.88" }, "buyer_user_id" : { "type" : "string", "description" : "买家在支付宝的用户id", "example" : "2088101117955611" }, "buyer_user_name" : { "type" : "string", "description" : "买家名称；\r\t买家为个人用户时为买家姓名，买家为企业用户时为企业名称；\r\t默认不返回该信息，需与支付宝约定后配置返回；", "example" : "菜鸟网络有限公司" }, "buyer_user_type" : { "type" : "string", "description" : "买家用户类型。CORPORATE:企业用户；PRIVATE:个人用户。", "example" : "PRIVATE" }, "charge_amount" : { "type" : "string", "description" : "该笔交易针对收款方的收费金额；单位：元。\t 只在银行间联交易场景下返回该信息；", "example" : "8.88" }, "charge_flags" : { "type" : "string", "description" : "费率活动标识。\t当交易享受特殊行业或活动费率时，返回该场景的标识。具体场景如下：\ttrade_special_00：订单优惠费率；\tindustry_special_on_00：线上行业特殊费率0；\tindustry_special_on_01：线上行业特殊费率1；\tindustry_special_00：线下行业特殊费率0；\tindustry_special_01：线下行业特殊费率1；\tbluesea_1：蓝海活动优惠费率标签；\t注：只在机构间联模式下返回，其它场景下不返回该字段； ", "example" : "bluesea_1" }, "charge_info_list" : { "type" : "array", "description" : "计费信息列表", "items" : { "$ref" : "#/components/schemas/ChargeInfo" } }, "credit_biz_order_id" : { "type" : "string", "description" : "信用业务单号。信用支付场景才有值，先用后付产品里是芝麻订单号。", "example" : "ZMCB99202103310000450000041833" }, "credit_pay_mode" : { "type" : "string", "description" : "信用支付模式。表示订单是采用信用支付方式（支付时买家没有出资，需要后续履约）。\"creditAdvanceV2\"表示芝麻先用后付模式，用户后续需要履约扣款。 此字段只有信用支付场景才有值，商户需要根据字段值单独处理。此字段以后可能扩展其他值，建议商户使用白名单方式识别，对于未识别的值做失败处理，并联系支付宝技术支持人员。", "example" : "creditAdvanceV2" }, "discount_amount" : { "type" : "string", "description" : "平台优惠金额。单位：元。", "example" : "88.88" }, "discount_goods_detail" : { "type" : "string", "description" : "本次交易支付所使用的单品券优惠的商品优惠信息。\t只有在query_options中指定时才返回该字段信息。", "example" : "[{\"goods_id\":\"STANDARD1026181538\",\"goods_name\":\"雪碧\",\"discount_amount\":\"100.00\",\"voucher_id\":\"2015102600073002039000002D5O\"}]" }, "enterprise_pay_info" : { "$ref" : "#/components/schemas/EnterprisePayInfo" }, "ext_infos" : { "type" : "string", "description" : "交易额外信息，特殊场景下与支付宝约定返回。\tjson格式。", "example" : "{\"action\":\"cancel\"}" }, "fund_bill_list" : { "type" : "array", "description" : "交易支付使用的资金渠道。\t只有在签约中指定需要返回资金明细，或者入参的query_options中指定时才返回该字段信息。", "items" : { "$ref" : "#/components/schemas/TradeFundBill" } }, "hb_fq_pay_info" : { "$ref" : "#/components/schemas/HbFqPayInfo" }, "hyb_amount" : { "type" : "string", "description" : "惠营宝回票金额。单位：元。", "example" : "10.24" }, "industry_sepc_detail" : { "type" : "string", "description" : "行业特殊信息（例如在医保卡支付业务中，向用户返回医疗信息）。", "example" : "{\"registration_order_pay\":{\"brlx\":\"1\",\"cblx\":\"1\"}}" }, "industry_sepc_detail_acc" : { "type" : "string", "description" : "行业特殊信息-个账相关", "example" : "{\"registration_order_pay\":{\"brlx\":\"1\",\"cblx\":\"1\"}}" }, "industry_sepc_detail_gov" : { "type" : "string", "description" : "行业特殊信息-统筹相关", "example" : "{\"registration_order_pay\":{\"brlx\":\"1\",\"cblx\":\"1\"}}" }, "invoice_amount" : { "type" : "string", "description" : "交易中用户支付的可开具发票的金额，单位为元，两位小数。该金额代表该笔交易中可以给用户开具发票的金额", "example" : "12.11" }, "mdiscount_amount" : { "type" : "string", "description" : "商家优惠金额。单位：元。", "example" : "88.88" }, "open_id" : { "type" : "string", "description" : "买家支付宝用户号，该字段将废弃，不要使用", "example" : "2088102122524333" }, "out_trade_no" : { "type" : "string", "description" : "商家订单号", "example" : "6823789339978248" }, "passback_params" : { "type" : "string", "description" : "公用回传参数。\t返回支付时传入的passback_params参数信息", "example" : "merchantBizType%3d3C%26merchantBizNo%3d2016010101111" }, "pay_amount" : { "type" : "string", "description" : "支付币种订单金额", "example" : "8.88" }, "pay_currency" : { "type" : "string", "description" : "订单支付币种", "example" : "CNY" }, "point_amount" : { "type" : "string", "description" : "积分支付的金额，单位为元，两位小数。该金额代表该笔交易中用户使用积分支付的金额，比如集分宝或者支付宝实时优惠等", "example" : "10" }, "receipt_amount" : { "type" : "string", "description" : "实收金额，单位为元，两位小数。该金额为本笔交易，商户账户能够实际收到的金额", "example" : "15.25" }, "receipt_currency_type" : { "type" : "string", "description" : "收款资金类型，当交易收款资金为数字人民币时返回值为“DC”，否则不返回该字段。", "example" : "DC" }, "send_pay_date" : { "type" : "string", "description" : "本次交易打款给卖家的时间", "example" : "2014-11-27 15:45:57" }, "settle_amount" : { "type" : "string", "description" : "结算币种订单金额", "example" : "2.96" }, "settle_currency" : { "type" : "string", "description" : "订单结算币种，对应支付接口传入的settle_currency，支持英镑：GBP、港币：HKD、美元：USD、新加坡元：SGD、日元：JPY、加拿大元：CAD、澳元：AUD、欧元：EUR、新西兰元：NZD、韩元：KRW、泰铢：THB、瑞士法郎：CHF、瑞典克朗：SEK、丹麦克朗：DKK、挪威克朗：NOK、马来西亚林吉特：MYR、印尼卢比：IDR、菲律宾比索：PHP、毛里求斯卢比：MUR、以色列新谢克尔：ILS、斯里兰卡卢比：LKR、俄罗斯卢布：RUB、阿联酋迪拉姆：AED、捷克克朗：CZK、南非兰特：ZAR", "example" : "USD" }, "settle_trans_rate" : { "type" : "string", "description" : "结算币种兑换标价币种汇率", "example" : "30.025" }, "settlement_id" : { "type" : "string", "description" : "支付清算编号，用于清算对账使用；\r\t只在银行间联交易场景下返回该信息；", "example" : "2018101610032004620239146945" }, "store_id" : { "type" : "string", "description" : "商户球房编号", "example" : "NJ_S_001" }, "store_name" : { "type" : "string", "description" : "请求交易支付中的商户店铺的名称", "example" : "证大五道口店" }, "subject" : { "type" : "string", "description" : "订单标题；\t 只在银行间联交易场景下返回该信息；", "example" : "Iphone6 16G" }, "terminal_id" : { "type" : "string", "description" : "商户机具终端编号", "example" : "NJ_T_001" }, "total_amount" : { "type" : "string", "description" : "交易的订单金额，单位为元，两位小数。该参数的值为支付时传入的total_amount", "example" : "88.88" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号", "example" : "2013112011001004330000121536" }, "trade_settle_info" : { "$ref" : "#/components/schemas/TradeSettleInfo" }, "trade_status" : { "type" : "string", "description" : "交易状态：WAIT_BUYER_PAY（交易创建，等待买家付款）、TRADE_CLOSED（未付款交易超时关闭，或支付完成后全额退款）、TRADE_SUCCESS（交易支付成功）、TRADE_FINISHED（交易结束，不可退款）", "example" : "TRADE_CLOSED" }, "trans_currency" : { "type" : "string", "description" : "标价币种，该参数的值为支付时传入的trans_currency，支持英镑：GBP、港币：HKD、美元：USD、新加坡元：SGD、日元：JPY、加拿大元：CAD、澳元：AUD、欧元：EUR、新西兰元：NZD、韩元：KRW、泰铢：THB、瑞士法郎：CHF、瑞典克朗：SEK、丹麦克朗：DKK、挪威克朗：NOK、马来西亚林吉特：MYR、印尼卢比：IDR、菲律宾比索：PHP、毛里求斯卢比：MUR、以色列新谢克尔：ILS、斯里兰卡卢比：LKR、俄罗斯卢布：RUB、阿联酋迪拉姆：AED、捷克克朗：CZK、南非兰特：ZAR、人民币：CNY、新台币：TWD。当trans_currency 和 settle_currency 不一致时，trans_currency支持人民币：CNY、新台币：TWD", "example" : "TWD" }, "trans_pay_rate" : { "type" : "string", "description" : "标价币种兑换支付币种汇率", "example" : "0.264" }, "voucher_detail_list" : { "type" : "array", "description" : "本交易支付时使用的所有优惠券信息。\t只有在query_options中指定时才返回该字段信息。", "items" : { "$ref" : "#/components/schemas/VoucherDetail" } } } }, "AlipayTradeRefundApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ACQ.SYSTEM_ERROR", "ACQ.INVALID_PARAMETER", "ACQ.REFUND_AMT_NOT_EQUAL_TOTAL", "ACQ.TRADE_NOT_EXIST", "ACQ.TRADE_HAS_FINISHED", "ACQ.TRADE_STATUS_ERROR", "ACQ.DISCORDANT_REPEAT_REQUEST", "ACQ.REASON_TRADE_REFUND_FEE_ERR", "ACQ.TRADE_NOT_ALLOW_REFUND", "ACQ.REASON_ILLEGAL_STATUS", "ACQ.REFUND_TRADE_FEE_ERROR", "ACQ.UN_SUPPORT_BIZ_TYPE", "ACQ.TRADE_HAS_CLOSE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeRefundApplyModel" : { "type" : "object", "properties" : { "extend_params" : { "type" : "string", "description" : "商户传入业务信息，具体值要和支付宝约定，格式为json格式。\r\t医保退款场景下，DESIGNATED_REFUND_ASSET为INNER_ASSET表示只退自费部分，DESIGNATED_REFUND_ASSET为OUTSIDE_ASSET表示只退医保部分，医保部分不支持部分退。退医保资金必需传cancel_bill_no和cancel_serial_no。", "example" : "{\"DESIGNATED_REFUND_ASSET\" :\"OUTSIDE_ASSET\",\"cancel_bill_no\":\"ZF26039675\",\"cancel_serial_no\":\"77640503\"}" }, "notify_url" : { "type" : "string", "description" : "通知地址" }, "operator_id" : { "type" : "string", "description" : "商户的操作员编号", "example" : "OP001" }, "out_request_no" : { "type" : "string", "description" : "标识一次退款请求，同一笔交易多次退款需要保证唯一，如需部分退款，则此参数必传。", "example" : "HZ01RF001" }, "out_trade_no" : { "type" : "string", "description" : "订单支付时传入的商户订单号,不能和 trade_no同时为空", "example" : "20150320010101001" }, "refund_amount" : { "type" : "string", "description" : "需要退款的金额，该金额不能大于订单金额,单位为元，支持两位小数", "example" : "200.12" }, "refund_fund_details" : { "type" : "array", "description" : "退款资金明细\r\t注：目前只有SETTLE_OFFLINE_GROUP产品的退款支持该字段", "items" : { "$ref" : "#/components/schemas/OpenApiRefundFundDetailPojo" } }, "refund_reason" : { "type" : "string", "description" : "退款的原因说明", "example" : "正常退款" }, "store_id" : { "type" : "string", "description" : "商户的球房编号", "example" : "NJ_S_001" }, "terminal_id" : { "type" : "string", "description" : "商户的终端编号", "example" : "NJ_T_001" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号，和商户订单号不能同时为空", "example" : "2014112611001004680073956707" } } }, "AlipayTradeRefundApplyResponseModel" : { "type" : "object", "properties" : { "out_request_no" : { "type" : "string", "description" : "本笔退款对应的退款请求号", "example" : "HZ01RF001" }, "out_trade_no" : { "type" : "string", "description" : "商户订单号", "example" : "20150320010101001" }, "refund_amount" : { "type" : "string", "description" : "本次退款请求，对应的退款金额", "example" : "200.12" }, "refund_status" : { "type" : "string", "description" : "REFUND_PROCESSING 退款处理中；REFUND_SUCCESS 退款处理成功；REFUND_FAIL 退款失败", "example" : "REFUND_PROCESSING" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号", "example" : "2014112611001004680073956707" } } }, "AlipayTradeRefundErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ACQ.SYSTEM_ERROR", "ACQ.INVALID_PARAMETER", "ACQ.SELLER_BALANCE_NOT_ENOUGH", "ACQ.REFUND_AMT_NOT_EQUAL_TOTAL", "ACQ.REASON_TRADE_BEEN_FREEZEN", "ACQ.TRADE_NOT_EXIST", "ACQ.TRADE_HAS_FINISHED", "ACQ.TRADE_STATUS_ERROR", "ACQ.DISCORDANT_REPEAT_REQUEST", "ACQ.REASON_TRADE_REFUND_FEE_ERR", "ACQ.TRADE_NOT_ALLOW_REFUND", "ACQ.REFUND_FEE_ERROR", "ACQ.TRADE_HAS_CLOSE", "ACQ.BUYER_NOT_EXIST", "ACQ.BUYER_ENABLE_STATUS_FORBID", "ACQ.REASON_TRADE_STATUS_INVALID", "ACQ.NOT_ALLOW_PARTIAL_REFUND", "ACQ.ONLINE_TRADE_VOUCHER_NOT_ALLOW_REFUND", "ACQ.BUYER_ERROR", "ACQ.CURRENCY_NOT_SUPPORT", "ACQ.ALLOC_AMOUNT_VALIDATE_ERROR", "ACQ.USER_NOT_MATCH_ERR", "ACQ.TRADE_SETTLE_ERROR", "ACQ.REFUND_CHARGE_ERROR", "ACQ.ENTERPRISE_PAY_BIZ_ERROR", "ACQ.OVERDRAFT_ASSIGN_ACCOUNT_INVALID", "ACQ.OVERDRAFT_AGREEMENT_NOT_MATCH", "ACQ.REFUND_ACCOUNT_NOT_EXIST", "ACQ.CUSTOMER_VALIDATE_ERROR", "ACQ.REFUND_ROYALTY_PAYEE_ACCOUNT_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeRefundModel" : { "type" : "object", "properties" : { "goods_detail" : { "type" : "array", "description" : "退款包含的商品列表信息，Json格式。", "items" : { "$ref" : "#/components/schemas/GoodsDetail" } }, "operator_id" : { "type" : "string", "description" : "商户的操作员编号", "example" : "OP001" }, "org_pid" : { "type" : "string", "description" : "银行间联模式下有用，其它场景请不要使用；\r\t双联通过该参数指定需要退款的交易所属收单机构的pid;", "example" : "2088101117952222" }, "out_request_no" : { "type" : "string", "description" : "退款请求号。\t标识一次退款请求，需要保证在交易号下唯一，如需部分退款，则此参数必传。\t注：针对同一次退款请求，如果调用接口失败或异常了，重试时需要保证退款请求号不能变更，防止该笔交易重复退款。支付宝会保证同样的退款请求号多次请求只会退一次。", "example" : "HZ01RF001" }, "out_trade_no" : { "type" : "string", "description" : "商户订单号。\t订单支付时传入的商户订单号，商家自定义且保证商家系统中唯一。与支付宝交易号 trade_no 不能同时为空。", "example" : "20150320010101001" }, "query_options" : { "type" : "array", "description" : "查询选项。\t商户通过上送该参数来定制同步需要额外返回的信息字段，数组格式。支持：refund_detail_item_list：退款使用的资金渠道；deposit_back_info：触发银行卡冲退信息通知；", "items" : { "type" : "string" }, "example" : "refund_detail_item_list" }, "refund_advance_account" : { "type" : "string", "description" : "指定垫资退款账号主体，可能是用户id或登录名", "example" : "loginname@alitest.com" }, "refund_advance_account_type" : { "type" : "string", "description" : "指定垫资退款账号的类型，取值范围：default，userId，loginName", "example" : "loginName" }, "refund_amount" : { "type" : "string", "description" : "退款金额。\t需要退款的金额，该金额不能大于订单金额，单位为元，支持两位小数。\t注：如果正向交易使用了营销，该退款金额包含营销金额，支付宝会按业务规则分配营销和买家自有资金分别退多少，默认优先退买家的自有资金。如交易总金额100元，用户支付时使用了80元自有资金和20元无资金流的营销券，商家实际收款80元。如果首次请求退款60元，则60元全部从商家收款资金扣除退回给用户自有资产；如果再请求退款40元，则从商家收款资金扣除20元退回用户资产以及把20元的营销券退回给用户（券是否可再使用取决于券的规则配置）。", "example" : "200.12" }, "refund_currency" : { "type" : "string", "description" : "订单退款币种信息。支持英镑：GBP、港币：HKD、美元：USD、新加坡元：SGD、日元：JPY、加拿大元：CAD、澳元：AUD、欧元：EUR、新西兰元：NZD、韩元：KRW、泰铢：THB、瑞士法郎：CHF、瑞典克朗：SEK、丹麦克朗：DKK、挪威克朗：NOK、马来西亚林吉特：MYR、印尼卢比：IDR、菲律宾比索：PHP、毛里求斯卢比：MUR、以色列新谢克尔：ILS、斯里兰卡卢比：LKR、俄罗斯卢布：RUB、阿联酋迪拉姆：AED、捷克克朗：CZK、南非兰特：ZAR、人民币：CNY", "example" : "USD" }, "refund_goods_detail" : { "type" : "array", "description" : "退款包含的商品列表信息", "items" : { "$ref" : "#/components/schemas/RefundGoodsDetail" } }, "refund_reason" : { "type" : "string", "description" : "退款原因说明。\t商家自定义，将在会在商户和用户的pc退款账单详情中展示", "example" : "正常退款" }, "refund_royalty_parameters" : { "type" : "array", "description" : "退分账明细信息。\t 注： 1.当面付且非直付通模式无需传入退分账明细，系统自动按退款金额与订单金额的比率，从收款方和分账收入方退款，不支持指定退款金额与退款方。 \t2.直付通模式，电脑网站支付，手机 APP 支付，手机网站支付产品，须在退款请求中明确是否退分账，从哪个分账收入方退，退多少分账金额；如不明确，默认从收款方退款，收款方余额不足退款失败。不支持系统按比率退款。", "items" : { "$ref" : "#/components/schemas/OpenApiRoyaltyDetailInfoPojo" } }, "store_id" : { "type" : "string", "description" : "商户球房编号，由商家自定义。需保证当前商户下唯一。", "example" : "NJ_S_001" }, "terminal_id" : { "type" : "string", "description" : "商户的终端编号", "example" : "NJ_T_001" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号。\t和商户订单号 out_trade_no 不能同时为空。", "example" : "2014112611001004680073956707" } } }, "AlipayTradeRefundResponseModel" : { "type" : "object", "properties" : { "buyer_logon_id" : { "type" : "string", "description" : "用户的登录id", "example" : "159****5620" }, "buyer_open_id" : { "type" : "string", "description" : "买家支付宝用户唯一标识", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "buyer_user_id" : { "type" : "string", "description" : "买家在支付宝的用户id", "example" : "2088101117955611" }, "fund_change" : { "type" : "string", "description" : "本次退款是否发生了资金变化", "example" : "Y" }, "gmt_refund_pay" : { "type" : "string", "description" : "退款支付时间", "example" : "2014-11-27 15:45:57" }, "has_deposit_back" : { "type" : "string", "description" : "是否有银行卡冲退，仅当query_options中传入deposit_back_info时返回", "example" : "true" }, "open_id" : { "type" : "string", "description" : "买家支付宝用户号，该参数已废弃，请不要使用", "example" : "2088102122524333" }, "out_trade_no" : { "type" : "string", "description" : "商户订单号", "example" : "6823789339978248" }, "present_refund_buyer_amount" : { "type" : "string", "description" : "本次退款金额中买家退款金额;单位：元。\t该字段默认不返回；", "example" : "88.88" }, "present_refund_discount_amount" : { "type" : "string", "description" : "本次退款金额中平台优惠退款金额；单位：元。\t该字段默认不返回；", "example" : "88.88" }, "present_refund_mdiscount_amount" : { "type" : "string", "description" : "本次退款金额中商家优惠退款金额；单位：元。\t该字段默认不返回；", "example" : "88.88" }, "refund_charge_amount" : { "type" : "string", "description" : "本次退款针对收款方的退收费金额；单位：元。\t只在机构间联模式下返回，其它场景下不返回该字段；", "example" : "8.88" }, "refund_charge_info_list" : { "type" : "array", "description" : "退费信息", "items" : { "$ref" : "#/components/schemas/RefundChargeInfo" } }, "refund_currency" : { "type" : "string", "description" : "退款币种信息", "example" : "USD" }, "refund_detail_item_list" : { "type" : "array", "description" : "退款使用的资金渠道。\t只有在签约中指定需要返回资金明细，或者入参的query_options中指定时才返回该字段信息。", "items" : { "$ref" : "#/components/schemas/TradeFundBill" } }, "refund_fee" : { "type" : "string", "description" : "退款总金额。单位：元。\t指该笔交易累计已经退款成功的金额。", "example" : "88.88" }, "refund_hyb_amount" : { "type" : "string", "description" : "本次请求退惠营宝金额。单位：元。", "example" : "10.24" }, "refund_preset_paytool_list" : { "$ref" : "#/components/schemas/PresetPayToolInfo" }, "refund_settlement_id" : { "type" : "string", "description" : "退款清算编号，用于清算对账使用；\t只在机构间联模式下返回，其它场景下不返回该字段；", "example" : "2018101610032004620239146945" }, "send_back_fee" : { "type" : "string", "description" : "本次商户实际退回金额。单位：元。\t说明：如需获取该值，需在入参query_options中传入 refund_detail_item_list。", "example" : "1.8" }, "store_name" : { "type" : "string", "description" : "交易在支付时候的球房名称", "example" : "望湘园联洋店" }, "trade_no" : { "type" : "string", "description" : "2013112011001004330000121536", "example" : "支付宝交易号" } } }, "AlipayTradeRoyaltyRateQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "PRODUCT_UNSIGN", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeRoyaltyRateQueryResponseModel" : { "type" : "object", "properties" : { "max_ratio" : { "type" : "integer", "description" : "最大分账比例，百分比整数，取值范围0～100", "example" : "80" }, "user_id" : { "type" : "string", "description" : "当前商户userId", "example" : "2088XXXX1234" } } }, "AlipayTradeRoyaltyRelationBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "PRODUCT_UNSIGN", "SYSTEM_ERROR", "OPENID_APPID_NOT_MATCH" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeRoyaltyRelationBatchqueryModel" : { "type" : "object", "properties" : { "out_request_no" : { "type" : "string", "description" : "外部请求号，由商家自定义。32个字符以内，仅可包含字母、数字、下划线。需保证在商户端不重复。", "example" : "2019032200000001" }, "page_num" : { "type" : "integer", "description" : "几页，起始页为 1。不填默认为 1。", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "页面大小。每页记录数，取值范围是(0,100]。不填默认为20", "example" : "20" } } }, "AlipayTradeRoyaltyRelationBatchqueryResponseModel" : { "type" : "object", "properties" : { "current_page_num" : { "type" : "integer", "description" : "当前页数", "example" : "1" }, "current_page_size" : { "type" : "integer", "description" : "当前页面大小", "example" : "20" }, "receiver_list" : { "type" : "array", "description" : "分账收款方列表", "items" : { "$ref" : "#/components/schemas/RoyaltyEntity" } }, "result_code" : { "type" : "string", "description" : "业务结果码。SUCCESS：分账关系查询成功；FAIL：分账关系查询失败。", "example" : "SUCCESS" }, "total_page_num" : { "type" : "integer", "description" : "总页数", "example" : "10" }, "total_record_num" : { "type" : "integer", "description" : "分账关系记录总数", "example" : "480" } } }, "AlipayTradeRoyaltyRelationBindErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "RELATION_QUANTITY_LIMIT", "PRODUCT_UNSIGN", "USER_NOT_EXIST", "SYSTEM_ERROR", "RECEIVER_LIST_EMPTY", "RECEIVER_LIST_OVERLOAD", "INVALID_RECEIVER_TYPE", "USERNAME_NOT_MATCH", "RECEIVER_ACCOUNT_NOT_CERTIFY", "RECEIVER_ACCOUNT_NO_BALANCE", "RECEIVER_ACCOUNT_STATE_INVALID", "OPENID_APPID_NOT_MATCH" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeRoyaltyRelationBindModel" : { "type" : "object", "properties" : { "out_request_no" : { "type" : "string", "description" : "外部请求号，由商家自定义。32个字符以内，仅可包含字母、数字、下划线。需保证在商户端不重复。", "example" : "2019032200000001" }, "receiver_list" : { "type" : "array", "description" : "分账接收方列表，单次传入最多20个", "items" : { "$ref" : "#/components/schemas/RoyaltyEntity" } } } }, "AlipayTradeRoyaltyRelationBindResponseModel" : { "type" : "object", "properties" : { "result_code" : { "type" : "string", "description" : "SUCCESS：分账关系绑定成功；\tFAIL：分账关系绑定失败。", "example" : "SUCCESS" } } }, "AlipayTradeRoyaltyRelationUnbindErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "PRODUCT_UNSIGN", "USER_NOT_EXIST", "SYSTEM_ERROR", "RECEIVER_LIST_EMPTY", "RECEIVER_LIST_OVERLOAD", "INVALID_RECEIVER_TYPE", "USERNAME_NOT_MATCH" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeRoyaltyRelationUnbindModel" : { "type" : "object", "properties" : { "out_request_no" : { "type" : "string", "description" : "外部请求号，由商家自定义。32个字符以内，仅可包含字母、数字、下划线。需保证在商户端不重复。", "example" : "2019032200000001" }, "receiver_list" : { "type" : "array", "description" : "分账接收方列表，单次传入最多 20 个信息。", "items" : { "$ref" : "#/components/schemas/RoyaltyEntity" } } } }, "AlipayTradeRoyaltyRelationUnbindResponseModel" : { "type" : "object", "properties" : { "result_code" : { "type" : "string", "description" : "业务结果码。SUCCESS：分账关系解绑成功；\tFAIL：分账关系解绑失败。", "example" : "SUCCESS" } } }, "AlipayTradeSettleConfirmErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ACQ.SYSTEM_ERROR", "ACQ.INVALID_PARAMETER", "ACQ.TRADE_NOT_EXIST", "ACQ.PARTNER_ERROR", "ACQ.DUP_OUT_REQUEST_NO", "ACQ.TRADE_SETTLE_ERROR", "ACQ.ILLEGAL_SETTLE_STATE", "ACQ.REASON_ILLEGAL_STATUS", "ACQ.SECONDARY_MERCHANT_ALIPAY_ACCOUNT_NOT_EXIST", "ACQ.DEFAULT_SETTLE_RULE_NOT_EXIST", "ACQ.REASON_TRADE_STATUS_INVALID", "ACQ.FREQUENCY_LIMITED", "ACQ.SECONDARY_MERCHANT_ID_INVALID", "ACQ.USER_ACCOUNT_HAD_FREEZEN", "ACQ.DISCORDANT_REPEAT_REQUEST", "ACQ.TXN_RESULT_ACCOUNT_BALANCE_NOT_ENOUGH", "ACQ.SETTLE_ENTITY_ID_INVALID", "ACQ.RISK_SETTLE_SUSPEND", "ACQ.SETTLE_ACCOUNT_NOT_EXIST", "ACQ.SETTLE_ACCOUNT_NOT_CERTIFY", "ACQ.SETTLE_ACCOUNT_NO_BALANCE", "ACQ.INVALID_SETTLE_AMOUNT_PARAMETER", "ACQ.USER_LOGONID_DUP", "ACQ.SECONDARY_MERCHANT_ALIPAY_ACCOUNT_INVALID", "ACQ.ALREADY_CONFIRM_SETTLE", "ACQ.SETTLE_ACCOUNT_HAS_BEEN_FROZEN", "ACQ.TRADE_HAS_CLOSE", "ACQ.TRADE_HAS_FINISHED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeSettleConfirmModel" : { "type" : "object", "properties" : { "extend_params" : { "$ref" : "#/components/schemas/SettleConfirmExtendParams" }, "out_request_no" : { "type" : "string", "description" : "确认结算请求流水号，开发者自行生成并保证唯一性，作为业务幂等性控制", "example" : "20160727001" }, "settle_info" : { "$ref" : "#/components/schemas/SettleInfo" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号", "example" : "2015070921001004130000127421" } } }, "AlipayTradeSettleConfirmResponseModel" : { "type" : "object", "properties" : { "out_request_no" : { "type" : "string", "description" : "确认结算请求流水号，开发者自行生成并保证唯一性，作为业务幂等性控制", "example" : "20160727001" }, "settle_amount" : { "type" : "string", "description" : "本次确认结算的实际结算金额，单位为元。", "example" : "0.1" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号", "example" : "2015070921001004130000127421" } } }, "AlipayTradeSettleReceivablesQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SUB_MERCHANT_NOT_EXIST", "SUB_MERCHANT_BELONG_ERROR", "SUB_MERCHANT_ACCOUNT_NOT_EXIST", "SYSTEM_ERROR", "QUERY_NOT_SUPPORT", "ILLEGAL_SETTLE_STATUS" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayTradeSettleReceivablesQueryModel" : { "type" : "object", "properties" : { "biz_product" : { "type" : "string", "description" : "收单产品码，商家和支付宝签约的产品码", "example" : "FACE_TO_FACE_PAYMENT" }, "extend_params" : { "type" : "string", "description" : "扩展参数", "example" : "{\"key\":\"value\"}" }, "merchant_info" : { "$ref" : "#/components/schemas/SettleEntity" }, "out_request_no" : { "type" : "string", "description" : "外部请求号，32个字符以内，可包含字母、数字、下划线。", "example" : "2019040100000001" }, "query_his_date" : { "type" : "string", "description" : "当trade_no不为空时，该字段不生效。\t查询历史日期，格式为 yyyyMMdd ，取值范围为昨日起至往前30日内；\t不传入时，查询实时待结算余额返回；\t传入过去某一天日期，查询对应日期的日终待结算余额返回（注意：日常场景下，昨日日终待结算余额只可在当天 02:00 后查询，在当天 02:00 前查询返回查询错误；大促场景下昨日日终可查时间会适当延后）；\t传入过去某一天非近30天内，返回参数错误。", "example" : "20200313" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号，当该笔交易为直付通账期模式，查询该笔交易待确认结算金额时必传", "example" : "2022081722001432461452204877" } } }, "AlipayTradeSettleReceivablesQueryResponseModel" : { "type" : "object", "properties" : { "on_settle_amount" : { "type" : "string", "description" : "直付通请款模式下的结算在途金额，发起结算后 T+N 日到账场景下的处理中金额，人民币，单位为元", "example" : "10000.00" }, "unsettled_amount" : { "type" : "string", "description" : "待结算金额，人民币，单位为元", "example" : "10000.00" } } }, "AlipayUserAgreementExecutionplanModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "ILLEGAL_EXECUTION_TIME", "ILLEGAL_AGREEMENT", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayUserAgreementExecutionplanModifyModel" : { "type" : "object", "properties" : { "agreement_no" : { "type" : "string", "description" : "周期性扣款产品，授权免密支付协议号", "example" : "20185909000458725113" }, "deduct_time" : { "type" : "string", "description" : "商户下一次扣款时间", "example" : "2019-05-12" }, "memo" : { "type" : "string", "description" : "具体修改原因", "example" : "用户已购买半年包，需延期扣款时间" } } }, "AlipayUserAgreementExecutionplanModifyResponseModel" : { "type" : "object", "properties" : { "agreement_no" : { "type" : "string", "description" : "周期性扣款产品，授权免密支付协议号", "example" : "20185909000458725113" }, "deduct_time" : { "type" : "string", "description" : "商户下一次扣款时间，格式 \"yyyy-MM-dd\"。\t例如：用户在1月1日开通了连续包月，使用了10天又另行购买了“季度包”，如果此时商户希望“季度包”立即优先生效，在季度包结束后能继续使用连续包月，那么原定的周期就被延后了。此时可以通过本接口将预计扣款时间推后“季度包”的时长。", "example" : "2020-05-12" } } }, "AlipayUserAgreementMigrateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "MERCHANT_NOT_SUPPORT", "AGREEMENT_ALREADY_MIGRATED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayUserAgreementMigrateModel" : { "type" : "object", "properties" : { "agreement_no" : { "type" : "string", "description" : "支付宝系统中用以唯一标识用户签约记录的编号（用户签约成功后的协议号 ）", "example" : "20170322450983769228" }, "target_app_id" : { "type" : "string", "description" : "需要迁移的目标商户应用id", "example" : "2014072300007148" }, "target_invoke_app_id" : { "type" : "string", "description" : "需要迁移的目标商户调用应用id", "example" : "2014072300007148" }, "target_partner_id" : { "type" : "string", "description" : "需要迁移的目标商户id", "example" : "2088101122675263" } } }, "AlipayUserAgreementMigrateResponseModel" : { "type" : "object" }, "AlipayUserAgreementPermissionCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "ILLEGAL_PARAMS", "USER_AGREEMENT_NOT_EXIST", "NOT_SUPPORT_MERCHANT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayUserAgreementPermissionCreateModel" : { "type" : "object", "properties" : { "agreement_no" : { "type" : "string", "description" : "支付宝系统中用以唯一标识用户签约记录的编号（用户签约成功后的协议号 ）", "example" : "20170322450983769228" }, "business_params" : { "$ref" : "#/components/schemas/BusinessParamsMap" }, "notice_template" : { "type" : "string", "description" : "目前共两种类型SERVIOCE_NOTICE和DEFAULT_PERMISSION，如果是服务变更提醒，需传入SERVIOCE_NOTICE", "example" : "SERVIOCE_NOTICE" }, "out_request_no" : { "type" : "string", "description" : "商户请求号。 由商家自定义，64个字符以内，仅支持字母、数字、下划线且需保证在商户端不重复。", "example" : "6823789339978248" }, "total_amount" : { "type" : "string", "description" : "订单总金额。 单位为元，精确到小数点后两位，取值范围：[0.01,100000000] 。", "example" : "88.88" } } }, "AlipayUserAgreementPermissionCreateResponseModel" : { "type" : "object", "properties" : { "deduct_permission" : { "type" : "string", "description" : "商户代扣扣款许可", "example" : "2021571176714791277815457854545" }, "effective_time_end" : { "type" : "string", "description" : "商户代扣扣款许可生效结束时间", "example" : "yyyyMMddHHmmss" }, "effective_time_start" : { "type" : "string", "description" : "商户代扣扣款许可生效开始时间", "example" : "yyyyMMddHHmmss" }, "is_success_send" : { "type" : "boolean", "description" : "消息是否发送成功", "example" : "true" } } }, "AlipayUserAgreementQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "USER_NOT_EXIST_ERROR", "PRODUCT_CODE_NOT_SUPPORTED_ERROR", "USER_AGREEMENT_NOT_EXIST", "INVALID_PARAMETER", "SYSTEM_ERROR", "AUTHOREE_IS_NOT_MATCH", "USER_NOT_EXSIT_ERROR", "LOGONID_IS_REPEATED", "AGREEMENT_HAS_UNSIGNED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayUserAgreementQueryResponseModel" : { "type" : "object", "properties" : { "agreement_no" : { "type" : "string", "description" : "用户签约成功后的协议号", "example" : "20170322450983769228" }, "alipay_logon_id" : { "type" : "string", "description" : "返回脱敏的支付宝账号", "example" : "test***ali@alipay.net" }, "credit_auth_mode" : { "type" : "string", "description" : "授信模式，取值：DEDUCT_HUAZHI-花芝GO。目前只在花芝代扣（即花芝go）协议时才会返回", "example" : "DEDUCT_HUAZHI" }, "device_id" : { "type" : "string", "description" : "设备Id", "example" : "RSED235F875932" }, "external_agreement_no" : { "type" : "string", "description" : "代扣协议中标示用户的唯一签约号(确保在商户系统中唯一)", "example" : "test" }, "external_logon_id" : { "type" : "string", "description" : "外部登录Id", "example" : "2088101118392209" }, "invalid_time" : { "type" : "string", "description" : "协议失效时间，格式为 yyyy-MM-dd HH:mm:ss。", "example" : "2117-05-24 00:00:00" }, "last_deduct_time" : { "type" : "string", "description" : "周期扣协议，上次扣款成功时间", "example" : "2022-05-15" }, "next_deduct_time" : { "type" : "string", "description" : "周期扣协议，预计下次扣款时间", "example" : "2022-06-15" }, "personal_product_code" : { "type" : "string", "description" : "协议产品码，商户和支付宝签约时确定，不同业务场景对应不同的签约产品码。", "example" : "GENERAL_WITHHOLDING_P" }, "pricipal_type" : { "type" : "string", "description" : "签约主体类型。\r\tCARD:支付宝账号\r\tCUSTOMER:支付宝用户", "example" : "CARD" }, "principal_id" : { "type" : "string", "description" : "签约主体标识。\r\t当principal_type为CARD 时，该字段为支付宝用户号;\r\t当principal_type为 CUSTOMER 时，该字段为支付宝用户标识。一个用户 可能有多个支付宝账号，即多个支付宝用户号，但只有一个是支付宝用户标识。\r\t一个支付宝账号对应一个支付宝唯一用户号(以2088开头的16位纯数字组成)。", "example" : "2088101122675263" }, "principal_open_id" : { "type" : "string", "description" : "签约主体标识。\t当principal_type为CARD 时，该字段为支付宝用户号;\t当principal_type为 CUSTOMER 时，该字段为支付宝用户标识。一个用户 可能有多个支付宝账号，即多个支付宝用户号，但只有一个是支付宝用户标识。", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "sign_scene" : { "type" : "string", "description" : "签约协议的场景。", "example" : "INDUSTRY|CARRENTAL" }, "sign_time" : { "type" : "string", "description" : "协议签约时间，格式为 yyyy-MM-dd HH:mm:ss。", "example" : "2017-05-24 15:00:40" }, "single_quota" : { "type" : "string", "description" : "单笔代扣额度", "example" : "100.00" }, "status" : { "type" : "string", "description" : "协议当前状态\r\t1. TEMP：暂存，协议未生效过；\r\t2. NORMAL：正常；\r\t3. STOP：暂停", "example" : "NORMAL" }, "third_party_type" : { "type" : "string", "description" : "签约第三方主体类型。对于三方协议，表示当前用户和哪一类的第三方主体进行签约。\r\t取值范围：\r\t1. PARTNER（平台商户）;\r\t2. MERCHANT（集团商户），集团下子商户可共享用户签约内容;\r\t默认为PARTNER。", "example" : "PARTNER" }, "valid_time" : { "type" : "string", "description" : "协议生效时间，格式为 yyyy-MM-dd HH:mm:ss。", "example" : "2017-05-24 15:00:40" }, "zm_open_id" : { "type" : "string", "description" : "用户的芝麻信用 openId，供商 户查询用户芝麻信用使用。", "example" : "268816057852461313538942792" } } }, "AlipayUserAgreementTransferErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "USER_AGREEMENT_NOT_EXIST", "INVALID_PARAMETER", "PRODUCT_CODE_IS_INVALID", "PRODUCTCODE_ALREADY_UPDATE", "NOT_SUPPORTED_BUSINESS", "SYSTEM_ERROR", "MERCHANT_AGREEMENT_IS_NOT_EXIST", "MERCHANT_STATUS_IS_NOT_NORMAL", "MERCHANT_AGREEMENT_IS_EXPIRED", "USER_AGREEMENT_IS_OUT_OF_DATE", "USER_AGREEMENT_STATUS_IS_EXPIRED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayUserAgreementTransferModel" : { "type" : "object", "properties" : { "agreement_no" : { "type" : "string", "description" : "支付宝系统中用以唯一标识用户签约记录的编号（用户签约成功后的协议号 ），如果传了该参数，其他参数会被忽略", "example" : "20170322450983769228" }, "period_rule_params" : { "$ref" : "#/components/schemas/PeriodRuleParams" }, "target_product_code" : { "type" : "string", "description" : "协议产品码，商户和支付宝签约时确定，不同业务场景对应不同的签约产品码。这里指的是需要修改目标产品码的值", "example" : "CYCLE_PAY_AUTH_P" } } }, "AlipayUserAgreementTransferResponseModel" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "单次金额限制", "example" : "100" }, "execute_time" : { "type" : "string", "description" : "执行时间", "example" : "2019-01-23" }, "period" : { "type" : "string", "description" : "周期", "example" : "7" }, "period_type" : { "type" : "string", "description" : "周期类型", "example" : "DAY" }, "total_amount" : { "type" : "string", "description" : "总金额限制", "example" : "600" }, "total_payments" : { "type" : "string", "description" : "总支付次数", "example" : "12" } } }, "AlipayUserAgreementUnsignErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "USER_NOT_EXIST_ERROR", "AGREEMENT_NOT_EXIST", "PRODUCT_CODE_NOT_SUPPORTED_ERROR", "USER_AGREEMENT_STATUS_NOT_NORMAL", "INVALID_PARAMETER", "SYSTEM_ERROR", "AUTHOREE_IS_NOT_MATCH", "MERCHANT_AGREEMENT_IS_NOT_EXIST", "USER_NOT_EXSIT_ERROR", "AGREEMENT_NOT_EXSIT", "USER_AGREEMENT_QUERY_FAIL", "USER_AGREEMENT_UNSIGN_FAIL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayUserAgreementUnsignModel" : { "type" : "object", "properties" : { "agreement_no" : { "type" : "string", "description" : "支付宝系统中用以唯一标识用户签约记录的编号（用户签约成功后的协议号 ），如果传了该参数，其他参数会被忽略\t。\t本参数与 external_agreement_no 不可同时为空。", "example" : "20170322450983769228" }, "alipay_logon_id" : { "type" : "string", "description" : "用户的支付宝登录账号，支持邮箱或手机号码格式。本参数与alipay_user_id 不可同时为空，若都填写，则以alipay_user_id 为准。", "example" : "abx@alitest.com" }, "alipay_open_id" : { "type" : "string", "description" : "用户的支付宝账号对应的支付宝唯一用户号，\t本参数与alipay_logon_id 不可同时为空，若都填写，则以本参数为准，优先级高于alipay_logon_id。", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "alipay_user_id" : { "type" : "string", "description" : "用户的支付宝账号对应的支付宝唯一用户号，以2088 开头的 16 位纯数字 组成;\r\t本参数与alipay_logon_id 不可同时为空，若都填写，则以本参数为准，优先级高于alipay_logon_id。", "example" : "2088101143488930" }, "extend_params" : { "type" : "string", "description" : "扩展参数", "example" : "{\"UNSIGN_ERROR_CODE\": \"USER_OWE_MONEY\",\"UNSIGN_ERROR_INFO\":\"10.00\"}" }, "external_agreement_no" : { "type" : "string", "description" : "代扣协议中标示用户的唯一签约号(确保在商户系统中\t唯一)。\t格式规则:支持大写小写字母和数字，最长 32 位。\t注意：若调用 alipay.user.agreement.page.sign(支付宝个人协议页面签约接口) 签约时传入 external_agreement_no 则该值必填且需与签约接口传入值相同。", "example" : "test" }, "notify_url" : { "type" : "string", "description" : "通知地址" }, "operate_type" : { "type" : "string", "description" : "操作类型：confirm（解约确认）；invalid（解约作废）。\t注意：仅异步解约需传入，其余情况无需传递本参数。", "example" : "confirm" }, "personal_product_code" : { "type" : "string", "description" : "协议产品码，商户和支付宝签约时确定，不同业务场景对应不同的签约产品码。", "example" : "GENERAL_WITHHOLDING_P" }, "sign_scene" : { "type" : "string", "description" : "签约协议场景，该值需要与系统/页面签约接口调用时传入的值保持一 致。如：周期扣款场景，需与调用 alipay.user.agreement.page.sign(支付宝个人协议页面签约接口) 签约时的 sign_scene 相同。\t当传入商户签约号 external_agreement_no时，场景不能为空或默认值 DEFAULT|DEFAULT。\t", "example" : "INDUSTRY|MEDICA" }, "third_party_type" : { "type" : "string", "description" : "签约第三方主体类型。对于三方协议，表示当前用户和哪一类的第三方主体进行签约。\r\t取值范围：\r\t1. PARTNER（平台商户）;\r\t2. MERCHANT（集团商户），集团下子商户可共享用户签约内容;\r\t默认为PARTNER。", "example" : "PARTNER" } } }, "AlipayUserAgreementUnsignResponseModel" : { "type" : "object" }, "AlipayUserAgreementUserverifyApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "USER_AGREEMENT_NOT_EXIST", "AGREEMENT_NO_IS_INVALID" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayUserAgreementUserverifyApplyModel" : { "type" : "object", "properties" : { "agreement_no" : { "type" : "string", "description" : "协议号", "example" : "20170502000610755993" } } }, "AlipayUserAgreementUserverifyApplyResponseModel" : { "type" : "object", "properties" : { "apply_token" : { "type" : "string", "description" : "用户验证申请token，其格式和内容，由支付宝定义。在鉴权确认的过程中，商户可根据申请操作成功时返回的申请token，获取后续的买家结果", "example" : "MDEDUCT0068292ca377d1d44b65fa24ec9cd89132f" } } }, "AlipayUserAgreementUserverifyQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "USER_AGREEMENT_NOT_EXIST", "AGREEMENT_NO_IS_INVALID", "SYSTEM_ERROR", "INVALID_PARAMETER", "AGREEMENT_NO_IS_NOT_MATCH", "APPLY_TOKEN_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayUserAgreementUserverifyQueryResponseModel" : { "type" : "object", "properties" : { "user_match" : { "type" : "boolean", "description" : "用户信息是否匹配", "example" : "true" } } }, "AlipayUserAlipaypointBudgetlibQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "BUDGET_NOT_EXIST", "BUDGET_NOT_MATCH_PARTNER", "PARAM_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayUserAlipaypointBudgetlibQueryResponseModel" : { "type" : "object", "properties" : { "budget_code" : { "type" : "string", "description" : "集分宝预算库编码", "example" : "20201107050844" }, "budget_desc" : { "type" : "string", "description" : "预算库的中文描述", "example" : "签到活动预算库" }, "cumulative_amount" : { "type" : "integer", "description" : "预算库累计积分数", "example" : "1000" }, "enabled" : { "type" : "boolean", "description" : "预算库是否为生效状态标识，true-生效中，false-已失效", "example" : "true" }, "end_time" : { "type" : "string", "description" : "预算库结束时间, yyyy-MM-dd HH:mm:ss", "example" : "2022-11-07 05:08:45" }, "remain_amount" : { "type" : "integer", "description" : "预算库当前剩余积分数", "example" : "10" }, "start_time" : { "type" : "string", "description" : "预算库开始时间, yyyy-MM-dd HH:mm:ss", "example" : "2020-11-07 05:08:45" } } }, "AlipayUserAlipaypointSendErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "DEPOSIT_CONTRACT_DISABLE", "SYSTEM_ERROR", "BIZ_ERROR", "USER_NOT_EXIST", "BUDGET_ABNORMAL", "BUDGET_NOT_EXIST", "BUDGET_DISABLED", "SEND_RESULT_UNKNOWN", "MEMO_INFO_ILLEGAL", "IDEMPOTENT_SUCCESS", "PARAM_ILLEGAL", "SECURITY_RISK_EXIST", "BUDGET_NOT_ENOUGH", "POINT_AMOUNT_INCONSISTENT", "IDEMPOTENT_PARAM_ILLEGAL", "BUDGET_USE_CHANNEL_DISABLE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayUserAlipaypointSendModel" : { "type" : "object", "properties" : { "budget_code" : { "type" : "string", "description" : "签约商户的集分宝的预算库，扣除此预算库的集分宝发放给用户。会校验budgetcode和业务方appId的签约商户pid的关联关系，若无关则发放失败。", "example" : "02559A591572" }, "memo" : { "type" : "string", "description" : "商户关于该笔发放的描述或者信息补充，仅存储，无实际校验功能，该信息会在\"集分宝\"小程序的\"集分宝明细\"中展示给用户。", "example" : "商户小程序签到送集分宝" }, "open_id" : { "type" : "string", "description" : "被发放集分宝用户ID，商户app_id维度下的用户标识，与user_account字段二选一。 建议优先使该字段指定发放用户，接口性能更佳", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "partner_biz_no" : { "type" : "string", "description" : "接入方自己交易的唯一流水ID号，不同交易请保证幂等号唯一性，集分宝服务将依据该字段来进行幂等控制，重试请求不要更换幂等号，需要慎重传递，否则可能会造成损失。", "example" : "011022222222212" }, "point_amount" : { "type" : "integer", "description" : "发放给用户的集分宝个数。个数区间为 [1,10000000]，需为整数。", "example" : "1" }, "user_account" : { "type" : "string", "description" : "被发放集分宝用户的支付宝登录号，邮箱地址或者手机号均可，与user_id字段二选一，在有user_id时，优先使用user_id字段。", "example" : "user_logon_id@test.com/1860000001" }, "user_id" : { "type" : "string", "description" : "被发放集分宝用户的蚂蚁统一会员ID，与user_account字段二选一。\t建议优先使用user_id，接口性能更佳，user_id和user_account都传递时，系统优先使用本字段。", "example" : "2088000000000001" } } }, "AlipayUserAlipaypointSendResponseModel" : { "type" : "object", "properties" : { "record_id" : { "type" : "string", "description" : "发放记录号。", "example" : "无" }, "transaction_id" : { "type" : "string", "description" : "对账中心关联订单，一般场景无需关注", "example" : "2022062910022100195147193863" } } }, "AlipayUserCertdocCertverifyConsultErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "ILLEGAL_ARGUMENT", "IDENTITY_VERIFY_CACHE_EXPIRED", "REQUIRED_PARAM_MISSING", "GUARDIAN_LIMIT_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayUserCertdocCertverifyConsultResponseModel" : { "type" : "object", "properties" : { "fail_params" : { "type" : "string", "description" : "具体哪些字段不一致。与预授权的输入字段对应，类型为字符串列表的JSON格式。", "example" : "[\"user_name\"]" }, "fail_reason" : { "type" : "string", "description" : "校验不一致时，描述不一致的原因", "example" : "姓名不一致" }, "passed" : { "type" : "string", "description" : "校验是否一致：T-一致、F-不一致", "example" : "F" } } }, "AlipayUserCertdocCertverifyPreconsultErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "ILLEGAL_ARGUMENT", "REQUIRED_PARAM_MISSING", "GUARDIAN_LIMIT_ERROR", "CERT_TYPE_INVALID" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayUserCertdocCertverifyPreconsultModel" : { "type" : "object", "properties" : { "cert_no" : { "type" : "string", "description" : "证件号", "example" : "230100199901010001" }, "cert_type" : { "type" : "string", "description" : "证件类型。暂仅支持 IDENTITY_CARD （身份证）。", "example" : "IDENTITY_CARD" }, "ext_info" : { "type" : "string", "description" : "拓展字段,JSON格式", "example" : "{}" }, "logon_id" : { "type" : "string", "description" : "支付宝登录名", "example" : "sample@sample.com" }, "mobile" : { "type" : "string", "description" : "手机号码", "example" : "13812345678" }, "user_name" : { "type" : "string", "description" : "真实姓名", "example" : "张三" } } }, "AlipayUserCertdocCertverifyPreconsultResponseModel" : { "type" : "object", "properties" : { "verify_id" : { "type" : "string", "description" : "申请验证ID。有效期为 2 小时，过期后在校验接口使用会报错 \"校验信息已过期\"。", "example" : "671ffcda5447bc87e9ed2f669eb143d4" } } }, "AlipayUserCertifyOpenInitializeErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "ILLEGAL_ARGUMENT_FORMAT", "ARRANGEMENT_STATUS_ERROR", "UNKNOWN_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayUserCertifyOpenInitializeModel" : { "type" : "object", "properties" : { "biz_code" : { "type" : "string", "description" : "认证场景码。入参支持的认证场景码和商户签约的认证场景相关，取值如下:\tFACE：多因子人脸认证\tCERT_PHOTO：多因子证照认证\tCERT_PHOTO_FACE ：多因子证照和人脸认证\tSMART_FACE：多因子快捷认证", "example" : "FACE" }, "face_contrast_picture" : { "type" : "string", "description" : "自定义人脸比对图片的base64编码格式的string字符串", "example" : "xydasf==" }, "identity_param" : { "$ref" : "#/components/schemas/OpenCertifyIdentityParam" }, "merchant_config" : { "$ref" : "#/components/schemas/OpenCertifyMerchantConfig" }, "outer_order_no" : { "type" : "string", "description" : "商户请求的唯一标识，商户要保证其唯一性，值为32位长度的字母数字组合。建议：前面几位字符是商户自定义的简称，中间可以使用一段时间，后段可以使用一个随机或递增序列", "example" : "ZGYD201809132323000001234" } } }, "AlipayUserCertifyOpenInitializeResponseModel" : { "type" : "object", "properties" : { "certify_id" : { "type" : "string", "description" : "本次申请操作的唯一标识，商户需要记录，后续的操作都需要用到", "example" : "2109b5e671aa3ff2eb4851816c65828f" } } }, "AlipayUserCertifyOpenQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "UNKNOWN_ERROR", "ILLEGAL_ARGUMENT_FORMAT", "CERTIFY_ID_EXPIRED", "OPEN_CERTIFY_BILL_NOT_EXIST", "OPEN_CERTIFY_BILL_STATUS_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayUserCertifyOpenQueryResponseModel" : { "type" : "object", "properties" : { "fail_reason" : { "type" : "string", "description" : "认证错误原因，扩展字段，默认不返回", "example" : "Z1147" }, "identity_info" : { "type" : "string", "description" : "认证的主体信息，一般的认证场景返回为空", "example" : "{}" }, "material_info" : { "type" : "string", "description" : "认证主体附件信息，主要为图片类材料，一般的认证场景都是返回空", "example" : "{}" }, "passed" : { "type" : "string", "description" : "是否通过，通过为T，不通过为F", "example" : "T" } } }, "AlipayUserDeliverAddress" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "地址", "example" : "XX路XX号" }, "address_code" : { "type" : "string", "description" : "区域编码", "example" : "100" }, "default_deliver_address" : { "type" : "string", "description" : "是否默认收货地址", "example" : "T" }, "deliver_area" : { "type" : "string", "description" : "区/县", "example" : "西湖区" }, "deliver_city" : { "type" : "string", "description" : "市", "example" : "杭州" }, "deliver_fullname" : { "type" : "string", "description" : "收货人全名", "example" : "张三" }, "deliver_mobile" : { "type" : "string", "description" : "收货地址的联系人移动电话", "example" : "13833334444" }, "deliver_phone" : { "type" : "string", "description" : "收货地址的联系人固定电话", "example" : "0517-28888888" }, "deliver_province" : { "type" : "string", "description" : "省", "example" : "浙江" }, "zip" : { "type" : "string", "description" : "邮编", "example" : "310000" } } }, "AlipayUserInfoShareErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayUserInfoShareResponseModel" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "详细地址。", "example" : "西湖区文三路国际大厦" }, "age" : { "type" : "string", "description" : "用户年龄，实名认证为T，且证件类型为身份证，则输出年龄字段，否则不输出", "example" : "45" }, "area" : { "type" : "string", "description" : "区县名称。", "example" : "西湖区" }, "avatar" : { "type" : "string", "description" : "用户头像地址。\t注意：如果没有数据（用户未设置）时不会返回该信息，请做好容错。", "example" : "http://tfsimg.alipay.com/images/partner/T1uIxXXbpXXXXXXXX" }, "business_scope" : { "type" : "string", "description" : "经营/业务范围（用户类型是公司类型时才有此字段）。", "example" : "餐饮" }, "cert_no" : { "type" : "string", "description" : "【证件号码】结合证件类型使用.【注意】只is_certified为T的时候才有意义，否则不保证准确性.", "example" : "340928109890871722" }, "cert_type" : { "type" : "string", "description" : "【证件类型】0:身份证 1:护照 2:军官证 3:士兵证 4:回乡证 5:临时身份证 6:户口簿 7:警官证 8:台胞证 9:营业执照10:其它证件 11:港澳居民来往内地通行证 12:台湾居民来往大陆通行证 13:台湾居民居住证 14:港澳居民居住证\t 15:港澳身份证 16:外国人永久居住证【注意】只有is_certified为T的时候才有意义，否则不保证准确性.", "example" : "7" }, "city" : { "type" : "string", "description" : "市名称。", "example" : "安庆" }, "college_name" : { "type" : "string", "description" : "学信网返回的学校名称，有可能为空。", "example" : "南京大学" }, "country_code" : { "type" : "string", "description" : "国家码", "example" : "CN" }, "degree" : { "type" : "string", "description" : "学信网返回的学历/学位信息，数据质量一般，请谨慎使用，取值包括：博士研究生、硕士研究生、高升本、专科、博士、硕士、本科、夜大电大函大普通班、专科(高职)、第二学士学位。", "example" : "硕士研究生" }, "deliver_addresses" : { "type" : "array", "description" : "收货地址列表", "items" : { "$ref" : "#/components/schemas/AlipayUserDeliverAddress" } }, "display_name" : { "type" : "string", "description" : "展示名称，用于展示和识别用户。返回的值是支付宝账户的可用外标之一，根据展示名称产品规则可能返回手机号/邮箱/支付宝号其中的一个。同一个账户在不同的时期返回的展示名称可能随规则变化而变化。", "example" : "miracle001" }, "email" : { "type" : "string", "description" : "优先获取email登录名，如果不存在，则返回mobile登录名", "example" : "sss@163.com" }, "enrollment_time" : { "type" : "string", "description" : "入学时间，yyyy-mm-dd格式", "example" : "2016-01-11" }, "ent_license_address" : { "type" : "string", "description" : "企业证照地址的详细地址（用户类型是公司用户才有该字段）【注意】只有is_certified为T的时候才有意义，否则不保证准确性.", "example" : "沙河街道庐山北路888号" }, "ent_license_area" : { "type" : "string", "description" : "企业证照地址所在地区或县（用户类型是公司用户才有该字段）【注意】只有is_certified为T的时候才有意义，否则不保证准确性，目前企业营业执照地址不含县(区)，area为空。", "example" : "庐山区" }, "ent_license_city" : { "type" : "string", "description" : "企业证照地址所在市（用户类型是公司用户才有该字段）【注意】只有is_certified为T的时候才有意义，否则不保证准确性.", "example" : "九江市" }, "ent_license_province" : { "type" : "string", "description" : "企业证照地址所在省份（用户类型是公司用户才有该字段）【注意】只有is_certified为T的时候才有意义，否则不保证准确性.", "example" : "江西省" }, "firm_agent_person_cert_expiry_date" : { "type" : "string", "description" : "企业代理人证件有效期（用户类型是公司类型时才有此字段）。", "example" : "20201212" }, "firm_agent_person_cert_no" : { "type" : "string", "description" : "企业代理人证件号码（用户类型是公司类型时才有此字段）。", "example" : "320322197712211890" }, "firm_agent_person_cert_type" : { "type" : "string", "description" : "企业代理人证件类型, 返回值参考cert_type字段（用户类型是公司类型时才有此字段）。", "example" : "0" }, "firm_agent_person_name" : { "type" : "string", "description" : "企业代理人姓名（用户类型是公司类型时才有此字段）。", "example" : "王五" }, "firm_legal_person_cert_expiry_date" : { "type" : "string", "description" : "企业法人证件有效期（用户类型是公司类型时才有此字段）。", "example" : "20200909" }, "firm_legal_person_cert_no" : { "type" : "string", "description" : "法人证件号码（用户类型是公司类型时才有此字段）。", "example" : "320231196408110099" }, "firm_legal_person_cert_type" : { "type" : "string", "description" : "企业法人证件类型, 返回值参考cert_type字段（用户类型是公司类型时才有此字段）。", "example" : "1" }, "firm_legal_person_name" : { "type" : "string", "description" : "企业法人名称（用户类型是公司类型时才有此字段）。", "example" : "李四" }, "firm_legal_person_pictures" : { "type" : "array", "description" : "企业法人证件图片（用户类型是公司类型时才有此字段）。", "items" : { "$ref" : "#/components/schemas/AlipayUserPicture" } }, "firm_pictures" : { "type" : "array", "description" : "企业相关证件图片，包含图片地址（目前需要调用alipay.user.certify.image.fetch转换一下）及类型（用户类型是公司类型时才有此字段）。", "items" : { "$ref" : "#/components/schemas/AlipayUserPicture" } }, "firm_type" : { "type" : "string", "description" : "公司类型，包括（用户类型是公司类型时才有此字段）：\r\tCO(公司)\r\tINST(事业单位),\r\tCOMM(社会团体),\r\tNGO(民办非企业组织),\r\tSTATEORGAN(党政国家机关)", "example" : "CO" }, "gender" : { "type" : "string", "description" : "性别。枚举值如下：\tF：女性；\tM：男性。", "example" : "F" }, "graduation_time" : { "type" : "string", "description" : "预期毕业时间，不保证准确性，yyyy-mm-dd格式。", "example" : "2021-01-01" }, "identity_card_address" : { "type" : "string", "description" : "身份证地址信息", "example" : "江西省上饶市xxx村34号" }, "identity_card_area" : { "type" : "string", "description" : "身份证地区信息", "example" : "xxx村23号" }, "identity_card_city" : { "type" : "string", "description" : "身份证市信息", "example" : "上饶市" }, "identity_card_province" : { "type" : "string", "description" : "身份证省信息", "example" : "江西省" }, "inst_or_corp" : { "type" : "string", "description" : "是否是金融机构或特殊单位，\"I\"表示金融机构, \"C\"表示无余额账户的单位账户, \"V\", 表示虚拟主体(类似机构仅内部户无余额户), \"N\"表示非金融机构且非无余额账户的单位账户,\"?\"表示匿名用户", "example" : "N" }, "is_adult" : { "type" : "string", "description" : "T/F, 实名认证为T，且证件类型为身份证，则输出是否成年字段，否则不输出", "example" : "F" }, "is_balance_frozen" : { "type" : "string", "description" : "余额账户是否被冻结。\r\tT--被冻结；F--未冻结", "example" : "T" }, "is_blocked" : { "type" : "string", "description" : "账户是否被冻结，T/F，T冻结，F未冻结", "example" : "T" }, "is_certified" : { "type" : "string", "description" : "是否通过实名认证。T是通过 F是没有实名认证。", "example" : "T" }, "is_student_certified" : { "type" : "string", "description" : "是否是学生", "example" : "T" }, "license_expiry_date" : { "type" : "string", "description" : "营业执照有效期，yyyyMMdd或长期，（用户类型是公司类型时才有此字段）。", "example" : "20200101" }, "license_no" : { "type" : "string", "description" : "企业执照号码（用户类型是公司类型时才有此字段）。", "example" : "371702118008810" }, "member_grade" : { "type" : "string", "description" : "支付宝会员等级", "example" : "primary,普通; golden,黄金; platinum,铂金; diamond,钻石unknown,未知。" }, "mobile" : { "type" : "string", "description" : "手机号码。", "example" : "13429199999" }, "nick_name" : { "type" : "string", "description" : "用户昵称。\t注意：如果没有数据（用户未设置）时不会返回该信息，请做好容错。", "example" : "支付宝小二" }, "open_id" : { "type" : "string", "description" : "支付宝用户的openId。", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "organization_code" : { "type" : "string", "description" : "组织机构代码（用户类型是公司类型时才有此字段）。", "example" : "暂无" }, "person_birthday" : { "type" : "string", "description" : "个人用户生日。", "example" : "19900101" }, "person_birthday_without_year" : { "type" : "string", "description" : "生日。不包含具体年份，格式MMdd", "example" : "0828" }, "person_cert_expiry_date" : { "type" : "string", "description" : "证件有效期（用户类型是个人的时候才有此字段）。", "example" : "20400101" }, "person_cert_issue_date" : { "type" : "string", "description" : "证件起始日期（用户类型是个人的时候才可能有此字段，不保证准确，同时有可能为空）。", "example" : "20220701" }, "person_pictures" : { "type" : "array", "description" : "个人证件图片（用户类型是个人的时候才有此字段）。", "items" : { "$ref" : "#/components/schemas/AlipayUserPicture" } }, "phone" : { "type" : "string", "description" : "电话号码。", "example" : "0511-26888888" }, "profession" : { "type" : "string", "description" : "职业", "example" : "教师" }, "province" : { "type" : "string", "description" : "省份名称。", "example" : "安徽省" }, "taobao_id" : { "type" : "string", "description" : "淘宝id", "example" : "42143928" }, "user_id" : { "type" : "string", "description" : "支付宝用户的userId。", "example" : "2088102104794936" }, "user_name" : { "type" : "string", "description" : "若用户是个人用户，则是用户的真实姓名；若是企业用户，则是企业名称。【注意】只有is_certified为T的时候才有意义，否则不保证准确性.", "example" : "张三" }, "user_nation" : { "type" : "string", "description" : "身份证民族信息", "example" : "汉" }, "user_status" : { "type" : "string", "description" : "用户状态（Q/T/B/W）。\tQ代表快速注册用户\tT代表正常用户\tB代表被冻结账户\tW代表已注册，未激活的账户", "example" : "T" }, "user_type" : { "type" : "string", "description" : "用户类型（1/2）\r\t1代表公司账户2代表个人账户", "example" : "1" }, "zip" : { "type" : "string", "description" : "邮政编码。", "example" : "3600" } } }, "AlipayUserPicture" : { "type" : "object", "properties" : { "picture_type" : { "type" : "string", "description" : "图片类型，包括身份证正反面、营业执照等" }, "picture_url" : { "type" : "string", "description" : "用于调用alipay.user.certify.image.fetch接口，获取图片资源" } } }, "AlipayUserTwostageCommonUseErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INPUT_ILLEGAL", "DECODE_FAILED", "INDEX_NOT_EXIST", "SYSTEM_ERROR", "ILLEGAL_CODE", "CODE_EXPIRED", "USER_UN_AUTH", "SENCENO_UN_MATCH" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayUserTwostageCommonUseModel" : { "type" : "object", "properties" : { "dynamic_id" : { "type" : "string", "description" : "商户扫描用户的付款码值。", "example" : "286861260475412123" }, "pay_check_strategy" : { "type" : "string", "description" : "传1表示 校验pid(pay_pid)和来支付的时候的pid一致性；\t传2表示校验pid(pay_pid)和来支付的时候的pid一致性、校验scene_no和来支付时DYNAMIC_TOKEN_OUT_BIZ_NO属性一致； \t不传值和value=2的表现一致", "example" : "1" }, "pay_pid" : { "type" : "string", "description" : "商家进行二阶段支付的PID信息。", "example" : "2088702093900999" }, "sence_no" : { "type" : "string", "description" : "外部业务号，用于标识这笔解码请求，对同一个码的重复解码请求，sence_no必须与上一次保持一致，每次请求的sence_no必须不一样，如alipay.user.twostage.common.use接口配合alipay.trade.pay（统一收单交易支付接口）一并使用时，alipay.trade.pay接口的extend_params属性中必须设置DYNAMIC_TOKEN_OUT_BIZ_NO，且值必须与sence_no保持一致。", "example" : "20170718xxxxxxxx" } } }, "AlipayUserTwostageCommonUseResponseModel" : { "type" : "object", "properties" : { "open_id" : { "type" : "string", "description" : "open_id", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "user_id" : { "type" : "string", "description" : "支付宝用户userId信息，因为用户已经在客户端给商户的小程序授权了，并且商户要通过userId信息挂接优惠券信息，所以可以无需脱敏返回给商户。", "example" : "2088123412341234" }, "user_identity_info" : { "$ref" : "#/components/schemas/UserIdentityInfo" } } }, "AlipayUserTwostageIndirectUseErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INPUT_ILLEGAL", "DECODE_FAILED", "INDEX_NOT_EXIST", "SYSTEM_ERROR", "ILLEGAL_CODE", "CODE_EXPIRED", "USER_UN_AUTH", "SENCENO_UN_MATCH", "CASCADE_RALATION_UN_MATCH", "SMID_UN_MATCH" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayUserTwostageIndirectUseModel" : { "type" : "object", "properties" : { "dynamic_id" : { "type" : "string", "description" : "商户扫描用户的付款码值。18~24位，25~30开头，例如28开头的18位的数字；或人脸支付的ftoken等。", "example" : "28xxxxxxxxxxxxxxxx" }, "org_pid" : { "type" : "string", "description" : "进件信息中，SMID对应的银行机构的PID信息，一般为2088开头的16位数字。", "example" : "2088xxxxxxxxxxx" }, "pay_smid" : { "type" : "string", "description" : "进件信息中，二级商户ID（ sub_merchant_id)信息，一般为2088开头的16位数字。", "example" : "2088xxxxxxxxxxx" }, "sence_no" : { "type" : "string", "description" : "外部业务号，用于标识这笔解码请求，对同一个码的重复解码请求，sence_no必须与上一次保持一致，每次请求的sence_no必须不一样，如alipay.user.twostage.common.use接口配合alipay.trade.pay（统一收单交易支付接口）一并使用时，alipay.trade.pay接口的extend_params属性中必须设置DYNAMIC_TOKEN_OUT_BIZ_NO，且值必须与sence_no保持一致", "example" : "20170718xxxxxxxx" }, "source_pid" : { "type" : "string", "description" : "进件信息中，SMID对应渠道的PID信息，一般为2088开头的16位数字。", "example" : "2088xxxxxxxxxxx" } } }, "AlipayUserTwostageIndirectUseResponseModel" : { "type" : "object", "properties" : { "user_id" : { "type" : "string", "description" : "蚂蚁统一会员ID", "example" : "2088xxxxxxxxxxx" } } }, "AlipayUserUserinfoShareErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "isv.invalid-argument", "isv.invalid-token", "aop.unknow-error", "isp.unknow-error" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AlipayUserUserinfoShareResponseModel" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "详细地址。", "example" : "西湖区文三路国际大厦" }, "address_code" : { "type" : "string", "description" : "区域编码，暂时不返回值", "example" : "330106" }, "alipay_user_id" : { "type" : "string", "description" : "支付宝用户ID", "example" : "2088156897126906" }, "area" : { "type" : "string", "description" : "区县名称。", "example" : "西湖区" }, "avatar" : { "type" : "string", "description" : "用户头像", "example" : "http://tfsimg.alipay.com/images/partner/T1uIxXXbpXXXXXXXX" }, "balance_freeze_type" : { "type" : "string", "description" : "【注意】当is_balance_frozen为“F”时，改字段不会返回.\r\tCTU ---- CTU冻结，允许用户开启\r\tALIBABA ---- ALIBABA冻结，允许用户开启\r\tSERVER ---- 后台冻结，允许用户开启\r\tUSER ---- 用户冻结 \r\tCTU_N---- CTU冻结，不允许用户开启\r\tALIBABA_N ---- ALIBABA冻结，不允许用户开启\r\tSERVER_N ---- 后台冻结，不允许用户开启\r\tUNKNOWN ---- 降级、或查询超时", "example" : "SERVER" }, "birthday" : { "type" : "string", "description" : "用户生日", "example" : "19900918" }, "cert_no" : { "type" : "string", "description" : "证件号码", "example" : "340928109890871722" }, "cert_type_value" : { "type" : "string", "description" : "0:身份证\r\t1:护照\r\t2:军官证\r\t3:士兵证\r\t4:回乡证\r\t5:临时身份证\r\t6:户口簿\r\t7:警官证\r\t8:台胞证\r\t9:营业执照\r\t10其它证件", "example" : "7" }, "city" : { "type" : "string", "description" : "市名称。", "example" : "安庆" }, "default_deliver_address" : { "type" : "string", "description" : "是否默认收货地址，暂时不返回值", "example" : "T" }, "deliver_address_list" : { "type" : "array", "description" : "收货人地址列表", "items" : { "$ref" : "#/components/schemas/DeliverAddress" } }, "deliver_area" : { "type" : "string", "description" : "收货人所在区县", "example" : "西湖区" }, "deliver_city" : { "type" : "string", "description" : "收货人所在城市", "example" : "杭州市" }, "deliver_fullname" : { "type" : "string", "description" : "收货人全称", "example" : "张三" }, "deliver_mobile" : { "type" : "string", "description" : "收货地址的联系人移动电话。", "example" : "13200909090" }, "deliver_phone" : { "type" : "string", "description" : "收货地址的联系人固定电话。", "example" : "13211111111" }, "deliver_province" : { "type" : "string", "description" : "收货人所在省份", "example" : "浙江省" }, "email" : { "type" : "string", "description" : "用户支付宝账号绑定的邮箱地址", "example" : "sss@163.com" }, "family_name" : { "type" : "string", "description" : "姓氏，取的是realName中的首个字符，对非中文、中文复姓支持较差。", "example" : "赵" }, "firm_name" : { "type" : "string", "description" : "公司名称（用户类型是公司类型时公司名称才有此字段）。", "example" : "阿里巴巴" }, "gender" : { "type" : "string", "description" : "性别（F：女性；M：男性）", "example" : "F" }, "is_balance_frozen" : { "type" : "string", "description" : "T--被冻结；F--未冻结", "example" : "T" }, "is_bank_auth" : { "type" : "string", "description" : "T为是银行卡认证，F为非银行卡认证。", "example" : "T" }, "is_certified" : { "type" : "string", "description" : "是否通过实名认证。T是通过 F是没有实名认证", "example" : "T" }, "is_certify_grade_a" : { "type" : "string", "description" : "T：表示A类实名认证；F：表示非A类实名认证", "example" : "T" }, "is_id_auth" : { "type" : "string", "description" : "T为是身份证认证，F为非身份证认证。", "example" : "T" }, "is_licence_auth" : { "type" : "string", "description" : "T为通过营业执照认证，F为没有通过", "example" : "T" }, "is_mobile_auth" : { "type" : "string", "description" : "T为是手机认证，F为非手机认证。", "example" : "T" }, "is_student_certified" : { "type" : "string", "description" : "是否是学生", "example" : "T" }, "mobile" : { "type" : "string", "description" : "手机号码。", "example" : "13429199999" }, "nick_name" : { "type" : "string", "description" : "用户昵称", "example" : "哈哈就是我" }, "phone" : { "type" : "string", "description" : "电话号码。", "example" : "0511-26888888" }, "province" : { "type" : "string", "description" : "省份名称。", "example" : "安徽省" }, "real_name" : { "type" : "string", "description" : "用户的真实姓名。", "example" : "张三" }, "reduced_birthday" : { "type" : "string", "description" : "生日的月和日，MMdd格式", "example" : "0428" }, "user_id" : { "type" : "string", "description" : "用户的userId", "example" : "2088102104794936" }, "user_status" : { "type" : "string", "description" : "用户状态（Q/T/B/W）。\r\tQ代表快速注册用户\r\tT代表已认证用户\r\tB代表被冻结账户\r\tW代表已注册，未激活的账户", "example" : "T" }, "user_type_value" : { "type" : "string", "description" : "用户类型（1/2）\r\t1代表公司账户2代表个人账户", "example" : "1" }, "zip" : { "type" : "string", "description" : "邮政编码。", "example" : "3600" } } }, "AmountTypeData" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "累计类型为金额类型的累计名称。为必传入参。", "example" : "优惠累计名称001" }, "out_discount_infos" : { "type" : "array", "description" : "优惠信息。为List类型，支持传入多笔优惠，大部分场景传入一笔。包含：优惠名称，优惠类型，优惠金额（单位元）。\t字段必传场景：\t1.当累计模式为【交易绑定模式】时，为必传入参。\t2.当累计模式为【交易解耦模式】，同时需要累计优惠信息时，为必传入参。", "items" : { "$ref" : "#/components/schemas/ZMGoOutDiscountInfo" } }, "trade_info" : { "$ref" : "#/components/schemas/ZMGoTradeInfo" } } }, "AmountTypeSyncData" : { "type" : "object", "properties" : { "discount_amount" : { "type" : "string", "description" : "商户回传的优惠金额，如用户享受的红包金额，单位元", "example" : "8.75" }, "discount_desc" : { "type" : "string", "description" : "商户数据回传的优惠信息的名称。", "example" : "消费满减优惠001" }, "has_alipay_trade" : { "type" : "boolean", "description" : "是否为支付宝交易，默认false，表示是否要做支付宝交易关联。此时tradeNo必须传支付宝交易号。", "example" : "false" }, "task_amount" : { "type" : "string", "description" : "用户和商户发生交易的交易单金额，单位元。", "example" : "3.57" }, "task_desc" : { "type" : "string", "description" : "任务描述", "example" : "完成一次任务001" }, "trade_no" : { "type" : "string", "description" : "用户和商户发生金额类交易的交易单号。", "example" : "2020081722001435461000061785" } } }, "AntMerchantExpandApprecommendAccountCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "MER_ARGUMENT_NULL", "APP_ID_NOT_EXIST", "APP_STATUS_IS_ILLEGAL", "APP_OWNER_ERROR", "ACCOUNT_AUTH_FAIL", "ACCOUNT_RECOMMEND_DUPLICATE", "ACCOUNT_NOT_EXIST", "SYSTEM_ERROR", "THIRD_SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandApprecommendAccountCreateModel" : { "type" : "object", "properties" : { "acc_no" : { "type" : "string", "description" : "待绑定账号PID", "example" : "2088001969784501" }, "app_no" : { "type" : "string", "description" : "待绑定小程序的app_id", "example" : "2021000155639069" } } }, "AntMerchantExpandApprecommendAccountCreateResponseModel" : { "type" : "object" }, "AntMerchantExpandApprecommendAccountDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "MER_ARGUMENT_NULL", "APP_ID_NOT_EXIST", "APP_OWNER_ERROR", "ACCOUNT_NOT_EXIST", "ACCOUNT_RECOMMEND_NOT_EXIST", "SYSTEM_ERROR", "THIRD_SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandApprecommendAccountDeleteResponseModel" : { "type" : "object" }, "AntMerchantExpandApprecommendAccountQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "APP_ID_NOT_EXIST", "APP_OWNER_ERROR", "SYSTEM_ERROR", "QUERY_PAGE_QUERY_NULL", "QUERY_PAGE_SIZE_LARGE", "QUERY_PAGE_SIZE_SMALL", "QUERY_PAGE_NUM_SMALL", "THIRD_SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandApprecommendAccountQueryResponseModel" : { "type" : "object", "properties" : { "list" : { "type" : "array", "description" : "账号列表", "items" : { "type" : "string" }, "example" : "[\"2088001969784501\"]" }, "page_number" : { "type" : "integer", "description" : "当前页码", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "单页行数", "example" : "10" }, "total_pages" : { "type" : "integer", "description" : "总页数", "example" : "1" }, "total_size" : { "type" : "string", "description" : "总行数", "example" : "1" } } }, "AntMerchantExpandApprecommendAvailableQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "QUERY_PAGE_QUERY_NULL", "QUERY_PAGE_SIZE_LARGE", "QUERY_PAGE_SIZE_SMALL", "QUERY_PAGE_NUM_SMALL", "THIRD_SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandApprecommendAvailableQueryResponseModel" : { "type" : "object", "properties" : { "list" : { "type" : "array", "description" : "总页数", "items" : { "type" : "string" }, "example" : "[\"2088001969784501\"]" }, "page_number" : { "type" : "integer", "description" : "当前页码", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "单页行数", "example" : "10" }, "total_pages" : { "type" : "integer", "description" : "总页数", "example" : "1" }, "total_size" : { "type" : "integer", "description" : "总行数", "example" : "1" } } }, "AntMerchantExpandIndirectImageUploadErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "MERCHANT_ILLEGAL_ARGUMENT", "EXCEED_MAX_SIZE", "INVALID_IMAGE_FORMAT", "IMAGE_UNSAFE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandIndirectImageUploadModel" : { "type" : "object", "properties" : { "image_type" : { "type" : "string", "description" : "图片格式，支持格式：bmp、jpg、jpeg、png、gif.", "example" : "jpg" } } }, "AntMerchantExpandIndirectImageUploadResponseModel" : { "type" : "object", "properties" : { "image_id" : { "type" : "string", "description" : "图片在文件存储平台的标识", "example" : "a5d373f6-3e79-405f-9993-fb7ea051c372.jpg" } } }, "AntMerchantExpandInfoQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PERMISSION_IS_ILLEGAL", "MER_ARGUMENT_NULL", "MERCHANT_INPUT_ARGUMENT_ILLEGAL", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandInfoQueryResponseModel" : { "type" : "object", "properties" : { "merchant_query_result" : { "$ref" : "#/components/schemas/MerchantQueryResult" } } }, "AntMerchantExpandItemCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "DB_ERROR", "ARGUMENT_NULL", "ARGUMENT_ILLEGAL", "ITEM_CATEGORY_NOT_EXIST", "ITEM_IN_CATEGORY_NUM_LIMIT", "ITEM_HAS_EXIST", "ITEM_LABEL_NOT_EXIST", "INFO_SEC_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandItemCreateModel" : { "type" : "object", "properties" : { "detail_url" : { "type" : "string", "description" : "详情地址", "example" : "https://www.alipay.com/item/detail01.html" }, "ext_info" : { "type" : "string", "description" : "商品扩展信息：可以解析成 Map 的 json string", "example" : "{\\\"OIL_GUNS\\\":\\\"[7,8,9,10]\\\", \\\"DISCOUNT\\\":\\\"95\\\"}" }, "external_item_id" : { "type" : "string", "description" : "外部商品ID", "example" : "201909161233534124235231111" }, "front_category_id" : { "type" : "string", "description" : "前台类目id：target_type + target_id 和 front_category_id 二选一", "example" : "2018091300502200002600105884" }, "label_list" : { "type" : "array", "description" : "商品标签列表", "items" : { "$ref" : "#/components/schemas/ItemLabelCreateInfo" } }, "main_pic" : { "type" : "string", "description" : "主图地址", "example" : "https://img.alicdn.com/imgextra/i4/263168616/O1CN01qp60TQ2DWB06jyvVg_!!263168616.jpg" }, "name" : { "type" : "string", "description" : "商品名称", "example" : "西红柿炒蛋" }, "scene" : { "type" : "string", "description" : "场景：GAS_CHARGE（加油）", "example" : "GAS_CHARGE" }, "sku_list" : { "type" : "array", "description" : "商品sku列表，至少有一个", "items" : { "$ref" : "#/components/schemas/ItemSkuCreateInfo" } }, "target_id" : { "type" : "string", "description" : "商户归属主体id", "example" : "2018090600502000000022501261" }, "target_type" : { "type" : "string", "description" : "商品归属主体类型：target_type + target_id 和 front_category_id 二选一\r\t\r\t商品归属主体类型:\r\t5: 店铺\r\t4: 主站MID\r\t3: 参与者\r\t2: 角色\r\t1: 联系人", "example" : "5" } } }, "AntMerchantExpandItemCreateResponseModel" : { "type" : "object", "properties" : { "item_id" : { "type" : "string", "description" : "商品id", "example" : "2018091300502200002600104169" } } }, "AntMerchantExpandItemDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "DB_ERROR", "ARGUMENT_NULL", "ITEM_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandItemDeleteResponseModel" : { "type" : "object", "properties" : { "item_id" : { "type" : "string", "description" : "商品id", "example" : "2018091300502200002600104169" } } }, "AntMerchantExpandItemModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "DB_ERROR", "ARGUMENT_NULL", "ARGUMENT_ILLEGAL", "ITEM_NOT_EXIST", "ITEM_CATEGORY_NOT_EXIST", "ITEM_SKU_NOT_EXIST", "ITEM_IN_CATEGORY_NUM_LIMIT", "ITEM_HAS_EXIST", "INFO_SEC_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandItemModifyModel" : { "type" : "object", "properties" : { "detail_url" : { "type" : "string", "description" : "商品详情地址", "example" : "https://www.alipay.com/item/detail01.html" }, "ext_info" : { "type" : "string", "description" : "商品扩展信息：可以解析成 Map 的 json string", "example" : "{\\\"OIL_GUNS\\\":\\\"[7,8,9,10]\\\", \\\"DISCOUNT\\\":\\\"95\\\"}" }, "external_item_id" : { "type" : "string", "description" : "外部商品ID（item_id不为空时作为普通更新项，item_id为空时作为更新KEY）", "example" : "20190916123423654241312" }, "front_category_id" : { "type" : "string", "description" : "前台类目id, null表示未分类", "example" : "2018091300502200002600105884" }, "item_id" : { "type" : "string", "description" : "商品id(和external_item_id不能同时为空)", "example" : "2018091300502200002600104169" }, "label_list" : { "type" : "array", "description" : "商品标签列表，null表示不修改标签列表，空list表示清空标签", "items" : { "$ref" : "#/components/schemas/ItemLabelModifyInfo" } }, "main_pic" : { "type" : "string", "description" : "商品主图", "example" : "https://img.alicdn.com/imgextra/i4/263168616/O1CN01qp60TQ2DWB06jyvVg_!!263168616.jpg" }, "name" : { "type" : "string", "description" : "商品名称", "example" : "西红柿炒蛋" }, "op_timestamp" : { "type" : "integer", "description" : "更新时间戳（只处理时间戳最大的一次请求）", "example" : "1234352342353" }, "scene" : { "type" : "string", "description" : "场景：GAS_CHARGE（加油）", "example" : "GAS_CHARGE" }, "sku_list" : { "type" : "array", "description" : "SKU列表（会和商品已存在SKU做差异化比较后做增删改操作）", "items" : { "$ref" : "#/components/schemas/ItemSkuModifyInfo" } }, "status" : { "type" : "string", "description" : "商品状态：\r\tEFFECT（有效）、 INVALID（无效）", "example" : "EFFECT" } } }, "AntMerchantExpandItemModifyResponseModel" : { "type" : "object", "properties" : { "item_id" : { "type" : "string", "description" : "商品id", "example" : "2018091300502200002600104169" } } }, "AntMerchantExpandItemOpenBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "DB_ERROR", "ARGUMENT_NULL", "ARGUMENT_ILLEGAL", "NO_PERMISSION" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandItemOpenBatchqueryModel" : { "type" : "object", "properties" : { "item_id_list" : { "type" : "array", "description" : "商品ID列表，单次查询上限为 20。", "items" : { "type" : "string" }, "example" : "2019073100812219000000100000" } } }, "AntMerchantExpandItemOpenBatchqueryResponseModel" : { "type" : "object", "properties" : { "item_list" : { "type" : "array", "description" : "商品列表。", "items" : { "$ref" : "#/components/schemas/CmItemInfo" } } } }, "AntMerchantExpandItemOpenCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "DB_ERROR", "ARGUMENT_NULL", "ARGUMENT_ILLEGAL", "ITEM_CATEGORY_NOT_EXIST", "INFO_SEC_ERROR", "NO_PERMISSION" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandItemOpenCreateModel" : { "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "商品描述", "example" : "精选东北优质非转基因大豆" }, "ext_info" : { "type" : "array", "description" : "商品扩展信息（具体KEY请参见产品文档）。\t小程序订单中心场景接入参见 接入指南。", "items" : { "$ref" : "#/components/schemas/ItemExtInfo" } }, "material_list" : { "type" : "array", "description" : "素材列表（最多3个），素材内容为素材key（素材key为alipay.merchant.item.file.upload 接口返回的 material_key）", "items" : { "$ref" : "#/components/schemas/MaterialCreateInfo" } }, "name" : { "type" : "string", "description" : "商品名称", "example" : "西红柿炒蛋" }, "property_list" : { "type" : "array", "description" : "商品属性列表", "items" : { "$ref" : "#/components/schemas/ItemPropertyInfo" } }, "scene" : { "type" : "string", "description" : "业务场景码。\t小程序订单中心场景固定为 APP_ORDER。", "example" : "APP_ORDER" }, "sku_list" : { "type" : "array", "description" : "商品SKU列表（至少1个，最多20个）", "items" : { "$ref" : "#/components/schemas/SkuCreateInfo" } }, "standard_category_id" : { "type" : "string", "description" : "商品所属标准类目ID，标品及非标品都需传入。 请填入 小程序商品类目表 中三级类目ID。", "example" : "2019073100992228000000100000" }, "target_id" : { "type" : "string", "description" : "商品归属主体ID\t例：商品归属主体类型target_type为店铺，则商品归属主体ID为店铺ID（支付宝侧店铺ID）；归属主体类型target_type为小程序，则归属主体ID为小程序ID", "example" : "2018090600502000000022501261" }, "target_type" : { "type" : "string", "description" : "商品归属主体类型。枚举如下：\t5：店铺。\t8：小程序。", "example" : "8" }, "type" : { "type" : "string", "description" : "商品类型。枚举支持：\tSTANDARD_GOODS：标品，一般是具有明确、标准规格、型号、参数的商品，如：手机、数码产品、大多数的家电 。\tNON_STANDARD_GOODS：非标品，则是在这些方面没有统一的行业标准和参数规格的商品，如：服装、鞋袜等。", "example" : "STANDARD_GOODS" } } }, "AntMerchantExpandItemOpenCreateResponseModel" : { "type" : "object", "properties" : { "item_id" : { "type" : "string", "description" : "商品ID", "example" : "2018091300502200002600104169" } } }, "AntMerchantExpandItemOpenDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "DB_ERROR", "ARGUMENT_NULL", "ITEM_NOT_EXIST", "NO_PERMISSION", "ARGUMENT_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandItemOpenDeleteResponseModel" : { "type" : "object" }, "AntMerchantExpandItemOpenModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "DB_ERROR", "ARGUMENT_NULL", "ARGUMENT_ILLEGAL", "ITEM_NOT_EXIST", "ITEM_CATEGORY_NOT_EXIST", "INFO_SEC_ERROR", "NO_PERMISSION" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandItemOpenModifyModel" : { "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "商品描述", "example" : "精选东北优质非转基因大豆" }, "ext_info" : { "type" : "array", "description" : "商品扩展信息（覆盖商品已存在扩展信息、具体KEY请参见产品文档）", "items" : { "$ref" : "#/components/schemas/ItemExtInfo" } }, "item_id" : { "type" : "string", "description" : "商品ID，通过创建商品接口 https://opendocs.alipay.com/apis/api_4/ant.merchant.expand.item.open.create 获取。", "example" : "2019073100702219000000100000" }, "material_list" : { "type" : "array", "description" : "商品素材列表（会和商品已存在素材做差异化比较后做增删改操作）", "items" : { "$ref" : "#/components/schemas/MaterialModifyInfo" } }, "name" : { "type" : "string", "description" : "商品名称", "example" : "西红柿炒蛋" }, "property_list" : { "type" : "array", "description" : "商品属性列表（覆盖商品已存在属性）", "items" : { "$ref" : "#/components/schemas/ItemPropertyInfo" } }, "sku_list" : { "type" : "array", "description" : "SKU列表（会和商品已存在SKU做差异化比较后做增删改操作）", "items" : { "$ref" : "#/components/schemas/SkuModifyInfo" } }, "standard_category_id" : { "type" : "string", "description" : "商品所属标准类目ID，当 type 为STANDARD_GOODS（标品）时必填。 请填入 https://opendocs.alipay.com/mini/011lxt 小程序商品类目表中三级类目ID。", "example" : "2019073100992228000000100000" }, "status" : { "type" : "string", "description" : "商品状态：EFFECT（有效）、INVALID（无效）", "example" : "EFFECT" }, "type" : { "type" : "string", "description" : "商品类型：STANDARD_GOODS（标品）、NON_STANDARD_GOODS（非标品）", "example" : "STANDARD_GOODS" } } }, "AntMerchantExpandItemOpenModifyResponseModel" : { "type" : "object" }, "AntMerchantExpandItemOpenQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "DB_ERROR", "ARGUMENT_NULL", "ARGUMENT_ILLEGAL", "NO_PERMISSION" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandItemOpenQueryResponseModel" : { "type" : "object", "properties" : { "item_list" : { "type" : "array", "description" : "商品列表", "items" : { "$ref" : "#/components/schemas/CmItemInfo" } } } }, "AntMerchantExpandItemQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "DB_ERROR", "ARGUMENT_NULL", "ARGUMENT_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandItemQueryResponseModel" : { "type" : "object", "properties" : { "item_list" : { "type" : "array", "description" : "商品列表", "items" : { "$ref" : "#/components/schemas/ItemModel" } } } }, "AntMerchantExpandItemStatusModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "DB_ERROR", "ARGUMENT_NULL", "ITEM_NOT_EXIST", "ITEM_ERROR_STATUS" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandItemStatusModifyModel" : { "type" : "object", "properties" : { "item_id" : { "type" : "string", "description" : "商品ID", "example" : "2018091300502200002600104169" }, "status" : { "type" : "string", "description" : "商品状态：EFFECT、INVALID", "example" : "EFFECT" } } }, "AntMerchantExpandItemStatusModifyResponseModel" : { "type" : "object", "properties" : { "item_id" : { "type" : "string", "description" : "商品id", "example" : "2018091300502200002600104169" } } }, "AntMerchantExpandMccQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "MER_ARGUMENT_NULL", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandMccQueryResponseModel" : { "type" : "object", "properties" : { "mcc_info_list" : { "type" : "array", "description" : "mcc查询信息结果列表", "items" : { "$ref" : "#/components/schemas/MccQueryInfo" } } } }, "AntMerchantExpandOrderQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "NOT_ALLOW_QUERY", "ORDER_ID_EMPTY", "ORDER_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandOrderQueryResponseModel" : { "type" : "object", "properties" : { "apply_time" : { "type" : "string", "description" : "申请单创建时间", "example" : "2017-11-11 12:00:00" }, "ext_info" : { "type" : "string", "description" : "返回申请单相关参数。当前返回内容有cardAliasNo，smid", "example" : "{\"cardAliasNo\":\"ab7c65ab96\",\"smid\":\"20881234567890\"}" }, "ip_role_id" : { "type" : "array", "description" : "商户角色id。间连商户或平台商二级商户业务中，本字段表示smid。审核通过后生成。", "items" : { "type" : "string" }, "example" : "2088301155943087" }, "merchant_name" : { "type" : "string", "description" : "商户名称", "example" : "蚂蚁金服（杭州）网络技术有限公司" }, "status" : { "type" : "string", "description" : "申请单状态。枚举支持：\t99：已完结；\t-1：失败；\t031：已提交审核。", "example" : "99" } } }, "AntMerchantExpandShopCloseErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "MER_ARGUMENT_NULL", "SHOP_NOT_EXIST", "RELATION_NOT_EXIST", "NOT_ALLOWED_SETTLE", "MER_ARGUMENT_ILLEGAL", "THIRD_SYSTEM_ERROR", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandShopCloseModel" : { "type" : "object", "properties" : { "ip_role_id" : { "type" : "string", "description" : "商户角色id，表示将要开的店属于哪个商户角色。对于直连开店场景，填写商户pid；对于间连开店场景（线上、线下、直付通），填写商户smid。若未传入shop_id 则本参数与store_id均必填。", "example" : "2088301155943087" }, "shop_id" : { "type" : "string", "description" : "支付宝侧蚂蚁店铺 id。传入本参数后可不填 store_id 及 ip_role_id。", "example" : "2018011900502000000005124744" }, "store_id" : { "type" : "string", "description" : "商户侧球房编号。表示该球房在该商户角色id(直连pid，间连smid)下，由商户自己定义的外部球房编号。若未传入 shop_id 则本参数与与ip_role_id均必填。", "example" : "NO0001" } } }, "AntMerchantExpandShopCloseResponseModel" : { "type" : "object" }, "AntMerchantExpandShopConsultErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "NOT_ALLOWED_SETTLE", "SHOP_CATEGORY_IS_ILLEGAL", "ISV_NOT_EXIST", "SHOP_ACCOUNT_NO_IS_ILLEGAL", "SHOP_SHOPNO_IS_EMPTY", "INDUSTRY_QUALIFICATION_IS_EMPTY", "SETTLED_OUTDOORIMAGE_EMPTY", "SHOP_SHOPNAME_IS_EMPTY", "SETTLED_BIZ_ADDRESS_ILLEGAL", "SHOP_CATEGORY_IS_EMPTY", "CONTACT_WAY_VALUE_NULL", "ADDRESS_PROVINCE_CODE_ILLEGAL", "ADDRESS_CITY_CODE_ILLEGAL", "ADDRESS_DISTRICT_CODE_ILLEGAL", "SHOP_ALREADY_EXIST", "GONGAN_CHECK_FAIL", "GONGSHANG_CHECK_FAIL", "MERCHANT_INPUT_ARGUMENT_ILLEGAL", "BRAND_ILLEGAL", "CONTACT_PERSON_NAME_NULL", "USER_ILLEGAL", "PROFILE_KEY_ILLEGAL", "SETTLED_BANKCARD_NO_IS_EMPTY", "SETTLED_ACCOUNTHOLDERNAME_EMPTY", "SETTLED_ACCOUNTBRANCHNAME_EMPTY", "SETTLED_ACCOUNTINSTNAME_EMPTY", "SETTLED_USAGETYPE_IS_EMPTY", "BANK_BRANCH_NAME_ILLEGAL", "SETTLED_USAGETYPE_ILLEGAL", "SETTLED_CARD_ACCOUNTINSTID_EMPTY", "SETTLED_CARD_ACCOUNTTYPE_EMPTY", "BANK_ACCOUNTINSTID_ILLEGAL", "SETTLED_CARD_ACCOUNTTYPE_ILLEGAL", "BANK_ACCOUNTINSTNAME_ILLEGAL", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandShopConsultModel" : { "type" : "object", "properties" : { "biz_cards" : { "type" : "array", "description" : "球房结算卡信息。本业务当前只允许传入一张结算卡。\t说明：本参数仅直付通业务使用，其余业务无需关注。", "items" : { "$ref" : "#/components/schemas/SettleCardInfo" } }, "brand_id" : { "type" : "string", "description" : "品牌id，非加油站等特殊球房无需关注。", "example" : "20181026000001" }, "business_address" : { "$ref" : "#/components/schemas/AddressInfo" }, "business_time" : { "type" : "array", "description" : "店铺经营时间。", "items" : { "$ref" : "#/components/schemas/ShopBusinessTime" } }, "cert_image" : { "type" : "string", "description" : "营业执照图片，需传入ant.merchant.expand.indirect.image.upload 接口上传图片后得到的 image_id。\t注意：\t* 蚂蚁球房管理场景可选。\t* 间连 M1、M2商家创建球房，必须传入营业执照图片。", "example" : "c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg" }, "cert_name" : { "type" : "string", "description" : "营业执照名称，填写值为营业执照或统一社会信用代码证上的名称。\t注意：若传入 cert_no，则本参数必填。", "example" : "xxxx小卖铺" }, "cert_no" : { "type" : "string", "description" : "证件号码，请填写店铺营业执照号。\t注意：\t* 蚂蚁球房管理场景可选。\t* 间连 M1、M2商家创建球房，必须传入营业执照号。", "example" : "9133010608210550XR" }, "cert_type" : { "type" : "string", "description" : "证件类型，取值范围：201：营业执照；2011:多证合一(统一社会信用代码)。\t注意：若传入 cert_no，则本参数必填。", "example" : "201" }, "contact_infos" : { "type" : "array", "description" : "联系人信息。如果填写，其中名称必填，手机、固话、email 三选一必填。", "items" : { "$ref" : "#/components/schemas/ContactInfo" } }, "contact_mobile" : { "type" : "string", "description" : "店铺联系手机，与店铺联系固话二选一必填", "example" : "13901390139" }, "contact_phone" : { "type" : "string", "description" : "店铺的联系固话，和店铺联系手机二选一必填", "example" : "010-62286228" }, "ext_infos" : { "type" : "array", "description" : "扩展信息列表。key值需要向对应行业的bd进行申请。", "items" : { "$ref" : "#/components/schemas/ShopExtInfo" } }, "ip_role_id" : { "type" : "string", "description" : "商户角色id，表示将要开的店属于哪个商户角色。对于直连开店场景，填写商户pid；对于间连开店场景（线上、线下、直付通），填写商户smid。特别说明：IoT设备三绑定场景统一填写商户pid", "example" : "2088301155943087" }, "legal_cert_no" : { "type" : "string", "description" : "法人身份证号。蚂蚁球房管理场景可选。", "example" : "100100198811110001" }, "legal_name" : { "type" : "string", "description" : "法人名称。蚂蚁球房管理场景可选。", "example" : "马云" }, "license_auth_letter_image" : { "type" : "string", "description" : "营业执照授权函。需传入ant.merchant.expand.indirect.image.upload 接口上传图片后得到的 image_id。\t蚂蚁球房管理场景可选。", "example" : "c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg" }, "memo" : { "type" : "string", "description" : "备注", "example" : "备注" }, "out_door_images" : { "type" : "string", "description" : "门头照 id，需传入 ant.merchant.expand.indirect.image.upload 接口上传图片后得到的 image_id。\t蚂蚁球房管理场景可选。", "example" : "c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg" }, "qualifications" : { "type" : "array", "description" : "行业特殊资质。", "items" : { "$ref" : "#/components/schemas/IndustryQualificationInfo" } }, "scene" : { "type" : "string", "description" : "场景，非加油站等特殊球房无需关注。", "example" : "PARK" }, "settle_alipay_logon_id" : { "type" : "string", "description" : "结算支付宝账号的登录号，需传入小程序归属账号。若需增加收款账号，可在创建球房后登录商家中心 ，在 账户中心 > 经营信息 > 球房管理 中选择对应球房选择 更多 > 编辑 > 新增收款账号。", "example" : "demo@163.com" }, "shop_category" : { "type" : "string", "description" : "新版球房类目标准二级类目code。类目标准及与原类目映射关系参见 支付宝球房类目-最新 表格。", "example" : "B0001" }, "shop_name" : { "type" : "string", "description" : "店铺名称。直连开店要保证全局店铺名称+地址唯一，间连开店要保证服务商pid下店铺名称+地址唯一", "example" : "肯德基中关村店" }, "shop_type" : { "type" : "string", "description" : "店铺经营类型，01表示直营，02表示加盟", "example" : "01" }, "store_id" : { "type" : "string", "description" : "球房编号，表示该球房在该商户角色id(直连pid，间连smid)下，由商户自己定义的外部球房编号", "example" : "NO0001" } } }, "AntMerchantExpandShopConsultResponseModel" : { "type" : "object", "properties" : { "account_audit" : { "type" : "boolean", "description" : "资金账户是否审核。当调用没有报错时，本值才有参考意义", "example" : "true" }, "order_id" : { "type" : "string", "description" : "咨询申请单id", "example" : "2018011900502000000005124744" }, "risk_audit" : { "type" : "boolean", "description" : "是否风控审核。当调用没有报错时，本值才有参考意义", "example" : "true" } } }, "AntMerchantExpandShopCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "NOT_ALLOWED_SETTLE", "SHOP_CATEGORY_IS_ILLEGAL", "ISV_NOT_EXIST", "SHOP_ACCOUNT_NO_IS_ILLEGAL", "SHOP_SHOPNO_IS_EMPTY", "INDUSTRY_QUALIFICATION_IS_EMPTY", "SETTLED_OUTDOORIMAGE_EMPTY", "SHOP_SHOPNAME_IS_EMPTY", "SETTLED_BIZ_ADDRESS_ILLEGAL", "SHOP_CATEGORY_IS_EMPTY", "CONTACT_WAY_VALUE_NULL", "ADDRESS_PROVINCE_CODE_ILLEGAL", "ADDRESS_CITY_CODE_ILLEGAL", "ADDRESS_DISTRICT_CODE_ILLEGAL", "SHOP_ALREADY_EXIST", "GONGAN_CHECK_FAIL", "GONGSHANG_CHECK_FAIL", "MERCHANT_INPUT_ARGUMENT_ILLEGAL", "CONTACT_PERSON_NAME_NULL", "USER_ILLEGAL", "BRAND_ILLEGAL", "PROFILE_KEY_ILLEGAL", "SETTLED_BANKCARD_NO_IS_EMPTY", "SETTLED_ACCOUNTHOLDERNAME_EMPTY", "SETTLED_ACCOUNTBRANCHNAME_EMPTY", "SETTLED_ACCOUNTINSTNAME_EMPTY", "SETTLED_USAGETYPE_IS_EMPTY", "BANK_BRANCH_NAME_ILLEGAL", "SETTLED_USAGETYPE_ILLEGAL", "SETTLED_CARD_ACCOUNTINSTID_EMPTY", "SETTLED_CARD_ACCOUNTTYPE_EMPTY", "BANK_ACCOUNTINSTID_ILLEGAL", "SETTLED_CARD_ACCOUNTTYPE_ILLEGAL", "BANK_ACCOUNTINSTNAME_ILLEGAL", "SYSTEM_ERROR", "GONGSHANG_LICENSE_ILLEGAL", "BUSINESS_LICENSE_EMPTY", "MER_ARGUMENT_NULL", "MERCHANT_NOT_EXIST", "ATTACHMENT_TYPE_ILLEGAL", "SHOP_NOT_EXIST", "ATTACHMENT_URL_NULL", "LOCATION_CHECK_FAIL", "ATTACHMENT_CHECK_FAIL", "BUSINESS_TIME_ILLEGAL", "SHOP_AUDIT_REJECT", "MER_ARGUMENT_ILLEGAL", "CTU_INDIRECT_CREATE_FAIL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandShopCreateModel" : { "type" : "object", "properties" : { "biz_cards" : { "type" : "array", "description" : "球房结算卡信息。本业务当前只允许传入一张结算卡。\t说明：本参数仅直付通业务使用，其余业务无需关注。", "items" : { "$ref" : "#/components/schemas/SettleCardInfo" } }, "brand_id" : { "type" : "string", "description" : "品牌id，非加油站等特殊球房无需关注。", "example" : "20181026000001" }, "business_address" : { "$ref" : "#/components/schemas/AddressInfo" }, "business_time" : { "type" : "array", "description" : "店铺经营时间。", "items" : { "$ref" : "#/components/schemas/ShopBusinessTime" } }, "cert_image" : { "type" : "string", "description" : "营业执照图片，需传入ant.merchant.expand.indirect.image.upload 接口上传图片后得到的 image_id。", "example" : "c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg" }, "cert_name" : { "type" : "string", "description" : "营业执照名称，填写值为营业执照或统一社会信用代码证上的名称。\t注意：若传入 cert_no，则本参数必填。", "example" : "xxxx小卖铺" }, "cert_no" : { "type" : "string", "description" : "证件号码，请填写店铺营业执照号。", "example" : "9133010608210550XR" }, "cert_type" : { "type" : "string", "description" : "证件类型，取值范围：201：营业执照；2011:多证合一(统一社会信用代码)。\t注意：若传入 cert_no，则本参数必填。", "example" : "201" }, "contact_infos" : { "type" : "array", "description" : "联系人信息。如果填写，其中名称必填，手机、固话、email 三选一必填。", "items" : { "$ref" : "#/components/schemas/ContactInfo" } }, "contact_mobile" : { "type" : "string", "description" : "店铺联系手机，与店铺联系固话二选一必填", "example" : "13901390139" }, "contact_phone" : { "type" : "string", "description" : "店铺的联系固话，和店铺联系手机二选一必填", "example" : "010-62286228" }, "ext_infos" : { "type" : "array", "description" : "扩展信息列表。key值需要向对应行业的bd进行申请。", "items" : { "$ref" : "#/components/schemas/ShopExtInfo" } }, "ip_role_id" : { "type" : "string", "description" : "商户角色id，表示将要开的店属于哪个商户角色。对于直连开店场景，填写商户pid；对于间连开店场景（线上、线下、直付通），填写商户smid。特别说明：IoT设备三绑定场景统一填写商户pid", "example" : "2088301155943087" }, "legal_cert_no" : { "type" : "string", "description" : "法人身份证号。通过蚂蚁球房管理能力创建球房时可选。", "example" : "100100198811110001" }, "legal_name" : { "type" : "string", "description" : "法人名称。通过蚂蚁球房管理能力创建球房时可选。", "example" : "支小宝" }, "license_auth_letter_image" : { "type" : "string", "description" : "营业执照授权函。需传入ant.merchant.expand.indirect.image.upload 接口上传图片后得到的 image_id。\t通过蚂蚁球房管理能力创建球房时可选。", "example" : "c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg" }, "memo" : { "type" : "string", "description" : "备注", "example" : "备注" }, "out_door_images" : { "type" : "array", "description" : "门头照 id，需传入ant.merchant.expand.indirect.image.upload 接口上传图片后得到的 image_id。\t通过蚂蚁球房管理能力创建球房时可选。", "items" : { "type" : "string" }, "example" : "c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg" }, "qualifications" : { "type" : "array", "description" : "行业特殊资质。", "items" : { "$ref" : "#/components/schemas/IndustryQualificationInfo" } }, "scene" : { "type" : "string", "description" : "场景，非加油站/酒店等特殊球房无需关注。", "example" : "PARK" }, "settle_alipay_logon_id" : { "type" : "string", "description" : "结算支付宝账号的登录号。", "example" : "demo@163.com" }, "shop_category" : { "type" : "string", "description" : "新版球房类目标准二级类目code。类目标准及与原类目映射关系参见 支付宝球房类目-最新 表格。", "example" : "B0001" }, "shop_name" : { "type" : "string", "description" : "店铺名称。直连开店要保证全局店铺名称+地址唯一，间连开店要保证服务商pid下店铺名称+地址唯一", "example" : "肯德基中关村店" }, "shop_type" : { "type" : "string", "description" : "店铺经营类型，01表示直营，02表示加盟", "example" : "01" }, "store_id" : { "type" : "string", "description" : "球房编号，表示该球房在该商户角色id(直连pid，间连smid)下，由商户自己定义的外部球房编号", "example" : "NO0001" } } }, "AntMerchantExpandShopCreateResponseModel" : { "type" : "object", "properties" : { "exist_shop_id" : { "type" : "string", "description" : "触发幂等时返回已存在的球房shopId", "example" : "2022102800077000000039913046" }, "order_id" : { "type" : "string", "description" : "申请单id", "example" : "2018012000502000000005130266" } } }, "AntMerchantExpandShopModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "NOT_ALLOWED_SETTLE", "SHOP_CATEGORY_IS_ILLEGAL", "ISV_NOT_EXIST", "SHOP_ACCOUNT_NO_IS_ILLEGAL", "INDUSTRY_QUALIFICATION_IS_EMPTY", "SETTLED_OUTDOORIMAGE_EMPTY", "SETTLED_BIZ_ADDRESS_ILLEGAL", "SHOP_CATEGORY_IS_EMPTY", "CONTACT_WAY_VALUE_NULL", "ADDRESS_PROVINCE_CODE_ILLEGAL", "ADDRESS_CITY_CODE_ILLEGAL", "ADDRESS_DISTRICT_CODE_ILLEGAL", "GONGAN_CHECK_FAIL", "GONGSHANG_CHECK_FAIL", "MERCHANT_INPUT_ARGUMENT_ILLEGAL", "CONTACT_PERSON_NAME_NULL", "USER_ILLEGAL", "BRAND_ILLEGAL", "PROFILE_KEY_ILLEGAL", "MER_ARGUMENT_NULL", "IP_ROLE_ID_DO_NOT_CHANGE", "SHOP_NOT_EXIST", "RELATION_NOT_EXIST", "SHOP_ALREADY_EXIST", "SETTLED_BANKCARD_NO_IS_EMPTY", "SETTLED_ACCOUNTHOLDERNAME_EMPTY", "SETTLED_ACCOUNTBRANCHNAME_EMPTY", "SETTLED_ACCOUNTINSTNAME_EMPTY", "SETTLED_USAGETYPE_IS_EMPTY", "BANK_BRANCH_NAME_ILLEGAL", "SETTLED_USAGETYPE_ILLEGAL", "SETTLED_CARD_ACCOUNTINSTID_EMPTY", "SETTLED_CARD_ACCOUNTTYPE_EMPTY", "BANK_ACCOUNTINSTID_ILLEGAL", "SETTLED_CARD_ACCOUNTTYPE_ILLEGAL", "BANK_ACCOUNTINSTNAME_ILLEGAL", "SETTLED_ALIPAYACCOUNT_NOT_EXIST", "GONGSHANG_LICENSE_ILLEGAL", "SYSTEM_ERROR", "SHOP_TYPE_ILLEGAL", "LOCATION_CHECK_FAIL", "ATTACHMENT_CHECK_FAIL", "BUSINESS_TIME_ILLEGAL", "SHOP_AUDIT_REJECT", "ATTACHMENT_URL_NULL", "SHOP_CODE_ALREADY_EXIST", "MER_ARGUMENT_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandShopModifyModel" : { "type" : "object", "properties" : { "biz_cards" : { "type" : "array", "description" : "球房结算卡信息。本业务当前只允许传入一张结算卡。\t说明：本参数仅直付通业务使用，其余业务无需关注。", "items" : { "$ref" : "#/components/schemas/SettleCardInfo" } }, "brand_id" : { "type" : "string", "description" : "品牌id。若无需更新本信息项，可以不填写", "example" : "20181026000001" }, "business_address" : { "$ref" : "#/components/schemas/AddressInfo" }, "business_time" : { "type" : "array", "description" : "店铺经营时间。若无需更新本信息项，可以不填写", "items" : { "$ref" : "#/components/schemas/ShopBusinessTime" } }, "cert_image" : { "type" : "string", "description" : "营业执照图片url。其值为使用ant.merchant.expand.indirect.image.upload上传图片得到的一串oss key。若无需更新本信息项，可以不填写", "example" : "c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg" }, "cert_name" : { "type" : "string", "description" : "营业执照名称，填写值为营业执照或统一社会信用代码证上的名称。若无需更新本信息项，可以不填写\t注意：若传入 cert_no 则本参数必填。", "example" : "xxxx小卖铺" }, "cert_no" : { "type" : "string", "description" : "证件号码。请填写店铺营业执照号。若无需更新本信息项，可以不填写，以原有值为准", "example" : "9133010608210550XR" }, "cert_type" : { "type" : "string", "description" : "证件类型，取值范围：201：营业执照；2011:多证合一(统一社会信用代码)。若无需更新本信息项，可以不填写。\t注意：若传入 cert_no 则本参数必填。", "example" : "201" }, "contact_infos" : { "$ref" : "#/components/schemas/ContactInfo" }, "contact_mobile" : { "type" : "string", "description" : "店铺联系手机。若无需更新本信息项，可以不填写，以原有值为准", "example" : "13901390139" }, "contact_phone" : { "type" : "string", "description" : "店铺的联系固话。若无需更新本信息项，可以不填写，以原有值为准", "example" : "010-62286228" }, "ext_infos" : { "type" : "array", "description" : "扩展信息列表。key值需要向对应行业的bd进行申请。传入本项时，按key进行更新或补充", "items" : { "$ref" : "#/components/schemas/ShopExtInfo" } }, "ip_role_id" : { "type" : "string", "description" : "商户角色id，表示将要修改的店属于哪个商户角色，和store_id一起定位待修改的球房。对于直连场景，填写商户pid；对于间连场景（线上、线下、直付通），填写商户smid。本接口中，如果没传shop_id，则本字段与store_id均必填。本信息项不可修改", "example" : "2088301155943087" }, "legal_cert_no" : { "type" : "string", "description" : "法人身份证号。如果要更新，必须和legal_name成对传入", "example" : "100100198811110001" }, "legal_name" : { "type" : "string", "description" : "法人名称。如果要更新，必须和legal_cert_no成对传入", "example" : "支小宝" }, "license_auth_letter_image" : { "type" : "string", "description" : "营业执照授权函。其值为使用ant.merchant.expand.indirect.image.upload上传图片得到的一串oss key。若无需更新本信息项，可以不填写", "example" : "c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg" }, "memo" : { "type" : "string", "description" : "备注。若无需更新本信息项，可以不填写", "example" : "备注" }, "out_door_images" : { "type" : "array", "description" : "门头照，其值为使用ant.merchant.expand.indirect.image.upload上传图片得到的一串oss key。若无需更新本信息项，可以不填写。若填写则会整体覆盖原有的门头照列表", "items" : { "type" : "string" }, "example" : "c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg" }, "qualifications" : { "type" : "array", "description" : "行业特殊资质。若无需更新本信息项，可以不填写。填写会按类型进行更新或补充", "items" : { "$ref" : "#/components/schemas/IndustryQualificationInfo" } }, "scene" : { "type" : "string", "description" : "场景。若无需更新本信息项，可以不填写", "example" : "PARK" }, "settle_alipay_logon_id" : { "type" : "string", "description" : "结算支付宝账号的登录号。若无需更新本信息项，可以不填写", "example" : "demo@163.com" }, "shop_category" : { "type" : "string", "description" : "新版球房类目标准二级类目code。类目标准及与原shop_category映射关系参见表格 https://ur.alipay.com/2qv1f9。若无需更新本信息项，可以不填写", "example" : "B0001" }, "shop_id" : { "type" : "string", "description" : "蚂蚁店铺id，用于查出待修改的球房。填写本参数的话，store_id和ip_role_id可以不填。本信息项不可修改", "example" : "2018011900502000000005124744" }, "shop_name" : { "type" : "string", "description" : "店铺名称。直连开店要保证全局店铺名称+地址唯一，间连开店要保证服务商pid下店铺名称+地址唯一。若无需更新本信息项，可以不填写", "example" : "肯德基中关村店" }, "store_id" : { "type" : "string", "description" : "球房编号，表示该球房在该商户角色id(直连pid，间连smid)下，由商户自己定义的外部球房编号。用于查出待修改的球房。本接口中，如果没传shop_id，则本字段与ip_role_id均必填；传入shop_id情况下，以shop_id为准查询球房，并修改本信息项", "example" : "NO0001" } } }, "AntMerchantExpandShopModifyResponseModel" : { "type" : "object", "properties" : { "order_id" : { "type" : "string", "description" : "申请单id", "example" : "2018012000502000000005130266" } } }, "AntMerchantExpandShopPageQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "MER_ARGUMENT_NULL", "NOT_ALLOWED_SETTLE", "MERCHANT_NOT_EXIST", "SYSTEM_ERROR", "ADDRESS_VERSION_CODE_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandShopPageQueryResponseModel" : { "type" : "object", "properties" : { "shop_infos" : { "type" : "array", "description" : "球房详情", "items" : { "$ref" : "#/components/schemas/ShopQueryOpenApiVO" } }, "total_pages" : { "type" : "integer", "description" : "总页数", "example" : "10" } } }, "AntMerchantExpandShopQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "MER_ARGUMENT_NULL", "SHOP_NOT_EXIST", "RELATION_NOT_EXIST", "NOT_ALLOWED_SETTLE", "MERCHANT_NOT_EXIST", "ADDRESS_VERSION_CODE_ILLEGAL", "SYSTEM_ERROR", "THIRD_SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandShopQueryResponseModel" : { "type" : "object", "properties" : { "brand_id" : { "type" : "string", "description" : "品牌id", "example" : "20181026000001" }, "business_address" : { "$ref" : "#/components/schemas/AddressInfo" }, "business_time" : { "type" : "array", "description" : "店铺经营时间。", "items" : { "$ref" : "#/components/schemas/ShopBusinessTime" } }, "cert_image" : { "type" : "string", "description" : "营业执照图片url。返回值为一个有访问时限的链接", "example" : "https://mif-pub.alipayobjects.com/c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg" }, "cert_name" : { "type" : "string", "description" : "营业执照名称，值为营业执照或统一社会信用代码证上的名称。", "example" : "xxxx小卖铺" }, "cert_no" : { "type" : "string", "description" : "证件号码", "example" : "9133010608210550XR" }, "cert_type" : { "type" : "string", "description" : "证件类型，取值范围：201：营业执照；2011:多证合一(统一社会信用代码)。", "example" : "201" }, "contact_infos" : { "type" : "array", "description" : "联系人信息。", "items" : { "$ref" : "#/components/schemas/ContactInfo" } }, "contact_mobile" : { "type" : "string", "description" : "店铺联系手机", "example" : "13901390139" }, "contact_phone" : { "type" : "string", "description" : "店铺的联系固话", "example" : "010-62286228" }, "ext_infos" : { "type" : "array", "description" : "扩展信息列表。key值需要向对应行业的bd进行申请。", "items" : { "$ref" : "#/components/schemas/ShopExtInfo" } }, "ip_role_id" : { "type" : "string", "description" : "商户角色id，表示将要开的店属于哪个商户角色。对于直连开店场景，填写商户pid；对于间连开店场景（线上、线下、直付通），填写商户smid。若未传入shop_id 则本参数与store_id均必填。", "example" : "2088301155943087" }, "legal_cert_no" : { "type" : "string", "description" : "法人身份证号。", "example" : "100100198811110001" }, "legal_name" : { "type" : "string", "description" : "法人名称。", "example" : "马云" }, "license_auth_letter_image" : { "type" : "string", "description" : "营业执照授权函。返回值为一个有访问时限的链接", "example" : "https://mif-pub.alipayobjects.com/c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg" }, "memo" : { "type" : "string", "description" : "备注", "example" : "备注" }, "new_shop_category" : { "type" : "string", "description" : "新版球房类目标准二级类目code。类目标准及与原shop_category映射关系参见文档https://gw.alipayobjects.com/os/bmw-prod/4b3f82df-e53e-4b84-bc41-fe025101e726.xlsx", "example" : "B0001" }, "out_door_images" : { "type" : "array", "description" : "门头照，返回值为一个有访问时限的链接", "items" : { "type" : "string" }, "example" : "https://mif-pub.alipayobjects.com/c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg" }, "qualifications" : { "type" : "array", "description" : "行业特殊资质。", "items" : { "$ref" : "#/components/schemas/IndustryQualificationInfo" } }, "scene" : { "type" : "string", "description" : "场景", "example" : "PARK" }, "settle_alipay_logon_id" : { "type" : "string", "description" : "结算支付宝账号的登录号", "example" : "demo@163.com" }, "shop_category" : { "type" : "string", "description" : "店铺类目，取值参见文件https://mif-pub.alipayobjects.com/ShopCategory.xlsx 中的三级球房类目", "example" : "1001" }, "shop_id" : { "type" : "string", "description" : "支付宝侧蚂蚁店铺 id。传入本参数后可不填 store_id 及 ip_role_id。", "example" : "2018011900502000000005124744" }, "shop_info_status" : { "type" : "string", "description" : "当前名称、地址、经纬度信息准确一致，可用于数字化经营场景消费（01=已认证，02=待优化，03=审核中，99=未知）", "example" : "01" }, "shop_name" : { "type" : "string", "description" : "店铺名称。", "example" : "肯德基中关村店" }, "shop_recommend_info" : { "$ref" : "#/components/schemas/ShopRecommendInfo" }, "shop_type" : { "type" : "string", "description" : "店铺经营类型，01表示直营，02表示加盟", "example" : "01" }, "store_id" : { "type" : "string", "description" : "商户侧球房编号。表示该球房在该商户角色id(直连pid，间连smid)下，由商户自己定义的外部球房编号。若未传入 shop_id 则本参数与与ip_role_id均必填。", "example" : "NO0001" } } }, "AntMerchantExpandShopReceiptaccountSaveErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "MER_ARGUMENT_NULL", "SHOP_NOT_EXIST", "RECEIPT_ACCOUNT_NOT_EXIST", "RECEIPT_ACCOUNT_EXISTS", "RECEIPT_ACCOUNT_EXCEED_LIMIT", "SYSTEM_ERROR", "MERCHANT_NOT_EXIST", "NOT_ALLOWED_SETTLE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AntMerchantExpandShopReceiptaccountSaveModel" : { "type" : "object", "properties" : { "promise" : { "type" : "string", "description" : "是否承诺收单账号信息准确。具体承诺信息可查看 球房信息承诺函。\tY 是\tN 否", "example" : "Y" }, "receipt_account_id" : { "type" : "string", "description" : "收单账号", "example" : "2088502344354813" }, "shop_id" : { "type" : "string", "description" : "店铺ID", "example" : "2022062300502007000073505619" } } }, "AntMerchantExpandShopReceiptaccountSaveResponseModel" : { "type" : "object" }, "AnttechOceanbaseTestplatformTaskQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "AnttechOceanbaseTestplatformTaskQueryModel" : { "type" : "object", "properties" : { "end_time" : { "type" : "string", "description" : "筛选结束时间", "example" : "2022-04-18 15:28:52" }, "palyer" : { "type" : "string", "description" : "参赛选手的名字", "example" : "无名选手" }, "run_task_retry" : { "type" : "integer", "description" : "允许超时任务的重试次数", "example" : "3" }, "run_task_time_out_minutes" : { "type" : "integer", "description" : "获取任务时先获取超时任务，这里传入的是超时的分钟数。默认30分钟。", "example" : "30" }, "start_time" : { "type" : "string", "description" : "获取任务的筛选条件", "example" : "2022-04-15 18:36:24" }, "test_cases" : { "type" : "string", "description" : "二级提测题目", "example" : "查询元数据校验select-meta" }, "test_info" : { "type" : "string", "description" : "测试结果描述、备注信息", "example" : "代码风格比较好" }, "test_suite" : { "type" : "string", "description" : "一级提测题目", "example" : "mini-ob" } } }, "AnttechOceanbaseTestplatformTaskQueryResponseModel" : { "type" : "object", "properties" : { "branch" : { "type" : "string", "description" : "提测代码的分支", "example" : "test-miniob" }, "commit_id" : { "type" : "string", "description" : "提测代码仓库的commit id", "example" : "586cbbe560dff2792dcc76e5705367b21fa1df5d" }, "current_retry" : { "type" : "string", "description" : "当前任务的运行（重试）次数", "example" : "1" }, "git_repo" : { "type" : "string", "description" : "代码仓库的url", "example" : "https://github.com/oceanbase/oceanbase.git" }, "gmt_create" : { "type" : "string", "description" : "任务创建的时间戳", "example" : "2022-04-15 18:36:24" }, "player" : { "type" : "string", "description" : "参赛选手的名字", "example" : "无名选手" }, "result_type" : { "type" : "integer", "description" : "提测结果类型 默认1", "example" : "1" }, "task_id" : { "type" : "integer", "description" : "测试任务的Id", "example" : "1" }, "test_cases" : { "type" : "string", "description" : "二级提测题目", "example" : "查询元数据校验select-meta" }, "test_info" : { "type" : "string", "description" : "测试题目", "example" : "必做。查询语句中存在不存在的列名、表名等，需要返回失败。需要检查代码，判断是否需要返回错误的地方都返回错误了。" }, "test_suite" : { "type" : "string", "description" : "一级提测题目", "example" : "mini-ob" } } }, "AppMemberInfo" : { "type" : "object", "properties" : { "gmt_invite" : { "type" : "string", "description" : "邀请时间", "example" : "2017-09-08 12:00:00" }, "gmt_join" : { "type" : "string", "description" : "加入时间", "example" : "2017-08-12" }, "logon_id" : { "type" : "string", "description" : "支付宝登录账号", "example" : "test@example.com" }, "nick_name" : { "type" : "string", "description" : "昵称", "example" : "张三" }, "open_id" : { "type" : "string", "description" : "支付宝用户openId", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "portrait" : { "type" : "string", "description" : "头像地址", "example" : "http://imageg.alipay.com/1" }, "role" : { "type" : "string", "description" : "角色类型", "example" : "DEVELOPER" }, "status" : { "type" : "string", "description" : "成员的状态，VALID-有效，UNCONFIRMED-未确认，TIMEOUT-已经失效，REFUSED-用户拒绝", "example" : "VALID" }, "user_id" : { "type" : "string", "description" : "支付宝用户id", "example" : "20881234123412341234" } } }, "AppTokenExchangeSubElement" : { "type" : "object", "properties" : { "app_auth_token" : { "type" : "string", "description" : "应用授权令牌", "example" : "201509BBeff9351ad1874306903e96b91d248A36" }, "app_refresh_token" : { "type" : "string", "description" : "刷新令牌", "example" : "201509BBdcba1e3347de4e75ba3fed2c9abebE36" }, "auth_app_id" : { "type" : "string", "description" : "授权商户appid", "example" : "2013121100055554" }, "expires_in" : { "type" : "string", "description" : "过期时间", "example" : "123456" }, "re_expires_in" : { "type" : "string", "description" : "刷新令牌过期时间", "example" : "123456" }, "user_id" : { "type" : "string", "description" : "授权商户的user_id", "example" : "2088102150527498" } } }, "AppVersionInfo" : { "type" : "object", "properties" : { "app_version" : { "type" : "string", "description" : "版本号，一般为x.y.x格式，其中x、y、z都是数字", "example" : "0.2.9" }, "base_audit" : { "type" : "string", "description" : "准入审核结果：\tPASS：通过\tREJECT：驳回\t（提审时 audit_rule 传 BASE_PROMOTE 时有该字段）", "example" : "PASS" }, "bundle_id" : { "type" : "string", "description" : "端信息，默认为支付宝端", "example" : "com.alipay.alipaywallet" }, "can_release" : { "type" : "string", "description" : "是否可上架\ttrue：可上架\tfalse：不可上架\t（version_status 为PROMOTE_AUDIT_REJECT有值）\t（提审时 audit_rule 传 BASE_PROMOTE 时有该字段）", "example" : "true" }, "create_time" : { "type" : "string", "description" : "版本创建时间，精确到秒", "example" : "2019-12-11 19:00:12" }, "promote_audit" : { "type" : "string", "description" : "营销审核结果：\tPASS：通过\tREJECT：驳回\t（提审时 audit_rule 传 BASE_PROMOTE 时有该字段）", "example" : "PASS" }, "version_description" : { "type" : "string", "description" : "版本描述，介绍此版本的主要变更和功能", "example" : "该版本新增了XXX功能，修复了XXX的bug，优化了用户体验。" }, "version_status" : { "type" : "string", "description" : "版本状态，可选值为：INIT: 开发中, AUDITING: 审核中, AUDIT_REJECT: 审核驳回, WAIT_RELEASE: 待上架, BASE_AUDIT_PASS: 准入不可营销, GRAY: 灰度中, RELEASE: 已上架, OFFLINE: 已下架, AUDIT_OFFLINE: 被强制下架;", "example" : "AUDITING" } } }, "ApplyOrderData" : { "type" : "object", "properties" : { "access_type" : { "type" : "string", "description" : "申请类型 BASE：基础信息， BRAND_BOX：品牌直达，SERVICE_BOX服务直达", "example" : "BRAND_BOX" }, "app_name" : { "type" : "string", "description" : "小程序名称", "example" : "小程序名称" }, "appid" : { "type" : "string", "description" : "小程序id", "example" : "2021001105612404" }, "audit_reason" : { "type" : "string", "description" : "审核原因", "example" : "审核原因" }, "brand_template_id" : { "type" : "string", "description" : "品牌的模板id ONE_WITH_TWO：一拖二、DEFAULT：一拖四", "example" : "DEFAULT" }, "create_time" : { "type" : "string", "description" : "创建时间", "example" : "2020-10-16 12:32:40" }, "is_old_data" : { "type" : "boolean", "description" : "标识老工单", "example" : "false" }, "latest" : { "type" : "boolean", "description" : "是不是最新的工单", "example" : "false" }, "major_status" : { "type" : "string", "description" : "服务主状态,INITIAL:初始化；VALID：已生效；INVALID：已失效", "example" : "INITIAL" }, "order_id" : { "type" : "string", "description" : "申请单ID", "example" : "AP20200212100002488" }, "part_agree_info" : { "type" : "array", "description" : "审核提效部分剔除数据的信息", "items" : { "$ref" : "#/components/schemas/SearchPartAgreeInfo" } }, "scene_code" : { "type" : "string", "description" : "场景编码", "example" : "HOT_WORD_RANKING" }, "scene_name" : { "type" : "string", "description" : "场景名称", "example" : "场景名称" }, "service_code" : { "type" : "string", "description" : "服务码", "example" : "2019121121000102523089" }, "status" : { "type" : "string", "description" : "申请状态 AGREE、REJECT、EDIT、AUDIT", "example" : "AGREE" }, "sub_service_name" : { "type" : "string", "description" : "子服务名称", "example" : "子服务名称" } } }, "ArInvoiceLineOpenApiResponse" : { "type" : "object", "properties" : { "amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "duty_free_flag" : { "type" : "string", "description" : "免税标识" }, "incl_tax_unit_amt" : { "type" : "integer", "description" : "含税单价" }, "invoice_id" : { "type" : "string", "description" : "关联的发票ID" }, "invoice_line_id" : { "type" : "string", "description" : "发票行iD" }, "measurement_unit" : { "type" : "string", "description" : "计量单位" }, "product_name" : { "type" : "string", "description" : "货物或劳务名称" }, "product_specification" : { "type" : "string", "description" : "规格型号" }, "quantity" : { "type" : "integer", "description" : "数量" }, "tax_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "tax_exclusive_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "tax_rate" : { "type" : "integer", "description" : "税率" }, "unit_amt" : { "type" : "integer", "description" : "单价" } } }, "ArInvoiceOpenApiResponse" : { "type" : "object", "properties" : { "ar_invoice_lines" : { "type" : "array", "description" : "发票行信息集合", "items" : { "$ref" : "#/components/schemas/ArInvoiceLineOpenApiResponse" } }, "buyer_address" : { "type" : "string", "description" : "购方的地址" }, "buyer_bank_account" : { "type" : "string", "description" : "购方银行账号" }, "buyer_bank_name" : { "type" : "string", "description" : "购方开户行名称" }, "buyer_invoice_title" : { "type" : "string", "description" : "购方发票抬头，用于打印在发票上" }, "buyer_tax_no" : { "type" : "string", "description" : "购方税号" }, "buyer_telephone" : { "type" : "string", "description" : "购方的电话号码" }, "can_link" : { "type" : "boolean", "description" : "是否可以关联账单" }, "creator" : { "type" : "string", "description" : "创建人" }, "drawer" : { "type" : "string", "description" : "开票人" }, "elc_invoice_url" : { "type" : "string", "description" : "电子发票在oss上的存储地址" }, "gmt_create" : { "type" : "string", "description" : "创建时间" }, "gmt_modified" : { "type" : "string", "description" : "修改时间" }, "inst_id" : { "type" : "string", "description" : "对应发票所在OU的id，用于标示该发票所述的OU。" }, "invoice_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "invoice_channel" : { "type" : "string", "description" : "开票渠道，01：在线，02：线下" }, "invoice_code" : { "type" : "string", "description" : "发票编码" }, "invoice_date" : { "type" : "string", "description" : "发票的开票日期，yyyyMMdd" }, "invoice_id" : { "type" : "string", "description" : "发票ID，唯一标示一张发票" }, "invoice_material" : { "type" : "string", "description" : "发票介质，01：电子，02：纸质" }, "invoice_no" : { "type" : "string", "description" : "发票号码" }, "invoice_note" : { "type" : "string", "description" : "发票备注" }, "invoice_status" : { "type" : "string", "description" : "发票状态：用于标示发票当前的状态，状态类型以及相关含义\r\t01：待开票，02：开票中，03：已开票，04：作废中，05：已作废，06：红冲中，07：已红冲，08：部分红冲，09：无效" }, "invoice_type" : { "type" : "string", "description" : "发票类型：01：专票，02：普票，03：营业税发票，04：国际形式发票，05：其它发票" }, "ip_id" : { "type" : "string", "description" : "对应发票商户的ipId，在主站标示mid，在其他环境标示ip_id。" }, "ip_role_id" : { "type" : "string", "description" : "商户结算的ipRoleId，表示商户的结算对象，在主站表示pid。" }, "last_moder" : { "type" : "string", "description" : "最近修改人" }, "linked_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "mail_status" : { "type" : "string", "description" : "发票开出后的邮寄状态，具体状态说明\r\t01：待邮寄，02：已邮寄，03：退回中，04：已退回" }, "memo" : { "type" : "string", "description" : "备注" }, "no_bill_invoice_flag" : { "type" : "string", "description" : "是否是无账单发票 Y：是 N：不是" }, "online" : { "type" : "boolean", "description" : "是否为点在发票\r\ttrue：是， false：不是" }, "payee" : { "type" : "string", "description" : "收款人" }, "recent_mail_id" : { "type" : "string", "description" : "邮件信息的主键，用于‘根据发票邮寄ID获取当前的邮寄信息’的查询输入。" }, "red" : { "type" : "string", "description" : "是否红字 Y：红字， N：蓝字" }, "red_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "rel_blue_invoices" : { "type" : "array", "description" : "发票如果有关联的蓝票则显示发票关联的蓝票信息", "items" : { "$ref" : "#/components/schemas/ArRelInvoiceOpenApiResponse" } }, "rel_red_invoices" : { "type" : "array", "description" : "如果发票有关联的红票则为关联的红票的信息", "items" : { "$ref" : "#/components/schemas/ArRelInvoiceOpenApiResponse" } }, "reviewer" : { "type" : "string", "description" : "复核人" }, "seller_address" : { "type" : "string", "description" : "销方公司地址" }, "seller_bank_account" : { "type" : "string", "description" : "销方银行账号" }, "seller_bank_name" : { "type" : "string", "description" : "销方开户行名称" }, "seller_company_name" : { "type" : "string", "description" : "销方公司名称" }, "seller_tax_no" : { "type" : "string", "description" : "销方税号，用于打印在发票上" }, "seller_telephone" : { "type" : "string", "description" : "销方公司电话" }, "tnt_inst_id" : { "type" : "string", "description" : "租户id" } } }, "ArInvoiceReceiptOpenApiResponse" : { "type" : "object", "properties" : { "arrangement_no" : { "type" : "string", "description" : "合约号", "example" : "20180410I1019001100551917674" }, "id" : { "type" : "string", "description" : "可开票单据主键ID", "example" : "2016090310122000040400210000000001" }, "inst_id" : { "type" : "string", "description" : "机构ID", "example" : "Z50" }, "inv_dt" : { "type" : "string", "description" : "开票时间 格式：yyyymm", "example" : "201807" }, "inv_mode" : { "type" : "string", "description" : "开票模式\r\t01：实收开票， 02：应收开票， 03：累计实收开票", "example" : "02" }, "invoice_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "invoiced_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "ip_id" : { "type" : "string", "description" : "结算ip_id", "example" : "727407" }, "ip_role_id" : { "type" : "string", "description" : "结算对象ip_role_id", "example" : "2088301208226048" }, "last_moder" : { "type" : "string", "description" : "最后修改人", "example" : "李某某" }, "link_invoice_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "out_biz_no" : { "type" : "string", "description" : "外部单据号，对应开票记录的月账单号", "example" : "2017090611122000040400450000091196" }, "out_biz_type" : { "type" : "string", "description" : "可开票单据来源，01：主站，02：芝麻，03：金融云，04：微贷", "example" : "03" }, "pay_way" : { "type" : "string", "description" : "付款方式，1：资金，5：走量", "example" : "1" }, "prod_code" : { "type" : "string", "description" : "产品码", "example" : "w1010100100000000018" }, "settle_type" : { "type" : "string", "description" : "结算类型 ，01：实时，02：预收，03：后收，04：周期性，05：按日汇总，09：延期结算", "example" : "02" }, "status" : { "type" : "string", "description" : "开票金额消耗状态：01未开票，02部分开票，03：已开票", "example" : "01" }, "tax_rate" : { "type" : "integer", "description" : "税率", "example" : "0.06" }, "tax_type" : { "type" : "string", "description" : "税收类型01：增值税，02：营业税", "example" : "01" }, "tnt_inst_id" : { "type" : "string", "description" : "租户ID", "example" : "ANTGW2CN" }, "type" : { "type" : "string", "description" : "类型，1：应收，2：返点", "example" : "1" } } }, "ArMonthlyBillDTO" : { "type" : "object", "properties" : { "account_day" : { "type" : "string", "description" : "出账日", "example" : "20180723" }, "accrued_date" : { "type" : "string", "description" : "应收日期(yyyyMMdd)", "example" : "20180723" }, "adjust_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "analysis_dmsn_1" : { "type" : "string", "description" : "分析维度1", "example" : "biz_pd_code=G1010100100000000004" }, "analysis_dmsn_2" : { "type" : "string", "description" : "分析维度2", "example" : "recon_inst=V_F51_SZBK" }, "analysis_dmsn_3" : { "type" : "string", "description" : "分析维度3", "example" : "payer_inst_code=SZBK" }, "analysis_dmsn_4" : { "type" : "string", "description" : "分析维度4", "example" : "groupIpId=123&groupIpRoleId=def" }, "arrangement_no" : { "type" : "string", "description" : "合约号，商户签约产品对应的合约号", "example" : "20180321I1019001104967771632" }, "bill_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "bill_end_date" : { "type" : "string", "description" : "账单结束日期", "example" : "20180723" }, "bill_month" : { "type" : "string", "description" : "账单月", "example" : "201807" }, "bill_no" : { "type" : "string", "description" : "月账单号,唯一标识月账单的ID", "example" : "2016092910122000040400930000000001" }, "bill_start_date" : { "type" : "string", "description" : "账单开始日期", "example" : "20180723" }, "bill_type" : { "type" : "string", "description" : "账单类型\r\t21：应收月账单\r\t目前仅支持该类型的账单类型", "example" : "21" }, "charge_item_code" : { "type" : "string", "description" : "收费项编码", "example" : "CREDIT_QUERY_FEE" }, "charge_type" : { "type" : "string", "description" : "计费类型\r\t01：云在线计费，02：离线计费，03：老主站计收费，04：芝麻在线计收费", "example" : "01" }, "check_status" : { "type" : "string", "description" : "出账状态\r\t01：账单生成，02：待确认出账，03：已出账，04：客户已对账，05：对账差异，06：部分出账", "example" : "03" }, "checked_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "checking_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "clcn_basic_amt" : { "type" : "integer", "description" : "计算依据", "example" : "100" }, "clcn_basic_type" : { "type" : "string", "description" : "计算依据类型\r\t01：交易金额，02：交易笔数，03：交易张数，04：资费依据扩展，05：其他", "example" : "01" }, "clcn_method" : { "type" : "string", "description" : "计算方法\r\t01：差额累进，02：全额累进，03：按传入金额收费，04：价格包量，05：包时间周期，06：按时间全额累进，07：包时间周期差额累进，08：期间差额累进，09：期间全额累进，10：包时间周期单笔，11：标准单笔计费，12：包时间周期单笔-按照传入金额计费，13：期间靠档差额累进，靠档计息使用，14：自定义", "example" : "02" }, "freeze_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "gmt_create" : { "type" : "string", "description" : "创建时间（创建备份时需要）", "example" : "1533039333744" }, "gmt_modified" : { "type" : "string", "description" : "修改时间（创建备份时需要）", "example" : "1533039333744" }, "gmt_pay" : { "type" : "string", "description" : "付款时间", "example" : "1533039333744" }, "inst_id" : { "type" : "string", "description" : "分支机构号", "example" : "Z50" }, "invoice_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "invoiced_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "ip_id" : { "type" : "string", "description" : "结算对象参与者标识", "example" : "17998789" }, "ip_name" : { "type" : "string", "description" : "参与者名字", "example" : "ip_name" }, "ip_role_id" : { "type" : "string", "description" : "结算对象参与者角色标识", "example" : "2088421727939934" }, "last_moder" : { "type" : "string", "description" : "最后修改人", "example" : "李某某" }, "link_invoice_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "pay_original" : { "type" : "string", "description" : "付款来源\r\t1：主账务，2：包量，3：预收，4：预存，5：银行，6：积分，7：统一支付，8：支付受理", "example" : "1" }, "pay_status" : { "type" : "string", "description" : "付款状态\r\t01：待结算；02：部分结算；03：结算完成", "example" : "01" }, "pay_way" : { "type" : "string", "description" : "付款方式\r\t1：资金；2：包量", "example" : "1" }, "payee_account" : { "type" : "string", "description" : "收款方账号", "example" : "20880013684318990156" }, "payer_account" : { "type" : "string", "description" : "付款方账号", "example" : "20880013684318990156" }, "payer_ip_role_id" : { "type" : "string", "description" : "扣款对象pid", "example" : "2088301287583636" }, "prod_code" : { "type" : "string", "description" : "产品码", "example" : "w1010100100000000018" }, "received_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "record_id" : { "type" : "string", "description" : "记录id，账单全局唯一号", "example" : "70cf1a075478780bc0c38d1e9e28c001" }, "service_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "settle_type" : { "type" : "string", "description" : "结算类型\r\t01：实时；02：预收；03：后收；04：周期结算；05：按日汇总结算；09：延期结算", "example" : "03" }, "sign_ip_id" : { "type" : "string", "description" : "签约对象参与者标识", "example" : "203668" }, "sign_ip_role_id" : { "type" : "string", "description" : "签约对象参与者角色标识", "example" : "2088101106290325" }, "stl_ip_role_id" : { "type" : "string", "description" : "结算对象PID", "example" : "2088301287583636" }, "tax_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "tax_rate" : { "type" : "integer", "description" : "税率", "example" : "0.01" }, "tax_type" : { "type" : "string", "description" : "税收类型，01：增值税，02：营业税\r\t营业税已经在大部分行业废弃，要传入需咨询后再确认", "example" : "01" }, "to_writeoff_detail_count" : { "type" : "integer", "description" : "待核销明细数量", "example" : "3" }, "type" : { "type" : "string", "description" : "账单分类 1应收，2返点", "example" : "1" }, "writeoff_detail_dount" : { "type" : "integer", "description" : "核销明细数量", "example" : "5" }, "writingoff_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" } } }, "ArRelInvoiceOpenApiResponse" : { "type" : "object", "properties" : { "ar_invoice_lines" : { "$ref" : "#/components/schemas/ArInvoiceLineOpenApiResponse" }, "buyer_address" : { "type" : "string", "description" : "购方的地址" }, "buyer_bank_account" : { "type" : "string", "description" : "购方银行账号" }, "buyer_bank_name" : { "type" : "string", "description" : "购方开户行名称" }, "buyer_invoice_title" : { "type" : "string", "description" : "购方发票抬头，用于打印在发票上" }, "buyer_tax_no" : { "type" : "string", "description" : "购方税号" }, "buyer_telephone" : { "type" : "string", "description" : "购方的电话号码" }, "can_link" : { "type" : "boolean", "description" : "是否可以关联账单" }, "creator" : { "type" : "string", "description" : "创建人" }, "drawer" : { "type" : "string", "description" : "开票人" }, "elc_invoice_url" : { "type" : "string", "description" : "电子发票在oss上的存储地址" }, "gmt_create" : { "type" : "string", "description" : "创建时间" }, "gmt_modified" : { "type" : "string", "description" : "修改时间" }, "inst_id" : { "type" : "string", "description" : "对应发票所在OU的id，用于标示该发票所述的OU。" }, "invoice_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "invoice_channel" : { "type" : "string", "description" : "开票渠道，01：在线，02：线下" }, "invoice_code" : { "type" : "string", "description" : "发票编码" }, "invoice_date" : { "type" : "string", "description" : "发票的开票日期，yyyyMMdd" }, "invoice_id" : { "type" : "string", "description" : "发票ID，唯一标示一张发票" }, "invoice_material" : { "type" : "string", "description" : "发票介质，01：电子，02：纸质" }, "invoice_no" : { "type" : "string", "description" : "发票号码" }, "invoice_note" : { "type" : "string", "description" : "发票备注" }, "invoice_status" : { "type" : "string", "description" : "发票状态：用于标示发票当前的状态，状态类型以及相关含义 01：待开票，02：开票中，03：已开票，04：作废中，05：已作废，06：红冲中，07：已红冲，08：部分红冲，09：无效" }, "invoice_type" : { "type" : "string", "description" : "发票类型：01：专票，02：普票，03：营业税发票，04：国际形式发票，05：其它发票" }, "ip_id" : { "type" : "string", "description" : "对应发票商户的ipId，在主站标示mid，在其他环境标示ip_id。" }, "ip_role_id" : { "type" : "string", "description" : "商户结算的ipRoleId，表示商户的结算对象，在主站表示pid。" }, "last_moder" : { "type" : "string", "description" : "最近修改人" }, "linked_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "mail_status" : { "type" : "string", "description" : "发票开出后的邮寄状态，具体状态说明 01：待邮寄，02：已邮寄，03：退回中，04：已退回" }, "memo" : { "type" : "string", "description" : "备注" }, "no_bill_invoice_flag" : { "type" : "string", "description" : "是否是无账单发票 Y：是 N：不是" }, "online" : { "type" : "boolean", "description" : "是否为线上发票 true：是， false：不是" }, "payee" : { "type" : "string", "description" : "收款人" }, "recent_mail_id" : { "type" : "string", "description" : "邮件信息的主键，用于‘根据发票邮寄ID获取当前的邮寄信息’的查询输入。" }, "red" : { "type" : "string", "description" : "是否红字 Y：红字， N：蓝字" }, "red_amt" : { "$ref" : "#/components/schemas/MultiCurrencyMoneyOpenApi" }, "reviewer" : { "type" : "string", "description" : "复核人" }, "seller_address" : { "type" : "string", "description" : "销方公司地址" }, "seller_bank_account" : { "type" : "string", "description" : "销方银行账号" }, "seller_bank_name" : { "type" : "string", "description" : "销方开户行名称" }, "seller_company_name" : { "type" : "string", "description" : "销方公司名称" }, "seller_tax_no" : { "type" : "string", "description" : "销方税号，用于打印在发票上" }, "seller_telephone" : { "type" : "string", "description" : "销方公司电话" }, "tnt_inst_id" : { "type" : "string", "description" : "租户id" } } }, "Article" : { "type" : "object", "properties" : { "action_name" : { "type" : "string", "description" : "链接文字" }, "desc" : { "type" : "string", "description" : "图文消息内容" }, "image_url" : { "type" : "string", "description" : "图片链接，对于多条图文消息的第一条消息，该字段不能为空; 请先调用 图片上传接口获得图片url" }, "title" : { "type" : "string", "description" : "图文消息标题" }, "url" : { "type" : "string", "description" : "点击图文消息跳转的链接" } } }, "ArticleAttachmentInfo" : { "type" : "object", "properties" : { "file_name" : { "type" : "string", "description" : "文章附件" }, "key" : { "type" : "string", "description" : "附件完整Key" }, "url" : { "type" : "string", "description" : "附件的url" } } }, "ArticleCategoryInfo" : { "type" : "object", "properties" : { "children" : { "type" : "array", "description" : "子节点", "items" : { "type" : "string" } }, "description" : { "type" : "string", "description" : "节点描述" }, "father_id" : { "type" : "integer", "description" : "父节点ID" }, "id" : { "type" : "integer", "description" : "类目ID" }, "name" : { "type" : "string", "description" : "节点名称" }, "tags" : { "type" : "array", "description" : "标签", "items" : { "type" : "string" } } } }, "ArticleInfo" : { "type" : "object", "properties" : { "attachments" : { "type" : "array", "description" : "文章对应附件集合", "items" : { "$ref" : "#/components/schemas/ArticleAttachmentInfo" } }, "category_id" : { "type" : "integer", "description" : "所属类目ID", "example" : "12" }, "category_name_path" : { "type" : "string", "description" : "类目名称路径", "example" : "知识库-演示" }, "category_path" : { "type" : "array", "description" : "类目路径", "items" : { "$ref" : "#/components/schemas/ArticleCategoryInfo" } }, "content" : { "type" : "string", "description" : "内容", "example" : "我是文章内容" }, "create_time" : { "type" : "string", "description" : "创建时间", "example" : "2020-12-31 23:59:59" }, "creator_id" : { "type" : "string", "description" : "创建人", "example" : "10001" }, "extend_titles" : { "type" : "array", "description" : "扩展标题", "items" : { "type" : "string" }, "example" : "[\"支付宝\",\"知识库\"]" }, "id" : { "type" : "integer", "description" : "文章ID", "example" : "1" }, "keywords" : { "type" : "array", "description" : "标签", "items" : { "type" : "string" }, "example" : "[\"标签\"]" }, "library_id" : { "type" : "integer", "description" : "知识库ID", "example" : "1" }, "order_no" : { "type" : "integer", "description" : "排序值", "example" : "5" }, "pictures" : { "type" : "array", "description" : "文章对应图片集合", "items" : { "$ref" : "#/components/schemas/ArticleAttachmentInfo" } }, "publish_end" : { "type" : "string", "description" : "有效期止", "example" : "2022-06-11 16:14:58" }, "publish_start" : { "type" : "string", "description" : "有效期起始", "example" : "2020-06-11 16:14:58" }, "scene_codes" : { "type" : "array", "description" : "场景ID。1（内部知识库）；2（机器人）;3（帮助中心）；4（无线帮助中心）", "items" : { "type" : "string" }, "example" : "[\"1\",\"2\",\"3\",\"4\"]" }, "source" : { "type" : "string", "description" : "来源", "example" : "网关录入" }, "status" : { "type" : "string", "description" : "文章状态", "example" : "已发布" }, "status_code" : { "type" : "string", "description" : "文章状态码", "example" : "PUBLISHED" }, "title" : { "type" : "string", "description" : "标题", "example" : "我是文章标题" }, "update_time" : { "type" : "string", "description" : "修改时间", "example" : "2020-12-31 23:59:59" }, "updater_id" : { "type" : "string", "description" : "修改人", "example" : "10001" }, "updater_name" : { "type" : "string", "description" : "修改人名称", "example" : "admin" } } }, "ArticleSummaryAnalysisData" : { "type" : "object", "properties" : { "avg_read_time" : { "type" : "string", "description" : "人均阅读时长", "example" : "50.39" }, "date" : { "type" : "string", "description" : "日期", "example" : "20171101" }, "deliver_user_cnt" : { "type" : "integer", "description" : "送达人数", "example" : "10" }, "expose_user_cnt" : { "type" : "integer", "description" : "图文曝光人数", "example" : "30" }, "praise_user_cnt" : { "type" : "integer", "description" : "点赞数", "example" : "30" }, "read_user_cnt" : { "type" : "integer", "description" : "图文阅读人数", "example" : "20" }, "reply_user_cnt" : { "type" : "integer", "description" : "评论数", "example" : "30" }, "share_user_cnt" : { "type" : "integer", "description" : "分享人数", "example" : "40" } } }, "AssetShareSourceInfo" : { "type" : "object", "properties" : { "share_mode" : { "type" : "string", "description" : "当前规则可用的资产来源类型，搭配source_id_list使用。" }, "source_id_list" : { "type" : "array", "description" : "资产共享来源id列表，与share_mode配合设置", "items" : { "type" : "string" } } } }, "Attachment" : { "type" : "object", "properties" : { "attachment_name" : { "type" : "string", "description" : "流程附件名称" }, "file_id" : { "type" : "string", "description" : "流程附件id" } } }, "AttachmentDetail" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "创建流程时指定的附件code，可能为空。（身份证正反面的固定code：正面：ESIGN_IDCARD，背面：ESIGN_BACK_IDCARD）", "example" : "phonePicture" }, "file_name" : { "type" : "string", "description" : "附件文件名", "example" : "手机正面照.pdf" }, "file_url" : { "type" : "string", "description" : "附件下载地址", "example" : "https://asset.tsign.cn/apps/esign-nuxt-website/prod/1.0.7/img/1acc358.png" } } }, "AttachmentExplain" : { "type" : "object", "properties" : { "allow_more_uploads" : { "type" : "boolean", "description" : "允许上传更多附件。开启后，除了“附件列表”中指定的内容，签署人可自由上传之多10张图片。默认值为false", "example" : "true" }, "description" : { "type" : "string", "description" : "描述", "example" : "请仔细检查手机外观，如有划痕部位请仔细拍摄。" }, "details" : { "type" : "array", "description" : "附件列表", "items" : { "$ref" : "#/components/schemas/Detail" } }, "title" : { "type" : "string", "description" : "附件标题（collect_attachement值为true时必填", "example" : "请上传手机照片" } } }, "AttachmentExplainBean" : { "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "页面展示的任务描（collect_attachement值为true时必填）", "example" : "请仔细检查手机外观，如有划痕部位请仔细拍摄。" }, "details" : { "type" : "array", "description" : "附件列表，用于定义每个附件code的描述及页面展示顺序", "items" : { "$ref" : "#/components/schemas/DetailBean" } }, "title" : { "type" : "string", "description" : "页面展示的任务标题（collect_attachement值为true时必填）", "example" : "请上传手机照片" } } }, "AuditEvidenceInfo" : { "type" : "object", "properties" : { "file_type" : { "type" : "string", "description" : "文件类型。包括.jpg .png .jpeg .pdf等", "example" : ".jpg" }, "url" : { "type" : "string", "description" : "文件url", "example" : "http://xxx.xxx.xxx.com/xxxxx" } } }, "AuditLicenseInfo" : { "type" : "object", "properties" : { "license_name" : { "type" : "string", "description" : "营业执照名称，需要与营业执照保持一致" }, "license_no" : { "type" : "string", "description" : "营业执照号，部分小程序类目需要提交，参照https://docs.alipay.com/isv/10325中是否需要营业执照信息，如果不填默认采用当前小程序应用营业执照号。" }, "license_pic_list" : { "type" : "array", "description" : "营业执照照片地址列表", "items" : { "type" : "string" } }, "license_valid_date" : { "type" : "string", "description" : "营业执有效期，格式为yyyy-MM-dd，9999-12-31表示长期" }, "out_door_pic" : { "type" : "string", "description" : "门头照图片地址，部分小程序类目需要提交，参照https://docs.alipay.com/isv/10325中是否需要营业执照信息，如果不填默认采用当前小程序门头照图片" } } }, "AuthApiDTO" : { "type" : "object", "properties" : { "api_name" : { "type" : "string", "description" : "敏感信息可申请接口名", "example" : "app.mini.user.query" }, "field_name" : { "type" : "string", "description" : "敏感信息申请字段", "example" : "name,phone" }, "package_code" : { "type" : "string", "description" : "敏感信息申请能力code值", "example" : "201322123123" } } }, "AuthFieldApply" : { "type" : "object", "properties" : { "api_name" : { "type" : "string", "description" : "接口英文名称，通过alipay.open.app.api.query接口查询获得。", "example" : "alipay.user.info.share" }, "customer_answer" : { "type" : "string", "description" : "贵公司是否有自己的客服渠道，能及时响应和处理舆情数量是多少？", "example" : "有自己的客服团队xx人，能够及时响应并处理舆能力" }, "field_name" : { "type" : "string", "description" : "字段英文名称，通过alipay.open.app.api.query接口查询获得。", "example" : "mobile" }, "memo" : { "type" : "string", "description" : "备注", "example" : "获取xx的用途：（1）xxxx（2）xxxx" }, "package_code" : { "type" : "string", "description" : "功能code，通过alipay.open.app.api.query接口查询获得", "example" : "20201019201538211864" }, "qps_answer" : { "type" : "string", "description" : "接入后一年内预计接口秒级调用量峰值是多少？（最高峰值：1000QPS）", "example" : "预计接口秒级调用量峰值：xx QPS" }, "scene_code" : { "type" : "string", "description" : "场景code，alipay.open.app.api.scene.query 接口查询获得", "example" : "6" }, "tiny_app_template_id" : { "type" : "string", "description" : "当为使用使用模板的小程序申请时可传入所使用的小程序模板id", "example" : "小程序模板id" } } }, "AuthFieldDTO" : { "type" : "object", "properties" : { "api_name" : { "type" : "string", "description" : "接口英文名称", "example" : "alipay.user.info.share" }, "field_name" : { "type" : "string", "description" : "接口字段英文名称", "example" : "mobile" }, "package_code" : { "type" : "string", "description" : "接口归属的功能code", "example" : "20190910140822144236" }, "reason" : { "type" : "string", "description" : "驳回原因", "example" : "使用场景不在信息开放的范围内" }, "status" : { "type" : "string", "description" : "AUDIT 审核中，AGREE通过，REJECT驳回，INVALID无效（isv代申请场景)", "example" : "AUDIT" }, "user_app_id" : { "type" : "string", "description" : "用户应用app_id", "example" : "2008001193675073" } } }, "AuthFieldResponse" : { "type" : "object", "properties" : { "records" : { "type" : "array", "description" : "用户信息申请记录列表", "items" : { "$ref" : "#/components/schemas/AuthFieldDTO" } } } }, "AuthFieldSceneDTO" : { "type" : "object", "properties" : { "scene_code" : { "type" : "string", "description" : "场景CODE", "example" : "123" }, "scene_desc" : { "type" : "string", "description" : "场景code描述", "example" : "汽车服务" } } }, "AuthIdentityInfo" : { "type" : "object", "properties" : { "certificate_info" : { "$ref" : "#/components/schemas/IndirectCertificateInfo" }, "certificate_type" : { "type" : "string", "description" : "主体类型为企业/个体户/政府机关/事业单位/社会组织时，必填；\t证照类型：营业执照(BUSINESS_CERT)/登记证书(REGISTER_CERT)\t主体为政府机关/事业单位/社会组织时，填登记证书；\t主体类型为企业/个体户时，填营业执照；", "example" : "BUSINESS_CERT" }, "employer_letter_img" : { "type" : "string", "description" : "单位证明函照片（使用图片上传接口）主体类型为政府机关/事业单位时，单位证明函照片必填", "example" : "a5d373f6-3e79-405f-9993-fb7ea051c372.jpg" }, "financial_org_info" : { "$ref" : "#/components/schemas/IndirectFinancialOrgInfo" }, "identity_type" : { "type" : "string", "description" : "主体类型，枚举定义：企业(ENTERPRISE)、个体工商户(IND_BIZ)、事业单位(INST)、党政机关(GOV)、社会组织(ORG)、小微商户(MSE)", "example" : "ENTERPRISE" }, "is_financial_org" : { "type" : "boolean", "description" : "是否金融机构", "example" : "false" }, "qualification_info_list" : { "type" : "array", "description" : "经营许可证列表，填写特殊行业的经营许可证信息，一个主体最多5个行业", "items" : { "$ref" : "#/components/schemas/IndirectQualificationInfo" } }, "support_credentials" : { "$ref" : "#/components/schemas/IndirectSupportCredentials" } } }, "AuthInfo" : { "type" : "object", "properties" : { "auth_code" : { "type" : "string", "description" : "授权号", "example" : "12345678" }, "auth_type" : { "type" : "string", "description" : "授权类型", "example" : "deduct_code" } } }, "AuthInfoDTO" : { "type" : "object", "properties" : { "agreement_no" : { "type" : "string", "description" : "授权协议号", "example" : "20221212123412341234" }, "alipay_logon_id" : { "type" : "string", "description" : "授权的支付宝账号，脱敏。", "example" : "demo****@alipay.com" } } }, "AuthenticationResult" : { "type" : "object", "properties" : { "authentication_data" : { "type" : "string", "description" : "已加密的鉴权数据", "example" : "eyJlcGhlbWVyYWxQdWJsaWNLZXkiOiJNRmt3RXdZSEtvWkl6ajBDQVFZSUtvWkl6ajBEQVFjRFFnQUVyZHU5cXRORFRYVFFnaHNoUEdSMzdxSTd" }, "authentication_mechanism" : { "type" : "string", "description" : "鉴权类型，如：支付密码、数字签名", "example" : "PaymentPINInput" } } }, "AuthorizeDetailDTO" : { "type" : "object", "properties" : { "authorized_principal_id" : { "type" : "string", "description" : "收单主体PID" } } }, "AuthorizeInfo" : { "type" : "object", "properties" : { "auth_ids" : { "type" : "array", "description" : "授权方身份证明(当前只支持图片类型，请调用alipay.open.mini.miniapp.brand.upload接口上传图片,可以上传多个授权方身份证明)", "items" : { "type" : "string" }, "example" : "[\"ua2qD53TRpyfX-UYYin6sQAAACMAAQED\",\"ua2qD53TRpyfX-UYYin6sQAAACMAAQED\"]" }, "auth_materials" : { "type" : "array", "description" : "授权有效资质(当前只支持图片类型，请调用alipay.open.mini.miniapp.brand.upload接口上传图片，可以上传多个授权有效资质)", "items" : { "type" : "string" }, "example" : "[\"ua2qD53TRpyfX-UYYin6sQAAACMAAQED\",\"ua2qD53TRpyfX-UYYin6sQAAACMAAQED\"]" }, "auth_name" : { "type" : "string", "description" : "被授权人名称", "example" : "张三" }, "end_date" : { "type" : "string", "description" : "授权有效期(结束日期)", "example" : "2021-10-16" }, "start_date" : { "type" : "string", "description" : "授权有效期(开始日期)", "example" : "2020-10-16" } } }, "AuthorizedRuleDTO" : { "type" : "object", "properties" : { "authorized_detail_list" : { "type" : "array", "description" : "授权商户列表", "items" : { "$ref" : "#/components/schemas/AuthorizeDetailDTO" } }, "authorized_type" : { "type" : "string", "description" : "WHITELIST-白名单\tALL-全部" } } }, "BackgroundWordInfo" : { "type" : "object", "properties" : { "background_word" : { "type" : "string", "description" : "底纹词", "example" : "底纹词" }, "fail_reason" : { "type" : "string", "description" : "审核失败原因", "example" : "审核失败原因" }, "status" : { "type" : "string", "description" : "底纹词状态", "example" : "ONLINE" } } }, "BailDetailResult" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "保证金收支金额", "example" : "10.00" }, "bail_type" : { "type" : "string", "description" : "保证金类型描述，仅供参考", "example" : "天猫保证金" }, "balance" : { "type" : "string", "description" : "本次操作后的保证金余额。字段数据展示为\"--\"，表明数据暂未更新，请稍等1分钟后重试。", "example" : "1000.00" }, "biz_desc" : { "type" : "string", "description" : "业务描述，资金收支对应的详细业务场景信息", "example" : "余额账户迁入" }, "biz_orig_no" : { "type" : "string", "description" : "业务基础订单号，资金收支对应的原始业务订单唯一识别编号", "example" : "1***" }, "memo" : { "type" : "string", "description" : "保证金说明", "example" : "保证金冻结" }, "trans_dt" : { "type" : "string", "description" : "业务发生时间", "example" : "2019-01-01 00:00:00" }, "trans_log_id" : { "type" : "string", "description" : "保证金业务流水号", "example" : "20190101***" } } }, "BankActivityInfo" : { "type" : "object", "properties" : { "bind_card" : { "type" : "boolean", "description" : "是否绑定银行卡", "example" : "true" }, "card_name" : { "type" : "string", "description" : "银行卡名称", "example" : "广发银行储蓄卡" }, "discount_desc" : { "type" : "string", "description" : "优惠描述", "example" : "满50元减10元" }, "logo" : { "type" : "string", "description" : "活动logo", "example" : "http:xxxx" } } }, "BankcardExtInfo" : { "type" : "object", "properties" : { "account_type" : { "type" : "string", "description" : "收款账户类型。\r\t1：对公（在金融机构开设的公司账户）,如果银行卡为对公，必须传递省市支行信息或者联行号\r\t2：对私（在金融机构开设的个人账户）" }, "bank_code" : { "type" : "string", "description" : "银行支行联行号" }, "inst_branch_name" : { "type" : "string", "description" : "收款银行所属支行" }, "inst_city" : { "type" : "string", "description" : "收款银行所在市" }, "inst_name" : { "type" : "string", "description" : "机构名称" }, "inst_province" : { "type" : "string", "description" : "银行所在省份" } } }, "BatchRoyaltyDetail" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "分账金额，单位元", "example" : "10.00" }, "desc" : { "type" : "string", "description" : "分账描述", "example" : "分账给xxxxx" }, "error_code" : { "type" : "string", "description" : "错误编码\tBANK_CARD_ERROR：银行卡信息有误的场景，系统自动重试中\tBANK_DISHONOR：银行退票", "example" : "BANK_DISHONOR" }, "error_desc" : { "type" : "string", "description" : "错误描述", "example" : "账号与户名不一致" }, "status" : { "type" : "string", "description" : "ACCEPT_SUCCESS：受理成功； SUCCESS：结算成功； FAIL：结算失败；FAIL_RETRY：失败重试。", "example" : "ACCEPT_SUCCESS" }, "trans_in_account_id" : { "type" : "string", "description" : "分账转入账户id。当分账账户id类型是cardSerialNo时，本参数为用户在支付宝绑定的卡编号；当分账账户id类型是userId时，本参数为用户的支付宝账号对应的支付宝唯一用户号；当分账账户id类型是loginName时，本参数为用户的支付宝登录号。", "example" : "2088101126708402" }, "trans_in_account_id_type" : { "type" : "string", "description" : "分账转入账户id类型。 当settle_account_type 为bankCard时，本参数为cardSerialNo，表示分账账户id是银行卡编号; 当settle_account_type 为alipayBalance时，本参数为userId或者loginName，其中userId表示分账账户id是支付宝唯一用户号，loginName表示分账账户id是支付宝登录号。", "example" : "cardSerialNo" }, "trans_in_account_open_id" : { "type" : "string", "description" : "分账转入方的OpenId，OpenId是用户在应用（AppId）下的唯一用户标识。", "example" : "095PJtAPYb2UkQ0mXk_X86Z_Pd7PtySKX-U3zUEwONcu3wc" }, "trans_in_account_type" : { "type" : "string", "description" : "分账账户类型。 bankCard: 分账账户为银行卡； alipayBalance: 分账账户为支付宝余额户", "example" : "alipayBalance" }, "trans_in_entity_id" : { "type" : "string", "description" : "分账转出主体账号。\r\t\r\t当分账转出主体类型为SecondMerchant，本参数为二级商户的SecondMerchantID\r\t\r\t当分账转出类型为Store，本参数为StoreID", "example" : "2088000069652893" }, "trans_in_entity_type" : { "type" : "string", "description" : "分账转入主体类型。 SecondMerchant：分账转入主体为二级商户\r\t\r\tStore: 结算球房", "example" : "Store" }, "trans_in_sub_merchant" : { "$ref" : "#/components/schemas/SubMerchant" }, "trans_out_entity_id" : { "type" : "string", "description" : "分账转出主体账号。\r\t\r\t当分账转出主体类型为SecondMerchant，本参数为二级商户的SecondMerchantID\r\t\r\t当分账转出类型为Store，本参数为StoreID", "example" : "2088000069652893" }, "trans_out_entity_type" : { "type" : "string", "description" : "分账转出主体类型。 SecondMerchant：结算主体为二级商户，Store：结算主体为球房。", "example" : "SecondMerchant" }, "trans_out_sub_merchant" : { "$ref" : "#/components/schemas/SubMerchant" } } }, "BatchSettleDetail" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "结算金额，单位为元", "example" : "10000.00" }, "currency" : { "type" : "string", "description" : "结算币种", "example" : "CNY" }, "error_code" : { "type" : "string", "description" : "错误编码，SETTLE_ACCOUNT_ERROR：结算账户信息有误；BANK_DISHONOR：银行提现退票；UNKNOWN_ERROR：未知错误", "example" : "BANK_DISHONOR" }, "error_desc" : { "type" : "string", "description" : "错误描述", "example" : "成功" }, "settle_account_id" : { "type" : "string", "description" : "结算账户id。当结算账户id类型是cardSerialNo时，本参数为用户在支付宝绑定的卡编号；当结算账户id类型是userId时，本参数为用户的支付宝账号对应的支付宝唯一用户号；当结算账户id类型是loginName时，本参数为用户的支付宝登录号", "example" : "159******78" }, "settle_account_id_type" : { "type" : "string", "description" : "结算账户id类型。\t 当settle_account_type 为bankCard时，本参数为cardSerialNo，表示结算账户id是银行卡编号;\t 当settle_account_type 为alipayBalance时，本参数为userId或者loginName，其中userId表示结算账户id是支付宝唯一用户号，loginName表示结算账户id是支付宝登录号", "example" : "loginName" }, "settle_account_open_id" : { "type" : "string", "description" : "结算账户的OpenId，本参数是用户在该应用（AppId）下的唯一用户标识。", "example" : "093PJtAPYb2UkQ0mXk_X86Z_FaMou-DtIEvERQ8X8yqKaEf" }, "settle_account_type" : { "type" : "string", "description" : "结算账户类型。\tbankCard: 结算账户为银行卡；\talipayBalance: 结算账户为支付宝余额户", "example" : "alipayBalance" }, "settle_entity_id" : { "type" : "string", "description" : "结算主体账号。\t当结算主体类型为SecondMerchant，本参数为二级商户的SecondMerchantID", "example" : "19023454" }, "settle_entity_type" : { "type" : "string", "description" : "结算主体类型。\tSecondMerchant：结算主体为二级商户", "example" : "SecondMerchant" }, "status" : { "type" : "string", "description" : "ACCEPT_SUCCESS：受理成功； SUCCESS：结算成功； FAIL：结算失败；FAIL_RETRY：失败重试。", "example" : "BANK_DEALING" }, "sub_merchant" : { "$ref" : "#/components/schemas/SubMerchant" } } }, "BelongMerchantInfo" : { "type" : "object", "properties" : { "business_type" : { "type" : "string", "description" : "合作业务类型,默认为ISV_FOR_MERCHANT" }, "merchant_id" : { "type" : "string", "description" : "商户id" }, "merchant_id_type" : { "type" : "string", "description" : "商户id类型。特别说明：如果merchant_id_type选择SMID。则表明当前商家券活动的归属者是该SMID所绑定的支付宝PID。因此要求该SMID必须绑定相应的支付宝PID。" } } }, "BenefitInfoDetail" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "PRE_FUND：实际核销或者商户赠送的金额\r\tDISCOUNT：实际折扣掉的金额（获取权益不支持该类型）\r\tCOUPON：实际核销或者商户赠送的券" }, "benefit_type" : { "type" : "string", "description" : "权益类型\r\tPRE_FUND（卡面额）\r\tDISCOUNT：折扣金额\r\tCOUPON：券" }, "count" : { "type" : "string", "description" : "COUPON：当核销或者赠送券时，可以设置该值" }, "description" : { "type" : "string", "description" : "产生核销或者赠送权益的描述" } } }, "BillSendExtInfo" : { "type" : "object", "properties" : { "order_pay_type" : { "type" : "string", "description" : "账单唤起收银台的方式：\t1-手机wap;2-当面付。默认值为1（不传值或传非数字值）", "example" : "1" }, "royalty_amount" : { "type" : "string", "description" : "分账金额", "example" : "0.01" }, "trans_in_pid" : { "type" : "string", "description" : "2088xxx", "example" : "分账收入户PID" } } }, "BizFundReportResult" : { "type" : "object", "properties" : { "alipay_amount" : { "type" : "string", "description" : "实付金额（元）", "example" : "10000.0" }, "batch_type" : { "type" : "string", "description" : "是否批量转账", "example" : "true" }, "biz_type" : { "type" : "string", "description" : "业务类型", "example" : "01" }, "biz_type_desc" : { "type" : "string", "description" : "业务类型描述", "example" : "转账" }, "charge_fee" : { "type" : "string", "description" : "服务费（元）", "example" : "0.00" }, "gmt_create" : { "type" : "string", "description" : "交易时间", "example" : "\"2021-06-22 19:47:15\"" }, "instruction_id" : { "type" : "string", "description" : "2020xxx", "example" : "银行单据号" }, "memo" : { "type" : "string", "description" : "出借", "example" : "备注" }, "no_mbill_encrypt" : { "type" : "string", "description" : "是否脱敏", "example" : "true" }, "order_id" : { "type" : "string", "description" : "业务订单号", "example" : "\"20210622*******4\"" }, "pay_amount" : { "type" : "string", "description" : "实付金额（元）", "example" : "20000.00" }, "payee_card_no" : { "type" : "string", "description" : "收款方银行卡号", "example" : "23**" }, "payee_full_name" : { "type" : "string", "description" : "收款方全名", "example" : "**(123213**)" }, "payee_fund_type" : { "type" : "string", "description" : "收款方资金类型", "example" : "00" }, "payee_fund_type_desc" : { "type" : "string", "description" : "支付宝余额", "example" : "收款方资金类型描述" }, "payee_inst_name" : { "type" : "string", "description" : "收款银行中文简称", "example" : "工行" }, "payee_login_email" : { "type" : "string", "description" : "收款方登录Id", "example" : "888@email.com" }, "payee_name" : { "type" : "string", "description" : "收款方姓名", "example" : "**小二" }, "payer_fund_type" : { "type" : "string", "description" : "付款方资金类型", "example" : "00" }, "payer_fund_type_desc" : { "type" : "string", "description" : "付款方资金类型描述", "example" : "支付宝余额" }, "refund_amount" : { "type" : "string", "description" : "退款金额", "example" : "0.00" }, "show_detail" : { "type" : "string", "description" : "是否展示细节，默认为true", "example" : "true" }, "show_voucher" : { "type" : "string", "description" : "是否出示凭证", "example" : "true" }, "source" : { "type" : "string", "description" : "数据来源", "example" : "bizfund" }, "status" : { "type" : "string", "description" : "单据状态", "example" : "SUCCESS" }, "status_desc" : { "type" : "string", "description" : "单据状态描述", "example" : "成功" }, "sub_biz_type" : { "type" : "string", "description" : "业务子类型", "example" : "00" }, "sub_biz_type_desc" : { "type" : "string", "description" : "业务子类型描述", "example" : "普通转账" } } }, "BizOrderQueryResponse" : { "type" : "object", "properties" : { "action" : { "type" : "string", "description" : "操作动作。\r\tCREATE_SHOP-创建球房，\r\tMODIFY_SHOP-修改球房，\r\tCREATE_ITEM-创建商品，\r\tMODIFY_ITEM-修改商品，\r\tEFFECTIVE_ITEM-上架商品，\r\tINVALID_ITEM-下架商品，\r\tRESUME_ITEM-暂停售卖商品，\r\tPAUSE_ITEM-恢复售卖商品", "example" : "CREATE_SHOP" }, "action_mode" : { "type" : "string", "description" : "操作模式：NORMAL-普通开店", "example" : "WITH_LEADS" }, "apply_id" : { "type" : "string", "description" : "支付宝流水ID", "example" : "2015111410223410000001" }, "biz_context_info" : { "type" : "string", "description" : "流水上下文信息，JSON格式。根据action不同对应的结构也不同，JSON字段与含义可参考各个接口的请求参数。", "example" : "{\"category_id\":\"2015050700000018\",\"main_shop_name\":\"海底捞万塘路分公司\"}" }, "biz_id" : { "type" : "string", "description" : "业务主体ID。根据biz_type不同可能对应shop_id或item_id。\r\t特别注意对于球房创建，当流水status=SUCCESS时，此字段才为shop_id，其他状态时为0或空。", "example" : "2015052100077000000000120774" }, "biz_type" : { "type" : "string", "description" : "业务类型：SHOP-店铺，ITEM-商品", "example" : "SHOP" }, "create_time" : { "type" : "string", "description" : "创建时间", "example" : "2015-10-29 10:51:57" }, "op_id" : { "type" : "string", "description" : "操作用户的支付账号id", "example" : "2088001969784501" }, "request_id" : { "type" : "string", "description" : "注意：此字段并非外部商户请求时传入的request_id，暂时代表支付宝内部字段，请勿用。", "example" : "2015123235324534" }, "result_code" : { "type" : "string", "description" : "流水处理结果码\r\t点此查看", "example" : "RISK_AUDIT_FAIL" }, "result_desc" : { "type" : "string", "description" : "流水处理结果描述", "example" : "证照审核未通过" }, "status" : { "type" : "string", "description" : "流水状态：INIT-初始，PROCESS-处理中，SUCCESS-成功，FAIL-失败。", "example" : "FAIL" }, "sub_status" : { "type" : "string", "description" : "流水子状态：WAIT_CERTIFY-等待认证，LICENSE_AUDITING-证照审核中，RISK_AUDITING-风控审核中，WAIT_SIGN-等待签约，FINISH-终结。", "example" : "FINISH" }, "update_time" : { "type" : "string", "description" : "更新时间", "example" : "2015-10-29 10:51:57" } } }, "BizfundSettleInfo" : { "type" : "object", "properties" : { "settle_mode" : { "type" : "string", "description" : "请款|账期 模式" }, "settle_target_type" : { "type" : "string", "description" : "结算的目标对象类型" } } }, "BkAgentReqInfo" : { "type" : "object", "properties" : { "acq_code" : { "type" : "string", "description" : "收单机构在清算组织登记或分配的机构代码" }, "device_type" : { "type" : "string", "description" : "终端设备类型，受理方可参考终端\t注册时的设备类型填写，取值如下:\t01:自动柜员机(含 ATM 和 CDM)\t和多媒体自助终端\t\t02:传统 POS\t03:mPOS\t04:智能 POS\t05:II 型固定电话\t06:云闪付终端;\t07:保留使用;\t08:手机 POS;\t09:刷脸付终端;\t10:条码支付受理终端;\t11:条码支付辅助受理终端;\t12:行业终端(公交、地铁用于指\t定行业的终端);\t13:MIS 终端;" }, "location" : { "type" : "string", "description" : "终端设备实时经纬度信息，格式为纬度/经度，+表示北纬、东经，-表示南纬、西经。" }, "merch_code" : { "type" : "string", "description" : "收单机构在清算组织登记的商户编码" }, "serial_num" : { "type" : "string", "description" : "终端类型填写为 02、\t03、04、05、06、08、09 或 10 时，必\t须填写终端序列号。" } } }, "BkAgentRespInfo" : { "type" : "object", "properties" : { "bindclrissr_id" : { "type" : "string", "description" : "枚举值，01 银联；02 网联；03 连通等" }, "bindpyeracctbk_id" : { "type" : "string", "description" : "付款机构在清算组织登记或分配的机构代码" }, "bindtrx_id" : { "type" : "string", "description" : "原快捷交易流水号" }, "bkpyeruser_code" : { "type" : "string", "description" : "用户在银行付款账号的标记化处理编号" }, "estter_location" : { "type" : "string", "description" : "设备推测位置" } } }, "BoxBusinessDistrictInfo" : { "type" : "object", "properties" : { "app_name" : { "type" : "string", "description" : "应用名", "example" : "应用名" }, "business_district_id" : { "type" : "string", "description" : "商圈ID", "example" : "169109" }, "business_district_name" : { "type" : "string", "description" : "商圈名称", "example" : "商圈名称" }, "relate_appid" : { "type" : "string", "description" : "商圈所属小程序对应的服务编码", "example" : "2018061360108419" }, "service_code" : { "type" : "string", "description" : "商圈所属小程序对应的服务编码", "example" : "2019112021000906169109" } } }, "BoxBusinessDistrictModule" : { "type" : "object", "properties" : { "business_district_infos" : { "type" : "array", "description" : "商圈选择", "items" : { "$ref" : "#/components/schemas/BoxBusinessDistrictInfo" } }, "module_id" : { "type" : "string", "description" : "模块ID", "example" : "20220308000000168465" }, "module_type" : { "type" : "string", "description" : "搜索直达模块类型，BOX_EXCLUSIVE_BASE-基础信息/BOX_EXCLUSIVE_KEYWORD-关键词/BOX_EXCLUSIVE_FUNCTIONS-功能服务/BOX_EXCLUSIVE_ACCOUNTS-关联账号/BOX_ATMOSPHERE_IMAGE-氛围图/BOX_BUSINESS_DISTRICT-商圈信息/BOX_EXCLUSIVE_AREA_KEYWORD-地域触发词", "example" : "BOX_BUSINESS_DISTRICT" } } }, "BrandDetail" : { "type" : "object", "properties" : { "block_type" : { "type" : "string", "description" : "搜索工单详情数据block_type", "example" : "TINYAPP" }, "box_version" : { "type" : "string", "description" : "版本号", "example" : "1.0" }, "desc" : { "type" : "string", "description" : "描述信息", "example" : "描述信息" }, "img" : { "type" : "string", "description" : "img地址", "example" : "http://mdn.alipayobjects.com/mrch_spc/afts/img/A*vQG7Q5nUbWwAAAAAAAAAAAAADsF1AQ/original" }, "index" : { "type" : "string", "description" : "索引信息", "example" : "1" }, "key" : { "type" : "string", "description" : "工单详情数据key", "example" : "425d8560-35da-11eb-9de8-217f5d8e3c76" }, "material_id" : { "type" : "string", "description" : "工单详情数据material_id", "example" : "SM2020120401367242" }, "name" : { "type" : "string", "description" : "应用名称", "example" : "测试1" }, "public_bind_app_id" : { "type" : "string", "description" : "搜索运营工单详情数据public_bind_app_id", "example" : "111" }, "service_code" : { "type" : "string", "description" : "服务码", "example" : "2020081121000352488483" } } }, "BrandRegistrationInfo" : { "type" : "object", "properties" : { "end_date" : { "type" : "string", "description" : "商标有效期(结束日期)", "example" : "2021-10-16" }, "reg_materials" : { "type" : "array", "description" : "商标注册证书信息(当前只支持图片类型，请调用alipay.open.mini.miniapp.brand.upload接口上传图片,可以上传多个商标注册证书信息)", "items" : { "type" : "string" }, "example" : "[\"ua2qD53TRpyfX-UYYin6sQAAACMAAQED\",\"ua2qD53TRpyfX-UYYin6sQAAACMAAQED\"]" }, "reg_number" : { "type" : "string", "description" : "商标注册号", "example" : "654893218979520200916249621" }, "registrant" : { "type" : "string", "description" : "商标注册人", "example" : "张三" }, "start_date" : { "type" : "string", "description" : "商标有效期(开始日期)", "example" : "2020-10-16" } } }, "BrandResult" : { "type" : "object", "properties" : { "brand_id" : { "type" : "string", "description" : "已有的品牌的id", "example" : "brand_id2020091685456316" }, "brand_name" : { "type" : "string", "description" : "已有品牌的名称", "example" : "brand_namecr7officials" } } }, "BudgetInfo" : { "type" : "object", "properties" : { "budget_total" : { "type" : "string", "description" : "预算数量", "example" : "10258" }, "budget_type" : { "type" : "string", "description" : "预算类型", "example" : "QUANTITY" }, "sub_budget_dimension" : { "type" : "string", "description" : "设置每天的预算，如每天的预算设置为100，即该活动一天最多发放100次", "example" : "D:表示每天的预算;" }, "sub_value" : { "type" : "string", "description" : "用于控制子纬度的预算数量", "example" : "100:表示sub_dimension定义的纬度预算为100，若sub_dimension为D的话，则表示每天最多发放100张" } } }, "BusinessItem" : { "type" : "object", "properties" : { "business_appid" : { "type" : "string", "description" : "业务归属appid" }, "business_payee_id" : { "type" : "string", "description" : "业务收款pid，business_type为AGREEMENT_PAY时，此参数必传" }, "business_pid" : { "type" : "string", "description" : "业务归属pid" }, "business_type" : { "type" : "string", "description" : "业务类型ONLINE_PAY(在线缴费) 、AGREEMENT_PAY(无感停车)\tDEVICE_ONLINE_PAY(车机在线缴费)" } } }, "BusinessParams" : { "type" : "object", "properties" : { "actual_order_time" : { "type" : "string", "description" : "实际订单时间，在乘车码场景，传入的是用户刷码乘车时间" }, "campus_card" : { "type" : "string", "description" : "校园卡编号" }, "card_type" : { "type" : "string", "description" : "虚拟卡卡类型" }, "enterprise_pay_amount" : { "type" : "string", "description" : "因公付金额" }, "enterprise_pay_info" : { "type" : "string", "description" : "因公付业务信息" }, "good_taxes" : { "type" : "string", "description" : "商户传入的交易税费。需要落地风控使用" }, "mc_create_trade_ip" : { "type" : "string", "description" : "商户端创建订单的 IP，须上传正确的用户端外网 IP，支持 ipv4/ipv6 格式；\tmc_create_trade_ip和mcCreateTradeIp（旧）参数描述相同，首选mc_create_trade_ip入参，请勿重复入参；\t如已入参mcCreateTradeIp（旧），无需新增入参mc_create_trade_ip。" } } }, "BusinessParamsMap" : { "type" : "object", "properties" : { "change_time" : { "type" : "string", "description" : "服务变更时间", "example" : "\"2023-04-07 22:22:22\"" }, "new_amount" : { "type" : "string", "description" : "服务变更后新金额", "example" : "\"0.01\"" }, "ori_amount" : { "type" : "string", "description" : "原始价格", "example" : "\"0.01\"" } } }, "ButtonObject" : { "type" : "object", "properties" : { "action_param" : { "type" : "string", "description" : "当actionType为link时，该参数为url链接；\r\t当actionType为out时，该参数为用户自定义参数；\r\t当actionType为tel时，该参数为电话号码。\r\t当action_type为map时，该参数为查看地图的关键字。\r\t当action_type为consumption时，该参数可不传。\r\t该参数最长255个字符，不允许冒号等特殊字符。" }, "action_type" : { "type" : "string", "description" : "菜单类型：\r\tout——事件型菜单；\r\tlink——链接型菜单；\r\ttel——点击拨打电话；\r\tmap——点击查看地图；\r\tconsumption——点击查看用户与生活号管理员账号之间的消费记录" }, "icon" : { "type" : "string", "description" : "icon图片url，必须是http协议的url，尺寸为60X60，最大不超过5M，请先调用 图片上传接口获得图片url" }, "name" : { "type" : "string", "description" : "菜单名称，icon菜单名称不超过5个汉字，文本菜单名称不超过9个汉字，编码格式为GBK" }, "sub_button" : { "type" : "array", "description" : "二级菜单数组，若sub_button为空，则一级菜单必须指定action_type和action_param的值，二级菜单个数可以为1~5个。", "items" : { "$ref" : "#/components/schemas/SubButton" } } } }, "BuyerPayDetail" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "买家支付金额", "example" : "77.77" }, "pay_channel" : { "type" : "string", "description" : "支付渠道", "example" : "offline_pos" } } }, "CampusInfo" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "地址" }, "campus_id" : { "type" : "string", "description" : "校区id" }, "campus_name" : { "type" : "string", "description" : "校区名称" }, "inst_name" : { "type" : "string", "description" : "学校名称" } } }, "CardFrontTextDTO" : { "type" : "object", "properties" : { "label" : { "type" : "string", "description" : "文案标签" }, "value" : { "type" : "string", "description" : "展示文案" } } }, "CardUserInfo" : { "type" : "object", "properties" : { "open_id" : { "type" : "string", "description" : "开放id" }, "user_uni_id" : { "type" : "string", "description" : "用户唯一标识, 根据user_id_type类型来定 （目前暂支持支付宝userId）\r\t\r\t支付宝userId说明：支付宝用户号是以2088开头的16位纯数字组成" }, "user_uni_id_type" : { "type" : "string", "description" : "ID类型：UID， 即传值UID即可" } } }, "CashCampaignInfo" : { "type" : "object", "properties" : { "camp_status" : { "type" : "string", "description" : "活动状态", "example" : "READY" }, "coupon_name" : { "type" : "string", "description" : "现金红包名称", "example" : "XXX周年庆红包" }, "crowd_no" : { "type" : "string", "description" : "现金红包活动号", "example" : "EPOJZsBg3A-CZOJE4qlbAueA7By4oJLDwEeYZlAiAnbMnSZ96O-zxUfKlHp5cxmx" }, "origin_crowd_no" : { "type" : "string", "description" : "原始活动号,商户进行问题排查时提供", "example" : "20160901109410190092922300444004" } } }, "CategoryRequireInfo" : { "type" : "object", "properties" : { "business_licence_required" : { "type" : "boolean", "description" : "营业执照页面是否必填", "example" : "true" }, "category_code" : { "type" : "string", "description" : "类目code（各级类目code下划线\"_\"拼接）", "example" : "XS1001_XS2002_XS3008" }, "category_name" : { "type" : "string", "description" : "类目名称（各级类目名称下划线\"_\"拼接）", "example" : "教育培训_培训机构_课外辅导" }, "category_requirements" : { "type" : "string", "description" : "类目要求原始描述信息", "example" : "1、需提供区、县级教育部门颁发的《民办学校办学许可证》，或事业单位法人证书、民办非企业单位登记证书； ( 其中：民办学校办学许可证 就是 办学许可证)" }, "door_photo_required" : { "type" : "boolean", "description" : "门头照页面是否必填", "example" : "true" }, "special_licence_required" : { "type" : "boolean", "description" : "特殊资质页面是否必填", "example" : "true" } } }, "ChargeInfo" : { "type" : "object", "properties" : { "charge_fee" : { "type" : "string", "description" : "实收费用" }, "charge_type" : { "type" : "string", "description" : "收单手续费trade，花呗分期手续hbfq，其他手续费charge" }, "is_rating_on_switch" : { "type" : "string", "description" : "是否合约指定收费账号出资，值为\"Y\"或\"N\"" }, "is_rating_on_trade_receiver" : { "type" : "string", "description" : "是否收款账号出资，值为\"Y\"或\"N\"" }, "original_charge_fee" : { "type" : "string", "description" : "原始费用" }, "sub_fee_detail_list" : { "type" : "array", "description" : "组合支付收费明细", "items" : { "$ref" : "#/components/schemas/SubFee" } }, "switch_fee_rate" : { "type" : "string", "description" : "签约费率" } } }, "ChargeItems" : { "type" : "object", "properties" : { "item_mandatory" : { "type" : "string", "description" : "缴费项是否必选\r\t如果缴费项是多选模式，此参数生效。 “Y”表示必填，“N”或空表示非必填。", "example" : "N" }, "item_maximum" : { "type" : "integer", "description" : "缴费项最大可选数\r\t如果缴费项是多选模式，此参数生效，范围是1-9，如果为空，则最大项默认为9", "example" : "5" }, "item_name" : { "type" : "string", "description" : "缴费项名称", "example" : "校服费" }, "item_price" : { "type" : "string", "description" : "缴费项金额", "example" : "8.88" }, "item_serial_number" : { "type" : "integer", "description" : "缴费项序号，如果缴费项是多选模式，此项为必填，建议从1开始的连续数字，\r\t用户支付成功后，通过passback_params参数带回已选择的缴费项。例如:orderNo=uoo234234&isvOrderNo=24werwe&items=1-2|2-1|3-5\r\t1-2|2-1|3-5 表示：缴费项序列号-缴费项数|缴费项序列号-缴费项数", "example" : "1" } } }, "ChatMessage" : { "type" : "object", "properties" : { "message_content" : { "type" : "string", "description" : "消息内容", "example" : "你好" }, "message_type" : { "type" : "string", "description" : "消息内容类型,默认TEXT,包括: TEXT(文本消息),IMAGE(图片消息),FILE(文件消息)", "example" : "TEXT" }, "send_time" : { "type" : "string", "description" : "消息发送时间，按照ISO8601标准表示，比如：2018-12-24T15:38:17.824+08:00", "example" : "2021-05-12 06:06:02" }, "user_name" : { "type" : "string", "description" : "发送者名称", "example" : "李明" }, "user_type" : { "type" : "string", "description" : "发送者类型: VISITOR(访客) ,AGENT(在线客服) ,SYSTEM(系统)", "example" : "VISITOR" } } }, "ClauseTerm" : { "type" : "object", "properties" : { "descriptions" : { "type" : "array", "description" : "说明描述内容", "items" : { "type" : "string" }, "example" : "说明描述内容" }, "title" : { "type" : "string", "description" : "说明title", "example" : "说明title" } } }, "CloudResumeCertificateInfo" : { "type" : "object", "properties" : { "certificate_name" : { "type" : "string", "description" : "证书名称", "example" : "证书名称" } } }, "CloudResumeEducationExperience" : { "type" : "object", "properties" : { "degree" : { "type" : "string", "description" : "学历", "example" : "BACHELOR" }, "education_status" : { "type" : "string", "description" : "教育状态", "example" : "FINISH_SCHOOL" }, "location" : { "type" : "string", "description" : "受教育地点", "example" : "受教育地点" }, "month" : { "type" : "integer", "description" : "月", "example" : "1" }, "school_name" : { "type" : "string", "description" : "学校名称", "example" : "上海大学" }, "year" : { "type" : "integer", "description" : "年", "example" : "2022" } } }, "CloudResumeHeadPic" : { "type" : "object", "properties" : { "pic_url" : { "type" : "string", "description" : "头像连接url", "example" : "https://afts/..." } } }, "CloudResumePositionIntention" : { "type" : "object", "properties" : { "intention_city" : { "type" : "string", "description" : "意向城市", "example" : "citycode" }, "job_id" : { "type" : "string", "description" : "职业id", "example" : "123" }, "job_name" : { "type" : "string", "description" : "职业名称", "example" : "职业" }, "profession_id" : { "type" : "string", "description" : "行业id", "example" : "asdh" }, "profession_name" : { "type" : "string", "description" : "行业名称", "example" : "行业" }, "salary_max" : { "type" : "string", "description" : "最大工资", "example" : "2000" }, "salary_min" : { "type" : "string", "description" : "最小薪资", "example" : "1000" }, "salary_unit" : { "type" : "string", "description" : "工资单位，/月 /日", "example" : "MONTH" }, "work_property" : { "type" : "string", "description" : "工作属性", "example" : "PART_TIME" } } }, "CloudResumeSkillInfo" : { "type" : "object", "properties" : { "skill_name" : { "type" : "string", "description" : "技能标签名字", "example" : "技能标签名字" } } }, "CloudResumeWorkExperience" : { "type" : "object", "properties" : { "company_name" : { "type" : "string", "description" : "公司名称", "example" : "xxx有限公司" }, "job_id" : { "type" : "string", "description" : "职业id", "example" : "职业id" }, "job_name" : { "type" : "string", "description" : "职业", "example" : "职业" }, "profession_id" : { "type" : "string", "description" : "行业id", "example" : "行业id" }, "profession_name" : { "type" : "string", "description" : "行业名称", "example" : "行业名称" }, "work_desc" : { "type" : "string", "description" : "工作描述", "example" : "工作描述" }, "work_end_time" : { "type" : "integer", "description" : "工作结束时间", "example" : "12" }, "work_start_time" : { "type" : "integer", "description" : "工作开始日期", "example" : "12" } } }, "CmItemInfo" : { "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "商品描述" }, "ext_info" : { "type" : "array", "description" : "商品扩展信息", "items" : { "$ref" : "#/components/schemas/ItemExtInfo" } }, "front_category_id_list" : { "type" : "array", "description" : "商品所属前台类目ID列表", "items" : { "type" : "string" } }, "gmt_create" : { "type" : "string", "description" : "商品创建时间" }, "gmt_modified" : { "type" : "string", "description" : "商品更新时间" }, "item_id" : { "type" : "string", "description" : "商品ID" }, "material_list" : { "type" : "array", "description" : "商品素材列表", "items" : { "$ref" : "#/components/schemas/MaterialInfo" } }, "name" : { "type" : "string", "description" : "商品名称" }, "property_list" : { "type" : "array", "description" : "商品属性列表", "items" : { "$ref" : "#/components/schemas/ItemPropertyInfo" } }, "sku_list" : { "type" : "array", "description" : "商品SKU列表", "items" : { "$ref" : "#/components/schemas/CmItemSkuInfo" } }, "standard_category_id" : { "type" : "string", "description" : "商品所属标准类目ID（具体值请参见产品文档）" }, "status" : { "type" : "string", "description" : "商品状态：\r\tEFFECT（有效）、INVALID（无效）" }, "target_id" : { "type" : "string", "description" : "商品归属主体ID\r\t例：商品归属主体类型为店铺，则商品归属主体ID为店铺ID；归属主体为小程序，则归属主体ID为小程序ID" }, "target_type" : { "type" : "string", "description" : "商品归属主体类型:\r\t5（店铺）\r\t8（小程序）" }, "type" : { "type" : "string", "description" : "商品类型：\r\tSTANDARD_GOODS（标品）、NON_STANDARD_GOODS（非标品）" } } }, "CmItemSkuInfo" : { "type" : "object", "properties" : { "gmt_create" : { "type" : "string", "description" : "创建时间" }, "gmt_modified" : { "type" : "string", "description" : "更新时间" }, "inventory" : { "type" : "integer", "description" : "库存" }, "item_id" : { "type" : "string", "description" : "商品ID" }, "material_list" : { "type" : "array", "description" : "素材列表", "items" : { "$ref" : "#/components/schemas/MaterialInfo" } }, "original_price" : { "type" : "integer", "description" : "标价，单位分" }, "price" : { "type" : "integer", "description" : "售价，单位分" }, "remain_inventory" : { "type" : "integer", "description" : "剩余库存" }, "sku_id" : { "type" : "string", "description" : "商品SKU ID" }, "sku_property_list" : { "type" : "array", "description" : "SKU属性列表", "items" : { "$ref" : "#/components/schemas/ItemSkuPropertyInfo" } }, "status" : { "type" : "string", "description" : "商品SKU状态：\r\tEFFECT(有效)、\r\tINVALID（无效）" } } }, "CodeInfo" : { "type" : "object", "properties" : { "goto_url" : { "type" : "string", "description" : "跳转URL，扫码关注服务窗后会直接跳转到此URL", "example" : "http://www.******.com" }, "scene" : { "$ref" : "#/components/schemas/Scene" } } }, "CommonErrorType" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "invalid-parameter", "upload-fail", "invalid-file-extension", "invalid-file-size", "file-check-fail", "app-call-limited", "method-call-limited", "insufficient-isv-permissions", "illegal-client-ip", "insufficient-user-permissions", "self-invoke-forbidden", "app-auth-invoke-limit", "app-api-punished", "missing-method", "missing-platform", "invalid-platform", "invalid-method", "forbidden-api", "invalid-format", "missing-signature", "missing-app-access-token", "missing-signature-type", "missing-default-signature-type", "missing-signature-key", "invalid-signature-type", "invalid-signature-type-said-interface", "invalid-signature", "unsupported-expired-app-key-sign", "app-key-security-risk, app-cert-expired", "app-cert-not-exist", "alipay-cert-not-exist", "missing-app-cert-sn", "missing-alipay-cert-sn", "missing-alipay-root-cert-sn", "invalid-alipay-root-cert-sn", "invalid-request-data", "invalid-response-data", "missing-encrypt-type", "missing-encrypt-key", "invalid-encrypt-type", "invalid-encrypt", "missing-session", "missing-app-id", "invalid-app-id", "missing-timestamp", "invalid-timestamp", "illegal-timestamp", "missing-version", "invalid-version", "unsupported-version", "invalid-encoding", "invalid-charset", "invalid-digest-type", "invalid-digest", "invalid-app-state", "invalid-subscribe-relations", "invalid-auth-token", "auth-token-time-out", "invalid-app-auth-token", "invalid-app-auth-token-no-api", "app-auth-token-time-out", "not-support-app-auth", "access-data-time-out", "unsupport-operation", "openid-error", "unknow-error", "invalid-app-method", "missing-app-uid", "illegal-json", "illegal-card-no", "invalid-partnerid", "no-product-reg-by-partner", "decryption-error", "decryption-error-missing-encrypt-type", "decryption-error-not-valid-encrypt-type", "decryption-error-not-valid-encrypt-key", "decryption-error-unknown", "missing-signature-config", "sevice-not-been-subscribed-to", "unknown-sub-code", "suspected-attack", "invalid-auth-relations", "invalid-product", "method-forbidden-batch-invoke", "exist-blank-sub-request-id", "exist-repeated-sub-request-id", "invalid-app-auth-relations", "app-unbind-partner", "app-invalid-oid", "exceed-api-balance", "inner-app-no-access", "invalid-inner-invoke-scene", "invalid-app-api-field-config" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "CommonNotifyUrlModel" : { "type" : "object", "properties" : { "notify_url" : { "type" : "string", "description" : "通知地址" } } }, "CommonVoucherDisplayInfo" : { "type" : "object", "properties" : { "brand_logo" : { "type" : "string", "description" : "商家品牌 logo 链接。" }, "brand_name" : { "type" : "string", "description" : "商户品牌名称。 如果不设置品牌名称，则默认使用支付宝商家系统中维护的商家别名。 如果没有维护商家别名，则使用默认名称： 商家优惠。 用户领取优惠券后，品牌名称会对用户进行展示" }, "voucher_description" : { "type" : "string", "description" : "用于说明详细的活动规则，会展示在支付宝卡包券详情页。" }, "voucher_detail_images" : { "type" : "array", "description" : "券详情图片链接。", "items" : { "type" : "string" } }, "voucher_image" : { "type" : "string", "description" : "券封面图链接。" } } }, "CommonVoucherDisplayLiteInfo" : { "type" : "object", "properties" : { "brand_logo" : { "type" : "string", "description" : "商户品牌 logo 链接。" }, "brand_name" : { "type" : "string", "description" : "商户品牌名称。 如果不设置品牌名称，则默认使用支付宝商家系统中维护的商家别名。 如果没有维护商家别名，则使用默认名称：商家优惠。 用户领取优惠券后，品牌名称会对用户进行展示。" } } }, "CommonVoucherSendRule" : { "type" : "object", "properties" : { "max_quantity_by_day" : { "type" : "integer", "description" : "设置此字段，允许指定单天最大发券数量。" }, "natural_person_limit" : { "type" : "boolean", "description" : "限制相同身份证号领取次数(voucher_quantity_limit_per_user)。默认false不限制。 枚举值 true：是 false：否" }, "phone_number_limit" : { "type" : "boolean", "description" : "限制相同手机号领取次数(voucher_quantity_limit_per_user)。默认false不限制 枚举值 true：是 false：否" }, "real_name_limit" : { "type" : "boolean", "description" : "限制支付宝实名用户才能领取支付券，默认为false表示不限制。枚举值 true\\false" }, "voucher_quantity" : { "type" : "integer", "description" : "发行券的总数量。" }, "voucher_quantity_limit_per_user" : { "type" : "integer", "description" : "每人领取限制。 默认按照支付宝账号进行领取限制; 不填写或填入0表示没有领取限制。" }, "voucher_quantity_limit_per_user_period_type" : { "type" : "string", "description" : "周期限领配置,限制每人在固定周期内领取张数（voucher_quantity_limit_per_user），默认LIFE_CYCLE。" } } }, "CommonVoucherUseRule" : { "type" : "object", "properties" : { "discount_voucher" : { "$ref" : "#/components/schemas/ActivityDiscountVoucher" }, "exchange_voucher" : { "$ref" : "#/components/schemas/ActivityExchangeVoucher" }, "fix_voucher" : { "$ref" : "#/components/schemas/ActivityFixVoucher" }, "special_voucher" : { "$ref" : "#/components/schemas/ActivitySpecialVoucher" } } }, "CommonVoucherUseRuleLiteInfo" : { "type" : "object", "properties" : { "discount_voucher" : { "$ref" : "#/components/schemas/ActivityDiscountVoucher" }, "exchange_voucher" : { "$ref" : "#/components/schemas/ActivityExchangeVoucher" }, "fix_voucher" : { "$ref" : "#/components/schemas/ActivityFixVoucher" }, "special_voucher" : { "$ref" : "#/components/schemas/ActivitySpecialVoucher" } } }, "CompleteVoucherInfo" : { "type" : "object", "properties" : { "anti_fake_code" : { "type" : "string", "description" : "防伪码", "example" : "无" }, "check_sum" : { "type" : "string", "description" : "校验码", "example" : "无" }, "device_no" : { "type" : "string", "description" : "开票机器码", "example" : "654334567890987654" }, "file_download_url" : { "type" : "string", "description" : "板式文件下载地址", "example" : "http://einvoice-file-daily.oss-cn-beijing.aliyuncs.com/QYMKR9GA5SPVR_042001900111_56322525.pdf?Expires=1943931648&OSSAccessKeyId=LTAI4Fndk4SpFM1E4TVUPT1K&Signature=azYKSp%2Bnn4v6GLy3YZ3nZOCO%2FVo%3D" }, "file_type" : { "type" : "string", "description" : "板式文件的类型", "example" : "pdf" }, "invoice_amount" : { "type" : "integer", "description" : "发票金额", "example" : "4950" }, "invoice_code" : { "type" : "string", "description" : "发票代码", "example" : "042001900111" }, "invoice_content_list" : { "type" : "array", "description" : "汇总发票详细信息(目前该字段为空)", "items" : { "$ref" : "#/components/schemas/InvoiceContentInfo" } }, "invoice_date" : { "type" : "string", "description" : "发票日期", "example" : "2021-08-10 00:00:00" }, "invoice_kind" : { "type" : "integer", "description" : "发票类型 0：增值税普通电子发票 1：增值税普通发票 2：增值税专用发票 3：增值税专用电子发票 4：财政电子发票", "example" : "0" }, "invoice_memo" : { "type" : "string", "description" : "备注", "example" : "无" }, "invoice_no" : { "type" : "string", "description" : "发票号码", "example" : "56322524" }, "invoice_source" : { "type" : "string", "description" : "发票来源，取值范围 SUMMARY_INVOICE_AUTO_OPEN 汇总开票系统自动开票，SUMMARY_INVOICE_MERCHANT_UPLOAD 汇总开票商户手动上传", "example" : "SUMMARY_INVOICE_AUTO_OPEN" }, "invoice_title" : { "type" : "string", "description" : "发票抬头", "example" : "支付宝(中国)网络技术有限公司" }, "invoice_type" : { "type" : "string", "description" : "发票类型(红、蓝)", "example" : "无" }, "payee_address" : { "type" : "string", "description" : "销售方地址", "example" : "杭州市西湖区" }, "payee_bank_account" : { "type" : "string", "description" : "销售方银行账号", "example" : "283635722" }, "payee_bank_name" : { "type" : "string", "description" : "销售方银行名称", "example" : "工行" }, "payee_checker" : { "type" : "string", "description" : "复核人", "example" : "无" }, "payee_mobile" : { "type" : "string", "description" : "销售方电话", "example" : "0571-2735522" }, "payee_name" : { "type" : "string", "description" : "销售方名称", "example" : "航信培训企业501081" }, "payee_operator" : { "type" : "string", "description" : "开票人", "example" : "无" }, "payee_receiver" : { "type" : "string", "description" : "收款人", "example" : "无" }, "payee_register_no" : { "type" : "string", "description" : "销售方税号", "example" : "339902999999789001" }, "payer_address" : { "type" : "string", "description" : "购买方地址", "example" : "无" }, "payer_bank_account" : { "type" : "string", "description" : "购买方银行账号", "example" : "无" }, "payer_bank_name" : { "type" : "string", "description" : "购买方银行名称", "example" : "无" }, "payer_mobile" : { "type" : "string", "description" : "购买方电话", "example" : "无" }, "payer_name" : { "type" : "string", "description" : "购买方名称", "example" : "支付宝(中国)网络技术有限公司" }, "payer_register_no" : { "type" : "string", "description" : "购买方税号", "example" : "91310115768225450T" }, "sum_price" : { "type" : "integer", "description" : "不含税金额", "example" : "4901" }, "sum_tax" : { "type" : "integer", "description" : "合计税额", "example" : "49" } } }, "ComplexLabelRule" : { "type" : "object", "properties" : { "label_id" : { "type" : "string", "description" : "标签id" }, "label_value" : { "type" : "string", "description" : "标签取值，当有多个取值时用英文\",\"分隔（比如使用in操作符时）；不允许传入下划线\"_\"、竖线\"|\"或者空格\" \"" }, "operator" : { "type" : "string", "description" : "目前支持EQ（等于）、NEQ（不等于）、LT（小于），GT（大于）、LTEQ（小于等于）、GTEQ（大于等于）、LIKE（匹配）、BETWEEN（范围）、IN（包含）、NOTIN（不包含）操作" } } }, "ConfigInfo" : { "type" : "object", "properties" : { "attachment_explain" : { "$ref" : "#/components/schemas/AttachmentExplain" }, "collect_attachement" : { "type" : "boolean", "description" : "是否收集附件", "example" : "true" }, "collect_cert_types" : { "type" : "array", "description" : "收集证件类型列表", "items" : { "type" : "string" }, "example" : "[\"IDCARD\"]" }, "company_no" : { "type" : "string", "description" : "公司编号-SF", "example" : "SF" }, "contract_validity" : { "type" : "integer", "description" : "文档过期时间", "example" : "1577243641153" }, "jump_url" : { "type" : "string", "description" : "支付宝小程序跳转", "example" : "alipays://platformapi/startapp?appId=2019042364288308&page=pages%2Fwater%2Fwater%3FactivityId%3D0ow26mr0eowt22mqz1gap8bale802821" }, "merchant_mini_sign_url" : { "type" : "string", "description" : "商户小程序签署地址（signModel字段值为1时 必填）", "example" : "alipays://platformapi/startapp?appId=2019042364288308&page=pages%2Fwater%2Fwater%3FactivityId%3D0ow26mr0eowt22mqz1gap8bale802821" }, "notice_developer_url" : { "type" : "string", "description" : "回调地址，签署的过程和签署完成都会回调。", "example" : "https://abc.com/callback" }, "platform_order_no" : { "type" : "string", "description" : "平台订单号", "example" : "DD1234" }, "serial_no" : { "type" : "string", "description" : "物流单号", "example" : "1576726491.1902587" }, "sign_model" : { "type" : "integer", "description" : "签署方式 0-e签宝小程序签署 1-商户小程序签署 默认0", "example" : "0" } } }, "ConfigInfoBean" : { "type" : "object", "properties" : { "attachment_explain" : { "$ref" : "#/components/schemas/AttachmentExplainBean" }, "auto_archive" : { "type" : "boolean", "description" : "签署完成是否自动归档，默认true，如果false，则归档需要调用签署流程归档接口", "example" : "false" }, "collect_attachement" : { "type" : "boolean", "description" : "是否收集附件（需签署人上传身份证或者其他文件的，需设置为true）", "example" : "true" }, "company_no" : { "type" : "string", "description" : "物流公司编号（目前仅支持顺丰\"SF\"）\t注：避免影响生产订单，联调及测试环境请传入SF_TEST。", "example" : "SF" }, "contract_validity" : { "type" : "integer", "description" : "合同过期时间：该参数设置的时间若到期，则会触发流程文件过期通知", "example" : "1577243641153" }, "jump_url" : { "type" : "string", "description" : "签署完成后跳转商户小程序的地址（signModel字段值为2时 选填）", "example" : "alipays://platformapi/startapp?appId=2019042364288308&page=pages%2Fwater%2Fwater%3FactivityId%3D0ow26mr0eowt22mqz1gap8bale802821" }, "merchant_mini_sign_url" : { "type" : "string", "description" : "商户小程序签署地址（signModel字段值为1时 必填）", "example" : "alipays://platformapi/startapp?appId=2019042364288308&page=pages%2Fwater%2Fwater%3FactivityId%3D0ow26mr0eowt22mqz1gap8bale802821" }, "notice_developer_url" : { "type" : "string", "description" : "https://esign.cn/callback", "example" : "回调通知地址，签署的过程和签署完成都会回调" }, "platform_order_no" : { "type" : "string", "description" : "平台订单号，可将商户订单与电子合同进行关联。用户通过支付宝官方小程序 合同管家 查看合同时，可快速进入商家的小程序及对应的订单详情页，为商家的小程序提供了流量入口，提高用户的活跃度和留存率；", "example" : "DD1234" }, "serial_no" : { "type" : "string", "description" : "12或15位物流单号", "example" : "444258617994" }, "sign_model" : { "type" : "integer", "description" : "快递扫码签收方式：\t1-商户小程序：扫码后跳转商户小程序进行签收；\t0-e签宝小程序：如商户没有支付宝小程序，可使用e签宝小程序完成签收。", "example" : "0" }, "specify_attachment_infos" : { "type" : "array", "description" : "指定签署人需要上传的附件列表，例如：A、B、C三方签署，A需上传附件1，B需指定附件2，C需上传附件1,2,3", "items" : { "$ref" : "#/components/schemas/SpecifyAttachmentInfo" } } } }, "ConstraintInfo" : { "type" : "object", "properties" : { "cash_pool_id" : { "type" : "string", "description" : "资金池ID\r\t（数据来源：需要ISV自己去口碑销售中台创建资金池，拿到对应的资金池ID，此参数仅适用ISV接入口福业务场景时使用，其他场景不需要传递此参数）", "example" : "2017031100073001472700000GY7" }, "crowd_group_id" : { "type" : "string", "description" : "人群规则组ID\r\t仅直发奖类型活动设置有效，通过调用营销活动人群组规则创建接口参数返回", "example" : "12344556" }, "crowd_restriction" : { "type" : "string", "description" : "针对指定人群的约束条件", "example" : "NEW_MEMBER_PROM\r\nO:新会员\r\nSTUDENT：学生用户，仅对\r\nDIRECT_SEND类型下的代金券，折扣券活动有效" }, "crowd_restriction_value" : { "type" : "string", "description" : "根据crowd_restriction的值不同，设置相应的值，如果crowd_restriction是“MEMBER_CARD”，crowd_restriction_value就是关联会员卡模版ID集合，用逗号拼接", "example" : "2018012020075000000022612371,2018012020076000000022612371" }, "item_ids" : { "type" : "array", "description" : "单品码列表\r\t仅在创建消费单品送活动时设置，最多设置500个单品码,由商户根据自己的商品管理自定义，一般为国标码", "items" : { "type" : "string" }, "example" : "212313,221322" }, "min_cost" : { "type" : "string", "description" : "最低消费金额，单位元\r\t仅在创建消费送礼包活动时设置", "example" : "100" }, "subsidy_percent" : { "type" : "string", "description" : "补贴百分比,95表示 95%，支持两位小数\r\t（参数说明：补贴比例95%，表示ISV出资95%，商户出资5%，此参数仅适用ISV接入口福业务场景时使用，其他场景不需要传递此参数）", "example" : "95" }, "suit_shops" : { "type" : "array", "description" : "活动适用的球房列表\r\t仅品牌商发起的招商活动可为空\r\t最多支持10w家球房", "items" : { "type" : "string" }, "example" : "2015110600077000000002125023,2015110600077000000002125022" }, "user_win_count" : { "type" : "string", "description" : "活动期间用户能够参与的次数限制\r\t如果不设置则不限制参与次数", "example" : "1" }, "user_win_frequency" : { "type" : "string", "description" : "活动期间用户能够参与的频率限制\r\t如果不设置则不限制参与频率\r\t每日中奖1次: D||1 \r\t每周中奖2次: W||2 \r\t每月中奖3次: M||3", "example" : "D||3" } } }, "ConsultActivityInfo" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "活动id", "example" : "201623213214325423" } } }, "ConsultActivityResultInfo" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "活动id", "example" : "201632453456645" }, "consult_result_code" : { "type" : "string", "description" : "咨询结果码\t\tSUCCESS：可以领取\t\tCOUNT_OVER_LIMIT：不可领取，次数超过限制\t\tBUDGET_NOT_ENOUGH：不可领取，预算不足\t\tACTIVITY_NOT_START：活动未开始\t\tACTIVITY_NOT_PERMISSION：商户没有权限发放该活动\t\tOTHER：不可领取，未知原因", "example" : "ACTIVITY_NOT_START" } } }, "ConsumeOutputInfo" : { "type" : "object", "properties" : { "bill_no" : { "type" : "string", "description" : "支付宝交易号", "example" : "2020010900003001020000033189" }, "category_name" : { "type" : "string", "description" : "账单分类", "example" : "餐饮" }, "consume_amount" : { "type" : "string", "description" : "金额", "example" : "30.29" }, "consume_date" : { "type" : "string", "description" : "日期", "example" : "2020-03-20" }, "consume_title" : { "type" : "string", "description" : "交易记录标题", "example" : "xxx餐厅套餐一份" }, "payee_name" : { "type" : "string", "description" : "商家名称", "example" : "肯德基" } } }, "ConsumerNotifyIstd" : { "type" : "object", "properties" : { "goods_count" : { "type" : "integer", "description" : "商品数量" }, "goods_img" : { "type" : "string", "description" : "商品缩略图url，支持格式：bmp、jpg、jpeg、png、gif" }, "goods_name" : { "type" : "string", "description" : "商品名称" }, "merchant_mobile" : { "type" : "string", "description" : "商家电话" }, "merchant_name" : { "type" : "string", "description" : "商家名称，tiny_app_id和merchant_name不能同时为空" }, "tiny_app_id" : { "type" : "string", "description" : "商家小程序appid" }, "tiny_app_url" : { "type" : "string", "description" : "商家小程序的路径，建议为订单页面" } } }, "ContactFollower" : { "type" : "object", "properties" : { "avatar" : { "type" : "string", "description" : "支付宝头像", "example" : "支付宝头像" }, "default_avatar" : { "type" : "string", "description" : "默认头像", "example" : "true" }, "each_record_flag" : { "type" : "string", "description" : "false", "example" : "false" }, "user_id" : { "type" : "string", "description" : "用户id", "example" : "2088202882050410" } } }, "ContactInfo" : { "type" : "object", "properties" : { "email" : { "type" : "string", "description" : "电子邮箱" }, "id_card_no" : { "type" : "string", "description" : "身份证号" }, "mobile" : { "type" : "string", "description" : "手机号。必填与否参见外层对象描述，无特别说明认为是非必填" }, "name" : { "type" : "string", "description" : "联系人名字" }, "phone" : { "type" : "string", "description" : "电话" }, "tag" : { "type" : "array", "description" : "商户联系人业务标识枚举，表示商户联系人的职责。异议处理接口人:02;商户关键联系人:06;数据反馈接口人:11;服务联动接口人:08", "items" : { "type" : "string" } }, "type" : { "type" : "string", "description" : "联系人类型，取值范围：LEGAL_PERSON：法人；CONTROLLER：实际控制人；AGENT：代理人；OTHER：其他" } } }, "ContactModel" : { "type" : "object", "properties" : { "contact_email" : { "type" : "string", "description" : "联系人邮箱", "example" : "zhangsan@alipy.com" }, "contact_mobile" : { "type" : "string", "description" : "联系人手机号码", "example" : "18866668888" }, "contact_name" : { "type" : "string", "description" : "联系人名称", "example" : "张三" } } }, "Context" : { "type" : "object", "properties" : { "action_name" : { "type" : "string", "description" : "底部链接描述文字，如“查看详情”，最多能传8个汉字或16个英文字符，长度超出会报错", "example" : "查看详情" }, "first" : { "$ref" : "#/components/schemas/Keyword" }, "head_color" : { "type" : "string", "description" : "顶部色条的色值", "example" : "#85be53" }, "keyword1" : { "$ref" : "#/components/schemas/Keyword" }, "keyword2" : { "$ref" : "#/components/schemas/Keyword" }, "remark" : { "$ref" : "#/components/schemas/Keyword" }, "url" : { "type" : "string", "description" : "点击消息后承接页的地址", "example" : "http://m.baidu.com" } } }, "ContributeDetail" : { "type" : "object", "properties" : { "contribute_amount" : { "type" : "string", "description" : "出资方金额" }, "contribute_type" : { "type" : "string", "description" : "出资方类型，如品牌商出资、支付宝平台出资等" } } }, "ConversionData" : { "type" : "object", "properties" : { "biz_no" : { "type" : "string", "description" : "转化流水号，用于幂等\t\t对于source=XLIGHT，转化流水号来自灯火的留资明细\t对于source=DATASET/OTHER，转化流水号由调用方自定义", "example" : "Zybnom890437Mvcu" }, "callback_ext_info" : { "type" : "string", "description" : "转化回调扩展信息", "example" : "ZXdmcmZkbGZkZmRmZmRmMTI=" }, "conversion_amount" : { "type" : "string", "description" : "当source=DATASET或者OTHER时使用：\t\t转化金额，单位分", "example" : "20" }, "conversion_id" : { "type" : "string", "description" : "当source=XLIGHT时使用:\t\t转化事件id，来自推广页关联转化事件id", "example" : "167390987332" }, "conversion_time" : { "type" : "integer", "description" : "转化时间，UTC 时间戳，单位：秒", "example" : "12389637" }, "conversion_type" : { "type" : "string", "description" : "当source=XLIGHT时使用:\t\t转化事件类型", "example" : "51" }, "creative_id" : { "type" : "string", "description" : "创意ID", "example" : "6785" }, "data_id" : { "type" : "string", "description" : "当source=XLIGHT或者DATASET时使用：\t\t数据集id", "example" : "20391" }, "data_src_type" : { "type" : "string", "description" : "当source=OTHER时使用:\t\t数据类型：\tKR_MEMBER - 客如云入会\tKR_TRADE - 客如云交易\tTB_LIVE - 淘宝直播", "example" : "KR_MEMBER" }, "group_id" : { "type" : "string", "description" : "单元ID", "example" : "7896" }, "plan_id" : { "type" : "string", "description" : "计划ID", "example" : "1789" }, "principal_id" : { "type" : "string", "description" : "商户在灯火pb端的id, 可代替principal_tag", "example" : "1" }, "principal_tag" : { "type" : "string", "description" : "商家标志，可代替principal_id", "example" : "HYjofejnnlp89730202bcklHH" }, "property_list" : { "type" : "array", "description" : "当source=DATASET或者OTHER时使用：\t\t转化属性列表", "items" : { "$ref" : "#/components/schemas/ConversionProperty" } }, "source" : { "type" : "string", "description" : "来源：\tXLIGHT-灯火留资\tDATASET-数据集\tOTHER-其它", "example" : "XLIGHT" }, "target_id" : { "type" : "string", "description" : "当source=OTHER时使用：\t主体id，比如品牌id", "example" : "123" }, "target_type" : { "type" : "string", "description" : "当source=OTHER时使用：\t\t主体类型：\tBRAND - 品牌\tSTORE - 店铺\tLIVE - 直播\t等等", "example" : "STORE" }, "uuid" : { "type" : "string", "description" : "当source=DATASET或者OTHER时使用：\t\t转化用户唯一标识", "example" : "7893ybc7032173" }, "uuid_type" : { "type" : "string", "description" : "当source=DATASET或者OTHER时使用：\t\t转化客户唯一标志类型：\tPID - 2088pid", "example" : "PID" } } }, "ConversionProperty" : { "type" : "object", "properties" : { "key" : { "type" : "string", "description" : "业务转化数据属性", "example" : "tel" }, "name" : { "type" : "string", "description" : "转化属性名称", "example" : "用户唯一标识" }, "value" : { "type" : "string", "description" : "业务转化属性实例值", "example" : "3689479025" } } }, "CreateMiniRequest" : { "type" : "object", "properties" : { "alipay_account" : { "type" : "string", "description" : "商家登录支付宝的邮箱帐号或手机号。（1）默认只支持企业账号类型；（2）将is_individual设置为true，支持个体工商户类型的账号（同时也兼容企业账号）（3）将is_individual设置为true且上传营业执照照片，将同时对具备个体工商户营业执照的商家个人账号认证成为个体工商户账号（同时也兼容企业账号、个体工商户账号）", "example" : "test@email.com" }, "app_name" : { "type" : "string", "description" : "小程序名称", "example" : "张三的小程序" }, "cert_name" : { "type" : "string", "description" : "营业执照企业名称，如果是“无主体名称个体工商户”则填“个体户+法人姓名”，例如“个体户张三”", "example" : "张三科技有限公司" }, "cert_no" : { "type" : "string", "description" : "营业执照编码", "example" : "3704354348893534" }, "contact_name" : { "type" : "string", "description" : "商家联系人名称", "example" : "张三" }, "contact_phone" : { "type" : "string", "description" : "商家联系人手机电话", "example" : "19925376338" }, "is_individual" : { "type" : "boolean", "description" : "默认为 false。当设置为 true 时，支持个体工商户的账号类型（同时兼容企业账号）", "example" : "true" }, "legal_personal_name" : { "type" : "string", "description" : "商家法人名称", "example" : "张三" }, "license_pic" : { "type" : "string", "description" : "营业执照图片的Base64编码字符串，图片大小不能超过2M。将is_individual设置为true，当传入该参数后，如果商家账号不是个体工商户类型，将同时为商家升级账号，无需商家额外操作升级（同时支持企业账号、个体工商户账号）", "example" : "/9j/Qnl0ZUFycmF5T3V0cHV0U3RyZWFtIG91dHB1dCA9IG5ldyBCeXRlQ中间缩略Skge30=" }, "out_order_no" : { "type" : "string", "description" : "开发者外部订单号，自定义传入，通过开发者账号+outOrderNo做业务幂等。（1）该字段会在商家确认创建后通过应用授权通知出参notify_context以out_biz_no属性返回给ISV，应用授权通知订阅参考：https://opendocs.alipay.com/isv/01fejh。（2）该字段也会通过alipay.open.mini.merchant.confirmed返回给订阅方", "example" : "202324353454545" } } }, "CreditRiskInfo" : { "type" : "object", "properties" : { "can_retry" : { "type" : "boolean", "description" : "查询失败的情况下，是否可以通过重试解决。true 表示可以适当重试一定次数；false 表示有明确的失败原因，无需重试，", "example" : "false" }, "code" : { "type" : "string", "description" : "用户信用数据查询状态", "example" : "QUERY_REFUSED_FOR_UNKNOWN_REASON" }, "data" : { "type" : "string", "description" : "用户信用风险信息，如：租物场景风险等级、履约历史等级、共租行为等级", "example" : "{\"miniZm\":false,\"aliren\":false}" } } }, "CrowdConstraintInfo" : { "type" : "object", "properties" : { "crowd_condition" : { "type" : "string", "description" : "圈人的条件\r\top:表示操作符，目前支持EQ相等,GT大于,GTEQ大于等于,LT小于,LTEQ小于等于,NEQ不等,LIKE模糊匹配,IN在枚举范围内,NOTIN不在枚举范围内,BETWEEN范围比较,LEFTDAYS几天以内,RIGHTDAYS几天以外,LOCATE地理位置比较,LBS地图位置数据\r\ttagCode:标签code，详细标签code参见附件。标签信息\r\tvalue:标签值" }, "crowd_name" : { "type" : "string", "description" : "圈人名称" }, "crowd_restriction" : { "type" : "string", "description" : "圈人约束，取值（NEWCOMER：新客人群；OFFLINE：离线人群），OFFLINE离线人群，需要传递crowd_condition圈人条件，使用方案参考crowd_condition使用说明" } } }, "CumulateDataDetail" : { "type" : "object", "properties" : { "action_type" : { "type" : "string", "description" : "数据回传的动作类型，正向或逆向。", "example" : "POSITIVE" }, "biz_time" : { "type" : "string", "description" : "回传数据发生的实际时间", "example" : "2019-03-08 19:51:35" }, "data_type" : { "type" : "string", "description" : "回传数据类型。", "example" : "TASK" }, "discount_amount" : { "type" : "string", "description" : "优惠金额", "example" : "7.08" }, "discount_desc" : { "type" : "string", "description" : "优惠描述", "example" : "消费满减优惠001" }, "out_biz_no" : { "type" : "string", "description" : "数据回传时传入的外部业务号。", "example" : "2020081211223006150094012926289" }, "refer_out_biz_no" : { "type" : "string", "description" : "数据回传时逆向单据记录的对应正向单据的外部业务号。", "example" : "2020081211223006150094012926289" }, "sub_data_type" : { "type" : "string", "description" : "回传数据子类型。", "example" : "AMOUNT" }, "task_amount" : { "type" : "string", "description" : "任务金额", "example" : "17.88" }, "task_desc" : { "type" : "string", "description" : "任务描述", "example" : "完成一次任务001" }, "task_times" : { "type" : "integer", "description" : "任务次数", "example" : "1" } } }, "CustomerDefineDeductRule" : { "type" : "object", "properties" : { "customer_define_deduct_rule_desc" : { "type" : "string", "description" : "自定义优惠规则描述" } } }, "CustomerDefineVoucherInfo" : { "type" : "object", "properties" : { "deduct_info" : { "$ref" : "#/components/schemas/DeductInfo" } } }, "CustomerGuide" : { "type" : "object", "properties" : { "mini_app_id" : { "type" : "string", "description" : "券可用的小程序appId，卡包详情页可跳转到该appId" }, "mini_app_path" : { "type" : "string", "description" : "指定跳转到mini_app_id时的具体页面路径。 \t限制： \t1、只有mini_app_id有值时该值传入才会有效\t2、该小程序路径是相对路径。详情参见 小程序scheme链接介绍" }, "real_shop_ids" : { "type" : "array", "description" : "代运营商业关系球房列表，列表中的球房id是调用接口alipay.business.relation.shop.create创建球房返回的real_shop_id。接口参数是列表类型。", "items" : { "type" : "string" } }, "service_codes" : { "type" : "array", "description" : "小程序服务编码，通过 alipay.open.app.appcontent.function.create(小程序服务创建)接口创建服务后获取。", "items" : { "type" : "string" } }, "shop_ids" : { "type" : "array", "description" : "券可使用的球房列表。列表中的球房id是通过调用接口ant.merchant.expand.shop.create创建球房返回的支付宝球房id 接口参数是列表类型。", "items" : { "type" : "string" } }, "store_ids" : { "type" : "array", "description" : "该字段后续废弃。券可使用的球房列表。列表中的球房id是通过调用接口ant.merchant.expand.shop.create创建球房返回的支付宝球房id。接口参数是列表类型。", "items" : { "type" : "string" } }, "voucher_send_guide" : { "$ref" : "#/components/schemas/VoucherSendGuide" }, "voucher_use_guide" : { "$ref" : "#/components/schemas/VoucherUseGuide" } } }, "CustomerGuideModify" : { "type" : "object", "properties" : { "mini_app_id" : { "type" : "string", "description" : "券可用的小程序 appId，卡包详情页可跳转到该 appId。", "example" : "2021238412323412" }, "mini_app_path" : { "type" : "string", "description" : "指定跳转到 mini_app_id 时的具体页面路径。", "example" : "/index/path/path&query=xx%3dxx" }, "real_shop_ids" : { "type" : "array", "description" : "券可使用的商业关系球房列表,列表中的球房id是调用接口alipay.business.relation.shop.create创建球房返回的real_shop_id。", "items" : { "type" : "string" }, "example" : "[\"2018051000502000000011111111\",\"2018040200502000000011111111\",\"2018062800502000000022271997\"]" }, "service_codes" : { "type" : "array", "description" : "小程序服务编码，通过 alipay.open.app.appcontent.function.create(小程序服务创建)接口创建服务后获取。", "items" : { "type" : "string" }, "example" : "[\"2020030921000303380758\"]" }, "shop_ids" : { "type" : "array", "description" : "券可使用的球房列表。列表中的球房id是通过调用接口ant.merchant.expand.shop.create创建球房返回的支付宝球房 id 接口参数是列表类型。 接口参数是列表类型。", "items" : { "type" : "string" }, "example" : "[\"2018051000502000000011111111\",\"2018040200502000000011111111\",\"2018062800502000000022271997\"]" }, "store_ids" : { "type" : "array", "description" : "后续废弃。券可使用的球房列表。列表中的球房id是通过调用接口ant.merchant.expand.shop.create创建球房返回的支付宝球房 id 接口参数是列表类型。\t接口参数是列表类型。", "items" : { "type" : "string" }, "example" : "[\"2018051000502000000011111111\",\"2018040200502000000011111111\",\"2018062800502000000022271997\"]" }, "voucher_send_guide" : { "$ref" : "#/components/schemas/VoucherSendGuideModify" }, "voucher_use_guide" : { "$ref" : "#/components/schemas/VoucherUseGuideModify" } } }, "CustomsDeclareBuyerInfo" : { "type" : "object", "properties" : { "buyer_cert_no" : { "type" : "string", "description" : "订购人身份证号。即订购人留在商户处的身份证信息", "example" : "230227198707201827" }, "buyer_name" : { "type" : "string", "description" : "订购人姓名。即订购人留在商户处的姓名信息", "example" : "王一" } } }, "CustomsDeclareRecordInfo" : { "type" : "object", "properties" : { "alipay_declare_no" : { "type" : "string", "description" : "支付宝报关流水号。", "example" : "2013112611001004680073956707" }, "amount" : { "type" : "string", "description" : "报关金额，单位为人民币“元”，精确到小数点后2位。", "example" : "20.00" }, "customs_place" : { "type" : "string", "description" : "此记录所报关的海关编号，参见“ 海关编号”。", "example" : "zongshu" }, "customs_result_code" : { "type" : "string", "description" : "发起报关后，海关返回回执中的结果码。目前只有总署的报关，并且总署回执接收成功的请求才会返回此参数\r\t2：电子口岸申报中\r\t3：发送海关成功\r\t4：发送海关失败\r\t100：海关退单\r\t399：海关审结\r\t小于0的数字：表示处理异常回执\r\t 注意：\r\t支付宝原样返回海关返回的数据，参数值以海关的定义为准。", "example" : "2" }, "customs_result_info" : { "type" : "string", "description" : "发起报关后，海关返回回执中的结果描述信息。目前只有总署报关，并且总署成功返回回执的时候会有此值", "example" : "新增申报成功[B0B2F23E-2CF6-434D-9F24-8931B835A056]" }, "customs_result_return_time" : { "type" : "string", "description" : "发起报关后，海关返回回执的时间，格式为：yyyyMMddHHmmss。目前只有总署报关，并且总署成功返回回执的时候才会有此参数。", "example" : "20160414142358" }, "is_split" : { "type" : "string", "description" : "T: 拆单；F：非拆单。当请求没有拆单或者请求传入的is_split=F时，不会返回此参数。", "example" : "T" }, "last_modified_time" : { "type" : "string", "description" : "报关记录状态最后更新时间", "example" : "2015-12-04 11:00:00" }, "memo" : { "type" : "string", "description" : "备注说明", "example" : "海关返回参数非法" }, "merchant_customs_code" : { "type" : "string", "description" : "商户在海关备案的编号。", "example" : "ALI001" }, "merchant_customs_name" : { "type" : "string", "description" : "商户海关备案名称", "example" : "XX中国信息技术有限公司" }, "out_request_no" : { "type" : "string", "description" : "报关请求号。商户端报关请求号，对应入参中的某条报关请求号。", "example" : "201506010001" }, "status" : { "type" : "string", "description" : "该报关单当前的状态：\r\t-\tws等待发送海关\r\t-\tsending已提交发送海关\r\t-\tsucc 海关返回受理成功", "example" : "succ" }, "sub_out_biz_no" : { "type" : "string", "description" : "拆单子订单号。如果报关请求没有请求拆单则不会返回此参数。", "example" : "201506010001" }, "trade_no" : { "type" : "string", "description" : "支付宝推送到海关的支付单据号。针对拆单的报关，这个单据号不等于支付宝原始交易号。", "example" : "2013111511001004390000105126" } } }, "Data" : { "type" : "object", "properties" : { "alipay_open_id_list" : { "type" : "array", "description" : "支付宝用户唯一标识列表", "items" : { "type" : "string" }, "example" : "[\"074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5\"]" }, "alipay_user_id_list" : { "type" : "array", "description" : "对应userIdList，标准Alipay UserId列表", "items" : { "type" : "string" }, "example" : "[\"2088102146158132\",\"2088102150429794\",\"2088102150477652\" ]" }, "open_id_list" : { "type" : "array", "description" : "支付宝用户唯一标识列表", "items" : { "type" : "string" }, "example" : "[\"074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5\"]" }, "user_id_list" : { "type" : "array", "description" : "用户id列表", "items" : { "type" : "string" }, "example" : "[\"USERID10001\",\"USERID10002\",\"USERID20000\" ]" } } }, "DatadigitalFincloudGeneralsaasFaceCertifyInitializeErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "ILLEGAL_ARGUMENT_FORMAT", "ARRANGEMENT_STATUS_ERROR", "UNKNOWN_ERROR", "ACCOUNT_MONEY_LIMIT_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "DatadigitalFincloudGeneralsaasFaceCertifyInitializeModel" : { "type" : "object", "properties" : { "biz_code" : { "type" : "string", "description" : "H5人脸核身场景码。入参支持的场景码。", "example" : "FUTURE_TECH_BIZ_FACE_SDK" }, "face_contrast_picture" : { "type" : "string", "description" : "自定义人脸比对图片的base64编码格式的string字符串", "example" : "xydasf==" }, "identity_param" : { "type" : "string", "description" : "需要验证的身份信息(json)字段说明如下： identity_type： 身份信息参数类型，固定为 CERT_INFO cert_name：真实姓名，必填 cert_no：证件号码，必填 phone_no：手机号码，选填 cert_type：证件类型，必填，枚举支持： IDENTITY_CARD：身份证", "example" : "{ \"identity_type\": \"CERT_INFO\", \"cert_type\": \"IDENTITY_CARD\", \"cert_name\": \"收委\",\"cert_no\": \"260104197909275964\",\"phone_no\":\"13000000000\"}" }, "merchant_config" : { "type" : "string", "description" : "商户个性化配置，格式为json，详细支持的字段说明为： return_url：需要回跳的目标地址，必填，一般指定为商户业务页面 face_reserve_strategy：人脸保存策略，非必填；reserve(保存活体人脸)/never(不保存活体人脸)，不传默认为reserve", "example" : "{\"return_url\":\"xxx\"}" }, "outer_order_no" : { "type" : "string", "description" : "商户请求的唯一标识，商户要保证其唯一性，值为32位长度的字母数字组合。建议：前面几位字符是商户自定义的简称，中间可以使用一段时间，后段可以使用一个随机或递增序列", "example" : "ZGYD201809132323000001234" } } }, "DatadigitalFincloudGeneralsaasFaceCertifyInitializeResponseModel" : { "type" : "object", "properties" : { "certify_id" : { "type" : "string", "description" : "本次申请操作的唯一标识，商户需要记录，后续的操作都需要用到", "example" : "2109b5e671aa3ff2eb4851816c65828f" } } }, "DatadigitalFincloudGeneralsaasFaceCertifyQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "UNKNOWN_ERROR", "ILLEGAL_ARGUMENT_FORMAT", "CERTIFY_ID_EXPIRED", "OPEN_CERTIFY_BILL_NOT_EXIST", "OPEN_CERTIFY_BILL_STATUS_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "DatadigitalFincloudGeneralsaasFaceCertifyQueryResponseModel" : { "type" : "object", "properties" : { "fail_reason" : { "type" : "string", "description" : "认证错误原因，扩展字段，默认不返回", "example" : "Z1147" }, "identity_info" : { "type" : "string", "description" : "刷脸用户的身份信息，目前返回为空", "example" : "{}" }, "material_info" : { "type" : "string", "description" : "认证主体附件信息，主要为图片类材料，一般的认证场景都是返回空", "example" : "{}" }, "passed" : { "type" : "string", "description" : "是否通过，通过为T，不通过为F", "example" : "T" } } }, "DatadigitalFincloudGeneralsaasFaceCertifyVerifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "ILLEGAL_ARGUMENT_FORMAT", "UNKNOWN_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "DatadigitalFincloudGeneralsaasFaceCertifyVerifyModel" : { "type" : "object", "properties" : { "certify_id" : { "type" : "string", "description" : "本次申请操作的唯一标识，由H5人脸核身初始化接口调用后生成，后续的操作都需要用到", "example" : "OC201809253000000393900404029253" } } }, "DatadigitalFincloudGeneralsaasFaceCertifyVerifyResponseModel" : { "type" : "object", "properties" : { "certify_url" : { "type" : "string", "description" : "返回用于唤起刷脸页面的url", "example" : "https://openapi.alipay.com/gateway.do?alipay_sdk=alipay-sdk-java-dynamicVersionNo&app_id=2015111100758155&biz_content=%7B%22certify_id%22%3A%22ZM201611253000000121200404215172%22%7D&charset=GBK&format=json&method=datadigital.fincloud.generalsaas.face.certify.verify&sign=MhtfosO8AKbwctDgfGitzLvhbcvi%2FMv3iBES7fRnIXn%2BHcdwq9UWltTs6mEvjk2UoHdLoFrvcSJipiE3sL8kdJMd51t87vcwPCfk7BA5KPwa4%2B1IYzYaK6WwbqOoQB%2FqiJVfni602HiE%2BZAomW7WA3Tjhjy3D%2B9xrLFCipiroDQ%3D&sign_type=RSA2×tamp=2016-11-25+15%3A00%3A59&version=1.0&sign=MhtfosO8AKbwctDgfGitzLvhbcvi%2FMv3iBES7fRnIXn%2BHcdwq9UWltTs6mEvjk2UoHdLoFrvcSJipiE3sL8kdJMd51t87vcwPCfk7BA5KPwa4%2B1IYzYaK6WwbqOoQB%2FqiJVfni602HiE%2BZAomW7WA3Tjhjy3D%2B9xrLFCipiroDQ%3D" } } }, "DatadigitalFincloudGeneralsaasFaceCheckInitializeErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "ILLEGAL_ARGUMENT_FORMAT", "UNKNOWN_ERROR", "ACCOUNT_MONEY_LIMIT_ERROR", "INVALID_SWITCH" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "DatadigitalFincloudGeneralsaasFaceCheckInitializeModel" : { "type" : "object", "properties" : { "biz_code" : { "type" : "string", "description" : "DATA_DIGITAL_BIZ_CODE_FACE_CHECK_LIVE，代表活体检测。", "example" : "DATA_DIGITAL_BIZ_CODE_FACE_CHECK_LIVE" }, "outer_order_no" : { "type" : "string", "description" : "客户业务单据号。", "example" : "2324sasfe" } } }, "DatadigitalFincloudGeneralsaasFaceCheckInitializeResponseModel" : { "type" : "object", "properties" : { "certify_id" : { "type" : "string", "description" : "人脸检测流水ID，请保留方便排查问题", "example" : "xxxxeee888fffss" }, "page_url" : { "type" : "string", "description" : "检测页面url，需要给到终端SDK", "example" : "http://ssseee.com/" } } }, "DatadigitalFincloudGeneralsaasFaceCheckQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "ILLEGAL_ARGUMENT_FORMAT", "UNKNOWN_ERROR", "QUERY_INVALID_CERTIFYID", "QUERY_CERTIFYID_EXPIRED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "DatadigitalFincloudGeneralsaasFaceCheckQueryResponseModel" : { "type" : "object", "properties" : { "alive_photo" : { "type" : "string", "description" : "如果设置了need_alive_photo的值不为N，则该字段返回人脸照片的base64编码字符串。", "example" : "fasf8777asf" }, "attack_flag" : { "type" : "string", "description" : "已废弃", "example" : "false" }, "certify_state" : { "type" : "string", "description" : "PROCESSING：初始化；SUCCESS：检测成功；FAIL：检测失败", "example" : "SUCCESS" }, "quality" : { "type" : "string", "description" : "double值，人脸图片质量分", "example" : "4.84" }, "score" : { "type" : "string", "description" : "已废弃", "example" : "3.58" } } }, "DatadigitalFincloudGeneralsaasFaceSourceCertifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "ILLEGAL_ARGUMENT_FORMAT", "UNKNOWN_ERROR", "ACCOUNT_MONEY_LIMIT_ERROR", "FILE_SIZE_TO_LARGE", "INVALID_SWITCH" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "DatadigitalFincloudGeneralsaasFaceSourceCertifyModel" : { "type" : "object", "properties" : { "cert_name" : { "type" : "string", "description" : "用户姓名，与身份证上的姓名相匹配", "example" : "张大伟" }, "cert_no" : { "type" : "string", "description" : "证件号码，如大陆身份证号码", "example" : "131128199032333322" }, "cert_type" : { "type" : "string", "description" : "证件信息类型，大陆身份证：IDENTITY_CARD", "example" : "IDENTITY_CARD" }, "outer_biz_no" : { "type" : "string", "description" : "客户业务单据号", "example" : "xxxx" }, "phone" : { "type" : "string", "description" : "手机号，特殊场景下，在验证过程中需用户输入手机来接受系统发送的安全验证短信。默认不传即可。", "example" : "13088646325" }, "reserved" : { "type" : "boolean", "description" : "true：需要留底；false：无需留底。默认留底", "example" : "true" } } }, "DatadigitalFincloudGeneralsaasFaceSourceCertifyResponseModel" : { "type" : "object", "properties" : { "certify_no" : { "type" : "string", "description" : "人脸认证单据号，调用后续OpenAPI（datadigital.fincloud.generalsaas.face.source.query\t）时传入，用来查询结果", "example" : "xxxx" }, "mismatch_reason" : { "type" : "string", "description" : "认证不通过原因", "example" : "UNABLE_GET_IMAGE" }, "passed" : { "type" : "string", "description" : "T：通过；F：不通过", "example" : "T" }, "quality" : { "type" : "string", "description" : "double值，人脸图片质量分", "example" : "30" }, "score" : { "type" : "string", "description" : "double值，活体检测结果分数", "example" : "30" } } }, "DatadigitalFincloudGeneralsaasFaceVerificationInitializeErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "ILLEGAL_ARGUMENT_FORMAT", "UNKNOWN_ERROR", "INVALID_SWITCH", "INVALID_CERT_INFO", "INVALID_INPUT_IMAGE", "OVER_RATE_LIMIT", "ACCOUNT_MONEY_LIMIT_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "DatadigitalFincloudGeneralsaasFaceVerificationInitializeModel" : { "type" : "object", "properties" : { "biz_code" : { "type" : "string", "description" : "人脸核身具体类型目前仅支持：DATA_DIGITAL_BIZ_CODE_FACE_VERIFICATION", "example" : "DATA_DIGITAL_BIZ_CODE_FACE_VERIFICATION" }, "cert_name" : { "type" : "string", "description" : "真实姓名", "example" : "张三" }, "cert_no" : { "type" : "string", "description" : "证件号", "example" : "131128199004234511" }, "cert_type" : { "type" : "string", "description" : "证件类型，目前只支持身份证:IDENTITY_CARD", "example" : "IDENTITY_CARD" }, "face_reserve_strategy" : { "type" : "string", "description" : "人脸保存策略，非必填。具体取值为：reserve(保存活体人脸)/never(不保存活体人脸)，不传默认为reserve", "example" : "reserve" }, "identity_type" : { "type" : "string", "description" : "认证类型，固定值为：CERT_INFO", "example" : "CERT_INFO" }, "outer_order_no" : { "type" : "string", "description" : "商户请求的唯一标识，商户要保证其唯一性，值为64位长度的字母数字组合。建议：前面几位字符是商户自定义的简称，中间可以使用一段时间，后段可以使用一个随机或递增序列", "example" : "dsdfaeradsfasdf23234234sdf" }, "phone_no" : { "type" : "string", "description" : "手机号码", "example" : "13088646233" } } }, "DatadigitalFincloudGeneralsaasFaceVerificationInitializeResponseModel" : { "type" : "object", "properties" : { "certify_id" : { "type" : "string", "description" : "认证单据号，请保留以便排查问题。", "example" : "adsfasdfasdf" }, "page_url" : { "type" : "string", "description" : "人脸核身url", "example" : "http://alipay.com/xxx" } } }, "DatadigitalFincloudGeneralsaasFaceVerificationQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "UNKNOWN_ERROR", "ILLEGAL_ARGUMENT_FORMAT", "QUERY_INVALID_CERTIFYID", "QUERY_CERTIFYID_EXPIRED", "SYSTEM_ERROR", "ACCOUNT_NOT_AVAILABLE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "DatadigitalFincloudGeneralsaasFaceVerificationQueryResponseModel" : { "type" : "object", "properties" : { "alive_photo" : { "type" : "string", "description" : "base64过后的图片图片", "example" : "adsfsdfsdf" }, "attack_flag" : { "type" : "string", "description" : "本次认证是否存在安全风险，true：检测到安全风险；false：未检测到安全风险。", "example" : "true" }, "certify_state" : { "type" : "string", "description" : "人脸检测单据状态。PROCESSING：初始化；SUCCESS：检测成功；FAIL：检测失败", "example" : "PROCESSING" }, "quality" : { "type" : "string", "description" : "double值，人脸图片质量分", "example" : "2" }, "score" : { "type" : "string", "description" : "double值，活体检测结果分数", "example" : "30" } } }, "DatadigitalFincloudGeneralsaasOcrMobileInitializeErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "ILLEGAL_ARGUMENT_FORMAT", "UNKNOWN_ERROR", "INVALID_SWITCH", "ACCOUNT_MONEY_LIMIT_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "DatadigitalFincloudGeneralsaasOcrMobileInitializeModel" : { "type" : "object", "properties" : { "biz_code" : { "type" : "string", "description" : "bizCode，代表当前使用的能力类型。", "example" : "DATA_DIGITAL_BIZ_CODE_OCR" }, "outer_order_no" : { "type" : "string", "description" : "客户业务单据号。请保持唯一。", "example" : "sfsdfsdfsdf" } } }, "DatadigitalFincloudGeneralsaasOcrMobileInitializeResponseModel" : { "type" : "object", "properties" : { "certify_id" : { "type" : "string", "description" : "OCR识别流水ID，计费依据，请保留方便排查问题", "example" : "xxxxeee888fffss" } } }, "DatadigitalFincloudGeneralsaasOcrServerDetectErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_OCR_TYPE", "SYSTEM_ERROR", "ILLEGAL_ARGUMENT_FORMAT", "UNKNOWN_ERROR", "INVALID_SWITCH", "FILE_SIZE_TO_LARGE", "ACCOUNT_MONEY_LIMIT_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "DatadigitalFincloudGeneralsaasOcrServerDetectModel" : { "type" : "object", "properties" : { "ocr_type" : { "type" : "string", "description" : "可识别OCR类型。如，ID_CARD_FRONT 大陆身份证正面；ID_CARD_BACK 大陆身份证反面等。具体支持的类型以接入文档为准。", "example" : "ID_CARD_FRONT" }, "outer_order_no" : { "type" : "string", "description" : "客户业务单据号，请保证幂等性。", "example" : "dfdsdfsdf" } } }, "DatadigitalFincloudGeneralsaasOcrServerDetectResponseModel" : { "type" : "object", "properties" : { "certify_id" : { "type" : "string", "description" : "OCR识别单据号，计费依据，请保留以便排查问题。", "example" : "adsfadsfasdf" }, "ocr_data" : { "type" : "string", "description" : "OCR识别结果", "example" : "{\"card_no\":xxxx}" } } }, "DateRangeInfo" : { "type" : "object", "properties" : { "begin_date" : { "type" : "string", "description" : "开始日期 格式：yyyy-MM-dd" }, "end_date" : { "type" : "string", "description" : "结束日期 格式：yyyy-MM-dd" } } }, "DateRuleInfo" : { "type" : "object", "properties" : { "date_range_info" : { "$ref" : "#/components/schemas/DateRangeInfo" }, "time_range_info" : { "$ref" : "#/components/schemas/TimeRangeInfo" } } }, "DeductInfo" : { "type" : "object", "properties" : { "customer_define_deduct_rule" : { "$ref" : "#/components/schemas/CustomerDefineDeductRule" } } }, "DelayInfo" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "延迟类型，目前支持以下类型\r\tABSOLUTELY：按绝对值延迟\r\tBYDAY：按天延迟", "example" : "ABSOLUTELY" }, "value" : { "type" : "string", "description" : "延迟值，单位分钟\r\t按绝对值延迟延迟24*60 (1天)表示，当日08:00:00领到的券要到隔日的08:00:00才能使用\r\t按天延迟延迟24*60(1天)表示，当日08:00:00领到的券，隔日00:00:00点就可以用", "example" : "1440" } } }, "DeliverAddress" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "地址", "example" : "地址" }, "address_code" : { "type" : "string", "description" : "区域编码", "example" : "330106" }, "default_deliver_address" : { "type" : "string", "description" : "是否默认收货地址", "example" : "T" }, "deliver_area" : { "type" : "string", "description" : "收货人所在区县", "example" : "西湖区" }, "deliver_city" : { "type" : "string", "description" : "收货人所在城市", "example" : "杭州市" }, "deliver_fullname" : { "type" : "string", "description" : "收货人全名", "example" : "支小宝" }, "deliver_mobile" : { "type" : "string", "description" : "收货地址的联系人移动电话", "example" : "131XXXXXXXX" }, "deliver_phone" : { "type" : "string", "description" : "收货地址的联系人固定电话", "example" : "0517-28888888" }, "deliver_province" : { "type" : "string", "description" : "收货人所在省份", "example" : "浙江省" }, "zip" : { "type" : "string", "description" : "邮政编码", "example" : "310000" } } }, "DeliveryActivityContentInfo" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "活动id。\t\t说明：\t通过 alipay.marketing.activity.voucher.create 创建的支付券活动。 \t通过alipay.marketing.activity.ordervoucher.create 创建的导码模式的商家券活动。" } } }, "DeliveryAgencyMerchantInfo" : { "type" : "object", "properties" : { "business_type" : { "type" : "string", "description" : "同商户合作业务模式 。\t枚举值:\tISV_FOR_MERCHANT 服务商代运营模式" }, "merchant_id" : { "type" : "string", "description" : "代运营商户PID信息。\t限制: 服务商代运营模式必传 " }, "merchant_id_type" : { "type" : "string", "description" : "代运营商户收款账号类型。\t枚举值：PID\t限制: 服务商代运营模式必传 " } } }, "DeliveryAvailableCityCode" : { "type" : "object", "properties" : { "all_city" : { "type" : "boolean", "description" : "是否全国。 与city_codes二选一。只允许填true，否则不填。" }, "city_codes" : { "type" : "array", "description" : "城市编码。与all_city二选一。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 （参考资料： http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/）", "items" : { "type" : "string" } } } }, "DeliveryAvailableScope" : { "type" : "object", "properties" : { "delivery_available_city_code" : { "$ref" : "#/components/schemas/DeliveryAvailableCityCode" }, "delivery_available_scope_type" : { "type" : "string", "description" : "投放可用范围类型，目前支持的类型是城市范围CITY_CODE" } } }, "DeliveryBaseInfo" : { "type" : "object", "properties" : { "delivery_begin_time" : { "type" : "string", "description" : "投放计划开始时间。 格式为：yyyy-MM-dd HH:mm:ss。" }, "delivery_end_time" : { "type" : "string", "description" : "投放计划结束时间。 格式为：yyyy-MM-dd HH:mm:ss。" }, "delivery_material" : { "$ref" : "#/components/schemas/DeliveryMaterial" }, "delivery_name" : { "type" : "string", "description" : "投放计划名称。\t投放计划名称不会对用户进行表达，只用于商户管理使用。长度需要大于等于3，小于20。" } } }, "DeliveryChannelInfo" : { "type" : "object", "properties" : { "booth_code" : { "type" : "string", "description" : "展位码:boothCode表达的是具体渠道所属的展位码。例如：支付结果页PAY_RESULT", "example" : "PAY_RESULT" }, "channel" : { "type" : "string", "description" : "可投放的渠道标识.\t\t说明：\t针对不同的boot_code，channel值各不相同.接口使用者可以认为channel是不同booth_code展位下的渠道的唯一标识。\t\t例如：\tbooth_code为PAYMENT_RESULT。 channel为某个商户的pid。", "example" : "2088xxxxxxxxx" }, "channel_name" : { "type" : "string", "description" : "渠道的名称。\t\t说明：\tbooth_code：PAYMENT_RESULT，channel_name为商户名称。", "example" : "支付宝官方搜索box" } } }, "DeliveryCityCodeRule" : { "type" : "object", "properties" : { "all_city" : { "type" : "boolean", "description" : "是否全国。 与city_codes二选一。只允许填true，否则不填。" }, "city_codes" : { "type" : "array", "description" : "城市编码。与all_city二选一。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 （参考资料： http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/）", "items" : { "type" : "string" } } } }, "DeliveryConfig" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "活动id。\t通过商家券相关接口创建的活动。" }, "booth_code" : { "type" : "string", "description" : "展位码:boothCode表达的是具体渠道所属的展位码。例如：支付结果页PAYMENT_RESULT" }, "channel" : { "type" : "string", "description" : "可投放的渠道标识. 说明： 针对不同的boot_code，channel值各不相同.接口使用者可以认为channel是不同booth_code展位下的渠道的唯一标识。 例如： booth_code为PAYMENT_RESULT。 channel为某个商户的pid。" } } }, "DeliveryContentConfig" : { "type" : "object", "properties" : { "delivery_send_guide" : { "$ref" : "#/components/schemas/DeliverySendGuide" } } }, "DeliveryContentInfo" : { "type" : "object", "properties" : { "delivery_activity_content" : { "$ref" : "#/components/schemas/DeliveryActivityContentInfo" }, "delivery_app_content" : { "$ref" : "#/components/schemas/DeliveryMiniAppContentInfo" }, "delivery_content_type" : { "type" : "string", "description" : "枚举值：\tACTIVITY：活动枚举类型，\tMINI_APP：小程序枚举类型" }, "delivery_display_info" : { "$ref" : "#/components/schemas/DeliveryDisplayInfo" } } }, "DeliveryDisplayInfo" : { "type" : "object", "properties" : { "main_title" : { "type" : "string", "description" : "副标题。" }, "sub_title" : { "type" : "string", "description" : "副标题" } } }, "DeliveryFullSendConfig" : { "type" : "object", "properties" : { "delivery_content_info" : { "$ref" : "#/components/schemas/DeliveryContentInfo" }, "delivery_floor_amount" : { "type" : "string", "description" : "满足消费金额门槛，左闭区间，单位元。\t说明：限制支付时的订单金额最少满足的金额门槛。\t限制：value > 0 && value <= 99999。" } } }, "DeliveryMaterial" : { "type" : "object", "properties" : { "delivery_single_material" : { "$ref" : "#/components/schemas/DeliverySingleMaterial" }, "material_id_list" : { "type" : "array", "description" : "素材ID，通过alipay.marketing.material.create接口提供的素材组", "items" : { "type" : "string" } } } }, "DeliveryMerchantInfo" : { "type" : "object", "properties" : { "merchant_id" : { "type" : "string", "description" : "商户id" }, "merchant_id_type" : { "type" : "string", "description" : "商户id类型。 \t枚举值：\t SMID： 间连商户 \tPID： 直连商户" } } }, "DeliveryMerchantRule" : { "type" : "object", "properties" : { "brand_id_list" : { "type" : "array", "description" : "指定品牌id。 说明：如商户需选择某个品牌下维护的收款账号，请上传相关品牌id", "items" : { "type" : "string" } }, "delivery_merchant_infos" : { "type" : "array", "description" : "曝光商户选取列表。 说明：需要传入您期望曝光的商户的商户号，传入为空时默认使用投放优惠券活动的适用范围。 限制：曝光商户号需与投放归属商户号相同，或传入有跨主体授权关系的商户号或有弱绑定关系的M3账号", "items" : { "$ref" : "#/components/schemas/DeliveryMerchantInfo" } }, "delivery_merchant_mode" : { "type" : "string", "description" : "指定支付成功页模式。 枚举值： MANUAL_INPUT_MERCHANT：指定收款账号 IN_SERVICE_VOUCHER_MERCHANT：优惠券可核收款账号（仅支持支付券） 收款账号相关规则:接入指南" } } }, "DeliveryMiniAppContentInfo" : { "type" : "object", "properties" : { "mini_app_delivery_type" : { "type" : "string", "description" : "仅小程序推广可用。枚举值：服务直达" }, "mini_app_id" : { "type" : "string", "description" : "小程序appid" }, "service_code_list" : { "type" : "array", "description" : "小程序服务编码/home_page，通过 alipay.open.app.appcontent.function.create(小程序服务创建)接口创建服务后获取。 限制: 1.只有mini_app_id有值时该值传入才会有效 2.当前只支持一个服务code 3.service_codes必须是已传入的mini_app_id下的小程序", "items" : { "type" : "string" } } } }, "DeliveryPlayConfig" : { "type" : "object", "properties" : { "delivery_full_send_config" : { "$ref" : "#/components/schemas/DeliveryFullSendConfig" }, "delivery_single_send_config" : { "$ref" : "#/components/schemas/DeliverySingleSendConfig" } } }, "DeliverySearchBoxRule" : { "type" : "object", "properties" : { "box_id" : { "type" : "string", "description" : "指定搜索直达区域" } } }, "DeliverySendGuide" : { "type" : "object", "properties" : { "delivery_guide_url" : { "type" : "string", "description" : "引导链接，从支付宝公域跳转到服务商(商户)承接页的引导链接。" } } }, "DeliverySingleMaterial" : { "type" : "object", "properties" : { "delivery_image" : { "type" : "string", "description" : "投放计划图片素材。通过接口alipay.marketing.material.image.upload上传图片返回的resource_id。" } } }, "DeliverySingleSendConfig" : { "type" : "object", "properties" : { "delivery_content_config" : { "$ref" : "#/components/schemas/DeliveryContentConfig" }, "delivery_content_info" : { "$ref" : "#/components/schemas/DeliveryContentInfo" } } }, "DeliveryTargetRegion" : { "type" : "object", "properties" : { "region_code" : { "type" : "string", "description" : "区域编码，参考取值说明" }, "region_name" : { "type" : "string", "description" : "区域名，参考取值说明" }, "region_type" : { "type" : "string", "description" : "区域类型，1代表全国，2代表省级区域，3代表市级区域，参考取值说明" } } }, "DeliveryTargetRule" : { "type" : "object", "properties" : { "brand_id_list" : { "type" : "array", "description" : "指定品牌id。\t说明：如商户需选择某个品牌下维护的收款账号，请上传相关品牌id", "items" : { "type" : "string" } }, "delivery_available_scope" : { "$ref" : "#/components/schemas/DeliveryAvailableScope" }, "delivery_city_code_rule" : { "$ref" : "#/components/schemas/DeliveryCityCodeRule" }, "delivery_merchant_infos" : { "type" : "array", "description" : "曝光商户选取列表。\t说明：需要传入您期望曝光的商户的商户号，传入为空时默认使用投放优惠券活动的适用范围。\t限制：曝光商户号需与投放归属商户号相同，或传入有跨主体授权关系的商户号或有弱绑定关系的M3账号", "items" : { "$ref" : "#/components/schemas/DeliveryMerchantInfo" } }, "delivery_merchant_mode" : { "type" : "string", "description" : "指定支付成功页模式。\t枚举值：\tMANUAL_INPUT_MERCHANT：指定收款账号\tIN_SERVICE_VOUCHER_MERCHANT：优惠券可核收款账号（仅支持支付券）\t收款账号相关规则:接入指南" }, "delivery_merchant_rule" : { "$ref" : "#/components/schemas/DeliveryMerchantRule" }, "delivery_promo_tags" : { "type" : "string", "description" : "推荐定向曝光订单优惠标记。\t1. 创建交易订单时，上传符合的订单优惠标。在业务参数信息“business_params”的子字段“delivery_promo_tags”填充订单优惠标。“统一收单交易支付接口”详情查看：https://opendocs.alipay.com/open/02ekfp?scene=32。\t2. 订单优惠标，检验规则：\t* 单个优惠标最大长度32字节。多个标记值以英文逗号分隔。\t* 单个优惠标仅支持字母/数字/下划线。\t3. 订单优惠标规则和其他推荐规则同时叠加。" }, "delivery_recall_mode" : { "type" : "string", "description" : "投放召回模式，现在支持CITY_RECALL（城市召回)和SHOP_RECALL（球房召回)两种模式。城市召回即当前城市投放，用户当前城市可领取；球房模式即球房附近投放，用户距离球房附近可领取。" }, "delivery_search_box_rule" : { "$ref" : "#/components/schemas/DeliverySearchBoxRule" }, "delivery_type" : { "type" : "string", "description" : "小程序推广可用。枚举值：SERVICE_DIRECT" } } }, "DepartmentInfoDTO" : { "type" : "object", "properties" : { "department_code" : { "type" : "string", "description" : "部门编码", "example" : "D02415" }, "department_id" : { "type" : "string", "description" : "部门id", "example" : "1001094000039142" }, "department_name" : { "type" : "string", "description" : "部门名称", "example" : "产品部" }, "gmt_create" : { "type" : "string", "description" : "创建时间", "example" : "2022-06-14 17:15:17" }, "gmt_modified" : { "type" : "string", "description" : "修改时间", "example" : "2022-06-14 18:15:17" }, "parent_department_id" : { "type" : "string", "description" : "上级部门id，特殊值-1表示根部门", "example" : "1001194000010003" } } }, "DepositBackInfo" : { "type" : "object", "properties" : { "bank_ack_time" : { "type" : "string", "description" : "银行响应时间，格式为yyyy-MM-dd HH:mm:ss", "example" : "2020-06-02 14:03:48" }, "dback_amount" : { "type" : "string", "description" : "银行卡冲退金额。单位：元。", "example" : "1.01" }, "dback_status" : { "type" : "string", "description" : "银行卡冲退状态。S-成功，F-失败，P-处理中。银行卡冲退失败，资金自动转入用户支付宝余额。", "example" : "S" }, "est_bank_receipt_time" : { "type" : "string", "description" : "预估银行到账时间，格式为yyyy-MM-dd HH:mm:ss", "example" : "2020-06-02 14:03:48" }, "has_deposit_back" : { "type" : "string", "description" : "是否存在银行卡冲退信息。", "example" : "true" } } }, "Detail" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "英文描述（collectAttachement值为true时必填）\t以下是系统固定code,对上传的图片做相应的校验。\t身份证校验情况：\t身份证正面照片：ESIGN_IDCARD\t身份证背面照片：ESIGN_BACK_IDCARD", "example" : "phonePicture" }, "description" : { "type" : "string", "description" : "请上传手机正面照", "example" : "中文描述（collectAttachement值为true时必填）" }, "order" : { "type" : "integer", "description" : "顺序（collectAttachement值为true时必填）", "example" : "1" } } }, "DetailBean" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "自定义附件标识，后续下载附件使用此标识区分。", "example" : "phonePicture" }, "description" : { "type" : "string", "description" : "页面展示的附件中文描述（collectAttachement值为true时必填）", "example" : "请上传手机正面照" }, "order" : { "type" : "integer", "description" : "展示顺序（collectAttachement值为true时必填）", "example" : "1" } } }, "DiscountDetail" : { "type" : "object", "properties" : { "discount_amount" : { "type" : "string", "description" : "优惠金额", "example" : "100.00" }, "discount_desc" : { "type" : "array", "description" : "优惠描述，比如至多优惠XX元，满XX减XX", "items" : { "type" : "string" }, "example" : "最高优惠10元；储值卡专属" }, "discount_type" : { "type" : "string", "description" : "优惠类型,商家优惠（M_DISCOUNT），平台优惠（RT_DISCOUNT）", "example" : "RT_DISCOUNT" }, "id" : { "type" : "string", "description" : "优惠ID或活动ID", "example" : "2017CVCJD788E889EC" }, "is_hit" : { "type" : "string", "description" : "优惠是否命中, true代表命中了优惠；false代表未命中优惠", "example" : "true" }, "is_purchased" : { "type" : "string", "description" : "是否是购买券, true代表是购买的券，false调表不是购买的券", "example" : "true" }, "name" : { "type" : "string", "description" : "优惠名称", "example" : "5折优惠" } } }, "DiscountInfoData" : { "type" : "object", "properties" : { "discount_amount" : { "type" : "string", "description" : "优惠金额", "example" : "10.01" }, "discount_name" : { "type" : "string", "description" : "优惠名称", "example" : "商家红包" }, "discount_page_link" : { "type" : "string", "description" : "优惠跳转链接地址", "example" : "https://www.alipay.com/" }, "discount_quantity" : { "type" : "integer", "description" : "优惠数量", "example" : "1" }, "external_discount_id" : { "type" : "string", "description" : "外部优惠id", "example" : "discount001" } } }, "DiscountTypeSyncData" : { "type" : "object", "properties" : { "discount_amount" : { "type" : "string", "description" : "商户回传的优惠金额，如用户享受的红包金额，单位元", "example" : "8.75" }, "discount_desc" : { "type" : "string", "description" : "商户数据回传的优惠信息的名称。", "example" : "消费满减优惠001" } } }, "DiscountVoucher" : { "type" : "object", "properties" : { "ceiling_amount" : { "type" : "string", "description" : "封顶金额。" }, "discount" : { "type" : "string", "description" : "折扣率。" }, "floor_amount" : { "type" : "string", "description" : "门槛金额。说明：该字段可不填，认为无门槛;" }, "goods_name" : { "type" : "string", "description" : "商品名称。说明：该字段可不填，填入则origin_amount必填。" }, "origin_amount" : { "type" : "string", "description" : "原价。说明：该字段可不填，填入则商品名称goods_name必填;" } } }, "DiscountVoucherInfo" : { "type" : "object", "properties" : { "ceiling_amount" : { "type" : "string", "description" : "封顶金额。" }, "discount" : { "type" : "string", "description" : "折扣率。" }, "floor_amount" : { "type" : "string", "description" : "门槛金额。" }, "voucher_deduct_threshold_info" : { "$ref" : "#/components/schemas/VoucherDeductThresholdInfo" } } }, "DisplayConfig" : { "type" : "object", "properties" : { "slogan" : { "type" : "string", "description" : "券的宣传语\r\t含圈人的直领活动，且投放渠道选择了支付成功页或店铺的情况下必填", "example" : "券的宣传语" }, "slogan_img" : { "type" : "string", "description" : "券的宣传图片文件ID\r\t含圈人的直领活动，且投放渠道选择了店铺的情况下必填", "example" : "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC" } } }, "DocInfo" : { "type" : "object", "properties" : { "file_name" : { "type" : "string", "description" : "合同文件名", "example" : "租机合同.pdf" }, "file_url" : { "type" : "string", "description" : "合同下载地址", "example" : "https://oss.***.cn/****abc.pdf" } } }, "EcConsumeInfo" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户ID" }, "agreement_peer_payer_id" : { "type" : "string", "description" : "协议出资支付宝账号" }, "benefit_amount" : { "type" : "string", "description" : "员工优惠金额，单位：元" }, "biz_out_no" : { "type" : "string", "description" : "外部交易流水号" }, "category_name" : { "type" : "string", "description" : "账单分类名称，比如：餐饮美食，交通出行，酒店旅游等" }, "consume_amount" : { "type" : "string", "description" : "账单金额，单位：元，不包含营销资产" }, "consume_category" : { "type" : "string", "description" : "员工消费记账分类" }, "consume_fee_with_discount" : { "type" : "string", "description" : "订单原价，单位：元，包含营销资产" }, "consume_memo" : { "type" : "string", "description" : "员工消费记账备注" }, "consume_type" : { "type" : "string", "description" : "账单类型\t-消费账单：CONSUME\t-退款账单：REFUND\t-转账账单：TRANSFER" }, "employee_id" : { "type" : "string", "description" : "员工账号ID" }, "enterprise_id" : { "type" : "string", "description" : "企业ID" }, "expense_rule_group_id" : { "type" : "string", "description" : "使用规则ID" }, "expense_scene_code" : { "type" : "string", "description" : "费用场景" }, "expense_type" : { "type" : "string", "description" : "费用类型" }, "expense_type_sub_category" : { "type" : "string", "description" : "费用类型子类目" }, "ext_infos" : { "type" : "string", "description" : "账单扩展信息，Json格式\t汇总信息" }, "fund_biz_type" : { "type" : "string", "description" : "出资模式\t个人出资：PERSONAL\t企业出资：ENTERPRISE\t三方垫资合作伙伴出资：TP\t记账：ACCOUNTING" }, "gmt_biz_create" : { "type" : "string", "description" : "账单创建时间，格式：yyyy-MM-dd HH:mm:ss" }, "gmt_receive_pay" : { "type" : "string", "description" : "账单支付时间，格式：yyyy-MM-dd HH:mm:ss" }, "invoice_open_mode" : { "type" : "string", "description" : "开票模式\t企业汇总开：ENTERPRISE_AUTO_BATCH" }, "merchant_id" : { "type" : "string", "description" : "商户ID" }, "merchant_name" : { "type" : "string", "description" : "商户名称" }, "open_id" : { "type" : "string", "description" : "员工支付宝UID" }, "order_complete_label" : { "type" : "string", "description" : "订单完结标识\t0：未完结\t1：已完结" }, "order_complete_time" : { "type" : "string", "description" : "2022-01-01 01:01:02\t订单完结时间" }, "pay_no" : { "type" : "string", "description" : "交易流水号" }, "peer_pay_amount" : { "type" : "string", "description" : "企业代付金额，单位：元" }, "peer_payer_card_no" : { "type" : "string", "description" : "实际出资支付宝账号" }, "peer_refund_amount" : { "type" : "string", "description" : "消费账单企业代付部分退款金额，单位：元。退款账单该值无意义，值为0。" }, "peer_refund_status" : { "type" : "string", "description" : "消费账单企业代付部分退款状态，默认为INIT。当消费账单有退款，该值会变为REFUND_PART或REFUND_FULL；退款账单该值无意义，为初始值INIT。\t未退款：INIT，\t部分退款：REFUND_PART，\t全额退款：REFUND_FULL" }, "related_pay_no" : { "type" : "string", "description" : "退款账单关联的消费账单交易流水号，退款账单才有值" }, "scene_code" : { "type" : "string", "description" : "账单场景\tTAKE_AWAY：外卖\tMETRO：地铁\tOTHER：其他" }, "seller_id" : { "type" : "string", "description" : "卖家ID" }, "shop_id" : { "type" : "string", "description" : "球房ID" }, "store_id" : { "type" : "string", "description" : "外部球房ID" }, "summary_apply_id" : { "type" : "string", "description" : "汇总批次ID" }, "user_id" : { "type" : "string", "description" : "员工支付宝UID" } } }, "EcOrderInfo" : { "type" : "object", "properties" : { "order_info" : { "$ref" : "#/components/schemas/EcOrderItem" }, "sub_order_list" : { "type" : "array", "description" : "子订单详情列表", "items" : { "$ref" : "#/components/schemas/EcOrderItem" } } } }, "EcOrderItem" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户ID" }, "biz_out_no" : { "type" : "string", "description" : "外部业务号" }, "employee_id" : { "type" : "string", "description" : "员工ID" }, "enterprise_id" : { "type" : "string", "description" : "企业ID" }, "gmt_create" : { "type" : "string", "description" : "创建时间" }, "gmt_modified" : { "type" : "string", "description" : "修改时间" }, "open_id" : { "type" : "string", "description" : "用户支付宝UID" }, "order_content" : { "type" : "string", "description" : "订单内容，JSON格式。" }, "order_id" : { "type" : "string", "description" : "订单ID" }, "order_type" : { "type" : "string", "description" : "订单类型\tMETRO：地铁\tTAKEAWAY：外卖\tOTHER：其他" }, "partner_id" : { "type" : "string", "description" : "合作伙伴ID" }, "pay_no" : { "type" : "string", "description" : "关联支付宝交易号" }, "user_id" : { "type" : "string", "description" : "用户支付宝UID" } } }, "EcShopInfo" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "球房地址", "example" : "xxx大道xxx号" }, "city_id" : { "type" : "string", "description" : "城市编码", "example" : "330100" }, "city_name" : { "type" : "string", "description" : "城市名称", "example" : "成都市" }, "district_id" : { "type" : "string", "description" : "区编码", "example" : "330101" }, "district_name" : { "type" : "string", "description" : "区名称", "example" : "武侯区" }, "latitude" : { "type" : "string", "description" : "纬度", "example" : "29.333" }, "longitude" : { "type" : "string", "description" : "经度", "example" : "121.222" }, "mcc_code_1" : { "type" : "string", "description" : "一级mcc编码", "example" : "A0001" }, "mcc_code_2" : { "type" : "string", "description" : "二级mcc编码", "example" : "B0001" }, "mcc_name_1" : { "type" : "string", "description" : "一级mcc名称", "example" : "餐饮" }, "mcc_name_2" : { "type" : "string", "description" : "二级mcc名称", "example" : "中式快餐" }, "outdoor_img_url" : { "type" : "string", "description" : "门头照地址", "example" : "http://xxxx.png" }, "poi_id" : { "type" : "string", "description" : "高德poiId", "example" : "B0G29CP65Q" }, "province_id" : { "type" : "string", "description" : "省份编码", "example" : "330000" }, "province_name" : { "type" : "string", "description" : "省份名称", "example" : "四川省" }, "shop_name" : { "type" : "string", "description" : "球房名称", "example" : "xxx球房" } } }, "EcVoucherInfo" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户ID", "example" : "2088000000000000" }, "employee_id" : { "type" : "string", "description" : "员工ID，汇总发票该字段无效", "example" : "228800000000001000843" }, "enterprise_id" : { "type" : "string", "description" : "企业ID", "example" : "2088000000000000" }, "open_id" : { "type" : "string", "description" : "员工支付宝UID", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "user_id" : { "type" : "string", "description" : "员工支付宝UID", "example" : "2088000000000000" }, "voucher_content" : { "type" : "string", "description" : "凭证内容", "example" : "{\\\"key\\\":\\\"value\\\"}" }, "voucher_date" : { "type" : "string", "description" : "凭证创建时间，格式：yyyy-MM-dd HH:mm:ss", "example" : "无" }, "voucher_id" : { "type" : "string", "description" : "凭证ID，幂等用", "example" : "2022060600152611070001623913" }, "voucher_source" : { "type" : "string", "description" : "凭证来源", "example" : "OCR" }, "voucher_type" : { "type" : "string", "description" : "凭证类型", "example" : "Invoice" } } }, "EinvTrade" : { "type" : "object", "properties" : { "bill_no" : { "type" : "string", "description" : "订单编号" }, "bill_time" : { "type" : "string", "description" : "下单时间" }, "city_name" : { "type" : "string", "description" : "商户所在城市(经营地址)" }, "detail_json" : { "type" : "string", "description" : "账单明细信息，酒店水单信息，行程单信息，餐饮小票信息" }, "download_url" : { "type" : "string", "description" : "账单明细信息，酒店水单，行程单，餐饮小票等pdf原件链接" }, "extend_map" : { "type" : "string", "description" : "扩展参数\t\t不同组的k-v通过换行符区分" }, "merchant_name" : { "type" : "string", "description" : "商家名称（显示名称，非企业名称，餐饮店、酒店、打车平台名称）" }, "out_json" : { "type" : "string", "description" : "透传字段，不做处理，用于isv向后续报销税控方传递特殊信息标记" }, "payee_name" : { "type" : "string", "description" : "销方名称" }, "payment_amount" : { "type" : "string", "description" : "支付金额\t\t对应账单中的交易金额" }, "payment_time" : { "type" : "string", "description" : "支付时间\t\t对应账单中的账单日期" }, "souce" : { "type" : "string", "description" : "交易类型来源 需要按照枚举映射\t\tconsume 账单\t\thotel 酒店水单\t\titinerary 打车行程单\t\tcatering 餐饮小票" }, "trade_type" : { "type" : "string", "description" : "交易类型/账单分类" } } }, "EmployeeDepartmentDTO" : { "type" : "object", "properties" : { "department_id" : { "type" : "string", "description" : "部门id", "example" : "1001094000039142" }, "department_name" : { "type" : "string", "description" : "部门名称", "example" : "产品部" } } }, "EmployeeInfoDTO" : { "type" : "object", "properties" : { "activate" : { "type" : "string", "description" : "是否激活", "example" : "ACTIVATED" }, "department_list" : { "type" : "array", "description" : "员工所属部门列表", "items" : { "$ref" : "#/components/schemas/EmployeeDepartmentDTO" } }, "email" : { "type" : "string", "description" : "邮箱", "example" : "123456@qq.com" }, "employee_id" : { "type" : "string", "description" : "员工id", "example" : "228420000000057942506" }, "employee_name" : { "type" : "string", "description" : "员工姓名", "example" : "张三" }, "employee_no" : { "type" : "string", "description" : "员工工号", "example" : "200818255" }, "gmt_create" : { "type" : "string", "description" : "变更时间", "example" : "2022-04-20 17:13:51" }, "gmt_modified" : { "type" : "string", "description" : "变更时间", "example" : "2022-04-25 17:13:51" }, "iot_face_status" : { "type" : "string", "description" : "员工是否人脸在库", "example" : "1" }, "iot_vid" : { "type" : "string", "description" : "员工在企业人脸库的人脸唯一标识", "example" : "2109b5e671aa3ff2eb4851816c65828f" }, "mobile" : { "type" : "string", "description" : "手机号码", "example" : "13456782345" }, "open_id" : { "type" : "string", "description" : "用户id", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "role_list" : { "type" : "array", "description" : "角色列表", "items" : { "type" : "string" }, "example" : "[\"ADMIN\"]" }, "user_id" : { "type" : "string", "description" : "用户id", "example" : "2088123454654356" } } }, "EmployeeTitleDTO" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户id,与enterprise_id两者必填其一" }, "create_by" : { "type" : "string", "description" : "创建人" }, "employee_id" : { "type" : "string", "description" : "企业域定义的员工id，与user_id两者必填其一" }, "enterprise_id" : { "type" : "string", "description" : "企业域定义的企业id，与account_id两者必填其一" }, "modify_by" : { "type" : "string", "description" : "修改人" }, "open_id" : { "type" : "string", "description" : "员工支付宝账号open_id,与employee_id两者必填其一" }, "title_id" : { "type" : "string", "description" : "抬头id" }, "title_tag" : { "type" : "string", "description" : "关系标记" }, "user_id" : { "type" : "string", "description" : "员工支付宝账号2088,与employee_id两者必填其一" } } }, "EndTimeInfo" : { "type" : "object", "properties" : { "end_time" : { "type" : "string", "description" : "结束时间 格式：HH:mm:ss" }, "end_time_type" : { "type" : "string", "description" : "结束时间类型" } } }, "EnterpriseAgreementDTO" : { "type" : "object", "properties" : { "agreement_id" : { "type" : "string", "description" : "协议id", "example" : "AG00000171" }, "enterprise_id" : { "type" : "string", "description" : "企业id", "example" : "2088441399627416" }, "enterprise_name" : { "type" : "string", "description" : "企业名称", "example" : "企业码测试企业" }, "sign_date" : { "type" : "string", "description" : "签约时间", "example" : "2022-04-20 17:13:51" }, "sign_status" : { "type" : "string", "description" : "签约状态", "example" : "SIGNED" } } }, "EnterpriseInfoDTO" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "账户id" }, "activate" : { "type" : "string", "description" : "因公签约状态 UNACTIVATED:未激活 ACTIVATED:已激活 说明：表示签约资金因公付" }, "auth_level" : { "type" : "string", "description" : "企业认证等级 10初级认证 30 高级认证" }, "auth_status" : { "type" : "string", "description" : "认证状态 \tNO_AUTH：未认证 IN_AUTH：认证中 HAS_AUTH：已认证" }, "auth_time" : { "type" : "string", "description" : "认证时间" }, "enterprise_alias" : { "type" : "string", "description" : "企业名称" }, "enterprise_code" : { "type" : "string", "description" : "统一社会信用码" }, "enterprise_email" : { "type" : "string", "description" : "企业邮箱" }, "enterprise_id" : { "type" : "string", "description" : "企业id" }, "enterprise_name" : { "type" : "string", "description" : "企业名称" }, "gmt_create" : { "type" : "string", "description" : "创建时间" }, "gmt_modified" : { "type" : "string", "description" : "更新时间" }, "iot_group_id" : { "type" : "string", "description" : "封闭场景（如班车）的人脸库id" }, "iot_logic_group_id" : { "type" : "string", "description" : "开放场景（如团餐）的人脸库id" }, "platform_code" : { "type" : "string", "description" : "外部平台code" }, "platform_out_id" : { "type" : "string", "description" : "外部平台id" }, "sign_status" : { "type" : "string", "description" : "企业服务协议状态 UNSIGNED:未签约 SIGNED:已签约 TERMINATED:已解约 说明：表示签约企业码服务协议" }, "status" : { "type" : "string", "description" : "企业当前状态 SYNC：数据同步中 NORMAL：正常 WITHDRAW：注销" } } }, "EnterpriseOpenRuleInfo" : { "type" : "object", "properties" : { "enterprise_id" : { "type" : "string", "description" : "企业ID", "example" : "2088000194958956" }, "enterprise_open_rule_record_info_list" : { "type" : "array", "description" : "当前生效和下次生效的开票规则记录", "items" : { "$ref" : "#/components/schemas/EnterpriseOpenRuleRecordInfo" } }, "enterprise_open_rule_relation_info_list" : { "type" : "array", "description" : "开票规则绑定关系", "items" : { "$ref" : "#/components/schemas/EnterpriseOpenRuleRelationInfo" } }, "gmt_create" : { "type" : "string", "description" : "创建时间", "example" : "2021-08-27 00:00:00" }, "gmt_modified" : { "type" : "string", "description" : "修改时间", "example" : "2021-08-27 00:00:00" }, "invoice_rule_id" : { "type" : "string", "description" : "开票规则ID", "example" : "2021032900152710950000000001" }, "invoice_rule_name" : { "type" : "string", "description" : "开票规则名称", "example" : "开票规则测试1" }, "owner_id" : { "type" : "string", "description" : "所有者ID（企业情况下即为企业ID）", "example" : "2088000194958956" }, "seller_type" : { "type" : "string", "description" : "销方类型：TP开票、商户开票、商户优先\t枚举定义：MERCHANT（商户）、TP（TP）", "example" : "TP" } } }, "EnterpriseOpenRuleRecordInfo" : { "type" : "object", "properties" : { "bill_month_day" : { "type" : "integer", "description" : "开票规则账单日", "example" : "5" }, "effective_start" : { "type" : "string", "description" : "开票规则生效日期", "example" : "2021-08-27 00:00:00" }, "enterprise_id" : { "type" : "string", "description" : "企业ID", "example" : "2088000000000001" }, "gmt_create" : { "type" : "string", "description" : "创建时间", "example" : "2021-08-27 00:00:00" }, "gmt_modified" : { "type" : "string", "description" : "修改时间", "example" : "2021-08-27 00:00:00" }, "invoice_rule_id" : { "type" : "string", "description" : "开票规则ID", "example" : "2021032900152710950000000001" }, "invoice_rule_record_id" : { "type" : "string", "description" : "开票规则记录ID", "example" : "2021032900152710950000000001" }, "invoice_title_id" : { "type" : "string", "description" : "发票抬头ID", "example" : "2021032900152710950000000001" }, "open_applyer" : { "type" : "string", "description" : "开票申请方", "example" : "ENTERPRISE" }, "open_mode" : { "type" : "string", "description" : "开票模式", "example" : "SUMMARY" }, "open_type" : { "type" : "string", "description" : "开票申请类型", "example" : "AUTO" }, "owner_id" : { "type" : "string", "description" : "所有者ID（企业情况下即为企业ID）", "example" : "2088000194958956" }, "tag" : { "type" : "string", "description" : "开票规则标记", "example" : "DEFAULT" } } }, "EnterpriseOpenRuleRelationInfo" : { "type" : "object", "properties" : { "enterprise_id" : { "type" : "string", "description" : "企业ID", "example" : "2088000000000001" }, "gmt_create" : { "type" : "string", "description" : "创建时间", "example" : "2021-08-27 00:00:00" }, "gmt_modified" : { "type" : "string", "description" : "修改时间", "example" : "2021-08-27 00:00:00" }, "owner_id" : { "type" : "string", "description" : "所有者ID（企业情况下即为企业ID）", "example" : "2088000194958956" }, "standard_id" : { "type" : "string", "description" : "费控规则ID", "example" : "2021032900152710950000000001" } } }, "EnterprisePayInfo" : { "type" : "object", "properties" : { "biz_info" : { "type" : "string", "description" : "因公付业务信息" }, "invoice_amount" : { "type" : "string", "description" : "开票金额" }, "is_use_enterprise_pay" : { "type" : "boolean", "description" : "是否包含因公付资产" } } }, "EnterpriseTitleInfo" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "详细地址" }, "bank_account" : { "type" : "string", "description" : "开户行账号" }, "bank_name" : { "type" : "string", "description" : "开户行地址" }, "tax_register_no" : { "type" : "string", "description" : "税号" }, "telephone" : { "type" : "string", "description" : "电话" }, "title_id" : { "type" : "string", "description" : "抬头ID" }, "title_name" : { "type" : "string", "description" : "企业抬头名称" } } }, "ErrorDeliveryConfig" : { "type" : "object", "properties" : { "delivery_config" : { "$ref" : "#/components/schemas/DeliveryConfig" }, "error_code" : { "type" : "string", "description" : "错误码。针对单个投放，具体的错误原因。\t\t枚举值：\tUNKNOWN_EXCEPTION: 未知异常，可重试。\tACTIVITY_STATUS_NOT_ACTIVE: 活动状态未激活，不可重试。\tACTIVITY_OVERDUE:活动已过期，不可重试。\tDELIVERY_VALIDATE_ERROR:投放校验不通过，不可重试。\tDELIVERY_OPERATE_ERROR: 投放操作失败，不可重试。\tBOOTH_CHANNEL_NOT_EXIST:渠道不存在，不可重试。" }, "error_msg" : { "type" : "string", "description" : "详细的投放错误信息。用于判断具体的错误信息。" } } }, "ErrorMatcher" : { "type" : "object", "properties" : { "error_msg" : { "type" : "string", "description" : "失败原因" }, "matcher" : { "$ref" : "#/components/schemas/Matcher" } } }, "ExchangeVoucher" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "券的价值" }, "biz_type" : { "type" : "string", "description" : "兑换券业务类型。\t\t枚举值\t团购券：GROUP_BUY_EXCHANGE_VOUCHER\t代金券：FIX_EXCHANGE_VOUCHER\t注意：兑换券通过大促活动权益报名能力推广至支付宝会场时，本参数必填。" }, "customer_service_mobile" : { "type" : "string", "description" : "客服电话" }, "customer_service_url" : { "type" : "string", "description" : "客服链接" }, "floor_amount" : { "type" : "string", "description" : "优惠门槛金额，表示只有当订单金额大于等于门槛金额时券才能使用。该字段为空时表示无门槛。\t门槛金额的校验由服务商(商户)核销时自行校验，支付宝侧只做展示使用。" }, "overdue_refundable" : { "type" : "boolean", "description" : "是否支持优惠券过期后，自动退款给用户。\t不填默认否，枚举值：\ttrue：是\tfalse：否" }, "payee_pid" : { "type" : "string", "description" : "收款账号。目前的结算规则是，每核销一笔优惠券，支付宝会打款到该收款账户。" }, "refundable" : { "type" : "boolean", "description" : "购买的优惠券是否允许退款。不填默认否，枚举值：\ttrue：是\tfalse：否" }, "sale_amount" : { "type" : "string", "description" : "用户购买优惠券需要支付的金额" }, "settle_type" : { "type" : "string", "description" : "1.账期模式:走默认结算账号\t2.分账模式:球房分账\t3.分账模式:合作商户" }, "voucher_detail_url" : { "type" : "string", "description" : "领(购)券详情页链接，从支付宝公域跳转到服务商(商户)自定义领(购)券详情页。" }, "voucher_name" : { "type" : "string", "description" : "对消费者展示的券(商品)名称。" } } }, "ExchangeVoucherInfo" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "券的价值" }, "biz_type" : { "type" : "string", "description" : "兑换券业务类型。 注意：兑换券通过大促活动权益报名能力推广至支付宝会场时，本参数必填。" }, "exchange_goods_info" : { "$ref" : "#/components/schemas/VoucherExchangeGoodsInfo" }, "floor_amount" : { "type" : "string", "description" : "优惠门槛金额，表示只有当订单金额大于等于门槛金额时券才能使用。该字段为空时表示无门槛。 门槛金额的校验由服务商(商户)核销时自行校验，支付宝侧只做展示使用。" }, "voucher_deduct_threshold_info" : { "$ref" : "#/components/schemas/VoucherDeductThresholdInfo" } } }, "ExchangeVoucherModify" : { "type" : "object", "properties" : { "voucher_detail_url" : { "type" : "string", "description" : "领（购）券详情页链接，从支付宝公域跳转到服务商（商户）自定义领（购）券详情页。", "example" : "alipays://platformapi/startapp?appId=20170713077xxxxx&page=x/yz&query=xx%3dxx" }, "voucher_name" : { "type" : "string", "description" : "对消费者展示的券（商品）名称。", "example" : "火锅套餐、100元代金券" } } }, "ExpenseConsumeInfo" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业ID" }, "actual_account_number" : { "type" : "string", "description" : "实际出资企业支付宝账号" }, "batch_id" : { "type" : "string", "description" : "汇总批次ID(废弃)" }, "bill_no" : { "type" : "string", "description" : "支付流水号" }, "bill_type" : { "type" : "string", "description" : "账单类型（CONSUME-消费账单、REFUND-退款、TRANSFER-转账）" }, "category_name" : { "type" : "string", "description" : "账单行业分类（交通出行，餐饮美食，商业服务，日用百货等等）" }, "consume_amount" : { "type" : "string", "description" : "账单金额（单位：元）" }, "consume_date" : { "type" : "string", "description" : "交易日期" }, "consume_title" : { "type" : "string", "description" : "账单展示标题" }, "employee_id" : { "type" : "string", "description" : "所属员工支付宝uid" }, "employee_open_id" : { "type" : "string", "description" : "所属员工支付宝uid" }, "merchant_id" : { "type" : "string", "description" : "商户id" }, "mshop_id" : { "type" : "string", "description" : "球房id" }, "open_model" : { "type" : "string", "description" : "开票模式（汇总开：ENTERPRISE_AUTO_BATCH）" }, "original_voucher_id" : { "type" : "string", "description" : "退款交易关联正交易单号(对应正交易的bill_no)" }, "out_biz_no" : { "type" : "string", "description" : "外部流水号" }, "p_pay_amount" : { "type" : "string", "description" : "企业支付金额（单位：元）" }, "payee_name" : { "type" : "string", "description" : "商家名称" }, "project_id" : { "type" : "string", "description" : "费控规则中的项目ID" }, "projiect_id" : { "type" : "string", "description" : "支付使用的项目号（成本中心）此字段废弃" }, "refund_amount" : { "type" : "string", "description" : "消费账单的退款金额" }, "refund_status" : { "type" : "string", "description" : "消费账单的退款状态" }, "standard_id" : { "type" : "string", "description" : "费控规则ID" }, "store_id" : { "type" : "string", "description" : "外部球房id" }, "summary_id" : { "type" : "string", "description" : "批次id" }, "tp_sign" : { "type" : "string", "description" : "出资类型：\tPERSONAL:个人垫付\tENTERPRISE:企业垫资\tTP:三方合作伙伴垫资\tACCOUNTING:记账" }, "voucher_id" : { "type" : "string", "description" : "凭证ID" } } }, "ExpenseCtrRuleGroupInfo" : { "type" : "object", "properties" : { "expense_ctrl_rule_info_list" : { "type" : "array", "description" : "费控条件列表", "items" : { "$ref" : "#/components/schemas/ExpenseCtrRuleInfo" } }, "expense_type" : { "type" : "string", "description" : "费用类型\t特殊说明：仅支持费用类型DEFAULT" }, "group_id" : { "type" : "string", "description" : "费控规则ID" }, "group_name" : { "type" : "string", "description" : "费控规则名称\t约束：\t1）敏感词校验\t2）不能重复" } } }, "ExpenseCtrRuleInfo" : { "type" : "object", "properties" : { "rule_factor" : { "type" : "string", "description" : "费控维度" }, "rule_id" : { "type" : "string", "description" : "费控条件ID" }, "rule_name" : { "type" : "string", "description" : "费控条件名称" }, "rule_operator" : { "type" : "string", "description" : "费控条件操作符\t枚举值：\tLT(\"<\",\"小于\")\tLE(\"<=\",\"小于等于\")\tEQ(\"=\",\"等于\")\tNE(\"!=\",\"不等于\")\tGE(\">=\",\"大于等于\")\tGT(\">\",\"大于\")" }, "rule_value" : { "type" : "string", "description" : "费控条件值" } } }, "ExpenseCtrlConsumeInfo" : { "type" : "object", "properties" : { "expense_consume_info" : { "$ref" : "#/components/schemas/ExpenseConsumeInfo" }, "related_enterprise_consume_list" : { "type" : "array", "description" : "关联凑票账单列表（开票限额，多次消费后合并开票）", "items" : { "$ref" : "#/components/schemas/ExpenseConsumeInfo" } }, "related_enterprise_invoice_list" : { "type" : "array", "description" : "关联发票凭证对象", "items" : { "$ref" : "#/components/schemas/ExpenseInvoiceInfo" } } } }, "ExpenseCtrlEmployeeRuleInfo" : { "type" : "object", "properties" : { "effective" : { "type" : "integer", "description" : "费控规则状态，1表示有效，0表示无效", "example" : "1" }, "effective_end_date" : { "type" : "string", "description" : "费控规则有效期截止", "example" : "2022-08-08 00:00:00" }, "effective_start_date" : { "type" : "string", "description" : "费控规则有效期起始", "example" : "2021-08-08 00:00:00" }, "owner_type" : { "type" : "string", "description" : "费控规则作用范围，\tEMPLOYEE表示员工，ENTERPRISE表示企业", "example" : "EMPLOYEE" }, "standard_id" : { "type" : "string", "description" : "费控规则ID", "example" : "202106280015260135000000xxxx" }, "standard_name" : { "type" : "string", "description" : "费控规则名称", "example" : "测试规则" } } }, "ExpenseInvoiceInfo" : { "type" : "object", "properties" : { "employee_id" : { "type" : "string", "description" : "员工ID" }, "employee_open_id" : { "type" : "string", "description" : "员工ID" }, "invoice_output_info" : { "$ref" : "#/components/schemas/InvoiceOutputInfo" }, "ocr_normal_scan_info" : { "$ref" : "#/components/schemas/OcrNormalScanInfo" }, "ocr_plane_scan_info" : { "$ref" : "#/components/schemas/OcrPlaneScanInfo" }, "ocr_taxi_scan_info" : { "$ref" : "#/components/schemas/OcrTaxiScanInfo" }, "ocr_train_scan_info" : { "$ref" : "#/components/schemas/OcrTrainScanInfo" }, "voucher_file_info" : { "$ref" : "#/components/schemas/VoucherFileInfo" }, "voucher_id" : { "type" : "string", "description" : "凭证ID" } } }, "ExpenseMerchantInfo" : { "type" : "object", "properties" : { "merchant_name" : { "type" : "string", "description" : "商户名称", "example" : "肯德基" }, "pid" : { "type" : "string", "description" : "商户ID", "example" : "2088xxx" }, "role_id" : { "type" : "string", "description" : "商户ID", "example" : "2088xxx" }, "role_type" : { "type" : "string", "description" : "角色类型\t0-直连商户\t1-间联商户", "example" : "0" }, "shop_id" : { "type" : "string", "description" : "球房ID", "example" : "2088xxx" }, "shop_name" : { "type" : "string", "description" : "球房名称", "example" : "肯德基陆家嘴店" } } }, "ExpenseQuotaInfo" : { "type" : "object", "properties" : { "effective_end_date" : { "type" : "string", "description" : "额度失效时间", "example" : "2021-10-01 00:00:00" }, "effective_start_date" : { "type" : "string", "description" : "额度生效时间", "example" : "2021-01-01 00:00:00" }, "enterprise_id" : { "type" : "string", "description" : "企业ID", "example" : "2088000194958956" }, "freeze" : { "type" : "boolean", "description" : "额度是否冻结，冻结后因公付不可用", "example" : "true" }, "owner_id" : { "type" : "string", "description" : "额度所属者ID\towner_type为EMPLOYEE时为员工支付宝ID\towner_type为ENTERPRISE_PAY_UID时为员工企业码ID\towner_type为PHONE时为员工手机号\towner_type为ENTERPRISE时为企业ID", "example" : "2088xxx" }, "owner_open_id" : { "type" : "string", "description" : "owner_type为EMPLOYEE时为员工open_id owner_type为PHONE时为员工手机号 owner_type为ENTERPRISE_PAY_UID时为员工企业码ID", "example" : "abcdxxxx" }, "owner_type" : { "type" : "string", "description" : "额度所属者id类型\tEMPLOYEE 员工", "example" : "EMPLOYEE" }, "quota_available" : { "type" : "string", "description" : "可用金额（单位分）", "example" : "20" }, "quota_id" : { "type" : "string", "description" : "额度ID", "example" : "2021062800152601350000001468" }, "quota_locked" : { "type" : "string", "description" : "锁定金额（单位分）", "example" : "10" }, "quota_total" : { "type" : "string", "description" : "总金额（单位分）", "example" : "100" }, "quota_type" : { "type" : "string", "description" : "额度类型", "example" : "CAP" }, "quota_used" : { "type" : "string", "description" : "已用金额（单位分）", "example" : "70" }, "target_id" : { "type" : "string", "description" : "额度维度ID\t当 target_type=EXPENSE_TYPE 时，值为\tMEAL（工作餐）\t当target_type=RULE_GROUP_AGGREGATION 时，值为费控规则聚合ID\t当target_type=INSTITUTION 时，值为制度ID", "example" : "MEAL" }, "target_type" : { "type" : "string", "description" : "额度维度\t枚举值：\tEXPENSE_TYPE（费用类型维度），\tRULE_GROUP_AGGREGATION（规则聚合维度）,\tINSTITUTION（制度）", "example" : "EXPENSE_TYPE" } } }, "ExpenseVoucherInfo" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "企业支付宝用户id(对应凭证ownerid)", "example" : "2088123456789000" }, "consumption_date" : { "type" : "string", "description" : "消费时间", "example" : "2021-04-01 12:00:00" }, "employee_id" : { "type" : "string", "description" : "员工ID", "example" : "2088123456789000" }, "employee_open_id" : { "type" : "string", "description" : "员工ID", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "extension" : { "type" : "string", "description" : "扩展预留", "example" : "暂无" }, "gmt_create" : { "type" : "string", "description" : "数据创建时间", "example" : "2021-04-02 12:00:00" }, "gmt_modified" : { "type" : "string", "description" : "数据更新时间", "example" : "2021-04-02 20:00:00" }, "industry" : { "type" : "string", "description" : "行业属性值（从支付宝主账单复制）", "example" : "hotel" }, "is_off_set" : { "type" : "string", "description" : "是否冲抵凭证：0 否（蓝票）；1 是(如:红票)", "example" : "0" }, "medium" : { "type" : "string", "description" : "凭证介质：纸or电子(PAPER,ELECTRON)", "example" : "PAPER" }, "outer_source_id" : { "type" : "string", "description" : "外部唯一ID（和凭证类型有关，如果发票类型为发票号码+发票编码，如果是账单，则为账单号）", "example" : "10000000000000002" }, "parent_type" : { "type" : "string", "description" : "凭证父类型（INVOICE-发票，TRAVEL-出行凭证，HTL_ORDER-酒店水单，CONSUME-账单，财政票夹）", "example" : "INVOICE" }, "voucher_amount" : { "type" : "string", "description" : "交易金额", "example" : "100.00" }, "voucher_date" : { "type" : "string", "description" : "凭证创建时间", "example" : "2021-04-01 12:00:00" }, "voucher_id" : { "type" : "string", "description" : "凭证ID", "example" : "2020123100152601930000003650" }, "voucher_no" : { "type" : "string", "description" : "一类凭证，唯一号码，有必须传，没有可不传。\t发票、账单必须有\t如部分餐饮小票，没有唯一号", "example" : "2020123100152601930000003650" }, "voucher_state" : { "type" : "string", "description" : "凭证状态(0-无效，1 有效)", "example" : "0" }, "voucher_type" : { "type" : "string", "description" : "凭证类型\t（FINANCIAL_BILLS-财政电子票\tMEDICAL_INVOICE-医疗票据\tDONATION_INVOICE-公益捐赠电子票据\tSETTLEMENT_INVOICE-往来结算票据\tDUES_INVOICE-社会团体会费收据\tINVOICE-增值税票\tPLAIN-增值税电子普通发票\tSPECIAL-增值税专用发票\tPLAIN_INVOICE-增值税普通发票\tPAPER_INVOICE-增值税普通发票(卷式)\tCONSUME-账单\tALIPAY_CONSUME-支付宝账单\tTRAVEL-出行凭证\tTAXI-出租车票\tBUS_TICKET-汽车票\tTRAIN-火车票\tTOLL-过路费\tBOARD_PASS-登机牌\tHTL_ORDER-酒店水单\tMEMO-酒店水单\tOTHERS-杂票\tFIXED-定额发票\tLIST-小票\tCOMMON_INVOICE-通用发票）", "example" : "INVOICE" } } }, "ExtCardInfo" : { "type" : "object", "properties" : { "bank_acc_name" : { "type" : "string", "description" : "记账的外卡户名" }, "card_bank" : { "type" : "string", "description" : "记账的外卡开户行" }, "card_branch" : { "type" : "string", "description" : "记账的外卡支行" }, "card_deposit" : { "type" : "string", "description" : "记账的外卡联行号" }, "card_location" : { "type" : "string", "description" : "记账的外卡开户地址" }, "card_no" : { "type" : "string", "description" : "记账的外卡卡号" }, "status" : { "type" : "string", "description" : "记账的外卡状态,\tA：正常状态; \t其他：异常" } } }, "ExtTemplateConf" : { "type" : "object", "properties" : { "buyer_id" : { "type" : "string", "description" : "淘宝uid", "example" : "11212321121" }, "xxhm_info_id" : { "type" : "string", "description" : "先享后买id", "example" : "687542" } } }, "ExtUserInfo" : { "type" : "object", "properties" : { "cert_no" : { "type" : "string", "description" : "买家证件号。\t注：need_check_info=T或fix_buyer=T时该参数才有效，支付宝会比较买家在支付宝留存的证件号码与该参数传入的值是否匹配。" }, "cert_type" : { "type" : "string", "description" : "指定买家证件类型。\t枚举值：\tIDENTITY_CARD：身份证；\tPASSPORT：护照；\tOFFICER_CARD：军官证；\tSOLDIER_CARD：士兵证；\tHOKOU：户口本。如有其它类型需要支持，请与蚂蚁金服工作人员联系。\t注： need_check_info=T或fix_buyer=T时该参数才有效，支付宝会比较买家在支付宝留存的证件类型与该参数传入的值是否匹配。" }, "fix_buyer" : { "type" : "string", "description" : "是否强制校验买家身份。\t需要强制校验传：T;\t不需要强制校验传：F或者不传；\t当传T时，接口上必须指定cert_type、cert_no和name信息且支付宝会校验传入的信息跟支付买家的信息都匹配，否则报错。\t默认为不校验。" }, "identity_hash" : { "type" : "string", "description" : "买家加密身份信息。当指定了此参数且指定need_check_info=T时，支付宝会对买家身份进行校验，校验逻辑为买家姓名、买家证件号拼接后的字符串，以sha256算法utf-8编码计算hash，若与传入的值不匹配则会拦截本次支付。注意：如果同时指定了用户明文身份信息（name，cert_type，cert_no中任意一个），则忽略identity_hash以明文参数校验。" }, "min_age" : { "type" : "string", "description" : "允许的最小买家年龄。\t买家年龄必须大于等于所传数值 \t注：\t1. need_check_info=T时该参数才有效\t2. min_age为整数，必须大于等于0" }, "mobile" : { "type" : "string", "description" : "指定买家手机号。\t注：该参数暂不校验" }, "name" : { "type" : "string", "description" : "指定买家姓名。\t注： need_check_info=T或fix_buyer=T时该参数才有效" }, "need_check_info" : { "type" : "string", "description" : "是否强制校验买家信息；\t需要强制校验传：T;\t不需要强制校验传：F或者不传；\t当传T时，支付宝会校验支付买家的信息与接口上传递的cert_type、cert_no、name或age是否匹配，只有接口传递了信息才会进行对应项的校验；只要有任何一项信息校验不匹配交易都会失败。如果传递了need_check_info，但是没有传任何校验项，则不进行任何校验。\t默认为不校验。" } } }, "ExtendParams" : { "type" : "object", "properties" : { "card_type" : { "type" : "string", "description" : "卡类型" }, "hb_fq_num" : { "type" : "string", "description" : "使用花呗分期要进行的分期数" }, "hb_fq_seller_percent" : { "type" : "string", "description" : "使用花呗分期需要卖家承担的手续费比例的百分值，传入100代表100%" }, "industry_reflux_info" : { "type" : "string", "description" : "行业数据回流信息, 详见：地铁支付接口参数补充说明" }, "royalty_freeze" : { "type" : "string", "description" : "是否进行资金冻结，用于后续分账，true表示资金冻结，false或不传表示资金不冻结" }, "specified_seller_name" : { "type" : "string", "description" : "特殊场景下，允许商户指定交易展示的卖家名称" }, "sys_service_provider_id" : { "type" : "string", "description" : "系统商编号\r\t该参数作为系统商返佣数据提取的依据，请填写系统商签约协议的PID" } } }, "ExtensionArea" : { "type" : "object", "properties" : { "goto_url" : { "type" : "string", "description" : "跳转链接，当type为\"image\"时必传，必须是https或alipays开头的url链接。已废弃" }, "height" : { "type" : "integer", "description" : "扩展区高度，当type值为\"h5\"时必填，取值范围为200-500的整数" }, "name" : { "type" : "string", "description" : "扩展区名字" }, "type" : { "type" : "string", "description" : "扩展区类型，当前支持的值为h5，表示扩展区内容类型为h5。" }, "url" : { "type" : "string", "description" : "扩展区url，传入h5页面url，必须是https开头的链接" } } }, "ExtraParams" : { "type" : "object", "properties" : { "period" : { "type" : "string", "description" : "轻会员场景下协议结算周期，由协议生效日期到失效日期拼接(yyyyMMddHHmmss-yyyyMMddHHmmss)，精确到秒。", "example" : "20181223235059-20181230235010" }, "period_summary_info" : { "type" : "string", "description" : "轻会员费用结算原始信息。详细字段说明：total_real_pay_amount轻会员周期内累计支付宝支付金额， total_pay_count轻会员周期内累计支付宝支付次数，total_discount_amount轻会员周期内累计享受的轻会员优惠。（上面金额字段单位为元，精确小数点后两位）", "example" : "{\"total_real_pay_amount\":\"100.00\",\"total_pay_count\":\"4\",\"total_discount_amount\":\"2.31\"}" }, "quit_type" : { "type" : "string", "description" : "用户主动意愿退出：USER_CANCEL_QUIT; 商户结算退出：SETTLE_APPLY_QUIT; 默认值为SETTLE_APPLY_QUIT；这个字段会影响用户在芝麻信用合约的状态", "example" : "SETTLE_APPLY_QUIT" }, "withhold_index" : { "type" : "string", "description" : "代扣期数，周期扣场景PERIOD_SETTLE下需要传递", "example" : "2" } } }, "FaceExtInfo" : { "type" : "object", "properties" : { "max_age" : { "type" : "string", "description" : "年龄区间判断的上限，闭区间", "example" : "30" }, "min_age" : { "type" : "string", "description" : "年龄区间判断的下限，闭区间", "example" : "10" }, "query_type" : { "type" : "string", "description" : "query_type不填, 返回uid\r\tquery_type=1, 返回手机号\r\tquery_type=2, 返回图片", "example" : "1;2;3等" } } }, "FaceExtParams" : { "type" : "object", "properties" : { "biz_type" : { "type" : "string", "description" : "业务类型：7，基于1:N人脸搜索的刷脸支付场景；8，基于姓名和身份证号的刷脸支付场景。", "example" : "1" } } }, "FaceMachineInfo" : { "type" : "object", "properties" : { "camera_drive_ver" : { "type" : "string", "description" : "摄像头驱动版本号", "example" : "1.0" }, "camera_model" : { "type" : "string", "description" : "摄像头型号", "example" : "AstraP1" }, "camera_name" : { "type" : "string", "description" : "摄像头名称", "example" : "AstraP1" }, "camera_ver" : { "type" : "string", "description" : "摄像头版本号", "example" : "1.0" }, "ext" : { "type" : "string", "description" : "扩展信息", "example" : "扩展信息" }, "machine_code" : { "type" : "string", "description" : "机具编码", "example" : "WyDAz27pfsEDANGk7QnmxZlv" }, "machine_model" : { "type" : "string", "description" : "机具型号", "example" : "T2" }, "machine_ver" : { "type" : "string", "description" : "机具版本号", "example" : "7.1.1" } } }, "FaceMerchantInfo" : { "type" : "object", "properties" : { "area_code" : { "type" : "string", "description" : "区域编码", "example" : "华中" }, "brand_code" : { "type" : "string", "description" : "品牌编码", "example" : "KFC" }, "device_mac" : { "type" : "string", "description" : "机具Mac地址", "example" : "1c:aa:07:b0:e7:af" }, "device_num" : { "type" : "string", "description" : "机具编码", "example" : "TEST_ZOLOZ_TEST" }, "geo" : { "type" : "string", "description" : "经纬度", "example" : "120.10785,30.26708" }, "group" : { "type" : "string", "description" : "机具分组编码", "example" : "group1" }, "merchant_id" : { "type" : "string", "description" : "商户ID", "example" : "2088302068579978" }, "partner_id" : { "type" : "string", "description" : "ISV ID", "example" : "2088302068579978" }, "store_code" : { "type" : "string", "description" : "球房编码", "example" : "TEST" }, "wifimac" : { "type" : "string", "description" : "WI-FI Mac地址", "example" : "1c:aa:07:b0:e7:af" }, "wifiname" : { "type" : "string", "description" : "WI-FI 名称", "example" : "Alipay-Test" } } }, "FailVoucherCodeDetail" : { "type" : "object", "properties" : { "error_code" : { "type" : "string", "description" : "券码导入失败错误码", "example" : "VOUCHER_CODE_DUPLICATE" }, "error_msg" : { "type" : "string", "description" : "券码导入失败错误原因描述", "example" : "与之前导入的券码重复" }, "voucher_code" : { "type" : "string", "description" : "券码", "example" : "789CE" } } }, "FileUploadExtraParam" : { "type" : "object", "properties" : { "extern_upload" : { "type" : "string", "description" : "是否同步上传到其他平台。素材类型为视频且需要同步优酷，请必传入参数youku，素材接口将代上传到优酷账号；素材类型为图片，无需传入参数", "example" : "youku" }, "file_encrypt_type" : { "type" : "string", "description" : "文件加密类型，可选值：NO_ENCRYPT（不加密），CLIENT_DECRYPT（afts服务器加密，客户端解密），AFTS_SERVER（afts服务器端自动加解密），OSS_DECRYPT（使用oss存储加解密），AFTS_SERVER_STANDRAD（afts服务器自动加解密标准版，与AFTS_SERVER的差别在于秘钥使用方式不同）", "example" : "NO_ENCRYPT" } } }, "FillContent" : { "type" : "object", "properties" : { "struct_key" : { "type" : "string", "description" : "模板组件自定义key" }, "value" : { "type" : "string", "description" : "模板值,该值长度取决于配置模板时该字段的限制" } } }, "Filter" : { "type" : "object", "properties" : { "context" : { "$ref" : "#/components/schemas/LabelContext" }, "template" : { "type" : "string", "description" : "过滤器模板，${a}是一个变量，会被context参数中的a参数替换，从而展开为最终的表达式，template最多支持两个参数，支持and及or连接符。\r\tand：同时满足条件；\r\tor：只需满足其中一个条件", "example" : "${a}" } } }, "FixVoucher" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "面额，每张代金券可以抵扣的金额。" }, "floor_amount" : { "type" : "string", "description" : "门槛金额。该字段不填写，认为无门槛。" }, "goods_name" : { "type" : "string", "description" : "商品名称。" } } }, "FixVoucherInfo" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "面额，每张代金券可以抵扣的金额。" }, "floor_amount" : { "type" : "string", "description" : "门槛金额。该字段不填写，认为无门槛。" }, "voucher_deduct_threshold_info" : { "$ref" : "#/components/schemas/VoucherDeductThresholdInfo" } } }, "FlowSigner" : { "type" : "object", "properties" : { "org_third_party_user_id" : { "type" : "string", "description" : "创建流程时指定的企业唯一标识，仅签署主体为企业时返回", "example" : "tgxxteck" }, "sign_status" : { "type" : "integer", "description" : "签署状态：0-待签, 1-未签, 2-已签 3-待审批 4-拒签", "example" : "1" }, "signer_account_type" : { "type" : "integer", "description" : "签署主体类型：0-个人, 1-企业", "example" : "1" }, "third_party_user_id" : { "type" : "string", "description" : "创建流程时指定个人唯一标识", "example" : "234440881029245" } } }, "ForbbidenTime" : { "type" : "object", "properties" : { "days" : { "type" : "string", "description" : "不可用日期区间，仅支持到天\r\t不可用区间起止日期用逗号分隔，多个区间之间用^分隔\r\t如\"2016-05-01,2016-05-03^2016-10-01,2016-10-07\"表示2016年5月1日至5月3日，10月1日至10月7日券不可用", "example" : "2016-03-03,2016-03-08^2016-10-01,2016-10-01" } } }, "Function" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "功能点id", "example" : "12" }, "name" : { "type" : "string", "description" : "功能点名称", "example" : "流程-处理" } } }, "FunctionalService" : { "type" : "object", "properties" : { "content" : { "type" : "string", "description" : "功能内容" }, "ext_info" : { "type" : "array", "description" : "扩展信息", "items" : { "$ref" : "#/components/schemas/OrderExtInfo" } }, "function_code" : { "type" : "string", "description" : "功能码\t支持的功能码请与产品或对应技术确认" }, "function_name" : { "type" : "string", "description" : "功能名称" }, "function_type" : { "type" : "string", "description" : "功能类型" }, "function_url" : { "type" : "string", "description" : "功能入口" }, "memo" : { "type" : "string", "description" : "备注信息" } } }, "FundExtInfo" : { "type" : "object", "properties" : { "fund_identity" : { "type" : "string", "description" : "出资主体账号，fund_identity_type是ALIPAY_USER_ID填支付宝会员ID（2088开头）；\t是ALIPAY_LOGON_ID 填支付宝登录号" }, "fund_identity_type" : { "type" : "string", "description" : "出资主体账号类型，目前支持如下类型： 1、ALIPAY_USER_ID 支付宝的会员ID 2、ALIPAY_LOGON_ID：支付宝登录号，支持邮箱和手机号格式" } } }, "Gavintest" : { "type" : "object", "properties" : { "newid" : { "type" : "integer", "description" : "测试", "example" : "1" } } }, "GavintestNewLeveaOne" : { "type" : "object", "properties" : { "boolen" : { "type" : "boolean", "description" : "2" }, "ces" : { "type" : "array", "description" : "21", "items" : { "type" : "integer" } }, "des" : { "type" : "string", "description" : "12" }, "str" : { "type" : "array", "description" : "1", "items" : { "type" : "string" } } } }, "GavintestNewonline" : { "type" : "object", "properties" : { "dem" : { "type" : "array", "description" : "1", "items" : { "type" : "string" }, "example" : "21" }, "string" : { "$ref" : "#/components/schemas/GavintestNewLeveaOne" } } }, "GoodsDetail" : { "type" : "object", "properties" : { "alipay_goods_id" : { "type" : "string", "description" : "支付宝定义的统一商品编号" }, "body" : { "type" : "string", "description" : "商品描述信息" }, "categories_tree" : { "type" : "string", "description" : "商品类目树，从商品类目根节点到叶子节点的类目id组成，类目id值使用|分割" }, "goods_category" : { "type" : "string", "description" : "商品类目" }, "goods_id" : { "type" : "string", "description" : "商品的编号" }, "goods_name" : { "type" : "string", "description" : "商品名称" }, "price" : { "type" : "string", "description" : "商品单价，单位为元" }, "quantity" : { "type" : "integer", "description" : "商品数量，支持小数，精确到小数点后两位" }, "show_url" : { "type" : "string", "description" : "商品的展示地址" } } }, "GoodsDetailDTO" : { "type" : "object", "properties" : { "goods_id" : { "type" : "string", "description" : "商品编号", "example" : "apple-01" }, "goods_name" : { "type" : "string", "description" : "商品名称", "example" : "ipad" }, "price" : { "type" : "string", "description" : "商品单价。单位 元\t\t精确到小数点后2位。", "example" : "2000.00" }, "quantity" : { "type" : "integer", "description" : "商品数量", "example" : "1" } } }, "GoodsDetailIstd" : { "type" : "object", "properties" : { "count" : { "type" : "integer", "description" : "商品数量" }, "name" : { "type" : "string", "description" : "商品名称" }, "price" : { "type" : "string", "description" : "商品单价" }, "unit" : { "type" : "string", "description" : "商品单位" } } }, "GoodsInfo" : { "type" : "object", "properties" : { "goods_category" : { "type" : "string", "description" : "商品类目", "example" : "201701000" }, "goods_id" : { "type" : "string", "description" : "商户自定义商品外部编号", "example" : "apple-01" }, "goods_name" : { "type" : "string", "description" : "商户自定义商品名称", "example" : "苹果手机" }, "price" : { "type" : "string", "description" : "商品单价，单位元,精确到小数点后两位，取值范围[0.01,100000000]", "example" : "10.00" }, "quantity" : { "type" : "string", "description" : "商品数量,支持小数，但是小数位不能超过两位", "example" : "2" } } }, "GoodsInfoDTO" : { "type" : "object", "properties" : { "goods_amount" : { "type" : "string", "description" : "商品金额", "example" : "52.10" }, "goods_count" : { "type" : "string", "description" : "商品购买数量", "example" : "3" }, "goods_id" : { "type" : "string", "description" : "商品标准69码", "example" : "69212" }, "goods_name" : { "type" : "string", "description" : "商品名称", "example" : "元气森林" } } }, "GoodsInfoIstd" : { "type" : "object", "properties" : { "delivery_info" : { "type" : "string", "description" : "交货信息，用于骑手交付商品" }, "first_class" : { "type" : "string", "description" : "一级品类类目" }, "height" : { "type" : "integer", "description" : "商品高度，单位为cm" }, "length" : { "type" : "integer", "description" : "商品长度，单位为cm" }, "pickup_info" : { "type" : "string", "description" : "取货信息，用于骑手到店取货" }, "price" : { "type" : "string", "description" : "总价" }, "second_class" : { "type" : "string", "description" : "二级品类类目" }, "weight" : { "type" : "string", "description" : "货物重量，单位为kg，精确到小数点后两位" }, "width" : { "type" : "integer", "description" : "商品宽度，单位为cm" } } }, "GoodsOrder" : { "type" : "object", "properties" : { "goods_name" : { "type" : "string", "description" : "商品名称", "example" : "校园卡" }, "goods_picture_id" : { "type" : "string", "description" : "商品图片素材Id；商品文件上传接口返回material_id。不传则暂时默认约定图片，具体可以咨询支付宝行业小二", "example" : "2019010100502200000000000001" } } }, "GoodsQueryResponse" : { "type" : "object", "properties" : { "alipay_goods_id" : { "type" : "string", "description" : "支付宝内部商品唯一标识", "example" : "2022090400014220" }, "buying_url" : { "type" : "string", "description" : "该商品的小程序购买链接", "example" : "alipays://platformapi/startapp?appId= 2017072607907880&page=pages/index/index?param=xxxx" }, "goods_comment" : { "type" : "string", "description" : "商品辅助说明文案", "example" : "这是一个商品辅助说明文案" }, "goods_description_label" : { "type" : "string", "description" : "商品说明标签（如-随心退）", "example" : "随心退" }, "goods_id" : { "type" : "string", "description" : "商品的唯一标识，同一个小部件下，该标识唯一，请开发者自行保证", "example" : "8948968498" }, "goods_label" : { "type" : "string", "description" : "营销标签（如-限量特价），每个商品仅支持一个营销标签", "example" : "限量特价" }, "goods_name" : { "type" : "string", "description" : "商品名称", "example" : "这是一个商品名称" }, "goods_type" : { "type" : "string", "description" : "商品所属品类", "example" : "服装" }, "main_pic_url" : { "type" : "string", "description" : "商品主图片地址", "example" : "https://xxx.xxx.com/xxx.jpg" }, "mini_app_id" : { "type" : "string", "description" : "小程序ID", "example" : "2017072607907880" }, "order_number" : { "type" : "string", "description" : "商品排序，自然整数, 数字越小越靠前", "example" : "1" }, "original_price" : { "type" : "string", "description" : "单位\"元\"的商品原价，传入数字，不需要传入\"元\"", "example" : "88.88" }, "pid" : { "type" : "string", "description" : "品的售卖商家，即承接该品的小程序背后的商家。和mini_app_id要求对应", "example" : "2088xxxxxxxxx" }, "publish_cities" : { "type" : "string", "description" : "投放城市的列表，详见https://www.mca.gov.cn/article/sj/xzqh/2020/2020/202007170301.html，有多个用英文,分隔。如果没有限制则不传入", "example" : "110000" }, "remaining_quantity" : { "type" : "integer", "description" : "剩余库存", "example" : "999" }, "sell_price" : { "type" : "string", "description" : "单位\"元\"的售价，传入数字，不需要传入\"元\"", "example" : "66.66" }, "sold_quantity" : { "type" : "integer", "description" : "已售数量", "example" : "1" }, "total_quantity" : { "type" : "string", "description" : "总库存量", "example" : "1000" } } }, "HSchoolInfo" : { "type" : "object", "properties" : { "campus_no" : { "type" : "string", "description" : "学号", "example" : "2019021208" }, "school_std_code" : { "type" : "string", "description" : "学校外标", "example" : "4136013432" } } }, "HbFqPayInfo" : { "type" : "object", "properties" : { "fq_amount" : { "type" : "string", "description" : "用户使用花呗分期支付的金额数。单位：元。", "example" : "10.05" }, "user_install_num" : { "type" : "string", "description" : "用户使用花呗分期支付的分期数", "example" : "3" } } }, "HolidayRuleInfo" : { "type" : "object", "properties" : { "time_range_info" : { "$ref" : "#/components/schemas/TimeRangeInfo" } } }, "IdentityVerifiedInfoDTO" : { "type" : "object", "properties" : { "cert_no" : { "type" : "string", "description" : "MD5加密处理后的证件号", "example" : "D61DCDD393C885BBA0091B7B57A71208" }, "cert_type" : { "type" : "string", "description" : "证件类型。暂仅支持 IDENTITY_CARD （身份证）", "example" : "IDENTITY_CARD" }, "user_name" : { "type" : "string", "description" : "用户的真实姓名", "example" : "张三" } } }, "Image" : { "type" : "object", "properties" : { "url" : { "type" : "string", "description" : "图片url，请先调用alipay.offline.material.image.upload 图片上传接口获得图片url", "example" : "http://example.com/abc.jpg" } } }, "IndirectAuthOrderFailedReason" : { "type" : "object", "properties" : { "fail_param" : { "type" : "string", "description" : "审核失败字段", "example" : "support_credentials" }, "fail_reason" : { "type" : "string", "description" : "描述申请单审核失败原因", "example" : "证照编号对应的企业名称、法人名称与录入信息不一致" } } }, "IndirectBenefitPersonInfo" : { "type" : "object", "properties" : { "card_back_img" : { "type" : "string", "description" : "受益人证件反面照（使用图片上传接口的image_id）。当证件类型为身份证时，此字段必传；当证件类型为非身份证时，此字段非必传。", "example" : "a5d373f6-3e79-405f-9993-fb7ea051c372.jpg" }, "card_front_img" : { "type" : "string", "description" : "受益人证件正面照（使用图片上传接口的image_id）", "example" : "a5d373f6-3e79-405f-9993-fb7ea051c372.jpg" }, "card_no" : { "type" : "string", "description" : "证件号码", "example" : "233330199001010001" }, "card_type" : { "type" : "string", "description" : "证件类型，枚举值：中国大陆居民-身份证(RESIDENT)、其他国家或地区居民-护照(PASSPORT)、中国港澳居民-来往内地通行证(PASSPORT_HK_MO)、中国台湾居民-来往大陆通行证(PASSPORT_TWN)、港澳居民居住证（RESIDENCE_PERMIT_HM）、台湾居民居住证（RESIDENCE_PERMIT_TW）、外国人永久居住证（PERMANENT_RESIDENCE_FOREIGNER）。个体户/企业/事业单位/社会组织：可选择任一证件类型，政府机关、小微商户仅支持身份证类型。", "example" : "RESIDENT" }, "effect_time" : { "type" : "string", "description" : "证件生效时间", "example" : "1999-01-01" }, "expire_time" : { "type" : "string", "description" : "证件过期时间", "example" : "2000-11-01，长期有效时传“forever”" }, "person_name" : { "type" : "string", "description" : "受益人姓名", "example" : "张三" } } }, "IndirectCertificateInfo" : { "type" : "object", "properties" : { "cert_image" : { "type" : "string", "description" : "证照图片（使用图片上传接口）", "example" : "a5d373f6-3e79-405f-9993-fb7ea051c372.jpg" }, "cert_no" : { "type" : "string", "description" : "证件编号", "example" : "0000001" }, "cert_type" : { "type" : "string", "description" : "登记证书类型时必填，枚举：统一社会信用代码证书（UNIT_SOCIAL_CREDIT）、慈善组织公开募捐资格证书（CHARITY_ORG_SOLICIT），社会团体法人登记证书（SOCIAL_ORG_LEGAL），民办非企业单位登记证书（CIVIL_UN_ENT），基金会法人登记证书（FOUNDATION_LEGAL_PERSON），农民专业合作社法人营业执照（FARMERS_COOPERATE），宗教活动场所登记证（RELIGION_PLACES），其他证书/批文/证明（OTHER_REG_CERT）", "example" : "SOCIAL_ORG_LEGAL" }, "effect_time" : { "type" : "string", "description" : "证照生效时间", "example" : "1999-01-01" }, "expire_time" : { "type" : "string", "description" : "证照过期时间", "example" : "2020-11-01，长期有效时传“forever”" }, "legal_person_name" : { "type" : "string", "description" : "证照法人姓名", "example" : "李四" }, "merchant_name" : { "type" : "string", "description" : "证照商户名称", "example" : "新新饭店" }, "register_address" : { "type" : "string", "description" : "证照注册地址", "example" : "浙江省杭州市西湖区xxx街道xxx门牌号" } } }, "IndirectContactPersonInfo" : { "type" : "object", "properties" : { "contact_card_no" : { "type" : "string", "description" : "联系人身份证件号。\t可传身份证、港澳居民来往内地通行证、港澳居民居住证、台湾居民来往大陆通行证、台湾居民居住证、护照、外国人永久居住证等证件号码，号码枚举见contact_card_type。若传身份证，需保证18位，且英文字母大写", "example" : "233330199001010001" }, "contact_cert_type" : { "type" : "string", "description" : "联系人证件类型，枚举值：中国大陆居民-身份证(RESIDENT)、其他国家或地区居民-护照(PASSPORT)、中国港澳居民-来往内地通行证(PASSPORT_HK_MO)、中国台湾居民-来往大陆通行证(PASSPORT_TWN)、港澳居民居住证（RESIDENCE_PERMIT_HM）、台湾居民居住证（RESIDENCE_PERMIT_TW）、外国人永久居住证（PERMANENT_RESIDENCE_FOREIGNER）。个体户/企业/事业单位/社会组织：可选择任一证件类型。小微商户仅支持身份证类型。", "example" : "RESIDENT" }, "contact_name" : { "type" : "string", "description" : "联系人姓名", "example" : "张三" }, "contact_phone_no" : { "type" : "string", "description" : "联系人手机", "example" : "19999999999" } } }, "IndirectExtraCredentials" : { "type" : "object", "properties" : { "smid_list" : { "type" : "array", "description" : "待确认商户号列表，最多20个", "items" : { "type" : "string" }, "example" : "[\"2088000000000001\"]" } } }, "IndirectFinancialOrgInfo" : { "type" : "object", "properties" : { "financial_org_cert_img" : { "type" : "array", "description" : "金融机构许可证图片，最多五张（使用图片上传接口）", "items" : { "type" : "string" }, "example" : "[\"a5d373f6-3e79-405f-9993-fb7ea051c372.jpg\"]" }, "financial_org_type" : { "type" : "string", "description" : "银行业(BANK)、支付机构(PAYMENT)、保险业(INSURANCE)、交易及结算类金融机构(SETTLE)、OTHER(OTHER)", "example" : "PAYMENT" } } }, "IndirectLegalPersonInfo" : { "type" : "object", "properties" : { "auth_letter_img" : { "type" : "string", "description" : "授权函照片（使用图片上传接口），当证件持有人类型为 经办人时，必须上传。其他情况，无需上传", "example" : "a5d373f6-3e79-405f-9993-fb7ea051c372.jpg" }, "card_back_img" : { "type" : "string", "description" : "法人/经营者证件反面照（使用图片上传接口的image_id）。当证件类型为身份证时，此字段必传；当证件类型为非身份证时，此字段非必传。", "example" : "a5d373f6-3e79-405f-9993-fb7ea051c372.jpg" }, "card_front_img" : { "type" : "string", "description" : "法人/经营者证件正面照（使用图片上传接口返回的image_id）", "example" : "a5d373f6-3e79-405f-9993-fb7ea051c372.jpg" }, "card_no" : { "type" : "string", "description" : "证件号码", "example" : "233330199001010001" }, "card_type" : { "type" : "string", "description" : "证件类型，枚举值：中国大陆居民-身份证(RESIDENT)、其他国家或地区居民-护照(PASSPORT)、中国港澳居民-来往内地通行证(PASSPORT_HK_MO)、中国台湾居民-来往大陆通行证(PASSPORT_TWN)、港澳居民居住证（RESIDENCE_PERMIT_HM）、台湾居民居住证（RESIDENCE_PERMIT_TW）、外国人永久居住证（PERMANENT_RESIDENCE_FOREIGNER）。个体户/企业/事业单位/社会组织：可选择任一证件类型，政府机关、小微商户仅支持身份证类型。", "example" : "RESIDENT" }, "effect_time" : { "type" : "string", "description" : "证件生效时间", "example" : "1999-01-01" }, "expire_time" : { "type" : "string", "description" : "证件过期时间", "example" : "2000-11-01，长期有效时传“forever”" }, "is_benefit_person" : { "type" : "boolean", "description" : "经营者/法人是否为受益人", "example" : "true" }, "legal_type" : { "type" : "string", "description" : "证件持有人类型：\t- 法人 LEGAL_PERSON\t- 经办人 AGENT_PERSON\t主体类型为政府机关、事业单位时选传：\t（1）若上传的是法人证件，则不需要上传该字段。\t（2）若因特殊情况，无法提供法人证件时，可上传经办人。\t主体类型为企业、个体户、社会组织、小微商户时，默认为经营者/法人，不需要上传该字段。", "example" : "LEGAL_PERSON" }, "person_name" : { "type" : "string", "description" : "法人姓名", "example" : "李四" } } }, "IndirectQualificationInfo" : { "type" : "object", "properties" : { "image_list" : { "type" : "array", "description" : "行业经营许可证资质照片，一个行业类目下最多上传6张资质照片（使用图片上传接口）", "items" : { "type" : "string" }, "example" : "[\"a5d373f6-3e79-405f-9993-fb7ea051c372.jpg\"]" }, "mcc_code" : { "type" : "string", "description" : "行业类目编号，支付宝商家行业二级类目code", "example" : "B0001" } } }, "IndirectSupportCredentials" : { "type" : "object", "properties" : { "city" : { "type" : "string", "description" : "球房城市", "example" : "杭州市" }, "city_code" : { "type" : "string", "description" : "球房市行政区号（数字）", "example" : "3310303" }, "district" : { "type" : "string", "description" : "球房街道", "example" : "西湖区留下街道" }, "district_code" : { "type" : "string", "description" : "球房街道区号（数字）", "example" : "3301000" }, "merchant_type" : { "type" : "string", "description" : "小微商户经营类型，枚举值：球房场所（STORE）、流动经营（STALL）", "example" : "STORE" }, "province" : { "type" : "string", "description" : "球房省份", "example" : "浙江省" }, "province_code" : { "type" : "string", "description" : "球房省行政区号（数字", "example" : "330100" }, "store_address" : { "type" : "string", "description" : "球房场所填写球房详细地址，流动经营类型填“无”", "example" : "xxx街道xxx门牌号" }, "store_door_img" : { "type" : "string", "description" : "球房门头照信息或摊位照（使用图片上传接口）", "example" : "a5d373f6-3e79-405f-9993-fb7ea051c372.jpg" }, "store_inner_img" : { "type" : "string", "description" : "球房店内照片或者摊位照侧面（使用图片上传接口）", "example" : "a5d373f6-3e79-405f-9993-fb7ea051c372.jpg" }, "store_name" : { "type" : "string", "description" : "球房名称", "example" : "新新饭店" } } }, "IndustryQualificationInfo" : { "type" : "object", "properties" : { "industry_qualification_image" : { "type" : "string", "description" : "商户行业资质图片。其值为使用ant.merchant.expand.indirect.image.upload上传图片得到的一串oss key" }, "industry_qualification_type" : { "type" : "string", "description" : "商户行业资质类型，具体选值参见，进件MCC与资质要求 202212.xlsx中特殊资质栏" } } }, "Instance" : { "type" : "object", "properties" : { "create_time" : { "type" : "string", "description" : "?创建时间", "example" : "2020-11-10 21:07:00" }, "creator_id" : { "type" : "string", "description" : "创建人id", "example" : "2018051101015016" }, "description" : { "type" : "string", "description" : "部门描述", "example" : "我是描述信息" }, "external_id" : { "type" : "string", "description" : "外部id", "example" : "939459821" }, "id" : { "type" : "string", "description" : "部门id（即租户实例ID、数据权限ID）", "example" : "pYv_gs0m" }, "name" : { "type" : "string", "description" : "租户实例（数据权限）名称", "example" : "XXX租户实例" }, "status" : { "type" : "string", "description" : "租户实例（数据权限）状态，所有可能的状态如下：INIT（初始化）、STARTED（准备完成）、START_FAILED（准备失败）、STOPPING（停用中）、STOPPED（已停用）、RELEASING（释放中）、RELEASED（已释放）、RESUMING（重新启动）、MODIFING（修改规格中）、DELETED（已删除）。", "example" : "STARTED" }, "update_time" : { "type" : "string", "description" : "最后修改时间", "example" : "2020-11-10 21:11:00" }, "updater_id" : { "type" : "string", "description" : "最后修改人id", "example" : "2018051101015016" } } }, "InstitutionBasicInfo" : { "type" : "object", "properties" : { "consult_mode" : { "type" : "string", "description" : "费控咨询模式", "example" : "0" }, "effective" : { "type" : "string", "description" : "制度是否启用", "example" : "1" }, "effective_end_date" : { "type" : "string", "description" : "制度生效结束时间", "example" : "2023-07-05 23:59:59" }, "effective_start_date" : { "type" : "string", "description" : "制度生效起始时间", "example" : "2022-07-04 00:00:00" }, "institution_desc" : { "type" : "string", "description" : "制度描述", "example" : "工作餐制度" }, "institution_id" : { "type" : "string", "description" : "制度id", "example" : "2023042600152617860000076000" }, "institution_name" : { "type" : "string", "description" : "制度名称", "example" : "餐补制度" } } }, "InteligentBudgetInfo" : { "type" : "object", "properties" : { "budget_total" : { "type" : "string", "description" : "预算数量", "example" : "999999" }, "budget_type" : { "type" : "string", "description" : "预算类型，枚举（QUANTITY：数量预算）", "example" : "QUANTITY" } } }, "InteligentClauseTerm" : { "type" : "object", "properties" : { "descriptions" : { "type" : "array", "description" : "说明描述内容", "items" : { "type" : "string" }, "example" : "说明描述内容" }, "title" : { "type" : "string", "description" : "说明title", "example" : "说明title" } } }, "InteligentConstraintInfo" : { "type" : "object", "properties" : { "crowd_group_id" : { "type" : "string", "description" : "人群组id，目前只支持返回时带出。", "example" : "34324224" }, "item_ids" : { "type" : "string", "description" : "单品码列表\r\t仅在创建消费单品送活动时设置，最多设置500个单品码,由商户根据自己的商品管理自定义，一般为国标码", "example" : "212313,221322" }, "min_cost" : { "type" : "string", "description" : "最低消费金额，单位元\r\t仅在创建消费送礼包活动时设置", "example" : "100" }, "suit_shops" : { "type" : "array", "description" : "活动适用的球房列表\r\t仅品牌商发起的招商活动可为空\r\t最多支持10w家球房", "items" : { "type" : "string" }, "example" : "2015110600077000000002125023,2015110600077000000002125022" }, "user_win_count" : { "type" : "string", "description" : "活动期间用户能够参与的次数限制\r\t如果不设置则不限制参与次数", "example" : "1" }, "user_win_frequency" : { "type" : "string", "description" : "活动期间用户能够参与的频率限制\r\t如果不设置则不限制参与频率\r\t每日中奖1次: D||1 \r\t每周中奖2次: W||2 \r\t每月中奖3次: M||3", "example" : "D||3" } } }, "InteligentDataCondition" : { "type" : "object", "properties" : { "data_type" : { "type" : "string", "description" : "数据类型，支持枚举：文本：STRING；数值：NUMBER；长整型：LONG；浮点型：DOUBLE；日期：DATE；布尔：BOOLEAN；金额：MONEY", "example" : "NUMBER" }, "limit_type" : { "type" : "string", "description" : "数据限制类型，支持枚举：固定值：FIX；单选值：SELECT；区间值：RANGE;", "example" : "RANGE" }, "value" : { "type" : "string", "description" : "数据格式值；如：范围值:(1,10)，固定值:1", "example" : "(1,10)" } } }, "InteligentDelayInfo" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "延迟类型，目前支持以下类型\r\tABSOLUTELY：按绝对值延迟\r\tBYDAY：按天延迟", "example" : "ABSOLUTELY" }, "value" : { "type" : "string", "description" : "延迟值，单位分钟\r\t按绝对值延迟延迟24*60 (1天)表示，当日08:00:00领到的券要到隔日的08:00:00才能使用\r\t按天延迟延迟24*60(1天)表示，当日08:00:00领到的券，隔日00:00:00点就可以用", "example" : "1440" } } }, "InteligentDisplayConfig" : { "type" : "object", "properties" : { "slogan" : { "type" : "string", "description" : "券的宣传语\r\t含圈人的直领活动，且投放渠道选择了支付成功页或店铺的情况下必填", "example" : "券的宣传语" }, "slogan_img" : { "type" : "string", "description" : "券的宣传图片文件ID\r\t含圈人的直领活动，且投放渠道选择了店铺的情况下必填", "example" : "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC" } } }, "InteligentForbiddenTime" : { "type" : "object", "properties" : { "days" : { "type" : "string", "description" : "不可用日期区间，仅支持到天\r\t不可用区间起止日期用逗号分隔，多个区间之间用^分隔\r\t如\"2016-05-01,2016-05-03^2016-10-01,2016-10-07\"表示2016年5月1日至5月3日，10月1日至10月7日券不可用", "example" : "2016-03-03,2016-03-08^2016-10-01,2016-10-01" } } }, "InteligentGeneralMerchantPromo" : { "type" : "object", "properties" : { "camp_id" : { "type" : "string", "description" : "营销活动的id，如merchant_promo_type：CONSUME_SEND即消费送的活动id", "example" : "20170901000000000006913911002170" }, "crowd_constraint" : { "$ref" : "#/components/schemas/CrowdConstraintInfo" }, "desc" : { "type" : "string", "description" : "活动描述信息，该信息有可能会在店铺详情页漏出，请自己填写", "example" : "本店酒水不参与该活动" }, "ext_info" : { "type" : "string", "description" : "活动扩展信息", "example" : "{\\\"key\\\":\\\"value\\\"}" }, "forecast_effect" : { "$ref" : "#/components/schemas/IntelligentPromoEffect" }, "inteligent_budget" : { "$ref" : "#/components/schemas/InteligentBudgetInfo" }, "inteligent_constraint" : { "$ref" : "#/components/schemas/InteligentConstraintInfo" }, "inteligent_promo_tools" : { "type" : "array", "description" : "营销工具集合。主要是活动涉及到的奖品信息", "items" : { "$ref" : "#/components/schemas/InteligentPromoTool" } }, "inteligent_publish_channels" : { "type" : "array", "description" : "投放渠道信息", "items" : { "$ref" : "#/components/schemas/InteligentPublishChannel" } }, "merchant_promo_type" : { "type" : "string", "description" : "营销活动类型；枚举（DIRECT_SEND：直发奖；CONSUME_SEND：消费送）", "example" : "CONSUME_SEND" }, "name" : { "type" : "string", "description" : "营销活动名称", "example" : "消费满100送20元代金券" }, "template_id" : { "type" : "string", "description" : "子营销活动对应的模板id", "example" : "20170909000000000012931911002490" } } }, "InteligentItemInfo" : { "type" : "object", "properties" : { "item_ids" : { "type" : "array", "description" : "券适用的单品码列表\r\t最少配置1个单品码\r\t最多配置500个单品码", "items" : { "type" : "string" }, "example" : "0000123,0000124" }, "item_imgs" : { "type" : "array", "description" : "单品图片列表\r\t单品图片不能超过3张", "items" : { "type" : "string" }, "example" : "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC" }, "item_link" : { "type" : "string", "description" : "单品券详细介绍跳转链接", "example" : "www.taobao.com" }, "item_name" : { "type" : "string", "description" : "单品名称", "example" : "单品名称" }, "item_text" : { "type" : "string", "description" : "单品券说明", "example" : "单品券说明" }, "max_discount_num" : { "type" : "string", "description" : "单品券适用的商品列表中，每一个商品最高可享受优惠的件数； \r\t如：券适用于A,B两种商品，该字段设置为1，则用券A,B两种商品每种最多只有一件可享受优惠；", "example" : "1" }, "min_consume_num" : { "type" : "string", "description" : "单品券适用商品列表中，每种商品享受优惠最低购买件数的门槛；\r\t如：券适用于A,B两种商品，该字段设置为3，则A,B两种商品每种最少需要购买3件才可享受优惠；", "example" : "1" }, "original_price" : { "type" : "string", "description" : "单品的原价，单位元\r\t必须为合法金额类型字符串，如9.99", "example" : "28.88" }, "sku_min_consume" : { "type" : "string", "description" : "券适用SKU的最低消费金额门槛\r\t如券适用A,B两个SKU，该字段设置的值为100，则订单中购买A,B两个SKU的合计金额需大于100元才可用券", "example" : "10" }, "total_max_discount_num" : { "type" : "string", "description" : "如果一个单品券适用A，B，C三个单品，若设置了该字段为2，则在一笔交易中，A，B，C三个单品加起来最多只有俩件能够享受优惠", "example" : "10" } } }, "InteligentMerchantPromo" : { "type" : "object", "properties" : { "general_promo" : { "$ref" : "#/components/schemas/InteligentGeneralMerchantPromo" }, "promo_type" : { "type" : "string", "description" : "子活动营销类型；枚举值：（GENERAL_MERCHANT：商户自运营活动）", "example" : "GENERAL_MERCHANT" } } }, "InteligentPromoTool" : { "type" : "object", "properties" : { "inteligent_send_rule" : { "$ref" : "#/components/schemas/InteligentSendRule" }, "inteligent_voucher" : { "$ref" : "#/components/schemas/InteligentVoucher" }, "status" : { "type" : "string", "description" : "单个营销工具的生效状态，当在招商部分券失效后会使用这个字段", "example" : "STARTED" }, "voucher_no" : { "type" : "string", "description" : "营销工具uid,创建营销活动时无需设置", "example" : "2342343245234234" } } }, "InteligentPublishChannel" : { "type" : "object", "properties" : { "config" : { "type" : "string", "description" : "当type为MERCHANT_CROWD时，config需填入口令送的密码和图片，样例如下：\"config\":\"{\\\"PASSWORD\\\":\\\"口令送密码\\\",\\\"BACKGROUND_LOGO\\\":\\\"1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC\\\"}\"", "example" : "\"PASSWORD\":\"口令送密码\",\"BACKGROUND_LOGO\":\"1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC\"" }, "ext_info" : { "type" : "string", "description" : "扩展信息，无需配置", "example" : "\"key\":\"value\"" }, "name" : { "type" : "string", "description" : "渠道名称", "example" : "投放到店铺" }, "type" : { "type" : "string", "description" : "渠道类型，目前支持以下类型：\r\tQR_CODE：二维码投放；\r\tSHORT_LINK：短连接投放；\r\tSHOP_DETAIL：店铺页投放；\r\tPAYMENT_RESULT：支付成功页；\r\tMERCHANT_CROWD：口令送；\r\tURL_WITH_TOKEN：外部发奖活动，\r\t只有活动类型为DIRECT_SEND时才支持；", "example" : "SHOP_DETAIL" } } }, "InteligentSendRule" : { "type" : "object", "properties" : { "allow_repeat_send" : { "type" : "string", "description" : "是否允许重复发奖：\r\ttrue代表允许，false代表不允许\r\t默认不设置，表明用户领取券后如果没有核销则不允许再次领取券\r\t如果设置为true，表明如果用户领取券后没有核销，还可以继续领取该券", "example" : "true" }, "min_cost" : { "type" : "string", "description" : "发券最低消费金额，单位元\r\t活动类型为消费送且不是消费送礼包时设置\r\t多营销工具之间不允许设置重复值", "example" : "100" }, "send_budget" : { "type" : "string", "description" : "券的预算数量（仅对口令送随机抽奖有效，即当活动类型为GUESS_SEND，且营销工具PromoTool的个数大于1时，此字段必填，其余情况此字段必为空）", "example" : "1234" }, "send_num" : { "type" : "string", "description" : "发券数目\r\t最少发1张券，最多发5张券", "example" : "1" } } }, "InteligentUseRule" : { "type" : "object", "properties" : { "inteligent_forbidden_time" : { "$ref" : "#/components/schemas/InteligentForbiddenTime" }, "inteligent_use_times" : { "type" : "array", "description" : "券可用时间段", "items" : { "$ref" : "#/components/schemas/InteligentUseTime" } }, "limit_rule" : { "type" : "string", "description" : "优惠券的使用支付渠道限制规\r\t则，\r\t不受支付渠道限制\r\t:USE_NO_LIMIT;\r\t仅限口碑储值卡支付时可用\r\t:USE_ON_CURRENT_PAY_C\r\tHANNEL;\r\t口碑储值卡支付时不可用\r\t:NOT_ALLOWED_USE;\r\t【备注】支付渠道限制不允许修改", "example" : "USE_NO_LIMIT" }, "min_consume" : { "type" : "string", "description" : "券核销的最低消费门槛，单位元", "example" : "10" }, "min_consume_condition" : { "$ref" : "#/components/schemas/InteligentDataCondition" }, "pay_redirect_url" : { "type" : "string", "description" : "券买单跳转链接", "example" : "https://mycar-parkingplatform.alipay-eco.com/pbizplatform/park/parking/stayPayCarList?entrance=1" }, "suit_shops" : { "type" : "array", "description" : "券适用球房列表\r\t仅品牌商发起的招商活动可为空\r\t直发奖类型活动必须与活动适用球房一致\r\t最多支持10w家球房", "items" : { "type" : "string" }, "example" : "2015110600077000000002125023,2015110600077000000002125022" } } }, "InteligentUseTime" : { "type" : "object", "properties" : { "dimension" : { "type" : "string", "description" : "券可用时段时间维度，目前支持周(W)", "example" : "W" }, "times" : { "type" : "string", "description" : "券可用时间段\r\t可用时间段起止时间用逗号分隔，多个时间段之间用^分隔\r\t如, \"16:00:00,20:00:00^21:00:00,22:00:00\"表示16点至20点，21点至22点可用\r\t时间段不可重叠", "example" : "16:00:00,20:00:00^21:00:00,22:00:00" }, "values" : { "type" : "string", "description" : "券可用时间维度值\r\t周维度的取值范围1-7(周一至周日)，多个可用时段用逗号分隔\r\t如\"1,3,5\"，对应周一，周三，周五可用", "example" : "1,3,5" } } }, "InteligentVoucher" : { "type" : "object", "properties" : { "brand_name" : { "type" : "string", "description" : "品牌名称", "example" : "品牌名称" }, "desc" : { "type" : "string", "description" : "券详细说明\r\t最多包含500个字符", "example" : "券的详细说明" }, "donate_flag" : { "type" : "string", "description" : "券是否可转赠，默认为可转赠", "example" : "true" }, "effect_type" : { "type" : "string", "description" : "券生效的方式，目前支持以下方式\r\t立即生效：IMMEDIATELY\r\t延迟生效：DELAY\r\t仅在券有效期类型为相对有效期时生效", "example" : "IMMEDIATELY" }, "end_time" : { "type" : "string", "description" : "券有效期的结束时间\r\t仅在券有效期类型为绝对有效期时生效\r\t必须晚于活动结束时间", "example" : "2016-11-01 00:00:00" }, "ext_info" : { "type" : "string", "description" : "券的扩展信息", "example" : "\"key\":\"value\"" }, "inteligent_clause_terms" : { "type" : "array", "description" : "券的说明条款", "items" : { "$ref" : "#/components/schemas/InteligentClauseTerm" } }, "inteligent_delay_info" : { "$ref" : "#/components/schemas/InteligentDelayInfo" }, "inteligent_desc_detail_list" : { "type" : "array", "description" : "券使用说明描述列表", "items" : { "$ref" : "#/components/schemas/InteligentVoucherDescDetail" } }, "inteligent_display_config" : { "$ref" : "#/components/schemas/InteligentDisplayConfig" }, "inteligent_item_info" : { "$ref" : "#/components/schemas/InteligentItemInfo" }, "inteligent_use_rule" : { "$ref" : "#/components/schemas/InteligentUseRule" }, "logo" : { "type" : "string", "description" : "券LOGO文件ID，调用图片上传接口alipay.offline.material.image.upload获得", "example" : "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC" }, "max_amount" : { "type" : "string", "description" : "最高优惠金额，单位元\r\t指用券最高可以优惠的金额\r\t必须为合法金额类型字符串仅当券类型为折扣券（RATE），每满减券（PER_FULL_CUT）有效", "example" : "100" }, "multi_use_mode" : { "type" : "string", "description" : "券叠加的属性，\r\t仅全场券可设置该选项；\r\tNO_MULTI:不可与其他全场券和单品券叠加;\r\tMULTI_USE_WITH_SINGLE:\r\t该全场优惠和单品优惠的叠加\r\t；MULTI_USE_WITH_OTHE\r\tRS:该全场优惠和其他所有优惠都可以叠加", "example" : "NO_MULTI" }, "name" : { "type" : "string", "description" : "券名称", "example" : "5元代金券" }, "rate" : { "type" : "string", "description" : "折扣率\r\t仅当券类型为折扣券时有效\r\t有效折扣率取值范围0.11-0.99\r\t仅允许保留小数点后两位", "example" : "0.8" }, "relative_time" : { "type" : "string", "description" : "券相对有效期，单位天\r\t仅在券有效期类型为相对有效期时生效\r\t如，设5表示领券领取后5日内有效", "example" : "1" }, "rounding_rule" : { "type" : "string", "description" : "券核销时，抹零方式，目前支持：\r\tNOT_AUTO_ROUNDING:不自动抹零\r\tAUTO_ROUNDING_YUAN:自动抹零到元\r\tAUTO_ROUNDING_JIAO:自动抹零到角\r\tROUNDING_UP_YUAN:四舍五入到元\r\tROUNDING_UP_JIAO:四舍五入到角", "example" : "NOT_AUTO_ROUNDING" }, "start_time" : { "type" : "string", "description" : "券有效期的开始时间\r\t仅在券有效期类型为绝对有效期时生效", "example" : "2016-05-01 00:00:00" }, "type" : { "type" : "string", "description" : "券类型，目前支持以下类型：\r\tMONEY：代金券；\r\tPER_FULL_CUT：每满减券", "example" : "MONEY" }, "use_instructions" : { "type" : "array", "description" : "券的使用说明\r\t使用须知最多6条，且每条最多100字", "items" : { "type" : "string" }, "example" : "券的使用说明" }, "validate_type" : { "type" : "string", "description" : "券有效期类型，目前支持以下类型：\r\tRELATIVE：相对有效期\r\tFIXED：绝对有效期", "example" : "FIXED" }, "verify_mode" : { "type" : "string", "description" : "该字段仅在兑换券条件下(即券类型为EXCHANGE)，用于设置兑换券的核销方式\r\tUSER_CLICK:用户自己点击券上的按钮核销\r\tMERCHANT_SCAN：商户通过APP扫码核销\r\t其他情况下此字段为空", "example" : "MERCHANT_SCAN" }, "voucher_img" : { "type" : "string", "description" : "券图片文件ID,调用上传图片接口alipay.offline.material.image.upload获得", "example" : "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC" }, "voucher_note" : { "type" : "string", "description" : "券的备注\r\t\r\t用于收银系统识别指定券使用；如备注中传入“123”，券发出后核销时将在当面付接口将该值传回，供收银系统识别", "example" : "券的备注" }, "worth_value" : { "type" : "string", "description" : "券面额，单位元必须为合法金额类型字符串券类型为代金券（MONEY）、减至券（REDUCETO）、每满减券（PER_FULL_CUT）时必填\r\t如：\r\t代金券：10元代金券中的10为券面额；\r\t每满减券：毎满100减10元，其中的10为券面额；\r\t减至券：单品原价100，现价10元，其中10为券面额，单品减至券的券面额必须低于单品原价", "example" : "10" } } }, "InteligentVoucherDescDetail" : { "type" : "object", "properties" : { "details" : { "type" : "string", "description" : "具体描述信息列表", "example" : "周一到周五可用" }, "images" : { "type" : "string", "description" : "图片描述信息", "example" : "https://dl.django.t.taobao.com/rest/1.0/image?fileIds=RY7twkJVR26nz8OeXRIjvAAAACMAAQED&zoom=original" }, "title" : { "type" : "string", "description" : "券说明的标题", "example" : "温馨提示" }, "url" : { "type" : "string", "description" : "券外部详情描述", "example" : "www.alipay.com" } } }, "IntelligentPromo" : { "type" : "object", "properties" : { "allow_auto_delay" : { "type" : "boolean", "description" : "是否允许自动续期", "example" : "true" }, "audit_status" : { "type" : "string", "description" : "审批状态。APPROVING：审批中；REJECTED：已驳回；PASS：已通过；（注意：修改接口无需传递审批状态）", "example" : "APPROVING" }, "create_request_no" : { "type" : "string", "description" : "请求幂等控制请求参数，该参数尽量比较复杂，建议使用uuid，否则触发幂等返回。", "example" : "7582ee4522934431bd45ae68616744b6" }, "creator_info" : { "$ref" : "#/components/schemas/PromoOperatorInfo" }, "desc" : { "type" : "string", "description" : "智能活动描述", "example" : "这是一个全场智能营销活动，仅在上海地区使用" }, "ext_info" : { "type" : "string", "description" : "活动扩展信息，通过《koubei.marketing.campaign.intelligent.promo.consult智能方案咨询接口》推荐出的方案扩展信息字段，调用《koubei.marketing.campaign.intelligent.promo.create创建智能方案》接口必须要原路带回，不能删减字段。", "example" : "{\\\"PARTNER_CATEGORY\\\":\\\"2015050700000002\\\",\\\"PROMO_REC_LOG\\\":\\\"20170919000000000195431911009130\\\"}" }, "forecast_effect" : { "$ref" : "#/components/schemas/IntelligentPromoEffect" }, "gmt_closed" : { "type" : "string", "description" : "智能营销活动下架的时间", "example" : "2016-05-01 00:00:00" }, "gmt_enabled" : { "type" : "string", "description" : "智能营销活动的生效时间", "example" : "2016-05-01 00:00:00" }, "gmt_end" : { "type" : "string", "description" : "智能营销活动的结束时间", "example" : "2016-05-01 00:00:00" }, "gmt_start" : { "type" : "string", "description" : "智能营销活动开始时间", "example" : "2016-05-01 00:00:00" }, "merchant_promos" : { "type" : "array", "description" : "智能营销商户子活动列表", "items" : { "$ref" : "#/components/schemas/InteligentMerchantPromo" } }, "name" : { "type" : "string", "description" : "智能营销活动对应的名称", "example" : "全场智能营销活动" }, "owner_info" : { "$ref" : "#/components/schemas/PromoOperatorInfo" }, "parent_promo_id" : { "type" : "string", "description" : "智能营销方案父id，如果需要续签智能营销活动，则会对于原有智能营销方案的id", "example" : "20171001000000000286566911004880" }, "plan_id" : { "type" : "string", "description" : "智能营销活动对应的方案编号", "example" : "20170901000000000007027911001170" }, "promo_id" : { "type" : "string", "description" : "智能营销方案id。《koubei.marketing.campaign.intelligent.promo.create》创建接口中这个参数不必传递，仅在查询接口中返回", "example" : "20170905000000000092980911009880" }, "promos" : { "type" : "array", "description" : "营销活动详情列表，注意：（该参数20180125开始已不在维护，替代参数详见merchant_promos，如需接入替代参数，接之前先找开发负责人申请appid白名单）", "items" : { "$ref" : "#/components/schemas/IntelligentPromoDetail" } }, "status" : { "type" : "string", "description" : "智能营销活动状态。CREATED：已创建；ENABLED：已生效；CLOSED：已关闭；FINISHED：已完结；DISABLED:已失效（有两种情况会是失效状态，一种是服务商创建方案，商户驳回，一种是服务商创建方案，商户未确认，活动到期。）（注意：修改方案的动作不需要传递方案状态）", "example" : "CREATED" }, "sub_promo_ids" : { "type" : "array", "description" : "该智能营销方案如果续签多次，则会返回该方案对应的所有智能营销子方案的promo_id", "items" : { "type" : "string" }, "example" : "[2016110700077000000003446037, 2016111000077000000003446529]" }, "sub_status" : { "type" : "string", "description" : "活动展示状态。已创建：CREATED；\r\tREJECTED：创建被驳回；ENABLING：生效中；ONLINE_WAIT_CONFIRM：上架待确认；PUBLISHED：已发布（活动未到开始时间）；ENABLED：已发布已开始；OFFLINE_WAIT_CONFIRM：下架待确认；CLOSING：下架中；CLOSED：已下架（人为干预下架）；FINISHED：已结束（活动到期自然结束）；MODIFYING：修改中；MODIFY_WAIT_CONFIRM：修改待确认；DISABLED：已失效\r\t（注意：修改接口子状态参数不能传递）", "example" : "ENABLING" }, "template_id" : { "type" : "string", "description" : "智能营销活动对应的方案中的模板编号", "example" : "20170901000000000006914911002170" }, "type" : { "type" : "string", "description" : "智能活动类型，值如下：RECOMMENDATION：系统推荐；REGISTRATION：报名。在创建时，这个字段需要ISV自己进行决策，在推荐接口会返回优惠力度，比如代金券面额等信息，ISV判断如果优惠力度比这个大或者相同，就用RECOMMENDATION，其他情况用REGISTRATION，如推荐力度大于实际创建传过来的优惠力度，则创建的时候系统会自动将RECOMMENDATION改为REGISTRATION", "example" : "RECOMMENDATION" } } }, "IntelligentPromoDetail" : { "type" : "object", "properties" : { "budget" : { "$ref" : "#/components/schemas/BudgetInfo" }, "camp_id" : { "type" : "string", "description" : "营销活动的id，也就是消费送的活动id", "example" : "20170901000000000006913911002170" }, "constraint" : { "$ref" : "#/components/schemas/ConstraintInfo" }, "crowd_constraint" : { "$ref" : "#/components/schemas/CrowdConstraintInfo" }, "desc" : { "type" : "string", "description" : "智能营销活动的子活动", "example" : "这是一个全场消费送的活动" }, "ext_info" : { "type" : "string", "description" : "活动扩展信息", "example" : "{\\\"key\\\":\\\"value\\\"}" }, "forecast_effect" : { "$ref" : "#/components/schemas/IntelligentPromoEffect" }, "merchant_promo_type" : { "type" : "string", "description" : "自运营活动类型。DIRECT_SEND：直发奖；CONSUME_SEND：消费送", "example" : "DIRECT_SEND" }, "name" : { "type" : "string", "description" : "子营销活动名称", "example" : "全场消费送活动" }, "promo_tools" : { "type" : "array", "description" : "营销工具集合。主要是活动涉及到的奖品信息", "items" : { "$ref" : "#/components/schemas/PromoTool" } }, "publish_channels" : { "type" : "array", "description" : "投放渠道信息", "items" : { "$ref" : "#/components/schemas/PublishChannel" } }, "template_id" : { "type" : "string", "description" : "子营销活动对应的模板id", "example" : "20170901000000000006912911002170" } } }, "IntelligentPromoEffect" : { "type" : "object", "properties" : { "avg_prize_increase" : { "type" : "string", "description" : "平均客单价提升比例" }, "cost" : { "type" : "string", "description" : "成本" }, "current_total_amount" : { "type" : "string", "description" : "当前效益" }, "effect_id" : { "type" : "string", "description" : "营销活动的预期效果id" }, "gmt_from" : { "type" : "string", "description" : "时间范围左值" }, "gmt_to" : { "type" : "string", "description" : "时间范围右值" }, "gmv" : { "type" : "string", "description" : "成交额" }, "remain_stock_num" : { "type" : "integer", "description" : "剩余库存数" }, "repay_rate_increase" : { "type" : "string", "description" : "复购率提升比例" }, "send_count_increase" : { "type" : "string", "description" : "发券量提升比例" }, "take_count" : { "type" : "integer", "description" : "发券数量" }, "type" : { "type" : "string", "description" : "营销活动效果类型。FORECAST：预估；STATISTICS：统计" }, "use_count" : { "type" : "integer", "description" : "核销量" } } }, "IntelligentPromoShopSummaryInfo" : { "type" : "object", "properties" : { "shop_id" : { "type" : "string", "description" : "球房id", "example" : "20543566463464565" }, "shop_name" : { "type" : "string", "description" : "全店名", "example" : "大娘水饺(万塘路店)" } } }, "InterfaceInfoList" : { "type" : "object", "properties" : { "interface_name" : { "type" : "string", "description" : "H5传入参数固定值：alipay.eco.mycar.parking.userpage.query;\t\t小程序传入参数固定值：alipay.eco.mycar.parking.isv.homepage;\t\t协议状态变更通知传入参数固定值：\talipay.eco.mycar.parking.agreement.notify;" }, "interface_type" : { "type" : "string", "description" : "H5、小程序传入参数固定值:interface_page；\t通知接口传入参数固定值:interface_service;" }, "interface_url" : { "type" : "string", "description" : "H5 SPI接口的调用地址url，协议必须为https，对整个url字符串必须进行UrlEncode编码。编码为UTF-8;\t\t小程序SPI接口的调用地址ur格式：小程序|小程序缴费页面地址;\t\t协议状态变更通知SPI接口的调用地址url，同H5格式;" } } }, "InviteMemberBusinessParamsDTO" : { "type" : "object", "properties" : { "employee_id" : { "type" : "string", "description" : "企业员工工卡", "example" : "983748293742" }, "fund_ext_info" : { "$ref" : "#/components/schemas/FundExtInfo" }, "group_id_list" : { "type" : "array", "description" : "员工关联的群组ID，当前系统仅支持一个", "items" : { "type" : "string" }, "example" : "[\"11\"]" } } }, "InviteResultDTO" : { "type" : "object", "properties" : { "identity" : { "type" : "string", "description" : "（被邀请人）用户唯一标识
\t补充说明：
\t- 该字段与签约接口alipay.fund.jointaccount.sign请求参数中传入值保持一致", "example" : "2088000268032234" }, "identity_type" : { "type" : "string", "description" : "（被邀请人）账号类型，参考值如下：
\t- OUT_USER_ID：商户侧用户唯一标识
\t补充说明：\t- 该字段与签约接口alipay.fund.jointaccount.sign请求参数中传入值保持一致", "example" : "ALIPAY_USER_ID" }, "process_id" : { "type" : "string", "description" : "审批单号，不同被邀请人之间的审批单号不同（支付宝侧生成）", "example" : "2021082066102300080000002126" } } }, "Invoice" : { "type" : "object", "properties" : { "email" : { "type" : "string", "description" : "邮箱地址", "example" : "123@123.com" }, "invoice_content" : { "type" : "string", "description" : "发票内容，配送服务费", "example" : "40" }, "invoice_fee" : { "type" : "string", "description" : "发票金额", "example" : "100" }, "invoice_title" : { "type" : "string", "description" : "发票抬头，如支付宝（杭州）信息技术有限公司", "example" : "支付宝（杭州）信息技术有限公司" }, "invoice_type" : { "type" : "integer", "description" : "发票类型，0：默认电子发票", "example" : "0" }, "phone" : { "type" : "string", "description" : "手机号码", "example" : "15171008605" }, "receiver" : { "type" : "string", "description" : "收件人姓名", "example" : "语轩" }, "tax_number" : { "type" : "string", "description" : "税号", "example" : "9133 0106 MA27 Y4U4 7R" }, "title_type" : { "type" : "integer", "description" : "抬头类型，0：企业单位，1：个人/非企业", "example" : "0" } } }, "InvoiceContentInfo" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "含税金额", "example" : "200" }, "item_name" : { "type" : "string", "description" : "发票项目名称/货物名称", "example" : "无" }, "item_no" : { "type" : "string", "description" : "商品编码/税收分类编码", "example" : "无" }, "item_unit" : { "type" : "string", "description" : "单位", "example" : "无" }, "price" : { "type" : "string", "description" : "单价", "example" : "100" }, "quantity" : { "type" : "string", "description" : "商品数量", "example" : "1" }, "row_type" : { "type" : "string", "description" : "发票行性质。0表示正常行，1表示折扣行，2表示被折扣行", "example" : "0" }, "specification" : { "type" : "string", "description" : "规格型号", "example" : "无" }, "sum_price" : { "type" : "string", "description" : "不含税金额", "example" : "150" }, "tax" : { "type" : "string", "description" : "税额", "example" : "40" }, "tax_rate" : { "type" : "string", "description" : "税率", "example" : "无" }, "zero_rate_flag" : { "type" : "string", "description" : "税率标识，只有税率为0的情况才有值，0=出口零税率，1=免税，2=不征收，3=普通零税率", "example" : "3" } } }, "InvoiceElementModel" : { "type" : "object", "properties" : { "expense_status" : { "type" : "string", "description" : "发票报销状态\r\t取值范围：\r\tWAIT_EXPENSE－未报销\r\tEXPENSE_PROCESSING－报销中\r\tEXPENSE_FINISHED－已报销" }, "extend_fields" : { "type" : "string", "description" : "扩展字段" }, "fake_code" : { "type" : "string", "description" : "防伪校验码" }, "has_pdf_file" : { "type" : "boolean", "description" : "发票是否有pdf文件" }, "has_risk" : { "type" : "boolean", "description" : "该发票可能存在异常，请核实后使用\r\ttrue:无异常\r\tfalse:存在异常" }, "invoice_amount" : { "type" : "string", "description" : "发票金额，含税" }, "invoice_code" : { "type" : "string", "description" : "发票代码" }, "invoice_date" : { "type" : "string", "description" : "开票日期" }, "invoice_img_url" : { "type" : "string", "description" : "发票pdf文件转换后jpg预览地址" }, "invoice_kind" : { "type" : "string", "description" : "发票类型\t可选值\tPLAIN：增值税电子普通发票\tSPECIAL：增值税专用发票\tALL_ELECTRONIC_GENERAL： \"电子发票（普通发票）\tALL_ELECTRONIC_SPECIAL： \"电子发票（专用发票）\tPLAIN_INVOICE:增值税普通发票\tPAPER_INVOICE:增值税普通发票（卷式）\tSALSE_INVOICE:机动车销售统一发票\t财政电子票据：FINANCIAL_ELECTRONIC_BILL" }, "invoice_no" : { "type" : "string", "description" : "发票号码" }, "invoice_status" : { "type" : "string", "description" : "发票状态　\r\t取值范围\r\tSUCCEED－正常蓝票\r\tEXPIRED－已失效" }, "isv_contact" : { "type" : "string", "description" : "服务商联系方式" }, "isv_name" : { "type" : "string", "description" : "服务商名称" }, "logo_url" : { "type" : "string", "description" : "logo地址" }, "m_name" : { "type" : "string", "description" : "商户全称" }, "out_tax_amount" : { "type" : "string", "description" : "发票金额，不含税" }, "payee_name" : { "type" : "string", "description" : "销方名称" }, "payee_tax_no" : { "type" : "string", "description" : "销方税号" }, "payer_name" : { "type" : "string", "description" : "购方名称" }, "payer_tax_no" : { "type" : "string", "description" : "购方税号" }, "pdf_url" : { "type" : "string", "description" : "PDF的下载链接" }, "source" : { "type" : "string", "description" : "表示发票来源，由发票回传方带入。例如：bz_gd，bz_ele，bz_tmall等" }, "trade_list" : { "type" : "array", "description" : "该发票对应的交易", "items" : { "$ref" : "#/components/schemas/EinvTrade" } }, "trade_match_result" : { "type" : "string", "description" : "交易匹配结果\tmatch-匹配到\tnoMatched-未匹配到\tnotMatch-未做匹配" } } }, "InvoiceElementStatusSyncOpenModel" : { "type" : "object", "properties" : { "apply_id" : { "type" : "string", "description" : "同步申请id，每次发起同步时生成，isv每次请求需要保证唯一", "example" : "2016112500152003000000000245" }, "expense_detail_url" : { "type" : "string", "description" : "报销详情地址，提供用户通过发票管家查看报销进度的地址\r\t如果报销企业入驻发票管家时需要isv传入报销详情地址，则必须提供", "example" : "http://www.baidu.com" }, "invoice_code" : { "type" : "string", "description" : "发票代码", "example" : "031001600111" }, "invoice_no" : { "type" : "string", "description" : "发票号码", "example" : "10001040" } } }, "InvoiceItem" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "含税总金额 (等于sum_price和tax之和)，\t单位：元，格式为2位小数，精度2位小数", "example" : "1170.00" }, "item_name" : { "type" : "string", "description" : "发票项目名称（或商品名称）", "example" : "电视机" }, "item_no" : { "type" : "string", "description" : "发票项目编号（或商品编号）", "example" : "1010101010000000000" }, "price" : { "type" : "string", "description" : "单价（不含税），格式为2位小数。最大支持6位小数，不足2位小数时需转化为2位小数格式。\t折扣行此参数不能传", "example" : "100.00" }, "quantity" : { "type" : "string", "description" : "数量，须大于0，最多6位小数。\t折扣行此参数不能传", "example" : "10" }, "row_type" : { "type" : "integer", "description" : "发票行性质。0表示正常行，1表示折扣行，2表示被折扣行。\t比如充电器单价100元，折扣10元，则明细为2行，充电器行性质为2，折扣行性质为1。如果充电器没有折扣，则值应为0。", "example" : "0" }, "specification" : { "type" : "string", "description" : "规格型号", "example" : "X100" }, "sum_price" : { "type" : "string", "description" : "不含税总金额，格式为2位小数\t单位：元，精度2位小数", "example" : "1000.00" }, "tax" : { "type" : "string", "description" : "税额，\t格式为2位小数", "example" : "170.00" }, "tax_rate" : { "type" : "string", "description" : "税率。格式为2位小数，如：0.00, 0.03, 0.13等等", "example" : "0.17" }, "unit" : { "type" : "string", "description" : "单位，折扣行不能传", "example" : "台" }, "zero_rate_flag" : { "type" : "string", "description" : "0税率标识，只有税率为0的情况才有值，0=出口零税率，1=免税，2=不征收，3=普通零税率", "example" : "1" } } }, "InvoiceItemContent" : { "type" : "object", "properties" : { "item_amount" : { "type" : "string", "description" : "价税合计。(等于sumPrice和tax之和)" }, "item_name" : { "type" : "string", "description" : "发票项目名称（或商品名称）" }, "item_no" : { "type" : "string", "description" : "商品编号" }, "item_price" : { "type" : "string", "description" : "单价，格式：100.00。新版电子发票，折扣行此参数不能传，非折扣行必传" }, "item_quantity" : { "type" : "integer", "description" : "数量。新版电子发票，折扣行此参数不能传，非折扣行必传" }, "item_sum_price" : { "type" : "string", "description" : "单项总价，格式：100.00" }, "item_tax_price" : { "type" : "string", "description" : "税额" }, "item_tax_rate" : { "type" : "string", "description" : "税率" }, "item_unit" : { "type" : "string", "description" : "台" }, "row_type" : { "type" : "integer", "description" : "发票行性质。0表示正常行，1表示折扣行，2表示被折扣行。比如充电器单价100元，折扣10元，则明细为2行，充电器行性质为2，折扣行性质为1。如果充电器没有折扣，则值应为0" } } }, "InvoiceItemOpenModel" : { "type" : "object", "properties" : { "item_ex_tax_amount" : { "type" : "string", "description" : "明细行不含税金额，保留两位小数" }, "item_name" : { "type" : "string", "description" : "开票项目：货物或应税劳务、服务名称" }, "item_no" : { "type" : "string", "description" : "国税局制定的商品税收编码，必须是最末级" }, "item_quantity" : { "type" : "integer", "description" : "数量；\t1.当row_type=0或2且item_unit_price为空，可空；\t2.可精确到小数点后6位" }, "item_spec" : { "type" : "string", "description" : "规格型号" }, "item_sum_amount" : { "type" : "string", "description" : "明细行价税合计，必须保证item_sum_amount=item_ex_tax_amount+item_tax_amount。" }, "item_tax_amount" : { "type" : "string", "description" : "明细行税额，保留两位小数，无税或者免税情况下输入：0.00。" }, "item_tax_rate" : { "type" : "string", "description" : "明细行税率，无税或者免税情况下输入：0.00。" }, "item_unit" : { "type" : "string", "description" : "单位" }, "item_unit_price" : { "type" : "string", "description" : "不含税单价;\t1.当row_type=0或2且item_quantity为空，可空\t2.可精确到小数点后8位；" }, "row_type" : { "type" : "string", "description" : "发票行性质：0表示正常行，1表示折扣行，2表示被折扣行。" } } }, "InvoiceModelContent" : { "type" : "object", "properties" : { "apply_id" : { "type" : "string", "description" : "支付宝端的申请id。如果在开票过程中，是通过支付宝提交的申请到机构端，支付宝会带上开票申请在支付宝生成的申请id，机构在回传发票的时候只需要回传这个申请id，不用获取用户的uid，支付宝可以根据申请id将发票归集到对应的用户名下", "example" : "2016112800152005000000000239" }, "extend_fields" : { "type" : "string", "description" : "key=value，每组键值对以回车分割", "example" : "shortPlatform=POS\r\nabx=xxx\r\neee=ccc" }, "file_download_type" : { "type" : "string", "description" : "下载的发票文件类型，可选值：\tpdf（发票原文件）\tofd（发票原文件）\tjpg（发票原文件缩略图）", "example" : "pdf" }, "file_download_url" : { "type" : "string", "description" : "发票原文件下载地址\t1.当tax_type=PLAIN、ALL_ELECTRONIC_GENERAL或ALL_ELECTRONIC_SPECIAL时，\tfile_download_url必传\t且file_download_type取值范围为pdf或ofd；\t2.当tax_type=SPECIAL时，\tfile_download_url必传\tfile_download_type可以传入pdf，ofd，jpg\t3.当其他票种时，file_download_url可以不传", "example" : "http://xxx.com" }, "financial_electronic_type" : { "type" : "string", "description" : "财政电子票据子类型，当tax_type=FINANCIAL_ELECTRONIC_BILL时要求必填\t可选值如下：\t01:非税收入通用票据 \t02:非税收入专用票据\t03:非税收入一般缴款书\t04:资金往来结算票据\t05:公益事业捐赠票据\t06:医疗收费票据\t07:社会团体会费票据\t08:社会保险基金票据\t09:工会经费收入票据\t99:其他财政票据", "example" : "MEDICAL_ELECTRONIC_BILL" }, "invoice_amount" : { "type" : "string", "description" : "发票金额，大于0且精确到小数点两位，以元为单位\r\t需要传入税价合计金额", "example" : "200.00" }, "invoice_code" : { "type" : "string", "description" : "发票代码，为国税局生成的唯一值，全电票时为空，其他情况不可为空", "example" : "2328742873" }, "invoice_content" : { "type" : "array", "description" : "发票内容项", "items" : { "$ref" : "#/components/schemas/InvoiceItemContent" } }, "invoice_date" : { "type" : "string", "description" : "发票日期，用户填写，目前精确到日", "example" : "2016-07-19" }, "invoice_fake_code" : { "type" : "string", "description" : "发票防伪码", "example" : "-" }, "invoice_file_data" : { "type" : "string", "description" : "原始发票PDF/OFD文件流", "example" : "01010010101" }, "invoice_img_url" : { "type" : "string", "description" : "发票原始文件jpg文件地址", "example" : "http://xxx.com" }, "invoice_no" : { "type" : "string", "description" : "发票号码，国税局生成的唯一号码，不可为空串；\r\t使用时请注意，invoice_no+invoice_code唯一，不能重复", "example" : "237428768" }, "invoice_operator" : { "type" : "string", "description" : "发票开具操作人", "example" : "张某某" }, "invoice_title" : { "$ref" : "#/components/schemas/InvoiceTitleModel" }, "invoice_type" : { "type" : "string", "description" : "发票类型，按照可选值只传入英文部分，该字段严格要求大小写\r\t可选值:\r\tblue（蓝票）\r\tred（红票）", "example" : "blue" }, "open_id" : { "type" : "string", "description" : "支付宝用户id，支付宝端的申请id存在的时候也不需要传，其他情况下，当同步的是蓝票时，必传，红票时不需传。", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "original_blue_invoice_code" : { "type" : "string", "description" : "仅用于同步红票，原始蓝票发票代码，同步红票时必传（全电票时为空）", "example" : "2328742873" }, "original_blue_invoice_no" : { "type" : "string", "description" : "仅用于同步红票，原始蓝票发票号码，同步红票时必传", "example" : "9288277173" }, "out_biz_no" : { "type" : "string", "description" : "商户交易流水号，不可为空串;\r\t传入红票时请注意，此字段的值要和蓝票保持一致", "example" : "2016010139992003" }, "out_invoice_id" : { "type" : "string", "description" : "商户唯一开票申请业务流水号，同一个isv下不能重复", "example" : "20160707399929991001" }, "register_address" : { "type" : "string", "description" : "开票单位地址", "example" : "天目山路黄龙时代广场B座" }, "register_bank_account" : { "type" : "string", "description" : "开票单位开户行账号", "example" : "6332000023949993" }, "register_bank_name" : { "type" : "string", "description" : "开票单位开户行名称", "example" : "西湖区建行" }, "register_name" : { "type" : "string", "description" : "开票单位", "example" : "支付宝（杭州）信息技术有限公司" }, "register_no" : { "type" : "string", "description" : "纳税人识别号，不可为空串", "example" : "J8374LK29387" }, "register_phone_no" : { "type" : "string", "description" : "开票人电话，支持座机和手机两种格式", "example" : "13200029932" }, "sum_amount" : { "type" : "string", "description" : "价税合计", "example" : "2000.00" }, "tax_amount" : { "type" : "string", "description" : "税额", "example" : "1000.00" }, "tax_type" : { "type" : "string", "description" : "税种\t可选值：\tPLAIN：增值税电子普通发票\tALL_ELECTRONIC_GENERAL：电子发票（普通发票）\tALL_ELECTRONIC_SPECIAL：电子发票（增值税专用发票）\tSPECIAL：增值税专用发票\tPLAIN_INVOICE:增值税普通发票\tFINANCIAL_ELECTRONIC_BILL:财政电子票据", "example" : "PLAIN" }, "user_id" : { "type" : "string", "description" : "支付宝用户id，支付宝端的申请id存在的时候也不需要传，其他情况下，当同步的是蓝票时，必传，红票时不需传。", "example" : "2088399922382233" } } }, "InvoiceOutputInfo" : { "type" : "object", "properties" : { "check_code" : { "type" : "string", "description" : "发票防伪码，验证码" }, "checker" : { "type" : "string", "description" : "票面上复核人信息。" }, "clerk" : { "type" : "string", "description" : "票面上开票员信息。" }, "ex_tax_amount" : { "type" : "string", "description" : "不含税金额，票面上的不含税金额，单位（元），保留两位小数。" }, "invoice_code" : { "type" : "string", "description" : "发票代码" }, "invoice_content" : { "type" : "array", "description" : "发票明细项。", "items" : { "$ref" : "#/components/schemas/InvoiceItemOpenModel" } }, "invoice_date" : { "type" : "string", "description" : "开票日期，格式如：YYYY-MM-DD。" }, "invoice_img_url" : { "type" : "string", "description" : "发票预览图片地址" }, "invoice_kind" : { "type" : "string", "description" : "标识发票的类型，PLAIN:增值税电子普通发票;SPECIAL:增值税专用发票;PLAIN_INVOICE:增值税普通发票;SALSE_INVOICE:机动车销售统一发票 ;PAPER_INVOICE:增值税普通发票(卷式)。" }, "invoice_memo" : { "type" : "string", "description" : "票面上备注信息。" }, "invoice_no" : { "type" : "string", "description" : "发票号码" }, "invoice_title" : { "$ref" : "#/components/schemas/InvoiceTitleOpenModel" }, "invoice_type" : { "type" : "string", "description" : "标识是红票还是蓝票，RED:红票;BLUE:蓝票" }, "ori_blue_inv_code" : { "type" : "string", "description" : "红票情况下，必须填入原始蓝票的发票代码。" }, "ori_blue_inv_no" : { "type" : "string", "description" : "红票情况下，必须填入原始蓝票的发票号码。" }, "payee" : { "type" : "string", "description" : "票面上收款人信息。" }, "payee_address_tel" : { "type" : "string", "description" : "票面上销售方地址、电话信息。" }, "payee_bank_name_account" : { "type" : "string", "description" : "票面上销售方开户行及账号。" }, "payee_name" : { "type" : "string", "description" : "票面上销售方企业名称。" }, "payee_register_no" : { "type" : "string", "description" : "票面上销售方税号信息。" }, "sum_amount" : { "type" : "string", "description" : "价税合计，票面上的总开票金额，单位（元），保留两位小数，sum_amount=ex_tax_amount+tax_amount。" }, "tax_amount" : { "type" : "string", "description" : "合计税额，票面上的合计税额，单位（元），保留两位小数。" } } }, "InvoicePDFSynModel" : { "type" : "object", "properties" : { "apply_id" : { "type" : "string", "description" : "支付宝开票申请id。\t当userId为空时，必填；\t如果在开票过程中，是通过支付宝提交的申请到开票服务方，支付宝会带上开票申请在支付宝生成的申请id，开票服务方在回传发票的时候只需要回传这个申请id，不用获取用户的userId，支付宝可以根据申请id将发票归集到对应的用户名下", "example" : "2016112800152005000000000239" }, "extend_fields" : { "type" : "string", "description" : "预留的扩展字段，格式如：key1=value1\\nkey2=value2\\nkey3=value3，字段之间以\\n(换行符)分隔。", "example" : "m_invoice_detail_url=http://127.0.0.1:8080/invoice/detail.action?fpdm= 1234567&fphm=123456" }, "file_base" : { "type" : "string", "description" : "base64化的字符串", "example" : "5LqR5YyW56iO5o6nDQoNCjIuMjjnur/kuIrlj6/llK7ljZYNCg0KVzHvvJrlrozmiJDnlJ/kuqflj5H" }, "file_download_type" : { "type" : "string", "description" : "PDF类型文件填写PDF，\tOFD类型文件填写ofd，\tJPG类型文件填写JPG(JPG文件请先询问对接人当前是否支持)", "example" : "PDF" }, "file_download_url" : { "type" : "string", "description" : "发票文件下载地址。", "example" : "http://img.hadalo.com/aa/kq/ddhrtdefgxKVXXXXa6apXXXXXXXXXX.pdf" }, "open_id" : { "type" : "string", "description" : "支付宝用户id，当apply_id为空时，open_id必填", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "out_invoice_id" : { "type" : "string", "description" : "外部ISV的唯一发票标识", "example" : "2088100022223333" }, "user_id" : { "type" : "string", "description" : "支付宝用户userId；\t当apply_id为空时，userId必填", "example" : "2088399922382233" }, "zip" : { "type" : "string", "description" : "压缩方式", "example" : "zip" } } }, "InvoiceSendOpenModel" : { "type" : "object", "properties" : { "apply_id" : { "type" : "string", "description" : "支付宝端的申请id。如果在开票过程中，是通过支付宝提交的申请到机构端，支付宝会带上开票申请在支付宝生成的申请id，机构在回传发票的时候只需要回传这个申请id，不用获取用户的uid，支付宝可以根据申请id将发票归集到对应的用户名下", "example" : "2016112800152005000000000239" }, "check_code" : { "type" : "string", "description" : "票面上的校验码信息。", "example" : "15170246985745164986" }, "checker" : { "type" : "string", "description" : "票面上复核人信息。", "example" : "李四" }, "clerk" : { "type" : "string", "description" : "票面上开票员信息。", "example" : "赵吴" }, "ex_tax_amount" : { "type" : "string", "description" : "不含税金额，票面上的不含税金额，单位（元），保留两位小数。", "example" : "100.00" }, "extend_fields" : { "type" : "string", "description" : "预留的扩展字段，格式如：key1=value1\\nkey2=value2\\nkey3=value3，字段之间以\\n分隔。", "example" : "m_invoice_detail_url=http://196.021.871.011:8080/invoice/detail.action?fpdm= 4112740003&fphm=41791003" }, "file_download_type" : { "type" : "string", "description" : "下载版式文件类型，需要回传文件下载链接的情况下必传，\t取值范围：PDF，JPG，OFD", "example" : "PDF" }, "file_download_url" : { "type" : "string", "description" : "发票版式文件下载地址。", "example" : "http://img.hadalo.com/aa/kq/ddhrtdefgxKVXXXXa6apXXXXXXXXXX.pdf" }, "financial_electronic_type" : { "type" : "string", "description" : "财政电子票据子类型，当tax_type=FINANCIAL_ELECTRONIC_BILL时要求必填 可选值如下： 01:非税收入通用票据 02:非税收入专用票据 03:非税收入一般缴款书 04:资金往来结算票据 05:公益事业捐赠票据 06:医疗收费票据 07:社会团体会费票据 08:社会保险基金票据 09:工会经费收入票据 99:其他财政票据", "example" : "MEDICAL_ELECTRONIC_BILL" }, "invoice_code" : { "type" : "string", "description" : "发票代码，该字段与invoice_no构成一张发票的唯一标识。", "example" : "4112740003" }, "invoice_content" : { "type" : "array", "description" : "发票明细项。", "items" : { "$ref" : "#/components/schemas/InvoiceItemOpenModel" } }, "invoice_date" : { "type" : "string", "description" : "开票日期，格式如：YYYY-MM-DD。", "example" : "2017-10-10" }, "invoice_kind" : { "type" : "string", "description" : "标识发票的类型，\tPLAIN:增值税电子普通发票;\tSPECIAL:增值税专用发票;\tALL_ELECTRONIC_GENERAL:电子发票（普通发票）;\tALL_ELECTRONIC_SPECIAL:电子发票（增值税专用发票）;\tPLAIN_INVOICE:增值税普通发票;\tFINANCIAL_ELECTRONIC_BILL:财政电子票据;", "example" : "PLAIN" }, "invoice_memo" : { "type" : "string", "description" : "票面上备注信息。", "example" : "订单号：2017120800001" }, "invoice_no" : { "type" : "string", "description" : "发票号码，该字段与invoice_code构成一张发票的唯一标识。", "example" : "41791003" }, "invoice_title" : { "$ref" : "#/components/schemas/InvoiceTitleOpenModel" }, "invoice_type" : { "type" : "string", "description" : "标识是红票还是蓝票，RED:红票;BLUE:蓝票。", "example" : "BLUE" }, "open_id" : { "type" : "string", "description" : "支付宝用户userId，当发送红字发票时，即invoice_type＝RED时，可选填；或者apply_id不为空的时候，可选填；其他情况必填。", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "ori_blue_inv_code" : { "type" : "string", "description" : "红票情况下，必须填入原始蓝票的发票代码（全电票时为空）。", "example" : "4112740002" }, "ori_blue_inv_no" : { "type" : "string", "description" : "红票情况下，必须填入原始蓝票的发票号码。", "example" : "41791002" }, "out_invoice_id" : { "type" : "string", "description" : "外部发票id，isv生成发票之后所生成的发票流水号，主要用做存储。", "example" : "201710283459661232435535" }, "out_trade_no" : { "type" : "string", "description" : "该发票基于的实际交易流水号。", "example" : "20171023293456785924325" }, "payee" : { "type" : "string", "description" : "票面上收款人信息。", "example" : "张三" }, "payee_address_tel" : { "type" : "string", "description" : "票面上销售方地址、电话信息。", "example" : "杭州市西湖区某某办公楼 0571-237405862" }, "payee_bank_name_account" : { "type" : "string", "description" : "票面上销售方开户行及账号。", "example" : "西湖区建行11111111111" }, "payee_register_name" : { "type" : "string", "description" : "票面上销售方企业名称。", "example" : "支付宝（杭州）信息技术有限公司" }, "payee_register_no" : { "type" : "string", "description" : "票面上销售方税号信息。", "example" : "310101000000090" }, "sum_amount" : { "type" : "string", "description" : "价税合计，票面上的总开票金额，单位（元），保留两位小数，sum_amount=ex_tax_amount+tax_amount。", "example" : "101.00" }, "tax_amount" : { "type" : "string", "description" : "合计税额，票面上的合计税额，单位（元），保留两位小数。", "example" : "1.00" }, "trade_list" : { "type" : "array", "description" : "交易内容，非必填但是不可以传空值，如果无需回传trade_list则不需要传该对象", "items" : { "$ref" : "#/components/schemas/EinvTrade" } }, "user_id" : { "type" : "string", "description" : "支付宝用户userId，当发送红字发票时，即invoice_type＝RED时，可选填；或者apply_id不为空的时候，可选填；其他情况必填。", "example" : "2088399922382233" } } }, "InvoiceTitleModel" : { "type" : "object", "properties" : { "is_default" : { "type" : "boolean", "description" : "是否为用户设置默认抬头\r\t字段值包括两种情况：\r\tfalse（非默认）\r\ttrue（默认抬头）" }, "logon_id" : { "type" : "string", "description" : "支付宝用户登录名" }, "open_bank_account" : { "type" : "string", "description" : "银行账号" }, "open_bank_name" : { "type" : "string", "description" : "开户银行" }, "open_id" : { "type" : "string", "description" : "支付宝用户id" }, "tax_register_no" : { "type" : "string", "description" : "纳税人识别号" }, "tele_phone_no" : { "type" : "string", "description" : "用户私人手机号" }, "title_name" : { "type" : "string", "description" : "抬头名称" }, "title_type" : { "type" : "string", "description" : "抬头类型\r\t字段值有两种情况抬:\r\tPERSONAL（个人） \r\tCORPORATION（单位）" }, "user_address" : { "type" : "string", "description" : "地址" }, "user_email" : { "type" : "string", "description" : "邮箱" }, "user_id" : { "type" : "string", "description" : "支付宝用户id" }, "user_mobile" : { "type" : "string", "description" : "电话号码" } } }, "InvoiceTitleOpenModel" : { "type" : "object", "properties" : { "payer_address_tel" : { "type" : "string", "description" : "票面上的购买方地址、电话" }, "payer_bank_name_account" : { "type" : "string", "description" : "票面上的购买方开户行及账户" }, "payer_register_no" : { "type" : "string", "description" : "票面上的购买方纳税人识别号" }, "title_name" : { "type" : "string", "description" : "票面上的购买方名称" } } }, "InvoiceUkDTO" : { "type" : "object", "properties" : { "invoice_code" : { "type" : "string", "description" : "发票代码" }, "invoice_no" : { "type" : "string", "description" : "发票号码" } } }, "IssueQuotaCheckInfo" : { "type" : "object", "properties" : { "issue_quota" : { "type" : "string", "description" : "发放金额", "example" : "10" }, "message" : { "type" : "string", "description" : "校验结果的原因", "example" : "金额不能为负数" }, "owner_id" : { "type" : "string", "description" : "入参的 owner_id", "example" : "13055551515" }, "owner_open_id" : { "type" : "string", "description" : "入参的 owner_open_id", "example" : "abcdxxxx" }, "owner_type" : { "type" : "string", "description" : "owner_type", "example" : "PHONE" }, "result" : { "type" : "boolean", "description" : "校验结果", "example" : "true" }, "user_name" : { "type" : "string", "description" : "用户姓名", "example" : "测试" } } }, "IssueRuleIdInfo" : { "type" : "object", "properties" : { "issue_rule_id" : { "type" : "string", "description" : "发放规则id", "example" : "2022031000152621000000000001" }, "outer_source_id" : { "type" : "string", "description" : "外部发放规则id", "example" : "123456" } } }, "IssueRuleInfo" : { "type" : "object", "properties" : { "effective_period" : { "type" : "string", "description" : "生效时间段" }, "invalid_mode" : { "type" : "integer", "description" : "累计类型，默认为0\t枚举：0（不可累计）、1（可累计）、2（累计天数）、3（累计到指定日期）" }, "invalid_mode_value" : { "type" : "string", "description" : "累计类型值" }, "issue_amount_value" : { "type" : "string", "description" : "发放金额" }, "issue_end_date" : { "type" : "string", "description" : "发放规则有效结束时间" }, "issue_rule_id" : { "type" : "string", "description" : "发放规则id" }, "issue_rule_name" : { "type" : "string", "description" : "发放规则名称" }, "issue_start_date" : { "type" : "string", "description" : "发放规则有效起始时间" }, "issue_type" : { "type" : "string", "description" : "发放类型" }, "outer_source_id" : { "type" : "string", "description" : "外部发放规则id" }, "quota_type" : { "type" : "string", "description" : "额度类型" }, "share_mode" : { "type" : "integer", "description" : "是否可转赠" }, "target_id" : { "type" : "string", "description" : "目标id" }, "target_type" : { "type" : "string", "description" : "发放规则归属的目标类型" } } }, "IssueTargetInfoContent" : { "type" : "object", "properties" : { "issue_quota" : { "type" : "string", "description" : "发放金额", "example" : "10" }, "owner_id" : { "type" : "string", "description" : "切换open_id前请使用：owner类型为PHONE时该字段表示员工手机号，owner类型为为EMPLOYEE时该字段表示为员工支付宝uid，owner类型为为ENTERPRISE_PAY_UID时该字段表示为员工企业码id", "example" : "13055551515" }, "owner_open_id" : { "type" : "string", "description" : "切换open_id后请使用：owner类型，PHONE为员工手机号，EMPLOYEE为员工open_id", "example" : "abcdxxxx" }, "owner_type" : { "type" : "string", "description" : "owner类型，用来表示owner_id的类型;\tenterprise_id支持PHONE、ENTERPRISE_PAY_UID类型；account_id支持EMPLOYEE类型", "example" : "PHONE" }, "user_name" : { "type" : "string", "description" : "员工姓名", "example" : "测试" } } }, "IsvAuthSceneInfo" : { "type" : "object", "properties" : { "scene_code" : { "type" : "string", "description" : "运营场景编码\tOPERATION_POINTS：管理运营积分\tSHOP_MANAGE：管理球房信息\tMINI_APP_OPER：运营支付宝小程序\tPROMOTION_MANAGE：运营营销活动", "example" : "PROMOTION_MANAGE" }, "scene_permissions" : { "type" : "string", "description" : "运营场景下的权限编码，多个权限编码以,隔开\t1、管理球房信息：SHOP_MANAGE；基础权限（升级）：SHOP_MANAGE_BASE\t2、运营营销活动：PROMOTION_MANAGE ；基础权限（升级）：PROMOTION_MANAGE_BASE\t3、运营支付宝小程序：MINI_APP_OPER；基础权限（升级）：MINI_APP_OPER_BASE\t4、管理运营积分：OPERATION_POINTS；基础权限（升级）：OPERATION_POINTS_BASE", "example" : "SHOP_MANAGE_BASE" } } }, "IsvExpandOpporDTO" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "商机地址", "example" : "紫金港路与文二西路交叉口向西500米西城广场" }, "leads_id" : { "type" : "string", "description" : "商机Id", "example" : "2020092100009315" }, "name" : { "type" : "string", "description" : "商机名称", "example" : "测试" }, "oppor_id" : { "type" : "string", "description" : "商机作业Id", "example" : "2020092200010868" }, "out_biz_no" : { "type" : "string", "description" : "外部幂等唯一键", "example" : "out_biz_no" }, "phone" : { "type" : "string", "description" : "商机联系电话", "example" : "13812312323" }, "status" : { "type" : "string", "description" : "商机作业状态", "example" : "EXPANDED" } } }, "IsvMerchantSalesDetailRequest" : { "type" : "object", "properties" : { "coupons_quantity" : { "type" : "string", "description" : "配券数", "example" : "1" }, "device_detail" : { "type" : "string", "description" : "设备详情", "example" : "此处为该设备的详细描述" }, "merchant_pid" : { "type" : "string", "description" : "商户pid", "example" : "2088301912341234" }, "mini_appid" : { "type" : "string", "description" : "小程序appid，若推广的商品不为小程序，则不传此参数", "example" : "2018082861168647" }, "operation_place" : { "type" : "string", "description" : "作业地", "example" : "浙江省杭州市西湖区蚂蚁A空间" }, "out_biz_no" : { "type" : "string", "description" : "外部业务号，传isv系统生成的账单号，需要保证唯一", "example" : "2021000000000" }, "promotor_pid" : { "type" : "string", "description" : "推广服务商(S2)pid", "example" : "2088301912341234" }, "sales_amount" : { "type" : "string", "description" : "销售金额，这里填写的是整数，单位为分，比如1元，那么输入100", "example" : "100" }, "sales_quantity" : { "type" : "string", "description" : "销售笔数", "example" : "100" }, "sub_promotor_pid" : { "type" : "string", "description" : "推广服务商(S2)子账号pid", "example" : "2088301912341234" }, "write_off_amount" : { "type" : "string", "description" : "核销金额，这里填写的是整数，单位为分，比如1元，那么输入100", "example" : "100" }, "write_off_quantity" : { "type" : "string", "description" : "核销数", "example" : "1" } } }, "IsvSpiDefinition" : { "type" : "object", "properties" : { "biz_code" : { "type" : "string", "description" : "ISV自定义的标识功能的业务代码，不可重复", "example" : "hotline" }, "description" : { "type" : "string", "description" : "spi功能描述", "example" : "spi功能描述" }, "icon" : { "type" : "string", "description" : "功能图标文件url", "example" : "http://127.0.0.1/" }, "spi_endpoint" : { "type" : "string", "description" : "spi接口服务地址", "example" : "http://127.0.0.1/" }, "spi_ext_property" : { "type" : "string", "description" : "spi接口扩展参数，json格式字符串", "example" : "{\"key\":\"value\"}" }, "spi_key" : { "type" : "string", "description" : "CCM预先定义的spi key，与插件位置有关", "example" : "spi_alipay_iservice_ccm_menu" }, "spi_name" : { "type" : "string", "description" : "SPI 名称", "example" : "热线工作台" } } }, "ItemConsultInfo" : { "type" : "object", "properties" : { "item_id" : { "type" : "string", "description" : "商品id", "example" : "20210105003" }, "promo_amount" : { "type" : "string", "description" : "商品优惠金额，单位为元", "example" : "3.0" }, "promo_count" : { "type" : "string", "description" : "商品优惠数量", "example" : "2" } } }, "ItemConsultRequest" : { "type" : "object", "properties" : { "item_id" : { "type" : "string", "description" : "商品id", "example" : "20210105003" }, "price" : { "type" : "string", "description" : "商品单价，单位为元，最多2位小数", "example" : "20.29" }, "quantity" : { "type" : "string", "description" : "商品数量", "example" : "3" } } }, "ItemExtInfo" : { "type" : "object", "properties" : { "ext_key" : { "type" : "string", "description" : "扩展信息的key" }, "ext_value" : { "type" : "string", "description" : "扩展信息的值" } } }, "ItemInfo" : { "type" : "object", "properties" : { "item_ids" : { "type" : "array", "description" : "券适用的单品码列表\r\t最少配置1个单品码\r\t最多配置500个单品码", "items" : { "type" : "string" }, "example" : "0000123,0000124" }, "item_imgs" : { "type" : "array", "description" : "单品图片列表\r\t单品图片不能超过3张", "items" : { "type" : "string" }, "example" : "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC" }, "item_link" : { "type" : "string", "description" : "单品券详细介绍跳转链接", "example" : "www.taobao.com" }, "item_name" : { "type" : "string", "description" : "单品名称", "example" : "单品名称" }, "item_text" : { "type" : "string", "description" : "单品券说明", "example" : "单品券说明" }, "max_discount_num" : { "type" : "string", "description" : "单品券适用的商品列表中，每一个商品最高可享受优惠的件数； \r\t如：券适用于A,B两种商品，该字段设置为1，则用券A,B两种商品每种最多只有一件可享受优惠；", "example" : "1" }, "min_consume_num" : { "type" : "string", "description" : "单品券适用商品列表中，每种商品享受优惠最低购买件数的门槛；\r\t如：券适用于A,B两种商品，该字段设置为3，则A,B两种商品每种最少需要购买3件才可享受优惠；", "example" : "1" }, "original_price" : { "type" : "string", "description" : "单品的原价，单位元\r\t必须为合法金额类型字符串，如9.99", "example" : "28.88" }, "sku_min_consume" : { "type" : "string", "description" : "券适用SKU的最低消费金额门槛\r\t如券适用A,B两个SKU，该字段设置的值为100，则订单中购买A,B两个SKU的合计金额需大于100元才可用券", "example" : "10" }, "total_max_discount_num" : { "type" : "string", "description" : "如果一个单品券适用A，B，C三个单品，若设置了该字段为2，则在一笔交易中，A，B，C三个单品加起来最多只有俩件能够享受优惠", "example" : "10" } } }, "ItemLabelCreateInfo" : { "type" : "object", "properties" : { "label_key" : { "type" : "string", "description" : "标签键\r\tOIL_NUM：油号", "example" : "OIL_NUM" }, "label_value" : { "type" : "string", "description" : "标签值：\r\tOIL_NUM对应的值为：95# 92# 98# 等等", "example" : "95#" } } }, "ItemLabelModifyInfo" : { "type" : "object", "properties" : { "label_key" : { "type" : "string", "description" : "标签键\r\tOIL_NUM：油号", "example" : "OIL_NUM" }, "label_value" : { "type" : "string", "description" : "标签值：\r\tOIL_NUM对应的值为：95# 92# 98# 等等", "example" : "95#" } } }, "ItemModel" : { "type" : "object", "properties" : { "creator_id" : { "type" : "string", "description" : "创建者id", "example" : "1" }, "creator_type" : { "type" : "string", "description" : "创建者类型", "example" : "SYSTEM" }, "ext_info" : { "type" : "string", "description" : "商品扩展信息：可以解析成 Map 的 json string", "example" : "{\"DISCOUNT\": \"88\"}" }, "front_category_id" : { "type" : "string", "description" : "前台类目id", "example" : "2018091300502200002600105884" }, "gmt_create" : { "type" : "string", "description" : "商品创建时间", "example" : "2018-09-25 19:41:34" }, "gmt_modified" : { "type" : "string", "description" : "商品更新时间", "example" : "2018-09-25 19:41:34" }, "item_id" : { "type" : "string", "description" : "商品id", "example" : "2018091300502200004300103587" }, "name" : { "type" : "string", "description" : "商品名称", "example" : "西红柿炒蛋" }, "sku_list" : { "type" : "array", "description" : "商品sku列表", "items" : { "$ref" : "#/components/schemas/ItemSkuInfo" } }, "sort" : { "type" : "integer", "description" : "商品排序", "example" : "0" }, "status" : { "type" : "string", "description" : "商品状态", "example" : "EFFECT" }, "target_id" : { "type" : "string", "description" : "商户归属主体id", "example" : "2018090600502000000022501261" }, "target_type" : { "type" : "string", "description" : "商品归属主体类型：5(商铺)", "example" : "5" }, "type" : { "type" : "string", "description" : "商品类型", "example" : "STANDARD_GOODS" } } }, "ItemOrderInfo" : { "type" : "object", "properties" : { "ext_info" : { "type" : "array", "description" : "扩展信息，请参见产品文档。小程序订单助手业务中，扩展参数必须传递素材id；其他业务场景参见对应的产品文档。", "items" : { "$ref" : "#/components/schemas/OrderExtInfo" } }, "item_id" : { "type" : "string", "description" : "商品 id", "example" : "2018111300502228000000177053" }, "item_name" : { "type" : "string", "description" : "商品名称", "example" : "苹果" }, "quantity" : { "type" : "integer", "description" : "商品数量（单位：自拟）。\t小程序订单助手业务中，为必传；其他业务场景参见对应的产品文档。", "example" : "20" }, "sku_id" : { "type" : "string", "description" : "商品 sku id", "example" : "2018111300502205000000176601" }, "status" : { "type" : "string", "description" : "商品状态枚举，默认无需传入，如需使用请联系业务负责人", "example" : "PAID" }, "status_desc" : { "type" : "string", "description" : "商品状态描述，默认无需传入，如需使用请联系业务负责人", "example" : "已付款" }, "unit" : { "type" : "string", "description" : "商品规格", "example" : "斤" }, "unit_price" : { "type" : "string", "description" : "商品单价（单位：元）。\t小程序订单助手业务中，为必传；其他业务场景参见对应的产品文档。", "example" : "13.18" } } }, "ItemPlanContentDO" : { "type" : "object", "properties" : { "codes" : { "type" : "array", "description" : "对应服务库编码", "items" : { "type" : "string" }, "example" : "[\"400000000207968215\"]" }, "type" : { "type" : "string", "description" : "条目类型，必须， 商品：ITEM", "example" : "ITEM" } } }, "ItemPromoInfo" : { "type" : "object", "properties" : { "item_consult_list" : { "type" : "array", "description" : "商品咨询列表", "items" : { "$ref" : "#/components/schemas/ItemConsultInfo" } }, "item_cover_pic" : { "type" : "string", "description" : "单品封面图", "example" : "https://gw.alipayobjects.com/mdn/rms_9822d7/afts/img/A*1F4eSaaPHRQAAAAAAAAAAABkARQnAQ" }, "item_desc" : { "type" : "string", "description" : "单品描述", "example" : "宝洁洗护用品促销" }, "item_detail_pic_list" : { "type" : "array", "description" : "单品详情图列表", "items" : { "type" : "string" }, "example" : "[\"https://gw.alipayobjects.com/mdn/rms_9822d7/afts/img/A*1F4eSaaPHRQAAAAAAAAAAABkARQnAQ\"]" }, "item_name" : { "type" : "string", "description" : "单品名称", "example" : "宝洁洗护用品" } } }, "ItemPropertyInfo" : { "type" : "object", "properties" : { "property_key" : { "type" : "string", "description" : "属性名称" }, "property_value_list" : { "type" : "array", "description" : "属性值列表", "items" : { "type" : "string" } } } }, "ItemSkuCreateInfo" : { "type" : "object", "properties" : { "cost_price" : { "type" : "integer", "description" : "成本价，单位分", "example" : "100" }, "ext_info" : { "type" : "array", "description" : "SKU扩展信息", "items" : { "$ref" : "#/components/schemas/ItemExtInfo" } }, "external_sku_id" : { "type" : "string", "description" : "外部SKU ID", "example" : "201909161232534324124123" }, "inventory" : { "type" : "integer", "description" : "库存", "example" : "100" }, "original_price" : { "type" : "integer", "description" : "标价，单位分", "example" : "100" }, "price" : { "type" : "integer", "description" : "售价，单位分", "example" : "100" } } }, "ItemSkuInfo" : { "type" : "object", "properties" : { "cost_price" : { "type" : "integer", "description" : "成本价，单位分", "example" : "100" }, "ext_info" : { "type" : "array", "description" : "SKU扩展信息", "items" : { "$ref" : "#/components/schemas/ItemExtInfo" } }, "gmt_create" : { "type" : "string", "description" : "创建时间", "example" : "2018-09-26 11:12:54" }, "gmt_modified" : { "type" : "string", "description" : "更新时间", "example" : "2018-09-26 11:12:54" }, "item_id" : { "type" : "string", "description" : "商品id", "example" : "2018091300502200004400104166" }, "original_price" : { "type" : "integer", "description" : "标价，单位分", "example" : "100" }, "price" : { "type" : "integer", "description" : "售价，单位分", "example" : "100" }, "sku_id" : { "type" : "string", "description" : "商品sku id", "example" : "2018091300502200001600103072" }, "status" : { "type" : "string", "description" : "商品SKU状态：EFFECT、INVALID", "example" : "EFFECT" } } }, "ItemSkuModifyInfo" : { "type" : "object", "properties" : { "cost_price" : { "type" : "integer", "description" : "成本价，单位分", "example" : "100" }, "ext_info" : { "type" : "array", "description" : "SKU扩展信息", "items" : { "$ref" : "#/components/schemas/ItemExtInfo" } }, "external_sku_id" : { "type" : "string", "description" : "外部skuId（sku_id不为空时作为普通更新项,sku_id为空时作为更新key,sku_id和该字段同时为空则新增该条数据）", "example" : "20190916123124234235234" }, "inventory" : { "type" : "integer", "description" : "库存", "example" : "100" }, "original_price" : { "type" : "integer", "description" : "标价，单位分", "example" : "100" }, "price" : { "type" : "integer", "description" : "售价，单位分", "example" : "100" }, "sku_id" : { "type" : "string", "description" : "skuId", "example" : "2018092600502220000000100274" }, "status" : { "type" : "string", "description" : "商品SKU状态：EFFECT、INVALID", "example" : "EFFECT" } } }, "ItemSkuPropertyInfo" : { "type" : "object", "properties" : { "property_key" : { "type" : "string", "description" : "属性" }, "property_value" : { "type" : "string", "description" : "属性值" } } }, "JinyouTestFive" : { "type" : "object", "properties" : { "f_1_f" : { "$ref" : "#/components/schemas/JinyouTestFour" }, "f_2_f" : { "$ref" : "#/components/schemas/JinyouTestThree" }, "f_3_openid" : { "type" : "string", "description" : "1", "example" : "xxxxxscddcd" }, "f_3_y" : { "type" : "string", "description" : "1", "example" : "1" }, "f_4_n" : { "type" : "string", "description" : "3", "example" : "2" } } }, "JinyouTestFour" : { "type" : "object", "properties" : { "f_1_openid" : { "type" : "string", "description" : "1", "example" : "xxxxxscddcd" }, "f_1_y" : { "type" : "string", "description" : "1", "example" : "1" }, "f_2_f" : { "$ref" : "#/components/schemas/JinyouTestThree" }, "f_3_openid" : { "type" : "string", "description" : "1", "example" : "xxxxxscddcd" }, "f_3_y" : { "type" : "integer", "description" : "1", "example" : "1" } } }, "JinyouTestOne" : { "type" : "object", "properties" : { "o_1_n" : { "type" : "string", "description" : "1" }, "o_2_openid" : { "type" : "string", "description" : "o_2_y" }, "o_2_y" : { "type" : "string", "description" : "o_2_y" }, "o_3_openid" : { "type" : "string", "description" : "o_3_y" }, "o_3_y" : { "type" : "integer", "description" : "o_3_y" } } }, "JinyouTestThree" : { "type" : "object", "properties" : { "th_1_f" : { "$ref" : "#/components/schemas/JinyouTestTwo" }, "th_2_n" : { "type" : "string", "description" : "无枚举值" }, "th_3_n" : { "type" : "boolean", "description" : "1" } } }, "JinyouTestTwo" : { "type" : "object", "properties" : { "t_1_openid" : { "type" : "string", "description" : "1" }, "t_1_y" : { "type" : "string", "description" : "1" }, "t_2_f" : { "$ref" : "#/components/schemas/JinyouTestOne" }, "t_3_n" : { "type" : "string", "description" : "1" } } }, "JinyoutestopenidOne" : { "type" : "object", "properties" : { "c_1" : { "type" : "string", "description" : "我晚点", "example" : "4" }, "q" : { "type" : "string", "description" : "1", "example" : "1" }, "q_1_open_id" : { "type" : "string", "description" : "1", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" } } }, "JinyoutestopenidThree" : { "type" : "object", "properties" : { "a" : { "type" : "string", "description" : "12", "example" : "a_noopenid无" }, "b" : { "type" : "string", "description" : "有openid,无枚举，有注意事项", "example" : "21" }, "b_open_id" : { "type" : "string", "description" : "有openid,无枚举，有注意事项", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "f" : { "$ref" : "#/components/schemas/JinyoutestopenidTwo" } } }, "JinyoutestopenidTwo" : { "type" : "object", "properties" : { "a" : { "type" : "string", "description" : "无openid,有枚举值，有注意事项", "example" : "hjkhjc" }, "b" : { "type" : "string", "description" : "有openid，无枚举值，无注意事项", "example" : "7878789" }, "b_open_id" : { "type" : "string", "description" : "有openid，无枚举值，无注意事项,openid有注意事项", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "f" : { "$ref" : "#/components/schemas/JinyoutestopenidOne" } } }, "JobWorthJobdata" : { "type" : "object", "properties" : { "certificate_grant_institution" : { "type" : "string", "description" : "证书发证机构", "example" : "浙江省杭州市西湖区红十字会" }, "certificate_id" : { "type" : "string", "description" : "证书编号", "example" : "abcd12345678" }, "certificate_level" : { "type" : "string", "description" : "证书等级：中文", "example" : "初级" }, "certificate_name" : { "type" : "string", "description" : "证书名称", "example" : "健康管理师" }, "certificate_pic_id" : { "type" : "string", "description" : "工作证图片上传接口返回的id", "example" : "abcd12345678" }, "company_name" : { "type" : "string", "description" : "公司名称", "example" : "上海依多企业管理有限公司" }, "degree" : { "type" : "string", "description" : "学历，可以用以下字段HIGHSCHOOL_AND_BELOW（高中及以下），POLYTECHNIC（中专），COLLEGE（大专），BACHELOR（本科），MASTER（硕士），DOCTOR_AND_ABOVE（博士及以上）", "example" : "BACHELOR" }, "delivery_position_id" : { "type" : "string", "description" : "商户侧投递岗位id", "example" : "xxxxx" }, "delivery_time" : { "type" : "integer", "description" : "投递时间戳", "example" : "9999" }, "education_status" : { "type" : "string", "description" : "教育状态只有两种，GRADUATE(毕业)，STUDY（未毕业）", "example" : "GRADUATE" }, "entry_no" : { "type" : "string", "description" : "报名流水号", "example" : "1235446" }, "exam_score" : { "type" : "string", "description" : "考试分数", "example" : "85" }, "head_pic_id" : { "type" : "string", "description" : "工作证图片上传接口返回的id", "example" : "abcd123456" }, "intention_city" : { "type" : "string", "description" : "求职意向，城市的adccode 例如110000（北京市）", "example" : "110000" }, "issue_date" : { "type" : "string", "description" : "发证日期，ms时间戳", "example" : "1668743509506" }, "job_id" : { "type" : "string", "description" : "岗位对应的职业id，字段参考https://www.yuque.com/wx3dkp/gwckr4/bs03t3", "example" : "5278A2C2001" }, "job_name" : { "type" : "string", "description" : "职业名称", "example" : "后端开发" }, "ka_job_id" : { "type" : "string", "description" : "商户职业Id", "example" : "abc123" }, "ka_job_name" : { "type" : "string", "description" : "商户职业名称", "example" : "电工" }, "ka_profession_id" : { "type" : "string", "description" : "商户行业Id", "example" : "abc" }, "ka_profession_name" : { "type" : "string", "description" : "商户行业名称", "example" : "建筑业" }, "location" : { "type" : "string", "description" : "省份", "example" : "浙江" }, "month" : { "type" : "string", "description" : "毕业的月", "example" : "7" }, "once_token" : { "type" : "string", "description" : "对应类型相关接口生成", "example" : "12345678qwe123" }, "profession_id" : { "type" : "string", "description" : "岗位对应的行业id，字段参考https://www.yuque.com/wx3dkp/gwckr4/bs03t3", "example" : "5378A2C2" }, "profession_name" : { "type" : "string", "description" : "行业名称", "example" : "IT互联网" }, "salary_max" : { "type" : "string", "description" : "求职意向，薪水范围，不能低于salary_min", "example" : "3000" }, "salary_min" : { "type" : "string", "description" : "求职意向，薪水范围，不能高于salary_max", "example" : "1000" }, "salary_unit" : { "type" : "string", "description" : "薪资单位，元/日(DAY)、元/次(TIME)、元/月(MONTH)、元/小时(HOUR)、元/件 (NUM)、元/周 (WEEK)、其他 (OTHER)", "example" : "DAY" }, "school_name" : { "type" : "string", "description" : "学校", "example" : "浙江大学" }, "skill_name" : { "type" : "string", "description" : "用英文逗号分隔，最多6项", "example" : "木工,电工" }, "start_time" : { "type" : "string", "description" : "参加工作的时间，格式形如 2011-07", "example" : "2011-07" }, "type" : { "type" : "string", "description" : "信息类型", "example" : "certificate" }, "valid_date_end" : { "type" : "string", "description" : "有效期：开始结束 ms 时间戳", "example" : "1668743509506" }, "valid_date_start" : { "type" : "string", "description" : "有效期：开始时间 ms时间戳", "example" : "1668743509506" }, "verify_status" : { "type" : "string", "description" : "校验状态", "example" : "\"true\"" }, "work_desc" : { "type" : "string", "description" : "工作描述", "example" : "岗位职责1、负责自媒体公众号的图片创作编辑2、擅长手绘图像、漫画图像制作3、思维活跃，能够根据所给要求完成一篇情景剧的漫画图案设计4、能够配合工作需求完成工作任务岗位要求1、漫画设计功底较强，能够独立完成创作编辑2、会使用相关修图软件，能独立处理图片3、有相关工作经验优先，艺术学院在校大学生优先" }, "work_end_time" : { "type" : "string", "description" : "工作结束时间，毫秒级时间戳", "example" : "1651138651000" }, "work_property" : { "type" : "string", "description" : "岗位属性：全职(FULL_TIME)或者兼职(PART_TIME)", "example" : "FULL_TIME" }, "work_start_time" : { "type" : "string", "description" : "工作开始时间，毫秒级时间戳", "example" : "1651138484000" }, "year" : { "type" : "string", "description" : "毕业的年", "example" : "2011" } } }, "JobWorthPositionInfo" : { "type" : "object", "properties" : { "age" : { "type" : "string", "description" : "职位要求-年龄要求\t无要求（不传）、28岁以上(OVER28)、40岁以下(BELOW40)、25岁～35岁(25TO35)", "example" : "OVER28" }, "benefit" : { "type" : "string", "description" : "福利，现有标签，最多5个标签，使用英文,分割\t参考\thttps://www.yuque.com/docs/share/805e9840-ae9d-499c-b566-46b3b8c9fb2d?# 《4.1 服务端接入----职位传入接口》的1.3.1.1", "example" : "五险一金,双休" }, "certifications" : { "type" : "string", "description" : "技能、证书等要求，比如学历、健康证、普通话或其他技能证书等", "example" : "特种工作证,健康证" }, "company_certificate" : { "type" : "string", "description" : "发布企业统一社会信用代码", "example" : "91330200750364874C" }, "company_logo_afts_id" : { "type" : "string", "description" : "上传的aftsid", "example" : "xxxx" }, "company_name" : { "type" : "string", "description" : "企业工商全称", "example" : "杭州希德利餐饮管理有限公司" }, "count" : { "type" : "integer", "description" : "招聘人数", "example" : "8" }, "education" : { "type" : "string", "description" : "学历要求,HIGHSCHOOL_AND_BELOW（高中及以下），POLYTECHNIC（中专），COLLEGE（大专），BACHELOR（本科），MASTER（硕士），DOCTOR_AND_ABOVE（博士及以上）", "example" : "BACHELOR" }, "gender" : { "type" : "string", "description" : "无要求（不传）、男或者女", "example" : "男" }, "ka_position_id" : { "type" : "string", "description" : "合作方岗位id自定义保持唯一性", "example" : "20881234567" }, "position_desc" : { "type" : "string", "description" : "长文本描述", "example" : "职位描述" }, "position_id" : { "type" : "string", "description" : "工作证岗位库的职位主键，只有更新职位信息时需要传入。第一次传入岗位后返回", "example" : "123456789012345678901234" }, "position_job_id" : { "type" : "string", "description" : "岗位对应的行业id，字段参考https://www.yuque.com/docs/share/805e9840-ae9d-499c-b566-46b3b8c9fb2d?# 《4.1 服务端接入----职位传入接口》的1.3.1.2", "example" : "5378A2C2001" }, "position_job_name" : { "type" : "string", "description" : "岗位对应的职业名称", "example" : "服务端开发工程师" }, "position_profession_id" : { "type" : "string", "description" : "岗位对应的职业id，字段参考https://www.yuque.com/docs/share/805e9840-ae9d-499c-b566-46b3b8c9fb2d?# 《4.1 服务端接入----职位传入接口》的1.3.1.2", "example" : "5278A2C2" }, "position_property" : { "type" : "string", "description" : "岗位属性：全职(FULL_TIME)或者兼职(PART_TIME)", "example" : "FULL_TIME" }, "position_status" : { "type" : "string", "description" : "职位的状态，只有上架(UNCHECK)和下架(OFFLINE)两种", "example" : "UNCHECK" }, "position_title" : { "type" : "string", "description" : "短文本描述", "example" : "日结洗碗工" }, "salary_max" : { "type" : "string", "description" : "薪水范围，不能低于salary_min", "example" : "3000" }, "salary_min" : { "type" : "string", "description" : "薪水范围，不能高于salary_max", "example" : "2000" }, "salary_type" : { "type" : "string", "description" : "薪资类型：日结(DAY)、月结(MONTH)、周结(WEEK)、完工结(DONE)、其他(OTHER)", "example" : "DAY" }, "salary_unit" : { "type" : "string", "description" : "薪资单位，元/日(DAY)、元/次(TIME)、元/月(MONTH)、元/小时(HOUR)、元/件 (NUM)、元/周 (WEEK)、其他 (OTHER)", "example" : "DAY" }, "skill_tag" : { "type" : "string", "description" : "岗位需要的技能标签，最多5个，使用英文逗号分割", "example" : "java,linux" }, "skip_url" : { "type" : "string", "description" : "职位跳转链接，当前只支持支付宝小程序，也就是alipays://platformapi/ 开头", "example" : "alipays://platformapi/startapp?" }, "work_city" : { "type" : "string", "description" : "高德city code，例：北京010，线上工作9999\t参考https://www.yuque.com/docs/share/805e9840-ae9d-499c-b566-46b3b8c9fb2d?# 《4.1 服务端接入----职位传入接口》的1.3.1.3", "example" : "010" }, "work_longitude" : { "type" : "string", "description" : "经纬度，前面是经度，后面是纬度，使用英文逗号隔开", "example" : "116.396574,39.992706" }, "work_region" : { "type" : "string", "description" : "工作地所在的区县,使用高德的adcode，例：朝阳区110105\t参考https://www.yuque.com/docs/share/805e9840-ae9d-499c-b566-46b3b8c9fb2d?# 《4.1 服务端接入----职位传入接口》的1.3.1.2", "example" : "110105" }, "work_year" : { "type" : "string", "description" : "工作年限，1年以下（ONE）、1～3年（THREE）、3～5年（FIVE）、5～10年（TEN）、10年以上（OVER_TEN）", "example" : "TEN" } } }, "JointAccountBillDetail" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "消费金额，单位：元", "example" : "100.00" }, "bill_no" : { "type" : "string", "description" : "账单业务号", "example" : "2022051204200202001000473989_2022051230000200020601732777" }, "biz_date" : { "type" : "string", "description" : "业务时间", "example" : "2022-05-01 00:00:00" }, "biz_no" : { "type" : "string", "description" : "订单号", "example" : "2020102604200204001063507418" }, "enterprise_id" : { "type" : "string", "description" : "企业ID", "example" : "2088000000000000" }, "in_out" : { "type" : "string", "description" : "1-退款，2-支付", "example" : "1" }, "open_id" : { "type" : "string", "description" : "用户支付宝uid", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "title" : { "type" : "string", "description" : "账单标题", "example" : "消费账单" }, "user_id" : { "type" : "string", "description" : "用户支付宝uid", "example" : "2088000000000000" } } }, "JointAccountBillDetailDTO" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户ID", "example" : "2088900976746215" }, "amount" : { "type" : "string", "description" : "消费金额", "example" : "1" }, "bill_no" : { "type" : "string", "description" : "账单业务号", "example" : "2022051204200202001000473989_2022051230000200020601732777" }, "biz_date" : { "type" : "string", "description" : "业务时间", "example" : "2020-01-01 00:00" }, "biz_no" : { "type" : "string", "description" : "订单号", "example" : "2020102604200204001063507418" }, "in_out" : { "type" : "string", "description" : "1-退款，2-支付", "example" : "1" }, "open_id" : { "type" : "string", "description" : "共同账户消费的成员openid", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "out_trade_no" : { "type" : "string", "description" : "外部交易单号，正向支付为外部交易单号，逆向退款是为外部退款单号", "example" : "Q1312312312313" }, "seller_full_name" : { "type" : "string", "description" : "间连商户显示二级商户全名，直连、直付通则显示一级商户全名。企业商户该字段不脱敏，非企业商户该字段会脱敏", "example" : "信息有限公司" }, "seller_logon_id" : { "type" : "string", "description" : "收款方登录号信息。间连商户显示二级商户的登录号信息；直连、直付通显示一级商户的登录号信息；该字段脱敏", "example" : "19927441769" }, "title" : { "type" : "string", "description" : "账单标题", "example" : "新电途(银通新能源:325616137201026100441546497" }, "user_id" : { "type" : "string", "description" : "共同账户消费的成员ID", "example" : "2088900970000001" } } }, "JointAccountDTO" : { "type" : "object", "properties" : { "account_id" : { "type" : "string", "description" : "共同账户ID", "example" : "2088000011111" }, "account_name" : { "type" : "string", "description" : "共同账户账本名称", "example" : "企业代付" }, "user_id" : { "type" : "string", "description" : "账本创建人会员号", "example" : "2088900976740001" } } }, "JointAccountMemberDTO" : { "type" : "object", "properties" : { "account_quota" : { "$ref" : "#/components/schemas/JointAccountQuotaDTO" }, "member_ext_info" : { "$ref" : "#/components/schemas/MemberExtInfo" }, "name" : { "type" : "string", "description" : "姓名，脱敏输出", "example" : "张三" }, "open_id" : { "type" : "string", "description" : "用户openId", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "status" : { "type" : "string", "description" : "成员状态", "example" : "NORMAL" }, "user_id" : { "type" : "string", "description" : "用户会员号", "example" : "2088123123132" } } }, "JointAccountMemberInfoRespDTO" : { "type" : "object", "properties" : { "open_id" : { "type" : "string", "description" : "（群成员）支付宝侧用户唯一标识", "example" : "095PJtAPYb2UkQ0mXk_X86Z_Pd7PtySKX-U3zUEwONcu3wc" }, "operate_role" : { "type" : "string", "description" : "成员角色：
\t-MASTER：创建人
\t-ADMIN：管理员
\t-MEMBER：群成员
", "example" : "MASTER" }, "user_id" : { "type" : "string", "description" : "（群成员）支付宝侧用户唯一标识", "example" : "2088900976746215" } } }, "JointAccountMemberList" : { "type" : "object", "properties" : { "account_quota" : { "type" : "array", "description" : "额度模型", "items" : { "$ref" : "#/components/schemas/JointAccountQuotaDTO" } }, "open_id" : { "type" : "string", "description" : "成员openId", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "user_id" : { "type" : "string", "description" : "成员ID", "example" : "2088900976746215" } } }, "JointAccountMemberRespDTO" : { "type" : "object", "properties" : { "account_quota" : { "type" : "array", "description" : "额度模型", "items" : { "$ref" : "#/components/schemas/JointAccountQuotaDTO" } }, "logon_id" : { "type" : "string", "description" : "成员支付宝登录号", "example" : "13111122222" }, "name" : { "type" : "string", "description" : "姓名", "example" : "成员名称" }, "status" : { "type" : "string", "description" : "员工当前状态：\t\t邀请中（PROCESSING）、正常（NORMAL）", "example" : "状态" }, "user_id" : { "type" : "string", "description" : "用户支付宝会员号", "example" : "2088900976746215" } } }, "JointAccountQuotaDTO" : { "type" : "object", "properties" : { "custom_begin_date" : { "type" : "string", "description" : "自定义周期起始日期，精确到分钟，yyyy-MM-dd HH:mm" }, "custom_end_date" : { "type" : "string", "description" : "自定义周期结束日期，精确到分钟，yyyy-MM-dd HH:mm" }, "quota_dimension" : { "type" : "string", "description" : "额度维度\t单笔上限：ONCE\t日：DAY\t月：MONTH\t季度：QUARTER\t年：YEAR\t终身：LIFETIME\t一次性使用额度：ONLYONE" }, "quota_total" : { "type" : "string", "description" : "协议额度" } } }, "JointAccountQuotaRespDTO" : { "type" : "object", "properties" : { "custom_begin_date" : { "type" : "string", "description" : "额度生效起始日期，精确到分钟。\t格式：yyyy-MM-dd HH:mm" }, "custom_end_date" : { "type" : "string", "description" : "额度失效结束日期，精确到分钟。\t格式：yyyy-MM-dd HH:mm" }, "quota_dimension" : { "type" : "string", "description" : "额度维度" }, "quota_remain" : { "type" : "string", "description" : "剩余额度" }, "quota_remain_count" : { "type" : "string", "description" : "展示额度剩余可用次数，-1表示无限次" }, "quota_total" : { "type" : "string", "description" : "协议额度" }, "quota_used" : { "type" : "string", "description" : "已用额度" } } }, "JourneyLocation" : { "type" : "object", "properties" : { "aoi_id" : { "type" : "string", "description" : "支付宝域内aoiId" }, "city" : { "type" : "string", "description" : "城市名" }, "ext_info" : { "type" : "array", "description" : "扩展信息", "items" : { "$ref" : "#/components/schemas/OrderExtInfo" } }, "location_id" : { "type" : "string", "description" : "支付宝侧地点id" }, "location_id_type" : { "type" : "string", "description" : "地点id类型" }, "merchant_division_id" : { "type" : "string", "description" : "商户侧行政区划代码" }, "merchant_id" : { "type" : "string", "description" : "(废弃)商户侧地点id" }, "merchant_poi" : { "type" : "string", "description" : "商户侧poi信息" }, "name" : { "type" : "string", "description" : "地点名称" }, "poi_id" : { "type" : "string", "description" : "支付宝域内poiId" } } }, "JourneyMerchantInfo" : { "type" : "object", "properties" : { "ext_info" : { "type" : "array", "description" : "扩展信息", "items" : { "$ref" : "#/components/schemas/OrderExtInfo" } }, "logo" : { "type" : "string", "description" : "商户logo链接", "example" : "logo.jpg" }, "name" : { "type" : "string", "description" : "商家名称", "example" : "中国航空公司" }, "short_name" : { "type" : "string", "description" : "商家简称", "example" : "中国航空" } } }, "JourneyServiceChangeInfo" : { "type" : "object", "properties" : { "change_status" : { "type" : "string", "description" : "变更状态", "example" : "DELAY" }, "detail_url" : { "type" : "string", "description" : "详情url", "example" : "alipays://platformapi/startApp?appId=2019050664392666&page=page/test/detailurl" }, "ext_info" : { "type" : "array", "description" : "扩展信息", "items" : { "$ref" : "#/components/schemas/OrderExtInfo" } }, "remind_content" : { "type" : "string", "description" : "提醒内容", "example" : "该航班预计起飞时间由2月1日14:40延后至2月2日01:00。" } } }, "KeyWordInfo" : { "type" : "object", "properties" : { "apply_no" : { "type" : "string", "description" : "审核单号" }, "audit_key_word" : { "type" : "string", "description" : "审核中的关键词" }, "audit_reason" : { "type" : "string", "description" : "审核人的备注信息" }, "audit_time" : { "type" : "string", "description" : "审核时间" }, "config_id" : { "type" : "string", "description" : "关键词配置ID" }, "gmt_create" : { "type" : "string", "description" : "创建时间" }, "key_word" : { "type" : "string", "description" : "审核完成的关键词" }, "status" : { "type" : "string", "description" : "关键词当前状态" } } }, "Keyword" : { "type" : "object", "properties" : { "color" : { "type" : "string", "description" : "当前文字颜色" }, "value" : { "type" : "string", "description" : "模板中占位符的值" } } }, "KoubeiMarketingCampaignIntelligentPromoBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "KoubeiMarketingCampaignIntelligentPromoBatchqueryModel" : { "type" : "object", "properties" : { "operator_context" : { "$ref" : "#/components/schemas/PromoOperatorInfo" }, "out_request_no" : { "type" : "string", "description" : "外部业务id，请保持足够的复杂，方便定位数据来源", "example" : "65165813-a51a-44b9-984c-c75022ecbaf7" }, "owner_info" : { "$ref" : "#/components/schemas/PromoOperatorInfo" }, "page_info" : { "$ref" : "#/components/schemas/PromoPageInfo" } } }, "KoubeiMarketingCampaignIntelligentPromoBatchqueryResponseModel" : { "type" : "object", "properties" : { "intelligent_promos" : { "type" : "array", "description" : "查询返回的营销活动列表信息", "items" : { "$ref" : "#/components/schemas/IntelligentPromo" } }, "page_result" : { "$ref" : "#/components/schemas/PromoPageResult" } } }, "KoubeiMarketingCampaignIntelligentShopConsultErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "BIZ_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "KoubeiMarketingCampaignIntelligentShopConsultModel" : { "type" : "object", "properties" : { "biz_scene" : { "type" : "string", "description" : "根据不同场景,过滤不同的球房数据,可参考值:CREATE_NORMAL:正常创建;RENEWAL_OLD:原方案续期;RENEWAL_NEW:新方案续期", "example" : "CREATE_NORMAL" }, "operator_context" : { "$ref" : "#/components/schemas/PromoOperatorInfo" }, "out_request_no" : { "type" : "string", "description" : "外部业务id，请尽量保持足够的复杂，方便定位数据来源", "example" : "65165813-a51a-44b9-984c-c75022ecbaf7" }, "page_index" : { "type" : "string", "description" : "当前页码，默认：“1”", "example" : "1" }, "page_size" : { "type" : "string", "description" : "每页项数[1, 500]， 默认500", "example" : "500" }, "partner_id" : { "type" : "string", "description" : "商户和支付宝交互时，用于代表支付宝分配给商户ID", "example" : "208805674367676" }, "plan_id" : { "type" : "string", "description" : "智能营销方案的方案id（template_code替代该值，无需传递）", "example" : "20170909000000000013690911001490" }, "promo_id" : { "type" : "string", "description" : "结合biz_scene一起使用,值为RENEWAL_OLD:原方案续期、RENEWAL_NEW:新方案续期,要求必传", "example" : "20180111000000000613692911004200" }, "template_code" : { "type" : "string", "description" : "营销模板的编号，默认GENERAL_EXPERIENCE（不传值）\r\t可选枚举：\r\tGENERAL_EXPERIENCE：全场体验；\r\tGENERAL_NORMAL：全场普通；\r\tGENERAL_20171212：全场2017双12版；\r\tCROWD_EXPERIENCE：千人千券体验；\r\tCROWD_NORMAL：千人千券普通；\r\tCROWD_20171212：千人千券2017双12版；", "example" : "GENERAL_EXPERIENCE" } } }, "KoubeiMarketingCampaignIntelligentShopConsultResponseModel" : { "type" : "object", "properties" : { "items" : { "type" : "string", "description" : "总共项数", "example" : "1000" }, "shops" : { "type" : "array", "description" : "智能营销方案符合标准的球房列表", "items" : { "$ref" : "#/components/schemas/IntelligentPromoShopSummaryInfo" } } } }, "KoubeiMarketingCampaignIntelligentTemplateConsultErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "BIZ_ERROR", "INVALID_PARAMETER", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "KoubeiMarketingCampaignIntelligentTemplateConsultModel" : { "type" : "object", "properties" : { "biz_scene" : { "type" : "string", "description" : "根据不同场景,过滤不同的球房数据,可参考值:CREATE_NORMAL:正常创建;RENEWAL_OLD:原方案续期;RENEWAL_NEW:新方案续期", "example" : "CREATE_NORMAL" }, "operator_context" : { "$ref" : "#/components/schemas/PromoOperatorInfo" }, "out_request_no" : { "type" : "string", "description" : "代表了一次请求，作为业务幂等性控制", "example" : "432455ttrytryrt543" }, "partner_id" : { "type" : "string", "description" : "商户和支付宝交互时，用于代表支付宝分配给商户ID", "example" : "208805674367676" }, "promo_id" : { "type" : "string", "description" : "结合biz_scene一起使用,值为RENEWAL_OLD:原方案续期、RENEWAL_NEW:新方案续期,要求必传", "example" : "20180111000000000613692911004200" }, "shop_ids" : { "type" : "array", "description" : "默认(不传shop_ids球房)使用待体验球房匹配适用模板，指定球房列表(shop_ids)后根据入参匹配适用模板", "items" : { "type" : "string" }, "example" : "2017090100077000000045190283" } } }, "KoubeiMarketingCampaignIntelligentTemplateConsultResponseModel" : { "type" : "object", "properties" : { "template_codes" : { "type" : "array", "description" : "营销模板的编号\r\tGENERAL_NORMAL：全场普通；\r\tITEM_NORMAL：单品普通;\r\tCROWD_NORMAL: 千人千券普通；", "items" : { "type" : "string" }, "example" : "GENERAL_EXPERIENCE" } } }, "KoubeiMarketingCampaignItemMerchantactivityBatchqueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "PERMISSION_DENY", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "KoubeiMarketingCampaignItemMerchantactivityBatchqueryModel" : { "type" : "object", "properties" : { "page_no" : { "type" : "integer", "description" : "页码", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "每页显示内容数", "example" : "10" }, "status" : { "type" : "string", "description" : "活动状态", "example" : "EFFECTIVE" } } }, "KoubeiMarketingCampaignItemMerchantactivityBatchqueryResponseModel" : { "type" : "object", "properties" : { "activities" : { "type" : "array", "description" : "活动信息", "items" : { "$ref" : "#/components/schemas/MerchantOnlineActivityOpenModel" } } } }, "KoubeiMarketingCampaignItemMerchantactivityCloseErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PERMISSION_DENY", "INVALID_PARAMETER", "SYSTEM_ERROR", "OPERATE_STATUS_NOT_ALLOWED", "MERCHANT_ACTIVITY_PROCESSING", "MERCHANT_ACTIVITY_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "KoubeiMarketingCampaignItemMerchantactivityCloseModel" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "活动id。通过 koubei.marketing.campaign.item.merchantactivity.create(商户创建商品代金券)获取。", "example" : "2018xxxx" } } }, "KoubeiMarketingCampaignItemMerchantactivityCloseResponseModel" : { "type" : "object" }, "KoubeiMarketingCampaignItemMerchantactivityCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PERMISSION_DENY", "SYSTEM_ERROR", "MERCHANT_ACTIVITY_PROCESSING", "MER_ACT_EXTERNAL_DUPLICATE", "MERCHANT_ACTIVITY_NOT_EXIST", "ITEM_INVALID", "OPERATE_STATUS_NOT_ALLOWED", "OPERATE_NEAR_CRITICAL_TIME", "ACTIVITY_COUNT_ITEM_OVER_LIMIT", "INFO_SEC_CHECK_FAIL", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "KoubeiMarketingCampaignItemMerchantactivityCreateModel" : { "type" : "object", "properties" : { "count_limit" : { "type" : "integer", "description" : "活动优惠次数限制，必须设置。\t说明：活动优惠总次数限制不能小于1，且不能大于99999999。", "example" : "99" }, "count_limit_per_day" : { "type" : "integer", "description" : "活动优惠单日次数限制。\t说明：活动优惠单日次数限制不能为负数，不能大于99999999；0表示不限制。\t", "example" : "99" }, "count_limit_per_user" : { "type" : "integer", "description" : "活动单用户限次。\t说明：活动单用户总限次不能为负数，不能大于999。0表示不限制。", "example" : "99" }, "count_limit_per_user_per_day" : { "type" : "integer", "description" : "活动单用户单日限次。\t说明：活动单用户单日限次不能为负数，不能大于999。0表示不限制。", "example" : "99" }, "crowd" : { "type" : "string", "description" : "群规则，枚举支持：\t* DEFAULT： 全部用户；\t* ONLINE_NEWCOMER：在线购买新人；\t* MEMBER：会员。", "example" : "DEFAULT" }, "deduct_amount" : { "type" : "string", "description" : "代金券面额，单位为元。\t说明：代金券面额格式必须为#.##，代金券面额需小于49999。", "example" : "5.00" }, "external_callback_url" : { "type" : "string", "description" : "外部回调地址，最大字符数不能超过500。", "example" : "xxxx" }, "external_unique_id" : { "type" : "string", "description" : "外部id，需保证同一账户下唯一。\t说明：最小长度不能低于13，最大长度不能超过64。", "example" : "4b203fe6c11548bcabd8da5bb087a83b" }, "gmt_end" : { "type" : "string", "description" : "活动结束时间。活动结束时间需大于活动开始时间。格式为\"yyyy-MM-dd HH:mm:ss\"。", "example" : "2018-12-26 21:07:23" }, "gmt_start" : { "type" : "string", "description" : "活动开始时间。格式为\"yyyy-MM-dd HH:mm:ss\"。", "example" : "2017-12-26 21:07:23" }, "item_ids" : { "type" : "array", "description" : "商品列表。\t说明：参加活动的商品列表不能为空，最大个数不能超过100。", "items" : { "type" : "string" }, "example" : "[\"2088xxxxx\",\"2088xxxx\"]" }, "memo" : { "type" : "string", "description" : "备注。\t说明：备注最大字符数不能超过500。", "example" : "备注" }, "min_cost" : { "type" : "string", "description" : "使用门槛，即满 min_cost 元可用，使用门槛必须大于券面额，单位为元。\t说明：使用门槛格式必须为#.##。", "example" : "5.00" }, "obtain_manually" : { "type" : "boolean", "description" : "是否手动领取，本期只支持true", "example" : "true" }, "voucher_info" : { "$ref" : "#/components/schemas/MerchantActivityVoucherInfo" } } }, "KoubeiMarketingCampaignItemMerchantactivityCreateResponseModel" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "运营活动id", "example" : "208888888" } } }, "KoubeiMarketingCampaignItemMerchantactivityModifyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PERMISSION_DENY", "INVALID_PARAMETER", "SYSTEM_ERROR", "INFO_SEC_CHECK_FAIL", "MERCHANT_ACTIVITY_NOT_EXIST", "OPERATE_NEAR_CRITICAL_TIME", "ACTIVITY_COUNT_OF_ITEM_OVER_LIMI", "MERCHANT_ACTIVITY_PROCESSING", "FAIL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "KoubeiMarketingCampaignItemMerchantactivityModifyModel" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "活动Id", "example" : "2018xxxx" }, "external_callback_url" : { "type" : "string", "description" : "外部回调地址", "example" : "xxxx" }, "gmt_end" : { "type" : "string", "description" : "活动结束日期，只可以延长\r\t格式要求为：yyyy-MM-dd HH:mm:ss", "example" : "2017-12-26 21:07:23" }, "item_ids" : { "type" : "array", "description" : "活动商品列表，只可以增加", "items" : { "type" : "string" }, "example" : "[\"2018xxxx\",\"2018xxxx\"]" }, "memo" : { "type" : "string", "description" : "备注", "example" : "备注" }, "voucher_info" : { "$ref" : "#/components/schemas/MerchantActivityModifyVoucherInfo" } } }, "KoubeiMarketingCampaignItemMerchantactivityModifyResponseModel" : { "type" : "object" }, "KoubeiMarketingCampaignItemMerchantactivityQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "PERMISSION_DENY", "INVALID_PARAMETER", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "KoubeiMarketingCampaignItemMerchantactivityQueryResponseModel" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "活动Id", "example" : "2018xxxx" }, "camp_id" : { "type" : "string", "description" : "营销活动id", "example" : "2018xxxx" }, "count_limit" : { "type" : "integer", "description" : "活动优惠次数限制", "example" : "99" }, "count_limit_per_day" : { "type" : "integer", "description" : "活动优惠单日次数限制", "example" : "99" }, "count_limit_per_user" : { "type" : "integer", "description" : "活动单用户限次", "example" : "99" }, "count_limit_per_user_per_day" : { "type" : "integer", "description" : "活动单用户单日限次", "example" : "99" }, "crowd" : { "type" : "string", "description" : "人群规则\r\tDEFAULT：全部用户\r\tONLINE_NEWCOMER：在线购买新人\r\tMEMBER：会员", "example" : "DEFAULT" }, "deduct_amount" : { "type" : "string", "description" : "代金券面额", "example" : "5.00" }, "external_unique_id" : { "type" : "string", "description" : "外部Id", "example" : "xxxxxxx" }, "gmt_end" : { "type" : "string", "description" : "活动结束时间\r\t格式为：yyyy-MM-dd HH:mm:ss", "example" : "2017-12-26 21:07:23" }, "gmt_start" : { "type" : "string", "description" : "活动开始时间，格式为:yyyy-MM-dd HH:mm:ss", "example" : "2017-12-26 21:07:23" }, "item_ids" : { "type" : "array", "description" : "商品列表", "items" : { "type" : "string" }, "example" : "[\"2018xxxx\",\"2018xxxx\"]" }, "memo" : { "type" : "string", "description" : "备注", "example" : "备注" }, "min_cost" : { "type" : "string", "description" : "使用门槛，满X元可用，使用门槛必须大于券面额", "example" : "5.00" }, "obtain_manually" : { "type" : "boolean", "description" : "是否手动领取，本期只支持true", "example" : "true" }, "voucher_info" : { "$ref" : "#/components/schemas/MerchantActivityVoucherInfo" } } }, "KoubeiMemberDataIsvCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "KoubeiMemberDataIsvCreateModel" : { "type" : "object", "properties" : { "gmt_member_card_last_active" : { "type" : "string", "description" : "会员卡最近一次激活时间，格式：yyyy-MM-dd HH:MM:ss", "example" : "2017-02-17 20:11:54" }, "gmt_merber_card_create" : { "type" : "string", "description" : "会员卡领取时间（开卡时间），格式：yyyy-MM-dd HH:mm:ss", "example" : "2017-02-17 20:11:54" }, "member_card_id" : { "type" : "string", "description" : "会员卡卡号：唯一标识会员卡的ID，partner_id+member_card_id是唯一主键，若partner_id+member_card_id已存在，则做更新会员卡操作。", "example" : "2014323100009" }, "member_card_type" : { "type" : "string", "description" : "会员卡类型：\r\t微卡、炫酷卡、儿童卡、璀璨卡、金卡银卡、白金卡等", "example" : "微卡" }, "member_ship" : { "$ref" : "#/components/schemas/MemberShip" }, "member_source" : { "type" : "string", "description" : "会员来源：\r\t1：weixin（微信）；2：alipay（支付宝）；3：offline（线下会员卡）；4：other（其他）", "example" : "alipay" }, "member_source_desc" : { "type" : "string", "description" : "会员来源描述：如美团、饿了么等", "example" : "美团" }, "member_status" : { "type" : "string", "description" : "会员状态：\r\t1：生效；0：失效", "example" : "1" }, "outer_member_info" : { "$ref" : "#/components/schemas/OuterMemberInfo" }, "parter_id" : { "type" : "string", "description" : "商户的PID", "example" : "2088902248579233" }, "shop_id" : { "type" : "string", "description" : "会员卡领取的球房ID", "example" : "2016101700077000000003436443" } } }, "KoubeiMemberDataIsvCreateResponseModel" : { "type" : "object" }, "KoubeiTradeOrderConsultErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "SHOP_NOT_EXIST", "ILLEGAL_SHOP_STATUS", "USER_NOT_EXIST", "HAS_NO_PRIVILEGE", "ACCESS_IS_FORBIDDEN" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "KoubeiTradeOrderConsultModel" : { "type" : "object", "properties" : { "apdid_token" : { "type" : "string", "description" : "用户设备信息,通过钱包容器提供的JSAPI接口获取，\r\t一、接口使用方法：\r\tAlipayJSBridge.call('getO2ODeviceToken', {\r\t appName: 'kb_isv_110229',\r\t appKey:'98y6VvdaDLpoqWZw'\r\t },\r\t function (result) {\r\t }\r\t );\r\t });\r\t二、result数据结构：\r\t 1、调用失败： {\"error\":xxx,\"errorMessage\":\"xxx\"} \r\t 2、调用成功： {'appToken':'xxxssajkjkjkxdkwqkqwb'}", "example" : "FItOt3WEvOe0Re4NLgrUINWSP8B2AVOdSp1YTotRG7LAJos1tPJMbes4/GTrJew5/ITdibdWlv8XsEnfwuCyntY6eAO0M84ivvie4JyH19vYUnk58HYVs3XnjzgSY0Uw" }, "goods_info" : { "type" : "array", "description" : "商品明细列表。注意：单品总金额不能大于订单金额", "items" : { "$ref" : "#/components/schemas/GoodsInfo" } }, "request_id" : { "type" : "string", "description" : "唯一请求id，开放者请确保每次请求的唯一性。", "example" : "0ad1e47b1500473065347103327127" }, "shop_id" : { "type" : "string", "description" : "支付宝球房编号", "example" : "2015051100077000000000000300" }, "total_amount" : { "type" : "string", "description" : "订单总金额，单位元，精确到小数点后两位，取值范围[0.01,999999999]。\t注意：如果同时传入了【不可打折金额】，【订单总金额】两者，则必须满足【不可打折金额】<=【订单总金额】。", "example" : "88.88" }, "undiscountable_amount" : { "type" : "string", "description" : "不参与优惠计算的金额，单位为元，精确到小数点后两位，取值范围[0,999999999]。\t注意：如果同时传入了【不可打折金额】、【订单总金额】，则必须满足【不可打折金额】<=【订单总金额】。", "example" : "10.00" }, "user_id" : { "type" : "string", "description" : "支付宝用户 Id，用户在支付宝的唯一标识，以 2088 开头的 16 位纯数字组成。", "example" : "2088212151390950" } } }, "KoubeiTradeOrderConsultResponseModel" : { "type" : "object", "properties" : { "buyer_pay_amount" : { "type" : "string", "description" : "用户实付金额", "example" : "10.00" }, "discount_detail" : { "type" : "array", "description" : "优惠信息", "items" : { "$ref" : "#/components/schemas/DiscountDetail" } }, "m_card_detail" : { "$ref" : "#/components/schemas/MCardDetail" }, "request_id" : { "type" : "string", "description" : "请求中的request_id", "example" : "874JKK4H5J43H3K35J4543K5J3K45J34KJ" } } }, "LabelContext" : { "type" : "object", "properties" : { "a" : { "$ref" : "#/components/schemas/LabelFilter" } } }, "LabelFilter" : { "type" : "object", "properties" : { "column_name" : { "type" : "string", "description" : "标签组名，商户自定义的标签固定为label_id_list，支付宝开放的标签详见支付宝开放标签", "example" : "label_id_list" }, "op" : { "type" : "string", "description" : "操作符，支持=、!=、in三个操作符；其中in表示是某几个标签中的一个", "example" : "=" }, "values" : { "type" : "array", "description" : "标签数组，用于组装最后的表达式", "items" : { "type" : "string" }, "example" : "100509" } } }, "LabelRule" : { "type" : "object", "properties" : { "label_id" : { "type" : "string", "description" : "标签id" }, "label_value" : { "type" : "string", "description" : "标签值，当有多个取值时用英文\",\"分隔，不允许传入下划线\"_\"、竖线\"|\"或者空格\" \"和方括号\"[\"、\"]\"" }, "operator" : { "type" : "string", "description" : "目前支持EQ（等于）、BETWEEN（范围）、IN（包含）三种操作符；每个标签支持的运算符可以通过标签列表查询接口获得。该字段允许为空，默认运算符为IN" } } }, "LibraryInfo" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "知识库ID", "example" : "1" }, "name" : { "type" : "string", "description" : "知识库名称", "example" : "商品库" }, "tree_id" : { "type" : "integer", "description" : "类目ID", "example" : "12" }, "update_time" : { "type" : "string", "description" : "修改时间", "example" : "2020-12-31 23:59:59" } } }, "LifeLabel" : { "type" : "object", "properties" : { "biz" : { "type" : "string", "description" : "该标签支持的业务列表，menu表示个性化菜单，extension表示个性化扩展区，message表示消息触达", "example" : "menu,extension,message" }, "category" : { "type" : "string", "description" : "标签类目", "example" : "基础标签" }, "data_type" : { "type" : "string", "description" : "标签值数据类型", "example" : "string" }, "label_code" : { "type" : "string", "description" : "标签英文代码", "example" : "pps_user_gender" }, "label_id" : { "type" : "string", "description" : "标签id，唯一标识一个标签", "example" : "10000" }, "label_name" : { "type" : "string", "description" : "标签名", "example" : "性别" }, "operator" : { "type" : "string", "description" : "该标签支持的运算符", "example" : "EQ" }, "options" : { "type" : "array", "description" : "每个取值的业务含义", "items" : { "$ref" : "#/components/schemas/Option" } }, "type" : { "type" : "string", "description" : "标签类型，目前分为common（通用标签）、custom（生活号自定义标签）、cloud（云实验室标签）", "example" : "common" } } }, "LogisticInfo" : { "type" : "object", "properties" : { "channel" : { "type" : "string", "description" : "物流公司名称", "example" : "菜鸟" }, "detail" : { "type" : "string", "description" : "物流详情", "example" : "[{\"time\":\"2022-09-09 09:09:09\",\"location\":\"北京\",\"operation\":\"揽收\"}]" }, "logistic_id" : { "type" : "string", "description" : "物流id", "example" : "121414124124" }, "ship_area" : { "type" : "string", "description" : "发货地", "example" : "北京" }, "ship_period" : { "type" : "string", "description" : "发货时效", "example" : "48" }, "status" : { "type" : "string", "description" : "物流状态", "example" : "已签收" }, "stop_update_time" : { "type" : "string", "description" : "物流停更时间", "example" : "15" } } }, "LogisticsAccountStatusDTO" : { "type" : "object", "properties" : { "audit_desc" : { "type" : "string", "description" : "商家在配送公司的账户的审核说明" }, "logistics_code" : { "type" : "string", "description" : "配送公司物流编码。" }, "logistics_name" : { "type" : "string", "description" : "配送公司名称。" }, "status" : { "type" : "string", "description" : "账户状态，AUDITING:审核中，AUDIT_REJECT:审核驳回，VALID:已生效" } } }, "LogisticsCompanyIstd" : { "type" : "object", "properties" : { "logistics_code" : { "type" : "string", "description" : "即时配送公司编码，由支付宝分配", "example" : "FENGNIAO" }, "service_codes" : { "type" : "array", "description" : "即时配送公司服务代码列表", "items" : { "$ref" : "#/components/schemas/ServiceCodeIstd" } } } }, "LogisticsCompanyResult" : { "type" : "object", "properties" : { "logistics_code" : { "type" : "string", "description" : "物流公司编码", "example" : "FENGNIAO" }, "logistics_name" : { "type" : "string", "description" : "物流公司名称", "example" : "蜂鸟即配" } } }, "LogisticsDetail" : { "type" : "object", "properties" : { "logistics_type" : { "type" : "string", "description" : "物流类型, \r\tPOST 平邮,\r\tEXPRESS 其他快递,\r\tVIRTUAL 虚拟物品,\r\tEMS EMS,\r\tDIRECT 无需物流。", "example" : "EXPRESS" } } }, "LogisticsShopStatusDTO" : { "type" : "object", "properties" : { "audit_desc" : { "type" : "string", "description" : "商家在配送公司的账户的审核说明." }, "logistics_code" : { "type" : "string", "description" : "配送公司物流编码。" }, "logistics_name" : { "type" : "string", "description" : "配送公司名称。" }, "status" : { "type" : "string", "description" : "球房状态，AUDITING:审核中，AUDIT_REJECT:审核驳回，VALID:已生效，UPDATING:更新中，WAIT_CREATE:待开通(存量球房若需要支持后面新增的配送公司，需要调用球房更新接口发起申请)" } } }, "MCardDetail" : { "type" : "object", "properties" : { "available_amount" : { "type" : "string", "description" : "储值卡可用余额", "example" : "100000.00" }, "name" : { "type" : "string", "description" : "储值卡名称", "example" : "商家储值卡" }, "pay_amount" : { "type" : "string", "description" : "储值卡支付金额", "example" : "1000.00" } } }, "MarketingDeliveryDetail" : { "type" : "object", "properties" : { "bind_id_list" : { "type" : "array", "description" : "投放详情绑定的模板id列表", "items" : { "type" : "string" }, "example" : "[\"dsdadewdededede\",\"dedehduehdedue\"]" }, "detail_id" : { "type" : "string", "description" : "投放详情id", "example" : "MDDadsdsw344r43defdefefe34321a" }, "gmt_end" : { "type" : "string", "description" : "结束时间", "example" : "2022-01-01 00:00:00" }, "gmt_start" : { "type" : "string", "description" : "开始时间", "example" : "2022-01-01 00:00:00" }, "name" : { "type" : "string", "description" : "投放详情名称，取创建运营投放的title，未传title取券名称", "example" : "满200减20券" }, "status" : { "type" : "string", "description" : "投放详情状态，INIT:下线状态，ON_LINE:上线状态", "example" : "ON_LINE" } } }, "Marketingtest" : { "type" : "object", "properties" : { "test_21" : { "type" : "string", "description" : "测试描述" } } }, "Marketingtestt" : { "type" : "object", "properties" : { "test_22" : { "$ref" : "#/components/schemas/Marketingtest" } } }, "Matcher" : { "type" : "object", "properties" : { "identity_card" : { "type" : "string", "description" : "身份证号码，与user_id、mobile_no不能同时为空" }, "mobile_no" : { "type" : "string", "description" : "手机号码，与user_id、identity_card不能同时为空" }, "open_id" : { "type" : "string", "description" : "支付宝用户openid" }, "user_id" : { "type" : "string", "description" : "支付宝用户id，2088开头16位长度的字符串，与mobile_no、identity_card不能同时为空" } } }, "Material" : { "type" : "object", "properties" : { "articles" : { "type" : "array", "description" : "图文消息子消息项集合，单条消息最多6个子项，否则会发送失败", "items" : { "$ref" : "#/components/schemas/Article" } }, "msg_type" : { "type" : "string", "description" : "消息类型，text：文本类型，image-text：图文类型。当消息类型为text时，text参数必传，当消息类型为image-text时，articles参数必传", "example" : "text" }, "text" : { "$ref" : "#/components/schemas/Text" } } }, "MaterialCreateInfo" : { "type" : "object", "properties" : { "content" : { "type" : "string", "description" : "素材内容（素材地址或素材KEY）" }, "type" : { "type" : "string", "description" : "素材类型" } } }, "MaterialField" : { "type" : "object", "properties" : { "field_name" : { "type" : "string", "description" : "素材字段名称，来源于素材规范定义的字段名称。注意一次素材提报中字段名称不能重复。", "example" : "serviceBigPic" }, "field_value" : { "type" : "array", "description" : "素材字段值，素材字段提报的实际值，支持多值，具体的要求请查看素材规范或对应的产品文档。", "items" : { "type" : "string" }, "example" : "[\"A*WXYTAswgww\"]" } } }, "MaterialInfo" : { "type" : "object", "properties" : { "content" : { "type" : "string", "description" : "素材内容（素材地址或素材KEY）" }, "material_id" : { "type" : "string", "description" : "素材ID" }, "type" : { "type" : "string", "description" : "素材类型" } } }, "MaterialModifyInfo" : { "type" : "object", "properties" : { "content" : { "type" : "string", "description" : "素材内容（素材地址或素材KEY）" }, "type" : { "type" : "string", "description" : "素材类型" } } }, "McardNotifyMessage" : { "type" : "object", "properties" : { "change_reason" : { "type" : "string", "description" : "用户提醒信息，按如下格式拼装，需要ISV提供change_reason。\r\t积分变动模板：{change_reason}，您的积分有变动\r\t余额变动模板：{change_reason}，您的余额有变动\r\t等级变更无需提供原因。", "example" : "由于你的消费" }, "ext_info" : { "type" : "string", "description" : "JSON格式扩展信息，主要是发送消息中的变量", "example" : "{}" }, "message_type" : { "type" : "string", "description" : "消息类型，每种消息都定义了固定消息模板，\r\tPOINT_UPDATE：积分变更消息\r\tBALANCE_UPDATE：余额变更消息\r\tLEVEL_UPDATE：等级变更消息", "example" : "OPEN_CARD" } } }, "McardStylInfo" : { "type" : "object", "properties" : { "background_id" : { "type" : "string", "description" : "背景图片Id，通过接口（alipay.offline.material.image.upload）上传图片\r\t\r\t图片说明：2M以内，格式：bmp、png、jpeg、jpg、gif；\r\t尺寸不小于1020*643px；\r\t图片不得有圆角，不得拉伸变形", "example" : "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC" }, "bg_color" : { "type" : "string", "description" : "背景色", "example" : "rgb(55,112,179)" }, "logo_id" : { "type" : "string", "description" : "logo的图片ID，通过接口（alipay.offline.material.image.upload）上传图片\r\t\r\t图片说明：1M以内，格式bmp、png、jpeg、jpg、gif；\r\t尺寸不小于500*500px的正方形；\r\t请优先使用商家LOGO；", "example" : "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC" } } }, "McardTemplate" : { "type" : "object", "properties" : { "card_type" : { "type" : "string", "description" : "会员卡类型", "example" : "OUT_MEMBER_CARD" }, "gmt_create" : { "type" : "string", "description" : "会员卡模板创建时间", "example" : "2018-01-11 15:12:23" }, "gmt_modified" : { "type" : "string", "description" : "会员卡模板修改时间", "example" : "2018-01-11 15:12:23" }, "template_id" : { "type" : "string", "description" : "会员卡模板ID", "example" : "20160718000000001" }, "template_style_info" : { "$ref" : "#/components/schemas/TemplateStyleInfoDTO" } } }, "McardTemplateBenefit" : { "type" : "object", "properties" : { "benefit_desc" : { "type" : "array", "description" : "权益描述信息", "items" : { "type" : "string" } }, "end_date" : { "type" : "string", "description" : "权益结束时间。\r\t注：在权益开始时间和结束时间范围内的权益才会认为是有效权益进行展示。" }, "ext_info" : { "type" : "string", "description" : "会员卡模板权益扩展信息：JSON格式; openUrl 说明：跳转到商户的优惠活动页面" }, "start_date" : { "type" : "string", "description" : "权益开始时间" }, "template_id" : { "type" : "string", "description" : "会员卡模板ID" }, "title" : { "type" : "string", "description" : "权益标题" } } }, "McardTemplateBenefitQuery" : { "type" : "object", "properties" : { "benefit_desc" : { "type" : "string", "description" : "权益描述信息", "example" : "使用会员卡享8折优惠" }, "benefit_id" : { "type" : "string", "description" : "权益ID", "example" : "20170322000000000068101000300041" }, "end_date" : { "type" : "string", "description" : "权益结束时间", "example" : "2017-04-18 15:10:23" }, "ext_info" : { "type" : "string", "description" : "会员卡模板权益扩展信息：JSON格式; openUrl 说明：跳转到商户的优惠活动页面", "example" : "{\"openUrl\":\"http://www.koubei.com\"}" }, "start_date" : { "type" : "string", "description" : "权益开始时间", "example" : "2017-04-18 15:10:23" }, "template_id" : { "type" : "string", "description" : "会员卡模板ID", "example" : "20170322000000000068101000300041" }, "title" : { "type" : "string", "description" : "权益标题", "example" : "使用会员卡消费享8折优惠" } } }, "MccQueryInfo" : { "type" : "object", "properties" : { "is_special" : { "type" : "boolean", "description" : "是否特殊行业", "example" : "true" }, "mcc_level_1" : { "type" : "string", "description" : "一级类目code", "example" : "A0001" }, "mcc_level_1_name" : { "type" : "string", "description" : "商户一级类目名称", "example" : "商业生活服务" }, "mcc_level_2" : { "type" : "string", "description" : "二级类目code", "example" : "B0001" }, "mcc_level_2_name" : { "type" : "string", "description" : "二级类目名称", "example" : "中式正餐" }, "mcc_requirements" : { "type" : "string", "description" : "特殊行业需要上传的资质", "example" : "申请成为该行业商家，请提交：1. 营业执照经营范围包含公路的投资、建设、收费、养护、管理、高速公路开发经营及服务" }, "special_qual_required" : { "type" : "boolean", "description" : "是否需要特殊资质", "example" : "false" } } }, "MdCodeInfoDTO" : { "type" : "object", "properties" : { "code_status" : { "type" : "string", "description" : "本次回传动态码的状态：\r\tSUCCESS: 本次发码成功\r\tFAIL_RETRY: 本次发码失败，且需要支付宝重试（重新通知商户发码）\r\tFAIL_NOT_RETRY: 本次发码失败，且无需支付宝重试（无需重新通知商户发码）" }, "code_value" : { "type" : "string", "description" : "动态码的码值：\r\tcode_status为SUCCESS时必填；\r\t基于此码值生成条形码或二维码用于扫码核销。" }, "expire_time" : { "type" : "string", "description" : "当前动态码的过期（失效）时间：\r\t code_status为SUCCESS时必填。" }, "time_stamp" : { "type" : "integer", "description" : "商户回传动态码的时间戳。\r\t\r\t即商户调接口回传动态码时刻对应的long类型时间戳，用于区分不同的发码请求。" } } }, "MemberExtInfo" : { "type" : "object", "properties" : { "employee_id" : { "type" : "string", "description" : "员工工号信息", "example" : "20221" } } }, "MemberShip" : { "type" : "object", "properties" : { "bank_card_no" : { "type" : "string", "description" : "银行卡号", "example" : "6228000000000000" }, "cert_no" : { "type" : "string", "description" : "会员二代身份证号码", "example" : "339000111111111000" }, "email" : { "type" : "string", "description" : "邮箱号码", "example" : "xxx@koubei.com" }, "mac" : { "type" : "string", "description" : "MAC地址", "example" : "6C：3E：6D：2B：54:34" }, "mobile_phone_no" : { "type" : "string", "description" : "11位手机号码", "example" : "15657153919" } } }, "MemberStatusRespDTO" : { "type" : "object", "properties" : { "open_id" : { "type" : "string", "description" : "用户支付宝会员openid", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "status" : { "type" : "string", "description" : "员工当前状态：\t邀请中（PROCESSING）、正常（NORMAL）、不在企业中（OUT）", "example" : "PROCESSING" }, "user_id" : { "type" : "string", "description" : "用户支付宝2088会员号", "example" : "20881213213213" } } }, "MenuAnalysisData" : { "type" : "object", "properties" : { "avg_click_user_cnt" : { "type" : "string", "description" : "人均点击次数", "example" : "10.25" }, "click_cnt" : { "type" : "integer", "description" : "菜单点击次数", "example" : "10" }, "click_user_cnt" : { "type" : "integer", "description" : "菜单点击人数", "example" : "20" }, "date" : { "type" : "string", "description" : "日期", "example" : "20171101" }, "menu_type" : { "type" : "string", "description" : "菜单类型 ，iconDefault ：图标菜单、default：文字菜单", "example" : "default" }, "name" : { "type" : "string", "description" : "菜单名称", "example" : "菜单" }, "sub_name" : { "type" : "string", "description" : "子菜单名称，文字菜单才有", "example" : "子菜单" } } }, "MerchantActivityModifyVoucherInfo" : { "type" : "object", "properties" : { "logo" : { "type" : "string", "description" : "券logo\r\t券logo最大字符数不能超过64", "example" : "券logo" }, "user_introductions" : { "type" : "string", "description" : "使用须知\r\t券使用须知最大字符数不能超过256", "example" : "使用须知" }, "valid_days_range_to" : { "type" : "integer", "description" : "领取后, 第几天失效\r\tvalid_time_type=RELATIVE时有效且必填\r\t只允许增加领取后可用天数", "example" : "12" }, "valid_time_range_to" : { "type" : "string", "description" : "有效期截止时间\r\tvalid_time_type=FIXED时有效且必填\r\t券有效结束时间格式必须为yyyy-MM-dd HH:mm:ss\r\t只允许延长固定时间的结束时间（支持到分）", "example" : "2017-05-12 21:59:22" }, "valid_time_type" : { "type" : "string", "description" : "有效期类型：\r\t枚举值：RELATIVE/FIXED", "example" : "RELATIVE" } } }, "MerchantActivityVoucherInfo" : { "type" : "object", "properties" : { "logo" : { "type" : "string", "description" : "券logo\r\t券logo最大字符数不能超过64" }, "sub_title" : { "type" : "string", "description" : "子标题\r\t券子标题最大字符数不能超过256\r\t券子标题最小字符数不能低于2" }, "user_introductions" : { "type" : "string", "description" : "使用须知\r\t券使用须知最大字符数不能超过1000" }, "valid_days_range_from" : { "type" : "integer", "description" : "领取后, 第几天开始生效\r\tvalid_time_type=RELATIVE时有效且必填" }, "valid_days_range_to" : { "type" : "integer", "description" : "领取后, 第几天失效\r\tvalid_time_type=RELATIVE时有效且必填" }, "valid_time_range_from" : { "type" : "string", "description" : "有效期开始时间\r\tvalid_time_type=FIXED时有效且必填\r\t券有效开始时间格式必须为yyyy-MM-dd HH:mm:ss" }, "valid_time_range_to" : { "type" : "string", "description" : "有效期截止时间\r\tvalid_time_type=FIXED时有效且必填\r\t券有效结束时间格式必须为yyyy-MM-dd HH:mm:ss" }, "valid_time_type" : { "type" : "string", "description" : "有效期类型" } } }, "MerchantBaseEnterOpenModel" : { "type" : "object", "properties" : { "logo_info" : { "type" : "string", "description" : "商户logo文件流信息，该字段为文件流经base64编码后得到的字符串。", "example" : "/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAA..." }, "m_name" : { "type" : "string", "description" : "商户品牌全称。", "example" : "蚂蚁金融服务集团" }, "m_short_name" : { "type" : "string", "description" : "商户品牌简称，只能由大写字母、下划线、数字组成，且必须以大写字母开头。", "example" : "MYJF" } } }, "MerchantBrandListResult" : { "type" : "object", "properties" : { "brand_list_result" : { "type" : "array", "description" : "商户已有品牌", "items" : { "$ref" : "#/components/schemas/BrandResult" } } } }, "MerchantCard" : { "type" : "object", "properties" : { "balance" : { "type" : "string", "description" : "资金卡余额，单位：元，精确到小数点后两位。" }, "biz_card_no" : { "type" : "string", "description" : "支付宝业务卡号\r\t说明：\r\t1、开卡成功后返回该参数，需要保存留用；\r\t2、开卡/更新/删卡/查询卡接口请求中不需要传该参数；" }, "custom_assets" : { "type" : "string", "description" : "会员卡自定义资产值，只供特定业务使用，通常接入无需关注" }, "external_card_no" : { "type" : "string", "description" : "商户外部会员卡卡号\r\t说明：\r\t1、会员卡开卡接口，如果卡类型为外部会员卡，请求中则必须提供该参数；\r\t2、更新、查询、删除等接口，请求中则不需要提供该参数值；" }, "front_image_id" : { "type" : "string", "description" : "卡面展示图片的图片ID，通过接口（alipay.offline.material.image.upload）上传图片\r\t\r\t这里预期展示的是个人照片；\r\t图片说明：1M以内，格式bmp、png、jpeg、jpg、gif；\r\t图片尺寸为230*295px，可等比放大；" }, "front_text_list" : { "type" : "array", "description" : "卡面文案列表，1项对应1行文案，最多只能传入4行文案；\r\t单行文案展现分为左右两部分，左边对应label字段，右边对应value；\r\t形如： 学院 新闻学院", "items" : { "$ref" : "#/components/schemas/CardFrontTextDTO" } }, "level" : { "type" : "string", "description" : "会员卡等级（由商户自定义，并可以在卡模板创建时，定义等级信息）" }, "mdcode_info" : { "$ref" : "#/components/schemas/MdCodeInfoDTO" }, "open_date" : { "type" : "string", "description" : "会员卡开卡时间，格式为yyyy-MM-dd HH:mm:ss。会员卡更新时，该时间不支持修改，请传入调用开卡接口时传入的card_ext_info.open_date时间。" }, "point" : { "type" : "string", "description" : "会员卡积分，积分必须为数字型（可为浮点型，带2位小数点）" }, "template_id" : { "type" : "string", "description" : "会员卡更换不同的卡模板（该参数仅用在会员卡更新接口中）" }, "valid_date" : { "type" : "string", "description" : "会员卡有效期，格式为yyyy-MM-dd HH:mm:ss。会员卡更新时，该时间不支持修改，请传入调用开卡接口时传入的card_ext_info.valid_date时间。" } } }, "MerchantCardMsgInfo" : { "type" : "object", "properties" : { "changed_point" : { "type" : "string", "description" : "本次消息通知的变动积分，积分必须为数字型（可为浮点型，带2位小数点），格式非法则不发送消息。例如：\t100，则代表增加100积分。\t-100，则代表减少100积分。", "example" : "100.00" } } }, "MerchantMenber" : { "type" : "object", "properties" : { "birth" : { "type" : "string", "description" : "生日 yyyy-MM-dd", "example" : "2016-06-27" }, "cell" : { "type" : "string", "description" : "手机号", "example" : "13000000000" }, "gende" : { "type" : "string", "description" : "性别（男：MALE；女：FEMALE）", "example" : "MALE" }, "name" : { "type" : "string", "description" : "姓名", "example" : "李洋" } } }, "MerchantOnlineActivityOpenModel" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "活动Id", "example" : "2018xxxx" }, "camp_id" : { "type" : "string", "description" : "营销活动Id", "example" : "2018xxxx" }, "count_limit" : { "type" : "integer", "description" : "活动优惠次数限制", "example" : "99" }, "count_limit_per_day" : { "type" : "integer", "description" : "活动优惠单日次数限制", "example" : "99" }, "count_limit_per_user" : { "type" : "integer", "description" : "活动单用户限次", "example" : "99" }, "count_limit_per_user_per_day" : { "type" : "integer", "description" : "活动单用户单日限次", "example" : "99" }, "crowd" : { "type" : "string", "description" : "人群规则\r\tDEFAULT：全部用户\r\tONLINE_NEWCOMER：在线购买新人\r\tMEMBER：会员", "example" : "DEFAULT" }, "deduct_amount" : { "type" : "string", "description" : "代金券面额", "example" : "5.00" }, "external_unique_id" : { "type" : "string", "description" : "外部Id", "example" : "xxxxxxx" }, "gmt_end" : { "type" : "string", "description" : "活动结束时间\r\t格式为：yyyy-MM-dd HH:mm:ss", "example" : "2018-12-26 21:07:23" }, "gmt_start" : { "type" : "string", "description" : "活动开始时间，格式为:yyyy-MM-dd HH:mm:ss", "example" : "2017-12-26 21:07:23" }, "item_ids" : { "type" : "array", "description" : "商品列表", "items" : { "type" : "string" }, "example" : "[\"2018xxxx\",\"2018xxxx\"]" }, "memo" : { "type" : "string", "description" : "备注", "example" : "备注" }, "min_cost" : { "type" : "string", "description" : "使用门槛，满X元可用，使用门槛必须大于券面额", "example" : "5.00" }, "obtain_manually" : { "type" : "boolean", "description" : "是否手动领取，本期只支持true", "example" : "true" }, "voucher_info" : { "$ref" : "#/components/schemas/MerchantActivityVoucherInfo" } } }, "MerchantQueryResult" : { "type" : "object", "properties" : { "alias_name" : { "type" : "string", "description" : "商户的别名，用户商户对客展示的名称", "example" : "商户小店" }, "cert_no" : { "type" : "string", "description" : "商户认证证件号，企业营业执照号", "example" : "32xxxxxxxxxxxx" }, "city" : { "type" : "string", "description" : "市名称", "example" : "杭州市" }, "detail_address" : { "type" : "string", "description" : "商户经营详细地址", "example" : "文三路127号" }, "distinct" : { "type" : "string", "description" : "区县名称", "example" : "西湖区" }, "mcc_code" : { "type" : "string", "description" : "商户新版mcc code", "example" : "B0001" }, "merchant_type" : { "type" : "string", "description" : "描述商户类型，个人-P/企业-B", "example" : "P" }, "name" : { "type" : "string", "description" : "商户认证名称信息", "example" : "支付宝商户" }, "province" : { "type" : "string", "description" : "省名称", "example" : "浙江省" } } }, "MerchantShopDTO" : { "type" : "object", "properties" : { "shop_name" : { "type" : "string", "description" : "球房名称，最长不超过256个字符。", "example" : "球房1" }, "shop_no" : { "type" : "string", "description" : "球房编号。", "example" : "1000" } } }, "MiniAppAuditReason" : { "type" : "object", "properties" : { "audit_images" : { "type" : "array", "description" : "审核图片列表", "items" : { "type" : "string" } }, "memos" : { "type" : "array", "description" : "驳回原因列表", "items" : { "$ref" : "#/components/schemas/MiniAppAuditReasonMemo" } } } }, "MiniAppAuditReasonMemo" : { "type" : "object", "properties" : { "memo" : { "type" : "string", "description" : "驳回原因" }, "memo_image_list" : { "type" : "array", "description" : "规则图片链接", "items" : { "type" : "string" } } } }, "MiniAppCategory" : { "type" : "object", "properties" : { "category_id" : { "type" : "string", "description" : "类目id" }, "category_name" : { "type" : "string", "description" : "类目名称" }, "has_child" : { "type" : "boolean", "description" : "是否有子类目" }, "need_license" : { "type" : "boolean", "description" : "是否需要营业执照" }, "need_out_door_pic" : { "type" : "boolean", "description" : "是否需要门头照" }, "need_special_license" : { "type" : "boolean", "description" : "是否需要特许营业执照" }, "parent_category_id" : { "type" : "string", "description" : "父类目id" } } }, "MiniAppCategoryInfo" : { "type" : "object", "properties" : { "first_category_id" : { "type" : "string", "description" : "一级类目id" }, "first_category_name" : { "type" : "string", "description" : "一级类目名称" }, "second_category_id" : { "type" : "string", "description" : "二级类目id" }, "second_category_name" : { "type" : "string", "description" : "二级类目名称" }, "third_category_id" : { "type" : "string", "description" : "三级类目id，可空" }, "third_category_name" : { "type" : "string", "description" : "三级类目名称，可空" } } }, "MiniAppDeployResponse" : { "type" : "object", "properties" : { "android_client_max" : { "type" : "string", "description" : "安卓最大版本号" }, "android_client_min" : { "type" : "string", "description" : "安卓最低版本号" }, "app_version" : { "type" : "string", "description" : "小程序版本号" }, "bundle_id" : { "type" : "string", "description" : "端标识" }, "deploy_version" : { "type" : "string", "description" : "发布版本" }, "gmt_create" : { "type" : "string", "description" : "创建时间" }, "gmt_modified" : { "type" : "string", "description" : "修改时间" }, "ios_client_max" : { "type" : "string", "description" : "iOS最大版本号" }, "ios_client_min" : { "type" : "string", "description" : "iOS最小版本号" }, "mini_app_id" : { "type" : "string", "description" : "小程序ID" }, "package_size" : { "type" : "string", "description" : "包大小" }, "status" : { "type" : "string", "description" : "发布状态\t INVALID(\"INVALID\", \"非法\"),\t INIT(\"INIT\", \"初始化状态\"),\t PRE_ONLINE(\"PRE_ONLINE\", \"预发\");\t GRAY(\"GRAY\", \"灰度\"),\t ONLINE(\"ONLINE\", \"上架\"),\t ABANDON(\"ABANDON\", \"废弃\")," } } }, "MiniAppPluginInfo" : { "type" : "object", "properties" : { "package_url" : { "type" : "string", "description" : "插件包地址", "example" : "www.xxx.com" }, "plugin_id" : { "type" : "string", "description" : "插件id，即插件的唯一标识", "example" : "2016122304555146" }, "require_version" : { "type" : "string", "description" : "小程序引用的插件版本，可以指定插件版本，1.2.3。也可以使用最新版本,*。推荐使用*", "example" : "*" } } }, "MiniAppPluginReference" : { "type" : "object", "properties" : { "lazy" : { "type" : "boolean", "description" : "是否懒加载" }, "plugin_id" : { "type" : "string", "description" : "插件id，即插件的唯一标识，形如小程序的appId" }, "plugin_lazy" : { "type" : "boolean", "description" : "是否懒加载" }, "plugin_version" : { "type" : "string", "description" : "小程序引用的插件版本，可以指定插件版本，如：1.0.11；也可以填*，表示引用最新的插件版本，此时，当插件发布新版本后，小程序内的插件会自动更新到最新的版本。" } } }, "MiniAppServiceInfo" : { "type" : "object", "properties" : { "biz_status" : { "type" : "string", "description" : "插件发布状态码，暂存100，风控审核200，运营审核300，等待上架400，已预发上架500，已上架501，已下架600，已驳回700", "example" : "200" }, "is_inner" : { "type" : "boolean", "description" : "是否是内部标，true/false", "example" : "true" }, "is_order" : { "type" : "boolean", "description" : "是否订购，true/false", "example" : "true" }, "isv_app_id" : { "type" : "string", "description" : "三方应用appid", "example" : "2021000146612019" }, "mini_app_id" : { "type" : "string", "description" : "应用id", "example" : "2021000146613280" }, "mini_app_name" : { "type" : "string", "description" : "测试插件", "example" : "小程序名称" }, "seller_id" : { "type" : "string", "description" : "卖家pid", "example" : "2088301715777422" }, "seller_name" : { "type" : "string", "description" : "卖家名", "example" : "frikwj" }, "service_code" : { "type" : "string", "description" : "商品CODE", "example" : "AM010401000000070768" }, "service_logo" : { "type" : "string", "description" : "服务图标", "example" : "http://appstoreisvpic.alipayobjects.com/dev/50a1a2ad-c9af-4c24-92e0-84127857b634.jpg" }, "service_name" : { "type" : "string", "description" : "服务名", "example" : "崮城的小程序插件01插件" }, "service_slogan" : { "type" : "string", "description" : "服务简介", "example" : "反倒是离开及发的克里斯" }, "show_type" : { "type" : "string", "description" : "是否在服务市场透出，SHOW展示、HIDE隐藏", "example" : "SHOW" } } }, "MiniPackageInfo" : { "type" : "object", "properties" : { "doc_url" : { "type" : "string", "description" : "功能包文档地址", "example" : "http://doc.aaa.alipay.com" }, "package_desc" : { "type" : "string", "description" : "功能包描述", "example" : "这是通用能力" }, "package_name" : { "type" : "string", "description" : "功能包名称", "example" : "基础能力" }, "package_open_type" : { "type" : "string", "description" : "功能包开通方式，\"APPLY\", \"申请开通\"；\"ORDER\", \"签约开通\"；\"DEFAULT\", \"默认开通\"", "example" : "APPLY" }, "status" : { "type" : "string", "description" : "功能包签约状态，\"valid\", \"已生效\"；\"audit\", \"签约中\"；\"invalid\", \"已失效\"；\"none\", \"未签约\"", "example" : "valid" } } }, "MiniVersionBaseInfo" : { "type" : "object", "properties" : { "app_version" : { "type" : "string", "description" : "版本号", "example" : "1.0.0" }, "build_source" : { "type" : "string", "description" : "小程序所属来源", "example" : "01" }, "bundle_id" : { "type" : "string", "description" : "com.alipay.alipaywallet:支付宝，com.amap.app:高德", "example" : "com.alipay.alipaywallet" }, "dev_id" : { "type" : "string", "description" : "小程序开发者ID", "example" : "2088********" }, "gray_strategy" : { "type" : "string", "description" : "小程序灰度值", "example" : "p10" }, "mini_app_id" : { "type" : "string", "description" : "小程序应用ID", "example" : "2019********" }, "status" : { "type" : "string", "description" : "小程序状态", "example" : "INIT" } } }, "MiniappBrandAuditResult" : { "type" : "object", "properties" : { "brand_id" : { "type" : "string", "description" : "小程序提交品牌认证时的品牌id", "example" : "brand_id2020091684564595" }, "brand_name" : { "type" : "string", "description" : "小程序提交品牌认证时的品牌名称", "example" : "brand_namecr7officials" }, "brand_status" : { "type" : "string", "description" : "小程序提交品牌认证后的认证状态\tAUDITING(审核中)\tAUDIT_PASS(审核通过)\tAUDIT_REJECT(驳回审核)\tINVALID(已失效)\tNEAR_INVALID(即将过期失效)\tCANCEL(取消认证)\tNO_BRAND(未认证)", "example" : "AUDITING(审核中)" }, "has_brand" : { "type" : "string", "description" : "小程序提交品牌认证是否认证成功", "example" : "true" }, "invalid_reason" : { "type" : "string", "description" : "失效原因", "example" : "品牌授权日期已到" }, "reject_reason" : { "type" : "string", "description" : "驳回原因", "example" : "申请人身份认证不通过" } } }, "ModifyQuotaDetails" : { "type" : "object", "properties" : { "quota_amount" : { "type" : "string", "description" : "具体额度，单位：元。如金额为空，表示删除已有的额度设置，无已有额度设置则忽略。", "example" : "100" }, "quota_dimension" : { "type" : "string", "description" : "额度维度\tMONTH/DAY/SINGLE\t分别代表月、日、单次", "example" : "MONTH" }, "role" : { "type" : "string", "description" : "PAYER/PAYEE\t额度管控的角色，收or付款方，目前只支持付款方", "example" : "PAYER" } } }, "MonitorHeartbeatSynErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码" }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "MonitorHeartbeatSynModel" : { "type" : "object", "properties" : { "biz_content" : { "type" : "string", "description" : "验签时该参数不做任何处理", "example" : "{任意值}" } } }, "MonitorHeartbeatSynResponseModel" : { "type" : "object", "properties" : { "pid" : { "type" : "string", "description" : "商户pid", "example" : "商户pid" } } }, "MoreInfoDTO" : { "type" : "object", "properties" : { "descs" : { "type" : "array", "description" : "选择opennative的时候必须填写descs的内容", "items" : { "type" : "string" } }, "params" : { "type" : "string", "description" : "扩展参数，需要URL地址回带的值，JSON格式(openweb时填)" }, "title" : { "type" : "string", "description" : "二级页面标题，只有当operate_type为openNative时有效。" }, "url" : { "type" : "string", "description" : "超链接(选择openweb的时候必须填写url参数内容)" } } }, "MultiCurrencyMoneyOpenApi" : { "type" : "object", "properties" : { "cent" : { "type" : "integer", "description" : "分" }, "currency_value" : { "type" : "string", "description" : "币种类型值" } } }, "MutipleCurrencyDetail" : { "type" : "object", "properties" : { "ext_info" : { "type" : "string", "description" : "扩展字段", "example" : "key=value" }, "payment_amount" : { "type" : "string", "description" : "支付金额", "example" : "100.00" }, "payment_currency" : { "type" : "string", "description" : "支付币种", "example" : "CNY" }, "settlement_amount" : { "type" : "string", "description" : "清算金额", "example" : "10.00" }, "settlement_currency" : { "type" : "string", "description" : "清算币种", "example" : "CNY" }, "trans_amount" : { "type" : "string", "description" : "转账金额", "example" : "10.00" }, "trans_currency" : { "type" : "string", "description" : "转账币种", "example" : "CNY" } } }, "OcrNormalScanInfo" : { "type" : "object", "properties" : { "invoice_code" : { "type" : "string", "description" : "发票代码" }, "invoice_date" : { "type" : "string", "description" : "开票时间" }, "invoice_no" : { "type" : "string", "description" : "发票号码" }, "price" : { "type" : "string", "description" : "金额" }, "remark" : { "type" : "string", "description" : "明细事由" } } }, "OcrPlaneScanInfo" : { "type" : "object", "properties" : { "destination" : { "type" : "string", "description" : "目的地" }, "flight_no" : { "type" : "string", "description" : "航班号" }, "invoice_date" : { "type" : "string", "description" : "乘机日期" }, "origin" : { "type" : "string", "description" : "出发地" }, "passenger" : { "type" : "string", "description" : "乘客" }, "price" : { "type" : "string", "description" : "金额" }, "remark" : { "type" : "string", "description" : "明细事由" }, "seat_class" : { "type" : "string", "description" : "飞机舱位" } } }, "OcrTaxiScanInfo" : { "type" : "object", "properties" : { "get_off_time" : { "type" : "string", "description" : "下车时间" }, "get_on_time" : { "type" : "string", "description" : "上车时间" }, "invoice_code" : { "type" : "string", "description" : "发票代码" }, "invoice_date" : { "type" : "string", "description" : "开票时间" }, "invoice_no" : { "type" : "string", "description" : "发票号码" }, "passenger" : { "type" : "string", "description" : "乘客人" }, "price" : { "type" : "string", "description" : "金额" }, "travel_dist" : { "type" : "string", "description" : "乘车距离" } } }, "OcrTrainScanInfo" : { "type" : "object", "properties" : { "destination" : { "type" : "string", "description" : "目的地" }, "invoice_date" : { "type" : "string", "description" : "乘车日期" }, "origin" : { "type" : "string", "description" : "出发地" }, "passenger" : { "type" : "string", "description" : "乘客" }, "price" : { "type" : "string", "description" : "金额" }, "remark" : { "type" : "string", "description" : "明细事由" }, "seat_class" : { "type" : "string", "description" : "座次" }, "train_no" : { "type" : "string", "description" : "车次" } } }, "OpenApiRefundFundDetailPojo" : { "type" : "object", "properties" : { "funds" : { "type" : "array", "description" : "退款资金明细\r\t详：\r\t若type为paySerialNo则funds为\r\t[{\"paySerialNo\":\"支付流水1\",\"refundFee\":\"退款金额1\"},{\"paySerialNo\":\"支付流水2\",\"refundFee\":\"退款金额2\"}]", "items" : { "type" : "string" }, "example" : "[{\"paySerialNo\":\"2018081603020111\",refundFee:\"12.00\"},{\"paySerialNo\":\"2018081603020112\",refundFee:\"2.00\"}]" }, "trans_in" : { "type" : "string", "description" : "收入方账户\r\t为空则原路退回", "example" : "2088101126708402" }, "trans_in_type" : { "type" : "string", "description" : "收入方账户类型", "example" : "bankAccount" }, "type" : { "type" : "string", "description" : "描述资金明细类型\r\t详：若type为paySerialNo\r\t则funds参数中体现的都为对应支付流水的退款明细", "example" : "paySerialNo" } } }, "OpenApiResponseHeader" : { "type" : "object", "properties" : { "conversation_id" : { "type" : "string", "description" : "会话id，对应请求中的conversation_id，若请求中conversation_id非空，则该值非空", "example" : "0b09fcb8-e2df-4d03-8265-e8384788f525" }, "response_id" : { "type" : "string", "description" : "响应id，对应请求中的request_id。如果请求中request_id非空，则response_id非空。", "example" : "aaf4d9d2-908b-4ccf-83ef-1b1a857e4296" }, "status_code" : { "type" : "string", "description" : "自定义状态码", "example" : "200" }, "status_message" : { "type" : "string", "description" : "状态信息", "example" : "Not parsed programmatically. Example \"Downstream system offline\"" }, "sub_status_code" : { "type" : "string", "description" : "子状态码", "example" : "40601" } } }, "OpenApiRoyaltyDetailInfoPojo" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "分账的金额，单位为元" }, "amount_percentage" : { "type" : "integer", "description" : "分账信息中分账百分比。取值范围为大于0，少于或等于100的整数。" }, "desc" : { "type" : "string", "description" : "分账描述" }, "royalty_scene" : { "type" : "string", "description" : "可选值：达人佣金、平台服务费、技术服务费、其他" }, "royalty_type" : { "type" : "string", "description" : "分账类型.\r\t普通分账为：transfer;\r\t补差为：replenish;\r\t为空默认为分账transfer;" }, "trans_in" : { "type" : "string", "description" : "收入方账户。如果收入方账户类型为userId，本参数为收入方的支付宝账号对应的支付宝唯一用户号，以2088开头的纯16位数字；如果收入方类型为cardAliasNo，本参数为收入方在支付宝绑定的卡编号；如果收入方类型为loginName，本参数为收入方的支付宝登录号；" }, "trans_in_name" : { "type" : "string", "description" : "分账收款方姓名，上送则进行姓名与支付宝账号的一致性校验，校验不一致则分账失败。不上送则不进行姓名校验" }, "trans_in_type" : { "type" : "string", "description" : "收入方账户类型。userId表示是支付宝账号对应的支付宝唯一用户号;cardAliasNo表示是卡编号;loginName表示是支付宝登录号；" }, "trans_out" : { "type" : "string", "description" : "支出方账户。如果支出方账户类型为userId，本参数为支出方的支付宝账号对应的支付宝唯一用户号，以2088开头的纯16位数字；如果支出方类型为loginName，本参数为支出方的支付宝登录号。 泛金融类商户分账时，该字段不要上送。" }, "trans_out_type" : { "type" : "string", "description" : "支出方账户类型。userId表示是支付宝账号对应的支付宝唯一用户号;loginName表示是支付宝登录号； 泛金融类商户分账时，该字段不要上送。" } } }, "OpenAppOperatorVo" : { "type" : "object", "properties" : { "logon_id" : { "type" : "string", "description" : "登录账号", "example" : "登录账号" }, "nick_name" : { "type" : "string", "description" : "昵称", "example" : "张三" }, "portrait" : { "type" : "string", "description" : "用户头像", "example" : "htpt://****" }, "role" : { "type" : "string", "description" : "角色", "example" : "OPERATOR" }, "status" : { "type" : "string", "description" : "状态", "example" : "VALID" }, "user_id" : { "type" : "string", "description" : "用户Id", "example" : "用户Id" } } }, "OpenCertifyIdentityParam" : { "type" : "object", "properties" : { "cert_digest" : { "type" : "string", "description" : "cert_digest：\t身份信息摘要", "example" : "21232f297a57a5a743894a0e4a801fc3" }, "cert_name" : { "type" : "string", "description" : "cert_name：\t填入真实姓名", "example" : "张三" }, "cert_no" : { "type" : "string", "description" : "cert_no：\t填入姓名相匹配的证件号码", "example" : "260104197909275964" }, "cert_type" : { "type" : "string", "description" : "cert_type：\t1、若为身份证，填IDENTITY_CARD；\t2、若为港澳居民来往内地通行证，填HOME_VISIT_PERMIT_HK_MC；\t3、若为台湾居民来往内地通行证，填HOME_VISIT_PERMIT_TAIWAN；\t4、若为港澳居民居住证，填RESIDENCE_PERMIT_HK_MC；\t5、若为台湾居民居住证，填RESIDENCE_PERMIT_TAIWAN；", "example" : "IDENTITY_CARD" }, "facial_picture_front" : { "type" : "string", "description" : "facial_picture_front：\t活体人脸图片base64串，主要用于离线人脸比对", "example" : "xydasf==" }, "identity_type" : { "type" : "string", "description" : "identity_type\t1.若本人验证，使用CERT_INFO；\t2.若代他人验证，使用AGENT_CERT_INFO；", "example" : "CERT_INFO" }, "open_id" : { "type" : "string", "description" : "open_id：\t开放平台用户ID", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "phone_no" : { "type" : "string", "description" : "phone_no：\t填写姓名相匹配的手机号", "example" : "13000000000" }, "user_id" : { "type" : "string", "description" : "user_id：\t支付宝用户ID", "example" : "2088xxxx" } } }, "OpenCertifyMerchantConfig" : { "type" : "object", "properties" : { "auth_scope" : { "type" : "string", "description" : "用于开放认证授权", "example" : "xxx" }, "auth_type" : { "type" : "string", "description" : "用于指定授权类型，与auth_scope配合使用", "example" : "xxx" }, "face_reserve_strategy" : { "type" : "string", "description" : "不传默认为reserve", "example" : "reserve" }, "facial_picture_level" : { "type" : "string", "description" : "若有特殊人脸等级采集要求，可指定等级", "example" : "FIN0" }, "linked_merchant_app_id" : { "type" : "string", "description" : "用于授权二级商户操作", "example" : "202134xxxx" }, "linked_merchant_logo_url" : { "type" : "string", "description" : "用于指定展示的商户logo", "example" : "http://xxx" }, "linked_merchant_name" : { "type" : "string", "description" : "用于指定展示的商户名称", "example" : "杭州xx公司" }, "out_put_facial_picture" : { "type" : "boolean", "description" : "在拥有该权限前提下，用于商户控制是否透出活体人脸", "example" : "true" }, "return_url" : { "type" : "string", "description" : "认证成功后需要跳转的地址，一般为商户业务页面；若无跳转地址可填空字符\"\";", "example" : "https://xxx" } } }, "OpenFormFieldDO" : { "type" : "object", "properties" : { "optional" : { "type" : "string", "description" : "表单可选字段配置，common_fields属性定义一个表单字段数组，表单字段有效值列表与required字段有效值列表相同。\r\t可选字段配置中不能含有必须字段配置的有效值。", "example" : "{\r\n \"common_fields\": [\r\n \"OPEN_FORM_FIELD_GENDER\"\r\n ]\r\n }" }, "required" : { "type" : "string", "description" : "表单必填字段配置，common_fields属性定义一个表单字段数组，字段有效值如下列表所示：\r\tOPEN_FORM_FIELD_MOBILE -- 手机号\r\tOPEN_FORM_FIELD_GENDER -- 性别\r\tOPEN_FORM_FIELD_NAME -- 姓名\r\tOPEN_FORM_FIELD_BIRTHDAY -- 生日\r\tOPEN_FORM_FIELD_IDCARD -- 身份证\r\tOPEN_FORM_FIELD_EMAIL -- 邮箱\r\tOPEN_FORM_FIELD_ADDRESS -- 地址\r\tOPEN_FORM_FIELD_CITY -- 城市\r\tOPEN_FORM_FIELD_IS_STUDENT -- 是否学生认证\r\tOPEN_FORM_FIELD_MEMBER_GRADE -- 会员等级", "example" : "{\r\n \"common_fields\": [\r\n \"OPEN_FORM_FIELD_MOBILE\"\r\n ]\r\n }" } } }, "OpenidComplex" : { "type" : "object", "properties" : { "json_string" : { "type" : "string", "description" : "11", "example" : "{}" }, "open_id_list" : { "type" : "array", "description" : "1", "items" : { "type" : "string" }, "example" : "[\"074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5\"]" }, "openid" : { "type" : "string", "description" : "11", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "uid" : { "type" : "string", "description" : "11", "example" : "2088502241306951" }, "uid_list" : { "type" : "array", "description" : "1", "items" : { "type" : "string" }, "example" : "[\"2088502241306951\"]" } } }, "OperationResultExtInfo" : { "type" : "object", "properties" : { "activation_time" : { "type" : "string", "description" : "激活时间", "example" : "2021-11-12 00:00:00" }, "device_no" : { "type" : "string", "description" : "设备号", "example" : "WW321314" } } }, "Option" : { "type" : "object", "properties" : { "text" : { "type" : "string", "description" : "文本，通常用于理解对应的取值", "example" : "男" }, "value" : { "type" : "string", "description" : "取值，通常使用简单的数字或字符串", "example" : "0" } } }, "OrderApplyStatusBriefDTO" : { "type" : "object", "properties" : { "apply_status" : { "type" : "string", "description" : "SUCCESS：开票成功\tFAIL：开票失败\tPROCESS：开票中\tNOTEXIST：申请不存在", "example" : "SUCCESS" }, "order_no" : { "type" : "string", "description" : "开票申请时传入订单号（支持主单号、子单号），不限是否为支付宝体内交易单号", "example" : "20200520110046966071" } } }, "OrderDataDistributeInfo" : { "type" : "object", "properties" : { "not_distribute_reason" : { "type" : "string", "description" : "未分发到场景的具体原因。开发者可根据具体原因定位解决问题后发起重试。", "example" : "小程序id不存在" }, "scene_code" : { "type" : "string", "description" : "分发场景code。\t具体枚举值如下：SERVICE_MSG-订单消息", "example" : "SERVICE_MSG" }, "scene_name" : { "type" : "string", "description" : "分发场景名，对应scene_code。", "example" : "订单消息" } } }, "OrderDataSyncSuggestion" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "同步建议内容", "example" : "建议回传蚂蚁球房ID，以便在场景中更好的分发" }, "type" : { "type" : "string", "description" : "同步建议类型", "example" : "SHOP_ID_INVALID" } } }, "OrderExtInfo" : { "type" : "object", "properties" : { "ext_key" : { "type" : "string", "description" : "键值" }, "ext_value" : { "type" : "string", "description" : "值" } } }, "OrderExtIstd" : { "type" : "object", "properties" : { "cash_on_delivery" : { "type" : "string", "description" : "骑手应付金额" }, "cash_on_pickup" : { "type" : "string", "description" : "骑手应收金额" }, "consumer_order_time" : { "type" : "string", "description" : "消费者下单时间" }, "delivery_direction" : { "type" : "integer", "description" : "物流流向，1：从球房取件送至用户；2：从用户取件送至球房" }, "delivery_type" : { "type" : "integer", "description" : "配送类型, 0: 即时单 1 预约单" }, "desc" : { "type" : "string", "description" : "备注" }, "expected_delivery_time" : { "type" : "string", "description" : "期望派单时间" }, "expected_finish_time" : { "type" : "string", "description" : "期望送达时间" }, "expected_pick_time" : { "type" : "string", "description" : "期望取件时间" }, "insure_price" : { "type" : "string", "description" : "保价金额" }, "is_direct_delivery" : { "type" : "integer", "description" : "是否直拿直送，1:直拿直送 0:非直拿直送" }, "is_finish_code_needed" : { "type" : "integer", "description" : "是否需要收货码，1:需要 0:不需要" }, "is_insured" : { "type" : "integer", "description" : "是否保价，1:保价 0:不保价" }, "is_pickup_code_needed" : { "type" : "integer", "description" : "是否需要取货码，1:需要 0:不需要" }, "poi_seq" : { "type" : "string", "description" : "球房订单流水号" }, "service_code" : { "type" : "string", "description" : "即时配送公司的服务代码" } } }, "OrderExtIstdForPreOrder" : { "type" : "object", "properties" : { "cash_on_delivery" : { "type" : "string", "description" : "骑手应付金额", "example" : "15.00" }, "cash_on_pickup" : { "type" : "string", "description" : "骑手应收金额", "example" : "13.00" }, "consumer_order_time" : { "type" : "string", "description" : "消费者下单时间", "example" : "2020-06-01 13:23:00" }, "delivery_direction" : { "type" : "integer", "description" : "物流流向，1：从球房取件送至用户；2：从用户取件送至球房", "example" : "1" }, "delivery_type" : { "type" : "integer", "description" : "配送类型, 0: 即时单 1 预约单", "example" : "0" }, "desc" : { "type" : "string", "description" : "备注", "example" : "备注" }, "expected_delivery_time" : { "type" : "string", "description" : "期望派单时间", "example" : "2020-11-27 15:45:57" }, "expected_finish_time" : { "type" : "string", "description" : "期望送达时间", "example" : "2020-06-01 13:23:00" }, "expected_pick_time" : { "type" : "string", "description" : "期望取件时间", "example" : "2020-06-01 13:23:00" }, "insure_price" : { "type" : "string", "description" : "保价金额", "example" : "100.00" }, "is_direct_delivery" : { "type" : "integer", "description" : "是否直拿直送，1:直拿直送 0:非直拿直送", "example" : "1" }, "is_finish_code_needed" : { "type" : "integer", "description" : "是否需要收货码，1:需要 0:不需要", "example" : "0" }, "is_insured" : { "type" : "integer", "description" : "是否保价，1:保价 0:不保价", "example" : "0" }, "is_pickup_code_needed" : { "type" : "integer", "description" : "是否需要取货码，1:需要 0:不需要", "example" : "0" }, "poi_seq" : { "type" : "string", "description" : "球房订单流水号", "example" : "xxx" }, "service_code" : { "type" : "string", "description" : "即时配送公司的服务代码", "example" : "001" } } }, "OrderItem" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "店铺所在具体位置", "example" : "西湖区XX街XX号" }, "brand_name" : { "type" : "string", "description" : "品牌名称", "example" : "肯德基" }, "category" : { "type" : "string", "description" : "店铺品类", "example" : "咖啡" }, "city" : { "type" : "string", "description" : "店铺所在的市", "example" : "杭州市" }, "city_code" : { "type" : "string", "description" : "城市编码", "example" : "110100" }, "commodity_id" : { "type" : "string", "description" : "订购的服务商品ID", "example" : "201604290086730119" }, "contacts" : { "type" : "string", "description" : "订单联系人", "example" : "张三" }, "creator" : { "type" : "string", "description" : "球房创建人(已删除)", "example" : "张三" }, "expire_date" : { "type" : "string", "description" : "过期时间", "example" : "2016-01-01 00:00:01" }, "merchant_name" : { "type" : "string", "description" : "商户名称", "example" : "XX网络有限公司" }, "merchant_pid" : { "type" : "string", "description" : "商户PID", "example" : "2088101118588888" }, "mini_app_id" : { "type" : "string", "description" : "小程序APPID，订购实体为小程序的场景该字段必填", "example" : "2017121800945174" }, "mini_app_name" : { "type" : "string", "description" : "小程序应用名称，订购实体为小程序的场景该字段必填", "example" : "小张火锅店小程序" }, "online_time" : { "type" : "string", "description" : "上架时间", "example" : "2016-01-01 00:01:01" }, "open_id_model" : { "type" : "string", "description" : "应用用户标识模式", "example" : "UID模式" }, "order_status" : { "type" : "string", "description" : "TO_DO-未实施,DOING-实施中,TO_CONFIRM-待商户确认,CONFIRMED-商户已确认,DONE-已完成,MERCHANT_REJECTED-商户已回绝,MERCHANT_CANCELLED-商户已取消,ISV_REJECTED-服务商已回绝,ISV_CANCELLED-服务商已取消", "example" : "DONE" }, "phone_no" : { "type" : "string", "description" : "订单所属人联系方式（手机或者座机）", "example" : "13988888888" }, "province" : { "type" : "string", "description" : "店铺所在的省份", "example" : "浙江省" }, "service_effect_date" : { "type" : "string", "description" : "订购的服务有效期生效时间", "example" : "2023-04-03 12:01:45" }, "service_expire_date" : { "type" : "string", "description" : "服务有效期截止时间", "example" : "2023-04-03 12:01:45" }, "shop_id" : { "type" : "string", "description" : "店铺ID，订购实体为口碑球房的场景该字段必填", "example" : "2015052000077000000000182140" }, "shop_name" : { "type" : "string", "description" : "店铺名称，订购实体为口碑球房的场景该字段必填", "example" : "小张火锅店" }, "shop_status" : { "type" : "string", "description" : "店铺状态（ONLINE--已上架 OFFLINE--未上架 AVAILABLE--已开通 INIT--未开通 EXPIRED--已过期）", "example" : "ONLINE" }, "status" : { "type" : "string", "description" : "待服务商接单", "example" : "MERCHANT_ORDED---待服务商接单" } } }, "OrderJourneyElement" : { "type" : "object", "properties" : { "arrival" : { "$ref" : "#/components/schemas/JourneyLocation" }, "departure" : { "$ref" : "#/components/schemas/JourneyLocation" }, "duration" : { "type" : "string", "description" : "行程时长，单位为秒", "example" : "3600" }, "end_time" : { "type" : "string", "description" : "结束时间（格式化）", "example" : "2021-01-02 12:21:22" }, "end_time_desc" : { "type" : "string", "description" : "结束时间描述（非结构化）", "example" : "1月2号" }, "ext_info" : { "type" : "array", "description" : "扩展信息", "items" : { "$ref" : "#/components/schemas/OrderExtInfo" } }, "functional_services" : { "type" : "array", "description" : "功能服务列表", "items" : { "$ref" : "#/components/schemas/FunctionalService" } }, "passagers" : { "type" : "array", "description" : "出行人", "items" : { "$ref" : "#/components/schemas/UserInfomation" } }, "service_change_info" : { "$ref" : "#/components/schemas/JourneyServiceChangeInfo" }, "service_provider" : { "$ref" : "#/components/schemas/JourneyMerchantInfo" }, "start_time" : { "type" : "string", "description" : "开始时间格式化", "example" : "2021-01-01 12:21:22" }, "start_time_desc" : { "type" : "string", "description" : "开始时间描述（非格式化）", "example" : "1月1号" } } }, "OrderJourneyInfo" : { "type" : "object", "properties" : { "action" : { "type" : "string", "description" : "操作动作\t-DELETE 删除，删除后的行程不再展示", "example" : "DELETE" }, "ext_info" : { "type" : "array", "description" : "扩展信息", "items" : { "$ref" : "#/components/schemas/OrderExtInfo" } }, "journey_create_time" : { "type" : "string", "description" : "行程创建时间", "example" : "2021-01-16 12:12:12" }, "journey_desc" : { "type" : "string", "description" : "行程描述", "example" : "中国航空公司 C8888 上海-北京" }, "journey_elements" : { "type" : "array", "description" : "行程元素列表", "items" : { "$ref" : "#/components/schemas/OrderJourneyElement" } }, "journey_index" : { "type" : "string", "description" : "描述本行程为整个行程中的第几程", "example" : "2" }, "journey_modify_time" : { "type" : "string", "description" : "行程修改时间", "example" : "2021-01-16 16:16:16" }, "merchant_journey_no" : { "type" : "string", "description" : "商户行程单号\t注：同一个pid下的行程单号需唯一。同一个pid下外部行程单号唯一", "example" : "202101130000001" }, "status" : { "type" : "string", "description" : "行程状态\t注：行程状态必须与支付宝侧进行约定", "example" : "MERCHANT_FINISHED" }, "status_desc" : { "type" : "string", "description" : "行程状态描述", "example" : "已完成" }, "sub_type" : { "type" : "string", "description" : "行程子类型", "example" : "abroad" }, "title" : { "type" : "string", "description" : "行程标题", "example" : "标题" }, "type" : { "type" : "string", "description" : "行程类型", "example" : "airticket" } } }, "OrderLogisticsInformationRequest" : { "type" : "object", "properties" : { "logistics_code" : { "type" : "string", "description" : "物流公司编号。\r\t物流公司编号值请查看产品文档\r\t注：该值为空时，有可能匹配不到物流信息。若有则必传", "example" : "STO" }, "tracking_no" : { "type" : "string", "description" : "物流单号", "example" : "P201802091000000002W" } } }, "OrderPageQueryDTO" : { "type" : "object", "properties" : { "page_data" : { "type" : "array", "description" : "审核单数据信息", "items" : { "$ref" : "#/components/schemas/ApplyOrderData" } }, "page_num" : { "type" : "string", "description" : "当前页码，默认第一页", "example" : "1" }, "page_size" : { "type" : "string", "description" : "每页记录数，默认10", "example" : "2" }, "total_number" : { "type" : "integer", "description" : "记录总数", "example" : "1000" } } }, "OrderParticipantInfo" : { "type" : "object", "properties" : { "ext_info" : { "type" : "array", "description" : "扩展信息", "items" : { "$ref" : "#/components/schemas/OrderExtInfo" } }, "logo_material_id" : { "type" : "string", "description" : "参与方logo素材id\t开发者通过 alipay.merchant.item.file.upload(商品文件上传接口)上传图片，获取到对应的素材 ID( material_id )", "example" : "2019010100502200000000000001" }, "name" : { "type" : "string", "description" : "参与方名称", "example" : "东方航空" }, "short_name" : { "type" : "string", "description" : "参与方简称", "example" : "东航" }, "type" : { "type" : "string", "description" : "参与方类型", "example" : "服务提供商" }, "uid" : { "type" : "string", "description" : "参与方支付宝uid", "example" : "2088202905583404" } } }, "OrderShopInfo" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "店铺地址" }, "alipay_shop_id" : { "type" : "string", "description" : "蚂蚁球房shop_id" }, "ext_info" : { "type" : "array", "description" : "球房其他业务属性，不同业务场景KEY枚举值不同，使用前请参考产品文档", "items" : { "$ref" : "#/components/schemas/OrderExtInfo" } }, "merchant_shop_id" : { "type" : "string", "description" : "商户球房id\t支持英文、数字的组合" }, "merchant_shop_link_page" : { "type" : "string", "description" : "店铺详情链接地址" }, "name" : { "type" : "string", "description" : "店铺名称" }, "phone_num" : { "type" : "string", "description" : "联系电话-支持固话或手机号\t仅支持数字、+、-" }, "type" : { "type" : "string", "description" : "仅当alipay_shop_id字段值为非标准蚂蚁球房时使用，其他场景无需传入" } } }, "OrderStatusData" : { "type" : "object", "properties" : { "order_id" : { "type" : "string", "description" : "申请单ID" }, "reject_reason" : { "type" : "string", "description" : "驳回原因" }, "status" : { "type" : "string", "description" : "申请状态 AGREE、REJECT、EDIT、AUDIT" } } }, "OrderVehicleInfo" : { "type" : "object", "properties" : { "license_plate_no" : { "type" : "string", "description" : "交通工具牌照号，如车牌号等", "example" : "沪A888888" }, "memo" : { "type" : "string", "description" : "车辆信息备注", "example" : "备注" }, "shift_no" : { "type" : "string", "description" : "班次", "example" : "班次" } } }, "OrderVoucherAvailableCityCode" : { "type" : "object", "properties" : { "all_city" : { "type" : "boolean", "description" : "是否全国。选择全国后，无须填写city_codes字段。系统默认填充全国全部城市信息。" }, "city_codes" : { "type" : "array", "description" : "城市编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 （参考资料： http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/）", "items" : { "type" : "string" } } } }, "OrderVoucherAvailableCityCodeModify" : { "type" : "object", "properties" : { "city_codes" : { "type" : "array", "description" : "城市编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 （参考资料： http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/）", "items" : { "type" : "string" }, "example" : "[\"100100\"]" } } }, "OrderVoucherAvailableScopeResult" : { "type" : "object", "properties" : { "order_voucher_available_shop_result" : { "$ref" : "#/components/schemas/OrderVoucherAvailableShopResult" }, "voucher_available_type" : { "type" : "string", "description" : "可用范围类型。" } } }, "OrderVoucherAvailableShop" : { "type" : "object", "properties" : { "order_voucher_merchant_all_shop" : { "$ref" : "#/components/schemas/OrderVoucherMerchantAllShop" }, "real_shop_ids" : { "type" : "array", "description" : "代运营商业关系球房列表，列表中的球房id是调用接口alipay.business.relation.shop.create创建球房返回的real_shop_id 接口参数是列表类型。", "items" : { "type" : "string" } }, "shop_ids" : { "type" : "array", "description" : "券可使用的球房列表。列表中的球房id是通过调用接口ant.merchant.expand.shop.create创建球房返回的支付宝球房id 接口参数是列表类型。", "items" : { "type" : "string" } } } }, "OrderVoucherAvailableShopModify" : { "type" : "object", "properties" : { "order_voucher_merchant_all_shop" : { "$ref" : "#/components/schemas/OrderVoucherMerchantAllShopModify" }, "real_shop_ids" : { "type" : "array", "description" : "券可使用的商业关系球房列表,列表中的球房id是调用接口alipay.business.relation.shop.create创建球房返回的real_shop_id。", "items" : { "type" : "string" }, "example" : "[\"2018051000502000000011111111\",\"2018040200502000000011111111\",\"2018062800502000000022271997\"]" }, "shop_ids" : { "type" : "array", "description" : "券可使用的球房列表。列表中的球房id是通过调用接口ant.merchant.expand.shop.create创建球房返回的支付宝球房id 接口参数是列表类型。接口参数是列表类型。", "items" : { "type" : "string" }, "example" : "[\"2018051000502000000011111111\",\"2018040200502000000011111111\",\"2018062800502000000022271997\"]" } } }, "OrderVoucherAvailableShopResult" : { "type" : "object", "properties" : { "order_voucher_merchant_all_shop_result" : { "$ref" : "#/components/schemas/OrderVoucherMerchantAllShopResult" }, "real_shop_fail_infos" : { "type" : "array", "description" : "请求失败的代运营商业关系球房详情", "items" : { "$ref" : "#/components/schemas/OrderVoucherRealShopFailInfo" } }, "shop_fail_infos" : { "type" : "array", "description" : "请求失败的支付宝球房详情。", "items" : { "$ref" : "#/components/schemas/OrderVoucherShopFailInfo" } }, "success_real_shop_ids" : { "type" : "array", "description" : "请求成功的代运营商业关系球房", "items" : { "type" : "string" } }, "success_shop_ids" : { "type" : "array", "description" : "请求成功的支付宝球房。", "items" : { "type" : "string" } } } }, "OrderVoucherMerchantAllShop" : { "type" : "object", "properties" : { "exclude_shop_ids" : { "type" : "array", "description" : "券不可使用的球房列表。指定商户全部球房可用时可通过该字段排除部分不可用球房。列表中的球房id是通过调用接口ant.merchant.expand.shop.create创建球房返回的支付宝球房id 接口参数是列表类型。", "items" : { "type" : "string" } } } }, "OrderVoucherMerchantAllShopModify" : { "type" : "object", "properties" : { "exclude_shop_ids" : { "type" : "array", "description" : "券不可使用的球房列表。列表中的球房id是通过调用接口ant.merchant.expand.shop.create创建球房返回的支付宝球房id 接口参数是列表类型。 接口参数是列表类型。", "items" : { "type" : "string" }, "example" : "[\"2018051000502000000011111111\",\"2018040200502000000011111111\",\"2018062800502000000022271997\"]" } } }, "OrderVoucherMerchantAllShopResult" : { "type" : "object", "properties" : { "exclude_shop_fail_infos" : { "type" : "array", "description" : "请求失败的不可用球房详情。", "items" : { "$ref" : "#/components/schemas/OrderVoucherShopFailInfo" } }, "success_exclude_shop_ids" : { "type" : "array", "description" : "请求成功的不可用球房列表。", "items" : { "type" : "string" } } } }, "OrderVoucherRealShopFailInfo" : { "type" : "object", "properties" : { "fail_message" : { "type" : "string", "description" : "请求失败提示信息。" }, "fail_reasons" : { "type" : "array", "description" : "请求失败原因。", "items" : { "type" : "string" } }, "real_shop_id" : { "type" : "string", "description" : "请求失败的代运营商业关系球房 ID。" } } }, "OrderVoucherShopFailInfo" : { "type" : "object", "properties" : { "fail_message" : { "type" : "string", "description" : "请求失败提示信息。" }, "fail_reasons" : { "type" : "array", "description" : "请求失败的原因。", "items" : { "type" : "string" } }, "shop_id" : { "type" : "string", "description" : "请求失败的支付球房 ID。" } } }, "OrderVoucherUseRuleResult" : { "type" : "object", "properties" : { "voucher_available_scope_result" : { "$ref" : "#/components/schemas/OrderVoucherAvailableScopeResult" } } }, "Org" : { "type" : "object", "properties" : { "org_id_number" : { "type" : "string", "description" : "企业证件号", "example" : "913301087458306077" }, "org_id_type" : { "type" : "string", "description" : "企业证件类型，（证件号不为空时必填，详见企业证件类型）", "example" : "CRED_ORG_USCC" }, "org_legal_id_number" : { "type" : "string", "description" : "法定代表人证件号", "example" : "330304199801011111" }, "org_legal_id_type" : { "type" : "string", "description" : "法定代表人证件类型", "example" : "CRED_PSN_CH_IDCARD" }, "org_legal_name" : { "type" : "string", "description" : "法定代表人名称", "example" : "折颜" }, "org_name" : { "type" : "string", "description" : "企业名称", "example" : "杭州天谷信息科技有限公司" }, "third_party_user_id" : { "type" : "string", "description" : "企业唯一标识：可传入平台机构id、企业证件号、企业邮箱等（个人用户与企业的唯一标识不可重复）", "example" : "913301087458306077" } } }, "OuterMemberInfo" : { "type" : "object", "properties" : { "user_info" : { "type" : "string", "description" : "商户记录的用户信息", "example" : "爱投诉；爱买打折商品" } } }, "OverseasExtendParams" : { "type" : "object", "properties" : { "goods_detail" : { "type" : "string", "description" : "商品明细列表", "example" : "[{\\\"goods_id\\\":\\\"001\\\",\\\"goods_amount\\\":\\\"100\\\"}]" } } }, "PackageItemOpenInfo" : { "type" : "object", "properties" : { "consume_output_info" : { "$ref" : "#/components/schemas/ConsumeOutputInfo" }, "file_download_url" : { "type" : "string", "description" : "发票文件下载链接", "example" : "http://txffp.oss-cn-beijing.aliyuncs.com/zfb/11b7678a6ab04271afd2c4dfd*******?Expires=1574665315&OSSAccessKeyId=LTAIYAJb********&Signature=%2BD6AX5gswetzBdz************%3D" }, "file_type" : { "type" : "string", "description" : "文件类型，如pdf，ofd，jpg", "example" : "pdf" }, "invoice_output_info" : { "$ref" : "#/components/schemas/InvoiceOutputInfo" }, "item_source" : { "type" : "string", "description" : "项目来源，如：ocr\\einvoice\\consume", "example" : "ocr" }, "item_sub_type" : { "type" : "string", "description" : "项目子类，如：出租车、火车、飞机等", "example" : "出租车" }, "item_type" : { "type" : "string", "description" : "项目大类，如：餐饮美食、酒店住宿、差旅出行等", "example" : "餐饮美食" }, "ocr_normal_scan_info" : { "$ref" : "#/components/schemas/OcrNormalScanInfo" }, "ocr_plane_scan_info" : { "$ref" : "#/components/schemas/OcrPlaneScanInfo" }, "ocr_taxi_scan_info" : { "$ref" : "#/components/schemas/OcrTaxiScanInfo" }, "ocr_train_scan_info" : { "$ref" : "#/components/schemas/OcrTrainScanInfo" } } }, "PaidOuterCardCycleInfoDTO" : { "type" : "object", "properties" : { "alipay_deduct_agreement" : { "type" : "string", "description" : "支付宝用户签约协议号" }, "alipay_deduct_product_code" : { "type" : "string", "description" : "支付宝代扣产品码" }, "alipay_deduct_scene" : { "type" : "string", "description" : "支付宝代扣场景码" }, "close_reason" : { "type" : "string", "description" : "关闭连续购买原因。枚举如下：\tMANUAL_CLOSE(手动关闭)\tEXPIRE_CLOSE(过期关闭)\tCLOSE(关闭)" }, "cycle_type" : { "type" : "string", "description" : "用户开通连续购买类型。枚举如下：\tYEAR(年)\tQUARTER(季度)\tMONTH(月)" }, "open_status" : { "type" : "string", "description" : "开通连续购买状态。枚举如下：\tOPEN(打开)\tCLOSE(关闭)" } } }, "PaidOuterCardCycleSellConfDTO" : { "type" : "object", "properties" : { "cycle_selling_url" : { "type" : "string", "description" : "用户开通连续购买地址" }, "cycle_type" : { "type" : "array", "description" : "周期购买类型。枚举如下：\tYEAR 年\tQUARTER 季度\tMONTH 月", "items" : { "type" : "string" } }, "support_cycle_sell" : { "type" : "boolean", "description" : "是否支持用户连续购买。true代表支持，false代表不支持。" } } }, "PaidOuterCardExtraInfoDTO" : { "type" : "object", "properties" : { "action" : { "type" : "string", "description" : "用户操作类型，枚举如下：\tOPEN 开通\tUPGRADE 升级\tDOWNGRADE 降级\tRENEW 续费" }, "cycle_info" : { "$ref" : "#/components/schemas/PaidOuterCardCycleInfoDTO" }, "purchase_info" : { "$ref" : "#/components/schemas/PaidOuterCardPurchaseInfoDTO" } } }, "PaidOuterCardManageUrlConfDTO" : { "type" : "object", "properties" : { "cycle_manage_url" : { "type" : "string", "description" : "连续购买管理地址。包括查看当前用户连续购买详情，关闭连续购买等功能" }, "downgrade_url" : { "type" : "string", "description" : "付费外卡降级地址" }, "refund_url" : { "type" : "string", "description" : "续费外卡退款地址" }, "renew_url" : { "type" : "string", "description" : "付费外卡续费地址" }, "upgrade_url" : { "type" : "string", "description" : "付费外卡升级地址" } } }, "PaidOuterCardPriceDetailDTO" : { "type" : "object", "properties" : { "desc" : { "type" : "string", "description" : "方案描述" }, "price" : { "type" : "string", "description" : "售卖具体金额。单位为元。支持两位小数。" }, "price_type" : { "type" : "string", "description" : "售卖金额类型。目前支持\tFIXED：固定金额" }, "worth" : { "type" : "string", "description" : "价值。单位为元。支持两位小数" } } }, "PaidOuterCardPurchaseInfoDTO" : { "type" : "object", "properties" : { "action_date" : { "type" : "string", "description" : "用户购买、升级、降级、续费的操作时间。格式为：yyyy-MM-dd hh:mm:ss" }, "alipay_trade_no" : { "type" : "string", "description" : "支付宝交易号，由api: alipay.trade.create 返回" }, "out_trade_no" : { "type" : "string", "description" : "商户订单号。与创建订单api：alipay.trade.create保持一致" }, "price" : { "type" : "string", "description" : "用户购买金额。当购买/升级/续费场景必填，单位元，精确到小数点后2位" }, "source" : { "type" : "string", "description" : "用户操作来源。枚举如下：\tALIPAY_TINY_APP(支付宝小程序)\tSELF_APP(商家APP)\tOTHER(其他)" } } }, "PaidOuterCardSellingConfDTO" : { "type" : "object", "properties" : { "end_date" : { "type" : "string", "description" : "售卖结束时间。\t格式：yyyy-MM-dd HH:mm:ss\t如果永久有效则不传。" }, "price_detail" : { "type" : "array", "description" : "售卖方案列表", "items" : { "$ref" : "#/components/schemas/PaidOuterCardPriceDetailDTO" } }, "selling_url" : { "type" : "string", "description" : "售卖地址" }, "start_date" : { "type" : "string", "description" : "售卖开始时间。格式：yyyy-MM-dd HH:mm:ss" } } }, "PaidOuterCardTemplateConfDTO" : { "type" : "object", "properties" : { "cycle_selling_conf" : { "$ref" : "#/components/schemas/PaidOuterCardCycleSellConfDTO" }, "manage_url_conf" : { "$ref" : "#/components/schemas/PaidOuterCardManageUrlConfDTO" }, "open_selling_conf" : { "$ref" : "#/components/schemas/PaidOuterCardSellingConfDTO" } } }, "Participant" : { "type" : "object", "properties" : { "bankcard_ext_info" : { "$ref" : "#/components/schemas/BankcardExtInfo" }, "ext_info" : { "type" : "string", "description" : "描述参与方信息的扩展属性，使用前请与支付宝工程师确认" }, "identity" : { "type" : "string", "description" : "参与方的唯一标识" }, "identity_type" : { "type" : "string", "description" : "参与方的标识类型，目前支持如下类型：\t1、ALIPAY_USER_ID 支付宝的会员ID\t2、ALIPAY_LOGON_ID：支付宝登录号，支持邮箱和手机号格式\t3、ALIPAY_OPEN_ID：支付宝openid" }, "merchant_user_info" : { "type" : "string", "description" : "商户端的用户信息描述，目前可指定如下属性：\r\tmerchant_user_id：商户端的用户唯一ID\r\tmerchant_user_name：商户端的用户名\r\tmerchant_user_nickname：商户端的用户昵称\r\tmerchant_user_mobile：商户端的手机号" }, "name" : { "type" : "string", "description" : "参与方真实姓名，如果非空，将校验收款支付宝账号姓名一致性。当identity_type=ALIPAY_LOGON_ID时，本字段必填。" } } }, "PayParams" : { "type" : "object", "properties" : { "async_type" : { "type" : "string", "description" : "普通异步支付, 传入该参数时，如果满足受理条件，会先同步受理支付，然后在异步调度推进支付\t\tNORMAL_ASYNC: 普通异步，受理成功之后，会在交易关单之前通过一定的策略重试\t\tNEAR_REAL_TIME_ASYNC: 准实时异步，受理成功之后，会准实时发起1次调度", "example" : "NORMAL_ASYNC" }, "retry_type" : { "type" : "string", "description" : "重试类型，当async_type传入NORMAL_ASYNC时，可以设置该参数，选择是否要重试，retry_type 可选，不设置时，可重试。\t● NONE_AND_CLOSETRADE：不重试，支付请求只会被执行1次，执行完成后如果交易未成功，会关闭交易\t● NONE：不重试，支付请求只会被执行1次，执行完成后，不做任何处理。交易到达了timeout_express指定的时间后，关闭交易。\t● RETY: 重试，支付请求在超时关单前，会按照策略重试", "example" : "NONE" } } }, "PaymentFixVoucher" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "面额，每张优惠券可以抵扣的金额。\t\t限制：\t1、币种为人民币，单位为元。小数点以后最多保留两位。\t2、取值范围:0.1<=x<=3000" }, "floor_amount" : { "type" : "string", "description" : "门槛金额。默认无门槛限制。 \t\t限制:\t1、币种为人民币，单位为元。小数点以后最多保留两位。 \t2、取值范围:0.1<=x<= 50000。\t3、若指定可核销商品编码，门槛金额必填。门槛金额为可核销商品部分的消费金额，而不是订单的消费金额。" } } }, "PaymentVoucherAlipayBalanceRechargeInfo" : { "type" : "object", "properties" : { "logon_id" : { "type" : "string", "description" : "出资的支付宝登录账号\t限制:\t1、登录账号和用户ID必须且只能二选一" }, "user_id" : { "type" : "string", "description" : "出资的支付宝用户id\t限制:\t1、登录账号和用户ID必须且只能二选一" } } }, "PaymentVoucherAvailableGoods" : { "type" : "object", "properties" : { "goods_description" : { "type" : "string", "description" : "商品描述信息。 用于券面展示，向用户介绍商品", "example" : "特价手机" }, "goods_ids" : { "type" : "array", "description" : "可优惠商品编码，商家自定义商品编码。当用户支付时，交易中的商品编码和支付券配置的商品编码有任一匹配时，可以使用优惠券。", "items" : { "type" : "string" }, "example" : "[\"apple-01\",\"apple-02\"]" }, "goods_name" : { "type" : "string", "description" : "商品名称", "example" : "ipad" } } }, "PaymentVoucherAvailableGoodsModify" : { "type" : "object", "properties" : { "goods_ids" : { "type" : "array", "description" : "可优惠商品编码，商家自定义商品编码。当用户支付时，交易中的商品编码和支付券配置的商品编码有任一匹配时，可以使用优惠券。\t限制:\t1、核销商品范围只能增大不能减小", "items" : { "type" : "string" }, "example" : "[\"apple-01\",\"apple-02\"]" } } }, "PaymentVoucherAvailableMerchant" : { "type" : "object", "properties" : { "available_pids" : { "type" : "array", "description" : "优惠券可核销的直连商户PID\t\t限制：\t1、available_pids和available_smids至少二选一。", "items" : { "type" : "string" }, "example" : "[\"2088102111111111\"]" }, "available_smids" : { "type" : "array", "description" : "优惠券可核销的间连商户SMID\t\t限制： \t1、available_pids和available_smids至少二选一。", "items" : { "type" : "string" }, "example" : "[\"2088102111111111\"]" } } }, "PaymentVoucherAvailableMerchantModify" : { "type" : "object", "properties" : { "available_pids" : { "type" : "array", "description" : "优惠券可以核销的直连商户PID。默认不修改。\t 限制： \t1、核销商户范围只能增大不能减小。", "items" : { "type" : "string" }, "example" : "[\"2088102111111111\"]" }, "available_smids" : { "type" : "array", "description" : "优惠券可以核销的间连商户SMID。默认不修改。\t 限制： \t1、核销商户范围只能增大不能减小。", "items" : { "type" : "string" }, "example" : "[\"2088102111111111\"]" } } }, "PaymentVoucherBelongMerchantInfo" : { "type" : "object", "properties" : { "merchant_id" : { "type" : "string", "description" : "商户支付宝id，默认品牌名和品牌logo将从该商户信息中获取" }, "merchant_id_type" : { "type" : "string", "description" : "商户id类型。 \t若传入的类型为直连商户则必须签约当面付且当前接口调用者与商户存在代运营关系\t当类型为SMID时表示为某个间连商户配券，但是券的归属者属于当前接口调用人。\t枚举值\tSMID 间连商户\tPID 直连商户" } } }, "PaymentVoucherBudgetInfo" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "营销资金预算,单位元。\t总预算=优惠金额*总发券张数" }, "budget_type" : { "type" : "string", "description" : "营销资金预算类型\t枚举值:\tNO_CASH 免充值\tRECHARGE 预充值\t\t1、免充值：制券方无需提前充值资金，用户核销支付券时，直接从订单原价中扣除优惠减价金额，最终只将用户实际支付的金额结算给核销商户，商户实收少于订单原价。\t2.预充值: 制券方需将优惠预算提前充值到支付宝指定营销账户中，用户核销支付券时，系统从该账户可用余额中扣除优惠减价部分对应的资金，连同用户实际支付的资金，一并结算给核销商户，不影响实收。" }, "recharge_info" : { "$ref" : "#/components/schemas/PaymentVoucherRechargeInfo" } } }, "PaymentVoucherDisplayInfo" : { "type" : "object", "properties" : { "brand_name" : { "type" : "string", "description" : "商户品牌名称。 如果不设置品牌名称，则默认使用支付宝商家系统中维护的商家别名。 如果没有维护商家别名，则使用默认名称： 商家优惠。 用户领取优惠券后，品牌名称会对用户进行展示" }, "customer_service_mobile" : { "type" : "string", "description" : "商家客服电话，会展示在支付宝卡包券详情页。" }, "voucher_description" : { "type" : "string", "description" : "用于说明详细的活动规则，会展示在支付宝卡包券详情页。" }, "voucher_detail_images" : { "type" : "array", "description" : "券详细图列表，会展示在用户支付宝卡包券详情页 需要通过 alipay.marketing.material.image.upload接口上传图片，指定file_key为PROMO_VOUCHER_DETAIL_IMAGE ,接口返回的resource_id即为该参数的值 上传图片尺寸600*600，支持格式：png、jpg、jpeg、bmp，大小不超过2MB 限制 1.voucher_image填入，该值才能填入； 2.最多3张；", "items" : { "type" : "string" } }, "voucher_image" : { "type" : "string", "description" : "券详情页封面图，会展示在用户支付宝卡包券详情页 需要通过 alipay.marketing.material.image.upload接口上传图片，指定file_key为PROMO_VOUCHER_IMAGE，接口返回的resource_id即为该参数的值 限制: 该字段在兑换券场景下必传 上传图片尺寸670*335，支持格式：png、jpg、jpeg、bmp，大小不超过2MB\t限制:\t1.指定可核销商品(available_goods)时必传" } } }, "PaymentVoucherRechargeInfo" : { "type" : "object", "properties" : { "alipay_balance_recharge_info" : { "$ref" : "#/components/schemas/PaymentVoucherAlipayBalanceRechargeInfo" }, "recharge_type" : { "type" : "string", "description" : "预充值方式。 \t枚举值 ALIPAY_BALANCE 支付宝余额预充值" } } }, "PaymentVoucherSendRule" : { "type" : "object", "properties" : { "max_quantity_by_day" : { "type" : "integer", "description" : "设置此字段，允许指定单天最大发券数量。\t\t限制:\t每天发放张数*活动天数应小于等于优惠券发放总量" }, "natural_person_limit" : { "type" : "boolean", "description" : "限制相同身份证号领取次数(voucher_quantity_limit_per_user)。默认false不限制。\t枚举值\ttrue：是\tfalse：否" }, "phone_number_limit" : { "type" : "boolean", "description" : "限制相同手机号领取次数(voucher_quantity_limit_per_user)。默认false不限制\t枚举值\ttrue：是\tfalse：否" }, "real_name_limit" : { "type" : "boolean", "description" : "限制支付宝实名用户才能领取支付券,默认为false表示不限制\t枚举值\ttrue\\false" }, "voucher_quantity" : { "type" : "integer", "description" : "发行券的总数量。\t限制：\t1、发放总个数最少1个\t2、发放总个数最多99999999个" }, "voucher_quantity_limit_per_user" : { "type" : "integer", "description" : "每人领取限制。 默认按照支付宝账号进行领取限制; \t不填写或填入0表示没有领取限制." }, "voucher_quantity_limit_per_user_period_type" : { "type" : "string", "description" : "周期限领配置,限制每人在固定周期内领取张数(voucher_quantity_limit_per_user),默认LIFE_CYCLE\t\t枚举值为 \tDAY:每天\tWEEK:每周\tMONTH:每月\tLIFE_CYCLE:整个活动周期" } } }, "PaymentVoucherUseRule" : { "type" : "object", "properties" : { "available_app_ids" : { "type" : "array", "description" : "可核销的支付宝小程序id\t\t限制： \t1、必须是支付宝小程序\t2、如果包含重复的小程序id会自动进行去重操作。", "items" : { "type" : "string" }, "example" : "[\"2021238412323412\"]" }, "available_goods" : { "$ref" : "#/components/schemas/PaymentVoucherAvailableGoods" }, "available_merchant" : { "$ref" : "#/components/schemas/PaymentVoucherAvailableMerchant" }, "available_store_ids" : { "type" : "array", "description" : "可核销支付球房id。\t限制： \t1、available_store_ids中的球房id必须是支付宝球房id。 \t2、available_store_ids如果包含重复的球房id会自动进行去重操作。", "items" : { "type" : "string" }, "example" : "[\"2018051000502000000011111111\",\"2018040200502000000011111111\",\"2018062800502000000022271997\"]" }, "fix_voucher" : { "$ref" : "#/components/schemas/PaymentFixVoucher" }, "unavailable_goods_ids" : { "type" : "array", "description" : "不可核销商品编码，商家自定义商品编码。当用户支付时，交易中的商品编码和支付券配置的商品编码有任一匹配时，不可以使用优惠券。\t\t限制:\t1、available_goods与unavailable_goods_ids只能二选一或者同时为空", "items" : { "type" : "string" }, "example" : "['apple-03','apple-04']" }, "use_mode" : { "type" : "string", "description" : "核销跳转方式,默认CAN_USE(详情页展示可使用按钮)\t枚举值:\tSCAN_CODE 跳转到支付宝收钱码\tSELF_LINK 跳转至商家指定页面\tCAN_USE 卡包券详情页显示可使用按钮", "example" : "SELF_LINK" }, "use_url" : { "type" : "string", "description" : "核销跳转链接\t限制:\t1、只有use_mode为SELF_LINK时该值有效且必传。\t2、核销跳转链接必须是支付宝小程序链接。", "example" : "alipays://platformapi/startapp?appId=201911136XXXXX&noneExit=true" }, "voucher_quantity_limit_per_user" : { "type" : "integer", "description" : "每个支付宝账号的核销次数限制。 默认不限制", "example" : "1" }, "voucher_quantity_limit_per_user_period_type" : { "type" : "string", "description" : "核销次数限制周期配置。默认值LIFE_CYCLE表示限制每个支付宝账号在整个活动期间核销次数。\t\t枚举值:\tDAY:每天 \tWEEK:每周 \tMONTH:每月 \tLIFE_CYCLE:整个活动", "example" : "DAY" }, "voucher_valid_period" : { "$ref" : "#/components/schemas/PaymentVoucherValidPeriod" } } }, "PaymentVoucherUseRuleDetail" : { "type" : "object", "properties" : { "fix_voucher" : { "$ref" : "#/components/schemas/PaymentFixVoucher" }, "use_mode" : { "type" : "string", "description" : "核销跳转方式,默认CAN_USE(详情页展示可使用按钮) 枚举值: \tSCAN_CODE 跳转到支付宝付钱码 \tSELF_LINK 跳转至商家指定页面 \tCAN_USE 卡包券详情页显示可使用按钮", "example" : "SELF_LINK" }, "use_url" : { "type" : "string", "description" : "核销跳转链接 限制: 1、只有use_mode为SELF_LINK时该值有效且必传。 2、核销跳转链接必须是支付宝小程序链接。", "example" : "alipays://platformapi/startapp?appId=201911136XXXXX&noneExit=true" }, "voucher_quantity_limit_per_user" : { "type" : "integer", "description" : "每个支付宝账号的核销次数限制。 默认不限制", "example" : "1" }, "voucher_quantity_limit_per_user_period_type" : { "type" : "string", "description" : "核销次数限制周期配置。默认值LIFE_CYCLE表示限制每个支付宝账号在整个活动期间核销次数。 枚举值: DAY:每天 WEEK:每周 MONTH:每月 LIFE_CYCLE:整个活动", "example" : "DAY" }, "voucher_valid_period" : { "$ref" : "#/components/schemas/PaymentVoucherValidPeriod" } } }, "PaymentVoucherUseRuleModify" : { "type" : "object", "properties" : { "available_app_ids" : { "type" : "string", "description" : "可核销的支付宝小程序id \t\t限制： \t1、必须是支付宝小程序 \t2、如果包含重复的小程序id会自动进行去重操作。\t3、可核销小程序范围只能扩大不能缩小", "example" : "[\"2021238412323412\"]" }, "available_goods" : { "$ref" : "#/components/schemas/PaymentVoucherAvailableGoodsModify" }, "available_merchant" : { "$ref" : "#/components/schemas/PaymentVoucherAvailableMerchantModify" }, "available_store_ids" : { "type" : "string", "description" : "可核销支付球房id。 \t\t限制： \t1、available_store_ids中的球房id必须是支付宝球房id。 \t2、available_store_ids如果包含重复的球房id会自动进行去重操作。\t3、可核销球房范围只能扩大不能缩小", "example" : "[\"2018051000502000000011111111\",\"2018040200502000000011111111\",\"2018062800502000000022271997\"]" }, "voucher_valid_period" : { "$ref" : "#/components/schemas/PaymentVoucherValidPeriodModify" } } }, "PaymentVoucherValidPeriod" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "券有效期。\t枚举值：\tABSOLUTE：绝对时间\tRELATIVE：相对时间" }, "valid_begin_time" : { "type" : "string", "description" : "券可使用的开始时间。\t\t格式为：yyyy-MM-dd HH:mm:ss\t\t限制：\ttype为ABSOLUTE时该字段必填。" }, "valid_days_after_receive" : { "type" : "integer", "description" : "券生效后N天内可以使用。\t\t可以配合wait_days_after_receive字段使用。\t\t限制：\t1.type为RELATIVE时必填。\t2.valid_days_after_receive必须大于0。" }, "valid_end_time" : { "type" : "string", "description" : "券可使用的结束时间。\t\t格式为yyyy-MM-dd HH:mm:ss\t\t限制：\t1、type为ABSOLUTE必填。\t2、券可使用的结束时间valid_end_time必须大于券的发放结束时间publish_end_time" }, "wait_days_after_receive" : { "type" : "integer", "description" : "用户领券后需要等待N天，券才可以生效。默认用户领券后立刻生效。\t\t限制：\t1、type为RELATIVE时可选。" } } }, "PaymentVoucherValidPeriodModify" : { "type" : "object", "properties" : { "valid_days_after_receive" : { "type" : "integer", "description" : "券生效后N天内可以使用。 限制： type为RELATIVE时可修改。 valid_days_after_receive必须大于0。 修改该时间，只允许延长，不允许缩短。", "example" : "3" }, "valid_end_time" : { "type" : "string", "description" : "券可使用的结束时间。 格式为yyyy-MM-dd HH:mm:ss 限制： type为ABSOLUTE可修改。 券可使用的结束时间valid_end_time 必须大于 券的发放结束时间 publish_end_time 修改券可使用的结束时间，只能延长，不允许缩短。", "example" : "2017-01-13 23:59:59" } } }, "PeriodRuleParams" : { "type" : "object", "properties" : { "execute_time" : { "type" : "string", "description" : "首次执行时间execute_time是周期扣款产品必填，即商户发起首次扣款的时间。精确到日，格式为yyyy-MM-dd\t结合其他必填的扣款周期参数，会确定商户以后的扣款计划。发起扣款的时间需符合这里的扣款计划。", "example" : "2019-01-23" }, "period" : { "type" : "integer", "description" : "周期数period是周期扣款产品必填。与另一参数period_type组合使用确定扣款周期，例如period_type为DAY，period=90，则扣款周期为90天。", "example" : "3" }, "period_type" : { "type" : "string", "description" : "周期类型period_type是周期扣款产品必填，枚举值为DAY和MONTH。\tDAY即扣款周期按天计，MONTH代表扣款周期按自然月。\t与另一参数period组合使用确定扣款周期，例如period_type为DAY，period=30，则扣款周期为30天；period_type为MONTH，period=3，则扣款周期为3个自然月。\t自然月是指，不论这个月有多少天，周期都计算到月份中的同一日期。例如1月3日到2月3日为一个自然月，1月3日到4月3日为三个自然月。注意周期类型使用MONTH的时候，计划扣款时间execute_time不允许传28日之后的日期（可以传28日），以此避免有些月份可能不存在对应日期的情况。", "example" : "DAY" }, "single_amount" : { "type" : "string", "description" : "单次扣款最大金额single_amount是周期扣款产品必填，即每次发起扣款时限制的最大金额，单位为元。商户每次发起扣款都不允许大于此金额。", "example" : "10.99" }, "total_amount" : { "type" : "string", "description" : "总金额限制，单位为元。如果传入此参数，商户多次扣款的累计金额不允许超过此金额。", "example" : "600" }, "total_payments" : { "type" : "integer", "description" : "总扣款次数。如果传入此参数，则商户成功扣款的次数不能超过此次数限制（扣款失败不计入）。", "example" : "12" } } }, "PluginBetaItemInfo" : { "type" : "object", "properties" : { "app_name" : { "type" : "string", "description" : "小程序名称", "example" : "小程序名称" }, "beta_status" : { "type" : "string", "description" : "被邀测状态，待确认WAITCHECK/确认CHECKED/拒绝REJECT", "example" : "WAITCHECK" }, "memo" : { "type" : "string", "description" : "拒绝原因", "example" : "拒绝原因" }, "mini_app_id" : { "type" : "string", "description" : "小程序ID", "example" : "2019****" }, "plugin_id" : { "type" : "string", "description" : "插件id", "example" : "2088xxx" }, "plugin_version" : { "type" : "string", "description" : "插件版本", "example" : "0.0.1" }, "qr_code_url" : { "type" : "string", "description" : "邀测二维码", "example" : "https://mobilecodec.alipay.com/show.htm?code=0le14985b5hyws8pcbyah5f" } } }, "PluginUseConfigInfo" : { "type" : "object", "properties" : { "bundle_id" : { "type" : "string", "description" : "端", "example" : "com.alipay.alipaywallet" }, "gray_code" : { "type" : "string", "description" : "灰度策略", "example" : "p1" }, "plugin_develop_version" : { "type" : "string", "description" : "插件研发版本", "example" : "0.0.3" }, "status" : { "type" : "string", "description" : "GRAY(灰度中)/RELEASE(在线状态)", "example" : "GRAY" } } }, "PluginUseRelationInfo" : { "type" : "object", "properties" : { "beta_memo" : { "type" : "string", "description" : "邀测驳回原因", "example" : "测试不通过" }, "beta_plugin_version" : { "type" : "string", "description" : "邀测插件版本号", "example" : "0.0.3" }, "beta_qr_code_url" : { "type" : "string", "description" : "邀测二维码", "example" : "https://mobilecodec.alipay.com/show.htm?code=0le14985b5hyws8pcbyah5f" }, "beta_status" : { "type" : "string", "description" : "WAITCHECK-待确认;CHECKED-确认;REJECT-拒绝", "example" : "WAITCHECK" }, "gmt_active" : { "type" : "string", "description" : "激活时间", "example" : "2018-05-10 15:10:25" }, "gmt_create" : { "type" : "string", "description" : "订购时间", "example" : "2018-05-10 15:10:25" }, "gmt_invalid" : { "type" : "string", "description" : "插件失效时间", "example" : "9999-12-31 00:00:00" }, "mini_app_id" : { "type" : "string", "description" : "应用ID", "example" : "2012211102012056" }, "plugin_deploy_version" : { "type" : "string", "description" : "插件构建版本", "example" : "0.2.1812171829.32" }, "plugin_id" : { "type" : "string", "description" : "插件ID", "example" : "2012211102012088" }, "plugin_status" : { "type" : "string", "description" : "插件状态，取值包括EXECUTING/WAIT_WORKING/WORKING/STOP_WORKING/WAIT_BUY", "example" : "WORKING" }, "plugin_use_config_info_list" : { "type" : "array", "description" : "分端版本配置信息列表", "items" : { "$ref" : "#/components/schemas/PluginUseConfigInfo" } }, "plugin_version" : { "type" : "string", "description" : "插件版本", "example" : "0.0.1" }, "run_mode_type" : { "type" : "string", "description" : "插件运行状态，取值包括ONLINE/TRIAL/REVIEW/DEBUG", "example" : "ONLINE" }, "source_from" : { "type" : "string", "description" : "渠道来源，取值包括SHOP_MINI/PLUGIN_DEBUG/PLUGIN_TRIAL/PLUGIN_AUDIT/GENERAL_SHOP_ID", "example" : "PLUGIN_DEBUG" } } }, "PointCard" : { "type" : "object", "properties" : { "desc" : { "type" : "string", "description" : "工具的描述", "example" : "集点卡的功能描述" }, "end_time" : { "type" : "string", "description" : "工具的有效期的结束时间（必须晚于活动的结束时间）", "example" : "2016-10-01 00:00:00" }, "logo" : { "type" : "string", "description" : "工具的LOGO文件ID", "example" : "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC" }, "name" : { "type" : "string", "description" : "工具的名称", "example" : "集点卡" }, "start_time" : { "type" : "string", "description" : "工具的有效期的起始时间", "example" : "2016-05-01 00:00:00" }, "type" : { "type" : "string", "description" : "工具类型，目前支持：\r\t集点卡：POINT_CARD", "example" : "POINT_CARD" } } }, "PreCreateWaybillIstd" : { "type" : "object", "properties" : { "coupon_fee" : { "type" : "string", "description" : "优惠券费用", "example" : "1.00" }, "deliver_fee" : { "type" : "string", "description" : "运费", "example" : "10.00" }, "dispatch_duration" : { "type" : "integer", "description" : "预计骑手还剩多久接单（单位：秒）", "example" : "300" }, "distance" : { "type" : "integer", "description" : "配送距离(单位：米)", "example" : "1000" }, "fee" : { "type" : "string", "description" : "实际运费", "example" : "9.00" }, "insurance_fee" : { "type" : "string", "description" : "保价费用", "example" : "0.00" }, "logistics_code" : { "type" : "string", "description" : "即时配送公司编码", "example" : "FENGNIAO" }, "logistics_token" : { "type" : "string", "description" : "配送公司可以返回此字段，当商家下单时候带上这个字段，保证在一段时间内运费不变", "example" : "token001" }, "pay_amount" : { "type" : "string", "description" : "支付金额，实际扣减的费用以此字段为准", "example" : "9.00" }, "service_code" : { "type" : "string", "description" : "即时配送公司服务代码", "example" : "fengniao01" }, "third_code" : { "type" : "string", "description" : "即时配送公司返回的响应码。10000表示业务处理成功，40004表示业务处理失败。", "example" : "10000" }, "third_sub_code" : { "type" : "string", "description" : "即时配送公司返回的错误码", "example" : "xxx" }, "third_sub_msg" : { "type" : "string", "description" : "即时配送公司返回的错误描述", "example" : "xxx" } } }, "PreOrderExtInfo" : { "type" : "object", "properties" : { "brand_id" : { "type" : "string", "description" : "品牌id", "example" : "123" }, "brand_name" : { "type" : "string", "description" : "品牌名称", "example" : "豫章人家" }, "channel" : { "type" : "string", "description" : "请求渠道", "example" : "APP, AlipayMiniApp, Taobao" }, "order_feature" : { "type" : "string", "description" : "单据属性,风控系统使用", "example" : "merchant_id@@@2088123456123456|||merchant_name@@@张三营业厅" } } }, "PresetPayToolInfo" : { "type" : "object", "properties" : { "amount" : { "type" : "array", "description" : "前置资产金额。单位：元。", "items" : { "type" : "string" }, "example" : "12.21" }, "assert_type_code" : { "type" : "string", "description" : "前置资产类型编码，和收单支付传入的preset_pay_tool里面的类型编码保持一致。", "example" : "盒马礼品卡:HEMA；抓猫猫红包:T_CAT_COUPON" } } }, "ProductAgentStatusInfo" : { "type" : "object", "properties" : { "product_code" : { "type" : "string", "description" : "产品编码", "example" : "FACE_TO_FACE_PAYMENT" }, "product_name" : { "type" : "string", "description" : "产品名称", "example" : "当面付收单" }, "reject_reason" : { "type" : "string", "description" : "产品被驳回的原因", "example" : "请您在签约时上传与账户主体一致的证件。" }, "status" : { "type" : "string", "description" : "none:未签约，表示还没有签约该产品 valid:已生效，表示合约已经生效，不需要再签约了 restrictValid:受限生效，表示合约已经生效，但是资料不全，功能受限 audit:审核中，已经有合约在审核中，请等待审核完成 waitConfirm:待商户确认协议，合约已经审核通过，需要商户确认后合约才生效 auditReject:审核未通过 invalid:合约失效，曾经签过合约，但已经失效了，可以重新发起签约 restrictInvalid:受限失效，受限合约失效了", "example" : "none|valid|restrictValid..." } } }, "ProductInviteStatusInfo" : { "type" : "object", "properties" : { "product_code" : { "type" : "string", "description" : "产品编码", "example" : "FACE_TO_FACE_PAYMENT" }, "product_name" : { "type" : "string", "description" : "产品名称", "example" : "当面付收单" }, "status" : { "type" : "string", "description" : "NONE：未签约，表示还没有签约该产品\tMERCHANT_AUDITING：审核中，已经有合约在审核中，请等待审核完成\tMERCHANT_CONFIRM_SUCCESS：已生效，表示合约已经生效，不需要再签约了\tMERCHANT_APPLY_ORDER_CANCELED：审核未通过", "example" : "NONE|MERCHANT_AUDITING|MERCHANT_CONFIRM_SUCCESS|MERCHANT_APPLY_ORDER_CANCELED" } } }, "ProductSignStatusInfo" : { "type" : "object", "properties" : { "product_code" : { "type" : "string", "description" : "产品编码", "example" : "FACE_TO_FACE_PAYMENT" }, "product_name" : { "type" : "string", "description" : "产品名称", "example" : "当面付收单" }, "status" : { "type" : "string", "description" : "none:未签约，表示还没有签约该产品\r\tvalid:已生效，表示合约已经生效，不需要再签约了\r\trestrictValid:受限生效，表示合约已经生效，但是资料不全，功能受限\r\taudit:审核中，已经有合约在审核中，请等待审核完成\r\twaitConfirm:待商户确认协议，合约已经审核通过，需要商户确认后合约才生效\r\tauditReject:审核未通过\r\tinvalid:合约失效，曾经签过合约，但已经失效了，可以重新发起签约\r\trestrictInvalid:受限失效，受限合约失效了", "example" : "none|valid|restrictValid|audit|waitConfirm|auditReject|invalid|restrictInvalid" } } }, "ProjectRuleInfo" : { "type" : "object", "properties" : { "effective_end_date" : { "type" : "string", "description" : "有效期截止", "example" : "2021-03-02 17:00:00" }, "effective_start_date" : { "type" : "string", "description" : "有效期起始", "example" : "2021-03-01 19:00:00" }, "employee_list" : { "type" : "array", "description" : "切换open_id前请使用此字段：员工uid列表", "items" : { "type" : "string" }, "example" : "[\"2088123412341234\"]" }, "employee_open_id_list" : { "type" : "array", "description" : "切换open_id后请使用此字段：员工open_id列表", "items" : { "type" : "string" }, "example" : "[\"abcdxxxx\"]" }, "expense_ctrl_rule_info_group_list" : { "type" : "array", "description" : "规则组列表", "items" : { "$ref" : "#/components/schemas/ExpenseCtrRuleGroupInfo" } }, "project_id" : { "type" : "string", "description" : "项目id", "example" : "1100" }, "project_name" : { "type" : "string", "description" : "项目名称", "example" : "费控项目" } } }, "PromiseDetail" : { "type" : "object", "properties" : { "auth_status" : { "type" : "boolean", "description" : "授权状态", "example" : "true" }, "create_time" : { "type" : "string", "description" : "任务创建时间", "example" : "yyyy-mm-dd hh:mm:ss" }, "end_time" : { "type" : "string", "description" : "任务结束时间", "example" : "yyyy-mm-dd hh:mm:ss" }, "final_time" : { "type" : "string", "description" : "任务到达终态的时间", "example" : "yyyy-mm-dd hh:mm:ss" }, "finish_periods" : { "type" : "integer", "description" : "任务完成期数", "example" : "1" }, "merchant_id" : { "type" : "string", "description" : "芝麻侧的商户id", "example" : "lefit" }, "merchant_logo" : { "type" : "string", "description" : "商户logo", "example" : "https://icon.png" }, "merchant_name" : { "type" : "string", "description" : "商户名称", "example" : "乐刻" }, "out_biz_no" : { "type" : "string", "description" : "生活记录加入时的外部业务号", "example" : "84927419" }, "period_type" : { "type" : "string", "description" : "周期类型", "example" : "multi" }, "promise_name" : { "type" : "string", "description" : "生活记录模板名称", "example" : "每周攒钱，完成心愿" }, "record_id" : { "type" : "string", "description" : "生活记录主记录id", "example" : "2022101865652385257" }, "record_status" : { "type" : "string", "description" : "主任务状态", "example" : "PROCESSING、UN_FINISH、CANCELED、FINISH，分别对应进行中、未完成、已取消、已完成" }, "start_time" : { "type" : "string", "description" : "任务开始时间", "example" : "yyyy-mm-dd hh:mm:ss" }, "sub_record_status" : { "type" : "string", "description" : "子记录状态", "example" : "PROCESSING、UN_FINISH、CANCELED、FINISH，分别对应进行中、未完成、已取消、已完成" }, "sub_title" : { "type" : "string", "description" : "副标题", "example" : "加入后7天内完成1次攒钱" }, "template_id" : { "type" : "string", "description" : "生活记录模板id", "example" : "save_money_every_week" }, "total_periods" : { "type" : "integer", "description" : "任务总期数", "example" : "4" } } }, "PromoDeliveryInfo" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "活动id", "example" : "201222222xxxxx" }, "booth_code" : { "type" : "string", "description" : "展位码:boothCode表达的是具体渠道所属的展位码。例如：支付结果页PAYMENT_RESULT", "example" : "PAYMENT_RESULT" }, "channel" : { "type" : "string", "description" : "可投放的渠道标识. 说明： 针对不同的boot_code，channel值各不相同.接口使用者可以认为channel是不同booth_code展位下的渠道的唯一标识。 例如： booth_code为PAYMENT_RESULT。 channel为某个商户的pid。", "example" : "2088xxxxxxx" }, "channel_name" : { "type" : "string", "description" : "渠道名称", "example" : "支付宝官方渠道" }, "delivery_status" : { "type" : "string", "description" : "投放状态.\t\t枚举值：\tACTIVE: 生效的投放。\tINACTIVE: 失效的投放。", "example" : "ACTIVE" } } }, "PromoOperatorInfo" : { "type" : "object", "properties" : { "operator_id" : { "type" : "string", "description" : "操作人id" }, "operator_type" : { "type" : "string", "description" : "操作人类型。SALES：口碑内部小二；MER：商户；MER_OPERATOR：商户员工；PROVIDER：服务商；PROVIDER_STAFF：服务商员工；" } } }, "PromoPageInfo" : { "type" : "object", "properties" : { "page_num" : { "type" : "integer", "description" : "页码", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "每页大小", "example" : "20" } } }, "PromoPageResult" : { "type" : "object", "properties" : { "page_num" : { "type" : "integer", "description" : "页码", "example" : "10" }, "page_size" : { "type" : "integer", "description" : "每页多少条", "example" : "10" }, "total_count" : { "type" : "integer", "description" : "总条数", "example" : "10000" }, "total_pages" : { "type" : "integer", "description" : "总共有多少页", "example" : "10" } } }, "PromoParam" : { "type" : "object", "properties" : { "actual_order_time" : { "type" : "string", "description" : "存在延迟扣款这一类的场景，用这个时间表明用户发生交易的时间，比如说，在公交地铁场景，用户刷码出站的时间，和商户上送交易的时间是不一样的。", "example" : "2018-09-25 22:47:33" } } }, "PromoTool" : { "type" : "object", "properties" : { "point_card" : { "$ref" : "#/components/schemas/PointCard" }, "send_rule" : { "$ref" : "#/components/schemas/SendRule" }, "status" : { "type" : "string", "description" : "单个营销工具的生效状态，当在招商部分券失效后会使用这个字段", "example" : "STARTED" }, "voucher" : { "$ref" : "#/components/schemas/Voucher" }, "voucher_no" : { "type" : "string", "description" : "营销工具uid,创建营销活动时无需设置", "example" : "2342343245234234" } } }, "PromotePageData" : { "type" : "object", "properties" : { "biz_no" : { "type" : "string", "description" : "留资流水号", "example" : "Zybnom890437Mvcu" }, "property_list" : { "type" : "array", "description" : "留资属性实例数据列表", "items" : { "$ref" : "#/components/schemas/PromotePagePropertyInstance" } } } }, "PromotePageDetail" : { "type" : "object", "properties" : { "gmt_create" : { "type" : "string", "description" : "推广页创建时间，格式：yyyy-mm-dd hh:mm:ss", "example" : "2020-12-12 12:20:30" }, "id" : { "type" : "integer", "description" : "推广页id", "example" : "2018374" }, "name" : { "type" : "string", "description" : "推广页名称", "example" : "测试留资推广页" }, "property_list" : { "type" : "array", "description" : "推广留资schema", "items" : { "$ref" : "#/components/schemas/PromotePageProperty" } }, "type" : { "type" : "string", "description" : "推广页类型：COLLECT_INFO - 普通留资；TRADE - 交易留资", "example" : "COLLECT_INFO" } } }, "PromotePageProperty" : { "type" : "object", "properties" : { "key" : { "type" : "string", "description" : "留资属性key", "example" : "orderId" }, "name" : { "type" : "string", "description" : "留资属性名称", "example" : "订单号" } } }, "PromotePagePropertyInstance" : { "type" : "object", "properties" : { "key" : { "type" : "string", "description" : "留资属性key", "example" : "orderId" }, "name" : { "type" : "string", "description" : "留资属性名称", "example" : "订单号" }, "value" : { "type" : "string", "description" : "留资属性实例值", "example" : "A27904vbvjlmn" } } }, "PromotionRelationDTO" : { "type" : "object", "properties" : { "apply_reason" : { "type" : "string", "description" : "申请推广时填写的申请理由", "example" : "XXX" }, "commodity_id" : { "type" : "string", "description" : "服务商品ID", "example" : "SS010101000000003954" }, "commodity_name" : { "type" : "string", "description" : "服务商品名称", "example" : "测试服务" }, "create_time" : { "type" : "string", "description" : "推广关系创建时间", "example" : "2020-10-12 12:10:10" }, "promoter_contact_name" : { "type" : "string", "description" : "推广服务商联系人名称", "example" : "张三" }, "promoter_contact_phone" : { "type" : "string", "description" : "推广服务商联系电话", "example" : "136xxxxxxxx" }, "promoter_name" : { "type" : "string", "description" : "推广服务商的名称", "example" : "xx商户" }, "promoter_pid" : { "type" : "string", "description" : "推广服务商的pid", "example" : "2088301324945205" }, "promotion_id" : { "type" : "string", "description" : "推广任务id", "example" : "2018052401048283" }, "promotion_name" : { "type" : "string", "description" : "推广任务的名称", "example" : "测试推广任务" } } }, "PromotionTaskRelation" : { "type" : "object", "properties" : { "apply_reason" : { "type" : "string", "description" : "申请推广时填写的申请理由", "example" : "XXX" }, "commodity_id" : { "type" : "string", "description" : "服务商品ID", "example" : "SS010101000000003954" }, "commodity_name" : { "type" : "string", "description" : "服务商品名称", "example" : "测试服务" }, "create_time" : { "type" : "string", "description" : "推广关系创建时间", "example" : "2020-10-12 12:10:10" }, "promoter_contact_name" : { "type" : "string", "description" : "推广服务商联系人名称", "example" : "张三" }, "promoter_contact_phone" : { "type" : "string", "description" : "推广服务商联系电话", "example" : "136xxxxxxxx" }, "promoter_name" : { "type" : "string", "description" : "推广服务商的名称", "example" : "xx商户" }, "promoter_pid" : { "type" : "string", "description" : "推广服务商的pid", "example" : "2088301324945205" }, "promotion_id" : { "type" : "string", "description" : "推广任务id", "example" : "2018052401048283" }, "promotion_name" : { "type" : "string", "description" : "推广任务的名称", "example" : "测试推广任务" } } }, "PubChannelDTO" : { "type" : "object", "properties" : { "ext_info" : { "type" : "string", "description" : "扩展信息，无需配置" }, "pub_channel" : { "type" : "string", "description" : "1、SHOP_DETAIL:店铺详情页 \r\t2、PAYMENT_RESULT: 支付成功页（支付成功页暂不支持）" } } }, "PublicAuditStatus" : { "type" : "object", "properties" : { "desc" : { "type" : "string", "description" : "审核状态描述，如果审核驳回则有相关的驳回理由", "example" : "logo不符合规范" }, "status" : { "type" : "string", "description" : "AUDITING：审核中，AUDIT_FAILED：审核驳回，AUDIT_SUCCESS：审核通过，AUDIT_NORMAL：无审核记录", "example" : "AUDITING" }, "type" : { "type" : "string", "description" : "NAME:名称、AVATAR:头像、NAME_AVATAR:名称与头像、INTRODUCTION:简介", "example" : "NAME" } } }, "PublicLabel" : { "type" : "object", "properties" : { "count" : { "type" : "integer", "description" : "标签用户量", "example" : "100000" }, "id" : { "type" : "string", "description" : "标签编号", "example" : "10005556" }, "name" : { "type" : "string", "description" : "标签名称", "example" : "标签1" } } }, "PublishChannel" : { "type" : "object", "properties" : { "config" : { "type" : "string", "description" : "当type为MERCHANT_CROWD时，config需填入口令送的密码和图片，样例如下：\"config\":\"{\\\"PASSWORD\\\":\\\"口令送密码\\\",\\\"BACKGROUND_LOGO\\\":\\\"1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC\\\"}\"", "example" : "{\"PASSWORD\":\"口令送密码\",\"BACKGROUND_LOGO\":\"1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC\"}" }, "ext_info" : { "type" : "string", "description" : "扩展信息，无需配置", "example" : "\"key\":\"value\"" }, "name" : { "type" : "string", "description" : "渠道名称", "example" : "投放到店铺" }, "type" : { "type" : "string", "description" : "渠道类型，目前支持以下类型\r\tQR_CODE：二维码投放\r\tSHORT_LINK：短连接投放\r\tSHOP_DETAIL：店铺页投放\r\tPAYMENT_RESULT：支付成功页\r\tMERCHANT_CROWD：口令送\r\tURL_WITH_TOKEN：外部发奖活动，只有活动类型为DIRECT_SEND时才支持\r\tEXTERNAL：外部投放，口碑需要感知任何投放内容", "example" : "SHOP_DETAIL" } } }, "QrCodeRouteGroup" : { "type" : "object", "properties" : { "mode" : { "type" : "string", "description" : "匹配规则，EXACT（精确匹配）、FUZZY（模糊匹配）、PATTERN（模式匹配）\\\\（如：配置二维码地址为https://www.alipay.com/my?id=123，当用户扫这个地址的二维码可唤起小程序）。 模糊匹配：根据填写的二维码地址模糊匹配，只要地址前缀匹配即可唤起小程序（如：配置二维码地址为https://www.alipay.com/my/，当用户扫的二维码地址为https://www.alipay.com/my/id=123,可唤起小程序）。\t。 模式匹配：根据填写的二维码地址可变变量进行匹配，只要地址的变量位置自定义，变量之外的部分匹配即可唤起小程序(如：配置的二维码地址为https://www.alipay.com/{0}/my/{1},当用户扫的二维码地址为：https://www.alipay.com/user/my/scan，可唤起小程序)", "example" : "EXACT" }, "route_group" : { "type" : "string", "description" : "路由组id（参数说明：该参数可用于alipay.open.mini.qrcode.unbind接口入参route_group，进行二维码解绑）", "example" : "eda224f222194cc48c27a3e6319fd331" }, "route_url" : { "type" : "string", "description" : "规则路由地址", "example" : "https://www.alipay.com/isv/" } } }, "QueryComplexLabelRule" : { "type" : "object", "properties" : { "label_id" : { "type" : "string", "description" : "标签id", "example" : "10000" }, "label_name" : { "type" : "string", "description" : "标签名", "example" : "职业" }, "label_value" : { "type" : "string", "description" : "当有多个取值时用英文\",\"分隔，不允许传入下划线\"_\"、竖线\"|\"或者空格\" \"", "example" : "程序员" }, "operator" : { "type" : "string", "description" : "运算符", "example" : "EQ" } } }, "QueryExtension" : { "type" : "object", "properties" : { "areas" : { "type" : "array", "description" : "扩展区列表", "items" : { "$ref" : "#/components/schemas/ExtensionArea" } }, "extension_key" : { "type" : "string", "description" : "扩展区套id", "example" : "2013121100055552_7c3cb211-e239-42c0-abb0-fe80d02cfe51" }, "label_rules" : { "type" : "array", "description" : "标签规则列表", "items" : { "$ref" : "#/components/schemas/QueryLabelRule" } }, "status" : { "type" : "string", "description" : "扩展区状态，\"ON\"代表上线，\"OFF\"代表下线，只有上线的扩展区才能被用户看到", "example" : "ON" } } }, "QueryGroup" : { "type" : "object", "properties" : { "count" : { "type" : "integer", "description" : "人群中包含人数", "example" : "888888" }, "id" : { "type" : "string", "description" : "分组id", "example" : "100" }, "label_rule" : { "type" : "array", "description" : "分组中的圈人规则", "items" : { "$ref" : "#/components/schemas/QueryComplexLabelRule" } }, "name" : { "type" : "string", "description" : "用户分组名称", "example" : "测试分组" } } }, "QueryLabelRule" : { "type" : "object", "properties" : { "label_id" : { "type" : "string", "description" : "标签id" }, "label_name" : { "type" : "string", "description" : "标签名" }, "label_value" : { "type" : "string", "description" : "标签值，多值会用英文逗号分隔" }, "operator" : { "type" : "string", "description" : "运算符" } } }, "QueryMenu" : { "type" : "object", "properties" : { "button" : { "type" : "array", "description" : "一级菜单列表", "items" : { "$ref" : "#/components/schemas/ButtonObject" } }, "label_rule" : { "type" : "array", "description" : "标签规则项列表", "items" : { "$ref" : "#/components/schemas/QueryLabelRule" } }, "menu_key" : { "type" : "string", "description" : "菜单唯一id", "example" : "default" }, "type" : { "type" : "string", "description" : "菜单类型，icon：icon型菜单，text：文本型菜单", "example" : "icon" } } }, "QuotaModifyDetail" : { "type" : "object", "properties" : { "agreement_no" : { "type" : "string", "description" : "授权协议号，和入参的协议号对应", "example" : "20216006003193457889" }, "error_code" : { "type" : "string", "description" : "明细处理错误码，当success为false时有值", "example" : "INVALID_AGREEMENT_NO" }, "fail_reason" : { "type" : "string", "description" : "错误描述，当success为false时有值", "example" : "无效的协议" }, "success" : { "type" : "boolean", "description" : "当前协议下的明细处理结果", "example" : "true" } } }, "QuotaQueryResponse" : { "type" : "object", "properties" : { "agreement_no" : { "type" : "string", "description" : "协议号", "example" : "20205321001042231004" }, "error_code" : { "type" : "string", "description" : "单个协议查询结果错误码", "example" : "INVALID_AGREEMENT" }, "fail_reason" : { "type" : "string", "description" : "单个协议响应错误描述", "example" : "无效的三方协议" }, "quota_details" : { "$ref" : "#/components/schemas/AccountQuotaDetail" }, "success" : { "type" : "string", "description" : "单个协议查询结果是否成功", "example" : "true" } } }, "ReceiverAddressInfo" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "收货地址", "example" : "上海市浦东新区陆家嘴银城中路501号" }, "division_code" : { "type" : "string", "description" : "中国标准城市区域码", "example" : "310115" }, "mobile" : { "type" : "string", "description" : "收货人手机号", "example" : "13120180615" }, "name" : { "type" : "string", "description" : "收货人的姓名", "example" : "张三" }, "zip" : { "type" : "string", "description" : "收货地址邮编", "example" : "200120" } } }, "ReceiverIstd" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "地址(街道、小区、大厦等，用于定位)" }, "address_detail" : { "type" : "string", "description" : "地址详情(楼号、单元号、层号)" }, "city" : { "type" : "string", "description" : "城市名称，如杭州市" }, "coordinate_type" : { "type" : "integer", "description" : "坐标类型，0：火星坐标（高德，腾讯地图均采用火星坐标） 1：百度坐标。目前只支持0:火星坐标" }, "lat" : { "type" : "string", "description" : "纬度" }, "lng" : { "type" : "string", "description" : "经度" }, "mobile_no" : { "type" : "string", "description" : "手机号" }, "name" : { "type" : "string", "description" : "姓名" } } }, "RecommendAccountDTO" : { "type" : "object", "properties" : { "alipay_account" : { "type" : "string", "description" : "推荐商家支付宝登录账号，邮箱或手机号码，脱敏处理" }, "user_name" : { "type" : "string", "description" : "推荐商家支付宝账号名称，脱敏处理" } } }, "RecruitEnrollInfo" : { "type" : "object", "properties" : { "cities" : { "type" : "array", "description" : "报名提交的活动城市码，详见活动城市码", "items" : { "type" : "string" } }, "enroll_merchant" : { "$ref" : "#/components/schemas/RecruitEnrollMerchant" }, "materials" : { "type" : "array", "description" : "报名提交的素材", "items" : { "$ref" : "#/components/schemas/RecruitMaterial" } }, "mini_apps" : { "type" : "array", "description" : "报名提交的小程序信息，是否必选取决于方案要求", "items" : { "$ref" : "#/components/schemas/RecruitMiniApp" } }, "vouchers" : { "type" : "array", "description" : "报名提交的券信息，是否必选取决于方案要求", "items" : { "$ref" : "#/components/schemas/RecruitVoucher" } } } }, "RecruitEnrollMerchant" : { "type" : "object", "properties" : { "merchant_uid" : { "type" : "string", "description" : "商户唯一ID(商户pid)" } } }, "RecruitEnrollRule" : { "type" : "object", "properties" : { "max_size" : { "type" : "integer", "description" : "最大数量", "example" : "1" }, "min_size" : { "type" : "integer", "description" : "最小数量", "example" : "1" }, "required" : { "type" : "boolean", "description" : "是否必填", "example" : "true" }, "rule_data" : { "$ref" : "#/components/schemas/RecruitEnrollRuleData" }, "type" : { "type" : "string", "description" : "招商报名时提交的内容类型:\t券:VOUCHER;\t小程序:MINI_APP;\t报名商户:ENROLL_MERCHANT;\t素材:MATERIAL;\t活动城市:CITY;", "example" : "VOUCHER" } } }, "RecruitEnrollRuleData" : { "type" : "object", "properties" : { "recruit_voucher_rules" : { "type" : "array", "description" : "招商方案可提报的券的规则列表，不同的券有不同的规则。", "items" : { "$ref" : "#/components/schemas/RecruitVoucherRule" } }, "schema" : { "type" : "string", "description" : "素材的要求，json字符串，使用时需要把此字符串解析成json对象。\tfield：提报的字段key\tlabel：字段说明\trequired：是否必填\ttype：字段类型。包含：图片（IMAGE）、文本（TEXT）、数据源（DATASOURCE）等\trules：字段约束规则\t 图片（IMAGE）：\t image_size：图片宽高，单位是PX\t file_type：图片类型\t file_size：表示图片大小的最大值，单位是KB\t image_aspect_ratio: 图片宽高比例\t 文本（TEXT）：\t unicode_length：文本长度，单位为Byte\t 数据源（DATASOURCE）：\t unicode_length：文本长度，单位为Byte", "example" : "[{\"field\":\"activityImage\",\"label\":\"活动图片\",\"type\":\"IMAGE\",\"required\":true,\"rules\":{\"image_size\":[400,300],\"file_type\":[\"jpg\"],\"file_size\":500}},{\"field\":\"contentId\",\"label\":\"内容ID\",\"required\":true,\"rules\":{\"unicode_length\":[2,512]},\"type\":\"DATASOURCE\"}]" } } }, "RecruitMaterial" : { "type" : "object", "properties" : { "data" : { "type" : "string", "description" : "提报的素材内容，json字符串，使用时需要把此字符串解析成json对象。\t字段来源于“招商方案查询接口（https://opendocs.alipay.com/pre-open/02bhl7）”中返回的素材字段field。如：activityImage、contentId等。\t字段类型mediaType包含：\t IMAGE，图片类型\t TEXT，文本类型\t DATASOURCE，数据源类型， 如：内容ID（contentId）字段类型为DATASOURCE\t字段取值：\t 图片（IMAGE）：\t aftsFileId：“营销图片资源上传接口（https://opendocs.alipay.com/pre-open/02bhlj）”返回的图片唯一资源ID\t 文本（TEXT）：\t text：文本内容\t 数据源（DATASOURCE）：\t text：当前仅支持内容ID值，可通过“内容批量查询接口（https://opendocs.alipay.com/pre-apis/02lu12，仅供受邀用户使用）”查询内容ID。" }, "description" : { "type" : "string", "description" : "对这个素材的描述，用于后续管理该素材" }, "material_audit_info" : { "type" : "string", "description" : "素材审核信息，展示给商家的素材审核不通过的意见。素材审核通过时该字段为空。\t报名详情查询接口不用填写该字段。" }, "name" : { "type" : "string", "description" : "素材名名称" }, "subject_id" : { "type" : "string", "description" : "关联的报名主体ID。\tenroll_scene_type是VOUCHER时，报名主体ID是activity_id；enroll_scene_type是MINI_APP时，报名主体ID是mini_app_id" } } }, "RecruitMiniApp" : { "type" : "object", "properties" : { "mini_app_id" : { "type" : "string", "description" : "小程序ID" } } }, "RecruitPlanLight" : { "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "招商方案描述：富文本内容，可能包含html标签", "example" : "

招商规则说明

" }, "enroll_end_time" : { "type" : "string", "description" : "报名结束时间", "example" : "2021-01-01 01:01:01" }, "enroll_scene_type" : { "type" : "string", "description" : "招商方案所属报名场景\t枚举值：\tVOUCHER：券报名场景；\tMINI_APP：小程序报名场景；", "example" : "VOUCHER" }, "enroll_start_time" : { "type" : "string", "description" : "报名开始时间", "example" : "2021-01-01 01:01:01" }, "logo" : { "type" : "string", "description" : "方案头图链接，150x150 以上尺寸的方形图片", "example" : "https://xxxx" }, "plan_id" : { "type" : "string", "description" : "招商方案ID", "example" : "2021041201000100000000999999" }, "plan_name" : { "type" : "string", "description" : "招商方案名称", "example" : "中秋招商方案" }, "status" : { "type" : "string", "description" : "方案状态: 可用:ENABLED", "example" : "ENABLED" } } }, "RecruitVoucher" : { "type" : "object", "properties" : { "activity_id" : { "type" : "string", "description" : "券活动id。支持商家券（创建商家券请参考https://opendocs.alipay.com/apis/01xm17）和支付券（创建支付券请参考https://opendocs.alipay.com/pre-apis/027185，仅供受邀用户使用），取值均为返回结果的activity_id字段。" } } }, "RecruitVoucherRule" : { "type" : "object", "properties" : { "amount_max" : { "type" : "string", "description" : "券面额（每张代金券可以抵扣的金额）的的最大值。 币种为人民币，单位为元。小数点以后最多保留两位。 该字段为空时表示不限制。", "example" : "15.00" }, "amount_min" : { "type" : "string", "description" : "券面额（每张代金券可以抵扣的金额）的最小值。 币种为人民币，单位为元。小数点以后最多保留两位。 该字段为空时表示不限制。", "example" : "12.00" }, "denomination_percent_max" : { "type" : "string", "description" : "券优惠比例的最大值。20代表优惠比例最多是20%。券优惠券比例=券优惠面额/门槛金额。\t浮点类型，取值范围为[1,100]，左右均是闭区间，小数点以后最多保留两位。\t该字段为空时表示不限制。", "example" : "20" }, "denomination_percent_min" : { "type" : "string", "description" : "券优惠比例的最小值。10代表优惠比例最少是10%。券优惠券比例=券优惠面额/门槛金额。\t浮点类型，取值范围为[1,100]，左右均是闭区间，小数点以后最多保留两位。\t该字段为空时表示不限制。", "example" : "10" }, "floor_amount_max" : { "type" : "string", "description" : "券门槛金额的最大值。\t币种为人民币，单位为元。小数点以后最多保留两位。\t该字段为空时表示不限制。", "example" : "20.00" }, "floor_amount_min" : { "type" : "string", "description" : "券门槛金额的最小值。\t币种为人民币，单位为元。小数点以后最多保留两位。\t该字段为空时表示不限制。", "example" : "10.00" }, "origin_amount_max" : { "type" : "string", "description" : "券原价的最大值。\t币种为人民币，单位为元。小数点以后最多保留两位。\t该字段为空时表示不限制。", "example" : "20.00" }, "origin_amount_min" : { "type" : "string", "description" : "券原价的最小值。\t币种为人民币，单位为元。小数点以后最多保留两位。\t该字段为空时表示不限制。", "example" : "10.00" }, "publish_end_time_max" : { "type" : "string", "description" : "券发放结束时间的最大值。\t格式为：yyyy-MM-dd HH:mm:ss\t该字段为空时表示不限制。", "example" : "2022-01-13 23:59:59" }, "publish_end_time_min" : { "type" : "string", "description" : "券发放结束时间的最小值。\t格式为：yyyy-MM-dd HH:mm:ss\t该字段为空时表示不限制。", "example" : "2019-09-10 00:00:00" }, "publish_start_time_max" : { "type" : "string", "description" : "券发放开始时间的最大值。\t格式为：yyyy-MM-dd HH:mm:ss\t该字段为空时表示不限制。", "example" : "2022-01-13 23:59:59" }, "publish_start_time_min" : { "type" : "string", "description" : "券发放开始时间的最小值。\t格式为：yyyy-MM-dd HH:mm:ss\t该字段为空时表示不限制。", "example" : "2019-09-10 00:00:00" }, "refund_type" : { "type" : "array", "description" : "退券类型要求，列表，总共有两种类型：\t过期退OVERDUE_REFUND\t随时退CAN_REFUND\t该字段为空时表示不限制。", "items" : { "type" : "string" }, "example" : "[\"CAN_REFUND\",\"OVERDUE_REFUND\"]" }, "sale_amount_max" : { "type" : "string", "description" : "用户购买优惠券需要支付的金额的最大值。\t币种为人民币，单位为元。小数点以后最多保留两位。\t该字段为空时表示不限制。", "example" : "20.00" }, "sale_amount_min" : { "type" : "string", "description" : "用户购买优惠券需要支付的金额的最小值。\t币种为人民币，单位为元。小数点以后最多保留两位。\t该字段为空时表示不限制。", "example" : "10.00" }, "use_channel" : { "type" : "array", "description" : "券核销渠道要求，列表，总共有两个渠道：\t球房SHOP\t小程序MINI_APP\t该字段为空时表示不限制。", "items" : { "type" : "string" }, "example" : "[ \"SHOP\", \"MINI_APP\" ]" }, "valid_days_after_receive_min" : { "type" : "integer", "description" : "券生效后至少N天内可以使用。比如：valid_days_after_receive_min=20代表\t券生效后至少20天内可以使用。\t该字段为空时表示不限制。", "example" : "20" }, "voucher_activity_type" : { "type" : "string", "description" : "券活动类型。支持七种商家券类型和两种支付券类型。\t\t枚举值：\t商家券类型：\t\tALL_FIX_ORDER_VOUCHER 全场满减券；\t\tITEM_FIX_ORDER_VOUCHER 单品满减券；\t\tALL_DISCOUNT_ORDER_VOUCHER 全场折扣券；\t\tITEM_DISCOUNT_ORDER_VOUCHER 单品折扣券；\t\tITEM_SPE_ORDER_VOUCHER 单品特价券；\t\tEXCHANGE_GROUP_BUY_ORDER_VOUCHER 兑换团购券；\t\tEXCHANGE_FIX_ORDER_VOUCHER 兑换代金券；\t\t支付券类型：\t\tALL_FIX_VOUCHER 全场满减券；\t\tITEM_FIX_VOUCHER 单品满减券；\t\t创建商家券参考https://opendocs.alipay.com/apis/01xm17\t创建支付券参考https://opendocs.alipay.com/pre-apis/027185（仅供受邀用户使用）\t不同的创建券的参数创建出不同类型的券：\t 1. 根据voucher_type区分满减券、折扣券、特价券、兑换券\t 2. 根据goods_name是否为空区分单品券、全场券（当voucher_type为满减券、折扣券、特价券）\t 3. 根据voucher_use_rule.exchange_voucher.biz_type区分团购券、代金券（当voucher_type为兑换券）", "example" : "ITEM_FIX_ORDER_VOUCHER" }, "voucher_quantity_limit_per_user_max" : { "type" : "integer", "description" : "每人领取限制的最大值。\t默认按照支付宝uid进行领取限制。\t该字段为空时表示不限制。", "example" : "20" }, "voucher_quantity_limit_per_user_min" : { "type" : "integer", "description" : "每人领取限制的最小值。\t默认按照支付宝uid进行领取限制。\t该字段为空时表示不限制。", "example" : "10" }, "voucher_quantity_max" : { "type" : "integer", "description" : "券库存数量的最大值。\t该字段为空时表示不限制。", "example" : "20" }, "voucher_quantity_min" : { "type" : "integer", "description" : "券库存数量的最小值。\t该字段为空时表示不限制。", "example" : "10" }, "voucher_valid_begin_time_min" : { "type" : "string", "description" : "券可使用的开始时间的最小值。\t格式为：yyyy-MM-dd HH:mm:ss\t该字段为空时表示不限制。", "example" : "2022-01-13 23:59:59" }, "voucher_valid_end_time_max" : { "type" : "string", "description" : "券可使用的结束时间的最大值。\t格式为：yyyy-MM-dd HH:mm:ss\t该字段为空时表示不限制。", "example" : "2022-01-13 23:59:59" } } }, "RefundChargeInfo" : { "type" : "object", "properties" : { "charge_type" : { "type" : "string", "description" : "收单手续费trade，花呗分期手续hbfq，其他手续费charge" }, "refund_charge_fee" : { "type" : "string", "description" : "实退费用。单位：元。" }, "refund_sub_fee_detail_list" : { "type" : "array", "description" : "组合支付退费明细", "items" : { "$ref" : "#/components/schemas/RefundSubFee" } }, "switch_fee_rate" : { "type" : "string", "description" : "签约费率" } } }, "RefundGoodsDetail" : { "type" : "object", "properties" : { "goods_id" : { "type" : "string", "description" : "商品编号。\t对应支付时传入的goods_id", "example" : "apple-01" }, "refund_amount" : { "type" : "string", "description" : "该商品的退款总金额，单位为元", "example" : "19.50" } } }, "RefundRoyaltyResult" : { "type" : "object", "properties" : { "refund_amount" : { "type" : "string", "description" : "退分账金额。单位：元。", "example" : "10" }, "result_code" : { "type" : "string", "description" : "退分账结果码", "example" : "SUCCESS" }, "royalty_type" : { "type" : "string", "description" : "分账类型.\r\t普通分账为：transfer;\r\t补差为：replenish;\r\t为空默认为分账transfer;", "example" : "transfer" }, "trans_in" : { "type" : "string", "description" : "转入人支付宝账号对应用户ID", "example" : "2088102210397302" }, "trans_in_email" : { "type" : "string", "description" : "转入人支付宝账号", "example" : "zen_gwen@hotmail.com" }, "trans_out" : { "type" : "string", "description" : "转出人支付宝账号对应用户ID", "example" : "2088102210397302" }, "trans_out_email" : { "type" : "string", "description" : "转出人支付宝账号", "example" : "alipay-test03@alipay.com" } } }, "RefundSubFee" : { "type" : "object", "properties" : { "refund_charge_fee" : { "type" : "string", "description" : "实退费用。单位：元。" }, "switch_fee_rate" : { "type" : "string", "description" : "签约费率" } } }, "RegionInfo" : { "type" : "object", "properties" : { "area_code" : { "type" : "string", "description" : "地址所属区代码" }, "area_name" : { "type" : "string", "description" : "地址所属区名称" }, "city_code" : { "type" : "string", "description" : "地址所属市代码" }, "city_name" : { "type" : "string", "description" : "地址所属市名称" }, "province_code" : { "type" : "string", "description" : "地址所属省份代码" }, "province_name" : { "type" : "string", "description" : "地址所属省份名称" } } }, "ReplyRecord" : { "type" : "object", "properties" : { "content" : { "type" : "string", "description" : "回复内容" }, "gmt_create" : { "type" : "string", "description" : "回复时间" }, "images" : { "type" : "array", "description" : "回复图片", "items" : { "type" : "string" } }, "replier_role" : { "type" : "string", "description" : "回复角色\t商家：MERCHANT \t审核小二：AUDITOR" }, "status" : { "type" : "string", "description" : "状态。只在replier_role = ‘AUDITOR’时有值。\tappealSuccess：申诉通过\tappealFailed：申诉不通过\trectifyPass：整改通过\trectifyReject：整改不通过" } } }, "ReplyRecordResponse" : { "type" : "object", "properties" : { "content" : { "type" : "string", "description" : "回复内容", "example" : "已退款退货给您，物流单号为：12344444" }, "gmt_create" : { "type" : "string", "description" : "回复时间", "example" : "2020-02-14 14:23:12" }, "images" : { "type" : "array", "description" : "回复图片", "items" : { "type" : "string" }, "example" : "[\"http://mdn.alipay.com/wsdk/img?fileid=A*ME4GQq2j-5oAAAAAAAAAAAAAAQAAAQ&t=83fed12ef006ebcd8df04dfe79faad6c&bi=openpunsh&ts=0&zoom=original\"]" }, "replier_name" : { "type" : "string", "description" : "回复人名称", "example" : "刘*" }, "replier_role" : { "type" : "string", "description" : "用户：USER \t商家：MERCHANT\t系统：SYSTEM\t审核小二：AUDITOR\t政府单位：GOVERNMENT", "example" : "USER" } } }, "Role" : { "type" : "object", "properties" : { "ccs_instance_id" : { "type" : "string", "description" : "部门id（即租户实例ID、数据权限ID）", "example" : "ZPASFSCN" }, "create_time" : { "type" : "string", "description" : "创建时间", "example" : "2020-11-10 21:14:00" }, "creator_id" : { "type" : "string", "description" : "创建人id", "example" : "20184359929433" }, "description" : { "type" : "string", "description" : "角色描述描述", "example" : "这个角色是....." }, "function_ids" : { "type" : "array", "description" : "角色关联额功能点id", "items" : { "type" : "string" }, "example" : "[\"43511\",\"345343\"]" }, "id" : { "type" : "string", "description" : "角色id", "example" : "12" }, "name" : { "type" : "string", "description" : "角色名", "example" : "知识库管理员" }, "update_time" : { "type" : "string", "description" : "最后修改时间", "example" : "2020-11-10 21:20:00" }, "updater_id" : { "type" : "string", "description" : "最后修改人id", "example" : "20190443599294" } } }, "RoleId" : { "type" : "object", "properties" : { "ccs_instance_id" : { "type" : "string", "description" : "部门id（即租户实例ID、数据权限ID）" }, "role_id" : { "type" : "string", "description" : "角色ID" } } }, "RoyaltyDetail" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "分账金额", "example" : "10.00" }, "detail_id" : { "type" : "string", "description" : "支付宝分账明细单号，每笔分账业务执行的明细单号", "example" : "2023030610032004370215900000" }, "error_code" : { "type" : "string", "description" : "分账失败错误码，只在分账失败时返回", "example" : "TXN_RESULT_ACCOUNT_BALANCE_NOT_ENOUGH" }, "error_desc" : { "type" : "string", "description" : "分账错误描述信息", "example" : "分账余额不足" }, "execute_dt" : { "type" : "string", "description" : "分账执行时间", "example" : "2021-07-30 12:00:00" }, "operation_type" : { "type" : "string", "description" : "分账操作类型。有以下几种类型： replenish(补差)、replenish_refund(退补差)、transfer(分账)、transfer_refund(退分账)", "example" : "transfer" }, "state" : { "type" : "string", "description" : "分账状态，SUCCESS成功，FAIL失败，PROCESSING处理中", "example" : "FAIL" }, "trans_in" : { "type" : "string", "description" : "分账转入账号，只有在operation_type为replenish_refund(退补差)，transfer(分账)才返回该字段或trans_in_open_id。trans_in_open_id为分账转入方的openId，当trans_in_open_id不为空的时候，请优先使用trans_in_open_id。", "example" : "2088111111112222" }, "trans_in_open_id" : { "type" : "string", "description" : "分账转入方的OpenId，OpenId为用户在该应用下支付宝的唯一用户标识。", "example" : "095PJtAPYb2UkQ0mXk_X86Z_Pd7PtySKX-U3zUEwONcu3wc" }, "trans_in_type" : { "type" : "string", "description" : "分账转入账号类型，userId表示是支付宝账号对应的支付宝唯一用户号，loginName表示是支付宝登录号，secondMerchantID表示是二级商户id。\t只有在operation_type为replenish_refund(退补差)，transfer(分账)才返回该字段", "example" : "userId" }, "trans_out" : { "type" : "string", "description" : "分账转出账号，只有在operation_type为replenish(补差),transfer_refund(退分账)类型才返回该字段或trans_out_open_id字段。trans_out_open_id字段为分账转出方的openId，当trans_out_open_id 字段不为空时，请优先使用trans_out_open_id。", "example" : "2088111111111111" }, "trans_out_open_id" : { "type" : "string", "description" : "分账转出方的OpenId，OpenId为用户在该应用下支付宝内的唯一用户标识。", "example" : "095PJtAPYb2UkQ0mXk_X86Z_Pd7PtySKX-U3zUEwONcu3wc" }, "trans_out_type" : { "type" : "string", "description" : "分账转出账号类型，userId表示是支付宝账号对应的支付宝唯一用户号，loginName表示是支付宝登录号，secondMerchantID表示是二级商户id。\t只有在operation_type为replenish(补差)，transfer_refund(退分账)类型才返回该字段", "example" : "userId" } } }, "RoyaltyDetailInfo" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "分账金额，单位为元", "example" : "10.00" }, "desc" : { "type" : "string", "description" : "分账描述", "example" : "分账给2088101126708402" }, "trans_in_account_id" : { "type" : "string", "description" : "分账转入账户id。当分账账户id类型是cardSerialNo时，本参数为用户在支付宝绑定的卡编号；当分账账户id类型是userId时，本参数为用户的支付宝账号对应的支付宝唯一用户号；当分账账户id类型是loginName时，本参数为用户的支付宝登录号;当分账账户id类型是openId时，本参数为用户的在该应用下的支付宝OpenId; 当 trans_in_account_type 为defaultSettle时，本参数必须为空", "example" : "2088101126708402" }, "trans_in_account_id_type" : { "type" : "string", "description" : "分账转入账户id类型。 当trans_in_account_type 为bankCard时，本参数为cardSerialNo，表示分账账户id是银行卡编号; 当trans_in_account_type 为alipayBalance时，本参数为userId或者loginName或者openId，其中userId表示分账账户id是支付宝唯一用户号，loginName表示分账账户id是支付宝登录号，openId表示分账账户id是支付宝OpenId; 当 trans_in_account_type 为 defaultSettle 时，本参数必须为空。", "example" : "cardSerialNo" }, "trans_in_account_type" : { "type" : "string", "description" : "分账账户类型。 bankCard: 分账账户为银行卡； alipayBalance: 分账账户为支付宝余额户; defaultSettle: 按默认结算规则分账", "example" : "alipayBalance" }, "trans_in_entity_id" : { "type" : "string", "description" : "分账转出主体账 号。\r\t\r\t当分账转出主体类型为SecondMerchant，本参数为二级商户的SecondMerchantID\r\t\r\t当分账转出类型为Store，本参数为StoreID", "example" : "SecondMerchant" }, "trans_in_entity_type" : { "type" : "string", "description" : "分账转入主体类型。 SecondMerchant：分账转入主体为二级商户\r\t\r\tStore: 结算球房", "example" : "Store" }, "trans_in_sub_merchant" : { "$ref" : "#/components/schemas/SubMerchant" }, "trans_out_entity_id" : { "type" : "string", "description" : "分账转出主体账。\r\t\r\t当分账转出主体类型为SecondMerchant，本参数为二级商户的SecondMerchantId\r\t\r\t当分账转出类型为Store，本参数为StoreID", "example" : "2088" }, "trans_out_entity_type" : { "type" : "string", "description" : "分账转出主体类型。 SecondMerchant：结算主体为二级商户\r\t\r\tStore: 结算球房", "example" : "SecondMerchant" }, "trans_out_sub_merchant" : { "$ref" : "#/components/schemas/SubMerchant" } } }, "RoyaltyDetailInfos" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "分账的金额，单位为元" }, "amount_percentage" : { "type" : "string", "description" : "分账的比例，值为20代表按20%的比例分账" }, "batch_no" : { "type" : "string", "description" : "分账批次号\r\t分账批次号。\r\t目前需要和转入账号类型为bankIndex配合使用。" }, "desc" : { "type" : "string", "description" : "分账描述信息" }, "out_relation_id" : { "type" : "string", "description" : "商户分账的外部关联号，用于关联到每一笔分账信息，商户需保证其唯一性。\r\t如果为空，该值则默认为“商户网站唯一订单号+分账序列号”" }, "serial_no" : { "type" : "integer", "description" : "分账序列号，表示分账执行的顺序，必须为正整数" }, "trans_in" : { "type" : "string", "description" : "如果转入账号类型为userId，本参数为接受分账金额的支付宝账号对应的支付宝唯一用户号。以2088开头的纯16位数字。\r\t\t如果转入账号类型为bankIndex，本参数为28位的银行编号（商户和支付宝签约时确定）。\r\t如果转入账号类型为storeId，本参数为商户的球房ID。" }, "trans_in_type" : { "type" : "string", "description" : "接受分账金额的账户类型：\r\t\tuserId：支付宝账号对应的支付宝唯一用户号。\r\t\tbankIndex：分账到银行账户的银行编号。目前暂时只支持分账到一个银行编号。\r\tstoreId：分账到球房对应的银行卡编号。\r\t默认值为userId。" }, "trans_out" : { "type" : "string", "description" : "如果转出账号类型为userId，本参数为要分账的支付宝账号对应的支付宝唯一用户号。以2088开头的纯16位数字。" }, "trans_out_type" : { "type" : "string", "description" : "要分账的账户类型。\r\t目前只支持userId：支付宝账号对应的支付宝唯一用户号。\r\t默认值为userId。" } } }, "RoyaltyEntity" : { "type" : "object", "properties" : { "account" : { "type" : "string", "description" : "分账接收方账号。 当分账方类型是userId时，本参数为用户的支付宝账号对应的支付宝唯一用户号，以2088开头的纯16位数字； 当分账方类型是loginName时，本参数为用户的支付宝登录号；当分账方类型是openId时，本参数传递支付宝openId信息。" }, "account_open_id" : { "type" : "string", "description" : "分账接收方openId，本参数为分账接收方在该应用（AppId）下的唯一用户标识，仅用于分账关系查询接口出参。" }, "bind_login_name" : { "type" : "string", "description" : "作为查询返回结果：分账收款方绑定时的支付宝登录号。分账关系绑定（alipay.trade.royalty.relation.bind）时，通过type为loginName绑定传入的支付宝登录号，若使用userId绑定则不返回。" }, "login_name" : { "type" : "string", "description" : "作为查询返回结果：当前userId对应的支付宝登录号。当login_name与bind_login_name不相等时，表明该支付宝账户发生了登录号变更。" }, "memo" : { "type" : "string", "description" : "分账关系描述" }, "name" : { "type" : "string", "description" : "分账接收方真实姓名。\t绑定分账关系时：\t当分账方类型是userId时，本参数可以不传，若上传则进行校验不上传不会校验。\t当分账方类型是loginName时，本参数必传。\t解绑分账关系时：作为请求参数可不填，分账关系查询时不作为返回结果返回" }, "type" : { "type" : "string", "description" : "分账接收方方类型。 userId：表示是支付宝账号对应的支付宝唯一用户号；loginName：表示是支付宝登录号；openId：表示支付宝openId。" } } }, "RoyaltyInfo" : { "type" : "object", "properties" : { "royalty_detail_infos" : { "type" : "array", "description" : "分账明细的信息，可以描述多条分账指令，json数组。", "items" : { "$ref" : "#/components/schemas/RoyaltyDetailInfos" } }, "royalty_type" : { "type" : "string", "description" : "分账类型\r\t卖家的分账类型，目前只支持传入ROYALTY（普通分账类型）。" } } }, "Scene" : { "type" : "object", "properties" : { "scene_id" : { "type" : "string", "description" : "场景Id，最长32位，英文字母、数字以及下划线，开发者自定义", "example" : "1234" } } }, "SchoolBaseInfo" : { "type" : "object", "properties" : { "campus_info" : { "type" : "array", "description" : "校区信息", "items" : { "$ref" : "#/components/schemas/CampusInfo" } }, "city_code" : { "type" : "string", "description" : "城市编码", "example" : "620900" }, "inst_id" : { "type" : "string", "description" : "学校内标", "example" : "2088000151541822" }, "inst_name" : { "type" : "string", "description" : "学校名称", "example" : "复旦大学" }, "inst_std_code" : { "type" : "string", "description" : "学校外标", "example" : "12510181450882098Q" }, "province_code" : { "type" : "string", "description" : "省份编码", "example" : "370000" } } }, "SchoolSimpleInfo" : { "type" : "object", "properties" : { "campus_info" : { "$ref" : "#/components/schemas/CampusInfo" }, "city_code" : { "type" : "string", "description" : "城市编码", "example" : "620900" }, "inst_id" : { "type" : "string", "description" : "学校内标", "example" : "2088000151541822" }, "inst_name" : { "type" : "string", "description" : "学校名称", "example" : "复旦大学" }, "inst_std_code" : { "type" : "string", "description" : "学校外标", "example" : "12510181450882098Q" }, "province_code" : { "type" : "string", "description" : "省份编码", "example" : "370000" } } }, "SearchAbilityOrderData" : { "type" : "object", "properties" : { "access_type" : { "type" : "string", "description" : "申请单类型", "example" : "BRAND_BOX" }, "app_name" : { "type" : "string", "description" : "小程序名称", "example" : "小程序名称" }, "app_status" : { "type" : "string", "description" : "小程序状态 ON_LINE、OFF_LINE", "example" : "ON_LINE" }, "appid" : { "type" : "string", "description" : "小程序id", "example" : "2021001105612404" }, "apply_id" : { "type" : "string", "description" : "申请单id", "example" : "AP20200212100002488" }, "apply_type" : { "type" : "string", "description" : "申请类型 BASE：基础信息， BRAND_BOX：品牌直达，SERVICE_BOX服务直达", "example" : "BRAND_BOX" }, "audit_status" : { "type" : "string", "description" : "申请状态 AGREE、REJECT、EDIT、AUDIT", "example" : "AGREE" }, "biz_id" : { "type" : "string", "description" : "bizId 为品牌box的boxID", "example" : "C100038430_2019042421000001069599_FUNCTION" }, "box_status" : { "type" : "string", "description" : "品牌box的上下架状态 ONLINE OFFLINE", "example" : "ONLINE" }, "brand_template_id" : { "type" : "string", "description" : "品牌的模板id ONE_WITH_TWO：一拖二、DEFAULT：一拖四", "example" : "DEFAULT" }, "children" : { "type" : "array", "description" : "二级服务信息", "items" : { "$ref" : "#/components/schemas/SearchAbilityOrderInfoOpenApi" } }, "data_key" : { "type" : "string", "description" : "二级服务的唯一标识", "example" : "2019042421000001069599" }, "gmt_modified" : { "type" : "string", "description" : "更新时间", "example" : "2020-10-16 12:00:21" }, "id" : { "type" : "string", "description" : "服务的唯一标识（优先使用serviceCode可忽略）", "example" : "3131231" }, "is_old_data" : { "type" : "string", "description" : "是否是老工单", "example" : "false" }, "major_status" : { "type" : "string", "description" : "服务主状态,INITIAL:初始化；VALID：已生效；INVALID：已失效", "example" : "INITIAL" }, "online_time" : { "type" : "string", "description" : "上架时间", "example" : "2020-10-10 12:32:31" }, "open_status" : { "type" : "boolean", "description" : "服务的可见性状态", "example" : "true" }, "operator" : { "type" : "string", "description" : "下架操作者", "example" : "20881231231" }, "reject_reason" : { "type" : "string", "description" : "驳回原因", "example" : "驳回原因" }, "scene_code" : { "type" : "string", "description" : "场景码", "example" : "HOT_WORD_RANKING" }, "scene_name" : { "type" : "string", "description" : "场景名称", "example" : "场景名称" }, "service_code" : { "type" : "string", "description" : "服务码", "example" : "2019121121000102523089" }, "sub_service_desc" : { "type" : "string", "description" : "子功能描述", "example" : "子功能描述" }, "sub_service_name" : { "type" : "string", "description" : "子功能名称", "example" : "子功能名称" } } }, "SearchAbilityOrderInfoOpenApi" : { "type" : "object", "properties" : { "access_type" : { "type" : "string", "description" : "申请单类型", "example" : "BASE" }, "app_name" : { "type" : "string", "description" : "小程序名称", "example" : "搜索1" }, "app_status" : { "type" : "string", "description" : "小程序状态", "example" : "ON_LINE" }, "audit_status" : { "type" : "string", "description" : "审核状态", "example" : "AUDIT_PASS" }, "biz_id" : { "type" : "string", "description" : "运营申请单详情biz_id", "example" : "2021001105610428" }, "box_status" : { "type" : "string", "description" : "上架状态", "example" : "ONLINE" }, "brand_template_id" : { "type" : "string", "description" : "品牌模板id", "example" : "ONE_WITH_TWO" }, "data_key" : { "type" : "string", "description" : "二级服务唯一标识", "example" : "23232234" }, "gmt_modified" : { "type" : "string", "description" : "最近更新时间", "example" : "2020-12-11" }, "id" : { "type" : "string", "description" : "唯一id", "example" : "123424" }, "is_old_data" : { "type" : "boolean", "description" : "是否老工单", "example" : "false" }, "major_status" : { "type" : "string", "description" : "服务主状态", "example" : "VALID" }, "online_time" : { "type" : "string", "description" : "上架时间", "example" : "2020-11-12" }, "open_status" : { "type" : "boolean", "description" : "小程序可见性", "example" : "true" }, "operator" : { "type" : "string", "description" : "下架操作者", "example" : "232323" }, "reject_reason" : { "type" : "string", "description" : "驳回原因", "example" : "驳回原因" }, "scene_code" : { "type" : "string", "description" : "场景码", "example" : "sss" }, "scene_name" : { "type" : "string", "description" : "场景名称", "example" : "aaa" }, "search_app_id" : { "type" : "string", "description" : "小程序id", "example" : "2021001105610428" }, "sepc_code" : { "type" : "string", "description" : "应用标识", "example" : "SP_MINI_APP" }, "service_code" : { "type" : "string", "description" : "服务码", "example" : "234345454" }, "sub_service_desc" : { "type" : "string", "description" : "子功能描述", "example" : "111" }, "sub_service_name" : { "type" : "string", "description" : "子功能名称", "example" : "子功能" } } }, "SearchApplyPageQueryRequest" : { "type" : "object", "properties" : { "apply_type" : { "type" : "string", "description" : "申请类型 BASE：基础信息， BRAND_BOX：品牌直达，SERVICE_BOX服务直达", "example" : "BRAND_BOX" }, "audit_status_list" : { "type" : "array", "description" : "筛选状态数组 AUDIT AGREE REJECT CANCEL EDIT", "items" : { "type" : "string" }, "example" : "[\"AUDIT\",\"AGREE\"]" }, "category_code" : { "type" : "string", "description" : "类目编码", "example" : "2021001162676276" }, "name" : { "type" : "string", "description" : "服务名称", "example" : "服务名称" }, "page_num" : { "type" : "string", "description" : "当前页码", "example" : "10" }, "page_size" : { "type" : "string", "description" : "页面的显示记录条数", "example" : "3" }, "service_code" : { "type" : "string", "description" : "服务code", "example" : "2020062021000575859547" }, "service_id" : { "type" : "string", "description" : "小程序appid", "example" : "2020072301000006648885" }, "start_row" : { "type" : "string", "description" : "起始记录，起始：0", "example" : "1" }, "sub_service_code" : { "type" : "string", "description" : "二级服务code", "example" : "2020062021000575859547" } } }, "SearchBaseItems" : { "type" : "object", "properties" : { "can_search" : { "type" : "boolean", "description" : "搜索可见性", "example" : "true" }, "key_words" : { "type" : "array", "description" : "提报关键词列表", "items" : { "type" : "string" }, "example" : "[\"111\",\"222\",\"333\"]" } } }, "SearchBaseOrderCreateApiRequest" : { "type" : "object", "properties" : { "access_type" : { "type" : "string", "description" : "搜索直达类型 BASE：基础信息，只支持基础信息工单提报", "example" : "BASE" }, "appid" : { "type" : "string", "description" : "小程序Id", "example" : "2021001105612404" }, "base_items" : { "$ref" : "#/components/schemas/SearchBaseItems" }, "descprise" : { "type" : "string", "description" : "服务描述", "example" : "服务描述" }, "is_draft" : { "type" : "boolean", "description" : "是否为草稿态", "example" : "true" }, "order_id" : { "type" : "string", "description" : "申请单id，仅仅驳回或修改是传入", "example" : "AP20200212100002488" }, "spec_code" : { "type" : "string", "description" : "服务的类型 SP_MINI_APP 小程序 SP_PUBLIC_APP 生活号", "example" : "SP_MINI_APP" } } }, "SearchBoxAccountModule" : { "type" : "object", "properties" : { "app_infos" : { "type" : "array", "description" : "应用信息列表", "items" : { "$ref" : "#/components/schemas/SearchBoxAppInfo" } }, "module_id" : { "type" : "string", "description" : "模块ID", "example" : "20220308000000168465" }, "module_type" : { "type" : "string", "description" : "搜索直达模块类型，BOX_EXCLUSIVE_BASE-基础信息/BOX_EXCLUSIVE_KEYWORD-关键词/BOX_EXCLUSIVE_FUNCTIONS-功能服务/BOX_EXCLUSIVE_ACCOUNTS-关联账号/BOX_ATMOSPHERE_IMAGE-氛围图", "example" : "BOX_EXCLUSIVE_ACCOUNTS" } } }, "SearchBoxActivity" : { "type" : "object", "properties" : { "box_activity_id" : { "type" : "string", "description" : "活动id", "example" : "20211223000000100000" }, "box_id" : { "type" : "string", "description" : "搜索直达id", "example" : "20211130000000100415" }, "end_time" : { "type" : "string", "description" : "活动结束时间", "example" : "2022-09-30 23:59:59" }, "fail_reason" : { "type" : "string", "description" : "审核失败原因", "example" : "品牌触发词必须完整包含品牌名称且不得使用泛词，建议调整。" }, "material_type" : { "type" : "string", "description" : "IMAGE-图片/VIDEO-视频", "example" : "IMAGE" }, "material_url" : { "type" : "string", "description" : "当material_type=\"IMAGE\"时，为图片url；当material_type=\"VIDEO\"时，为视频url", "example" : "http://mdn.alipayobjects.com/mrch_spc/afts/img/A*0XA2Qo_omj4AAAAAAAAAAAAADsF1AQ/original" }, "run_status" : { "type" : "string", "description" : "运行状态，INITIAL-初始，ONLINE-已上架，EXPIRE-已失效，OFFLINE-已下架", "example" : "ONLINE" }, "start_time" : { "type" : "string", "description" : "活动开始时间", "example" : "2022-02-10 08:00:00" }, "status" : { "type" : "string", "description" : "配置状态，INITIAL-初始/AUDIT-审核中/CANCEL-已取消/ONLINE-已上架/REJECT-驳回/OFFLINE-已下架/EXPIRE-已失效", "example" : "ONLINE" }, "target_appid" : { "type" : "string", "description" : "跳转应用ID", "example" : "2021001191699651" }, "target_appname" : { "type" : "string", "description" : "目标小程序名称", "example" : "目标小程序名称" }, "target_regions" : { "type" : "array", "description" : "投放目标区域", "items" : { "$ref" : "#/components/schemas/DeliveryTargetRegion" } }, "title" : { "type" : "string", "description" : "活动标题", "example" : "活动标题" }, "video_info" : { "$ref" : "#/components/schemas/SearchBoxActivityVideoInfo" } } }, "SearchBoxActivityVideoInfo" : { "type" : "object", "properties" : { "video_btn_text" : { "type" : "string", "description" : "视频按钮文案，2-4个汉字" }, "video_coverimg_id" : { "type" : "string", "description" : "视频封面图片id，图片id可以通过调用接口alipay.open.file.upload上传图片，获取图片id(bizCode：search_box_videocover)。 图片规范 " }, "video_sub_title" : { "type" : "string", "description" : "视频副标题，2-16个汉字" }, "video_title" : { "type" : "string", "description" : "视频主标题，2-10个汉字" } } }, "SearchBoxAppInfo" : { "type" : "object", "properties" : { "app_name" : { "type" : "string", "description" : "应用名称" }, "app_type" : { "type" : "string", "description" : "应用类型，TINY_APP-小程序/PUBLIC_APP-生活号/SHOP_APP-球房应用" }, "relate_appid" : { "type" : "string", "description" : "应用ID" } } }, "SearchBoxAreaKeyWordModule" : { "type" : "object", "properties" : { "latest_audit_area_keyword_info" : { "$ref" : "#/components/schemas/SearchBoxKeywordInfo" }, "module_id" : { "type" : "string", "description" : "模块id", "example" : "20220308000000168465" }, "module_type" : { "type" : "string", "description" : "搜索直达模块类型，BOX_EXCLUSIVE_BASE-基础信息/BOX_EXCLUSIVE_KEYWORD-关键词/BOX_EXCLUSIVE_FUNCTIONS-功能服务/BOX_EXCLUSIVE_ACCOUNTS-关联账号/BOX_ATMOSPHERE_IMAGE-氛围图", "example" : "BOX_EXCLUSIVE_AREA_KEYWORD" }, "valid_area_keyword_info" : { "$ref" : "#/components/schemas/SearchBoxKeywordInfo" } } }, "SearchBoxBasicInfo" : { "type" : "object", "properties" : { "box_id" : { "type" : "string", "description" : "搜索直达配置id", "example" : "20220117000000112680" }, "brand_id" : { "type" : "string", "description" : "品牌id", "example" : "1000467882" }, "name" : { "type" : "string", "description" : "搜索直达名称", "example" : "搜索直达名称" }, "status" : { "type" : "string", "description" : "搜索直达配置状态，INITIAL-初始/ONLINE-已上架/EXPIRE-已失效/OFFLINE-已下架", "example" : "ONLINE" }, "target_appid" : { "type" : "string", "description" : "小程序id", "example" : "2018092561507369" } } }, "SearchBoxBasicInfoModule" : { "type" : "object", "properties" : { "apply_no" : { "type" : "string", "description" : "申请单号", "example" : "2022010700503000000000487728" }, "box_desc" : { "type" : "string", "description" : "介绍，已生效的数据", "example" : "品牌介绍" }, "fail_reason" : { "type" : "string", "description" : "审核失败原因", "example" : "品牌触发词必须完整包含品牌名称且不得使用泛词，建议调整。" }, "gmt_modified" : { "type" : "string", "description" : "修改时间", "example" : "2022-01-07 18:22:04" }, "latest_audit_box_desc" : { "type" : "string", "description" : "介绍，最近一次审核内容", "example" : "品牌介绍" }, "module_id" : { "type" : "string", "description" : "模块配置ID", "example" : "20220308000000168465" }, "module_type" : { "type" : "string", "description" : "搜索直达模块类型，BOX_EXCLUSIVE_BASE-基础信息/BOX_EXCLUSIVE_KEYWORD-关键词/BOX_EXCLUSIVE_FUNCTIONS-功能服务/BOX_EXCLUSIVE_ACCOUNTS-关联账号/BOX_ATMOSPHERE_IMAGE-氛围图", "example" : "BOX_EXCLUSIVE_BASE" }, "status" : { "type" : "string", "description" : "状态，INITIAL-初始/AUDIT-审核中/CANCEL-已取消/ONLINE-已上架/REJECT-驳回/OFFLINE-已下架/EXPIRE-已失效", "example" : "AUDIT" } } }, "SearchBoxImageModule" : { "type" : "object", "properties" : { "apply_no" : { "type" : "string", "description" : "申请单号" }, "fail_reason" : { "type" : "string", "description" : "审核失败原因" }, "gmt_modified" : { "type" : "string", "description" : "修改时间" }, "module_id" : { "type" : "string", "description" : "模块ID" }, "module_type" : { "type" : "string", "description" : "搜索直达模块类型，BOX_EXCLUSIVE_BASE-基础信息/BOX_EXCLUSIVE_KEYWORD-关键词/BOX_EXCLUSIVE_FUNCTIONS-功能服务/BOX_EXCLUSIVE_ACCOUNTS-关联账号/BOX_ATMOSPHERE_IMAGE-氛围图" }, "status" : { "type" : "string", "description" : "状态，INITIAL-初始/AUDIT-审核中/CANCEL-已取消/ONLINE-已上架/REJECT-驳回/OFFLINE-已下架/EXPIRE-已失效" } } }, "SearchBoxKeyWordModule" : { "type" : "object", "properties" : { "apply_no" : { "type" : "string", "description" : "申请单号", "example" : "2022010700503000000000487728" }, "fail_reason" : { "type" : "string", "description" : "审核失败原因", "example" : "品牌触发词必须完整包含品牌名称且不得使用泛词，建议调整。" }, "gmt_modified" : { "type" : "string", "description" : "修改时间", "example" : "2022-01-07 18:22:04" }, "keywords" : { "type" : "array", "description" : "自定义触发词(生效中)", "items" : { "type" : "string" }, "example" : "[\"自定义触发词\"]" }, "latest_audit_keywords" : { "type" : "array", "description" : "自定义触发词(最近一次审核内容)", "items" : { "type" : "string" }, "example" : "[\"自定义触发词\"]" }, "module_id" : { "type" : "string", "description" : "模块配置ID", "example" : "20220308000000168465" }, "module_type" : { "type" : "string", "description" : "搜索直达模块类型，BOX_EXCLUSIVE_BASE-基础信息/BOX_EXCLUSIVE_KEYWORD-关键词/BOX_EXCLUSIVE_FUNCTIONS-功能服务/BOX_EXCLUSIVE_ACCOUNTS-关联账号/BOX_ATMOSPHERE_IMAGE-氛围图", "example" : "BOX_EXCLUSIVE_KEYWORD" }, "status" : { "type" : "string", "description" : "状态，INITIAL-初始/AUDIT-审核中/CANCEL-已取消/ONLINE-已上架/REJECT-驳回/OFFLINE-已下架/EXPIRE-已失效", "example" : "ONLINE" } } }, "SearchBoxKeywordInfo" : { "type" : "object", "properties" : { "apply_no" : { "type" : "string", "description" : "申请单号" }, "fail_reason" : { "type" : "string", "description" : "审核失败原因" }, "gmt_modified" : { "type" : "string", "description" : "修改时间" }, "keywords" : { "type" : "array", "description" : "关键词", "items" : { "type" : "string" } }, "module_id" : { "type" : "string", "description" : "模块ID" }, "status" : { "type" : "string", "description" : "ONLINE--上架\tREJECT--驳回\tOFFLINE-已下架" } } }, "SearchBoxServiceInfo" : { "type" : "object", "properties" : { "service_category_code" : { "type" : "string", "description" : "服务类目编码" }, "service_category_name" : { "type" : "string", "description" : "服务类目名称" }, "service_code" : { "type" : "string", "description" : "服务编码" }, "service_name" : { "type" : "string", "description" : "服务名称" } } }, "SearchBoxServiceModule" : { "type" : "object", "properties" : { "module_id" : { "type" : "string", "description" : "模块ID", "example" : "20220308000000168465" }, "module_type" : { "type" : "string", "description" : "搜索直达模块类型，BOX_EXCLUSIVE_BASE-基础信息/BOX_EXCLUSIVE_KEYWORD-关键词/BOX_EXCLUSIVE_FUNCTIONS-功能服务/BOX_EXCLUSIVE_ACCOUNTS-关联账号/BOX_ATMOSPHERE_IMAGE-氛围图", "example" : "BOX_EXCLUSIVE_FUNCTIONS" }, "service_infos" : { "type" : "array", "description" : "服务信息列表", "items" : { "$ref" : "#/components/schemas/SearchBoxServiceInfo" } } } }, "SearchOperPageQueryRequest" : { "type" : "object", "properties" : { "access_type" : { "type" : "string", "description" : "申请类型 BASE：基础信息， BRAND_BOX：品牌直达，SERVICE_BOX服务直达", "example" : "BRAND_BOX" }, "appid" : { "type" : "string", "description" : "小程序ID", "example" : "2021001105612404" }, "page_num" : { "type" : "string", "description" : "当前页", "example" : "1" }, "page_size" : { "type" : "string", "description" : "每页显示条数", "example" : "2" }, "scene_code" : { "type" : "string", "description" : "场景码", "example" : "HOT_WORD_RANKING" }, "spec_code" : { "type" : "string", "description" : "服务类型 SP_MINI_APP 小程序 SP_PUBLIC_APP 生活号", "example" : "SP_MINI_APP" } } }, "SearchOrderBrandDetail" : { "type" : "object", "properties" : { "brand_detail" : { "$ref" : "#/components/schemas/BrandDetail" }, "key" : { "type" : "string", "description" : "工单详情key值", "example" : "425d8560-35da-11eb-9de8-217f5d8e3c76" } } }, "SearchOrderDetailData" : { "type" : "object", "properties" : { "access_type" : { "type" : "string", "description" : "申请单类型 BASE：基础信息， BRAND_BOX：品牌直达，SERVICE_BOX服务直达", "example" : "BASE" }, "app_category" : { "type" : "string", "description" : "小程序类目名", "example" : "旅行住宿_国际货运代理和报关行" }, "app_icon" : { "type" : "string", "description" : "小程序图标", "example" : "http://appstoreisvpic.alipayobjects.com/dev/bec7d11f-bb62-4abf-9a75-0d10407b4ed8.png" }, "app_name" : { "type" : "string", "description" : "小程序名称", "example" : "小程序名称" }, "app_status" : { "type" : "string", "description" : "小程序状态", "example" : "ON_LINE" }, "appid" : { "type" : "string", "description" : "小程序ID", "example" : "2014060600164699" }, "base_order_status" : { "$ref" : "#/components/schemas/OrderStatusData" }, "biz_id" : { "type" : "string", "description" : "bizid 业务id", "example" : "765432123456" }, "box_order_status" : { "$ref" : "#/components/schemas/OrderStatusData" }, "box_status" : { "type" : "string", "description" : "上下架状态 ONLINE OFFLINE", "example" : "ONLINE" }, "brand_template_id" : { "type" : "string", "description" : "品牌的模板id ONE_WITH_TWO：一拖二、DEFAULT：一拖四", "example" : "DEFAULT" }, "brandbox_orderstatus" : { "$ref" : "#/components/schemas/OrderStatusData" }, "can_modify_keyword" : { "type" : "boolean", "description" : "是否可修改关键词", "example" : "true" }, "describe" : { "type" : "string", "description" : "服务描述", "example" : "搜索提报测试小程序3" }, "detail_base_items" : { "$ref" : "#/components/schemas/SearchOrderDetailDataBaseItems" }, "detail_brand_items" : { "$ref" : "#/components/schemas/SearchOrderDetailDataBrandItems" }, "detail_service_items" : { "$ref" : "#/components/schemas/SearchOrderDetailDataServiceItems" }, "final_status" : { "type" : "string", "description" : "最终状态", "example" : "AGREE" }, "gmtmodified" : { "type" : "string", "description" : "最后修改时间", "example" : "2020-10-15 11:34:23" }, "keyword_gmt_modified" : { "type" : "string", "description" : "关键词的修改时间", "example" : "2020-10-14 14:25:50" }, "online_time" : { "type" : "string", "description" : "上架时间", "example" : "2020-10-15 11:34:23" }, "operator_type" : { "type" : "string", "description" : "操作人员类型", "example" : "操作人员类型" }, "order_id" : { "type" : "string", "description" : "申请单id", "example" : "AP2020101501254498" }, "partner_type" : { "type" : "string", "description" : "查询服务提供者生态类型 一二三方 1 | 2 | 3", "example" : "1" }, "reject_node" : { "type" : "string", "description" : "驳回节点", "example" : "驳回节点" }, "reject_reason" : { "type" : "string", "description" : "驳回原因", "example" : "驳回原因" }, "scene_code" : { "type" : "string", "description" : "场景码", "example" : "HOT_WORD_RANKING" }, "scene_name" : { "type" : "string", "description" : "场景名称", "example" : "场景名称" }, "service_code" : { "type" : "string", "description" : "服务code", "example" : "2019121121000102523089" }, "service_name" : { "type" : "string", "description" : "服务名", "example" : "服务名" }, "status" : { "type" : "string", "description" : "申请单状态 AGREE、REJECT、AUDIT", "example" : "AUDIT" }, "sub_service_code" : { "type" : "string", "description" : "二级服务code", "example" : "2019121121000102523089" }, "template_id" : { "type" : "string", "description" : "模板Id", "example" : "WALLET-SEARCH@boxFunctionCommon" }, "template_name" : { "type" : "string", "description" : "模板名称", "example" : "二级服务菜单直达" } } }, "SearchOrderDetailDataBaseItems" : { "type" : "object", "properties" : { "can_search" : { "type" : "string", "description" : "搜索可见性", "example" : "true" }, "desc" : { "type" : "string", "description" : "描述信息", "example" : "描述信息" }, "img" : { "type" : "string", "description" : "img地址", "example" : "https://appstoreisvpic.alipayobjects.com/prod/37945fc8-d09b-4b3a-a472-4673c55e9dc9.png" }, "key_word" : { "type" : "string", "description" : "关键词", "example" : "测试" }, "name" : { "type" : "string", "description" : "应用名称", "example" : "测试1" }, "region" : { "type" : "string", "description" : "基础工单详情region", "example" : "0" }, "serv_can_search" : { "type" : "string", "description" : "搜索可见性", "example" : "true" }, "serv_search_keywords" : { "type" : "string", "description" : "搜索关键词", "example" : "搜索" }, "template_id" : { "type" : "string", "description" : "模板id", "example" : "WALLET-SEARCH@boxFunctionCommon" }, "url" : { "type" : "string", "description" : "跳转url链接", "example" : "https://appstoreisvpic.alipayobjects.com/prod" } } }, "SearchOrderDetailDataBrandItems" : { "type" : "object", "properties" : { "biz_id" : { "type" : "string", "description" : "工单详情bizid", "example" : "C100038430_2020081121000352488483_FUNCTION" }, "box_status" : { "type" : "string", "description" : "上下架状态", "example" : "ONLINE" }, "brand_box_keywords" : { "type" : "string", "description" : "关键词信息", "example" : "烟草" }, "brand_detail_list" : { "type" : "array", "description" : "工单详情数据信息", "items" : { "$ref" : "#/components/schemas/SearchOrderBrandDetail" } }, "brand_template_id" : { "type" : "string", "description" : "品牌展示模板类型", "example" : "ONE_WITH_TWO" }, "channel" : { "type" : "string", "description" : "工单详情数据channel", "example" : "OPENINSIGHT" }, "merchant_type" : { "type" : "string", "description" : "工单详情数据merchant_type", "example" : "GENERAL" }, "template_id" : { "type" : "string", "description" : "模板id", "example" : "WALLET-SEARCH@boxContent" } } }, "SearchOrderDetailDataServiceItems" : { "type" : "object", "properties" : { "area_codes" : { "type" : "string", "description" : "服务工单详情area_codes", "example" : "1" }, "carrier_code" : { "type" : "string", "description" : "carrier_code", "example" : "2019021863152020" }, "carrier_list" : { "type" : "string", "description" : "服务工单数据carrier_list", "example" : "111" }, "category_attribute_value" : { "type" : "string", "description" : "服务工单category_attribute_value", "example" : "111" }, "category_code" : { "type" : "string", "description" : "类目id", "example" : "C100038432" }, "category_ids" : { "type" : "string", "description" : "类目id", "example" : "XS3120" }, "channel_type" : { "type" : "string", "description" : "渠道类型", "example" : "MERCHANT_SELF_MANAGE_MINI_APP" }, "desc" : { "type" : "string", "description" : "描述", "example" : "描述" }, "img" : { "type" : "string", "description" : "img地址", "example" : "https://mdn.alipayobjects.com/openpt_appstore/afts/img/A*1o71SaApF5YAAAAAAAAAAAAAATcnAQ/original" }, "key_word" : { "type" : "string", "description" : "关键词", "example" : "关键词" }, "key_word_list" : { "type" : "string", "description" : "关键词列表", "example" : "测试" }, "logo" : { "type" : "string", "description" : "logo图片地址", "example" : "https://mdn.alipayobjects.com/openpt_appstore/afts/img/A*1o71SaApF5YAAAAAAAAAAAAAATcnAQ/original" }, "name" : { "type" : "string", "description" : "应用名称", "example" : "应用名称" }, "parent_service_code" : { "type" : "string", "description" : "服务编码", "example" : "2019041721000201048200" }, "region" : { "type" : "string", "description" : "服务工单详情region", "example" : "1" }, "serv_search_catalogs" : { "type" : "string", "description" : "serv_search_catalogs", "example" : "C100038432" }, "serv_search_keywords" : { "type" : "string", "description" : "关键词", "example" : "关键词" }, "service_code" : { "type" : "string", "description" : "2020112321000021082348", "example" : "服务码" }, "service_name" : { "type" : "string", "description" : "服务名称", "example" : "测试1" }, "service_time_end" : { "type" : "string", "description" : "服务结束时间", "example" : "23:59:59" }, "service_time_start" : { "type" : "string", "description" : "服务开始时间", "example" : "00:00:00" }, "short_desc" : { "type" : "string", "description" : "服务短描述", "example" : "服务短描述" }, "spec_code" : { "type" : "string", "description" : "应用标识", "example" : "SP_SEARCH_SERVICE" }, "template_id" : { "type" : "string", "description" : "模板id", "example" : "WALLET-SEARCH@boxFunctionCommon" } } }, "SearchOrderRequest" : { "type" : "object", "properties" : { "apply_id" : { "type" : "string", "description" : "申请单id", "example" : "AP20200212100002488" }, "apply_type" : { "type" : "string", "description" : "申请类型 BASE：基础信息， BRAND_BOX：品牌直达，SERVICE_BOX服务直达", "example" : "BASE" }, "brand_template_id" : { "type" : "string", "description" : "品牌的模板id ONE_WITH_TWO：一拖二、DEFAULT：一拖四", "example" : "DEFAULT" }, "service_code" : { "type" : "string", "description" : "服务code", "example" : "2019121121000102523089" }, "spec_code" : { "type" : "string", "description" : "服务的类型默认使用小程序 SP_MINI_APP 小程序 SP_PUBLIC_APP 生活号", "example" : "SP_MINI_APP" } } }, "SearchPartAgreeInfo" : { "type" : "object", "properties" : { "audit_info" : { "type" : "string", "description" : "剔除数据名称", "example" : "单车" }, "audit_operator" : { "type" : "string", "description" : "剔除数据的operator信息", "example" : "liming" }, "audit_reason" : { "type" : "string", "description" : "剔除原因", "example" : "剔除原因" }, "audit_type" : { "type" : "string", "description" : "剔除数据类型", "example" : "aaa" } } }, "SeatInfo" : { "type" : "object", "properties" : { "seat_class" : { "type" : "string", "description" : "座位等级", "example" : "一等座" }, "seat_no" : { "type" : "string", "description" : "座位号", "example" : "12车12D" } } }, "SendRule" : { "type" : "object", "properties" : { "allow_repeat_send" : { "type" : "string", "description" : "是否允许重复发奖：\r\ttrue代表允许，false代表不允许\r\t默认不设置，表明用户领取券后如果没有核销则不允许再次领取券\r\t如果设置为true，表明如果用户领取券后没有核销，还可以继续领取该券（只有配置publish_channels中type为URL_WITH_TOKEN外部发券时，该字段生效）", "example" : "true" }, "min_cost" : { "type" : "string", "description" : "发券最低消费金额，单位元\r\t活动类型为消费送且不是消费送礼包时设置\r\t多营销工具之间不允许设置重复值", "example" : "100" }, "send_budget" : { "type" : "string", "description" : "券的预算数量（仅对口令送随机抽奖有效，即当活动类型为GUESS_SEND，且营销工具PromoTool的个数大于1时，此字段必填，其余情况此字段必为空）", "example" : "1234" }, "send_num" : { "type" : "string", "description" : "发券数目\r\t最少发1张券，最多发5张券", "example" : "1" } } }, "SenderIstd" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "地址(街道、小区、大厦等，用于定位)" }, "address_detail" : { "type" : "string", "description" : "地址详情(楼号、单元号、层号)" }, "city" : { "type" : "string", "description" : "城市名称，如杭州市" }, "coordinate_type" : { "type" : "integer", "description" : "坐标类型，0：火星坐标（高德，腾讯地图均采用火星坐标） 1:百度坐标， 目前只支持0" }, "lat" : { "type" : "string", "description" : "纬度" }, "lng" : { "type" : "string", "description" : "经度" }, "mobile_no" : { "type" : "string", "description" : "手机号" }, "name" : { "type" : "string", "description" : "姓名" } } }, "ServiceCodeIstd" : { "type" : "object", "properties" : { "service_code" : { "type" : "string", "description" : "即时配送公司服务代码", "example" : "fengniao01" } } }, "ServiceRecordCatRequest" : { "type" : "object", "properties" : { "cat_name" : { "type" : "string", "description" : "类目名称(需要每一级用;分隔封装)" }, "first_cat" : { "type" : "string", "description" : "一级类目编码" }, "fourth_cat" : { "type" : "string", "description" : "四级类目编码" }, "instence_code" : { "type" : "string", "description" : "类目树编码" }, "second_cat" : { "type" : "string", "description" : "二级类目编码" }, "third_cat" : { "type" : "string", "description" : "三级类目编码" } } }, "SettleCardInfo" : { "type" : "object", "properties" : { "account_branch_name" : { "type" : "string", "description" : "开户支行名" }, "account_holder_name" : { "type" : "string", "description" : "卡户名" }, "account_inst_city" : { "type" : "string", "description" : "开户行所在地-市" }, "account_inst_id" : { "type" : "string", "description" : "开户行简称缩写" }, "account_inst_name" : { "type" : "string", "description" : "银行名称" }, "account_inst_province" : { "type" : "string", "description" : "开户行所在地-省" }, "account_no" : { "type" : "string", "description" : "银行卡号" }, "account_type" : { "type" : "string", "description" : "卡类型\r\t借记卡-DC\r\t信用卡-CC" }, "bank_code" : { "type" : "string", "description" : "联行号" }, "usage_type" : { "type" : "string", "description" : "账号使用类型\r\t对公-01\r\t对私-02" } } }, "SettleClause" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "结算金额，单位为元", "example" : "0.1" }, "currency" : { "type" : "string", "description" : "结算币种，支持人民币：CNY", "example" : "CNY" }, "settle_account_entity" : { "type" : "string", "description" : "结算账号所属于的结算主体类型。\tsecondMerchant 二级商户的结算账号\tstore 球房的结算账号\t如果不填，默认为settleEntityType对应的类型", "example" : "secondMerchant" }, "settle_account_id" : { "type" : "string", "description" : "结算账户id。\t\t当结算账户id类型是cardSerialNo时，本参数为用户在支付宝绑定的卡编号；当结算账户id类型是userId时，本参数为用户的支付宝账号对应的支付宝唯一用户号；当结算账户id类型是loginName时，本参数为用户的支付宝登录号; 当 settle_account_type 为defaultSettle时，本参数必须为空", "example" : "15912345678" }, "settle_account_id_type" : { "type" : "string", "description" : "结算账户id类型。 \t当settle_account_type 为bankCard时，本参数为cardSerialNo，表示结算账户id是银行卡编号; 当settle_account_type 为alipayBalance时，本参数为userId或者loginName，其中userId表示结算账户id是支付宝唯一用户号，loginName表示结算账户id是支付宝登录号; 当 settle_account_type 为 defaultSettle 时，本参数必须为空", "example" : "loginName" }, "settle_account_type" : { "type" : "string", "description" : "结算账户类型。\t\tbankCard: 结算账户为银行卡；\talipayBalance: 结算账户为支付宝余额户；\tdefaultSettle: 按默认结算规则结算", "example" : "alipayBalance" }, "settle_entity_id" : { "type" : "string", "description" : "结算主体账号。\r\t当结算主体类型为SecondMerchant，本参数为二级商户的SecondMerchantID", "example" : "19023454" }, "settle_entity_type" : { "type" : "string", "description" : "结算主体类型。\r\tSecondMerchant：结算主体为二级商户", "example" : "SecondMerchant" }, "sub_merchant" : { "$ref" : "#/components/schemas/SubMerchant" } } }, "SettleConfirmExtendParams" : { "type" : "object", "properties" : { "royalty_freeze" : { "type" : "string", "description" : "是否进行资金冻结，用于后续分账，true表示冻结，false或不传表示不冻结", "example" : "true" } } }, "SettleDetailInfo" : { "type" : "object", "properties" : { "actual_amount" : { "type" : "string", "description" : "仅在直付通账期模式下，当一笔交易需要分多次发起部分确认结算时使用，表示本次确认结算的实际结算金额。传递本字段后，原amount字段不再生效，结算金额以本字段为准。如已经发生过部分确认结算、不传递本字段则默认按剩余待结算金额一次性结算。" }, "amount" : { "type" : "string", "description" : "结算的金额，单位为元。在创建订单和支付接口时必须和交易金额相同。在结算确认接口时必须等于交易金额减去已退款金额。直付通账期模式下，如使用部分结算能力、传递了actual_amount字段，则忽略本字段的校验、可不传。" }, "settle_entity_id" : { "type" : "string", "description" : "结算主体标识。当结算主体类型为SecondMerchant时，为二级商户的SecondMerchantID；当结算主体类型为Store时，为球房的外标。" }, "settle_entity_type" : { "type" : "string", "description" : "结算主体类型。\r\t二级商户:SecondMerchant;商户或者直连商户球房:Store" }, "summary_dimension" : { "type" : "string", "description" : "结算汇总维度，按照这个维度汇总成批次结算，由商户指定。\t\t目前需要和结算收款方账户类型为cardAliasNo配合使用" }, "trans_in" : { "type" : "string", "description" : "结算收款方。当结算收款方类型是cardAliasNo时，本参数为用户在支付宝绑定的卡编号；结算收款方类型是userId时，本参数为用户的支付宝账号对应的支付宝唯一用户号，以2088开头的纯16位数字；当结算收款方类型是loginName时，本参数为用户的支付宝登录号；当结算收款方类型是defaultSettle时，本参数不能传值，保持为空。" }, "trans_in_type" : { "type" : "string", "description" : "结算收款方的账户类型。\t\tcardAliasNo：结算收款方的银行卡编号;\tuserId：表示是支付宝账号对应的支付宝唯一用户号;\tloginName：表示是支付宝登录号；\tdefaultSettle：表示结算到商户进件时设置的默认结算账号，结算主体为球房时不支持传defaultSettle；" } } }, "SettleEntity" : { "type" : "object", "properties" : { "settle_entity_id" : { "type" : "string", "description" : "结算主体账号\t当结算主体类型为SecondMerchant，本参数为二级商户的SecondMerchantID；当结算主体类型为MerchantStore，本参数为商户球房ID。", "example" : "19023454" }, "settle_entity_type" : { "type" : "string", "description" : "结算主体类型\tSecondMerchant：结算主体为二级商户；MerchantStore：结算主体为商户球房", "example" : "SecondMerchant" } } }, "SettleExtendParams" : { "type" : "object", "properties" : { "royalty_finish" : { "type" : "string", "description" : "冻结分账场景下生效，其他场景传入无效。\t代表该交易分账是否完结，可选值：true/false，不传默认为false。\ttrue：代表分账完结，则本次分账处理完成后会把该笔交易的剩余冻结金额全额解冻。\tfalse：代表分账未完结。", "example" : "true" } } }, "SettleExtraParams" : { "type" : "object", "properties" : { "quit_type" : { "type" : "string", "description" : "quit_type为USER_CANCEL_QUIT或者SETTLE_APPLY_QUIT", "example" : "SETTLE_APPLY_QUIT" }, "settle_adjust_reason" : { "type" : "string", "description" : "action_type选择PAY_TO_ZERO时必填，\t\"SERVICE_CANCELED\":\"服务已取消\",\t\"OTHER_CHANNEL_PERFORMANCE\":\"户已通过其他方式履约\"", "example" : "SERVICE_CANCELED或OTHER_CHANNEL_PERFORMANCE" } } }, "SettleInfo" : { "type" : "object", "properties" : { "settle_detail_infos" : { "type" : "array", "description" : "结算详细信息，json数组，目前只支持一条。", "items" : { "$ref" : "#/components/schemas/SettleDetailInfo" } }, "settle_period_time" : { "type" : "string", "description" : "该笔订单的超期自动确认结算时间，到达期限后，将自动确认结算。此字段只在签约账期结算模式时有效。取值范围：1d～365d。d-天。 该参数数值不接受小数点。" } } }, "ShopBusinessTime" : { "type" : "object", "properties" : { "close_time" : { "type" : "string", "description" : "关门时间 格式：HH:mm" }, "open_time" : { "type" : "string", "description" : "开门时间 格式：HH:mm" }, "week_day" : { "type" : "integer", "description" : "本对象表示周几的营业时间。1~6表示周一到周六，7表示周日" } } }, "ShopCategoryConfigInfo" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "类目ID", "example" : "2016031800159500" }, "is_leaf" : { "type" : "string", "description" : "是否是叶子节点", "example" : "true" }, "level" : { "type" : "string", "description" : "类目层级", "example" : "3" }, "link" : { "type" : "string", "description" : "类目层级路径", "example" : "美食-中餐-淮扬菜" }, "nm" : { "type" : "string", "description" : "类目名称", "example" : "淮扬菜" } } }, "ShopCategoryInfo" : { "type" : "object", "properties" : { "category_id" : { "type" : "string", "description" : "类目编号", "example" : "2015050700000018" }, "category_level" : { "type" : "string", "description" : "类目层级,目前最多支持1、2、3三级", "example" : "2" }, "category_name" : { "type" : "string", "description" : "类目名称", "example" : "美食" } } }, "ShopCommentInfo" : { "type" : "object", "properties" : { "avg_popularity" : { "type" : "string", "description" : "店铺30天平均人气值", "example" : "76" }, "avg_popularity_name" : { "type" : "string", "description" : "avg_popularity字段展示文案", "example" : "口碑人气" }, "score" : { "type" : "string", "description" : "球房评分，评分越高，球房质量越高", "example" : "3.2" }, "star" : { "type" : "string", "description" : "球房星级，0~5,越高，店铺质量越高", "example" : "4.0" } } }, "ShopExtInfo" : { "type" : "object", "properties" : { "key_name" : { "type" : "string", "description" : "KV数据对的key，表示该kv对象表示什么含义。" }, "value" : { "type" : "string", "description" : "kv对象的值" } } }, "ShopQueryOpenApiVO" : { "type" : "object", "properties" : { "business_address" : { "$ref" : "#/components/schemas/AddressInfo" }, "business_time" : { "type" : "array", "description" : "店铺经营时间", "items" : { "$ref" : "#/components/schemas/ShopBusinessTime" } }, "contact_mobile" : { "type" : "string", "description" : "店铺联系手机", "example" : "13901390139" }, "contact_phone" : { "type" : "string", "description" : "店铺的联系固话", "example" : "010-62286228" }, "new_shop_category" : { "type" : "string", "description" : "新版球房类目标准二级类目code。类目标准及与原shop_category映射关系参见文档https://gw.alipayobjects.com/os/bmw-prod/4b3f82df-e53e-4b84-bc41-fe025101e726.xlsx", "example" : "B0001" }, "shop_category" : { "type" : "string", "description" : "店铺类目，取值参见文件https://mif-pub.alipayobjects.com/ShopCategory.xlsx 中的三级球房类目", "example" : "1001" }, "shop_id" : { "type" : "string", "description" : "蚂蚁店铺id", "example" : "2018011900502000000005124744" }, "shop_info_status" : { "type" : "string", "description" : "当前名称、地址、经纬度信息准确一致，可用于数字化经营场景消费（01=已认证,02=待优化,03=审核中,99=未知）", "example" : "01" }, "shop_name" : { "type" : "string", "description" : "店铺名称", "example" : "肯德基中关村店" }, "shop_status" : { "type" : "string", "description" : "球房状态，01正常，03冻结", "example" : "01" }, "shop_type" : { "type" : "string", "description" : "店铺经营类型，01表示直营，02表示加盟", "example" : "01" }, "store_id" : { "type" : "string", "description" : "球房编号，表示该球房在该商户角色id(直连pid，间连smid)下，由商户自己定义的外部球房编号", "example" : "NO0001" } } }, "ShopRecommendInfo" : { "type" : "object", "properties" : { "recommend" : { "type" : "string", "description" : "球房修改建议", "example" : "请修改店名为真实经营的球房名称，如有分店，请修改成品牌（分店名），如大润发（杭州西溪店）" }, "recommend_address" : { "type" : "string", "description" : "推荐详细地址", "example" : "杭州市西湖区**路**号" }, "recommend_latitude" : { "type" : "string", "description" : "推荐纬度", "example" : "30.111" }, "recommend_longtitude" : { "type" : "string", "description" : "推荐经度", "example" : "120.3333" }, "recommend_name" : { "type" : "string", "description" : "推荐球房名称", "example" : "大润发（杭州西溪店）" }, "unconfidence_reason" : { "type" : "string", "description" : "球房不置信原因", "example" : "店名不准确" } } }, "ShopSummaryQueryResponse" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "球房地址", "example" : "万塘路18号黄龙时代广场" }, "branch_shop_name" : { "type" : "string", "description" : "分店名", "example" : "万塘路店" }, "brand_name" : { "type" : "string", "description" : "品牌名，不填写则默认为其它品牌", "example" : "肯德基" }, "business_time" : { "type" : "string", "description" : "经营时间", "example" : "10:00-14:00" }, "category_infos" : { "type" : "array", "description" : "球房类目列表", "items" : { "$ref" : "#/components/schemas/ShopCategoryInfo" } }, "city_code" : { "type" : "string", "description" : "城市编码，国标码，详见国家统计局数据 点此下载", "example" : "140500" }, "district_code" : { "type" : "string", "description" : "区县编码，国标码，详见国家统计局数据 点此下载", "example" : "140521" }, "ext_info" : { "type" : "string", "description" : "json 字符串表示额外信息;\r\t\r\torder_biz_mode: 点餐营业模式, REGULAR-正餐、LIGHT_FAST-轻快餐;\r\tpre_order: 预点餐服务可用状态, 1-服务可用、0-服务不可用\r\torder: 到店点餐服务可用状态：1-服务可用、0-服务不可用", "example" : "{\"order_biz_mode\":\"REGULAR\",\"order\":\"1\",\"pre_order\":\"1\"}" }, "gmt_create" : { "type" : "string", "description" : "创建时间", "example" : "2016-06-23 21:15:04.593" }, "is_show" : { "type" : "string", "description" : "球房是否在客户端显示，T表示显示，F表示隐藏", "example" : "T" }, "latitude" : { "type" : "string", "description" : "纬度，只有在query_type=KB_PROMOTER非空", "example" : "31.226948" }, "longitude" : { "type" : "string", "description" : "经度，只有在query_type=KB_PROMOTER非空", "example" : "121.549728" }, "main_image" : { "type" : "string", "description" : "球房首图", "example" : "AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC" }, "main_shop_name" : { "type" : "string", "description" : "主球房名", "example" : "海底捞" }, "per_pay" : { "type" : "string", "description" : "人均价格。单位是分。例如：2000，表示20元", "example" : "100" }, "pic_coll" : { "type" : "string", "description" : "图片集，是map转化成的json串，key是图片id,value是图片url", "example" : "{\"IUFIDASFIEUIOFKSFIUFE83IEI\":\"http://object.alipay.com/getpic.do?kjkdjkjj\"}" }, "province_code" : { "type" : "string", "description" : "省份编码，国标码，详见国家统计局数据 点此下载", "example" : "110000" }, "shop_comment_info" : { "$ref" : "#/components/schemas/ShopCommentInfo" }, "shop_id" : { "type" : "string", "description" : "球房ID", "example" : "2015052100077000000000120773" }, "shop_type" : { "type" : "string", "description" : "COMMON（普通球房）、MALL（商圈）", "example" : "COMMON" }, "status" : { "type" : "string", "description" : "球房状态，OPEN：营业中、PAUSE：暂停营业、FREEZE：已冻结、CLOSE:球房已关闭", "example" : "OPEN" } } }, "SignAddressInfo" : { "type" : "object", "properties" : { "city_code" : { "type" : "string", "description" : "城市编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 （参考资料： http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/）" }, "country_code" : { "type" : "string", "description" : "国家编码，中国默认：156" }, "detail_address" : { "type" : "string", "description" : "详细地址" }, "district_code" : { "type" : "string", "description" : "区县编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 （参考资料： http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/）" }, "latitude" : { "type" : "string", "description" : "纬度，浮点型,小数点后最多保留6位 如需要录入经纬度，请以高德坐标系为准，录入时请确保经纬度参数准确。高德经纬度查询：http://lbs.amap.com/console/show/picker" }, "longitude" : { "type" : "string", "description" : "经度，浮点型, 小数点后最多保留6位。 如需要录入经纬度，请以高德坐标系为准，录入时请确保经纬度参数准确。高德经纬度查询：http://lbs.amap.com/console/show/picker" }, "province_code" : { "type" : "string", "description" : "省份编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 （参考资料： http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/）" } } }, "SignData" : { "type" : "object", "properties" : { "ori_app_id" : { "type" : "string", "description" : "签名商户开放平台应用APPID", "example" : "2021000185629012" }, "ori_char_set" : { "type" : "string", "description" : "编码类型（大小写敏感）", "example" : "UTF-8" }, "ori_out_biz_no" : { "type" : "string", "description" : "ori_out_biz_no_001", "example" : "商户订单号" }, "ori_sign" : { "type" : "string", "description" : "签名密文", "example" : "EqHFP0z4a9iaQ1ep==" }, "ori_sign_type" : { "type" : "string", "description" : "签名算法（大小写敏感）", "example" : "RSA2" }, "partner_id" : { "type" : "string", "description" : "2088041181118800", "example" : "签名被授权方支付宝账号ID" } } }, "SignField" : { "type" : "object", "properties" : { "auto_execute" : { "type" : "string", "description" : "平台自动签", "example" : "true" }, "signer" : { "$ref" : "#/components/schemas/Signer" }, "struct_key" : { "type" : "string", "description" : "模板组件id", "example" : "18247776929e433784636126b33b08a3" } } }, "SignFieldBean" : { "type" : "object", "properties" : { "sign_field_type" : { "type" : "string", "description" : "签署类型：\t\tplatform-平台自动签：无需指定签署人。创建流程后，系统将自动盖上商户的默认企业印章。\t\tperson-个人签署：需要指定签署人个人信息。创建流程后，需通过签署插件完成签署。\torg-企业签署：需要指定签署企业信息与经办人个人信息。创建流程后，需经办人代企业完成签署。（企业暂不支持插件签署，可通过获取签署地址接口获取企业签署地址）", "example" : "person" }, "signer" : { "$ref" : "#/components/schemas/SignerBean" }, "struct_key" : { "type" : "string", "description" : "签署区key值", "example" : "signer1" } } }, "SignRestrictInfo" : { "type" : "object", "properties" : { "restrict_product" : { "type" : "string", "description" : "产品码，支付宝定义的产品码", "example" : "I1011000100000000001" }, "restrict_reason" : { "type" : "string", "description" : "受限的原因", "example" : "经营资质不符合要求" }, "restrict_reason_code" : { "type" : "string", "description" : "受限原因编码", "example" : "001" }, "restrict_version" : { "type" : "string", "description" : "受限版本，02-受限版 04-极速版", "example" : "02" } } }, "Signer" : { "type" : "object", "properties" : { "email" : { "type" : "string", "description" : "邮箱", "example" : "593100192@tsign.cn" }, "id_number" : { "type" : "string", "description" : "证件号", "example" : "330304199806083911" }, "id_type" : { "type" : "string", "description" : "证件类型,详见个人证件类型说明（http://open.esign.cn/docs/xy/%E6%8E%A5%E5%8F%A3%E6%96%87%E6%A1%A3/%E9%99%84%E5%BD%95/%E4%B8%AA%E4%BA%BA%E8%AF%81%E4%BB%B6%E7%B1%BB%E5%9E%8B.html），默认CRED_PSN_CH_IDCARD (证件号不为空，则必填)", "example" : "CRED_PSN_CH_IDCARD" }, "mobile" : { "type" : "string", "description" : "手机号", "example" : "18888888888" }, "name" : { "type" : "string", "description" : "姓名", "example" : "姓名" }, "user_id" : { "type" : "string", "description" : "支付宝userId", "example" : "2088102924502823" } } }, "SignerBean" : { "type" : "object", "properties" : { "email" : { "type" : "string", "description" : "个人邮箱", "example" : "593100192@tsign.cn" }, "id_number" : { "type" : "string", "description" : "个人证件号", "example" : "330304199801011111" }, "id_type" : { "type" : "string", "description" : "个人证件类型（证件号不为空时必填，详见个人证件类型说明 ）", "example" : "CRED_PSN_CH_IDCARD" }, "mobile" : { "type" : "string", "description" : "个人手机号", "example" : "18888888888" }, "name" : { "type" : "string", "description" : "个人姓名", "example" : "折颜" }, "org" : { "$ref" : "#/components/schemas/Org" }, "third_party_user_id" : { "type" : "string", "description" : "个人唯一标识：可传入平台的个人用户id、支付宝userid、证件号、手机号、邮箱等。", "example" : "2088102924502823" } } }, "SingleArticleAnalysisData" : { "type" : "object", "properties" : { "avg_read_time" : { "type" : "string", "description" : "人均阅读时长", "example" : "27.13" }, "date" : { "type" : "string", "description" : "文章发布日期", "example" : "2017-09-08 15:00:18" }, "deliver_user_cnt" : { "type" : "integer", "description" : "送达人数", "example" : "10" }, "expose_user_cnt" : { "type" : "integer", "description" : "曝光人数", "example" : "30" }, "praise_user_cnt" : { "type" : "integer", "description" : "点赞数", "example" : "20" }, "read_user_cnt" : { "type" : "integer", "description" : "阅读人数", "example" : "20" }, "reply_user_cnt" : { "type" : "integer", "description" : "评论数", "example" : "30" }, "share_user_cnt" : { "type" : "integer", "description" : "分享人数", "example" : "40" }, "title" : { "type" : "string", "description" : "文章标题", "example" : "文章标题" } } }, "SkuCreateInfo" : { "type" : "object", "properties" : { "inventory" : { "type" : "integer", "description" : "库存", "example" : "100" }, "material_list" : { "type" : "array", "description" : "SKU素材列表（最多3个）", "items" : { "$ref" : "#/components/schemas/MaterialCreateInfo" } }, "original_price" : { "type" : "integer", "description" : "标价，单位分", "example" : "100" }, "price" : { "type" : "integer", "description" : "售价，单位分", "example" : "100" }, "property_list" : { "type" : "array", "description" : "SKU属性列表", "items" : { "$ref" : "#/components/schemas/ItemSkuPropertyInfo" } } } }, "SkuModifyInfo" : { "type" : "object", "properties" : { "inventory" : { "type" : "integer", "description" : "库存", "example" : "100" }, "material_list" : { "type" : "array", "description" : "SKU素材列表（会和SKU已存在素材做差异化比较后做增删改操作）", "items" : { "$ref" : "#/components/schemas/MaterialModifyInfo" } }, "original_price" : { "type" : "integer", "description" : "标价，单位分", "example" : "100" }, "price" : { "type" : "integer", "description" : "售价，单位分", "example" : "100" }, "property_list" : { "type" : "array", "description" : "SKU属性列表（覆盖SKU已存在属性）", "items" : { "$ref" : "#/components/schemas/ItemSkuPropertyInfo" } }, "sku_id" : { "type" : "string", "description" : "SKU ID（传空表示新增对应SKU）", "example" : "2018092600502220000000100274" } } }, "SourceContentInfo" : { "type" : "object", "properties" : { "content_id" : { "type" : "string", "description" : "内容ID", "example" : "20210928OB02001002950004xxxx" }, "link" : { "type" : "string", "description" : "支付宝内容链接", "example" : "alipays://xxxx" }, "permission_status" : { "type" : "string", "description" : "内容分发范围。0 - 仅创作者自己可见，1 - 所有人可见，2 - 分发范围受限。", "example" : "1" }, "source_author" : { "type" : "string", "description" : "作者", "example" : "作者" }, "source_link" : { "type" : "string", "description" : "来源文章的原始链接地址", "example" : "http://test.xx.com" }, "source_media_infos" : { "type" : "array", "description" : "素材列表", "items" : { "$ref" : "#/components/schemas/SourceMediaInfo" } }, "source_offers" : { "type" : "array", "description" : "关联服务", "items" : { "$ref" : "#/components/schemas/SourceOffer" } }, "source_publish_date" : { "type" : "string", "description" : "文章发布时间", "example" : "2018-09-30 10:10:10" }, "source_status" : { "type" : "string", "description" : "内容状态\t0-审核中\t1-成功发布\t2-审核不通过\t3-己删除", "example" : "1" }, "source_summary" : { "type" : "string", "description" : "文章的摘要", "example" : "文章的摘要" }, "source_title" : { "type" : "string", "description" : "内容标题", "example" : "内容标题" }, "source_type" : { "type" : "string", "description" : "内容类型（0-长图文 1-短图文 2-视频）", "example" : "1" }, "special_tags" : { "type" : "array", "description" : "平台加工后的内容标签，例如\tHIGH_QUALITY: 优质", "items" : { "type" : "string" }, "example" : "[\"HIGH_QUALITY\"]" } } }, "SourceMediaInfo" : { "type" : "object", "properties" : { "media_id" : { "type" : "string", "description" : "素材ID，对应“支付宝文件上传接口”获取的file_id", "example" : "A12334" }, "media_type" : { "type" : "string", "description" : "素材类型。\t image：图片\t video：视频\tcover_static：静态封面", "example" : "image" } } }, "SourceOffer" : { "type" : "object", "properties" : { "offer_id" : { "type" : "string", "description" : "offerId，根据offer类型对应不同ID。支持小程序的APPID/小程序服务的服务编码/优惠券的活动ID", "example" : "a2344" }, "offer_type" : { "type" : "string", "description" : "offer类型。目前仅支持小程序（mini_app/service）、小程序服务（subservice）、营销活动（voucher）、商品(goods)。\t注意：其中“小程序”offer类型，在发布接口请用mini_app，查询接口返回为service", "example" : "mini_app" } } }, "SpecialVoucher" : { "type" : "object", "properties" : { "floor_amount" : { "type" : "string", "description" : "门槛金额。说明：该字段可不填，认为无门槛;" }, "goods_name" : { "type" : "string", "description" : "商品名称。" }, "origin_amount" : { "type" : "string", "description" : "原价。\t限制：\t币种为人民币，单位为元。小数点以后最多保留两位;\t取值范围:0.1<=x<=9999。" }, "special_amount" : { "type" : "string", "description" : "特价，即：原价-特价=优惠金额。" } } }, "SpecialVoucherInfo" : { "type" : "object", "properties" : { "floor_amount" : { "type" : "string", "description" : "门槛金额。" }, "special_amount" : { "type" : "string", "description" : "特价，即：原价-特价=优惠金额。" }, "voucher_deduct_threshold_info" : { "$ref" : "#/components/schemas/VoucherDeductThresholdInfo" } } }, "SpecifyAttachmentInfo" : { "type" : "object", "properties" : { "allow_more_uploads" : { "type" : "boolean", "description" : "是否允许上传更多附件，默认值为false。开启后，除了“collect_common_codes”中指定的附件，签署人可自由上传至多10张图片。", "example" : "true" }, "allow_more_uploads_max_count" : { "type" : "integer", "description" : "允许上传更多附件时，可上传的最大附件数，一次流程中累计的上传附件数至多30（含“附件列表”数量）", "example" : "3" }, "collect_cert_types" : { "type" : "array", "description" : "需要签署人上传的证件照片，可进行ORC识别，目前仅支持IDCARD", "items" : { "type" : "string" }, "example" : "IDCARD" }, "collect_common_codes" : { "type" : "array", "description" : "需要签署人上传的其他附件列表，即attachment_explain.details中定义的code列表", "items" : { "type" : "string" }, "example" : "phonePicture1" }, "third_party_user_id" : { "type" : "string", "description" : "个人唯一标识，对应签署区中指定的签署人", "example" : "tgxxteck" } } }, "SpiResult" : { "type" : "object", "properties" : { "biz_code" : { "type" : "string", "description" : "isv自定义业务代码", "example" : "hotline" }, "spi_id" : { "type" : "integer", "description" : "spi唯一id", "example" : "1" } } }, "SpuAttribute" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "商品属性名", "example" : "材质" }, "value" : { "type" : "array", "description" : "商品属性值", "items" : { "type" : "string" }, "example" : "[\"纯棉\",\"条轮\"]" } } }, "SpuDetail" : { "type" : "object", "properties" : { "brand" : { "type" : "string", "description" : "商品品牌", "example" : "思有为" }, "category" : { "type" : "string", "description" : "商品类目", "example" : "汽车配件" }, "dimension" : { "type" : "string", "description" : "商品规格", "example" : "\"品牌\": \"思有为\", \"颜色分类\":\"黑色\",\"传感器类别\": \"24G\",\"毫米波型号\": 1001,\"最大探测距离\": \"15m\",\"是否支持到店安装\":\"是\",\"传感器数量\": \"2个\"" }, "icon" : { "type" : "string", "description" : "商品图片地址", "example" : "https://image.baidu.com/search/detail?ct=503316480&z=0&ipn=d" }, "link_url" : { "type" : "string", "description" : "商品链接", "example" : "https://detail.tmall.com/item.htm?id=530187047412&ali_trackid=2:mm_26632614_0_0:1603785697_244_935652742" }, "spu_id" : { "type" : "string", "description" : "商品ID", "example" : "spu001002003004005006" }, "title" : { "type" : "string", "description" : "商品名称", "example" : "汽车盲点BSD并线辅助系统盲点监测变道后视镜盲区监控雷达预警" } } }, "SpuInfo" : { "type" : "object", "properties" : { "brand" : { "type" : "string", "description" : "品牌名称", "example" : "壳牌" }, "category" : { "type" : "string", "description" : "类目", "example" : "美妆" }, "count" : { "type" : "integer", "description" : "商品数量", "example" : "1" }, "icon" : { "type" : "string", "description" : "图片链接", "example" : "http://baidu.com/imge/dfadf.jpg" }, "price" : { "type" : "string", "description" : "商品单价", "example" : "23" }, "provider" : { "type" : "string", "description" : "商品提供方，店铺或品牌方", "example" : "XX店铺" }, "spu_id" : { "type" : "string", "description" : "商品ID", "example" : "spu12141239912" } } }, "StandardConditionInfo" : { "type" : "object", "properties" : { "rule_factor" : { "type" : "string", "description" : "条件类型" }, "rule_id" : { "type" : "string", "description" : "费控条件ID" }, "rule_name" : { "type" : "string", "description" : "费控条件名称" }, "rule_operator" : { "type" : "string", "description" : "费控条件操作符 枚举值： LT(\"<\",\"小于\") LE(\"<=\",\"小于等于\") EQ(\"=\",\"等于\") NE(\"!=\",\"不等于\") GE(\">=\",\"大于等于\") GT(\">\",\"大于\")" }, "rule_value" : { "type" : "string", "description" : "费控条件值" } } }, "StandardIdInfo" : { "type" : "object", "properties" : { "outer_source_id" : { "type" : "string", "description" : "外部使用规则id", "example" : "123456" }, "standard_id" : { "type" : "string", "description" : "使用规则id", "example" : "2022020900152608000000000001" } } }, "StandardInfo" : { "type" : "object", "properties" : { "asset_share_source_info" : { "$ref" : "#/components/schemas/AssetShareSourceInfo" }, "consume_mode" : { "type" : "string", "description" : "消费模式，不填为默认模式，枚举值：COUPON_ONLY（仅支持点券）\tCOUPON_AND_CAP（支持点券+余额）\tDEFAULT（默认模式）\t点券：消费时找员工的点券，没有或者用完了不可付；\t点券+余额：消费时找员工的点券，没有找员工的余额，没有或者用完了不可付。\t默认：有给员工设置员工余额以员工余额为准，用完为止。否则只受规则里的限额和企业账户资金上限管控；" }, "expense_type_sub_category" : { "type" : "string", "description" : "费用类型子类，当制度的费用类型为MEAL时，支持到店、外卖；当费用类型为非MEAL时，与费用类型保持一致" }, "open_rule_id" : { "type" : "string", "description" : "开票规则id，可通过接口alipay.ebpp.invoice.enterpriseconsume.enterpriseopenrule.create 创建并得到开票规则ID" }, "outer_source_id" : { "type" : "string", "description" : "外部使用规则id，制度内使用规则该字段不允许重复" }, "payment_policy" : { "type" : "string", "description" : "支付策略 当笔消费金额大于规则可用余额时，用于控制支付策略，该字段缺省时采取因公账户和个人账户组合支付策略" }, "standard_condition_info_list" : { "type" : "array", "description" : "使用规则条件列表", "items" : { "$ref" : "#/components/schemas/StandardConditionInfo" } }, "standard_desc" : { "type" : "string", "description" : "使用规则描述(敏感词校验)" }, "standard_id" : { "type" : "string", "description" : "制度ID（创建使用规则时非必填）" }, "standard_name" : { "type" : "string", "description" : "规则名称" } } }, "StandardRuleInfo" : { "type" : "object", "properties" : { "effective_end_date" : { "type" : "string", "description" : "有效期截止", "example" : "2021-08-27 00:00:00" }, "effective_start_date" : { "type" : "string", "description" : "有效期起始", "example" : "2021-08-26 00:00:00" }, "expense_ctrl_rule_info_list" : { "type" : "array", "description" : "费控条件列表", "items" : { "$ref" : "#/components/schemas/ExpenseCtrRuleInfo" } }, "payment_policy" : { "type" : "string", "description" : "当笔消费金额大于规则可用余额时，用于控制支付策略，该字段缺省时采取因公账户和个人账户组合支付策略， 枚举值：PERSONAL（全部个人账户支付）", "example" : "PERSONAL" }, "standard_desc" : { "type" : "string", "description" : "费控规则说明", "example" : "费控规则说明测试" }, "standard_id" : { "type" : "string", "description" : "费控规则ID", "example" : "2021062800152601350000001466" }, "standard_name" : { "type" : "string", "description" : "费控规则名称", "example" : "费控规则名称" } } }, "StandardServiceBaseInfo" : { "type" : "object", "properties" : { "biz_status" : { "type" : "string", "description" : "服务状态", "example" : "INVALID" }, "category_id" : { "type" : "string", "description" : "类目id", "example" : "C154984121" }, "service_code" : { "type" : "string", "description" : "服务code", "example" : "S11111" }, "service_name" : { "type" : "string", "description" : "服务名称", "example" : "肯德基" } } }, "StationDetailInfo" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "站点编码", "example" : "12000020" }, "ext_code" : { "type" : "string", "description" : "站点外部编码", "example" : "260000210002" }, "name" : { "type" : "string", "description" : "站点中文名称", "example" : "蓝村路" } } }, "StdPublicBindAccount" : { "type" : "object", "properties" : { "agreement_id" : { "type" : "string", "description" : "协议号是商户会员在支付宝公众账号中的唯一标识。", "example" : "20131017000001476688" }, "app_id" : { "type" : "string", "description" : "公众账号ID", "example" : "2013091300001633" }, "bind_account_no" : { "type" : "string", "description" : "绑定的商户会员号", "example" : "6226250032060088" }, "display_name" : { "type" : "string", "description" : "公众账号期望支付宝用户在公众账号首页看到的关于该用户的显示信息，最长10个汉字。", "example" : "尾号0088" }, "from_user_id" : { "type" : "string", "description" : "绑定的商户会员对应的支付宝用户号，以2088 开头的16位数字。", "example" : "2088123412341234" }, "open_id" : { "type" : "string", "description" : "1", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "real_name" : { "type" : "string", "description" : "绑定的商户会员的真实姓名，最长10个汉字。", "example" : "王小毛" } } }, "SubButton" : { "type" : "object", "properties" : { "action_param" : { "type" : "string", "description" : "当actionType为link时，该参数为url链接； \r\t当actionType为out时，该参数为用户自定义参数； \r\t当actionType为tel时，该参数为电话号码。 \r\t当action_type为map时，该参数为查看地图的关键字。\r\t 当action_type为consumption时，该参数可不传。 \r\t该参数最长255个字符，不允许冒号等特殊字符。" }, "action_type" : { "type" : "string", "description" : "菜单类型：\r\tout——事件型菜单；\r\tlink——链接型菜单；\r\ttel——点击拨打电话；\r\tmap——点击查看地图；\r\tconsumption——点击查看用户与生活号管理员账号之间的消费记录" }, "icon" : { "type" : "string", "description" : "icon图片url，必须是http协议的url，尺寸为60X60，最大不超过5M，请先调用 图片上传接口获得图片url" }, "name" : { "type" : "string", "description" : "菜单名称，icon菜单名称不超过5个汉字，文本菜单名称不超过9个汉字，编码格式为GBK" } } }, "SubFee" : { "type" : "object", "properties" : { "charge_fee" : { "type" : "string", "description" : "实收费用" }, "original_charge_fee" : { "type" : "string", "description" : "原始费用" }, "switch_fee_rate" : { "type" : "string", "description" : "签约费率" } } }, "SubMerchant" : { "type" : "object", "properties" : { "merchant_id" : { "type" : "string", "description" : "支付宝二级商户编号。\t间连受理商户的支付宝商户编号，通过间连商户入驻接口后由支付宝生成。\t直付通和机构间连业务场景下必传。" }, "merchant_type" : { "type" : "string", "description" : "二级商户编号类型。\t枚举值：\talipay:支付宝分配的间联商户编号；\t目前仅支持alipay，默认可以不传。" } } }, "SubMerchantCommonEnterOpenModel" : { "type" : "object", "properties" : { "extend_fields" : { "type" : "string", "description" : "扩展字段，为json字符串格式；入驻支付即开票的产品该字段必填，用户白名单，由此字段传入；支付即开票商户配置维度，如果不传默认为SMID_MODE，目前仅支持SMID_MODE和PID_MODE", "example" : "\"{\\\\\"M_WHITE_LIST\\\\\":\\\\\"18997927882\\\\\", \\\\\"PAYMENT_OPEN_MERCHANT_DIMENSION\\\\\": \\\\\"PID_MODE\\\\\"}\"" }, "product_code" : { "type" : "string", "description" : "商户球房入驻的产品码,STANDARD_INVOICE:扫码开票，INVOICE_RETURN:企业自建-发票回传，INVOICE_EXPENSE:发票报销，PAYMENT_OPEN:支付即开票，PAY_FEE_OPEN:缴费后开票。", "example" : "STANDARD_INVOICE" }, "s_short_name" : { "type" : "string", "description" : "商户球房所属的服务方简称。", "example" : "SAD" } } }, "SubMerchantEnterOpenModel" : { "type" : "object", "properties" : { "extend_fields" : { "type" : "string", "description" : "扩展字段，为json字符串格式；入驻缴费后开票的产品如果需要传入自定义开票链接，由此字段传入。", "example" : "\"{\\\\\"MERCHANT_OPEN_URL\\\\\":\\\\\"http://xxx\\\\\"}\"" }, "industry" : { "type" : "string", "description" : "商户行业，枚举值如下：subway：地铁，etc：ETC，online_car_hailing：网约车，catering：餐饮，hotel：酒店，convenience_store：便利店，oil：加油，insurance：保险，service_provider：运营商，life_payment：生活缴费，political：政务，other：其他", "example" : "hotel" }, "pid" : { "type" : "string", "description" : "开票商户pid，入驻支付即开票场景的时候，该字段必传", "example" : "2088102143353534" }, "register_no" : { "type" : "string", "description" : "商户球房税号。", "example" : "91500000747150346A" }, "sub_m_name" : { "type" : "string", "description" : "商户球房全称。", "example" : "杭州蚂蚁金服信息技术有限公司" }, "sub_m_short_name" : { "type" : "string", "description" : "商户球房简称，只能由大写字母、下划线、数字组成，且必须以大写字母开头。", "example" : "MYJF_HZ" } } }, "SubPackageInfo" : { "type" : "object", "properties" : { "builded_package_url" : { "type" : "string", "description" : "构建好的结果地址", "example" : "构建好的结果地址" }, "new_builded_package_url" : { "type" : "string", "description" : "构建好的分包地址", "example" : "构建好的分包地址" }, "new_size" : { "type" : "string", "description" : "2.0分包大小，单位字节", "example" : "1000" }, "path" : { "type" : "string", "description" : "分包路径", "example" : "main/packageA/packageB" }, "size" : { "type" : "string", "description" : "分包大小，单位字节", "example" : "1000" }, "source_url" : { "type" : "string", "description" : "源码地址", "example" : "源码地址" }, "type" : { "type" : "string", "description" : "分包类型： MAIN ｜ SUB", "example" : "MAIN" } } }, "SubServiceKeyWordInfo" : { "type" : "object", "properties" : { "app_name" : { "type" : "string", "description" : "小程序名称", "example" : "小程序名称123" }, "keyword_info" : { "type" : "array", "description" : "此服务下的关键词", "items" : { "$ref" : "#/components/schemas/KeyWordInfo" } }, "mini_app_id" : { "type" : "string", "description" : "小程序id", "example" : "2021002172648359" }, "sub_service_code" : { "type" : "string", "description" : "子服务code", "example" : "2022051021000880652471" }, "sub_service_desc" : { "type" : "string", "description" : "子服务简单描述", "example" : "这是个服务" }, "sub_service_name" : { "type" : "string", "description" : "子服务名", "example" : "这是服务名字" }, "sub_service_status" : { "type" : "string", "description" : "子服务状态，\tINITIAL：初始化：VALID:已生效；INVALID：已失效", "example" : "INVALID" } } }, "SubTaskInfo" : { "type" : "object", "properties" : { "execute_result" : { "type" : "string", "description" : "子任务执行结果；执行成功为成功，失败则填充失败结果", "example" : "航旅交通1经营内容涉及传销，金融互助平台不合作;" }, "status" : { "type" : "string", "description" : "子任务状态\t状态 INIT:初始化 FAILURE:失败 FINISH:成功", "example" : "INIT" }, "type" : { "type" : "string", "description" : "子任务类型\tSIGN_TASK：签约子任务\tOPE_TASK：代运营授权子任务\tAPP_TASK：应用授权子任务", "example" : "SIGN_TASK" }, "type_desc" : { "type" : "string", "description" : "子任务类型描述", "example" : "签约子任务" } } }, "SubscribeRelation" : { "type" : "object", "properties" : { "keep_state" : { "type" : "string", "description" : "订阅保持状态，即用户勾选“总是保持以上选择，不再询问”选项时勾选的订阅状态。枚举值：\t0：保持订阅。\t1：保持拒绝订阅。\t说明：若用户“总是保持以上选择，不再询问”选项，且选择订阅消息。下次触发消息订阅组件时，支付宝将自动发起一次静默订阅（不再拉起订阅组件，无需用户手动订阅）。", "example" : "0" }, "show" : { "type" : "boolean", "description" : "模板是否展示在订阅组件中。枚举值：\ttrue：订阅组件中展示查询的模板。\tfalse：订阅组件中不展示模板", "example" : "true" }, "subscribe_state" : { "type" : "string", "description" : "订阅状态。枚举值\t0：拒绝订阅。\t1：订阅", "example" : "0" }, "subscribe_type" : { "type" : "string", "description" : "消息模板的订阅类型。枚举值：\tlongterm：长期性订阅\tonetime：一次性订阅", "example" : "longterm" }, "template_id" : { "type" : "string", "description" : "消息模板id", "example" : "7c866fab64464afaa956223c74ce6cbc" } } }, "SuccessDeliveryConfig" : { "type" : "object", "properties" : { "delivery_config" : { "$ref" : "#/components/schemas/DeliveryConfig" } } }, "TargetInfo" : { "type" : "object", "properties" : { "target_id" : { "type" : "string", "description" : "应用id，例如小程序id", "example" : "2018001307627807" }, "target_type" : { "type" : "string", "description" : "应用类型\t小程序传入：APPID\t生活号传入：PUBLICID", "example" : "APPID" } } }, "TaskTypeData" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "商户数据回传的任务名称，供C端展示。当累计的数据类型为任务类型时，此为必传字段", "example" : "滴滴打车任务001" } } }, "Template" : { "type" : "object", "properties" : { "context" : { "$ref" : "#/components/schemas/Context" }, "template_id" : { "type" : "string", "description" : "消息模板ID", "example" : "cbb9fdded2b74fe4bb082de3ed1e1eb2" } } }, "TemplateActionInfoDTO" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "行动点业务CODE，商户自定义" }, "mini_app_url" : { "$ref" : "#/components/schemas/TemplateActionMiniAppUrlDTO" }, "text" : { "type" : "string", "description" : "行动点展示文案" }, "url" : { "type" : "string", "description" : "行动点跳转链接，当url_type取\"url\"或不填时必填" }, "url_type" : { "type" : "string", "description" : "跳转链接类型，当前支持url和miniAppUrl，不填则默认为url类型：\r\turl：对应填写url参数，支持http(s)和支付宝schema地址等；\r\tminiAppUrl: 对应填写mini_app_url参数，跳转至指定的支付宝小程序页面" } } }, "TemplateActionMiniAppUrlDTO" : { "type" : "object", "properties" : { "display_on_list" : { "type" : "string", "description" : "行动点按钮是否在列表页展示，true 或 false，不填则默认false；\r\t列表页可以配置展示最多2项小程序跳转行动点。" }, "mini_app_id" : { "type" : "string", "description" : "小程序appId" }, "mini_page_param" : { "type" : "string", "description" : "指定小程序页面，不填则默认跳转至对应小程序首页" }, "mini_query_param" : { "type" : "string", "description" : "query参数，商户自定义传参，填入值将以\"query\"为参数名提交至指定小程序页面" } } }, "TemplateBenefitInfoDTO" : { "type" : "object", "properties" : { "benefit_desc" : { "type" : "array", "description" : "权益描述信息", "items" : { "type" : "string" } }, "end_date" : { "type" : "string", "description" : "权益结束时间" }, "start_date" : { "type" : "string", "description" : "开始时间" }, "title" : { "type" : "string", "description" : "权益描述" } } }, "TemplateCardLevelConfDTO" : { "type" : "object", "properties" : { "level" : { "type" : "string", "description" : "会员级别 该级别和开卡接口中的level要一致" }, "level_desc" : { "type" : "string", "description" : "会员级别描述" }, "level_icon" : { "type" : "string", "description" : "会员级别对应icon， 通过接口（alipay.offline.material.image.upload）上传图片" }, "level_show_name" : { "type" : "string", "description" : "会员级别显示名称" } } }, "TemplateColumnInfoDTO" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "标准栏位：行为由支付宝统一定，同时已经分配标准Code\r\tBALANCE：会员卡余额\r\tPOINT：积分\r\tLEVEL：等级\r\tTELEPHONE：联系方式\r\t自定义栏位：行为由商户定义，自定义Code码（只要无重复）" }, "group_title" : { "type" : "string", "description" : "若template_style_info.column_info_layout\r\t的值为grid，此项为宫格项所属分组标题。可空。如果需要展示该项，还需支付宝内部进行特殊配置。" }, "icon_id" : { "type" : "string", "description" : "若template_style_info.column_info_layout\r\t的值为grid，此项为宫格项的展示icon。通过接口（alipay.offline.material.image.upload）上传图片。" }, "more_info" : { "$ref" : "#/components/schemas/MoreInfoDTO" }, "operate_type" : { "type" : "string", "description" : "1、openNative：打开二级页面，展现 more中descs\r\t2、openWeb：打开URL\r\t3、staticinfo：静态信息\r\t注意：\r\t不填则默认staticinfo；\r\t标准code尽量使用staticinfo，例如TELEPHONE商家电话栏位就只支持staticinfo；" }, "tag" : { "type" : "string", "description" : "若template_style_info.column_info_layout\r\t的值为grid，此项为宫格项标签。可空。" }, "title" : { "type" : "string", "description" : "栏目的标题" }, "value" : { "type" : "string", "description" : "卡包详情页面，卡栏位右边展现的值\r\t\r\tTELEPHONE栏位的商家联系电话号码由此value字段传入" } } }, "TemplateFieldRuleDTO" : { "type" : "object", "properties" : { "field_name" : { "type" : "string", "description" : "字段名称，现在支持如下几个Key（暂不支持自定义）\r\tBalance：金额\r\tPoint：整数\r\tLevel：任意字符串\r\tOpenDate：开卡日期\r\tValidDate：过期日期" }, "rule_name" : { "type" : "string", "description" : "规则名\r\t1、ASSIGN_FROM_REQUEST: 以rule_value为key值，表示该栏位的值从会员卡开卡接口中获取，会员卡开卡接口的card_info中获取对应参数值\r\t2、DATE_IN_FUTURE: 生成一个未来的日期（格式YYYY-MM-DD)，当选择DATE_IN_FUTURE的时候，field_name 必须是OpenDate或ValidDate， 值为(10m或10d 分别表示10个月或10天)\r\t3、CONST: 常量，会员卡开卡接口进行开卡的时候使用模板创建时候设置的值，即取rule_value的值" }, "rule_value" : { "type" : "string", "description" : "根据rule_name，采取相应取值策略\r\tCONST：直接取rule_value作为卡属性值\r\tDATE_IN_FUTURE：10m或10d 分别表示10个月或10天\r\tASSIGN_FROM_REQUEST：在开卡Reuqest请求中按rule_value取值，现在和field_name对应的为（OpenDate、ValidDate、Level、Point、Balance）" } } }, "TemplateInfo" : { "type" : "object", "properties" : { "fill_contents" : { "type" : "array", "description" : "模板填充项", "items" : { "$ref" : "#/components/schemas/FillContent" } }, "name" : { "type" : "string", "description" : "文件名称", "example" : "iphone手机签收单" }, "signfields" : { "$ref" : "#/components/schemas/SignField" }, "template_id" : { "type" : "string", "description" : "模板id", "example" : "6b95e887c4b342a8b6501bd334b286df" } } }, "TemplateInfoBean" : { "type" : "object", "properties" : { "fill_contents" : { "type" : "array", "description" : "模板填充项，根据组件key值传入填写内容", "items" : { "$ref" : "#/components/schemas/FillContent" } }, "name" : { "type" : "string", "description" : "签署文件名称", "example" : "iPhone手机签收单" }, "signfields" : { "type" : "array", "description" : "签署区，根据签署区key值传入对应的签署人信息", "items" : { "$ref" : "#/components/schemas/SignFieldBean" } }, "template_id" : { "type" : "string", "description" : "模板id，通过创建合同模板获取", "example" : "6b95e887c4b342a8b6501bd334b286df" } } }, "TemplateMdcodeNotifyConfDTO" : { "type" : "object", "properties" : { "ext_params" : { "type" : "string", "description" : "扩展参数信息；\r\t格式为key-value键值对；\r\t支付宝POST请求指定url时，除BizCardNo等固定参数外，将带上ext_params中配置的所有key-value参数。" }, "url" : { "type" : "string", "description" : "商户接收发码通知的地址链接；\r\t只支持https地址；\r\t用户打开会员卡时，支付宝提交POST请求此url地址，通知商户发码。" } } }, "TemplateOpenCardConfDTO" : { "type" : "object", "properties" : { "card_rights" : { "type" : "array", "description" : "领卡权益信息", "items" : { "$ref" : "#/components/schemas/TemplateRightsContentDTO" } }, "conf" : { "type" : "string", "description" : "配置，预留字段，暂时不用" }, "open_card_source_type" : { "type" : "string", "description" : "ISV：外部系统\r\tMER：直连商户" }, "open_card_url" : { "type" : "string", "description" : "开卡连接，必须http、https开头" }, "source_app_id" : { "type" : "string", "description" : "渠道APPID，提供领卡页面的服务提供方" } } }, "TemplateRightsContentDTO" : { "type" : "object", "properties" : { "detail" : { "type" : "string", "description" : "权益内容详情" }, "logo_id" : { "type" : "string", "description" : "权益icon图片Id（目前用于开卡授权页使用），通过接口（alipay.offline.material.image.upload）上传图片" }, "title" : { "type" : "string", "description" : "权益内容标题" } } }, "TemplateStyleInfoDTO" : { "type" : "object", "properties" : { "background_id" : { "type" : "string", "description" : "背景图片Id，通过接口（alipay.offline.material.image.upload）上传图片\r\t\r\t图片说明：2M以内，格式：bmp、png、jpeg、jpg、gif；\r\t尺寸不小于1020*643px；\r\t图片不得有圆角，不得拉伸变形" }, "banner_img_id" : { "type" : "string", "description" : "banner图片地址。 通过接口（alipay.offline.material.image.upload）上传图片。" }, "banner_url" : { "type" : "string", "description" : "banner跳转地址。" }, "bg_color" : { "type" : "string", "description" : "字体颜色（非背景色），只影响卡详情中部信息区域字体颜色" }, "brand_name" : { "type" : "string", "description" : "品牌商名称" }, "card_show_name" : { "type" : "string", "description" : "钱包端显示名称（字符串长度）" }, "color" : { "type" : "string", "description" : "注意：此字段已废弃。\r\t卡片颜色" }, "column_info_layout" : { "type" : "string", "description" : "栏位信息布局。目前只支持list（列表）或grid（宫格）形式。如果为空则默认为list。" }, "feature_descriptions" : { "type" : "array", "description" : "特色信息，用于领卡预览", "items" : { "type" : "string" } }, "front_image_enable" : { "type" : "boolean", "description" : "设置是否在卡面展示（个人头像）图片信息，默认不展示；\r\t当前仅用于身份验证信息类型的个人头像图片；\r\t图片id随创建卡/更新卡时传入；\r\t详见会员卡产品文档。" }, "front_text_list_enable" : { "type" : "boolean", "description" : "设置是否在卡面展示文案信息，默认不展示；\r\t文案信息分行展示，最多展示4行文案，每行文案分为label和value两部分；\r\t文案实际内容随创建卡/更新卡时传入；\r\t详见会员卡产品说明文档。" }, "logo_id" : { "type" : "string", "description" : "logo的图片ID，通过接口（alipay.offline.material.image.upload）上传图片\r\t\r\t图片说明：1M以内，格式bmp、png、jpeg、jpg、gif；\r\t尺寸不小于500*500px的正方形；\r\t请优先使用商家LOGO；" }, "slogan" : { "type" : "string", "description" : "标语" }, "slogan_img_id" : { "type" : "string", "description" : "标语图片， 通过接口（alipay.offline.material.image.upload）上传图片" } } }, "TemplateUsageInfo" : { "type" : "object", "properties" : { "app_version" : { "type" : "string", "description" : "商家小程序版本号", "example" : "0.0.1" }, "mini_app_id" : { "type" : "string", "description" : "商家小程序appId", "example" : "2018011111111111" } } }, "Text" : { "type" : "object", "properties" : { "content" : { "type" : "string", "description" : "文本消息的内容" }, "title" : { "type" : "string", "description" : "文本消息的标题" } } }, "TicketDetailInfo" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "总金额，元为单位", "example" : "10.00" }, "end_station" : { "type" : "string", "description" : "终点站编码", "example" : "21003002" }, "end_station_name" : { "type" : "string", "description" : "终点站中文名称", "example" : "浦电路" }, "quantity" : { "type" : "string", "description" : "票数量", "example" : "8" }, "start_station" : { "type" : "string", "description" : "起点站编码", "example" : "12300002" }, "start_station_name" : { "type" : "string", "description" : "起点站中文名称", "example" : "蓝村路" }, "status" : { "type" : "string", "description" : "订单状态", "example" : "SUCCESS" }, "ticket_price" : { "type" : "string", "description" : "单价，元为单位", "example" : "5.00" }, "ticket_type" : { "type" : "string", "description" : "票类型", "example" : "oneway" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号", "example" : "0123456789" } } }, "TicketInfo" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "地址\t不同类型下的地址含义不同。若type为MEAL_NUM，address则代表取餐地点；若type为PICKUP_CODE，address则代表取件地点。其他类型查看小程序订单产品文档", "example" : "上海市南泉北路447号" }, "end_time" : { "type" : "string", "description" : "截止时间，如果凭证自提/核销时间是一个时间段可传入该字段，time代表自提开始时间，end_time代表自提结束时间，结束时间必须晚于开始时间", "example" : "2020-01-21 11:30:00" }, "resv_type" : { "type" : "string", "description" : "凭证预约类型，一般不需要传入。可选值为INSTANT/RESERVATION，其中INSTANT代表是实时凭证，RESERVATION代表是预约凭证，不传入默认为实时凭证。区别在于预约凭证一般不是当场可取，而是用户下单后的很多天之后才可以凭借凭证提取", "example" : "RESERVATION" }, "shop" : { "type" : "string", "description" : "凭证可核销球房/货品自提球房，如果自提球房与购买球房不一致，可传入该字段提示用户自提球房", "example" : "杭州面馆西溪路店" }, "ticket_no" : { "type" : "string", "description" : "单据号\t不同类型下单据号含义不同。若类型为MEAL_NUM，则ticket_no表示取餐号；若类型为PICKUP_CODE，则ticket_no表示取件码；其他类型查看小程序订单产品文档", "example" : "A0001" }, "time" : { "type" : "string", "description" : "时间，如果传入了end_time则该字段必传\t不同类型下的地址含义不同。若type为MEAL_NUM，time则代表取餐时间；若type为PICKUP_CODE，address则代表取件时间。其他类型查看小程序订单产品文档", "example" : "2020-01-21 11:02:02" }, "type" : { "type" : "string", "description" : "凭证类型\tMEAL_NUM 取餐号\tPICKUP_CODE 取件码\tSELF_PICK_CODE 自提码\tPASSWORD 口令\t具体类型查看产品文档", "example" : "MEAL_NUM" } } }, "TicketOrderInfo" : { "type" : "object", "properties" : { "arrival" : { "$ref" : "#/components/schemas/JourneyLocation" }, "content" : { "type" : "string", "description" : "凭证内容", "example" : "凭证内容" }, "departure" : { "$ref" : "#/components/schemas/JourneyLocation" }, "effective_num" : { "type" : "integer", "description" : "凭证有效数", "example" : "1" }, "end_time" : { "type" : "string", "description" : "结束时间", "example" : "2020-02-01 08:00:00" }, "ext_info" : { "type" : "array", "description" : "扩展信息", "items" : { "$ref" : "#/components/schemas/OrderExtInfo" } }, "face_value" : { "type" : "string", "description" : "票面价", "example" : "10.00" }, "functional_services" : { "type" : "array", "description" : "功能服务信息", "items" : { "$ref" : "#/components/schemas/FunctionalService" } }, "invalid_reason" : { "type" : "string", "description" : "凭证失效原因", "example" : "用户取消" }, "locations" : { "type" : "array", "description" : "凭证可使用地点", "items" : { "$ref" : "#/components/schemas/JourneyLocation" } }, "merchant_ticket_no" : { "type" : "string", "description" : "商户侧凭证ID或核销码", "example" : "out_20210820" }, "seat_infos" : { "type" : "array", "description" : "座位信息", "items" : { "$ref" : "#/components/schemas/SeatInfo" } }, "service_provider" : { "$ref" : "#/components/schemas/OrderParticipantInfo" }, "shops" : { "type" : "array", "description" : "凭证可使用球房列表", "items" : { "$ref" : "#/components/schemas/OrderShopInfo" } }, "start_time" : { "type" : "string", "description" : "凭证开始时间", "example" : "2020-01-01 08:00:00" }, "status" : { "type" : "string", "description" : "凭证状态", "example" : "TICKETED" }, "ticket_create_time" : { "type" : "string", "description" : "凭证创建时间", "example" : "2020-01-01 08:00:01" }, "ticket_modify_time" : { "type" : "string", "description" : "凭证修改时间，精确到毫秒", "example" : "2020-01-01 08:00:01" }, "ticket_num" : { "type" : "integer", "description" : "凭证购买数", "example" : "2" }, "ticket_users" : { "type" : "array", "description" : "凭证使用者信息", "items" : { "$ref" : "#/components/schemas/UserInfomation" } }, "title" : { "type" : "string", "description" : "凭证标题", "example" : "上海-杭州" }, "vehicle_info" : { "$ref" : "#/components/schemas/OrderVehicleInfo" } } }, "TimeRangeInfo" : { "type" : "object", "properties" : { "begin_time" : { "type" : "string", "description" : "开始时间 格式：HH:mm:ss" }, "end_time_info" : { "$ref" : "#/components/schemas/EndTimeInfo" } } }, "TimeRestrictInfo" : { "type" : "object", "properties" : { "disable_period_info" : { "type" : "array", "description" : "不可用时间段", "items" : { "$ref" : "#/components/schemas/VoucherUseTimeRuleInfo" } }, "usable_period_info" : { "type" : "array", "description" : "可用时间段", "items" : { "$ref" : "#/components/schemas/VoucherUseTimeRuleInfo" } } } }, "TimesTypeSyncData" : { "type" : "object", "properties" : { "discount_amount" : { "type" : "string", "description" : "商户回传的优惠金额，如用户享受的红包金额，单位元", "example" : "8.75" }, "discount_desc" : { "type" : "string", "description" : "商户数据回传的优惠信息的名称。", "example" : "消费满减优惠001" }, "task_amount" : { "type" : "string", "description" : "用户和商户发生交易的交易单金额，单位元。", "example" : "3.57" }, "task_desc" : { "type" : "string", "description" : "任务描述", "example" : "完成一次任务001" }, "task_times" : { "type" : "integer", "description" : "当为次数型任务时必须传。", "example" : "1" } } }, "TipsDelivery" : { "type" : "object", "properties" : { "delivery_content" : { "type" : "string", "description" : "收藏引导文案内容", "example" : "点击收藏，下次访问更方便" }, "delivery_id" : { "type" : "string", "description" : "收藏引导投放活动ID", "example" : "20211114000003057595" }, "delivery_name" : { "type" : "string", "description" : "收藏引导投放活动的名称", "example" : "首页收藏引导投放活动" }, "end_time" : { "type" : "string", "description" : "活动结束时间", "example" : "2021-12-23 14:29:00" }, "fail_reason" : { "type" : "string", "description" : "文案审核驳回理由，仅AUDIT_REJECTED生效", "example" : "当前文案语义不通顺，请修改" }, "match_type" : { "type" : "string", "description" : "匹配类型：GLOBAL为全局生效，TARGETURL为目标页面生效，需配置相应页面地址match_url。", "example" : "TARGETURL" }, "match_url" : { "type" : "string", "description" : "目标页面地址", "example" : "/page/web" }, "start_time" : { "type" : "string", "description" : "活动开始时间", "example" : "2021-11-11 14:31:13" }, "status" : { "type" : "string", "description" : "活动状态。 枚举值： INIT: 初始化；AUDITING: 审核中；AUDIT_REJECTED:审核驳回；WORKING: 生效中；PUASE: 暂停；FINISHED 已结束；", "example" : "WORKING" } } }, "Topic" : { "type" : "object", "properties" : { "img_url" : { "type" : "string", "description" : "营销位图片url", "example" : "https://oalipay-dl-django.alicdn.com/rest/1.0/image?fileIds=xxx&zoom=xxx" }, "link_type" : { "type" : "string", "description" : "跳转类型，网页:HTTP、小程序:APP", "example" : "HTTP" }, "link_url" : { "type" : "string", "description" : "营销位跳转地址，点击营销位头图跳到的链接url。", "example" : "https://www.alipay.com" }, "sub_title" : { "type" : "string", "description" : "营销位描述", "example" : "营销位描述" }, "title" : { "type" : "string", "description" : "营销位名称", "example" : "营销位名称" }, "topic_id" : { "type" : "string", "description" : "营销位id", "example" : "CG202011131013300867029" }, "topic_items" : { "type" : "array", "description" : "营销位内容列表", "items" : { "$ref" : "#/components/schemas/TopicItem" } } } }, "TopicItem" : { "type" : "object", "properties" : { "img_url" : { "type" : "string", "description" : "内容图片url, 尺寸为300*300，最大不超过3M，支持格式:.jpg、.png ，请先调用 图片上传接口获得图片url" }, "link_type" : { "type" : "string", "description" : "跳转类型，网页:HTTP、小程序:APP，不传默认HTTP" }, "link_url" : { "type" : "string", "description" : "跳转链接，点击营销位内容图片跳到的链接url" }, "sub_title" : { "type" : "string", "description" : "内容说明" }, "title" : { "type" : "string", "description" : "内容标题" } } }, "TradeComplainQueryResponse" : { "type" : "object", "properties" : { "complain_event_id" : { "type" : "string", "description" : "支付宝侧投诉单号", "example" : "2020092300102000000001459758" }, "complain_reason" : { "type" : "string", "description" : "投诉原因", "example" : "重复扣款" }, "content" : { "type" : "string", "description" : "已经扣除了我的钱，为什么再次扣款？？？", "example" : "投诉内容" }, "gmt_create" : { "type" : "string", "description" : "投诉单创建时间", "example" : "2020-02-14 14:23:12" }, "gmt_finished" : { "type" : "string", "description" : "投诉单结束时间", "example" : "2020-02-14 14:23:12" }, "gmt_modified" : { "type" : "string", "description" : "投诉单修改时间", "example" : "2020-02-14 14:23:12" }, "images" : { "type" : "array", "description" : "投诉图片", "items" : { "type" : "string" }, "example" : "[\"http://mdn.alipay.com/wsdk/img?fileid=A*ME4GQq2j-5oAAAAAAAAAAAAAAQAAAQ&t=83fed12ef006ebcd8df04dfe79faad6c&bi=openpunsh&ts=0&zoom=original\"]" }, "leaf_category_name" : { "type" : "string", "description" : "投诉诉求", "example" : "我要退款" }, "merchant_order_no" : { "type" : "string", "description" : "商家订单号", "example" : "tp1234567899" }, "phone_no" : { "type" : "string", "description" : "投诉人电话号码", "example" : "15768789890" }, "status" : { "type" : "string", "description" : "状态\t商家处理中：MERCHANT_PROCESSING\t商家已反馈：MERCHANT_FEEDBACKED\t投诉已完结：FINISHED\t投诉已撤销：CANCELLED\t平台处理中：PLATFORM_PROCESSING\t平台处理完结：PLATFORM_FINISH\t系统关闭：CLOSED", "example" : "MERCHANT_PROCESSING" }, "target_id" : { "type" : "string", "description" : "应用id，例如小程序id、生活号id、商家pid", "example" : "2018001307627807" }, "target_type" : { "type" : "string", "description" : "应用类型\t小程序为：APPID\t生活号为：PUBLICID\t商家为：PID", "example" : "APPID" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号", "example" : "2020092322001448341410785740" } } }, "TradeFundBill" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "该支付工具类型所使用的金额。单位：元。" }, "bank_code" : { "type" : "string", "description" : "银行卡支付时的银行代码" }, "fund_channel" : { "type" : "string", "description" : "交易使用的资金渠道，详见 支付渠道列表" }, "fund_type" : { "type" : "string", "description" : "渠道所使用的资金类型,目前只在资金渠道(fund_channel)是银行卡渠道(BANKCARD)的情况下才返回该信息(DEBIT_CARD:借记卡,CREDIT_CARD:信用卡,MIXED_CARD:借贷合一卡)" }, "real_amount" : { "type" : "string", "description" : "渠道实际付款金额" } } }, "TradeFundBillDetail" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "交易金额" }, "asset_type_code" : { "type" : "string", "description" : "资产类型编码" }, "asset_user_id" : { "type" : "string", "description" : "资产的属主" }, "asset_user_open_id" : { "type" : "string", "description" : "资产的属主openid" }, "biz_pay_type" : { "type" : "string", "description" : "支付业务类型\t\tPAY-支付\t\tREFUND-退款" }, "create_time" : { "type" : "string", "description" : "创建时间" }, "payment_no" : { "type" : "string", "description" : "支付单据号" } } }, "TradeInfoDTO" : { "type" : "object", "properties" : { "buyer_id" : { "type" : "string", "description" : "买家ID", "example" : "208888888888" }, "create_time" : { "type" : "string", "description" : "交易创建时间", "example" : "2010-11-11 11:11:11" }, "platform_order_id" : { "type" : "string", "description" : "外部平台订单号", "example" : "781773393333012410369282" }, "total_amount" : { "type" : "string", "description" : "订单总金额", "example" : "88" }, "trade_amount" : { "type" : "string", "description" : "订单总金额", "example" : "88" }, "trade_fund_bill_list" : { "type" : "array", "description" : "资金单明细", "items" : { "$ref" : "#/components/schemas/TradeFundBillDetail" } }, "trade_no" : { "type" : "string", "description" : "交易单号", "example" : "1231231321321" }, "trade_status" : { "type" : "string", "description" : "交易状态：WAIT_BUYER_PAY（交易创建，等待买家付款）、TRADE_CLOSED（未付款交易超时关闭，或支付完成后全额退款）、TRADE_SUCCESS（交易支付成功）、TRADE_FINISHED（交易结束，不可退款）", "example" : "TRADE_SUCCESS" } } }, "TradeItemResult" : { "type" : "object", "properties" : { "alipay_order_no" : { "type" : "string", "description" : "支付宝订单号。对账使用，不脱敏" }, "gmt_create" : { "type" : "string", "description" : "交易创建时间" }, "gmt_pay" : { "type" : "string", "description" : "交易支付时间" }, "gmt_refund" : { "type" : "string", "description" : "交易退款时间" }, "goods_memo" : { "type" : "string", "description" : "商品备注信息" }, "goods_title" : { "type" : "string", "description" : "商品名称" }, "merchant_order_no" : { "type" : "string", "description" : "商户订单号，创建支付宝交易时传入的信息。对账使用，不脱敏" }, "net_mdiscount" : { "type" : "string", "description" : "商家优惠金额" }, "other_account" : { "type" : "string", "description" : "对方账户" }, "refund_amount" : { "type" : "string", "description" : "订单退款金额" }, "service_fee" : { "type" : "string", "description" : "服务费金额" }, "store_name" : { "type" : "string", "description" : "球房名称" }, "store_no" : { "type" : "string", "description" : "球房编号" }, "total_amount" : { "type" : "string", "description" : "订单金额" }, "trade_status" : { "type" : "string", "description" : "订单状态(待付款,成功,关闭,待发货,待确认收货,已预付,进行中)" }, "trade_type" : { "type" : "string", "description" : "业务类型，帮助商户作为对账参考" } } }, "TradeSettleDetail" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "实际操作金额，单位为元，两位小数。该参数的值为分账或补差或结算时传入", "example" : "10.00" }, "operation_dt" : { "type" : "string", "description" : "操作日期", "example" : "2019-05-16 09:59:17" }, "operation_serial_no" : { "type" : "string", "description" : "商户操作序列号。商户发起请求的外部请求号。", "example" : "2321232323232" }, "operation_type" : { "type" : "string", "description" : "结算操作类型。有以下几种类型：\treplenish(补差)、replenish_refund(退补差)、transfer(分账)、transfer_refund(退分账)、settle(结算)、settle_refund(退结算)、on_settle(待结算)。", "example" : "replenish" }, "ori_trans_in" : { "type" : "string", "description" : "商户请求的转入账号", "example" : "2088111111111111" }, "ori_trans_out" : { "type" : "string", "description" : "商户请求的转出账号", "example" : "2088111111111111" }, "trans_in" : { "type" : "string", "description" : "转入账号", "example" : "2088111111111111" }, "trans_out" : { "type" : "string", "description" : "转出账号", "example" : "2088111111111111" } } }, "TradeSettleInfo" : { "type" : "object", "properties" : { "trade_settle_detail_list" : { "type" : "array", "description" : "交易结算明细信息", "items" : { "$ref" : "#/components/schemas/TradeSettleDetail" } } } }, "TransferAccountBookDetailResult" : { "type" : "object", "properties" : { "account" : { "type" : "string", "description" : "付款/收款账户。充值记录中是付款账户。提现、转账记录中是收款账户。支付宝名称及账号脱敏；银行账户的户名脱敏，银行账户显示银行名称+银行卡号后四位", "example" : "*三（招商银行2456）" }, "amount" : { "type" : "string", "description" : "金额", "example" : "100.00" }, "biz_desc" : { "type" : "string", "description" : "业务类型描述。可用于区分业务类型，和不同子账本", "example" : "薪资代发-明细转账-I{2088000117463004}" }, "fund_desc" : { "type" : "string", "description" : "资金来源/去向类型。在充值记录中，表示资金来源类型，在转账和提现类型中，表示去向类型", "example" : "银行卡" }, "instruction_id" : { "type" : "string", "description" : "银行单据号。对账使用，无需脱敏", "example" : "20190101***" }, "memo" : { "type" : "string", "description" : "备注信息", "example" : "普通充值" }, "order_no" : { "type" : "string", "description" : "业务订单号。该笔业务单据的唯一识别编号", "example" : "20190101***" }, "service_fee" : { "type" : "string", "description" : "服务费金额", "example" : "1.00" }, "status" : { "type" : "string", "description" : "资金状态", "example" : "成功" }, "sub_type_desc" : { "type" : "string", "description" : "子类型。“充值类型”，普通充值、大额充值。“转账类型”，暂无实现。转账至支付宝账户、转账至银行卡、批量转账支付宝账户、批量转账至银行卡、批量付款。“提现类型”，暂无实现。普通提现、批量委托提现。对账使用，无需脱敏", "example" : "普通充值" }, "trans_dt" : { "type" : "string", "description" : "业务发生时间", "example" : "2019-01-01 00:00:00" }, "type_desc" : { "type" : "string", "description" : "查询类型描述：充值、转账、提现", "example" : "充值" } } }, "TransferDetailResult" : { "type" : "object", "properties" : { "account" : { "type" : "string", "description" : "付款/收款账户。充值记录中是付款账户。提现、转账记录中是收款账户。支付宝名称及账号脱敏；银行账户的户名脱敏，银行账户显示银行名称+银行卡号后四位", "example" : "*三（招商银行2456）" }, "amount" : { "type" : "string", "description" : "金额", "example" : "100.00" }, "fund_desc" : { "type" : "string", "description" : "资金来源/去向类型。在充值记录中，表示资金来源类型，在转账和提现类型中，表示去向类型", "example" : "银行卡" }, "instruction_id" : { "type" : "string", "description" : "银行单据号。对账使用，无需脱敏", "example" : "20190101***" }, "memo" : { "type" : "string", "description" : "备注信息", "example" : "普通充值" }, "order_no" : { "type" : "string", "description" : "业务订单号。该笔业务单据的唯一识别编号", "example" : "20190101***" }, "service_fee" : { "type" : "string", "description" : "服务费金额", "example" : "1.00" }, "status" : { "type" : "string", "description" : "资金状态", "example" : "成功" }, "sub_type_desc" : { "type" : "string", "description" : "子类型。“充值类型”，普通充值、大额充值。“转账类型”，暂无实现。转账至支付宝账户、转账至银行卡、批量转账支付宝账户、批量转账至银行卡、批量付款。“提现类型”，暂无实现。普通提现、批量委托提现。对账使用，无需脱敏", "example" : "普通充值" }, "trans_dt" : { "type" : "string", "description" : "业务发生时间", "example" : "2019-01-01 00:00:00" }, "type_desc" : { "type" : "string", "description" : "查询类型描述：充值、转账、提现", "example" : "充值" } } }, "TreeInfo" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "类目树ID", "example" : "1" }, "instance_code" : { "type" : "string", "description" : "知识库对应的类目树名称，与treeId不可同时为空", "example" : "TREE_cVE_MHk8_1532332260914" }, "name" : { "type" : "string", "description" : "类目名称", "example" : "蚂蚁科技" } } }, "UnfreezeExtendParams" : { "type" : "object", "properties" : { "quit_type" : { "type" : "string", "description" : "退出类型", "example" : "SETTLE_APPLY_QUIT" }, "total_discount_amount" : { "type" : "string", "description" : "芝麻Go开始到到期过程中享受的优惠总金额", "example" : "3.00" }, "total_real_pay_amount" : { "type" : "string", "description" : "芝麻Go开始到到期过程中任务相关支付的总金额。", "example" : "3.00" }, "total_task_count" : { "type" : "string", "description" : "芝麻Go开始到到期过程中和任务相关的完成次数", "example" : "0" } } }, "UpdatedAuthenticationDetails" : { "type" : "object", "properties" : { "authentication_mechanisms" : { "type" : "array", "description" : "鉴权机制", "items" : { "type" : "string" }, "example" : "ApplicationRedirect" }, "nonce" : { "type" : "string", "description" : "随机数", "example" : "4A941B84" }, "partial_transaction_details_signature" : { "type" : "string", "description" : "交易签名信息", "example" : "U2VydmVyIGdlbmVyYXRlZCB0cmFuc2FjdGlvbiBkZXRhaWxzIHNpZ25hdHVyZQ==" }, "pin_format" : { "type" : "string", "description" : "6位密码或者长密码", "example" : "sixDigits" }, "signing_key_material" : { "type" : "string", "description" : "签名秘钥", "example" : "U2lnbmluZyBrZXkgbWF0ZXJpYWw=" } } }, "UseRule" : { "type" : "object", "properties" : { "ext_info" : { "type" : "string", "description" : "扩展属性，无需设置", "example" : "\\\"key\\\":\\\"value\\\"" }, "forbidden_time" : { "$ref" : "#/components/schemas/ForbbidenTime" }, "limit_rule" : { "type" : "string", "description" : "优惠券的使用支付渠道限制规\r\t则，\r\t不受支付渠道限制\r\t:USE_NO_LIMIT;\r\t仅限口碑储值卡支付时可用\r\t:USE_ON_CURRENT_PAY_C\r\tHANNEL;\r\t口碑储值卡支付时不可用\r\t:NOT_ALLOWED_USE;\r\t【备注】支付渠道限制不允许修改", "example" : "USE_NO_LIMIT" }, "min_consume" : { "type" : "string", "description" : "券核销的最低消费门槛，单位元", "example" : "10" }, "pay_redirect_url" : { "type" : "string", "description" : "券买单跳转链接", "example" : "https://mycar-parkingplatform.alipay-eco.com/pbizplatform/park/parking/stayPayCarList?entrance=1" }, "suit_shops" : { "type" : "array", "description" : "券适用球房列表\r\t仅品牌商发起的招商活动可为空\r\t直发奖类型活动必须与活动适用球房一致\r\t最多支持10w家球房", "items" : { "type" : "string" }, "example" : "2015110600077000000002125023,2015110600077000000002125022" }, "use_time" : { "type" : "array", "description" : "券可用时间段", "items" : { "$ref" : "#/components/schemas/UseTime" } } } }, "UseTime" : { "type" : "object", "properties" : { "dimension" : { "type" : "string", "description" : "券可用时段时间维度，目前支持周(W)", "example" : "W" }, "times" : { "type" : "string", "description" : "券可用时间段\r\t可用时间段起止时间用逗号分隔，多个时间段之间用^分隔\r\t如, \"16:00:00,20:00:00^21:00:00,22:00:00\"表示16点至20点，21点至22点可用\r\t时间段不可重叠", "example" : "16:00:00,20:00:00^21:00:00,22:00:00" }, "values" : { "type" : "string", "description" : "券可用时间维度值\r\t周维度的取值范围1-7(周一至周日)，多个可用时段用逗号分隔\r\t如\"1,3,5\"，对应周一，周三，周五可用", "example" : "1,3,5" } } }, "UserAnalysisData" : { "type" : "object", "properties" : { "cancel_user_cnt" : { "type" : "string", "description" : "取消关注人数", "example" : "40" }, "cumulate_user_cnt" : { "type" : "string", "description" : "累积关注人数", "example" : "60" }, "date" : { "type" : "string", "description" : "日期", "example" : "20171101" }, "grow_user_cnt" : { "type" : "string", "description" : "净增关注人数", "example" : "20" }, "new_user_cnt" : { "type" : "string", "description" : "新关注人数", "example" : "30" } } }, "UserDetails" : { "type" : "object", "properties" : { "user_change_mobile" : { "type" : "string", "description" : "用户变更手机号，替换旧的手机号" }, "user_mobile" : { "type" : "string", "description" : "孩子家长的手机号" }, "user_name" : { "type" : "string", "description" : "张三" }, "user_relation" : { "type" : "string", "description" : "孩子与家长的关系： 1、爸爸 2、妈妈 3、爷爷 4、奶奶 5、外公 6、外婆 7、家长" } } }, "UserIdentityInfo" : { "type" : "object", "properties" : { "h_school_info" : { "$ref" : "#/components/schemas/HSchoolInfo" } } }, "UserInfomation" : { "type" : "object", "properties" : { "cert_no" : { "type" : "string", "description" : "证件号" }, "cert_type" : { "type" : "string", "description" : "身份证：IDENTITY_CARD、护照：PASSPORT、军官证：OFFICER_CARD、士兵证：SOLDIER_CARD、户口本：HOKOU等。" }, "ext_info" : { "type" : "array", "description" : "扩展信息", "items" : { "$ref" : "#/components/schemas/OrderExtInfo" } }, "mobile" : { "type" : "string", "description" : "手机号" }, "name" : { "type" : "string", "description" : "姓名" }, "open_id" : { "type" : "string", "description" : "用户（user_id）在应用（appId）下的唯一用户标识" }, "user_id" : { "type" : "string", "description" : "支付宝uid" } } }, "UserInvoiceInfoOpenApiResponse" : { "type" : "object", "properties" : { "accept_electronic" : { "type" : "boolean", "description" : "(AR开票使用)是否接受电子票 true:是，false:否", "example" : "true" }, "address" : { "type" : "string", "description" : "公司注册地址", "example" : "广州市增城区新塘镇沿江大道20号1601房" }, "auto" : { "type" : "boolean", "description" : "(AR开票使用)是否自动申请开票 true:是，false:否", "example" : "true" }, "bank_account" : { "type" : "string", "description" : "银行账户", "example" : "3602201309100137669" }, "bank_name" : { "type" : "string", "description" : "开户行", "example" : "中国工商银行广州市第二支行" }, "business_licence_url" : { "type" : "string", "description" : "营业执照地址", "example" : "gfcenter/inv/userinvoicefile/aruserprofilepic_2088721075211978_15133031297372951.jpg" }, "creator" : { "type" : "string", "description" : "资料创建人", "example" : "李某某" }, "gmt_create" : { "type" : "string", "description" : "创建时间", "example" : "1533039333744" }, "gmt_modified" : { "type" : "string", "description" : "修改时间", "example" : "1533039333744" }, "hold" : { "type" : "boolean", "description" : "(AR开票使用)是否暂停开票\r\ttrue:暂停开票，false:可开票", "example" : "true" }, "id" : { "type" : "string", "description" : "开票资料ID", "example" : "2017061410122000544800280000000001" }, "ip_id" : { "type" : "string", "description" : "商户PID,\r\ttype=01时表示OU用户,填充的是InstId机构代码,例如Z50,\r\ttype=02时表示商户MID,\r\ttype=03时表示商户PID", "example" : "10000004" }, "last_modifier" : { "type" : "string", "description" : "最后修改人", "example" : "李某某" }, "open_account_permit_url" : { "type" : "string", "description" : "银行开户许可证地址", "example" : "gfcenter/inv/userinvoicefile/aruserprofilepic_2088721075211978_15133031297372951.jpg" }, "other_qualification_url" : { "type" : "string", "description" : "其它资质证明地址", "example" : "gfcenter/inv/userinvoicefile/aruserprofilepic_2088721075211978_15133031297372951.jpg" }, "status" : { "type" : "string", "description" : "资料状态，01：待审，02：已审(有效)， 03：已作废", "example" : "02" }, "task_date" : { "type" : "string", "description" : "上一次任务执行时间(针对自动开票场景),格式:YYYYMMDD", "example" : "20180723" }, "tax_no" : { "type" : "string", "description" : "纳税人识别号（购方税号）", "example" : "91440106058924978D" }, "tax_payer_qualification" : { "type" : "string", "description" : "纳税人开票资格种类\r\t01：一般纳税人，02：小规模纳税人", "example" : "01" }, "tax_qualification_url" : { "type" : "string", "description" : "一般纳税人资格证书地址", "example" : "gfcenter/inv/userinvoicefile/aruserprofilepic_2088721075211978_15133031297372951.jpg" }, "tax_reg_cert_url" : { "type" : "string", "description" : "税务登记证地址", "example" : "gfcenter/inv/userinvoicefile/aruserprofilepic_2088721075211978_15133031297372951.jpg" }, "taxpayer_quali_valid" : { "type" : "string", "description" : "纳税人资格开始时间 （时间戳）", "example" : "1533039333744" }, "telephone" : { "type" : "string", "description" : "公司注册电话", "example" : "0571-82523768" }, "title" : { "type" : "string", "description" : "发票抬头", "example" : "支付宝" }, "tnt_inst_id" : { "type" : "string", "description" : "租户ID", "example" : "ANTGW2CN" }, "type" : { "type" : "string", "description" : "开票资料用户类型 \r\t01：OU，02：商户，03：C用户", "example" : "02" }, "user_mail_info_list" : { "type" : "array", "description" : "收件人地址列表", "items" : { "$ref" : "#/components/schemas/UserMailInfoVO" } } } }, "UserMailInfoOrder" : { "type" : "object", "properties" : { "city" : { "type" : "string", "description" : "联系所在城市" }, "country" : { "type" : "string", "description" : "联系人国家" }, "county_district" : { "type" : "string", "description" : "联系人所在县/区" }, "detail_address" : { "type" : "string", "description" : "联系所在详细地址" }, "email" : { "type" : "string", "description" : "电子邮箱" }, "ip_role_id" : { "type" : "string", "description" : "商户ipRole(pid)" }, "name" : { "type" : "string", "description" : "联系人名字" }, "province" : { "type" : "string", "description" : "联系人省份" }, "street" : { "type" : "string", "description" : "联系人所在街道" }, "telephone" : { "type" : "string", "description" : "联系人电话" } } }, "UserMailInfoVO" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "收件人地址", "example" : "中国|浙江省|杭州市|西湖区|蒋村街道|10号楼99号" }, "city" : { "type" : "string", "description" : "城市", "example" : "杭州市" }, "country" : { "type" : "string", "description" : "国家", "example" : "中国" }, "county_district" : { "type" : "string", "description" : "县区", "example" : "西湖区" }, "detail_address" : { "type" : "string", "description" : "详细地址", "example" : "10号楼99号" }, "email" : { "type" : "string", "description" : "邮件人的电子邮箱", "example" : "hahaha@alipay.com" }, "gmt_create" : { "type" : "string", "description" : "创建时间", "example" : "1533039333744" }, "gmt_modified" : { "type" : "string", "description" : "修改时间", "example" : "1533039333744" }, "id" : { "type" : "string", "description" : "收件人信息ID", "example" : "2017031410122000565000480000002129" }, "name" : { "type" : "string", "description" : "收件人姓名", "example" : "朱文三" }, "pid" : { "type" : "string", "description" : "pid用于指定该地址归属的PID，应对集团模式的商户所设定,发票邮寄地址根据PID确定", "example" : "2088812004337486" }, "province" : { "type" : "string", "description" : "省份", "example" : "浙江省" }, "street" : { "type" : "string", "description" : "街道", "example" : "蒋村街道" }, "telephone" : { "type" : "string", "description" : "收件人电话", "example" : "0891-3983888" } } }, "UserRiskPrediction" : { "type" : "object", "properties" : { "phone_recycle_risk_leve" : { "type" : "string", "description" : "用户绑定手机号被二次放号风险等级。\tNO_RESULT：手机号风险未入库\tNO_RISK：用户绑定手机无二次放号风险，高置信度\tLOW_RISK：用户绑定手机二次放号风险较小，商户自行决策是否相信。\tHIGH_RISK：用户绑定手机已被放号，高置信度", "example" : "HIGH_RISK" }, "refused_payment_risk_level" : { "type" : "string", "description" : "用户拒付风险等级。\tNO_SIGN：商户未签约。\tNO_RESULT：未查询到账户信息。\tLOW_RISK：用户拒付风险为低；处理建议：用户可以先享受服务，再进行支付。\tMEDIUM_RISK：用户拒付风险为中；处理建议：根据业务场景客户自行判断提供或者不提供。\tHIGH_RISK：用户拒付风险为高；处理建议：不建议先提供给用户服务。", "example" : "HIGH_RISK" } } }, "UserTradeInfoDTO" : { "type" : "object", "properties" : { "goods_info_list" : { "type" : "array", "description" : "商品信息列表", "items" : { "$ref" : "#/components/schemas/GoodsInfoDTO" } }, "partner_id" : { "type" : "string", "description" : "球房ISV的PID", "example" : "208881123" }, "risk_level" : { "type" : "string", "description" : "是否是风险交易：NO_RISK-无风险；POTENTIAL_RISK-潜在风险（中等风险）；HIGH_RISK-高风险", "example" : "NO_RISK" }, "trade_amount" : { "type" : "string", "description" : "交易总金额，单位元，精确两位小数点", "example" : "68.12" }, "trade_no" : { "type" : "string", "description" : "交易单号", "example" : "202110000111" }, "trade_time" : { "type" : "string", "description" : "交易时间", "example" : "2022-02-11 00:00:00" }, "unfiltered_total_goods_count" : { "type" : "integer", "description" : "商品数据会根据活动商品列表进行过滤，该字段代表未过滤的商品列表大小", "example" : "100" }, "user_id" : { "type" : "string", "description" : "消费者支付宝ID", "example" : "2088111" } } }, "UserVoucherBaseInfo" : { "type" : "object", "properties" : { "associate_trade_no" : { "type" : "string", "description" : "若商家券操作过关联商户订单信息，则该字段返回商家券已关联的商户订单号。" }, "create_time" : { "type" : "string", "description" : "领券时间" }, "valid_begin_time" : { "type" : "string", "description" : "券可使用的开始时间。 格式为：yyyy-MM-dd HH:mm:ss" }, "valid_end_time" : { "type" : "string", "description" : "券可使用的结束时间。 格式为yyyy-MM-dd HH:mm:ss" }, "voucher_id" : { "type" : "string", "description" : "支付宝券id" }, "voucher_max_use_times" : { "type" : "integer", "description" : "券最大核销次数" }, "voucher_name" : { "type" : "string", "description" : "券名称" }, "voucher_status" : { "type" : "string", "description" : "券状态。SENDED:可用 USED:已核销(即完全使用), EXPIRED:已过期(只能查询6个月内数据)" }, "voucher_used_times" : { "type" : "integer", "description" : "券已核销次数" } } }, "UserVoucherInfo" : { "type" : "object", "properties" : { "activity_base_info" : { "$ref" : "#/components/schemas/ActivityBaseInfo" }, "activity_id" : { "type" : "string", "description" : "活动 id。", "example" : "2016042700826004508401111111" }, "available_begin_time" : { "type" : "string", "description" : "券可用开始时间。", "example" : "2017-01-01 00:00:01" }, "available_end_time" : { "type" : "string", "description" : "券可用结束时间。", "example" : "2017-01-01 00:00:01" }, "belong_merchant_id" : { "type" : "string", "description" : "券归属商户 pid。", "example" : "2088102111111111" }, "create_time" : { "type" : "string", "description" : "用户领券时间。", "example" : "2017-01-01 00:00:01" }, "user_voucher_base_info" : { "$ref" : "#/components/schemas/UserVoucherBaseInfo" }, "voucher_available_scope_info" : { "$ref" : "#/components/schemas/VoucherAvailableScopeInfo" }, "voucher_customer_guide_info" : { "$ref" : "#/components/schemas/VoucherCustomerGuideInfo" }, "voucher_deduct_info" : { "$ref" : "#/components/schemas/VoucherDeductInfo" }, "voucher_display_lite_info" : { "$ref" : "#/components/schemas/CommonVoucherDisplayLiteInfo" }, "voucher_display_pattern_info" : { "$ref" : "#/components/schemas/VoucherDisplayPatternInfo" }, "voucher_id" : { "type" : "string", "description" : "用户券 id。支付宝为用户优惠券唯一分配的 id。", "example" : "2021072900073002214009F8QHR3" }, "voucher_name" : { "type" : "string", "description" : "券名称。展示在支付宝卡包中的券名称。", "example" : "满10减1" }, "voucher_send_mode_info" : { "$ref" : "#/components/schemas/VoucherSendModeInfo" }, "voucher_status" : { "type" : "string", "description" : "券状态。", "example" : "SENDED" }, "voucher_type" : { "type" : "string", "description" : "券类型。", "example" : "FIX_VOUCHER" }, "voucher_use_rule_info" : { "$ref" : "#/components/schemas/VoucherUseRuleInfo" }, "voucher_use_rule_lite_info" : { "$ref" : "#/components/schemas/CommonVoucherUseRuleLiteInfo" } } }, "ViolationEvent" : { "type" : "object", "properties" : { "can_appeal" : { "type" : "boolean", "description" : "商家是否可以申诉", "example" : "true" }, "can_rectify" : { "type" : "boolean", "description" : "商家是否可以整改", "example" : "true" }, "punish_action" : { "type" : "string", "description" : "处罚动作及有效期", "example" : "[ \"警告_2020-02-14 14:23:12-2020-03-14 14:23:12\",\"小程序应用下架_2020-02-14 14:23:12-2020-03-14 14:23:12\"]" }, "status" : { "type" : "string", "description" : "违规工单状态枚举：\tPUNISH_DONE：处罚生效中\tPUNISH_APPEAL_REVOKED：处罚已撤销\tPUNISH_INVALID_REVOKED：处罚已到期\tWAITING_RECTIFY：待整改 \tRECTIFY_AUDITOR_PROCESSING：整改审核中\tRECTIFY_REJECTED：整改不通过\tRECTIFY_PASSED：整改通过\tRECTIFY_TIMEOUT ：整改已超时", "example" : "PUNISH_DONE" }, "target_id" : { "type" : "string", "description" : "违规对象ID", "example" : "2022000000000011" }, "target_name" : { "type" : "string", "description" : "违规对象名称", "example" : "xxx测试小程序" }, "target_type" : { "type" : "string", "description" : "违规对象类型\t小程序ID:APPID \t生活号ID:PUBLICID", "example" : "APPID" }, "violation_record_id" : { "type" : "string", "description" : "违规记录ID", "example" : "202201001200001001" }, "violation_time" : { "type" : "string", "description" : "违规时间", "example" : "2020-01-01 00:00:01" }, "violation_type" : { "type" : "string", "description" : "即平台依据平台规范/规则，判定商户的违规类型", "example" : "数据和系统安全/敏感参数泄露风险" } } }, "Voucher" : { "type" : "object", "properties" : { "allow_split" : { "type" : "boolean", "description" : "是否允许拆分，券在核销的时候是否允许券的面额拆分使用。(仅限渠道类型为ISV企业福利：ISV_ENTERPRISE_BENIFIT的场景使用)", "example" : "false" }, "available_amount" : { "type" : "string", "description" : "券剩余面额，单位元\r\t券详情查询接口返回，可拆分券中的券详情展示用", "example" : "100" }, "brand_name" : { "type" : "string", "description" : "券副标题", "example" : "券副标题" }, "clause_terms" : { "type" : "array", "description" : "券的说明条款", "items" : { "$ref" : "#/components/schemas/ClauseTerm" } }, "delay_info" : { "$ref" : "#/components/schemas/DelayInfo" }, "desc" : { "type" : "string", "description" : "券详细说明\r\t最多包含500个字符", "example" : "券的详细说明" }, "desc_detail_list" : { "type" : "array", "description" : "券使用说明描述列表", "items" : { "$ref" : "#/components/schemas/VoucherDescDetail" } }, "display_config" : { "$ref" : "#/components/schemas/DisplayConfig" }, "donate_flag" : { "type" : "string", "description" : "券是否可转赠，默认为可转赠", "example" : "true" }, "effect_type" : { "type" : "string", "description" : "券生效的方式，目前支持以下方式\r\t立即生效：IMMEDIATELY\r\t延迟生效：DELAY\r\t仅在券有效期类型为相对有效期时生效", "example" : "IMMEDIATELY" }, "end_time" : { "type" : "string", "description" : "券有效期的结束时间\r\t仅在券有效期类型为绝对有效期时生效\r\t必须晚于活动结束时间", "example" : "2016-11-01 00:00:00" }, "ext_info" : { "type" : "string", "description" : "券的扩展信息", "example" : "\"key\":\"value\"" }, "item_info" : { "$ref" : "#/components/schemas/ItemInfo" }, "logo" : { "type" : "string", "description" : "券LOGO文件ID，调用图片上传接口alipay.offline.material.image.upload获得", "example" : "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC" }, "max_amount" : { "type" : "string", "description" : "最高优惠金额，单位元\r\t指用券最高可以优惠的金额\r\t必须为合法金额类型字符串仅当券类型为折扣券（RATE），每满减券（PER_FULL_CUT）有效", "example" : "100" }, "multi_use_mode" : { "type" : "string", "description" : "券叠加的属性，\r\t仅全场券可设置该选项；\r\tNO_MULTI:不可与其他全场券和单品券叠加;\r\tMULTI_USE_WITH_SINGLE:\r\t该全场优惠和单品优惠的叠加\r\t；MULTI_USE_WITH_OTHE\r\tRS:该全场优惠和其他所有优惠都可以叠加", "example" : "NO_MULTI" }, "name" : { "type" : "string", "description" : "名称", "example" : "券的名称" }, "rate" : { "type" : "string", "description" : "折扣率\r\t仅当券类型为折扣券时有效\r\t有效折扣率取值范围0.11-0.99\r\t仅允许保留小数点后两位", "example" : "0.8" }, "relative_time" : { "type" : "string", "description" : "券相对有效期，单位天\r\t仅在券有效期类型为相对有效期时生效\r\t如，设5表示领券领取后5日内有效", "example" : "1" }, "rounding_rule" : { "type" : "string", "description" : "券核销时，抹零方式，目前支持：\tNOT_AUTO_ROUNDING:不自动抹零\tAUTO_ROUNDING_YUAN:自动抹零到元\tAUTO_ROUNDING_JIAO:自动抹零到角\tROUNDING_UP_YUAN:四舍五入到元\tROUNDING_UP_JIAO:四舍五入到角", "example" : "NOT_AUTO_ROUNDING" }, "start_time" : { "type" : "string", "description" : "券有效期的开始时间\r\t仅在券有效期类型为绝对有效期时生效", "example" : "2016-05-01 00:00:00" }, "type" : { "type" : "string", "description" : "券类型，目前支持以下类型：\r\tEXCHANGE：兑换券；\r\tMONEY：代金券；\r\tREDUCETO：减至券；\r\tRATE：折扣券；\r\tPER_FULL_CUT：每满减券", "example" : "MONEY" }, "use_instructions" : { "type" : "array", "description" : "券的使用说明\r\t使用须知最多6条，且每条最多100字", "items" : { "type" : "string" }, "example" : "券的使用说明" }, "use_rule" : { "$ref" : "#/components/schemas/UseRule" }, "validate_type" : { "type" : "string", "description" : "券有效期类型，目前支持以下类型：\r\tRELATIVE：相对有效期\r\tFIXED：绝对有效期", "example" : "FIXED" }, "verify_mode" : { "type" : "string", "description" : "该字段仅在兑换券条件下(即券类型为EXCHANGE)，用于设置兑换券的核销方式\r\tUSER_CLICK:用户自己点击券上的按钮核销\r\tMERCHANT_SCAN：商户通过APP扫码核销\r\t其他情况下此字段为空", "example" : "MERCHANT_SCAN" }, "voucher_img" : { "type" : "string", "description" : "券图片文件ID,调用上传图片接口alipay.offline.material.image.upload获得", "example" : "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC" }, "voucher_note" : { "type" : "string", "description" : "券的备注\r\t\r\t用于收银系统识别指定券使用；如备注中传入“123”，券发出后核销时将在当面付接口将该值传回，供收银系统识别", "example" : "券的备注" }, "worth_value" : { "type" : "string", "description" : "券面额，单位元必须为合法金额类型字符串券类型为代金券（MONEY）、减至券（REDUCETO）、每满减券（PER_FULL_CUT）时必填\r\t如：\r\t代金券：10元代金券中的10为券面额；\r\t每满减券：毎满100减10元，其中的10为券面额；\r\t减至券：单品原价100，现价10元，其中10为券面额，单品减至券的券面额必须低于单品原价", "example" : "10" } } }, "VoucherAbsolutePeriodInfo" : { "type" : "object", "properties" : { "time_restrict_info" : { "$ref" : "#/components/schemas/TimeRestrictInfo" }, "valid_begin_time" : { "type" : "string", "description" : "券可使用的开始时间。 格式为：yyyy-MM-dd HH:mm:ss。" }, "valid_end_time" : { "type" : "string", "description" : "券可使用的结束时间。 格式为yyyy-MM-dd HH:mm:ss。" } } }, "VoucherAvailableAccountInfo" : { "type" : "object", "properties" : { "available_pids" : { "type" : "array", "description" : "优惠券可核销的直连商户PID", "items" : { "type" : "string" } }, "available_smids" : { "type" : "array", "description" : "优惠券可核销的间连商户SMID", "items" : { "type" : "string" } } } }, "VoucherAvailableAppInfo" : { "type" : "object", "properties" : { "available_app_ids" : { "type" : "array", "description" : "可核销的支付宝小程序id", "items" : { "type" : "string" } } } }, "VoucherAvailableGeographyAllShopInfo" : { "type" : "object", "properties" : { "exclude_shop_ids" : { "type" : "array", "description" : "券不可使用的球房列表。指定商户全部球房可用时可通过该字段排除部分不可用球房。 列表中的球房id是通过调用接口ant.merchant.expand.shop.create创建球房返回的支付宝球房id 接口参数是列表类型。", "items" : { "type" : "string" } }, "merchant_ids" : { "type" : "array", "description" : "全部球房可用的商户ID", "items" : { "type" : "string" } } } }, "VoucherAvailableGeographyAllShopResultInfo" : { "type" : "object", "properties" : { "fail_exclude_shop_infos" : { "type" : "array", "description" : "请求失败的不可用球房详情。", "items" : { "$ref" : "#/components/schemas/VoucherFailShopInfo" } }, "success_exclude_shop_ids" : { "type" : "array", "description" : "请求成功的不可用球房列表。", "items" : { "type" : "string" } } } }, "VoucherAvailableGeographyCityInfo" : { "type" : "object", "properties" : { "all_city" : { "type" : "boolean", "description" : "是否全国。 选择全国后，无须填写city_codes字段。系统默认填充全国全部城市信息。" }, "available_city_codes" : { "type" : "array", "description" : "城市编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 （参考资料： http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/）", "items" : { "type" : "string" } } } }, "VoucherAvailableGeographyScopeInfo" : { "type" : "object", "properties" : { "available_geography_city_info" : { "$ref" : "#/components/schemas/VoucherAvailableGeographyCityInfo" }, "available_geography_scope_type" : { "type" : "string", "description" : "券可用地理位置类型。" }, "available_geography_shop_info" : { "$ref" : "#/components/schemas/VoucherAvailableGeographyShopInfo" } } }, "VoucherAvailableGeographyScopeResultInfo" : { "type" : "object", "properties" : { "available_geography_shop_result_info" : { "$ref" : "#/components/schemas/VoucherAvailableGeographyShopResultInfo" } } }, "VoucherAvailableGeographyShopInfo" : { "type" : "object", "properties" : { "available_geography_all_shop" : { "$ref" : "#/components/schemas/VoucherAvailableGeographyAllShopInfo" }, "available_real_shop_ids" : { "type" : "array", "description" : "代运营商业关系球房列表，列表中的球房id是调用接口alipay.business.relation.shop.create创建球房返回的real_shop_id 接口参数是列表类型。", "items" : { "type" : "string" } }, "available_shop_ids" : { "type" : "array", "description" : "券可使用的球房列表。列表中的球房id是通过调用接口ant.merchant.expand.shop.create创建球房返回的支付宝球房id 接口参数是列表类型。", "items" : { "type" : "string" } } } }, "VoucherAvailableGeographyShopResultInfo" : { "type" : "object", "properties" : { "available_geography_all_shop_result_info" : { "$ref" : "#/components/schemas/VoucherAvailableGeographyAllShopResultInfo" }, "fail_available_real_shop_infos" : { "type" : "array", "description" : "失败的物理球房详情。", "items" : { "$ref" : "#/components/schemas/VoucherFailShopInfo" } }, "fail_available_shop_infos" : { "type" : "array", "description" : "失败的可用球房。", "items" : { "$ref" : "#/components/schemas/VoucherFailShopInfo" } }, "success_available_real_shop_ids" : { "type" : "array", "description" : "代运营商业关系球房列表，列表中的球房id是调用接口alipay.business.relation.shop.create创建球房返回的real_shop_id 接口参数是列表类型。", "items" : { "type" : "string" } }, "success_available_shop_ids" : { "type" : "array", "description" : "券可使用的球房列表。列表中的球房id是通过调用接口ant.merchant.expand.shop.create创建球房返回的支付宝球房id 接口参数是列表类型。", "items" : { "type" : "string" } } } }, "VoucherAvailableGoodsInfo" : { "type" : "object", "properties" : { "available_goods_sku_ids" : { "type" : "array", "description" : "可优惠商品编码，商家自定义商品编码。当用户支付时，交易中的商品编码和支付券配置的商品编码有任一匹配时，可以使用优惠券。", "items" : { "type" : "string" } }, "exclude_goods_sku_ids" : { "type" : "array", "description" : "不可核销商品编码，商家自定义商品编码。当用户支付时，交易中的商品编码和支付券配置的商品编码有任一匹配时，不可以使用优惠券。", "items" : { "type" : "string" } }, "goods_description" : { "type" : "string", "description" : "商品描述" }, "goods_detail" : { "type" : "string", "description" : "商品详情，会展示在特定渠道(如服务市场团购业务插件的套餐明细)。" }, "goods_detail_images" : { "type" : "array", "description" : "商品详情图片列表，会展示在特定渠道(如服务市场团购业务插件的头图)", "items" : { "type" : "string" } }, "goods_detail_rich_description" : { "type" : "string", "description" : "商品详情富文本描述" }, "goods_name" : { "type" : "string", "description" : "商品名称。" }, "origin_amount" : { "type" : "string", "description" : "商品原价" } } }, "VoucherAvailableScope" : { "type" : "object", "properties" : { "order_voucher_available_city_code" : { "$ref" : "#/components/schemas/OrderVoucherAvailableCityCode" }, "order_voucher_available_shop" : { "$ref" : "#/components/schemas/OrderVoucherAvailableShop" }, "voucher_available_type" : { "type" : "string", "description" : "可用范围类型。" } } }, "VoucherAvailableScopeInfo" : { "type" : "object", "properties" : { "voucher_available_account_info" : { "$ref" : "#/components/schemas/VoucherAvailableAccountInfo" }, "voucher_available_app_info" : { "$ref" : "#/components/schemas/VoucherAvailableAppInfo" }, "voucher_available_geography_scope_info" : { "$ref" : "#/components/schemas/VoucherAvailableGeographyScopeInfo" }, "voucher_available_goods_info" : { "$ref" : "#/components/schemas/VoucherAvailableGoodsInfo" } } }, "VoucherAvailableScopeModify" : { "type" : "object", "properties" : { "modify_type" : { "type" : "string", "description" : "可用范围修改类型。", "example" : "ADD" }, "order_voucher_available_city_code" : { "$ref" : "#/components/schemas/OrderVoucherAvailableCityCodeModify" }, "order_voucher_available_shop" : { "$ref" : "#/components/schemas/OrderVoucherAvailableShopModify" } } }, "VoucherAvailableScopeResultInfo" : { "type" : "object", "properties" : { "voucher_available_geography_scope_result_info" : { "$ref" : "#/components/schemas/VoucherAvailableGeographyScopeResultInfo" } } }, "VoucherBalanceRechargeInfo" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "支付宝余额充值金额\t 限制： \t1.币种为人民币，单位元。 \t2. 总预算=优惠金额*总发券张数" }, "logon_id" : { "type" : "string", "description" : "出资的商户支付宝登录账号 \t限制: \tlogon_id和partner_id必须且只能二选一" }, "partner_id" : { "type" : "string", "description" : "出资的商户支付宝ID \t限制: \tlogon_id和partner_id必须且只能二选一" } } }, "VoucherBudgetSupplyInfo" : { "type" : "object", "properties" : { "budget_type" : { "type" : "string", "description" : "营销资金预算类型 \t枚举值: \tNO_CASH 免充值 \tRECHARGE 预充值 \t\t1、免充值：制券方无需提前充值资金，用户核销支付券时，直接从订单原价中扣除优惠减价金额，最终只将用户实际支付的金额结算给核销商户，商户实收少于订单原价。 \t2.预充值: 制券方需将优惠预算提前充值到支付宝指定营销账户中，用户核销支付券时，系统从该账户可用余额中扣除优惠减价部分对应的资金，连同用户实际支付的资金，一并结算给核销商户，不影响实收。" }, "voucher_recharge_info" : { "$ref" : "#/components/schemas/VoucherRechargeInfo" } } }, "VoucherConsultInfo" : { "type" : "object", "properties" : { "ceiling_amount" : { "type" : "string", "description" : "封顶优惠金额，单位为元", "example" : "4.0" }, "item_promo_info" : { "$ref" : "#/components/schemas/ItemPromoInfo" }, "optimal" : { "type" : "boolean", "description" : "是否为可使用的互斥券中最优的（目前返回的记录该值均为true，即可忽略该值判断）", "example" : "true" }, "promo_amount" : { "type" : "string", "description" : "优惠总金额，单位为元", "example" : "30.00" }, "promo_text" : { "type" : "string", "description" : "优惠文案", "example" : "大杯拿铁限时享受满10减1" }, "promo_type" : { "type" : "string", "description" : "优惠类型： 代金(FIX),折扣(DISCOUNT),减至(SPECIAL，即特价券)", "example" : "FIX" }, "reduction_amount" : { "type" : "string", "description" : "满减金额，单位为元，仅针对代金券", "example" : "2.0" }, "reduction_ratio" : { "type" : "string", "description" : "优惠额度，如3折券，返回0.7，仅针对折扣券", "example" : "0.7" }, "specified_amount" : { "type" : "string", "description" : "减至金额，单位为元，仅针对减至券", "example" : "32.0" }, "threshold_amount" : { "type" : "string", "description" : "优惠门槛，单位为元（部分券没有门槛金额）", "example" : "120.00" }, "voucher_id" : { "type" : "string", "description" : "券id", "example" : "202010220007300232330005DGEE" }, "voucher_name" : { "type" : "string", "description" : "券名称", "example" : "商家全场5折优惠" }, "voucher_type" : { "type" : "string", "description" : "券类型： 1）全场券(ALL) 2）单品券(ITEM)", "example" : "ALL" } } }, "VoucherCustomerGuideInfo" : { "type" : "object", "properties" : { "voucher_send_guide_info" : { "$ref" : "#/components/schemas/VoucherSendGuideInfo" }, "voucher_use_guide_info" : { "$ref" : "#/components/schemas/VoucherUseGuideInfo" } } }, "VoucherDeductInfo" : { "type" : "object", "properties" : { "customer_define_voucher_info" : { "$ref" : "#/components/schemas/CustomerDefineVoucherInfo" }, "discount_voucher_info" : { "$ref" : "#/components/schemas/DiscountVoucherInfo" }, "exchange_voucher_info" : { "$ref" : "#/components/schemas/ExchangeVoucherInfo" }, "fix_voucher_info" : { "$ref" : "#/components/schemas/FixVoucherInfo" }, "special_voucher_info" : { "$ref" : "#/components/schemas/SpecialVoucherInfo" }, "voucher_type" : { "type" : "string", "description" : "券类型。" } } }, "VoucherDeductThresholdInfo" : { "type" : "object", "properties" : { "customer_define_voucher_threshold_desc" : { "type" : "string", "description" : "自定义门槛描述" }, "voucher_express_info" : { "$ref" : "#/components/schemas/VoucherExpressInfo" }, "voucher_goods_quantity_specification_info" : { "$ref" : "#/components/schemas/VoucherGoodsQuantitySpecificationInfo" } } }, "VoucherDescDetail" : { "type" : "object", "properties" : { "details" : { "type" : "array", "description" : "具体描述信息列表", "items" : { "type" : "string" }, "example" : "周一到周五可用" }, "images" : { "type" : "array", "description" : "图片描述信息", "items" : { "type" : "string" }, "example" : "https://dl.django.t.taobao.com/rest/1.0/image?fileIds=RY7twkJVR26nz8OeXRIjvAAAACMAAQED&zoom=original" }, "title" : { "type" : "string", "description" : "券说明的标题", "example" : "温馨提示" }, "url" : { "type" : "string", "description" : "券外部详情描述", "example" : "www.alipay.com" } } }, "VoucherDetail" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "优惠券面额，它应该会等于商家出资加上其他出资方出资" }, "id" : { "type" : "string", "description" : "券id" }, "memo" : { "type" : "string", "description" : "优惠券备注信息" }, "merchant_contribute" : { "type" : "string", "description" : "商家出资（特指发起交易的商家出资金额）" }, "name" : { "type" : "string", "description" : "券名称" }, "other_contribute" : { "type" : "string", "description" : "其他出资方出资金额，可能是支付宝，可能是品牌商，或者其他方，也可能是他们的一起出资" }, "other_contribute_detail" : { "type" : "array", "description" : "优惠券的其他出资方明细", "items" : { "$ref" : "#/components/schemas/ContributeDetail" } }, "purchase_ant_contribute" : { "type" : "string", "description" : "如果使用的这张券是用户购买的，则该字段代表用户在购买这张券时平台优惠的金额" }, "purchase_buyer_contribute" : { "type" : "string", "description" : "如果使用的这张券是用户购买的，则该字段代表用户在购买这张券时用户实际付款的金额" }, "purchase_merchant_contribute" : { "type" : "string", "description" : "如果使用的这张券是用户购买的，则该字段代表用户在购买这张券时商户优惠的金额" }, "template_id" : { "type" : "string", "description" : "券模板id" }, "type" : { "type" : "string", "description" : "券类型，如：\tALIPAY_FIX_VOUCHER - 全场代金券\tALIPAY_DISCOUNT_VOUCHER - 折扣券\tALIPAY_ITEM_VOUCHER - 单品优惠券\tALIPAY_CASH_VOUCHER - 现金抵价券\tALIPAY_BIZ_VOUCHER - 商家全场券\t注：不排除将来新增其他类型的可能，商家接入时注意兼容性避免硬编码" } } }, "VoucherDisplayInfo" : { "type" : "object", "properties" : { "brand_logo" : { "type" : "string", "description" : "商家logo。需要通过\talipay.marketing.material.image.upload接口上传图片，指定file_key为PROMO_BRAND_LOGO，返回的resource_id即为该参数的值" }, "brand_name" : { "type" : "string", "description" : "商户品牌名称。如果不设置品牌名称，则默认使用支付宝商家系统中维护的商家别名。如果没有维护商家别名，则使用默认名称：商家优惠。用户领取优惠券后，品牌名称会对用户进行展示" }, "customer_service_mobile" : { "type" : "string", "description" : "客服电话" }, "customer_service_url" : { "type" : "string", "description" : "客服链接" }, "voucher_comment" : { "type" : "string", "description" : "券补充说明，该字段为可运营字段，可描述商品特色\t会展示在用户支付宝卡包券详情页" }, "voucher_description" : { "type" : "string", "description" : "券详细使用说明。" }, "voucher_detail_images" : { "type" : "array", "description" : "券详细图列表，会展示在用户支付宝卡包券详情页。需要通过\talipay.marketing.material.image.upload接口上传图片，指定file_key为PROMO_VOUCHER_DETAIL_IMAGE\t,接口返回的resource_id即为该参数的值。上传图片尺寸600*600，支持格式：png、jpg、jpeg、bmp，大小不超过2MB。", "items" : { "type" : "string" } }, "voucher_image" : { "type" : "string", "description" : "券详情页封面图，会展示在用户支付宝卡包券详情页。需要通过\talipay.marketing.material.image.upload接口上传图片，指定file_key为PROMO_VOUCHER_IMAGE，接口返回的resource_id即为该参数的值" } } }, "VoucherDisplayInfoModify" : { "type" : "object", "properties" : { "brand_logo" : { "type" : "string", "description" : "商家logo \t需要通过 alipay.marketing.material.image.upload接口上传图片，指定file_key为PROMO_BRAND_LOGO，返回的resource_id即为该参数的值", "example" : "adeDSktiQO-u5vJUqVbcQwAAACMAAQED" }, "brand_name" : { "type" : "string", "description" : "商户品牌名称。", "example" : "商家优惠" }, "customer_service_mobile" : { "type" : "string", "description" : "客服电话", "example" : "81XXXXXXX" }, "customer_service_url" : { "type" : "string", "description" : "客服链接", "example" : "alipay://xxxx" }, "voucher_comment" : { "type" : "string", "description" : "券补充说明，该字段为可运营字段，可描述商品特色 会展示在用户支付宝卡包券详情页。", "example" : "食材新鲜，品质之选" }, "voucher_description" : { "type" : "string", "description" : "券详细使用说明。", "example" : "1、本券不可兑换现金，不可找零。2、每个用户最多可以领取1张。3、如果订单发生退款，优惠券无法退还。" }, "voucher_detail_images" : { "type" : "array", "description" : "券详细图列表，会展示在用户支付宝卡包券详情页 需要通过 alipay.marketing.material.image.upload接口上传图片，指定file_key为PROMO_VOUCHER_DETAIL_IMAGE ,接口返回的resource_id即为该参数的值 上传图片尺寸600*600，支持格式：png、jpg、jpeg、bmp，大小不超过2MB。", "items" : { "type" : "string" }, "example" : "[\"adeDSktiQO-u5vJUqVbcQwAAACMAAQE1\",\"adeDSktiQO-u5vJUqVbcQwAAACMAAQE2\",\"adeDSktiQO-u5vJUqVbcQwAAACMAAQE3\"]" }, "voucher_image" : { "type" : "string", "description" : "券详情页封面图，会展示在用户支付宝卡包券详情页 需要通过 alipay.marketing.material.image.upload接口上传图片，指定file_key为PROMO_VOUCHER_IMAGE，接口返回的resource_id即为该参数的值。", "example" : "adeDSktiQO-u5vJUqVbcQwAAACMAAQED" } } }, "VoucherDisplayPatternInfo" : { "type" : "object", "properties" : { "brand_logo" : { "type" : "string", "description" : "商家logo 需要通过 alipay.marketing.material.image.upload接口上传图片，指定file_key为PROMO_BRAND_LOGO，返回的resource_id即为该参数的值。" }, "brand_logo_url" : { "type" : "string", "description" : "商家品牌logo链接" }, "brand_name" : { "type" : "string", "description" : "商户品牌名称。 如果不设置品牌名称，则默认使用支付宝商家系统中维护的商家别名。 如果没有维护商家别名，则使用默认名称： 商家优惠。 用户领取优惠券后，品牌名称会对用户进行展示。" }, "customer_service_mobile" : { "type" : "string", "description" : "客服电话。" }, "customer_service_url" : { "type" : "string", "description" : "客服链接。" }, "voucher_description" : { "type" : "string", "description" : "券详细使用说明。" }, "voucher_detail_image_urls" : { "type" : "array", "description" : "券详情链接", "items" : { "type" : "string" } }, "voucher_detail_images" : { "type" : "array", "description" : "券详细图列表，会展示在用户支付宝卡包券详情页 需要通过 alipay.marketing.material.image.upload接口上传图片，指定file_key为PROMO_VOUCHER_DETAIL_IMAGE ,接口返回的resource_id即为该参数的值 上传图片尺寸600*600，支持格式：png、jpg、jpeg、bmp，大小不超过2MB。", "items" : { "type" : "string" } }, "voucher_image" : { "type" : "string", "description" : "券详情页封面图，会展示在用户支付宝卡包券详情页。\t需要通过 alipay.marketing.material.image.upload接口上传图片，指定file_key为PROMO_VOUCHER_IMAGE，接口返回的resource_id即为该参数的值。" }, "voucher_image_url" : { "type" : "string", "description" : "券封面链接" }, "voucher_name" : { "type" : "string", "description" : "券名称。" } } }, "VoucherExchangeGoodsInfo" : { "type" : "object", "properties" : { "exchange_goods_name" : { "type" : "string", "description" : "兑换商品名称" } } }, "VoucherExpressInfo" : { "type" : "object", "properties" : { "pay_express" : { "type" : "string", "description" : "邮费标识，属于券的服务，用于用户门槛信息展示" } } }, "VoucherFailShopInfo" : { "type" : "object", "properties" : { "fail_message" : { "type" : "string", "description" : "请求失败提示信息。" }, "fail_reasons" : { "type" : "array", "description" : "请求失败的原因。", "items" : { "type" : "string" } }, "real_shop_id" : { "type" : "string", "description" : "请求失败的物理球房 id。" }, "shop_id" : { "type" : "string", "description" : "请求失败的支付球房 ID。" } } }, "VoucherFileInfo" : { "type" : "object", "properties" : { "file_download_url" : { "type" : "string", "description" : "发票文件下载" }, "file_name" : { "type" : "string", "description" : "文件名" }, "file_type" : { "type" : "string", "description" : "文件类型" } } }, "VoucherGoodsQuantitySpecificationInfo" : { "type" : "object", "properties" : { "directional_type" : { "type" : "string", "description" : "定向类型用于规格设置，比如：FIX 表示 固定满X件，APPOINT 表示指定第N件" }, "specification_quantity" : { "type" : "integer", "description" : "数量" }, "specification_unit" : { "type" : "string", "description" : "单位" } } }, "VoucherInventoryInfo" : { "type" : "object", "properties" : { "send_count" : { "type" : "integer", "description" : "已发放数量。" }, "use_count" : { "type" : "integer", "description" : "已核销数量。" } } }, "VoucherMiniAppSendGuideInfo" : { "type" : "object", "properties" : { "mini_app_url" : { "type" : "string", "description" : "小程序发券链接" } } }, "VoucherMiniAppUseGuideInfo" : { "type" : "object", "properties" : { "mini_app_service_codes" : { "type" : "array", "description" : "小程序服务编码，通过 alipay.open.app.appcontent.function.create(小程序服务创建)接口创建服务后获取。", "items" : { "type" : "string" } }, "mini_app_url" : { "type" : "string", "description" : "小程序核销链接" } } }, "VoucherPackageActivityInfo" : { "type" : "object", "properties" : { "activity_base_info" : { "$ref" : "#/components/schemas/ActivityBaseInfo" }, "voucher_available_scope_info" : { "$ref" : "#/components/schemas/VoucherAvailableScopeInfo" }, "voucher_deduct_info" : { "$ref" : "#/components/schemas/VoucherDeductInfo" }, "voucher_display_pattern_info" : { "$ref" : "#/components/schemas/VoucherDisplayPatternInfo" }, "voucher_send_mode_info" : { "$ref" : "#/components/schemas/VoucherSendModeInfo" }, "voucher_use_rule_info" : { "$ref" : "#/components/schemas/VoucherUseRuleInfo" } } }, "VoucherPackageBaseInfo" : { "type" : "object", "properties" : { "purchase_end_time" : { "type" : "string", "description" : "券包购买结束时间" }, "purchase_start_time" : { "type" : "string", "description" : "券包购买开始时间" }, "voucher_package_id" : { "type" : "string", "description" : "券包id" }, "voucher_package_name" : { "type" : "string", "description" : "券包名称" }, "voucher_package_status" : { "type" : "string", "description" : "券包状态。 CREATED：已创建, ENABLE： 已发布（包含进行中和已过期，已过期以voucher_package_purchase_end_time为准）, PAUSED： 已暂停, DISABLE： 已停止;" }, "voucher_total_amount" : { "type" : "string", "description" : "券包总价值（单位是元）： 券包下券的优惠总额（满减券指优惠面额，折扣券指优惠上限，特价券指原价减去特价）" } } }, "VoucherPackageConsultResult" : { "type" : "object", "properties" : { "consult_result_code" : { "type" : "string", "description" : "券包购买咨询结果code：\tSUCCESS：可以领取；\tPRODUCT_NOT_ENABLE：产品不可用；\tNOT_IN_SELL_TIME：不在销售时间内；\tPRODUCT_SOLD_OUT：产品售罄；\tUSER_PURCHASE_LIMIT：用户购买上限；\tOTHER：不可购买，未知原因", "example" : "SUCCESS" }, "voucher_package_id" : { "type" : "string", "description" : "券包id", "example" : "IP20220628016671405804297103167741" } } }, "VoucherPackageInfo" : { "type" : "object", "properties" : { "voucher_package_base_info" : { "$ref" : "#/components/schemas/VoucherPackageBaseInfo" }, "voucher_package_sales_lite_info" : { "$ref" : "#/components/schemas/VoucherPackageSalesLiteInfo" } } }, "VoucherPackageModeInfo" : { "type" : "object", "properties" : { "voucher_package_id" : { "type" : "string", "description" : "券包id，对应alipay.marketing.activity.voucherpackage.query中voucher_package_id。" } } }, "VoucherPackageSalesInfo" : { "type" : "object", "properties" : { "budget" : { "type" : "integer", "description" : "券包售卖预算，单位是份数", "example" : "1000" }, "pay_channel" : { "type" : "string", "description" : "券包购买支付渠道\tpcredit：花呗\tcreditCard：信用卡\tcredit_group：花呗与信用卡\t为空则不限渠道", "example" : "pcredit" }, "purchase_url" : { "type" : "string", "description" : "券包购买链接", "example" : "http://123.htm" }, "sale_count_limit_in_period" : { "type" : "integer", "description" : "券包售卖期限内最大购买次数", "example" : "5" }, "sale_period_limit" : { "type" : "string", "description" : "券包购买期限类型\tNO：不限制 \tALL：售卖时间内 \tDAY：天 \tWEEK：周 \tMONTH：月", "example" : "NO" }, "sale_price" : { "type" : "string", "description" : "券包售卖价格，单位是元", "example" : "1.99" } } }, "VoucherPackageSalesLiteInfo" : { "type" : "object", "properties" : { "budget" : { "type" : "integer", "description" : "券包预算，单位是份数", "example" : "100" }, "sale_price" : { "type" : "string", "description" : "券包售卖价格，单位是元", "example" : "3.99" } } }, "VoucherPackageUseRule" : { "type" : "object", "properties" : { "use_rule_desc" : { "type" : "string", "description" : "券包使用规则", "example" : "当前券包的券必须在线下扫码点餐场景使用" } } }, "VoucherRechargeInfo" : { "type" : "object", "properties" : { "recharge_type" : { "type" : "string", "description" : "预充值方式。 \t枚举值:\tALIPAY_BALANCE 支付宝余额预充值" }, "voucher_balance_recharge_info" : { "$ref" : "#/components/schemas/VoucherBalanceRechargeInfo" } } }, "VoucherRefundDetailInfo" : { "type" : "object", "properties" : { "voucher_refund_use_times" : { "type" : "integer", "description" : "本次取消核销次数", "example" : "1" } } }, "VoucherRelativePeriodInfo" : { "type" : "object", "properties" : { "time_restrict_info" : { "$ref" : "#/components/schemas/TimeRestrictInfo" }, "valid_days_after_receive" : { "type" : "integer", "description" : "券生效后 N 天内可以使用。 可以配合wait_days_after_receive 字段使用。" }, "wait_days_after_receive" : { "type" : "integer", "description" : "用户领券后需要等待 N 天，券才可以生效。 \t字段值为 0 表示用户领券后立刻生效。" } } }, "VoucherSaleModeInfo" : { "type" : "object", "properties" : { "fund_custody_mode" : { "type" : "string", "description" : "资金托管方式" }, "overdue_refundable" : { "type" : "boolean", "description" : "是否支持优惠券过期后，自动退款给用户。 不填默认否，枚举值： true：是 false：否。自动退款功能需要服务商在优惠券过期时，主动调用alipay.marketing.activity.order.refund接口进行退款。 如果配置优惠券时选择了过期自动退款，但是实际券过期后，服务商没有进行退款，那么用户投诉后，需要服务商进行解决。" }, "overdue_refundable_need_confirm" : { "type" : "boolean", "description" : "在支持过期自动退款后，支付宝发起自动退款前 是否需要向商户确认退款。 不填默认否，枚举值： true：是 false：否。\t\t如果选择了 true:是 ，则需要商户配合接入 过期自动退款前是否需要向商户确认SPI(spi.alipay.marketing.activity.order.refundconfirm) 以及 退款确认结果API(alipay.marketing.activity.order.refundconfirmcommit)" }, "payee_pid" : { "type" : "string", "description" : "收款账号。 目前的结算规则是，每核销一笔优惠券，支付宝会打款到该收款账户。" }, "refundable" : { "type" : "boolean", "description" : "购买的优惠券是否允许退款。 不填默认否，枚举值： true：是 false：否" }, "refundable_need_confirm" : { "type" : "boolean", "description" : "在支持随时退后，支付宝发起退款前用于判断是否需要向商户确认退款。 不填默认否，枚举值： true：是 false：否。 如果选择了 true:是 ，则需要商户配合接入退款前是否需要向商户确认SPI(spi.alipay.marketing.activity.order.refundconfirm)" }, "sale_amount" : { "type" : "string", "description" : "用户购买优惠券需要支付的金额" }, "settle_info" : { "$ref" : "#/components/schemas/BizfundSettleInfo" } } }, "VoucherSendGuide" : { "type" : "object", "properties" : { "voucher_detail_url" : { "type" : "string", "description" : "领(购)券详情页链接，从支付宝公域跳转到服务商(商户)自定义领(购)券详情页。" } } }, "VoucherSendGuideInfo" : { "type" : "object", "properties" : { "mini_app_send_guide_info" : { "$ref" : "#/components/schemas/VoucherMiniAppSendGuideInfo" }, "send_guide_mode" : { "type" : "array", "description" : "发放引导模式", "items" : { "type" : "string" } } } }, "VoucherSendGuideModify" : { "type" : "object", "properties" : { "voucher_detail_url" : { "type" : "string", "description" : "领（购）券详情页链接，从支付宝公域跳转到服务商（商户）自定义领(购)券详情页。说明：当 voucher_type=EXCHANGE_VOUCHER 时，该字段可修改，其他不允许修改。", "example" : "alipays://platformapi/startapp?appId=xxxx" } } }, "VoucherSendModeInfo" : { "type" : "object", "properties" : { "voucher_package_mode_info" : { "$ref" : "#/components/schemas/VoucherPackageModeInfo" }, "voucher_sale_mode_info" : { "$ref" : "#/components/schemas/VoucherSaleModeInfo" }, "voucher_send_mode" : { "type" : "string", "description" : "券发放模式。" }, "voucher_send_rule_info" : { "$ref" : "#/components/schemas/VoucherSendRuleInfo" } } }, "VoucherSendRuleDetail" : { "type" : "object", "properties" : { "natural_person_limit" : { "type" : "boolean", "description" : "是否开启自然人领取限制。自然人表示按照身份证纬度进行领取限制。" }, "phone_number_limit" : { "type" : "boolean", "description" : "是否开启电话号码领取限制。" }, "voucher_quantity" : { "type" : "integer", "description" : "发行券的数量。" }, "voucher_quantity_limit_per_user" : { "type" : "integer", "description" : "每人领取限制。默认按照支付宝uid进行领取限制;\t不填写或填入0，默认没有领取限制。" } } }, "VoucherSendRuleDetailModify" : { "type" : "object", "properties" : { "natural_person_limit" : { "type" : "boolean", "description" : "是否开启自然人领取限制。 自然人表示按照身份证纬度进行领取限制。", "example" : "true" }, "phone_number_limit" : { "type" : "string", "description" : "是否开启电话号码领取限制。", "example" : "true" }, "voucher_quantity_limit_per_user" : { "type" : "integer", "description" : "每人领取限制。 默认按照支付宝uid进行领取限制;", "example" : "1" } } }, "VoucherSendRuleInfo" : { "type" : "object", "properties" : { "max_quantity_by_day" : { "type" : "integer", "description" : "设置此字段，允许指定单天最大发券数量。" }, "natural_person_limit" : { "type" : "boolean", "description" : "是否开启自然人领取限制。 自然人表示按照身份证纬度进行领取限制。" }, "phone_number_limit" : { "type" : "boolean", "description" : "是否开启电话号码领取限制。" }, "phone_number_need_input_limit" : { "type" : "boolean", "description" : "下单时是否需要用户填写手机号码" }, "publish_end_time" : { "type" : "string", "description" : "券发放结束时间。 格式为：yyyy-MM-dd HH:mm:ss" }, "publish_start_time" : { "type" : "string", "description" : "券发放开始时间。 格式为：yyyy-MM-dd HH:mm:ss" }, "quantity" : { "type" : "integer", "description" : "发行券的数量。" }, "quantity_limit_per_user" : { "type" : "integer", "description" : "每人领取限制。 默认按照支付宝账号进行领取限制; 不填写或填入0表示没有领取限制." }, "quantity_limit_per_user_period_type" : { "type" : "string", "description" : "周期限领配置,限制每人在固定周期内领取张数(voucher_quantity_limit_per_user),默认LIFE_CYCLE" }, "real_name_limit" : { "type" : "boolean", "description" : "限制支付宝实名用户才能领取支付券,默认为false表示不限制 枚举值 true\\false" } } }, "VoucherSummary" : { "type" : "object", "properties" : { "publish_count" : { "type" : "integer", "description" : "券已发放数量。" }, "used_count" : { "type" : "integer", "description" : "券已核销数量。" } } }, "VoucherUseDetailInfo" : { "type" : "object", "properties" : { "voucher_use_times" : { "type" : "integer", "description" : "本次核销次数", "example" : "1" } } }, "VoucherUseDetailResultInfo" : { "type" : "object", "properties" : { "voucher_max_un_use_times" : { "type" : "integer", "description" : "剩余可核销次数" } } }, "VoucherUseGuide" : { "type" : "object", "properties" : { "mini_app_id" : { "type" : "string", "description" : "券可用的小程序appId，卡包详情页可跳转到该appId" }, "mini_app_path" : { "type" : "string", "description" : "指定跳转到mini_app_id时的具体页面路径。" }, "mini_app_use_guide" : { "type" : "boolean", "description" : "小程序核销。" }, "offline_code_use_guide" : { "type" : "boolean", "description" : "线下扫码核销。" }, "service_codes" : { "type" : "array", "description" : "小程序服务编码，通过 alipay.open.app.appcontent.function.create(小程序服务创建)接口创建服务后获取。", "items" : { "type" : "string" } } } }, "VoucherUseGuideInfo" : { "type" : "object", "properties" : { "mini_app_use_guide_info" : { "$ref" : "#/components/schemas/VoucherMiniAppUseGuideInfo" }, "use_guide_mode" : { "type" : "array", "description" : "使用引导模式", "items" : { "type" : "string" } } } }, "VoucherUseGuideModify" : { "type" : "object", "properties" : { "mini_app_id" : { "type" : "string", "description" : "券可用的小程序 appId，卡包详情页可跳转到该 appId。", "example" : "2021238412323412" }, "mini_app_path" : { "type" : "string", "description" : "指定跳转到 mini_app_id 时的具体页面路径。", "example" : "/index/path/path&query=xx%3dxx" }, "service_codes" : { "type" : "array", "description" : "小程序服务编码，通过 alipay.open.app.appcontent.function.create(小程序服务创建)接口创建服务后获取。", "items" : { "type" : "string" }, "example" : "[\"2020030921000303380758\"]" } } }, "VoucherUseRule" : { "type" : "object", "properties" : { "discount_voucher" : { "$ref" : "#/components/schemas/DiscountVoucher" }, "exchange_voucher" : { "$ref" : "#/components/schemas/ExchangeVoucher" }, "fix_voucher" : { "$ref" : "#/components/schemas/FixVoucher" }, "special_voucher" : { "$ref" : "#/components/schemas/SpecialVoucher" }, "voucher_available_scope" : { "$ref" : "#/components/schemas/VoucherAvailableScope" }, "voucher_valid_period" : { "$ref" : "#/components/schemas/VoucherValidPeriod" } } }, "VoucherUseRuleInfo" : { "type" : "object", "properties" : { "quantity_limit_per_user" : { "type" : "integer", "description" : "核销次数限制。" }, "quantity_limit_per_user_period_type" : { "type" : "string", "description" : "核销周期。" }, "voucher_max_use_times" : { "type" : "integer", "description" : "券最大核销次数。" }, "voucher_use_ext_info" : { "type" : "string", "description" : "自定义扩展信息" }, "voucher_use_time_info" : { "$ref" : "#/components/schemas/VoucherUseTimeInfo" } } }, "VoucherUseRuleModify" : { "type" : "object", "properties" : { "exchange_voucher" : { "$ref" : "#/components/schemas/ExchangeVoucherModify" }, "voucher_available_scope" : { "$ref" : "#/components/schemas/VoucherAvailableScopeModify" }, "voucher_valid_period" : { "$ref" : "#/components/schemas/VoucherValidPeriodModify" } } }, "VoucherUseTimeInfo" : { "type" : "object", "properties" : { "absolute_period_info" : { "$ref" : "#/components/schemas/VoucherAbsolutePeriodInfo" }, "period_type" : { "type" : "string", "description" : "券有效期。" }, "relative_period_info" : { "$ref" : "#/components/schemas/VoucherRelativePeriodInfo" } } }, "VoucherUseTimeRuleInfo" : { "type" : "object", "properties" : { "date_rule_info" : { "$ref" : "#/components/schemas/DateRuleInfo" }, "holiday_rule_info" : { "$ref" : "#/components/schemas/HolidayRuleInfo" }, "rule_type" : { "type" : "string", "description" : "规则类型" }, "week_rule_info" : { "$ref" : "#/components/schemas/WeekRuleInfo" } } }, "VoucherValidPeriod" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "券有效期。" }, "valid_begin_time" : { "type" : "string", "description" : "券可使用的开始时间。格式为：yyyy-MM-dd HH:mm:ss" }, "valid_days_after_receive" : { "type" : "integer", "description" : "券生效后N天内可以使用。可以配合wait_days_after_receive字段使用。" }, "valid_end_time" : { "type" : "string", "description" : "券可使用的结束时间。格式为yyyy-MM-dd HH:mm:ss" }, "wait_days_after_receive" : { "type" : "integer", "description" : "用户领券后需要等待N天，券才可以生效。如果该字段填入0或者不填写，则用户领券后立刻生效。" } } }, "VoucherValidPeriodModify" : { "type" : "object", "properties" : { "valid_begin_time" : { "type" : "string", "description" : "券可使用的开始时间。格式为：yyyy-MM-dd HH:mm:ss。", "example" : "2017-01-10 00:00:00" }, "valid_days_after_receive" : { "type" : "integer", "description" : "券生效后 N 天内可以使用。", "example" : "3" }, "valid_end_time" : { "type" : "string", "description" : "券可使用的结束时间。格式为yyyy-MM-dd HH:mm:ss。", "example" : "2017-01-13 23:59:59" }, "wait_days_after_receive" : { "type" : "integer", "description" : "用户领券后需要等待 N 天，券才可以生效。", "example" : "2" } } }, "WaitRepaymentOrderInfo" : { "type" : "object", "properties" : { "advance_order_id" : { "type" : "string", "description" : "垫资单id", "example" : "20190128002630010000170001187808" }, "alipay_user_id" : { "type" : "string", "description" : "买家的支付宝用户id", "example" : "2088302483540171" }, "biz_product" : { "type" : "string", "description" : "通常为商户签约的收单产品码", "example" : "GENERAL_WITHHOLDING" }, "open_id" : { "type" : "string", "description" : "买家的支付宝用户id", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "orig_biz_order_id" : { "type" : "string", "description" : "原始的业务单号，通常为支付宝交易号", "example" : "2018060821001001820554093702" }, "wait_repayment_amount" : { "type" : "integer", "description" : "垫资金额", "example" : "2.04" } } }, "WaybillInvoice" : { "type" : "object", "properties" : { "waybill_amount" : { "type" : "string", "description" : "即时配送运单金额", "example" : "100" }, "waybill_no" : { "type" : "string", "description" : "即时配送运单编号", "example" : "waybill_no_00001" } } }, "WaybillInvoiceIstd" : { "type" : "object", "properties" : { "reason" : { "type" : "string", "description" : "失败原因，需要传单个配送单的驳回原因", "example" : "开票失败原因" }, "shop_no" : { "type" : "string", "description" : "商家球房编号", "example" : "shop_no_00001" }, "waybill_amount" : { "type" : "string", "description" : "即时配送运单金额，waybill_invoce_status为1的情况下不能为空", "example" : "100" }, "waybill_invoice_status" : { "type" : "integer", "description" : "明细的运单开票状态，1：开票成功 2：不可开票 3：可开票；整体开票状态为0的情况下，无开票明细；整体开票状态为1，明细开票状态全部是1；整体开票状态为2，明细开票状态为2或者3", "example" : "0" }, "waybill_no" : { "type" : "string", "description" : "即时配送运单编号", "example" : "waybillNo_20200811" } } }, "WaybillInvoiceQueryIstd" : { "type" : "object", "properties" : { "reason" : { "type" : "string", "description" : "失败原因，需要传单个即时配送运单的驳回原因", "example" : "开票金额错误" }, "shop_no" : { "type" : "string", "description" : "商家球房编号", "example" : "shop_no_20200818" }, "waybill_amount" : { "type" : "string", "description" : "即时配送运单金额，waybill_invoce_status为1的情况下不能为空", "example" : "200" }, "waybill_invoice_status" : { "type" : "integer", "description" : "明细的运单开票状态，1：开票成功 2：不可开票 3：可开票；整体开票状态为0的情况下，无开票明细；整体开票状态为1，明细开票状态全部是1；整体开票状态为2，明细开票状态全部为2", "example" : "0" }, "waybill_no" : { "type" : "string", "description" : "即时配送运单编号", "example" : "waybill_no_20200811" } } }, "WeekRuleInfo" : { "type" : "object", "properties" : { "time_range_info" : { "$ref" : "#/components/schemas/TimeRangeInfo" }, "week_day" : { "type" : "string", "description" : "星期数，以“,”连接多个星期数" } } }, "WidgetActivityInfo" : { "type" : "object", "properties" : { "activity_click_url" : { "type" : "string", "description" : "活动点击跳转到小程序的链接地址", "example" : "alipays://platformapi/startapp?appId= 2017072607907880&page=pages/index/index?param=xxxx" }, "activity_id" : { "type" : "string", "description" : "活动的唯一标识，同一个小程序橱窗下，该标识唯一，请开发者自行保证", "example" : "8948968498" }, "activity_name" : { "type" : "string", "description" : "活动名称", "example" : "这是一个活动名称" }, "activity_picture_urls" : { "type" : "array", "description" : "活动图片链接,最多不能超过5个", "items" : { "type" : "string" }, "example" : "[\"https://xxx.xxx.com/xxx.jpg\"]" } } }, "WidgetGoodsInfo" : { "type" : "object", "properties" : { "buying_url" : { "type" : "string", "description" : "该商品的小程序购买链接，如果需要进行公域推广，请字段请必填" }, "goods_brand" : { "type" : "string", "description" : "商品品牌，如果需要进行公域推广，该字段请必填" }, "goods_comment" : { "type" : "string", "description" : "商品辅助说明文案" }, "goods_description_label" : { "type" : "string", "description" : "商品说明标签（如-随心退）" }, "goods_id" : { "type" : "string", "description" : "商品的唯一标识，同一个小部件下，该标识唯一，请开发者自行保证" }, "goods_label" : { "type" : "string", "description" : "营销标签（如-限量特价），每个商品仅支持一个营销标签" }, "goods_name" : { "type" : "string", "description" : "商品名称" }, "goods_type" : { "type" : "string", "description" : "商品所属品类" }, "main_pic_url" : { "type" : "string", "description" : "商品主图片地址，如果需要进行公域推广，该字段请必填。" }, "need_public_promo" : { "type" : "boolean", "description" : "是否需要进行公域推广，默认情况下为false" }, "order_number" : { "type" : "integer", "description" : "商品排序，自然整数, 数字越小越靠前" }, "original_price" : { "type" : "string", "description" : "单位\"元\"的商品原价，传入数字，不需要传入\"元\"。如果需要进行公域推广，该字段请必填。" }, "publish_cities" : { "type" : "string", "description" : "投放城市的列表，详见https://www.mca.gov.cn/article/sj/xzqh/2020/2020/202007170301.html，有多个用英文,分隔。如果没有限制则不传入" }, "remaining_quantity" : { "type" : "integer", "description" : "剩余库存，如果需要进行公域推广，该字段请必填，并且当剩余库存为0时，请及时同步。" }, "sell_price" : { "type" : "string", "description" : "单位\"元\"的售价，传入数字，不需要传入\"元\"。如果需要进行公域推广，该字段请必填。" }, "sell_tag_list" : { "type" : "array", "description" : "商品的卖点标签，如果需要进行公域推广，请至少填写两个卖点标签。", "items" : { "type" : "string" } }, "sold_quantity" : { "type" : "integer", "description" : "已售数量" }, "status" : { "type" : "string", "description" : "商品状态，商品的上下架，默认情况为上架，上架为ONLINE,下架为OFFLINE" }, "total_quantity" : { "type" : "integer", "description" : "总库存量" } } }, "ZMGOBasicConfig" : { "type" : "object", "properties" : { "biz_type" : { "type" : "string", "description" : "商户在芝麻GO配置的业务身份编码" }, "contact" : { "type" : "string", "description" : "商家客服电话" }, "isv_pid" : { "type" : "string", "description" : "运营商商户支付宝ID。若非ISV代理模式，也就是商户自运营模式，此属性取值与partner_id一致。" }, "merchant_custom_logo" : { "type" : "string", "description" : "商户LOGO" }, "out_biz_no" : { "type" : "string", "description" : "外部业务单号，供幂等使用，需保证每次请求的值都不同" }, "partner_id" : { "type" : "string", "description" : "商户的支付宝ID，即为此商户创建芝麻GO模板" }, "template_name" : { "type" : "string", "description" : "芝麻GO模板名称" }, "template_no" : { "type" : "string", "description" : "模板编号" } } }, "ZMGOCycleFlexConfig" : { "type" : "object", "properties" : { "cycle_flex_withhold_fee_name" : { "type" : "string", "description" : "周期灵活扣的费用名称" }, "cycle_flex_withhold_max_price" : { "type" : "string", "description" : "周期灵活扣单期扣款的最大额度" }, "cycle_flex_withhold_total_period_count" : { "type" : "integer", "description" : "周期灵活扣的总期数" } } }, "ZMGOCycleWithholdConfig" : { "type" : "object", "properties" : { "deduct_plan" : { "type" : "array", "description" : "扣款计划", "items" : { "type" : "string" } }, "exemption_period" : { "type" : "string", "description" : "豁免期天数" }, "period" : { "type" : "string", "description" : "周期" }, "period_type" : { "type" : "string", "description" : "扣款周期类型，支持DAY-天模式，MONTH-月模式" }, "support_cycle_withhold_high_mode" : { "type" : "boolean", "description" : "是否支持周期扣高级模式，高级模式下扣款计划中内一起的扣款金额可以进行定制" }, "support_exemption_period" : { "type" : "boolean", "description" : "是否支持豁免期，如果支持豁免期，用户开通后再豁免期内退出无需扣款" }, "withhold_mode" : { "type" : "string", "description" : "设置扣款模式，目前支持每月固定日期或固定时间间隔" } } }, "ZMGOExtConfig" : { "type" : "object", "properties" : { "text_content_fill_rule_id" : { "type" : "string", "description" : "文本内容填充规则ID" }, "text_content_fill_variable" : { "type" : "string", "description" : "文本内容填充变量，变量key由运营同学提供" } } }, "ZMGOObligationConfig" : { "type" : "object", "properties" : { "benefit_url" : { "type" : "string", "description" : "芝麻GO管理页做任务按钮对应链接" }, "obligation_amount" : { "type" : "string", "description" : "完成任务所需的最少额度，当obligation_template取值为：OBTL002时必传" }, "obligation_template" : { "type" : "string", "description" : "承诺模式下，义务的类型，包含次数类型和金额类型：\t OBTL001(\"OBTL001\", \"在x时间内完成n次\"),\t OBTL002(\"OBTL002\", \"在x时间内达到n元金额\")" }, "obligation_times" : { "type" : "string", "description" : "完成任务所需的最少次数，当obligation_template取值为：OBTL001时必填" }, "promise_type_desc" : { "type" : "string", "description" : "任务描述" }, "task_progress_redirect_schema" : { "type" : "string", "description" : "芝麻GO管理页任务进度重定向链接" } } }, "ZMGOOpenConfig" : { "type" : "object", "properties" : { "apply_button_desc" : { "type" : "string", "description" : "开通页按钮文案描述;传入内容后开通页点击开通按钮展示文案会使用该字段传入内容" }, "appoint_date" : { "type" : "string", "description" : "固定到期时间或每月的第几日。 （1）当period_mode为APPOINT_DATE时，取值固定日期，如\"2022-06-01 00:00:00\"，表示协议在6月1号0点到期; （2）当period_mode为FIX_DATE，取值\"3\"，表示协议在period_time个月后的3号到期。" }, "card_color_scheme" : { "type" : "string", "description" : "芝麻GO卡颜色。 C_BLACK(\"C_BLACK\", \"黑色\"), C_RED(\"C_RED\", \"红色\"), C_GREEN(\"C_GREEN\", \"绿色\"), C_LIGHT_BLUE(\"C_LIGHT_BLUE\", \"浅蓝色\"), C_BLUE(\"C_BLUE\", \"蓝色\"), C_ORANGE(\"C_ORANGE\",\"橙色\"), C_PURPLE(\"C_PURPLE\", \"紫色\");" }, "custom_open_tip_list" : { "type" : "string", "description" : "未完成任务规则详情" }, "custom_open_tips" : { "type" : "string", "description" : "规则详情" }, "freeze_amount" : { "type" : "string", "description" : "担保金额额度" }, "min_sign_interval" : { "type" : "string", "description" : "用户签约间隔时间" }, "period_mode" : { "type" : "string", "description" : "芝麻GO义务到期的计算方式。包括： RELATIVE_DATE(\"RELATIVE_DATE\", \"相对日期\"), ABSOLATE_DATE(\"ABSOLATE_DATE\", \"绝对日期(当日开始计算)\"), ABSOLUTE_PLUS_1_DATE(\"ABSOLUTE_PLUS_1_DATE\", \"绝对日期(次日开始计算)\"), FIX_DATE(\"FIX_DATE\", \"固定日期\"), APPOINT_DATE(\"APPOINT_DATE\", \"指定日期\")," }, "period_time" : { "type" : "string", "description" : "周期时长\t当period_mode为RELATIVE_DATE、ABSOLATE_DATE、ABSOLUTE_PLUS_1_DATE、FIX_DATE时必填" }, "show_sign_success_page" : { "type" : "boolean", "description" : "是否展示签约完成页" }, "sign_again_schema" : { "type" : "string", "description" : "用户签约商户活动到期" }, "sign_success_task_button_desc" : { "type" : "string", "description" : "签约完成页任务按钮描述，当展示签约完成页=true的时候 改内容必填" }, "support_expire_deferral" : { "type" : "boolean", "description" : "是否支持延期特权" } } }, "ZMGOQuitConfig" : { "type" : "object", "properties" : { "quit_desc" : { "type" : "string", "description" : "退出提示" }, "quit_jump_url" : { "type" : "string", "description" : "退出跳转商家页地址，当quit_type取值为：QUIT_MERCHANT_JUMP，必传" }, "quit_type" : { "type" : "string", "description" : "退出芝麻GO方式，取值：\t （1）QUIT_COMMON(\"QUIT_COMMON\", \"标准退出\"),\t（2）QUIT_MERCHANT_JUMP(\"QUIT_MERCHANT_JUMP\", \"商家页退出\"),\t（3）QUIT_ONLY_TIPS(\"QUIT_ONLY_TIPS\", \"仅退出提示\")" } } }, "ZMGORightConfig" : { "type" : "object", "properties" : { "cumulative_preferential_redirect_schema" : { "type" : "string", "description" : "芝麻GO管理页已享优惠进度的重定向链接" }, "custom_benefit_desc" : { "type" : "string", "description" : "权益描述" }, "custom_sub_benefit_desc" : { "type" : "string", "description" : "权益描述子标题" } } }, "ZMGOSettlementConfig" : { "type" : "object", "properties" : { "custom_fee_name" : { "type" : "string", "description" : "会员费扣费名称" }, "cycle_flex_withhold_config" : { "$ref" : "#/components/schemas/ZMGOCycleFlexConfig" }, "cycle_withhold_config" : { "$ref" : "#/components/schemas/ZMGOCycleWithholdConfig" }, "exp_stop_delay_days" : { "type" : "integer", "description" : "预计结算延迟天数，当exp_stop_time_mode取值RELATIVE_DATE、ABSOLATE_DATE、ABSOLUTE_PLUS_1_DATE时，必传" }, "exp_stop_time" : { "type" : "string", "description" : "预期结算时间，当exp_stop_time_mode取值APPOINT_DATE时，必传" }, "exp_stop_time_mode" : { "type" : "string", "description" : "预计结算时间模式，取值：（1）RELATIVE_DATE(\"RELATIVE_DATE\", \"相对日期\"), （2）ABSOLATE_DATE(\"ABSOLATE_DATE\", \"绝对日期(当日开始计算)\"), （3）ABSOLUTE_PLUS_1_DATE(\"ABSOLUTE_PLUS_1_DATE\", \"绝对日期(次日开始计算)\"), （4）APPOINT_DATE(\"APPOINT_DATE\", \"指定日期\")" }, "fulfilltimes_custom_settlement_plan" : { "type" : "string", "description" : "按履约次数灵活扣款计划。当settlement_type取值为fulfillTimesCustomSettlement时，此属性必传" }, "settlement_type" : { "type" : "string", "description" : "结算类型，取值：\t BENEFIT_SETTLEMENT(\"benefitSettlement\", \"按权益金额结算\"),\t FULFILL_TIMES_CUSTOM_SETTLEMENT(\"fulfillTimesCustomSettlement\",\"按履约次数扣款\")" } } }, "ZMGoOutDiscountInfo" : { "type" : "object", "properties" : { "discount_amount" : { "type" : "string", "description" : "商户回传的优惠金额，如用户享受的红包金额，单位元", "example" : "8.75" }, "discount_name" : { "type" : "string", "description" : "商户数据回传的优惠信息的名称", "example" : "滴滴打车优惠001" }, "discount_type" : { "type" : "string", "description" : "优惠信息的类型。为枚举值，商户可任意选择一个值作为入参传入。可取值：\t(\"exclusiveBenefit\",\"专享优惠\"),\t(\"exclusiveDiscount\",\"专享折扣\"),\t(\"appreciationBenefit\", \"增值权益\"),\t(\"memberPoint\", \"会员积分\")", "example" : "exclusiveBenefit" } } }, "ZMGoTradeInfo" : { "type" : "object", "properties" : { "amount" : { "type" : "string", "description" : "用户和商户发生交易的交易单金额，单位元", "example" : "3.57" }, "trade_no" : { "type" : "string", "description" : "用户和商户发生交易的交易单号，仅在商户需要回传交易信息时传入。", "example" : "2020081722001435461000061785" } } }, "ZhimaCreditPayafteruseCreditagreementQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "BIZ_ERROR", "EXTRA_PARAM_FORMAT_ERROR", "INVALID_PARAMETER", "CREDIT_AUTH_NOT_EXIST", "ILLEGAL_QUERY", "CREDIT_AGREEMENT_NOT_EXIST", "DEPEND_FAILURE" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaCreditPayafteruseCreditagreementQueryResponseModel" : { "type" : "object", "properties" : { "agreement_status" : { "type" : "string", "description" : "开通/授权状态，VALID: 有效，INVALID: 无效", "example" : "VALID" }, "biz_time" : { "type" : "string", "description" : "开通时间，agreement_status为VALID有效。", "example" : "2020-09-15 11:23:04" }, "credit_agreement_id" : { "type" : "string", "description" : "芝麻开通/授权协议号", "example" : "ZMOP99202011240100520025162811" }, "ext_info" : { "type" : "string", "description" : "该字段只在特殊业务场景下，根据业务方约定返回；一般业务场景下不需要消费该字段", "example" : "{\"key\":\"value\"}" }, "out_agreement_no" : { "type" : "string", "description" : "商户外部协议号", "example" : "2014070700166653" } } }, "ZhimaCreditPayafteruseCreditagreementTransferErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "OUT_AGREEMENT_NO_DUPLICATE", "DEDUCT_AGREEMENT_INVALID", "ZHIMA_EVALUATE_NO_PASS", "CHECK_SIGN_SALES_FAIL", "SIGN_MODE_NOT_MATCH", "INVALID_PARAMETER", "USER_EXIST_VALID_AGREEMENT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaCreditPayafteruseCreditagreementTransferModel" : { "type" : "object", "properties" : { "category_id" : { "type" : "string", "description" : "芝麻外部类目", "example" : "credit_pay_test" }, "deduct_agreement_no" : { "type" : "string", "description" : "用户的代扣协议号", "example" : "20215401139331610689" }, "out_agreement_no" : { "type" : "string", "description" : "商户外部协议号，不同的支付宝用户需要传递不同的外部单号", "example" : "2014070700166653" }, "zm_service_id" : { "type" : "string", "description" : "芝麻信用服务ID", "example" : "2020050722001440031000061082" } } }, "ZhimaCreditPayafteruseCreditagreementTransferResponseModel" : { "type" : "object", "properties" : { "credit_agreement_id" : { "type" : "string", "description" : "芝麻开通协议号", "example" : "ZMOP99202011240100520025162811" }, "out_agreement_no" : { "type" : "string", "description" : "商户外部协议号", "example" : "2014070700166653" } } }, "ZhimaCreditPayafteruseCreditbizorderFinishErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "BIZ_ERROR", "ORDER_NOT_EXIST", "INVALID_PARAMETER", "ORDER_STATUS_INVALID", "MERCHANT_NO_PERMISSION_OPERATE_ORDER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaCreditPayafteruseCreditbizorderFinishModel" : { "type" : "object", "properties" : { "credit_biz_order_id" : { "type" : "string", "description" : "信用服务订单号", "example" : "ZMCB20201021200102012" }, "is_fulfilled" : { "type" : "string", "description" : "用户此订单是否守约。\t传true时，用户在芝麻信用-守约记录中，该笔订单是已守约状态；\t传false时，用户在芝麻信用-守约记录中，该笔订单是已取消状态。", "example" : "true" }, "out_request_no" : { "type" : "string", "description" : "商户外部请求号", "example" : "2014070700166653" }, "remark" : { "type" : "string", "description" : "商户对本次操作的附言描述", "example" : "完结订单" } } }, "ZhimaCreditPayafteruseCreditbizorderFinishResponseModel" : { "type" : "object", "properties" : { "credit_biz_order_id" : { "type" : "string", "description" : "信用服务订单号", "example" : "ZMCB20201021200102012" }, "order_status" : { "type" : "string", "description" : "信用服务订单状态.INIT: 下单状态; TRADE_CLOSED: 订单取消或者交易全额退款； TRADE_FINISHED：扣款成功状态", "example" : "INIT" }, "out_request_no" : { "type" : "string", "description" : "商户外部请求号", "example" : "4977164666634053" } } }, "ZhimaCreditPayafteruseCreditbizorderOrderErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "BIZ_ERROR", "INVALID_PARAMETER", "CREDIT_AGREEMENT_INVALID", "CHECK_SIGN_SALES_FAIL", "ZHIMA_EVALUATE_NO_PASS", "SIGN_SALES_CHANGE", "ZHIMA_CHECK_NO_PASS" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaCreditPayafteruseCreditbizorderOrderModel" : { "type" : "object", "properties" : { "amount_type" : { "type" : "string", "description" : "只有当传递了order_amount时，该参数才有意义； 1）该参数不传时，默认为ORDER_AMOUNT。 2）传ORDER_AMOUNT时，表示order_amount传入的金额为后付金额，在发起扣款时，最大扣款支付金额为order_amount传入的值； 3）传RISK_AMOUNT时，表示ORDER_AMOUNT传入的金额为风险预估金额，在发起扣款时，最大扣款支付金额为商户签约时约定的上限额度。", "example" : "RISK_AMOUNT" }, "body" : { "type" : "string", "description" : "订单描述", "example" : "Iphone6 16G" }, "category_id" : { "type" : "string", "description" : "芝麻外部类目", "example" : "credit_pay_after_use" }, "credit_agreement_id" : { "type" : "string", "description" : "芝麻开通协议号", "example" : "ZMOP99202011240100520025162811" }, "extend_params" : { "type" : "string", "description" : "业务扩展参数", "example" : "{\"key\":\"value\"}" }, "order_amount" : { "type" : "string", "description" : "订单金额，该金额为当前订单扣款的累计最大额度。例如，下单时传递10.00，则扣款时最大支付金额为10元。若该参数不传，则默认使用商户签约时约定的上限额度。芝麻速办业务场景（极速回收、极速返利、极速退款等）商户请求时，order_amount必传，且amount_type类型需传递ORDER_AMOUNT。", "example" : "88.66" }, "out_order_no" : { "type" : "string", "description" : "商户外部订单号，保证不重复", "example" : "out00120312323232" }, "product_code" : { "type" : "string", "description" : "产品码，不传默认为CREDIT_PAY_AFTER_USE", "example" : "CREDIT_PAY_AFTER_USE" }, "subject" : { "type" : "string", "description" : "订单标题。\t注意：不可使用特殊字符，如 /，=，& 等。", "example" : "Iphone6 16G" } } }, "ZhimaCreditPayafteruseCreditbizorderOrderResponseModel" : { "type" : "object", "properties" : { "credit_biz_order_id" : { "type" : "string", "description" : "信用服务订单号", "example" : "ZMCB99202103310000450000041833" }, "out_order_no" : { "type" : "string", "description" : "商户传入的外部订单号", "example" : "out1210212021212" } } }, "ZhimaCreditPayafteruseCreditbizorderQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "BIZ_ERROR", "INVALID_PARAMETER", "ILLEGAL_QUERY" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaCreditPayafteruseCreditbizorderQueryResponseModel" : { "type" : "object", "properties" : { "create_time" : { "type" : "string", "description" : "订单创建时间", "example" : "2020-09-15 11:23:04" }, "credit_agreement_id" : { "type" : "string", "description" : "芝麻开通协议号", "example" : "ZMOP2014070700166653" }, "credit_biz_order_id" : { "type" : "string", "description" : "信用服务订单号", "example" : "ZMCB20201021200102012" }, "order_status" : { "type" : "string", "description" : "信用服务订单状态。INIT: 下单状态；TRADE_CLOSED: 订单取消或者交易全额退款； TRADE_FINISHED：扣款成功状态", "example" : "INIT" }, "product_code" : { "type" : "string", "description" : "产品码", "example" : "CREDIT_PAY_AFTER_USE" }, "total_amount" : { "type" : "string", "description" : "信用服务订单金额", "example" : "88.88" }, "trade_no" : { "type" : "string", "description" : "支付宝交易号", "example" : "2021030422001428451400037476" }, "zm_service_id" : { "type" : "string", "description" : "芝麻信用服务ID", "example" : "2020050722001440031000061082" } } }, "ZhimaCreditPeZmgoAgreementQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ZMGO_BIZ_AGR_NULL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaCreditPeZmgoAgreementQueryResponseModel" : { "type" : "object", "properties" : { "agreement_id" : { "type" : "string", "description" : "支付宝系统中用以唯一标识用户签约记录的编号，即花芝轻会员协议号。", "example" : "20185513447859192007" }, "agreement_name" : { "type" : "string", "description" : "协议名称", "example" : "花呗先享会员" }, "agreement_status" : { "type" : "string", "description" : "协议状态。Y表示状态有效，P表示状态失效中，N表示状态已失效", "example" : "Y" }, "alipay_user_id" : { "type" : "string", "description" : "支付宝用户userId", "example" : "2088302424419340" }, "biz_type" : { "type" : "string", "description" : "代表签约芝麻GO所属业务类型", "example" : "zm_zmgo" }, "open_id" : { "type" : "string", "description" : "支付宝用户userId", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "sign_time" : { "type" : "string", "description" : "该条芝麻GO协议签约时间", "example" : "2021-09-27 00:00:00" }, "start_time" : { "type" : "string", "description" : "该芝麻GO协议开始时间", "example" : "2021-09-27 00:00:00" } } }, "ZhimaCreditPeZmgoAgreementUnsignErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "ZMGO_BIZ_AGR_SYSTEM_ERROR", "ZMGO_BIZ_ORDER_SYSTEM_ERROR", "SETTLE_BALANCE_ACCOUNT_ERROR", "ZMGO_SYSTEM_AMOUNT_NOT_CLEAR", "ZMGO_BIZ_AGR_ERROR", "ZMGO_CREATE_WPN_SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaCreditPeZmgoAgreementUnsignModel" : { "type" : "object", "properties" : { "agreement_id" : { "type" : "string", "description" : "支付宝系统中用以唯一标识用户签约记录的编号。", "example" : "ZMGO_AGR2020122710020604120000000001" }, "alipay_user_id" : { "type" : "string", "description" : "支付宝的用户id", "example" : "2088302841345600" }, "open_id" : { "type" : "string", "description" : "支付宝的用户id", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "partner_id" : { "type" : "string", "description" : "商户ID", "example" : "2088302424614288" }, "quit_type" : { "type" : "string", "description" : "quit_type为USER_CANCEL_QUIT或者SETTLE_APPLY_QUIT", "example" : "SETTLE_APPLY_QUIT" } } }, "ZhimaCreditPeZmgoAgreementUnsignResponseModel" : { "type" : "object", "properties" : { "agreement_id" : { "type" : "string", "description" : "支付宝系统中用以唯一标识用户签约记录的编号。", "example" : "ZMGO_AGR2020122710020604120000000001" }, "withhold_plan_no" : { "type" : "string", "description" : "调用芝麻GO结算受理接口时，需要传入该值", "example" : "ZMGO_WHD2021022210020603120000301613" } } }, "ZhimaCreditPeZmgoBizoptCloseErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "BIZ_OPT_STATUS_CHECK_FAILURE", "BIZ_OPT_NOT_EXIST", "BIZ_OPT_ERROR", "ZMGO_BIZ_OPT_NULL", "BIZ_OPT_UPDATE_FAILURE", "REQUEST_ACCESS_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaCreditPeZmgoBizoptCloseModel" : { "type" : "object", "properties" : { "alipay_user_id" : { "type" : "string", "description" : "支付宝用户Id", "example" : "2088302841345600" }, "open_id" : { "type" : "string", "description" : "支付宝用户Id", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "out_request_no" : { "type" : "string", "description" : "商户本次操作的请求流水号，由商户生成，请确保唯一性", "example" : "99202005050100930053707258" }, "partner_id" : { "type" : "string", "description" : "商户Id", "example" : "2088302424614288" }, "template_id" : { "type" : "string", "description" : "芝麻GO配置模板Id", "example" : "2021012300020903090008858258" } } }, "ZhimaCreditPeZmgoBizoptCloseResponseModel" : { "type" : "object", "properties" : { "biz_opt_no" : { "type" : "string", "description" : "芝麻GO签约申请时生成的签约申请单据号", "example" : "ZMGO_OPT2021020110020607850000006001" }, "open_id" : { "type" : "string", "description" : "蚂蚁统一会员ID", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "out_request_no" : { "type" : "string", "description" : "商户本次操作的请求流水号", "example" : "9e8cc8da16866a79161ee033cb58497b" }, "partner_id" : { "type" : "string", "description" : "商户ID", "example" : "2088302424614288" }, "user_id" : { "type" : "string", "description" : "蚂蚁统一会员ID", "example" : "2088302841345600" } } }, "ZhimaCreditPeZmgoCumulationSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "REQUEST_PARAM_ILLEGAL", "SYSTEM_ERROR", "INVALID_PARAMETER", "REQUEST_ACCESS_ILLEGAL", "INVALID_BIZ_ACTION", "EASY_MEMBER_CONSULT_FAIL", "INVALID_CUMULATE_MODE", "IDEMPOTENT_ERROR", "INVALID_CUMULATE_TYPE", "PAY_ORDER_NOT_EXIST", "ORDER_AMOUNT_ILLEGAL", "DISCOUNT_AMOUNT_ILLEGAL", "REFUND_TIME_ILLEGAL", "REFUND_ILLEGAL", "BUYER_INFO_ERROR", "SELLER_INFO_ERROR", "TRADE_NOT_EXIST" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaCreditPeZmgoCumulationSyncModel" : { "type" : "object", "properties" : { "agreement_no" : { "type" : "string", "description" : "芝麻go协议号，唯一标识一个芝麻go协议。为必传入参。", "example" : "20195108518085620000" }, "amount_type_data" : { "$ref" : "#/components/schemas/AmountTypeData" }, "biz_action" : { "type" : "string", "description" : "数据回传的动作类型，为枚举值，为必传入参。\t可取值：\t(\"ORDER_PAID\", \"正向支付\")，(\"ORDER_REFUND\", \"逆向退款\")。\t其中ORDER_PAID表示回传为正向的，即订单金额累加，优惠累加，任务次数累加；而ORDER_REFUND表示回传为逆向的，即订单金额退款，优惠退款，任务次数回退。", "example" : "ORDER_PAID" }, "biz_time" : { "type" : "string", "description" : "交易发生时间，包括：订单交易时间，优惠核销时间，以及任务完成时间。为必传入参。\t如：用户在【2019-03-08 00:00:00】核销了一个红包，但是【2019-03-10 00:00:00】才进行数据回传，此时biz_time取值红包核销的时间，也就是【2019-03-08 00:00:00】。", "example" : "2019-03-08 19:51:35" }, "cumulate_data_type" : { "type" : "string", "description" : "累计类型。为枚举值，为必传入参。\t可取值：(\"AMOUNT\", \"金额类型\")，(\"TASK\", \"任务类型\")，(\"AMOUNT_TASK\", \"额度和任务类型\")。\t其中，交易解耦模式仅允许AMOUNT或TASK。而交易绑定模式下，仅允许AMOUNT_TASK。", "example" : "AMOUNT" }, "ext_info" : { "type" : "string", "description" : "扩展字段，格式为Json格式的字符串，非必传。", "example" : "{\"number\":\"20200303938282939\"}" }, "has_alipay_trade" : { "type" : "boolean", "description" : "是否为支付宝交易。仅在累计模式为【交易绑定模式】下被消费。当芝麻Go模板配置的累计模式为交易绑定模式时，此时需传入扩展参数是否为支付宝交易。若是支付宝交易，传值true，否则为false。若不传此字段，默认为false。\t若为true，则会对交易号trade_no进行校验，校验是否为支付宝交易，以及用户userId和商户partnerId是否一致，若校验不通过，累计失败。", "example" : "false" }, "open_id" : { "type" : "string", "description" : "用户userId，蚂蚁统一会员ID，为必传入参。", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "out_biz_no" : { "type" : "string", "description" : "外部业务号。需保证唯一，为必传入参。\t若接口调用失败，提示信息为更换幂等号，商户更换此字段重新发起调用。", "example" : "2020081211223006150094012926289" }, "partner_id" : { "type" : "string", "description" : "商户ID，为必传入参。", "example" : "2088621805983504" }, "pay_out_biz_no" : { "type" : "string", "description" : "逆向对应的正向外部业务号。逆向场景为必传入参。也就是biz_action为ORDER_REFUND时为必传入参。\t逆向时需通过此字段明确对应的正向的外部业务号。", "example" : "2020081211223006150094012926289" }, "request_from" : { "type" : "string", "description" : "取固定值ExternalMerchantSource，为必传入参。表示数据回传来源为外部商户，数据回传内部逻辑需感知。", "example" : "ExternalMerchantSource" }, "task_type_data" : { "$ref" : "#/components/schemas/TaskTypeData" }, "user_id" : { "type" : "string", "description" : "用户userId，蚂蚁统一会员ID，为必传入参。", "example" : "2088602002015001" } } }, "ZhimaCreditPeZmgoCumulationSyncResponseModel" : { "type" : "object", "properties" : { "agreement_no" : { "type" : "string", "description" : "芝麻go协议号，唯一标识一个芝麻go协议。\t累计成功后返回此字段。", "example" : "20195108518085620000" }, "fail_reason" : { "type" : "string", "description" : "数据回传失败原因描述。\t累计失败后返回此字段。", "example" : "入参userId为空" }, "open_id" : { "type" : "string", "description" : "用户userId，蚂蚁统一会员ID。\t累计成功后返回此字段。", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "out_biz_no" : { "type" : "string", "description" : "外部业务号。需保证唯一，若接口调用失败，提示信息为更换幂等号，商户更换此字段重新发起调用。\t累计成功后返回此字段。", "example" : "2020081211223006150094012926289" }, "user_id" : { "type" : "string", "description" : "用户userId，蚂蚁统一会员ID。\t累计成功后返回此字段。", "example" : "2088602002015001" } } }, "ZhimaCreditPeZmgoPreorderCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "CUSTOM_FREEZE_AMOUNT_NOT_SUPPORT", "NOTIFY_URL_NOT_SUPPORT", "ORDER_INDEPOTENT_FAILED", "TEMPLATE_INVALID", "MERCHANT_AGREEMENT_CHECK_FAILED", "FREEZE_AMOUNT_INVALID", "ORDER_HAS_CLOSED", "SYSTEM_ERROR", "NOT_SUPPORT_DYNAMIC_TEMPLATE", "REQUEST_ACCESS_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaCreditPeZmgoPreorderCreateModel" : { "type" : "object", "properties" : { "alipay_open_id" : { "type" : "string", "description" : "支付宝用户ID。同一个外部请求号，调用方要确保支付宝userId取值不变", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "alipay_user_id" : { "type" : "string", "description" : "支付宝用户ID。同一个外部请求号，调用方要确保支付宝userId取值不变", "example" : "2088759402857364" }, "biz_time" : { "type" : "string", "description" : "业务发生时间，如2016-07-06 00:00:02\t签约超时关单时间依赖这个时间\t这个时间会做幂等校验，如果创单幂等，但时间不同会失败", "example" : "2016-07-06 00:00:02" }, "custom_temp_conf" : { "type" : "string", "description" : "废弃字段，勿用", "example" : "SHOW_AGREEMENT_LIST=true" }, "expire_aisle_data" : { "type" : "string", "description" : "协议到期后通知", "example" : "业务方到期标识" }, "ext_template_conf" : { "$ref" : "#/components/schemas/ExtTemplateConf" }, "extend_params" : { "$ref" : "#/components/schemas/PreOrderExtInfo" }, "freeze_amount" : { "type" : "string", "description" : "冻结金额，单位：元", "example" : "1.00" }, "isv_pid" : { "type" : "string", "description" : "ISV商户ID", "example" : "2088374762857463" }, "out_request_no" : { "type" : "string", "description" : "外部请求号，唯一", "example" : "ORDER_12345678" }, "partner_id" : { "type" : "string", "description" : "商户ID", "example" : "2088437463829741" }, "partner_user_identifier" : { "type" : "string", "description" : "商户侧用户唯一标识。ex.商户侧uid", "example" : "user102934889234" }, "pay_aisle_data" : { "type" : "string", "description" : "结算成功后通知", "example" : "业务方结算标识" }, "sign_aisle_data" : { "type" : "string", "description" : "签约成功后通知", "example" : "业务方签约标识" }, "template_id" : { "type" : "string", "description" : "签约芝麻GO的模板ID", "example" : "2020122200020903760008552025" }, "timeout_express" : { "type" : "string", "description" : "超时关单时间\t默认1H。1m～15d。m表示分钟，h表示小时，d表示天。该参数数值不接受小数点， 如1.5h，可转换为90m\t签约超时关单时间依赖这个时间", "example" : "15m" } } }, "ZhimaCreditPeZmgoPreorderCreateResponseModel" : { "type" : "object", "properties" : { "biz_type" : { "type" : "string", "description" : "业务类型", "example" : "hongbaoqiandao" }, "partner_id" : { "type" : "string", "description" : "商户ID", "example" : "2088990000000000" }, "preorder_no" : { "type" : "string", "description" : "芝麻GO预创建单号", "example" : "ZMGO_ASO2019071000020903940000062019" } } }, "ZhimaCreditPeZmgoSettleApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "PAY_AMOUNT_IDEMPOTENT_ERROR", "SETTLE_ACCEPT_NOT_SUPPORT", "SETTLE_WITHHOLD_PLAN_NOT_EXIST", "SETTLE_WITHHOLD_PLAN_NO_ERROR", "ZMGO_CONFIG_SYSTEM_ERROR", "SETTLE_BALANCE_ACCOUNT_ERROR", "SETTLE_BIZ_ORDER_NOT_EXIST", "ZMGO_BIZ_ORDER_SYSTEM_ERROR", "ZMGO_SYSTEM_AMOUNT_NOT_CLEAR", "ZMGO_CREATE_WPN_SYSTEM_ERROR", "ZMGO_BIZ_AGR_SYSTEM_ERROR", "SETTLE_ILLEGAL_RPC", "SETTLE_WITHHOLD_PLAN_STATUS_ERROR", "SETTLE_BIZ_AGREEMENT_STATUS_FINISH", "BALANCE_AVAILABLE_AMOUNT_NOT_ENOUGH", "ZMGO_ACCEPTED_SYSTEM_ERROR", "SYSTEM_ERROR", "SETTLE_INVALID_SETTLEMENT_INFO", "PAY_AMOUNT_CHECK_ERROR", "CYCLE_WITHHOLD_NOTIN_ACCEPT_TIME", "CYCLE_WITHHOLD_PAY_AMOUNT_ERROR", "REQUEST_ACCESS_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaCreditPeZmgoSettleApplyModel" : { "type" : "object", "properties" : { "action_type" : { "type" : "string", "description" : "DEFAULT_SETTLE 默认结算模式;\tPAY_TO_ZERO 支付转0元；", "example" : "DEFAULT_SETTLE或PAY_TO_ZERO" }, "agreement_id" : { "type" : "string", "description" : "支付宝系统中用以唯一标识用户签约记录的编号。", "example" : "ZMGO_AGR2020122710020604120000000001" }, "alipay_open_id" : { "type" : "string", "description" : "买家在支付宝的用户id", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "alipay_user_id" : { "type" : "string", "description" : "买家在支付宝的用户id", "example" : "2088101117955611" }, "out_request_no" : { "type" : "string", "description" : "商户本次操作的请求流水号，用于标示请求流水的唯一性，不能包含除中文、英文、数字以外的字符，需要保证在商户端不重复。", "example" : "8077735255938032" }, "partner_id" : { "type" : "string", "description" : "商户ID", "example" : "2088102146225135" }, "pay_amount" : { "type" : "string", "description" : "需要支付的金额，单位为：元（人民币），精确到小数点后两位", "example" : "2.00" }, "settle_extend_params" : { "$ref" : "#/components/schemas/SettleExtraParams" }, "total_discount_amount" : { "type" : "string", "description" : "芝麻GO任务开始到到期过程中和任务相关享受的总优惠金额，单位为：元（人民币），精确到小数点后两位。", "example" : "3.00" }, "total_real_pay_amount" : { "type" : "string", "description" : "芝麻GO任务开始到到期过程中和任务相关支付的总金额，单位为：元（人民币），精确到小数点后两位。", "example" : "3.00" }, "total_task_count" : { "type" : "string", "description" : "芝麻GO任务开始到到期过程中和任务相关完成的任务次数", "example" : "0" }, "withhold_plan_no" : { "type" : "string", "description" : "芝麻GO结算时，需要传入的扣款单据号。来源于协议到期通知消息，外部商户接入时，该参数必填", "example" : "ZMGO_WHD2021010510020603410000006001" } } }, "ZhimaCreditPeZmgoSettleApplyResponseModel" : { "type" : "object", "properties" : { "agreement_id" : { "type" : "string", "description" : "支付宝系统中用以唯一标识用户签约记录的编号。", "example" : "ZMGO_AGR2020122710020604120000000001" }, "fail_reason" : { "type" : "string", "description" : "根据商户传入的轻会员协议结算周期内累计消费数据与支付宝端轻会员协议结算周期内消费数据比对之后，若数据不一致，则会返回对应的异常数据比对结果。", "example" : "累计支付宝支付金额不一致,支付宝:100.00元,商户:150.00元" }, "out_request_no" : { "type" : "string", "description" : "商户本次操作的请求流水号，用于标示请求流水的唯一性，不能包含除中文、英文、数字以外的字符，需要保证在商户端不重复。", "example" : "8077735255938032" }, "settle_status" : { "type" : "string", "description" : "Y(\"Y\", \"支付成功\"),\tP(\"P\", \"支付中\"),\tN(\"N\", \"支付失败\"),", "example" : "P" }, "withhold_plan_no" : { "type" : "string", "description" : "芝麻GO结算时，需要传入的扣款单据号。来源于协议到期通知消息", "example" : "ZMGO_WHD2021010510020603410000006001" } } }, "ZhimaCreditPeZmgoSettleRefundErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "AGREEMENT_NOT_EXIST", "REFUND_AMOUNT_CHECK_ERROR", "REQUEST_PARAM_ILLEGAL", "REQUEST_ACCESS_ILLEGAL", "REFUND_PARAM_IS_ERROR", "REFUND_AGREEMENT_STATUS_NOT_SUPPORT", "AUTH_OPT_ORDER_NOT_EXIST", "REFUND_OPT_ORDER_NOT_UNIQUE", "REFUND_OPT_ORDER_NOT_EXIST", "REFUND_TRADE_NO_NOT_EXIST", "REFUND_REQUEST_NO_IDEMPOTENT_FAIL", "AGREEMENT_AND_USER_NOT_MATCH", "REFUND_AMOUNT_IS_ILLEGAL", "REFUND_PAY_AMOUNT_IS_EMPTY", "REFUND_AMOUNT_IS_ZERO", "TRADENO_AND_AUTHOPT_NOT_MATCH", "OPTID_AND_TRADENO_ALL_EMPTY", "AGREEMENT_AND_PARTNER_NOT_MATCH", "REFUND_LAST_TIME_SUCCESS", "REFUND_LAST_TIME_FAIL", "REFUND_LAST_TIME_INIT", "REFUND_AGREEMENT_NOT_EXIST", "UNITRADEPROD_EXECUTE_ERROR", "TRADE_HAS_CLOSE", "SELLER_BALANCE_NOT_ENOUGH", "REFUND_AMT_NOT_EQUAL_TOTAL", "TRADE_NOT_EXIST", "TRADE_HAS_FINISHED", "REASON_TRADE_REFUND_FEE_ERR", "TRADE_NOT_ALLOW_REFUND", "REFUND_FEE_ERROR", "REASON_TRADE_BEEN_FREEZEN", "TRADE_STATUS_ERROR", "REFUND_LAST_TIME_ACCEPT", "REFUND_PAY_AMOUNT_IS_ZERO", "SETTLE_REFUND_ERROR", "SETTLE_REFUND_AMOUNT_ERROR", "SETTLE_WITHHOLD_PLAN_NOT_EXIST", "SETTLE_WITHHOLD_PLAN_STATUS_ERROR", "SETTLE_REFUND_BALANCE_ERROR", "SETTLE_BIZ_AGREEMENT_NOT_EXIST", "SETTLE_REFUND_REQUEST_NO_ERROR", "SETTLE_REFUND_ILLEGAL_ACCESS", "SETTLE_REFUND_TIME_ERROR", "SETTLE_REFUND_NOT_SUPPORT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaCreditPeZmgoSettleRefundModel" : { "type" : "object", "properties" : { "agreement_id" : { "type" : "string", "description" : "签约芝麻GO的业务协议号，在签约成功、结算成功等通知中回回传给商户。", "example" : "ZMGO_AGR2021010510020604080000006001" }, "alipay_open_id" : { "type" : "string", "description" : "支付宝用户ID", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "alipay_user_id" : { "type" : "string", "description" : "支付宝用户ID", "example" : "2088302841345600" }, "memo" : { "type" : "string", "description" : "本次退款说明", "example" : "退款" }, "out_request_no" : { "type" : "string", "description" : "外部请求号", "example" : "99202005050100930053707258" }, "partner_id" : { "type" : "string", "description" : "商户ID", "example" : "2088302424614288" }, "refund_amount" : { "type" : "string", "description" : "退款金额，单位为：元（人民币），精确到小数点后两位", "example" : "3.00" }, "refund_type" : { "type" : "string", "description" : "退款类型：\tMEMBER_FEE_REFUND 会员费结算退款 ，WITHHOLD_FEE_REFUND 周期扣款金额退款。\t不填写默认为 MEMBER_FEE_REFUND", "example" : "MEMBER_FEE_REFUND" }, "withhold_plan_no" : { "type" : "string", "description" : "芝麻侧扣款计划单据号，在结算扣款成功的通知消息中会回传。", "example" : "ZMGO_WHD2021010510020603410000006001" } } }, "ZhimaCreditPeZmgoSettleRefundResponseModel" : { "type" : "object", "properties" : { "fail_reason" : { "type" : "string", "description" : "退款操作错误原因描述", "example" : "退款金额超限" }, "out_request_no" : { "type" : "string", "description" : "外部请求号", "example" : "99202005050100930053707258" }, "refund_amount" : { "type" : "string", "description" : "本次请求退款金额", "example" : "3.00" }, "refund_opt_no" : { "type" : "string", "description" : "芝麻GO退款生成的内部唯一流水，外部商户可以拿这个参数进行对账", "example" : "ZMGO_OPT202107271002060716000012522x" }, "retry" : { "type" : "boolean", "description" : "此字段含义，商家接入时需咨询对接技术。", "example" : "true" }, "withhold_plan_no" : { "type" : "string", "description" : "本次退款的扣款计划单号", "example" : "ZMGO_WHD2021010510020603410000006001" } } }, "ZhimaCreditPeZmgoSettleUnfreezeErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "ZMGO_CONFIG_SYSTEM_ERROR", "BALANCE_AVAILABLE_AMOUNT_NOT_ENOUGH", "BALANCE_ACCOUNT_MISSING", "BIZ_ORDER_NOT_EXIST_FAILURE", "SETTLE_BIZ_AGREEMENT_NOT_EXIST", "UNFREEZE_AGR_N_STATUS", "BIZ_OPT_IDEMPOTENT_FAILURE", "BIZ_OPT_UPDATE_FAILURE", "BALANCE_USER_LOCK_COLLISION", "BALANCE_IDEMPOTENT_CHECK_FAILURE", "BALANCE_SYSTEM_AMOUNT_NOT_ENOUGH", "REQUEST_ACCESS_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaCreditPeZmgoSettleUnfreezeModel" : { "type" : "object", "properties" : { "agreement_id" : { "type" : "string", "description" : "支付宝系统中用以唯一标识用户签约记录的编号，即花呗先享协议号", "example" : "20185513447859192007" }, "alipay_open_id" : { "type" : "string", "description" : "买家在支付宝的用户id", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "alipay_user_id" : { "type" : "string", "description" : "买家在支付宝的用户id", "example" : "2088101117955611" }, "biz_time" : { "type" : "string", "description" : "解冻成功时间", "example" : "2014-09-15 11:23:04" }, "order_title" : { "type" : "string", "description" : "解冻的描述", "example" : "2088411663864410" }, "out_request_no" : { "type" : "string", "description" : "商户本次操作的请求流水号，用于标识请求流水的唯一性，不能包含除中文、英文、数字以外的字符，需要保证在商户端不重复。由商户传入，最终返回给商户。", "example" : "8077735255938032" }, "partner_id" : { "type" : "string", "description" : "商户ID", "example" : "2088411663864410" }, "unfreeze_amount" : { "type" : "string", "description" : "解冻金额", "example" : "3.00" }, "unfreeze_extend_params" : { "$ref" : "#/components/schemas/UnfreezeExtendParams" } } }, "ZhimaCreditPeZmgoSettleUnfreezeResponseModel" : { "type" : "object", "properties" : { "fail_reaseon" : { "type" : "string", "description" : "失败原因", "example" : "余额户可用资金不足" }, "retry" : { "type" : "string", "description" : "是否可以重试", "example" : "true|false" }, "unfreeze_amount" : { "type" : "string", "description" : "解冻金额字符串", "example" : "1.00" }, "unfreeze_status" : { "type" : "string", "description" : "解冻状态", "example" : "Y/N" } } }, "ZhimaCustomerJobworthAuthenticationQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "USER_NOT_AUTHORIZE", "TOKEN_INVALID", "NOT_OPEN_ZM", "USER_NOT_OPEN_JOBWORTH", "INVALID_PARAMETER", "JOB_WORTH_BLACK_LIST", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaCustomerJobworthAuthenticationQueryResponseModel" : { "type" : "object", "properties" : { "identity_result" : { "type" : "string", "description" : "SUCCESS代表可信，FAILED代表不可信，WAITING_VERIFY代表未知需要等待结果", "example" : "SUCCESS/FAILED/WAITING_VERIFY" }, "identity_result_skip_url" : { "type" : "string", "description" : "身份认证查询结果页面的小程序链接，有芝麻提供，用户在端内可直接访问", "example" : "alipays://platformapi/startapp?appId" }, "token_status" : { "type" : "string", "description" : "代表订单状态", "example" : "FINISH" } } }, "ZhimaCustomerJobworthCloudresumeQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "USER_NOT_AUTHORIZE", "QUERY_DATA_IS_NULL", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaCustomerJobworthCloudresumeQueryResponseModel" : { "type" : "object", "properties" : { "birthday" : { "type" : "string", "description" : "出身日期", "example" : "出生日期" }, "certificates" : { "type" : "array", "description" : "证书名称", "items" : { "$ref" : "#/components/schemas/CloudResumeCertificateInfo" } }, "education_experiences" : { "type" : "array", "description" : "教育经历", "items" : { "$ref" : "#/components/schemas/CloudResumeEducationExperience" } }, "gender" : { "type" : "string", "description" : "性别", "example" : "男 or 女" }, "phone" : { "type" : "string", "description" : "手机号码", "example" : "1234" }, "pic_url" : { "$ref" : "#/components/schemas/CloudResumeHeadPic" }, "position_intentions" : { "type" : "array", "description" : "求职期望", "items" : { "$ref" : "#/components/schemas/CloudResumePositionIntention" } }, "skills" : { "type" : "array", "description" : "技能信息", "items" : { "$ref" : "#/components/schemas/CloudResumeSkillInfo" } }, "user_name" : { "type" : "string", "description" : "姓名", "example" : "姓名" }, "work_experiences" : { "type" : "array", "description" : "工作经历", "items" : { "$ref" : "#/components/schemas/CloudResumeWorkExperience" } }, "work_start_date" : { "type" : "integer", "description" : "工作开始日期", "example" : "123" } } }, "ZhimaCustomerJobworthInfoQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "BLACK_CONTROL", "JOB_ID_NOT_MATCH", "CONFIG_ERROR_WITHOUT_SERVICE_ID", "USER_NOT_AUTHORIZE", "ILLEGAL_ARGUMENT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaCustomerJobworthInfoQueryResponseModel" : { "type" : "object", "properties" : { "acceptance_id" : { "type" : "string", "description" : "受理台单号作为jsapi的一个参数。如果不使用jsapi可以忽略", "example" : "ZMEV99202108230100080001977388" }, "auth_token" : { "type" : "string", "description" : "用于授权校验,授权之前需要通过token校验", "example" : "124780137240912384128394" }, "html_url" : { "type" : "string", "description" : "h5url", "example" : "https://ssss" }, "picture_url" : { "type" : "string", "description" : "职得工作证图片url,可以直接用于展示", "example" : "http://www.123.com" }, "scene_result" : { "type" : "boolean", "description" : "场景授权结果", "example" : "true" }, "sub_code" : { "type" : "string", "description" : "业务编码", "example" : "USER_NOT_OPEN_ZHIMA" }, "sub_msg" : { "type" : "string", "description" : "业务中文结果信息", "example" : "用户没有开通芝麻" }, "update_url" : { "type" : "string", "description" : "工作证图片更新的url,需要跳转到工作证小程序中进行更新", "example" : "http://www.123123.com" }, "url" : { "type" : "string", "description" : "职得工作证跳转小程序链接", "example" : "http://www.123.com?XXX" } } }, "ZhimaCustomerJobworthJobdataAddErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "ILLEGAL_ARGUMENT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaCustomerJobworthJobdataAddModel" : { "type" : "object", "properties" : { "cert_no" : { "type" : "string", "description" : "身份证证件号", "example" : "1101121983010****5" }, "cert_type" : { "type" : "string", "description" : "0:身份证1:护照2:台湾同胞回乡证3:港澳居民往来内地通行证4:台湾居民通行证5:港澳居民通行证", "example" : "0" }, "conn_key" : { "type" : "string", "description" : "关联key，受理台返回", "example" : "abcd12345678" }, "job_data_list" : { "type" : "array", "description" : "回传信息", "items" : { "$ref" : "#/components/schemas/JobWorthJobdata" } }, "open_id" : { "type" : "string", "description" : "支付宝uid", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "user_id" : { "type" : "string", "description" : "支付宝uid", "example" : "2088302586280165" }, "user_name" : { "type" : "string", "description" : "用户中文名", "example" : "张三" } } }, "ZhimaCustomerJobworthJobdataAddResponseModel" : { "type" : "object", "properties" : { "acceptance_id" : { "type" : "string", "description" : "受理台单号，用来调用工作证受理台", "example" : "abcd1234" }, "sub_code" : { "type" : "string", "description" : "错误码", "example" : "INVALID_PARAMETER" }, "sub_msg" : { "type" : "string", "description" : "业务中文结果信息", "example" : "参数有误" }, "url" : { "type" : "string", "description" : "职得工作证跳转小程序链接", "example" : "http://www.123.com?XXX" } } }, "ZhimaCustomerJobworthPictureUploadErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "ILLEGAL_ARGUMENT", "PICTURE_UPLOAD_LIMIT_ERROR", "PICTURE_TYPE_ERROR", "SYSTEM_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaCustomerJobworthPictureUploadModel" : { "type" : "object", "properties" : { "content" : { "type" : "string", "description" : "图片对应的base64字符串，支持jpg和png，1M之内", "example" : "-" }, "pic_type" : { "type" : "string", "description" : "只能传入指定类型，具体类型看文档", "example" : "JOB_DATA_UPLOAD" } } }, "ZhimaCustomerJobworthPictureUploadResponseModel" : { "type" : "object", "properties" : { "pic_id" : { "type" : "string", "description" : "图片返回ID", "example" : "abcd123456" }, "sub_code" : { "type" : "string", "description" : "错误码", "example" : "PICTURE_UPLOAD_LIMIT_ERROR" }, "sub_msg" : { "type" : "string", "description" : "错误原因", "example" : "图片上传限制" } } }, "ZhimaCustomerJobworthPositionAddErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaCustomerJobworthPositionAddModel" : { "type" : "object", "properties" : { "jobworth_position_info" : { "$ref" : "#/components/schemas/JobWorthPositionInfo" } } }, "ZhimaCustomerJobworthPositionAddResponseModel" : { "type" : "object", "properties" : { "position_id" : { "type" : "string", "description" : "岗位信息ID", "example" : "123456789012345678901234" }, "sub_code" : { "type" : "string", "description" : "业务错误", "example" : "SALARY_ERROR" }, "sub_msg" : { "type" : "string", "description" : "业务错误信息", "example" : "薪水格式错误" } } }, "ZhimaMerchantSubsidiariesApplyErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "CREDIT_SERVICE_ID_NOT_EXIST", "SECURITY_RISK_ERROR", "SECURITY_RISK_NOT_PASS", "BIZ_FAIL", "PROCESS_DUPLICATION_ERROR", "DATA_UPDATE_ERROR", "PROCESS_ADD_ERROR", "FILE_TYPE_ILLEGAL", "FILE_VERIFY_WIDTH_HEIGHT_FAIL", "FILE_LOGO_CHECK_FAIL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaMerchantSubsidiariesApplyModel" : { "type" : "object", "properties" : { "pid" : { "type" : "string", "description" : "商户pid", "example" : "2088101117955612" }, "service_id" : { "type" : "string", "description" : "信用服务id", "example" : "20210413000000000000xxxxxxxx" }, "smid" : { "type" : "string", "description" : "二级商户进件id", "example" : "2088101118048455" }, "sub_merchant_contact_number" : { "type" : "string", "description" : "子商户联系电话", "example" : "200-000-0000" }, "sub_merchant_jump_link" : { "type" : "string", "description" : "子商户跳转链接", "example" : "https://xxxxxxxx" }, "sub_merchant_logo_url" : { "type" : "string", "description" : "子商户logo地址", "example" : "https://xxxxxxxx" }, "sub_merchant_name" : { "type" : "string", "description" : "子商户名", "example" : "XXX商户" }, "sub_pid" : { "type" : "string", "description" : "子商户id", "example" : "2088101117955611" } } }, "ZhimaMerchantSubsidiariesApplyResponseModel" : { "type" : "object", "properties" : { "biz_error_code" : { "type" : "string", "description" : "业务错误码", "example" : "1001" }, "biz_error_message" : { "type" : "string", "description" : "业务错误信息", "example" : "处理失败" }, "order_no" : { "type" : "string", "description" : "工单标识", "example" : "100010" } } }, "ZhimaMerchantSubsidiariesCloseErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "BIZ_FAIL", "INVALID_PARAMETER", "DATA_UPDATE_ERROR", "PROCESS_CANCEL_ERROR", "NO_AUTHORITY_HANDLE_DISSENT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaMerchantSubsidiariesCloseModel" : { "type" : "object", "properties" : { "order_no" : { "type" : "string", "description" : "工单标识", "example" : "100010" } } }, "ZhimaMerchantSubsidiariesCloseResponseModel" : { "type" : "object", "properties" : { "biz_error_code" : { "type" : "string", "description" : "业务错误码", "example" : "1001" }, "biz_error_message" : { "type" : "string", "description" : "业务错误信息", "example" : "处理失败" }, "order_memo" : { "type" : "string", "description" : "工单审核备注", "example" : "审核通过" }, "order_no" : { "type" : "string", "description" : "工单标识，业务成功时返回工单号", "example" : "100010" }, "order_status" : { "type" : "string", "description" : "工单状态", "example" : "AGREE" } } }, "ZhimaMerchantZmgoCumulateQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaMerchantZmgoCumulateQueryResponseModel" : { "type" : "object", "properties" : { "aggr_amount" : { "type" : "string", "description" : "总共累计金额", "example" : "99.99" }, "aggr_discount_amount" : { "type" : "string", "description" : "总共累计优惠金额", "example" : "83.88" }, "aggr_times" : { "type" : "integer", "description" : "总共累计次数", "example" : "4" }, "agreement_id" : { "type" : "string", "description" : "芝麻go协议号，唯一标识一个芝麻go协议。", "example" : "20195108518085620000" }, "detail_list" : { "type" : "array", "description" : "详情数据列表", "items" : { "$ref" : "#/components/schemas/CumulateDataDetail" } }, "fail_reason" : { "type" : "string", "description" : "查询失败原因", "example" : "协议已经失效" }, "page_no" : { "type" : "integer", "description" : "分页参数，返回传入的值。", "example" : "1" }, "page_size" : { "type" : "integer", "description" : "分页参数，返回传入的值。", "example" : "20" } } }, "ZhimaMerchantZmgoCumulateSyncErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "AGREEMENT_STATUS_INVALID" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaMerchantZmgoCumulateSyncModel" : { "type" : "object", "properties" : { "agreement_id" : { "type" : "string", "description" : "芝麻go协议号，唯一标识一个芝麻go协议。", "example" : "20195108518085620000" }, "amount_type_sync_data" : { "$ref" : "#/components/schemas/AmountTypeSyncData" }, "biz_action" : { "type" : "string", "description" : "数据回传的动作类型。枚举如下：\t* POSITIVE：正向回传，即订单金额累加，优惠累加，任务次数累加。\t* REVERSE：逆向回传，即订单金额退款，优惠退款，任务次数回退。", "example" : "POSITIVE" }, "biz_time" : { "type" : "string", "description" : "回传数据发生的实际时间，包括：订单交易时间，优惠核销时间，以及任务完成时间。为必传入参。 如：用户在【2019-03-08 00:00:00】核销了一个红包，但是【2019-03-10 00:00:00】才进行数据回传，此时biz_time取值红包核销的时间，也就是【2019-03-08 00:00:00】。", "example" : "2019-03-08 19:51:35" }, "data_type" : { "type" : "string", "description" : "回传数据类型，枚举：\tTASK - 进度型，影响进度\tDISCOUNT - 优惠型", "example" : "TASK" }, "discount_type_sync_data" : { "$ref" : "#/components/schemas/DiscountTypeSyncData" }, "open_id" : { "type" : "string", "description" : "用户 id，用户在支付宝的唯一标识，以 2088 开头的 16 位纯数字组成。", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "out_biz_no" : { "type" : "string", "description" : "外部业务号，唯一标识一笔回传数据。", "example" : "2020081211223006150094012926289" }, "provider_pid" : { "type" : "string", "description" : "数据回传的商户 ID，即和用户发生业务来往的 PID 主体。商户账号在支付宝的唯一标识，以 2088 开头的 16 位纯数字组成。", "example" : "2088621805983504" }, "refer_out_biz_no" : { "type" : "string", "description" : "逆向对应的正向外部业务号。逆向场景为必传入参。也就是biz_action为REVERSE时为必传入参。 逆向时需通过此字段明确对应的正向的外部业务号。", "example" : "2020081211223006150094012926289" }, "sub_biz_action" : { "type" : "string", "description" : "数据回传动作子类型，枚举值，为必传入参。\tADD - 新增数据\tUPDATE - 修改数据\t备注：UPDATE只能更新金额信息。", "example" : "ADD" }, "times_type_sync_data" : { "$ref" : "#/components/schemas/TimesTypeSyncData" }, "user_id" : { "type" : "string", "description" : "用户 id，用户在支付宝的唯一标识，以 2088 开头的 16 位纯数字组成。\t", "example" : "2088602002015001" } } }, "ZhimaMerchantZmgoCumulateSyncResponseModel" : { "type" : "object", "properties" : { "agreement_id" : { "type" : "string", "description" : "芝麻go协议号，唯一标识一个芝麻go协议。", "example" : "20195108518085620000" }, "fail_reason" : { "type" : "string", "description" : "数据回传失败原因描述", "example" : "协议已经失效" }, "out_biz_no" : { "type" : "string", "description" : "外部业务号，唯一标识一笔回传数据。", "example" : "2020081211223006150094012926289" } } }, "ZhimaMerchantZmgoTemplateCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "CHECK_DEFAULT_VALUE_FAIL", "INVALID_CYCLE_FLEX_WITHHOLD_CONFIG", "INVALID_FULFILL_TIMES_SETTLE_PLAN", "INVALID_FREEZE_AMOUNT", "INVALID_CUSTOM_OPEN_TIP_LIST", "INVALID_SETTLEMENT_TYPE", "INVALID_QUIT_TYPE", "INVALID_BIZ_TYPE", "INVALID_PERIOD_MODE", "INVALID_APPOINT_DATE", "INVALID_PERIOD_TIME", "REQUEST_ACCESS_ILLEGAL", "INVALID_TEXT_CONTENT_FILL_VARIABLE", "INVALID_TEXT_CONTENT_FILL_RULEID", "CUSTOM_MERCHANT_LOGO_PREFIX_ILLEGAL", "CONTENT_SEC_CHECK_FAIL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaMerchantZmgoTemplateCreateModel" : { "type" : "object", "properties" : { "basic_config" : { "$ref" : "#/components/schemas/ZMGOBasicConfig" }, "ext_config" : { "$ref" : "#/components/schemas/ZMGOExtConfig" }, "obligation_config" : { "$ref" : "#/components/schemas/ZMGOObligationConfig" }, "open_config" : { "$ref" : "#/components/schemas/ZMGOOpenConfig" }, "quit_config" : { "$ref" : "#/components/schemas/ZMGOQuitConfig" }, "right_config" : { "$ref" : "#/components/schemas/ZMGORightConfig" }, "settlement_config" : { "$ref" : "#/components/schemas/ZMGOSettlementConfig" } } }, "ZhimaMerchantZmgoTemplateCreateResponseModel" : { "type" : "object", "properties" : { "template_no" : { "type" : "string", "description" : "芝麻GO模板号", "example" : "ZMGO_TPL202206091002000195047" } } }, "ZhimaMerchantZmgoTemplateQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "REQUEST_ACCESS_ILLEGAL" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZhimaMerchantZmgoTemplateQueryResponseModel" : { "type" : "object", "properties" : { "basic_config" : { "$ref" : "#/components/schemas/ZMGOBasicConfig" }, "ext_config" : { "$ref" : "#/components/schemas/ZMGOExtConfig" }, "obligation_config" : { "$ref" : "#/components/schemas/ZMGOObligationConfig" }, "open_config" : { "$ref" : "#/components/schemas/ZMGOOpenConfig" }, "quit_config" : { "$ref" : "#/components/schemas/ZMGOQuitConfig" }, "right_config" : { "$ref" : "#/components/schemas/ZMGORightConfig" }, "settlement_config" : { "$ref" : "#/components/schemas/ZMGOSettlementConfig" } } }, "ZhubUidTelPair" : { "type" : "object", "properties" : { "open_id" : { "type" : "string", "description" : "支付宝用户open_id", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "phone" : { "type" : "string", "description" : "手机号", "example" : "13817337490" }, "user_id" : { "type" : "string", "description" : "支付宝uid", "example" : "2088302193568425" } } }, "ZolozAuthenticationCustomerFacemanageCreateErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "EXTRACT_FAIL", "UNABLE_GET_IMAGE", "ILLEGAL_CERT", "NOT_OPEN_SMILE", "UID_NOT_FOUND" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZolozAuthenticationCustomerFacemanageCreateModel" : { "type" : "object", "properties" : { "areacode" : { "type" : "string", "description" : "地域编码", "example" : "010" }, "biz_type" : { "type" : "string", "description" : "人脸产品能力，预热场景，需要传college，k12，scenic，subway，traffic。具体值视具体场景", "example" : "1" }, "bizscale" : { "type" : "string", "description" : "业务量规模", "example" : "99999999活跃人数" }, "brandcode" : { "type" : "string", "description" : "商户品牌", "example" : "KFC" }, "devicenum" : { "type" : "string", "description" : "商户机具唯一编码，关键参数\t人脸预热，传logicGroupId", "example" : "123456" }, "extinfo" : { "type" : "string", "description" : "拓展参数", "example" : "{}" }, "facetype" : { "type" : "string", "description" : "入库类型 IDCARD:身份证 ALIPAY_USER:支付宝用户id, ALIPAY_TEL:手机号入库 CUSTOMER:自定义 DIRECT_CLIENT_PRE：本地预写入 DIRECT_CLIENT：本地客户端库 ENCLOSED：封闭场景", "example" : "DIRECT_CLIENT" }, "faceval" : { "type" : "string", "description" : "入库用户信息 人脸预热，alipayUid必填", "example" : "示例[{\"alipayUid\":\"2088402144983195\",\"customUserId\":\"01\", \"faceContent\":\"base64String\"}]" }, "group" : { "type" : "string", "description" : "分组5", "example" : "group0" }, "storecode" : { "type" : "string", "description" : "球房编码", "example" : "HZ1000435" }, "validtimes" : { "type" : "string", "description" : "有效期天数，如7天、30天、365天", "example" : "7" } } }, "ZolozAuthenticationCustomerFacemanageCreateResponseModel" : { "type" : "object", "properties" : { "result" : { "type" : "string", "description" : "业务结果", "example" : "{}" }, "retcode" : { "type" : "string", "description" : "返回码", "example" : "OK_SUCCESS" }, "retcodesub" : { "type" : "string", "description" : "返回详细码", "example" : "Z3161" }, "retmessage" : { "type" : "string", "description" : "返回信息", "example" : "成功" }, "retmessagesub" : { "type" : "string", "description" : "返回详细信息", "example" : "非法参数类型" } } }, "ZolozAuthenticationCustomerFacemanageDeleteErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZolozAuthenticationCustomerFacemanageDeleteModel" : { "type" : "object", "properties" : { "areacode" : { "type" : "string", "description" : "地域编码", "example" : "010" }, "biz_type" : { "type" : "string", "description" : "人脸产品能力", "example" : "1" }, "bizscale" : { "type" : "string", "description" : "业务量", "example" : "9999999999" }, "brandcode" : { "type" : "string", "description" : "商户品牌", "example" : "KFC" }, "devicenum" : { "type" : "string", "description" : "商户机具唯一编码，关键参数", "example" : "商户机具唯一编码" }, "extinfo" : { "type" : "string", "description" : "拓展参数", "example" : "{}" }, "facetype" : { "type" : "string", "description" : "入库类型\tIDCARD:身份证\tALIPAY_USER:支付宝用户id,\tALIPAY_TEL:手机号入库\tCUSTOMER:自定义", "example" : "IDCARD,ALIPAY_USER, ALIPAY_TEL,CUSTOMER" }, "faceval" : { "type" : "string", "description" : "入库用户信息", "example" : "类型为IDCARD数据格式：[{\"certName\": \"张三\",\"certNo\":\"3101101999xxxxxxxx\",\"certType\":\"IDCARD\"}]类型ALIPAY_USER数据格式:[{\"alipayUid\":\"20885022\"}]" }, "group" : { "type" : "string", "description" : "分组", "example" : "group0" }, "storecode" : { "type" : "string", "description" : "球房编码", "example" : "HZ1000435" }, "validtimes" : { "type" : "string", "description" : "有效期天数，如7天、30天、365天", "example" : "7" } } }, "ZolozAuthenticationCustomerFacemanageDeleteResponseModel" : { "type" : "object", "properties" : { "result" : { "type" : "string", "description" : "返回值", "example" : "{}" }, "retcode" : { "type" : "string", "description" : "返回码", "example" : "OK_SUCCESS" }, "retcodesub" : { "type" : "string", "description" : "返回详细码", "example" : "Z3111" }, "retmessage" : { "type" : "string", "description" : "返回信息", "example" : "成功" }, "retmessagesub" : { "type" : "string", "description" : "返回详细信息", "example" : "出库成功" } } }, "ZolozAuthenticationCustomerFtokenQueryErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "BIZ_ERROR", "INVALID_PARAMETER", "SYSTEM_ERROR", "FTOKEN_INVALID", "TOKEN_NOT_FOUND", "UID_NOT_FOUND", "TOKEN_EXPIRED", "TOKEN_CONSUMED" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZolozAuthenticationCustomerFtokenQueryModel" : { "type" : "object", "properties" : { "biz_type" : { "type" : "string", "description" : "1、1：1人脸验证能力\r\t2、1：n人脸搜索能力（支付宝uid入库）\r\t3、1：n人脸搜索能力（支付宝手机号入库）\r\t4、手机号和人脸识别综合能力", "example" : "1" }, "ext_info" : { "$ref" : "#/components/schemas/FaceExtInfo" }, "ftoken" : { "type" : "string", "description" : "人脸token", "example" : "fp0593e8d5c136277f13fd5bc36c13a7db7" }, "zim_id" : { "type" : "string", "description" : "刷脸初始化流程中产生的zimId值", "example" : "3b35b4677de2c69bb5bab69a4a5168d62" } } }, "ZolozAuthenticationCustomerFtokenQueryResponseModel" : { "type" : "object", "properties" : { "age_check_result" : { "type" : "string", "description" : "年龄是否在指定范围内，未指定范围则返回空，true/false", "example" : "true" }, "authimg_base_64" : { "type" : "string", "description" : "图片base64 encodeString", "example" : "图片base64 encodeString" }, "cert_name" : { "type" : "string", "description" : "证件姓名", "example" : "张三" }, "cert_no" : { "type" : "string", "description" : "身份证号码", "example" : "身份证号码" }, "face_id" : { "type" : "string", "description" : "由ISV定义的对自然人唯一编码，举例可以是身份证号码和姓名的MD5值，或者是其他编码方式，要求脱敏、随机且在ISV可以唯一说明一个自然人", "example" : "6458f8361582010447730145389650" }, "open_id" : { "type" : "string", "description" : "支付宝用户open_id", "example" : "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5" }, "uid" : { "type" : "string", "description" : "支付宝uid", "example" : "2088002842508713" }, "uid_tel_pair_list" : { "type" : "array", "description" : "用户名信息返回的列表", "items" : { "$ref" : "#/components/schemas/ZhubUidTelPair" } } } }, "ZolozAuthenticationCustomerSmilepayInitializeErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "SYSTEM_ERROR", "INVALID_PARAMETER", "BIZ_ERROR", "MACHINE_SERVICE_SUSPEND", "BIZ_ID_REPEAT" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZolozAuthenticationCustomerSmilepayInitializeModel" : { "type" : "object", "properties" : { "service_id" : { "type" : "string", "description" : "刷脸服务Id", "example" : "pay-刷脸支付\nauth-刷脸核身" }, "service_params" : { "type" : "string", "description" : "商户可传入刷脸服务所需的扩展参数，json格式", "example" : "{\"key1\": \"value1\"}" }, "zimmetainfo" : { "type" : "string", "description" : "{ \"apdidToken\": \"设备指纹\", \"appName\": \"应用名称\", \"appVersion\": \"应用版本\", \"bioMetaInfo\": \"生物信息如2.3.0:3,-4\" }", "example" : "{ \"apdidToken\": \"设备指纹\", \"appName\": \"应用名称\", \"appVersion\": \"应用版本\", \"bioMetaInfo\": \"生物信息如2.3.0:3,-4\" }" } } }, "ZolozAuthenticationCustomerSmilepayInitializeResponseModel" : { "type" : "object", "properties" : { "result" : { "type" : "string", "description" : "返回值", "example" : "{\"zimId\":\"54acb4edf8884e9c38c5c3614cc53ae3c\",\"type\":\"zimInit\",\"zimInitClientData\":\"唤起人脸客户端参数\"}" } } }, "ZolozAuthenticationSmilepayInitializeErrorResponseModel" : { "required" : [ "code", "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "错误码", "enum" : [ "INVALID_PARAMETER", "SYSTEM_ERROR", "BIZ_ERROR" ] }, "links" : { "type" : "string", "description" : "解决方案链接" }, "message" : { "type" : "string", "description" : "错误描述" } } }, "ZolozAuthenticationSmilepayInitializeModel" : { "type" : "object", "properties" : { "apdid_token" : { "type" : "string", "description" : "设备指纹，用于唯一标识一台设备", "example" : "40Kl9e97cQcMJka5gfT0arVPq7GTaR6yE5f73mj8zqBW9eOPZQEAAA==" }, "app_name" : { "type" : "string", "description" : "人脸识别应用名称", "example" : "com.alipay.zoloz.smile" }, "app_version" : { "type" : "string", "description" : "人脸识别应用版本号", "example" : "3.7.0.201809191618" }, "base_ver" : { "type" : "string", "description" : "基础包版本号", "example" : "7.1.1" }, "bio_meta_info" : { "type" : "string", "description" : "生物识别元信息", "example" : "3.13.0:12419136,6" }, "device_model" : { "type" : "string", "description" : "设备型号", "example" : "T2" }, "device_type" : { "type" : "string", "description" : "设备类型", "example" : "android" }, "ext_info" : { "$ref" : "#/components/schemas/FaceExtParams" }, "machine_info" : { "$ref" : "#/components/schemas/FaceMachineInfo" }, "merchant_info" : { "$ref" : "#/components/schemas/FaceMerchantInfo" }, "os_version" : { "type" : "string", "description" : "操作系统版本号", "example" : "7.1.1" }, "remote_log_id" : { "type" : "string", "description" : "业务ID", "example" : "bcf71c4290f288f4421ee9d49eedbf1e2840ba" }, "zim_ver" : { "type" : "string", "description" : "ZIM版本号", "example" : "1.0.0" } } }, "ZolozAuthenticationSmilepayInitializeResponseModel" : { "type" : "object", "properties" : { "ret_code_sub" : { "type" : "string", "description" : "返回详细码", "example" : "Z3161" }, "ret_message_sub" : { "type" : "string", "description" : "返回详细信息", "example" : "操作成功" }, "zim_id" : { "type" : "string", "description" : "ZIM上下文ID", "example" : "e0bdf675bc8b6f442eb03b2109d59c92d" }, "zim_init_client_data" : { "type" : "string", "description" : "客户端协议", "example" : "客户端渲染数据，JSON或PB格式" } } } }, "parameters" : { "AuthToken" : { "name" : "auth_token", "in" : "query", "description" : "用户授权令牌", "allowEmptyValue" : true, "schema" : { "type" : "string" } }, "TargetAppId" : { "name" : "target_app_id", "in" : "query", "description" : "目标isv应用ID", "schema" : { "type" : "string" } } } } }