Skip to content

Check Disbursement Status

Tip

  • All requests are Post requests, and the data format is json

API Documentation for Querying PayOut Result

Brief Description

  • The business party can actively query the payment results.

Request URL

  • /v1/vexora/queryPayOutResult

Request Method

  • Method: POST
  • Content-Type: application/json
Parameter Required Type Description
merchantNo Yes String Merchant number assigned by Vexora.

Request Body Parameters

Parameter Required Type Description
tradeNo Yes String Merchant transaction number of the payout order to query.
timestamp Yes String Current Unix timestamp in milliseconds, represented as a string.
sign Yes String Lowercase MD5 request signature. Exclude sign, sort all non-empty request parameters by name, concatenate them as key1=value1key2=value2, append the app secret, and calculate the MD5 hash.

Request Example

{
  "tradeNo": "test_00000002",
  "timestamp": "1728613320708",
  "sign": "ee5c512fe36fed2afe2d36ab248e0eb8"
}

Response Parameters

Parameter Required Type Description
code Yes String API response code. 0000 indicates that the query was processed; use data.status to determine the transaction status.
msg Yes String Description of the API request result.
success Yes Boolean Whether the query request was processed successfully.
timestamp Yes Long Server timestamp in milliseconds.
data Yes Object Payout order details.
data.tradeNo Yes String Merchant transaction number.
data.platFormTradeNo Yes String Unique Vexora transaction number.
data.status Yes String Current payout order status code.
data.message Yes String Transaction status description.
data.orderAmount Yes String Original payout amount submitted when the order was created.
data.payAmount Yes String Amount successfully paid to the recipient.
data.serviceAmount No String Service fee. Returned when the payout transaction is successful.
data.successTime No String Payout completion time in local time (YYYY-MM-DD HH:mm:ss).

Response Example

{
    "code": "0000",
    "msg": "success",
    "success": true,
    "timestamp": 1728613339884,
    "data": {
        "tradeNo": "test_00000002",
        "platFormTradeNo": "63mz9aepqczdw280",
        "status": "0015",
        "message": "Paying",
        "orderAmount": "300.00",
        "payAmount": "200.00",
        "serviceAmount": "10",
        "successTime": "2024-10-12 12:59:32"
    }
}