Return Status Code

return_code

String(16)

Yes

SUCCESS or FAIL
Specifies communicating label instead of transaction label. The status of a transaction is determined by the value of result_code.
Example: SUCCESS

Return Data

return_msg

String(128)

No

If not empty, this is the error description
Signature failure
Parameter format checking error
Example: Signature failure

Official Account ID

appid

String(32)

Yes

Specifies 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 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 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

Device ID

device_info

String(32)

No

Specifies the terminal device ID assigned by WeChat Payment
Example: 013467007045764

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

SUCCESS or FAIL
Example: SUCCESS

Error Code

error_code

String(32)

No

The error code returned
Example: SYSTEMERROR

Error Code Description

error_code_des

String(128)

No

The detailed error description returned.
Example: System error

User Tag

openid

String(128)

Yes

The user id of the Payer provided by the WeChat system in OpenID format as unique tag on merchant’s appid. Also it is unique to each appid instance.
About how to get openid, please refer to get openid api.
Example: wxd930ea5d5a258f4f

Follows Official Account or not

is_subscribe

String(1)

Yes

 Specifies whether the payer follows the associated official account or not, with Y meaning ‘follows’ and N meaning ’not follows’.
Example: Y

Sub User Tag

sub_openid

String(128)

No

The user id of the Payer provided by the WeChat system in OpenID format as unique tag on merchant’s appid. Also 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)

No

 Specifies whether the payer follows the associated official account or not, with Y meaning ‘follows’ and N meaning ’not follows’.
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

Set as JSAPI, NATIVE, or APP
Example: JSAPI

Payment Bank

bank_type

String(32)

Yes

Use strings for bank type. For more information, see attachments.
Example: CMC

Total Amount

total_fee

int

Yes

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

Currency Type

fee_type

String(8)

Yes

ISO-4217 standard compliant and be described by three characters based code. For more information, see Currency Type
Example: CNY

Cash Payment Amount

cash_fee

int

Yes

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

Cash Type

cash_fee_type

String(16)

No

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

Specifies the number of a WeChat payment order

transaction_id

String(32)

Yes

Specifies the WeChat payment order id number
Example: 1217752501201407033233368018

Merchant Order Number

out_trade_no

String(32)

Yes

Specifies an order number created by a Merchants' system, which is consistent with request.
Example: 1212321211201407033568112322

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 the time of completing payment in the format of yyyyMMddHHmmss, such as 20091225091010 for Dec 25, 2009 09:10:10. For more information, see Time Protocol.
Example: 20141030133525

Exchange Rate

rate_value

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

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