Official Account ID

appid

String(32)

Yes

Specifies Official Account ID assigned by WeChat.
Example: Wx1378acui7865dt65

Merchant ID

mch_id

String(32)

Yes

Specifies merchant ID assigned by WeChat Pay
Example: 12567876549

Sub Merchant ID

sub_mch_id

String(32)

Yes

The merchant ID assigned by WeChat Pay for the sub-merchant
1.For direct merchants or institutions, this field is not required
2.For service providers, this field is required
Note: Only for Institutional mode
Example: 12567876549

Settlement Status

usetag

int

Yes

Indicates the fund has been settled or is still outstanding:
1 - settled
2 – outstanding
Example: 1

Random String

nonce_str

String(32)

Yes

A random string of less than 32 chars. For more information, see Random String Algorithm.
Example: Uihu276jjghxlehu38764409322

Offset

offset

int

Yes

Returned query data starts from this offset value
Example: 0

Max Records

limit

int

Yes

The number of returned records (generally less than 10)
Example: 10

Start Date

date_start

String(14)

Yes

In the format of yyyyMMdd. For example, December 25, 2009 is expressed as 20091225 in the time zone (GMT+8). For more information, see Time Protocol.
Example: 20150807

End Date

date_end

String(14)

Yes

In the format of yyyyMMdd. For example, December 25, 2009 is expressed as 20091225 in the time zone (GMT+8). For more information, see Time Protocol.
Example: 20150807

Whether to query funds-distribution settlement information

query_split

bool

No

or merchants with enabled funds-distribution permission, if query_split is true, the funds-distribution settlement field will be added to the returned information; merchants without funds-distribution permission do not need to check this field.
Example：true

Signature

sign

String(64)

Yes

Specifies a signature. For more information, see Signature Algorithm.
Example: 8439EBD8AE7422590E2004D0C5EBFFBC

Return Status Code

return_code

String(16)

Yes

SUCCESS/FAIL
Specifies communicating label (not 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 returned data is not empty,  the returned data is the error description of the following:

• 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 Pay
Example: wx8888888888888888

Sub Merchant ID

sub_mch_id

String(32)

Yes

Specifies sub merchant ID assigned by WeChat Pay
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

Indicates a random string of less than 32 chars
Example: 5K8264ILTKCH16CQ2502SI8ZNMTM67VS

Service Result

result_code

String(16)

Yes

SUCCESS/FAIL
Example: SUCCESS

Error Code

err_code

String(32)

No

ORDERNOTEXIST: Order does not exist
SYSTEMERROR: System error
Example: SYSTEMERROR

Error Code Description

err_code_des

String(128)

No

Describes result data
Example: System error

Return Data Lines

record_num

String(10)

Yes

Indicates the number of lines of return data. And the following fields would be returned when result_code is SUCCESS and record_num is not 0.

Foreign Payment Batch Number

fbatchno

String(32)

Yes

Indicates the batch number of foreign payment
Example: 10

Settlement Date

date_settlement

String(14)

Yes

In the format of yyyyMMdd. For example, December 25, 2009 is expressed as 20091225 in the time zone (GMT+8).
Example: 20091225

Transaction Start Date

date_start

String(14)

Yes

In the format of yyyyMMdd. For example, December 25, 2009 is expressed as 20091225 in the time zone (GMT+8).
Example: 20091225

Trasanction End Date

date_end

String(14)

Yes

In the format of yyyyMMdd. For example, December 25, 2009 is expressed as 20091225 in the time zone (GMT+8).
Example: 20091225

Remit Amount

settlement_fee

String(32)

Yes

Priced in foreign currency at the minimum trading unit
Example: 1

Non-Remit Amount

unsettlement_fee

String(32)

Yes

Priced in foreign currency at the minimum trading unit
Example: 1

Settlement Currency

settlementfee_type

String(8)

Yes

Comply with ISO 4217 standards and use CNY for Chinese currency by default.
Notes: The currency type for payment and refund shall be the same.
Example: GBP

Payment Amount

pay_fee

int

Yes

Priced in foreign currency at the minimum trading unit
Example: 1

Refund Amount

refund_fee

int

Yes

Priced in foreign currency at the minimum trading unit
Example: 1

Net Payment Amount

pay_net_fee

int

Yes

Priced in foreign currency at the minimum trading unit
Example: 1

Charge Amount

poundage_fee

int

Yes

Priced in foreign currency at the minimum trading unit
Example: 1

Funds-distribution transfer amount

split_settlement_fee

int

No

foreign currency price, in the minimum unit of foreign currency. The information will be returned when the merchant enables funds-distribution permission, [query_split=true], and [usetag=1].
Example：1

Not-transferred amount in funds-distribution

split_unsettlement_fee

int

No

Not-transferred amount in funds-distribution: foreign currency price, in the minimum unit of foreign currency. The information will be returned when the merchant enables funds-distribution permission, [query_split=true], and [usetag=2].
Example：1