通用礼品卡接口文档（KFC、必胜客、GAP等）

通用礼品卡接口文档，集于各商家（KFC、必胜客、GAP等）实体卡和会员卡的API虚拟卡，可用于线上/下消费、移动支付。

1.API

1.1商品列表

接口地址：http://v.juhe.cn/giftCard/products

支持格式：json/xml

请求方式：http get/post

请求示例：http://v.juhe.cn/giftCard/products

接口备注：查询可购买的礼品卡的列表，及每个礼品卡对应的productId。如需了解各礼品卡的使用，请点击 我

调用样例及调试工具：API测试工具

请求参数说明：

	名称	类型	必填	说明
	​dtype	string	否	返回的格式，json或xml，默认json
	key	string	是	您申请到的APPKEY

返回参数说明：

	名称	类型	说明
	​error_code	int	返回码
	reason	string	返回说明
	result	string	返回结果集

JSON返回示例：

/* 示例内容有所省略，请以您取到的最新数据为准 */
/* 商品ID基本不会变，请做好长期的缓存 */
/* 如果您的需求量较大，请告诉我们您需要的卡种以便我们备货 */
/* 如需各卡的使用说明，请访问 http://code.juhe.cn/docs/1944 */

{
  "reason": "查询成功",
  "result": [
    {
      "productId": "100026", /* 商品ID基本不会变，请做好长期的缓存 */
      "name": "携程任我行100元", /* 商品名 */
      "value": "100.00", /* 商品面值 */
      "discount": "0.998" /* 默认折扣，如您需求量较大，可议 */
    },
    {
      "productId": "100027",
      "name": "携程任我行500元",
      "value": "500.00",
      "discount": "0.998"
    },
   {
      "productId": "310001",
      "name": "阳澄湖牌出口有机大闸蟹298型", /* 优惠价格，企业采购，请咨询客服*/
      "value": "298.00",
      "discount": "0.900"
    },
    此处有省略
  ],
  "error_code": 0
}

1.2发货

接口地址：http://v.juhe.cn/giftCard/delivery

支持格式：json/xml

请求方式：http get/post

请求示例：http://v.juhe.cn/giftCard/delivery?key=您申请到的APPKEY

接口备注：发货，会先尝试从您的聚合余额里扣款，请保证余额充足（不可透支）；卡密一经售出，非卡密本身质量原因，概不退换

调用样例及调试工具：API测试工具

请求参数说明：

	名称	类型	必填	说明
	​dtype	string	否	返回的格式，json或xml，默认json
	key	string	是	您申请到的APPKEY
	num	int	是	购买数量，1-10
	productId	string	是	商品ID，从商品列表查询
	userOrderId	string	是	您的订单号，50个字符内，允许数字、字母、下划线，请保证单号唯一

返回参数说明：

	名称	类型	说明
	​error_code	int	返回码
	reason	string	返回说明
	result	string	返回结果集

JSON返回示例：

/*请注意，发货时可能会返回“此商品暂无库存”，请联系我们客服并告知您需要的卡种类、数量，以便我们备货*/

{
  "reason": "成功的返回",
  "result": {
    "juheOrderId": "JUHE14575079213274NN", /*聚合订单号*/
    "userOrderId": "MYORDER123456", /*您的订单号*/
    "num": 1, /*本次发货数量*/
    "cards": [ /*卡信息*/
      {
        "cardNo": "DCDCDCJUHEDCDC", /*DES加密后的卡号，解密方法见：http://code.juhe.cn/docs/1943、
http://code.juhe.cn/docs/1945*/
        "cardPws": "YOYOYOYOCKN", /*DES加密后的卡密，解密方法见：http://code.juhe.cn/docs/1943、
http://code.juhe.cn/docs/1945*/
        "expireDate": "20251231" /*失效时间*/
      }
    ]
  },
  "error_code": 0
}

1.3订单详情

接口地址：http://v.juhe.cn/giftCard/order

支持格式：json/xml

请求方式：http get/post

请求示例：http://v.juhe.cn/giftCard/order?key=您的APPKEY&juheOrderId=123233123312

接口备注：根据聚合订单号查询订单详情

调用样例及调试工具：API测试工具

请求参数说明：

	名称	类型	必填	说明
	dtype	string	否	返回的格式，json或xml，默认json
	key	string	是	您申请到的APPKEY
	juheOrderId	string	是	聚合订单号

