线上资金授权冻结接口

开发环境

http://dev-cn.your-api-server.com

POST

/v3/alipay/fund/auth/order/app/freeze

alipay.fund.auth.order.app

创建支付宝授权订单并完成资金冻结。适用于线上场景完成资金授权, 例如从商户APP端拉起支付宝收银台完成冻结。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/v3/alipay/fund/auth/order/app/freeze' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": "0.01",
    "business_params": "{\"outRiskInfo\":\"{\\\"mcCreateTradeTime\\\":\\\"2022-03-11 12:46:09\\\",\\\"extraAccountCertnoLastSix\\\":\\\"000011\\\",\\\"mobileOperatingPlatform\\\":\\\"ios\\\",\\\"sysVersion\\\":\\\"15.4.2\\\",\\\"mcCreateTradeIp\\\":\\\"11.110.111.43\\\"}\"}",
    "deposit_product_mode": "POSTPAY",
    "disable_pay_channels": "[{\"payChannelType\":\"OPTIMIZED_MOTO\"},{\"payChannelType\":\"BIGAMOUNT_CREDIT_CARTOON\"}]",
    "enable_pay_channels": "[{\"payChannelType\":\"PCREDIT_PAY\"},{\"payChannelType\":\"MONEY_FUND\"}]",
    "extra_param": "{\"category\":\"CHARGE_PILE_CAR\",\"serviceId\":\"2020042800000000000001450466\"}",
    "identity_params": "{\"identity_hash\":\"acc2b92ffc5ed9b472faa19748f10045c30434132784f774b00216a56b8841c6\"}",
    "notify_url": "string",
    "order_title": "XX租车押金",
    "out_order_no": "8077735255938023",
    "out_request_no": "8077735255938032",
    "pay_timeout": "2d",
    "payee_logon_id": "159****5620",
    "payee_user_id": "2088102000275795",
    "post_payments": [
        {
            "amount": "string",
            "description": "string",
            "name": "string"
        }
    ],
    "product_code": "PRE_AUTH_ONLINE",
    "scene_code": "OVERSEAS_ONLINE_AUTH_COMMON_SCENE",
    "settle_currency": "USD",
    "timeout_express": "2d",
    "trans_currency": "USD"
}'

响应示例

200 - 示例 1

{
  "amount": "0.01",
  "auth_no": "2014070800002001550000014417",
  "credit_amount": "0.01",
  "fund_amount": "0.01",
  "operation_id": "2014070800032850551",
  "out_order_no": "4977164666634053",
  "out_request_no": "2014070700166653",
  "payer_open_id": "03914IMEfXsS9K-tSvHy-IisrLlOfthFgDVo-hU30XtKPg9",
  "payer_user_id": "2088102000275885",
  "pre_auth_type": "CREDIT_AUTH",
  "status": "SUCCESS",
  "trans_currency": "USD",
  "gmt_trans": {}
}

请求参数

Body 参数application/json

amount

string

可选

需要冻结的金额，单位为：元（人民币），精确到小数点后两位。取值范围：[0.01,100000000.00]

示例值:

0.01

business_params

string

可选

业务参数，如风控参数outRiskInfo等。

示例值:

{"outRiskInfo":"{\"mcCreateTradeTime\":\"2022-03-11 12:46:09\",\"extraAccountCertnoLastSix\":\"000011\",\"mobileOperatingPlatform\":\"ios\",\"sysVersion\":\"15.4.2\",\"mcCreateTradeIp\":\"11.110.111.43\"}"}

deposit_product_mode

string

可选

免押受理台模式，使用免押产品必传该字段。根据免押不同业务模式将开通受理台区分三种模式，商家可根据调用预授权冻结接口传入的参数决定该笔免押订单选择哪种受理台模式。不同受理台模式需要传入不同参数，其中：POSTPAY 表示后付金额已知，POSTPAY_UNCERTAIN 表示后付金额未知，DEPOSIT_ONLY 表示纯免押。具体规则参考文档：https://opendocs.alipay.com/b/08tf3t?pathHash=d67d7545

