alipay.acquire.query

Environment

HTTPS request URL

Production environment

https://intlmapi.alipay.com/gateway.do

Test environment

https://mapi.alipaydev.com/gateway.do

service

String Required

Service Name

Example:alipay.acquire.query

partner

String(16)

Partner ID that is composed of 16 digits beginning with 2088.

Example:2088101125328850

_input_charset

String Required

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

Example:UTF-8

sign_type

String Required

Sign type. DSA, RSA, and MD5 are supported. Use uppercase.

Example:RSA

sign

String Required

Sign value

Example:31a008138e2f26a6414119984553e538

alipay_ca_request
String

Signature type.

• 1: Certificate signature
• 2: Other key signatures

If this is null, the default value shall be 2.

Example:2

Business parameters

out_trade_no

String(64) Required

Unique order No. in Alipay’s merchant’s website

Example:HZ0120131127001

trade_no
String(64)

The trade serial number of the trade in Alipay system.16 bits at least and 64 bits at most. If out_trade_no and  trade_no are transmitted at the same time, trade_no shall govern.

Example:2013112611001004680 073956707

is_success
String Required

Request succeeds or not. Successful request does not mean the business is accepted and processed successfully.

• T means success
• F means failure

Example:T

sign_type

String

Sign type. DSA, RSA, and MD5 are supported. Use uppercase.

Example:MD5

sign
String

Sign value

Example:630c9331f0946bde8e164564d1f7aeeb

error
String

• This parameter does not exist if request succeeds;
• This parameter will be error code if request fails. Please refer to Access Errors and System Errors.

Example:ILLEGAL_SIGN

result_code
String(32) Required

Response code of refund processing result.

• SUCCESS: successful refund
• FAIL: unsuccessful refund
• UNKNOWN: unknown result

Example:SUCCESS

trade_no
String(64)

Trade number of the trade in Alipay system16 bits at least and 64 bits at most

Example:2013111511001004390000105126

out_trade_no
String(64)

Unique order ID in order system in corresponding merchant’s website other than Alipay trade number.Uniqueness of this parameter in merchant’s website shall be guaranteed. This is a parameter transmitted upon corresponding request, which shall be returned in its original shape.

Example:3406822113320232

buyer_user_id
String(24)

Unique Alipay user ID corresponding to Buyer’s Alipay logon ID.16 numbers beginning with 2088

Example:2088102114647394

buyer_logon_id
String(100)

Buyer’s Alipay logon ID, may be email or phone number.

Example:ali***@alitest.com

partner
String(16)

Unique Alipay user number corresponding to authorized Alipay account number. Composed of 16 numbers beginning with 2088.

Example:2088101126765726

trade_status
String(32)

Current trade status.

Example:TRADE_CLOSED

detail_error_code
String(48)

Give cause description to the response code returned. Please refer to Business errors. If the response code of result_code is SUCCESS, this parameter shall not be returned.

Example:TRADE_NOT_EXIST

detail_error_des
String(64)

Give literal statement as to the detailed error code. If the response code of result_code is S UCCESS, this parameter shall not be returned.

Example:TRADE_NOT_EXIST

fund_bill_list
List

Information about the payment channel used in this trade shall be in the format of xml and may include the child node (<TradeFundBill>) of muti-channel information. Please refer to fund_bill_list. If the list of payment documents is required to be returned, partner and Alipay shall reach an agreement on return upon signing contract; the system gives tacit consent to not return this parameter.

Example:See Response sample

total_fee
String

Order amount paid in this trade, unit: RMB (Yuan).

Example:20

total_price
Number

The pricing in foreign currency. If the transaction is priced in RMB, this parameter is null

Example:10

currency
String(8)

The currency used for settlement.

Example:CNY

trans_currency
String(8)

Pricing currency of the transaction

Example:CNY

exchange_rate
String

Exchange rate of foreign currency and CNY (RMB).

Example:6.0939

send_pay_date
String

The time of transferring payment to seller’s account, format: yyyy-MM-dd HH:mm:ss.

Example:2014-07-21 11:43:42

extend_info_list
Object

The extend information list of the trade, XML format, can include multiple extension child node<ExtendInfo>. The Child node please refer to extend_info_list.

Example:See Response sample

fund_channel
String

Payment channel, please refer to Payment Channels.

Example:10

amount
String

Amount paid through the designated payment channel, Unit: Yuan

Example:70.00

Key
String Required

Now only support:

• SHOP_ID: The serial number of brands store that under the shop.
• TERMINAL_ID: terminal device id.

Example:SHOP_ID

Value
String

The value of  extend information

Example:BJ_ZZ_001

Authorization number is wrong for which the possible reasons include:

• The merchant owning the authorization number is not the same as the request merchant;
• The payer owning the authorization number is not the same as the request payer;
• The available capital under the authorization number is less than the request unlocked capital;
• The status of the authorization number is not authorized;

The receiver owning the authorization number is not the same as the request receiver.

• Trade closed whose payment has not been completed within specified time;
• Trades closed whose payment has been fully returned when the trade completes.