API REFERENCE

Brazil · Query collection

Endpoint, parameters and examples for Brazil: Query collection.

Endpoint#

POSThttps://YOUR_GATEWAY_HOST/Pay_Trade_query.html

application/x-www-form-urlencoded

Parameters#

Field	Requirement	Signed	Description
`pay_memberid`	Required	Yes	Merchant number shown in the panel, not the internal user ID.
`pay_orderid`	Required	Yes	Original merchant collection order ID. Query this ID, not the platform ID returned on creation.
`pay_md5sign`	Required	No	32-character uppercase MD5 signature; exclude this field from signing.

Field	Description
`memberid`	Merchant number shown in the panel, not the internal user ID.
`orderid`	Original merchant order ID.
`amount`	BRL amount; responses may use JSON numbers or strings without a fixed decimal format. Preserve the received value for verification.
`true_amount`	Recorded actual paid amount; older or unavailable data may be empty or zero.
`time_end`	Successful payment completion time, yyyy-MM-dd HH:mm:ss; not a completion time for unpaid orders.
`transaction_id`	Platform order or transaction ID.
`returncode`	Fixed "00" in normal queries; payment status depends on trade_state.
`trade_state`	NOTPAY: unpaid; SUCCESS: payment completed.
`sign`	32-character uppercase MD5 signature; exclude this field from signing.

Examples#

cURL · replace placeholders before use

curl --request POST 'https://YOUR_GATEWAY_HOST/Pay_Trade_query.html' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'pay_memberid=10000' \
  --data-urlencode 'pay_orderid=DEMO_PAYIN_001' \
  --data-urlencode 'pay_md5sign=CALCULATE_WITH_YOUR_APIKEY'

Request fields · submit as form

{
  "pay_memberid": "10000",
  "pay_orderid": "DEMO_PAYIN_001",
  "pay_md5sign": "CALCULATE_WITH_YOUR_APIKEY"
}

Response example

{
  "memberid": "10000",
  "orderid": "DEMO_PAYIN_001",
  "amount": "100.00",
  "true_amount": "100.00",
  "time_end": "2026-10-24 12:00:00",
  "transaction_id": "DEMO_PLATFORM_PAYIN",
  "returncode": "00",
  "trade_state": "SUCCESS",
  "sign": "CALCULATE_WITH_YOUR_APIKEY"
}

Response example

{
  "status": "error",
  "msg": "签名验证失败",
  "data": []
}

Signing & result handling#

Compute the signature over the operation-specific field set, not every example field.

Open signing guide