此列表包含该产品所涉及的所有接口,点击“查看文档”可查看接口的公共请求参数,业务请求参数,返回参数,其他语言请求示例以及错误码等。
接口英文名 | 接口中文名 | API文档 |
---|---|---|
alipay.offline.market.shop.create |
创建门店信息 |
|
alipay.offline.market.shop.category.query |
门店类目配置查询接口 |
查看文档 |
alipay.offline.market.shop.modify |
修改门店信息 |
|
alipay.offline.market.shop.querydetail |
查询单个门店信息接口 |
|
alipay.offline.market.shop.batchquery |
查询商户的门店编号列表 |
|
alipay.offline.market.shop.summary.batchquery |
门店摘要信息批量查询接口 |
|
alipay.offline.market.applyorder.batchquery |
业务流水批量查询接口 |
|
alipay.offline.material.image.upload |
上传门店照片接口 |
REQUEST URL: http://example.com/gateway.do REQUEST METHOD: POST CONTENT: sign=VMFwVp4Gy1YjTLmhGYvl71kQ/lnf+cYUjBpFwiKEJkTqN2ObYm7vpw8dYQkj2sSakM8KK+8LwdXlz7BT78faQPijbsDtESSJ+0cd/Lx/Dg1DEvokbFeT4XiAtqu5mqm7FAE3N2aMCMh+5LFyh+5phOzYhDkt4bv1eBRyJVOYuKE= request_id=20150101 biz_type=CREATE_SHOP_AUDIT notify_id=7d1091d622ee408a10032e12768829agxc notify_time=2015-10-29 10:51:57 notify_type=shop_audit_result apply_id=2015052100077000000000120773 is_online=T is_show=T shop_id=2015101500077000000004682500 sign_type=RSA audit_status=AUDIT_SUCCESS version=2.0
注: 所有请求参数需经过编码处理,本示例给出的是未经编码处理时的请求参数
参数 | 参数名称 | 类型 | 必填 | 描述 | 范例 |
---|---|---|---|---|---|
request_id | 外部请求ID | String(64) | 是 | 外部请求ID,可以根据该字段明确本次notify是对应于哪次接口调用的回应 | 2015123235324534 |
biz_type | 事件类型 | String(64) | 是 | 如果是创建门店时的事件,biz_type=CREATE_SHOP_AUDIT; 如果是修改门店时的事件,biz_type=MODIFY_SHOP_AUDIT |
CREATE_SHOP_AUDIT |
notify_id | 本条消息的ID | String(64) | 是 | 通知ID。开发者通过这个ID进行幂等处理 | 32b109f32c3e6910950627bf9d8ec0fc |
notify_time | 通知发送时间 | String(16) | 是 | 通知发送时间 | 2015-10-29 10:51:57 |
notify_type | 通知类型 | String(64) | 是 | 通知类型:shop_audit_result(审核结果通知) | shop_audit_result |
apply_id | 支付宝申请流水ID | String(64) | 是 | 支付宝申请流水ID,后续的增删改查接口都使用该ID作为主键 | 2015052100077000000000120773 |
audit_status | 门店审核状态 | String(32) | 是 | 门店审核状态,对于开发者而言,只有三个状态。 AUDITING:审核中 AUDIT_FAILED:审核驳回 AUDIT_SUCCESS:审核通过 第一次审核通过会触发门店上架 |
AUDIT_SUCCESS |
is_online | 门店是否上架 | String(2) | 是 | T表示上架,F表示未上架,第一次门店审核通过后会触发上架 | T |
is_show | 门店是否在客户端显示 | String(2) | 是 | T表示显示,F表示隐藏 | T |
version | 接口版本 | String(10) | 是 | 接口版本,默认为1.0版本。升级为2.0版本时,需要与支付宝联调,通知、开店流程与1.0版本差别较大。 | 2.0 |
sign_type | 签名方式 | String(10) | 否 | 签名算法类型,目前支持RSA | RSA |
sign | 签名 | String(256) | 是 | 签名 | 601510b7970e52cc63db0f44997cf70e |
shop_id | 支付宝门店ID | String(64) | 否 | 支付宝门店ID,审核通过后有此字段,不通过,此字段为空 | 2016030200077000000002808543 |
result_code | 结果码 | String(64) | 否 | 结果码,申请流水失败,或者审核时,部分信息被风控调整时,会返回此字段。 | RISK_AUDIT_FAIL |
result_desc | 流水申请结果描述 | String(64) | 否 | 流水申请结果描述,申请流水处理失败,或者审核时,部分信息被风控调整时,会返回此字段。具体见下表。 | 证照信息有误,修改驳回 |
is_judge_recover | 是否判单恢复通知 | String(10) | 否 | ISV帮商户开店或者修改门店,被支付宝认为是疑似跟线上重复门店,同步返回失败(SHOP_CREATE_SHOP_JUDGE_FAIL、SHOP_MODIFY_SHOP_JUDGE_FAIL)。商户或ISV申诉,支付宝小二会将原流水恢复并重新发起审核流程,恢复的同时支付宝系统会发通知告知ISV(通过申请开店或者修改门店的URL地址),此字段只有在此情况下才会返回给ISV(值为T),其他情况不会返回此字段。ISV根据通知中的request_id可以关联到原开店流水,并记录下通知中的apply_id,后面可以通过apply_id调用支付宝申请流水查询接口,跟进开店或者修改门店流失的审核状态。 | T |
返回值 | 描述 |
---|---|
LICENSE_PRINCIPAL_NOT_MATCH | 营业执照与门店主体不一致 |
RISK_AUDIT_FAIL | 风控审核未通过 |
SHOP_INVALID_STATUS | 店铺状态非法 |
SHOP_JUDGE_FAIL | 门店判重不通过 |
SHOP_LICENSE_AUDIT_FAIL | 当前证照已开店,无法重复开店 |
SIGN_FAIL | 签约失败 |
SYSTEM_CANCEL | 系统撤销 |
UNIQUE_CONSTRAINT_IMPLEMENTID_ERROR | 机具号已存在 |
UNIQUE_CONSTRAINT_OUTSHOPID_ERROR | 门店编号已存在 |
UNIQUE_CONSTRAINT_SHOP_ERROR | 门店已存在 |
注意1: 对于修改后立即生效的消息,不会推送审核成功事件,请以修改后同步返回参数中的audit_status为准
注意2: 开发者接收到消息后,必须返回一条success消息,以表示成功接收到该条notify,否则支付宝将多次重试推送该消息到开发者网关
PHP代码示例: echo "success";
使用场景举例:当 触发主体(支付宝、服务商、商家、支付宝处罚中心) 修改了开发者创建的门店的信息时,支付宝会以post异步响应方式向开发者应用网关(应用网关为创建应用时,应用环境中配置的网关)发送通知(如未配置则不会通知)。开发者在接收到异步通知后,需要对收到的内容进行验签,验证是否是支付宝发送的,验签示例点此了解。
参数 | 类型 | 长度 | 是否必填 | 描述 | 范例 |
---|---|---|---|---|---|
partner_id | String | 16 | 是 | 店铺所属商户的PID | 2088001969784501 |
notify_pid | String | 16 | 是 | 店铺所属系统集成商的PID | 2088001969784502 |
notify_time | Date | 是 | 通知发送时间 | 2015-10-29 10:51:57 | |
shop_id | String | 64 | 是 | 支付宝门店ID | 2016030200077000000002808543 |
status | String | 10 | 是 | 门店状态: PAUSED(暂停) OPEN(开店) CLOSED(关店) FREEZE(冻结) |
OPEN |
sign_type | String | 10 | 是 | 签名算法类型,目前支持RSA | RSA |
sign | String | 256 | 是 | 签名 | 601510b7970e52cc63db0f44997cf70e |
display_status | String | 2 | 是 | 门店在支付宝钱包展示状态,T:展示,F:不展示 | T |
notify_type | String | 64 | 是 | 通知类型:shop_update(门店变更通知) | shop_update |
update_time | String | 32 | 是 | 店铺变动时间 | 2016-05-06 15:28:15 |
create_time | String | 32 | 否 | 店铺创建时间 | 2016-05-06 15:19:11 |
action | String | 50 | 是 | ON_LINE_SHOP:上架店铺 OFF_LINE_SHOP:下架店铺 MODIFY_SHOP:修改店铺 FREEZE_SHOP:冻结店铺 UNFREEZE_SHOP:解冻店铺 HIDE_SHOP:隐藏店铺 SHOW_SHOP:展示店铺 |
MODIFY_SHOP |
notify_id | String | 128 | 否 | 通知ID | ac05099524730693a8b330c5ecf72da9786 |