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
Name Required Type Description
merchantNo Yes String Merchant number assigned by Vexora.

Request Body Parameters

Name Required Type Description
tradeNo Yes String The transaction number provided by the merchant during payout
timestamp Yes String Timestamp
sign Yes String Request signature. Sort all non-empty request body parameters except sign by parameter name in ascending alphabetical order, concatenate them as key1=value1key2=value2, append the app secret, and generate a lowercase MD5 hash.

Request Example

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

Successful Response Example

Parameter Name Required Type Description
msg Yes String Request result (Returning "success" only indicates the request was successful; it should not be used for merchant-side logic)
code Yes String Request response code (Returning "0000" only indicates the request was successful; it should not be used for merchant-side logic)
timestamp Yes String Timestamp (e.g., 1715941383720)
success Yes Boolean Whether the query request was processed successfully. Use data.status to determine the final transaction state.
data Yes Object Response object
data.tradeNo Yes String Transaction number returned by the merchant
data.platFormTradeNo Yes String vexora transaction number
data.orderAmount Yes Float Order amount
data.payAmount Yes Float Payment amount
data.status Yes String Transaction results,Merchants can process subsequent workflows based on the returned status in the transaction result. For details, please refer to the status code reference table.
data.message Yes String Error description

Successful Response Example**:

{
    "msg": "success",
    "code": "0000",
    "timestamp": 1728613339884,
    "success": true,
    "data": {
        "platFormTradeNo": "63mz9aepqczdw280",
        "tradeNo": "test_00000002",
        "orderAmount": "300.00",
        "payAmount": "200.00",
        "status": "0015",
        "message": "Processing"

    }
}