alipay.fund.auth.order.freeze

2021-02-24 07:50

Call the alipay.fund.auth.order.freeze interface to unfreeze full or partial amount of funds.

Request

Service address

Environment	HTTPS request URL
Production environment	https://globalopenapi.alipay.com/gateway.do
Test environment	https://openapi.alipaydev.com/gateway.do

Request parameters

Parameter

Description

Basic parameter

app_id

String (32) Required

The unique ID that is assigned by Alipay to identify an application.

Example: 2014072300007148

method

String (128) Required

Interface name

Example: alipay.fund.auth.order.freeze

format

String (40)

Only JSON is supported.

Example: JSON

charset

String (10) Required

The charset with which the request data is encoded. GBK and UTF-8 are supported.

Example: UTF-8

sign_type

String (10) Required

Signature type. RSA and RSA2 are supported. Use uppercase.

Example: RSA2

sign

String (344) Required

Signature value

timestamp

String (19) Required

The time when the merchant server sends the request. The format is yyyy-mm-dd hh:mm:ss.

Example: 2020-07-24 03:07:50

version

String (3) Required

The API version. The value is fixed as 1.0.

Example: 1.0

notify_url

String (256)

The URL for receiving asynchronous notifications after the pre-auth is completed.

Example: http://api.test.alipay.net/atinterface/receive_notify.htm

app_auth_token

String (40)

To query authorization information.

Example: 201510BBaabdb44d8fd04607abf8d5931ec75D84

Note: After a merchant authorizes an ISV to use certain APIs, Alipay will assign an app_auth_token to the ISV. The ISV can use this interface to query the authorization information such as the authorizer and authorized APIs corresponding to the app_auth_token. For more details, see Overview of the app authorization (in Mandarin).

biz_content

String Required

Collection of request parameters. The maximum length is not limited. Except for common parameters, all other request parameters must be passed in to this parameter.

Business parameter

auth_no

String (64) Required

Payment authorization code

Example: 287634438256649999

out_request_no

String (64) Required

The serial number of a merchant's funds pre-auth request. The number must be unique at the merchant end.

Example: ABC8077735255938032

amount

Price(11) Required

Frozen amount

Example: 150.00

remark

String(100) Required

Operation description.

Example: Unfreeze without reason.

Response

Synchronous response

Parameter

Description

Basic parameter

code

String (16) Required

The gateway return code, which indicates whether the request is accepted by Alipay gateway.

Example: 10000

msg

String (32) Required

Description of the gateway return code

Example: Business Failed

sub_code

String (16)

Processing result of the request

Example: isv.invalid-signature

sub_msg

String (64)

Description of the processing result of the request

sign

String (344) Required

The sign value. See Signature for details.

Business parameter

auth_no

String(64) Required

Payment authorization code

Example: 287634438256649999

out_order_no

String (64) Required

The transaction number of funds pre-auth assigned by merchant system.

Example: 4977164666634053

out_request_no

String (64) Required

The serial number of a merchant's funds pre-auth request. The number must be unique at the merchant end.

Example: ABC8077735255938032

operation_id

String(64) Required

The serial number of funds operation assigned by Alipay.

Example: 2014070800032850551

amount

Price (11) Required

Frozen amount

Example: 150.00

status

String(20) Required

Status of the funds operation. Possible values include:

SUCCESS
CLOSED

Example: SUCCESS

gmt_trans

Date (20)

The time when the authorized funds unfreeze successfully. The format is yyyy-mm-dd hh:mm:ss.

Example: 2020-09-15 11:23:04

credit_amount

Price (11)

Credit amount. The unit is RMB.

Example: 100.00

fund_amount

Price (11)

Balance amount. The unit is RMB.

Example: 100.00

Asynchronous response

Parameter

Description

auth_no

String (64) Required

The transaction number of funds pre-auth assigned by Alipay, which is composed of 28 digits.

Example: 201808077735255938

operation_id

String (64) Required

The serial number of funds operation assigned by Alipay.

Example: 2014070800032850551

out_order_no

String (64) Required

The transaction number of funds pre-auth assigned by merchant.

Example: 4977164666634053

out_request_no

String (64) Required

The serial number of funds operation request assigned by merchant.

Example: 2014070700166653

operation_type

String (20) Required

Funds operation type. Possible values include:

FREEZE
UNFREEZE
PAY

Example: FREEZE

amount

Price (11) Required

The total amount of funds frozen in the transaction currency, rounded to 2 decimal places.

Example: 100.00

status

String (20) Required

Status of the funds pre-auth. Possible values are:

INIT
SUCCESS
CLOSED

Example: SUCCESS

payer_user_id

String (32) Required

Payer's Alipay user ID

Example: 2088102000275885

payer_logon_id

String (100) Required

The payer's Alipay login ID, email, or phone number are supported.

Example: email@example.com

gmt_trans

Date Required

The time when the funds pre-auth changed. The format is yyyy-mm-dd hh:mm:ss. Use GMT+8.

Example: 2020-09-15 11:23:04

gmt_create

Date Required

The time when the funds pre-auth succeed. The format is yyyy-mm-dd hh:mm:ss.

Example: 2020-09-15 11:23:04

total_freeze_amount

String (11) Required

The total frozen amount. The unit is the transaction currency used when the funds were frozen.

Example: 100.00

total_unfreeze_amount

String (11) Required

The total unfrozen amount. The currency is the transaction currency used when the funds were frozen.

Example: 20.00

total_pay_amount

String (11) Required

The total paid amount. The currency is the transaction currency used when the funds were frozen.

Example: 80.00

rest_amount

String (11) Required

The total paid amount. The currency is the transaction currency used when the funds were frozen.

Example: 20.00

credit_amount

String (11) Required

The credit amount. The currency is RMB.

Example: 10.00

fund_amount

String (11) Required

The balance amount. The currency is RMB.

Example: 10.00

total_freeze_credit_amount

String(11) Required

Total frozen credit amount. The currency is RMB.

Example:10.00

Total_freeze_fund_amount

String(11) Required

Total frozen balance amount. The currency is RMB.

total_unfreeze_credit_amount

String(11) Required

Total unfrozen credit amount. The currency is RMB.

Example:10.00

total_unfreeze_fund_amount

String(11) Required

Total unfrozen balance amount. The currency is RMB.

Example:10.00

total_pay_credit_amount

String(11) Required

Total paid credit amount. The currency is RMB.

Example:10.00

total_pay_fund_amount

String(11) Required

Total paid balance amount. The currency is RMB.

Example:10.00

rest_credit_amount

String(11) Required

Rest credit amount. The currency is RMB.

Example:10.00

rest_fund_amount

String(11) Required

Rest balance amount. The currency is RMB.

Example:10.00

Notification trigger condition

Trigger condition name	Description	Note
fund_auth_unfreeze	Pre-auth fund is unfrozen.	true (trigger notification)

Error codes

Error Code	Description
ILLEGAL_ARGUMENT	The parameter is incorrect. Check each request parameter according to the API specification. For cashier, get the customer to refresh the payment code and try the pre-auth again.
UNIQUE_VIOLATION	Repeated order number. Get the cashier to cancel the order and retry.
SYSTEM_ERROR	System error
PAYER_USER_STATUS_LIMIT	Abnormal customer account
AUTH_ORDER_NOT_EXIST	The pre-auth order does not exist.
REQUEST_AMOUNT_EXCEED	The unfreezing amount exceeds the frozen amount.
ILLEGAL_STATUS	Illegal order status
ORDER_ALREADY_FINISH	Order completed
ORDER_ALREADY_CLOSED	Order closed