支付宝当面付-参数

1.当面付—扫码支付参数

公共参数

公共请求参数

参数	类型	是否必填	最大长度	描述	示例值
app_id	String	是	32	支付宝分配给开发者的应用ID	2014072300007148
method	String	是	128	接口名称	alipay.trade.pay
format	String	否	40	仅支持JSON	JSON
charset	String	是	10	请求使用的编码格式，如utf-8,gbk,gb2312等	utf-8
sign_type	String	是	10	商户生成签名字符串所使用的签名算法类型，目前支持RSA2和RSA，推荐使用RSA2	RSA2
sign	String	是	344	商户请求参数的签名串，详见签名	详见示例
timestamp	String	是	19	发送请求的时间，格式"yyyy-MM-dd HH:mm:ss"	2014-07-24 03:07:50
version	String	是	3	调用的接口版本，固定为：1.0	1.0
notify_url	String	否	256	支付宝服务器主动通知商户服务器里指定的页面http/https路径。	http://api.test.alipay.net/atinterface/receive_notify.htm
app_auth_token	String	否	40	详见应用授权概述
biz_content	String	是		请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递，具体参照各产品快速接入文档

请求参数

参数	类型	是否必填	最大长度	描述	示例值
out_trade_no	String	必选	64	商户订单号。 由商家自定义，64个字符以内，仅支持字母、数字、下划线且需保证在商户端不重复。	20150320010101001
total_amount	Price	必选	11	订单总金额。 单位为元，精确到小数点后两位，取值范围：[0.01,100000000] 。	88.88
subject	String	必选	256	订单标题。 注意：不可使用特殊字符，如 /，=，& 等。	Iphone6 16G
scene	String	必选	32	支付场景。 枚举值： bar_code：当面付条码支付场景； security_code：当面付刷脸支付场景，对应的auth_code为fp开头的刷脸标识串； 默认值为bar_code。	bar_code
auth_code	String	必选	64	支付授权码。 当面付场景传买家的付款码（2530开头的长度为1624位的数字，实际字符串长度以开发者获取的付款码长度为准）或者刷脸标识串（fp开头的35位字符串）。	28763443825664394
product_code	String	可选	64	产品码。 商家和支付宝签约的产品码。 当面付场景下，如果签约的是当面付快捷版，则传 OFFLINE_PAYMENT; 其它支付宝当面付产品传 FACE_TO_FACE_PAYMENT； 不传则默认使用FACE_TO_FACE_PAYMENT。	FACE_TO_FACE_PAYMENT
seller_id	String	可选	28	卖家支付宝用户ID。 当需要指定收款账号时，通过该参数传入，如果该值为空，则默认为商户签约账号对应的支付宝用户ID。 收款账号优先级规则：门店绑定的收款账户>请求传入的seller_id>商户签约账号对应的支付宝用户ID； 注：直付通和机构间联场景下seller_id无需传入或者保持跟pid一致；如果传入的seller_id与pid不一致，需要联系支付宝小二配置收款关系；	2088102146225135
goods_detail	GoodsDetail[]	可选		订单包含的商品列表信息，json格式。
└goods_id	String	必选	32	商品的编号	apple-01
└goods_name	String	必选	256	商品名称	ipad
└quantity	Number	必选	10	商品数量	1
└price	Price	必选	9	商品单价，单位为元	2000
└goods_category	String	可选	24	商品类目	34543238
└categories_tree	String	可选	128	商品类目树，从商品类目根节点到叶子节点的类目id组成，类目id值使用|分割	124868003|126232002|126252004
└show_url	String	可选	400	商品的展示地址	http://www.alipay.com/xxx.jpg
extend_params	ExtendParams	可选		业务扩展参数
└sys_service_provider_id	String	可选	64	系统商编号 该参数作为系统商返佣数据提取的依据，请填写系统商签约协议的PID	2088511833207846
└card_type	String	可选	32	卡类型	S0JP0000
└specified_seller_name	String	可选	32	特殊场景下，允许商户指定交易展示的卖家名称	XXX的跨境小铺
promo_params	PromoParam	可选		优惠明细参数，通过此属性补充营销参数。 注：仅与支付宝协商后可用。
└actual_order_time	String	可选	32	存在延迟扣款这一类的场景，用这个时间表明用户发生交易的时间，比如说，在公交地铁场景，用户刷码出站的时间，和商户上送交易的时间是不一样的。	2018-09-25 22:47:33
store_id	String	可选	32	商户门店编号。 指商户创建门店时输入的门店编号。	NJ_001
operator_id	String	可选	28	商户操作员编号。	yx_001
terminal_id	String	可选	32	商户机具终端编号。	NJ_T_001
query_options	String[]	可选	1024	返回参数选项。 商户通过传递该参数来定制同步需要额外返回的信息字段，数组格式。如：["fund_bill_list","voucher_detail_list","discount_goods_detail"]	["fund_bill_list","voucher_detail_list","discount_goods_detail"]