返回参数说明：

	名称	类型	说明
	error_code	int	返回码
	reason	string	返回说明
	result	string	返回结果集

JSON返回示例：

{
  "reason": "查询成功",
  "result": {
    "juheOrderId": "JHDN201603120014351360130234",
    "productId": "100022",
    "submitTime": "2016-03-12 00:15:34",
    "message": "发货成功",
    "cards": [
      {
        "cardNo": "tV47z0fgrFuyAu1an1vi95ciamcrypted",
        "cardPws": "udOpZ+ESspfRWjaEAjidliamcrypted",
        "expireDate": "20181119"
      }
    ]
  },
  "error_code": 0
}

1.4历史订单查询

接口地址：http://v.juhe.cn/giftCard/orders

支持格式：json/xml

请求方式：http get/post

请求示例：http://v.juhe.cn/giftCard/orders?key=您的APPKEY&begin=2016-02-09&end=2016-03-09

接口备注：查某段时间内的订单信息

调用样例及调试工具：API测试工具

请求参数说明：

	名称	类型	必填	说明
	​dtype	string	否	返回的格式，json或xml，默认json
	key	string	是	您申请到的APPKEY
	begin	string	是	开始的日期，如：2016-02-09（默认为2016-02-09 00:00:00）
	end	string	是	结束的日期，如：2016-03-09（默认为2016-03-09 00:00:00）

返回参数说明：

	名称	类型	说明
	​error_code	int	返回码
	reason	string	返回说明
	result	string	返回结果集

JSON返回示例：

{
  "reason": "查询成功",
  "result": [
    {
      "juheOrderId": "JHDN201603141423227380180045",
      "productId": "100058",
      "submitTime": "2016-03-14 14:23:22",
      "message": "抱歉：此商品暂无库存"
    },
    {
      "juheOrderId": "JHDN201603141550086498910071",
      "productId": "100022",
      "submitTime": "2016-03-14 15:51:17",
      "message": "发货成功"
    }
  ],
  "error_code": 0
}

1.5账户变动记录

接口地址：v.juhe.cn/giftCard/account.php

支持格式：json/xml

请求方式：get/post

请求示例：v.juhe.cn/giftCard/account.php?key=key&begin=2016-02-09&end=2016-08-01

接口备注：查询因本业务而引起的余额变动记录

调用样例及调试工具：API测试工具

请求参数说明：

	名称	类型	必填	说明
	dtype	string	否	返回的格式，json或xml，默认json
	key	string	是	您申请到的APPKEY
	begin	string	是	开始日期，如：2016-01-01
	end	string	是	结束日期，如：2016-07-01

返回参数说明：

	名称	类型	说明
	error_code	int	返回码
	reason	string	返回说明
	result	string	返回结果集

JSON返回示例：

{
  "reason": "查询成功",
  "result": [
    {
      "juheOrderId": "JHDN2016033434341122540472",
      "price": "1000.00",
      "time": "2016-03-11 22:54:04",
      "type": "0" /*0表示扣款，1表示加款*/
    },
    {
      "juheOrderId": "JHDN201342343258",
      "price": "999.00",
      "time": "2016-03-11 22:55:32",
      "type": "0"
    },
    有省略
  ],
  "error_code": 0
}

2.礼品卡使用说明

肯德基/必胜客百胜心意美食卡

1、本卡为电子礼品卡，可在百胜旗下各品牌（肯德基、必胜客、必胜客宅急送、东方既白、小肥羊）已安装百胜卡扫描机的餐厅使用。 具体可使用门店可查询：http://card.yum.com.cn。

2、电子卡必须绑定百胜账号之后才能使用，方法如下： 关注微信公众号“百胜心意美食卡”后，进入“我的账户”->打开“ ”->输入手机上的电子卡卡号及密码进行注册和绑定操作。 将电子卡和百胜账号绑定之后，可以点击微信公众号里的“付款码”->刷新之后将显示的条形码在收银机扫描设备上扫描完成付款。

3、本电子卡有效期为3年。

4、本电子卡不记名、不挂失、不兑现，请妥善保管卡密，卡密一经售出，非卡密本身质量问题，概不退换。

5、本电子卡消费视同现金，可与店内其他优惠一起使用。

