礼品卡兑换 - iPaaS三方执行动作

请求参数

Body 参数application/json

rootKdtId

integer <int64>

有赞店铺总部Id

必需

appId

string

必需

应用厂商标识appId

globalProps

object (Map«Object»)

全局变量

必需

key

object (key)

可选

extendMap

object (Map«Object»)

必需

上下文扩展信息，透传信息key

key

object (key)

可选

kdtId

integer <int64>

有赞店铺id

必需

outStoreId

string

三方系统店铺id

必需

yzOpenId

string

有赞用户id

必需

outOpenId

string

三方用户id

必需

outTemplateNo

string

可选

外部卡模板号，线上卡兑换时，该字段不为空

serialNum

string

可选

卡号/序列号，卡密兑换时必填，扫码兑换时为空

checkCode

string

可选

卡密/兑换码，卡密兑换时必填，扫码兑换时为空

cardRandom

string

可选

卡号随机码，扫码兑换时必填，卡密兑换时为空

exchangeType

enum<integer>

兑换方式

必需

枚举值:

needActive

boolean

必需

兑换时是否要同步进行激活，true-需要激活，false-无需激活

onlineCard

boolean

必需

是否是线上兑换卡，true-线上卡，false-线下卡

supportGive

boolean

必需

线上卡是否支持赠送，true-支持赠送，false-不支持赠送

onlineCardExchangeResult

object (OnlineCardExchangeResult)

线上卡兑换结果

可选

cardNo

string

线上兑换卡号

必需

exchangeStatus

enum<integer>

兑换状态

必需

枚举值:

23456

exchangeFailReason

string

可选

其他兑换失败原因，exchangeStatus=6时，此原因会展示给用户

exchangeTime

string <date-time>

可选

兑换成功的日期，兑换成功时必填，毫秒级时间戳

principal

integer <int64>

卡内本金-分

可选

bonus

integer <int64>

卡内赠送金-分

可选

denomination

integer <int64>

卡面额-分

可选

templateNo

string

卡模板号

可选

expireTime

string <date-time>

可选

批量制卡时卡的有效期截止日期-毫秒时间戳

templateName

string

卡模板名称

可选

supportGive

boolean

是否支持赠送

可选

示例

{
    "rootKdtId": 0,
    "appId": "string",
    "globalProps": {
        "key": {}
    },
    "extendMap": {
        "key": {}
    },
    "kdtId": 0,
    "outStoreId": "string",
    "yzOpenId": "string",
    "outOpenId": "string",
    "outTemplateNo": "string",
    "serialNum": "string",
    "checkCode": "string",
    "cardRandom": "string",
    "exchangeType": 1,
    "needActive": true,
    "onlineCard": true,
    "supportGive": true,
    "onlineCardExchangeResult": {
        "cardNo": "string",
        "exchangeStatus": 2,
        "exchangeFailReason": "string",
        "exchangeTime": "2019-08-24T14:15:22Z",
        "principal": 0,
        "bonus": 0,
        "denomination": 0,
        "templateNo": "string",
        "expireTime": "2019-08-24T14:15:22Z",
        "templateName": "string",
        "supportGive": true
    }
}

返回响应

🟢200成功

application/json

Body

success

boolean

可选

标识本次调用是否返回

code

integer

可选

本次调用返回code，一般为错误代码

message

string

可选

本次调用返回的消息，一般为错误消息

requestId

string

请求Id

可选

errorData

object (Map«Object»)

调用失败返回的数据

可选

key

object (key)

可选

data

object (ValueCardExchangeExtResponse)

调用返回的数据

可选

success

boolean

兑换结果

必需

cardNo

string

兑换后三方卡号

可选

exchangeStatus

enum<integer>

兑换状态

必需

枚举值:

23456

exchangeFailReason

string

可选

其他兑换失败原因，exchangeStatus 6时，此原因会展示给用户

exchangeTime

string <date-time>

可选

兑换成功的日期，兑换成功时必填，毫秒级时间戳

updatedTime

string <date-time>

更新时间

可选

示例

{
  "success": false,
  "code": 0,
  "message": "",
  "requestId": "",
  "errorData": {
    "": {}
  },
  "data": {
    "success": false,
    "cardNo": "",
    "exchangeStatus": 0,
    "exchangeFailReason": "",
    "exchangeTime": "",
    "updatedTime": ""
  }
}