参数附录

支付渠道及说明

参数

名称

extra 参数

alipay

支付宝 App 支付

alipay参数

alipay_qr

支付宝正扫

alipay_qr参数

alipay_wap

支付宝 H5 支付

alipay_wap参数

alipay_lite

支付宝小程序支付

alipay_lite参数

alipay_scan

支付宝反扫

alipay_scan参数

wx

微信 App 支付

wx参数

wx_qr

微信正扫

wx_qr参数

wx_wap

微信 H5 支付

wx_wap参数

wx_pub

微信公众号支付

wx_pub参数

wx_lite

微信小程序支付

wx_lite参数

wx_scan

微信反扫

wx_scan参数

支付渠道 extra参数 说明

根据支付是渠道的不同,您需要本章节内容,在发起交易时上送特定渠道所需要的额外参数,以及根据部分渠道支付成功返回的额外参数进行响应的处理。

alipay参数

请求参数

参数

类型

必填

描述

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

返回参数

参数

描述

pay_info

支付信息,用于唤起支付宝

couponInfos

优惠券信息,使用 JSON格式

alipay_qr参数

请求参数

参数

类型

必填

描述

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

返回参数

参数

描述

qrcode_url

二维码连接

couponInfos

优惠券信息,使用 JSON格式

alipay_wap参数

请求参数

参数

类型

必填

描述

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

返回参数

参数

描述

pay_info

支付信息,用于唤起支付宝

couponInfos

优惠券信息,使用 JSON格式

alipay_lite参数

请求参数

参数

类型

必填

描述

buyer_id

String(100)

Y

买家的支付宝用户 id

buyer_logon_id

String(100)

N

买家支付宝账号

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

返回参数

参数

描述

pay_info

支付信息,用于唤起支付宝

couponInfos

优惠券信息,使用 JSON格式

alipay_scan参数

请求参数

参数

类型

必填

描述

auth_code

String(128)

Y

扫码设备读出的条形码或者二维码信息

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

返回参数

参数

描述

couponInfos

优惠券信息,使用 JSON格式

wx参数

请求参数

参数

类型

必填

描述

wx_app_id

String(32)

Y

商户 App 在微信平台注册的 appid

limit_pay

String(1)

N

值为 1 时禁止使用信用卡支付

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

返回参数

参 数

描述

pay_info

JSON格式 字符串,作用于原生态 js 支付时的参数

open_id

支付完成后额外返回付款用户的微信 open_id

sub_open_id

在子商户 appid 下的唯一标志

bank_type

支付完成后额外返回付款用户的付款银行类型 bank_type

couponInfos

优惠券信息,使用 JSON格式

wx_qr参数

请求参数

类型

必填

描述

wx_app_id

String(32)

Y

商户 App 在微信平台注册的 appid

limit_pay

String(1)

N

值为 1 时禁止使用信用卡支付

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

返回参数

参数

描述

qrcode_url

二维码链接

open_id

支付完成后额外返回付款用户的微信 open_id

bank_type

支付完成后额外返回付款用户的付款银行类型 bank_type

couponInfos

优惠券信息,使用 JSON格式

wx_wap参数

请求参数

参数

类型

必填

描述

wx_app_id

String(32)

Y

商户 App 在微信平台注册的 appid

limit_pay

String(1)

N

值为 1 时禁止使用信用卡支付

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

返回参数

参数

描述

pay_info

JSON格式 字符串,作用于原生态 js 支付时的参数

open_id

支付完成后额外返回付款用户的微信 open_id

sub_open_id

在子商户 appid 下的唯一标志

bank_type

支付完成后额外返回付款用户的付款银行类型 bank_type

couponInfos

优惠券信息,使用 JSON格式

wx_pub参数

请求参数

参数

类型

必填

描述

open_id

String(128)

Y

微信用户关注商家公众号的 openid

wx_app_id

String(32)

Y

商户 App 在微信平台注册的 appid

is_raw

String(1)

Y

是否原生态:”1”-是,”0”-否

