Alipay, China's leading third-party online payment solutionAlipay, China's leading third-party online payment solution

alipay.fund.auth.operation.detail.query

Call the alipay.fund.auth.operation.detail.query interface to query detailed information of a funds pre-auth operation.

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)

The pre-auth order number assigned by Alipay.

This parameter is required when out_order_no is not provided. If auth_no and out_order_no appear at the same time, auth_no takes precedence.

Example: 2014070800002001550000014417

operation_id

String (64)

The serial number of operation assigned by Alipay.

This parameter is required when out_request_no is not specified. If operation_id and out_request_no appear at the same time, operation_id takes precedence.

Example: 20161012405744018102

out_order_no

String (64)

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

This parameter is required when auth_no is not specified. If auth_no and out_order_no appear at the same time, auth_no takes precedence.

Example: 4977164666634053

out_request_no

String (64)

The serial number of a partner's funds pre-auth request. 

This parameter is required when operation_id is not specified. If operation_id and out_request_no appear at the same time, operation_id takes precedence.

Example: ABC8077735255938032

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

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

Example: 2014070800002001550000014417

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 system.

Example: 4977164666634053

out_request_no

String (64) Required

The serial number of funds operation request assigned by merchant system.

Example: 2014070700166653

order_title

String (100) Required

Transaction title

Example: PreAuth Trans

status

String(20) Required

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

  • INIT
  • SUCCESS
  • CLOSED

Example: SUCCESS

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

remark

String (100) Required

Operations description

gmt_create

Date (20) Required

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

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

gmt_trans

Date (20) Required

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

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

payer_user_id

String (32) Required

Payer's Alipay user ID.

Example: 2088102000275885

payee_logon_id

String (100) Required

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

Example: email@example.com

pre_auth_type

String (32)

Pre-auth type. Only CREDIT_AUTH is supported now.

Example: CREDIT_AUTH

total_freeze_amount

Price(decimal)11b(9.2) Required

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

Example: 100.00

total_unfreeze_amount

Price(decimal)11b(9.2) Required

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

Example: 20.00

total_pay_amount

Price(decimal)11b(9.2) Required

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

Example: 80.00

rest_amount

Price(decimal)11b(9.2) Required

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

Example: 20.00

trans_currency

String (8) Required

The pricing currency. Use uppercase.

Example: USD

extra_param

String (300)

The extension parameter passed by the merchant when requesting the creation of the pre-auth order. Only the merchant-defined extension information (merchantExt) is returned.

Example: {"merchantExt":"key1=value1,key2=value2"}

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.

AUTH_ORDER_NOT_EXIST

The pre-auth order does not exist.

AUTH_OPERATION_NOT_EXIST

The Alipay fund operation number does not exist.

ACCESS_FORBIDDEN

You have no permission to query this order information.

SYSTEM_ERROR

System error