Official Account ID

appid

String(32)

Yes

Specifies an Official Account ID assigned by WeChat
Example：wx8888888888888888

Merchant ID

mch_id

String(32)

Yes

Specifies merchant ID assigned by WeChat Payment
Example：1900000109

Sub Official Account ID

sub_appid

String(32)

No

Specifies an Sub Official Account ID assigned by WeChat.
Specifies Sub merchant ID of institution's sub-merchant assigned by WeChat Pay
Note: Only for Institutional mode
Example：wx8888888888888888

Sub  Merchant ID

sub_mch_id

String(32)

Yes

Specifies Sub merchant ID assigned by WeChat Payment
Specifies Sub merchant ID of institution's sub-merchant assigned by WeChat Pay
Note: Only for Institutional mode
Example：1900000109

WeChat Order Number

transaction_id

String(32)

Choose one to submit

WeChat order number is preferred.

Example: 4200000000002104083200000488

Merchant Order Number

out_trade_no

String(32)

Specifies an internal order number created by the Merchant's system. This field is required when transaction_id is not provided.
Example: 1217752501201407033233368018

Random string

nonce_str

String(32)

Yes

32 characters or fewer. For more information, see Random String Algorithm .
Example：5K8264ILTKCH16CQ2502SI8ZNMTM67VS

Signature

sign

String(64)

Yes

Specifies a signature. For more information, see Signature Algorithm .
Example：C380BEC2BFD727A4B6845133519F3AD6

Sign type

sign_type

String(32)

No

Currently HMAC-SHA256 and MD5 are supported, default is MD5. This field is only required when sign_type is HMAC-SHA256.
Example：HMAC-SHA256

Return Status Code

return_code

String(16)

Yes

Set to SUCCESS or FAIL
Specifies communicating label instead of transaction label. The status of the transaction is determined by the value of the result_code field.
Example：SUCCESS

Return Data

return_msg

String(128)

No

If not empty, this is the error description. If not empty, this is the error description
Signature Failure
Parameter format checking error
Example：Signature Failure

Official Account ID

appid

String(32)

Yes

The Official Account ID submitted when calling the interface
Example：wx8888888888888888

Merchant ID

mch_id

String(32)

Yes

The Merchant ID submitted when calling the interface
Example：1900000109

Sub Official Account ID

sub_appid

String(32)

No

The Sub Official Account ID submitted when calling the interface
Specifies Sub merchant ID of institution's sub-merchant assigned by WeChat Pay
Note: Only for Institutional mode
Example：wx8888888888888888

Sub  Merchant ID

sub_mch_id

String(32)

Yes

The Sub Merchant ID submitted when calling the interface
Specifies Sub merchant ID of institution's sub-merchant assigned by WeChat Pay
Note: Only for Institutional mode
Example：1900000109

Random String

nonce_str

String(32)

Yes

32 characters or fewer
Example: 5K8264ILTKCH16CQ2502SI8ZNMTM67VS

Signature

sign

String(64)

Yes

Specifies a signature. For more information, see Signature Algorithm .
Example：C380BEC2BFD727A4B6845133519F3AD6

Service Result

result_code

String(16)

Yes

Set to SUCCESS or FAIL
Example：SUCCESS

Error Code

err_code

String(32)

No

Please refer to Error Codes
Example：SYSTEMERROR

Error Code Description

err_code_des

String(128)

No

The detailed description of error
Example：System error

Device ID

device_info

String(32)

No

Specifies the ID of the terminal device with from which the Merchant submitted their order
Example: 013467007045764

User Tag

openid

String(128)

Yes

Specifies the user id of the Payer provided by the WeChat system, it is unique to each appid instance.
About how to get openid, please refer to get openid api.
Example: wxd930ea5d5a258f4fo

Follows Official Account or not

is_subscribe

String(1)

No

For users who pay for transactions related to an official account, the value in this field states whether the user is current following the official account
Y: Follows
N: Doesn’t follow
Example: Y

Sub User Tag

sub_openid

String(128)

No

Specifies the user id of the Payer provided by the WeChat system, it is unique to each appid instance.
Specifies Sub merchant ID of institution's sub-merchant assigned by WeChat Pay
About how to get sub_openid, please refer to get openid api.
Note: Only for Institutional mode
Example: wxd930ea5d5a258f4f

Follows Sub Official Account or not

sub_is_subscribe

String(1)

Yes

For users who pay for transactions related to an sub official account, the value in this field states whether the user is current following the official account
Y: Follows
N: Doesn’t follow
Specifies Sub merchant ID of institution's sub-merchant assigned by WeChat Pay
Note: Only for Institutional mode
Example: Y

Transaction Type

trade_type

String(16)

Yes

The transaction type submitted. The value could be JSAPI, NATIVE, or APP.
Example: JSAPI

Transaction Status

trade_state

String(32)

Yes

1.SUCCESS: Payment successful

2.REFUND: Order to be refunded

3.NOTPAY: Order not paid

4.CLOSED: Order closed

5.REVOKED: Order revoked

6.USERPAYING: Awaiting user topay

7.PAYERROR: Payment failed (payment status failed to be returned by bank or other reasons).

Example: SUCCESS

Payment Bank

bank_type

String(32)

Yes

String states bank_type.
Example: CMC

Total Amount

total_fee

int

Yes

Specifies the total amount for a transaction. For more information, see Payment Amount.
Example: 100

Currency Type

fee_type

String(8)

No

Complies with ISO 4217 standards and uses 3 characters based code. For more information, see Currency Type.
Example: USD

Cash Payment Amount

cash_fee

int

Yes

Specifies the total cash payment amount of a transaction. For more information, see Payment Amount.
Example: 100

Cash Type

cash_fee_type

String(16)

Yes

Complies with ISO 4217 standards and uses CNY (Chinese yuan) by default. For more information, see Currency Type.
Example: CNY

WeChat Order Number

transaction_id

String(32)

Yes

Specifies the WeChat payment order id
Example: 4200000000002104083200000488

Merchant Order Number

out_trade_no

String(32)

Yes

Specifies the order number created within the Merchants' system, which is consistent with request.
Example: 1217752501201407033233368018

Merchant's Data Package

attach

String(128)

No

Specifies merchant's data package, which is returned as it is.
Example: 123456

Payment End Time

time_end

String(14)

Yes

Specifies transaction creation time in the format of yyyyMMddHHmmss, such as 20091225091010 for Dec 25, 2009 09:10:10. For more information, see Section 4.2 Time Protocol.
Example: 20141030133525

Description of Trade Status

trade_state_desc

String(256)

Yes

Description of the current transaction status and guild for the next step.
Example: Payment failed, please create a new order

Exchange Rate

rate

String(16)

Yes

The value is 10 to the 8th power times of the exchange rate from foreign currency to RMB. For example, the exchange rate from foreign currency to RMB is 6.5, the value will be 650000000
Example: 650000000

ORDERNOTEXIST

This order does not exist.

This order number does not exist in the query system.

This API only helps query successfully paid transactions. The Merchant should check whether the provided transaction ID is correct.

SYSTEMERROR

System error

Exception occurs when data is returned from backend.

This is caused by system error. Try to query again.