帮助中心

5009-储值礼品卡退款信息查询

2019-11-18

接口编号:5009

接口说明:

储值礼品卡退款信息查询接口 (根据外部订单号和原始单据号获取储值礼品卡的退款信息,用于POS收银系统的储值卡余额退款时使用)

请求说明:

HTTP请求方式:POST

返回数据格式:JSON

请求路径:api/wxgiftcard/GetWxGiftCardInfoByOriginalOrderId

请求参数:

  字段
  类型  可否为空  长度  描述
  ExternalOrderId  string  否  20  外部订单号(小票号)
  OriginalOrderId  string  否  20  原始单据号(退款单号)
  WxCardCode  string  是  20  礼品卡Code(卡号或动态码)






返回参数:

  字段
  类型长度  描述
  CardId  string64  储值卡ID
  CardCode  string20
  储值卡Code
  CardTitle  string20  储值卡名称
  CardValidity  string50  储值卡有效期
  IsPrepaidCard  bool
  是否为预付卡(储值卡)
  InitBalance  decimal    12,2  储值卡的初始余额(面值)
  DeductionValue  decimal    12,2  储值卡的退款金额
  Balance  decimal 12,2  储值卡余额
  ResidualRefundBalance  decimal    12,2  储值卡可退金额
  StatusMsg  string     10  储值卡退款状态
  CardStatus  string  10  储值卡当前状态
  ProdItemName  string30
  商品名称
  ProdItemNo  string20  商品货号
  RetailPrice  decimal12,2  商品吊牌价
  SalePrice  decimal12,2  商品售价
  PictureThumb  string256  商品缩略图
  IsConsumeWord  bool
  是否口令核销














请求参数示例代码(json对象):

{
    "ExternalOrderId":"E2018070311244812083",
    "OriginalOrderId":"R2018070311244812083",
    "WxCardCode":"718811983384"
}

系统级返回结果示例(json对象):

{
    "Status": true,
    "StatusCode": 200,
    "Msg": "成功",
    "Timestamp": "20150622093101",
    "Sign": "6ECC9BF07C69E80F6D8552FF7B2E7A8FCA2CC80E",
    "Result": 见业务返回结果示例,
}

//返回结果表示储值卡退款成功
{
    "Sign": "FF66F4D1CBCFE6BE74985B4E21CBFA3365D68B86",    
    "Status": true,
    "StatusCode": 200,
    "Msg": "成功",
    "Timestamp": "20190326180332",
    "Result": [
        {
            "CardId": "puMMGs-XqPVWSQMx7ei9awcqdasQ",
            "CardCode": "718811983384",
            "CardTitle": "储值卡",
            "IsConsumeWord": false,
            "CardValidity": "2019-11-03 16:37:09",
            "InitBalance": 500,
            "DeductionValue": 300,
            "Balance": 300,
            "IsPrepaidCard": true,
            "StatusMsg": "退款成功",
            "CardStatus":"储值卡已使用",
            "ResidualRefundBalance": 200,
            "RetailPrice": 0,
            "SalePrice": 0
        }
    ]
}

//返回结果表示储值卡退款失败
{
    "Sign": "",
    "Status": false,
    "StatusCode": 2000,
    "Msg": "不存在已退款的礼品卡!",
    "Timestamp": "20190326222253"
}