公共响应参数

参数	类型	是否必填	最大长度	描述	示例值
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=

响应参数

参数	类型	是否必填	最大长度	描述	示例值
trade_no	String	必选	64	支付宝交易号	2013112011001004330000121536
out_trade_no	String	必选	64	商户订单号	6823789339978248
buyer_logon_id	String	必选	100	买家支付宝账号	159****5620
total_amount	Price	必选	11	交易金额	120.88
receipt_amount	String	必选	11	实收金额	88.88
buyer_pay_amount	Price	可选	11	买家付款的金额	8.88
point_amount	Price	可选	11	使用集分宝付款的金额	8.12
invoice_amount	Price	可选	11	交易中可给用户开具发票的金额	12.50
gmt_payment	Date	必选	32	交易支付时间	2014-11-27 15:45:57
fund_bill_list	TradeFundBill[]	必选		交易支付使用的资金渠道。 只有在签约中指定需要返回资金明细，或者入参的query_options中指定时才返回该字段信息。
└fund_channel	String	必选	32	交易使用的资金渠道，详见 支付渠道列表	ALIPAYACCOUNT
└amount	Price	必选	32	该支付工具类型所使用的金额	10
└real_amount	Price	可选	11	渠道实际付款金额	11.21
store_name	String	可选	512	发生支付交易的商户门店名称	证大五道口店
buyer_user_id	String	必选	28	买家在支付宝的用户id	2088101117955611
discount_goods_detail	String	可选	4096	本次交易支付所使用的单品券优惠的商品优惠信息。 只有在query_options中指定时才返回该字段信息。	[{"goods_id":"STANDARD1026181538","goods_name":"雪碧","discount_amount":"100.00","voucher_id":"2015102600073002039000002D5O"}]
voucher_detail_list	VoucherDetail[]	可选		本交易支付时使用的所有优惠券信息。 只有在query_options中指定时才返回该字段信息。
└id	String	必选	32	券id	2015102600073002039000002D5O
└name	String	必选	64	券名称	XX超市5折优惠
└type	String	必选	32	券类型，如： ALIPAY_FIX_VOUCHER - 全场代金券 ALIPAY_DISCOUNT_VOUCHER - 折扣券 ALIPAY_ITEM_VOUCHER - 单品优惠券 ALIPAY_CASH_VOUCHER - 现金抵价券 ALIPAY_BIZ_VOUCHER - 商家全场券 注：不排除将来新增其他类型的可能，商家接入时注意兼容性避免硬编码	ALIPAY_FIX_VOUCHER
└amount	Price	必选	8	优惠券面额，它应该会等于商家出资加上其他出资方出资	10.00
└merchant_contribute	Price	可选	8	商家出资（特指发起交易的商家出资金额）	9.00
└other_contribute	Price	可选	8	其他出资方出资金额，可能是支付宝，可能是品牌商，或者其他方，也可能是他们的一起出资	1.00
└memo	String	可选	256	优惠券备注信息	学生专用优惠
└template_id	String	可选	64	券模板id	20171030000730015359000EMZP0
└purchase_buyer_contribute	Price	可选	8	如果使用的这张券是用户购买的，则该字段代表用户在购买这张券时用户实际付款的金额	2.01
└purchase_merchant_contribute	Price	可选	8	如果使用的这张券是用户购买的，则该字段代表用户在购买这张券时商户优惠的金额	1.03
└purchase_ant_contribute	Price	可选	8	如果使用的这张券是用户购买的，则该字段代表用户在购买这张券时平台优惠的金额	0.82
mdiscount_amount	String	特殊可选	11	商家优惠金额	88.88
discount_amount	String	特殊可选	11	平台优惠金额	88.88

2.其余查单 退款参数

https://opendocs.alipay.com/open/02ekfg?scene=19