会员对外文档平台 会员对外文档平台
登录
接口
介绍
  • TOB直充接口

  • TOB激活码直充接口

  • OTT直充接口

  • OTT自动续费接口

  • OTT激活码直充接口

  • 通用接口

    • 通用退单接口
    • 退单查询
    • 下单回调接口
    • 退单回调接口
    • 积分查询接口
  • 内容点播接口

  • 卡券类接口

  • 用户信息接口

  • 会员福利接口

  • 合作方客户FV管理

# 退单查询

# 简介

# 业务介绍

通过查询接口查询退单的进度和状态

# 接口定义

# 应用场景

当合作方发起退款前,可以通过此接口查询用户可退的权益等信息

# 接口域名

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

# URL

/partner/refundQuery.action

# 请求方式

参数 说明
Method GET/POST
Content-Type application/x-www-form-urlencoded

# 请求参数

变量名 名称 是否必须 类型 说明
partnerNo 合作方编码 是 String 合作方的唯一标识,由爱奇艺提供
sign 签名串 是 String MD5签名,签名方法见MD5加密描述
orderNo 原订单号 是 String 合作方的退单原订单号

# 返回参数

字段名 类型 说明
code String 返回码,参考附录
msg String 返回码说明
status Integer 状态,0-未退,3-待退,4-已退,5-退单审核中,6-退单申请被拒
time String 退款时间,格式yyyy-MM-dd HH:mm:ss,若status=0,则不会返回此字段
amount Integer 数量
unit Integer amount的单位,1-天,2-月
sum Integer 退单金额(即爱奇艺侧可退金额),单位为分
partnerSum Integer 用户退单金额(合作方传入的退单金额),单位为分

# 返回示例

{
    "code":"A00000",
    "msg":"成功",
    "data":{
        "status":0,
        "time":"yyyy-MM-dd  HH:mm:ss",
        "amount":1,
        "unit":1,
        "sum":10000,
        "partnerSum":10000
    }
}

# 返回码定义

返回码Code 描述 备注
A00000 处理成功
Q00301 参数错误(如合作方编号为空,订单号非法等)
Q00307 签名错误
Q00332 系统错误
Q00409 原订单不存在或状态不是已完成
Q00426 原订单上没有可退的会员权益
Q00429 不支持合作方接口退单

# 附录

# MD5加密描述

采用MD5计算签名,MD5密钥由爱奇艺提供,具体计算方法如下:
1、 假设共有三个参数 a=3、b=2、c=1;
2、 按参数名的字母正序排列,再用“&”连接后得到串A,即为“a=3&b=2&c=1”;
3、 将MD5密钥拼接到串A后面,假设MD5密钥为“qwer”,则拼接后为“a=3&b=2&c=1qwer”;
4、 计算拼接串的MD5即为最终签名值,注意使用UTF-8编码计算,MD5后的签名最后都转成小写。
举例:
参数:a=3、b=2、c=1;
MD5密钥:qwer
最终签名串:f80118ff523f25eda67cb799bdc9c52d

# JAVA版本示例代码如下:

public class Test{
/**
 * MD5签名测试类
 *
 */
    private static final char[] DIGITS = {'0', '1', '2', '3', '4', '5', '6',
        '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
    public static void main(String[] args) {
        TreeMap<String, Object> paramMap = new TreeMap<>();
        paramMap.put("a", "3");
        paramMap.put("b", "2");
        paramMap.put("c", "1");
        String md5key = "qwer";
        String targetParam = Joiner.on("&").withKeyValueSeparator("=")
        .useForNull("").join(paramMap);
        // MD5签名工具类,可以自己实现, MD5实现参照
        String targetSign = EncodeUtils.MD5(targetParam + md5key, "UTF-8");
        System.out.println("targetSign: " + targetSign);
    }
}

# 加密工具类

# MD5加密

import com.google.common.base.Joiner;
import org.apache.commons.lang.StringUtils;
import org.junit.Test;
import java.util.HashMap;
import java.util.Map;
import java.util.TreeMap;
import java.io.UnsupportedEncodingException;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
public class EncodeUtils{

    public static String MD5(String text, String charset) {

        MessageDigest msgDigest = null;
        try {
            msgDigest = MessageDigest.getInstance("MD5");
        } catch (NoSuchAlgorithmException e) {
            throw new IllegalStateException("System doesn't support MD5 algorithm.");
        }
        try {
            msgDigest.update(text.getBytes(charset));    //注意改接口是按照指定编码形式签名
        } catch (UnsupportedEncodingException e) {
            throw new IllegalStateException("System doesn't support your  EncodingException.");
        }
        byte[] bytes = msgDigest.digest();
        String md5Str = new String(encodeHex(bytes));
        return md5Str;
    }

    public static char[] encodeHex(byte[] data) {

        int l = data.length;
        char[] out = new char[l << 1];
        // two characters form the hex value.
        for (int i = 0, j = 0; i < l; i++) {
            out[j++] = DIGITS[(0xF0 & data[i]) >>> 4];
            out[j++] = DIGITS[0x0F & data[i]];
        }
        return out;
    }
}

# 在线测试

参数 值 备注
partnerNo toB_common_test

所需密钥:

参数 值
MD5密钥 b0ee3c7f62760330
点击此处进行接口调试
在线调试

← 通用退单接口 下单回调接口 →