基本参数

service

接口名称

String

接口名称。

不可空

alipay.fund.auth.create.voucher

partner

合作者身份ID

String(16)

签约的支付宝账号对应的支付宝唯一用户号。

以2088开头的16位纯数字组成。

不可空

2088001159940003

_input_charset

参数编码字符集

String

商户网站使用的编码格式，如utf-8、gbk、gb2312等。

不可空

GBK

sign_type

签名方式

String

RSA或MD5，必须大写。

不可空

RSA

sign

签名

String

请参见“签名机制”。

不可空

_p_w_l_h_j0b_gd_aejia7n_ko4_m%252Fu_w_jd3_nx_s_k_mxus9_hoxg_y_r_lunli_pmma29_t_q%3D%3D

notify_url

服务器异步通知页面路径

String(200)

支付宝服务器主动通知商户网站里指定的页面http路径。

可空

http://www.test.com/alipay/notify_url.php

业务参数

out_order_no

商户授权资金订单号

String(64)

商户的授权资金订单号。

同一商户不同的订单，商户授权资金订单号不能重复。

不可空

20140216001

out_request_no

商户请求流水号

String(64)

商户本次资金操作的请求流水号。

同一商户每次不同的资金操作请求，商户请求流水号不能重复。

不可空

20140216001001

product_code

业务产品码

String(50)

对应销售产品，商户签约时由支付宝统一分配。花呗预授权的业务产品码是 FUND_PRE_AUTH

不可空

FUND_PRE_AUTH

scene_code

业务场景码

String(50)

对应业务场景，商户签约时由支付宝统一分配。花呗预授权的业务产品码是HOTEL

不可空

HOTEL

order_title

订单标题

String(100)

业务订单的简单描述，如商品名称等。

长度不超过100个字母或50个汉字。

不可空

大床房一晚

amount

冻结金额

String

需要冻结的金额，单位为：元（人民币）。

取值范围：[0.01,100000000.00]。

不可空

4800.00

payee_logon_id

收款方支付宝账号

String(100)

收款方支付宝账号（Email或手机号）。

如果payee_user_id非空则优先以payee_user_id获取用户信息，否则根据该字段获取用户信息自动补全payee_user_id。payee_logon_id与payee_user_id不能同时为空。

可空

test@alipay.com

payee_user_id

收款方支付宝用户号

String(32)

收款方支付宝账号对应的支付宝唯一用户号。

以2088开头的16位纯数字组成。

如果非空则会在支付时校验交易的的收款方与此是否一致。

payee_logon_id与payee_user_id不能同时为空。

可空

2088102000275795

pay_timeout

支付超时

String

付款方超过该时间未付款，则自动关闭订单，不允许付款。

取值范围：1m～15d。

格式：m-分钟，h-小时，d-天。比如15点创建的订单，如果超时传1d，则到第二天15点超时。

如果为空，则默认超时为7d。

可空

2d

expire_time

业务到期时间

String

订单到期时间，只做展示用，到期支付宝不自动解冻剩余资金。

格式：YYYY-MM-DD HH:MM。

可空

2015-01-01 00:00

extra_param

业务扩展参数

String(300)

用于商户的特定业务信息的传递，json格式。

参见业务扩展参数

可空

{"appId":"123","merchantExt":"key1=value1,key2=value2"}

参数

参数名称

类型（长度范围）

参数说明

是否为空

样例

appId

公众账号ID

String

支付宝钱包中公众服务ID。

用户在手机钱包内完成预授权操作后，可以跳转到商户自己的公众账号中。

可空

123

merchantExt

商户扩展信息

String

商户的扩展信息，会在查询资金授权订单时返回给商户。

只有商户与支付宝约定了传递此参数且约定了参数含义，此参数才有效。

建议格式：key1=value1,key2=value2

可空

key1=value1,key2=value2

基本参数

is_success

是否成功

String

请求是否成功。请求成功不代表业务处理成功。

l  T代表成功

l  F代表失败

不可空

T

sign

签名

String

请参见“签名机制”。

可空

8d34527bb746762b5ddc764e7fdea9af

sign_type

签名方式

String

RSA或MD5，必须大写。

可空

MD5

error

错误代码

String

l  请求成功时，不存在本参数；

l  请求失败时，本参数为错误代码，参见“接入错误码”和“系统错误码”。

可空

ILLEGAL_SIGN

业务参数

result_code

处理结果码

String

处理结果代码。当处理结果码不是SUCCESS时，其他业务参数均可能为空！。

请参见“资金授权订单创建并发码业务处理结果码”。

不可空

SUCCESS

result_message

处理结果描述

String

详细描述处理失败的原因。

请参见“资金授权订单创建并发码业务处理结果码”中的“含义”。

