openapi: 3.0.3 info: contact: name: 开放平台文档中心 url: https://openhome.alipay.com/developmentDocument.htm description: 支付宝开放平台v3协议文档 title: 支付宝开放平台API version: 2024-04-07 servers: - description: Production server url: https://openapi.alipay.com - description: Sandbox server url: http://openapi.sandbox.dl.alipaydev.com paths: /v3/alios/open/auto/info/query: get: description: 用户授权商户可获取用户的车辆信息后商户可通过openapi获取车辆信息 operationId: alios.open.auto.info.query parameters: - allowEmptyValue: true description: 用户授权令牌 explode: true in: query name: auth_token required: false schema: type: string style: form - description: 蚂蚁统一会员ID explode: true in: query name: user_id required: false schema: example: "33424562" type: string style: form - description: 经度 explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form - description: 设备token explode: true in: query name: device_token required: false schema: example: cn-shanghai.e81fe6ffe0214049be4da405b3e78849 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AliosOpenAutoInfoQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alios_open_auto_info_query_default_response' description: 请求失败 summary: 查询阿里车的车辆信息 tags: - alios.open.auto.info x-accepts: application/json /v3/alipay/boss/fnc/invoice/apply: post: description: 根据账单申请应收发票开票 operationId: alipay.boss.fnc.invoice.apply requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayBossFncInvoiceApplyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayBossFncInvoiceApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_boss_fnc_invoice_apply_default_response' description: 请求失败 summary: 应收开票申请(根据账单申请) tags: - alipay.boss.fnc.invoice x-content-type: application/json x-accepts: application/json /v3/alipay/boss/fnc/invoice/batchquery: post: description: 根据综合查询条件查询对应发票信息 operationId: alipay.boss.fnc.invoice.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayBossFncInvoiceBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayBossFncInvoiceBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_boss_fnc_invoice_batchquery_default_response' description: 请求失败 summary: 应收发票综合查询 tags: - alipay.boss.fnc.invoice x-content-type: application/json x-accepts: application/json /v3/alipay/boss/fnc/invoice/query: get: description: 根据发票综合查询接口(alipay.boss.fnc.invoice.batchquery)查询到发票列表后,再根据每个发票对应的发票id查询发票的详细信息 operationId: alipay.boss.fnc.invoice.query parameters: - description: 查询ID:用于标示一张发票,通过发票综合查询可以查询到该ID。 explode: true in: query name: invoice_id required: false schema: example: 如:2017060210122000040400270002815483 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayBossFncInvoiceQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_boss_fnc_invoice_query_default_response' description: 请求失败 summary: 根据发票ID查询发票信息 tags: - alipay.boss.fnc.invoice x-accepts: application/json /v3/alipay/boss/fnc/invoicereceipt/batchquery: post: description: 根据月账单号集合和来源查询开票单据及金额汇总 operationId: alipay.boss.fnc.invoicereceipt.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayBossFncInvoicereceiptBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayBossFncInvoicereceiptBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_boss_fnc_invoicereceipt_batchquery_default_response' description: 请求失败 summary: 根据月账单号集合和来源查询开票单据及金额汇总 tags: - alipay.boss.fnc.invoicereceipt x-content-type: application/json x-accepts: application/json /v3/alipay/boss/fnc/invoicereceipt/create: post: description: 月帐单创建消息同步 operationId: alipay.boss.fnc.invoicereceipt.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayBossFncInvoicereceiptCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayBossFncInvoicereceiptCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_boss_fnc_invoicereceipt_create_default_response' description: 请求失败 summary: 账单变更同步接口月帐单创建消息同步 tags: - alipay.boss.fnc.invoicereceipt x-content-type: application/json x-accepts: application/json /v3/alipay/boss/fnc/userinvoiceinfo/create: post: description: 申请开票alipay.boss.fnc.invoice.create之前需要维护的开票资料信息 operationId: alipay.boss.fnc.userinvoiceinfo.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayBossFncUserinvoiceinfoCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayBossFncUserinvoiceinfoCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_boss_fnc_userinvoiceinfo_create_default_response' description: 请求失败 summary: 新增客户开票资料 tags: - alipay.boss.fnc.userinvoiceinfo x-content-type: application/json x-accepts: application/json /v3/alipay/boss/fnc/userinvoiceinfo/modify: post: description: 通过查询用户的开票资料(alipay.boss.fnc.userinvoiceinfo.query)后进行开票资料的修改 operationId: alipay.boss.fnc.userinvoiceinfo.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayBossFncUserinvoiceinfoModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayBossFncUserinvoiceinfoModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_boss_fnc_userinvoiceinfo_modify_default_response' description: 请求失败 summary: 修改用户开票资料 tags: - alipay.boss.fnc.userinvoiceinfo x-content-type: application/json x-accepts: application/json /v3/alipay/boss/fnc/userinvoiceinfo/query: get: description: 根据PID获取相关的开票资料 operationId: alipay.boss.fnc.userinvoiceinfo.query parameters: - description: 开票pid/mid/ou,唯一标识商户信息/集团用户信息的ID explode: true in: query name: pid required: false schema: example: "2088001007243670" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayBossFncUserinvoiceinfoQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_boss_fnc_userinvoiceinfo_query_default_response' description: 请求失败 summary: 根据PID获取相关的开票资料 tags: - alipay.boss.fnc.userinvoiceinfo x-accepts: application/json /v3/alipay/commerce/cityfacilitator/station/query: get: description: 商户App获取地铁购票开放购票的站点和禁止到达的站点 operationId: alipay.commerce.cityfacilitator.station.query parameters: - description: "城市编码请参考查询 中华人民共和国行政区划代码。\t已支持城市:广州 440100,深圳 440300,杭州330100。" explode: true in: query name: city_code required: false schema: example: "440300" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceCityfacilitatorStationQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_cityfacilitator_station_query_default_response' description: 请求失败 summary: 地铁购票站点数据查询 tags: - alipay.commerce.cityfacilitator.station x-accepts: application/json /v3/alipay/commerce/cityfacilitator/voucher/batchquery: post: description: 商户APP调该接口批量查询订单状态 operationId: alipay.commerce.cityfacilitator.voucher.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceCityfacilitatorVoucherBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceCityfacilitatorVoucherBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_cityfacilitator_voucher_batchquery_default_response' description: 请求失败 summary: 地铁购票订单批量查询 tags: - alipay.commerce.cityfacilitator.voucher x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/cityfacilitator/voucher/generate: post: description: 商户APP调快捷支付付款后,获取地铁购票的核销码 operationId: alipay.commerce.cityfacilitator.voucher.generate requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceCityfacilitatorVoucherGenerateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceCityfacilitatorVoucherGenerateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_cityfacilitator_voucher_generate_default_response' description: 请求失败 summary: 地铁购票核销码发码 tags: - alipay.commerce.cityfacilitator.voucher x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/cityfacilitator/voucher/refund: post: description: 地铁购票,商户发码后,调该接口从中间户退款 operationId: alipay.commerce.cityfacilitator.voucher.refund requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceCityfacilitatorVoucherRefundModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceCityfacilitatorVoucherRefundResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_cityfacilitator_voucher_refund_default_response' description: 请求失败 summary: 地铁购票发码退款 tags: - alipay.commerce.cityfacilitator.voucher x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/ec/balance/downloadurl/query: get: description: 对账单文件下载接口 operationId: alipay.commerce.ec.balance.downloadurl.query parameters: - description: 企业ID explode: true in: query name: enterprise_id required: false schema: example: "2088123456789000" type: string style: form - description: 共同账户ID explode: true in: query name: account_id required: false schema: example: "2088000295356628" type: string style: form - description: 授权签约协议号 explode: true in: query name: agreement_no required: false schema: example: "20205820659822371223" type: string style: form - description: 账单类型 explode: true in: query name: bill_type required: false schema: example: enterprisetrade type: string style: form - description: 账单时间 explode: true in: query name: bill_date required: false schema: example: yyyy-MM-dd type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcBalanceDownloadurlQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_balance_downloadurl_query_default_response' description: 请求失败 summary: 对账单文件下载接口 tags: - alipay.commerce.ec.balance.downloadurl x-accepts: application/json /v3/alipay/commerce/ec/balance/period/modify: post: description: 用于在企业码B端后台创建的企业调整月对账单账期 operationId: alipay.commerce.ec.balance.period.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcBalancePeriodModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcBalancePeriodModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_balance_period_modify_default_response' description: 请求失败 summary: 企业码月对账单账期修改 tags: - alipay.commerce.ec.balance.period x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/ec/consume/detail/query: post: description: 用于企业查询企业码账单详情 operationId: alipay.commerce.ec.consume.detail.query requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcConsumeDetailQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcConsumeDetailQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_consume_detail_query_default_response' description: 请求失败 summary: 企业码账单详情查询 tags: - alipay.commerce.ec.consume.detail x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/ec/department: post: description: 创建企业部门 operationId: alipay.commerce.ec.department.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcDepartmentCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcDepartmentCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_department_create_default_response' description: 请求失败 summary: 企业部门创建 tags: - alipay.commerce.ec.department x-content-type: application/json x-accepts: application/json put: description: 修改企业部门信息 operationId: alipay.commerce.ec.department.info.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcDepartmentInfoModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcDepartmentInfoModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_department_info_modify_default_response' description: 请求失败 summary: 企业部门信息修改 tags: - alipay.commerce.ec.department.info x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/ec/department/delete: post: description: 删除企业部门 operationId: alipay.commerce.ec.department.delete requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcDepartmentDeleteModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcDepartmentDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_department_delete_default_response' description: 请求失败 summary: 企业部门删除 tags: - alipay.commerce.ec.department x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/ec/department/info/query: get: description: 根据部门id查询企业下某个部门的详细信息 operationId: alipay.commerce.ec.department.info.query parameters: - description: 企业id explode: true in: query name: enterprise_id required: false schema: example: "2088441363102941" type: string style: form - description: 部门id explode: true in: query name: department_id required: false schema: example: "1001094000039142" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcDepartmentInfoQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_department_info_query_default_response' description: 请求失败 summary: 查询部门详情 tags: - alipay.commerce.ec.department.info x-accepts: application/json /v3/alipay/commerce/ec/department/sublist/query: get: description: 查询某个部门的子部门id列表,支持查询根部门id operationId: alipay.commerce.ec.department.sublist.query parameters: - description: 企业id explode: true in: query name: enterprise_id required: false schema: example: "2088441363102941" type: string style: form - description: 部门id,特殊值 -1 表示查询根部门id explode: true in: query name: department_id required: false schema: example: "1001094000039142" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcDepartmentSublistQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_department_sublist_query_default_response' description: 请求失败 summary: 查询子部门id列表 tags: - alipay.commerce.ec.department.sublist x-accepts: application/json /v3/alipay/commerce/ec/employee/add: post: description: 企业添加员工,并返回员工签约链接 operationId: alipay.commerce.ec.employee.add requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEmployeeAddModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEmployeeAddResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_employee_add_default_response' description: 请求失败 summary: 添加员工 tags: - alipay.commerce.ec.employee x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/ec/employee/delete: post: description: 删除员工并解绑因公付 operationId: alipay.commerce.ec.employee.delete requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEmployeeDeleteModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEmployeeDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_employee_delete_default_response' description: 请求失败 summary: 删除员工 tags: - alipay.commerce.ec.employee x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/ec/employee/idlist/query: get: description: 查询某个部门下员工id列表 operationId: alipay.commerce.ec.employee.idlist.query parameters: - description: 企业id explode: true in: query name: enterprise_id required: false schema: example: "2088441363102941" type: string style: form - description: 部门id explode: true in: query name: department_id required: false schema: example: "1001094000039142" type: string style: form - description: 查询页数 explode: true in: query name: page_num required: false schema: example: 1 type: integer style: form - description: 每页查询大小,限制最大为1000 explode: true in: query name: page_size required: false schema: example: 1000 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEmployeeIdlistQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_employee_idlist_query_default_response' description: 请求失败 summary: 查询部门下员工id列表 tags: - alipay.commerce.ec.employee.idlist x-accepts: application/json /v3/alipay/commerce/ec/employee/info: put: description: 员工信息修改 operationId: alipay.commerce.ec.employee.info.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEmployeeInfoModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEmployeeInfoModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_employee_info_modify_default_response' description: 请求失败 summary: 员工信息修改 tags: - alipay.commerce.ec.employee.info x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/ec/employee/info/query: get: description: 根据员工id或员工uid查询企业下某个员工的详细信息 operationId: alipay.commerce.ec.employee.info.query parameters: - description: 企业id explode: true in: query name: enterprise_id required: false schema: example: "2088441363102941" type: string style: form - description: 员工id explode: true in: query name: employee_id required: false schema: example: "228420000000057942506" type: string style: form - description: 蚂蚁统一会员ID explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form - description: 蚂蚁统一会员ID explode: true in: query name: user_id required: false schema: example: "2088501304519332" type: string style: form - description: 员工手机号码 explode: true in: query name: mobile required: false schema: example: 134XXXX2526 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEmployeeInfoQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_employee_info_query_default_response' description: 请求失败 summary: 查询员工详情 tags: - alipay.commerce.ec.employee.info x-accepts: application/json /v3/alipay/commerce/ec/employee/invite: get: description: 获取员工邀请链接,若只传入企业ID企业则邀请链接对企业员工均有效,若传入了企业ID和员工ID则链接只对传入的员工ID有效 operationId: alipay.commerce.ec.employee.invite.query parameters: - description: 企业id explode: true in: query name: enterprise_id required: false schema: example: "2088985758939" type: string style: form - description: 企业码员工ID explode: true in: query name: employee_id required: false schema: example: "2288099887700000" type: string style: form - description: 页面内容code explode: true in: query name: page_content_code required: false schema: example: PCC_STANDARD type: string style: form - description: 代扣签约串 explode: true in: query name: withholding_sign_str required: false schema: example: biz_content=%7B%22access_params%22%3A%7B%22personal_product_code%22%3A%22GENERAL_WITHHOLDING_P%22%2C%22sign_scene%22%3A%22INDUSTRY%7CMULTI_MEDIA%22%7D&sign=111&app_id=2017090501336035&method=alipay.user.agreement.page.sign&version=1.0 type: string style: form - description: 是否生成签约吱口令,不传默认为N explode: true in: query name: create_share_code required: false schema: example: "Y" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEmployeeInviteQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_employee_invite_query_default_response' description: 请求失败 summary: 获取员工邀请链接 tags: - alipay.commerce.ec.employee.invite x-accepts: application/json /v3/alipay/commerce/ec/employee/title: post: description: 批量新增员工抬头关系 operationId: alipay.commerce.ec.employee.title.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEmployeeTitleCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEmployeeTitleCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_employee_title_create_default_response' description: 请求失败 summary: 新增员工抬头关系 tags: - alipay.commerce.ec.employee.title x-content-type: application/json x-accepts: application/json put: description: 修改员工抬头信息 operationId: alipay.commerce.ec.employee.title.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEmployeeTitleModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEmployeeTitleModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_employee_title_modify_default_response' description: 请求失败 summary: 修改员工抬头信息 tags: - alipay.commerce.ec.employee.title x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/ec/employee/title/delete: post: description: 批量删除员工抬头信息 operationId: alipay.commerce.ec.employee.title.delete requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEmployeeTitleDeleteModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEmployeeTitleDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_employee_title_delete_default_response' description: 请求失败 summary: 删除员工抬头信息 tags: - alipay.commerce.ec.employee.title x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/ec/enterprise: put: description: 修改企业信息 operationId: alipay.commerce.ec.enterprise.info.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEnterpriseInfoModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEnterpriseInfoModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_enterprise_info_modify_default_response' description: 请求失败 summary: 企业信息修改 tags: - alipay.commerce.ec.enterprise.info x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/ec/enterprise/address: get: description: 查询企业地址信息 operationId: alipay.commerce.ec.enterprise.address.query parameters: - description: 通过企业码2.0签约接口签约,只填写企业id,无需填写共同账户id和授权签约协议号。 explode: true in: query name: enterprise_id required: false schema: example: "2088501312695783" type: string style: form - description: 通过企业码1.0接口签约的共同账户,和agreement_no搭配使用。 explode: true in: query name: account_id required: false schema: example: "2088501312612345" type: string style: form - description: 可通过签约消息获取。配合共同账户id使用,当填写企业共同账户id时,此字段必填。 explode: true in: query name: agreement_no required: false schema: example: "20215425001181407500" type: string style: form - description: 地址id explode: true in: query name: address_id required: false schema: example: "1903501312695783" type: string style: form - description: 市 explode: true in: query name: city_code required: false schema: example: "310023" type: string style: form - description: 页码从1开始 explode: true in: query name: page_num required: false schema: example: 1 type: integer style: form - description: 每页数据 explode: true in: query name: page_size required: false schema: example: 20 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEnterpriseAddressQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_enterprise_address_query_default_response' description: 请求失败 summary: 企业地址查询 tags: - alipay.commerce.ec.enterprise.address x-accepts: application/json post: description: 企业地址添加 operationId: alipay.commerce.ec.enterprise.address.add requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEnterpriseAddressAddModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEnterpriseAddressAddResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_enterprise_address_add_default_response' description: 请求失败 summary: 企业地址添加 tags: - alipay.commerce.ec.enterprise.address x-content-type: application/json x-accepts: application/json put: description: 企业地址修改 operationId: alipay.commerce.ec.enterprise.address.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEnterpriseAddressModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEnterpriseAddressModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_enterprise_address_modify_default_response' description: 请求失败 summary: 企业地址修改 tags: - alipay.commerce.ec.enterprise.address x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/ec/enterprise/agreement: get: description: 查询企业签约企业码信息 operationId: alipay.commerce.ec.enterprise.agreement.query parameters: - description: 企业id;enterprise_id与account_id至少传一个,如果都传了优先使用enterprise_id explode: true in: query name: enterprise_id required: false schema: example: "2088441399627416" type: string style: form - description: 资金共同账号id;enterprise_id与account_id至少传一个,如果都传了优先使用enterprise_id explode: true in: query name: account_id required: false schema: example: "2088610274867962" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEnterpriseAgreementQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_enterprise_agreement_query_default_response' description: 请求失败 summary: 查询企业签约企业码信息 tags: - alipay.commerce.ec.enterprise.agreement x-accepts: application/json /v3/alipay/commerce/ec/enterprise/create: post: description: 企业入驻,并返回签约链接 operationId: alipay.commerce.ec.enterprise.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEnterpriseCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEnterpriseCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_enterprise_create_default_response' description: 请求失败 summary: 企业入驻 tags: - alipay.commerce.ec.enterprise x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/ec/enterprise/delete: post: description: 企业注销,清理企业数据 operationId: alipay.commerce.ec.enterprise.delete requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEnterpriseDeleteModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEnterpriseDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_enterprise_delete_default_response' description: 请求失败 summary: 企业注销 tags: - alipay.commerce.ec.enterprise x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/ec/enterprise/info: get: description: 查询企业详细信息 operationId: alipay.commerce.ec.enterprise.info.query parameters: - description: 企业id explode: true in: query name: enterprise_id required: false schema: example: "20889490309498" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEnterpriseInfoQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_enterprise_info_query_default_response' description: 请求失败 summary: 查询企业详情 tags: - alipay.commerce.ec.enterprise.info x-accepts: application/json /v3/alipay/commerce/ec/enterprise/unsignurl: get: description: 企业解约,获取解约链接,点击链接跳转到解约页面,进行解约协议 operationId: alipay.commerce.ec.enterprise.unsign parameters: - description: 通过企业码2.0签约接口签约,只填写企业id,无需填写共同账户id和授权签约协议号。 explode: true in: query name: enterprise_id required: false schema: example: "2088123412341234" type: string style: form - description: 通过企业码1.0接口签约的共同账户,和agreement_no搭配使用。 explode: true in: query name: account_id required: false schema: example: "2088000194958956" type: string style: form - description: 可通过签约消息获取。配合共同账户id使用,当填写企业共同账户id时,此字段必填。 explode: true in: query name: agreement_no required: false schema: example: "20215425001181407500" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcEnterpriseUnsignResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_enterprise_unsign_default_response' description: 请求失败 summary: 企业解约 tags: - alipay.commerce.ec.enterprise x-accepts: application/json /v3/alipay/commerce/ec/jointaccountbill/detail/batchquery: get: description: 分页查询企业账单 operationId: alipay.commerce.ec.jointaccountbill.detail.batchquery parameters: - description: 企业ID explode: true in: query name: enterprise_id required: false schema: example: "2088123456789000" type: string style: form - description: 业务场景。不传默认为ISV_DEFAULT explode: true in: query name: biz_scene required: false schema: example: ISV_DEFAULT type: string style: form - description: 员工支付宝UID explode: true in: query name: user_id required: false schema: example: "2088123456789000" type: string style: form - description: 员工支付宝UID explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form - description: 员工id explode: true in: query name: employee_id required: false schema: example: "2288029541813166" type: string style: form - description: 页码 explode: true in: query name: page_num required: false schema: example: "1" type: string style: form - description: 每页大小 explode: true in: query name: page_size required: false schema: example: "20" type: string style: form - description: 起始日期 explode: true in: query name: start_date required: false schema: example: yyyy-MM-dd HH:mm:ss type: string style: form - description: 截止日期 explode: true in: query name: end_date required: false schema: example: yyyy-MM-dd HH:mm:ss type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcJointaccountbillDetailBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_jointaccountbill_detail_batchquery_default_response' description: 请求失败 summary: 企业账单批量分页查询 tags: - alipay.commerce.ec.jointaccountbill.detail x-accepts: application/json /v3/alipay/commerce/ec/user/enterprise: get: description: 用户所属企业列表 operationId: alipay.commerce.ec.user.enterprise.query parameters: - description: 用户id explode: true in: query name: user_id required: false schema: example: "20889384849393" type: string style: form - description: 用户open_id explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEcUserEnterpriseQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_ec_user_enterprise_query_default_response' description: 请求失败 summary: 用户企业列表 tags: - alipay.commerce.ec.user.enterprise x-accepts: application/json /v3/alipay/commerce/educate/campus/institutions/add: post: description: 学校信息入驻 operationId: alipay.commerce.educate.campus.institutions.add requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEducateCampusInstitutionsAddModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEducateCampusInstitutionsAddResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_educate_campus_institutions_add_default_response' description: 请求失败 summary: 入驻学校信息 tags: - alipay.commerce.educate.campus.institutions x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/educate/campus/institutions/query: get: description: 可以通过学校库产品查询支付宝系统中是否已存在对应的学校,避免重复入驻,以及通过该接口查询入驻的进度:入驻成功则会返回学校信息,失败则不会返回 operationId: alipay.commerce.educate.campus.institutions.query parameters: - description: 学校名称 explode: true in: query name: inst_name required: false schema: example: 复旦大学 type: string style: form - description: 省份编码,编码标准为中华人民共和国行政区划代码,参见 2020年12月中华人民共和国县以上行政区划代码。 explode: true in: query name: province_code required: false schema: example: "370000" type: string style: form - description: 城市编码,编码标准为中华人民共和国行政区划代码,参见 2020年12月中华人民共和国县以上行政区划代码。 explode: true in: query name: city_code required: false schema: example: "370900" type: string style: form - description: 学校内标:支付宝内部学校唯一编号。使用内标查询时,默认使用内标进行精确匹配。 explode: true in: query name: inst_id required: false schema: example: "2088000139662311" type: string style: form - description: 学校外标:统一社会信用编码或教育部提供的学校标识码。使用学校外标查询时,默认使用外标进行精确匹配。 explode: true in: query name: inst_std_code required: false schema: example: "202008016104" type: string style: form - description: "是否使用学校名称模糊匹配进行查询,默认精确匹配。\t枚举值如下:\t1:精确匹配;\t0:模糊匹配" explode: true in: query name: like_property required: false schema: example: "1" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEducateCampusInstitutionsQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_educate_campus_institutions_query_default_response' description: 请求失败 summary: 查询学校信息 tags: - alipay.commerce.educate.campus.institutions x-accepts: application/json /v3/alipay/commerce/educate/schoolcard/order/sync: post: description: 校园卡支付订单数据同步 operationId: alipay.commerce.educate.schoolcard.order.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEducateSchoolcardOrderSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceEducateSchoolcardOrderSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_educate_schoolcard_order_sync_default_response' description: 请求失败 summary: 校园卡支付订单数据同步 tags: - alipay.commerce.educate.schoolcard.order x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/iot/device/report/upload: post: description: 设备检测报告上传 operationId: alipay.commerce.iot.device.report.upload requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceIotDeviceReportUploadModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceIotDeviceReportUploadResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_iot_device_report_upload_default_response' description: 请求失败 summary: 设备检测报告上传 tags: - alipay.commerce.iot.device.report x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/iot/sdarttool/message/query: get: description: isv通过消息id查询消息 operationId: alipay.commerce.iot.sdarttool.message.query parameters: - description: 消息ID explode: true in: query name: message_no required: false schema: example: "201911250000021611" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceIotSdarttoolMessageQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_iot_sdarttool_message_query_default_response' description: 请求失败 summary: 消息查询 tags: - alipay.commerce.iot.sdarttool.message x-accepts: application/json /v3/alipay/commerce/iot/sdarttool/message/send: post: description: ISV通过此接口向IOT设备推送消息 operationId: alipay.commerce.iot.sdarttool.message.send requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceIotSdarttoolMessageSendModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceIotSdarttoolMessageSendResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_iot_sdarttool_message_send_default_response' description: 请求失败 summary: IOT消息服务 tags: - alipay.commerce.iot.sdarttool.message x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/logistics/invoice/istdwaybill/create: post: description: 开即时配送订单发票 operationId: alipay.commerce.logistics.invoice.istdwaybill.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceLogisticsInvoiceIstdwaybillCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceLogisticsInvoiceIstdwaybillCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_logistics_invoice_istdwaybill_create_default_response' description: 请求失败 summary: 开即时配送订单发票 tags: - alipay.commerce.logistics.invoice.istdwaybill x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/logistics/invoice/istdwaybill/query: get: description: 查询即时配送订单的开票结果 operationId: alipay.commerce.logistics.invoice.istdwaybill.query parameters: - description: 即时配送公司编码 explode: true in: query name: logistics_code required: false schema: example: FENGNIAO type: string style: form - description: 开票请求流水号 explode: true in: query name: out_invoice_request_no required: false schema: example: out_invoice_no_00001 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceLogisticsInvoiceIstdwaybillQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_logistics_invoice_istdwaybill_query_default_response' description: 请求失败 summary: 查询即时配送订单的开票结果 tags: - alipay.commerce.logistics.invoice.istdwaybill x-accepts: application/json /v3/alipay/commerce/logistics/logisticscompany/instantdelivery/query: get: description: 查询支付宝支持的即时配送公司 operationId: alipay.commerce.logistics.logisticscompany.instantdelivery.query responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceLogisticsLogisticscompanyInstantdeliveryQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_logistics_logisticscompany_instantdelivery_query_default_response' description: 请求失败 summary: 查询支付宝支持的即时配送公司 tags: - alipay.commerce.logistics.logisticscompany.instantdelivery x-accepts: application/json /v3/alipay/commerce/logistics/order/instantdelivery/cancel: post: description: 取消即时配送订单 operationId: alipay.commerce.logistics.order.instantdelivery.cancel requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceLogisticsOrderInstantdeliveryCancelModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceLogisticsOrderInstantdeliveryCancelResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_logistics_order_instantdelivery_cancel_default_response' description: 请求失败 summary: 取消即时配送订单 tags: - alipay.commerce.logistics.order.instantdelivery x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/logistics/order/instantdelivery/create: post: description: 下即时配送订单 operationId: alipay.commerce.logistics.order.instantdelivery.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceLogisticsOrderInstantdeliveryCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceLogisticsOrderInstantdeliveryCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_logistics_order_instantdelivery_create_default_response' description: 请求失败 summary: 下即时配送订单 tags: - alipay.commerce.logistics.order.instantdelivery x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/logistics/order/instantdelivery/precreate: post: description: 预下即时配送订单 operationId: alipay.commerce.logistics.order.instantdelivery.precreate requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceLogisticsOrderInstantdeliveryPrecreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceLogisticsOrderInstantdeliveryPrecreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_logistics_order_instantdelivery_precreate_default_response' description: 请求失败 summary: 预下即时配送订单 tags: - alipay.commerce.logistics.order.instantdelivery x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/logistics/order/istdcancel/preconsult: post: description: 预取消即时配送订单 operationId: alipay.commerce.logistics.order.istdcancel.preconsult requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceLogisticsOrderIstdcancelPreconsultModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceLogisticsOrderIstdcancelPreconsultResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_logistics_order_istdcancel_preconsult_default_response' description: 请求失败 summary: 预取消即时配送订单 tags: - alipay.commerce.logistics.order.istdcancel x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/logistics/order/istdretry/create: post: description: 重下即时配送订单 operationId: alipay.commerce.logistics.order.istdretry.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceLogisticsOrderIstdretryCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceLogisticsOrderIstdretryCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_logistics_order_istdretry_create_default_response' description: 请求失败 summary: 重下即时配送订单 tags: - alipay.commerce.logistics.order.istdretry x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/logistics/waybill/istddetail/query: get: description: 查询即时配送运单详情 operationId: alipay.commerce.logistics.waybill.istddetail.query parameters: - description: 商家门店编号 explode: true in: query name: shop_no required: false schema: example: shopno001 type: string style: form - description: 商家订单号 explode: true in: query name: out_order_no required: false schema: example: "2020090411140000000000777000216122" type: string style: form - description: 支付宝订单流水号 explode: true in: query name: order_no required: false schema: example: "2020090411130000000000772400280352" type: string style: form - description: 即时配送公司编码 explode: true in: query name: logistics_code required: false schema: example: FENGNIAO type: string style: form - description: 即时配送运单编号 explode: true in: query name: waybill_no required: false schema: example: waybillno001 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceLogisticsWaybillIstddetailQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_logistics_waybill_istddetail_query_default_response' description: 请求失败 summary: 查询即时配送运单详情 tags: - alipay.commerce.logistics.waybill.istddetail x-accepts: application/json /v3/alipay/commerce/operation/activity/merchant/modify: post: description: 商户签约信息修改 operationId: alipay.commerce.operation.activity.merchant.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceOperationActivityMerchantModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceOperationActivityMerchantModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_operation_activity_merchant_modify_default_response' description: 请求失败 summary: 商户签约信息修改 tags: - alipay.commerce.operation.activity.merchant x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/operation/activity/merchant/sign: post: description: 商户签约活动 operationId: alipay.commerce.operation.activity.merchant.sign requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceOperationActivityMerchantSignModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceOperationActivityMerchantSignResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_operation_activity_merchant_sign_default_response' description: 请求失败 summary: 商户签约活动 tags: - alipay.commerce.operation.activity.merchant x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/operation/activity/merchant/unsign: post: description: 用户银行商户模式商户解约活动使用 operationId: alipay.commerce.operation.activity.merchant.unsign responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceOperationActivityMerchantUnsignResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_operation_activity_merchant_unsign_default_response' description: 请求失败 summary: 活动商户解约 tags: - alipay.commerce.operation.activity.merchant x-accepts: application/json /v3/alipay/commerce/operation/bank/activity/query: get: description: 银行活动信息查询 operationId: alipay.commerce.operation.bank.activity.query parameters: - description: 支付宝openId explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form - description: 蚂蚁统一会员ID explode: true in: query name: user_id required: false schema: example: 208822294389xxxx type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceOperationBankActivityQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_operation_bank_activity_query_default_response' description: 请求失败 summary: 银行活动信息查询 tags: - alipay.commerce.operation.bank.activity x-accepts: application/json /v3/alipay/commerce/transport/charger/chargerbindinfo/sync: post: description: 设备运营商通过该接口同步自己阵地中用户绑定充电桩的信息,包含绑定信息,解绑信息,设备状态等等设备信息 operationId: alipay.commerce.transport.charger.chargerbindinfo.sync parameters: - allowEmptyValue: true description: 用户授权令牌 explode: true in: query name: auth_token required: false schema: type: string style: form requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceTransportChargerChargerbindinfoSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceTransportChargerChargerbindinfoSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_transport_charger_chargerbindinfo_sync_default_response' description: 请求失败 summary: 充电运营商同步用户绑定充电桩信息接口 tags: - alipay.commerce.transport.charger.chargerbindinfo x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/transport/parking/enterinfo/sync: post: description: 车辆驶入停车场时,服务商通过此接口配置消息模板内容告知支付宝发送给用户 operationId: alipay.commerce.transport.parking.enterinfo.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceTransportParkingEnterinfoSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceTransportParkingEnterinfoSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_transport_parking_enterinfo_sync_default_response' description: 请求失败 summary: 停车入场模板消息配置 tags: - alipay.commerce.transport.parking.enterinfo x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/transport/parking/exitinfo/sync: post: description: 用户要驶离停车场时,服务商通过此接口配置消息模板内容告知支付宝发送给用户 operationId: alipay.commerce.transport.parking.exitinfo.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceTransportParkingExitinfoSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceTransportParkingExitinfoSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_transport_parking_exitinfo_sync_default_response' description: 请求失败 summary: 停车离场消息模板配置 tags: - alipay.commerce.transport.parking.exitinfo x-content-type: application/json x-accepts: application/json /v3/alipay/commerce/transport/parking/paymentinfo/sync: post: description: 用户在场内支付时,服务商通过此接口配置消息模板内容告知支付宝发送给用户 operationId: alipay.commerce.transport.parking.paymentinfo.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceTransportParkingPaymentinfoSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayCommerceTransportParkingPaymentinfoSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_commerce_transport_parking_paymentinfo_sync_default_response' description: 请求失败 summary: 停车支付模板消息配置 tags: - alipay.commerce.transport.parking.paymentinfo x-content-type: application/json x-accepts: application/json /v3/alipay/data/bill/accountbookereceipt/apply: post: description: 申请子账本电子回单(子账本业务定制接口) operationId: alipay.data.bill.accountbookereceipt.apply requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayDataBillAccountbookereceiptApplyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayDataBillAccountbookereceiptApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_data_bill_accountbookereceipt_apply_default_response' description: 请求失败 summary: 申请子账本电子回单(incubating) tags: - alipay.data.bill.accountbookereceipt x-content-type: application/json x-accepts: application/json /v3/alipay/data/bill/accountbookereceipt/query: get: 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 parameters: - description: 根据申请id查询状态 explode: true in: query name: file_id required: false schema: example: "12345" type: string style: form - description: 协议号 explode: true in: query name: agreement_no required: false schema: example: "20205215001418078112" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayDataBillAccountbookereceiptQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_data_bill_accountbookereceipt_query_default_response' description: 请求失败 summary: 查询子账本电子回单状态(incubating) tags: - alipay.data.bill.accountbookereceipt x-accepts: application/json /v3/alipay/data/bill/accountlog/query: get: description: 为支付宝商家提供支付宝账户的账务流水信息,供对账使用。 operationId: alipay.data.bill.accountlog.query parameters: - description: 账务流水创建时间的起始范围 explode: true in: query name: start_time required: false schema: example: 2019-01-01 00:00:00 type: string style: form - description: 账务流水创建时间的结束范围。与起始时间间隔不超过31天。查询结果为起始时间至结束时间的左闭右开区间 explode: true in: query name: end_time required: false schema: example: 2019-01-02 00:00:00 type: string style: form - description: 支付宝订单号,通过支付宝订单号精确查询相关的流水明细,商户订单号与支付宝订单号互斥 explode: true in: query name: alipay_order_no required: false schema: example: 20190101*** type: string style: form - description: 商户订单号,通过商户订单号精确查询相关的流水明细,商户订单号与支付宝订单号互斥 explode: true in: query name: merchant_order_no required: false schema: example: TX*** type: string style: form - description: 分页号,从1开始 explode: true in: query name: page_no required: false schema: example: "1" type: string style: form - description: 分页大小1000-2000,默认2000 explode: true in: query name: page_size required: false schema: example: "2000" type: string style: form - description: 账务的类型代码,特殊场景下使用 explode: true in: query name: trans_code required: false schema: example: "101101,301101" type: string style: form - description: 协议授权码,特殊场景下使用 explode: true in: query name: agreement_no required: false schema: example: "20215606000635888888" type: string style: form - description: 协议产品码。特殊场景下使用 explode: true in: query name: agreement_product_code required: false schema: example: FUND_SIGN_WITHHOLDING type: string style: form - description: 指定用户做账单查询 explode: true in: query name: bill_user_id required: false schema: example: "2088123456789012" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayDataBillAccountlogQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_data_bill_accountlog_query_default_response' description: 请求失败 summary: 支付宝商家账户账务明细查询 tags: - alipay.data.bill.accountlog x-accepts: application/json /v3/alipay/data/bill/bail/query: get: description: 为支付宝商家提供支付宝账户保证金信息,供对账使用。 operationId: alipay.data.bill.bail.query parameters: - description: 保证金流水创建时间的起始范围 explode: true in: query name: start_time required: false schema: example: 2019-01-01 00:00:00 type: string style: form - description: 保证金流水创建时间的结束范围。与起始时间间隔不超过31天。查询结果为起始时间至结束时间的左闭右开区间 explode: true in: query name: end_time required: false schema: example: 2019-01-02 00:00:00 type: string style: form - description: 保证金类型,目前支持TMALL_S_BAIL-天猫保证金,TAOBAO_BAIL-淘宝保证金 explode: true in: query name: bail_type required: false schema: example: TMALL_S_BAIL type: string style: form - description: 保证金流水号。如果查询参数中指定流水号,则只查询流水号相关的记录 explode: true in: query name: trans_log_id required: false schema: example: 20190101*** type: string style: form - description: 业务基础订单号。如果查询参数中指定订单号,则只查询相关的记录 explode: true in: query name: biz_orig_no required: false schema: example: 1*** type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayDataBillBailQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_data_bill_bail_query_default_response' description: 请求失败 summary: 支付宝商家账户保证金查询 tags: - alipay.data.bill.bail x-accepts: application/json /v3/alipay/data/bill/balance/query: get: description: 为支付宝商家提供支付宝账户当前余额信息,包括冻结金额,可用余额和总额,供对账使用。 operationId: alipay.data.bill.balance.query parameters: - description: 目标查询账户(仅支持部分场景,查询自身时候不需要传递当前字段)。 explode: true in: query name: bill_user_id required: false schema: example: "2088123456789012" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayDataBillBalanceQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_data_bill_balance_query_default_response' description: 请求失败 summary: 支付宝商家账户当前余额查询 tags: - alipay.data.bill.balance x-accepts: application/json /v3/alipay/data/bill/balancehis/query: get: description: 为支付宝商家提供支付宝账户历史余额信息,供对账使用。 operationId: alipay.data.bill.balancehis.query parameters: - description: 查询指定自然日的起初余额和期末余额,biz_date与biz_month传入参数互斥 explode: true in: query name: biz_date required: false schema: example: 2019-08-01 type: string style: form - description: 查询指定自然月的起初余额和期末余额,biz_date与biz_month传入参数互斥 explode: true in: query name: biz_month required: false schema: example: 2019-08 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayDataBillBalancehisQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_data_bill_balancehis_query_default_response' description: 请求失败 summary: 支付宝商家账户历史余额查询 tags: - alipay.data.bill.balancehis x-accepts: application/json /v3/alipay/data/bill/bizfundagent/query: get: description: 用于ISV代理商户查询商户的资金业务账单 operationId: alipay.data.bill.bizfundagent.query parameters: - description: 账单查询时间范围 -- 起始时间 explode: true in: query name: start_time required: false schema: example: 2021-01-01 00:00:00 type: string style: form - description: 账单查询时间范围 -- 结束范围。时间范围最大不超过31天。 explode: true in: query name: end_time required: false schema: example: 2021-02-01 00:00:00 type: string style: form - description: 页码,从1开始 explode: true in: query name: page_no required: false schema: example: "1" type: string style: form - description: 分页大小1000-2000,默认2000 explode: true in: query name: page_size required: false schema: example: "2000" type: string style: form - description: ISV与商户授权协议号 explode: true in: query name: agreement_no required: false schema: example: "20205215001418078112" type: string style: form - description: 记账本id,服务商在帮助商户开通时候获取的唯一身份号 explode: true in: query name: account_book_id required: false schema: example: "20880123456789012" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayDataBillBizfundagentQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_data_bill_bizfundagent_query_default_response' description: 请求失败 summary: ISV代理商户资金业务账单查询 tags: - alipay.data.bill.bizfundagent x-accepts: application/json /v3/alipay/data/bill/buy/query: get: description: 为支付宝商家提供支付宝账户买入交易信息,供对账使用。 operationId: alipay.data.bill.buy.query parameters: - description: 交易流水创建时间的起始范围 explode: true in: query name: start_time required: false schema: example: 2019-01-01 00:00:00 type: string style: form - description: 交易流水创建时间的结束范围。与起始时间间隔不超过31天。查询结果为起始时间至结束时间的左闭右开区间 explode: true in: query name: end_time required: false schema: example: 2019-01-02 00:00:00 type: string style: form - description: 支付宝交易流水号。如果查询参数中指定流水号,则只查询流水号相关的记录 explode: true in: query name: alipay_order_no required: false schema: example: 20190101*** type: string style: form - description: 商户交易号。如果查询参数中指定交易号,则只查询相关的记录 explode: true in: query name: merchant_order_no required: false schema: example: TX*** type: string style: form - description: 门店编号,模糊搜索 explode: true in: query name: store_no required: false schema: example: 门店1 type: string style: form - description: 分页号,从1开始 explode: true in: query name: page_no required: false schema: example: "1" type: string style: form - description: 分页大小1000-2000,默认2000 explode: true in: query name: page_size required: false schema: example: "2000" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayDataBillBuyQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_data_bill_buy_query_default_response' description: 请求失败 summary: 支付宝商家账户买入交易查询 tags: - alipay.data.bill.buy x-accepts: application/json /v3/alipay/data/bill/ereceipt/apply: post: 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayDataBillEreceiptApplyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayDataBillEreceiptApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_data_bill_ereceipt_apply_default_response' description: 请求失败 summary: 申请电子回单(incubating) tags: - alipay.data.bill.ereceipt x-content-type: application/json x-accepts: application/json /v3/alipay/data/bill/ereceipt/query: get: description: |- 电子签章申请分两个步骤: 1、使用alipay.data.bill.ereceipt.apply创建申请,并获取file_id信息。 2、等待一段时间后,使用file_id查询alipay.data.bill.ereceipt.query申请信息。 单个申请建议每5分钟查询一次状态。批量回单建议20分钟查询一次。汇总回单建议30分钟查询一次 operationId: alipay.data.bill.ereceipt.query parameters: - description: 根据申请id查询状态。通过 alipay.data.bill.ereceipt.apply(申请电子回单(incubating)) 接口同步响应获取。 explode: true in: query name: file_id required: false schema: example: "12345" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayDataBillEreceiptQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_data_bill_ereceipt_query_default_response' description: 请求失败 summary: 查询电子回单状态(incubating) tags: - alipay.data.bill.ereceipt x-accepts: application/json /v3/alipay/data/bill/ereceiptagent/apply: post: 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayDataBillEreceiptagentApplyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayDataBillEreceiptagentApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_data_bill_ereceiptagent_apply_default_response' description: 请求失败 summary: ISV代理商户申请电子回单 tags: - alipay.data.bill.ereceiptagent x-content-type: application/json x-accepts: application/json /v3/alipay/data/bill/sell/query: get: description: 为支付宝商家提供支付宝账户卖出交易信息,供对账使用。 operationId: alipay.data.bill.sell.query parameters: - description: 卖出交易流水创建时间的起始范围 explode: true in: query name: start_time required: false schema: example: 2019-01-01 00:00:00 type: string style: form - description: 卖出交易流水创建时间的结束范围。与起始时间间隔不超过31天。查询结果为起始时间至结束时间的左闭右开区间 explode: true in: query name: end_time required: false schema: example: 2019-01-02 00:00:00 type: string style: form - description: 支付宝交易流水号。如果查询参数中指定流水号,则只查询流水号相关的记录 explode: true in: query name: alipay_order_no required: false schema: example: 20190101*** type: string style: form - description: 商户交易号。如果查询参数中指定交易号,则只查询相关的记录 explode: true in: query name: merchant_order_no required: false schema: example: TX*** type: string style: form - description: 门店编号,模糊搜索 explode: true in: query name: store_no required: false schema: example: 门店1 type: string style: form - description: 分页号,从1开始 explode: true in: query name: page_no required: false schema: example: "1" type: string style: form - description: 分页大小1000-2000,默认2000 explode: true in: query name: page_size required: false schema: example: "2000" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayDataBillSellQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_data_bill_sell_query_default_response' description: 请求失败 summary: 支付宝商家账户卖出交易查询 tags: - alipay.data.bill.sell x-accepts: application/json /v3/alipay/data/bill/transfer/query: get: description: 为支付宝商家提供支付宝账户充值,转账,提现信息,供对账使用。 operationId: alipay.data.bill.transfer.query parameters: - description: 充值、转账、提现流水业务时间的起始范围 explode: true in: query name: start_time required: false schema: example: 2019-01-01 00:00:00 type: string style: form - description: 充值、转账、提现流水业务时间的结束范围。与起始时间间隔不超过31天。查询结果为起始时间至结束时间的左闭右开区间 explode: true in: query name: end_time required: false schema: example: 2019-01-02 00:00:00 type: string style: form - description: 转账类型:充值-DEPOSIT,提现-WITHDRAW,转账-TRANSFER。 explode: true in: query name: type required: false schema: example: DEPOSIT type: string style: form - description: 分页号,从1开始 explode: true in: query name: page_no required: false schema: example: "1" type: string style: form - description: 分页大小1000-2000,默认2000 explode: true in: query name: page_size required: false schema: example: "2000" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayDataBillTransferQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_data_bill_transfer_query_default_response' description: 请求失败 summary: 支付宝商家账户充值,转账,提现查询 tags: - alipay.data.bill.transfer x-accepts: application/json /v3/alipay/data/bill/transferaccountbook/query: get: description: 子账本充提转账单查询(子账本业务定制接口) operationId: alipay.data.bill.transferaccountbook.query parameters: - description: 充值、转账、提现流水业务时间的起始范围 explode: true in: query name: start_time required: false schema: example: 2019-01-01 00:00:00 type: string style: form - description: 充值、转账、提现流水业务时间的结束范围。与起始时间间隔不超过31天。查询结果为起始时间至结束时间的左闭右开区间 explode: true in: query name: end_time required: false schema: example: 2019-01-02 00:00:00 type: string style: form - description: 转账类型:充值-DEPOSIT,提现-WITHDRAW,转账-TRANSFER。 explode: true in: query name: type required: false schema: example: TRANSFER type: string style: form - description: 协议号 explode: true in: query name: agreement_no required: false schema: example: "20205215001418078112" type: string style: form - description: 子账本号,或者子账本名称。模糊查询 explode: true in: query name: store_no required: false schema: example: "2088000117463004" type: string style: form - description: 分页号,从1开始 explode: true in: query name: page_no required: false schema: example: "1" type: string style: form - description: 分页大小1000-2000,默认2000 explode: true in: query name: page_size required: false schema: example: "2000" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayDataBillTransferaccountbookQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_data_bill_transferaccountbook_query_default_response' description: 请求失败 summary: 子账本充提转账单查询(incubating) tags: - alipay.data.bill.transferaccountbook x-accepts: application/json /v3/alipay/data/dataservice/ad/conversion/upload: post: description: 用于回传转化数据 operationId: alipay.data.dataservice.ad.conversion.upload requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayDataDataserviceAdConversionUploadModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayDataDataserviceAdConversionUploadResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_data_dataservice_ad_conversion_upload_default_response' description: 请求失败 summary: 转化数据回传 tags: - alipay.data.dataservice.ad.conversion x-content-type: application/json x-accepts: application/json /v3/alipay/data/dataservice/ad/promotepage/batchquery: get: description: 用于获取指定商家的自建推广页列表 operationId: alipay.data.dataservice.ad.promotepage.batchquery parameters: - description: 代理商访问灯火平台的token explode: true in: query name: biz_token required: false schema: example: HYjofejnnlp89730202bcklHH type: string style: form - description: 商家标志 explode: true in: query name: principal_tag required: false schema: example: yfvbv133498 type: string style: form - description: 推广页类型:COLLECT_INFO - 免费留资;TRADE - 付费留资; OPERATION_PAID - 运营商付费留资;待扩展 explode: true in: query name: type required: false schema: example: COLLECT_INFO type: string style: form - description: 分页参数之页数,从1开始 explode: true in: query name: page_no required: false schema: example: 1 type: integer style: form - description: 分页参数之每页大小,最大1000 explode: true in: query name: page_size required: false schema: example: 100 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayDataDataserviceAdPromotepageBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_data_dataservice_ad_promotepage_batchquery_default_response' description: 请求失败 summary: 自建推广页列表批量查询 tags: - alipay.data.dataservice.ad.promotepage x-accepts: application/json /v3/alipay/data/dataservice/ad/promotepage/download: get: description: 用于获取指定商家指定推广页的留资数据,注意调用频次小于20qps operationId: alipay.data.dataservice.ad.promotepage.download parameters: - description: 留资开始日期,格式:yyyy-mm-dd,不能早于30天前 explode: true in: query name: start_date required: false schema: example: 2020-12-12 type: string style: form - description: 留资结束日期,格式:yyyy-mm-dd;不能晚于当天 explode: true in: query name: end_date required: false schema: example: 2020-12-13 type: string style: form - description: 分页参数之页数,从1开始 explode: true in: query name: page_no required: false schema: example: 1 type: integer style: form - description: 分页参数之每页大小,最大1000 explode: true in: query name: page_size required: false schema: example: 100 type: integer style: form - description: 代理商访问灯火平台的token explode: true in: query name: biz_token required: false schema: example: HYjofejnnlp89730202bcklHH type: string style: form - description: 商家标志 explode: true in: query name: principal_tag required: false schema: example: yfvbv133498 type: string style: form - description: 推广页id explode: true in: query name: promote_page_id required: false schema: example: 79900056 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayDataDataserviceAdPromotepageDownloadResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_data_dataservice_ad_promotepage_download_default_response' description: 请求失败 summary: 自建推广页留资数据查询 tags: - alipay.data.dataservice.ad.promotepage x-accepts: application/json /v3/alipay/data/dataservice/bill/downloadurl/query: get: description: 为方便商户快速查账,支持商户通过本接口获取商户离线账单下载地址 operationId: alipay.data.dataservice.bill.downloadurl.query parameters: - description: 账单类型,商户通过接口或商户经开放平台授权后其所属服务商通过接口可以获取以下账单类型。 explode: true in: query name: bill_type required: false schema: example: trade type: string style: form - description: "账单时间: \t* 日账单格式为yyyy-MM-dd,最早可下载2016年1月1日开始的日账单。不支持下载当日账单,只能\ 下载前一日24点前的账单数据(T+1),当日数据一般于次日 9 点前生成,特殊情况可能延迟。 \t* 月账单格式为yyyy-MM,最早可下载2016年\ 1月开始的月账单。不支持下载当月账单,只能下载上一月账单数据,当月账单一般在次月 3 日生成,特殊情况可能延迟。\t* 当biz_type为settlementMerge时\ 候,时间为汇总批次结算资金到账的日期,日期格式为yyyy-MM-dd,最早可下载2023年4月17日及以后的账单。" explode: true in: query name: bill_date required: false schema: example: 2016-04-05 type: string style: form - description: 二级商户smid,这个参数只在bill_type是trade_zft_merchant时才能使用 explode: true in: query name: smid required: false schema: example: "2088123412341234" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayDataDataserviceBillDownloadurlQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_data_dataservice_bill_downloadurl_query_default_response' description: 请求失败 summary: 查询对账单下载地址 tags: - alipay.data.dataservice.bill.downloadurl x-accepts: application/json /v3/alipay/ebpp/bill/add: post: description: 创建账单 operationId: alipay.ebpp.bill.add parameters: - allowEmptyValue: true description: 用户授权令牌 explode: true in: query name: auth_token required: false schema: type: string style: form requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppBillAddModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppBillAddResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_bill_add_default_response' description: 请求失败 summary: 创建账单 tags: - alipay.ebpp.bill x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/bill/get: get: description: 查询账单 operationId: alipay.ebpp.bill.get parameters: - allowEmptyValue: true description: 用户授权令牌 explode: true in: query name: auth_token required: false schema: type: string style: form - description: "支付宝订单类型。公共事业缴纳JF,信用卡还款HK" explode: true in: query name: order_type required: false schema: example: JF type: string style: form - description: 输出机构的业务流水号,需要保证唯一性。 explode: true in: query name: merchant_order_no required: false schema: example: "201203031234567" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppBillGetResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_bill_get_default_response' description: 请求失败 summary: 查询账单 tags: - alipay.ebpp.bill x-accepts: application/json /v3/alipay/ebpp/invoice/apply/inv/upload: put: description: |- 发票回传接口适用于以下场景: 1、间联开票模式:阿里发票平台向ISV提交了原始发票申请,商户在ISV后台开具发票成功后,基于申请ID(apply_id)回传发票至阿里发票平台归集与交付。 2、直连开票模式:阿里发票平台请求ISV开票,ISV系统异步执行开票事务后,基于开票流水号(serial_no)回传开票结果至阿里发票平台归集与交付。 3、ISV直接回传发票给阿里发票平台,进行归集,并交付给业务前台和用户。 operationId: alipay.ebpp.invoice.apply.inv.upload requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceApplyInvUploadModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceApplyInvUploadResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_apply_inv_upload_default_response' description: 请求失败 summary: 发票回传 tags: - alipay.ebpp.invoice.apply.inv x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/apply/result/sync: post: description: ISV向支付宝同步发票申请结果 operationId: alipay.ebpp.invoice.apply.result.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceApplyResultSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceApplyResultSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_apply_result_sync_default_response' description: 请求失败 summary: ISV向支付宝同步发票申请结果 tags: - alipay.ebpp.invoice.apply.result x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/apply/status/notify: put: description: 发票申请状态变更通知 operationId: alipay.ebpp.invoice.apply.status.notify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceApplyStatusNotifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceApplyStatusNotifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_apply_status_notify_default_response' description: 请求失败 summary: 发票申请状态变更 tags: - alipay.ebpp.invoice.apply.status x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/applystatus/query: post: description: 根据外部订单号查询开票状态,仅有申请状态无完整票据信息 operationId: alipay.ebpp.invoice.applystatus.query requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceApplystatusQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceApplystatusQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_applystatus_query_default_response' description: 请求失败 summary: 根据外部订单号查询开票状态 tags: - alipay.ebpp.invoice.applystatus x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/auth/sign: post: description: 用户在ISV端签约了发票相关的授权关系之后,ISV使用该接口将授权关系同步到发票管家。 operationId: alipay.ebpp.invoice.auth.sign requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceAuthSignModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceAuthSignResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_auth_sign_default_response' description: 请求失败 summary: 发票授权关系签约 tags: - alipay.ebpp.invoice.auth x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/auth/unsign: post: description: 用户在ISV端解约了发票相关的授权关系之后,ISV使用该接口将授权关系在发票管家端解约。 operationId: alipay.ebpp.invoice.auth.unsign requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceAuthUnsignModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceAuthUnsignResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_auth_unsign_default_response' description: 请求失败 summary: 发票授权关系解约 tags: - alipay.ebpp.invoice.auth x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/detail/output/query: post: description: "根据发票代码,发票号码获取发票详细信息\r\n查询权限要求:\r\n发票属于当前isv报销单据进行状态(支持的状态有\r\n\ EXPENSE_APPLY-用户已提交申请\r\nEXPENSE_APPROVAL_PASS -报销审核通过\r\nEXPENSE_FINISHED-\ 报销完结)" operationId: alipay.ebpp.invoice.detail.output.query requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceDetailOutputQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceDetailOutputQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_detail_output_query_default_response' description: 请求失败 summary: 获取发票详细信息 tags: - alipay.ebpp.invoice.detail.output x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/ecorder/order/query: get: description: 企业码订单查询 operationId: alipay.ebpp.invoice.ecorder.order.query parameters: - description: 企业ID explode: true in: query name: enterprise_id required: false schema: example: "2088501296144291" type: string style: form - description: 共同账户ID explode: true in: query name: account_id required: false schema: example: "2088000000000000" type: string style: form - description: 授权签约协议号 explode: true in: query name: agreement_no required: false schema: example: "20200000000000000000" type: string style: form - description: 订单ID explode: true in: query name: order_id required: false schema: example: "2020103022000000000000000000" type: string style: form - description: 订单类型 explode: true in: query name: order_type required: false schema: example: METRO type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceEcorderOrderQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_ecorder_order_query_default_response' description: 请求失败 summary: 企业码订单查询 tags: - alipay.ebpp.invoice.ecorder.order x-accepts: application/json /v3/alipay/ebpp/invoice/einvpackage/query: get: description: 第三方报销软件根据支付宝提供的用户的发票包id,查询对应的发票包的电子发票,ocr纸票和消费记录明细信息 operationId: alipay.ebpp.invoice.einvpackage.query parameters: - description: 加密过的uid。获取详情参见 "推"模式发票报销。 explode: true in: query name: encrypted_uid required: false schema: example: Zhm4AKUE8ShJK6FYfKmk type: string style: form - description: 发票包id。获取详情参见 "推"模式发票报销。 explode: true in: query name: package_id required: false schema: example: "202004150000000000000000000" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceEinvpackageQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_einvpackage_query_default_response' description: 请求失败 summary: 查询用户发票包的明细信息 tags: - alipay.ebpp.invoice.einvpackage x-accepts: application/json /v3/alipay/ebpp/invoice/enterprise/merchantrelation/create: post: description: 根据交易流水号创建企业商户绑定关系 operationId: alipay.ebpp.invoice.enterprise.merchantrelation.create parameters: - description: 企业ID explode: true in: query name: enterprise_id required: false schema: example: 2088xxx type: string style: form requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseMerchantrelationCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseMerchantrelationCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_enterprise_merchantrelation_create_default_response' description: 请求失败 summary: 创建企业商户关系 tags: - alipay.ebpp.invoice.enterprise.merchantrelation x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/enterpriseconsume/consume/batchquery: post: description: 基于企业ID和员工UID,在指定时间段(时间间隔不超过24小时)内获取因公账单数据 operationId: alipay.ebpp.invoice.enterpriseconsume.consume.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeConsumeBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeConsumeBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_enterpriseconsume_consume_batchquery_default_response' description: 请求失败 summary: 企业因公账单查询 tags: - alipay.ebpp.invoice.enterpriseconsume.consume x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/enterpriseconsume/detail/query: get: description: 获取凭证基础信息结构化数据 operationId: alipay.ebpp.invoice.enterpriseconsume.detail.query parameters: - description: 企业ID explode: true in: query name: account_id required: false schema: example: "2088123456789000" type: string style: form - description: 授权签约协议号 explode: true in: query name: agreement_no required: false schema: example: "20205820659822371223" type: string style: form - description: 账单凭证ID explode: true in: query name: voucher_id required: false schema: example: "2020123100152601930000003650" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeDetailQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_enterpriseconsume_detail_query_default_response' description: 请求失败 summary: 凭证详情查询接口 tags: - alipay.ebpp.invoice.enterpriseconsume.detail x-accepts: application/json /v3/alipay/ebpp/invoice/enterpriseconsume/enterpriseopenrule/create: post: description: 新增一条开票规则配置 operationId: alipay.ebpp.invoice.enterpriseconsume.enterpriseopenrule.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_enterpriseconsume_enterpriseopenrule_create_default_response' description: 请求失败 summary: 新增开票规则 tags: - alipay.ebpp.invoice.enterpriseconsume.enterpriseopenrule x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/enterpriseconsume/enterpriseopenrule/modify: post: description: 修改开票规则 operationId: alipay.ebpp.invoice.enterpriseconsume.enterpriseopenrule.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_enterpriseconsume_enterpriseopenrule_modify_default_response' description: 请求失败 summary: 修改开票规则 tags: - alipay.ebpp.invoice.enterpriseconsume.enterpriseopenrule x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/enterpriseconsume/enterpriseopenrule/query: get: description: 根据开票规则ID查询开票规则详情 operationId: alipay.ebpp.invoice.enterpriseconsume.enterpriseopenrule.query parameters: - description: 企业ID explode: true in: query name: enterprise_id required: false schema: example: "2088000194958955" type: string style: form - description: 开票规则ID explode: true in: query name: invoice_rule_id required: false schema: example: "2021032900152710950000000001" type: string style: form - description: 共同账户ID explode: true in: query name: account_id required: false schema: example: "2088000194958956" type: string style: form - description: 授权签约协议号 explode: true in: query name: agreement_no required: false schema: example: "20215425001112341234" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_enterpriseconsume_enterpriseopenrule_query_default_response' description: 请求失败 summary: 查询开票规则 tags: - alipay.ebpp.invoice.enterpriseconsume.enterpriseopenrule x-accepts: application/json /v3/alipay/ebpp/invoice/enterpriseconsume/openrulerelation/create: post: description: 新增开票规则并自动绑定到费控规则 operationId: alipay.ebpp.invoice.enterpriseconsume.openrulerelation.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeOpenrulerelationCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeOpenrulerelationCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_enterpriseconsume_openrulerelation_create_default_response' description: 请求失败 summary: 新增开票规则并绑定费控规则 tags: - alipay.ebpp.invoice.enterpriseconsume.openrulerelation x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/enterpriseconsume/relatedetail/query: get: description: 合花账单关联详情查询,通过凭证ID获取这个账单详细信息和关联的凭证详细信息 operationId: alipay.ebpp.invoice.enterpriseconsume.relatedetail.query parameters: - description: 企业ID explode: true in: query name: account_id required: false schema: example: "2088123456789000" type: string style: form - description: 授权签约协议号 explode: true in: query name: agreement_no required: false schema: example: "20205820659822371223" type: string style: form - description: 账单凭证ID explode: true in: query name: voucher_id required: false schema: example: "2020123100152601930000003650" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeRelatedetailQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_enterpriseconsume_relatedetail_query_default_response' description: 请求失败 summary: 合花账单关联详情查询 tags: - alipay.ebpp.invoice.enterpriseconsume.relatedetail x-accepts: application/json /v3/alipay/ebpp/invoice/enterpriseconsume/summaryinvoicedetail/query: get: description: 根据汇总开票通知拿到的开票批次ID查询汇总发票详情 operationId: alipay.ebpp.invoice.enterpriseconsume.summaryinvoicedetail.query parameters: - description: 企业 ID explode: true in: query name: account_id required: false schema: example: "2088000237836238" type: string style: form - description: 授权签约协议号 explode: true in: query name: agreement_no required: false schema: example: "20205820659822371223" type: string style: form - description: 开票批次 ID explode: true in: query name: summary_id required: false schema: example: "2021080400152500230000000881" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeSummaryinvoicedetailQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_enterpriseconsume_summaryinvoicedetail_query_default_response' description: 请求失败 summary: 查询汇总发票详情 tags: - alipay.ebpp.invoice.enterpriseconsume.summaryinvoicedetail x-accepts: application/json /v3/alipay/ebpp/invoice/enterpriseexctrl/employertitle: put: description: 修改企业开票抬头 operationId: alipay.ebpp.invoice.enterpriseexctrl.employertitle.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseexctrlEmployertitleModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseexctrlEmployertitleModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_enterpriseexctrl_employertitle_modify_default_response' description: 请求失败 summary: 修改企业抬头 tags: - alipay.ebpp.invoice.enterpriseexctrl.employertitle x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/enterpriseexctrl/employertitle/batchquery: post: description: 分页查询企业抬头列表 operationId: alipay.ebpp.invoice.enterpriseexctrl.employertitle.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseexctrlEmployertitleBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseexctrlEmployertitleBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_enterpriseexctrl_employertitle_batchquery_default_response' description: 请求失败 summary: 批量查询企业抬头 tags: - alipay.ebpp.invoice.enterpriseexctrl.employertitle x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/enterpriseexctrl/employertitle/create: post: description: 新增一条企业开票抬头 operationId: alipay.ebpp.invoice.enterpriseexctrl.employertitle.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseexctrlEmployertitleCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseexctrlEmployertitleCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_enterpriseexctrl_employertitle_create_default_response' description: 请求失败 summary: 新增企业抬头 tags: - alipay.ebpp.invoice.enterpriseexctrl.employertitle x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/enterpriseexctrl/employertitle/query: get: description: 根据抬头ID查询企业抬头详情 operationId: alipay.ebpp.invoice.enterpriseexctrl.employertitle.query parameters: - description: 企业共同账户id explode: true in: query name: account_id required: false schema: example: "2088000194958956" type: string style: form - description: 企业id explode: true in: query name: enterprise_id required: false schema: example: "2088123412341234" type: string style: form - description: 授权签约协议号 explode: true in: query name: agreement_no required: false schema: example: "20215425001181407500" type: string style: form - description: 抬头ID explode: true in: query name: title_id required: false schema: example: "2022110200152710030000000003" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseexctrlEmployertitleQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_enterpriseexctrl_employertitle_query_default_response' description: 请求失败 summary: 查询企业抬头 tags: - alipay.ebpp.invoice.enterpriseexctrl.employertitle x-accepts: application/json /v3/alipay/ebpp/invoice/expense/progress/sync: post: description: 用户提交发票管家发票到isv申请报销后,isv对报销处理进度推进 operationId: alipay.ebpp.invoice.expense.progress.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpenseProgressSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpenseProgressSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_expense_progress_sync_default_response' description: 请求失败 summary: 发票报销处理进度同步 tags: - alipay.ebpp.invoice.expense.progress x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/expensecomsue/outsource/notify: post: description: 外部和企业码进行额度共管的时候,外部以交易的形式(支付、退款)将外部发生的额度变更同步给企业码 operationId: alipay.ebpp.invoice.expensecomsue.outsource.notify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpensecomsueOutsourceNotifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpensecomsueOutsourceNotifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_expensecomsue_outsource_notify_default_response' description: 请求失败 summary: 同步外部额度变更(交易形式) tags: - alipay.ebpp.invoice.expensecomsue.outsource x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/expensecontrol/aggregation/create: post: description: 创建费控规则聚合关系 operationId: alipay.ebpp.invoice.expensecontrol.aggregation.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpensecontrolAggregationCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpensecontrolAggregationCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_expensecontrol_aggregation_create_default_response' description: 请求失败 summary: 创建费控规则聚合关系 tags: - alipay.ebpp.invoice.expensecontrol.aggregation x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/expensecontrol/employeequota/create: post: description: 创建余额,该接口开放给特定场景。如果需要使用,请联系技术支持。 operationId: alipay.ebpp.invoice.expensecontrol.employeequota.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpensecontrolEmployeequotaCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpensecontrolEmployeequotaCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_expensecontrol_employeequota_create_default_response' description: 请求失败 summary: 创建余额(特定场景) tags: - alipay.ebpp.invoice.expensecontrol.employeequota x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/expensecontrol/issuebatch/cancel: post: description: 通过发放批次id,作废当前批次下发放的额度 operationId: alipay.ebpp.invoice.expensecontrol.issuebatch.cancel requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpensecontrolIssuebatchCancelModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpensecontrolIssuebatchCancelResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_expensecontrol_issuebatch_cancel_default_response' description: 请求失败 summary: 作废额度发放 tags: - alipay.ebpp.invoice.expensecontrol.issuebatch x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/expensecontrol/issuebatch/create: post: description: 通过该接口对企业下的员工进行批量的额度发放。 operationId: alipay.ebpp.invoice.expensecontrol.issuebatch.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpensecontrolIssuebatchCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpensecontrolIssuebatchCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_expensecontrol_issuebatch_create_default_response' description: 请求失败 summary: 手动发放额度接口 tags: - alipay.ebpp.invoice.expensecontrol.issuebatch x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/expensecontrol/quota/create: post: description: 创建余额或者点券 operationId: alipay.ebpp.invoice.expensecontrol.quota.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpensecontrolQuotaCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpensecontrolQuotaCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_expensecontrol_quota_create_default_response' description: 请求失败 summary: 创建余额/点券 tags: - alipay.ebpp.invoice.expensecontrol.quota x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/expensecontrol/quota/modify: post: description: 修改余额或点券 operationId: alipay.ebpp.invoice.expensecontrol.quota.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpensecontrolQuotaModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpensecontrolQuotaModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_expensecontrol_quota_modify_default_response' description: 请求失败 summary: 修改余额/点券 tags: - alipay.ebpp.invoice.expensecontrol.quota x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/expensecontrol/quota/query: post: description: 查询余额或者点券 operationId: alipay.ebpp.invoice.expensecontrol.quota.query requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpensecontrolQuotaQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpensecontrolQuotaQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_expensecontrol_quota_query_default_response' description: 请求失败 summary: 查询余额/点券 tags: - alipay.ebpp.invoice.expensecontrol.quota x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/expenserules/employee/query: get: description: 查询费控规则员工 operationId: alipay.ebpp.invoice.expenserules.employee.query parameters: - description: 共同账号ID explode: true in: query name: account_id required: false schema: example: "2088123456789000" type: string style: form - description: 授权签约协议号 explode: true in: query name: agreement_no required: false schema: example: "20205820659822371223" type: string style: form - description: 企业码企业id explode: true in: query name: enterprise_id required: false schema: example: "2088000194958956" type: string style: form - description: 费控规则ID explode: true in: query name: standard_id required: false schema: example: "2021081900152601000000000101" type: string style: form - description: 页数 explode: true in: query name: page_num required: false schema: example: 1 type: integer style: form - description: 页大小 explode: true in: query name: page_size required: false schema: example: 20 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesEmployeeQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_expenserules_employee_query_default_response' description: 请求失败 summary: 查询费控规则员工 tags: - alipay.ebpp.invoice.expenserules.employee x-accepts: application/json /v3/alipay/ebpp/invoice/expenserules/employeerules/query: get: description: 分页查询指定员工绑定的所有费控规则,默认返回所有有效和无效规则,查询结果按费控规则的创建时间倒序 operationId: alipay.ebpp.invoice.expenserules.employeerules.query parameters: - description: 企业ID explode: true in: query name: account_id required: false schema: example: 208800019495xxxx type: string style: form - description: 授权签约协议号 explode: true in: query name: agreement_no required: false schema: example: 2021542500111234xxxx type: string style: form - description: 未切换open_id时使用此字段:员工ID explode: true in: query name: employee_id required: false schema: example: 208852286537xxxx type: string style: form - description: 切换open_id后使用此字段:员工的open_id explode: true in: query name: employee_open_id required: false schema: example: abcdxxxx type: string style: form - description: 页码,默认值为1 explode: true in: query name: page_num required: false schema: example: 1 type: integer style: form - description: 每页行数,默认值为20 explode: true in: query name: page_size required: false schema: example: 20 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesEmployeerulesQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_expenserules_employeerules_query_default_response' description: 请求失败 summary: 查询员工绑定的所有费控规则 tags: - alipay.ebpp.invoice.expenserules.employeerules x-accepts: application/json /v3/alipay/ebpp/invoice/expenserules/groupemployee/modify: post: description: 修改费控规则员工 operationId: alipay.ebpp.invoice.expenserules.groupemployee.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesGroupemployeeModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesGroupemployeeModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_expenserules_groupemployee_modify_default_response' description: 请求失败 summary: 修改费控规则员工 tags: - alipay.ebpp.invoice.expenserules.groupemployee x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/expenserules/projectemployee/modify: post: description: 修改项目的员工列表 operationId: alipay.ebpp.invoice.expenserules.projectemployee.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesProjectemployeeModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesProjectemployeeModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_expenserules_projectemployee_modify_default_response' description: 请求失败 summary: 修改项目的员工列表 tags: - alipay.ebpp.invoice.expenserules.projectemployee x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/expenserules/projectinfo/modify: post: description: 修改项目基础信息 operationId: alipay.ebpp.invoice.expenserules.projectinfo.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesProjectinfoModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesProjectinfoModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_expenserules_projectinfo_modify_default_response' description: 请求失败 summary: 修改项目基础信息 tags: - alipay.ebpp.invoice.expenserules.projectinfo x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/expenserules/projectrule/create: post: description: 创建项目费控规则 operationId: alipay.ebpp.invoice.expenserules.projectrule.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesProjectruleCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesProjectruleCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_expenserules_projectrule_create_default_response' description: 请求失败 summary: 创建项目费控规则 tags: - alipay.ebpp.invoice.expenserules.projectrule x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/expenserules/projectrule/query: get: description: 查询项目费控规则 operationId: alipay.ebpp.invoice.expenserules.projectrule.query parameters: - description: 共同账号ID explode: true in: query name: account_id required: false schema: example: "2088000194958956" type: string style: form - description: 授权签约协议号 explode: true in: query name: agreement_no required: false schema: example: "20215425001112341234" type: string style: form - description: 项目id(可空) explode: true in: query name: project_id required: false schema: example: "2021063000152700000000000000" type: string style: form - description: 员工UID(可空) explode: true in: query name: employee_id required: false schema: example: "2088123412341234" type: string style: form - description: 切换open_id后请使用:员工open_id(可空) explode: true in: query name: employee_open_id required: false schema: example: abcdxxxx type: string style: form - description: 页数 explode: true in: query name: page_num required: false schema: example: 1 type: integer style: form - description: 页大小 explode: true in: query name: page_size required: false schema: example: 20 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesProjectruleQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_expenserules_projectrule_query_default_response' description: 请求失败 summary: 查询项目费控规则 tags: - alipay.ebpp.invoice.expenserules.projectrule x-accepts: application/json /v3/alipay/ebpp/invoice/expenserules/projectrules/modify: post: description: 修改项目费控规则 operationId: alipay.ebpp.invoice.expenserules.projectrules.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesProjectrulesModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesProjectrulesModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_expenserules_projectrules_modify_default_response' description: 请求失败 summary: 修改项目费控规则 tags: - alipay.ebpp.invoice.expenserules.projectrules x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/expenserules/scenerule/create: post: description: 创建费控规则,例如:创建一条有效期为2021-08-01 00:00:00到2031-08-01 00:00:00的福利餐费控规则,限制对应员工的单日消费金额不超过100元; operationId: alipay.ebpp.invoice.expenserules.scenerule.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesSceneruleCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesSceneruleCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_expenserules_scenerule_create_default_response' description: 请求失败 summary: 创建费控规则 tags: - alipay.ebpp.invoice.expenserules.scenerule x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/expenserules/scenerule/modify: post: description: 修改费控规则 operationId: alipay.ebpp.invoice.expenserules.scenerule.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesSceneruleModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesSceneruleModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_expenserules_scenerule_modify_default_response' description: 请求失败 summary: 修改费控规则 tags: - alipay.ebpp.invoice.expenserules.scenerule x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/expenserules/scenerule/query: get: description: 查询费控规则信息 operationId: alipay.ebpp.invoice.expenserules.scenerule.query parameters: - description: 企业ID explode: true in: query name: account_id required: false schema: example: "2088000194958956" type: string style: form - description: 授权签约协议号 explode: true in: query name: agreement_no required: false schema: example: "20215425001112341234" type: string style: form - description: 企业码企业id explode: true in: query name: enterprise_id required: false schema: example: "2088000194958956" type: string style: form - description: 费控规则ID explode: true in: query name: standard_id required: false schema: example: "20215425001112341234" type: string style: form - description: 页数 explode: true in: query name: page_num required: false schema: example: 1 type: integer style: form - description: 页大小 explode: true in: query name: page_size required: false schema: example: 10 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesSceneruleQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_expenserules_scenerule_query_default_response' description: 请求失败 summary: 查询费控规则信息 tags: - alipay.ebpp.invoice.expenserules.scenerule x-accepts: application/json /v3/alipay/ebpp/invoice/expensescene/merchant/query: get: description: 查询企业可用商户信息 operationId: alipay.ebpp.invoice.expensescene.merchant.query parameters: - description: 共同账户ID explode: true in: query name: account_id required: false schema: example: 2088xxx type: string style: form - description: 授权签约协议号 explode: true in: query name: agreement_no required: false schema: example: "20215713002876184996" type: string style: form - description: 企业ID explode: true in: query name: enterprise_id required: false schema: example: 2088xxx type: string style: form - description: 商户ID explode: true in: query name: role_id required: false schema: example: 2088xxx type: string style: form - description: 商户ID explode: true in: query name: pid required: false schema: example: 2088xxx type: string style: form - description: 门店ID explode: true in: query name: shop_id required: false schema: example: 2088xxx type: string style: form - description: "费用类型\tMEAL - 工作餐" explode: true in: query name: expense_type required: false schema: example: MEAL type: string style: form - description: 页码 explode: true in: query name: page_num required: false schema: example: 1 type: integer style: form - description: 每页行数(最大100) explode: true in: query name: page_size required: false schema: example: 20 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceExpensesceneMerchantQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_expensescene_merchant_query_default_response' description: 请求失败 summary: 查询企业可用商户信息 tags: - alipay.ebpp.invoice.expensescene.merchant x-accepts: application/json /v3/alipay/ebpp/invoice/file/output/query: get: description: "根据发票代码,发票号码获取用户的普通增值税电子发票pdf文件\r\n查询权限要求: 发票属于当前isv报销单据进行状态(支持\ 的状态有 EXPENSE_APPLY-用户已提交申请 EXPENSE_APPROVAL_PASS -报销审核通过 EXPENSE_FINISHED-\ 报销完结)" operationId: alipay.ebpp.invoice.file.output.query parameters: - description: 发票归属用户 id,用户在支付宝的唯一标识,以 2088 开头的 16 位纯数字组成。 explode: true in: query name: user_id required: false schema: example: "2088550000000" type: string style: form - description: 发票归属用户 id,用户在支付宝的唯一标识,以 2088 开头的 16 位纯数字组成。 explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form - description: "发票代码\t字段长度(10-12位),全电票时为空" explode: true in: query name: invoice_code required: false schema: example: "123" type: string style: form - description: "发票号码\t字段长度(8-10位),全电票时为20位" explode: true in: query name: invoice_no required: false schema: example: "111" type: string style: form - description: 发票pdf文件下载应用场景。固定为 INVOICE_EXPENSE 表示发票报销。 explode: true in: query name: scene required: false schema: example: INVOICE_EXPENSE type: string style: form - description: 是否跳过发票报销状态同步;当为true时,跳过报销状态同步校验。默认为false,需要先做报销状态同步 explode: true in: query name: skip_expense_progress_sync required: false schema: example: false type: boolean style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceFileOutputQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_file_output_query_default_response' description: 请求失败 summary: 获取电子发票原文件 tags: - alipay.ebpp.invoice.file.output x-accepts: application/json /v3/alipay/ebpp/invoice/info/send: post: description: 商户或ISV将发票信息发送至发票管家。例如:商户为用户开出发票之后,通过该接口将发票发送到买家支付宝的发票管家中,买家可在发票管家中查看发票。 operationId: alipay.ebpp.invoice.info.send requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceInfoSendModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceInfoSendResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_info_send_default_response' description: 请求失败 summary: 发票信息回传接口(新版) tags: - alipay.ebpp.invoice.info x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/institution/create: post: description: 制度新增,包含制度下使用规则列表和发放规则列表的新增。 operationId: alipay.ebpp.invoice.institution.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_institution_create_default_response' description: 请求失败 summary: 制度新增 tags: - alipay.ebpp.invoice.institution x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/institution/delete: delete: description: 制度删除 operationId: alipay.ebpp.invoice.institution.delete parameters: - description: 企业共同账户id explode: true in: query name: account_id required: false schema: example: "2088000194958956" type: string style: form - description: 授权签约协议号 explode: true in: query name: agreement_no required: false schema: example: "20215425001181407500" type: string style: form - description: 企业id explode: true in: query name: enterprise_id required: false schema: example: "2088123412341234" type: string style: form - description: 制度id explode: true in: query name: institution_id required: false schema: example: "2022031000152617000000000001" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_institution_delete_default_response' description: 请求失败 summary: 制度删除 tags: - alipay.ebpp.invoice.institution x-accepts: application/json /v3/alipay/ebpp/invoice/institution/detailinfo/query: get: description: 单个制度查询,返回制度详细信息,包含制度下使用规则列表和发放规则列表 operationId: alipay.ebpp.invoice.institution.detailinfo.query parameters: - description: 企业共同账户id explode: true in: query name: account_id required: false schema: example: "2088000194958956" type: string style: form - description: 授权签约协议号 explode: true in: query name: agreement_no required: false schema: example: "20215425001112341234" type: string style: form - description: 企业ID explode: true in: query name: enterprise_id required: false schema: example: "2088000194958956" type: string style: form - description: 制度id explode: true in: query name: institution_id required: false schema: example: "2022071800152609780000004052" type: string style: form - description: 外部唯一标识 explode: true in: query name: outer_source_id required: false schema: example: 0b249cd916969304726395528e002c type: string style: form - description: 适配id类型 explode: true in: query name: owner_type required: false schema: example: PHONE type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionDetailinfoQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_institution_detailinfo_query_default_response' description: 请求失败 summary: 制度详情查询 tags: - alipay.ebpp.invoice.institution.detailinfo x-accepts: application/json /v3/alipay/ebpp/invoice/institution/expenserule/create: post: description: 创建费控使用规则 operationId: alipay.ebpp.invoice.institution.expenserule.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionExpenseruleCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionExpenseruleCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_institution_expenserule_create_default_response' description: 请求失败 summary: 创建费控使用规则 tags: - alipay.ebpp.invoice.institution.expenserule x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/institution/expenserule/delete: post: description: 删除制度下使用规则 operationId: alipay.ebpp.invoice.institution.expenserule.delete requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionExpenseruleDeleteModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionExpenseruleDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_institution_expenserule_delete_default_response' description: 请求失败 summary: 删除使用规则 tags: - alipay.ebpp.invoice.institution.expenserule x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/institution/expenserule/modify: post: description: 编辑制度下的使用规则 operationId: alipay.ebpp.invoice.institution.expenserule.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionExpenseruleModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionExpenseruleModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_institution_expenserule_modify_default_response' description: 请求失败 summary: 编辑使用规则 tags: - alipay.ebpp.invoice.institution.expenserule x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/institution/modify: post: description: 制度编辑 operationId: alipay.ebpp.invoice.institution.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_institution_modify_default_response' description: 请求失败 summary: 制度编辑 tags: - alipay.ebpp.invoice.institution x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/institution/pageinfo/query: get: description: 制度分页查询,返回制度基本信息 operationId: alipay.ebpp.invoice.institution.pageinfo.query parameters: - description: 企业共同账户id explode: true in: query name: account_id required: false schema: example: "2088000194958956" type: string style: form - description: 授权签约协议号 explode: true in: query name: agreement_no required: false schema: example: "20215425001112341234" type: string style: form - description: 企业ID explode: true in: query name: enterprise_id required: false schema: example: "2088000194958956" type: string style: form - description: 页码 explode: true in: query name: page_num required: false schema: example: 10 type: integer style: form - description: 页大小 explode: true in: query name: page_size required: false schema: example: 100 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionPageinfoQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_institution_pageinfo_query_default_response' description: 请求失败 summary: 费控制度分页查询 tags: - alipay.ebpp.invoice.institution.pageinfo x-accepts: application/json /v3/alipay/ebpp/invoice/institution/scope/modify: post: description: 修改制度下适配范围 operationId: alipay.ebpp.invoice.institution.scope.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionScopeModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionScopeModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_institution_scope_modify_default_response' description: 请求失败 summary: 修改制度下适配范围 tags: - alipay.ebpp.invoice.institution.scope x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/institution/scopepageinfo/query: get: description: 分页查询制度下适用范围列表 operationId: alipay.ebpp.invoice.institution.scopepageinfo.query parameters: - description: 企业共同账户id explode: true in: query name: account_id required: false schema: example: "2088000194958956" type: string style: form - description: 授权签约协议号 explode: true in: query name: agreement_no required: false schema: example: "20215425001112341234" type: string style: form - description: 企业id explode: true in: query name: enterprise_id required: false schema: example: "2088000194958956" type: string style: form - description: 制度id explode: true in: query name: institution_id required: false schema: example: "2022071800152609780000004052" type: string style: form - description: 适配id类型 explode: true in: query name: owner_type required: false schema: example: PHONE type: string style: form - description: 页码 explode: true in: query name: page_num required: false schema: example: 10 type: integer style: form - description: 页大小 explode: true in: query name: page_size required: false schema: example: 100 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionScopepageinfoQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_institution_scopepageinfo_query_default_response' description: 请求失败 summary: 分页查询制度下人员 tags: - alipay.ebpp.invoice.institution.scopepageinfo x-accepts: application/json /v3/alipay/ebpp/invoice/issuerule/create: post: description: 新增发放规则 operationId: alipay.ebpp.invoice.issuerule.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceIssueruleCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceIssueruleCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_issuerule_create_default_response' description: 请求失败 summary: 新增发放规则 tags: - alipay.ebpp.invoice.issuerule x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/issuerule/delete: post: description: 删除发放规则 operationId: alipay.ebpp.invoice.issuerule.delete requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceIssueruleDeleteModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceIssueruleDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_issuerule_delete_default_response' description: 请求失败 summary: 删除发放规则 tags: - alipay.ebpp.invoice.issuerule x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/issuerule/modify: post: description: 编辑发放规则 operationId: alipay.ebpp.invoice.issuerule.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceIssueruleModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceIssueruleModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_issuerule_modify_default_response' description: 请求失败 summary: 编辑发放规则 tags: - alipay.ebpp.invoice.issuerule x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/isvtoken/reim/apply: post: description: 当报销软件跳转支付宝报销助手,需要通过授权令牌进行身份认证,该接口用于ISV获取报销助手的授权令牌 operationId: alipay.ebpp.invoice.isvtoken.reim.apply requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceIsvtokenReimApplyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceIsvtokenReimApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_isvtoken_reim_apply_default_response' description: 请求失败 summary: 获取报销授权令牌 tags: - alipay.ebpp.invoice.isvtoken.reim x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/list/expense/sync: post: description: 报销状态节点状态批量同步时调用该接口 operationId: alipay.ebpp.invoice.list.expense.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceListExpenseSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceListExpenseSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_list_expense_sync_default_response' description: 请求失败 summary: 报销状态批量同步开放接口 tags: - alipay.ebpp.invoice.list.expense x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/merchant/enterstatus/query: get: description: 提供给替商户批量入驻的服务商,主动查询入驻流程的状态。 operationId: alipay.ebpp.invoice.merchant.enterstatus.query parameters: - description: 商户品牌简称,只能由大写字母、下划线、数字组成,且必须以大写字母开头。 explode: true in: query name: m_short_name required: false schema: example: MYJF type: string style: form - description: "商户门店入驻的产品码,STANDARD_INVOICE:扫码开票,INVOICE_RETURN:企业自建-发票回传,INVOICE_EXPENSE:发\ 票报销,PAYMENT_OPEN:支付即开票,PAY_FEE_OPEN:缴费后开票。" explode: true in: query name: product_code required: false schema: example: STANDARD_INVOICE type: string style: form - description: 工单流水号(如果不填则默认查询最近一条工单) explode: true in: query name: process_id required: false schema: example: "1234567" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceMerchantEnterstatusQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_merchant_enterstatus_query_default_response' description: 请求失败 summary: 商户入驻流程状态查询 tags: - alipay.ebpp.invoice.merchant.enterstatus x-accepts: application/json /v3/alipay/ebpp/invoice/merchantlist/enter/apply: post: description: 针对已经在支付宝入驻的服务方,使用该接口导入服务方后面的开票商户 operationId: alipay.ebpp.invoice.merchantlist.enter.apply requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceMerchantlistEnterApplyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceMerchantlistEnterApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_merchantlist_enter_apply_default_response' description: 请求失败 summary: 商户批量入驻申请接口 tags: - alipay.ebpp.invoice.merchantlist.enter x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/order/query: get: description: 根据外部订单号查询发票详情信息,适用于外部商户无开票申请ID场景 operationId: alipay.ebpp.invoice.order.query parameters: - description: 开票申请时所传入订单号,不限于支付宝体内交易订单号。如:20200520110046966071 explode: true in: query name: order_no required: false schema: example: "20200520110046966071" type: string style: form - description: "定义商户的一级简称,用于标识商户品牌,对应于商户入驻时填写的\"商户品牌简称\"。 如:肯德基:KFC" explode: true in: query name: m_short_name required: false schema: example: KFC type: string style: form - description: "定义商户的二级简称,用于标识商户品牌下的分支机构,如门店,对应于商户入驻时填写的\"商户门店简称\"。 如:肯德基-杭州\ 西湖区文一西路店:KFC-HZ-19003 要求:\"商户品牌简称+商户门店简称\"作为确定商户及其下属机构的唯一标识,不可重复。" explode: true in: query name: sub_m_short_name required: false schema: example: KFC-HZ-19003 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceOrderQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_order_query_default_response' description: 请求失败 summary: 根据外部订单号查询发票信息 tags: - alipay.ebpp.invoice.order x-accepts: application/json /v3/alipay/ebpp/invoice/sycn: post: description: 外部商户开蓝票/冲红执行成功后将发票信息及原件(如有)同步至支付宝,由支付宝通知用户查看已开具的发票。 operationId: alipay.ebpp.invoice.sycn requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceSycnModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceSycnResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_sycn_default_response' description: 请求失败 summary: 发票信息同步至支付宝 tags: - alipay.ebpp.invoice x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/sync/simple/send: post: description: 商户或ISV将发票信息发送至发票管家。 operationId: alipay.ebpp.invoice.sync.simple.send requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceSyncSimpleSendModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceSyncSimpleSendResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_sync_simple_send_default_response' description: 请求失败 summary: 简单模式发票回传接口 tags: - alipay.ebpp.invoice.sync.simple x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/taxno/batchquery: post: description: 根据购买方税号获取用户的发票关键要素列表,该接口目前适用于发票报销场景 operationId: alipay.ebpp.invoice.taxno.batchquery parameters: - allowEmptyValue: true description: 用户授权令牌 explode: true in: query name: auth_token required: false schema: type: string style: form requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceTaxnoBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceTaxnoBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_taxno_batchquery_default_response' description: 请求失败 summary: 获取指定企业的发票要素列表 tags: - alipay.ebpp.invoice.taxno x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/invoice/title/dynamic/get: get: description: 支付宝钱包内的发票管家app在用户抬头展示页面会显示对应该抬头的动态条形码,通过本接口,可根据条形码中数字串获取对应的用户抬头信息。 operationId: alipay.ebpp.invoice.title.dynamic.get parameters: - description: 抬头动态码 explode: true in: query name: bar_code required: false schema: example: "82771888" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceTitleDynamicGetResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_title_dynamic_get_default_response' description: 请求失败 summary: 根据动态码查询发票抬头 tags: - alipay.ebpp.invoice.title.dynamic x-accepts: application/json /v3/alipay/ebpp/invoice/title/list/get: get: description: 用于服务商在用户授权的情况下获取用户的发票抬头列表供用户使用。 operationId: alipay.ebpp.invoice.title.list.get parameters: - allowEmptyValue: true description: 用户授权令牌 explode: true in: query name: auth_token required: false schema: type: string style: form - description: 支付宝用户id explode: true in: query name: user_id required: false schema: example: "2088000000000000" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceTitleListGetResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_title_list_get_default_response' description: 请求失败 summary: 获取指定用户所有的有效抬头列表 tags: - alipay.ebpp.invoice.title.list x-accepts: application/json /v3/alipay/ebpp/invoice/token/batchquery: get: description: 根据用户通过发票管家选择发票列表产生的请求令牌获取用户选择发票要素列表 operationId: alipay.ebpp.invoice.token.batchquery parameters: - description: 查询请求令牌。通过唤起支付宝钱包后用户进入发票管家选择发票列表后创建,并通过isv接收url回传给isv。详见 "选"模式发票报销。 explode: true in: query name: invoice_token required: false schema: example: 0136d80096e34a07a528db7cc5bc442888s type: string style: form - description: 发票要素获取应用场景。固定为 INVOICE_EXPENSE 表示发票报销。 explode: true in: query name: scene required: false schema: example: INVOICE_EXPENSE type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppInvoiceTokenBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_invoice_token_batchquery_default_response' description: 请求失败 summary: 根据查询令牌获取发票要素列表 tags: - alipay.ebpp.invoice.token x-accepts: application/json /v3/alipay/ebpp/pdeduct/async/pay: post: description: 直连代扣机构根据用户个人签约协议,按期按账单请求从用户账户扣款的接口。 operationId: alipay.ebpp.pdeduct.async.pay requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppPdeductAsyncPayModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppPdeductAsyncPayResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_pdeduct_async_pay_default_response' description: 请求失败 summary: 公共事业缴费直连代扣异步扣款支付接口 tags: - alipay.ebpp.pdeduct.async x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/pdeduct/bill/pay/status: get: description: 缴费直连代扣 operationId: alipay.ebpp.pdeduct.bill.pay.status parameters: - description: 支付宝用户ID explode: true in: query name: agreement_id required: false schema: example: "2088123123421312" type: string style: form - description: 用户UserId在应用AppId下的唯一用户标识 explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form - description: 商户代扣业务流水 explode: true in: query name: out_order_no required: false schema: example: "12312313" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppPdeductBillPayStatusResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_pdeduct_bill_pay_status_default_response' description: 请求失败 summary: 缴费直连代扣订单支付状态查询 tags: - alipay.ebpp.pdeduct.bill.pay x-accepts: application/json /v3/alipay/ebpp/pdeduct/pay: post: description: 直连代扣机构根据用户个人签约协议,按期按账单请求从用户账户扣款的接口。 operationId: alipay.ebpp.pdeduct.pay requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppPdeductPayModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppPdeductPayResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_pdeduct_pay_default_response' description: 请求失败 summary: 公共事业缴费直连代扣扣款支付接口 tags: - alipay.ebpp.pdeduct x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/pdeduct/sign/add: post: description: 缴费直连代扣签约 operationId: alipay.ebpp.pdeduct.sign.add requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppPdeductSignAddModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppPdeductSignAddResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_pdeduct_sign_add_default_response' description: 请求失败 summary: 缴费直连代扣签约 tags: - alipay.ebpp.pdeduct.sign x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/pdeduct/sign/cancel: post: description: 缴费直连代扣,用户取消签约接口 operationId: alipay.ebpp.pdeduct.sign.cancel requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppPdeductSignCancelModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppPdeductSignCancelResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_pdeduct_sign_cancel_default_response' description: 请求失败 summary: 缴费直连代扣取消签约 tags: - alipay.ebpp.pdeduct.sign x-content-type: application/json x-accepts: application/json /v3/alipay/ebpp/pdeduct/sign/query: get: description: 提供给朗新查询代扣协议状态的接口,用于进行双边对账,解决单边协议问题 operationId: alipay.ebpp.pdeduct.sign.query parameters: - description: 用户ID explode: true in: query name: user_id required: false schema: example: "2088302186230962" type: string style: form - description: 用户UserId在应用AppId下的唯一用户标识 explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form - description: 支付宝代扣协议Id。若协议id不传递,则需要保证业务类型、子业务类型、出账机构、户号必传 explode: true in: query name: agreement_id required: false schema: example: "1234557890" type: string style: form - description: "业务类型。\r\tJF:缴水、电、燃气、固话宽带、有线电视、交通罚款费用\r\tWUYE:缴物业费\r\tHK:信用卡还\ 款\r\tTX:手机充值" explode: true in: query name: biz_type required: false schema: example: JF type: string style: form - description: "业务子类型。\r\tWATER:缴水费\r\tELECTRIC:缴电费\r\tGAS:缴燃气费\r\tCOMMUN:缴固\ 话宽带\r\tCATV:缴有线电视费\r\tTRAFFIC:缴交通罚款\r\tWUYE:缴物业费\r\tHK:信用卡还款\r\tCZ:手机充值" explode: true in: query name: sub_biz_type required: false schema: example: ELECTRIC type: string style: form - description: 支付宝缴费系统中的出账机构ID explode: true in: query name: charge_inst required: false schema: example: CQCENTERELECTRIC type: string style: form - description: 户号,机构针对于每户的水、电都会有唯一的标识户号 explode: true in: query name: bill_key required: false schema: example: "02659981" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppPdeductSignQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_pdeduct_sign_query_default_response' description: 请求失败 summary: 直连代扣协议查询接口 tags: - alipay.ebpp.pdeduct.sign x-accepts: application/json /v3/alipay/ebpp/pdeduct/sign/validate: post: description: 服务窗代扣签约的前置校验接口,签约前,可以先调用该接口进行校验是否可以签约 operationId: alipay.ebpp.pdeduct.sign.validate requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEbppPdeductSignValidateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEbppPdeductSignValidateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_ebpp_pdeduct_sign_validate_default_response' description: 请求失败 summary: 缴费直连代扣签约前置校验 tags: - alipay.ebpp.pdeduct.sign x-content-type: application/json x-accepts: application/json /v3/alipay/eco/contract/signflows/create: post: description: 根据配置好的合同模板,调用接口填充内容并指定签署人创建电子合同签署流程。 operationId: alipay.eco.contract.signflows.create parameters: - description: 目标isv应用ID explode: true in: query name: target_app_id required: false schema: type: string style: form requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEcoContractSignflowsCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoContractSignflowsCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_contract_signflows_create_default_response' description: 请求失败 summary: 创建电子合同签署流程(E签宝) tags: - alipay.eco.contract.signflows x-content-type: application/json x-accepts: application/json /v3/alipay/eco/doc/template/create: post: description: 通过此接口创建合同模板后,通过返回的文件直传地址上传模板文件(WORD/PDF)。同时记录接口返回的模板ID(templateId),后续发起合同签署需要使用到。 operationId: alipay.eco.doc.template.create parameters: - description: 目标isv应用ID explode: true in: query name: target_app_id required: false schema: type: string style: form requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEcoDocTemplateCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoDocTemplateCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_doc_template_create_default_response' description: 请求失败 summary: 创建合同模板(E签宝) tags: - alipay.eco.doc.template x-content-type: application/json x-accepts: application/json /v3/alipay/eco/doctemplate/settingurl/query: get: description: 通过创建合同模板接口返回的模板ID(templateId)获取合同模板的配置地址。在模板设置页面上进行模板输入组件、签署区设置后,即可基于模板发起合同签署。 operationId: alipay.eco.doctemplate.settingurl.query parameters: - description: 目标isv应用ID explode: true in: query name: target_app_id required: false schema: type: string style: form - description: 合同模板id。通过创建合同模版(alipay.eco.doc.template.create)接口获取。 explode: true in: query name: template_id required: false schema: example: 0016801a4ec24e548a93b094856b735c type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoDoctemplateSettingurlQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_doctemplate_settingurl_query_default_response' description: 请求失败 summary: 获取合同模板设置地址(E签宝) tags: - alipay.eco.doctemplate.settingurl x-accepts: application/json /v3/alipay/eco/edu/kt/billing/modify: post: description: isv向支付宝-中小学-教育缴费发送教育缴费账单后,家长在支付宝-中小学-教育缴费中对账单完成支付操作且支付成功,ISV在自有系统内容对账,完成后通过此接口同步对账后的账单状态。状态分为:缴费成功、缴费失败。 operationId: alipay.eco.edu.kt.billing.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEcoEduKtBillingModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoEduKtBillingModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_edu_kt_billing_modify_default_response' description: 请求失败 summary: 教育缴费账单状态同步接口 tags: - alipay.eco.edu.kt.billing x-content-type: application/json x-accepts: application/json /v3/alipay/eco/edu/kt/billing/query: get: description: 缴费账单查询 operationId: alipay.eco.edu.kt.billing.query parameters: - description: Isv pid explode: true in: query name: isv_pid required: false schema: example: "2088121212121212" type: string style: form - description: 学校支付宝pid,直付通填写smid explode: true in: query name: school_pid required: false schema: example: "2088101117955611" type: string style: form - description: ISV调用发送账单接口,返回给商户的order_no explode: true in: query name: out_trade_no required: false schema: example: 58de07de7bb90a437553e464 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoEduKtBillingQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_edu_kt_billing_query_default_response' description: 请求失败 summary: 缴费账单查询 tags: - alipay.eco.edu.kt.billing x-accepts: application/json /v3/alipay/eco/edu/kt/billing/send: post: description: 商家发送教育缴费账单给孩子,家长在支付宝可以查看自己绑定的孩子的缴费账单。 operationId: alipay.eco.edu.kt.billing.send requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEcoEduKtBillingSendModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoEduKtBillingSendResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_edu_kt_billing_send_default_response' description: 请求失败 summary: 教育缴费账单发送接口 tags: - alipay.eco.edu.kt.billing x-content-type: application/json x-accepts: application/json /v3/alipay/eco/edu/kt/parent/query: get: description: "ISV发送账单后,用户在支付宝缴费成功。ISV可以通过此接口查询,用户缴费的时候,是否创建了缴费账户,如果已经添加,学校使用\ ISV的系统再次发账单就可以通过支付宝的通知触达用户;如果未添加,学校即可联系家长,督促家长在支付宝添加学生的缴费账户。\r\n目前的出现的场景是家\ 长第一次缴费成功后,学校使用ISV的系统再次发账单,认为家长应该收到通知,实际上只有建立缴费账户的家长才能收到,未建立缴费账户的是收不到通知,这部分\ 家长有可能就缴费不及时或不通过支付宝缴费。" operationId: alipay.eco.edu.kt.parent.query parameters: - description: 学校支付宝pid explode: true in: query name: school_pid required: false schema: example: "20880012939123234423" type: string style: form - description: 学校编码,录入学校接口返回的school_no参数 explode: true in: query name: school_no required: false schema: example: "11010100000002" type: string style: form - description: Isv的支付宝pid explode: true in: query name: partner_id required: false schema: example: "208800129391238873" type: string style: form - description: 孩子或学生姓名 explode: true in: query name: child_name required: false schema: example: 张晓晓 type: string style: form - description: 用户手机号,发账单时填写users数组中的一个手机号。结果返回用户是否通过此手机号添加此学生的缴费账户。user_mobile、student_code 、student_identify 必须并且只能填一项。 explode: true in: query name: user_mobile required: false schema: example: "13300000000" type: string style: form - description: 学生的学号,一个学校的学号必须是唯一。结果返回用户是否通过此学号添加此学生的缴费账户。user_mobile、student_code 、student_identify 必须并且只能填一项。 explode: true in: query name: student_code required: false schema: example: "2098453900091" type: string style: form - description: 学生的身份证号,使用身份证规则验证。结果返回用户是否通过此身份证号添加此学生的缴费账户。user_mobile、student_code 、student_identify 必须并且只能填一项。 explode: true in: query name: student_identify required: false schema: example: "982343191010100909" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoEduKtParentQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_edu_kt_parent_query_default_response' description: 请求失败 summary: 查询学生家长状态接口 tags: - alipay.eco.edu.kt.parent x-accepts: application/json /v3/alipay/eco/edu/kt/schoolinfo/modify: post: description: ISV与支付宝签约后,通过此接口同步学校信息到中小学教育平台。 operationId: alipay.eco.edu.kt.schoolinfo.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEcoEduKtSchoolinfoModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoEduKtSchoolinfoModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_edu_kt_schoolinfo_modify_default_response' description: 请求失败 summary: 教育缴费学校信息录入接口 tags: - alipay.eco.edu.kt.schoolinfo x-content-type: application/json x-accepts: application/json /v3/alipay/eco/edu/kt/student/modify: post: description: 学生信息更新 operationId: alipay.eco.edu.kt.student.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEcoEduKtStudentModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoEduKtStudentModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_edu_kt_student_modify_default_response' description: 请求失败 summary: 学生信息更新 tags: - alipay.eco.edu.kt.student x-content-type: application/json x-accepts: application/json /v3/alipay/eco/file/path/query: get: description: 获取文件直传地址(E签宝) operationId: alipay.eco.file.path.query parameters: - description: 目标isv应用ID explode: true in: query name: target_app_id required: false schema: type: string style: form - description: 先计算文件md5值,在对该md5值进行base64编码 explode: true in: query name: content_md_5 required: false schema: example: eGMHwA4TWnbg6PYKMxreUQ== type: string style: form - description: 目标文件的MIME类型 explode: true in: query name: content_type required: false schema: example: application/octet-stream type: string style: form - description: "文件名称。\t注意:必须带上文件扩展名,不然会导致后续发起流程校验不通过。示例:合同.pdf。" explode: true in: query name: file_name required: false schema: example: 附件.zip type: string style: form - description: 文件大小,单位byte。最大允许上传30Mb explode: true in: query name: file_size required: false schema: example: 2542635 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoFilePathQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_file_path_query_default_response' description: 请求失败 summary: 获取文件直传地址(E签宝) tags: - alipay.eco.file.path x-accepts: application/json /v3/alipay/eco/mycar/parking/chargeinfo/sync: post: description: 停车场价格信息同步 operationId: alipay.eco.mycar.parking.chargeinfo.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingChargeinfoSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingChargeinfoSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_mycar_parking_chargeinfo_sync_default_response' description: 请求失败 summary: 停车场价格信息同步 tags: - alipay.eco.mycar.parking.chargeinfo x-content-type: application/json x-accepts: application/json /v3/alipay/eco/mycar/parking/charginginfo/sync: post: description: 上传车辆在停车场的计费信息,将停车动作推进到计费状态,上传信息通过该接口提交到支付宝,支付宝返回对应的信息 operationId: alipay.eco.mycar.parking.charginginfo.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingCharginginfoSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingCharginginfoSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_mycar_parking_charginginfo_sync_default_response' description: 请求失败 summary: 车辆停车计费接口 tags: - alipay.eco.mycar.parking.charginginfo x-content-type: application/json x-accepts: application/json /v3/alipay/eco/mycar/parking/config/query: get: description: ISV通过该接口,查询ISV已注册到车主平台停车业务系统配置信息。 operationId: alipay.eco.mycar.parking.config.query parameters: - description: "接口名称。H5传入参数固定值:alipay.eco.mycar.parking.userpage.query;\t小程序\ 传入参数固定值:alipay.eco.mycar.parking.isv.homepage;\t协议状态变更通知传入参数固定值: alipay.eco.mycar.parking.agreement.notify。" explode: true in: query name: interface_name required: false schema: example: alipay.eco.mycar.parking.userpage.query type: string style: form - description: "接口类型。H5、小程序传入参数固定值:interface_page;\t通知接口传入参数固定值:interface_service。" explode: true in: query name: interface_type required: false schema: example: interface_page type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingConfigQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_mycar_parking_config_query_default_response' description: 请求失败 summary: ISV系统配置查询接口 tags: - alipay.eco.mycar.parking.config x-accepts: application/json /v3/alipay/eco/mycar/parking/config/set: post: description: ISV通过该接口,配置车主平台各业务所需要的ISV的系统配置信息。如果接口配置存在则覆盖原有的接口信息。通过该接口设置的配置信息是立刻生效的,在调用该接口修改配置信息时请先评估对线上业务的影响,并做好处理方案。 operationId: alipay.eco.mycar.parking.config.set requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingConfigSetModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingConfigSetResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_mycar_parking_config_set_default_response' description: 请求失败 summary: 停车ISV系统配置接口 tags: - alipay.eco.mycar.parking.config x-content-type: application/json x-accepts: application/json /v3/alipay/eco/mycar/parking/enterinfo/sync: post: description: 上传车辆驶入信息,上传信息通过该接口提交到支付宝,支付宝返回对应的信息 operationId: alipay.eco.mycar.parking.enterinfo.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingEnterinfoSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingEnterinfoSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_mycar_parking_enterinfo_sync_default_response' description: 请求失败 summary: 车辆驶入接口 tags: - alipay.eco.mycar.parking.enterinfo x-content-type: application/json x-accepts: application/json /v3/alipay/eco/mycar/parking/exitinfo/sync: post: description: 上传车辆驶出信息,上传信息通过该接口提交到支付宝,支付宝返回对应的信息 operationId: alipay.eco.mycar.parking.exitinfo.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingExitinfoSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingExitinfoSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_mycar_parking_exitinfo_sync_default_response' description: 请求失败 summary: 车辆驶出接口 tags: - alipay.eco.mycar.parking.exitinfo x-content-type: application/json x-accepts: application/json /v3/alipay/eco/mycar/parking/order/sync: post: description: 商户通过接口调用,回传订单信息给停车平台 operationId: alipay.eco.mycar.parking.order.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingOrderSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingOrderSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_mycar_parking_order_sync_default_response' description: 请求失败 summary: 订单同步接口 tags: - alipay.eco.mycar.parking.order x-content-type: application/json x-accepts: application/json /v3/alipay/eco/mycar/parking/order/update: post: description: 商户通过接口调用,回传订单状态给停车平台 operationId: alipay.eco.mycar.parking.order.update requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingOrderUpdateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingOrderUpdateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_mycar_parking_order_update_default_response' description: 请求失败 summary: 订单更新接口 tags: - alipay.eco.mycar.parking.order x-content-type: application/json x-accepts: application/json /v3/alipay/eco/mycar/parking/overtimecharginginfo/sync: post: description: 上传车辆在停车场超时出场后的重新计费信息,将停车动作推进到计费状态,上传信息通过该接口提交到支付宝,支付宝返回对应的信息 operationId: alipay.eco.mycar.parking.overtimecharginginfo.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingOvertimecharginginfoSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingOvertimecharginginfoSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_mycar_parking_overtimecharginginfo_sync_default_response' description: 请求失败 summary: 车辆停车超时重计费接口 tags: - alipay.eco.mycar.parking.overtimecharginginfo x-content-type: application/json x-accepts: application/json /v3/alipay/eco/mycar/parking/parkinglotbiz/transfer: post: description: 解决车场多isv接管问题,可以通过归属灵活控制权限。 operationId: alipay.eco.mycar.parking.parkinglotbiz.transfer requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingParkinglotbizTransferModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingParkinglotbizTransferResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_mycar_parking_parkinglotbiz_transfer_default_response' description: 请求失败 summary: 车场业务归属配置 tags: - alipay.eco.mycar.parking.parkinglotbiz x-content-type: application/json x-accepts: application/json /v3/alipay/eco/mycar/parking/parkinglotinfo/create: post: description: 录入停车场信息,内容信息通过该接口提交到支付宝,支付宝会生成支付宝这边停车场ID反馈给开发者,用户后续更新和上送车辆信息。 operationId: alipay.eco.mycar.parking.parkinglotinfo.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingParkinglotinfoCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingParkinglotinfoCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_mycar_parking_parkinglotinfo_create_default_response' description: 请求失败 summary: 录入停车场信息 tags: - alipay.eco.mycar.parking.parkinglotinfo x-content-type: application/json x-accepts: application/json /v3/alipay/eco/mycar/parking/parkinglotinfo/query: get: description: 停车场信息查询,通过停车场id或者ISV停车场ID查询停车场信息。只能查询正在调用接口商户自己创建的停车场,限制在归属PID层面上。 operationId: alipay.eco.mycar.parking.parkinglotinfo.query parameters: - description: "支付宝停车平台ID,由支付宝定义的该停车场标识,同一个ISV或商户范围内唯一。通过 alipay.eco.mycar.parking.parkinglotinfo.create(录入停车场信息)接口获取。\t注意:parking_id和\ out_parking_id不能同时为空。" explode: true in: query name: parking_id required: false schema: example: PI1535687028031821446 type: string style: form - description: "ISV停车场ID,由ISV定义的停车场标识,同一个ISV或商户范围内唯一。需与 alipay.eco.mycar.parking.parkinglotinfo.create(录入停车场信息)接口传入值一致。\t注意\ :parking_id和out_parking_id不能同时为空。" explode: true in: query name: out_parking_id required: false schema: example: "10000110001" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingParkinglotinfoQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_mycar_parking_parkinglotinfo_query_default_response' description: 请求失败 summary: 停车场信息查询 tags: - alipay.eco.mycar.parking.parkinglotinfo x-accepts: application/json /v3/alipay/eco/mycar/parking/parkinglotinfo/update: post: description: 录入停车场信息,内容信息通过该接口提交到支付宝,支付宝会生成支付宝这边停车场ID反馈给开发者,用于后续更新和上送车辆信息,停车场名称不允许修改。 operationId: alipay.eco.mycar.parking.parkinglotinfo.update requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingParkinglotinfoUpdateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingParkinglotinfoUpdateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_mycar_parking_parkinglotinfo_update_default_response' description: 请求失败 summary: 修改停车场信息 tags: - alipay.eco.mycar.parking.parkinglotinfo x-content-type: application/json x-accepts: application/json /v3/alipay/eco/mycar/parking/paymentinfo/sync: post: description: 上传车辆在停车场的缴费信息,将停车动作推进到计费状态,上传信息通过该接口提交到支付宝,支付宝返回对应的信息 operationId: alipay.eco.mycar.parking.paymentinfo.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingPaymentinfoSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingPaymentinfoSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_mycar_parking_paymentinfo_sync_default_response' description: 请求失败 summary: 车辆停车缴费接口 tags: - alipay.eco.mycar.parking.paymentinfo x-content-type: application/json x-accepts: application/json /v3/alipay/eco/mycar/parking/spaceinfo/sync: post: description: 停车场位置信息同步 operationId: alipay.eco.mycar.parking.spaceinfo.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingSpaceinfoSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingSpaceinfoSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_mycar_parking_spaceinfo_sync_default_response' description: 请求失败 summary: 停车场车位信息同步 tags: - alipay.eco.mycar.parking.spaceinfo x-content-type: application/json x-accepts: application/json /v3/alipay/eco/mycar/parking/vehicle/query: get: description: 商户通过接口调用,获取用户车牌信息 operationId: alipay.eco.mycar.parking.vehicle.query parameters: - allowEmptyValue: true description: 用户授权令牌 explode: true in: query name: auth_token required: false schema: type: string style: form - description: 支付宝用户车辆ID,系统唯一。(该参数会在停车平台用户点击查询缴费,跳转到ISV停车缴费查询页面时,从请求中传递) explode: true in: query name: car_id required: false schema: example: "201605061278654" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoMycarParkingVehicleQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_mycar_parking_vehicle_query_default_response' description: 请求失败 summary: 车牌查询接口 tags: - alipay.eco.mycar.parking.vehicle x-accepts: application/json /v3/alipay/eco/sign/flow/cancel: post: description: 签署流程撤销(E签宝) operationId: alipay.eco.sign.flow.cancel parameters: - description: 目标isv应用ID explode: true in: query name: target_app_id required: false schema: type: string style: form requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEcoSignFlowCancelModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoSignFlowCancelResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_sign_flow_cancel_default_response' description: 请求失败 summary: 签署流程撤销(E签宝) tags: - alipay.eco.sign.flow x-content-type: application/json x-accepts: application/json /v3/alipay/eco/sign/flow/create: post: description: 创建流程(E签宝)。 operationId: alipay.eco.sign.flow.create parameters: - description: 目标isv应用ID explode: true in: query name: target_app_id required: false schema: type: string style: form requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEcoSignFlowCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoSignFlowCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_sign_flow_create_default_response' description: 请求失败 summary: 创建流程(E签宝) tags: - alipay.eco.sign.flow x-content-type: application/json x-accepts: application/json /v3/alipay/eco/sign/flow/finish: post: description: 手动归档签署流程,归档后所有资源不可修改,归档前签署流程中的所有签署人必须都签署完成。如果创建流程时,设置了自动归档,则无需调用本接口,签署完成后系统会自动调用。 operationId: alipay.eco.sign.flow.finish parameters: - description: 目标isv应用ID explode: true in: query name: target_app_id required: false schema: type: string style: form requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayEcoSignFlowFinishModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoSignFlowFinishResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_sign_flow_finish_default_response' description: 请求失败 summary: 签署流程归档 tags: - alipay.eco.sign.flow x-content-type: application/json x-accepts: application/json /v3/alipay/eco/sign/flow/query: get: description: 签署流程查询(E签宝)。可通过此接口查询流程、签署人的签署状态。 operationId: alipay.eco.sign.flow.query parameters: - description: 目标isv应用ID explode: true in: query name: target_app_id required: false schema: type: string style: form - description: 流程id,通过 创建电子合同签署流程(alipay.eco.contract.signflows.create)接口获取。 explode: true in: query name: flow_id required: false schema: example: 429b1d3038854cabbcdac0a63d7e4c0d type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoSignFlowQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_sign_flow_query_default_response' description: 请求失败 summary: 签署流程查询(E签宝) tags: - alipay.eco.sign.flow x-accepts: application/json /v3/alipay/eco/signflows/detail/query: get: description: 获取签署流程合同与附件的下载地址(E签宝) operationId: alipay.eco.signflows.detail.query parameters: - description: 目标isv应用ID explode: true in: query name: target_app_id required: false schema: type: string style: form - description: 流程id,通过 创建电子合同签署流程(alipay.eco.contract.signflows.create)接口获取。 explode: true in: query name: flow_id required: false schema: example: 429b1d3038854cabbcdac0a63d7e4c0d type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoSignflowsDetailQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_signflows_detail_query_default_response' description: 请求失败 summary: 获取签署流程合同与附件的下载地址(E签宝) tags: - alipay.eco.signflows.detail x-accepts: application/json /v3/alipay/eco/signflows/url/query: get: description: |- 创建流程后,获取指定签署人的签署链接地址,可在应用内集成H5签署页,或者通过短信发送签署链接。 传入个人唯一标识,则获取的签署任务链接仅包含个人人的签署任务;如同时传入企业唯一标识,则获取的签署任务链接包含企业与个人的签署任务。 预览链接:支持签署人先查看合同原文,后进行登录并完成签署。适用于应用内集成场景。 签署链接:签署人需要登录后查看合同原文并签署。适用用短信发送场景。 operationId: alipay.eco.signflows.url.query parameters: - description: 目标isv应用ID explode: true in: query name: target_app_id required: false schema: type: string style: form - description: 流程id,通过 创建电子合同签署流程(alipay.eco.contract.signflows.create)接口获取。 explode: true in: query name: flow_id required: false schema: example: 429b1d3038854cabbcdac0a63d7e4c0d type: string style: form - description: 创建流程时指定个人唯一标识 explode: true in: query name: third_party_user_id required: false schema: example: "2088102924502823" type: string style: form - description: 创建流程时指定企业唯一标识 explode: true in: query name: org_third_party_user_id required: false schema: example: "913301087458306077" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayEcoSignflowsUrlQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_eco_signflows_url_query_default_response' description: 请求失败 summary: 获取签署地址 tags: - alipay.eco.signflows.url x-accepts: application/json /v3/alipay/fund/account/query: get: description: 可查询请求方的支付宝账户余额信息。 operationId: alipay.fund.account.query parameters: - description: 商户会员的唯一标识。如果传入的user_id为虚拟账户userId,此字段必传并比对一致性。 explode: true in: query name: merchant_user_id required: false schema: example: "243893499" type: string style: form - description: 支付宝会员 id。 explode: true in: query name: alipay_user_id required: false schema: example: "2088301409188095" type: string style: form - description: 支付宝openId explode: true in: query name: alipay_open_id required: false schema: example: 061P6NAblcWDWJoDRxSVvOYz-ufp-3wQaA4E_szQyMFTXse type: string style: form - description: 开户产品码。如果查询托管子户余额,必传且必须传入与开户时传入的值一致。 explode: true in: query name: account_product_code required: false schema: example: DING_ACCOUNT type: string style: form - description: 查询的账号类型,查询余额账户值为ACCTRANS_ACCOUNT。必填。 explode: true in: query name: account_type required: false schema: example: ACCTRANS_ACCOUNT type: string style: form - description: 开户场景码,与开户产品码不可同时传递。 explode: true in: query name: account_scene_code required: false schema: example: SCENE_000_000_000 type: string style: form - description: JSON格式,传递业务扩展参数。 explode: true in: query name: ext_info required: false schema: example: "{\"agreement_no\":\"2019000000000\"}" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundAccountQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_account_query_default_response' description: 请求失败 summary: 支付宝资金账户资产查询接口 tags: - alipay.fund.account x-accepts: application/json /v3/alipay/fund/accountbook/create: post: description: 资金记账本开通 operationId: alipay.fund.accountbook.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundAccountbookCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundAccountbookCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_accountbook_create_default_response' description: 请求失败 summary: 资金记账本开通 tags: - alipay.fund.accountbook x-content-type: application/json x-accepts: application/json /v3/alipay/fund/accountbook/notify/query: get: description: ISV通过此接口查询指定记账本的入金和出金通知的订阅关系 operationId: alipay.fund.accountbook.notify.query parameters: - description: 产品码。固定为SATF_FUND_BOOK explode: true in: query name: product_code required: false schema: example: SATF_FUND_BOOK type: string style: form - description: 场景码。固定为DEFAULT explode: true in: query name: biz_scene required: false schema: example: DEFAULT type: string style: form - description: 记账本ID explode: true in: query name: account_book_id required: false schema: example: "2088000147677710" type: string style: form - description: 协议号。 若是基于协议的记账本,则agreement_no必传; 若是自创建的记账本,则agreement_no不传; explode: true in: query name: agreement_no required: false schema: example: "20205724001102186227" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundAccountbookNotifyQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_accountbook_notify_query_default_response' description: 请求失败 summary: 记账本通知订阅关系查询接口 tags: - alipay.fund.accountbook.notify x-accepts: application/json /v3/alipay/fund/accountbook/notify/subscribe: post: description: ISV通过此接口订阅指定记账本的入金和出金通知。目前只有非OpenAPI方式的充值通知(比如大额来账、贷款入金) operationId: alipay.fund.accountbook.notify.subscribe requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundAccountbookNotifySubscribeModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundAccountbookNotifySubscribeResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_accountbook_notify_subscribe_default_response' description: 请求失败 summary: 记账本通知订阅接口 tags: - alipay.fund.accountbook.notify x-content-type: application/json x-accepts: application/json /v3/alipay/fund/accountbook/notify/unsubscribe: post: description: ISV通过此接口取消订阅指定记账本的入金和出金通知 operationId: alipay.fund.accountbook.notify.unsubscribe requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundAccountbookNotifyUnsubscribeModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundAccountbookNotifyUnsubscribeResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_accountbook_notify_unsubscribe_default_response' description: 请求失败 summary: 记账本通知取消订阅接口 tags: - alipay.fund.accountbook.notify x-content-type: application/json x-accepts: application/json /v3/alipay/fund/accountbook/query: get: description: 资金记账本的信息查询 operationId: alipay.fund.accountbook.query parameters: - description: 记账账簿id explode: true in: query name: account_book_id required: false schema: example: "2088001409188095" type: string style: form - description: 商户会员的唯一标识,如果传入account_book_id此字段必传并比对一致性。 explode: true in: query name: merchant_user_id required: false schema: example: "243893499" type: string style: form - description: 资金记账本的开通场景码 explode: true in: query name: scene_code required: false schema: example: SATF_FUND_BOOK type: string style: form - description: JSON格式,传递业务扩展参数 explode: true in: query name: ext_info required: false schema: example: "{\"agreement_no\":\"2019000000000\"}" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundAccountbookQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_accountbook_query_default_response' description: 请求失败 summary: 资金记账本的信息查询 tags: - alipay.fund.accountbook x-accepts: application/json /v3/alipay/fund/agreement/quota/modify: post: description: 基于扣款合约设置付款方额度 operationId: alipay.fund.agreement.quota.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundAgreementQuotaModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundAgreementQuotaModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_agreement_quota_modify_default_response' description: 请求失败 summary: 额度设置接口 tags: - alipay.fund.agreement.quota x-content-type: application/json x-accepts: application/json /v3/alipay/fund/agreement/quota/query: post: description: 查询基于扣款协议的额度配置查询 operationId: alipay.fund.agreement.quota.query requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundAgreementQuotaQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundAgreementQuotaQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_agreement_quota_query_default_response' description: 请求失败 summary: 额度查询接口 tags: - alipay.fund.agreement.quota x-content-type: application/json x-accepts: application/json /v3/alipay/fund/auth/operation/cancel: post: description: 只有商户由于业务系统处理超时需要终止后续业务处理或者授权结果未知时可调用撤销,其他正常授权冻结的操作如需实现相同功能请调用资金授权解冻服务。提交资金授权后调用【资金授权操作查询】,没有明确的授权结果再调用【资金授权撤销】 operationId: alipay.fund.auth.operation.cancel requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundAuthOperationCancelModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundAuthOperationCancelResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_auth_operation_cancel_default_response' description: 请求失败 summary: 资金授权撤销接口 tags: - alipay.fund.auth.operation x-content-type: application/json x-accepts: application/json /v3/alipay/fund/auth/operation/detail/query: post: description: 通过该接口可以查询单笔明细的详细信息 operationId: alipay.fund.auth.operation.detail.query requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundAuthOperationDetailQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundAuthOperationDetailQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_auth_operation_detail_query_default_response' description: 请求失败 summary: 资金授权操作查询接口 tags: - alipay.fund.auth.operation.detail x-content-type: application/json x-accepts: application/json /v3/alipay/fund/auth/order/app/freeze: post: description: "创建支付宝授权订单并完成资金冻结。适用于线上场景完成资金授权, 例如从商户APP端拉起支付宝收银台完成冻结。" operationId: alipay.fund.auth.order.app.freeze requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundAuthOrderAppFreezeModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundAuthOrderAppFreezeResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_auth_order_app_freeze_default_response' description: 请求失败 summary: 线上资金授权冻结接口 tags: - alipay.fund.auth.order.app x-content-type: application/json x-accepts: application/json /v3/alipay/fund/auth/order/freeze: post: description: 收银员使用扫码设备读取用户支付宝钱包“付款码”后,将条码信息和订单信息通过本接口上送至支付宝发起资金冻结。 operationId: alipay.fund.auth.order.freeze requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundAuthOrderFreezeModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundAuthOrderFreezeResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_auth_order_freeze_default_response' description: 请求失败 summary: 资金授权冻结接口 tags: - alipay.fund.auth.order x-content-type: application/json x-accepts: application/json /v3/alipay/fund/auth/order/unfreeze: post: description: 当资金授权发生之后一段时间内,由于买家或者商家等其他原因需要要解冻资金,商家可通过资金授权解冻接口将授权资金进行解冻,支付宝将在收到解冻请求并验证成功后,按解冻规则将冻结资金按原路进行解冻 operationId: alipay.fund.auth.order.unfreeze requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundAuthOrderUnfreezeModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundAuthOrderUnfreezeResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_auth_order_unfreeze_default_response' description: 请求失败 summary: 资金授权解冻接口 tags: - alipay.fund.auth.order x-content-type: application/json x-accepts: application/json /v3/alipay/fund/auth/order/voucher/create: post: description: 收银员通过收银台或商户后台调用支付宝接口,生成二维码后,展示给用户,由用户扫描二维码完成资金冻结。 operationId: alipay.fund.auth.order.voucher.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundAuthOrderVoucherCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundAuthOrderVoucherCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_auth_order_voucher_create_default_response' description: 请求失败 summary: 资金授权发码接口 tags: - alipay.fund.auth.order.voucher x-content-type: application/json x-accepts: application/json /v3/alipay/fund/enterprisepay/group/add: post: description: 创建因公付群组,包含群组信息和出资信息 operationId: alipay.fund.enterprisepay.group.add requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundEnterprisepayGroupAddModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundEnterprisepayGroupAddResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_enterprisepay_group_add_default_response' description: 请求失败 summary: 因公付新增账户下群组 tags: - alipay.fund.enterprisepay.group x-content-type: application/json x-accepts: application/json /v3/alipay/fund/enterprisepay/group/delete: delete: description: 因公付删除账户下群组 operationId: alipay.fund.enterprisepay.group.delete parameters: - description: "产品码,默认值\tENTERPRISE_PAY" explode: true in: query name: product_code required: false schema: example: ENTERPRISE_PAY type: string style: form - description: 场景码,联系支付宝分配 explode: true in: query name: biz_scene required: false schema: example: ANT_GROUP type: string style: form - description: 企业签约账户ID explode: true in: query name: account_id required: false schema: example: "2088888888" type: string style: form - description: 平台和企业的三方授权协议号 explode: true in: query name: agreement_no required: false schema: example: "1231231321323" type: string style: form - description: 外部业务号 explode: true in: query name: out_biz_no required: false schema: example: "12123123" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundEnterprisepayGroupDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_enterprisepay_group_delete_default_response' description: 请求失败 summary: 因公付删除账户下群组 tags: - alipay.fund.enterprisepay.group x-accepts: application/json /v3/alipay/fund/enterprisepay/group/modify: post: description: 因公付更新账户下群组 operationId: alipay.fund.enterprisepay.group.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundEnterprisepayGroupModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundEnterprisepayGroupModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_enterprisepay_group_modify_default_response' description: 请求失败 summary: 因公付更新账户下群组 tags: - alipay.fund.enterprisepay.group x-content-type: application/json x-accepts: application/json /v3/alipay/fund/enterprisepay/group/query: get: description: 查询因公付群组,包含群组信息和对应的出资主体 operationId: alipay.fund.enterprisepay.group.query parameters: - description: 产品码,默认值 ENTERPRISE_PAY explode: true in: query name: product_code required: false schema: example: ENTERPRISE_PAY type: string style: form - description: 场景码,联系支付宝分配 explode: true in: query name: biz_scene required: false schema: example: ANT_GROUP type: string style: form - description: 企业签约账户ID explode: true in: query name: account_id required: false schema: example: "2088888888" type: string style: form - description: 平台和企业的三方授权协议号 explode: true in: query name: agreement_no required: false schema: example: "1231231321323" type: string style: form - description: 外部业务号,外部群组号 explode: true in: query name: out_biz_no required: false schema: example: "12312313" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundEnterprisepayGroupQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_enterprisepay_group_query_default_response' description: 请求失败 summary: 因公付查询账户下群组 tags: - alipay.fund.enterprisepay.group x-accepts: application/json /v3/alipay/fund/enterprisepay/member/modify: post: description: 因公付更新员工资金协议 operationId: alipay.fund.enterprisepay.member.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundEnterprisepayMemberModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundEnterprisepayMemberModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_enterprisepay_member_modify_default_response' description: 请求失败 summary: 因公付更新员工资金协议 tags: - alipay.fund.enterprisepay.member x-content-type: application/json x-accepts: application/json /v3/alipay/fund/enterprisepay/sign: post: description: 用于获取因公付企业签约链接 operationId: alipay.fund.enterprisepay.sign requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundEnterprisepaySignModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundEnterprisepaySignResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_enterprisepay_sign_default_response' description: 请求失败 summary: 因公付企业签约 tags: - alipay.fund.enterprisepay x-content-type: application/json x-accepts: application/json /v3/alipay/fund/enterprisepay/unsign: post: description: 用于因公付企业解约时获取解约链接 operationId: alipay.fund.enterprisepay.unsign requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundEnterprisepayUnsignModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundEnterprisepayUnsignResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_enterprisepay_unsign_default_response' description: 请求失败 summary: 因公付企业解约 tags: - alipay.fund.enterprisepay x-content-type: application/json x-accepts: application/json /v3/alipay/fund/jointaccount/bill/query: get: description: 因公付账单查询 operationId: alipay.fund.jointaccount.bill.query parameters: - description: 因公付产品码 explode: true in: query name: product_code required: false schema: example: ENTERPRISE_PAY type: string style: form - description: 业务场景 explode: true in: query name: biz_scene required: false schema: example: DEFAULT type: string style: form - description: 账户ID explode: true in: query name: account_id required: false schema: example: "2088900976746215" type: string style: form - description: 采用分页查询,本参数为空或0默认显示第一页。如果输入的值大于总页数,则支付宝返回最后一页数据 explode: true in: query name: page_num required: false schema: example: "1" type: string style: form - description: 每页大小,不传的情况下默认20条,超过20条默认按20条查询;不足20条则按实际记录数返回 explode: true in: query name: page_size required: false schema: example: "1" type: string style: form - description: 员工ID explode: true in: query name: user_id required: false schema: example: "2088900976746215" type: string style: form - description: 员工的openId explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form - description: 起始日期 explode: true in: query name: start_date required: false schema: example: yyyy-MM-dd type: string style: form - description: 截止日期 explode: true in: query name: end_date required: false schema: example: yyyy-MM-dd type: string style: form - description: 授权协议号 explode: true in: query name: agreement_no required: false schema: example: "2088900976746215123123" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundJointaccountBillQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_jointaccount_bill_query_default_response' description: 请求失败 summary: 因公付账单查询 tags: - alipay.fund.jointaccount.bill x-accepts: application/json /v3/alipay/fund/jointaccount/detail/query: get: description: 发起人在商户上点击查看账户详情,商户服务端进行受理,并调用支付宝进行处理。处理结果,同步返回给商户。 operationId: alipay.fund.jointaccount.detail.query parameters: - description: 销售产品码 explode: true in: query name: product_code required: false schema: example: ENTERPRISE_PAY type: string style: form - description: 业务场景码 explode: true in: query name: biz_scene required: false schema: example: DEFAULT type: string style: form - description: "合花群ID(查询方式二:通过传入account_id+agreement_no查询)
\t补充说明:
\t\ -该字段可在签约接口alipay.fund.jointaccount.sign调用后,由账户变更结果通知接口alipay.fund.jointaccount.account.completed中\ 返回。
\t-该字段可在签约接口调用后,由查询账户详情接口alipay.fund.jointaccount.detail.query中返回\ 。" explode: true in: query name: account_id required: false schema: example: 2088xxx type: string style: form - description: "授权协议号(查询方式二:通过传入account_id+agreement_no查询)
\t补充说明:
\t\ -该字段可在签约接口alipay.fund.jointaccount.sign调用后,由账户变更结果通知接口alipay.fund.jointaccount.account.completed中\ 返回。
\t-该字段可在签约接口调用后,由查询账户详情接口alipay.fund.jointaccount.detail.query中返回\ 。" explode: true in: query name: agreement_no required: false schema: example: 2088xxx type: string style: form - description: "商户侧单号(查询方式一:通过传入\tout_biz_no查询)
\t补充说明:
\t-该字段与签约接口alipay.fund.jointaccount.sign请\ 求参数中传入值保持一致" explode: true in: query name: out_biz_no required: false schema: example: 无 type: string style: form - description: "业务渠道
\t补充说明:
\t需要商户侧必传,支付宝侧不做强校验" explode: true in: query name: channel required: false schema: example: MMJZ type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundJointaccountDetailQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_jointaccount_detail_query_default_response' description: 请求失败 summary: 共享资金-查询账户详情 tags: - alipay.fund.jointaccount.detail x-accepts: application/json /v3/alipay/fund/jointaccount/list/query: get: description: 企业查询代付账户列表 operationId: alipay.fund.jointaccount.list.query parameters: - description: 产品码 explode: true in: query name: product_code required: false schema: example: ENTERPRISE_PAY type: string style: form - description: 业务场景 explode: true in: query name: biz_scene required: false schema: example: DEFAULT type: string style: form - description: 角色:创建方(CREATOR)、参与方(PARTICIPANT) explode: true in: query name: operate_role required: false schema: example: CREATOR type: string style: form - description: 授权协议号 explode: true in: query name: agreement_no required: false schema: example: "208890097674621512231" type: string style: form - description: "员工账号:\t\tidentity_type是ALIPAY_USER_ID填支付宝会员ID(2088开头);\t\t是\ ALIPAY_LOGON_ID 填支付宝登录号" explode: true in: query name: identity required: false schema: example: name@email.com type: string style: form - description: 账号类型,目前支持如下类型: 1、ALIPAY_USER_ID 支付宝的会员ID 2、ALIPAY_LOGON_ID:支付宝登录号,支持邮箱和手机号格式 explode: true in: query name: identity_type required: false schema: example: ALIPAY_LOGON_ID type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundJointaccountListQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_jointaccount_list_query_default_response' description: 请求失败 summary: 企业查询代付账户列表 tags: - alipay.fund.jointaccount.list x-accepts: application/json /v3/alipay/fund/jointaccount/member/batchquery: post: description: 企业查询员工列表,支持分页,支持按登录号精确查询,支持按会员号精确查询 operationId: alipay.fund.jointaccount.member.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundJointaccountMemberBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundJointaccountMemberBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_jointaccount_member_batchquery_default_response' description: 请求失败 summary: 企业批量查询员工信息(分页) tags: - alipay.fund.jointaccount.member x-content-type: application/json x-accepts: application/json /v3/alipay/fund/jointaccount/member/bind: post: description: 因公付邀请员工 operationId: alipay.fund.jointaccount.member.bind requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundJointaccountMemberBindModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundJointaccountMemberBindResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_jointaccount_member_bind_default_response' description: 请求失败 summary: 因公付邀请员工 tags: - alipay.fund.jointaccount.member x-content-type: application/json x-accepts: application/json /v3/alipay/fund/jointaccount/member/consult: post: description: 返回输入的员工列表是否在指定企业组织中 operationId: alipay.fund.jointaccount.member.consult requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundJointaccountMemberConsultModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundJointaccountMemberConsultResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_jointaccount_member_consult_default_response' description: 请求失败 summary: 员企关系咨询 tags: - alipay.fund.jointaccount.member x-content-type: application/json x-accepts: application/json /v3/alipay/fund/jointaccount/member/query: get: description: 企业查询员工列表 operationId: alipay.fund.jointaccount.member.query parameters: - description: 产品码 explode: true in: query name: product_code required: false schema: example: ENTERPRISE_PAY type: string style: form - description: 业务场景 explode: true in: query name: biz_scene required: false schema: example: DEFAULT type: string style: form - description: 账户ID explode: true in: query name: account_id required: false schema: example: "2088900976746215" type: string style: form - description: 采用分页查询,本参数为空或0默认显示第一页。如果输入的值大于总页数,则支付宝返回最后一页数据。 explode: true in: query name: page_num required: false schema: example: "1" type: string style: form - description: 每页大小,不传的情况下默认20条,超过20条默认按20条查询;不足20条则按实际记录数返回 explode: true in: query name: page_size required: false schema: example: "1" type: string style: form - description: 员工id explode: true in: query name: user_id required: false schema: example: "2088900976746215" type: string style: form - description: 员工的openId explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form - description: 授权协议号 explode: true in: query name: agreement_no required: false schema: example: "20889009767462151111111" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundJointaccountMemberQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_jointaccount_member_query_default_response' description: 请求失败 summary: 企业查询员工列表 tags: - alipay.fund.jointaccount.member x-accepts: application/json /v3/alipay/fund/jointaccount/member/unbind: post: description: 企业删除员工 operationId: alipay.fund.jointaccount.member.unbind requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundJointaccountMemberUnbindModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundJointaccountMemberUnbindResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_jointaccount_member_unbind_default_response' description: 请求失败 summary: 企业删除员工 tags: - alipay.fund.jointaccount.member x-content-type: application/json x-accepts: application/json /v3/alipay/fund/jointaccount/memberrule/modify: post: description: 企业设置员工规则 operationId: alipay.fund.jointaccount.memberrule.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundJointaccountMemberruleModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundJointaccountMemberruleModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_jointaccount_memberrule_modify_default_response' description: 请求失败 summary: 企业设置员工规则 tags: - alipay.fund.jointaccount.memberrule x-content-type: application/json x-accepts: application/json /v3/alipay/fund/jointaccount/quota/query: get: description: 查询账户额度详情 operationId: alipay.fund.jointaccount.quota.query parameters: - description: 产品码 explode: true in: query name: product_code required: false schema: example: ENTERPRISE_PAY type: string style: form - description: 业务场景 explode: true in: query name: biz_scene required: false schema: example: DEFAULT type: string style: form - description: 账户ID explode: true in: query name: account_id required: false schema: example: "2088900976746215" type: string style: form - description: 员工ID explode: true in: query name: member_id required: false schema: example: "2088900976746215" type: string style: form - description: 员工的openid explode: true in: query name: member_open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form - description: 角色:创建方(CREATOR)、参与方(PARTICIPANT) explode: true in: query name: operate_role required: false schema: example: CREATOR type: string style: form - description: 授权协议号 explode: true in: query name: agreement_no required: false schema: example: "208890097674621512312" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundJointaccountQuotaQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_jointaccount_quota_query_default_response' description: 请求失败 summary: 查询账户额度详情 tags: - alipay.fund.jointaccount.quota x-accepts: application/json /v3/alipay/fund/jointaccount/rule/modify: post: description: 企业账户规则设置 operationId: alipay.fund.jointaccount.rule.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundJointaccountRuleModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundJointaccountRuleModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_jointaccount_rule_modify_default_response' description: 请求失败 summary: 企业账户规则设置 tags: - alipay.fund.jointaccount.rule x-content-type: application/json x-accepts: application/json /v3/alipay/fund/jointaccount/sign/query: get: description: 通过外部订单号(out_biz_no)主动查询企业签约结果,可用于未收到签约结果通知的补偿操作 operationId: alipay.fund.jointaccount.sign.query parameters: - description: "产品码,默认值\tENTERPRISE_PAY" explode: true in: query name: product_code required: false schema: example: ENTERPRISE_PAY type: string style: form - description: 场景码,联系支付宝分配 explode: true in: query name: biz_scene required: false schema: example: ISV_ALIYUN type: string style: form - description: 外部业务号,查询对应账户状态,优先级高于account_id explode: true in: query name: out_biz_no required: false schema: example: "123123132" type: string style: form - description: "企业签约账户ID,用于外部商户已获取企业签约ID,查询账户状态" explode: true in: query name: account_id required: false schema: example: "208812312313213" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundJointaccountSignQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_jointaccount_sign_query_default_response' description: 请求失败 summary: 企业签约结果查询 tags: - alipay.fund.jointaccount.sign x-accepts: application/json /v3/alipay/fund/jointaccount/trade/query: get: description: 共同账户交易查询 operationId: alipay.fund.jointaccount.trade.query parameters: - description: 销售产品码 explode: true in: query name: product_code required: false schema: example: ENTERPRISE_PAY type: string style: form - description: 业务场景 explode: true in: query name: biz_scene required: false schema: example: ELE_ONLINE type: string style: form - description: 成员ID,消费发起人 explode: true in: query name: member_id required: false schema: example: "208811123123" type: string style: form - description: 消费发起人的openId explode: true in: query name: member_open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form - description: 企业账户ID explode: true in: query name: account_id required: false schema: example: "208811123123" type: string style: form - description: 三方授权协议号 explode: true in: query name: agreement_no required: false schema: example: "12312312313123" type: string style: form - description: 支付宝交易订单号 explode: true in: query name: trade_no required: false schema: example: "12312313123" type: string style: form - description: 外部平台订单号。使用该参数查询时,返回结果见trade_info_list explode: true in: query name: platform_order_id required: false schema: example: "781773393333012410369282" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundJointaccountTradeQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_jointaccount_trade_query_default_response' description: 请求失败 summary: 共同账户交易查询 tags: - alipay.fund.jointaccount.trade x-accepts: application/json /v3/alipay/fund/trans/common/query: get: description: 商户可通过该接口查询转账业务单据的状态,主要应用于统一转账接口(alipay.fund.trans.uni.transfer)、无线转账接口(alipay.fund.trans.app.pay)、单笔转账到支付宝账户接口(alipay.fund.trans.toaccount.transfer) operationId: alipay.fund.trans.common.query parameters: - description: "销售产品码,商家和支付宝签约的产品码,如果传递了out_biz_no则该字段为必传。可传值如下:\tSTD_RED_PACKET:\ 现金红包\tTRANS_ACCOUNT_NO_PWD:单笔无密转账到支付宝账户\tTRANS_BANKCARD_NO_PWD:单笔无密转账到银行\ 卡" explode: true in: query name: product_code required: false schema: example: STD_RED_PACKET type: string style: form - description: "描述特定的业务场景,如果传递了out_biz_no则该字段为必传。可取的业务场景如下:\r\tPERSONAL_PAY:\ C2C现金红包-发红包;\r\tPERSONAL_COLLECTION:C2C现金红包-领红包;\r\tREFUND:C2C现金红包-红包退回;\ \r\tDIRECT_TRANSFER:B2C现金红包、单笔无密转账" explode: true in: query name: biz_scene required: false schema: example: PERSONAL_PAY type: string style: form - description: "商户转账唯一订单号,发起转账来源方定义的转账单据ID。 \t本参数和order_id(支付宝转账单据号)、pay_fund_order_id(\ 支付宝支付资金流水号)三者不能同时为空。\t当三者同时传入时,将用pay_fund_order_id(支付宝支付资金流水号)进行查询,忽略其余两\ 者;\t当本参数和支付宝转账单据号同时提供时,将用支付宝转账单据号进行查询,忽略本参数。" explode: true in: query name: out_biz_no required: false schema: example: "201808080001" type: string style: form - description: "支付宝转账单据号。 本参数和out_biz_no(商户转账唯一订单号)、pay_fund_order_id(支付宝支付资\ 金流水号)三者不能同时为空。 \t当三者同时传入时,将用pay_fund_order_id(支付宝支付资金流水号)进行查询,忽略其余两者;\t当\ 本参数和pay_fund_order_id(支付宝支付资金流水号)同时提供时,将用支付宝支付资金流水号进行查询,忽略本参数; \t当本参数和out_biz_no(\ 商户转账唯一订单号)同时提供时,将用本参数进行查询,忽略商户转账唯一订单号。" explode: true in: query name: order_id required: false schema: example: "20190801110070000006380000250621" type: string style: form - description: "支付宝支付资金流水号。本参数和支付宝转账单据号、商户转账唯一订单号三者不能同时为空。 \t当本参数和out_biz_no(\ 商户转账唯一订单号)、order_id(支付宝转账单据号)同时提供时,将用本参数进行查询,忽略其余两者;\t当本参数和order_id(支付宝转\ 账单据号)同时提供时,将用本参数进行查询,忽略支付宝转账单据号; \t当本参数和out_biz_no(商户转账唯一订单号)同时提供时,将用本参数\ 进行查询,忽略商户转账唯一订单号。" explode: true in: query name: pay_fund_order_id required: false schema: example: "20190801110070001506380000251556" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundTransCommonQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_trans_common_query_default_response' description: 请求失败 summary: 转账业务单据查询接口 tags: - alipay.fund.trans.common x-accepts: application/json /v3/alipay/fund/trans/order/query: get: description: 商户可通过该接口查询转账订单的状态、支付时间等相关信息,主要应用于B2C转账订单查询的场景 operationId: alipay.fund.trans.order.query parameters: - description: "商户转账唯一订单号:发起转账来源方定义的转账单据ID。\r\t和支付宝转账单据号不能同时为空。当和支付宝转账单据号同时提\ 供时,将用支付宝转账单据号进行查询,忽略本参数。" explode: true in: query name: out_biz_no required: false schema: example: "3142321423432" type: string style: form - description: 支付宝转账单据号:和商户转账唯一订单号不能同时为空。当和商户转账唯一订单号同时提供时,将用本参数进行查询,忽略商户转账唯一订单号。 explode: true in: query name: order_id required: false schema: example: "20160627110070001502260006780837" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundTransOrderQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_trans_order_query_default_response' description: 请求失败 summary: 查询转账订单接口 tags: - alipay.fund.trans.order x-accepts: application/json /v3/alipay/fund/trans/pay: post: description: 付款方通过协议、二维码、声波、人脸等方式,通过本接口提交给支付宝直接完成支付。 operationId: alipay.fund.trans.pay requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundTransPayModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundTransPayResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_trans_pay_default_response' description: 请求失败 summary: 资金支付接口 tags: - alipay.fund.trans x-content-type: application/json x-accepts: application/json /v3/alipay/fund/trans/payee/bind/query: get: description: 资金收款账号绑定关系查询 operationId: alipay.fund.trans.payee.bind.query parameters: - description: 证件号 explode: true in: query name: identity required: false schema: example: "230100199901010001" type: string style: form - description: "证件类型,暂仅支持 IDENTITY_CARD (身份证)" explode: true in: query name: identity_type required: false schema: example: IDENTITY_CARD type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundTransPayeeBindQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_trans_payee_bind_query_default_response' description: 请求失败 summary: 资金收款账号绑定关系查询 tags: - alipay.fund.trans.payee.bind x-accepts: application/json /v3/alipay/fund/trans/refund: post: description: "当资金支付一段时间后,由于收款方一直没有收钱(比如抢红包),可以通过退款接口将资金退换给付款方。支付宝将会按照退款规则将支付\ 款按原路退到付款方帐号上。 \r\n交易超过约定时间(签约时设置的可退款时间)的订单无法进行退款。支付宝退款支持单笔交易分多次退回,多次退款需要提交\ 原支付订单的商户订单号和设置不同的退款单号。一笔退款失败后重新提交,要采用原来的退款单号。总退款金额不能超过(用户实际支付金额-已领红包)的金额。" operationId: alipay.fund.trans.refund requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundTransRefundModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundTransRefundResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_trans_refund_default_response' description: 请求失败 summary: 资金退回接口 tags: - alipay.fund.trans x-content-type: application/json x-accepts: application/json /v3/alipay/fund/trans/toaccount/transfer: post: description: |- 单笔转账到支付宝账户接口是基于支付宝的资金处理能力,为了满足支付宝商家向其他支付宝账户转账的需求,针对有部分开发能力的商家,提供通过API接口完成支付宝账户间的转账的功能。 该接口适用行业较广,比如商家间的货款结算,商家给个人用户发放佣金等。(目前已对该接口能力做了升级,后续建议调用新接口alipay.fund.trans.uni.transfer) operationId: alipay.fund.trans.toaccount.transfer requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundTransToaccountTransferModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundTransToaccountTransferResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_trans_toaccount_transfer_default_response' description: 请求失败 summary: 单笔转账到支付宝账户接口 tags: - alipay.fund.trans.toaccount x-content-type: application/json x-accepts: application/json /v3/alipay/fund/trans/uni/transfer: post: description: |- 单笔转账接口是基于支付宝的资金处理能力,为了满足支付宝商家的转账需求,针对有部分开发能力的商家,提供通过API接口完成企业自身支付宝账户到支付宝账户的转账功能。 适用于:C2C现金红包的红包领取、B2C现金红包的红包发放、B2C单笔转账到支付宝账户等。
说明:本接口为公用接口,参数说明不针对特定产品。不同产品入参请参考对应产品文档。 operationId: alipay.fund.trans.uni.transfer requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundTransUniTransferModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundTransUniTransferResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_trans_uni_transfer_default_response' description: 请求失败 summary: 单笔转账接口 tags: - alipay.fund.trans.uni x-content-type: application/json x-accepts: application/json /v3/alipay/fund/usertrade/batchquery: post: description: 资金团队会监听指定门店相关的用户交易数据,并且,在用户授权后,开放该接口给到外部调用,查询用户近期内的交易数据。 operationId: alipay.fund.usertrade.batchquery parameters: - allowEmptyValue: true description: 用户授权令牌 explode: true in: query name: auth_token required: false schema: type: string style: form requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayFundUsertradeBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayFundUsertradeBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_fund_usertrade_batchquery_default_response' description: 请求失败 summary: 用户交易数据查询 tags: - alipay.fund.usertrade x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/agent/create: post: description: 新增一个CCM客服 operationId: alipay.iservice.ccm.agent.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmAgentCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmAgentCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_agent_create_default_response' description: 请求失败 summary: 新增客服接口 tags: - alipay.iservice.ccm.agent x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/agent/delete: delete: description: 管理员删除一个客服 operationId: alipay.iservice.ccm.agent.delete parameters: - description: 客服id explode: true in: query name: id required: false schema: example: "2019032101896769" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmAgentDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_agent_delete_default_response' description: 请求失败 summary: 删除客服接口 tags: - alipay.iservice.ccm.agent x-accepts: application/json /v3/alipay/iservice/ccm/agent/get: get: description: ISV或商户查询获取某个客服的详细信息 operationId: alipay.iservice.ccm.agent.get parameters: - description: 客服id explode: true in: query name: id required: false schema: example: "2018101801902073" type: string style: form - description: 客服工号 explode: true in: query name: job_number required: false schema: example: "0001" type: string style: form - description: "客服账号渠道, ALIPAY:支付宝账号\tuser_channel和external_user_id必须配对使用" explode: true in: query name: user_channel required: false schema: example: ALIPAY type: string style: form - description: "客服账号id,当user_channel=ALIPAY时,此id为支付宝2088id\texternal_user_id和\ user_channel必须配对使用" explode: true in: query name: external_user_id required: false schema: example: 2088xxx type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmAgentGetResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_agent_get_default_response' description: 请求失败 summary: 查询客服详情 tags: - alipay.iservice.ccm.agent x-accepts: application/json /v3/alipay/iservice/ccm/agent/modify: post: description: 管理员修改客服信息 operationId: alipay.iservice.ccm.agent.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmAgentModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmAgentModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_agent_modify_default_response' description: 请求失败 summary: 更新客服接口 tags: - alipay.iservice.ccm.agent x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/agent/query: post: description: 根据指定的查询条件查询客服列表 operationId: alipay.iservice.ccm.agent.query requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmAgentQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmAgentQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_agent_query_default_response' description: 请求失败 summary: 客服查询接口 tags: - alipay.iservice.ccm.agent x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/agent/schedulelog/query: post: description: ISV或商户批量查询获取客服状态变更流水日志详细信息 operationId: alipay.iservice.ccm.agent.schedulelog.query requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmAgentSchedulelogQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmAgentSchedulelogQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_agent_schedulelog_query_default_response' description: 请求失败 summary: 查询客服状态变更流水日志 tags: - alipay.iservice.ccm.agent.schedulelog x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/function/query: get: description: 列出所有的功能点 operationId: alipay.iservice.ccm.function.query responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmFunctionQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_function_query_default_response' description: 请求失败 summary: 列出所有的功能点 tags: - alipay.iservice.ccm.function x-accepts: application/json /v3/alipay/iservice/ccm/instance/create: post: description: 创建租户实例 operationId: alipay.iservice.ccm.instance.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmInstanceCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmInstanceCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_instance_create_default_response' description: 请求失败 summary: 创建租户实例 tags: - alipay.iservice.ccm.instance x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/instance/get: get: description: 查询单个租户实例(数据权限) operationId: alipay.iservice.ccm.instance.get parameters: - description: 部门id(即租户实例ID、数据权限ID) explode: true in: query name: id required: false schema: example: pYv_gs0m type: string style: form - description: 外部id explode: true in: query name: external_id required: false schema: example: "5544744" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmInstanceGetResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_instance_get_default_response' description: 请求失败 summary: 查询单个租户实例(数据权限) tags: - alipay.iservice.ccm.instance x-accepts: application/json /v3/alipay/iservice/ccm/instance/query: get: description: 列出所有的租户实例(数据权限)。一个云客服租户下可以有多个租户实例(数据权限),每个租户实例之间的数据是隔离的(除了用户、权限、私信、IVR数据外)。 operationId: alipay.iservice.ccm.instance.query parameters: - description: 查询结果的页码,起始值为 1,默认值为 1 explode: true in: query name: page_num required: false schema: example: 1 type: integer style: form - description: 分页查询时设置的每页记录数,最大值 100 行,默认为 10 explode: true in: query name: page_size required: false schema: example: 10 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmInstanceQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_instance_query_default_response' description: 请求失败 summary: 列出所有的租户实例(数据权限) tags: - alipay.iservice.ccm.instance x-accepts: application/json /v3/alipay/iservice/ccm/isv/initialize: post: description: 商家 / ISV 开发的插件接入CCM(蚂蚁客户沟通管理平台)之前,需要先将自己的信息注册到 CCM,并设置一个用于 iframe 接口接入安全认证使用的公钥。 operationId: alipay.iservice.ccm.isv.initialize requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmIsvInitializeModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmIsvInitializeResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_isv_initialize_default_response' description: 请求失败 summary: ccm isv注册接口 tags: - alipay.iservice.ccm.isv x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/ols/chatrecord/query: get: description: ISV或商户根据在线服务记录id查询该通对话的聊天记录及相关信息 operationId: alipay.iservice.ccm.ols.chatrecord.query parameters: - description: 租户实例id(数据权限id),不填,则使用默认的租户实例id explode: true in: query name: ccs_instance_id required: false schema: example: ZPSDWACN type: string style: form - description: 在线服务记录id explode: true in: query name: id required: false schema: example: "201909021113010100000001922200" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmOlsChatrecordQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_ols_chatrecord_query_default_response' description: 请求失败 summary: 查询某通在线服务的聊天记录 tags: - alipay.iservice.ccm.ols.chatrecord x-accepts: application/json /v3/alipay/iservice/ccm/robot/avatarbase/query: post: description: 用于与数字人交互 operationId: alipay.iservice.ccm.robot.avatarbase.query requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmRobotAvatarbaseQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmRobotAvatarbaseQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_robot_avatarbase_query_default_response' description: 请求失败 summary: 虚拟数字人开放接口调用 tags: - alipay.iservice.ccm.robot.avatarbase x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/role/create: post: description: 创建角色 operationId: alipay.iservice.ccm.role.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmRoleCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmRoleCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_role_create_default_response' description: 请求失败 summary: 创建角色 tags: - alipay.iservice.ccm.role x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/role/delete: delete: description: 删除角色 operationId: alipay.iservice.ccm.role.delete parameters: - description: 角色id explode: true in: query name: id required: false schema: example: "123" type: string style: form - description: 部门id(即租户实例ID、数据权限ID),如果不传入,使用租户id explode: true in: query name: ccs_instance_id required: false schema: example: ksj_J2Qa type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmRoleDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_role_delete_default_response' description: 请求失败 summary: 删除角色 tags: - alipay.iservice.ccm.role x-accepts: application/json /v3/alipay/iservice/ccm/role/get: get: description: 获取角色详情 operationId: alipay.iservice.ccm.role.get parameters: - description: 角色id explode: true in: query name: id required: false schema: example: "123" type: string style: form - description: 部门id,不传默认用租户ID explode: true in: query name: ccs_instance_id required: false schema: example: qi1_FAq1 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmRoleGetResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_role_get_default_response' description: 请求失败 summary: 获取角色详情 tags: - alipay.iservice.ccm.role x-accepts: application/json /v3/alipay/iservice/ccm/role/modify: post: description: 更新角色 operationId: alipay.iservice.ccm.role.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmRoleModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmRoleModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_role_modify_default_response' description: 请求失败 summary: 更新角色 tags: - alipay.iservice.ccm.role x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/role/page/query: get: description: 分页查询角色 operationId: alipay.iservice.ccm.role.page.query parameters: - description: 角色名称 explode: true in: query name: name required: false schema: example: 普通客服 type: string style: form - description: 查询结果的页码,起始值为 1,默认值为 1 explode: true in: query name: page_num required: false schema: example: 1 type: integer style: form - description: 分页查询时设置的每页记录数,最大值 100 行,默认为 10 explode: true in: query name: page_size required: false schema: example: 10 type: integer style: form - description: 部门id(即租户实例ID、数据权限ID) explode: true in: query name: ccs_instance_id required: false schema: example: kaj_9DA1 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmRolePageQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_role_page_query_default_response' description: 请求失败 summary: 分页查询角色 tags: - alipay.iservice.ccm.role.page x-accepts: application/json /v3/alipay/iservice/ccm/service/buy: post: description: 租户购买了isv服务后,通知ccm开通服务 operationId: alipay.iservice.ccm.service.buy requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmServiceBuyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmServiceBuyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_service_buy_default_response' description: 请求失败 summary: 租户开通isv服务接口 tags: - alipay.iservice.ccm.service x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/service/close: post: description: 租户购买的ISV服务到期后,isv通知ccm关闭服务 operationId: alipay.iservice.ccm.service.close requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmServiceCloseModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmServiceCloseResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_service_close_default_response' description: 请求失败 summary: 关闭租户开通的isv服务接口 tags: - alipay.iservice.ccm.service x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/service/initialize: post: description: ISV调用此接口对接入CCM的服务代码、名称、描述等信息做初始化 operationId: alipay.iservice.ccm.service.initialize requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmServiceInitializeModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmServiceInitializeResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_service_initialize_default_response' description: 请求失败 summary: isv服务初始化接口 tags: - alipay.iservice.ccm.service x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/servicerecord/create: post: description: 提供给云客服租户自主创建服务记录 operationId: alipay.iservice.ccm.servicerecord.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmServicerecordCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmServicerecordCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_servicerecord_create_default_response' description: 请求失败 summary: 创建服务记录 tags: - alipay.iservice.ccm.servicerecord x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/servicerecord/modify: post: description: 提供给云客服租户自主变更服务记录 operationId: alipay.iservice.ccm.servicerecord.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmServicerecordModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmServicerecordModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_servicerecord_modify_default_response' description: 请求失败 summary: 变更服务记录 tags: - alipay.iservice.ccm.servicerecord x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/sw/article/batchquery: post: description: 知识库-问答-批量查询 operationId: alipay.iservice.ccm.sw.article.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwArticleBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwArticleBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_sw_article_batchquery_default_response' description: 请求失败 summary: 知识库-问答-批量查询 tags: - alipay.iservice.ccm.sw.article x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/sw/article/create: put: description: 知识库-问答-创建 operationId: alipay.iservice.ccm.sw.article.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwArticleCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwArticleCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_sw_article_create_default_response' description: 请求失败 summary: 知识库-问答-创建 tags: - alipay.iservice.ccm.sw.article x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/sw/article/delete: delete: description: 知识库-问答-删除 operationId: alipay.iservice.ccm.sw.article.delete responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwArticleDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_sw_article_delete_default_response' description: 请求失败 summary: 知识库-问答-删除 tags: - alipay.iservice.ccm.sw.article x-accepts: application/json /v3/alipay/iservice/ccm/sw/article/get: get: description: 知识库-问答-获取 operationId: alipay.iservice.ccm.sw.article.get parameters: - description: 子部门ID,不传为默认部门 explode: true in: query name: ccs_instance_id required: false schema: example: ZPNASDK type: string style: form - description: 文章ID explode: true in: query name: id required: false schema: example: 1 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwArticleGetResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_sw_article_get_default_response' description: 请求失败 summary: 知识库-问答-获取 tags: - alipay.iservice.ccm.sw.article x-accepts: application/json /v3/alipay/iservice/ccm/sw/article/modify: patch: description: 知识库-问答-修改 operationId: alipay.iservice.ccm.sw.article.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwArticleModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwArticleModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_sw_article_modify_default_response' description: 请求失败 summary: 知识库-问答-修改 tags: - alipay.iservice.ccm.sw.article x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/sw/knowledge/modify: post: description: 知识库问答管理 operationId: alipay.iservice.ccm.sw.knowledge.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwKnowledgeModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwKnowledgeModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_sw_knowledge_modify_default_response' description: 请求失败 summary: 知识库问答管理 tags: - alipay.iservice.ccm.sw.knowledge x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/sw/library/batchquery: get: description: 知识库-库-批量查询 operationId: alipay.iservice.ccm.sw.library.batchquery parameters: - description: 子部门ID,不传为默认部门 explode: true in: query name: ccs_instance_id required: false schema: example: ZPNASDK type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwLibraryBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_sw_library_batchquery_default_response' description: 请求失败 summary: 知识库-库-批量查询 tags: - alipay.iservice.ccm.sw.library x-accepts: application/json /v3/alipay/iservice/ccm/sw/library/create: put: description: 知识库-库-创建 operationId: alipay.iservice.ccm.sw.library.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwLibraryCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwLibraryCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_sw_library_create_default_response' description: 请求失败 summary: 知识库-库-创建 tags: - alipay.iservice.ccm.sw.library x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/sw/library/delete: delete: description: 知识库-库-删除 operationId: alipay.iservice.ccm.sw.library.delete responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwLibraryDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_sw_library_delete_default_response' description: 请求失败 summary: 知识库-库-删除 tags: - alipay.iservice.ccm.sw.library x-accepts: application/json /v3/alipay/iservice/ccm/sw/library/modify: patch: description: 知识库-库-修改 operationId: alipay.iservice.ccm.sw.library.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwLibraryModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwLibraryModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_sw_library_modify_default_response' description: 请求失败 summary: 知识库-库-修改 tags: - alipay.iservice.ccm.sw.library x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/sw/order/sync: post: description: 商品订单同步 operationId: alipay.iservice.ccm.sw.order.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwOrderSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwOrderSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_sw_order_sync_default_response' description: 请求失败 summary: 商品订单同步 tags: - alipay.iservice.ccm.sw.order x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/sw/spu/sync: post: description: 商品库-商品信息同步 operationId: alipay.iservice.ccm.sw.spu.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwSpuSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwSpuSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_sw_spu_sync_default_response' description: 请求失败 summary: 商品库-商品信息同步 tags: - alipay.iservice.ccm.sw.spu x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/sw/tree/batchquery: get: description: 知识库-类目-批量查询 operationId: alipay.iservice.ccm.sw.tree.batchquery parameters: - description: 子部门ID,不传为默认部门 explode: true in: query name: ccs_instance_id required: false schema: example: ZPNASDK type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwTreeBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_sw_tree_batchquery_default_response' description: 请求失败 summary: 知识库-类目-批量查询 tags: - alipay.iservice.ccm.sw.tree x-accepts: application/json /v3/alipay/iservice/ccm/sw/tree/create: put: description: 知识库-类目-创建 operationId: alipay.iservice.ccm.sw.tree.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwTreeCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwTreeCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_sw_tree_create_default_response' description: 请求失败 summary: 知识库-类目-创建 tags: - alipay.iservice.ccm.sw.tree x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/sw/tree/delete: delete: description: 知识库-类目-删除 operationId: alipay.iservice.ccm.sw.tree.delete responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwTreeDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_sw_tree_delete_default_response' description: 请求失败 summary: 知识库-类目-删除 tags: - alipay.iservice.ccm.sw.tree x-accepts: application/json /v3/alipay/iservice/ccm/sw/tree/get: get: description: 知识库-类目-获取 operationId: alipay.iservice.ccm.sw.tree.get parameters: - description: 子部门ID,不传为默认部门 explode: true in: query name: ccs_instance_id required: false schema: example: ZPNASDK type: string style: form - description: 类目ID explode: true in: query name: id required: false schema: example: 1 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwTreeGetResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_sw_tree_get_default_response' description: 请求失败 summary: 知识库-类目-获取 tags: - alipay.iservice.ccm.sw.tree x-accepts: application/json /v3/alipay/iservice/ccm/sw/tree/modify: patch: description: 知识库-类目-修改 operationId: alipay.iservice.ccm.sw.tree.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwTreeModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwTreeModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_sw_tree_modify_default_response' description: 请求失败 summary: 知识库-类目-修改 tags: - alipay.iservice.ccm.sw.tree x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/sw/tree/publish: put: description: 知识库-类目-发布 operationId: alipay.iservice.ccm.sw.tree.publish requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwTreePublishModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwTreePublishResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_sw_tree_publish_default_response' description: 请求失败 summary: 知识库-类目-发布 tags: - alipay.iservice.ccm.sw.tree x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/sw/treecategory/batchquery: get: description: 知识库-节点-批量查询 operationId: alipay.iservice.ccm.sw.treecategory.batchquery parameters: - description: 子部门ID,不传为默认部门 explode: true in: query name: ccs_instance_id required: false schema: example: ZPNASDK type: string style: form - description: 知识库ID explode: true in: query name: library_id required: false schema: example: 1 type: integer style: form - description: 节点名称 explode: true in: query name: name required: false schema: example: 服务群 type: string style: form - description: 页数,page_size不能为空 explode: true in: query name: page_num required: false schema: example: 1 type: integer style: form - description: 页显示大小,page_num不能为空 explode: true in: query name: page_size required: false schema: example: 10 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwTreecategoryBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_sw_treecategory_batchquery_default_response' description: 请求失败 summary: 知识库-节点-批量查询 tags: - alipay.iservice.ccm.sw.treecategory x-accepts: application/json /v3/alipay/iservice/ccm/sw/treecategory/create: put: description: 知识库-节点-创建 operationId: alipay.iservice.ccm.sw.treecategory.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwTreecategoryCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwTreecategoryCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_sw_treecategory_create_default_response' description: 请求失败 summary: 知识库-节点-创建 tags: - alipay.iservice.ccm.sw.treecategory x-content-type: application/json x-accepts: application/json /v3/alipay/iservice/ccm/sw/treecategory/delete: delete: description: 知识库-节点-删除 operationId: alipay.iservice.ccm.sw.treecategory.delete responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwTreecategoryDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_sw_treecategory_delete_default_response' description: 请求失败 summary: 知识库-节点-删除 tags: - alipay.iservice.ccm.sw.treecategory x-accepts: application/json /v3/alipay/iservice/ccm/sw/treecategory/modify: patch: description: 知识库-节点-修改 operationId: alipay.iservice.ccm.sw.treecategory.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwTreecategoryModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayIserviceCcmSwTreecategoryModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_iservice_ccm_sw_treecategory_modify_default_response' description: 请求失败 summary: 知识库-节点-修改 tags: - alipay.iservice.ccm.sw.treecategory x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/activity/batchquery: post: description: 通过此接口可查询多个活动的摘要信息。 operationId: alipay.marketing.activity.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_batchquery_default_response' description: 请求失败 summary: 条件查询活动列表 tags: - alipay.marketing.activity x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/activity/consult: post: description: 通过此接口可以咨询用户是否可以领取该活动优惠券,决定是否对用户展示该活动信息。 operationId: alipay.marketing.activity.consult requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityConsultModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityConsultResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_consult_default_response' description: 请求失败 summary: 活动领取咨询接口 tags: - alipay.marketing.activity x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/activity/deliverychannel/query: post: description: |- 查询可推广渠道。该接口会返回可以投放的所有渠道的详细信息。 其中每个渠道的boothCode含义:boothCode表达的是某个渠道可以投放的展位码。例如:支付结果页PAY_RESULT 其中每个渠道的channel含义:表达的是某个固定的渠道。例如:在boothCode = PAY_RESULT 的情况下, channel = 商户的pid。 该channel就是一个可以投放的渠道,投放后可以在对应的商户的支付结果页看到优惠券。后续创建投放时根据返回的 channel 选择投放渠道 operationId: alipay.marketing.activity.deliverychannel.query requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityDeliverychannelQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityDeliverychannelQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_deliverychannel_query_default_response' description: 请求失败 summary: 查询可推广渠道 tags: - alipay.marketing.activity.deliverychannel x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/activity/ordervoucher/associate: post: description: | 将已发放的商家券券码与订单信息关联,用于后续参与返佣激励等操作的统计。 operationId: alipay.marketing.activity.ordervoucher.associate requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherAssociateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherAssociateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_ordervoucher_associate_default_response' description: 请求失败 summary: 关联订单信息 tags: - alipay.marketing.activity.ordervoucher x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/activity/ordervoucher/disassociate: post: description: 取消商家券与订单信息的关联关系. operationId: alipay.marketing.activity.ordervoucher.disassociate requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherDisassociateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherDisassociateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_ordervoucher_disassociate_default_response' description: 请求失败 summary: 取消关联订单信息 tags: - alipay.marketing.activity.ordervoucher x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/activity/ordervoucher/query: get: description: 商户通过该接口查询商家券活动详情。 operationId: alipay.marketing.activity.ordervoucher.query parameters: - description: 活动id explode: true in: query name: activity_id required: false schema: example: "2016042700826004508401111111" type: string style: form - description: 商户接入模式 explode: true in: query name: merchant_access_mode required: false schema: example: AGENCY_MODE type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_ordervoucher_query_default_response' description: 请求失败 summary: 查询商家券活动 tags: - alipay.marketing.activity.ordervoucher x-accepts: application/json /v3/alipay/marketing/activity/ordervoucher/user/batchqueryvoucher: get: description: 可通过该接口查询用户在某商户可用的全部券,可用于商户的小程序/H5中,用户"我的优惠券"或"提交订单页"展示优惠信息。只能查询商户配的券,无法查询平台优惠券。 operationId: alipay.marketing.activity.user.batchqueryvoucher parameters: - allowEmptyValue: true description: 用户授权令牌 explode: true in: query name: auth_token required: false schema: type: string style: form - description: 支付宝用户 id explode: true in: query name: user_id required: false schema: example: "2088512417841101" type: string style: form - description: 支付宝用户openId explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form - description: 活动 id explode: true in: query name: activity_id required: false schema: example: "2016042700826004508401111111" type: string style: form - description: 券归属商户 explode: true in: query name: belong_merchant_id required: false schema: example: "2088202967380463" type: string style: form - description: 券发放商户 explode: true in: query name: sender_merchant_id required: false schema: example: "2088102161342862" type: string style: form - description: 券状态,其中已过期状态可查询6个月内的数据 explode: true in: query name: voucher_status required: false schema: example: SENDED type: string style: form - description: 分页查询页码 explode: true in: query name: page_num required: false schema: example: 1 type: integer style: form - description: 商户接入模式 explode: true in: query name: merchant_access_mode required: false schema: example: AGENCY_MODE type: string style: form - description: 分页查询单页数据条数 explode: true in: query name: page_size required: false schema: example: 20 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityUserBatchqueryvoucherResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_user_batchqueryvoucher_default_response' description: 请求失败 summary: 条件查询用户券 tags: - alipay.marketing.activity.user x-accepts: application/json /v3/alipay/marketing/activity/ordervoucher/user/voucher: get: description: 通过此接口可以查询用户券信息,包括用户券的基础信息、状态。 operationId: alipay.marketing.activity.user.queryvoucher parameters: - description: 商户 PID,默认为当前接口调用商户。 explode: true in: query name: merchant_id required: false schema: example: "2088202967380463" type: string style: form - description: 支付宝user_id账号 explode: true in: query name: user_id required: false schema: example: "2088512417841101" type: string style: form - description: 领券的支付宝用户openId explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form - description: 活动id explode: true in: query name: activity_id required: false schema: example: "2016042700826004508401111111" type: string style: form - description: 用户券 id。支付宝为用户优惠券唯一分配的 id。 explode: true in: query name: voucher_id required: false schema: example: 2021072900073002214009F8QHR3 type: string style: form - description: 用户领取的商家券券码。 explode: true in: query name: voucher_code required: false schema: example: ABE44 type: string style: form - description: 商户接入模式。 explode: true in: query name: merchant_access_mode required: false schema: example: AGENCY_MODE type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityUserQueryvoucherResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_user_queryvoucher_default_response' description: 请求失败 summary: 查询用户券详情 tags: - alipay.marketing.activity.user x-accepts: application/json /v3/alipay/marketing/activity/voucher/append: post: description: |- 支付券激活成功后,调用该接口追加支付券预算。追加支付券预算接口同步返回请求受理结果,后续通过alipay.marketing.activity.message.appended消息接口异步发送追加支付券预算成功事件消息。 如果成功消息长时间未送达,请联系相关技术人员。 operationId: alipay.marketing.activity.voucher.append requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityVoucherAppendModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityVoucherAppendResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_voucher_append_default_response' description: 请求失败 summary: 追加支付券预算 tags: - alipay.marketing.activity.voucher x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/activity/voucher/create: post: description: 商户通过调用此接口创建支付券,包括预充值&免充值支付券,接口同步返回创建处理结果。创建完成后将获得活动id,可用于各个营销场景的活动投放。 operationId: alipay.marketing.activity.voucher.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityVoucherCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityVoucherCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_voucher_create_default_response' description: 请求失败 summary: 创建支付券 tags: - alipay.marketing.activity.voucher x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/activity/voucher/modify: post: description: "商户可以通过该接口修改支付券基本信息。 接口同步返回修改请求受理结果,后续通过alipay.marketing.activity.message.modified消\ 息接口异步发送修改活动成功事件消息。 \n\n特别注意:修改支付券接口返回结果并不代表活动修改成功,必须等待消息回调后才能确保成功。 如果成功消息长\ 时间未送达,请联系相关技术人员。" operationId: alipay.marketing.activity.voucher.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityVoucherModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityVoucherModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_voucher_modify_default_response' description: 请求失败 summary: 修改支付券基本信息 tags: - alipay.marketing.activity.voucher x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/activity/voucher/publish: post: description: | 支付券创建成功后,通过调用此接口激活支付券。 激活支付券接口同步返回请求受理结果,后续通过alipay.marketing.activity.message.created消息接口异步发送激活支付券成功事件消息。 如果成功消息长时间未送达,请联系相关技术人员。 operationId: alipay.marketing.activity.voucher.publish requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityVoucherPublishModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityVoucherPublishResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_voucher_publish_default_response' description: 请求失败 summary: 激活支付券 tags: - alipay.marketing.activity.voucher x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/activity/voucher/query: get: description: 通过此接口可查询支付券活动信息,包括活动的配置信息以及活动概况数据。 operationId: alipay.marketing.activity.voucher.query parameters: - description: 活动id explode: true in: query name: activity_id required: false schema: example: "2016042700826004508401111111" type: string style: form - description: 商户接入模式。 explode: true in: query name: merchant_access_mode required: false schema: example: AGENCY_MODE type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityVoucherQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_voucher_query_default_response' description: 请求失败 summary: 查询支付券详情 tags: - alipay.marketing.activity.voucher x-accepts: application/json /v3/alipay/marketing/activity/voucher/send: post: description: API完成制券后,可使用发放支付券接口发券。通过调用此接口可发放支付券给指定用户,发券场景可以是小程序、H5、APP等。 operationId: alipay.marketing.activity.voucher.send requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityVoucherSendModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityVoucherSendResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_voucher_send_default_response' description: 请求失败 summary: 发放支付券 tags: - alipay.marketing.activity.voucher x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/activity/voucher/stop: post: description: 商家调用该接口停止支付券。 停止支付券接口同步返回请求受理结果,后续通过alipay.marketing.activity.message.stopped消息接口异步发送停止活动成功事件。 如果成功消息长时间未送达,请联系相关技术人员。 operationId: alipay.marketing.activity.voucher.stop requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityVoucherStopModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityVoucherStopResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_voucher_stop_default_response' description: 请求失败 summary: 停止支付券 tags: - alipay.marketing.activity.voucher x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/activity/voucherpackage/batchquery: post: description: 券包批量查询 operationId: alipay.marketing.activity.voucherpackage.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityVoucherpackageBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityVoucherpackageBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_voucherpackage_batchquery_default_response' description: 请求失败 summary: 券包批量查询 tags: - alipay.marketing.activity.voucherpackage x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/activity/voucherpackage/consult: post: description: 券包购买咨询,咨询当前用户是否可以购买指定的券包 operationId: alipay.marketing.activity.voucherpackage.consult parameters: - allowEmptyValue: true description: 用户授权令牌 explode: true in: query name: auth_token required: false schema: type: string style: form requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityVoucherpackageConsultModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityVoucherpackageConsultResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_voucherpackage_consult_default_response' description: 请求失败 summary: 券包购买咨询 tags: - alipay.marketing.activity.voucherpackage x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/activity/voucherpackage/query: get: description: 查询券包详情,包括券包信息和券包下面券信息 operationId: alipay.marketing.activity.voucherpackage.query parameters: - description: 券包id explode: true in: query name: voucher_package_id required: false schema: example: IP20220628016671405804297103167741 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityVoucherpackageQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_voucherpackage_query_default_response' description: 请求失败 summary: 券包详情查询 tags: - alipay.marketing.activity.voucherpackage x-accepts: application/json /v3/alipay/marketing/activity/{activity_id}: get: description: 通过此接口可以查询活动详情,包括支付券和商家券活动。 operationId: alipay.marketing.activity.query parameters: - description: 活动id explode: false in: path name: activity_id required: true schema: example: "2016042700826004508401111111" type: string style: simple - description: "商户PID,默认为当前接口调用商户。" explode: true in: query name: merchant_id required: false schema: example: "2088202967380463" type: string style: form - description: 商户接入模式。 explode: true in: query name: merchant_access_mode required: false schema: example: AGENCY_MODE type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_query_default_response' description: 请求失败 summary: 查询活动详情 tags: - alipay.marketing.activity x-accepts: application/json /v3/alipay/marketing/activity/{activity_id}/app/batchquery: get: description: "通过此接口可查询活动的可用小程序,判断活动是否在该小程序可用,来决定是否展示。" operationId: alipay.marketing.activity.app.batchquery parameters: - description: "商户PID,默认为当前接口调用商户 \t限制: \t接口调用者必须有商户代运营权限。 \t代运营授权流程" explode: true in: query name: merchant_id required: false schema: example: "2088202967380463" type: string style: form - description: 活动id explode: false in: path name: activity_id required: true schema: example: "2016042700826004508401111111" type: string style: simple - description: "分页查询页码。 \t限制:\t必须为大于0的整数" explode: true in: query name: page_num required: false schema: example: 1 type: integer style: form - description: "分页查询单页数据条数。 \t限制: \t1.必须为大于0的整数 \t2.每页最大值为20" explode: true in: query name: page_size required: false schema: example: "20" type: string style: form - description: 商户接入模式 explode: true in: query name: merchant_access_mode required: false schema: example: AGENCY_MODE type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityAppBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_app_batchquery_default_response' description: 请求失败 summary: 查询活动可用小程序 tags: - alipay.marketing.activity.app x-accepts: application/json /v3/alipay/marketing/activity/{activity_id}/goods/batchquery: get: description: "通过此接口可查询活动的可用或不可用商品,判断是否在该商品可用,来决定是否展示。" operationId: alipay.marketing.activity.goods.batchquery parameters: - description: "商户PID,默认为当前接口调用商户。" explode: true in: query name: merchant_id required: false schema: example: "2088202967380463" type: string style: form - description: 活动id explode: false in: path name: activity_id required: true schema: example: "2016042700826004508401111111" type: string style: simple - description: 活动单品类型。 explode: true in: query name: goods_use_type required: false schema: example: AVAILABLE type: string style: form - description: "分页查询页码。\t限制:\t必须为大于0的整数" explode: true in: query name: page_num required: false schema: example: 1 type: integer style: form - description: "分页查询单页数据条数。\t限制:\t1.必须为大于0的整数\t2.每页最大值为20" explode: true in: query name: page_size required: false schema: example: 20 type: integer style: form - description: "版本号\t\t枚举值:\t2.0.0" explode: true in: query name: product_version required: false schema: example: 2.0.0 type: string style: form - description: 商户接入模式 explode: true in: query name: merchant_access_mode required: false schema: example: AGENCY_MODE type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityGoodsBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_goods_batchquery_default_response' description: 请求失败 summary: 查询活动适用商品 tags: - alipay.marketing.activity.goods x-accepts: application/json /v3/alipay/marketing/activity/{activity_id}/merchant/batchquery: get: description: "通过此接口可查询活动的可用商户,判断活动是否在某商户可用,来决定是否展示。" operationId: alipay.marketing.activity.merchant.batchquery parameters: - description: "商户PID,默认为当前接口调用商户。" explode: true in: query name: merchant_id required: false schema: example: "2088202967380463" type: string style: form - description: 活动id explode: false in: path name: activity_id required: true schema: example: "2016042700826004508401111111" type: string style: simple - description: "分页查询页码。 \t限制: \t必须为大于0的整数" explode: true in: query name: page_num required: false schema: example: 1 type: integer style: form - description: "分页查询单页数据条数。 \t限制: \t1.必须为大于0的整数 \t2.每页最大值为20" explode: true in: query name: page_size required: false schema: example: 20 type: integer style: form - description: 商户接入模式 explode: true in: query name: merchant_access_mode required: false schema: example: AGENCY_MODE type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityMerchantBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_merchant_batchquery_default_response' description: 请求失败 summary: 查询活动可用商户 tags: - alipay.marketing.activity.merchant x-accepts: application/json /v3/alipay/marketing/activity/{activity_id}/shop/batchquery: get: description: 通过此接口可查询活动的可用门店,判断券是否在某门店可用,来决定是否展示。 operationId: alipay.marketing.activity.shop.batchquery parameters: - description: "商户PID,默认为当前接口调用商户。" explode: true in: query name: merchant_id required: false schema: example: "2088202967380463" type: string style: form - description: 活动id explode: false in: path name: activity_id required: true schema: example: "2016042700826004508401111111" type: string style: simple - description: "分页查询页码。 \t限制: \t必须为大于0的整数" explode: true in: query name: page_num required: false schema: example: 1 type: integer style: form - description: "分页查询单页数据条数。 \t限制: \t1.必须为大于0的整数 \t2.每页最大值为20" explode: true in: query name: page_size required: false schema: example: 20 type: integer style: form - description: "版本号\t\t枚举值:\t2.0.0" explode: true in: query name: product_version required: false schema: example: 2.0.0 type: string style: form - description: 商户接入模式 explode: true in: query name: merchant_access_mode required: false schema: example: AGENCY_MODE type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityShopBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_shop_batchquery_default_response' description: 请求失败 summary: 查询活动可用门店 tags: - alipay.marketing.activity.shop x-accepts: application/json /v3/alipay/marketing/campaign/cash/create: post: description: 商户通过开放平台创建商户活动 operationId: alipay.marketing.campaign.cash.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCampaignCashCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCampaignCashCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_campaign_cash_create_default_response' description: 请求失败 summary: 创建现金活动 tags: - alipay.marketing.campaign.cash x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/campaign/cash/detail/query: get: description: 商户通过开放平台查询自己创建的现金活动详情 operationId: alipay.marketing.campaign.cash.detail.query parameters: - description: 现金活动号,通过alipay.marketing.campaign.cash.create(创建现金活动)接口创建现金活动获取。 explode: true in: query name: crowd_no required: false schema: example: POYb84lfiKVdIfERAYsqPL_KQRIpfQbl47xfRmmPBlDMnSZ96O-zxUfKlHp5cxmx type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCampaignCashDetailQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_campaign_cash_detail_query_default_response' description: 请求失败 summary: 现金活动详情查询 tags: - alipay.marketing.campaign.cash.detail x-accepts: application/json /v3/alipay/marketing/campaign/cash/list/query: get: description: 商户通过开放平台查询自己创建的现金活动列表 operationId: alipay.marketing.campaign.cash.list.query parameters: - description: "要查询的活动状态,不填默认为 ALL 返回所有类型。枚举支持:\t*ALL:所有类型的活动。\t*CREATED:已创建\ 未打款。\t*PAID:已打款。\t*READY:活动已开始。\t*PAUSE:活动已暂停。\t*CLOSED:活动已结束。\t*SETTLE:\ 活动已清算。" explode: true in: query name: camp_status required: false schema: example: PAID type: string style: form - description: 分页查询时每页返回的列表大小,每页数据最大为 50。 explode: true in: query name: page_size required: false schema: example: "10" type: string style: form - description: 分页查询时的页码,从1开始 explode: true in: query name: page_index required: false schema: example: "1" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCampaignCashListQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_campaign_cash_list_query_default_response' description: 请求失败 summary: 现金活动列表查询 tags: - alipay.marketing.campaign.cash.list x-accepts: application/json /v3/alipay/marketing/campaign/cash/status/modify: post: description: 商户更改现金活动状态,启动/暂停/终止 operationId: alipay.marketing.campaign.cash.status.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCampaignCashStatusModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCampaignCashStatusModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_campaign_cash_status_modify_default_response' description: 请求失败 summary: 更改现金活动状态 tags: - alipay.marketing.campaign.cash.status x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/campaign/cash/trigger: post: description: 用户通过开放平台参与现金活动 operationId: alipay.marketing.campaign.cash.trigger requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCampaignCashTriggerModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCampaignCashTriggerResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_campaign_cash_trigger_default_response' description: 请求失败 summary: 触发现金红包活动 tags: - alipay.marketing.campaign.cash x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/campaign/order/voucher/consult: post: description: 本接口用于前置优惠咨询,包括本订单可享的优惠券列表,注意该列表并不等价于最终核销时使用的券列表,而是包含了咨询的那一刻该订单能用的所有券,且券满足叠加使用下的互斥等规则 operationId: alipay.marketing.campaign.order.voucher.consult parameters: - allowEmptyValue: true description: 用户授权令牌 explode: true in: query name: auth_token required: false schema: type: string style: form requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCampaignOrderVoucherConsultModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCampaignOrderVoucherConsultResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_campaign_order_voucher_consult_default_response' description: 请求失败 summary: 订单优惠前置咨询 tags: - alipay.marketing.campaign.order.voucher x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/card/activateform/query: get: description: 会员卡开卡场景下,用户确认领卡后,跳转到商户开卡处理页面,商户通过该接口查询用户表单信息。 operationId: alipay.marketing.card.activateform.query parameters: - allowEmptyValue: true description: 用户授权令牌 explode: true in: query name: auth_token required: false schema: type: string style: form - description: 开放表单信息查询业务类型 explode: true in: query name: biz_type required: false schema: example: MEMBER_CARD type: string style: form - description: 会员卡模板id。使用会员卡模板创建接口(alipay.marketing.card.template.create)返回的结果 explode: true in: query name: template_id required: false schema: example: "2071828288283883" type: string style: form - description: "查询用户表单提交信息的请求id。\t\t网页移动应用&小程序应用:与auth_code 一起通过alipay.marketing.card.activateurl.apply(获\ 取会员卡领卡投放链接)接口callback地址回传。\t\t注意:auth_code(用户授权码)用于换取用户授权令牌 accessToken,\ 后续调用接口需传入accessToken。" explode: true in: query name: request_id required: false schema: example: "2017021929993993992839493394" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardActivateformQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_card_activateform_query_default_response' description: 请求失败 summary: 查询用户提交的会员卡表单信息 tags: - alipay.marketing.card.activateform x-accepts: application/json /v3/alipay/marketing/card/activateurl/apply: post: description: 会员卡开卡业务,开发者通过该接口获取用户开卡链接,用于会员卡投放。 operationId: alipay.marketing.card.activateurl.apply requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardActivateurlApplyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardActivateurlApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_card_activateurl_apply_default_response' description: 请求失败 summary: 获取会员卡领卡投放链接 tags: - alipay.marketing.card.activateurl x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/card/benefit/create: post: description: 会员卡模板外部权益创建,创建的权益内容信息将展示在卡包中卡详情页中部区域。 operationId: alipay.marketing.card.benefit.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardBenefitCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardBenefitCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_card_benefit_create_default_response' description: 请求失败 summary: 会员卡模板外部权益创建 tags: - alipay.marketing.card.benefit x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/card/benefit/delete: delete: description: 会员卡模板外部权益删除 operationId: alipay.marketing.card.benefit.delete parameters: - description: 会员卡模板ID,通过 alipay.marketing.card.template.create(会员卡模板创建)接口创建会员卡模板获取。 explode: true in: query name: template_id required: false schema: example: "20170322000000000068101000300041" type: string style: form - description: 权益ID,通过 alipay.marketing.card.benefit.create(会员卡模板外部权益创建)接口创建获取。 explode: true in: query name: benefit_id required: false schema: example: "20170322000000000068101000300041" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardBenefitDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_card_benefit_delete_default_response' description: 请求失败 summary: 会员卡模板外部权益删除 tags: - alipay.marketing.card.benefit x-accepts: application/json /v3/alipay/marketing/card/benefit/modify: post: description: 会员卡模板外部权益修改 operationId: alipay.marketing.card.benefit.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardBenefitModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardBenefitModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_card_benefit_modify_default_response' description: 请求失败 summary: 会员卡模板外部权益修改 tags: - alipay.marketing.card.benefit x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/card/benefit/query: get: description: 会员卡模板外部权益查询 operationId: alipay.marketing.card.benefit.query parameters: - description: 会员卡模板ID,通过 alipay.marketing.card.template.create(会员卡模板创建)接口创建会员卡模板获取。 explode: true in: query name: template_id required: false schema: example: "20170322000000000068101000300041" type: string style: form - description: 权益ID,通过 alipay.marketing.card.benefit.create(会员卡模板外部权益创建)接口创建获取。 explode: true in: query name: benefit_id required: false schema: example: "20170322000000000068101000300041" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardBenefitQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_card_benefit_query_default_response' description: 请求失败 summary: 会员卡模板外部权益查询 tags: - alipay.marketing.card.benefit x-accepts: application/json /v3/alipay/marketing/card/consume/sync: post: description: 会员卡消费记录同步 operationId: alipay.marketing.card.consume.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardConsumeSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardConsumeSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_card_consume_sync_default_response' description: 请求失败 summary: 会员卡消费记录同步 tags: - alipay.marketing.card.consume x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/card/delete: delete: description: 通过 API 接口删除商家会员卡。 operationId: alipay.marketing.card.delete parameters: - description: 商户端删卡业务流水号,商户自定义且需确保流水号唯一性。 explode: true in: query name: out_serial_no required: false schema: example: "2016062700001" type: string style: form - description: 支付宝业务卡号。即开卡接口返回结果中的card_info.biz_card_no。 explode: true in: query name: target_card_no required: false schema: example: "0000001" type: string style: form - description: 卡号ID类型 explode: true in: query name: target_card_no_type required: false schema: example: BIZ_CARD type: string style: form - description: "删卡原因\t\tUSER_UNBUND:用户解绑(可以重新绑定)\t\tCANCEL:销户(完成销户后,就不能再重新绑定\ )\t\tPRESENT:转赠(可以重新绑定)" explode: true in: query name: reason_code required: false schema: example: USER_UNBUND type: string style: form - description: "删卡扩展参数,json格式。\t\t用于商户的特定业务信息的传递,只有商户与支付宝约定了传递此参数且约定了参数含义,此参\ 数才有效。\t\t目前支持如下key:\t\tnew_card_no:新卡号\t\tdonee_user_id:受赠人userId" explode: true in: query name: ext_info required: false schema: example: "{\"new_card_no\":\"12345\",\" donee_user_id\":\"2088102130652460\"\ }" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_card_delete_default_response' description: 请求失败 summary: 会员卡删卡 tags: - alipay.marketing.card x-accepts: application/json /v3/alipay/marketing/card/formtemplate/set: post: description: 会员卡开卡、用户授权确认 operationId: alipay.marketing.card.formtemplate.set requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardFormtemplateSetModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardFormtemplateSetResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_card_formtemplate_set_default_response' description: 请求失败 summary: 会员卡开卡表单模板配置 tags: - alipay.marketing.card.formtemplate x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/card/message/notify: post: description: 商户触发消息通知用户 operationId: alipay.marketing.card.message.notify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardMessageNotifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardMessageNotifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_card_message_notify_default_response' description: 请求失败 summary: 会员卡消息通知 tags: - alipay.marketing.card.message x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/card/open: post: description: 商户通过API接口,进行会员卡开卡。 operationId: alipay.marketing.card.open parameters: - allowEmptyValue: true description: 用户授权令牌 explode: true in: query name: auth_token required: false schema: type: string style: form requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardOpenModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardOpenResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_card_open_default_response' description: 请求失败 summary: 会员卡开卡 tags: - alipay.marketing.card x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/card/query: post: description: 根据卡号或者持卡人信息查询会员卡信息 operationId: alipay.marketing.card.query requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_card_query_default_response' description: 请求失败 summary: 会员卡查询 tags: - alipay.marketing.card x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/card/template/batchquery: post: description: 会员卡模板批量查询 operationId: alipay.marketing.card.template.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardTemplateBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardTemplateBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_card_template_batchquery_default_response' description: 请求失败 summary: 会员卡模板批量查询 tags: - alipay.marketing.card.template x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/card/template/create: post: description: 会员卡模板创建 operationId: alipay.marketing.card.template.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardTemplateCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardTemplateCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_card_template_create_default_response' description: 请求失败 summary: 会员卡模板创建 tags: - alipay.marketing.card.template x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/card/template/modify: post: description: 会员卡模板修改 operationId: alipay.marketing.card.template.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardTemplateModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardTemplateModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_card_template_modify_default_response' description: 请求失败 summary: 会员卡模板修改 tags: - alipay.marketing.card.template x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/card/template/query: get: description: 会员卡模板查询接口 operationId: alipay.marketing.card.template.query parameters: - description: 会员卡模板id。调用alipay.marketing.card.template.create(会员卡模板创建接口)创建模板后同步返回。 explode: true in: query name: template_id required: false schema: example: "20160718000000001" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardTemplateQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_card_template_query_default_response' description: 请求失败 summary: 会员卡模板查询接口 tags: - alipay.marketing.card.template x-accepts: application/json /v3/alipay/marketing/card/update: post: description: 会员卡更新 operationId: alipay.marketing.card.update requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardUpdateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingCardUpdateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_card_update_default_response' description: 请求失败 summary: 会员卡更新 tags: - alipay.marketing.card x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/delivery: post: description: 为商家提供推广内容能力。创建推广成功后,请依据推广变更消息alipay.marketing.activity.delivery.message感知推广变更状态。 operationId: alipay.marketing.activity.delivery.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityDeliveryCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityDeliveryCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_delivery_create_default_response' description: 请求失败 summary: 创建推广计划 tags: - alipay.marketing.activity.delivery x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/delivery/{delivery_id}/query: post: description: 查询推广计划详情信息。 operationId: alipay.marketing.activity.delivery.query parameters: - description: 推广计划id explode: false in: path name: delivery_id required: true schema: example: "20121231231242353" type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityDeliveryQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityDeliveryQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_delivery_query_default_response' description: 请求失败 summary: 查询推广计划 tags: - alipay.marketing.activity.delivery x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/delivery/{delivery_id}/stop: patch: description: "停止推广计划。 \n注意:停止推广操作成功到推广内容停止生效,可能存在几分钟的延迟。" operationId: alipay.marketing.activity.delivery.stop parameters: - description: 推广计划id explode: false in: path name: delivery_id required: true schema: example: "20121231231242353" type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityDeliveryStopModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityDeliveryStopResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_delivery_stop_default_response' description: 请求失败 summary: 停止推广计划 tags: - alipay.marketing.activity.delivery x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/material/create: post: description: 用于创建支付宝素材 operationId: alipay.marketing.material.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingMaterialCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingMaterialCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_material_create_default_response' description: 请求失败 summary: 创建支付宝素材 tags: - alipay.marketing.material x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/material/image: post: description: 营销通用上传图片接口 operationId: alipay.marketing.material.image.upload requestBody: content: multipart/form-data: encoding: file_content: contentType: '*/*' style: form data: contentType: application/json style: form schema: $ref: '#/components/schemas/alipay_marketing_material_image_upload_request' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingMaterialImageUploadResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_material_image_upload_default_response' description: 请求失败 summary: 营销图片资源上传接口 tags: - alipay.marketing.material.image x-content-type: multipart/form-data x-accepts: application/json /v3/alipay/marketing/ordervoucher/activity: post: description: |- 商家调用该接口创建商家券活动。 创建商家券活动接口同步返回创建请求受理结果,后续通过alipay.marketing.activity.message.created消息接口异步发送活动创建成功事件消息。 如果在code_mode=MERCHANT_UPLOAD的模式下,创建商家券活动后,还需要进行券码导入操作,以及预算追加操作,然后商家券才能进行发放。 operationId: alipay.marketing.activity.ordervoucher.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_ordervoucher_create_default_response' description: 请求失败 summary: 创建商家券活动 tags: - alipay.marketing.activity.ordervoucher x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/ordervoucher/activity/{activity_id}: patch: description: |- 商家调用该接口修改商家券活动基本信息。 修改商家券活动基本信息接口同步返回修改请求受理结果,后续通过alipay.marketing.activity.message.modified消息接口异步发送修改活动成功事件消息。 operationId: alipay.marketing.activity.ordervoucher.modify parameters: - description: 活动id1 explode: false in: path name: activity_id required: true schema: example: "2016042700826004508401111111" type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_ordervoucher_modify_default_response' description: 请求失败 summary: 修改商家券活动基本信息 tags: - alipay.marketing.activity.ordervoucher x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/ordervoucher/activity/{activity_id}/append: patch: description: |- 商家调用该接口修改商家券活动预算上限,以此来追加商家券活动预算。 修改商家券活动预算上限同步返回追加请求受理结果,后续通过alipay.marketing.activity.message.appended消息接口异步发送发券数量上限修改成功事件消息。 code_mode=MERCHANT_UPLOAD场景下,必须先导入券码后,方可追加商家券预算。 operationId: alipay.marketing.activity.ordervoucher.append parameters: - description: 活动id explode: false in: path name: activity_id required: true schema: example: "2016042700826004508401111111" type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherAppendModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherAppendResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_ordervoucher_append_default_response' description: 请求失败 summary: 修改商家券活动发券数量上限 tags: - alipay.marketing.activity.ordervoucher x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/ordervoucher/activity/{activity_id}/stop: patch: description: |- 商家调用该接口停止优惠券。 停止优惠券接口同步返回停止请求受理结果,后续通过alipay.marketing.activity.message.stopped消息接口异步发送停止活动成功事件。 如果成功消息长时间未送达,请联系相关技术人员。 operationId: alipay.marketing.activity.ordervoucher.stop parameters: - description: 活动id explode: false in: path name: activity_id required: true schema: example: "2016042700826004508401111111" type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherStopModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherStopResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_ordervoucher_stop_default_response' description: 请求失败 summary: 停止商家券活动 tags: - alipay.marketing.activity.ordervoucher x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/ordervoucher/activity/{activity_id}/voucher/codecount: get: description: 商家调用该接口查询活动中的有效券码个数。接口同步返回查询结果。 operationId: alipay.marketing.activity.ordervoucher.codecount parameters: - description: 活动id explode: false in: path name: activity_id required: true schema: example: "2016042700826004508401111111" type: string style: simple - description: 商户接入模式 explode: true in: query name: merchant_access_mode required: false schema: example: AGENCY_MODE type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherCodecountResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_ordervoucher_codecount_default_response' description: 请求失败 summary: 统计商家券券码数量 tags: - alipay.marketing.activity.ordervoucher x-accepts: application/json /v3/alipay/marketing/ordervoucher/activity/{activity_id}/voucher/codedeposit: post: description: 商家调用该接口同步导入商家券券码,接口同步返回导入结果。请在接收alipay.marketing.activity.message.created消息后,再进行调用。 operationId: alipay.marketing.activity.ordervoucher.codedeposit parameters: - description: 活动id explode: false in: path name: activity_id required: true schema: example: "2016042700826004508401111111" type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherCodedepositModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherCodedepositResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_ordervoucher_codedeposit_default_response' description: 请求失败 summary: 同步商家券券码 tags: - alipay.marketing.activity.ordervoucher x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/ordervoucher/activity/{activity_id}/voucher/{voucher_code}/refund: post: description: |- 商户调用该接口进行优惠券退券处理。接口同步返回结果。 如果优惠券过期后,发起退券操作,该接口返回成功,优惠券退回后仍不可用。 如果优惠券在支付宝卡包已删除,发起退券操作,该接口返回成功,优惠券在支付宝卡包仍然是删除状态。 operationId: alipay.marketing.activity.ordervoucher.refund parameters: - description: 活动id explode: false in: path name: activity_id required: true schema: example: "2016042700826004508401111111" type: string style: simple - description: 已核销待退券的券码 explode: false in: path name: voucher_code required: true schema: example: ABE44 type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherRefundModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherRefundResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_ordervoucher_refund_default_response' description: 请求失败 summary: 取消券核销状态 tags: - alipay.marketing.activity.ordervoucher x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/ordervoucher/activity/{activity_id}/voucher/{voucher_code}/use: post: description: 商户调用该接口,通过券码进行优惠券核销,接口同步返回核销结果。 operationId: alipay.marketing.activity.ordervoucher.use parameters: - description: 活动id explode: false in: path name: activity_id required: true schema: example: "2016042700826004508401111111" type: string style: simple - description: 待核销的券码。 explode: false in: path name: voucher_code required: true schema: example: ABE44 type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherUseModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherUseResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_activity_ordervoucher_use_default_response' description: 请求失败 summary: 同步券核销状态 tags: - alipay.marketing.activity.ordervoucher x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/recruit/enroll/close: post: description: 下线报名 operationId: alipay.marketing.recruit.enroll.close requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingRecruitEnrollCloseModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingRecruitEnrollCloseResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_recruit_enroll_close_default_response' description: 请求失败 summary: 下线报名 tags: - alipay.marketing.recruit.enroll x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/recruit/enroll/create: post: description: 创建报名后立即提交,审核通过后会以消息的形式通知调用方(需要接入消息接口alipay.marketing.enroll.status.changed)。在消息通知前可以尝试调用“报名详情查询接口(alipay.marketing.enroll.detail.query)”了解报名状态。 operationId: alipay.marketing.recruit.enroll.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingRecruitEnrollCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingRecruitEnrollCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_recruit_enroll_create_default_response' description: 请求失败 summary: 招商报名提交 tags: - alipay.marketing.recruit.enroll x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/recruit/enroll/query: get: description: 报名详情查询 operationId: alipay.marketing.recruit.enroll.query parameters: - description: 外部操作流水号,创建招商报名时传入。由商家/ISV 自定义,仅支持字母、数字、下划线且需保证每次操作唯一。 explode: true in: query name: out_biz_no required: false schema: example: 21ba1e1c16456985463242192e4d type: string style: form - description: 报名ID,此参数和out_biz_no至少传一个,优先取enroll_id explode: true in: query name: enroll_id required: false schema: example: "2021041201000200000000999999" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingRecruitEnrollQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_recruit_enroll_query_default_response' description: 请求失败 summary: 报名详情查询 tags: - alipay.marketing.recruit.enroll x-accepts: application/json /v3/alipay/marketing/recruit/plan/query: post: description: 招商方案详情查询 operationId: alipay.marketing.recruit.plan.query requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingRecruitPlanQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingRecruitPlanQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_recruit_plan_query_default_response' description: 请求失败 summary: 招商方案详情查询 tags: - alipay.marketing.recruit.plan x-content-type: application/json x-accepts: application/json /v3/alipay/marketing/recruit/planlist/query: post: description: 查询可报名的方案列表 operationId: alipay.marketing.recruit.planlist.query requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingRecruitPlanlistQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMarketingRecruitPlanlistQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_marketing_recruit_planlist_query_default_response' description: 请求失败 summary: 查询可报名的方案列表 tags: - alipay.marketing.recruit.planlist x-content-type: application/json x-accepts: application/json /v3/alipay/merchant/anchor/query: get: description: 查询主播信息 operationId: alipay.merchant.anchor.info.query parameters: - description: 蚂蚁统一会员ID explode: true in: query name: user_id required: false schema: example: "2088000011112222" type: string style: form - description: 蚂蚁统一会员ID explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form - description: 生活号ID explode: true in: query name: public_id required: false schema: example: "2021000011112222" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantAnchorInfoQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_merchant_anchor_info_query_default_response' description: 请求失败 summary: 查询主播信息 tags: - alipay.merchant.anchor.info x-accepts: application/json /v3/alipay/merchant/image/upload: post: description: 商户上传投诉处理、服务咨询的图片接口 operationId: alipay.merchant.image.upload requestBody: content: multipart/form-data: encoding: data: contentType: application/json style: form image_content: contentType: '*/*' style: form schema: $ref: '#/components/schemas/alipay_merchant_image_upload_request' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantImageUploadResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_merchant_image_upload_default_response' description: 请求失败 summary: 商户上传处理图片 tags: - alipay.merchant.image x-content-type: multipart/form-data x-accepts: application/json /v3/alipay/merchant/indirect/authorder/close: put: description: 申请单处于审核中、审核失败、待确认等状态时,申请单可撤销,撤销后可重新调用提交申请单接口上传申请单信息 operationId: alipay.merchant.indirect.authorder.close requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantIndirectAuthorderCloseModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantIndirectAuthorderCloseResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_merchant_indirect_authorder_close_default_response' description: 请求失败 summary: 商家认证申请单撤销 tags: - alipay.merchant.indirect.authorder x-content-type: application/json x-accepts: application/json /v3/alipay/merchant/indirect/authorder/create: post: description: 间连商户认证申请单提交,用于支付宝间连商家认证 operationId: alipay.merchant.indirect.authorder.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantIndirectAuthorderCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantIndirectAuthorderCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_merchant_indirect_authorder_create_default_response' description: 请求失败 summary: 商家认证申请单提交 tags: - alipay.merchant.indirect.authorder x-content-type: application/json x-accepts: application/json /v3/alipay/merchant/indirect/authorder/querystatus: post: description: 查询商家认证申请单状态,以及失败原因 operationId: alipay.merchant.indirect.authorder.querystatus requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantIndirectAuthorderQuerystatusModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantIndirectAuthorderQuerystatusResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_merchant_indirect_authorder_querystatus_default_response' description: 请求失败 summary: 查询商家认证申请单状态 tags: - alipay.merchant.indirect.authorder x-content-type: application/json x-accepts: application/json /v3/alipay/merchant/indirect/smidbind/query: get: description: 获取商家认证状态,状态枚举:已确认/未确认/已注销 operationId: alipay.merchant.indirect.smidbind.query parameters: - description: 支付宝商户id explode: true in: query name: sub_merchant_id required: false schema: example: "2088000000000001" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantIndirectSmidbindQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_merchant_indirect_smidbind_query_default_response' description: 请求失败 summary: 获取商家认证状态 tags: - alipay.merchant.indirect.smidbind x-accepts: application/json /v3/alipay/merchant/iot/device/bind: post: description: 同步IoT设备、商户和门店的绑定关系 operationId: alipay.merchant.iot.device.bind requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantIotDeviceBindModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantIotDeviceBindResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_merchant_iot_device_bind_default_response' description: 请求失败 summary: IoT设备绑定门店 tags: - alipay.merchant.iot.device x-content-type: application/json x-accepts: application/json /v3/alipay/merchant/iot/device/query: get: description: 通过设备唯一标识查询设备绑定关系 operationId: alipay.merchant.iot.device.query parameters: - description: "可选方式 [ID,SN]。ID-使用biztid作为设备唯一识别标识;SN-使用supplier_id、device_sn联\ 合作为设备唯一识别标识。由于不同机型的supplier_id不同,推荐使用 ID 。" explode: true in: query name: device_id_type required: false schema: example: SN type: string style: form - description: 设备 ID ,device_id_type 为 ID 时填写。 explode: true in: query name: biz_tid required: false schema: example: 01017gV1CZ1XxASNbqkTJqchletNyVXtsKy1PAs4FKZ6tjRMqyMG2Zk type: string style: form - description: 设备供应商ID ,device_id_type 为 SN 时填写。需注意不同机型的供应商ID可能不同。 explode: true in: query name: supplier_id required: false schema: example: "201812271300540049" type: string style: form - description: 设备序列号 ,device_id_type 为 SN 时填写。需配合supplier_id使用。 explode: true in: query name: device_sn required: false schema: example: QCF420190316000107 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantIotDeviceQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_merchant_iot_device_query_default_response' description: 请求失败 summary: IoT设备绑定关系查询 tags: - alipay.merchant.iot.device x-accepts: application/json /v3/alipay/merchant/iot/device/verify: post: description: 校验IoT设备和商户收单账号的对应关系 operationId: alipay.merchant.iot.device.verify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantIotDeviceVerifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantIotDeviceVerifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_merchant_iot_device_verify_default_response' description: 请求失败 summary: IoT设备绑定校验 tags: - alipay.merchant.iot.device x-content-type: application/json x-accepts: application/json /v3/alipay/merchant/item/file/upload: post: description: 商户把商品对应的图片文件、普通文件信息上传到支付宝,后续通过该接口返回的素材ID来和支付宝交互 operationId: alipay.merchant.item.file.upload requestBody: content: multipart/form-data: encoding: file_content: contentType: '*/*' style: form data: contentType: application/json style: form schema: $ref: '#/components/schemas/alipay_merchant_item_file_upload_request' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantItemFileUploadResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_merchant_item_file_upload_default_response' description: 请求失败 summary: 商品文件上传接口 tags: - alipay.merchant.item.file x-content-type: multipart/form-data x-accepts: application/json /v3/alipay/merchant/live/channel/query: get: description: 根据直播等内容域跳转小程序下单时携带的orderStartId,回查业务主体信息(如操作人、主播、直播、文章等,用于外部业务信息补全、返佣等)。 operationId: alipay.merchant.live.channel.query parameters: - description: 渠道下单参数(orderStartId) explode: true in: query name: secret required: false schema: example: b07d6694341b69c406522d3ff28d9807 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantLiveChannelQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_merchant_live_channel_query_default_response' description: 请求失败 summary: 渠道信息查询 tags: - alipay.merchant.live.channel x-accepts: application/json /v3/alipay/merchant/live/itemplan/modify: post: description: 支付宝货品推广计划创建 operationId: alipay.merchant.live.itemplan.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantLiveItemplanModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantLiveItemplanModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_merchant_live_itemplan_modify_default_response' description: 请求失败 summary: 支付宝货品推广计划创建 tags: - alipay.merchant.live.itemplan x-content-type: application/json x-accepts: application/json /v3/alipay/merchant/order/sync: post: description: 商户可以调用此接口同步交易对应的订单数据 operationId: alipay.merchant.order.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantOrderSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantOrderSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_merchant_order_sync_default_response' description: 请求失败 summary: 订单数据同步接口 tags: - alipay.merchant.order x-content-type: application/json x-accepts: application/json /v3/alipay/merchant/tradecomplain/batchquery: post: description: 开发者根据其应用id查询用户在其应用(小程序、生活号)的投诉单列表记录。投诉单列表以分页查询方式返回。 operationId: alipay.merchant.tradecomplain.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantTradecomplainBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantTradecomplainBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_merchant_tradecomplain_batchquery_default_response' description: 请求失败 summary: 查询交易投诉列表 tags: - alipay.merchant.tradecomplain x-content-type: application/json x-accepts: application/json /v3/alipay/merchant/tradecomplain/feedback: post: description: 商户请求交易投诉处理API,上传处理类型、处理内容描述及图片凭证。其中上传图片凭证需要先通过"商户上传处理图片"接口获取图片id,再将图片id设置到接口请求中。 operationId: alipay.merchant.tradecomplain.feedback.submit requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantTradecomplainFeedbackSubmitModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantTradecomplainFeedbackSubmitResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_merchant_tradecomplain_feedback_submit_default_response' description: 请求失败 summary: 商家处理交易投诉 tags: - alipay.merchant.tradecomplain.feedback x-content-type: application/json x-accepts: application/json /v3/alipay/merchant/tradecomplain/reply: post: description: 投诉单状态在“商家待处理”或“商家已反馈”或“商家处理超时”状态下,若有内容需要补充说明,可使用此接口提交文字或图片 operationId: alipay.merchant.tradecomplain.reply.submit requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantTradecomplainReplySubmitModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantTradecomplainReplySubmitResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_merchant_tradecomplain_reply_submit_default_response' description: 请求失败 summary: 商家留言回复 tags: - alipay.merchant.tradecomplain.reply x-content-type: application/json x-accepts: application/json /v3/alipay/merchant/tradecomplain/supplement: post: description: 投诉进入平台处理中状态时,为保证客服能准确判定责任方,可使用此接口补充文字或图片说明问题及处理经过 operationId: alipay.merchant.tradecomplain.supplement.submit requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantTradecomplainSupplementSubmitModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantTradecomplainSupplementSubmitResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_merchant_tradecomplain_supplement_submit_default_response' description: 请求失败 summary: 商家补充凭证 tags: - alipay.merchant.tradecomplain.supplement x-content-type: application/json x-accepts: application/json /v3/alipay/merchant/tradecomplain/{complain_event_id}: get: description: 开发者根据支付宝侧投诉单号查询该笔投诉详细记录。 operationId: alipay.merchant.tradecomplain.query parameters: - description: 支付宝侧投诉单号 explode: false in: path name: complain_event_id required: true schema: example: "2020092300102000000001459758" type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMerchantTradecomplainQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_merchant_tradecomplain_query_default_response' description: 请求失败 summary: 查询单条交易投诉详情 tags: - alipay.merchant.tradecomplain x-accepts: application/json /v3/alipay/mobile/public/follow/list: get: description: "公众号可通过本接口来获取帐号的关注者列表,关注者列表由一串userId组成。一次拉取调用最多拉取10000个关注者的userId,\ 可以通过多次拉取的方式来满足需求。\r\n公众号可通过本接口来获取帐号的关注者列表,关注者列表由一串userId组成。一次拉取调用最多拉取10000个\ 关注者的userId,可以通过多次拉取的方式来满足需求。" operationId: alipay.mobile.public.follow.list parameters: - description: "当nextUserId为空时,代表查询第一组,如果有值时以当前值为准查询下一组\r\t详情请见" explode: true in: query name: biz_content required: false schema: example: "{\"nextUserId\":\"2088102123322367\"}" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMobilePublicFollowListResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_mobile_public_follow_list_default_response' description: 请求失败 summary: 获取关注者列表 tags: - alipay.mobile.public.follow x-accepts: application/json /v3/alipay/mobile/public/info/query: get: description: 通过该接口查询服务窗名称、头像、欢迎语基础信息 operationId: alipay.mobile.public.info.query responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMobilePublicInfoQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_mobile_public_info_query_default_response' description: 请求失败 summary: 服务窗基础信息查询接口 tags: - alipay.mobile.public.info x-accepts: application/json /v3/alipay/mobile/public/menu/add: post: description: 通过POST一个特定的结构体,实现支付宝钱包客户端的服务窗创建自定义菜单。本接口只可以调用一次,菜单已存在无需再次创建,今后只需要调用更新接口。 operationId: alipay.mobile.public.menu.add requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMobilePublicMenuAddModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMobilePublicMenuAddResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_mobile_public_menu_add_default_response' description: 请求失败 summary: 创建菜单 tags: - alipay.mobile.public.menu x-content-type: application/json x-accepts: application/json /v3/alipay/mobile/public/menu/get: get: description: 查询当前使用的自定义菜单 operationId: alipay.mobile.public.menu.get responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMobilePublicMenuGetResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_mobile_public_menu_get_default_response' description: 请求失败 summary: 查询菜单 tags: - alipay.mobile.public.menu x-accepts: application/json /v3/alipay/mobile/public/menu/update: post: description: 通过POST一个特定结构体,实现支付宝钱包客户端的公众账号更新自定义菜单。每一次的更新是针对全部自定义菜单的更新。 operationId: alipay.mobile.public.menu.update requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMobilePublicMenuUpdateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMobilePublicMenuUpdateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_mobile_public_menu_update_default_response' description: 请求失败 summary: 更新菜单 tags: - alipay.mobile.public.menu x-content-type: application/json x-accepts: application/json /v3/alipay/mobile/public/message/custom/send: post: description: 异步单发消息 operationId: alipay.mobile.public.message.custom.send requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMobilePublicMessageCustomSendModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMobilePublicMessageCustomSendResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_mobile_public_message_custom_send_default_response' description: 请求失败 summary: 异步单发消息 tags: - alipay.mobile.public.message.custom x-content-type: application/json x-accepts: application/json /v3/alipay/mobile/public/message/single/send: post: description: 单发模板消息 operationId: alipay.mobile.public.message.single.send requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMobilePublicMessageSingleSendModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMobilePublicMessageSingleSendResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_mobile_public_message_single_send_default_response' description: 请求失败 summary: 单发模板消息 tags: - alipay.mobile.public.message.single x-content-type: application/json x-accepts: application/json /v3/alipay/mobile/public/message/total/send: post: description: 群发消息 operationId: alipay.mobile.public.message.total.send requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMobilePublicMessageTotalSendModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMobilePublicMessageTotalSendResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_mobile_public_message_total_send_default_response' description: 请求失败 summary: 群发消息 tags: - alipay.mobile.public.message.total x-content-type: application/json x-accepts: application/json /v3/alipay/mobile/public/qrcode/create: post: description: "为了满足用户渠道推广分析的需要,公众平台提供了生成带参数二维码的接口。使用该接口可以获得多个带不同场景值的二维码,用户扫描后\ ,公众号可以接收到事件推送。目前有2种类型的二维码,分别是临时二维码、和永久二维码,前者有过期时间,最大为1800秒。\r\n每次创建二维码ticket需\ 要提供一个开发者自行设定的参数(scene_id)。" operationId: alipay.mobile.public.qrcode.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMobilePublicQrcodeCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMobilePublicQrcodeCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_mobile_public_qrcode_create_default_response' description: 请求失败 summary: 生成带参数的二维码 tags: - alipay.mobile.public.qrcode x-content-type: application/json x-accepts: application/json /v3/alipay/mobile/public/shortlink/create: post: description: 商户通过本接口生成带自有场景标识的短链接 operationId: alipay.mobile.public.shortlink.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMobilePublicShortlinkCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMobilePublicShortlinkCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_mobile_public_shortlink_create_default_response' description: 请求失败 summary: 服务窗短链自主生成接口 tags: - alipay.mobile.public.shortlink x-content-type: application/json x-accepts: application/json /v3/alipay/mobile/public/template/message/delete: post: description: 模板消息删除接口 operationId: alipay.mobile.public.template.message.delete requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMobilePublicTemplateMessageDeleteModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMobilePublicTemplateMessageDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_mobile_public_template_message_delete_default_response' description: 请求失败 summary: 模板消息删除接口 tags: - alipay.mobile.public.template.message x-content-type: application/json x-accepts: application/json /v3/alipay/mobile/public/template/message/get: get: description: 帮助服务窗从服务窗平台(fuwu.alipay.com)公共模板库里领取一个行业的消息模板--消息模板是一种消息的样式,如消费提醒、账单提醒等 operationId: alipay.mobile.public.template.message.get parameters: - description: 消息母板id explode: true in: query name: template_id required: false schema: example: TM000000223 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMobilePublicTemplateMessageGetResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_mobile_public_template_message_get_default_response' description: 请求失败 summary: 模板消息领取接口 tags: - alipay.mobile.public.template.message x-accepts: application/json /v3/alipay/mobile/public/template/message/query: post: description: 模板消息查询接口 operationId: alipay.mobile.public.template.message.query parameters: - allowEmptyValue: true description: 用户授权令牌 explode: true in: query name: auth_token required: false schema: type: string style: form requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMobilePublicTemplateMessageQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMobilePublicTemplateMessageQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_mobile_public_template_message_query_default_response' description: 请求失败 summary: 模板消息查询接口 tags: - alipay.mobile.public.template.message x-content-type: application/json x-accepts: application/json /v3/alipay/mobile/std/public/message/custom/send: post: description: 商户给单个用户发送消息 operationId: alipay.mobile.std.public.message.custom.send requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayMobileStdPublicMessageCustomSendModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayMobileStdPublicMessageCustomSendResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_mobile_std_public_message_custom_send_default_response' description: 请求失败 summary: 异步单发消息 tags: - alipay.mobile.std.public.message.custom x-content-type: application/json x-accepts: application/json /v3/alipay/offline/market/applyorder/batchquery: post: description: 通过该接口分页查询Leads、门店、商品相关操作流水信息 operationId: alipay.offline.market.applyorder.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOfflineMarketApplyorderBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOfflineMarketApplyorderBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_offline_market_applyorder_batchquery_default_response' description: 请求失败 summary: 业务流水批量查询接口 tags: - alipay.offline.market.applyorder x-content-type: application/json x-accepts: application/json /v3/alipay/offline/market/shop/batchquery: post: description: 系统商通过该接口可以查询对应APPID下所有的门店编号(支付宝口碑门店编号) operationId: alipay.offline.market.shop.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOfflineMarketShopBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOfflineMarketShopBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_offline_market_shop_batchquery_default_response' description: 请求失败 summary: 查询商户的门店编号列表 tags: - alipay.offline.market.shop x-content-type: application/json x-accepts: application/json /v3/alipay/offline/market/shop/category/query: get: description: 用于查询可用于开店的类目,以及类目上的配置约束信息 operationId: alipay.offline.market.shop.category.query parameters: - description: 类目ID,如果为空则查询全部类目。 explode: true in: query name: category_id required: false schema: example: "2015050700000000" type: string style: form - description: "表示接口业务的调用方身份,默认不填标识为ISV。" explode: true in: query name: op_role required: false schema: example: ISV type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOfflineMarketShopCategoryQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_offline_market_shop_category_query_default_response' description: 请求失败 summary: 门店类目配置查询接口 tags: - alipay.offline.market.shop.category x-accepts: application/json /v3/alipay/offline/market/shop/create: post: description: 系统商需要通过该接口在口碑平台帮助商户创建门店信息。 operationId: alipay.offline.market.shop.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOfflineMarketShopCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOfflineMarketShopCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_offline_market_shop_create_default_response' description: 请求失败 summary: 创建门店信息 tags: - alipay.offline.market.shop x-content-type: application/json x-accepts: application/json /v3/alipay/offline/market/shop/modify: post: description: 系统商需要通过该接口在口碑平台帮助商户修改门店信息,所有的选项都为非必填项,需要修改什么信息就传入什么参数,不传入的参数,则保持不变。修改门店名、品牌名、品牌logo、首图、门店图片、营业执照、营业执照编号、营业执照名称、经营许可证、经营许可证有效期、门店授权函、是否在其它平台开店、在其它平台开店照片,会重新触发风控审核,修改其他字段不会触发风控审核。 operationId: alipay.offline.market.shop.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOfflineMarketShopModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOfflineMarketShopModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_offline_market_shop_modify_default_response' description: 请求失败 summary: 修改门店信息 tags: - alipay.offline.market.shop x-content-type: application/json x-accepts: application/json /v3/alipay/offline/market/shop/querydetail: get: description: 系统商通过该接口可以查询单个门店的详细信息,包括门店基础信息,门店状态等信息 operationId: alipay.offline.market.shop.querydetail parameters: - description: 支付宝门店ID explode: true in: query name: shop_id required: false schema: example: "2015052100077000000000120773" type: string style: form - description: "服务商及商户调用情况下务必传递。操作人角色,默认商户操作:MERCHANT;服务商操作:PROVIDER;ISV: 不需\ 要填写" explode: true in: query name: op_role required: false schema: example: MERCHANT或PROVIDER type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOfflineMarketShopQuerydetailResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_offline_market_shop_querydetail_default_response' description: 请求失败 summary: 查询单个门店信息接口 tags: - alipay.offline.market.shop x-accepts: application/json /v3/alipay/offline/market/shop/summary/batchquery: post: description: 用于进行门店摘要信息批量查询接口。 operationId: alipay.offline.market.shop.summary.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOfflineMarketShopSummaryBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOfflineMarketShopSummaryBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_offline_market_shop_summary_batchquery_default_response' description: 请求失败 summary: 门店摘要信息批量查询接口 tags: - alipay.offline.market.shop.summary x-content-type: application/json x-accepts: application/json /v3/alipay/offline/material/image/upload: post: description: "系统商需要先将商户需要使用的图片和视频,上传支付宝服务器,生成对应的图片ID后才能够在口碑平台上配置相应图片" operationId: alipay.offline.material.image.upload requestBody: content: multipart/form-data: encoding: data: contentType: application/json style: form image_content: contentType: '*/*' style: form schema: $ref: '#/components/schemas/alipay_offline_material_image_upload_request' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOfflineMaterialImageUploadResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_offline_material_image_upload_default_response' description: 请求失败 summary: 上传门店照片和视频接口 tags: - alipay.offline.material.image x-content-type: multipart/form-data x-accepts: application/json /v3/alipay/open/agent/cancel: post: description: 取消代商户签约、创建应用事务 operationId: alipay.open.agent.cancel requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAgentCancelModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAgentCancelResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_agent_cancel_default_response' description: 请求失败 summary: 取消代商户签约、创建应用事务 tags: - alipay.open.agent x-content-type: application/json x-accepts: application/json /v3/alipay/open/agent/common/sign: post: description: 三方应用代理签约产品,需要配合开启事务接口使用 operationId: alipay.open.agent.common.sign requestBody: content: multipart/form-data: encoding: web_pay_screenshot: contentType: '*/*' style: form shop_sign_board_pic: contentType: '*/*' style: form h_5_pay_screenshot: contentType: '*/*' style: form data: contentType: application/json style: form shop_scene_pic: contentType: '*/*' style: form h_5_home_screenshot: contentType: '*/*' style: form app_home_screenshot: contentType: '*/*' style: form business_license_auth_pic: contentType: '*/*' style: form app_item_screenshot: contentType: '*/*' style: form h_5_sites_loa: contentType: '*/*' style: form web_item_screenshot: contentType: '*/*' style: form special_license_pic: contentType: '*/*' style: form web_sites_loa: contentType: '*/*' style: form business_license_pic: contentType: '*/*' style: form mini_app_screenshot: contentType: '*/*' style: form h_5_item_screenshot: contentType: '*/*' style: form app_demo: contentType: '*/*' style: form h_5_extra_pic: contentType: '*/*' style: form web_home_screenshot: contentType: '*/*' style: form app_auth_pic: contentType: '*/*' style: form app_pay_screenshot: contentType: '*/*' style: form schema: $ref: '#/components/schemas/alipay_open_agent_common_sign_request' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAgentCommonSignResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_agent_common_sign_default_response' description: 请求失败 summary: 代签约产品通用接口 tags: - alipay.open.agent.common x-content-type: multipart/form-data x-accepts: application/json /v3/alipay/open/agent/commonsign/confirm: post: description: 三方应用代理签约产品,上传商户信息后,确认提交信息。可以配合开启事务接口使用。 operationId: alipay.open.agent.commonsign.confirm requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAgentCommonsignConfirmModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAgentCommonsignConfirmResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_agent_commonsign_confirm_default_response' description: 请求失败 summary: 代商户签约,提交信息确认接口 tags: - alipay.open.agent.commonsign x-content-type: application/json x-accepts: application/json /v3/alipay/open/agent/confirm: post: description: 提交事务。只允许提交init状态的事务,submit|cancel|timeout 状态的都是终态,不允许提交,且不允许提交空事务,需要先调用代创建小程序、代签约当面付等业务接口,再提交事务。服务市场订购及授权,使用订单授权凭证order_ticket开启的事务,提交后会有应用授权令牌返回。 operationId: alipay.open.agent.confirm requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAgentConfirmModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAgentConfirmResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_agent_confirm_default_response' description: 请求失败 summary: 提交代商户签约、创建应用事务 tags: - alipay.open.agent x-content-type: application/json x-accepts: application/json /v3/alipay/open/agent/create: post: description: 在 ISV 代商户进行应用创建、产品签约时,用于开启一个操作事务,必须是第一个调用的接口。场景1:ISV 代商户进行应用创建、产品签约,最后提交事务后需要商户确认才能完成流程;场景2:服务市场订购及授权,使用订单授权凭证order_ticket开启预授权模式,该模式下提交事务后无需商户确认。 operationId: alipay.open.agent.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAgentCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAgentCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_agent_create_default_response' description: 请求失败 summary: 开启代商户签约、创建应用事务 tags: - alipay.open.agent x-content-type: application/json x-accepts: application/json /v3/alipay/open/agent/facetoface/sign: post: description: 三方应用代理签约当面付产品,需要配合开启事务接口使用 operationId: alipay.open.agent.facetoface.sign requestBody: content: multipart/form-data: encoding: shop_sign_board_pic: contentType: '*/*' style: form special_license_pic: contentType: '*/*' style: form business_license_pic: contentType: '*/*' style: form data: contentType: application/json style: form shop_scene_pic: contentType: '*/*' style: form business_license_auth_pic: contentType: '*/*' style: form schema: $ref: '#/components/schemas/alipay_open_agent_facetoface_sign_request' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAgentFacetofaceSignResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_agent_facetoface_sign_default_response' description: 请求失败 summary: 代签约当面付产品 tags: - alipay.open.agent.facetoface x-content-type: multipart/form-data x-accepts: application/json /v3/alipay/open/agent/mini/create: post: description: ISV 代商家创建小程序应用。该接口后续将不再更新迭代,请使用新接口对接开发。新接口介绍文档:https://opendocs.alipay.com/isv/03kqzh ;新接口对接文档:https://opendocs.alipay.com/mini/03l21u 。 operationId: alipay.open.agent.mini.create requestBody: content: multipart/form-data: encoding: app_logo: contentType: '*/*' style: form data: contentType: application/json style: form schema: $ref: '#/components/schemas/alipay_open_agent_mini_create_request' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAgentMiniCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_agent_mini_create_default_response' description: 请求失败 summary: 代商家创建小程序应用 tags: - alipay.open.agent.mini x-content-type: multipart/form-data x-accepts: application/json /v3/alipay/open/agent/mobilepay/sign: post: description: 三方应用代理签约APP支付产品,需要配合开启事务接口使用 operationId: alipay.open.agent.mobilepay.sign requestBody: content: multipart/form-data: encoding: special_license_pic: contentType: '*/*' style: form business_license_pic: contentType: '*/*' style: form data: contentType: application/json style: form app_demo: contentType: '*/*' style: form app_home_screenshot: contentType: '*/*' style: form business_license_auth_pic: contentType: '*/*' style: form app_item_screenshot: contentType: '*/*' style: form in_app_screenshot: contentType: '*/*' style: form app_auth_pic: contentType: '*/*' style: form pay_screenshot: contentType: '*/*' style: form app_pay_screenshot: contentType: '*/*' style: form home_screenshot: contentType: '*/*' style: form schema: $ref: '#/components/schemas/alipay_open_agent_mobilepay_sign_request' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAgentMobilepaySignResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_agent_mobilepay_sign_default_response' description: 请求失败 summary: 代签约APP支付产品 tags: - alipay.open.agent.mobilepay x-content-type: multipart/form-data x-accepts: application/json /v3/alipay/open/agent/offlinepayment/sign: post: description: 三方应用代理签约当面付快捷版产品,需要配合开启事务接口使用 operationId: alipay.open.agent.offlinepayment.sign requestBody: content: multipart/form-data: encoding: shop_sign_board_pic: contentType: '*/*' style: form special_license_pic: contentType: '*/*' style: form business_license_pic: contentType: '*/*' style: form data: contentType: application/json style: form shop_scene_pic: contentType: '*/*' style: form schema: $ref: '#/components/schemas/alipay_open_agent_offlinepayment_sign_request' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAgentOfflinepaymentSignResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_agent_offlinepayment_sign_default_response' description: 请求失败 summary: 代签约当面付快捷版产品 tags: - alipay.open.agent.offlinepayment x-content-type: multipart/form-data x-accepts: application/json /v3/alipay/open/agent/order/query: get: description: 代签约产品提交后,查询对应申请单的情况 operationId: alipay.open.agent.order.query parameters: - description: ISV 代商户操作事务编号,通过调用alipay.open.agent.create(开启代商户签约、创建应用事务)接口返回,详见 https://opendocs.alipay.com/apis/api_50/alipay.open.agent.create/ 。 explode: true in: query name: batch_no required: false schema: example: "2017110616474516400082883" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAgentOrderQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_agent_order_query_default_response' description: 请求失败 summary: 查询申请单状态 tags: - alipay.open.agent.order x-accepts: application/json /v3/alipay/open/agent/signstatus/query: post: description: 主要用在isv代理商户签约场景,用来查询商户签约某个产品的签约状态,可以配合"第三方接入核心API"功能包里的接口使用 operationId: alipay.open.agent.signstatus.query requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAgentSignstatusQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAgentSignstatusQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_agent_signstatus_query_default_response' description: 请求失败 summary: 查询商户某个产品的签约状态 tags: - alipay.open.agent.signstatus x-content-type: application/json x-accepts: application/json /v3/alipay/open/app/api/field/apply: post: description: 申请获取接口出参中用户敏感信息字段,应用使用视频或图片(至少选择一项上传),单个图片或视频不超过10M,最多可上传5张图片示例。 operationId: alipay.open.app.api.field.apply requestBody: content: multipart/form-data: encoding: data: contentType: application/json style: form picture_5: contentType: '*/*' style: form video: contentType: '*/*' style: form picture_2: contentType: '*/*' style: form picture_1: contentType: '*/*' style: form picture_4: contentType: '*/*' style: form picture_3: contentType: '*/*' style: form schema: $ref: '#/components/schemas/alipay_open_app_api_field_apply_request' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAppApiFieldApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_app_api_field_apply_default_response' description: 请求失败 summary: 申请获取接口用户敏感信息字段 tags: - alipay.open.app.api.field x-content-type: multipart/form-data x-accepts: application/json /v3/alipay/open/app/api/field/query: get: description: 查询用户信息申请记录,开发者发起请求时会基于当前发起请求的app_id进行查询,若为isv发起的三方代调用则以授权的商户app_id进行查询。 operationId: alipay.open.app.api.field.query responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAppApiFieldQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_app_api_field_query_default_response' description: 请求失败 summary: 用户信息申请记录查询 tags: - alipay.open.app.api.field x-accepts: application/json /v3/alipay/open/app/api/query: get: description: 通过appId查询该应用下可申请的接口敏感字段信息 operationId: alipay.open.app.api.query responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAppApiQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_app_api_query_default_response' description: 请求失败 summary: 查询应用可申请的接口出参敏感字段列表 tags: - alipay.open.app.api x-accepts: application/json /v3/alipay/open/app/api/scene/query: get: description: 在申请接口出参中用户敏感信息字段时,本接口用于获取所申请接口字段的使用场景 operationId: alipay.open.app.api.scene.query parameters: - description: 接口出参字段英文名。 explode: true in: query name: field_name required: false schema: example: mobile type: string style: form - description: 接口英文名。 explode: true in: query name: api_name required: false schema: example: alipay.user.info.share type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAppApiSceneQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_app_api_scene_query_default_response' description: 请求失败 summary: 查询接口字段使用场景 tags: - alipay.open.app.api.scene x-accepts: application/json /v3/alipay/open/app/members/create: post: description: 应用添加成员,目前只支持小程序类型的应用使用 operationId: alipay.open.app.members.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAppMembersCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAppMembersCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_app_members_create_default_response' description: 请求失败 summary: 应用添加成员 tags: - alipay.open.app.members x-content-type: application/json x-accepts: application/json /v3/alipay/open/app/members/delete: delete: description: 删除应用成员,目前只支持小程序类型的应用 operationId: alipay.open.app.members.delete parameters: - description: 被删除成员的支付宝账户唯一标识,以2088开头。 explode: true in: query name: user_id required: false schema: example: 208822294389xxxx type: string style: form - description: 被删除成员的openId。 explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form - description: 被删除成员的角色类型 explode: true in: query name: role required: false schema: example: DEVELOPER type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAppMembersDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_app_members_delete_default_response' description: 请求失败 summary: 应用删除成员 tags: - alipay.open.app.members x-accepts: application/json /v3/alipay/open/app/members/query: get: description: 应用查询成员列表,目前只支持小程序类型的应用 operationId: alipay.open.app.members.query parameters: - description: 查询的成员角色类型 explode: true in: query name: role required: false schema: example: DEVELOPER type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAppMembersQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_app_members_query_default_response' description: 请求失败 summary: 应用查询成员列表 tags: - alipay.open.app.members x-accepts: application/json /v3/alipay/open/app/messagetemplate/subscribe/query: post: description: 商户使用该接口可以查询用户对其消息模板的订阅关系,可以根据是否订阅引导用户进行订阅和精准触达消息 operationId: alipay.open.app.messagetemplate.subscribe.query requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAppMessagetemplateSubscribeQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAppMessagetemplateSubscribeQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_app_messagetemplate_subscribe_query_default_response' description: 请求失败 summary: 模板订阅关系查询 tags: - alipay.open.app.messagetemplate.subscribe x-content-type: application/json x-accepts: application/json /v3/alipay/open/app/mini/templatemessage/send: post: description: 小程序通过openapi给用户触达消息,主要为支付后的触达(通过消费id)、用户提交表单后的触达(通过formId)、刷脸后的触达(通过ftoken)以及用户订阅消息模板后的触达。 operationId: alipay.open.app.mini.templatemessage.send requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAppMiniTemplatemessageSendModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAppMiniTemplatemessageSendResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_app_mini_templatemessage_send_default_response' description: 请求失败 summary: 小程序发送模板消息 tags: - alipay.open.app.mini.templatemessage x-content-type: application/json x-accepts: application/json /v3/alipay/open/app/qrcode/create: post: description: 生成小程序推广二维码 operationId: alipay.open.app.qrcode.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAppQrcodeCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAppQrcodeCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_app_qrcode_create_default_response' description: 请求失败 summary: 小程序生成推广二维码接口 tags: - alipay.open.app.qrcode x-content-type: application/json x-accepts: application/json /v3/alipay/open/app/service/apply: post: description: 服务提报申请 operationId: alipay.open.app.service.apply requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAppServiceApplyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAppServiceApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_app_service_apply_default_response' description: 请求失败 summary: 服务提报申请 tags: - alipay.open.app.service x-content-type: application/json x-accepts: application/json /v3/alipay/open/app/service/delete: delete: description: 服务失效 operationId: alipay.open.app.service.delete parameters: - description: 服务id explode: true in: query name: service_code required: false schema: example: "12522641" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAppServiceDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_app_service_delete_default_response' description: 请求失败 summary: 服务失效接口 tags: - alipay.open.app.service x-accepts: application/json /v3/alipay/open/app/service/list/query: get: description: 服务批量分页查询 operationId: alipay.open.app.service.list.query parameters: - description: 服务名称 explode: true in: query name: service_name required: false schema: example: 肯德基 type: string style: form - description: 类目 explode: true in: query name: category_id required: false schema: example: C15484611 type: string style: form - description: 每页记录数 explode: true in: query name: page_size required: false schema: example: 10 type: integer style: form - description: 页码 explode: true in: query name: page_num required: false schema: example: 1 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAppServiceListQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_app_service_list_query_default_response' description: 请求失败 summary: 服务批量查询 tags: - alipay.open.app.service.list x-accepts: application/json /v3/alipay/open/app/service/query: get: description: 服务查询 operationId: alipay.open.app.service.query parameters: - description: 服务id explode: true in: query name: service_code required: false schema: example: s1111 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAppServiceQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_app_service_query_default_response' description: 请求失败 summary: 服务查询 tags: - alipay.open.app.service x-accepts: application/json /v3/alipay/open/app/service/schema/query: get: description: 服务schema查询下发 operationId: alipay.open.app.service.schema.query parameters: - description: "类目id, 获取请参考各个行业场景服务接入资料" explode: true in: query name: category_id required: false schema: example: c11111 type: string style: form - description: 服务模版类型,默认值:DEFAULT explode: true in: query name: template_type required: false schema: example: DEFAULT type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAppServiceSchemaQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_app_service_schema_query_default_response' description: 请求失败 summary: 服务schema下发 tags: - alipay.open.app.service.schema x-accepts: application/json /v3/alipay/open/auth/app/aes/get: get: description: 商家应用授权给ISV服务商代管理应用场景下,ISV开发者使用三方应用appId发起调用,通过该接口获取商户应用的AES密钥。接口返回的商户应用aes密钥内容为加密内容,需要ISV使用三方应用的AES密钥对接口返回进行解密。java sdk内部会自动完成解密返回明文内容。SDK AES加解密支持 operationId: alipay.open.auth.app.aes.get parameters: - description: 商家应用appId explode: true in: query name: merchant_app_id required: false schema: example: "20191223601234564" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAuthAppAesGetResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_auth_app_aes_get_default_response' description: 请求失败 summary: 授权应用aes密钥查询 tags: - alipay.open.auth.app.aes x-accepts: application/json /v3/alipay/open/auth/app/aes/set: post: description: 商家应用授权给ISV服务商代管理应用场景下,ISV开发者使用三方应用appId发起调用,通过该接口设置商户应用的AES密钥。接口返回的商户应用aes密钥内容为加密内容,需要ISV使用三方应用的AES密钥对接口返回进行解密。java sdk内部会自动完成解密返回明文内容。SDK AES加解密支持。 operationId: alipay.open.auth.app.aes.set requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAuthAppAesSetModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAuthAppAesSetResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_auth_app_aes_set_default_response' description: 请求失败 summary: 授权应用aes密钥设置 tags: - alipay.open.auth.app.aes x-content-type: application/json x-accepts: application/json /v3/alipay/open/auth/token/app: post: 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAuthTokenAppModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAuthTokenAppResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_auth_token_app_default_response' description: 请求失败 summary: 换取应用授权令牌 tags: - alipay.open.auth.token x-content-type: application/json x-accepts: application/json /v3/alipay/open/auth/token/app/query: get: description: 当商户把服务窗、店铺等接口的权限授权给ISV之后,支付宝会给ISV颁发一个app_auth_token。如若授权成功之后,ISV想知道用户的授权信息,如授权者、授权接口列表等信息,可以调用本接口查询某个app_auth_token对应的授权信息 operationId: alipay.open.auth.token.app.query parameters: - description: 应用授权令牌 explode: true in: query name: app_auth_token required: false schema: example: 201509BBeff9351ad1874306903e96b91d248A36 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAuthTokenAppQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_auth_token_app_query_default_response' description: 请求失败 summary: 查询某个应用授权AppAuthToken的授权信息 tags: - alipay.open.auth.token.app x-accepts: application/json /v3/alipay/open/auth/userauth/relationship/query: get: description: 校验本应用和用户的授权关系有效性 operationId: alipay.open.auth.userauth.relationship.query parameters: - description: 蚂蚁统一会员ID,如果未开启openid改造,则此值必传 explode: true in: query name: user_id required: false schema: example: "2088123443211234" type: string style: form - description: 蚂蚁统一会员ID,蚂蚁统一会员ID,如果已完成openid改造,则此值必传 explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form - description: 查询授权关系所关联的scope,半角逗号分隔的列表,且不允许有重复值 explode: true in: query name: scopes required: false schema: example: "auth_user,auth_zhima" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenAuthUserauthRelationshipQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_auth_userauth_relationship_query_default_response' description: 请求失败 summary: 用户授权关系查询 tags: - alipay.open.auth.userauth.relationship x-accepts: application/json /v3/alipay/open/biz/create: post: description: bizcontent测试12 operationId: alipay.open.biz.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenBizCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenBizCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_biz_create_default_response' description: 请求失败 summary: bizcontent测试12 tags: - alipay.open.biz x-content-type: application/json x-accepts: application/json /v3/alipay/open/fee/adjust/apply: post: description: 服务商替代签约或交易传参的商户申请费率 operationId: alipay.open.fee.adjust.apply requestBody: content: multipart/form-data: encoding: data: contentType: application/json style: form shop_scene_pic: contentType: '*/*' style: form attachment: contentType: '*/*' style: form shop_sign_pic: contentType: '*/*' style: form cert_pic: contentType: '*/*' style: form schema: $ref: '#/components/schemas/alipay_open_fee_adjust_apply_request' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenFeeAdjustApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_fee_adjust_apply_default_response' description: 请求失败 summary: 特殊费率申请 tags: - alipay.open.fee.adjust x-content-type: multipart/form-data x-accepts: application/json /v3/alipay/open/file/upload: post: description: |- 支付宝通用文件上传接口,支付宝开发者可以调用此接口上传文件,文件可以提供给其他业务使用,例如:上传素材(视频/图片),素材可以供给到生活号+/小程序等其他开放应用后正式发布。 该接口支持使用支付宝SDK和HTTP POST请求,两种方式示例如下: 1. 使用支付宝SDK时,可以直接使用FileItem上传,代码片段参考下文 2. 使用直接使用http协议时,需要忽略file_content参数,文件放入表单中,其余参数放入URL中,其中将参数(不包括文件和file_content)按自行实现签名文档实现,示例: curl --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 requestBody: content: multipart/form-data: encoding: file_content: contentType: '*/*' style: form data: contentType: application/json style: form schema: $ref: '#/components/schemas/alipay_open_file_upload_request' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenFileUploadResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_file_upload_default_response' description: 请求失败 summary: 支付宝文件上传接口 tags: - alipay.open.file x-content-type: multipart/form-data x-accepts: application/json /v3/alipay/open/instantdelivery/account/create: post: description: 商家入驻开放平台,接入即时配送服务,调用即时配送公司的接口创建账户 operationId: alipay.open.instantdelivery.account.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenInstantdeliveryAccountCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenInstantdeliveryAccountCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_instantdelivery_account_create_default_response' description: 请求失败 summary: 即时配送商家账户创建 tags: - alipay.open.instantdelivery.account x-content-type: application/json x-accepts: application/json /v3/alipay/open/instantdelivery/account/query: get: description: 即时配送业务,查询商家账户信息 operationId: alipay.open.instantdelivery.account.query responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenInstantdeliveryAccountQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_instantdelivery_account_query_default_response' description: 请求失败 summary: 即时配送商家账户查询 tags: - alipay.open.instantdelivery.account x-accepts: application/json /v3/alipay/open/instantdelivery/merchantagreement/query: get: description: "协议签署查询api, 提供isv查询商户物流代扣协议签署情况" operationId: alipay.open.instantdelivery.merchantagreement.query responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenInstantdeliveryMerchantagreementQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_instantdelivery_merchantagreement_query_default_response' description: 请求失败 summary: 协议签署查询api tags: - alipay.open.instantdelivery.merchantagreement x-accepts: application/json /v3/alipay/open/instantdelivery/merchantagreement/sign: post: description: 即时配送中商家代扣协议签署 operationId: alipay.open.instantdelivery.merchantagreement.sign requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenInstantdeliveryMerchantagreementSignModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenInstantdeliveryMerchantagreementSignResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_instantdelivery_merchantagreement_sign_default_response' description: 请求失败 summary: 即时配送中商家代扣协议签署 tags: - alipay.open.instantdelivery.merchantagreement x-content-type: application/json x-accepts: application/json /v3/alipay/open/instantdelivery/merchantshop/batchquery: post: description: 即时配送场景,商家门店信息分页查询 operationId: alipay.open.instantdelivery.merchantshop.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenInstantdeliveryMerchantshopBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenInstantdeliveryMerchantshopBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_instantdelivery_merchantshop_batchquery_default_response' description: 请求失败 summary: 即时配送商家门店分页查询 tags: - alipay.open.instantdelivery.merchantshop x-content-type: application/json x-accepts: application/json /v3/alipay/open/instantdelivery/merchantshop/create: post: description: 帮商家在即时配送公司创建门店。名称+地址必须全局唯一;pid下的shopNo必须唯一。 operationId: alipay.open.instantdelivery.merchantshop.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenInstantdeliveryMerchantshopCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenInstantdeliveryMerchantshopCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_instantdelivery_merchantshop_create_default_response' description: 请求失败 summary: 即时配送商家门店创建 tags: - alipay.open.instantdelivery.merchantshop x-content-type: application/json x-accepts: application/json /v3/alipay/open/instantdelivery/merchantshop/modify: post: description: 帮商家更新在即时配送公司的门店 operationId: alipay.open.instantdelivery.merchantshop.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenInstantdeliveryMerchantshopModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenInstantdeliveryMerchantshopModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_instantdelivery_merchantshop_modify_default_response' description: 请求失败 summary: 即时配送商家门店更新 tags: - alipay.open.instantdelivery.merchantshop x-content-type: application/json x-accepts: application/json /v3/alipay/open/instantdelivery/merchantshop/query: get: description: 即时配送场景,查询商家门店详情信息。 operationId: alipay.open.instantdelivery.merchantshop.query parameters: - description: 商家门店编码。 explode: true in: query name: shop_no required: false schema: example: "1000" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenInstantdeliveryMerchantshopQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_instantdelivery_merchantshop_query_default_response' description: 请求失败 summary: 即时配送商家门店详情查询 tags: - alipay.open.instantdelivery.merchantshop x-accepts: application/json /v3/alipay/open/invite/order/query: get: description: 创建签约授权流程后,查询对应产品签约申请单的状态 operationId: alipay.open.invite.order.query parameters: - description: isv业务系统单据编号 explode: true in: query name: isv_biz_id required: false schema: example: "2017110616474516400082883" type: string style: form - description: 商家的支付宝账号,如果调用alipay.open.invite.order.create接口时有传入支付宝账号,则这里查询签约状态时必须要传 explode: true in: query name: alipay_logon_id required: false schema: example: fykevbdz6766@alitest.com type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenInviteOrderQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_invite_order_query_default_response' description: 请求失败 summary: 查询签约申请单状态 tags: - alipay.open.invite.order x-accepts: application/json /v3/alipay/open/mini/appdeploy/byappid/query: get: description: 用于伙伴平台面向开发者提供查询小程序发布能力 operationId: alipay.open.mini.appdeploy.byappid.query parameters: - description: 小程序应用ID explode: true in: query name: mini_app_id required: false schema: example: 2018XXXXXX type: string style: form - description: 端标识 explode: true in: query name: bundle_id required: false schema: example: com.amap.app type: string style: form - description: 租户标识 explode: true in: query name: inst_code required: false schema: example: alipay type: string style: form - description: 当前页,从1开始 explode: true in: query name: page_num required: false schema: example: 1 type: integer style: form - description: 每页个数 explode: true in: query name: page_size required: false schema: example: 20 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniAppdeployByappidQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_appdeploy_byappid_query_default_response' description: 请求失败 summary: 根据APPID分页查询小程序发布信息 tags: - alipay.open.mini.appdeploy.byappid x-accepts: application/json /v3/alipay/open/mini/appdeploy/byappversion/query: get: description: 伙伴平台使用,用于向开发者展示小程序发布信息 operationId: alipay.open.mini.appdeploy.byappversion.query parameters: - description: 小程序ID explode: true in: query name: mini_app_id required: false schema: example: 2011XXXXXXX type: string style: form - description: 端标识 explode: true in: query name: bundle_id required: false schema: example: com.amap.app type: string style: form - description: 租户 explode: true in: query name: inst_code required: false schema: example: alipay type: string style: form - description: 小程序版本 explode: true in: query name: app_version required: false schema: example: 0.0.1 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniAppdeployByappversionQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_appdeploy_byappversion_query_default_response' description: 请求失败 summary: 通过版本查询小程序发布 tags: - alipay.open.mini.appdeploy.byappversion x-accepts: application/json /v3/alipay/open/mini/appdeploy/bydeployversion/query: get: description: 用于伙伴向开发者展示小程序发布信息 operationId: alipay.open.mini.appdeploy.bydeployversion.query parameters: - description: 客户端标识 explode: true in: query name: bundle_id required: false schema: example: com.amap.app type: string style: form - description: 小程序ID explode: true in: query name: mini_app_id required: false schema: example: 2021XXXXXX type: string style: form - description: 租户 explode: true in: query name: inst_code required: false schema: example: alipay type: string style: form - description: 发布标识 explode: true in: query name: deploy_version required: false schema: example: 0.2.201910101.2 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniAppdeployBydeployversionQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_appdeploy_bydeployversion_query_default_response' description: 请求失败 summary: 根据发布版本查询小程序发布信息 tags: - alipay.open.mini.appdeploy.bydeployversion x-accepts: application/json /v3/alipay/open/mini/baseinfo/modify: post: description: |- 小程序修改基础信息。 本接口暂不支持已经上过架的小程序调用(只支持小程序首次上架之前修改信息) operationId: alipay.open.mini.baseinfo.modify requestBody: content: multipart/form-data: encoding: app_logo: contentType: '*/*' style: form data: contentType: application/json style: form schema: $ref: '#/components/schemas/alipay_open_mini_baseinfo_modify_request' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniBaseinfoModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_baseinfo_modify_default_response' description: 请求失败 summary: 小程序修改基础信息 tags: - alipay.open.mini.baseinfo x-content-type: multipart/form-data x-accepts: application/json /v3/alipay/open/mini/baseinfo/name/check: get: description: 小程序名称检测。包含小程序名称基础校验、名称重复、存在敏感信息、存在品牌词、名称宽泛等检测能力。若返回“check_code”:“NONE”,说明小程序名称未检测出异常。 operationId: alipay.open.mini.baseinfo.name.check parameters: - description: 小程序名字,长度限制 3~30 个字符,仅支持包含简体中文、数字、英文、下划线、+、-。 explode: true in: query name: app_name required: false schema: example: 吱声小铺 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniBaseinfoNameCheckResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_baseinfo_name_check_default_response' description: 请求失败 summary: 小程序名称检测 tags: - alipay.open.mini.baseinfo.name x-accepts: application/json /v3/alipay/open/mini/baseinfo/query: get: description: 查询小程序基础信息 operationId: alipay.open.mini.baseinfo.query responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniBaseinfoQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_baseinfo_query_default_response' description: 请求失败 summary: 查询小程序基础信息 tags: - alipay.open.mini.baseinfo x-accepts: application/json /v3/alipay/open/mini/category/query: get: description: 小程序类目树查询 operationId: alipay.open.mini.category.query parameters: - description: 是否过滤小程序不可用类目。枚举值如下: true:表示过滤不可用类目。 false:表示不过滤不可用类目。 explode: true in: query name: is_filter required: false schema: example: true type: boolean style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniCategoryQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_category_query_default_response' description: 请求失败 summary: 小程序类目树查询 tags: - alipay.open.mini.category x-accepts: application/json /v3/alipay/open/mini/category/require/query: post: description: 查询类目所需资质信息 operationId: alipay.open.mini.category.require.query requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniCategoryRequireQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniCategoryRequireQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_category_require_query_default_response' description: 请求失败 summary: 查询类目所需资质信息 tags: - alipay.open.mini.category.require x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/experience/cancel: post: description: 版本号为空 operationId: alipay.open.mini.experience.cancel requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniExperienceCancelModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniExperienceCancelResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_experience_cancel_default_response' description: 请求失败 summary: 小程序取消体验版 tags: - alipay.open.mini.experience x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/experience/create: post: description: 小程序生成体验版 operationId: alipay.open.mini.experience.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniExperienceCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniExperienceCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_experience_create_default_response' description: 请求失败 summary: 小程序生成体验版 tags: - alipay.open.mini.experience x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/experience/query: get: description: 小程序体验版状态查询接口 operationId: alipay.open.mini.experience.query parameters: - description: 商家小程序版本号。 explode: true in: query name: app_version required: false schema: example: 0.0.1 type: string style: form - description: "小程序客户端类型,默认为支付宝端。常见支持如下客户端:\tcom.alipay.alipaywallet:支付宝端;\t\ com.alibaba.android.rimet:DINGDING端;\tcom.amap.app:高德端;\tcom.alibaba.ailabs.genie.webapps:\ 天猫精灵端;\tcom.alipay.iot.xpaas:支付宝IoT端。\t如需更多端投放,请联系业务BD。" explode: true in: query name: bundle_id required: false schema: example: com.alipay.alipaywallet type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniExperienceQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_experience_query_default_response' description: 请求失败 summary: 小程序体验版状态查询接口 tags: - alipay.open.mini.experience x-accepts: application/json /v3/alipay/open/mini/individual/business/certify: post: description: 小程序场景下,个体工商户具有和企业账户相同的能力,通过本接口,可以将符合资质的个人账户升级为个体工商户 operationId: alipay.open.mini.individual.business.certify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniIndividualBusinessCertifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniIndividualBusinessCertifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_individual_business_certify_default_response' description: 请求失败 summary: 个人账户升级为个体工商户 tags: - alipay.open.mini.individual.business x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/inner/experience/cancel: post: description: 提供给内部一二方用于取消体验版 operationId: alipay.open.mini.inner.experience.cancel requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerExperienceCancelModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerExperienceCancelResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_inner_experience_cancel_default_response' description: 请求失败 summary: 内部链路取消体验版 tags: - alipay.open.mini.inner.experience x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/inner/members/add: post: description: 添加开发成员 operationId: alipay.open.mini.inner.members.add requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerMembersAddModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerMembersAddResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_inner_members_add_default_response' description: 请求失败 summary: 内部链路添加开发成员 tags: - alipay.open.mini.inner.members x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/inner/members/delete: delete: description: 删除开发成员 operationId: alipay.open.mini.inner.members.delete parameters: - description: 业务小程序id explode: true in: query name: mini_app_id required: false schema: example: "2021154987463214" type: string style: form - description: 业务来源 explode: true in: query name: app_origin required: false schema: example: ALIPAY type: string style: form - description: 域账号(如传入则删除联系人) explode: true in: query name: domain_account required: false schema: example: 域账号 type: string style: form - description: 登陆支付宝账号 explode: true in: query name: login_id required: false schema: example: 登陆支付宝账号 type: string style: form - description: 成员类型 explode: true in: query name: type required: false schema: example: "1" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerMembersDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_inner_members_delete_default_response' description: 请求失败 summary: 内部链路删除开发成员 tags: - alipay.open.mini.inner.members x-accepts: application/json /v3/alipay/open/mini/inner/members/query: get: description: 内部链路查询开发成员 operationId: alipay.open.mini.inner.members.query parameters: - description: 业务小程序id explode: true in: query name: mini_app_id required: false schema: example: "2021125487896547" type: string style: form - description: 业务来源 explode: true in: query name: app_origin required: false schema: example: ALIPAY type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerMembersQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_inner_members_query_default_response' description: 请求失败 summary: 内部链路查询开发成员 tags: - alipay.open.mini.inner.members x-accepts: application/json /v3/alipay/open/mini/innerapp/create: post: description: 小程序提供一套针对一二方场景的开发者提供一套统一的内部能力开放体系,定向输出赋能 operationId: alipay.open.mini.innerapp.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerappCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerappCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerapp_create_default_response' description: 请求失败 summary: 内部链路小程序创建 tags: - alipay.open.mini.innerapp x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerapp/plugin/order: post: description: 提供给二方场景下,代商家小程序订购、授权与签约插件 operationId: alipay.open.mini.innerapp.plugin.order requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerappPluginOrderModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerappPluginOrderResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerapp_plugin_order_default_response' description: 请求失败 summary: 小程序代商户订购插件 tags: - alipay.open.mini.innerapp.plugin x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerapp/pluginrelation/query: post: description: 查询插件引用关系 operationId: alipay.open.mini.innerapp.pluginrelation.query requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerappPluginrelationQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerappPluginrelationQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerapp_pluginrelation_query_default_response' description: 请求失败 summary: 查询插件引用关系 tags: - alipay.open.mini.innerapp.pluginrelation x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerapp/pluginservice/publish: post: description: 插件发布能力中心 operationId: alipay.open.mini.innerapp.pluginservice.publish requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerappPluginservicePublishModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerappPluginservicePublishResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerapp_pluginservice_publish_default_response' description: 请求失败 summary: 插件发布能力中心 tags: - alipay.open.mini.innerapp.pluginservice x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerapp/pluginsyncmode/modify: post: description: 修改插件继承模式,模板和插件使用关系是否自动继承到宿主小程序上 operationId: alipay.open.mini.innerapp.pluginsyncmode.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerappPluginsyncmodeModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerappPluginsyncmodeModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerapp_pluginsyncmode_modify_default_response' description: 请求失败 summary: 修改插件继承模式 tags: - alipay.open.mini.innerapp.pluginsyncmode x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerapp/pluginuseconfig/cancel: post: description: 结束插件端版本配置灰度 operationId: alipay.open.mini.innerapp.pluginuseconfig.cancel requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerappPluginuseconfigCancelModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerappPluginuseconfigCancelResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerapp_pluginuseconfig_cancel_default_response' description: 请求失败 summary: 撤销插件端版本配置灰度 tags: - alipay.open.mini.innerapp.pluginuseconfig x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerapp/pluginuseconfig/online: post: description: 小程序使用插件版本全量上线 operationId: alipay.open.mini.innerapp.pluginuseconfig.online requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerappPluginuseconfigOnlineModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerappPluginuseconfigOnlineResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerapp_pluginuseconfig_online_default_response' description: 请求失败 summary: 上线插件使用端版本配置 tags: - alipay.open.mini.innerapp.pluginuseconfig x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerapp/pluginuseconfig/upgrade: post: description: 升级/降级 端版本配置 operationId: alipay.open.mini.innerapp.pluginuseconfig.upgrade requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerappPluginuseconfigUpgradeModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerappPluginuseconfigUpgradeResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerapp_pluginuseconfig_upgrade_default_response' description: 请求失败 summary: 灰度端版本配置 tags: - alipay.open.mini.innerapp.pluginuseconfig x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerapp/service/publish: post: description: 小程序提供一套针对一二方场景的开发者提供一套统一的内部能力开放体系,定向输出赋能 operationId: alipay.open.mini.innerapp.service.publish requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerappServicePublishModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerappServicePublishResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerapp_service_publish_default_response' description: 请求失败 summary: 小程序模板发布服务市场 tags: - alipay.open.mini.innerapp.service x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerapp/service/query: get: description: 小程序服务市场搜索,包括搜索模板和插件 operationId: alipay.open.mini.innerapp.service.query parameters: - description: 插件id或模板id explode: true in: query name: mini_app_id required: false schema: example: "2012211102012056" type: string style: form - description: 小程序应用子类型 explode: true in: query name: app_sub_type required: false schema: example: TINYAPP_TEMPLATE、TINYAPP_PLUGIN type: string style: form - description: 是否在服务市场透出,SHOW展示、HIDE隐藏 explode: true in: query name: show_type required: false schema: example: SHOW type: string style: form - description: 关键词 explode: true in: query name: keyword required: false schema: example: xxxx插件 type: string style: form - description: 页码,默认第一页 explode: true in: query name: page_num required: false schema: example: "1" type: string style: form - description: 分页数,默认每页10个 explode: true in: query name: page_size required: false schema: example: "10" type: string style: form - description: 业务来源,新接入方需要向支付宝申请专用来源,否则不予接入。https://yuque.antfin-inc.com/tinyapp-all/qddncu/bidushixiang explode: true in: query name: app_origin required: false schema: example: https://yuque.antfin-inc.com/tinyapp-all/qddncu/bidushixiang type: string style: form - description: 是否需要展示offline状态插件,不传默认为false(不展示) explode: true in: query name: include_offline required: false schema: example: true type: boolean style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerappServiceQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerapp_service_query_default_response' description: 请求失败 summary: 小程序服务市场搜索 tags: - alipay.open.mini.innerapp.service x-accepts: application/json /v3/alipay/open/mini/innerbaseinfo/applogo/upload: post: description: 上传小程序logo图片 operationId: alipay.open.mini.innerbaseinfo.applogo.upload requestBody: content: multipart/form-data: encoding: app_logo: contentType: '*/*' style: form schema: $ref: '#/components/schemas/alipay_open_mini_innerbaseinfo_applogo_upload_request' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerbaseinfoApplogoUploadResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerbaseinfo_applogo_upload_default_response' description: 请求失败 summary: 内部小程序-小程序logo图片上传 tags: - alipay.open.mini.innerbaseinfo.applogo x-content-type: multipart/form-data x-accepts: application/json /v3/alipay/open/mini/innerbaseinfo/query: get: description: 查询小程序应用信息 operationId: alipay.open.mini.innerbaseinfo.query parameters: - description: 小程序ID,mini_app_id 和 mini_app_name 两个需要有其中一个必填,当填了mini_app_id时只使用id去进行查询。 explode: true in: query name: mini_app_id required: false schema: example: "2014060600164699" type: string style: form - description: 租户code,alipay or taobao explode: true in: query name: inst_code required: false schema: example: taobao type: string style: form - description: 小程序name,mini_app_id 和 mini_app_name 两个需要有其中一个必填,当填了mini_app_id时只使用id去进行查询。 explode: true in: query name: mini_app_name required: false schema: example: test type: string style: form - description: 小程序类型,TINYAPP_TEMPLATE,TINYAPP_NORMAL,TINYAPP_PLUGIN,使用mini_app_name查询的时候,该字段要求必传。 explode: true in: query name: app_sub_type required: false schema: example: TINYAPP_TEMPLATE type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerbaseinfoQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerbaseinfo_query_default_response' description: 请求失败 summary: 内部小程序-应用信息查询 tags: - alipay.open.mini.innerbaseinfo x-accepts: application/json /v3/alipay/open/mini/innerversion/audit/cancel: post: description: 小程序提供一套针对一二方场景的开发者提供一套统一的内部能力开放体系,定向输出赋能 operationId: alipay.open.mini.innerversion.audit.cancel requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionAuditCancelModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionAuditCancelResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_audit_cancel_default_response' description: 请求失败 summary: 内部链路撤销审核 tags: - alipay.open.mini.innerversion.audit x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerversion/audit/submit: post: description: 小程序版本提交审核,审核申请完结后会通过From蚂蚁消息通知到开发者。 operationId: alipay.open.mini.innerversion.audit.submit requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionAuditSubmitModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionAuditSubmitResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_audit_submit_default_response' description: 请求失败 summary: 小程序版本提交审核 tags: - alipay.open.mini.innerversion.audit x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerversion/backdev/publish: post: description: 小程序提供一套针对一二方场景的开发者提供一套统一的内部能力开放体系,定向输出赋能 operationId: alipay.open.mini.innerversion.backdev.publish requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionBackdevPublishModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionBackdevPublishResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_backdev_publish_default_response' description: 请求失败 summary: 内部链路小程序退回开发 tags: - alipay.open.mini.innerversion.backdev x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerversion/beta/confirm: post: description: 小程序确认邀测结果 operationId: alipay.open.mini.innerversion.beta.confirm requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionBetaConfirmModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionBetaConfirmResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_beta_confirm_default_response' description: 请求失败 summary: 确认邀测结果 tags: - alipay.open.mini.innerversion.beta x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerversion/betainfo/query: get: description: "查看插件可邀测版本状态,邀测结果" operationId: alipay.open.mini.innerversion.betainfo.query parameters: - description: 插件ID explode: true in: query name: plugin_id required: false schema: example: 2021xxxx type: string style: form - description: 端信息 explode: true in: query name: bundle_id required: false schema: example: com.alipay.alipaywallet type: string style: form - description: 查询版本号 explode: true in: query name: plugin_version required: false schema: example: 0.0.1 type: string style: form - description: 业务来源 explode: true in: query name: app_origin required: false schema: example: ASTORE type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionBetainfoQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_betainfo_query_default_response' description: 请求失败 summary: 查看可邀测状态接口 tags: - alipay.open.mini.innerversion.betainfo x-accepts: application/json /v3/alipay/open/mini/innerversion/buildaudit/submit: post: description: 内部链路小程序构建并提审 operationId: alipay.open.mini.innerversion.buildaudit.submit requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionBuildauditSubmitModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionBuildauditSubmitResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_buildaudit_submit_default_response' description: 请求失败 summary: 内部链路小程序构建并提审 tags: - alipay.open.mini.innerversion.buildaudit x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerversion/condition/batchquery: post: description: 小程序提供一套针对一二方场景的开发者提供一套统一的内部能力开放体系,定向输出赋能 operationId: alipay.open.mini.innerversion.condition.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionConditionBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionConditionBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_condition_batchquery_default_response' description: 请求失败 summary: 根据状态批量查询版本信息 tags: - alipay.open.mini.innerversion.condition x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerversion/content/rollback: post: description: | 针对一二方场景的开发者,小程序提供一套统一的内部能力体系,定向输出赋能,本接口主要用于回滚版本 operationId: alipay.open.mini.innerversion.content.rollback requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionContentRollbackModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionContentRollbackResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_content_rollback_default_response' description: 请求失败 summary: 内部链路回滚版本 tags: - alipay.open.mini.innerversion.content x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerversion/gray/finish: post: description: 小程序提供一套针对一二方场景的开发者提供一套统一的内部能力开放体系,定向输出赋能 operationId: alipay.open.mini.innerversion.gray.finish requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionGrayFinishModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionGrayFinishResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_gray_finish_default_response' description: 请求失败 summary: 内部链路结束灰度 tags: - alipay.open.mini.innerversion.gray x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerversion/gray/publish: post: description: 小程序提供一套针对一二方场景的开发者提供一套统一的内部能力开放体系,定向输出赋能 operationId: alipay.open.mini.innerversion.gray.publish requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionGrayPublishModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionGrayPublishResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_gray_publish_default_response' description: 请求失败 summary: 内部链路小程序灰度上架 tags: - alipay.open.mini.innerversion.gray x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerversion/info/delete: delete: description: 针对一二方场景的开发者,小程序提供一套统一的内部能力体系,定向输出赋能,本接口主要用于删除版本 operationId: alipay.open.mini.innerversion.info.delete parameters: - description: 小程序ID explode: true in: query name: mini_app_id required: false schema: example: 2018******** type: string style: form - description: 业务场景来源 explode: true in: query name: app_origin required: false schema: example: ASTORE type: string style: form - description: 端信息 explode: true in: query name: bundle_id required: false schema: example: com.alipay.alipaywallet type: string style: form - description: 小程序版本号 explode: true in: query name: app_version required: false schema: example: 0.0.1 type: string style: form - description: 操作者ID,支付宝租户必填 explode: true in: query name: pid required: false schema: example: 2088******* type: string style: form - description: 租户信息 explode: true in: query name: inst_code required: false schema: example: alipay type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionInfoDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_info_delete_default_response' description: 请求失败 summary: 内部链路删除版本 tags: - alipay.open.mini.innerversion.info x-accepts: application/json /v3/alipay/open/mini/innerversion/info/query: get: description: 小程序提供一套针对一二方场景的开发者提供一套统一的内部能力开放体系,定向输出赋能 operationId: alipay.open.mini.innerversion.info.query parameters: - description: 端信息 explode: true in: query name: bundle_id required: false schema: example: 支付宝:com.alipay.alipaywallet 高德:com.amap.app type: string style: form - description: 小程序ID explode: true in: query name: mini_app_id required: false schema: example: 2019**** type: string style: form - description: 查询版本号 explode: true in: query name: app_version required: false schema: example: 0.0.1 type: string style: form - description: 业务来源,新接入方需要向支付宝申请专用来源,否则不予接入。https://yuque.antfin-inc.com/tinyapp-all/qddncu/bidushixiang explode: true in: query name: app_origin required: false schema: example: https://yuque.antfin-inc.com/tinyapp-all/qddncu/bidushixiang type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionInfoQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_info_query_default_response' description: 请求失败 summary: 内部链路小程序版本信息查询 tags: - alipay.open.mini.innerversion.info x-accepts: application/json /v3/alipay/open/mini/innerversion/instantiation/query: get: description: 用于通过模板实例化的小程序版本查询实例化关系 operationId: alipay.open.mini.innerversion.instantiation.query parameters: - description: 来源类型,新接入方需要向支付宝申请专用来源,否则不予接入,申请方式请参见接入手册。 explode: true in: query name: app_origin required: false schema: example: AAA type: string style: form - description: 端id explode: true in: query name: bundle_id required: false schema: example: com.alipay.alipaywallet type: string style: form - description: 小程序ID,特殊场景专用,普通业务方无需关注该参数。 explode: true in: query name: mini_app_id required: false schema: example: "2021000116680014" type: string style: form - description: 实例化小程序版本号 explode: true in: query name: app_version required: false schema: example: 0.0.1 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionInstantiationQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_instantiation_query_default_response' description: 请求失败 summary: 小程序实例化关系查询 tags: - alipay.open.mini.innerversion.instantiation x-accepts: application/json /v3/alipay/open/mini/innerversion/last/query: get: description: | 针对一二方场景的开发者,小程序提供一套统一的内部能力体系,定向输出赋能,本接口主要用于查询最新版本号 operationId: alipay.open.mini.innerversion.last.query parameters: - description: 小程序ID,仅特殊场景使用,普通业务方无需关注该参数。 explode: true in: query name: mini_app_id required: false schema: example: 2018******** type: string style: form - description: 端信息 explode: true in: query name: bundle_id required: false schema: example: com.alipay.alipaywallet type: string style: form - description: 业务来源场景 explode: true in: query name: app_origin required: false schema: example: AAA type: string style: form - description: 小程序主体 explode: true in: query name: pid required: false schema: example: 2088******* type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionLastQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_last_query_default_response' description: 请求失败 summary: 内部链路查询最新版本号 tags: - alipay.open.mini.innerversion.last x-accepts: application/json /v3/alipay/open/mini/innerversion/modelforoffline/query: get: description: 用于查询线上的版本包数据,同步到线下 operationId: alipay.open.mini.innerversion.modelforoffline.query parameters: - description: 小程序ID explode: true in: query name: mini_app_id required: false schema: example: 2018******** type: string style: form - description: 版本号 explode: true in: query name: app_version required: false schema: example: 0.0.1 type: string style: form - description: com.alipay.alipaywallet:支付包 explode: true in: query name: bundle_id required: false schema: example: com.alipay.alipaywallet type: string style: form - description: alipay:支付宝 explode: true in: query name: inst_code required: false schema: example: alipay type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionModelforofflineQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_modelforoffline_query_default_response' description: 请求失败 summary: 小程序线上版本包数据同步线下场景查询 tags: - alipay.open.mini.innerversion.modelforoffline x-accepts: application/json /v3/alipay/open/mini/innerversion/nobuild/upload: post: description: 手淘小程序产物包免构建版本上传 operationId: alipay.open.mini.innerversion.nobuild.upload requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionNobuildUploadModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionNobuildUploadResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_nobuild_upload_default_response' description: 请求失败 summary: 手淘小程序产物包免构建版本上传 tags: - alipay.open.mini.innerversion.nobuild x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerversion/offline/publish: post: description: 小程序提供一套针对一二方场景的开发者提供一套统一的内部能力开放体系,定向输出赋能 operationId: alipay.open.mini.innerversion.offline.publish requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionOfflinePublishModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionOfflinePublishResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_offline_publish_default_response' description: 请求失败 summary: 内部链路小程序下架 tags: - alipay.open.mini.innerversion.offline x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerversion/online: post: description: 内部小程序上架接口 operationId: alipay.open.mini.innerversion.online requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionOnlineModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionOnlineResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_online_default_response' description: 请求失败 summary: 内部小程序-上架 tags: - alipay.open.mini.innerversion x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerversion/online/publish: post: description: 小程序提供一套针对一二方场景的开发者提供一套统一的内部能力开放体系,定向输出赋能 operationId: alipay.open.mini.innerversion.online.publish requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionOnlinePublishModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionOnlinePublishResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_online_publish_default_response' description: 请求失败 summary: 内部链路小程序上架 tags: - alipay.open.mini.innerversion.online x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerversion/package/create: post: description: 内部OPENAPI 单独构建包信息。将构建链路中打预发包逻辑抽离出来,成为单独的能力,让伙伴等业务自己来调用 operationId: alipay.open.mini.innerversion.package.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionPackageCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionPackageCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_package_create_default_response' description: 请求失败 summary: 单独构建包信息 tags: - alipay.open.mini.innerversion.package x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerversion/sync: post: description: 小程序上架、回滚,因拉包机制,用户无法及时生效,拉到原版本的用户,过期才会失效,该接口能力可以推送新版本到用户 operationId: alipay.open.mini.innerversion.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_sync_default_response' description: 请求失败 summary: 小程序包信息推送 tags: - alipay.open.mini.innerversion x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerversion/templated/upload: post: description: 基于模板构建实例化小程序,同步接口,调用成功表示创建版本成功 operationId: alipay.open.mini.innerversion.templated.upload requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionTemplatedUploadModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionTemplatedUploadResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_templated_upload_default_response' description: 请求失败 summary: 基于模板构建版本 tags: - alipay.open.mini.innerversion.templated x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerversion/upgrade: post: description: 升级基于模板实例化的小程序,升级后不需要重新提交审核;同步接口。 operationId: alipay.open.mini.innerversion.upgrade requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionUpgradeModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionUpgradeResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_upgrade_default_response' description: 请求失败 summary: 升级模板实例化小程序 tags: - alipay.open.mini.innerversion x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerversion/upload: post: description: 内部小程序,创建打包构建任务,异步返回,使用查询接口轮询构建结果 operationId: alipay.open.mini.innerversion.upload requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionUploadModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionUploadResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_upload_default_response' description: 请求失败 summary: 内部小程序-打包构建 tags: - alipay.open.mini.innerversion x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/innerversion/uploadstatus/query: get: description: 查询构建状态 operationId: alipay.open.mini.innerversion.uploadstatus.query parameters: - description: 包管理ID,用于查询打包状态 explode: true in: query name: build_package_id required: false schema: example: "34818" type: string style: form - description: 小程序ID explode: true in: query name: mini_app_id required: false schema: example: "2018012201365222" type: string style: form - description: 小程序版本 explode: true in: query name: build_version required: false schema: example: 0.0.5 type: string style: form - description: 租户id explode: true in: query name: inst_code required: false schema: example: taobao type: string style: form - description: 端信息 explode: true in: query name: bundle_id required: false schema: example: com.taobao.app type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniInnerversionUploadstatusQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_innerversion_uploadstatus_query_default_response' description: 请求失败 summary: 多端小程序-查询构建状态 tags: - alipay.open.mini.innerversion.uploadstatus x-accepts: application/json /v3/alipay/open/mini/isv/create: post: description: |- 服务商代商家创建小程序,待商家确认后服务商代创建的小程序才会生效,若商家超过确认时间则服务商创建的小程序会自动作废释放占用的小程序名称。 将 is_individual 设置为 true,并且同时传入 license_pic。将同时对具备个体工商户营业执照的商家个人账号认证成为个体工商户账号(创建小程序+升级个体工商户账号一体化)。 operationId: alipay.open.mini.isv.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniIsvCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniIsvCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_isv_create_default_response' description: 请求失败 summary: isv服务商代商户创建小程序 tags: - alipay.open.mini.isv x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/isv/fastregister/create: post: description: ISV代商户创建试用小程序 operationId: alipay.open.mini.isv.fastregister.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniIsvFastregisterCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniIsvFastregisterCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_isv_fastregister_create_default_response' description: 请求失败 summary: ISV代创建试用小程序 tags: - alipay.open.mini.isv.fastregister x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/isv/fastregister/query: get: description: 查询试用小程序 operationId: alipay.open.mini.isv.fastregister.query parameters: - description: 代创建试用小程序单号 explode: true in: query name: order_no required: false schema: example: "2202121278786786768" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniIsvFastregisterQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_isv_fastregister_query_default_response' description: 请求失败 summary: 查询试用小程序 tags: - alipay.open.mini.isv.fastregister x-accepts: application/json /v3/alipay/open/mini/isv/query: get: description: isv查询代商家创建小程序记录 operationId: alipay.open.mini.isv.query parameters: - description: 服务商代商家创建小程序,由支付宝开放平台返回的订单号用于后续查询处理进展。 explode: true in: query name: order_no required: false schema: example: "2394834823942343" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniIsvQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_isv_query_default_response' description: 请求失败 summary: isv查询代商家创建小程序记录 tags: - alipay.open.mini.isv x-accepts: application/json /v3/alipay/open/mini/miniapp/brand/cancel: post: description: 小程序品牌提交认证后取消品牌认证 operationId: alipay.open.mini.miniapp.brand.cancel responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniMiniappBrandCancelResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_miniapp_brand_cancel_default_response' description: 请求失败 summary: 小程序品牌提交认证后取消品牌认证 tags: - alipay.open.mini.miniapp.brand x-accepts: application/json /v3/alipay/open/mini/miniapp/brand/query: get: description: 小程序品牌提交认证后查询品牌审核结果以及商户已有品牌 operationId: alipay.open.mini.miniapp.brand.query responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniMiniappBrandQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_miniapp_brand_query_default_response' description: 请求失败 summary: 小程序品牌提交认证后查询品牌审核结果以及商户已有品牌 tags: - alipay.open.mini.miniapp.brand x-accepts: application/json /v3/alipay/open/mini/miniapp/brand/submit: post: description: 小程序品牌提交认证 operationId: alipay.open.mini.miniapp.brand.submit requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniMiniappBrandSubmitModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniMiniappBrandSubmitResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_miniapp_brand_submit_default_response' description: 请求失败 summary: 小程序品牌提交认证 tags: - alipay.open.mini.miniapp.brand x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/miniapp/brand/upload: post: description: 小程序品牌提交认证时上传用户资质以及身份信息 operationId: alipay.open.mini.miniapp.brand.upload requestBody: content: multipart/form-data: encoding: file_content: contentType: '*/*' style: form schema: $ref: '#/components/schemas/alipay_open_mini_miniapp_brand_upload_request' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniMiniappBrandUploadResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_miniapp_brand_upload_default_response' description: 请求失败 summary: 小程序品牌提交认证时上传用户资质以及身份信息 tags: - alipay.open.mini.miniapp.brand x-content-type: multipart/form-data x-accepts: application/json /v3/alipay/open/mini/miniapp/serviceconfig/modify: post: description: 小程序设置客服方式 operationId: alipay.open.mini.miniapp.serviceconfig.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniMiniappServiceconfigModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniMiniappServiceconfigModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_miniapp_serviceconfig_modify_default_response' description: 请求失败 summary: 小程序设置客服方式 tags: - alipay.open.mini.miniapp.serviceconfig x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/qrcode/bind: post: description: 商户可不需更换线下二维码,通过该接口完成配置后,用户用支付宝扫描普通二维码时打开小程序并跳转到指定页面,普通二维码关联小程序最多可设置20条规则。 operationId: alipay.open.mini.qrcode.bind requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniQrcodeBindModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniQrcodeBindResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_qrcode_bind_default_response' description: 请求失败 summary: 关联普通二维码 tags: - alipay.open.mini.qrcode x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/qrcode/query: get: description: 通过appId查询商户关联的普通二维码路由信息 operationId: alipay.open.mini.qrcode.query parameters: - description: 页码 explode: true in: query name: page_no required: false schema: example: 1 type: integer style: form - description: 每页条数,最大为10 explode: true in: query name: page_size required: false schema: example: 10 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniQrcodeQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_qrcode_query_default_response' description: 请求失败 summary: 查询普通二维码 tags: - alipay.open.mini.qrcode x-accepts: application/json /v3/alipay/open/mini/qrcode/unbind: post: description: 删除已关联普通二维码 operationId: alipay.open.mini.qrcode.unbind requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniQrcodeUnbindModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniQrcodeUnbindResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_qrcode_unbind_default_response' description: 请求失败 summary: 删除已关联普通二维码 tags: - alipay.open.mini.qrcode x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/resource/promotionsource/notify: post: description: 淘联盟定制回调接口,用户流量插件账号打通场景 operationId: alipay.open.mini.resource.promotionsource.notify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniResourcePromotionsourceNotifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniResourcePromotionsourceNotifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_resource_promotionsource_notify_default_response' description: 请求失败 summary: 提供给淘联盟推广位信息接口 tags: - alipay.open.mini.resource.promotionsource x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/resource/record/notify: post: description: 淘联盟定制回调接口,用户流量插件账号打通场景 operationId: alipay.open.mini.resource.record.notify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniResourceRecordNotifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniResourceRecordNotifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_resource_record_notify_default_response' description: 请求失败 summary: 提供给淘联盟备案信息接口 tags: - alipay.open.mini.resource.record x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/safedomain/create: post: description: 小程序添加域白名单 operationId: alipay.open.mini.safedomain.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniSafedomainCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniSafedomainCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_safedomain_create_default_response' description: 请求失败 summary: 小程序添加域白名单 tags: - alipay.open.mini.safedomain x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/safedomain/delete: delete: description: 小程序删除域白名单 operationId: alipay.open.mini.safedomain.delete parameters: - description: "服务器域名白名单。支付宝小程序在HTTP请求、上传文件等场景只能与域名白名单中的域名进行通讯 。\t删除域白名单后需重新\ 上传应用版本(模板模式下小程序模板及商家应用都需重新上传、实例化版本)才会生效。老版本应用继续使用老版本名单(即删除域名可继续使用)。" explode: true in: query name: safe_domain required: false schema: example: example.com type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniSafedomainDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_safedomain_delete_default_response' description: 请求失败 summary: 小程序删除域白名单 tags: - alipay.open.mini.safedomain x-accepts: application/json /v3/alipay/open/mini/template/marketing/create: post: description: 小程序消息运营位创建 operationId: alipay.open.mini.template.marketing.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniTemplateMarketingCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniTemplateMarketingCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_template_marketing_create_default_response' description: 请求失败 summary: 小程序消息运营位创建 tags: - alipay.open.mini.template.marketing x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/template/usage/query: get: description: 查询使用模板的小程序列表 operationId: alipay.open.mini.template.usage.query parameters: - description: 小程序模板APPID explode: true in: query name: template_id required: false schema: example: "1" type: string style: form - description: 查询的页数,起始为 1(第一页) 。默认第一页。 explode: true in: query name: page_num required: false schema: example: 1 type: integer style: form - description: 每页的数量,最多查询50个,默认查询10个 explode: true in: query name: page_size required: false schema: example: 10 type: integer style: form - description: 模板小程序的版本号 explode: true in: query name: template_version required: false schema: example: 0.0.1 type: string style: form - description: "小程序客户端类型,默认为支付宝端。常见支持如下客户端:\tcom.alipay.alipaywallet:支付宝端;\t\ com.alibaba.android.rimet:DINGDING端;\tcom.amap.app:高德端;\tcom.alibaba.ailabs.genie.webapps:\ 天猫精灵端;\tcom.alipay.iot.xpaas:支付宝IoT端。\t如需更多端投放,请联系业务BD。" explode: true in: query name: bundle_id required: false schema: example: com.alipay.alipaywallet type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniTemplateUsageQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_template_usage_query_default_response' description: 请求失败 summary: 查询使用模板的小程序列表 tags: - alipay.open.mini.template.usage x-accepts: application/json /v3/alipay/open/mini/templatemessage/usertemplate/apply: post: description: 小程序模板消息申请,申请之后可以通过返回的user_template_id来发送模板消息 operationId: alipay.open.mini.templatemessage.usertemplate.apply requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniTemplatemessageUsertemplateApplyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniTemplatemessageUsertemplateApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_templatemessage_usertemplate_apply_default_response' description: 请求失败 summary: 小程序模板消息申请 tags: - alipay.open.mini.templatemessage.usertemplate x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/templatemsg/maketing/batchquery: post: description: 小程序模板消息营销投放详情分页批量查询 operationId: alipay.open.mini.templatemsg.maketing.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniTemplatemsgMaketingBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniTemplatemsgMaketingBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_templatemsg_maketing_batchquery_default_response' description: 请求失败 summary: 小程序模板消息营销投放详情分页批量查询 tags: - alipay.open.mini.templatemsg.maketing x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/templatemsg/maketingstatus/modify: post: description: 小程序模板消息营销投放详情状态修改 operationId: alipay.open.mini.templatemsg.maketingstatus.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniTemplatemsgMaketingstatusModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniTemplatemsgMaketingstatusModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_templatemsg_maketingstatus_modify_default_response' description: 请求失败 summary: 小程序模板消息营销投放详情状态修改 tags: - alipay.open.mini.templatemsg.maketingstatus x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/templatemsg/tinypayswitch/confirm: post: description: 支付消息是用户和商户收款账户之间发生的交易后,由平台代发的消息提醒。通过接口确认后,可在小程序交易的支付消息上透出商户主体和商户小程序入口 operationId: alipay.open.mini.templatemsg.tinypayswitch.confirm responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniTemplatemsgTinypayswitchConfirmResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_templatemsg_tinypayswitch_confirm_default_response' description: 请求失败 summary: 小程序支付消息确认接口 tags: - alipay.open.mini.templatemsg.tinypayswitch x-accepts: application/json /v3/alipay/open/mini/tips/delivery/batchquery: post: description: 小程序收藏引导投放活动配置批量查询接口,获取该小程序下所有活动配置及状态信息。 operationId: alipay.open.mini.tips.delivery.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniTipsDeliveryBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniTipsDeliveryBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_tips_delivery_batchquery_default_response' description: 请求失败 summary: 小程序收藏引导投放活动配置批量查询 tags: - alipay.open.mini.tips.delivery x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/tips/delivery/create: post: description: | 小程序收藏引导投放活动配置创建。通过配置有效的小程序收藏引导(tips)文案,创建小程序收藏引导活动。用户在活动有效期内等于相应页面,将展示配置的个性化文案,帮助用户收藏小程序。请结合您的小程序及页面,配置个性化文案。 operationId: alipay.open.mini.tips.delivery.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniTipsDeliveryCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniTipsDeliveryCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_tips_delivery_create_default_response' description: 请求失败 summary: 小程序收藏引导投放活动配置创建 tags: - alipay.open.mini.tips.delivery x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/tips/delivery/modify: post: description: 小程序收藏引导投放活动修改接口,目前支持活动状态的修改,包括暂停、恢复、终止单个收藏引导活动。 operationId: alipay.open.mini.tips.delivery.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniTipsDeliveryModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniTipsDeliveryModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_tips_delivery_modify_default_response' description: 请求失败 summary: 小程序收藏引导投放活动修改 tags: - alipay.open.mini.tips.delivery x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/tips/delivery/query: get: description: 小程序收藏引导投放活动配置详情查询接口,获取当前活动ID对应活动的配置及状态信息。 operationId: alipay.open.mini.tips.delivery.query parameters: - description: 收藏引导投放活动ID,查询收藏引导活动必填参数 explode: true in: query name: delivery_id required: false schema: example: "20211114000003057595" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniTipsDeliveryQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_tips_delivery_query_default_response' description: 请求失败 summary: 小程序收藏引导投放活动详情查询 tags: - alipay.open.mini.tips.delivery x-accepts: application/json /v3/alipay/open/mini/tips/statistic/query: get: description: 小程序收藏引导tips文案投放汇总数据查询接口。可查询小程序维度或活动维度的tips曝光uv,收藏uv,以及收藏转化率。请先配置投放活动,否则查询结果返回参数为空。 operationId: alipay.open.mini.tips.statistic.query parameters: - description: "收藏引导投放活动ID,供查询收藏引导活动配置接口调用\t,当以小程序维度查询数据(query_type为app)时delivery_id为\ 空" explode: true in: query name: delivery_id required: false schema: example: "20220308000000934758" type: string style: form - description: 查询类型,表示以当前维度进行数据聚合。 explode: true in: query name: query_type required: false schema: example: app type: string style: form - description: 查询开始日期,精度为天 explode: true in: query name: start_date required: false schema: example: "20220322" type: string style: form - description: 查询截止日期,精度为天 explode: true in: query name: end_date required: false schema: example: "20220328" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniTipsStatisticQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_tips_statistic_query_default_response' description: 请求失败 summary: 小程序收藏引导汇总数据查询 tags: - alipay.open.mini.tips.statistic x-accepts: application/json /v3/alipay/open/mini/version/audit/apply: post: description: |- 小程序提交审核。 1、本接口中关于小程序基础信息的一些字段例如小程序名称、小程序logo、客服电话等,这些信息如果你前期已经设置过,平台将会在你本次调用接口的时候,将上一次设置的信息自动填入,所以允许你本次调用时不传入。如果你前期还未设置过这些信息,则本次调用是需要必传的。具体的字段要求详见每个字段的描述。你可以用alipay.open.mini.version.detail.query接口查询小程序信息之前是否已经设置。 2、小程序版本信息例如小程序版本号、小程序版本描述,这些信息是需要你每次调用接口必传的。 3、本接口涉及到“审核流程拆分”、“审核加急”、“自动上架”的功能,具体功能详见接口字段audit_rule、speed_up、auto_online描述。 4、普通模板构建的商家小程序限 5个小程序/模板/日,可以升级为标准版,标准版没有数量限制。 operationId: alipay.open.mini.version.audit.apply requestBody: content: multipart/form-data: encoding: fifth_license_pic: contentType: '*/*' style: form third_special_license_pic: contentType: '*/*' style: form data: contentType: application/json style: form fifth_screen_shot: contentType: '*/*' style: form first_license_pic: contentType: '*/*' style: form test_file_name: contentType: '*/*' style: form first_special_license_pic: contentType: '*/*' style: form first_screen_shot: contentType: '*/*' style: form second_screen_shot: contentType: '*/*' style: form second_license_pic: contentType: '*/*' style: form app_logo: contentType: '*/*' style: form third_screen_shot: contentType: '*/*' style: form fourth_screen_shot: contentType: '*/*' style: form third_license_pic: contentType: '*/*' style: form out_door_pic: contentType: '*/*' style: form second_special_license_pic: contentType: '*/*' style: form fourth_license_pic: contentType: '*/*' style: form schema: $ref: '#/components/schemas/alipay_open_mini_version_audit_apply_request' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniVersionAuditApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_version_audit_apply_default_response' description: 请求失败 summary: 小程序提交审核 tags: - alipay.open.mini.version.audit x-content-type: multipart/form-data x-accepts: application/json /v3/alipay/open/mini/version/audit/cancel: post: description: 三方实例化小程序撤销审核 operationId: alipay.open.mini.version.audit.cancel requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniVersionAuditCancelModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniVersionAuditCancelResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_version_audit_cancel_default_response' description: 请求失败 summary: 小程序撤销审核 tags: - alipay.open.mini.version.audit x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/version/audited/cancel: post: description: 小程序退回开发 operationId: alipay.open.mini.version.audited.cancel requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniVersionAuditedCancelModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniVersionAuditedCancelResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_version_audited_cancel_default_response' description: 请求失败 summary: 小程序退回开发 tags: - alipay.open.mini.version.audited x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/version/build/query: get: description: 小程序查询版本构建状态 operationId: alipay.open.mini.version.build.query parameters: - description: 小程序版本号 explode: true in: query name: app_version required: false schema: example: 0.0.1 type: string style: form - description: "小程序客户端类型,默认为支付宝端。常见支持如下客户端:\tcom.alipay.alipaywallet:支付宝端;\t\ com.alibaba.android.rimet:DINGDING端;\tcom.amap.app:高德端;\tcom.alibaba.ailabs.genie.webapps:\ 天猫精灵端;\tcom.alipay.iot.xpaas:支付宝IoT端。\t如需更多端投放,请联系业务BD。" explode: true in: query name: bundle_id required: false schema: example: com.alipay.alipaywallet type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniVersionBuildQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_version_build_query_default_response' description: 请求失败 summary: 小程序查询版本构建状态 tags: - alipay.open.mini.version.build x-accepts: application/json /v3/alipay/open/mini/version/delete: post: description: 小程序删除版本 operationId: alipay.open.mini.version.delete requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniVersionDeleteModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniVersionDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_version_delete_default_response' description: 请求失败 summary: 小程序删除版本 tags: - alipay.open.mini.version x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/version/detail/query: get: description: 小程序版本详情查询 operationId: alipay.open.mini.version.detail.query parameters: - description: 小程序版本号 explode: true in: query name: app_version required: false schema: example: 0.0.1 type: string style: form - description: "小程序客户端类型,默认为支付宝端。常见支持如下客户端:\tcom.alipay.alipaywallet:支付宝端;\t\ com.alibaba.android.rimet:DINGDING端;\tcom.amap.app:高德端;\tcom.alibaba.ailabs.genie.webapps:\ 天猫精灵端;\tcom.alipay.iot.xpaas:支付宝IoT端。\t如需更多端投放,请联系业务BD。" explode: true in: query name: bundle_id required: false schema: example: com.alipay.alipaywallet type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniVersionDetailQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_version_detail_query_default_response' description: 请求失败 summary: 小程序版本详情查询 tags: - alipay.open.mini.version.detail x-accepts: application/json /v3/alipay/open/mini/version/gray/cancel: post: description: 小程序结束灰度 operationId: alipay.open.mini.version.gray.cancel requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniVersionGrayCancelModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniVersionGrayCancelResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_version_gray_cancel_default_response' description: 请求失败 summary: 小程序结束灰度 tags: - alipay.open.mini.version.gray x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/version/gray/online: post: description: 小程序灰度上架 operationId: alipay.open.mini.version.gray.online requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniVersionGrayOnlineModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniVersionGrayOnlineResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_version_gray_online_default_response' description: 请求失败 summary: 小程序灰度上架 tags: - alipay.open.mini.version.gray x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/version/list/query: get: description: 根据状态、端分页查询小程序版本基础信息列表,查询结果根据版本号大小降序排列,即0.0.2在前,0.0.1在后。 operationId: alipay.open.mini.version.list.query parameters: - description: "端参数,用于查询多端版本,不传默认为支付宝端。。常见支持如下客户端:\tcom.alipay.alipaywallet:\ 支付宝端;\tcom.alibaba.android.rimet:DINGDING端;\tcom.amap.app:高德端;\tcom.alibaba.ailabs.genie.webapps:\ 天猫精灵端;\tcom.alipay.iot.xpaas:支付宝IoT端。\t如需更多端投放,请联系业务BD。" explode: true in: query name: bundle_id required: false schema: example: com.alipay.alipaywallet type: string style: form - description: "版本状态列表,用英文逗号\",\"分割,可选;不填默认不返回。" explode: true in: query name: version_status required: false schema: example: AUDITING type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniVersionListQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_version_list_query_default_response' description: 请求失败 summary: 小程序版本列表查询 tags: - alipay.open.mini.version.list x-accepts: application/json /v3/alipay/open/mini/version/offline: post: description: 小程序下架 operationId: alipay.open.mini.version.offline requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniVersionOfflineModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniVersionOfflineResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_version_offline_default_response' description: 请求失败 summary: 小程序下架 tags: - alipay.open.mini.version x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/version/online: post: description: 小程序上架 operationId: alipay.open.mini.version.online requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniVersionOnlineModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniVersionOnlineResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_version_online_default_response' description: 请求失败 summary: 小程序上架 tags: - alipay.open.mini.version x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/version/rollback: post: description: 小程序回滚 operationId: alipay.open.mini.version.rollback requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniVersionRollbackModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniVersionRollbackResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_version_rollback_default_response' description: 请求失败 summary: 小程序回滚 tags: - alipay.open.mini.version x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/version/upload: post: description: 小程序基于模板上传版本 operationId: alipay.open.mini.version.upload requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniVersionUploadModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniVersionUploadResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_version_upload_default_response' description: 请求失败 summary: 小程序基于模板上传版本 tags: - alipay.open.mini.version x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/widget/data/sync: post: description: 面向商品售卖类的小程序橱窗,提供的橱窗内展示数据同步能力,同步后会进行文本和图片信息审核,审核完成后通知结果通过openmq消息通知 operationId: alipay.open.mini.widget.data.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniWidgetDataSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniWidgetDataSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_widget_data_sync_default_response' description: 请求失败 summary: 小程序橱窗数据同步 tags: - alipay.open.mini.widget.data x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/widget/goods/modify: patch: description: 面向商品售卖类的小部件,提供的商品信息修改能力,修改后会进行文本和图片信息审核,审核完成后通知结果通过openmq消息通知 operationId: alipay.open.mini.widget.goods.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniWidgetGoodsModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniWidgetGoodsModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_widget_goods_modify_default_response' description: 请求失败 summary: 小部件商品修改 tags: - alipay.open.mini.widget.goods x-content-type: application/json x-accepts: application/json /v3/alipay/open/mini/widget/goods/query: get: description: 面向商品售卖类的小部件,提供商品信息查询能力,返回审核通过的商品信息 operationId: alipay.open.mini.widget.goods.query parameters: - description: 根据承接品的商家小程序ID查询 explode: true in: query name: mini_app_id required: false schema: example: "2017072607907880" type: string style: form - description: 根据承接该品的小程序背后的商家查询 explode: true in: query name: pid required: false schema: example: 2088xxxxxxxxx type: string style: form - description: 根据商品的唯一标识查询 explode: true in: query name: goods_id required: false schema: example: "8948968498" type: string style: form - description: 查询第几页,最小值为1 explode: true in: query name: page_num required: false schema: example: 1 type: integer style: form - description: 查询页面数量,最大值为50 explode: true in: query name: page_size required: false schema: example: 10 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniWidgetGoodsQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_widget_goods_query_default_response' description: 请求失败 summary: 小部件商品查询 tags: - alipay.open.mini.widget.goods x-accepts: application/json /v3/alipay/open/mini/widget/goods/upload: post: description: 面向商品售卖类的小部件,提供的商品信息上传能力,上传后会进行文本和图片信息审核,审核完成后通知结果通过openmq消息通知 operationId: alipay.open.mini.widget.goods.upload requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniWidgetGoodsUploadModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenMiniWidgetGoodsUploadResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_mini_widget_goods_upload_default_response' description: 请求失败 summary: 小部件商品上传 tags: - alipay.open.mini.widget.goods x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/account/create: post: description: 当用户成为商户的关注用户后,可以在商户的服务窗中点击“添加绑定商户会员号”功能,支付宝系统收到操作请求后将该动作通知给商户(使用用户发送信息到商户接口,其中eventType(事件类型)为click,actionParam(按钮标识)为authentication),商户根据此通知调用商户回复消息接口(其中须包含Url链接地址),支付宝收到商户的回复消息中的链接地址后,自动跳转至商户平台的上商户会员绑定界面中,让用户完成账户绑定。 当用户有效完成账户绑定后,商户调用本接口,把绑定结果数据通知给支付宝。 operationId: alipay.open.public.account.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicAccountCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicAccountCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_account_create_default_response' description: 请求失败 summary: 添加绑定商户会员号 tags: - alipay.open.public.account x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/account/delete: delete: description: "在支付宝服务窗中目前一共有三种解除绑定商户会员号的场景,具体如下:\r\n用户取消关注服务窗\r\n用户在服务窗内手动执行解\ 除绑定操作\r\n开发者调用解除绑定商户会员号接口解除绑定" operationId: alipay.open.public.account.delete parameters: - description: 协议号,商户会员在支付宝服务窗账号中的唯一标识,与bind_account_no不能同时为空 explode: true in: query name: agreement_id required: false schema: example: "29022222" type: string style: form - description: 绑定帐号,建议在开发者的系统中保持唯一性,与agreement_id不能同时为空 explode: true in: query name: bind_account_no required: false schema: example: test001 type: string style: form - description: 绑定用户的支付宝userid,2088开头16位长度的字符串,与agreementId不能同时为空 explode: true in: query name: from_user_id required: false schema: example: "2088656734541243" type: string style: form - description: 支付宝用户的唯一标识 explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicAccountDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_account_delete_default_response' description: 请求失败 summary: 解除绑定商户会员号 tags: - alipay.open.public.account x-accepts: application/json /v3/alipay/open/public/account/query: get: description: 当用户成为商户的关注用户之后,则商户可以通过本接口查询关注者的绑定账户,以便补全异常情况下的单边账户数据。 operationId: alipay.open.public.account.query parameters: - description: 用户的支付宝用户号,2088开头。 explode: true in: query name: user_id required: false schema: example: "2088123412341234" type: string style: form - description: 支付宝用户的唯一标识 explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicAccountQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_account_query_default_response' description: 请求失败 summary: 查询绑定商户会员号 tags: - alipay.open.public.account x-accepts: application/json /v3/alipay/open/public/account/reset: post: description: 如果商户想要重置已经添加的外部账户,可以通过该接口完成。重置后,原有的外部户将删除,新的外部户添加进去。 operationId: alipay.open.public.account.reset requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicAccountResetModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicAccountResetResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_account_reset_default_response' description: 请求失败 summary: 重新设置绑定商家会员号 tags: - alipay.open.public.account x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/advert/batchquery: post: description: 可以通过此接口查询所有广告位的配置信息 operationId: alipay.open.public.advert.batchquery responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicAdvertBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_advert_batchquery_default_response' description: 请求失败 summary: 生活号广告位查询接口 tags: - alipay.open.public.advert x-accepts: application/json /v3/alipay/open/public/advert/create: post: description: 可通过本接口在生活号主页添加广告位,根据业务需求配置不同的图片和跳转链接 operationId: alipay.open.public.advert.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicAdvertCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicAdvertCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_advert_create_default_response' description: 请求失败 summary: 生活号广告位添加接口 tags: - alipay.open.public.advert x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/advert/delete: delete: description: 可以通过此接口删除指定广告位的配置信息 operationId: alipay.open.public.advert.delete parameters: - description: 待删除的广告位id explode: true in: query name: advert_id required: false schema: example: "123" type: string style: form - description: 待删除的广告位分组标识 explode: true in: query name: advert_group required: false schema: example: CG202008041013200064690 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicAdvertDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_advert_delete_default_response' description: 请求失败 summary: 生活号广告位删除接口 tags: - alipay.open.public.advert x-accepts: application/json /v3/alipay/open/public/advert/modify: post: description: 可以通过此接口修改指定广告位的配置信息 operationId: alipay.open.public.advert.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicAdvertModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicAdvertModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_advert_modify_default_response' description: 请求失败 summary: 生活号广告位修改接口 tags: - alipay.open.public.advert x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/articlesummary/data/batchquery: post: description: 开发者可以通过图文分析接口查询30天内,所有历史发布的图文消息的数据,包括送达人数、曝光人数、图文阅读人数、分享人数等信息。 operationId: alipay.open.public.articlesummary.data.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicArticlesummaryDataBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicArticlesummaryDataBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_articlesummary_data_batchquery_default_response' description: 请求失败 summary: 图文分析-按时间查询数据接口 tags: - alipay.open.public.articlesummary.data x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/contact/follow/batchquery: post: description: 查询服务窗联系人关注列表 operationId: alipay.open.public.contact.follow.batchquery parameters: - allowEmptyValue: true description: 用户授权令牌 explode: true in: query name: auth_token required: false schema: type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicContactFollowBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_contact_follow_batchquery_default_response' description: 请求失败 summary: 查询服务窗联系人关注列表 tags: - alipay.open.public.contact.follow x-accepts: application/json /v3/alipay/open/public/default/extension/create: post: description: 开发者可使用此接口创建默认扩展区 operationId: alipay.open.public.default.extension.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicDefaultExtensionCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicDefaultExtensionCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_default_extension_create_default_response' description: 请求失败 summary: 默认扩展区创建接口 tags: - alipay.open.public.default.extension x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/follow/batchquery: post: description: 公众号可通过本接口来获取账号的关注者列表,关注者列表由一串userId组成。一次拉取调用最多拉取10000个关注者的userId,可以通过多次拉取的方式来满足需求。 公众号可通过本接口来获取账号的关注者列表,关注者列表由一串userId组成。一次拉取调用最多拉取10000个关注者的userId,可以通过多次拉取的方式来满足需求。 operationId: alipay.open.public.follow.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicFollowBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicFollowBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_follow_batchquery_default_response' description: 请求失败 summary: 获取关注者列表 tags: - alipay.open.public.follow x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/group/batchquery: post: description: 使用该接口查询分组列表,并配合其它分组管理接口使用,最多显示200条 operationId: alipay.open.public.group.batchquery responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicGroupBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_group_batchquery_default_response' description: 请求失败 summary: 查询用户分组列表 tags: - alipay.open.public.group x-accepts: application/json /v3/alipay/open/public/group/create: post: description: 开发者可使用此接口根据指定条件从关注用户中圈定人群生成分组,分组可用于组发消息等场景,分组圈定的人群必须大于50人。 operationId: alipay.open.public.group.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicGroupCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicGroupCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_group_create_default_response' description: 请求失败 summary: 用户分组创建接口 tags: - alipay.open.public.group x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/group/crowd/query: post: description: 用户可以指定自己创建的分组,调用接口查询对应的人群数量,人群必须大于50人才能正常返回,否则报错。 operationId: alipay.open.public.group.crowd.query requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicGroupCrowdQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicGroupCrowdQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_group_crowd_query_default_response' description: 请求失败 summary: 人群数量查询 tags: - alipay.open.public.group.crowd x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/group/delete: delete: description: 调用接口删除用户分组 operationId: alipay.open.public.group.delete parameters: - description: "分组ID,通过alipay.open.public.group.create(用户分组创建接口)\t创建用户分组获取。" explode: true in: query name: group_id required: false schema: example: "100" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicGroupDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_group_delete_default_response' description: 请求失败 summary: 用户分组删除接口 tags: - alipay.open.public.group x-accepts: application/json /v3/alipay/open/public/group/modify: post: description: 调用改接口修改用户分组,仅支持修改分组名称。 operationId: alipay.open.public.group.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicGroupModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicGroupModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_group_modify_default_response' description: 请求失败 summary: 用户分组修改接口 tags: - alipay.open.public.group x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/info/modify: post: description: 提供生活号基础信息修改,同时适用于口碑商户签约当面付2.0默认创建的服务窗,需上传相关资质材料。修改名称、头像、简介会触发风控审核,审核通过后修改生效,支持isv调用 operationId: alipay.open.public.info.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicInfoModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicInfoModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_info_modify_default_response' description: 请求失败 summary: 生活号基础信息修改接口 tags: - alipay.open.public.info x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/info/query: get: description: 提供名称、头像、简介、欢迎语、上下架、审核信息查询,支持isv调用 operationId: alipay.open.public.info.query responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicInfoQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_info_query_default_response' description: 请求失败 summary: 生活号基础信息查询接口 tags: - alipay.open.public.info x-accepts: application/json /v3/alipay/open/public/label/create: post: description: 开发者可以使用该接口创建一个标签,一个服务窗最多同时拥有500个标签,标签名不能重复。 operationId: alipay.open.public.label.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicLabelCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicLabelCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_label_create_default_response' description: 请求失败 summary: 公众号标签管理-添加标签 tags: - alipay.open.public.label x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/label/query: get: description: 开发者可以查询该服务窗所有标签值及拥有该标签的用户个数 operationId: alipay.open.public.label.query responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicLabelQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_label_query_default_response' description: 请求失败 summary: 公众号标签管理-查询标签 tags: - alipay.open.public.label x-accepts: application/json /v3/alipay/open/public/label/user/query: get: description: 开发者可以使用该接口查询某个用户的所有标签 operationId: alipay.open.public.label.user.query parameters: - description: 支付宝用户的userid,2088开头长度为16位的字符串 explode: true in: query name: user_id required: false schema: example: "2088283746283746" type: string style: form - description: 支付宝用户的唯一标识 explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicLabelUserQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_label_user_query_default_response' description: 请求失败 summary: 公众号标签管理-查询用户标签 tags: - alipay.open.public.label.user x-accepts: application/json /v3/alipay/open/public/life/aboard/apply: post: description: 上架生活号 operationId: alipay.open.public.life.aboard.apply responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicLifeAboardApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_life_aboard_apply_default_response' description: 请求失败 summary: 上架生活号 tags: - alipay.open.public.life.aboard x-accepts: application/json /v3/alipay/open/public/life/agentcreate/query: get: description: isv可调用此接口查询代商户创建的生活号审核状态 operationId: alipay.open.public.life.agentcreate.query parameters: - description: 由开发者创建的外部入驻申请单据号,需与alipay.open.public.life.agent.create(isv代创建生活号接口)的out_biz_no一致。 explode: true in: query name: out_biz_no required: false schema: example: "2016070788301823878" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicLifeAgentcreateQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_life_agentcreate_query_default_response' description: 请求失败 summary: isv代创建生活号申请状态查询接口 tags: - alipay.open.public.life.agentcreate x-accepts: application/json /v3/alipay/open/public/life/debark/apply: post: description: 下架生活号 operationId: alipay.open.public.life.debark.apply responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicLifeDebarkApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_life_debark_apply_default_response' description: 请求失败 summary: 下架生活号 tags: - alipay.open.public.life.debark x-accepts: application/json /v3/alipay/open/public/life/label/batchquery: post: description: 开发者可调用该接口查询生活号支持的标签列表,其中包括生活号通用标签、生活号自定义标签以及数据实验室标签。 operationId: alipay.open.public.life.label.batchquery responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicLifeLabelBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_life_label_batchquery_default_response' description: 请求失败 summary: 标签批量查询接口 tags: - alipay.open.public.life.label x-accepts: application/json /v3/alipay/open/public/life/label/create: post: description: 开发者可使用该API创建自定义标签 operationId: alipay.open.public.life.label.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicLifeLabelCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicLifeLabelCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_life_label_create_default_response' description: 请求失败 summary: 创建标签接口 tags: - alipay.open.public.life.label x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/life/label/delete: delete: description: 开发者可调用此API删除自定义标签 operationId: alipay.open.public.life.label.delete parameters: - description: 标签 id,只支持生活号自定义标签。通过 alipay.open.public.life.label.create(创建标签接口)创建自定义标签后获取。 explode: true in: query name: label_id required: false schema: example: "10000" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicLifeLabelDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_life_label_delete_default_response' description: 请求失败 summary: 标签删除接口 tags: - alipay.open.public.life.label x-accepts: application/json /v3/alipay/open/public/life/label/modify: post: description: 开发者可调用此API修改自定义标签的名称 operationId: alipay.open.public.life.label.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicLifeLabelModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicLifeLabelModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_life_label_modify_default_response' description: 请求失败 summary: 标签修改接口 tags: - alipay.open.public.life.label x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/life/msg/recall: post: description: 生活号消息撤回接口 operationId: alipay.open.public.life.msg.recall requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicLifeMsgRecallModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicLifeMsgRecallResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_life_msg_recall_default_response' description: 请求失败 summary: 生活号消息撤回接口 tags: - alipay.open.public.life.msg x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/life/msg/send: post: description: 媒体资讯生活号群发一篇图文或视频类消息,生活号主页以及客户端首页展示消息详情 operationId: alipay.open.public.life.msg.send requestBody: content: multipart/form-data: encoding: cover: contentType: '*/*' style: form data: contentType: application/json style: form schema: $ref: '#/components/schemas/alipay_open_public_life_msg_send_request' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicLifeMsgSendResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_life_msg_send_default_response' description: 请求失败 summary: 生活号广播消息发送接口 tags: - alipay.open.public.life.msg x-content-type: multipart/form-data x-accepts: application/json /v3/alipay/open/public/matchuser/label/create: post: description: 开发者可以使用此接口向匹配到的用户添加指定标签值,每个用户每个标签只能有一个标签值,当向同一个用户添加多个标签值时,最新的标签值会覆盖之前的标签值 operationId: alipay.open.public.matchuser.label.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMatchuserLabelCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMatchuserLabelCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_matchuser_label_create_default_response' description: 请求失败 summary: 用户打标接口 tags: - alipay.open.public.matchuser.label x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/matchuser/label/delete: post: description: 开发者可以使用此接口删除匹配到的支付宝用户的指定标签值 operationId: alipay.open.public.matchuser.label.delete requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMatchuserLabelDeleteModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMatchuserLabelDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_matchuser_label_delete_default_response' description: 请求失败 summary: 用户取消标签接口 tags: - alipay.open.public.matchuser.label x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/menu/batchquery: post: description: 开发者可调用该接口查询自己创建的菜单列表 operationId: alipay.open.public.menu.batchquery responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMenuBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_menu_batchquery_default_response' description: 请求失败 summary: 菜单列表查询接口 tags: - alipay.open.public.menu x-accepts: application/json /v3/alipay/open/public/menu/create: post: description: 开发者可调用该接口为生活号创建一套默认菜单,当用户进入生活号主页时,若没有命中任何个性化菜单,则会展示该默认菜单,每个生活号必须有一套默认菜单 operationId: alipay.open.public.menu.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMenuCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMenuCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_menu_create_default_response' description: 请求失败 summary: 默认菜单创建接口 tags: - alipay.open.public.menu x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/menu/data/batchquery: post: description: 开发者可以根据本接口查询30天内菜单的相关数据,包括菜单点击人数和次数 operationId: alipay.open.public.menu.data.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMenuDataBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMenuDataBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_menu_data_batchquery_default_response' description: 请求失败 summary: 菜单分析数据查询接口 tags: - alipay.open.public.menu.data x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/menu/modify: post: description: 开发者可调用该接口更新默认菜单,菜单更新成功后实时生效 operationId: alipay.open.public.menu.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMenuModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMenuModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_menu_modify_default_response' description: 请求失败 summary: 默认菜单更新接口 tags: - alipay.open.public.menu x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/menu/query: get: description: 开发者通过调用该接口查询菜单。 operationId: alipay.open.public.menu.query responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMenuQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_menu_query_default_response' description: 请求失败 summary: 公众服务平台查询菜单 tags: - alipay.open.public.menu x-accepts: application/json /v3/alipay/open/public/message/content/create: post: description: 开发者可使用该接口将富文本内容生成生活号图文消息内容链接 operationId: alipay.open.public.message.content.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMessageContentCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMessageContentCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_message_content_create_default_response' description: 请求失败 summary: 创建图文消息内容接口 tags: - alipay.open.public.message.content x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/message/content/modify: post: description: 开发者可使用该接口修改已经创建的生活号图文消息素材里的内容 operationId: alipay.open.public.message.content.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMessageContentModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMessageContentModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_message_content_modify_default_response' description: 请求失败 summary: 更新图文消息内容接口 tags: - alipay.open.public.message.content x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/message/custom/send: post: description: 开发者可使用该接口向指定关注用户推送客服消息,一般用于开发者使用接口与用户进行实时信息交互,例如自动回答用户包含某些指定关键字的咨询等。注意:用户必须在48小时之内与该生活号有交互行为才能收到消息(交互行为包括进入生活号、点击菜单、向生活号发送消息等),每个生活号每天只能向1个用户推送100条消息,超过这个数目会报错频率超限 operationId: alipay.open.public.message.custom.send requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMessageCustomSendModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMessageCustomSendResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_message_custom_send_default_response' description: 请求失败 summary: 异步单发消息 tags: - alipay.open.public.message.custom x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/message/group/send: post: description: 开发者可调用此接口向指定分组中的关注用户发送消息,该接口为异步接口,一般请求成功后一段时间用户才能收到消息。 operationId: alipay.open.public.message.group.send requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMessageGroupSendModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMessageGroupSendResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_message_group_send_default_response' description: 请求失败 summary: 分组消息发送接口 tags: - alipay.open.public.message.group x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/message/label/send: post: 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMessageLabelSendModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMessageLabelSendResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_message_label_send_default_response' description: 请求失败 summary: 根据标签组发消息接口 tags: - alipay.open.public.message.label x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/message/single/send: post: description: 商户可使用该接口向用户推送制定模板的消息,如动账提醒、停车通知等消息,消息模板可在生活号后台(fuwu.alipay.com)领取,点击“模板消息”菜单,即可在模板库中领取行业对应的模板 operationId: alipay.open.public.message.single.send requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMessageSingleSendModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMessageSingleSendResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_message_single_send_default_response' description: 请求失败 summary: 单发模板消息 tags: - alipay.open.public.message.single x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/message/total/send: post: description: 群发消息 operationId: alipay.open.public.message.total.send requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMessageTotalSendModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicMessageTotalSendResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_message_total_send_default_response' description: 请求失败 summary: 群发消息 tags: - alipay.open.public.message.total x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/payee/bind/create: post: description: 允许开发者调用该接口将收款账号与当前生活号绑定,从而支持支付成功页引导推荐关注生活号 operationId: alipay.open.public.payee.bind.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicPayeeBindCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicPayeeBindCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_payee_bind_create_default_response' description: 请求失败 summary: 添加收款账号接口 tags: - alipay.open.public.payee.bind x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/payee/bind/delete: delete: description: 允许开发者调用该接口将收款账号与当前生活号解绑 operationId: alipay.open.public.payee.bind.delete parameters: - description: 收款账号,需要绑定的收款支付宝账号,请勿与 pid 同时传入。 explode: true in: query name: login_id required: false schema: example: "13434232322" type: string style: form - description: 支付宝用户id,2088开头的16位长度字符串,请勿与 login_id 同时传入。 explode: true in: query name: pid required: false schema: example: "208844738438439" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicPayeeBindDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_payee_bind_delete_default_response' description: 请求失败 summary: 解绑收款账号接口 tags: - alipay.open.public.payee.bind x-accepts: application/json /v3/alipay/open/public/personalized/extension/batchquery: post: description: 开发者可使用此接口批量查询扩展区列表,包括默认扩展区和个性化扩展区 operationId: alipay.open.public.personalized.extension.batchquery responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicPersonalizedExtensionBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_personalized_extension_batchquery_default_response' description: 请求失败 summary: 扩展区批量查询接口 tags: - alipay.open.public.personalized.extension x-accepts: application/json /v3/alipay/open/public/personalized/extension/create: post: description: 开发者可使用该接口创建一套个性化扩展区,符合该扩展区规则的用户进入生活号主页后会看到该个性化扩展区 operationId: alipay.open.public.personalized.extension.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicPersonalizedExtensionCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicPersonalizedExtensionCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_personalized_extension_create_default_response' description: 请求失败 summary: 个性化扩展区创建接口 tags: - alipay.open.public.personalized.extension x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/personalized/extension/delete: delete: description: 开发者可调用该接口删除创建的一套扩展区,包括个性化扩展区和默认扩展区 operationId: alipay.open.public.personalized.extension.delete parameters: - description: 一套扩展区的key,删除默认扩展区时传入default ,查询扩展区列表可以获得每套扩展区的key explode: true in: query name: extension_key required: false schema: example: "10000" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicPersonalizedExtensionDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_personalized_extension_delete_default_response' description: 请求失败 summary: 扩展区删除接口 tags: - alipay.open.public.personalized.extension x-accepts: application/json /v3/alipay/open/public/personalized/menu/create: post: description: 开发者可使用该接口创建个性化菜单,当生活号用户标签信息命中该菜单的标签规则时,用户将会看到该套菜单。个性化菜单创建完成后立即生效,用户支付宝客户端版本低于10.0.12时,若创建的是icon菜单,也会以文本菜单的形式展示。 operationId: alipay.open.public.personalized.menu.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicPersonalizedMenuCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicPersonalizedMenuCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_personalized_menu_create_default_response' description: 请求失败 summary: 个性化菜单创建 tags: - alipay.open.public.personalized.menu x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/personalized/menu/delete: delete: description: 开发者可使用该接口删除个性化菜单 operationId: alipay.open.public.personalized.menu.delete parameters: - description: 要删除的个性化菜单key。通过 alipay.open.public.personalized.menu.create(个性化菜单创建)接口创建个性化菜单后获取。 explode: true in: query name: menu_key required: false schema: example: "100000" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicPersonalizedMenuDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_personalized_menu_delete_default_response' description: 请求失败 summary: 个性化菜单删除 tags: - alipay.open.public.personalized.menu x-accepts: application/json /v3/alipay/open/public/qrcode/create: post: description: 为了满足用户渠道推广分析的需要,公众平台提供了生成带参数二维码的接口。使用该接口可以获得多个带不同场景值的二维码,用户扫描后,公众号可以接收到事件推送。目前有2种类型的二维码,分别是临时二维码、和永久二维码,前者有过期时间,最大为1800秒。 每次创建二维码ticket需要提供一个开发者自行设定的参数(scene_id)。 operationId: alipay.open.public.qrcode.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicQrcodeCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicQrcodeCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_qrcode_create_default_response' description: 请求失败 summary: 带参推广二维码接口 tags: - alipay.open.public.qrcode x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/setting/category/query: get: description: 查询生活号已设置的行业类型,支持isv调用 operationId: alipay.open.public.setting.category.query responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicSettingCategoryQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_setting_category_query_default_response' description: 请求失败 summary: 生活号查询行业设置接口 tags: - alipay.open.public.setting.category x-accepts: application/json /v3/alipay/open/public/shortlink/create: post: description: 商户通过本接口生成带自有场景标识的短链接 operationId: alipay.open.public.shortlink.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicShortlinkCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicShortlinkCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_shortlink_create_default_response' description: 请求失败 summary: 服务窗短链自主生成接口 tags: - alipay.open.public.shortlink x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/singlearticle/data/batchquery: post: description: 开发者可以通过本接口查询最近30天内发布的图文消息的数据,数据包括:发布时间、送达人数、阅读人数、分享人数等。 operationId: alipay.open.public.singlearticle.data.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicSinglearticleDataBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicSinglearticleDataBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_singlearticle_data_batchquery_default_response' description: 请求失败 summary: 图文分析-按文章查询数据接口 tags: - alipay.open.public.singlearticle.data x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/template/message/get: get: description: 帮助服务窗开发者从服务窗平台(fuwu.alipay.com)公共模板库里领取一个行业的消息模板--消息模板是一种消息的样式,如消费提醒、账单提醒等,主要用于isv帮助商户领取消息模板。 operationId: alipay.open.public.template.message.get parameters: - description: 消息母板id,登陆生活号后台(fuwu.alipay.com),点击菜单“模板消息”,点击“模板库”,即可看到相应模板的消息母板id explode: true in: query name: template_id required: false schema: example: TM000000223 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicTemplateMessageGetResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_template_message_get_default_response' description: 请求失败 summary: 消息模板领取接口 tags: - alipay.open.public.template.message x-accepts: application/json /v3/alipay/open/public/template/message/industry/modify: post: description: 用于修改服务窗消息模板设置的行业信息,如:IT科技/IT软件与服务。 operationId: alipay.open.public.template.message.industry.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicTemplateMessageIndustryModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicTemplateMessageIndustryModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_template_message_industry_modify_default_response' description: 请求失败 summary: 模板消息行业设置修改接口 tags: - alipay.open.public.template.message.industry x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/topic/batchquery: post: description: "通过此接口,开发者可以查询已经在生活号主页配置的营销位具体信息,包括标题、描述、链接等信息。" operationId: alipay.open.public.topic.batchquery responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicTopicBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_topic_batchquery_default_response' description: 请求失败 summary: 营销位查询接口 tags: - alipay.open.public.topic x-accepts: application/json /v3/alipay/open/public/topic/create: post: description: 开发者可以通过此接口,在生活号主页中配置营销位,支持展示4-8个营销位,满足商家对业务的需求,需要注意的是,当某个营销位需要显示为头图时,必须要配置以下三个参数:营销位描述 (sub_title)、营销位图片(img_url)、营销位链接地址(link_url),如不需要展示头图时,以上三个参数均不要传。 operationId: alipay.open.public.topic.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicTopicCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicTopicCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_topic_create_default_response' description: 请求失败 summary: 营销位添加接口 tags: - alipay.open.public.topic x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/topic/delete: delete: description: "通过此接口,开发者可以根据营销位的id删除指定的营销位。" operationId: alipay.open.public.topic.delete parameters: - description: 营销位id explode: true in: query name: topic_id required: false schema: example: "123" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicTopicDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_topic_delete_default_response' description: 请求失败 summary: 营销位删除接口 tags: - alipay.open.public.topic x-accepts: application/json /v3/alipay/open/public/topic/modify: post: description: "通过此接口,开发者可以修改已经在生活号主页配置的营销位具体信息,包括标题、描述、链接等信息。需要注意的是,当某个营销位需要显\ 示为头图时,必须要配置以下三个参数:营销位描述 (sub_title)、营销位图片(img_url)、营销位链接地址(link_url),如不需要展\ 示头图时,以上三个参数均不要传。请注意修改是针对整套营销位,会覆盖之前的营销位。" operationId: alipay.open.public.topic.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicTopicModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicTopicModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_topic_modify_default_response' description: 请求失败 summary: 营销位修改接口 tags: - alipay.open.public.topic x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/user/data/batchquery: post: description: 通过此接口,开发者可以根据时间查询30天内的关注用户人数、取消关注用户人数、净增关注人数、累计关注人数信息 operationId: alipay.open.public.user.data.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicUserDataBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicUserDataBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_user_data_batchquery_default_response' description: 请求失败 summary: 用户分析数据查询接口 tags: - alipay.open.public.user.data x-content-type: application/json x-accepts: application/json /v3/alipay/open/public/user/follow/query: get: description: 查询用户是否已经关注生活号,支持生活号、内容号、财富号 operationId: alipay.open.public.user.follow.query parameters: - description: 支付宝用户id,用户在支付宝的唯一标识,以 2088 开头的 16 位纯数字组成。 explode: true in: query name: user_id required: false schema: example: "2088132324342243" type: string style: form - description: 支付宝用户唯一的标识 explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenPublicUserFollowQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_public_user_follow_query_default_response' description: 请求失败 summary: 查询用户是否已经关注了生活号 tags: - alipay.open.public.user.follow x-accepts: application/json /v3/alipay/open/search/ability/batchquery: post: description: 搜索运营列表分页查询 operationId: alipay.open.search.ability.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchAbilityBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchAbilityBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_ability_batchquery_default_response' description: 请求失败 summary: 搜索运营列表分页查询 tags: - alipay.open.search.ability x-content-type: application/json x-accepts: application/json /v3/alipay/open/search/appkeyword/apply: post: description: 提报搜索关键词 operationId: alipay.open.search.appkeyword.apply requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchAppkeywordApplyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchAppkeywordApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_appkeyword_apply_default_response' description: 请求失败 summary: 提报搜索关键词 tags: - alipay.open.search.appkeyword x-content-type: application/json x-accepts: application/json /v3/alipay/open/search/appkeyword/batchquery: get: description: 查询小程序已配置关键词 operationId: alipay.open.search.appkeyword.batchquery parameters: - description: 小程序id explode: true in: query name: target_appid required: false schema: example: "2021001120654127" type: string style: form - description: 关键词的状态,枚举值,不传该字段表示查询所有状态 explode: true in: query name: status required: false schema: example: ONLINE type: string style: form - description: 当前页 explode: true in: query name: page_number required: false schema: example: 1 type: integer style: form - description: 每页显示条数 explode: true in: query name: page_size required: false schema: example: 10 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchAppkeywordBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_appkeyword_batchquery_default_response' description: 请求失败 summary: 查询小程序已配置关键词 tags: - alipay.open.search.appkeyword x-accepts: application/json /v3/alipay/open/search/appkeyword/delete: post: description: 删除搜索关键词 operationId: alipay.open.search.appkeyword.delete requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchAppkeywordDeleteModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchAppkeywordDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_appkeyword_delete_default_response' description: 请求失败 summary: 删除搜索关键词 tags: - alipay.open.search.appkeyword x-content-type: application/json x-accepts: application/json /v3/alipay/open/search/appkeyword/querystatus: get: description: 查询小程序搜索关键词的审核工单的状态 operationId: alipay.open.search.appkeyword.querystatus parameters: - description: 小程序id explode: true in: query name: target_appid required: false schema: example: "2021001120654127" type: string style: form - description: 审核工单id,提报接口的返回值 explode: true in: query name: apply_no required: false schema: example: "20220519000000108026" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchAppkeywordQuerystatusResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_appkeyword_querystatus_default_response' description: 请求失败 summary: 查询小程序搜索关键词的审核工单的状态 tags: - alipay.open.search.appkeyword x-accepts: application/json /v3/alipay/open/search/appkeywordquota/query: get: description: 查询小程序可配置关键词数 operationId: alipay.open.search.appkeywordquota.query parameters: - description: 小程序id explode: true in: query name: target_appid required: false schema: example: "2021001120654127" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchAppkeywordquotaQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_appkeywordquota_query_default_response' description: 请求失败 summary: 查询小程序可配置关键词数 tags: - alipay.open.search.appkeywordquota x-accepts: application/json /v3/alipay/open/search/baseorder/modify: post: description: 搜索运营提报基础信息工单 operationId: alipay.open.search.baseorder.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchBaseorderModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchBaseorderModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_baseorder_modify_default_response' description: 请求失败 summary: 搜索运营提报基础信息工单 tags: - alipay.open.search.baseorder x-content-type: application/json x-accepts: application/json /v3/alipay/open/search/box/apply: post: description: |- 申请创建搜索直达配置,相关概念说明及准入条件详见 搜索直达 通过该接口创建搜索直达,满足准入门槛时,创建后立马生效。 operationId: alipay.open.search.box.apply requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchBoxApplyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchBoxApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_box_apply_default_response' description: 请求失败 summary: 申请创建搜索直达配置 tags: - alipay.open.search.box x-content-type: application/json x-accepts: application/json /v3/alipay/open/search/box/batchquery: post: description: 批量查询商户已开通搜索直达的小程序及直达信息(搜索直达名称和id) operationId: alipay.open.search.box.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchBoxBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchBoxBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_box_batchquery_default_response' description: 请求失败 summary: 批量查询搜索直达配置列表 tags: - alipay.open.search.box x-content-type: application/json x-accepts: application/json /v3/alipay/open/search/box/consult: post: description: |- 用于对搜索直达创建申请的入参和条件进行提前判断校验。 具体准入条件参考搜索直达准入条件 operationId: alipay.open.search.box.consult requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchBoxConsultModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchBoxConsultResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_box_consult_default_response' description: 请求失败 summary: 搜索直达创建预校验 tags: - alipay.open.search.box x-content-type: application/json x-accepts: application/json /v3/alipay/open/search/box/modify: post: description: 修改搜索直达配置模块,配置对应的模块参考: 搜索直达模块说明 operationId: alipay.open.search.box.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchBoxModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchBoxModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_box_modify_default_response' description: 请求失败 summary: 修改搜索直达配置 tags: - alipay.open.search.box x-content-type: application/json x-accepts: application/json /v3/alipay/open/search/box/offline: post: description: 若不需要运营搜索直达时,可调用次接口下架搜索直达 operationId: alipay.open.search.box.offline requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchBoxOfflineModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchBoxOfflineResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_box_offline_default_response' description: 请求失败 summary: 下架搜索直达 tags: - alipay.open.search.box x-content-type: application/json x-accepts: application/json /v3/alipay/open/search/box/online: post: description: 若搜索直达处于下架状态时,可通过此接口来重新上架直达,上架须满足搜索直达准入门槛,若不满足,则会上架失败并报错 operationId: alipay.open.search.box.online requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchBoxOnlineModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchBoxOnlineResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_box_online_default_response' description: 请求失败 summary: 上架搜索直达 tags: - alipay.open.search.box x-content-type: application/json x-accepts: application/json /v3/alipay/open/search/box/query: get: description: 查询商户已开通搜索直达的小程序及直达信息(搜索直达名称和id),各模块说明详见 搜索直达 。 operationId: alipay.open.search.box.query parameters: - description: 搜索直达配置id explode: true in: query name: box_id required: false schema: example: "20220308000000128693" type: string style: form - description: 商户id,代运营模式下传入。代运营模式,需要服务商已获得商家"运营支付宝小程序"授权。 explode: true in: query name: merchant_id required: false schema: example: 2088xxxxxxxxxxxx type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchBoxQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_box_query_default_response' description: 请求失败 summary: 查询搜索直达配置详情 tags: - alipay.open.search.box x-accepts: application/json /v3/alipay/open/search/boxactivity/apply: post: description: 当搜索直达处于上架状态时,通过该接口来创建banner活动。相关概念和说明详见 搜索直达 。 operationId: alipay.open.search.boxactivity.apply requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchBoxactivityApplyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchBoxactivityApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_boxactivity_apply_default_response' description: 请求失败 summary: 申请创建搜索直达活动配置 tags: - alipay.open.search.boxactivity x-content-type: application/json x-accepts: application/json /v3/alipay/open/search/boxactivity/batchquery: post: description: 批量查询多个搜索直达banner的活动信息 operationId: alipay.open.search.boxactivity.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchBoxactivityBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchBoxactivityBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_boxactivity_batchquery_default_response' description: 请求失败 summary: 批量查询搜索直达活动配置 tags: - alipay.open.search.boxactivity x-content-type: application/json x-accepts: application/json /v3/alipay/open/search/boxactivity/modify: post: description: 修改搜索直达活动配置 operationId: alipay.open.search.boxactivity.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchBoxactivityModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchBoxactivityModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_boxactivity_modify_default_response' description: 请求失败 summary: 修改搜索直达活动配置 tags: - alipay.open.search.boxactivity x-content-type: application/json x-accepts: application/json /v3/alipay/open/search/boxactivity/offline: post: description: 需要下架某个banner活动时,可通过此接口来进行下架操作 operationId: alipay.open.search.boxactivity.offline requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchBoxactivityOfflineModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchBoxactivityOfflineResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_boxactivity_offline_default_response' description: 请求失败 summary: 下架搜索直达活动 tags: - alipay.open.search.boxactivity x-content-type: application/json x-accepts: application/json /v3/alipay/open/search/boxactivity/query: get: description: 查询单个搜索直达banner的活动信息 operationId: alipay.open.search.boxactivity.query parameters: - description: 搜索直达活动id explode: true in: query name: box_activity_id required: false schema: example: "20211223000000100000" type: string style: form - description: 商户id,代运营模式下传入。代运营模式,需要服务商已获得商家"运营支付宝小程序"授权。 explode: true in: query name: merchant_id required: false schema: example: 2088xxxxxxxxxxxx type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchBoxactivityQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_boxactivity_query_default_response' description: 请求失败 summary: 查询搜索直达活动配置详情 tags: - alipay.open.search.boxactivity x-accepts: application/json /v3/alipay/open/search/orderdetail/query: post: description: 查询搜索服务工单的详细信息 operationId: alipay.open.search.orderdetail.query requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchOrderdetailQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchOrderdetailQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_orderdetail_query_default_response' description: 请求失败 summary: 查询搜索服务工单的详细信息 tags: - alipay.open.search.orderdetail x-content-type: application/json x-accepts: application/json /v3/alipay/open/search/serviceorder/batchquery: post: description: 搜索运营服务查询接口 operationId: alipay.open.search.serviceorder.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchServiceorderBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchServiceorderBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_serviceorder_batchquery_default_response' description: 请求失败 summary: 搜索运营服务查询接口 tags: - alipay.open.search.serviceorder x-content-type: application/json x-accepts: application/json /v3/alipay/open/search/subservicekeyword/apply: post: description: 小程序-服务推广-提报服务关键词 operationId: alipay.open.search.subservicekeyword.apply requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchSubservicekeywordApplyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchSubservicekeywordApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_subservicekeyword_apply_default_response' description: 请求失败 summary: 提报服务关键词 tags: - alipay.open.search.subservicekeyword x-content-type: application/json x-accepts: application/json /v3/alipay/open/search/subservicekeyword/batchquery: get: description: 批量查询小程序的服务关键词 operationId: alipay.open.search.subservicekeyword.batchquery parameters: - description: 小程序id explode: true in: query name: target_appid required: false schema: example: "2021001112626071" type: string style: form - description: 审核状态,服务关键词的审核状态,枚举值,不传该字段表示查询所有状态 explode: true in: query name: status required: false schema: example: ONLINE type: string style: form - description: 分页参数,分页查询时使用 explode: true in: query name: page_number required: false schema: example: 1 type: integer style: form - description: 分页参数,分页查询时使用 explode: true in: query name: page_size required: false schema: example: 10 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchSubservicekeywordBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_subservicekeyword_batchquery_default_response' description: 请求失败 summary: 服务关键词批量查询接口 tags: - alipay.open.search.subservicekeyword x-accepts: application/json /v3/alipay/open/search/subservicekeyword/delete: post: description: 删除服务关键词 operationId: alipay.open.search.subservicekeyword.delete requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchSubservicekeywordDeleteModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchSubservicekeywordDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_subservicekeyword_delete_default_response' description: 请求失败 summary: 删除服务关键词 tags: - alipay.open.search.subservicekeyword x-content-type: application/json x-accepts: application/json /v3/alipay/open/search/subservicekeyword/querystatus: get: description: 查询小程序服务关键词的审核工单的状态 operationId: alipay.open.search.subservicekeyword.querystatus parameters: - description: 小程序id explode: true in: query name: target_appid required: false schema: example: "2021001112626071" type: string style: form - description: 审核工单id,提报接口的返回值 explode: true in: query name: apply_no required: false schema: example: "20220519000000108026" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSearchSubservicekeywordQuerystatusResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_search_subservicekeyword_querystatus_default_response' description: 请求失败 summary: 查询小程序服务关键词的审核工单的状态 tags: - alipay.open.search.subservicekeyword x-accepts: application/json /v3/alipay/open/servicemarket/commodity/shop/offline: post: description: 本接口需要商户授权服务商门店操作权限后,服务商可对商户门店上的插件进行下架操作 operationId: alipay.open.servicemarket.commodity.shop.offline requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenServicemarketCommodityShopOfflineModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenServicemarketCommodityShopOfflineResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_servicemarket_commodity_shop_offline_default_response' description: 请求失败 summary: 门店插件下架操作 tags: - alipay.open.servicemarket.commodity.shop x-content-type: application/json x-accepts: application/json /v3/alipay/open/servicemarket/commodity/shop/online: post: description: 本接口用于上架商户门店订购的服务。 operationId: alipay.open.servicemarket.commodity.shop.online requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenServicemarketCommodityShopOnlineModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenServicemarketCommodityShopOnlineResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_servicemarket_commodity_shop_online_default_response' description: 请求失败 summary: 门店插件上架操作 tags: - alipay.open.servicemarket.commodity.shop x-content-type: application/json x-accepts: application/json /v3/alipay/open/servicemarket/order/accept: post: description: 商户订购服务插件之后,需要服务商接单,调用此接口可完成接单操作 operationId: alipay.open.servicemarket.order.accept requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenServicemarketOrderAcceptModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenServicemarketOrderAcceptResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_servicemarket_order_accept_default_response' description: 请求失败 summary: 服务商接单操作 tags: - alipay.open.servicemarket.order x-content-type: application/json x-accepts: application/json /v3/alipay/open/servicemarket/order/create: post: description: 第三方服务商可以创建服务市场的订单,并代为创建小程序应用,小程序应用授权给服务商 operationId: alipay.open.servicemarket.order.create requestBody: content: multipart/form-data: encoding: app_logo: contentType: '*/*' style: form data: contentType: application/json style: form schema: $ref: '#/components/schemas/alipay_open_servicemarket_order_create_request' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenServicemarketOrderCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_servicemarket_order_create_default_response' description: 请求失败 summary: 服务市场代订购小程序 tags: - alipay.open.servicemarket.order x-content-type: multipart/form-data x-accepts: application/json /v3/alipay/open/servicemarket/order/item/cancel: post: description: 服务商可以单个取消订单明细实施项 operationId: alipay.open.servicemarket.order.item.cancel requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenServicemarketOrderItemCancelModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenServicemarketOrderItemCancelResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_servicemarket_order_item_cancel_default_response' description: 请求失败 summary: 服务订单明细实施项单项取消 tags: - alipay.open.servicemarket.order.item x-content-type: application/json x-accepts: application/json /v3/alipay/open/servicemarket/order/item/complete: post: description: 商户在订购插件后,服务商完成实施操作,此接口会检测当前订单必须所属当前操作服务商 operationId: alipay.open.servicemarket.order.item.complete requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenServicemarketOrderItemCompleteModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenServicemarketOrderItemCompleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_servicemarket_order_item_complete_default_response' description: 请求失败 summary: 服务商完成订单内单个明细实施项 tags: - alipay.open.servicemarket.order.item x-content-type: application/json x-accepts: application/json /v3/alipay/open/servicemarket/order/item/confirm: post: description: 此接口需商家授权服务商应用权限后,服务商可代商家进行实施确认完成动作 operationId: alipay.open.servicemarket.order.item.confirm requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenServicemarketOrderItemConfirmModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenServicemarketOrderItemConfirmResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_servicemarket_order_item_confirm_default_response' description: 请求失败 summary: 服务商代商家确认实施完成 tags: - alipay.open.servicemarket.order.item x-content-type: application/json x-accepts: application/json /v3/alipay/open/servicemarket/order/notify: post: description: 服务市场当商户选择服务商提供产品并订购确认时,通知服务商订单消息。服务商可以通过通知的消息内容回查该订单明细。回查接口(alipay.open.servicemarket.order.query) operationId: alipay.open.servicemarket.order.notify requestBody: content: application/json: schema: $ref: '#/components/schemas/CommonNotifyUrlModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenServicemarketOrderNotifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_servicemarket_order_notify_default_response' description: 请求失败 summary: 服务市场商户确认订购通知 tags: - alipay.open.servicemarket.order x-content-type: application/json x-accepts: application/json /v3/alipay/open/servicemarket/order/query: get: description: 第三方服务商提供服务产品被商户订购后,服务市场会推送订单信息给服务商,服务商根据订单号回查该订单明细信息。 operationId: alipay.open.servicemarket.order.query parameters: - description: 订购服务订单ID,通过支付宝发送的 https://opendocs.alipay.com/apis/api_3/alipay.open.servicemarket.order.notify(服务市场商户确认订购通知) 通知获取。 explode: true in: query name: commodity_order_id required: false schema: example: "20160010200000000033400" type: string style: form - description: 查询开始页码,1 为第一页。 explode: true in: query name: start_page required: false schema: example: "1" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenServicemarketOrderQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_servicemarket_order_query_default_response' description: 请求失败 summary: 服务市场订单明细查询 tags: - alipay.open.servicemarket.order x-accepts: application/json /v3/alipay/open/servicemarket/order/reject: post: description: 服务商可以拒接商户购买服务插件订单 operationId: alipay.open.servicemarket.order.reject requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenServicemarketOrderRejectModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenServicemarketOrderRejectResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_servicemarket_order_reject_default_response' description: 请求失败 summary: 服务商拒绝接单 tags: - alipay.open.servicemarket.order x-content-type: application/json x-accepts: application/json /v3/alipay/open/servicemarket/promotiontask/relation/query: get: description: 用于开发服务商查询已与其达成推广关系的地推服务商信息 operationId: alipay.open.servicemarket.promotiontask.relation.query parameters: - description: 服务商品ID explode: true in: query name: commodity_id required: false schema: example: SS010101000000003954 type: string style: form - description: 每页数量,范围(1-100)。默认:10 explode: true in: query name: page_size required: false schema: example: 10 type: integer style: form - description: 当前页码,从1开始。默认:1 explode: true in: query name: page_num required: false schema: example: 1 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenServicemarketPromotiontaskRelationQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_servicemarket_promotiontask_relation_query_default_response' description: 请求失败 summary: 服务商推广关系查询 tags: - alipay.open.servicemarket.promotiontask.relation x-accepts: application/json /v3/alipay/open/sp/blueseaactivity/create: post: description: 服务商返佣活动报名 operationId: alipay.open.sp.blueseaactivity.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpBlueseaactivityCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpBlueseaactivityCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_sp_blueseaactivity_create_default_response' description: 请求失败 summary: 服务商返佣活动报名申请 tags: - alipay.open.sp.blueseaactivity x-content-type: application/json x-accepts: application/json /v3/alipay/open/sp/blueseaactivity/modify: post: description: 服务商返佣活动 operationId: alipay.open.sp.blueseaactivity.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpBlueseaactivityModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpBlueseaactivityModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_sp_blueseaactivity_modify_default_response' description: 请求失败 summary: 服务商返佣活动申请单修改 tags: - alipay.open.sp.blueseaactivity x-content-type: application/json x-accepts: application/json /v3/alipay/open/sp/blueseaactivity/query: get: description: 服务商返佣活动 operationId: alipay.open.sp.blueseaactivity.query parameters: - description: 申请单 id。通过 alipay.open.sp.blueseaactivity.create接口获取 explode: true in: query name: order_id required: false schema: example: "5881" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpBlueseaactivityQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_sp_blueseaactivity_query_default_response' description: 请求失败 summary: 服务商返佣活动申请单详情查询 tags: - alipay.open.sp.blueseaactivity x-accepts: application/json /v3/alipay/open/sp/image/upload: post: description: 图片上传 operationId: alipay.open.sp.image.upload requestBody: content: multipart/form-data: encoding: image_content: contentType: '*/*' style: form schema: $ref: '#/components/schemas/alipay_open_sp_image_upload_request' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpImageUploadResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_sp_image_upload_default_response' description: 请求失败 summary: 图片上传接口 tags: - alipay.open.sp.image x-content-type: multipart/form-data x-accepts: application/json /v3/alipay/open/sp/isv/bill/sync: post: description: 针对SSB业务中,S1回传S2推广过程中,获得的分佣账单数据 operationId: alipay.open.sp.isv.bill.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpIsvBillSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpIsvBillSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_sp_isv_bill_sync_default_response' description: 请求失败 summary: 服务商账单数据回传 tags: - alipay.open.sp.isv.bill x-content-type: application/json x-accepts: application/json /v3/alipay/open/sp/isv/operation/sync: post: description: 针对SSB业务中,S1回传S2推广过程中,获得的作业结果数据 operationId: alipay.open.sp.isv.operation.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpIsvOperationSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpIsvOperationSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_sp_isv_operation_sync_default_response' description: 请求失败 summary: 服务商作业结果数据回传 tags: - alipay.open.sp.isv.operation x-content-type: application/json x-accepts: application/json /v3/alipay/open/sp/isv/relation/query: get: description: 用于开发服务商查询已与其达成推广关系的地推服务商信息 operationId: alipay.open.sp.isv.relation.query parameters: - description: 服务市场商品Code explode: true in: query name: commodity_id required: false schema: example: SS010301000000001908 type: string style: form - description: 每页数量,范围(1-100)。默认:10 explode: true in: query name: page_size required: false schema: example: "10" type: string style: form - description: 当前页码,从1开始。默认:1 explode: true in: query name: page_num required: false schema: example: "1" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpIsvRelationQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_sp_isv_relation_query_default_response' description: 请求失败 summary: spcenter服务商推广关系查询 tags: - alipay.open.sp.isv.relation x-accepts: application/json /v3/alipay/open/sp/isv/sales/sync: post: description: 针对SSB业务中,S2推广之后,推广的产品的销售数据回传 operationId: alipay.open.sp.isv.sales.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpIsvSalesSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpIsvSalesSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_sp_isv_sales_sync_default_response' description: 请求失败 summary: 商户销售数据回传接口 tags: - alipay.open.sp.isv.sales x-content-type: application/json x-accepts: application/json /v3/alipay/open/sp/isv/signauth/create: post: description: 针对签约授权一体化场景,创建签约授权一体化订单绑定签约单(可选)、绑定代运营授权单、应用授权单,跟踪整个签约授权一体化订单的状态 operationId: alipay.open.sp.isv.signauth.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpIsvSignauthCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpIsvSignauthCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_sp_isv_signauth_create_default_response' description: 请求失败 summary: 创建签约授权一体化订单 tags: - alipay.open.sp.isv.signauth x-content-type: application/json x-accepts: application/json /v3/alipay/open/sp/isv/signauth/query: get: description: 查询签约授权一体化订单状态详情(包含子任务信息) operationId: alipay.open.sp.isv.signauth.query parameters: - description: "签约授权一体化订单ID\t可通过alipay.open.sp.isv.signauth.create 接口获取" explode: true in: query name: order_id required: false schema: example: "20211102034000100000047728652040" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpIsvSignauthQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_sp_isv_signauth_query_default_response' description: 请求失败 summary: 查询签约授权一体化订单状态详情 tags: - alipay.open.sp.isv.signauth x-accepts: application/json /v3/alipay/open/sp/leads/expand/create: post: description: 在线写入商机库 operationId: alipay.open.sp.leads.expand.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpLeadsExpandCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpLeadsExpandCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_sp_leads_expand_create_default_response' description: 请求失败 summary: 在线写入商机库 tags: - alipay.open.sp.leads.expand x-content-type: application/json x-accepts: application/json /v3/alipay/open/sp/merchant/inconsistent/approve: post: description: 针对服务优选扫码点餐小程序,用于收集并审核非同人商家的进件资料。 operationId: alipay.open.sp.merchant.inconsistent.approve requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpMerchantInconsistentApproveModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpMerchantInconsistentApproveResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_sp_merchant_inconsistent_approve_default_response' description: 请求失败 summary: 非同人商家进件资料审批 tags: - alipay.open.sp.merchant.inconsistent x-content-type: application/json x-accepts: application/json /v3/alipay/open/sp/operation/apply: post: description: 服务商向商户发起代运营操作(账号绑定或者代运营授权) operationId: alipay.open.sp.operation.apply requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpOperationApplyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpOperationApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_sp_operation_apply_default_response' description: 请求失败 summary: 向商户发起代运营操作 tags: - alipay.open.sp.operation x-content-type: application/json x-accepts: application/json /v3/alipay/open/sp/operation/qrcode/query: get: description: 面向服务商,查询发起代运营授权或者账号绑定的二维码。代间联商户代运营时,推荐使用接口同步返回的recommend_accounts字段中的账号扫码确认。 operationId: alipay.open.sp.operation.qrcode.query parameters: - description: 外部操作流水,由服务商自定义,需确保每次操作唯一。仅支持数字、字母、下划线组合。 explode: true in: query name: out_biz_no required: false schema: example: "2020124234523465636345634" type: string style: form - description: "代运营操作类型。取值如下:\t* ACCOUNT_BIND:账号绑定,仅支持间连商户。\t* OPERATION_AUTH:\ 代运营授权,支持间连、直连商户。" explode: true in: query name: operate_type required: false schema: example: OPERATION_AUTH type: string style: form - description: "支付宝商户号。注意仅支持 2088 开头的间连商户。\t若被代运营者是间连商户,则 merchant_no 必填;\t若\ 为直连商户,则 merchant_no 和 alipay_account 不能同时为空,都有值优先取 merchant_no。" explode: true in: query name: merchant_no required: false schema: example: 2088XXXX type: string style: form - description: "支付宝登录账号。通常为手机号或者邮箱。\t若被代运营者是间连商户,该字段无需填写。\t若为直连商户,则 merchant_no\ \ 和 alipay_account 不能同时为空,都有值优先取 merchant_no。" explode: true in: query name: alipay_account required: false schema: example: xxx@gmail.com type: string style: form - description: "接入的产品编号。\t操作类型为绑定的,填OPENAPI_BIND_DEFAULT;\t操作类型为授权的,填OPENAPI_AUTH_DEFAULT" explode: true in: query name: access_product_code required: false schema: example: OPENAPI_AUTH_DEFAULT type: string style: form - description: "场景授权列表结构结构:场景codeA:权限code1,权限code2;场景codeB:权限code1,权限code2;" explode: true in: query name: isv_scene_permissions required: false schema: example: SHOP_MANAGE:SHOP_MANAGE_BASE;PROMOTION_MANAGE:PROMOTION_MANAGE_BASE type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpOperationQrcodeQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_sp_operation_qrcode_query_default_response' description: 请求失败 summary: 查询代运营授权或者账号绑定二维码 tags: - alipay.open.sp.operation.qrcode x-accepts: application/json /v3/alipay/open/sp/operation/result/query: get: description: |- 查询服务商代运营操作(代运营授权或者账号绑定)结果。提供两种查询方式: 方式一:operate_type + batch_no,提供基于操作批次的精确查询,只查询本操作批次的代运营操作结果,不反映最终代运营操作结果。 方式一查询方式优先级更高。 方式二:operate_type + access_product_code + merchant_no + alipay_account 参数组合,可以查询代运营操作最终结果,任意一个操作批次成功都会体现在最终结果中。 方式三:operate_type + isv_scene_permissions + merchant_no + alipay_account 参数组合,可以查询代运营操作最终结果,任意一个操作批次成功都会体现在最终结果中(仅支持查询授权结果)。 operationId: alipay.open.sp.operation.result.query parameters: - description: 代运营操作类型。取值如下 ACCOUNT_BIND:账号绑定; OPERATION_AUTH:代运营授权。 explode: true in: query name: operate_type required: false schema: example: ACCOUNT_BIND type: string style: form - description: "支付宝操作批次号。\tbatch_no提供基于操作批次的精确查询,只查询本操作批次的代运营操作结果,不反映最终代运营操作\ 结果。\t注意:\t1.access_product_code、merchant_no、alipay_account三个参数组合与传入 batch_no\ \ 为两种查询方式,不可同时为空且以 batch_no 优先。\t2.access_product_code、merchant_no、alipay_account三\ 个参数组合可以查询最终代运营操作结果。" explode: true in: query name: batch_no required: false schema: example: "2020222342342" type: string style: form - description: "接入的产品编号。未传batch_no时必填,枚举如下:\tOPENAPI_BIND_DEFAULT:操作类型为账号绑定;\ \tOPENAPI_AUTH_DEFAULT:操作类型为代运营授权。" explode: true in: query name: access_product_code required: false schema: example: OPENAPI_BIND_DEFAULT type: string style: form - description: "支付宝商户号。支持间连、直连商户,值为2088开头。\t未传batch_no时需注意:\t若查询间连商户则 merchant_no\ \ 必填; \t若查询直连商户,则merchant_no和alipay_account不能同时为空,都有值优先取merchant_no。" explode: true in: query name: merchant_no required: false schema: example: "2088912341234123" type: string style: form - 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。" explode: true in: query name: alipay_account required: false schema: example: testaccount@test.com type: string style: form - description: "场景授权列表结构结构:场景codeA:权限code1,权限code2;场景codeB:权限code1,权限code2;" explode: true in: query name: isv_scene_permissions required: false schema: example: SHOP_MANAGE:SHOP_MANAGE_BASE;PROMOTION_MANAGE:PROMOTION_MANAGE_BASE type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpOperationResultQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_sp_operation_result_query_default_response' description: 请求失败 summary: 查询服务商代运营操作结果 tags: - alipay.open.sp.operation.result x-accepts: application/json /v3/alipay/open/sp/oppor/detail/query: get: description: 商机作业详情查询 operationId: alipay.open.sp.oppor.detail.query parameters: - description: 服务商pid explode: true in: query name: isv_pid required: false schema: example: "2088501013445414" type: string style: form - description: 商机作业Id explode: true in: query name: oppor_id required: false schema: example: "2022041403518351" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpOpporDetailQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_sp_oppor_detail_query_default_response' description: 请求失败 summary: 商机作业详情查询 tags: - alipay.open.sp.oppor.detail x-accepts: application/json /v3/alipay/open/sp/oppor/feedback/modify: post: description: 商机拓展完成 operationId: alipay.open.sp.oppor.feedback.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpOpporFeedbackModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpOpporFeedbackModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_sp_oppor_feedback_modify_default_response' description: 请求失败 summary: 商机拓展完成 tags: - alipay.open.sp.oppor.feedback x-content-type: application/json x-accepts: application/json /v3/alipay/open/sp/oppor/page/query: get: description: 商机作业列表查询 operationId: alipay.open.sp.oppor.page.query parameters: - description: 服务商pid explode: true in: query name: isv_pid required: false schema: example: "2088302213873401" type: string style: form - description: "作业记录状态列表,以,拼接传入" explode: true in: query name: status_list required: false schema: example: "WAIT_MER_CONFIRM,MER_CONFIRMED,MER_REJECTED,EXPANDING,EXPANDED,EXPAND_FAILED" type: string style: form - description: 页大小 explode: true in: query name: page_size required: false schema: example: "10" type: string style: form - description: 页数 explode: true in: query name: page_num required: false schema: example: "1" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenSpOpporPageQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_sp_oppor_page_query_default_response' description: 请求失败 summary: 商机作业列表查询 tags: - alipay.open.sp.oppor.page x-accepts: application/json /v3/alipay/open/violation/violationdetail/query: get: description: 违规记录详情查询 operationId: alipay.open.violation.violationdetail.query parameters: - description: 支付宝侧生成的违规记录唯一标识 explode: true in: query name: violation_record_id required: false schema: example: "20220524001020000000000001" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenViolationViolationdetailQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_violation_violationdetail_query_default_response' description: 请求失败 summary: 违规记录详情查询 tags: - alipay.open.violation.violationdetail x-accepts: application/json /v3/alipay/open/violation/violationevent/batchquery: post: description: 违规记录列表查询 operationId: alipay.open.violation.violationevent.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayOpenViolationViolationeventBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayOpenViolationViolationeventBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_open_violation_violationevent_batchquery_default_response' description: 请求失败 summary: 违规记录列表查询 tags: - alipay.open.violation.violationevent x-content-type: application/json x-accepts: application/json /v3/alipay/pcredit/huabei/auth/accumulation/query: get: description: 根据协议与对应的周期查询支付宝累计数据。 operationId: alipay.pcredit.huabei.auth.accumulation.query parameters: - description: 支付宝系统中用以唯一标识用户签约记录的编号。 explode: true in: query name: agreement_no required: false schema: example: "20170502000610755993" type: string style: form - description: 协议结算周期,使用支付宝端回传的周期信息。 explode: true in: query name: period required: false schema: example: 20181223235059-20181230235010 type: string style: form - description: 买家在支付宝的用户id explode: true in: query name: alipay_user_id required: false schema: example: "2088101117955611" type: string style: form - description: 买家在支付宝的用户id explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayPcreditHuabeiAuthAccumulationQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_pcredit_huabei_auth_accumulation_query_default_response' description: 请求失败 summary: 花芝轻会员周期累计数据查询 tags: - alipay.pcredit.huabei.auth.accumulation x-accepts: application/json /v3/alipay/pcredit/huabei/auth/agreement/close: put: description: 用户已经开通花芝先享后,商户可通过此接口提前关闭协议。 operationId: alipay.pcredit.huabei.auth.agreement.close requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayPcreditHuabeiAuthAgreementCloseModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayPcreditHuabeiAuthAgreementCloseResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_pcredit_huabei_auth_agreement_close_default_response' description: 请求失败 summary: 花芝协议关闭接口 tags: - alipay.pcredit.huabei.auth.agreement x-content-type: application/json x-accepts: application/json /v3/alipay/pcredit/huabei/auth/agreement/query: get: description: |- 花芝轻会员协议查询,返回协议的状态。如果协议处于签约状态,同时返回最新的资金池余额。 有两种方式查询。优先使用agreement_no查询;其次是使用(out_sign_no, auth_scene)查询。 如果商户不能保证out_sign_no的唯一性,慎用(out_sign_no, auth_scene)的查询方式,它优先返回仍处于签约状态的协议。 operationId: alipay.pcredit.huabei.auth.agreement.query parameters: - description: 支付宝系统中用以唯一标识用户签约记录的编号,即花芝轻会员。传入该参数,会忽略其它所有参数。 explode: true in: query name: agreement_no required: false schema: example: "20185513447859192007" type: string style: form - description: 买家在支付宝的用户id explode: true in: query name: alipay_user_id required: false schema: example: "2088101117955611" type: string style: form - description: 买家在支付宝的用户id explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form - description: 外部签约号,由商户提供,花芝轻会员协议中标识用户的唯一签约号(确保在商户系统中唯一)。 explode: true in: query name: out_sign_no required: false schema: example: "2018053100073208416400000002" type: string style: form - description: 花芝轻会员签约场景,商户和支付宝签约时确定。该值需要与系统/页面签约接口调用时传入的值保持一致。 explode: true in: query name: auth_scene required: false schema: example: EXTERNAL_PCARD type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayPcreditHuabeiAuthAgreementQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_pcredit_huabei_auth_agreement_query_default_response' description: 请求失败 summary: 花芝轻会员协议查询接口 tags: - alipay.pcredit.huabei.auth.agreement x-accepts: application/json /v3/alipay/pcredit/huabei/auth/order/query: get: 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 parameters: - description: 支付宝侧花呗冻结、解冻操作单据id。在原先的冻结或者解冻接口调用中同步返回给商户,或者通过商户通知返回给商户。按订单号查询时,此字段不可为空。 explode: true in: query name: auth_opt_id required: false schema: example: "2018081010020817070009689955" type: string style: form - description: 买家在支付宝的用户id。通过userid+请求流水号组合查询时,此字段不可为空。 explode: true in: query name: alipay_user_id required: false schema: example: "2088101117955611" type: string style: form - description: 买家在支付宝的用户id explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form - description: 商户原先调用冻结、解冻接口传入的请求流水号。按照流水号查询订单时,此字段不能为空。 explode: true in: query name: out_request_no required: false schema: example: "8077735255938032" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayPcreditHuabeiAuthOrderQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_pcredit_huabei_auth_order_query_default_response' description: 请求失败 summary: 花呗先享订单查询接口 tags: - alipay.pcredit.huabei.auth.order x-accepts: application/json /v3/alipay/pcredit/huabei/auth/order/unfreeze: put: description: "用户已经开通花呗先享协议后,商户通过此接口解冻用户资金池金额,也可以解冻并解约。\r\n如果是解约操作,则要求传入的解冻金额\ 必须等于用户资金池余额。\r\n注意:商户在发起解约前,请务必保证已经结算过用户会员费,一旦解约后,无法发起结算用户会员费操作。" operationId: alipay.pcredit.huabei.auth.order.unfreeze requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayPcreditHuabeiAuthOrderUnfreezeModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayPcreditHuabeiAuthOrderUnfreezeResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_pcredit_huabei_auth_order_unfreeze_default_response' description: 请求失败 summary: 花呗先享解冻或解约接口 tags: - alipay.pcredit.huabei.auth.order x-content-type: application/json x-accepts: application/json /v3/alipay/pcredit/huabei/auth/refund/apply: put: description: 用于1)芝麻GO会员费扣款逆向退款操作2)周期扣款每期扣款逆向退款操作 operationId: alipay.pcredit.huabei.auth.refund.apply requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayPcreditHuabeiAuthRefundApplyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayPcreditHuabeiAuthRefundApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_pcredit_huabei_auth_refund_apply_default_response' description: 请求失败 summary: 花芝结算扣款费用逆向退款申请 tags: - alipay.pcredit.huabei.auth.refund x-content-type: application/json x-accepts: application/json /v3/alipay/pcredit/huabei/auth/settle/apply: put: description: 用户已经开通花芝轻会员协议后,商户通过此接口解冻转支付用户冻结金额。传入金额必须小于等于冻结金额 operationId: alipay.pcredit.huabei.auth.settle.apply requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayPcreditHuabeiAuthSettleApplyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayPcreditHuabeiAuthSettleApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_pcredit_huabei_auth_settle_apply_default_response' description: 请求失败 summary: 花芝轻会员结算申请 tags: - alipay.pcredit.huabei.auth.settle x-content-type: application/json x-accepts: application/json /v3/alipay/security/data/sss/create/{a}: post: description: 文档回归测试勿动openapi_openid_post多场景 operationId: alipay.security.data.sss.create parameters: - description: 有枚举,必须,有openid,有注意事项 explode: true in: query name: b required: false schema: example: "12" type: string style: form - description: 有枚举,必须,有openid,有注意事项 explode: true in: query name: b_open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form - description: path.数字,无枚举,有注意事项 explode: false in: path name: a required: true schema: example: 1 type: integer style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipaySecurityDataSssCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipaySecurityDataSssCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_security_data_sss_create_default_response' description: 请求失败 summary: 文档回归测试勿动openapi_openid_post多场景 tags: - alipay.security.data.sss x-content-type: application/json x-accepts: application/json /v3/alipay/security/prod/sss/query/{bbb}: post: description: 金柚测试3.0接口 operationId: alipay.security.prod.sss.query parameters: - description: "1" explode: true in: query name: aaa required: false schema: example: "3333" type: string style: form - description: "1" explode: true in: query name: aaa_open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form - description: activity_id 词条描述 explode: false in: path name: bbb required: true schema: example: "1" type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipaySecurityProdSssQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipaySecurityProdSssQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_security_prod_sss_query_default_response' description: 请求失败 summary: 金柚测试3.0接口 tags: - alipay.security.prod.sss x-content-type: application/json x-accepts: application/json /v3/alipay/security/risk/customerrisk/send: post: description: 判断商户有问题时,服务商将商户信息同步到支付宝 operationId: alipay.security.risk.customerrisk.send requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipaySecurityRiskCustomerriskSendModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipaySecurityRiskCustomerriskSendResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_security_risk_customerrisk_send_default_response' description: 请求失败 summary: 商户数据同步 tags: - alipay.security.risk.customerrisk x-content-type: application/json x-accepts: application/json /v3/alipay/security/risk/verifyidentity/miniapp/confirm: post: description: 确认身份核验结果接口 operationId: alipay.security.risk.verifyidentity.miniapp.confirm requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipaySecurityRiskVerifyidentityMiniappConfirmModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipaySecurityRiskVerifyidentityMiniappConfirmResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_security_risk_verifyidentity_miniapp_confirm_default_response' description: 请求失败 summary: 小程序核验服务结果确认接口 tags: - alipay.security.risk.verifyidentity.miniapp x-content-type: application/json x-accepts: application/json /v3/alipay/social/base/contentlib/standardcontent/batchquery: post: description: 支付宝生活号+查询当前账号下发布过的内容及对应详情信息 operationId: alipay.social.base.contentlib.standardcontent.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipaySocialBaseContentlibStandardcontentBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipaySocialBaseContentlibStandardcontentBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_social_base_contentlib_standardcontent_batchquery_default_response' description: 请求失败 summary: 内容批量查询接口 tags: - alipay.social.base.contentlib.standardcontent x-content-type: application/json x-accepts: application/json /v3/alipay/system/oauth/token: post: description: 换取授权访问令牌 operationId: alipay.system.oauth.token requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipaySystemOauthTokenModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipaySystemOauthTokenResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_system_oauth_token_default_response' description: 请求失败 summary: 换取授权访问令牌 tags: - alipay.system.oauth x-content-type: application/json x-accepts: application/json /v3/alipay/trade/advance/consult: get: description: 商户通过此接口咨询,当前用户是否满足垫资服务条件 或者 针对单笔订单的风险评估进行预咨询服务。 operationId: alipay.trade.advance.consult parameters: - description: "支付宝用户 id,2088开头的16为数字。\t除单笔订单风险预评估场景(即consult_scene指定ORDER_RISK_EVALUATION)外\ ,其他场景必选。" explode: true in: query name: alipay_user_id required: false schema: example: "2088302483540171" type: string style: form - description: "订单咨询类型,用以选择咨询的服务。不传时默认为垫资咨询,其他的场景需要按照对接的服务传入指定的值。\tORDER_RISK_EVALUATION:\ 表示单笔订单风险预评估。" explode: true in: query name: consult_scene required: false schema: example: ORDER_RISK_EVALUATION type: string style: form - description: 行业产品信息,咨询时会从该产品对应的销售方案中获取相关垫资规则配置。 explode: true in: query name: industry_product_code required: false schema: example: CAR_OWNERS_PARKINGPAY type: string style: form - description: 子商户id explode: true in: query name: sub_merchant_id required: false schema: example: "2088102122458832" type: string style: form - description: 子商户类型 explode: true in: query name: sub_merchant_type required: false schema: example: PARTNER type: string style: form - description: 支付宝系统中用以唯一标识用户签约记录的编号(用户签约成功后的协议号 ) ,在进行单笔订单风险评估预咨询时必传。 explode: true in: query name: agreement_no required: false schema: example: "20170322450983769228" type: string style: form - description: "预估订单总金额,单位为元,精确到小数点后两位,单笔订单风险预评估时使用,取值范围[0.01,100000000]。" explode: true in: query name: estimated_order_amount required: false schema: example: "9.00" type: string style: form - description: 商户请求时的外部订单号,在花芝场景下非空。 explode: true in: query name: out_trade_no required: false schema: example: test20191100000001 type: string style: form - description: 是否需要进行用户风险预测 explode: true in: query name: need_user_risk_prediction required: false schema: example: "true" type: string style: form - description: 交易信息摘要,需要进行用户风险预测时可传,用于结合场景的更加精细的预测。具体信息结构服务接入前咨询约定。 explode: true in: query name: trade_digest required: false schema: example: "{{\"parking_city\":\"太原市\",\"vehicle_number\":\"辽7666666\"}}" type: string style: form - description: 用户在外部域账号系统绑定的手机号,需要进行用户风险预测时必传,用于预测用户是否面临被二次放号的场景。使用时需要对请求加密,加密后请求在公网传输时为加密文本。详见:https://opendocs.alipay.com/open/common/104567;https://opendocs.alipay.com/isv/grefvl/getaes explode: true in: query name: user_out_binding_phone required: false schema: example: "1868888888888" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeAdvanceConsultResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_advance_consult_default_response' description: 请求失败 summary: 订单咨询服务 tags: - alipay.trade.advance x-accepts: application/json /v3/alipay/trade/applepay/authentication/submit: post: description: ApplePay定义的接口,支付宝进行适配。ApplePay端支付核身完毕后,提交到支付宝进行核身验证+支付推进。 operationId: alipay.trade.applepay.authentication.submit requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayTradeApplepayAuthenticationSubmitModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeApplepayAuthenticationSubmitResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_applepay_authentication_submit_default_response' description: 请求失败 summary: ApplePay支付鉴权提交 tags: - alipay.trade.applepay.authentication x-content-type: application/json x-accepts: application/json /v3/alipay/trade/batch/settle: post: description: 买家付款成功之后,资金进入二级商户待结算户,支付宝等待平台的结算指令进行结算。平台可根据平台规则,发起批量结算请求,将资金结算到二级商户的结算账号。请款金额只要不超过待结算的总余额即可。 operationId: alipay.trade.batch.settle requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayTradeBatchSettleModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeBatchSettleResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_batch_settle_default_response' description: 请求失败 summary: 批量结算 tags: - alipay.trade.batch x-content-type: application/json x-accepts: application/json /v3/alipay/trade/batch/settle/query: post: description: 商户请求批量结算结果查询 operationId: alipay.trade.batch.settle.query requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayTradeBatchSettleQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeBatchSettleQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_batch_settle_query_default_response' description: 请求失败 summary: 批量结算查询 tags: - alipay.trade.batch.settle x-content-type: application/json x-accepts: application/json /v3/alipay/trade/batch/transfer: post: description: 在红星美凯龙场景下,请款到不同主体的银行卡/账户中 operationId: alipay.trade.batch.transfer requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayTradeBatchTransferModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeBatchTransferResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_batch_transfer_default_response' description: 请求失败 summary: 请款分账 tags: - alipay.trade.batch x-content-type: application/json x-accepts: application/json /v3/alipay/trade/batch/transfer/query: get: description: 针对请款分账接口的查询功能 operationId: alipay.trade.batch.transfer.query parameters: - description: 批量结算时传入的外部流水号,与settle_no二者必填其一。 out_request_no和settle_no如果同时存在,优先取settle_no explode: true in: query name: out_request_no required: false schema: example: "20180101" type: string style: form - description: 结算单据号,与out_request_no二者必填其一 explode: true in: query name: settle_no required: false schema: example: "2019050510032002040000053220" type: string style: form - description: 扩展字段 explode: true in: query name: extend_params required: false schema: example: "{\"key\":\"value\"}" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeBatchTransferQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_batch_transfer_query_default_response' description: 请求失败 summary: 请款分账查询接口 tags: - alipay.trade.batch.transfer x-accepts: application/json /v3/alipay/trade/cancel: post: description: "支付交易返回失败或支付系统超时,调用该接口撤销交易。如果此订单用户支付失败,支付宝系统会将此订单关闭;如果用户支付成功,支付\ 宝系统会将此订单资金退还给用户。\r\n注意:只有发生支付系统超时或者支付结果未知时可调用撤销,其他正常支付的单如需实现相同功能请调用申请退款API。\ 提交支付交易后调用【查询订单API】,没有明确的支付结果再调用【撤销订单API】。" operationId: alipay.trade.cancel requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayTradeCancelModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeCancelResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_cancel_default_response' description: 请求失败 summary: 统一收单交易撤销接口 tags: - alipay.trade x-content-type: application/json x-accepts: application/json /v3/alipay/trade/close: post: description: 用于交易创建后,用户在一定时间内未进行支付,可调用该接口直接将未付款的交易进行关闭。 operationId: alipay.trade.close requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayTradeCloseModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeCloseResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_close_default_response' description: 请求失败 summary: 统一收单交易关闭接口 tags: - alipay.trade x-content-type: application/json x-accepts: application/json /v3/alipay/trade/create: post: description: 商户通过该接口进行交易的创建下单 operationId: alipay.trade.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayTradeCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_create_default_response' description: 请求失败 summary: 统一收单交易创建接口 tags: - alipay.trade x-content-type: application/json x-accepts: application/json /v3/alipay/trade/customs/declare: post: description: 境外商户的商品进口到国内时需要向海关中心报送支付、物流等信息,由海关审核,如果交易是由支付宝支付的话,需要商户可以调用此报关接口来请求支付宝将其指定交易报送支付单给海关。 operationId: alipay.trade.customs.declare requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayTradeCustomsDeclareModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeCustomsDeclareResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_customs_declare_default_response' description: 请求失败 summary: 统一收单报关接口 tags: - alipay.trade.customs x-content-type: application/json x-accepts: application/json /v3/alipay/trade/customs/query: get: description: 境外商户的商品进口到国内时需要向海关中心报送支付、物流等信息,由海关审核,如果交易是由支付宝支付的话,需要商户调用支付宝报关接口来请求支付宝将其指定交易报送支付单给海关。商户可以通过该接口主动查询报关状态,了解报关详情以及进度。 operationId: alipay.trade.customs.query parameters: - description: "报关请求号。需要查询的商户端报关请求号,支持批量查询,\r\t多个值用英文半角逗号分隔,单次请求最多10个;" explode: true in: query name: out_request_nos required: false schema: example: "201506010001,201506010002,201506010003" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeCustomsQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_customs_query_default_response' description: 请求失败 summary: 查询报关详细信息 tags: - alipay.trade.customs x-accepts: application/json /v3/alipay/trade/fastpay/refund/query: post: description: 商户可使用该接口查询自已通过alipay.trade.refund提交的退款请求是否执行成功。 operationId: alipay.trade.fastpay.refund.query requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayTradeFastpayRefundQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeFastpayRefundQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_fastpay_refund_query_default_response' description: 请求失败 summary: 统一收单交易退款查询 tags: - alipay.trade.fastpay.refund x-content-type: application/json x-accepts: application/json /v3/alipay/trade/order/pay: post: description: 商户用已创建的交易进行支付(需要使用该接口请联系接口owner) operationId: alipay.trade.order.pay requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayTradeOrderPayModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeOrderPayResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_order_pay_default_response' description: 请求失败 summary: 统一收单交易订单支付接口 tags: - alipay.trade.order x-content-type: application/json x-accepts: application/json /v3/alipay/trade/order/settle: post: description: 用于在卖家交易成功之后,基于交易订单,进行卖家与第三方(如供应商或平台商)的资金再分配。一般用于第三方从卖家抽佣场景。 operationId: alipay.trade.order.settle requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayTradeOrderSettleModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeOrderSettleResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_order_settle_default_response' description: 请求失败 summary: 统一收单交易结算接口 tags: - alipay.trade.order x-content-type: application/json x-accepts: application/json /v3/alipay/trade/order/settle/query: get: description: 根据分账请求号查询交易分账结果 operationId: alipay.trade.order.settle.query parameters: - description: 支付宝分账请求单号,传入该字段,无需再传外部请求号和支付宝交易号 explode: true in: query name: settle_no required: false schema: example: "20210706002530020036530021395831" type: string style: form - description: 调用分账接口时指定的外部请求号。分账查询时需要和支付宝交易号一起传入 explode: true in: query name: out_request_no required: false schema: example: "20210727001" type: string style: form - description: 支付宝交易号,传入该字段,需要和外部请求号一起传入 explode: true in: query name: trade_no required: false schema: example: 2021112611001004680 073956707 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeOrderSettleQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_order_settle_query_default_response' description: 请求失败 summary: 交易分账查询接口 tags: - alipay.trade.order.settle x-accepts: application/json /v3/alipay/trade/orderinfo/sync: post: description: 该接口用于商户向支付宝同步该笔订单相关业务信息 operationId: alipay.trade.orderinfo.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayTradeOrderinfoSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeOrderinfoSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_orderinfo_sync_default_response' description: 请求失败 summary: 支付宝订单信息同步接口 tags: - alipay.trade.orderinfo x-content-type: application/json x-accepts: application/json /v3/alipay/trade/overseas/settle: post: description: 境内收单跨境结算 operationId: alipay.trade.overseas.settle requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayTradeOverseasSettleModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeOverseasSettleResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_overseas_settle_default_response' description: 请求失败 summary: 统一境内收单跨境结算接口 tags: - alipay.trade.overseas x-content-type: application/json x-accepts: application/json /v3/alipay/trade/pay: post: description: 收银员使用扫码设备读取用户手机支付宝“付款码”获取设备(如扫码枪)读取用户手机支付宝的付款码信息后,将二维码或条码信息通过本接口上送至支付宝发起支付。 operationId: alipay.trade.pay requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayTradePayModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradePayResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_pay_default_response' description: 请求失败 summary: 统一收单交易支付接口 tags: - alipay.trade x-content-type: application/json x-accepts: application/json /v3/alipay/trade/precreate: post: description: 收银员通过收银台或商户后台调用支付宝接口,生成二维码后,展示给用户,由用户扫描二维码完成订单支付。 operationId: alipay.trade.precreate requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayTradePrecreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradePrecreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_precreate_default_response' description: 请求失败 summary: 统一收单线下交易预创建 tags: - alipay.trade x-content-type: application/json x-accepts: application/json /v3/alipay/trade/query: post: description: "该接口提供所有支付宝支付订单的查询,商户可以通过该接口主动查询订单状态,完成下一步的业务逻辑。\r\n需要调用查询接口的情况\ :\r\n当商户后台、网络、服务器等出现异常,商户系统最终未接收到支付通知;\r\n调用支付接口后,返回系统错误或未知交易状态情况;\r\n调用alipay.trade.pay,\ 返回INPROCESS的状态;\r\n调用alipay.trade.cancel之前,需确认支付状态;" operationId: alipay.trade.query requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayTradeQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_query_default_response' description: 请求失败 summary: 统一收单交易查询 tags: - alipay.trade x-content-type: application/json x-accepts: application/json /v3/alipay/trade/refund: post: description: "当交易发生之后一段时间内,由于买家或者卖家的原因需要退款时,卖家可以通过退款接口将支付款退还给买家,支付宝将在收到退款请求并\ 且验证成功之后,按照退款规则将支付款按原路退到买家帐号上。\n交易超过约定时间(签约时设置的可退款时间)的订单无法进行退款。 \n支付宝退款支持单笔\ 交易分多次退款,多次退款需要提交原支付订单的订单号和设置不同的退款请求号。一笔退款失败后重新提交,要保证重试时退款请求号不能变更,防止该笔交易重复退\ 款。 \n同一笔交易累计提交的退款金额不能超过原始交易总金额。" operationId: alipay.trade.refund requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayTradeRefundModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeRefundResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_refund_default_response' description: 请求失败 summary: 统一收单交易退款接口 tags: - alipay.trade x-content-type: application/json x-accepts: application/json /v3/alipay/trade/refund/apply: post: description: 商户通过此接口提交异步退款请求,支付宝受理后,将会异步进行退款处理。退款完成后异步通知商户退款结果,商户可以通过alipay.trade.fastpay.refund.query接口查询退款状态。 operationId: alipay.trade.refund.apply requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayTradeRefundApplyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeRefundApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_refund_apply_default_response' description: 请求失败 summary: 异步退款受理接口 tags: - alipay.trade.refund x-content-type: application/json x-accepts: application/json /v3/alipay/trade/royalty/rate/query: get: description: 商户签约分账产品后,商户或其授权ISV可对分账比例进行查询。 operationId: alipay.trade.royalty.rate.query parameters: - description: 外部请求号,由商家自定义。32个字符以内,仅可包含字母、数字、下划线。需保证在商户端不重复。 explode: true in: query name: out_request_no required: false schema: example: "20220823165400001" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeRoyaltyRateQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_royalty_rate_query_default_response' description: 请求失败 summary: 分账比例查询 tags: - alipay.trade.royalty.rate x-accepts: application/json /v3/alipay/trade/royalty/relation/batchquery: post: description: 当商户签约分账产品后,授权ISV帮其进行分账关系的维护。本接口用于商户与分账方的关系查询。 operationId: alipay.trade.royalty.relation.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayTradeRoyaltyRelationBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeRoyaltyRelationBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_royalty_relation_batchquery_default_response' description: 请求失败 summary: 分账关系查询 tags: - alipay.trade.royalty.relation x-content-type: application/json x-accepts: application/json /v3/alipay/trade/royalty/relation/bind: post: description: 当商户签约分账产品后,授权ISV帮其进行分账关系的维护。本接口用于商户与分账方的关系绑定。 operationId: alipay.trade.royalty.relation.bind requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayTradeRoyaltyRelationBindModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeRoyaltyRelationBindResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_royalty_relation_bind_default_response' description: 请求失败 summary: 分账关系绑定 tags: - alipay.trade.royalty.relation x-content-type: application/json x-accepts: application/json /v3/alipay/trade/royalty/relation/unbind: post: description: 当商户签约分账产品后,授权ISV帮其进行分账关系的维护。本接口用于商户与分账方的关系解绑。 operationId: alipay.trade.royalty.relation.unbind requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayTradeRoyaltyRelationUnbindModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeRoyaltyRelationUnbindResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_royalty_relation_unbind_default_response' description: 请求失败 summary: 分账关系解绑 tags: - alipay.trade.royalty.relation x-content-type: application/json x-accepts: application/json /v3/alipay/trade/settle/confirm: post: description: |- 用户付款后,平台上的卖家发货,用户收到商品确认收货后,平台通过确认结算接口,将交易款结算给指定的卖家账户。 单笔结算到卖家余额的场景支持分账冻结。在确认结算时,传入冻结标识 royalty_freeze=true,资金结算到卖家支付宝余额后,会先冻结在不可用余额中,后续分账将自动从冻结余额划出,平台商可调用分账完结释放冻结资金,系统默认在冻结30天后自动解冻。解冻后,仍可以发起分账。为保证分账成功率,请尽可能在分账冻结期内分账。 operationId: alipay.trade.settle.confirm requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayTradeSettleConfirmModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeSettleConfirmResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_settle_confirm_default_response' description: 请求失败 summary: 统一收单确认结算接口 tags: - alipay.trade.settle x-content-type: application/json x-accepts: application/json /v3/alipay/trade/settle/receivables/query: post: description: 对外提供待结算资金查询的能力。 operationId: alipay.trade.settle.receivables.query requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayTradeSettleReceivablesQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayTradeSettleReceivablesQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_trade_settle_receivables_query_default_response' description: 请求失败 summary: 待结算查询 tags: - alipay.trade.settle.receivables x-content-type: application/json x-accepts: application/json /v3/alipay/user/agreement/executionplan/modify: post: description: 周期性扣款产品,商户延期扣款接口 operationId: alipay.user.agreement.executionplan.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayUserAgreementExecutionplanModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayUserAgreementExecutionplanModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_user_agreement_executionplan_modify_default_response' description: 请求失败 summary: 周期性扣款协议执行计划修改接口 tags: - alipay.user.agreement.executionplan x-content-type: application/json x-accepts: application/json /v3/alipay/user/agreement/migrate: post: description: 由商户调用,将商户与用户签署的代扣协议内容进行迁移,包括协议主体迁移等 operationId: alipay.user.agreement.migrate requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayUserAgreementMigrateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayUserAgreementMigrateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_user_agreement_migrate_default_response' description: 请求失败 summary: 代扣协议迁移 tags: - alipay.user.agreement x-content-type: application/json x-accepts: application/json /v3/alipay/user/agreement/permission/create: post: description: 支付宝协议支付许可创建接口、服务变更发送消息提醒接口 operationId: alipay.user.agreement.permission.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayUserAgreementPermissionCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayUserAgreementPermissionCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_user_agreement_permission_create_default_response' description: 请求失败 summary: 支付宝协议支付许可创建、服务变更接口 tags: - alipay.user.agreement.permission x-content-type: application/json x-accepts: application/json /v3/alipay/user/agreement/query: get: description: 支付宝个人代扣协议查询接口 operationId: alipay.user.agreement.query parameters: - description: 协议产品码,商户和支付宝签约时确定,商户可咨询技术支持。 explode: true in: query name: personal_product_code required: false schema: example: GENERAL_WITHHOLDING_P type: string style: form - description: "用户的支付宝账号对应 的支付宝唯一用户号,以 2088 开头的 16 位纯数字 组成。\t本参数与alipay_logon_id若\ 都填写,则以本参数为准,优先级高于 alipay_logon_id。" explode: true in: query name: alipay_user_id required: false schema: example: "2088101122675263" type: string style: form - description: "用户的支付宝账号对应 的支付宝唯一用户号,\t本参数与alipay_logon_id若都填写,则以本参数为准,优先级高于\ \ alipay_logon_id。" explode: true in: query name: alipay_open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form - description: 用户的支付宝登录账号,支持邮箱或手机号码格式。本参数与alipay_open_id 或 alipay_user_id 同时填写,优先按照 alipay_open_id 或 alipay_user_id 处理。 explode: true in: query name: alipay_logon_id required: false schema: example: abx@alitest.com type: string style: form - description: "签约场景码,该值需要与系统/页面签约接口调用时传入的值保持一 致。如:周期扣款场景与调用 alipay.user.agreement.page.sign(支\ 付宝个人协议页面签约接口) 签约时的 sign_scene 相同。 \t注意:当传入商户签约号 external_agreement_no 时,\ 该值不能为空或默认值 DEFAULT|DEFAULT。\t" explode: true in: query name: sign_scene required: false schema: example: INDUSTRY|MEDICAL type: string style: form - description: "代扣协议中标示用户的唯一签约号(确保在商户系统中\t唯一)。\t格式规则:支持大写小写字母和数字,最长 32 位。" explode: true in: query name: external_agreement_no required: false schema: example: test type: string style: form - description: "签约第三方主体类型。对于三方协议,表示当前用户和哪一类的第三方主体进行签约。\t默认为PARTNER。" explode: true in: query name: third_party_type required: false schema: example: PARTNER type: string style: form - description: 支付宝系统中用以唯一标识用户签约记录的编号(用户签约成功后的协议号 ) ,如果传了该参数,其他参数会被忽略 explode: true in: query name: agreement_no required: false schema: example: "20170322450983769228" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayUserAgreementQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_user_agreement_query_default_response' description: 请求失败 summary: 支付宝个人代扣协议查询接口 tags: - alipay.user.agreement x-accepts: application/json /v3/alipay/user/agreement/transfer: post: description: 由商户调用,将商户之前通用代扣产品转移到周期扣的协议产品 operationId: alipay.user.agreement.transfer requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayUserAgreementTransferModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayUserAgreementTransferResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_user_agreement_transfer_default_response' description: 请求失败 summary: 协议由普通通用代扣协议产品转移到周期扣协议产品 tags: - alipay.user.agreement x-content-type: application/json x-accepts: application/json /v3/alipay/user/agreement/unsign: post: description: 支付宝个人代扣协议解约接口 operationId: alipay.user.agreement.unsign requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayUserAgreementUnsignModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayUserAgreementUnsignResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_user_agreement_unsign_default_response' description: 请求失败 summary: 支付宝个人代扣协议解约接口 tags: - alipay.user.agreement x-content-type: application/json x-accepts: application/json /v3/alipay/user/agreement/userverify/apply: post: description: 验证协议对应的用户信息 operationId: alipay.user.agreement.userverify.apply requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayUserAgreementUserverifyApplyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayUserAgreementUserverifyApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_user_agreement_userverify_apply_default_response' description: 请求失败 summary: 协议用户一致性验证 tags: - alipay.user.agreement.userverify x-content-type: application/json x-accepts: application/json /v3/alipay/user/agreement/userverify/query: get: description: 商户使用用户验证申请接口时,获取token,然后通过次接口回去验证状态 operationId: alipay.user.agreement.userverify.query parameters: - description: 协议号 explode: true in: query name: agreement_no required: false schema: example: "20170502000610755993" type: string style: form - description: 申请时获取的token explode: true in: query name: apply_token required: false schema: example: MDEDUCT0068292ca377d1d44b65fa24ec9cd89132f type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayUserAgreementUserverifyQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_user_agreement_userverify_query_default_response' description: 请求失败 summary: 用户协议鉴权查询结果 tags: - alipay.user.agreement.userverify x-accepts: application/json /v3/alipay/user/alipaypoint/budgetlib/query: get: description: 用于查询集分宝预算库详情 operationId: alipay.user.alipaypoint.budgetlib.query parameters: - description: 集分宝预算库编码 explode: true in: query name: budget_code required: false schema: example: "20201107050844" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayUserAlipaypointBudgetlibQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_user_alipaypoint_budgetlib_query_default_response' description: 请求失败 summary: 查询集分宝预算库详情 tags: - alipay.user.alipaypoint.budgetlib x-accepts: application/json /v3/alipay/user/alipaypoint/send: post: description: 用于发放商户采购的集分宝给到支付宝用户 operationId: alipay.user.alipaypoint.send requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayUserAlipaypointSendModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayUserAlipaypointSendResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_user_alipaypoint_send_default_response' description: 请求失败 summary: 集分宝发放接口 tags: - alipay.user.alipaypoint x-content-type: application/json x-accepts: application/json /v3/alipay/user/certdoc/certverify/consult: get: description: 商户在预咨询接口(接口1)预先录入某用户的实名证件信息(例如姓名、身份证号等),获得用户授权后调用本咨询接口(接口2),将对比该用户的支付宝实名信息与(接口1)传入的信息是否一致。 operationId: alipay.user.certdoc.certverify.consult parameters: - allowEmptyValue: true description: 用户授权令牌 explode: true in: query name: auth_token required: false schema: type: string style: form - description: 信息校验验证ID。通过alipay.user.certdoc.certverify.preconsult(实名证件信息比对验证预咨询)接口获取。 explode: true in: query name: verify_id required: false schema: example: 671ffcda5447bc87e9ed2f669eb143d4 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayUserCertdocCertverifyConsultResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_user_certdoc_certverify_consult_default_response' description: 请求失败 summary: 实名证件信息比对验证咨询 tags: - alipay.user.certdoc.certverify x-accepts: application/json /v3/alipay/user/certdoc/certverify/preconsult: post: description: 商户在该接口(接口1)预先录入某用户的实名证件信息(例如姓名、身份证号等),获得用户授权后调用咨询接口(接口2),将对比该用户的支付宝实名信息与该(接口1)传入的信息是否一致。 operationId: alipay.user.certdoc.certverify.preconsult requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayUserCertdocCertverifyPreconsultModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayUserCertdocCertverifyPreconsultResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_user_certdoc_certverify_preconsult_default_response' description: 请求失败 summary: 实名证件信息比对验证预咨询 tags: - alipay.user.certdoc.certverify x-content-type: application/json x-accepts: application/json /v3/alipay/user/certify/open/initialize: post: description: 支付宝开放认证初始化服务,用于创建开放认证流程。注意:港澳台同胞身份验证服务仅支持在支付宝客户端内使用,外部 APP 使用该项服务需唤起支付宝客户端。 operationId: alipay.user.certify.open.initialize requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayUserCertifyOpenInitializeModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayUserCertifyOpenInitializeResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_user_certify_open_initialize_default_response' description: 请求失败 summary: 身份认证初始化服务 tags: - alipay.user.certify.open x-content-type: application/json x-accepts: application/json /v3/alipay/user/certify/open/query: get: description: 商户在开放认证完成后,调用本接口查询认证状态和相关数据 operationId: alipay.user.certify.open.query parameters: - description: 本次申请操作的唯一标识,通过alipay.user.certify.open.initialize(身份认证初始化服务)接口同步响应获取。 explode: true in: query name: certify_id required: false schema: example: OC201809253000000393900404029253 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayUserCertifyOpenQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_user_certify_open_query_default_response' description: 请求失败 summary: 身份认证记录查询 tags: - alipay.user.certify.open x-accepts: application/json /v3/alipay/user/info/share: post: description: 配合支付宝会员授权接口,查询授权信息。 operationId: alipay.user.info.share parameters: - allowEmptyValue: true description: 用户授权令牌 explode: true in: query name: auth_token required: false schema: type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayUserInfoShareResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_user_info_share_default_response' description: 请求失败 summary: 支付宝会员授权信息查询接口 tags: - alipay.user.info x-accepts: application/json /v3/alipay/user/twostage/common/use: post: description: 商家通过小程序/卡券开放权益(优惠券),用户在小程序/卡券授权后,打开付款码时通过该接口获取用户信息。 operationId: alipay.user.twostage.common.use requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayUserTwostageCommonUseModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayUserTwostageCommonUseResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_user_twostage_common_use_default_response' description: 请求失败 summary: 通用当面付二阶段接口 tags: - alipay.user.twostage.common x-content-type: application/json x-accepts: application/json /v3/alipay/user/twostage/indirect/use: post: description: |- 间连模式通过双联向银行输出付款码查UID接口. 双联二阶段里,授权之后调用该接口,进行解码并校验双联pid、银行orgId、isv sourceId及学校smid之间的级联关系;检查授权关系;解码并返回用户uid operationId: alipay.user.twostage.indirect.use requestBody: content: application/json: schema: $ref: '#/components/schemas/AlipayUserTwostageIndirectUseModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayUserTwostageIndirectUseResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_user_twostage_indirect_use_default_response' description: 请求失败 summary: 双联二阶段 tags: - alipay.user.twostage.indirect x-content-type: application/json x-accepts: application/json /v3/alipay/user/userinfo/share: post: description: "外部应用上架到支付宝钱包,当支付宝用户从钱包访问外部应用时,会跳转到外部应用并带上用户的授权码。\r\n外部应用用授权码调用\ 授权令牌交换API(alipay.system.oauth.token)可得到授权令牌。\r\n用授权令牌调用此接口得到支付宝会员相关信息。\r\n\ 特别说明:此接口的不需要授权是指不需外部应用主动引导用户授权,支付宝钱包会在引导用户授权后,\r\n带上授权码再跳转到外部应用。" operationId: alipay.user.userinfo.share responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlipayUserUserinfoShareResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/alipay_user_userinfo_share_default_response' description: 请求失败 summary: 支付宝钱包用户信息共享 tags: - alipay.user.userinfo x-accepts: application/json /v3/ant/merchant/expand/apprecommend/account/create: post: description: 将账号与小程序进行绑定,用于支付推荐场景 operationId: ant.merchant.expand.apprecommend.account.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandApprecommendAccountCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandApprecommendAccountCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_apprecommend_account_create_default_response' description: 请求失败 summary: 关联账号和小程序 tags: - ant.merchant.expand.apprecommend.account x-content-type: application/json x-accepts: application/json /v3/ant/merchant/expand/apprecommend/account/delete: delete: description: 取消账号与小程序的绑定,用于支付推荐场景 operationId: ant.merchant.expand.apprecommend.account.delete parameters: - description: 待解绑小程序的app_id explode: true in: query name: app_no required: false schema: example: "2021000155639069" type: string style: form - description: 待解绑账号PID explode: true in: query name: acc_no required: false schema: example: 20880019****4501 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandApprecommendAccountDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_apprecommend_account_delete_default_response' description: 请求失败 summary: 取消关联账号和小程序 tags: - ant.merchant.expand.apprecommend.account x-accepts: application/json /v3/ant/merchant/expand/apprecommend/account/query: get: description: 查询已关联指定APP的账号列表,用于支付推荐场景 operationId: ant.merchant.expand.apprecommend.account.query parameters: - description: 已关联小程序的app_id explode: true in: query name: app_no required: false schema: example: 20210001****9069 type: string style: form - description: 单页行数,不能超过100行 explode: true in: query name: page_size required: false schema: example: 10 type: integer style: form - description: 页码 explode: true in: query name: page_number required: false schema: example: 1 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandApprecommendAccountQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_apprecommend_account_query_default_response' description: 请求失败 summary: 查询已关联指定APP的账号列表 tags: - ant.merchant.expand.apprecommend.account x-accepts: application/json /v3/ant/merchant/expand/apprecommend/available/query: get: description: 查询可关联APP的账号列表,用于支付推荐场景 operationId: ant.merchant.expand.apprecommend.available.query parameters: - description: 单页行数,不能超过100行 explode: true in: query name: page_size required: false schema: example: 10 type: integer style: form - description: 页码 explode: true in: query name: page_number required: false schema: example: 1 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandApprecommendAvailableQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_apprecommend_available_query_default_response' description: 请求失败 summary: 查询可关联APP的账号列表 tags: - ant.merchant.expand.apprecommend.available x-accepts: application/json /v3/ant/merchant/expand/info/query: get: description: 提供商户号查询商户基础信息 operationId: ant.merchant.expand.info.query parameters: - description: 商户号,目前是商户pid explode: true in: query name: merchant_no required: false schema: example: "2088123456788765" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandInfoQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_info_query_default_response' description: 请求失败 summary: 蚂蚁商户信息查询接口 tags: - ant.merchant.expand.info x-accepts: application/json /v3/ant/merchant/expand/item/create: post: description: 用于服务商或商户创建商品 operationId: ant.merchant.expand.item.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandItemCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandItemCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_item_create_default_response' description: 请求失败 summary: 商品创建接口 tags: - ant.merchant.expand.item x-content-type: application/json x-accepts: application/json /v3/ant/merchant/expand/item/delete: delete: description: 用于服务商或商户删除商品 operationId: ant.merchant.expand.item.delete parameters: - description: "商品ID(item_id不为空则以item_id作为删除KEY,item_id为空则以external_item_id作\ 为删除KEY,两者不能同时为空)" explode: true in: query name: item_id required: false schema: example: "2018091300502200002600104169" type: string style: form - description: "外部商品ID(item_id不为空则以item_id作为删除KEY,item_id为空则以external_item_id作\ 为删除KEY,两者不能同时为空)" explode: true in: query name: external_item_id required: false schema: example: "20190916123124123123123" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandItemDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_item_delete_default_response' description: 请求失败 summary: 商品删除接口 tags: - ant.merchant.expand.item x-accepts: application/json /v3/ant/merchant/expand/item/modify: post: description: 用于服务商或商户修改商品 operationId: ant.merchant.expand.item.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandItemModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandItemModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_item_modify_default_response' description: 请求失败 summary: 商品修改接口 tags: - ant.merchant.expand.item x-content-type: application/json x-accepts: application/json /v3/ant/merchant/expand/item/open/batchquery: post: description: 用于ISV或商户批量查询商品 operationId: ant.merchant.expand.item.open.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandItemOpenBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandItemOpenBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_item_open_batchquery_default_response' description: 请求失败 summary: 批量查询商品接口 tags: - ant.merchant.expand.item.open x-content-type: application/json x-accepts: application/json /v3/ant/merchant/expand/item/open/create: post: description: 用于ISV或商户创建商品 operationId: ant.merchant.expand.item.open.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandItemOpenCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandItemOpenCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_item_open_create_default_response' description: 请求失败 summary: 创建商品接口 tags: - ant.merchant.expand.item.open x-content-type: application/json x-accepts: application/json /v3/ant/merchant/expand/item/open/delete: delete: description: 用于ISV或商户删除商品 operationId: ant.merchant.expand.item.open.delete parameters: - description: 商品ID explode: true in: query name: item_id required: false schema: example: "2019073100702219000000100000" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandItemOpenDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_item_open_delete_default_response' description: 请求失败 summary: 删除商品接口 tags: - ant.merchant.expand.item.open x-accepts: application/json /v3/ant/merchant/expand/item/open/modify: post: description: 用于ISV或商户修改商品 operationId: ant.merchant.expand.item.open.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandItemOpenModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandItemOpenModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_item_open_modify_default_response' description: 请求失败 summary: 修改商品接口 tags: - ant.merchant.expand.item.open x-content-type: application/json x-accepts: application/json /v3/ant/merchant/expand/item/open/query: get: description: 用于ISV或商户查询商品 operationId: ant.merchant.expand.item.open.query parameters: - description: "商品归属主体ID\t例:商品归属主体类型target_type为店铺,则商品归属主体ID为店铺ID(支付宝侧店铺ID);\ 归属主体类型target_type为小程序,则归属主体ID为小程序ID" explode: true in: query name: target_id required: false schema: example: "2018090600502000000022501261" type: string style: form - description: 场景码(具体值请参见产品文档)。 explode: true in: query name: scene required: false schema: example: APP_ORDER type: string style: form - description: "商品归属主体类型。枚举如下:\t5:店铺。\t8:小程序。" explode: true in: query name: target_type required: false schema: example: "8" type: string style: form - description: 商品状态 explode: true in: query name: status required: false schema: example: EFFECT type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandItemOpenQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_item_open_query_default_response' description: 请求失败 summary: 查询商品接口 tags: - ant.merchant.expand.item.open x-accepts: application/json /v3/ant/merchant/expand/item/query: get: description: 用于服务商或商户查询其商品信息 operationId: ant.merchant.expand.item.query parameters: - description: "商品归属主体类型:\r\t5: 店铺\r\t4: 主站MID\r\t3: 参与者\r\t2: 角色\r\t1: 联系人" explode: true in: query name: target_type required: false schema: example: "5" type: string style: form - description: 商品归属主体id explode: true in: query name: target_id required: false schema: example: "2018090600502000000022501261" type: string style: form - description: "未分类类目: true 的时候 front_category_id 必须不填(null)" explode: true in: query name: undefined_category required: false schema: example: false type: boolean style: form - description: "商品前台类目id: null 表示所有分类" explode: true in: query name: front_category_id required: false schema: example: "2018091300502200002600105884" type: string style: form - description: 商品状态:EFFECT、INVALID、PAUSE;不填返回所有状态商品 explode: true in: query name: status required: false schema: example: EFFECT type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandItemQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_item_query_default_response' description: 请求失败 summary: 商品查询接口 tags: - ant.merchant.expand.item x-accepts: application/json /v3/ant/merchant/expand/item/status/modify: post: description: 用于服务商或商户修改商品状态 operationId: ant.merchant.expand.item.status.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandItemStatusModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandItemStatusModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_item_status_modify_default_response' description: 请求失败 summary: 商品状态修改接口 tags: - ant.merchant.expand.item.status x-content-type: application/json x-accepts: application/json /v3/ant/merchant/expand/shop/consult: post: description: 蚂蚁店铺创建咨询 operationId: ant.merchant.expand.shop.consult requestBody: content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandShopConsultModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandShopConsultResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_shop_consult_default_response' description: 请求失败 summary: 蚂蚁店铺创建咨询 tags: - ant.merchant.expand.shop x-content-type: application/json x-accepts: application/json /v3/ant/merchant/expand/shop/receiptaccount/save: post: description: 店铺增加收单账号 operationId: ant.merchant.expand.shop.receiptaccount.save requestBody: content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandShopReceiptaccountSaveModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandShopReceiptaccountSaveResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_shop_receiptaccount_save_default_response' description: 请求失败 summary: 店铺增加收单账号 tags: - ant.merchant.expand.shop.receiptaccount x-content-type: application/json x-accepts: application/json /v3/ant/merchant/indirect/image: post: description: 图片上传 operationId: ant.merchant.expand.indirect.image.upload requestBody: content: multipart/form-data: encoding: data: contentType: application/json style: form image_content: contentType: '*/*' style: form schema: $ref: '#/components/schemas/ant_merchant_expand_indirect_image_upload_request' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandIndirectImageUploadResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_indirect_image_upload_default_response' description: 请求失败 summary: 图片上传 tags: - ant.merchant.expand.indirect.image x-content-type: multipart/form-data x-accepts: application/json /v3/ant/merchant/mcc/query: get: description: 用于查询商户的新版本mcc行业信息 operationId: ant.merchant.expand.mcc.query parameters: - description: 传入需要查询的code列表,以英文逗号分隔 explode: true in: query name: mcc_code_list required: false schema: example: "B0001,B0002" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandMccQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_mcc_query_default_response' description: 请求失败 summary: 商户mcc信息查询 tags: - ant.merchant.expand.mcc x-accepts: application/json /v3/ant/merchant/order/{order_id}: get: description: 服务商根据申请单id,查询自己提交的商户进件、管理等申请单 operationId: ant.merchant.expand.order.query parameters: - description: '申请单 id。 1.蚂蚁门店管理场景:通过 ant.merchant.expand.shop.create(蚂蚁店铺创建)接口进件时返回的order_id。 2.直付通二级商户进件场景:通过ant.merchant.expand.indirect.zft.create(直付通二级商户创建)接口进件时返回的order_id。 ' explode: false in: path name: order_id required: true schema: example: "2017112200502000000004754299" type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandOrderQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_order_query_default_response' description: 请求失败 summary: 商户申请单查询 tags: - ant.merchant.expand.order x-accepts: application/json /v3/ant/merchant/shop: get: description: 用于服务商或商户查询其自己的店铺信息 operationId: ant.merchant.expand.shop.query parameters: - description: 蚂蚁店铺id explode: true in: query name: shop_id required: false schema: example: "2018011900502000000005124744" type: string style: form - description: 门店编号,表示该门店在该商户角色id(直连pid,间连smid)下,由商户自己定义的外部门店编号 explode: true in: query name: store_id required: false schema: example: NO0001 type: string style: form - description: 商户角色id,表示将要开的店属于哪个商户角色。对于直连开店场景,填写商户pid;对于间连开店场景(线上、线下、直付通),填写商户smid explode: true in: query name: ip_role_id required: false schema: example: "2088301155943087" type: string style: form - description: 行政区划版本,当前可传空值(取默认版本)、2022Q2、UPTODATE(取最新版本),其中空值默认为:2020Q1版本( address_version=''或null),想要查看版本是2022年2季度版本则传入:(address_version='2022Q2'),想要获取最新版本则传入:(address_version ='UPTODATE') explode: true in: query name: address_version required: false schema: example: 2022Q2 type: string style: form - description: 门店不置信时,是否需要返回shop_recommend_info explode: true in: query name: need_recommend required: false schema: example: "0" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandShopQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_shop_query_default_response' description: 请求失败 summary: 店铺查询接口 tags: - ant.merchant.expand.shop x-accepts: application/json patch: description: 修改蚂蚁店铺,按信息项修改。若无特殊说明,如果某项存在但是没填写,则不会覆盖掉原来的值 operationId: ant.merchant.expand.shop.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandShopModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandShopModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_shop_modify_default_response' description: 请求失败 summary: 修改蚂蚁店铺 tags: - ant.merchant.expand.shop x-content-type: application/json x-accepts: application/json post: description: 创建蚂蚁店铺 operationId: ant.merchant.expand.shop.create requestBody: content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandShopCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandShopCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_shop_create_default_response' description: 请求失败 summary: 蚂蚁店铺创建 tags: - ant.merchant.expand.shop x-content-type: application/json x-accepts: application/json /v3/ant/merchant/shop/close: patch: description: 通过shop_id,关闭蚂蚁店铺。 operationId: ant.merchant.expand.shop.close requestBody: content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandShopCloseModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandShopCloseResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_shop_close_default_response' description: 请求失败 summary: 蚂蚁店铺关闭 tags: - ant.merchant.expand.shop x-content-type: application/json x-accepts: application/json /v3/ant/merchant/shop/pagequery: get: description: 用于服务商或商户查询其自己的店铺信息 operationId: ant.merchant.expand.shop.page.query parameters: - description: 商户角色id,表示将要开的店属于哪个商户角色。对于直连开店场景,填写商户pid;对于间连开店场景(线上、线下、直付通),填写商户smid。特别说明:IoT设备三绑定场景统一填写商户pid explode: true in: query name: ip_role_id required: false schema: example: "2088301155943087" type: string style: form - description: 查询页数 explode: true in: query name: page_num required: false schema: example: 1 type: integer style: form - description: 每页查询大小,限制100以内 explode: true in: query name: page_size required: false schema: example: 10 type: integer style: form - description: 行政区划版本,当前可传空值(取默认版本)、2022Q2、UPTODATE(取最新版本),其中空值默认为:2020Q1版本(address_version=''或null),想要查看版本是2022年2季度版本则传入:(address_version='2022Q2'),想要获取最新版本则传入:(address_version ='UPTODATE') explode: true in: query name: address_version required: false schema: example: 2022Q2 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AntMerchantExpandShopPageQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/ant_merchant_expand_shop_page_query_default_response' description: 请求失败 summary: 店铺分页查询接口 tags: - ant.merchant.expand.shop.page x-accepts: application/json /v3/anttech/oceanbase/testplatform/task/query: post: description: 获取ob开源官网提测平台待执行任务接口,用于测试任务 operationId: anttech.oceanbase.testplatform.task.query requestBody: content: application/json: schema: $ref: '#/components/schemas/AnttechOceanbaseTestplatformTaskQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/AnttechOceanbaseTestplatformTaskQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/anttech_oceanbase_testplatform_task_query_default_response' description: 请求失败 summary: 获取ob开源官网提测平台待执行任务接口 tags: - anttech.oceanbase.testplatform.task x-content-type: application/json x-accepts: application/json /v3/datadigital/fincloud/generalsaas/face/certify/initialize: post: description: 人脸核身初始化服务,用于创建认证流程。供外部客户使用该项服务。 operationId: datadigital.fincloud.generalsaas.face.certify.initialize requestBody: content: application/json: schema: $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasFaceCertifyInitializeModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasFaceCertifyInitializeResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/datadigital_fincloud_generalsaas_face_certify_initialize_default_response' description: 请求失败 summary: H5人脸核身初始化 tags: - datadigital.fincloud.generalsaas.face.certify x-content-type: application/json x-accepts: application/json /v3/datadigital/fincloud/generalsaas/face/certify/query: get: description: 商户在用户使用支付宝完成刷脸之后,调用本接口查询核身结果状态及相关数据 operationId: datadigital.fincloud.generalsaas.face.certify.query parameters: - description: "本次申请操作的唯一标识,通过datadigital.fincloud.generalsaas.face.certify.initialize\t\ 接口同步响应获取。" explode: true in: query name: certify_id required: false schema: example: 03cdsfsss20048373 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasFaceCertifyQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/datadigital_fincloud_generalsaas_face_certify_query_default_response' description: 请求失败 summary: H5人脸核身查询记录 tags: - datadigital.fincloud.generalsaas.face.certify x-accepts: application/json /v3/datadigital/fincloud/generalsaas/face/certify/verify: post: description: H5人脸核身服务开始认证。请根据返回结果渲染页面。 operationId: datadigital.fincloud.generalsaas.face.certify.verify requestBody: content: application/json: schema: $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasFaceCertifyVerifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasFaceCertifyVerifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/datadigital_fincloud_generalsaas_face_certify_verify_default_response' description: 请求失败 summary: H5人脸核身开始认证 tags: - datadigital.fincloud.generalsaas.face.certify x-content-type: application/json x-accepts: application/json /v3/datadigital/fincloud/generalsaas/face/check/initialize: post: description: 人脸检测业务单据初始化 operationId: datadigital.fincloud.generalsaas.face.check.initialize requestBody: content: application/json: schema: $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasFaceCheckInitializeModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasFaceCheckInitializeResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/datadigital_fincloud_generalsaas_face_check_initialize_default_response' description: 请求失败 summary: 活体检测初始化 tags: - datadigital.fincloud.generalsaas.face.check x-content-type: application/json x-accepts: application/json /v3/datadigital/fincloud/generalsaas/face/check/query: get: description: 用于查询活体检测结果。 operationId: datadigital.fincloud.generalsaas.face.check.query parameters: - description: 传入初始化接口datadigital.fincloud.generalsaas.face.check.initialize 得到的certify_id explode: true in: query name: certify_id required: false schema: example: dddddfsss88833ssf type: string style: form - description: 是否需要返回活体结果图片,needAlivePhoto:Y_O (原始图片)、Y_M(虚化,背景马赛克)、N(不返图)。非必填,默认为N explode: true in: query name: need_alive_photo required: false schema: example: Y_M type: string style: form - description: 该入参已经废弃。 explode: true in: query name: need_score required: false schema: example: "Y" type: string style: form - description: 是否需要返回图片质量分,非必填,默认值为N。 N表示不需要,Y表示需要 explode: true in: query name: need_quality_score required: false schema: example: "N" type: string style: form - description: 该参数已废弃 explode: true in: query name: need_attack_result required: false schema: example: "N" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasFaceCheckQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/datadigital_fincloud_generalsaas_face_check_query_default_response' description: 请求失败 summary: 活体检测结果查询 tags: - datadigital.fincloud.generalsaas.face.check x-accepts: application/json /v3/datadigital/fincloud/generalsaas/face/source/certify: post: description: 上传人脸照片,调用权威核验源进行验证 operationId: datadigital.fincloud.generalsaas.face.source.certify requestBody: content: multipart/form-data: encoding: file_content: contentType: '*/*' style: form data: contentType: application/json style: form schema: $ref: '#/components/schemas/datadigital_fincloud_generalsaas_face_source_certify_request' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasFaceSourceCertifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/datadigital_fincloud_generalsaas_face_source_certify_default_response' description: 请求失败 summary: 纯服务端人脸核身 tags: - datadigital.fincloud.generalsaas.face.source x-content-type: multipart/form-data x-accepts: application/json /v3/datadigital/fincloud/generalsaas/face/verification/initialize: post: description: 人脸核身初始化接口 operationId: datadigital.fincloud.generalsaas.face.verification.initialize requestBody: content: application/json: schema: $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasFaceVerificationInitializeModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasFaceVerificationInitializeResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/datadigital_fincloud_generalsaas_face_verification_initialize_default_response' description: 请求失败 summary: 人脸核身初始化 tags: - datadigital.fincloud.generalsaas.face.verification x-content-type: application/json x-accepts: application/json /v3/datadigital/fincloud/generalsaas/face/verification/query: get: description: 查询核身结果 operationId: datadigital.fincloud.generalsaas.face.verification.query parameters: - description: 填入人脸核身初始化阶段获取到的certify_id explode: true in: query name: certify_id required: false schema: example: adsfasdfasdf type: string style: form - description: 是否需要返回活体结果图片,needAlivePhoto:Y_O (原始图片)、Y_M(虚化,背景马赛克)、N(不返图),默认为N explode: true in: query name: need_alive_photo required: false schema: example: "N" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasFaceVerificationQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/datadigital_fincloud_generalsaas_face_verification_query_default_response' description: 请求失败 summary: 人脸核身结果查询 tags: - datadigital.fincloud.generalsaas.face.verification x-accepts: application/json /v3/datadigital/fincloud/generalsaas/ocr/mobile/initialize: post: description: OCR端云一体化识别 operationId: datadigital.fincloud.generalsaas.ocr.mobile.initialize requestBody: content: application/json: schema: $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasOcrMobileInitializeModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasOcrMobileInitializeResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/datadigital_fincloud_generalsaas_ocr_mobile_initialize_default_response' description: 请求失败 summary: App端OCR初始化 tags: - datadigital.fincloud.generalsaas.ocr.mobile x-content-type: application/json x-accepts: application/json /v3/datadigital/fincloud/generalsaas/ocr/server/detect: post: description: 纯服务端OCR对接 operationId: datadigital.fincloud.generalsaas.ocr.server.detect requestBody: content: multipart/form-data: encoding: file_content: contentType: '*/*' style: form data: contentType: application/json style: form schema: $ref: '#/components/schemas/datadigital_fincloud_generalsaas_ocr_server_detect_request' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasOcrServerDetectResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/datadigital_fincloud_generalsaas_ocr_server_detect_default_response' description: 请求失败 summary: 服务端OCR tags: - datadigital.fincloud.generalsaas.ocr.server x-content-type: multipart/form-data x-accepts: application/json /v3/koubei/marketing/campaign/intelligent/promo/batchquery: post: description: 智能营销活动批量查询 operationId: koubei.marketing.campaign.intelligent.promo.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/KoubeiMarketingCampaignIntelligentPromoBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/KoubeiMarketingCampaignIntelligentPromoBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/koubei_marketing_campaign_intelligent_promo_batchquery_default_response' description: 请求失败 summary: 智能营销活动批量查询 tags: - koubei.marketing.campaign.intelligent.promo x-content-type: application/json x-accepts: application/json /v3/koubei/marketing/campaign/intelligent/shop/consult: post: description: 咨询完智能营销活动模型后,可以查询商户的符合智能营销活动标准的门店 operationId: koubei.marketing.campaign.intelligent.shop.consult requestBody: content: application/json: schema: $ref: '#/components/schemas/KoubeiMarketingCampaignIntelligentShopConsultModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/KoubeiMarketingCampaignIntelligentShopConsultResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/koubei_marketing_campaign_intelligent_shop_consult_default_response' description: 请求失败 summary: 智能营销门店咨询 tags: - koubei.marketing.campaign.intelligent.shop x-content-type: application/json x-accepts: application/json /v3/koubei/marketing/campaign/intelligent/template/consult: post: description: 咨询可使用的智能营销模板 operationId: koubei.marketing.campaign.intelligent.template.consult requestBody: content: application/json: schema: $ref: '#/components/schemas/KoubeiMarketingCampaignIntelligentTemplateConsultModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/KoubeiMarketingCampaignIntelligentTemplateConsultResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/koubei_marketing_campaign_intelligent_template_consult_default_response' description: 请求失败 summary: 智能营销模板咨询 tags: - koubei.marketing.campaign.intelligent.template x-content-type: application/json x-accepts: application/json /v3/koubei/marketing/campaign/item/merchantactivity/batchquery: post: description: 商户查询商品代金券列表 operationId: koubei.marketing.campaign.item.merchantactivity.batchquery requestBody: content: application/json: schema: $ref: '#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityBatchqueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityBatchqueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/koubei_marketing_campaign_item_merchantactivity_batchquery_default_response' description: 请求失败 summary: 商户查询商品代金券列表 tags: - koubei.marketing.campaign.item.merchantactivity x-content-type: application/json x-accepts: application/json /v3/koubei/marketing/campaign/item/merchantactivity/close: post: description: 商户下架代金券 operationId: koubei.marketing.campaign.item.merchantactivity.close requestBody: content: application/json: schema: $ref: '#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityCloseModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityCloseResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/koubei_marketing_campaign_item_merchantactivity_close_default_response' description: 请求失败 summary: 商户下架代金券 tags: - koubei.marketing.campaign.item.merchantactivity x-content-type: application/json x-accepts: application/json /v3/koubei/marketing/campaign/item/merchantactivity/create: post: description: 商户创建商品代金券 operationId: koubei.marketing.campaign.item.merchantactivity.create requestBody: content: application/json: schema: $ref: '#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/koubei_marketing_campaign_item_merchantactivity_create_default_response' description: 请求失败 summary: 商户创建商品代金券 tags: - koubei.marketing.campaign.item.merchantactivity x-content-type: application/json x-accepts: application/json /v3/koubei/marketing/campaign/item/merchantactivity/modify: post: description: 商户修改商品代金券 operationId: koubei.marketing.campaign.item.merchantactivity.modify requestBody: content: application/json: schema: $ref: '#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityModifyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityModifyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/koubei_marketing_campaign_item_merchantactivity_modify_default_response' description: 请求失败 summary: 商户修改商品代金券 tags: - koubei.marketing.campaign.item.merchantactivity x-content-type: application/json x-accepts: application/json /v3/koubei/marketing/campaign/item/merchantactivity/query: get: description: 商户查询商品代金券详情 operationId: koubei.marketing.campaign.item.merchantactivity.query parameters: - description: 运营活动id explode: true in: query name: activity_id required: false schema: example: 2018xxxx type: string style: form - description: 外部id explode: true in: query name: external_unique_id required: false schema: example: 2018xxxx type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/koubei_marketing_campaign_item_merchantactivity_query_default_response' description: 请求失败 summary: 商户查询商品代金券详情 tags: - koubei.marketing.campaign.item.merchantactivity x-accepts: application/json /v3/koubei/trade/order/consult: post: description: ISV下单前,可以通过此接口咨询用户优惠信息 operationId: koubei.trade.order.consult requestBody: content: application/json: schema: $ref: '#/components/schemas/KoubeiTradeOrderConsultModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/KoubeiTradeOrderConsultResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/koubei_trade_order_consult_default_response' description: 请求失败 summary: 口碑订单预咨询 tags: - koubei.trade.order x-content-type: application/json x-accepts: application/json /v3/monitor/heartbeat/syn: post: description: 本质上是金融云验签接口 operationId: monitor.heartbeat.syn requestBody: content: application/json: schema: $ref: '#/components/schemas/MonitorHeartbeatSynModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/MonitorHeartbeatSynResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/monitor_heartbeat_syn_default_response' description: 请求失败 summary: 验签接口 tags: - monitor.heartbeat x-content-type: application/json x-accepts: application/json /v3/zhima/credit/payafteruse/creditagreement/query: get: description: 使用商户外部协议号或开通/授权协议号,查询服务开通/授权信息。 operationId: zhima.credit.payafteruse.creditagreement.query parameters: - description: 商户外部协议号 explode: true in: query name: out_agreement_no required: false schema: example: "2014070700166653" type: string style: form - description: 芝麻开通/授权协议号,out_agreement_no与credit_agreement_id必填一个,推荐使用credit_agreement_id。 explode: true in: query name: credit_agreement_id required: false schema: example: ZMOP2020050722001440 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaCreditPayafteruseCreditagreementQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_credit_payafteruse_creditagreement_query_default_response' description: 请求失败 summary: 查询服务开通/授权信息 tags: - zhima.credit.payafteruse.creditagreement x-accepts: application/json /v3/zhima/credit/payafteruse/creditagreement/transfer: post: description: 其他产品功能(例如信用代扣),通过该接口,可以转换为芝麻产品(芝麻先享产品,芝麻风险评估产品),完成信用服务授权 operationId: zhima.credit.payafteruse.creditagreement.transfer requestBody: content: application/json: schema: $ref: '#/components/schemas/ZhimaCreditPayafteruseCreditagreementTransferModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaCreditPayafteruseCreditagreementTransferResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_credit_payafteruse_creditagreement_transfer_default_response' description: 请求失败 summary: 芝麻信用服务授权 tags: - zhima.credit.payafteruse.creditagreement x-content-type: application/json x-accepts: application/json /v3/zhima/credit/payafteruse/creditbizorder/finish: post: description: 结束信用服务订单 operationId: zhima.credit.payafteruse.creditbizorder.finish requestBody: content: application/json: schema: $ref: '#/components/schemas/ZhimaCreditPayafteruseCreditbizorderFinishModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaCreditPayafteruseCreditbizorderFinishResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_credit_payafteruse_creditbizorder_finish_default_response' description: 请求失败 summary: 结束信用服务订单 tags: - zhima.credit.payafteruse.creditbizorder x-content-type: application/json x-accepts: application/json /v3/zhima/credit/payafteruse/creditbizorder/order: post: description: |- 芝麻信用产品免密下单,不需要唤起支付宝APP,通过服务端调用完成下单。 涉及芝麻信用服务产品、芝麻风险评估产品 operationId: zhima.credit.payafteruse.creditbizorder.order requestBody: content: application/json: schema: $ref: '#/components/schemas/ZhimaCreditPayafteruseCreditbizorderOrderModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaCreditPayafteruseCreditbizorderOrderResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_credit_payafteruse_creditbizorder_order_default_response' description: 请求失败 summary: 芝麻信用服务下单(免用户确认场景) tags: - zhima.credit.payafteruse.creditbizorder x-content-type: application/json x-accepts: application/json /v3/zhima/credit/payafteruse/creditbizorder/query: get: description: 信用服务订单查询 operationId: zhima.credit.payafteruse.creditbizorder.query parameters: - description: 信用服务订单号,out_order_no与credit_biz_order_id至少传一个 explode: true in: query name: credit_biz_order_id required: false schema: example: ZMCB20201021200102012 type: string style: form - description: 商户外部单号,out_order_no与credit_biz_order_id至少传一个 explode: true in: query name: out_order_no required: false schema: example: "20202010212001384" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaCreditPayafteruseCreditbizorderQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_credit_payafteruse_creditbizorder_query_default_response' description: 请求失败 summary: 信用服务订单查询 tags: - zhima.credit.payafteruse.creditbizorder x-accepts: application/json /v3/zhima/credit/pe/zmgo/agreement/query: get: description: 用户已经开通芝麻GO后,通过此接口查询协议。 operationId: zhima.credit.pe.zmgo.agreement.query parameters: - description: 支付宝系统中用以唯一标识用户签约记录的编号,即花芝轻会员。传入该参数,会忽略其它所有参数。 explode: true in: query name: agreement_id required: false schema: example: "20185513447859192007" type: string style: form - description: 买家在支付宝的用户id explode: true in: query name: alipay_user_id required: false schema: example: "2088101117955611" type: string style: form - description: 买家在支付宝的用户id explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaCreditPeZmgoAgreementQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_credit_pe_zmgo_agreement_query_default_response' description: 请求失败 summary: 芝麻Go协议查询接口 tags: - zhima.credit.pe.zmgo.agreement x-accepts: application/json /v3/zhima/credit/pe/zmgo/agreement/unsign: post: description: 芝麻GO协议解约 operationId: zhima.credit.pe.zmgo.agreement.unsign requestBody: content: application/json: schema: $ref: '#/components/schemas/ZhimaCreditPeZmgoAgreementUnsignModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaCreditPeZmgoAgreementUnsignResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_credit_pe_zmgo_agreement_unsign_default_response' description: 请求失败 summary: 芝麻GO协议解约 tags: - zhima.credit.pe.zmgo.agreement x-content-type: application/json x-accepts: application/json /v3/zhima/credit/pe/zmgo/bizopt/close: post: description: 签约芝麻GO时,在签约申请时会生初始状态的签约单,如果后续不进行签约确认,可通过此接口关闭签约单 operationId: zhima.credit.pe.zmgo.bizopt.close requestBody: content: application/json: schema: $ref: '#/components/schemas/ZhimaCreditPeZmgoBizoptCloseModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaCreditPeZmgoBizoptCloseResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_credit_pe_zmgo_bizopt_close_default_response' description: 请求失败 summary: 芝麻GO签约关单 tags: - zhima.credit.pe.zmgo.bizopt x-content-type: application/json x-accepts: application/json /v3/zhima/credit/pe/zmgo/cumulation/sync: post: description: 芝麻go商户通过此api接口,将用户行为数据回传到芝麻侧,数据包括:交易型数据(订单信息、优惠信息)和非交易型数据(用户完成任务次数)。芝麻侧将回传的数据在C端向用户展示,并且在结算时对结算金额进行校验(可选)。 operationId: zhima.credit.pe.zmgo.cumulation.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/ZhimaCreditPeZmgoCumulationSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaCreditPeZmgoCumulationSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_credit_pe_zmgo_cumulation_sync_default_response' description: 请求失败 summary: 芝麻go用户数据回传 tags: - zhima.credit.pe.zmgo.cumulation x-content-type: application/json x-accepts: application/json /v3/zhima/credit/pe/zmgo/preorder/create: put: description: 芝麻GO签约三件套前预创建单据,预传入签约基本参数和自定义配置,并支持动态模板配置能力。 operationId: zhima.credit.pe.zmgo.preorder.create requestBody: content: application/json: schema: $ref: '#/components/schemas/ZhimaCreditPeZmgoPreorderCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaCreditPeZmgoPreorderCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_credit_pe_zmgo_preorder_create_default_response' description: 请求失败 summary: 芝麻GO签约预创单 tags: - zhima.credit.pe.zmgo.preorder x-content-type: application/json x-accepts: application/json /v3/zhima/credit/pe/zmgo/settle/apply: post: description: 用户已经开通芝麻GO后,商户通过此接口解冻转支付用户冻结金额。传入金额必须小于等于冻结金额 operationId: zhima.credit.pe.zmgo.settle.apply requestBody: content: application/json: schema: $ref: '#/components/schemas/ZhimaCreditPeZmgoSettleApplyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaCreditPeZmgoSettleApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_credit_pe_zmgo_settle_apply_default_response' description: 请求失败 summary: 芝麻GO结算申请 tags: - zhima.credit.pe.zmgo.settle x-content-type: application/json x-accepts: application/json /v3/zhima/credit/pe/zmgo/settle/refund: post: description: "芝麻GO结算金额逆向退款接口: 对zhima.credit.pe.zmgo.settle.apply(芝麻GO结算申请接口\ ) 产生的结算交易发起退款操作" operationId: zhima.credit.pe.zmgo.settle.refund requestBody: content: application/json: schema: $ref: '#/components/schemas/ZhimaCreditPeZmgoSettleRefundModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaCreditPeZmgoSettleRefundResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_credit_pe_zmgo_settle_refund_default_response' description: 请求失败 summary: 芝麻GO结算退款接口 tags: - zhima.credit.pe.zmgo.settle x-content-type: application/json x-accepts: application/json /v3/zhima/credit/pe/zmgo/settle/unfreeze: put: description: 用户已经开通芝麻GO后,商户通过此接口解冻转支付用户冻结金额。传入金额必须小于等于冻结金额 operationId: zhima.credit.pe.zmgo.settle.unfreeze requestBody: content: application/json: schema: $ref: '#/components/schemas/ZhimaCreditPeZmgoSettleUnfreezeModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaCreditPeZmgoSettleUnfreezeResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_credit_pe_zmgo_settle_unfreeze_default_response' description: 请求失败 summary: 芝麻GO解冻接口 tags: - zhima.credit.pe.zmgo.settle x-content-type: application/json x-accepts: application/json /v3/zhima/customer/jobworth/authentication: get: description: 根据一次性token查询用户身份认证结果 operationId: zhima.customer.jobworth.authentication.query parameters: - description: 调用第一步创建接口的out_agreement_no,由外部传入 explode: true in: query name: conn_key required: false schema: example: uuid type: string style: form - description: 查询身份认证结果的凭证,在认证结果到达终态后只允许查询成功一次,若需要再次查询,则需要调用第一个接口再拉起受理台 explode: true in: query name: once_token required: false schema: example: uuid type: string style: form - description: "exact:精确查询,dim:模糊查询" explode: true in: query name: query_type required: false schema: example: exact\dim type: string style: form - description: 04:教师,其它身份类型联系芝麻技术支持确认 explode: true in: query name: identity_type required: false schema: example: "04" type: string style: form - description: 信用服务id,商家接入产品功能包时有运营同学分配 explode: true in: query name: service_id required: false schema: example: "2019120400000000000004450100" type: string style: form - description: "蚂蚁统一会员ID\t和身份证任选一个传入" explode: true in: query name: user_id required: false schema: example: "20881029102921" type: string style: form - description: "蚂蚁统一会员ID\t和身份证任选一个传入" explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form - description: 证件号 explode: true in: query name: cert_no required: false schema: example: "420192931233123123" type: string style: form - description: "\"身份证 : 0\",\"护照: 1\",\"台湾往来通行证:4\",\"港澳往来通行证:3\", \"回乡证: 2\"\ ;\"港澳证件:5\"" explode: true in: query name: cert_type required: false schema: example: "0" type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaCustomerJobworthAuthenticationQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_customer_jobworth_authentication_query_default_response' description: 请求失败 summary: 职得身份认证查询接口 tags: - zhima.customer.jobworth.authentication x-accepts: application/json /v3/zhima/customer/jobworth/cloudresume/query: get: description: 用于查询工作证基本信息 operationId: zhima.customer.jobworth.cloudresume.query parameters: - description: 长效的认证令牌:zhima.credit.payafteruse.creditagreement.sign 的out_agreement_no explode: true in: query name: conn_key required: false schema: example: uuid type: string style: form - description: "交换云简历的单次token:zhima.credit.payafteruse.creditagreement.sign\ \ 的\t\textra_param入参onceToken(授权后5分钟内,单次有效" explode: true in: query name: once_token required: false schema: example: uuid type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaCustomerJobworthCloudresumeQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_customer_jobworth_cloudresume_query_default_response' description: 请求失败 summary: 智能简历基本数据查询 tags: - zhima.customer.jobworth.cloudresume x-accepts: application/json /v3/zhima/customer/jobworth/info/query: get: description: |- 查询用户职得工作证信息 查询方式3选1,都设置时uid优先 1、支付宝uid查询:user_id 2、身份证+姓名查询:cert_type+cert_no 3、智能简历场景:conn_key operationId: zhima.customer.jobworth.info.query parameters: - description: 姓名 explode: true in: query name: user_name required: false schema: example: 张三 type: string style: form - description: 外部订单号,zhima.credit.payafteruse.creditagreement.sign的入参 out_agreement_no智能简历场景支持只传该值 explode: true in: query name: conn_key required: false schema: example: ttest11234 type: string style: form - description: 证件号 ,根据cert_type类型设置对应证件号码,选择身份证校验时必传 explode: true in: query name: cert_no required: false schema: example: 42011719880304XXXX type: string style: form - description: "蚂蚁统一会员ID ,为2088开头的唯一标识\t选择支付宝uid检验时必传,支付宝uid或身份证+身份证类型 查询2选\ 1,都设置时uid优先" explode: true in: query name: user_id required: false schema: example: 2088XXXXXXXX type: string style: form - description: "蚂蚁统一会员ID ,为2088开头的唯一标识\t选择支付宝uid检验时必传,支付宝uid或身份证+身份证类型 查询2选\ 1,都设置时uid优先" explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form - description: 若用户没有开通工作证或者芝麻,成功开通后回跳的链接 ,支持http或schema地址 explode: true in: query name: back_url required: false schema: example: www.123.com type: string style: form - description: "证件类型 ,枚举值:\t0:身份证1:护照2:台湾同胞回乡证3:港澳居民往来内地通行证4:台湾居民通行证5:港澳居民通行\ 证\t选择身份证校验时必传,支付宝uid或身份证+身份证类型 查询2选1,都设置时uid优先" explode: true in: query name: cert_type required: false schema: example: 0:身份证1:护照2:台湾同胞回乡证3:港澳居民往来内地通行证4:台湾居民通行证5:港澳居民通行证 type: string style: form - description: 商户内部的唯一id如果是需要返回h5页面必填 explode: true in: query name: ka_visitor_id required: false schema: example: xxx type: string style: form - description: "访问类型\tC = company or P = person\t如果是需要返回h5页面必填" explode: true in: query name: visitor_type required: false schema: example: P type: string style: form - description: "商户侧配置访客名称\t如果是需要返回h5页面必填" explode: true in: query name: visitor_name required: false schema: example: 访客名称 type: string style: form - description: 公司社会统一代码h5页面访客展示使用 explode: true in: query name: company_certificate required: false schema: example: xxxx type: string style: form - description: 上传图片接口返回的id explode: true in: query name: visitor_url required: false schema: example: xxxx type: string style: form - description: 在h5页面是否展示底部跳转按钮 explode: true in: query name: has_button required: false schema: example: true type: boolean style: form - description: "true or false\t是否展示" explode: true in: query name: has_number required: false schema: example: true type: boolean style: form - description: 是否展示二维码 explode: true in: query name: has_qr_code required: false schema: example: true type: boolean style: form - description: 是否需要返回h5页面 explode: true in: query name: has_html required: false schema: example: true type: boolean style: form - description: 对外使用的jobid explode: true in: query name: job_id required: false schema: example: 05A00 type: string style: form - description: 行业描述ID explode: true in: query name: industry_id required: false schema: example: 05A21 type: string style: form - description: 子场景 explode: true in: query name: cloud_resume_scene required: false schema: example: GREEN_HIRE type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaCustomerJobworthInfoQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_customer_jobworth_info_query_default_response' description: 请求失败 summary: 职得工作证信息查询 tags: - zhima.customer.jobworth.info x-accepts: application/json /v3/zhima/customer/jobworth/jobdata/add: post: description: 合作的三方伙伴通过该接口,将数据回传到工作证 operationId: zhima.customer.jobworth.jobdata.add requestBody: content: application/json: schema: $ref: '#/components/schemas/ZhimaCustomerJobworthJobdataAddModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaCustomerJobworthJobdataAddResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_customer_jobworth_jobdata_add_default_response' description: 请求失败 summary: 工作证职业数据回流接口 tags: - zhima.customer.jobworth.jobdata x-content-type: application/json x-accepts: application/json /v3/zhima/customer/jobworth/picture/upload: post: description: 工作证图片上传通用接口 operationId: zhima.customer.jobworth.picture.upload requestBody: content: application/json: schema: $ref: '#/components/schemas/ZhimaCustomerJobworthPictureUploadModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaCustomerJobworthPictureUploadResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_customer_jobworth_picture_upload_default_response' description: 请求失败 summary: 职得工作证图片上传 tags: - zhima.customer.jobworth.picture x-content-type: application/json x-accepts: application/json /v3/zhima/customer/jobworth/position/add: post: description: 保存商户传入岗位信息,当接口调用成功,业务问题时返回subcode operationId: zhima.customer.jobworth.position.add requestBody: content: application/json: schema: $ref: '#/components/schemas/ZhimaCustomerJobworthPositionAddModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaCustomerJobworthPositionAddResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_customer_jobworth_position_add_default_response' description: 请求失败 summary: 职得工作证岗位收集 tags: - zhima.customer.jobworth.position x-content-type: application/json x-accepts: application/json /v3/zhima/merchant/subsidiaries/apply: post: description: 子商户信息添加 operationId: zhima.merchant.subsidiaries.apply requestBody: content: application/json: schema: $ref: '#/components/schemas/ZhimaMerchantSubsidiariesApplyModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaMerchantSubsidiariesApplyResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_merchant_subsidiaries_apply_default_response' description: 请求失败 summary: 子商户信息添加 tags: - zhima.merchant.subsidiaries x-content-type: application/json x-accepts: application/json /v3/zhima/merchant/subsidiaries/close: post: description: 关闭子商户信息工单 operationId: zhima.merchant.subsidiaries.close requestBody: content: application/json: schema: $ref: '#/components/schemas/ZhimaMerchantSubsidiariesCloseModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaMerchantSubsidiariesCloseResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_merchant_subsidiaries_close_default_response' description: 请求失败 summary: 关闭子商户信息工单 tags: - zhima.merchant.subsidiaries x-content-type: application/json x-accepts: application/json /v3/zhima/merchant/zmgo/cumulate/query: get: description: 芝麻GO数据累计查询接口,包含汇总和明细信息 operationId: zhima.merchant.zmgo.cumulate.query parameters: - description: 芝麻go协议号,唯一标识一个芝麻go协议。 explode: true in: query name: agreement_id required: false schema: example: "20195108518085620000" type: string style: form - description: 用户 id,用户在支付宝的唯一标识,以 2088 开头的 16 位纯数字组成。 explode: true in: query name: user_id required: false schema: example: "2088602002015001" type: string style: form - description: 用户 id,用户在支付宝的唯一标识,以 2088 开头的 16 位纯数字组成。 explode: true in: query name: open_id required: false schema: example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string style: form - description: 数据回传的商户 ID,即和用户发生业务来往的 PID 主体。商户账号在支付宝的唯一标识,以 2088 开头的 16 位纯数字组成。 explode: true in: query name: provider_pid required: false schema: example: "2088621805983504" type: string style: form - description: "是否需要回传明细。枚举支持:\t* true:需要回传明细。\t* false:不需要回传明细。" explode: true in: query name: need_detail required: false schema: example: false type: boolean style: form - description: 分页参数,当need_detail=true时需要,代表当前页数,从1开始。 explode: true in: query name: page_no required: false schema: example: 1 type: integer style: form - description: 分页参数,当need_detail=true时需要,代表每页大小,不能大于20。 explode: true in: query name: page_size required: false schema: example: 20 type: integer style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaMerchantZmgoCumulateQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_merchant_zmgo_cumulate_query_default_response' description: 请求失败 summary: 商家芝麻GO累计数据查询接口 tags: - zhima.merchant.zmgo.cumulate x-accepts: application/json /v3/zhima/merchant/zmgo/cumulate/sync: post: description: 外部商家接入芝麻GO场景下,回传用户行为履约数据给芝麻。 operationId: zhima.merchant.zmgo.cumulate.sync requestBody: content: application/json: schema: $ref: '#/components/schemas/ZhimaMerchantZmgoCumulateSyncModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaMerchantZmgoCumulateSyncResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_merchant_zmgo_cumulate_sync_default_response' description: 请求失败 summary: 商家芝麻GO累计数据回传接口 tags: - zhima.merchant.zmgo.cumulate x-content-type: application/json x-accepts: application/json /v3/zhima/merchant/zmgo/template/create: post: description: | 外部商家接入芝麻GO场景下,为商户提供自助创建芝麻GO模板的能力。 operationId: zhima.merchant.zmgo.template.create requestBody: content: application/json: schema: $ref: '#/components/schemas/ZhimaMerchantZmgoTemplateCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaMerchantZmgoTemplateCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_merchant_zmgo_template_create_default_response' description: 请求失败 summary: 商户创建芝麻GO模板接口 tags: - zhima.merchant.zmgo.template x-content-type: application/json x-accepts: application/json /v3/zhima/merchant/zmgo/template/query: get: description: 芝麻GO模板查询 operationId: zhima.merchant.zmgo.template.query parameters: - description: 模板ID,由创建模板接口返回结果提供 explode: true in: query name: template_no required: false schema: example: ZMGO_TPL2021061601004538 type: string style: form - description: 商户ID explode: true in: query name: partner_id required: false schema: example: 208830****697946 type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZhimaMerchantZmgoTemplateQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zhima_merchant_zmgo_template_query_default_response' description: 请求失败 summary: 芝麻GO模板查询 tags: - zhima.merchant.zmgo.template x-accepts: application/json /v3/zoloz/authentication/customer/facemanage/create: post: description: 热脸入库 operationId: zoloz.authentication.customer.facemanage.create requestBody: content: application/json: schema: $ref: '#/components/schemas/ZolozAuthenticationCustomerFacemanageCreateModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZolozAuthenticationCustomerFacemanageCreateResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zoloz_authentication_customer_facemanage_create_default_response' description: 请求失败 summary: 热脸入库 tags: - zoloz.authentication.customer.facemanage x-content-type: application/json x-accepts: application/json /v3/zoloz/authentication/customer/facemanage/delete: post: description: 出库逻辑 operationId: zoloz.authentication.customer.facemanage.delete requestBody: content: application/json: schema: $ref: '#/components/schemas/ZolozAuthenticationCustomerFacemanageDeleteModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZolozAuthenticationCustomerFacemanageDeleteResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zoloz_authentication_customer_facemanage_delete_default_response' description: 请求失败 summary: 热脸出库 tags: - zoloz.authentication.customer.facemanage x-content-type: application/json x-accepts: application/json /v3/zoloz/authentication/customer/ftoken/query: post: description: 查询刷脸结果信息接口 operationId: zoloz.authentication.customer.ftoken.query requestBody: content: application/json: schema: $ref: '#/components/schemas/ZolozAuthenticationCustomerFtokenQueryModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZolozAuthenticationCustomerFtokenQueryResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zoloz_authentication_customer_ftoken_query_default_response' description: 请求失败 summary: 查询刷脸结果信息接口 tags: - zoloz.authentication.customer.ftoken x-content-type: application/json x-accepts: application/json /v3/zoloz/authentication/customer/smilepay/initialize: post: description: 人脸刷脸付初始化 operationId: zoloz.authentication.customer.smilepay.initialize requestBody: content: application/json: schema: $ref: '#/components/schemas/ZolozAuthenticationCustomerSmilepayInitializeModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZolozAuthenticationCustomerSmilepayInitializeResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zoloz_authentication_customer_smilepay_initialize_default_response' description: 请求失败 summary: 人脸刷脸付初始化 tags: - zoloz.authentication.customer.smilepay x-content-type: application/json x-accepts: application/json /v3/zoloz/authentication/smilepay/initialize: post: description: 通过该接口获取刷脸支付服务的初始化信息,详细字段描述请参考产品说明文档 operationId: zoloz.authentication.smilepay.initialize requestBody: content: application/json: schema: $ref: '#/components/schemas/ZolozAuthenticationSmilepayInitializeModel' required: false responses: "200": content: application/json: schema: $ref: '#/components/schemas/ZolozAuthenticationSmilepayInitializeResponseModel' description: common response default: content: application/json: schema: $ref: '#/components/schemas/zoloz_authentication_smilepay_initialize_default_response' description: 请求失败 summary: 刷脸支付初始化 tags: - zoloz.authentication.smilepay x-content-type: application/json x-accepts: application/json components: parameters: AuthToken: allowEmptyValue: true description: 用户授权令牌 explode: true in: query name: auth_token required: false schema: type: string style: form TargetAppId: description: 目标isv应用ID explode: true in: query name: target_app_id required: false schema: type: string style: form schemas: AbilityPageQueryDTO: properties: page_data: description: 搜索运营列表的分页数据 items: $ref: '#/components/schemas/SearchAbilityOrderData' type: array page_num: description: 当前页码,默认第一页 example: "1" type: string page_size: description: 每页记录数,默认10 example: "10" type: string total_number: description: 记录总数 example: 10 type: integer type: object AccessParams: properties: channel: description: "目前支持以下值:\r\t1. ALIPAYAPP (钱包h5页面签约)\r\t2. QRCODE(扫码签约)\r\t\ 3. QRCODEORSMS(扫码签约或者短信签约)" example: ALIPAYAPP type: string type: object AccountLogItemResult: properties: account_log_id: description: 支付宝账务流水号。对账使用,不脱敏 example: 1*** type: string alipay_order_no: description: 支付宝订单号。对账使用,不脱敏 example: 20190101*** type: string balance: description: 余额,仅供参考。由于架构原因,余额变动并不保证连续。也就是余额不一定等于上一笔余额减去当笔金额。但是会保证最终一致。 example: "10000.00" type: string bill_source: description: 业务账单来源,资金收支对应的上游业务订单数据来源,确认业务订单出处。此字段供商户对账使用,不脱敏。 example: 商家中心 type: string biz_desc: description: 业务描述,资金收支对应的详细业务场景信息。此字段供商户对账使用,不脱敏。 example: 002***|交易退款 type: string biz_nos: description: 业务订单号,资金收支相关的业务场景订单号明细,字母大写;M:平台交易主单号,S:平台交易子单号,O:业务系统单据号(如退款订单号)。此字段供商户对账使用,不脱敏。 example: "M{330***}|S{330***}|O{192***}" type: string biz_orig_no: description: 业务基础订单号,资金收支对应的原始业务订单唯一识别编号。此字段供商户对账使用,不脱敏。 example: 330*** type: string complement_info: description: 账单的补全信息,用于特殊场景,普通商户不需要传值,对账时可忽略。 example: 商家中心 type: string direction: description: 收入/支出。表示收支。amount是正数,返回“收入”。amount是负数,返回“支出” example: 收入 type: string merchant_order_no: description: 商户订单号,创建支付宝交易时传入的信息。对账使用,不脱敏 example: TX*** type: string merchant_out_refund_no: description: 支付宝交易商户退款请求号。对应商户在调用收单退款接口openApi请求传入的outRequestNo参数值 example: 20211119*** type: string other_account: description: 对方账户 example: 张*(a*@alipay.com) type: string store_name: description: 门店信息 example: 杭州一店 type: string trans_amount: description: 金额 example: "1000.00" type: string trans_dt: description: 入账时间 example: 2019-01-01 00:00:00 type: string trans_memo: description: 账务备注。由上游业务决定,不可依赖此字段进行对账 example: 备注1 type: string type: description: 账务记录的类型,仅供参考 example: 交易 type: string type: object AccountQuotaDetail: properties: quota_amount: description: 周期内的额度上限 example: 50000 type: integer quota_dimension: description: 额度周期,有限枚举 example: DAY type: string role: description: 角色 example: PAYER type: string type: object ActivityAppInfo: properties: mini_app_id: description: 小程序id example: "2021238412323412" type: string type: object ActivityBaseInfo: properties: activity_id: description: 活动id type: string activity_name: description: 活动名称。 type: string activity_operation_status: description: 活动操作状态。 type: string activity_product_type: description: 券活动产品类型 type: string activity_status: description: 活动状态 。 ACTIVE:活动已激活,表示活动已经生效,等到活动开始(publish_start_time)之后用户就可以参与活动。 PAUSE:活动已暂停,表示商户临时暂停该活动,该状态下用户不能参与活动。 type: string belong_merchant_info: $ref: '#/components/schemas/BelongMerchantInfo' code_mode: description: 码模式。 MERCHANT_UPLOAD:商户上传自定义code,发券时系统随机选取上传的券code发放 MERCHANT_API:发奖时指定券码发奖,此模式无须提前上传券码。 type: string out_activity_id: description: 外部活动ID type: string type: object ActivityDiscountVoucher: properties: ceiling_amount: description: 封顶金额。 type: string discount: description: 折扣率。 type: string floor_amount: description: 门槛金额。说明:该字段可不填,认为无门槛; type: string goods_name: description: 商品名称。说明:该字段可不填,填入 origin_amount 则必填。 type: string origin_amount: description: 原价。说明:该字段可不填,填入商品名称goods_name则必填; type: string type: object ActivityExchangeVoucher: properties: amount: description: 券的价值。 type: string floor_amount: description: 门槛金额。说明:该字段可不填,认为无门槛; type: string overdue_refundable: description: 是否支持优惠券过期后,自动退款给用户。 不填默认否,枚举值: true:是 false:否 自动退款功能需要服务商在优惠券过期时,主动调用alipay.marketing.activity.order.refund接口进行退款。 如果配置优惠券时选择了过期自动退款,但是实际券过期后,服务商没有进行退款,那么用户投诉后,需要服务商进行解决。 type: boolean refundable: description: 购买的优惠券是否允许退款。 不填默认否,枚举值: true:是 false:否 type: boolean sale_amount: description: 用户购买优惠券需要支付的金额。 type: string type: object ActivityFixVoucher: properties: amount: description: 面额,每张代金券可以抵扣的金额。 type: string floor_amount: description: 门槛金额。该字段不填写,认为无门槛。 type: string goods_name: description: 商品名称。 type: string type: object ActivityGoodsInfo: properties: goods_id: description: 商品编码 example: "111" type: string goods_use_type: description: 活动单品类型。 example: AVAILABLE type: string type: object ActivityLiteInfo: properties: activity_base_info: $ref: '#/components/schemas/ActivityBaseInfo' activity_id: description: 活动 id。 example: "2016042700826004508401111111" type: string activity_name: description: 活动名称 example: 满10减1活动 type: string activity_status: description: 活动状态 。 ACTIVE:活动已激活,表示活动已经生效,等到活动开始(publish_start_time)之后用户就可以参与活动。 PAUSE:活动已暂停,表示商户临时暂停该活动,该状态下用户不能参与活动。 example: ACTIVE type: string belong_merchant_id: description: 归属商户PID example: "2088202967380463" type: string create_time: description: 活动创建时间。 example: 2017-01-01 00:00:01 type: string publish_end_time: description: 券发放结束时间。格式为:yyyy-MM-dd HH:mm:ss。 example: 2017-01-29 23:59:59 type: string publish_start_time: description: 券发放开始时间。 格式为:yyyy-MM-dd HH:mm:ss example: 2017-01-01 00:00:01 type: string 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: description: 券类型。 example: FIX_VOUCHER type: string voucher_use_rule_info: $ref: '#/components/schemas/VoucherUseRuleInfo' voucher_use_rule_lite_info: $ref: '#/components/schemas/CommonVoucherUseRuleLiteInfo' type: object ActivityMerchantInfo: properties: merchant_id: description: "商户PID,默认为当前接口调用商户。" example: 2088xx type: string merchant_id_type: description: 商户支付宝id类型。 example: PID type: string type: object ActivityShopInfo: properties: latitude: description: "纬度,浮点型,小数点后最多保留6位" example: "60.270001" type: string longitude: description: "经度,浮点型, 小数点后最多保留6位。" example: "120.760001" type: string shop_id: description: 支付宝侧蚂蚁店铺 id。 example: "2018011900502000000005124744" type: string shop_name: description: 店铺名称。 example: 肯德基中关村店 type: string shop_type: description: "门店类型\tPAYMENT_SHOP 支付门店\tREAL_SHOP 代运营商业关系门店" example: PAYMENT_SHOP type: string type: object ActivitySpecialVoucher: properties: floor_amount: description: 门槛金额。说明:该字段可不填,认为无门槛; type: string goods_name: description: 商品名称。说明:该字段可不填,填入 origin_amount 则必填。 type: string origin_amount: description: 原价。说明:该字段可不填,填入商品名称goods_name则必填; type: string special_amount: description: 特价,即:原价-特价=优惠金额。 type: string type: object AddressInfo: properties: address: description: 地址。商户详细经营地址或人员所在地点 type: string city_code: description: "城市编码。\t蚂蚁店铺请按照蚂蚁店铺地区码 表格中填写。\t直付通商户请按照直付通商户地区码 表格中内容填写。" type: string district_code: description: "区县编码。\t蚂蚁店铺请按照蚂蚁店铺地区码 表格中填写。\t直付通商户请按照直付通商户地区码 表格中内容填写。" type: string latitude: description: "纬度,浮点型,小数点后最多保留6位\t\t如需要录入经纬度,请以高德坐标系为准,录入时请确保经纬度参数准确。高德经纬度查询" type: string longitude: description: "经度,浮点型, 小数点后最多保留6位。\t\t如需要录入经纬度,请以高德坐标系为准,录入时请确保经纬度参数准确。高德经纬度查询" type: string poiid: description: 高德poiid type: string province_code: description: "省份编码。\t蚂蚁店铺请按照蚂蚁店铺地区码 表格中填写。\t直付通商户请按照直付通商户地区码 表格中内容填写。" type: string type: description: 地址类型。取值范围:BUSINESS_ADDRESS:经营地址(默认) type: string type: object AddressInfoDTO: properties: account_id: description: 共同账户id,当入参传入共同账户id时返回该值 example: "2088501312695783" type: string address: description: 详细地址 example: 西溪路569号蚂蚁A空间6楼601 type: string address_id: description: 地址id example: "190303094020" type: string city_code: description: 市(国家统一行政规划编码) example: "330100" type: string city_name: description: 城市 example: 杭州市 type: string community: description: 小区/楼宇 example: 蚂蚁A空间 type: string enterprise_id: description: 企业id,当入参传入企业id时返回该值 example: "2088501312695783" type: string latitude: description: 纬度 example: "30.261121" type: string longitude: description: 经度 example: "120.104735" type: string mark: description: 备注 example: 备注 type: string poi_id: description: 地图poi example: B0GKN4522Z type: string type: object Advert: properties: advert_group: description: 广告组标识 example: CG202008041013200064690 type: string advert_id: description: 广告位id example: "123" type: string advert_items: description: 广告位轮播内容列表 items: $ref: '#/components/schemas/AdvertItem' type: array group_id: description: 投放人群分组id example: RQ20191025100100595279 type: string mobile_client_type: description: "手机客户端类型,iphone、android、wp,空为不区分机型" example: android type: string type: object AdvertItem: properties: img_url: description: "广告图片url, 尺寸为996*240,最大不超过5M,支持格式:.jpg、.png ,请先调用 图片上传接口获得图片url" type: string link_type: description: 跳转类型,网页:HTTP、小程序:APP,不传默认HTTP type: string link_url: description: 跳转链接,点击广告图片跳到的链接url type: string name: description: 广告帧名称,可选 type: string type: object AgentChatInfo: properties: ccs_instance_id: description: 数据权限id(租户实例id) type: string extended_group_ids: description: 在线扩展技能组id列表 items: type: string type: array group_id: description: 在线技能组id type: string level_id: description: 在线服务等级 type: string type: object AgentHotlineInfo: properties: ccs_instance_id: description: 数据权限id(租户实例id) type: string group_ids: description: 热线技能组id items: type: string type: array type: object AgentScheduleLog: properties: agent_id: description: 客服id example: "2018101801902073" type: string agent_name: description: 客服名称 example: 张三 type: string create_time: description: "状态变更发生时间,采用UTC时间,按照ISO8601标准表示,格式为:yyyy-MM-dd'T'HH:mm:ss'Z'" example: 2020-10-23 09:10:23 type: string duration: description: "状态持续时长,单位秒" example: 120 type: integer end_time: description: "状态变更结束时间,采用UTC时间,按照ISO8601标准表示,格式为:yyyy-MM-dd'T'HH:mm:ss'Z'" example: 2020-10-23 09:20:53 type: string external_user_no: description: isv或商户系统中对应的客服工号 example: "0012" type: string id: description: 客服状态变更流水id example: "10223" type: string last_status: description: 变更前状态 example: 离线 type: string start_time: description: "状态变更开始时间,采用UTC时间,按照ISO8601标准表示,格式为:yyyy-MM-dd'T'HH:mm:ss'Z'" example: 2020-10-23 09:10:23 type: string status: description: 变更后状态 example: 上线 type: string type: object AgentVO: properties: answering_mode: description: 热线接入方式 example: "0" type: string avatar: description: 头像的oss file key example: testfile type: string ccs_instance_ids: description: 客服归属的部门id列表 example: "[\"XAHSNRBS\"]" items: type: string type: array chat_config: description: 在线技能组信息 items: $ref: '#/components/schemas/AgentChatInfo' type: array create_time: description: 创建时间, 标准时间格式:yyyy-MM-dd HH:mm:ss example: 2020-10-01 11:11:11 type: string creator_id: description: 创建人id example: "2019032101896769" type: string dingtalk_user_id: description: 钉钉user_id(绑定钉钉的用户该字段非空) example: "1293894912" type: string email: description: 客服邮箱 example: test@163.com type: string external_id: description: "外部系统用户,比如金融云的用户id、支付宝账号id" example: 2088xxx type: string hotline_config: description: 热线技能组信息 items: $ref: '#/components/schemas/AgentHotlineInfo' type: array id: description: 客服唯一标识id example: "2019032101896769" type: string job_number: description: 客服工号 example: "0002" type: string last_login_time: description: "最后登录时间,标准时间格式:yyyy-MM-dd HH:mm:ss" example: 2020-10-20 07:40:31 type: string mobile: description: 客服手机号 example: "13812345678" type: string nick_name: description: 客服昵称 example: 风清扬 type: string profile: description: 个人简介 example: 我是玉树临风一表人才的张三 type: string real_name: description: 客服姓名 example: 张三 type: string role_ids: description: 客服角色id列表 items: $ref: '#/components/schemas/RoleId' type: array status: description: 状态:NORMAL,DELETE example: NORMAL type: string type: description: 用户类型:NORMAL(普通客服),ADMIN(超级管理员,不能被删除) example: NORMAL type: string update_time: description: 最后修改时间, 标准时间格式:yyyy-MM-dd HH:mm:ss example: 2020-10-01 11:11:11 type: string updater_id: description: 最后修改人id example: "2019032101896769" type: string type: object AgreementDetail: properties: agreement_no: description: 协议号 example: "20120000000000000000" type: string status: description: 协议状态 example: NORMAL type: string type: object AgreementParams: properties: agreement_no: description: 支付宝系统中用以唯一标识用户签约记录的编号(用户签约成功后的协议号 ) example: "20170322450983769228" type: string apply_token: description: 鉴权申请token,其格式和内容,由支付宝定义。在需要做支付鉴权校验时,该参数不能为空。 example: MDEDUCT0068292ca377d1d44b65fa24ec9cd89132f type: string auth_confirm_no: description: 鉴权确认码,在需要做支付鉴权校验时,该参数不能为空 example: "423979" type: string deduct_permission: description: 商户代扣扣款许可 example: "2021571176714791277815457854545" type: string type: object AgreementQuotaModifyList: properties: agreement_no: description: 授权协议号 example: "20205321001042231004" type: string quota_details: description: 设置额度明细 items: $ref: '#/components/schemas/ModifyQuotaDetails' type: array type: object AliosOpenAutoInfoQueryErrorResponseModel: properties: code: description: 错误码 enum: - ISV_VERIFICATION_FAILED - NOT_FOUND - BIZ_ERROR - SYSTEM_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AliosOpenAutoInfoQueryResponseModel: properties: engine_no: description: 发动机号 example: "234534634523" type: string license_no: description: 车牌号 example: 京FW12A7 type: string user_activation_time: description: 用户激活时间 example: 2020-04-29 15:53:11 type: string vehicle_type: description: 车辆类型 example: "02" type: string vin: description: 车辆识别号码 example: T1D234E567A890H type: string type: object AlipayBossFncInvoiceApplyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayBossFncInvoiceApplyModel: properties: biz_id: description: 调用方身份识别标记(应用名称) 与业务单据号联合唯一 example: SETTLE_MIDDLE_GROUND type: string biz_no: description: 业务单据号,业务流水号 example: 47674d29cadd425a7eeb3ae4b51af7d5_765915 type: string invoice_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' invoice_type: description: 申请开票类型,01:专票;02:普票 example: "01" type: string memo: description: 备注 example: 备注 type: string mthtly_bill_nos: description: 需开票的应收月账单号 example: "2018060510122000040400841100996001" items: type: string type: array operator: description: 申请人的uid号 example: "208812345677" type: string out_biz_type: description: 01主站,02芝麻,03金融云 example: "03" type: string type: object AlipayBossFncInvoiceApplyResponseModel: properties: result_set: description: 开票申请ID,唯一性ID example: "2017090710122000473800320000049574" type: string type: object AlipayBossFncInvoiceBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayBossFncInvoiceBatchqueryModel: properties: apply_order_id: description: 开票申请ID,唯一标识开票申请表的ID example: "2017090710122000473800320000049574" type: string buyer_invoice_title: description: 买方发票抬头,用于打印在发票上 example: 联想 ( 上海 ) 电子科技有限公司 type: string buyer_ipid: description: 对应发票商户的ipId,在主站标示mid,在其他环境标示ip_id。 example: "10000004" type: string buyer_ipids: description: 购方商户ID集合 example: "2345643" items: type: string type: array buyer_iprole_id: description: 商户结算的ipRoleId,表示商户的结算对象,在主站表示pid。 example: "2088621524618252" type: string buyer_iprole_ids: description: 购方PID集合 example: "2088621524618252" items: type: string type: array inst_id: description: 对应发票所在OU的id,用于标示该发票所述的OU。 example: Z50 type: string invoice_channel: description: 开票渠道 01 线上;02 线下 example: "01" type: string invoice_code: description: 发票代码,税务部门给予发票的编码 example: "031001600211" type: string invoice_create_date_begin: description: 发票创建日期【起始日期,格式yyyyMMdd】 example: "20180723" type: string invoice_create_date_end: description: 发票创建日期【结束日期,格式yyyyMMdd】 example: "20180723" type: string invoice_ids: description: 发票ID集合,发票ID,唯一标示一张发票的ID example: "2017011210122000494000670000000001" items: type: string type: array invoice_material: description: 开票介质 01电子 02纸质 example: "01" type: string invoice_no: description: 发票号码,税务部门给予发票的编码 example: "86230814" type: string invoice_open_date_begin: description: 发票开票日期【起始日期,格式yyyyMMdd】 example: "20180723" type: string invoice_open_date_end: description: 发票开票日期【结束日期,格式yyyyMMdd】 example: "20180723" type: string invoice_status: description: 发票状态:用于标示发票当前的状态,状态类型以及相关含义:01 待开票;02 开票中;03 已开票;04 作废中;05 已作废;06 红冲中;07 已红冲;08 部分红冲;09 无效 example: "01" items: type: string type: array invoice_types: description: "发票类型,01专票 02普票 03营业税发票 04国际形式发票 05其它发票" example: "01" items: type: string type: array is_online: description: 是否能在线开票 Y能 N不能 example: "Y" type: string is_red: description: 是否红字 Y红字 N蓝字 example: "N" type: string mail_status: description: 邮寄状态 01 待邮寄;02 已邮寄;03 退回中;04 已退回 example: "01" items: type: string type: array monthly_bill_no: description: 月账单号 example: "2017090510122000040400320000017749" type: string page_no: description: 起始页,分页时必须提供 example: 1 type: integer page_size: description: 每页显示数,分页时必须提供 example: 20 type: integer tracking_no: description: 快递单号 example: "20170112101" type: string type: object AlipayBossFncInvoiceBatchqueryResponseModel: properties: amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' current_page: description: 当前页码 example: 123456 type: integer items_page: description: 每页条数 example: 123456 type: integer result_set: description: "结果对象,发票对象的集合" items: $ref: '#/components/schemas/ArInvoiceOpenApiResponse' type: array total_items: description: 查询到的结果总数 example: 123456 type: integer total_pages: description: 总页数 example: 123456 type: integer type: object AlipayBossFncInvoiceQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayBossFncInvoiceQueryResponseModel: properties: result_set: $ref: '#/components/schemas/ArInvoiceOpenApiResponse' type: object AlipayBossFncInvoicereceiptBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayBossFncInvoicereceiptBatchqueryModel: properties: bill_nos: description: 月账单号集合,唯一性ID集合,月账单表唯一主键ID集合 example: "2015050910120900000001120000000001" items: type: string type: array out_biz_type: description: 来源类型,01:主站;02:芝麻;03:金融云;04:微贷 example: "03" type: string type: object AlipayBossFncInvoicereceiptBatchqueryResponseModel: properties: result_set: description: 返回结果对象:可开票单据 items: $ref: '#/components/schemas/ArInvoiceReceiptOpenApiResponse' type: array total_inv_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' total_inved_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' total_link_invoice_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' type: object AlipayBossFncInvoicereceiptCreateErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayBossFncInvoicereceiptCreateModel: properties: event_code: description: "账单金额变更消息事件码\r\tAR_MTHLY_BILL_CREATE:应收账单创建,\r\tAR_MTHLY_BILL_CHANGE:应\ 收金额更新" example: AR_MTHLY_BILL_CREATE type: string event_type: description: "账单金额变更消息事件类型\r\tCREATE:创建事件,UPDATE:更新事件" example: CREATE type: string monthly_bill: $ref: '#/components/schemas/ArMonthlyBillDTO' msg_id: description: 事件全局id,可以使用uuid example: "12345678996434444" type: string out_biz_type: description: "消息来源 01:主站,02:芝麻,03:金融云,04:微贷" example: "03" type: string type: object AlipayBossFncInvoicereceiptCreateResponseModel: type: object AlipayBossFncUserinvoiceinfoCreateErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayBossFncUserinvoiceinfoCreateModel: properties: accept_electronic: description: 是否接受电子票 true:是,false:否 example: false type: boolean address: description: 公司注册地址,公司营业执照上登记的住址,一般纳税人必须填写,小规模纳税人无需填写 example: 武汉市武昌区中北路7号 type: string addressing: description: "开票资料pid寻址方式 true:pid寻址mid,优先以mid维度保存开票资料,若无mid则以pid维度保存开票资\ 料 false:不寻址mid,以pid维度保存开票资料;非主站商户体系都是以pid(ipRoleId)维度保存开票资料,该值直接填为false" example: false type: boolean auto: description: 是否自动申请开票 true:是,false:否 example: false type: boolean bank_account: description: "银行账户,公司银行账号\r\t一般纳税人必须填写,小规模纳税人无需填写" example: "3602201309100137669" type: string bank_name: description: "开户行,办理银行开户手续的营业网点\r\t一般纳税人必须填写,小规模纳税人无需填写" example: 中国工商银行广州市第二支行 type: string business_licence_url: description: 营业执照地址,营业执照上传oss上的地址 example: gfcenter/inv/userinvoicefile/aruserprofilepic_2088721075211978_15133031297372951.jpg type: string hold: description: 是否暂停开票,商户添加的开票资料就是不暂停开票,如果后续要暂停开票,只能去结算中台处理。 example: false type: boolean ip_role_id: description: 商户的pid(ipRoleId) example: "2088001007243670" type: string open_account_permit_url: description: 银行开户许可证附件,银行开户许可证上传oss上的地址 example: gfcenter/inv/userinvoicefile/aruserprofilepic_2088721075211978_15133031297372951.jpg type: string operator: description: 当前操作人 example: 李某某 type: string operator_type: description: "当前操作人类型,01:商户 02:管理员(小二)" example: "02" type: string other_qualification_url: description: 其它资质证明地址,其他资质证明附件上传oss上的地址 example: gfcenter/inv/userinvoicefile/aruserprofilepic_2088721075211978_15133031297372951.jpg type: string ou: description: 外部只允许添加商户开票资料,该值填写为false example: false type: boolean tax_no: description: 纳税人识别号,税务登记证上的号码。一般纳税人必须填写,小规模纳税人如果是商户也必须填写,个人无需填写 example: "310113000782689" type: string tax_payer_quali_valid: description: "纳税人资格开始时间 (格式:时间戳)\r\t一般纳税人必须填写,小规模纳税人无需填写" example: "1533039333744" type: string tax_payer_qualification: description: 纳税人资格种类,01:一般纳税人;02:小规模纳税人;03:国际商户 example: "01" type: string tax_qualification_url: description: 一般纳税人资格证书地址,一般纳税人资格证书上传oss上的地址 example: gfcenter/inv/userinvoicefile/aruserprofilepic_2088721075211978_15133031297372951.jpg type: string tax_reg_cert_url: description: 税务登记证地址,税务登记证上传oss上的地址 example: gfcenter/inv/userinvoicefile/aruserprofilepic_2088721075211978_15133031297372951.jpg type: string telephone: description: "公司注册电话(手机号和座机均可)\r\t一般纳税人必须填写,小规模纳税人无需填写" example: 021-56518888 type: string title: description: 发票抬头,票面信息上的抬头信息 example: 上海大众汽车有限公司 type: string user_mail_info_order_list: description: "收件人列表,若不修改此项可以不填\r\t选择非电子票时,邮寄信息必填,且保证邮寄信息的ipRoleId和开票资料的\ ipRoleId相等" items: $ref: '#/components/schemas/UserMailInfoOrder' type: array type: object AlipayBossFncUserinvoiceinfoCreateResponseModel: properties: result_set: description: 开票资料id,唯一性ID example: "2018060810122000544800670000008977" type: string type: object AlipayBossFncUserinvoiceinfoModifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayBossFncUserinvoiceinfoModifyModel: properties: accept_electronic: description: 是否接受电子票 true:是,false:否 example: true type: boolean address: description: 公司注册地址,公司营业执照上登记的住址,一般纳税人必须填写,小规模纳税人无需填写 example: 武汉市武昌区中北路7号 type: string auto: description: 是否自动申请开票 true:是;false:否 example: true type: boolean bank_account: description: "银行账户,公司银行账号\r\t一般纳税人必须填写,小规模纳税人无需填写" example: "3602201309100137789" type: string bank_name: description: "开户行,办理银行开户手续的营业网点\r\t一般纳税人必须填写,小规模纳税人无需填写" example: 中国工商银行广州市第二支行 type: string business_licence_url: description: 营业执照地址,营业执照上传oss上的地址 example: gfcenter/inv/userinvoicefile/aruserprofilepic_2088421504368153_15138457060231013.jpg type: string hold: description: 是否暂停开票,商户修改无效,如果要暂停开票,只能去结算中台处理。 example: true type: boolean id: description: 开票资料ID example: "10000004" type: string open_account_permit_url: description: 银行开户许可证附件,银行开户许可证上传oss上的地址 example: gfcenter/inv/userinvoicefile/aruserprofilepic_2088421504368153_151384570602313.jpg type: string operator: description: 当前操作人 example: "2088123456789776" type: string operator_type: description: "当前操作人类型,01:商户;02:管理员(小二)" example: "01" type: string other_qualification_url: description: 其它资质证明地址,其他资质证明附件上传oss上的地址 example: gfcenter/inv/userinvoicefile/aruserprofilepic_2088421504368153_151384570602333.jpg type: string tax_no: description: 纳税人识别号,税务登记证上的号码。一般纳税人必须填写,小规模纳税人如果是商户也必须填写,个人无需填写 example: "310113000782689" type: string tax_payer_quali_valid: description: "纳税人资格开始时间 (格式:时间戳)\r\t一般纳税人必须填写,小规模纳税人无需填写" example: "1533039333744" type: string tax_payer_qualification: description: 纳税人资格种类,01:一般纳税人;02:小规模纳税人;03:国际商户 example: "01" type: string tax_qualification_url: description: 一般纳税人资格证书地址,一般纳税人资格证书上传oss上的地址 example: gfcenter/inv/userinvoicefile/aruserprofilepic_2088721075211978_15133031297372951.jpg type: string tax_reg_cert_url: description: 税务登记证地址,税务登记证上传oss上的地址 example: gfcenter/inv/userinvoicefile/aruserprofilepic_2088421504368153_15138457060231013.jpg type: string telephone: description: "公司注册电话\r\t一般纳税人必须填写,小规模纳税人无需填写" example: 021-56518888 type: string title: description: 发票抬头,票面信息上的抬头信息 example: 上海大众汽车有限公司 type: string user_mail_info_order_list: description: "收件人列表,若不修改此项可以不填\r\t选择非电子票时,邮寄信息必填,且保证邮寄信息的ipRoleId和开票资料的\ ipRoleId相等" items: $ref: '#/components/schemas/UserMailInfoOrder' type: array type: object AlipayBossFncUserinvoiceinfoModifyResponseModel: type: object AlipayBossFncUserinvoiceinfoQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayBossFncUserinvoiceinfoQueryResponseModel: properties: result_set: $ref: '#/components/schemas/UserInvoiceInfoOpenApiResponse' type: object AlipayCommerceCityfacilitatorStationQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - ILLEGAL_BIZ_PARAMS - NO_RIGHT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceCityfacilitatorStationQueryResponseModel: properties: support_starts: description: 支持设为起点的站点列表 items: $ref: '#/components/schemas/StationDetailInfo' type: array type: object AlipayCommerceCityfacilitatorVoucherBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - ILLEGAL_BIZ_PARAMS - NO_RIGHT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceCityfacilitatorVoucherBatchqueryModel: properties: city_code: description: "城市编码请参考查询 中华人民共和国行政区划代码。\t已支持城市:广州 440100,深圳 440300,杭州330100。" example: "440300" type: string trade_nos: description: 支付宝交易号列表 example: "0123456789" items: type: string type: array type: object AlipayCommerceCityfacilitatorVoucherBatchqueryResponseModel: properties: tickets: description: 查询到的订单信息列表 items: $ref: '#/components/schemas/TicketDetailInfo' type: array type: object AlipayCommerceCityfacilitatorVoucherGenerateErrorResponseModel: properties: code: description: 错误码 enum: - SUCCESS - SYSTEM_ERROR - ILLEGAL_BIZ_PARAMS - NO_RIGHT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceCityfacilitatorVoucherGenerateModel: properties: city_code: description: "城市编码请参考查询 中华人民共和国行政区划代码。\t已支持城市:广州 440100,深圳 440300,杭州330100。" example: "440300" type: string site_begin: description: 起点站站点编码 example: "02490301" type: string site_end: description: 终点站站点编码 example: "02490305" type: string ticket_num: description: 地铁票购票数量 example: "5" type: string ticket_price: description: 单张票价,元为单价 example: "5.00" type: string ticket_type: description: "地铁票种类,枚举支持:\t*oneway。" example: oneway type: string total_fee: description: 订单总金额,元为单位 example: "10.00" type: string trade_no: description: 支付宝交易号(交易支付时,必须通过指定sellerId:2088121612215201,将钱支付到指定的中间户中) example: "2016031521001004390263523925" type: string type: object AlipayCommerceCityfacilitatorVoucherGenerateResponseModel: properties: expired_date: description: 核销码过期时间 example: 2016-03-18 00:00:00 type: string qr_code_no: 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 type: string ticket_no: description: 地铁购票的核销码 example: "0243567832" type: string type: object AlipayCommerceCityfacilitatorVoucherRefundErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - ILLEGAL_BIZ_PARAMS - NO_RIGHT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceCityfacilitatorVoucherRefundModel: properties: city_code: description: "城市编码请参考查询 中华人民共和国行政区划代码。\t已支持城市:广州 440100,深圳 440300,杭州330100。" example: "440300" type: string trade_no: description: 支付宝交易号 example: "2016031521001004390263523925" type: string type: object AlipayCommerceCityfacilitatorVoucherRefundResponseModel: type: object AlipayCommerceEcBalanceDownloadurlQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - PERMISSION_DENIED - PARAMETER_ILLEGAL - MONTH_BALANCE_RECORD_NOT_EXIST - BALANCE_HAS_NO_CONSUME - DAILY_BALANCE_RECORD_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcBalanceDownloadurlQueryResponseModel: properties: bill_download_url: 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 type: string type: object AlipayCommerceEcBalancePeriodModifyErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - PERMISSION_DENIED - PARAMETER_ILLEGAL - BALANCE_PERIOD_INVALID - LOCK_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcBalancePeriodModifyModel: properties: account_id: description: 共同账户id - 适用于在企业码小程序创建的共同账户,和agreement_no搭配使用 example: "2088000194958956" type: string agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string bill_day: description: 月账单账期 example: 31 type: integer enterprise_id: description: 企业ID - 适用于在企业码PC端创建的企业账号 example: "2088000194958956" type: string type: object AlipayCommerceEcBalancePeriodModifyResponseModel: properties: result: description: 修改结果 example: true type: boolean type: object AlipayCommerceEcConsumeDetailQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - PERMISSION_DENIED - CONSUME_NOT_EXIST - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcConsumeDetailQueryModel: properties: account_id: description: 共同账户ID example: "2088123456789000" type: string agreement_no: description: 授权签约协议号 example: "20205820659822371223" type: string enterprise_id: description: 企业ID example: "2088123456789000" type: string pay_no: description: 支付宝账单号 example: "2020123100152601930000003650" type: string query_options: description: 查询选项 example: "[\"Refund\"]" items: type: string type: array type: object AlipayCommerceEcConsumeDetailQueryResponseModel: properties: consume_info: $ref: '#/components/schemas/EcConsumeInfo' related_order_info: $ref: '#/components/schemas/EcOrderInfo' related_refund_list: description: 关联账单列表 items: $ref: '#/components/schemas/EcConsumeInfo' type: array related_voucher_list: description: 关联凭证详情列表 items: $ref: '#/components/schemas/EcVoucherInfo' type: array type: object AlipayCommerceEcDepartmentCreateErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - PARAMETER_ERROR - NO_AGREEMENT - ENTERPRISE_NOT_EXIST - DEPARTMENT_CODE_EXIST - ENTERPRISE_STATUS_ERROR - DEPARTMENT_PARENT_CANNOT_BE_NULL - DEPARTMENT_PARENT_NOT_EXIST - DEPARTMENT_DEPTH_EXCEED_MAX - DEPARTMENT_NAME_EXIST - DEPARTMENT_PARENT_ID_NOT_EXIST - DEPT_UPGRADING type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcDepartmentCreateModel: properties: department_code: description: 部门编码 example: D00001 type: string department_name: description: 部门名称 example: 财务部 type: string enterprise_id: description: 企业id example: "2088501412314698" type: string parent_department_id: description: 上级部门id example: "1001169000136660" type: string type: object AlipayCommerceEcDepartmentCreateResponseModel: properties: department_id: description: 新创建的部门id example: "1001169000136660" type: string type: object AlipayCommerceEcDepartmentDeleteErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - NO_AGREEMENT - ENTERPRISE_NOT_EXIST - ROOT_DEPARTMENT_CANNOT_DELETE - DEPARTMENT_EMPLOYEE_EXIST - DEPT_UPGRADING - DEPT_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcDepartmentDeleteModel: properties: department_id: description: 部门id example: "1001169000136660" type: string enterprise_id: description: 企业id example: "2088501412314698" type: string type: object AlipayCommerceEcDepartmentDeleteResponseModel: type: object AlipayCommerceEcDepartmentInfoModifyErrorResponseModel: properties: code: 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 - ROOT_DEPARTMENT_CANNOT_MODIFY - PLATFORM_DEPARTMENT_CANNOT_MODIFY - DEPT_UPGRADING - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcDepartmentInfoModifyModel: properties: department_code: description: 部门编码,不同部门的编码不能相同,为空则代表不修改 example: D00001 type: string department_id: description: 待修改部门的部门id example: "1001169000136660" type: string department_name: description: 部门名称,为空则代表不修改 example: 财务部 type: string enterprise_id: description: 企业id example: "2088501412314698" type: string parent_department_id: description: 上级部门id,为空则代表不修改 example: "1001169000136660" type: string type: object AlipayCommerceEcDepartmentInfoModifyResponseModel: type: object AlipayCommerceEcDepartmentInfoQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - NO_AGREEMENT - DEPT_NOT_EXIST - ENTERPRISE_NOT_EXIST - PARAM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcDepartmentInfoQueryResponseModel: properties: department_info: $ref: '#/components/schemas/DepartmentInfoDTO' type: object AlipayCommerceEcDepartmentSublistQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - NO_AGREEMENT - DEPT_NOT_EXIST - ENTERPRISE_STATUS_ERROR - ENTERPRISE_NOT_EXIST - PARAM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcDepartmentSublistQueryResponseModel: properties: department_id_list: description: 部门id列表 example: "[\"1001094000052875\",\"1001094000052876\"]" items: type: string type: array type: object AlipayCommerceEcEmployeeAddErrorResponseModel: properties: code: 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 - ISV_USER_ID_NOT_SUPPORT - ACCOUNT_NOT_PERSONAL - EMPLOYEE_EMAIL_EXIST - ENTERPRISE_STATUS_ERROR - EMPLOYEE_ALIPAY_BIND_FAIL - EMPLOYEE_EXIST - IOT_USER_CREATE_ERROR - MSG_SEND_ERROR - PARAM_ERROR - REMOTE_SERVICE_ERROR - ECEIF_EMPLOYEE_CERT_EXIST - DEPT_UPGRADING - MODIFY_AGENCY_OPERATION_FAIL - ISV_USER_STATUS_QUERY_ERROR - ORG_USER_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcEmployeeAddModel: properties: department_ids: description: 员工所属部门 example: "[\"1001069000162569\"]" items: type: string type: array employee_cert_no: description: 证件号码,根据employee_cert_type指定的证件类型,传入对应的证件号码,用于企业人脸库员工刷脸开通时的核验。 example: 2601**********5964 type: string employee_cert_type: description: 证件类型,用于企业人脸库员工刷脸开通时的核验 example: IDENTITY_CARD type: string employee_email: description: 员工邮箱 example: 19929@email.com type: string employee_mobile: description: 员工手机号 example: 157****2245 type: string employee_name: description: 员工姓名 example: 张三 type: string employee_no: description: 员工编号/工号 example: D28339 type: string encrypt_cert_no: description: 加密证件号(默认转大写后用SHA256加密)与证件类型搭配使用,不可与证件号同时存在 example: B0160ABEE2099421C8B30EF3D9ED4E13C6C5708D6BB71441C7858B0C3AF89274 type: string encrypt_mobile: description: 加密手机号(默认使用SHA256加密,不可与手机号同时存在) example: B0160ABEE2099421C8B30EF3D9ED4E13C6C5708D6BB71441C7858B0C3AF89274 type: string enterprise_id: description: 企业id example: "20887448493929" type: string identity: description: 员工身份标识 example: "20889939994000" type: string identity_open_id: description: 当identity_type为ALIPAY_USER_ID时,此字段传入open_id example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string identity_type: description: 身份类型 example: ALIPAY_USER_ID type: string iot_check_type: description: 员工刷脸加入企业人脸库时的核验方式 example: business_facepay_checkall type: string iot_vid: deprecated: true description: 员工在企业人脸库的人脸唯一标识(该字段已作废,不支持自定义传入)(iot不支持自定义传入) example: 2109b5e671aa3ff2eb4851816c65828f type: string profiles: description: 员工个性化信息 example: "{\"consume_remark\":\"员工账单备注内容示例\"}" type: string role_list: description: 角色列表,目前只支持填一种角色,默认为USER example: "[\"USER\"]" items: type: string type: array sign_return_url: description: 员工签约后回跳地址 example: https://www.alipay.com type: string sign_url_carry_info: description: 签约链接是否需要携带员工身份信息(手机/邮箱) example: true type: boolean withholding_sign_str: description: "代扣签约串,需调代扣接口获取签约串\t参\ 考文档" example: biz_content=%7B%22access_params%22%3A%7B%22personal_product_code%22%3A%22GENERAL_WITHHOLDING_P%22%2C%22sign_scene%22%3A%22INDUSTRY%7CMULTI_MEDIA%22%7D&sign=111&app_id=2017090501336035&method=alipay.user.agreement.page.sign&version=1.0 type: string type: object AlipayCommerceEcEmployeeAddResponseModel: properties: employee_id: description: 员工id example: "2288033000090876" type: string iot_unique_id: description: IOT开通刷脸支持唯一操作流水号,此处透出用于外部服务商通过该unique_id便捷调用IOT侧接口 example: "3444950005320032" type: string sign_url: description: 资金代付签约链接 1.员工未绑支付宝,拉起员工绑定页面 2.员工已绑支付宝,拉起资金签约页面 example: https://ur.alipay.com/3I2tPbLkAiktIoqe2dseZUzT type: string type: object AlipayCommerceEcEmployeeDeleteErrorResponseModel: properties: code: description: 错误码 enum: - PARAMETER_ERROR - SYSTEM_ERROR - NO_AGREEMENT - ENTERPRISE_NOT_EXIST - EMPLOYEE_NOT_EXIST - MSG_SEND_ERROR - REMOTE_SERVICE_ERROR - IOT_USER_DELETE_ERROR - ENTERPRISE_NOT_SIGNED - PARAM_ERROR - DEPT_UPGRADING - EMPLOYEE_IS_SUPER_ADMIN type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcEmployeeDeleteModel: properties: employee_id: description: 员工id example: "2288839494040404" type: string enterprise_id: description: 企业id example: "2088993848994994" type: string type: object AlipayCommerceEcEmployeeDeleteResponseModel: type: object AlipayCommerceEcEmployeeIdlistQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - NO_AGREEMENT - DEPT_NOT_EXIST - ENTERPRISE_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcEmployeeIdlistQueryResponseModel: properties: current_page: description: 当前页数 example: 1 type: integer employee_id_list: description: 员工id列表 example: "[\"228420000000057942506\",\"228420000000057942507\"]" items: type: string type: array total_num: description: 员工总数 example: 566 type: integer total_pages: description: 总页数 example: 1 type: integer type: object AlipayCommerceEcEmployeeInfoModifyErrorResponseModel: properties: code: description: 错误码 enum: - PARAMETER_ERROR - SYSTEM_ERROR - ENTERPRISE_NOT_EXIST - EMPLOYEE_NOT_EXIST - DEPT_NOT_EXIST - OPEN_EMPLOYEE_ROLE_MODIFY_FAIL - NO_AGREEMENT - EMPLOYEE_BIND_NOT_MODIFY_ROLE - EMPLOYEE_EMAIL_EXIST - EMPLOYEE_MOBILE_EXIST - PARAM_ERROR - DEPT_UPGRADING - ISV_USER_STATUS_QUERY_ERROR - ORG_USER_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcEmployeeInfoModifyModel: properties: department_ids: description: 员工所属部门 example: "[\"1023993000\"]" items: type: string type: array employee_email: description: 员工邮箱 example: aajka@email.com type: string employee_id: description: 员工id example: "22887387848484" type: string employee_mobile: description: 员工手机号 example: 158****4364 type: string employee_name: description: 员工姓名 example: 张三 type: string employee_no: description: 员工工号 example: D83030 type: string enterprise_id: description: 企业id example: "2088474883838" type: string profiles: description: 个性化信息 example: "{\"consume_remark\":\"员工账单备注内容示例\"}" type: string role_list: description: 角色列表,目前只支持填一种角色 example: "[\"USER\"]" items: type: string type: array type: object AlipayCommerceEcEmployeeInfoModifyResponseModel: properties: employee_id: description: 员工id example: "2288738383939" type: string type: object AlipayCommerceEcEmployeeInfoQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - NO_AGREEMENT - EMPLOYEE_NOT_EXIST - ENTERPRISE_NOT_EXIST - PARAM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcEmployeeInfoQueryResponseModel: properties: employee_info: $ref: '#/components/schemas/EmployeeInfoDTO' type: object AlipayCommerceEcEmployeeInviteQueryErrorResponseModel: properties: code: description: 错误码 enum: - PARAMETER_ERROR - ENTERPRISE_NOT_EXIST - NO_AGREEMENT - SYSTEM_ERROR - GET_SIGN_URL_ERROR - ENTERPRISE_NOT_SIGNED - EMPLOYEE_NOT_EXIST - REMOTE_SERVICE_ERROR - PARAM_ERROR - GENERATE_SHARE_CODE_FAIL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcEmployeeInviteQueryResponseModel: properties: enterprise_id: description: 企业id example: "208847489339" type: string mini_app_sign_url: description: 支付宝服务商小程序跳入企业码小程序签约链接 example: /pages/open/authorize/individual-auth/index?token=xxxxea2ac30656af68522fa596335a3642364d9994270ba&scene=PCC_STANDARD type: string share_code: description: 签约吱口令 example: d:/qO2jW35792K 或复制此消息打开支付宝,企业码 $203 j@i.Dany e:/R type: string sign_url: description: 邀请链接 example: http://sjddkk.com type: string type: object AlipayCommerceEcEmployeeTitleCreateErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - OVER_MAXIMUM_CAPACITY - ECEIF_ENTERPRISE_NOT_EXIST - ENTERPRISE_ID_IS_BLANK - TITLE_ENTERPRISE_NOT_MATCH - SYSTEM_ERROR - REMOTE_SERVICE_ERROR - EMPLOYEE_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcEmployeeTitleCreateModel: properties: employee_title_list: description: 员工与抬头关系列表 items: $ref: '#/components/schemas/EmployeeTitleDTO' type: array type: object AlipayCommerceEcEmployeeTitleCreateResponseModel: type: object AlipayCommerceEcEmployeeTitleDeleteErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - OVER_MAXIMUM_CAPACITY - ENTERPRISE_NOT_EXIST - TITLE_ENTERPRISE_NOT_MATCH - SYSTEM_ERROR - TITLE_ID_IS_BLANK - ENTERPRISE_ID_IS_BLANK - PARAMETER_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcEmployeeTitleDeleteModel: properties: employee_title_list: description: 员工抬头列表 items: $ref: '#/components/schemas/EmployeeTitleDTO' type: array type: object AlipayCommerceEcEmployeeTitleDeleteResponseModel: type: object AlipayCommerceEcEmployeeTitleModifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - TITLE_ENTERPRISE_NOT_MATCH - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcEmployeeTitleModifyModel: properties: account_id: description: 共同账号id,与enterprise_id两者必填其一 example: "2088000397722031" type: string create_by: description: 创建人 example: 昭运 type: string employee_id: description: 企业域定义的员工id,与user_id两者必填其一 example: "228800000000002000002" type: string enterprise_id: description: 企业域定义下的企业id,与accountId两者必填其一 example: "2088000230921202" type: string modify_by: description: 修改人 example: 昭运 type: string new_title_id: description: 修改后的抬头id example: "2022060900801711450000073478" type: string old_title_id: description: 修改前的抬头id example: "2022060900801711450000073478" type: string open_id: description: 支付宝open_id,与employee_id两者必填其一 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string title_tag: description: 员工抬头关系标 example: ou type: string user_id: description: 支付宝id2088,与employee_id两者必填其一 example: "2088502255168118" type: string type: object AlipayCommerceEcEmployeeTitleModifyResponseModel: type: object AlipayCommerceEcEnterpriseAddressAddErrorResponseModel: properties: code: description: 错误码 enum: - PARAMETER_ERROR - SYSTEM_ERROR - ENTERPRISE_NOT_EXIST - SENSITIVE_WORDS_EXIST - NO_AGREEMENT - LAT_LNG_NOT_FOUND_ADDRESS type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcEnterpriseAddressAddModel: properties: account_id: description: 通过企业码1.0接口签约的共同账户,和agreement_no搭配使用。 example: "2088123412341234" type: string address: description: 详细地址最长50个字符 example: 西溪路569号蚂蚁A空间6楼601 type: string agreement_no: description: 可通过签约消息获取。配合共同账户id使用,当填写企业共同账户id时,此字段必填。 example: "20215425001181407500" type: string city_code: description: 市(国家统一行政规划编码) example: "330100" type: string city_name: description: 市 example: 杭州市 type: string community: description: 小区/楼宇 example: 蚂蚁A空间 type: string enterprise_id: description: 通过企业码2.0签约接口签约,只填写企业id,无需填写共同账户id和授权签约协议号。 example: "2088000194958956" type: string latitude: description: 纬度 example: "30.261121" type: string longitude: description: 经度 example: "120.104735" type: string mark: description: 备注最长50个字符 example: 备注 type: string poi_id: description: 高德地图poi example: B0GKN4522Z type: string type: object AlipayCommerceEcEnterpriseAddressAddResponseModel: properties: address_id: description: 地址id example: "19200289393" type: string type: object AlipayCommerceEcEnterpriseAddressModifyErrorResponseModel: properties: code: description: 错误码 enum: - PARAMETER_ERROR - SYSTEM_ERROR - ENTERPRISE_NOT_EXIST - SENSITIVE_WORDS_EXIST - NO_AGREEMENT - ADDRESS_NOT_EXIST - ADDRESS_HAS_USED - REMOTE_SERVICE_ERROR - LAT_LNG_NOT_FOUND_ADDRESS type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcEnterpriseAddressModifyModel: properties: account_id: description: 通过企业码1.0接口签约的共同账户,和agreement_no搭配使用。 example: "2088000194958956" type: string address: description: 详细地址最长50个字符 example: 西溪路569号蚂蚁A空间6楼601 type: string address_id: description: 地址id example: "19393030303" type: string agreement_no: description: 可通过签约消息获取。配合共同账户id使用,当填写企业共同账户id时,此字段必填。 example: "20215425001181407500" type: string city_code: description: 市(国家统一行政规划编码) example: "330100" type: string city_name: description: 城市名称 example: 杭州市 type: string community: description: 小区/楼宇 example: 蚂蚁A空间 type: string enterprise_id: description: 通过企业码2.0签约接口签约,只填写企业id,无需填写共同账户id和授权签约协议号。 example: "2088123412341234" type: string latitude: description: 纬度 example: "30.261121" type: string longitude: description: 经度 example: "120.104735" type: string mark: description: 备注 example: 备注 type: string poi_id: description: 高德地图poi example: B0GKN4522Z type: string status: description: 状态(生效/失效) example: NORMAL type: string type: object AlipayCommerceEcEnterpriseAddressModifyResponseModel: properties: address_id: description: 地址id example: "19300392390" type: string type: object AlipayCommerceEcEnterpriseAddressQueryErrorResponseModel: properties: code: description: 错误码 enum: - PARAMETER_ERROR - SYSTEM_ERROR - NO_AGREEMENT - ENTERPRISE_NOT_EXIST - ADDRESS_HAS_USED - SENSITIVE_WORDS_EXIST - ENTERPRISE_ADDRESS_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcEnterpriseAddressQueryResponseModel: properties: current_page: description: 页码 example: 1 type: integer enterprise_address_info_list: description: 地址列表 items: $ref: '#/components/schemas/AddressInfoDTO' type: array total_num: description: 总数量 example: 10 type: integer total_pages: description: 总页数 example: 2 type: integer type: object AlipayCommerceEcEnterpriseAgreementQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - PARAMETER_ERROR - ENTERPRISE_NOT_EXIST - PERMISSION_DENIED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcEnterpriseAgreementQueryResponseModel: properties: enterprise_agreement_dto: $ref: '#/components/schemas/EnterpriseAgreementDTO' type: object AlipayCommerceEcEnterpriseCreateErrorResponseModel: properties: code: 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 - AUTH_INFO_NULL - ENTERPRISE_EMAIL_ALREADY_EXIST - CONFIRM_LETTER_IMG_NULL - LICENSE_IMG_NULL - EMPLOYEE_ADD_FAIL - ISV_USER_ID_NOT_SUPPORT - EMPLOYEE_NOT_EXIST - ISV_GROUP_APP_ID_EMPTY type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcEnterpriseCreateModel: properties: biz_scene: description: 场景码 example: ISV_QYM type: string create_fund_account: description: 是否设置管理员支付宝为企业出资账户 example: true type: boolean create_iot_group: description: 是否创建企业人脸库,适用于对接团餐刷脸付、门禁刷脸通行等场景 example: false type: boolean enterprise_alias: description: 企业简称 example: 企业码测试 type: string enterprise_name: description: 企业名称 example: 企业码测试有限公司 type: string group_app_id: description: 订购【一脸通行开通插件】的小程序appId example: "2021001188888888" type: string identity: description: 管理员身份标识 example: "2088501412314698" type: string identity_name: description: 管理员姓名 example: 张三 type: string identity_open_id: description: 管理员身份openId example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string identity_type: description: 管理员身份类型 example: ALIPAY_USER_ID type: string out_biz_no: description: 外部业务号 example: "28839390030030" type: string sign_return_url: description: 企业码签约后回跳地址 example: https://www.alipay.com type: string sign_terminal: description: 管理员签约终端类型 example: PC type: string type: object AlipayCommerceEcEnterpriseCreateResponseModel: properties: enterprise_id: description: 企业id example: "2088501412314698" type: string iot_group_id: description: 封闭场景(如班车)的人脸库id,如果入参create_iot_group传false,则不会创建企业人脸库,该字段为空。 example: BUSINESS_898263530536960 type: string iot_logic_group_id: description: 开放场景(如团餐)的人脸库id,如果入参create_iot_group传false,则不会创建企业人脸库,该字段为空。 example: BUSINESS_898263530536960 type: string sign_url: description: 资金代付签约链接 example: http://business-site-default.dev.alipay.net/page/EnterprisePay/Account?signToken=12324 type: string type: object AlipayCommerceEcEnterpriseDeleteErrorResponseModel: properties: code: description: 错误码 enum: - PARAMETER_ERROR - SYSTEM_ERROR - ENTERPRISE_NOT_EXIST - ENTERPRISE_HAS_DELETE - NO_AGREEMENT - ACCOUNT_NORMAL_ERROR - MSG_SEND_ERROR - FUND_ACCOUNT_UNBIND_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcEnterpriseDeleteModel: properties: enterprise_id: description: 企业id example: "208839030030" type: string type: object AlipayCommerceEcEnterpriseDeleteResponseModel: properties: enterprise_id: description: 企业ID example: "2088738399393" type: string type: object AlipayCommerceEcEnterpriseInfoModifyErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - PARAMETER_ERROR - NO_AGREEMENT - ENTERPRISE_NOT_EXIST - ONLY_NOAUTH_CAN_MODIFY_NAME - SENSITIVE_WORDS_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcEnterpriseInfoModifyModel: properties: enterprise_alias: description: 企业简称 example: 企业码测试 type: string enterprise_id: description: 企业id example: "2088501412314698" type: string enterprise_name: description: 企业名称 example: 企业码测试有限公司 type: string type: object AlipayCommerceEcEnterpriseInfoModifyResponseModel: type: object AlipayCommerceEcEnterpriseInfoQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - ENTERPRISE_NOT_EXIST - NO_AGREEMENT - IOT_GROUP_ID_QUERY_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcEnterpriseInfoQueryResponseModel: properties: enterprise_info: $ref: '#/components/schemas/EnterpriseInfoDTO' type: object AlipayCommerceEcEnterpriseUnsignErrorResponseModel: properties: code: description: 错误码 enum: - PARAMETER_ERROR - SYSTEM_ERROR - NO_AGREEMENT - GET_UNSIGN_URL_ERROR - ENTERPRISE_NOT_EXIST - ENTERPRISE_HAS_UNSIGN type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcEnterpriseUnsignResponseModel: properties: account_id: description: 入参传的共同账户id,出参也会返回共同账户id example: "2088390300034" type: string enterprise_id: description: 企业id example: "208893993930" type: string unsign_url: description: 解约链接 example: http://business-site-default.dev.alipay.net/page/EnterprisePay/Account?signToken=12324 type: string type: object AlipayCommerceEcJointaccountbillDetailBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - PERMISSION_DENIED - INVALID_PARAMETER - EMPLOYEE_INFO_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcJointaccountbillDetailBatchqueryResponseModel: properties: bill_list: description: 返回账单列表 items: $ref: '#/components/schemas/JointAccountBillDetail' type: array biz_scene: description: 业务场景 example: ISV_DEFAULT type: string enterprise_id: description: 企业ID,和接口入参一致 example: "2088123456789000" type: string has_next_page: description: 是否有下一页 example: true type: boolean page_num: description: 当期页数 example: "1" type: string page_size: description: 当期页记录数 example: "20" type: string type: object AlipayCommerceEcUserEnterpriseQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEcUserEnterpriseQueryResponseModel: properties: enterprise_info_list: description: 用户所属企业列表 items: $ref: '#/components/schemas/EnterpriseInfoDTO' type: array type: object AlipayCommerceEducateCampusInstitutionsAddErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEducateCampusInstitutionsAddModel: properties: card_pict_url: description: 事业单位法人证书或办学许可证的图片。入驻学校时,如果流入人工审核,会根据此图片进行辅助验证。 example: A*HZ9NTamTmx4AAAAAAAAAAAAAAQAAAQ type: string city_code: description: 市 example: "370800" type: string inst_name: description: 入驻的学校名称,必须是完整的学校全称 example: 复旦大学 type: string inst_std_code: description: 学校外标,使用统一社会信用编码 example: "3451000031" type: string learning_stage: description: "办学阶段。\t枚举值如下:\tKINDERGARTEN(幼儿园)\tPRIMARY_SCHOOL(小学) \tMIDDLE_SCHOOL(\ 初中) \tHIGH_SCHOOL(高中)\tSECONDARY_VOCATIONAL_SCHOOL(中职中专) \t注意:如果学校兼有多种\ 属性,可以连写用英文逗号拆分,如:MIDDLE_SCHOOL,HIGH_SCHOOL 代表兼有初中部和高中部;" example: "MIDDLE_SCHOOL,HIGH_SCHOOL" type: string province_code: description: 省份 example: "370000" type: string school_property: description: "学校性质.枚举值如下:\t 1:公立 \t2:民办" example: "1" type: string type: object AlipayCommerceEducateCampusInstitutionsAddResponseModel: properties: inst_id: description: 学校内标。如果入驻成功,返回学校内标;入驻失败则不返回学校内标。 example: "2088000305455592" type: string inst_std_code: description: 学校外标。如果入驻成功,返回学校外标;入驻失败则不返回学校外标。 example: "3451000031" type: string reason: description: 入驻失败原因 example: 学校已存在或检测到类似学校,请联系支付宝业务人员处理 type: string type: object AlipayCommerceEducateCampusInstitutionsQueryErrorResponseModel: properties: code: description: 错误码 enum: - QUERY_TOO_FREQUENCY - ILLEGAL_PARAM - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEducateCampusInstitutionsQueryResponseModel: properties: school_info: $ref: '#/components/schemas/SchoolSimpleInfo' school_info_list: description: 学校基础信息列表 items: $ref: '#/components/schemas/SchoolBaseInfo' type: array type: object AlipayCommerceEducateSchoolcardOrderSyncErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - ILLEGAL_PARAM - SCHOOL_NOT_EXIST - CHECK_SCHOOL_SIGN_FAIL - TRADE_SYNC_TEMPLATE_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceEducateSchoolcardOrderSyncModel: properties: actual_amount: description: 实际金额(总支付金额),单位为【元】 example: "0.60" type: string applet_app_id: description: 小程序appid example: "2019022763389198" type: string card_balance: description: 校园卡余额 example: "20.32" type: string card_no: description: "128" example: 校园卡卡号 type: string card_type: description: 校园卡类型 example: "1" type: string create_time: description: 该笔订单真实的创建时间,需精确到毫秒。 example: 2022-09-16 10:12:12.910 type: string discount_amount: description: 优惠金额 example: "0.70" type: string goods_orders: $ref: '#/components/schemas/GoodsOrder' merchant_name: description: 商家名称,不传默认展示学校名称 example: 温州医科大食堂 type: string modified_time: description: 订单修改时间 example: 2022-09-16 10:12:12.910 type: string open_id: description: 用户open_id example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string order_amount: description: 订单金额 example: "1.30" type: string order_detail_url: description: 订单详情链接 example: alipays://platformapi/startapp?appId=2021002126602599&page=%2fpages%2forder-details%2forder-details%3fticketOrderId%3d20210376854 type: string order_status: description: 订单状态 example: CONSUME_S type: string out_biz_no: description: 外部业务号,由商家自定义,128个字符以内,仅支持字母、数字、下划线且需保证在商户端不重复。 example: "20220320010101001" type: string pay_address: description: 支付地点 example: 1餐厅-3楼1号机 type: string pay_mode: description: 付款方式,不传默认展示学校名称+校园卡+(卡号后四位) example: 电子校园卡(1001) type: string rake_back_pid: description: 系统商编号。该参数作为系统商返佣数据提取的依据,请填写系统商签约协议的PID example: "2088511833207846" type: string school_id: description: 学校内标,录入学校接口返回的参数 example: "2088200341082323" type: string school_pid: description: 学校收款账号 example: "2088102146225135" type: string service_provider_name: description: 服务提供者名称 example: 完美校园 type: string type: description: 业务类型 example: SCHOOL_PAY type: string user_id: description: "买家支付宝用户ID。\t2088开头的16位纯数字,小程序场景下获取用户ID请参考:用户授权;\t其它场景下获取用户\ ID请参考:网页授权获取用户信息;" example: "2088102146225135" type: string type: object AlipayCommerceEducateSchoolcardOrderSyncResponseModel: properties: order_id: description: 订单号 example: 2022xxxx type: string type: object AlipayCommerceIotDeviceReportUploadErrorResponseModel: properties: code: description: 错误码 enum: - DEVICE_REPORT_UPLOAD_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceIotDeviceReportUploadModel: properties: report_content: description: 设备检测报告详情 example: 设备检测报告详情JSON字符串 type: string sn: description: 设备唯一标识 example: SMIT1D2020108003872 type: string type: object AlipayCommerceIotDeviceReportUploadResponseModel: properties: status: description: 是否上传成功 example: true type: boolean type: object AlipayCommerceIotSdarttoolMessageQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - PARAM_INVALID - NOT_FOUND_DATA type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceIotSdarttoolMessageQueryResponseModel: properties: consume_err_code: description: 消息消费返回码,不用的消息类型返回码不一样 example: PRINT_FAIL type: string consume_err_msg: description: 消息消费错误原因 example: 消息消费错误原因 type: string consume_state: description: 消息消费状态1-未消费; 2-消费成功;3-消费失败 example: 1 type: integer deliver_cnt: description: 消息投递次数 example: 1 type: integer deliver_status: description: "消息投递状态\t1: 未投递 2: 投递中 3: 投递成功 4: 投递失败 5: 消息失效不再发送" example: "1" type: string last_deliver_at: description: 消息最后一次发送时间 example: 1574752505481 type: integer msg_ack_time: description: 消息确认消费时间(ms) example: 1574752506609 type: integer msg_bida: description: 消息必达类型 1-非必达; 2-必达. example: 1 type: integer msg_expire_time: description: 消息过期时间(ms) example: 1575011705405 type: integer msg_gmt_create: description: 消息创建时间(ms) example: 1575028811454 type: integer msg_priority: description: 消息投递优先级 example: 0 type: integer type: object AlipayCommerceIotSdarttoolMessageSendErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceIotSdarttoolMessageSendModel: properties: bi_da: description: 消息是否必达(immediate_msg为false时此字段设置有效),消息过期时间顺延3*24h. 建议使用expire_time设置消息过期时间 example: false type: boolean device_query_type: description: "设备查询条件类型 ;SUPPLIERID_SN:supplierid+sn ;\t ITEMID_SN:itemid\ \ + sn;\tSN:sn" example: ITEMID_SN type: string immediate_msg: description: 是否即时消息; true-校验设备是否在线,false-不校验设备是否在线 example: true type: boolean item_id: description: 产品ID example: "2019111304877238" type: string msg_content: description: 消息内容 example: "{\"contentParams\":[\"消息内容\"]}" type: string msg_content_type: description: 消息内容格式 example: text type: string msg_expire: description: 消息过期时间戳(ms), 默认为当前时间顺延24h有效。当设备在线时消息服务过期之前尝试推送。最大过期时间顺延3*24h example: 1573107942000 type: integer msg_priority: description: 消息优先级(immediate_msg为false此字段设置有效)数字越大优先发送。 example: 0 type: integer msg_type: description: "消息类型:\txpaas_common-小程序消息;\truyi_ordermsg-如意订单消息" example: xpaas_common type: string service_id: description: 服务ID,当小程序消费消息时必传(传入的是小程序ID) example: "201808903221" type: string sn: description: 设备sn号 example: "10000000001" type: string supplier_id: description: 厂商ID example: "20000000001" type: string type: object AlipayCommerceIotSdarttoolMessageSendResponseModel: properties: message_no: description: 消息ID example: "201911010000001" type: string type: object AlipayCommerceLogisticsInvoiceIstdwaybillCreateErrorResponseModel: properties: code: description: 错误码 enum: - PARAM_ILLEGAL - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceLogisticsInvoiceIstdwaybillCreateModel: properties: invoice: $ref: '#/components/schemas/Invoice' logistics_code: description: 即时配送公司编码 example: FENGNIAO type: string out_invoice_request_no: description: 开票请求流水号 example: out_invoice_no_00001 type: string waybill_invoices: description: 即时配送运单列表 items: $ref: '#/components/schemas/WaybillInvoice' type: array type: object AlipayCommerceLogisticsInvoiceIstdwaybillCreateResponseModel: properties: invoice_fee: description: 开票金额 example: "100.00" type: string status: description: 整体的运单开票状态,0:处理中 1:开票成功 2:开票失败 example: 0 type: integer waybill_invoices: description: 即时配送运单列表 items: $ref: '#/components/schemas/WaybillInvoiceIstd' type: array type: object AlipayCommerceLogisticsInvoiceIstdwaybillQueryErrorResponseModel: properties: code: description: 错误码 enum: - PARAM_ILLEGAL - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceLogisticsInvoiceIstdwaybillQueryResponseModel: properties: status: description: 整体的运单开票状态,0:处理中 1:开票成功 2:开票失败 example: 0 type: integer waybill_invoices: description: 即时配送运单列表 items: $ref: '#/components/schemas/WaybillInvoiceQueryIstd' type: array type: object AlipayCommerceLogisticsLogisticscompanyInstantdeliveryQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceLogisticsLogisticscompanyInstantdeliveryQueryResponseModel: properties: logistics_companies: description: 即时配送公司列表 items: $ref: '#/components/schemas/LogisticsCompanyResult' type: array type: object AlipayCommerceLogisticsOrderInstantdeliveryCancelErrorResponseModel: properties: code: description: 错误码 enum: - PARAM_ILLEGAL - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceLogisticsOrderInstantdeliveryCancelModel: properties: cancel_reason: description: 取消原因,取消原因id为i_6时必填 example: 其他原因取消运单 type: string cancel_reason_id: description: 取消原因id example: i_6 type: string logistics_code: description: 即时配送公司编码 example: FENGNIAO type: string order_no: description: 支付宝订单流水号 example: "2020090411130000000000772400280352" type: string out_order_no: description: 商家订单号,与order_no不能同时为空 example: "2020090411140000000000777000216122" type: string waybill_no: description: 即时配送运单编号 example: waybillno001 type: string type: object AlipayCommerceLogisticsOrderInstantdeliveryCancelResponseModel: properties: cancel_fee: description: 取消金额 example: "100.00" type: string type: object AlipayCommerceLogisticsOrderInstantdeliveryCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceLogisticsOrderInstantdeliveryCreateModel: properties: consumer_id: description: 消费者id, 如果consumer_source是alipay,则consumer_id必须是支付宝用户uid;如果consumer_source是wx,则consumer_id可以为空 example: 2088xxx type: string consumer_notify: $ref: '#/components/schemas/ConsumerNotifyIstd' consumer_source: description: "消费者来源,支付宝:alipay; 微信:wx" example: alipay type: string goods_details: description: 商品明细 items: $ref: '#/components/schemas/GoodsDetailIstd' type: array goods_info: $ref: '#/components/schemas/GoodsInfoIstd' logistics_code: description: 即时配送公司编码 example: FENGNIAO type: string logistics_token: description: "下即时配送订单token, 配送公司可以返回此字段,当商家下单时候带上这个字段,保证在一段时间内运费不变" example: token001 type: string open_id: description: 消费者id, 如果consumer_source是alipay,则consumer_id必须是支付宝用户openId;如果consumer_source是wx,则consumer_id可以为空 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string order_ext_istd: $ref: '#/components/schemas/OrderExtIstd' out_order_no: description: 商家订单号 example: "2020090411140000000000777000216122" type: string receiver: $ref: '#/components/schemas/ReceiverIstd' sender: $ref: '#/components/schemas/SenderIstd' shop_no: description: 商家门店编号 example: shopno001 type: string type: object AlipayCommerceLogisticsOrderInstantdeliveryCreateResponseModel: properties: coupon_fee: description: 优惠券费用 example: "1.00" type: string deliver_fee: description: 运费 example: "10.00" type: string dispatch_duration: description: 预计骑手还剩多久接单,单位:秒 example: 60 type: integer distance: description: 配送距离 example: 300 type: integer fee: description: 实际运费 example: "9.00" type: string finish_code: description: 收货码,骑手必须输入收货码才能完成订单妥投 example: xxx type: string insurance_fee: description: 保价费用 example: "0.00" type: string order_no: description: 支付宝订单流水号 example: "2020090411130000000000772400280352" type: string pay_amount: description: "支付金额, 实际扣减的费用以此字段为准" example: "9.00" type: string pickup_code: description: "取货码, 骑手必须输入取货码才能从商家取货" example: xxx type: string status: description: 即时配送运单状态 example: i_101 type: string waybill_no: description: 即时配送运单编号 example: waybillno001 type: string type: object AlipayCommerceLogisticsOrderInstantdeliveryPrecreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceLogisticsOrderInstantdeliveryPrecreateModel: properties: consumer_id: description: 消费者id, 如果consumer_source是alipay,则consumer_id必须是支付宝用户uid;如果consumer_source是wx,则consumer_id可以为空 example: 2088xxx type: string consumer_notify: $ref: '#/components/schemas/ConsumerNotifyIstd' consumer_source: description: "消费者来源, 支付宝:alipay, 微信:wx" example: alipay type: string goods_details: description: 商品明细 items: $ref: '#/components/schemas/GoodsDetailIstd' type: array goods_info: $ref: '#/components/schemas/GoodsInfoIstd' logistics_companies: description: 即时配送公司配置列表 items: $ref: '#/components/schemas/LogisticsCompanyIstd' type: array open_id: description: 消费者id, 如果consumer_source是alipay,则consumer_id必须是支付宝的openId;如果consumer_source是wx,则consumer_id可以为空 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string order_ext_istd: $ref: '#/components/schemas/OrderExtIstdForPreOrder' out_order_no: description: 商家订单号 example: "2020090411140000000000777000216122" type: string receiver: $ref: '#/components/schemas/ReceiverIstd' sender: $ref: '#/components/schemas/SenderIstd' shop_no: description: 商家门店编号 example: shopno001 type: string type: object AlipayCommerceLogisticsOrderInstantdeliveryPrecreateResponseModel: properties: waybills: description: 即时配送运单列表 items: $ref: '#/components/schemas/PreCreateWaybillIstd' type: array type: object AlipayCommerceLogisticsOrderIstdcancelPreconsultErrorResponseModel: properties: code: description: 错误码 enum: - PARAM_ILLEGAL - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceLogisticsOrderIstdcancelPreconsultModel: properties: cancel_reason: description: 取消原因,取消原因id为i_6时必填 example: 其他原因取消运单 type: string cancel_reason_id: description: 取消原因id example: i_6 type: string logistics_code: description: 即时配送公司编码 example: FENGNIAO type: string order_no: description: 支付宝订单流水号 example: "2020090411130000000000772400280352" type: string out_order_no: description: 商家订单号,与order_no不能同时为空 example: "2020090411140000000000777000216122" type: string waybill_no: description: 即时配送运单编号 example: waybillno001 type: string type: object AlipayCommerceLogisticsOrderIstdcancelPreconsultResponseModel: properties: allow_cancel: description: 是否允许取消 example: true type: boolean cancel_fee: description: 取消金额 example: "100.00" type: string type: object AlipayCommerceLogisticsOrderIstdretryCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceLogisticsOrderIstdretryCreateModel: properties: consumer_id: description: 消费者id, 如果consumer_source是alipay,则consumer_id必须是支付宝用户uid;如果consumer_source是wx,则consumer_id可以为空 example: 2088xxx type: string consumer_notify: $ref: '#/components/schemas/ConsumerNotifyIstd' consumer_source: description: "消费者来源, 支付宝:alipay, 微信:wx" example: alipay type: string goods_details: description: 商品明细 items: $ref: '#/components/schemas/GoodsDetailIstd' type: array goods_info: $ref: '#/components/schemas/GoodsInfoIstd' logistics_code: description: 即时配送公司编码 example: FENGNIAO type: string logistics_token: description: "下即时配送订单token, 配送公司可以返回此字段,当商家下单时候带上这个字段,保证在一段时间内运费不变" example: token001 type: string open_id: description: 消费者id, 如果consumer_source是alipay,则consumer_id必须是支付宝用户openId;如果consumer_source是wx,则consumer_id可以为空 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string order_ext_istd: $ref: '#/components/schemas/OrderExtIstd' out_order_no: description: 商家订单号 example: "2020090411140000000000777000216122" type: string receiver: $ref: '#/components/schemas/ReceiverIstd' sender: $ref: '#/components/schemas/SenderIstd' shop_no: description: 商家门店编号 example: shopno001 type: string type: object AlipayCommerceLogisticsOrderIstdretryCreateResponseModel: properties: coupon_fee: description: 优惠券费用 example: "1.00" type: string deliver_fee: description: 运费 example: "10.00" type: string dispatch_duration: description: 预计骑手还剩多久接单,单位:秒 example: 60 type: integer distance: description: 配送距离(单位:米) example: 300 type: integer fee: description: 实际运费 example: "9.00" type: string finish_code: description: 收货码,骑手必须输入收货码才能完成订单妥投 example: xxx type: string insurance_fee: description: 保价费用 example: "0.00" type: string order_no: description: 支付宝订单流水号 example: "2020090411130000000000772400280352" type: string pay_amount: description: "支付金额, 实际扣减的费用以此字段为准" example: "9.00" type: string pickup_code: description: "取货码, 骑手必须输入取货码才能从商家取货" example: xxx type: string status: description: 即时配送运单状态 example: i_101 type: string waybill_no: description: 即时配送运单编号 example: waybillno001 type: string type: object AlipayCommerceLogisticsWaybillIstddetailQueryErrorResponseModel: properties: code: description: 错误码 enum: - PARAM_ILLEGAL - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceLogisticsWaybillIstddetailQueryResponseModel: properties: reach_duration: description: 预计还剩多久送达 单位:秒 example: 600 type: integer rider_lat: description: 骑手位置纬度 example: "30.246984" type: string rider_lng: description: 骑手位置经度 example: "120.210568" type: string rider_mobile_no: description: 骑手电话 example: "18962866666" type: string rider_name: description: 骑手姓名 example: 小明 type: string rider_poi_link: description: 骑手实时定位H5链接字段,在骑手已接单后,将可展示骑手实时位置的H5页面链接同步商户 example: http://aliyun.com type: string status: description: 即时配送运单状态 example: i_102 type: string type: object AlipayCommerceOperationActivityMerchantModifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceOperationActivityMerchantModifyModel: properties: consumption_threshold: description: 消费门槛,单位分 example: 500 type: integer discount_amount: description: 优惠金额,单位分 example: 500 type: integer type: description: "NORMAL 常规类型,不限制, RESTRICTED 限制报名条件" example: NORMAL type: string type: object AlipayCommerceOperationActivityMerchantModifyResponseModel: type: object AlipayCommerceOperationActivityMerchantSignErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceOperationActivityMerchantSignModel: properties: consumption_threshold: description: 消费门槛(单位分) example: 5000 type: integer discount_amount: description: 优惠金额,单位分 example: 500 type: integer type: description: "报名类型,NORMAL 常规类型,不限制, RESTRICTED 限制报名条件" example: NORMAL type: string type: object AlipayCommerceOperationActivityMerchantSignResponseModel: type: object AlipayCommerceOperationActivityMerchantUnsignErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceOperationActivityMerchantUnsignResponseModel: type: object AlipayCommerceOperationBankActivityQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceOperationBankActivityQueryResponseModel: properties: activity_info_list: description: 活动信息列表 items: $ref: '#/components/schemas/BankActivityInfo' type: array merchant_tag: description: 商户标签 example: "28949219098127398" type: string type: object AlipayCommerceTransportChargerChargerbindinfoSyncErrorResponseModel: properties: code: description: 错误码 enum: - ISV_INVALID_ARGUMENTS - BUSINESS_FAILED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceTransportChargerChargerbindinfoSyncModel: properties: bind_qrcode: description: 绑定充电桩二维码值,用户扫码绑桩扫描的二维码 example: https://qrcode.starcharge.com/#/10050638 type: string bind_status: description: 绑定状态 1:绑定; 2:解绑; 0:未知 example: "1" type: string bind_time: description: 绑定时间,绑定成功必传 example: 2022-11-17 17:39:27 type: string connector_type: description: "1:家用插座\t2、交流接口插座\t3:交流接口插头\t4、直流接口枪头\t5、无线充电座\t6、其他" example: "2" type: string current_output_type: description: "1:国标\t2:欧标\t3:美标\t4:日标\t5:其他" example: "1" type: string equip_id: description: 设备编号 example: "65469765489754837868" type: string equip_imei: description: 设备IMEI号 example: "2432479035808" type: string equip_name: description: 设备名称,对用户展示,可以是设备名称,也可以是设备SN号,设备编号 example: 守护者XX1 type: string equip_sn: description: 设备SN号 example: "24789990209409" type: string equip_status: description: 设备状态,遵循中电联协议的设备状态。0:离网;1:空闲;2:占用未充电;3:占用充电中;4:占用(预约锁定);255:故障 example: "1" type: string equip_type_no: description: 设备型号 example: "2325436576768" type: string operator_id: description: 运营商编码,一般为企业组织机构代码 example: "325616137" type: string operator_uid: description: 商户内部唯一标识用户的用户标识 example: "13588139138" type: string rated_current: description: "额定电流,单位:A" example: "20" type: string rated_power: description: 额定功率,单位:kW example: "1000" type: string rated_voltage: description: 额定电压,单位:V example: "220" type: string unbind_time: description: 解绑时间,解绑必传 example: 2022-11-17 17:39:27 type: string type: object AlipayCommerceTransportChargerChargerbindinfoSyncResponseModel: properties: equip_id: description: 商户同步的充电桩设备编码 example: 234h78890900000 type: string fail_reason: description: 绑定关系结果接收失败原因 example: 设备状态不存在 type: string result_status: description: "0:成功\t1:拒绝" example: "0" type: string type: object AlipayCommerceTransportParkingEnterinfoSyncErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - BIZ_FAIL - BIZ_UNKNOWN type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceTransportParkingEnterinfoSyncModel: properties: agreement_query: description: 是否启用车牌代扣状态查询功能,true为启用,false为停用 example: true type: boolean free_enter_minutes: description: 当前停车场的入场免费时长分钟数 example: "15" type: string in_time: description: 车辆入场的时间,格式"YYYY-MM-DD HH:mm:ss",24小时制,请保证服务器时间准确,入场时间不应晚于当前网络时间 example: 2016-07-24 03:07:50 type: string is_encrypt_plate_no: description: 车牌是否加密,true为加密,false为不加密,默认为false example: false type: boolean need_charge: description: 当前行程是否需要计费。true:需要,false:不需要。不传默认为true。 example: true type: boolean open_appid: description: 蚂蚁会员统一ID对应的归属应用appid example: 2023xxxxxxxxxxxx type: string open_id: description: 蚂蚁会员统一ID example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string out_serial_no: description: 外部停车流水号(用于串通进场与出场信息) example: "2020090711003017233600000001" type: string parking_id: description: "支付宝停车平台ID,由支付宝定义的该停车场标识,同一个isv或商户范围内唯一。通过 alipay.eco.mycar.parking.parkinglotinfo.create\t\ (录入停车场信息)接口获取。" example: "2015042321001004720200028594" type: string plate_color: description: "车牌颜色,车牌颜色,枚举支持:\t*BLUE:蓝。\t*GREEN:绿。\t*YELLOW:黄。\t*WHITE:白\ 。\t*BLACK:黑。\t*LIMEGREEN:黄绿色。" example: BLUE type: string plate_no: description: 车牌号(支持加密格式) example: 豫C33333 type: string service_url: 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 type: string type: object AlipayCommerceTransportParkingEnterinfoSyncResponseModel: properties: agreement_scene: description: 用户签约的代扣场景字符集,多个英文逗号分割,当车场为ORC识别车牌的场景,返回值包含PLATE_PAY时,表示代扣协议可用。 当车场为ETC设备识别车牌,返回值包含ETC_PAY时表示协议可用。当用户未签约任何代扣场景时返回NO_AGREEMENT_SCENE example: PLATE_PAY type: string biz_code: description: 具体错误code example: INVALID_PARAMETER type: string biz_msg: description: 具体错误描述 example: 车牌不合法 type: string type: object AlipayCommerceTransportParkingExitinfoSyncErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_FAIL - BIZ_UNKNOWN - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceTransportParkingExitinfoSyncModel: properties: is_encrypt_plate_no: description: 车牌是否加密,true为加密,false为不加密,默认为false example: true type: boolean open_appid: description: 蚂蚁会员统一ID对应的归属应用appid example: 2023xxxxxxxxxxxx type: string open_id: description: 蚂蚁会员统一ID example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string out_serial_no: description: 外部停车流水号(用于串通进场与出场信息) example: "2020090711003017233600000001" type: string out_time: description: 车辆出场的时间,格式"YYYY-MM-DD HH:mm:ss",24小时制,请保证服务器时间准确,出场时间不应晚于当前网络时间,也不当早于入场时间。 example: 2016-07-24 03:07:50 type: string plate_color: description: "车牌颜色,车牌颜色,枚举支持:\t*BLUE:蓝。\t*GREEN:绿。\t*YELLOW:黄。\t*WHITE:白\ 。\t*BLACK:黑。\t*LIMEGREEN:黄绿色。" example: BLUE type: string plate_no: description: 车牌号(支持加密格式) example: 豫C33333 type: string service_url: 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 type: string type: object AlipayCommerceTransportParkingExitinfoSyncResponseModel: properties: biz_code: description: 具体错误码 example: INVALID_PARAMETER type: string biz_msg: description: 具体错误原因 example: 车牌不合法 type: string type: object AlipayCommerceTransportParkingPaymentinfoSyncErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_FAIL - BIZ_UNKNOWN - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayCommerceTransportParkingPaymentinfoSyncModel: properties: free_exit_minutes: description: 停车场内缴费后,允许出场的免费时长分钟数 example: "15" type: string is_encrypt_plate_no: description: 车牌是否加密,true为加密,false为不加密,默认为false example: true type: boolean open_appid: description: 蚂蚁会员统一ID对应的归属应用appid example: 2023xxxxxxxxxxxx type: string open_id: description: 蚂蚁会员统一ID example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string out_serial_no: description: 外部停车流水号(用于串通进场与出场信息) example: "2020090711003017233600000001" type: string payment_time: description: 场内缴费时间,格式"YYYY-MM-DD HH:mm:ss",24小时制,请保证服务器时间准确,场内缴费不应晚于当前网络时间 example: 2021-06-12 15:29:55 type: string payment_type: description: "支付方式\tALIPAY:支付宝支付\tCASH:现金\tOTHER:其他渠道\tFREE:免费" example: ALIPAY type: string plate_color: description: "车牌颜色,车牌颜色,枚举支持:\t*BLUE:蓝。\t*GREEN:绿。\t*YELLOW:黄。\t*WHITE:白\ 。\t*BLACK:黑。\t*LIMEGREEN:黄绿色。" example: BLUE type: string plate_no: description: 车牌号(支持加密格式) example: 豫C33333 type: string service_url: 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 type: string type: object AlipayCommerceTransportParkingPaymentinfoSyncResponseModel: properties: biz_code: description: 具体错误码 example: INVALID_PARAMETER type: string biz_msg: description: 具体错误原因 example: 车牌不合法 type: string type: object AlipayDataBillAccountbookereceiptApplyErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - SYSTEM_BUSY - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayDataBillAccountbookereceiptApplyModel: properties: agreement_no: description: 协议号 example: "20205215001418078112" type: string key: description: 明细凭证,传入流水号(转账接口查询结果)。汇总凭证,传入起止时间,格式yyyy-MM-dd_yyyy-MM-dd。 example: 2020-01-01_2020-01-10 type: string store_no: description: 子账本号,或者子账本名称。模糊查询 example: "2088000117463004" type: string type: description: 申请的类型。可传入:FUND_PLATFORM_DETAIL - 资金明细证明,FUND_PLATFORM_SUM - 资金汇总证明 example: FUND_PLATFORM_DETAIL type: string type: object AlipayDataBillAccountbookereceiptApplyResponseModel: properties: file_id: description: 文件申请号file_id信息。使用file_id可以查询处理状态 example: "12345" type: string type: object AlipayDataBillAccountbookereceiptQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - SYSTEM_BUSY - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayDataBillAccountbookereceiptQueryResponseModel: properties: download_url: description: "下载链接。status为SUCCESS时返回。用户可以使用此http链接下载文件内容。有效时间20s。\t生成的文件\ 是zip格式。需要解压后获取电子回单pdf内容" example: https://dwbillcenter.alipay.com/xxx type: string error_message: description: 如果生成失败,则会返回失败原因 example: key不存在 type: string status: description: "处理状态\t * INIT - 初始化\t * PROCESS - 处理中\t * SUCCESS - 成功\t\ \ * FAIL - 失败" example: SUCCESS type: string type: object AlipayDataBillAccountlogQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - SYSTEM_BUSY - AGREEMENT_CHECK_FAIL - USER_AGREEMENT_CHECK_FAIL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayDataBillAccountlogQueryResponseModel: properties: detail_list: description: "账务明细返回结果。\t当查询为空的时候,不返回,有结果的时候才会返回。" items: $ref: '#/components/schemas/AccountLogItemResult' type: array page_no: description: 分页号,从1开始 example: "1" type: string page_size: description: 分页大小1000-2000 example: "2000" type: string total_size: description: 账务明细总数。返回满足查询条件的明细的数量 example: "10000" type: string type: object AlipayDataBillBailQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - SYSTEM_BUSY type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayDataBillBailQueryResponseModel: properties: detail_list: description: 保证金明细列表,最多返回5000条 items: $ref: '#/components/schemas/BailDetailResult' type: array type: object AlipayDataBillBalanceQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - SYSTEM_BUSY - USER_AGREEMENT_CHECK_FAIL - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayDataBillBalanceQueryResponseModel: properties: available_amount: description: 账户可用余额 example: "9000.00" type: string freeze_amount: description: 冻结金额。单位(元) example: "1000.00" type: string settle_amount: description: 待结算金额,单位(元) example: "500.00" type: string total_amount: description: 支付宝账户余额 example: "10000.00" type: string type: object AlipayDataBillBalancehisQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - PROCESSING - SYSTEM_BUSY type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayDataBillBalancehisQueryResponseModel: properties: beginning_balance: description: 期初余额 example: "10000.00" type: string ending_balance: description: 期末余额 example: "11000.00" type: string type: object AlipayDataBillBizfundagentQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayDataBillBizfundagentQueryResponseModel: properties: detail_list: description: 资金明细记录 items: $ref: '#/components/schemas/BizFundReportResult' type: array page_no: description: 分页号,从1开始 example: "1" type: string page_size: description: 页面大小,最大2000 example: "2000" type: string total_size: description: 数据分页总页数 example: "100" type: string type: object AlipayDataBillBuyQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - SYSTEM_BUSY type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayDataBillBuyQueryResponseModel: properties: detail_list: description: 交易流水详情 items: $ref: '#/components/schemas/TradeItemResult' type: array page_no: description: 分页号,从1开始 example: "1" type: string page_size: description: 分页大小1000-2000 example: "2000" type: string total_size: description: 账务明细总数。返回满足查询条件的明细的数量 example: "10000" type: string type: object AlipayDataBillEreceiptApplyErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - SYSTEM_BUSY - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayDataBillEreceiptApplyModel: properties: bill_user_id: description: 授权商户pid。需调用方获取商户授权,才可使用。 example: 2088********9999 type: string key: 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: string type: 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 type: string type: object AlipayDataBillEreceiptApplyResponseModel: properties: file_id: description: "文件申请号file_id信息。\t使用file_id可以查询处理状态,有效期:2天" example: "12345" type: string type: object AlipayDataBillEreceiptQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - SYSTEM_BUSY - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayDataBillEreceiptQueryResponseModel: properties: download_url: description: "下载链接,status 为 SUCCESS 时返回。用户可以使用此http链接下载文件内容。有效时间为 30s。 \t\ 生成文件为PDF格式,下载即可获取电子回单 PDF 内容。" example: https://dwbillcenter.alipay.com/xxx type: string error_message: description: 如果生成失败,则会返回失败原因 example: key不存在 type: string status: description: "处理状态。枚举值如下:\tINIT:初始化。\tPROCESS:处理中。\tSUCCESS:成功。\tFAIL:失败\ 。" example: SUCCESS type: string type: object AlipayDataBillEreceiptagentApplyErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayDataBillEreceiptagentApplyModel: properties: agreement_no: description: ISV与商户签约授权协议号 example: "20200826170801" type: string end_time: description: "查询时间区间的结束时间,属于闭区间。\t[start_time,end_time]" example: 2023-11-08 00:00:00 type: string key: description: 根据不同业务类型,传入不同参数。格式如下: * FUND_DETAIL - 资金业务回单。传入资金单号(fundOrderId,可通过充值、转账、提现接口获取) example: 2020xxx type: string start_time: description: 搜索范围的起始时间 example: 2023-11-08 00:00:00 type: string type: description: 申请的类型(目前仅支持资金业务回单)。可传入: * FUND_DETAIL - 资金业务回单。 example: FUND_DETAIL type: string type: object AlipayDataBillEreceiptagentApplyResponseModel: properties: file_id: description: 文件申请号file_id信息。使用file_id可以查询处理状态 example: "12321" type: string type: object AlipayDataBillSellQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - SYSTEM_BUSY type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayDataBillSellQueryResponseModel: properties: detail_list: description: 交易流水详情 items: $ref: '#/components/schemas/TradeItemResult' type: array page_no: description: 分页号,从1开始 example: "1" type: string page_size: description: 分页大小1000-2000 example: "2000" type: string total_size: description: 账务明细总数。返回满足查询条件的明细的数量 example: "10000" type: string type: object AlipayDataBillTransferQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - SYSTEM_BUSY type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayDataBillTransferQueryResponseModel: properties: detail_list: description: 充值、提现、转账明细记录 items: $ref: '#/components/schemas/TransferDetailResult' type: array page_no: description: 分页号,从1开始 example: "1" type: string page_size: description: 分页大小1000-2000 example: "2000" type: string total_size: description: 充值、提现、转账明细总数。返回满足查询条件的明细的数量 example: "10000" type: string type: object AlipayDataBillTransferaccountbookQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - SYSTEM_BUSY type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayDataBillTransferaccountbookQueryResponseModel: properties: detail_list: description: 充值、提现、转账明细记录 items: $ref: '#/components/schemas/TransferAccountBookDetailResult' type: array page_no: description: 分页号,从1开始 example: "1" type: string page_size: description: 分页大小1000-2000 example: "2000" type: string total_size: description: 充值、提现、转账明细总数。返回满足查询条件的明细的数量 example: "10000" type: string type: object AlipayDataDataserviceAdConversionUploadErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - BIZ_ERROR - NO_SERVICE_PURVIEW - BIZ_TOKEN_ERROR - NO_DATA_PURVIEW - NULL_ARGUMENT - PRINCIPAL_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayDataDataserviceAdConversionUploadModel: properties: biz_token: description: 代理商访问灯火平台的token example: HYjofejnnlp89730202bcklHH type: string conversion_data_list: description: "转化数据列表, 最多1000条" items: $ref: '#/components/schemas/ConversionData' type: array type: object AlipayDataDataserviceAdConversionUploadResponseModel: type: object AlipayDataDataserviceAdPromotepageBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - BIZ_ERROR - NO_SERVICE_PURVIEW - BIZ_TOKEN_ERROR - NO_DATA_PURVIEW - NULL_ARGUMENT - PRINCIPAL_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayDataDataserviceAdPromotepageBatchqueryResponseModel: properties: list: description: 自建推广页详情列表 items: $ref: '#/components/schemas/PromotePageDetail' type: array page_no: description: 分页参数之页数 example: 1 type: integer page_size: description: 分页参数之每页大小 example: 100 type: integer total: description: 分页参数之总数据量 example: 1000 type: integer type: object AlipayDataDataserviceAdPromotepageDownloadErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - BIZ_ERROR - NO_SERVICE_PURVIEW - BIZ_TOKEN_ERROR - NO_DATA_PURVIEW - NULL_ARGUMENT - PRINCIPAL_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayDataDataserviceAdPromotepageDownloadResponseModel: properties: conversion_id: description: 转化事件ID example: "167390987332" type: string list: description: 留资属性实例数据列表 items: $ref: '#/components/schemas/PromotePageData' type: array page_no: description: 分页参数之页数,从1开始 example: 1 type: integer page_size: description: 分页参数之每页大小,最大1000 example: 100 type: integer total: description: 分页参数之总数据量 example: 1000 type: integer type: object AlipayDataDataserviceBillDownloadurlQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVAILID_ARGUMENTS - BILL_NOT_EXIST - UNKNOWN_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayDataDataserviceBillDownloadurlQueryResponseModel: properties: bill_download_url: description: 账单下载地址链接,获取连接后30秒后未下载,链接地址失效。 example: http://dwbillcenter.alipay.com/downloadBillFile.resource?bizType=X&pid=X&fileType=X&bizDates=X&downloadFileName=X&fileId=X type: string bill_file_code: description: "描述本次申请的账单文件状态。\tEMPTY_DATA_WITH_BILL_FILE:当天无账单业务数据&&可以获取到\ 空数据账单文件。" example: EMPTY_DATA_WITH_BILL_FILE type: string type: object AlipayEbppBillAddErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppBillAddModel: properties: bank_bill_no: description: 外部订单号 example: "20130916" type: string bill_date: description: 账单的账期,格式为 yyyyMMdd。例如:202012表示2020年12月的账单。 example: "201203" type: string bill_key: description: 账单单据号,例如水费单号,手机号,电费号,信用卡卡号。没有唯一性要求。 example: "3388102012376451" type: string charge_inst: description: 支付宝给每个出账机构指定了一个对应的英文短名称来唯一表示该收费单位。 example: BJCEB type: string extend_field: description: 扩展属性 example: "{\"key1\":\"value1\",\"key2\":\"value2\",\"key3\":\"value3\",\"\ key4\":\"value4\"}" type: string merchant_order_no: description: 输出机构的业务流水号,需要保证唯一性 example: "201203031234567" type: string mobile: description: 用户的手机号 example: "15987838584" type: string order_type: description: "支付宝订单类型。枚举支持:\t*JF:公共事业缴纳。\t*WUYE:物业缴费。\t*HK:信用卡还款。\t*TX:通\ 讯缴费。" example: JF type: string owner_name: description: 拥有该账单的用户姓名 example: 织绫 type: string pay_amount: description: "缴费金额。用户支付的总金额。单位为 元(人民币)。取值范围为[0.01,100000000.00],精确到小数点后两\ 位。" example: "23.45" type: string service_amount: description: 账单的服务费。 example: "8" type: string sub_order_type: 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 type: string traffic_location: description: 交通违章地点,sub_order_type=TRAFFIC时填写。 example: "浙江,杭徽高速" type: string traffic_regulations: description: 违章行为,sub_order_type=TRAFFIC时填写。 example: 闯红灯 type: string type: object AlipayEbppBillAddResponseModel: properties: alipay_order_no: description: 支付宝的业务订单号,具有唯一性。 example: "201203088888888" type: string bank_bill_no: description: 外部订单号,由于对账时回传给外部商户 example: "20130705" type: string bill_date: description: 账单的账期,格式为 yyyyMMdd。例如:202012表示2020年12月的账单。 example: "201203" type: string bill_key: description: 账单单据号,例如水费单号,手机号,电费号,信用卡卡号。没有唯一性要求。 example: "3388102012376451" type: string charge_inst: description: 支付宝给每个出账机构指定了一个对应的英文短名称来唯一表示该收费单位。 example: BJCEB type: string charge_inst_name: description: 出账机构中文名称。 example: 北京光大 type: string extend_field: description: "扩展属性,该属性值现在用于确保只有一个人可以支付成功\r\t用法:多个人对同一笔外部欠费单创建多个账单时,确保该值不\ 变" example: "20140504" type: string merchant_order_no: description: 输出机构的业务流水号,需要保证唯一性。 example: "201203031234567" type: string order_type: description: "支付宝订单类型。枚举支持:\t*JF:公共事业缴纳。\t*WUYE:物业缴费。\t*HK:信用卡还款。\t*TX:通\ 讯缴费。" example: JF type: string owner_name: description: 拥有该账单的用户姓名 example: 织绫 type: string pay_amount: description: "缴费金额。用户支付的总金额。单位为 元(人民币)。取值范围为[0.01,100000000.00],精确到小数点后两\ 位。" example: "23.45" type: string service_amount: description: 账单的服务费 example: "8" type: string sub_order_type: 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 type: string type: object AlipayEbppBillGetErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppBillGetResponseModel: properties: alipay_order_no: description: 支付宝的业务订单号,具有唯一性。 example: "201203088888888" type: string bill_date: description: 账单的账期,例如201203表示2012年3月的账单。 example: "201203" type: string bill_key: description: 账单单据号,例如水费单号,手机号,电费号,信用卡卡号。没有唯一性要求。 example: "3388102012376451" type: string charge_inst: description: 支付宝给每个出账机构指定了一个对应的英文短名称来唯一表示该收费单位。 example: BJCEB type: string charge_inst_name: description: 出账机构中文名称。 example: 北京光大 type: string merchant_order_no: description: 输出机构的业务流水号,需要保证唯一性。 example: "201203031234567" type: string order_status: description: "账单的状态。 INIT:等待付款,SUCCESS:成功,FAILED:失败。" example: S type: string order_type: description: "支付宝订单类型。公共事业缴纳JF,信用卡还款HK" example: JF type: string owner_name: description: 拥有该账单的用户姓名 example: 织绫 type: string pay_amount: description: "缴费金额。用户支付的总金额。单位为:RMB Yuan。取值范围为[0.01,100000000.00],精确到小数点\ 后两位。" example: "23.45" type: string pay_time: description: 付款时间 example: 2012-01-01 00:22:11 type: string service_amount: description: 账单的服务费 example: "8" type: string sub_order_type: description: 子业务类型是业务类型的下一级概念,例如:WATER表示JF下面的水费,ELECTRIC表示JF下面的电费,GAS表示JF下面的燃气费。 example: WATER type: string traffic_location: description: 交通违章地点,sub_order_type=TRAFFIC时有值 example: "浙江,杭徽高速" type: string traffic_regulations: description: 违章行为,sub_order_type=TRAFFIC时有值。 example: 违章停车 type: string type: object AlipayEbppInvoiceApplyInvUploadErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceApplyInvUploadModel: properties: anti_fake_code: description: 发票防伪码/密码 example: acbgjjk13jsadjkfdajkadf123 type: string apply_id: description: "发票申请ID, 由阿里发票平台生成。 拆单开票后一笔申请可能对应多张发票。 source=apply时必填,其他source可\ 为空" example: "12345678" type: string biz_error_code: description: 开票失败错误码, 开票失败(create_result=fail)时必填 example: sys type: string biz_error_msg: description: 开票失败错误信息, 开票失败(create_result=fail)时必填 example: 系统异常 type: string business_type: description: 抬头类型。可选值: 0:个人 1:企业 example: 0 type: integer check_code: description: 校验码 example: acbgjjk13 type: string create_result: description: "开票结果,枚举值: success: 发票开具成功; fail: 开票失败; source=async时必填,传实际\ 的开票结果。其他source可不传,默认为success" example: success type: string device_no: description: 开票分机号/机器编号 example: "12345678" type: string invoice_amount: description: 合计含税金额(开票金额),格式为2位小数。 当开红票时,该字段为负数。 开票成功时(create_result=success)必填 example: "1170.00" type: string invoice_code: description: 发票代码。 开票成功时(create_result=success)必填 example: "123123123412" type: string invoice_date: description: 开票日期,格式 yyyy-MM-dd. 开票成功时(create_result=success)必填 example: 2020-09-10 type: string invoice_file_content: description: 发票版式文件数据,base64化的字符串; 电子发票必填 example: sfsdfhgsgs type: string invoice_file_type: description: "发票板式文件类型。可选值: PDF, OFD。 开电票且开票成功时(create_result=success)必填" example: PDF type: string invoice_items: $ref: '#/components/schemas/InvoiceItem' invoice_kind: description: "开票发票类型 可选值: 0: 电票; 1:纸质普票; 2:纸质专票; 开票成功时(create_result=success)必\ 填" example: 0 type: integer invoice_memo: description: 发票备注,会显示在票面 example: 电子发票测试 type: string invoice_no: description: 发票号码。 开票成功时(create_result=success)必填 example: "12345678" type: string invoice_type: description: "发票(开票)类型,可选值: blue: 蓝票; red: 红票; 开票成功时(create_result=success)必\ 填" example: blue type: string levy_type: description: 征税方式,0普通征收,1减按征收,2差额征收 example: "0" type: string normal_invoice_code: description: 原发票代码。 冲红且开票成功时(create_result=success)必填 example: "111100000000" type: string normal_invoice_no: description: 原发票号码。 冲红且开票成功时(create_result=success)必填 example: "00004349" type: string payee_address: description: 销方地址。 开票成功时(create_result=success)必填 example: 杭州市西湖区 type: string payee_bank_account_id: description: 销方银行账号 example: "8888888888888888" type: string payee_bank_name: description: 销方开户行名称 example: "92523123213412341234" type: string payee_checker: description: 复核人 example: 王五 type: string payee_name: description: 销方名称。 开票成功时(create_result=success)必填 example: 测试企业 type: string payee_operator: description: 开票人。 开票成功时(create_result=success)必填 example: 张三 type: string payee_phone: description: 销方联系电话。 开票成功时(create_result=success)必填 example: "18234561212" type: string payee_receiver: description: 收款人 example: 李四 type: string payee_register_no: description: 销方税务登记证号。由大写字母或数字组成,长度要求15~20位。 开票成功时(create_result=success)必填 example: "20150201321123" type: string payer_address: description: 购方地址, 专票且开票成功时(create_result=success)必填 example: 浙江省杭州市余杭区文一西路xxx号 type: string payer_bank_account_id: description: 购方银行账号, 专票且开票成功时(create_result=success)必填 example: "123412341234" type: string payer_bank_name: description: 购方开户行名称, 专票且开票成功时(create_result=success)必填 example: 招商银行 type: string payer_email: description: "购方电子邮箱,需满足邮箱格式。 格式要求:\\\\w+([-+.]\\\\w+)*@\\\\w+([-.]\\\\\ w+)*\\\\.\\\\w+([-.]\\\\w+)*" example: mytest@xxx.com type: string payer_name: description: 购方抬头。 开票成功时(create_result=success)必填 example: 张三 type: string payer_phone: description: 购方联系电话, 专票且开票成功时(create_result=success)必填 example: "18234561212" type: string payer_register_no: description: 购方税务登记证号,由大写字母或数字组成,长度要求15~20位。 开企业抬头时必填, 专票且开票成功时(create_result=success)必填 example: "2015020123123" type: string platform_code: description: "业务平台Code, 由发票中台分配。 用于标识需交付发票的业务平台,source=upload时必填,其他source可\ 为空" example: TB type: string platform_tid: description: 业务平台发票申请对应的订单号。 用于区分业务平台订单号,source=upload时必填,其他source可为空 example: "100011101" type: string platform_user_id: description: 业务平台发票申请对应的订单号。 用于区分业务平台订单号,source=upload时必填,其他source可为空 example: "12345678" type: string qr_code: description: 二维码 example: adsf123 type: string receive_mobile: description: 购方手机号码,用于收票 example: "13388889999" type: string red_notice_no: description: 红字通知单号; 专票冲红且开票成功时(create_result=success)必填 example: "123" type: string serial_no: description: 开票流水号/序列号,唯一标志一笔开票请求,由于阿里发票中台生成。 source=async时必填,其他source可为空 example: TB1001_1331 type: string source: description: "发票来源,可选值: apply: 间连开票模式,ISV回传商家基于申请开具的发票; async:直连开票模式,ISV回\ 传开票结果; upload:直接回传,进行归集与交付的发票" example: apply type: string special_flag: description: 特殊票种标识,可选值: “00”非特殊票种 (默认值) “02”农产品收购 “06”抵扣通行费 “07”其它通行费 “08”成品油销售 “18”成品油专票负数发票 example: "02" type: string sum_price: description: 合计金额(不含税),格式为2位小数。 当开红票时,该字段为负数。 开票成功时(create_result=success)必填 example: "1000.00" type: string sum_tax: description: 合计税额,格式为2位小数。 当开红票时,该字段为0或负数。 开票成功时(create_result=success)必填 example: "170.00" type: string type: object AlipayEbppInvoiceApplyInvUploadResponseModel: properties: is_success: description: 处理是否成功 example: true type: boolean type: object AlipayEbppInvoiceApplyResultSyncErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - ANT_INVOICE_APPLY_NOT_EXIST - BIZ_ERROR - INVOICE_APPLY_RETURN_INVALID type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceApplyResultSyncModel: properties: apply_id: description: 支付宝发起开票申请的id,该id具有唯一性,该字段由支付宝向税控发起申请的时候带过去,作为支付宝向税控开票申请的唯一标志 example: "2023000000000000000000000001" type: string result: description: "支付宝向税控商或ISV发起发票申请后,对应这笔申请的发票开具结果。\r\t取值如下:\r\tSUCCESS:成功;FAIL:失\ 败" example: SUCCESS type: string result_code: description: "结果码,支付宝向税控商或ISV发起发票申请后,对应这笔申请的发票开具结果进行详细说明的结果码。\r\t取值如下:\r\ \t成功(SUCCESS),\r\t参数不合法(PARAMETER_ILLEGAL),\r\t商户税控设备异常(MERCHANT_TAX_DEVICE_ERROR)." example: SUCCESS type: string result_msg: description: 结果描述,支付宝向税控商或ISV发起发票申请后,对应这笔申请的发票开具结果描述信息。 example: 成功 type: string tax_apply_id: description: "该字段是税控商或ISV收到支付宝开票请求后生成的申请id,由税控商或isv自己生成,该id具有唯一性\r\t当ISV接\ 入时是按照tax_apply_id来查询发票信息时,该字段必填。" example: "20160707399929991001" type: string type: object AlipayEbppInvoiceApplyResultSyncResponseModel: properties: retry_flag: description: "标注是否需要调用方重试。\r\t当结果返回失败时(code 不等于 10000 且 msg 不等于 SUCCESS\r\ \t),如果该字段返回true表明该失败的情况通过重试补偿可解决,为false表明失败情况通过重试无法解决,可以停止重试,根据返回的错误码尝\ 试解决。" example: false type: boolean type: object AlipayEbppInvoiceApplyStatusNotifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceApplyStatusNotifyModel: properties: apply_id: description: "发票申请ID,由阿里发票平台生成。字母或数字组成。\t申请单的唯一标识,幂等字段。" example: "123456" type: string apply_status: description: "申请状态,可选值:\tapplying: 申请中,初始状态;\tcancelled: 申请已取消、或商户已驳回;\t\ creating_inv: 商户已受理/开票中,待发票结果回传;\tinv_failed: 开票失败;\tinv_success: 开票成功\ ;\tinv_part_success: 部分成功(拆单场景下存在。举例:发票申请拆单之后有10张票,其中有1张开票成功时,此时申请状态为\ inv_part_success,当10张票全部成功申请状态则为inv_success)" example: cancelled type: string invoice_uks: description: "该申请下所有已开具成功的发票。\t状态变更为 apply_status=inv_success 时该字段必传" items: $ref: '#/components/schemas/InvoiceUkDTO' type: array message: description: "说明信息:驳回或失败原因\tapply_status=inv_failed 或 apply_status=cancelled\ \ 时必传" example: 购方信息错误 type: string type: object AlipayEbppInvoiceApplyStatusNotifyResponseModel: properties: missing_invoices: description: "update_success=false时返回。\t该申请下存在未归集成功的发票。即:attach_invoices\ \ 中携带的发票存在未回传成功的发票。\t此时调用方,需先调用发票回传接口,完成发票回传。然后再重试此接口。" items: $ref: '#/components/schemas/InvoiceUkDTO' type: array update_success: description: 事务执行结果,true成功,false失败 example: true type: boolean type: object AlipayEbppInvoiceApplystatusQueryErrorResponseModel: properties: code: description: 错误码 enum: - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceApplystatusQueryModel: properties: m_short_name: description: "定义商户的一级简称,用于标识商户品牌,对应于商户入驻时填写的\"商户品牌简称\"。 如:肯德基:KFC" example: KFC type: string order_no_list: description: "待查询订单开票状态列表,各订单号间通过英文逗号分割,不限于支付宝体内交易订单号。如:20200520110046966071,20200520110046966072,20200520110046966073" example: "20200520110046966071,20200520110046966072,20200520110046966073" items: type: string type: array sub_m_short_name: description: "定义商户的二级简称,用于标识商户品牌下的分支机构,如门店,对应于商户入驻时填写的\"商户门店简称\"。 如:肯德基\ -杭州西湖区文一西路店:KFC-HZ-19003 要求:\"商户品牌简称+商户门店简称\"作为确定商户及其下属机构的唯一标识,不可重复。" example: KFC-HZ-19003 type: string type: object AlipayEbppInvoiceApplystatusQueryResponseModel: properties: apply_status_brief_dtos: description: 每笔交易开票状态 items: $ref: '#/components/schemas/OrderApplyStatusBriefDTO' type: array type: object AlipayEbppInvoiceAuthSignErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceAuthSignModel: properties: authorization_type: description: "发票授权类型,可选值:INVOICE_AUTO_SYNC(发票自动回传)\tINVOICE_TWOWAY_AUTO_SYNC(\ 发票双向自动回传)" example: INVOICE_AUTO_SYNC type: string extend_fields: description: "扩展字段,格式为:KEY1=VALUE1,KEY2=VALUE2,KEY3=VALUE3\t邮箱地址KEY为EMAIL_ADDRESS" example: EMAIL_ADDRESS=example@alipay.com type: string m_short_name: description: 开票商户品牌简称,与商户入驻时的品牌简称保持一致。 example: CSD type: string open_id: description: 支付宝用户userId example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string user_id: description: 支付宝用户userId example: "2088399922382233" type: string type: object AlipayEbppInvoiceAuthSignResponseModel: type: object AlipayEbppInvoiceAuthUnsignErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - RECORD_NOT_EXIST - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceAuthUnsignModel: properties: authorization_type: description: "发票授权类型,可选值:INVOICE_AUTO_SYNC(发票自动回传)\tINVOICE_TWOWAY_AUTO_SYNC(\ 发票双向自动回传)" example: INVOICE_AUTO_SYNC type: string extend_fields: description: "扩展字段,格式为:KEY1=VALUE1,KEY2=VALUE2,KEY3=VALUE3\t邮箱地址KEY为EMAIL_ADDRESS" example: EMAIL_ADDRESS=example@alipay.com type: string m_short_name: description: 开票商户品牌简称,与商户入驻时的品牌简称保持一致。 example: CSD type: string open_id: description: 支付宝用户userId example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string user_id: description: 支付宝用户userId example: "2088399922382233" type: string type: object AlipayEbppInvoiceAuthUnsignResponseModel: type: object AlipayEbppInvoiceDetailOutputQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVOICE_NOT_EXIST - INVOICE_QUERY_DENY - PARAMETER_ILLEGAL - QUERY_TAX_NO_NOT_EQUAL_CERTIFY_NO type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceDetailOutputQueryModel: properties: invoice_code: description: "发票代码\t长度限制(10-12位),全电票则为空" example: "1234567890" type: string invoice_no: description: "发票号码\t长度限制(8-20位)" example: "12345678" type: string open_id: description: 支付宝用户 id example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string scene: description: 获取发票明细应用场景。固定为 INVOICE_EXPENSE 表示发票报销。 example: INVOICE_EXPENSE type: string skip_expense_progress_sync: description: 是否跳过发票报销状态同步;当为true时,跳过报销状态同步校验。默认为false,需要先做报销状态同步 example: false type: boolean user_id: description: 发票归属用户 id,用户在支付宝的唯一标识,以 2088 开头的 16 位纯数字组成。 example: "20880000000000000" type: string type: object AlipayEbppInvoiceDetailOutputQueryResponseModel: properties: anti_fake_code: description: 防伪码,发票校验码 example: "14345678908765433456" type: string ex_tax_amount: description: 不含税金额(废弃) example: "85.00" type: string expense_status: description: "发票报销状态\r\t取值范围:\r\tWAIT_EXPENSE-未报销\r\tEXPENSE_PROCESSING-\ 报销中\r\tEXPENSE_FINISHED-已报销" example: WAIT_APPLY type: string has_risk: description: "该发票可能存在异常,请核实后使用\r\ttrue:无异常\r\tfalse:存在异常" example: true type: boolean has_upload_pdf: description: "是否已上传发票pdf文件\r\tfalse-未上传\r\ttrue-已上传" example: "false" type: string invoice_amount: description: 发票金额(价税合计金额) example: "100.00" type: string invoice_code: description: "发票代码\t(全电票为空)" example: "123456" type: string invoice_date: description: 开票日期 example: 2017-07-10 type: string invoice_img_url: description: 发票缩略图地址 example: http://img.test.com type: string invoice_item_content_list: description: 发票内容项 items: $ref: '#/components/schemas/InvoiceItemContent' type: array invoice_no: description: 发票号码 example: "123" type: string invoice_status: description: "发票状态\r\tSUCCEED-成功\r\tEXPIRED-已失效\r\tTRANSFERRED-已转交" example: SUCCEED type: string invoice_type: description: "发票类型\r\t值有两种情况:blue-蓝票 red-红票" example: blue type: string payee_address: description: 销售方地址 example: 浙江杭州万塘路18号 type: string payee_bank_account: description: 销售方开户银行账号 example: "1234" type: string payee_bank_name: description: 销售方开户银行名称 example: 建设银行 type: string payee_phone: description: 销售方电话 example: 012-0000000 type: string payee_register_name: description: 销售方名称 example: 国力大酒店 type: string payee_tax_no: description: 销售方税号 example: "123456789" type: string payer_address: description: 购买方地址 example: 浙江杭州西湖区天目山路222号 type: string payer_bank_account: description: 购买方开户银行账号 example: "123556" type: string payer_bank_name: description: 购买方开户银行名称 example: 招商银行 type: string payer_name: description: 购买方名称 example: 支付宝(中国)技术有限公司 type: string payer_phone: description: 购买方电话 example: "1893445555555" type: string payer_tax_no: description: 购买方税号 example: "1234" type: string sum_tax_amount: description: 合计税额(废弃) example: "15.00" type: string tax_type: description: "票种\tPLAIN:增值税电子普通发票\tSPECIAL:增值税专用发票\tALL_ELECTRONIC_GENERAL:\ 电子发票(普通发票)\tALL_ELECTRONIC_SPECIAL:电子发票(增值税专用发票)\tPLAIN_INVOICE:增值税普通发\ 票\tPAPER_INVOICE:增值税普通发票(卷式)\tSALSE_INVOICE:机动车销售统一发票" example: PLAIN type: string type: object AlipayEbppInvoiceEcorderOrderQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - PERMISSION_DENIED - INVALID_PARAMETER - ORDER_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceEcorderOrderQueryResponseModel: properties: order_info: $ref: '#/components/schemas/EcOrderItem' sub_order_list: description: 企业码子订单详情列表 items: $ref: '#/components/schemas/EcOrderItem' type: array type: object AlipayEbppInvoiceEinvpackageQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceEinvpackageQueryResponseModel: properties: package_item_info_list: description: 发票包明细数据 items: $ref: '#/components/schemas/PackageItemOpenInfo' type: array type: object AlipayEbppInvoiceEnterpriseMerchantrelationCreateErrorResponseModel: properties: code: description: 错误码 enum: - PARAMETER_ILLEGAL - SYSTEM_ERROR - PERMISSION_DENIED - INVALID_TRADE_NO type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceEnterpriseMerchantrelationCreateModel: properties: account_id: description: 共同账户ID example: 2088xxx type: string agreement_no: description: 授权签约协议号 example: "20215713002876184996" type: string operator_id: description: 传入操作人员标识 example: 记录操作人身份标识,可传工号,如9527 type: string shop_info: $ref: '#/components/schemas/EcShopInfo' trade_no: description: 交易流水号 example: 2019xxxxxx type: string type: object AlipayEbppInvoiceEnterpriseMerchantrelationCreateResponseModel: properties: pid: description: 门店收单pid example: 2088xxx type: string role_type: description: 门店直间连类型 example: "0" type: string shop_id: description: 门店ID example: 2088xxx type: string success: description: 是否成功 example: true type: boolean type: object AlipayEbppInvoiceEnterpriseconsumeConsumeBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - PERMISSION_DENIED - EMPLOYEE_CNT_LIMIT_ERROR - DURATION_EXCEED_LIMIT_ERROR - SYSTEM_ERROR - DURATION_ILLEGAL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceEnterpriseconsumeConsumeBatchqueryModel: properties: account_id: description: 企业ID example: "2088000194958956" type: string agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string consumption_end: description: 交易结束时间,格式:yyyy-MM-dd HH:mm:ss example: 2021-12-16 00:00:00 type: string consumption_start: description: 交易开始时间,格式:yyyy-MM-dd HH:mm:ss example: 2021-12-16 00:00:00 type: string employee_list: description: 员工支付宝UID列表,单次传入最大员工数量为10 example: "[\"2088210888827370\"]" items: type: string type: array employee_open_ids: description: 员工支付宝UID列表,单次传入最大员工数量为10 example: "[\"074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5\"]" items: type: string type: array type: object AlipayEbppInvoiceEnterpriseconsumeConsumeBatchqueryResponseModel: properties: expense_consume_info_list: description: 企业查询到的员工账单列表 items: $ref: '#/components/schemas/ExpenseConsumeInfo' type: array type: object AlipayEbppInvoiceEnterpriseconsumeDetailQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - PERMISSION_DENIED - VOUCHER_NOT_EXIST - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceEnterpriseconsumeDetailQueryResponseModel: properties: expense_consume_info: $ref: '#/components/schemas/ExpenseConsumeInfo' expense_invoice_info: $ref: '#/components/schemas/ExpenseInvoiceInfo' voucher_info: $ref: '#/components/schemas/ExpenseVoucherInfo' type: object AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleCreateModel: properties: account_id: description: 共同账户ID example: "2088000194958956" type: string agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string bill_month_day: description: 账期结束日期 example: 5 type: integer enterprise_id: description: 企业ID example: "2088402284248282" type: string invoice_rule_name: description: 开票规则名称 example: 开票规则测试1 type: string invoice_title_id: description: 发票抬头 example: "2021032900152710950000000001" type: string open_mode: description: 开票模式 example: SUMMARY type: string receive_address: description: 收件人地址 example: 杭州市西湖区 type: string receive_name: description: 收件人姓名 example: 张三 type: string receive_phone: description: 收件人手机号 example: "15555555555" type: string seller_type: description: 销方类型 example: TP type: string tag: description: 开票规则标记 example: DEFAULT type: string type: object AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleCreateResponseModel: properties: invoice_rule_id: description: 开票规则ID example: "2021070100152721370000002201" type: string type: object AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleModifyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleModifyModel: properties: account_id: description: 企业共同账户ID example: "2088000194958956" type: string agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string enterprise_id: description: 企业ID example: "2088000194958956" type: string invoice_rule_id: description: 开票规则ID example: "2021032900152710950000000001" type: string invoice_rule_name: description: 开票规则名称 example: 开票规则测试2 type: string invoice_title_id: description: 发票抬头 example: "2021080500152710850000000421" type: string receive_address: description: 收件人地址 example: 杭州市西湖区 type: string receive_name: description: 收件人姓名 example: 张三 type: string receive_phone: description: 收件人手机号 example: "15555555555" type: string seller_type: description: 销方类型 example: TP type: string type: object AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleModifyResponseModel: properties: success: description: success example: true type: boolean type: object AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleQueryErrorResponseModel: properties: code: description: 错误码 enum: - PARAMETER_ILLEGAL - SYSTEM_ERROR - PERMISSION_DENIED - INVOICE_RULE_NOT_EXIST - REMOTE_SERVICE_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleQueryResponseModel: properties: enterprise_open_rule_info: $ref: '#/components/schemas/EnterpriseOpenRuleInfo' type: object AlipayEbppInvoiceEnterpriseconsumeOpenrulerelationCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceEnterpriseconsumeOpenrulerelationCreateModel: properties: account_id: description: 企业共同账户ID example: "2088000194958956" type: string agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string enterprise_id: description: 企业ID example: "2088000194958901" type: string invoice_rule_id: description: 开票规则ID example: "2021070101152721181000002201" type: string standard_id_list: description: 费控规则ID列表 example: "[\"2021090600152601180000000358\",\"2021090600152601180000000359\"\ ]" items: type: string type: array type: object AlipayEbppInvoiceEnterpriseconsumeOpenrulerelationCreateResponseModel: properties: success: description: 是否成功 example: true type: boolean type: object AlipayEbppInvoiceEnterpriseconsumeRelatedetailQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - PERMISSION_DENIED - VOUCHER_NOT_EXIST - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceEnterpriseconsumeRelatedetailQueryResponseModel: properties: expense_ctrl_consume_info: $ref: '#/components/schemas/ExpenseCtrlConsumeInfo' type: object AlipayEbppInvoiceEnterpriseconsumeSummaryinvoicedetailQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - PERMISSION_DENIED - SUMMARY_INVOICE_NOT_EXIT - PARAMETER_ILLEGAL - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceEnterpriseconsumeSummaryinvoicedetailQueryResponseModel: properties: account_id: description: 企业汇总场景下,即企业ID example: "2088000237836238" type: string apply_date: description: 申请时间 example: 2021-08-26 11:11:11 type: string batch_id: description: 已废弃,开票批次 ID(建议使用summary_id) example: "2021080400152500230000000881" type: string batch_status: description: "批次状态
\t INIT:汇总批次初始化状态,未进行汇总
\t SUMMARY:汇总批次\ 化汇总完成,汇总金额计算完成
\t PROCESS:汇总批次初始化状态,汇总开票申请提交成功
\t NOT_SUPPORT:\ 汇总开票商户业务能力不支持
\t FAIL:汇总批次申请失败状态
\t SUCCESS:汇总批次申请成功状态,此\ 时发票已回传
\t MANUAL_CONFIRM:汇总批次人工确认收票
" example: SUCCESS type: string complete_voucher_list: description: 发票内容 items: $ref: '#/components/schemas/CompleteVoucherInfo' type: array gmt_biz_end: description: 账期结束时间 example: 2021-08-09 00:00:59 type: string gmt_biz_start: description: 账期起始时间 example: 2021-08-09 00:00:59 type: string status_show_content: description: "状态对应的展示明细内容
\t 初始化
\t 汇总完成
\t 开票中...
\t\ \ 不支持开票
\t 开票失败
\t 已开票
\t 确认已收票
" example: 已开票 type: string summary_id: description: 开票批次 ID example: "2021080400152500230000000881" type: string user_id: description: 企业汇总场景下,即企业ID(请使用account_id) example: "2088000237836238" type: string type: object AlipayEbppInvoiceEnterpriseexctrlEmployertitleBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - PERMISSION_DENIED - SYSTEM_ERROR - PARAMETER_ILLEGAL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceEnterpriseexctrlEmployertitleBatchqueryModel: properties: account_id: description: 企业共同账户id example: "2088000194958956" type: string agreement_no: description: 授权签约协议号 example: "20215425001181407500" type: string enterprise_id: description: 企业id example: "2088123412341234" type: string page_num: description: 页码 example: 1 type: integer page_size: description: 每页行数 example: 10 type: integer type: object AlipayEbppInvoiceEnterpriseexctrlEmployertitleBatchqueryResponseModel: properties: code: description: "返回码\t10000-成功\t其他都是失败" example: "10000" type: string msg: description: 返回消息 example: 成功 type: string title_info_list: description: 企业抬头信息 items: $ref: '#/components/schemas/EnterpriseTitleInfo' type: array type: object AlipayEbppInvoiceEnterpriseexctrlEmployertitleCreateErrorResponseModel: properties: code: description: 错误码 enum: - PARAMETER_ILLEGAL - PERMISSION_DENIED - SYSTEM_ERROR - ENTERPRISE_TITLE_EXISTS - ENTERPRISE_TITLE_EXCEED - ENTERPRISE_TITLE_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceEnterpriseexctrlEmployertitleCreateModel: properties: account_id: description: 企业共同账户id example: "2088000194958956" type: string address: description: 企业地址 example: '***省***市****区' type: string agreement_no: description: 授权签约协议号 example: "20215425001181407500" type: string bank_account: description: 开户行账号 example: 622000******** type: string bank_name: description: 开户行名称 example: 招商银行 type: string enterprise_id: description: 企业id example: "2088123412341234" type: string tax_register_no: description: 税号 example: 9133*********5852F type: string telephone: description: 电话 example: 0739-56***** type: string title_name: description: 企业抬头名称 example: '*****有限公司' type: string type: object AlipayEbppInvoiceEnterpriseexctrlEmployertitleCreateResponseModel: properties: code: description: "返回码\t10000-成功\t其他都是失败" example: "10000" type: string msg: description: 返回消息 example: 成功 type: string success: description: 是否成功 example: true type: boolean title_id: description: 抬头ID example: "2021090100152710300000000729" type: string type: object AlipayEbppInvoiceEnterpriseexctrlEmployertitleModifyErrorResponseModel: properties: code: description: 错误码 enum: - PARAMETER_ILLEGAL - SYSTEM_ERROR - PERMISSION_DENIED - ENTERPRISE_TITLE_EXISTS - ENTERPRISE_TITLE_NOT_EXISTS - ENTERPRISE_TITLE_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceEnterpriseexctrlEmployertitleModifyModel: properties: account_id: description: 企业共同账户id example: "2088000194958956" type: string address: description: 详细地址 example: '***省***市****区' type: string agreement_no: description: 授权签约协议号 example: "20215425001181407500" type: string bank_account: description: 开户行账号 example: 622000******** type: string bank_name: description: 开户行 example: 招商银行 type: string enterprise_id: description: 企业id example: "2088123412341234" type: string tax_register_no: description: 税号 example: 9133*********5852F type: string telephone: description: 电话 example: 0739-56***** type: string title_id: description: 抬头ID example: '****' type: string title_name: description: 企业抬头名称 example: '*****有限公司' type: string type: object AlipayEbppInvoiceEnterpriseexctrlEmployertitleModifyResponseModel: properties: code: description: "返回码\t10000-成功\t其他都是失败" example: "10000" type: string msg: description: 返回信息 example: 成功 type: string success: description: 是否成功 example: true type: boolean title_id: description: 抬头ID example: "2021090100152710300000000731" type: string type: object AlipayEbppInvoiceEnterpriseexctrlEmployertitleQueryErrorResponseModel: properties: code: description: 错误码 enum: - PERMISSION_DENIED - SYSTEM_ERROR - PARAMETER_ILLEGAL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceEnterpriseexctrlEmployertitleQueryResponseModel: properties: code: description: "返回码\t10000-成功\t其他都是失败" example: "10000" type: string msg: description: 返回消息 example: 成功 type: string title_info: $ref: '#/components/schemas/EnterpriseTitleInfo' type: object AlipayEbppInvoiceExpenseProgressSyncErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceExpenseProgressSyncModel: properties: apply_id: description: 同步申请id,每次发起同步时生成,isv每次请求需要保证唯一 example: BxpO0dtPbcLLpwD8h5H47ehQXkBdI type: string business_time: description: 报销状态变更执行时间 example: 2017-08-14 10:10:00 type: string expense_detail_url: description: "报销详情地址,提供用户通过发票管家查看报销进度的地址\r\t如果报销企业入驻发票管家时需要isv传入报销详情地址,则\ 必须提供" example: http://www.baidu.com type: string expense_order_no: description: 报销单据号 example: "123" type: string expense_tax_no: description: 报销企业税号 example: "123456" type: string invoice_code: description: 发票代码 example: "1234567890" type: string invoice_no: description: 发票号码 example: "12345678" type: string memo: description: 备注 example: 财务已打款 type: string open_id: description: open_id,支付宝用户id example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string status: description: "报销操作。枚举值如下:\t*EXPENSE_APPLY:用户已提交申请。*EXPENSE_APPROVAL_PASS:\ 报销审核通过。\t*EXPENSE_FINISHED:报销完结。\t*EXPENSE_CANCEL:报销撤回。" example: EXPENSE_APPLY type: string user_id: description: 发票归属用户 id,用户在支付宝的唯一标识,以 2088 开头的 16 位纯数字组成。 example: "20880000000000000" type: string type: object AlipayEbppInvoiceExpenseProgressSyncResponseModel: type: object AlipayEbppInvoiceExpensecomsueOutsourceNotifyErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - PERMISSION_DENIED - WORK_NO_NOT_FIND - QUOTA_DEAL_ERROR - PLATFORM_ILLEGAL - EMPLOYEE_NO_NOT_FIND type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceExpensecomsueOutsourceNotifyModel: properties: account_id: description: 企业共同账户id example: "2088000194958956" type: string agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string amount: description: 消费金额 example: 200 type: integer deal_time: description: 交易发生时间 example: 2021-01-01 12:00:00 type: string employee_id: description: 员工id example: "2088210888827370" type: string employee_id_type: description: 员工账号类型 example: 0 type: integer employee_open_id: description: 员工开放id example: abcdxxxx type: string enterprise_id: description: 企业id example: "2088000194958956" type: string extend: description: 拓展参数 example: "{\\\"adcode\\\":\\\"310000\\\"}" type: string is_off_set: description: 交易类型 example: 0 type: integer out_source_id: description: 外部交易支付单号 example: TN00000000000001 type: string platform: description: 外部平台编码 example: DAO_AN type: string relate_no: description: 外部交易退款单号 example: "200222222222" type: string standard_id: description: 费控规则ID example: "2021082700152601730000003677" type: string type: object AlipayEbppInvoiceExpensecomsueOutsourceNotifyResponseModel: properties: success: description: 是否成功 example: true type: boolean type: object AlipayEbppInvoiceExpensecontrolAggregationCreateErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceExpensecontrolAggregationCreateModel: properties: account_id: description: 企业ID example: "2088000194958956" type: string aggregation_name: description: "聚合关系名称\t特殊说明:敏感词校验" example: 测试聚合关系 type: string agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string standard_id_list: description: 费控规则ID列表 example: "[\"2021082700152601730000003677\",\"2021082700152601730000003679\"\ ]" items: type: string type: array type: object AlipayEbppInvoiceExpensecontrolAggregationCreateResponseModel: properties: aggregation_id: description: 费控聚合关系ID example: "2021082700152602730000003677" type: string type: object AlipayEbppInvoiceExpensecontrolEmployeequotaCreateErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED - QUOTA_EXISTS - NO_RULE_AVAILABLE - REQUEST_REPEAT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceExpensecontrolEmployeequotaCreateModel: properties: account_id: description: 共同账号ID example: "2088000194958956" type: string agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string effective_end_date: description: 余额失效时间(默认有效期100年) example: 2021-10-01 00:00:00 type: string effective_start_date: description: 余额生效时间(默认当前时间) example: 2021-01-01 00:00:00 type: string outer_source_id: description: 外部操作幂等ID(接入方接口调用幂等控制ID) example: TN00000000000001 type: string owner_id: description: "切换open_id前请使用:余额所属者ID\towner_type为员工时为员工支付宝ID" example: "2088210888827370" type: string owner_open_id: description: 切换open_id后请使用:余额所属者ID owner_type为员工时为员工open_id example: abcdxxxx type: string owner_type: description: "余额所属者类型\tEMPLOYEE: 员工" example: EMPLOYEE type: string platform: description: 外部平台编码(通常为接入方大写英文缩写) example: RJ type: string quota_model: description: 余额同步模式,默认 DEFAULT_STANDARD example: DEFAULT_STANDARD type: string quota_value: description: "余额,以(分)为单位\t特殊说明:余额不超过100000元" example: "10" type: string type: object AlipayEbppInvoiceExpensecontrolEmployeequotaCreateResponseModel: properties: quota_id: description: 新增的余额ID example: "2021062800152601350000001468" type: string type: object AlipayEbppInvoiceExpensecontrolIssuebatchCancelErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - ISSUE_BATCH_IS_INVALID - ISSUE_BATCH_REVOKING - ISSUE_BATCH_IN_PROGRESS - PERMISSION_DENIED - FREQUENT_OPERATION_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceExpensecontrolIssuebatchCancelModel: properties: account_id: description: 共同账户id example: "2088000194958956" type: string agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string enterprise_id: description: 企业ID example: "2088000194958956" type: string institution_id: description: 制度id example: "2022070500152608330000012007" type: string issue_batch_id: description: 发放批次id example: "2022062800152622440000009966" type: string type: object AlipayEbppInvoiceExpensecontrolIssuebatchCancelResponseModel: properties: result: description: 是否成功 example: true type: boolean type: object AlipayEbppInvoiceExpensecontrolIssuebatchCreateErrorResponseModel: properties: code: 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 - FREQUENT_OPERATION_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceExpensecontrolIssuebatchCreateModel: properties: account_id: description: 共同账户id example: "2088000194958956" type: string agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string batch_no: description: 发放批次号,用于幂等校验本次发放 example: "2022062800152622440000009966" type: string effective_end_date: description: 额度有效结束时间 example: 2021-01-01 12:00:00 type: string effective_start_date: description: 额度有效起始时间 example: 2021-01-01 12:00:00 type: string enterprise_id: description: 企业ID example: "2088000194958956" type: string institution_id: description: 制度id example: "2022052000152618690000000005" type: string issue_desc: description: 发放说明 example: 发放餐补 type: string issue_name: description: 发放名称 example: 发放餐补 type: string issue_target_info_list: description: 员工发放信息列表 items: $ref: '#/components/schemas/IssueTargetInfoContent' type: array quota_type: description: 额度类型 example: COUPON type: string share_mode: description: 是否可转赠 example: "1" type: string type: object AlipayEbppInvoiceExpensecontrolIssuebatchCreateResponseModel: properties: issue_batch_id: description: 发放批次id example: "2022070500152622690000017754" type: string issue_quota_check_failed_list: description: 校验失败的数据 items: $ref: '#/components/schemas/IssueQuotaCheckInfo' type: array type: object AlipayEbppInvoiceExpensecontrolQuotaCreateErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED - QUOTA_EXISTS - REQUEST_REPEAT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceExpensecontrolQuotaCreateModel: properties: account_id: description: 共同账号id example: "2088000194958956" type: string agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string effective_end_date: description: 额度失效时间(格式:yyyy-MM-dd HH:mm:ss) example: 2021-10-01 00:00:00 type: string effective_start_date: description: 额度生效时间(格式:yyyy-MM-dd HH:mm:ss) example: 2021-01-01 00:00:00 type: string enterprise_id: description: 企业ID example: "2088000194958956" type: string outer_source_id: description: 外部操作幂等ID(接入方接口调用幂等控制ID) example: TN00000000000001 type: string owner_id: description: 额度所属者ID(未切换open_id请使用此字段): example: "2088210888827370" type: string owner_open_id: description: 额度所属者ID(切换open_id后请使用此字段): example: "2088210888827370" type: string owner_type: description: 额度所属者类型 example: EMPLOYEE type: string platform: description: 外部平台编码(通常为接入方大写英文缩写) example: RJ type: string quota_type: description: 创建额度类型 example: COUPON type: string quota_value: description: 额度值,以(分)为单位 example: "50" type: string share_mode: description: "0:不可转赠\t1:可以转增" example: "0" type: string target_id: description: 额度维度ID example: MEAL type: string target_type: description: "额度维度\t枚举值:\tEXPENSE_TYPE(费用类型维度),\tRULE_GROUP_AGGREGATION(\ 规则聚合维度),\tINSTITUTION(制度维度)" example: EXPENSE_TYPE type: string type: object AlipayEbppInvoiceExpensecontrolQuotaCreateResponseModel: properties: quota_id: description: 新增的额度ID example: "1234" type: string type: object AlipayEbppInvoiceExpensecontrolQuotaModifyErrorResponseModel: properties: code: 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 - COUPON_MODIFY_SHARE_MODE_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceExpensecontrolQuotaModifyModel: properties: account_id: description: 企业共同账户ID example: "2088000194958956" type: string action: description: 变更模式 example: ADD type: string agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string amount: description: 变更的金额/余额,以(分)为单位,当变更的资产类型为次卡时,当前的单位为次 example: "10" type: string enterprise_id: description: 企业ID example: "2088000194958956" type: string outer_source_id: description: 外部操作幂等ID(接入方接口调用幂等控制ID) example: TN00000000000001 type: string platform: description: 外部平台编码 example: RJ type: string quota_id: description: 额度ID example: "2021062800152601350000001468" type: string share_mode: description: 是否可转赠,1表示可转赠,0表示不可转赠 example: "1" type: string type: object AlipayEbppInvoiceExpensecontrolQuotaModifyResponseModel: properties: success: description: 是否成功 example: true type: boolean type: object AlipayEbppInvoiceExpensecontrolQuotaQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceExpensecontrolQuotaQueryModel: properties: account_id: description: 企业共同账户ID example: "2088000194958956" type: string agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string enterprise_id: description: 企业id example: "2088000194958956" type: string owner_id: description: 额度所属者ID example: "2088210888827370" type: string owner_open_id: description: 额度所属者开放ID example: abcdxxxx type: string owner_type: description: 额度所属者类型 example: EMPLOYEE type: string page_num: description: 页码 example: 1 type: integer page_size: description: 每页条数 example: 20 type: integer quota_id_list: description: 额度ID列表 example: "[\"2021062xxx\"]" items: type: string type: array quota_type: description: 额度类型 example: COUPON type: string target_id: description: 额度维度ID example: MEAL type: string target_type: description: 额度维度 example: EXPENSE_TYPE type: string type: object AlipayEbppInvoiceExpensecontrolQuotaQueryResponseModel: properties: expense_quota_info_list: description: 额度列表 items: $ref: '#/components/schemas/ExpenseQuotaInfo' type: array page_num: description: 当前页数 example: 1 type: integer page_size: description: 当前记录数 example: 20 type: integer total_page_count: description: 总页数 example: 5 type: integer type: object AlipayEbppInvoiceExpenserulesEmployeeQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceExpenserulesEmployeeQueryResponseModel: properties: employee_list: description: 切换open_id前请使用此字段:员工列表 example: "[\"2088402331504664\",\"2088402331504664\",\"2088402331504664\"\ ]" items: type: string type: array employee_open_id_list: description: 切换open_id后请使用此字段:员工open_id列表 example: "[\"abcdxxxx\"]" items: type: string type: array page_num: description: 当前页数 example: 1 type: integer page_size: description: 当前记录数 example: 20 type: integer total_page_count: description: 总页数 example: 100 type: integer type: object AlipayEbppInvoiceExpenserulesEmployeerulesQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - PERMISSION_DENIED - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceExpenserulesEmployeerulesQueryResponseModel: properties: employee_rules: description: 员工已绑定费控规则列表 items: $ref: '#/components/schemas/ExpenseCtrlEmployeeRuleInfo' type: array page_num: description: 客户端输入的页码 example: 1 type: integer page_size: description: 客户端输入的每页行数 example: 20 type: integer total_count: description: 查询到的实例总数 example: 100 type: integer type: object AlipayEbppInvoiceExpenserulesGroupemployeeModifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - GROUP_NOT_EXIST - PERMISSION_DENIED - EMPLOYEE_MAX_RULE_COUNT - INVALIDATE_EMPLOYEE_FAIL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceExpenserulesGroupemployeeModifyModel: properties: account_id: description: 企业共同账户id example: "2088000194958956" type: string add_employee_list: description: "未切换 open_id 时请使用此字段:\t需要添加的员工UID列表\t特殊说明:一次最多50个" example: "[\"2088402266061144\",\"2088402266063146\"]" items: type: string type: array add_employee_open_id_list: description: "切换 open_id 后请使用此字段:\t需要添加的open_id/企业码员工ID列表 特殊说明:一次最多50个" example: "[\"abcdxxx\"]" items: type: string type: array agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string enterprise_id: description: 企业码企业id example: "2088000194958956" type: string group_id_list: description: 费控规则ID列表 example: "[\"2021062800152601350000001466\"]" items: type: string type: array remove_employee_list: description: "未切换 open_id 时请使用此字段:\t需要移除的员工UID列表\t特殊说明:一次最多50个" example: "[\"2088402266062862\",\"2088402266060390\"]" items: type: string type: array remove_employee_open_id_list: description: "切换 open_id 后请使用此字段:\t需要移除的open_id/企业码员工ID列表 特殊说明:一次最多50个" example: "[\"abcdxxx\"]" items: type: string type: array type: object AlipayEbppInvoiceExpenserulesGroupemployeeModifyResponseModel: properties: success: description: 是否成功 example: true type: boolean type: object AlipayEbppInvoiceExpenserulesProjectemployeeModifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PROJECT_NOT_EXIST - EMPLOYEE_RULE_CONFLICT - PERMISSION_DENIED - EMPLOYEE_MAX_RULE_COUNT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceExpenserulesProjectemployeeModifyModel: properties: account_id: description: 共同账户ID example: "2088000194958956" type: string add_employee_list: description: "切换open_id前使用此字段:\t需要添加的员工UID列表\t约束:一次最多50个" example: "[\"2088402266061144\",\"2088402266063146\"]" items: type: string type: array add_employee_open_id_list: description: "切换open_id后使用此字段:\t需要添加的员工open_id列表\t约束:一次最多50个" example: "[\"abcdxxxx\"]" items: type: string type: array agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string project_id: description: 项目ID example: "2021040900152700950000000862" type: string remove_employee_list: description: "切换open_id前使用此字段:\t需要移除的员工UID列表\t约束:一次最多50个" example: "[\"2088402266062862\",\"2088402266060390\"]" items: type: string type: array remove_employee_open_id_list: description: 切换open_id后前使用此字段: 需要移除的员工open_id列表 约束:一次最多50个 example: "[\"abcdxxxx\"]" items: type: string type: array type: object AlipayEbppInvoiceExpenserulesProjectemployeeModifyResponseModel: properties: success: description: 是否成功 example: true type: boolean type: object AlipayEbppInvoiceExpenserulesProjectinfoModifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED - PROJECT_NOT_EXIST - PROJECT_NAME_EXIST_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceExpenserulesProjectinfoModifyModel: properties: account_id: description: 企业ID example: "2088000166192438" type: string agreement_no: description: 授权签约协议号 example: "20215425123412341234" type: string effective_end_date: description: "有效期截止(yyyy-MM-dd HH:mm:ss)\t特殊说明:\t1)与起始时间必须同时传,且大于起始时间\t\ 2)不传则默认不修改" example: 2021-04-30 23:59:59 type: string effective_start_date: description: "有效期起始(yyyy-MM-dd HH:mm:ss)\t特殊说明:\t1)与截止时间必须同时传,且小于截止时间\t\ 2)不传入则默认不修改" example: 2020-04-01 00:00:00 type: string project_id: description: 项目ID example: "2021041500152700430000004790" type: string project_name: description: "项目名\t特殊说明:不传入则默认不修改" example: 修改项目名 type: string type: object AlipayEbppInvoiceExpenserulesProjectinfoModifyResponseModel: properties: success: description: 是否成功 example: true type: boolean type: object AlipayEbppInvoiceExpenserulesProjectruleCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceExpenserulesProjectruleCreateModel: properties: account_id: description: 共同账户id example: "2088000194958956" type: string agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string effective_end_date: description: 有效期截止(yyyy-MM-dd HH:mm:ss,必须大于起始时间) example: 2021-03-01 00:00:00 type: string effective_start_date: description: 有效期起始(yyyy-MM-dd HH:mm:ss,必须小于截止时间) example: 2021-03-01 00:00:00 type: string employee_list: description: "切换open_id前使用此字段:员工支付宝ID列表\t特殊说明:单次传入的最大员工数为50,后续通过修改项目的员工列\ 表接口进行员工调整" example: "[\"2088123412341234\",\"2088123412342234\"]" items: type: string type: array employee_open_id_list: description: 切换open_id后使用此字段:员工open_id列表 特殊说明:单次传入的最大员工数为50,后续通过修改项目的员工列表接口进行员工调整 example: "[\"abcdxxxx\"]" items: type: string type: array expense_ctrl_rule_info_group_list: description: 费控规则列表 items: $ref: '#/components/schemas/ExpenseCtrRuleGroupInfo' type: array project_name: description: "项目名称\t约束:\t1)敏感词校验\t2)不能重复" example: 项目 type: string type: object AlipayEbppInvoiceExpenserulesProjectruleCreateResponseModel: properties: project_id: description: 项目ID example: "2021070700152700030000000681" type: string type: object AlipayEbppInvoiceExpenserulesProjectruleQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED - PROJECT_NOT_EXIST_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceExpenserulesProjectruleQueryResponseModel: properties: page_num: description: 当前页数 example: "1" type: string page_size: description: 当前记录数 example: "10" type: string project_rule_info_list: description: 项目规则列表 items: $ref: '#/components/schemas/ProjectRuleInfo' type: array total_count: description: 总记录数 example: "50" type: string total_page_count: description: 总页数 example: "1" type: string type: object AlipayEbppInvoiceExpenserulesProjectrulesModifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED - PROJECT_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceExpenserulesProjectrulesModifyModel: properties: account_id: description: 企业ID example: "2088000194958956" type: string action: description: "修改操作\t枚举值:MODIFY_RULE(修改费控条件),仅支持MODIFY_RULE" example: MODIFY_RULE type: string agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string expense_ctrl_rule_info_group_list: description: 费控规则列表 items: $ref: '#/components/schemas/ExpenseCtrRuleGroupInfo' type: array project_id: description: 项目ID example: "2021041300152700950000001050" type: string type: object AlipayEbppInvoiceExpenserulesProjectrulesModifyResponseModel: properties: success: description: 是否成功 example: "true" type: string type: object AlipayEbppInvoiceExpenserulesSceneruleCreateErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED - STANDARD_NAME_EXIST_ERROR - EMPLOYEE_CNT_LIMIT_ERROR - EXPENSE_RULE_CREATE_FAIL - EMPLOYEE_MAX_RULE_COUNT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceExpenserulesSceneruleCreateModel: properties: account_id: description: 共同账号ID example: "2088000194958956" type: string agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string effective_end_date: description: 有效期截止 example: 2021-08-27 00:00:00 type: string effective_start_date: description: 有效期起始 example: 2021-08-26 00:00:00 type: string employee_list: description: "切换open_id前请使用:员工支付宝uid列表\t特殊说明:单次传入的最大员工数为50,后续通过修改费控规则员工接\ 口进行员工调整" example: "[\"2088210888827370\"]" items: type: string type: array employee_open_id_list: description: 切换open_id后请使用:员工open_id/企业码员工ID列表 特殊说明:单次传入的最大员工数为50,后续通过修改费控规则员工接口进行员工调整 example: "[\"abcdxxxx\"]" items: type: string type: array enterprise_id: description: 企业码企业id example: "2088000194958956" type: string expense_ctrl_rule_info_list: 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' type: array expense_type: description: 费用类型 example: MEAL type: string payment_policy: description: "当笔消费金额大于规则可用余额时,用于控制支付策略,该字段缺省时采取因公账户和个人账户组合支付策略, 枚举值:PERSONAL(\ 全部个人账户支付), COMBINATION(因公账户和个人账户组合支付)" example: PERSONAL type: string scene_type: description: 因公场景 example: OVERTIME type: string standard_desc: description: "费控规则说明\t特殊说明:敏感词校验" example: 福利餐费控规则说明 type: string standard_name: description: "费控规则名称\t特殊说明:\t1)敏感词校验\t2)不能重复,若需要重复联系支持人员定向放开" example: 福利餐费控规则 type: string type: object AlipayEbppInvoiceExpenserulesSceneruleCreateResponseModel: properties: standard_id: description: 费控规则ID example: "2021091000152601200000006167" type: string type: object AlipayEbppInvoiceExpenserulesSceneruleModifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED - STANDARD_EXIST_ERROR - STANDARD_NAME_EXIST_ERROR - EXPENSE_RULE_CREATE_FAIL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceExpenserulesSceneruleModifyModel: properties: account_id: description: 企业ID example: "2088000194958956" type: string action: description: "修改操作\t枚举值:\tADD_RULE(新增费控条件),DELETE_RULE(删除费控条件),MODIFY_RULE(\ 修改费控条件),MODIFY_STANDARD(修改费控规则基本信息)" example: ADD_RULE type: string agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string effective_end_date: description: "有效期截止\t特殊说明:修改费控规则基本信息时必传" example: 2021-08-27 00:00:00 type: string effective_start_date: description: "有效期起始\t特殊说明:修改费控规则基本信息时必传" example: 2021-08-26 00:00:00 type: string enterprise_id: description: 企业码企业id example: "2088000194958956" type: string expense_ctrl_rule_info_list: description: 费控规则条件列表 特殊说明:新增费控条件/修改费控条件/删除费控条件操作时必填 items: $ref: '#/components/schemas/ExpenseCtrRuleInfo' type: array payment_policy: description: "当笔消费金额大于规则可用余额时,用于控制支付策略,该字段缺省时采取因公账户和个人账户组合支付策略, 枚举值:PERSONAL(\ 全部个人账户支付), COMBINATION(因公账户和个人账户组合支付)" example: PERSONAL type: string standard_desc: description: "费控规则说明\t特殊说明:\t1)敏感词校验\t2)修改费控规则基本信息时必传" example: 费控规则说明 type: string standard_id: description: 费控规则ID example: "2021062800152601350000001466" type: string standard_name: description: "费控规则名称\t特殊说明:\t1)敏感词校验\t2)修改费控规则基本信息时必传\t3)不能重复,若需要重复联系支持人\ 员定向放开" example: 费控规则名称 type: string type: object AlipayEbppInvoiceExpenserulesSceneruleModifyResponseModel: properties: success: description: 是否成功 example: true type: boolean type: object AlipayEbppInvoiceExpenserulesSceneruleQueryErrorResponseModel: properties: code: description: 错误码 enum: - PARAMETER_ILLEGAL - SYSTEM_ERROR - PERMISSION_DENIED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceExpenserulesSceneruleQueryResponseModel: properties: page_num: description: 当前页数 example: 1 type: integer page_size: description: 当前记录数 example: 10 type: integer standard_rule_info_list: description: 费控规则列表 items: $ref: '#/components/schemas/StandardRuleInfo' type: array total_page_count: description: 总页数 example: 10 type: integer type: object AlipayEbppInvoiceExpensesceneMerchantQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED - PARAMETER_ILLEGAL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceExpensesceneMerchantQueryResponseModel: properties: expense_merchant_info_list: description: 商户信息 items: $ref: '#/components/schemas/ExpenseMerchantInfo' type: array page_num: description: 当前页数 example: 1 type: integer page_size: description: 当前记录数 example: 20 type: integer total_page_count: description: 总页数 example: 3 type: integer type: object AlipayEbppInvoiceFileOutputQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVOICE_NOT_EXIST - INVOICE_QUERY_DENY - SYSTEM_ERROR - PARAMETER_ILLEGAL - PDF_NOT_EXIST - QUERY_TAX_NO_NOT_EQUAL_CERTIFY_NO type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceFileOutputQueryResponseModel: properties: file_type: description: 发票文件类型pdf或ofd example: pdf type: string invoice_file_content: description: "发票文件内容,需要先base64解码,获取原始byte[]类型文件流" example: SEWHBFR2GKMBJNY52JBM56N type: string type: object AlipayEbppInvoiceInfoSendErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - MERCHANT_NOT_SUPPORT - BIZ_ERROR - RECORD_ALREADY_EXIST - INVOICE_INFOSEC_CHECK_FAIL - COLLECTION_NON_USER - INVOICE_IS_NOT_EXPIRED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceInfoSendModel: properties: invoice_info_list: description: 发票信息列表 items: $ref: '#/components/schemas/InvoiceSendOpenModel' type: array m_short_name: description: 开票商户品牌简称,与商户入驻时的品牌简称保持一致。 example: XSD type: string sub_m_short_name: description: 开票商户门店简称,与商户入驻时的门店简称保持一致。 example: XSD_HL type: string type: object AlipayEbppInvoiceInfoSendResponseModel: properties: url: description: 发票访问地址,同步红票的情况下不返回该字段,同步蓝票的情况下如果同步单张发票,返回发票详情链接地址,如果同步的是多张发票,返回发票列表地址 example: alipays://platformapi/startapp?appId=20000920&url=%2Fwww%2Flist.htm%3Ffrom%3Doffline type: string type: object AlipayEbppInvoiceInstitutionCreateErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED - INSTITUTION_CREATE_FAIL - ENTERPRISE_SYNC_EXTERIOR_EXCEPTION - RECORD_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceInstitutionCreateModel: properties: account_id: description: 企业共同账户id example: "2088000194958956" type: string adapter_type: description: 制度适配范围 example: EMPLOYEE_ALL type: string agreement_no: description: 授权签约协议号 example: "20225415889003553" type: string consult_mode: description: 费控咨询模式,默认为0。 example: "0" type: string effective_end_date: description: 制度生效结束时间 example: 2022-09-30 23:59:59 type: string effective_start_date: description: 制度生效起始时间 example: 2022-09-10 00:00:00 type: string enterprise_id: description: 企业id example: "2088123412341234" type: string expense_type: description: 费用类型 example: MEAL type: string institution_desc: description: 制度描述 example: 餐补制度 type: string institution_name: description: 制度名称 example: 费用制度 type: string issue_rule_info_list: description: 发放规则列表 items: $ref: '#/components/schemas/IssueRuleInfo' type: array outer_source_id: description: 外部唯一标识,可用于防止重复创建 example: 0b26c12b16900047742372557ee431 type: string owner_id_list: description: 适配id列表 example: "[\"2088402266061144\",\"2088402266063146\"]" items: type: string type: array owner_open_id_list: description: 适配开放id列表 example: "[\"abcdxxxx\"]" items: type: string type: array owner_type: description: 适配id类型 example: ENTERPRISE_PAY_UID type: string scene_type: description: 因公场景 example: OVERTIME type: string standard_info_list: description: 使用规则列表 items: $ref: '#/components/schemas/StandardInfo' type: array type: object AlipayEbppInvoiceInstitutionCreateResponseModel: properties: institution_id: description: 制度id example: "2022031000152617000000000001" type: string issue_rule_id_info_list: description: 发放规则id列表 items: $ref: '#/components/schemas/IssueRuleIdInfo' type: array standard_id_info_list: description: 使用规则id列表 items: $ref: '#/components/schemas/StandardIdInfo' type: array type: object AlipayEbppInvoiceInstitutionDeleteErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED - INSTITUTION_NOT_EXIST_ERROR - INSTITUTION_DELETE_FAIL - ENTERPRISE_SYNC_EXTERIOR_EXCEPTION type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceInstitutionDeleteResponseModel: properties: result: description: 删除结果是否成功 example: true type: boolean type: object AlipayEbppInvoiceInstitutionDetailinfoQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED - INSTITUTION_NOT_EXIST_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceInstitutionDetailinfoQueryResponseModel: properties: adapter_type: description: 若适用范围为EMPLOYEE_ALL,则表示制度对企业下全员生效,owner_id_list不返回;若适配范围为EMPLOYEE_SELECT,owner_id_list返回员工对应的id信息,返回的id类型通过owner_type区分;若适配范围为EMPLOYEE_DEPARTMENT,则表示对指定的部门生效,返回owner_id_list为部门id列表 example: EMPLOYEE_ALL type: string consult_mode: description: 费控咨询模式 example: "0" type: string effective: description: 制度启用停用状态 example: "0" type: string effective_end_date: description: 制度生效结束时间 example: 2001-01-01 23:59:59 type: string effective_start_date: description: 制度生效起始时间 example: 2000-01-01 00:00:00 type: string expense_type: description: 费用类型 example: MEAL type: string institution_desc: description: 制度描述 example: 工作餐制度 type: string institution_id: description: 制度id example: "2023042600152617860000076700" type: string institution_name: description: 制度名称 example: 餐补制度 type: string issue_rule_info_list: description: 发放规则信息列表 items: $ref: '#/components/schemas/IssueRuleInfo' type: array outer_source_id: description: 外部唯一标识 example: 0b249cd9169693047263955280052c type: string owner_id_list: description: 适配id列表 example: "[\"2288078000164693\"]" items: type: string type: array owner_open_id_list: description: 适配开放id列表 example: "[\"abcdxxxx\"]" items: type: string type: array scene_type: description: 因公场景 example: OVERTIME type: string standard_info_detail_list: description: 使用规则列表 items: $ref: '#/components/schemas/StandardInfo' type: array standard_info_list: $ref: '#/components/schemas/StandardInfo' type: object AlipayEbppInvoiceInstitutionExpenseruleCreateErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED - INSTITUTION_NOT_EXIST_ERROR - BIND_INVOICE_RULE_FAILED - RECORD_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceInstitutionExpenseruleCreateModel: properties: account_id: description: 企业共同账户id example: "2088000194958956" type: string agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string asset_share_source_info: $ref: '#/components/schemas/AssetShareSourceInfo' consume_mode: description: 消费模式 example: DEFAULT type: string enterprise_id: description: 企业码id example: "2088000194958956" type: string expense_ctrl_rule_info_list: $ref: '#/components/schemas/ExpenseCtrRuleInfo' expense_type_sub_category: description: 费用类型子类 example: TAKE_AWAY type: string institution_id: description: 制度id example: "2022051900152617290000002725" type: string open_rule_id: description: 开票规则id example: "2022070600152721390000011371" type: string outer_source_id: description: 外部唯一标识,填写该字段可用于创建幂等,防止重复创建 example: 06026e3e160000550145934323718 type: string payment_policy: description: 支付策略 example: COMBINATION type: string standard_condition_info_list: description: 使用规则因子列表 items: $ref: '#/components/schemas/StandardConditionInfo' type: array standard_desc: description: 使用规则描述 example: 福利餐说明 type: string standard_name: description: 费控规则名称 example: 福利餐费控规则 type: string type: object AlipayEbppInvoiceInstitutionExpenseruleCreateResponseModel: properties: standard_id: description: 使用规则id example: "2022070600152617780000000001" type: string type: object AlipayEbppInvoiceInstitutionExpenseruleDeleteErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED - INSTITUTION_NOT_EXIST_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceInstitutionExpenseruleDeleteModel: properties: account_id: description: 企业共同账户id example: "2088000194958956" type: string agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string enterprise_id: description: 企业id example: "2088000194958956" type: string institution_id: description: 制度id example: "2022070600152617780000000001" type: string standard_id_list: description: 删除的使用规则id列表 example: "[\"2021062800152601350000001468\"]" items: type: string type: array type: object AlipayEbppInvoiceInstitutionExpenseruleDeleteResponseModel: properties: result: description: 删除是否成功 example: true type: boolean type: object AlipayEbppInvoiceInstitutionExpenseruleModifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED - INSTITUTION_NOT_EXIST_ERROR - EXPENSE_RULE_MODIFY_FAIL - BIND_INVOICE_RULE_FAILED - STANDARD_NOT_EXIST_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceInstitutionExpenseruleModifyModel: properties: account_id: description: 企业共同账户id example: "2088000194958956" type: string action: description: 修改使用规则 example: MODIFY_BASIC_INFO type: string agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string asset_share_source_info: $ref: '#/components/schemas/AssetShareSourceInfo' consume_mode: description: 该使用规则支持的资产消费模式,不填写则为默认模式,默认模式下有余额时使用余额,没有余额则使用规则中的限额,点券模式为只能使用点券,点券+余额模式为可以使用点券和余额。 example: DEFAULT type: string enterprise_id: description: 企业id example: "2088000194958956" type: string expense_ctrl_rule_info_list: description: 使用规则条件列表(已废弃) items: $ref: '#/components/schemas/ExpenseCtrRuleInfo' type: array institution_id: description: 制度id example: "2022070600152617780000000001" type: string open_rule_id: description: 开票规则id example: "2022070600152608780000000001" type: string payment_policy: description: 当笔消费金额大于规则可用余额时,用于控制支付策略 example: COMBINATION type: string standard_condition_info_list: description: 规则条件列表 items: $ref: '#/components/schemas/StandardConditionInfo' type: array standard_desc: description: 规则描述 example: 当前规则为午餐餐补规则 type: string standard_id: description: 使用规则id example: "2022070600152621780000000001" type: string standard_name: description: 规则名称 example: 午餐规则 type: string type: object AlipayEbppInvoiceInstitutionExpenseruleModifyResponseModel: properties: result: description: 编辑结果是否成功 example: true type: boolean type: object AlipayEbppInvoiceInstitutionModifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED - INSTITUTION_NOT_EXIST_ERROR - INSTITUTION_MODIFY_FAIL - MODIFY_CONSULT_FAILED_ISSUE - MODIFY_CONSULT_FAILED_CONSUME type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceInstitutionModifyModel: properties: account_id: description: 企业共同账户id example: "2088000194958956" type: string agreement_no: description: 授权签约协议号 example: "20215425001181407500" type: string consult_mode: description: "费控咨询模式:\t0-支付宝内部计算规则可用金额\t1-咨询外部服务商规则可用金额" example: "0" type: string effective: description: 制度是否启用 example: "0" type: string effective_end_date: description: 制度生效结束时间(可空),最小粒度为天,最早是当日 example: 2022-09-30 23:59:59 type: string effective_start_date: description: 制度生效起始时间 example: 2022-09-10 00:00:00 type: string enterprise_id: description: 企业id example: "2088123412341234" type: string institution_desc: description: 制度描述 example: 餐补制度 type: string institution_id: description: 制度id example: "2022031000152617000000000001" type: string institution_name: description: 制度名称 example: 费用制度 type: string type: object AlipayEbppInvoiceInstitutionModifyResponseModel: properties: result: description: 修改是否成功 example: true type: boolean type: object AlipayEbppInvoiceInstitutionPageinfoQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceInstitutionPageinfoQueryResponseModel: properties: institution_basic_info_list: description: 制度基本信息列表 items: $ref: '#/components/schemas/InstitutionBasicInfo' type: array page_num: description: 页码 example: "10" type: string page_size: description: 页大小 example: 10 type: integer total_page_count: description: 总页数 example: 10 type: integer type: object AlipayEbppInvoiceInstitutionScopeModifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceInstitutionScopeModifyModel: properties: account_id: description: 企业共同账户id example: "2088000194958956" type: string adapter_type: description: 制度适用范围类型 example: EMPLOYEE_SELECT type: string add_owner_id_list: description: 增加适配id列表 example: "[\"2088402266061144\",\"2088402266063146\"]" items: type: string type: array add_owner_open_id_list: description: 增加适配开放id列表 example: "[\"abcdxxxx\"]" items: type: string type: array agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string enterprise_id: description: 企业id example: "2088000194958956" type: string institution_id: description: 制度id example: "2022072800152617760000002797" type: string owner_type: description: 归属类型 example: ENTERPRISE_PAY_UID type: string remove_owner_id_list: description: 删除适配id列表 example: "[\"2088402266062862\",\"2088402266060390\"]" items: type: string type: array remove_owner_open_id_list: description: 删除适配开放id列表 example: "[\"abcdxxxx\"]" items: type: string type: array type: object AlipayEbppInvoiceInstitutionScopeModifyResponseModel: properties: result: description: 操作是否成功 example: true type: boolean type: object AlipayEbppInvoiceInstitutionScopepageinfoQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED - INSTITUTION_NOT_EXIST_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceInstitutionScopepageinfoQueryResponseModel: properties: adapter_type: description: 制度适用范围类型 example: EMPLOYEE_ALL type: string onwer_open_id_list: description: 适配开放id列表 example: "[\"asdfxxxx\"]" items: type: string type: array owner_id_list: description: 适配id列表 example: "[\"2288078000164693\"]" items: type: string type: array page_num: description: 页码 example: 10 type: integer page_size: description: 页大小 example: 100 type: integer total_page_count: description: 总页数 example: 100 type: integer type: object AlipayEbppInvoiceIssueruleCreateErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED - SENSITIVE_CHECK_FAIL - RECORD_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceIssueruleCreateModel: properties: account_id: description: 共同账户id example: "2088000194958956" type: string agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string effective: description: "是否启用,\"0\"为停用,\"1\"为启用;\t如果target_type指定INSTITUTION,则与制度一致\ ,无需填写" example: "1" type: string effective_period: description: "生效周期,时间不限格式:\"{\\\"all\\\":true}\"" example: "{\\\"all\\\":true}" type: string enterprise_id: description: 企业ID example: "2088000194958956" type: string invalid_mode: description: 是否可累计:0(不可累计)、1(可累计),2(累计天数)、3(累计到指定日期)余额只允许可累计,按城市发放只允许不可累计,设置了生效周期只允许不可累计 example: 0 type: integer invalid_mode_value: description: 累计值(预留字段) example: 预留 type: string issue_amount_value: description: "发放金额,单位(元);\t按城市不同发放标准示例值:\"[{\\\"cities\\\":[\\\"321000\\\ \",\\\"321100\\\"],\\\"amount\\\":\\\"50\\\"},{\\\"cities\\\":[\\\"321200\\\ \",\\\"321300\\\"],\\\"amount\\\":\\\"150\\\"}]\"\t统一标准发放示例值:\"200\"" example: "200" type: string issue_end_date: description: "发放规则的截止时间\t如果target_type指定INSTITUTION,则使用制度有效期结束时间,无需填写" example: 2021-01-01 12:00:00 type: string issue_rule_name: description: 发放规则名称 example: 晚餐发放 type: string issue_start_date: description: "发放规则的开始时间\t如果target_type指定INSTITUTION,则使用制度有效期起始时间,无需填写" example: 2021-01-01 12:00:00 type: string issue_type: description: 发放类型 example: ISSUE_MONTH type: string outer_source_id: description: 填写该字段可用于创建幂等,防止重复创建 example: 0b26c12b16950007742372557ee431 type: string quota_type: description: 额度类型,枚举:COUPON(点券)、CAP(余额)、ISV(外算额度) example: COUPON type: string share_mode: description: 是否可转赠:0(不可转赠)、1(可转赠) example: 0 type: integer target_id: description: "发放规则关联的目标值\ttarget_type为制度时:制度id" example: "2022052000152618690000000005" type: string target_type: description: 发放规则关联的目标类型 example: INSTITUTION type: string type: object AlipayEbppInvoiceIssueruleCreateResponseModel: properties: issue_rule_id: description: 创建的发放规则ID example: "2022070500152622690000017754" type: string type: object AlipayEbppInvoiceIssueruleDeleteErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceIssueruleDeleteModel: properties: account_id: description: 共同账户id example: "2088000194958956" type: string agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string enterprise_id: description: 企业ID example: "2088000194958956" type: string issue_rule_id_list: description: 需要删除的发放规则id列表 example: "[\"2022052000152618690000000005\"]" items: type: string type: array target_id: description: 目标值id example: "2022052000152618690000000005" type: string target_type: description: 发放规则关联的目标类型 example: INSTITUTION type: string type: object AlipayEbppInvoiceIssueruleDeleteResponseModel: properties: result: description: 删除结果 example: true type: boolean type: object AlipayEbppInvoiceIssueruleModifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - PERMISSION_DENIED - SENSITIVE_CHECK_FAIL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceIssueruleModifyModel: properties: account_id: description: 共同账户id example: "2088000194958956" type: string action: description: "修改类型,枚举:\tMODIFY_BASIC_INFO(修改发放规则基本信息)" example: MODIFY_BASIC_INFO type: string agreement_no: description: 授权签约协议号 example: "20215425001112341234" type: string effective: description: 是否启用,"0"为停用,"1"为启用; example: "1" type: string effective_period: description: "生效周期(不传则不修改),不限:\"{\\\"all\\\":true}\"" example: "{\\\"all\\\":true}" type: string enterprise_id: description: 企业ID example: "2088000194958956" type: string invalid_mode: description: 是否可累计(不传则不修改)可选值:0(不可累计)、1(可累计),2(累计天数),3(累计到固定时间) example: 0 type: integer invalid_mode_value: description: 累计值 example: "10" type: string issue_amount_value: description: 发放金额(不传则不修改),单位(元) example: "200" type: string issue_end_date: description: 发放规则的截止时间 example: 2021-01-01 12:00:00 type: string issue_rule_id: description: 发放规则id example: "2022052000152618690000000005" type: string issue_rule_name: description: 发放规则名称(不传则不修改) example: 晚餐发放 type: string issue_start_date: description: 发放规则的开始时间 example: 2021-01-01 12:00:00 type: string issue_type: description: 发放类型 example: ISSUE_MONTH type: string quota_type: description: 额度类型 example: COUPON type: string share_mode: description: 是否可转赠(不传则不修改),可选值:0(不可转赠)、1(可转赠),默认为0,按城市发放不支持可转赠 example: 0 type: integer target_id: description: 发放规则关联的目标值 target_type为制度时:制度id example: "2022052000152618690000000005" type: string target_type: description: 发放规则关联的目标类型 example: INSTITUTION type: string type: object AlipayEbppInvoiceIssueruleModifyResponseModel: properties: result: description: 修改结果 example: true type: boolean type: object AlipayEbppInvoiceIsvtokenReimApplyErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceIsvtokenReimApplyModel: properties: isv_app_code: description: 报销软件app对应的isv app code,由支付宝进行分配。详情参见 "推"模式发票报销 example: ekuaibao_tinyapp type: string type: object AlipayEbppInvoiceIsvtokenReimApplyResponseModel: properties: isv_token: description: 支付宝分配给报销软件的授权token,当前设置有效时间为20分钟 example: 9232d035c6b547f8a2023a399b1e8fe2 type: string serial_no: description: 该次请求的唯一标志,当前设置有效时间为20分钟 example: 1730d660f1d type: string type: object AlipayEbppInvoiceListExpenseSyncErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceListExpenseSyncModel: properties: business_time: description: 报销进度变更时间 example: 2017-08-14 10:10:00 type: string expense_order_no: description: 商户报销单据号 example: "20180808128739874213" type: string expense_tax_no: description: 报销企业税号 example: 113071TRDX8RQU8 type: string invoice_element_list: description: 需要同步报销状态的发票列表 items: $ref: '#/components/schemas/InvoiceElementStatusSyncOpenModel' type: array memo: description: 报销审批备注 example: 财务已打款 type: string open_id: description: 用户uid example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string status: description: EXPENSE_APPLY:报销申请提交;EXPENSE_APPROVAL_PASS:报销申请审核通过;EXPENSE_FINISHED:报销申请完成;EXPENSE_CANCEL:报销申请撤回 example: EXPENSE_APPLY type: string user_id: description: 用户uid example: "2088002000321000" type: string type: object AlipayEbppInvoiceListExpenseSyncResponseModel: type: object AlipayEbppInvoiceMerchantEnterstatusQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - BIZ_ERROR - RECORD_NOT_EXIST - PERMISSION_DENIED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceMerchantEnterstatusQueryResponseModel: properties: status: description: 工单状态,审核中:AUDITING,验收中:ACCEPTING,成功:SUCCESS,失败:FAIL example: SUCCESS type: string type: object AlipayEbppInvoiceMerchantlistEnterApplyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceMerchantlistEnterApplyModel: properties: merchant_base: $ref: '#/components/schemas/MerchantBaseEnterOpenModel' sub_merchant_common_info: $ref: '#/components/schemas/SubMerchantCommonEnterOpenModel' sub_merchant_list: description: 商户门店列表信息,最多传入30个门店信息 items: $ref: '#/components/schemas/SubMerchantEnterOpenModel' type: array type: object AlipayEbppInvoiceMerchantlistEnterApplyResponseModel: properties: process_id: description: 工单流水号,支付开票PID模式当前不会返回流水号。 example: "1234567" type: string type: object AlipayEbppInvoiceOrderQueryErrorResponseModel: properties: code: description: 错误码 enum: - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceOrderQueryResponseModel: properties: invoice_element_model: $ref: '#/components/schemas/InvoiceElementModel' order_no: description: 开票申请时传入订单号(支持主单号、子单号),不限是否为支付宝体内交易单号 example: "20200520110046966071" type: string type: object AlipayEbppInvoiceSycnErrorResponseModel: properties: code: description: 错误码 enum: - PARAMETER_ILLEGAL - MERCHANT_NOT_SUPPORTED - SYSTEM_ERROR - RECORD_ALREADY_EXIST - COLLECTION_NON_USER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceSycnModel: properties: invoice_info: description: 同步发票信息模型 items: $ref: '#/components/schemas/InvoiceModelContent' type: array m_short_name: description: "商户的品牌名称简称,该字段需要接入前向发票管家申请,\r\tm_short_name+sub_m_short_name具\ 有唯一约束\r\t如:肯德基:KFC" example: KFC type: string sub_m_short_name: description: "支付宝为商户分配的商户门店简称,该字段需要接入前在发票管家申请\r\t如:肯德基-杭州西湖区文一西路店:KFC-HZ-XH001" example: KFC_HZ_XH001 type: string type: object AlipayEbppInvoiceSycnResponseModel: properties: url: description: "支付宝发票管家发票详情页链接地址\r\t如果同步的发票是多张时,此链接为当前用户的已开立发票列表地址" example: alipays://platformapi/startapp?appId=20000920&url=%2Fwww%2Fdetail.htm%3Ffrom%3Doffline%26code%3D201606210015200108000 type: string type: object AlipayEbppInvoiceSyncSimpleSendErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceSyncSimpleSendModel: properties: invoice_info: $ref: '#/components/schemas/InvoicePDFSynModel' m_short_name: description: 开票商户品牌简称,与商户入驻时的品牌简称保持一致。详情参见 电子发票 example: XSD type: string sub_m_short_name: description: 开票商户门店简称,与商户入驻时的门店简称保持一致。 example: XSD_HL type: string type: object AlipayEbppInvoiceSyncSimpleSendResponseModel: type: object AlipayEbppInvoiceTaxnoBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - PARAMETER_ILLEGAL - PERMISSION_DENIED - QUERY_TAX_NO_NOT_EQUAL_CERTIFY_NO type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceTaxnoBatchqueryModel: properties: enable_trade_out: description: 默认值为false。true为输出交易信息,false为不输出交易信息。 example: "true" type: string end_invoice_date: description: "查询结束时间,精确到天(按开票日期查询)\tstart_invoice_date和end_invoice_date传\ 值要求\t1.同时为空时,返回最近半年200条数据\t2.必须同时为空 或 同时不为空\t3.结束日期不能大于当前日期\t4.开始时间和结束\ 时间跨度不能超过6个月" example: 2017-07-11 type: string invoice_kind_list: description: "查询票种列表。枚举值如下:\t*PLAIN:增值税电子普通发票;\t*SPECIAL:增值税专用发票;\t*ALL_ELECTRONIC_GENERAL:\ \ \"电子发票(普通发票);\t*ALL_ELECTRONIC_SPECIAL: \"电子发票(专用发票);\t*PLAIN_INVOICE:\ 增值税普通发票;\t*PAPER_INVOICE:增值税普通发票(卷式);\t*SALSE_INVOICE:机动车销售统一发票。" example: PLAIN items: type: string type: array limit_size: description: 查询结果上限笔数,最大值20 example: 20 type: integer page_num: description: 当前页码,为空时默认第一页 example: 1 type: integer scene: description: 发票要素获取应用场景。"拉"模式报销 固定为 INVOICE_EXPENSE 表示发票报销。 example: INVOICE_EXPENSE type: string start_invoice_date: description: "查询起始时间,精确到天(按开票日期查询)\tstart_invoice_date和end_invoice_date传\ 值要求\t1.同时为空时,返回最近半年200条数据\t2.必须同时为空 或 同时不为空\t3.结束日期不能大于当前日期\t4.开始时间和结束\ 时间跨度不能超过6个月" example: 2017-01-11 type: string tax_no: description: 企业税号 example: "123" type: string type: object AlipayEbppInvoiceTaxnoBatchqueryResponseModel: properties: invoice_element_list: description: 发票要素列表 items: $ref: '#/components/schemas/InvoiceElementModel' type: array open_id: description: 支付宝用户id example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string user_id: description: 支付宝用户id example: "2088000000000000" type: string type: object AlipayEbppInvoiceTitleDynamicGetErrorResponseModel: properties: code: description: 错误码 enum: - TITLE_NOT_EXIST - ACCESS_FREQUENCY_TOO_HIGH - PARAMETER_ILLEGAL - SYSTEM_ERROR - BAR_CODE_EXPIRED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceTitleDynamicGetResponseModel: properties: title: $ref: '#/components/schemas/InvoiceTitleModel' type: object AlipayEbppInvoiceTitleListGetErrorResponseModel: properties: code: description: 错误码 enum: - TITLE_LIST_NOT_EXIST - PARAMETER_ILLEGAL - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceTitleListGetResponseModel: properties: title_list: description: 抬头列表 items: $ref: '#/components/schemas/InvoiceTitleModel' type: array type: object AlipayEbppInvoiceTokenBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVOICE_INVALID_TOKEN - PERMISSION_DENIED - PARAMETER_ILLEGAL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppInvoiceTokenBatchqueryResponseModel: properties: invoice_element_list: description: 发票要素列表 items: $ref: '#/components/schemas/InvoiceElementModel' type: array open_id: description: 支付宝用户id example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string user_id: description: 支付宝用户id example: "20880000000000000" type: string type: object AlipayEbppPdeductAsyncPayErrorResponseModel: properties: code: description: 错误码 enum: - SUBMIT_REQUEST_FAILURE type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppPdeductAsyncPayModel: properties: agent_channel: description: 分配给外部机构发起扣款时的渠道码。朗新为LANGXIN example: LANGXIN type: string agent_code: description: 二级渠道码,预留字段 example: SECOND type: string agreement_id: description: 支付宝代扣协议Id example: "1234557890" type: string bill_date: description: 账期 example: "201605" type: string bill_key: description: 户号 example: "03932134" type: string extend_field: description: 扩展字段 example: "{\"key1\":\"value1\",\"key2\":\"value2\", \"key3\":\"value3\"\ ,\"key4\":\"value4\"}" type: string fine_amount: description: 滞纳金 example: "2.00" type: string memo: description: 备注信息 example: memo type: string open_id: description: 用户UserId在应用AppId下的唯一用户标识 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string out_order_no: description: 商户外部业务流水号 example: "1888232932" type: string pay_amount: description: 扣款金额,支付总金额,包含滞纳金 example: "23.00" type: string pid: description: 商户partnerId example: "2088131312" type: string user_id: description: 用户ID example: "208811233144123" type: string type: object AlipayEbppPdeductAsyncPayResponseModel: properties: agreement_id: description: 支付宝代扣协议ID example: "42132131" type: string out_order_no: description: 商户代扣业务流水 example: "312312" type: string result_status: description: 扣款流水状态 example: I type: string type: object AlipayEbppPdeductBillPayStatusErrorResponseModel: properties: code: description: 错误码 enum: - BILL_NOT_EXIST - PARAMETER_ILLEGAL - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppPdeductBillPayStatusResponseModel: properties: agreement_id: description: 支付宝协议流水 example: "2919219429194" type: string open_id: description: 用户UserId在应用AppId下的唯一用户标识 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string order_no: description: 支付宝流billNo example: "2015010122003385" type: string order_result_code: description: 订单的结果码 example: PAY_FAIL type: string order_result_msg: description: 订单的结果描述 example: AE0110270001_支付金额不足 type: string out_order_no: description: 外部订单流水 example: "21929910124" type: string status: description: "支付宝订单支付状态。\r\t0:未知状态。\r\t1:支付成功。\r\t2:支付失败。" example: "0" type: string type: object AlipayEbppPdeductPayErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppPdeductPayModel: properties: agent_channel: description: 渠道码,如用户通过机构通过服务窗进来签约则是PUBLICFORM,此值可随意传,只要不空就行 example: PUBLICFORM type: string agent_code: description: 二级渠道码,预留字段 example: SECOND type: string agreement_id: description: 支付宝代扣协议Id example: "1234557890" type: string bill_date: description: 账期 example: "201410" type: string bill_key: description: 户号,缴费单位用于标识每一户的唯一性的 example: "262327843" type: string extend_field: 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\"}" type: string fine_amount: description: 滞纳金 example: "2.00" type: string memo: description: 备注信息 example: memo type: string open_id: description: 用户UserId在应用AppId下的唯一用户标识 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string out_order_no: description: 商户外部业务流水号 example: "18882329324" type: string pay_amount: description: 扣款金额,支付总金额,包含滞纳金 example: "23.00" type: string pid: description: 商户PartnerId example: "2088611103588892" type: string user_id: description: 用户ID example: "2088123411243554" type: string type: object AlipayEbppPdeductPayResponseModel: properties: agreement_id: description: 支付宝代扣协议ID example: "1231232132" type: string bill_no: description: 支付宝订单流水号 example: "201323423234" type: string extend_field: description: 扩展参数 example: "{\"school_no\":\"SHNU\",\r\n\"student_id\":\"20130516\"}" type: string out_order_no: description: 商户代扣业务流水 example: "213134234" type: string result_code: description: "针对于支付失败时,给的对应错误明细,如果判断外围的错误码是INVOKE_PAYACCEPTANCE_EXCEPTION需\ 要近一步再结合着结果模型中的result_code, result_msg来判断" example: AE0110270001 type: string result_msg: description: "针对于支付失败时,给的对应错误明细,如果判断外围的错误码是INVOKE_PAYACCEPTANCE_EXCEPTION需\ 要近一步再结合着结果模型中的result_code, result_msg来判断" example: 支付金额不足 type: string result_status: description: "订单支付状态。\r\t0:未知\r\t1:成功\r\t2:失败" example: "1" type: string type: object AlipayEbppPdeductSignAddErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppPdeductSignAddModel: properties: agent_channel: description: "机构签约代扣来源渠道\r\tPUBLICPLATFORM:服务窗" example: PUBLICPLATFORM type: string agent_code: description: 从服务窗发起则为publicId的值 example: "123456" type: string bill_key: description: 户号,机构针对于每户的水、电都会有唯一的标识户号 example: "02659981" type: string biz_type: description: "业务类型。枚举支持:\t*JF:公共事业缴纳。\t*WUYE:物业缴费。\t*HK:信用卡还款。\t*TX:通讯缴费\ 。\t*IND:保险缴费。" example: JF type: string charge_inst: description: 支付宝缴费系统中的出账机构ID example: CQCENTERELECTRIC type: string deduct_prod_code: description: "代扣产品码。 缴费业务场景中,传入INST_DIRECT_DEDUCT。保险业务场景中, 传入INSURANCE_MERCHANT_DEDUCT。" example: INSURANCE_MERCHANT_DEDUCT type: string deduct_type: description: 签约类型可为空 example: direct_sign_deduct type: string ext_user_info: 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\"\ :\"\"}" type: string extend_field: description: 扩展字段 example: "null" type: string notify_config: description: 通知方式设置,可为空 example: "null" type: string open_id: description: 用户UserId在应用AppId下的唯一用户标识 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string out_agreement_id: description: 外部产生的协议ID example: "123456" type: string owner_name: description: 户名,户主真实姓名 example: 王海龙 type: string pay_config: description: 支付工具设置,目前可为空 example: "null" type: string pay_password_token: description: 支付密码鉴权token,需要用户首先处于登陆态,然后访问https://ebppprod.alipay.com/deduct/enterMobileicPayPassword.htm?cb=自己指定的回跳连接地址,访问页面后会进到独立密码校验页,用户输入密码校验成功后,会生成token回调到指定的回跳地址,如果设置cb=www.alipay.com则最后回调的内容是www.alipay.com?token=312314ADFDSFAS,然后签约时直接取得地址后token的值即可。 example: 11505a6f41688644a4b85f9bf80ef071 type: string pid: description: 商户id,商户在支付宝的唯一标识,以 2088 开头的 16 位纯数字组成。 example: "2088102118849556" type: string sign_expire_date: description: 签约到期时间。空表示无限期,一期固定传空。 example: 2015-03-12 type: string sub_biz_type: 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 type: string user_id: description: 用户 id,用户在支付宝的唯一标识,以 2088 开头的 16 位纯数字组成。 example: "2088111133334134" type: string type: object AlipayEbppPdeductSignAddResponseModel: properties: agreement_id: description: 支付宝代扣协议ID example: "20141028000363828663" type: string agreement_status: description: 支付宝协议状态。签约成功则返回success example: success type: string extend_field: description: 扩展参数,可为空 example: "null" type: string notify_config: description: 通知方式设置。 example: 通知方式文案 type: string out_agreement_id: description: 商户生成的代扣协议ID example: "123123" type: string pay_config: description: 支付方式设置 example: BALANCE items: type: string type: array sign_date: description: 签约时间 example: 2014-01-21 type: string type: object AlipayEbppPdeductSignCancelErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppPdeductSignCancelModel: properties: agent_channel: description: 此值只是供代扣中心做最后的渠道统计用,并不做值是什么的强校验,只要不为空就可以 example: "操作来源\r\nPUBLICPLATFORM:服务窗" type: string agent_code: description: 标识发起方的ID,从服务窗发起则为appId的值,appId即开放平台分配给接入ISV的id,此处也可以随便真其它值,只要能标识唯一即可 example: "201603012984123" type: string agreement_id: description: 支付宝代扣协议ID example: "20160512331244123124421" type: string open_id: description: 用户UserId在应用AppId下的唯一用户标识 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string pay_password_token: description: "需要用户首先处于登陆态,然后访问https://ebppprod.alipay.com/deduct/enterMobileicPayPassword.htm?cb=自\ 己指定的回跳连接地址,访问页面后会进到独立密码校验页,用户输入密码校验成功后,会生成token回调到指定的回跳地址,如果设置cb=www.baidu.com则\ 最后回调的内容是www.baidu.com?token=312314ADFDSFAS,然后签约时直接取得地址后token的值即可" example: 11505a6f41688644a4b85f9bf80ef071 type: string user_id: description: 用户ID example: "2088123411112222" type: string type: object AlipayEbppPdeductSignCancelResponseModel: properties: agreement_id: description: 支付宝代扣协议ID example: "20441111111" type: string agreement_status: description: 支付宝协议状态。解约成功则返回success example: success type: string out_agreement_id: description: 商户代扣协议ID example: "23433333333" type: string type: object AlipayEbppPdeductSignQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - QUERY_DEDUCT_SIGN_INFO_ERROR - DEDUCT_SIGN_INFO_NOT_EXIST - PARAMETER_ILLEGAL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppPdeductSignQueryResponseModel: properties: agreement_id: description: 协议ID example: "20160331000700130000930600556911" type: string bill_key: description: 户号 example: "03983123" type: string charge_inst: description: 出账机构 example: HZYHWATER type: string out_agreement_id: description: 朗新协议ID example: 738F4D9B6F825FDE9D07773E08BD0A2E type: string sign_date: description: 签约时间 example: 2016-02-03 18:00:00 type: string user_id: description: 用户ID example: "2088022621144305" type: string type: object AlipayEbppPdeductSignValidateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEbppPdeductSignValidateModel: properties: agent_channel: description: "机构签约代扣来源渠道\r\tPUBLICPLATFORM:服务窗" example: PUBLICPLATFORM type: string agent_code: description: 从服务窗发起则为该服务窗的appid的值 example: "123456" type: string bill_key: description: 户号,机构针对于每户的水、电都会有唯一的标识户号 example: "02659981" type: string biz_type: description: "业务类型。\r\tJF:缴水、电、燃气、固话宽带、有线电视、交通罚款费用\r\tWUYE:缴物业费\r\tHK:信用\ 卡还款\r\tTX:手机充值" example: JF type: string charge_inst: description: 支付宝缴费系统中的出账机构ID example: CQCENTERELECTRIC type: string deduct_type: description: "签约类型,可为空。目前类型有INST_DIRECT_DEDUCT" example: direct_sign_deduct type: string extend_field: description: 扩展字段 example: "null" type: string notify_config: description: 通知方式设置,本期预留字段,固定传空。 example: "null" type: string open_id: description: 用户UserId在应用AppId下的唯一用户标识 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string out_agreement_id: description: 外部机构签约的协议id example: "123456" type: string owner_name: description: 户名,户主真实姓名 example: 王龙海 type: string pay_config: description: 支付工具设置,目前可为空。类型有:BALANCE;CARTOON;BIGAMOUNT_CREDIT_CARTOON;DEBIT_EXPRESS;OPTIMIZED_MOTO;PCREDIT_PAY;MONEY_FUND example: "null" type: string pid: description: 商户签约支付宝账号的userid,2088开头16位长度的字符串,在支付宝系统中唯一 example: "2088102118849556" type: string sign_expire_date: description: 签约到期时间。空表示无限期,一期固定传空。 example: 2015-03-12 type: string sub_biz_type: description: "业务子类型。\r\tWATER:缴水费\r\tELECTRIC:缴电费\r\tGAS:缴燃气费\r\tCOMMUN:\ 缴固话宽带\r\tCATV:缴有线电视费\r\tTRAFFIC:缴交通罚款\r\tWUYE:缴物业费\r\tHK:信用卡还款\r\tCZ:手\ 机充值" example: ELECTRIC type: string user_id: description: 用户支付宝账号id,2088开头16位长度的字符串,在支付宝系统中唯一 example: "2088111133334134" type: string type: object AlipayEbppPdeductSignValidateResponseModel: type: object AlipayEcoContractSignflowsCreateErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - PARAM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoContractSignflowsCreateModel: properties: attachments: description: 附件信息(附件可作为合同的辅助证明材料,无需签署。需通过文件直传接口上传附件,获取文件id后添加)。注意事项参见 文件流上传方法。 items: $ref: '#/components/schemas/Attachment' type: array business_scene: description: 流程主题(简要概括合同的签署内容) example: 爱租机手机交付单;某某公司劳动合同等 type: string config_info: $ref: '#/components/schemas/ConfigInfoBean' template_infos: description: 模板信息(基于合同模板填充内容生成待签文件,并指定签署人) items: $ref: '#/components/schemas/TemplateInfoBean' type: array type: object AlipayEcoContractSignflowsCreateResponseModel: properties: flow_id: description: 电子合同流程id(需记录到业务系统中,后续相关服务调用都基于此ID) example: 56b75290982d472b8d60133cd9a747a3 type: string type: object AlipayEcoDocTemplateCreateErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - PARAM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoDocTemplateCreateModel: properties: content_md_5: description: 模版文件的md5值。示例代码参见 创建合同模板 example: L+K1FXfqwcY6LJ0LFXb7gQ== type: string content_type: description: 目标文件的MIME类型。示例代码参见 创建合同模板 example: application/octet-stream type: string convert_to_pdf: description: 是否需要转成pdf,如果模板文件为.doc/.docx 传true,为pdf传false example: "false" type: string file_name: description: 文件名称,必须带上文件扩展名如 .pdf、.doc、.docx,否则会导致后续发起流程校验异常。 example: 劳动合同.PDF type: string type: object AlipayEcoDocTemplateCreateResponseModel: properties: template_id: description: 模板id(请记录模板ID(templateId),后续发起合同签署需要使用到) example: 049d33945cde46b7953bf377fe2a7608 type: string upload_url: 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... type: string type: object AlipayEcoDoctemplateSettingurlQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - PARAM_ERROR - TEMPLATE_FILE_IS_NOT_CONVERT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoDoctemplateSettingurlQueryResponseModel: properties: setting_url: description: 模板设置地址 example: https://t.tsign.cn/9rT0KvuVQdDJ type: string type: object AlipayEcoEduKtBillingModifyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoEduKtBillingModifyModel: properties: bank_success: description: 成功Y,失败N example: "Y" type: string buyer_logon_id: description: 退款时,支付宝返回的用户的登录id example: 159****5620 type: string buyer_user_id: description: 支付宝返回的买家支付宝用户id example: "2088101117955611" type: string buyer_user_open_id: description: 支付宝返回的买家支付宝用户id加密后信息 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string fund_change: description: 本次退款是否发生了资金变化 example: "Y" type: string gmt_refund: description: 支付宝返回的退款时间,而不是商户退款申请的时间 example: 2015-11-27 15:45:57 type: string out_request_no: description: 标识一次退款请求,同一笔交易多次退款需要保证唯一,如需部分退款,则此参数必传。(若退款时填写,则同步退款状态时也必须填写) example: HZ01RF001 type: string out_trade_no: description: isv系统的订单号 example: "20160101909909354354354" type: string refund_amount: description: "需要退款的金额,该金额不能大于订单金额,单位为元,支持两位小数" example: "200.12" type: string refund_detail_item_list: 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}" type: string refund_reason: description: 退款原因,商家根据客户实际退款原因填写(若退款时填写,则同步退款状态时也必须填写) example: 正常退款 type: string status: description: "状态:1:缴费成功,2:关闭账单,3、退费\r\t如果为退款状态,需要填写fund_change, \r\trefund_amount,\ \ refund_reason,\r\tout_request_no, buyer_logon_id,\r\tgmt_refund,\r\t\ buyer_user_id, refund_detail_item_list;\r\t4、同步网商返回的状态,如果是网商银行的账单,bank_success这\ 个字段必填" example: "1" type: string trade_no: description: 支付宝返回的交易号 example: "2014112611001004680073956707" type: string type: object AlipayEcoEduKtBillingModifyResponseModel: properties: status: description: 如果成功,返回Y example: "Y" type: string type: object AlipayEcoEduKtBillingQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - ILLEGAL_PARAM type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoEduKtBillingQueryResponseModel: properties: order_status: description: "NOT_PAY 待缴费\r\tPAYING 支付中\r\tPAY_SUCCESS 支付成功,处理中\r\tBILLING_SUCCESS\ \ 缴费成功\r\tTIMEOUT_CLOSED 逾期关闭账单\r\tISV_CLOSED 账单关闭" example: NOT_PAY type: string out_trade_no: description: ISV发送账单时输入ISV端的账单号 example: "2017097634092" type: string type: object AlipayEcoEduKtBillingSendErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - BIZ_ERROR - ILLEGAL_PARAM type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoEduKtBillingSendModel: properties: amount: description: "总金额,单位为元,精确到小数点后两位,取值范围[0.01,100000000],\r\t如果是非多选项,是要和缴费项\ 的总和相同,多选模式不做验证" example: "88.88" type: string charge_bill_title: description: 缴费账单名称 example: 学生开学收费项 type: string charge_item: description: 缴费详情:输入json格式字符串。Json定义:key填写缴费项名称,value填写缴费项金额,金额保留2位小数 items: $ref: '#/components/schemas/ChargeItems' type: array charge_type: description: "缴费项模式:空或\"N\",表示缴费项不可选,\r\t\"M\"表示缴费项为可选 ,支持单选和多选。" example: M type: string child_name: description: 孩子名字 example: 张晓晓 type: string class_in: description: 孩子所在班级 example: 3班 type: string end_enable: description: "截止日期是否生效,与gmt_end发布配合使用,N为gmt_end不生效,用户过期后仍可以缴费;Y为gmt_end生\ 效,用户过期后,不能再缴费。" example: "Y" type: string ext_info: $ref: '#/components/schemas/BillSendExtInfo' gmt_end: description: 缴费截止时间,格式"yyyy-MM-dd HH:mm:ss",日期要大于当前时间。请注意,过期时间不宜设置过短。 example: 2016-01-01 13:13:13 type: string grade: description: 孩子所在年级 example: 高一 type: string out_trade_no: description: ISV端的缴费账单编号 example: "20160232343253253453" type: string partner_id: description: "Isv支付宝pid, 支付宝签约后,返回给ISV编号" example: "201600129391238873" type: string school_no: description: 学校编码,录入学校接口返回的参数 example: "11010100000002" type: string school_pid: description: "学校支付宝pid,直付通填写smid" example: "20880012939123234423" type: string student_code: description: 学生的学号,只支持字母和数字类型,一般以教育局学号为准,作为学生的唯一标识。此字段与student_identify、家长user_mobile至少选一个 example: "2098453900091" type: string student_identify: description: "学生的身份证号,如果ISV有学生身份证号,则同步身份证号作为学生唯一标识。此字段与student_code、家长user_mobile至\ 少选一个。\r\t大陆身份证必须是18位 , 其它地区或国家的身份证开头需要加\"IC\"开头区分并且不超过18位,但查询账单的时候不要带\"\ IC\"" example: "310193199905289483" type: string users: description: 孩子的家长信息,最多一次输入10个家长,此字段做为识别家长的孩子用,与student_identify、student_code至少选一个 items: $ref: '#/components/schemas/UserDetails' type: array type: object AlipayEcoEduKtBillingSendResponseModel: properties: order_no: description: 支付宝-中小学-教育缴费的账单号 example: "20160101909909354354354" type: string type: object AlipayEcoEduKtParentQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoEduKtParentQueryResponseModel: properties: status: description: 如果用户已经添加过这个孩子,则返回SUCCESS , 失败返回FAIL。 example: SUCCESS type: string type: object AlipayEcoEduKtSchoolinfoModifyErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - BIZ_ERROR - INVALID_PARAMETER_COLLEGE_SCHOOL_TYPE_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoEduKtSchoolinfoModifyModel: properties: bank_notify_url: description: 与浙江网商交易见证平台有交互ISV输入网商交易异步通知回调URL,教育缴费同步账单信息给网商,网商会回调此url,ISV即可获取网商相关的参数,根据教育缴费平台账单发送接口返回的 order_no和网商返回的outer_trade_no来对应账单信息。 example: https://www.xxx.xxx/xx type: string bank_partner_id: description: "与浙江网商交易见证平台有交互的ISV,由交易见证平台分配给合作方业务平台 签约唯一ID ,由网商分配给ISV的渠道参\ 数" example: "200002924334" type: string bank_uid: description: 与浙江网商交易见证平台有交互的ISV在创建账户时的uid,也就是ISV平台上的用户ID(字母或数字) example: "20000293230232" type: string bankcard_no: description: 对应集团到卡模式的银行编号.学校与支付宝后台签约时,由学校提交给支付宝的编号 example: P0004 type: string batch_no: description: 集团收单模式:分账批次号,支付宝配置后提供的银行卡批次号 example: "201812180111030000034567270022" type: string card_alias_no: description: 学校开通直付通卡编号,smid与card_alias_no必须同时填写 example: c6c0c7a1b9d54e5db9d49eed39f00e65 type: string city_code: description: 城市的国家编码。参见 国家统计局出版的行政区划代码。 example: "330100" type: string city_name: description: 城市名称 example: 杭州市 type: string corporate_branch_pid: description: 集团收单模式:BD批量上传银行卡信息后,支付宝系统分配给ISV的每个卡分配的唯一标识 example: "2088301031335812" type: string district_code: description: 区县的国家编码。参见 国家统计局出版的行政区划代码。 example: "330106" type: string district_name: description: 区县名称 example: 西湖区 type: string isv_name: description: ISV公司名称 , 会在账单详情页面展示给用户 example: 杭州少年宫 type: string isv_no: description: "注意:本参数于2017-08-03开始已经废弃,不再需要传递。\t由支付宝提供的给已经签约的isv的编码,业务上一般\ 直接采用isv的支付宝PID。" example: "201600129391238873" type: string isv_notify_url: description: 此通知地址是为了保持教育缴费平台与ISV商户支付状态一致性。用户支付成功后,支付宝会根据本isv_notify_url(异步通知说明https://docs.open.alipay.com/203/105286/),通过POST请求的形式将支付结果作为参数通知到商户系统,ISV商户可以根据返回的参数更新账单状态。 example: https://isv.com/xxx type: string isv_phone: description: ISV的联系方式 , 会在账单详情页面展示给用户,用户有问题可以直接联系此电话获取帮助 example: "13300000000" type: string isv_pid: description: 填写已经签约教育缴费的isv的支付宝PID example: "2088121212121212" type: string province_code: description: 省份的国家编码,参见 国家统计局出版的行政区划代码。 example: "330000" type: string province_name: description: 省名称 example: 浙江省 type: string school_icon: description: "学校的校徽或logo,在学校展示页面作为学校的标识。该字段为图片的链接地址,只支持png或jpg图片格式,图片高度为\ 108,宽度为108 ,不大于20k。\r\t注意:此链接要求公网可以访问,否则无法正常展示。" example: http://ecopublic-dev.oss-cn-hangzhou.aliyuncs.com/eco/edu_alipay/school/school.png type: string school_icon_type: description: 如果填写了school_icon参数,则此字段不能为空。目前只支持png和jpg两种格式 example: png type: string school_name: description: 学校名称 example: 杭州市西湖第一实验学校 type: string school_pid: description: "学校签约支付宝教育缴费支付宝pid,如果是直付通学校,填写直付通返回的smid" example: "20880012939123234423" type: string school_stdcode: description: 学校(机构)标识码(由教育部按照国家标准及编码规则编制,可以在教育局官网查询) example: "3133005132" type: string school_type: description: "学校的类型。枚举值如下:\t*1:代表托儿所。\t*2:代表幼儿园。\t*3:代表小学。\t*4:代表初中。\t*5:\ 代表高中。\t注意:如果学校兼有多种属性,可以连写,比如:45:代表兼有初中部高中部;34:代表兼有小学部初中部。" example: "4" type: string smid: description: 学校开通直付通返回的二级商户id,smid与card_alias_no必须同时填写 example: "2088301031335814" type: string trans_in: description: 集团收单模式:分账批次号,支付宝配置后提供的银行卡批次号 example: "4325353" type: string white_channel_code: description: "与浙江网商交易见证平台有交互的ISV,由网商分配给ISV的渠道参数" example: TESTBANK10301 type: string type: object AlipayEcoEduKtSchoolinfoModifyResponseModel: properties: school_no: description: 支付宝分配给学校的编码,作为学校在支付宝的标识 example: "11010100000002" type: string status: description: Y:代表成功;N:代表失败 example: "Y" type: string type: object AlipayEcoEduKtStudentModifyErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoEduKtStudentModifyModel: properties: child_name: description: "修改后的学生姓名\r\t本接口调用时,child_name、student_code、student_identify、\ users这几个参数至少需要填写其中一个,不能同时为空" example: 张三 type: string isv_pid: description: 已经签约教育缴费的isv的支付宝PID example: "2088121212121212" type: string school_no: description: 学校编号,调用alipay.eco.edu.kt.schoolinfo.modify接口录入学校信息时,接口返回的编号 example: "11010100000001" type: string school_pid: description: 学校用来签约支付宝教育缴费的支付宝PID example: "2088101117955611" type: string status: description: "区分ISV操作,“D”表示删除,“U”表示更新,区分大小写。\r\t如果为U,则学生名字,学号,身份证至少填写一项" example: U type: string student_code: description: "修改后的学号\r\t本接口调用时,child_name、student_code、student_identify、\ users这几个参数至少需要填写其中一个,不能同时为空" example: "6589154" type: string student_identify: description: "修改后的身份证号码\r\t本接口调用时,child_name、student_code、student_identify、\ users这几个参数至少需要填写其中一个,不能同时为空" example: "610824197812044680" type: string student_no: description: 支付宝-中小学-教育缴费生成的学生唯一编号 example: 57de63cb1ef157595c005467 type: string users: description: "孩子的家长信息,最多一次输入20个家长。如果输入的家长信息不存在,则该改学生增加家长信息\r\t本接口调用时,child_name、\ student_code、student_identify、users这几个参数至少需要填写其中一个,不能同时为空" items: $ref: '#/components/schemas/UserDetails' type: array type: object AlipayEcoEduKtStudentModifyResponseModel: properties: status: description: Y:代表成功;N:代表失败 example: "Y" type: string type: object AlipayEcoFilePathQueryErrorResponseModel: properties: code: description: 错误码 enum: - PARAM_ERROR - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoFilePathQueryResponseModel: properties: file_id: description: 文件Id example: 049d33945cde46b7953bf377fe2a7608 type: string upload_url: 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... type: string type: object AlipayEcoMycarParkingChargeinfoSyncErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoMycarParkingChargeinfoSyncModel: properties: business_hours: description: 营业时间 example: 24小时 type: string car_daylight_advanced_price: description: 小车-白天 非首个计费单元价格 example: 3元/小时或1.5元/30分钟 type: string car_daylight_base_price: description: 小车-白天 首个计费单元价格 example: 10元/1小时或5元/30分钟 type: string car_night_advanced_price: description: 小车-夜间 非首个计费单元价格 example: 3元/小时或1.5元/30分钟 type: string car_night_base_price: description: 小车-夜间 首个计费单元价格 example: 10元/1小时或5元/30分钟 type: string car_onetime_price: description: "小车 计次收费价格\r\txx元 / 次,按次收费的车场填写" example: 20元/次 type: string daily_price_upperbound: description: 单日停车封顶价格:具体值或“不封顶” example: 260元或不封顶 type: string daylight_business_hours: description: 车场白天(收费)营业时间段 example: 9:00-21:00 type: string free_period: description: 单次停车免费时长 example: 30分钟 type: string has_charging_pile: description: "是否有充电桩: -1 未知,0 否,1 是" example: "1" type: string is_charge: description: "是否收费:-1 未知,0 否,1 是" example: "1" type: string night_business_hours: description: 车场夜间(收费)营业时间段 example: 21:00-9:00 type: string parking_id: description: 停车场ID example: PI20190506152394234234 type: string parking_space_count: description: 总车位数 example: 1600 type: integer remark: description: "复杂计费补充描述\r\t收费复杂无法格式化的车场填写,以文本形式表述" example: 前3小时XXX,3-6小时之间XXX,超过6小时XXXX type: string truck_daylight_advanced_price: description: 大车-白天 非首个计费单元价格 example: 3元/小时或1.5元/30分钟 type: string truck_daylight_base_price: description: 大车-白天 首个计费单元价格 example: 10元/1小时或5元/30分钟 type: string truck_night_advanced_price: description: 大车-夜间 非首个计费单元价格 example: 4元/次 type: string truck_night_base_price: description: 大车-夜间 首个计费单元价格 example: 3元/小时或1.5元/30分钟 type: string truck_onetime_price: description: "大车 计次收费价格\r\txx元 / 次,按次收费的车场填写" example: 30元/次 type: string type: object AlipayEcoMycarParkingChargeinfoSyncResponseModel: properties: sync_result: description: 同步结果:0 成功,1 失败 example: "0" type: string type: object AlipayEcoMycarParkingCharginginfoSyncErrorResponseModel: properties: code: description: 错误码 enum: - BIZ_ERROR - INVALID_PARAMETER - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoMycarParkingCharginginfoSyncModel: properties: car_number: description: 车牌号 example: 浙Axxxxx type: string isv_url: description: 智能助理当前的跳转链接 example: http://xxxxxx type: string parking_id: description: 支付宝停车平台ID,由支付宝定义的该停车场标识,同一个isv或商户范围内唯一。通过 alipay.eco.mycar.parking.parkinglotinfo.create(录入停车场信息)接口获取。 example: "2015042321001004720200028594" type: string serial_no: description: "支付宝业务流水号,用于记录车辆从驶入到驶出的全流程。通过 alipay.eco.mycar.parking.enterinfo.sync\t\ (车辆驶入接口)接口获取。" example: "2020090711003017233600000001" type: string type: object AlipayEcoMycarParkingCharginginfoSyncResponseModel: type: object AlipayEcoMycarParkingConfigQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INTERFACE_TYPE_IS_ILLEGAL - MERCHANT_INFO_IS_EMPTY - INTERFACE_INFO_IS_EMPTY - SERVICE_NAME_IS_ILLEGAL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoMycarParkingConfigQueryResponseModel: properties: account_no: description: 签约支付宝账号,开发者通过ISV系统配置信息注册接口(alipay.eco.mycar.parking.config.set)传入的参数值 example: 1234567@126.com type: string interface_info_list: $ref: '#/components/schemas/InterfaceInfoList' merchant_logo: description: 商户在停车平台首页露出的LOGO链接地址,开发者通过ISV系统配置信息注册接口(alipay.eco.mycar.parking.config.set)调用自动生成该链接 example: http://ecopublic.oss-cn-hangzhou.aliyuncs.com/eco/carlife/parking/merchantlogo/xiaoshanjichang.png type: string merchant_name: description: 商户简称,开发者通过ISV系统配置信息注册接口(alipay.eco.mycar.parking.config.set)传入的参数值 example: 杭州立方 type: string merchant_service_phone: description: 商户客服电话,开发者通过ISV系统配置信息注册接口(alipay.eco.mycar.parking.config.set)传入的参数值 example: 021-25413215 type: string type: object AlipayEcoMycarParkingConfigSetErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoMycarParkingConfigSetModel: properties: account_no: description: 签约支付宝账号 example: 1234567@126.com type: string interface_info_list: description: 接口信息列表,停车业务需要配置的接口列表,该值为JSON数据格式的LIST对象,现阶段只需要配置一个页面接口即可 。每次请将所有的接口配置信息都传入,未传的接口信息将会被置空。 items: $ref: '#/components/schemas/InterfaceInfoList' type: array merchant_logo: description: "商户在停车平台首页露出的LOGO。\t注意:\t*该图片为PNG格式,内容为BASE64的字符串,建议图片尺寸27px*27px,\ 大小不要超过60K。\t*若为空则停车平台首页将不露出商户LOGO。" example: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAIAAAACCAYAAABytg0kAAAAE0lEQVQImWP81mfxn4GJAYQgAAAqvgLBUG4ufAAAAABJRU5ErkJggg==" type: string merchant_name: description: 商户简称,由开发者提供 example: 杭州立方 type: string merchant_service_phone: description: 商户客服电话 example: 021-25413215 type: string type: object AlipayEcoMycarParkingConfigSetResponseModel: type: object AlipayEcoMycarParkingEnterinfoSyncErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR - CALL_TOO_OFFTEN - ISV_APP_ID_ILLEGAL - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoMycarParkingEnterinfoSyncModel: properties: agreement_query: description: 是否启用车牌代扣状态查询功能,true为启用,false为停用 example: true type: boolean car_color: description: "车牌颜色,车牌颜色,枚举支持:\t*BLUE:蓝。\t*GREEN:绿。\t*YELLOW:黄。\t*WHITE:白\ 。\t*BLACK:黑。\t*LIMEGREEN:黄绿色。" example: BLUE type: string car_number: description: 车牌号 example: 豫C33333 type: string entrance_id: description: 用于识别车辆进口,多出入口车场适用 example: SN001 type: string free_minutes: description: 当前停车场的入场免费时长分钟数 example: 15 type: integer in_time: description: 车辆入场的时间,格式"YYYY-MM-DD HH:mm:ss",24小时制,请保证服务器时间准确,入场时间不应晚于当前网络时间 example: 2016-07-24 03:07:50 type: string is_encrypt_car_number: description: 是否加密,默认为false example: true type: boolean isv_url: description: 智能助理当前的跳转链接。为ISV/商家小程序scheme地址或H5页面地址。 example: http://xxxxx type: string out_serial_no: description: 外部停车流水号(用于串通进场与出场信息) example: "2020090711003017233600000001" type: string parking_id: description: 支付宝停车平台ID,由支付宝定义的该停车场标识,同一个isv或商户范围内唯一。通过 alipay.eco.mycar.parking.parkinglotinfo.create(录入停车场信息)接口获取。 example: "2015042321001004720200028594" type: string space_number: description: 用于标识车辆停放车位编号,路侧适用 example: PK001 type: string store_id: description: 与parking_id对应的外部停车场编号,在门店中维护 example: 360xx type: string type: object AlipayEcoMycarParkingEnterinfoSyncResponseModel: properties: agreement_scene: description: 用户签约的代扣场景字符集,多个英文逗号分割,当车场为ORC识别车牌的场景,返回值包含PLATE_PAY时,表示代扣协议可用。 当车场为ETC设备识别车牌,返回值包含ETC_PAY时表示协议可用。当用户未签约任何代扣场景时返回NO_AGREEMENT_SCENE example: "PLATE_PAY,ETC_PAY" type: string agreement_status: description: "该字段已废弃,请使用agreement_scene字段" example: 0:已签约无感代扣 1:未签约 type: string car_status: description: 当前车辆在支付宝侧的信息,是否可以使用无感支付,可选返回项为: NORMAL:正常缴费用户 NON-SENSE-PAY:可无感支付用户 example: NORMAL type: string current_time: description: 当前时间戳(查询签约状态和是否支持无感支付仅代表当前时间点查询结果,不作为最后代扣结果,应在发起代扣前再次查询) example: 2020-11-27 15:40:00 type: string serial_no: description: 支付宝业务流水号,用于记录车辆从驶入到驶出的全流程 example: "2020090711003017233600000001" type: string type: object AlipayEcoMycarParkingExitinfoSyncErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - BIZ_ERROR - CALL_TOO_OFFTEN - SERIAL_NO_ENTER_NO_RECORD - SERIAL_NO_DOUBLE_ENTER_NO_RECORD type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoMycarParkingExitinfoSyncModel: properties: actual_amount: description: 实际金额 example: "10.00" type: string car_color: description: "车牌颜色,枚举支持:\t*BLUE:蓝。\t*GREEN:绿。\t*YELLOW:黄。\t*WHITE:白。\t*BLACK:\ 黑。\t*LIMEGREEN:黄绿色。" example: BLUE type: string car_number: description: 车牌号 example: 豫C33333 type: string discount_amount: description: 折扣金额 example: "10.00" type: string exit_id: description: 用于识别车辆出口,多出入口车场适用 example: SN001 type: string is_encrypt_car_number: description: 是否加密,默认为false example: false type: boolean isv_url: description: 智能助理当前的跳转链接 example: http://xxxxx type: string order_amount: description: 订单总金额 example: "10.00" type: string out_serial_no: description: 外部停车流水号(用于串通进场与出场信息) example: "2020090711003017233600000001" type: string out_time: description: 车辆离场时间,格式"YYYY-MM-DD HH:mm:ss",24小时制 example: 2016-07-24 03:07:50 type: string parking_id: description: 支付宝停车平台ID,由支付宝定义的该停车场标识,同一个ISV或商户范围内唯一。通过 alipay.eco.mycar.parking.parkinglotinfo.create(录入停车场信息)接口获取。 example: PI1592907192010409114 type: string serial_no: description: 支付宝业务流水号,用于记录车辆从驶入到驶出的全流程。通过 alipay.eco.mycar.parking.enterinfo.sync(车辆驶入接口)接口获取。 example: "2020090711003017233600000001" type: string space_number: description: 用于标识车辆停放车位编号,路侧适用 example: PK001 type: string store_id: description: 与parking_id对应的外部停车场编号,在门店中维护 example: 360xx type: string type: object AlipayEcoMycarParkingExitinfoSyncResponseModel: type: object AlipayEcoMycarParkingOrderSyncErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoMycarParkingOrderSyncModel: properties: agent_pid: description: 该笔停车交易需要返佣的对象实体PID,可能是商户,可能是ISV;只做下沉,用于离线表层面对账。 example: 2088xxxxxx type: string car_number: description: 车牌 example: 浙Axxxxx type: string card_number: description: 如果是停车卡缴费,则填入停车卡卡号,否则为'*' example: "2357868977445645645656" type: string in_duration: description: 停车时长(以分为单位) example: "320" type: string in_time: description: 入场时间,格式"YYYY-MM-DD HH:mm:ss",24小时制 example: 2016-08-12 20:20:13 type: string open_id: description: 应用用户ID,唯一标识 example: 021uU2O6oUtUsckXA1rpUpiWpFWNTOFZXoOgVOPIrkW2Dgb type: string order_no: description: 支付宝支付流水,系统唯一 example: "7674879087745646586" type: string order_status: description: "设备商订单状态,枚举支持:\t* 0:成功。\t* 1:失败。" example: "1" type: string order_time: description: 订单创建时间,格式"YYYY-MM-DD HH:mm:ss",24小时制 example: 2016-08-12 20:27:30 type: string out_order_no: description: 设备商订单号,由ISV系统生成 example: "201605061278654435466567" type: string out_parking_id: description: ISV停车场ID,由ISV定义的停车场标识,同一个isv或商户范围内唯一。需与 alipay.eco.mycar.parking.parkinglotinfo.create(录入停车场信息)接口传入值一致。 example: "201605061278654" type: string out_time: description: 出场时间,格式"YYYY-MM-DD HH:mm:ss",24小时制 example: 2021-03-04 15:04:05 type: string parking_id: description: 支付宝停车平台ID,由支付宝定义的该停车场标识,同一个isv或商户范围内唯一。通过 alipay.eco.mycar.parking.parkinglotinfo.create(录入停车场信息)接口获取。 example: "1234567890123456" type: string parking_name: description: 停车场名称,需与alipay.eco.mycar.parking.parkinglotinfo.create(录入停车场信息)接口传入值一致。 example: 上海证大五道口地下停车场 type: string parking_record_id: description: 支付宝业务流水号,用于记录车辆从驶入到驶出的全流程。通过 alipay.eco.mycar.parking.enterinfo.sync(车辆驶入接口)接口获取。 example: "2020090711003017233600000001" type: string pay_money: description: 缴费金额,保留小数点后两位 example: "20.00" type: string pay_scene: description: 支付场景:INPARKINGLOT_PAY:场内在线缴费;ENTRANCE_EXIT_PAY:出入口缴费、VEH_DEVICE_PAY:车机缴费;会根据场景判断是否发放能量,当前只有场内支付场景会发能量,需要能量发放请与服务接入支持同学提前沟通。 example: INPARKINGLOT_PAY type: string pay_time: description: "缴费时间, 格式\"YYYYMM-DD HH:mm:ss\",24小时制" example: 2016-08-12 23:20:23 type: string pay_type: description: "付款方式,枚举支持:\t*1:支付宝在线缴费。" example: "1" type: string smid: description: 间连商户ID example: "12345678900" type: string user_id: description: "停车缴费用户 id,用户在支付宝的唯一标识,以 2088 开头的 16 位纯数字组成。\t注意:ISV需保证用户 id的\ 正确性,以免导致用户在停车平台查询不到相关的订单信息。" example: "2088006362935583" type: string type: object AlipayEcoMycarParkingOrderSyncResponseModel: type: object AlipayEcoMycarParkingOrderUpdateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoMycarParkingOrderUpdateModel: properties: open_id: description: 应用用户ID,唯一标识 example: 021uU2O6oUtUsckXA1rpUpiWpFWNTOFZXoOgVOPIrkW2Dgb type: string order_no: description: 支付宝支付流水号,系统唯一 example: PO20160805204323394865 type: string order_status: description: "用户停车订单状态,枚举支持:\t*0:成功。\t*1:失败。" example: "1" type: string user_id: description: "停车缴费用户 id,用户在支付宝的唯一标识,以 2088 开头的 16 位纯数字组成。\t注意:ISV需保证用户 id\ \ 的正确性,以免导致用户在停车平台查询不到相关的订单信息。" example: "2088006362935583" type: string type: object AlipayEcoMycarParkingOrderUpdateResponseModel: type: object AlipayEcoMycarParkingOvertimecharginginfoSyncErrorResponseModel: properties: code: description: 错误码 enum: - BIZ_ERROR - INVALID_PARAMETER - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoMycarParkingOvertimecharginginfoSyncModel: properties: car_number: description: 车牌号 example: 浙Axxxxx type: string isv_url: description: 智能助理当前的跳转链接 example: http://xxxxx type: string parking_id: description: 支付宝停车平台ID,由支付宝定义的该停车场标识,同一个isv或商户范围内唯一。通过 alipay.eco.mycar.parking.parkinglotinfo.create(录入停车场信息)接口获取。 example: "2015042321001004720200028594" type: string serial_no: description: 支付宝业务流水号,用于记录车辆从驶入到驶出的全流程 example: "2020090711003017233600000001" type: string type: object AlipayEcoMycarParkingOvertimecharginginfoSyncResponseModel: type: object AlipayEcoMycarParkingParkinglotbizTransferErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoMycarParkingParkinglotbizTransferModel: properties: business_isv: description: 车场业务归属关系列表 items: $ref: '#/components/schemas/BusinessItem' type: array parking_id: description: 车场创建返回的parking_id字段 example: PI1480989659571286385 type: string type: object AlipayEcoMycarParkingParkinglotbizTransferResponseModel: type: object AlipayEcoMycarParkingParkinglotinfoCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoMycarParkingParkinglotinfoCreateModel: properties: agent_id: description: 服务商的支付宝账号ID(2088开头的16位纯数字,获取方式),由服务商提供给ISV example: "2088456825942563" type: string business_isv: description: 车场业务归属列表 items: $ref: '#/components/schemas/BusinessItem' type: array city_id: description: 该参数废弃 example: "110101" type: string contact_alipay: description: 该参数废弃 example: 189xxxxxxxx type: string contact_emali: description: 该参数废弃 example: alipay@alipay.com type: string contact_mobile: description: 该参数废弃 example: 189xxxxxxxx type: string contact_name: description: 该参数废弃 example: 张三 type: string contact_tel: description: 该参数废弃 example: 0571xxxxxxxx type: string contact_weixin: description: 该参数废弃 example: "923422342" type: string equipment_name: description: 该参数废弃 example: 杭州立方 type: string is_support_invoice: description: "是否支持电子发票。枚举支持:\t0:表示不支持。\t1:表示支持。" example: "1" type: string isv_mobile: description: ISV电话,传入original_isv_pid、original_isv_appid时,此处为服务商电话 example: 571-8643-2799 type: string latitude: description: 纬度 example: "30.548828" type: string longitude: description: 经度 example: "114.266418" type: string mchnt_id: description: 收款方的支付宝账号ID(2088开头的16位纯数字,获取方式),由停车场收款的业主方提供给ISV,该字段暂用于机具和物料申领 example: "2088456825942563" type: string original_isv_appid: description: "ISV的APPID,服务商调用必传,由ISV提供给服务商" example: "2021002108619277" type: string original_isv_mobile: description: ISV电话,此值与isv_mobile组合使用 example: 571-8643-2799 type: string original_isv_name: description: ISV的名称,服务商调用必传,由ISV提供给服务商 example: 杭州立方 type: string original_isv_pid: description: "ISV的PID,服务商调用必传,由ISV提供给服务商" example: "2088456825942563" type: string out_parking_id: description: ISV停车场ID,由ISV 自定义,同一个isv或商户范围内唯一 example: "10000110001" type: string parking_address: description: 停车场地址 example: 浙江省杭州市古墩路与疏港公路的交汇处 type: string parking_end_time: description: 该参数废弃 example: 03:07:50 type: string parking_fee_description: description: 收费说明 example: 小车一小时10元 type: string parking_fee_description_img: description: 商户在停车平台露出的停车价格图片;注意:该图片为PNG格式内容为BASE64的字符串,大小不要超过1MB example: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAIAAAACCAYAAABytg0kAAAAE0lEQVQImWP81mfxn4GJAYQgAAAqvgLBUG4ufAAAAABJRU5ErkJggg==" type: string parking_lot_type: description: 停车场类型,1为居民小区、2为商圈停车场(购物中心商业广场商场等)、3为路侧停车、4为公园景点(景点乐园公园老街古镇等)、5为商务楼宇(酒店写字楼商务楼园区等)、6为其他、7为交通枢纽(机场火车站汽车站码头港口等)、8为市政设施(体育场博物图书馆医院学校等) example: "1" type: string parking_mobile: description: 停车场客服电话 example: 189XXXXXXXX type: string parking_name: description: 停车场名称,由ISV定义,尽量与高德地图上的一致。 example: 城西停车场 type: string parking_number: description: 该参数废弃 example: "10000" type: string parking_poiid: description: 如何获取parking_poiid(高德地图唯一标标识)参考文档 https://opendocs.alipay.com/support/01rghx;若无法成功获取高德POI时,也可选用经纬度的方式注册。 example: B000A9JM2H type: string parking_start_time: description: 该参数废弃 example: 07:00:00 type: string parking_type: description: 该参数废弃 example: "2" type: string pay_type: description: "支付方式。枚举支持:\t1:表示支付宝在线缴费。\t2:表示支付宝代扣缴费。\t3:表示当面付。\t说明:如支持多种\ 方式以 ',' 进行分隔。" example: "2" type: string payment_mode: description: 该参数废弃 example: "1" type: string shopingmall_id: description: 商圈id example: "100001008" type: string sum_space: description: 停车场车位数 example: "3000" type: string support_after_pay: description: "是否支持先离后付。枚举支持:\tY:支持。\tN:不支持。\t说明:默认为空不支持,此参数适用于签约信用代扣的商户。" example: "Y" type: string time_out: description: 用户支付未离场的超时时间(以分钟为单位) example: "13" type: string type: object AlipayEcoMycarParkingParkinglotinfoCreateResponseModel: properties: parking_id: description: 支付宝返回停车场id。成功不为空,失败返回空 example: "2014072300007148" type: string type: object AlipayEcoMycarParkingParkinglotinfoQueryErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoMycarParkingParkinglotinfoQueryResponseModel: properties: address_id: description: 地区编码 example: "110105" type: string agent_id: description: 服务商ID(2088开头的16位纯数字),由服务商提供给ISV example: "2088456825942563" type: string business_isv: description: 车场业务归属列表 items: $ref: '#/components/schemas/BusinessItem' type: array city_id: description: 城市编码 example: "010" type: string map_poi_address: description: 高德检索地址 example: 望京街4号望京SOHO type: string map_poi_name: description: 高德检索名称 example: 望京SOHO停车场 type: string mchnt_id: description: 收款方ID(2088开头的16位纯数字),由停车场收款的业主方提供给ISV,该字段暂用于机具和物料申领 example: "2088456825942563" type: string out_parking_id: description: ISV停车场ID,由ISV提供,同一个isv或商户范围内唯一 example: "10000110001" type: string parking_address: description: 停车场地址 example: 北京市朝阳区望京街与阜安西路交叉路口 type: string parking_fee_description: description: 收费说明 example: 小车一小时10元 type: string parking_fee_description_img: description: 停车场价格明细图片 example: https://mdgwdev.alipay.net/afts/img/A*617CRpBdj_fJCs1NmMi4dQAAAa4wAA/original?bz=industry_etc&t=-NhhRTMCAllKiM3Vj1mNcQAAAABkMK5ft-HF type: string parking_id: description: 支付宝返回停车场id,系统唯一 example: PI1532313981415143356 type: string parking_latitude: description: 停车场位置经度(优先高德坐标获取结果) example: "39.998001" type: string parking_longitude: description: 停车场位置经度(优先高德坐标获取结果) example: "116.480654" type: string parking_lot_type: description: 停车场类型,1为居民小区、2为商圈停车场(购物中心商业广场商场等)、3为路侧停车、4为公园景点(景点乐园公园老街古镇等)、5为商务楼宇(酒店写字楼商务楼园区等)、6为其他、7为交通枢纽(机场火车站汽车站码头港口等)、8为市政设施(体育场博物图书馆医院学校等) example: 2为商圈停车场(购物中心商业广场商场等) type: string parking_mobile: description: 停车场客服电话 example: 189XXXXXXXX type: string parking_name: description: 停车场名称,由ISV定义,尽量与高德地图上的一致 example: 望京SOHO停车场 type: string parking_poiid: description: 高德地图唯一标识 example: B0FFFAIBGG type: string pay_type: description: "支付方式(1为支付宝在线缴费,2为支付宝代扣缴费,3当面付),如支持多种方式以','进行间隔" example: 2为支付宝代扣缴费 type: string province_id: description: 省份编码 example: "110000" type: string shopingmall_id: description: 商圈id example: "100001008" type: string time_out: description: 用户支付未离场的超时时间(以分钟为单位) example: "13" type: string type: object AlipayEcoMycarParkingParkinglotinfoUpdateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoMycarParkingParkinglotinfoUpdateModel: properties: agent_id: description: 服务商ID(2088开头的16位纯数字),由服务商提供给ISV example: "2088456825942563" type: string business_isv: description: 车场业务归属列表 items: $ref: '#/components/schemas/BusinessItem' type: array city_id: description: 该参数废弃 example: "110101" type: string contact_alipay: description: 该参数废弃 example: 189xxxxxxxxxxx type: string contact_email: description: 该参数废弃 example: alipay@alipay.com type: string contact_mobile: description: 该参数废弃 example: "18912345678" type: string contact_name: description: 该参数废弃 example: 张三 type: string contact_tel: description: 该参数废弃 example: 0571xxxxxxxx type: string contact_weixin: description: 该参数废弃 example: "923422342" type: string equipment_name: description: 该参数废弃 example: 杭州立方 type: string is_support_invoice: description: "是否支持电子发票。枚举支持: \t*0:表示不支持。 \t*1:表示支持。" example: "1" type: string isv_mobile: description: ISV电话,传入original_isv_pid、original_isv_appid时,此处为服务商电话 example: 571-8643-2799 type: string latitude: description: 纬度 example: "30.548828" type: string longitude: description: 经度 example: "114.266418" type: string mchnt_id: description: 收款方ID(2088开头的16位纯数字),由停车场收款的业主方提供给ISV,该字段暂用于机具和物料申领,更新时不影响交易接口中的收款方值。 example: "2088456825942563" type: string original_isv_appid: description: "ISV的APPID,服务商调用必传,由ISV提供给服务商" example: "2021002108619277" type: string original_isv_mobile: description: ISV电话,此值与isv_mobile组合使用 example: 571-8643-2799 type: string original_isv_name: description: ISV的名称,服务商调用必传,由ISV提供给服务商 example: 杭州立方 type: string original_isv_pid: description: "ISV的PID,服务商调用必传,由ISV提供给服务商" example: "2088456825942563" type: string out_parking_id: description: 该参数废弃 example: "10000110001" type: string parking_address: description: 停车场地址 example: 浙江省杭州市古墩路与疏港公路的交汇处 type: string parking_end_time: description: 该参数废弃 example: 03:07:50 type: string parking_fee_description: description: 收费说明 example: 小车一小时10元 type: string parking_fee_description_img: description: 商户在停车平台露出的停车价格图片;注意:该图片为PNG格式内容为BASE64的字符串,大小不要超过1MB example: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAIAAAACCAYAAABytg0kAAAAE0lEQVQImWP81mfxn4GJAYQgAAAqvgLBUG4ufAAAAABJRU5ErkJggg==" type: string parking_id: description: 支付宝返回停车场id,系统唯一 example: "2014072300007148" type: string parking_lot_type: description: 停车场类型,1为居民小区、2为商圈停车场(购物中心商业广场商场等)、3为路侧停车、4为公园景点(景点乐园公园老街古镇等)、5为商务楼宇(酒店写字楼商务楼园区等)、6为其他、7为交通枢纽(机场火车站汽车站码头港口等)、8为市政设施(体育场博物图书馆医院学校等) example: "1" type: string parking_mobile: description: 停车场客服电话 example: 189XXXXXXXX type: string parking_name: description: 停车场名称,由ISV定义,尽量与高德地图上的一致 example: 城西停车场 type: string parking_number: description: 该参数废弃 example: "10000" type: string parking_poiid: description: "高德地图唯一标识。新增高德兴趣点流程 点此查看详情 。\t获取高德兴趣点流程 点此查看详情。" example: B000A9JM2H type: string parking_start_time: description: 该参数废弃 example: 03:07:50 type: string parking_type: description: 该参数废弃 example: "1" type: string pay_type: description: "支付方式。枚举支持:\t*1:表示支付宝在线缴费。 \t*2:表示支付宝代扣缴费。 \t*3:表示当面付。 \t说明\ :如支持多种方式以 ',' 进行分隔。" example: "2" type: string payment_mode: description: 该参数废弃 example: "1" type: string shopingmall_id: description: 商圈id example: "100001008" type: string sum_space: description: 停车场车位数 example: "3000" type: string support_after_pay: description: "是否支持先离后付。枚举支持: \t*Y:支持。 \t*N:不支持。 \t说明:默认为空不支持,此参数适用于签约信用代\ 扣的商户。" example: "Y" type: string time_out: description: 用户支付未离场的超时时间(以分钟为单位) example: "13" type: string type: object AlipayEcoMycarParkingParkinglotinfoUpdateResponseModel: type: object AlipayEcoMycarParkingPaymentinfoSyncErrorResponseModel: properties: code: description: 错误码 enum: - BIZ_ERROR - INVALID_PARAMETER - SYSTEM_ERROR - RECORD_NOT_FOUND type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoMycarParkingPaymentinfoSyncModel: properties: car_number: description: 车牌号 example: 浙Axxxxx type: string isv_url: description: 停车消息透出后,消息详情的落地承接页链接,可配置ISV维度的统一值 example: http://xxxxx type: string out_serial_no: 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" type: string parking_id: description: 支付宝停车平台ID,由支付宝定义的该停车场标识,同一个isv或商户范围内唯一。通过 alipay.eco.mycar.parking.parkinglotinfo.create(录入停车场信息)接口获取。 example: "2015042321001004720200028594" type: string payment_free_minutes: description: 停车场内缴费后,允许出场的免费时长分钟数 example: 15 type: integer payment_time: description: 场内缴费时间,格式"YYYY-MM-DD HH:mm:ss",24小时制,请保证服务器时间准确,场内缴费不应晚于当前网络时间 example: 2021-06-12 15:29:55 type: string serial_no: 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" type: string type: object AlipayEcoMycarParkingPaymentinfoSyncResponseModel: type: object AlipayEcoMycarParkingSpaceinfoSyncErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - MERCHANT_VERIFY_FAILED - EMPTY_PARAMETER - PARAMETER_FORMAT_ERR - PARKING_ID_EMPTY - PARKING_FREE_SPACE_EMPTY type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoMycarParkingSpaceinfoSyncModel: properties: free_charging_pile: description: 空闲充电桩车位数 example: 30 type: integer free_parking_space: description: 车场空闲可用的车位数 example: 500 type: integer parking_id: description: 停车场ID example: PI20190506152394234234 type: string parking_space_status: description: "停车场实时状态: 0 拥堵,1 正常,2 空闲" example: "1" type: string type: object AlipayEcoMycarParkingSpaceinfoSyncResponseModel: properties: sync_result: description: 同步结果:0 成功,1 失败 example: "1" type: string type: object AlipayEcoMycarParkingVehicleQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoMycarParkingVehicleQueryResponseModel: properties: car_number: description: 车牌信息(utf-8编码) example: 川Axxxxxx type: string type: object AlipayEcoSignFlowCancelErrorResponseModel: properties: code: description: 错误码 enum: - NOT_ALLOW_REVOKE - PARAM_ERROR - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoSignFlowCancelModel: properties: flow_id: description: 流程id,通过 创建电子合同签署流程(alipay.eco.contract.signflows.create)接口获取。 example: 429b1d3038854cabbcdac0a63d7e4c0d type: string revoke_reason: description: 撤销原因,默认为"撤销"。商家可自定义。 example: 合同内容不符,拒签 type: string type: object AlipayEcoSignFlowCancelResponseModel: type: object AlipayEcoSignFlowCreateErrorResponseModel: properties: code: description: 错误码 enum: - PARAM_ERROR - SYSTEM_ERROR - SERIAL_NO_IS_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoSignFlowCreateModel: properties: attachments: description: 附件信息 items: $ref: '#/components/schemas/Attachment' type: array business_scene: description: 流程主题 example: 商品签收 type: string config_info: $ref: '#/components/schemas/ConfigInfo' template_infos: description: 模板信息 items: $ref: '#/components/schemas/TemplateInfo' type: array type: object AlipayEcoSignFlowCreateResponseModel: properties: flow_id: description: 流程Id example: 56b75290982d472b8d60133cd9a747a3 type: string type: object AlipayEcoSignFlowFinishErrorResponseModel: properties: code: description: 错误码 enum: - PARAM_ERROR - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoSignFlowFinishModel: properties: flow_id: description: 流程id example: 429b1d3038854cabbcdac0a63d7e4c0d type: string type: object AlipayEcoSignFlowFinishResponseModel: type: object AlipayEcoSignFlowQueryErrorResponseModel: properties: code: description: 错误码 enum: - PARAM_ERROR - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoSignFlowQueryResponseModel: properties: business_scene: description: 文件主题 example: 合同名称 type: string contract_validity: description: 文件有效截止日期 example: 1592386042000 type: integer flow_desc: description: "流程描述, 如果流程已拒签或已撤回, 并且存在拒签或撤回原因, 流程描述显示为原因, 否则默认为流程状态描述" example: 完成 type: string flow_end_time: description: 流程结束时间 example: 1560764486000 type: integer flow_id: description: 流程Id example: 429b1d3038854cabbcdac0a63d7e4c0d type: string flow_start_time: description: 流程开始时间 example: 1560764486000 type: integer flow_status: description: "流程状态,0-草稿 1-签署中 2-完成 3-撤销 4-终止 5-过期 6-删除 7-拒签" example: 2 type: integer notice_developer_url: description: 通知开发者地址 example: http://127.0.0.1:9110/notice type: string sign_validity: description: 签署有效截止日期 example: 1592386042000 type: integer signers: description: 签署人列表及签署状态 items: $ref: '#/components/schemas/FlowSigner' type: array type: object AlipayEcoSignflowsDetailQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - PARAM_ERROR - UNABLE_DOWNLOAD_FILE type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoSignflowsDetailQueryResponseModel: properties: attachments: $ref: '#/components/schemas/AttachmentDetail' docs: $ref: '#/components/schemas/DocInfo' type: object AlipayEcoSignflowsUrlQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - PARAM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayEcoSignflowsUrlQueryResponseModel: properties: preview_short_url: description: 预览短链地址(30天有效) example: http://testfront.tsign.cn type: string preview_url: description: 预览长链地址(永久有效) example: https://testt.tsign.cn/55vebd3omU7k type: string sign_short_url: description: 签署短链地址(30天有效) example: http://testfront.tsign.cn:8821 type: string sign_url: description: 签署长链地址(永久有效) example: https://testt.tsign.cn/55vebd3omU7k type: string type: object AlipayFundAccountQueryErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundAccountQueryResponseModel: properties: available_amount: description: 账户可用余额,单位元,精确到小数点后两位。 example: "26.45" type: string ext_card_info: $ref: '#/components/schemas/ExtCardInfo' freeze_amount: description: 当前支付宝账户的实时冻结余额 example: "11.11" type: string type: object AlipayFundAccountbookCreateErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - USER_AGREEMENT_VERIFY_FAIL - OPEN_ACCOUNT_BOOK_ERROR - MERCHANT_PRODUCT_NOT_SIGN type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundAccountbookCreateModel: properties: ext_info: description: JSON格式,传递业务扩展参数 example: "{\"agreement_no\":\"2019000000000\",\"cert_no\":\"61102619921108888\"\ }" type: string merchant_user_id: description: 外部商户系统会员的唯一标识,自定义传入 example: "10000001" type: string merchant_user_type: description: 外部商户用户类型:BUSINESS_EMPLOYEE example: BUSINESS_ORGANIZATION type: string scene_code: description: 资金记账本的业务场景 example: SATF_FUND_BOOK type: string type: object AlipayFundAccountbookCreateResponseModel: properties: account_book_id: description: 开通的资金记账本id example: "2088123412341234" type: string ext_card_info: $ref: '#/components/schemas/ExtCardInfo' type: object AlipayFundAccountbookNotifyQueryErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundAccountbookNotifyQueryResponseModel: properties: account_book_id: description: 记账本ID example: "2088000147677710" type: string code: description: 响应code。 成功为10000; 业务异常为40004; example: "10000" type: string msg: description: 响应描述。 成功为Success; 业务异常为Business Failed; example: Success type: string subscribe_status: description: 订阅关系状态, VALID:有效的; INVALID:失效的; example: VALID type: string type: object AlipayFundAccountbookNotifySubscribeErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundAccountbookNotifySubscribeModel: properties: account_book_id: description: 记账本ID example: "2088000147677710" type: string agreement_no: description: 协议号。 若是基于协议的记账本,则agreement_no必传; 若是自创建的记账本,则agreement_no不传; example: "20205724001102186227" type: string biz_scene: description: 场景码。固定为DEFAULT example: DEFAULT type: string product_code: description: 产品码。固定为SATF_FUND_BOOK example: SATF_FUND_BOOK type: string type: object AlipayFundAccountbookNotifySubscribeResponseModel: properties: account_book_id: description: 记账本ID example: 2088**********0378 type: string code: description: 响应code。 成功为10000; 业务异常为40004; example: "10000" type: string msg: description: 响应描述。 成功为Success; 业务异常为Business Failed; example: Success type: string subscribe_status: description: 订阅关系状态, VALID:有效的; INVALID:失效的; example: VALID type: string type: object AlipayFundAccountbookNotifyUnsubscribeErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundAccountbookNotifyUnsubscribeModel: properties: account_book_id: description: 记账本ID example: "2088000147677710" type: string agreement_no: description: "协议号。\t若是基于协议的记账本,则agreement_no必传;\t若是自创建的记账本,则agreement_no不\ 传;" example: "20205724001102186227" type: string biz_scene: description: 场景码。固定为DEFAULT example: DEFAULT type: string product_code: description: 产品码。固定为SATF_FUND_BOOK example: SATF_FUND_BOOK type: string type: object AlipayFundAccountbookNotifyUnsubscribeResponseModel: properties: account_book_id: description: 记账本ID example: "2088000147677710" type: string code: description: "响应code。\t成功为10000;\t业务异常为40004;" example: "10000" type: string msg: description: 响应描述。 成功为Success; 业务异常为Business Failed; example: Success type: string subscribe_status: description: "订阅关系状态, \tVALID:有效的; \tINVALID:失效的;" example: VALID type: string type: object AlipayFundAccountbookQueryErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundAccountbookQueryResponseModel: properties: account_book_id: description: 记账账簿id example: "2088001409188095" type: string auth_info: $ref: '#/components/schemas/AuthInfoDTO' available_amount: description: 可用余额 example: "26.45" type: string ext_card_info: $ref: '#/components/schemas/ExtCardInfo' type: object AlipayFundAgreementQuotaModifyErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - PRODUCT_NOT_SIGN - NOT_SUPPORT_PRODUCT_SCENE - NOT_SUPPORT_QUOTA_ROLE type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundAgreementQuotaModifyModel: properties: agreement_quota_modify_list: description: 协议额度设置信息 items: $ref: '#/components/schemas/AgreementQuotaModifyList' type: array biz_scene: description: 场景码,非固定值,使用的对应的资金场景码保持一致 example: ENTRUST_TRANSFER type: string product_code: description: 额度产品码,非固定值,使用的对应的资金产品码保持一致 example: BATCH_API_TO_ACC_NO_PWD type: string type: object AlipayFundAgreementQuotaModifyResponseModel: properties: quota_modify_detail_list: description: 额度变更结果集合 items: $ref: '#/components/schemas/QuotaModifyDetail' type: array type: object AlipayFundAgreementQuotaQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - PRODUCT_NOT_SIGN - NOT_SUPPORT_PRODUCT_SCENE type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundAgreementQuotaQueryModel: properties: agreement_no_list: description: 授权协议号 example: "[\"20205321001042231004\"]" items: type: string type: array biz_scene: description: 场景码,非固定值,使用的对应的资金场景码保持一致 example: ENTRUST_TRANSFER type: string product_code: description: 额度产品码,非固定值,使用的对应的资金产品码保持一致 example: BATCH_API_TO_ACC_NO_PWD type: string type: object AlipayFundAgreementQuotaQueryResponseModel: properties: quota_query_response_list: description: 单个协议的额度查询结果 items: $ref: '#/components/schemas/QuotaQueryResponse' type: array type: object AlipayFundAuthOperationCancelErrorResponseModel: properties: code: description: 错误码 enum: - ILLEGAL_ARGUMENT - ACCESS_FORBIDDEN - PAYER_USER_STATUS_LIMIT - ORDER_ALREADY_FINISH - CANCEL_OPERATION_TIME_OUT - REQUEST_AMOUNT_EXCEED - SYSTEM_ERROR - PAYER_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundAuthOperationCancelModel: properties: auth_no: description: "支付宝授权资金订单号。\t与商户的授权资金订单号不能同时为空,二者都传入时,以支付宝资金授权订单号为准,该参数与支付\ 宝授权资金操作流水号配对使用。" example: "2014070800002001550000014417" type: string notify_url: description: 通知地址 type: string operation_id: description: "支付宝的授权资金操作流水号。\t与商户的授权资金操作流水号不能同时为空,二者都传入时,以支付宝的授权资金操作流水号为\ 准,该参数与支付宝授权资金订单号配对使用。" example: "20161012405744018102" type: string out_order_no: description: "商户的授权资金订单号。\t与支付宝的授权资金订单号不能同时为空,二者都传入时,以支付宝的授权资金订单号为准,该参数与\ 商户的授权资金操作流水号配对使用。\t该值与资金冻结时 out_order_no一致。" example: "4977164666634053" type: string out_request_no: description: "商户的授权资金操作流水号。\t与支付宝的授权资金操作流水号不能同时为空,二者都传入时,以支付宝的授权资金操作流水号为\ 准,该参数与商户的授权资金订单号配对使用。\t该值与资金冻结时out_request_no一致" example: "2016100810000003551" type: string remark: description: "商户对本次撤销操作的附言描述。\t长度不超过100个字母或50个汉字。" example: 授权撤销 type: string type: object AlipayFundAuthOperationCancelResponseModel: properties: action: description: "本次撤销触发的资金动作\r\tclose:关闭冻结明细,无资金解冻\r\tunfreeze:产生了资金解冻" example: close type: string auth_no: description: 支付宝资金授权订单号。 example: "2016101210002001810258115912" type: string operation_id: description: 支付宝的冻结操作流水号。 example: "20161012405744018102" type: string out_order_no: description: 商户的授权资金订单号。 example: "4977164666634053" type: string out_request_no: description: 商户的冻结操作流水号 。 example: "234555553333444334" type: string type: object AlipayFundAuthOperationDetailQueryErrorResponseModel: properties: code: description: 错误码 enum: - ILLEGAL_ARGUMENT - AUTH_ORDER_NOT_EXIST - AUTH_OPERATION_NOT_EXIST - ACCESS_FORBIDDEN - SYSTEM_ERROR - ENTERPRISE_PAY_BIZ_ERROR - HAS_NO_PRIVILEGE type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundAuthOperationDetailQueryModel: properties: auth_no: description: "支付宝授权资金订单号。\t与商户的授权资金订单号不能同时为空,二者都传入时,以支付宝资金授权订单号为准,该参数与支付\ 宝授权资金操作流水号配对使用。" example: "2014021601002000640012345678" type: string operation_id: description: "支付宝的授权资金操作流水号。\t与商户的授权资金操作流水号不能同时为空,二者都传入时,以支付宝的授权资金操作流水号为\ 准,该参数与支付宝授权资金订单号配对使用。" example: "20140216010020006400" type: string operation_type: description: "需要查询的授权资金操作类型。\t未传入本参数时,如果仅查询出单笔明细则直接返回,如果查询出多笔则优先返回冻结明细、无\ 冻结明细时返回解冻明细;\t当传入本参数时,则严格按照该操作类型返回对应明细" example: FREEZE type: string out_order_no: description: "商户的授权资金订单号。\t与支付宝的授权资金订单号不能同时为空,二者都传入时,以支付宝的授权资金订单号为准,该参数与\ 商户的授权资金操作流水号配对使用。\t该值与资金冻结时 out_order_no一致。" example: "8077735255938023" type: string out_request_no: description: "商户的授权资金操作流水号。\t与支付宝的授权资金操作流水号不能同时为空,二者都传入时,以支付宝的授权资金操作流水号为\ 准,该参数与商户的授权资金订单号配对使用。\t查询冻结明细时,该值与发起冻结操作时传入的out_request_no一致;\t查询解冻明细时\ ,该值与发起解冻操作时传入的out_request_no一致;\t查询支付明细时,该值与发起转支付操作时传入的out_trade_no一致。" example: "20140216001001" type: string query_options: description: 需要查询的额外信息 example: "[\"credit_risk_info\"]" items: type: string type: array type: object AlipayFundAuthOperationDetailQueryResponseModel: properties: amount: description: 该笔资金操作流水operation_id对应的操作金额,单位为:元(人民币) example: "200.00" type: string auth_no: description: 支付宝资金授权订单号 example: "2014031600002001260000001000" type: string credit_amount: description: 该笔资金操作流水operation_id对应的操作信用金额 example: "0.01" type: string credit_merchant_ext: description: 芝麻透出给商户的信息,具体内容由商户与芝麻约定后返回 example: "{\"1003190\":\"true\"}" type: string credit_risk_info: $ref: '#/components/schemas/CreditRiskInfo' enterprise_pay_info: description: 因公付业务信息 example: "{\"biz_info\":\"{\\\"enterprisePayAmount\\\":\\\"0.01\\\"}\"}" type: string extra_param: description: 商户请求创建预授权订单时传入的扩展参数,仅返回商户自定义的扩展信息(merchantExt) example: "{\"merchantExt\":\"key1=value1,key2=value2\"}" type: string fund_amount: description: 该笔资金操作流水operation_id对应的操作自有资金金额 example: "0.01" type: string gmt_create: description: "资金授权单据操作流水创建时间,\r\t格式:YYYY-MM-DD HH:MM:SS" example: 2014-01-01 20:00:00 type: string gmt_trans: description: "支付宝账务处理成功时间,\r\t格式:YYYY-MM-DD HH:MM:SS" example: 2014-01-01 20:00:00 type: string operation_id: description: 支付宝资金操作流水号 example: "20140216355864862002" type: string operation_type: description: 支付宝资金操作类型,表示当前查询到的这笔明细的操作类型。 example: UNFREEZE type: string order_status: description: 授权单状态:INIT(初始状态:已创建未授权)、AUTHORIZED(已授权状态:授权成功,可以进行转支付或解冻操作)、FINISH(完成状态:转支付完成且无剩余冻结资金)、CLOSED(关闭状态:授权未完成超时关闭或冻结资金全额解冻) example: AUTHORIZED type: string order_title: description: 业务订单的简单描述,如商品名称等 example: 0元购土豪金 type: string out_order_no: description: 商户的授权资金订单号 example: "20140216001" type: string out_request_no: description: 商户资金操作的请求流水号 example: "20140216001001" type: string payer_logon_id: description: 付款方支付宝账号(Email或手机号),仅作展示使用,默认会加“*”号处理 example: ali*@alipay.com type: string payer_open_id: description: 支付宝openId,用户(userId)在应用(appId)下的唯一标识。 example: 03914IMEfXsS9K-tSvHy-IisrLlOfthFgDVo-hU30XtKPg9 type: string payer_user_id: description: 付款方支付宝账号对应的支付宝唯一用户号,以2088开头的16位纯数字组成 example: "2088402019148643" type: string pre_auth_type: description: 预授权类型,信用预授权情况下值为 CREDIT_AUTH,表示该笔预授权为信用预授权,实际没有冻结用户资金;其它情况均不返回该字段。 example: CREDIT_AUTH type: string remark: description: 商户对本次操作的附言描述,长度不超过100个字母或50个汉字 example: 2014-05期解冻200.00元 type: string rest_amount: description: 订单当前剩余冻结金额,单位为:元(人民币)。 example: "4600.00" type: string rest_credit_amount: description: 剩余冻结信用金额,单位为:元(人民币),精确到小数点后两位 example: "0.01" type: string rest_fund_amount: description: 剩余冻结自有资金金额,单位为:元(人民币),精确到小数点后两位 example: "0.01" type: string status: description: "资金操作流水的状态,\r\t目前支持: \r\tINIT:初始\r\tSUCCESS:成功\r\tCLOSED:关闭" example: SUCCESS type: string total_freeze_amount: description: 订单累计的冻结金额,单位为:元(人民币) example: "4800.00" type: string total_freeze_credit_amount: description: 累计冻结信用金额,单位为:元(人民币),精确到小数点后两位 example: "0.01" type: string total_freeze_fund_amount: description: 累计冻结自有资金金额,单位为:元(人民币),精确到小数点后两位 example: "0.01" type: string total_pay_amount: description: 订单累计用于支付的金额,单位为:元(人民币) example: "0.00" type: string total_pay_credit_amount: description: 累计支付信用金额,单位为:元(人民币),精确到小数点后两位 example: "0.01" type: string total_pay_fund_amount: description: 累计支付自有资金金额,单位为:元(人民币),精确到小数点后两位 example: "0.01" type: string trans_currency: description: "标价币种, amount 对应的币种单位。支持澳元:AUD, 新西兰元:NZD, 台币:TWD, 美元:USD,\ \ 欧元:EUR, 英镑:GBP" example: USD type: string type: object AlipayFundAuthOrderAppFreezeErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundAuthOrderAppFreezeModel: properties: amount: description: "需要冻结的金额,单位为:元(人民币),精确到小数点后两位。\t取值范围:[0.01,100000000.00]" example: "0.01" type: string business_params: description: 业务参数,如风控参数outRiskInfo等。 example: "{\"outRiskInfo\":\"{\\\"mcCreateTradeTime\\\":\\\"2022-03-11 12:46:09\\\ \",\\\"extraAccountCertnoLastSix\\\":\\\"000011\\\",\\\"mobileOperatingPlatform\\\ \":\\\"ios\\\",\\\"sysVersion\\\":\\\"15.4.2\\\",\\\"mcCreateTradeIp\\\ \":\\\"11.110.111.43\\\"}\"}" type: string deposit_product_mode: description: "免押受理台模式,使用免押产品必传该字段。根据免押不同业务模式将开通受理台区分三种模式,商家可根据调用预授权冻结接口传\ 入的参数决定该笔免押订单选择哪种受理台模式。不同受理台模式需要传入不同参数,其中:POSTPAY 表示后付金额已知,POSTPAY_UNCERTAIN\ \ 表示后付金额未知,DEPOSIT_ONLY 表示纯免押。\t具体规则参考文档:https://opendocs.alipay.com/b/08tf3t?pathHash=d67d7545" example: POSTPAY type: string disable_pay_channels: description: "无特殊需要请勿传入;商户可用该参数禁用支付渠道。\t传入后用户不可使用列表中的渠道进行支付,目前支持两种禁用渠道:信\ 用卡快捷(OPTIMIZED_MOTO)、信用卡卡通(BIGAMOUNT_CREDIT_CARTOON)。与可用支付渠道不能同时传入" example: "[{\"payChannelType\":\"OPTIMIZED_MOTO\"},{\"payChannelType\":\"\ BIGAMOUNT_CREDIT_CARTOON\"}]" type: string enable_pay_channels: description: "无特殊需要请勿传入;商户可用该参数指定支付渠道。\t传入后用户仅能使用列表中的渠道进行支付,目前支持三种渠道,余额宝\ (MONEY_FUND)、花呗(PCREDIT_PAY)以及芝麻信用(CREDITZHIMA)。与禁用支付渠道不可同时传入" example: "[{\"payChannelType\":\"PCREDIT_PAY\"},{\"payChannelType\":\"MONEY_FUND\"\ }]" type: string extra_param: description: "业务扩展参数,用于特定业务信息的传递,json格式。\t1、category,信用类目,信用预授权场景必传,具体类目\ 信息见https://opendocs.alipay.com/open/10719;\ \t2、serviceId,信用服务ID:信用预授权场景必传。需要商家在 开放平台-芝麻免押-信用服务管理 创建信用服务获取,详情可查看 创建信用服务。在创建过程中如果有其它疑问,可以咨询芝麻客服小二(0571-88158055 转 2);\t3、creditExtInfo,\ 信用参数,可选,如有需要请与芝麻约定后传入,信用服务说明见https://opendocs.alipay.com/open/11157/qlsxya" example: "{\"category\":\"CHARGE_PILE_CAR\",\"serviceId\":\"2020042800000000000001450466\"\ }" type: string identity_params: description: "无特殊需要请勿传入;买家实名信息。\t传入后支付宝会比对买家在支付宝端的实名信息。包含两个可选key:\t1.identity_hash,\ 买家姓名拼接身份证号后,使用SHA256摘要方式与UTF8编码后的hash值,返回的十六进制字符串,例如 “张三4566498798498498498498”\ 对应的identity_hash应为“acc2b92ffc5ed9b472faa19748f10045c30434132784f774b00216a56b8841c6”\ \t2.alipay_user_id,买家uid" example: "{\"identity_hash\":\"acc2b92ffc5ed9b472faa19748f10045c30434132784f774b00216a56b8841c6\"\ }" type: string notify_url: description: 通知地址 type: string order_title: description: "订单标题。\t业务订单的简单描述,如商品名称等" example: XX租车押金 type: string out_order_no: description: "商户授权资金订单号。\t商家自定义需保证在商户端不重复。仅支持字母、数字、下划线。" example: "8077735255938023" type: string out_request_no: description: "商户本次资金操作的请求流水号,用于标示请求流水的唯一性。\t可与out_order_no相同,仅支持字母、数字、下划\ 线。" example: "8077735255938032" type: string pay_timeout: description: "预授权订单相对超时时间。从商户客户端请求时间开始计算。\t预授权订单允许的最晚授权时间,逾期将关闭该笔订单。取值范围\ :1m~15d。m-分钟,h-小时,d-天。 该参数数值不接受小数点, 如 1.5h,可转换为90m。\t默认为15m。" example: 2d type: string payee_logon_id: description: "收款账户的支付宝登录号(email或手机号)。\t如果传入则会校验该登录号对应的账号是否具备当前商户收款权限,如果商\ 户希望用户能够使用花呗,则用户号(payee_user_id)和登录号(payee_logon_id)两者必须传入其一" example: 159****5620 type: string payee_user_id: description: "收款账户的支付宝用户号。\t以2088开头的16位纯数字,如果传入则会校验该账号是否具备当前商户收款权限,如果商户希\ 望用户能够使用花呗,则用户号(payee_user_id)和登录号(payee_logon_id)两者必须传入其一" example: "2088102000275795" type: string post_payments: description: "后付费项目, 有付费项目时需要传入该字段。不同受理台模式需要传入不同参数,后付费项目名称和计费说明需要通过校验规则,\ 同时计费说明将展示在开通受理台上。当受理台模式(deposit_product_mode)传入POSTPAY 时,后付费项目名称(name)\ 、金额(amount)必传,计费说明(description)选传;当传入 POSTPAY_UNCERTAIN 时,后付费项目名称(name)\ 、计费说明(description)必传,金额(amount)不传。\t具体规则参考文档:\thttps://opendocs.alipay.com/b/08tf3t?pathHash=d67d7545" items: $ref: '#/components/schemas/PostPayment' type: array product_code: description: "销售产品码。\t支付宝预授权产品固定为 PRE_AUTH_ONLINE" example: PRE_AUTH_ONLINE type: string scene_code: 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 type: string settle_currency: description: "商户指定的结算币种。支持澳元:AUD, 新西兰元:NZD, 台币:TWD, 美元:USD, 欧元:EUR, 英镑:\ GBP" example: USD type: string timeout_express: description: "预授权订单相对超时时间。从商户客户端请求时间开始计算。\t预授权订单允许的最晚授权时间,逾期将关闭该笔订单。取值范围\ :1m~15d。m-分钟,h-小时,d-天。 该参数数值不接受小数点, 如 1.5h,可转换为90m。\t默认为15m。" example: 2d type: string trans_currency: description: "标价币种, amount 对应的币种单位。支持澳元:AUD, 新西兰元:NZD, 台币:TWD, 美元:USD,\ \ 欧元:EUR, 英镑:GBP, 人民币:CNY" example: USD type: string type: object AlipayFundAuthOrderAppFreezeResponseModel: properties: amount: description: 本次操作冻结的金额,单位为:元(人民币),精确到小数点后两位 example: "0.01" type: string auth_no: description: 支付宝的资金授权订单号 example: "2014070800002001550000014417" type: string credit_amount: description: 本次冻结操作中信用冻结金额,单位为:元(人民币),精确到小数点后两位 example: "0.01" type: string fund_amount: description: 本次冻结操作中自有资金冻结金额,单位为:元(人民币),精确到小数点后两位 example: "0.01" type: string gmt_trans: description: "资金授权成功时间\r\t格式:YYYY-MM-DD HH:MM:SS" example: 2014-09-15 11:23:04 type: string operation_id: description: 支付宝的资金操作流水号 example: "2014070800032850551" type: string orderStr: description: 获取签名后的业务数据 example: 请参考响应示例 type: string out_order_no: description: 商户的授权资金订单号 example: "4977164666634053" type: string out_request_no: description: 商户本次资金操作的请求流水号 example: "2014070700166653" type: string payer_open_id: description: 支付宝openId,用户(userId)在应用(appId)下的唯一用户标识。 example: 03914IMEfXsS9K-tSvHy-IisrLlOfthFgDVo-hU30XtKPg9 type: string payer_user_id: description: 付款方支付宝用户号 example: "2088102000275885" type: string pre_auth_type: description: "预授权类型,目前支持 CREDIT_AUTH(信用预授权);\r\t商户可根据该标识来判断该笔预授权的类型,当返回值\ 为\"CREDIT_AUTH\"表明该笔预授权为信用预授权,没有真实冻结资金;当返回值为空或者不为\"CREDIT_AUTH\"则表明该笔预\ 授权为普通资金预授权,会冻结用户资金。" example: CREDIT_AUTH type: string status: description: "资金预授权明细的状态\r\t目前支持: \r\tINIT:初始\r\tSUCCESS: 成功\r\tCLOSED:\ 关闭" example: SUCCESS type: string trans_currency: description: "标价币种, amount 对应的币种单位。支持澳元:AUD, 新西兰元:NZD, 台币:TWD, 美元:USD,\ \ 欧元:EUR, 英镑:GBP, 人民币:CNY" example: USD type: string type: object AlipayFundAuthOrderFreezeErrorResponseModel: properties: code: 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_ORGANIZATION_ID_ERROR - SUB_MERCHANT_LEVEL_ERROR - SUB_MERCHANT_NO_PERMISSION - MERCHANT_STATUS_ERROR - UNSUPPORTED_BIZ_TYPE - SMILE_PRE_AUTH_ZM_CONSULT_FAIL - USER_BANKCARD_CANCELED - USER_BANKCARD_EXPRESS_ERROR - USER_BANKCARD_FROZEN - USER_BANKCARD_PAY_ERROR - USER_BANKCARD_REPORT_LOSS - ILLEGAL_PAYEE_USER_ID - USER_BANKCARD_STATUS_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundAuthOrderFreezeModel: properties: amount: description: "需要冻结的金额,单位为:元(人民币),精确到小数点后两位。\t取值范围:[0.01,100000000.00]" example: "0.01" type: string auth_code: description: "用户付款码。\t1.条码场景:25~30开头的长度为16~24位的数字,实际字符串长度以开发者获取的付款码长度为准;\ \t2.刷脸场景:\t1)fp开头的35位字符串;\t2)300-700字符的随机字符串;\t注:刷脸场景考虑到未来可能拓展更多格式,建议外\ 围不必做规则拦截,由支付宝统一做有效性校验" example: |- 付款码场景:28763443825664394, 刷脸场景1)示例:fp1394da8bfc3e299a2128b8bda17456h84 type: string auth_code_type: description: "付款码类型。\t1.条码场景:bar_code\t2.刷脸场景:security_code" example: bar_code type: string business_params: description: 业务参数,如风控参数outRiskInfo等。 example: "{\"outRiskInfo\":\"{\\\"mcCreateTradeTime\\\":\\\"2022-03-11 12:46:09\\\ \",\\\"extraAccountCertnoLastSix\\\":\\\"000011\\\",\\\"mobileOperatingPlatform\\\ \":\\\"ios\\\",\\\"sysVersion\\\":\\\"15.4.2\\\",\\\"mcCreateTradeIp\\\ \":\\\"11.110.111.43\\\"}\"}" type: string deposit_product_mode: description: "免押受理台模式,使用免押产品必传该字段。根据免押不同业务模式将开通受理台区分三种模式,商家可根据调用预授权冻结接口传\ 入的参数决定该笔免押订单选择哪种受理台模式。不同受理台模式需要传入不同参数,其中:POSTPAY 表示后付金额已知,POSTPAY_UNCERTAIN\ \ 表示后付金额未知,DEPOSIT_ONLY 表示纯免押。\t具体规则参考文档:https://opendocs.alipay.com/b/08tf3t?pathHash=d67d7545" example: POSTPAY type: string disable_pay_channels: description: "无特殊需要请勿传入;商户可用该参数禁用支付渠道。\t传入后用户不可使用列表中的渠道进行支付,目前支持两种禁用渠道:信\ 用卡快捷(OPTIMIZED_MOTO)、信用卡卡通(BIGAMOUNT_CREDIT_CARTOON)。与可用支付渠道不能同时传入" example: "[{\"payChannelType\":\"OPTIMIZED_MOTO\"},{\"payChannelType\":\"\ BIGAMOUNT_CREDIT_CARTOON\"}]" type: string enable_pay_channels: description: "无特殊需要请勿传入;商户可用该参数指定支付渠道。\t传入后用户仅能使用列表中的渠道进行支付,目前支持三种渠道,余额宝\ (MONEY_FUND)、花呗(PCREDIT_PAY)以及芝麻信用(CREDITZHIMA)。与禁用支付渠道不可同时传入" example: "[{\"payChannelType\":\"PCREDIT_PAY\"},{\"payChannelType\":\"MONEY_FUND\"\ }]" type: string extra_param: description: "业务扩展参数,用于特定业务信息的传递,json格式。\t1、category,信用类目,信用预授权场景必传,具体类目\ 信息见https://opendocs.alipay.com/open/10719;\ \t2、serviceId,信用服务ID:信用预授权场景必传。需要商家在 开放平台-芝麻免押-信用服务管理 创建信用服务获取,详情可查看 创建信用服务。在创建过程中如果有其它疑问,可以咨询芝麻客服小二(0571-88158055 转 2);\t3、creditExtInfo,\ 信用参数,可选,如有需要请与芝麻约定后传入,信用服务说明见https://opendocs.alipay.com/open/11157/qlsxya" example: "{\"category\":\"CHARGE_PILE_CAR\",\"serviceId\":\"2020042800000000000001450466\"\ }" type: string identity_params: 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\"\ }" type: string notify_url: description: 通知地址 type: string order_title: description: "订单标题。\t业务订单的简单描述,如商品名称等" example: XX租车押金 type: string out_order_no: description: "商户授权资金订单号。\t商家自定义需保证在商户端不重复。仅支持字母、数字、下划线。" example: "8077735255938023" type: string out_request_no: description: "商户本次资金操作的请求流水号,用于标示请求流水的唯一性。\t可与out_order_no相同,仅支持字母、数字、下划\ 线。" example: "8077735255938032" type: string pay_timeout: description: "预授权订单相对超时时间,从商户请求时间开始计算。\t预授权订单允许的最晚授权时间,逾期将关闭该笔订单。取值范围:1m~\ 15d。m-分钟,h-小时,d-天。 该参数数值不接受小数点, 如 1.5h,可转换为90m。\t默认为15m。" example: 2d type: string payee_logon_id: description: "收款账户的支付宝登录号(email或手机号)。\t如果传入则会校验该登录号对应的账号是否具备当前商户收款权限,如果商\ 户希望用户能够使用花呗,则用户号(payee_user_id)和登录号(payee_logon_id)两者必须传入其一" example: 159****5620 type: string payee_user_id: description: "收款账户的支付宝用户号。\t以2088开头的16位纯数字,如果传入则会校验该账号是否具备当前商户收款权限,如果商户希\ 望用户能够使用花呗,则用户号(payee_user_id)和登录号(payee_logon_id)两者必须传入其一" example: "2088102000275795" type: string post_payments: description: "后付费项目, 有付费项目时需要传入该字段。不同受理台模式需要传入不同参数,后付费项目名称和计费说明需要通过校验规则,\ 同时计费说明将展示在开通受理台上。当受理台模式(deposit_product_mode)传入POSTPAY 时,后付费项目名称(name)\ 、金额(amount)必传,计费说明(description)选传;当传入 POSTPAY_UNCERTAIN 时,后付费项目名称(name)\ 、计费说明(description)必传,金额(amount)不传。\t具体规则参考文档:\thttps://opendocs.alipay.com/b/08tf3t?pathHash=d67d7545" items: $ref: '#/components/schemas/PostPayment' type: array product_code: description: "销售产品码。\t当面资金预授权固定为 PRE_AUTH" example: PRE_AUTH type: string scene_code: description: "场景码。\t刷脸场景下传入HOTEL,其他情况下无需传入" example: HOTEL type: string settle_currency: description: "商户指定的结算币种。支持澳元:AUD, 新西兰元:NZD, 台币:TWD, 美元:USD, 欧元:EUR, 英镑:\ GBP" example: USD type: string terminal_params: 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\"\ }" type: string timeout_express: description: "预授权订单相对超时时间,从商户请求时间开始计算。\t预授权订单允许的最晚授权时间,逾期将关闭该笔订单。取值范围:1m~\ 15d。m-分钟,h-小时,d-天。 该参数数值不接受小数点, 如 1.5h,可转换为90m。\t默认为15m。" example: 2d type: string trans_currency: description: "标价币种, amount 对应的币种单位。支持澳元:AUD, 新西兰元:NZD, 台币:TWD, 美元:USD,\ \ 欧元:EUR, 英镑:GBP" example: USD type: string type: object AlipayFundAuthOrderFreezeResponseModel: properties: amount: description: 本次操作冻结的金额,单位为:元(人民币),精确到小数点后两位 example: "0.01" type: string auth_no: description: 支付宝的资金授权订单号 example: "2014070800002001550000014417" type: string credit_amount: description: 本次冻结操作中信用冻结金额,单位为:元(人民币),精确到小数点后两位 example: "0.01" type: string fund_amount: description: 本次冻结操作中自有资金冻结金额,单位为:元(人民币),精确到小数点后两位 example: "0.01" type: string gmt_trans: description: "资金授权成功时间\r\t格式:YYYY-MM-DD HH:MM:SS" example: 2014-09-15 11:23:04 type: string operation_id: description: 支付宝的资金操作流水号 example: "2014070800032850551" type: string out_order_no: description: 商户的授权资金订单号 example: "4977164666634053" type: string out_request_no: description: 商户本次资金操作的请求流水号 example: "2014070700166653" type: string payer_logon_id: description: 付款方支付宝账号(Email或手机号) example: test***@alitest.com type: string payer_open_id: description: 支付宝openId,用户(userId)在应用(appId)下的唯一用户标识。 example: 03914IMEfXsS9K-tSvHy-IisrLlOfthFgDVo-hU30XtKPg9 type: string payer_user_id: description: 付款方支付宝用户号 example: "2088102000275885" type: string pre_auth_type: description: "预授权类型,目前支持 CREDIT_AUTH(信用预授权);\r\t商户可根据该标识来判断该笔预授权的类型,当返回值\ 为\"CREDIT_AUTH\"表明该笔预授权为信用预授权,没有真实冻结资金;当返回值为空或者不为\"CREDIT_AUTH\"则表明该笔预\ 授权为普通资金预授权,会冻结用户资金。" example: CREDIT_AUTH type: string status: description: "资金预授权明细的状态\r\t目前支持: \r\tINIT:初始\r\tSUCCESS: 成功\r\tCLOSED:\ 关闭" example: SUCCESS type: string trans_currency: description: "标价币种, amount 对应的币种单位。支持澳元:AUD, 新西兰元:NZD, 台币:TWD, 美元:USD,\ \ 欧元:EUR, 英镑:GBP" example: USD type: string type: object AlipayFundAuthOrderUnfreezeErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundAuthOrderUnfreezeModel: properties: amount: description: "本次操作解冻的金额,单位为:元(人民币),精确到小数点后两位。\t取值范围:[0.01,100000000.00]" example: "20.11" type: string auth_no: description: 支付宝资金授权订单号。 example: "2016101210002001810258115912" type: string extra_param: description: "解冻扩展信息。map的json格式,目前支持如下key:\tunfreezeBizInfo:\ 由芝麻消费,当前支持value如下:\t\"bizComplete\":\"true\"——标识本次解冻用户已履约,true表示信用单履约完\ 结" example: "{\"unfreezeBizInfo\": \"{\\\"bizComplete\\\":\\\"true\\\"}\"}" type: string notify_url: description: 通知地址 type: string out_request_no: description: "解冻请求流水号。\t如果是针对同一笔授权单不同的解冻请求,如第一次解冻1元,第二次解冻2元,则解冻请求流水号必须不重\ 复;\t如果是针对同一笔解冻请求的多次发起,则需要保证每次发起,解冻请求流水号和解冻金额都相同" example: "2016101200104001110081001" type: string remark: description: 商户对本次解冻操作的附言描述 example: 2014-05期解冻200.00元 type: string type: object AlipayFundAuthOrderUnfreezeResponseModel: properties: amount: description: "本次操作解冻的金额,单位为:元(人民币),精确到小数点后两位,取值范围:[0.01,100000000.00]" example: "20.81" type: string auth_no: description: 支付宝资金授权订单号 example: "2014070800002001550000014417" type: string credit_amount: description: 本次解冻操作中信用解冻金额,单位为:元(人民币),精确到小数点后两位 example: "0.01" type: string fund_amount: description: 本次解冻操作中自有资金解冻金额,单位为:元(人民币),精确到小数点后两位 example: "0.01" type: string gmt_trans: description: 授权资金解冻成功时间,格式:YYYY-MM-DD HH:MM:SS example: 2014-09-15 11:23:04 type: string operation_id: description: 支付宝资金操作流水号 example: "2014070800032850551" type: string out_order_no: description: 商户的授权资金订单号 example: "4977164666634053" type: string out_request_no: description: 商户本次资金操作的请求流水号 example: "20140707001555633" type: string status: description: "资金操作流水的状态\t目前支持:SUCCESS:成功" example: SUCCESS type: string type: object AlipayFundAuthOrderVoucherCreateErrorResponseModel: properties: code: 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_ORGANIZATION_ID_ERROR - SUB_MERCHANT_LEVEL_ERROR - SUB_MERCHANT_NO_PERMISSION - MERCHANT_STATUS_ERROR - UNSUPPORTED_BIZ_TYPE - ILLEGAL_PAYEE_USER_ID type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundAuthOrderVoucherCreateModel: properties: amount: description: "需要冻结的金额,单位为:元(人民币),精确到小数点后两位。\t取值范围:[0.01,100000000.00]" example: "100.00" type: string business_params: description: 业务参数,如风控参数outRiskInfo等。 example: "{\"outRiskInfo\":\"{\\\"mcCreateTradeTime\\\":\\\"2022-03-11 12:46:09\\\ \",\\\"extraAccountCertnoLastSix\\\":\\\"000011\\\",\\\"mobileOperatingPlatform\\\ \":\\\"ios\\\",\\\"sysVersion\\\":\\\"15.4.2\\\",\\\"mcCreateTradeIp\\\ \":\\\"11.110.111.43\\\"}\"}" type: string deposit_product_mode: description: "免押受理台模式,使用免押产品必传该字段。根据免押不同业务模式将开通受理台区分三种模式,商家可根据调用预授权冻结接口传\ 入的参数决定该笔免押订单选择哪种受理台模式。不同受理台模式需要传入不同参数,其中:POSTPAY 表示后付金额已知,POSTPAY_UNCERTAIN\ \ 表示后付金额未知,DEPOSIT_ONLY 表示纯免押。\t具体规则参考文档:https://opendocs.alipay.com/b/08tf3t?pathHash=d67d7545" example: POSTPAY type: string disable_pay_channels: description: "无特殊需要请勿传入;商户可用该参数禁用支付渠道。\t传入后用户不可使用列表中的渠道进行支付,目前支持两种禁用渠道:信\ 用卡快捷(OPTIMIZED_MOTO)、信用卡卡通(BIGAMOUNT_CREDIT_CARTOON)。与可用支付渠道不能同时传入" example: "[{\"payChannelType\":\"OPTIMIZED_MOTO\"},{\"payChannelType\":\"\ BIGAMOUNT_CREDIT_CARTOON\"}]" type: string enable_pay_channels: description: "无特殊需要请勿传入;商户可用该参数指定支付渠道。\t传入后用户仅能使用列表中的渠道进行支付,目前支持三种渠道,余额宝\ (MONEY_FUND)、花呗(PCREDIT_PAY)以及芝麻信用(CREDITZHIMA)。与禁用支付渠道不可同时传入" example: "[{\"payChannelType\":\"PCREDIT_PAY\"},{\"payChannelType\":\"MONEY_FUND\"\ }]" type: string extra_param: description: 业务扩展参数,用于特定业务信息的传递,json格式。 1、category,信用类目,信用预授权场景必传,具体类目信息见https://opendocs.alipay.com/open/10719; 2、serviceId,信用服务ID:信用预授权场景必传。需要商家在 开放平台-芝麻免押-信用服务管理 创建信用服务获取,详情可查看 创建信用服务。在创建过程中如果有其它疑问,可以咨询芝麻客服小二(0571-88158055 转 2); 3、creditExtInfo,信用参数,可选,如有需要请与芝麻约定后传入,信用服务说明见https://opendocs.alipay.com/open/11157/qlsxya example: "{\"category\":\"CHARGE_PILE_CAR\",\"serviceId\":\"2020042800000000000001450466\"\ }" type: string identity_params: 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\"}" type: string notify_url: description: 通知地址 type: string order_title: description: "订单标题。\t业务订单的简单描述,如商品名称等" example: 预授权发码 type: string out_order_no: description: "商户授权资金订单号。\t商家自定义需保证在商户端不重复。仅支持字母、数字、下划线。" example: "8077735255938023" type: string out_request_no: description: "商户本次资金操作的请求流水号,用于标示请求流水的唯一性。\t可与out_order_no相同,仅支持字母、数字、下划\ 线。" example: "8077735255938032" type: string pay_timeout: description: "预授权订单相对超时时间,从商户请求时间开始计算。\t预授权订单允许的最晚授权时间,逾期将关闭该笔订单。取值范围:1m~\ 15d。m-分钟,h-小时,d-天。 该参数数值不接受小数点, 如 1.5h,可转换为90m。\t默认为15m。" example: 2d type: string payee_logon_id: description: "收款账户的支付宝登录号(email或手机号)。\t如果传入则会校验该登录号对应的账号是否具备当前商户收款权限,如果商\ 户希望用户能够使用花呗,则用户号(payee_user_id)和登录号(payee_logon_id)两者必须传入其一,二者无需同时传入" example: 159****5620 type: string payee_user_id: description: "收款账户的支付宝用户号。\t以2088开头的16位纯数字,如果传入则会校验该账号是否具备当前商户收款权限,如果商户希\ 望用户能够使用花呗,则用户号(payee_user_id)和登录号(payee_logon_id)两者必须传入其一,二者无需同时传入" example: "2088102000275795" type: string post_payments: description: "后付费项目,有付费项目时需要传入该字段。不同受理台模式需要传入不同参数,后付费项目名称和计费说明需要通过校验规则,同\ 时计费说明将展示在开通受理台上。当受理台模式(deposit_product_mode)传入POSTPAY 时,后付费项目名称(name)、\ 金额(amount)必传,计费说明(description)选传;当传入 POSTPAY_UNCERTAIN 时,后付费项目名称(name)\ 、计费说明(description)必传,金额(amount)不传。\t具体规则参考文档:https://opendocs.alipay.com/b/08tf3t?pathHash=d67d7545" items: $ref: '#/components/schemas/PostPayment' type: array product_code: description: "销售产品码。\t当面资金预授权固定为 PRE_AUTH" example: PRE_AUTH type: string settle_currency: description: "商户指定的结算币种。支持澳元:AUD, 新西兰元:NZD, 台币:TWD, 美元:USD, 欧元:EUR, 英镑:\ GBP" example: USD type: string timeout_express: description: "预授权订单相对超时时间,从商户请求时间开始计算。\t预授权订单允许的最晚授权时间,逾期将关闭该笔订单。取值范围:1m~\ 15d。m-分钟,h-小时,d-天。 该参数数值不接受小数点, 如 1.5h,可转换为90m。\t默认为15m。" example: 2d type: string trans_currency: description: "标价币种, amount 对应的币种单位。支持澳元:AUD, 新西兰元:NZD, 台币:TWD, 美元:USD,\ \ 欧元:EUR, 英镑:GBP" example: USD type: string type: object AlipayFundAuthOrderVoucherCreateResponseModel: properties: code_type: description: "码类型,分为 barCode:条形码 (一维码) 和 qrCode:二维码(qrCode) ;\r\t目前发码只支\ 持 qrCode" example: qrCode type: string code_url: description: "生成的带有支付宝logo的二维码地址,如:http://mobilecodec.alipay.com/show.htm?code=aeparsv2dknkqf3018556a;\ 商户端通过在末尾追加picSize来指定要显示的图片大小,如\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 type: string code_value: description: 当前发码请求生成的二维码码串,商户端可以利用二维码生成工具根据该码串值生成对应的二维码 example: https://qr.alipay.com/aax017928umnzqo0uswmzd3 type: string out_order_no: description: 商户的授权资金订单号 example: "8077735255938023" type: string out_request_no: description: 商户本次资金操作的请求流水号 example: "8077735255938032" type: string type: object AlipayFundEnterprisepayGroupAddErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundEnterprisepayGroupAddModel: properties: account_id: description: 企业签约账户ID example: "2088888888" type: string agreement_no: description: 平台和企业的三方授权协议号 example: "1231231321323" type: string biz_scene: description: 场景码,联系支付宝分配 example: ANT_GROUP type: string fund_ext_info: $ref: '#/components/schemas/FundExtInfo' name: description: 群组名称 example: 后勤组 type: string out_biz_no: description: 外部业务号,外部群组号 example: "12312313" type: string product_code: description: "产品码,默认值\tENTERPRISE_PAY" example: ENTERPRISE_PAY type: string type: object AlipayFundEnterprisepayGroupAddResponseModel: properties: account_id: description: 因公付账户ID example: "2088123123" type: string fund_group_id: description: 资金群组号 example: "2088123123" type: string out_group_id: description: 外部群组号,业务号 example: out_001 type: string type: object AlipayFundEnterprisepayGroupDeleteErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundEnterprisepayGroupDeleteResponseModel: type: object AlipayFundEnterprisepayGroupModifyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundEnterprisepayGroupModifyModel: properties: account_id: description: 企业签约账户ID example: "2088888888" type: string agreement_no: description: 平台和企业的三方授权协议号 example: "1231231321323" type: string biz_scene: description: 场景码,联系支付宝分配 example: ANT_GROUP type: string fund_ext_info: $ref: '#/components/schemas/FundExtInfo' name: description: 群组名称 example: 后勤组 type: string operation_type_list: description: "更新操作类型:多个时逗号分隔\tNAME-群组名称\tFUND-出资信息\t字段不传时,默认全量更新" example: "[\"NAME\",\"FUND\"]" items: type: string type: array out_biz_no: description: 外部业务号 example: "12123123" type: string product_code: description: "产品码,默认值\tENTERPRISE_PAY" example: ENTERPRISE_PAY type: string type: object AlipayFundEnterprisepayGroupModifyResponseModel: type: object AlipayFundEnterprisepayGroupQueryErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundEnterprisepayGroupQueryResponseModel: properties: account_id: description: 企业签约账户ID example: "2088888888" type: string fund_group_id: description: 内部群组号 example: "2088888888" type: string fund_identity: description: 该群所对应的出资主体账号 example: "20888888" type: string group_name: description: 群组名称 example: 群组 type: string out_group_id: description: 外部群组号 example: "1231231" type: string type: object AlipayFundEnterprisepayMemberModifyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundEnterprisepayMemberModifyModel: properties: account_id: description: 企业签约账户ID example: "2088888888" type: string agreement_no: description: 平台和企业的三方授权协议号 example: "1231231321323" type: string biz_scene: description: 场景码,联系支付宝分配 example: ANT_GROUP type: string fund_ext_info: $ref: '#/components/schemas/FundExtInfo' group_id_list: description: 员工当前关联的群组ID,支持多个 example: "[\"11\",\"22\",\"33\"]" items: type: string type: array open_id: description: 蚂蚁统一会员openId example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string operation_type_list: description: "更新操作类型:多个时逗号分隔\tGROUP-群组信息\tFUND-出资信息\t字段不传时,默认全量更新" example: "[\"GROUP\",\"FUND\"]" items: type: string type: array product_code: description: "产品码,默认值\tENTERPRISE_PAY" example: ENTERPRISE_PAY type: string user_id: description: 蚂蚁统一会员ID example: "2088123123" type: string type: object AlipayFundEnterprisepayMemberModifyResponseModel: type: object AlipayFundEnterprisepaySignErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundEnterprisepaySignModel: properties: account_name: description: 企业简称,传空采用默认规则命名,使用公司名称 example: Anonymity type: string appoint_sign_terminal: description: "指定签约终端类型\tPC-电脑浏览器\tMOBILE-手机端" example: PC type: string biz_scene: description: 业务场景,联系支付宝分配 example: DEFAULT type: string ext_params: description: 特殊场景下扩展字段 example: "\"{\\\"key\\\":\\\"value\\\"}\"" type: string identity: 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 type: string identity_name: description: 开户用户名称,identity_type为ALIPAY_LOGON_ID时必填 example: 张三 type: string identity_type: description: "账号类型,目前支持如下类型:\t1、ALIPAY_USER_ID 支付宝的会员ID\t2、ALIPAY_LOGON_ID:\ 支付宝登录号,支持邮箱和手机号格式\t3、OUT_USER_ID:外部用户uid" example: ALIPAY_LOGON_ID type: string out_biz_no: description: "商户侧单号(幂等字段)\t,补充说明:幂等逻辑(商户appid+out_biz_no),商户集成时需注意,如换号重复\ 发起,则认为是一笔新的请求" example: "1650353507572" type: string out_entity_id: description: 外部实体ID,一般表述为外部操作人操作某个外部实体。比如企业码2284号 example: "2488888888" type: string out_source: description: ISV平台定义的共同账户开户来源 example: DINGDING type: string product_code: description: 产品码 example: ENTERPRISE_PAY type: string type: object AlipayFundEnterprisepaySignResponseModel: properties: sign_token: description: 签约凭证 example: signToken type: string sign_url: description: 签约链接,用于跳转到开户页面 example: http://business-site-default.dev.alipay.net/page/EnterprisePay/Account?signToken=12324 type: string type: object AlipayFundEnterprisepayUnsignErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundEnterprisepayUnsignModel: properties: account_id: description: 企业账号 example: 2088xxx type: string agreement_no: description: 授权协议号 example: 2088xxx type: string biz_scene: description: 业务场景 example: ISV_ALIYUN type: string product_code: description: 销售产品码 example: ENTERPRISE_PAY type: string type: object AlipayFundEnterprisepayUnsignResponseModel: properties: unsign_token: description: 解约凭证 example: 700e15fc014d463eb84600676f1976b4 type: string unsign_url: description: 解约链接 example: http://business-site-default.dev.alipay.net/page/EnterprisePay/Account?unsignToken=12324 type: string type: object AlipayFundJointaccountBillQueryErrorResponseModel: properties: code: description: 错误码 enum: - PRODUCT_NOT_SIGN - AGREEMENT_IS_INVALID - ILLEGAL_ARGUMENT - START_AFTER_END_DATE - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundJointaccountBillQueryResponseModel: properties: bill_list: description: 返回账单列表。账单列表为空时,返回为空 items: $ref: '#/components/schemas/JointAccountBillDetailDTO' type: array biz_scene: description: 场景 example: DEFAULT type: string has_next_page: description: 是否有下一页 example: true type: boolean page_num: description: 当期页数 example: "1" type: string page_size: description: 当期页记录数 example: "10" type: string product_code: description: 产品码 example: ENTERPRISE_PAY type: string type: object AlipayFundJointaccountDetailQueryErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundJointaccountDetailQueryResponseModel: properties: account_id: description: 合花群ID(支付宝侧生成) example: 2088xxx type: string account_name: description: 账户名称(支付宝侧生成) example: 企业代付 type: string account_quota: description: 额度模型 items: $ref: '#/components/schemas/JointAccountQuotaRespDTO' type: array account_status: description: "账户状态
\t-NORMAL:正常
\t-RELEASING:注销中
\t-RELEASED:已注\ 销
\t- FREEZE:冻结" example: NORMAL type: string agreement_no: description: 授权协议号(支付宝侧生成) example: 2088xxx type: string authorized_rule: $ref: '#/components/schemas/AuthorizedRuleDTO' available_balance: description: 当前可用金额(单位为元,必须大于0且最多小数点后两位) example: "13.14" type: string biz_scene: description: 业务场景码 example: DEFAULT type: string creator_id: description: (创建人)支付宝侧用户唯一标识 example: "2088900976740001" type: string creator_open_id: description: (创建人)支付宝侧用户唯一标识 example: 095PJtAPYb2Uk type: string creator_out_id: description: "(创建人)商户侧用户唯一标识
\t补充说明:
\t-如果签约时,发起人标识传递的是商户侧用户唯一标识,则\ 该字段会返回
\t-如果签约时,发起人标识传递的是支付宝侧用户唯一标识,则该字段为空" example: "12345678" type: string freeze_balance: description: 当前冻结金额(单位为元,必须大于0且最多小数点后两位) example: "5.20" type: string invite_result_list: description: 签约时邀请的成员列表(快照) items: $ref: '#/components/schemas/InviteResultDTO' type: array member_list: description: 已加入合花群的成员列表 items: $ref: '#/components/schemas/JointAccountMemberInfoRespDTO' type: array product_code: description: 销售产品码 example: ENTERPRISE_PAY type: string profit_status: description: "生息状态:
\t- MAKING :开启中
\t- MADE. :已开启
\t\ - CLEARING:关闭中
\t- NONE. :未生息" example: MADE type: string yesterday_profit: description: 昨日收益 example: "0.45" type: string type: object AlipayFundJointaccountListQueryErrorResponseModel: properties: code: description: 错误码 enum: - PRODUCT_NOT_SIGN type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundJointaccountListQueryResponseModel: properties: account_list: description: 共同账户列表 items: $ref: '#/components/schemas/JointAccountDTO' type: array biz_scene: description: 场景 example: DEFAULT type: string product_code: description: 产品码 example: ENTERPRISE_PAY type: string type: object AlipayFundJointaccountMemberBatchqueryErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundJointaccountMemberBatchqueryModel: properties: account_id: description: 共同账户ID example: "20888888888" type: string agreement_no: description: 三方授权协议号 example: "3424324324324" type: string biz_scene: description: 业务场景 example: ISV_DEFAULT type: string identity: description: "企业账号:identity_type是ALIPAY_USER_ID填支付宝会员ID(2088开头);\t是ALIPAY_LOGON_ID\ \ 填支付宝登录号" example: name@email.com type: string identity_type: description: 账号类型,目前支持如下类型: 1、ALIPAY_USER_ID 支付宝的会员ID 2、ALIPAY_LOGON_ID:支付宝登录号,支持邮箱和手机号格式 example: ALIPAY_LOGON_ID type: string last_open_id: description: 按游标查询,传入上次查询最后一个用户的openId example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string last_user_id: description: 按游标查询,传入上次查询最后一个用户ID,适用于逐页查询。优先级大于page_num example: "2088900976746215" type: string page_num: description: 采用分页查询,本参数为空或0默认显示第一页。如果输入的值大于总页数,则支付宝返回最后一页数据。 example: "1" type: string page_size: description: 每页大小,不传的情况下默认20条,上限100;不足20条则按实际记录数返回 example: "20" type: string product_code: description: 销售产品码 example: ENTERPRISE_PAY type: string type: object AlipayFundJointaccountMemberBatchqueryResponseModel: properties: account_id: description: 共同账户ID example: "2088900976746215" type: string member_list: description: 员工列表 items: $ref: '#/components/schemas/JointAccountMemberDTO' type: array page_num: description: 当前页数,使用游标方式查询时,没有该字段 example: "1" type: string page_size: description: 当前记录数 example: "1" type: string total_count: description: 总条数 example: "100" type: string total_page_count: description: 总页数 example: "50" type: string type: object AlipayFundJointaccountMemberBindErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundJointaccountMemberBindModel: properties: account_id: description: 账本ID example: "2088000166406784" type: string account_quota: $ref: '#/components/schemas/JointAccountQuotaDTO' agreement_no: description: 授权签约协议号 example: "20214922001380716008" type: string biz_scene: description: 业务场景,联系支付宝分配 example: ISV_STANDARD type: string business_params: $ref: '#/components/schemas/InviteMemberBusinessParamsDTO' identity: description: "成员账号:\tidentity_type是ALIPAY_USER_ID填支付宝会员ID(2088开头);\t是ALIPAY_LOGON_ID\ \ 填支付宝登录号;\t是ALIPAY_OPEN_ID 填支付宝openId" example: name@email.com type: string identity_type: description: "账号类型,目前支持如下类型:\t1、ALIPAY_USER_ID 支付宝的会员ID \t2、ALIPAY_LOGON_ID:\ 支付宝登录号,支持邮箱和手机号格式\t3、ALIPAY_OPEN_ID:支付宝openId" example: ALIPAY_LOGON_ID type: string identity_verified_info: $ref: '#/components/schemas/IdentityVerifiedInfoDTO' name: description: 成员姓名,账号类型为ALIPAY_LOGON_ID时必填 example: 张三 type: string product_code: description: 产品码 example: ENTERPRISE_PAY type: string type: object AlipayFundJointaccountMemberBindResponseModel: properties: reply_url: description: 员工回应邀请链接 example: http://www.baidu.com type: string type: object AlipayFundJointaccountMemberConsultErrorResponseModel: properties: code: description: 错误码 enum: - PRODUCT_NOT_SIGN - AGREEMENT_IS_INVALID - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundJointaccountMemberConsultModel: properties: account_id: description: 企业ID example: "2088900976746215" type: string agreement_no: description: 协议号 example: "20205820659822371223" type: string business_params: description: 扩展参数,如需使用请联系支付宝开放同学 example: "{\"k\":\"v\"}" type: string open_id_list: description: 要检查的员工openId example: "[\"074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5\"]" items: type: string type: array user_id_list: description: 要检查的员工ID example: "[\"2088900976746215\"]" items: type: string type: array type: object AlipayFundJointaccountMemberConsultResponseModel: properties: account_id: description: 企业ID example: "2088900976746215" type: string code: description: "返回码\t10000-成功\t其他都是失败" example: "10000" type: string member_list: description: 员工列表 items: $ref: '#/components/schemas/MemberStatusRespDTO' type: array msg: description: 描述信息 example: Success type: string type: object AlipayFundJointaccountMemberQueryErrorResponseModel: properties: code: description: 错误码 enum: - PRODUCT_NOT_SIGN - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundJointaccountMemberQueryResponseModel: properties: account_id: description: 共同账户ID example: "2088900976746215" type: string biz_scene: description: 场景码 example: DEFAULT type: string member_list: description: 成员列表 items: $ref: '#/components/schemas/JointAccountMemberRespDTO' type: array page_num: description: 页码 example: "1" type: string page_size: description: 页面记录数 example: "10" type: string product_code: description: 产品码 example: ENTERPRISE_PAY type: string total_page_count: description: 总页数 example: "10" type: string type: object AlipayFundJointaccountMemberUnbindErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundJointaccountMemberUnbindModel: properties: account_id: description: 账本id example: "2088000166406784" type: string agreement_no: description: 授权协议号 example: "20214922001380716008" type: string biz_scene: description: 场景码 example: DEFAULT type: string identity: description: "成员账号:\tidentity_type是ALIPAY_USER_ID填支付宝会员ID(2088开头);\t是ALIPAY_LOGON_ID\ \ 填支付宝登录号" example: name@email.com type: string identity_type: description: 账号类型,目前支持如下类型: 1、ALIPAY_USER_ID 支付宝的会员ID 2、ALIPAY_LOGON_ID:支付宝登录号,支持邮箱和手机号格式 example: ALIPAY_LOGON_ID type: string name: description: 姓名,账号类型为ALIPAY_LOGON_ID时必填 example: 张三 type: string product_code: description: 产品码 example: ENTERPRISE_PAY type: string status: description: "成员当前状态:\t邀请中(PROCESSING)、正常(NORMAL)" example: NORMAL type: string type: object AlipayFundJointaccountMemberUnbindResponseModel: type: object AlipayFundJointaccountMemberruleModifyErrorResponseModel: properties: code: description: 错误码 enum: - PRODUCT_NOT_SIGN - MAX_QUOTA_CONFIG_MISSING type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundJointaccountMemberruleModifyModel: properties: account_id: description: 账户ID example: "2088900976746215" type: string agreement_no: description: 授权协议号 example: "20889009767462151233" type: string biz_scene: description: 业务场景 example: DEFAULT type: string member_list: $ref: '#/components/schemas/JointAccountMemberList' product_code: description: 产品码 example: ENTERPRISE_PAY type: string type: object AlipayFundJointaccountMemberruleModifyResponseModel: type: object AlipayFundJointaccountQuotaQueryErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundJointaccountQuotaQueryResponseModel: properties: account_id: description: 共同账户ID example: "2088900976746215" type: string account_quota: description: 共同账户额度模型 items: $ref: '#/components/schemas/JointAccountQuotaRespDTO' type: array biz_scene: description: 场景码 example: DEFAULT type: string member_id: description: 成员ID(如果查询员工才返回) example: "2088900976746215" type: string member_open_id: description: 员工openId example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string product_code: description: 产品码 example: ENTERPRISE_PAY type: string type: object AlipayFundJointaccountRuleModifyErrorResponseModel: properties: code: description: 错误码 enum: - PRODUCT_NOT_SIGN type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundJointaccountRuleModifyModel: properties: account_id: description: 账本ID example: "2088402123951081" type: string account_name: description: 账本名称 example: 账本名称 type: string account_quota: description: 账户额度 items: $ref: '#/components/schemas/JointAccountQuotaDTO' type: array agreement_no: description: 授权协议号 example: "2088402124305476" type: string authorized_rule: $ref: '#/components/schemas/AuthorizedRuleDTO' biz_scene: description: 场景码 example: DEFAULT type: string product_code: description: 产品码 example: ENTERPRISE_PAY type: string type: object AlipayFundJointaccountRuleModifyResponseModel: type: object AlipayFundJointaccountSignQueryErrorResponseModel: properties: code: description: 错误码 enum: - ILLEGAL_ARGUMENT - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundJointaccountSignQueryResponseModel: properties: account_id: description: 企业签约的账户ID example: "2088123123123" type: string agreement_no: description: 企业授权平台的三方授权协议号 example: "121212121212" type: string status: description: 账户状态,NORMAL-生效中,RELEASED-已销户 example: NORMAL type: string type: object AlipayFundJointaccountTradeQueryErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundJointaccountTradeQueryResponseModel: properties: buyer_id: description: 买家ID example: "2088888888" type: string buyer_open_id: description: 买家的openId example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string create_time: description: 交易创建时间 example: 2010-11-11 11:11:11 type: string total_amount: description: 订单总金额 example: "2" type: string trade_fund_bill_list: description: 资金单明细 items: $ref: '#/components/schemas/TradeFundBillDetail' type: array trade_info_list: description: 交易信息集合。查询为批量查询时,使用该结果返回 items: $ref: '#/components/schemas/TradeInfoDTO' type: array trade_no: description: 交易单号 example: "1231231321321" type: string trade_status: description: 交易状态:WAIT_BUYER_PAY(交易创建,等待买家付款)、TRADE_CLOSED(未付款交易超时关闭,或支付完成后全额退款)、TRADE_SUCCESS(交易支付成功)、TRADE_FINISHED(交易结束,不可退款) example: TRADE_SUCCESS type: string type: object AlipayFundTransCommonQueryErrorResponseModel: properties: code: description: 错误码 enum: - ORDER_NOT_EXIST - INVALID_PARAMETER - SYSTEM_ERROR - NO_ORDER_PERMISSION type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundTransCommonQueryResponseModel: properties: arrival_time_end: description: "预计到账时间,转账到银行卡专用,格式为yyyy-MM-dd HH:mm:ss,转账受理失败不返回。\r\t注意:\r\ \t此参数为预计时间,可能与实际到账时间有较大误差,不能作为实际到账时间使用,仅供参考用途。" example: 2013-01-01 08:08:08 type: string deduct_bill_info: description: 商户查询代扣订单信息时返回其在代扣请求中传入的账单属性 example: "{\"bizDesc\":\"代扣账单属性\",\"bizNos\":\"M{529316162343612472}\",\"\ billSource\":\"账房\",\"bizOrigNo\":\"529316162343612472\",\"reqSystem\"\ :\"PointCenter\"}" type: string error_code: description: 查询到的订单状态为FAIL失败或REFUND退票时,返回错误代码 example: PAYEE_CARD_INFO_ERROR type: string fail_reason: description: 查询到的订单状态为FAIL失败或REFUND退票时,返回具体的原因。 example: 收款方银行卡信息有误 type: string order_fee: description: 预计收费金额(元),转账到银行卡专用,数字格式,精确到小数点后2位,转账失败或转账受理失败不返回。 example: "0.02" type: string order_id: description: 支付宝转账单据号,查询失败不返回。 example: "20190801110070000006380000250621" type: string out_biz_no: description: 商户订单号 example: "201808080001" type: string passback_params: description: 商户回传参数 example: "{\"merchantBizType\":\"peerPay\"}" type: string pay_date: description: 支付时间,格式为yyyy-MM-dd HH:mm:ss,转账失败不返回。 example: 2013-01-01 08:08:08 type: string pay_fund_order_id: description: 支付宝支付资金流水号,转账失败不返回。 example: "20190801110070001506380000251556" type: string settle_serial_no: description: "金融机构发起签约类、支付类、差错类业务时,应为每笔业务分配唯一的交易流水号。31位交易流水号组成规则为:“8位日期”\ +“16位序列号”+“1位预留位”+“6位控制位”,其中:\ta)“8位日期”为系统当前日期,ISODate格式:“YYYYMMDD”\t\ b)“16位序列号”由金融机构生成,金融机构应确保该值在网联当日唯一\tc)“1位预留位”由平台分配\td)“6位控制位”由金融机构通过平台\ 获取\t例如:2023052993044491260542090100400" example: "2023052993044491260542090100400" type: string status: 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 type: string sub_order_error_code: description: 特殊场景提供,当子单出现异常导致主单失败或者退款时,会提供此字段,用于透出子单具体的错误场景 example: MID_ACCOUNT_CARD_INFO_ERROR type: string sub_order_fail_reason: description: 特殊场景提供,当子单出现异常导致主单失败或者退款时,会提供此字段,用于透出子单具体的错误场景 example: 收款方银行卡信息有误 type: string sub_order_status: description: 退款子单失败状态 example: FAIL type: string trans_amount: description: 付款金额,收银台场景下付款成功后的支付金额,订单状态为SUCCESS才返回,其他状态不返回。付款金额,单位为元,精确到小数点后两位。 example: "32.00" type: string transfer_bill_info: description: 商户在查询代发订单信息时返回其在代发请求中传入的账单属性。 example: "{\"bizDesc\":\"代扣账单属性\",\"bizNos\":\"M{529316162343612472}\",\"\ billSource\":\"账房\",\"bizOrigNo\":\"529316162343612472\",\"reqSystem\"\ :\"PointCenter\"}" type: string type: object AlipayFundTransOrderQueryErrorResponseModel: properties: code: description: 错误码 enum: - ORDER_NOT_EXIST - NO_ORDER_PERMISSION - INVALID_PARAMETER - ILLEGAL_ACCOUNT_STATUS_EXCEPTION - SYSTEM_ERROR - ORDER_ID_INVALID type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundTransOrderQueryResponseModel: properties: arrival_time_end: description: "预计到账时间,转账到银行卡专用,格式为yyyy-MM-dd HH:mm:ss,转账受理失败不返回。\r\t 注意\ :\r\t此参数为预计时间,可能与实际到账时间有较大误差,不能作为实际到账时间使用,仅供参考用途。" example: 2013-01-01 08:08:08 type: string error_code: description: "查询失败时,本参数为错误代 码。\r\t 查询成功不返回。 对于退票订单,不返回该参数。" example: EXCEED_LIMIT_SM_AMOUNT type: string fail_reason: description: 查询到的订单状态为FAIL失败或REFUND退票时,返回具体的原因。 example: 单笔额度超限 type: string order_fee: description: 预计收费金额(元),转账到银行卡专用,数字格式,精确到小数点后2位,转账失败或转账受理失败不返回。 example: "0.02" type: string order_id: description: 支付宝转账单据号,查询失败不返回。 example: "20181225110070001502260000212207" type: string out_biz_no: description: "发起转账来源方定义的转账单据号。 \r\t该参数的赋值均以查询结果中 的 out_biz_no 为准。 \r\t如果\ 查询失败,不返回该参数。" example: "3142321423432" type: string pay_date: description: 支付时间,格式为yyyy-MM-dd HH:mm:ss,转账失败不返回。 example: 2013-01-01 08:08:08 type: string status: description: "转账单据状态。\r\t\tSUCCESS:成功(配合\"单笔转账到银行账户接口\"产品使用时, 同一笔单据多次查询有\ 可能从成功变成退票状态);\r\t\tFAIL:失败(具体失败原因请参见error_code以及fail_reason返回值);\r\t\t\ INIT:等待处理;\r\t\tDEALING:处理中;\r\t\tREFUND:退票(仅配合\"单笔转账到银行账户接口\"产品使用时会涉及\ , 具体退票原因请参见fail_reason返回值);\r\t\tUNKNOWN:状态未知。" example: SUCCESS type: string type: object AlipayFundTransPayErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundTransPayModel: properties: auth_info: $ref: '#/components/schemas/AuthInfo' biz_scene: description: 业务场景,比如群收款、红包等 example: PARTY_MEMBERSHIP_DUES type: string business_params: description: JSON格式,传递业务扩展参数,使用前请与支付宝工程师联系! example: "{\"MERCHANT_PAYER_ID\":\"1234567890\",\"MERCHANT_PAYER_PHONE:\"\ 15012341234\"}" type: string order_title: description: 订单的标题,用于在收银台和消费记录展示 example: 钉钉红包 type: string out_biz_no: description: 商户端的唯一订单号,对于同一笔转账请求,商户需保证该订单号唯一。 example: "201806300001" type: string passback_params: description: 回传参数,如果请求时传递了该参数,则异步通知商户时会回传该参数。 example: "{\"merchantBizType\":\"peerPay\"}" type: string payee_info: $ref: '#/components/schemas/Participant' payer_info: $ref: '#/components/schemas/Participant' product_code: description: 销售产品码,商家和支付宝签约的产品码 example: STD_APP_TRANSFER type: string refund_time_expire: description: 退款超时时间,格式yyyy-MM-dd HH:mm。到指定时间后,系统会自动触发退款,并原路退回到付款账户。如果指定了退款时间,必须早于销售方案里设置的最晚退款时间。 example: 2018-11-08 10:00 type: string remark: description: 备注 example: 报销付款 type: string time_expire: description: 绝对超时时间,格式为yyyy-MM-dd HH:mm example: 2018-03-23 19:15 type: string trans_amount: description: "订单总金额,单位为元,精确到小数点后两位,取值范围[0.01,100000000]" example: "8.88" type: string type: object AlipayFundTransPayResponseModel: properties: order_id: description: 该笔转账在支付宝系统内部的单据ID example: "20180629110070001502040007320562" type: string out_biz_no: description: 商户端的唯一订单号 example: "201806300001" type: string pay_fund_order_id: description: 支付宝支付资金流水号 example: "20190801110070001506380000251556" type: string status: description: "SUCCESS:支付成功;\r\tFAIL:支付失败;\r\tUNKNOWN:未知;建议通过查询确认最新状态" example: SUCCESS type: string trans_pay_time: description: 订单支付时间,格式为yyyy-MM-dd HH:mm:ss example: 2019-08-21 00:00:00 type: string type: object AlipayFundTransPayeeBindQueryErrorResponseModel: properties: code: description: 错误码 enum: - NOT_IN_WHITE_LIST - SYSTEM_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundTransPayeeBindQueryResponseModel: properties: bind: description: 是否绑定收款账号。true:已绑定;false:未绑定 example: "true" type: string type: object AlipayFundTransRefundErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundTransRefundModel: properties: business_params: description: JSON格式,传递业务扩展参数,使用前请与支付宝工程师联系! example: "{\"MERCHANT_PAYER_ID\":\"1234567890\",\"MERCHANT_PAYER_PHONE:\"\ 15012341234\"}" type: string order_id: description: 发红包时支付宝返回的支付宝订单号order_id。 example: "20190703110075000006530004756875" type: string out_request_no: description: 标识一次资金退回请求,一笔资金退回失败后重新提交,要采用原来的资金退回单号。总退款金额不能超过用户实际支付金额。 example: "2018999960760005838333" type: string passback_params: description: 公用回传参数,如果请求时传递了该参数,则异步通知商户时会回传该参数。 example: "{\"merchantBizType\":\"peerPay\"}" type: string refund_amount: description: "需要退款的金额,该金额不能大于订单金额,单位为元,支持两位小数" example: "8.88" type: string remark: description: 资金退回备注 example: 红包超时退回 type: string type: object AlipayFundTransRefundResponseModel: properties: order_id: description: 发红包时支付宝返回的支付宝订单号order_id。 example: "20881030507841230156" type: string out_request_no: description: 标识一次资金退回请求,一笔资金退回失败后重新提交,要采用原来的资金退回单号。总退款金额不能超过用户实际支付金额。 example: "2019063050784123" type: string refund_amount: description: 本次退款的金额,单位为元,支持两位小数 example: "8.88" type: string refund_date: description: 退款资金退回 example: 2019-01-01 08:08:08 type: string refund_order_id: description: 退款的支付宝系统内部单据id example: "2088000000300210312" type: string status: description: SUCCESS:退款成功 example: SUCCESS type: string type: object AlipayFundTransToaccountTransferErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundTransToaccountTransferModel: properties: amount: description: "转账金额,单位:元。\r\t只支持2位小数,小数点前最大支持13位,金额必须大于等于0.1元。 \r\t最大转账金额\ 以实际签约的限额为准。" example: "12.23" type: string ext_param: description: 扩展参数,json字符串格式,目前仅支持的key=order_title,表示收款方的转账账单标题,value可以根据自己的业务定制。 example: "{\"order_title\":\"兑奖红包\"}" type: string out_biz_no: description: "商户转账唯一订单号。发起转账来源方定义的转账单据ID,用于将转账回执通知给来源方。\r\t不同来源方给出的ID可以重\ 复,同一个来源方必须保证其ID的唯一性。\r\t只支持半角英文、数字,及“-”、“_”。" example: "3142321423432" type: string payee_account: description: 收款方账户。与payee_type配合使用。付款方和收款方不能是同一个账户。 example: abc@sina.com type: string payee_real_name: description: "收款方真实姓名(最长支持100个英文/50个汉字)。\r\t如果本参数不为空,则会校验该账户在支付宝登记的实名是否与\ 收款方真实姓名一致。" example: 张三 type: string payee_type: description: "收款方账户类型。可取值:\t1、ALIPAY_USERID:支付宝账号对应的支付宝唯一用户号。以2088开头的16位\ 纯数字组成。\t2、ALIPAY_LOGONID:支付宝登录号,支持邮箱和手机号格式。\t2、ALIPAY_OPENID:支付宝openid" example: ALIPAY_LOGONID type: string payer_real_name: description: "付款方真实姓名(最长支持100个英文/50个汉字)。\r\t如果本参数不为空,则会校验该账户在支付宝登记的实名是否与\ 付款方真实姓名一致。" example: 上海交通卡公司 type: string payer_show_name: description: 付款方姓名(最长支持100个英文/50个汉字)。显示在收款方的账单详情页。如果该字段不传,则默认显示付款方的支付宝认证姓名或单位名称。 example: 上海交通卡退款 type: string remark: description: "转账备注(支持200个英文/100个汉字)。\r\t当付款方为企业账户,且转账金额达到(大于等于)50000元,remark不\ 能为空。收款方可见,会展示在收款用户的收支详情中。" example: 转账备注 type: string type: object AlipayFundTransToaccountTransferResponseModel: properties: order_id: description: 支付宝转账单据号,成功一定返回,失败可能不返回也可能返回。 example: "20160627110070001502260006780837" type: string out_biz_no: description: 商户转账唯一订单号:发起转账来源方定义的转账单据号。请求时对应的参数,原样返回。 example: "3142321423432" type: string pay_date: description: 支付时间:格式为yyyy-MM-dd HH:mm:ss,仅转账成功返回。 example: 2013-01-01 08:08:08 type: string type: object AlipayFundTransUniTransferErrorResponseModel: properties: code: 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 - PERM_AML_NOT_REALNAME_PAY - CONFIGURATION_ERROR - ILLEGAL_REQUEST_USER_ID - PARAMETER_ERROR - PERMIT_CHECK_PERM_AML_CERT_MISS_ACC_LIMIT - RECEIVER_USER_RISK_FREEZE - PAYER_PAYEE_ACCOUNT_NAME_CAN_NOT_SAME type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundTransUniTransferModel: properties: biz_scene: description: "描述特定的业务场景,可传的参数如下:\tDIRECT_TRANSFER:单笔无密转账到支付宝,B2C现金红包;\t\ PERSONAL_COLLECTION:C2C现金红包-领红包" example: DIRECT_TRANSFER type: string business_params: description: "转账业务请求的扩展参数,支持传入的扩展参数如下:\tsub_biz_scene 子业务场景,红包业务必传,取值REDPACKET,\ C2C现金红包、B2C现金红包均需传入" example: "{\"sub_biz_scene\":\"REDPACKET\"}" type: string mutiple_currency_detail: $ref: '#/components/schemas/MutipleCurrencyDetail' order_title: description: 转账业务的标题,用于在支付宝用户的账单里显示 example: 转账标题 type: string original_order_id: description: 原支付宝业务单号。 example: "20190620110075000006640000063056" type: string out_biz_no: description: 商家侧唯一订单号,由商家自定义。对于不同转账请求,商家需保证该订单号在自身系统唯一。 example: "201806300001" type: string passback_params: description: 公用回传参数,如果请求时传递了该参数,则异步通知商户时会回传该参数。 example: "{\"merchantBizType\":\"peerPay\"}" type: string payee_info: $ref: '#/components/schemas/Participant' payer_info: $ref: '#/components/schemas/Participant' product_code: description: "业务产品码,\t单笔无密转账到支付宝账户固定为:\tTRANS_ACCOUNT_NO_PWD;\t收发现金红包固定为\ :\tSTD_RED_PACKET;" example: TRANS_ACCOUNT_NO_PWD type: string remark: description: 业务备注 example: 单笔转账 type: string sign_data: $ref: '#/components/schemas/SignData' trans_amount: description: "订单总金额,单位为元,精确到小数点后两位,STD_RED_PACKET产品取值范围[0.01,100000000];\ \tTRANS_ACCOUNT_NO_PWD产品取值范围[0.1,100000000]" example: "23.00" type: string type: object AlipayFundTransUniTransferResponseModel: properties: amount: description: 转账金额,单位为元,默认为空,特殊场景提供。 example: "12.01" type: string order_id: description: 支付宝转账订单号 example: "20190801110070000006380000250621" type: string out_biz_no: description: 商户订单号 example: "201808080001" type: string pay_fund_order_id: description: 支付宝支付资金流水号 example: "20190801110070001506380000251556" type: string settle_serial_no: description: "金融机构发起签约类、支付类、差错类业务时,应为每笔业务分配唯一的交易流水号。31位交易流水号组成规则为:“8位日期”\ +“16位序列号”+“1位预留位”+“6位控制位”,其中:\ta)“8位日期”为系统当前日期,ISODate格式:“YYYYMMDD”\t\ b)“16位序列号”由金融机构生成,金融机构应确保该值在网联当日唯一\tc)“1位预留位”由平台分配\td)“6位控制位”由金融机构通过平台\ 获取\t例如:2023052993044491260542090100400" example: "2023052993044491260542090100400" type: string status: description: "转账单据状态。\tSUCCESS(该笔转账交易成功):成功;\tFAIL:失败(具体失败原因请参见error_code以\ 及fail_reason返回值);\tDEALING:处理中(转账到支付宝账户不涉及);\tREFUND:退票(转账到支付宝账户不涉及);" example: SUCCESS type: string trans_date: description: 订单支付时间,格式为yyyy-MM-dd HH:mm:ss example: 2019-08-21 00:00:00 type: string type: object AlipayFundUsertradeBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - INNER_RPC_INVOKE_FAIL - USER_UNAUTHORIZED - CONFIG_ERROR - MAX_VISIT_LIMIT - AOP_SERVICE_UNAVAILABLE - USER_INFO_VALIDATE_ERROR - INVALID_PARAMETER - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayFundUsertradeBatchqueryModel: properties: biz_scene: description: 查询交易数据场景码 example: BRAND_MARKET_PROMOTION type: string end_time: description: 拉取的结算时间,格式yyyy-MM-dd HH:mm:ss,拉取逻辑包含该时刻。 example: 2022-02-11 00:00:00 type: string page_index: description: 分页页码,从1开始,必须大于0 example: "1" type: string page_size: description: 分页大小,必须大于0,最大设置100 example: "100" type: string product_code: description: 查询交易数据产品码 example: MARKET_PROMOTION type: string start_time: description: 拉取的起始时间,格式yyyy-MM-dd HH:mm:ss,时间必须早于拉取的截止时间,并且,接口仅限查询用户30天内交易数据,拉取逻辑包含该时刻。 example: 2022-02-10 00:00:00 type: string type: object AlipayFundUsertradeBatchqueryResponseModel: properties: end_time: description: 拉取的结束时间,格式yyyy-MM-dd HH:mm:ss example: 2022-02-11 00:00:00 type: string has_next: description: 是否有下一页 example: true type: boolean page_index: description: 入参中的分页页码 example: "1" type: string page_size: description: 入参中的分页大小 example: "100" type: string start_time: description: 拉取的起始时间,格式yyyy-MM-dd HH:mm:ss example: 2022-02-10 00:00:00 type: string total_count: description: 交易时间区间内的总交易数 example: 120 type: integer trade_info_list: description: 用户交易数据 items: $ref: '#/components/schemas/UserTradeInfoDTO' type: array type: object AlipayIserviceCcmAgentCreateErrorResponseModel: properties: code: 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 - ROLE_INSTANCE_INVALID - ROLE_NOT_EXISTS - UNKNOW_ERROR - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmAgentCreateModel: properties: answering_mode: description: 热线接入方式,取值0,1,2 example: "0" type: string ccs_instance_ids: description: 部门id列表 example: "[\"XAHSNRBS\"]" items: type: string type: array chat_configs: description: 在线技能组设置,技能组部门间隔离,此设置应与ccs_instance_ids对应 items: $ref: '#/components/schemas/AgentChatInfo' type: array creator_id: description: 操作人客服id example: "2019032101896769" type: string email: description: 客服邮箱 example: test@163.com type: string external_user_id: description: 客服账号id,当user_channel=ALIPAY时,external_user_id为支付宝账号id example: 2088xxx type: string hotline_configs: description: 热线技能组设置,技能组部门间隔离,此设置应与ccs_instance_ids对应 items: $ref: '#/components/schemas/AgentHotlineInfo' type: array job_number: description: 客服工号,新增后不可变更。4位数字,不可重复 example: "0002" type: string mobile: description: 客服手机号 example: "13812345678" type: string nick_name: description: 客服昵称 example: 风清扬 type: string real_name: description: 客服姓名 example: 张三 type: string role_ids: description: 角色id列表 items: $ref: '#/components/schemas/RoleId' type: array user_channel: description: 客服账号渠道 ALIPAY:支付宝账号 example: ALIPAY type: string type: object AlipayIserviceCcmAgentCreateResponseModel: properties: id: description: CCM客服id example: "2019032101896769" type: string type: object AlipayIserviceCcmAgentDeleteErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - INTERNAL_ERROR - TENENT_NOT_FOUND - AGENT_NOT_EXISTS type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmAgentDeleteResponseModel: type: object AlipayIserviceCcmAgentGetErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - AGENT_NOT_EXISTS - INTERNAL_ERROR - TENENT_NOT_FOUND type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmAgentGetResponseModel: properties: answering_mode: description: 热线接入方式: 0:话机 1:电脑耳机;2:webrtc example: "0" type: string avatar: description: 头像的oss file key example: "12345" type: string ccs_instance_ids: description: 客服关联的数据权限id列表 example: "ZPASFSCN,QWT_SADLD" items: type: string type: array chat_config: description: 客服在线信息 items: $ref: '#/components/schemas/AgentChatInfo' type: array create_time: description: 创建时间,采用UTC时间,按照ISO8601标准表示,格式为:yyyy-MM-dd'T'HH:mm:ss'Z example: 2020-07-15 17:58:27 type: string creator_id: description: 创建人id example: "246534573" type: string dingtalk_user_id: description: 钉钉user_id example: "1293894912" type: string email: description: 邮箱 example: abc@alipay.com type: string external_id: description: "外部系统用户id,比如:金融云的用户id" example: "112133" type: string hotline_config: description: 客服热线信息 items: $ref: '#/components/schemas/AgentHotlineInfo' type: array id: description: 客服id example: "2018101801902073" type: string job_number: description: 工号 example: "0001" type: string last_login_time: description: "客服上次登录时间\t采用UTC时间,按照ISO8601标准表示,格式为:yyyy-MM-dd'T'HH:mm:ss'Z'" example: 2020-07-15 17:58:27 type: string mobile: description: 手机号 example: "17712341234" type: string nick_name: description: 客服昵称 example: 风清扬 type: string profile: description: 个人简介 example: 我是玉树临风一表人才的张三 type: string real_name: description: 客服姓名 example: 张三 type: string role_ids: description: 角色id列表 items: $ref: '#/components/schemas/RoleId' type: array status: description: 客服状态:NORMAL,DELETE example: NORMAL type: string type: description: 用户类型:NORMAL(普通客服),ADMIN(超级管理员,不能被删除) example: NORMAL type: string update_time: description: 最后修改时间,采用UTC时间,按照ISO8601标准表示,格式为:yyyy-MM-dd'T'HH:mm:ss'Z' example: 2020-07-15 17:58:27 type: string updater_id: description: 最后修改人id example: "246534573" type: string type: object AlipayIserviceCcmAgentModifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - INTERNAL_ERROR - TENENT_NOT_FOUND - DUPLICATE_NICK_NAME - INVALID_HOTLINE_ANSWERING_MODE - AGENT_NOT_EXISTS type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmAgentModifyModel: properties: answering_mode: description: 热线接入方式,取值0,1,2 example: "0" type: string ccs_instance_ids: description: 部门id列表 example: "[\"XAHSNRBS\"]" items: type: string type: array chat_configs: description: 在线技能组设置,技能组部门间隔离,此设置应与ccs_instance_ids对应 items: $ref: '#/components/schemas/AgentChatInfo' type: array email: description: 客服邮箱 example: test@163.com type: string hotline_configs: description: 热线技能组设置,技能组部门间隔离,此设置应与ccs_instance_ids对应 items: $ref: '#/components/schemas/AgentHotlineInfo' type: array id: description: 客服id example: "2019032101896769" type: string mobile: description: 客服手机号 example: "13812345678" type: string nick_name: description: 客服昵称 example: 风清扬 type: string real_name: description: 客服姓名 example: 张三 type: string role_ids: description: 客服角色id列表 items: $ref: '#/components/schemas/RoleId' type: array updater_id: description: 操作人客服id example: "2019032101896769" type: string type: object AlipayIserviceCcmAgentModifyResponseModel: type: object AlipayIserviceCcmAgentQueryErrorResponseModel: properties: code: description: 错误码 enum: - INTERNAL_ERROR - TENENT_NOT_FOUND - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmAgentQueryModel: properties: answering_mode: description: 热线接入方式 example: "0" type: string ccs_instance_id: description: 部门id example: XAHSNRBS type: string chat_ext_group_ids: description: 在线扩展技能组id example: "[\"123\"]" items: type: string type: array chat_group_ids: description: 在线技能组id example: "[\"123\"]" items: type: string type: array chat_level_ids: description: 在线服务等级 example: "[\"123\"]" items: type: string type: array email: description: 客服邮箱 example: test@163.com type: string hotline_group_ids: description: 热线扩展技能组id example: "[\"123\"]" items: type: string type: array page_num: description: 查询结果的页码,起始值为 1,默认值为 1 example: 1 type: integer page_size: description: 分页查询时设置的每页记录数,最大值 100 行,默认为 10 example: 10 type: integer real_name: description: 客服姓名 example: 张三 type: string role_ids: description: 客服角色id example: "[\"123\"]" items: type: string type: array type: object AlipayIserviceCcmAgentQueryResponseModel: properties: agents: description: 客服列表 items: $ref: '#/components/schemas/AgentVO' type: array page_num: description: 查询结果的页码,起始值为 1,默认值为 1 example: 1 type: integer page_size: description: 分页查询时设置的每页记录数,最大值 100 行,默认为 10 example: 10 type: integer total_count: description: 总条目数 example: 99 type: integer type: object AlipayIserviceCcmAgentSchedulelogQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMS - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmAgentSchedulelogQueryModel: properties: agent_ids: description: "客服id集合,限制最多100个id,不传查询部门下所有客服的状态变更流水日志" example: "[\"2018101801902073\",\"2018101801902090\"]" items: type: string type: array ccs_instance_id: description: 部门id(即租户实例ID、数据权限ID) example: kaj_9DA1 type: string end_time: description: "客服状态变更结束时间,开始时间与结束时间间隔不能超过1天,采用UTC时间,按照ISO8601标准表示,格式为:yyyy-MM-dd'T'HH:mm:ss'Z'" example: 2020-10-24 00:00:00 type: string limit: description: "查询条数,最大100, 不传默认100" example: 100 type: integer page_num: description: 查询结果的页码,起始值为 1,默认值为 1 example: 1 type: integer page_size: description: 分页查询时设置的每页记录数,最大值 100 行,默认为 100 example: 10 type: integer start_id: description: "起始id,分页导出的起始客服状态变更流水id,第一页传0,翻页时传上一页结果的最大id" example: 10223 type: integer start_time: description: "客服状态变更开始时间,采用UTC时间,按照ISO8601标准表示,格式为:yyyy-MM-dd'T'HH:mm:ss'Z'" example: 2020-10-23 00:00:00 type: string type: object AlipayIserviceCcmAgentSchedulelogQueryResponseModel: properties: agent_schedule_logs: $ref: '#/components/schemas/AgentScheduleLog' page_num: description: 查询结果的页码 example: 1 type: integer page_size: description: 分页查询时设置的每页记录数 example: 10 type: integer total_count: description: 总条目数 example: 125 type: integer type: object AlipayIserviceCcmFunctionQueryErrorResponseModel: properties: code: description: 错误码 enum: - INTERNAL_ERROR - TENENT_NOT_FOUND type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmFunctionQueryResponseModel: properties: functions: description: 功能点列表 items: $ref: '#/components/schemas/Function' type: array type: object AlipayIserviceCcmInstanceCreateErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - INTERNAL_ERROR - TENENT_NOT_FOUND - UNKNOW_ERROR - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmInstanceCreateModel: properties: creator_id: description: 创建人id example: "246534573" type: string description: description: 租户实例(数据权限)描述信息 example: 我是租户实例(数据权限)描述 type: string external_id: description: 外部id example: "29488293" type: string name: description: 租户实例(数据权限)名称,如果名称已经存在,将创建失败 example: 测试租户实例(数据权限) type: string type: object AlipayIserviceCcmInstanceCreateResponseModel: properties: id: description: 租户实例(数据权限)ID example: pYv_gs0m type: string type: object AlipayIserviceCcmInstanceGetErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - INTERNAL_ERROR - TENENT_NOT_FOUND type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmInstanceGetResponseModel: properties: create_time: description: 创建时间 example: 2020-11-10 20:56:00 type: string creator_id: description: 创建人id example: "2018051101015016" type: string description: description: 描述 example: 我是部门描述 type: string external_id: description: 外部id example: "392435002" type: string id: description: 部门id(即租户实例ID、数据权限ID) example: pYv_gs0m type: string name: description: 租户实例(数据权限)名称 example: XXX租户实例 type: string status: description: 租户实例(数据权限)状态,所有可能的状态如下:INIT(初始化)、STARTED(准备完成)、START_FAILED(准备失败)、STOPPING(停用中)、STOPPED(已停用)、RELEASING(释放中)、RELEASED(已释放)、RESUMING(重新启动)、MODIFING(修改规格中)、DELETED(已删除)。 example: STARTED type: string update_time: description: 最后修改时间 example: 2020-11-10 21:01:00 type: string updater_id: description: 最后修改人id example: "2018051101015016" type: string type: object AlipayIserviceCcmInstanceQueryErrorResponseModel: properties: code: description: 错误码 enum: - INTERNAL_ERROR - TENENT_NOT_FOUND type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmInstanceQueryResponseModel: properties: instances: description: 租户实例列表 items: $ref: '#/components/schemas/Instance' type: array page_num: description: 查询结果的页码 example: 1 type: integer page_size: description: 分页查询时设置的每页记录数 example: 10 type: integer total_count: description: 总条目数 example: 100 type: integer type: object AlipayIserviceCcmIsvInitializeErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - PUBKEY_IMPORT_FAILED - PUBKEY_HAS_EXIST - CCM_KEY_GENERATE_FAILED - INTERNAL_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmIsvInitializeModel: properties: isv_pub_key: description: 用于接入CCM iframe接口安全认证的 ISV 公钥,采用 base64 编码,秘钥对生成算法为 RSA2048。 example: MIIBIjANBgkqhkiG9wxxxx type: string type: object AlipayIserviceCcmIsvInitializeResponseModel: properties: ccm_pub_key: description: Base64编码CCM公钥:CCM公私钥对由CCM自动生成,用于Iframe spi接口安全认证 example: MIIBIjANBgkqhkiG9w0BAQxxxx type: string type: object AlipayIserviceCcmOlsChatrecordQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmOlsChatrecordQueryResponseModel: properties: agent_id: description: 客服id example: "2008123455" type: string agent_name: description: 客服昵称 example: 客服003 type: string categories: description: 多个层级类目信息 example: "[[{\\\"id\\\":111,\\\"name\\\":\\\"保险\\\"},{\\\"id\\\":122,\\\"\ name\\\":\\\"财保\\\"},{\\\"id\\\":133,\\\"name\\\":\\\"车险\\\"}],[{\\\"\ id\\\":211,\\\"name\\\":\\\"售后\\\"},{\\\"id\\\":222,\\\"name\\\":\\\"出\ 险\\\"},{\\\"id\\\":233,\\\"name\\\":\\\"理赔\\\"}]]" type: string group_id: description: 在线技能组id example: "1" type: string group_name: description: 在线技能组名称 example: 基础技能组 type: string memo: description: 备注信息 example: 该问题可通过xx手段解决,请回复客户xxxxxx。 type: string messages: description: 聊天消息列表 items: $ref: '#/components/schemas/ChatMessage' type: array satisfaction: description: 满意度。 0:非常满意 1:满意 2:一般 3:不满意 4:非常不满意 example: "0" type: string status: description: 服务记录状态。1:待处理 2:暂存 3:完结 4:废除 5:无效 6:未知 example: "1" type: string talk_duration: description: 在线服务时长,单位秒 example: 3600 type: integer visitor_province: description: 访客归属地 example: 浙江 type: string type: object AlipayIserviceCcmRobotAvatarbaseQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - INTERNAL_ERROR - TENENT_NOT_FOUND - UNKNOW_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmRobotAvatarbaseQueryModel: properties: commodity_code: description: 开通的数字人的商品码 example: P_STD_AVATAR_CCM type: string method_params: description: method_params:对应target_method请求方法的具体传参值k-v map example: "{\"key1\":\"name\",}" type: string target_method: description: targetMethod;数字人目标方法调用 example: init.json type: string tenant_code: description: 租户code&租户id,对于子部门客户需要上传子部门id example: bUC_Weh3 type: string type: object AlipayIserviceCcmRobotAvatarbaseQueryResponseModel: properties: result: description: result:方法调用返回值响应 k-v map example: "{\"key1\":\"xxx\",\"key2\":\"xxxx\"}" type: string type: object AlipayIserviceCcmRoleCreateErrorResponseModel: properties: code: description: 错误码 enum: - DUPLICATE_ROLE - INTERNAL_ERROR - TENENT_NOT_FOUND type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmRoleCreateModel: properties: ccs_instance_id: description: 部门id(即租户实例ID、数据权限ID) example: jwa_8J2l type: string creator_id: description: 创建人id example: "201835445454546" type: string description: description: 角色描述信息 example: 我是角色描述... type: string function_ids: description: 角色关联额功能点id example: "[\"123\",\"456\"]" items: type: string type: array name: description: 角色名 example: 保险类角色 type: string type: object AlipayIserviceCcmRoleCreateResponseModel: properties: id: description: 角色id example: "123" type: string type: object AlipayIserviceCcmRoleDeleteErrorResponseModel: properties: code: description: 错误码 enum: - INTERNAL_ERROR - TENENT_NOT_FOUND type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmRoleDeleteResponseModel: type: object AlipayIserviceCcmRoleGetErrorResponseModel: properties: code: description: 错误码 enum: - ROLE_NOT_EXIST - INTERNAL_ERROR - TENENT_NOT_FOUND type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmRoleGetResponseModel: properties: ccs_instance_id: description: 部门id(即租户实例ID、数据权限ID) example: ZPASFSCN type: string create_time: description: 创建时间 example: 2020-11-10 21:52:00 type: string creator_id: description: 创建人id example: "201855445857455" type: string description: description: 描述信息 example: 我是描述信息... type: string function_ids: description: 角色关联的功能点id example: "[\"123\",\"456\"]" items: type: string type: array id: description: 角色id example: "123" type: string name: description: 角色名称 example: XX角色 type: string update_time: description: 最后修改时间 example: 2020-11-10 21:56:00 type: string updater_id: description: 最后修改人id example: "20185512254425" type: string type: object AlipayIserviceCcmRoleModifyErrorResponseModel: properties: code: description: 错误码 enum: - ROLE_NOT_EXIST - INTERNAL_ERROR - TENENT_NOT_FOUND type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmRoleModifyModel: properties: ccs_instance_id: description: 部门id(即租户实例ID、数据权限ID),不传默认使用租户id example: alw_J1Ds type: string description: description: 描述信息 example: 我是角色描述 type: string function_ids: description: 角色关联额功能点id example: "[\"123\",\"456\"]" items: type: string type: array id: description: 角色id example: "123" type: string updater_id: description: 最后修改人id example: "20181422342134" type: string type: object AlipayIserviceCcmRoleModifyResponseModel: type: object AlipayIserviceCcmRolePageQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - INTERNAL_ERROR - TENENT_NOT_FOUND type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmRolePageQueryResponseModel: properties: page_num: description: 查询结果的页码 example: 1 type: integer page_size: description: 分页查询时设置的每页记录数 example: 10 type: integer roles: description: 角色列表 items: $ref: '#/components/schemas/Role' type: array total_count: description: 总条目数 example: 125 type: integer type: object AlipayIserviceCcmServiceBuyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - TENENT_NOT_FOUND - APP_NOT_INITIALIAZED - SERVICE_NOT_INITIALIAZED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmServiceBuyModel: properties: service_code: description: 服务代码。通过alipay.iservice.ccm.service.initialize(isv服务初始化接口) 获取。 example: testCode type: string type: object AlipayIserviceCcmServiceBuyResponseModel: properties: service_instance_id: description: 服务实例id example: 1 type: integer tenant_id: description: 商户在CCM的租户id example: qHT_sTlI type: string type: object AlipayIserviceCcmServiceCloseErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - TENENT_NOT_FOUND - APP_NOT_INITIALIAZED - SERVICE_NOT_INITIALIAZED - SERVICE_NOT_OPEN type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmServiceCloseModel: properties: service_code: description: 服务代码。通过alipay.iservice.ccm.service.initialize(isv服务初始化接口) 获取。 example: testCode type: string type: object AlipayIserviceCcmServiceCloseResponseModel: type: object AlipayIserviceCcmServiceInitializeErrorResponseModel: properties: code: description: 错误码 enum: - INTERNAL_ERROR - INVALID_PARAMETER - APP_NOT_INITIALIAZED - SPI_KEY_UNDEFINED - SERVICE_CODE_INVALID type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmServiceInitializeModel: properties: description: description: 服务描述 example: 热线工作台 type: string icon: description: 服务图标url。支持 http(s) 链接。 example: http://127.0.0.1/ type: string service_code: description: 服务编码。可在服务上架后,在服务市场上查询此信息。 example: testCode type: string service_name: description: 服务名称。可在服务上架后,在服务市场上查询此信息。 example: 热线工作台 type: string service_order_url: description: 服务订购二维码链接 example: http://127.0.0.1/ type: string spis: description: spi定义列表 items: $ref: '#/components/schemas/IsvSpiDefinition' type: array type: object AlipayIserviceCcmServiceInitializeResponseModel: properties: spi_ids: description: spi在ccm中的唯一标识,与biz_code一一对应 items: $ref: '#/components/schemas/SpiResult' type: array type: object AlipayIserviceCcmServicerecordCreateErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmServicerecordCreateModel: properties: acid: description: 来电唯一标识 example: CCC/2459691380492662222224097452 type: string aid: description: 客服坐席号(软电话中定义的) example: "20000105" type: string ani: description: 主叫号码 example: "15123090087" type: string asid: description: 恒生专用来电唯一标识 example: 29de02050ce1403db710a0b1f4daad6d type: string category_list: description: 类目信息(详细信息请参考具体类型描述) items: $ref: '#/components/schemas/ServiceRecordCatRequest' type: array chat_begin_time: description: 标准时间格式:yyyy-MM-dd HH:mm:ss example: 2018-11-20 11:37:26 type: string chat_end_time: description: 标准时间格式:yyyy-MM-dd HH:mm:ss example: 2018-11-20 11:38:49 type: string city: description: 来电地址 example: 山东 type: string creator_id: description: 创建者ID example: "2020042801917879" type: string discon_symbol: description: "先挂断方\tAGENT:客服\tCUSTOMER:客户" example: AGENT type: string dnis: description: 被叫号码 example: "15925998721" type: string file_size: description: 文件大小 example: 1222000 type: integer gmt_create: description: 创建时间(yyyy-MM-dd HH:mm:ss) example: 2010-11-11 11:11:11 type: string gmt_modified: description: 修改时间 example: 2010-11-11 11:11:11 type: string memo: description: 服务记录备注信息 example: 亲,昨天已经寄给你了呢 type: string modifier_id: description: 修改人ID example: "2020042801917879" type: string outbound_task_id: description: 外呼任务ID example: 10.253.104.12_1d5d40fd-aa5e-4f23-9247-14cd28e125f2 type: string satisfaction: description: "满意度\t0:非常满意\t1:满意\t2:一般\t3:不满意\t4:非常不满意" example: "0" type: string satisfaction_memo: description: 满意度补充信息 example: 其它:非常不满意,完全都是我在自问自答; type: string service_source: description: "1:客户来电\t4:电话回访\t5:网点服务\t6:在线服务\t7:外呼任务\t8:手动外呼\t9:在线离线留言" example: "1" type: string service_time: description: 服务时长(单位:秒) example: 1924 type: integer skillgroup_id: description: 技能组ID example: "100000000001" type: string skillgroup_name: description: 技能组名称(技能组ID对应的技能组名称) example: 融资业务还款组 type: string tnt_inst_id: description: 业务租户 example: TTTKPICN type: string user_id: description: 来访用户唯一标识ID example: "202007011113010526000000035332" type: string verify_result: 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 type: string type: object AlipayIserviceCcmServicerecordCreateResponseModel: properties: service_record_id: description: 服务记录ID example: "201709271113010100000000000001" type: string type: object AlipayIserviceCcmServicerecordModifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SERVICE_RECORD_NOT_EXISIT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmServicerecordModifyModel: properties: acid: description: 来电唯一标识 example: CCC/2459691380492662222224097452 type: string aid: description: 客服坐席号(软电话中定义的) example: "20000105" type: string ani: description: 主叫号码 example: "15123090087" type: string asid: description: 恒生专用来电唯一标识 example: 29de02050ce1403db710a0b1f4daad6d type: string category_list: $ref: '#/components/schemas/ServiceRecordCatRequest' chat_begin_time: description: 标准时间格式:yyyy-MM-dd HH:mm:ss example: 2018-11-20 11:37:26 type: string chat_end_time: description: 标准时间格式:yyyy-MM-dd HH:mm:ss example: 2018-11-20 11:38:49 type: string city: description: 来电地址 example: 山东 type: string creator_id: description: 创建者ID example: "2020042801917879" type: string discon_symbol: description: 先挂断方 AGENT:客服 CUSTOMER:客户 example: AGENT type: string dnis: description: 被叫号码 example: "15925998721" type: string file_size: description: 文件大小 example: 1222000 type: integer gmt_create: description: 创建时间(yyyy-MM-dd HH:mm:ss) example: 2010-11-11 11:11:11 type: string gmt_modified: description: 修改时间 example: 2010-11-11 11:11:11 type: string id: description: 云客服服务记录ID example: "202011161113010100000000739715" type: string memo: description: 服务记录备注信息 example: 亲,昨天已经寄给你了呢 type: string modifier_id: description: 修改人ID example: "2020042801917879" type: string outbound_task_id: description: 外呼任务ID example: 10.253.104.12_1d5d40fd-aa5e-4f23-9247-14cd28e125f2 type: string satisfaction: description: 满意度 0:非常满意 1:满意 2:一般 3:不满意 4:非常不满意 example: "0" type: string satisfaction_memo: description: 满意度补充信息 example: 其它:非常不满意,完全都是我在自问自答; type: string service_source: description: 1:客户来电 4:电话回访 5:网点服务 6:在线服务 7:外呼任务 8:手动外呼 9:在线离线留言 example: "1" type: string service_time: description: 服务时长(单位:秒) example: 1924 type: integer skillgroup_id: description: 技能组ID example: "100000000001" type: string skillgroup_name: description: 技能组名称(技能组ID对应的技能组名称) example: 融资业务还款组 type: string status: description: "1:待处理\t2:暂存\t3:完结\t4:废除\t5:无效\t6:未知" example: "1" type: string tnt_inst_id: description: 业务租户 example: ORGJC1CN type: string user_id: description: 来访用户唯一标识ID example: "202007011113010526000000035332" type: string verify_result: 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 type: string type: object AlipayIserviceCcmServicerecordModifyResponseModel: type: object AlipayIserviceCcmSwArticleBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmSwArticleBatchqueryModel: properties: category_id: description: 所属类目ID,如果search_all_category为true则不用填 example: 12 type: integer ccs_instance_id: description: 子部门ID,不传为默认部门 example: ZPNASDK type: string end_time: description: 结束时间,并且开始时间不能为空 example: 2020-12-31 23:59:59 type: string ids: description: 文章ID集合 example: "[1,12]" items: type: integer type: array keyword: description: 关键字 example: 支付宝 type: string keywords: description: 标签 example: "[\"关键\",\"核心\"]" items: type: string type: array library_id: description: 知识库ID example: 1 type: integer page_num: description: 页数,page_size不能为空 example: 1 type: integer page_size: description: 页大小,page_num不能为空 example: 20 type: integer search_all_category: description: 是否搜索所有类目,如果为true则不用填写category_id值 example: true type: boolean search_category_type: description: "Current(搜索当前节点);\tChildren(搜索当前节点以及子节点)" example: Current type: string start_time: description: 开始时间,并且结束时间不能为空 example: 2020-12-31 00:00:01 type: string status: description: 状态,PUBLISHED(已发布),UNPUBLISH(未发布),EXPIRED(失效),DELETED(已删除) example: PUBLISHED type: string type: object AlipayIserviceCcmSwArticleBatchqueryResponseModel: properties: articles: description: 文章信息 items: $ref: '#/components/schemas/ArticleInfo' type: array type: object AlipayIserviceCcmSwArticleCreateErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmSwArticleCreateModel: properties: category_id: description: 所属类目ID,如果search_all_category为true则不用填 example: 12 type: integer ccs_instance_id: description: 子部门ID,不传为默认部门 example: ZPNASDK type: string content: description: 内容 example: 这是一个普通的内容文本 type: string extend_titles: description: 扩展标题 example: "[\"支付宝\",\"知识库\"]" items: type: string type: array keywords: description: 标签 example: "[\"关键\",\"核心\"]" items: type: string type: array library_id: description: 知识库ID example: "1" type: string scene_codes: description: 场景ID。KNOWLEDGE(内部知识库);ROBOT(机器人);HELP(帮助中心);WHELP(无线帮助中心) example: "[\"KNOWLEDGE\",\"ROBOT\",\"HELP\",\"WHELP\"]" items: type: string type: array title: description: 标题 example: 这是一个普通的标题 type: string type: object AlipayIserviceCcmSwArticleCreateResponseModel: properties: id: description: 文章ID example: 1 type: integer type: object AlipayIserviceCcmSwArticleDeleteErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmSwArticleDeleteResponseModel: type: object AlipayIserviceCcmSwArticleGetErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmSwArticleGetResponseModel: properties: attachments: description: 文章对应附件集合 items: $ref: '#/components/schemas/ArticleAttachmentInfo' type: array category_id: description: 所属类目ID example: 12 type: integer category_name_path: description: 类目名称路径 example: 知识库-演示 type: string category_path: description: 类目路径 items: $ref: '#/components/schemas/ArticleCategoryInfo' type: array content: description: 内容 example: 我是文章内容 type: string create_time: description: 创建时间 example: 2020-12-31 23:59:59 type: string creator_id: description: 创建人 example: "10001" type: string extend_titles: description: 扩展标题 example: "[\"支付宝\",\"知识库\"]" items: type: string type: array id: description: 文章ID example: 1 type: integer keywords: description: 标签 example: "[\"标签\"]" items: type: string type: array library_id: description: 知识库ID example: 1 type: integer order_no: description: 排序值 example: 5 type: integer pictures: description: 文章对应图片集合 items: $ref: '#/components/schemas/ArticleAttachmentInfo' type: array publish_end: description: 有效期止 example: 2022-06-11 16:14:58 type: string publish_start: description: 有效期起始 example: 2020-06-11 16:14:58 type: string scene_codes: description: 场景ID。1(内部知识库);2(机器人);3(帮助中心);4(无线帮助中心) example: "[\"1\",\"2\",\"3\",\"4\"]" items: type: string type: array source: description: 来源 example: 网关录入 type: string status: description: 文章状态 example: 已发布 type: string status_code: description: 文章状态码 example: PUBLISHED type: string title: description: 标题 example: 我是文章标题 type: string update_time: description: 修改时间 example: 2020-12-31 23:59:59 type: string updater_id: description: 修改人 example: "10001" type: string updater_name: description: 修改人名称 example: admin type: string type: object AlipayIserviceCcmSwArticleModifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmSwArticleModifyModel: properties: category_id: description: 所属类目ID,如果search_all_category为true则不用填 example: 12 type: integer ccs_instance_id: description: 子部门ID,不传为默认部门 example: ZPNASDK type: string content: description: 内容 example: 这是一个普通的内容文本 type: string extend_titles: description: 扩展标题 example: "[\"支付宝\",\"知识库\"]" items: type: string type: array id: description: 文章ID example: 1 type: integer keywords: description: 标签 example: "[\"关键\",\"核心\"]" items: type: string type: array scene_codes: description: 场景ID。1(内部知识库);2(机器人);3(帮助中心);4(无线帮助中心) example: "[\"1\",\"2\",\"3\",\"4\"]" items: type: string type: array title: description: 标题 example: 这是一个普通的标题 type: string type: object AlipayIserviceCcmSwArticleModifyResponseModel: type: object AlipayIserviceCcmSwKnowledgeModifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmSwKnowledgeModifyModel: properties: category_id: description: 所属类目ID example: 12 type: integer category_name: description: 知识点所属类目 example: 平板电脑 type: string content: description: 知识点答案内容 example: 商品的发货地是广东佛山 type: string ext_id: description: 外部知识点ID example: qa0002003004005006 type: string extend_titles: description: 扩展标题(问法) example: "[\"商品从哪里发货\"]" items: type: string type: array icon: description: 问答关联图片附件地址 example: https://image.baidu.com/search/detail?ct=503316480&z=0 type: string id: description: 知识点ID example: 123456 type: integer is_delete: description: 默认为false,为true且id非空时,表示删除知识点 example: false type: boolean is_searchable: description: 是否被检索到,默认false,系统希望为true example: true type: boolean library_id: description: 知识库ID example: 23 type: integer library_name: description: 知识库名称 example: 商品知识库 type: string spu: $ref: '#/components/schemas/SpuDetail' tags: description: 以逗号分割的字符串列表 example: "[\"发货地\",\"发货点\"]" items: type: string type: array title: description: 知识点标题 example: 商品的发货地是哪里? type: string type: object AlipayIserviceCcmSwKnowledgeModifyResponseModel: properties: id: description: 知识点ID example: 12345 type: integer type: object AlipayIserviceCcmSwLibraryBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmSwLibraryBatchqueryResponseModel: properties: libraries: description: 知识库集合 items: $ref: '#/components/schemas/LibraryInfo' type: array type: object AlipayIserviceCcmSwLibraryCreateErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmSwLibraryCreateModel: properties: ccs_instance_id: description: 子部门ID,不传为默认部门 example: ZPNASDK type: string instance_code: description: 知识库对应的类目树名称,与treeId不可同时为空 example: TREE_cVE_MHk8_1532332260914 type: string name: description: 知识库名称 example: 商品库 type: string tree_id: description: 知识库对应的类目树Id,与instanceCode不可同时为空 example: 12 type: integer type: object AlipayIserviceCcmSwLibraryCreateResponseModel: properties: id: description: 知识库Id example: 1 type: integer type: object AlipayIserviceCcmSwLibraryDeleteErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmSwLibraryDeleteResponseModel: type: object AlipayIserviceCcmSwLibraryModifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmSwLibraryModifyModel: properties: ccs_instance_id: description: 子部门ID,不传为默认部门 example: ZPNASDK type: string id: description: 知识库Id example: "1" type: string name: description: 知识库名称 example: 商品库 type: string type: object AlipayIserviceCcmSwLibraryModifyResponseModel: type: object AlipayIserviceCcmSwOrderSyncErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmSwOrderSyncModel: properties: amount: description: 订单金额 example: "12234.33" type: string link_url: description: 订单链接 example: http://taobao.com/order/1214134234 type: string logistic_count: description: 订单物流数量 example: 1 type: integer logistics: description: 物流信息列表 items: $ref: '#/components/schemas/LogisticInfo' type: array order_create_time: description: 订单创建时间 example: 2022-04-04 09:09:09 type: string order_id: description: 订单id example: "123121414" type: string order_type: description: "普通订单:NORMAL\t预售订单:PRE_SALE" example: NORMAL type: string spu_count: description: 订单商品种类 example: 1 type: integer spus: description: 订单商品信息 items: $ref: '#/components/schemas/SpuInfo' type: array status: description: "订单状态,目前支持以下几种状态\t下单未支付\tWAIT_PAY\t支付未发货\tPAIED\t已发货\tIN_DELIVERY\t\ 售后中\tIN_AFTER_SALE\t订单完成\tFINISHED" example: WAIT_PAY type: string sub_status: description: 订单子状态 example: SIGNED type: string user_id: description: 下单用户id(外部系统ID) example: "90932423423" type: string type: object AlipayIserviceCcmSwOrderSyncResponseModel: properties: order_id: description: 订单id example: "124121453" type: string type: object AlipayIserviceCcmSwSpuSyncErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmSwSpuSyncModel: properties: attribute: description: 商品属性列表 items: $ref: '#/components/schemas/SpuAttribute' type: array brand: description: 商品品牌 example: 米其林 type: string category: description: 商品类目,用于商品库中分类 example: 美妆 type: string description: description: 商品描述 example: 商品质量符合XX标准,支持7天无理由退换 type: string icon: description: "商品图片链接\t特殊可选规则:is_delete=false的情况下必填" example: https://image.baidu.com/search/detail?ct=503316480&z=0&ipn=d type: string is_delete: description: 默认为false,为true,表示删除知识点 example: "false" type: string library_id: description: 知识库id example: 23 type: integer library_name: description: 知识库名称 example: 商品知识库 type: string link_url: description: "商品链接\t特殊可选规则:is_delete=false的情况下必填" example: https://detail.tmall.com/item.htm?id=530187047412&ali_trackid=2:mm_26632614_0_0:1603785697_244_935652742 type: string original_price: description: 商品原价 example: "123.58" type: string price: description: "商品售价\t特殊可选规则:is_delete=false的情况下必填" example: "99.99" type: string spu_id: description: 商品ID example: spu1212391923 type: string status: description: "商品状态:AVAILABLE 表示可售卖,SOLD_OUT为售罄/不可卖,默认可售卖" example: AVAILABLE type: string title: description: "商品名称\t特殊可选规则:is_delete=false的情况下必填" example: 汽车盲点BSD并线辅助系统盲点监测变道后视镜盲区监控雷达预警 type: string type: object AlipayIserviceCcmSwSpuSyncResponseModel: properties: spu_id: description: 商品id example: spu12434234234 type: string type: object AlipayIserviceCcmSwTreeBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmSwTreeBatchqueryResponseModel: properties: trees: description: 类目集合 items: $ref: '#/components/schemas/TreeInfo' type: array type: object AlipayIserviceCcmSwTreeCreateErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmSwTreeCreateModel: properties: ccs_instance_id: description: 子部门ID,不传为默认部门 example: ZPNASDK type: string name: description: 类目名称 example: 蚂蚁科技 type: string type: object AlipayIserviceCcmSwTreeCreateResponseModel: properties: id: description: 类目ID example: 1 type: integer type: object AlipayIserviceCcmSwTreeDeleteErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmSwTreeDeleteResponseModel: type: object AlipayIserviceCcmSwTreeGetErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmSwTreeGetResponseModel: properties: tree: description: 类目树字符串 example: "{\"description\":\"\",\"fatherId\":0,\"id\":47250,\"name\":\"\ OpenAPI测试\",\"tags\":[\"KNOWLEDGE\",\"HELP\",\"PLATFORM\"]}" type: string type: object AlipayIserviceCcmSwTreeModifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmSwTreeModifyModel: properties: ccs_instance_id: description: 子部门ID,不传为默认部门 example: ZPNASDK type: string id: description: 类目ID example: 1 type: integer name: description: 类目名称 example: 蚂蚁科技 type: string type: object AlipayIserviceCcmSwTreeModifyResponseModel: type: object AlipayIserviceCcmSwTreePublishErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmSwTreePublishModel: properties: ccs_instance_id: description: 子部门ID,不传为默认部门 example: ZPNASDK type: string id: description: 类目ID example: 1 type: integer type: object AlipayIserviceCcmSwTreePublishResponseModel: type: object AlipayIserviceCcmSwTreecategoryBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmSwTreecategoryBatchqueryResponseModel: properties: categories: description: 节点集合 items: $ref: '#/components/schemas/ArticleCategoryInfo' type: array page_num: description: 页数 example: 1 type: integer page_size: description: 页显示大小 example: 10 type: integer total_count: description: 总行数 example: 1 type: integer type: object AlipayIserviceCcmSwTreecategoryCreateErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmSwTreecategoryCreateModel: properties: ccs_instance_id: description: 子部门ID,不传为默认部门 example: ZPNASDK type: string description: description: 描述 example: 这是一段描述 type: string father_id: description: 父节点ID example: 12 type: integer name: description: 节点名称 example: 服务群 type: string tags: description: 标签。KNOWLEDGE(知识库);PLATFORM(公有云工作台);HELP(公有云帮助中心) example: "[\"KNOWLEDGE\",\"PLATFORM\",\"HELP\"]" items: type: string type: array type: object AlipayIserviceCcmSwTreecategoryCreateResponseModel: properties: id: description: 节点ID example: 1 type: integer type: object AlipayIserviceCcmSwTreecategoryDeleteErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmSwTreecategoryDeleteResponseModel: type: object AlipayIserviceCcmSwTreecategoryModifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayIserviceCcmSwTreecategoryModifyModel: properties: ccs_instance_id: description: 子部门ID,不传为默认部门 example: ZPNASDK type: string description: description: 描述 example: 这是一段描述 type: string father_id: description: 父节点ID example: "12" type: string id: description: 节点ID example: 1 type: integer name: description: 节点名称 example: 服务群 type: string tags: description: 标签。KNOWLEDGE(知识库);PLATFORM(公有云工作台);HELP(公有云帮助中心) example: "[\"KNOWLEDGE\",\"PLATFORM\",\"HELP\"]" type: string type: object AlipayIserviceCcmSwTreecategoryModifyResponseModel: type: object AlipayMarketingActivityAppBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityAppBatchqueryResponseModel: properties: activity_id: description: 活动id example: "2016042700826004508401111111" type: string app_infos: description: 可用小程序列表 items: $ref: '#/components/schemas/ActivityAppInfo' type: array page_num: description: 分页查询页码。 example: 1 type: integer page_size: description: 分页查询单页数据条数。 example: 20 type: integer total_size: description: 可用小程序总数量 example: 200 type: integer type: object AlipayMarketingActivityBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityBatchqueryModel: properties: activity_status: description: 活动状态 。 ACTIVE:活动已激活,表示活动已经生效,等到活动开始(publish_start_time)之后用户就可以参与活动。 PAUSE:活动已暂停,表示商户临时暂停该活动,该状态下用户不能参与活动。 example: ACTIVE type: string merchant_access_mode: description: 商户接入模式。 example: AGENCY_MODE type: string merchant_id: description: "商户PID,默认为当前接口调用商户。" example: "2088202967380463" type: string page_num: description: 分页查询页码。 example: 1 type: integer page_size: description: 分页查询单页数据条数。 example: 20 type: integer type: object AlipayMarketingActivityBatchqueryResponseModel: properties: activity_lite_infos: description: 活动摘要信息 items: $ref: '#/components/schemas/ActivityLiteInfo' type: array page_num: description: 分页查询页码。 example: 2 type: integer page_size: description: 分页查询单页数据条数。 example: 20 type: integer total_size: description: 经过条件筛选,查询到的活动总数量 example: "200" type: string type: object AlipayMarketingActivityConsultErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityConsultModel: properties: consult_activity_info_list: description: 待咨询的活动信息列表 items: $ref: '#/components/schemas/ConsultActivityInfo' type: array merchant_access_mode: description: 商户接入模式 example: AGENCY_MODE type: string merchant_id: description: "商户PID,默认为当前接口调用商户。" example: "2088102111111111" type: string open_id: description: 领券的支付宝用户openId example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string user_id: description: 领券的用户uid example: 2088xxxx type: string type: object AlipayMarketingActivityConsultResponseModel: properties: consult_result_info_list: description: 咨询后的活动结果信息 items: $ref: '#/components/schemas/ConsultActivityResultInfo' type: array open_id: description: 领券的用户openId example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string user_id: description: 领券的用户uid example: 2088xxxxx type: string type: object AlipayMarketingActivityDeliveryCreateErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityDeliveryCreateModel: properties: belong_merchant_info: $ref: '#/components/schemas/DeliveryAgencyMerchantInfo' delivery_base_info: $ref: '#/components/schemas/DeliveryBaseInfo' delivery_booth_code: description: 投放的展位编码。 example: PUBLIC_UNION type: string delivery_config_list: description: "[已废弃]\t待创建的投放配置列表。\t最大数量限制20个。" items: $ref: '#/components/schemas/DeliveryConfig' type: array delivery_play_config: $ref: '#/components/schemas/DeliveryPlayConfig' delivery_target_rule: $ref: '#/components/schemas/DeliveryTargetRule' merchant_access_mode: description: 商户接入模式 example: SELF_MODE type: string out_biz_no: description: 外部业务单号,用作幂等控制。 幂等作用:请求返回与上一次相同的结果。 外部接入方需保证业务单号唯一。 example: 20170101000001654bb46ba type: string type: object AlipayMarketingActivityDeliveryCreateResponseModel: properties: delivery_guide_preview_url: description: "预览链接。\t可用于预览用户在承接页面领券的流程。" example: alipays://platformapi/startapp?appId=xxxx type: string delivery_id: description: 推广计划id example: "20121231231242353" type: string error_delivery_config_list: description: "[已废弃]\t创建失败的投放信息列表\t\t失败的投放配置列表中,会返回对应的deliveryConfig对象。" items: $ref: '#/components/schemas/ErrorDeliveryConfig' type: array success_delivery_config_list: description: "[已废弃]\t创建成功的投放信息列表\t\t成功的投放配置列表中,会返回对应的deliveryConfig对象。" items: $ref: '#/components/schemas/SuccessDeliveryConfig' type: array type: object AlipayMarketingActivityDeliveryQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - BIZ_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityDeliveryQueryModel: properties: belong_merchant_info: $ref: '#/components/schemas/DeliveryAgencyMerchantInfo' delivery_config_list: description: "\"[已废弃] 待查询的投放配置列表。 最大数量限制20个。\"" items: $ref: '#/components/schemas/DeliveryConfig' type: array merchant_access_mode: description: 商户接入模式 example: SELF_MODE type: string type: object AlipayMarketingActivityDeliveryQueryResponseModel: properties: delivery_base_info: $ref: '#/components/schemas/DeliveryBaseInfo' delivery_booth_code: description: 运营计划的展位编码。 枚举值: SERVICE_MESSAGE:商家消息(包含订单、订阅、其他消息) example: SERVICE_MESSAGE type: string delivery_error_msg: description: 投放计划错误信息描述,如投放计划审核失败时为审核失败原因。 example: 素材审核失败:素材存在敏感信息。 type: string delivery_id: description: 投放计划id example: "20121231231242353" type: string delivery_info_list: description: "\"[已废弃] 投放信息列表\"" items: $ref: '#/components/schemas/PromoDeliveryInfo' type: array delivery_play_config: $ref: '#/components/schemas/DeliveryPlayConfig' delivery_status: description: 投放计划状态。 example: ACTIVE type: string delivery_target_rule: $ref: '#/components/schemas/DeliveryTargetRule' type: object AlipayMarketingActivityDeliveryStopErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityDeliveryStopModel: properties: belong_merchant_info: $ref: '#/components/schemas/DeliveryAgencyMerchantInfo' delivery_config_list: description: "\"[已废弃] 待停止的投放配置列表。 最大数量限制20个。\"" items: $ref: '#/components/schemas/DeliveryConfig' type: array merchant_access_mode: description: 商户接入模式 example: SELF_MODE type: string out_biz_no: description: 外部业务单号,用作幂等控制。 幂等作用: 再次请求返回与上一次相同的结果。 外部接入方需保证业务单号唯一。 example: 20170101000001654bb46ba type: string type: object AlipayMarketingActivityDeliveryStopResponseModel: properties: delivery_id: description: 推广计划id。 example: "20121231231242353" type: string error_delivery_config_list: description: 停止失败的投放配置列表 items: $ref: '#/components/schemas/ErrorDeliveryConfig' type: array success_delivery_config_list: description: 停止成功的投放配置列表 items: $ref: '#/components/schemas/SuccessDeliveryConfig' type: array type: object AlipayMarketingActivityDeliverychannelQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - BIZ_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityDeliverychannelQueryModel: properties: belong_merchant_info: $ref: '#/components/schemas/DeliveryAgencyMerchantInfo' booth_code: description: "展位码。\t\tboothCode含义:boothCode表达的是某个渠道可以投放的展位码。例如:支付结果页PAY_RESULT\t\ \t枚举值:\tPAY_RESULT:支付结果页。\t\t后续新增可投放的展位后,会在文档中新增描述信息" example: PAY_RESULT type: string page_num: description: "查询的页码。\t\t特别说明:\t页码从1开始。" example: 1 type: integer page_size: description: 每页查询的个数,最大值为 100。 example: 2 type: integer type: object AlipayMarketingActivityDeliverychannelQueryResponseModel: properties: delivery_channel_info_list: description: '"可投放的渠道信息列表。 用于表达当前可以投放的渠道列表信息"' items: $ref: '#/components/schemas/DeliveryChannelInfo' type: array page_num: description: 查询的页码。 特别说明: 页码从1开始。 example: "1" type: string page_size: description: 每页查询个数 example: "2" type: string total_size: description: 可返回的渠道总数 example: "6" type: string type: object AlipayMarketingActivityGoodsBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityGoodsBatchqueryResponseModel: properties: activity_id: description: 活动id example: "2016042700826004508401111111" type: string app_item_infos: description: 小程序商品信息 items: $ref: '#/components/schemas/AppItemInfo' type: array goods_infos: description: 商品编码列表 items: $ref: '#/components/schemas/ActivityGoodsInfo' type: array page_num: description: 分页查询页码。 example: 1 type: integer page_size: description: 分页查询单页数据条数。 example: 20 type: integer total_size: description: 商品编码总数量 example: 200 type: integer type: object AlipayMarketingActivityMerchantBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityMerchantBatchqueryResponseModel: properties: activity_id: description: 活动id example: "2016042700826004508401111111" type: string merchant_infos: description: 可用商户列表 items: $ref: '#/components/schemas/ActivityMerchantInfo' type: array page_num: description: 分页查询页码。 example: 1 type: integer page_size: description: 分页查询单页数据条数。 example: 20 type: integer total_size: description: 可用商户总数量 example: 200 type: integer type: object AlipayMarketingActivityOrdervoucherAppendErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityOrdervoucherAppendModel: properties: merchant_access_mode: description: 商户接入模式 example: AGENCY_MODE type: string out_biz_no: description: "外部业务单号,用作幂等控制。\t\t幂等作用:\t参数不变的情况下,再次请求返回与上一次相同的结果。\t\t外部接入\ 方需保证业务单号唯一。" example: 20170101000001654bb46ba type: string voucher_quantity: description: "发行券的数量。\t\t限制:\t券总预算<= 999999\t\t特别说明:\t该字段的含义是追加到的数量。\t不可\ 减少,只能增加。\t\tcode_mode=\tMERCHANT_UPLOAD 的情况下,voucher_quantity 需要与导入码的总\ 数量保持一致(即历史导入数量 + 追加导入数量)。" example: 100 type: integer type: object AlipayMarketingActivityOrdervoucherAppendResponseModel: type: object AlipayMarketingActivityOrdervoucherAssociateErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - ACTIVITY_NOT_EXIST - VOUCHER_NOT_EXIST - ACTIVITY_NOT_PERMISSION - VOUCHER_ASSOCIATE_OTHER_TRADE_NO type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityOrdervoucherAssociateModel: properties: activity_id: description: 活动id example: "2016042700826004508401111111" type: string merchant_access_mode: description: 商户接入模式 example: AGENCY_MODE type: string out_biz_no: description: 外部业务单号,用作幂等控制。 幂等作用: 参数不变的情况下,再次请求返回与上一次相同的结果。 外部接入方需保证业务单号唯一。 example: 20170101000001654bb46ba type: string trade_no: description: 支付宝支付下单时的商户订单号,欲与该商家券关联的支付宝支付 example: "2021042322001426261436764012" type: string voucher_code: description: "商家券券码。\t限制:\t券码必须已发放给用户。" example: ABE44 type: string type: object AlipayMarketingActivityOrdervoucherAssociateResponseModel: properties: associate_time: description: 支付宝系统关联订单成功的时间。 格式为:yyyy-MM-dd HH:mm:ss example: 2017-01-01 00:00:01 type: string type: object AlipayMarketingActivityOrdervoucherCodecountErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityOrdervoucherCodecountResponseModel: properties: success_count: description: 已经导入的券码数量 example: 100 type: integer type: object AlipayMarketingActivityOrdervoucherCodedepositErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityOrdervoucherCodedepositModel: properties: merchant_access_mode: description: 商户接入模式 example: AGENCY_MODE type: string out_biz_no: description: "外部业务单号,用作幂等控制。\t\t幂等作用:\t参数不变的情况下,再次请求返回与上一次相同的结果。\t\t外部接入\ 方需保证业务单号唯一。" example: 20170101000001654bb46ba type: string voucher_codes: description: "券码的数量列表。接口参数为列表类型。\t\t限制:\t目前最大上传 1000 个。\t\t单个code最长64位。\t\ \t商户上传的券code列表,code允许包含的字符有0-9、a-z、A-Z、-、_、+、=、|。" example: "[\"123AB\",\"45zz6\",\"789CE\"]" items: type: string type: array type: object AlipayMarketingActivityOrdervoucherCodedepositResponseModel: properties: fail_count: description: 导入失败的券码数量 example: 1 type: integer fail_voucher_code_detail_list: description: 上传失败券码详情列表,包括上传失败的券码及对应的错误码和错误原因 items: $ref: '#/components/schemas/FailVoucherCodeDetail' type: array success_count: description: 导入成功的券码数量 example: 2 type: integer success_voucher_code_list: description: 上传成功的券码列表 example: "[\"123AB\",\"45zz6\"]" items: type: string type: array type: object AlipayMarketingActivityOrdervoucherCreateErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - BIZ_ERROR - DISCOUNT_AMOUNT_INSUFFICIENT - BUSINESS_HAS_RISK type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityOrdervoucherCreateModel: properties: activity_base_info: $ref: '#/components/schemas/ActivityBaseInfo' activity_name: description: 活动名称。不对用户进行展示,仅供商家在后台管理活动使用。 example: 满10减1活动 type: string belong_merchant_info: $ref: '#/components/schemas/BelongMerchantInfo' biz_tag: description: 该字段废弃!后续不要使用该字段!商家券业务标签,影响商家券对C端用户的展示形式。 example: GROUP_BUY_EXCHANGE_VOUCHER type: string code_mode: description: 码模式。MERCHANT_UPLOAD:商户上传自定义code,发券时系统随机选取上传的券code发放。MERCHANT_API:发奖时指定券码发奖,此模式无须提前上传券码。 example: MERCHANT_UPLOAD type: string customer_guide: $ref: '#/components/schemas/CustomerGuide' merchant_access_mode: description: 商户接入模式 example: AGENCY_MODE type: string out_biz_no: description: "外部业务单号,用作幂等控制。\t幂等作用:参数不变的情况下,再次请求返回与上一次相同的结果。" example: 20170101000001654bb46ba type: string publish_end_time: description: 券发放结束时间。格式为:yyyy-MM-dd HH:mm:ss example: 2017-01-29 23:59:59 type: string publish_start_time: description: 券发放开始时间。格式为:yyyy-MM-dd HH:mm:ss example: 2017-01-01 00:00:01 type: string 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: description: "券类型。\t兑换券仅支持一类券类型:EXCHANGE_VOUCHER: 兑换券;" example: FIX_VOUCHER type: string voucher_use_rule: $ref: '#/components/schemas/VoucherUseRule' voucher_use_rule_info: $ref: '#/components/schemas/VoucherUseRuleInfo' type: object AlipayMarketingActivityOrdervoucherCreateResponseModel: properties: activity_id: description: 活动id example: "2016042700826004508401111111" type: string voucher_available_scope_result_info: $ref: '#/components/schemas/VoucherAvailableScopeResultInfo' voucher_use_rule_result: $ref: '#/components/schemas/OrderVoucherUseRuleResult' type: object AlipayMarketingActivityOrdervoucherDisassociateErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - ACTIVITY_NOT_EXIST - VOUCHER_NOT_EXIST - ACTIVITY_NOT_PERMISSION - VOUCHER_ASSOCIATE_TRADE_NO_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityOrdervoucherDisassociateModel: properties: activity_id: description: 活动id example: "2016042700826004508401111111" type: string merchant_access_mode: description: 商户接入模式 example: AGENCY_MODE type: string out_biz_no: description: 外部业务单号,用作幂等控制。 幂等作用: 参数不变的情况下,再次请求返回与上一次相同的结果。 外部接入方需保证业务单号唯一。 example: 20170101000001654bb46ba type: string trade_no: description: 该交易在支付宝系统中的交易流水号。 example: "2021042322001426261436764012" type: string voucher_code: description: "券码。 限制: 券码必须已发放给用户。" example: ABE44 type: string type: object AlipayMarketingActivityOrdervoucherDisassociateResponseModel: properties: disassociate_time: description: 支付宝系统取消关联订单成功的时间。 格式为:yyyy-MM-dd HH:mm:ss example: 2017-01-01 00:00:01 type: string type: object AlipayMarketingActivityOrdervoucherModifyErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityOrdervoucherModifyModel: properties: activity_base_info: $ref: '#/components/schemas/ActivityBaseInfo' activity_name: description: 活动名称。 example: 满10减1活动 type: string customer_guide: $ref: '#/components/schemas/CustomerGuideModify' merchant_access_mode: description: 商户接入模式 example: SELF_MODE type: string out_biz_no: description: "外部业务单号,用作幂等控制。\t幂等作用:\t参数不变的情况下,再次请求返回与上一次相同的结果。" example: 20170101000001654bb46ba type: string publish_end_time: description: "券发放结束时间。该值为空表示不修改\t格式为:yyyy-MM-dd HH:mm:ss" example: 2017-01-29 23:59:59 type: string publish_start_time: description: 券发放开始时间。 格式为:yyyy-MM-dd HH:mm:ss example: 2017-01-01 00:00:01 type: string voucher_available_scope_info: $ref: '#/components/schemas/VoucherAvailableScopeInfo' voucher_available_scope_modify_type: description: 可用范围修改类型。 example: ADD type: string 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' type: object AlipayMarketingActivityOrdervoucherModifyResponseModel: properties: voucher_available_scope_result_info: $ref: '#/components/schemas/VoucherAvailableScopeResultInfo' voucher_use_rule_result: $ref: '#/components/schemas/OrderVoucherUseRuleResult' type: object AlipayMarketingActivityOrdervoucherQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityOrdervoucherQueryResponseModel: properties: activity_base_info: $ref: '#/components/schemas/ActivityBaseInfo' activity_id: description: 活动id example: "2016042700826004508401111111" type: string activity_name: description: 活动名称。不对用户进行展示,仅供商家在后台管理活动使用。 example: 满10减1优惠券 type: string activity_operation_status: description: 活动操作状态 example: MODIFYING type: string activity_status: description: 活动状态。已激活状态代表活动正常运行,已终止状态代表商家终止活动,不可再发放。 example: ACTIVE type: string belong_merchant_info: $ref: '#/components/schemas/BelongMerchantInfo' biz_tag: description: 商家券业务标签,影响商家券对C端用户的展示形式。 example: GROUP_BUY_EXCHANGE_VOUCHER type: string customer_guide: $ref: '#/components/schemas/CustomerGuide' publish_end_time: description: 券发放结束时间。格式为:yyyy-MM-dd HH:mm:ss example: 2017-01-29 23:59:59 type: string publish_start_time: description: 券发放开始时间。格式为:yyyy-MM-dd HH:mm:ss example: 2017-01-01 00:00:01 type: string 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: description: 券类型 example: FIX_VOUCHER type: string voucher_use_rule: $ref: '#/components/schemas/VoucherUseRule' voucher_use_rule_info: $ref: '#/components/schemas/VoucherUseRuleInfo' type: object AlipayMarketingActivityOrdervoucherRefundErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityOrdervoucherRefundModel: properties: biz_dt: description: "当前订单的退券时间。\t\t\t\t格式为:yyyy-MM-dd HH:mm:ss" example: 2017-01-01 00:00:01 type: string merchant_access_mode: description: 商户接入模式 example: AGENCY_MODE type: string out_biz_no: description: "外部业务单号,用作幂等控制。\t\t\t\t幂等作用:\t\t参数不变的情况下,再次请求返回与上一次相同的结果。\t\ \t\t\t外部接入方需保证业务单号唯一" example: 20170101000001654bb46ba type: string total_fee: description: 当前订单的退款总金额(包含优惠券金额),单位为元。 example: "999.99" type: string voucher_refund_detail_info: $ref: '#/components/schemas/VoucherRefundDetailInfo' type: object AlipayMarketingActivityOrdervoucherRefundResponseModel: properties: activity_id: description: 优惠券活动id example: "2022113000826004726607680740" type: string voucher_use_detail_result_info: $ref: '#/components/schemas/VoucherUseDetailResultInfo' type: object AlipayMarketingActivityOrdervoucherStopErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityOrdervoucherStopModel: properties: merchant_access_mode: description: 商户接入模式 example: AGENCY_MODE type: string out_biz_no: description: "外部业务单号,用作幂等控制。\t\t幂等作用:\t参数不变的情况下,再次请求返回与上一次相同的结果。\t\t外部接入\ 方需保证业务单号唯一。" example: 20170101000001654bb46ba type: string type: object AlipayMarketingActivityOrdervoucherStopResponseModel: type: object AlipayMarketingActivityOrdervoucherUseErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - BIZ_ERROR - ACTIVITY_NOT_PERMISSION type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityOrdervoucherUseModel: properties: biz_dt: description: 外部优惠券的核销时间,用于流水记录。 格式为:yyyy-MM-dd HH:mm:ss example: 2017-01-01 00:00:01 type: string goods_detail: description: 商品明细信息 items: $ref: '#/components/schemas/GoodsDetailDTO' type: array merchant_access_mode: description: 商户接入模式 example: AGENCY_MODE type: string out_biz_no: description: "外部业务单号,用作幂等控制。\t\t\t\t幂等作用:\t\t参数不变的情况下,再次请求返回与上一次相同的结果。\t\ \t\t\t外部接入方需保证业务单号唯一。" example: 20170101000001654bb46ba type: string real_shop_id: 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" type: string store_id: 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" type: string total_fee: description: 订单总金额 example: "999.99" type: string trade_channel: description: 交易渠道。 example: ZHIFUBAO_TRADE_CHANNEL type: string trade_no: description: "该交易在支付宝系统中的交易流水号。\t注意:若用户使用支付宝为交易的渠道,本参数必填。" example: "2021042322001426261436764012" type: string voucher_use_detail_info: $ref: '#/components/schemas/VoucherUseDetailInfo' type: object AlipayMarketingActivityOrdervoucherUseResponseModel: properties: activity_id: description: 优惠券活动id example: "2016042700826004508401111111" type: string voucher_use_detail_result_info: $ref: '#/components/schemas/VoucherUseDetailResultInfo' type: object AlipayMarketingActivityQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - ACTIVITY_NOT_ACTIVE - ACTIVITY_NOT_PERMISSION type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityQueryResponseModel: properties: activity_base_info: $ref: '#/components/schemas/ActivityBaseInfo' activity_id: description: 活动id example: "2016042700826004508401111111" type: string activity_name: description: 活动名称。 不对用户进行展示,仅供商家在后台管理活动使用。 example: 满10减1活动 type: string activity_status: description: 活动状态。活动已激活,表示活动已经生效,等到活动开始(publish_start_time)之后用户就可以参与活动。活动已暂停,表示商户临时暂停该活动,该状态下用户不能参与活动。活动已结束,表示商户主动停止活动或活动到期结束(publish_end_time)不能再进行领取或修改等操作。 example: ACTIVE type: string belong_merchant_id: description: 归属商户PID example: "2088202967380463" type: string publish_end_time: description: 券发放结束时间。 格式为:yyyy-MM-dd HH:mm:ss example: 2017-01-29 23:59:59 type: string publish_start_time: description: 券发放开始时间。 格式为:yyyy-MM-dd HH:mm:ss example: 2017-01-01 00:00:01 type: string 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: description: 券类型。 example: FIX_VOUCHER type: string voucher_use_rule: $ref: '#/components/schemas/CommonVoucherUseRule' voucher_use_rule_info: $ref: '#/components/schemas/VoucherUseRuleInfo' type: object AlipayMarketingActivityShopBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityShopBatchqueryResponseModel: properties: activity_id: description: 活动id example: "2016042700826004508401111111" type: string page_num: description: 分页查询页码。 example: 1 type: integer page_size: description: 分页查询单页数据条数。 example: 20 type: integer shop_infos: description: 可用门店列表 items: $ref: '#/components/schemas/ActivityShopInfo' type: array total_size: description: 可用门店总数量 example: 200 type: integer type: object AlipayMarketingActivityUserBatchqueryvoucherErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityUserBatchqueryvoucherResponseModel: properties: page_num: description: 分页查询页码 example: 1 type: integer page_size: description: 分页查询单页数据条数 example: 20 type: integer total_size: description: 总数量 example: 200 type: integer user_voucher_infos: description: 用户券实例 items: $ref: '#/components/schemas/UserVoucherInfo' type: array type: object AlipayMarketingActivityUserQueryvoucherErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - VOUCHER_NOT_EXIST - ACTIVITY_NOT_PERMISSION - MERCHANT_RELATION_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityUserQueryvoucherResponseModel: properties: activity_base_info: $ref: '#/components/schemas/ActivityBaseInfo' activity_id: description: 活动 id example: "2016042700826004508401111111" type: string associate_trade_no: description: 若商家券操作过关联商户订单信息,则该字段返回商家券已关联的商户订单号。 example: "2021042322001426261436764012" type: string available_begin_time: description: 券可用开始时间。格式为:yyyy-MM-dd HH:mm:ss example: 2017-01-01 00:00:01 type: string available_end_time: description: 券可用结束时间。格式为:yyyy-MM-dd HH:mm:ss example: 2017-01-01 00:00:01 type: string belong_merchant_id: description: 券归属 pid example: "2088202967380463" type: string create_time: description: 领券时间 example: 2017-01-01 00:00:01 type: string user_voucher_base_info: $ref: '#/components/schemas/UserVoucherBaseInfo' 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_name: description: 对消费者展示的券(商品)名称。 example: 满10减1 type: string voucher_send_mode_info: $ref: '#/components/schemas/VoucherSendModeInfo' voucher_send_rule: $ref: '#/components/schemas/CommonVoucherSendRule' voucher_status: description: 券状态。 example: SENDED type: string voucher_type: description: 券类型。 example: FIX_VOUCHER type: string voucher_use_rule: $ref: '#/components/schemas/CommonVoucherUseRule' voucher_use_rule_info: $ref: '#/components/schemas/VoucherUseRuleInfo' type: object AlipayMarketingActivityVoucherAppendErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityVoucherAppendModel: properties: activity_id: description: 活动id example: "2016042700826004508401111111" type: string merchant_access_mode: description: 商户接入模式 example: AGENCY_MODE type: string out_biz_no: description: "外部业务单号,用作幂等控制。\t\t幂等作用:\t参数不变的情况下,再次请求返回与上一次相同的结果。\t\t外部接入\ 方需保证业务单号唯一。" example: 20170101000001654bb46ba type: string voucher_quantity: description: 发行券的数量。。 限制: 券总预算<= 99999999 特别说明: 该字段的含义是追加到的数量。 不可减少,只能增加。 example: 100 type: integer type: object AlipayMarketingActivityVoucherAppendResponseModel: properties: recharge_url: description: "预充值链接\t\t限制\t有效时间3天" example: https://voucherprod.alipay.com/coupon/templatepayment.htm?templateId=20210829000730015448005XXOO&authNo=2021082910002001170507729XX5&operationId=202X0829X45X35X1170X type: string type: object AlipayMarketingActivityVoucherCreateErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - BIZ_ERROR - MATERIAL_AUDIT_WAITING type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityVoucherCreateModel: properties: activity_base_info: $ref: '#/components/schemas/ActivityBaseInfo' activity_name: description: 活动名称。 example: 满10减1活动 type: string belong_merchant_info: $ref: '#/components/schemas/PaymentVoucherBelongMerchantInfo' merchant_access_mode: description: 商户接入模式 example: AGENCY_MODE type: string out_biz_no: description: "用作幂等控制。\t\t幂等作用:\t参数不变的情况下,再次请求返回与上一次相同的结果。\t\t外部接入方需保证业务单\ 号唯一。" example: 20170101000001654bb46ba type: string publish_end_time: description: 券发放结束时间。 格式为:yyyy-MM-dd HH:mm:ss 限制: 券发放结束时间 publish_end_time 与 券发放开始时间 publish_start_time 间隔必须小于等于180天 example: 2017-01-29 23:59:59 type: string publish_start_time: description: 券发放开始时间。 格式为:yyyy-MM-dd HH:mm:ss example: 2017-01-01 00:00:01 type: string 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: description: 券类型 example: FIX_VOUCHER type: string voucher_use_rule: $ref: '#/components/schemas/PaymentVoucherUseRule' voucher_use_rule_info: $ref: '#/components/schemas/VoucherUseRuleInfo' type: object AlipayMarketingActivityVoucherCreateResponseModel: properties: activity_id: description: 活动id example: "2016042700826004508401111111" type: string type: object AlipayMarketingActivityVoucherModifyErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityVoucherModifyModel: properties: activity_base_info: $ref: '#/components/schemas/ActivityBaseInfo' activity_id: description: 活动id example: "2016042700826004508401111111" type: string merchant_access_mode: description: 商户接入模式 example: AGENCY_MODE type: string out_biz_no: description: 外部业务单号,用作幂等控制。 幂等作用: 参数不变的情况下,再次请求返回与上一次相同的结果。 example: 20170101000001654bb46ba type: string publish_end_time: description: 券发放结束时间。格式为:yyyy-MM-dd HH:mm:ss example: 2017-01-29 23:59:59 type: string 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' type: object AlipayMarketingActivityVoucherModifyResponseModel: type: object AlipayMarketingActivityVoucherPublishErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityVoucherPublishModel: properties: activity_id: description: 活动id example: "2016042700826004508401111111" type: string merchant_access_mode: description: 商户接入模式 example: AGENCY_MODE type: string out_biz_no: description: "用作幂等控制\t\t幂等作用:\t参数不变的情况下,再次请求返回与上一次相同的结果。\t外部接入方需保证业务单号唯一\ 。" example: 20170101000001654bb46ba type: string type: object AlipayMarketingActivityVoucherPublishResponseModel: properties: recharge_url: description: 预充值链接 example: https://voucherprod.alipay.com/coupon/templatepayment.htm?templateId=20210829000730015448005XXOO&authNo=2021082910002001170507729XX5&operationId=202X0829X45X35X1170X type: string type: object AlipayMarketingActivityVoucherQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityVoucherQueryResponseModel: properties: activity_base_info: $ref: '#/components/schemas/ActivityBaseInfo' activity_id: description: 活动 ID example: "2016042700826004508401111111" type: string activity_name: description: 活动名称。 不对用户进行展示,仅供商家在后台管理活动使用。 example: 满10减1活动 type: string activity_status: description: "活动状态。\t如果该值为空,说明活动还未创建成功。" example: ACTIVE type: string belong_merchant_info: $ref: '#/components/schemas/PaymentVoucherBelongMerchantInfo' publish_end_time: description: 券发放结束时间。 格式为:yyyy-MM-dd HH:mm:ss。 example: 2017-01-29 23:59:59 type: string publish_start_time: description: 券发放开始时间。 格式为:yyyy-MM-dd HH:mm:ss example: 2017-01-01 00:00:01 type: string 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: description: 优惠类型。 example: FIX_VOUCHER type: string voucher_use_rule: $ref: '#/components/schemas/PaymentVoucherUseRuleDetail' voucher_use_rule_info: $ref: '#/components/schemas/VoucherUseRuleInfo' type: object AlipayMarketingActivityVoucherSendErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - ACTIVITY_NOT_ACTIVE - ACTIVITY_NOT_START - ACTIVITY_IS_END - ACTIVITY_IS_STOPED - BUDGET_NOT_ENOUGH - COUNT_OVER_LIMIT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityVoucherSendModel: properties: activity_id: description: 活动id example: "2016042700826004508401111111" type: string merchant_access_mode: description: 商户接入模式 example: AGENCY_MODE type: string open_id: description: 领券的支付宝用户openId example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string out_biz_no: description: "外部业务单号,用作幂等控制。\t\t幂等作用:\t参数不变的情况下,再次请求返回与上一次相同的结果。\t\t外部接入\ 方需保证业务单号唯一。" example: 20170101000001654bb46ba type: string user_id: description: 领券的支付宝user_id账号 example: "2088512417841101" type: string type: object AlipayMarketingActivityVoucherSendResponseModel: properties: voucher_id: description: 本次发放的支付券id example: 2021072600073002785300065Q39 type: string type: object AlipayMarketingActivityVoucherStopErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityVoucherStopModel: properties: activity_id: description: 活动id example: "2016042700826004508401111111" type: string merchant_access_mode: description: 商户接入模式 example: AGENCY_MODE type: string out_biz_no: description: "64\t外部业务单号,用作幂等控制。\t\t幂等作用:\t参数不变的情况下,再次请求返回与上一次相同的结果。\t\t\ 外部接入方需保证业务单号唯一。" example: 20170101000001654bb46ba type: string type: object AlipayMarketingActivityVoucherStopResponseModel: type: object AlipayMarketingActivityVoucherpackageBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityVoucherpackageBatchqueryModel: properties: page_num: description: 分页参数,需要查询的页码,起始页是1 example: 1 type: integer page_size: description: 分页参数,每页记录数,最大不可超过30 example: 20 type: integer voucher_package_purchase_start_time: description: 券包购买开始时间。 格式为:yyyy-MM-dd HH:mm:ss example: 2017-01-01 00:00:01 type: string voucher_package_status: description: 券包状态 example: ENABLE type: string type: object AlipayMarketingActivityVoucherpackageBatchqueryResponseModel: properties: page_num: description: 分页参数,当前所在的页码 example: 1 type: integer page_size: description: 分页参数,每页记录数,最大不可超过30 example: 10 type: integer total_size: description: 券包总数量 example: 100 type: integer voucher_package_info: description: 券包信息 items: $ref: '#/components/schemas/VoucherPackageInfo' type: array type: object AlipayMarketingActivityVoucherpackageConsultErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityVoucherpackageConsultModel: properties: voucher_package_id_list: description: 券包id列表 example: "[\"IP20220628016671405804297103167741\"]" items: type: string type: array type: object AlipayMarketingActivityVoucherpackageConsultResponseModel: properties: voucher_package_consult_result: description: 券包购买咨询结果 items: $ref: '#/components/schemas/VoucherPackageConsultResult' type: array type: object AlipayMarketingActivityVoucherpackageQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - VOUCHER_PACKAGE_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingActivityVoucherpackageQueryResponseModel: properties: voucher_package_activity_info: description: 券包活动信息 items: $ref: '#/components/schemas/VoucherPackageActivityInfo' type: array voucher_package_base_info: $ref: '#/components/schemas/VoucherPackageBaseInfo' voucher_package_sales_info: $ref: '#/components/schemas/VoucherPackageSalesInfo' voucher_package_use_rule: $ref: '#/components/schemas/VoucherPackageUseRule' type: object AlipayMarketingCampaignCashCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingCampaignCashCreateModel: properties: coupon_name: description: "红包名称,商户在查询列表、详情看到的名字,同时也会显示在商户付款页面。" example: XXX周年庆红包 type: string end_time: description: "活动结束时间,必须大于活动开始时间, 基本格式:yyyy-MM-dd HH:mm:ss,活动有效时间最长为6个月,过\ 期后需要创建新的活动。" example: 2016-09-20 22:48:30 type: string merchant_link: description: "商户打款后的跳转链接,从支付宝收银台打款成功后的跳转链接。不填时,打款后停留在支付宝支付成功页。商户实际跳转会自动添\ 加crowdNo作为跳转参数。示例: http://www.yourhomepage.com?crowdNo=XXX" example: http://www.weibo.com type: string prize_msg: description: 活动文案,用户在账单、红包中看到的账单描述、红包描述。 example: XXX送您大红包 type: string prize_type: description: "现金红包的发放形式,。枚举支持:\t*fixed:固定金额。\t*random:随机金额。选择随机金额时,单个红包的\ 金额在平均金额的0.5~1.5倍之间浮动。\t" example: random type: string send_freqency: 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 type: string start_time: description: "活动开始时间,必须大于活动创建的时间。入参支持如下两种形式:\t 1. 填入固定时间,时间格式为 yyyy-MM-dd\ \ HH:mm:ss,如 2020-12-10 22:28:30\t 2. 填字符串 NowTime,表示创建即生效。" example: NowTime type: string total_money: description: "活动发放的现金总金额,最小金额1.00元,最大金额10000000.00元。每个红包的最大金额不允许超过200元,最\ 小金额不得低于0.20元。 实际的金额限制可能会根据业务进行动态调整。" example: "10000000.00" type: string total_num: 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" type: string type: object AlipayMarketingCampaignCashCreateResponseModel: properties: crowd_no: description: 生成的现金红包活动号 example: EPOJZsBg3A-CZOJE4qlbAueA7By4oJLDwEeYZlAiAnbMnSZ96O-zxUfKlHp5cxmx type: string origin_crowd_no: description: "原始活动号,商户排查问题时提供的活动依据" example: "20160901109410190092922300444004" type: string pay_url: description: 活动创建后的付款链接,返回的是urlencode编码后的字符串。需要先进行urldecode解码,然后在浏览器中进行访问,会先进行支付宝登录引导,然后商户进行付款,付款有效期24小时。 example: http%3a%2f%2fcashier.stable.alipay.net%2fstandard%2flightpay%2flightPayCashier.htm%3forderId%3d0826e2e3984d6fa7b92046.rz0NN4263% type: string type: object AlipayMarketingCampaignCashDetailQueryErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingCampaignCashDetailQueryResponseModel: properties: camp_status: description: "活动状态,CREATED: 已创建未打款\tPAID:已打款\tREADY:活动已开始\tPAUSE:活动已暂停\t\ CLOSED:活动已结束\tSETTLED:活动已清算" example: CREATED、PAID、READY、PAUSE、CLOSED、SETTLED type: string coupon_name: description: 红包名称 example: XXX周年庆红包 type: string crowd_no: description: 活动号 example: POYb84lfiKVdIfERAYsqPL_KQRIpfQbl47xfRmmPBlDMnSZ96O-zxUfKlHp5cxmx type: string end_time: description: 活动结束时间 example: 2016-08-10 22:28:30 type: string origin_crowd_no: description: "原始活动号,商户排查问题时提供的活动依据" example: "20160901029410190092922308762004" type: string prize_msg: description: "活动文案,用户在账单中看到的红包描述" example: XX送您大红包 type: string prize_type: description: "现金红包的发放形式, fixed为固定金额,random为随机金额" example: random type: string send_amount: description: 活动已发放金额 example: "200000.00" type: string start_time: description: 活动开始时间 example: 2016-08-10 22:28:30 type: string total_amount: description: 活动总金额 example: "20000.00" type: string total_count: description: 红包总个数 example: 1000 type: integer total_num: description: 红包总个数(废弃) example: 1000 type: integer type: object AlipayMarketingCampaignCashListQueryErrorResponseModel: properties: code: description: 错误码 enum: - BIZ_CONTENT_IS_EMPTY - CASH_LIST_PAGE_CHECK_FAILED - BIZ_CONTENT_FORMAT_ERROR - CALL_TOO_FREQUENCY - PRODUCT_IS_NOT_OPENED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingCampaignCashListQueryResponseModel: properties: camp_list: description: 活动列表 items: $ref: '#/components/schemas/CashCampaignInfo' type: array page_index: description: "分页的页码,起始从1开始" example: "1" type: string page_size: description: 分页每页大小 example: "10" type: string total_size: description: 活动总个数 example: "20" type: string type: object AlipayMarketingCampaignCashStatusModifyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingCampaignCashStatusModifyModel: properties: camp_status: description: "金活动修改后的状态。支持修改为:\t*PAUSE:活动暂停。\t*READY:活动开始。\t*CLOSED:活动结束\ 。" example: PAUSE type: string crowd_no: description: 现金活动号,通过alipay.marketing.campaign.cash.create(创建现金活动)接口创建现金活动获取。 example: HHV-vl7IKtHddoWgpHTOdL_KQRIpfQbl47xfRmmPBlDMnSZ96O-zxUfKlHp5cxmx type: string type: object AlipayMarketingCampaignCashStatusModifyResponseModel: type: object AlipayMarketingCampaignCashTriggerErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingCampaignCashTriggerModel: properties: crowd_no: description: 现金活动号,通过alipay.marketing.campaign.cash.create(创建现金活动)接口创建现金活动获取。 example: 3DpriXtAGxmDPi7QyeoKeX8wwS3qbKCcnigowys220Lxs type: string login_id: description: "用户登录账号名,一般为邮箱或手机号。\t注意:user_id与login_id二选一必填,同时传入时以user_id为\ 准。" example: username@gmail.com type: string open_id: description: open_id example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string order_price: description: 此字段如果传入金额,就忽略prize_type算法,按照传入的金额发奖。如果不传或者小于等于0,则按照活动创建时指定的prize_type为fixed或者random算法发奖 example: 100,单位为分,代表1元 type: string out_biz_no: description: 领取红包的外部业务号,只由可由字母、数字、下划线组成。同一个活动中不可重复,相同的外部业务号会被幂等并返回之前的结果。不填时,系统会生成一个默认固定的外部业务号。 example: "201702101356" type: string user_id: description: "用户支付宝唯一标识,2088开头。\t注意:user_id与login_id二选一必填,同时传入时以user_id为\ 准。" example: "2088102164186692" type: string type: object AlipayMarketingCampaignCashTriggerResponseModel: properties: biz_no: description: "支付宝业务号,发奖成功时返回,调用者可提供此字符串进行问题排查与核对等" example: "20170117110070001502640004976114" type: string coupon_name: description: "红包名称,创建活动时设置,用于账单列表和详情、红包列表和详情的展示" example: '***周年庆红包' type: string error_msg: description: 用户领取失败的错误信息描述 example: 用户实名验证不通过 type: string merchant_logo: description: 商户头像logo的图片url地址,用于账单和红包列表、详情的展示 example: http://tfs.alipay.com/images/partner/1111111xxxxxxx_160x160 type: string out_biz_no: description: "外部业务号,回填请求中的out_biz_no,请求参数中传了out_biz_no就会回传回去,如果不传就回传默认的\"\ default_out_biz_no\",请求者可用于日志记录与核对等" example: "2017021319450001" type: string partner_id: description: 发送红包商户签约pid,发奖成功时非空 example: "2088123456789012" type: string prize_amount: description: 现金红包金额,发奖成功时非空,单位为元,保留两位小数 example: "234.40" type: string prize_msg: description: "活动文案,用于账单的备注展示、红包详情页的文案展示" example: "XXX送您大红包,祝您中秋快乐" type: string repeat_trigger_flag: description: 用户是否重复领取,如果重复领取,返回的是之前的中奖结果,如果是首次领取,则走发奖流程 example: true或false type: string trigger_result: description: 是否中奖结果状态,取值为true或false。如果为true表示发奖成功,这时返回的结果中的其他字段非空;如果为false表示发奖失败,这时返回的其他字段为空 example: "true" type: string type: object AlipayMarketingCampaignOrderVoucherConsultErrorResponseModel: properties: code: description: 错误码 enum: - ILLEGAL_ARGUMENT_EXCEPTION - CONSULT_EXCEPTION type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingCampaignOrderVoucherConsultModel: properties: business_param: description: 业务参数大字段,优惠咨询的控制参数,json格式;目前支持传入useBigAmountSkipOrderThold为N来控制不使用大金额跳过优惠的订单门槛检查;默认不传; example: "{\"useBigAmountSkipOrderThold\":\"N\"}" type: string item_consult_list: description: 商品咨询请求列表(当需要咨询单品券时必传,如果某商品不希望参与本次单品优惠咨询则不传递对应信息即可) items: $ref: '#/components/schemas/ItemConsultRequest' type: array order_amount: description: 订单金额(如同时享受商户自有优惠请先扣除后传入),单位为元,最多2位小数 example: "120.87" type: string scene_code: description: 场景码:默认(DEFAULT) example: "[\"DEFAULT\"]" items: type: string type: array specified_app_id: description: 券指定的核销appid(如果配券时指定了核销范围为线上小程序及相应的appid则此处必传) example: "2021001159604390" type: string type: object AlipayMarketingCampaignOrderVoucherConsultResponseModel: properties: optimal_total_promo_amount: description: 最优券叠加总优惠金额,单位为元 example: "15.50" type: string voucher_consult_list: description: 优惠券咨询结果列表 items: $ref: '#/components/schemas/VoucherConsultInfo' type: array type: object AlipayMarketingCardActivateformQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - OPEN_PROFILE_QUERY_FAIL - REQUEST_ID_EXPIRE - REQUEST_ID_INVALID - ILLEGAL_NULL_ARGUMENT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingCardActivateformQueryResponseModel: properties: infos: description: "表单提交信息各个字段的值JSON数组\t\t\t\t通用表单字段名称如下示例:\t\tOPEN_FORM_FIELD_MOBILE\ \ – 手机号\t\tOPEN_FORM_FIELD_GENDER – 性别\t\tOPEN_FORM_FIELD_NAME – 姓名\t\t\ OPEN_FORM_FIELD_BIRTHDAY – 生日\t\tOPEN_FORM_FIELD_IDCARD – 身份证\t\tOPEN_FORM_FIELD_EMAIL\ \ – 邮箱\t\tOPEN_FORM_FIELD_ADDRESS – 地址\t\t\t\t详细字段名称列表见会员卡开卡表单模板配置接口:\ alipay.marketing.card.formtemplate.set\t\t\t\t注:\t\t1. 证件类型字段(OPEN_FORM_FIELD_CERT_TYPE)返\ 回结果取值如下:\t\t 0 -- 身份证\t\t 1 -- 护照\t\t 2 -- 港澳居民通行证\t\t 3 --\ \ 台湾居民通行证" example: "[{\"OPEN_FORM_FIELD_GENDER\":\"男\"},{\"OPEN_FORM_FIELD_MOBILE\"\ :\"13888888888\"},{\"OPEN_FORM_FIELD_NAME\":\"李四\"}]" type: string type: object AlipayMarketingCardActivateurlApplyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - CARD_TEMPLATE_NOT_EXIST - OPEN_FORM_TEMPLATE_NOT_EXIST - ILLEGAL_ARGUMENT_OUT_STRING - ILLEGAL_NULL_ARGUMENT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingCardActivateurlApplyModel: properties: callback: description: "会员卡开卡表单提交后回调地址。要求必须是单纯的服务端接收回调。\t说明:\t1.该地址不可带参数,如需回传参数,可设\ 置out_string入参。" example: https://alipay.com/card/demo.htm type: string follow_app_id: description: 需要关注的生活号AppId。若需要在领卡页面展示“关注生活号”提示,需开通生活号并绑定会员卡。生活号快速接入详见:https://doc.open.alipay.com/docs/doc.htm?treeId=193&articleId=105933&docType=1 example: "20150000000000000" type: string out_string: description: 该值为商家拉起开卡组件的传递的 out_string 值。通常可用于区分不同业务场景,禁止将该字段作为开卡流程的必要字段,否则会导致会员推广场景下的入会失败 example: "201928393932" type: string template_id: description: 会员卡模板id。使用会员卡模板创建接口(alipay.marketing.card.template.create)返回的结果 example: "20170228000000000210102000300974" type: string type: object AlipayMarketingCardActivateurlApplyResponseModel: properties: apply_card_url: description: 会员卡领卡链接(使用时需URLDecode解码)。商户获取此链接后可投放到服务窗消息、店铺二维码等。 example: https%3A%2F%2Fmemberprod.alipay.com%2Faccount%2Fopenform%2Factivecard.htm%3Fapp_id%3D2017051007191443%26template_id%3D2017053100 type: string type: object AlipayMarketingCardBenefitCreateErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - TEMPLATE_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingCardBenefitCreateModel: properties: mcard_template_benefit: $ref: '#/components/schemas/McardTemplateBenefit' type: object AlipayMarketingCardBenefitCreateResponseModel: properties: benefit_id: description: 权益ID example: "2017040600077000000002409504" type: string type: object AlipayMarketingCardBenefitDeleteErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - TEMPLATE_NOT_EXIST - BENEFIT_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingCardBenefitDeleteResponseModel: properties: result: description: 权益删除结果;true成功,false失败 example: true type: boolean type: object AlipayMarketingCardBenefitModifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - TEMPLATE_NOT_EXIST - BENEFIT_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingCardBenefitModifyModel: properties: benefit_id: description: 权益ID,通过 alipay.marketing.card.benefit.create(会员卡模板外部权益创建)接口创建获取。 example: "2017040600077000000002409504" type: string mcard_template_benefit: $ref: '#/components/schemas/McardTemplateBenefit' type: object AlipayMarketingCardBenefitModifyResponseModel: properties: result: description: 权益修改结果;true成功:false失败 example: true type: boolean type: object AlipayMarketingCardBenefitQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - TEMPLATE_NOT_EXIST - BENEFIT_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingCardBenefitQueryResponseModel: properties: mcard_template_benefit_query: description: 会员卡模板外部权益列表 items: $ref: '#/components/schemas/McardTemplateBenefitQuery' type: array type: object AlipayMarketingCardConsumeSyncErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - CARD_NOT_EXIT - NO_CARD_TYPE type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingCardConsumeSyncModel: properties: act_pay_amount: description: "用户实际付的现金金额\t\t1.针对预付卡面额的核销金额在use_benefit_list展现,作为权益金额\t\t\ 2.权益金额不叠加在该金额上" example: "23.9" type: string card_info: $ref: '#/components/schemas/MerchantCard' gain_benefit_list: description: 获取权益列表 items: $ref: '#/components/schemas/BenefitInfoDetail' type: array memo: description: 备注信息,现有直接填写门店信息 example: 用户门店充值100 type: string shop_code: description: 门店编号 example: "201606270000001" type: string swipe_cert_type: description: "产生该笔交易时,用户出具的凭证类型。枚举支持:\t*ALIPAY:支付宝电子卡;\t*ENTITY:实体卡;\t*OTHER:\ 其他。" example: ALIPAY type: string target_card_no: description: 支付宝业务卡号,即通过alipay.marketing.card.open(会员卡开卡)接口开卡后获取的 card_info.biz_card_no 值。 example: "0000001" type: string target_card_no_type: description: "卡号ID类型。支持:\t*BIZ_CARD:支付宝业务卡号(商户会员卡场景使用)。" example: BIZ_CARD type: string trade_amount: description: 交易金额:本次交易的实际总金额(可认为标价金额) example: "67.5" type: string trade_name: description: 交易名称。为空时支付宝将根据交易类型提供默认名称。 example: 预付卡充值100元 type: string trade_no: description: 支付宝交易号 example: "201606270000000001" type: string trade_time: description: "线下交易时间,为用户付款的交易时间。\t说明:当交易时间晚于上次消费记录同步时间时,将变更会员卡信息。" example: 2012-11-22 10:47:20 type: string trade_type: description: "交易类型。枚举支持:\t*开卡:OPEN;\t*消费:TRADE;\t*充值:DEPOSIT;\t*退卡:RETURN。" example: DEPOSIT type: string use_benefit_list: description: 实际消耗的权益 items: $ref: '#/components/schemas/BenefitInfoDetail' type: array type: object AlipayMarketingCardConsumeSyncResponseModel: properties: external_card_no: description: 外部卡号 example: EXT10000001 type: string type: object AlipayMarketingCardDeleteErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - CARD_NOT_EXIT - NO_CARD_TYPE - CARD_IS_DELETED_ALREADY type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingCardDeleteResponseModel: properties: biz_serial_no: description: 支付宝端删卡业务流水号 example: "2016062700001" type: string type: object AlipayMarketingCardFormtemplateSetErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingCardFormtemplateSetModel: properties: fields: $ref: '#/components/schemas/OpenFormFieldDO' template_id: description: 会员卡模板id。调用alipay.marketing.card.template.create(会员卡模板创建接口)创建模板后同步返回。 example: "20170228000000000210102000300974" type: string type: object AlipayMarketingCardFormtemplateSetResponseModel: type: object AlipayMarketingCardMessageNotifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - CARD_NOT_EXIT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingCardMessageNotifyModel: properties: notify_info: description: "消息通知详情,包含消息通知需要的信息,map 格式存储。\t积分过期提醒:\t
expired_point 过\ 期积分值\t
expired_time 过期时间" example: "{\"expired_point\":\"121\"}" type: string notify_no: description: 消息通知幂等标识,业务流水号 example: "2000000000001" type: string notify_type: description: "消息通知类型,\t
POINT_REMIND 积分过期提醒" example: POINT_REMIND type: string occur_time: description: 标识业务发生时间,时间格式为"yyyy-MM-dd HH:mm:ss"。 example: 2020-12-27 12:12:12 type: string target_card_no: description: 支付宝业务卡号,即通过 alipay.marketing.card.open 接口开卡后获取的 card_info.biz_card_no 值。 example: "000001" type: string target_card_no_type: description: 卡号ID类型 example: BIZ_CARD type: string type: object AlipayMarketingCardMessageNotifyResponseModel: properties: result_code: description: 二级错误处理结果(如果公用返回结果为false,则可以看这个接口判断明细原因) 如果公用返回为true,则该字段为空 example: isv.update-usercard-fail type: string type: object AlipayMarketingCardOpenErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingCardOpenModel: properties: card_ext_info: $ref: '#/components/schemas/MerchantCard' card_template_id: description: 支付宝分配的卡模板Id(卡模板创建接口返回的模板ID) example: "201606270000001" type: string card_user_info: $ref: '#/components/schemas/CardUserInfo' member_ext_info: $ref: '#/components/schemas/MerchantMenber' open_card_channel: description: "领卡渠道,用于记录外部商户端领卡来源的渠道信息,渠道值可自行定义(仅限数字、字母、下划线) \t\t可直接标识领卡渠\ 道,也可配合open_card_channel_id标识领卡渠道类型:\t\t例如:\t\t线下门店领取:20161534000000000008863(\ 直接标识领卡渠道,门店shopId)\t\t线下扫二维码领取:QR(标识领卡类型);\t\t线下活动领取:20170522000000000003609(\ 直接标识领卡渠道,商户活动ID)" example: "20161534000000000008863" type: string open_card_channel_id: description: "领卡来源的渠道id,注意区别于open_card_channel领卡渠道;\t\t一般使用场景:\t\topen_card_channel用\ 于区分渠道类型,例如取值为\"SHOP\"(门店),\"ACTIVITY\"(活动);\t\t则open_card_channel_id可用\ 于区分同渠道的不同实体,对应取各门店ID或各活动的标识ID等;" example: "123123123123" type: string out_serial_no: description: 外部商户流水号。由商户自定义,需保证商户系统中唯一。 example: "2016062700001" type: string paid_outer_card_info: $ref: '#/components/schemas/PaidOuterCardExtraInfoDTO' type: object AlipayMarketingCardOpenResponseModel: properties: card_info: $ref: '#/components/schemas/MerchantCard' open_card_channel: description: "实际记录的领卡渠道(可能跟商户传入值不同);\t\t可直接标识领卡渠道,也可配合open_card_channel_id标\ 识领卡渠道类型:\t\t例如:\t\t线下门店领取:20161534000000000008863(直接标识领卡渠道,门店shopId)\t\ \t线下扫二维码领取:QR(标识领卡类型);\t\t线下活动领取:20170522000000000003609(直接标识领卡渠道,商户活动\ ID)" example: "20161534000000000008863" type: string open_card_channel_id: description: "实际记录的领卡来源渠道id(可能跟商户传入值不同);\t\t区别于open_card_channel领卡渠道;\t\t\ 一般使用场景:\t\topen_card_channel用于区分渠道类型,例如取值为\"SHOP\"(门店),\"ACTIVITY\"(活动\ );\t\t则open_card_channel_id可用于区分同渠道的不同实体,对应取各门店ID或各活动的标识ID等;" example: "123123123123" type: string type: object AlipayMarketingCardQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - CARD_NOT_EXIT - NO_CARD_TYPE type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingCardQueryModel: properties: card_user_info: $ref: '#/components/schemas/CardUserInfo' ext_info: description: 扩展信息,暂时没有 example: "{\"key\":\"value\"}" type: string target_card_no: 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" type: string target_card_no_type: description: 卡号ID类型 example: BIZ_CARD type: string template_id: description: 会员卡模板id。调用alipay.marketing.card.template.create(会员卡模板创建接口)创建模板后同步返回。 example: "20200312000000000414103000300846" type: string type: object AlipayMarketingCardQueryResponseModel: properties: card_info: $ref: '#/components/schemas/MerchantCard' paid_outer_card_info: $ref: '#/components/schemas/PaidOuterCardExtraInfoDTO' pass_id: description: "商家会员卡页面跳转到支付宝卡券详情页的pass_id,对应schema地址中的参数p,\t主要用于小程序跳往会员卡详\ 情的链接拼接" example: "21942125" type: string schema_url: description: 商家会员卡页面跳转到支付宝卡券详情页面的schema地址 example: alipays://platformapi/startapp?appId=20000021&b=m&p=111 type: string type: object AlipayMarketingCardTemplateBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingCardTemplateBatchqueryModel: properties: page_no: description: 查询起始页码,第一页为 1。 example: 1 type: integer page_size: description: 每页数据大小,默认 20条,最大支持20条。 example: 20 type: integer type: object AlipayMarketingCardTemplateBatchqueryResponseModel: properties: mcard_template: description: 会员卡模板基本信息 items: $ref: '#/components/schemas/McardTemplate' type: array template_total: description: 会员卡模板总数 example: 10 type: integer type: object AlipayMarketingCardTemplateCreateErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - TEMPLATE_NOT_EXIT - NO_CARD_TYPE - TEMPLATE_OVER_LIMIT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingCardTemplateCreateModel: properties: access_version: description: 接入版本 example: basic type: string biz_no_prefix: description: "业务卡号前缀,由商户指定\t\t支付宝业务卡号生成规则:biz_no_prefix(商户指定)卡号前缀 + biz_no_suffix(实\ 时生成)卡号后缀" example: prex type: string biz_no_suffix_len: description: 业务卡号后缀长度,与biz_no_prefix配合,扣除系统预留2位,剩下对应seq长度。在生成卡号时,若seq位数不足前置补0,若seq位数超出则以实际为准。举例:设为10,其中8位用于生成seq,可覆盖1亿用户,即使seq超过1亿,生成卡号也不报错,但总长度不得超过32位。建议按需设置合适的值,以获得长度一致的业务卡号,建议长度20,性能更好。 example: "20" type: string card_action_list: description: '"卡行动点配置; 行动点,即用户可点击跳转的区块,类似按钮控件的交互; 单张卡最多定制3个行动点。如果各项的配置内容完全一样,展示时会进行去重。"' items: $ref: '#/components/schemas/TemplateActionInfoDTO' type: array card_level_conf: description: 卡级别配置 items: $ref: '#/components/schemas/TemplateCardLevelConfDTO' type: array card_spec_tag: description: 卡特定标签,只供特定业务使用,通常接入无需关注 example: NONE type: string card_type: description: 卡类型 example: OUT_MEMBER_CARD type: string column_info_list: description: 栏位信息 items: $ref: '#/components/schemas/TemplateColumnInfoDTO' type: array field_rule_list: description: '"字段规则列表,会员卡开卡过程中,会员卡信息的生成规则, 例如:卡有效期为开卡后两年内有效,则设置为:DATE_IN_FUTURE"' items: $ref: '#/components/schemas/TemplateFieldRuleDTO' type: array mdcode_notify_conf: $ref: '#/components/schemas/TemplateMdcodeNotifyConfDTO' notify_url: description: 通知地址 type: string open_card_conf: $ref: '#/components/schemas/TemplateOpenCardConfDTO' paid_outer_card_conf: $ref: '#/components/schemas/PaidOuterCardTemplateConfDTO' pub_channels: description: 卡模板投放渠道 items: $ref: '#/components/schemas/PubChannelDTO' type: array request_id: description: 请求ID,商家自定义且并保证唯一性。 example: "2016072100000000001" type: string service_label_list: description: 服务标签列表 example: "[\"HUABEI_FUWU\"]" items: type: string type: array shop_ids: description: 会员卡上架门店id(支付宝门店id),即发放会员卡的商家门店id example: "[\"2015122900077000000002409504\"]" items: type: string type: array spi_app_id: description: "spi应用id,为实现spi.alipay.user.opencard.get接口的app_id。若是第三方代理模式\ ,可以设置成服务商的 APPID 或者是商家自己的 APPID;\t若不是第三方代理模式,只能设置商家自己的 APPID。" example: "2021001160639010" type: string template_benefit_info: description: '"权益信息, 1、在卡包的卡详情页面会自动添加“会员权益”栏位,展现此字段配置的会员卡权益信息, 2、如果添加门店渠道,则可在门店页展现会员卡的权益"' items: $ref: '#/components/schemas/TemplateBenefitInfoDTO' type: array template_form_config: $ref: '#/components/schemas/TemplateFormConfig' template_style_info: $ref: '#/components/schemas/TemplateStyleInfoDTO' write_off_type: 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 type: string type: object AlipayMarketingCardTemplateCreateResponseModel: properties: template_id: description: 支付宝卡模板ID example: "201607180000001" type: string type: object AlipayMarketingCardTemplateModifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - TEMPLATE_NOT_EXIT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingCardTemplateModifyModel: properties: access_version: description: 接口接入版本 example: basic type: string biz_no_prefix: description: "业务卡号前缀,由商户指定\t\t支付宝业务卡号生成规则:biz_no_prefix(商户指定)卡号前缀 + biz_no_suffix(实\ 时生成)卡号后缀" example: prex type: string biz_no_suffix_len: description: 业务卡号后缀长度,与biz_no_prefix配合,扣除系统预留2位,剩下对应seq长度。在生成卡号时,若seq位数不足前置补0,若seq位数超出则以实际为准。举例:设为10,其中8位用于生成seq,可覆盖1亿用户,即使seq超过1亿,生成卡号也不报错,但总长度不得超过32位。建议按需设置合适的值,以获得长度一致的业务卡号,建议长度20,性能更好。 example: "10" type: string card_action_list: description: '"卡行动点配置; 行动点,即用户可点击跳转的区块,类似按钮控件的交互; 单张卡最多定制4个行动点。"' items: $ref: '#/components/schemas/TemplateActionInfoDTO' type: array card_level_conf: description: 卡级别配置 items: $ref: '#/components/schemas/TemplateCardLevelConfDTO' type: array card_spec_tag: description: 卡特定标签,只供特定业务使用,通常接入无需关注 example: NONE type: string column_info_list: description: 栏位信息(卡包详情页面展现的栏位) items: $ref: '#/components/schemas/TemplateColumnInfoDTO' type: array field_rule_list: description: '"字段规则列表,会员卡开卡过程中,会员卡信息的生成规则, 例如:卡有效期为开卡后两年内有效,则设置为:DATE_IN_FUTURE 注意:商家会员卡场景不支持修改该内容。 "' items: $ref: '#/components/schemas/TemplateFieldRuleDTO' type: array mdcode_notify_conf: $ref: '#/components/schemas/TemplateMdcodeNotifyConfDTO' open_card_conf: $ref: '#/components/schemas/TemplateOpenCardConfDTO' paid_outer_card_conf: $ref: '#/components/schemas/PaidOuterCardTemplateConfDTO' pub_channels: description: 卡模板投放渠道 items: $ref: '#/components/schemas/PubChannelDTO' type: array request_id: description: 请求 ID,商户自定义且需确保每次请求唯一。 example: "2016072100000000001" type: string shop_ids: description: "会员卡上架门店 id(支付宝门店id),即发放会员卡的商家门店id。不传则保持创建模板时信息。\t注意:不支持删除已\ 有shop_id,仅支持新增。" example: "[\"2015122900077000000002409504\"]" items: type: string type: array spi_app_id: description: "spi应用id,为实现spi.alipay.user.opencard.get接口的app_id。若是第三方代理模式\ ,可以设置成服务商的 APPID 或者是商家自己的 APPID;\t若不是第三方代理模式,只能设置商家自己的 APPID。" example: "2014072300007148" type: string template_benefit_info: description: '"权益信息, 1、在卡包的卡详情页面会自动添加权益栏位,展现会员卡特权, 2、如果添加门店渠道,则可在门店页展现会员卡的权益"' items: $ref: '#/components/schemas/TemplateBenefitInfoDTO' type: array template_form_config: $ref: '#/components/schemas/TemplateFormConfig' template_id: description: 会员卡模板id。调用alipay.marketing.card.template.create(会员卡模板创建接口)创建模板后同步返回。 example: "201607180000001" type: string template_style_info: $ref: '#/components/schemas/TemplateStyleInfoDTO' write_off_type: 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 type: string type: object AlipayMarketingCardTemplateModifyResponseModel: properties: template_id: description: 模板ID example: "2016071800000000001" type: string type: object AlipayMarketingCardTemplateQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - TEMPLATE_NOT_EXIT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingCardTemplateQueryResponseModel: properties: access_version: description: 接入版本,接入的是基础版本一定会有值 example: basic type: string biz_no_prefix: description: "业务卡号前缀,由商户指定\t\t支付宝业务卡号生成规则:biz_no_prefix(商户指定)卡号前缀 + biz_no_suffix(实\ 时生成)卡号后缀" example: prex type: string biz_no_suffix_len: description: "业务卡号后缀的长度\t\t支付宝业务卡号生成规则:biz_no_prefix(商户指定)卡号前缀 + biz_no_suffix(实\ 时生成)卡号后缀" example: "10" type: string card_action_list: description: '"卡行动点配置; 行动点,即用户可点击跳转的区块,类似按钮控件的交互; 单张卡最多4个行动点。"' items: $ref: '#/components/schemas/TemplateActionInfoDTO' type: array card_level_confs: description: 卡等级配置 items: $ref: '#/components/schemas/TemplateCardLevelConfDTO' type: array card_spec_tag: description: 卡特定标签,只供特定业务使用,通常接入无需关注 example: NONE type: string card_type: description: "会员卡类型:\r\tOUT_MEMBER_CARD:外部权益卡" example: OUT_MEMBER_CARD type: string column_info_list: description: 栏位信息(卡包详情页面展现的栏位) items: $ref: '#/components/schemas/TemplateColumnInfoDTO' type: array field_rule_list: description: '"字段规则列表,会员卡开卡过程中,会员卡信息的生成规则, 例如:卡有效期为开卡后两年内有效,则设置为:DATE_IN_FUTURE"' items: $ref: '#/components/schemas/TemplateFieldRuleDTO' type: array mdcode_notify_conf: $ref: '#/components/schemas/TemplateMdcodeNotifyConfDTO' open_card_conf: $ref: '#/components/schemas/TemplateOpenCardConfDTO' paid_outer_card_conf: $ref: '#/components/schemas/PaidOuterCardTemplateConfDTO' pub_channels: description: 卡模板投放渠道 items: $ref: '#/components/schemas/PubChannelDTO' type: array service_label_list: description: 服务标签列表 example: "[\"HUABEI_FUWU\"]" items: type: string type: array shop_ids: description: 支付宝门店id example: "[\"2015122900077000000002409504\"]" items: type: string type: array spi_app_id: description: spi应用id,设置的实现spi.alipay.user.opencard.get接口的app_id example: "2014072300007148" type: string template_benefit_info: description: '"权益信息, 1、在卡包的卡详情页面会自动添加权益栏位,展现会员卡特权, 2、如果添加门店渠道,则可在门店页展现会员卡的权益"' items: $ref: '#/components/schemas/TemplateBenefitInfoDTO' type: array template_form_config: $ref: '#/components/schemas/TemplateFormConfig' template_style_info: $ref: '#/components/schemas/TemplateStyleInfoDTO' type: object AlipayMarketingCardUpdateErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - NO_CARD_TYPE - CARD_NOT_EXIT - PAIDOUTERCARD_LACK_TEMPLATE_CONFIG type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingCardUpdateModel: properties: card_info: $ref: '#/components/schemas/MerchantCard' ext_info: description: 扩展信息(暂时无用) example: "{\"key\":\"value\"}" type: string mcard_style_info: $ref: '#/components/schemas/McardStylInfo' merchant_card_msg_info: $ref: '#/components/schemas/MerchantCardMsgInfo' notify_messages: description: "注意:此字段已废弃。\t卡信息变更通知消息\t1、在列表中定义的消息,才会发送给用户,消息格式一定。\t2、根据卡信\ 息变更情况,一次可发送多个消息" items: $ref: '#/components/schemas/McardNotifyMessage' type: array occur_time: description: 业务发生时间,时间格式为"yyyy-MM-dd HH:mm:ss"。 example: 2020-12-27 12:12:12 type: string paid_outer_card_info: $ref: '#/components/schemas/PaidOuterCardExtraInfoDTO' target_card_no: description: 支付宝业务卡号:1、3.0(历史版本)版本来源于alipay.marketing.card.open(会员卡开卡)接口开卡后获取的 card_info.biz_card_no 值;2、极速版来源于spi.alipay.user.opencard.get(会员卡开通,获取会员卡信息)请求参数中的biz_card_no值。 example: "000001" type: string target_card_no_type: description: 卡号ID类型 example: BIZ_CARD type: string type: object AlipayMarketingCardUpdateResponseModel: properties: result_code: description: "二级错误处理结果(如果公用返回结果为false,则可以看这个接口判断明细原因)\r\t如果公用返回为true,则该字\ 段为空" example: isv.update-usercard-fail type: string type: object AlipayMarketingMaterialCreateErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - MATERIALSPECID_NOT_EXIST - INVALID_PARAMETER - MATERIALSPEC_CHECK_FAILED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingMaterialCreateModel: properties: material_fields: description: 素材字段列表,素材提报的具体内容,包含三种类型:图片、文本、链接。图片类型,则根据“图片资源上传接口(https://opendocs.alipay.com/pre-open/02bhlj)”中返回的resource_id字段值进行素材字段的设值。文本或链接类型,则按照实际需要设值即可,需满足具体的规范要求。规范要求详情请参见产品文档。 items: $ref: '#/components/schemas/MaterialField' type: array material_name: description: 素材名称,接入方自行生成,建议命名时遵循一定的规律以方便管理。 example: 测试素材名称 type: string material_spec_id: description: 素材规范ID,用于标识具体场景下的素材规范,根据具体的使用场景获取对应的素材规范ID。 example: "2019041301000200000077970001" type: string out_biz_no: description: 外部业务单号,用作幂等控制,相同单号会返回上一次的结果,接入方需保证单号唯一。 example: 21ba1e1c16456985463242192e4d type: string type: object AlipayMarketingMaterialCreateResponseModel: properties: material_id: description: 素材ID。 example: "2019070100903002019700470001" type: string type: object AlipayMarketingMaterialImageUploadErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - FILE_SIZE_OUT_OF_RANGE - PIC_SUFFIX_ILLEGAL - FILE_TYPE_ERROR - MATERIAL_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingMaterialImageUploadModel: properties: belong_merchant_info: $ref: '#/components/schemas/BelongMerchantInfo' file_key: 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 type: string merchant_access_mode: description: 商户接入模式 example: SELF_MODE type: string type: object AlipayMarketingMaterialImageUploadResponseModel: properties: resource_enhance: description: 图片是否优化过。系统会根据要求,若上传的图片不符合要求的尺寸,会对上传的图片做尺寸的优化。 example: false type: boolean resource_id: description: 图片唯一资源ID example: adeDSktiQO-u5vJUqVbcQwAAACMAAQED type: string resource_url: description: 上传后图片的url地址 example: https://mdn.alipayobjects.com/afts/img/A*o-BSQa2Pnq4mIFdCjUnmqAAAARwnAQ/original?bz=promo_merchant type: string type: object AlipayMarketingRecruitEnrollCloseErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - BIZ_ERROR - PROHIBIT_NEW_DEVELOPER_CALL - ONLY_NEW_INTERFACE_SUPPORT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingRecruitEnrollCloseModel: properties: enroll_id: description: 活动报名ID example: "2021041201000200000000999999" type: string type: object AlipayMarketingRecruitEnrollCloseResponseModel: type: object AlipayMarketingRecruitEnrollCreateErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - BIZ_ERROR - PROHIBIT_NEW_DEVELOPER_CALL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingRecruitEnrollCreateModel: properties: enroll_info: $ref: '#/components/schemas/RecruitEnrollInfo' enroll_scene_type: description: "活动报名场景配置。\t枚举值:\tVOUCHER:券报名场景的报名;\tMINI_APP:小程序报名场景的报名;" example: VOUCHER type: string out_biz_no: description: 外部操作流水号。由商家/ISV 自定义,仅支持字母、数字、下划线且需保证每次操作唯一。 example: 21ba1e1c16456985463242192e4d type: string plan_id: description: 要报名的招商方案ID example: "2021041301000200000077974217" type: string type: object AlipayMarketingRecruitEnrollCreateResponseModel: properties: enroll_id: description: 报名ID example: "2021041301000200000077974217" type: string out_biz_no: description: 外部操作流水号。由商家/ISV 自定义,仅支持字母、数字、下划线且需保证每次操作唯一。 example: 21ba1e1c16456985463242192e4d type: string type: object AlipayMarketingRecruitEnrollQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - BIZ_ERROR - PROHIBIT_NEW_DEVELOPER_CALL - ONLY_NEW_INTERFACE_SUPPORT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingRecruitEnrollQueryResponseModel: properties: enroll_id: description: 报名ID example: "2021041301000200000000000000" type: string enroll_info: $ref: '#/components/schemas/RecruitEnrollInfo' enroll_scene_type: description: "报名所属的活动报名场景。\t枚举值: VOUCHER:属于券报名场景;\tMINI_APP:属于小程序报名场景;" example: VOUCHER type: string enroll_time: description: 报名时间 example: 2020-10-10 10:10:10 type: string memo: description: 备注字段 example: 报名审核不通过 type: string out_biz_no: description: 外部操作流水号。由商家/ISV 自定义,仅支持字母、数字、下划线且需保证每次操作唯一。 example: 21ba1e1c16456985463242192e4d type: string plan_id: description: 招商方案ID example: "2021041301000200000000000000" type: string status: description: 报名状态: AUDITING 审核中; ENABLED 通过 ; REJECTED 不通过 ; CLOSING 下线审核中 ; CLOSED 已下线; example: ENABLED type: string type: object AlipayMarketingRecruitPlanQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - BUSINESS_FAILED - PROHIBIT_NEW_DEVELOPER_CALL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayMarketingRecruitPlanQueryModel: properties: enroll_merchant: $ref: '#/components/schemas/RecruitEnrollMerchant' plan_id: description: 招商方案ID example: "2021042001000100000000668277" type: string type: object AlipayMarketingRecruitPlanQueryResponseModel: properties: description: description: 招商方案描述:富文本内容,可能包含html标签 example:

招商规则说明

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

client detail

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

pc detail

type: string mini_app_id: description: 插件id example: "2012211102012056" type: string sell_crowd: description: "可订购人群,1003个人, 1004企业,-1无限制" example: "-1" type: string show_type: description: 发布后是否展示,01展示(默认)、02隐藏 example: "01" type: string title: description: 服务标题 example: 互投插件 type: string visit_url_for_pc: description: pc端url地址,不需要则为空 example: https://nengli.alipay.com/abilityprod/detail?abilityCode=SM010000000000001100 type: string type: object AlipayOpenMiniInnerappPluginservicePublishResponseModel: properties: ability_id: description: PL2012211102012056 example: 能力中心id type: string type: object AlipayOpenMiniInnerappPluginsyncmodeModifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMS - UPDATE_PLUGIN_SERVICE_FAIL - SUB_APPLICATION_TYPE_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerappPluginsyncmodeModifyModel: properties: app_origin: description: 来源 example: "-" type: string mini_app_id: description: 小程序应用 ID, example: "2021001177654214" type: string plugin_id: description: 插件id example: "2021002146679702" type: string sync_mode: description: 模式,SYNC/NONE example: SYNC type: string type: object AlipayOpenMiniInnerappPluginsyncmodeModifyResponseModel: type: object AlipayOpenMiniInnerappPluginuseconfigCancelErrorResponseModel: properties: code: description: 错误码 enum: - CAN_NOT_GRAY_EXIST_VERSION - CURRENT_VERSION_IS_ONLINE - APP_INFO_NOT_EXIST - PLUGIN_NOT_ORDERED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerappPluginuseconfigCancelModel: properties: app_origin: description: 来源 example: "-" type: string bundle_id: description: 端id example: com.alipay.alipaywallet type: string mini_app_id: description: 小程序应用 ID example: "2021002146679701" type: string plugin_dev_version: description: 插件研发版本 example: 0.0.3 type: string plugin_id: description: 插件id example: "2021002146679702" type: string type: object AlipayOpenMiniInnerappPluginuseconfigCancelResponseModel: type: object AlipayOpenMiniInnerappPluginuseconfigOnlineErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMS - PLUGIN_NOT_ORDERED - APP_INFO_NOT_EXIST - CAN_NOT_GRAY_EXIST_VERSION - CURRENT_VERSION_IS_ONLINE type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerappPluginuseconfigOnlineModel: properties: app_origin: description: 来源 example: "-" type: string bundle_id: description: 端id example: com.alipay.alipaywallet type: string mini_app_id: description: 小程序应用 ID example: "2021002146679701" type: string plugin_dev_version: description: 插件研发版本 example: 0.0.3 type: string plugin_id: description: 插件id example: "2021002146679702" type: string type: object AlipayOpenMiniInnerappPluginuseconfigOnlineResponseModel: type: object AlipayOpenMiniInnerappPluginuseconfigUpgradeErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMS - PLUGIN_NOT_ORDERED - APP_INFO_NOT_EXIST - CAN_NOT_GRAY_EXIST_VERSION - CURRENT_VERSION_IS_ONLINE type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerappPluginuseconfigUpgradeModel: properties: app_origin: description: 来源 example: "-" type: string bundle_id: description: 端id example: com.alipay.alipaywallet type: string mini_app_id: description: 小程序应用 ID example: "2021002146679701" type: string plugin_dev_version: description: 插件研发版本 example: 0.0.3 type: string plugin_id: description: 插件id example: "2021002146679702" type: string strategy_value: description: 灰度值 example: p50 type: string type: object AlipayOpenMiniInnerappPluginuseconfigUpgradeResponseModel: type: object AlipayOpenMiniInnerappServicePublishErrorResponseModel: properties: code: description: 错误码 enum: - APP_ORIGIN_NOT_EXIST - APP_INFO_NOT_EXIST - APPLICATION_TYPE_NOT_MINIAPP - MINI_APP_NOT_ONLINE - BUNDLE_ID_NOT_EXIST - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerappServicePublishModel: properties: app_logo: description: 服务发布logo example: https://appstoreisvpic.alipayobjects.com/prod/f9e291ed-0de5-4f5e-97ec-f76b8414a3e0.png type: string app_origin: description: 业务来源 example: AAA type: string mini_app_id: description: 小程序ID,仅特殊场景使用,普通业务方无需关注该参数。 example: 2019**** type: string pid: description: 小程序模板所属PID example: 2088**** type: string sub_title: description: 服务子标题 example: 服务子标题 type: string title: description: 服务名称 example: 服务名称 type: string type: object AlipayOpenMiniInnerappServicePublishResponseModel: properties: merchandise_id: description: 服务ID example: I1060100001000050361 type: string type: object AlipayOpenMiniInnerappServiceQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PAGE_NUM - INVALID_PAGE_SIZE - INVALID_PARAMS - BIZ_ERROR - APP_ORIGIN_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerappServiceQueryResponseModel: properties: mini_app_service_info_list: description: 小程序服务信息 items: $ref: '#/components/schemas/MiniAppServiceInfo' type: array page: description: 当前页数 example: 1 type: integer page_size: description: 页大小 example: 10 type: integer total_count: description: 总数 example: 100 type: integer type: object AlipayOpenMiniInnerbaseinfoApplogoUploadErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_LOGO_EXT - LOGO_IS_BLANK - LOGO_SIZE_EXCEED - LOGO_HEIGHT_NOT_EQUAL_WIDTH type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerbaseinfoApplogoUploadModel: type: object AlipayOpenMiniInnerbaseinfoApplogoUploadResponseModel: properties: app_logo: description: "上传图片结果地址。\t图片要求:\t1、不能超过256kb 2、支持的图片格式为jpg、jpeg、png 3、长宽比\ 例必须为为1:1" example: http://appstoreisvpic.alipayobjects.com/6c19accf-1343-4c5d-be62-3964144b3944.png type: string type: object AlipayOpenMiniInnerbaseinfoQueryErrorResponseModel: properties: code: description: 错误码 enum: - APPID_IS_BLANK - APP_INFO_NOT_EXIST - DEVELOPER_INFO_NOT_EXIST - SYSTEM_ERROR - MERCHANT_NOT_EXESIT - INVALID_PARAMS type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerbaseinfoQueryResponseModel: properties: app_alias_name: description: 小程序别名,简称 example: 小程序别名,简称 type: string app_category_ids: description: 类目Id列表 example: 107209_107226;107209_107227 type: string app_desc: description: 小程序应用描述 example: 小程序官方示例Demo,展示已支持的接口能力及组件。 type: string app_english_name: description: 小程序英文名称 example: tinyapp type: string app_key: description: 手淘开放平台鉴权key,支付宝不需要 example: test type: string app_logo: description: 小程序应用logo图标 example: https://appstoreisvpic.alipayobjects.com/prod/04843e84-f1fd-4717-a230-1c72de99aa5d.png type: string app_name: description: 小程序名称 example: 小程序名称 type: string app_slogan: description: 小程序简介 example: 小程序简介 type: string app_sub_type: description: 小程序类型,TINYAPP_TEMPLATE,TINYAPP_NORMAL,TINYAPP_PLUGIN example: TINYAPP_TEMPLATE type: string dev_id: description: 小程序所属主体信息 example: "2088301139347331" type: string gmt_create: description: 小程序主体创建时间 example: 2017-12-12 12:00:00 type: string gmt_modified: description: 小程序主体更新时间 example: 2017-12-12 12:00:00 type: string mini_app_id: description: 小程序Id example: "3000000000001501" type: string mini_category_ids: description: 新小程序前台类目,一级与二级、三级用下划线隔开,最多可以选四个类目,类目之间;隔开。使用后不再读取app_category_ids值,老前台类目将废弃 example: XS1001_XS2001_XS3002;XS1011_XS2089;XS1002_XS2008_XS3024 type: string origin: description: 应用创建来源,alipay = 支付宝,taobao = 淘宝 example: alipay type: string owner_entity: description: 小程序主体信息 example: "0001" type: string owner_portrait: description: 小程序主体头像信息 example: http://www.alipay.icon.com type: string plugin_refresh_type: description: AUTO/自动更新、MANUAL/手动更新 example: MANUAL type: string service_email: description: 小程序客服邮箱 example: example@mail.com type: string service_phone: description: 小程序客服电话 example: "13110101010" type: string type: object AlipayOpenMiniInnerversionAuditCancelErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionAuditCancelModel: properties: app_origin: description: 业务来源 example: AAA type: string app_version: description: 小程序版本 example: 0.0.1 type: string bundle_id: description: 端信息 example: 支付宝:com.alipay.alipaywallet 高德:com.amap.app type: string mini_app_id: description: 小程序ID,仅特殊场景使用,普通业务方无需关注该参数 example: 2019**** type: string pid: description: 小程序所属PID example: 2088**** type: string type: object AlipayOpenMiniInnerversionAuditCancelResponseModel: type: object AlipayOpenMiniInnerversionAuditSubmitErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionAuditSubmitModel: properties: app_category_ids: description: 小程序类目,格式为 第一个一级类目_第一个二级类目;第二个一级类目_第二个二级类目,详细类目可以参考开放服务类目,如果不填默认采用当前小程序应用类目。使用默认应用类目后不需要再次上传营业执照号、营业执照名、营业执照截图、营业执照有效期。 example: 107211_ 107427 type: string app_desc: description: 小程序应用描述,20-200个字,如果不填默认采用当前小程序的应用描述 example: 这是一个小程序的描述这是一个小程序的描述这是一个小程序的描述这是一个小程序的描述 type: string app_english_name: description: 小程序应用英文名称,如果不填默认采用当前小程序应用英文名称,3~30个字符。插件不填 example: demoenname type: string app_logo: description: 小程序logo图标,图片格式必须为:png、jpeg、jpg,比例必须为1:1,建议上传像素为180*180,不超过256kb, 如果不填默认采用当前小程序应用logo图标 example: https://appstoreisvpic.alipayobjects.com/prod/f9e291ed-0de5-4f5e-97ec-f76b8414a3e0.png type: string app_name: description: 小程序应用名称,如果不填默认采用当前小程序应用名称,名称3-40个字符,一个中文算两个字符 example: XXX的应用 type: string app_origin: description: 来源类型,新接入方需要向支付宝申请专用来源,否则不予接入,申请方式请参见接入手册。 example: AAA type: string app_slogan: description: 小程序应用简介,一句话描述小程序功能,如果不填默认采用当前小程序应用简介,10~32个字符 example: 示例slogan type: string app_version: description: "需要提交审核的小程序版本号,格式为: x.y.z,其中x、y、z均为整型数字,一个应用最多只能有一个审核中、审核通过\ 或者审核驳回的版本。" example: 0.0.1 type: string bundle_id: description: 端ID,多端场景下区分不同端 example: com.alipay.alipaywallet type: string license_info: $ref: '#/components/schemas/AuditLicenseInfo' memo: description: 小程序备注 example: 小程序备注示例 type: string mini_app_id: description: 小程序ID,特殊场景专用,普通业务方无需关注该参数。 example: "2019051464523527" type: string mini_category_ids: description: 新小程序前台类目,格式为 第一个一级类目_第一个二级类目;第二个一级类目_第二个二级类目_第二个三级类目,详细类目可以通过 alipay.open.mini.category.query(小程序类目树查询接口)查询mini_category_list,如果不填默认采用当前小程序应用类目。使用默认应用类目后不需要再次上传营业执照号、营业执照名、营业执照截图、营业执照有效期。使用后不再读取app_category_ids值,老前台类目将废弃 example: XS1001_XS2001_XS3002;XS1011_XS2089;XS1002_XS2008_XS3024 type: string open_id: description: 小程序所属PID example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string out_door_pic: description: 门头照图片地址,部分小程序类目需要提交,参照 开放服务类目 中是否需要营业执照信息,如果不填默认采用当前小程序门头照图片 example: https://appstoreisvpic.alipayobjects.com/prod/c74a6310-4695-48d7-8f1b-4e5cc11c7615.jpg type: string pid: description: 小程序所属PID example: 2088**** type: string screen_shot_list: description: 小程序应用截图列表,逗号分割,需要2-5张图片,单张图片不能超过4MB,图片格式只支持jpg,png;通过模板实例化小程序不需要传递此参数。 example: "https://appstoreisvpic.alipayobjects.com/prod/c74a6310-4695-48d7-8f1b-4e5cc11c7615.jpg,https://app.alipayobjects.com/ss.jpg" items: type: string type: array service_email: description: 小程序客服邮箱,如果不填默认采用当前小程序的应用客服邮箱,和客服电话至少填写一个 example: example@mail.com type: string service_phone: description: 小程序客服电话,如果不填默认采用当前小程序的应用客服电话,和客服邮箱至少填写一个。插件不填 example: "13110101010" type: string special_license_pic_list: description: 特殊资质图片地址列表,逗号分隔;部分类目需要特殊资质,如果需要特殊资质,最少一张,最多三张。模板和插件不需要特殊资质 example: "https://appstoreisvpic.alipayobjects.com/prod/c74a6310-4695-48d7-8f1b-4e5cc11c7615.jpg,https://appstoreisvpic.alipayobjects.com/prod/c74a6310-4695-48d7-8f1b-4e5cc11c7615.jpg" type: string version_desc: description: 小程序版本变更描述,30-500个字符,区分于app_desc example: 本版本主要新增了XXX功能:1、xxxxxxx; 2、xxxxxx;修复了XXXbug:1、xxxxxx;2、xxxxxx type: string type: object AlipayOpenMiniInnerversionAuditSubmitResponseModel: type: object AlipayOpenMiniInnerversionBackdevPublishErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionBackdevPublishModel: properties: app_origin: description: 业务来源 example: AAA type: string app_version: description: 小程序版本 example: 0.0.1 type: string bundle_id: description: 端信息 example: 支付宝:com.alipay.alipaywallet 高德:com.amap.app type: string mini_app_id: description: 小程序ID,仅特殊场景使用,普通业务方无需关注该参数 example: 2019**** type: string pid: description: 小程序所属PID example: 2088**** type: string type: object AlipayOpenMiniInnerversionBackdevPublishResponseModel: type: object AlipayOpenMiniInnerversionBetaConfirmErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - PLUGIN_BETA_RELATION_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionBetaConfirmModel: properties: app_origin: description: 业务来源 example: AAA type: string memo: description: 拒绝理由 example: 业务验证不通过 type: string mini_app_id: description: 小程序ID,仅特殊场景使用,普通业务方无需关注该参数 example: 2019***** type: string operate: description: 操作:pass/reject。接受或者拒绝 example: pass type: string pid: description: 小程序所属PID example: 2088**** type: string plugin_id: description: 要确认邀测结果的插件appid example: 2019***** type: string type: object AlipayOpenMiniInnerversionBetaConfirmResponseModel: type: object AlipayOpenMiniInnerversionBetainfoQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - PACKAGE_VERSION_IS_BLANK - PLUGINID_IS_BLANK - APP_ORIGIN_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionBetainfoQueryResponseModel: properties: plugin_beta_item_list: description: 邀测结果列表 items: $ref: '#/components/schemas/PluginBetaItemInfo' type: array status: description: 邀测状态,待确认WAITCHECK/确认CHECKED/拒绝REJECT example: WAITCHECK type: string type: object AlipayOpenMiniInnerversionBuildauditSubmitErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionBuildauditSubmitModel: properties: app_category_ids: description: 小程序类目,可不传,不传取基础信息中的小程序类目 example: 107209_107226 type: string app_desc: description: 小程序描述,可不传,不传取基础信息中的小程序描述 example: 小程序描述 type: string app_english_name: description: 小程序在从未上架过版本之前,英文名称是可以修改的,该字段用于在提交审核时候修改小程序英文名称。注意:小程序一旦有过上架版本之后就不可以修改英文名称。 example: 小程序英文名称 type: string app_logo: description: 小程序logo,可不传,不传取基础信息中的小程序logo,请调用专用的logo上传接口上传logo文件,并将返回的地址作为本字段传入 example: https://appstoreisvpic.alipayobjects.com/prod/e2bcf04b-da46-4b7f-a020-e9d224df7689.png type: string app_name: description: 小程序在从未上架过版本之前,中文名称是可以修改的,该字段用于在提交审核时候修改小程序中文名称。注意:小程序一旦有过上架版本之后就不可以修改中文名称。 example: 小程序名称 type: string app_origin: description: 来源类型,新接入方需要向支付宝申请专用来源,否则不予接入,申请方式请参见接入手册。 example: AAA type: string app_slogan: description: 小程序应用简介,一句话描述小程序功能,如果不填默认采用当前小程序应用简介,10~32个字符 example: 小程序简介 type: string app_version: description: 小程序版本号 example: 1.0.1 type: string build_ext: description: 构建扩展参数 example: "{\"ext\":{\"appId\":\"2019********\",\"pid\":\"2088*******\"},\"\ extEnable\":true}" type: string bundle_id: description: 端信息 example: com.alipay.alipaywallet type: string isv_app_id: description: 三方应用ID example: 2018******** type: string license_info: $ref: '#/components/schemas/AuditLicenseInfo' mini_app_id: description: 小程序ID,特殊场景专用,普通业务方无需关注该参数。 example: 2018******** type: string mini_category_ids: 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 type: string pid: description: 小程序开发者ID,可不传,不传取基础信息中的小程序开发者ID example: 2088******** type: string region_type: description: "服务区域类型,可不传,不传取基础信息中的小程序服务区域类型" example: GLOBAL type: string screen_shot_list: 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" type: string service_phone: description: 客服电话,可不传,不传取基础信息中的小程序客服电话 example: 021-2222222 type: string special_license_pic_list: description: "特殊资质图片地址列表,逗号分割," example: "https://appstoreisvpic.alipayobjects.com/prod/f2e32236-b537-405b-8764-613ea50c2f6b.png,https://appstoreisvpic.alipayobjects.com/prod/f2e32236-b537-405b-8764-613ea50c2f6b.png" type: string template_id: description: 小程序模板ID example: 2018******** type: string template_version: description: 模板的版本号,如果不填写,则默认用模板当前最新的在架版本 example: 1.0.0 type: string version_desc: description: 小程序版本描述,30-500个字符,一个中文占两个字符,一个英文或者数字占一个字符 example: 本版本新增了XXX功能,修复了XXXbug,解决了XXX问题,欢迎大家体验提出意见。 type: string type: object AlipayOpenMiniInnerversionBuildauditSubmitResponseModel: type: object AlipayOpenMiniInnerversionConditionBatchqueryErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionConditionBatchqueryModel: properties: app_origin: description: 业务来源 example: AAA type: string bundle_id: description: com.alipay.alipaywallet:支付宝,com.amap.app:高德 example: com.alipay.alipaywallet type: string mini_app_id: description: 小程序ID,仅特殊场景使用,普通业务方无需关注该参数。 example: 2019********* type: string page_num: description: 页码 example: "1" type: string page_size: description: 分页数 example: "10" type: string version_status: description: "INIT:开发中,RELEASE:上架,OFFLINE:下架,AUDITING:审核中,AUDIT_REJECT:审\ 核驳回,WAIT_RELEASE:待上架,GRAY:灰度中,以,号隔开" example: INIT type: string type: object AlipayOpenMiniInnerversionConditionBatchqueryResponseModel: properties: mini_version_base_info_list: description: 小程序版本信息 items: $ref: '#/components/schemas/MiniVersionBaseInfo' type: array type: object AlipayOpenMiniInnerversionContentRollbackErrorResponseModel: properties: code: description: 错误码 enum: - APP_ORIGIN_IS_BLANK - APP_ORIGIN_NOT_EXIST - BUNDLE_ID_NOT_EXIST - BUNDLE_ID_IS_BLANK - PID_IS_BLANK - APPID_IS_BLANK type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionContentRollbackModel: properties: app_origin: description: 业务场景来源 example: AAA type: string app_version: description: 小程序当前上架版本号 example: 1.0.0 type: string bundle_id: description: 端 example: com.alipay.alipaywallet type: string mini_app_id: description: 小程序ID,仅特殊场景使用,普通业务方无需关注该参数。 example: 2018******** type: string pid: description: 小程序所属主体 example: 2088******** type: string type: object AlipayOpenMiniInnerversionContentRollbackResponseModel: type: object AlipayOpenMiniInnerversionGrayFinishErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionGrayFinishModel: properties: app_origin: description: 业务来源 example: AAA type: string app_version: description: 小程序版本 example: 0.0.1 type: string bundle_id: description: 端信息 example: 支付宝:com.alipay.alipaywallet 高德:com.amap.app type: string mini_app_id: description: 小程序ID,仅特殊场景使用,普通业务方无需关注该参数 example: 2019**** type: string pid: description: 小程序所属PID example: 2088**** type: string type: object AlipayOpenMiniInnerversionGrayFinishResponseModel: type: object AlipayOpenMiniInnerversionGrayPublishErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionGrayPublishModel: properties: app_origin: description: 业务来源 example: AAA type: string app_version: description: 小程序版本 example: 0.0.1 type: string beta_app_id_list: description: 待邀测应用列表,灰度插件时使用,如无邀测必要请不要传入 example: "[\"2021xxxxx\"]" items: type: string type: array bundle_id: description: 端信息 example: 支付宝:com.alipay.alipaywallet 高德:com.amap.app type: string gray_strategy: description: 灰度值 example: gray_mayi_rule、gray_alibaba_rule type: string mini_app_id: description: 小程序ID,仅特殊场景使用,普通业务方无需关注该参数 example: 2019**** type: string pid: description: 小程序所属PID example: 2088**** type: string type: object AlipayOpenMiniInnerversionGrayPublishResponseModel: type: object AlipayOpenMiniInnerversionInfoDeleteErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionInfoDeleteResponseModel: type: object AlipayOpenMiniInnerversionInfoQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - PARAMS_VALID_ERROR - APP_ORIGIN_NOT_EXIST - BUNDLE_ID_NOT_EXIST - APP_INFO_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionInfoQueryResponseModel: properties: app_version: description: 版本号 example: 0.0.1 type: string build_source: description: 版本构建类型 example: 01 自创建 02 模板构建 type: string bundle_id: description: 端信息 example: 支付宝:com.alipay.alipaywallet 高德:com.amap.app type: string create_time: description: 版本创建时间 example: 2019-01-01 12:00:22 type: string description: description: 版本描述 example: 我是小程序版本描述 type: string ext_json: description: 实例化模板参数 example: "{}" type: string gmt_modified: description: 版本更新时间 example: 2019-01-01 12:12:12 type: string gray_start_time: description: 版本灰度时间 example: 2019-01-01 12:00:22 type: string gray_strategy: description: 小程序灰度比例值 example: p10-10%的用户,p30-30%的用户,p50-50%的用户 type: string mini_app_id: description: 小程序ID example: 2019**** type: string offline_time: description: 版本下架时间 example: 2019-01-01 12:00:22 type: string package_url: description: 包地址 example: http://alipay-offline.cn-hangzhou.alipay.aliyun-inc.com/pkgcore/pMugqXnuGsXecwEvlsuQ.amr type: string plugin_refs: description: 引用插件信息 items: $ref: '#/components/schemas/MiniAppPluginInfo' type: array process_task_id: description: 流程id example: "123" type: string reject_reason: description: 审核失败原因 example: 名称过于宽泛 type: string rollback_time: description: 版本回滚时间 example: 2019-01-01 12:00:22 type: string scan_result: description: 安全扫描结果 example: "True" type: string screen_shot_list: description: 小程序版本截图,多个截图以逗号隔开 example: http://image.aaa.alipay.com type: string shelf_time: description: 版本上架时间 example: 2019-01-01 12:00:22 type: string source_url: description: 源码包地址 example: http://alipay-offline.cn-hangzhou.alipay.aliyun-inc.com/pkgcore/pMugqXnuGsXecwEvlsuQ.amr type: string status: description: 版本状态 example: 小程序版本状态,INIT-开发中,AUDITING-审核中,WAIT_RELEASE-审核通过,AUDIT_REJECT-审核驳回,RELEASE-已上架,GRAY-灰度中,OFFLINE-下架 type: string template_extra: description: 模板构建参数 example: "{\"tinycliversion\":\"1.1.1\"}" type: string template_version: description: 模板版本号 example: 0.0.1 type: string type: object AlipayOpenMiniInnerversionInstantiationQueryErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionInstantiationQueryResponseModel: properties: app_version: description: 小程序版本号 example: 0.0.1 type: string bundle_id: description: 端id example: com.alipay.alipaywallet type: string mini_app_id: description: 小程序appId example: "2021000116680014" type: string template_id: description: 模板id example: "2019042861090647" type: string template_version: description: 模板的版本号 example: 0.0.3 type: string type: object AlipayOpenMiniInnerversionLastQueryErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionLastQueryResponseModel: properties: app_desc: description: 小程序应用描述 example: 小程序官方示例Demo,展示已支持的接口能力及组件 type: string app_name: description: 小程序的名称 example: 小程序名称 type: string app_version: description: 版本号 example: 1.0.1 type: string bundle_id: description: 端信息 example: 支付宝:com.alipay.alipaywallet 高德:com.amap.app type: string category_ids: description: 小程序所属类目 example: 107209_107226 type: string english_name: description: 小程序英文名称 example: xiaochengxu type: string logo_url: description: 小程序应用logo图标 example: https://appstoreisvpic.alipayobjects.com/prod/04843e84-f1fd-4717-a230-1c72de99aa5d.png type: string mini_app_id: description: 小程序ID example: 2018******** type: string service_phone: description: 小程序客服电话 example: "13110101010" type: string slogan: description: 小程序应用简介,一句话描述小程序功能 example: 提供小程序示例功能 type: string status: description: 版本状态 example: INIT type: string sub_application_type: description: 小程序子类型,自研、模板类型 example: TINY_NORMAL type: string type: object AlipayOpenMiniInnerversionModelforofflineQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionModelforofflineQueryResponseModel: properties: model_json: description: 线上版本包数据 example: "{}" type: string sync_id: description: 同步ID,同步失败时便于去线上追溯 example: abcasdasda1217893189389asdasda98 type: string type: object AlipayOpenMiniInnerversionNobuildUploadErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionNobuildUploadModel: properties: build_extra_info: 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\"}" type: string build_js_permission: description: jsapi权限文件 example: "{\"permissionJSON\":[1, 2, 3, 4, 5]}" type: string build_main_url: description: 小程序页面主入口。/index.html#page/component/index,该值需要和extendInfo中的page参数保持一致 example: /index.html#page/component/index type: string build_qcloud_info: description: 打包平台扩展信息 example: "{\"launchParams\":{\"enableTabBar\":\"YES\",\"enableJSC\":\"YES\"\ ,\"page\":\"page/component/index\",\"enableKeepAlive\":\"YES\",\"enableWK\"\ :\"YES\"}}" type: string build_version: description: 小程序版本 example: 0.0.1 type: string builded_package_size: description: 已经构建过的amr包大小,单位是字节,建议如实填写 example: "20" type: string builded_package_url: description: 已经构建的包地址,目前主要自行构建的场景使用 example: 产物包地址 type: string builded_plugin_size: description: 构建好的插件包amr大小 example: "100" type: string builded_plugin_url: description: 构建好的插件包地址 example: 构建好的插件包地址 type: string bundle_id: description: 一个端的标识,用于区分不同的客户端,每接入一个客户端,都需要向小程序应用中心申请bundleId入驻 example: com.alipay.alipaywallet type: string components: description: 组件参数 example: "{}" type: string inst_code: description: 上传调试版的接入租户类型 example: taobao type: string mini_app_id: description: 小程序id example: "2017122101357757" type: string new_builded_package_size: description: 2.0已经构建过的amr包大小,单位是字节,主要是给自行构建的场景使用 example: "100" type: string new_builded_package_url: description: 2.0产物包地址 example: 2.0产物包地址 type: string new_builded_plugin_size: description: 构建好的插件包amr大小 example: "100" type: string new_builded_plugin_url: description: 构建好的插件包地址 example: 构建好的插件包地址 type: string no_sign: description: "否免加签, true的时候代表传过来的是加签后的包地址" example: true type: boolean plugin_refs: description: 小程序代码中引用的插件列表,包含插件id和插件版本信息,业务方需要自行解析源码包的app.json里面的plugins信息 items: $ref: '#/components/schemas/MiniAppPluginReference' type: array sub_packages: description: 构建好的分包信息 items: $ref: '#/components/schemas/SubPackageInfo' type: array type: object AlipayOpenMiniInnerversionNobuildUploadResponseModel: type: object AlipayOpenMiniInnerversionOfflinePublishErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionOfflinePublishModel: properties: app_origin: description: 业务来源 example: AAA type: string app_version: description: 版本号 example: 0.0.1 type: string bundle_id: description: 端信息 example: 支付宝:com.alipay.alipaywallet 高德:com.amap.app type: string mini_app_id: description: 小程序ID,仅特殊场景使用,普通业务方无需关注该参数 example: 2019**** type: string pid: description: 小程序所属PID example: 2088***** type: string type: object AlipayOpenMiniInnerversionOfflinePublishResponseModel: type: object AlipayOpenMiniInnerversionOnlineErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - ONLINE_FAILURE - PARAMS_VALID_ERROR - MINI_APP_VERSION_NOT_EXISTS - MINI_APP_VERSION_STATUS_ILLEGAL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionOnlineModel: properties: app_offline_version: description: 下架版本 example: 0.0.5 type: string app_online_version: description: 上架版本 example: 0.0.6 type: string app_origin: description: 业务来源 example: ASTORE type: string bundle_id: description: 一个端的标识,用于区分不同的客户端,每接入一个客户端,都需要向小程序应用中心申请bundelId入驻 example: com.alipay.alipaywallet type: string inst_code: description: 租户code,alipay or taobao example: taobao type: string mini_app_id: description: 小程序ID example: "2018012201365222" type: string type: object AlipayOpenMiniInnerversionOnlinePublishErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionOnlinePublishModel: properties: app_origin: description: 业务来源 example: AAA type: string app_version: description: 小程序版本 example: 0.0.1 type: string bundle_id: description: 端信息 example: 支付宝:com.alipay.alipaywallet 高德:com.amap.app type: string downgrade: description: 否服务降级,如果降级,拉包策略如果端上有本地包,则使用本地包打开,同时异步下载新包,待下次打开则使用新包 example: true type: boolean mini_app_id: description: 小程序ID,仅特殊场景使用,普通业务方无需关注该参数 example: 2019***** type: string pid: description: 小程序所属PID example: 2088**** type: string release_type: description: normal默认普通发布,high 高保发布 example: normal/high type: string type: object AlipayOpenMiniInnerversionOnlinePublishResponseModel: type: object AlipayOpenMiniInnerversionOnlineResponseModel: type: object AlipayOpenMiniInnerversionPackageCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionPackageCreateModel: properties: app_origin: description: 业务来源 example: AAA type: string app_version: description: 小程序版本 example: 0.0.1 type: string bundle_id: description: 端信息 example: 支付宝:com.alipay.alipaywallet 高德:com.amap.app type: string mini_app_id: description: 小程序ID,仅特殊场景使用,普通业务方无需关注该参数。 example: 2019**** type: string package_type: description: 打包类型。预发包和覆盖率包 example: PRE_ONLINE type: string pid: description: pid. 伙伴链路(app_origin='HUOBAN')时必填 example: 2019**** type: string type: object AlipayOpenMiniInnerversionPackageCreateResponseModel: type: object AlipayOpenMiniInnerversionSyncErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionSyncModel: properties: app_origin: description: 业务参数来源 example: AAA type: string app_version: description: 推送的小程序版本号 example: 1.0.0 type: string bundle_id: description: 端信息 example: com.alipay.alipaywallet type: string dev_id: description: 操作人ID example: 2088****** type: string mini_app_id: description: 小程序ID,仅特殊场景使用,普通业务方无需关注该参数。 example: 2019******* type: string sync_type: description: 同送方式 example: global:全量,recent:定向 type: string type: object AlipayOpenMiniInnerversionSyncResponseModel: type: object AlipayOpenMiniInnerversionTemplatedUploadErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionTemplatedUploadModel: properties: app_origin: description: 来源类型,新接入方需要向支付宝申请专用来源,否则不予接入。 example: AAA type: string app_version: description: "格式为: x.y.z,其中x、y、z均为整型数字,版本不能重复构建,且新版本号必须高于旧版本" example: 0.0.1 type: string bundle_id: description: 端id example: com.alipay.alipaywallet type: string ext: description: 模板的配置参数,完整内容请参见:https://docs.alipay.com/mini/isv/ortga1 example: "{\"extEnable\": true, \"extPages\": {\"pages/face/index\": {\"\ defaultTitle\": \"默认页面标题\"}},\"window\": {\"defaultTitle\": \"默认标题\"}}" type: string mini_app_id: description: 小程序ID,特殊场景专用,普通业务方无需关注该参数。 example: "2019051464523527" type: string template_id: description: 模板id,模板必须已经处于上架/下架状态 example: "2019032163637014" type: string template_version: description: 模板版本,必须处于上架/下架状态。如果为空,默认取当前在架,或者最新下架的版本。 example: 0.0.1 type: string type: object AlipayOpenMiniInnerversionTemplatedUploadResponseModel: type: object AlipayOpenMiniInnerversionUpgradeErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionUpgradeModel: properties: app_origin: description: 来源类型,新接入方需要向支付宝申请专用来源,否则不予接入。 example: AAA type: string bundle_id: description: 端ID,多端场景下区分不同端 example: com.alipay.alipaywallet type: string mini_app_id: description: 小程序ID,特殊场景专用,普通业务方无需关注该参数。 example: "2019032163637016" type: string template_id: description: 用于升级的模板id example: "2019032163637014" type: string template_version: description: "用于升级的模板版本号,版本号必须满足 x.y.z, 且均为数字" example: 0.0.3 type: string type: object AlipayOpenMiniInnerversionUpgradeResponseModel: type: object AlipayOpenMiniInnerversionUploadErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionUploadModel: properties: app_origin: description: 业务来源,新接入方需要向支付宝申请专用来源,否则不予接入。https://yuque.antfin-inc.com/tinyapp-all/qddncu/bidushixiang example: https://yuque.antfin-inc.com/tinyapp-all/qddncu/bidushixiang type: string build_app_type: description: IDE开发打包类型,写死tinyApp example: tinyApp type: string build_extra_info: 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\"}" type: string build_extra_mini_project_config: description: 用于覆盖开发者配置字段,实现止血和灰度逻辑 example: "{\"enableAppxNg\":\"YES\"}" type: string build_js_permission: description: "jsapi 权限文件,钉钉外请勿传" example: "{\"permissionJSON\":[1, 2, 3, 4, 5]}" type: string build_main_url: description: 小程序页面主入口。/index.html#page/component/index,该值需要和extendInfo中的page参数保持一致 example: /index.html#page/component/index type: string build_max_android_client_version: description: 最大Android客户端版本号,禁止使用,如果需要使用请联系小程序平台评估,否则端上会出现问题 example: 100.0.0 type: string build_max_ios_client_version: description: 最大iOS客户单版本号,禁止使用,如果需要使用请联系小程序平台评估,否则端上会出现问题 example: 100.0.0 type: string build_min_android_client_version: description: 最小Android客户端版本号,禁止使用,如果需要使用请联系小程序平台评估,否则端上会出现问题 example: 10.1.35 type: string build_min_ios_client_version: description: 最小iOS客户单版本号,禁止使用,如果需要使用请联系小程序平台评估,否则端上会出现问题 example: 10.1.35 type: string build_package_md_5: description: 源码包文件流的MD5字符串 example: 源码包 type: string build_package_name: description: 包名称 example: dist.amr type: string build_package_stream: description: base64编码后的小程序源码包文件流 example: 小程序源码包 type: string build_qcloud_info: description: 打包平台扩展信息 example: "{\"launchParams\":{\"enableTabBar\":\"YES\",\"enableJSC\":\"YES\"\ ,\"page\":\"page/component/index\",\"enableKeepAlive\":\"YES\",\"enableWK\"\ :\"YES\"}}" type: string build_signed_pkg_url: description: 已经构建加签过的包地址 example: 已经构建加签过的包地址 type: string build_source_pkg_size: description: 源码包大小 example: "10000" type: string build_source_pkg_url: description: 源码包地址,源码包大小不能超过20M且地址必须永久有效,若超20M,将限制业务来源调用。将源码文件夹整个用zip格式压缩成后缀amr文件传至文件服务器 example: http://alipay-offline.cn-hangzhou.alipay.aliyun-inc.com/pkgcore/DMDjCdOCtERoGgyrJZzq.amr type: string build_sub_url: description: 子入口 example: /index.html#pages/todos/todos type: string build_version: description: 小程序版本 example: 0.0.1 type: string builded_package_size: description: 已经构建过的包大小,单位是字节,主要是给自行构建的场景使用 example: "10000" type: string builded_package_url: description: 已经构建的包地址,目前主要自行构建的场景使用 example: 已经构建的包地址 type: string bundle_id: description: 一个端的标识,用于区分不同的客户端,每接入一个客户端,都需要向小程序应用中心申请bundleId入驻 example: com.alipay.alipaywallet type: string client_type: description: 多端类型,除了钉钉外其他业务方禁止使用 example: DINGDING type: string inst_code: description: 上传调试版的接入租户类型。 example: taobao type: string mini_app_id: description: 小程序ID example: "2017122101357757" type: string plugin_refs: description: 小程序代码中引用的插件列表,包含插件id和插件版本信息,业务方需要自行解析源码包的app.json里面的plugins信息 items: $ref: '#/components/schemas/MiniAppPluginReference' type: array type: object AlipayOpenMiniInnerversionUploadResponseModel: properties: build_info: description: 构建信息 example: 构建信息 type: string build_package_url: description: 包地址 example: http://alipay-rmsdeploy-image.cn-hangzhou.alipay.aliyun-inc.com/qcloud/build-target-c1d90a3bcf354803ad01b28cdccd83a4.tar type: string build_status: description: 构建状态 example: 构建状态 type: string build_version: description: 构建版本 example: 0.0.5 type: string need_rotation: description: 是否需要轮询 example: "TRUE" type: string new_build_package_url: description: appx构建返回值 example: http://alipay-rmsdeploy-image.cn-hangzhou.alipay.aliyun-inc.com/qcloud/build-target-c1d90a3bcf354803ad01b28cdccd83a4.tar type: string package_id: description: 包管理包ID example: "34845" type: string version_created: description: 版本创建结果 example: "TRUE" type: string type: object AlipayOpenMiniInnerversionUploadstatusQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - POLLING_BUILD_VERSION_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniInnerversionUploadstatusQueryResponseModel: properties: build_info: description: 构建信息 example: 构建信息 type: string build_package_url: description: 构建好的包地址 example: http://alipay-rmsdeploy-image.cn-hangzhou.alipay.aliyun-inc.com/qcloud/build-target-c1d90a3bcf354803ad01b28cdccd83a4.tar type: string build_status: description: 构建状态 example: 构建状态 type: string log_url: description: 构建日志地址 example: https://tfapi.alipay.com/logs/5c1ac74d0c5e1d85b8c618dd type: string need_rotation: description: 是否需要轮询 example: "TRUE" type: string new_build_package_url: description: 构建好的appx2.0包地址 example: http://alipay-rmsdeploy-image.cn-hangzhou.alipay.aliyun-inc.com/qcloud/build-target-c1d90a3bcf354803ad01b28cdccd83a4.tar type: string new_result_url: description: 构建的结果地址 example: https://tfapi.alipay.com/logs/5c1ac75f4b6ce5884ced6f00 type: string result_url: description: 构建的结果地址 example: https://tfapi.alipay.com/logs/5c1ac75f4b6ce5884ced6f00 type: string version_created: description: 创建版本结果 example: "TRUE" type: string type: object AlipayOpenMiniIsvCreateErrorResponseModel: properties: code: 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 - BRAND_TORT - RPC_INVOKE_ERROR - RATE_LIMITING_RISK - INFO_INVALID - ILLEGAL_PARAMS - APP_NAME_LENGTH_LIMIT - EXTERNAL_SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniIsvCreateModel: properties: create_mini_request: $ref: '#/components/schemas/CreateMiniRequest' type: object AlipayOpenMiniIsvCreateResponseModel: properties: order_no: description: 小程序代创建订单号 example: "2387429847238743" type: string type: object AlipayOpenMiniIsvFastregisterCreateErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_MINI_APP_NAME_LENGTH - ILLEGAL_PARAMS - PRECREATE_MINI_ERROR - OPENCORE_APP_NAME_EXIST - PROVIDER_ROLE_INVALID - SYSTEM_ERROR - OPENID_QUERY_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniIsvFastregisterCreateModel: properties: app_name: description: "小程序名称,昵称半自动设定,强制后缀“的试用小程序”。且该参数会进行关键字检查,如果命中品牌关键字则会报错。\t如遇\ 到品牌大客户要用试用小程序,建议用户先换个名字,认证后再修改成品牌名。" example: 示例小程序 type: string auth_notify_url: description: 授权确认成功后回调h5链接或小程序页面 example: pages/notify/index type: string out_order_no: description: 开发者外部订单号,通过开发者账号+外部订单号做业务幂等 example: "23948392483253534535" type: string uid: description: 商户uid example: 208822294389xxxx type: string type: object AlipayOpenMiniIsvFastregisterCreateResponseModel: properties: authorize_url: description: 授权确认跳转url example: alipays://xxxxxxxxxxxxxxxx type: string order_no: description: 代创建试用小程序单号 example: "2022120716532186600070121" type: string type: object AlipayOpenMiniIsvFastregisterQueryErrorResponseModel: properties: code: description: 错误码 enum: - NO_PERMISSION - ILLEGAL_PARAMS - SYSTEM_ERROR - ORDER_NOT_EXIST - ORDER_TYPE_NOT_MATCH type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniIsvFastregisterQueryResponseModel: properties: app_name: description: 小程序应用名 example: 张三的试用小程序 type: string isv_app_id: description: 服务商appid example: "2021090923349983" type: string mini_app_id: description: 小程序appid example: "20212323243534535" type: string order_no: description: 代创建试用小程序单号 example: "2202324344343435353" type: string out_order_no: description: 商户传入的外部订单号 example: "23948392483253534535" type: string status: 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 type: string type: object AlipayOpenMiniIsvQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMS - SYSTEM_ERROR - PERMISSION_DENIED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniIsvQueryResponseModel: properties: min_app_id: description: 小程序appId,商家确认后非空,若商家未确认或超时返回空 example: 201407230000xxxx type: string order_no: description: 订单号 example: "239238834234344" type: string out_order_no: description: 外部订单号,开发者帐号+外部订单号维度来控制请求务幂等 example: "23948392483253534535" type: string pid: description: 商户pid example: "2088002306330746" type: string status: description: PROCESS处理中,TIMEOUT超时,AGREED同意, REJECTED拒绝 example: PROCESS type: string type: object AlipayOpenMiniMiniappBrandCancelErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniMiniappBrandCancelResponseModel: type: object AlipayOpenMiniMiniappBrandQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniMiniappBrandQueryResponseModel: properties: merchant_brand_list_result: $ref: '#/components/schemas/MerchantBrandListResult' miniapp_brand_audit_result: $ref: '#/components/schemas/MiniappBrandAuditResult' type: object AlipayOpenMiniMiniappBrandSubmitErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniMiniappBrandSubmitModel: properties: apply_type: description: "申请的资质类型\tSELF_BRAND_APPLY 自有品牌申请(当需要一个新的品牌时选择此项)\tAUTHORIZE_BRAND_APPLY\ \ 授权品牌申请(当需要授权一个已有的品牌给商户时选择此项)\tEXIST_BRAND_BIND 品牌绑定,适用于品牌已申请成功的情况(当需\ 要将已有品牌绑定到无品牌小程序时选择此项)" example: AUTHORIZE_BRAND_APPLY type: string authorize_info: $ref: '#/components/schemas/AuthorizeInfo' brand_id: description: 商户已有品牌Id(只有申请的资质类型为EXIST_BRAND_BIND 时需要填写) example: brand2020091614782813 type: string brand_name: description: 品牌名称 example: CR7合作 type: string brand_registration_info: $ref: '#/components/schemas/BrandRegistrationInfo' id_materials: description: 申请人身份证明材料(当前只支持图片类型,请调用alipay.open.mini.miniapp.brand.upload接口上传图片,可以上传多个身份证明材料) example: "[\"ua2qD53TRpyfX-UYYin6sQAAACMAAQED\",\"ua2qD53TRpyfX-UYYin6sQAAACMAAQED\"\ ]" items: type: string type: array type: object AlipayOpenMiniMiniappBrandSubmitResponseModel: type: object AlipayOpenMiniMiniappBrandUploadErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniMiniappBrandUploadModel: type: object AlipayOpenMiniMiniappBrandUploadResponseModel: properties: file_key: description: 图片上传成功后的图片存储键(可用于填写调用alipay.open.mini.miniapp.brand.submit时需要的图片类型的字段) example: A*BTRVJSTHEBRE784685 type: string type: object AlipayOpenMiniMiniappServiceconfigModifyErrorResponseModel: properties: code: description: 错误码 enum: - BIZ_ERROR - INVALID_PARAMETER - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniMiniappServiceconfigModifyModel: properties: home_open: description: 云客服是否在小程序首页透出,true-开启,false-不开启 example: true type: boolean service_config: description: 客服方式,目前支持ANTCLOUD-云客服 example: ANTCLOUD type: string type: object AlipayOpenMiniMiniappServiceconfigModifyResponseModel: type: object AlipayOpenMiniQrcodeBindErrorResponseModel: properties: code: 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 - SYSTEM_ERROR - SECUTIY_SSRF_URL_ILLEGAL - SECUTIY_SSRF_URL_FAILD - QRCODE_HOST_ROUTE_NUM_LIMIT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniQrcodeBindModel: properties: mode: description: "匹配规则,仅支持EXACT(精确匹配)、FUZZY(模糊匹配)两个值。\t\t精确匹配:根据填写的二维码地址精确匹配\ ,地址完全一致时才能唤起小程序(如:配置二维码地址为https://www.alipay.com/my?id=123,当用户扫这个地址的二维\ 码可唤起小程序)。\t\t模糊匹配:根据填写的二维码地址模糊匹配,只要地址前缀匹配即可唤起小程序(如:配置二维码地址为https://www.alipay.com/my/,\ 当用户扫的二维码地址为https://www.alipay.com/my/id=123,可唤起小程序)。" example: FUZZY type: string page_redirection: description: 小程序功能页,配置扫描二维码后打开的小程序功能页面路径 example: pages/index/index type: string route_pattern: description: "模式,用于描述通用的路由url格式,适用于同一个host下面存在大量路由的场景,主要用于提升路由性能,其中{0}、\ {1} 代表路径中的变量" example: "http://yoursite.com/merchant/{0}/shop/{1}" type: string route_url: description: 二维码域名,须通过ICP备案验证,支持http、https、ftp开头的链接 example: https://www.yoursite.com/ type: string type: object AlipayOpenMiniQrcodeBindResponseModel: properties: route_group: description: 路由规则组,用于唯一标记一条路由规则 example: 78b59c5b6b2946448bc77e17e544b813 type: string type: object AlipayOpenMiniQrcodeQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - PAGE_PARAM_NULL_FAIL - PAGE_SIZE_OUT_LIMIT_FAIL - PAGE_PARAM_MIN_LIMIT_FAIL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniQrcodeQueryResponseModel: properties: qr_code_route_groups: description: 规则路由数据列表 items: $ref: '#/components/schemas/QrCodeRouteGroup' type: array total_items: description: 数据总数 example: 20 type: integer type: object AlipayOpenMiniQrcodeUnbindErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAM - TINY_APP_NOT_EXIST - ROUTE_GROUP_NOT_EXIST - NO_PERMISSION - QRCODE_ROUTE_PATTERN_DELETE_NOT_SUPPORT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniQrcodeUnbindModel: properties: route_group: description: 路由规则组,用于唯一标记一条路由规则。调用 https://opendocs.alipay.com/apis/00rkye 接口关联普通二维码后的返回值。 example: 78b59c5b6b2946448bc77e17e544b813 type: string type: object AlipayOpenMiniQrcodeUnbindResponseModel: type: object AlipayOpenMiniResourcePromotionsourceNotifyErrorResponseModel: properties: code: description: 错误码 enum: - PARAM_APP_ID_IS_BLANK - PARAM_PROMOTION_ID_IS_BLANK - PARAM_PROMOTION_NAME_IS_BLANK - RESOURCE_SOURCE_IS_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniResourcePromotionsourceNotifyModel: properties: author_id: description: 媒体唤起时传入的支付宝id example: 201*********** type: string params: description: 媒体唤起时提供的额外参数值列表,这里可能有多个值,打平以后拼入。即url_decode(authcbparams) example: app_id=1024562&a=1&b=2&c=3&bind_entry=12 type: string promotion_id: description: 推广位id example: mm_mm_123213123123131_21 type: string promotion_name: description: 推广位名称 example: 推广位名称 type: string source: description: 媒体来源,标识调用方 example: zfb_xcx type: string type: object AlipayOpenMiniResourcePromotionsourceNotifyResponseModel: type: object AlipayOpenMiniResourceRecordNotifyErrorResponseModel: properties: code: description: 错误码 enum: - PARAM_APP_ID_IS_BLANK - PARAM_TAOBAO_ID_IS_BLANK - PARAM_TAOBAO_NICK_IS_BLANK - RESOURCE_SOURCE_IS_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniResourceRecordNotifyModel: properties: author_id: description: 媒体唤起时传入的支付宝id example: 2121****** type: string mini_app_id: description: 支付宝appid,代表一个小程序的唯一标识 example: 201*********** type: string params: description: 媒体唤起时提供的额外参数值列表,这里可能有多个值,打平以后拼入。即url_decode(authcbparams) example: app_id=1024562&a=1&b=2&c=3&bind_entry=12 type: string site_id: description: 回调的siteid 淘宝账号唯一 example: "12323232" type: string source: description: 媒体来源,标识调用方 example: zfb_xcx type: string taobao_id: description: 淘宝id example: 1*********** type: string taobao_nick: description: 淘宝昵称 example: '**昵称' type: string type: object AlipayOpenMiniResourceRecordNotifyResponseModel: type: object AlipayOpenMiniSafedomainCreateErrorResponseModel: properties: code: 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 - ILLEGAL_PARAMS type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniSafedomainCreateModel: properties: safe_domain: description: "服务器域名白名单。支付宝小程序在HTTP请求、上传文件等场景只能与域名白名单中的域名进行通讯 。\t新添加域白名单后\ 需重新上传应用版本(模板模式下小程序模板及商家应用都需重新上传、实例化版本)才会生效。老版本应用继续使用老版本名单。\t每个应用最多可添加\ 30个 URL。" example: example.com type: string type: object AlipayOpenMiniSafedomainCreateResponseModel: type: object AlipayOpenMiniSafedomainDeleteErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - APPLICATION_TYPE_NOT_MINIAPP - SAFE_DOMAIN_IS_BLANK type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniSafedomainDeleteResponseModel: type: object AlipayOpenMiniTemplateMarketingCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniTemplateMarketingCreateModel: properties: activity_id: description: 营销活动id example: 2022xxxx type: string gmt_end: description: 活动结束时间 example: 2022-01-10 22:00:00 type: string gmt_start: description: 活动开始时间 example: 2022-01-01 10:00:00 type: string template_ids: description: 消息模板id列表,最多50个模板id example: "[\"a\",\"b\",\"c\"]" items: type: string type: array title: description: 消息运营位名称,不填默认使用券名称 example: 优惠活动xxx type: string type: object AlipayOpenMiniTemplateMarketingCreateResponseModel: properties: detail_id: description: 投放详情主键id example: MDDdejifjeifjoe30fr4j3ifo3f3f3 type: string type: object AlipayOpenMiniTemplateUsageQueryErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniTemplateUsageQueryResponseModel: properties: app_ids: description: 小程序appId列表 example: "[\"208812345678\",\"208812345679\"]" items: type: string type: array template_usage_info_list: description: 模板使用信息 items: $ref: '#/components/schemas/TemplateUsageInfo' type: array type: object AlipayOpenMiniTemplatemessageUsertemplateApplyErrorResponseModel: properties: code: description: 错误码 enum: - MESSAGE_LIBRARY_ILLEGAL - MESSAGE_TEMPLATE_KEYWORD_ILLEGAL - KEYWORDS_NUMBER_INVALID - USER_TEMPLATE_OVER_LIMIT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniTemplatemessageUsertemplateApplyModel: properties: keyword_list: description: "开发者自行组合好的模板关键词列表,关键词之间使用英文的逗号“,”进行分割,关键词顺序可以自由搭配,最多支持10个关键\ 词组合,这里组织的关键词,在发送模板消息接口中,按照这里的顺序进行占位符替换" example: "1,2,3" type: string template_library_id: description: 模板库id,可登录小程序后台查看获取 example: AT0001 type: string type: object AlipayOpenMiniTemplatemessageUsertemplateApplyResponseModel: properties: user_template_id: description: 开发者申请的模板id号,使用该模板id号,开发者可以调用alipay.open.app.mini.templatemessage.send接口进行模板消息发送 example: MDI4YzIxMDE2M2I5YTQzYjUxNWE4MjA4NmU1MTIyYmM= type: string type: object AlipayOpenMiniTemplatemsgMaketingBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - PAG_NUM_NOT_VALID - PAG_SIZE_NOT_VALID - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniTemplatemsgMaketingBatchqueryModel: properties: page_num: description: 分页查询页码 example: 1 type: integer page_size: description: 每页展示条数,最大支持50个 example: 10 type: integer type: object AlipayOpenMiniTemplatemsgMaketingBatchqueryResponseModel: properties: marketing_delivery_detail_list: description: 投放详情列表 items: $ref: '#/components/schemas/MarketingDeliveryDetail' type: array total: description: 投放详情总条数 example: 100 type: integer type: object AlipayOpenMiniTemplatemsgMaketingstatusModifyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniTemplatemsgMaketingstatusModifyModel: properties: detail_id: description: 营销投放详情id example: MDDadsfeeijdfiedfef32r3jkdeaqee type: string status: description: 投放详情状态值,如:INIT:下线状态,ON_LINE:上线状态,DELETED:删除状态 example: DELETED type: string type: object AlipayOpenMiniTemplatemsgMaketingstatusModifyResponseModel: type: object AlipayOpenMiniTemplatemsgTinypayswitchConfirmErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - APPINFO_NOT_EXIST - BIZ_CONTENT_IS_NULL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniTemplatemsgTinypayswitchConfirmResponseModel: type: object AlipayOpenMiniTipsDeliveryBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniTipsDeliveryBatchqueryModel: properties: page_number: description: 每页记录条数,最小1,最大20 example: "1" type: string page_size: description: 查询的页数,从1开始,最大1000 example: "5" type: string type: object AlipayOpenMiniTipsDeliveryBatchqueryResponseModel: properties: tips_delivery_list: description: 收藏引导活动信息列表。根据活动状态排序,顺序为:生效中,暂停,审核中,白名单生效中,初始化,审核失败,结束。相同状态优先展示状态更新时间最迟的活动。 items: $ref: '#/components/schemas/TipsDelivery' type: array total_pages: description: 总页数 example: 1 type: integer total_size: description: 收藏引导数据总数量 example: 20 type: integer type: object AlipayOpenMiniTipsDeliveryCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniTipsDeliveryCreateModel: properties: delivery_content: description: 收藏引导文案内容,不得超过14个字 example: 点击收藏,下次使用更方便 type: string delivery_name: description: 收藏引导活动名称 example: 收藏引导首页投放活动 type: string end_time: description: 活动结束时间 example: 2022-12-31 15:23:43 type: string match_type: description: 匹配类型 example: TARGETURL type: string match_url: description: 目标页面地址,当匹配类型为TARGETURL时,投放文案仅在当前页面生效 example: /page/web type: string start_time: description: 活动开始时间 example: 2021-11-25 15:23:43 type: string type: object AlipayOpenMiniTipsDeliveryCreateResponseModel: properties: delivery_id: description: 收藏引导活动ID example: "20211111000000797023" type: string type: object AlipayOpenMiniTipsDeliveryModifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - DELIVER_NOT_EXIST - TIPS_DELIVERY_AUDITING - SAME_MODIFY_OPERATION_TYPE - INVALID_OPERATE_TYPE - STATUS_NOT_ALLOWED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniTipsDeliveryModifyModel: properties: delivery_id: description: 收藏引导投放活动ID example: "20211114000003057595" type: string operate_type: description: 活动投放操作类型 example: RESUME type: string type: object AlipayOpenMiniTipsDeliveryModifyResponseModel: type: object AlipayOpenMiniTipsDeliveryQueryErrorResponseModel: properties: code: description: 错误码 enum: - DELIVER_NOT_EXIST - NO_PERMISSION type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniTipsDeliveryQueryResponseModel: properties: delivery_content: description: 收藏引导文案内容,不得超过14个字 example: 点击收藏,下次访问更方便 type: string delivery_id: description: 收藏引导投放活动ID example: "20211114000003057595" type: string delivery_name: description: 收藏引导配置投放活动的名称 example: 收藏引导配置投放活动 type: string end_time: description: 活动结束时间 example: 2021-11-12 14:31:13 type: string fail_reason: description: 文案审核驳回理由,仅AUDIT_REJECTED生效 example: 当前文案语义不通顺,请修改 type: string match_type: description: 匹配类型 example: TARGETURL type: string match_url: description: 目标页面地址,当匹配类型为TARGETURL时,投放文案仅在当前页面生效 example: /page/web type: string start_time: description: 活动开始时间 example: 2021-11-11 14:31:13 type: string status: description: 活动状态 example: WORKING type: string type: object AlipayOpenMiniTipsStatisticQueryErrorResponseModel: properties: code: description: 错误码 enum: - NO_QUERY_DELIVERY_ID - INVALID_QUERY_TYPE - INVALID_QUERY_TIME - DELIVER_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniTipsStatisticQueryResponseModel: properties: app_collect_cnt: description: 昨日(接口调用当日的前一天)小程序收藏人数,时间内未创建投放活动,则响应时不传出参数。 example: 4798780 type: integer app_uv: description: 昨日(接口调用当日的前一天)小程序访问人数。当小程序日访问量为0,或以活动维度查询,或时间内未创建投放活动,则响应时不传出参数。 example: 3080000 type: integer delivery_content: description: "收藏文案内容(仅以app维度查询时为空),仅活动维度查询成功时返回。" example: 点击收藏,下次使用更方便 type: string delivery_id: description: "收藏引导投放活动ID(仅以app维度查询时为空),仅活动维度查询成功时返回。" example: "2018092061468502" type: string tips_collect_rate: description: 昨日(接口调用当日的前一天)收藏引导文案收藏转化率,数据为小数字符串类型,取小数点后两位,单位为百分比。小程序曝光数为0,或时间内未创建投放活动,则响应时不传出参数。 example: "33.33" type: string tips_collect_uv: description: 昨日(接口调用当日的前一天)收藏引导文案收藏用户数,时间内未创建投放活动,则响应时不传出参数。 example: 440000 type: integer tips_expo_uv: description: 昨日(接口调用当日的前一天)收藏引导文案曝光用户数,时间内未创建投放活动,则响应时不传出参数。 example: 434000 type: integer total_app_collect_cnt: description: 时间段内累计小程序收藏人数,时间内未创建投放活动,则响应时不传出参数。 example: 7800000 type: integer total_app_uv: description: 时间段内累计小程序访问人数。当小程序日访问量为0,或以活动维度查询,或时间内未创建投放活动,则响应时不传出参数。 example: 79980000 type: integer total_tips_collect_rate: description: 时间段内收藏引导文案收藏转化率,数据为小数字符串类型,取小数点后两位,单位为百分比。小程序曝光数为0,或时间内未创建投放活动,则响应时不传出参数。 example: "33.33" type: string total_tips_collect_uv: description: 时间段内累计收藏引导文案收藏用户数,时间内未创建投放活动,则响应时不传出参数。 example: 5030000 type: integer total_tips_expo_uv: description: 时间段内累计收藏引导文案曝光用户数,仅当小程序/活动投放活动时返回。时间内未创建投放活动,则响应时不传出参数。 example: 2333900 type: integer type: object AlipayOpenMiniVersionAuditApplyErrorResponseModel: properties: code: 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 - HAS_NO_MODIFY_CNT - INVALID_TEST_PWD_LENGTH - SUB_APPLICATION_TYPE_ERROR - LICENSE_NAME_IS_BLANK - RISK_DECISION_HIT_BROAD - INVALID_TEST_ACCOUNT_LENGTH - DEVELOPER_INFO_NOT_EXIST - INVALIID_MEMO_TRADENO - MEMO_TRADENO_CHECK_FAIL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniVersionAuditApplyModel: properties: app_category_ids: description: 小程序类目,格式为 第一个一级类目_第一个二级类目;第二个一级类目_第二个二级类目,详细类目可以通过 https://docs.open.alipay.com/api_49/alipay.open.mini.category.query接口查询,如果不填默认采用当前小程序应用类目。使用默认应用类目后不需要再次上传营业执照号、营业执照名、营业执照截图、营业执照有效期。 example: 11_12;12_13 type: string app_desc: description: 小程序描述,长度限制 20~400 个字符(中文字符按2个字符计算)。 example: 一家专注做潮流女装的店铺,带给消费者价格便宜、质量上乘的衣服 type: string app_english_name: description: 小程序应用英文名称,长度限制 3~30 个字符(中文字符按2个字符计算);仅支持英文和数字。 example: demoexample type: string app_name: description: "小程序名称,长度限制 3~40 个字符(中文字符按2个字符计算),仅支持包含中文、数字、英文、下划线、+、-。\t如\ 果不填默认采用当前小程序应用名称,如无默认值则必填,不可为空。" example: 杭州支小宝潮流女装店 type: string app_slogan: description: 小程序简介,一句话描述小程序功能,长度限制 10~32个字符(中文字符按2个字符计算)。 example: 专注潮流女装20年 type: string app_version: description: 小程序版本号,请选择开发版本执行提交审核操作。 example: 0.0.1 type: string audit_rule: description: 审核类型,建议设置成“BASE_PROMOTE”,小程序将会更容易上架。将小程序发布审核拆分成“准入”、“营销”。原先小程序需要两个环节都审核通过才能上架,现在小程序只需要准入通过即可上架,但是无法在营销场景(支付宝泛搜、支付宝首页推荐等)展现给用户,小程序可通过精搜或者扫码等方式使用。如果小程序需要进行营销,可发布新版本,当准入&营销都通过后,小程序也可被营销。点击查看支付宝小程序营销规范:https://opendocs.alipay.com/b/03al2q example: BASE_PROMOTE type: string auto_online: description: "审核通过后是否自动上架,\t自动上架:true;不自动上架(默认):false。\t如果小程序上架前无需特殊处理,建\ 议设置成true,平台将会在小程序审核通过时自动将其上架" example: "true" type: string bundle_id: description: "小程序投放的端参数。例如投放到支付宝钱包是支付宝端。默认支付宝端。支持:\tcom.alipay.alipaywallet:支\ 付宝端;\tcom.alipay.iot.xpaas:支付宝IoT端。" example: com.alipay.alipaywallet type: string license_name: description: "营业执照名称,参照https://opendocs.alipay.com/mini/operation/material,要求填写营业执照信息。" example: '****集团股份有限公司' type: string license_no: description: 营业执照证件号,部分小程序类目需要提交,可通过https://opendocs.alipay.com/mini/03l8c8查询类目是否需要上传营业执照信息。参照https://opendocs.alipay.com/mini/operation/material 要求填写营业执照信息。 example: 9133********373179 type: string license_valid_date: description: 营业执照有效期,格式为 yyyy-MM-dd,9999-12-31表示长期有效。 example: 9999-12-31 type: string memo: description: 小程序备注,小程序备注最多500字符(中文字符按2个字符计算)。 example: 小程序示例 type: string mini_category_ids: description: "新小程序前台类目,格式为 第一个一级类目_第一个二级类目;第二个一级类目_第二个二级类目_第二个三级类目,详细类目可\ 以通过 https://docs.open.alipay.com/api_49/alipay.open.mini.category.query\t\ 接口查询mini_category_list。" example: XS1001_XS2001_XS3002;XS1011_XS2089;XS1002_XS2008_XS3024 type: string region_type: description: 小程序服务区域类型 example: CHINA type: string service_email: description: 小程序客服邮箱,如果不填默认采用当前小程序的应用客服邮箱,小程序客服电话和邮箱至少输入一个。如果前期已经设置过该信息,本次可不填,平台将会为你默认上传该信息。 example: example@mail.com type: string service_phone: description: 小程序客服电话,长度限制5~30个字符,仅支持包含数字和-。如果不填默认采用当前小程序的应用客服电话,小程序客服电话和邮箱至少输入一个。如果前期已经设置过该信息,本次可不填,平台将会为你默认上传该信息。 example: "13110101010" type: string service_region_info: 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 items: $ref: '#/components/schemas/RegionInfo' type: array speed_up: description: "如果有审核加急权益,是否使用审核加急权益加速审核:\t加速(默认):true\t不加速:false" example: "true" type: string test_accout: 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: "18812341234" type: string test_password: description: 测试账号密码 example: "12345678" type: string version_desc: description: 小程序版本描述,介绍此版本的主要变更和功能,30-500个字符(中文字符按2个字符计算)。 example: 该版本新增了XXX功能,修复了XXX的bug,优化了用户体验。 type: string type: object AlipayOpenMiniVersionAuditApplyResponseModel: properties: speed_up: description: "是否加速审核\t加速:true;\t不加速:false" example: "true" type: string speed_up_memo: description: 提审加速审核说明 example: 绿通权益使用限流 type: string type: object AlipayOpenMiniVersionAuditCancelErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniVersionAuditCancelModel: properties: app_version: description: "商家小程序审核中的版本号, 不传默认撤消正在审核中的版本。" example: 0.0.1 type: string bundle_id: description: "小程序客户端类型,默认为支付宝端。常见支持如下客户端:\tcom.alipay.alipaywallet:支付宝端;\ \tcom.alibaba.android.rimet:DINGDING端;\tcom.amap.app:高德端;\tcom.alibaba.ailabs.genie.webapps:\ 天猫精灵端;\tcom.alipay.iot.xpaas:支付宝IoT端。\t如需更多端投放,请联系业务BD。" example: com.alipay.alipaywallet type: string type: object AlipayOpenMiniVersionAuditCancelResponseModel: type: object AlipayOpenMiniVersionAuditedCancelErrorResponseModel: properties: code: 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 - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniVersionAuditedCancelModel: properties: app_version: description: 商家小程序版本号。可将已过审、审核被驳回的小程序版本退回到开发中的状态。 example: 0.0.1 type: string bundle_id: description: "小程序客户端类型。常见支持如下客户端:\tcom.alipay.alipaywallet:支付宝端;\tcom.alibaba.android.rimet:\ DINGDING端;\tcom.amap.app:高德端;\tcom.alibaba.ailabs.genie.webapps:天猫精灵端;\ \tcom.alipay.iot.xpaas:支付宝IoT端。\t如需更多端投放,请联系业务BD。" example: com.alipay.alipaywallet type: string type: object AlipayOpenMiniVersionAuditedCancelResponseModel: type: object AlipayOpenMiniVersionBuildQueryErrorResponseModel: properties: code: 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 - POLLING_BUILD_VERSION_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniVersionBuildQueryResponseModel: properties: build_status: description: 构建的状态,0-构建排队中;1-正在构建;2-构建成功;3-构建失败;5-构建超时 example: "0" type: string create_status: description: "创建版本的状态,状态说明如下:\t0:构建排队中;\t1:正在构建;\t2:构建成功;\t3:构建失败;\t5:构建\ 超时;\t6:版本创建成功。" example: "6" type: string need_rotation: description: 是否需要轮询 example: '"true"' type: string version_created: description: 是否创建版本 example: '"true"' type: string type: object AlipayOpenMiniVersionDeleteErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniVersionDeleteModel: properties: app_version: description: ' 小程序版本号。只有状态为开发中的版本才能被删除。' example: 0.0.1 type: string bundle_id: description: "小程序客户端类型,默认为支付宝端。常见支持如下客户端:\tcom.alipay.alipaywallet:支付宝端;\ \tcom.alibaba.android.rimet:DINGDING端;\tcom.amap.app:高德端;\tcom.alibaba.ailabs.genie.webapps:\ 天猫精灵端;\tcom.alipay.iot.xpaas:支付宝IoT端。\t如需更多端投放,请联系业务BD。" example: com.alipay.alipaywallet type: string type: object AlipayOpenMiniVersionDeleteResponseModel: type: object AlipayOpenMiniVersionDetailQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - APPLICATION_TYPE_NOT_MINIAPP - APP_VERSION_IS_BLANK - BUNDLE_ID_NOT_EXIST - VERSION_IS_BLANK type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniVersionDetailQueryResponseModel: properties: app_desc: description: 小程序应用描述 example: 小程序demo的相关示例 type: string app_english_name: description: 小程序应用英文名称 example: demoexample type: string app_logo: description: 小程序应用logo图标 example: http://image.aaaa.alipay.com type: string app_name: description: 小程序应用名称 example: 小程序demo type: string app_slogan: description: 小程序应用简介,一句话描述小程序功能 example: 小程序demo简介 type: string app_version: description: 小程序版本号 example: 0.0.1 type: string base_audit: description: "准入审核结果\t(提审时 audit_rule 传 BASE_PROMOTE 时有该字段)" example: PASS type: string base_audit_record: $ref: '#/components/schemas/MiniAppAuditReason' can_release: description: "是否可上架\ttrue:可上架\tfalse:不可上架\t(version_status 为PROMOTE_AUDIT_REJECT有\ 值)\t(提审时 audit_rule 传 BASE_PROMOTE 时有该字段)" example: "true" type: string gmt_apply_audit: description: 小程序版本提交审核的时间,格式为yyyy-MM-dd HH:mm:ss example: 2017-12-12 12:00:00 type: string gmt_audit_end: description: 小程序版本审核结束时间,格式为yyyy-MM-dd HH:mm:ss example: 2017-12-12 12:00:00 type: string gmt_create: description: 小程序版本创建时间 example: 2017-12-12 12:00:00 type: string gmt_offline: description: 小程序版本下架时间 example: 2017-12-12 12:00:00 type: string gmt_online: description: 小程序版本上架时间 example: 2017-12-12 12:00:00 type: string gray_strategy: description: 小程序灰度比例值,p10-10%的用户,p30-30%的用户,p50-50%的用户 example: p10 type: string memo: description: 小程序备注 example: 这是一个demo示例 type: string mini_app_category_info_list: description: 小程序类目列表 items: $ref: '#/components/schemas/MiniAppCategoryInfo' type: array mini_category_info_list: description: 新小程序类目列表 items: $ref: '#/components/schemas/MiniAppCategoryInfo' type: array package_info_list: description: 小程序功能包列表 items: $ref: '#/components/schemas/MiniPackageInfo' type: array promote_audit: description: "营销审核结果:\tPASS:通过\tREJECT:驳回\t(提审时 audit_rule 传 BASE_PROMOTE\ \ 时有该字段)" example: PASS type: string promote_audit_record: $ref: '#/components/schemas/MiniAppAuditReason' reject_reason: description: 审核驳回原因 example: 名称太宽泛 type: string scan_result: description: 安全扫描结果,True-安全扫描通过,False-安全扫描不通过,NAN-扫描中 example: "True" type: string screen_shot_list: description: 小程序版本截图,多个截图以逗号隔开 example: http://image.aaa.alipay.com items: type: string type: array service_email: description: 客服邮箱 example: example@mail.com type: string service_phone: description: 客服电话 example: "13110101010" type: string service_region_info: description: 小程序服务区域信息,当服务区域类型是LOCATION时,这里明确指出具体的服务区域信息 items: $ref: '#/components/schemas/RegionInfo' type: array service_region_type: description: 小程序服务区域类型 example: LOCATION type: string status: description: 小程序版本状态,INIT-开发中,AUDITING-审核中,WAIT_RELEASE-待上架,BASE_AUDIT_PASS-准入不可营销,AUDIT_REJECT-审核驳回,RELEASE-已上架,GRAY-灰度中,OFFLINE-已下架,AUDIT_OFFLINE-已被强制下架 example: INIT type: string version_desc: description: 小程序版本描述 example: 这是一个简单的版本描述 type: string type: object AlipayOpenMiniVersionGrayCancelErrorResponseModel: properties: code: 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 - CAN_NOT_CANCEL_GRAY_WITH_DIFF_DW type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniVersionGrayCancelModel: properties: app_version: description: 商家灰度中的小程序版本号,结束灰度后小程序将回到审核通过状态。 example: 0.0.1 type: string bundle_id: description: "小程序客户端类型,默认为支付宝端。常见支持如下客户端:\tcom.alipay.alipaywallet:支付宝端;\ \tcom.alibaba.android.rimet:DINGDING端;\tcom.amap.app:高德端;\tcom.alibaba.ailabs.genie.webapps:\ 天猫精灵端;\tcom.alipay.iot.xpaas:支付宝IoT端。\t如需更多端投放,请联系业务BD。" example: com.alipay.alipaywallet type: string type: object AlipayOpenMiniVersionGrayCancelResponseModel: type: object AlipayOpenMiniVersionGrayOnlineErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniVersionGrayOnlineModel: properties: app_version: description: 商家小程序版本号,需为审核通过状态的小程序版本。 example: 0.0.1 type: string bundle_id: description: "小程序客户端类型,默认为支付宝端。常见支持如下客户端:\tcom.alipay.alipaywallet:支付宝端;\ \tcom.alibaba.android.rimet:DINGDING端;\tcom.amap.app:高德端;\tcom.alibaba.ailabs.genie.webapps:\ 天猫精灵端;\tcom.alipay.iot.xpaas:支付宝IoT端。\t如需更多端投放,请联系业务BD。" example: com.alipay.alipaywallet type: string gray_strategy: description: 小程序灰度策略值 example: p10 type: string type: object AlipayOpenMiniVersionGrayOnlineResponseModel: type: object AlipayOpenMiniVersionListQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - APPLICATION_TYPE_NOT_MINIAPP - NO_TEMPLATE_INSTANTIATE_RELATION - PAGE_SIZE_LESS_ZERO type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniVersionListQueryResponseModel: properties: app_version_infos: description: 版本列表,根据版本号倒叙排列,即版本号大的在前面;如果不存在任何版本,返回空列表 items: $ref: '#/components/schemas/AppVersionInfo' type: array app_versions: description: 小程序支付宝端每个状态的最新版本号列表(历史返回值,已不推荐使用,逐渐废弃) example: "[\"0.0.1\",\"0.0.2\"]" items: type: string type: array type: object AlipayOpenMiniVersionOfflineErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniVersionOfflineModel: properties: app_version: description: 商家小程序已上架版本号。 example: 0.0.1 type: string bundle_id: description: "小程序客户端类型,默认为支付宝端。常见支持如下客户端:\tcom.alipay.alipaywallet:支付宝端;\ \tcom.alibaba.android.rimet:DINGDING端;\tcom.amap.app:高德端;\tcom.alibaba.ailabs.genie.webapps:\ 天猫精灵端;\tcom.alipay.iot.xpaas:支付宝IoT端。\t如需更多端投放,请联系业务BD。" example: com.alipay.alipaywallet type: string type: object AlipayOpenMiniVersionOfflineResponseModel: type: object AlipayOpenMiniVersionOnlineErrorResponseModel: properties: code: 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 - CAN_NOT_ONLINE_WITHOUT_REGISTRATION type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniVersionOnlineModel: properties: app_version: description: 商家小程序版本号,需为审核通过状态或灰度中版本。 example: 0.0.1 type: string bundle_id: description: "小程序客户端类型,默认为支付宝端。常见支持如下客户端:\tcom.alipay.alipaywallet:支付宝端;\ \tcom.alibaba.android.rimet:DINGDING端;\tcom.amap.app:高德端;\tcom.alibaba.ailabs.genie.webapps:\ 天猫精灵端;\tcom.alipay.iot.xpaas:支付宝IoT端。\t如需更多端投放,请联系业务BD。" example: com.alipay.alipaywallet type: string downgrade: description: true - 性能优先; false - 覆盖优先(默认) example: false type: boolean type: object AlipayOpenMiniVersionOnlineResponseModel: type: object AlipayOpenMiniVersionRollbackErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniVersionRollbackModel: properties: app_version: description: "商家小程序已上架版本。下架后将自动回滚至上一(已上架)小程序版本。\t例如:商家小程序有 0.01(上一上架版本)、\ 0.02(未上架版本)、0.03(当前上架版本) 三个版本,回滚时需传入商家小程序版本 0.03 表示将 0.03 版本回滚至上一个已上架版\ 本即此处 0.01 版本,同时 0.03 版本将自动下架,0.01 版本自动上架(无需审核)。" example: 0.0.1 type: string bundle_id: description: "小程序客户端类型,默认为支付宝端。常见支持如下客户端:\tcom.alipay.alipaywallet:支付宝端;\ \tcom.alibaba.android.rimet:DINGDING端;\tcom.amap.app:高德端;\tcom.alibaba.ailabs.genie.webapps:\ 天猫精灵端;\tcom.alipay.iot.xpaas:支付宝IoT端。\t如需更多端投放,请联系业务BD。" example: com.alipay.alipaywallet type: string type: object AlipayOpenMiniVersionRollbackResponseModel: type: object AlipayOpenMiniVersionUploadErrorResponseModel: properties: code: 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 - APP_TO_APP_AUTH_FAIL - BUILD_VERSION_COMPARE_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniVersionUploadModel: properties: app_version: description: "商家小程序版本号。版本号必须满足 x.y.z, 且均为数字。要求版本号比商户之前最新的版本号高。" example: 0.0.1 type: string bundle_id: description: "小程序客户端类型,默认为支付宝端。常见支持如下客户端:\tcom.alipay.alipaywallet:支付宝端;\ \tcom.alibaba.android.rimet:DINGDING端;\tcom.amap.app:高德端;\tcom.alibaba.ailabs.genie.webapps:\ 天猫精灵端;\tcom.alipay.iot.xpaas:支付宝IoT端。\t如需更多端投放,请联系业务BD。" example: com.alipay.alipaywallet type: string ext: description: "自定义参数,用于配置商家小程序的个性化内容,具体使用方法参见示例代码。\t在小程序中可以通过 my.getExtConfig()\ \ 或 my.getExtConfigSync() 获取 ext 参数内容(建议支付宝版本 > 10.1.38,并使用 my.canIUse 做兼容处理)\ 。" example: "{\"extEnable\": true, \"extPages\": {\"pages/face/index\": {\"\ defaultTitle\": \"哈哈哈哈\"}},\"window\": {\"defaultTitle\": \"AI2\"}}" type: string template_id: description: 小程序模板 APPID。 example: "1" type: string template_version: description: "小程序模板版本号。版本号必须满足 x.y.z, 且均为数字。不传默认使用最新在架(已上架)模板版本。" example: 0.0.1 type: string type: object AlipayOpenMiniVersionUploadResponseModel: properties: build_status: description: 构建的状态,0-构建排队中;1-正在构建;2-构建成功;3-构建失败;5-构建超时 example: "0" type: string create_status: description: 创建版本的状态,0-构建排队中;1-正在构建;2-构建成功;3-构建失败;5-构建超时;6-版本创建成功 example: "6" type: string need_rotation: description: 是否需要轮询 example: '"true"' type: string version_created: description: 是否创建了版本 example: "true" type: string type: object AlipayOpenMiniWidgetDataSyncErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniWidgetDataSyncModel: properties: activity_list: description: 活动信息列表 items: $ref: '#/components/schemas/WidgetActivityInfo' type: array data_type: description: 数据类型,可选值:ACTIVITY(活动数据)、GOODS(商品数据) example: ACTIVITY type: string goods_list: description: 商品信息列表 items: $ref: '#/components/schemas/WidgetGoodsInfo' type: array mini_app_id: description: 商家小程序ID example: "2017072607907880" type: string pid: description: 小程序背后的商家,和mini_app_id要求对应 example: 2088xxxxxxxxx type: string type: object AlipayOpenMiniWidgetDataSyncResponseModel: properties: commit_id: description: 同步接口生成的唯一标识,用于查询提交数据的审核状态 example: "20220829000000000101" type: string type: object AlipayOpenMiniWidgetGoodsModifyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniWidgetGoodsModifyModel: properties: buying_url: description: 需要修改的商品小程序购买链接 example: alipays://platformapi/startapp?appId= 2017072607907880&page=pages/index/index?param=xxxx type: string goods_brand: description: 需要修改的商品品牌 example: 肯德基 type: string goods_comment: description: 需要修改的商品辅助说明文案 example: 这是一个商品辅助说明文案 type: string goods_description_label: description: 需要修改的商品说明标签(如-随心退) example: 随心退 type: string goods_id: description: 商品的唯一标识,根据该字段修改商品 example: "8948968498" type: string goods_label: description: 需要修改的商品营销标签(如-限量特价),每个商品仅支持一个营销标签 example: 限量特价 type: string goods_name: description: 需要修改的商品名称 example: 这是一个商品名称 type: string goods_type: description: 需要修改的商品所属品类 example: 服装 type: string main_pic_url: description: 需要修改的商品主图片地址 example: https://xxx.xxx.com/xxx.jpg type: string need_public_promo: description: 是否需要进行公域推广 example: true type: boolean order_number: description: "需要修改的商品排序,自然整数, 数字越小越靠前" example: 1 type: integer original_price: description: 需要修改的商品原价,单位"元",传入数字,不需要传入"元" example: "88.88" type: string publish_cities: description: "需要修改的商品投放城市的列表,详见https://www.mca.gov.cn/article/sj/xzqh/2020/2020/202007170301.html,\ 有多个用英文,分隔。如果没有限制则不传入" example: "110000" type: string sell_price: description: 需要修改的商品售价,位"元",传入数字,不需要传入"元" example: "66.66" type: string sell_tag_list: description: 需要修改的商品卖点标签 example: "[\"特惠\",\"热卖\"]" items: type: string type: array type: object AlipayOpenMiniWidgetGoodsModifyResponseModel: properties: commit_id: description: 商品修改返回的提交ID,用于查询商品信息的审核状态 example: "20220829000000000101" type: string type: object AlipayOpenMiniWidgetGoodsQueryErrorResponseModel: properties: code: description: 错误码 enum: - GOODS_PAGE_SIZE_LIMIT - PAGE_NUM_NO_LESS_ONE - PARAM_IS_NULL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniWidgetGoodsQueryResponseModel: properties: data_list: description: 商品信息列表 items: $ref: '#/components/schemas/GoodsQueryResponse' type: array page_num: description: 查询第几页 example: 1 type: integer page_size: description: 查询页面数量 example: 10 type: integer total: description: 查询结果总数 example: 10 type: integer type: object AlipayOpenMiniWidgetGoodsUploadErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenMiniWidgetGoodsUploadModel: properties: goods_list: description: 商品信息列表 items: $ref: '#/components/schemas/WidgetGoodsInfo' type: array mini_app_id: description: 用于承接品的商家小程序ID example: "2017072607907880" type: string pid: description: 品的售卖商家,即承接该品的小程序背后的商家。和mini_app_id要求对应 example: 2088xxxxxxxxx type: string type: object AlipayOpenMiniWidgetGoodsUploadResponseModel: properties: commit_id: description: 商品提交生成的唯一标识,用于查询商品信息的审核状态 example: "20220829000000000101" type: string type: object AlipayOpenPublicAccountCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicAccountCreateModel: properties: agreement_id: description: 账户添加成功,在支付宝与其对应的协议号。如果账户重复添加,接口保证幂等依然视为添加成功,返回此前该账户在支付宝对应的协议号。其他异常该字段不存在。 example: "29022222" type: string bind_account_no: description: 绑定帐号,建议在开发者的系统中保持唯一性 example: test001 type: string display_name: description: 开发者期望在服务窗首页看到的关于该用户的显示信息,最长10个字符 example: test001 type: string from_user_id: description: 要绑定的商户会员对应的支付宝userid,2088开头长度为16位的字符串 example: "2088801234567890" type: string open_id: description: 支付宝用户的唯一标识 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string real_name: description: 要绑定的商户会员的真实姓名,最长10个汉字 example: 张三 type: string remark: description: 备注信息,开发者可以通过该字段纪录其他的额外信息 example: 备注信息 type: string type: object AlipayOpenPublicAccountCreateResponseModel: properties: agreement_id: description: 协议号,商户会员在支付宝服务窗账号中的唯一标识 example: "29022222" type: string type: object AlipayOpenPublicAccountDeleteErrorResponseModel: properties: code: description: 错误码 enum: - OPEN_ID_IS_ILLEGAL - ACCOUNT_PARAMS_NOT_ENOUGH - FORBIT_REMOVE_BIND_ACCOUNT - REMOVE_BIND_ACCOUNT_FAIL - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicAccountDeleteResponseModel: type: object AlipayOpenPublicAccountQueryErrorResponseModel: properties: code: description: 错误码 enum: - OPEN_ID_IS_ILLEGAL - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicAccountQueryResponseModel: properties: public_bind_accounts: description: 绑定账户列表 items: $ref: '#/components/schemas/StdPublicBindAccount' type: array type: object AlipayOpenPublicAccountResetErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicAccountResetModel: properties: agreement_id: description: 需要重置的协议号,商户会员在支付宝生活号账号中的唯一标识。 example: "29022222" type: string bind_account_no: description: 绑定帐号,建议在开发者的系统中保持唯一性 example: test002 type: string display_name: description: "商户期望在生活号首页看到的关于该用户的显示信息,最长10个字符。\t" example: test002 type: string from_user_id: description: "要绑定的商户会员对应的支付宝唯一标识,2088开头长度为16位的字符串。\t" example: "2088801234567890" type: string open_id: description: 支付宝用户的唯一标识 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string real_name: description: 要绑定的商户会员的真实姓名,最长10个汉字 example: 张三 type: string remark: description: 备注信息,开发者可以通过该字段纪录其他的额外信息 example: 备注信息 type: string type: object AlipayOpenPublicAccountResetResponseModel: properties: agreement_id: description: 重置后的协议号,商户会员在支付宝服务窗账号中的唯一标识 example: "29022223" type: string type: object AlipayOpenPublicAdvertBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - BUSINESS_ERROR - APP_NO_AVAIABLE type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicAdvertBatchqueryResponseModel: properties: advert_list: description: 广告位列表 。目前只有一个广告位。 items: $ref: '#/components/schemas/Advert' type: array count: description: 广告组数量 example: 1 type: integer type: object AlipayOpenPublicAdvertCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicAdvertCreateModel: properties: advert_items: description: ' 广告位轮播内容列表。数量限制:大于1个,小于5个。广告位轮播内容顺序:与接口传入的顺序排列一致。' items: $ref: '#/components/schemas/AdvertItem' type: array type: object AlipayOpenPublicAdvertCreateResponseModel: properties: advert_group: description: 广告分组标识 example: default type: string advert_id: description: 广告位id example: "123" type: string type: object AlipayOpenPublicAdvertDeleteErrorResponseModel: properties: code: description: 错误码 enum: - ILLEGAL_BIZ_PARAMS - PUBLIC_ADVERT_ID_INVALID - PUBLIC_ADVERT_NOT_EXISTS - SYSTEM_ERROR - BUSINESS_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicAdvertDeleteResponseModel: type: object AlipayOpenPublicAdvertModifyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicAdvertModifyModel: properties: advert_id: description: 广告位id,通过alipay.open.public.advert.create(生活号广告位添加接口)添加广告位获取。 example: "123" type: string advert_items: description: 广告位轮播内容列表。数量限制:大于1个,小于5个。广告位轮播内容顺序:与接口传入的顺序排列一致。 items: $ref: '#/components/schemas/AdvertItem' type: array type: object AlipayOpenPublicAdvertModifyResponseModel: type: object AlipayOpenPublicArticlesummaryDataBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - ILLEGAL_BIZ_PARAMS - SYSTEM_ERROR - BUSINESS_ERROR - QUERY_DATE_INVALID type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicArticlesummaryDataBatchqueryModel: properties: begin_date: description: 数据开始日期,时间格式为 "yyyyMMdd" 。 example: "20171101" type: string end_date: description: 数据结束日期,时间格式为"yyyyMMdd"。查询数据开始日期/结束日期时间跨度最大30天。 example: "20171108" type: string type: object AlipayOpenPublicArticlesummaryDataBatchqueryResponseModel: properties: data_list: description: 文章分析数据列表 items: $ref: '#/components/schemas/ArticleSummaryAnalysisData' type: array type: object AlipayOpenPublicContactFollowBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - ILLEGAL_BIZ_PARAMS - QUERY_CONTACT_FOLLOWER_FORBIDDEN - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicContactFollowBatchqueryResponseModel: properties: contact_follow_list: description: 联系人关注者列表 items: $ref: '#/components/schemas/ContactFollower' type: array type: object AlipayOpenPublicDefaultExtensionCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicDefaultExtensionCreateModel: properties: areas: description: 默认扩展区列表,最多包含3个扩展区 items: $ref: '#/components/schemas/ExtensionArea' type: array type: object AlipayOpenPublicDefaultExtensionCreateResponseModel: properties: extension_key: description: 一套扩展区的key,创建一套扩展区成功后,支付宝会将该字段返回,后续对扩展区进行删除等操作都会用到这个值。 example: "10000" type: string type: object AlipayOpenPublicFollowBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - QUERY_FOLLOWER_FORBIDDEN - OPENID_INVALID - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicFollowBatchqueryModel: properties: next_user_id: description: 当关注者数量超过10000时使用,本次拉取数据中第一个用户的userId,从上次接口调用返回值中获取。第一次调用置空 example: "2088102146158132" type: string open_id: description: 支付宝用户的唯一标识 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string type: object AlipayOpenPublicFollowBatchqueryResponseModel: properties: count: description: 本次调用获取的userId个数,最大值为10000 example: "10000" type: string next_user_id: description: 查询分组的userid example: "2088102123322367" type: string open_id: description: 支付宝用户的 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string open_id_list: description: 支付宝用户的唯一标识列表 example: "[\"074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5\"]" items: type: string type: array user_id_list: description: 用户的userId列表 example: "[\"2088102146158132\",\"2088102150429794\",\"2088102150477652\"\ \ ]" items: type: string type: array type: object AlipayOpenPublicGroupBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicGroupBatchqueryResponseModel: properties: groups: description: 用户分组列表,包含每个分组的id、name、以及规则模型 items: $ref: '#/components/schemas/QueryGroup' type: array type: object AlipayOpenPublicGroupCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicGroupCreateModel: properties: label_rule: description: 标签规则,满足该规则的粉丝将被圈定,标签id不能重复 items: $ref: '#/components/schemas/ComplexLabelRule' type: array name: description: 分组名称,仅支持中文、字母、数字、下划线的组合。 example: 测试分组 type: string type: object AlipayOpenPublicGroupCreateResponseModel: properties: group_id: description: 分组id example: "10000" type: string type: object AlipayOpenPublicGroupCrowdQueryErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicGroupCrowdQueryModel: properties: label_rule: description: 用户分组的规则项列表,规则项之间元素是与的逻辑,每个规则项内部用多个值表示或的逻辑 items: $ref: '#/components/schemas/ComplexLabelRule' type: array type: object AlipayOpenPublicGroupCrowdQueryResponseModel: properties: count: description: 分组圈出的人群数量 example: "2000000" type: string type: object AlipayOpenPublicGroupDeleteErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - GROUP_ID_INVALID - GROUP_NOT_EXISTED - GROUP_NOT_ALLOW_DELETE type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicGroupDeleteResponseModel: type: object AlipayOpenPublicGroupModifyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicGroupModifyModel: properties: group_id: description: "分组ID,通过alipay.open.public.group.create(用户分组创建接口)\t创建用户分组获取。" example: "100" type: string label_rule: description: 标签规则,满足该规则的粉丝将被圈定,标签id不能重复 items: $ref: '#/components/schemas/ComplexLabelRule' type: array name: description: 分组名称,仅支持中文、字母、数字、下划线的组合。 example: 测试分组 type: string type: object AlipayOpenPublicGroupModifyResponseModel: type: object AlipayOpenPublicInfoModifyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicInfoModifyModel: properties: app_name: description: "生活号名称,2-20个字之间。注意:\t* 不得含有违反法律法规和公序良俗的相关信息;\t* 不得侵害他人名誉权、知\ 识产权、商业秘密等合法权利;\t* 不得以太过广泛的、或产品、行业词组来命名,如:女装、皮革批发;\t* 不得以实名认证的媒体资质账号创建服\ 务窗,或媒体相关名称命名服务窗,如:XX电视台、XX杂志等。" example: 生活号名称 type: string auth_pic: description: 授权运营书图片地址,企业商户若为被经营方授权,需上传加盖公章的扫描件。支持 .jpg、 .jpeg、 .png 格式,需小于1M。使用 alipay.offline.material.image.upload(上传门店照片和视频接口)上传图片后,将得到的image_url回填与此处。 example: http://pic.alipayobjects.com/e/201311/1ZQ type: string background_url: description: 背景图片地址,建议尺寸 1600 x 1000px,支持.jpg .jpeg .png格式,小于1M。使用 alipay.offline.material.image.upload(上传门店照片和视频接口)上传图片后,将得到的image_url回填与此处。 example: http://pic.alipayobjects.com/e/201311/1ZQ type: string introduction: description: 简介 example: 生活号简介 type: string license_url: description: "营业执照地址,建议尺寸 320*320 px,支持 .jpg、 .jpeg、 .png 格式,需小于1M。\t使用\ \ alipay.offline.material.image.upload(上传门店照片和视频接口)上传图片后,将得到的image_url回\ 填与此处。" example: http://pic.alipayobjects.com/e/201311/1ZQ type: string logo_url: description: "生活号头像地址,建议尺寸 320*320 px,支持 .jpg、 .jpeg、 .png 格式,需小于1M。\t使用\ \ alipay.offline.material.image.upload(上传门店照片和视频接口)上传图片后,将得到的image_url回\ 填与此处。" example: http://pic.alipayobjects.com/e/201311/1ZQ type: string notify_url: description: 通知地址 type: string public_greeting: description: 欢迎语 example: 欢迎光临 type: string shop_pics: description: "门店照片地址,支持 .jpg、 .jpeg、 .png 格式,需小于1M。\t使用 alipay.offline.material.image.upload(上传门店照片和视频接口)上传图片后,将得到的image_url回\ 填与此处。" example: http://pic.alipayobjects.com/e/201311/1ZQ items: type: string type: array type: object AlipayOpenPublicInfoModifyResponseModel: properties: audit_desc: description: 服务窗审核状态描述 example: 审核中 type: string audit_status: description: 服务窗审核状态,申请成功后返回AUDITING,等待风控审核 example: AUDITING type: string type: object AlipayOpenPublicInfoQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - APP_NOT_PUBLICAPP type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicInfoQueryResponseModel: properties: app_name: description: 生活号名称 example: 生活号名称 type: string audit_desc: description: 最新审核状态描述,如果审核驳回则有相关的驳回理由 example: logo图片不符合规范 type: string audit_status: description: 最新审核状态,对于系统商而言,只有四个状态,AUDITING:审核中,AUDIT_FAILED:审核驳回,AUDIT_SUCCESS:审核通过,AUDIT_NORMAL:无审核状态(当前没有处于审核过程的工单) example: AUDITING type: string audit_status_list: description: 审核状态表,目前支持名称、头像、名称与头像、简介审核状态 items: $ref: '#/components/schemas/PublicAuditStatus' type: array background_url: description: 背景图片地址 example: http://dl.django.t.taobao.com/rest/1.0/image?fileIds=V9rfg69SSimLZg5wDA3yEgAAACMA type: string introduction: description: 生活号简介 example: 简介 type: string is_online: description: 生活号是否上线,T表示上线,F表示未上线 example: T type: string is_release: description: 生活号是否上架,T表示上架,上架即可在支付宝客户端被搜索到,F表示未上架 example: F type: string logo_url: description: 生活号头像地址 example: http://pic.alipayobjects.com/e/201311/1ZQ type: string mcc_code_desc: description: 商家经营类目,详情参见 商家经营类目 example: 房地产开发商 type: string public_greeting: description: 欢迎语 example: 欢迎光临 type: string type: object AlipayOpenPublicLabelCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicLabelCreateModel: properties: name: description: 标签名 example: 测试标签01 type: string type: object AlipayOpenPublicLabelCreateResponseModel: properties: id: description: 支付宝返回的标签ID,开发者后续通过该ID进行标签的查询、修改、删除等操作 example: 100513 type: integer name: description: 开发者传入name的值 example: 测试标签01 type: string type: object AlipayOpenPublicLabelQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicLabelQueryResponseModel: properties: label_list: description: 该服务窗拥有的标签列表 items: $ref: '#/components/schemas/PublicLabel' type: array type: object AlipayOpenPublicLabelUserQueryErrorResponseModel: properties: code: description: 错误码 enum: - ILLEGAL_BIZ_PARAMS - OPEN_ID_IS_ILLEGAL - FORBIT_QUERY_USER_LABEL - PUBLIC_ID_IS_EMPTY - USER_ID_IS_EMPTY - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicLabelUserQueryResponseModel: properties: label_ids: description: 用户标签id列表,以英文逗号分隔 example: "100509,100510,100511,100512" type: string type: object AlipayOpenPublicLifeAboardApplyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicLifeAboardApplyResponseModel: properties: result: description: 上架成功后返回的提示 example: 上架成功 type: string type: object AlipayOpenPublicLifeAgentcreateQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_OUT_BIZ_NO - LIFE_NO_EXIST_OUT_BIZ_NO - LIFE_ILLEGAL_ISV_APP_ID - BUSINESS_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicLifeAgentcreateQueryResponseModel: properties: life_app_id: description: 只有审核通过,且商户在支付宝发送的授权邮件中确认授权,此时生活号才会正式创建,查询才会返回该值 example: "2017062501320531" type: string merchant_pid: description: 商户pid example: "2088302109396986" type: string order_status_biz_desc: description: "支付宝商户入驻申请单状态,申请单状态包括:暂存、审核中、待商户确认、成功、失败。\t说明:暂存是审核前的中间状态,如\ 出现暂存状态请再次提交代创建生活号申请。" example: 审核成功 type: string out_biz_no: description: 由开发者创建的外部入驻申请单据号 example: "2016070788301823878" type: string refused_reason: description: 只有审核失败才会返回该值 example: 提供的资质证明不符合要求,请重新上传再试 type: string type: object AlipayOpenPublicLifeDebarkApplyErrorResponseModel: properties: code: description: 错误码 enum: - LIFE_ALREADY_DEBARK - LIFE_ILLEGAL_ISV_APP_ID - BUSINESS_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicLifeDebarkApplyResponseModel: properties: result: description: 下架成功后返回的提示 example: 下架成功 type: string type: object AlipayOpenPublicLifeLabelBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicLifeLabelBatchqueryResponseModel: properties: labels: description: 标签列表 items: $ref: '#/components/schemas/LifeLabel' type: array type: object AlipayOpenPublicLifeLabelCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicLifeLabelCreateModel: properties: data_type: description: "标签值类型,不填默认为 string 类型。\t注意:目前只支持 string(字符串类型)。" example: string type: string label_name: description: "自定义标签名。\t注意:每个生活号最多创建 100 个自定义标签。" example: 职业 type: string type: object AlipayOpenPublicLifeLabelCreateResponseModel: properties: label_id: description: 标签id example: "10000" type: string type: object AlipayOpenPublicLifeLabelDeleteErrorResponseModel: properties: code: description: 错误码 enum: - DEL_LABEL_ID_IS_EMPTY - LABEL_NOT_EXISTS - LABEL_IS_USED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicLifeLabelDeleteResponseModel: type: object AlipayOpenPublicLifeLabelModifyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicLifeLabelModifyModel: properties: label_id: description: 标签 id,只支持生活号自定义标签。通过 alipay.open.public.life.label.create(创建标签接口)创建自定义标签后获取。 example: "10000" type: string label_name: description: 标签名 example: 职业 type: string type: object AlipayOpenPublicLifeLabelModifyResponseModel: type: object AlipayOpenPublicLifeMsgRecallErrorResponseModel: properties: code: description: 错误码 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicLifeMsgRecallModel: properties: message_id: description: 消息id,可在调用群发消息组发消息接口时会返回,请注意保存留用。 example: "2016000000000000" type: string type: object AlipayOpenPublicLifeMsgRecallResponseModel: type: object AlipayOpenPublicLifeMsgSendErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicLifeMsgSendModel: properties: category: description: 消息分类,请传入对应分类编码值 example: c001 type: string content: description: 消息正文,html原文或纯文本 example: 多云转晴,10°-21° type: string desc: description: 消息概述 example: 多云转晴,13-21° type: string msg_type: description: 媒体资讯类生活号消息类型 example: IMAGE-CONTENT: 生活号新图文消息(单条),VIDEO:生活号视频消息(单条) type: string source_ext_info: 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\"}" type: string title: description: 消息标题 example: 杭州天气预报 type: string unique_msg_id: description: 来源方消息唯一标识;若不为空,根据此id和生活号id对消息去重;若为空,不去重 example: "2016042810221362" type: string video_length: description: 生活号消息视频时长,单位:秒(视频类消息必填) example: "120" type: string video_samples: description: 视频类型消息中视频抽样关键帧截图,视频类消息选填 example: https://os.alipayobjects.com/rmsportal/SbMPIcOBQLFUXGg.jpg items: type: string type: array video_size: description: 视频大小,单位:KB(视频类消息必填) example: "1024" type: string video_source: description: "视频资源来源id(视频类消息必填),取值限定youku, miaopai, taobao, sina中的一个" example: youku type: string video_temporary_url: description: 视频的临时链接(优酷来源的视频消息,该字段不能为空) example: https://openhome.alipay.com/platform/home.htm type: string video_url: description: 生活号视频类消息视频id或url(视频类消息必填,根据来源区分) example: https://open.alipay.com/platform/home.htm type: string type: object AlipayOpenPublicLifeMsgSendResponseModel: properties: alipay_msg_id: description: 生活号消息唯一标识 example: "2016042811340001" type: string type: object AlipayOpenPublicMatchuserLabelCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicMatchuserLabelCreateModel: properties: label_id: description: 标签 id,只支持生活号自定义标签。通过 alipay.open.public.life.label.create(创建标签接口)创建自定义标签后获取。 example: "10000" type: string label_value: description: 标签值,由开发者自主指定,标签值类型要满足 alipay.open.public.life.label.create(创建标签接口)中data_type参数的限定。 example: 浙江 type: string matchers: description: 支付宝用户匹配器列表,最多传入10条 items: $ref: '#/components/schemas/Matcher' type: array type: object AlipayOpenPublicMatchuserLabelCreateResponseModel: properties: error_count: description: 用户打标失败数量 example: 1 type: integer error_matchers: description: 出错的匹配器列表 items: $ref: '#/components/schemas/ErrorMatcher' type: array type: object AlipayOpenPublicMatchuserLabelDeleteErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicMatchuserLabelDeleteModel: properties: label_id: description: 标签 id,只支持生活号自定义标签。通过 alipay.open.public.life.label.create(创建标签接口)创建自定义标签后获取。 example: "10000" type: string matchers: description: 支付宝用户匹配器列表,最多传入10条 items: $ref: '#/components/schemas/Matcher' type: array type: object AlipayOpenPublicMatchuserLabelDeleteResponseModel: properties: error_count: description: 用户打标失败数量 example: 1 type: integer error_matchers: description: 出错的匹配器列表 items: $ref: '#/components/schemas/ErrorMatcher' type: array type: object AlipayOpenPublicMenuBatchqueryErrorResponseModel: properties: code: description: 错误码 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicMenuBatchqueryResponseModel: properties: count: description: 菜单数量,包括默认菜单和个性化菜单 example: "5" type: string menus: description: 菜单列表 items: $ref: '#/components/schemas/QueryMenu' type: array type: object AlipayOpenPublicMenuCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicMenuCreateModel: properties: button: description: "一级菜单列表。说明:\t* 如果是文本菜单,最多有4个一级菜单,若开发者在后台打开了\"咨询反馈\"的开关,则只能有\ 3个一级菜单。\t* 如果是 ICON 菜单信息,最多有80个一级菜单(忽略二级菜单)。" items: $ref: '#/components/schemas/ButtonObject' type: array type: description: "菜单类型,不填时默认为 text(文本型菜单)。枚举值如下:\t* text:文本型菜单。\t* icon:表示 icon\ \ 型菜单,当传值为\"icon\"时,菜单节点的icon字段必传。" example: text type: string type: object AlipayOpenPublicMenuCreateResponseModel: properties: menu_key: description: 默认菜单菜单key,文本菜单为“default”,icon菜单为“iconDefault” example: default type: string type: object AlipayOpenPublicMenuDataBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - ILLEGAL_BIZ_PARAMS - SYSTEM_ERROR - BUSINESS_ERROR - QUERY_DATE_INVALID type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicMenuDataBatchqueryModel: properties: begin_date: description: 数据开始日期,时间格式为 "yyyyMMdd" 。 example: "20171101" type: string end_date: description: 数据结束日期,时间格式为"yyyyMMdd"。查询数据开始日期/结束日期时间跨度最大30天。 example: "20171108" type: string type: object AlipayOpenPublicMenuDataBatchqueryResponseModel: properties: data_list: description: 菜单分析数据列表 items: $ref: '#/components/schemas/MenuAnalysisData' type: array type: object AlipayOpenPublicMenuModifyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicMenuModifyModel: properties: button: description: "一级菜单列表。说明:\t* 如果是文本菜单,最多有4个一级菜单,若开发者在后台打开了\"咨询反馈\"的开关,则只能有\ 3个一级菜单。\t* 如果是 ICON 菜单信息,最多有80个一级菜单(忽略二级菜单)。" items: $ref: '#/components/schemas/ButtonObject' type: array type: description: "菜单类型,不填时默认为 text(文本型菜单)。枚举值如下:\t* text:文本型菜单。\t* icon:表示 icon\ \ 型菜单,当传值为\"icon\"时,菜单节点的icon字段必传。" example: icon type: string type: object AlipayOpenPublicMenuModifyResponseModel: type: object AlipayOpenPublicMenuQueryErrorResponseModel: properties: code: description: 错误码 enum: - MENU_NOT_SET - MENU_NOT_EXIST - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicMenuQueryResponseModel: properties: menu_content: description: 一级菜单数组,个数应为1~4个 example: "{\"button\":[{\"actionParam\":\"menu_v01_pay\",\"actionType\"\ :\"in\",\"name\":\"支付\"}]}" type: string type: object AlipayOpenPublicMessageContentCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicMessageContentCreateModel: properties: benefit: description: 活动利益点,最多10个字符。仅 ctype 为 activity 类型时才需传入。 example: 满**减** type: string content: description: 消息正文(支持富文本) example: 示例 type: string could_comment: description: "是否允许评论。枚举支持:\t*T:允许。\t*F:不允许,默认不允许。" example: T type: string cover: 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 type: string ctype: description: 图文类型,不填默认普通图文。还支持 activity(活动图文)。 example: activity type: string ext_tags: description: 关键词列表,英文逗号分隔,最多不超过5个 example: "关键,热度" type: string login_ids: description: 可预览支付宝账号列表,需要预览时才填写, 英文逗号分隔,最多不超过10个 example: "13434343432,xxx@163.com" type: string title: description: 标题 example: 标题 type: string type: object AlipayOpenPublicMessageContentCreateResponseModel: properties: content_id: description: 内容id example: 201410323232dsadjada-dsa-1234dsada type: string content_url: description: 内容详情内链url example: alipays://xxxx type: string type: object AlipayOpenPublicMessageContentModifyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicMessageContentModifyModel: properties: benefit: description: 活动利益点,图文类型ctype为activity类型时才需要传,最多10个字符 example: 满**减** type: string content: description: 消息正文(支持富文本) example: 示例 type: string content_id: description: 内容id example: 20141032434dsdsada-dsadas-2e32 type: string could_comment: description: 是否允许评论 T:允许 F:不允许,默认不允许 example: T type: string cover: description: "封面图url, 尺寸为996*450,最大不超过3M,支持格式:.jpg、.png ,请先调用 图片上传接口获得图片url。" example: https://oalipay-dl-django.alicdn.com/rest/1.0/image?fileIds=xxx&zoom=xxx type: string ctype: description: "图文类型 activity: 活动图文,不填默认普通图文" example: activity type: string ext_tags: description: 关键词列表,英文逗号分隔,最多不超过5个 example: "关键,热度" type: string login_ids: description: 可预览支付宝账号列表,需要预览时才填写, 英文逗号分隔,最多不超过10个 example: "13434343432,xxx@163.com" type: string title: description: 标题 example: 标题 type: string type: object AlipayOpenPublicMessageContentModifyResponseModel: properties: content_id: description: 内容id example: 201410323232dsadjada-dsa-1234dsada type: string content_url: description: 内容详情内链url example: alipays://xxxx type: string type: object AlipayOpenPublicMessageCustomSendErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicMessageCustomSendModel: properties: articles: description: "msg_type为image-text,本参数必填。\t" items: $ref: '#/components/schemas/Article' type: array chat: description: "是否为聊天消息。枚举支持:\t*0:代表非聊天消息,消息显示在生活号主页,默认为 0。\t*1:代表是聊天消息,消息\ 显示在咨询反馈列表页。" example: "0" type: string event_type: description: 触发消息的事件类型,默认为空。代表商户未改造。如果是follow,代表关注消息。click代表菜单点击,enter_ppchat代表进入事件;请注意事件类型的大小写 example: follow type: string msg_type: description: "消息类型。枚举支持:\t* text:表示文本消息;\t* image-text:表示图文消息。" example: text type: string open_id: description: 支付宝用户的唯一标识 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string text: $ref: '#/components/schemas/Text' to_user_id: description: 消息接收用户的userid example: "2088283746283746" type: string type: object AlipayOpenPublicMessageCustomSendResponseModel: type: object AlipayOpenPublicMessageGroupSendErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicMessageGroupSendModel: properties: articles: description: 图文消息,当 msg_type为image-text,本参数必填。 items: $ref: '#/components/schemas/Article' type: array group_id: description: "分组ID,通过alipay.open.public.group.create(用户分组创建接口)\t创建用户分组获取。" example: "10000" type: string image: $ref: '#/components/schemas/Image' msg_type: description: "消息类型。枚举支持:\t* text:表示文本消息;\t* image-text:表示图文消息。\t" example: text type: string text: $ref: '#/components/schemas/Text' type: object AlipayOpenPublicMessageGroupSendResponseModel: properties: message_id: description: 2013121100055554f1000b64-3f05-4581-a5e1-16e29d242950 example: 消息ID type: string type: object AlipayOpenPublicMessageLabelSendErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicMessageLabelSendModel: properties: filter: $ref: '#/components/schemas/Filter' material: $ref: '#/components/schemas/Material' type: object AlipayOpenPublicMessageLabelSendResponseModel: type: object AlipayOpenPublicMessageSingleSendErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicMessageSingleSendModel: properties: template: $ref: '#/components/schemas/Template' to_open_id: description: 支付宝openId,用于支付宝用户在当前应用下的用户标识。 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string to_user_id: description: 消息接收用户的支付宝用户id,用户在支付宝的唯一标识,以 2088 开头的 16 位纯数字组成。 example: "2088202882050410" type: string type: object AlipayOpenPublicMessageSingleSendResponseModel: type: object AlipayOpenPublicMessageTotalSendErrorResponseModel: properties: code: description: 错误码 enum: - MSG_TYPE_ILLEGAL - OPEN_ID_IS_ILLEGAL - ILLEGAL_ARGUMENT_PARAMS - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicMessageTotalSendModel: properties: articles: description: "图文消息,当 msg_type为image-text,本参数必填。\t" items: $ref: '#/components/schemas/Article' type: array msg_type: description: "消息类型。枚举支持:\t* text:表示文本消息;\t* image-text:表示图文消息。" example: text type: string text: $ref: '#/components/schemas/Text' type: object AlipayOpenPublicMessageTotalSendResponseModel: properties: message_id: description: 消息ID example: 2013121100055554f1000b64-3f05-4581-a5e1-16e29d242950 type: string type: object AlipayOpenPublicPayeeBindCreateErrorResponseModel: properties: code: description: 错误码 enum: - AYEEBIND_USER_INVALID - PAYEEBIND_APP_INVALID - PAYEEBIND_NOT_SAME_SUBJECT - PAYEEBIND_LOGIN_ID_HAS_BIND - PAYEEBIND_COUNT_OVER - PARAM_NOT_ALLOW_COEXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicPayeeBindCreateModel: properties: login_id: description: 收款账号,需要绑定的收款支付宝账号,请勿与 pid 同时传入。 example: "13429393030" type: string pid: description: 支付宝用户id,2088开头的16位长度字符串,请勿与 login_id 同时传入。 example: "2088344343289143" type: string type: object AlipayOpenPublicPayeeBindCreateResponseModel: type: object AlipayOpenPublicPayeeBindDeleteErrorResponseModel: properties: code: description: 错误码 enum: - PAYEEBIND_BIND_NOT_EXIST - PARAM_NOT_ALLOW_COEXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicPayeeBindDeleteResponseModel: type: object AlipayOpenPublicPersonalizedExtensionBatchqueryErrorResponseModel: properties: code: description: 错误码 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicPersonalizedExtensionBatchqueryResponseModel: properties: count: description: 扩展区套数 example: 10 type: integer extensions: description: 扩展区信息 items: $ref: '#/components/schemas/QueryExtension' type: array type: object AlipayOpenPublicPersonalizedExtensionCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicPersonalizedExtensionCreateModel: properties: areas: description: 扩展区列表,最大条数为3 items: $ref: '#/components/schemas/ExtensionArea' type: array label_rule: description: 标签规则,目前限定只能传入1条,在扩展区上线后,满足该标签规则的用户进入生活号首页,将看到该套扩展区。生成标签及打标详情参见标签管理。 items: $ref: '#/components/schemas/LabelRule' type: array type: object AlipayOpenPublicPersonalizedExtensionCreateResponseModel: properties: extension_key: description: 扩展区套id。创建个性化扩展区成功后,支付宝会将该字段返回,后续扩展区上下线或者扩展区删除都会用到这个值。 example: "10000" type: string type: object AlipayOpenPublicPersonalizedExtensionDeleteErrorResponseModel: properties: code: description: 错误码 enum: - EXTENSION_KEY_IS_EMPTY type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicPersonalizedExtensionDeleteResponseModel: type: object AlipayOpenPublicPersonalizedMenuCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicPersonalizedMenuCreateModel: properties: button: description: "一级菜单列表。说明:\t* 如果是文本菜单,最多有4个一级菜单,若开发者在后台打开了\"咨询反馈\"的开关,则只能有\ 3个一级菜单。\t* 如果是 ICON 菜单信息,最多有80个一级菜单(忽略二级菜单)。" items: $ref: '#/components/schemas/ButtonObject' type: array group_id: description: "人群分组id。分组创建及管理接入详情参见 分组管理。\t注意:group_id 与 label_rule(标签规则)不能同时为空。" example: RQ20190917100100000001 type: string label_rule: description: "标签规则,目前限定只能传入1条,在个性化菜单创建成功后,满足该标签规则的用户进入生活号首页,将看到该套菜单。生成标签\ 及打标详情参见标签管理。\ \t注意:group_id(人群分组id) 与 label_rule 不能同时为空。" items: $ref: '#/components/schemas/LabelRule' type: array mobile_client_type: description: "手机客户端类型,枚举支持:\t*iphone;\t*android;\t*wp;\t说明:不填为不区分机型。" example: android type: string type: description: "菜单类型,不填时默认为 text(文本型菜单)。枚举值如下:\t* text:文本型菜单。\t* icon:表示 icon\ \ 型菜单,当传值为\"icon\"时,菜单节点的icon字段必传。" example: text type: string type: object AlipayOpenPublicPersonalizedMenuCreateResponseModel: properties: menu_key: description: 该套个性化菜单key example: "100000" type: string type: object AlipayOpenPublicPersonalizedMenuDeleteErrorResponseModel: properties: code: description: 错误码 enum: - ILLEGAL_BIZ_PARAMS - MENU_KEY_IS_EMPTY - MENU_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicPersonalizedMenuDeleteResponseModel: type: object AlipayOpenPublicQrcodeCreateErrorResponseModel: properties: code: description: 错误码 enum: - PARSE_XML_JSON_ERROR - ILLEGAL_BIZ_PARAMS - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicQrcodeCreateModel: properties: code_info: $ref: '#/components/schemas/CodeInfo' code_type: description: "二维码类型,目前只支持两种类型:\r\tTEMP:临时的(默认);\r\tPERM:永久的" example: TEMP type: string expire_second: description: "临时码过期时间,以秒为单位,最大不超过1800秒;\r\t永久码置空" example: "1000" type: string show_logo: description: 二维码中间是否显示服务窗logo,Y:显示;N:不显示(默认) example: "N" type: string type: object AlipayOpenPublicQrcodeCreateResponseModel: properties: code_img: description: 二维码图片地址,可跳转到实际图片 example: https://mobilecodec.alipay.com/show.htm?code=ppx086640jutnzjgx5ghxf7&picSize=M type: string expire_second: description: 二维码有效时间,单位(秒)。永久码暂时忽略该信息 example: "1800" type: string type: object AlipayOpenPublicSettingCategoryQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicSettingCategoryQueryResponseModel: properties: primary_category: description: "已设置的一级行业分类名称。\t" example: 电子商务 type: string secondary_category: description: 已设置的二级行业分类名称。 example: 酒店 type: string type: object AlipayOpenPublicShortlinkCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicShortlinkCreateModel: properties: remark: description: 对于场景 ID 的描述,由商户自定义。 example: 门店1支付推广 type: string scene_id: description: 短链接对应的场景 ID。由商户自定义,仅支持数字、字母及下划线。 example: store_pay_01 type: string type: object AlipayOpenPublicShortlinkCreateResponseModel: properties: shortlink: description: 生成的带参推广短链接 example: http://t.alipay.com/I/Ev62jVRm type: string type: object AlipayOpenPublicSinglearticleDataBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - ILLEGAL_BIZ_PARAMS - SYSTEM_ERROR - BUSINESS_ERROR - QUERY_DATE_INVALID type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicSinglearticleDataBatchqueryModel: properties: begin_date: description: 数据开始日期,时间格式为 "yyyyMMdd" 。 example: "20171101" type: string end_date: description: 数据结束日期,时间格式为"yyyyMMdd"。查询数据开始日期/结束日期时间跨度最大30天。 example: "20171108" type: string type: object AlipayOpenPublicSinglearticleDataBatchqueryResponseModel: properties: data_list: description: 单篇文章分析数据列表 items: $ref: '#/components/schemas/SingleArticleAnalysisData' type: array type: object AlipayOpenPublicTemplateMessageGetErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicTemplateMessageGetResponseModel: properties: msg_template_id: description: 消息模板id--商户领取母版后生成的唯一模板id example: 14330d60f0ab4516853a0900827cee35 type: string template: description: 模板内容 example: "{\"appId\":\"${ALIPAY.appId}\",\"createTime\":${ALIPAY.createTime},\"\ toUserId\":\"${ALIPAY.toUserId}\",\"msgType\":\"text\",\"push\":\"true\"\ }" type: string type: object AlipayOpenPublicTemplateMessageIndustryModifyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicTemplateMessageIndustryModifyModel: properties: primary_industry_code: description: 服务窗消息模板所属主行业一/二级编码,参见 查看行业信息。 example: 10001/20102 type: string primary_industry_name: description: 服务窗消息模板所属主行业一/二级名称,参见 查看行业信息。 example: IT科技/IT软件与服务 type: string secondary_industry_code: description: 服务窗消息模板所属副行业一/二级编码,参见 查看行业信息。 example: 10001/20102 type: string secondary_industry_name: description: 服务窗消息模板所属副行业一/二级名称,参见 查看行业信息。 example: IT科技/IT软件与服务 type: string type: object AlipayOpenPublicTemplateMessageIndustryModifyResponseModel: type: object AlipayOpenPublicTopicBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - BUSINESS_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicTopicBatchqueryResponseModel: properties: topic_list: description: 营销位列表 items: $ref: '#/components/schemas/Topic' type: array type: object AlipayOpenPublicTopicCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicTopicCreateModel: properties: img_url: description: "营销位图片url, 尺寸为996*450,最大不超过5M,支持格式:.jpg、.png ,请先调用 图片上传接口获得图片url。营销位需要展示头图时,必须填写该参数。" example: https://oalipay-dl-django.alicdn.com/rest/1.0/image?fileIds=xxx&zoom=xxx type: string link_type: description: 跳转类型,网页:HTTP、小程序:APP,不传默认HTTP example: HTTP type: string link_url: description: 营销位跳转地址,点击营销位头图跳到的链接url。营销位需要展示头图时,必须填写该参数。 example: https://www.alipay.com type: string sub_title: description: 营销位描述。营销位需要展示头图时,必须填写该参数。 example: 营销位描述 type: string title: description: 营销位名称 example: 营销位名称 type: string topic_items: description: 营销位内容,数量限制:大于4个,小于8个 items: $ref: '#/components/schemas/TopicItem' type: array type: object AlipayOpenPublicTopicCreateResponseModel: properties: topic_id: description: 营销位id example: "123" type: string type: object AlipayOpenPublicTopicDeleteErrorResponseModel: properties: code: description: 错误码 enum: - ILLEGAL_BIZ_PARAMS - TOPIC_ID_INVALID - TOPIC_NOT_EXISTS - SYSTEM_ERROR - BUSINESS_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicTopicDeleteResponseModel: type: object AlipayOpenPublicTopicModifyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicTopicModifyModel: properties: img_url: description: "营销位图片url, 尺寸为996*450,最大不超过5M,支持格式:.jpg、.png ,请先调用 图片上传接口获得图片url。营销位需要展示头图时,必须填写该参数。" example: https://oalipay-dl-django.alicdn.com/rest/1.0/image?fileIds=xxx&zoom=xxx type: string link_type: description: 跳转类型,网页:HTTP、小程序:APP,不传默认HTTP example: HTTP type: string link_url: description: 营销位跳转地址,点击营销位头图跳到的链接url。营销位需要展示头图时,必须填写该参数。 example: https://www.alipay.com type: string sub_title: description: 营销位描述。营销位需要展示头图时,必须填写该参数 example: 营销位描述 type: string title: description: 营销位名称 example: 营销位名称 type: string topic_id: description: 营销位id example: "123" type: string topic_items: $ref: '#/components/schemas/TopicItem' type: object AlipayOpenPublicTopicModifyResponseModel: type: object AlipayOpenPublicUserDataBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - ILLEGAL_BIZ_PARAMS - SYSTEM_ERROR - BUSINESS_ERROR - QUERY_DATE_INVALID type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicUserDataBatchqueryModel: properties: begin_date: description: "数据开始日期,时间格式为 \"yyyyMMdd\" 。\t" example: "20171101" type: string end_date: description: 数据结束日期,时间格式为"yyyyMMdd"。查询数据开始日期/结束日期时间跨度最大30天。 example: "20171108" type: string type: object AlipayOpenPublicUserDataBatchqueryResponseModel: properties: data_list: description: 用户分析数据 items: $ref: '#/components/schemas/UserAnalysisData' type: array type: object AlipayOpenPublicUserFollowQueryErrorResponseModel: properties: code: description: 错误码 enum: - ILLEGAL_BIZ_PARAMS - SYSTEM_ERROR - BUSINESS_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenPublicUserFollowQueryResponseModel: properties: is_follow: description: "用户是否关注。枚举值如下:\t*T:代表已关注。\t*F:代表未关注。" example: T type: string type: object AlipayOpenSearchAbilityBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - BIZ_ERROR - SYSTEM_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchAbilityBatchqueryModel: properties: biz_data: $ref: '#/components/schemas/SearchOperPageQueryRequest' biz_type: description: 表示修改内容的业务类型 example: SEARCH_ABILITY_BATCH_QUERY type: string opt_type: description: 进行具体操作的类型比如:query example: query type: string type: object AlipayOpenSearchAbilityBatchqueryResponseModel: properties: data: $ref: '#/components/schemas/AbilityPageQueryDTO' type: object AlipayOpenSearchAppkeywordApplyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchAppkeywordApplyModel: properties: config_id: description: 关键词配置id,由支付宝生成,关键词申请通过后会通知接口返回,也可以申请单状态获取 example: "20221108000000245181" type: string key_words: description: 提报的关键词 example: "[\"关键词1\",\"关键词2\"]" items: type: string type: array target_appid: description: 小程序id example: "2021001120654127" type: string type: object AlipayOpenSearchAppkeywordApplyResponseModel: properties: apply_no: description: 提报之后的后台审核工单的id example: "20220524000000113288" type: string type: object AlipayOpenSearchAppkeywordBatchqueryErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchAppkeywordBatchqueryResponseModel: properties: key_word_info: description: 审核通过关键词明细 items: $ref: '#/components/schemas/KeyWordInfo' type: array page_number: description: 第几页 example: 1 type: integer page_size: description: 每页条数 example: 10 type: integer total_count: description: 总条数 example: 1234 type: integer total_page_count: description: 总页数 example: 123 type: integer type: object AlipayOpenSearchAppkeywordDeleteErrorResponseModel: properties: code: description: 错误码 enum: - NO_PERMISSION - APP_NOT_ONLINE - MINI_APP_CAN_NOT_SEARCH - SYSTEM_ERROR - INVALID_PARAMETER - INVALID_STATUS - SYSTEM_BUSY type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchAppkeywordDeleteModel: properties: config_id: description: 关键词配置ID example: "20220513000000165607" type: string key_words: description: 需要删除的生效关键词 example: "[\"关键词1\",\"关键词2\"]" items: type: string type: array target_appid: description: 小程序id example: "2021001120654127" type: string type: object AlipayOpenSearchAppkeywordDeleteResponseModel: type: object AlipayOpenSearchAppkeywordQuerystatusErrorResponseModel: properties: code: description: 错误码 enum: - NO_PERMISSION - APP_NOT_ONLINE - MINI_APP_CAN_NOT_SEARCH - SYSTEM_ERROR - INVALID_PARAMETER - OPERATE_TOO_FAST - SYSTEM_BUSY type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchAppkeywordQuerystatusResponseModel: properties: key_words: description: 关键词工单审核状态返回值 items: $ref: '#/components/schemas/KeyWordInfo' type: array type: object AlipayOpenSearchAppkeywordquotaQueryErrorResponseModel: properties: code: description: 错误码 enum: - NO_PERMISSION - APP_NOT_ONLINE - MINI_APP_CAN_NOT_SEARCH - SYSTEM_ERROR - INVALID_PARAMETER - OPERATE_TOO_FAST - SYSTEM_BUSY type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchAppkeywordquotaQueryResponseModel: properties: quota_num: description: 剩余可配置额度数量,返回具体数字 example: "1" type: string type: object AlipayOpenSearchBaseorderModifyErrorResponseModel: properties: code: description: 错误码 enum: - BIZ_ERROR - SYSTEM_ERROR - INVALID_PARAMETER - SYSTEM_BUSY - NOT_ALLOWED_OPERATE - SEARCH_KEYWORD_CONFIG_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchBaseorderModifyModel: properties: biz_data: $ref: '#/components/schemas/SearchBaseOrderCreateApiRequest' biz_type: description: 表示修改内容的业务类型 example: SEARCH_ORDER_CREATE type: string opt_type: description: 操作的具体类型 example: set type: string type: object AlipayOpenSearchBaseorderModifyResponseModel: properties: apply_id: description: 工单id example: 23343434******** type: string type: object AlipayOpenSearchBoxApplyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchBoxApplyModel: properties: area_keywords: description: 小程序直达配置的常用服务中带有门店信息时,可添加简称触发词 example: "[\"简称触发词\"]" items: type: string type: array box_desc: description: "品牌介绍,5-15个中文字符。\t小程序直达不支持设置此项" example: 品牌介绍 type: string brand_id: description: 品牌id,参考 品牌认证说明 example: "1000467882" type: string business_benefit_switch: description: 可通过配置来开启商圈权益模块,关闭后搜索直达不展示商圈权益模块 example: true type: boolean business_district_ids: description: 小程序已关联商圈时,可添加商圈id(目前仅对品牌直达开放,小程序直达暂未开放) example: "[\"商圈id\"]" items: type: string type: array custom_keywords: description: "自定义触发词,最多可配置6个,限1-8个中文字符。\t小程序直达不支持设置此项" example: "[\"自定义触发词\"]" items: type: string type: array image_id: description: "氛围图片id,调用 支付宝文件上传接口 上传图片获取图片id(bizCode:search_box_atmosphere)。 图片规范 \t小程序直达不支持设置此项。" example: A*oZQmT4xTBPUAAAAAAAAAAAAAAQAAAQ type: string image_name: description: "氛围图片名。\t小程序直达不支持设置此项" example: 氛围图1 type: string merchant_id: description: 商户id,代运营模式下传入。代运营模式,需要服务商已获得商家"运营支付宝小程序"授权。 example: 2088xxxxxxxxxxxx type: string related_accounts: description: 关联账号信息,1-3个。 内部字段均需设置。当为品牌直达时,数组中的第1个账号会被设置为"账号1",也就是将作为搜索直达专区头部的跳转地址 items: $ref: '#/components/schemas/SearchBoxAppInfo' type: array service_infos: description: '"服务信息,服务必须审核通过才能申请搜索直达。品牌直达最多可配置同一品牌认证下的小程序4个,小程序直达最多可配置2个。 内部字段均需设置。"' items: $ref: '#/components/schemas/SearchBoxServiceInfo' type: array target_appid: description: 小程序id,小程序直达时必传,需要和申请的商户主体保持一致,且符合 准入类目 example: "2018092561507369" type: string type: object AlipayOpenSearchBoxApplyResponseModel: properties: box_id: description: 搜索直达配置id example: "20220117000000112680" type: string type: object AlipayOpenSearchBoxBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - INPUT_ARGUMENT_NULL - INPUT_ARGUMENT_ILLEGAL - ISV_NOT_AUTH - NO_PERMISSION - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchBoxBatchqueryModel: properties: merchant_id: description: 商户id,代运营模式下传入。代运营模式,需要服务商已获得商家"运营支付宝小程序"授权。 example: 2088xxxxxxxxxxxx type: string page_number: description: "分页查询的当前页号,从1开始" example: 1 type: integer page_size: description: 每页查询的数量,默认10,不得超过50 example: 10 type: integer type: object AlipayOpenSearchBoxBatchqueryResponseModel: properties: box_infos: description: 搜索直达基础信息 items: $ref: '#/components/schemas/SearchBoxBasicInfo' type: array page_number: description: 当前页码 example: 1 type: integer page_size: description: 每页记录数 example: 10 type: integer total_count: description: 总记录数 example: 100 type: integer total_page_count: description: 总页数 example: 5 type: integer type: object AlipayOpenSearchBoxConsultErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - ISV_NOT_AUTH - INPUT_ARGUMENT_ILLEGAL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchBoxConsultModel: properties: area_keywords: description: 小程序直达配置的常用服务中带有门店信息时,可添加简称触发词 example: 简称触发词 type: string box_desc: description: "品牌介绍,5-15个中文字符。 \t小程序直达不支持设置此项" example: 品牌介绍 type: string brand_id: description: 品牌id,参考品牌认证说明 example: "1000467882" type: string business_benefit_switch: description: 可通过配置来开启商圈权益模块,关闭后搜索直达不展示商圈权益模块 example: true type: boolean business_district_ids: description: 小程序已关联商圈时,可添加商圈id(目前仅对品牌直达开放,小程序直达暂未开放) example: "[\"商圈id\"]" items: type: string type: array custom_keywords: description: "自定义触发词,最多可配置6个,限1-8个中文字符。 \t小程序直达不支持设置此项" example: "[\"自定义触发词\"]" items: type: string type: array image_id: description: "氛围图片id,调用 支付宝文件上传接口 上传图片获取图片id(bizCode:search_box_atmosphere)。 图片规范 \t小程序直达不支持设置此项。" example: A*oZQmT4xTBPUAAAAAAAAAAAAAAQAAAQ type: string image_name: description: "氛围图片名。 \t小程序直达不支持设置此项" example: 氛围图1 type: string merchant_id: description: 商户id,代运营模式下传入。代运营模式,需要服务商已获得商家"运营支付宝小程序"授权。 example: 2088xxxxxxxxxxxx type: string related_accounts: description: 关联账号信息,1-2个。 内部字段均需设置。 items: $ref: '#/components/schemas/SearchBoxAppInfo' type: array service_infos: description: 服务信息,服务必须审核通过才能申请搜索直达。 内部字段均需设置。 items: $ref: '#/components/schemas/SearchBoxServiceInfo' type: array target_appid: description: 小程序id,小程序直达时必传,需要和申请的商户主体保持一致,且符合准入类目 example: 2018092561XXXXXX type: string type: object AlipayOpenSearchBoxConsultResponseModel: properties: access: description: 是否准入,false代表不准入 example: true type: boolean not_pass_items: description: 不准入项列表。不准入项用字符串描述,可参照接口文档和准入条件,进行调整以达到申请要求 example: "[\"小程序未设置搜索可见\"]" items: type: string type: array type: object AlipayOpenSearchBoxModifyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchBoxModifyModel: properties: area_keywords: description: 小程序直达配置的常用服务中带有门店信息时,可添加简称触发词 example: "[\"简称触发词\"]" items: type: string type: array box_desc: description: "品牌介绍,5-15个中文字符。当修改品牌介绍模块(module_type=BOX_EXCLUSIVE_BASE)时传\ 入。\t小程序直达时不支持设置" example: 品牌介绍 type: string box_id: description: 搜索直达配置id example: "20220308000000128693" type: string brand_id: description: 品牌id,参考 品牌认证说明 example: "1000467882" type: string business_benefit_switch: description: 可通过配置来开启商圈权益模块,关闭后搜索直达不展示商圈权益模块 example: false type: boolean business_district_ids: description: 小程序已关联商圈时,可添加商圈id(目前仅对品牌直达开放,小程序直达暂未开放) example: "[\"商圈id\"]" items: type: string type: array custom_keywords: description: "1024" example: 自定义触发词 type: string image_id: description: "氛围图片id,调用 支付宝文件上传接口 上传图片获取图片id(bizCode:search_box_atmosphere)。 图片规范 \t小程序直达不支持设置此项。" example: A*oZQmT4xTBPUAAAAAAAAAAAAAAQAAAQ type: string image_name: description: "氛围图片名,当修改氛围图模块(module_type=BOX_ATMOSPHERE_IMAGE)时传入。\t小程序直\ 达不支持设置" example: 搜索直达氛围图1 type: string merchant_id: description: 商户id,代运营模式下传入。代运营模式,需要服务商已获得商家"运营支付宝小程序"授权。 example: 2088xxxxxxxxxxxx type: string module_id: description: 搜索直达模块配置id,新增模块时可不传,更新模块时必传。从alipay.open.search.box.query详情接口查询可获取已存在模块的配置id example: "20220308000000168465" type: string module_type: description: 搜索直达模块类型,参考 搜索直达模块说明 。 example: BOX_EXCLUSIVE_KEYWORD type: string related_accounts: description: '"关联账号信息,可配置1-2个。传入账号需归属于商家主体。品牌直达修改官方账号(module_type=BOX_EXCLUSIVE_ACCOUNTS)时传入,小程序直达修改常用服务模块时也需传值。 当为品牌直达时,数组中的第1个账号会被设置为"账号1",也就是将作为搜索直达专区头部的跳转地址。"' items: $ref: '#/components/schemas/SearchBoxAppInfo' type: array service_infos: description: 服务信息,服务必须审核通过才能申请搜索直达,可配置1-4个。当修改常用服务模块(module_type=BOX_EXCLUSIVE_FUNCTIONS)时传入 items: $ref: '#/components/schemas/SearchBoxServiceInfo' type: array target_appid: description: 小程序id,小程序直达时必传,需要和申请的商户主体保持一致,且符合 准入类目 example: "2018092561507369" type: string type: object AlipayOpenSearchBoxModifyResponseModel: properties: module_id: description: 模块配置ID example: "20220116000000130147" type: string type: object AlipayOpenSearchBoxOfflineErrorResponseModel: properties: code: description: 错误码 enum: - INPUT_ARGUMENT_ILLEGAL - INPUT_ARGUMENT_NULL - ISV_NOT_AUTH - NO_PERMISSION - RELATED_ACCOUNT_NO_TINY_APP - SYSTEM_ERROR - STATUS_NOT_ALLOWED_OPERATE type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchBoxOfflineModel: properties: box_id: description: 搜索直达配置id example: "20211130000000100415" type: string merchant_id: description: 商户id,代运营模式下传入。代运营模式,需要服务商已获得商家"运营支付宝小程序"授权。 example: 2088xxxxxxxxxxxx type: string type: object AlipayOpenSearchBoxOfflineResponseModel: type: object AlipayOpenSearchBoxOnlineErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchBoxOnlineModel: properties: box_id: description: 搜索直达配置id example: "20211130000000100415" type: string merchant_id: description: 商户id,代运营模式下传入。代运营模式,需要服务商已获得商家"运营支付宝小程序"授权。 example: 2088xxxxxxxxxxxx type: string type: object AlipayOpenSearchBoxOnlineResponseModel: type: object AlipayOpenSearchBoxQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - NO_PERMISSION - SYSTEM_ERROR - ISV_NOT_AUTH - INPUT_ARGUMENT_ILLEGAL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchBoxQueryResponseModel: properties: account_module: $ref: '#/components/schemas/SearchBoxAccountModule' area_keyword_module: $ref: '#/components/schemas/SearchBoxAreaKeyWordModule' basic_info_module: $ref: '#/components/schemas/SearchBoxBasicInfoModule' box_id: description: 搜索直达配置id example: "20220308000000128693" type: string box_status: description: 搜索直达配置状态,AUDIT-审核中/ONLINE-已上架/REJECT-驳回/OFFLINE-已下架 example: ONLINE type: string business_district_module: $ref: '#/components/schemas/BoxBusinessDistrictModule' default_keywords: description: 搜索直达默认触发词,由系统生成,无法修改 example: "[\"默认触发词\"]" items: type: string type: array 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' type: object AlipayOpenSearchBoxactivityApplyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchBoxactivityApplyModel: properties: action_url: description: 活动链接,必须为关联的小程序的页面链接(链接以 alipays 开头),可参考 小程序scheme链接介绍 example: alipays://platformapi/startapp?appId=2021001198637195&pages/kaq_maid/kaq_maid type: string background_word: description: 创建banner活动时,可添加底纹推广词,有机会在首页搜索框内展示,提升banner活动曝光机会 example: 搜索底纹推广词 type: string box_id: description: 搜索直达配置id example: "20211130000000100415" type: string end_time: description: 活动结束时间,开始和结束时间之间不得超过90天 example: 2022-09-30 23:59:59 type: string material_id: description: 当material_type="IMAGE"时,为图片id;当material_type="VIDEO"时,为视频id。小程序直达仅支持图片类型。图片id可以通过调用 支付宝文件上传接口 上传图片,获取图片id(bizCode:search_box_banner)。 图片规范 example: A*oZQmT4xTBPUAAAAAAAAAAAAAAQAAAQ type: string material_type: description: IMAGE-图片/VIDEO-视频 example: IMAGE type: string merchant_id: description: 商户id,代运营模式下传入。代运营模式,需要服务商已获得商家"运营支付宝小程序"授权。 example: 2088xxxxxxxxxxxx type: string start_time: description: 活动开始时间,开始和结束时间之间不得超过90天 example: 2022-02-10 08:00:00 type: string target_appid: description: 跳转应用ID example: "2021001191699651" type: string target_appname: description: 跳转小程序名称 example: 目标小程序名 type: string target_regions: description: 投放目标区域列表 items: $ref: '#/components/schemas/DeliveryTargetRegion' type: array title: description: 活动标题 example: 活动标题 type: string video_info: $ref: '#/components/schemas/SearchBoxActivityVideoInfo' type: object AlipayOpenSearchBoxactivityApplyResponseModel: properties: box_activity_id: description: 搜索直达活动ID example: "20211223000000100000" type: string type: object AlipayOpenSearchBoxactivityBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - INPUT_ARGUMENT_ILLEGAL - INPUT_ARGUMENT_NULL - ISV_NOT_AUTH - NO_PERMISSION - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchBoxactivityBatchqueryModel: properties: box_id: description: 搜索直达id example: "20211130000000100415" type: string merchant_id: description: 商户id,代运营模式下传入。代运营模式,需要服务商已获得商家"运营支付宝小程序"授权。 example: 2088xxxxxxxxxxxx type: string page_number: description: "分页查询的当前页号,从1开始" example: 1 type: integer page_size: description: 每页查询的数量,默认10,不超过50 example: 10 type: integer type: object AlipayOpenSearchBoxactivityBatchqueryResponseModel: properties: models: description: 活动明细列表 items: $ref: '#/components/schemas/SearchBoxActivity' type: array page_number: description: 当前页码 example: "1" type: string page_size: description: 每页记录数 example: "10" type: string total_count: description: 总记录数 example: 100 type: integer total_page_count: description: 总页数 example: 5 type: integer type: object AlipayOpenSearchBoxactivityModifyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchBoxactivityModifyModel: properties: action_url: description: 活动链接,必须为关联的小程序的页面链接(链接以 alipays 开头),可参考 小程序scheme链接介绍 example: alipays://platformapi/startapp?appId=2021001198637195&pages/kaq_maid/kaq_maid type: string background_word: description: 创建banner活动时,可添加底纹推广词,有机会在首页搜索框内展示,提升banner活动曝光机会 example: 搜索底纹推广词 type: string box_activity_id: description: 搜索直达活动id example: "20211223000000100000" type: string end_time: description: 活动结束时间,开始时间和结束时间之间不能超过90天 example: 2022-09-30 23:59:59 type: string material_id: description: 当material_type="IMAGE"时,为图片id;当material_type="VIDEO"时,为视频id。图片id可以通过调用接口alipay.open.file.upload上传图片,获取图片id(bizCode:search_box_banner)。规范详情可查看 图片规范 。 example: 20211206OB020010034807196034 type: string material_type: description: IMAGE-图片/VIDEO-视频 example: IMAGE type: string merchant_id: description: 商户id,代运营模式下传入。代运营模式,需要服务商已获得商家"运营支付宝小程序"授权。 example: 2088xxxxxxxxxxxx type: string start_time: description: 活动开始时间,开始时间和结束时间之间不能超过90天 example: 2022-02-10 08:00:00 type: string target_appid: description: 跳转应用ID example: "2021001191699651" type: string target_appname: description: 目标小程序名称 example: 目标小程序名 type: string target_regions: description: 投放目标区域列表 items: $ref: '#/components/schemas/DeliveryTargetRegion' type: array title: description: 活动标题 example: 活动标题 type: string video_info: $ref: '#/components/schemas/SearchBoxActivityVideoInfo' type: object AlipayOpenSearchBoxactivityModifyResponseModel: type: object AlipayOpenSearchBoxactivityOfflineErrorResponseModel: properties: code: description: 错误码 enum: - INPUT_ARGUMENT_ILLEGAL - INPUT_ARGUMENT_NULL - NO_PERMISSION - STATUS_NOT_ALLOWED_OPERATE - SYSTEM_ERROR - ISV_NOT_AUTH type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchBoxactivityOfflineModel: properties: box_activity_id: description: 搜索直达活动id example: "20211223000000100000" type: string merchant_id: description: 商户id,代运营模式下传入。代运营模式,需要服务商已获得商家"运营支付宝小程序"授权。 example: 2088xxxxxxxxxxxx type: string type: object AlipayOpenSearchBoxactivityOfflineResponseModel: type: object AlipayOpenSearchBoxactivityQueryErrorResponseModel: properties: code: description: 错误码 enum: - INPUT_ARGUMENT_ILLEGAL - INPUT_ARGUMENT_NULL - ISV_NOT_AUTH - NO_PERMISSION - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchBoxactivityQueryResponseModel: properties: background_word: description: 底纹词 example: 底纹词 type: string background_word_info: $ref: '#/components/schemas/BackgroundWordInfo' box_activity_id: description: 搜索直达活动id example: "20211223000000100000" type: string box_id: description: 搜索直达id example: "20211130000000100415" type: string end_time: description: 活动结束时间 example: 2022-09-30 23:59:59 type: string fail_reason: description: 审核失败原因 example: 审核失败原因 type: string gmt_modified: description: 更新时间 example: 2022-02-10 08:00:00 type: string material_type: description: IMAGE-图片/VIDEO-视频 example: IMAGE type: string material_url: description: 当material_type="IMAGE"时,为图片url;当material_type="VIDEO"时,为视频url example: http://mdn.alipayobjects.com/mrch_spc/afts/img/A*0XA2Qo_omj4AAAAAAAAAAAAADsF1AQ/original type: string run_status: description: 运行状态,INITIAL-初始/ONLINE-已上架/EXPIRE-已失效/OFFLINE-已下架 example: ONLINE type: string start_time: description: 活动开始时间 example: 2022-02-10 08:00:00 type: string status: description: 配置状态,INITIAL-初始/AUDIT-审核中/CANCEL-已取消/ONLINE-已上架/REJECT-驳回/OFFLINE-已下架/EXPIRE-已失效 example: AUDIT type: string target_appid: description: 跳转应用ID example: "2021001191699651" type: string target_appname: description: 模板名称 example: 目标小程序名 type: string target_regions: description: 投放目标区域 items: $ref: '#/components/schemas/DeliveryTargetRegion' type: array title: description: 活动标题 example: 活动标题 type: string video_info: $ref: '#/components/schemas/SearchBoxActivityVideoInfo' type: object AlipayOpenSearchOrderdetailQueryErrorResponseModel: properties: code: description: 错误码 enum: - BIZ_ERROR - INVALID_PARAMETER - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchOrderdetailQueryModel: properties: biz_data: $ref: '#/components/schemas/SearchOrderRequest' biz_type: description: 表示修改内容的业务类型 example: SEARCH_ORDER_DETAIL_QUERY type: string opt_type: description: 进行具体操作的类型比如:create、mod、cancel example: query type: string type: object AlipayOpenSearchOrderdetailQueryResponseModel: properties: data: $ref: '#/components/schemas/SearchOrderDetailData' type: object AlipayOpenSearchServiceorderBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - BIZ_ERROR - INVALID_PARAMETER - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchServiceorderBatchqueryModel: properties: biz_data: $ref: '#/components/schemas/SearchApplyPageQueryRequest' biz_type: description: 表示查询内容的类型 example: SEARCH_ORDER_BATCH_QUERY type: string opt_type: description: 操作的类型,如query example: query type: string type: object AlipayOpenSearchServiceorderBatchqueryResponseModel: properties: data: $ref: '#/components/schemas/OrderPageQueryDTO' type: object AlipayOpenSearchSubservicekeywordApplyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchSubservicekeywordApplyModel: properties: config_id: description: 关键词配置id,由支付宝生成,关键词申请通过后会通知接口返回,也可以申请单状态获取 example: "20221108000000245181" type: string key_words: description: 服务关键词列表,每批最多传入30个,关键词长度小于12个汉字。 超过数量限制会申请失败,剩余关键词可通过 alipay.open.search.appkeywordquota.query查询 example: "[\"a\",\"b\"]" items: type: string type: array sub_service_code: description: 子服务code,提报服务关键词,alipay.open.app.service.list.query(服务批量查询)这个接口可以获取 example: "2020071621000604578858" type: string target_appid: description: 小程序id example: "2021001112626071" type: string type: object AlipayOpenSearchSubservicekeywordApplyResponseModel: properties: apply_no: description: 审核工单id,唯一,提报服务关键词,提报服务关键词返回该id example: "20220524000000113287" type: string type: object AlipayOpenSearchSubservicekeywordBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - UN_SUPPORT_SEARCH_BOX_STATUS - NO_PERMISSION - INVALID_PARAMETER - SYSTEM_ERROR - SYSTEM_BUSY type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchSubservicekeywordBatchqueryResponseModel: properties: page_number: description: 第几页 example: 1 type: integer page_size: description: 每页条数 example: 2 type: integer subservice_keyword_info: description: 关键词明细 items: $ref: '#/components/schemas/SubServiceKeyWordInfo' type: array total_count: description: 总条数 example: 12 type: integer total_page_count: description: 总页数 example: 6 type: integer type: object AlipayOpenSearchSubservicekeywordDeleteErrorResponseModel: properties: code: description: 错误码 enum: - NO_PERMISSION - APP_NOT_ONLINE - MINI_APP_CAN_NOT_SEARCH - SYSTEM_ERROR - INVALID_PARAMETER - OPERATE_TOO_FAST - INVALID_STATUS - SYSTEM_BUSY type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchSubservicekeywordDeleteModel: properties: config_id: description: 关键词配置ID example: "20220513000000165607" type: string target_appid: description: 小程序id example: "2021001112626071" type: string type: object AlipayOpenSearchSubservicekeywordDeleteResponseModel: type: object AlipayOpenSearchSubservicekeywordQuerystatusErrorResponseModel: properties: code: description: 错误码 enum: - NO_PERMISSION - APP_NOT_ONLINE - MINI_APP_CAN_NOT_SEARCH - SYSTEM_ERROR - INVALID_PARAMETER - OPERATE_TOO_FAST - SYSTEM_BUSY type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSearchSubservicekeywordQuerystatusResponseModel: properties: key_words: description: 关键词工单审核状态返回值 items: $ref: '#/components/schemas/KeyWordInfo' type: array type: object AlipayOpenServicemarketCommodityShopOfflineErrorResponseModel: properties: code: description: 错误码 enum: - PARAMS_ERROR - NO_PERMISSION_OFFLINE_SHOP - COMMODITY_SHOP_NOT_EXIST - SYSTEM_ERROR - SHOP_STATUS_NOT_SUPPORT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenServicemarketCommodityShopOfflineModel: properties: commodity_id: description: 服务商户ID example: "20160010200000000033400" type: string shop_id: description: 门店ID example: "2015052000077000000000182140" type: string type: object AlipayOpenServicemarketCommodityShopOfflineResponseModel: type: object AlipayOpenServicemarketCommodityShopOnlineErrorResponseModel: properties: code: description: 错误码 enum: - NO_PERMISSION_ONLINE_SHOP - SHOP_TYPE_ALREADY_ONLINE - COMMODITY_SHOP_NOT_EXIST - PARAMS_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenServicemarketCommodityShopOnlineModel: properties: commodity_id: description: 服务插件ID example: "201511020002630060" type: string shop_id: description: 店铺ID example: "2015052000077000000000182140" type: string type: object AlipayOpenServicemarketCommodityShopOnlineResponseModel: type: object AlipayOpenServicemarketOrderAcceptErrorResponseModel: properties: code: description: 错误码 enum: - NO_PERMISSION_ACCETP_ORDER - COMMODITY_ORDER_STATUS_INVALID - ORDER_NOT_EXIST - PARAMS_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenServicemarketOrderAcceptModel: properties: commodity_order_id: description: 服务商品订单ID example: "201604060043410106" type: string type: object AlipayOpenServicemarketOrderAcceptResponseModel: type: object AlipayOpenServicemarketOrderCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenServicemarketOrderCreateModel: properties: app_category_ids: description: 11_12;12_13。小程序类目,格式为 第一个一级类目_第一个二级类目;第二个一级类目_第二个二级类目,详细类目可以参考https://docs.alipay.com/isv/10325 example: 107397_107223 type: string app_desc: description: 小程序官方示例Demo,展示已支持的接口能力及组件。 example: 小程序应用描述 type: string app_english_name: description: 小程序应用英文名称 example: demoexample type: string app_name: description: 小程序应用名称 example: 小程序示例 type: string app_origin: description: 来源的业务方,需要申请 example: AA type: string app_slogan: description: 小程序应用简介,一句话描述小程序功能 example: 提供小程序示例功能 type: string market_code: description: 订购的服务商品ID所在的市场编码。新接入场景必须传递,具体值请联系产品分配。 example: SERVICE_MAEKET type: string merchandise_id: description: 订购的服务商品ID example: I1060100001000050361 type: string merchant_pid: description: 商户PID example: "2088101118588888" type: string mini_app_id: description: 一二方支持传入appId example: "123123" type: string mini_category_ids: 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 type: string out_biz_no: description: "比如某种业务标准外部订单号,比如交易外部订单号,代表商户端自己订单号" example: "2018072600000015692246" type: string service_email: description: 小程序客服邮箱 example: example@mail.com type: string service_phone: description: 小程序客服电话 example: "13110101010" type: string type: object AlipayOpenServicemarketOrderCreateResponseModel: properties: commodity_order_id: description: 订单号 example: "2018071900000015585789" type: string mini_app_id: description: 支付宝分配给开发者的应用ID example: "2014072300007148" type: string type: object AlipayOpenServicemarketOrderItemCancelErrorResponseModel: properties: code: description: 错误码 enum: - PARAMS_ERROR - NO_PERMISSION_CANCEL_ORDER_ITEM - COMMODITY_ORDER_ITEM_NOT_EXIST - ITEM_STATUS_NOT_ALLOW type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenServicemarketOrderItemCancelModel: properties: cancel_reason: description: 当前门店区域不支持实施 example: 该门店暂无法实施完成 type: string commodity_order_id: description: 订购服务订单ID,通过支付宝发送的 服务市场商户确认订购通知 通知获取。 example: "20160010200000000033400" type: string mini_app_id: description: 商家订购服务选择的某一小程序的APPID,如果该订单为蚂蚁服务市场发布的小程序插件服务所产生的订单,则此字段必填 example: "2017121800945174" type: string shop_id: description: "商家订购服务选择的某一门店的ID。若该订单: \t为支付宝服务市场发布的服务所产生订单则该参数可选。" example: "2015052000077000000000182140" type: string type: object AlipayOpenServicemarketOrderItemCancelResponseModel: type: object AlipayOpenServicemarketOrderItemCompleteErrorResponseModel: properties: code: description: 错误码 enum: - PARAMS_ERROR - NO_PERMISSION_OPERATION - COMMODITY_ORDER_ITEM_NOT_EXIST - ITEM_STATUS_NOT_ALLOW - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenServicemarketOrderItemCompleteModel: properties: commodity_order_id: description: 订购服务插件订单号 example: "20160010200000000033400" type: string mini_app_id: description: 商家订购服务选择的某一小程序的APPID,如果该订单为蚂蚁服务市场发布的小程序插件服务所产生的订单,则此字段必填 example: "2017121800945174" type: string shop_id: description: "商家订购服务选择的某一门店的ID。若该订单:\t为支付宝服务市场发布的服务所产生订单则该参数可选。" example: "2015052000077000000000182140" type: string type: object AlipayOpenServicemarketOrderItemCompleteResponseModel: type: object AlipayOpenServicemarketOrderItemConfirmErrorResponseModel: properties: code: description: 错误码 enum: - NO_PERMISSION_COMFIRM_ORDERITEM - ITEM_STATUS_NOT_ALLOW - COMMODITY_ORDER_ITEM_NOT_EXIST - PARAMS_ERROR - SYSTEM_ERROR - CONFIRM_CHARGE_ITEM_NOT_ALLOW type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenServicemarketOrderItemConfirmModel: properties: commodity_order_id: description: 订购服务插件订单号 example: "20160010200000000033400" type: string mini_app_id: description: 商家订购服务选择的某一小程序的APPID,如果该订单为蚂蚁服务市场发布的小程序插件服务所产生的订单,则此字段必填 example: "2017121800945174" type: string shop_id: description: "商家订购服务选择的某一门店的ID。若该订单: \t为支付宝(蚂蚁)服务市场发布的服务所产生订单则该参数可选。" example: "2015052000077000000000182140" type: string type: object AlipayOpenServicemarketOrderItemConfirmResponseModel: type: object AlipayOpenServicemarketOrderNotifyErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenServicemarketOrderNotifyResponseModel: type: object AlipayOpenServicemarketOrderQueryErrorResponseModel: properties: code: description: 错误码 enum: - QUERY_FAILD - NOPERMISSION_QUERY type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenServicemarketOrderQueryResponseModel: properties: auto_upgrade: description: true:开启;false:关闭;需要同步校验commodity_id,如果没有查询到订购信息的话,忽略该字段返回值 example: true type: boolean commodity_id: description: 订购服务商品ID example: "201604290086730119" type: string current_page: description: 当前查询页(本接口支持最多查询100条记录) example: 1 type: integer order_items: description: 订单明细列表 items: $ref: '#/components/schemas/OrderItem' type: array specifications: description: 用于区分同一个服务的不同版本 example: 标准版、试用版 type: string status: description: MERCHANT_ORDED(待服务商接单) example: MERCHANT_ORDED type: string total_size: description: 总记录数 example: 1000 type: integer type: object AlipayOpenServicemarketOrderRejectErrorResponseModel: properties: code: description: 错误码 enum: - PARAMS_ERROR - NO_PERMISSION_REJECT_ORDER - ORDER_NOT_EXIST - COMMODITY_ORDER_STATUS_INVALID type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenServicemarketOrderRejectModel: properties: commodity_order_id: description: 订购服务商品订单ID example: "20160010200000000033400" type: string reject_reason: description: 拒绝接单原因 example: 暂不支持该地区服务 type: string type: object AlipayOpenServicemarketOrderRejectResponseModel: type: object AlipayOpenServicemarketPromotiontaskRelationQueryErrorResponseModel: properties: code: description: 错误码 enum: - PARAMS_ERROR - QUERY_FAILD type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenServicemarketPromotiontaskRelationQueryResponseModel: properties: current_page: description: 当前页码 example: 1 type: integer page_size: description: 每页数量 example: 10 type: integer promotion_relations: description: 推广服务商信息列表 items: $ref: '#/components/schemas/PromotionTaskRelation' type: array total_size: description: 总记录数 example: 1000 type: integer type: object AlipayOpenSpBlueseaactivityCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSpBlueseaactivityCreateModel: properties: address: description: "详细地址。\t该资质是否必传请参见报\ 名资质要求。" example: 万塘路18号黄龙时代广场B座 type: string biz_scene: 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 type: string business_lic: description: "营业执照,要求证件文本信息清晰可见,图片文件大小在 50K-5M 之间,不限制长宽,支持 png、bmp、gif、\ jpg、jpeg 格式。\t请传入alipay.open.sp.image.upload(图\ 片上传接口) 返回的 image_id。\t该资质是否必传请参见报\ 名资质要求。" example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string city_code: description: 城市编码。请按照表格 中内容填写。 (请参考资料: 统计用区划和城乡划分代码) example: "310001" type: string district_code: description: 区县编码。请按照表格 中内容填写。 (请参考资料: 统计用区划和城乡划分代码) example: "310006" type: string food_business_lic: description: "食品经营许可证,要求证件文本信息清晰可见,图片文件大小在 50K-5M 之间,不限制长宽,支持 png、bmp、gif、\ jpg、jpeg 格式。\t请传入alipay.open.sp.image.upload(图\ 片上传接口) 返回的 image_id。\t该资质是否必传请参见报\ 名资质要求。" example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string food_circulate_lic: description: "食品流通许可证,要求证件文本信息清晰可见,图片文件大小在 50K-5M 之间,不限制长宽,支持 png、bmp、gif、\ jpg、jpeg 格式。\t请传入alipay.open.sp.image.upload(图\ 片上传接口) 返回的 image_id。\t该资质是否必传请参见报\ 名资质要求。" example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string food_health_lic: description: "食品卫生许可证,要求证件文本信息清晰可见,图片文件大小在 50K-5M 之间,不限制长宽,支持 png、bmp、gif、\ jpg、jpeg 格式。\t请传入alipay.open.sp.image.upload(图\ 片上传接口) 返回的 image_id。 \t该资质是否必传请参见报\ 名资质要求。" example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string food_production_lic: description: "食品生产许可证,要求证件文本信息清晰可见,图片文件大小在 50K-5M 之间,不限制长宽,支持 png、bmp、gif、\ jpg、jpeg 格式。\t请传入alipay.open.sp.image.upload(图\ 片上传接口) 返回的 image_id。\t该资质是否必传请参见报\ 名资质要求。" example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string food_service_lic: description: "餐饮服务许可证,要求证件文本信息清晰可见,图片文件大小在 50K-5M 之间,不限制长宽,支持 png、bmp、gif、\ jpg、jpeg 格式。\t请传入alipay.open.sp.image.upload(图\ 片上传接口) 返回的 image_id。\t该资质是否必传请参见报\ 名资质要求。" example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string indoor_pic: description: "内景照,要求图片清晰可见,图片文件大小在 50K-5M 之间,不限制长宽,支持 png、bmp、gif、jpg、jpeg\ \ 格式。\t请传入alipay.open.sp.image.upload(图\ 片上传接口) 返回的 image_id。\t该资质是否必传请参见报\ 名资质要求。" example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string merchant_logon: description: 参与蓝海活动的商户支付宝账号,只有当参与直连蓝海活动场景(BLUE_SEA_FOOD_APPLY/BLUE_SEA_FMCG_APPLY)时必填,间连场景可空。 example: "13200132000" type: string province_code: description: 省份编码。请按照表格 中内容填写。 (请参考资料: 统计用区划和城乡划分代码) example: "310000" type: string shop_entrance_pic: description: "门头照,要求图片清晰可见,图片文件大小在 50K-5M 之间,不限制长宽,支持 png、bmp、gif、jpg、jpeg\ \ 格式。\t请传入alipay.open.sp.image.upload(图\ 片上传接口) 返回的 image_id。\t该资质是否必传请参见报\ 名资质要求。" example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string sub_merchant_id: description: 参与蓝海活动的间连商户账号,只有当参与间连蓝海活动场景(BLUE_SEA_FOOD_INDIRECT_APPLY/BLUE_SEA_FMCG_INDIRECT_APPLY)时必填,直连场景可空。 example: "2088100010001000" type: string tobacco_lic: description: "烟草专卖零售许可证,要求证件文本信息清晰可见,图片文件大小在 50K-5M 之间,不限制长宽,支持 png、bmp、\ gif、jpg、jpeg 格式。\t请传入alipay.open.sp.image.upload(图\ 片上传接口) 返回的 image_id。 \t该资质是否必传请参见报\ 名资质要求。" example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string type: object AlipayOpenSpBlueseaactivityCreateResponseModel: properties: order_id: description: 申请单Id example: "0581" type: string type: object AlipayOpenSpBlueseaactivityModifyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSpBlueseaactivityModifyModel: properties: address: description: 详细地址 example: 万塘路18号黄龙时代广场B座 type: string business_lic: description: 营业执照,要求证件文本信息清晰可见。 请上传照片的image_id,传参明细请参见报名资质要求 example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string city_code: description: 城市编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 (参考资料: http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/) example: "310001" type: string district_code: description: 区县编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 (参考资料: http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/) example: "310006" type: string food_business_lic: description: 食品经营许可证,要求证件文本信息清晰可见。请上传照片的image_id,传参明细请参见报名资质要求 example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string food_circulate_lic: description: 食品流通许可证,要求证件文本信息清晰可见。请上传照片的image_id,传参明细请参见报名资质要求 example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string food_health_lic: description: 食品卫生许可证,要求证件文本信息清晰可见。请上传照片的image_id,传参明细请参见报名资质要求 example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string food_production_lic: description: 食品生产许可证,要求证件文本信息清晰可见。请上传照片的image_id,传参明细请参见报名资质要求 example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string food_service_lic: description: 餐饮服务许可证,要求证件文本信息清晰可见。请上传照片的image_id,传参明细请参见报名资质要求 example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string indoor_pic: description: 门头照,要求内景照片清晰可见。请上传照片的image_id,传参明细请参见报名资质要求 example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string order_id: description: 申请单 id。通过 alipay.open.sp.blueseaactivity.create接口获取。 example: "0581" type: string province_code: description: 省份编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 (参考资料: http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/) example: "310000" type: string shop_entrance_pic: description: 门头照,要求店铺外观照片清晰可见。请上传照片的image_id,传参明细请参见报名资质要求 example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string tobacco_lic: description: 烟草专卖零售许可证,要求证件文本信息清晰可见。请上传照片的image_id,传参明细请参见报名资质要求 example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string type: object AlipayOpenSpBlueseaactivityModifyResponseModel: type: object AlipayOpenSpBlueseaactivityQueryErrorResponseModel: properties: code: description: 错误码 enum: - ILLEGAL_PARAMS - SYSTEM_ERROR - NO_PERMISSION - BLUESEA_ORDER_INVALID type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSpBlueseaactivityQueryResponseModel: properties: address: description: 详细地址 example: 万塘路18号黄龙时代广场B座 type: string biz_scene: description: 蓝海活动的场景,包括直连餐饮(BLUE_SEA_FOOD_APPLY)、直连快消(BLUE_SEA_FMCG_APPLY)、间连餐饮(BLUE_SEA_FOOD_INDIRECT_APPLY)、间连快消(BLUE_SEA_FMCG_INDIRECT_APPLY)场景 example: BLUE_SEA_FOOD_APPLY type: string business_lic: description: 营业执照,要求证件文本信息清晰可见。 资质信息请参见报名资质要求 example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string city_code: description: 城市编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 (参考资料: http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/) example: "310001" type: string district_code: description: 区县编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 (参考资料: http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/) example: "310006" type: string food_business_lic: description: 食品经营许可证,要求证件文本信息清晰可见。资质信息请参见报名资质要求 example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string food_circulate_lic: description: 食品流通许可证,要求证件文本信息清晰可见。资质信息请参见报名资质要求 example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string food_health_lic: description: 食品卫生许可证,要求证件文本信息清晰可见。资质信息请参见报名资质要求 example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string food_production_lic: description: 食品生产许可证,要求证件文本信息清晰可见。资质信息请参见报名资质要求 example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string food_service_lic: description: 餐饮服务许可证,要求证件文本信息清晰可见。资质信息请参见报名资质要求 example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string indoor_pic: description: 门头照,要求内景照片清晰可见。资质信息请参见报名资质要求 example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string memo: description: 审核驳回原因,在订单状态为失败时有效 example: 资质照片和商户名称不一致,请修改一致后,重新申请;其他原因; type: string merchant_logon: description: 参与蓝海活动的商户支付宝账号,只有当参与直连蓝海活动场景(BLUE_SEA_FOOD_APPLY/BLUE_SEA_FMCG_APPLY)时才返回 example: "13200132000" type: string province_code: description: 省份编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 (参考资料: http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/) example: "310000" type: string shop_entrance_pic: description: 门头照,要求店铺外观照片清晰可见。资质信息请参见报名资质要求 example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string status: description: 申请单状态,状态机参考(AUDITING:审核中,FAIL:报名失败,PASS:报名成功) example: AUDITING type: string sub_merchant_id: description: 参与蓝海活动的间连商户账号,只有当参与间连蓝海活动场景(BLUE_SEA_FOOD_INDIRECT_APPLY/BLUE_SEA_FMCG_INDIRECT_APPLY)时才返回 example: "2088100010001000" type: string tobacco_lic: description: 烟草专卖零售许可证,要求证件文本信息清晰可见。资质信息请参见报名资质要求 example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string type: object AlipayOpenSpImageUploadErrorResponseModel: properties: code: description: 错误码 enum: - FILE_SIZE_OUT_LIMIT - SYSTEM_ERROR - FILE_SIZE_MIN_LIMIT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSpImageUploadModel: type: object AlipayOpenSpImageUploadResponseModel: properties: image_id: description: 图片在文件存储平台的标识 example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string type: object AlipayOpenSpIsvBillSyncErrorResponseModel: properties: code: description: 错误码 enum: - BIZ_ERROR_BILL_NOT_MATCH - BIZ_ERROR_INVALID_STATUS - BIZ_ERROR_BILL_REDUPLICATE_RETURN type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSpIsvBillSyncModel: properties: end_time: description: 账单结束时间 example: 2021-11-10 type: string generate_time: description: 出账时间,回传出账信息时,必须传递 example: 2021-10-14 00:00:00 type: string item_code: description: 服务优选商品编码 example: SS010301000000001234 type: string out_biz_no: description: 外部业务号,传isv系统生成的账单号,需要保证唯一 example: "2021000000000" type: string pay_time: description: 账单支付时间,回传支付数时,必须传递 example: 2021-10-14 00:00:00 type: string price: description: 账单金额,这里填写的是整数,单位为分,比如1元,那么输入100 example: "100" type: string promotor_pid: description: 推广服务商(S2)pid example: "2088301912341234" type: string start_time: description: 账单开始时间 example: 2021-10-10 type: string status: description: GENERATE_BILL代表”已出账“,PAID_BILL代表”已支付“,选择这两者之一 example: GENERATE_BILL type: string sub_promotor_pid: description: S1回传的S2的操作员工子账号,如果是子账号操作,请回传 example: "20211011000000" type: string type: object AlipayOpenSpIsvBillSyncResponseModel: properties: success: description: 返回true或者flase,ture代表账单回传成功,false表示账单回传失败 example: true type: boolean type: object AlipayOpenSpIsvOperationSyncErrorResponseModel: properties: code: 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 - MERCHANT_PID_ILLEGAL - MINI_APP_ID_ILLEGAL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSpIsvOperationSyncModel: properties: customer_type: description: 客户类型,PERSONAL表示个人,ALIPAY_RECOMMEND表示支付宝推荐 example: PERSONAL type: string ext_info: $ref: '#/components/schemas/OperationResultExtInfo' implement_end_time: description: 实施结束时间 example: 2021-10-11 00:00:00 type: string implement_object_name: description: 实施对象名称 example: 浙江省杭州市西湖区西溪路黄焖鸡米饭 type: string implement_place: description: 实施地点 example: 浙江省杭州市西湖区蚂蚁A空间 type: string implement_result: description: 实施结果,SUCCESS表示实施成功,FAIL表示实施失败 example: SUCCESS type: string implement_result_image: description: 实施结果的照片 example: https://os.alipayobjects.com/rmsportal/JxAjrvPKriKOpjf.png type: string implement_result_remark: description: 实施结果的备注 example: 失败原因:商户取消购买 type: string implement_start_time: description: 实施开始时间 example: 2021-10-10 00:00:00 type: string item_code: description: 服务优选商品编码 example: SS010301000000001234 type: string item_price: description: 商品价格,这里填写的是整数,单位为分,比如1元,那么输入100 example: "100" type: string merchant_pid: description: 商户pid example: "2088301912341234" type: string mini_appid: description: 商品小程序appid,若推广的商品不为小程序,则不传此参数 example: "2018082861168647" type: string oppor_id: description: 拓展助手中的商机id example: "2021101809775931" type: string order_id: description: 下单订单号 example: "201811190000000000001100" type: string out_biz_no: description: 外部业务号,传isv系统生成的账单号,需要保证唯一 example: "2021000000000" type: string promotor_pid: description: 推广服务商(S2)pid example: "2088301912341234" type: string shop_id: description: 店铺id example: "2019081500502000000025130577" type: string sub_promotor_pid: description: 推广服务商(S2)子账号pid example: "2088301912341234" type: string type: object AlipayOpenSpIsvOperationSyncResponseModel: type: object AlipayOpenSpIsvRelationQueryErrorResponseModel: properties: code: description: 错误码 enum: - ILLEGAL_PARAMS - NO_PERMIT_FOR_OPERATOR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSpIsvRelationQueryResponseModel: properties: current_page: description: 当前页码 example: 1 type: integer page_size: description: 每页数量 example: 10 type: integer promotion_relations: description: 推广服务商信息列表 items: $ref: '#/components/schemas/PromotionRelationDTO' type: array total_size: description: 总记录数 example: 1000 type: integer type: object AlipayOpenSpIsvSalesSyncErrorResponseModel: properties: code: description: 错误码 enum: - OPERATION_RESULT_RELATED_FAIL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSpIsvSalesSyncModel: properties: merchant_sales_detail: description: 商户销售数据回传的参数对象,形式为一个列表,每天回传昨日商户的销售数据。 items: $ref: '#/components/schemas/IsvMerchantSalesDetailRequest' type: array type: object AlipayOpenSpIsvSalesSyncResponseModel: type: object AlipayOpenSpIsvSignauthCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSpIsvSignauthCreateModel: properties: isv_auth_scene_infos: description: 代运营授权场景信息 items: $ref: '#/components/schemas/IsvAuthSceneInfo' type: array merchant_logon_id: description: "商户登录账号\t支持手机号和邮箱账号;不支持pid" example: "13181141917" type: string need_app_auth: description: "1表示需要,0表示不需要\t不传参数默认是需要(1)\t是否创建三方应用授权子任务,也就是是否需要给三方应用授权" example: "1" type: string sign_order_no: description: "签约单号\t可通过alipay.open.agent.confirm接口获取签约单号" example: "20211015034000100000052128459671" type: string type: object AlipayOpenSpIsvSignauthCreateResponseModel: properties: order_id: description: 签约授权一体化主单ID example: "20211102034000100000047728652233" type: string type: object AlipayOpenSpIsvSignauthQueryErrorResponseModel: properties: code: description: 错误码 enum: - ILLEGAL_PARAMS - SIGNAUTH_ORDER_NOT_EXIST - SIGNAUTH_ISV_NOT_MATCH - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSpIsvSignauthQueryResponseModel: properties: order_id: description: 签约授权一体化订单ID example: "20211102034000100000047728652040" type: string status: description: "签约授权一体化订单状态\tINIT:初始化\tUNCONFIRM:待确认\tFAILURE:失败\tFINISH:成\ 功" example: INIT type: string task_infos: description: 签约授权一体化订单子任务单信息 items: $ref: '#/components/schemas/SubTaskInfo' type: array type: object AlipayOpenSpLeadsExpandCreateErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - ISV_NOT_IN_WHITELIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSpLeadsExpandCreateModel: properties: address: description: 拓展助手商机地址 example: 紫金港路与文二西路交叉口向西500米西城广场 type: string city_code: description: 拓展助手商机地址市code example: "330100" type: string city_name: description: 拓展助手商机地址市名称 example: 杭州市 type: string district_code: description: 拓展助手商机地址区code example: "330111" type: string district_name: description: 拓展助手商机地址区名称 example: 西湖区 type: string email: description: 拓展助手商机邮箱 example: xxx@qq.com type: string latitude: description: 拓展助手商机地址纬度 example: "30.259247" type: string longitude: description: 拓展助手商机地址经度 example: "120.13042700000001" type: string mcc: description: mcc行业 example: MARKET type: string merchant_pid: description: 2088账号 example: "2088401299710003" type: string name: description: 拓展助手商机名称 example: 名称 type: string out_biz_no: description: 外部幂等唯一键 example: out_biz_no type: string phone: description: 拓展助手商机联系电话 example: "13812312323" type: string province_code: description: 拓展助手商机地址省code example: "330000" type: string province_name: description: 拓展助手商机地址省名称 example: 浙江省 type: string scene: description: 拓展助手场景,参数约定 example: IOT_RUYI_EXPAND type: string type: object AlipayOpenSpLeadsExpandCreateResponseModel: properties: leads_id: description: 商机id example: 商机id type: string type: object AlipayOpenSpMerchantInconsistentApproveErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSpMerchantInconsistentApproveModel: properties: back_card: description: 身份证背面照,图片文件大小在 50K-5M 之间,不限制长宽,支持 png、bmp、gif、jpg、jpeg 格式。 请传入alipay.open.sp.image.upload(图片上传接口) 返回的 image_id。 example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string commitment_letter: description: 实际经营人承诺函照片,要求证件文本信息清晰可见,图片文件大小在 50K-5M 之间,不限制长宽,支持 png、bmp、gif、jpg、jpeg 格式。 请传入alipay.open.sp.image.upload(图片上传接口) 返回的 image_id。 该资质是否必传请参见报名资质要求。 example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string front_card: description: 身份证正面照,要求证件文本信息清晰可见,图片文件大小在 50K-5M 之间,不限制长宽,支持 png、bmp、gif、jpg、jpeg 格式. 请传alipay.open.sp.image.upload(图片上传接口) 返回的 image_id。 example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string handheld_business_license: description: 手持营业执照合照,要求证件文本信息清晰可见,图片文件大小在 50K-5M 之间,不限制长宽,支持 png、bmp、gif、jpg、jpeg 格式。 请传入alipay.open.sp.image.upload(图片上传接口) 返回的 image_id。 该资质是否必传请参见报名资质要求。 example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string handheld_card: description: 手持身份证合照,要求证件文本信息清晰可见,图片文件大小在 50K-5M 之间,不限制长宽,支持 png、bmp、gif、jpg、jpeg 格式。 请传入alipay.open.sp.image.upload(图片上传接口) 返回的 image_id。 该资质是否必传请参见报名资质要求。 example: A*7j1pTrCpV8EAAAAAAAAAAAAAAQAAAA type: string item_code: description: 服务优选商品编码 example: SS010301000000001234 type: string merchant_pid: description: 商家pid example: "2088301912341234" type: string mini_appid: description: 商家小程序appId example: "2021060612341234" type: string out_biz_no: description: 外部业务号,需不重复 example: "2088100010001000" type: string promotor_pid: description: 推广服务商(S2)pid example: "2088301912341234" type: string type: object AlipayOpenSpMerchantInconsistentApproveResponseModel: properties: apply_no: description: 申请单据编号 example: "2021090912341234" type: string type: object AlipayOpenSpOperationApplyErrorResponseModel: properties: code: 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 - BP_WAIT_PROCESS_CREATE_ERROR - MRCHPROD_RPC_INVOKE_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSpOperationApplyModel: properties: access_product_code: description: "接入的产品编号。 枚举如下:\t* OPENAPI_BIND_DEFAULT:操作类型为账号绑定。\t* OPENAPI_AUTH_DEFAULT:\ 操作类型为代运营授权时。" example: OPENAPI_BIND_DEFAULT type: string alipay_account: description: "支付宝登录账号,通常为手机号或者邮箱。\t间连场景必填。\t直连场景选填,特别注意merchant_no和alipay_account不\ 能同时为空,都有值优先取merchant_no。" example: xxx@gmail.com type: string isv_scene_permissions: 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 type: string merchant_no: description: "支付宝商户号。\t间连场景,merchant_no必填,传入商户smid,特别注意仅支持2088开头的间连商户。\t\ 直连场景,merchant_no选填,传入商户支付宝pid,特别注意merchant_no和alipay_account不能同时为空,优先取\ merchant_no。" example: 2088XXXX type: string operate_type: description: "代运营操作类型。枚举如下:\t* ACCOUNT_BIND:代表绑定支付宝账号,仅对于间连商户。\t* OPERATION_AUTH:\ 代表代运营授权,支持间连和直连商户,其中间连场景包含绑定支付宝账号。" example: ACCOUNT_BIND type: string out_biz_no: description: 外部操作流水,ISV自定义。每次操作需要确保唯一。 example: "2020124234523465636345634" type: string type: object AlipayOpenSpOperationApplyResponseModel: properties: batch_no: description: 支付宝操作批次号 example: "2020222342342" type: string bind_account: $ref: '#/components/schemas/RecommendAccountDTO' recommend_accounts: description: 只针对服务商代间连商家发起代运营绑定、授权时,如果传递的alipay_account不符合绑定或授权要求,这个字段会返回推荐的商家支付宝账号列表,包括:支付宝账号和名称,为保护商家信息,账号和名称都按照规范脱敏。 items: $ref: '#/components/schemas/RecommendAccountDTO' type: array type: object AlipayOpenSpOperationQrcodeQueryErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSpOperationQrcodeQueryResponseModel: properties: batch_no: description: 支付宝操作批次号 example: "2020222342342" type: string bind_account: $ref: '#/components/schemas/RecommendAccountDTO' qr_code_url: description: "二维码图片地址,urlEncode处理过。\t注意:\t1.有效期为24h;\t2.用户扫码确认授权操作(同意/拒绝\ )后,支付宝将通过alipay.open.sp.operation.result.notify接\ 口发送异步通知给服务商。" example: http://qrcode.alipay.com/adadadad.jpg type: string recommend_account_list: description: 只针对服务商代间连商家发起代运营绑定、授权时,如果传递的alipay_account不符合绑定或授权要求,这个字段会返回推荐的商家支付宝账号列表,包括:支付宝账号和名称,为保护商家信息,账号和名称都按照规范脱敏。 items: $ref: '#/components/schemas/RecommendAccountDTO' type: array recommend_accounts: $ref: '#/components/schemas/RecommendAccountDTO' type: object AlipayOpenSpOperationResultQueryErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSpOperationResultQueryResponseModel: properties: bind_user_id: description: 商户支付宝pid。仅间连场景,且存在绑定关系时返回值。 example: 2088XXXX type: string handle_status: description: "代运营操作结果。\tSUCCESS:代表成功。\tPROCESS:待商家确认中。\tNO_PERMISSION:表示\ 当前商家支付宝账号无权限操作。需要提醒商家切换成发起授权时指定的支付宝账号。\tNONE:表示不存在代运营绑定或授权关系。\tNONE_ACCOUNT:\ 间连商家推荐支付宝账号列表为空。" example: SUCCESS type: string merchant_no: description: 支付宝商户号。间连场景为商户smid,直连场景为商户支付宝pid example: 2088XXX type: string type: object AlipayOpenSpOpporDetailQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - ISV_NOT_IN_WHITELIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSpOpporDetailQueryResponseModel: properties: address: description: 商机地址 example: 紫金港路与文二西路交叉口向西500米西城广场 type: string leads_id: description: 商机Id example: "2022032304216502" type: string name: description: 商机名称 example: 智能美业 type: string oppor_id: description: 商机作业Id example: "2022041403518351" type: string out_biz_no: description: 外部幂等唯一键 example: "2021110900796459" type: string phone: description: 商机联系电话 example: "17003802762" type: string status: description: 商机作业状态 example: EXPAND_FAILED type: string type: object AlipayOpenSpOpporFeedbackModifyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - ISV_NOT_IN_WHITELIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSpOpporFeedbackModifyModel: properties: expand_result: description: 拓展助手商机拓展结果 example: EXPANDED/EXPAND_FAILED type: string isv_pid: description: 服务商pid example: "2088501013445414" type: string leads_id: description: 商机id example: "2022032304216502" type: string merchant_pid: description: 拓展助手商机商家pid example: "2088341444815673" type: string oppor_id: description: 商机作业id example: "2022041403518351" type: string sn: description: 拓展设备sn号 example: sn type: string type: object AlipayOpenSpOpporFeedbackModifyResponseModel: properties: msg: description: 商机拓展结果反馈结果失败描述 example: msg type: string success: description: 商机拓展结果反馈结果是否成功 example: true type: boolean type: object AlipayOpenSpOpporPageQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - ISV_NOT_IN_WHITELIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenSpOpporPageQueryResponseModel: properties: current_page: description: 当前页码 example: 1 type: integer oppor_list: description: 商机作业记录列表 items: $ref: '#/components/schemas/IsvExpandOpporDTO' type: array page_size: description: 每页数量 example: 10 type: integer total_size: description: 总记录数 example: 10 type: integer type: object AlipayOpenViolationViolationdetailQueryErrorResponseModel: properties: code: description: 错误码 enum: - AUTHORITY_ILLEGAL - ILLEGAL_PARAMS - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenViolationViolationdetailQueryResponseModel: properties: appeal_dead_line: description: "申诉截止日期。\t即商户可进行申诉的截止日期,若超过该时间未申诉或申诉不通过,平台不提供申诉机会,维持原处罚结果;若\ 该时间内完成申诉且申诉通过,平台将撤销对商户的处罚" example: 2020-01-01 00:00:01 type: string appeal_reply_records: description: 商家申诉记录 items: $ref: '#/components/schemas/ReplyRecord' type: array can_appeal: description: 商家是否可以申诉 example: true type: boolean can_rectify: description: 商家是否可以整改 example: true type: boolean punish_action: 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\"]" items: type: string type: array rectify_dead_line: description: 截止整改时间。即商户可进行整改的截止日期,若超过该时间未整改或整改不通过,平台将对商户进行处罚,若该时间内完成整改且整改通过,平台对商户不处罚 example: 2020-01-01 00:00:01 type: string rectify_reply_records: description: 商家整改记录 items: $ref: '#/components/schemas/ReplyRecord' type: array status: description: 违规工单状态枚举 example: PUNISH_DONE type: string surplus_appeal_cnt: description: "剩余申诉次数。\t即在申诉截止日期内,平台允许商家申诉的次数,当商户提交申诉但申诉未通过时,剩余申诉次数减1,当整改\ 次数为0,不管是否在整改截止日期内,平台将对商户进行处罚" example: "3" type: string surplus_rectify_cnt: description: 剩余整改次数。即在整改截止日期内,平台允许商家整改的次数,当商户提交整改但整改未通过时,剩余整改次数减1,当整改次数为0,不管是否在整改截止日期内,平台将对商户进行处罚 example: "3" type: string target_id: description: 违规对象ID example: "2022000000000011" type: string target_name: description: 违规对象名称 example: xxx测试小程序 type: string target_type: description: "违规对象类型\t小程序ID:APPID\t生活号ID:PUBLICID" example: APPID type: string violation_evidence: description: 平台判定商家违规凭证 items: $ref: '#/components/schemas/AuditEvidenceInfo' type: array violation_reason: description: 违规原因 example: 营销推广内容中出现的原价或参考价并无实际销售记录,诱导用户参与或下单交易/服务的行为。 type: string violation_record_id: description: 支付宝侧生成的违规记录唯一标识 example: "20220524001020000000000001" type: string violation_time: description: 违规时间,格式为 yyyy-MM-dd HH:mm:ss example: 2020-01-01 00:00:01 type: string violation_type: description: 即平台依据平台规范/规则,判定商户的违规类型 example: 数据和系统安全/敏感参数泄露风险 type: string type: object AlipayOpenViolationViolationeventBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - AUTHORITY_ILLEGAL - ILLEGAL_PARAMS - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayOpenViolationViolationeventBatchqueryModel: properties: begin_time: description: 查询开始时间 时间格式:yyyy-MM-dd HH:mm:ss 若不填写,则默认当前时间30天前。 注意:begin_time和end_time时间跨度最大一年 example: 2020-01-01 00:00:01 type: string end_time: description: 查询结束时间 时间格式:yyyy-MM-dd HH:mm:ss 若不填写,则默认当前时间。 注意:begin_time和end_time时间跨度最大一年 example: 2020-01-01 00:00:01 type: string status: description: 违规工单状态 example: PUNISH_DONE type: string type: object AlipayOpenViolationViolationeventBatchqueryResponseModel: properties: violation_record_infos: $ref: '#/components/schemas/ViolationEvent' type: object AlipayPcreditHuabeiAuthAccumulationQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - AGREEMENT_NOT_EXIST - CALL_LIMITED - INVALID_PERIOD type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayPcreditHuabeiAuthAccumulationQueryResponseModel: properties: pay_amount: description: 本周期内支付宝端根据用户消费情况试算出的应付费用,仅供参考使用。 example: "3.75" type: string total_discount_amount: description: 本周期内用户累计享受的优惠金额 example: "2.15" type: string total_pay_count: description: 本周期内用户总的消费次数 example: "2" type: string total_real_pay_amount: description: 本周期内用户累计支付宝付款金额 example: "3.75" type: string type: object AlipayPcreditHuabeiAuthAgreementCloseErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - AGREEMENT_NOT_EXIST - NOT_ALLOW_CLOSE - AGREEMENT_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayPcreditHuabeiAuthAgreementCloseModel: properties: agreement_no: description: 花芝协议号,支付宝系统中用以唯一标识用户签约记录的编号,即花芝协议号。 example: "20195609549841482443" type: string alipay_user_id: description: 买家在支付宝的用户id example: "2088101117955611" type: string open_id: description: 买家在支付宝的用户id example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string out_request_no: description: 外部请求号 example: "2019080910020821390001569835" type: string partner_id: description: 商户ID example: "2088101117955611" type: string quit_type: description: 用户主动意愿退出:USER_CANCEL_QUIT; 商户结算退出:SETTLE_APPLY_QUIT; 默认值为SETTLE_APPLY_QUIT;这个字段会影响用户在芝麻信用合约的状态 example: SETTLE_APPLY_QUIT type: string type: object AlipayPcreditHuabeiAuthAgreementCloseResponseModel: properties: out_request_no: description: 外部请求号 example: "2019080910020821390001569835" type: string type: object AlipayPcreditHuabeiAuthAgreementQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - AGREEMENT_NOT_EXIST - CALL_LIMITED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayPcreditHuabeiAuthAgreementQueryResponseModel: properties: agreement_name: description: 协议名称 example: 花呗先享会员 type: string agreement_no: description: 支付宝系统中用以唯一标识用户签约记录的编号,即花芝轻会员协议号。 example: "20185513447859192007" type: string agreement_status: description: 协议状态。Y表示状态有效,N表示状态失效 example: "Y" type: string alipay_user_id: description: 支付宝用户userId example: "2088302424419340" type: string auth_scene: description: 花芝轻会员签约场景,商户和支付宝签约时确定,商户接入时需要咨询技术支持。 example: EXTERNAL_PCARD type: string external_logon_id: description: 用户在商户网站的登录账号 example: sample@126.com type: string gmt_sign: description: 签约时间。如果是在签状态,返回签约时间。 example: 2018-09-15 11:23:04 type: string gmt_unsign: description: 花芝轻会员协议解约时间。如果是解约状态,才返回该字段。 example: 2018-09-15 11:23:04 type: string open_id: description: 支付宝用户userId example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string out_biz_type: description: 外部业务类型,用于区分本次业务交互在商户侧具体的业务类别,提供给商家进行特定逻辑的处理 example: NORMAL_BIZ_TYPE type: string out_sign_no: description: 外部签约号,由商户提供,花芝轻会员协议中标识用户的唯一签约号(确保在商户系统中唯一)。由商户签约时传入,最终返回给商户。 example: "2018053100073208416400000002" type: string rest_freeze_amount: description: 用户在本花芝轻会员协议中,剩余的总冻结额度(资金池总余额),数值能实时准确,可以用于核对。两位小数,单位元。 example: "200.00" type: string type: object AlipayPcreditHuabeiAuthOrderQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - ORDER_NOT_EXIST - CALL_LIMITED - UNSUPPORT_OPERATION type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayPcreditHuabeiAuthOrderQueryResponseModel: properties: agreement_no: description: 支付宝系统中用以唯一标识用户签约记录的编号,即花呗先享协议号。 example: "20185513447859192007" type: string alipay_user_id: description: 支付宝用户userId example: "2088302424419340" type: string auth_opt_id: description: 支付宝侧花呗冻结解冻操作单据id example: "2018081010020817070009689955" type: string gmt_trans: description: 业务操作完成时间 example: 2018-09-15 11:23:04 type: string open_id: description: 支付宝用户userId example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string order_title: description: 商户业务订单的简单描述,如商品名称等,长度不超过100个字母或50个汉字 example: 饿了么花呗先享超级会员续费冻结 type: string out_request_no: description: 商户本次操作的请求流水号 example: "8077735255938032" type: string rest_freeze_amount: description: 完成本次操作时,用户资金池余额快照。仅作提示用,请勿用于核对,并发情况下数值有可能不准确。两位小数,单位元。 example: "200.00" type: string seller_id: description: 商户的支付宝用户id example: "2088102146225135" type: string trans_amount: description: 冻结或者解冻金额 example: 操作金额 type: string trans_status: description: 业务操作状态,Y表示成功结束;N表示失败结束;I表示进行中。 example: "Y" type: string trans_type: description: 操作类型,FREEZE表示冻结操作;UNFREEZE表示解冻操作;PAY表示支付操作;SETTLE表示结算操作 example: FREEZE type: string type: object AlipayPcreditHuabeiAuthOrderUnfreezeErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayPcreditHuabeiAuthOrderUnfreezeModel: properties: agreement_no: description: 支付宝系统中用以唯一标识用户签约记录的编号,即花呗先享协议号 example: "20185513447859192007" type: string alipay_user_id: description: 买家在支付宝的用户id example: "2088101117955611" type: string need_terminated: description: true表示需要解约。false或者不填写表示仅解冻。 example: '''false''' type: string open_id: description: 买家在支付宝的用户id example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string order_title: description: 商户业务订单的简单描述,如商品名称等,长度不超过100个字母或50个汉字 example: 饿了么花呗先享超级会员撤销 type: string out_request_no: description: 商户本次操作的请求流水号,用于标识请求流水的唯一性,不能包含除中文、英文、数字以外的字符,需要保证在商户端不重复。 example: "8077735255938032" type: string seller_id: description: 商户的支付宝用户id。如果该值为空,则默认为商户签约账号对应的支付宝用户ID。 example: "2088102146225135" type: string unfreeze_amount: description: 需要解冻的金额,单位为:元(人民币),精确到小数点后两位 example: "3.00" type: string type: object AlipayPcreditHuabeiAuthOrderUnfreezeResponseModel: properties: agreement_no: description: 支付宝系统中用以唯一标识用户签约记录的编号,即花呗先享协议号 example: "20185513447859192007" type: string agreement_status: description: 协议状态。Y表示状态有效,N表示状态失效 example: "Y" type: string alipay_user_id: description: 买家在支付宝的用户id example: "2088101117955611" type: string auth_opt_id: description: 支付宝侧花呗冻结解冻操作单据id example: "2018081010020817070009689955" type: string gmt_trans: description: 解冻成功时间 example: 2014-09-15 11:23:04 type: string open_id: description: 买家在支付宝的用户id example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string out_request_no: description: 商户本次操作的请求流水号,用于标识请求流水的唯一性,不能包含除中文、英文、数字以外的字符,需要保证在商户端不重复。由商户传入,最终返回给商户。 example: "8077735255938032" type: string rest_freeze_amount: description: 完成本次操作时,用户资金池余额快照。仅作提示用,请勿用于核对,并发情况下数值有可能不准确。两位小数,单位元。 example: "200.00" type: string seller_id: description: 商户的支付宝用户id example: "2088411663864410" type: string trans_status: description: 业务操作状态,Y表示成功;N表示失败。 example: "Y" type: string unfreeze_amount: description: 解冻金额 example: "3.00" type: string type: object AlipayPcreditHuabeiAuthRefundApplyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayPcreditHuabeiAuthRefundApplyModel: properties: agreement_no: description: 签约花芝的业务协议号,在签约成功、结算成功等通知中回回传给商户。 example: "20205105001164318008" type: string alipay_user_id: description: 支付宝用户ID example: "2088302841345600" type: string auth_opt_id: description: "支付宝侧授权操作单据id,在结算扣款成功的通知消息中会回传。在周期扣款场景下,和trade_no必传其中一个值。" example: "2018041721001001230571065758" type: string memo: description: 本次退款说明 example: 退款 type: string open_id: description: 支付宝用户ID example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string out_request_no: description: 外部请求号 example: "99202005050100930053707258" type: string partner_id: description: 商户ID example: "2088302424614288" type: string refund_amount: description: 退款金额,单位为:元(人民币),精确到小数点后两位 example: "3.00" type: string refund_type: description: "MEMBER_FEE_REFUND 会员费结算退款\tWITHHOLD_FEE_REFUND 周期扣款金额退款\t默\ 认为MEMBER_FEE_REFUND" example: MEMBER_FEE_REFUND type: string trade_no: description: "支付宝交易号,在结算扣款成功的通知中会回传。\t在周期扣款场景下,和auth_opt_id必传其中一个值。" example: "2013112011001004330000121536" type: string type: object AlipayPcreditHuabeiAuthRefundApplyResponseModel: properties: auth_opt_id: description: 授权支付单ID example: "2018041721001001230571065758" type: string fail_reason: description: 退款操作错误原因描述 example: 退款金额超限 type: string out_request_no: description: 外部请求号 example: "99202005050100930053707258" type: string retry: description: 是否可重试 example: true type: boolean type: object AlipayPcreditHuabeiAuthSettleApplyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayPcreditHuabeiAuthSettleApplyModel: properties: action_type: description: "操作类型,默认为 MERCHANT_SETTLE(结算)。枚举值如下:\t* MERCHANT_SETTLE:结算\ (需要主动退出在发起结算);\t* QUIT_SETTLE:退出协议(解约协议);\t* PERIOD_SETTLE:分阶段结算(不解约\ 协议)。" example: PERIOD_SETTLE type: string agreement_no: description: 支付宝系统中用以唯一标识用户签约记录的编号。 example: "20170502000610755993" type: string alipay_user_id: description: 用户在支付宝的唯一标识,以 2088 开头的 16 位纯数字组成。 example: "2088101117955611" type: string extend_params: $ref: '#/components/schemas/ExtraParams' need_terminated: description: "是否解约,该参数控制结算完成之后的操作,为空则表示结算后解约。枚举值如下:\t* true:代表解约,默认为true。\ \t* false:代表不解约。" example: "true" type: string open_id: description: 用户在支付宝的唯一标识 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string out_request_no: description: 商户本次操作的请求流水号,用于标示请求流水的唯一性,不能包含除中文、英文、数字以外的字符,需要保证在商户端不重复。 example: "8077735255938032" type: string pay_amount: description: 需要支付的金额,单位为:元(人民币),精确到小数点后两位 example: "3.00" type: string seller_id: description: "支付宝商家ID,即商家账号在支付宝的唯一标识,以 2088 开头的 16 位纯数字组成。\t说明:若该值为空,则默认\ 为商户签约账号对应的支付宝用户ID。" example: "2088102146225135" type: string type: object AlipayPcreditHuabeiAuthSettleApplyResponseModel: properties: fail_reason: description: 根据商户传入的轻会员协议结算周期内累计消费数据与支付宝端轻会员协议结算周期内消费数据比对之后,若数据不一致,则会返回对应的异常数据比对结果。 example: "累计支付宝支付金额不一致,支付宝:100.00元,商户:150.00元" type: string out_request_no: description: 商户本次操作的请求流水号,用于标示请求流水的唯一性,不能包含除中文、英文、数字以外的字符,需要保证在商户端不重复。 example: "8077735255938032" type: string type: object AlipaySecurityDataSssCreateErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - MANJIANG_UNIFY_TEST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipaySecurityDataSssCreateModel: properties: area_code: description: "body,可选,无openid,有枚举值,注意事项" example: aaa type: string f: $ref: '#/components/schemas/JinyoutestopenidThree' type: object AlipaySecurityDataSssCreateResponseModel: properties: c: description: 区 example: "1" type: string c_open_id: description: 区 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string type: object AlipaySecurityProdSssQueryErrorResponseModel: properties: code: description: 错误码 enum: - SECURITY_CHECK_FAILED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipaySecurityProdSssQueryModel: properties: tesst: description: stst items: $ref: '#/components/schemas/PromiseDetail' type: array xxx: $ref: '#/components/schemas/JinyouTestFive' type: object AlipaySecurityProdSssQueryResponseModel: properties: ccc: description: "1" example: "23" type: string ccc_open_id: description: "1" example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string type: object AlipaySecurityRiskCustomerriskSendErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipaySecurityRiskCustomerriskSendModel: properties: bank_card_no: description: 交易对应的银行卡的卡号(支付宝直连和间连合作伙伴均可回传此参数) example: "421234234234234000" type: string business_license_no: description: 该账号对应的营业执照号码(支付宝直连和间连合作伙伴均可回传此参数) example: 34xggdf345 type: string cert_no: description: 该用户对应的身份证号码(支付宝直连和间连合作伙伴均可回传此参数) example: "659004198009128344" type: string email_address: description: 账户注册时填写的邮箱地址(适用于支付宝直连商户回传此信息) example: 12345@abcd.com type: string external_id: description: 适用于间连业务场景下,商户在银行被分配的ID(适用于支付宝间连合作伙伴回传此信息) example: "2088011993690428" type: string merch_name: description: 该笔风险交易购买的具体商品名称(适用于支付宝直连商户回传此信息) example: 游戏道具 type: string mobile: description: 手机(支付宝直连和间连合作伙伴均可回传此参数) example: "1359892324" type: string mobile_ip: description: 该账号登录合作伙伴平台时的IP地址(适用于支付宝直连商户回传此信息) example: 10.253.231.22 type: string order_ip: description: 该账户在商户平台下单时的MAC地址或IP地址(适用于支付宝直连商户回传此信息) example: 00000000-01010000-10111010 type: string pid: description: 适用于直连商户场景下的支付宝合作伙伴ID(适用于支付宝直连合作伙伴回传此信息) example: "2088123456789012" type: string plat_account: description: 指第三方在商户平台注册成功后,平台给予的账户号(适用于支付宝直连商户回传此信息) example: abc123 type: string process_code: 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\t\ 01:已延迟结算,02:关停商户,99:其他\r\t多重处理结果可调用多次,每次回传一种处理结果" example: "01" type: string smid: description: 指间连交易场景下商家被支付宝分配的ID(适用于支付宝间连合作伙伴回传此信息) example: "17022079254" type: string trade_no: description: 支付宝推送的风险消息中的交易号(支付宝直连和间连合作伙伴均需回传此参数) example: "2017113021001004640000000000" type: string type: object AlipaySecurityRiskCustomerriskSendResponseModel: type: object AlipaySecurityRiskVerifyidentityMiniappConfirmErrorResponseModel: properties: code: description: 错误码 enum: - PARAM_TAMPERED - INVALID_ARGUMENTS - SYSTEM_ERROR - VERIFY_STATE_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipaySecurityRiskVerifyidentityMiniappConfirmModel: properties: challenge: description: 业务的业务流水号,例如订单id example: "00123456" type: string open_id: description: 蚂蚁统一会员ID,验证时会与做身份认证时候会话中的openid做比对,如不相符核验结果不通过 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string user_id: description: 蚂蚁统一会员ID,验证时会与做身份认证时候会话中的userId做比对,如不相符核验结果不通过 example: "2088302857831249" type: string verify_id: description: 核身校验id,是一次核身校验服务中唯一性的id example: 0xa213nfdajbav17521 type: string type: object AlipaySecurityRiskVerifyidentityMiniappConfirmResponseModel: properties: error_code: description: 身份核实校验结果失败时,返回的失败错误码 example: SYSTEM_ERROR type: string error_msg: description: 身份核实校验结果失败时,返回的失败错误原因说明 example: 系统繁忙,请稍后再试 type: string verify_result: description: 身份核验结果 example: true type: boolean type: object AlipaySocialBaseContentlibStandardcontentBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - CONTENT_NOT_EXISTS - NO_PERMISSION - SYSTEM_ERROR - PUBLIC_NOT_UPGRADE - PUBLIC_NOT_EXISTS - BUSINESS_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipaySocialBaseContentlibStandardcontentBatchqueryModel: properties: need_detail: description: "指示是否返回内容详情, 默认为false\tfalse: 仅返回内容ID列表\ttrue:返回 content_details" example: true type: boolean page_num: description: "当页分页,默认为1" example: 1 type: integer page_size: description: "分页记录数,最大20,默认20" example: 20 type: integer public_id: description: 生活号+号ID,只有MCN机构为达人号ID查询内容才需要传入 example: 2030000013518xxx type: string status: description: 内容状态,默认查询所有状态 example: "1" type: string type: object AlipaySocialBaseContentlibStandardcontentBatchqueryResponseModel: properties: content_details: description: 内容详情列表 items: $ref: '#/components/schemas/SourceContentInfo' type: array content_ids: description: 内容ID列表 example: "[\"20211022OB02001003220004xxxx\"]" items: type: string type: array page_num: description: 当前分页 example: 1 type: integer page_size: description: 每页记录数 example: 20 type: integer total: description: 总记录数 example: 100 type: integer type: object AlipaySystemOauthTokenErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipaySystemOauthTokenModel: properties: code: description: 授权码,用户对应用授权后得到。本参数在 grant_type 为 authorization_code 时必填;为 refresh_token 时不填。 example: 4b203fe6c11548bcabd8da5bb087a83b type: string grant_type: description: 授权方式 example: authorization_code type: string refresh_token: description: 刷新令牌,上次换取访问令牌时得到。本参数在 grant_type 为 authorization_code 时不填;为 refresh_token 时必填,且该值来源于此接口的返回值 app_refresh_token(即至少需要通过 grant_type=authorization_code 调用此接口一次才能获取)。 example: 201208134b203fe6c11548bcabd8da5bb087a83b type: string type: object AlipaySystemOauthTokenResponseModel: properties: access_token: description: 访问令牌。通过该令牌调用需要授权类接口 example: 20120823ac6ffaa4d2d84e7384bf983531473993 type: string alipay_user_id: description: 已废弃,请勿使用 example: 已废弃,请勿使用 type: string auth_start: description: 授权token开始时间,作为有效期计算的起点 example: 2010-11-11 11:11:11 type: string auth_token_type: description: 令牌类型,permanent表示返回的access_token和refresh_token永久有效,非永久令牌不返回该字段 example: permanent type: string expires_in: description: 访问令牌的有效时间,单位是秒。 example: "3600" type: string open_id: description: 支付宝用户唯一标识 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string re_expires_in: description: 刷新令牌的有效时间,单位是秒。 example: "3600" type: string refresh_token: description: 刷新令牌。通过该令牌可以刷新access_token example: 20120823ac6ffdsdf2d84e7384bf983531473993 type: string union_id: description: "union_id是支付宝用户在开放平台的唯一标识符,在配置应用分组后会返回该值。\t同一用户的union_id在同一\ 分组内应用保持一致。" example: 092aSPrsmhTbexLh9zgoYb2uvZNC4D8izCpGKTem8QiIOQb type: string user_id: description: 支付宝用户的唯一标识。以2088开头的16位数字。 example: "2088102150477652" type: string type: object AlipayTradeAdvanceConsultErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - USER_STAUTS_ERROR - USER_NOT_EXIST - BUYER_NOT_SUPPORT_ADVANCEPAY - ILLEGAL_AGREEMENT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeAdvanceConsultResponseModel: properties: refer_result: description: "true 代表当前时间点,用户允许垫资\tfalse 代表当前时间,用户不允许垫资" example: true type: boolean result_code: description: 用户被注销 example: USER_NOT_EXIST type: string result_message: description: 返回用户不准入原因 example: 用户不准入 type: string risk_level: description: 订单风险评估等级,在单笔订单风险预评估时返回。当基础风险校验通过时,可通过该值获取业务风险评估等级。取值:2-高风险;1-低风险。 example: "1" type: string user_risk_prediction: $ref: '#/components/schemas/UserRiskPrediction' wait_repayment_amount: description: 用户剩余的总待还金额,无论当前用户是否允许垫资,都会返回该属性。 example: "2.48" type: string wait_repayment_order_count: description: 用户总的未还的垫资笔数,无论用户是否允许垫资,都会返回该属性 example: 6 type: integer wait_repayment_order_infos: description: 待还订单列表,无论用户当前状态是否允许垫资,都会返回当前用户在商户下的待还订单信息 items: $ref: '#/components/schemas/WaitRepaymentOrderInfo' type: array type: object AlipayTradeApplepayAuthenticationSubmitErrorResponseModel: properties: code: description: 错误码 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeApplepayAuthenticationSubmitModel: properties: authentication_results: description: ApplePay核身鉴权结果,包括:支付密码、用户确认、数字签名 items: $ref: '#/components/schemas/AuthenticationResult' type: array device_identifier: description: Apple端的设备ID example: mKS9uBWMBT4Vv4+mgVLy7ZbMYer0XMHMfdqnOBVVr+b/iqNagFVjVWSGeSGOhDBi type: string dpan_identifier: description: Apple绑定的BundleId example: DAPLSM20191217003050010000320000001002 type: string transaction_identifier: description: 交易标识 example: "2020040422001424181400075556" type: string type: object AlipayTradeApplepayAuthenticationSubmitResponseModel: properties: authentication_error: description: 核身错误信息 example: PINMaximumTriesExceeded type: string fallback_authentication_mechanisms: description: 失败时的鉴权重试机制 example: PaymentPINInput items: type: string type: array response_header: $ref: '#/components/schemas/OpenApiResponseHeader' retry_authentication_mechanisms: description: 鉴权重试机制 example: PaymentPINInput items: type: string type: array signing_certificate: description: base64之后的证书 example: R2VuZXJhdGVkIENlcnRpZmljYXRlIERhdGE= type: string updated_authentication_details: $ref: '#/components/schemas/UpdatedAuthenticationDetails' updated_transaction_status: description: 交易状态 example: Pending type: string type: object AlipayTradeBatchSettleErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeBatchSettleModel: properties: biz_product: description: 收单产品码,商家和支付宝签约的产品码 example: FACE_TO_FACE_PAYMENT type: string extend_params: description: 扩展参数 example: "{\"key\":\"value\"}" type: string out_request_no: description: 结算请求外部流水号,32个字符以内、可包含字母、数字、下划线;需保证在商户端不重复,如果重复则返回该流水号对应的结算单据的状态。 example: "20180101" type: string settle_clauses: description: 结算明细条款 items: $ref: '#/components/schemas/SettleClause' type: array settle_type: description: 结算方式,目前仅支持提前放款结算quickSettlement,提前放款结算需要商户开通快收服务,不填则为普通结算方式 example: quickSettlement type: string type: object AlipayTradeBatchSettleQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BATCH_SETTLE_NOT_EXIST - SYSTEM_ERROR - OPENID_APPID_NOT_MATCH type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeBatchSettleQueryModel: properties: extend_params: description: 扩展参数 example: "{\"key\":\"value\"}" type: string out_request_no: description: 批量结算时传入的外部流水号,与settle_no二者必填其一。 out_request_no和settle_no如果同时存在,优先取settle_no example: "20180101" type: string settle_no: description: 结算单据号,与out_request_no二者必填其一 example: "2019050510032002040000053220" type: string type: object AlipayTradeBatchSettleQueryResponseModel: properties: out_request_no: description: 批量结算时传入的外部流水号 example: "20190101" type: string settle_detail: description: 批量结算详情 items: $ref: '#/components/schemas/BatchSettleDetail' type: array settle_no: description: 结算单据号 example: "2019050510032002040000053220" type: string type: object AlipayTradeBatchSettleResponseModel: properties: gmt_create: description: 结算受理时间 example: 2014-11-27 15:45:57 type: string out_request_no: description: 结算请求外部流水号 example: "201811" type: string result_code: description: "业务结果码。\r\t\r\tACCEPT_SUCCESS:受理成功;\r\tACCEPT_FAIL:受理失败;\r\t\ SUCCESS:结算处理成功;\r\tFAIL:结算处理失败;\r\tSYSTEM_EXCEPTION:系统异常" example: ACCEPT_SUCCESS type: string settle_no: description: 结算单据号。仅当业务结果码为ACCEPT_SUCCESS 或 SUCCESS时,settle_no有效 example: "2018032310032002040000053220" type: string type: object AlipayTradeBatchTransferErrorResponseModel: properties: code: 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 - FREQUENCY_LIMITED - NO_INVOKE_AUTH type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeBatchTransferModel: properties: extend_params: description: 业务扩展参数 example: "{\"key\":\"value\"}" type: string out_request_no: description: 结算请求外部流水号,32个字符以内、可包含字母、数字、下划线;需保证在商户端不重复 example: "20180101" type: string royalty_parameters: description: "分账条款明细\t特别注意:最好一次只传一个分账条款。\t如果传多个,则要求出账方只能有一个,\t举例:A分给B+A分\ 给C+A分给D=OK\tA分给B+C分给D=不行" items: $ref: '#/components/schemas/RoyaltyDetailInfo' type: array type: object AlipayTradeBatchTransferQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - BATCH_SETTLE_NOT_EXIST - SYSTEM_ERROR - OPENID_APPID_NOT_MATCH type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeBatchTransferQueryResponseModel: properties: out_request_no: description: 批量结算时传入的外部流水号 example: "20008" type: string royalty_detail: description: 批量结算详情 items: $ref: '#/components/schemas/BatchRoyaltyDetail' type: array settle_no: description: 结算单据号 example: "2019050510032002040000053220" type: string type: object AlipayTradeBatchTransferResponseModel: properties: gmt_create: description: 分账受理时间 example: 2014-11-27 15:45:57 type: string out_request_no: description: 分账请求外部流水号 example: "2008121" type: string result_code: description: 业务结果码。 ACCEPT_SUCCESS:受理成功; ACCEPT_FAIL:受理失败; SUCCESS:结算处理成功; FAIL:结算处理失败; SYSTEM_EXCEPTION:系统异常 example: ACCEPT_SUCCESS type: string settle_no: description: 分账单据号 example: "2018032310032002040000053220" type: string type: object AlipayTradeCancelErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeCancelModel: properties: out_trade_no: description: "原支付请求的商户订单号,和支付宝交易号不能同时为空" example: "20150320010101001" type: string trade_no: description: 支付宝交易号,和商户订单号不能同时为空 example: "2014112611001004680073956707" type: string type: object AlipayTradeCancelResponseModel: properties: action: description: "本次撤销触发的交易动作,接口调用成功且交易存在时返回。可能的返回值:\tclose:交易未支付,触发关闭交易动作,无\ 退款;\trefund:交易已支付,\b触发交易退款动作;\t未返回:未查询到交易,或接口调用失败;" example: close type: string gmt_refund_pay: description: "当撤销产生了退款时,返回退款时间;\t 只在银行间联交易场景下返回该信息;" example: 2016-11-27 15:45:57 type: string out_trade_no: description: 商户订单号 example: "6823789339978248" type: string refund_settlement_id: description: "当撤销产生了退款时,返回的退款清算编号,用于清算对账使用;\r\t只在银行间联交易场景下返回该信息;" example: "2018101610032004620239146945" type: string retry_flag: description: 是否需要重试 example: "N" type: string trade_no: description: "支付宝交易号;\t当发生交易关闭或交易退款时返回;" example: "2013112011001004330000121536" type: string type: object AlipayTradeCloseErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeCloseModel: properties: notify_url: description: 通知地址 type: string operator_id: description: 商家操作员编号 id,由商家自定义。 example: YX01 type: string out_trade_no: description: "订单支付时传入的商户订单号,和支付宝交易号不能同时为空。 trade_no,out_trade_no如果同时存在优先\ 取trade_no" example: HZ0120131127001 type: string trade_no: description: 该交易在支付宝系统中的交易流水号。最短 16 位,最长 64 位。和out_trade_no不能同时为空,如果同时传了 out_trade_no和 trade_no,则以 trade_no为准。 example: "2013112611001004680073956707" type: string type: object AlipayTradeCloseResponseModel: properties: out_trade_no: description: 创建交易传入的商户订单号 example: YX_001 type: string trade_no: description: 支付宝交易号 example: "2013112111001004500000675971" type: string type: object AlipayTradeCreateErrorResponseModel: properties: code: 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 - ACQ.BIZ_PRODUCT_NOT_ALLOWED - ACQ.UNBOUND_APPLICATION - ACQ.PRODUCT_NOT_SUPPORT_IN_TINY_APP - ACQ.MERCHANT_STATUS_NOT_NORMAL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeCreateModel: properties: agreement_sign_params: $ref: '#/components/schemas/SignParams' alipay_store_id: description: "支付宝店铺编号。\t指商户创建门店后支付宝生成的门店ID。" example: "2016041400077000000003314986" type: string bkagent_req_info: $ref: '#/components/schemas/BkAgentReqInfo' body: description: "订单附加信息。\t如果请求时传递了该参数,将在异步通知、对账单中原样返回,同时会在商户和用户的pc账单详情中作为交易\ 描述展示" example: Iphone6 16G type: string business_params: $ref: '#/components/schemas/BusinessParams' buyer_id: description: "买家支付宝用户ID。\t2088开头的16位纯数字,小程序场景下获取用户ID请参考:用户授权;\t\ 其它场景下获取用户ID请参考:网页授权获取用户信息;\t注:交易的买家与卖家不能相同。" example: "2088102146225135" type: string buyer_logon_id: description: 买家支付宝登录账号。 建议通过open_id来传递买家信息。 example: "15901825620" type: string buyer_open_id: description: 买家支付宝用户唯一标识 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string disable_pay_channels: description: "禁用渠道,用户不可用指定渠道支付,多个渠道以逗号分割\r\t注,与enable_pay_channels互斥\r\t\ 渠道列表" example: "pcredit,moneyFund,debitCardExpress" type: string discountable_amount: description: "可打折金额。\t参与优惠计算的金额,单位为元,精确到小数点后两位,取值范围[0.01,100000000]。 \t如\ 果同时传入了【可打折金额】、【不可打折金额】和【订单总金额】,则必须满足如下条件:【订单总金额】=【可打折金额】+【不可打折金额】。\t如果\ 订单金额全部参与优惠计算,则【可打折金额】和【不可打折金额】都无需传入。" example: "80.00" type: string enable_pay_channels: description: "指定支付渠道。\t用户只能使用指定的渠道进行支付,多个渠道以逗号分割。\t与disable_pay_channels互\ 斥,支持传入的值:渠道列表。\t注:如果传入了指定支付渠道,则用户只能用指定内的渠道支付,包括营销渠道也要指定才能使用。该参数可能导致用户支付受限,\ 慎用。" example: "pcredit,moneyFund,debitCardExpress" type: string ext_user_info: $ref: '#/components/schemas/ExtUserInfo' extend_params: $ref: '#/components/schemas/ExtendParams' goods_detail: description: 订单包含的商品列表信息,json格式。 items: $ref: '#/components/schemas/GoodsDetail' type: array logistics_detail: $ref: '#/components/schemas/LogisticsDetail' merchant_order_no: description: 商户的原始订单号 example: "20161008001" type: string notify_url: description: 通知地址 type: string op_app_id: description: 小程序支付中,商户实际经营主体的小程序应用的appid example: "2014072300007148" type: string op_buyer_open_id: description: 买家支付宝用户唯一标识(商户实际经营主体的小程序应用关联的买家open_id) example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string operator_id: description: 商户操作员编号。 example: Yx_001 type: string out_trade_no: description: "商户订单号。\t由商家自定义,64个字符以内,仅支持字母、数字、下划线且需保证在商户端不重复。" example: "20150320010101001" type: string passback_params: description: "公用回传参数。\t如果请求时传递了该参数,支付宝会在异步通知时将该参数原样返回。" example: merchantBizType%3d3C%26merchantBizNo%3d2016010101111 type: string product_code: description: "产品码。\t商家和支付宝签约的产品码。 枚举值(点击查看签约情况):\tFACE_TO_FACE_PAYMENT:\ 当面付产品;\t默认值为FACE_TO_FACE_PAYMENT。" example: FACE_TO_FACE_PAYMENT type: string query_options: description: "返回参数选项。 商户通过传递该参数来定制需要额外返回的信息字段,数组格式。包括但不限于:[\"enterprise_pay_info\"\ ,\"hyb_amount\"]" example: "[\"enterprise_pay_info\",\"hyb_amount\"]" items: type: string type: array receiver_address_info: $ref: '#/components/schemas/ReceiverAddressInfo' royalty_info: $ref: '#/components/schemas/RoyaltyInfo' seller_id: description: "卖家支付宝用户ID。\t当需要指定收款账号时,通过该参数传入,如果该值为空,则默认为商户签约账号对应的支付宝用户ID。\ \t收款账号优先级规则:门店绑定的收款账户>请求传入的seller_id>商户签约账号对应的支付宝用户ID;\t注:直付通和机构间联场景下\ seller_id无需传入或者保持跟pid一致;\t如果传入的seller_id与pid不一致,需要联系支付宝小二配置收款关系;" example: "2088102146225135" type: string settle_info: $ref: '#/components/schemas/SettleInfo' store_id: description: "商户门店编号。\t指商户创建门店时输入的门店编号。" example: NJ_001 type: string sub_merchant: $ref: '#/components/schemas/SubMerchant' subject: description: "订单标题。\t注意:不可使用特殊字符,如 /,=,& 等。" example: Iphone6 16G type: string terminal_id: description: 商户机具终端编号。 example: NJ_T_001 type: string time_expire: description: "订单绝对超时时间。\t格式为yyyy-MM-dd HH:mm:ss。\t注:time_expire和timeout_express两\ 者只需传入一个或者都不传,如果两者都传,优先使用time_expire。" example: 2021-12-31 10:05:00 type: string timeout_express: description: "订单相对超时时间。从交易创建时间开始计算。\t该笔订单允许的最晚付款时间,逾期将关闭交易。取值范围:1m~15d。\ m-分钟,h-小时,d-天,1c-当天(1c-当天的情况下,无论交易何时创建,都在0点关闭)。 该参数数值不接受小数点, 如 1.5h,可转\ 换为 90m。\t当面付场景默认值为3h。\t注:time_expire和timeout_express两者只需传入一个或者都不传,如果两者\ 都传,优先使用time_expire。" example: 90m type: string total_amount: description: "订单总金额。\t单位为元,精确到小数点后两位,取值范围:[0.01,100000000] 。" example: "88.88" type: string undiscountable_amount: description: "不可打折金额。\t不参与优惠计算的金额,单位为元,精确到小数点后两位,取值范围[0.01,100000000]。 \t\ 如果同时传入了【可打折金额】、【不可打折金额】和【订单总金额】,则必须满足如下条件:【订单总金额】=【可打折金额】+【不可打折金额】。\t如\ 果订单金额全部参与优惠计算,则【可打折金额】和【不可打折金额】都无需传入。" example: "8.88" type: string type: object AlipayTradeCreateResponseModel: properties: out_trade_no: description: 商户订单号 example: "20150423001001" type: string trade_no: description: 支付宝交易号 example: "2015042321001004720200028594" type: string type: object AlipayTradeCustomsDeclareErrorResponseModel: properties: code: 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 - PAYER_CERT_INFO_ILLEGAL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeCustomsDeclareModel: properties: amount: description: 报关金额,单位为人民币“元”,精确到小数点后2位。 example: "2" type: string buyer_info: $ref: '#/components/schemas/CustomsDeclareBuyerInfo' customs_place: description: 海关编号(大小写皆可)。参见“ 海关编号”。 example: ZONGSHU type: string declare_mode: description: 报关模式,默认可空,1表示需要强校验买家和支付人的身份信息。 example: 1 type: integer deposit_trade_no: description: 定金在支付宝系统中的交易流水号,最长64位。当该参数不为空时,代表为”定金+尾款“报关场景。 example: "2022110322001431071435352949" type: string is_split: description: "商户控制本单是否拆单的报关参数。\r\t仅当该参数传值为T或者t时,才会触发拆单。" example: T type: string merchant_customs_code: description: 商户在海关备案的编号。 example: "737203458" type: string merchant_customs_name: description: 商户海关备案名称。 example: 龙腾国际贸易有限公司 type: string merchant_id: description: 国际站商户标识 example: "2188120005907173" type: string out_request_no: description: "报关流水号。商户生成的用于唯一标识一次报关操作的业务编号。\t建议生成规则:yyyymmdd型8位日期拼接4位序列号\ 。每个报关请求号仅允许传入:数字、英文字母、下划线”_”、短横线”-” 。长度6-64位前后不能有空格" example: "9193457120563834" type: string out_trade_no: description: 国际站外部订单号 example: "1422534255340818295" type: string sub_out_biz_no: description: 拆单报关的商户子订单号。 用于区别拆单时不同子单。拆单时必须传入,否则会报INVALID_PARAMETER错误码。 example: "2015080811223212345453" type: string trade_no: description: 支付宝交易号。该交易在支付宝系统中的交易流水号,最长64位。 example: "2015051446800462" type: string type: object AlipayTradeCustomsDeclareResponseModel: properties: alipay_declare_no: description: 支付宝报关流水号。 example: "2013112611001004680073956707" type: string currency: description: 币种 example: "142" type: string identity_check: description: 订购人身份信息和支付人的身份信息验证结果。T表示商户传入的订购人姓名和身份证号和支付人的姓名和身份证号一致。F代表商户传入的订购人姓名和身份证号和支付人的姓名和身份证号不一致。对于同一笔报关单支付宝只会校验一次,如果多次重推不会返回此参数。 example: T type: string out_trade_no: description: 国际站外部订单号 example: "1422534255340818295" type: string pay_code: description: 支付机构注册号 example: 31222699S7 type: string pay_transaction_id: description: 清算流水号 example: "2019032011082610277150475" type: string total_amount: description: 交易总金额(单位:分) example: "133000" type: string trade_no: description: 支付宝推送到海关的支付单据号。 example: "2013111511001004390000105126" type: string ver_dept: description: "清算机构标志(1-cup,2-null,3-other)" example: "1" type: string type: object AlipayTradeCustomsQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - MAX_OUT_REQUEST_NO_EXCEEDED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeCustomsQueryResponseModel: properties: not_found: description: 不存在记录的报关请求号。多个值用逗号分隔,单次最多10个;每个报关请求号String(32) example: "201506010001,201506010002,201506010003" type: string records: description: 匹配到的列表。每个记录代表一条报关记录 items: $ref: '#/components/schemas/CustomsDeclareRecordInfo' type: array type: object AlipayTradeFastpayRefundQueryErrorResponseModel: properties: code: description: 错误码 enum: - ACQ.SYSTEM_ERROR - ACQ.INVALID_PARAMETER - TRADE_NOT_EXIST - ACQ.TRADE_NOT_EXIST - ACQ.ENTERPRISE_PAY_BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeFastpayRefundQueryModel: properties: org_pid: description: "银行间联模式下有用,其它场景请不要使用;\r\t双联通过该参数指定需要查询的交易所属收单机构的pid;" example: "2088101117952222" type: string out_request_no: description: "退款请求号。\t请求退款接口时,传入的退款请求号,如果在退款请求时未传入,则该值为创建交易时的商户订单号。" example: HZ01RF001 type: string out_trade_no: description: "商户订单号。\t订单支付时传入的商户订单号,和支付宝交易号不能同时为空。 trade_no,out_trade_no如\ 果同时存在优先取trade_no" example: "2014112611001004680073956707" type: string query_options: description: "查询选项,商户通过上送该参数来定制同步需要额外返回的信息字段,数组格式。枚举支持:\trefund_detail_item_list:\ 本次退款使用的资金渠道;\tgmt_refund_pay:退款执行成功的时间;\tdeposit_back_info:银行卡冲退信息;" example: refund_detail_item_list items: type: string type: array trade_no: description: "支付宝交易号。\t和商户订单号不能同时为空" example: "2021081722001419121412730660" type: string type: object AlipayTradeFastpayRefundQueryResponseModel: properties: deposit_back_info: $ref: '#/components/schemas/DepositBackInfo' enterprise_pay_info: $ref: '#/components/schemas/EnterprisePayInfo' error_code: description: 退款失败错误码。只在使用异步退款接口情况下才会返回该字段 example: SELLER_BALANCE_NOT_ENOUGH type: string gmt_refund_pay: description: 退款时间。默认不返回该信息,需要在入参的query_options中指定"gmt_refund_pay"值时才返回该字段信息。 example: 2014-11-27 15:45:57 type: string industry_sepc_detail: description: 行业特殊信息(例如在医保卡支付退款中,医保局向商户返回医疗信息)。 example: "[{\"bizType\":\"REFUND\",\"modelName\":\"tradeCancelContext\"\ ,\"contextData\":{\"response_content\":\"{\\\"WxResToll\\\":{\\\"dealID\\\ \":\\\"\\\",}}\"}}]" type: string out_request_no: description: 本笔退款对应的退款请求号 example: "20150320010101001" type: string out_trade_no: description: 创建交易传入的商户订单号 example: "20150320010101001" type: string present_refund_buyer_amount: description: "本次退款金额中买家退款金额。单位:元。\t该字段默认不返回;" example: "88.88" type: string present_refund_discount_amount: description: "本次退款金额中平台优惠退款金额。单位:元。\t该字段默认不返回;" example: "88.88" type: string present_refund_mdiscount_amount: description: "本次退款金额中商家优惠退款金额。单位:元。\t该字段默认不返回;" example: "88.88" type: string refund_amount: description: 本次退款请求,对应的退款金额。单位:元。 example: "12.33" type: string refund_channel_list: description: 若支付渠道包含医保统筹、个账,则显示退款的渠道信息。如统筹OUTSIDEGOVCARD,个账OUTSIDEACCCARD example: OUTSIDEGOVCARD type: string refund_channel_status: description: 若支付渠道包含医保统筹、个账,全渠道退款成功时返回SUCCESS,全失败时返回FAIL,部分成功时返回PART_SUCCESS example: SUCCESS type: string refund_charge_amount: description: "本次退款针对收款方的退收费金额;单位:元。\t只在机构间联模式下返回,其它场景下不返回该字段;" example: "8.88" type: string refund_charge_info_list: description: 退费信息 items: $ref: '#/components/schemas/RefundChargeInfo' type: array refund_detail_item_list: description: "本次退款使用的资金渠道;\t默认不返回该信息,需要在入参的query_options中指定\"refund_detail_item_list\"\ 值时才返回该字段信息。" items: $ref: '#/components/schemas/TradeFundBill' type: array refund_hyb_amount: description: 本次退款金额中退惠营宝的金额。单位:元。 example: "10.24" type: string refund_reason: description: 发起退款时,传入的退款原因 example: 用户退款请求 type: string refund_royaltys: description: 退分账明细信息,当前仅在直付通产品中返回。 items: $ref: '#/components/schemas/RefundRoyaltyResult' type: array refund_settlement_id: description: "退款清算编号,用于清算对账使用;\t只在机构间联模式下返回,其它场景下不返回该字段;" example: "2018101610032004620239146945" type: string refund_status: description: "退款状态。枚举值:\tREFUND_SUCCESS 退款处理成功;\t未返回该字段表示退款请求未收到或者退款失败;\t\ 注:如果退款查询发起时间早于退款时间,或者间隔退款发起时间太短,可能出现退款查询时还没处理成功,后面又处理成功的情况,建议商户在退款发起后间\ 隔10秒以上再发起退款查询请求。" example: REFUND_SUCCESS type: string send_back_fee: description: "本次商户实际退回金额;单位:元。\t默认不返回该信息,需要在入参的query_options中指定\"refund_detail_item_list\"\ 值时才返回该字段信息。" example: "88" type: string total_amount: description: 该笔退款所对应的交易的订单金额。单位:元。 example: "100.20" type: string trade_no: description: 支付宝交易号 example: "2014112611001004680073956707" type: string type: object AlipayTradeOrderPayErrorResponseModel: properties: code: 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 - ACQ.BUYER_BALANCE_NOT_ENOUGH - ACQ.CREDIT_FULFILLMENT_DELIVERY_UNFINISHED - ACQ.HAVE_PAYMENT_EXIST - ACQ.NO_PAYMENT_INSTRUMENTS_AVAILABLE - ACQ.PAYMENT_FAIL - ACQ.PRODUCT_AMOUNT_LIMIT_ERROR - ACQ.TRADE_NOT_EXIST - ACQ.ZM_ORDER_CHECK_NOT_CREDIT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeOrderPayModel: properties: advance_payment_type: description: "垫资支付模式。支付时需要垫资的场景才传入。具体传参需与支付宝约定。\tCREDIT_FULFILLMENT_ZM 表\ 示先用后付产品履约动作支持芝麻垫资。" example: CREDIT_FULFILLMENT_ZM type: string buyer_id: description: "买家的支付宝用户id\r\t\r\t注:\r\t1.用于校验与已存交易中的买家是否相等" example: "2088202954065786" type: string buyer_open_id: description: "买家支付宝用户唯一标识\t\t注:\t1.用于校验与已存交易中的买家是否相等" example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string buyer_pay_detail: description: "买家支付明细\r\t\r\t目前支持的支付渠道为:\r\t- offline_pos:本次买家使用的是pos刷卡支付\ \r\t\r\t注:\r\t各支付工具金额总和=订单总金额" items: $ref: '#/components/schemas/BuyerPayDetail' type: array fulfillment_amount: description: 本次履约支付金额,单位为元,精确到小数点后两位。履约支付场景才需要传入。 example: "88.88" type: string is_async_pay: description: 是否异步支付,传入true时,表明本次期望走异步支付,会先将支付请求受理下来,再异步推进。商户可以通过交易的异步通知或者轮询交易的状态来确定最终的交易结果 example: true type: boolean order_pay_mode: description: "订单支付模式。特殊支付场景才需要传入。具体传参需与支付宝约定。\tCREDIT_FULFILLMENT_ZM表示基于\ 芝麻授信的履约支付模式,比如芝麻先用后付产品。" example: CREDIT_FULFILLMENT_ZM type: string out_request_no: description: 商户请求号,标识一次请求的唯一id,用于幂等控制。 example: "20200320010101001" type: string product_code: description: 销售产品码 example: SETTLE_OFFLINE_GROUP type: string total_amount: description: "订单总金额,单位为元,精确到小数点后两位,取值范围[0.01,100000000]\r\t\r\t注:\r\t1.用\ 于校验与已存交易中的金额是否相等" example: "88.88" type: string trade_no: description: 支付宝交易号 example: "2018062721001004150200645134" type: string type: object AlipayTradeOrderPayResponseModel: properties: async_payment_mode: description: "异步支付模式。订单使用异步支付模式时才有值。\t目前有五种值: ASYNC_DELAY_PAY(异步延时付款); ASYNC_REALTIME_PAY(异\ 步准实时付款); SYNC_DIRECT_PAY(同步直接扣款); NORMAL_ASYNC_PAY(纯异步付款); QUOTA_OCCUPYIED_ASYNC_PAY(异\ 步支付并且预占了先享后付额度);" example: NORMAL_ASYNC_PAY type: string fulfillment_amount: description: 实际履约金额,单位(元)。仅履约场景才会返回 example: "10.24" type: string gmt_payment: description: 交易支付时间 example: 2021-03-17 09:45:57 type: string out_request_no: description: 商户请求号 example: "20180623001001" type: string out_trade_no: description: 商户订单号 example: "20180623001001" type: string total_amount: description: 订单总金额。元为单元,精确到2位小数。 example: "120.88" type: string trade_no: description: 支付宝交易号 example: "2018062721001004150200645134" type: string type: object AlipayTradeOrderSettleErrorResponseModel: properties: code: 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 - ACQ.ILLEGAL_REQUEST - ACQ.SETTLE_SCENE_NOT_SUPPORT - ACQ.ALLOC_REFUSE_BEFORE_SETTLE - ACQ.ALLOC_REFUSE_AFTER_REFUND type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeOrderSettleModel: properties: extend_params: $ref: '#/components/schemas/SettleExtendParams' operator_id: description: 操作员 ID,商家自定义操作员编号。 example: A0001 type: string out_request_no: description: 结算请求流水号,由商家自定义。32个字符以内,仅可包含字母、数字、下划线。需保证在商户端不重复。 example: "20160727001" type: string royalty_mode: description: 分账模式,目前有两种分账同步执行sync,分账异步执行async,不传默认同步执行 example: async type: string royalty_parameters: description: "分账明细信息。单独调用分账完结时,可以不传此参数。其他场景必传。\t注意:商家分账场景下分账收入方 trans_in\ \ 只支持支付宝账户,不支持使用 cardAliasNo 卡编号。" items: $ref: '#/components/schemas/OpenApiRoyaltyDetailInfoPojo' type: array trade_no: description: 支付宝订单号 example: "2014030411001007850000672009" type: string type: object AlipayTradeOrderSettleQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - MERCHANT_TRADE_NOT_MATCH - OPENID_APPID_NOT_MATCH type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeOrderSettleQueryResponseModel: properties: operation_dt: description: 分账受理时间 example: 2021-07-30 12:00:00 type: string out_request_no: description: 商户分账请求单号 example: "20210727001" type: string royalty_detail_list: description: 分账明细 items: $ref: '#/components/schemas/RoyaltyDetail' type: array type: object AlipayTradeOrderSettleResponseModel: properties: settle_no: description: 支付宝分账单号,可以根据该单号查询单次分账请求执行结果 example: "20210718002530070036530006474222" type: string trade_no: description: 支付宝交易号 example: "2015070921001004130000127422" type: string type: object AlipayTradeOrderinfoSyncErrorResponseModel: properties: code: description: 错误码 enum: - ACQ.SYSTEM_ERROR - ACQ.INVALID_PARAMETER - ACQ.TRADE_NOT_EXIST - ACQ.NOTIFY_STATUS_INVALID type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeOrderinfoSyncModel: properties: biz_type: description: "交易信息同步对应的业务类型,具体值与支付宝约定;\r\t信用授权场景下传CREDIT_AUTH\r\t信用代扣场景下\ 传CREDIT_DEDUCT" example: CREDIT_AUTH type: string order_biz_info: description: "商户传入同步信息,具体值要和支付宝约定;用于芝麻信用租车、单次授权等信息同步场景,格式为json格式。\t状态枚举如\ 下:\t\tCOMPLETE:同步用户已履约\t适用场景:发起扣款后,芝麻生成待履约记录,如果用户通过其他方式完成订单支付,请反馈该状态,芝\ 麻将完结待履约记录对用户形成一条良好履约记录;同步该状态时需要同步调用 取消扣款 接口关闭交易订单。\t\tCLOSED: 同步履约已取消\t\ 适用场景:发起扣款后,芝麻生成待履约记录,如果发现该笔扣款无效需要取消,请反馈该状态,芝麻将取消用户待履约记录;同步该状态时需要同步调用 取\ 消扣款 接口关闭交易订单。" example: "{\"status\":\"COMPLETE\"}" type: string orig_request_no: description: 原始业务请求单号。如对某一次退款进行履约时,该字段传退款时的退款请求号 example: HZ01RF001 type: string out_request_no: description: 外部请求号,商家自定义且保证商家系统中唯一。需要注意的是,支付宝会对外部请求号做幂等控制,如果一笔交易再次使用相同的外部请求号发起请求,订单信息不会更新。 example: HZ01RF001 type: string trade_no: description: 支付宝交易号 example: "2018061021001004680073956707" type: string type: object AlipayTradeOrderinfoSyncResponseModel: properties: buyer_open_id: description: 买家支付宝用户唯一标识 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string buyer_user_id: description: 买家在支付宝的用户id example: "2088101117955611" type: string out_trade_no: description: 商户订单号 example: "20180610010101001" type: string trade_no: description: 支付宝交易号 example: "20180610121001004680073956707" type: string type: object AlipayTradeOverseasSettleErrorResponseModel: properties: code: 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 - ILLEGAL_REQUEST - CONFIRM_REFUSE_AFTER_REFUND type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeOverseasSettleModel: properties: amount: description: 跨境结算的人民币金额,单位为元;等于交易金额 (实际为实收金额),加上净补差金额,减去已退款金额,减去净收费金额,再减去净分账金额, example: "3.14" type: string extend_params: $ref: '#/components/schemas/OverseasExtendParams' foreign_settle_currency: description: 跨境结算的外币币种 example: USD type: string out_request_no: description: 外部请求号,开发者自行生成并保证唯一性,作为业务幂等性控制 example: "20160727001" type: string trade_no: description: 支付宝交易号 example: "2020121921001004130000127421" type: string type: object AlipayTradeOverseasSettleResponseModel: properties: exchange_rate: description: 本笔跨境结算使用的汇率,精度 8 位小数 example: "6.83950000" type: string foreign_settle_amount: description: 本次跨境结算的实际结算外币金额 example: "1.00" type: string foreign_settle_currency: description: 本笔跨境结算实际结算的外币币种 example: USD type: string out_request_no: description: 请求流水号,开发者自行生成并保证唯一性,作为业务幂等性控制 example: "20160727001" type: string settle_amount: description: 本次跨境结算的实际结算人民币金额 example: "6.00" type: string trade_no: description: 支付宝交易号 example: "2020121921001004130000127421" type: string type: object AlipayTradePayErrorResponseModel: properties: code: 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 - ACQ.UN_SUPPORT_TRADE_SCENE - ACQ.OVER_MAX_DEDUCT_COUNT - ACQ.OVER_MAX_UNDER_WAY_DEDUCT_COUNT - ACQ.OVER_DEDUCT_PERIOD - ACQ.OVER_MERCHANT_DAILY_DEDUCT_AMOUNT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradePayModel: properties: advance_payment_type: description: "支付模式类型,若值为ENJOY_PAY_V2表示当前交易允许走先享后付2.0垫资" example: ENJOY_PAY_V2 type: string agreement_params: $ref: '#/components/schemas/AgreementParams' alipay_store_id: description: "支付宝店铺编号。\t指商户创建门店后支付宝生成的门店ID。" example: "2016041400077000000003314986" type: string auth_code: description: "支付授权码。\t当面付场景传买家的付款码(25~30开头的长度为16~24位的数字,实际字符串长度以开发者获取的付款\ 码长度为准)或者刷脸标识串(fp开头的35位字符串);\t周期扣款或代扣场景无需传入,协议号通过agreement_params参数传递;\ \ \t支付宝预授权和新当面资金授权场景无需传入,授权订单号通过 auth_no字段传入。\t注:交易的买家与卖家不能相同。" example: "28763443825664394" type: string auth_confirm_mode: description: "预授权确认模式。\t适用于支付宝预授权和新当面资金授权场景。枚举值:\tCOMPLETE:转交易完成后解冻剩余冻结金\ 额;\tNOT_COMPLETE:转交易完成后不解冻剩余冻结金额;\t默认值为NOT_COMPLETE。" example: COMPLETE type: string auth_no: description: "资金预授权单号。\t支付宝预授权和新当面资金授权场景下必填。" example: "2016110310002001760201905725" type: string bkagent_req_info: $ref: '#/components/schemas/BkAgentReqInfo' body: description: "订单附加信息。\t如果请求时传递了该参数,将在异步通知、对账单中原样返回,同时会在商户和用户的pc账单详情中作为交易\ 描述展示" example: Iphone6 16G type: string business_params: $ref: '#/components/schemas/BusinessParams' buyer_id: description: "买家支付宝用户ID。\t支付宝预授权和新当面资金授权场景下必填,其它场景不需要传入。" example: "2088202954065786" type: string buyer_open_id: description: 买家支付宝用户唯一标识 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string disable_pay_channels: description: "禁用支付渠道。\t多个渠道以逗号分割,如同时禁用信用支付类型和积分,则传入:\"credit_group,point\"\ 。\t支持传入的值:渠道列表" example: credit_group type: string discountable_amount: description: "可打折金额。\t参与优惠计算的金额,单位为元,精确到小数点后两位,取值范围[0.01,100000000]。 \t如\ 果同时传入了【可打折金额】、【不可打折金额】和【订单总金额】,则必须满足如下条件:【订单总金额】=【可打折金额】+【不可打折金额】。\t如果\ 订单金额全部参与优惠计算,则【可打折金额】和【不可打折金额】都无需传入。" example: "80.00" type: string ext_user_info: $ref: '#/components/schemas/ExtUserInfo' extend_params: $ref: '#/components/schemas/ExtendParams' goods_detail: description: 订单包含的商品列表信息,json格式。 items: $ref: '#/components/schemas/GoodsDetail' type: array is_async_pay: description: "是否异步支付,传入true时,表明本次期望走异步支付,会先将支付请求受理下来,再异步推进。商户可以通过交易的异步通知\ 或者轮询交易的状态来确定最终的交易结果。\t只在代扣场景下有效,其它场景无需传入。" example: false type: boolean merchant_order_no: description: 商户的原始订单号 example: "201008123456789" type: string notify_url: description: 通知地址 type: string operator_id: description: 商户操作员编号。 example: yx_001 type: string out_trade_no: description: "商户订单号。\t由商家自定义,64个字符以内,仅支持字母、数字、下划线且需保证在商户端不重复。" example: "20150320010101001" type: string passback_params: description: "公用回传参数。\t如果请求时传递了该参数,支付宝会在异步通知时将该参数原样返回。" example: merchantBizType%3d3C%26merchantBizNo%3d2016010101111 type: string pay_params: $ref: '#/components/schemas/PayParams' product_code: 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 type: string promo_params: $ref: '#/components/schemas/PromoParam' query_options: description: "返回参数选项。\t商户通过传递该参数来定制同步需要额外返回的信息字段,数组格式。包括但不限于:[\"fund_bill_list\"\ ,\"voucher_detail_list\",\"enterprise_pay_info\",\"discount_goods_detail\"\ ,\"discount_amount\",\"mdiscount_amount\"]" example: voucher_detail_list items: type: string type: array request_org_pid: description: 收单机构(例如银行)的标识,填写该机构在支付宝的pid。只在机构间联场景下传递该值。 example: "2088201916734621" type: string royalty_info: $ref: '#/components/schemas/RoyaltyInfo' scene: description: "支付场景。枚举值:\tbar_code:当面付条码支付场景;\tsecurity_code:当面付刷脸支付场景,对应\ 的auth_code为fp开头的刷脸标识串;\t周期扣款或代扣场景无需传入,协议号通过agreement_params参数传递; \t支付宝\ 预授权和新当面资金授权场景无需传入,授权订单号通过 auth_no字段传入。\t默认值为bar_code。" example: bar_code type: string seller_id: description: "卖家支付宝用户ID。\t当需要指定收款账号时,通过该参数传入,如果该值为空,则默认为商户签约账号对应的支付宝用户ID。\ \t收款账号优先级规则:门店绑定的收款账户>请求传入的seller_id>商户签约账号对应的支付宝用户ID;\t注:直付通和机构间联场景下\ seller_id无需传入或者保持跟pid一致;\t如果传入的seller_id与pid不一致,需要联系支付宝小二配置收款关系;\t支付宝预\ 授权和新当面资金授权场景下必填。" example: "2088102146225135" type: string settle_currency: 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 type: string settle_info: $ref: '#/components/schemas/SettleInfo' store_id: description: "商户门店编号。\t指商户创建门店时输入的门店编号。" example: NJ_001 type: string sub_merchant: $ref: '#/components/schemas/SubMerchant' subject: description: "订单标题。\t注意:不可使用特殊字符,如 /,=,& 等。" example: Iphone6 16G type: string terminal_id: description: 商户机具终端编号。 example: NJ_T_001 type: string terminal_params: 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\"}" type: string time_expire: description: "订单绝对超时时间。\t格式为yyyy-MM-dd HH:mm:ss。超时时间范围:1m~15d。\t注:time_expire和\ timeout_express两者只需传入一个或者都不传,如果两者都传,优先使用time_expire。" example: 2021-12-31 10:05:00 type: string timeout_express: description: "订单相对超时时间。从交易创建时间开始计算。\t\t该笔订单允许的最晚付款时间,逾期将关闭交易。取值范围:1m~15d。\ m-分钟,h-小时,d-天,1c-当天(1c-当天的情况下,无论交易何时创建,都在0点关闭)。 该参数数值不接受小数点, 如 1.5h,可转\ 换为 90m。\t\t当面付场景默认值为3h;\t\t其它场景默认值为15d;" example: 90m type: string total_amount: description: "订单总金额。\t单位为元,精确到小数点后两位,取值范围:[0.01,100000000] 。" example: "88.88" type: string trans_currency: 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 type: string undiscountable_amount: description: "不可打折金额。\t不参与优惠计算的金额,单位为元,精确到小数点后两位,取值范围[0.01,100000000]。 \t\ 如果同时传入了【可打折金额】、【不可打折金额】和【订单总金额】,则必须满足如下条件:【订单总金额】=【可打折金额】+【不可打折金额】。\t如\ 果订单金额全部参与优惠计算,则【可打折金额】和【不可打折金额】都无需传入。" example: "8.88" type: string type: object AlipayTradePayResponseModel: properties: advance_amount: description: "先享后付2.0垫资金额,不返回表示没有走垫资,非空表示垫资支付的金额" example: "88.8" type: string async_payment_mode: description: "异步支付模式,目前有五种值:\tASYNC_DELAY_PAY(异步延时付款);\tASYNC_REALTIME_PAY(异\ 步准实时付款);\tSYNC_DIRECT_PAY(同步直接扣款);\tNORMAL_ASYNC_PAY(纯异步付款);\tQUOTA_OCCUPYIED_ASYNC_PAY(异\ 步支付并且预占了先享后付额度);" example: SYNC_DIRECT_PAY type: string auth_trade_pay_mode: description: 预授权支付模式,该参数仅在信用预授权支付场景下返回。信用预授权支付:CREDIT_PREAUTH_PAY example: CREDIT_PREAUTH_PAY type: string bkagent_resp_info: $ref: '#/components/schemas/BkAgentRespInfo' business_params: description: "商户传入业务信息,具体值要和支付宝约定\r\t将商户传入信息分发给相应系统,应用于安全,营销等参数直传场景\r\t格\ 式为json格式" example: "{\"data\":\"123\"}" type: string buyer_logon_id: description: 买家支付宝账号 example: 159****5620 type: string buyer_open_id: description: 买家支付宝用户唯一标识 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string buyer_pay_amount: description: 买家付款的金额 example: "8.88" type: string buyer_user_id: description: 买家在支付宝的用户id example: "2088101117955611" type: string buyer_user_name: description: "买家名称;\r\t买家为个人用户时为买家姓名,买家为企业用户时为企业名称;\r\t默认不返回该信息,需与支付宝约定后\ 配置返回;" example: 菜鸟网络有限公司 type: string buyer_user_type: description: 买家用户类型。 example: PRIVATE type: string can_turn_to_app_pay: description: 是否可以转为app支付,仅当商户代扣失败场景才会返回该字段信息 example: "true" type: string card_balance: description: 支付宝卡余额 example: "98.23" type: string charge_amount: description: "该笔交易针对收款方的收费金额;\t只在机构间联模式下返回,其它场景下不返回该字段;" example: "8.88" type: string charge_flags: 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 type: string charge_info_list: $ref: '#/components/schemas/ChargeInfo' credit_biz_order_id: description: 信用业务单号。信用支付场景才有值。先用后付产品里是芝麻订单号。 example: ZMCB99202103310000450000041833 type: string credit_pay_mode: description: 信用支付模式。表示订单是采用信用支付方式(支付时买家没有出资,需要后续履约)。"creditAdvanceV2"表示芝麻先用后付模式,用户后续需要履约扣款。 此字段只有信用支付场景才有值,商户需要根据字段值单独处理。此字段以后可能扩展其他值,建议商户使用白名单方式识别,对于未识别的值做失败处理,并联系支付宝技术支持人员。 example: creditAdvanceV2 type: string discount_amount: description: 平台优惠金额 example: "88.88" type: string discount_goods_detail: description: "本次交易支付所使用的单品券优惠的商品优惠信息。\t只有在query_options中指定时才返回该字段信息。" example: "[{\"goods_id\":\"STANDARD1026181538\",\"goods_name\":\"雪碧\",\"\ discount_amount\":\"100.00\",\"voucher_id\":\"2015102600073002039000002D5O\"\ }]" type: string enterprise_pay_info: $ref: '#/components/schemas/EnterprisePayInfo' fund_bill_list: description: "交易支付使用的资金渠道。\t只有在签约中指定需要返回资金明细,或者入参的query_options中指定时才返回该字\ 段信息。" items: $ref: '#/components/schemas/TradeFundBill' type: array gmt_payment: description: 交易支付时间 example: 2014-11-27 15:45:57 type: string hyb_amount: description: 惠营宝回票金额 example: "10.24" type: string invoice_amount: description: 交易中可给用户开具发票的金额 example: "12.50" type: string mdiscount_amount: description: 商家优惠金额 example: "88.88" type: string open_id: description: "买家支付宝用户号,该参数已废弃,请不要使用" example: "2088102122524333" type: string out_trade_no: description: 商户订单号 example: "6823789339978248" type: string pay_amount: description: 支付币种订单金额 example: "580.04" type: string pay_currency: description: 支付币种 example: CNY type: string point_amount: description: 使用集分宝付款的金额 example: "8.12" type: string receipt_amount: description: 实收金额 example: "88.88" type: string receipt_currency_type: description: 收款资金类型,当交易收款资金为数字人民币时返回值为“DC”,否则不返回该字段。 example: DC type: string settle_amount: description: 结算币种订单金额 example: "88.88" type: string settle_currency: 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 type: string settle_trans_rate: description: 结算币种兑换标价币种汇率 example: "1" type: string settlement_id: description: "支付清算编号,用于清算对账使用;\t只在机构间联模式下返回,其它场景下不返回该字段;" example: "2018101610032004620239146945" type: string store_name: description: 发生支付交易的商户门店名称 example: 证大五道口店 type: string total_amount: description: 交易金额 example: "120.88" type: string trade_no: description: 支付宝交易号 example: "2013112011001004330000121536" type: string trans_currency: 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 type: string trans_pay_rate: description: 标价币种兑换支付币种汇率 example: "6.5261" type: string voucher_detail_list: description: "本交易支付时使用的所有优惠券信息。\t只有在query_options中指定时才返回该字段信息。" items: $ref: '#/components/schemas/VoucherDetail' type: array type: object AlipayTradePrecreateErrorResponseModel: properties: code: 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 - ACQ.MERCHANT_STATUS_NOT_NORMAL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradePrecreateModel: properties: alipay_store_id: description: "支付宝店铺编号。\t指商户创建门店后支付宝生成的门店ID。" example: "2016052600077000000015640104" type: string bkagent_req_info: $ref: '#/components/schemas/BkAgentReqInfo' body: description: "订单附加信息。\t如果请求时传递了该参数,将在异步通知、对账单中原样返回,同时会在商户和用户的pc账单详情中作为交易\ 描述展示" example: Iphone6 16G type: string business_params: $ref: '#/components/schemas/BusinessParams' buyer_logon_id: description: 买家支付宝账号 example: "15901825620" type: string code_type: description: 码类型,如果请求时传入了share_code,将在响应参数返回吱口令;如果为空,则默认为订单码 example: share_code type: string disable_pay_channels: description: "禁用渠道,用户不可用指定渠道支付,多个渠道以逗号分割\t注,与enable_pay_channels互斥\t渠道列表" example: "pcredit,moneyFund,debitCardExpress" type: string discountable_amount: description: "可打折金额。\t参与优惠计算的金额,单位为元,精确到小数点后两位,取值范围[0.01,100000000]。 \t如\ 果同时传入了【可打折金额】、【不可打折金额】和【订单总金额】,则必须满足如下条件:【订单总金额】=【可打折金额】+【不可打折金额】。\t如果\ 订单金额全部参与优惠计算,则【可打折金额】和【不可打折金额】都无需传入。" example: "80.00" type: string enable_pay_channels: description: "指定支付渠道。\t用户只能使用指定的渠道进行支付,多个渠道以逗号分割。\t与disable_pay_channels互\ 斥,支持传入的值:渠道列表。\t注:如果传入了指定支付渠道,则用户只能用指定内的渠道支付,包括营销渠道也要指定才能使用。该参数可能导致用户支付受限,\ 慎用。" example: "pcredit,moneyFund,debitCardExpress" type: string ext_user_info: $ref: '#/components/schemas/ExtUserInfo' extend_params: $ref: '#/components/schemas/ExtendParams' goods_detail: description: 订单包含的商品列表信息.json格式. 其它说明详见:“商品明细说明” items: $ref: '#/components/schemas/GoodsDetail' type: array merchant_order_no: description: 商户的原始订单号 example: "20161008001" type: string notify_url: description: 通知地址 type: string operator_id: description: 商户操作员编号。 example: yx_001 type: string out_trade_no: description: "商户订单号。\t由商家自定义,64个字符以内,仅支持字母、数字、下划线且需保证在商户端不重复。" example: "20150320010101001" type: string passback_params: description: "公用回传参数。\t如果请求时传递了该参数,支付宝会在异步通知时将该参数原样返回。" example: merchantBizType%3d3C%26merchantBizNo%3d2016010101111 type: string product_code: description: "产品码。\t商家和支付宝签约的产品码。 枚举值(点击查看签约情况):\tFACE_TO_FACE_PAYMENT:\ 当面付产品;\t默认值为FACE_TO_FACE_PAYMENT。" example: FACE_TO_FACE_PAYMENT type: string qr_code_timeout_express: description: "二维码订单相对超时时间。\t该笔订单允许的最晚付款时间,逾期将关闭交易,从生成二维码开始计时。 取值范围:1m~15d。\ m-分钟,h-小时,d-天,1c-当天(1c-当天的情况下,无论交易何时创建,都在0点关闭)。 该参数数值不接受小数点, 如 1.5h,可转\ 换为 90m。\t注:二维码最长有效期是2小时,不管该参数传递的值是多少,超过2小时后二维码都将失效不能再进行扫码支付。" example: 90m type: string query_options: description: "返回参数选项。 商户通过传递该参数来定制需要额外返回的信息字段,数组格式。包括但不限于:[\"hyb_amount\"\ ,\"enterprise_pay_info\"]" example: "[\"hyb_amount\",\"enterprise_pay_info\"]" items: type: string type: array royalty_info: $ref: '#/components/schemas/RoyaltyInfo' seller_id: description: "卖家支付宝用户ID。\t当需要指定收款账号时,通过该参数传入,如果该值为空,则默认为商户签约账号对应的支付宝用户ID。\ \t收款账号优先级规则:门店绑定的收款账户>请求传入的seller_id>商户签约账号对应的支付宝用户ID;\t注:直付通和机构间联场景下\ seller_id无需传入或者保持跟pid一致;\t如果传入的seller_id与pid不一致,需要联系支付宝小二配置收款关系;" example: "2088102146225135" type: string settle_info: $ref: '#/components/schemas/SettleInfo' store_id: description: "商户门店编号。\t指商户创建门店时输入的门店编号。" example: NJ_001 type: string sub_merchant: $ref: '#/components/schemas/SubMerchant' subject: description: "订单标题。\t注意:不可使用特殊字符,如 /,=,& 等。" example: Iphone6 16G type: string terminal_id: description: 商户机具终端编号。 example: NJ_T_001 type: string time_expire: description: "订单绝对超时时间。\t格式为yyyy-MM-dd HH:mm:ss。\t注:time_expire和timeout_express两\ 者只需传入一个或者都不传,如果两者都传,优先使用time_expire。" example: 2021-12-31 10:05:00 type: string timeout_express: 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 type: string total_amount: description: "订单总金额。\t单位为元,精确到小数点后两位,取值范围:[0.01,100000000] 。" example: "88.88" type: string undiscountable_amount: description: "不可打折金额。\t不参与优惠计算的金额,单位为元,精确到小数点后两位,取值范围[0.01,100000000]。 \t\ 如果同时传入了【可打折金额】、【不可打折金额】和【订单总金额】,则必须满足如下条件:【订单总金额】=【可打折金额】+【不可打折金额】。\t如\ 果订单金额全部参与优惠计算,则【可打折金额】和【不可打折金额】都无需传入。" example: "8.88" type: string type: object AlipayTradePrecreateResponseModel: properties: out_trade_no: description: 商户的订单号 example: "6823789339978248" type: string qr_code: description: 当前预下单请求生成的二维码码串,有效时间2小时,可以用二维码生成工具根据该码串值生成对应的二维码 example: https://qr.alipay.com/bavh4wjlxf12tper3a type: string share_code: description: 当前预下单请求生成的吱口令码串,有效时间2小时,可以在支付宝app端访问对应内容 example: chb4n8A94Qc type: string type: object AlipayTradeQueryErrorResponseModel: properties: code: description: 错误码 enum: - ACQ.SYSTEM_ERROR - ACQ.INVALID_PARAMETER - ACQ.TRADE_NOT_EXIST - ACQ.ENTERPRISE_PAY_BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeQueryModel: properties: org_pid: description: "银行间联模式下有用,其它场景请不要使用;\r\t双联通过该参数指定需要查询的交易所属收单机构的pid;" example: "2088101117952222" type: string out_trade_no: description: "订单支付时传入的商户订单号,和支付宝交易号不能同时为空。\r\ttrade_no,out_trade_no如果同时存\ 在优先取trade_no" example: "20150320010101001" type: string query_options: description: "查询选项,商户传入该参数可定制本接口同步响应额外返回的信息字段,数组格式。支持枚举如下:trade_settle_info:\ 返回的交易结算信息,包含分账、补差等信息;\tfund_bill_list:交易支付使用的资金渠道;\tvoucher_detail_list:\ 交易支付时使用的所有优惠券信息;\tdiscount_goods_detail:交易支付所使用的单品券优惠的商品优惠信息;\tmdiscount_amount:\ 商家优惠金额;\tmedical_insurance_info:医保信息;" example: trade_settle_info items: type: string type: array trade_no: description: 支付宝交易号,和商户订单号不能同时为空 example: 2014112611001004680 073956707 type: string type: object AlipayTradeQueryResponseModel: properties: additional_status: description: "交易附加状态:\tSELLER_NOT_RECEIVED(买家已付款,卖家未收款);" example: SELLER_NOT_RECEIVED type: string alipay_store_id: description: 支付宝店铺编号 example: "2015040900077001000100001232" type: string alipay_sub_merchant_id: description: "间连商户在支付宝端的商户编号;\t 只在银行间联交易场景下返回该信息;" example: "2088301372182171" type: string auth_trade_pay_mode: description: 预授权支付模式,该参数仅在信用预授权支付场景下返回。信用预授权支付:CREDIT_PREAUTH_PAY example: CREDIT_PREAUTH_PAY type: string biz_settle_mode: description: 账期结算标识,指已完成支付的订单会进行账期管控,不会实时结算。该参数目前会在使用小程序交易组件场景下返回 example: PERIOD type: string bkagent_resp_info: $ref: '#/components/schemas/BkAgentRespInfo' body: description: "订单描述;\t只在银行间联交易场景下返回该信息;" example: Iphone6 16G type: string buyer_logon_id: description: 买家支付宝账号 example: 159****5620 type: string buyer_open_id: description: 买家支付宝用户唯一标识 example: 01501o8f93I3nJAGB1jG4ONxtxV25DCN3Gec3uggnC4CJU0 type: string buyer_pay_amount: description: 买家实付金额,单位为元,两位小数。该金额代表该笔交易买家实际支付的金额,不包含商户折扣等金额 example: "8.88" type: string buyer_user_id: description: 买家在支付宝的用户id example: "2088101117955611" type: string buyer_user_name: description: "买家名称;\r\t买家为个人用户时为买家姓名,买家为企业用户时为企业名称;\r\t默认不返回该信息,需与支付宝约定后\ 配置返回;" example: 菜鸟网络有限公司 type: string buyer_user_type: description: 买家用户类型。CORPORATE:企业用户;PRIVATE:个人用户。 example: PRIVATE type: string charge_amount: description: "该笔交易针对收款方的收费金额;单位:元。\t 只在银行间联交易场景下返回该信息;" example: "8.88" type: string charge_flags: 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 type: string charge_info_list: description: 计费信息列表 items: $ref: '#/components/schemas/ChargeInfo' type: array credit_biz_order_id: description: 信用业务单号。信用支付场景才有值,先用后付产品里是芝麻订单号。 example: ZMCB99202103310000450000041833 type: string credit_pay_mode: description: 信用支付模式。表示订单是采用信用支付方式(支付时买家没有出资,需要后续履约)。"creditAdvanceV2"表示芝麻先用后付模式,用户后续需要履约扣款。 此字段只有信用支付场景才有值,商户需要根据字段值单独处理。此字段以后可能扩展其他值,建议商户使用白名单方式识别,对于未识别的值做失败处理,并联系支付宝技术支持人员。 example: creditAdvanceV2 type: string discount_amount: description: 平台优惠金额。单位:元。 example: "88.88" type: string discount_goods_detail: description: "本次交易支付所使用的单品券优惠的商品优惠信息。\t只有在query_options中指定时才返回该字段信息。" example: "[{\"goods_id\":\"STANDARD1026181538\",\"goods_name\":\"雪碧\",\"\ discount_amount\":\"100.00\",\"voucher_id\":\"2015102600073002039000002D5O\"\ }]" type: string enterprise_pay_info: $ref: '#/components/schemas/EnterprisePayInfo' ext_infos: description: "交易额外信息,特殊场景下与支付宝约定返回。\tjson格式。" example: "{\"action\":\"cancel\"}" type: string fulfillment_detail_list: description: 履约详情列表。 只有入参的query_options中指定fulfillment_detail_list并且所查询的交易存在履约明细时才返回该字段信息。 items: $ref: '#/components/schemas/FulfillmentDetail' type: array fund_bill_list: description: "交易支付使用的资金渠道。\t只有在签约中指定需要返回资金明细,或者入参的query_options中指定时才返回该字\ 段信息。" items: $ref: '#/components/schemas/TradeFundBill' type: array hb_fq_pay_info: $ref: '#/components/schemas/HbFqPayInfo' hyb_amount: description: 惠营宝回票金额。单位:元。 example: "10.24" type: string industry_sepc_detail: description: 行业特殊信息(例如在医保卡支付业务中,向用户返回医疗信息)。 example: "{\"registration_order_pay\":{\"brlx\":\"1\",\"cblx\":\"1\"}}" type: string industry_sepc_detail_acc: description: 行业特殊信息-个账相关 example: "{\"registration_order_pay\":{\"brlx\":\"1\",\"cblx\":\"1\"}}" type: string industry_sepc_detail_gov: description: 行业特殊信息-统筹相关 example: "{\"registration_order_pay\":{\"brlx\":\"1\",\"cblx\":\"1\"}}" type: string intact_charge_info_list: description: 完整的收费信息 items: $ref: '#/components/schemas/IntactChargeInfo' type: array invoice_amount: description: 交易中用户支付的可开具发票的金额,单位为元,两位小数。该金额代表该笔交易中可以给用户开具发票的金额 example: "12.11" type: string mdiscount_amount: description: 商家优惠金额。单位:元。 example: "88.88" type: string medical_insurance_info: description: "医保信息。入参的query_options中指定时才返回该字段信息。medicareCardType:医保卡类型,\"\ 1\":\"亲情支付\",\"0\":\"本人支付\",为空默认为本人支付;medicareCardHolderHiddenName:医保卡\ 持卡人姓名。" example: "\"{\\\"medicareCardType\\\":\\\"1\\\",\\\"medicareCardHolderHiddenName\\\ \":\\\"**华\\\"}\"" type: string open_id: description: 买家支付宝用户号,该字段将废弃,不要使用 example: "2088102122524333" type: string out_trade_no: description: 商家订单号 example: "6823789339978248" type: string passback_params: description: "公用回传参数。\t返回支付时传入的passback_params参数信息" example: merchantBizType%3d3C%26merchantBizNo%3d2016010101111 type: string pay_amount: description: 支付币种订单金额 example: "8.88" type: string pay_currency: description: 订单支付币种 example: CNY type: string payment_info_with_id_list: description: 带支付宝支付id的信息,暂不对外开放 items: $ref: '#/components/schemas/PaymentInfoWithId' type: array point_amount: description: 积分支付的金额,单位为元,两位小数。该金额代表该笔交易中用户使用积分支付的金额,比如集分宝或者支付宝实时优惠等 example: "10" type: string receipt_amount: description: 实收金额,单位为元,两位小数。该金额为本笔交易,商户账户能够实际收到的金额 example: "15.25" type: string receipt_currency_type: description: 收款资金类型,当交易收款资金为数字人民币时返回值为“DC”,否则不返回该字段。 example: DC type: string req_goods_detail: description: 支付请求的商品明细列表 items: $ref: '#/components/schemas/GoodsDetail' type: array send_pay_date: description: 本次交易打款给卖家的时间 example: 2014-11-27 15:45:57 type: string settle_amount: description: 结算币种订单金额 example: "2.96" type: string settle_currency: 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 type: string settle_trans_rate: description: 结算币种兑换标价币种汇率 example: "30.025" type: string settlement_id: description: "支付清算编号,用于清算对账使用;\r\t只在银行间联交易场景下返回该信息;" example: "2018101610032004620239146945" type: string store_id: description: 商户门店编号 example: NJ_S_001 type: string store_name: description: 请求交易支付中的商户店铺的名称 example: 证大五道口店 type: string subject: description: "订单标题;\t 只在银行间联交易场景下返回该信息;" example: Iphone6 16G type: string terminal_id: description: 商户机具终端编号 example: NJ_T_001 type: string total_amount: description: 交易的订单金额,单位为元,两位小数。该参数的值为支付时传入的total_amount example: "88.88" type: string trade_no: description: 支付宝交易号 example: "2013112011001004330000121536" type: string trade_settle_info: $ref: '#/components/schemas/TradeSettleInfo' trade_status: description: 交易状态:WAIT_BUYER_PAY(交易创建,等待买家付款)、TRADE_CLOSED(未付款交易超时关闭,或支付完成后全额退款)、TRADE_SUCCESS(交易支付成功)、TRADE_FINISHED(交易结束,不可退款) example: TRADE_CLOSED type: string trans_currency: 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 type: string trans_pay_rate: description: 标价币种兑换支付币种汇率 example: "0.264" type: string voucher_detail_list: description: "本交易支付时使用的所有优惠券信息。\t只有在query_options中指定时才返回该字段信息。" items: $ref: '#/components/schemas/VoucherDetail' type: array type: object AlipayTradeRefundApplyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeRefundApplyModel: properties: extend_params: 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\"}" type: string notify_url: description: 通知地址 type: string operator_id: description: 商户的操作员编号 example: OP001 type: string out_request_no: description: 标识一次退款请求,同一笔交易多次退款需要保证唯一,如需部分退款,则此参数必传。 example: HZ01RF001 type: string out_trade_no: description: "订单支付时传入的商户订单号,不能和 trade_no同时为空" example: "20150320010101001" type: string refund_amount: description: "需要退款的金额,该金额不能大于订单金额,单位为元,支持两位小数" example: "200.12" type: string refund_fund_details: description: "退款资金明细\r\t注:目前只有SETTLE_OFFLINE_GROUP产品的退款支持该字段" items: $ref: '#/components/schemas/OpenApiRefundFundDetailPojo' type: array refund_reason: description: 退款的原因说明 example: 正常退款 type: string store_id: description: 商户的门店编号 example: NJ_S_001 type: string terminal_id: description: 商户的终端编号 example: NJ_T_001 type: string trade_no: description: 支付宝交易号,和商户订单号不能同时为空 example: "2014112611001004680073956707" type: string type: object AlipayTradeRefundApplyResponseModel: properties: out_request_no: description: 本笔退款对应的退款请求号 example: HZ01RF001 type: string out_trade_no: description: 商户订单号 example: "20150320010101001" type: string refund_amount: description: 本次退款请求,对应的退款金额 example: "200.12" type: string refund_status: description: REFUND_PROCESSING 退款处理中;REFUND_SUCCESS 退款处理成功;REFUND_FAIL 退款失败 example: REFUND_PROCESSING type: string trade_no: description: 支付宝交易号 example: "2014112611001004680073956707" type: string type: object AlipayTradeRefundErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeRefundModel: properties: goods_detail: description: 退款包含的商品列表信息,Json格式。 items: $ref: '#/components/schemas/GoodsDetail' type: array operator_id: description: 商户的操作员编号 example: OP001 type: string org_pid: description: "银行间联模式下有用,其它场景请不要使用;\r\t双联通过该参数指定需要退款的交易所属收单机构的pid;" example: "2088101117952222" type: string out_request_no: description: "退款请求号。\t标识一次退款请求,需要保证在交易号下唯一,如需部分退款,则此参数必传。\t注:针对同一次退款请求,如\ 果调用接口失败或异常了,重试时需要保证退款请求号不能变更,防止该笔交易重复退款。支付宝会保证同样的退款请求号多次请求只会退一次。" example: HZ01RF001 type: string out_trade_no: description: "商户订单号。\t订单支付时传入的商户订单号,商家自定义且保证商家系统中唯一。与支付宝交易号 trade_no 不能同\ 时为空。" example: "20150320010101001" type: string query_options: description: "查询选项。\t商户通过上送该参数来定制同步需要额外返回的信息字段,数组格式。支持:refund_detail_item_list:\ 退款使用的资金渠道;deposit_back_info:触发银行卡冲退信息通知;" example: refund_detail_item_list items: type: string type: array refund_advance_account: description: 指定垫资退款账号主体,可能是用户id或登录名 example: loginname@alitest.com type: string refund_advance_account_type: description: 指定垫资退款账号的类型,取值范围:default,userId,loginName example: loginName type: string refund_amount: description: "退款金额。\t需要退款的金额,该金额不能大于订单金额,单位为元,支持两位小数。\t注:如果正向交易使用了营销,该退款\ 金额包含营销金额,支付宝会按业务规则分配营销和买家自有资金分别退多少,默认优先退买家的自有资金。如交易总金额100元,用户支付时使用了80元\ 自有资金和20元无资金流的营销券,商家实际收款80元。如果首次请求退款60元,则60元全部从商家收款资金扣除退回给用户自有资产;如果再请求退\ 款40元,则从商家收款资金扣除20元退回用户资产以及把20元的营销券退回给用户(券是否可再使用取决于券的规则配置)。" example: "200.12" type: string refund_currency: 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 type: string refund_goods_detail: description: 退款包含的商品列表信息 items: $ref: '#/components/schemas/RefundGoodsDetail' type: array refund_reason: description: "退款原因说明。\t商家自定义,将在会在商户和用户的pc退款账单详情中展示" example: 正常退款 type: string refund_royalty_parameters: description: "退分账明细信息。\t 注: 1.当面付且非直付通模式无需传入退分账明细,系统自动按退款金额与订单金额的比率,从收款方\ 和分账收入方退款,不支持指定退款金额与退款方。 \t2.直付通模式,电脑网站支付,手机 APP 支付,手机网站支付产品,须在退款请求中明确是\ 否退分账,从哪个分账收入方退,退多少分账金额;如不明确,默认从收款方退款,收款方余额不足退款失败。不支持系统按比率退款。" items: $ref: '#/components/schemas/OpenApiRoyaltyDetailInfoPojo' type: array store_id: description: 商户门店编号,由商家自定义。需保证当前商户下唯一。 example: NJ_S_001 type: string terminal_id: description: 商户的终端编号 example: NJ_T_001 type: string trade_no: description: "支付宝交易号。\t和商户订单号 out_trade_no 不能同时为空,两者同时存在时,优先取值trade_no" example: "2014112611001004680073956707" type: string type: object AlipayTradeRefundResponseModel: properties: buyer_logon_id: description: 用户的登录id example: 159****5620 type: string buyer_open_id: description: 买家支付宝用户唯一标识 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string buyer_user_id: description: 买家在支付宝的用户id example: "2088101117955611" type: string fund_change: description: 本次退款是否发生了资金变化 example: "Y" type: string gmt_refund_pay: description: 退款支付时间 example: 2014-11-27 15:45:57 type: string has_deposit_back: description: 是否有银行卡冲退,仅当query_options中传入deposit_back_info时返回 example: "true" type: string open_id: description: 买家支付宝用户号,该参数已废弃,请不要使用 example: "2088102122524333" type: string out_trade_no: description: 商户订单号 example: "6823789339978248" type: string present_refund_buyer_amount: description: "本次退款金额中买家退款金额;单位:元。\t该字段默认不返回;" example: "88.88" type: string present_refund_discount_amount: description: "本次退款金额中平台优惠退款金额;单位:元。\t该字段默认不返回;" example: "88.88" type: string present_refund_mdiscount_amount: description: "本次退款金额中商家优惠退款金额;单位:元。\t该字段默认不返回;" example: "88.88" type: string refund_charge_amount: description: "本次退款针对收款方的退收费金额;单位:元。\t只在机构间联模式下返回,其它场景下不返回该字段;" example: "8.88" type: string refund_charge_info_list: description: 退费信息 items: $ref: '#/components/schemas/RefundChargeInfo' type: array refund_currency: description: 退款币种信息 example: USD type: string refund_detail_item_list: description: "退款使用的资金渠道。\t只有在签约中指定需要返回资金明细,或者入参的query_options中指定时才返回该字段信\ 息。" items: $ref: '#/components/schemas/TradeFundBill' type: array refund_fee: description: "退款总金额。单位:元。\t指该笔交易累计已经退款成功的金额。" example: "88.88" type: string refund_hyb_amount: description: 本次请求退惠营宝金额。单位:元。 example: "10.24" type: string refund_preset_paytool_list: $ref: '#/components/schemas/PresetPayToolInfo' refund_settlement_id: description: "退款清算编号,用于清算对账使用;\t只在机构间联模式下返回,其它场景下不返回该字段;" example: "2018101610032004620239146945" type: string send_back_fee: description: "本次商户实际退回金额。单位:元。\t说明:如需获取该值,需在入参query_options中传入 refund_detail_item_list。" example: "1.8" type: string store_name: description: 交易在支付时候的门店名称 example: 望湘园联洋店 type: string trade_no: description: 支付宝交易号 example: "2013112011001004330000121536" type: string type: object AlipayTradeRoyaltyRateQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - PRODUCT_UNSIGN - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeRoyaltyRateQueryResponseModel: properties: max_ratio: description: 最大分账比例,百分比整数,取值范围0~100 example: 80 type: integer user_id: description: 当前商户userId example: 2088XXXX1234 type: string type: object AlipayTradeRoyaltyRelationBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - PRODUCT_UNSIGN - SYSTEM_ERROR - OPENID_APPID_NOT_MATCH type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeRoyaltyRelationBatchqueryModel: properties: out_request_no: description: 外部请求号,由商家自定义。32个字符以内,仅可包含字母、数字、下划线。需保证在商户端不重复。 example: "2019032200000001" type: string page_num: description: 几页,起始页为 1。不填默认为 1。 example: 1 type: integer page_size: description: "页面大小。每页记录数,取值范围是(0,100]。不填默认为20" example: 20 type: integer type: object AlipayTradeRoyaltyRelationBatchqueryResponseModel: properties: current_page_num: description: 当前页数 example: 1 type: integer current_page_size: description: 当前页面大小 example: 20 type: integer receiver_list: description: 分账收款方列表 items: $ref: '#/components/schemas/RoyaltyEntity' type: array result_code: description: 业务结果码。SUCCESS:分账关系查询成功;FAIL:分账关系查询失败。 example: SUCCESS type: string total_page_num: description: 总页数 example: 10 type: integer total_record_num: description: 分账关系记录总数 example: 480 type: integer type: object AlipayTradeRoyaltyRelationBindErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeRoyaltyRelationBindModel: properties: out_request_no: description: 外部请求号,由商家自定义。32个字符以内,仅可包含字母、数字、下划线。需保证在商户端不重复。 example: "2019032200000001" type: string receiver_list: description: 分账接收方列表,单次传入最多20个 items: $ref: '#/components/schemas/RoyaltyEntity' type: array type: object AlipayTradeRoyaltyRelationBindResponseModel: properties: result_code: description: "SUCCESS:分账关系绑定成功;\tFAIL:分账关系绑定失败。" example: SUCCESS type: string type: object AlipayTradeRoyaltyRelationUnbindErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - PRODUCT_UNSIGN - USER_NOT_EXIST - SYSTEM_ERROR - RECEIVER_LIST_EMPTY - RECEIVER_LIST_OVERLOAD - INVALID_RECEIVER_TYPE - USERNAME_NOT_MATCH type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeRoyaltyRelationUnbindModel: properties: out_request_no: description: 外部请求号,由商家自定义。32个字符以内,仅可包含字母、数字、下划线。需保证在商户端不重复。 example: "2019032200000001" type: string receiver_list: description: 分账接收方列表,单次传入最多 20 个信息。 items: $ref: '#/components/schemas/RoyaltyEntity' type: array type: object AlipayTradeRoyaltyRelationUnbindResponseModel: properties: result_code: description: "业务结果码。SUCCESS:分账关系解绑成功;\tFAIL:分账关系解绑失败。" example: SUCCESS type: string type: object AlipayTradeSettleConfirmErrorResponseModel: properties: code: 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 - ACQ.ILLEGAL_REQUEST - ACQ.CONFIRM_REFUSE_AFTER_REFUND - ACQ.SETTLE_SCENE_NOT_SUPPORT - ACQ.INVALID_STORE_ID - ACQ.SETTLE_ACCOUNT_INVALID type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeSettleConfirmModel: properties: extend_params: $ref: '#/components/schemas/SettleConfirmExtendParams' out_request_no: description: 确认结算请求流水号,开发者自行生成并保证唯一性,作为业务幂等性控制 example: "20160727001" type: string settle_info: $ref: '#/components/schemas/SettleInfo' trade_no: description: 支付宝交易号 example: "2015070921001004130000127421" type: string type: object AlipayTradeSettleConfirmResponseModel: properties: out_request_no: description: 确认结算请求流水号,开发者自行生成并保证唯一性,作为业务幂等性控制 example: "20160727001" type: string settle_amount: description: 本次确认结算的实际结算金额,单位为元。 example: "0.1" type: string trade_no: description: 支付宝交易号 example: "2015070921001004130000127421" type: string type: object AlipayTradeSettleReceivablesQueryErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayTradeSettleReceivablesQueryModel: properties: biz_product: description: 收单产品码,商家和支付宝签约的产品码 example: FACE_TO_FACE_PAYMENT type: string extend_params: description: 扩展参数 example: "{\"key\":\"value\"}" type: string merchant_info: $ref: '#/components/schemas/SettleEntity' out_request_no: description: 外部请求号,32个字符以内,可包含字母、数字、下划线。 example: "2019040100000001" type: string query_his_date: description: "当trade_no不为空时,该字段不生效。\t查询历史日期,格式为 yyyyMMdd ,取值范围为昨日起至往前30日\ 内;\t不传入时,查询实时待结算余额返回;\t传入过去某一天日期,查询对应日期的日终待结算余额返回(注意:日常场景下,昨日日终待结算余额只可\ 在当天 02:00 后查询,在当天 02:00 前查询返回查询错误;大促场景下昨日日终可查时间会适当延后);\t传入过去某一天非近30天内,\ 返回参数错误。" example: "20200313" type: string trade_no: description: 支付宝交易号,当该笔交易为直付通账期模式,查询该笔交易待确认结算金额时必传 example: "2022081722001432461452204877" type: string type: object AlipayTradeSettleReceivablesQueryResponseModel: properties: on_settle_amount: description: 直付通请款模式下的结算在途金额,发起结算后 T+N 日到账场景下的处理中金额,人民币,单位为元 example: "10000.00" type: string unsettled_amount: description: 待结算金额,人民币,单位为元 example: "10000.00" type: string type: object AlipayUserAgreementExecutionplanModifyErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - ILLEGAL_EXECUTION_TIME - ILLEGAL_AGREEMENT - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayUserAgreementExecutionplanModifyModel: properties: agreement_no: description: 周期性扣款产品,授权免密支付协议号 example: "20185909000458725113" type: string deduct_time: description: 商户下一次扣款时间 example: 2019-05-12 type: string memo: description: 具体修改原因 example: 用户已购买半年包,需延期扣款时间 type: string type: object AlipayUserAgreementExecutionplanModifyResponseModel: properties: agreement_no: description: 周期性扣款产品,授权免密支付协议号 example: "20185909000458725113" type: string deduct_time: description: "商户下一次扣款时间,格式 \"yyyy-MM-dd\"。\t例如:用户在1月1日开通了连续包月,使用了10天又另行购\ 买了“季度包”,如果此时商户希望“季度包”立即优先生效,在季度包结束后能继续使用连续包月,那么原定的周期就被延后了。此时可以通过本接口将预计\ 扣款时间推后“季度包”的时长。" example: 2020-05-12 type: string type: object AlipayUserAgreementMigrateErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - MERCHANT_NOT_SUPPORT - AGREEMENT_ALREADY_MIGRATED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayUserAgreementMigrateModel: properties: agreement_no: description: 支付宝系统中用以唯一标识用户签约记录的编号(用户签约成功后的协议号 ) example: "20170322450983769228" type: string target_app_id: description: 需要迁移的目标商户应用id example: "2014072300007148" type: string target_invoke_app_id: description: 需要迁移的目标商户调用应用id example: "2014072300007148" type: string target_partner_id: description: 需要迁移的目标商户id example: "2088101122675263" type: string type: object AlipayUserAgreementMigrateResponseModel: type: object AlipayUserAgreementPermissionCreateErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - ILLEGAL_PARAMS - USER_AGREEMENT_NOT_EXIST - NOT_SUPPORT_MERCHANT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayUserAgreementPermissionCreateModel: properties: agreement_no: description: 支付宝系统中用以唯一标识用户签约记录的编号(用户签约成功后的协议号 ) example: "20170322450983769228" type: string business_params: $ref: '#/components/schemas/BusinessParamsMap' notice_template: description: 目前共两种类型SERVIOCE_NOTICE和DEFAULT_PERMISSION,如果是服务变更提醒,需传入SERVIOCE_NOTICE example: SERVIOCE_NOTICE type: string out_request_no: description: 商户请求号。 由商家自定义,64个字符以内,仅支持字母、数字、下划线且需保证在商户端不重复。 example: "6823789339978248" type: string total_amount: description: "订单总金额。 单位为元,精确到小数点后两位,取值范围:[0.01,100000000] 。" example: "88.88" type: string type: object AlipayUserAgreementPermissionCreateResponseModel: properties: deduct_permission: description: 商户代扣扣款许可 example: "2021571176714791277815457854545" type: string effective_time_end: description: 商户代扣扣款许可生效结束时间 example: yyyyMMddHHmmss type: string effective_time_start: description: 商户代扣扣款许可生效开始时间 example: yyyyMMddHHmmss type: string is_success_send: description: 消息是否发送成功 example: true type: boolean type: object AlipayUserAgreementQueryErrorResponseModel: properties: code: 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 - PARENT_MERCHANT_QUERY_FAIL - MERCHANT_STATUS_IS_NOT_NORMAL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayUserAgreementQueryResponseModel: properties: agreement_no: description: 用户签约成功后的协议号 example: "20170322450983769228" type: string alipay_logon_id: description: 返回脱敏的支付宝账号 example: test***ali@alipay.net type: string credit_auth_mode: description: 授信模式,目前只在花芝代扣(即花芝go)协议时才会返回 example: DEDUCT_HUAZHI type: string device_id: description: 设备Id example: RSED235F875932 type: string external_agreement_no: description: 代扣协议中标示用户的唯一签约号(确保在商户系统中唯一)。当入参中传了此参数时返回。 example: test type: string external_logon_id: description: 外部登录Id。当入参中传了此参数时返回。 example: "2088101118392209" type: string invalid_time: description: 协议失效时间,格式为 yyyy-MM-dd HH:mm:ss。 example: 2117-05-24 00:00:00 type: string last_deduct_time: description: 周期扣协议,上次扣款成功时间 example: 2022-05-15 type: string next_deduct_time: description: 周期扣协议,预计下次扣款时间 example: 2022-06-15 type: string personal_product_code: description: 协议产品码,商户和支付宝签约时确定,不同业务场景对应不同的签约产品码。 example: GENERAL_WITHHOLDING_P type: string pricipal_type: description: 签约主体类型。 example: CARD type: string principal_id: description: "签约主体标识。\t当principal_type为CARD 时,该字段为支付宝用户号;" example: "2088101122675263" type: string principal_open_id: description: "签约主体标识。\t当principal_type为CARD 时,该字段为支付宝用户号;" example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string sign_scene: description: 签约协议的场景。 example: INDUSTRY|CARRENTAL type: string sign_time: description: 协议签约时间,格式为 yyyy-MM-dd HH:mm:ss。 example: 2017-05-24 15:00:40 type: string single_quota: description: 单笔代扣额度 example: "100.00" type: string status: description: "协议当前状态\r\t1. TEMP:暂存,协议未生效过;\r\t2. NORMAL:正常;\r\t3. STOP:暂\ 停" example: NORMAL type: string third_party_type: description: "签约第三方主体类型。对于三方协议,表示当前用户和哪一类的第三方主体进行签约。\t默认为PARTNER。" example: PARTNER type: string valid_time: description: 协议生效时间,格式为 yyyy-MM-dd HH:mm:ss。 example: 2017-05-24 15:00:40 type: string zm_open_id: description: 用户的芝麻信用 openId,供商 户查询用户芝麻信用使用。 example: "268816057852461313538942792" type: string type: object AlipayUserAgreementTransferErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayUserAgreementTransferModel: properties: agreement_no: description: 支付宝系统中用以唯一标识用户签约记录的编号(用户签约成功后的协议号 ),如果传了该参数,其他参数会被忽略 example: "20170322450983769228" type: string period_rule_params: $ref: '#/components/schemas/PeriodRuleParams' target_product_code: description: 协议产品码,商户和支付宝签约时确定,不同业务场景对应不同的签约产品码。这里指的是需要修改目标产品码的值 example: CYCLE_PAY_AUTH_P type: string type: object AlipayUserAgreementTransferResponseModel: properties: amount: description: 单次金额限制,单位为元 example: "100" type: string execute_time: description: 执行时间 example: 2019-01-23 type: string period: description: 周期 example: "7" type: string period_type: description: 周期类型 example: DAY type: string total_amount: description: 总金额限制,单位为元 example: "600" type: string total_payments: description: 总支付次数 example: "12" type: string type: object AlipayUserAgreementUnsignErrorResponseModel: properties: code: 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 - USER_AGREEMENT_STATUS_IS_NOT_NORMAL - ILLEGAL_PARAMS type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayUserAgreementUnsignModel: properties: agreement_no: description: "支付宝系统中用以唯一标识用户签约记录的编号(用户签约成功后的协议号 ),如果传了该参数,其他参数会被忽略\t。\t本\ 参数与 external_agreement_no 不可同时为空。" example: "20170322450983769228" type: string alipay_logon_id: description: 用户的支付宝登录账号,支持邮箱或手机号码格式。本参数与alipay_user_id 不可同时为空,若都填写,则以alipay_user_id 为准。 example: abx@alitest.com type: string alipay_open_id: description: "用户的支付宝账号对应的支付宝唯一用户号,\t本参数与alipay_logon_id 不可同时为空,若都填写,则以本参\ 数为准,优先级高于alipay_logon_id。" example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string alipay_user_id: description: "用户的支付宝账号对应的支付宝唯一用户号,以2088 开头的 16 位纯数字 组成;\r\t本参数与alipay_logon_id\ \ 不可同时为空,若都填写,则以本参数为准,优先级高于alipay_logon_id。" example: "2088101143488930" type: string extend_params: description: 扩展参数 example: "{\"UNSIGN_ERROR_CODE\": \"USER_OWE_MONEY\",\"UNSIGN_ERROR_INFO\"\ :\"10.00\"}" type: string external_agreement_no: description: "代扣协议中标示用户的唯一签约号(确保在商户系统中\t唯一)。\t格式规则:支持大写小写字母和数字,最长 32 位。\t\ 注意:若调用 alipay.user.agreement.page.sign(支付宝个人协议页面签约接口) 签约时传入 external_agreement_no\ \ 则该值必填且需与签约接口传入值相同。" example: test type: string notify_url: description: 通知地址 type: string operate_type: description: 注意:仅异步解约需传入,其余情况无需传递本参数。 example: confirm type: string personal_product_code: description: 协议产品码,商户和支付宝签约时确定,不同业务场景对应不同的签约产品码。 example: GENERAL_WITHHOLDING_P type: string sign_scene: description: "签约协议场景,该值需要与系统/页面签约接口调用时传入的值保持一 致。如:周期扣款场景,需与调用 alipay.user.agreement.page.sign(支\ 付宝个人协议页面签约接口) 签约时的 sign_scene 相同。\t当传入商户签约号 external_agreement_no时,场景不\ 能为空或默认值 DEFAULT|DEFAULT。\t" example: INDUSTRY|MEDICA type: string third_party_type: description: 签约第三方主体类型。对于三方协议,表示当前用户和哪一类的第三方主体进行签约。 example: PARTNER type: string type: object AlipayUserAgreementUnsignResponseModel: type: object AlipayUserAgreementUserverifyApplyErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - USER_AGREEMENT_NOT_EXIST - AGREEMENT_NO_IS_INVALID type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayUserAgreementUserverifyApplyModel: properties: agreement_no: description: 协议号 example: "20170502000610755993" type: string type: object AlipayUserAgreementUserverifyApplyResponseModel: properties: apply_token: description: 用户验证申请token,其格式和内容,由支付宝定义。在鉴权确认的过程中,商户可根据申请操作成功时返回的申请token,获取后续的买家结果 example: MDEDUCT0068292ca377d1d44b65fa24ec9cd89132f type: string type: object AlipayUserAgreementUserverifyQueryErrorResponseModel: properties: code: description: 错误码 enum: - USER_AGREEMENT_NOT_EXIST - AGREEMENT_NO_IS_INVALID - SYSTEM_ERROR - INVALID_PARAMETER - AGREEMENT_NO_IS_NOT_MATCH - APPLY_TOKEN_NOT_EXIST - AUTHOREE_IS_NOT_MATCH type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayUserAgreementUserverifyQueryResponseModel: properties: user_match: description: 用户信息是否匹配 example: true type: boolean type: object AlipayUserAlipaypointBudgetlibQueryErrorResponseModel: properties: code: description: 错误码 enum: - BUDGET_NOT_EXIST - BUDGET_NOT_MATCH_PARTNER - PARAM_ILLEGAL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayUserAlipaypointBudgetlibQueryResponseModel: properties: budget_code: description: 集分宝预算库编码 example: "20201107050844" type: string budget_desc: description: 预算库的中文描述 example: 签到活动预算库 type: string cumulative_amount: description: 预算库累计积分数 example: 1000 type: integer enabled: description: 预算库是否为生效状态标识,true-生效中,false-已失效 example: true type: boolean end_time: description: "预算库结束时间, yyyy-MM-dd HH:mm:ss" example: 2022-11-07 05:08:45 type: string remain_amount: description: 预算库当前剩余积分数 example: 10 type: integer start_time: description: "预算库开始时间, yyyy-MM-dd HH:mm:ss" example: 2020-11-07 05:08:45 type: string type: object AlipayUserAlipaypointSendErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayUserAlipaypointSendModel: properties: budget_code: description: 签约商户的集分宝的预算库,扣除此预算库的集分宝发放给用户。会校验budgetcode和业务方appId的签约商户pid的关联关系,若无关则发放失败。 example: 02559A591572 type: string memo: description: 商户关于该笔发放的描述或者信息补充,仅存储,无实际校验功能,该信息会在"集分宝"小程序的"集分宝明细"中展示给用户。 example: 商户小程序签到送集分宝 type: string open_id: description: 被发放集分宝用户ID,商户app_id维度下的用户标识,与user_account字段二选一。 建议优先使该字段指定发放用户,接口性能更佳 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string partner_biz_no: description: 接入方自己交易的唯一流水ID号,不同交易请保证幂等号唯一性,集分宝服务将依据该字段来进行幂等控制,重试请求不要更换幂等号,需要慎重传递,否则可能会造成损失。 example: "011022222222212" type: string point_amount: description: "发放给用户的集分宝个数。个数区间为 [1,10000000],需为整数。" example: 1 type: integer user_account: description: 被发放集分宝用户的支付宝登录号,邮箱地址或者手机号均可,与user_id字段二选一,在有user_id时,优先使用user_id字段。 example: user_logon_id@test.com/1860000001 type: string user_id: description: "被发放集分宝用户的蚂蚁统一会员ID,与user_account字段二选一。\t建议优先使用user_id,接口性能更\ 佳,user_id和user_account都传递时,系统优先使用本字段。" example: "2088000000000001" type: string type: object AlipayUserAlipaypointSendResponseModel: properties: record_id: description: 发放记录号。 example: 无 type: string transaction_id: description: 对账中心关联订单,一般场景无需关注 example: "2022062910022100195147193863" type: string type: object AlipayUserCertdocCertverifyConsultErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - ILLEGAL_ARGUMENT - IDENTITY_VERIFY_CACHE_EXPIRED - REQUIRED_PARAM_MISSING - GUARDIAN_LIMIT_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayUserCertdocCertverifyConsultResponseModel: properties: fail_params: description: 具体哪些字段不一致。与预授权的输入字段对应,类型为字符串列表的JSON格式。 example: "[\"user_name\"]" type: string fail_reason: description: 校验不一致时,描述不一致的原因 example: 姓名不一致 type: string passed: description: 校验是否一致:T-一致、F-不一致 example: F type: string type: object AlipayUserCertdocCertverifyPreconsultErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - ILLEGAL_ARGUMENT - REQUIRED_PARAM_MISSING - GUARDIAN_LIMIT_ERROR - CERT_TYPE_INVALID type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayUserCertdocCertverifyPreconsultModel: properties: cert_no: description: 证件号 example: "230100199901010001" type: string cert_type: description: 证件类型。暂仅支持 IDENTITY_CARD (身份证)。 example: IDENTITY_CARD type: string ext_info: description: "拓展字段,JSON格式" example: "{}" type: string logon_id: description: 支付宝登录名 example: sample@sample.com type: string mobile: description: 手机号码 example: "13812345678" type: string user_name: description: 真实姓名 example: 张三 type: string type: object AlipayUserCertdocCertverifyPreconsultResponseModel: properties: verify_id: description: 申请验证ID。有效期为 2 小时,过期后在校验接口使用会报错 "校验信息已过期"。 example: 671ffcda5447bc87e9ed2f669eb143d4 type: string type: object AlipayUserCertifyOpenInitializeErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - ILLEGAL_ARGUMENT_FORMAT - ARRANGEMENT_STATUS_ERROR - UNKNOWN_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayUserCertifyOpenInitializeModel: properties: biz_code: description: "认证场景码。入参支持的认证场景码和商户签约的认证场景相关,取值如下:\tFACE:多因子人脸认证\tCERT_PHOTO:\ 多因子证照认证\tCERT_PHOTO_FACE :多因子证照和人脸认证\tSMART_FACE:多因子快捷认证" example: FACE type: string face_contrast_picture: description: 自定义人脸比对图片的base64编码格式的string字符串 example: xydasf== type: string identity_param: $ref: '#/components/schemas/OpenCertifyIdentityParam' merchant_config: $ref: '#/components/schemas/OpenCertifyMerchantConfig' outer_order_no: description: 商户请求的唯一标识,商户要保证其唯一性,值为32位长度的字母数字组合。建议:前面几位字符是商户自定义的简称,中间可以使用一段时间,后段可以使用一个随机或递增序列 example: ZGYD201809132323000001234 type: string type: object AlipayUserCertifyOpenInitializeResponseModel: properties: certify_id: description: 本次申请操作的唯一标识,商户需要记录,后续的操作都需要用到 example: 2109b5e671aa3ff2eb4851816c65828f type: string type: object AlipayUserCertifyOpenQueryErrorResponseModel: properties: code: description: 错误码 enum: - UNKNOWN_ERROR - ILLEGAL_ARGUMENT_FORMAT - CERTIFY_ID_EXPIRED - OPEN_CERTIFY_BILL_NOT_EXIST - OPEN_CERTIFY_BILL_STATUS_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayUserCertifyOpenQueryResponseModel: properties: fail_reason: description: 认证错误原因,扩展字段,默认不返回 example: Z1147 type: string identity_info: description: 认证的主体信息,一般的认证场景返回为空 example: "{}" type: string material_info: description: 认证主体附件信息,主要为图片类材料,一般的认证场景都是返回空 example: "{}" type: string passed: description: 是否通过,通过为T,不通过为F example: T type: string type: object AlipayUserDeliverAddress: properties: address: description: 地址 example: XX路XX号 type: string address_code: description: 区域编码 example: "100" type: string default_deliver_address: description: 是否默认收货地址 example: T type: string deliver_area: description: 区/县 example: 西湖区 type: string deliver_city: description: 市 example: 杭州 type: string deliver_fullname: description: 收货人全名 example: 张三 type: string deliver_mobile: description: 收货地址的联系人移动电话 example: "13833334444" type: string deliver_phone: description: 收货地址的联系人固定电话 example: 0517-28888888 type: string deliver_province: description: 省 example: 浙江 type: string zip: description: 邮编 example: "310000" type: string type: object AlipayUserInfoShareErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayUserInfoShareResponseModel: properties: address: description: 详细地址。 example: 西湖区文三路国际大厦 type: string age: description: 用户年龄,实名认证为T,且证件类型为身份证,则输出年龄字段,否则不输出 example: "45" type: string area: description: 区县名称。 example: 西湖区 type: string avatar: description: "用户头像地址。\t注意:如果没有数据(用户未设置)时不会返回该信息,请做好容错。" example: http://tfsimg.alipay.com/images/partner/T1uIxXXbpXXXXXXXX type: string business_scope: description: 经营/业务范围(用户类型是公司类型时才有此字段)。 example: 餐饮 type: string cert_no: description: 【证件号码】结合证件类型使用.【注意】只is_certified为T的时候才有意义,否则不保证准确性. example: "340928109890871722" type: string cert_type: description: "【证件类型】0:身份证 1:护照 2:军官证 3:士兵证 4:回乡证 5:临时身份证 6:户口簿 7:警官证 8:台\ 胞证 9:营业执照10:其它证件 11:港澳居民来往内地通行证 12:台湾居民来往大陆通行证 13:台湾居民居住证 14:港澳居民居住证\t\ \ 15:港澳身份证 16:外国人永久居住证【注意】只有is_certified为T的时候才有意义,否则不保证准确性." example: "7" type: string city: description: 市名称。 example: 安庆 type: string college_name: description: 学信网返回的学校名称,有可能为空。 example: 南京大学 type: string country_code: description: 国家码 example: CN type: string degree: description: 学信网返回的学历/学位信息,数据质量一般,请谨慎使用,取值包括:博士研究生、硕士研究生、高升本、专科、博士、硕士、本科、夜大电大函大普通班、专科(高职)、第二学士学位。 example: 硕士研究生 type: string deliver_addresses: description: 收货地址列表 items: $ref: '#/components/schemas/AlipayUserDeliverAddress' type: array display_name: description: 展示名称,用于展示和识别用户。返回的值是支付宝账户的可用外标之一,根据展示名称产品规则可能返回手机号/邮箱/支付宝号其中的一个。同一个账户在不同的时期返回的展示名称可能随规则变化而变化。 example: miracle001 type: string email: description: 优先获取email登录名,如果不存在,则返回mobile登录名 example: sss@163.com type: string enrollment_time: description: 入学时间,yyyy-mm-dd格式 example: 2016-01-11 type: string ent_license_address: description: 企业证照地址的详细地址(用户类型是公司用户才有该字段)【注意】只有is_certified为T的时候才有意义,否则不保证准确性. example: 沙河街道庐山北路888号 type: string ent_license_area: description: 企业证照地址所在地区或县(用户类型是公司用户才有该字段)【注意】只有is_certified为T的时候才有意义,否则不保证准确性,目前企业营业执照地址不含县(区),area为空。 example: 庐山区 type: string ent_license_city: description: 企业证照地址所在市(用户类型是公司用户才有该字段)【注意】只有is_certified为T的时候才有意义,否则不保证准确性. example: 九江市 type: string ent_license_province: description: 企业证照地址所在省份(用户类型是公司用户才有该字段)【注意】只有is_certified为T的时候才有意义,否则不保证准确性. example: 江西省 type: string firm_agent_person_cert_expiry_date: description: 企业代理人证件有效期(用户类型是公司类型时才有此字段)。 example: "20201212" type: string firm_agent_person_cert_no: description: 企业代理人证件号码(用户类型是公司类型时才有此字段)。 example: "320322197712211890" type: string firm_agent_person_cert_type: description: "企业代理人证件类型, 返回值参考cert_type字段(用户类型是公司类型时才有此字段)。" example: "0" type: string firm_agent_person_name: description: 企业代理人姓名(用户类型是公司类型时才有此字段)。 example: 王五 type: string firm_legal_person_cert_expiry_date: description: 企业法人证件有效期(用户类型是公司类型时才有此字段)。 example: "20200909" type: string firm_legal_person_cert_no: description: 法人证件号码(用户类型是公司类型时才有此字段)。 example: "320231196408110099" type: string firm_legal_person_cert_type: description: "企业法人证件类型, 返回值参考cert_type字段(用户类型是公司类型时才有此字段)。" example: "1" type: string firm_legal_person_name: description: 企业法人名称(用户类型是公司类型时才有此字段)。 example: 李四 type: string firm_legal_person_pictures: description: 企业法人证件图片(用户类型是公司类型时才有此字段)。 items: $ref: '#/components/schemas/AlipayUserPicture' type: array firm_pictures: description: 企业相关证件图片,包含图片地址(目前需要调用alipay.user.certify.image.fetch转换一下)及类型(用户类型是公司类型时才有此字段)。 items: $ref: '#/components/schemas/AlipayUserPicture' type: array firm_type: description: "公司类型,包括(用户类型是公司类型时才有此字段):\t\tCO(公司)\t\tINST(事业单位),\t\tCOMM(社\ 会团体),\t\tNGO(民办非企业组织),\t\tSTATEORGAN(党政国家机关)" example: CO type: string gender: description: "性别。枚举值如下:\tF:女性;\tM:男性。" example: F type: string graduation_time: description: 预期毕业时间,不保证准确性,yyyy-mm-dd格式。 example: 2021-01-01 type: string identity_card_address: description: 身份证地址信息 example: 江西省上饶市xxx村34号 type: string identity_card_area: description: 身份证地区信息 example: xxx村23号 type: string identity_card_city: description: 身份证市信息 example: 上饶市 type: string identity_card_province: description: 身份证省信息 example: 江西省 type: string inst_or_corp: description: "是否是金融机构或特殊单位,\"I\"表示金融机构, \"C\"表示无余额账户的单位账户, \"V\", 表示虚拟主\ 体(类似机构仅内部户无余额户), \"N\"表示非金融机构且非无余额账户的单位账户,\"?\"表示匿名用户" example: "N" type: string is_adult: description: "T/F, 实名认证为T,且证件类型为身份证,则输出是否成年字段,否则不输出" example: F type: string is_balance_frozen: description: "余额账户是否被冻结。\t\tT--被冻结;F--未冻结" example: T type: string is_blocked: description: 账户是否被冻结,T/F,T冻结,F未冻结 example: T type: string is_certified: description: 是否通过实名认证。T是通过 F是没有实名认证。 example: T type: string is_student_certified: description: 是否是学生 example: T type: string license_expiry_date: description: 营业执照有效期,yyyyMMdd或长期,(用户类型是公司类型时才有此字段)。 example: "20200101" type: string license_no: description: 企业执照号码(用户类型是公司类型时才有此字段)。 example: "371702118008810" type: string member_grade: description: 支付宝会员等级 example: "primary,普通; golden,黄金; platinum,铂金; diamond,钻石unknown,未知。" type: string mobile: description: 手机号码。 example: "13429199999" type: string nick_name: description: "用户昵称。\t注意:如果没有数据(用户未设置)时不会返回该信息,请做好容错。" example: 支付宝小二 type: string open_id: description: 支付宝用户的openId。 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string organization_code: description: 组织机构代码(用户类型是公司类型时才有此字段)。 example: 暂无 type: string person_birthday: description: 个人用户生日。 example: "19900101" type: string person_birthday_without_year: description: 生日。不包含具体年份,格式MMdd example: "0828" type: string person_cert_expiry_date: description: 证件有效期(用户类型是个人的时候才有此字段)。 example: "20400101" type: string person_cert_issue_date: description: 证件起始日期(用户类型是个人的时候才可能有此字段,不保证准确,同时有可能为空)。 example: "20220701" type: string person_pictures: description: 个人证件图片(用户类型是个人的时候才有此字段)。 items: $ref: '#/components/schemas/AlipayUserPicture' type: array phone: description: 电话号码。 example: 0511-26888888 type: string profession: description: 职业 example: 教师 type: string province: description: 省份名称。 example: 安徽省 type: string taobao_id: description: 淘宝id example: "42143928" type: string user_id: description: 支付宝用户的userId。 example: "2088102104794936" type: string user_name: description: 若用户是个人用户,则是用户的真实姓名;若是企业用户,则是企业名称。【注意】只有is_certified为T的时候才有意义,否则不保证准确性. example: 张三 type: string user_nation: description: 身份证民族信息 example: 汉 type: string user_status: description: "用户状态(Q/T/B/W)。\tQ代表快速注册用户\tT代表正常用户\tB代表被冻结账户\tW代表已注册,未激活的账\ 户" example: T type: string user_type: description: "用户类型(1/2)\r\t1代表公司账户2代表个人账户" example: "1" type: string zip: description: 邮政编码。 example: "3600" type: string type: object AlipayUserPicture: properties: picture_type: description: 图片类型,包括身份证正反面、营业执照等 type: string picture_url: description: 用于调用alipay.user.certify.image.fetch接口,获取图片资源 type: string type: object AlipayUserTwostageCommonUseErrorResponseModel: properties: code: description: 错误码 enum: - INPUT_ILLEGAL - DECODE_FAILED - INDEX_NOT_EXIST - SYSTEM_ERROR - ILLEGAL_CODE - CODE_EXPIRED - USER_UN_AUTH - SENCENO_UN_MATCH type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayUserTwostageCommonUseModel: properties: dynamic_id: description: 商户扫描用户的付款码值。 example: "286861260475412123" type: string pay_check_strategy: description: "传1表示 校验pid(pay_pid)和来支付的时候的pid一致性;\t传2表示校验pid(pay_pid)和来支付\ 的时候的pid一致性、校验scene_no和来支付时DYNAMIC_TOKEN_OUT_BIZ_NO属性一致; \ \ \t不传值和value=2的表现一致" example: "1" type: string pay_pid: description: 商家进行二阶段支付的PID信息。 example: "2088702093900999" type: string sence_no: 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 type: string type: object AlipayUserTwostageCommonUseResponseModel: properties: open_id: description: open_id example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string user_id: description: 支付宝用户userId信息,因为用户已经在客户端给商户的小程序授权了,并且商户要通过userId信息挂接优惠券信息,所以可以无需脱敏返回给商户。 example: "2088123412341234" type: string user_identity_info: $ref: '#/components/schemas/UserIdentityInfo' type: object AlipayUserTwostageIndirectUseErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayUserTwostageIndirectUseModel: properties: dynamic_id: description: 商户扫描用户的付款码值。18~24位,25~30开头,例如28开头的18位的数字;或人脸支付的ftoken等。 example: 28xxxxxxxxxxxxxxxx type: string org_pid: description: 进件信息中,SMID对应的银行机构的PID信息,一般为2088开头的16位数字。 example: 2088xxxxxxxxxxx type: string pay_smid: description: 进件信息中,二级商户ID( sub_merchant_id)信息,一般为2088开头的16位数字。 example: 2088xxxxxxxxxxx type: string sence_no: 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 type: string source_pid: description: 进件信息中,SMID对应渠道的PID信息,一般为2088开头的16位数字。 example: 2088xxxxxxxxxxx type: string type: object AlipayUserTwostageIndirectUseResponseModel: properties: user_id: description: 蚂蚁统一会员ID example: 2088xxxxxxxxxxx type: string type: object AlipayUserUserinfoShareErrorResponseModel: properties: code: description: 错误码 enum: - isv.invalid-argument - isv.invalid-token - aop.unknow-error - isp.unknow-error type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AlipayUserUserinfoShareResponseModel: properties: address: description: 详细地址。 example: 西湖区文三路国际大厦 type: string address_code: description: 区域编码,暂时不返回值 example: "330106" type: string alipay_user_id: description: 支付宝用户ID example: "2088156897126906" type: string area: description: 区县名称。 example: 西湖区 type: string avatar: description: 用户头像 example: http://tfsimg.alipay.com/images/partner/T1uIxXXbpXXXXXXXX type: string balance_freeze_type: description: "【注意】当is_balance_frozen为“F”时,改字段不会返回.\t\tCTU ---- CTU冻结,允许用\ 户开启\t\tALIBABA ---- ALIBABA冻结,允许用户开启\t\tSERVER ---- 后台冻结,允许用户开启\t\tUSER\ \ ---- 用户冻结 \t\tCTU_N---- CTU冻结,不允许用户开启\t\tALIBABA_N ---- ALIBABA冻结,不\ 允许用户开启\t\tSERVER_N ---- 后台冻结,不允许用户开启\t\tUNKNOWN ---- 降级、或查询超时" example: SERVER type: string birthday: description: 用户生日 example: "19900918" type: string cert_no: description: 证件号码 example: "340928109890871722" type: string cert_type_value: description: "0:身份证\t\t1:护照\t\t2:军官证\t\t3:士兵证\t\t4:回乡证\t\t5:临时身份证\t\t6:户\ 口簿\t\t7:警官证\t\t8:台胞证\t\t9:营业执照\t\t10其它证件" example: "7" type: string city: description: 市名称。 example: 安庆 type: string default_deliver_address: description: 是否默认收货地址,暂时不返回值 example: T type: string deliver_address_list: description: 收货人地址列表 items: $ref: '#/components/schemas/DeliverAddress' type: array deliver_area: description: 收货人所在区县 example: 西湖区 type: string deliver_city: description: 收货人所在城市 example: 杭州市 type: string deliver_fullname: description: 收货人全称 example: 张三 type: string deliver_mobile: description: 收货地址的联系人移动电话。 example: "13200909090" type: string deliver_phone: description: 收货地址的联系人固定电话。 example: "13211111111" type: string deliver_province: description: 收货人所在省份 example: 浙江省 type: string email: description: 用户支付宝账号绑定的邮箱地址 example: sss@163.com type: string family_name: description: 姓氏,取的是realName中的首个字符,对非中文、中文复姓支持较差。 example: 赵 type: string firm_name: description: 公司名称(用户类型是公司类型时公司名称才有此字段)。 example: 阿里巴巴 type: string gender: description: 性别(F:女性;M:男性) example: F type: string is_balance_frozen: description: T--被冻结;F--未冻结 example: T type: string is_bank_auth: description: T为是银行卡认证,F为非银行卡认证。 example: T type: string is_certified: description: 是否通过实名认证。T是通过 F是没有实名认证 example: T type: string is_certify_grade_a: description: T:表示A类实名认证;F:表示非A类实名认证 example: T type: string is_id_auth: description: T为是身份证认证,F为非身份证认证。 example: T type: string is_licence_auth: description: T为通过营业执照认证,F为没有通过 example: T type: string is_mobile_auth: description: T为是手机认证,F为非手机认证。 example: T type: string is_student_certified: description: 是否是学生 example: T type: string mobile: description: 手机号码。 example: "13429199999" type: string nick_name: description: 用户昵称 example: 哈哈就是我 type: string phone: description: 电话号码。 example: 0511-26888888 type: string province: description: 省份名称。 example: 安徽省 type: string real_name: description: 用户的真实姓名。 example: 张三 type: string reduced_birthday: description: 生日的月和日,MMdd格式 example: "0428" type: string user_id: description: 用户的userId example: "2088102104794936" type: string user_status: description: "用户状态(Q/T/B/W)。\r\tQ代表快速注册用户\r\tT代表已认证用户\r\tB代表被冻结账户\r\tW代表\ 已注册,未激活的账户" example: T type: string user_type_value: description: "用户类型(1/2)\t\t1代表公司账户2代表个人账户" example: "1" type: string zip: description: 邮政编码。 example: "3600" type: string type: object AmountTypeData: properties: name: description: 累计类型为金额类型的累计名称。为必传入参。 example: 优惠累计名称001 type: string out_discount_infos: description: "优惠信息。为List类型,支持传入多笔优惠,大部分场景传入一笔。包含:优惠名称,优惠类型,优惠金额(单位元)。\t字\ 段必传场景:\t1.当累计模式为【交易绑定模式】时,为必传入参。\t2.当累计模式为【交易解耦模式】,同时需要累计优惠信息时,为必传入参。" items: $ref: '#/components/schemas/ZMGoOutDiscountInfo' type: array trade_info: $ref: '#/components/schemas/ZMGoTradeInfo' type: object AmountTypeSyncData: properties: discount_amount: description: 商户回传的优惠金额,如用户享受的红包金额,单位元 example: "8.75" type: string discount_desc: description: 商户数据回传的优惠信息的名称。 example: 消费满减优惠001 type: string has_alipay_trade: description: 是否为支付宝交易,默认false,表示是否要做支付宝交易关联。此时tradeNo必须传支付宝交易号。 example: false type: boolean task_amount: description: 用户和商户发生交易的交易单金额,单位元。 example: "3.57" type: string task_desc: description: 任务描述 example: 完成一次任务001 type: string trade_no: description: 用户和商户发生金额类交易的交易单号。 example: "2020081722001435461000061785" type: string type: object AntMerchantExpandApprecommendAccountCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandApprecommendAccountCreateModel: properties: acc_no: description: 待绑定账号PID example: 20880019****4501 type: string app_no: description: 待绑定小程序的app_id example: 20210001****9069 type: string type: object AntMerchantExpandApprecommendAccountCreateResponseModel: type: object AntMerchantExpandApprecommendAccountDeleteErrorResponseModel: properties: code: description: 错误码 enum: - MER_ARGUMENT_NULL - APP_ID_NOT_EXIST - APP_OWNER_ERROR - ACCOUNT_NOT_EXIST - ACCOUNT_RECOMMEND_NOT_EXIST - SYSTEM_ERROR - THIRD_SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandApprecommendAccountDeleteResponseModel: type: object AntMerchantExpandApprecommendAccountQueryErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandApprecommendAccountQueryResponseModel: properties: list: description: 账号列表 example: "[\"2088001969784501\"]" items: type: string type: array page_number: description: 当前页码 example: 1 type: integer page_size: description: 单页行数 example: 10 type: integer total_pages: description: 总页数 example: 1 type: integer total_size: description: 总行数 example: "1" type: string type: object AntMerchantExpandApprecommendAvailableQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - QUERY_PAGE_QUERY_NULL - QUERY_PAGE_SIZE_LARGE - QUERY_PAGE_SIZE_SMALL - QUERY_PAGE_NUM_SMALL - THIRD_SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandApprecommendAvailableQueryResponseModel: properties: list: description: 总页数 example: "[\"20880019****4501\"]" items: type: string type: array page_number: description: 当前页码 example: 1 type: integer page_size: description: 单页行数 example: 10 type: integer total_pages: description: 总页数 example: 1 type: integer total_size: description: 总行数 example: 1 type: integer type: object AntMerchantExpandIndirectImageUploadErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - MERCHANT_ILLEGAL_ARGUMENT - EXCEED_MAX_SIZE - INVALID_IMAGE_FORMAT - IMAGE_UNSAFE type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandIndirectImageUploadModel: properties: image_type: description: 图片格式,支持格式:bmp、jpg、jpeg、png、gif. example: jpg type: string type: object AntMerchantExpandIndirectImageUploadResponseModel: properties: image_id: description: 图片在文件存储平台的标识 example: a5d373f6-3e79-405f-9993-fb7ea051c372.jpg type: string type: object AntMerchantExpandInfoQueryErrorResponseModel: properties: code: description: 错误码 enum: - PERMISSION_IS_ILLEGAL - MER_ARGUMENT_NULL - MERCHANT_INPUT_ARGUMENT_ILLEGAL - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandInfoQueryResponseModel: properties: merchant_query_result: $ref: '#/components/schemas/MerchantQueryResult' type: object AntMerchantExpandItemCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandItemCreateModel: properties: detail_url: description: 详情地址 example: https://www.alipay.com/item/detail01.html type: string ext_info: description: "商品扩展信息:可以解析成 Map 的 json string" example: "{\\\"OIL_GUNS\\\":\\\"[7,8,9,10]\\\", \\\"DISCOUNT\\\":\\\"95\\\ \"}" type: string external_item_id: description: 外部商品ID example: "201909161233534124235231111" type: string front_category_id: description: 前台类目id:target_type + target_id 和 front_category_id 二选一 example: "2018091300502200002600105884" type: string label_list: description: 商品标签列表 items: $ref: '#/components/schemas/ItemLabelCreateInfo' type: array main_pic: description: 主图地址 example: https://img.alicdn.com/imgextra/i4/263168616/O1CN01qp60TQ2DWB06jyvVg_!!263168616.jpg type: string name: description: 商品名称 example: 西红柿炒蛋 type: string scene: description: 场景:GAS_CHARGE(加油) example: GAS_CHARGE type: string sku_list: description: 商品sku列表,至少有一个 items: $ref: '#/components/schemas/ItemSkuCreateInfo' type: array target_id: description: 商户归属主体id example: "2018090600502000000022501261" type: string target_type: 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" type: string type: object AntMerchantExpandItemCreateResponseModel: properties: item_id: description: 商品id example: "2018091300502200002600104169" type: string type: object AntMerchantExpandItemDeleteErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - DB_ERROR - ARGUMENT_NULL - ITEM_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandItemDeleteResponseModel: properties: item_id: description: 商品id example: "2018091300502200002600104169" type: string type: object AntMerchantExpandItemModifyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandItemModifyModel: properties: detail_url: description: 商品详情地址 example: https://www.alipay.com/item/detail01.html type: string ext_info: description: "商品扩展信息:可以解析成 Map 的 json string" example: "{\\\"OIL_GUNS\\\":\\\"[7,8,9,10]\\\", \\\"DISCOUNT\\\":\\\"95\\\ \"}" type: string external_item_id: description: 外部商品ID(item_id不为空时作为普通更新项,item_id为空时作为更新KEY) example: "20190916123423654241312" type: string front_category_id: description: "前台类目id, null表示未分类" example: "2018091300502200002600105884" type: string item_id: description: 商品id(和external_item_id不能同时为空) example: "2018091300502200002600104169" type: string label_list: description: 商品标签列表,null表示不修改标签列表,空list表示清空标签 items: $ref: '#/components/schemas/ItemLabelModifyInfo' type: array main_pic: description: 商品主图 example: https://img.alicdn.com/imgextra/i4/263168616/O1CN01qp60TQ2DWB06jyvVg_!!263168616.jpg type: string name: description: 商品名称 example: 西红柿炒蛋 type: string op_timestamp: description: 更新时间戳(只处理时间戳最大的一次请求) example: 1234352342353 type: integer scene: description: 场景:GAS_CHARGE(加油) example: GAS_CHARGE type: string sku_list: description: SKU列表(会和商品已存在SKU做差异化比较后做增删改操作) items: $ref: '#/components/schemas/ItemSkuModifyInfo' type: array status: description: "商品状态:\r\tEFFECT(有效)、 INVALID(无效)" example: EFFECT type: string type: object AntMerchantExpandItemModifyResponseModel: properties: item_id: description: 商品id example: "2018091300502200002600104169" type: string type: object AntMerchantExpandItemOpenBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - DB_ERROR - ARGUMENT_NULL - ARGUMENT_ILLEGAL - NO_PERMISSION type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandItemOpenBatchqueryModel: properties: item_id_list: description: 商品ID列表 example: "2019073100812219000000100000" items: type: string type: array type: object AntMerchantExpandItemOpenBatchqueryResponseModel: properties: item_list: description: 商品列表。 items: $ref: '#/components/schemas/CmItemInfo' type: array type: object AntMerchantExpandItemOpenCreateErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - DB_ERROR - ARGUMENT_NULL - ARGUMENT_ILLEGAL - ITEM_CATEGORY_NOT_EXIST - INFO_SEC_ERROR - NO_PERMISSION type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandItemOpenCreateModel: properties: description: description: 商品描述 example: 精选东北优质非转基因大豆 type: string ext_info: description: 商品扩展信息(具体KEY请参见产品文档)。 小程序订单中心场景接入参见 接入指南。 items: $ref: '#/components/schemas/ItemExtInfo' type: array material_list: description: 素材列表(最多3个),素材内容为素材key(素材key为alipay.merchant.item.file.upload 接口返回的 material_key) items: $ref: '#/components/schemas/MaterialCreateInfo' type: array name: description: 商品名称 example: 西红柿炒蛋 type: string property_list: description: 商品属性列表 items: $ref: '#/components/schemas/ItemPropertyInfo' type: array scene: description: 业务场景码。 example: APP_ORDER type: string sku_list: description: 商品SKU列表(至少1个,最多20个) items: $ref: '#/components/schemas/SkuCreateInfo' type: array standard_category_id: description: 商品所属标准类目ID,标品及非标品都需传入。 请填入 小程序商品类目表 中三级类目ID。 example: "2019073100992228000000100000" type: string target_id: description: "商品归属主体ID\t例:商品归属主体类型target_type为店铺,则商品归属主体ID为店铺ID(支付宝侧店铺ID)\ ;归属主体类型target_type为小程序,则归属主体ID为小程序ID" example: "2018090600502000000022501261" type: string target_type: description: "商品归属主体类型。枚举如下:\t5:店铺。\t8:小程序。" example: "8" type: string type: description: "商品类型。枚举支持:\tSTANDARD_GOODS:标品,一般是具有明确、标准规格、型号、参数的商品,如:手机、数\ 码产品、大多数的家电 。\tNON_STANDARD_GOODS:非标品,则是在这些方面没有统一的行业标准和参数规格的商品,如:服装、鞋袜等\ 。" example: STANDARD_GOODS type: string type: object AntMerchantExpandItemOpenCreateResponseModel: properties: item_id: description: 商品ID example: "2018091300502200002600104169" type: string type: object AntMerchantExpandItemOpenDeleteErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - DB_ERROR - ARGUMENT_NULL - ITEM_NOT_EXIST - NO_PERMISSION - ARGUMENT_ILLEGAL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandItemOpenDeleteResponseModel: type: object AntMerchantExpandItemOpenModifyErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - DB_ERROR - ARGUMENT_NULL - ARGUMENT_ILLEGAL - ITEM_NOT_EXIST - ITEM_CATEGORY_NOT_EXIST - INFO_SEC_ERROR - NO_PERMISSION type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandItemOpenModifyModel: properties: description: description: 商品描述 example: 精选东北优质非转基因大豆 type: string ext_info: description: 商品扩展信息(覆盖商品已存在扩展信息、具体KEY请参见产品文档) items: $ref: '#/components/schemas/ItemExtInfo' type: array item_id: description: 商品ID example: "2019073100702219000000100000" type: string material_list: description: 商品素材列表(会和商品已存在素材做差异化比较后做增删改操作) items: $ref: '#/components/schemas/MaterialModifyInfo' type: array name: description: 商品名称 example: 西红柿炒蛋 type: string property_list: description: 商品属性列表(覆盖商品已存在属性) items: $ref: '#/components/schemas/ItemPropertyInfo' type: array sku_list: description: SKU列表(会和商品已存在SKU做差异化比较后做增删改操作) items: $ref: '#/components/schemas/SkuModifyInfo' type: array standard_category_id: description: 商品所属标准类目ID,当 type 为STANDARD_GOODS(标品)时必填。 请填入 https://opendocs.alipay.com/mini/011lxt 小程序商品类目表中三级类目ID。 example: "2019073100992228000000100000" type: string status: description: 商品状态 example: EFFECT type: string type: description: 商品类型:STANDARD_GOODS(标品)、NON_STANDARD_GOODS(非标品) example: STANDARD_GOODS type: string type: object AntMerchantExpandItemOpenModifyResponseModel: type: object AntMerchantExpandItemOpenQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - DB_ERROR - ARGUMENT_NULL - ARGUMENT_ILLEGAL - NO_PERMISSION type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandItemOpenQueryResponseModel: properties: item_list: description: 商品列表 items: $ref: '#/components/schemas/CmItemInfo' type: array type: object AntMerchantExpandItemQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - DB_ERROR - ARGUMENT_NULL - ARGUMENT_ILLEGAL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandItemQueryResponseModel: properties: item_list: description: 商品列表 items: $ref: '#/components/schemas/ItemModel' type: array type: object AntMerchantExpandItemStatusModifyErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - DB_ERROR - ARGUMENT_NULL - ITEM_NOT_EXIST - ITEM_ERROR_STATUS type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandItemStatusModifyModel: properties: item_id: description: 商品ID example: "2018091300502200002600104169" type: string status: description: 商品状态:EFFECT、INVALID example: EFFECT type: string type: object AntMerchantExpandItemStatusModifyResponseModel: properties: item_id: description: 商品id example: "2018091300502200002600104169" type: string type: object AntMerchantExpandMccQueryErrorResponseModel: properties: code: description: 错误码 enum: - MER_ARGUMENT_NULL - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandMccQueryResponseModel: properties: mcc_info_list: description: mcc查询信息结果列表 items: $ref: '#/components/schemas/MccQueryInfo' type: array type: object AntMerchantExpandOrderQueryErrorResponseModel: properties: code: description: 错误码 enum: - NOT_ALLOW_QUERY - ORDER_ID_EMPTY - ORDER_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandOrderQueryResponseModel: properties: apply_time: description: 申请单创建时间 example: 2017-11-11 12:00:00 type: string ext_info: description: 返回申请单相关参数。当前返回内容有cardAliasNo,smid example: "{\"cardAliasNo\":\"ab7c65ab96\",\"smid\":\"20881234567890\"}" type: string ip_role_id: description: 商户角色id。间连商户或平台商二级商户业务中,本字段表示smid。 example: "2088301155943087" items: type: string type: array merchant_name: description: 商户名称 example: 蚂蚁金服(杭州)网络技术有限公司 type: string status: description: 申请单状态。 example: "99" type: string type: object AntMerchantExpandShopCloseErrorResponseModel: properties: code: description: 错误码 enum: - MER_ARGUMENT_NULL - SHOP_NOT_EXIST - RELATION_NOT_EXIST - NOT_ALLOWED_SETTLE - MER_ARGUMENT_ILLEGAL - THIRD_SYSTEM_ERROR - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandShopCloseModel: properties: ip_role_id: description: 商户角色id,表示将要开的店属于哪个商户角色。对于直连开店场景,填写商户pid;对于间连开店场景(线上、线下、直付通),填写商户smid。若未传入shop_id 则本参数与store_id均必填。 example: "2088301155943087" type: string shop_id: description: 支付宝侧蚂蚁店铺 id。传入本参数后可不填 store_id 及 ip_role_id。 example: "2018011900502000000005124744" type: string store_id: description: 商户侧门店编号。表示该门店在该商户角色id(直连pid,间连smid)下,由商户自己定义的外部门店编号。若未传入 shop_id 则本参数与与ip_role_id均必填。 example: NO0001 type: string type: object AntMerchantExpandShopCloseResponseModel: type: object AntMerchantExpandShopConsultErrorResponseModel: properties: code: 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 - SHOP_CODE_ALREADY_EXIST - SYSTEM_ERROR - SETTLED_ALIPAYACCOUNT_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandShopConsultModel: properties: biz_cards: description: '"门店结算卡信息。本业务当前只允许传入一张结算卡。 说明:本参数仅直付通业务使用,其余业务无需关注。"' items: $ref: '#/components/schemas/SettleCardInfo' type: array brand_id: description: 品牌id,非加油站等特殊门店无需关注。 example: "20181026000001" type: string business_address: $ref: '#/components/schemas/AddressInfo' business_time: description: 店铺经营时间。 items: $ref: '#/components/schemas/ShopBusinessTime' type: array cert_image: description: 营业执照图片KEY。通过ant.merchant.expand.indirect.image.upload 接口上传图片后得到的 image_id example: c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg type: string cert_name: description: 营业执照名称,填写值为营业执照或统一社会信用代码证上的名称。 example: 支付宝东门小卖铺 type: string cert_no: description: 证件号码,请填写店铺营业执照号。 example: 9133010608210550XR type: string cert_type: description: 证件类型 example: "201" type: string contact_infos: description: 联系人信息。如果填写,其中名称必填,手机、固话、email 三选一必填。 items: $ref: '#/components/schemas/ContactInfo' type: array contact_mobile: description: 店铺联系手机,与店铺联系固话二选一必填 example: "13901390139" type: string contact_phone: description: 店铺的联系固话,和店铺联系手机二选一必填 example: 010-62286228 type: string ext_infos: description: 扩展信息列表。key值需要向对应行业的bd进行申请。 items: $ref: '#/components/schemas/ShopExtInfo' type: array ip_role_id: description: 商户角色id,表示将要开的店属于哪个商户角色。对于直连开店场景,填写商户pid;对于间连开店场景(线上、线下、直付通),填写商户smid。特别说明:IoT设备三绑定场景统一填写商户pid example: "2088301155943087" type: string legal_cert_no: description: 法人身份证号 example: "100100198811110001" type: string legal_name: description: 法人名称。 example: 支小宝 type: string license_auth_letter_image: description: "营业执照授权函。需传入ant.merchant.expand.indirect.image.upload 接口上传图片后得到的 image_id。\t蚂\ 蚁门店管理场景可选。" example: c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg type: string memo: description: 备注 example: 备注 type: string out_door_images: description: 门头照 id,需传入 ant.merchant.expand.indirect.image.upload 接口上传图片后得到的 image_id example: c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg type: string qualifications: description: 行业特殊资质。 items: $ref: '#/components/schemas/IndustryQualificationInfo' type: array scene: description: 场景,非加油站等特殊门店无需关注。 example: PARK type: string settle_alipay_logon_id: description: 结算支付宝账号的登录号,需传入小程序归属账号。若需增加收款账号,可在创建门店后登录商家中心 ,在 账户中心 > 经营信息 > 门店管理 中选择对应门店选择 更多 > 编辑 > 新增收款账号。 example: demo@163.com type: string shop_category: description: 新版门店类目标准二级类目code。类目标准及与原类目映射关系参见 支付宝门店类目-最新 表格。 example: B0001 type: string shop_name: description: 店铺名称。直连开店要保证全局店铺名称+地址唯一,间连开店要保证服务商pid下店铺名称+地址唯一 example: 庆丰包子铺中关村店 type: string shop_type: description: 店铺经营类型,01表示直营,02表示加盟 example: "01" type: string store_id: description: 门店编号,表示该门店在该商户角色id(直连pid,间连smid)下,由商户自己定义的外部门店编号 example: NO0001 type: string type: object AntMerchantExpandShopConsultResponseModel: properties: account_audit: description: 资金账户是否审核。当调用没有报错时,本值才有参考意义 example: true type: boolean order_id: description: 咨询申请单id example: "2018011900502000000005124744" type: string risk_audit: description: 是否风控审核。当调用没有报错时,本值才有参考意义 example: true type: boolean type: object AntMerchantExpandShopCreateErrorResponseModel: properties: code: 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 - DETAIL_ADDRESS_NOT_CONTAIN_KEYWORD_VALUE - SHOP_NAME_EXIST_RISK - SHOP_ADDRESS_EXIST_RISK - SHOP_REMARK_EXIST_RISK - EXTERNAL_SHOP_CODE_EXIST_RISK - SHOP_CODE_ALREADY_EXIST - SETTLED_ALIPAYACCOUNT_NOT_EXIST - DETAIL_ADDRESS_NOT_CONTAINS_CHINESE_CHARACTER - OUTDOOR_IMAGE_URL_IS_EMPTY - BIZ_SCENE_PIC_URL_IS_EMPTY - BUSINESS_LICENSE_URL_IS_EMPTY - MERCHANT_LOGO_URL_IS_EMPTY - SETTLED_BANKCARD_NUMBER_LENGTH_ILLEGAL - ACCOUNT_HOLDER_NAME_LENGTH_ILLEGAL - ACCOUNT_INST_PROVINCE_LENGTH_ILLEGAL - ACCOUNT_INST_CITY_LENGTH_ILLEGAL - ACCOUNT_BRANCH_NAME_LENGTH_ILLEGAL - ACCOUNT_NAME_LENGTH_ILLEGAL - ACCOUNT_INST_ID_LENGTH_ILLEGAL - OUTDOOR_IMAGE_OSSKEY_NOT_EXIST - BUSINESS_LICENSE_OSSKEY_NOT_EXIST - SPECIAL_TRAVEL_PERMIT_OSSKEY_NOT_EXIST - OTA_SNAPSHOT_OSSKEY_NOT_EXIST - ID_CARD_MSG_ILLEGAL - BUSINESS_LICENSE_ILLEGAL - BUSINESS_ADDRESS_IS_EMPTY - DETAIL_ADDRESS_CONTAIN_PROVINCES_CITY_REGION - SHOP_INFO_SOURCE_OTHER_TAG - MERCHANT_ORDER_EXECUTE_CONFLICT - ENUM_ILLEGAL - BANK_CARD_TYPE_ILLEGAL - TARGET_TYPE_ILLEGAL - SHOP_EXT_INFO_NULL - SHOP_INFO_SOURCE_ILLEGAL - SHOP_INFO_SOURCE_CHANNEL_ILLEGAL - SHOP_INFO_SOURCE_BIZ_FROM_ILLEGAL - DISTRICT_CODE_ILLEGAL - SETTLED_BANKCARD_ACCOUNTINSTPROVINCE_IS_EMPTY - SETTLED_BANKCARD_ACCOUNTINSTCITY_IS_EMPTY - SETTLED_CARD_SIZE_IS_ILLEGAL - BANK_CODE_ILLEGAL - ADDRESS_VERSION_CODE_ILLEGAL - SHOP_SHOP_TYPE_ILLEGAL - SHOP_SOURCE_IS_ILLEGAL - CATEGORY_EVALUATE_FAIL - CATEGORY_WITH_NO_PROOF - SHOP_ASSET_CHECK_RESULT_EMPTY - SHOP_ASSET_NOT_BINDABLE - SHOP_ASSET_MAX_LIMIT - SHOP_PRE_RISK_LEVEL_ERROR - SHOP_PRE_POI_NOT_FILL_ERROR - STORE_ID_LENGTH_ILLEGAL - SHOP_COVER_OSSKEY_NOT_EXIST - SHOP_COVER_NOT_EXIST - SHOP_EXT_INFO_INPUT_ARGUMENT_ILLEGAL - SHOP_EXT_INFO_VALUE_INPUT_ARGUMENT_ILLEGAL - SHOP_CATEGORY_EMPTY type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandShopCreateModel: properties: biz_cards: description: 门店结算卡信息。本业务当前只允许传入一张结算卡。 说明:本参数仅直付通业务使用,其余业务无需关注。 items: $ref: '#/components/schemas/SettleCardInfo' type: array brand_id: description: 品牌id,非加油站等特殊门店无需关注。 example: "20181026000001" type: string business_address: $ref: '#/components/schemas/AddressInfo' business_time: description: 店铺经营时间。 items: $ref: '#/components/schemas/ShopBusinessTime' type: array cert_image: description: 营业执照图片KEY example: 营业执照图片id type: string cert_name: description: 营业执照名称,填写值为营业执照或统一社会信用代码证上的名称。 example: 支付宝东门小卖铺 type: string cert_no: description: 证件号码,请填写店铺营业执照号。 example: 9133010608210550XR type: string cert_type: description: 证件类型 example: "201" type: string contact_infos: description: 联系人信息 items: $ref: '#/components/schemas/ContactInfo' type: array contact_mobile: description: 店铺联系手机号 example: "13901390139" type: string contact_phone: description: 店铺的联系固定电话 example: 010-62286228 type: string cover: description: 需传入ant.merchant.expand.indirect.image.upload 接口上传图片后得到的 image_id。 example: c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg type: string ext_infos: description: 扩展信息列表。key值需要向对应行业的bd进行申请。 items: $ref: '#/components/schemas/ShopExtInfo' type: array ip_role_id: description: 当前门店归属的商户角色 ID,表示当前进件的店铺的归属商户。对于直连开店场景,填写商户 PID。对于间连开店场景(线上、线下、直付通),商户SMID example: "2088301155943087" type: string legal_cert_no: description: 法人身份证号 example: "100100198811110001" type: string legal_name: description: 法人名称 example: 支小宝 type: string license_auth_letter_image: description: 营业执照授权函图片id,通过 ant.merchant.expand.indirect.image.upload 接口上传图片后得到的 image_id example: 营业执照授权函图片id type: string memo: description: 备注 example: 备注 type: string out_door_images: description: 需传入ant.merchant.expand.indirect.image.upload 接口上传图片后得到的 image_id。 example: c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg items: type: string type: array qualifications: description: 行业特殊资质。 items: $ref: '#/components/schemas/IndustryQualificationInfo' type: array scene: description: 场景,非加油站/酒店等特殊门店无需关注。 example: PARK type: string settle_alipay_logon_id: description: 门店结算收款的支付宝账号 example: demo@163.com type: string shop_category: description: 新版门店类目标准二级类目code。类目标准及与原类目映射关系参见 支付宝门店类目-最新 表格。 example: B0001 type: string shop_name: description: "店铺名称, 由商户定义在支付宝内的店铺名称" example: 支付宝(西溪路店) type: string shop_type: description: 店铺经营类型,01表示直营,02表示加盟 example: "01" type: string store_id: description: 门店编号,表示该门店在该商户角色id(直连pid,间连smid)下,由商户自己定义的外部门店编号 example: NO0001 type: string type: object AntMerchantExpandShopCreateResponseModel: properties: exist_shop_id: description: 触发幂等时返回已存在的门店shopId example: "2022102800077000000039913046" type: string order_id: description: 申请单id example: "2018012000502000000005130266" type: string type: object AntMerchantExpandShopModifyErrorResponseModel: properties: code: 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 - FIELD_LENGTH_ERROR - MERCHANT_ORDER_EXECUTE_CONFLICT - THIRD_SYSTEM_ERROR - CTU_INDIRECT_CREATE_FAIL - DETAIL_ADDRESS_NOT_CONTAIN_KEYWORD_VALUE - SHOP_NAME_EXIST_RISK - SHOP_ADDRESS_EXIST_RISK - SHOP_REMARK_EXIST_RISK - EXTERNAL_SHOP_CODE_EXIST_RISK - DETAIL_ADDRESS_NOT_CONTAINS_CHINESE_CHARACTER - OUTDOOR_IMAGE_URL_IS_EMPTY - BIZ_SCENE_PIC_URL_IS_EMPTY - BUSINESS_LICENSE_URL_IS_EMPTY - MERCHANT_LOGO_URL_IS_EMPTY - SETTLED_BANKCARD_NUMBER_LENGTH_ILLEGAL - ACCOUNT_HOLDER_NAME_LENGTH_ILLEGAL - ACCOUNT_INST_PROVINCE_LENGTH_ILLEGAL - ACCOUNT_INST_CITY_LENGTH_ILLEGAL - ACCOUNT_BRANCH_NAME_LENGTH_ILLEGAL - ACCOUNT_NAME_LENGTH_ILLEGAL - ACCOUNT_INST_ID_LENGTH_ILLEGAL - OUTDOOR_IMAGE_OSSKEY_NOT_EXIST - BUSINESS_LICENSE_OSSKEY_NOT_EXIST - SPECIAL_TRAVEL_PERMIT_OSSKEY_NOT_EXIST - OTA_SNAPSHOT_OSSKEY_NOT_EXIST - ID_CARD_MSG_ILLEGAL - BUSINESS_LICENSE_ILLEGAL - BUSINESS_ADDRESS_IS_EMPTY - DETAIL_ADDRESS_CONTAIN_PROVINCES_CITY_REGION - MERCHANT_NOT_EXIST - SHOP_INFO_SOURCE_OTHER_TAG - CONFIG_ERROR - ENUM_ILLEGAL - ATTACHMENT_TYPE_ILLEGAL - BANK_CARD_TYPE_ILLEGAL - TARGET_TYPE_ILLEGAL - SHOP_EXT_INFO_NULL - SHOP_INFO_SOURCE_ILLEGAL - SHOP_INFO_SOURCE_CHANNEL_ILLEGAL - SHOP_INFO_SOURCE_BIZ_FROM_ILLEGAL - DISTRICT_CODE_ILLEGAL - UK_OCCUPIED - SETTLED_BANKCARD_ACCOUNTINSTPROVINCE_IS_EMPTY - SETTLED_BANKCARD_ACCOUNTINSTCITY_IS_EMPTY - SETTLED_CARD_SIZE_IS_ILLEGAL - BUSINESS_LICENSE_EMPTY - BANK_CODE_ILLEGAL - ADDRESS_VERSION_CODE_ILLEGAL - SHOP_SHOPNO_IS_EMPTY - SHOP_SHOPNAME_IS_EMPTY - SHOP_SOURCE_IS_ILLEGAL - CATEGORY_EVALUATE_FAIL - CATEGORY_WITH_NO_PROOF - SHOP_ASSET_CHECK_RESULT_EMPTY - SHOP_ASSET_NOT_BINDABLE - SHOP_ASSET_MAX_LIMIT - SHOP_PRE_RISK_LEVEL_ERROR - SHOP_PRE_POI_NOT_FILL_ERROR - STORE_ID_LENGTH_ILLEGAL - SHOP_COVER_OSSKEY_NOT_EXIST - SHOP_COVER_NOT_EXIST - SHOP_EXT_INFO_INPUT_ARGUMENT_ILLEGAL - SHOP_EXT_INFO_VALUE_INPUT_ARGUMENT_ILLEGAL - SHOP_CATEGORY_EMPTY type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandShopModifyModel: properties: biz_cards: description: '"门店结算卡信息。本业务当前只允许传入一张结算卡。 说明:本参数仅直付通业务使用,其余业务无需关注。"' items: $ref: '#/components/schemas/SettleCardInfo' type: array brand_id: description: 品牌id。若无需更新本信息项,可以不填写 example: "20181026000001" type: string business_address: $ref: '#/components/schemas/AddressInfo' business_time: description: 店铺经营时间。若无需更新本信息项,可以不填写 items: $ref: '#/components/schemas/ShopBusinessTime' type: array cert_image: description: 营业执照图片KEY example: c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg type: string cert_name: description: 营业执照名称,填写值为营业执照或统一社会信用代码证上的名称。 example: 支付宝东门小卖铺 type: string cert_no: description: 证件号码。请填写店铺营业执照号。 example: 9133010608210550XR type: string cert_type: description: 证件类型 example: "201" type: string contact_infos: $ref: '#/components/schemas/ContactInfo' contact_mobile: description: 店铺联系手机 example: "13901390139" type: string contact_phone: description: 店铺的联系固话 example: 010-62286228 type: string cover: description: 封面图,其值为使用ant.merchant.expand.indirect.image.upload上传图片得到的一串oss key。若无需更新本信息项,可以不填写。若填写则会整体覆盖原有的封面图 example: c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg type: string ext_infos: description: 扩展信息列表。key值需要向对应行业的bd进行申请。传入本项时,按key进行更新或补充 items: $ref: '#/components/schemas/ShopExtInfo' type: array ip_role_id: description: 商户角色id,表示将要修改的店属于哪个商户角色,和store_id一起定位待修改的门店。对于直连场景,填写商户pid;对于间连场景(线上、线下、直付通),填写商户smid。本信息项不可修改 example: "2088301155943087" type: string legal_cert_no: description: 法人身份证号。如果要更新,必须和legal_name成对传入 example: "100100198811110001" type: string legal_name: description: 法人名称。如果要更新,必须和legal_cert_no成对传入 example: 支小宝 type: string license_auth_letter_image: description: 营业执照授权函。其值为使用ant.merchant.expand.indirect.image.upload上传图片得到的一串oss key。若无需更新本信息项,可以不填写 example: c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg type: string memo: description: 备注 example: 备注 type: string out_door_images: description: 门头照,其值为使用ant.merchant.expand.indirect.image.upload上传图片得到的一串oss key。若无需更新本信息项,可以不填写。若填写则会整体覆盖原有的门头照列表 example: c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg items: type: string type: array qualifications: description: 行业特殊资质。若无需更新本信息项,可以不填写。填写会按类型进行更新或补充 items: $ref: '#/components/schemas/IndustryQualificationInfo' type: array scene: description: 场景。若无需更新本信息项,可以不填写 example: PARK type: string settle_alipay_logon_id: description: 结算支付宝账号的登录号。若无需更新本信息项,可以不填写 example: demo@163.com type: string shop_category: description: 新版门店类目标准二级类目code。类目标准及与原类目映射关系参见 支付宝门店类目-最新 表格。 example: B0001 type: string shop_id: description: 蚂蚁店铺id,用于查出待修改的门店。填写本参数的话,store_id和ip_role_id可以不填。本信息项不可修改 example: "2018011900502000000005124744" type: string shop_name: description: 店铺名称。直连开店要保证全局店铺名称+地址唯一,间连开店要保证服务商pid下店铺名称+地址唯一。若无需更新本信息项,可以不填写 example: 支付宝东门小卖铺 type: string store_id: description: 门店编号,表示该门店在该商户角色id(直连pid,间连smid)下,由商户自己定义的外部门店编号。用于查出待修改的门店。 example: NO0001 type: string type: object AntMerchantExpandShopModifyResponseModel: properties: order_id: description: 申请单id example: "2018012000502000000005130266" type: string type: object AntMerchantExpandShopPageQueryErrorResponseModel: properties: code: description: 错误码 enum: - MER_ARGUMENT_NULL - NOT_ALLOWED_SETTLE - MERCHANT_NOT_EXIST - SYSTEM_ERROR - ADDRESS_VERSION_CODE_ILLEGAL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandShopPageQueryResponseModel: properties: alipay_poiid: description: 门店地址库 ID,按照一定的平台规则识别出的线下真实存在、真实经营的蚂蚁门店地址库 ID,将作用于服务商的返佣激励、商品/券等权益的公域分发。如平台未返回alipay_poiid,请在确认门店信息真实有效后,稍后再进行查询 example: "2022082900502055000000100000" type: string shop_infos: description: 门店详情 items: $ref: '#/components/schemas/ShopQueryOpenApiVO' type: array total_pages: description: 总页数 example: 10 type: integer type: object AntMerchantExpandShopQueryErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandShopQueryResponseModel: properties: alipay_poiid: description: 门店地址库 ID,按照一定的平台规则识别出的线下真实存在、真实经营的蚂蚁门店地址库 ID,将作用于服务商的返佣激励、商品/券等权益的公域分发。如平台未返回alipay_poiid,请在确认门店信息真实有效后,稍后再进行查询。 example: "2022082900502055000000100000" type: string brand_id: description: 品牌id example: "20181026000001" type: string business_address: $ref: '#/components/schemas/AddressInfo' business_time: description: 店铺经营时间。 items: $ref: '#/components/schemas/ShopBusinessTime' type: array cert_image: description: 营业执照图片url。返回值为一个有访问时限的链接 example: https://mif-pub.alipayobjects.com/c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg type: string cert_name: description: 营业执照名称,值为营业执照或统一社会信用代码证上的名称。 example: xxxx小卖铺 type: string cert_no: description: 证件号码 example: 9133010608210550XR type: string cert_type: description: 证件类型,取值范围:201:营业执照;2011:多证合一(统一社会信用代码)。 example: "201" type: string contact_infos: description: 联系人信息。 items: $ref: '#/components/schemas/ContactInfo' type: array contact_mobile: description: 店铺联系手机 example: "13901390139" type: string contact_phone: description: 店铺的联系固话 example: 010-62286228 type: string ext_infos: description: 扩展信息列表。key值需要向对应行业的bd进行申请。 items: $ref: '#/components/schemas/ShopExtInfo' type: array ip_role_id: description: 商户角色id,表示将要开的店属于哪个商户角色。对于直连开店场景,填写商户pid;对于间连开店场景(线上、线下、直付通),填写商户smid。若未传入shop_id 则本参数与store_id均必填。 example: "2088301155943087" type: string legal_cert_no: description: 法人身份证号。 example: "100100198811110001" type: string legal_name: description: 法人名称。 example: 马云 type: string license_auth_letter_image: description: 营业执照授权函。返回值为一个有访问时限的链接 example: https://mif-pub.alipayobjects.com/c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg type: string memo: description: 备注 example: 备注 type: string new_shop_category: description: 新版门店类目标准二级类目code example: B0001 type: string out_door_images: description: 门头照,返回值为一个有访问时限的链接 example: https://mif-pub.alipayobjects.com/c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg items: type: string type: array qualifications: description: 行业特殊资质。 items: $ref: '#/components/schemas/IndustryQualificationInfo' type: array scene: description: 场景 example: PARK type: string settle_alipay_logon_id: description: 结算支付宝账号的登录号 example: demo@163.com type: string shop_category: description: 店铺类目,取值参见文件中的三级门店类目 example: "1001" type: string shop_id: description: 支付宝侧蚂蚁店铺 id example: "2018011900502000000005124744" type: string shop_info_status: description: 当前名称、地址、经纬度信息准确一致,可用于数字化经营场景消费(如商品、券、消费圈等场域的分发),不影响门店支付结算 example: "01" type: string shop_name: description: 店铺名称。 example: 肯德基中关村店 type: string shop_recommend_info: $ref: '#/components/schemas/ShopRecommendInfo' shop_type: description: 店铺经营类型 example: "01" type: string store_id: description: 商户侧门店编号。表示该门店在该商户角色id(直连pid,间连smid)下,由商户自己定义的外部门店编号。若未传入 shop_id 则本参数与与ip_role_id均必填。 example: NO0001 type: string type: object AntMerchantExpandShopReceiptaccountSaveErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AntMerchantExpandShopReceiptaccountSaveModel: properties: promise: description: "是否承诺收单账号信息准确。具体承诺信息可查看 门店信息承诺函。\tY 是\tN 否" example: "Y" type: string receipt_account_id: description: 收单账号 example: "2088502344354813" type: string shop_id: description: 店铺ID example: "2022062300502007000073505619" type: string type: object AntMerchantExpandShopReceiptaccountSaveResponseModel: type: object AnttechOceanbaseTestplatformTaskQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object AnttechOceanbaseTestplatformTaskQueryModel: properties: end_time: description: 筛选结束时间 example: 2022-04-18 15:28:52 type: string palyer: description: 参赛选手的名字 example: 无名选手 type: string run_task_retry: description: 允许超时任务的重试次数 example: 3 type: integer run_task_time_out_minutes: description: 获取任务时先获取超时任务,这里传入的是超时的分钟数。默认30分钟。 example: 30 type: integer start_time: description: 获取任务的筛选条件 example: 2022-04-15 18:36:24 type: string test_cases: description: 二级提测题目 example: 查询元数据校验select-meta type: string test_info: description: 测试结果描述、备注信息 example: 代码风格比较好 type: string test_suite: description: 一级提测题目 example: mini-ob type: string type: object AnttechOceanbaseTestplatformTaskQueryResponseModel: properties: branch: description: 提测代码的分支 example: test-miniob type: string commit_id: description: 提测代码仓库的commit id example: 586cbbe560dff2792dcc76e5705367b21fa1df5d type: string current_retry: description: 当前任务的运行(重试)次数 example: "1" type: string git_repo: description: 代码仓库的url example: https://github.com/oceanbase/oceanbase.git type: string gmt_create: description: 任务创建的时间戳 example: 2022-04-15 18:36:24 type: string player: description: 参赛选手的名字 example: 无名选手 type: string result_type: description: 提测结果类型 默认1 example: 1 type: integer task_id: description: 测试任务的Id example: 1 type: integer test_cases: description: 二级提测题目 example: 查询元数据校验select-meta type: string test_info: description: 测试题目 example: 必做。查询语句中存在不存在的列名、表名等,需要返回失败。需要检查代码,判断是否需要返回错误的地方都返回错误了。 type: string test_suite: description: 一级提测题目 example: mini-ob type: string type: object AppItemInfo: properties: item_id: description: 小程序商品-支付宝内部商品id example: "2023041422000600076270" type: string item_use_type: description: 商品可用类型 example: AVAILABLE type: string mini_app_id: description: 小程序id example: "2021238412323412" type: string out_item_id: description: 外部商品ID example: "2021003131689002" type: string type: object AppMemberInfo: properties: gmt_invite: description: 邀请时间,格式为yyyy-MM-dd HH:mm:ss example: 2017-09-08 12:00:00 type: string gmt_join: description: 加入时间,格式为yyyy-MM-dd example: 2017-08-12 type: string logon_id: description: 支付宝登录账号 example: test***@example.com type: string nick_name: description: 昵称 example: 张三 type: string open_id: description: 支付宝用户openId example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string portrait: description: 头像地址fileId(完整地址需自行拼接) example: AAA-AAAAAAAAA type: string role: description: 角色类型 example: DEVELOPER type: string status: description: 成员的状态 example: VALID type: string user_id: description: 支付宝用户id example: 208822294389xxxx type: string type: object AppTokenExchangeSubElement: properties: app_auth_token: description: 应用授权令牌 example: 201509BBeff9351ad1874306903e96b91d248A36 type: string app_refresh_token: description: 刷新令牌 example: 201509BBdcba1e3347de4e75ba3fed2c9abebE36 type: string auth_app_id: description: 授权商户appid example: "2013121100055554" type: string expires_in: description: 过期时间 example: "123456" type: string re_expires_in: description: 刷新令牌过期时间 example: "123456" type: string user_id: description: 授权商户的user_id example: "2088102150527498" type: string type: object AppVersionInfo: properties: app_version: description: 版本号,一般为x.y.x格式,其中x、y、z都是数字 example: 0.2.9 type: string base_audit: description: "准入审核结果\t(提审时 audit_rule 传 BASE_PROMOTE 时有该字段)" example: PASS type: string bundle_id: description: "小程序客户端类型,默认为支付宝端。常见支持如下客户端:\tcom.alipay.alipaywallet:支付宝端;\ \tcom.alibaba.android.rimet:DINGDING端;\tcom.amap.app:高德端;\tcom.alibaba.ailabs.genie.webapps:\ 天猫精灵端;\tcom.alipay.iot.xpaas:支付宝IoT端。\t如需更多端投放,请联系业务BD。" example: com.alipay.alipaywallet type: string can_release: description: "是否可上架\ttrue:可上架\tfalse:不可上架\t(version_status 为PROMOTE_AUDIT_REJECT有\ 值)\t(提审时 audit_rule 传 BASE_PROMOTE 时有该字段)" example: "true" type: string create_time: description: 版本创建时间,精确到秒 example: 2019-12-11 19:00:12 type: string promote_audit: description: "营销审核结果:\tPASS:通过\tREJECT:驳回\t(提审时 audit_rule 传 BASE_PROMOTE\ \ 时有该字段)" example: PASS type: string version_description: description: 小程序版本描述,介绍此版本的主要变更和功能,5-500个字符。 example: 该版本新增了XXX功能,修复了XXX的bug,优化了用户体验。 type: string version_status: description: "版本状态,可选值为:INIT: 开发中, AUDITING: 审核中, AUDIT_REJECT: 审核驳回, WAIT_RELEASE:\ \ 待上架, BASE_AUDIT_PASS: 准入不可营销, GRAY: 灰度中, RELEASE: 已上架, OFFLINE: 已下架\ , AUDIT_OFFLINE: 被强制下架;" example: AUDITING type: string type: object ApplyOrderData: properties: access_type: description: 申请类型 BASE:基础信息, BRAND_BOX:品牌直达,SERVICE_BOX服务直达 example: BRAND_BOX type: string app_name: description: 小程序名称 example: 小程序名称 type: string appid: description: 小程序id example: "2021001105612404" type: string audit_reason: description: 审核原因 example: 同意 type: string brand_template_id: description: 品牌的模板id ONE_WITH_TWO:一拖二、DEFAULT:一拖四 example: DEFAULT type: string create_time: description: 创建时间 example: 2020-10-16 12:32:40 type: string is_old_data: description: 标识老工单 example: false type: boolean latest: description: 是不是最新的工单 example: false type: boolean major_status: description: "服务主状态,INITIAL:初始化;VALID:已生效;INVALID:已失效" example: INITIAL type: string order_id: description: 申请单ID example: AP20200212100002488 type: string part_agree_info: description: 审核提效部分剔除数据的信息 items: $ref: '#/components/schemas/SearchPartAgreeInfo' type: array scene_code: description: 场景编码 example: HOT_WORD_RANKING type: string scene_name: description: 场景名称 example: 场景名称 type: string service_code: description: 服务码 example: "2019121121000102523089" type: string status: description: 申请状态 AGREE、REJECT、EDIT、AUDIT example: AGREE type: string sub_service_name: description: 子服务名称 example: 子服务名称 type: string type: object ArInvoiceLineOpenApiResponse: properties: amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' duty_free_flag: description: 免税标识 type: string incl_tax_unit_amt: description: 含税单价 type: integer invoice_id: description: 关联的发票ID type: string invoice_line_id: description: 发票行iD type: string measurement_unit: description: 计量单位 type: string product_name: description: 货物或劳务名称 type: string product_specification: description: 规格型号 type: string quantity: description: 数量 type: integer tax_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' tax_exclusive_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' tax_rate: description: 税率 type: integer unit_amt: description: 单价 type: integer type: object ArInvoiceOpenApiResponse: properties: ar_invoice_lines: description: 发票行信息集合 items: $ref: '#/components/schemas/ArInvoiceLineOpenApiResponse' type: array buyer_address: description: 购方的地址 type: string buyer_bank_account: description: 购方银行账号 type: string buyer_bank_name: description: 购方开户行名称 type: string buyer_invoice_title: description: 购方发票抬头,用于打印在发票上 type: string buyer_tax_no: description: 购方税号 type: string buyer_telephone: description: 购方的电话号码 type: string can_link: description: 是否可以关联账单 type: boolean creator: description: 创建人 type: string drawer: description: 开票人 type: string elc_invoice_url: description: 电子发票在oss上的存储地址 type: string gmt_create: description: 创建时间 type: string gmt_modified: description: 修改时间 type: string inst_id: description: 对应发票所在OU的id,用于标示该发票所述的OU。 type: string invoice_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' invoice_channel: description: 开票渠道,01:在线,02:线下 type: string invoice_code: description: 发票编码 type: string invoice_date: description: 发票的开票日期,yyyyMMdd type: string invoice_id: description: 发票ID,唯一标示一张发票 type: string invoice_material: description: 发票介质,01:电子,02:纸质 type: string invoice_no: description: 发票号码 type: string invoice_note: description: 发票备注 type: string invoice_status: description: "发票状态:用于标示发票当前的状态,状态类型以及相关含义\r\t01:待开票,02:开票中,03:已开票,04:作废中\ ,05:已作废,06:红冲中,07:已红冲,08:部分红冲,09:无效" type: string invoice_type: description: 发票类型:01:专票,02:普票,03:营业税发票,04:国际形式发票,05:其它发票 type: string ip_id: description: 对应发票商户的ipId,在主站标示mid,在其他环境标示ip_id。 type: string ip_role_id: description: 商户结算的ipRoleId,表示商户的结算对象,在主站表示pid。 type: string last_moder: description: 最近修改人 type: string linked_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' mail_status: description: "发票开出后的邮寄状态,具体状态说明\r\t01:待邮寄,02:已邮寄,03:退回中,04:已退回" type: string memo: description: 备注 type: string no_bill_invoice_flag: description: 是否是无账单发票 Y:是 N:不是 type: string online: description: "是否为点在发票\r\ttrue:是, false:不是" type: boolean payee: description: 收款人 type: string recent_mail_id: description: 邮件信息的主键,用于‘根据发票邮寄ID获取当前的邮寄信息’的查询输入。 type: string red: description: 是否红字 Y:红字, N:蓝字 type: string red_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' rel_blue_invoices: description: 发票如果有关联的蓝票则显示发票关联的蓝票信息 items: $ref: '#/components/schemas/ArRelInvoiceOpenApiResponse' type: array rel_red_invoices: description: 如果发票有关联的红票则为关联的红票的信息 items: $ref: '#/components/schemas/ArRelInvoiceOpenApiResponse' type: array reviewer: description: 复核人 type: string seller_address: description: 销方公司地址 type: string seller_bank_account: description: 销方银行账号 type: string seller_bank_name: description: 销方开户行名称 type: string seller_company_name: description: 销方公司名称 type: string seller_tax_no: description: 销方税号,用于打印在发票上 type: string seller_telephone: description: 销方公司电话 type: string tnt_inst_id: description: 租户id type: string type: object ArInvoiceReceiptOpenApiResponse: properties: arrangement_no: description: 合约号 example: 20180410I1019001100551917674 type: string id: description: 可开票单据主键ID example: "2016090310122000040400210000000001" type: string inst_id: description: 机构ID example: Z50 type: string inv_dt: description: 开票时间 格式:yyyymm example: "201807" type: string inv_mode: description: "开票模式\r\t01:实收开票, 02:应收开票, 03:累计实收开票" example: "02" type: string invoice_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' invoiced_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' ip_id: description: 结算ip_id example: "727407" type: string ip_role_id: description: 结算对象ip_role_id example: "2088301208226048" type: string last_moder: description: 最后修改人 example: 李某某 type: string link_invoice_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' out_biz_no: description: 外部单据号,对应开票记录的月账单号 example: "2017090611122000040400450000091196" type: string out_biz_type: description: 可开票单据来源,01:主站,02:芝麻,03:金融云,04:微贷 example: "03" type: string pay_way: description: 付款方式,1:资金,5:走量 example: "1" type: string prod_code: description: 产品码 example: w1010100100000000018 type: string settle_type: description: 结算类型 ,01:实时,02:预收,03:后收,04:周期性,05:按日汇总,09:延期结算 example: "02" type: string status: description: 开票金额消耗状态:01未开票,02部分开票,03:已开票 example: "01" type: string tax_rate: description: 税率 type: integer tax_type: description: 税收类型01:增值税,02:营业税 example: "01" type: string tnt_inst_id: description: 租户ID example: ANTGW2CN type: string type: description: 类型,1:应收,2:返点 example: "1" type: string type: object ArMonthlyBillDTO: properties: account_day: description: 出账日 example: "20180723" type: string accrued_date: description: 应收日期(yyyyMMdd) example: "20180723" type: string adjust_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' analysis_dmsn_1: description: 分析维度1 example: biz_pd_code=G1010100100000000004 type: string analysis_dmsn_2: description: 分析维度2 example: recon_inst=V_F51_SZBK type: string analysis_dmsn_3: description: 分析维度3 example: payer_inst_code=SZBK type: string analysis_dmsn_4: description: 分析维度4 example: groupIpId=123&groupIpRoleId=def type: string arrangement_no: description: 合约号,商户签约产品对应的合约号 example: 20180321I1019001104967771632 type: string bill_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' bill_end_date: description: 账单结束日期 example: "20180723" type: string bill_month: description: 账单月 example: "201807" type: string bill_no: description: "月账单号,唯一标识月账单的ID" example: "2016092910122000040400930000000001" type: string bill_start_date: description: 账单开始日期 example: "20180723" type: string bill_type: description: "账单类型\r\t21:应收月账单\r\t目前仅支持该类型的账单类型" example: "21" type: string charge_item_code: description: 收费项编码 example: CREDIT_QUERY_FEE type: string charge_type: description: "计费类型\r\t01:云在线计费,02:离线计费,03:老主站计收费,04:芝麻在线计收费" example: "01" type: string check_status: description: "出账状态\r\t01:账单生成,02:待确认出账,03:已出账,04:客户已对账,05:对账差异,06:部分出账" example: "03" type: string checked_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' checking_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' clcn_basic_amt: description: 计算依据 example: 100 type: integer clcn_basic_type: description: "计算依据类型\r\t01:交易金额,02:交易笔数,03:交易张数,04:资费依据扩展,05:其他" example: "01" type: string clcn_method: description: "计算方法\r\t01:差额累进,02:全额累进,03:按传入金额收费,04:价格包量,05:包时间周期,06:按时间\ 全额累进,07:包时间周期差额累进,08:期间差额累进,09:期间全额累进,10:包时间周期单笔,11:标准单笔计费,12:包时间周期单笔\ -按照传入金额计费,13:期间靠档差额累进,靠档计息使用,14:自定义" example: "02" type: string freeze_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' gmt_create: description: 创建时间(创建备份时需要) example: "1533039333744" type: string gmt_modified: description: 修改时间(创建备份时需要) example: "1533039333744" type: string gmt_pay: description: 付款时间 example: "1533039333744" type: string inst_id: description: 分支机构号 example: Z50 type: string invoice_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' invoiced_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' ip_id: description: 结算对象参与者标识 example: "17998789" type: string ip_name: description: 参与者名字 example: ip_name type: string ip_role_id: description: 结算对象参与者角色标识 example: "2088421727939934" type: string last_moder: description: 最后修改人 example: 李某某 type: string link_invoice_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' pay_original: description: "付款来源\r\t1:主账务,2:包量,3:预收,4:预存,5:银行,6:积分,7:统一支付,8:支付受理" example: "1" type: string pay_status: description: "付款状态\r\t01:待结算;02:部分结算;03:结算完成" example: "01" type: string pay_way: description: "付款方式\r\t1:资金;2:包量" example: "1" type: string payee_account: description: 收款方账号 example: "20880013684318990156" type: string payer_account: description: 付款方账号 example: "20880013684318990156" type: string payer_ip_role_id: description: 扣款对象pid example: "2088301287583636" type: string prod_code: description: 产品码 example: w1010100100000000018 type: string received_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' record_id: description: 记录id,账单全局唯一号 example: 70cf1a075478780bc0c38d1e9e28c001 type: string service_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' settle_type: description: "结算类型\r\t01:实时;02:预收;03:后收;04:周期结算;05:按日汇总结算;09:延期结算" example: "03" type: string sign_ip_id: description: 签约对象参与者标识 example: "203668" type: string sign_ip_role_id: description: 签约对象参与者角色标识 example: "2088101106290325" type: string stl_ip_role_id: description: 结算对象PID example: "2088301287583636" type: string tax_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' tax_rate: description: 税率 type: integer tax_type: description: "税收类型,01:增值税,02:营业税\r\t营业税已经在大部分行业废弃,要传入需咨询后再确认" example: "01" type: string to_writeoff_detail_count: description: 待核销明细数量 example: 3 type: integer type: description: 账单分类 1应收,2返点 example: "1" type: string writeoff_detail_dount: description: 核销明细数量 example: 5 type: integer writingoff_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' type: object ArRelInvoiceOpenApiResponse: properties: ar_invoice_lines: $ref: '#/components/schemas/ArInvoiceLineOpenApiResponse' buyer_address: description: 购方的地址 type: string buyer_bank_account: description: 购方银行账号 type: string buyer_bank_name: description: 购方开户行名称 type: string buyer_invoice_title: description: 购方发票抬头,用于打印在发票上 type: string buyer_tax_no: description: 购方税号 type: string buyer_telephone: description: 购方的电话号码 type: string can_link: description: 是否可以关联账单 type: boolean creator: description: 创建人 type: string drawer: description: 开票人 type: string elc_invoice_url: description: 电子发票在oss上的存储地址 type: string gmt_create: description: 创建时间 type: string gmt_modified: description: 修改时间 type: string inst_id: description: 对应发票所在OU的id,用于标示该发票所述的OU。 type: string invoice_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' invoice_channel: description: 开票渠道,01:在线,02:线下 type: string invoice_code: description: 发票编码 type: string invoice_date: description: 发票的开票日期,yyyyMMdd type: string invoice_id: description: 发票ID,唯一标示一张发票 type: string invoice_material: description: 发票介质,01:电子,02:纸质 type: string invoice_no: description: 发票号码 type: string invoice_note: description: 发票备注 type: string invoice_status: description: 发票状态:用于标示发票当前的状态,状态类型以及相关含义 01:待开票,02:开票中,03:已开票,04:作废中,05:已作废,06:红冲中,07:已红冲,08:部分红冲,09:无效 type: string invoice_type: description: 发票类型:01:专票,02:普票,03:营业税发票,04:国际形式发票,05:其它发票 type: string ip_id: description: 对应发票商户的ipId,在主站标示mid,在其他环境标示ip_id。 type: string ip_role_id: description: 商户结算的ipRoleId,表示商户的结算对象,在主站表示pid。 type: string last_moder: description: 最近修改人 type: string linked_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' mail_status: description: 发票开出后的邮寄状态,具体状态说明 01:待邮寄,02:已邮寄,03:退回中,04:已退回 type: string memo: description: 备注 type: string no_bill_invoice_flag: description: 是否是无账单发票 Y:是 N:不是 type: string online: description: 是否为线上发票 true:是, false:不是 type: boolean payee: description: 收款人 type: string recent_mail_id: description: 邮件信息的主键,用于‘根据发票邮寄ID获取当前的邮寄信息’的查询输入。 type: string red: description: 是否红字 Y:红字, N:蓝字 type: string red_amt: $ref: '#/components/schemas/MultiCurrencyMoneyOpenApi' reviewer: description: 复核人 type: string seller_address: description: 销方公司地址 type: string seller_bank_account: description: 销方银行账号 type: string seller_bank_name: description: 销方开户行名称 type: string seller_company_name: description: 销方公司名称 type: string seller_tax_no: description: 销方税号,用于打印在发票上 type: string seller_telephone: description: 销方公司电话 type: string tnt_inst_id: description: 租户id type: string type: object Article: properties: action_name: description: 链接文字 type: string desc: description: 图文消息内容 type: string image_url: description: 图片链接,对于多条图文消息的第一条消息,该字段不能为空; 请先调用 图片上传接口获得图片url type: string title: description: 图文消息标题 type: string url: description: 点击图文消息跳转的链接 type: string type: object ArticleAttachmentInfo: properties: file_name: description: 文章附件 type: string key: description: 附件完整Key type: string url: description: 附件的url type: string type: object ArticleCategoryInfo: properties: children: description: 子节点 items: type: string type: array description: description: 节点描述 type: string father_id: description: 父节点ID type: integer id: description: 类目ID type: integer name: description: 节点名称 type: string tags: description: 标签 items: type: string type: array type: object ArticleInfo: properties: attachments: description: 文章对应附件集合 items: $ref: '#/components/schemas/ArticleAttachmentInfo' type: array category_id: description: 所属类目ID example: 12 type: integer category_name_path: description: 类目名称路径 example: 知识库-演示 type: string category_path: description: 类目路径 items: $ref: '#/components/schemas/ArticleCategoryInfo' type: array content: description: 内容 example: 我是文章内容 type: string create_time: description: 创建时间 example: 2020-12-31 23:59:59 type: string creator_id: description: 创建人 example: "10001" type: string extend_titles: description: 扩展标题 example: "[\"支付宝\",\"知识库\"]" items: type: string type: array id: description: 文章ID example: 1 type: integer keywords: description: 标签 example: "[\"标签\"]" items: type: string type: array library_id: description: 知识库ID example: 1 type: integer order_no: description: 排序值 example: 5 type: integer pictures: description: 文章对应图片集合 items: $ref: '#/components/schemas/ArticleAttachmentInfo' type: array publish_end: description: 有效期止 example: 2022-06-11 16:14:58 type: string publish_start: description: 有效期起始 example: 2020-06-11 16:14:58 type: string scene_codes: description: 场景ID。1(内部知识库);2(机器人);3(帮助中心);4(无线帮助中心) example: "[\"1\",\"2\",\"3\",\"4\"]" items: type: string type: array source: description: 来源 example: 网关录入 type: string status: description: 文章状态 example: 已发布 type: string status_code: description: 文章状态码 example: PUBLISHED type: string title: description: 标题 example: 我是文章标题 type: string update_time: description: 修改时间 example: 2020-12-31 23:59:59 type: string updater_id: description: 修改人 example: "10001" type: string updater_name: description: 修改人名称 example: admin type: string type: object ArticleSummaryAnalysisData: properties: avg_read_time: description: 人均阅读时长 example: "50.39" type: string date: description: 日期 example: "20171101" type: string deliver_user_cnt: description: 送达人数 example: 10 type: integer expose_user_cnt: description: 图文曝光人数 example: 30 type: integer praise_user_cnt: description: 点赞数 example: 30 type: integer read_user_cnt: description: 图文阅读人数 example: 20 type: integer reply_user_cnt: description: 评论数 example: 30 type: integer share_user_cnt: description: 分享人数 example: 40 type: integer type: object AssetShareSourceInfo: properties: share_mode: description: 当前规则可用的资产来源类型,搭配source_id_list使用。 type: string source_id_list: description: 资产共享来源id列表,与share_mode配合设置 items: type: string type: array type: object Attachment: properties: attachment_name: description: 流程附件名称 type: string file_id: description: 流程附件id type: string type: object AttachmentDetail: properties: code: description: 创建流程时指定的附件code,可能为空。(身份证正反面的固定code:正面:ESIGN_IDCARD,背面:ESIGN_BACK_IDCARD) example: phonePicture type: string file_name: description: 附件文件名 example: 手机正面照.pdf type: string file_url: description: 附件下载地址 example: https://asset.tsign.cn/apps/esign-nuxt-website/prod/1.0.7/img/1acc358.png type: string type: object AttachmentExplain: properties: allow_more_uploads: description: 允许上传更多附件。开启后,除了“附件列表”中指定的内容,签署人可自由上传之多10张图片。默认值为false example: true type: boolean description: description: 描述 example: 请仔细检查手机外观,如有划痕部位请仔细拍摄。 type: string details: description: 附件列表 items: $ref: '#/components/schemas/Detail' type: array title: description: 附件标题(collect_attachement值为true时必填 example: 请上传手机照片 type: string type: object AttachmentExplainBean: properties: description: description: 页面展示的任务描(collect_attachement值为true时必填) example: 请仔细检查手机外观,如有划痕部位请仔细拍摄。 type: string details: description: 附件列表,用于定义每个附件code的描述及页面展示顺序 items: $ref: '#/components/schemas/DetailBean' type: array title: description: 页面展示的任务标题(collect_attachement值为true时必填) example: 请上传手机照片 type: string type: object AuditEvidenceInfo: properties: file_type: description: 文件类型。包括.jpg .png .jpeg .pdf等 example: .jpg type: string url: description: 文件url example: http://xxx.xxx.com/xxxxx type: string type: object AuditLicenseInfo: properties: license_name: description: 营业执照名称,需要与营业执照保持一致 type: string license_no: description: 营业执照号,部分小程序类目需要提交,参照https://docs.alipay.com/isv/10325中是否需要营业执照信息,如果不填默认采用当前小程序应用营业执照号。 type: string license_pic_list: description: 营业执照照片地址列表 items: type: string type: array license_valid_date: description: 营业执有效期,格式为yyyy-MM-dd,9999-12-31表示长期 type: string out_door_pic: description: 门头照图片地址,部分小程序类目需要提交,参照https://docs.alipay.com/isv/10325中是否需要营业执照信息,如果不填默认采用当前小程序门头照图片 type: string type: object AuthApiDTO: properties: api_name: description: 敏感信息可申请接口名 example: app.mini.user.query type: string field_name: description: 敏感信息申请字段 example: "name,phone" type: string package_code: description: 敏感信息申请能力code值 example: "201322123123" type: string type: object AuthFieldApply: properties: api_name: description: 接口英文名称,通过alipay.open.app.api.query接口查询获得。 example: alipay.user.info.share type: string customer_answer: description: 贵公司是否有自己的客服渠道,能及时响应和处理舆情数量是多少? example: 有自己的客服团队xx人,能够及时响应并处理舆能力 type: string field_name: description: 字段英文名称,通过alipay.open.app.api.query接口查询获得。 example: mobile type: string memo: description: 备注 example: 获取xx的用途:(1)xxxx(2)xxxx type: string package_code: description: 功能code,通过alipay.open.app.api.query接口查询获得 example: "20201019201538211864" type: string qps_answer: description: 接入后一年内预计接口秒级调用量峰值是多少?(最高峰值:1000QPS) example: 预计接口秒级调用量峰值:xx QPS type: string scene_code: description: 场景code,alipay.open.app.api.scene.query 接口查询获得 example: "6" type: string tiny_app_template_id: description: 当为使用使用模板的小程序申请时可传入所使用的小程序模板id example: 小程序模板id type: string type: object AuthFieldDTO: properties: api_name: description: 接口英文名称 example: alipay.user.info.share type: string field_name: description: 接口字段英文名称 example: mobile type: string package_code: description: 接口归属的功能code example: "20190910140822144236" type: string reason: description: 驳回原因 example: 使用场景不在信息开放的范围内 type: string status: description: AUDIT 审核中,AGREE通过,REJECT驳回,INVALID无效(isv代申请场景) example: AUDIT type: string user_app_id: description: 用户应用app_id example: "2008001193675073" type: string type: object AuthFieldResponse: properties: records: description: 用户信息申请记录列表 items: $ref: '#/components/schemas/AuthFieldDTO' type: array type: object AuthFieldSceneDTO: properties: scene_code: description: 场景CODE example: "123" type: string scene_desc: description: 场景code描述 example: 汽车服务 type: string type: object AuthIdentityInfo: properties: certificate_info: $ref: '#/components/schemas/IndirectCertificateInfo' certificate_type: description: "主体类型为企业/个体户/政府机关/事业单位/社会组织时,必填;\t证照类型:营业执照(BUSINESS_CERT)/登\ 记证书(REGISTER_CERT)\t主体为政府机关/事业单位/社会组织时,填登记证书;\t主体类型为企业/个体户时,填营业执照;" example: BUSINESS_CERT type: string employer_letter_img: description: 单位证明函照片(使用图片上传接口)主体类型为政府机关/事业单位时,单位证明函照片必填 example: a5d373f6-3e79-405f-9993-fb7ea051c372.jpg type: string financial_org_info: $ref: '#/components/schemas/IndirectFinancialOrgInfo' identity_type: description: 主体类型,枚举定义:企业(ENTERPRISE)、个体工商户(IND_BIZ)、事业单位(INST)、党政机关(GOV)、社会组织(ORG)、小微商户(MSE) example: ENTERPRISE type: string is_financial_org: description: 是否金融机构 example: false type: boolean qualification_info_list: description: 经营许可证列表,填写特殊行业的经营许可证信息,一个主体最多5个行业 items: $ref: '#/components/schemas/IndirectQualificationInfo' type: array support_credentials: $ref: '#/components/schemas/IndirectSupportCredentials' type: object AuthInfo: properties: auth_code: description: 授权号 example: "12345678" type: string auth_type: description: 授权类型 example: deduct_code type: string type: object AuthInfoDTO: properties: agreement_no: description: 授权协议号 example: "20221212123412341234" type: string alipay_logon_id: description: 授权的支付宝账号,脱敏。 example: demo****@alipay.com type: string type: object AuthenticationResult: properties: authentication_data: description: 已加密的鉴权数据 example: eyJlcGhlbWVyYWxQdWJsaWNLZXkiOiJNRmt3RXdZSEtvWkl6ajBDQVFZSUtvWkl6ajBEQVFjRFFnQUVyZHU5cXRORFRYVFFnaHNoUEdSMzdxSTd type: string authentication_mechanism: description: 鉴权类型,如:支付密码、数字签名 example: PaymentPINInput type: string type: object AuthorizeDetailDTO: properties: authorized_principal_id: description: 收单主体PID type: string type: object AuthorizeInfo: properties: auth_ids: description: "授权方身份证明(当前只支持图片类型,请调用alipay.open.mini.miniapp.brand.upload接\ 口上传图片,可以上传多个授权方身份证明)" example: "[\"ua2qD53TRpyfX-UYYin6sQAAACMAAQED\",\"ua2qD53TRpyfX-UYYin6sQAAACMAAQED\"\ ]" items: type: string type: array auth_materials: description: 授权有效资质(当前只支持图片类型,请调用alipay.open.mini.miniapp.brand.upload接口上传图片,可以上传多个授权有效资质) example: "[\"ua2qD53TRpyfX-UYYin6sQAAACMAAQED\",\"ua2qD53TRpyfX-UYYin6sQAAACMAAQED\"\ ]" items: type: string type: array auth_name: description: 被授权人名称 example: 张三 type: string end_date: description: 授权有效期(结束日期) example: 2021-10-16 type: string start_date: description: 授权有效期(开始日期) example: 2022-02-10 08:00:00 type: string type: object AuthorizedRuleDTO: properties: authorized_detail_list: description: 授权商户列表 items: $ref: '#/components/schemas/AuthorizeDetailDTO' type: array authorized_type: description: "WHITELIST-白名单\tALL-全部" type: string type: object BackgroundWordInfo: properties: background_word: description: 底纹词 example: 底纹词 type: string fail_reason: description: 审核失败原因 example: 审核失败原因 type: string status: description: 底纹词状态 example: ONLINE type: string type: object BailDetailResult: properties: amount: description: 保证金收支金额 example: "10.00" type: string bail_type: description: 保证金类型描述,仅供参考 example: 天猫保证金 type: string balance: description: 本次操作后的保证金余额。字段数据展示为"--",表明数据暂未更新,请稍等1分钟后重试。 example: "1000.00" type: string biz_desc: description: 业务描述,资金收支对应的详细业务场景信息 example: 余额账户迁入 type: string biz_orig_no: description: 业务基础订单号,资金收支对应的原始业务订单唯一识别编号 example: 1*** type: string memo: description: 保证金说明 example: 保证金冻结 type: string trans_dt: description: 业务发生时间 example: 2019-01-01 00:00:00 type: string trans_log_id: description: 保证金业务流水号 example: 20190101*** type: string type: object BankActivityInfo: properties: bind_card: description: 是否绑定银行卡 example: true type: boolean card_name: description: 银行卡名称 example: 广发银行储蓄卡 type: string discount_desc: description: 优惠描述 example: 满50元减10元 type: string logo: description: 活动logo example: http:xxxx type: string type: object BankcardExtInfo: properties: account_type: description: "收款账户类型。\r\t1:对公(在金融机构开设的公司账户),如果银行卡为对公,必须传递省市支行信息或者联行号\r\t\ 2:对私(在金融机构开设的个人账户)" type: string bank_code: description: 银行支行联行号 type: string inst_branch_name: description: 收款银行所属支行 type: string inst_city: description: 收款银行所在市 type: string inst_name: description: 机构名称 type: string inst_province: description: 银行所在省份 type: string type: object BatchRoyaltyDetail: properties: amount: description: 分账金额,单位元 example: "10.00" type: string desc: description: 分账描述 example: 分账给xxxxx type: string error_code: description: "错误编码\tBANK_CARD_ERROR:银行卡信息有误的场景,系统自动重试中\tBANK_DISHONOR:银行\ 退票" example: BANK_DISHONOR type: string error_desc: description: 错误描述 example: 账号与户名不一致 type: string status: description: ACCEPT_SUCCESS:受理成功; SUCCESS:结算成功; FAIL:结算失败;FAIL_RETRY:失败重试。 example: ACCEPT_SUCCESS type: string trans_in_account_id: description: 分账转入账户id。当分账账户id类型是cardSerialNo时,本参数为用户在支付宝绑定的卡编号;当分账账户id类型是userId时,本参数为用户的支付宝账号对应的支付宝唯一用户号;当分账账户id类型是loginName时,本参数为用户的支付宝登录号。 example: "2088101126708402" type: string trans_in_account_id_type: description: 分账转入账户id类型。 当settle_account_type 为bankCard时,本参数为cardSerialNo,表示分账账户id是银行卡编号; 当settle_account_type 为alipayBalance时,本参数为userId或者loginName,其中userId表示分账账户id是支付宝唯一用户号,loginName表示分账账户id是支付宝登录号。 example: cardSerialNo type: string trans_in_account_open_id: description: 分账转入方的OpenId,OpenId是用户在应用(AppId)下的唯一用户标识。 example: 095PJtAPYb2UkQ0mXk_X86Z_Pd7PtySKX-U3zUEwONcu3wc type: string trans_in_account_type: description: "分账账户类型。 bankCard: 分账账户为银行卡; alipayBalance: 分账账户为支付宝余额户" example: alipayBalance type: string trans_in_entity_id: description: "分账转出主体账号。\r\t\r\t当分账转出主体类型为SecondMerchant,本参数为二级商户的SecondMerchantID\r\ \t\r\t当分账转出类型为Store,本参数为StoreID" example: "2088000069652893" type: string trans_in_entity_type: description: "分账转入主体类型。 SecondMerchant:分账转入主体为二级商户\r\t\r\tStore: 结算门店" example: Store type: string trans_in_sub_merchant: $ref: '#/components/schemas/SubMerchant' trans_out_entity_id: description: "分账转出主体账号。\r\t\r\t当分账转出主体类型为SecondMerchant,本参数为二级商户的SecondMerchantID\r\ \t\r\t当分账转出类型为Store,本参数为StoreID" example: "2088000069652893" type: string trans_out_entity_type: description: 分账转出主体类型。 SecondMerchant:结算主体为二级商户,Store:结算主体为门店。 example: SecondMerchant type: string trans_out_sub_merchant: $ref: '#/components/schemas/SubMerchant' type: object BatchSettleDetail: properties: amount: description: 结算金额,单位为元 example: "10000.00" type: string currency: description: 结算币种 example: CNY type: string error_code: description: 错误编码,SETTLE_ACCOUNT_ERROR:结算账户信息有误;BANK_DISHONOR:银行提现退票;UNKNOWN_ERROR:未知错误 example: BANK_DISHONOR type: string error_desc: description: 错误描述 example: 成功 type: string settle_account_id: description: 结算账户id。当结算账户id类型是cardSerialNo时,本参数为用户在支付宝绑定的卡编号;当结算账户id类型是userId时,本参数为用户的支付宝账号对应的支付宝唯一用户号;当结算账户id类型是loginName时,本参数为用户的支付宝登录号 example: 159******78 type: string settle_account_id_type: description: "结算账户id类型。\t 当settle_account_type 为bankCard时,本参数为cardSerialNo,\ 表示结算账户id是银行卡编号;\t 当settle_account_type 为alipayBalance时,本参数为userId或者loginName,\ 其中userId表示结算账户id是支付宝唯一用户号,loginName表示结算账户id是支付宝登录号" example: loginName type: string settle_account_open_id: description: 结算账户的OpenId,本参数是用户在该应用(AppId)下的唯一用户标识。 example: 093PJtAPYb2UkQ0mXk_X86Z_FaMou-DtIEvERQ8X8yqKaEf type: string settle_account_type: description: "结算账户类型。\tbankCard: 结算账户为银行卡;\talipayBalance: 结算账户为支付宝余额户" example: alipayBalance type: string settle_entity_id: description: "结算主体账号。\t当结算主体类型为SecondMerchant,本参数为二级商户的SecondMerchantID" example: "19023454" type: string settle_entity_type: description: "结算主体类型。\tSecondMerchant:结算主体为二级商户;\tStore:结算主体为门店;" example: SecondMerchant type: string status: description: ACCEPT_SUCCESS:受理成功; SUCCESS:结算成功; FAIL:结算失败;FAIL_RETRY:失败重试。 example: BANK_DEALING type: string sub_merchant: $ref: '#/components/schemas/SubMerchant' type: object BelongMerchantInfo: properties: business_type: description: "合作业务类型,默认为ISV_FOR_MERCHANT" type: string merchant_id: description: "商户PID,默认为当前接口调用商户。" type: string merchant_id_type: description: 商户id类型。特别说明:如果merchant_id_type选择SMID。则表明当前商家券活动的归属者是该SMID所绑定的支付宝PID。因此要求该SMID必须绑定相应的支付宝PID。 type: string type: object BenefitInfoDetail: properties: amount: description: "PRE_FUND:实际核销或者商户赠送的金额\t\tDISCOUNT:实际折扣掉的金额(获取权益不支持该类型)\t\t\ COUPON:实际核销或者商户赠送的券" type: string benefit_type: description: 权益类型 type: string count: description: COUPON:当核销或者赠送券时,可以设置该值 type: string description: description: 产生核销或者赠送权益的描述 type: string type: object BillSendExtInfo: properties: order_pay_type: description: "账单唤起收银台的方式:\t1-手机wap;2-当面付。默认值为1(不传值或传非数字值)" example: "1" type: string royalty_amount: description: 分账金额 example: "0.01" type: string trans_in_pid: description: 2088xxx example: 分账收入户PID type: string type: object BizFundReportResult: properties: alipay_amount: description: 实付金额(元) example: "10000.0" type: string batch_type: description: 是否批量转账 example: "true" type: string biz_type: description: 业务类型 example: DEPOSIT type: string biz_type_desc: description: 业务类型描述 example: 转账 type: string charge_fee: description: 服务费(元) example: "0.00" type: string gmt_create: description: 交易时间 example: '"2021-06-22 19:47:15"' type: string instruction_id: description: 2020xxx example: 银行单据号 type: string memo: description: 出借 example: 备注 type: string no_mbill_encrypt: description: 是否脱敏 example: "true" type: string order_id: description: 业务订单号 example: '"20210622*******4"' type: string pay_amount: description: 实付金额(元) example: "20000.00" type: string payee_card_no: description: 收款方银行卡号 example: 23** type: string payee_full_name: description: 收款方全名 example: '**(123213**)' type: string payee_fund_type: description: 收款方资金类型 example: "01" type: string payee_fund_type_desc: description: 支付宝余额 example: 收款方资金类型描述 type: string payee_inst_name: description: 收款银行中文简称 example: 工行 type: string payee_login_email: description: 收款方登录Id example: 888@email.com type: string payee_name: description: 收款方姓名 example: '**小二' type: string payer_fund_type: description: 付款方资金类型 example: "01" type: string payer_fund_type_desc: description: 付款方资金类型描述 example: 支付宝余额 type: string refund_amount: description: 退款金额(元) example: "0.00" type: string show_detail: description: 是否展示细节,默认为true example: "true" type: string show_voucher: description: 是否出示凭证 example: "true" type: string source: description: 数据来源 example: bizfund type: string status: description: 单据状态 example: SUCCESS type: string status_desc: description: 单据状态描述 example: 成功 type: string sub_biz_type: description: 普通转账 example: COMMON_TRANSFER type: string sub_biz_type_desc: description: 业务子类型描述 example: 普通转账 type: string type: object BizOrderQueryResponse: properties: action: 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 type: string action_mode: description: 操作模式:NORMAL-普通开店 example: WITH_LEADS type: string apply_id: description: 支付宝流水ID example: "2015111410223410000001" type: string biz_context_info: description: 流水上下文信息,JSON格式。根据action不同对应的结构也不同,JSON字段与含义可参考各个接口的请求参数。 example: "{\"category_id\":\"2015050700000018\",\"main_shop_name\":\"海底捞\ 万塘路分公司\"}" type: string biz_id: description: "业务主体ID。根据biz_type不同可能对应shop_id或item_id。\r\t特别注意对于门店创建,当流水\ status=SUCCESS时,此字段才为shop_id,其他状态时为0或空。" example: "2015052100077000000000120774" type: string biz_type: description: 业务类型:SHOP-店铺,ITEM-商品 example: SHOP type: string create_time: description: 创建时间 example: 2015-10-29 10:51:57 type: string op_id: description: 操作用户的支付账号id example: "2088001969784501" type: string request_id: description: 注意:此字段并非外部商户请求时传入的request_id,暂时代表支付宝内部字段,请勿用。 example: "2015123235324534" type: string result_code: description: "流水处理结果码\r\t点此查看" example: RISK_AUDIT_FAIL type: string result_desc: description: 流水处理结果描述 example: 证照审核未通过 type: string status: description: 流水状态:INIT-初始,PROCESS-处理中,SUCCESS-成功,FAIL-失败。 example: FAIL type: string sub_status: description: 流水子状态:WAIT_CERTIFY-等待认证,LICENSE_AUDITING-证照审核中,RISK_AUDITING-风控审核中,WAIT_SIGN-等待签约,FINISH-终结。 example: FINISH type: string update_time: description: 更新时间 example: 2015-10-29 10:51:57 type: string type: object BizfundSettleInfo: properties: settle_mode: description: 请款|账期 模式 type: string settle_target_type: description: 结算的目标对象类型 type: string type: object BkAgentReqInfo: properties: acq_code: description: 收单机构在清算组织登记或分配的机构代码 type: string device_type: description: 终端设备类型,受理方可参考终端注册时的设备类型填写。 type: string location: description: 终端设备实时经纬度信息,格式为纬度/经度,+表示北纬、东经,-表示南纬、西经。 type: string merch_code: description: 收单机构在清算组织登记的商户编码 type: string serial_num: description: "终端类型填写为 02、\t03、04、05、06、08、09 或 10 时,必\t须填写终端序列号。" type: string type: object BkAgentRespInfo: properties: bindclrissr_id: description: 枚举值,01 银联;02 网联;03 连通等 type: string bindpyeracctbk_id: description: 付款机构在清算组织登记或分配的机构代码 type: string bindtrx_id: description: 原快捷交易流水号 type: string bkpyeruser_code: description: 用户在银行付款账号的标记化处理编号 type: string estter_location: description: 设备推测位置 type: string type: object BoxBusinessDistrictInfo: properties: app_name: description: 应用名 example: 应用名 type: string business_district_id: description: 商圈ID example: "169109" type: string business_district_name: description: 商圈名称 example: 商圈名称 type: string relate_appid: description: 商圈所属小程序对应的服务编码 example: "2018061360108419" type: string service_code: description: 商圈所属小程序对应的服务编码 example: "2019112021000906169109" type: string type: object BoxBusinessDistrictModule: properties: business_district_infos: description: 商圈选择 items: $ref: '#/components/schemas/BoxBusinessDistrictInfo' type: array module_id: description: 模块配置ID example: "20220308000000168465" type: string module_type: description: 搜索直达模块类型 example: BOX_BUSINESS_DISTRICT type: string type: object BrandDetail: properties: block_type: description: 搜索工单详情数据block_type example: TINYAPP type: string box_version: description: 版本号 example: "1.0" type: string desc: description: 描述信息 example: 描述信息 type: string img: description: img地址 example: http://mdn.alipayobjects.com/mrch_spc/afts/img/A*vQG7Q5nUbWwAAAAAAAAAAAAADsF1AQ/original type: string index: description: 索引信息 example: "1" type: string key: description: 工单详情数据key example: 425d8560-35da-11eb-9de8-217f5d8e3c76 type: string material_id: description: 工单详情数据material_id example: SM2020120401367242 type: string name: description: 应用名称 example: 测试1 type: string public_bind_app_id: description: 搜索运营工单详情数据public_bind_app_id example: "111" type: string service_code: description: 服务码 example: "2020081121000352488483" type: string type: object BrandRegistrationInfo: properties: end_date: description: 商标有效期(结束日期) example: 2021-10-16 type: string reg_materials: description: "商标注册证书信息(当前只支持图片类型,请调用alipay.open.mini.miniapp.brand.upload接\ 口上传图片,可以上传多个商标注册证书信息)" example: "[\"ua2qD53TRpyfX-UYYin6sQAAACMAAQED\",\"ua2qD53TRpyfX-UYYin6sQAAACMAAQED\"\ ]" items: type: string type: array reg_number: description: 商标注册号 example: "654893218979520200916249621" type: string registrant: description: 商标注册人 example: 张三 type: string start_date: description: 商标有效期(开始日期) example: 2022-02-10 08:00:00 type: string type: object BrandResult: properties: brand_id: description: 已有的品牌的id example: brand_id2020091685456316 type: string brand_name: description: 已有品牌的名称 example: brand_namecr7officials type: string type: object BudgetInfo: properties: budget_total: description: 预算数量 example: "10258" type: string budget_type: description: 预算类型 example: QUANTITY type: string sub_budget_dimension: description: 设置每天的预算,如每天的预算设置为100,即该活动一天最多发放100次 example: D:表示每天的预算; type: string sub_value: description: 用于控制子纬度的预算数量 example: 100:表示sub_dimension定义的纬度预算为100,若sub_dimension为D的话,则表示每天最多发放100张 type: string type: object BusinessItem: properties: business_appid: description: 业务归属appid type: string business_payee_id: description: 业务收款pid,business_type为AGREEMENT_PAY时,此参数必传 type: string business_pid: description: 业务归属pid type: string business_type: description: "业务类型ONLINE_PAY(在线缴费) 、AGREEMENT_PAY(无感停车)\tDEVICE_ONLINE_PAY(车\ 机在线缴费)" type: string type: object BusinessParams: properties: actual_order_time: description: 实际订单时间,在乘车码场景,传入的是用户刷码乘车时间 type: string campus_card: description: 校园卡编号 type: string card_type: description: 虚拟卡卡类型 type: string enterprise_pay_amount: description: 因公付金额,单位:元。 type: string enterprise_pay_info: description: 因公付业务信息 type: string good_taxes: description: 商户传入的交易税费。需要落地风控使用 type: string mc_create_trade_ip: description: "商户端创建订单的 IP,须上传正确的用户端外网 IP,支持 ipv4/ipv6 格式;\tmc_create_trade_ip和\ mcCreateTradeIp(旧)参数描述相同,首选mc_create_trade_ip入参,请勿重复入参;\t如已入参mcCreateTradeIp(\ 旧),无需新增入参mc_create_trade_ip。" type: string tiny_app_merchant_biz_type: description: "当需要在 商家平台(b.alipay.com)—数据中心 中查看对应业务场景下的数据明细可以通过该参数传入\t支持传\ 入的值:小程序细分业务场景" type: string type: object BusinessParamsMap: properties: change_time: description: 服务变更时间 example: '"2023-04-07 22:22:22"' type: string new_amount: description: 服务变更后新金额 example: '"0.01"' type: string ori_amount: description: 原始价格 example: '"0.01"' type: string type: object ButtonObject: properties: action_param: 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个字符,不允许冒号等特殊字符。" type: string action_type: description: "菜单类型:\r\tout——事件型菜单;\r\tlink——链接型菜单;\r\ttel——点击拨打电话;\r\tmap—\ —点击查看地图;\r\tconsumption——点击查看用户与生活号管理员账号之间的消费记录" type: string icon: description: icon图片url,必须是http协议的url,尺寸为60X60,最大不超过5M,请先调用 图片上传接口获得图片url type: string name: description: 菜单名称,icon菜单名称不超过5个汉字,文本菜单名称不超过9个汉字,编码格式为GBK type: string sub_button: description: 二级菜单数组,若sub_button为空,则一级菜单必须指定action_type和action_param的值,二级菜单个数可以为1~5个。 items: $ref: '#/components/schemas/SubButton' type: array type: object BuyerPayDetail: properties: amount: description: 买家支付金额,单位:元。 example: "77.77" type: string pay_channel: description: 支付渠道 example: offline_pos type: string type: object CampusInfo: properties: address: description: 地址 type: string campus_id: description: 校区id type: string campus_name: description: 校区名称 type: string inst_name: description: 学校名称 type: string type: object CardFrontTextDTO: properties: label: description: 文案标签 type: string value: description: 展示文案 type: string type: object CardUserInfo: properties: open_id: description: 用户open_id type: string user_uni_id: description: "用户唯一标识, 根据user_uni_id_type类型来定 (目前暂支持支付宝userId)\t\t支付宝userId说\ 明:支付宝用户号是以2088开头的16位纯数字组成" type: string user_uni_id_type: description: 用户唯一标识类型 type: string type: object CashCampaignInfo: properties: camp_status: description: 活动状态 example: READY type: string coupon_name: description: 现金红包名称 example: XXX周年庆红包 type: string crowd_no: description: 现金红包活动号 example: EPOJZsBg3A-CZOJE4qlbAueA7By4oJLDwEeYZlAiAnbMnSZ96O-zxUfKlHp5cxmx type: string origin_crowd_no: description: "原始活动号,商户进行问题排查时提供" example: "20160901109410190092922300444004" type: string type: object CategoryRequireInfo: properties: business_licence_required: description: 营业执照页面是否必填 example: true type: boolean category_code: description: 类目code(各级类目code下划线"_"拼接)。类目信息参考alipay.open.mini.category.query example: XS1001_XS2002_XS3008 type: string category_name: description: 类目名称(各级类目名称下划线"_"拼接) example: 教育培训_培训机构_课外辅导 type: string category_requirements: description: 类目要求原始描述信息 example: 1、需提供区、县级教育部门颁发的《民办学校办学许可证》,或事业单位法人证书、民办非企业单位登记证书; ( 其中:民办学校办学许可证 就是 办学许可证) type: string door_photo_required: description: 门头照页面是否必填 example: true type: boolean special_licence_required: description: 特殊资质页面是否必填 example: true type: boolean type: object ChargeInfo: properties: charge_fee: description: 实收费用 type: string charge_type: description: 收单手续费trade,花呗分期手续hbfq,其他手续费charge type: string is_rating_on_switch: description: 是否合约指定收费账号出资,值为"Y"或"N" type: string is_rating_on_trade_receiver: description: 是否收款账号出资,值为"Y"或"N" type: string original_charge_fee: description: 原始费用 type: string sub_fee_detail_list: description: 组合支付收费明细 items: $ref: '#/components/schemas/SubFee' type: array switch_fee_rate: description: 签约费率 type: string type: object ChargeItems: properties: item_mandatory: description: "缴费项是否必选\r\t如果缴费项是多选模式,此参数生效。 “Y”表示必填,“N”或空表示非必填。" example: "N" type: string item_maximum: description: "缴费项最大可选数\r\t如果缴费项是多选模式,此参数生效,范围是1-9,如果为空,则最大项默认为9" example: 5 type: integer item_name: description: 缴费项名称 example: 校服费 type: string item_price: description: 缴费项金额 example: "8.88" type: string item_serial_number: 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 type: integer type: object ChatMessage: properties: message_content: description: 消息内容 example: 你好 type: string message_type: description: "消息内容类型,默认TEXT,包括: TEXT(文本消息),IMAGE(图片消息),FILE(文件消息)" example: TEXT type: string send_time: description: 消息发送时间,按照ISO8601标准表示,比如:2018-12-24T15:38:17.824+08:00 example: 2021-05-12 06:06:02 type: string user_name: description: 发送者名称 example: 李明 type: string user_type: description: "发送者类型: VISITOR(访客) ,AGENT(在线客服) ,SYSTEM(系统)" example: VISITOR type: string type: object ClauseTerm: properties: descriptions: description: 说明描述内容 example: 说明描述内容 items: type: string type: array title: description: 说明title example: 说明title type: string type: object CloudResumeCertificateInfo: properties: certificate_cert_level: description: 证书等级 example: 证书等级 type: string certificate_name: description: 证书名称 example: 证书名称 type: string certificate_send_card_address: description: 发证机构 example: 发证机构 type: string certificate_verify_status: description: "UNPROMISED=未承诺\tPROMISED=已承诺\tVERFIED=已验真\tUNVERIFIED=验证未通\ 过" example: VERFIED type: string in_validity_period: description: "VALID=有效\tINVALID=失效\tUNKNOWN=未知" example: UNKNOWN type: string type: object CloudResumeEducationExperience: properties: degree: description: 学历 example: BACHELOR type: string education_status: description: 教育状态 example: FINISH_SCHOOL type: string finish_school_month: description: 毕业月份 example: "9" type: string finish_school_year: description: 毕业年份 example: 2023 type: integer in_school_month: description: 入学月份 example: 12 type: integer in_school_year: description: 入学年份 example: 2023 type: integer location: description: 受教育地点 example: 受教育地点 type: string major: description: 上学专业 example: 计算机科学与技术 type: string month: description: 月 example: 1 type: integer school_name: description: 学校名称 example: 上海大学 type: string tong_zhao: description: 是否统招 example: true type: boolean year: description: 年 example: 2022 type: integer type: object CloudResumeHeadPic: properties: pic_url: description: 头像连接url example: https://afts/... type: string type: object CloudResumePositionIntention: properties: intention_city: description: 意向城市Code。具体地区编码参见https://lbs.amap.com/api/webservice/download 里面城市编码表 example: "110000" type: string job_id: deprecated: true description: 职业id(这个字段在目前版本不对外暴露) example: aaaaaaa-ssss-bbbb-cccc-dddddddddd type: string job_name: description: 职业名称 example: 医生 type: string profession_id: deprecated: true description: 行业id(这个字段在目前版本不对外暴露) example: aaaaa0000-0000-0000-0000-aaaaaaaaaaaa type: string profession_name: description: 行业名称 example: 医疗健康 type: string salary_max: description: 最大工资 example: "2000" type: string salary_min: description: 最小薪资 example: "1000" type: string salary_unit: description: 工资单位,/月 /日 example: MONTH type: string work_property: description: 工作属性 example: PART_TIME type: string type: object CloudResumeSkillInfo: properties: skill_name: description: 技能标签名字 example: 技能标签名字 type: string type: object CloudResumeWorkExperience: properties: company_name: description: 公司名称 example: xxx有限公司 type: string job_id: description: 职业id example: 47f5c014 type: string job_name: description: 职业 example: 送餐员 type: string position_name: description: 用户在求职意向页面自主录入 example: 开发工程师 type: string profession_id: description: 行业id example: 47f5c type: string profession_name: description: 行业名称 example: 餐饮服务 type: string work_desc: description: 工作描述 example: 工作描述 type: string work_end_time: description: 工作结束时间 example: 1667232000000 type: integer work_start_time: description: 工作开始日期 example: 1666159991000 type: integer type: object CmItemInfo: properties: description: description: 商品描述 type: string ext_info: description: 商品扩展信息 items: $ref: '#/components/schemas/ItemExtInfo' type: array front_category_id_list: description: 商品所属前台类目ID列表 items: type: string type: array gmt_create: description: 商品创建时间 type: string gmt_modified: description: 商品更新时间 type: string item_id: description: 商品ID type: string material_list: description: 商品素材列表 items: $ref: '#/components/schemas/MaterialInfo' type: array name: description: 商品名称 type: string property_list: description: 商品属性列表 items: $ref: '#/components/schemas/ItemPropertyInfo' type: array sku_list: description: 商品SKU列表 items: $ref: '#/components/schemas/CmItemSkuInfo' type: array standard_category_id: description: 商品所属标准类目ID(具体值请参见产品文档) type: string status: description: 商品状态 type: string target_id: description: "商品归属主体ID\t\t例:商品归属主体类型为店铺,则商品归属主体ID为店铺ID;归属主体为小程序,则归属主体ID为\ 小程序ID" type: string target_type: description: "商品归属主体类型:\t\t5(店铺)\t\t8(小程序)" type: string type: description: "商品类型:\t\tSTANDARD_GOODS(标品)、NON_STANDARD_GOODS(非标品)" type: string type: object CmItemSkuInfo: properties: gmt_create: description: 创建时间 type: string gmt_modified: description: 更新时间 type: string inventory: description: 库存 type: integer item_id: description: 商品ID type: string material_list: description: 素材列表 items: $ref: '#/components/schemas/MaterialInfo' type: array original_price: description: 标价,单位分 type: integer price: description: 售价,单位分 type: integer remain_inventory: description: 剩余库存 type: integer sku_id: description: 商品SKU ID type: string sku_property_list: description: SKU属性列表 items: $ref: '#/components/schemas/ItemSkuPropertyInfo' type: array status: description: 商品SKU状态 type: string type: object CodeInfo: properties: goto_url: description: 跳转URL,扫码关注服务窗后会直接跳转到此URL example: http://www.******.com type: string scene: $ref: '#/components/schemas/Scene' type: object CommonErrorType: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object CommonNotifyUrlModel: properties: notify_url: description: 通知地址 type: string type: object CommonVoucherDisplayInfo: properties: brand_logo: description: 商家品牌 logo 链接 type: string brand_name: description: 商户品牌名称。 type: string voucher_description: description: 用于说明详细的活动规则,会展示在支付宝卡包券详情页。 type: string voucher_detail_images: description: 券详情图片链接。 items: type: string type: array voucher_image: description: 券封面图链接。 type: string type: object CommonVoucherDisplayLiteInfo: properties: brand_logo: description: 商户品牌 logo 链接。 type: string brand_name: description: 商户品牌名称。 如果不设置品牌名称,则默认使用支付宝商家系统中维护的商家别名。 如果没有维护商家别名,则使用默认名称:商家优惠。 用户领取优惠券后,品牌名称会对用户进行展示。 type: string type: object CommonVoucherSendRule: properties: max_quantity_by_day: description: 设置此字段,允许指定单天最大发券数量。 type: integer natural_person_limit: description: 限制相同身份证号领取次数(voucher_quantity_limit_per_user)。默认false不限制。 枚举值 true:是 false:否 type: boolean phone_number_limit: description: 限制相同手机号领取次数(voucher_quantity_limit_per_user)。默认false不限制 枚举值 true:是 false:否 type: boolean real_name_limit: description: 限制支付宝实名用户才能领取支付券,默认为false表示不限制。枚举值 true\false type: boolean voucher_quantity: description: 发行券的总数量。 type: integer voucher_quantity_limit_per_user: description: 每人领取限制。 默认按照支付宝账号进行领取限制; 不填写或填入0表示没有领取限制。 type: integer voucher_quantity_limit_per_user_period_type: description: "周期限领配置,限制每人在固定周期内领取张数(voucher_quantity_limit_per_user),默认\ LIFE_CYCLE。" type: string type: object CommonVoucherUseRule: 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' type: object CommonVoucherUseRuleLiteInfo: 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' type: object CompleteVoucherInfo: properties: anti_fake_code: description: 防伪码 example: 无 type: string check_sum: description: 校验码 example: 无 type: string device_no: description: 开票机器码 example: "654334567890987654" type: string file_download_url: description: 板式文件下载地址 example: http://einvoice-file-daily.oss-cn-beijing.aliyuncs.com/QYMKR9GA5SPVR_042001900111_56322525.pdf?Expires=1943931648&OSSAccessKeyId=LTAI4Fndk4SpFM1E4TVUPT1K&Signature=azYKSp%2Bnn4v6GLy3YZ3nZOCO%2FVo%3D type: string file_type: description: 板式文件的类型 example: pdf type: string invoice_amount: description: 发票金额(元) example: 4950 type: integer invoice_code: description: 发票代码 example: "042001900111" type: string invoice_content_list: description: 汇总发票详细信息(目前该字段为空) items: $ref: '#/components/schemas/InvoiceContentInfo' type: array invoice_date: description: 发票日期 example: 2021-08-10 00:00:00 type: string invoice_kind: description: 发票类型 0:增值税普通电子发票 1:增值税普通发票 2:增值税专用发票 3:增值税专用电子发票 4:财政电子发票 example: 0 type: integer invoice_memo: description: 备注 example: 无 type: string invoice_no: description: 发票号码 example: "56322524" type: string invoice_source: description: 发票来源,取值范围 SUMMARY_INVOICE_AUTO_OPEN 汇总开票系统自动开票,SUMMARY_INVOICE_MERCHANT_UPLOAD 汇总开票商户手动上传 example: SUMMARY_INVOICE_AUTO_OPEN type: string invoice_title: description: 发票抬头 example: 支付宝(中国)网络技术有限公司 type: string invoice_type: description: 发票类型(红、蓝) example: 无 type: string payee_address: description: 销售方地址 example: 杭州市西湖区 type: string payee_bank_account: description: 销售方银行账号 example: "283635722" type: string payee_bank_name: description: 销售方银行名称 example: 工行 type: string payee_checker: description: 复核人 example: 无 type: string payee_mobile: description: 销售方电话 example: 0571-2735522 type: string payee_name: description: 销售方名称 example: 航信培训企业501081 type: string payee_operator: description: 开票人 example: 无 type: string payee_receiver: description: 收款人 example: 无 type: string payee_register_no: description: 销售方税号 example: "339902999999789001" type: string payer_address: description: 购买方地址 example: 无 type: string payer_bank_account: description: 购买方银行账号 example: 无 type: string payer_bank_name: description: 购买方银行名称 example: 无 type: string payer_mobile: description: 购买方电话 example: 无 type: string payer_name: description: 购买方名称 example: 支付宝(中国)网络技术有限公司 type: string payer_register_no: description: 购买方税号 example: 91310115768225450T type: string sum_price: description: 不含税金额(元) example: 4901 type: integer sum_tax: description: 合计税额(元) example: 49 type: integer type: object ComplexLabelRule: properties: label_id: description: 标签id type: string label_value: description: "标签取值,当有多个取值时用英文\",\"分隔(比如使用in操作符时);不允许传入下划线\"_\"、竖线\"|\"或者\ 空格\" \"" type: string operator: description: 目前支持EQ(等于)、NEQ(不等于)、LT(小于),GT(大于)、LTEQ(小于等于)、GTEQ(大于等于)、LIKE(匹配)、BETWEEN(范围)、IN(包含)、NOTIN(不包含)操作 type: string type: object ConfigInfo: properties: attachment_explain: $ref: '#/components/schemas/AttachmentExplain' collect_attachement: description: 是否收集附件 example: true type: boolean collect_cert_types: description: 收集证件类型列表 example: "[\"IDCARD\"]" items: type: string type: array company_no: description: 公司编号-SF example: SF type: string contract_validity: description: 文档过期时间 example: 1577243641153 type: integer jump_url: description: 支付宝小程序跳转 example: alipays://platformapi/startapp?appId=2019042364288308&page=pages%2Fwater%2Fwater%3FactivityId%3D0ow26mr0eowt22mqz1gap8bale802821 type: string merchant_mini_sign_url: description: 商户小程序签署地址(signModel字段值为1时 必填) example: alipays://platformapi/startapp?appId=2019042364288308&page=pages%2Fwater%2Fwater%3FactivityId%3D0ow26mr0eowt22mqz1gap8bale802821 type: string notice_developer_url: description: 回调地址,签署的过程和签署完成都会回调。 example: https://abc.com/callback type: string platform_order_no: description: 平台订单号 example: DD1234 type: string serial_no: description: 物流单号 example: "1576726491.1902587" type: string sign_model: description: 签署方式 0-e签宝小程序签署 1-商户小程序签署 默认0 example: 0 type: integer type: object ConfigInfoBean: properties: attachment_explain: $ref: '#/components/schemas/AttachmentExplainBean' auto_archive: description: 签署完成是否自动归档,默认true,如果false,则归档需要调用签署流程归档接口 example: false type: boolean collect_attachement: description: 是否收集附件(需签署人上传身份证或者其他文件的,需设置为true) example: true type: boolean company_no: description: "物流公司编号(目前仅支持顺丰\"SF\")\t注:避免影响生产订单,联调及测试环境请传入SF_TEST。" example: SF type: string contract_validity: description: 合同过期时间:该参数设置的时间若到期,则会触发流程文件过期通知 example: 1577243641153 type: integer jump_url: description: 签署完成后跳转商户小程序的地址(signModel字段值为2时 选填) example: alipays://platformapi/startapp?appId=2019042364288308&page=pages%2Fwater%2Fwater%3FactivityId%3D0ow26mr0eowt22mqz1gap8bale802821 type: string merchant_mini_sign_url: description: 商户小程序签署地址(signModel字段值为1时 必填) example: alipays://platformapi/startapp?appId=2019042364288308&page=pages%2Fwater%2Fwater%3FactivityId%3D0ow26mr0eowt22mqz1gap8bale802821 type: string notice_developer_url: description: https://esign.cn/callback example: 回调通知地址,签署的过程和签署完成都会回调 type: string platform_order_no: description: 平台订单号,可将商户订单与电子合同进行关联。用户通过支付宝官方小程序 合同管家 查看合同时,可快速进入商家的小程序及对应的订单详情页,为商家的小程序提供了流量入口,提高用户的活跃度和留存率; example: DD1234 type: string serial_no: description: 12或15位物流单号 example: "444258617994" type: string sign_model: description: "快递扫码签收方式:\t1-商户小程序:扫码后跳转商户小程序进行签收;\t0-e签宝小程序:如商户没有支付宝小程序,可\ 使用e签宝小程序完成签收。" example: 0 type: integer specify_attachment_infos: description: "指定签署人需要上传的附件列表,例如:A、B、C三方签署,A需上传附件1,B需指定附件2,C需上传附件1,2,3" items: $ref: '#/components/schemas/SpecifyAttachmentInfo' type: array type: object ConstraintInfo: properties: cash_pool_id: description: "资金池ID\r\t(数据来源:需要ISV自己去口碑销售中台创建资金池,拿到对应的资金池ID,此参数仅适用ISV接入口\ 福业务场景时使用,其他场景不需要传递此参数)" example: 2017031100073001472700000GY7 type: string crowd_group_id: description: "人群规则组ID\r\t仅直发奖类型活动设置有效,通过调用营销活动人群组规则创建接口参数返回" example: "12344556" type: string crowd_restriction: description: 针对指定人群的约束条件 example: "NEW_MEMBER_PROM\r\nO:新会员\r\nSTUDENT:学生用户,仅对\r\nDIRECT_SEND类型下的\ 代金券,折扣券活动有效" type: string crowd_restriction_value: description: 根据crowd_restriction的值不同,设置相应的值,如果crowd_restriction是“MEMBER_CARD”,crowd_restriction_value就是关联会员卡模版ID集合,用逗号拼接 example: "2018012020075000000022612371,2018012020076000000022612371" type: string item_ids: description: "单品码列表\r\t仅在创建消费单品送活动时设置,最多设置500个单品码,由商户根据自己的商品管理自定义,一般为国标码" example: "212313,221322" items: type: string type: array min_cost: description: "最低消费金额,单位元\r\t仅在创建消费送礼包活动时设置" example: "100" type: string subsidy_percent: description: "补贴百分比,95表示 95%,支持两位小数\r\t(参数说明:补贴比例95%,表示ISV出资95%,商户出资5%,此\ 参数仅适用ISV接入口福业务场景时使用,其他场景不需要传递此参数)" example: "95" type: string suit_shops: description: "活动适用的门店列表\r\t仅品牌商发起的招商活动可为空\r\t最多支持10w家门店" example: "2015110600077000000002125023,2015110600077000000002125022" items: type: string type: array user_win_count: description: "活动期间用户能够参与的次数限制\r\t如果不设置则不限制参与次数" example: "1" type: string user_win_frequency: description: "活动期间用户能够参与的频率限制\r\t如果不设置则不限制参与频率\r\t每日中奖1次: D||1 \r\t每周中奖\ 2次: W||2 \r\t每月中奖3次: M||3" example: D||3 type: string type: object ConsultActivityInfo: properties: activity_id: description: 活动id example: "2016042700826004508401111111" type: string type: object ConsultActivityResultInfo: properties: activity_id: description: 活动id example: "2016042700826004508401111111" type: string consult_result_code: description: 咨询结果码 example: ACTIVITY_NOT_START type: string type: object ConsumeOutputInfo: properties: bill_no: description: 支付宝交易号 example: "2020010900003001020000033189" type: string category_name: description: 账单分类 example: 餐饮 type: string consume_amount: description: 金额 example: "30.29" type: string consume_date: description: 日期 example: 2020-03-20 type: string consume_title: description: 交易记录标题 example: xxx餐厅套餐一份 type: string payee_name: description: 商家名称 example: 肯德基 type: string type: object ConsumerNotifyIstd: properties: goods_count: description: 商品数量 type: integer goods_img: description: 商品缩略图url,支持格式:bmp、jpg、jpeg、png、gif type: string goods_name: description: 商品名称 type: string merchant_mobile: description: 商家电话 type: string merchant_name: description: 商家名称,tiny_app_id和merchant_name不能同时为空 type: string tiny_app_id: description: 商家小程序appid type: string tiny_app_url: description: 商家小程序的路径,建议为订单页面 type: string type: object ContactFollower: properties: avatar: description: 支付宝头像 example: 支付宝头像 type: string default_avatar: description: 默认头像 example: "true" type: string each_record_flag: description: "false" example: "false" type: string user_id: description: 用户id example: "2088202882050410" type: string type: object ContactInfo: properties: email: description: 电子邮箱 type: string id_card_no: description: 身份证号 type: string mobile: description: 手机号 type: string name: description: 联系人名字 type: string phone: description: 电话 type: string tag: description: 商户联系人业务标识枚举,表示商户联系人的职责 items: type: string type: array type: description: 联系人类型,取值范围:LEGAL_PERSON:法人;CONTROLLER:实际控制人;AGENT:代理人;OTHER:其他 type: string type: object ContactModel: properties: contact_email: description: 联系人邮箱 example: zhangsan@alipy.com type: string contact_mobile: description: 联系人手机号码 example: "18866668888" type: string contact_name: description: 联系人名称 example: 张三 type: string type: object Context: properties: action_name: description: 底部链接描述文字,如“查看详情”,最多能传8个汉字或16个英文字符,长度超出会报错 example: 查看详情 type: string first: $ref: '#/components/schemas/Keyword' head_color: description: 顶部色条的色值 example: '#85be53' type: string keyword1: $ref: '#/components/schemas/Keyword' keyword2: $ref: '#/components/schemas/Keyword' remark: $ref: '#/components/schemas/Keyword' url: description: 点击消息后承接页的地址 example: http://m.baidu.com type: string type: object ContributeDetail: properties: contribute_amount: description: 出资方金额 type: string contribute_type: description: 出资方类型 type: string type: object ConversionData: properties: ad_id: description: 广告id example: "123" type: string biz_no: description: "转化流水号,用于幂等\t\t对于source=XLIGHT,转化流水号来自灯火的留资明细\t对于source=DATASET/OTHER,\ 转化流水号由调用方自定义" example: Zybnom890437Mvcu type: string callback_ext_info: description: 转化回调扩展信息 example: ZXdmcmZkbGZkZmRmZmRmMTI= type: string cid: description: 监测链接配置的__CID__宏参发生用户点击替换后的id值 example: 8e91eca2-930d-4b4e-bb38-1ba74146cd06 type: string conversion_amount: description: "当source=DATASET或者OTHER时使用:\t\t转化金额,单位分" example: "20" type: string conversion_id: description: "当source=XLIGHT时使用:\t\t转化事件id,来自推广页关联转化事件id" example: "167390987332" type: string conversion_time: description: 转化时间,UTC 时间戳,单位:秒 example: 12389637 type: integer conversion_type: description: "当source=XLIGHT时使用:\t\t转化事件类型" example: "51" type: string creative_id: description: 创意ID example: "6785" type: string data_id: description: "当source=XLIGHT或者DATASET时使用:\t\t数据集id" example: "20391" type: string data_src_type: description: "当source=OTHER时使用:\t\t数据类型:\tKR_MEMBER - 客如云入会\tKR_TRADE -\ \ 客如云交易\tTB_LIVE - 淘宝直播" example: KR_MEMBER type: string group_id: description: 单元ID example: "7896" type: string join_channel: description: XLIGHT - 灯火归因;MERCHANT-商家归因; 默认为XLIGHT example: XLIGHT type: string plan_id: description: 计划ID example: "1789" type: string principal_id: description: "商户在灯火pb端的id, 可代替principal_tag" example: "1" type: string principal_tag: description: 商家标志,可代替principal_id example: HYjofejnnlp89730202bcklHH type: string property_list: description: "当source=DATASET或者OTHER时使用:\t\t转化属性列表" items: $ref: '#/components/schemas/ConversionProperty' type: array source: description: "来源:\tXLIGHT-灯火留资\tDATASET-数据集\tOTHER-其它" example: XLIGHT type: string target_id: description: "当source=OTHER时使用:\t主体id,比如品牌id" example: "123" type: string target_type: description: "当source=OTHER时使用:\t\t主体类型:\tBRAND - 品牌\tSTORE - 店铺\tLIVE -\ \ 直播\t等等" example: STORE type: string uuid: description: "当source=DATASET或者OTHER时使用:\t\t转化用户唯一标识" example: 7893ybc7032173 type: string uuid_open_id: description: 支付宝用户在应用维度下的唯一标识 example: oPXyY4O0ZTmUqSX4MRxYDDCccT6Kc9EXX type: string uuid_type: description: "当source=DATASET或者OTHER时使用:\t\t转化客户唯一标志类型:\tPID - 2088pid" example: PID type: string type: object ConversionProperty: properties: key: description: 业务转化数据属性 example: tel type: string name: description: 转化属性名称 example: 用户唯一标识 type: string value: description: 业务转化属性实例值 example: "3689479025" type: string type: object CreateMiniRequest: properties: alipay_account: description: 商家登录支付宝的邮箱帐号或手机号。(1)默认只支持企业账号类型;(2)将is_individual设置为true,支持个体工商户类型的账号(同时也兼容企业账号)(3)将is_individual设置为true且上传营业执照照片,将同时对具备个体工商户营业执照的商家个人账号认证成为个体工商户账号(同时也兼容企业账号、个体工商户账号) example: test@email.com type: string app_name: description: 小程序名称 example: 示例小程序 type: string cert_name: description: 营业执照企业名称,如果是“无主体名称个体工商户”则填“个体户+法人姓名”,例如“个体户张三” example: 张三科技有限公司 type: string cert_no: description: 营业执照编码 example: "3704354348893534" type: string contact_name: description: 商家联系人名称 example: 张三 type: string contact_phone: description: 商家联系人手机电话 example: 199xxxx6338 type: string is_individual: description: 默认为 false。当设置为 true 时,支持个体工商户的账号类型(同时兼容企业账号) example: true type: boolean legal_personal_name: description: 商家法人名称 example: 张三 type: string license_pic: description: 营业执照图片的Base64编码字符串,图片大小不能超过2M。将is_individual设置为true,当传入该参数后,如果商家账号不是个体工商户类型,将同时为商家升级账号,无需商家额外操作升级(同时支持企业账号、个体工商户账号) example: /9j/Qnl0ZUFycmF5T3V0cHV0U3RyZWFtIG91dHB1dCA9IG5ldyBCeXRlQ中间缩略Skge30= type: string out_order_no: description: 开发者外部订单号,自定义传入,通过开发者账号+outOrderNo做业务幂等。(1)该字段会在商家确认创建后通过应用授权通知出参notify_context以out_biz_no属性返回给ISV,应用授权通知订阅参考:https://opendocs.alipay.com/isv/01fejh。(2)该字段也会通过alipay.open.mini.merchant.confirmed返回给订阅方 example: "202324353454545" type: string type: object CreditRiskInfo: properties: can_retry: description: 查询失败的情况下,是否可以通过重试解决。true 表示可以适当重试一定次数;false 表示有明确的失败原因,无需重试, example: false type: boolean code: description: 用户信用数据查询状态 example: QUERY_REFUSED_FOR_UNKNOWN_REASON type: string data: description: 用户信用风险信息,如:租物场景风险等级、履约历史等级、共租行为等级 example: "{\"miniZm\":false,\"aliren\":false}" type: string type: object CrowdConstraintInfo: properties: crowd_condition: description: "圈人的条件\r\top:表示操作符,目前支持EQ相等,GT大于,GTEQ大于等于,LT小于,LTEQ小于等于,NEQ不\ 等,LIKE模糊匹配,IN在枚举范围内,NOTIN不在枚举范围内,BETWEEN范围比较,LEFTDAYS几天以内,RIGHTDAYS几天以\ 外,LOCATE地理位置比较,LBS地图位置数据\r\ttagCode:标签code,详细标签code参见附件。标签信息\r\tvalue:标签值" type: string crowd_name: description: 圈人名称 type: string crowd_restriction: description: 圈人约束,取值(NEWCOMER:新客人群;OFFLINE:离线人群),OFFLINE离线人群,需要传递crowd_condition圈人条件,使用方案参考crowd_condition使用说明 type: string type: object CumulateDataDetail: properties: action_type: description: 数据回传的动作类型,正向或逆向。 example: POSITIVE type: string biz_time: description: 回传数据发生的实际时间 example: 2019-03-08 19:51:35 type: string data_type: description: 回传数据类型。 example: TASK type: string discount_amount: description: 优惠金额 example: "7.08" type: string discount_desc: description: 优惠描述 example: 消费满减优惠001 type: string out_biz_no: description: 数据回传时传入的外部业务号。 example: "2020081211223006150094012926289" type: string refer_out_biz_no: description: 数据回传时逆向单据记录的对应正向单据的外部业务号。 example: "2020081211223006150094012926289" type: string sub_data_type: description: 回传数据子类型。 example: AMOUNT type: string task_amount: description: 任务金额 example: "17.88" type: string task_desc: description: 任务描述 example: 完成一次任务001 type: string task_times: description: 任务次数 example: 1 type: integer type: object CustomerDefineDeductRule: properties: customer_define_deduct_rule_desc: description: 自定义优惠规则描述 type: string type: object CustomerDefineVoucherInfo: properties: deduct_info: $ref: '#/components/schemas/DeductInfo' type: object CustomerGuide: properties: mini_app_id: description: 券可用的小程序appId,卡包详情页可跳转到该appId type: string mini_app_path: description: "指定跳转到mini_app_id时的具体页面路径。 \t限制: \t1、只有mini_app_id有值时该值传入才会\ 有效\t2、该小程序路径是相对路径。详情参见 小程序scheme链接介绍" type: string real_shop_ids: description: 代运营商业关系门店列表,列表中的门店id是调用接口alipay.business.relation.shop.create创建门店返回的real_shop_id。接口参数是列表类型。 items: type: string type: array service_codes: description: 小程序服务编码,通过 alipay.open.app.appcontent.function.create(小程序服务创建)接口创建服务后获取。 items: type: string type: array shop_ids: description: 券可使用的门店列表。列表中的门店id是通过调用接口ant.merchant.expand.shop.create创建门店返回的支付宝门店id 接口参数是列表类型。 items: type: string type: array store_ids: description: 该字段后续废弃。券可使用的门店列表。列表中的门店id是通过调用接口ant.merchant.expand.shop.create创建门店返回的支付宝门店id。接口参数是列表类型。 items: type: string type: array voucher_send_guide: $ref: '#/components/schemas/VoucherSendGuide' voucher_use_guide: $ref: '#/components/schemas/VoucherUseGuide' type: object CustomerGuideModify: properties: mini_app_id: description: 券可用的小程序 appId,卡包详情页可跳转到该 appId。 example: "2021238412323412" type: string mini_app_path: description: 指定跳转到 mini_app_id 时的具体页面路径。 example: /index/path/path&query=xx%3dxx type: string real_shop_ids: description: "券可使用的商业关系门店列表,列表中的门店id是调用接口alipay.business.relation.shop.create创\ 建门店返回的real_shop_id。" example: "[\"2018051000502000000011111111\",\"2018040200502000000011111111\"\ ,\"2018062800502000000022271997\"]" items: type: string type: array service_codes: description: 小程序服务编码,通过 alipay.open.app.appcontent.function.create(小程序服务创建)接口创建服务后获取。 example: "[\"2020030921000303380758\"]" items: type: string type: array shop_ids: description: 券可使用的门店列表。列表中的门店id是通过调用接口ant.merchant.expand.shop.create创建门店返回的支付宝门店 id 接口参数是列表类型。 接口参数是列表类型。 example: "[\"2018051000502000000011111111\",\"2018040200502000000011111111\"\ ,\"2018062800502000000022271997\"]" items: type: string type: array store_ids: description: "后续废弃。券可使用的门店列表。列表中的门店id是通过调用接口ant.merchant.expand.shop.create创\ 建门店返回的支付宝门店 id 接口参数是列表类型。\t接口参数是列表类型。" example: "[\"2018051000502000000011111111\",\"2018040200502000000011111111\"\ ,\"2018062800502000000022271997\"]" items: type: string type: array voucher_send_guide: $ref: '#/components/schemas/VoucherSendGuideModify' voucher_use_guide: $ref: '#/components/schemas/VoucherUseGuideModify' type: object CustomsDeclareBuyerInfo: properties: buyer_cert_no: description: 订购人身份证号。即订购人留在商户处的身份证信息 example: "230227198707201827" type: string buyer_name: description: 订购人姓名。即订购人留在商户处的姓名信息 example: 王一 type: string type: object CustomsDeclareRecordInfo: properties: alipay_declare_no: description: 支付宝报关流水号。 example: "2013112611001004680073956707" type: string amount: description: 报关金额,单位为人民币“元”,精确到小数点后2位。 example: "20.00" type: string customs_place: description: 此记录所报关的海关编号,参见“ 海关编号”。 example: zongshu type: string customs_result_code: description: "发起报关后,海关返回回执中的结果码。目前只有总署的报关,并且总署回执接收成功的请求才会返回此参数\r\t2:电子口岸\ 申报中\r\t3:发送海关成功\r\t4:发送海关失败\r\t100:海关退单\r\t399:海关审结\r\t小于0的数字:表示处理异常回执\ \r\t 注意:\r\t支付宝原样返回海关返回的数据,参数值以海关的定义为准。" example: "2" type: string customs_result_info: description: 发起报关后,海关返回回执中的结果描述信息。目前只有总署报关,并且总署成功返回回执的时候会有此值 example: "新增申报成功[B0B2F23E-2CF6-434D-9F24-8931B835A056]" type: string customs_result_return_time: description: 发起报关后,海关返回回执的时间,格式为:yyyyMMddHHmmss。目前只有总署报关,并且总署成功返回回执的时候才会有此参数。 example: "20160414142358" type: string is_split: description: "T: 拆单;F:非拆单。当请求没有拆单或者请求传入的is_split=F时,不会返回此参数。" example: T type: string last_modified_time: description: 报关记录状态最后更新时间 example: 2015-12-04 11:00:00 type: string memo: description: 备注说明 example: 海关返回参数非法 type: string merchant_customs_code: description: 商户在海关备案的编号。 example: ALI001 type: string merchant_customs_name: description: 商户海关备案名称 example: XX中国信息技术有限公司 type: string out_request_no: description: 报关请求号。商户端报关请求号,对应入参中的某条报关请求号。 example: "201506010001" type: string status: description: "该报关单当前的状态:\r\t-\tws等待发送海关\r\t-\tsending已提交发送海关\r\t-\tsucc\ \ 海关返回受理成功" example: succ type: string sub_out_biz_no: description: 拆单子订单号。如果报关请求没有请求拆单则不会返回此参数。 example: "201506010001" type: string trade_no: description: 支付宝推送到海关的支付单据号。针对拆单的报关,这个单据号不等于支付宝原始交易号。 example: "2013111511001004390000105126" type: string type: object Data: properties: alipay_open_id_list: description: 支付宝用户唯一标识列表 example: "[\"074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5\"]" items: type: string type: array alipay_user_id_list: description: 对应userIdList,标准Alipay UserId列表 example: "[\"2088102146158132\",\"2088102150429794\",\"2088102150477652\"\ \ ]" items: type: string type: array open_id_list: description: 支付宝用户唯一标识列表 example: "[\"074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5\"]" items: type: string type: array user_id_list: description: 用户id列表 example: "[\"USERID10001\",\"USERID10002\",\"USERID20000\" ]" items: type: string type: array type: object DatadigitalFincloudGeneralsaasFaceCertifyInitializeErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - ILLEGAL_ARGUMENT_FORMAT - ARRANGEMENT_STATUS_ERROR - ACCOUNT_MONEY_LIMIT_ERROR - INVALID_SWITCH - UNKNOWN_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object DatadigitalFincloudGeneralsaasFaceCertifyInitializeModel: properties: biz_code: description: H5人脸核身场景码。入参支持的场景码。 example: FUTURE_TECH_BIZ_FACE_SDK type: string face_contrast_picture: description: 自定义人脸比对图片的base64编码格式的string字符串 example: xydasf== type: string identity_param: $ref: '#/components/schemas/OpenCertifyIdentifyInfo' merchant_config: $ref: '#/components/schemas/OpenCertifyMerchantConfigs' outer_order_no: description: 商户请求的唯一标识,商户要保证其唯一性,值为32位长度的字母数字组合。建议:前面几位字符是商户自定义的简称,中间可以使用一段时间,后段可以使用一个随机或递增序列 example: ZGYD201809132323000001234 type: string type: object DatadigitalFincloudGeneralsaasFaceCertifyInitializeResponseModel: properties: certify_id: description: 本次申请操作的唯一标识,商户需要记录,后续的操作都需要用到 example: 2109b5e671aa3ff2eb4851816c65828f type: string type: object DatadigitalFincloudGeneralsaasFaceCertifyQueryErrorResponseModel: properties: code: description: 错误码 enum: - UNKNOWN_ERROR - ILLEGAL_ARGUMENT_FORMAT - CERTIFY_ID_EXPIRED - OPEN_CERTIFY_BILL_NOT_EXIST - OPEN_CERTIFY_BILL_STATUS_ERROR - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object DatadigitalFincloudGeneralsaasFaceCertifyQueryResponseModel: properties: fail_reason: description: 认证错误原因,扩展字段,默认不返回 example: Z1147 type: string identity_info: description: 刷脸用户的身份信息,目前返回为空 example: "{}" type: string material_info: description: 认证主体附件信息,主要为图片类材料,一般的认证场景都是返回空 example: "{}" type: string passed: description: 是否通过,通过为T,不通过为F example: T type: string type: object DatadigitalFincloudGeneralsaasFaceCertifyVerifyErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - ILLEGAL_ARGUMENT_FORMAT - UNKNOWN_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object DatadigitalFincloudGeneralsaasFaceCertifyVerifyModel: properties: certify_id: description: 本次申请操作的唯一标识,由H5人脸核身初始化接口调用后生成,后续的操作都需要用到 example: OC201809253000000393900404029253 type: string type: object DatadigitalFincloudGeneralsaasFaceCertifyVerifyResponseModel: properties: certify_url: 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 type: string type: object DatadigitalFincloudGeneralsaasFaceCheckInitializeErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - ILLEGAL_ARGUMENT_FORMAT - UNKNOWN_ERROR - ACCOUNT_MONEY_LIMIT_ERROR - INVALID_SWITCH type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object DatadigitalFincloudGeneralsaasFaceCheckInitializeModel: properties: biz_code: description: DATA_DIGITAL_BIZ_CODE_FACE_CHECK_LIVE,代表活体检测。 example: DATA_DIGITAL_BIZ_CODE_FACE_CHECK_LIVE type: string outer_order_no: description: 客户业务单据号。 example: 2324sasfe type: string type: object DatadigitalFincloudGeneralsaasFaceCheckInitializeResponseModel: properties: certify_id: description: 人脸检测流水ID,请保留方便排查问题 example: xxxxeee888fffss type: string page_url: description: 检测页面url,需要给到终端SDK example: http://ssseee.com/ type: string type: object DatadigitalFincloudGeneralsaasFaceCheckQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - ILLEGAL_ARGUMENT_FORMAT - UNKNOWN_ERROR - QUERY_INVALID_CERTIFYID - QUERY_CERTIFYID_EXPIRED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object DatadigitalFincloudGeneralsaasFaceCheckQueryResponseModel: properties: alive_photo: description: 如果设置了need_alive_photo的值不为N,则该字段返回人脸照片的base64编码字符串。 example: fasf8777asf type: string attack_flag: description: 已废弃 example: "false" type: string certify_state: description: PROCESSING:初始化;SUCCESS:检测成功;FAIL:检测失败 example: SUCCESS type: string quality: description: double值,人脸图片质量分 example: "4.84" type: string score: description: 已废弃 example: "3.58" type: string type: object DatadigitalFincloudGeneralsaasFaceSourceCertifyErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - ILLEGAL_ARGUMENT_FORMAT - UNKNOWN_ERROR - ACCOUNT_MONEY_LIMIT_ERROR - FILE_SIZE_TO_LARGE - INVALID_SWITCH type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object DatadigitalFincloudGeneralsaasFaceSourceCertifyModel: properties: cert_name: description: 用户姓名,与身份证上的姓名相匹配 example: 张大伟 type: string cert_no: description: 证件号码,如大陆身份证号码 example: "131128199032333322" type: string cert_type: description: 证件信息类型,大陆身份证:IDENTITY_CARD example: IDENTITY_CARD type: string liveness_strategy: description: "活体检测类型,当前枚举支持:\tOFF:关闭活体检测;\tCHECK:正常活体检测。\t不传默认CHECK。" example: CHECK type: string nation: description: 国家地区代码,当证件类型为外国人永久居留证时必填。 example: CAN type: string outer_biz_no: description: 客户业务单据号 example: xxxx type: string phone: description: 手机号,特殊场景下,在验证过程中需用户输入手机来接受系统发送的安全验证短信。默认不传即可。 example: "13088646325" type: string reserved: description: true:需要留底;false:无需留底。默认留底 example: true type: boolean security_strategy: description: ON:开启安全拦截。OFF:关闭安全拦截。默认取值为ON。 example: "ON" type: string type: object DatadigitalFincloudGeneralsaasFaceSourceCertifyResponseModel: properties: certify_no: description: 人脸认证单据号,用于认证问题排查 example: xxxx type: string mismatch_reason: description: 认证不通过原因 example: UNABLE_GET_IMAGE type: string passed: description: T:通过;F:不通过 example: T type: string quality: description: double值,人脸图片质量分 example: "30" type: string score: description: double值,活体检测结果分数 example: "30" type: string type: object DatadigitalFincloudGeneralsaasFaceVerificationInitializeErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - ILLEGAL_ARGUMENT_FORMAT - UNKNOWN_ERROR - INVALID_SWITCH - INVALID_CERT_INFO - INVALID_INPUT_IMAGE - OVER_RATE_LIMIT - ACCOUNT_MONEY_LIMIT_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object DatadigitalFincloudGeneralsaasFaceVerificationInitializeModel: properties: biz_code: description: 人脸核身具体类型目前仅支持:DATA_DIGITAL_BIZ_CODE_FACE_VERIFICATION example: DATA_DIGITAL_BIZ_CODE_FACE_VERIFICATION type: string cert_name: description: 真实姓名 example: 张三 type: string cert_no: description: 证件号 example: "131128199004234511" type: string cert_type: description: "证件类型,当前枚举支持:\tIDENTITY_CARD:身份证\tRESIDENCE_HK_MC:港澳居民居住证\t\ RESIDENCE_TAIWAN:台湾居民居住证" example: IDENTITY_CARD type: string face_reserve_strategy: description: 人脸保存策略,非必填。具体取值为:reserve(保存活体人脸)/never(不保存活体人脸),不传默认为reserve example: reserve type: string identity_type: description: 认证类型,固定值为:CERT_INFO example: CERT_INFO type: string nation: description: 国家地区代码,当证件类型为外国人永久居留证时必填。 example: CAN type: string outer_order_no: description: 商户请求的唯一标识,商户要保证其唯一性,值为64位长度的字母数字组合。建议:前面几位字符是商户自定义的简称,中间可以使用一段时间,后段可以使用一个随机或递增序列 example: dsdfaeradsfasdf23234234sdf type: string phone_no: description: 手机号码 example: "13088646233" type: string type: object DatadigitalFincloudGeneralsaasFaceVerificationInitializeResponseModel: properties: certify_id: description: 认证单据号,请保留以便排查问题。 example: adsfasdfasdf type: string page_url: description: 人脸核身url example: http://alipay.com/xxx type: string type: object DatadigitalFincloudGeneralsaasFaceVerificationQueryErrorResponseModel: properties: code: description: 错误码 enum: - UNKNOWN_ERROR - ILLEGAL_ARGUMENT_FORMAT - QUERY_INVALID_CERTIFYID - QUERY_CERTIFYID_EXPIRED - SYSTEM_ERROR - ACCOUNT_NOT_AVAILABLE type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object DatadigitalFincloudGeneralsaasFaceVerificationQueryResponseModel: properties: alive_photo: description: base64过后的图片图片 example: adsfsdfsdf type: string attack_flag: description: 本次认证是否存在安全风险,true:检测到安全风险;false:未检测到安全风险。 example: "true" type: string certify_state: description: 人脸认证状态。PROCESSING:初始化;SUCCESS:认证通过;FAIL:认证不通过。 example: PROCESSING type: string quality: description: double值,人脸图片质量分 example: "2" type: string score: description: double值,活体检测结果分数 example: "30" type: string type: object DatadigitalFincloudGeneralsaasOcrMobileInitializeErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - ILLEGAL_ARGUMENT_FORMAT - UNKNOWN_ERROR - INVALID_SWITCH - ACCOUNT_MONEY_LIMIT_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object DatadigitalFincloudGeneralsaasOcrMobileInitializeModel: properties: biz_code: description: bizCode,代表当前使用的能力类型。 example: DATA_DIGITAL_BIZ_CODE_OCR type: string outer_order_no: description: 客户业务单据号。请保持唯一。 example: sfsdfsdfsdf type: string type: object DatadigitalFincloudGeneralsaasOcrMobileInitializeResponseModel: properties: certify_id: description: OCR识别流水ID,计费依据,请保留方便排查问题 example: xxxxeee888fffss type: string type: object DatadigitalFincloudGeneralsaasOcrServerDetectErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_OCR_TYPE - SYSTEM_ERROR - ILLEGAL_ARGUMENT_FORMAT - UNKNOWN_ERROR - INVALID_SWITCH - FILE_SIZE_TO_LARGE - ACCOUNT_MONEY_LIMIT_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object DatadigitalFincloudGeneralsaasOcrServerDetectModel: properties: ocr_type: description: 可识别OCR类型。如,ID_CARD_FRONT 身份证含照片的一面;ID_CARD_BACK 身份证带国徽的一面。具体支持的类型以接入文档为准。 example: ID_CARD_FRONT type: string outer_order_no: description: 客户业务单据号,请保证幂等性。 example: dfdsdfsdf type: string type: object DatadigitalFincloudGeneralsaasOcrServerDetectResponseModel: properties: certify_id: description: OCR识别单据号,计费依据,请保留以便排查问题。 example: adsfadsfasdf type: string ocr_data: description: OCR识别结果 example: "{\"card_no\":xxxx}" type: string type: object DateRangeInfo: properties: begin_date: description: 开始日期 格式:yyyy-MM-dd type: string end_date: description: 结束日期 格式:yyyy-MM-dd type: string type: object DateRuleInfo: properties: date_range_info: $ref: '#/components/schemas/DateRangeInfo' time_range_info: $ref: '#/components/schemas/TimeRangeInfo' type: object DeductInfo: properties: customer_define_deduct_rule: $ref: '#/components/schemas/CustomerDefineDeductRule' type: object DelayInfo: properties: type: description: "延迟类型,目前支持以下类型\r\tABSOLUTELY:按绝对值延迟\r\tBYDAY:按天延迟" example: ABSOLUTELY type: string value: 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" type: string type: object DeliverAddress: properties: address: description: 地址 example: 地址 type: string address_code: description: 区域编码 example: "330106" type: string default_deliver_address: description: 是否默认收货地址 example: T type: string deliver_area: description: 收货人所在区县 example: 西湖区 type: string deliver_city: description: 收货人所在城市 example: 杭州市 type: string deliver_fullname: description: 收货人全名 example: 支小宝 type: string deliver_mobile: description: 收货地址的联系人移动电话 example: 131XXXXXXXX type: string deliver_phone: description: 收货地址的联系人固定电话 example: 0517-28888888 type: string deliver_province: description: 收货人所在省份 example: 浙江省 type: string zip: description: 邮政编码 example: "310000" type: string type: object DeliveryActivityContentInfo: properties: activity_id: description: 活动id type: string type: object DeliveryAgencyMerchantInfo: properties: business_type: description: 合作业务类型。 type: string merchant_id: description: "代运营商户PID信息。\t限制: 服务商代运营模式必传 " type: string merchant_id_type: description: "商户id类型。 限制: 服务商代运营模式必传" type: string type: object DeliveryAvailableCityCode: properties: all_city: description: 是否全国。 与city_codes二选一。只允许填true,否则不填。 type: boolean city_codes: 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 type: array type: object DeliveryAvailableScope: properties: delivery_available_city_code: $ref: '#/components/schemas/DeliveryAvailableCityCode' delivery_available_scope_type: description: 投放可用范围类型,目前支持的类型是城市范围CITY_CODE type: string type: object DeliveryBaseInfo: properties: delivery_begin_time: description: 投放计划开始时间。 格式为:yyyy-MM-dd HH:mm:ss。 type: string delivery_end_time: description: 投放计划结束时间。 格式为:yyyy-MM-dd HH:mm:ss。 type: string delivery_material: $ref: '#/components/schemas/DeliveryMaterial' delivery_name: description: "投放计划名称。\t投放计划名称不会对用户进行表达,只用于商户管理使用。长度需要大于等于3,小于20。" type: string type: object DeliveryChannelInfo: properties: booth_code: description: 展位码:boothCode表达的是具体渠道所属的展位码。例如:支付结果页PAY_RESULT example: PAY_RESULT type: string channel: description: "可投放的渠道标识.\t\t说明:\t针对不同的boot_code,channel值各不相同.接口使用者可以认为channel是\ 不同booth_code展位下的渠道的唯一标识。\t\t例如:\tbooth_code为PAYMENT_RESULT。 channel为某个\ 商户的pid。" example: 2088xxxxxxxxx type: string channel_name: description: "渠道的名称。\t\t说明:\tbooth_code:PAYMENT_RESULT,channel_name为商户名称\ 。" example: 支付宝官方搜索box type: string type: object DeliveryCityCodeRule: properties: all_city: description: 是否全国。只允许填true,否则不填。 type: boolean city_codes: 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 type: array type: object DeliveryConfig: properties: activity_id: description: 活动id type: string booth_code: description: 展位码:boothCode表达的是具体渠道所属的展位码。例如:支付结果页PAYMENT_RESULT type: string channel: description: 可投放的渠道标识. type: string type: object DeliveryContentConfig: properties: delivery_send_guide: $ref: '#/components/schemas/DeliverySendGuide' type: object DeliveryContentInfo: properties: delivery_activity_content: $ref: '#/components/schemas/DeliveryActivityContentInfo' delivery_app_content: $ref: '#/components/schemas/DeliveryMiniAppContentInfo' delivery_content_type: description: 运营内容类型。 type: string delivery_display_info: $ref: '#/components/schemas/DeliveryDisplayInfo' delivery_item_content: $ref: '#/components/schemas/DeliveryItemContentInfo' type: object DeliveryCrowdRule: properties: crowd_id: description: 指定人群ID type: string type: object DeliveryDisplayInfo: properties: main_title: description: 副标题。 type: string sub_title: description: 副标题 type: string type: object DeliveryFullSendConfig: properties: delivery_content_info: $ref: '#/components/schemas/DeliveryContentInfo' delivery_floor_amount: description: "满足消费金额门槛,左闭区间,单位元。\t说明:限制支付时的订单金额最少满足的金额门槛。\t限制:value > 0\ \ && value <= 99999。" type: string type: object DeliveryItemContentInfo: properties: item_id: description: "支付宝侧商品id。\t注意事项:支持状态为“出售中”的商品" type: string item_type: description: 商品模版类型 type: string type: object DeliveryMaterial: properties: delivery_single_material: $ref: '#/components/schemas/DeliverySingleMaterial' material_id_list: description: 素材ID,通过alipay.marketing.material.create接口提供的素材组 items: type: string type: array type: object DeliveryMerchantInfo: properties: merchant_id: description: 商户id type: string merchant_id_type: description: 商户id类型。 type: string type: object DeliveryMerchantRule: properties: brand_id_list: description: 指定品牌id。 说明:如商户需选择某个品牌下维护的收款账号,请上传相关品牌id items: type: string type: array delivery_merchant_infos: description: 曝光商户选取列表。 说明:需要传入您期望曝光的商户的商户号,传入为空时默认使用投放优惠券活动的适用范围。 限制:曝光商户号需与投放归属商户号相同,或传入有跨主体授权关系的商户号或有弱绑定关系的M3账号 items: $ref: '#/components/schemas/DeliveryMerchantInfo' type: array delivery_merchant_mode: description: 指定支付成功页模式。 type: string type: object DeliveryMiniAppContentInfo: properties: mini_app_delivery_type: description: 仅小程序推广可用。 type: string mini_app_id: description: 小程序ID type: string service_code_list: description: "小程序服务编码/home_page,通过 alipay.open.app.appcontent.function.create(小\ 程序服务创建)接口创建服务后获取。 限制: 1.只有mini_app_id有值时该值传入才会有效 2.当前只支持一个服务code 3.service_codes必\ 须是已传入的mini_app_id下的小程序" items: type: string type: array type: object DeliveryPlayConfig: properties: delivery_full_send_config: $ref: '#/components/schemas/DeliveryFullSendConfig' delivery_single_send_config: $ref: '#/components/schemas/DeliverySingleSendConfig' type: object DeliverySearchBoxRule: properties: box_id: description: 指定搜索直达区域 type: string type: object DeliverySendGuide: properties: delivery_guide_url: description: 引导链接,从支付宝公域跳转到服务商(商户)承接页的引导链接。 type: string type: object DeliverySingleMaterial: properties: delivery_image: description: 投放计划图片素材。通过接口alipay.marketing.material.image.upload上传图片返回的resource_id。 type: string type: object DeliverySingleSendConfig: properties: delivery_content_config: $ref: '#/components/schemas/DeliveryContentConfig' delivery_content_info: $ref: '#/components/schemas/DeliveryContentInfo' type: object DeliveryTargetRegion: properties: region_code: description: 区域编码,参考取值说明 type: string region_name: description: 区域名,参考取值说明 type: string region_type: description: 区域类型,1代表全国,2代表省级区域,3代表市级区域,参考取值说明 type: string type: object DeliveryTargetRule: properties: brand_id_list: description: "指定品牌id。\t说明:如商户需选择某个品牌下维护的收款账号,请上传相关品牌id" items: type: string type: array delivery_available_scope: $ref: '#/components/schemas/DeliveryAvailableScope' delivery_city_code_rule: $ref: '#/components/schemas/DeliveryCityCodeRule' delivery_crowd_rule: $ref: '#/components/schemas/DeliveryCrowdRule' delivery_merchant_infos: description: '"曝光商户选取列表。 说明:需要传入您期望曝光的商户的商户号,传入为空时默认使用投放优惠券活动的适用范围。 限制:曝光商户号需与投放归属商户号相同,或传入有跨主体授权关系的商户号或有弱绑定关系的M3账号"' items: $ref: '#/components/schemas/DeliveryMerchantInfo' type: array delivery_merchant_mode: description: 指定支付成功页模式。 type: string delivery_merchant_rule: $ref: '#/components/schemas/DeliveryMerchantRule' delivery_promo_tags: description: "推荐定向曝光订单优惠标记。\t1. 创建交易订单时,上传符合的订单优惠标。在业务参数信息“business_params”\ 的子字段“delivery_promo_tags”填充订单优惠标。“统一收单交易支付接口”详情查看:https://opendocs.alipay.com/open/02ekfp?scene=32。\ \t2. 订单优惠标,检验规则:\t* 单个优惠标最大长度32字节。多个标记值以英文逗号分隔。\t* 单个优惠标仅支持字母/数字/下划线。\t\ 3. 订单优惠标规则和其他推荐规则同时叠加。" type: string delivery_recall_mode: description: 投放召回模式,现在支持CITY_RECALL(城市召回)和SHOP_RECALL(门店召回)两种模式。 type: string delivery_search_box_rule: $ref: '#/components/schemas/DeliverySearchBoxRule' delivery_template_rule: $ref: '#/components/schemas/DeliveryTemplateRule' delivery_type: description: 小程序推广可用。 type: string type: object DeliveryTemplateRule: properties: template_id: description: 指定商家消息区域 type: string type: object DepartmentInfoDTO: properties: department_code: description: 部门编码 example: D02415 type: string department_id: description: 部门id example: "1001094000039142" type: string department_name: description: 部门名称 example: 产品部 type: string gmt_create: description: 创建时间 example: 2022-06-14 17:15:17 type: string gmt_modified: description: 修改时间 example: 2022-06-14 18:15:17 type: string parent_department_id: description: 上级部门id,特殊值-1表示根部门 example: "1001194000010003" type: string type: object DepositBackInfo: properties: bank_ack_time: description: 银行响应时间,格式为yyyy-MM-dd HH:mm:ss example: 2020-06-02 14:03:48 type: string dback_amount: description: 银行卡冲退金额。单位:元。 example: "1.01" type: string dback_status: description: 银行卡冲退状态。S-成功,F-失败,P-处理中。银行卡冲退失败,资金自动转入用户支付宝余额。 example: S type: string est_bank_receipt_time: description: 预估银行到账时间,格式为yyyy-MM-dd HH:mm:ss example: 2020-06-02 14:03:48 type: string has_deposit_back: description: 是否存在银行卡冲退信息。 example: "true" type: string type: object Detail: properties: code: description: "英文描述(collectAttachement值为true时必填)\t以下是系统固定code,对上传的图片做相应的校\ 验。\t身份证校验情况:\t身份证正面照片:ESIGN_IDCARD\t身份证背面照片:ESIGN_BACK_IDCARD" example: phonePicture type: string description: description: 请上传手机正面照 example: 中文描述(collectAttachement值为true时必填) type: string order: description: 顺序(collectAttachement值为true时必填) example: 1 type: integer type: object DetailBean: properties: code: description: 自定义附件标识,后续下载附件使用此标识区分。 example: phonePicture type: string description: description: 页面展示的附件中文描述(collectAttachement值为true时必填) example: 请上传手机正面照 type: string order: description: 展示顺序(collectAttachement值为true时必填) example: 1 type: integer type: object DiscountDetail: properties: discount_amount: description: 优惠金额 example: "100.00" type: string discount_desc: description: 优惠描述,比如至多优惠XX元,满XX减XX example: 最高优惠10元;储值卡专属 items: type: string type: array discount_type: description: "优惠类型,商家优惠(M_DISCOUNT),平台优惠(RT_DISCOUNT)" example: RT_DISCOUNT type: string id: description: 优惠ID或活动ID example: 2017CVCJD788E889EC type: string is_hit: description: "优惠是否命中, true代表命中了优惠;false代表未命中优惠" example: "true" type: string is_purchased: description: "是否是购买券, true代表是购买的券,false调表不是购买的券" example: "true" type: string name: description: 优惠名称 example: 5折优惠 type: string type: object DiscountInfoData: properties: discount_amount: description: 优惠金额 example: "2.44" type: string discount_name: description: 优惠名称 example: 商家红包 type: string discount_page_link: description: 优惠跳转链接地址 example: https://www.alipay.com/ type: string discount_quantity: description: 优惠数量 example: 1 type: integer external_discount_id: description: 外部优惠id example: discount001 type: string type: object DiscountTypeSyncData: properties: discount_amount: description: 商户回传的优惠金额,如用户享受的红包金额,单位元 example: "8.75" type: string discount_desc: description: 商户数据回传的优惠信息的名称。 example: 消费满减优惠001 type: string type: object DiscountVoucher: properties: ceiling_amount: description: 封顶金额。 type: string discount: description: 折扣率。 type: string floor_amount: description: 门槛金额。说明:该字段可不填,认为无门槛; type: string goods_name: description: 商品名称。 type: string origin_amount: description: 原价。说明:该字段可不填,填入商品名称goods_name则必填; type: string type: object DiscountVoucherInfo: properties: ceiling_amount: description: 封顶金额。 type: string discount: description: 折扣率。 type: string floor_amount: description: 门槛金额。说明:该字段可不填,认为无门槛; type: string voucher_deduct_threshold_info: $ref: '#/components/schemas/VoucherDeductThresholdInfo' type: object DisplayConfig: properties: slogan: description: "券的宣传语\r\t含圈人的直领活动,且投放渠道选择了支付成功页或店铺的情况下必填" example: 券的宣传语 type: string slogan_img: description: "券的宣传图片文件ID\r\t含圈人的直领活动,且投放渠道选择了店铺的情况下必填" example: 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC type: string type: object DocInfo: properties: file_name: description: 合同文件名 example: 租机合同.pdf type: string file_url: description: 合同下载地址 example: https://oss.***.cn/****abc.pdf type: string type: object EcConsumeInfo: properties: account_id: description: 共同账户ID type: string agreement_peer_payer_id: description: 协议出资支付宝账号 type: string benefit_amount: description: 员工优惠金额,单位:元 type: string biz_out_no: description: 外部交易流水号 type: string category_name: description: 账单分类名称,比如:餐饮美食,交通出行,酒店旅游等 type: string consume_amount: description: 账单金额,单位:元,不包含营销资产 type: string consume_biz_type: description: "账单业务类型\t-因公支付:EC_PAY\t-因公收款:EC_CLLCT" type: string consume_category: description: 员工消费记账分类 type: string consume_fee_with_discount: description: 订单原价,单位:元,包含营销资产 type: string consume_memo: description: 员工消费记账备注 type: string consume_type: description: "账单类型\t-消费账单:CONSUME\t-退款账单:REFUND\t-转账账单:TRANSFER" type: string employee_id: description: 员工账号ID type: string enterprise_id: description: 企业ID type: string expense_rule_group_id: description: 使用规则ID type: string expense_scene_code: description: 费用场景 type: string expense_type: description: 费用类型 type: string expense_type_sub_category: description: 费用类型子类目 type: string ext_infos: description: "账单扩展信息,JsonMap格式, key值枚举 [{\"value\": \"SUMMARY_INFO\",\"\ name\": \"账单汇总信息\"},{\"value\": \"MERCHANT_EXTEND_INFO\",\"name\": \"商\ 户扩展信息\"}, {\"value\": \"TERMINAL_INFO\",\"name\": \"终端设备信息\"},{\"value\"\ : \"BENEFIT_INFO\",\"name\": \"优惠扩展信息\"}, {\"value\": \"CONSUMPTION_LOCATION\"\ ,\"name\": \"消费上报位置\"},{\"value\": \"THIRD_PARTY_PAYMENT_INFO\",\"name\"\ : \"代收款详情\"}]" type: string fund_biz_type: description: "出资模式\t个人出资:PERSONAL\t企业出资:ENTERPRISE\t三方垫资合作伙伴出资:TP\t记账:ACCOUNTING" type: string gmt_biz_create: description: 账单创建时间,格式:yyyy-MM-dd HH:mm:ss type: string gmt_receive_pay: description: 账单支付时间,格式:yyyy-MM-dd HH:mm:ss type: string invoice_open_mode: description: "开票模式\t企业汇总开:ENTERPRISE_AUTO_BATCH" type: string merchant_id: description: 商户ID type: string merchant_name: description: 商户名称 type: string open_id: description: 员工支付宝UID type: string opposite_full_name: description: 收款方全称(如果是个人会显示脱敏后的名称) type: string order_complete_label: description: "订单完结标识\t0:未完结\t1:已完结" type: string order_complete_time: description: "2022-01-01 01:01:02\t订单完结时间" type: string pay_no: description: 交易流水号 type: string payer_card_no: description: 付款方卡号 type: string payer_logon_id: description: 付款方登录账号 type: string payer_name: description: 付款方名称 type: string peer_pay_amount: description: 企业代付金额,单位:元 type: string peer_payer_card_no: description: 实际出资支付宝账号 type: string peer_refund_amount: description: 消费账单企业代付部分退款金额,单位:元。退款账单该值无意义,值为0。 type: string peer_refund_status: description: "消费账单企业代付部分退款状态,默认为INIT。当消费账单有退款,该值会变为REFUND_PART或REFUND_FULL;\ 退款账单该值无意义,为初始值INIT。\t未退款:INIT,\t部分退款:REFUND_PART,\t全额退款:REFUND_FULL" type: string related_pay_no: description: 退款账单关联的消费账单交易流水号,退款账单才有值 type: string scene_code: description: "账单场景\tTAKE_AWAY:外卖\tMETRO:地铁\tOTHER:其他" type: string seller_id: description: 卖家ID type: string shop_id: description: 门店ID type: string store_id: description: 外部门店ID type: string summary_apply_id: description: 汇总批次ID type: string user_id: description: 员工支付宝UID type: string type: object EcOrderInfo: properties: order_info: $ref: '#/components/schemas/EcOrderItem' sub_order_list: description: 子订单详情列表 items: $ref: '#/components/schemas/EcOrderItem' type: array type: object EcOrderItem: properties: account_id: description: 共同账户ID type: string biz_out_no: description: 外部业务号 type: string employee_id: description: 员工ID type: string enterprise_id: description: 企业ID type: string gmt_create: description: 创建时间 type: string gmt_modified: description: 修改时间 type: string open_id: description: 用户支付宝UID type: string order_content: description: 订单内容,JSON格式。 type: string order_id: description: 订单ID type: string order_type: description: "订单类型\tMETRO:地铁\tTAKEAWAY:外卖\tOTHER:其他" type: string partner_id: description: 合作伙伴ID type: string pay_no: description: 关联支付宝交易号 type: string user_id: description: 用户支付宝UID type: string type: object EcShopInfo: properties: address: description: 门店地址 example: xxx大道xxx号 type: string city_id: description: 城市编码 example: "330100" type: string city_name: description: 城市名称 example: 成都市 type: string district_id: description: 区编码 example: "330101" type: string district_name: description: 区名称 example: 武侯区 type: string latitude: description: 纬度 example: "29.333" type: string longitude: description: 经度 example: "121.222" type: string mcc_code_1: description: 一级mcc编码 example: A0001 type: string mcc_code_2: description: 二级mcc编码 example: B0001 type: string mcc_name_1: description: 一级mcc名称 example: 餐饮 type: string mcc_name_2: description: 二级mcc名称 example: 中式快餐 type: string outdoor_img_url: description: 门头照地址 example: http://xxxx.png type: string poi_id: description: 高德poiId example: B0G29CP65Q type: string province_id: description: 省份编码 example: "330000" type: string province_name: description: 省份名称 example: 四川省 type: string shop_name: description: 门店名称 example: xxx门店 type: string type: object EcVoucherInfo: properties: account_id: description: 共同账户ID example: "2088000000000000" type: string employee_id: description: 员工ID,汇总发票该字段无效 example: "228800000000001000843" type: string enterprise_id: description: 企业ID example: "2088000000000000" type: string open_id: description: 员工支付宝UID example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string user_id: description: 员工支付宝UID example: "2088000000000000" type: string voucher_content: description: 凭证内容 example: "{\\\"key\\\":\\\"value\\\"}" type: string voucher_date: description: 凭证创建时间,格式:yyyy-MM-dd HH:mm:ss example: 无 type: string voucher_id: description: 凭证ID,幂等用 example: "2022060600152611070001623913" type: string voucher_source: description: 凭证来源 example: OCR type: string voucher_type: description: 凭证类型 example: Invoice type: string type: object EinvTrade: properties: bill_no: description: 订单编号 type: string bill_time: description: 下单时间 type: string city_name: description: 商户所在城市(经营地址) type: string detail_json: description: 账单明细信息,酒店水单信息,行程单信息,餐饮小票信息 type: string download_url: description: 账单明细信息,酒店水单,行程单,餐饮小票等pdf原件链接 type: string extend_map: description: "扩展参数\t\t不同组的k-v通过换行符区分" type: string merchant_name: description: 商家名称(显示名称,非企业名称,餐饮店、酒店、打车平台名称) type: string out_json: description: 透传字段,不做处理,用于isv向后续报销税控方传递特殊信息标记 type: string payee_name: description: 销方名称 type: string payment_amount: description: "支付金额,单位(元),\t对应账单中的交易金额" type: string payment_time: description: "支付时间\t\t对应账单中的账单日期" type: string souce: description: "交易类型来源 需要按照枚举映射\t\tconsume 账单\t\thotel 酒店水单\t\titinerary 打\ 车行程单\t\tcatering 餐饮小票" type: string trade_type: description: 交易类型/账单分类 type: string type: object EmployeeDepartmentDTO: properties: department_id: description: 部门id example: "1001094000039142" type: string department_name: description: 部门名称 example: 产品部 type: string type: object EmployeeInfoDTO: properties: activate: description: 是否激活 example: ACTIVATED type: string department_list: description: 员工所属部门列表 items: $ref: '#/components/schemas/EmployeeDepartmentDTO' type: array email: description: 邮箱 example: 123456@qq.com type: string employee_cert_no: description: 证件号,手机号,邮箱三个必填其一 example: "12345" type: string employee_cert_type: description: 证件类型,当证件号不为空时必填 example: IDENTITY_CARD type: string employee_id: description: 员工id example: "228420000000057942506" type: string employee_name: description: 员工姓名 example: 张三 type: string employee_no: description: 员工工号 example: "200818255" type: string encrypt_cert_no: description: 加密身份证号,当加密类型不为空时必填 example: 0fc57efb28cfb5125d32e6d84823d49032d46d10df08f0e599d3844ecd3e0a1f type: string encrypt_mobile: description: 加密手机号,当加密类型不为空时必填 example: f20a8027c95b5b3225c93e81e39ff0f496fd2868de11dbcc49d9584be80463a6 type: string gmt_create: description: 变更时间 example: 2022-04-20 17:13:51 type: string gmt_modified: description: 变更时间 example: 2022-04-25 17:13:51 type: string iot_face_status: description: 员工是否人脸在库 example: "1" type: string iot_vid: description: 员工在企业人脸库的人脸唯一标识 example: 2109b5e671aa3ff2eb4851816c65828f type: string mobile: description: 手机号码 example: "13456782345" type: string open_id: description: 用户id example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string role_list: description: 角色列表 example: "[\"ADMIN\"]" items: type: string type: array user_id: description: 用户id example: "2088123454654356" type: string type: object EmployeeTitleDTO: properties: account_id: description: "共同账户id,与enterprise_id两者必填其一" type: string create_by: description: 创建人 type: string employee_id: description: 企业域定义的员工id,与user_id两者必填其一 type: string enterprise_id: description: 企业域定义的企业id,与account_id两者必填其一 type: string modify_by: description: 修改人 type: string open_id: description: "员工支付宝账号open_id,与employee_id两者必填其一" type: string title_id: description: 抬头id type: string title_tag: description: 关系标记 type: string user_id: description: "员工支付宝账号2088,与employee_id两者必填其一" type: string type: object EndTimeInfo: properties: end_time: description: 结束时间 格式:HH:mm:ss type: string end_time_type: description: 结束时间类型 type: string type: object EnterpriseAgreementDTO: properties: agreement_id: description: 协议id example: AG00000171 type: string enterprise_id: description: 企业id example: "2088441399627416" type: string enterprise_name: description: 企业名称 example: 企业码测试企业 type: string sign_date: description: 签约时间 example: 2022-04-20 17:13:51 type: string sign_status: description: 签约状态 example: SIGNED type: string type: object EnterpriseInfoDTO: properties: account_id: description: 共同账户id type: string activate: description: 因公签约状态 type: string auth_level: description: 企业认证等级 type: string auth_status: description: 认证状态 type: string auth_time: description: 认证时间 type: string enterprise_alias: description: 企业简称 type: string enterprise_code: description: 统一社会信用码 type: string enterprise_email: description: 企业邮箱 type: string enterprise_id: description: 企业id type: string enterprise_name: description: 企业名称 type: string gmt_create: description: 创建时间 type: string gmt_modified: description: 更新时间 type: string iot_group_id: description: 封闭场景(如班车)的人脸库id type: string iot_logic_group_id: description: 开放场景(如团餐)的人脸库id type: string platform_code: description: 外部平台code type: string platform_out_id: description: 外部平台id type: string sign_status: description: 企业码服务协议签约状态 type: string status: description: 企业当前状态 type: string type: object EnterpriseOpenRuleInfo: properties: enterprise_id: description: 企业ID example: "2088000194958956" type: string enterprise_open_rule_record_info_list: description: 当前生效和下次生效的开票规则记录 items: $ref: '#/components/schemas/EnterpriseOpenRuleRecordInfo' type: array enterprise_open_rule_relation_info_list: description: 开票规则绑定关系 items: $ref: '#/components/schemas/EnterpriseOpenRuleRelationInfo' type: array gmt_create: description: 创建时间 example: 2021-08-27 00:00:00 type: string gmt_modified: description: 修改时间 example: 2021-08-27 00:00:00 type: string invoice_rule_id: description: 开票规则ID example: "2021032900152710950000000001" type: string invoice_rule_name: description: 开票规则名称 example: 开票规则测试1 type: string owner_id: description: 所有者ID(企业情况下即为企业ID) example: "2088000194958956" type: string seller_type: description: "销方类型:TP开票、商户开票、商户优先\t枚举定义:MERCHANT(商户)、TP(TP)" example: TP type: string type: object EnterpriseOpenRuleRecordInfo: properties: bill_month_day: description: 开票规则账单日 example: 5 type: integer effective_start: description: 开票规则生效日期 example: 2021-08-27 00:00:00 type: string enterprise_id: description: 企业ID example: "2088000000000001" type: string gmt_create: description: 创建时间 example: 2021-08-27 00:00:00 type: string gmt_modified: description: 修改时间 example: 2021-08-27 00:00:00 type: string invoice_rule_id: description: 开票规则ID example: "2021032900152710950000000001" type: string invoice_rule_record_id: description: 开票规则记录ID example: "2021032900152710950000000001" type: string invoice_title_id: description: 发票抬头ID example: "2021032900152710950000000001" type: string open_applyer: description: 开票申请方 example: ENTERPRISE type: string open_mode: description: 开票模式 example: SUMMARY type: string open_type: description: 开票申请类型 example: AUTO type: string owner_id: description: 所有者ID(企业情况下即为企业ID) example: "2088000194958956" type: string tag: description: 开票规则标记 example: DEFAULT type: string type: object EnterpriseOpenRuleRelationInfo: properties: enterprise_id: description: 企业ID example: "2088000000000001" type: string gmt_create: description: 创建时间 example: 2021-08-27 00:00:00 type: string gmt_modified: description: 修改时间 example: 2021-08-27 00:00:00 type: string owner_id: description: 所有者ID(企业情况下即为企业ID) example: "2088000194958956" type: string standard_id: description: 费控规则ID example: "2021032900152710950000000001" type: string type: object EnterprisePayInfo: properties: biz_info: description: 因公付业务信息 type: string invoice_amount: description: 开票金额 type: string is_use_enterprise_pay: description: 是否包含因公付资产 type: boolean type: object EnterpriseTitleInfo: properties: address: description: 详细地址 type: string bank_account: description: 开户行账号 type: string bank_name: description: 开户行地址 type: string tax_register_no: description: 税号 type: string telephone: description: 电话 type: string title_id: description: 抬头ID type: string title_name: description: 企业抬头名称 type: string type: object ErrorDeliveryConfig: properties: delivery_config: $ref: '#/components/schemas/DeliveryConfig' error_code: description: 错误码。针对单个投放,具体的错误原因。 type: string error_msg: description: 详细的投放错误信息。用于判断具体的错误信息。 type: string type: object ErrorMatcher: properties: error_msg: description: 失败原因 type: string matcher: $ref: '#/components/schemas/Matcher' type: object ExchangeVoucher: properties: amount: description: 券的价值 type: string biz_type: description: "兑换券业务类型。\t\t枚举值\t团购券:GROUP_BUY_EXCHANGE_VOUCHER\t代金券:FIX_EXCHANGE_VOUCHER\t\ 注意:兑换券通过大\ 促活动权益报名能力推广至支付宝会场时,本参数必填。" type: string customer_service_mobile: description: 客服电话 type: string customer_service_url: description: 客服链接 type: string floor_amount: description: 门槛金额。说明:该字段可不填,认为无门槛; type: string overdue_refundable: description: "是否支持优惠券过期后,自动退款给用户。\t不填默认否,枚举值:\ttrue:是\tfalse:否" type: boolean payee_pid: description: 收款账号。目前的结算规则是,每核销一笔优惠券,支付宝会打款到该收款账户。 type: string refundable: description: "购买的优惠券是否允许退款。不填默认否,枚举值:\ttrue:是\tfalse:否" type: boolean sale_amount: description: 用户购买优惠券需要支付的金额 type: string settle_type: description: 解决类型。 type: string voucher_detail_url: description: 领(购)券详情页链接,从支付宝公域跳转到服务商(商户)自定义领(购)券详情页。 type: string voucher_name: description: 对消费者展示的券(商品)名称。 type: string type: object ExchangeVoucherInfo: properties: amount: description: 券的价值 type: string biz_type: description: 兑换券业务类型。 注意:兑换券通过大促活动权益报名能力推广至支付宝会场时,本参数必填。 type: string exchange_goods_info: $ref: '#/components/schemas/VoucherExchangeGoodsInfo' floor_amount: description: 优惠门槛金额,表示只有当订单金额大于等于门槛金额时券才能使用。该字段为空时表示无门槛。 门槛金额的校验由服务商(商户)核销时自行校验,支付宝侧只做展示使用。 type: string voucher_deduct_threshold_info: $ref: '#/components/schemas/VoucherDeductThresholdInfo' type: object ExchangeVoucherModify: properties: voucher_detail_url: description: 领(购)券详情页链接,从支付宝公域跳转到服务商(商户)自定义领(购)券详情页。 example: alipays://platformapi/startapp?appId=xxxx type: string voucher_name: description: 对消费者展示的券(商品)名称。 example: 满10减1 type: string type: object ExpenseConsumeInfo: properties: account_id: description: 企业ID type: string actual_account_number: description: 实际出资企业支付宝账号 type: string batch_id: description: 汇总批次ID(废弃) type: string bill_no: description: 支付流水号 type: string bill_type: description: 账单类型(CONSUME-消费账单、REFUND-退款、TRANSFER-转账) type: string category_name: description: 账单行业分类(交通出行,餐饮美食,商业服务,日用百货等等) type: string consume_amount: description: 账单金额(单位:元) type: string consume_date: description: 交易日期 type: string consume_title: description: 账单展示标题 type: string employee_id: description: 所属员工支付宝uid type: string employee_open_id: description: 所属员工支付宝uid type: string merchant_id: description: 商户id type: string mshop_id: description: 门店id type: string open_model: description: 开票模式(汇总开:ENTERPRISE_AUTO_BATCH) type: string original_voucher_id: description: 退款交易关联正交易单号(对应正交易的bill_no) type: string out_biz_no: description: 外部流水号 type: string p_pay_amount: description: 企业支付金额(单位:元) type: string payee_name: description: 商家名称 type: string project_id: description: 费控规则中的项目ID type: string projiect_id: description: 支付使用的项目号(成本中心)此字段废弃 type: string refund_amount: description: 消费账单的退款金额(元) type: string refund_status: description: 消费账单的退款状态 type: string standard_id: description: 费控规则ID type: string store_id: description: 外部门店id type: string summary_id: description: 批次id type: string tp_sign: description: "出资类型:\tPERSONAL:个人垫付\tENTERPRISE:企业垫资\tTP:三方合作伙伴垫资\tACCOUNTING:记\ 账" type: string voucher_id: description: 凭证ID type: string type: object ExpenseCtrRuleGroupInfo: properties: expense_ctrl_rule_info_list: description: 费控条件列表 items: $ref: '#/components/schemas/ExpenseCtrRuleInfo' type: array expense_type: description: "费用类型\t特殊说明:仅支持费用类型DEFAULT" type: string group_id: description: 费控规则ID type: string group_name: description: "费控规则名称\t约束:\t1)敏感词校验\t2)不能重复" type: string type: object ExpenseCtrRuleInfo: properties: rule_factor: description: 费控维度 type: string rule_id: description: 费控条件ID type: string rule_name: description: 费控条件名称 type: string rule_operator: description: "费控条件操作符\t枚举值:\tLT(\"<\",\"小于\")\tLE(\"<=\",\"小于等于\")\tEQ(\"\ =\",\"等于\")\tNE(\"!=\",\"不等于\")\tGE(\">=\",\"大于等于\")\tGT(\">\",\"大于\")" type: string rule_value: description: 费控条件值 type: string type: object ExpenseCtrlConsumeInfo: properties: expense_consume_info: $ref: '#/components/schemas/ExpenseConsumeInfo' related_enterprise_consume_list: description: 关联凑票账单列表(开票限额,多次消费后合并开票) items: $ref: '#/components/schemas/ExpenseConsumeInfo' type: array related_enterprise_invoice_list: description: 关联发票凭证对象 items: $ref: '#/components/schemas/ExpenseInvoiceInfo' type: array type: object ExpenseCtrlEmployeeRuleInfo: properties: effective: description: 费控规则状态,1表示有效,0表示无效 example: 1 type: integer effective_end_date: description: 费控规则有效期截止 example: 2022-08-08 00:00:00 type: string effective_start_date: description: 费控规则有效期起始 example: 2021-08-08 00:00:00 type: string owner_type: description: "费控规则作用范围,\tEMPLOYEE表示员工,ENTERPRISE表示企业" example: EMPLOYEE type: string standard_id: description: 费控规则ID example: 202106280015260135000000xxxx type: string standard_name: description: 费控规则名称 example: 测试规则 type: string type: object ExpenseInvoiceInfo: properties: employee_id: description: 员工ID type: string employee_open_id: description: 员工ID type: string 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: description: 凭证ID type: string type: object ExpenseMerchantInfo: properties: merchant_name: description: 商户名称 example: 肯德基 type: string pid: description: 商户ID example: 2088xxx type: string role_id: description: 商户ID example: 2088xxx type: string role_type: description: "角色类型\t0-直连商户\t1-间联商户" example: "0" type: string shop_id: description: 门店ID example: 2088xxx type: string shop_name: description: 门店名称 example: 肯德基陆家嘴店 type: string type: object ExpenseQuotaInfo: properties: effective_end_date: description: 额度失效时间 example: 2021-10-01 00:00:00 type: string effective_start_date: description: 额度生效时间 example: 2021-01-01 00:00:00 type: string enterprise_id: description: 企业ID example: "2088000194958956" type: string freeze: description: 额度是否冻结,冻结后因公付不可用 example: true type: boolean owner_id: description: "额度所属者ID\towner_type为EMPLOYEE时为员工支付宝ID\towner_type为ENTERPRISE_PAY_UID时\ 为员工企业码ID\towner_type为PHONE时为员工手机号\towner_type为ENTERPRISE时为企业ID" example: 2088xxx type: string owner_open_id: description: owner_type为EMPLOYEE时为员工open_id owner_type为PHONE时为员工手机号 owner_type为ENTERPRISE_PAY_UID时为员工企业码ID example: abcdxxxx type: string owner_type: description: 额度所属者id类型 example: EMPLOYEE type: string quota_available: description: 可用金额(单位分) example: "20" type: string quota_id: description: 额度ID example: "2021062800152601350000001468" type: string quota_locked: description: 锁定金额(单位分) example: "10" type: string quota_total: description: 总金额(单位分) example: "100" type: string quota_type: description: 额度类型 example: CAP type: string quota_used: description: 已用金额(单位分) example: "70" type: string target_id: description: "额度维度ID\t当 target_type=EXPENSE_TYPE 时,值为\tMEAL(工作餐)\t当target_type=RULE_GROUP_AGGREGATION\ \ 时,值为费控规则聚合ID\t当target_type=INSTITUTION 时,值为制度ID" example: MEAL type: string target_type: description: 额度维度 example: EXPENSE_TYPE type: string type: object ExpenseVoucherInfo: properties: account_id: description: 企业支付宝用户id(对应凭证ownerid) example: "2088123456789000" type: string consumption_date: description: 消费时间 example: 2021-04-01 12:00:00 type: string employee_id: description: 员工ID example: "2088123456789000" type: string employee_open_id: description: 员工ID example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string extension: description: 扩展预留 example: 暂无 type: string gmt_create: description: 数据创建时间 example: 2021-04-02 12:00:00 type: string gmt_modified: description: 数据更新时间 example: 2021-04-02 20:00:00 type: string industry: description: 行业属性值(从支付宝主账单复制) example: hotel type: string is_off_set: description: 是否冲抵凭证:0 否(蓝票);1 是(如:红票) example: "0" type: string medium: description: "凭证介质:纸or电子(PAPER,ELECTRON)" example: PAPER type: string outer_source_id: description: 外部唯一ID(和凭证类型有关,如果发票类型为发票号码+发票编码,如果是账单,则为账单号) example: "10000000000000002" type: string parent_type: description: 凭证父类型(INVOICE-发票,TRAVEL-出行凭证,HTL_ORDER-酒店水单,CONSUME-账单,财政票夹) example: INVOICE type: string voucher_amount: description: 交易金额(元) example: "100.00" type: string voucher_date: description: 凭证创建时间 example: 2021-04-01 12:00:00 type: string voucher_id: description: 凭证ID example: "2020123100152601930000003650" type: string voucher_no: description: "一类凭证,唯一号码,有必须传,没有可不传。\t发票、账单必须有\t如部分餐饮小票,没有唯一号" example: "2020123100152601930000003650" type: string voucher_state: description: 凭证状态(0-无效,1 有效) example: "0" type: string voucher_type: description: "凭证类型\t(FINANCIAL_BILLS-财政电子票\tMEDICAL_INVOICE-医疗票据\tDONATION_INVOICE-公\ 益捐赠电子票据\tSETTLEMENT_INVOICE-往来结算票据\tDUES_INVOICE-社会团体会费收据\tINVOICE-增值税\ 票\tPLAIN-增值税电子普通发票\tSPECIAL-增值税专用发票\tPLAIN_INVOICE-增值税普通发票\tPAPER_INVOICE-增\ 值税普通发票(卷式)\tCONSUME-账单\tALIPAY_CONSUME-支付宝账单\tTRAVEL-出行凭证\tTAXI-出租车票\t\ BUS_TICKET-汽车票\tTRAIN-火车票\tTOLL-过路费\tBOARD_PASS-登机牌\tHTL_ORDER-酒店水单\t\ MEMO-酒店水单\tOTHERS-杂票\tFIXED-定额发票\tLIST-小票\tCOMMON_INVOICE-通用发票)" example: INVOICE type: string type: object ExtCardInfo: properties: bank_acc_name: description: 记账的外卡户名 type: string card_bank: description: 记账的外卡开户行 type: string card_branch: description: 记账的外卡支行 type: string card_deposit: description: 记账的外卡联行号 type: string card_location: description: 记账的外卡开户地址 type: string card_no: description: 记账的外卡卡号 type: string status: description: "记账的外卡状态,\tA:正常状态; \t其他:异常" type: string type: object ExtTemplateConf: properties: buyer_id: description: 淘宝uid example: "11212321121" type: string xxhm_info_id: description: 先享后买id example: "687542" type: string type: object ExtUserInfo: properties: cert_no: description: "买家证件号。\t注:need_check_info=T或fix_buyer=T时该参数才有效,支付宝会比较买家在支付\ 宝留存的证件号码与该参数传入的值是否匹配。" type: string cert_type: description: "指定买家证件类型。\t枚举值:\tIDENTITY_CARD:身份证;\tPASSPORT:护照;\tOFFICER_CARD:\ 军官证;\tSOLDIER_CARD:士兵证;\tHOKOU:户口本;\tPERMANENT_RESIDENCE_FOREIGNER:外国人\ 永久居留身份证。\t如有其它类型需要支持,请与蚂蚁金服工作人员联系。\t注: need_check_info=T或fix_buyer=T时该\ 参数才有效,支付宝会比较买家在支付宝留存的证件类型与该参数传入的值是否匹配。" type: string fix_buyer: description: "是否强制校验买家身份。\t需要强制校验传:T;\t不需要强制校验传:F或者不传;\t当传T时,接口上必须指定cert_type、\ cert_no和name信息且支付宝会校验传入的信息跟支付买家的信息都匹配,否则报错。\t默认为不校验。" type: string identity_hash: description: 买家加密身份信息。当指定了此参数且指定need_check_info=T时,支付宝会对买家身份进行校验,校验逻辑为买家姓名、买家证件号拼接后的字符串,以sha256算法utf-8编码计算hash,若与传入的值不匹配则会拦截本次支付。注意:如果同时指定了用户明文身份信息(name,cert_type,cert_no中任意一个),则忽略identity_hash以明文参数校验。 type: string min_age: description: "允许的最小买家年龄。\t买家年龄必须大于等于所传数值 \t注:\t1. need_check_info=T时该参数才\ 有效\t2. min_age为整数,必须大于等于0" type: string mobile: description: "指定买家手机号。\t注:该参数暂不校验" type: string name: description: "指定买家姓名。\t注: need_check_info=T或fix_buyer=T时该参数才有效" type: string need_check_info: description: "是否强制校验买家信息;\t需要强制校验传:T;\t不需要强制校验传:F或者不传;\t当传T时,支付宝会校验支付买家的\ 信息与接口上传递的cert_type、cert_no、name或age是否匹配,只有接口传递了信息才会进行对应项的校验;只要有任何一项信息校\ 验不匹配交易都会失败。如果传递了need_check_info,但是没有传任何校验项,则不进行任何校验。\t默认为不校验。" type: string type: object ExtendParams: properties: card_type: description: 卡类型 type: string hb_fq_num: description: 使用花呗分期要进行的分期数 type: string hb_fq_seller_percent: description: 使用花呗分期需要卖家承担的手续费比例的百分值,传入100代表100% type: string industry_reflux_info: description: "行业数据回流信息, 详见:地铁支付接口参数补充说明" type: string royalty_freeze: description: 是否进行资金冻结,用于后续分账,true表示资金冻结,false或不传表示资金不冻结 type: string specified_seller_name: description: 特殊场景下,允许商户指定交易展示的卖家名称 type: string sys_service_provider_id: description: "系统商编号\r\t该参数作为系统商返佣数据提取的依据,请填写系统商签约协议的PID" type: string tc_installment_order_id: description: 公域商品交易分期单ID,小程序交易组件订单特殊场景使用,请传入 订单分期接口(alipay.open.mini.order.installment.create)中返回的installment_order_id type: string trade_component_order_id: description: 公域商品交易业务订单ID type: string type: object ExtensionArea: properties: goto_url: description: 跳转链接,当type为"image"时必传,必须是https或alipays开头的url链接。已废弃 type: string height: description: 扩展区高度,当type值为"h5"时必填,取值范围为200-500的整数 type: integer name: description: 扩展区名字 type: string type: description: 扩展区类型,当前支持的值为h5,表示扩展区内容类型为h5。 type: string url: description: 扩展区url,传入h5页面url,必须是https开头的链接 type: string type: object ExtraParams: properties: period: description: 轻会员场景下协议结算周期,由协议生效日期到失效日期拼接(yyyyMMddHHmmss-yyyyMMddHHmmss),精确到秒。 example: 20181223235059-20181230235010 type: string period_summary_info: 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\"}" type: string quit_type: description: 用户主动意愿退出:USER_CANCEL_QUIT; 商户结算退出:SETTLE_APPLY_QUIT; 默认值为SETTLE_APPLY_QUIT;这个字段会影响用户在芝麻信用合约的状态 example: SETTLE_APPLY_QUIT type: string withhold_index: description: 代扣期数,周期扣场景PERIOD_SETTLE下需要传递 example: "2" type: string type: object FaceExtInfo: properties: max_age: description: 年龄区间判断的上限,闭区间 example: "30" type: string min_age: description: 年龄区间判断的下限,闭区间 example: "10" type: string query_type: description: "query_type不填, 返回uid\r\tquery_type=1, 返回手机号\r\tquery_type=2,\ \ 返回图片" example: 1;2;3等 type: string type: object FaceExtParams: properties: biz_type: description: 业务类型:7,基于1:N人脸搜索的刷脸支付场景;8,基于姓名和身份证号的刷脸支付场景。 example: "1" type: string type: object FaceMachineInfo: properties: camera_drive_ver: description: 摄像头驱动版本号 example: "1.0" type: string camera_model: description: 摄像头型号 example: AstraP1 type: string camera_name: description: 摄像头名称 example: AstraP1 type: string camera_ver: description: 摄像头版本号 example: "1.0" type: string ext: description: 扩展信息 example: 扩展信息 type: string machine_code: description: 机具编码 example: WyDAz27pfsEDANGk7QnmxZlv type: string machine_model: description: 机具型号 example: T2 type: string machine_ver: description: 机具版本号 example: 7.1.1 type: string type: object FaceMerchantInfo: properties: area_code: description: 区域编码 example: 华中 type: string brand_code: description: 品牌编码 example: KFC type: string device_mac: description: 机具Mac地址 example: 1c:aa:07:b0:e7:af type: string device_num: description: 机具编码 example: TEST_ZOLOZ_TEST type: string geo: description: 经纬度 example: "120.10785,30.26708" type: string group: description: 机具分组编码 example: group1 type: string merchant_id: description: 商户ID example: "2088302068579978" type: string partner_id: description: ISV ID example: "2088302068579978" type: string store_code: description: 门店编码 example: TEST type: string wifimac: description: WI-FI Mac地址 example: 1c:aa:07:b0:e7:af type: string wifiname: description: WI-FI 名称 example: Alipay-Test type: string type: object FailVoucherCodeDetail: properties: error_code: description: 券码导入失败错误码 example: VOUCHER_CODE_DUPLICATE type: string error_msg: description: 券码导入失败错误原因描述 example: 与之前导入的券码重复 type: string voucher_code: description: 导入失败的券码 example: 789CE type: string type: object FileUploadExtraParam: properties: extern_upload: description: 是否同步上传到其他平台。素材类型为视频且需要同步优酷,请必传入参数youku,素材接口将代上传到优酷账号;素材类型为图片,无需传入参数 example: youku type: string file_encrypt_type: description: 文件加密类型 example: NO_ENCRYPT type: string type: object FillContent: properties: struct_key: description: 模板组件自定义key type: string value: description: "模板值,该值长度取决于配置模板时该字段的限制" type: string type: object Filter: properties: context: $ref: '#/components/schemas/LabelContext' template: description: "过滤器模板,${a}是一个变量,会被context参数中的a参数替换,从而展开为最终的表达式,template最多支\ 持两个参数,支持and及or连接符。\r\tand:同时满足条件;\r\tor:只需满足其中一个条件" example: "${a}" type: string type: object FixVoucher: properties: amount: description: 面额,每张代金券可以抵扣的金额。 type: string floor_amount: description: 门槛金额。该字段不填写,认为无门槛。 type: string goods_name: description: 商品名称。 type: string type: object FixVoucherInfo: properties: amount: description: 面额,每张代金券可以抵扣的金额。 type: string floor_amount: description: 门槛金额。该字段不填写,认为无门槛。 type: string voucher_deduct_threshold_info: $ref: '#/components/schemas/VoucherDeductThresholdInfo' type: object FlowSigner: properties: org_third_party_user_id: description: 创建流程时指定的企业唯一标识,仅签署主体为企业时返回 example: tgxxteck type: string sign_status: description: "签署状态:0-待签, 1-未签, 2-已签 3-待审批 4-拒签" example: 1 type: integer signer_account_type: description: "签署主体类型:0-个人, 1-企业" example: 1 type: integer third_party_user_id: description: 创建流程时指定个人唯一标识 example: "234440881029245" type: string type: object ForbbidenTime: properties: days: 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" type: string type: object FulfillmentDetail: properties: fulfillment_amount: description: 履约金额 example: "80.00" type: string gmt_payment: description: 履约支付时间 example: 2021-03-17 09:45:57 type: string out_request_no: description: 商户发起履约请求时,传入的out_request_no,标识一次请求的唯一id example: "20200320010101001" type: string type: object Function: properties: id: description: 功能点id example: "12" type: string name: description: 功能点名称 example: 流程-处理 type: string type: object FunctionalService: properties: content: description: 功能内容 type: string ext_info: description: 扩展信息 items: $ref: '#/components/schemas/OrderExtInfo' type: array function_code: description: "功能码\t支持的功能码请与产品或对应技术确认" type: string function_name: description: 功能名称 type: string function_type: description: 功能类型 type: string function_url: description: 功能入口 type: string memo: description: 备注信息 type: string type: object FundExtInfo: properties: fund_identity: description: "出资主体账号,fund_identity_type是ALIPAY_USER_ID填支付宝会员ID(2088开头);\t\ 是ALIPAY_LOGON_ID 填支付宝登录号" type: string fund_identity_type: description: 出资主体账号类型,目前支持如下类型: 1、ALIPAY_USER_ID 支付宝的会员ID 2、ALIPAY_LOGON_ID:支付宝登录号,支持邮箱和手机号格式 type: string type: object Gavintest: properties: newid: description: 测试 example: 1 type: integer type: object GavintestNewLeveaOne: properties: boolen: description: "2" type: boolean ces: description: "21" items: type: integer type: array des: description: "12" type: string str: description: "1" items: type: string type: array type: object GavintestNewonline: properties: dem: description: "1" example: "21" items: type: string type: array string: $ref: '#/components/schemas/GavintestNewLeveaOne' type: object GoodsDetail: properties: alipay_goods_id: description: 支付宝定义的统一商品编号 type: string body: description: 商品描述信息 type: string categories_tree: description: 商品类目树,从商品类目根节点到叶子节点的类目id组成,类目id值使用|分割 type: string goods_category: description: 商品类目 type: string goods_id: description: "商品的编号,该参数传入支付券上绑定商品goods_id,\t倘若无支付券需要消费,该字段传入商品最小粒度的商品ID(\ 如:若商品有sku粒度,则传商户sku粒度的ID)" type: string goods_name: description: 商品名称 type: string out_item_id: description: 商家侧小程序商品ID,指商家提报给小程序商品库的商品。当前接口的extend_params.trade_component_order_id字段不为空时该字段必填,且与交易组件订单参数保持一致。了解小程序商品请参考:小程序商品 type: string out_sku_id: description: 商家侧小程序商品ID,指商家提报给小程序商品库的商品。当前接口的extend_params.trade_component_order_id字段不为空时该字段必填,且与交易组件订单参数保持一致。了解小程序商品请参考:小程序商品 type: string price: description: 商品单价,单位为元 type: string quantity: description: 商品数量 type: integer show_url: description: 商品的展示地址 type: string type: object GoodsDetailDTO: properties: goods_id: description: 商品编号 example: apple-01 type: string goods_name: description: 商品名称 example: ipad type: string price: description: "商品单价。单位 元\t\t精确到小数点后2位。" example: "2000.00" type: string quantity: description: 商品数量 example: 1 type: integer type: object GoodsDetailIstd: properties: count: description: 商品数量 type: integer name: description: 商品名称 type: string price: description: 商品单价 type: string unit: description: 商品单位 type: string type: object GoodsInfo: properties: goods_category: description: 商品类目 example: "201701000" type: string goods_id: description: 商户自定义商品外部编号 example: apple-01 type: string goods_name: description: 商户自定义商品名称 example: 苹果手机 type: string price: description: "商品单价,单位元,精确到小数点后两位,取值范围[0.01,100000000]" example: "10.00" type: string quantity: description: "商品数量,支持小数,但是小数位不能超过两位" example: "2" type: string type: object GoodsInfoDTO: properties: goods_amount: description: 商品金额 example: "52.10" type: string goods_count: description: 商品购买数量 example: "3" type: string goods_id: description: 商品标准69码 example: "69212" type: string goods_name: description: 商品名称 example: 元气森林 type: string type: object GoodsInfoIstd: properties: delivery_info: description: 交货信息,用于骑手交付商品 type: string first_class: description: 一级品类类目 type: string height: description: 商品高度,单位为cm type: integer length: description: 商品长度,单位为cm type: integer pickup_info: description: 取货信息,用于骑手到店取货 type: string price: description: 总价 type: string second_class: description: 二级品类类目 type: string weight: description: 货物重量,单位为kg,精确到小数点后两位 type: string width: description: 商品宽度,单位为cm type: integer type: object GoodsOrder: properties: goods_name: description: 商品名称 example: 午饭套餐 type: string goods_picture_id: description: 商品图片素材Id example: "2019010100502200000000000001" type: string type: object GoodsQueryResponse: properties: alipay_goods_id: description: 支付宝内部商品唯一标识 example: "2022090400014220" type: string buying_url: description: 该商品的小程序购买链接 example: alipays://platformapi/startapp?appId= 2017072607907880&page=pages/index/index?param=xxxx type: string goods_comment: description: 商品辅助说明文案 example: 这是一个商品辅助说明文案 type: string goods_description_label: description: 商品说明标签(如-随心退) example: 随心退 type: string goods_id: description: 商品的唯一标识,同一个小部件下,该标识唯一,请开发者自行保证 example: "8948968498" type: string goods_label: description: 营销标签(如-限量特价),每个商品仅支持一个营销标签 example: 限量特价 type: string goods_name: description: 商品名称 example: 这是一个商品名称 type: string goods_type: description: 商品所属品类 example: 服装 type: string main_pic_url: description: 商品主图片地址 example: https://xxx.xxx.com/xxx.jpg type: string mini_app_id: description: 小程序ID example: "2017072607907880" type: string order_number: description: "商品排序,自然整数, 数字越小越靠前" example: "1" type: string original_price: description: 单位"元"的商品原价,传入数字,不需要传入"元" example: "88.88" type: string pid: description: 品的售卖商家,即承接该品的小程序背后的商家。和mini_app_id要求对应 example: 2088xxxxxxxxx type: string publish_cities: description: "投放城市的列表,详见https://www.mca.gov.cn/article/sj/xzqh/2020/2020/202007170301.html,\ 有多个用英文,分隔。如果没有限制则不传入" example: "110000" type: string remaining_quantity: description: 剩余库存 example: 999 type: integer sell_price: description: 单位"元"的售价,传入数字,不需要传入"元" example: "66.66" type: string sold_quantity: description: 已售数量 example: 1 type: integer total_quantity: description: 总库存量 example: "1000" type: string type: object HSchoolInfo: properties: campus_no: description: 学号 example: "2019021208" type: string school_std_code: description: 学校外标 example: "4136013432" type: string type: object HbFqPayInfo: properties: fq_amount: description: 用户使用花呗分期支付的金额数。单位:元。 example: "10.05" type: string user_install_num: description: 用户使用花呗分期支付的分期数 example: "3" type: string type: object HolidayRuleInfo: properties: time_range_info: $ref: '#/components/schemas/TimeRangeInfo' type: object IdentityVerifiedInfoDTO: properties: cert_no: description: MD5加密处理后的证件号 example: D61DCDD393C885BBA0091B7B57A71208 type: string cert_type: description: 证件类型。暂仅支持 IDENTITY_CARD (身份证) example: IDENTITY_CARD type: string user_name: description: 用户的真实姓名 example: 张三 type: string type: object Image: properties: url: description: 图片url,请先调用alipay.offline.material.image.upload 图片上传接口获得图片url example: http://example.com/abc.jpg type: string type: object IndirectAuthOrderFailedReason: properties: fail_param: description: 审核失败字段 example: support_credentials type: string fail_reason: description: 描述申请单审核失败原因 example: 证照编号对应的企业名称、法人名称与录入信息不一致 type: string type: object IndirectBenefitPersonInfo: properties: card_back_img: description: 受益人证件反面照(使用图片上传接口的image_id)。当证件类型为身份证时,此字段必传;当证件类型为非身份证时,此字段非必传。 example: a5d373f6-3e79-405f-9993-fb7ea051c372.jpg type: string card_front_img: description: 受益人证件正面照(使用图片上传接口的image_id) example: a5d373f6-3e79-405f-9993-fb7ea051c372.jpg type: string card_no: description: 证件号码 example: "233330199001010001" type: string card_type: description: 证件类型,枚举值:中国大陆居民-身份证(RESIDENT)、其他国家或地区居民-护照(PASSPORT)、中国港澳居民-来往内地通行证(PASSPORT_HK_MO)、中国台湾居民-来往大陆通行证(PASSPORT_TWN)、港澳居民居住证(RESIDENCE_PERMIT_HM)、台湾居民居住证(RESIDENCE_PERMIT_TW)、外国人永久居住证(PERMANENT_RESIDENCE_FOREIGNER)。个体户/企业/事业单位/社会组织:可选择任一证件类型,政府机关、小微商户仅支持身份证类型。 example: RESIDENT type: string effect_time: description: 证件生效时间 example: 1999-01-01 type: string expire_time: description: 证件过期时间 example: 2000-11-01,长期有效时传“forever” type: string person_name: description: 受益人姓名 example: 张三 type: string type: object IndirectCertificateInfo: properties: cert_image: description: 证照图片(使用图片上传接口) example: a5d373f6-3e79-405f-9993-fb7ea051c372.jpg type: string cert_no: description: 证件编号 example: "0000001" type: string cert_type: 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 type: string effect_time: description: 证照生效时间 example: 1999-01-01 type: string expire_time: description: 证照过期时间 example: 2020-11-01,长期有效时传“forever” type: string legal_person_name: description: 证照法人姓名 example: 李四 type: string merchant_name: description: 证照商户名称 example: 新新饭店 type: string register_address: description: 证照注册地址 example: 浙江省杭州市西湖区xxx街道xxx门牌号 type: string type: object IndirectContactPersonInfo: properties: contact_card_no: description: "联系人身份证件号。\t可传身份证、港澳居民来往内地通行证、港澳居民居住证、台湾居民来往大陆通行证、台湾居民居住证、护\ 照、外国人永久居住证等证件号码,号码枚举见contact_card_type。若传身份证,需保证18位,且英文字母大写" example: "233330199001010001" type: string contact_cert_type: description: 联系人证件类型,枚举值:中国大陆居民-身份证(RESIDENT)、其他国家或地区居民-护照(PASSPORT)、中国港澳居民-来往内地通行证(PASSPORT_HK_MO)、中国台湾居民-来往大陆通行证(PASSPORT_TWN)、港澳居民居住证(RESIDENCE_PERMIT_HM)、台湾居民居住证(RESIDENCE_PERMIT_TW)、外国人永久居住证(PERMANENT_RESIDENCE_FOREIGNER)。个体户/企业/事业单位/社会组织:可选择任一证件类型。小微商户仅支持身份证类型。 example: RESIDENT type: string contact_name: description: 联系人姓名 example: 张三 type: string contact_phone_no: description: 联系人手机 example: "19999999999" type: string type: object IndirectExtraCredentials: properties: smid_list: description: 待确认商户号列表,最多20个 example: "[\"2088000000000001\"]" items: type: string type: array type: object IndirectFinancialOrgInfo: properties: financial_org_cert_img: description: 金融机构许可证图片,最多五张(使用图片上传接口) example: "[\"a5d373f6-3e79-405f-9993-fb7ea051c372.jpg\"]" items: type: string type: array financial_org_type: description: 银行业(BANK)、支付机构(PAYMENT)、保险业(INSURANCE)、交易及结算类金融机构(SETTLE)、OTHER(OTHER) example: PAYMENT type: string type: object IndirectLegalPersonInfo: properties: auth_letter_img: description: 授权函照片(使用图片上传接口),当证件持有人类型为 经办人时,必须上传。其他情况,无需上传 example: a5d373f6-3e79-405f-9993-fb7ea051c372.jpg type: string card_back_img: description: 法人/经营者证件反面照(使用图片上传接口的image_id)。当证件类型为身份证时,此字段必传;当证件类型为非身份证时,此字段非必传。 example: a5d373f6-3e79-405f-9993-fb7ea051c372.jpg type: string card_front_img: description: 法人/经营者证件正面照(使用图片上传接口返回的image_id) example: a5d373f6-3e79-405f-9993-fb7ea051c372.jpg type: string card_no: description: 证件号码 example: "233330199001010001" type: string card_type: description: 证件类型,枚举值:中国大陆居民-身份证(RESIDENT)、其他国家或地区居民-护照(PASSPORT)、中国港澳居民-来往内地通行证(PASSPORT_HK_MO)、中国台湾居民-来往大陆通行证(PASSPORT_TWN)、港澳居民居住证(RESIDENCE_PERMIT_HM)、台湾居民居住证(RESIDENCE_PERMIT_TW)、外国人永久居住证(PERMANENT_RESIDENCE_FOREIGNER)。个体户/企业/事业单位/社会组织:可选择任一证件类型,政府机关、小微商户仅支持身份证类型。 example: RESIDENT type: string effect_time: description: 证件生效时间 example: 1999-01-01 type: string expire_time: description: 证件过期时间 example: 2000-11-01,长期有效时传“forever” type: string is_benefit_person: description: 经营者/法人是否为受益人 example: true type: boolean legal_type: description: "证件持有人类型:\t- 法人 LEGAL_PERSON\t- 经办人 AGENT_PERSON\t主体类型为政府\ 机关、事业单位时选传:\t(1)若上传的是法人证件,则不需要上传该字段。\t(2)若因特殊情况,无法提供法人证件时,可上传经办人。\t主体类\ 型为企业、个体户、社会组织、小微商户时,默认为经营者/法人,不需要上传该字段。" example: LEGAL_PERSON type: string person_name: description: 法人姓名 example: 李四 type: string type: object IndirectQualificationInfo: properties: image_list: description: 行业经营许可证资质照片,一个行业类目下最多上传6张资质照片(使用图片上传接口) example: "[\"a5d373f6-3e79-405f-9993-fb7ea051c372.jpg\"]" items: type: string type: array mcc_code: description: 行业类目编号,支付宝商家行业二级类目code example: B0001 type: string type: object IndirectSupportCredentials: properties: city: description: 门店城市 example: 杭州市 type: string city_code: description: 门店市行政区号(数字) example: "3310303" type: string district: description: 门店街道 example: 西湖区留下街道 type: string district_code: description: 门店街道区号(数字) example: "3301000" type: string merchant_type: description: 小微商户经营类型,枚举值:门店场所(STORE)、流动经营(STALL) example: STORE type: string province: description: 门店省份 example: 浙江省 type: string province_code: description: 门店省行政区号(数字 example: "330100" type: string store_address: description: 门店场所填写门店详细地址,流动经营类型填“无” example: xxx街道xxx门牌号 type: string store_door_img: description: 门店门头照信息或摊位照(使用图片上传接口) example: a5d373f6-3e79-405f-9993-fb7ea051c372.jpg type: string store_inner_img: description: 门店店内照片或者摊位照侧面(使用图片上传接口) example: a5d373f6-3e79-405f-9993-fb7ea051c372.jpg type: string store_name: description: 门店名称 example: 新新饭店 type: string type: object IndustryQualificationInfo: properties: industry_qualification_image: description: 商户行业资质图片。其值为通过ant.merchant.expand.indirect.image.upload上传图片得到的image_id type: string industry_qualification_type: description: 商户行业资质类型,具体选值参见文档 type: string type: object Instance: properties: create_time: description: ?创建时间 example: 2020-11-10 21:07:00 type: string creator_id: description: 创建人id example: "2018051101015016" type: string description: description: 部门描述 example: 我是描述信息 type: string external_id: description: 外部id example: "939459821" type: string id: description: 部门id(即租户实例ID、数据权限ID) example: pYv_gs0m type: string name: description: 租户实例(数据权限)名称 example: XXX租户实例 type: string status: description: 租户实例(数据权限)状态,所有可能的状态如下:INIT(初始化)、STARTED(准备完成)、START_FAILED(准备失败)、STOPPING(停用中)、STOPPED(已停用)、RELEASING(释放中)、RELEASED(已释放)、RESUMING(重新启动)、MODIFING(修改规格中)、DELETED(已删除)。 example: STARTED type: string update_time: description: 最后修改时间 example: 2020-11-10 21:11:00 type: string updater_id: description: 最后修改人id example: "2018051101015016" type: string type: object InstitutionBasicInfo: properties: consult_mode: description: 费控咨询模式 example: "0" type: string effective: description: 制度是否启用 example: "1" type: string effective_end_date: description: 制度生效结束时间 example: 2023-07-05 23:59:59 type: string effective_start_date: description: 制度生效起始时间 example: 2022-07-04 00:00:00 type: string institution_desc: description: 制度描述 example: 工作餐制度 type: string institution_id: description: 制度id example: "2023042600152617860000076000" type: string institution_name: description: 制度名称 example: 餐补制度 type: string type: object IntactChargeInfo: properties: actual_amount: description: 实际收费金额,单位元 example: "0.01" type: string bill_type: description: 收费类型 example: "1" type: string gmt_pay: description: "收费时间,时间精确到秒" example: 2023-05-16 22:22:22 type: string is_refund: description: 是否退费 example: true type: boolean out_biz_no: description: 外部请求号 example: "2323232323" type: string plan_amount: description: 应收费金额,单位元 example: "0.02" type: string product_name: description: 收费产品 example: ALI_ESCROW type: string service_target: description: 收费唯一id example: "2023232" type: string service_type: description: 收费类型 example: TRADE type: string status: description: 状态 example: "1" type: string target_account_no: description: 收费目标账号 example: "20880156" type: string target_user_id: description: 收费目标uid example: "2088" type: string type: object InteligentBudgetInfo: properties: budget_total: description: 预算数量 example: "999999" type: string budget_type: description: 预算类型,枚举(QUANTITY:数量预算) example: QUANTITY type: string type: object InteligentClauseTerm: properties: descriptions: description: 说明描述内容 example: 说明描述内容 items: type: string type: array title: description: 说明title example: 说明title type: string type: object InteligentConstraintInfo: properties: crowd_group_id: description: 人群组id,目前只支持返回时带出。 example: "34324224" type: string item_ids: description: "单品码列表\r\t仅在创建消费单品送活动时设置,最多设置500个单品码,由商户根据自己的商品管理自定义,一般为国标码" example: "212313,221322" type: string min_cost: description: "最低消费金额,单位元\r\t仅在创建消费送礼包活动时设置" example: "100" type: string suit_shops: description: "活动适用的门店列表\r\t仅品牌商发起的招商活动可为空\r\t最多支持10w家门店" example: "2015110600077000000002125023,2015110600077000000002125022" items: type: string type: array user_win_count: description: "活动期间用户能够参与的次数限制\r\t如果不设置则不限制参与次数" example: "1" type: string user_win_frequency: description: "活动期间用户能够参与的频率限制\r\t如果不设置则不限制参与频率\r\t每日中奖1次: D||1 \r\t每周中奖\ 2次: W||2 \r\t每月中奖3次: M||3" example: D||3 type: string type: object InteligentDataCondition: properties: data_type: description: 数据类型,支持枚举:文本:STRING;数值:NUMBER;长整型:LONG;浮点型:DOUBLE;日期:DATE;布尔:BOOLEAN;金额:MONEY example: NUMBER type: string limit_type: description: 数据限制类型,支持枚举:固定值:FIX;单选值:SELECT;区间值:RANGE; example: RANGE type: string value: description: "数据格式值;如:范围值:(1,10),固定值:1" example: "(1,10)" type: string type: object InteligentDelayInfo: properties: type: description: "延迟类型,目前支持以下类型\r\tABSOLUTELY:按绝对值延迟\r\tBYDAY:按天延迟" example: ABSOLUTELY type: string value: 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" type: string type: object InteligentDisplayConfig: properties: slogan: description: "券的宣传语\r\t含圈人的直领活动,且投放渠道选择了支付成功页或店铺的情况下必填" example: 券的宣传语 type: string slogan_img: description: "券的宣传图片文件ID\r\t含圈人的直领活动,且投放渠道选择了店铺的情况下必填" example: 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC type: string type: object InteligentForbiddenTime: properties: days: 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" type: string type: object InteligentGeneralMerchantPromo: properties: camp_id: description: 营销活动的id,如merchant_promo_type:CONSUME_SEND即消费送的活动id example: "20170901000000000006913911002170" type: string crowd_constraint: $ref: '#/components/schemas/CrowdConstraintInfo' desc: description: 活动描述信息,该信息有可能会在店铺详情页漏出,请自己填写 example: 本店酒水不参与该活动 type: string ext_info: description: 活动扩展信息 example: "{\\\"key\\\":\\\"value\\\"}" type: string forecast_effect: $ref: '#/components/schemas/IntelligentPromoEffect' inteligent_budget: $ref: '#/components/schemas/InteligentBudgetInfo' inteligent_constraint: $ref: '#/components/schemas/InteligentConstraintInfo' inteligent_promo_tools: description: 营销工具集合。主要是活动涉及到的奖品信息 items: $ref: '#/components/schemas/InteligentPromoTool' type: array inteligent_publish_channels: description: 投放渠道信息 items: $ref: '#/components/schemas/InteligentPublishChannel' type: array merchant_promo_type: description: 营销活动类型;枚举(DIRECT_SEND:直发奖;CONSUME_SEND:消费送) example: CONSUME_SEND type: string name: description: 营销活动名称 example: 消费满100送20元代金券 type: string template_id: description: 子营销活动对应的模板id example: "20170909000000000012931911002490" type: string type: object InteligentItemInfo: properties: item_ids: description: "券适用的单品码列表\r\t最少配置1个单品码\r\t最多配置500个单品码" example: "0000123,0000124" items: type: string type: array item_imgs: description: "单品图片列表\r\t单品图片不能超过3张" example: 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC items: type: string type: array item_link: description: 单品券详细介绍跳转链接 example: www.taobao.com type: string item_name: description: 单品名称 example: 单品名称 type: string item_text: description: 单品券说明 example: 单品券说明 type: string max_discount_num: description: "单品券适用的商品列表中,每一个商品最高可享受优惠的件数; \r\t如:券适用于A,B两种商品,该字段设置为1,则用\ 券A,B两种商品每种最多只有一件可享受优惠;" example: "1" type: string min_consume_num: description: "单品券适用商品列表中,每种商品享受优惠最低购买件数的门槛;\r\t如:券适用于A,B两种商品,该字段设置为3,则A,B两\ 种商品每种最少需要购买3件才可享受优惠;" example: "1" type: string original_price: description: "单品的原价,单位元\r\t必须为合法金额类型字符串,如9.99" example: "28.88" type: string sku_min_consume: description: "券适用SKU的最低消费金额门槛\r\t如券适用A,B两个SKU,该字段设置的值为100,则订单中购买A,B两个SKU的\ 合计金额需大于100元才可用券" example: "10" type: string total_max_discount_num: description: 如果一个单品券适用A,B,C三个单品,若设置了该字段为2,则在一笔交易中,A,B,C三个单品加起来最多只有俩件能够享受优惠 example: "10" type: string type: object InteligentMerchantPromo: properties: general_promo: $ref: '#/components/schemas/InteligentGeneralMerchantPromo' promo_type: description: 子活动营销类型;枚举值:(GENERAL_MERCHANT:商户自运营活动) example: GENERAL_MERCHANT type: string type: object InteligentPromoTool: properties: inteligent_send_rule: $ref: '#/components/schemas/InteligentSendRule' inteligent_voucher: $ref: '#/components/schemas/InteligentVoucher' status: description: 单个营销工具的生效状态,当在招商部分券失效后会使用这个字段 example: STARTED type: string voucher_no: description: "营销工具uid,创建营销活动时无需设置" example: "2342343245234234" type: string type: object InteligentPublishChannel: properties: config: description: "当type为MERCHANT_CROWD时,config需填入口令送的密码和图片,样例如下:\"config\":\"\ {\\\"PASSWORD\\\":\\\"口令送密码\\\",\\\"BACKGROUND_LOGO\\\":\\\"1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC\\\ \"}\"" example: "\"PASSWORD\":\"口令送密码\",\"BACKGROUND_LOGO\":\"1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC\"" type: string ext_info: description: 扩展信息,无需配置 example: '"key":"value"' type: string name: description: 渠道名称 example: 投放到店铺 type: string type: description: "渠道类型,目前支持以下类型:\r\tQR_CODE:二维码投放;\r\tSHORT_LINK:短连接投放;\r\t\ SHOP_DETAIL:店铺页投放;\r\tPAYMENT_RESULT:支付成功页;\r\tMERCHANT_CROWD:口令送;\r\t\ URL_WITH_TOKEN:外部发奖活动,\r\t只有活动类型为DIRECT_SEND时才支持;" example: SHOP_DETAIL type: string type: object InteligentSendRule: properties: allow_repeat_send: description: "是否允许重复发奖:\r\ttrue代表允许,false代表不允许\r\t默认不设置,表明用户领取券后如果没有核销则不\ 允许再次领取券\r\t如果设置为true,表明如果用户领取券后没有核销,还可以继续领取该券" example: "true" type: string min_cost: description: "发券最低消费金额,单位元\r\t活动类型为消费送且不是消费送礼包时设置\r\t多营销工具之间不允许设置重复值" example: "100" type: string send_budget: description: 券的预算数量(仅对口令送随机抽奖有效,即当活动类型为GUESS_SEND,且营销工具PromoTool的个数大于1时,此字段必填,其余情况此字段必为空) example: "1234" type: string send_num: description: "发券数目\r\t最少发1张券,最多发5张券" example: "1" type: string type: object InteligentUseRule: properties: inteligent_forbidden_time: $ref: '#/components/schemas/InteligentForbiddenTime' inteligent_use_times: description: 券可用时间段 items: $ref: '#/components/schemas/InteligentUseTime' type: array limit_rule: 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 type: string min_consume: description: 券核销的最低消费门槛,单位元 example: "10" type: string min_consume_condition: $ref: '#/components/schemas/InteligentDataCondition' pay_redirect_url: description: 券买单跳转链接 example: https://mycar-parkingplatform.alipay-eco.com/pbizplatform/park/parking/stayPayCarList?entrance=1 type: string suit_shops: description: "券适用门店列表\r\t仅品牌商发起的招商活动可为空\r\t直发奖类型活动必须与活动适用门店一致\r\t最多支持10w家\ 门店" example: "2015110600077000000002125023,2015110600077000000002125022" items: type: string type: array type: object InteligentUseTime: properties: dimension: description: 券可用时段时间维度,目前支持周(W) example: W type: string times: 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" type: string values: description: "券可用时间维度值\r\t周维度的取值范围1-7(周一至周日),多个可用时段用逗号分隔\r\t如\"1,3,5\",对\ 应周一,周三,周五可用" example: "1,3,5" type: string type: object InteligentVoucher: properties: brand_name: description: 品牌名称 example: 品牌名称 type: string desc: description: "券详细说明\r\t最多包含500个字符" example: 券的详细说明 type: string donate_flag: description: 券是否可转赠,默认为可转赠 example: "true" type: string effect_type: description: "券生效的方式,目前支持以下方式\r\t立即生效:IMMEDIATELY\r\t延迟生效:DELAY\r\t仅在券有效\ 期类型为相对有效期时生效" example: IMMEDIATELY type: string end_time: description: "券有效期的结束时间\r\t仅在券有效期类型为绝对有效期时生效\r\t必须晚于活动结束时间" example: 2016-11-01 00:00:00 type: string ext_info: description: 券的扩展信息 example: '"key":"value"' type: string inteligent_clause_terms: description: 券的说明条款 items: $ref: '#/components/schemas/InteligentClauseTerm' type: array inteligent_delay_info: $ref: '#/components/schemas/InteligentDelayInfo' inteligent_desc_detail_list: description: 券使用说明描述列表 items: $ref: '#/components/schemas/InteligentVoucherDescDetail' type: array inteligent_display_config: $ref: '#/components/schemas/InteligentDisplayConfig' inteligent_item_info: $ref: '#/components/schemas/InteligentItemInfo' inteligent_use_rule: $ref: '#/components/schemas/InteligentUseRule' logo: description: 券LOGO文件ID,调用图片上传接口alipay.offline.material.image.upload获得 example: 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC type: string max_amount: description: "最高优惠金额,单位元\r\t指用券最高可以优惠的金额\r\t必须为合法金额类型字符串仅当券类型为折扣券(RATE),\ 每满减券(PER_FULL_CUT)有效" example: "100" type: string multi_use_mode: description: "券叠加的属性,\r\t仅全场券可设置该选项;\r\tNO_MULTI:不可与其他全场券和单品券叠加;\r\tMULTI_USE_WITH_SINGLE:\r\ \t该全场优惠和单品优惠的叠加\r\t;MULTI_USE_WITH_OTHE\r\tRS:该全场优惠和其他所有优惠都可以叠加" example: NO_MULTI type: string name: description: 券名称 example: 5元代金券 type: string rate: description: "折扣率\r\t仅当券类型为折扣券时有效\r\t有效折扣率取值范围0.11-0.99\r\t仅允许保留小数点后两位" example: "0.8" type: string relative_time: description: "券相对有效期,单位天\r\t仅在券有效期类型为相对有效期时生效\r\t如,设5表示领券领取后5日内有效" example: "1" type: string rounding_rule: 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 type: string start_time: description: "券有效期的开始时间\r\t仅在券有效期类型为绝对有效期时生效" example: 2016-05-01 00:00:00 type: string type: description: "券类型,目前支持以下类型:\r\tMONEY:代金券;\r\tPER_FULL_CUT:每满减券" example: MONEY type: string use_instructions: description: "券的使用说明\r\t使用须知最多6条,且每条最多100字" example: 券的使用说明 items: type: string type: array validate_type: description: "券有效期类型,目前支持以下类型:\r\tRELATIVE:相对有效期\r\tFIXED:绝对有效期" example: FIXED type: string verify_mode: description: "该字段仅在兑换券条件下(即券类型为EXCHANGE),用于设置兑换券的核销方式\r\tUSER_CLICK:用户自己\ 点击券上的按钮核销\r\tMERCHANT_SCAN:商户通过APP扫码核销\r\t其他情况下此字段为空" example: MERCHANT_SCAN type: string voucher_img: description: "券图片文件ID,调用上传图片接口alipay.offline.material.image.upload获得" example: 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC type: string voucher_note: description: "券的备注\r\t\r\t用于收银系统识别指定券使用;如备注中传入“123”,券发出后核销时将在当面付接口将该值传回,\ 供收银系统识别" example: 券的备注 type: string worth_value: description: "券面额,单位元必须为合法金额类型字符串券类型为代金券(MONEY)、减至券(REDUCETO)、每满减券(PER_FULL_CUT)\ 时必填\r\t如:\r\t代金券:10元代金券中的10为券面额;\r\t每满减券:毎满100减10元,其中的10为券面额;\r\t减至券:单\ 品原价100,现价10元,其中10为券面额,单品减至券的券面额必须低于单品原价" example: "10" type: string type: object InteligentVoucherDescDetail: properties: details: description: 具体描述信息列表 example: 周一到周五可用 type: string images: description: 图片描述信息 example: https://dl.django.t.taobao.com/rest/1.0/image?fileIds=RY7twkJVR26nz8OeXRIjvAAAACMAAQED&zoom=original type: string title: description: 券说明的标题 example: 温馨提示 type: string url: description: 券外部详情描述 example: www.alipay.com type: string type: object IntelligentPromo: properties: allow_auto_delay: description: 是否允许自动续期 example: true type: boolean audit_status: description: 审批状态。APPROVING:审批中;REJECTED:已驳回;PASS:已通过;(注意:修改接口无需传递审批状态) example: APPROVING type: string create_request_no: description: 请求幂等控制请求参数,该参数尽量比较复杂,建议使用uuid,否则触发幂等返回。 example: 7582ee4522934431bd45ae68616744b6 type: string creator_info: $ref: '#/components/schemas/PromoOperatorInfo' desc: description: 智能活动描述 example: 这是一个全场智能营销活动,仅在上海地区使用 type: string ext_info: description: 活动扩展信息,通过《koubei.marketing.campaign.intelligent.promo.consult智能方案咨询接口》推荐出的方案扩展信息字段,调用《koubei.marketing.campaign.intelligent.promo.create创建智能方案》接口必须要原路带回,不能删减字段。 example: "{\\\"PARTNER_CATEGORY\\\":\\\"2015050700000002\\\",\\\"PROMO_REC_LOG\\\ \":\\\"20170919000000000195431911009130\\\"}" type: string forecast_effect: $ref: '#/components/schemas/IntelligentPromoEffect' gmt_closed: description: 智能营销活动下架的时间 example: 2016-05-01 00:00:00 type: string gmt_enabled: description: 智能营销活动的生效时间 example: 2016-05-01 00:00:00 type: string gmt_end: description: 智能营销活动的结束时间 example: 2016-05-01 00:00:00 type: string gmt_start: description: 智能营销活动开始时间 example: 2016-05-01 00:00:00 type: string merchant_promos: description: 智能营销商户子活动列表 items: $ref: '#/components/schemas/InteligentMerchantPromo' type: array name: description: 智能营销活动对应的名称 example: 全场智能营销活动 type: string owner_info: $ref: '#/components/schemas/PromoOperatorInfo' parent_promo_id: description: 智能营销方案父id,如果需要续签智能营销活动,则会对于原有智能营销方案的id example: "20171001000000000286566911004880" type: string plan_id: description: 智能营销活动对应的方案编号 example: "20170901000000000007027911001170" type: string promo_id: description: 智能营销方案id。《koubei.marketing.campaign.intelligent.promo.create》创建接口中这个参数不必传递,仅在查询接口中返回 example: "20170905000000000092980911009880" type: string promos: description: 营销活动详情列表,注意:(该参数20180125开始已不在维护,替代参数详见merchant_promos,如需接入替代参数,接之前先找开发负责人申请appid白名单) items: $ref: '#/components/schemas/IntelligentPromoDetail' type: array status: description: 智能营销活动状态。CREATED:已创建;ENABLED:已生效;CLOSED:已关闭;FINISHED:已完结;DISABLED:已失效(有两种情况会是失效状态,一种是服务商创建方案,商户驳回,一种是服务商创建方案,商户未确认,活动到期。)(注意:修改方案的动作不需要传递方案状态) example: CREATED type: string sub_promo_ids: description: 该智能营销方案如果续签多次,则会返回该方案对应的所有智能营销子方案的promo_id example: "[2016110700077000000003446037, 2016111000077000000003446529]" items: type: string type: array sub_status: 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 type: string template_id: description: 智能营销活动对应的方案中的模板编号 example: "20170901000000000006914911002170" type: string type: description: 智能活动类型,值如下:RECOMMENDATION:系统推荐;REGISTRATION:报名。在创建时,这个字段需要ISV自己进行决策,在推荐接口会返回优惠力度,比如代金券面额等信息,ISV判断如果优惠力度比这个大或者相同,就用RECOMMENDATION,其他情况用REGISTRATION,如推荐力度大于实际创建传过来的优惠力度,则创建的时候系统会自动将RECOMMENDATION改为REGISTRATION example: RECOMMENDATION type: string type: object IntelligentPromoDetail: properties: budget: $ref: '#/components/schemas/BudgetInfo' camp_id: description: 营销活动的id,也就是消费送的活动id example: "20170901000000000006913911002170" type: string constraint: $ref: '#/components/schemas/ConstraintInfo' crowd_constraint: $ref: '#/components/schemas/CrowdConstraintInfo' desc: description: 智能营销活动的子活动 example: 这是一个全场消费送的活动 type: string ext_info: description: 活动扩展信息 example: "{\\\"key\\\":\\\"value\\\"}" type: string forecast_effect: $ref: '#/components/schemas/IntelligentPromoEffect' merchant_promo_type: description: 自运营活动类型。DIRECT_SEND:直发奖;CONSUME_SEND:消费送 example: DIRECT_SEND type: string name: description: 子营销活动名称 example: 全场消费送活动 type: string promo_tools: description: 营销工具集合。主要是活动涉及到的奖品信息 items: $ref: '#/components/schemas/PromoTool' type: array publish_channels: description: 投放渠道信息 items: $ref: '#/components/schemas/PublishChannel' type: array template_id: description: 子营销活动对应的模板id example: "20170901000000000006912911002170" type: string type: object IntelligentPromoEffect: properties: avg_prize_increase: description: 平均客单价提升比例 type: string cost: description: 成本 type: string current_total_amount: description: 当前效益 type: string effect_id: description: 营销活动的预期效果id type: string gmt_from: description: 时间范围左值 type: string gmt_to: description: 时间范围右值 type: string gmv: description: 成交额 type: string remain_stock_num: description: 剩余库存数 type: integer repay_rate_increase: description: 复购率提升比例 type: string send_count_increase: description: 发券量提升比例 type: string take_count: description: 发券数量 type: integer type: description: 营销活动效果类型。FORECAST:预估;STATISTICS:统计 type: string use_count: description: 核销量 type: integer type: object IntelligentPromoShopSummaryInfo: properties: shop_id: description: 门店id example: "20543566463464565" type: string shop_name: description: 全店名 example: 大娘水饺(万塘路店) type: string type: object InterfaceInfoList: properties: interface_name: description: "H5传入参数固定值:alipay.eco.mycar.parking.userpage.query;\t\t小程序传\ 入参数固定值:alipay.eco.mycar.parking.isv.homepage;\t\t协议状态变更通知传入参数固定值:\talipay.eco.mycar.parking.agreement.notify;" type: string interface_type: description: "H5、小程序传入参数固定值:interface_page;\t通知接口传入参数固定值:interface_service;" type: string interface_url: description: "H5 SPI接口的调用地址url,协议必须为https,对整个url字符串必须进行UrlEncode编码。编码为UTF-8;\t\ \t小程序SPI接口的调用地址ur格式:小程序|小程序缴费页面地址;\t\t协议状态变更通知SPI接口的调用地址url,同H5格式;" type: string type: object InviteMemberBusinessParamsDTO: properties: employee_id: description: 企业员工工卡 example: "983748293742" type: string fund_ext_info: $ref: '#/components/schemas/FundExtInfo' group_id_list: description: 员工关联的群组ID,当前系统仅支持一个 example: "[\"11\"]" items: type: string type: array type: object InviteResultDTO: properties: identity: description: "(被邀请人)用户唯一标识
\t补充说明:
\t- 该字段与签约接口alipay.fund.jointaccount.sign请\ 求参数中传入值保持一致" example: "2088000268032234" type: string identity_type: description: "(被邀请人)账号类型,参考值如下:
\t- OUT_USER_ID:商户侧用户唯一标识
\t补充说明:\t\ - 该字段与签约接口alipay.fund.jointaccount.sign请求参数中传入值保持一致" example: ALIPAY_USER_ID type: string process_id: description: 审批单号,不同被邀请人之间的审批单号不同(支付宝侧生成) example: "2021082066102300080000002126" type: string type: object Invoice: properties: email: description: 邮箱地址 example: 123@123.com type: string invoice_content: description: 发票内容,配送服务费 example: "40" type: string invoice_fee: description: 发票金额 example: "100" type: string invoice_title: description: 发票抬头,如支付宝(杭州)信息技术有限公司 example: 支付宝(杭州)信息技术有限公司 type: string invoice_type: description: 发票类型,0:默认电子发票 example: 0 type: integer phone: description: 手机号码 example: "15171008605" type: string receiver: description: 收件人姓名 example: 语轩 type: string tax_number: description: 税号 example: 9133 0106 MA27 Y4U4 7R type: string title_type: description: 抬头类型,0:企业单位,1:个人/非企业 example: 0 type: integer type: object InvoiceContentInfo: properties: amount: description: 含税金额(元) example: "200" type: string item_name: description: 发票项目名称/货物名称 example: 无 type: string item_no: description: 商品编码/税收分类编码 example: 无 type: string item_unit: description: 单位 example: 无 type: string price: description: 单价(元) example: "100" type: string quantity: description: 商品数量 example: "1" type: string row_type: description: 发票行性质。0表示正常行,1表示折扣行,2表示被折扣行 example: "0" type: string specification: description: 规格型号 example: 无 type: string sum_price: description: 不含税金额(元) example: "150" type: string tax: description: 税额 example: "40" type: string tax_rate: description: 税率 example: 无 type: string zero_rate_flag: description: 税率标识,只有税率为0的情况才有值,0=出口零税率,1=免税,2=不征收,3=普通零税率 example: "3" type: string type: object InvoiceElementModel: properties: expense_status: description: "发票报销状态\r\t取值范围:\r\tWAIT_EXPENSE-未报销\r\tEXPENSE_PROCESSING-\ 报销中\r\tEXPENSE_FINISHED-已报销" type: string extend_fields: description: 扩展字段 type: string fake_code: description: 防伪校验码 type: string has_pdf_file: description: 发票是否有pdf文件 type: boolean has_risk: description: "该发票可能存在异常,请核实后使用\r\ttrue:无异常\r\tfalse:存在异常" type: boolean invoice_amount: description: 发票金额,含税 type: string invoice_code: description: 发票代码 type: string invoice_date: description: 开票日期 type: string invoice_img_url: description: 发票pdf文件转换后jpg预览地址 type: string invoice_kind: description: "发票类型\t可选值\tPLAIN:增值税电子普通发票\tSPECIAL:增值税专用发票\tALL_ELECTRONIC_GENERAL:\ \ \"电子发票(普通发票)\tALL_ELECTRONIC_SPECIAL: \"电子发票(专用发票)\tPLAIN_INVOICE:增值\ 税普通发票\tPAPER_INVOICE:增值税普通发票(卷式)\tSALSE_INVOICE:机动车销售统一发票\t财政电子票据:FINANCIAL_ELECTRONIC_BILL" type: string invoice_no: description: 发票号码 type: string invoice_status: description: "发票状态 \r\t取值范围\r\tSUCCEED-正常蓝票\r\tEXPIRED-已失效" type: string isv_contact: description: 服务商联系方式 type: string isv_name: description: 服务商名称 type: string logo_url: description: logo地址 type: string m_name: description: 商户全称 type: string out_tax_amount: description: 发票金额,不含税 type: string payee_name: description: 销方名称 type: string payee_tax_no: description: 销方税号 type: string payer_name: description: 购方名称 type: string payer_tax_no: description: 购方税号 type: string pdf_url: description: PDF的下载链接 type: string source: description: 表示发票来源,由发票回传方带入。例如:bz_gd,bz_ele,bz_tmall等 type: string trade_list: description: 该发票对应的交易 items: $ref: '#/components/schemas/EinvTrade' type: array trade_match_result: description: "交易匹配结果\tmatch-匹配到\tnoMatched-未匹配到\tnotMatch-未做匹配" type: string type: object InvoiceElementStatusSyncOpenModel: properties: apply_id: description: 同步申请id,每次发起同步时生成,isv每次请求需要保证唯一 example: "2016112500152003000000000245" type: string expense_detail_url: description: "报销详情地址,提供用户通过发票管家查看报销进度的地址\r\t如果报销企业入驻发票管家时需要isv传入报销详情地址,则\ 必须提供" example: http://www.baidu.com type: string invoice_code: description: 发票代码 example: "031001600111" type: string invoice_no: description: 发票号码 example: "10001040" type: string type: object InvoiceItem: properties: amount: description: "含税总金额 (等于sum_price和tax之和),\t单位:元,格式为2位小数,精度2位小数" example: "1170.00" type: string item_name: description: 发票项目名称(或商品名称) example: 电视机 type: string item_no: description: 发票项目编号(或商品编号) example: "1010101010000000000" type: string price: description: "单价(不含税),格式为2位小数。最大支持6位小数,不足2位小数时需转化为2位小数格式。\t折扣行此参数不能传" example: "100.00" type: string quantity: description: "数量,须大于0,最多6位小数。\t折扣行此参数不能传" example: "10" type: string row_type: description: "发票行性质。0表示正常行,1表示折扣行,2表示被折扣行。\t比如充电器单价100元,折扣10元,则明细为2行,充电器\ 行性质为2,折扣行性质为1。如果充电器没有折扣,则值应为0。" example: 0 type: integer specification: description: 规格型号 example: X100 type: string sum_price: description: "不含税总金额,格式为2位小数\t单位:元,精度2位小数" example: "1000.00" type: string tax: description: "税额,\t格式为2位小数" example: "170.00" type: string tax_rate: description: "税率。格式为2位小数,如:0.00, 0.03, 0.13等等" example: "0.17" type: string unit: description: 单位,折扣行不能传 example: 台 type: string zero_rate_flag: description: 0税率标识,只有税率为0的情况才有值,0=出口零税率,1=免税,2=不征收,3=普通零税率 example: "1" type: string type: object InvoiceItemContent: properties: item_amount: description: 价税合计。(等于sumPrice和tax之和) type: string item_name: description: 发票项目名称(或商品名称) type: string item_no: description: 商品编号 type: string item_price: description: 单价,格式:100.00。新版电子发票,折扣行此参数不能传,非折扣行必传 type: string item_quantity: description: 数量。新版电子发票,折扣行此参数不能传,非折扣行必传 type: integer item_sum_price: description: 单项总价,格式:100.00 type: string item_tax_price: description: 税额 type: string item_tax_rate: description: 税率 type: string item_unit: description: 台 type: string row_type: description: 发票行性质。0表示正常行,1表示折扣行,2表示被折扣行。比如充电器单价100元,折扣10元,则明细为2行,充电器行性质为2,折扣行性质为1。如果充电器没有折扣,则值应为0 type: integer type: object InvoiceItemOpenModel: properties: item_ex_tax_amount: description: 明细行不含税金额,单位元,保留两位小数 type: string item_name: description: 开票项目:货物或应税劳务、服务名称 type: string item_no: description: 国税局制定的商品税收编码,必须是最末级 type: string item_quantity: description: "数量;\t1.当row_type=0或2且item_unit_price为空,可空;\t2.可精确到小数点后6位" type: integer item_spec: description: 规格型号 type: string item_sum_amount: description: 明细行价税合计,单位元,必须保证item_sum_amount=item_ex_tax_amount+item_tax_amount。 type: string item_tax_amount: description: 明细行税额,单位元,保留两位小数,无税或者免税情况下输入:0.00。 type: string item_tax_rate: description: 明细行税率,无税或者免税情况下输入:0.00。 type: string item_unit: description: 单位 type: string item_unit_price: description: "不含税单价(元);\t1.当row_type=0或2且item_quantity为空,可空\t2.可精确到小数点后\ 8位;" type: string row_type: description: 发票行性质:0表示正常行,1表示折扣行,2表示被折扣行。 type: string type: object InvoiceModelContent: properties: apply_id: description: 支付宝端的申请id。如果在开票过程中,是通过支付宝提交的申请到机构端,支付宝会带上开票申请在支付宝生成的申请id,机构在回传发票的时候只需要回传这个申请id,不用获取用户的uid,支付宝可以根据申请id将发票归集到对应的用户名下 example: "2016112800152005000000000239" type: string extend_fields: description: key=value,每组键值对以回车分割 example: "shortPlatform=POS\r\nabx=xxx\r\neee=ccc" type: string file_download_type: description: "下载的发票文件类型,可选值:\tpdf(发票原文件)\tofd(发票原文件)\tjpg(发票原文件缩略图)" example: pdf type: string file_download_url: 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 type: string financial_electronic_type: description: "财政电子票据子类型,当tax_type=FINANCIAL_ELECTRONIC_BILL时要求必填\t可选值如下:\ \t01:非税收入通用票据 \t02:非税收入专用票据\t03:非税收入一般缴款书\t04:资金往来结算票据\t05:公益事业捐赠票据\t\ 06:医疗收费票据\t07:社会团体会费票据\t08:社会保险基金票据\t09:工会经费收入票据\t99:其他财政票据" example: MEDICAL_ELECTRONIC_BILL type: string invoice_amount: description: "发票金额,大于0且精确到小数点两位,以元为单位\r\t需要传入税价合计金额" example: "200.00" type: string invoice_code: description: 发票代码,为国税局生成的唯一值,全电票时为空,其他情况不可为空 example: "2328742873" type: string invoice_content: description: 发票内容项 items: $ref: '#/components/schemas/InvoiceItemContent' type: array invoice_date: description: 发票日期,用户填写,目前精确到日 example: 2016-07-19 type: string invoice_fake_code: description: 发票防伪码 example: "-" type: string invoice_file_data: description: 原始发票PDF/OFD文件流 example: "01010010101" type: string invoice_img_url: description: 发票原始文件jpg文件地址 example: http://xxx.com type: string invoice_no: description: "发票号码,国税局生成的唯一号码,不可为空串;\r\t使用时请注意,invoice_no+invoice_code唯一\ ,不能重复" example: "237428768" type: string invoice_operator: description: 发票开具操作人 example: 张某某 type: string invoice_title: $ref: '#/components/schemas/InvoiceTitleModel' invoice_type: description: "发票类型,按照可选值只传入英文部分,该字段严格要求大小写\r\t可选值:\r\tblue(蓝票)\r\tred(红票\ )" example: blue type: string open_id: description: 支付宝用户id,支付宝端的申请id存在的时候也不需要传,其他情况下,当同步的是蓝票时,必传,红票时不需传。 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string original_blue_invoice_code: description: 仅用于同步红票,原始蓝票发票代码,同步红票时必传(全电票时为空) example: "2328742873" type: string original_blue_invoice_no: description: 仅用于同步红票,原始蓝票发票号码,同步红票时必传 example: "9288277173" type: string out_biz_no: description: "商户交易流水号,不可为空串;\r\t传入红票时请注意,此字段的值要和蓝票保持一致" example: "2016010139992003" type: string out_invoice_id: description: 商户唯一开票申请业务流水号,同一个isv下不能重复 example: "20160707399929991001" type: string register_address: description: 开票单位地址 example: 天目山路黄龙时代广场B座 type: string register_bank_account: description: 开票单位开户行账号 example: "6332000023949993" type: string register_bank_name: description: 开票单位开户行名称 example: 西湖区建行 type: string register_name: description: 开票单位 example: 支付宝(杭州)信息技术有限公司 type: string register_no: description: 纳税人识别号,不可为空串 example: J8374LK29387 type: string register_phone_no: description: 开票人电话,支持座机和手机两种格式 example: "13200029932" type: string sum_amount: description: 价税合计 example: "2000.00" type: string tax_amount: description: 税额 example: "1000.00" type: string tax_type: description: "税种\t可选值:\tPLAIN:增值税电子普通发票\tALL_ELECTRONIC_GENERAL:电子发票(普通发\ 票)\tALL_ELECTRONIC_SPECIAL:电子发票(增值税专用发票)\tSPECIAL:增值税专用发票\tPLAIN_INVOICE:增\ 值税普通发票\tFINANCIAL_ELECTRONIC_BILL:财政电子票据" example: PLAIN type: string user_id: description: 支付宝用户id,支付宝端的申请id存在的时候也不需要传,其他情况下,当同步的是蓝票时,必传,红票时不需传。 example: "2088399922382233" type: string type: object InvoiceOutputInfo: properties: check_code: description: 发票防伪码,验证码 type: string checker: description: 票面上复核人信息。 type: string clerk: description: 票面上开票员信息。 type: string ex_tax_amount: description: 不含税金额,票面上的不含税金额,单位(元),保留两位小数。 type: string invoice_code: description: 发票代码 type: string invoice_content: description: 发票明细项。 items: $ref: '#/components/schemas/InvoiceItemOpenModel' type: array invoice_date: description: 开票日期,格式如:YYYY-MM-DD。 type: string invoice_img_url: description: 发票预览图片地址 type: string invoice_kind: description: 标识发票的类型,PLAIN:增值税电子普通发票;SPECIAL:增值税专用发票;PLAIN_INVOICE:增值税普通发票;SALSE_INVOICE:机动车销售统一发票 ;PAPER_INVOICE:增值税普通发票(卷式)。 type: string invoice_memo: description: 票面上备注信息。 type: string invoice_no: description: 发票号码 type: string invoice_title: $ref: '#/components/schemas/InvoiceTitleOpenModel' invoice_type: description: 标识是红票还是蓝票,RED:红票;BLUE:蓝票 type: string ori_blue_inv_code: description: 红票情况下,必须填入原始蓝票的发票代码。 type: string ori_blue_inv_no: description: 红票情况下,必须填入原始蓝票的发票号码。 type: string payee: description: 票面上收款人信息。 type: string payee_address_tel: description: 票面上销售方地址、电话信息。 type: string payee_bank_name_account: description: 票面上销售方开户行及账号。 type: string payee_name: description: 票面上销售方企业名称。 type: string payee_register_no: description: 票面上销售方税号信息。 type: string sum_amount: description: 价税合计,票面上的总开票金额,单位(元),保留两位小数,sum_amount=ex_tax_amount+tax_amount。 type: string tax_amount: description: 合计税额,票面上的合计税额,单位(元),保留两位小数。 type: string type: object InvoicePDFSynModel: properties: apply_id: description: 支付宝开票申请id example: "2016112800152005000000000239" type: string extend_fields: 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 type: string file_base: description: base64化的字符串,与file_download_url不可同时为空。 example: 5LqR5YyW56iO5o6nDQoNCjIuMjjnur/kuIrlj6/llK7ljZYNCg0KVzHvvJrlrozmiJDnlJ/kuqflj5H type: string file_download_type: description: "文件类型,必填。\tPDF类型文件填写PDF,\tOFD类型文件填写ofd,\tJPG类型文件填写JPG(JPG文件\ 请先询问对接人当前是否支持)" example: PDF type: string file_download_url: description: 发票文件下载地址,和file_base不可同时为空。 example: http://img.hadalo.com/aa/kq/ddhrtdefgxKVXXXXa6apXXXXXXXXXX.pdf type: string login_id: description: 支付宝登录账号 example: 155xxxxxxxx type: string open_id: description: 支付宝用户id,当apply_id为空时,open_id必填 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string out_invoice_id: description: 外部ISV的唯一发票标识 example: "2088100022223333" type: string user_id: description: 支付宝用户userId example: "2088399922382233" type: string zip: description: 压缩方式 example: zip type: string type: object InvoiceSendOpenModel: properties: apply_id: description: 支付宝端的申请id。如果在开票过程中,是通过支付宝提交的申请到机构端,支付宝会带上开票申请在支付宝生成的申请id,机构在回传发票的时候只需要回传这个申请id,不用获取用户的uid,支付宝可以根据申请id将发票归集到对应的用户名下 example: "2016112800152005000000000239" type: string check_code: description: 票面上的校验码信息。 example: "15170246985745164986" type: string checker: description: 票面上复核人信息。 example: 李四 type: string clerk: description: 票面上开票员信息。 example: 赵吴 type: string ex_tax_amount: description: 不含税金额,票面上的不含税金额,单位(元),保留两位小数。 example: "100.00" type: string extend_fields: 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 type: string file_download_type: description: 下载版式文件类型,需要回传文件下载链接的情况下必传 example: PDF type: string file_download_url: description: 发票版式文件下载地址。 example: http://img.hadalo.com/aa/kq/ddhrtdefgxKVXXXXa6apXXXXXXXXXX.pdf type: string financial_electronic_type: description: 财政电子票据子类型 example: "01" type: string invoice_code: description: 发票代码,该字段与invoice_no构成一张发票的唯一标识。 example: "4112740003" type: string invoice_content: description: 发票明细项。 items: $ref: '#/components/schemas/InvoiceItemOpenModel' type: array invoice_date: description: 开票日期,格式如:YYYY-MM-DD。 example: 2017-10-10 type: string invoice_kind: description: "标识发票的类型,\tPLAIN:增值税电子普通发票;\tSPECIAL:增值税专用发票;\tALL_ELECTRONIC_GENERAL:电\ 子发票(普通发票);\tALL_ELECTRONIC_SPECIAL:电子发票(增值税专用发票);\tPLAIN_INVOICE:增值税普通\ 发票;\tFINANCIAL_ELECTRONIC_BILL:财政电子票据;" example: PLAIN type: string invoice_memo: description: 票面上备注信息。 example: 订单号:2017120800001 type: string invoice_no: description: 发票号码,该字段与invoice_code构成一张发票的唯一标识。 example: "41791003" type: string invoice_title: $ref: '#/components/schemas/InvoiceTitleOpenModel' invoice_type: description: 标识是红票还是蓝票,RED:红票;BLUE:蓝票。 example: BLUE type: string open_id: description: 支付宝用户userId,当发送红字发票时,即invoice_type=RED时,可选填;或者apply_id不为空的时候,可选填;其他情况必填。 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string ori_blue_inv_code: description: 红票情况下,必须填入原始蓝票的发票代码(全电票时为空)。 example: "4112740002" type: string ori_blue_inv_no: description: 红票情况下,必须填入原始蓝票的发票号码。 example: "41791002" type: string out_invoice_id: description: 外部发票id,isv生成发票之后所生成的发票流水号,主要用做存储。 example: "201710283459661232435535" type: string out_trade_no: description: 该发票基于的实际交易流水号。 example: "20171023293456785924325" type: string payee: description: 票面上收款人信息。 example: 张三 type: string payee_address_tel: description: 票面上销售方地址、电话信息。 example: 杭州市西湖区某某办公楼 0571-237405862 type: string payee_bank_name_account: description: 票面上销售方开户行及账号。 example: 西湖区建行11111111111 type: string payee_register_name: description: 票面上销售方企业名称。 example: 支付宝(杭州)信息技术有限公司 type: string payee_register_no: description: 票面上销售方税号信息。 example: "310101000000090" type: string sum_amount: description: 价税合计,票面上的总开票金额,单位(元),保留两位小数,sum_amount=ex_tax_amount+tax_amount。 example: "101.00" type: string tax_amount: description: 合计税额,票面上的合计税额,单位(元),保留两位小数。 example: "1.00" type: string trade_list: description: 交易内容,非必填但是不可以传空值,如果无需回传trade_list则不需要传该对象 items: $ref: '#/components/schemas/EinvTrade' type: array user_id: description: 支付宝用户userId,当发送红字发票时,即invoice_type=RED时,可选填;或者apply_id不为空的时候,可选填;其他情况必填。 example: "2088399922382233" type: string type: object InvoiceTitleModel: properties: is_default: description: "是否为用户设置默认抬头\r\t字段值包括两种情况:\r\tfalse(非默认)\r\ttrue(默认抬头)" type: boolean logon_id: description: 支付宝用户登录名 type: string open_bank_account: description: 银行账号 type: string open_bank_name: description: 开户银行 type: string open_id: description: 支付宝用户id type: string tax_register_no: description: 纳税人识别号 type: string tele_phone_no: description: 用户私人手机号 type: string title_name: description: 抬头名称 type: string title_type: description: "抬头类型\r\t字段值有两种情况抬:\r\tPERSONAL(个人) \r\tCORPORATION(单位)" type: string user_address: description: 地址 type: string user_email: description: 邮箱 type: string user_id: description: 支付宝用户id type: string user_mobile: description: 电话号码 type: string type: object InvoiceTitleOpenModel: properties: payer_address_tel: description: 票面上的购买方地址、电话 type: string payer_bank_name_account: description: 票面上的购买方开户行及账户 type: string payer_register_no: description: 票面上的购买方纳税人识别号 type: string title_name: description: 票面上的购买方名称 type: string type: object InvoiceUkDTO: properties: invoice_code: description: 发票代码 type: string invoice_no: description: 发票号码 type: string type: object IssueQuotaCheckInfo: properties: issue_quota: description: 发放金额 example: "10" type: string message: description: 校验结果的原因 example: 金额不能为负数 type: string owner_id: description: 入参的 owner_id example: "13055551515" type: string owner_open_id: description: 入参的 owner_open_id example: abcdxxxx type: string owner_type: description: owner_type example: PHONE type: string result: description: 校验结果 example: true type: boolean user_name: description: 用户姓名 example: 测试 type: string type: object IssueRuleIdInfo: properties: issue_rule_id: description: 发放规则id example: "2022031000152621000000000001" type: string outer_source_id: description: 外部发放规则id example: "123456" type: string type: object IssueRuleInfo: properties: effective_period: description: 生效时间段 type: string invalid_mode: description: "累计类型,默认为0\t可选值:0(不可累计)、1(可累计)、2(累计天数)、3(累计到指定日期)" type: integer invalid_mode_value: description: 累计类型值 type: string issue_amount_value: description: 发放金额,单位元 type: string issue_end_date: description: 发放规则有效结束时间 type: string issue_rule_id: description: 发放规则id type: string issue_rule_name: description: 发放规则名称 type: string issue_start_date: description: 发放规则有效起始时间 type: string issue_type: description: 发放类型 type: string outer_source_id: description: 外部发放规则id type: string quota_type: description: 额度类型 type: string share_mode: description: 是否可转赠 type: integer target_id: description: 目标id type: string target_type: description: 发放规则归属的目标类型 type: string type: object IssueTargetInfoContent: properties: issue_quota: description: 发放金额 example: "10" type: string owner_id: description: 切换open_id前请使用:owner类型为PHONE时该字段表示员工手机号,owner类型为为EMPLOYEE时该字段表示为员工支付宝uid,owner类型为为ENTERPRISE_PAY_UID时该字段表示为员工企业码id example: "13055551515" type: string owner_open_id: description: 切换open_id后请使用:owner类型,PHONE为员工手机号,EMPLOYEE为员工open_id example: abcdxxxx type: string owner_type: description: "owner类型,用来表示owner_id的类型;\tenterprise_id支持PHONE、ENTERPRISE_PAY_UID类\ 型;account_id支持EMPLOYEE类型" example: PHONE type: string user_name: description: 员工姓名 example: 测试 type: string type: object IsvAuthSceneInfo: properties: scene_code: description: "运营场景编码\tOPERATION_POINTS:管理运营积分\tSHOP_MANAGE:管理门店信息\tMINI_APP_OPER:\ 运营支付宝小程序\tPROMOTION_MANAGE:运营营销活动" example: PROMOTION_MANAGE type: string scene_permissions: description: "运营场景下的权限编码,多个权限编码以,隔开\t1、管理门店信息:SHOP_MANAGE;基础权限(升级):SHOP_MANAGE_BASE\t\ 2、运营营销活动:PROMOTION_MANAGE ;基础权限(升级):PROMOTION_MANAGE_BASE\t3、运营支付宝小程序:\ MINI_APP_OPER;基础权限(升级):MINI_APP_OPER_BASE\t4、管理运营积分:OPERATION_POINTS;基\ 础权限(升级):OPERATION_POINTS_BASE" example: SHOP_MANAGE_BASE type: string type: object IsvExpandOpporDTO: properties: address: description: 商机地址 example: 紫金港路与文二西路交叉口向西500米西城广场 type: string leads_id: description: 商机Id example: "2020092100009315" type: string name: description: 商机名称 example: 测试 type: string oppor_id: description: 商机作业Id example: "2020092200010868" type: string out_biz_no: description: 外部幂等唯一键 example: out_biz_no type: string phone: description: 商机联系电话 example: "13812312323" type: string status: description: 商机作业状态 example: EXPANDED type: string type: object IsvMerchantSalesDetailRequest: properties: coupons_quantity: description: 配券数 example: "1" type: string device_detail: description: 设备详情 example: 此处为该设备的详细描述 type: string merchant_pid: description: 商户pid example: "2088301912341234" type: string mini_appid: description: 小程序appid,若推广的商品不为小程序,则不传此参数 example: "2018082861168647" type: string operation_place: description: 作业地 example: 浙江省杭州市西湖区蚂蚁A空间 type: string out_biz_no: description: 外部业务号,传isv系统生成的账单号,需要保证唯一 example: "2021000000000" type: string promotor_pid: description: 推广服务商(S2)pid example: "2088301912341234" type: string sales_amount: description: 销售金额,这里填写的是整数,单位为分,比如1元,那么输入100 example: "100" type: string sales_quantity: description: 销售笔数 example: "100" type: string sub_promotor_pid: description: 推广服务商(S2)子账号pid example: "2088301912341234" type: string write_off_amount: description: 核销金额,这里填写的是整数,单位为分,比如1元,那么输入100 example: "100" type: string write_off_quantity: description: 核销数 example: "1" type: string type: object IsvSpiDefinition: properties: biz_code: description: ISV自定义的标识功能的业务代码,不可重复 example: hotline type: string description: description: spi功能描述 example: spi功能描述 type: string icon: description: 功能图标文件url example: http://127.0.0.1/ type: string spi_endpoint: description: spi接口服务地址 example: http://127.0.0.1/ type: string spi_ext_property: description: spi接口扩展参数,json格式字符串 example: "{\"key\":\"value\"}" type: string spi_key: description: CCM预先定义的spi key,与插件位置有关 example: spi_alipay_iservice_ccm_menu type: string spi_name: description: SPI 名称 example: 热线工作台 type: string type: object ItemConsultInfo: properties: item_id: description: 商品id example: "20210105003" type: string promo_amount: description: 商品优惠金额,单位为元 example: "3.0" type: string promo_count: description: 商品优惠数量 example: "2" type: string type: object ItemConsultRequest: properties: item_id: description: 商品id example: "20210105003" type: string price: description: 商品单价,单位为元,最多2位小数 example: "20.29" type: string quantity: description: 商品数量 example: "3" type: string type: object ItemExtInfo: properties: ext_key: description: 扩展信息的key type: string ext_value: description: 扩展信息的值 type: string type: object ItemInfo: properties: item_ids: description: "券适用的单品码列表\r\t最少配置1个单品码\r\t最多配置500个单品码" example: "0000123,0000124" items: type: string type: array item_imgs: description: "单品图片列表\r\t单品图片不能超过3张" example: 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC items: type: string type: array item_link: description: 单品券详细介绍跳转链接 example: www.taobao.com type: string item_name: description: 单品名称 example: 单品名称 type: string item_text: description: 单品券说明 example: 单品券说明 type: string max_discount_num: description: "单品券适用的商品列表中,每一个商品最高可享受优惠的件数; \r\t如:券适用于A,B两种商品,该字段设置为1,则用\ 券A,B两种商品每种最多只有一件可享受优惠;" example: "1" type: string min_consume_num: description: "单品券适用商品列表中,每种商品享受优惠最低购买件数的门槛;\r\t如:券适用于A,B两种商品,该字段设置为3,则A,B两\ 种商品每种最少需要购买3件才可享受优惠;" example: "1" type: string original_price: description: "单品的原价,单位元\r\t必须为合法金额类型字符串,如9.99" example: "28.88" type: string sku_min_consume: description: "券适用SKU的最低消费金额门槛\r\t如券适用A,B两个SKU,该字段设置的值为100,则订单中购买A,B两个SKU的\ 合计金额需大于100元才可用券" example: "10" type: string total_max_discount_num: description: 如果一个单品券适用A,B,C三个单品,若设置了该字段为2,则在一笔交易中,A,B,C三个单品加起来最多只有俩件能够享受优惠 example: "10" type: string type: object ItemLabelCreateInfo: properties: label_key: description: "标签键\r\tOIL_NUM:油号" example: OIL_NUM type: string label_value: description: "标签值:\r\tOIL_NUM对应的值为:95# 92# 98# 等等" example: 95# type: string type: object ItemLabelModifyInfo: properties: label_key: description: "标签键\r\tOIL_NUM:油号" example: OIL_NUM type: string label_value: description: "标签值:\r\tOIL_NUM对应的值为:95# 92# 98# 等等" example: 95# type: string type: object ItemModel: properties: creator_id: description: 创建者id example: "1" type: string creator_type: description: 创建者类型 example: SYSTEM type: string ext_info: description: "商品扩展信息:可以解析成 Map 的 json string" example: "{\"DISCOUNT\": \"88\"}" type: string front_category_id: description: 前台类目id example: "2018091300502200002600105884" type: string gmt_create: description: 商品创建时间 example: 2018-09-25 19:41:34 type: string gmt_modified: description: 商品更新时间 example: 2018-09-25 19:41:34 type: string item_id: description: 商品id example: "2018091300502200004300103587" type: string name: description: 商品名称 example: 西红柿炒蛋 type: string sku_list: description: 商品sku列表 items: $ref: '#/components/schemas/ItemSkuInfo' type: array sort: description: 商品排序 example: 0 type: integer status: description: 商品状态 example: EFFECT type: string target_id: description: 商户归属主体id example: "2018090600502000000022501261" type: string target_type: description: 商品归属主体类型:5(商铺) example: "5" type: string type: description: 商品类型 example: STANDARD_GOODS type: string type: object ItemOrderInfo: properties: ext_info: description: 扩展信息,请参见产品文档。小程序订单助手业务中,扩展参数必须传递素材id;其他业务场景参见对应的产品文档。 items: $ref: '#/components/schemas/OrderExtInfo' type: array item_id: description: 商品ID example: "2019073100702219000000100000" type: string item_name: description: 商品名称 example: 苹果 type: string quantity: description: 商品数量(单位:自拟) example: 20 type: integer sku_id: description: 商品 sku id example: "2018111300502205000000176601" type: string status: description: 商品状态枚举 example: PAID type: string status_desc: description: 商品状态描述,默认无需传入,如需使用请联系业务负责人 example: 已付款 type: string unit: description: 商品规格 example: 斤 type: string unit_price: description: 商品单价(单位:元) example: "13.18" type: string type: object ItemPlanContentDO: properties: codes: description: 对应服务库编码 example: "[\"400000000207968215\"]" items: type: string type: array type: description: 条目类型,必须, 商品:ITEM example: ITEM type: string type: object ItemPromoInfo: properties: item_consult_list: description: 商品咨询列表 items: $ref: '#/components/schemas/ItemConsultInfo' type: array item_cover_pic: description: 单品封面图 example: https://gw.alipayobjects.com/mdn/rms_9822d7/afts/img/A*1F4eSaaPHRQAAAAAAAAAAABkARQnAQ type: string item_desc: description: 单品描述 example: 宝洁洗护用品促销 type: string item_detail_pic_list: description: 单品详情图列表 example: "[\"https://gw.alipayobjects.com/mdn/rms_9822d7/afts/img/A*1F4eSaaPHRQAAAAAAAAAAABkARQnAQ\"\ ]" items: type: string type: array item_name: description: 单品名称 example: 宝洁洗护用品 type: string type: object ItemPropertyInfo: properties: property_key: description: 属性名称 type: string property_value_list: description: 属性值列表 items: type: string type: array type: object ItemSkuCreateInfo: properties: cost_price: description: 成本价,单位分 example: 100 type: integer ext_info: description: SKU扩展信息 items: $ref: '#/components/schemas/ItemExtInfo' type: array external_sku_id: description: 外部SKU ID example: "201909161232534324124123" type: string inventory: description: 库存 example: 100 type: integer original_price: description: 标价,单位分 example: 100 type: integer price: description: 售价,单位分 example: 100 type: integer type: object ItemSkuInfo: properties: cost_price: description: 成本价,单位分 example: 100 type: integer ext_info: description: SKU扩展信息 items: $ref: '#/components/schemas/ItemExtInfo' type: array gmt_create: description: 创建时间 example: 2018-09-26 11:12:54 type: string gmt_modified: description: 更新时间 example: 2018-09-26 11:12:54 type: string item_id: description: 商品id example: "2018091300502200004400104166" type: string original_price: description: 标价,单位分 example: 100 type: integer price: description: 售价,单位分 example: 100 type: integer sku_id: description: 商品sku id example: "2018091300502200001600103072" type: string status: description: 商品SKU状态:EFFECT、INVALID example: EFFECT type: string type: object ItemSkuModifyInfo: properties: cost_price: description: 成本价,单位分 example: 100 type: integer ext_info: description: SKU扩展信息 items: $ref: '#/components/schemas/ItemExtInfo' type: array external_sku_id: description: "外部skuId(sku_id不为空时作为普通更新项,sku_id为空时作为更新key,sku_id和该字段同时为空则\ 新增该条数据)" example: "20190916123124234235234" type: string inventory: description: 库存 example: 100 type: integer original_price: description: 标价,单位分 example: 100 type: integer price: description: 售价,单位分 example: 100 type: integer sku_id: description: skuId example: "2018092600502220000000100274" type: string status: description: 商品SKU状态:EFFECT、INVALID example: EFFECT type: string type: object ItemSkuPropertyInfo: properties: property_key: description: 属性 type: string property_value: description: 属性值 type: string type: object JinyouTestFive: properties: f_1_f: $ref: '#/components/schemas/JinyouTestFour' f_2_f: $ref: '#/components/schemas/JinyouTestThree' f_3_openid: description: "1" example: xxxxxscddcd type: string f_3_y: description: "1" example: "1" type: string f_4_n: description: "3" example: "2" type: string type: object JinyouTestFour: properties: f_1_openid: description: "1" example: xxxxxscddcd type: string f_1_y: description: "1" example: "1" type: string f_2_f: $ref: '#/components/schemas/JinyouTestThree' f_3_openid: description: "1" example: xxxxxscddcd type: string f_3_y: description: "1" example: 1 type: integer type: object JinyouTestOne: properties: o_1_n: description: "1" type: string o_2_openid: description: o_2_y type: string o_2_y: description: o_2_y type: string o_3_openid: description: o_3_y type: string o_3_y: description: o_3_y type: integer type: object JinyouTestThree: properties: th_1_f: $ref: '#/components/schemas/JinyouTestTwo' th_2_n: description: 无枚举值 type: string th_3_n: description: "1" type: boolean type: object JinyouTestTwo: properties: t_1_openid: description: "1" type: string t_1_y: description: "1" type: string t_2_f: $ref: '#/components/schemas/JinyouTestOne' t_3_n: description: "1" type: string type: object JinyoutestopenidOne: properties: c_1: description: 我晚点 example: "4" type: string q: description: "1" example: "1" type: string q_1_open_id: description: "1" example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string type: object JinyoutestopenidThree: properties: a: description: "12" example: a_noopenid无 type: string b: description: "有openid,无枚举,有注意事项" example: "21" type: string b_open_id: description: "有openid,无枚举,有注意事项" example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string f: $ref: '#/components/schemas/JinyoutestopenidTwo' type: object JinyoutestopenidTwo: properties: a: description: "无openid,有枚举值,有注意事项" example: hjkhjc type: string b: description: 有openid,无枚举值,无注意事项 example: "7878789" type: string b_open_id: description: "有openid,无枚举值,无注意事项,openid有注意事项" example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string f: $ref: '#/components/schemas/JinyoutestopenidOne' type: object JobWorthJobdata: properties: certificate_grant_institution: description: 证书发证机构 example: 浙江省杭州市西湖区红十字会 type: string certificate_id: description: 证书编号 example: abcd12345678 type: string certificate_level: description: 证书等级:中文 example: 初级 type: string certificate_name: description: 证书名称 example: 健康管理师 type: string certificate_pic_id: description: 工作证图片上传接口返回的id example: abcd12345678 type: string company_name: description: 公司名称 example: 上海依多企业管理有限公司 type: string degree: description: 学历,可以用以下字段HIGHSCHOOL_AND_BELOW(高中及以下),POLYTECHNIC(中专),COLLEGE(大专),BACHELOR(本科),MASTER(硕士),DOCTOR_AND_ABOVE(博士及以上) example: BACHELOR type: string delivery_position_id: description: 商户侧投递岗位id example: xxxxx type: string delivery_time: description: 投递时间戳 example: 9999 type: integer education_status: description: 教育状态只有两种,GRADUATE(毕业),STUDY(未毕业) example: GRADUATE type: string entry_no: description: 报名流水号 example: "1235446" type: string exam_score: description: 考试分数 example: "85" type: string head_pic_id: description: 工作证图片上传接口返回的id example: abcd123456 type: string intention_city: description: 求职意向,城市的adccode 例如110000(北京市) example: "110000" type: string intention_city_name: description: 意向城市名,例如北京市,传入北京即可,大理白族自治州,传入大理即可 example: 北京 type: string issue_date: description: 发证日期,ms时间戳 example: "1668743509506" type: string job_id: description: 岗位对应的职业id,字段参考https://www.yuque.com/wx3dkp/gwckr4/bs03t3 example: 5278A2C2001 type: string job_name: description: 职业名称 example: 后端开发 type: string ka_job_id: description: 商户职业Id example: abc123 type: string ka_job_name: description: 商户职业名称 example: 电工 type: string ka_profession_id: description: 商户行业Id example: abc type: string ka_profession_name: description: 商户行业名称 example: 建筑业 type: string location: description: 省份 example: 浙江 type: string month: description: 毕业的月 example: "7" type: string once_token: description: 对应类型相关接口生成 example: 12345678qwe123 type: string profession_id: description: 岗位对应的行业id,字段参考https://www.yuque.com/wx3dkp/gwckr4/bs03t3 example: 5378A2C2 type: string profession_name: description: 行业名称 example: IT互联网 type: string salary_max: description: 求职意向,薪水范围,不能低于salary_min example: "3000" type: string salary_min: description: 求职意向,薪水范围,不能高于salary_max example: "1000" type: string salary_unit: description: 薪资单位,元/日(DAY)、元/次(TIME)、元/月(MONTH)、元/小时(HOUR)、元/件 (NUM)、元/周 (WEEK)、其他 (OTHER) example: DAY type: string school_name: description: 学校 example: 浙江大学 type: string skill_name: description: 用英文逗号分隔,最多6项 example: "木工,电工" type: string start_time: description: 参加工作的时间,格式形如 2011-07 example: 2011-07 type: string type: description: 信息类型 example: certificate type: string valid_date_end: description: 有效期:开始结束 ms 时间戳 example: "1668743509506" type: string valid_date_start: description: 有效期:开始时间 ms时间戳 example: "1668743509506" type: string verify_status: description: 校验状态 example: '"true"' type: string work_desc: description: 工作描述 example: 岗位职责1、负责自媒体公众号的图片创作编辑2、擅长手绘图像、漫画图像制作3、思维活跃,能够根据所给要求完成一篇情景剧的漫画图案设计4、能够配合工作需求完成工作任务岗位要求1、漫画设计功底较强,能够独立完成创作编辑2、会使用相关修图软件,能独立处理图片3、有相关工作经验优先,艺术学院在校大学生优先 type: string work_end_time: description: 工作结束时间,毫秒级时间戳 example: "1651138651000" type: string work_place: description: 工作经历工作地 example: 工作经历工作地 type: string work_property: description: 岗位属性:全职(FULL_TIME)或者兼职(PART_TIME) example: FULL_TIME type: string work_start_time: description: 工作开始时间,毫秒级时间戳 example: "1651138484000" type: string year: description: 毕业的年 example: "2011" type: string type: object JobWorthPositionInfo: properties: age: description: "职位要求-年龄要求\t无要求(不传)、28岁以上(OVER28)、40岁以下(BELOW40)、25岁~35岁(25TO35)" example: OVER28 type: string benefit: description: "福利,现有标签,最多5个标签,使用英文,分割\t参考\thttps://www.yuque.com/docs/share/805e9840-ae9d-499c-b566-46b3b8c9fb2d?#\ \ 《4.1 服务端接入----职位传入接口》的1.3.1.1" example: "五险一金,双休" type: string certifications: description: 技能、证书等要求,比如学历、健康证、普通话或其他技能证书等 example: "特种工作证,健康证" type: string company_certificate: description: 发布企业统一社会信用代码 example: 91330200750364874C type: string company_logo_afts_id: description: 上传的aftsid example: xxxx type: string company_name: description: 企业工商全称 example: 杭州希德利餐饮管理有限公司 type: string count: description: 招聘人数 example: 8 type: integer education: description: "学历要求,HIGHSCHOOL_AND_BELOW(高中及以下),POLYTECHNIC(中专),COLLEGE(大\ 专),BACHELOR(本科),MASTER(硕士),DOCTOR_AND_ABOVE(博士及以上)" example: BACHELOR type: string gender: description: 无要求(不传)、男或者女 example: 男 type: string ka_position_id: description: 合作方岗位id自定义保持唯一性 example: "20881234567" type: string position_desc: description: 长文本描述 example: 职位描述 type: string position_id: description: 工作证岗位库的职位主键,只有更新职位信息时需要传入。第一次传入岗位后返回 example: "123456789012345678901234" type: string position_job_id: description: 岗位对应的行业id,字段参考https://www.yuque.com/docs/share/805e9840-ae9d-499c-b566-46b3b8c9fb2d?# 《4.1 服务端接入----职位传入接口》的1.3.1.2 example: 5378A2C2001 type: string position_job_name: description: 岗位对应的职业名称 example: 服务端开发工程师 type: string position_profession_id: description: 岗位对应的职业id,字段参考https://www.yuque.com/docs/share/805e9840-ae9d-499c-b566-46b3b8c9fb2d?# 《4.1 服务端接入----职位传入接口》的1.3.1.2 example: 5278A2C2 type: string position_property: description: 岗位属性:全职(FULL_TIME)或者兼职(PART_TIME) example: FULL_TIME type: string position_status: description: 职位的状态,只有上架(UNCHECK)和下架(OFFLINE)两种 example: UNCHECK type: string position_title: description: 短文本描述 example: 日结洗碗工 type: string salary_max: description: 薪水范围,不能低于salary_min example: "3000" type: string salary_min: description: 薪水范围,不能高于salary_max example: "2000" type: string salary_type: description: 薪资类型:日结(DAY)、月结(MONTH)、周结(WEEK)、完工结(DONE)、其他(OTHER) example: DAY type: string salary_unit: description: 薪资单位,元/日(DAY)、元/次(TIME)、元/月(MONTH)、元/小时(HOUR)、元/件 (NUM)、元/周 (WEEK)、其他 (OTHER) example: DAY type: string skill_tag: description: 岗位需要的技能标签,最多5个,使用英文逗号分割 example: "java,linux" type: string skip_url: description: 职位跳转链接,当前只支持支付宝小程序,也就是alipays://platformapi/ 开头 example: alipays://platformapi/startapp? type: string work_city: 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" type: string work_longitude: description: 经纬度,前面是经度,后面是纬度,使用英文逗号隔开 example: "116.396574,39.992706" type: string work_region: description: "工作地所在的区县,使用高德的adcode,例:朝阳区110105\t参考https://www.yuque.com/docs/share/805e9840-ae9d-499c-b566-46b3b8c9fb2d?#\ \ 《4.1 服务端接入----职位传入接口》的1.3.1.2" example: "110105" type: string work_year: description: 工作年限,1年以下(ONE)、1~3年(THREE)、3~5年(FIVE)、5~10年(TEN)、10年以上(OVER_TEN) example: TEN type: string type: object JointAccountBillDetail: properties: amount: description: 消费金额,单位:元 example: "100.00" type: string bill_no: description: 账单业务号 example: 2022051204200202001000473989_2022051230000200020601732777 type: string biz_date: description: 业务时间 example: 2022-05-01 00:00:00 type: string biz_no: description: 订单号 example: "2020102604200204001063507418" type: string biz_out_no: description: 外部单号 example: "407578148517691" type: string enterprise_id: description: 企业ID example: "2088000000000000" type: string in_out: description: 1-退款,2-支付 example: "1" type: string open_id: description: 用户支付宝uid example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string title: description: 账单标题 example: 消费账单 type: string user_id: description: 用户支付宝uid example: "2088000000000000" type: string type: object JointAccountBillDetailDTO: properties: account_id: description: 共同账户ID example: "2088900976746215" type: string amount: description: 消费金额 example: "1" type: string bill_no: description: 账单业务号 example: 2022051204200202001000473989_2022051230000200020601732777 type: string biz_date: description: 业务时间 example: 2020-01-01 00:00 type: string biz_no: description: 订单号 example: "2020102604200204001063507418" type: string in_out: description: 1-退款,2-支付 example: "1" type: string open_id: description: 共同账户消费的成员openid example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string out_trade_no: description: 外部交易单号,正向支付为外部交易单号,逆向退款是为外部退款单号 example: Q1312312312313 type: string payer_asset_info: $ref: '#/components/schemas/UserAssetInfoVO' seller_full_name: description: 间连商户显示二级商户全名,直连、直付通则显示一级商户全名。企业商户该字段不脱敏,非企业商户该字段会脱敏 example: 信息有限公司 type: string seller_logon_id: description: 收款方登录号信息。间连商户显示二级商户的登录号信息;直连、直付通显示一级商户的登录号信息;该字段脱敏 example: "19927441769" type: string title: description: 账单标题 example: 新电途(银通新能源:325616137201026100441546497 type: string user_id: description: 共同账户消费的成员ID example: "2088900970000001" type: string type: object JointAccountDTO: properties: account_id: description: 共同账户ID example: "2088000011111" type: string account_name: description: 共同账户账本名称 example: 企业代付 type: string user_id: description: 账本创建人会员号 example: "2088900976740001" type: string type: object JointAccountMemberDTO: properties: account_quota: $ref: '#/components/schemas/JointAccountQuotaDTO' member_ext_info: $ref: '#/components/schemas/MemberExtInfo' name: description: 姓名,脱敏输出 example: 张三 type: string open_id: description: 用户openId example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string status: description: 成员状态 example: NORMAL type: string user_id: description: 用户会员号 example: "2088123123132" type: string type: object JointAccountMemberInfoRespDTO: properties: open_id: description: (群成员)支付宝侧用户唯一标识 example: 095PJtAPYb2UkQ0mXk_X86Z_Pd7PtySKX-U3zUEwONcu3wc type: string operate_role: description: "成员角色:
\t-MASTER:创建人
\t-ADMIN:管理员
\t-MEMBER:群成员
" example: MASTER type: string user_id: description: (群成员)支付宝侧用户唯一标识 example: "2088900976746215" type: string type: object JointAccountMemberList: properties: account_quota: description: 额度模型 items: $ref: '#/components/schemas/JointAccountQuotaDTO' type: array open_id: description: 成员openId example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string user_id: description: 成员ID example: "2088900976746215" type: string type: object JointAccountMemberRespDTO: properties: account_quota: description: 额度模型 items: $ref: '#/components/schemas/JointAccountQuotaDTO' type: array logon_id: description: 成员支付宝登录号 example: "13111122222" type: string name: description: 姓名 example: 成员名称 type: string status: description: "员工当前状态:\t\t邀请中(PROCESSING)、正常(NORMAL)" example: 状态 type: string user_id: description: 用户支付宝会员号 example: "2088900976746215" type: string type: object JointAccountQuotaDTO: properties: custom_begin_date: description: 自定义周期起始日期,精确到分钟,yyyy-MM-dd HH:mm type: string custom_end_date: description: 自定义周期结束日期,精确到分钟,yyyy-MM-dd HH:mm type: string quota_dimension: description: "额度维度\t单笔上限:ONCE\t日:DAY\t月:MONTH\t季度:QUARTER\t年:YEAR\t终身:LIFETIME\t\ 一次性使用额度:ONLYONE" type: string quota_total: description: 协议额度 type: string type: object JointAccountQuotaRespDTO: properties: custom_begin_date: description: "额度生效起始日期,精确到分钟。\t格式:yyyy-MM-dd HH:mm" type: string custom_end_date: description: "额度失效结束日期,精确到分钟。\t格式:yyyy-MM-dd HH:mm" type: string quota_dimension: description: 额度维度 type: string quota_remain: description: 剩余额度 type: string quota_remain_count: description: 展示额度剩余可用次数,-1表示无限次 type: string quota_total: description: 协议额度 type: string quota_used: description: 已用额度 type: string type: object JourneyLocation: properties: aoi_id: description: 支付宝域内aoiId type: string city: description: 城市名 type: string ext_info: description: 扩展信息 items: $ref: '#/components/schemas/OrderExtInfo' type: array location_id: description: 支付宝侧地点id type: string location_id_type: description: 地点id类型 type: string merchant_division_id: description: 商户侧行政区划代码 type: string merchant_id: description: (废弃)商户侧地点id type: string merchant_poi: description: 商户侧poi信息 type: string name: description: 地点名称 type: string poi_id: description: 支付宝域内poiId type: string type: object JourneyMerchantInfo: properties: ext_info: description: 扩展信息 items: $ref: '#/components/schemas/OrderExtInfo' type: array logo: description: 商户logo链接 example: logo.jpg type: string name: description: 商家名称 example: 中国航空公司 type: string short_name: description: 商家简称 example: 中国航空 type: string type: object JourneyServiceChangeInfo: properties: change_status: description: 变更状态 example: DELAY type: string detail_url: description: 详情url example: alipays://platformapi/startApp?appId=2019050664392666&page=page/test/detailurl type: string ext_info: description: 扩展信息 items: $ref: '#/components/schemas/OrderExtInfo' type: array remind_content: description: 提醒内容 example: 该航班预计起飞时间由2月1日14:40延后至2月2日01:00。 type: string type: object KeyWordInfo: properties: apply_no: description: 审核单号 type: string audit_key_word: description: 审核中的关键词 type: string audit_reason: description: 审核人的备注信息 type: string audit_time: description: 审核时间,格式为 yyyy-MM-dd HH:mm:ss type: string config_id: description: 关键词配置ID type: string gmt_create: description: 创建时间,格式为 yyyy-MM-dd HH:mm:ss type: string key_word: description: 审核完成的关键词 type: string status: description: 关键词当前状态 type: string type: object Keyword: properties: color: description: 当前文字颜色 type: string value: description: 模板中占位符的值 type: string type: object KoubeiMarketingCampaignIntelligentPromoBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object KoubeiMarketingCampaignIntelligentPromoBatchqueryModel: properties: operator_context: $ref: '#/components/schemas/PromoOperatorInfo' out_request_no: description: 外部业务id,请保持足够的复杂,方便定位数据来源 example: 65165813-a51a-44b9-984c-c75022ecbaf7 type: string owner_info: $ref: '#/components/schemas/PromoOperatorInfo' page_info: $ref: '#/components/schemas/PromoPageInfo' type: object KoubeiMarketingCampaignIntelligentPromoBatchqueryResponseModel: properties: intelligent_promos: description: 查询返回的营销活动列表信息 items: $ref: '#/components/schemas/IntelligentPromo' type: array page_result: $ref: '#/components/schemas/PromoPageResult' type: object KoubeiMarketingCampaignIntelligentShopConsultErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - BIZ_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object KoubeiMarketingCampaignIntelligentShopConsultModel: properties: biz_scene: description: "根据不同场景,过滤不同的门店数据,可参考值:CREATE_NORMAL:正常创建;RENEWAL_OLD:原方案续期\ ;RENEWAL_NEW:新方案续期" example: CREATE_NORMAL type: string operator_context: $ref: '#/components/schemas/PromoOperatorInfo' out_request_no: description: 外部业务id,请尽量保持足够的复杂,方便定位数据来源 example: 65165813-a51a-44b9-984c-c75022ecbaf7 type: string page_index: description: 当前页码,默认:“1” example: "1" type: string page_size: description: "每页项数[1, 500], 默认500" example: "500" type: string partner_id: description: 商户和支付宝交互时,用于代表支付宝分配给商户ID example: "208805674367676" type: string plan_id: description: 智能营销方案的方案id(template_code替代该值,无需传递) example: "20170909000000000013690911001490" type: string promo_id: description: "结合biz_scene一起使用,值为RENEWAL_OLD:原方案续期、RENEWAL_NEW:新方案续期,要求必传" example: "20180111000000000613692911004200" type: string template_code: 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 type: string type: object KoubeiMarketingCampaignIntelligentShopConsultResponseModel: properties: items: description: 总共项数 example: "1000" type: string shops: description: 智能营销方案符合标准的门店列表 items: $ref: '#/components/schemas/IntelligentPromoShopSummaryInfo' type: array type: object KoubeiMarketingCampaignIntelligentTemplateConsultErrorResponseModel: properties: code: description: 错误码 enum: - BIZ_ERROR - INVALID_PARAMETER - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object KoubeiMarketingCampaignIntelligentTemplateConsultModel: properties: biz_scene: description: "根据不同场景,过滤不同的门店数据,可参考值:CREATE_NORMAL:正常创建;RENEWAL_OLD:原方案续期\ ;RENEWAL_NEW:新方案续期" example: CREATE_NORMAL type: string operator_context: $ref: '#/components/schemas/PromoOperatorInfo' out_request_no: description: 代表了一次请求,作为业务幂等性控制 example: 432455ttrytryrt543 type: string partner_id: description: 商户和支付宝交互时,用于代表支付宝分配给商户ID example: "208805674367676" type: string promo_id: description: "结合biz_scene一起使用,值为RENEWAL_OLD:原方案续期、RENEWAL_NEW:新方案续期,要求必传" example: "20180111000000000613692911004200" type: string shop_ids: description: 默认(不传shop_ids门店)使用待体验门店匹配适用模板,指定门店列表(shop_ids)后根据入参匹配适用模板 example: "2017090100077000000045190283" items: type: string type: array type: object KoubeiMarketingCampaignIntelligentTemplateConsultResponseModel: properties: template_codes: description: "营销模板的编号\r\tGENERAL_NORMAL:全场普通;\r\tITEM_NORMAL:单品普通;\r\tCROWD_NORMAL:\ \ 千人千券普通;" example: GENERAL_EXPERIENCE items: type: string type: array type: object KoubeiMarketingCampaignItemMerchantactivityBatchqueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - PERMISSION_DENY - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object KoubeiMarketingCampaignItemMerchantactivityBatchqueryModel: properties: page_no: description: 页码 example: 1 type: integer page_size: description: 每页显示内容数 example: 10 type: integer status: description: 活动状态 example: EFFECTIVE type: string type: object KoubeiMarketingCampaignItemMerchantactivityBatchqueryResponseModel: properties: activities: description: 活动信息 items: $ref: '#/components/schemas/MerchantOnlineActivityOpenModel' type: array type: object KoubeiMarketingCampaignItemMerchantactivityCloseErrorResponseModel: properties: code: description: 错误码 enum: - PERMISSION_DENY - INVALID_PARAMETER - SYSTEM_ERROR - OPERATE_STATUS_NOT_ALLOWED - MERCHANT_ACTIVITY_PROCESSING - MERCHANT_ACTIVITY_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object KoubeiMarketingCampaignItemMerchantactivityCloseModel: properties: activity_id: description: 活动id。通过 koubei.marketing.campaign.item.merchantactivity.create(商户创建商品代金券)获取。 example: 2018xxxx type: string type: object KoubeiMarketingCampaignItemMerchantactivityCloseResponseModel: type: object KoubeiMarketingCampaignItemMerchantactivityCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object KoubeiMarketingCampaignItemMerchantactivityCreateModel: properties: count_limit: description: "活动优惠次数限制,必须设置。\t说明:活动优惠总次数限制不能小于1,且不能大于99999999。" example: 99 type: integer count_limit_per_day: description: "活动优惠单日次数限制。\t说明:活动优惠单日次数限制不能为负数,不能大于99999999;0表示不限制。\t" example: 99 type: integer count_limit_per_user: description: "活动单用户限次。\t说明:活动单用户总限次不能为负数,不能大于999。0表示不限制。" example: 99 type: integer count_limit_per_user_per_day: description: "活动单用户单日限次。\t说明:活动单用户单日限次不能为负数,不能大于999。0表示不限制。" example: 99 type: integer crowd: description: "群规则,枚举支持:\t* DEFAULT: 全部用户;\t* ONLINE_NEWCOMER:在线购买新人;\t*\ \ MEMBER:会员。" example: DEFAULT type: string deduct_amount: description: "代金券面额,单位为元。\t说明:代金券面额格式必须为#.##,代金券面额需小于49999。" example: "5.00" type: string external_callback_url: description: 外部回调地址,最大字符数不能超过500。 example: xxxx type: string external_unique_id: description: "外部id,需保证同一账户下唯一。\t说明:最小长度不能低于13,最大长度不能超过64。" example: 4b203fe6c11548bcabd8da5bb087a83b type: string gmt_end: description: 活动结束时间。活动结束时间需大于活动开始时间。格式为"yyyy-MM-dd HH:mm:ss"。 example: 2018-12-26 21:07:23 type: string gmt_start: description: 活动开始时间。格式为"yyyy-MM-dd HH:mm:ss"。 example: 2017-12-26 21:07:23 type: string item_ids: description: "商品列表。\t说明:参加活动的商品列表不能为空,最大个数不能超过100。" example: "[\"2088xxxxx\",\"2088xxxx\"]" items: type: string type: array memo: description: "备注。\t说明:备注最大字符数不能超过500。" example: 备注 type: string min_cost: description: "使用门槛,即满 min_cost 元可用,使用门槛必须大于券面额,单位为元。\t说明:使用门槛格式必须为#.##。" example: "5.00" type: string obtain_manually: description: 是否手动领取,本期只支持true example: true type: boolean voucher_info: $ref: '#/components/schemas/MerchantActivityVoucherInfo' type: object KoubeiMarketingCampaignItemMerchantactivityCreateResponseModel: properties: activity_id: description: 运营活动id example: "208888888" type: string type: object KoubeiMarketingCampaignItemMerchantactivityModifyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object KoubeiMarketingCampaignItemMerchantactivityModifyModel: properties: activity_id: description: 活动Id example: 2018xxxx type: string external_callback_url: description: 外部回调地址 example: xxxx type: string gmt_end: description: "活动结束日期,只可以延长\r\t格式要求为:yyyy-MM-dd HH:mm:ss" example: 2017-12-26 21:07:23 type: string item_ids: description: 活动商品列表,只可以增加 example: "[\"2018xxxx\",\"2018xxxx\"]" items: type: string type: array memo: description: 备注 example: 备注 type: string voucher_info: $ref: '#/components/schemas/MerchantActivityModifyVoucherInfo' type: object KoubeiMarketingCampaignItemMerchantactivityModifyResponseModel: type: object KoubeiMarketingCampaignItemMerchantactivityQueryErrorResponseModel: properties: code: description: 错误码 enum: - PERMISSION_DENY - INVALID_PARAMETER - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object KoubeiMarketingCampaignItemMerchantactivityQueryResponseModel: properties: activity_id: description: 活动Id example: 2018xxxx type: string camp_id: description: 营销活动id example: 2018xxxx type: string count_limit: description: 活动优惠次数限制 example: 99 type: integer count_limit_per_day: description: 活动优惠单日次数限制 example: 99 type: integer count_limit_per_user: description: 活动单用户限次 example: 99 type: integer count_limit_per_user_per_day: description: 活动单用户单日限次 example: 99 type: integer crowd: description: "人群规则\r\tDEFAULT:全部用户\r\tONLINE_NEWCOMER:在线购买新人\r\tMEMBER:会\ 员" example: DEFAULT type: string deduct_amount: description: 代金券面额 example: "5.00" type: string external_unique_id: description: 外部Id example: xxxxxxx type: string gmt_end: description: "活动结束时间\r\t格式为:yyyy-MM-dd HH:mm:ss" example: 2017-12-26 21:07:23 type: string gmt_start: description: 活动开始时间,格式为:yyyy-MM-dd HH:mm:ss example: 2017-12-26 21:07:23 type: string item_ids: description: 商品列表 example: "[\"2018xxxx\",\"2018xxxx\"]" items: type: string type: array memo: description: 备注 example: 备注 type: string min_cost: description: 使用门槛,满X元可用,使用门槛必须大于券面额 example: "5.00" type: string obtain_manually: description: 是否手动领取,本期只支持true example: true type: boolean voucher_info: $ref: '#/components/schemas/MerchantActivityVoucherInfo' type: object KoubeiTradeOrderConsultErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - SHOP_NOT_EXIST - ILLEGAL_SHOP_STATUS - USER_NOT_EXIST - HAS_NO_PRIVILEGE - ACCESS_IS_FORBIDDEN type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object KoubeiTradeOrderConsultModel: properties: apdid_token: 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 type: string goods_info: description: 商品明细列表。注意:单品总金额不能大于订单金额 items: $ref: '#/components/schemas/GoodsInfo' type: array request_id: description: 唯一请求id,开放者请确保每次请求的唯一性。 example: 0ad1e47b1500473065347103327127 type: string shop_id: description: 支付宝门店编号 example: "2015051100077000000000000300" type: string total_amount: description: "订单总金额,单位元,精确到小数点后两位,取值范围[0.01,999999999]。\t注意:如果同时传入了【不可打折\ 金额】,【订单总金额】两者,则必须满足【不可打折金额】<=【订单总金额】。" example: "88.88" type: string undiscountable_amount: description: "不参与优惠计算的金额,单位为元,精确到小数点后两位,取值范围[0,999999999]。\t注意:如果同时传入了【不\ 可打折金额】、【订单总金额】,则必须满足【不可打折金额】<=【订单总金额】。" example: "10.00" type: string user_id: description: 支付宝用户 Id,用户在支付宝的唯一标识,以 2088 开头的 16 位纯数字组成。 example: "2088212151390950" type: string type: object KoubeiTradeOrderConsultResponseModel: properties: buyer_pay_amount: description: 用户实付金额 example: "10.00" type: string discount_detail: description: 优惠信息 items: $ref: '#/components/schemas/DiscountDetail' type: array m_card_detail: $ref: '#/components/schemas/MCardDetail' request_id: description: 请求中的request_id example: 874JKK4H5J43H3K35J4543K5J3K45J34KJ type: string type: object LabelContext: properties: a: $ref: '#/components/schemas/LabelFilter' type: object LabelFilter: properties: column_name: description: 标签组名,商户自定义的标签固定为label_id_list,支付宝开放的标签详见支付宝开放标签 example: label_id_list type: string op: description: 操作符,支持=、!=、in三个操作符;其中in表示是某几个标签中的一个 example: = type: string values: description: 标签数组,用于组装最后的表达式 example: "100509" items: type: string type: array type: object LabelRule: properties: label_id: description: 标签id type: string label_value: description: "标签值,当有多个取值时用英文\",\"分隔,不允许传入下划线\"_\"、竖线\"|\"或者空格\" \"和方括号\"\ [\"、\"]\"" type: string operator: description: 目前支持EQ(等于)、BETWEEN(范围)、IN(包含)三种操作符;每个标签支持的运算符可以通过标签列表查询接口获得。该字段允许为空,默认运算符为IN type: string type: object LibraryInfo: properties: id: description: 知识库ID example: 1 type: integer name: description: 知识库名称 example: 商品库 type: string tree_id: description: 类目ID example: 12 type: integer update_time: description: 修改时间 example: 2020-12-31 23:59:59 type: string type: object LifeLabel: properties: biz: description: 该标签支持的业务列表,menu表示个性化菜单,extension表示个性化扩展区,message表示消息触达 example: "menu,extension,message" type: string category: description: 标签类目 example: 基础标签 type: string data_type: description: 标签值数据类型 example: string type: string label_code: description: 标签英文代码 example: pps_user_gender type: string label_id: description: 标签id,唯一标识一个标签 example: "10000" type: string label_name: description: 标签名 example: 性别 type: string operator: description: 该标签支持的运算符 example: EQ type: string options: description: 每个取值的业务含义 items: $ref: '#/components/schemas/Option' type: array type: description: 标签类型,目前分为common(通用标签)、custom(生活号自定义标签)、cloud(云实验室标签) example: common type: string type: object LogisticInfo: properties: channel: description: 物流公司名称 example: 菜鸟 type: string detail: description: 物流详情 example: "[{\"time\":\"2022-09-09 09:09:09\",\"location\":\"北京\",\"operation\"\ :\"揽收\"}]" type: string logistic_id: description: 物流id example: "121414124124" type: string ship_area: description: 发货地 example: 北京 type: string ship_period: description: 发货时效 example: "48" type: string status: description: 物流状态 example: 已签收 type: string stop_update_time: description: 物流停更时间 example: "15" type: string type: object LogisticsAccountStatusDTO: properties: audit_desc: description: 商家在配送公司的账户的审核说明 type: string logistics_code: description: 配送公司物流编码。 type: string logistics_name: description: 配送公司名称。 type: string status: description: 账户状态,AUDITING:审核中,AUDIT_REJECT:审核驳回,VALID:已生效 type: string type: object LogisticsCompanyIstd: properties: logistics_code: description: 即时配送公司编码,由支付宝分配 example: FENGNIAO type: string service_codes: description: 即时配送公司服务代码列表 items: $ref: '#/components/schemas/ServiceCodeIstd' type: array type: object LogisticsCompanyResult: properties: logistics_code: description: 物流公司编码 example: FENGNIAO type: string logistics_name: description: 物流公司名称 example: 蜂鸟即配 type: string type: object LogisticsDetail: properties: logistics_type: description: 物流类型 example: EXPRESS type: string type: object LogisticsShopStatusDTO: properties: audit_desc: description: 商家在配送公司的账户的审核说明. type: string logistics_code: description: 配送公司物流编码。 type: string logistics_name: description: 配送公司名称。 type: string status: description: 门店状态,AUDITING:审核中,AUDIT_REJECT:审核驳回,VALID:已生效,UPDATING:更新中,WAIT_CREATE:待开通(存量门店若需要支持后面新增的配送公司,需要调用门店更新接口发起申请) type: string type: object MCardDetail: properties: available_amount: description: 储值卡可用余额 example: "100000.00" type: string name: description: 储值卡名称 example: 商家储值卡 type: string pay_amount: description: 储值卡支付金额 example: "1000.00" type: string type: object MarketingDeliveryDetail: properties: bind_id_list: description: 投放详情绑定的模板id列表 example: "[\"dsdadewdededede\",\"dedehduehdedue\"]" items: type: string type: array detail_id: description: 投放详情id example: MDDadsdsw344r43defdefefe34321a type: string gmt_end: description: 结束时间 example: 2022-01-01 00:00:00 type: string gmt_start: description: 开始时间 example: 2022-01-01 00:00:00 type: string name: description: 投放详情名称,取创建运营投放的title,未传title取券名称 example: 满200减20券 type: string status: description: 投放详情状态,INIT:下线状态,ON_LINE:上线状态 example: ON_LINE type: string type: object Matcher: properties: identity_card: description: 身份证号码,与user_id、mobile_no不能同时为空 type: string mobile_no: description: 手机号码,与user_id、identity_card不能同时为空 type: string open_id: description: 支付宝用户openid type: string user_id: description: 支付宝用户id,2088开头16位长度的字符串,与mobile_no、identity_card不能同时为空 type: string type: object Material: properties: articles: description: 图文消息子消息项集合,单条消息最多6个子项,否则会发送失败 items: $ref: '#/components/schemas/Article' type: array msg_type: description: 消息类型,text:文本类型,image-text:图文类型。当消息类型为text时,text参数必传,当消息类型为image-text时,articles参数必传 example: text type: string text: $ref: '#/components/schemas/Text' type: object MaterialCreateInfo: properties: content: description: 素材内容(素材地址或素材KEY) type: string type: description: 素材类型 type: string type: object MaterialField: properties: field_name: description: 素材字段名称,来源于素材规范定义的字段名称。注意一次素材提报中字段名称不能重复。 example: serviceBigPic type: string field_value: description: 素材字段值,素材字段提报的实际值,支持多值,具体的要求请查看素材规范或对应的产品文档。 example: "[\"A*WXYTAswgww\"]" items: type: string type: array type: object MaterialInfo: properties: content: description: 素材内容(素材地址或素材KEY) type: string material_id: description: 素材ID type: string type: description: 素材类型 type: string type: object MaterialModifyInfo: properties: content: description: 素材内容(素材地址或素材KEY) type: string type: description: 素材类型 type: string type: object McardNotifyMessage: properties: change_reason: description: "用户提醒信息,按如下格式拼装,需要ISV提供change_reason。\t\t积分变动模板:{change_reason},\ 您的积分有变动\t\t余额变动模板:{change_reason},您的余额有变动\t\t等级变更无需提供原因。" example: 由于你的消费 type: string ext_info: description: JSON格式扩展信息,主要是发送消息中的变量 example: "{\"key\":\"value\"}" type: string message_type: description: 消息类型,每种消息都定义了固定消息模板 example: OPEN_CARD type: string type: object McardStylInfo: properties: background_id: description: "背景图片Id,通过接口(alipay.offline.material.image.upload)上传图片\t\t\t\ \t图片说明:2M以内,格式:bmp、png、jpeg、jpg、gif;\t\t尺寸不小于1020*643px;\t\t图片不得有圆角,不得\ 拉伸变形" example: 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC type: string bg_color: description: 背景色 example: "rgb(55,112,179)" type: string logo_id: description: "logo的图片ID,通过接口(alipay.offline.material.image.upload)上传图片\t\ \t\t\t图片说明:1M以内,格式bmp、png、jpeg、jpg、gif;\t\t尺寸不小于500*500px的正方形;\t\t请优先使\ 用商家LOGO;" example: 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC type: string type: object McardTemplate: properties: card_type: description: 卡类型 example: OUT_MEMBER_CARD type: string gmt_create: description: 会员卡模板创建时间 example: 2018-01-11 15:12:23 type: string gmt_modified: description: 会员卡模板修改时间 example: 2018-01-11 15:12:23 type: string template_id: description: 会员卡模板ID example: "20160718000000001" type: string template_style_info: $ref: '#/components/schemas/TemplateStyleInfoDTO' type: object McardTemplateBenefit: properties: benefit_desc: description: 权益描述信息 items: type: string type: array end_date: description: "权益结束时间。\t\t注:在权益开始时间和结束时间范围内的权益才会认为是有效权益进行展示。" type: string ext_info: description: 会员卡模板权益扩展信息:JSON格式; openUrl 说明:跳转到商户的优惠活动页面 type: string start_date: description: 权益开始时间 type: string template_id: description: 会员卡模板ID type: string title: description: 权益标题 type: string type: object McardTemplateBenefitQuery: properties: benefit_desc: description: 权益描述信息 example: 使用会员卡享8折优惠 type: string benefit_id: description: 权益ID example: "20170322000000000068101000300041" type: string end_date: description: 权益结束时间 example: 2017-04-18 15:10:23 type: string ext_info: description: 会员卡模板权益扩展信息:JSON格式; openUrl 说明:跳转到商户的优惠活动页面 example: "{\"openUrl\":\"http://www.koubei.com\"}" type: string start_date: description: 权益开始时间 example: 2017-04-18 15:10:23 type: string template_id: description: 会员卡模板ID example: "20170322000000000068101000300041" type: string title: description: 权益标题 example: 使用会员卡消费享8折优惠 type: string type: object MccQueryInfo: properties: is_special: description: 是否特殊行业 example: true type: boolean mcc_level_1: description: 一级类目code example: A0001 type: string mcc_level_1_name: description: 商户一级类目名称 example: 商业生活服务 type: string mcc_level_2: description: 二级类目code example: B0001 type: string mcc_level_2_name: description: 二级类目名称 example: 中式正餐 type: string mcc_requirements: description: 特殊行业需要上传的资质 example: 申请成为该行业商家,请提交:1. 营业执照经营范围包含公路的投资、建设、收费、养护、管理、高速公路开发经营及服务 type: string special_qual_required: description: 是否需要特殊资质 example: false type: boolean type: object MdCodeInfoDTO: properties: code_status: description: "本次回传动态码的状态:\t\tSUCCESS: 本次发码成功\t\tFAIL_RETRY: 本次发码失败,且需要支付\ 宝重试(重新通知商户发码)\t\tFAIL_NOT_RETRY: 本次发码失败,且无需支付宝重试(无需重新通知商户发码)" type: string code_value: description: "动态码的码值:\t\tcode_status为SUCCESS时必填;\t\t基于此码值生成条形码或二维码用于扫码核销\ 。" type: string expire_time: description: "当前动态码的过期(失效)时间:\t\t code_status为SUCCESS时必填。" type: string time_stamp: description: "商户回传动态码的时间戳 (单位秒)。\t\t\t\t即商户调接口回传动态码时刻对应的long类型时间戳,用于区分不同\ 的发码请求。" type: integer type: object MemberExtInfo: properties: employee_id: description: 员工工号信息 example: "20221" type: string type: object MemberStatusRespDTO: properties: open_id: description: 用户支付宝会员openid example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string status: description: "员工当前状态:\t邀请中(PROCESSING)、正常(NORMAL)、不在企业中(OUT)" example: PROCESSING type: string user_id: description: 用户支付宝2088会员号 example: "20881213213213" type: string type: object MenuAnalysisData: properties: avg_click_user_cnt: description: 人均点击次数 example: "10.25" type: string click_cnt: description: 菜单点击次数 example: 10 type: integer click_user_cnt: description: 菜单点击人数 example: 20 type: integer date: description: 日期 example: "20171101" type: string menu_type: description: 菜单类型 ,iconDefault :图标菜单、default:文字菜单 example: default type: string name: description: 菜单名称 example: 菜单 type: string sub_name: description: 子菜单名称,文字菜单才有 example: 子菜单 type: string type: object MerchantActivityModifyVoucherInfo: properties: logo: description: "券logo\r\t券logo最大字符数不能超过64" example: 券logo type: string user_introductions: description: "使用须知\r\t券使用须知最大字符数不能超过256" example: 使用须知 type: string valid_days_range_to: description: "领取后, 第几天失效\r\tvalid_time_type=RELATIVE时有效且必填\r\t只允许增加领取后可用\ 天数" example: 12 type: integer valid_time_range_to: description: "有效期截止时间\r\tvalid_time_type=FIXED时有效且必填\r\t券有效结束时间格式必须为yyyy-MM-dd\ \ HH:mm:ss\r\t只允许延长固定时间的结束时间(支持到分)" example: 2017-05-12 21:59:22 type: string valid_time_type: description: "有效期类型:\r\t枚举值:RELATIVE/FIXED" example: RELATIVE type: string type: object MerchantActivityVoucherInfo: properties: logo: description: "券logo\r\t券logo最大字符数不能超过64" type: string sub_title: description: "子标题\r\t券子标题最大字符数不能超过256\r\t券子标题最小字符数不能低于2" type: string user_introductions: description: "使用须知\r\t券使用须知最大字符数不能超过1000" type: string valid_days_range_from: description: "领取后, 第几天开始生效\r\tvalid_time_type=RELATIVE时有效且必填" type: integer valid_days_range_to: description: "领取后, 第几天失效\r\tvalid_time_type=RELATIVE时有效且必填" type: integer valid_time_range_from: description: "有效期开始时间\r\tvalid_time_type=FIXED时有效且必填\r\t券有效开始时间格式必须为yyyy-MM-dd\ \ HH:mm:ss" type: string valid_time_range_to: description: "有效期截止时间\r\tvalid_time_type=FIXED时有效且必填\r\t券有效结束时间格式必须为yyyy-MM-dd\ \ HH:mm:ss" type: string valid_time_type: description: 有效期类型 type: string type: object MerchantBaseEnterOpenModel: properties: login_id: description: 登陆账号 example: "15587665764" type: string logo_info: description: 商户logo文件流信息,该字段为文件流经base64编码后得到的字符串。 example: /9j/4AAQSkZJRgABAQEASABIAAD/2wBDAA... type: string m_name: description: 商户品牌全称。 example: 蚂蚁金融服务集团 type: string m_short_name: description: 商户品牌简称 example: MYJF type: string type: object MerchantBrandListResult: properties: brand_list_result: description: 商户已有品牌 items: $ref: '#/components/schemas/BrandResult' type: array type: object MerchantCard: properties: balance: description: 资金卡余额,单位:元,精确到小数点后两位。 type: string biz_card_no: description: "支付宝业务卡号\t\t说明:\t\t1、开卡成功后返回该参数,需要保存留用;\t\t2、开卡/更新/删卡/查询卡接口\ 请求中不需要传该参数;" type: string custom_assets: description: 会员卡自定义资产值,只供特定业务使用,通常接入无需关注 type: string external_card_no: description: 用户在商户crm系统中的会员卡卡号,该参数必填。 type: string front_image_id: description: "卡面展示图片的图片ID,通过接口(alipay.offline.material.image.upload)上传图片\ \t\t\t\t这里预期展示的是个人照片;\t\t图片说明:1M以内,格式bmp、png、jpeg、jpg、gif;\t\t图片尺寸为230*295px,\ 可等比放大;" type: string front_text_list: description: "卡面文案列表,1项对应1行文案,最多只能传入4行文案;\r\t单行文案展现分为左右两部分,左边对应label字段,右\ 边对应value;\r\t形如: 学院 新闻学院" items: $ref: '#/components/schemas/CardFrontTextDTO' type: array level: description: 会员卡等级(由商户自定义,并可以在卡模板创建时,定义等级信息) type: string mdcode_info: $ref: '#/components/schemas/MdCodeInfoDTO' open_date: description: 会员卡开卡时间,格式为yyyy-MM-dd HH:mm:ss。会员卡更新时,该时间不支持修改。 type: string point: description: 会员卡积分,积分必须为数字型(可为浮点型,带2位小数点) type: string template_id: description: 会员卡更换不同的卡模板(该参数仅用在会员卡更新接口中) type: string valid_date: description: 会员卡有效期结束时间,格式为yyyy-MM-dd HH:mm:ss。会员卡更新时,该时间不支持修改。 type: string type: object MerchantCardMsgInfo: properties: changed_point: description: "本次消息通知的变动积分,积分必须为数字型(可为浮点型,带2位小数点),格式非法则不发送消息。例如:\t100,则代表\ 增加100积分。\t-100,则代表减少100积分。" example: "100.00" type: string type: object MerchantMenber: properties: birth: description: 生日 yyyy-MM-dd example: 2016-06-27 type: string cell: description: 手机号 example: "13000000000" type: string gende: description: 性别 example: MALE type: string name: description: 姓名 example: 李洋 type: string type: object MerchantOnlineActivityOpenModel: properties: activity_id: description: 活动Id example: 2018xxxx type: string camp_id: description: 营销活动Id example: 2018xxxx type: string count_limit: description: 活动优惠次数限制 example: 99 type: integer count_limit_per_day: description: 活动优惠单日次数限制 example: 99 type: integer count_limit_per_user: description: 活动单用户限次 example: 99 type: integer count_limit_per_user_per_day: description: 活动单用户单日限次 example: 99 type: integer crowd: description: "人群规则\r\tDEFAULT:全部用户\r\tONLINE_NEWCOMER:在线购买新人\r\tMEMBER:会\ 员" example: DEFAULT type: string deduct_amount: description: 代金券面额 example: "5.00" type: string external_unique_id: description: 外部Id example: xxxxxxx type: string gmt_end: description: "活动结束时间\r\t格式为:yyyy-MM-dd HH:mm:ss" example: 2018-12-26 21:07:23 type: string gmt_start: description: 活动开始时间,格式为:yyyy-MM-dd HH:mm:ss example: 2017-12-26 21:07:23 type: string item_ids: description: 商品列表 example: "[\"2018xxxx\",\"2018xxxx\"]" items: type: string type: array memo: description: 备注 example: 备注 type: string min_cost: description: 使用门槛,满X元可用,使用门槛必须大于券面额 example: "5.00" type: string obtain_manually: description: 是否手动领取,本期只支持true example: true type: boolean voucher_info: $ref: '#/components/schemas/MerchantActivityVoucherInfo' type: object MerchantQueryResult: properties: alias_name: description: 商户的别名,用户商户对客展示的名称 example: 商户小店 type: string cert_no: description: 商户认证证件号,企业营业执照号 example: 9133010608210550XR type: string city: description: 市名称 example: 杭州市 type: string detail_address: description: 商户经营详细地址 example: 文三路127号 type: string distinct: description: 区县名称 example: 西湖区 type: string mcc_code: description: 商户新版mcc code example: B0001 type: string merchant_type: description: 描述商户类型,个人-P/企业-B example: P type: string name: description: 商户认证名称信息 example: 支付宝商户 type: string province: description: 省名称 example: 浙江省 type: string type: object MerchantShopDTO: properties: shop_name: description: 门店名称,最长不超过256个字符。 example: 门店1 type: string shop_no: description: 门店编号。 example: "1000" type: string type: object MiniAppAuditReason: properties: audit_images: description: 审核图片列表 items: type: string type: array memos: description: 驳回原因列表 items: $ref: '#/components/schemas/MiniAppAuditReasonMemo' type: array type: object MiniAppAuditReasonMemo: properties: memo: description: 驳回原因 type: string memo_image_list: description: 规则图片链接 items: type: string type: array type: object MiniAppCategory: properties: category_id: description: 类目id type: string category_name: description: 类目名称 type: string has_child: description: 是否有子类目 type: boolean need_license: description: 是否需要营业执照 type: boolean need_out_door_pic: description: 是否需要门头照 type: boolean need_special_license: description: 是否需要特许营业执照 type: boolean parent_category_id: description: 父类目id type: string type: object MiniAppCategoryInfo: properties: first_category_id: description: 一级类目id type: string first_category_name: description: 一级类目名称 type: string second_category_id: description: 二级类目id type: string second_category_name: description: 二级类目名称 type: string third_category_id: description: 三级类目id,可空 type: string third_category_name: description: 三级类目名称,可空 type: string type: object MiniAppDeployResponse: properties: android_client_max: description: 安卓最大版本号 type: string android_client_min: description: 安卓最低版本号 type: string app_version: description: 小程序版本号 type: string bundle_id: description: 端标识 type: string deploy_version: description: 发布版本 type: string gmt_create: description: 创建时间 type: string gmt_modified: description: 修改时间 type: string ios_client_max: description: iOS最大版本号 type: string ios_client_min: description: iOS最小版本号 type: string mini_app_id: description: 小程序ID type: string package_size: description: 包大小 type: string status: description: "发布状态\t INVALID(\"INVALID\", \"非法\"),\t INIT(\"INIT\"\ , \"初始化状态\"),\t PRE_ONLINE(\"PRE_ONLINE\", \"预发\");\t GRAY(\"GRAY\"\ , \"灰度\"),\t ONLINE(\"ONLINE\", \"上架\"),\t ABANDON(\"ABANDON\",\ \ \"废弃\")," type: string type: object MiniAppPluginInfo: properties: package_url: description: 插件包地址 example: www.xxx.com type: string plugin_id: description: 插件id,即插件的唯一标识 example: "2016122304555146" type: string require_version: description: "小程序引用的插件版本,可以指定插件版本,1.2.3。也可以使用最新版本,*。推荐使用*" example: '*' type: string type: object MiniAppPluginReference: properties: lazy: description: 是否懒加载 type: boolean plugin_id: description: 插件id,即插件的唯一标识,形如小程序的appId type: string plugin_lazy: description: 是否懒加载 type: boolean plugin_version: description: 小程序引用的插件版本,可以指定插件版本,如:1.0.11;也可以填*,表示引用最新的插件版本,此时,当插件发布新版本后,小程序内的插件会自动更新到最新的版本。 type: string type: object MiniAppServiceInfo: properties: biz_status: description: 插件发布状态码,暂存100,风控审核200,运营审核300,等待上架400,已预发上架500,已上架501,已下架600,已驳回700 example: "200" type: string is_inner: description: 是否是内部标,true/false example: true type: boolean is_order: description: 是否订购,true/false example: true type: boolean isv_app_id: description: 三方应用appid example: "2021000146612019" type: string mini_app_id: description: 应用id example: "2021000146613280" type: string mini_app_name: description: 测试插件 example: 小程序名称 type: string seller_id: description: 卖家pid example: "2088301715777422" type: string seller_name: description: 卖家名 example: frikwj type: string service_code: description: 商品CODE example: AM010401000000070768 type: string service_logo: description: 服务图标 example: http://appstoreisvpic.alipayobjects.com/dev/50a1a2ad-c9af-4c24-92e0-84127857b634.jpg type: string service_name: description: 服务名 example: 崮城的小程序插件01插件 type: string service_slogan: description: 服务简介 example: 反倒是离开及发的克里斯 type: string show_type: description: 是否在服务市场透出,SHOW展示、HIDE隐藏 example: SHOW type: string type: object MiniPackageInfo: properties: doc_url: description: 功能包文档地址 example: http://doc.aaa.alipay.com type: string package_desc: description: 功能包描述 example: 通用能力 type: string package_name: description: 功能包名称 example: 小程序基础功能包 type: string package_open_type: description: 功能包开通方式 example: APPLY type: string status: description: 功能包签约状态 example: valid type: string type: object MiniVersionBaseInfo: properties: app_version: description: 版本号 example: 1.0.0 type: string build_source: description: 小程序所属来源 example: "01" type: string bundle_id: description: com.alipay.alipaywallet:支付宝,com.amap.app:高德 example: com.alipay.alipaywallet type: string dev_id: description: 小程序开发者ID example: 2088******** type: string gray_strategy: description: 小程序灰度值 example: p10 type: string mini_app_id: description: 小程序应用ID example: 2019******** type: string status: description: 小程序状态 example: INIT type: string type: object MiniappBrandAuditResult: properties: brand_id: description: 小程序提交品牌认证时的品牌id example: brand_id2020091684564595 type: string brand_name: description: 小程序提交品牌认证时的品牌名称 example: brand_namecr7officials type: string brand_status: description: 小程序提交品牌认证后的认证状态 example: AUDITING type: string has_brand: description: 小程序提交品牌认证是否认证成功 example: "true" type: string invalid_reason: description: 失效原因 example: 品牌授权日期已到 type: string reject_reason: description: 驳回原因 example: 申请人身份认证不通过 type: string type: object ModifyQuotaDetails: properties: quota_amount: description: 具体额度,单位:元。如金额为空,表示删除已有的额度设置,无已有额度设置则忽略。 example: "100" type: string quota_dimension: description: "额度维度\tMONTH/DAY/SINGLE\t分别代表月、日、单次" example: MONTH type: string role: description: "PAYER/PAYEE\t额度管控的角色,收or付款方,目前只支持付款方" example: PAYER type: string type: object MonitorHeartbeatSynErrorResponseModel: properties: code: description: 错误码 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object MonitorHeartbeatSynModel: properties: biz_content: description: 验签时该参数不做任何处理 example: "{任意值}" type: string type: object MonitorHeartbeatSynResponseModel: properties: pid: description: 商户pid example: 商户pid type: string type: object MoreInfoDTO: properties: descs: description: 描述,当operate_type为openNative必填 items: type: string type: array params: description: 扩展参数,需要URL地址回带的值,JSON格式(openweb时填) type: string title: description: 二级页面标题,只有当operate_type为openNative时有效。 type: string url: description: 超链接(选择openweb的时候必须填写url参数内容) type: string type: object MultiCurrencyMoneyOpenApi: properties: cent: description: 分 type: integer currency_value: description: 币种类型值 type: string type: object MutipleCurrencyDetail: properties: ext_info: description: 扩展字段 example: key=value type: string payment_amount: description: 支付金额,单位为该币种基础计价单位,如人民币为:元 example: "100.00" type: string payment_currency: description: 支付币种 example: CNY type: string settlement_amount: description: 清算金额,单位为该币种基础计价单位,如人民币为:元 example: "10.00" type: string settlement_currency: description: 清算币种 example: CNY type: string trans_amount: description: 转账金额,单位为该币种基础计价单位,如人民币为:元 example: "10.00" type: string trans_currency: description: 转账币种 example: CNY type: string type: object OcrNormalScanInfo: properties: invoice_code: description: 发票代码 type: string invoice_date: description: 开票时间 type: string invoice_no: description: 发票号码 type: string price: description: 金额(元) type: string remark: description: 明细事由 type: string type: object OcrPlaneScanInfo: properties: destination: description: 目的地 type: string flight_no: description: 航班号 type: string invoice_date: description: 乘机日期 type: string origin: description: 出发地 type: string passenger: description: 乘客 type: string price: description: 金额(元) type: string remark: description: 明细事由 type: string seat_class: description: 飞机舱位 type: string type: object OcrTaxiScanInfo: properties: get_off_time: description: 下车时间 type: string get_on_time: description: 上车时间 type: string invoice_code: description: 发票代码 type: string invoice_date: description: 开票时间 type: string invoice_no: description: 发票号码 type: string passenger: description: 乘客人 type: string price: description: 金额(元) type: string travel_dist: description: 乘车距离 type: string type: object OcrTrainScanInfo: properties: destination: description: 目的地 type: string invoice_date: description: 乘车日期 type: string origin: description: 出发地 type: string passenger: description: 乘客 type: string price: description: 金额(元) type: string remark: description: 明细事由 type: string seat_class: description: 座次 type: string train_no: description: 车次 type: string type: object OpenApiRefundFundDetailPojo: properties: funds: description: "退款资金明细\r\t详:\r\t若type为paySerialNo则funds为\r\t[{\"paySerialNo\"\ :\"支付流水1\",\"refundFee\":\"退款金额1\"},{\"paySerialNo\":\"支付流水2\",\"refundFee\"\ :\"退款金额2\"}]" example: "[{\"paySerialNo\":\"2018081603020111\",refundFee:\"12.00\"},{\"\ paySerialNo\":\"2018081603020112\",refundFee:\"2.00\"}]" items: type: string type: array trans_in: description: "收入方账户\r\t为空则原路退回" example: "2088101126708402" type: string trans_in_type: description: 收入方账户类型 example: bankAccount type: string type: description: "描述资金明细类型\r\t详:若type为paySerialNo\r\t则funds参数中体现的都为对应支付流水的退款\ 明细" example: paySerialNo type: string type: object OpenApiResponseHeader: properties: conversation_id: description: 会话id,对应请求中的conversation_id,若请求中conversation_id非空,则该值非空 example: 0b09fcb8-e2df-4d03-8265-e8384788f525 type: string response_id: description: 响应id,对应请求中的request_id。如果请求中request_id非空,则response_id非空。 example: aaf4d9d2-908b-4ccf-83ef-1b1a857e4296 type: string status_code: description: 自定义状态码 example: "200" type: string status_message: description: 状态信息 example: Not parsed programmatically. Example "Downstream system offline" type: string sub_status_code: description: 子状态码 example: "40601" type: string type: object OpenApiRoyaltyDetailInfoPojo: properties: amount: description: 分账的金额,单位为元 type: string amount_percentage: description: 分账信息中分账百分比。取值范围为大于0,少于或等于100的整数。 type: integer desc: description: 分账描述 type: string royalty_scene: description: 可选值:达人佣金、平台服务费、技术服务费、其他 type: string royalty_type: description: 分账类型. type: string trans_in: description: 收入方账户。如果收入方账户类型为userId,本参数为收入方的支付宝账号对应的支付宝唯一用户号,以2088开头的纯16位数字;如果收入方类型为cardAliasNo,本参数为收入方在支付宝绑定的卡编号;如果收入方类型为loginName,本参数为收入方的支付宝登录号; type: string trans_in_name: description: 分账收款方姓名,上送则进行姓名与支付宝账号的一致性校验,校验不一致则分账失败。不上送则不进行姓名校验 type: string trans_in_type: description: 收入方账户类型。 type: string trans_out: description: 支出方账户。如果支出方账户类型为userId,本参数为支出方的支付宝账号对应的支付宝唯一用户号,以2088开头的纯16位数字;如果支出方类型为loginName,本参数为支出方的支付宝登录号。 泛金融类商户分账时,该字段不要上送。 type: string trans_out_type: description: 支出方账户类型。 type: string type: object OpenApiSpecifiedChannelParamsPojo: properties: asset_type_code: description: 资产类型编码,具体传参值请联系技术进行分配。 example: ALICREDIT type: string inst_id: description: 机构描述 example: INST_ALIPAY type: string type: object OpenAppOperatorVo: properties: logon_id: description: 登录账号 example: 登录账号 type: string nick_name: description: 昵称 example: 张三 type: string portrait: description: 用户头像 example: htpt://**** type: string role: description: 角色 example: OPERATOR type: string status: description: 状态 example: VALID type: string user_id: description: 用户Id example: 用户Id type: string type: object OpenCertifyIdentifyInfo: properties: cert_name: description: 填入真实姓名 example: 张三 type: string cert_no: description: 填入姓名相匹配的证件号码 example: "260104197909275964" type: string cert_type: description: 当前仅支持IDENTITY_CARD example: IDENTITY_CARD type: string identity_type: description: 当前仅支持CERT_INFO example: CERT_INFO type: string phone_no: description: 选填手机号 example: "13000000000" type: string type: object OpenCertifyIdentityParam: properties: cert_digest: description: "cert_digest:\t身份信息摘要" example: 21232f297a57a5a743894a0e4a801fc3 type: string cert_name: description: "cert_name:\t填入真实姓名" example: 张三 type: string cert_no: description: "cert_no:\t填入姓名相匹配的证件号码" example: "260104197909275964" type: string cert_type: 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;\t6、外国人永久居留证,填PERMANENT_RESIDENCE_FOREIGNER;" example: IDENTITY_CARD type: string facial_picture_front: description: "facial_picture_front:\t活体人脸图片base64串,主要用于离线人脸比对" example: xydasf== type: string identity_type: description: "identity_type\t1.若本人验证,使用CERT_INFO;\t2.若代他人验证,使用AGENT_CERT_INFO;" example: CERT_INFO type: string open_id: description: "open_id:\t开放平台用户ID" example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string phone_no: description: "phone_no:\t填写姓名相匹配的手机号" example: "13000000000" type: string user_id: description: "user_id:\t支付宝用户ID" example: 2088xxxx type: string type: object OpenCertifyMerchantConfig: properties: auth_scope: description: 用于开放认证授权 example: xxx type: string auth_type: description: 用于指定授权类型,与auth_scope配合使用 example: xxx type: string face_reserve_strategy: description: 不传默认为reserve example: reserve type: string facial_picture_level: description: 若有特殊人脸等级采集要求,可指定等级 example: FIN0 type: string linked_merchant_app_id: description: 用于授权二级商户操作 example: 202134xxxx type: string linked_merchant_logo_url: description: 用于指定展示的商户logo example: http://xxx type: string linked_merchant_name: description: 用于指定展示的商户名称 example: 杭州xx公司 type: string out_put_facial_picture: description: 在拥有该权限前提下,用于商户控制是否透出活体人脸 example: true type: boolean return_url: description: 认证成功后需要跳转的地址,一般为商户业务页面;若无跳转地址可填空字符""; example: https://xxx type: string type: object OpenCertifyMerchantConfigs: properties: face_reserve_strategy: description: 不传默认为reserve example: reserve type: string return_url: description: 认证成功后需要跳转的地址,一般为商户业务页面;若无跳转地址可填空字符""。 example: https://xxx type: string type: object OpenFormFieldDO: properties: optional: description: "表单可选字段配置,common_fields属性定义一个表单字段数组,表单字段有效值列表与required字段有效值\ 列表相同。\t\t可选字段配置中不能含有必须字段配置的有效值。" example: |- { "common_fields": [ "OPEN_FORM_FIELD_GENDER" ] } type: string required: description: "表单必填字段配置,common_fields属性定义一个表单字段数组,字段有效值如下列表所示:\t\tOPEN_FORM_FIELD_MOBILE\ \ -- 手机号\t\tOPEN_FORM_FIELD_GENDER -- 性别\t\tOPEN_FORM_FIELD_NAME -- 姓名\ \t\tOPEN_FORM_FIELD_BIRTHDAY -- 生日\t\tOPEN_FORM_FIELD_IDCARD -- 身份证\t\t\ OPEN_FORM_FIELD_EMAIL -- 邮箱\t\tOPEN_FORM_FIELD_ADDRESS -- 地址\t\tOPEN_FORM_FIELD_CITY\ \ -- 城市\t\tOPEN_FORM_FIELD_IS_STUDENT -- 是否学生认证\t\tOPEN_FORM_FIELD_MEMBER_GRADE\ \ -- 会员等级" example: |- { "common_fields": [ "OPEN_FORM_FIELD_MOBILE" ] } type: string type: object OperationResultExtInfo: properties: activation_time: description: 激活时间 example: 2021-11-12 00:00:00 type: string device_no: description: 设备号 example: WW321314 type: string type: object Option: properties: text: description: 文本,通常用于理解对应的取值 example: 男 type: string value: description: 取值,通常使用简单的数字或字符串 example: "0" type: string type: object OrderApplyStatusBriefDTO: properties: apply_status: description: "SUCCESS:开票成功\tFAIL:开票失败\tPROCESS:开票中\tNOTEXIST:申请不存在" example: SUCCESS type: string order_no: description: 开票申请时传入订单号(支持主单号、子单号),不限是否为支付宝体内交易单号 example: "20200520110046966071" type: string type: object OrderDataDistributeInfo: properties: not_distribute_reason: description: 未分发到场景的具体原因。开发者可根据具体原因定位解决问题后发起重试。 example: 小程序id不存在 type: string scene_code: description: 分发场景code。 example: SERVICE_MSG type: string scene_name: description: 分发场景名,对应scene_code。 example: 订单消息 type: string type: object OrderDataSyncSuggestion: properties: message: description: 同步建议内容 example: 建议回传蚂蚁门店ID,以便在场景中更好的分发 type: string type: description: 同步建议类型 example: SHOP_ID_INVALID type: string type: object OrderExtInfo: properties: ext_key: description: 键值 type: string ext_value: description: 值 type: string type: object OrderExtIstd: properties: cash_on_delivery: description: 骑手应付金额 type: string cash_on_pickup: description: 骑手应收金额 type: string consumer_order_time: description: 消费者下单时间 type: string delivery_direction: description: 物流流向,1:从门店取件送至用户;2:从用户取件送至门店 type: integer delivery_type: description: "配送类型, 0: 即时单 1 预约单" type: integer desc: description: 备注 type: string expected_delivery_time: description: 期望派单时间 type: string expected_finish_time: description: 期望送达时间 type: string expected_pick_time: description: 期望取件时间 type: string insure_price: description: 保价金额 type: string is_direct_delivery: description: 是否直拿直送,1:直拿直送 0:非直拿直送 type: integer is_finish_code_needed: description: 是否需要收货码,1:需要 0:不需要 type: integer is_insured: description: 是否保价,1:保价 0:不保价 type: integer is_pickup_code_needed: description: 是否需要取货码,1:需要 0:不需要 type: integer poi_seq: description: 门店订单流水号 type: string service_code: description: 即时配送公司的服务代码 type: string type: object OrderExtIstdForPreOrder: properties: cash_on_delivery: description: 骑手应付金额 example: "15.00" type: string cash_on_pickup: description: 骑手应收金额 example: "13.00" type: string consumer_order_time: description: 消费者下单时间 example: 2020-06-01 13:23:00 type: string delivery_direction: description: 物流流向,1:从门店取件送至用户;2:从用户取件送至门店 example: 1 type: integer delivery_type: description: "配送类型, 0: 即时单 1 预约单" example: 0 type: integer desc: description: 备注 example: 备注 type: string expected_delivery_time: description: 期望派单时间 example: 2020-11-27 15:45:57 type: string expected_finish_time: description: 期望送达时间 example: 2020-06-01 13:23:00 type: string expected_pick_time: description: 期望取件时间 example: 2020-06-01 13:23:00 type: string insure_price: description: 保价金额 example: "100.00" type: string is_direct_delivery: description: 是否直拿直送,1:直拿直送 0:非直拿直送 example: 1 type: integer is_finish_code_needed: description: 是否需要收货码,1:需要 0:不需要 example: 0 type: integer is_insured: description: 是否保价,1:保价 0:不保价 example: 0 type: integer is_pickup_code_needed: description: 是否需要取货码,1:需要 0:不需要 example: 0 type: integer poi_seq: description: 门店订单流水号 example: xxx type: string service_code: description: 即时配送公司的服务代码 example: "001" type: string type: object OrderItem: properties: address: description: 店铺所在具体位置 example: 西湖区XX街XX号 type: string brand_name: description: 品牌名称 example: 肯德基 type: string category: description: 店铺品类 example: 咖啡 type: string city: description: 店铺所在的市 example: 杭州市 type: string city_code: description: 城市编码 example: "110100" type: string commodity_id: description: 订购的服务商品ID example: "201604290086730119" type: string contacts: description: 订单联系人 example: 张三 type: string creator: description: 门店创建人(已删除) example: 张三 type: string expire_date: description: 过期时间 example: 2016-01-01 00:00:01 type: string merchant_name: description: 商户名称 example: XX网络有限公司 type: string merchant_pid: description: 商户PID example: "2088101118588888" type: string mini_app_id: description: 小程序APPID,订购实体为小程序的场景该字段必填 example: "2017121800945174" type: string mini_app_name: description: 小程序应用名称,订购实体为小程序的场景该字段必填 example: 小张火锅店小程序 type: string online_time: description: 上架时间 example: 2016-01-01 00:01:01 type: string open_id_model: description: 应用用户标识模式 example: UID模式 type: string order_status: description: "TO_DO-未实施,DOING-实施中,TO_CONFIRM-待商户确认,CONFIRMED-商户已确认,DONE-已\ 完成,MERCHANT_REJECTED-商户已回绝,MERCHANT_CANCELLED-商户已取消,ISV_REJECTED-服务商已回\ 绝,ISV_CANCELLED-服务商已取消" example: DONE type: string phone_no: description: 订单所属人联系方式(手机或者座机) example: "13988888888" type: string province: description: 店铺所在的省份 example: 浙江省 type: string service_effect_date: description: 订购的服务有效期生效时间 example: 2023-04-03 12:01:45 type: string service_expire_date: description: 服务有效期截止时间 example: 2023-04-03 12:01:45 type: string shop_id: description: 店铺ID,订购实体为口碑门店的场景该字段必填 example: "2015052000077000000000182140" type: string shop_name: description: 店铺名称,订购实体为口碑门店的场景该字段必填 example: 小张火锅店 type: string shop_status: description: 店铺状态(ONLINE--已上架 OFFLINE--未上架 AVAILABLE--已开通 INIT--未开通 EXPIRED--已过期) example: ONLINE type: string status: description: 待服务商接单 example: MERCHANT_ORDED---待服务商接单 type: string type: object OrderJourneyElement: properties: arrival: $ref: '#/components/schemas/JourneyLocation' departure: $ref: '#/components/schemas/JourneyLocation' duration: description: 行程时长 example: "3600" type: string end_time: description: 结束时间 example: 2021-01-02 12:21:22 type: string end_time_desc: description: 结束时间描述(非结构化) example: 1月2号 type: string ext_info: description: 扩展信息 items: $ref: '#/components/schemas/OrderExtInfo' type: array functional_services: description: 功能服务列表 items: $ref: '#/components/schemas/FunctionalService' type: array passagers: description: 出行人 items: $ref: '#/components/schemas/UserInfomation' type: array service_change_info: $ref: '#/components/schemas/JourneyServiceChangeInfo' service_provider: $ref: '#/components/schemas/JourneyMerchantInfo' start_time: description: 开始时间 example: 2021-01-01 12:21:22 type: string start_time_desc: description: 开始时间描述(非结构化) example: 1月1号 type: string type: object OrderJourneyInfo: properties: action: description: 操作动作 example: DELETE type: string ext_info: description: 扩展信息 items: $ref: '#/components/schemas/OrderExtInfo' type: array journey_create_time: description: 行程创建时间 example: 2021-01-16 12:12:12 type: string journey_desc: description: 行程描述 example: 中国航空公司 C8888 上海-北京 type: string journey_elements: description: 行程元素列表 items: $ref: '#/components/schemas/OrderJourneyElement' type: array journey_index: description: 描述本行程为整个行程中的第几程 example: "2" type: string journey_modify_time: description: 行程修改时间 example: 2021-01-16 16:16:16 type: string merchant_journey_no: description: 商户行程单号 example: "202101130000001" type: string status: description: 行程状态 example: MERCHANT_FINISHED type: string status_desc: description: 行程状态描述 example: 已完成 type: string sub_type: description: 行程子类型 example: abroad type: string title: description: 行程标题 example: 标题 type: string type: description: 行程类型 example: airticket type: string type: object OrderLogisticsInformationRequest: properties: logistics_code: description: 物流公司编号。物流公司编号值请查看产品文档 example: STO type: string tracking_no: description: 物流单号 example: P201802091000000002W type: string type: object OrderPageQueryDTO: properties: page_data: description: 审核单数据信息 items: $ref: '#/components/schemas/ApplyOrderData' type: array page_num: description: 当前页码,默认第一页 example: "1" type: string page_size: description: 每页记录数,默认10 example: "2" type: string total_number: description: 记录总数 example: 1000 type: integer type: object OrderParticipantInfo: properties: ext_info: description: 扩展信息 items: $ref: '#/components/schemas/OrderExtInfo' type: array logo_material_id: description: "参与方logo素材id\t开发者通过 alipay.merchant.item.file.upload(商品文件上传\ 接口)上传图片,获取到对应的素材 ID( material_id )" example: "2019010100502200000000000001" type: string name: description: 参与方名称 example: 东方航空 type: string short_name: description: 参与方简称 example: 东航 type: string type: description: 参与方类型 example: 服务提供商 type: string uid: description: 参与方支付宝uid example: "2088202905583404" type: string type: object OrderShopInfo: properties: address: description: 店铺地址 type: string alipay_shop_id: description: 蚂蚁门店shop_id type: string ext_info: description: 门店其他业务属性,不同业务场景KEY枚举值不同,使用前请参考产品文档 items: $ref: '#/components/schemas/OrderExtInfo' type: array merchant_shop_id: description: "商户门店id\t支持英文、数字的组合" type: string merchant_shop_link_page: description: 店铺详情链接地址 type: string name: description: 店铺名称 type: string phone_num: description: 联系电话-支持固话或手机号 仅支持数字、+、- 。例如 手机:1380***1111、固话:021-888**888 type: string type: description: 仅当alipay_shop_id字段值为非标准蚂蚁门店时使用,其他场景无需传入 type: string type: object OrderStatusData: properties: order_id: description: 申请单ID type: string reject_reason: description: 驳回原因 type: string status: description: 申请状态 AGREE、REJECT、EDIT、AUDIT type: string type: object OrderVehicleInfo: properties: license_plate_no: description: 交通工具牌照号,如车牌号等 example: 沪A888888 type: string memo: description: 备注信息 example: 备注 type: string shift_no: description: 班次 example: 班次 type: string type: object OrderVoucherAvailableCityCode: properties: all_city: description: 是否全国。选择全国后,无须填写city_codes字段。系统默认填充全国全部城市信息。 type: boolean city_codes: description: 城市编码。请按照表格中内容填写。 (参考资料) items: type: string type: array type: object OrderVoucherAvailableCityCodeModify: properties: city_codes: description: 城市编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 (参考资料: http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/) example: "[\"100100\"]" items: type: string type: array type: object OrderVoucherAvailableScopeResult: properties: order_voucher_available_shop_result: $ref: '#/components/schemas/OrderVoucherAvailableShopResult' voucher_available_type: description: 可用范围类型。 type: string type: object OrderVoucherAvailableShop: properties: order_voucher_merchant_all_shop: $ref: '#/components/schemas/OrderVoucherMerchantAllShop' real_shop_ids: description: 代运营商业关系门店列表,列表中的门店id是调用接口alipay.business.relation.shop.create创建门店返回的real_shop_id 接口参数是列表类型。 items: type: string type: array shop_ids: description: 券可使用的门店列表。列表中的门店id是通过调用接口ant.merchant.expand.shop.create创建门店返回的支付宝门店id 接口参数是列表类型。 items: type: string type: array type: object OrderVoucherAvailableShopModify: properties: order_voucher_merchant_all_shop: $ref: '#/components/schemas/OrderVoucherMerchantAllShopModify' real_shop_ids: description: "券可使用的商业关系门店列表,列表中的门店id是调用接口alipay.business.relation.shop.create创\ 建门店返回的real_shop_id。" example: "[\"2018051000502000000011111111\",\"2018040200502000000011111111\"\ ,\"2018062800502000000022271997\"]" items: type: string type: array shop_ids: description: 券可使用的门店列表。列表中的门店id是通过调用接口ant.merchant.expand.shop.create创建门店返回的支付宝门店id 接口参数是列表类型。接口参数是列表类型。 example: "[\"2018051000502000000011111111\",\"2018040200502000000011111111\"\ ,\"2018062800502000000022271997\"]" items: type: string type: array type: object OrderVoucherAvailableShopResult: properties: order_voucher_merchant_all_shop_result: $ref: '#/components/schemas/OrderVoucherMerchantAllShopResult' real_shop_fail_infos: description: 请求失败的代运营商业关系门店详情 items: $ref: '#/components/schemas/OrderVoucherRealShopFailInfo' type: array shop_fail_infos: description: 请求失败的支付宝门店详情。 items: $ref: '#/components/schemas/OrderVoucherShopFailInfo' type: array success_real_shop_ids: description: 请求成功的代运营商业关系门店 items: type: string type: array success_shop_ids: description: 请求成功的支付宝门店。 items: type: string type: array type: object OrderVoucherMerchantAllShop: properties: exclude_shop_ids: description: 券不可使用的门店列表。指定商户全部门店可用时可通过该字段排除部分不可用门店。列表中的门店id是通过调用接口ant.merchant.expand.shop.create创建门店返回的支付宝门店id 接口参数是列表类型。 items: type: string type: array type: object OrderVoucherMerchantAllShopModify: properties: exclude_shop_ids: description: 券不可使用的门店列表。指定商户全部门店可用时可通过该字段排除部分不可用门店。列表中的门店id是通过调用接口ant.merchant.expand.shop.create创建门店返回的支付宝门店id 接口参数是列表类型。 example: "[\"2018051000502000000011111111\",\"2018040200502000000011111111\"\ ,\"2018062800502000000022271997\"]" items: type: string type: array type: object OrderVoucherMerchantAllShopResult: properties: exclude_shop_fail_infos: description: 请求失败的不可用门店详情。 items: $ref: '#/components/schemas/OrderVoucherShopFailInfo' type: array success_exclude_shop_ids: description: 请求成功的不可用门店列表。 items: type: string type: array type: object OrderVoucherRealShopFailInfo: properties: fail_message: description: 请求失败提示信息。 type: string fail_reasons: description: 请求失败原因。 items: type: string type: array real_shop_id: description: 请求失败的代运营商业关系门店 ID。 type: string type: object OrderVoucherShopFailInfo: properties: fail_message: description: 请求失败提示信息。 type: string fail_reasons: description: 请求失败的原因。 items: type: string type: array shop_id: description: 支付宝侧蚂蚁店铺 id。 type: string type: object OrderVoucherUseRuleResult: properties: voucher_available_scope_result: $ref: '#/components/schemas/OrderVoucherAvailableScopeResult' type: object Org: properties: org_id_number: description: 企业证件号 example: "913301087458306077" type: string org_id_type: description: 企业证件类型,(证件号不为空时必填,详见企业证件类型) example: CRED_ORG_USCC type: string org_legal_id_number: description: 法定代表人证件号 example: "330304199801011111" type: string org_legal_id_type: description: 法定代表人证件类型 example: CRED_PSN_CH_IDCARD type: string org_legal_name: description: 法定代表人名称 example: 折颜 type: string org_name: description: 企业名称 example: 杭州天谷信息科技有限公司 type: string third_party_user_id: description: 企业唯一标识:可传入平台机构id、企业证件号、企业邮箱等(个人用户与企业的唯一标识不可重复) example: "913301087458306077" type: string type: object OverseasExtendParams: properties: goods_detail: description: 商品明细列表 example: "[{\\\"goods_id\\\":\\\"001\\\",\\\"goods_amount\\\":\\\"100\\\"\ }]" type: string type: object PackageItemOpenInfo: properties: consume_output_info: $ref: '#/components/schemas/ConsumeOutputInfo' file_download_url: description: 发票文件下载链接 example: http://txffp.oss-cn-beijing.aliyuncs.com/zfb/11b7678a6ab04271afd2c4dfd*******?Expires=1574665315&OSSAccessKeyId=LTAIYAJb********&Signature=%2BD6AX5gswetzBdz************%3D type: string file_type: description: 文件类型,如pdf,ofd,jpg example: pdf type: string invoice_output_info: $ref: '#/components/schemas/InvoiceOutputInfo' item_source: description: 项目来源,如:ocr\einvoice\consume example: ocr type: string item_sub_type: description: 项目子类,如:出租车、火车、飞机等 example: 出租车 type: string item_type: description: 项目大类,如:餐饮美食、酒店住宿、差旅出行等 example: 餐饮美食 type: string 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' type: object PaidOuterCardCycleInfoDTO: properties: alipay_deduct_agreement: description: 支付宝用户签约协议号 type: string alipay_deduct_product_code: description: 支付宝代扣产品码 type: string alipay_deduct_scene: description: 支付宝代扣场景码 type: string close_reason: description: 关闭连续购买原因。 type: string cycle_type: description: 用户开通连续购买类型。 type: string open_status: description: 开通连续购买状态。 type: string type: object PaidOuterCardCycleSellConfDTO: properties: cycle_selling_url: description: 用户开通连续购买地址 type: string cycle_type: description: 周期购买类型。 items: type: string type: array support_cycle_sell: description: 是否支持用户连续购买 type: boolean type: object PaidOuterCardExtraInfoDTO: properties: action: description: 用户操作类型 type: string cycle_info: $ref: '#/components/schemas/PaidOuterCardCycleInfoDTO' purchase_info: $ref: '#/components/schemas/PaidOuterCardPurchaseInfoDTO' type: object PaidOuterCardManageUrlConfDTO: properties: cycle_manage_url: description: 连续购买管理地址。包括查看当前用户连续购买详情,关闭连续购买等功能 type: string downgrade_url: description: 付费外卡降级地址 type: string refund_url: description: 续费外卡退款地址 type: string renew_url: description: 付费外卡续费地址 type: string upgrade_url: description: 付费外卡升级地址 type: string type: object PaidOuterCardPriceDetailDTO: properties: desc: description: 方案描述 type: string price: description: 售卖具体金额。单位为元。支持两位小数。 type: string price_type: description: 售卖金额类型 type: string worth: description: 价值。单位为元。支持两位小数 type: string type: object PaidOuterCardPurchaseInfoDTO: properties: action_date: description: 用户购买、升级、降级、续费的操作时间。格式为:yyyy-MM-dd hh:mm:ss type: string alipay_trade_no: description: "支付宝交易号,由api: alipay.trade.create 返回" type: string out_trade_no: description: 商户订单号。与创建订单api:alipay.trade.create保持一致 type: string price: description: 用户购买金额。当购买/升级/续费场景必填,单位元,精确到小数点后2位 type: string source: description: 用户操作来源 type: string type: object PaidOuterCardSellingConfDTO: properties: end_date: description: "售卖结束时间。\t格式:yyyy-MM-dd HH:mm:ss\t如果永久有效则不传。" type: string price_detail: description: 售卖方案列表 items: $ref: '#/components/schemas/PaidOuterCardPriceDetailDTO' type: array selling_url: description: 售卖地址 type: string start_date: description: 售卖开始时间。格式:yyyy-MM-dd HH:mm:ss type: string type: object PaidOuterCardTemplateConfDTO: properties: cycle_selling_conf: $ref: '#/components/schemas/PaidOuterCardCycleSellConfDTO' manage_url_conf: $ref: '#/components/schemas/PaidOuterCardManageUrlConfDTO' open_selling_conf: $ref: '#/components/schemas/PaidOuterCardSellingConfDTO' type: object Participant: properties: bankcard_ext_info: $ref: '#/components/schemas/BankcardExtInfo' ext_info: description: 描述参与方信息的扩展属性,使用前请与支付宝工程师确认 type: string identity: description: 参与方的唯一标识 type: string identity_type: description: "参与方的标识类型,目前支持如下类型:\t1、ALIPAY_USER_ID 支付宝的会员ID\t2、ALIPAY_LOGON_ID:\ 支付宝登录号,支持邮箱和手机号格式\t3、ALIPAY_OPEN_ID:支付宝openid" type: string merchant_user_info: description: "商户端的用户信息描述,目前可指定如下属性:\r\tmerchant_user_id:商户端的用户唯一ID\r\tmerchant_user_name:\ 商户端的用户名\r\tmerchant_user_nickname:商户端的用户昵称\r\tmerchant_user_mobile:商户端\ 的手机号" type: string name: description: 参与方真实姓名,如果非空,将校验收款支付宝账号姓名一致性。当identity_type=ALIPAY_LOGON_ID时,本字段必填。 type: string type: object PayParams: properties: async_type: description: "普通异步支付, 传入该参数时,如果满足受理条件,会先同步受理支付,然后在异步调度推进支付\t\tNORMAL_ASYNC:\ \ 普通异步,受理成功之后,会在交易关单之前通过一定的策略重试\t\tNEAR_REAL_TIME_ASYNC: 准实时异步,受理成功之后,\ 会准实时发起1次调度" example: NORMAL_ASYNC type: string retry_type: description: "重试类型,当async_type传入NORMAL_ASYNC时,可以设置该参数,选择是否要重试,retry_type\ \ 可选,不设置时,可重试。\t● NONE_AND_CLOSETRADE:不重试,支付请求只会被执行1次,执行完成后如果交易未成功,会关闭\ 交易\t● NONE:不重试,支付请求只会被执行1次,执行完成后,不做任何处理。交易到达了timeout_express指定的时间后,关闭交\ 易。\t● RETY: 重试,支付请求在超时关单前,会按照策略重试" example: NONE type: string type: object PaymentFixVoucher: properties: amount: description: "面额,每张优惠券可以抵扣的金额。\t\t限制:\t1、币种为人民币,单位为元。小数点以后最多保留两位。\t2、取值范\ 围:0.1<=x<=3000" type: string floor_amount: description: 门槛金额。该字段不填写,认为无门槛。 type: string type: object PaymentInfoWithId: properties: payment_ids: description: 支付单id example: "[\"23232334343242424\",\"2323232323232\"]" items: type: string type: array type: description: 支付资金类型 example: PAY type: string type: object PaymentVoucherAlipayBalanceRechargeInfo: properties: logon_id: description: "出资的支付宝登录账号\t限制:\t1、登录账号和用户ID必须且只能二选一" type: string user_id: description: "出资的支付宝用户id\t限制:\t1、登录账号和用户ID必须且只能二选一" type: string type: object PaymentVoucherAvailableGoods: properties: goods_description: description: 商品描述信息。 用于券面展示,向用户介绍商品 example: 美味甜甜圈很美味 type: string goods_ids: description: 可优惠商品编码,商家自定义商品编码。当用户支付时,交易中的商品编码和支付券配置的商品编码有任一匹配时,可以使用优惠券。 example: "[\"apple-01\",\"apple-02\"]" items: type: string type: array goods_name: description: 商品名称 example: 美味甜甜圈 type: string type: object PaymentVoucherAvailableGoodsModify: properties: goods_ids: description: "可优惠商品编码,商家自定义商品编码。当用户支付时,交易中的商品编码和支付券配置的商品编码有任一匹配时,可以使用优惠券\ 。\t限制:\t1、核销商品范围只能增大不能减小" example: "[\"apple-01\",\"apple-02\"]" items: type: string type: array type: object PaymentVoucherAvailableMerchant: properties: available_pids: description: "优惠券可核销的直连商户PID\t\t限制:\t1、available_pids和available_smids至少二\ 选一。" example: "[\"2088102111111111\"]" items: type: string type: array available_smids: description: "优惠券可核销的间连商户SMID\t\t限制: \t1、available_pids和available_smids至\ 少二选一。" example: "[\"2088102111111111\"]" items: type: string type: array type: object PaymentVoucherAvailableMerchantModify: properties: available_pids: description: "优惠券可以核销的直连商户PID。默认不修改。\t 限制: \t1、核销商户范围只能增大不能减小。" example: "[\"2088102111111111\"]" items: type: string type: array available_smids: description: "优惠券可以核销的间连商户SMID。默认不修改。\t 限制: \t 1、核销商户范围只能增大不能减小。" example: "[\"2088102111111111\"]" items: type: string type: array type: object PaymentVoucherBelongMerchantInfo: properties: merchant_id: description: 商户支付宝id,默认品牌名和品牌logo将从该商户信息中获取 type: string merchant_id_type: description: 商户支付宝id类型。 type: string type: object PaymentVoucherBudgetInfo: properties: amount: description: "营销资金预算,单位元。\t总预算=优惠金额*总发券张数" type: string budget_type: description: "营销资金预算类型\t1、免充值:制券方无需提前充值资金,用户核销支付券时,直接从订单原价中扣除优惠减价金额,最终只将\ 用户实际支付的金额结算给核销商户,商户实收少于订单原价。\t2.预充值: 制券方需将优惠预算提前充值到支付宝指定营销账户中,用户核销支付券\ 时,系统从该账户可用余额中扣除优惠减价部分对应的资金,连同用户实际支付的资金,一并结算给核销商户,不影响实收。" type: string recharge_info: $ref: '#/components/schemas/PaymentVoucherRechargeInfo' type: object PaymentVoucherDisplayInfo: properties: brand_name: description: 商户品牌名称。 type: string customer_service_mobile: description: 商家客服电话,会展示在支付宝卡包券详情页。 type: string voucher_description: description: 用于说明详细的活动规则,会展示在支付宝卡包券详情页。 type: string voucher_detail_images: 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 type: array voucher_image: description: "券详情页封面图,会展示在用户支付宝卡包券详情页 需要通过 alipay.marketing.material.image.upload接\ 口上传图片,指定file_key为PROMO_VOUCHER_IMAGE,接口返回的resource_id即为该参数的值 限制: 该字段在\ 兑换券场景下必传 上传图片尺寸670*335,支持格式:png、jpg、jpeg、bmp,大小不超过2MB\t限制:\t1.指定可核销商品\ (available_goods)时必传" type: string type: object PaymentVoucherRechargeInfo: properties: alipay_balance_recharge_info: $ref: '#/components/schemas/PaymentVoucherAlipayBalanceRechargeInfo' recharge_type: description: 预充值方式 type: string type: object PaymentVoucherSendRule: properties: max_quantity_by_day: description: "设置此字段,允许指定单天最大发券数量。\t\t限制:\t每天发放张数*活动天数应小于等于优惠券发放总量" type: integer natural_person_limit: description: "限制相同身份证号领取次数(voucher_quantity_limit_per_user)。默认false不限制。\t\ 枚举值\ttrue:是\tfalse:否" type: boolean phone_number_limit: description: "限制相同手机号领取次数(voucher_quantity_limit_per_user)。默认false不限制\t枚\ 举值\ttrue:是\tfalse:否" type: boolean real_name_limit: description: "限制支付宝实名用户才能领取支付券,默认为false表示不限制\t枚举值\ttrue\\false" type: boolean voucher_quantity: description: "发行券的总数量。\t限制:\t1、发放总个数最少1个\t2、发放总个数最多99999999个" type: integer voucher_quantity_limit_per_user: description: "每人领取限制。 默认按照支付宝账号进行领取限制; \t不填写或填入0表示没有领取限制." type: integer voucher_quantity_limit_per_user_period_type: description: "周期限领配置,限制每人在固定周期内领取张数(voucher_quantity_limit_per_user),默认\ LIFE_CYCLE" type: string type: object PaymentVoucherUseRule: properties: available_app_ids: description: "可核销的支付宝小程序id\t\t限制: \t1、必须是支付宝小程序\t2、如果包含重复的小程序id会自动进行去重操作\ 。" example: "[\"2021238412323412\"]" items: type: string type: array available_goods: $ref: '#/components/schemas/PaymentVoucherAvailableGoods' available_merchant: $ref: '#/components/schemas/PaymentVoucherAvailableMerchant' available_store_ids: description: "可核销支付门店id。\t限制: \t1、available_store_ids中的门店id必须是支付宝门店id。 \t\ 2、available_store_ids如果包含重复的门店id会自动进行去重操作。" example: "[\"2018051000502000000011111111\",\"2018040200502000000011111111\"\ ,\"2018062800502000000022271997\"]" items: type: string type: array fix_voucher: $ref: '#/components/schemas/PaymentFixVoucher' unavailable_goods_ids: description: "不可核销商品编码,商家自定义商品编码。当用户支付时,交易中的商品编码和支付券配置的商品编码有任一匹配时,不可以使用优\ 惠券。\t\t限制:\t1、available_goods与unavailable_goods_ids只能二选一或者同时为空" example: "['apple-03','apple-04']" items: type: string type: array use_mode: description: "核销跳转方式,默认CAN_USE(详情页展示可使用按钮)" example: SELF_LINK type: string use_url: description: "核销跳转链接\t限制:\t1、只有use_mode为SELF_LINK时该值有效且必传。\t2、核销跳转链接必须是支\ 付宝小程序链接。" example: alipays://platformapi/startapp?appId=201911136XXXXX&noneExit=true type: string voucher_quantity_limit_per_user: description: 每个支付宝账号的核销次数限制。 默认不限制 example: 1 type: integer voucher_quantity_limit_per_user_period_type: description: 核销次数限制周期配置。默认值LIFE_CYCLE表示限制每个支付宝账号在整个活动期间核销次数。 example: DAY type: string voucher_valid_period: $ref: '#/components/schemas/PaymentVoucherValidPeriod' type: object PaymentVoucherUseRuleDetail: properties: fix_voucher: $ref: '#/components/schemas/PaymentFixVoucher' use_mode: description: "核销跳转方式,默认CAN_USE(详情页展示可使用按钮)" example: SELF_LINK type: string use_url: description: "核销跳转链接 限制: 1、只有use_mode为SELF_LINK时该值有效且必传。 2、核销跳转链接必须是支付宝小\ 程序链接。" example: alipays://platformapi/startapp?appId=201911136XXXXX&noneExit=true type: string voucher_quantity_limit_per_user: description: 每个支付宝账号的核销次数限制。 默认不限制 example: 1 type: integer voucher_quantity_limit_per_user_period_type: description: 核销次数限制周期配置。默认值LIFE_CYCLE表示限制每个支付宝账号在整个活动期间核销次数。 example: DAY type: string voucher_valid_period: $ref: '#/components/schemas/PaymentVoucherValidPeriod' type: object PaymentVoucherUseRuleModify: properties: available_app_ids: description: "可核销的支付宝小程序id \t\t限制: \t1、必须是支付宝小程序 \t2、如果包含重复的小程序id会自动进行去重\ 操作。\t3、可核销小程序范围只能扩大不能缩小" example: "[\"2021238412323412\"]" type: string available_goods: $ref: '#/components/schemas/PaymentVoucherAvailableGoodsModify' available_merchant: $ref: '#/components/schemas/PaymentVoucherAvailableMerchantModify' available_store_ids: description: "可核销支付门店id。 \t\t限制: \t1、available_store_ids中的门店id必须是支付宝门店id。\ \ \t2、available_store_ids如果包含重复的门店id会自动进行去重操作。\t3、可核销门店范围只能扩大不能缩小" example: "[\"2018051000502000000011111111\",\"2018040200502000000011111111\"\ ,\"2018062800502000000022271997\"]" type: string voucher_valid_period: $ref: '#/components/schemas/PaymentVoucherValidPeriodModify' type: object PaymentVoucherValidPeriod: properties: type: description: 券有效期类型 type: string valid_begin_time: description: "券可使用的开始时间。\t\t格式为:yyyy-MM-dd HH:mm:ss\t\t限制:\ttype为ABSOLUTE时\ 该字段必填。" type: string valid_days_after_receive: description: "券生效后N天内可以使用。\t\t可以配合wait_days_after_receive字段使用。\t\t限制:\t\ 1.type为RELATIVE时必填。\t2.valid_days_after_receive必须大于0。" type: integer valid_end_time: description: "券可使用的结束时间。\t\t格式为yyyy-MM-dd HH:mm:ss\t\t限制:\t1、type为ABSOLUTE必\ 填。\t2、券可使用的结束时间valid_end_time必须大于券的发放结束时间publish_end_time" type: string wait_days_after_receive: description: "用户领券后需要等待N天,券才可以生效。默认用户领券后立刻生效。\t\t限制:\t1、type为RELATIVE时可选\ 。" type: integer type: object PaymentVoucherValidPeriodModify: properties: valid_days_after_receive: description: 券生效后N天内可以使用。 限制: type为RELATIVE时可修改。 valid_days_after_receive必须大于0。 修改该时间,只允许延长,不允许缩短。 example: 3 type: integer valid_end_time: description: 券可使用的结束时间。 格式为yyyy-MM-dd HH:mm:ss 限制: type为ABSOLUTE可修改。 券可使用的结束时间valid_end_time 必须大于 券的发放结束时间 publish_end_time 修改券可使用的结束时间,只能延长,不允许缩短。 example: 2017-01-13 23:59:59 type: string type: object PeriodRuleParams: properties: execute_time: description: "首次执行时间execute_time是周期扣款产品必填,即商户发起首次扣款的时间。精确到日,格式为yyyy-MM-dd\t\ 结合其他必填的扣款周期参数,会确定商户以后的扣款计划。发起扣款的时间需符合这里的扣款计划。" type: string period: description: 周期数period是周期扣款产品必填。与另一参数period_type组合使用确定扣款周期,例如period_type为DAY,period=90,则扣款周期为90天。 type: integer period_type: 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日),以此避免有些月份可能不存在对应日期的情况。" type: string single_amount: description: 单次扣款最大金额single_amount是周期扣款产品必填,即每次发起扣款时限制的最大金额,单位为元。商户每次发起扣款都不允许大于此金额。 type: string total_amount: description: 总金额限制,单位为元。如果传入此参数,商户多次扣款的累计金额不允许超过此金额。 type: string total_payments: description: 总扣款次数。如果传入此参数,则商户成功扣款的次数不能超过此次数限制(扣款失败不计入)。 type: integer type: object PluginBetaItemInfo: properties: app_name: description: 小程序名称 example: 小程序名称 type: string beta_status: description: 被邀测状态,待确认WAITCHECK/确认CHECKED/拒绝REJECT example: WAITCHECK type: string memo: description: 拒绝原因 example: 拒绝原因 type: string mini_app_id: description: 小程序ID example: 2019**** type: string plugin_id: description: 插件id example: 2088xxx type: string plugin_version: description: 插件版本 example: 0.0.1 type: string qr_code_url: description: 邀测二维码 example: https://mobilecodec.alipay.com/show.htm?code=0le14985b5hyws8pcbyah5f type: string type: object PluginUseConfigInfo: properties: bundle_id: description: 端 example: com.alipay.alipaywallet type: string gray_code: description: 灰度策略 example: p1 type: string plugin_develop_version: description: 插件研发版本 example: 0.0.3 type: string status: description: GRAY(灰度中)/RELEASE(在线状态) example: GRAY type: string type: object PluginUseRelationInfo: properties: beta_memo: description: 邀测驳回原因 example: 测试不通过 type: string beta_plugin_version: description: 邀测插件版本号 example: 0.0.3 type: string beta_qr_code_url: description: 邀测二维码 example: https://mobilecodec.alipay.com/show.htm?code=0le14985b5hyws8pcbyah5f type: string beta_status: description: WAITCHECK-待确认;CHECKED-确认;REJECT-拒绝 example: WAITCHECK type: string gmt_active: description: 激活时间 example: 2018-05-10 15:10:25 type: string gmt_create: description: 订购时间 example: 2018-05-10 15:10:25 type: string gmt_invalid: description: 插件失效时间 example: 9999-12-31 00:00:00 type: string mini_app_id: description: 应用ID example: "2012211102012056" type: string plugin_deploy_version: description: 插件构建版本 example: 0.2.1812171829.32 type: string plugin_id: description: 插件ID example: "2012211102012088" type: string plugin_status: description: 插件状态,取值包括EXECUTING/WAIT_WORKING/WORKING/STOP_WORKING/WAIT_BUY example: WORKING type: string plugin_use_config_info_list: description: 分端版本配置信息列表 items: $ref: '#/components/schemas/PluginUseConfigInfo' type: array plugin_version: description: 插件版本 example: 0.0.1 type: string run_mode_type: description: 插件运行状态,取值包括ONLINE/TRIAL/REVIEW/DEBUG example: ONLINE type: string source_from: description: 渠道来源,取值包括SHOP_MINI/PLUGIN_DEBUG/PLUGIN_TRIAL/PLUGIN_AUDIT/GENERAL_SHOP_ID example: PLUGIN_DEBUG type: string type: object PointCard: properties: desc: description: 工具的描述 example: 集点卡的功能描述 type: string end_time: description: 工具的有效期的结束时间(必须晚于活动的结束时间) example: 2016-10-01 00:00:00 type: string logo: description: 工具的LOGO文件ID example: 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC type: string name: description: 工具的名称 example: 集点卡 type: string start_time: description: 工具的有效期的起始时间 example: 2016-05-01 00:00:00 type: string type: description: "工具类型,目前支持:\r\t集点卡:POINT_CARD" example: POINT_CARD type: string type: object PostPayment: properties: amount: description: 后付费金额,单位为:元(人民币),精确到小数点后两位。 type: string description: description: 计费说明 type: string name: description: 后付费项目名称 type: string type: object PreCreateWaybillIstd: properties: coupon_fee: description: 优惠券费用 example: "1.00" type: string deliver_fee: description: 运费 example: "10.00" type: string dispatch_duration: description: 预计骑手还剩多久接单(单位:秒) example: 300 type: integer distance: description: 配送距离(单位:米) example: 1000 type: integer fee: description: 实际运费 example: "9.00" type: string insurance_fee: description: 保价费用 example: "0.00" type: string logistics_code: description: 即时配送公司编码 example: FENGNIAO type: string logistics_token: description: 配送公司可以返回此字段,当商家下单时候带上这个字段,保证在一段时间内运费不变 example: token001 type: string pay_amount: description: 支付金额,实际扣减的费用以此字段为准 example: "9.00" type: string service_code: description: 即时配送公司服务代码 example: fengniao01 type: string third_code: description: 即时配送公司返回的响应码。10000表示业务处理成功,40004表示业务处理失败。 example: "10000" type: string third_sub_code: description: 即时配送公司返回的错误码 example: xxx type: string third_sub_msg: description: 即时配送公司返回的错误描述 example: xxx type: string type: object PreOrderExtInfo: properties: brand_id: description: 品牌id example: "123" type: string brand_name: description: 品牌名称 example: 豫章人家 type: string channel: description: 请求渠道 example: "APP, AlipayMiniApp, Taobao" type: string order_feature: description: "单据属性,风控系统使用" example: merchant_id@@@2088123456123456|||merchant_name@@@张三营业厅 type: string type: object PresetPayToolInfo: properties: amount: description: 前置资产金额。单位:元。 example: "12.21" items: type: string type: array assert_type_code: description: 前置资产类型编码,和收单支付传入的preset_pay_tool里面的类型编码保持一致。 example: HEMA type: string type: object ProductAgentStatusInfo: properties: product_code: description: 产品编码 example: FACE_TO_FACE_PAYMENT type: string product_name: description: 产品名称 example: 当面付收单 type: string reject_reason: description: 产品被驳回的原因 example: 请您在签约时上传与账户主体一致的证件。 type: string status: description: none:未签约,表示还没有签约该产品 valid:已生效,表示合约已经生效,不需要再签约了 restrictValid:受限生效,表示合约已经生效,但是资料不全,功能受限 audit:审核中,已经有合约在审核中,请等待审核完成 waitConfirm:待商户确认协议,合约已经审核通过,需要商户确认后合约才生效 auditReject:审核未通过 invalid:合约失效,曾经签过合约,但已经失效了,可以重新发起签约 restrictInvalid:受限失效,受限合约失效了 example: none|valid|restrictValid... type: string type: object ProductInviteStatusInfo: properties: product_code: description: 产品编码 example: FACE_TO_FACE_PAYMENT type: string product_name: description: 产品名称 example: 当面付收单 type: string status: description: "NONE:未签约,表示还没有签约该产品\tMERCHANT_AUDITING:审核中,已经有合约在审核中,请等待审核\ 完成\tMERCHANT_CONFIRM_SUCCESS:已生效,表示合约已经生效,不需要再签约了\tMERCHANT_APPLY_ORDER_CANCELED:\ 审核未通过" example: NONE|MERCHANT_AUDITING|MERCHANT_CONFIRM_SUCCESS|MERCHANT_APPLY_ORDER_CANCELED type: string type: object ProductSignStatusInfo: properties: product_code: description: 产品编码 example: FACE_TO_FACE_PAYMENT type: string product_name: description: 产品名称 example: 当面付收单 type: string status: 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 type: string type: object ProjectRuleInfo: properties: effective_end_date: description: 有效期截止 example: 2021-03-02 17:00:00 type: string effective_start_date: description: 有效期起始 example: 2021-03-01 19:00:00 type: string employee_list: description: 切换open_id前请使用此字段:员工uid列表 example: "[\"2088123412341234\"]" items: type: string type: array employee_open_id_list: description: 切换open_id后请使用此字段:员工open_id列表 example: "[\"abcdxxxx\"]" items: type: string type: array expense_ctrl_rule_info_group_list: description: 规则组列表 items: $ref: '#/components/schemas/ExpenseCtrRuleGroupInfo' type: array project_id: description: 项目id example: "1100" type: string project_name: description: 项目名称 example: 费控项目 type: string type: object PromiseDetail: properties: auth_status: description: 授权状态 example: true type: boolean create_time: description: 任务创建时间 example: yyyy-mm-dd hh:mm:ss type: string end_time: description: 任务结束时间 example: yyyy-mm-dd hh:mm:ss type: string final_time: description: 任务到达终态的时间 example: yyyy-mm-dd hh:mm:ss type: string finish_periods: description: 任务完成期数 example: 1 type: integer merchant_id: description: 芝麻侧的商户id example: lefit type: string merchant_logo: description: 商户logo example: https://icon.png type: string merchant_name: description: 商户名称 example: 乐刻 type: string out_biz_no: description: 生活记录加入时的外部业务号 example: "84927419" type: string period_type: description: 周期类型 example: multi type: string promise_name: description: 生活记录模板名称 example: 每周攒钱,完成心愿 type: string record_id: description: 生活记录主记录id example: "2022101865652385257" type: string record_status: description: 主任务状态 example: PROCESSING、UN_FINISH、CANCELED、FINISH,分别对应进行中、未完成、已取消、已完成 type: string start_time: description: 任务开始时间 example: yyyy-mm-dd hh:mm:ss type: string sub_record_status: description: 子记录状态 example: PROCESSING、UN_FINISH、CANCELED、FINISH,分别对应进行中、未完成、已取消、已完成 type: string sub_title: description: 副标题 example: 加入后7天内完成1次攒钱 type: string template_id: description: 生活记录模板id example: save_money_every_week type: string total_periods: description: 任务总期数 example: 4 type: integer type: object PromoDeliveryInfo: properties: activity_id: description: 活动id example: "2016042700826004508401111111" type: string booth_code: description: 展位码:boothCode表达的是具体渠道所属的展位码。例如:支付结果页PAYMENT_RESULT example: PAYMENT_RESULT type: string channel: description: 可投放的渠道标识. example: 2088xxxxxxxxx type: string channel_name: description: 渠道名称 example: 支付宝官方渠道 type: string delivery_status: description: 投放状态。 example: ACTIVE type: string type: object PromoOperatorInfo: properties: operator_id: description: 操作人id type: string operator_type: description: 操作人类型。SALES:口碑内部小二;MER:商户;MER_OPERATOR:商户员工;PROVIDER:服务商;PROVIDER_STAFF:服务商员工; type: string type: object PromoPageInfo: properties: page_num: description: 页码 example: 1 type: integer page_size: description: 每页大小 example: 20 type: integer type: object PromoPageResult: properties: page_num: description: 页码 example: 10 type: integer page_size: description: 每页多少条 example: 10 type: integer total_count: description: 总条数 example: 10000 type: integer total_pages: description: 总共有多少页 example: 10 type: integer type: object PromoParam: properties: actual_order_time: description: 存在延迟扣款这一类的场景,用这个时间表明用户发生交易的时间,比如说,在公交地铁场景,用户刷码出站的时间,和商户上送交易的时间是不一样的。 example: 2018-09-25 22:47:33 type: string type: object PromoTool: properties: point_card: $ref: '#/components/schemas/PointCard' send_rule: $ref: '#/components/schemas/SendRule' status: description: 单个营销工具的生效状态,当在招商部分券失效后会使用这个字段 example: STARTED type: string voucher: $ref: '#/components/schemas/Voucher' voucher_no: description: "营销工具uid,创建营销活动时无需设置" example: "2342343245234234" type: string type: object PromotePageData: properties: biz_no: description: 留资流水号 example: Zybnom890437Mvcu type: string encrypt_uid: description: 加密uid,用于深转数据回传 example: X5PXuiJn+3OPKZFrcK20Szc54k8OsWOfpRzXqbcslLY= type: string property_list: description: 留资属性实例数据列表 items: $ref: '#/components/schemas/PromotePagePropertyInstance' type: array type: object PromotePageDetail: properties: gmt_create: description: 推广页创建时间,格式:yyyy-mm-dd hh:mm:ss example: 2020-12-12 12:20:30 type: string id: description: 推广页id example: 2018374 type: integer name: description: 推广页名称 example: 测试留资推广页 type: string property_list: description: 推广留资schema items: $ref: '#/components/schemas/PromotePageProperty' type: array type: description: 推广页类型:COLLECT_INFO - 普通留资;TRADE - 交易留资 example: COLLECT_INFO type: string type: object PromotePageProperty: properties: key: description: 留资属性key example: orderId type: string name: description: 留资属性名称 example: 订单号 type: string type: object PromotePagePropertyInstance: properties: key: description: 留资属性key example: orderId type: string name: description: 留资属性名称 example: 订单号 type: string value: description: 留资属性实例值 example: A27904vbvjlmn type: string type: object PromotionRelationDTO: properties: apply_reason: description: 申请推广时填写的申请理由 example: XXX type: string commodity_id: description: 服务商品ID example: SS010101000000003954 type: string commodity_name: description: 服务商品名称 example: 测试服务 type: string create_time: description: 推广关系创建时间 example: 2020-10-12 12:10:10 type: string promoter_contact_name: description: 推广服务商联系人名称 example: 张三 type: string promoter_contact_phone: description: 推广服务商联系电话 example: 136xxxxxxxx type: string promoter_name: description: 推广服务商的名称 example: xx商户 type: string promoter_pid: description: 推广服务商的pid example: "2088301324945205" type: string promotion_id: description: 推广任务id example: "2018052401048283" type: string promotion_name: description: 推广任务的名称 example: 测试推广任务 type: string type: object PromotionTaskRelation: properties: apply_reason: description: 申请推广时填写的申请理由 example: XXX type: string commodity_id: description: 服务商品ID example: SS010101000000003954 type: string commodity_name: description: 服务商品名称 example: 测试服务 type: string create_time: description: 推广关系创建时间 example: 2020-10-12 12:10:10 type: string promoter_contact_name: description: 推广服务商联系人名称 example: 张三 type: string promoter_contact_phone: description: 推广服务商联系电话 example: 136xxxxxxxx type: string promoter_name: description: 推广服务商的名称 example: xx商户 type: string promoter_pid: description: 推广服务商的pid example: "2088301324945205" type: string promotion_id: description: 推广任务id example: "2018052401048283" type: string promotion_name: description: 推广任务的名称 example: 测试推广任务 type: string type: object PubChannelDTO: properties: ext_info: description: 扩展信息,无需配置 type: string pub_channel: description: 投放渠道类型 type: string type: object PublicAuditStatus: properties: desc: description: 审核状态描述,如果审核驳回则有相关的驳回理由 example: logo不符合规范 type: string status: description: AUDITING:审核中,AUDIT_FAILED:审核驳回,AUDIT_SUCCESS:审核通过,AUDIT_NORMAL:无审核记录 example: AUDITING type: string type: description: NAME:名称、AVATAR:头像、NAME_AVATAR:名称与头像、INTRODUCTION:简介 example: NAME type: string type: object PublicLabel: properties: count: description: 标签用户量 example: 100000 type: integer id: description: 标签编号 example: "10005556" type: string name: description: 标签名称 example: 标签1 type: string type: object PublishChannel: properties: config: description: "当type为MERCHANT_CROWD时,config需填入口令送的密码和图片,样例如下:\"config\":\"\ {\\\"PASSWORD\\\":\\\"口令送密码\\\",\\\"BACKGROUND_LOGO\\\":\\\"1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC\\\ \"}\"" example: "{\"PASSWORD\":\"口令送密码\",\"BACKGROUND_LOGO\":\"1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC\"\ }" type: string ext_info: description: 扩展信息,无需配置 example: '"key":"value"' type: string name: description: 渠道名称 example: 投放到店铺 type: string type: 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 type: string type: object QrCodeRouteGroup: properties: mode: 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 type: string route_group: description: 路由组id(参数说明:该参数可用于alipay.open.mini.qrcode.unbind接口入参route_group,进行二维码解绑) example: eda224f222194cc48c27a3e6319fd331 type: string route_url: description: 规则路由地址 example: https://www.alipay.com/isv/ type: string type: object QueryComplexLabelRule: properties: label_id: description: 标签id example: "10000" type: string label_name: description: 标签名 example: 职业 type: string label_value: description: "当有多个取值时用英文\",\"分隔,不允许传入下划线\"_\"、竖线\"|\"或者空格\" \"" example: 程序员 type: string operator: description: 运算符 example: EQ type: string type: object QueryExtension: properties: areas: description: 扩展区列表 items: $ref: '#/components/schemas/ExtensionArea' type: array extension_key: description: 扩展区套id example: 2013121100055552_7c3cb211-e239-42c0-abb0-fe80d02cfe51 type: string label_rules: description: 标签规则列表 items: $ref: '#/components/schemas/QueryLabelRule' type: array status: description: 扩展区状态,"ON"代表上线,"OFF"代表下线,只有上线的扩展区才能被用户看到 example: "ON" type: string type: object QueryGroup: properties: count: description: 人群中包含人数 example: 888888 type: integer id: description: 分组id example: "100" type: string label_rule: description: 分组中的圈人规则 items: $ref: '#/components/schemas/QueryComplexLabelRule' type: array name: description: 用户分组名称 example: 测试分组 type: string type: object QueryLabelRule: properties: label_id: description: 标签id type: string label_name: description: 标签名 type: string label_value: description: 标签值,多值会用英文逗号分隔 type: string operator: description: 运算符 type: string type: object QueryMenu: properties: button: description: 一级菜单列表 items: $ref: '#/components/schemas/ButtonObject' type: array label_rule: description: 标签规则项列表 items: $ref: '#/components/schemas/QueryLabelRule' type: array menu_key: description: 菜单唯一id example: default type: string type: description: 菜单类型,icon:icon型菜单,text:文本型菜单 example: icon type: string type: object QuotaModifyDetail: properties: agreement_no: description: 授权协议号,和入参的协议号对应 example: "20216006003193457889" type: string error_code: description: 明细处理错误码,当success为false时有值 example: INVALID_AGREEMENT_NO type: string fail_reason: description: 错误描述,当success为false时有值 example: 无效的协议 type: string success: description: 当前协议下的明细处理结果 example: true type: boolean type: object QuotaQueryResponse: properties: agreement_no: description: 协议号 example: "20205321001042231004" type: string error_code: description: 单个协议查询结果错误码 example: INVALID_AGREEMENT type: string fail_reason: description: 单个协议响应错误描述 example: 无效的三方协议 type: string quota_details: $ref: '#/components/schemas/AccountQuotaDetail' success: description: 单个协议查询结果是否成功 example: "true" type: string type: object ReceiverAddressInfo: properties: address: description: 收货地址 example: 上海市浦东新区陆家嘴银城中路501号 type: string division_code: description: 中国标准城市区域码 example: "310115" type: string mobile: description: 收货人手机号 example: "13120180615" type: string name: description: 收货人的姓名 example: 张三 type: string zip: description: 收货地址邮编 example: "200120" type: string type: object ReceiverIstd: properties: address: description: 地址(街道、小区、大厦等,用于定位) type: string address_detail: description: 地址详情(楼号、单元号、层号) type: string city: description: 城市名称,如杭州市 type: string coordinate_type: description: 坐标类型,0:火星坐标(高德,腾讯地图均采用火星坐标) 1:百度坐标。目前只支持0:火星坐标 type: integer lat: description: 纬度 type: string lng: description: 经度 type: string mobile_no: description: 手机号 type: string name: description: 姓名 type: string type: object RecommendAccountDTO: properties: alipay_account: description: 推荐商家支付宝登录账号,邮箱或手机号码,脱敏处理 type: string user_name: description: 推荐商家支付宝账号名称,脱敏处理 type: string type: object RecruitEnrollInfo: properties: cities: description: 报名提交的活动城市码,详见活动城市码 items: type: string type: array enroll_merchant: $ref: '#/components/schemas/RecruitEnrollMerchant' materials: description: 报名提交的素材 items: $ref: '#/components/schemas/RecruitMaterial' type: array mini_apps: description: 报名提交的小程序信息,是否必选取决于方案要求 items: $ref: '#/components/schemas/RecruitMiniApp' type: array vouchers: description: 报名提交的券信息,是否必选取决于方案要求 items: $ref: '#/components/schemas/RecruitVoucher' type: array type: object RecruitEnrollMerchant: properties: merchant_uid: description: 商户唯一ID(商户pid) type: string type: object RecruitEnrollRule: properties: max_size: description: 最大数量 example: 1 type: integer min_size: description: 最小数量 example: 1 type: integer required: description: 是否必填 example: true type: boolean rule_data: $ref: '#/components/schemas/RecruitEnrollRuleData' type: description: "招商报名时提交的内容类型:\t券:VOUCHER;\t小程序:MINI_APP;\t报名商户:ENROLL_MERCHANT;\t\ 素材:MATERIAL;\t活动城市:CITY;" example: VOUCHER type: string type: object RecruitEnrollRuleData: properties: recruit_voucher_rules: description: 招商方案可提报的券的规则列表,不同的券有不同的规则。 items: $ref: '#/components/schemas/RecruitVoucherRule' type: array schema: description: "素材的要求,json字符串,使用时需要把此字符串解析成json对象。\tfield:提报的字段key\tlabel:\ 字段说明\trequired:是否必填\ttype:字段类型。包含:图片(IMAGE)、文本(TEXT)、数据源(DATASOURCE)等\t\ rules:字段约束规则\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\"}]" type: string type: object RecruitMaterial: properties: data: 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。" type: string description: description: 对这个素材的描述,用于后续管理该素材 type: string material_audit_info: description: "素材审核信息,展示给商家的素材审核不通过的意见。素材审核通过时该字段为空。\t报名详情查询接口不用填写该字段。" type: string name: description: 素材名名称 type: string subject_id: description: "关联的报名主体ID。\tenroll_scene_type是VOUCHER时,报名主体ID是activity_id;\ enroll_scene_type是MINI_APP时,报名主体ID是mini_app_id" type: string type: object RecruitMiniApp: properties: mini_app_id: description: 小程序ID type: string type: object RecruitPlanLight: properties: description: description: 招商方案描述:富文本内容,可能包含html标签 example:

招商规则说明

type: string enroll_end_time: description: 报名结束时间 example: 2021-01-01 01:01:01 type: string enroll_scene_type: description: "招商方案所属报名场景\t枚举值:\tVOUCHER:券报名场景;\tMINI_APP:小程序报名场景;" example: VOUCHER type: string enroll_start_time: description: 报名开始时间 example: 2021-01-01 01:01:01 type: string logo: description: 方案头图链接,150x150 以上尺寸的方形图片 example: https://xxxx type: string plan_id: description: 招商方案ID example: "2021041201000100000000999999" type: string plan_name: description: 招商方案名称 example: 中秋招商方案 type: string status: description: 招商方案状态 example: ENABLED type: string type: object RecruitVoucher: properties: activity_id: description: 券活动id。支持商家券(创建商家券请参考https://opendocs.alipay.com/apis/01xm17)和支付券(创建支付券请参考https://opendocs.alipay.com/pre-apis/027185,仅供受邀用户使用),取值均为返回结果的activity_id字段。 type: string type: object RecruitVoucherRule: properties: amount_max: description: 券面额(每张代金券可以抵扣的金额)的最大值。 币种为人民币,单位为元。小数点以后最多保留两位。 该字段为空时表示不限制。 example: "15.00" type: string amount_min: description: 券面额(每张代金券可以抵扣的金额)的最小值。 币种为人民币,单位为元。小数点以后最多保留两位。 该字段为空时表示不限制。 example: "12.00" type: string denomination_percent_max: description: "券优惠比例的最大值。20代表优惠比例最多是20%。券优惠券比例=券优惠面额/门槛金额。\t浮点类型,取值范围为[1,100],\ 左右均是闭区间,小数点以后最多保留两位。\t该字段为空时表示不限制。" example: "20" type: string denomination_percent_min: description: "券优惠比例的最小值。10代表优惠比例最少是10%。券优惠券比例=券优惠面额/门槛金额。\t浮点类型,取值范围为[1,100],\ 左右均是闭区间,小数点以后最多保留两位。\t该字段为空时表示不限制。" example: "10" type: string floor_amount_max: description: "券门槛金额的最大值。\t币种为人民币,单位为元。小数点以后最多保留两位。\t该字段为空时表示不限制。" example: "20.00" type: string floor_amount_min: description: "券门槛金额的最小值。\t币种为人民币,单位为元。小数点以后最多保留两位。\t该字段为空时表示不限制。" example: "10.00" type: string origin_amount_max: description: "券原价的最大值。\t币种为人民币,单位为元。小数点以后最多保留两位。\t该字段为空时表示不限制。" example: "20.00" type: string origin_amount_min: description: "券原价的最小值。\t币种为人民币,单位为元。小数点以后最多保留两位。\t该字段为空时表示不限制。" example: "10.00" type: string publish_end_time_max: description: "券发放结束时间的最大值。\t格式为:yyyy-MM-dd HH:mm:ss\t该字段为空时表示不限制。" example: 2022-01-13 23:59:59 type: string publish_end_time_min: description: "券发放结束时间的最小值。\t格式为:yyyy-MM-dd HH:mm:ss\t该字段为空时表示不限制。" example: 2019-09-10 00:00:00 type: string publish_start_time_max: description: "券发放开始时间的最大值。\t格式为:yyyy-MM-dd HH:mm:ss\t该字段为空时表示不限制。" example: 2022-01-13 23:59:59 type: string publish_start_time_min: description: "券发放开始时间的最小值。\t格式为:yyyy-MM-dd HH:mm:ss\t该字段为空时表示不限制。" example: 2019-09-10 00:00:00 type: string refund_type: description: "退券类型要求,列表,总共有两种类型:\t过期退OVERDUE_REFUND\t随时退CAN_REFUND\t该字段为\ 空时表示不限制。" example: "[\"CAN_REFUND\",\"OVERDUE_REFUND\"]" items: type: string type: array sale_amount_max: description: "用户购买优惠券需要支付的金额的最大值。\t币种为人民币,单位为元。小数点以后最多保留两位。\t该字段为空时表示不限制\ 。" example: "20.00" type: string sale_amount_min: description: "用户购买优惠券需要支付的金额的最小值。\t币种为人民币,单位为元。小数点以后最多保留两位。\t该字段为空时表示不限制\ 。" example: "10.00" type: string use_channel: description: "券核销渠道要求,列表,总共有两个渠道:\t门店SHOP\t小程序MINI_APP\t该字段为空时表示不限制。" example: "[ \"SHOP\", \"MINI_APP\" ]" items: type: string type: array valid_days_after_receive_min: description: "券生效后至少N天内可以使用。比如:valid_days_after_receive_min=20代表\t券生效后至少\ 20天内可以使用。\t该字段为空时表示不限制。" example: 20 type: integer voucher_activity_type: description: "券活动类型。支持七种商家券类型和两种支付券类型。\t\t枚举值:\t商家券类型:\tALL_FIX_ORDER_VOUCHER\ \ 全场满减券;\tITEM_FIX_ORDER_VOUCHER 单品满减券;\tALL_DISCOUNT_ORDER_VOUCHER 全场\ 折扣券;\tITEM_DISCOUNT_ORDER_VOUCHER 单品折扣券;\tITEM_SPE_ORDER_VOUCHER 单品特价券\ ;\tEXCHANGE_GROUP_BUY_ORDER_VOUCHER 兑换团购券;\tEXCHANGE_FIX_ORDER_VOUCHER\ \ 兑换代金券;\t\t支付券类型:\tALL_FIX_VOUCHER 全场满减券;\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 type: string voucher_quantity_limit_per_user_max: description: "每人领取限制的最大值。\t默认按照支付宝uid进行领取限制。\t该字段为空时表示不限制。" example: 20 type: integer voucher_quantity_limit_per_user_min: description: "每人领取限制的最小值。\t默认按照支付宝uid进行领取限制。\t该字段为空时表示不限制。" example: 10 type: integer voucher_quantity_max: description: "券库存数量的最大值。\t该字段为空时表示不限制。" example: 20 type: integer voucher_quantity_min: description: "券库存数量的最小值。\t该字段为空时表示不限制。" example: 10 type: integer voucher_valid_begin_time_min: description: "券可使用的开始时间的最小值。\t格式为:yyyy-MM-dd HH:mm:ss\t该字段为空时表示不限制。" example: 2022-01-13 23:59:59 type: string voucher_valid_end_time_max: description: "券可使用的结束时间的最大值。\t格式为:yyyy-MM-dd HH:mm:ss\t该字段为空时表示不限制。" example: 2022-01-13 23:59:59 type: string type: object RefundChargeInfo: properties: charge_type: description: 收单手续费trade,花呗分期手续hbfq,其他手续费charge type: string refund_charge_fee: description: 实退费用。单位:元。 type: string refund_sub_fee_detail_list: description: 组合支付退费明细 items: $ref: '#/components/schemas/RefundSubFee' type: array switch_fee_rate: description: 签约费率 type: string type: object RefundGoodsDetail: properties: goods_id: description: "商品编号。\t对应支付时传入的goods_id" example: apple-01 type: string out_item_id: description: 商家侧小程序商品ID,对应支付时传入的out_item_id example: outItem_01 type: string out_sku_id: description: 商家侧小程序商品sku ID,对应支付时传入的out_sku_id example: outSku_01 type: string refund_amount: description: 该商品的退款总金额,单位为元 example: "19.50" type: string type: object RefundRoyaltyResult: properties: refund_amount: description: 退分账金额。单位:元。 example: "10" type: string result_code: description: 退分账结果码 example: SUCCESS type: string royalty_type: description: "分账类型.\t字段为空默认为普通分账类型transfer" example: transfer type: string trans_in: description: 转入人支付宝账号对应用户ID example: "2088102210397302" type: string trans_in_email: description: 转入人支付宝账号 example: zen_gwen@hotmail.com type: string trans_out: description: 转出人支付宝账号对应用户ID example: "2088102210397302" type: string trans_out_email: description: 转出人支付宝账号 example: alipay-test03@alipay.com type: string type: object RefundSubFee: properties: refund_charge_fee: description: 实退费用。单位:元。 type: string switch_fee_rate: description: 签约费率 type: string type: object RegionInfo: properties: area_code: description: 地址所属区代码 type: string area_name: description: 地址所属区名称 type: string city_code: description: 地址所属市代码 type: string city_name: description: 地址所属市名称 type: string province_code: description: 地址所属省份代码 type: string province_name: description: 地址所属省份名称 type: string type: object ReplyRecord: properties: content: description: 回复内容 type: string gmt_create: description: 回复时间 type: string images: description: 回复图片 items: type: string type: array replier_role: description: "回复角色\t商家:MERCHANT \t审核小二:AUDITOR" type: string status: description: 状态。只在replier_role = ‘AUDITOR’时有值 type: string type: object ReplyRecordResponse: properties: content: description: 回复内容 example: 已退款退货给您,物流单号为:12344444 type: string gmt_create: description: 回复时间 example: 2020-02-14 14:23:12 type: string images: description: 回复图片 example: "[\"http://mdn.alipay.com/wsdk/img?fileid=A*ME4GQq2j-5oAAAAAAAAAAAAAAQAAAQ&t=83fed12ef006ebcd8df04dfe79faad6c&bi=openpunsh&ts=0&zoom=original\"\ ]" items: type: string type: array replier_name: description: 回复人名称 example: 刘* type: string replier_role: description: "用户:USER \t商家:MERCHANT\t系统:SYSTEM\t审核小二:AUDITOR\t政府单位:GOVERNMENT" example: USER type: string type: object Role: properties: ccs_instance_id: description: 部门id(即租户实例ID、数据权限ID) example: ZPASFSCN type: string create_time: description: 创建时间 example: 2020-11-10 21:14:00 type: string creator_id: description: 创建人id example: "20184359929433" type: string description: description: 角色描述描述 example: 这个角色是..... type: string function_ids: description: 角色关联额功能点id example: "[\"43511\",\"345343\"]" items: type: string type: array id: description: 角色id example: "12" type: string name: description: 角色名 example: 知识库管理员 type: string update_time: description: 最后修改时间 example: 2020-11-10 21:20:00 type: string updater_id: description: 最后修改人id example: "20190443599294" type: string type: object RoleId: properties: ccs_instance_id: description: 部门id(即租户实例ID、数据权限ID) type: string role_id: description: 角色ID type: string type: object RoyaltyDetail: properties: amount: description: 分账金额 example: "10.00" type: string detail_id: description: 支付宝分账明细单号,每笔分账业务执行的明细单号 example: "2023030610032004370215900000" type: string error_code: description: 分账失败错误码,只在分账失败时返回 example: TXN_RESULT_ACCOUNT_BALANCE_NOT_ENOUGH type: string error_desc: description: 分账错误描述信息 example: 分账余额不足 type: string execute_dt: description: 分账执行时间 example: 2021-07-30 12:00:00 type: string operation_type: description: 分账操作类型。有以下几种类型: replenish(补差)、replenish_refund(退补差)、transfer(分账)、transfer_refund(退分账) example: transfer type: string state: description: 分账状态,SUCCESS成功,FAIL失败,PROCESSING处理中 example: FAIL type: string trans_in: 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" type: string trans_in_open_id: description: 分账转入方的OpenId,OpenId为用户在该应用下支付宝的唯一用户标识。 example: 095PJtAPYb2UkQ0mXk_X86Z_Pd7PtySKX-U3zUEwONcu3wc type: string trans_in_type: description: 分账转入账号类型。 example: userId type: string trans_out: 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" type: string trans_out_open_id: description: 分账转出方的OpenId,OpenId为用户在该应用下支付宝内的唯一用户标识。 example: 095PJtAPYb2UkQ0mXk_X86Z_Pd7PtySKX-U3zUEwONcu3wc type: string trans_out_type: description: 分账转出账号类型 example: userId type: string type: object RoyaltyDetailInfo: properties: amount: description: 分账金额,单位为元 example: "10.00" type: string desc: description: 分账描述 example: 分账给2088101126708402 type: string scene: description: "分账场景,目前仅支持5中类型,RETURN_MONEY(垫资还款), CHARGE(费用), REPLENISH(补\ 贴),FUND_TRANS_IN_SWITCHING(存量资金搬迁),PUNISHMENT(处罚)" example: PUNISHMENT type: string trans_in_account_id: description: 分账转入账户id。当分账账户id类型是cardSerialNo时,本参数为用户在支付宝绑定的卡编号;当分账账户id类型是userId时,本参数为用户的支付宝账号对应的支付宝唯一用户号;当分账账户id类型是loginName时,本参数为用户的支付宝登录号;当分账账户id类型是openId时,本参数为用户的在该应用下的支付宝OpenId; 当 trans_in_account_type 为defaultSettle时,本参数必须为空 example: "2088101126708402" type: string trans_in_account_id_type: 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 type: string trans_in_account_type: description: "分账账户类型。 bankCard: 分账账户为银行卡; alipayBalance: 分账账户为支付宝余额户; defaultSettle:\ \ 按默认结算规则分账" example: alipayBalance type: string trans_in_entity_biz_type: description: 分账账户业务类型,目前仅支持已结算类型 settled example: settled type: string trans_in_entity_id: description: "分账转出主体账 号。\r\t\r\t当分账转出主体类型为SecondMerchant,本参数为二级商户的SecondMerchantID\r\ \t\r\t当分账转出类型为Store,本参数为StoreID" example: SecondMerchant type: string trans_in_entity_type: description: "分账转入主体类型。 SecondMerchant:分账转入主体为二级商户\tStore: 分账转入主体为门店" example: Store type: string trans_in_sub_merchant: $ref: '#/components/schemas/SubMerchant' trans_out_entity_biz_type: description: 分账转出方主体业务类型,目前仅支持已结算类型 settled example: settled type: string trans_out_entity_id: description: "分账转出主体账。\r\t\r\t当分账转出主体类型为SecondMerchant,本参数为二级商户的SecondMerchantId\r\ \t\r\t当分账转出类型为Store,本参数为StoreID" example: "2088" type: string trans_out_entity_type: description: "分账转出主体类型。 SecondMerchant:结算主体为二级商户\tStore: 结算主体为门店" example: SecondMerchant type: string trans_out_sub_merchant: $ref: '#/components/schemas/SubMerchant' type: object RoyaltyDetailInfos: properties: amount: description: 分账的金额,单位为元 type: string amount_percentage: description: 分账的比例,值为20代表按20%的比例分账 type: string batch_no: description: "分账批次号\r\t分账批次号。\r\t目前需要和转入账号类型为bankIndex配合使用。" type: string desc: description: 分账描述信息 type: string out_relation_id: description: "商户分账的外部关联号,用于关联到每一笔分账信息,商户需保证其唯一性。\r\t如果为空,该值则默认为“商户网站唯一订单\ 号+分账序列号”" type: string serial_no: description: 分账序列号,表示分账执行的顺序,必须为正整数 type: integer trans_in: description: "如果转入账号类型为userId,本参数为接受分账金额的支付宝账号对应的支付宝唯一用户号。以2088开头的纯16位数字\ 。\r\t\t如果转入账号类型为bankIndex,本参数为28位的银行编号(商户和支付宝签约时确定)。\r\t如果转入账号\ 类型为storeId,本参数为商户的门店ID。" type: string trans_in_type: description: 接受分账金额的账户类型 type: string trans_out: description: 如果转出账号类型为userId,本参数为要分账的支付宝账号对应的支付宝唯一用户号。以2088开头的纯16位数字。 type: string trans_out_type: description: "要分账的账户类型。\r\t目前只支持userId:支付宝账号对应的支付宝唯一用户号。\r\t默认值为userId。" type: string type: object RoyaltyEntity: properties: account: description: 分账接收方账号。 当分账方类型是userId时,本参数为用户的支付宝账号对应的支付宝唯一用户号,以2088开头的纯16位数字; 当分账方类型是loginName时,本参数为用户的支付宝登录号;当分账方类型是openId时,本参数传递支付宝openId信息。 type: string account_open_id: description: 分账接收方openId,本参数为分账接收方在该应用(AppId)下的唯一用户标识,仅用于分账关系查询接口出参。 type: string bind_login_name: description: 作为查询返回结果:分账收款方绑定时的支付宝登录号。分账关系绑定(alipay.trade.royalty.relation.bind)时,通过type为loginName绑定传入的支付宝登录号,若使用userId绑定则不返回。 type: string login_name: description: 作为查询返回结果:当前userId对应的支付宝登录号。当login_name与bind_login_name不相等时,表明该支付宝账户发生了登录号变更。 type: string memo: description: 分账关系描述 type: string name: description: "分账接收方真实姓名。\t绑定分账关系时:\t当分账方类型是userId时,本参数可以不传,若上传则进行校验不上传不会\ 校验。\t当分账方类型是loginName时,本参数必传。\t解绑分账关系时:作为请求参数可不填,分账关系查询时不作为返回结果返回" type: string type: description: 分账接收方方类型。 type: string type: object RoyaltyInfo: properties: royalty_detail_infos: description: 分账明细的信息,可以描述多条分账指令,json数组。 items: $ref: '#/components/schemas/RoyaltyDetailInfos' type: array royalty_type: description: "分账类型\r\t卖家的分账类型,目前只支持传入ROYALTY(普通分账类型)。" type: string type: object Scene: properties: scene_id: description: 场景Id,最长32位,英文字母、数字以及下划线,开发者自定义 example: "1234" type: string type: object SchoolBaseInfo: properties: campus_info: description: 校区信息 items: $ref: '#/components/schemas/CampusInfo' type: array city_code: description: 城市编码 example: "620900" type: string inst_id: description: 学校内标 example: "2088000151541822" type: string inst_name: description: 学校名称 example: 复旦大学 type: string inst_std_code: description: 学校外标 example: 12510181450882098Q type: string province_code: description: 省份编码 example: "370000" type: string type: object SchoolSimpleInfo: properties: campus_info: $ref: '#/components/schemas/CampusInfo' city_code: description: 城市编码 example: "620900" type: string inst_id: description: 学校内标 example: "2088000151541822" type: string inst_name: description: 学校名称 example: 复旦大学 type: string inst_std_code: description: 学校外标 example: 12510181450882098Q type: string province_code: description: 省份编码 example: "370000" type: string type: object SearchAbilityOrderData: properties: access_type: description: 申请单类型 example: BRAND_BOX type: string app_name: description: 小程序名称 example: 小程序名称 type: string app_status: description: 小程序状态 ON_LINE、OFF_LINE example: ON_LINE type: string appid: description: 小程序id example: "2021001105612404" type: string apply_id: description: 申请单id example: AP20200212100002488 type: string apply_type: description: 申请类型 BASE:基础信息, BRAND_BOX:品牌直达,SERVICE_BOX服务直达 example: BRAND_BOX type: string audit_status: description: 申请状态 AGREE、REJECT、EDIT、AUDIT example: AGREE type: string biz_id: description: bizId 为品牌box的boxID example: C100038430_2019042421000001069599_FUNCTION type: string box_status: description: 品牌box的上下架状态 ONLINE OFFLINE example: ONLINE type: string brand_template_id: description: 品牌的模板id ONE_WITH_TWO:一拖二、DEFAULT:一拖四 example: DEFAULT type: string children: description: 二级服务信息 items: $ref: '#/components/schemas/SearchAbilityOrderInfoOpenApi' type: array data_key: description: 二级服务的唯一标识 example: "2019042421000001069599" type: string gmt_modified: description: 更新时间 example: 2020-10-16 12:00:21 type: string id: description: 服务的唯一标识(优先使用serviceCode可忽略) example: "3131231" type: string is_old_data: description: 是否是老工单 example: "false" type: string major_status: description: "服务主状态,INITIAL:初始化;VALID:已生效;INVALID:已失效" example: INITIAL type: string online_time: description: 上架时间 example: 2020-10-10 12:32:31 type: string open_status: description: 服务的可见性状态 example: true type: boolean operator: description: 下架操作者 example: "20881231231" type: string reject_reason: description: 驳回原因 example: 驳回原因 type: string scene_code: description: 场景码 example: HOT_WORD_RANKING type: string scene_name: description: 场景名称 example: 场景名称 type: string service_code: description: 服务码 example: "2019121121000102523089" type: string sub_service_desc: description: 子功能描述 example: 子功能描述 type: string sub_service_name: description: 子功能名称 example: 子功能名称 type: string type: object SearchAbilityOrderInfoOpenApi: properties: access_type: description: 申请单类型 example: BASE type: string app_name: description: 小程序名称 example: 搜索1 type: string app_status: description: 小程序状态 example: ON_LINE type: string audit_status: description: 审核状态 example: AUDIT_PASS type: string biz_id: description: 运营申请单详情biz_id example: "2021001105610428" type: string box_status: description: 上架状态 example: ONLINE type: string brand_template_id: description: 品牌模板id example: ONE_WITH_TWO type: string data_key: description: 二级服务唯一标识 example: "23232234" type: string gmt_modified: description: 最近更新时间 example: 2020-10-16 12:00:21 type: string id: description: 唯一id example: "123424" type: string is_old_data: description: 是否老工单 example: false type: boolean major_status: description: 服务主状态 example: VALID type: string online_time: description: 上架时间 example: 2020-10-10 12:32:31 type: string open_status: description: 小程序可见性 example: true type: boolean operator: description: 下架操作者 example: "232323" type: string reject_reason: description: 驳回原因 example: 驳回原因 type: string scene_code: description: 场景码 example: sss type: string scene_name: description: 场景名称 example: aaa type: string search_app_id: description: 小程序id example: "2021001105610428" type: string sepc_code: description: 应用标识 example: SP_MINI_APP type: string service_code: description: 服务码 example: "234345454" type: string sub_service_desc: description: 子功能描述 example: "111" type: string sub_service_name: description: 子功能名称 example: 子功能 type: string type: object SearchApplyPageQueryRequest: properties: apply_type: description: 申请类型 BASE:基础信息, BRAND_BOX:品牌直达,SERVICE_BOX服务直达 example: BRAND_BOX type: string audit_status_list: description: 筛选状态数组 AUDIT AGREE REJECT CANCEL EDIT example: "[\"AUDIT\",\"AGREE\"]" items: type: string type: array category_code: description: 类目编码 example: "2021001162676276" type: string name: description: 服务名称 example: 服务名称 type: string page_num: description: 当前页码 example: "10" type: string page_size: description: 页面的显示记录条数 example: "3" type: string service_code: description: 服务code example: "2020062021000575859547" type: string service_id: description: 小程序appid example: "2020072301000006648885" type: string start_row: description: 起始记录,起始:0 example: "1" type: string sub_service_code: description: 二级服务code example: "2020062021000575859547" type: string type: object SearchBaseItems: properties: can_search: description: 搜索可见性 example: true type: boolean key_words: description: 提报关键词列表 example: "[\"111\",\"222\",\"333\"]" items: type: string type: array type: object SearchBaseOrderCreateApiRequest: properties: access_type: description: 搜索直达类型 BASE:基础信息,只支持基础信息工单提报 example: BASE type: string appid: description: 小程序Id example: "2021001105612404" type: string base_items: $ref: '#/components/schemas/SearchBaseItems' descprise: description: 服务描述 example: 服务描述 type: string is_draft: description: 是否为草稿态 example: true type: boolean order_id: description: 申请单id,仅仅驳回或修改是传入 example: AP20200212100002488 type: string spec_code: description: 服务的类型 SP_MINI_APP 小程序 SP_PUBLIC_APP 生活号 example: SP_MINI_APP type: string type: object SearchBoxAccountModule: properties: app_infos: description: 应用信息列表 items: $ref: '#/components/schemas/SearchBoxAppInfo' type: array module_id: description: 模块配置ID example: "20220308000000168465" type: string module_type: description: 搜索直达模块类型 example: BOX_EXCLUSIVE_ACCOUNTS type: string type: object SearchBoxActivity: properties: box_activity_id: description: 活动id example: "20211223000000100000" type: string box_id: description: 搜索直达id example: "20211130000000100415" type: string end_time: description: 活动结束时间 example: 2022-09-30 23:59:59 type: string fail_reason: description: 审核失败原因 example: 品牌触发词必须完整包含品牌名称且不得使用泛词,建议调整。 type: string material_type: description: IMAGE-图片/VIDEO-视频 example: IMAGE type: string material_url: description: 当material_type="IMAGE"时,为图片url;当material_type="VIDEO"时,为视频url example: http://mdn.alipayobjects.com/mrch_spc/afts/img/A*0XA2Qo_omj4AAAAAAAAAAAAADsF1AQ/original type: string run_status: description: 运行状态,INITIAL-初始,ONLINE-已上架,EXPIRE-已失效,OFFLINE-已下架 example: ONLINE type: string start_time: description: 活动开始时间 example: 2022-02-10 08:00:00 type: string status: description: 配置状态,INITIAL-初始/AUDIT-审核中/CANCEL-已取消/ONLINE-已上架/REJECT-驳回/OFFLINE-已下架/EXPIRE-已失效 example: ONLINE type: string target_appid: description: 跳转应用ID example: "2021001191699651" type: string target_appname: description: 目标小程序名称 example: 目标小程序名称 type: string target_regions: description: 投放目标区域 items: $ref: '#/components/schemas/DeliveryTargetRegion' type: array title: description: 活动标题 example: 活动标题 type: string video_info: $ref: '#/components/schemas/SearchBoxActivityVideoInfo' type: object SearchBoxActivityVideoInfo: properties: video_btn_text: description: 视频按钮文案,2-4个汉字 type: string video_coverimg_id: description: 视频封面图片id,图片id可以通过调用接口alipay.open.file.upload上传图片,获取图片id(bizCode:search_box_videocover)。 图片规范 type: string video_sub_title: description: 视频副标题,2-16个汉字 type: string video_title: description: 视频主标题,2-10个汉字 type: string type: object SearchBoxAppInfo: properties: app_name: description: 应用名称 type: string app_type: description: 应用类型,TINY_APP-小程序/PUBLIC_APP-生活号 type: string relate_appid: description: 应用ID type: string type: object SearchBoxAreaKeyWordModule: properties: latest_audit_area_keyword_info: $ref: '#/components/schemas/SearchBoxKeywordInfo' module_id: description: 模块配置ID example: "20220308000000168465" type: string module_type: description: 搜索直达模块类型 example: BOX_EXCLUSIVE_AREA_KEYWORD type: string valid_area_keyword_info: $ref: '#/components/schemas/SearchBoxKeywordInfo' type: object SearchBoxBasicInfo: properties: box_id: description: 搜索直达配置id example: "20220117000000112680" type: string brand_id: description: 品牌id example: "1000467882" type: string name: description: 搜索直达名称 example: 搜索直达名称 type: string status: description: 搜索直达配置状态,INITIAL-初始/ONLINE-已上架/EXPIRE-已失效/OFFLINE-已下架 example: ONLINE type: string target_appid: description: 小程序id example: "2018092561507369" type: string type: object SearchBoxBasicInfoModule: properties: apply_no: description: 申请单号 example: "2022010700503000000000487728" type: string box_desc: description: 介绍,已生效的数据 example: 品牌介绍 type: string fail_reason: description: 审核失败原因 example: 品牌触发词必须完整包含品牌名称且不得使用泛词,建议调整。 type: string gmt_modified: description: 修改时间 example: 2022-01-07 18:22:04 type: string latest_audit_box_desc: description: 介绍,最近一次审核内容 example: 品牌介绍 type: string module_id: description: 模块配置ID example: "20220308000000168465" type: string module_type: description: 搜索直达模块类型 example: BOX_EXCLUSIVE_BASE type: string status: description: 状态,INITIAL-初始/AUDIT-审核中/CANCEL-已取消/ONLINE-已上架/REJECT-驳回/OFFLINE-已下架/EXPIRE-已失效 example: AUDIT type: string type: object SearchBoxImageModule: properties: apply_no: description: 申请单号 type: string fail_reason: description: 审核失败原因 type: string gmt_modified: description: 修改时间 type: string module_id: description: 模块配置ID type: string module_type: description: 搜索直达模块类型 type: string status: description: 状态,INITIAL-初始/AUDIT-审核中/CANCEL-已取消/ONLINE-已上架/REJECT-驳回/OFFLINE-已下架/EXPIRE-已失效 type: string type: object SearchBoxKeyWordModule: properties: apply_no: description: 申请单号 example: "2022010700503000000000487728" type: string fail_reason: description: 审核失败原因 example: 品牌触发词必须完整包含品牌名称且不得使用泛词,建议调整。 type: string gmt_modified: description: 修改时间 example: 2022-01-07 18:22:04 type: string keywords: description: 自定义触发词(生效中) example: "[\"自定义触发词\"]" items: type: string type: array latest_audit_keywords: description: 自定义触发词(最近一次审核内容) example: "[\"自定义触发词\"]" items: type: string type: array module_id: description: 模块配置ID example: "20220308000000168465" type: string module_type: description: 搜索直达模块类型 example: BOX_EXCLUSIVE_KEYWORD type: string status: description: 状态,INITIAL-初始/AUDIT-审核中/CANCEL-已取消/ONLINE-已上架/REJECT-驳回/OFFLINE-已下架/EXPIRE-已失效 example: ONLINE type: string type: object SearchBoxKeywordInfo: properties: apply_no: description: 申请单号 type: string fail_reason: description: 审核失败原因 type: string gmt_modified: description: 修改时间 type: string keywords: description: 关键词 items: type: string type: array module_id: description: 模块配置ID type: string status: description: "ONLINE--上架\tREJECT--驳回\tOFFLINE-已下架" type: string type: object SearchBoxServiceInfo: properties: service_category_code: description: 服务类目编码 type: string service_category_name: description: 服务类目名称 type: string service_code: description: 服务编码 type: string service_name: description: 服务名称 type: string type: object SearchBoxServiceModule: properties: module_id: description: 模块配置ID example: "20220308000000168465" type: string module_type: description: 搜索直达模块类型 example: BOX_EXCLUSIVE_FUNCTIONS type: string service_infos: description: 服务信息列表 items: $ref: '#/components/schemas/SearchBoxServiceInfo' type: array type: object SearchOperPageQueryRequest: properties: access_type: description: 申请类型 BASE:基础信息, BRAND_BOX:品牌直达,SERVICE_BOX服务直达 example: BRAND_BOX type: string appid: description: 小程序ID example: "2021001105612404" type: string page_num: description: 当前页 example: "1" type: string page_size: description: 每页显示条数 example: "2" type: string scene_code: description: 场景码 example: HOT_WORD_RANKING type: string spec_code: description: 服务类型 SP_MINI_APP 小程序 SP_PUBLIC_APP 生活号 example: SP_MINI_APP type: string type: object SearchOrderBrandDetail: properties: brand_detail: $ref: '#/components/schemas/BrandDetail' key: description: 工单详情key值 example: 425d8560-35da-11eb-9de8-217f5d8e3c76 type: string type: object SearchOrderDetailData: properties: access_type: description: 申请单类型 BASE:基础信息, BRAND_BOX:品牌直达,SERVICE_BOX服务直达 example: BASE type: string app_category: description: 小程序类目名 example: 旅行住宿_国际货运代理和报关行 type: string app_icon: description: 小程序图标 example: http://appstoreisvpic.alipayobjects.com/dev/bec7d11f-bb62-4abf-9a75-0d10407b4ed8.png type: string app_name: description: 小程序名称 example: 小程序名称 type: string app_status: description: 小程序状态 example: ON_LINE type: string appid: description: 小程序ID example: "2014060600164699" type: string base_order_status: $ref: '#/components/schemas/OrderStatusData' biz_id: description: bizid 业务id example: "765432123456" type: string box_order_status: $ref: '#/components/schemas/OrderStatusData' box_status: description: 上下架状态 ONLINE OFFLINE example: ONLINE type: string brand_template_id: description: 品牌的模板id ONE_WITH_TWO:一拖二、DEFAULT:一拖四 example: DEFAULT type: string brandbox_orderstatus: $ref: '#/components/schemas/OrderStatusData' can_modify_keyword: description: 是否可修改关键词 example: true type: boolean describe: description: 服务描述 example: 搜索提报测试小程序3 type: string detail_base_items: $ref: '#/components/schemas/SearchOrderDetailDataBaseItems' detail_brand_items: $ref: '#/components/schemas/SearchOrderDetailDataBrandItems' detail_service_items: $ref: '#/components/schemas/SearchOrderDetailDataServiceItems' final_status: description: 最终状态 example: AGREE type: string gmtmodified: description: 最后修改时间 example: 2020-10-15 11:34:23 type: string keyword_gmt_modified: description: 关键词的修改时间 example: 2020-10-14 14:25:50 type: string online_time: description: 上架时间 example: 2020-10-15 11:34:23 type: string operator_type: description: 操作人员类型 example: 操作人员类型 type: string order_id: description: 申请单id example: AP2020101501254498 type: string partner_type: description: 查询服务提供者生态类型 一二三方 1 | 2 | 3 example: "1" type: string reject_node: description: 驳回节点 example: 驳回节点 type: string reject_reason: description: 驳回原因 example: 驳回原因 type: string scene_code: description: 场景码 example: HOT_WORD_RANKING type: string scene_name: description: 场景名称 example: 场景名称 type: string service_code: description: 服务code example: "2019121121000102523089" type: string service_name: description: 服务名 example: 服务名 type: string status: description: 申请单状态 AGREE、REJECT、AUDIT example: AUDIT type: string sub_service_code: description: 二级服务code example: "2019121121000102523089" type: string template_id: description: 模板Id example: WALLET-SEARCH@boxFunctionCommon type: string template_name: description: 模板名称 example: 二级服务菜单直达 type: string type: object SearchOrderDetailDataBaseItems: properties: can_search: description: 搜索可见性 example: "true" type: string desc: description: 描述信息 example: 描述信息 type: string img: description: img地址 example: https://appstoreisvpic.alipayobjects.com/prod/37945fc8-d09b-4b3a-a472-4673c55e9dc9.png type: string key_word: description: 关键词 example: 测试 type: string name: description: 应用名称 example: 测试1 type: string region: description: 基础工单详情region example: "1" type: string serv_can_search: description: 搜索可见性 example: "true" type: string serv_search_keywords: description: 搜索关键词 example: 搜索 type: string template_id: description: 模板id example: WALLET-SEARCH@boxFunctionCommon type: string url: description: 跳转url链接 example: https://appstoreisvpic.alipayobjects.com/prod type: string type: object SearchOrderDetailDataBrandItems: properties: biz_id: description: 工单详情bizid example: C100038430_2020081121000352488483_FUNCTION type: string box_status: description: 上下架状态 example: ONLINE type: string brand_box_keywords: description: 关键词信息 example: 烟草 type: string brand_detail_list: description: 工单详情数据信息 items: $ref: '#/components/schemas/SearchOrderBrandDetail' type: array brand_template_id: description: 品牌展示模板类型 example: ONE_WITH_TWO type: string channel: description: 工单详情数据channel example: OPENINSIGHT type: string merchant_type: description: 工单详情数据merchant_type example: GENERAL type: string template_id: description: 模板id example: WALLET-SEARCH@boxContent type: string type: object SearchOrderDetailDataServiceItems: properties: area_codes: description: 服务工单详情area_codes example: "1" type: string carrier_code: description: carrier_code example: "2019021863152020" type: string carrier_list: description: 服务工单数据carrier_list example: "111" type: string category_attribute_value: description: 服务工单category_attribute_value example: "111" type: string category_code: description: 类目编码 example: C100038432 type: string category_ids: description: 类目id example: XS3120 type: string channel_type: description: 渠道类型 example: MERCHANT_SELF_MANAGE_MINI_APP type: string desc: description: 描述信息 example: 描述信息 type: string img: description: img地址 example: https://mdn.alipayobjects.com/openpt_appstore/afts/img/A*1o71SaApF5YAAAAAAAAAAAAAATcnAQ/original type: string key_word: description: 关键词 example: 关键词 type: string key_word_list: description: 关键词列表 example: 测试 type: string logo: description: logo图片地址 example: https://mdn.alipayobjects.com/openpt_appstore/afts/img/A*1o71SaApF5YAAAAAAAAAAAAAATcnAQ/original type: string name: description: 应用名称 example: 应用名称 type: string parent_service_code: description: 服务编码 example: "2019041721000201048200" type: string region: description: 服务工单详情region example: "1" type: string serv_search_catalogs: description: serv_search_catalogs example: C100038432 type: string serv_search_keywords: description: 关键词 example: 关键词 type: string service_code: description: "2020112321000021082348" example: "2019121121000102523089" type: string service_name: description: 服务名称 example: 测试1 type: string service_time_end: description: 服务结束时间 example: 23:59:59 type: string service_time_start: description: 服务开始时间 example: 00:00:00 type: string short_desc: description: 服务短描述 example: 服务短描述 type: string spec_code: description: 应用标识 example: SP_SEARCH_SERVICE type: string template_id: description: 模板id example: WALLET-SEARCH@boxFunctionCommon type: string type: object SearchOrderRequest: properties: apply_id: description: 申请单id example: AP20200212100002488 type: string apply_type: description: 申请类型 BASE:基础信息, BRAND_BOX:品牌直达,SERVICE_BOX服务直达 example: BASE type: string brand_template_id: description: 品牌的模板id ONE_WITH_TWO:一拖二、DEFAULT:一拖四 example: DEFAULT type: string service_code: description: 服务code example: "2019121121000102523089" type: string spec_code: description: 服务的类型默认使用小程序 SP_MINI_APP 小程序 SP_PUBLIC_APP 生活号 example: SP_MINI_APP type: string type: object SearchPartAgreeInfo: properties: audit_info: description: 剔除数据名称 example: 单车 type: string audit_operator: description: 审核operator信息 example: liming type: string audit_reason: description: 审核原因 example: 同意 type: string audit_type: description: 剔除数据类型 example: aaa type: string type: object SeatInfo: properties: seat_class: description: 座位等级 example: 一等座 type: string seat_no: description: 座位号 example: 12车12D type: string type: object SendRule: properties: allow_repeat_send: description: "是否允许重复发奖:\r\ttrue代表允许,false代表不允许\r\t默认不设置,表明用户领取券后如果没有核销则不\ 允许再次领取券\r\t如果设置为true,表明如果用户领取券后没有核销,还可以继续领取该券(只有配置publish_channels中type为\ URL_WITH_TOKEN外部发券时,该字段生效)" example: "true" type: string min_cost: description: "发券最低消费金额,单位元\r\t活动类型为消费送且不是消费送礼包时设置\r\t多营销工具之间不允许设置重复值" example: "100" type: string send_budget: description: 券的预算数量(仅对口令送随机抽奖有效,即当活动类型为GUESS_SEND,且营销工具PromoTool的个数大于1时,此字段必填,其余情况此字段必为空) example: "1234" type: string send_num: description: "发券数目\r\t最少发1张券,最多发5张券" example: "1" type: string type: object SenderIstd: properties: address: description: 地址(街道、小区、大厦等,用于定位) type: string address_detail: description: 地址详情(楼号、单元号、层号) type: string city: description: 城市名称,如杭州市 type: string coordinate_type: description: 坐标类型,0:火星坐标(高德,腾讯地图均采用火星坐标) 1:百度坐标, 目前只支持0 type: integer lat: description: 纬度 type: string lng: description: 经度 type: string mobile_no: description: 手机号 type: string name: description: 姓名 type: string type: object ServiceCodeIstd: properties: service_code: description: 即时配送公司服务代码 example: fengniao01 type: string type: object ServiceRecordCatRequest: properties: cat_name: description: 类目名称(需要每一级用;分隔封装) type: string first_cat: description: 一级类目编码 type: string fourth_cat: description: 四级类目编码 type: string instence_code: description: 类目树编码 type: string second_cat: description: 二级类目编码 type: string third_cat: description: 三级类目编码 type: string type: object SettleCardInfo: properties: account_branch_name: description: 开户支行名 type: string account_holder_name: description: 卡户名 type: string account_inst_city: description: 开户行所在地-市 type: string account_inst_id: description: 开户行简称缩写 type: string account_inst_name: description: 银行名称 type: string account_inst_province: description: 开户行所在地-省 type: string account_no: description: 银行卡号 type: string account_type: description: "卡类型\r\t借记卡-DC\r\t信用卡-CC" type: string bank_code: description: 联行号 type: string usage_type: description: "账号使用类型\r\t对公-01\r\t对私-02" type: string type: object SettleClause: properties: amount: description: 结算金额,单位为元 example: "0.1" type: string currency: description: 结算币种,支持人民币:CNY example: CNY type: string settle_account_entity: description: "结算账号所属于的结算主体类型。\tsecondMerchant 二级商户的结算账号\tstore 门店的结算账号\t\ 如果不填,默认为settleEntityType对应的类型" example: secondMerchant type: string settle_account_id: description: "结算账户id。\t\t当结算账户id类型是cardSerialNo时,本参数为用户在支付宝绑定的卡编号;当结算账户\ id类型是userId时,本参数为用户的支付宝账号对应的支付宝唯一用户号;当结算账户id类型是loginName时,本参数为用户的支付宝登录\ 号; 当 settle_account_type 为defaultSettle时,本参数必须为空" example: "15912345678" type: string settle_account_id_type: description: "结算账户id类型。当 settle_account_type 为 defaultSettle 时,本参数必须为空。\ \ \t当settle_account_type 为bankCard时,本参数为cardSerialNo,表示结算账户id是银行卡编号; 当\ settle_account_type 为alipayBalance时,本参数为userId或者loginName,其中userId表示结算\ 账户id是支付宝唯一用户号,loginName表示结算账户id是支付宝登录号。" example: loginName type: string settle_account_type: description: "结算账户类型。\t\tbankCard: 结算账户为银行卡;\talipayBalance: 结算账户为支付宝余额户\ ;\tdefaultSettle: 按默认结算规则结算" example: alipayBalance type: string settle_entity_biz_type: description: 已结算资产 example: settled type: string settle_entity_id: description: "结算主体账号。\t当结算主体类型为SecondMerchant,传二级商户ID(smid);结算主体类型为Store时\ ,传门店ID" example: "19023454" type: string settle_entity_type: description: "结算主体类型。\tSecondMerchant:结算主体为二级商户\tStore:结算主体为门店" example: SecondMerchant type: string sub_merchant: $ref: '#/components/schemas/SubMerchant' type: object SettleConfirmExtendParams: properties: royalty_freeze: description: 是否进行资金冻结,用于后续分账,true表示冻结,false或不传表示不冻结 example: "true" type: string type: object SettleDetailInfo: properties: actual_amount: description: 仅在直付通账期模式下,当一笔交易需要分多次发起部分确认结算时使用,表示本次确认结算的实际结算金额。传递本字段后,原amount字段不再生效,结算金额以本字段为准。如已经发生过部分确认结算、不传递本字段则默认按剩余待结算金额一次性结算。 type: string amount: description: 结算的金额,单位为元。在创建订单和支付接口时必须和交易金额相同。在结算确认接口时必须等于交易金额减去已退款金额。直付通账期模式下,如使用部分结算能力、传递了actual_amount字段,则忽略本字段的校验、可不传。 type: string settle_entity_id: description: 结算主体标识。当结算主体类型为SecondMerchant时,为二级商户的SecondMerchantID;当结算主体类型为Store时,为门店的外标。 type: string settle_entity_type: description: 结算主体类型。 type: string summary_dimension: description: "结算汇总维度,按照这个维度汇总成批次结算,由商户指定。\t\t目前需要和结算收款方账户类型为cardAliasNo配\ 合使用" type: string trans_in: description: 结算收款方。当结算收款方类型是cardAliasNo时,本参数为用户在支付宝绑定的卡编号;结算收款方类型是userId时,本参数为用户的支付宝账号对应的支付宝唯一用户号,以2088开头的纯16位数字;当结算收款方类型是loginName时,本参数为用户的支付宝登录号;当结算收款方类型是defaultSettle时,本参数不能传值,保持为空。 type: string trans_in_type: description: 结算收款方的账户类型。 type: string type: object SettleEntity: properties: settle_entity_biz_type: description: 结算主体资产业务类型,settled 表示已结算资产 example: settled type: string settle_entity_id: description: "结算主体账号\t当结算主体类型为SecondMerchant,本参数为二级商户的SecondMerchantID;当\ 结算主体类型为MerchantStore,本参数为商户门店ID。" example: "19023454" type: string settle_entity_type: description: "结算主体类型\tSecondMerchant:结算主体为二级商户;Store:结算主体为商户门店" example: SecondMerchant type: string type: object SettleExtendParams: properties: royalty_finish: description: "冻结分账场景下生效,其他场景传入无效。\t代表该交易分账是否完结,可选值:true/false,不传默认为false。\ \ttrue:代表分账完结,则本次分账处理完成后会把该笔交易的剩余冻结金额全额解冻。\tfalse:代表分账未完结。" example: "true" type: string type: object SettleExtraParams: properties: quit_type: description: quit_type为USER_CANCEL_QUIT或者SETTLE_APPLY_QUIT example: SETTLE_APPLY_QUIT type: string scene_pay_link_info: description: "商链通权益抵扣信息, 当前只有运营商使用, 未使用权益抵扣忽略该字段\t\tfundRuleList为对应的出资\ 信息,目前该列表不支持多对象,长度限制为1。其中fundAgreementNo为本笔交易实际出资的协议,由(商链通二方通用版本接入文档)2.3.2获\ 取,fundAmount为该出资协议出资的金额。\t\tbizScene和subBizScene为(商链通二方通用版本接入文档)2.1.3中\ 支付宝侧分配的信息。\t\tbizMode=MERCHANT_ORDER为固定值。" example: "{\"fundRuleList\":[{\"fundAmount\":0.01,\"fundAgreementNo\":\"\ 20235228003240641994\"}],\"bizScene\":\"支付宝侧分配\",\"subBizScene\":\"支付宝\ 侧分配\",\"bizMode\":\"MERCHANT_ORDER\"}" type: string settle_adjust_reason: description: "action_type选择PAY_TO_ZERO时必填,\t\"SERVICE_CANCELED\":\"服务已取消\ \",\t\"OTHER_CHANNEL_PERFORMANCE\":\"户已通过其他方式履约\"" example: SERVICE_CANCELED或OTHER_CHANNEL_PERFORMANCE type: string type: object SettleInfo: properties: settle_detail_infos: description: 结算详细信息,json数组,目前只支持一条。 items: $ref: '#/components/schemas/SettleDetailInfo' type: array settle_period_time: description: 该笔订单的超期自动确认结算时间,到达期限后,将自动确认结算。此字段只在签约账期结算模式时有效。取值范围:1d~365d。d-天。 该参数数值不接受小数点。 type: string type: object ShopBusinessTime: properties: close_time: description: 关门时间 格式:HH:mm type: string open_time: description: 开门时间 格式:HH:mm type: string week_day: description: 本对象表示周几的营业时间。1~6表示周一到周六,7表示周日 type: integer type: object ShopCategoryConfigInfo: properties: id: description: 类目ID example: "2016031800159500" type: string is_leaf: description: 是否是叶子节点 example: "true" type: string level: description: 类目层级 example: "3" type: string link: description: 类目层级路径 example: 美食-中餐-淮扬菜 type: string nm: description: 类目名称 example: 淮扬菜 type: string type: object ShopCategoryInfo: properties: category_id: description: 类目编号 example: "2015050700000018" type: string category_level: description: "类目层级,目前最多支持1、2、3三级" example: "2" type: string category_name: description: 类目名称 example: 美食 type: string type: object ShopCommentInfo: properties: avg_popularity: description: 店铺30天平均人气值 example: "76" type: string avg_popularity_name: description: avg_popularity字段展示文案 example: 口碑人气 type: string score: description: 门店评分,评分越高,门店质量越高 example: "3.2" type: string star: description: "门店星级,0~5,越高,店铺质量越高" example: "4.0" type: string type: object ShopExtInfo: properties: key_name: description: KV数据对的key,表示该kv对象表示什么含义。 type: string value: description: kv对象的值 type: string type: object ShopQueryOpenApiVO: properties: business_address: $ref: '#/components/schemas/AddressInfo' business_time: description: 店铺经营时间 items: $ref: '#/components/schemas/ShopBusinessTime' type: array contact_mobile: description: 店铺联系手机 example: "13901390139" type: string contact_phone: description: 店铺的联系固话 example: 010-62286228 type: string new_shop_category: description: 新版门店类目标准二级类目code。类目标准及与原shop_category映射关系参见文档https://gw.alipayobjects.com/os/bmw-prod/4b3f82df-e53e-4b84-bc41-fe025101e726.xlsx example: B0001 type: string shop_category: description: 店铺类目.取值参见文件文件中的三级门店类目 example: "1002" type: string shop_id: description: 蚂蚁店铺id example: "2018011900502000000005124744" type: string shop_info_status: description: 当前名称、地址、经纬度信息准确一致,可用于数字化经营场景消费(如商品、券、消费圈等场域的分发),不影响门店支付结算 example: "01" type: string shop_name: description: 店铺名称 example: 支付宝东门小卖铺 type: string shop_status: description: 门店状态 example: "01" type: string shop_type: description: 店铺经营类型 example: "01" type: string store_id: description: 门店编号,表示该门店在该商户角色id(直连pid,间连smid)下,由商户自己定义的外部门店编号 example: NO0001 type: string type: object ShopRecommendInfo: properties: recommend: description: 门店修改建议 example: 请修改店名为真实经营的门店名称,如有分店,请修改成品牌(分店名),如大润发(杭州西溪店) type: string recommend_address: description: 推荐详细地址 example: 杭州市西湖区**路**号 type: string recommend_latitude: description: 推荐纬度 example: "30.111" type: string recommend_longtitude: description: 推荐经度 example: "120.3333" type: string recommend_name: description: 推荐门店名称 example: 大润发(杭州西溪店) type: string unconfidence_reason: description: 门店不置信原因 example: 店名不准确 type: string type: object ShopSummaryQueryResponse: properties: address: description: 门店地址 example: 万塘路18号黄龙时代广场 type: string branch_shop_name: description: 分店名 example: 万塘路店 type: string brand_name: description: 品牌名,不填写则默认为其它品牌 example: 肯德基 type: string business_time: description: 经营时间 example: 10:00-14:00 type: string category_infos: description: 门店类目列表 items: $ref: '#/components/schemas/ShopCategoryInfo' type: array city_code: description: 城市编码,国标码,详见国家统计局数据 点此下载 example: "140500" type: string district_code: description: 区县编码,国标码,详见国家统计局数据 点此下载 example: "140521" type: string ext_info: 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\"}" type: string gmt_create: description: 创建时间 example: 2016-06-23 21:15:04.593 type: string is_show: description: 门店是否在客户端显示,T表示显示,F表示隐藏 example: T type: string latitude: description: 纬度,只有在query_type=KB_PROMOTER非空 example: "31.226948" type: string longitude: description: 经度,只有在query_type=KB_PROMOTER非空 example: "121.549728" type: string main_image: description: 门店首图 example: AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC type: string main_shop_name: description: 主门店名 example: 海底捞 type: string per_pay: description: 人均价格。单位是分。例如:2000,表示20元 example: "100" type: string pic_coll: description: "图片集,是map转化成的json串,key是图片id,value是图片url" example: "{\"IUFIDASFIEUIOFKSFIUFE83IEI\":\"http://object.alipay.com/getpic.do?kjkdjkjj\"\ }" type: string province_code: description: 省份编码,国标码,详见国家统计局数据 点此下载 example: "110000" type: string shop_comment_info: $ref: '#/components/schemas/ShopCommentInfo' shop_id: description: 门店ID example: "2015052100077000000000120773" type: string shop_type: description: COMMON(普通门店)、MALL(商圈) example: COMMON type: string status: description: 门店状态,OPEN:营业中、PAUSE:暂停营业、FREEZE:已冻结、CLOSE:门店已关闭 example: OPEN type: string type: object SignAddressInfo: properties: city_code: description: 城市编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 (参考资料: http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/) type: string country_code: description: 国家编码,中国默认:156 type: string detail_address: description: 详细地址 type: string district_code: description: 区县编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 (参考资料: http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/) type: string latitude: description: "纬度,浮点型,小数点后最多保留6位 如需要录入经纬度,请以高德坐标系为准,录入时请确保经纬度参数准确。高德经纬度查询\ :http://lbs.amap.com/console/show/picker" type: string longitude: description: "经度,浮点型, 小数点后最多保留6位。 如需要录入经纬度,请以高德坐标系为准,录入时请确保经纬度参数准确。高德经纬度\ 查询:http://lbs.amap.com/console/show/picker" type: string province_code: description: 省份编码。请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。 (参考资料: http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/) type: string type: object SignData: properties: ori_app_id: description: 签名商户开放平台应用APPID example: "2021000185629012" type: string ori_char_set: description: 编码类型(大小写敏感) example: UTF-8 type: string ori_out_biz_no: description: ori_out_biz_no_001 example: 商户订单号 type: string ori_sign: description: 签名密文 example: EqHFP0z4a9iaQ1ep== type: string ori_sign_type: description: 签名算法(大小写敏感) example: RSA2 type: string partner_id: description: "2088041181118800" example: 签名被授权方支付宝账号ID type: string type: object SignField: properties: auto_execute: description: 平台自动签 example: "true" type: string signer: $ref: '#/components/schemas/Signer' struct_key: description: 模板组件id example: 18247776929e433784636126b33b08a3 type: string type: object SignFieldBean: properties: sign_field_type: description: "签署类型:\t\tplatform-平台自动签:无需指定签署人。创建流程后,系统将自动盖上商户的默认企业印章。\t\t\ person-个人签署:需要指定签署人个人信息。创建流程后,需通过签署插件完成签署。\torg-企业签署:需要指定签署企业信息与经办人个人信\ 息。创建流程后,需经办人代企业完成签署。(企业暂不支持插件签署,可通过获取签署地址接口获取企业签署地址)" example: person type: string signer: $ref: '#/components/schemas/SignerBean' struct_key: description: 签署区key值 example: signer1 type: string type: object SignMerchantParams: properties: sub_merchant_id: description: 子商户的商户id example: "2088123412341234" type: string sub_merchant_name: description: 子商户的商户名称 example: 滴滴出行 type: string sub_merchant_service_description: description: 子商户的服务描述 example: 免密付车费,单次最高500 type: string sub_merchant_service_name: description: 子商户的服务名称 example: 滴滴出行免密支付 type: string type: object SignParams: properties: access_params: $ref: '#/components/schemas/AccessParams' allow_huazhi_degrade: description: 是否允许花芝GO降级成原代扣(即销售方案指定的代扣产品),在花芝GO场景下才会使用该值。取值:true-允许降级,false-不允许降级。默认为true。 example: false type: boolean external_agreement_no: description: 商户签约号,代扣协议中标示用户的唯一签约号(确保在商户系统中唯一)。 格式规则:支持大写小写字母和数字,最长32位。 商户系统按需传入,如果同一用户在同一产品码、同一签约场景下,签订了多份代扣协议,那么需要指定并传入该值。 example: test20190701 type: string external_logon_id: description: 用户在商户网站的登录账号,用于在签约页面展示,如果为空,则不展示 example: "13888888888" type: string period_rule_params: $ref: '#/components/schemas/PeriodRuleParams' personal_product_code: description: 个人签约产品码,商户和支付宝签约时确定。 example: CYCLE_PAY_AUTH_P type: string product_code: description: 商家和支付宝签约的产品码。 商家扣款产品传入固定值:GENERAL_WITHHOLDING example: GENERAL_WITHHOLDING type: string recommend_sort_channel_params: description: 商户指定优先渠道扣款参数 items: $ref: '#/components/schemas/OpenApiSpecifiedChannelParamsPojo' type: array sign_notify_url: description: 签约成功后商户用于接收异步通知的地址。如果不传入,签约与支付的异步通知都会发到外层notify_url参数传入的地址;如果外层也未传入,签约与支付的异步通知都会发到商户appid配置的网关地址。 example: http://www.merchant.com/receiveSignNotify type: string sign_scene: description: 协议签约场景,商户和支付宝签约时确定,商户可咨询技术支持。 example: INDUSTRY|DIGITAL_MEDIA type: string sub_merchant: $ref: '#/components/schemas/SignMerchantParams' type: object SignRestrictInfo: properties: restrict_product: description: 产品码,支付宝定义的产品码 example: I1011000100000000001 type: string restrict_reason: description: 受限的原因 example: 经营资质不符合要求 type: string restrict_reason_code: description: 受限原因编码 example: "001" type: string restrict_version: description: 受限版本,02-受限版 04-极速版 example: "02" type: string type: object Signer: properties: email: description: 邮箱 example: 593100192@tsign.cn type: string id_number: description: 证件号 example: "330304199806083911" type: string id_type: 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 type: string mobile: description: 手机号 example: "18888888888" type: string name: description: 姓名 example: 姓名 type: string user_id: description: 支付宝userId example: "2088102924502823" type: string type: object SignerBean: properties: email: description: 个人邮箱 example: 593100192@tsign.cn type: string id_number: description: 个人证件号 example: "330304199801011111" type: string id_type: description: 个人证件类型(证件号不为空时必填,详见个人证件类型说明 ) example: CRED_PSN_CH_IDCARD type: string mobile: description: 个人手机号 example: "18888888888" type: string name: description: 个人姓名 example: 折颜 type: string org: $ref: '#/components/schemas/Org' third_party_user_id: description: 个人唯一标识:可传入平台的个人用户id、支付宝userid、证件号、手机号、邮箱等。 example: "2088102924502823" type: string type: object SingleArticleAnalysisData: properties: avg_read_time: description: 人均阅读时长 example: "27.13" type: string date: description: 文章发布日期 example: 2017-09-08 15:00:18 type: string deliver_user_cnt: description: 送达人数 example: 10 type: integer expose_user_cnt: description: 曝光人数 example: 30 type: integer praise_user_cnt: description: 点赞数 example: 20 type: integer read_user_cnt: description: 阅读人数 example: 20 type: integer reply_user_cnt: description: 评论数 example: 30 type: integer share_user_cnt: description: 分享人数 example: 40 type: integer title: description: 文章标题 example: 文章标题 type: string type: object SkuCreateInfo: properties: inventory: description: 库存 example: 100 type: integer material_list: description: SKU素材列表(最多3个) items: $ref: '#/components/schemas/MaterialCreateInfo' type: array original_price: description: 标价,单位分 example: 100 type: integer price: description: 售价,单位分 example: 100 type: integer property_list: description: SKU属性列表 items: $ref: '#/components/schemas/ItemSkuPropertyInfo' type: array type: object SkuModifyInfo: properties: inventory: description: 库存 example: 100 type: integer material_list: description: SKU素材列表(会和SKU已存在素材做差异化比较后做增删改操作) items: $ref: '#/components/schemas/MaterialModifyInfo' type: array original_price: description: 标价,单位分 example: 100 type: integer price: description: 售价,单位分 example: 100 type: integer property_list: description: SKU属性列表(覆盖SKU已存在属性) items: $ref: '#/components/schemas/ItemSkuPropertyInfo' type: array sku_id: description: SKU ID(传空表示新增对应SKU) example: "2018092600502220000000100274" type: string type: object SourceContentInfo: properties: content_id: description: 内容ID example: 20210928OB02001002950004xxxx type: string link: description: 支付宝内容链接 example: alipays://xxxx type: string permission_status: description: 内容分发范围。0 - 仅创作者自己可见,1 - 所有人可见,2 - 分发范围受限。 example: "1" type: string source_author: description: 作者 example: 作者 type: string source_link: description: 来源文章的原始链接地址 example: http://test.xx.com type: string source_media_infos: description: 素材列表 items: $ref: '#/components/schemas/SourceMediaInfo' type: array source_offers: description: 关联服务 items: $ref: '#/components/schemas/SourceOffer' type: array source_publish_date: description: 文章发布时间 example: 2018-09-30 10:10:10 type: string source_status: description: "内容状态\t0-审核中\t1-成功发布\t2-审核不通过\t3-己删除" example: "1" type: string source_summary: description: 文章的摘要 example: 文章的摘要 type: string source_title: description: 内容标题 example: 内容标题 type: string source_type: description: 内容类型(0-长图文 1-短图文 2-视频) example: "1" type: string special_tags: description: "平台加工后的内容标签,例如\tHIGH_QUALITY: 优质" example: "[\"HIGH_QUALITY\"]" items: type: string type: array type: object SourceMediaInfo: properties: media_id: description: 素材ID,对应“支付宝文件上传接口”获取的file_id example: A12334 type: string media_type: description: "素材类型。\t image:图片\t video:视频\tcover_static:静态封面" example: image type: string type: object SourceOffer: properties: offer_id: description: offerId,根据offer类型对应不同ID。支持小程序的APPID/小程序服务的服务编码/优惠券的活动ID example: a2344 type: string offer_type: description: "offer类型。目前仅支持小程序(mini_app/service)、小程序服务(subservice)、营销活动(\ voucher)、商品(goods)、小游戏(game)。\t注意:其中“小程序”offer类型,在发布接口请用mini_app,查询接口返\ 回为service" example: mini_app type: string type: object SpecialVoucher: properties: floor_amount: description: 门槛金额。说明:该字段可不填,认为无门槛; type: string goods_name: description: 商品名称。 type: string origin_amount: description: "原价。\t限制:\t币种为人民币,单位为元。小数点以后最多保留两位;\t取值范围:0.1<=x<=9999。" type: string special_amount: description: 特价,即:原价-特价=优惠金额。 type: string type: object SpecialVoucherInfo: properties: floor_amount: description: 门槛金额。说明:该字段可不填,认为无门槛; type: string special_amount: description: 特价,即:原价-特价=优惠金额。 type: string voucher_deduct_threshold_info: $ref: '#/components/schemas/VoucherDeductThresholdInfo' type: object SpecifyAttachmentInfo: properties: allow_more_uploads: description: 是否允许上传更多附件,默认值为false。开启后,除了“collect_common_codes”中指定的附件,签署人可自由上传至多10张图片。 example: true type: boolean allow_more_uploads_max_count: description: 允许上传更多附件时,可上传的最大附件数,一次流程中累计的上传附件数至多30(含“附件列表”数量) example: 3 type: integer collect_cert_types: description: 需要签署人上传的证件照片,可进行ORC识别,目前仅支持IDCARD example: IDCARD items: type: string type: array collect_common_codes: description: 需要签署人上传的其他附件列表,即attachment_explain.details中定义的code列表 example: phonePicture1 items: type: string type: array third_party_user_id: description: 个人唯一标识,对应签署区中指定的签署人 example: tgxxteck type: string type: object SpiResult: properties: biz_code: description: isv自定义业务代码 example: hotline type: string spi_id: description: spi唯一id example: 1 type: integer type: object SpuAttribute: properties: name: description: 商品属性名 example: 材质 type: string value: description: 商品属性值 example: "[\"纯棉\",\"条轮\"]" items: type: string type: array type: object SpuDetail: properties: brand: description: 商品品牌 example: 思有为 type: string category: description: 商品类目 example: 汽车配件 type: string dimension: description: 商品规格 example: "\"品牌\": \"思有为\", \"颜色分类\":\"黑色\",\"传感器类别\": \"24G\",\"毫米波型号\"\ : 1001,\"最大探测距离\": \"15m\",\"是否支持到店安装\":\"是\",\"传感器数量\": \"2个\"" type: string icon: description: 商品图片地址 example: https://image.baidu.com/search/detail?ct=503316480&z=0&ipn=d type: string link_url: description: 商品链接 example: https://detail.tmall.com/item.htm?id=530187047412&ali_trackid=2:mm_26632614_0_0:1603785697_244_935652742 type: string spu_id: description: 商品ID example: spu001002003004005006 type: string title: description: 商品名称 example: 汽车盲点BSD并线辅助系统盲点监测变道后视镜盲区监控雷达预警 type: string type: object SpuInfo: properties: brand: description: 品牌名称 example: 壳牌 type: string category: description: 类目 example: 美妆 type: string count: description: 商品数量 example: 1 type: integer icon: description: 图片链接 example: http://baidu.com/imge/dfadf.jpg type: string price: description: 商品单价(单位:元) example: "23" type: string provider: description: 商品提供方,店铺或品牌方 example: XX店铺 type: string spu_id: description: 商品ID example: spu12141239912 type: string type: object StandardConditionInfo: properties: rule_factor: description: 条件类型 type: string rule_id: description: 费控条件ID type: string rule_name: description: 费控条件名称 type: string rule_operator: description: "费控条件操作符 枚举值: LT(\"<\",\"小于\") LE(\"<=\",\"小于等于\") EQ(\"=\"\ ,\"等于\") NE(\"!=\",\"不等于\") GE(\">=\",\"大于等于\") GT(\">\",\"大于\")" type: string rule_value: description: 费控条件值 type: string type: object StandardIdInfo: properties: outer_source_id: description: 外部使用规则id example: "123456" type: string standard_id: description: 使用规则id example: "2022020900152608000000000001" type: string type: object StandardInfo: properties: asset_share_source_info: $ref: '#/components/schemas/AssetShareSourceInfo' consume_mode: description: "消费模式,不填为默认模式,枚举值:COUPON_ONLY(仅支持点券)\tCOUPON_AND_CAP(支持点券+余\ 额)\tCOUNT(仅支持次卡)\tDEFAULT(默认模式)\t点券:消费时找员工的点券,没有或者用完了不可付;\t点券+余额:消费时找员\ 工的点券,没有找员工的余额,没有或者用完了不可付;\t次卡:消费时找员工的次卡,没有或者用完了不可付;\t默认:有给员工设置员工余额以员工余\ 额为准,用完为止。否则只受规则里的限额和企业账户资金上限管控;" type: string expense_type_sub_category: description: 费用类型子类,当制度的费用类型为MEAL时,支持到店、外卖;当费用类型为非MEAL时,与费用类型保持一致 type: string open_rule_id: description: 开票规则id,可通过接口alipay.ebpp.invoice.enterpriseconsume.enterpriseopenrule.create 创建并得到开票规则ID type: string outer_source_id: description: 外部使用规则id,制度内使用规则该字段不允许重复 type: string payment_policy: description: 支付策略 当笔消费金额大于规则可用余额时,用于控制支付策略,该字段缺省时采取因公账户和个人账户组合支付策略 type: string standard_condition_info_list: description: 使用规则条件列表 items: $ref: '#/components/schemas/StandardConditionInfo' type: array standard_desc: description: 使用规则描述(敏感词校验) type: string standard_id: description: 制度ID(创建使用规则时非必填) type: string standard_name: description: 规则名称 type: string type: object StandardRuleInfo: properties: effective_end_date: description: 有效期截止 example: 2021-08-27 00:00:00 type: string effective_start_date: description: 有效期起始 example: 2021-08-26 00:00:00 type: string expense_ctrl_rule_info_list: description: 费控条件列表 items: $ref: '#/components/schemas/ExpenseCtrRuleInfo' type: array payment_policy: description: 当笔消费金额大于规则可用余额时,用于控制支付策略,该字段缺省时采取因公账户和个人账户组合支付策略, 枚举值:PERSONAL(全部个人账户支付) example: PERSONAL type: string standard_desc: description: 费控规则说明 example: 费控规则说明测试 type: string standard_id: description: 费控规则ID example: "2021062800152601350000001466" type: string standard_name: description: 费控规则名称 example: 费控规则名称 type: string type: object StandardServiceBaseInfo: properties: biz_status: description: 服务状态 example: INVALID type: string category_id: description: 类目id example: C154984121 type: string service_code: description: 服务code example: S11111 type: string service_name: description: 服务名称 example: 肯德基 type: string type: object StationDetailInfo: properties: code: description: 站点编码 example: "12000020" type: string ext_code: description: 站点外部编码 example: "260000210002" type: string name: description: 站点中文名称 example: 蓝村路 type: string type: object StdPublicBindAccount: properties: agreement_id: description: 协议号是商户会员在支付宝公众账号中的唯一标识。 example: "20131017000001476688" type: string app_id: description: 公众账号ID example: "2013091300001633" type: string bind_account_no: description: 绑定的商户会员号 example: "6226250032060088" type: string display_name: description: 公众账号期望支付宝用户在公众账号首页看到的关于该用户的显示信息,最长10个汉字。 example: 尾号0088 type: string from_user_id: description: 绑定的商户会员对应的支付宝用户号,以2088 开头的16位数字。 example: "2088123412341234" type: string open_id: description: "1" example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string real_name: description: 绑定的商户会员的真实姓名,最长10个汉字。 example: 王小毛 type: string type: object SubButton: properties: action_param: 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个字符,不允许冒号等特殊字符。" type: string action_type: description: "菜单类型:\r\tout——事件型菜单;\r\tlink——链接型菜单;\r\ttel——点击拨打电话;\r\tmap—\ —点击查看地图;\r\tconsumption——点击查看用户与生活号管理员账号之间的消费记录" type: string icon: description: icon图片url,必须是http协议的url,尺寸为60X60,最大不超过5M,请先调用 图片上传接口获得图片url type: string name: description: 菜单名称,icon菜单名称不超过5个汉字,文本菜单名称不超过9个汉字,编码格式为GBK type: string type: object SubFee: properties: charge_fee: description: 实收费用 type: string original_charge_fee: description: 原始费用 type: string switch_fee_rate: description: 签约费率 type: string type: object SubMerchant: properties: merchant_id: description: "支付宝二级商户编号。\t间连受理商户的支付宝商户编号,通过间连商户入驻接口后由支付宝生成。\t直付通和机构间连业务场\ 景下必传。" type: string merchant_type: description: "二级商户编号类型。\t枚举值:\talipay:支付宝分配的间联商户编号;\t目前仅支持alipay,默认可以不传。" type: string type: object SubMerchantCommonEnterOpenModel: properties: extend_fields: description: 扩展字段,为json字符串格式;入驻支付即开票的产品该字段必填,用户白名单,由此字段传入;支付即开票商户配置维度,如果不传默认为SMID_MODE,目前仅支持SMID_MODE和PID_MODE example: "\"{\\\\\"M_WHITE_LIST\\\\\":\\\\\"18997927882\\\\\", \\\\\"PAYMENT_OPEN_MERCHANT_DIMENSION\\\ \\\": \\\\\"PID_MODE\\\\\"}\"" type: string product_code: description: "商户门店入驻的产品码,STANDARD_INVOICE:扫码开票,INVOICE_RETURN:企业自建-发票回传,\ INVOICE_EXPENSE:发票报销,PAYMENT_OPEN:支付即开票,PAY_FEE_OPEN:缴费后开票。" example: STANDARD_INVOICE type: string s_short_name: description: 商户门店所属的服务方简称。 example: SAD type: string type: object SubMerchantEnterOpenModel: properties: extend_fields: description: 扩展字段,为json字符串格式;入驻缴费后开票的产品如果需要传入自定义开票链接,由此字段传入。 example: "\"{\\\\\"MERCHANT_OPEN_URL\\\\\":\\\\\"http://xxx\\\\\"}\"" type: string industry: description: 商户行业,枚举值如下:subway:地铁,etc:ETC,online_car_hailing:网约车,catering:餐饮,hotel:酒店,convenience_store:便利店,oil:加油,insurance:保险,service_provider:运营商,life_payment:生活缴费,political:政务,other:其他 example: hotel type: string pid: description: 开票商户pid,入驻支付即开票场景的时候,非登录账号入驻模式,则该字段必传 example: "2088102143353534" type: string register_no: description: 商户门店税号。 example: 91500000747150346A type: string sub_m_name: description: 商户门店全称。 example: 杭州蚂蚁金服信息技术有限公司 type: string sub_m_short_name: description: 商户门店简称 example: MYJF_HZ type: string type: object SubPackageInfo: properties: builded_package_url: description: 构建好的结果地址 example: 构建好的结果地址 type: string new_builded_package_url: description: 构建好的分包地址 example: 构建好的分包地址 type: string new_size: description: 2.0分包大小,单位字节 example: "1000" type: string path: description: 分包路径 example: main/packageA/packageB type: string size: description: 分包大小,单位字节 example: "1000" type: string source_url: description: 源码地址 example: 源码地址 type: string type: description: 分包类型: MAIN | SUB example: MAIN type: string type: object SubServiceKeyWordInfo: properties: app_name: description: 小程序名称 example: 小程序名称 type: string keyword_info: description: 此服务下的关键词 items: $ref: '#/components/schemas/KeyWordInfo' type: array mini_app_id: description: 小程序ID example: "2021002172648359" type: string sub_service_code: description: 子服务code example: "2022051021000880652471" type: string sub_service_desc: description: 子服务简单描述 example: 这是个服务 type: string sub_service_name: description: 子服务名 example: 这是服务名字 type: string sub_service_status: description: "子服务状态,\tINITIAL:初始化:VALID:已生效;INVALID:已失效" example: INVALID type: string type: object SubTaskInfo: properties: execute_result: description: 子任务执行结果;执行成功为成功,失败则填充失败结果 example: 航旅交通1经营内容涉及传销,金融互助平台不合作; type: string status: description: "子任务状态\t状态 INIT:初始化 FAILURE:失败 FINISH:成功" example: INIT type: string type: description: "子任务类型\tSIGN_TASK:签约子任务\tOPE_TASK:代运营授权子任务\tAPP_TASK:应用授权子任\ 务" example: SIGN_TASK type: string type_desc: description: 子任务类型描述 example: 签约子任务 type: string type: object SubscribeRelation: properties: keep_state: description: "订阅保持状态,即用户勾选“总是保持以上选择,不再询问”选项时勾选的订阅状态。枚举值:\t1:保持订阅。\t0:保持拒\ 绝订阅。\t说明:若用户“总是保持以上选择,不再询问”选项,且选择订阅消息。下次触发消息订阅组件时,支付宝将自动发起一次静默订阅(不再拉起订\ 阅组件,无需用户手动订阅)。" example: "0" type: string show: description: "模板是否展示在订阅组件中。枚举值:\ttrue:订阅组件中展示查询的模板。\tfalse:订阅组件中不展示模板" example: true type: boolean subscribe_state: description: "订阅状态。枚举值\t0:拒绝订阅。\t1:订阅" example: "0" type: string subscribe_type: description: "消息模板的订阅类型。枚举值:\tlongterm:长期性订阅\tonetime:一次性订阅" example: longterm type: string template_id: description: 消息模板id example: 7c866fab64464afaa956223c74ce6cbc type: string type: object SuccessDeliveryConfig: properties: delivery_config: $ref: '#/components/schemas/DeliveryConfig' type: object TargetInfo: properties: target_id: description: 应用id,例如小程序id example: "2018001307627807" type: string target_type: description: "应用类型\t小程序传入:APPID\t生活号传入:PUBLICID" example: APPID type: string type: object TaskTypeData: properties: name: description: 商户数据回传的任务名称,供C端展示。当累计的数据类型为任务类型时,此为必传字段 example: 滴滴打车任务001 type: string type: object Template: properties: context: $ref: '#/components/schemas/Context' template_id: description: 消息模板ID example: cbb9fdded2b74fe4bb082de3ed1e1eb2 type: string type: object TemplateActionInfoDTO: properties: code: description: 行动点业务CODE,商户自定义 type: string mini_app_url: $ref: '#/components/schemas/TemplateActionMiniAppUrlDTO' text: description: 行动点展示文案 type: string url: description: 行动点跳转链接,当url_type填"url"或不填时必填,支持http(s)和支付宝schema地址等 type: string url_type: description: "跳转链接类型,不填则默认为url类型:\t\turl:对应填写url参数\t\tminiAppUrl: 对应填写mini_app_url参\ 数,跳转至指定的支付宝小程序页面" type: string type: object TemplateActionMiniAppUrlDTO: properties: display_on_list: description: "行动点按钮是否在列表页展示,true 或 false,不填则默认false;\t\t列表页可以配置展示最多2项小程序\ 跳转行动点。" type: string mini_app_id: description: 小程序appId type: string mini_page_param: description: 指定小程序页面,不填则默认跳转至对应小程序首页 type: string mini_query_param: description: query参数,商户自定义传参,填入值将以"query"为参数名提交至指定小程序页面 type: string type: object TemplateBenefitInfoDTO: properties: benefit_desc: description: 权益描述信息 items: type: string type: array end_date: description: 权益结束时间 type: string start_date: description: 权益开始时间 type: string title: description: 权益描述 type: string type: object TemplateCardLevelConfDTO: properties: level: description: 会员级别 该级别和开卡接口中的level要一致 type: string level_desc: description: 会员级别描述 type: string level_icon: description: "会员级别对应icon图片,\t\t会员信息预留字段,暂不在用户端展示;\t\t通过接口(alipay.offline.material.image.upload)\ 上传图片" type: string level_show_name: description: 会员级别显示名称 type: string type: object TemplateColumnInfoDTO: properties: code: description: "标准栏位:行为由支付宝统一定,同时已经分配标准Code\r\tBALANCE:会员卡余额\r\tPOINT:积分\r\ \tLEVEL:等级\r\tTELEPHONE:联系方式\r\t自定义栏位:行为由商户定义,自定义Code码(只要无重复)" type: string group_title: description: "若template_style_info.column_info_layout\t的值为grid,此项为宫格项所属分\ 组标题。可空。如果需要展示该项,还需支付宝内部进行特殊配置。" type: string icon_id: description: "当template_style_info.column_info_layout\t的值为grid时,此参数必填。此项\ 为宫格项的展示icon。通过接口(alipay.offline.material.image.upload)上传图片。" type: string more_info: $ref: '#/components/schemas/MoreInfoDTO' operate_type: description: "1、openNative:打开二级页面,展现 more中descs\t\t2、openWeb:打开URL\t\t3、\ staticinfo:静态信息\t\t注意:\t\t不填则默认staticinfo;\t\t标准code尽量使用staticinfo,例如\ TELEPHONE商家电话栏位就只支持staticinfo;" type: string tag: description: "只有当template_style_info.column_info_layout\t的值为grid时,此参数有效。\ 此项为宫格项标签,最多只会展示一个标签。" type: string title: description: 栏目标题 type: string value: description: "卡包详情页面,卡栏位右边展现的值\r\t\r\tTELEPHONE栏位的商家联系电话号码由此value字段传入" type: string type: object TemplateFieldRuleDTO: properties: field_name: description: 字段名称 type: string rule_name: description: "规则名\t\t1、ASSIGN_FROM_REQUEST: 以rule_value为key值,表示该栏位的值从会\ 员卡开卡接口中获取,会员卡开卡接口的card_info中获取对应参数值\t\t2、DATE_IN_FUTURE: 生成一个未来的日期(格式\ YYYY-MM-DD),当选择DATE_IN_FUTURE的时候,field_name 必须是OpenDate或ValidDate, 值为\ (10m或10d 分别表示10个月或10天)\t\t3、CONST: 常量,会员卡开卡接口进行开卡的时候使用模板创建时候设置的值,即取rule_value的\ 值" type: string rule_value: description: "规则值,根据rule_name,采取相应取值策略\t\tCONST:直接取rule_value作为卡属性值\t\t\ DATE_IN_FUTURE:10m或10d 分别表示10个月或10天\t\tASSIGN_FROM_REQUEST:在开卡Reuqest请\ 求中按rule_value取值,现在和field_name对应的为(OpenDate、ValidDate、Level、Point、Balance)" type: string type: object TemplateFormConfig: properties: fields: $ref: '#/components/schemas/TemplateFormFields' open_card_mini_app_id: description: 入会时承接入会弹层的小程序appId type: string type: object TemplateFormFields: properties: optional: description: 开卡表单可填字段,可选字段选项不能与必填字段required重复 items: type: string type: array required: description: 开卡表单必填字段,必填字段必须有一个值,并且不能与可选字段optional里面重复 items: type: string type: array type: object TemplateInfo: properties: fill_contents: description: 模板填充项 items: $ref: '#/components/schemas/FillContent' type: array name: description: 文件名称 example: iphone手机签收单 type: string signfields: $ref: '#/components/schemas/SignField' template_id: description: 模板id example: 6b95e887c4b342a8b6501bd334b286df type: string type: object TemplateInfoBean: properties: fill_contents: description: 模板填充项,根据组件key值传入填写内容 items: $ref: '#/components/schemas/FillContent' type: array name: description: 签署文件名称 example: iPhone手机签收单 type: string signfields: description: 签署区,根据签署区key值传入对应的签署人信息 items: $ref: '#/components/schemas/SignFieldBean' type: array template_id: description: 模板id,通过创建合同模板获取 example: 6b95e887c4b342a8b6501bd334b286df type: string type: object TemplateMdcodeNotifyConfDTO: properties: ext_params: description: "扩展参数信息;\t\t格式为key-value键值对;\t\t支付宝POST请求指定url时,除BizCardNo等\ 固定参数外,将带上ext_params中配置的所有key-value参数。" type: string url: description: "商户接收发码通知的地址链接;\t\t只支持https地址;\t\t用户打开会员卡时,支付宝提交POST请求此url地\ 址,通知商户发码。" type: string type: object TemplateOpenCardConfDTO: properties: card_rights: description: 领卡权益信息 items: $ref: '#/components/schemas/TemplateRightsContentDTO' type: array conf: description: 配置,预留字段,暂时不用 type: string open_card_source_type: description: 开卡渠道类型 type: string open_card_url: description: 开卡链接,必须http、https开头 type: string source_app_id: description: 渠道APPID,提供领卡页面的服务提供方 type: string type: object TemplateRightsContentDTO: properties: detail: description: 权益内容详情 type: string logo_id: description: 权益icon图片Id(目前用于开卡授权页使用),通过接口(alipay.offline.material.image.upload)上传图片 type: string title: description: 权益内容标题 type: string type: object TemplateStyleInfoDTO: properties: background_id: description: "背景图片Id,通过接口(alipay.offline.material.image.upload)上传图片\t\t\t\ \t图片说明:2M以内,格式:bmp、png、jpeg、jpg、gif;\t\t尺寸不小于1020*643px;\t\t图片不得有圆角,不得\ 拉伸变形" type: string banner_img_id: description: banner图片id。 通过接口(alipay.offline.material.image.upload)上传图片。 type: string banner_url: description: banner跳转地址。 type: string bg_color: description: 字体颜色(非背景色),只影响卡详情中部信息区域字体颜色 type: string brand_name: description: 品牌商名称 type: string card_show_name: description: 钱包端显示名称 type: string color: description: 注意:此字段已废弃。 type: string column_info_layout: description: 如果为空则默认为list。 type: string feature_descriptions: description: 特色信息,用于领卡预览 items: type: string type: array front_image_enable: description: "设置是否在卡面展示(个人头像)图片信息,默认不展示;\t\t当前仅用于身份验证信息类型的个人头像图片;\t\t图片\ id随创建卡/更新卡时传入;\t\t详见会员卡产品文档。" type: boolean front_text_list_enable: description: "设置是否在卡面展示文案信息,默认不展示;\t\t文案信息分行展示,最多展示4行文案,每行文案分为label和value两\ 部分;\t\t文案实际内容随创建卡/更新卡时传入;\t\t详见会员卡产品说明文档。" type: boolean logo_id: description: "logo的图片ID,通过接口(alipay.offline.material.image.upload)上传图片\t\ \t\t\t图片说明:1M以内,格式bmp、png、jpeg、jpg、gif;\t\t尺寸不小于500*500px的正方形;\t\t请优先使\ 用商家LOGO;" type: string slogan: description: 标语 type: string slogan_img_id: description: 标语图片id, 通过接口(alipay.offline.material.image.upload)上传图片 type: string type: object TemplateUsageInfo: properties: app_version: description: 商家小程序版本号 example: 0.0.1 type: string mini_app_id: description: 商家小程序appId example: "2018011111111111" type: string type: object Text: properties: content: description: 文本消息的内容 type: string title: description: 文本消息的标题 type: string type: object TicketDetailInfo: properties: amount: description: 总金额,元为单位 example: "10.00" type: string end_station: description: 终点站编码 example: "21003002" type: string end_station_name: description: 终点站中文名称 example: 浦电路 type: string quantity: description: 票数量 example: "8" type: string start_station: description: 起点站编码 example: "12300002" type: string start_station_name: description: 起点站中文名称 example: 蓝村路 type: string status: description: 订单状态 example: SUCCESS type: string ticket_price: description: 单价,元为单位 example: "5.00" type: string ticket_type: description: 票类型 example: oneway type: string trade_no: description: 支付宝交易号 example: "0123456789" type: string type: object TicketInfo: properties: address: description: 店铺地址 example: 上海市南泉北路447号 type: string end_time: description: 截止时间 example: 2020-01-21 11:30:00 type: string resv_type: description: 凭证预约类型,一般不需要传入。可选值为INSTANT/RESERVATION,其中INSTANT代表是实时凭证,RESERVATION代表是预约凭证,不传入默认为实时凭证。区别在于预约凭证一般不是当场可取,而是用户下单后的很多天之后才可以凭借凭证提取 example: RESERVATION type: string shop: description: 凭证可核销门店/货品自提门店,如果自提门店与购买门店不一致,可传入该字段提示用户自提门店 example: 杭州面馆西溪路店 type: string ticket_no: description: "单据号\t不同类型下单据号含义不同。若类型为MEAL_NUM,则ticket_no表示取餐号;若类型为PICKUP_CODE,\ 则ticket_no表示取件码;其他类型查看小程序订单产品文档" example: A0001 type: string time: description: 时间 example: 2020-01-21 11:02:02 type: string type: description: "凭证类型\t具体类型查看产品文档" example: MEAL_NUM type: string type: object TicketOrderInfo: properties: arrival: $ref: '#/components/schemas/JourneyLocation' content: description: 凭证内容 example: 凭证内容 type: string departure: $ref: '#/components/schemas/JourneyLocation' effective_num: description: 凭证有效数 example: 1 type: integer end_time: description: 凭证结束时间 example: 2021-01-02 12:21:22 type: string ext_info: description: 扩展信息 items: $ref: '#/components/schemas/OrderExtInfo' type: array face_value: description: 票面价 example: "9.99" type: string functional_services: description: 功能服务信息 items: $ref: '#/components/schemas/FunctionalService' type: array invalid_reason: description: 凭证失效原因 example: 用户取消 type: string locations: description: 凭证可使用地点 items: $ref: '#/components/schemas/JourneyLocation' type: array merchant_ticket_no: description: 商户侧凭证ID或核销码 example: out_20210820 type: string seat_infos: description: 座位信息 items: $ref: '#/components/schemas/SeatInfo' type: array service_provider: $ref: '#/components/schemas/OrderParticipantInfo' shops: description: 凭证可使用门店列表 items: $ref: '#/components/schemas/OrderShopInfo' type: array start_time: description: 凭证开始时间 example: 2020-01-01 08:00:00 type: string status: description: 凭证状态 example: TICKETED type: string ticket_create_time: description: 凭证创建时间 example: 2020-01-01 08:00:01 type: string ticket_modify_time: description: 凭证修改时间 example: 2020-01-01 08:00:01 type: string ticket_num: description: 凭证购买数 example: 2 type: integer ticket_users: description: 凭证使用者信息 items: $ref: '#/components/schemas/UserInfomation' type: array title: description: 凭证标题 example: 上海-杭州 type: string vehicle_info: $ref: '#/components/schemas/OrderVehicleInfo' type: object TimeRangeInfo: properties: begin_time: description: 开始时间 格式:HH:mm:ss type: string end_time_info: $ref: '#/components/schemas/EndTimeInfo' type: object TimeRestrictInfo: properties: disable_period_info: description: 不可用时间段 items: $ref: '#/components/schemas/VoucherUseTimeRuleInfo' type: array usable_period_info: description: 可用时间段 items: $ref: '#/components/schemas/VoucherUseTimeRuleInfo' type: array type: object TimesTypeSyncData: properties: discount_amount: description: 商户回传的优惠金额,如用户享受的红包金额,单位元 example: "8.75" type: string discount_desc: description: 商户数据回传的优惠信息的名称。 example: 消费满减优惠001 type: string task_amount: description: 用户和商户发生交易的交易单金额,单位元。 example: "3.57" type: string task_desc: description: 任务描述 example: 完成一次任务001 type: string task_times: description: 当为次数型任务时必须传。 example: 1 type: integer type: object TipsDelivery: properties: delivery_content: description: 收藏引导文案内容,不得超过14个字 example: 点击收藏,下次访问更方便 type: string delivery_id: description: 收藏引导投放活动ID example: "20211114000003057595" type: string delivery_name: description: 收藏引导活动名称 example: 首页收藏引导投放活动 type: string end_time: description: 活动结束时间 example: 2021-12-23 14:29:00 type: string fail_reason: description: 文案审核驳回理由,仅状态为AUDIT_REJECTED时有效 example: 当前文案语义不通顺,请修改 type: string match_type: description: 匹配类型 example: TARGETURL type: string match_url: description: 目标页面地址,当匹配类型为TARGETURL时,投放文案仅在当前页面生效 example: /page/web type: string start_time: description: 活动开始时间 example: 2021-11-11 14:31:13 type: string status: description: 活动状态 example: WORKING type: string type: object Topic: properties: img_url: description: 营销位图片url example: https://oalipay-dl-django.alicdn.com/rest/1.0/image?fileIds=xxx&zoom=xxx type: string link_type: description: 跳转类型,网页:HTTP、小程序:APP example: HTTP type: string link_url: description: 营销位跳转地址,点击营销位头图跳到的链接url。 example: https://www.alipay.com type: string sub_title: description: 营销位描述 example: 营销位描述 type: string title: description: 营销位名称 example: 营销位名称 type: string topic_id: description: 营销位id example: CG202011131013300867029 type: string topic_items: description: 营销位内容列表 items: $ref: '#/components/schemas/TopicItem' type: array type: object TopicItem: properties: img_url: description: "内容图片url, 尺寸为300*300,最大不超过3M,支持格式:.jpg、.png ,请先调用 图片上传接口获得图片url" type: string link_type: description: 跳转类型,网页:HTTP、小程序:APP,不传默认HTTP type: string link_url: description: 跳转链接,点击营销位内容图片跳到的链接url type: string sub_title: description: 内容说明 type: string title: description: 内容标题 type: string type: object TradeComplainQueryResponse: properties: complain_event_id: description: 支付宝侧投诉单号 example: "2020092300102000000001459758" type: string complain_reason: description: 投诉原因 example: 重复扣款 type: string content: description: 已经扣除了我的钱,为什么再次扣款??? example: 投诉内容 type: string gmt_create: description: 投诉单创建时间 example: 2020-02-14 14:23:12 type: string gmt_finished: description: 投诉单结束时间 example: 2020-02-14 14:23:12 type: string gmt_modified: description: 投诉单修改时间 example: 2020-02-14 14:23:12 type: string images: description: 投诉图片 example: "[\"http://mdn.alipay.com/wsdk/img?fileid=A*ME4GQq2j-5oAAAAAAAAAAAAAAQAAAQ&t=83fed12ef006ebcd8df04dfe79faad6c&bi=openpunsh&ts=0&zoom=original\"\ ]" items: type: string type: array leaf_category_name: description: 投诉诉求 example: 我要退款 type: string merchant_order_no: description: 商家订单号 example: tp1234567899 type: string phone_no: description: 投诉人电话号码 example: "15768789890" type: string status: description: "状态\t商家处理中:MERCHANT_PROCESSING\t商家已反馈:MERCHANT_FEEDBACKED\t\ 投诉已完结:FINISHED\t投诉已撤销:CANCELLED\t平台处理中:PLATFORM_PROCESSING\t平台处理完结:PLATFORM_FINISH\t\ 系统关闭:CLOSED" example: MERCHANT_PROCESSING type: string target_id: description: 应用id,例如小程序id、生活号id、商家pid example: "2018001307627807" type: string target_type: description: "应用类型\t小程序为:APPID\t生活号为:PUBLICID\t商家为:PID" example: APPID type: string trade_no: description: 支付宝交易号 example: "2020092322001448341410785740" type: string type: object TradeFundBill: properties: amount: description: 该支付工具类型所使用的金额。单位:元。 type: string bank_code: description: 银行卡支付时的银行代码 type: string fund_channel: description: 交易使用的资金渠道,详见 支付渠道列表 type: string fund_type: description: "渠道所使用的资金类型,目前只在资金渠道(fund_channel)是银行卡渠道(BANKCARD)的情况下才返回该信\ 息" type: string real_amount: description: 渠道实际付款金额 type: string type: object TradeFundBillDetail: properties: amount: description: 交易金额 type: string asset_type_code: description: 资产类型编码 type: string asset_user_id: description: 资产的属主 type: string asset_user_open_id: description: 资产的属主openid type: string biz_pay_type: description: "支付业务类型\t\tPAY-支付\t\tREFUND-退款" type: string create_time: description: 创建时间 type: string payment_no: description: 支付单据号 type: string type: object TradeInfoDTO: properties: buyer_id: description: 买家ID example: "208888888888" type: string create_time: description: 交易创建时间 example: 2010-11-11 11:11:11 type: string platform_order_id: description: 外部平台订单号 example: "781773393333012410369282" type: string total_amount: description: 订单总金额 example: "88" type: string trade_amount: description: 订单总金额 example: "88" type: string trade_fund_bill_list: description: 资金单明细 items: $ref: '#/components/schemas/TradeFundBillDetail' type: array trade_no: description: 交易单号 example: "1231231321321" type: string trade_status: description: 交易状态:WAIT_BUYER_PAY(交易创建,等待买家付款)、TRADE_CLOSED(未付款交易超时关闭,或支付完成后全额退款)、TRADE_SUCCESS(交易支付成功)、TRADE_FINISHED(交易结束,不可退款) example: TRADE_SUCCESS type: string type: object TradeItemResult: properties: alipay_order_no: description: 支付宝订单号。对账使用,不脱敏 type: string gmt_create: description: 交易创建时间 type: string gmt_pay: description: 交易支付时间 type: string gmt_refund: description: 交易退款时间 type: string goods_memo: description: 商品备注信息 type: string goods_title: description: 商品名称 type: string merchant_order_no: description: 商户订单号,创建支付宝交易时传入的信息。对账使用,不脱敏 type: string net_mdiscount: description: 商家优惠金额 type: string other_account: description: 对方账户 type: string refund_amount: description: 订单退款金额 type: string service_fee: description: 服务费金额 type: string store_name: description: 门店名称 type: string store_no: description: 门店编号 type: string total_amount: description: 订单金额 type: string trade_status: description: "订单状态(待付款,成功,关闭,待发货,待确认收货,已预付,进行中)" type: string trade_type: description: 业务类型,帮助商户作为对账参考 type: string type: object TradeSettleDetail: properties: amount: description: 实际操作金额,单位为元,两位小数。该参数的值为分账或补差或结算时传入 example: "10.00" type: string operation_dt: description: 操作日期 example: 2019-05-16 09:59:17 type: string operation_serial_no: description: 商户操作序列号。商户发起请求的外部请求号。 example: "2321232323232" type: string operation_type: description: "结算操作类型。有以下几种类型:\treplenish(补差)、replenish_refund(退补差)、transfer(分\ 账)、transfer_refund(退分账)、settle(结算)、settle_refund(退结算)、on_settle(待结算)。" example: replenish type: string ori_trans_in: description: 商户请求的转入账号 example: "2088111111111111" type: string ori_trans_out: description: 商户请求的转出账号 example: "2088111111111111" type: string trans_in: description: 转入账号 example: "2088111111111111" type: string trans_out: description: 转出账号 example: "2088111111111111" type: string type: object TradeSettleInfo: properties: trade_settle_detail_list: description: 交易结算明细信息 items: $ref: '#/components/schemas/TradeSettleDetail' type: array trade_unsettled_amount: description: 直付通账期、直连账期下返回,其他场景为空,表示一笔订单剩余待结算金额 example: "1.1" type: string type: object TransferAccountBookDetailResult: properties: account: description: 付款/收款账户。充值记录中是付款账户。提现、转账记录中是收款账户。支付宝名称及账号脱敏;银行账户的户名脱敏,银行账户显示银行名称+银行卡号后四位 example: '*三(招商银行2456)' type: string amount: description: 金额 example: "100.00" type: string biz_desc: description: 业务类型描述。可用于区分业务类型,和不同子账本 example: "薪资代发-明细转账-I{2088000117463004}" type: string fund_desc: description: 资金来源/去向类型。在充值记录中,表示资金来源类型,在转账和提现类型中,表示去向类型 example: 银行卡 type: string instruction_id: description: 银行单据号。对账使用,无需脱敏 example: 20190101*** type: string memo: description: 备注信息 example: 普通充值 type: string order_no: description: 业务订单号。该笔业务单据的唯一识别编号 example: 20190101*** type: string service_fee: description: 服务费金额 example: "1.00" type: string status: description: 资金状态 example: 成功 type: string sub_type_desc: description: 子类型。“充值类型”,普通充值、大额充值。“转账类型”,暂无实现。转账至支付宝账户、转账至银行卡、批量转账支付宝账户、批量转账至银行卡、批量付款。“提现类型”,暂无实现。普通提现、批量委托提现。对账使用,无需脱敏 example: 普通充值 type: string trans_dt: description: 业务发生时间 example: 2019-01-01 00:00:00 type: string type_desc: description: 查询类型描述:充值、转账、提现 example: 充值 type: string type: object TransferDetailResult: properties: account: description: 付款/收款账户。充值记录中是付款账户。提现、转账记录中是收款账户。支付宝名称及账号脱敏;银行账户的户名脱敏,银行账户显示银行名称+银行卡号后四位 example: '*三(招商银行2456)' type: string amount: description: 金额 example: "100.00" type: string fund_desc: description: 资金来源/去向类型。在充值记录中,表示资金来源类型,在转账和提现类型中,表示去向类型 example: 银行卡 type: string instruction_id: description: 银行单据号。对账使用,无需脱敏 example: 20190101*** type: string memo: description: 备注信息 example: 普通充值 type: string order_no: description: 业务订单号。该笔业务单据的唯一识别编号 example: 20190101*** type: string service_fee: description: 服务费金额 example: "1.00" type: string status: description: 资金状态 example: 成功 type: string sub_type_desc: description: 子类型。“充值类型”,普通充值、大额充值。“转账类型”,暂无实现。转账至支付宝账户、转账至银行卡、批量转账支付宝账户、批量转账至银行卡、批量付款。“提现类型”,暂无实现。普通提现、批量委托提现。对账使用,无需脱敏 example: 普通充值 type: string trans_dt: description: 业务发生时间 example: 2019-01-01 00:00:00 type: string type_desc: description: 查询类型描述:充值、转账、提现 example: 充值 type: string type: object TreeInfo: properties: id: description: 类目树ID example: 1 type: integer instance_code: description: 知识库对应的类目树名称,与treeId不可同时为空 example: TREE_cVE_MHk8_1532332260914 type: string name: description: 类目名称 example: 蚂蚁科技 type: string type: object UnfreezeExtendParams: properties: quit_type: description: 退出类型 example: SETTLE_APPLY_QUIT type: string total_discount_amount: description: 芝麻Go开始到到期过程中享受的优惠总金额 example: "3.00" type: string total_real_pay_amount: description: 芝麻Go开始到到期过程中任务相关支付的总金额。 example: "3.00" type: string total_task_count: description: 芝麻Go开始到到期过程中和任务相关的完成次数 example: "0" type: string type: object UpdatedAuthenticationDetails: properties: authentication_mechanisms: description: 鉴权机制 example: ApplicationRedirect items: type: string type: array nonce: description: 随机数 example: 4A941B84 type: string partial_transaction_details_signature: description: 交易签名信息 example: U2VydmVyIGdlbmVyYXRlZCB0cmFuc2FjdGlvbiBkZXRhaWxzIHNpZ25hdHVyZQ== type: string pin_format: description: 6位密码或者长密码 example: sixDigits type: string signing_key_material: description: 签名秘钥 example: U2lnbmluZyBrZXkgbWF0ZXJpYWw= type: string type: object UseRule: properties: ext_info: description: 扩展属性,无需设置 example: \"key\":\"value\" type: string forbidden_time: $ref: '#/components/schemas/ForbbidenTime' limit_rule: 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 type: string min_consume: description: 券核销的最低消费门槛,单位元 example: "10" type: string pay_redirect_url: description: 券买单跳转链接 example: https://mycar-parkingplatform.alipay-eco.com/pbizplatform/park/parking/stayPayCarList?entrance=1 type: string suit_shops: description: "券适用门店列表\r\t仅品牌商发起的招商活动可为空\r\t直发奖类型活动必须与活动适用门店一致\r\t最多支持10w家\ 门店" example: "2015110600077000000002125023,2015110600077000000002125022" items: type: string type: array use_time: description: 券可用时间段 items: $ref: '#/components/schemas/UseTime' type: array type: object UseTime: properties: dimension: description: 券可用时段时间维度,目前支持周(W) example: W type: string times: 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" type: string values: description: "券可用时间维度值\r\t周维度的取值范围1-7(周一至周日),多个可用时段用逗号分隔\r\t如\"1,3,5\",对\ 应周一,周三,周五可用" example: "1,3,5" type: string type: object UserAnalysisData: properties: cancel_user_cnt: description: 取消关注人数 example: "40" type: string cumulate_user_cnt: description: 累积关注人数 example: "60" type: string date: description: 日期 example: "20171101" type: string grow_user_cnt: description: 净增关注人数 example: "20" type: string new_user_cnt: description: 新关注人数 example: "30" type: string type: object UserAssetInfoVO: properties: asset_id: description: 资产ID example: "2088123412341234" type: string asset_type: description: 资产类型 example: ACCOUNT_BOOK_ID type: string user_id: description: 支付宝用户ID example: 2088XXXX type: string user_open_id: description: 支付宝用户开放ID example: ioe2318sjrahdsksmvj28471 type: string type: object UserDetails: properties: user_change_mobile: description: 用户变更手机号,替换旧的手机号 type: string user_mobile: description: 孩子家长的手机号 type: string user_name: description: 张三 type: string user_relation: description: 孩子与家长的关系: 1、爸爸 2、妈妈 3、爷爷 4、奶奶 5、外公 6、外婆 7、家长 type: string type: object UserIdentityInfo: properties: h_school_info: $ref: '#/components/schemas/HSchoolInfo' type: object UserInfomation: properties: cert_no: description: 证件号 type: string cert_type: description: 证件类型。 type: string ext_info: description: 扩展信息 items: $ref: '#/components/schemas/OrderExtInfo' type: array mobile: description: 手机号 type: string name: description: 姓名 type: string open_id: description: 支付宝用户openId type: string user_id: description: 支付宝用户ID,可以通过支付结果通知、用户授权等渠道获取 type: string type: object UserInvoiceInfoOpenApiResponse: properties: accept_electronic: description: (AR开票使用)是否接受电子票 true:是,false:否 example: true type: boolean address: description: 公司注册地址 example: 广州市增城区新塘镇沿江大道20号1601房 type: string auto: description: (AR开票使用)是否自动申请开票 true:是,false:否 example: true type: boolean bank_account: description: 银行账户 example: "3602201309100137669" type: string bank_name: description: 开户行 example: 中国工商银行广州市第二支行 type: string business_licence_url: description: 营业执照地址 example: gfcenter/inv/userinvoicefile/aruserprofilepic_2088721075211978_15133031297372951.jpg type: string creator: description: 资料创建人 example: 李某某 type: string gmt_create: description: 创建时间 example: "1533039333744" type: string gmt_modified: description: 修改时间 example: "1533039333744" type: string hold: description: "(AR开票使用)是否暂停开票\r\ttrue:暂停开票,false:可开票" example: true type: boolean id: description: 开票资料ID example: "2017061410122000544800280000000001" type: string ip_id: description: "商户PID,\r\ttype=01时表示OU用户,填充的是InstId机构代码,例如Z50,\r\ttype=02时\ 表示商户MID,\r\ttype=03时表示商户PID" example: "10000004" type: string last_modifier: description: 最后修改人 example: 李某某 type: string open_account_permit_url: description: 银行开户许可证地址 example: gfcenter/inv/userinvoicefile/aruserprofilepic_2088721075211978_15133031297372951.jpg type: string other_qualification_url: description: 其它资质证明地址 example: gfcenter/inv/userinvoicefile/aruserprofilepic_2088721075211978_15133031297372951.jpg type: string status: description: 资料状态,01:待审,02:已审(有效), 03:已作废 example: "02" type: string task_date: description: "上一次任务执行时间(针对自动开票场景),格式:YYYYMMDD" example: "20180723" type: string tax_no: description: 纳税人识别号(购方税号) example: 91440106058924978D type: string tax_payer_qualification: description: "纳税人开票资格种类\r\t01:一般纳税人,02:小规模纳税人" example: "01" type: string tax_qualification_url: description: 一般纳税人资格证书地址 example: gfcenter/inv/userinvoicefile/aruserprofilepic_2088721075211978_15133031297372951.jpg type: string tax_reg_cert_url: description: 税务登记证地址 example: gfcenter/inv/userinvoicefile/aruserprofilepic_2088721075211978_15133031297372951.jpg type: string taxpayer_quali_valid: description: 纳税人资格开始时间 (时间戳) example: "1533039333744" type: string telephone: description: 公司注册电话 example: 0571-82523768 type: string title: description: 发票抬头 example: 支付宝 type: string tnt_inst_id: description: 租户ID example: ANTGW2CN type: string type: description: "开票资料用户类型 \r\t01:OU,02:商户,03:C用户" example: "02" type: string user_mail_info_list: description: 收件人地址列表 items: $ref: '#/components/schemas/UserMailInfoVO' type: array type: object UserMailInfoOrder: properties: city: description: 联系所在城市 type: string country: description: 联系人国家 type: string county_district: description: 联系人所在县/区 type: string detail_address: description: 联系所在详细地址 type: string email: description: 电子邮箱 type: string ip_role_id: description: 商户ipRole(pid) type: string name: description: 联系人名字 type: string province: description: 联系人省份 type: string street: description: 联系人所在街道 type: string telephone: description: 联系人电话 type: string type: object UserMailInfoVO: properties: address: description: 收件人地址 example: 中国|浙江省|杭州市|西湖区|蒋村街道|10号楼99号 type: string city: description: 城市 example: 杭州市 type: string country: description: 国家 example: 中国 type: string county_district: description: 县区 example: 西湖区 type: string detail_address: description: 详细地址 example: 10号楼99号 type: string email: description: 邮件人的电子邮箱 example: hahaha@alipay.com type: string gmt_create: description: 创建时间 example: "1533039333744" type: string gmt_modified: description: 修改时间 example: "1533039333744" type: string id: description: 收件人信息ID example: "2017031410122000565000480000002129" type: string name: description: 收件人姓名 example: 朱文三 type: string pid: description: "pid用于指定该地址归属的PID,应对集团模式的商户所设定,发票邮寄地址根据PID确定" example: "2088812004337486" type: string province: description: 省份 example: 浙江省 type: string street: description: 街道 example: 蒋村街道 type: string telephone: description: 收件人电话 example: 0891-3983888 type: string type: object UserRiskPrediction: properties: phone_recycle_risk_leve: description: "用户绑定手机号被二次放号风险等级。\tNO_RESULT:手机号风险未入库\tNO_RISK:用户绑定手机无二次放号\ 风险,高置信度\tLOW_RISK:用户绑定手机二次放号风险较小,商户自行决策是否相信。\tHIGH_RISK:用户绑定手机已被放号,高置信\ 度" example: HIGH_RISK type: string refused_payment_risk_level: description: "用户拒付风险等级。\tNO_SIGN:商户未签约。\tNO_RESULT:未查询到账户信息。\tLOW_RISK:用\ 户拒付风险为低;处理建议:用户可以先享受服务,再进行支付。\tMEDIUM_RISK:用户拒付风险为中;处理建议:根据业务场景客户自行判断提\ 供或者不提供。\tHIGH_RISK:用户拒付风险为高;处理建议:不建议先提供给用户服务。" example: HIGH_RISK type: string type: object UserTradeInfoDTO: properties: goods_info_list: description: 商品信息列表 items: $ref: '#/components/schemas/GoodsInfoDTO' type: array partner_id: description: 门店ISV的PID example: "208881123" type: string risk_level: description: 是否是风险交易:NO_RISK-无风险;POTENTIAL_RISK-潜在风险(中等风险);HIGH_RISK-高风险 example: NO_RISK type: string trade_amount: description: 交易总金额,单位元,精确两位小数点 example: "68.12" type: string trade_no: description: 交易单号 example: "202110000111" type: string trade_time: description: 交易时间 example: 2022-02-11 00:00:00 type: string unfiltered_total_goods_count: description: 商品数据会根据活动商品列表进行过滤,该字段代表未过滤的商品列表大小 example: 100 type: integer user_id: description: 消费者支付宝ID example: "2088111" type: string type: object UserVoucherBaseInfo: properties: associate_trade_no: description: 若商家券操作过关联商户订单信息,则该字段返回商家券已关联的商户订单号。 type: string belong_merchant_id: description: 券归属商户 type: string create_time: description: 领券时间 type: string valid_begin_time: description: 券可使用的开始时间。 格式为:yyyy-MM-dd HH:mm:ss type: string valid_end_time: description: 券可使用的结束时间。 格式为yyyy-MM-dd HH:mm:ss type: string voucher_code: description: "用户领取的券码code,支付宝商家券活动才会返回券码,其他优惠券活动该值为空" type: string voucher_id: description: 用户券 id。支付宝为用户优惠券唯一分配的 id。 type: string voucher_max_use_times: description: 券最大核销次数 type: integer voucher_name: description: 对消费者展示的券(商品)名称。 type: string voucher_status: description: "券状态。SENDED:可用 USED:已核销(即完全使用), EXPIRED:已过期(只能查询6个月内数据)" type: string voucher_used_times: description: 券已核销次数 type: integer type: object UserVoucherInfo: properties: activity_base_info: $ref: '#/components/schemas/ActivityBaseInfo' activity_id: description: 活动id example: "2016042700826004508401111111" type: string available_begin_time: description: 券可用开始时间。 example: 2017-01-01 00:00:01 type: string available_end_time: description: 券可用结束时间。 example: 2017-01-01 00:00:01 type: string belong_merchant_id: description: 归属商户PID example: "2088202967380463" type: string create_time: description: 用户领券时间。 example: 2017-01-01 00:00:01 type: string 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: description: 用户券 id。支付宝为用户优惠券唯一分配的 id。 example: 2021072900073002214009F8QHR3 type: string voucher_name: description: 对消费者展示的券(商品)名称。 example: 满10减1 type: string voucher_send_mode_info: $ref: '#/components/schemas/VoucherSendModeInfo' voucher_status: description: 券状态。 example: SENDED type: string voucher_type: description: 券类型 example: FIX_VOUCHER type: string voucher_use_rule_info: $ref: '#/components/schemas/VoucherUseRuleInfo' voucher_use_rule_lite_info: $ref: '#/components/schemas/CommonVoucherUseRuleLiteInfo' type: object ViolationEvent: properties: can_appeal: description: 商家是否可以申诉 example: true type: boolean can_rectify: description: 商家是否可以整改 example: true type: boolean punish_action: 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\"]" type: string status: description: 违规工单状态枚举 example: PUNISH_DONE type: string target_id: description: 违规对象ID example: "2022000000000011" type: string target_name: description: 违规对象名称 example: xxx测试小程序 type: string target_type: description: "违规对象类型\t小程序ID:APPID \t生活号ID:PUBLICID" example: APPID type: string violation_record_id: description: 支付宝侧生成的违规记录唯一标识 example: "20220524001020000000000001" type: string violation_time: description: 违规时间,格式为 yyyy-MM-dd HH:mm:ss example: 2020-01-01 00:00:01 type: string violation_type: description: 即平台依据平台规范/规则,判定商户的违规类型 example: 数据和系统安全/敏感参数泄露风险 type: string type: object Voucher: properties: allow_split: description: 是否允许拆分,券在核销的时候是否允许券的面额拆分使用。(仅限渠道类型为ISV企业福利:ISV_ENTERPRISE_BENIFIT的场景使用) example: false type: boolean available_amount: description: "券剩余面额,单位元\r\t券详情查询接口返回,可拆分券中的券详情展示用" example: "100" type: string brand_name: description: 券副标题 example: 券副标题 type: string clause_terms: description: 券的说明条款 items: $ref: '#/components/schemas/ClauseTerm' type: array delay_info: $ref: '#/components/schemas/DelayInfo' desc: description: "券详细说明\r\t最多包含500个字符" example: 券的详细说明 type: string desc_detail_list: description: 券使用说明描述列表 items: $ref: '#/components/schemas/VoucherDescDetail' type: array display_config: $ref: '#/components/schemas/DisplayConfig' donate_flag: description: 券是否可转赠,默认为可转赠 example: "true" type: string effect_type: description: "券生效的方式,目前支持以下方式\r\t立即生效:IMMEDIATELY\r\t延迟生效:DELAY\r\t仅在券有效\ 期类型为相对有效期时生效" example: IMMEDIATELY type: string end_time: description: "券有效期的结束时间\r\t仅在券有效期类型为绝对有效期时生效\r\t必须晚于活动结束时间" example: 2016-11-01 00:00:00 type: string ext_info: description: 券的扩展信息 example: '"key":"value"' type: string item_info: $ref: '#/components/schemas/ItemInfo' logo: description: 券LOGO文件ID,调用图片上传接口alipay.offline.material.image.upload获得 example: 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC type: string max_amount: description: "最高优惠金额,单位元\r\t指用券最高可以优惠的金额\r\t必须为合法金额类型字符串仅当券类型为折扣券(RATE),\ 每满减券(PER_FULL_CUT)有效" example: "100" type: string multi_use_mode: description: "券叠加的属性,\r\t仅全场券可设置该选项;\r\tNO_MULTI:不可与其他全场券和单品券叠加;\r\tMULTI_USE_WITH_SINGLE:\r\ \t该全场优惠和单品优惠的叠加\r\t;MULTI_USE_WITH_OTHE\r\tRS:该全场优惠和其他所有优惠都可以叠加" example: NO_MULTI type: string name: description: 名称 example: 券的名称 type: string rate: description: "折扣率\r\t仅当券类型为折扣券时有效\r\t有效折扣率取值范围0.11-0.99\r\t仅允许保留小数点后两位" example: "0.8" type: string relative_time: description: "券相对有效期,单位天\r\t仅在券有效期类型为相对有效期时生效\r\t如,设5表示领券领取后5日内有效" example: "1" type: string rounding_rule: description: "券核销时,抹零方式,目前支持:\tNOT_AUTO_ROUNDING:不自动抹零\tAUTO_ROUNDING_YUAN:自\ 动抹零到元\tAUTO_ROUNDING_JIAO:自动抹零到角\tROUNDING_UP_YUAN:四舍五入到元\tROUNDING_UP_JIAO:四\ 舍五入到角" example: NOT_AUTO_ROUNDING type: string start_time: description: "券有效期的开始时间\r\t仅在券有效期类型为绝对有效期时生效" example: 2016-05-01 00:00:00 type: string type: description: "券类型,目前支持以下类型:\r\tEXCHANGE:兑换券;\r\tMONEY:代金券;\r\tREDUCETO:减\ 至券;\r\tRATE:折扣券;\r\tPER_FULL_CUT:每满减券" example: MONEY type: string use_instructions: description: "券的使用说明\r\t使用须知最多6条,且每条最多100字" example: 券的使用说明 items: type: string type: array use_rule: $ref: '#/components/schemas/UseRule' validate_type: description: "券有效期类型,目前支持以下类型:\r\tRELATIVE:相对有效期\r\tFIXED:绝对有效期" example: FIXED type: string verify_mode: description: "该字段仅在兑换券条件下(即券类型为EXCHANGE),用于设置兑换券的核销方式\r\tUSER_CLICK:用户自己\ 点击券上的按钮核销\r\tMERCHANT_SCAN:商户通过APP扫码核销\r\t其他情况下此字段为空" example: MERCHANT_SCAN type: string voucher_img: description: "券图片文件ID,调用上传图片接口alipay.offline.material.image.upload获得" example: 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC type: string voucher_note: description: "券的备注\r\t\r\t用于收银系统识别指定券使用;如备注中传入“123”,券发出后核销时将在当面付接口将该值传回,\ 供收银系统识别" example: 券的备注 type: string worth_value: description: "券面额,单位元必须为合法金额类型字符串券类型为代金券(MONEY)、减至券(REDUCETO)、每满减券(PER_FULL_CUT)\ 时必填\r\t如:\r\t代金券:10元代金券中的10为券面额;\r\t每满减券:毎满100减10元,其中的10为券面额;\r\t减至券:单\ 品原价100,现价10元,其中10为券面额,单品减至券的券面额必须低于单品原价" example: "10" type: string type: object VoucherAbsolutePeriodInfo: properties: time_restrict_info: $ref: '#/components/schemas/TimeRestrictInfo' valid_begin_time: description: 券可使用的开始时间。 格式为:yyyy-MM-dd HH:mm:ss。 type: string valid_end_time: description: 券可使用的结束时间。 格式为yyyy-MM-dd HH:mm:ss。 type: string type: object VoucherAvailableAccountInfo: properties: available_pids: description: 优惠券可核销的直连商户PID items: type: string type: array available_smids: description: 优惠券可核销的间连商户SMID items: type: string type: array type: object VoucherAvailableAppInfo: properties: available_app_ids: description: 可核销的支付宝小程序id items: type: string type: array type: object VoucherAvailableGeographyAllShopInfo: properties: available_brand_id: description: "全部门店可用的品牌ID\t提示:\t1.目前只支持传入当前券归属商户的品牌ID\t2.品牌ID可以在登录b.alipay.com-账\ 户中心-品牌管理里查看。如果没有品牌,可以先创建品牌。Sop:\t注意事项\t1.只支持传入单个品牌ID\t2.传入品牌ID后,券的商户品牌\ 和logo仍以voucher_display_pattern_info传入为准。" type: string exclude_shop_ids: description: 券不可使用的门店列表。指定商户全部门店可用时可通过该字段排除部分不可用门店。 列表中的门店id是通过调用接口ant.merchant.expand.shop.create创建门店返回的支付宝门店id 接口参数是列表类型。 items: type: string type: array merchant_ids: description: 全部门店可用的商户ID items: type: string type: array type: object VoucherAvailableGeographyAllShopResultInfo: properties: fail_exclude_shop_infos: description: 请求失败的不可用门店详情。 items: $ref: '#/components/schemas/VoucherFailShopInfo' type: array success_exclude_shop_ids: description: 请求成功的不可用门店列表。 items: type: string type: array type: object VoucherAvailableGeographyCityInfo: properties: all_city: description: 是否全国。 选择全国后,无须填写city_codes字段。系统默认填充全国全部城市信息。 type: boolean available_city_codes: description: 城市编码。请按照表格中内容填写。(参考资料) items: type: string type: array type: object VoucherAvailableGeographyScopeInfo: properties: available_geography_city_info: $ref: '#/components/schemas/VoucherAvailableGeographyCityInfo' available_geography_scope_type: description: 券可用地理位置类型。 type: string available_geography_shop_info: $ref: '#/components/schemas/VoucherAvailableGeographyShopInfo' type: object VoucherAvailableGeographyScopeResultInfo: properties: available_geography_shop_result_info: $ref: '#/components/schemas/VoucherAvailableGeographyShopResultInfo' type: object VoucherAvailableGeographyShopInfo: properties: available_geography_all_shop: $ref: '#/components/schemas/VoucherAvailableGeographyAllShopInfo' available_real_shop_ids: description: 代运营商业关系门店列表,列表中的门店id是调用接口alipay.business.relation.shop.create创建门店返回的real_shop_id 接口参数是列表类型。 items: type: string type: array available_shop_ids: description: 券可使用的门店列表。列表中的门店id是通过调用接口ant.merchant.expand.shop.create创建门店返回的支付宝门店id 接口参数是列表类型。 items: type: string type: array type: object VoucherAvailableGeographyShopResultInfo: properties: available_geography_all_shop_result_info: $ref: '#/components/schemas/VoucherAvailableGeographyAllShopResultInfo' fail_available_real_shop_infos: description: 失败的物理门店详情。 items: $ref: '#/components/schemas/VoucherFailShopInfo' type: array fail_available_shop_infos: description: 失败的可用门店。 items: $ref: '#/components/schemas/VoucherFailShopInfo' type: array success_available_real_shop_ids: description: 代运营商业关系门店列表,列表中的门店id是调用接口alipay.business.relation.shop.create创建门店返回的real_shop_id 接口参数是列表类型。 items: type: string type: array success_available_shop_ids: description: 券可使用的门店列表。列表中的门店id是通过调用接口ant.merchant.expand.shop.create创建门店返回的支付宝门店id 接口参数是列表类型。 items: type: string type: array type: object VoucherAvailableGoodsInfo: properties: available_goods_sku_ids: description: 可优惠商品编码,商家自定义商品编码。当用户支付时,交易中的商品编码和支付券配置的商品编码有任一匹配时,可以使用优惠券。 items: type: string type: array exclude_goods_sku_ids: description: 不可核销商品编码,商家自定义商品编码。当用户支付时,交易中的商品编码和支付券配置的商品编码有任一匹配时,不可以使用优惠券。 items: type: string type: array goods_description: description: 商品描述信息。 用于券面展示,向用户介绍商品 type: string goods_detail: description: 商品详情,会展示在特定渠道(如服务市场团购业务插件的套餐明细)。 type: string goods_detail_images: description: 商品详情图片列表,会展示在特定渠道(如服务市场团购业务插件的头图) items: type: string type: array goods_detail_rich_description: description: 商品详情富文本描述 type: string goods_name: description: 商品名称。 type: string origin_amount: description: 原价。说明:该字段可不填,填入商品名称goods_name则必填; type: string type: object VoucherAvailableItemInfo: properties: item_id: description: 内部商品ID type: string out_item_info: description: 外部商品信息 items: $ref: '#/components/schemas/VoucherAvailableOutItemInfo' type: array type: object VoucherAvailableOutItemInfo: properties: item_app_id: description: 小程序ID type: string out_item_id: description: 外部商品ID type: string type: object VoucherAvailableScope: properties: order_voucher_available_city_code: $ref: '#/components/schemas/OrderVoucherAvailableCityCode' order_voucher_available_shop: $ref: '#/components/schemas/OrderVoucherAvailableShop' voucher_available_type: description: 可用范围类型。 type: string type: object VoucherAvailableScopeInfo: 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' voucher_available_item_info: $ref: '#/components/schemas/VoucherAvailableItemInfo' type: object VoucherAvailableScopeModify: properties: modify_type: description: 可用范围修改类型。 example: ADD type: string order_voucher_available_city_code: $ref: '#/components/schemas/OrderVoucherAvailableCityCodeModify' order_voucher_available_shop: $ref: '#/components/schemas/OrderVoucherAvailableShopModify' type: object VoucherAvailableScopeResultInfo: properties: voucher_available_geography_scope_result_info: $ref: '#/components/schemas/VoucherAvailableGeographyScopeResultInfo' type: object VoucherBalanceRechargeInfo: properties: amount: description: "支付宝余额充值金额\t 限制: \t 1.币种为人民币,单位元。 \t 2. 总预算=优惠金额*总发券张数" type: string logon_id: description: 出资的商户支付宝登录账号 type: string partner_id: description: 出资的商户支付宝ID type: string type: object VoucherBudgetSupplyInfo: properties: budget_type: description: "营销资金预算类型 \t1、免充值:制券方无需提前充值资金,用户核销支付券时,直接从订单原价中扣除优惠减价金额,最终只\ 将用户实际支付的金额结算给核销商户,商户实收少于订单原价。 \t2.预充值: 制券方需将优惠预算提前充值到支付宝指定营销账户中,用户核销\ 支付券时,系统从该账户可用余额中扣除优惠减价部分对应的资金,连同用户实际支付的资金,一并结算给核销商户,不影响实收。" type: string voucher_recharge_info: $ref: '#/components/schemas/VoucherRechargeInfo' type: object VoucherConsultInfo: properties: ceiling_amount: description: 封顶优惠金额,单位为元 example: "4.0" type: string item_promo_info: $ref: '#/components/schemas/ItemPromoInfo' optimal: description: 是否为可使用的互斥券中最优的(目前返回的记录该值均为true,即可忽略该值判断) example: true type: boolean promo_amount: description: 优惠总金额,单位为元 example: "30.00" type: string promo_text: description: 优惠文案 example: 大杯拿铁限时享受满10减1 type: string promo_type: description: "优惠类型: 代金(FIX),折扣(DISCOUNT),减至(SPECIAL,即特价券)" example: FIX type: string reduction_amount: description: 满减金额,单位为元,仅针对代金券 example: "2.0" type: string reduction_ratio: description: 优惠额度,如3折券,返回0.7,仅针对折扣券 example: "0.7" type: string specified_amount: description: 减至金额,单位为元,仅针对减至券 example: "32.0" type: string threshold_amount: description: 优惠门槛,单位为元(部分券没有门槛金额) example: "120.00" type: string voucher_id: description: 券id example: 202010220007300232330005DGEE type: string voucher_name: description: 券名称 example: 商家全场5折优惠 type: string voucher_type: description: 券类型: 1)全场券(ALL) 2)单品券(ITEM) example: ALL type: string type: object VoucherCustomerGuideInfo: properties: voucher_send_guide_info: $ref: '#/components/schemas/VoucherSendGuideInfo' voucher_use_guide_info: $ref: '#/components/schemas/VoucherUseGuideInfo' type: object VoucherDeductInfo: 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: description: 券类型。 type: string type: object VoucherDeductThresholdInfo: properties: customer_define_voucher_threshold_desc: description: 自定义门槛描述 type: string voucher_express_info: $ref: '#/components/schemas/VoucherExpressInfo' voucher_goods_quantity_specification_info: $ref: '#/components/schemas/VoucherGoodsQuantitySpecificationInfo' type: object VoucherDescDetail: properties: details: description: 具体描述信息列表 example: 周一到周五可用 items: type: string type: array images: description: 图片描述信息 example: https://dl.django.t.taobao.com/rest/1.0/image?fileIds=RY7twkJVR26nz8OeXRIjvAAAACMAAQED&zoom=original items: type: string type: array title: description: 券说明的标题 example: 温馨提示 type: string url: description: 券外部详情描述 example: www.alipay.com type: string type: object VoucherDetail: properties: amount: description: 优惠券面额,它应该会等于商家出资加上其他出资方出资 type: string id: description: 券id type: string memo: description: 优惠券备注信息 type: string merchant_contribute: description: 商家出资(特指发起交易的商家出资金额) type: string name: description: 券名称 type: string other_contribute: description: 其他出资方出资金额,可能是支付宝,可能是品牌商,或者其他方,也可能是他们的一起出资 type: string other_contribute_detail: description: 优惠券的其他出资方明细 items: $ref: '#/components/schemas/ContributeDetail' type: array purchase_ant_contribute: description: 如果使用的这张券是用户购买的,则该字段代表用户在购买这张券时平台优惠的金额 type: string purchase_buyer_contribute: description: 如果使用的这张券是用户购买的,则该字段代表用户在购买这张券时用户实际付款的金额 type: string purchase_merchant_contribute: description: 如果使用的这张券是用户购买的,则该字段代表用户在购买这张券时商户优惠的金额 type: string template_id: description: 券模板id type: string type: description: 券类型 type: string type: object VoucherDisplayInfo: properties: brand_logo: description: "商家logo。需要通过\talipay.marketing.material.image.upload接口上传图片,\ 指定file_key为PROMO_BRAND_LOGO,返回的resource_id即为该参数的值" type: string brand_name: description: 商户品牌名称。如果不设置品牌名称,则默认使用支付宝商家系统中维护的商家别名。如果没有维护商家别名,则使用默认名称:商家优惠。用户领取优惠券后,品牌名称会对用户进行展示 type: string customer_service_mobile: description: 客服电话 type: string customer_service_url: description: 客服链接 type: string voucher_comment: description: "券补充说明,该字段为可运营字段,可描述商品特色\t会展示在用户支付宝卡包券详情页" type: string voucher_description: description: 券详细使用说明。 type: string voucher_detail_images: 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 type: array voucher_image: description: "券详情页封面图,会展示在用户支付宝卡包券详情页。需要通过\talipay.marketing.material.image.upload接\ 口上传图片,指定file_key为PROMO_VOUCHER_IMAGE,接口返回的resource_id即为该参数的值" type: string type: object VoucherDisplayInfoModify: properties: brand_logo: description: "商家logo \t需要通过 alipay.marketing.material.image.upload接口上传图\ 片,指定file_key为PROMO_BRAND_LOGO,返回的resource_id即为该参数的值" example: adeDSktiQO-u5vJUqVbcQwAAACMAAQED type: string brand_name: description: 商户品牌名称。 example: 商家优惠 type: string customer_service_mobile: description: 客服电话 example: 81XXXXXXX type: string customer_service_url: description: 客服链接 example: alipay://xxxx type: string voucher_comment: description: 券补充说明,该字段为可运营字段,可描述商品特色 会展示在用户支付宝卡包券详情页。 example: 食材新鲜,品质之选 type: string voucher_description: description: 券详细使用说明。 example: 1、本券不可兑换现金,不可找零。2、每个用户最多可以领取1张。3、如果订单发生退款,优惠券无法退还。 type: string voucher_detail_images: description: "券详细图列表,会展示在用户支付宝卡包券详情页 需要通过 alipay.marketing.material.image.upload接\ 口上传图片,指定file_key为PROMO_VOUCHER_DETAIL_IMAGE ,接口返回的resource_id即为该参数的值\ \ 上传图片尺寸600*600,支持格式:png、jpg、jpeg、bmp,大小不超过2MB。" example: "[\"adeDSktiQO-u5vJUqVbcQwAAACMAAQE1\",\"adeDSktiQO-u5vJUqVbcQwAAACMAAQE2\"\ ,\"adeDSktiQO-u5vJUqVbcQwAAACMAAQE3\"]" items: type: string type: array voucher_image: description: 券详情页封面图,会展示在用户支付宝卡包券详情页 需要通过 alipay.marketing.material.image.upload接口上传图片,指定file_key为PROMO_VOUCHER_IMAGE,接口返回的resource_id即为该参数的值。 example: adeDSktiQO-u5vJUqVbcQwAAACMAAQED type: string type: object VoucherDisplayPatternInfo: properties: brand_logo: description: 商家logo 需要通过 alipay.marketing.material.image.upload接口上传图片,指定file_key为PROMO_BRAND_LOGO,返回的resource_id即为该参数的值。 type: string brand_logo_url: description: 商家品牌logo链接 type: string brand_name: description: 商户品牌名称。 type: string customer_service_mobile: description: 客服电话。 type: string customer_service_url: description: 客服链接。 type: string voucher_description: description: 券详细使用说明。 type: string voucher_detail_image_urls: description: 券详情链接 items: type: string type: array voucher_detail_images: description: "券详细图列表,会展示在用户支付宝卡包券详情页 需要通过 alipay.marketing.material.image.upload接\ 口上传图片,指定file_key为PROMO_VOUCHER_DETAIL_IMAGE ,接口返回的resource_id即为该参数的值\ \ 上传图片尺寸600*600,支持格式:png、jpg、jpeg、bmp,大小不超过2MB。" items: type: string type: array voucher_image: description: "券详情页封面图,会展示在用户支付宝卡包券详情页。\t需要通过 alipay.marketing.material.image.upload接\ 口上传图片,指定file_key为PROMO_VOUCHER_IMAGE,接口返回的resource_id即为该参数的值。" type: string voucher_image_url: description: 券封面链接 type: string voucher_name: description: 券名称。 type: string type: object VoucherExchangeGoodsInfo: properties: exchange_goods_name: description: 兑换商品名称 type: string type: object VoucherExpressInfo: properties: pay_express: description: 邮费标识,属于券的服务,用于用户门槛信息展示 type: string type: object VoucherFailShopInfo: properties: fail_message: description: 请求失败提示信息。 type: string fail_reasons: description: 请求失败的原因。 items: type: string type: array real_shop_id: description: 请求失败的物理门店 id。 type: string shop_id: description: 支付宝侧蚂蚁店铺 id。 type: string type: object VoucherFileInfo: properties: file_download_url: description: 发票文件下载 type: string file_name: description: 文件名 type: string file_type: description: 文件类型 type: string type: object VoucherGoodsQuantitySpecificationInfo: properties: directional_type: description: 定向类型用于规格设置,比如:FIX 表示 固定满X件,APPOINT 表示指定第N件 type: string specification_quantity: description: 数量 type: integer specification_unit: description: 单位 type: string type: object VoucherInventoryInfo: properties: send_count: description: 已发放数量。 type: integer use_count: description: 已核销数量。 type: integer type: object VoucherMiniAppSendGuideInfo: properties: mini_app_url: description: 小程序发券链接 type: string type: object VoucherMiniAppUseGuideInfo: properties: mini_app_service_codes: description: 小程序服务编码。取值来源:通过alipay.open.app.service.apply(小程序服务创建)接口创建服务后获取。 items: type: string type: array mini_app_url: description: 小程序核销链接 type: string type: object VoucherPackageActivityInfo: 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' type: object VoucherPackageBaseInfo: properties: purchase_end_time: description: 券包购买结束时间 type: string purchase_start_time: description: 券包购买开始时间 type: string voucher_package_id: description: 券包id type: string voucher_package_name: description: 券包名称 type: string voucher_package_status: description: 券包状态 type: string voucher_total_amount: description: 券包总价值(单位是元): 券包下券的优惠总额(满减券指优惠面额,折扣券指优惠上限,特价券指原价减去特价) type: string type: object VoucherPackageConsultResult: properties: consult_result_code: description: "券包购买咨询结果code:\tSUCCESS:可以领取;\tPRODUCT_NOT_ENABLE:产品不可用;\t\ NOT_IN_SELL_TIME:不在销售时间内;\tPRODUCT_SOLD_OUT:产品售罄;\tUSER_PURCHASE_LIMIT:\ 用户购买上限;\tOTHER:不可购买,未知原因" example: SUCCESS type: string voucher_package_id: description: 券包id example: IP20220628016671405804297103167741 type: string type: object VoucherPackageInfo: properties: voucher_package_base_info: $ref: '#/components/schemas/VoucherPackageBaseInfo' voucher_package_sales_lite_info: $ref: '#/components/schemas/VoucherPackageSalesLiteInfo' type: object VoucherPackageModeInfo: properties: voucher_package_id: description: 券包id,对应alipay.marketing.activity.voucherpackage.query中voucher_package_id。 type: string type: object VoucherPackageSalesInfo: properties: budget: description: 券包售卖预算,单位是份数 example: 1000 type: integer pay_channel: description: "券包购买支付渠道\tpcredit:花呗\tcreditCard:信用卡\tcredit_group:花呗与信用卡\t\ 为空则不限渠道" example: pcredit type: string purchase_url: description: 券包购买链接 example: http://123.htm type: string sale_count_limit_in_period: description: 券包售卖期限内最大购买次数 example: 5 type: integer sale_period_limit: description: "券包购买期限类型\tNO:不限制 \tALL:售卖时间内 \tDAY:天 \tWEEK:周 \tMONTH:月" example: "NO" type: string sale_price: description: 券包售卖价格,单位是元 example: "1.99" type: string type: object VoucherPackageSalesLiteInfo: properties: budget: description: 券包预算,单位是份数 example: 1000 type: integer sale_price: description: 券包售卖价格,单位是元 example: "3.99" type: string type: object VoucherPackageUseRule: properties: use_rule_desc: description: 券包使用规则 example: 当前券包的券必须在线下扫码点餐场景使用 type: string type: object VoucherRechargeInfo: properties: recharge_type: description: 预充值方式。 type: string voucher_balance_recharge_info: $ref: '#/components/schemas/VoucherBalanceRechargeInfo' type: object VoucherRefundDetailInfo: properties: voucher_refund_use_times: description: 本次取消核销次数 example: 1 type: integer type: object VoucherRelativePeriodInfo: properties: time_restrict_info: $ref: '#/components/schemas/TimeRestrictInfo' valid_days_after_receive: description: 券生效后 N 天内可以使用。 可以配合wait_days_after_receive 字段使用。 type: integer wait_days_after_receive: description: "用户领券后需要等待 N 天,券才可以生效。 \t字段值为 0 表示用户领券后立刻生效。" type: integer type: object VoucherSaleModeInfo: properties: fund_custody_mode: description: 资金托管方式 type: string overdue_refundable: description: 是否支持优惠券过期后,自动退款给用户。 不填默认否,枚举值: true:是 false:否。自动退款功能需要服务商在优惠券过期时,主动调用alipay.marketing.activity.order.refund接口进行退款。 如果配置优惠券时选择了过期自动退款,但是实际券过期后,服务商没有进行退款,那么用户投诉后,需要服务商进行解决。 type: boolean overdue_refundable_need_confirm: description: "在支持过期自动退款后,支付宝发起自动退款前 是否需要向商户确认退款。 不填默认否,枚举值: true:是 false:\ 否。\t\t如果选择了 true:是 ,则需要商户配合接入 过期自动退款前是否需要向商户确认SPI(spi.alipay.marketing.activity.order.refundconfirm)\ \ 以及 退款确认结果API(alipay.marketing.activity.order.refundconfirmcommit)" type: boolean payee_pid: description: 收款账号。 目前的结算规则是,每核销一笔优惠券,支付宝会打款到该收款账户。 type: string refundable: description: 购买的优惠券是否允许退款。 不填默认否,枚举值: true:是 false:否 type: boolean refundable_need_confirm: description: 在支持随时退后,支付宝发起退款前用于判断是否需要向商户确认退款。 不填默认否,枚举值: true:是 false:否。 如果选择了 true:是 ,则需要商户配合接入退款前是否需要向商户确认SPI(spi.alipay.marketing.activity.order.refundconfirm) type: boolean sale_amount: description: 用户购买优惠券需要支付的金额 type: string settle_info: $ref: '#/components/schemas/BizfundSettleInfo' type: object VoucherSendGuide: properties: voucher_detail_url: description: 领(购)券详情页链接,从支付宝公域跳转到服务商(商户)自定义领(购)券详情页。 type: string type: object VoucherSendGuideInfo: properties: mini_app_send_guide_info: $ref: '#/components/schemas/VoucherMiniAppSendGuideInfo' send_guide_mode: description: 发放引导模式 items: type: string type: array type: object VoucherSendGuideModify: properties: voucher_detail_url: description: 领(购)券详情页链接,从支付宝公域跳转到服务商(商户)自定义领(购)券详情页。说明:当 voucher_type=EXCHANGE_VOUCHER 时,该字段可修改,其他不允许修改。 example: alipays://platformapi/startapp?appId=xxxx type: string type: object VoucherSendModeInfo: properties: voucher_package_mode_info: $ref: '#/components/schemas/VoucherPackageModeInfo' voucher_sale_mode_info: $ref: '#/components/schemas/VoucherSaleModeInfo' voucher_send_mode: description: 券发放模式。 type: string voucher_send_rule_info: $ref: '#/components/schemas/VoucherSendRuleInfo' type: object VoucherSendRuleDetail: properties: natural_person_limit: description: 是否开启自然人领取限制。自然人表示按照身份证纬度进行领取限制。 type: boolean phone_number_limit: description: 是否开启电话号码领取限制。 type: boolean voucher_quantity: description: 发行券的数量。 type: integer voucher_quantity_limit_per_user: description: "每人领取限制。默认按照支付宝uid进行领取限制;\t不填写或填入0,默认没有领取限制。" type: integer type: object VoucherSendRuleDetailModify: properties: natural_person_limit: description: 是否开启自然人领取限制。 自然人表示按照身份证纬度进行领取限制。 example: false type: boolean phone_number_limit: description: 是否开启电话号码领取限制。 example: "true" type: string voucher_quantity_limit_per_user: description: 每人领取限制。 默认按照支付宝uid进行领取限制; example: 1 type: integer type: object VoucherSendRuleInfo: properties: max_quantity_by_day: description: 设置此字段,允许指定单天最大发券数量。 type: integer natural_person_limit: description: 是否开启自然人领取限制。 自然人表示按照身份证纬度进行领取限制。 type: boolean phone_number_limit: description: 是否开启电话号码领取限制。 type: boolean phone_number_need_input_limit: description: 下单时是否需要用户填写手机号码 type: boolean publish_end_time: description: 券发放结束时间。 格式为:yyyy-MM-dd HH:mm:ss type: string publish_start_time: description: 券发放开始时间。 格式为:yyyy-MM-dd HH:mm:ss type: string quantity: description: 发行券的数量。 type: integer quantity_limit_per_user: description: 每人领取限制。 默认按照支付宝账号进行领取限制; 不填写或填入0表示没有领取限制. type: integer quantity_limit_per_user_period_type: description: "周期限领配置,限制每人在固定周期内领取张数(voucher_quantity_limit_per_user),默认\ LIFE_CYCLE" type: string real_name_limit: description: "限制支付宝实名用户才能领取支付券,默认为false表示不限制 枚举值 true\\false" type: boolean type: object VoucherSummary: properties: publish_count: description: 券已发放数量。 type: integer used_count: description: 券已核销数量。 type: integer type: object VoucherUseDetailInfo: properties: voucher_use_times: description: 本次核销次数(不包含撤销核销的次数) example: 1 type: integer type: object VoucherUseDetailResultInfo: properties: voucher_max_un_use_times: description: 剩余可核销次数 type: integer type: object VoucherUseGuide: properties: mini_app_id: description: 券可用的小程序appId,卡包详情页可跳转到该appId type: string mini_app_path: description: 指定跳转到mini_app_id时的具体页面路径。 type: string mini_app_use_guide: description: 小程序核销。 type: boolean offline_code_use_guide: description: 线下扫码核销。 type: boolean service_codes: description: 小程序服务编码,通过 alipay.open.app.appcontent.function.create(小程序服务创建)接口创建服务后获取。 items: type: string type: array type: object VoucherUseGuideInfo: properties: mini_app_use_guide_info: $ref: '#/components/schemas/VoucherMiniAppUseGuideInfo' use_guide_mode: description: 使用引导模式 items: type: string type: array type: object VoucherUseGuideModify: properties: mini_app_id: description: 券可用的小程序 appId,卡包详情页可跳转到该 appId。 example: "2021238412323412" type: string mini_app_path: description: 指定跳转到 mini_app_id 时的具体页面路径。 example: /index/path/path&query=xx%3dxx type: string service_codes: description: 小程序服务编码,通过 alipay.open.app.appcontent.function.create(小程序服务创建)接口创建服务后获取。 example: "[\"2020030921000303380758\"]" items: type: string type: array type: object VoucherUseRule: 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' type: object VoucherUseRuleInfo: properties: quantity_limit_per_user: description: 核销次数限制。 type: integer quantity_limit_per_user_period_type: description: "周期限领配置,限制每人在固定周期内领取张数(voucher_quantity_limit_per_user),默认\ LIFE_CYCLE" type: string voucher_max_use_times: description: 券最大核销次数。 type: integer voucher_use_ext_info: description: 自定义扩展信息 type: string voucher_use_time_info: $ref: '#/components/schemas/VoucherUseTimeInfo' type: object VoucherUseRuleModify: properties: exchange_voucher: $ref: '#/components/schemas/ExchangeVoucherModify' voucher_available_scope: $ref: '#/components/schemas/VoucherAvailableScopeModify' voucher_valid_period: $ref: '#/components/schemas/VoucherValidPeriodModify' type: object VoucherUseTimeInfo: properties: absolute_period_info: $ref: '#/components/schemas/VoucherAbsolutePeriodInfo' period_type: description: 券有效期。 type: string relative_period_info: $ref: '#/components/schemas/VoucherRelativePeriodInfo' type: object VoucherUseTimeRuleInfo: properties: date_rule_info: $ref: '#/components/schemas/DateRuleInfo' holiday_rule_info: $ref: '#/components/schemas/HolidayRuleInfo' rule_type: description: 规则类型 type: string week_rule_info: $ref: '#/components/schemas/WeekRuleInfo' type: object VoucherValidPeriod: properties: type: description: 券有效期类型 type: string valid_begin_time: description: 券可使用的开始时间。格式为:yyyy-MM-dd HH:mm:ss type: string valid_days_after_receive: description: 券生效后N天内可以使用。可以配合wait_days_after_receive字段使用。 type: integer valid_end_time: description: 券可使用的结束时间。格式为yyyy-MM-dd HH:mm:ss type: string wait_days_after_receive: description: 用户领券后需要等待N天,券才可以生效。如果该字段填入0或者不填写,则用户领券后立刻生效。 type: integer type: object VoucherValidPeriodModify: properties: valid_begin_time: description: 券可使用的开始时间。格式为:yyyy-MM-dd HH:mm:ss。 example: 2017-01-10 00:00:00 type: string valid_days_after_receive: description: 券生效后 N 天内可以使用。 example: 3 type: integer valid_end_time: description: 券可使用的结束时间。格式为yyyy-MM-dd HH:mm:ss。 example: 2017-01-13 23:59:59 type: string wait_days_after_receive: description: 用户领券后需要等待 N 天,券才可以生效。 example: 2 type: integer type: object WaitRepaymentOrderInfo: properties: advance_order_id: description: 垫资单id example: "20190128002630010000170001187808" type: string alipay_user_id: description: 买家的支付宝用户id example: "2088302483540171" type: string biz_product: description: 通常为商户签约的收单产品码 example: GENERAL_WITHHOLDING type: string open_id: description: 买家的支付宝用户id example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string orig_biz_order_id: description: 原始的业务单号,通常为支付宝交易号 example: "2018060821001001820554093702" type: string wait_repayment_amount: description: 垫资金额 type: integer type: object WaybillInvoice: properties: waybill_amount: description: 即时配送运单金额 example: "100" type: string waybill_no: description: 即时配送运单编号 example: waybill_no_00001 type: string type: object WaybillInvoiceIstd: properties: reason: description: 失败原因,需要传单个配送单的驳回原因 example: 开票失败原因 type: string shop_no: description: 商家门店编号 example: shop_no_00001 type: string waybill_amount: description: 即时配送运单金额,waybill_invoce_status为1的情况下不能为空 example: "100" type: string waybill_invoice_status: description: 明细的运单开票状态,1:开票成功 2:不可开票 3:可开票;整体开票状态为0的情况下,无开票明细;整体开票状态为1,明细开票状态全部是1;整体开票状态为2,明细开票状态为2或者3 example: 0 type: integer waybill_no: description: 即时配送运单编号 example: waybillNo_20200811 type: string type: object WaybillInvoiceQueryIstd: properties: reason: description: 失败原因,需要传单个即时配送运单的驳回原因 example: 开票金额错误 type: string shop_no: description: 商家门店编号 example: shop_no_20200818 type: string waybill_amount: description: 即时配送运单金额,waybill_invoce_status为1的情况下不能为空 example: "200" type: string waybill_invoice_status: description: 明细的运单开票状态,1:开票成功 2:不可开票 3:可开票;整体开票状态为0的情况下,无开票明细;整体开票状态为1,明细开票状态全部是1;整体开票状态为2,明细开票状态全部为2 example: 0 type: integer waybill_no: description: 即时配送运单编号 example: waybill_no_20200811 type: string type: object WeekRuleInfo: properties: time_range_info: $ref: '#/components/schemas/TimeRangeInfo' week_day: description: "星期数,以“,”连接多个星期数" type: string type: object WidgetActivityInfo: properties: activity_click_url: description: 活动点击跳转到小程序的链接地址 example: alipays://platformapi/startapp?appId= 2017072607907880&page=pages/index/index?param=xxxx type: string activity_id: description: 活动的唯一标识,同一个小程序橱窗下,该标识唯一,请开发者自行保证 example: "8948968498" type: string activity_name: description: 活动名称 example: 这是一个活动名称 type: string activity_picture_urls: description: "活动图片链接,最多不能超过5个" example: "[\"https://xxx.xxx.com/xxx.jpg\"]" items: type: string type: array type: object WidgetGoodsInfo: properties: buying_url: description: 该商品的小程序购买链接,如果需要进行公域推广,请字段请必填 type: string goods_brand: description: 商品品牌,如果需要进行公域推广,该字段请必填 type: string goods_comment: description: 商品辅助说明文案 type: string goods_description_label: description: 商品说明标签(如-随心退) type: string goods_id: description: 商品的唯一标识,同一个小部件下,该标识唯一,请开发者自行保证 type: string goods_label: description: 营销标签(如-限量特价),每个商品仅支持一个营销标签 type: string goods_name: description: 商品名称 type: string goods_type: description: 商品所属品类 type: string main_pic_url: description: 商品主图片地址,如果需要进行公域推广,该字段请必填。 type: string need_public_promo: description: 是否需要进行公域推广,默认情况下为false type: boolean order_number: description: "商品排序,自然整数, 数字越小越靠前" type: integer original_price: description: 单位"元"的商品原价,传入数字,不需要传入"元"。如果需要进行公域推广,该字段请必填。 type: string publish_cities: description: "投放城市的列表,详见https://www.mca.gov.cn/article/sj/xzqh/2020/2020/202007170301.html,\ 有多个用英文,分隔。如果没有限制则不传入" type: string remaining_quantity: description: 剩余库存,如果需要进行公域推广,该字段请必填,并且当剩余库存为0时,请及时同步。 type: integer sell_price: description: 单位"元"的售价,传入数字,不需要传入"元"。如果需要进行公域推广,该字段请必填。 type: string sell_tag_list: description: 商品的卖点标签,如果需要进行公域推广,请至少填写两个卖点标签。 items: type: string type: array sold_quantity: description: 已售数量 type: integer status: description: "商品状态,商品的上下架,默认情况为上架,上架为ONLINE,下架为OFFLINE" type: string total_quantity: description: 总库存量 type: integer type: object ZMGOBasicConfig: properties: biz_type: description: 商户在芝麻GO配置的业务身份编码 type: string contact: description: 商家客服电话 type: string isv_pid: description: 运营商商户支付宝ID。若非ISV代理模式,也就是商户自运营模式,此属性取值与partner_id一致。 type: string merchant_custom_logo: description: 商户LOGO type: string out_biz_no: description: 外部业务单号,供幂等使用,需保证每次请求的值都不同 type: string partner_id: description: 商户的支付宝ID,即为此商户创建芝麻GO模板 type: string template_name: description: 芝麻GO模板名称 type: string template_no: description: 模板编号 type: string type: object ZMGOCycleFlexConfig: properties: cycle_flex_withhold_fee_name: description: 周期灵活扣的费用名称 type: string cycle_flex_withhold_max_price: description: 周期灵活扣单期扣款的最大额度 type: string cycle_flex_withhold_total_period_count: description: 周期灵活扣的总期数 type: integer type: object ZMGOCycleWithholdConfig: properties: deduct_plan: description: 扣款计划 items: type: string type: array exemption_period: description: 豁免期天数 type: string period: description: 周期 type: string period_type: description: 扣款周期类型,支持DAY-天模式,MONTH-月模式 type: string support_cycle_withhold_high_mode: description: 是否支持周期扣高级模式,高级模式下扣款计划中内一起的扣款金额可以进行定制 type: boolean support_exemption_period: description: 是否支持豁免期,如果支持豁免期,用户开通后再豁免期内退出无需扣款 type: boolean withhold_mode: description: 设置扣款模式,目前支持每月固定日期或固定时间间隔 type: string type: object ZMGOExtConfig: properties: text_content_fill_rule_id: description: 文本内容填充规则ID type: string text_content_fill_variable: description: 文本内容填充变量,变量key由运营同学提供 type: string type: object ZMGOObligationConfig: properties: benefit_url: description: 芝麻GO管理页做任务按钮对应链接 type: string obligation_amount: description: 完成任务所需的最少额度,当obligation_template取值为:OBTL002时必传 type: string obligation_template: description: "承诺模式下,义务的类型,包含次数类型和金额类型:\t OBTL001(\"OBTL001\", \"在x时间内\ 完成n次\"),\t OBTL002(\"OBTL002\", \"在x时间内达到n元金额\")" type: string obligation_times: description: 完成任务所需的最少次数,当obligation_template取值为:OBTL001时必填 type: string promise_type_desc: description: 任务描述 type: string task_progress_redirect_schema: description: 芝麻GO管理页任务进度重定向链接 type: string type: object ZMGOOpenConfig: properties: apply_button_desc: description: 开通页按钮文案描述;传入内容后开通页点击开通按钮展示文案会使用该字段传入内容 type: string appoint_date: description: 固定到期时间或每月的第几日。 (1)当period_mode为APPOINT_DATE时,取值固定日期,如"2022-06-01 00:00:00",表示协议在6月1号0点到期; (2)当period_mode为FIX_DATE,取值"3",表示协议在period_time个月后的3号到期。 type: string card_color_scheme: 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\", \"紫色\");" type: string custom_open_tip_list: description: 未完成任务规则详情 type: string custom_open_tips: description: 规则详情 type: string freeze_amount: description: 担保金额额度,单位:元 type: string min_sign_interval: description: 用户签约间隔时间,单位天 type: string period_mode: 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\", \"指定日期\")," type: string period_time: description: "周期时长\t当period_mode为RELATIVE_DATE、ABSOLATE_DATE、ABSOLUTE_PLUS_1_DATE、\ FIX_DATE时必填" type: string show_sign_success_page: description: 是否展示签约完成页 type: boolean sign_again_schema: description: 用户签约商户活动到期 type: string sign_success_task_button_desc: description: 签约完成页任务按钮描述,当展示签约完成页=true的时候 改内容必填 type: string support_expire_deferral: deprecated: true description: 是否支持延期特权,开启后用户可以在任务到期前进行延期。(该功能已停用,不建议开启使用。) type: boolean type: object ZMGOQuitConfig: properties: quit_desc: description: 退出提示 type: string quit_jump_url: description: 退出跳转商家页地址,当quit_type取值为:QUIT_MERCHANT_JUMP,必传 type: string quit_type: description: "退出芝麻GO方式,取值:\t (1)QUIT_COMMON(\"QUIT_COMMON\", \"标准退出\"),\t\ (2)QUIT_MERCHANT_JUMP(\"QUIT_MERCHANT_JUMP\", \"商家页退出\"),\t(3)QUIT_ONLY_TIPS(\"\ QUIT_ONLY_TIPS\", \"仅退出提示\")" type: string type: object ZMGORightConfig: properties: cumulative_preferential_redirect_schema: description: 芝麻GO管理页已享优惠进度的重定向链接 type: string custom_benefit_desc: description: 权益描述 type: string custom_sub_benefit_desc: description: 权益描述子标题 type: string type: object ZMGOSettlementConfig: properties: custom_fee_name: description: 会员费扣费名称 type: string cycle_flex_withhold_config: $ref: '#/components/schemas/ZMGOCycleFlexConfig' cycle_withhold_config: $ref: '#/components/schemas/ZMGOCycleWithholdConfig' exp_stop_delay_days: description: 预计结算延迟天数,当exp_stop_time_mode取值RELATIVE_DATE、ABSOLATE_DATE、ABSOLUTE_PLUS_1_DATE时,必传 type: integer exp_stop_time: description: 预期结算时间,当exp_stop_time_mode取值APPOINT_DATE时,必传 type: string exp_stop_time_mode: 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\"\ , \"指定日期\")" type: string fulfilltimes_custom_settlement_plan: description: 按履约次数灵活扣款计划。当settlement_type取值为fulfillTimesCustomSettlement时,此属性必传 type: string settlement_type: description: "结算类型,取值:\t BENEFIT_SETTLEMENT(\"benefitSettlement\", \"\ 按权益金额结算\"),\t FULFILL_TIMES_CUSTOM_SETTLEMENT(\"fulfillTimesCustomSettlement\"\ ,\"按履约次数扣款\")" type: string type: object ZMGoOutDiscountInfo: properties: discount_amount: description: 商户回传的优惠金额,如用户享受的红包金额,单位元 example: "8.75" type: string discount_name: description: 商户数据回传的优惠信息的名称 example: 滴滴打车优惠001 type: string discount_type: description: "优惠信息的类型。为枚举值,商户可任意选择一个值作为入参传入。可取值:\t(\"exclusiveBenefit\"\ ,\"专享优惠\"),\t(\"exclusiveDiscount\",\"专享折扣\"),\t(\"appreciationBenefit\"\ , \"增值权益\"),\t(\"memberPoint\", \"会员积分\")" example: exclusiveBenefit type: string type: object ZMGoTradeInfo: properties: amount: description: 用户和商户发生交易的交易单金额,单位元 example: "3.57" type: string trade_no: description: 用户和商户发生交易的交易单号,仅在商户需要回传交易信息时传入。 example: "2020081722001435461000061785" type: string type: object ZhimaCreditPayafteruseCreditagreementQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - BIZ_ERROR - EXTRA_PARAM_FORMAT_ERROR - INVALID_PARAMETER - CREDIT_AUTH_NOT_EXIST - ILLEGAL_QUERY - CREDIT_AGREEMENT_NOT_EXIST - DEPEND_FAILURE type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaCreditPayafteruseCreditagreementQueryResponseModel: properties: agreement_status: description: "开通/授权状态,VALID: 有效,INVALID: 无效" example: VALID type: string alipay_user_id: description: 蚂蚁统一会员ID example: "2088091111111111" type: string biz_time: description: 开通时间,agreement_status为VALID有效。 example: 2020-09-15 11:23:04 type: string credit_agreement_id: description: 芝麻开通/授权协议号 example: ZMOP99202011240100520025162811 type: string ext_info: description: 该字段只在特殊业务场景下,根据业务方约定返回;一般业务场景下不需要消费该字段 example: "{\"key\":\"value\"}" type: string open_id: description: 开放ID example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string out_agreement_no: description: 商户外部协议号 example: "2014070700166653" type: string type: object ZhimaCreditPayafteruseCreditagreementTransferErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaCreditPayafteruseCreditagreementTransferModel: properties: category_id: description: 芝麻外部类目 example: credit_pay_test type: string deduct_agreement_no: description: 用户的代扣协议号 example: "20215401139331610689" type: string extend_params: description: 业务扩展参数,Json格式 example: "{\"key\":\"value\"}" type: string out_agreement_no: description: 商户外部协议号,不同的支付宝用户需要传递不同的外部单号 example: "2014070700166653" type: string product_code: description: 商户签约的芝麻产品的产品码 example: CREDIT_RISK_ASSESSMENT type: string zm_service_id: description: 芝麻信用服务ID example: "2020050722001440031000061082" type: string type: object ZhimaCreditPayafteruseCreditagreementTransferResponseModel: properties: credit_agreement_id: description: 芝麻开通协议号 example: ZMOP99202011240100520025162811 type: string out_agreement_no: description: 商户外部协议号 example: "2014070700166653" type: string type: object ZhimaCreditPayafteruseCreditbizorderFinishErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - BIZ_ERROR - ORDER_NOT_EXIST - INVALID_PARAMETER - ORDER_STATUS_INVALID - MERCHANT_NO_PERMISSION_OPERATE_ORDER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaCreditPayafteruseCreditbizorderFinishModel: properties: credit_biz_order_id: description: 信用服务订单号 example: ZMCB20201021200102012 type: string is_fulfilled: description: "字符串类型,用户此订单是否守约。\t传\"true\"时,用户在芝麻信用-守约记录中,该笔订单是已守约状态;\t传\"\ false\"时,用户在芝麻信用-守约记录中,该笔订单是已取消状态。" example: '"true"' type: string out_request_no: description: 商户外部请求号 example: "2014070700166653" type: string remark: description: 商户对本次操作的附言描述 example: 完结订单 type: string type: object ZhimaCreditPayafteruseCreditbizorderFinishResponseModel: properties: credit_biz_order_id: description: 信用服务订单号 example: ZMCB20201021200102012 type: string order_status: description: "信用服务订单状态.INIT: 下单状态; TRADE_CLOSED: 订单取消或者交易全额退款; TRADE_FINISHED:\ 扣款成功状态" example: INIT type: string out_request_no: description: 商户外部请求号 example: "4977164666634053" type: string type: object ZhimaCreditPayafteruseCreditbizorderOrderErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaCreditPayafteruseCreditbizorderOrderModel: properties: amount_type: description: 只有当传递了order_amount时,该参数才有意义; 1)该参数不传时,默认为ORDER_AMOUNT。 2)传ORDER_AMOUNT时,表示order_amount传入的金额为后付金额,在发起扣款时,最大扣款支付金额为order_amount传入的值; 3)传RISK_AMOUNT时,表示ORDER_AMOUNT传入的金额为风险预估金额,在发起扣款时,最大扣款支付金额为商户签约时约定的上限额度。 example: RISK_AMOUNT type: string body: description: 订单描述 example: Iphone6 16G type: string category_id: description: 芝麻外部类目,芝麻先享接入无差异化风控诉求可不传 example: credit_pay_after_use type: string credit_agreement_id: description: 芝麻开通协议号 example: ZMOP99202011240100520025162811 type: string extend_params: description: 业务扩展参数 example: "{\"key\":\"value\"}" type: string order_amount: description: 订单金额,该金额为当前订单扣款的累计最大额度。例如,下单时传递10.00,则扣款时最大支付金额为10元。若该参数不传,则默认使用商户签约时约定的上限额度。芝麻速办业务场景(极速回收、极速返利、极速退款等)商户请求时,order_amount必传,且amount_type类型需传递ORDER_AMOUNT。 example: "88.66" type: string out_order_no: description: 商户外部订单号,保证不重复 example: out00120312323232 type: string product_code: description: 产品码,不传默认为CREDIT_PAY_AFTER_USE example: CREDIT_PAY_AFTER_USE type: string subject: description: "订单标题。\t注意:不可使用特殊字符,如 /,=,& 等。" example: Iphone6 16G type: string type: object ZhimaCreditPayafteruseCreditbizorderOrderResponseModel: properties: credit_biz_order_id: description: 信用服务订单号 example: ZMCB99202103310000450000041833 type: string out_order_no: description: 商户传入的外部订单号 example: out1210212021212 type: string type: object ZhimaCreditPayafteruseCreditbizorderQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - BIZ_ERROR - INVALID_PARAMETER - ILLEGAL_QUERY - DEPEND_FAILURE type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaCreditPayafteruseCreditbizorderQueryResponseModel: properties: create_time: description: 订单创建时间 example: 2020-09-15 11:23:04 type: string credit_agreement_id: description: 芝麻开通协议号 example: ZMOP2014070700166653 type: string credit_biz_order_id: description: 信用服务订单号 example: ZMCB20201021200102012 type: string order_status: description: "信用服务订单状态。INIT: 下单状态;TRADE_CLOSED: 订单取消或者交易全额退款; TRADE_FINISHED:\ 扣款成功状态" example: INIT type: string product_code: description: 产品码 example: w1040100001000010020 type: string total_amount: description: 信用服务订单金额 example: "88.88" type: string trade_no: description: 支付宝交易号 example: "2021030422001428451400037476" type: string zm_service_id: description: 芝麻信用服务ID example: "2020050722001440031000061082" type: string type: object ZhimaCreditPeZmgoAgreementQueryErrorResponseModel: properties: code: description: 错误码 enum: - ZMGO_BIZ_AGR_NULL - AGREEMENT_NOT_EXIST type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaCreditPeZmgoAgreementQueryResponseModel: properties: agreement_id: description: 支付宝系统中用以唯一标识用户签约记录的编号,即花芝轻会员协议号。 example: "20185513447859192007" type: string agreement_name: description: 协议名称 example: 花呗先享会员 type: string agreement_status: description: 协议状态。Y表示状态有效,P表示状态失效中,N表示状态已失效 example: "Y" type: string alipay_user_id: description: 支付宝用户userId example: "2088302424419340" type: string biz_type: description: 代表签约芝麻GO所属业务类型 example: zm_zmgo type: string open_id: description: 支付宝用户userId example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string sign_time: description: 该条芝麻GO协议签约时间 example: 2021-09-27 00:00:00 type: string start_time: description: 该芝麻GO协议开始时间 example: 2021-09-27 00:00:00 type: string type: object ZhimaCreditPeZmgoAgreementUnsignErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaCreditPeZmgoAgreementUnsignModel: properties: agreement_id: description: 支付宝系统中用以唯一标识用户签约记录的编号。 example: ZMGO_AGR2020122710020604120000000001 type: string alipay_user_id: description: 支付宝的用户id example: "2088302841345600" type: string open_id: description: 支付宝的用户id example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string partner_id: description: 商户ID example: "2088302424614288" type: string quit_type: description: quit_type为USER_CANCEL_QUIT或者SETTLE_APPLY_QUIT example: SETTLE_APPLY_QUIT type: string type: object ZhimaCreditPeZmgoAgreementUnsignResponseModel: properties: agreement_id: description: 支付宝系统中用以唯一标识用户签约记录的编号。 example: ZMGO_AGR2020122710020604120000000001 type: string withhold_plan_no: description: 调用芝麻GO结算受理接口时,需要传入该值 example: ZMGO_WHD2021022210020603120000301613 type: string type: object ZhimaCreditPeZmgoBizoptCloseErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaCreditPeZmgoBizoptCloseModel: properties: alipay_user_id: description: 支付宝用户Id example: "2088302841345600" type: string open_id: description: 支付宝用户Id example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string out_request_no: description: 商户本次操作的请求流水号,由商户生成,请确保唯一性 example: "99202005050100930053707258" type: string partner_id: description: 商户Id example: "2088302424614288" type: string template_id: description: 芝麻GO配置模板Id example: "2021012300020903090008858258" type: string type: object ZhimaCreditPeZmgoBizoptCloseResponseModel: properties: biz_opt_no: description: 芝麻GO签约申请时生成的签约申请单据号 example: ZMGO_OPT2021020110020607850000006001 type: string open_id: description: 蚂蚁统一会员ID example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string out_request_no: description: 商户本次操作的请求流水号 example: 9e8cc8da16866a79161ee033cb58497b type: string partner_id: description: 商户ID example: "2088302424614288" type: string user_id: description: 蚂蚁统一会员ID example: "2088302841345600" type: string type: object ZhimaCreditPeZmgoCumulationSyncErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaCreditPeZmgoCumulationSyncModel: properties: agreement_no: description: 芝麻go协议号,唯一标识一个芝麻go协议。为必传入参。 example: "20195108518085620000" type: string amount_type_data: $ref: '#/components/schemas/AmountTypeData' biz_action: description: "数据回传的动作类型,为枚举值,为必传入参。\t可取值:\t(\"ORDER_PAID\", \"正向支付\"),(\"\ ORDER_REFUND\", \"逆向退款\")。\t其中ORDER_PAID表示回传为正向的,即订单金额累加,优惠累加,任务次数累加;而\ ORDER_REFUND表示回传为逆向的,即订单金额退款,优惠退款,任务次数回退。" example: ORDER_PAID type: string biz_time: 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 type: string cumulate_data_type: description: "累计类型。为枚举值,为必传入参。\t可取值:(\"AMOUNT\", \"金额类型\"),(\"TASK\", \"\ 任务类型\"),(\"AMOUNT_TASK\", \"额度和任务类型\")。\t其中,交易解耦模式仅允许AMOUNT或TASK。而交易绑定\ 模式下,仅允许AMOUNT_TASK。" example: AMOUNT type: string ext_info: description: 扩展字段,格式为Json格式的字符串,非必传。 example: "{\"number\":\"20200303938282939\"}" type: string has_alipay_trade: description: "是否为支付宝交易。仅在累计模式为【交易绑定模式】下被消费。当芝麻Go模板配置的累计模式为交易绑定模式时,此时需传入扩\ 展参数是否为支付宝交易。若是支付宝交易,传值true,否则为false。若不传此字段,默认为false。\t若为true,则会对交易号trade_no进\ 行校验,校验是否为支付宝交易,以及用户userId和商户partnerId是否一致,若校验不通过,累计失败。" example: false type: boolean open_id: description: 用户userId,蚂蚁统一会员ID,为必传入参。 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string out_biz_no: description: "外部业务号。需保证唯一,为必传入参。\t若接口调用失败,提示信息为更换幂等号,商户更换此字段重新发起调用。" example: "2020081211223006150094012926289" type: string partner_id: description: 商户ID,为必传入参。 example: "2088621805983504" type: string pay_out_biz_no: description: "逆向对应的正向外部业务号。逆向场景为必传入参。也就是biz_action为ORDER_REFUND时为必传入参。\t\ 逆向时需通过此字段明确对应的正向的外部业务号。" example: "2020081211223006150094012926289" type: string request_from: description: 取固定值ExternalMerchantSource,为必传入参。表示数据回传来源为外部商户,数据回传内部逻辑需感知。 example: ExternalMerchantSource type: string task_type_data: $ref: '#/components/schemas/TaskTypeData' user_id: description: 用户userId,蚂蚁统一会员ID,为必传入参。 example: "2088602002015001" type: string type: object ZhimaCreditPeZmgoCumulationSyncResponseModel: properties: agreement_no: description: "芝麻go协议号,唯一标识一个芝麻go协议。\t累计成功后返回此字段。" example: "20195108518085620000" type: string fail_reason: description: "数据回传失败原因描述。\t累计失败后返回此字段。" example: 入参userId为空 type: string open_id: description: "用户userId,蚂蚁统一会员ID。\t累计成功后返回此字段。" example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string out_biz_no: description: "外部业务号。需保证唯一,若接口调用失败,提示信息为更换幂等号,商户更换此字段重新发起调用。\t累计成功后返回此字段。" example: "2020081211223006150094012926289" type: string user_id: description: "用户userId,蚂蚁统一会员ID。\t累计成功后返回此字段。" example: "2088602002015001" type: string type: object ZhimaCreditPeZmgoPreorderCreateErrorResponseModel: properties: code: 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 - ACQUIRE_USER_LOCK_FAIL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaCreditPeZmgoPreorderCreateModel: properties: alipay_open_id: description: 支付宝用户ID。同一个外部请求号,调用方要确保支付宝userId取值不变 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string alipay_user_id: description: 支付宝用户ID。同一个外部请求号,调用方要确保支付宝userId取值不变 example: "2088759402857364" type: string biz_time: description: "业务发生时间,如2016-07-06 00:00:02\t签约超时关单时间依赖这个时间\t这个时间会做幂等校验,如果\ 创单幂等,但时间不同会失败" example: 2016-07-06 00:00:02 type: string custom_temp_conf: description: 废弃字段,勿用 example: SHOW_AGREEMENT_LIST=true type: string expire_aisle_data: description: 协议到期后通知 example: 业务方到期标识 type: string ext_template_conf: $ref: '#/components/schemas/ExtTemplateConf' extend_params: $ref: '#/components/schemas/PreOrderExtInfo' freeze_amount: description: 冻结金额,单位:元 example: "1.00" type: string isv_pid: description: ISV商户ID example: "2088374762857463" type: string out_request_no: description: 外部请求号,唯一 example: ORDER_12345678 type: string partner_id: description: 商户ID example: "2088437463829741" type: string partner_user_identifier: description: 商户侧用户唯一标识。ex.商户侧uid example: user102934889234 type: string pay_aisle_data: description: 结算成功后通知 example: 业务方结算标识 type: string sign_aisle_data: description: 签约成功后通知 example: 业务方签约标识 type: string template_id: description: 签约芝麻GO的模板ID example: "2020122200020903760008552025" type: string timeout_express: description: "超时关单时间\t默认1H。1m~15d。m表示分钟,h表示小时,d表示天。该参数数值不接受小数点, 如1.5h,可转\ 换为90m\t签约超时关单时间依赖这个时间" example: 15m type: string type: object ZhimaCreditPeZmgoPreorderCreateResponseModel: properties: biz_type: description: 业务类型 example: hongbaoqiandao type: string partner_id: description: 商户ID example: "2088990000000000" type: string preorder_no: description: 芝麻GO预创建单号 example: ZMGO_ASO2019071000020903940000062019 type: string type: object ZhimaCreditPeZmgoSettleApplyErrorResponseModel: properties: code: 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 - FUNDS_CHANNEL_CHECK_FAILED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaCreditPeZmgoSettleApplyModel: properties: action_type: description: "DEFAULT_SETTLE 默认结算模式;\tPAY_TO_ZERO 支付转0元;" example: DEFAULT_SETTLE或PAY_TO_ZERO type: string agreement_id: description: 支付宝系统中用以唯一标识用户签约记录的编号。 example: ZMGO_AGR2020122710020604120000000001 type: string alipay_open_id: description: 买家在支付宝的用户id example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string alipay_user_id: description: 买家在支付宝的用户id example: "2088101117955611" type: string out_request_no: description: 商户本次操作的请求流水号,用于标示请求流水的唯一性,不能包含除中文、英文、数字以外的字符,需要保证在商户端不重复。 example: "8077735255938032" type: string partner_id: description: 商户ID example: "2088102146225135" type: string pay_amount: description: 需要支付的金额,单位为:元(人民币),精确到小数点后两位 example: "2.00" type: string settle_extend_params: $ref: '#/components/schemas/SettleExtraParams' total_discount_amount: description: 芝麻GO任务开始到到期过程中和任务相关享受的总优惠金额,单位为:元(人民币),精确到小数点后两位。 example: "3.00" type: string total_real_pay_amount: description: 芝麻GO任务开始到到期过程中和任务相关支付的总金额,单位为:元(人民币),精确到小数点后两位。 example: "3.00" type: string total_task_count: description: 芝麻GO任务开始到到期过程中和任务相关完成的任务次数 example: "0" type: string withhold_plan_no: description: 芝麻GO结算时,需要传入的扣款单据号。来源于协议到期通知消息,外部商户接入时,该参数必填 example: ZMGO_WHD2021010510020603410000006001 type: string type: object ZhimaCreditPeZmgoSettleApplyResponseModel: properties: agreement_id: description: 支付宝系统中用以唯一标识用户签约记录的编号。 example: ZMGO_AGR2020122710020604120000000001 type: string fail_reason: description: 根据商户传入的轻会员协议结算周期内累计消费数据与支付宝端轻会员协议结算周期内消费数据比对之后,若数据不一致,则会返回对应的异常数据比对结果。 example: "累计支付宝支付金额不一致,支付宝:100.00元,商户:150.00元" type: string out_request_no: description: 商户本次操作的请求流水号,用于标示请求流水的唯一性,不能包含除中文、英文、数字以外的字符,需要保证在商户端不重复。 example: "8077735255938032" type: string settle_status: description: "Y(\"Y\", \"支付成功\"),\tP(\"P\", \"支付中\"),\tN(\"N\", \"支付失败\"\ )," example: P type: string withhold_plan_no: description: 芝麻GO结算时,需要传入的扣款单据号。来源于协议到期通知消息 example: ZMGO_WHD2021010510020603410000006001 type: string type: object ZhimaCreditPeZmgoSettleRefundErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaCreditPeZmgoSettleRefundModel: properties: agreement_id: description: 签约芝麻GO的业务协议号,在签约成功、结算成功等通知中回回传给商户。 example: ZMGO_AGR2021010510020604080000006001 type: string alipay_open_id: description: 支付宝用户ID example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string alipay_user_id: description: 支付宝用户ID example: "2088302841345600" type: string memo: description: 本次退款说明 example: 退款 type: string out_request_no: description: 外部请求号 example: "99202005050100930053707258" type: string partner_id: description: 商户ID example: "2088302424614288" type: string refund_amount: description: 退款金额,单位为:元(人民币),精确到小数点后两位 example: "3.00" type: string refund_type: description: "退款类型:\tMEMBER_FEE_REFUND 会员费结算退款 ,WITHHOLD_FEE_REFUND 周期扣款\ 金额退款。\t不填写默认为 MEMBER_FEE_REFUND" example: MEMBER_FEE_REFUND type: string withhold_plan_no: description: 芝麻侧扣款计划单据号,在结算扣款成功的通知消息中会回传。 example: ZMGO_WHD2021010510020603410000006001 type: string type: object ZhimaCreditPeZmgoSettleRefundResponseModel: properties: fail_reason: description: 退款操作错误原因描述 example: 退款金额超限 type: string out_request_no: description: 外部请求号 example: "99202005050100930053707258" type: string refund_amount: description: 本次请求退款金额,单位为:元(人民币),精确到小数点后两位 example: "3.00" type: string refund_opt_no: description: 芝麻GO退款生成的内部唯一流水,外部商户可以拿这个参数进行对账 example: ZMGO_OPT202107271002060716000012522x type: string retry: description: 此字段含义,商家接入时需咨询对接技术。 example: true type: boolean withhold_plan_no: description: 本次退款的扣款计划单号 example: ZMGO_WHD2021010510020603410000006001 type: string type: object ZhimaCreditPeZmgoSettleUnfreezeErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaCreditPeZmgoSettleUnfreezeModel: properties: agreement_id: description: 支付宝系统中用以唯一标识用户签约记录的编号,即花呗先享协议号 example: "20185513447859192007" type: string alipay_open_id: description: 买家在支付宝的用户id example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string alipay_user_id: description: 买家在支付宝的用户id example: "2088101117955611" type: string biz_time: description: 解冻成功时间 example: 2014-09-15 11:23:04 type: string order_title: description: 解冻的描述 example: "2088411663864410" type: string out_request_no: description: 商户本次操作的请求流水号,用于标识请求流水的唯一性,不能包含除中文、英文、数字以外的字符,需要保证在商户端不重复。由商户传入,最终返回给商户。 example: "8077735255938032" type: string partner_id: description: 商户ID example: "2088411663864410" type: string unfreeze_amount: description: 解冻金额 example: "3.00" type: string unfreeze_extend_params: $ref: '#/components/schemas/UnfreezeExtendParams' type: object ZhimaCreditPeZmgoSettleUnfreezeResponseModel: properties: fail_reaseon: description: 失败原因 example: 余额户可用资金不足 type: string retry: description: 是否可以重试 example: true|false type: string unfreeze_amount: description: 解冻金额字符串 example: "1.00" type: string unfreeze_status: description: 解冻状态 example: Y/N type: string type: object ZhimaCustomerJobworthAuthenticationQueryErrorResponseModel: properties: code: description: 错误码 enum: - USER_NOT_AUTHORIZE - TOKEN_INVALID - NOT_OPEN_ZM - USER_NOT_OPEN_JOBWORTH - INVALID_PARAMETER - JOB_WORTH_BLACK_LIST - SYSTEM_ERROR - MERCHANT_INTERCEPT - RISK_INTERCEPT - OPEN_ZM_ACCOUNT_INTERCEPT - CARD_NO_NOT_MATCH - MOBILE_NO_NOT_MATCH - USER_NAME_NOT_MATCH - WRONG_OUT_AGREEMENT_NO_INTERCEPT - TOKEN_NOT_MATCH_IDENTITY_TYPE - PARAM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaCustomerJobworthAuthenticationQueryResponseModel: properties: identity_result: description: SUCCESS代表可信,FAILED代表不可信,WAITING_VERIFY代表未知需要等待结果 example: SUCCESS/FAILED/WAITING_VERIFY type: string identity_result_skip_url: description: 身份认证查询结果页面的小程序链接,有芝麻提供,用户在端内可直接访问 example: alipays://platformapi/startapp?appId type: string open_id: description: 蚂蚁统一会员ID example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string token_status: description: 代表订单状态 example: FINISH type: string user_id: description: 蚂蚁统一会员ID example: "2088402562742105" type: string type: object ZhimaCustomerJobworthCloudresumeQueryErrorResponseModel: properties: code: description: 错误码 enum: - USER_NOT_AUTHORIZE - QUERY_DATA_IS_NULL - SYSTEM_ERROR - INVALID_PARAMETER - ZM.SYSTEM_ERROR - USER_NOT_OPEN_ZHIMA - APP_INVOKE_DEGRADE type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaCustomerJobworthCloudresumeQueryResponseModel: properties: birthday: description: 出生日期 example: "20001001" type: string certificates: description: 证书名称 items: $ref: '#/components/schemas/CloudResumeCertificateInfo' type: array education_experiences: description: 教育经历 items: $ref: '#/components/schemas/CloudResumeEducationExperience' type: array email: description: 用户在芝麻工作证填写的邮箱 example: 123@126.com type: string gender: description: 性别 example: 男 type: string intention_status: description: 用户的求职状态 example: ALWAYS_ON_JOB type: string person_desc: description: 用户在芝麻工作证填写的自我介绍 example: 我是张三,性格开朗 type: string phone: description: 手机号码 example: "13311111111" type: string pic_url: $ref: '#/components/schemas/CloudResumeHeadPic' position_intentions: description: 求职期望 items: $ref: '#/components/schemas/CloudResumePositionIntention' type: array position_type: description: 职业身份 example: IN_SCHOOL type: string residential_area: description: 常驻地址 example: 浙江省杭州市 type: string skills: description: 技能信息 items: $ref: '#/components/schemas/CloudResumeSkillInfo' type: array user_name: description: 姓名 example: 张三 type: string work_experiences: description: 工作经历 items: $ref: '#/components/schemas/CloudResumeWorkExperience' type: array work_start_date: description: 工作开始日期(时间戳) example: 1669388400000 type: integer type: object ZhimaCustomerJobworthInfoQueryErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - BLACK_CONTROL - JOB_ID_NOT_MATCH - CONFIG_ERROR_WITHOUT_SERVICE_ID - USER_NOT_AUTHORIZE - ILLEGAL_ARGUMENT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaCustomerJobworthInfoQueryResponseModel: properties: acceptance_id: description: 受理台单号作为jsapi的一个参数。如果不使用jsapi可以忽略 example: ZMEV99202108230100080001977388 type: string auth_token: description: "用于授权校验,授权之前需要通过token校验" example: "124780137240912384128394" type: string html_url: description: h5url example: https://ssss type: string picture_url: description: "职得工作证图片url,可以直接用于展示" example: http://www.123.com type: string scene_result: description: 场景授权结果 example: true type: boolean sub_code: description: 业务编码 example: USER_NOT_OPEN_ZHIMA type: string sub_msg: description: 业务中文结果信息 example: 用户没有开通芝麻 type: string update_url: description: "工作证图片更新的url,需要跳转到工作证小程序中进行更新" example: http://www.123123.com type: string url: description: 职得工作证跳转小程序链接 example: http://www.123.com?XXX type: string type: object ZhimaCustomerJobworthJobdataAddErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - ILLEGAL_ARGUMENT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaCustomerJobworthJobdataAddModel: properties: cert_no: description: 身份证证件号 example: 1101121983010****5 type: string cert_type: description: 0:身份证1:护照2:台湾同胞回乡证3:港澳居民往来内地通行证4:台湾居民通行证5:港澳居民通行证 example: "0" type: string conn_key: description: 关联key,受理台返回 example: abcd12345678 type: string job_data_list: description: 回传信息 items: $ref: '#/components/schemas/JobWorthJobdata' type: array open_id: description: 支付宝uid example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string user_id: description: 支付宝uid example: "2088302586280165" type: string user_name: description: 用户中文名 example: 张三 type: string type: object ZhimaCustomerJobworthJobdataAddResponseModel: properties: acceptance_id: description: 受理台单号,用来调用工作证受理台 example: abcd1234 type: string sub_code: description: 错误码 example: INVALID_PARAMETER type: string sub_msg: description: 业务中文结果信息 example: 参数有误 type: string url: description: 职得工作证跳转小程序链接 example: http://www.123.com?XXX type: string type: object ZhimaCustomerJobworthPictureUploadErrorResponseModel: properties: code: description: 错误码 enum: - ILLEGAL_ARGUMENT - PICTURE_UPLOAD_LIMIT_ERROR - PICTURE_TYPE_ERROR - SYSTEM_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaCustomerJobworthPictureUploadModel: properties: content: description: 图片对应的base64字符串,支持jpg和png,1M之内 example: "-" type: string pic_type: description: 只能传入指定类型,具体类型看文档 example: JOB_DATA_UPLOAD type: string type: object ZhimaCustomerJobworthPictureUploadResponseModel: properties: pic_id: description: 图片返回ID example: abcd123456 type: string sub_code: description: 错误码 example: PICTURE_UPLOAD_LIMIT_ERROR type: string sub_msg: description: 错误原因 example: 图片上传限制 type: string type: object ZhimaCustomerJobworthPositionAddErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaCustomerJobworthPositionAddModel: properties: jobworth_position_info: $ref: '#/components/schemas/JobWorthPositionInfo' type: object ZhimaCustomerJobworthPositionAddResponseModel: properties: position_id: description: 岗位信息ID example: "123456789012345678901234" type: string sub_code: description: 业务错误 example: SALARY_ERROR type: string sub_msg: description: 业务错误信息 example: 薪水格式错误 type: string type: object ZhimaMerchantSubsidiariesApplyErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaMerchantSubsidiariesApplyModel: properties: pid: description: 商户pid example: "2088101117955612" type: string service_id: description: 信用服务id example: 20210413000000000000xxxxxxxx type: string smid: description: 二级商户进件id example: "2088101118048455" type: string sub_merchant_contact_number: description: 子商户联系电话 example: 200-000-0000 type: string sub_merchant_jump_link: description: 子商户跳转链接 example: https://xxxxxxxx type: string sub_merchant_logo_url: description: 子商户logo地址 example: https://xxxxxxxx type: string sub_merchant_name: description: 子商户名 example: XXX商户 type: string sub_pid: description: 子商户id example: "2088101117955611" type: string type: object ZhimaMerchantSubsidiariesApplyResponseModel: properties: biz_error_code: description: 业务错误码 example: "1001" type: string biz_error_message: description: 业务错误信息 example: 处理失败 type: string order_no: description: 工单标识 example: "100010" type: string type: object ZhimaMerchantSubsidiariesCloseErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - BIZ_FAIL - INVALID_PARAMETER - DATA_UPDATE_ERROR - PROCESS_CANCEL_ERROR - NO_AUTHORITY_HANDLE_DISSENT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaMerchantSubsidiariesCloseModel: properties: order_no: description: 工单标识 example: "100010" type: string type: object ZhimaMerchantSubsidiariesCloseResponseModel: properties: biz_error_code: description: 业务错误码 example: "1001" type: string biz_error_message: description: 业务错误信息 example: 处理失败 type: string order_memo: description: 工单审核备注 example: 审核通过 type: string order_no: description: 工单标识,业务成功时返回工单号 example: "100010" type: string order_status: description: 工单状态 example: AGREE type: string type: object ZhimaMerchantZmgoCumulateQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaMerchantZmgoCumulateQueryResponseModel: properties: aggr_amount: description: 总共累计金额 example: "99.99" type: string aggr_discount_amount: description: 总共累计优惠金额 example: "83.88" type: string aggr_times: description: 总共累计次数 example: 4 type: integer agreement_id: description: 芝麻go协议号,唯一标识一个芝麻go协议。 example: "20195108518085620000" type: string detail_list: description: 详情数据列表 items: $ref: '#/components/schemas/CumulateDataDetail' type: array fail_reason: description: 查询失败原因 example: 协议已经失效 type: string page_no: description: 分页参数,返回传入的值。 example: 1 type: integer page_size: description: 分页参数,返回传入的值。 example: 20 type: integer type: object ZhimaMerchantZmgoCumulateSyncErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - AGREEMENT_STATUS_INVALID - IDEMPOTENT_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaMerchantZmgoCumulateSyncModel: properties: agreement_id: description: 芝麻go协议号,唯一标识一个芝麻go协议。 example: "20195108518085620000" type: string amount_type_sync_data: $ref: '#/components/schemas/AmountTypeSyncData' biz_action: description: "数据回传的动作类型。枚举如下:\t* POSITIVE:正向回传,即订单金额累加,优惠累加,任务次数累加。\t* REVERSE:\ 逆向回传,即订单金额退款,优惠退款,任务次数回退。" example: POSITIVE type: string biz_time: 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 type: string data_type: description: "回传数据类型,枚举:\tTASK - 进度型,影响进度\tDISCOUNT - 优惠型" example: TASK type: string discount_type_sync_data: $ref: '#/components/schemas/DiscountTypeSyncData' open_id: description: 用户 id,用户在支付宝的唯一标识,以 2088 开头的 16 位纯数字组成。 example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string out_biz_no: description: 外部业务号,唯一标识一笔回传数据。 example: "2020081211223006150094012926289" type: string provider_pid: description: 数据回传的商户 ID,即和用户发生业务来往的 PID 主体。商户账号在支付宝的唯一标识,以 2088 开头的 16 位纯数字组成。 example: "2088621805983504" type: string refer_out_biz_no: description: 逆向对应的正向外部业务号。逆向场景为必传入参。也就是biz_action为REVERSE时为必传入参。 逆向时需通过此字段明确对应的正向的外部业务号。 example: "2020081211223006150094012926289" type: string sub_biz_action: description: "数据回传动作子类型,枚举值,为必传入参。\tADD - 新增数据\tUPDATE - 修改数据\t备注:UPDATE只\ 能更新金额信息。" example: ADD type: string times_type_sync_data: $ref: '#/components/schemas/TimesTypeSyncData' user_id: description: "用户 id,用户在支付宝的唯一标识,以 2088 开头的 16 位纯数字组成。\t" example: "2088602002015001" type: string type: object ZhimaMerchantZmgoCumulateSyncResponseModel: properties: agreement_id: description: 芝麻go协议号,唯一标识一个芝麻go协议。 example: "20195108518085620000" type: string fail_reason: description: 数据回传失败原因描述 example: 协议已经失效 type: string out_biz_no: description: 外部业务号,唯一标识一笔回传数据。 example: "2020081211223006150094012926289" type: string type: object ZhimaMerchantZmgoTemplateCreateErrorResponseModel: properties: code: 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 type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaMerchantZmgoTemplateCreateModel: 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' type: object ZhimaMerchantZmgoTemplateCreateResponseModel: properties: template_no: description: 芝麻GO模板号 example: ZMGO_TPL202206091002000195047 type: string type: object ZhimaMerchantZmgoTemplateQueryErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - REQUEST_ACCESS_ILLEGAL type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZhimaMerchantZmgoTemplateQueryResponseModel: 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' type: object ZhubUidTelPair: properties: open_id: description: 支付宝用户open_id example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string phone: description: 手机号 example: "13817337490" type: string user_id: description: 支付宝uid example: "2088302193568425" type: string type: object ZolozAuthenticationCustomerFacemanageCreateErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - EXTRACT_FAIL - UNABLE_GET_IMAGE - ILLEGAL_CERT - NOT_OPEN_SMILE - UID_NOT_FOUND type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZolozAuthenticationCustomerFacemanageCreateModel: properties: areacode: description: 地域编码 example: "010" type: string biz_type: description: 人脸产品能力,预热场景,需要传college,k12,scenic,subway,traffic。具体值视具体场景 example: "1" type: string bizscale: description: 业务量规模 example: 99999999活跃人数 type: string brandcode: description: 商户品牌 example: KFC type: string devicenum: description: "商户机具唯一编码,关键参数\t人脸预热,传logicGroupId" example: "123456" type: string extinfo: description: 拓展参数 example: "{}" type: string facetype: description: "入库类型 IDCARD:身份证 ALIPAY_USER:支付宝用户id, ALIPAY_TEL:手机号入库 CUSTOMER:自\ 定义 DIRECT_CLIENT_PRE:本地预写入 DIRECT_CLIENT:本地客户端库 ENCLOSED:封闭场景" example: DIRECT_CLIENT type: string faceval: description: 入库用户信息 人脸预热,alipayUid必填 example: "示例[{\"alipayUid\":\"2088402144983195\",\"customUserId\":\"01\"\ , \"faceContent\":\"base64String\"}]" type: string group: description: 分组5 example: group0 type: string storecode: description: 门店编码 example: HZ1000435 type: string validtimes: description: 有效期天数,如7天、30天、365天 example: "7" type: string type: object ZolozAuthenticationCustomerFacemanageCreateResponseModel: properties: result: description: 业务结果 example: "{}" type: string retcode: description: 返回码 example: OK_SUCCESS type: string retcodesub: description: 返回详细码 example: Z3161 type: string retmessage: description: 返回信息 example: 成功 type: string retmessagesub: description: 返回详细信息 example: 非法参数类型 type: string type: object ZolozAuthenticationCustomerFacemanageDeleteErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZolozAuthenticationCustomerFacemanageDeleteModel: properties: areacode: description: 地域编码 example: "010" type: string biz_type: description: 人脸产品能力 example: "1" type: string bizscale: description: 业务量 example: "9999999999" type: string brandcode: description: 商户品牌 example: KFC type: string devicenum: description: 商户机具唯一编码,关键参数 example: 商户机具唯一编码 type: string extinfo: description: 拓展参数 example: "{}" type: string facetype: description: "入库类型\tIDCARD:身份证\tALIPAY_USER:支付宝用户id,\tALIPAY_TEL:手机号入库\t\ CUSTOMER:自定义" example: "IDCARD,ALIPAY_USER, ALIPAY_TEL,CUSTOMER" type: string faceval: description: 入库用户信息 example: "类型为IDCARD数据格式:[{\"certName\": \"张三\",\"certNo\":\"3101101999xxxxxxxx\"\ ,\"certType\":\"IDCARD\"}]类型ALIPAY_USER数据格式:[{\"alipayUid\":\"20885022\"\ }]" type: string group: description: 分组 example: group0 type: string storecode: description: 门店编码 example: HZ1000435 type: string validtimes: description: 有效期天数,如7天、30天、365天 example: "7" type: string type: object ZolozAuthenticationCustomerFacemanageDeleteResponseModel: properties: result: description: 返回值 example: "{}" type: string retcode: description: 返回码 example: OK_SUCCESS type: string retcodesub: description: 返回详细码 example: Z3111 type: string retmessage: description: 返回信息 example: 成功 type: string retmessagesub: description: 返回详细信息 example: 出库成功 type: string type: object ZolozAuthenticationCustomerFtokenQueryErrorResponseModel: properties: code: description: 错误码 enum: - BIZ_ERROR - INVALID_PARAMETER - SYSTEM_ERROR - FTOKEN_INVALID - TOKEN_NOT_FOUND - UID_NOT_FOUND - TOKEN_EXPIRED - TOKEN_CONSUMED type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZolozAuthenticationCustomerFtokenQueryModel: properties: biz_type: description: "1、1:1人脸验证能力\r\t2、1:n人脸搜索能力(支付宝uid入库)\r\t3、1:n人脸搜索能力(支付宝手机号\ 入库)\r\t4、手机号和人脸识别综合能力" example: "1" type: string ext_info: $ref: '#/components/schemas/FaceExtInfo' ftoken: description: 人脸token example: fp0593e8d5c136277f13fd5bc36c13a7db7 type: string zim_id: description: 刷脸初始化流程中产生的zimId值 example: 3b35b4677de2c69bb5bab69a4a5168d62 type: string type: object ZolozAuthenticationCustomerFtokenQueryResponseModel: properties: age_check_result: description: 年龄是否在指定范围内,未指定范围则返回空,true/false example: "true" type: string authimg_base_64: description: 图片base64 encodeString example: 图片base64 encodeString type: string cert_name: description: 证件姓名 example: 张三 type: string cert_no: description: 身份证号码 example: 身份证号码 type: string face_id: description: 由ISV定义的对自然人唯一编码,举例可以是身份证号码和姓名的MD5值,或者是其他编码方式,要求脱敏、随机且在ISV可以唯一说明一个自然人 example: 6458f8361582010447730145389650 type: string open_id: description: 支付宝用户open_id example: 074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5 type: string uid: description: 支付宝uid example: "2088002842508713" type: string uid_tel_pair_list: description: 用户名信息返回的列表 items: $ref: '#/components/schemas/ZhubUidTelPair' type: array type: object ZolozAuthenticationCustomerSmilepayInitializeErrorResponseModel: properties: code: description: 错误码 enum: - SYSTEM_ERROR - INVALID_PARAMETER - BIZ_ERROR - MACHINE_SERVICE_SUSPEND - BIZ_ID_REPEAT type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZolozAuthenticationCustomerSmilepayInitializeModel: properties: service_id: description: 刷脸服务Id example: |- pay-刷脸支付 auth-刷脸核身 type: string service_params: description: 商户可传入刷脸服务所需的扩展参数,json格式 example: "{\"key1\": \"value1\"}" type: string zimmetainfo: description: "{ \"apdidToken\": \"设备指纹\", \"appName\": \"应用名称\", \"appVersion\"\ : \"应用版本\", \"bioMetaInfo\": \"生物信息如2.3.0:3,-4\" }" example: "{ \"apdidToken\": \"设备指纹\", \"appName\": \"应用名称\", \"appVersion\"\ : \"应用版本\", \"bioMetaInfo\": \"生物信息如2.3.0:3,-4\" }" type: string type: object ZolozAuthenticationCustomerSmilepayInitializeResponseModel: properties: result: description: 返回值 example: "{\"zimId\":\"54acb4edf8884e9c38c5c3614cc53ae3c\",\"type\":\"zimInit\"\ ,\"zimInitClientData\":\"唤起人脸客户端参数\"}" type: string type: object ZolozAuthenticationSmilepayInitializeErrorResponseModel: properties: code: description: 错误码 enum: - INVALID_PARAMETER - SYSTEM_ERROR - BIZ_ERROR type: string links: description: 解决方案链接 type: string message: description: 错误描述 type: string required: - code - message type: object ZolozAuthenticationSmilepayInitializeModel: properties: apdid_token: description: 设备指纹,用于唯一标识一台设备 example: 40Kl9e97cQcMJka5gfT0arVPq7GTaR6yE5f73mj8zqBW9eOPZQEAAA== type: string app_name: description: 人脸识别应用名称 example: com.alipay.zoloz.smile type: string app_version: description: 人脸识别应用版本号 example: 3.7.0.201809191618 type: string base_ver: description: 基础包版本号 example: 7.1.1 type: string bio_meta_info: description: 生物识别元信息 example: "3.13.0:12419136,6" type: string device_model: description: 设备型号 example: T2 type: string device_type: description: 设备类型 example: android type: string ext_info: $ref: '#/components/schemas/FaceExtParams' machine_info: $ref: '#/components/schemas/FaceMachineInfo' merchant_info: $ref: '#/components/schemas/FaceMerchantInfo' os_version: description: 操作系统版本号 example: 7.1.1 type: string remote_log_id: description: 业务ID example: bcf71c4290f288f4421ee9d49eedbf1e2840ba type: string zim_ver: description: ZIM版本号 example: 1.0.0 type: string type: object ZolozAuthenticationSmilepayInitializeResponseModel: properties: ret_code_sub: description: 返回详细码 example: Z3161 type: string ret_message_sub: description: 返回详细信息 example: 操作成功 type: string zim_id: description: ZIM上下文ID example: e0bdf675bc8b6f442eb03b2109d59c92d type: string zim_init_client_data: description: 客户端协议 example: 客户端渲染数据,JSON或PB格式 type: string type: object alios_open_auto_info_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AliosOpenAutoInfoQueryErrorResponseModel' alipay_boss_fnc_invoice_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayBossFncInvoiceApplyErrorResponseModel' alipay_boss_fnc_invoice_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayBossFncInvoiceBatchqueryErrorResponseModel' alipay_boss_fnc_invoice_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayBossFncInvoiceQueryErrorResponseModel' alipay_boss_fnc_invoicereceipt_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayBossFncInvoicereceiptBatchqueryErrorResponseModel' alipay_boss_fnc_invoicereceipt_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayBossFncInvoicereceiptCreateErrorResponseModel' alipay_boss_fnc_userinvoiceinfo_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayBossFncUserinvoiceinfoCreateErrorResponseModel' alipay_boss_fnc_userinvoiceinfo_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayBossFncUserinvoiceinfoModifyErrorResponseModel' alipay_boss_fnc_userinvoiceinfo_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayBossFncUserinvoiceinfoQueryErrorResponseModel' alipay_commerce_cityfacilitator_station_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceCityfacilitatorStationQueryErrorResponseModel' alipay_commerce_cityfacilitator_voucher_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceCityfacilitatorVoucherBatchqueryErrorResponseModel' alipay_commerce_cityfacilitator_voucher_generate_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceCityfacilitatorVoucherGenerateErrorResponseModel' alipay_commerce_cityfacilitator_voucher_refund_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceCityfacilitatorVoucherRefundErrorResponseModel' alipay_commerce_ec_balance_downloadurl_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcBalanceDownloadurlQueryErrorResponseModel' alipay_commerce_ec_balance_period_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcBalancePeriodModifyErrorResponseModel' alipay_commerce_ec_consume_detail_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcConsumeDetailQueryErrorResponseModel' alipay_commerce_ec_department_info_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcDepartmentInfoModifyErrorResponseModel' alipay_commerce_ec_department_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcDepartmentCreateErrorResponseModel' alipay_commerce_ec_department_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcDepartmentDeleteErrorResponseModel' alipay_commerce_ec_department_info_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcDepartmentInfoQueryErrorResponseModel' alipay_commerce_ec_department_sublist_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcDepartmentSublistQueryErrorResponseModel' alipay_commerce_ec_employee_add_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcEmployeeAddErrorResponseModel' alipay_commerce_ec_employee_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcEmployeeDeleteErrorResponseModel' alipay_commerce_ec_employee_idlist_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcEmployeeIdlistQueryErrorResponseModel' alipay_commerce_ec_employee_info_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcEmployeeInfoModifyErrorResponseModel' alipay_commerce_ec_employee_info_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcEmployeeInfoQueryErrorResponseModel' alipay_commerce_ec_employee_invite_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcEmployeeInviteQueryErrorResponseModel' alipay_commerce_ec_employee_title_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcEmployeeTitleModifyErrorResponseModel' alipay_commerce_ec_employee_title_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcEmployeeTitleCreateErrorResponseModel' alipay_commerce_ec_employee_title_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcEmployeeTitleDeleteErrorResponseModel' alipay_commerce_ec_enterprise_info_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcEnterpriseInfoModifyErrorResponseModel' alipay_commerce_ec_enterprise_address_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcEnterpriseAddressQueryErrorResponseModel' alipay_commerce_ec_enterprise_address_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcEnterpriseAddressModifyErrorResponseModel' alipay_commerce_ec_enterprise_address_add_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcEnterpriseAddressAddErrorResponseModel' alipay_commerce_ec_enterprise_agreement_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcEnterpriseAgreementQueryErrorResponseModel' alipay_commerce_ec_enterprise_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcEnterpriseCreateErrorResponseModel' alipay_commerce_ec_enterprise_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcEnterpriseDeleteErrorResponseModel' alipay_commerce_ec_enterprise_info_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcEnterpriseInfoQueryErrorResponseModel' alipay_commerce_ec_enterprise_unsign_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcEnterpriseUnsignErrorResponseModel' alipay_commerce_ec_jointaccountbill_detail_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcJointaccountbillDetailBatchqueryErrorResponseModel' alipay_commerce_ec_user_enterprise_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEcUserEnterpriseQueryErrorResponseModel' alipay_commerce_educate_campus_institutions_add_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEducateCampusInstitutionsAddErrorResponseModel' alipay_commerce_educate_campus_institutions_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEducateCampusInstitutionsQueryErrorResponseModel' alipay_commerce_educate_schoolcard_order_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceEducateSchoolcardOrderSyncErrorResponseModel' alipay_commerce_iot_device_report_upload_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceIotDeviceReportUploadErrorResponseModel' alipay_commerce_iot_sdarttool_message_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceIotSdarttoolMessageQueryErrorResponseModel' alipay_commerce_iot_sdarttool_message_send_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceIotSdarttoolMessageSendErrorResponseModel' alipay_commerce_logistics_invoice_istdwaybill_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceLogisticsInvoiceIstdwaybillCreateErrorResponseModel' alipay_commerce_logistics_invoice_istdwaybill_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceLogisticsInvoiceIstdwaybillQueryErrorResponseModel' alipay_commerce_logistics_logisticscompany_instantdelivery_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceLogisticsLogisticscompanyInstantdeliveryQueryErrorResponseModel' alipay_commerce_logistics_order_instantdelivery_cancel_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceLogisticsOrderInstantdeliveryCancelErrorResponseModel' alipay_commerce_logistics_order_instantdelivery_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceLogisticsOrderInstantdeliveryCreateErrorResponseModel' alipay_commerce_logistics_order_instantdelivery_precreate_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceLogisticsOrderInstantdeliveryPrecreateErrorResponseModel' alipay_commerce_logistics_order_istdcancel_preconsult_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceLogisticsOrderIstdcancelPreconsultErrorResponseModel' alipay_commerce_logistics_order_istdretry_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceLogisticsOrderIstdretryCreateErrorResponseModel' alipay_commerce_logistics_waybill_istddetail_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceLogisticsWaybillIstddetailQueryErrorResponseModel' alipay_commerce_operation_activity_merchant_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceOperationActivityMerchantModifyErrorResponseModel' alipay_commerce_operation_activity_merchant_sign_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceOperationActivityMerchantSignErrorResponseModel' alipay_commerce_operation_activity_merchant_unsign_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceOperationActivityMerchantUnsignErrorResponseModel' alipay_commerce_operation_bank_activity_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceOperationBankActivityQueryErrorResponseModel' alipay_commerce_transport_charger_chargerbindinfo_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceTransportChargerChargerbindinfoSyncErrorResponseModel' alipay_commerce_transport_parking_enterinfo_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceTransportParkingEnterinfoSyncErrorResponseModel' alipay_commerce_transport_parking_exitinfo_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceTransportParkingExitinfoSyncErrorResponseModel' alipay_commerce_transport_parking_paymentinfo_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayCommerceTransportParkingPaymentinfoSyncErrorResponseModel' alipay_data_bill_accountbookereceipt_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayDataBillAccountbookereceiptApplyErrorResponseModel' alipay_data_bill_accountbookereceipt_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayDataBillAccountbookereceiptQueryErrorResponseModel' alipay_data_bill_accountlog_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayDataBillAccountlogQueryErrorResponseModel' alipay_data_bill_bail_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayDataBillBailQueryErrorResponseModel' alipay_data_bill_balance_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayDataBillBalanceQueryErrorResponseModel' alipay_data_bill_balancehis_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayDataBillBalancehisQueryErrorResponseModel' alipay_data_bill_bizfundagent_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayDataBillBizfundagentQueryErrorResponseModel' alipay_data_bill_buy_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayDataBillBuyQueryErrorResponseModel' alipay_data_bill_ereceipt_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayDataBillEreceiptApplyErrorResponseModel' alipay_data_bill_ereceipt_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayDataBillEreceiptQueryErrorResponseModel' alipay_data_bill_ereceiptagent_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayDataBillEreceiptagentApplyErrorResponseModel' alipay_data_bill_sell_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayDataBillSellQueryErrorResponseModel' alipay_data_bill_transfer_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayDataBillTransferQueryErrorResponseModel' alipay_data_bill_transferaccountbook_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayDataBillTransferaccountbookQueryErrorResponseModel' alipay_data_dataservice_ad_conversion_upload_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayDataDataserviceAdConversionUploadErrorResponseModel' alipay_data_dataservice_ad_promotepage_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayDataDataserviceAdPromotepageBatchqueryErrorResponseModel' alipay_data_dataservice_ad_promotepage_download_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayDataDataserviceAdPromotepageDownloadErrorResponseModel' alipay_data_dataservice_bill_downloadurl_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayDataDataserviceBillDownloadurlQueryErrorResponseModel' alipay_ebpp_bill_add_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppBillAddErrorResponseModel' alipay_ebpp_bill_get_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppBillGetErrorResponseModel' alipay_ebpp_invoice_apply_inv_upload_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceApplyInvUploadErrorResponseModel' alipay_ebpp_invoice_apply_result_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceApplyResultSyncErrorResponseModel' alipay_ebpp_invoice_apply_status_notify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceApplyStatusNotifyErrorResponseModel' alipay_ebpp_invoice_applystatus_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceApplystatusQueryErrorResponseModel' alipay_ebpp_invoice_auth_sign_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceAuthSignErrorResponseModel' alipay_ebpp_invoice_auth_unsign_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceAuthUnsignErrorResponseModel' alipay_ebpp_invoice_detail_output_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceDetailOutputQueryErrorResponseModel' alipay_ebpp_invoice_ecorder_order_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceEcorderOrderQueryErrorResponseModel' alipay_ebpp_invoice_einvpackage_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceEinvpackageQueryErrorResponseModel' alipay_ebpp_invoice_enterprise_merchantrelation_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseMerchantrelationCreateErrorResponseModel' alipay_ebpp_invoice_enterpriseconsume_consume_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeConsumeBatchqueryErrorResponseModel' alipay_ebpp_invoice_enterpriseconsume_detail_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeDetailQueryErrorResponseModel' alipay_ebpp_invoice_enterpriseconsume_enterpriseopenrule_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleCreateErrorResponseModel' alipay_ebpp_invoice_enterpriseconsume_enterpriseopenrule_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleModifyErrorResponseModel' alipay_ebpp_invoice_enterpriseconsume_enterpriseopenrule_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeEnterpriseopenruleQueryErrorResponseModel' alipay_ebpp_invoice_enterpriseconsume_openrulerelation_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeOpenrulerelationCreateErrorResponseModel' alipay_ebpp_invoice_enterpriseconsume_relatedetail_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeRelatedetailQueryErrorResponseModel' alipay_ebpp_invoice_enterpriseconsume_summaryinvoicedetail_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseconsumeSummaryinvoicedetailQueryErrorResponseModel' alipay_ebpp_invoice_enterpriseexctrl_employertitle_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseexctrlEmployertitleModifyErrorResponseModel' alipay_ebpp_invoice_enterpriseexctrl_employertitle_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseexctrlEmployertitleBatchqueryErrorResponseModel' alipay_ebpp_invoice_enterpriseexctrl_employertitle_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseexctrlEmployertitleCreateErrorResponseModel' alipay_ebpp_invoice_enterpriseexctrl_employertitle_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceEnterpriseexctrlEmployertitleQueryErrorResponseModel' alipay_ebpp_invoice_expense_progress_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceExpenseProgressSyncErrorResponseModel' alipay_ebpp_invoice_expensecomsue_outsource_notify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceExpensecomsueOutsourceNotifyErrorResponseModel' alipay_ebpp_invoice_expensecontrol_aggregation_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceExpensecontrolAggregationCreateErrorResponseModel' alipay_ebpp_invoice_expensecontrol_employeequota_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceExpensecontrolEmployeequotaCreateErrorResponseModel' alipay_ebpp_invoice_expensecontrol_issuebatch_cancel_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceExpensecontrolIssuebatchCancelErrorResponseModel' alipay_ebpp_invoice_expensecontrol_issuebatch_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceExpensecontrolIssuebatchCreateErrorResponseModel' alipay_ebpp_invoice_expensecontrol_quota_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceExpensecontrolQuotaCreateErrorResponseModel' alipay_ebpp_invoice_expensecontrol_quota_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceExpensecontrolQuotaModifyErrorResponseModel' alipay_ebpp_invoice_expensecontrol_quota_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceExpensecontrolQuotaQueryErrorResponseModel' alipay_ebpp_invoice_expenserules_employee_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesEmployeeQueryErrorResponseModel' alipay_ebpp_invoice_expenserules_employeerules_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesEmployeerulesQueryErrorResponseModel' alipay_ebpp_invoice_expenserules_groupemployee_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesGroupemployeeModifyErrorResponseModel' alipay_ebpp_invoice_expenserules_projectemployee_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesProjectemployeeModifyErrorResponseModel' alipay_ebpp_invoice_expenserules_projectinfo_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesProjectinfoModifyErrorResponseModel' alipay_ebpp_invoice_expenserules_projectrule_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesProjectruleCreateErrorResponseModel' alipay_ebpp_invoice_expenserules_projectrule_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesProjectruleQueryErrorResponseModel' alipay_ebpp_invoice_expenserules_projectrules_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesProjectrulesModifyErrorResponseModel' alipay_ebpp_invoice_expenserules_scenerule_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesSceneruleCreateErrorResponseModel' alipay_ebpp_invoice_expenserules_scenerule_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesSceneruleModifyErrorResponseModel' alipay_ebpp_invoice_expenserules_scenerule_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceExpenserulesSceneruleQueryErrorResponseModel' alipay_ebpp_invoice_expensescene_merchant_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceExpensesceneMerchantQueryErrorResponseModel' alipay_ebpp_invoice_file_output_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceFileOutputQueryErrorResponseModel' alipay_ebpp_invoice_info_send_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceInfoSendErrorResponseModel' alipay_ebpp_invoice_institution_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionCreateErrorResponseModel' alipay_ebpp_invoice_institution_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionDeleteErrorResponseModel' alipay_ebpp_invoice_institution_detailinfo_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionDetailinfoQueryErrorResponseModel' alipay_ebpp_invoice_institution_expenserule_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionExpenseruleCreateErrorResponseModel' alipay_ebpp_invoice_institution_expenserule_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionExpenseruleDeleteErrorResponseModel' alipay_ebpp_invoice_institution_expenserule_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionExpenseruleModifyErrorResponseModel' alipay_ebpp_invoice_institution_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionModifyErrorResponseModel' alipay_ebpp_invoice_institution_pageinfo_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionPageinfoQueryErrorResponseModel' alipay_ebpp_invoice_institution_scope_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionScopeModifyErrorResponseModel' alipay_ebpp_invoice_institution_scopepageinfo_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceInstitutionScopepageinfoQueryErrorResponseModel' alipay_ebpp_invoice_issuerule_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceIssueruleCreateErrorResponseModel' alipay_ebpp_invoice_issuerule_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceIssueruleDeleteErrorResponseModel' alipay_ebpp_invoice_issuerule_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceIssueruleModifyErrorResponseModel' alipay_ebpp_invoice_isvtoken_reim_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceIsvtokenReimApplyErrorResponseModel' alipay_ebpp_invoice_list_expense_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceListExpenseSyncErrorResponseModel' alipay_ebpp_invoice_merchant_enterstatus_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceMerchantEnterstatusQueryErrorResponseModel' alipay_ebpp_invoice_merchantlist_enter_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceMerchantlistEnterApplyErrorResponseModel' alipay_ebpp_invoice_order_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceOrderQueryErrorResponseModel' alipay_ebpp_invoice_sycn_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceSycnErrorResponseModel' alipay_ebpp_invoice_sync_simple_send_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceSyncSimpleSendErrorResponseModel' alipay_ebpp_invoice_taxno_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceTaxnoBatchqueryErrorResponseModel' alipay_ebpp_invoice_title_dynamic_get_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceTitleDynamicGetErrorResponseModel' alipay_ebpp_invoice_title_list_get_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceTitleListGetErrorResponseModel' alipay_ebpp_invoice_token_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppInvoiceTokenBatchqueryErrorResponseModel' alipay_ebpp_pdeduct_async_pay_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppPdeductAsyncPayErrorResponseModel' alipay_ebpp_pdeduct_bill_pay_status_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppPdeductBillPayStatusErrorResponseModel' alipay_ebpp_pdeduct_pay_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppPdeductPayErrorResponseModel' alipay_ebpp_pdeduct_sign_add_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppPdeductSignAddErrorResponseModel' alipay_ebpp_pdeduct_sign_cancel_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppPdeductSignCancelErrorResponseModel' alipay_ebpp_pdeduct_sign_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppPdeductSignQueryErrorResponseModel' alipay_ebpp_pdeduct_sign_validate_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEbppPdeductSignValidateErrorResponseModel' alipay_eco_contract_signflows_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoContractSignflowsCreateErrorResponseModel' alipay_eco_doc_template_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoDocTemplateCreateErrorResponseModel' alipay_eco_doctemplate_settingurl_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoDoctemplateSettingurlQueryErrorResponseModel' alipay_eco_edu_kt_billing_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoEduKtBillingModifyErrorResponseModel' alipay_eco_edu_kt_billing_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoEduKtBillingQueryErrorResponseModel' alipay_eco_edu_kt_billing_send_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoEduKtBillingSendErrorResponseModel' alipay_eco_edu_kt_parent_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoEduKtParentQueryErrorResponseModel' alipay_eco_edu_kt_schoolinfo_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoEduKtSchoolinfoModifyErrorResponseModel' alipay_eco_edu_kt_student_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoEduKtStudentModifyErrorResponseModel' alipay_eco_file_path_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoFilePathQueryErrorResponseModel' alipay_eco_mycar_parking_chargeinfo_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoMycarParkingChargeinfoSyncErrorResponseModel' alipay_eco_mycar_parking_charginginfo_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoMycarParkingCharginginfoSyncErrorResponseModel' alipay_eco_mycar_parking_config_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoMycarParkingConfigQueryErrorResponseModel' alipay_eco_mycar_parking_config_set_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoMycarParkingConfigSetErrorResponseModel' alipay_eco_mycar_parking_enterinfo_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoMycarParkingEnterinfoSyncErrorResponseModel' alipay_eco_mycar_parking_exitinfo_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoMycarParkingExitinfoSyncErrorResponseModel' alipay_eco_mycar_parking_order_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoMycarParkingOrderSyncErrorResponseModel' alipay_eco_mycar_parking_order_update_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoMycarParkingOrderUpdateErrorResponseModel' alipay_eco_mycar_parking_overtimecharginginfo_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoMycarParkingOvertimecharginginfoSyncErrorResponseModel' alipay_eco_mycar_parking_parkinglotbiz_transfer_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoMycarParkingParkinglotbizTransferErrorResponseModel' alipay_eco_mycar_parking_parkinglotinfo_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoMycarParkingParkinglotinfoCreateErrorResponseModel' alipay_eco_mycar_parking_parkinglotinfo_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoMycarParkingParkinglotinfoQueryErrorResponseModel' alipay_eco_mycar_parking_parkinglotinfo_update_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoMycarParkingParkinglotinfoUpdateErrorResponseModel' alipay_eco_mycar_parking_paymentinfo_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoMycarParkingPaymentinfoSyncErrorResponseModel' alipay_eco_mycar_parking_spaceinfo_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoMycarParkingSpaceinfoSyncErrorResponseModel' alipay_eco_mycar_parking_vehicle_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoMycarParkingVehicleQueryErrorResponseModel' alipay_eco_sign_flow_cancel_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoSignFlowCancelErrorResponseModel' alipay_eco_sign_flow_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoSignFlowCreateErrorResponseModel' alipay_eco_sign_flow_finish_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoSignFlowFinishErrorResponseModel' alipay_eco_sign_flow_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoSignFlowQueryErrorResponseModel' alipay_eco_signflows_detail_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoSignflowsDetailQueryErrorResponseModel' alipay_eco_signflows_url_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayEcoSignflowsUrlQueryErrorResponseModel' alipay_fund_account_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundAccountQueryErrorResponseModel' alipay_fund_accountbook_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundAccountbookCreateErrorResponseModel' alipay_fund_accountbook_notify_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundAccountbookNotifyQueryErrorResponseModel' alipay_fund_accountbook_notify_subscribe_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundAccountbookNotifySubscribeErrorResponseModel' alipay_fund_accountbook_notify_unsubscribe_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundAccountbookNotifyUnsubscribeErrorResponseModel' alipay_fund_accountbook_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundAccountbookQueryErrorResponseModel' alipay_fund_agreement_quota_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundAgreementQuotaModifyErrorResponseModel' alipay_fund_agreement_quota_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundAgreementQuotaQueryErrorResponseModel' alipay_fund_auth_operation_cancel_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundAuthOperationCancelErrorResponseModel' alipay_fund_auth_operation_detail_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundAuthOperationDetailQueryErrorResponseModel' alipay_fund_auth_order_app_freeze_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundAuthOrderAppFreezeErrorResponseModel' alipay_fund_auth_order_freeze_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundAuthOrderFreezeErrorResponseModel' alipay_fund_auth_order_unfreeze_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundAuthOrderUnfreezeErrorResponseModel' alipay_fund_auth_order_voucher_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundAuthOrderVoucherCreateErrorResponseModel' alipay_fund_enterprisepay_group_add_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundEnterprisepayGroupAddErrorResponseModel' alipay_fund_enterprisepay_group_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundEnterprisepayGroupDeleteErrorResponseModel' alipay_fund_enterprisepay_group_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundEnterprisepayGroupModifyErrorResponseModel' alipay_fund_enterprisepay_group_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundEnterprisepayGroupQueryErrorResponseModel' alipay_fund_enterprisepay_member_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundEnterprisepayMemberModifyErrorResponseModel' alipay_fund_enterprisepay_sign_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundEnterprisepaySignErrorResponseModel' alipay_fund_enterprisepay_unsign_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundEnterprisepayUnsignErrorResponseModel' alipay_fund_jointaccount_bill_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundJointaccountBillQueryErrorResponseModel' alipay_fund_jointaccount_detail_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundJointaccountDetailQueryErrorResponseModel' alipay_fund_jointaccount_list_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundJointaccountListQueryErrorResponseModel' alipay_fund_jointaccount_member_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundJointaccountMemberBatchqueryErrorResponseModel' alipay_fund_jointaccount_member_bind_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundJointaccountMemberBindErrorResponseModel' alipay_fund_jointaccount_member_consult_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundJointaccountMemberConsultErrorResponseModel' alipay_fund_jointaccount_member_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundJointaccountMemberQueryErrorResponseModel' alipay_fund_jointaccount_member_unbind_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundJointaccountMemberUnbindErrorResponseModel' alipay_fund_jointaccount_memberrule_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundJointaccountMemberruleModifyErrorResponseModel' alipay_fund_jointaccount_quota_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundJointaccountQuotaQueryErrorResponseModel' alipay_fund_jointaccount_rule_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundJointaccountRuleModifyErrorResponseModel' alipay_fund_jointaccount_sign_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundJointaccountSignQueryErrorResponseModel' alipay_fund_jointaccount_trade_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundJointaccountTradeQueryErrorResponseModel' alipay_fund_trans_common_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundTransCommonQueryErrorResponseModel' alipay_fund_trans_order_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundTransOrderQueryErrorResponseModel' alipay_fund_trans_pay_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundTransPayErrorResponseModel' alipay_fund_trans_payee_bind_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundTransPayeeBindQueryErrorResponseModel' alipay_fund_trans_refund_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundTransRefundErrorResponseModel' alipay_fund_trans_toaccount_transfer_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundTransToaccountTransferErrorResponseModel' alipay_fund_trans_uni_transfer_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundTransUniTransferErrorResponseModel' alipay_fund_usertrade_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayFundUsertradeBatchqueryErrorResponseModel' alipay_iservice_ccm_agent_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmAgentCreateErrorResponseModel' alipay_iservice_ccm_agent_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmAgentDeleteErrorResponseModel' alipay_iservice_ccm_agent_get_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmAgentGetErrorResponseModel' alipay_iservice_ccm_agent_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmAgentModifyErrorResponseModel' alipay_iservice_ccm_agent_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmAgentQueryErrorResponseModel' alipay_iservice_ccm_agent_schedulelog_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmAgentSchedulelogQueryErrorResponseModel' alipay_iservice_ccm_function_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmFunctionQueryErrorResponseModel' alipay_iservice_ccm_instance_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmInstanceCreateErrorResponseModel' alipay_iservice_ccm_instance_get_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmInstanceGetErrorResponseModel' alipay_iservice_ccm_instance_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmInstanceQueryErrorResponseModel' alipay_iservice_ccm_isv_initialize_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmIsvInitializeErrorResponseModel' alipay_iservice_ccm_ols_chatrecord_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmOlsChatrecordQueryErrorResponseModel' alipay_iservice_ccm_robot_avatarbase_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmRobotAvatarbaseQueryErrorResponseModel' alipay_iservice_ccm_role_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmRoleCreateErrorResponseModel' alipay_iservice_ccm_role_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmRoleDeleteErrorResponseModel' alipay_iservice_ccm_role_get_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmRoleGetErrorResponseModel' alipay_iservice_ccm_role_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmRoleModifyErrorResponseModel' alipay_iservice_ccm_role_page_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmRolePageQueryErrorResponseModel' alipay_iservice_ccm_service_buy_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmServiceBuyErrorResponseModel' alipay_iservice_ccm_service_close_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmServiceCloseErrorResponseModel' alipay_iservice_ccm_service_initialize_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmServiceInitializeErrorResponseModel' alipay_iservice_ccm_servicerecord_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmServicerecordCreateErrorResponseModel' alipay_iservice_ccm_servicerecord_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmServicerecordModifyErrorResponseModel' alipay_iservice_ccm_sw_article_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmSwArticleBatchqueryErrorResponseModel' alipay_iservice_ccm_sw_article_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmSwArticleCreateErrorResponseModel' alipay_iservice_ccm_sw_article_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmSwArticleDeleteErrorResponseModel' alipay_iservice_ccm_sw_article_get_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmSwArticleGetErrorResponseModel' alipay_iservice_ccm_sw_article_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmSwArticleModifyErrorResponseModel' alipay_iservice_ccm_sw_knowledge_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmSwKnowledgeModifyErrorResponseModel' alipay_iservice_ccm_sw_library_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmSwLibraryBatchqueryErrorResponseModel' alipay_iservice_ccm_sw_library_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmSwLibraryCreateErrorResponseModel' alipay_iservice_ccm_sw_library_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmSwLibraryDeleteErrorResponseModel' alipay_iservice_ccm_sw_library_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmSwLibraryModifyErrorResponseModel' alipay_iservice_ccm_sw_order_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmSwOrderSyncErrorResponseModel' alipay_iservice_ccm_sw_spu_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmSwSpuSyncErrorResponseModel' alipay_iservice_ccm_sw_tree_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmSwTreeBatchqueryErrorResponseModel' alipay_iservice_ccm_sw_tree_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmSwTreeCreateErrorResponseModel' alipay_iservice_ccm_sw_tree_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmSwTreeDeleteErrorResponseModel' alipay_iservice_ccm_sw_tree_get_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmSwTreeGetErrorResponseModel' alipay_iservice_ccm_sw_tree_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmSwTreeModifyErrorResponseModel' alipay_iservice_ccm_sw_tree_publish_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmSwTreePublishErrorResponseModel' alipay_iservice_ccm_sw_treecategory_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmSwTreecategoryBatchqueryErrorResponseModel' alipay_iservice_ccm_sw_treecategory_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmSwTreecategoryCreateErrorResponseModel' alipay_iservice_ccm_sw_treecategory_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmSwTreecategoryDeleteErrorResponseModel' alipay_iservice_ccm_sw_treecategory_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayIserviceCcmSwTreecategoryModifyErrorResponseModel' alipay_marketing_activity_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityBatchqueryErrorResponseModel' alipay_marketing_activity_consult_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityConsultErrorResponseModel' alipay_marketing_activity_deliverychannel_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityDeliverychannelQueryErrorResponseModel' alipay_marketing_activity_ordervoucher_associate_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherAssociateErrorResponseModel' alipay_marketing_activity_ordervoucher_disassociate_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherDisassociateErrorResponseModel' alipay_marketing_activity_ordervoucher_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherQueryErrorResponseModel' alipay_marketing_activity_user_batchqueryvoucher_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityUserBatchqueryvoucherErrorResponseModel' alipay_marketing_activity_user_queryvoucher_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityUserQueryvoucherErrorResponseModel' alipay_marketing_activity_voucher_append_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityVoucherAppendErrorResponseModel' alipay_marketing_activity_voucher_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityVoucherCreateErrorResponseModel' alipay_marketing_activity_voucher_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityVoucherModifyErrorResponseModel' alipay_marketing_activity_voucher_publish_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityVoucherPublishErrorResponseModel' alipay_marketing_activity_voucher_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityVoucherQueryErrorResponseModel' alipay_marketing_activity_voucher_send_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityVoucherSendErrorResponseModel' alipay_marketing_activity_voucher_stop_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityVoucherStopErrorResponseModel' alipay_marketing_activity_voucherpackage_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityVoucherpackageBatchqueryErrorResponseModel' alipay_marketing_activity_voucherpackage_consult_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityVoucherpackageConsultErrorResponseModel' alipay_marketing_activity_voucherpackage_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityVoucherpackageQueryErrorResponseModel' alipay_marketing_activity_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityQueryErrorResponseModel' alipay_marketing_activity_app_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityAppBatchqueryErrorResponseModel' alipay_marketing_activity_goods_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityGoodsBatchqueryErrorResponseModel' alipay_marketing_activity_merchant_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityMerchantBatchqueryErrorResponseModel' alipay_marketing_activity_shop_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityShopBatchqueryErrorResponseModel' alipay_marketing_campaign_cash_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingCampaignCashCreateErrorResponseModel' alipay_marketing_campaign_cash_detail_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingCampaignCashDetailQueryErrorResponseModel' alipay_marketing_campaign_cash_list_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingCampaignCashListQueryErrorResponseModel' alipay_marketing_campaign_cash_status_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingCampaignCashStatusModifyErrorResponseModel' alipay_marketing_campaign_cash_trigger_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingCampaignCashTriggerErrorResponseModel' alipay_marketing_campaign_order_voucher_consult_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingCampaignOrderVoucherConsultErrorResponseModel' alipay_marketing_card_activateform_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingCardActivateformQueryErrorResponseModel' alipay_marketing_card_activateurl_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingCardActivateurlApplyErrorResponseModel' alipay_marketing_card_benefit_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingCardBenefitCreateErrorResponseModel' alipay_marketing_card_benefit_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingCardBenefitDeleteErrorResponseModel' alipay_marketing_card_benefit_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingCardBenefitModifyErrorResponseModel' alipay_marketing_card_benefit_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingCardBenefitQueryErrorResponseModel' alipay_marketing_card_consume_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingCardConsumeSyncErrorResponseModel' alipay_marketing_card_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingCardDeleteErrorResponseModel' alipay_marketing_card_formtemplate_set_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingCardFormtemplateSetErrorResponseModel' alipay_marketing_card_message_notify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingCardMessageNotifyErrorResponseModel' alipay_marketing_card_open_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingCardOpenErrorResponseModel' alipay_marketing_card_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingCardQueryErrorResponseModel' alipay_marketing_card_template_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingCardTemplateBatchqueryErrorResponseModel' alipay_marketing_card_template_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingCardTemplateCreateErrorResponseModel' alipay_marketing_card_template_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingCardTemplateModifyErrorResponseModel' alipay_marketing_card_template_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingCardTemplateQueryErrorResponseModel' alipay_marketing_card_update_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingCardUpdateErrorResponseModel' alipay_marketing_activity_delivery_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityDeliveryCreateErrorResponseModel' alipay_marketing_activity_delivery_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityDeliveryQueryErrorResponseModel' alipay_marketing_activity_delivery_stop_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityDeliveryStopErrorResponseModel' alipay_marketing_material_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingMaterialCreateErrorResponseModel' alipay_marketing_material_image_upload_request: properties: data: $ref: '#/components/schemas/AlipayMarketingMaterialImageUploadModel' file_content: format: binary type: string type: object alipay_marketing_material_image_upload_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingMaterialImageUploadErrorResponseModel' alipay_marketing_activity_ordervoucher_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherCreateErrorResponseModel' alipay_marketing_activity_ordervoucher_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherModifyErrorResponseModel' alipay_marketing_activity_ordervoucher_append_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherAppendErrorResponseModel' alipay_marketing_activity_ordervoucher_stop_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherStopErrorResponseModel' alipay_marketing_activity_ordervoucher_codecount_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherCodecountErrorResponseModel' alipay_marketing_activity_ordervoucher_codedeposit_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherCodedepositErrorResponseModel' alipay_marketing_activity_ordervoucher_refund_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherRefundErrorResponseModel' alipay_marketing_activity_ordervoucher_use_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingActivityOrdervoucherUseErrorResponseModel' alipay_marketing_recruit_enroll_close_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingRecruitEnrollCloseErrorResponseModel' alipay_marketing_recruit_enroll_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingRecruitEnrollCreateErrorResponseModel' alipay_marketing_recruit_enroll_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingRecruitEnrollQueryErrorResponseModel' alipay_marketing_recruit_plan_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingRecruitPlanQueryErrorResponseModel' alipay_marketing_recruit_planlist_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMarketingRecruitPlanlistQueryErrorResponseModel' alipay_merchant_anchor_info_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMerchantAnchorInfoQueryErrorResponseModel' alipay_merchant_image_upload_request: properties: data: $ref: '#/components/schemas/AlipayMerchantImageUploadModel' image_content: format: binary type: string type: object alipay_merchant_image_upload_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMerchantImageUploadErrorResponseModel' alipay_merchant_indirect_authorder_close_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMerchantIndirectAuthorderCloseErrorResponseModel' alipay_merchant_indirect_authorder_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMerchantIndirectAuthorderCreateErrorResponseModel' alipay_merchant_indirect_authorder_querystatus_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMerchantIndirectAuthorderQuerystatusErrorResponseModel' alipay_merchant_indirect_smidbind_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMerchantIndirectSmidbindQueryErrorResponseModel' alipay_merchant_iot_device_bind_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMerchantIotDeviceBindErrorResponseModel' alipay_merchant_iot_device_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMerchantIotDeviceQueryErrorResponseModel' alipay_merchant_iot_device_verify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMerchantIotDeviceVerifyErrorResponseModel' alipay_merchant_item_file_upload_request: properties: data: $ref: '#/components/schemas/AlipayMerchantItemFileUploadModel' file_content: format: binary type: string type: object alipay_merchant_item_file_upload_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMerchantItemFileUploadErrorResponseModel' alipay_merchant_live_channel_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMerchantLiveChannelQueryErrorResponseModel' alipay_merchant_live_itemplan_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMerchantLiveItemplanModifyErrorResponseModel' alipay_merchant_order_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMerchantOrderSyncErrorResponseModel' alipay_merchant_tradecomplain_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMerchantTradecomplainBatchqueryErrorResponseModel' alipay_merchant_tradecomplain_feedback_submit_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMerchantTradecomplainFeedbackSubmitErrorResponseModel' alipay_merchant_tradecomplain_reply_submit_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMerchantTradecomplainReplySubmitErrorResponseModel' alipay_merchant_tradecomplain_supplement_submit_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMerchantTradecomplainSupplementSubmitErrorResponseModel' alipay_merchant_tradecomplain_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMerchantTradecomplainQueryErrorResponseModel' alipay_mobile_public_follow_list_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMobilePublicFollowListErrorResponseModel' alipay_mobile_public_info_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMobilePublicInfoQueryErrorResponseModel' alipay_mobile_public_menu_add_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMobilePublicMenuAddErrorResponseModel' alipay_mobile_public_menu_get_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMobilePublicMenuGetErrorResponseModel' alipay_mobile_public_menu_update_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMobilePublicMenuUpdateErrorResponseModel' alipay_mobile_public_message_custom_send_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMobilePublicMessageCustomSendErrorResponseModel' alipay_mobile_public_message_single_send_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMobilePublicMessageSingleSendErrorResponseModel' alipay_mobile_public_message_total_send_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMobilePublicMessageTotalSendErrorResponseModel' alipay_mobile_public_qrcode_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMobilePublicQrcodeCreateErrorResponseModel' alipay_mobile_public_shortlink_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMobilePublicShortlinkCreateErrorResponseModel' alipay_mobile_public_template_message_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMobilePublicTemplateMessageDeleteErrorResponseModel' alipay_mobile_public_template_message_get_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMobilePublicTemplateMessageGetErrorResponseModel' alipay_mobile_public_template_message_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMobilePublicTemplateMessageQueryErrorResponseModel' alipay_mobile_std_public_message_custom_send_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayMobileStdPublicMessageCustomSendErrorResponseModel' alipay_offline_market_applyorder_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOfflineMarketApplyorderBatchqueryErrorResponseModel' alipay_offline_market_shop_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOfflineMarketShopBatchqueryErrorResponseModel' alipay_offline_market_shop_category_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOfflineMarketShopCategoryQueryErrorResponseModel' alipay_offline_market_shop_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOfflineMarketShopCreateErrorResponseModel' alipay_offline_market_shop_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOfflineMarketShopModifyErrorResponseModel' alipay_offline_market_shop_querydetail_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOfflineMarketShopQuerydetailErrorResponseModel' alipay_offline_market_shop_summary_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOfflineMarketShopSummaryBatchqueryErrorResponseModel' alipay_offline_material_image_upload_request: properties: data: $ref: '#/components/schemas/AlipayOfflineMaterialImageUploadModel' image_content: format: binary type: string type: object alipay_offline_material_image_upload_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOfflineMaterialImageUploadErrorResponseModel' alipay_open_agent_cancel_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAgentCancelErrorResponseModel' alipay_open_agent_common_sign_request: properties: app_auth_pic: format: binary type: string app_demo: format: binary type: string app_home_screenshot: format: binary type: string app_item_screenshot: format: binary type: string app_pay_screenshot: format: binary type: string business_license_auth_pic: format: binary type: string business_license_pic: format: binary type: string data: $ref: '#/components/schemas/AlipayOpenAgentCommonSignModel' h_5_extra_pic: format: binary type: string h_5_home_screenshot: format: binary type: string h_5_item_screenshot: format: binary type: string h_5_pay_screenshot: format: binary type: string h_5_sites_loa: format: binary type: string mini_app_screenshot: format: binary type: string shop_scene_pic: format: binary type: string shop_sign_board_pic: format: binary type: string special_license_pic: format: binary type: string web_home_screenshot: format: binary type: string web_item_screenshot: format: binary type: string web_pay_screenshot: format: binary type: string web_sites_loa: format: binary type: string type: object alipay_open_agent_common_sign_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAgentCommonSignErrorResponseModel' alipay_open_agent_commonsign_confirm_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAgentCommonsignConfirmErrorResponseModel' alipay_open_agent_confirm_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAgentConfirmErrorResponseModel' alipay_open_agent_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAgentCreateErrorResponseModel' alipay_open_agent_facetoface_sign_request: properties: business_license_auth_pic: format: binary type: string business_license_pic: format: binary type: string data: $ref: '#/components/schemas/AlipayOpenAgentFacetofaceSignModel' shop_scene_pic: format: binary type: string shop_sign_board_pic: format: binary type: string special_license_pic: format: binary type: string type: object alipay_open_agent_facetoface_sign_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAgentFacetofaceSignErrorResponseModel' alipay_open_agent_mini_create_request: properties: app_logo: format: binary type: string data: $ref: '#/components/schemas/AlipayOpenAgentMiniCreateModel' type: object alipay_open_agent_mini_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAgentMiniCreateErrorResponseModel' alipay_open_agent_mobilepay_sign_request: properties: app_auth_pic: format: binary type: string app_demo: format: binary type: string app_home_screenshot: format: binary type: string app_item_screenshot: format: binary type: string app_pay_screenshot: format: binary type: string business_license_auth_pic: format: binary type: string business_license_pic: format: binary type: string data: $ref: '#/components/schemas/AlipayOpenAgentMobilepaySignModel' home_screenshot: format: binary type: string in_app_screenshot: format: binary type: string pay_screenshot: format: binary type: string special_license_pic: format: binary type: string type: object alipay_open_agent_mobilepay_sign_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAgentMobilepaySignErrorResponseModel' alipay_open_agent_offlinepayment_sign_request: properties: business_license_pic: format: binary type: string data: $ref: '#/components/schemas/AlipayOpenAgentOfflinepaymentSignModel' shop_scene_pic: format: binary type: string shop_sign_board_pic: format: binary type: string special_license_pic: format: binary type: string type: object alipay_open_agent_offlinepayment_sign_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAgentOfflinepaymentSignErrorResponseModel' alipay_open_agent_order_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAgentOrderQueryErrorResponseModel' alipay_open_agent_signstatus_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAgentSignstatusQueryErrorResponseModel' alipay_open_app_api_field_apply_request: properties: data: $ref: '#/components/schemas/AlipayOpenAppApiFieldApplyModel' picture_1: format: binary type: string picture_2: format: binary type: string picture_3: format: binary type: string picture_4: format: binary type: string picture_5: format: binary type: string video: format: binary type: string type: object alipay_open_app_api_field_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAppApiFieldApplyErrorResponseModel' alipay_open_app_api_field_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAppApiFieldQueryErrorResponseModel' alipay_open_app_api_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAppApiQueryErrorResponseModel' alipay_open_app_api_scene_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAppApiSceneQueryErrorResponseModel' alipay_open_app_members_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAppMembersCreateErrorResponseModel' alipay_open_app_members_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAppMembersDeleteErrorResponseModel' alipay_open_app_members_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAppMembersQueryErrorResponseModel' alipay_open_app_messagetemplate_subscribe_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAppMessagetemplateSubscribeQueryErrorResponseModel' alipay_open_app_mini_templatemessage_send_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAppMiniTemplatemessageSendErrorResponseModel' alipay_open_app_qrcode_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAppQrcodeCreateErrorResponseModel' alipay_open_app_service_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAppServiceApplyErrorResponseModel' alipay_open_app_service_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAppServiceDeleteErrorResponseModel' alipay_open_app_service_list_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAppServiceListQueryErrorResponseModel' alipay_open_app_service_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAppServiceQueryErrorResponseModel' alipay_open_app_service_schema_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAppServiceSchemaQueryErrorResponseModel' alipay_open_auth_app_aes_get_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAuthAppAesGetErrorResponseModel' alipay_open_auth_app_aes_set_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAuthAppAesSetErrorResponseModel' alipay_open_auth_token_app_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAuthTokenAppErrorResponseModel' alipay_open_auth_token_app_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAuthTokenAppQueryErrorResponseModel' alipay_open_auth_userauth_relationship_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenAuthUserauthRelationshipQueryErrorResponseModel' alipay_open_biz_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenBizCreateErrorResponseModel' alipay_open_fee_adjust_apply_request: properties: attachment: format: binary type: string cert_pic: format: binary type: string data: $ref: '#/components/schemas/AlipayOpenFeeAdjustApplyModel' shop_scene_pic: format: binary type: string shop_sign_pic: format: binary type: string type: object alipay_open_fee_adjust_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenFeeAdjustApplyErrorResponseModel' alipay_open_file_upload_request: properties: data: $ref: '#/components/schemas/AlipayOpenFileUploadModel' file_content: format: binary type: string type: object alipay_open_file_upload_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenFileUploadErrorResponseModel' alipay_open_instantdelivery_account_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenInstantdeliveryAccountCreateErrorResponseModel' alipay_open_instantdelivery_account_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenInstantdeliveryAccountQueryErrorResponseModel' alipay_open_instantdelivery_merchantagreement_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenInstantdeliveryMerchantagreementQueryErrorResponseModel' alipay_open_instantdelivery_merchantagreement_sign_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenInstantdeliveryMerchantagreementSignErrorResponseModel' alipay_open_instantdelivery_merchantshop_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenInstantdeliveryMerchantshopBatchqueryErrorResponseModel' alipay_open_instantdelivery_merchantshop_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenInstantdeliveryMerchantshopCreateErrorResponseModel' alipay_open_instantdelivery_merchantshop_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenInstantdeliveryMerchantshopModifyErrorResponseModel' alipay_open_instantdelivery_merchantshop_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenInstantdeliveryMerchantshopQueryErrorResponseModel' alipay_open_invite_order_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenInviteOrderQueryErrorResponseModel' alipay_open_mini_appdeploy_byappid_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniAppdeployByappidQueryErrorResponseModel' alipay_open_mini_appdeploy_byappversion_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniAppdeployByappversionQueryErrorResponseModel' alipay_open_mini_appdeploy_bydeployversion_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniAppdeployBydeployversionQueryErrorResponseModel' alipay_open_mini_baseinfo_modify_request: properties: app_logo: format: binary type: string data: $ref: '#/components/schemas/AlipayOpenMiniBaseinfoModifyModel' type: object alipay_open_mini_baseinfo_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniBaseinfoModifyErrorResponseModel' alipay_open_mini_baseinfo_name_check_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniBaseinfoNameCheckErrorResponseModel' alipay_open_mini_baseinfo_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniBaseinfoQueryErrorResponseModel' alipay_open_mini_category_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniCategoryQueryErrorResponseModel' alipay_open_mini_category_require_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniCategoryRequireQueryErrorResponseModel' alipay_open_mini_experience_cancel_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniExperienceCancelErrorResponseModel' alipay_open_mini_experience_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniExperienceCreateErrorResponseModel' alipay_open_mini_experience_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniExperienceQueryErrorResponseModel' alipay_open_mini_individual_business_certify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniIndividualBusinessCertifyErrorResponseModel' alipay_open_mini_inner_experience_cancel_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerExperienceCancelErrorResponseModel' alipay_open_mini_inner_members_add_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerMembersAddErrorResponseModel' alipay_open_mini_inner_members_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerMembersDeleteErrorResponseModel' alipay_open_mini_inner_members_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerMembersQueryErrorResponseModel' alipay_open_mini_innerapp_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerappCreateErrorResponseModel' alipay_open_mini_innerapp_plugin_order_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerappPluginOrderErrorResponseModel' alipay_open_mini_innerapp_pluginrelation_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerappPluginrelationQueryErrorResponseModel' alipay_open_mini_innerapp_pluginservice_publish_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerappPluginservicePublishErrorResponseModel' alipay_open_mini_innerapp_pluginsyncmode_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerappPluginsyncmodeModifyErrorResponseModel' alipay_open_mini_innerapp_pluginuseconfig_cancel_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerappPluginuseconfigCancelErrorResponseModel' alipay_open_mini_innerapp_pluginuseconfig_online_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerappPluginuseconfigOnlineErrorResponseModel' alipay_open_mini_innerapp_pluginuseconfig_upgrade_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerappPluginuseconfigUpgradeErrorResponseModel' alipay_open_mini_innerapp_service_publish_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerappServicePublishErrorResponseModel' alipay_open_mini_innerapp_service_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerappServiceQueryErrorResponseModel' alipay_open_mini_innerbaseinfo_applogo_upload_request: properties: app_logo: format: binary type: string type: object alipay_open_mini_innerbaseinfo_applogo_upload_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerbaseinfoApplogoUploadErrorResponseModel' alipay_open_mini_innerbaseinfo_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerbaseinfoQueryErrorResponseModel' alipay_open_mini_innerversion_audit_cancel_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionAuditCancelErrorResponseModel' alipay_open_mini_innerversion_audit_submit_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionAuditSubmitErrorResponseModel' alipay_open_mini_innerversion_backdev_publish_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionBackdevPublishErrorResponseModel' alipay_open_mini_innerversion_beta_confirm_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionBetaConfirmErrorResponseModel' alipay_open_mini_innerversion_betainfo_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionBetainfoQueryErrorResponseModel' alipay_open_mini_innerversion_buildaudit_submit_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionBuildauditSubmitErrorResponseModel' alipay_open_mini_innerversion_condition_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionConditionBatchqueryErrorResponseModel' alipay_open_mini_innerversion_content_rollback_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionContentRollbackErrorResponseModel' alipay_open_mini_innerversion_gray_finish_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionGrayFinishErrorResponseModel' alipay_open_mini_innerversion_gray_publish_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionGrayPublishErrorResponseModel' alipay_open_mini_innerversion_info_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionInfoDeleteErrorResponseModel' alipay_open_mini_innerversion_info_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionInfoQueryErrorResponseModel' alipay_open_mini_innerversion_instantiation_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionInstantiationQueryErrorResponseModel' alipay_open_mini_innerversion_last_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionLastQueryErrorResponseModel' alipay_open_mini_innerversion_modelforoffline_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionModelforofflineQueryErrorResponseModel' alipay_open_mini_innerversion_nobuild_upload_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionNobuildUploadErrorResponseModel' alipay_open_mini_innerversion_offline_publish_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionOfflinePublishErrorResponseModel' alipay_open_mini_innerversion_online_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionOnlineErrorResponseModel' alipay_open_mini_innerversion_online_publish_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionOnlinePublishErrorResponseModel' alipay_open_mini_innerversion_package_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionPackageCreateErrorResponseModel' alipay_open_mini_innerversion_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionSyncErrorResponseModel' alipay_open_mini_innerversion_templated_upload_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionTemplatedUploadErrorResponseModel' alipay_open_mini_innerversion_upgrade_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionUpgradeErrorResponseModel' alipay_open_mini_innerversion_upload_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionUploadErrorResponseModel' alipay_open_mini_innerversion_uploadstatus_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniInnerversionUploadstatusQueryErrorResponseModel' alipay_open_mini_isv_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniIsvCreateErrorResponseModel' alipay_open_mini_isv_fastregister_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniIsvFastregisterCreateErrorResponseModel' alipay_open_mini_isv_fastregister_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniIsvFastregisterQueryErrorResponseModel' alipay_open_mini_isv_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniIsvQueryErrorResponseModel' alipay_open_mini_miniapp_brand_cancel_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniMiniappBrandCancelErrorResponseModel' alipay_open_mini_miniapp_brand_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniMiniappBrandQueryErrorResponseModel' alipay_open_mini_miniapp_brand_submit_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniMiniappBrandSubmitErrorResponseModel' alipay_open_mini_miniapp_brand_upload_request: properties: file_content: format: binary type: string type: object alipay_open_mini_miniapp_brand_upload_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniMiniappBrandUploadErrorResponseModel' alipay_open_mini_miniapp_serviceconfig_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniMiniappServiceconfigModifyErrorResponseModel' alipay_open_mini_qrcode_bind_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniQrcodeBindErrorResponseModel' alipay_open_mini_qrcode_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniQrcodeQueryErrorResponseModel' alipay_open_mini_qrcode_unbind_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniQrcodeUnbindErrorResponseModel' alipay_open_mini_resource_promotionsource_notify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniResourcePromotionsourceNotifyErrorResponseModel' alipay_open_mini_resource_record_notify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniResourceRecordNotifyErrorResponseModel' alipay_open_mini_safedomain_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniSafedomainCreateErrorResponseModel' alipay_open_mini_safedomain_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniSafedomainDeleteErrorResponseModel' alipay_open_mini_template_marketing_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniTemplateMarketingCreateErrorResponseModel' alipay_open_mini_template_usage_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniTemplateUsageQueryErrorResponseModel' alipay_open_mini_templatemessage_usertemplate_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniTemplatemessageUsertemplateApplyErrorResponseModel' alipay_open_mini_templatemsg_maketing_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniTemplatemsgMaketingBatchqueryErrorResponseModel' alipay_open_mini_templatemsg_maketingstatus_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniTemplatemsgMaketingstatusModifyErrorResponseModel' alipay_open_mini_templatemsg_tinypayswitch_confirm_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniTemplatemsgTinypayswitchConfirmErrorResponseModel' alipay_open_mini_tips_delivery_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniTipsDeliveryBatchqueryErrorResponseModel' alipay_open_mini_tips_delivery_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniTipsDeliveryCreateErrorResponseModel' alipay_open_mini_tips_delivery_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniTipsDeliveryModifyErrorResponseModel' alipay_open_mini_tips_delivery_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniTipsDeliveryQueryErrorResponseModel' alipay_open_mini_tips_statistic_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniTipsStatisticQueryErrorResponseModel' alipay_open_mini_version_audit_apply_request: properties: app_logo: format: binary type: string data: $ref: '#/components/schemas/AlipayOpenMiniVersionAuditApplyModel' fifth_license_pic: format: binary type: string fifth_screen_shot: format: binary type: string first_license_pic: format: binary type: string first_screen_shot: format: binary type: string first_special_license_pic: format: binary type: string fourth_license_pic: format: binary type: string fourth_screen_shot: format: binary type: string out_door_pic: format: binary type: string second_license_pic: format: binary type: string second_screen_shot: format: binary type: string second_special_license_pic: format: binary type: string test_file_name: format: binary type: string third_license_pic: format: binary type: string third_screen_shot: format: binary type: string third_special_license_pic: format: binary type: string type: object alipay_open_mini_version_audit_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniVersionAuditApplyErrorResponseModel' alipay_open_mini_version_audit_cancel_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniVersionAuditCancelErrorResponseModel' alipay_open_mini_version_audited_cancel_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniVersionAuditedCancelErrorResponseModel' alipay_open_mini_version_build_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniVersionBuildQueryErrorResponseModel' alipay_open_mini_version_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniVersionDeleteErrorResponseModel' alipay_open_mini_version_detail_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniVersionDetailQueryErrorResponseModel' alipay_open_mini_version_gray_cancel_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniVersionGrayCancelErrorResponseModel' alipay_open_mini_version_gray_online_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniVersionGrayOnlineErrorResponseModel' alipay_open_mini_version_list_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniVersionListQueryErrorResponseModel' alipay_open_mini_version_offline_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniVersionOfflineErrorResponseModel' alipay_open_mini_version_online_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniVersionOnlineErrorResponseModel' alipay_open_mini_version_rollback_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniVersionRollbackErrorResponseModel' alipay_open_mini_version_upload_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniVersionUploadErrorResponseModel' alipay_open_mini_widget_data_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniWidgetDataSyncErrorResponseModel' alipay_open_mini_widget_goods_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniWidgetGoodsModifyErrorResponseModel' alipay_open_mini_widget_goods_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniWidgetGoodsQueryErrorResponseModel' alipay_open_mini_widget_goods_upload_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenMiniWidgetGoodsUploadErrorResponseModel' alipay_open_public_account_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicAccountCreateErrorResponseModel' alipay_open_public_account_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicAccountDeleteErrorResponseModel' alipay_open_public_account_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicAccountQueryErrorResponseModel' alipay_open_public_account_reset_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicAccountResetErrorResponseModel' alipay_open_public_advert_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicAdvertBatchqueryErrorResponseModel' alipay_open_public_advert_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicAdvertCreateErrorResponseModel' alipay_open_public_advert_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicAdvertDeleteErrorResponseModel' alipay_open_public_advert_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicAdvertModifyErrorResponseModel' alipay_open_public_articlesummary_data_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicArticlesummaryDataBatchqueryErrorResponseModel' alipay_open_public_contact_follow_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicContactFollowBatchqueryErrorResponseModel' alipay_open_public_default_extension_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicDefaultExtensionCreateErrorResponseModel' alipay_open_public_follow_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicFollowBatchqueryErrorResponseModel' alipay_open_public_group_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicGroupBatchqueryErrorResponseModel' alipay_open_public_group_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicGroupCreateErrorResponseModel' alipay_open_public_group_crowd_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicGroupCrowdQueryErrorResponseModel' alipay_open_public_group_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicGroupDeleteErrorResponseModel' alipay_open_public_group_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicGroupModifyErrorResponseModel' alipay_open_public_info_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicInfoModifyErrorResponseModel' alipay_open_public_info_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicInfoQueryErrorResponseModel' alipay_open_public_label_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicLabelCreateErrorResponseModel' alipay_open_public_label_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicLabelQueryErrorResponseModel' alipay_open_public_label_user_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicLabelUserQueryErrorResponseModel' alipay_open_public_life_aboard_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicLifeAboardApplyErrorResponseModel' alipay_open_public_life_agentcreate_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicLifeAgentcreateQueryErrorResponseModel' alipay_open_public_life_debark_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicLifeDebarkApplyErrorResponseModel' alipay_open_public_life_label_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicLifeLabelBatchqueryErrorResponseModel' alipay_open_public_life_label_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicLifeLabelCreateErrorResponseModel' alipay_open_public_life_label_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicLifeLabelDeleteErrorResponseModel' alipay_open_public_life_label_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicLifeLabelModifyErrorResponseModel' alipay_open_public_life_msg_recall_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicLifeMsgRecallErrorResponseModel' alipay_open_public_life_msg_send_request: properties: cover: format: binary type: string data: $ref: '#/components/schemas/AlipayOpenPublicLifeMsgSendModel' type: object alipay_open_public_life_msg_send_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicLifeMsgSendErrorResponseModel' alipay_open_public_matchuser_label_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicMatchuserLabelCreateErrorResponseModel' alipay_open_public_matchuser_label_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicMatchuserLabelDeleteErrorResponseModel' alipay_open_public_menu_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicMenuBatchqueryErrorResponseModel' alipay_open_public_menu_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicMenuCreateErrorResponseModel' alipay_open_public_menu_data_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicMenuDataBatchqueryErrorResponseModel' alipay_open_public_menu_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicMenuModifyErrorResponseModel' alipay_open_public_menu_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicMenuQueryErrorResponseModel' alipay_open_public_message_content_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicMessageContentCreateErrorResponseModel' alipay_open_public_message_content_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicMessageContentModifyErrorResponseModel' alipay_open_public_message_custom_send_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicMessageCustomSendErrorResponseModel' alipay_open_public_message_group_send_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicMessageGroupSendErrorResponseModel' alipay_open_public_message_label_send_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicMessageLabelSendErrorResponseModel' alipay_open_public_message_single_send_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicMessageSingleSendErrorResponseModel' alipay_open_public_message_total_send_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicMessageTotalSendErrorResponseModel' alipay_open_public_payee_bind_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicPayeeBindCreateErrorResponseModel' alipay_open_public_payee_bind_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicPayeeBindDeleteErrorResponseModel' alipay_open_public_personalized_extension_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicPersonalizedExtensionBatchqueryErrorResponseModel' alipay_open_public_personalized_extension_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicPersonalizedExtensionCreateErrorResponseModel' alipay_open_public_personalized_extension_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicPersonalizedExtensionDeleteErrorResponseModel' alipay_open_public_personalized_menu_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicPersonalizedMenuCreateErrorResponseModel' alipay_open_public_personalized_menu_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicPersonalizedMenuDeleteErrorResponseModel' alipay_open_public_qrcode_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicQrcodeCreateErrorResponseModel' alipay_open_public_setting_category_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicSettingCategoryQueryErrorResponseModel' alipay_open_public_shortlink_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicShortlinkCreateErrorResponseModel' alipay_open_public_singlearticle_data_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicSinglearticleDataBatchqueryErrorResponseModel' alipay_open_public_template_message_get_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicTemplateMessageGetErrorResponseModel' alipay_open_public_template_message_industry_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicTemplateMessageIndustryModifyErrorResponseModel' alipay_open_public_topic_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicTopicBatchqueryErrorResponseModel' alipay_open_public_topic_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicTopicCreateErrorResponseModel' alipay_open_public_topic_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicTopicDeleteErrorResponseModel' alipay_open_public_topic_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicTopicModifyErrorResponseModel' alipay_open_public_user_data_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicUserDataBatchqueryErrorResponseModel' alipay_open_public_user_follow_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenPublicUserFollowQueryErrorResponseModel' alipay_open_search_ability_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchAbilityBatchqueryErrorResponseModel' alipay_open_search_appkeyword_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchAppkeywordApplyErrorResponseModel' alipay_open_search_appkeyword_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchAppkeywordBatchqueryErrorResponseModel' alipay_open_search_appkeyword_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchAppkeywordDeleteErrorResponseModel' alipay_open_search_appkeyword_querystatus_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchAppkeywordQuerystatusErrorResponseModel' alipay_open_search_appkeywordquota_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchAppkeywordquotaQueryErrorResponseModel' alipay_open_search_baseorder_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchBaseorderModifyErrorResponseModel' alipay_open_search_box_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchBoxApplyErrorResponseModel' alipay_open_search_box_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchBoxBatchqueryErrorResponseModel' alipay_open_search_box_consult_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchBoxConsultErrorResponseModel' alipay_open_search_box_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchBoxModifyErrorResponseModel' alipay_open_search_box_offline_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchBoxOfflineErrorResponseModel' alipay_open_search_box_online_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchBoxOnlineErrorResponseModel' alipay_open_search_box_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchBoxQueryErrorResponseModel' alipay_open_search_boxactivity_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchBoxactivityApplyErrorResponseModel' alipay_open_search_boxactivity_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchBoxactivityBatchqueryErrorResponseModel' alipay_open_search_boxactivity_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchBoxactivityModifyErrorResponseModel' alipay_open_search_boxactivity_offline_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchBoxactivityOfflineErrorResponseModel' alipay_open_search_boxactivity_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchBoxactivityQueryErrorResponseModel' alipay_open_search_orderdetail_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchOrderdetailQueryErrorResponseModel' alipay_open_search_serviceorder_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchServiceorderBatchqueryErrorResponseModel' alipay_open_search_subservicekeyword_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchSubservicekeywordApplyErrorResponseModel' alipay_open_search_subservicekeyword_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchSubservicekeywordBatchqueryErrorResponseModel' alipay_open_search_subservicekeyword_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchSubservicekeywordDeleteErrorResponseModel' alipay_open_search_subservicekeyword_querystatus_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSearchSubservicekeywordQuerystatusErrorResponseModel' alipay_open_servicemarket_commodity_shop_offline_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenServicemarketCommodityShopOfflineErrorResponseModel' alipay_open_servicemarket_commodity_shop_online_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenServicemarketCommodityShopOnlineErrorResponseModel' alipay_open_servicemarket_order_accept_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenServicemarketOrderAcceptErrorResponseModel' alipay_open_servicemarket_order_create_request: properties: app_logo: format: binary type: string data: $ref: '#/components/schemas/AlipayOpenServicemarketOrderCreateModel' type: object alipay_open_servicemarket_order_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenServicemarketOrderCreateErrorResponseModel' alipay_open_servicemarket_order_item_cancel_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenServicemarketOrderItemCancelErrorResponseModel' alipay_open_servicemarket_order_item_complete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenServicemarketOrderItemCompleteErrorResponseModel' alipay_open_servicemarket_order_item_confirm_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenServicemarketOrderItemConfirmErrorResponseModel' alipay_open_servicemarket_order_notify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenServicemarketOrderNotifyErrorResponseModel' alipay_open_servicemarket_order_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenServicemarketOrderQueryErrorResponseModel' alipay_open_servicemarket_order_reject_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenServicemarketOrderRejectErrorResponseModel' alipay_open_servicemarket_promotiontask_relation_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenServicemarketPromotiontaskRelationQueryErrorResponseModel' alipay_open_sp_blueseaactivity_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSpBlueseaactivityCreateErrorResponseModel' alipay_open_sp_blueseaactivity_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSpBlueseaactivityModifyErrorResponseModel' alipay_open_sp_blueseaactivity_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSpBlueseaactivityQueryErrorResponseModel' alipay_open_sp_image_upload_request: properties: image_content: format: binary type: string type: object alipay_open_sp_image_upload_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSpImageUploadErrorResponseModel' alipay_open_sp_isv_bill_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSpIsvBillSyncErrorResponseModel' alipay_open_sp_isv_operation_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSpIsvOperationSyncErrorResponseModel' alipay_open_sp_isv_relation_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSpIsvRelationQueryErrorResponseModel' alipay_open_sp_isv_sales_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSpIsvSalesSyncErrorResponseModel' alipay_open_sp_isv_signauth_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSpIsvSignauthCreateErrorResponseModel' alipay_open_sp_isv_signauth_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSpIsvSignauthQueryErrorResponseModel' alipay_open_sp_leads_expand_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSpLeadsExpandCreateErrorResponseModel' alipay_open_sp_merchant_inconsistent_approve_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSpMerchantInconsistentApproveErrorResponseModel' alipay_open_sp_operation_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSpOperationApplyErrorResponseModel' alipay_open_sp_operation_qrcode_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSpOperationQrcodeQueryErrorResponseModel' alipay_open_sp_operation_result_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSpOperationResultQueryErrorResponseModel' alipay_open_sp_oppor_detail_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSpOpporDetailQueryErrorResponseModel' alipay_open_sp_oppor_feedback_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSpOpporFeedbackModifyErrorResponseModel' alipay_open_sp_oppor_page_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenSpOpporPageQueryErrorResponseModel' alipay_open_violation_violationdetail_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenViolationViolationdetailQueryErrorResponseModel' alipay_open_violation_violationevent_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayOpenViolationViolationeventBatchqueryErrorResponseModel' alipay_pcredit_huabei_auth_accumulation_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayPcreditHuabeiAuthAccumulationQueryErrorResponseModel' alipay_pcredit_huabei_auth_agreement_close_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayPcreditHuabeiAuthAgreementCloseErrorResponseModel' alipay_pcredit_huabei_auth_agreement_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayPcreditHuabeiAuthAgreementQueryErrorResponseModel' alipay_pcredit_huabei_auth_order_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayPcreditHuabeiAuthOrderQueryErrorResponseModel' alipay_pcredit_huabei_auth_order_unfreeze_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayPcreditHuabeiAuthOrderUnfreezeErrorResponseModel' alipay_pcredit_huabei_auth_refund_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayPcreditHuabeiAuthRefundApplyErrorResponseModel' alipay_pcredit_huabei_auth_settle_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayPcreditHuabeiAuthSettleApplyErrorResponseModel' alipay_security_data_sss_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipaySecurityDataSssCreateErrorResponseModel' alipay_security_prod_sss_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipaySecurityProdSssQueryErrorResponseModel' alipay_security_risk_customerrisk_send_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipaySecurityRiskCustomerriskSendErrorResponseModel' alipay_security_risk_verifyidentity_miniapp_confirm_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipaySecurityRiskVerifyidentityMiniappConfirmErrorResponseModel' alipay_social_base_contentlib_standardcontent_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipaySocialBaseContentlibStandardcontentBatchqueryErrorResponseModel' alipay_system_oauth_token_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipaySystemOauthTokenErrorResponseModel' alipay_trade_advance_consult_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeAdvanceConsultErrorResponseModel' alipay_trade_applepay_authentication_submit_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeApplepayAuthenticationSubmitErrorResponseModel' alipay_trade_batch_settle_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeBatchSettleErrorResponseModel' alipay_trade_batch_settle_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeBatchSettleQueryErrorResponseModel' alipay_trade_batch_transfer_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeBatchTransferErrorResponseModel' alipay_trade_batch_transfer_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeBatchTransferQueryErrorResponseModel' alipay_trade_cancel_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeCancelErrorResponseModel' alipay_trade_close_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeCloseErrorResponseModel' alipay_trade_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeCreateErrorResponseModel' alipay_trade_customs_declare_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeCustomsDeclareErrorResponseModel' alipay_trade_customs_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeCustomsQueryErrorResponseModel' alipay_trade_fastpay_refund_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeFastpayRefundQueryErrorResponseModel' alipay_trade_order_pay_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeOrderPayErrorResponseModel' alipay_trade_order_settle_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeOrderSettleErrorResponseModel' alipay_trade_order_settle_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeOrderSettleQueryErrorResponseModel' alipay_trade_orderinfo_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeOrderinfoSyncErrorResponseModel' alipay_trade_overseas_settle_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeOverseasSettleErrorResponseModel' alipay_trade_pay_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradePayErrorResponseModel' alipay_trade_precreate_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradePrecreateErrorResponseModel' alipay_trade_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeQueryErrorResponseModel' alipay_trade_refund_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeRefundErrorResponseModel' alipay_trade_refund_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeRefundApplyErrorResponseModel' alipay_trade_royalty_rate_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeRoyaltyRateQueryErrorResponseModel' alipay_trade_royalty_relation_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeRoyaltyRelationBatchqueryErrorResponseModel' alipay_trade_royalty_relation_bind_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeRoyaltyRelationBindErrorResponseModel' alipay_trade_royalty_relation_unbind_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeRoyaltyRelationUnbindErrorResponseModel' alipay_trade_settle_confirm_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeSettleConfirmErrorResponseModel' alipay_trade_settle_receivables_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayTradeSettleReceivablesQueryErrorResponseModel' alipay_user_agreement_executionplan_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayUserAgreementExecutionplanModifyErrorResponseModel' alipay_user_agreement_migrate_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayUserAgreementMigrateErrorResponseModel' alipay_user_agreement_permission_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayUserAgreementPermissionCreateErrorResponseModel' alipay_user_agreement_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayUserAgreementQueryErrorResponseModel' alipay_user_agreement_transfer_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayUserAgreementTransferErrorResponseModel' alipay_user_agreement_unsign_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayUserAgreementUnsignErrorResponseModel' alipay_user_agreement_userverify_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayUserAgreementUserverifyApplyErrorResponseModel' alipay_user_agreement_userverify_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayUserAgreementUserverifyQueryErrorResponseModel' alipay_user_alipaypoint_budgetlib_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayUserAlipaypointBudgetlibQueryErrorResponseModel' alipay_user_alipaypoint_send_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayUserAlipaypointSendErrorResponseModel' alipay_user_certdoc_certverify_consult_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayUserCertdocCertverifyConsultErrorResponseModel' alipay_user_certdoc_certverify_preconsult_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayUserCertdocCertverifyPreconsultErrorResponseModel' alipay_user_certify_open_initialize_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayUserCertifyOpenInitializeErrorResponseModel' alipay_user_certify_open_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayUserCertifyOpenQueryErrorResponseModel' alipay_user_info_share_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayUserInfoShareErrorResponseModel' alipay_user_twostage_common_use_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayUserTwostageCommonUseErrorResponseModel' alipay_user_twostage_indirect_use_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayUserTwostageIndirectUseErrorResponseModel' alipay_user_userinfo_share_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AlipayUserUserinfoShareErrorResponseModel' ant_merchant_expand_apprecommend_account_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandApprecommendAccountCreateErrorResponseModel' ant_merchant_expand_apprecommend_account_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandApprecommendAccountDeleteErrorResponseModel' ant_merchant_expand_apprecommend_account_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandApprecommendAccountQueryErrorResponseModel' ant_merchant_expand_apprecommend_available_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandApprecommendAvailableQueryErrorResponseModel' ant_merchant_expand_info_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandInfoQueryErrorResponseModel' ant_merchant_expand_item_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandItemCreateErrorResponseModel' ant_merchant_expand_item_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandItemDeleteErrorResponseModel' ant_merchant_expand_item_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandItemModifyErrorResponseModel' ant_merchant_expand_item_open_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandItemOpenBatchqueryErrorResponseModel' ant_merchant_expand_item_open_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandItemOpenCreateErrorResponseModel' ant_merchant_expand_item_open_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandItemOpenDeleteErrorResponseModel' ant_merchant_expand_item_open_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandItemOpenModifyErrorResponseModel' ant_merchant_expand_item_open_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandItemOpenQueryErrorResponseModel' ant_merchant_expand_item_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandItemQueryErrorResponseModel' ant_merchant_expand_item_status_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandItemStatusModifyErrorResponseModel' ant_merchant_expand_shop_consult_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandShopConsultErrorResponseModel' ant_merchant_expand_shop_receiptaccount_save_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandShopReceiptaccountSaveErrorResponseModel' ant_merchant_expand_indirect_image_upload_request: properties: data: $ref: '#/components/schemas/AntMerchantExpandIndirectImageUploadModel' image_content: format: binary type: string type: object ant_merchant_expand_indirect_image_upload_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandIndirectImageUploadErrorResponseModel' ant_merchant_expand_mcc_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandMccQueryErrorResponseModel' ant_merchant_expand_order_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandOrderQueryErrorResponseModel' ant_merchant_expand_shop_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandShopQueryErrorResponseModel' ant_merchant_expand_shop_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandShopCreateErrorResponseModel' ant_merchant_expand_shop_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandShopModifyErrorResponseModel' ant_merchant_expand_shop_close_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandShopCloseErrorResponseModel' ant_merchant_expand_shop_page_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AntMerchantExpandShopPageQueryErrorResponseModel' anttech_oceanbase_testplatform_task_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/AnttechOceanbaseTestplatformTaskQueryErrorResponseModel' datadigital_fincloud_generalsaas_face_certify_initialize_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasFaceCertifyInitializeErrorResponseModel' datadigital_fincloud_generalsaas_face_certify_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasFaceCertifyQueryErrorResponseModel' datadigital_fincloud_generalsaas_face_certify_verify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasFaceCertifyVerifyErrorResponseModel' datadigital_fincloud_generalsaas_face_check_initialize_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasFaceCheckInitializeErrorResponseModel' datadigital_fincloud_generalsaas_face_check_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasFaceCheckQueryErrorResponseModel' datadigital_fincloud_generalsaas_face_source_certify_request: properties: data: $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasFaceSourceCertifyModel' file_content: format: binary type: string type: object datadigital_fincloud_generalsaas_face_source_certify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasFaceSourceCertifyErrorResponseModel' datadigital_fincloud_generalsaas_face_verification_initialize_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasFaceVerificationInitializeErrorResponseModel' datadigital_fincloud_generalsaas_face_verification_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasFaceVerificationQueryErrorResponseModel' datadigital_fincloud_generalsaas_ocr_mobile_initialize_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasOcrMobileInitializeErrorResponseModel' datadigital_fincloud_generalsaas_ocr_server_detect_request: properties: data: $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasOcrServerDetectModel' file_content: format: binary type: string type: object datadigital_fincloud_generalsaas_ocr_server_detect_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/DatadigitalFincloudGeneralsaasOcrServerDetectErrorResponseModel' koubei_marketing_campaign_intelligent_promo_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/KoubeiMarketingCampaignIntelligentPromoBatchqueryErrorResponseModel' koubei_marketing_campaign_intelligent_shop_consult_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/KoubeiMarketingCampaignIntelligentShopConsultErrorResponseModel' koubei_marketing_campaign_intelligent_template_consult_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/KoubeiMarketingCampaignIntelligentTemplateConsultErrorResponseModel' koubei_marketing_campaign_item_merchantactivity_batchquery_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityBatchqueryErrorResponseModel' koubei_marketing_campaign_item_merchantactivity_close_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityCloseErrorResponseModel' koubei_marketing_campaign_item_merchantactivity_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityCreateErrorResponseModel' koubei_marketing_campaign_item_merchantactivity_modify_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityModifyErrorResponseModel' koubei_marketing_campaign_item_merchantactivity_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/KoubeiMarketingCampaignItemMerchantactivityQueryErrorResponseModel' koubei_trade_order_consult_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/KoubeiTradeOrderConsultErrorResponseModel' monitor_heartbeat_syn_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/MonitorHeartbeatSynErrorResponseModel' zhima_credit_payafteruse_creditagreement_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaCreditPayafteruseCreditagreementQueryErrorResponseModel' zhima_credit_payafteruse_creditagreement_transfer_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaCreditPayafteruseCreditagreementTransferErrorResponseModel' zhima_credit_payafteruse_creditbizorder_finish_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaCreditPayafteruseCreditbizorderFinishErrorResponseModel' zhima_credit_payafteruse_creditbizorder_order_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaCreditPayafteruseCreditbizorderOrderErrorResponseModel' zhima_credit_payafteruse_creditbizorder_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaCreditPayafteruseCreditbizorderQueryErrorResponseModel' zhima_credit_pe_zmgo_agreement_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaCreditPeZmgoAgreementQueryErrorResponseModel' zhima_credit_pe_zmgo_agreement_unsign_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaCreditPeZmgoAgreementUnsignErrorResponseModel' zhima_credit_pe_zmgo_bizopt_close_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaCreditPeZmgoBizoptCloseErrorResponseModel' zhima_credit_pe_zmgo_cumulation_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaCreditPeZmgoCumulationSyncErrorResponseModel' zhima_credit_pe_zmgo_preorder_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaCreditPeZmgoPreorderCreateErrorResponseModel' zhima_credit_pe_zmgo_settle_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaCreditPeZmgoSettleApplyErrorResponseModel' zhima_credit_pe_zmgo_settle_refund_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaCreditPeZmgoSettleRefundErrorResponseModel' zhima_credit_pe_zmgo_settle_unfreeze_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaCreditPeZmgoSettleUnfreezeErrorResponseModel' zhima_customer_jobworth_authentication_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaCustomerJobworthAuthenticationQueryErrorResponseModel' zhima_customer_jobworth_cloudresume_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaCustomerJobworthCloudresumeQueryErrorResponseModel' zhima_customer_jobworth_info_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaCustomerJobworthInfoQueryErrorResponseModel' zhima_customer_jobworth_jobdata_add_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaCustomerJobworthJobdataAddErrorResponseModel' zhima_customer_jobworth_picture_upload_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaCustomerJobworthPictureUploadErrorResponseModel' zhima_customer_jobworth_position_add_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaCustomerJobworthPositionAddErrorResponseModel' zhima_merchant_subsidiaries_apply_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaMerchantSubsidiariesApplyErrorResponseModel' zhima_merchant_subsidiaries_close_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaMerchantSubsidiariesCloseErrorResponseModel' zhima_merchant_zmgo_cumulate_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaMerchantZmgoCumulateQueryErrorResponseModel' zhima_merchant_zmgo_cumulate_sync_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaMerchantZmgoCumulateSyncErrorResponseModel' zhima_merchant_zmgo_template_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaMerchantZmgoTemplateCreateErrorResponseModel' zhima_merchant_zmgo_template_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZhimaMerchantZmgoTemplateQueryErrorResponseModel' zoloz_authentication_customer_facemanage_create_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZolozAuthenticationCustomerFacemanageCreateErrorResponseModel' zoloz_authentication_customer_facemanage_delete_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZolozAuthenticationCustomerFacemanageDeleteErrorResponseModel' zoloz_authentication_customer_ftoken_query_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZolozAuthenticationCustomerFtokenQueryErrorResponseModel' zoloz_authentication_customer_smilepay_initialize_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZolozAuthenticationCustomerSmilepayInitializeErrorResponseModel' zoloz_authentication_smilepay_initialize_default_response: anyOf: - $ref: '#/components/schemas/CommonErrorType' - $ref: '#/components/schemas/ZolozAuthenticationSmilepayInitializeErrorResponseModel'