API REFERENCE

Brazil · Query payout

Endpoint, parameters and examples for Brazil: Query payout.

Endpoint#

POSThttps://YOUR_GATEWAY_HOST/Payment_Dfpay_query.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.
`out_trade_no`	Required	Yes	Original merchant payout order ID; use a unique ID for each new request.
`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.
`mchid`	Merchant number shown in the panel, not the internal user ID.
`out_trade_no`	Original merchant order ID.
`amount`	BRL amount string with two decimal places. Limits and fees depend on merchant and product.
`transaction_id`	Platform order or transaction ID.
`refCode`	Business status code; see the status table.
`refMsg`	Status description; interpret together with refCode.
`success_time`	Returned only for completed orders, yyyy-MM-dd HH:mm:ss in Brazil time.
`sign`	32-character uppercase MD5 signature; exclude this field from signing.

Value	Description
`"0"`	Pending review, pending processing or processing; not a final result.
`"1"`	Payout completed; includes success_time.
`"2"`	Review rejected, failed or failed pending rejection; this alone does not confirm a refund credit.
`"7"`	Transaction not found: status="error", no sign.
`"8"`	Unknown status; keep under investigation, do not mark completed.

Examples#

cURL · replace placeholders before use

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

Request fields · submit as form

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

Response example

{
  "status": "success",
  "msg": "请求成功",
  "mchid": "10000",
  "out_trade_no": "DEMO_PAYOUT_001",
  "amount": "100.00",
  "transaction_id": "DEMO_PLATFORM_PAYOUT",
  "refCode": "1",
  "refMsg": "成功",
  "success_time": "2026-10-24 12:00:00",
  "sign": "CALCULATE_WITH_YOUR_APIKEY"
}

Response example

{
  "status": "error",
  "msg": "请求成功",
  "refCode": "7",
  "refMsg": "交易不存在"
}

Signing & result handling#

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

Open signing guide