会员卡开通,获取会员卡信息
请求地址
环境 | HTTPS请求地址 |
---|---|
正式环境 | https://openapi.alipay.com/gateway.do |
公共请求参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
method | String | 必选 | 128 | 接口名称 | alipay.trade.order.settle |
charset | String | 必选 | 10 | 请求使用的编码格式,如utf-8,gbk,gb2312等 | utf-8 |
version | String | 必选 | 3 | 版本号,默认1.0 | 1.0 |
biz_app_id | String | 可选 | 32 | 商户app_id | 2014072300007148 |
invoke_app_id | String | 可选 | 32 | 调用方app_id | 2014072300007148 |
utc_timestamp | String | 必选 | 19 | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" | 2014-07-24 03:07:50 |
sign_type | String | 必选 | 10 | 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 | RSA2 |
sign | String | 必选 | 344 | 商户请求参数的签名串,详见签名 | 详见示例 |
请求参数
Header
Query
Body
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
user_id | String | 可选 | 16 | user_id:蚂蚁统一会员ID想了解openid? | 2088902351536970 |
union_id | String | 可选 | 47 | union_id是支付宝用户在开放平台的唯一标识符,在配置应用分组后会返回该值。 union_id在同一分组内应用保持一致 | 092aSPrsmhTbexLh9zgoYb2uvZNC4D8izCpGKTem8QiIOQb |
template_id | String | 必选 | 32 | template_id:会员卡模版id | 20200312000000000414103000300846 |
out_serial_no | String | 必选 | 32 | out_serial_no:外部流水号,标识一次用户的开卡动作,由卡包维护全局唯一。 | 1621923366000 |
biz_card_no | String | 必选 | 32 | biz_card_no:支付宝业务卡号,对应返回出参card_info中的biz_card_no字段,需回传 | 000001 |
user_info | String | 必选 | 10240 | user_info:用户提交的表单信息,JSON数组格式。 通用表单字段名称如下示例: OPEN_FORM_FIELD_MOBILE – 手机号 OPEN_FORM_FIELD_GENDER – 性别 OPEN_FORM_FIELD_NAME – 姓名 OPEN_FORM_FIELD_BIRTHDAY – 生日 OPEN_FORM_FIELD_IDCARD – 身份证 OPEN_FORM_FIELD_EMAIL – 邮箱 OPEN_FORM_FIELD_ADDRESS – 地址 详细字段名称列表见会员卡开卡表单模板配置接口:alipay.marketing.card.formtemplate.set 注: 1. 证件类型字段(OPEN_FORM_FIELD_CERT_TYPE)返回结果取值如下: 0 -- 身份证 1 -- 护照 2 -- 港澳居民通行证 3 -- 台湾居民通行证 | [{"OPEN_FORM_FIELD_GENDER":"男"},{"OPEN_FORM_FIELD_MOBILE":"13888888888"},{"OPEN_FORM_FIELD_NAME":"李四"}] |
out_string | String | 可选 | 1024 | 该值为商家拉起开卡组件的传递的out_string值,可用于该值区分不同的业务场景,禁止将该字段作为开卡流程的必要字段,否则会导致会员推广场景下的入会失败 | test |
公共响应参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
code | String | 必选 | - | 网关返回码,详见文档 | 40004 |
msg | String | 必选 | - | 网关返回码描述,详见文档 | Business Failed |
sub_code | String | 可选 | - | 业务返回码,参见具体的API接口文档 | ACQ.TRADE_HAS_SUCCESS |
sub_msg | String | 可选 | - | 业务返回码描述,参见具体的API接口文档 | 交易已被支付 |
sign | String | 必选 | - | 签名,详见文档 | DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo= |
响应参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
card_info | MerchantCard | 必选 | card_info:商家定义的会员卡信息 | ||
open_card_ext_info | OpenCardExtInfo | 可选 | open_card_ext_info:用于传递开卡过程中附加的扩展信息 | ||
result | OpenCardSpiResultCode | 可选 | result: spi开卡接口结果信息 |
响应示例
{
"response": {
"code": "10000",
"msg": "Success",
"card_info": {
"biz_card_no": "000001",
"external_card_no": "EXT0001",
"open_date": "2014-02-20 21:20:46",
"valid_date": "2020-02-20 21:20:46",
"level": "VIP1",
"point": "88",
"balance": "124.89",
"template_id": "20170308000000000058101000300045",
"custom_assets": "100元",
"mdcode_info": {
"code_status": "SUCCESS",
"code_value": "1KFCDY0002",
"expire_time": "2017-06-09 16:25:53",
"time_stamp": 1496996459
},
"front_text_list": [
{
"label": "专业",
"value": "金融贸易"
}
],
"front_image_id": "9fxnkgt0QFmqKAl5V2BqxQAAACMAAQED"
},
"open_card_ext_info": {
"is_new_member": true,
"activity_id": "12345"
},
"result": {
"result_code": "SUCCESS",
"result_desc": "成功"
}
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
异常示例
{
"response": {
"code": "20000",
"msg": "Service Currently Unavailable",
"sub_code": "isp.unknow-error",
"sub_msg": "系统繁忙"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}