示例值:

POSTPAY

disable_pay_channels

string

可选

无特殊需要请勿传入；商户可用该参数禁用支付渠道。传入后用户不可使用列表中的渠道进行支付，目前支持两种禁用渠道：信用卡快捷（OPTIMIZED_MOTO）、信用卡卡通（BIGAMOUNT_CREDIT_CARTOON）。与可用支付渠道不能同时传入

示例值:

[{"payChannelType":"OPTIMIZED_MOTO"},{"payChannelType":"BIGAMOUNT_CREDIT_CARTOON"}]

enable_pay_channels

string

可选

无特殊需要请勿传入；商户可用该参数指定支付渠道。传入后用户仅能使用列表中的渠道进行支付，目前支持三种渠道，余额宝（MONEY_FUND）、花呗（PCREDIT_PAY）以及芝麻信用（CREDITZHIMA）。与禁用支付渠道不可同时传入

示例值:

[{"payChannelType":"PCREDIT_PAY"},{"payChannelType":"MONEY_FUND"}]

extra_param

string

可选

业务扩展参数，用于特定业务信息的传递，json格式。 1、category，信用类目，信用预授权场景必传，具体类目信息见https://opendocs.alipay.com/open/10719； 2、serviceId，信用服务id，信用预授权场景必传，需要联系芝麻客服获取，https://cshall.alipay.com/enterprise/index.htm?sourceId=pc_zhima（右上角“有问题点我”进入咨询）； 3、creditExtInfo，信用参数，可选，如有需要请与芝麻约定后传入，信用服务说明见https://opendocs.alipay.com/open/11157/qlsxya

示例值:

{"category":"CHARGE_PILE_CAR","serviceId":"2020042800000000000001450466"}

identity_params

string

可选

无特殊需要请勿传入；买家实名信息。传入后支付宝会比对买家在支付宝端的实名信息。包含两个可选key： 1.identity_hash，买家姓名拼接身份证号后，使用SHA256摘要方式与UTF8编码后的hash值，返回的十六进制字符串，例如 “张三4566498798498498498498”对应的identity_hash应为“acc2b92ffc5ed9b472faa19748f10045c30434132784f774b00216a56b8841c6” 2.alipay_user_id，买家uid

示例值:

{"identity_hash":"acc2b92ffc5ed9b472faa19748f10045c30434132784f774b00216a56b8841c6"}

notify_url

string

通知地址

可选

order_title

string

可选

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

示例值:

XX租车押金

out_order_no

string

可选

商户授权资金订单号。商家自定义需保证在商户端不重复。仅支持字母、数字、下划线。

示例值:

8077735255938023

out_request_no

string

可选

商户本次资金操作的请求流水号，用于标示请求流水的唯一性。可与out_order_no相同，仅支持字母、数字、下划线。

示例值:

8077735255938032

pay_timeout

string

可选

预授权订单相对超时时间。从商户客户端请求时间开始计算。预授权订单允许的最晚授权时间，逾期将关闭该笔订单。取值范围：1m～15d。m-分钟，h-小时，d-天。该参数数值不接受小数点，如 1.5h，可转换为90m。默认为15m。

示例值:

payee_logon_id

string

可选

收款账户的支付宝登录号（email或手机号）。如果传入则会校验该登录号对应的账号是否具备当前商户收款权限，如果商户希望用户能够使用花呗，则用户号(payee_user_id)和登录号(payee_logon_id)两者必须传入其一

示例值:

159****5620

payee_user_id

string

可选

收款账户的支付宝用户号。以2088开头的16位纯数字，如果传入则会校验该账号是否具备当前商户收款权限，如果商户希望用户能够使用花呗，则用户号(payee_user_id)和登录号(payee_logon_id)两者必须传入其一

示例值:

2088102000275795

post_payments

array[object (PostPayment) {3}]

可选

