感谢您的反馈!
公共参数
环境 | HTTPS请求地址 |
---|---|
正式环境 | https://openapi.alipay.com/gateway.do |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
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 |
scene | String | 必选 | 32 | 支付场景 条码支付,取值:bar_code 声波支付,取值:wave_code |
bar_code |
auth_code | String | 必选 | 32 | 支付授权码,25~30开头的长度为16~24位的数字,实际字符串长度以开发者获取的付款码长度为准 | 28763443825664394 |
product_code | String | 可选 | 32 | 销售产品码 | FACE_TO_FACE_PAYMENT |
subject | String | 必选 | 256 | 订单标题 | Iphone6 16G |
buyer_id | String | 可选 | 28 | 买家的支付宝用户id,如果为空,会从传入了码值信息中获取买家ID | 2088202954065786 |
seller_id | String | 可选 | 28 | 如果该值为空,则默认为商户签约账号对应的支付宝用户ID | 2088102146225135 |
total_amount | Price | 可选 | 11 | 订单总金额,单位为元,精确到小数点后两位,取值范围[0.01,100000000] 如果同时传入【可打折金额】和【不可打折金额】,该参数可以不用传入; 如果同时传入了【可打折金额】,【不可打折金额】,【订单总金额】三者,则必须满足如下条件:【订单总金额】=【可打折金额】+【不可打折金额】 |
88.88 |
trans_currency | String | 可选 | 8 | 标价币种, total_amount 对应的币种单位。支持英镑:GBP、港币:HKD、美元:USD、新加坡元:SGD、日元:JPY、加拿大元:CAD、澳元:AUD、欧元:EUR、新西兰元:NZD、韩元:KRW、泰铢:THB、瑞士法郎:CHF、瑞典克朗:SEK、丹麦克朗:DKK、挪威克朗:NOK、马来西亚林吉特:MYR、印尼卢比:IDR、菲律宾比索:PHP、毛里求斯卢比:MUR、以色列新谢克尔:ILS、斯里兰卡卢比:LKR、俄罗斯卢布:RUB、阿联酋迪拉姆:AED、捷克克朗:CZK、南非兰特:ZAR、人民币:CNY | USD |
settle_currency | String | 可选 | 8 | 商户指定的结算币种,支持英镑:GBP、港币:HKD、美元:USD、新加坡元:SGD、日元:JPY、加拿大元:CAD、澳元:AUD、欧元:EUR、新西兰元:NZD、韩元:KRW、泰铢:THB、瑞士法郎:CHF、瑞典克朗:SEK、丹麦克朗:DKK、挪威克朗:NOK、马来西亚林吉特:MYR、印尼卢比:IDR、菲律宾比索:PHP、毛里求斯卢比:MUR、以色列新谢克尔:ILS、斯里兰卡卢比:LKR、俄罗斯卢布:RUB、阿联酋迪拉姆:AED、捷克克朗:CZK、南非兰特:ZAR、人民币:CNY | USD |
discountable_amount | Price | 可选 | 11 | 参与优惠计算的金额,单位为元,精确到小数点后两位,取值范围[0.01,100000000]。 如果该值未传入,但传入了【订单总金额】和【不可打折金额】,则该值默认为【订单总金额】-【不可打折金额】 |
8.88 |
body | String | 可选 | 128 | 订单描述 | Iphone6 16G |
goods_detail | GoodsDetail[] | 可选 | 订单包含的商品列表信息,json格式,其它说明详见商品明细说明 | ||
operator_id | String | 可选 | 28 | 商户操作员编号 | yx_001 |
store_id | String | 可选 | 32 | 商户门店编号 | NJ_001 |
terminal_id | String | 可选 | 32 | 商户机具终端编号 | NJ_T_001 |
extend_params | ExtendParams | 可选 | 业务扩展参数 | ||
timeout_express | String | 可选 | 6 | 该笔订单允许的最晚付款时间,逾期将关闭交易。取值范围:1m~15d。m-分钟,h-小时,d-天,1c-当天(1c-当天的情况下,无论交易何时创建,都在0点关闭)。 该参数数值不接受小数点, 如 1.5h,可转换为 90m | 90m |
auth_confirm_mode | String | 可选 | 32 | 预授权确认模式,授权转交易请求中传入,适用于预授权转交易业务使用,目前只支持PRE_AUTH(预授权产品码) COMPLETE:转交易支付完成结束预授权,解冻剩余金额; NOT_COMPLETE:转交易支付完成不结束预授权,不解冻剩余金额 |
COMPLETE:转交易支付完成结束预授权;NOT_COMPLETE:转交易支付完成不结束预授权 |
terminal_params | String | 可选 | 2048 | 商户传入终端设备相关信息,具体值要和支付宝约定 | {"key":"value"} |
promo_params | PromoParam | 可选 | 优惠明细参数,通过此属性补充营销参数 |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
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 |
settle_amount | String | 选填 | 11 | 结算币种订单金额 | 88.88 |
pay_currency | String | 选填 | 8 | 支付币种 | CNY |
pay_amount | String | 选填 | 11 | 支付币种订单金额 | 580.04 |
settle_trans_rate | String | 选填 | 32 | 结算币种兑换标价币种汇率 | 1 |
trans_pay_rate | String | 选填 | 32 | 标价币种兑换支付币种汇率 | 6.5261 |
total_amount | Price | 必填 | 11 | 交易金额 | 120.88 |
trans_currency | String | 选填 | 5 | 标价币种, total_amount对应的币种单位。目前支持英镑:GBP、港币:HKD、美元:USD、新加坡元:SGD、日元:JPY、加拿大元:CAD、澳元:AUD、欧元:EUR、新西兰元:NZD、韩元:KRW、泰铢:THB、瑞士法郎:CHF、瑞典克朗:SEK、丹麦克朗:DKK、挪威克朗:NOK、马来西亚林吉特:MYR、印尼卢比:IDR、菲律宾比索:PHP、毛里求斯卢比:MUR、以色列新谢克尔:ILS、斯里兰卡卢比:LKR、俄罗斯卢布:RUB、阿联酋迪拉姆:AED、捷克克朗:CZK、南非兰特:ZAR、人民币:CNY | USD |
settle_currency | String | 选填 | 8 | 商户指定的结算币种,目前支持英镑:GBP、港币:HKD、美元:USD、新加坡元:SGD、日元:JPY、加拿大元:CAD、澳元:AUD、欧元:EUR、新西兰元:NZD、韩元:KRW、泰铢:THB、瑞士法郎:CHF、瑞典克朗:SEK、丹麦克朗:DKK、挪威克朗:NOK、马来西亚林吉特:MYR、印尼卢比:IDR、菲律宾比索:PHP、毛里求斯卢比:MUR、以色列新谢克尔:ILS、斯里兰卡卢比:LKR、俄罗斯卢布:RUB、阿联酋迪拉姆:AED、捷克克朗:CZK、南非兰特:ZAR、人民币:CNY | USD |
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 | 必填 | 交易支付使用的资金渠道 | ||
card_balance | Price | 选填 | 11 | 支付宝卡余额 | 98.23 |
store_name | String | 选填 | 512 | 发生支付交易的商户门店名称 | 证大五道口店 |
buyer_user_id | String | 必填 | 28 | 买家在支付宝的用户id | 2088101117955611 |
discount_goods_detail | String | 选填 | 1024 | 本次交易支付所使用的单品券优惠的商品优惠信息 | [{"goods_id":"STANDARD1026181538","goods_name":"雪碧","discount_amount":"100.00","voucher_id":"2015102600073002039000002D5O"}] |
voucher_detail_list | VoucherDetail | 选填 | 本交易支付时使用的所有优惠券信息 | ||
auth_trade_pay_mode | String | 选填 | 64 | 预授权支付模式,该参数仅在信用预授权支付场景下返回。信用预授权支付:CREDIT_PREAUTH_PAY | CREDIT_PREAUTH_PAY |
charge_amount | String | 选填 | 11 | 该笔交易针对收款方的收费金额; 默认不返回该信息,需与支付宝约定后配置返回; |
8.88 |
charge_flags | String | 选填 | 64 | 费率活动标识,当交易享受活动优惠费率时,返回该活动的标识; 默认不返回该信息,需与支付宝约定后配置返回; 可能的返回值列表: 蓝海活动标识:bluesea_1 |
bluesea_1 |
settlement_id | String | 选填 | 64 | 支付清算编号,用于清算对账使用; 只在银行间联交易场景下返回该信息; |
2018101610032004620239146945 |
business_params | String | 选填 | 512 | 商户传入业务信息,具体值要和支付宝约定 将商户传入信息分发给相应系统,应用于安全,营销等参数直传场景 格式为json格式 |
{"data":"123"} |
buyer_user_type | String | 选填 | 18 | 买家用户类型。CORPORATE:企业用户;PRIVATE:个人用户。 | PRIVATE |
mdiscount_amount | String | 选填 | 11 | 商家优惠金额 | 88.88 |
discount_amount | String | 选填 | 11 | 平台优惠金额 | 88.88 |
buyer_user_name | String | 选填 | 128 | 买家名称; 买家为个人用户时为买家姓名,买家为企业用户时为企业名称; 默认不返回该信息,需与支付宝约定后配置返回; |
菜鸟网络有限公司 |