# 合作方福利订单回传接口

# 简介

# 业务介绍

合作方福利订单回传接口

# 接口定义

# 应用场景

由爱奇艺提供本接口供合作方调用，合作方福利订单回传

# 接口域名

环境	域名
生产	openapi.vip.iqiyi.com
测试	test-openapi.vip.iqiyi.com

# URL

/rights-proxy-api/benifit/callback/benifitOrder

# 请求方式

参数	说明
Method	POST
Content-Type	application/json

序号	变量名	名称	是否必须	类型	说明
1	customer	商户标识	是	String	合作方标识（爱奇艺侧分配）

# 请求参数

参数			名称	类型	是否必须	说明
biz			业务标识	String	是	爱奇艺侧按业务分配（福利）
uid			爱奇艺UID	String	否
orderCode			爱奇艺流水号	String	否	爱奇艺侧跳转/直充/发券时提供的爱奇艺侧业务流水号/订单号(最大长度64位)
orderInfo			订单信息	JsonString，json格式的字符串	否	核销时产生的订单信息
	partner		商家名称	String	否	商家名称和店铺名称至少传入一个，生成订单的商家名称//服务商名称
	shop		店铺名称	String	否	商家名称和店铺名称至少传入一个
	shopUrl		店铺连接	String	否	查看店铺详情
	orderNo		订单编号	String	是	该笔订单的订单号
	fee		支付金额	Integer	是	该笔订单的总支付金额(分)
	payTime		支付时间	Long	否	该笔订单支付的时间戳(毫秒)
	status		订单状态	Integer	是	0-待支付、1-待发货、2-已发货、3-派送中、4-已完成、5-退款中、6-已退款、7-已取消
	url		订单详情链接	String	是	查看订单详情的URL
	items		商品列表	jsonArray, jsonArray格式的字符串
		name	商品名称	String	是	商品的全称
		img	商品图片	String	是	商品的图片：尺寸规范由设计提供
		fee	商品金额	Integer	是	商品的原价
		spec	商品规格	String	是	商品的规格，如颜色、尺码、型号
		amount	购买数量	Integer	是	单个商品购买数量
sign			接口签名	String	是	调用签名，签名秘钥由合作方提供，签名算法参见：https://developer.vip.iqiyi.com/custom/TOB/subscribeTob.html#MD5

# 返回参数

字段名	类型	说明
code	String	返回码
msg	String	返回信息

# 请求示例

{"orderCode":"b26ign8c-6mu9-kr6tfe","orderInfo":"{"fee":1,"items":"[{\"name\":\"商品名称\",\"img\":\"https://cdn.pixabay.com/photo/2020/03/31/19/20/dog-4988985__480.jpg\",\"fee\":1,\"spec\":\"规格\",\"amount\":1}]","orderNo":"12345","partner":"test","payTime":1662099112,"status":1,"url":"baidu.com"}","item":"1_220811191844001479u0001","biz":"benifit","customer":"benefit_test","sign":"72f54834474171aaf5818263c66d6392"}

# MD5签名格式化参数示例

biz=benifit&orderCode=b26ign8c-6mu9-kr6tfe&orderInfo={"fee":1,"items":"[{"name":"商品名称","img":"https://cdn.pixabay.com/photo/2020/03/31/19/20/dog-4988985__480.jpg","fee":1,"spec":"规格","amount":1}]","orderNo":"12345","partner":"test","payTime":1662099112,"status":1,"url":"baidu.com"}e85854766ad326f9

# 测试环境及参数

参数	值	备注
customer	benefit_test
biz	benefit

# FAQ

Q1.提示签名错误

1.联系爱奇艺对接人，确认配置的customer、秘钥是否和传入的一致
2.检查参数签名规则是否符合文档约束
3.若以上检查无问题，则提供下完整请求参数、签名前明文串

点击此处进行接口调试

← 合作方福利核销接口合作方创建FV接口 →