后付费项目，有付费项目时需要传入该字段。不同受理台模式需要传入不同参数，后付费项目名称和计费说明需要通过校验规则，同时计费说明将展示在开通受理台上。当受理台模式（deposit_product_mode）传入POSTPAY 时，后付费项目名称（name）、金额（amount）必传，计费说明（description）选传；当传入 POSTPAY_UNCERTAIN 时，后付费项目名称（name）、计费说明（description）必传，金额（amount）不传。具体规则参考文档：https://opendocs.alipay.com/b/08tf3t?pathHash=d67d7545

amount

string

可选

后付费金额，单位为：元（人民币），精确到小数点后两位。

description

string

计费说明

可选

name

string

后付费项目名称

可选

product_code

string

可选

销售产品码。支付宝预授权产品固定为 PRE_AUTH_ONLINE

示例值:

PRE_AUTH_ONLINE

scene_code

string

可选

场景码，用于区分预授权不同业务场景。如：当面预授权通用场景（O2O_AUTH_COMMON_SCENE）、支付宝预授权通用场景（ONLINE_AUTH_COMMON_SCENE）、境外当面预授权通用场景（OVERSEAS_O2O_AUTH_COMMON_SCENE）、境外支付预授权通用场景（OVERSEAS_ONLINE_AUTH_COMMON_SCENE）等

示例值:

OVERSEAS_ONLINE_AUTH_COMMON_SCENE

settle_currency

string

可选

商户指定的结算币种。支持澳元：AUD, 新西兰元：NZD, 台币：TWD, 美元：USD, 欧元：EUR, 英镑：GBP

示例值:

USD

timeout_express

string

可选

示例值:

trans_currency

string

可选

标价币种, amount 对应的币种单位。支持澳元：AUD, 新西兰元：NZD, 台币：TWD, 美元：USD, 欧元：EUR, 英镑：GBP, 人民币：CNY

示例值:

USD

示例

返回响应

🟢200common response

application/json

Body

amount

string

可选

本次操作冻结的金额，单位为：元（人民币），精确到小数点后两位

示例值:

0.01

auth_no

string

可选

支付宝的资金授权订单号

示例值:

2014070800002001550000014417

credit_amount

string

可选

本次冻结操作中信用冻结金额，单位为：元（人民币），精确到小数点后两位

示例值:

0.01

fund_amount

string

可选

本次冻结操作中自有资金冻结金额，单位为：元（人民币），精确到小数点后两位

示例值:

0.01

operation_id

string

可选

支付宝的资金操作流水号

示例值:

2014070800032850551

out_order_no

string

可选

商户的授权资金订单号

示例值:

4977164666634053

out_request_no

string

可选

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

示例值:

2014070700166653

payer_open_id

string

可选

支付宝openId，用户（userId）在应用（appId）下的唯一用户标识。

示例值:

03914IMEfXsS9K-tSvHy-IisrLlOfthFgDVo-hU30XtKPg9

payer_user_id

string

付款方支付宝用户号

可选

示例值:

2088102000275885

pre_auth_type

string

可选

预授权类型，目前支持 CREDIT_AUTH(信用预授权); 商户可根据该标识来判断该笔预授权的类型，当返回值为"CREDIT_AUTH"表明该笔预授权为信用预授权，没有真实冻结资金；当返回值为空或者不为"CREDIT_AUTH"则表明该笔预授权为普通资金预授权，会冻结用户资金。

示例值:

CREDIT_AUTH

status

string

可选

资金预授权明细的状态目前支持：
INIT：初始 SUCCESS: 成功 CLOSED：关闭

示例值:

SUCCESS

trans_currency

string

可选

标价币种, amount 对应的币种单位。支持澳元：AUD, 新西兰元：NZD, 台币：TWD, 美元：USD, 欧元：EUR, 英镑：GBP, 人民币：CNY

示例值:

USD

gmt_trans

string

可选

资金授权成功时间格式：YYYY-MM-DD HH:MM:SS

示例值:

{}

🔴500请求失败

异步通知说明

资金授权解冻接口