卡券实例更新接口

开发环境

http://dev-cn.your-api-server.com

POST

/v3/alipay/pass/instance/update

对于已发放的卡券实例，可通过此接口更新信息，通常用于更新使用状态。

错误码

公共错误码

前往查看

业务错误码

状态码	错误码	错误描述	解决方案
400	KP.AE_SYSTEM_ERROR	系统繁忙或系统异常	尝试重试，必要时请至支持中心（https://support.open.alipay.com/alipay/support/index.htm）提问，或点击右上角帮助支持→在线咨询，联系我们的技术客服来解决
400	KP.AE_ALIPASS_PARAMS_FORMAT_ERROR	参数格式错误，一般是预期json格式的参数不符合JSON规范	检查参数格式是否符合JSON语法规范
400	KP.AE_ALIPASS_NOTEXIST	卡券不存在	核查serial_number和channel_id传参是否符合预期，必要时请至支持中心（https://support.open.alipay.com/alipay/support/index.htm）提问，或点击右上角帮助支持→在线咨询，联系我们的技术客服来解决
400	KP.AE_ALIPASS_UPDATE_ERROR	更新卡券失败	确认参数是否符合文档预期，尝试重试
400	KP.AE_ALIPASS_PARAME_IS_NULL	参数值为null	根据返回值result的errorMsg检查发券参数tpl_params是否缺失动态参数对应的值
400	KP.AE_ALIPASS_PARAMS_VALUE_INVAILD	无效的参数传值	确认参数格式符合预期，确认传参biz_content符合json规范
400	KP.AE_ALIPASS_CHAR_NOT_GBK	卡券传值中有非GBK的字符	确认传参字符为GBK编码

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/v3/alipay/pass/instance/update' \
--header 'authorization: ALIPAY-SHA256withRSA app_id=$appid,timestamp=$now,nonce=$uuid,expired_seconds=600,sign=$sign' \
--header 'alipay-request-id: $requestid' \
--header 'Content-Type: application/json' \
--data-raw '{
	"user_id":"2088012345678910",
	"serial_number":"209919213",
	"channel_id":"2088918273",
	"tpl_params":"{\"title\":\"券标题\",\"channelID\":\"xxx\",\"serialNumer\":\"xxxx\"}",
	"status":"USED",
	"verify_code":"8612231273",
	"verify_type":"wave"
}'

响应示例

{
  "success": "TRUE",
  "result": "{\"serialNumber\":\"123555123\",\"passId\":\"209919213\",\"operate\":\"UPDATE\",\"errorCode\":\"SUCCESS\",\"errorMsg\":\"处理成功\"}"
}

请求参数

Header 参数

authorization

string

必需

示例值:

ALIPAY-SHA256withRSA app_id=$appid,timestamp=$now,nonce=$uuid,expired_seconds=600,sign=$sign

alipay-request-id

string

必需

示例值:

$requestid

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

user_id

string

可选

支付宝用户ID，新接入商户必填，历史已接入商户请尽快补传

serial_number

string

必需

商户指定卡券唯一值，卡券JSON模板中fileInfo->serialNumber字段对应的值

channel_id

string

必需

代理商代替商户发放卡券后，再代替商户更新卡券时，此值为商户的pid/appid

tpl_params

string

可选

模版动态参数信息：对应模板中

变量名

的动态参数，见模板创建接口返回值中的tpl_params字段

status

string

可选

券状态，支持更新为USED、CLOSED两种状态

verify_code

string

可选

历史遗留，已废弃。当状态变更为USED时，建议传，该值正常为模板中核销区域（Operation）对应的message值。

verify_type

string

可选

历史遗留，已废弃。核销方式，该值正常为模板中核销区域（Operation）对应的format值。verify_code和verify_type需同时传入。

示例

返回响应

🟢200成功

application/json

Body

success

string

必需

操作成功标识【true：成功；false：失败】

result

string

必需

接口调用返回结果信息

卡券实例发放接口

上传门店照片和视频接口

卡券实例更新接口

错误码#

公共错误码#

业务错误码#

请求参数

返回响应

错误码

公共错误码

业务错误码