API REFERENCE

Brazil · Account balance

Endpoint, parameters and examples for Brazil: Account balance.

Endpoint#

POSThttps://YOUR_GATEWAY_HOST/Payment_Dfpay_querybalance.html

application/x-www-form-urlencoded

Parameters#

Field	Requirement	Signed	Description
`mchid`	Required	Yes	Merchant number shown in the panel, not the internal user ID.
`pay_md5sign`	Required	No	32-character uppercase MD5 signature; exclude this field from signing.

Field	Description
`status`	API processing result, not the final financial outcome.
`msg`	API message.
`balance`	Merchant balance snapshot at query time, in BRL.

Examples#

cURL · replace placeholders before use

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

Request fields · submit as form

{
  "mchid": "10000",
  "pay_md5sign": "CALCULATE_WITH_YOUR_APIKEY"
}

Response example

{
  "status": "success",
  "msg": "查询成功",
  "balance": "100.00"
}

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