6、电子卡可转赠他人，操作方法如下：

登入手机微信公众号“百胜心意美食卡”->“我的账户”->“赠送亲友”->选择赠送金额->填写“接收人信息”->提交订单即可。

京东礼品卡

1、京东E卡有效期为36个月，京东E卡不记名、不挂失、不计息、不兑现、不可修改密码，请妥善保管卡号及密码。

2、京东E卡仅能购买京东自营商品（“自营商品”指在商品详情页明确标识为“商品从京东库房出库，由京东安排配送，且商品发票由京东提供”的商品，出版物和第三方卖家商品不在此内。）

3、发生退货时，京东E卡支付部分自动退回卡内。

4、卡密一经售出，非卡密本身质量问题，概不退换。

1号店礼品卡

1 、购买1号店礼品卡需同意并遵守《1号店礼品卡章程》及《1号店礼品卡购卡协议》。

2、礼品卡可购买1号店网站www.yhd.com由纽海信息技术（上海）有限公司销售即1号店自营的商品（入驻商家，1号团，虚拟商品等除外）。

3、礼品卡不记名、不挂失、不兑换现金。购物金额不足部分以现金补足。

4、礼品卡支付部分不开具发票，购买3c类商品开具0元发票。

5、用礼品卡支付购买实物商品发生退货时，礼品卡支付部分退回卡内，不予兑现。

6、礼品卡自生效之日起不少于三年内有效。

7、卡密一经售出，非卡密本身质量问题，概不退换。

当当网礼品卡

1、礼品卡有效期自卡生效之日起三年内有效，请务必在有效期内使用，过期卡将失效；

2、成功激活后，仅能在绑定账户使用，暂不支持跨账户使用；

3、礼品卡不支持购买国美商品、礼品卡、彩票、话费充值及生活服务类团购商品；

4、礼品卡不能与礼券同时使用；

5、礼品卡可合并使用，支付金额不足部分可用其他支付方式支付不足；

6、礼品卡支付的部分不开具发票；

7、订单退货、缺货，礼品卡支付金额将退回卡内；

8、礼品卡不记名、不挂失、不兑现现金、不退卡；

9、使用礼品卡购买某些品类商品时会加收部分手续费，请以届时当当网相关规定和结算页面为准；

10、当当网保留不时修改礼品卡使用规则、条款和使用条件的权利，所有规则、条款和条件将在法律允许的最大限度内适用；

11、卡密一经售出，非卡密本身质量问题，概不退换。

携程任我游礼品卡

1、携程发行的礼品卡内预付价值一元等值于一元人民币。

2、携程礼品卡（任我游）可预订预付费类酒店、惠选酒店、旅游度假产品、团购产品（注：自由机+酒产品、门票类产品、代驾租车产品及银行专享类旅游度假产品等暂不支持礼品卡支付）。

3、 已领用至携程会员账户内的携程礼品卡可以分次消费，单个携程会员账户内的携程礼品卡金额在有效期内不限额、不限人次、不限次数使用。

4、 在预订一项产品时，多张携程礼品卡可领用到同一个携程会员账户内合并金额使用，不同携程会员账户的金额不能合并使用。

5、 携程礼品卡一经售出，使用范围不可改变，不合并、不挂失、不能兑换现金。

6、 用于销售的携程礼品卡自生效之日起不少于三年内有效。携程礼品卡应该在有效期内使用。

7、卡密一经售出，非卡密本身质量问题，概不退换。

携程任我行礼品卡

1、携程发行的礼品卡内预付价值一元等值于一元人民币。

2、携程礼品卡（任我行）可预订预付费类酒店、惠选酒店、机票、旅游度假产品、火车票产品、团购产品（注：自由机+酒产品、部分门票类产品、代驾租车产品及银行专享类旅游度假产品等暂不支持礼品卡支付）。

3、已领用至携程会员账户内的携程礼品卡可以分次消费，单个携程会员账户内的携程礼品卡金额在有效期内不限额、不限人次、不限次数使用。

4、 在预订一项产品时，多张携程礼品卡可领用到同一个携程会员账户内合并金额使用，不同携程会员账户的金额不能合并使用。

5、 携程礼品卡一经售出，使用范围不可改变，不合并、不挂失、不能兑换现金。

