API REFERENCE

Vietnam · Query payout

Endpoint, parameters and examples for Vietnam: Query payout.

Endpoint#

POSThttps://YOUR_GATEWAY_HOST/Payment_Dfpay_query.html

application/x-www-form-urlencoded

Parameters#

Parameter	Meaning	Signed	Description
`out_trade_no`	Merchant payout order ID	Yes	Must be unique
`mchid`	Merchant ID	Yes	Assigned merchant ID
`pay_md5sign`	MD5 signature	No	See signing and verification

Parameter	Meaning	Signed	Description
`status`	Request status	Yes	success: request succeeded, not final payment success; error: request failed
`msg`	Status description	Yes	Payout result description
`mchid`	Merchant ID	Yes	Returned when status=success
`out_trade_no`	Merchant payout order ID	Yes	Returned when status=success
`amount`	Payout amount	Yes	Returned when status=success
`transaction_id`	Platform order ID	Yes	Returned when status=success
`refCode`	Business status	Yes	status=success: refCode=0 / 1 / 2status=error: refCode=2
`refMsg`	Business description	Yes	Returned when status=success
`success_time`	Payout completion time	Yes	Returned when status=success and refCode=1
`sign`	MD5 signature	No	See signing and verification

status	refCode	refMsg
`success`	0	待审核 / 待处理 / 处理中 / 未知状态
`success`	1	Succeeded
`success`	2	失败 / 失败,请驳回 / 审核驳回
`error`	2	Transaction not found

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": "100000.00",
  "transaction_id": "DEMO_PLATFORM_PAYOUT",
  "refCode": "1",
  "refMsg": "成功",
  "success_time": "2026-10-11 12:05:00",
  "sign": "CALCULATE_WITH_YOUR_APIKEY"
}

Response example

{
  "status": "success",
  "msg": "请求成功",
  "mchid": "10000",
  "out_trade_no": "DEMO_PAYOUT_001",
  "amount": "100000.00",
  "transaction_id": "DEMO_PLATFORM_PAYOUT",
  "refCode": "0",
  "refMsg": "处理中",
  "sign": "CALCULATE_WITH_YOUR_APIKEY"
}

Response example

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

Signing & result handling#

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

Open signing guide