ECJiaWiki:Api:order/pay

来自ECJiaWiki
跳转至: 导航搜索

应用场景

 订单支付

接口名称

 order/pay

Header请求参数

字段名 变量名 必填 类型 示例值 描述 since deprecated
设备唯一ID device-udid String a46d663d675d4858ea7d0a21c2de06e9 设备的唯一编号 1.3.0
设备客户端类型 device-client String android,iphone,h5,weapp 设备类型的描述 1.3.0
产品编号 device-code String 6015 产品编号 1.3.0
API版本 api-version String 1.6 API接口版本号 1.3.0

举例如下

{
    "device-udid" : "a46d663d675d4858ea7d0a21c2de06e9",
    "device-client" : "weapp",
    "device-code " : "6015",
    "api-version" : "1.6",
}

返回参数

字段名 变量名 必填 类型 示例值 描述 since deprecated
返回信息 data Json 接口提供的返回信息 1.3.0
└支付信息 payment Json 接口返回的支付信息 1.3.0
 └订单id号 order_id Int 订单id号 1.3.0
 └结算 order_surplus String 订单结算价 1.3.0
 └金额 order_amount String 返回的金额值 1.3.0
 └用户余额 user_money String 接口返回用户的金额 1.3.0
 └支付码 pay_code String pay_balance 接口返回用户的金额 1.3.0
 └支付名称 pay_name String 余额支付 接口返回用户的支付方式 1.3.0
 └支付状态 pay_status String success 接口返回支付状态,成功返回success,失败返回error 1.3.0
 └在线支付 pay_online 在线支付状态 1.3.0
 └订单支付状态 order_pay_status Int 订单支付状态码 1.3.0
返回状态码 status Json {"succeed" : 1} 返回请求接口后的数据,succeed为1代表成功,0则为失败,失败后则返回error_code(错误code)及error_desc(错误说明) 1.3.0
报错信息 error_message Array 支付报错返回的信息 1.3.0

成功举例如下

(不同支付方式和场景返回值不同)

{
    "data" {
            "payment": {
                    "order_id" : 2656
                    "order_surplus" : 116.03
                    "order_amount" : 0.00
                    "user_money" : 6339.56
                    "pay_code" : "pay_balance"
                    "pay_name" : "余额支付"
                    "pay_status" : "success"
                    "pay_online" : 
                    "order_pay_status" : 0
            }
        }
    "status" : {
            "succeed" : 1
     }
}

//已付款
{
    "order_id" : 2656
    "order_surplus" : 116.03
    "order_amount" : 0.00
    "pay_code" : "pay_balance"
    "pay_name": "余额支付"
    "pay_status" : "error"
    "pay_online" : 
    "error_message": "该订单已经支付,请勿重复支付。"
    "order_pay_status": 2
}

请求参数

字段名 变量名 必填 类型 示例值 描述 since deprecated
token请求凭证 token String 调用接口凭证 1.3.0
订单id order_id Int 订单id 1.3.0

举例如下

{
    "token": "d122e3c72332c5af12a71d77c9f1462f5901d276",    //session_id的加密
    "order_id": 39,    //订单id
}

返回参数

字段名 变量名 必填 类型 示例值 描述 since deprecated
返回信息 data String 请求接口提供的返回信息 1.3.0
状态码 status Json {"succeed" : 1} 返回请求接口后的数据,succeed为1代表成功,0则为失败 1.3.0

成功举例如下

{
  "data": '<!DOCTYPE html><html><head><title></title><meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1.0"><base href="http://127.0.0.1/myworkEPP/ECJia/upload/" /></head><body></body></html>',    //返回数据
  "status": {
    "succeed": 1    //返回成功
  }
}

返回参数

字段名 变量名 必填 类型 示例值 描述 since deprecated
返回状态码 status Json 返回请求接口后的数据,succeed为1代表成功,0则为失败,失败后则返回error_code(错误code)及error_desc(错误说明) 1.3.0
└错误编码 error_code Int 错误编码 1.3.0
└错误描述 error_desc String 接口返回的错误信息 1.3.0

错误举例如下

{
  "status": {		//状态
    "succeed": 0;		//是否成功
    "error_code": 11;		//错误编码
    "error_desc": "用户名或email已使用";		//错误信息
  }
}


注:错误编码