6、 用于销售的携程礼品卡自生效之日起不少于三年内有效。携程礼品卡应该在有效期内使用。

7、卡密一经售出，非卡密本身质量问题，概不退换。

苏宁礼品卡

1. 苏宁易购电子礼品卡仅可在苏宁易购网上商城使用（非自营商品、合约计划、充值缴费、机票、酒店、彩票、团购等虚拟产品及金银类投资商品不能使用）；

2. 电子礼品卡有效期为3年，可以多次使用，直到卡内金额用完截止；

3. 电子礼品卡在苏宁易购首次使用或充值绑定后，将只能被绑定账户使用，不能跨账户使用；

4. 网上订单发生退货时，礼品卡金额自动退还到卡内。

5. 持卡人在苏宁电器门店或苏宁易购网上商城持卡消费时，在购买商品时礼品卡支付部分不再开具发票。

6. 卡密一经售出，非卡密本身质量问题，概不退换。

唯品会礼品卡

1.唯品卡可用于在唯品会官网(www.vip.com)的所有订单，暂不支持移动端使用。

2.唯品卡可以抵扣运费，一张唯品卡可以多次使用，如果当次消费金额超过唯品卡余额，不足部分顾客可使用其他支付方式支付。

3.唯品卡需在有效期内激活，激活之后3年有效，请在有效期内使用，过期作废。

4.唯品卡不可以和优惠券或礼品卡一起使用。使用唯品卡下单时，唯品卡支付部分不再开发票。

5.卡密一经售出，非卡密本身质量问题，概不退换。

6.唯品卡一旦激活，只能在激活账户使用，不能跨账户使用。

7.唯品卡激活方式：PC登陆唯品会，进入“我的账户”—“卡券管理”—选择唯品卡输入激活码（即卡密）。

GAP礼品卡

1.顾客凭此卡可在全国（不包括港澳台地区）所有Old Navy/盖璞商店以及oldnavy.cn和gap.cn网上购买商品（礼品卡除外）。结算时将直接扣除卡内余额至零为止。超出卡内金额部分请自行付款。

2.如需退还使用本卡购买之商品，退款将直接存入卡内，恕不退还现金。

3.本卡不记名、不提现、不透支、不计息、不找零。此卡一经售出，恕不退卡。如有任何遗失，恕不补发或退款。

4.发票已于购买本卡时开具。凭卡购物时，恕不重开发票。

5.本卡有效期为购买日起3年。

6.顾客可使用任一盖璞商店指定终端或通过oldnavy.cn或gap.cn网上查询余额。

国美在线红券

1、红券可用于购买国美在线自营商品和第三方平台商品；

2、红券可全场通用（黄金、汽车除外），单张订单仅可使用1张红券；

3、使用红券支付时，订单金额总额须大于使用的红券总面值，即使用红券总金额必须小于订单总金额，红券最大可使用金额=订单总额-（商品数×1元），例如：订单中含5件商品，总金额为100元，则最多可使用红券金额为：100-（5×1）=95元；差额部分需您选择其他支付方式来支付；

4、团购、抢购商品，目前支持红券支付。

5、用于销售的国美红券自生效之日起一年内有效，激活到账户内的过期后可以延期。

6、卡密一经售出，非卡密本身质量问题，概不退换。

优酷土豆

优酷会员是优酷向广大用户提供的增值尊贵服务，在免费享受"快""全""清"的观看体验之外，优酷会员可享受更多的增值功能和特权，包含点播节目5折优惠、全站视频免广告、上万小时付费节目免费看、会员专属尊贵标识和各种线上线下服务等。优酷会员卡-月卡，自激活之日起可使用1个月。

1、登陆/注册优酷账号；第二步：打开http://vip.youku.com 点击“我的账户-会员卡激活”，输入会员卡密码和验证码，即完成激活。安卓手机端激活流程第一步：登陆/注册优酷账号；

2、进入“会员中心”，点击“开通会员”；

3、点击“激活卡密”，输入卡密和验证码，即完成激活。卡密一经售出，非卡密本身质量问题，概不退换。

3.完整教学代码示例：

语言	标题
PHP	礼品卡的解密方法
JAVA	礼品卡卡信息的解密方法
other	礼品卡接口常见问题的说明
C#	礼品卡卡信息的解密方法