可空

非法参数

out_order_no

商户授权资金订单号

String(64)

商户的授权资金订单号。

不可空

20140216001

out_request_no

商户请求流水号

String(64)

商户本次资金操作的请求流水号。

不可空

20140216001001

voucher_type

凭证类型

String(20)

目前仅支持：qrcode（二维码）。

不可空

qrcode

voucher_value

凭证内容

String(128)

凭证的内容。如果凭证类型为二维码，则内容为二维码码串。

不可空

https://qr.alipay.com/aar25omxde6uaduc01995f

voucher_url

目标地址

String

根据预下单模式返回的地址。如：二维码地址、钱包唤醒地址等。

不可空

https://tfsimg.alipay.com/images/mobilecodec/T1aNRcXg0fXXXXXXXX

基本参数

notify_time

通知时间

Date

通知的发送时间。格式：YYYY-MM-DD HH:MM:SS。

不可空

2009-08-12 11:08:32

notify_type

通知类型

String

通知的类型。本接口为固定值fund_auth_freeze（资金授权订单冻结通知）。

不可空

fund_auth_freeze

notify_id

通知校验ID

String

通知校验ID。

不可空

df35c47ed9df1fe4157a555e5c1f4a39

sign_type

签名方式

String

签名方式如DSA、RSA、MD5。

不可空

DSA

sign

签名

String

请参见“签名机制”。

不可空

b1af584504b8e845ebe40b8e0e733729

业务参数

auth_no

支付宝资金授权订单号

String(64)

支付宝资金授权订单号。

不可空

2014021601002000640012345678

out_order_no

商户授权资金订单号

String(64)

商户的授权资金订单号。

不可空

20140216001

total_freeze_amount

累计冻结金额

String

订单累计的冻结金额，单位为：元（人民币）。

不可空

4800.00

total_unfreeze_amount

累计解冻金额

String

订单累计的解冻金额，单位为：元（人民币）。

不可空

0.00

total_pay_amount

累计支付金额

String

订单累计用于支付的金额，单位为：元（人民币）。

不可空

0.00

rest_amount

剩余冻结金额

String

订单总共剩余的冻结金额，单位为：元（人民币）。

不可空

4600.00

order_status

支付宝订单状态

String(20)

支付宝订单的状态。

目前包括：

l  INIT：初始

l  AUTHORIZED：已授权

l  FINISH：完成

l  CLOSED：关闭

不可空

AUTHORIZED

operation_id

支付宝资金操作流水号

String

支付宝资金操作流水号。

不可空

2014021601002001640087654321

out_request_no

商户请求流水号

String

商户本次资金操作的请求流水号。

不可空

20140216001001

operation_type

操作类型

String

支付宝资金操作类型。

本接口为FREEZE（冻结）。

不可空

FREEZE

amount

冻结金额

String

本次操作冻结的金额，单位为：元（人民币）。

不可空

4800.00

status

操作流水状态

String

资金操作流水的状态。

目前支持：

l  INIT：初始

l  PROCESSING：处理中

l  SUCCESS：成功

l  FAIL：失败

l  CLOSED：关闭

不可空

SUCCESS

gmt_create

操作创建时间

String

资金授权单据操作创建时间。

格式：YYYY-MM-DD HH:MM:SS。

不可空

2014-01-01 20:00:00

payer_logon_id

付款方支付宝账号

String(100)

付款方支付宝账号（Email或手机号）。

仅作展示使用，默认会加“*”号处理。

可空

ali*@alipay.com

payer_user_id

付款方支付宝用户号

String(32)

付款方支付宝账号对应的支付宝唯一用户号。

以2088开头的16位纯数字组成。

可空

2088402019148643

payee_logon_id

收款方支付宝账号

String(100)

如果操作类型为支付，该字段标识当前操作收款方支付宝账号（Email或手机号）。

商户请求支付时传递给交易的收款方信息。

可空

test*@alipay.com

payee_user_id

收款方支付宝用户号

String(32)

如果操作类型为支付，该字段标识当前操作收款方支付宝账号对应的支付宝唯一用户号。

以2088开头的16位纯数字组成。

商户请求支付时传递给交易的收款方信息。

可空

2088400012341234

target_order_no

目标业务单据号

String(64)

当操作类型为支付时，该字段标识该笔资金用于支付交易的交易号。

可空

2014010111001004390000105126

target_order_type

目标业务单据类型

String(20)

当操作类型为支付时，该字段标识target_order_no的类型。

目前仅支持TRADE_NO（交易号）。

可空

TRADE_NO

gmt_trans

操作处理成功时间

String

支付宝账务处理成功时间。

格式：YYYY-MM-DD HH:MM:SS。

可空

2014-01-01 20:00:00