callback_url

String(256)

N

交易完成后跳转的 URL, 需送绝对路径

limit_pay

String(1)

N

值为 1 时禁止使用信用卡支付

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

返回参数

参数

描述

token_id

动态口令, 用于后续接口调用中使用

pay_info

JSON格式 字符串,入参 isRaw=1 该值返回

open_id

支付完成后额外返回付款用户的微信 open_id

sub_open_id

在子商户 appid 下的唯一标志

bank_type

支付完成后额外返回付款用户的付款银行类型 bank_type

couponInfos

优惠券信息,使用 JSON格式

wx_lite参数

请求参数

参数

类型

必填

描述

open_id

String(128)

Y

微信用户关注商家公众号的 openid

wx_app_id

String(32)

Y

商户 App 在微信平台注册的 appid

is_raw

String(1)

Y

是否原生态:”1”-是,”0”-否

callback_url

String(256)

N

交易完成后跳转的 URL, 需送绝对路径

limit_pay

String(1)

N

值为 1 时禁止使用信用卡支付

promotion_detail

Map

N

优惠信息,详见 PromotionDetail对象

返回参数

参数

描述

token_id

动态口令, 用于后续接口调用中使用

pay_info

JSON格式 字符串,入参 isRaw=1 该值返回

open_id

支付完成后额外返回付款用户的微信 open_id

sub_open_id

在子商户 appid 下的唯一标志

bank_type

支付完成后额外返回付款用户的付款银行类型 bank_type

couponInfos

优惠券信息,使用 JSON格式

wx_scan参数

请求参数

参数

类型

必填

描述

auth_code

String(128)

Y

扫码设备读出的条形码或者二维码信息

promotion_detail

JSON

N

优惠信息,详见 PromotionDetail对象

limit_pay

String(1)

N

值为1时禁止使用信用卡支付

返回参数

参数

描述

open_id

支付完成后额外返回付款用户的微信 open_id

sub_open_id

在子商户 appid 下的唯一标志

couponInfos

优惠券信息,使用 JSON格式

PromotionDetail对象

参数

类型

必填

描述

cost_price

String(14)

N

  • 订单原价

  • 商户侧一张小票订单可能被分多次支付,订单原价用于记录整张小票的交易金额

  • 当订单原价与支付金额不相等,则不享受优惠

  • 该字段主要用于防止同一张小票分多次支付,以享受多次优惠的情况,正常支付订单不必上传此参数

receipt_id

String(32)

N

商家小票 id

goods_detail

JSON

Y

订单包含的商品列表信息,详见 GoodsDetail对象

GoodsDetail对象

参数

类型

必填

描述

goods_id

String(32)

Y

商品编码,由半角的大小写字母、数字、中划线、下划线中的一种或几种组成

goods_name

String(256)

Y

商品名称

quantity

String(10)

Y

商品数量

price

String(12)

Y

商品单价,单位为:元。 如果商户有优惠,需传输商户优惠后的单价(例如:用户对一笔 100元 的订单使用了商场发的优惠券 100-50,则活动商品的单价应为原单价-50)

goods_category

String(24)

N

商品类目

goods_body

String(1000)

N

商品描述信息

show_url

String(400)

N

商品的展示地址

DeviceInfo 设备信息

参数

类型

必填

描述

device_type

String(2)

N

设备类型,1 :手机, 2 :平板, 3:手表, 4:PC

device_ip

String(64)

N

交易设备所在的公网 IP

device_mac

String(64)

N

交易设备 MAC

device_imei

String(64)

N

交易设备 IMEI

device_imsi

String(64)

N

交易设备 IMSI

device_iccId

String(64)

N

交易设备 ICCID

device_wifi_mac

String(64)

N

交易设备 WIFIMAC

device_gps

String(64)

N

交易设备 GPS

支付状态 status

属性值

描述

pending

交易处理中

succeeded

交易成功

failed

交易失败

货币代码 currency

属性值

描述

cny

人名币(默认值)