Check Disbursement Status

Tip

• All requests are Post requests, and the data format is json
• API Documentation for Querying Payment Results

Brief Description

• The business party can actively query the payment results.

Request URL

• /v1/vexora/queryPayOutResult

Request Method

• Method: POST
• Content-Type: application/json

Header

Name	Required	Type	Description
merchantNo	Yes	String	Merchant number assigned by Vexora.

Request Body Parameters

Name	Required	Type	Description
tradeNo	Yes	String	Transaction number passed by the merchant during the 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

{
    "tradeNo": "1000002",
    "timestamp": "1724142308374",
    "sign": "f1af771406f49807ef09626bf54ed620"
}

Response Parameters

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	Long	Server timestamp in milliseconds (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.platFormTradeNo	Yes	String	vexora transaction number
data.tradeNo	Yes	String	Merchant transaction number returned
data.amount	Yes	String	Transaction amount
data.serviceAmount	No	String	Service fee.
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	Status description
data.successTime	No	String	Transaction success time (local time)
data.endToEndId	No	String	End-to-end transaction identifier returned by the payment network.

Response Example

{
    "msg": "success",
    "code": "0000",
    "timestamp": 1719830071094,
    "success": true,
    "data": {
        "platFormTradeNo": "5286e98841194687a95d25b5f3be346d",
        "tradeNo": "00000020",
        "amount": "30000",
        "serviceAmount": "10",
        "endToEndId": "E123456782024070118343100001",
        "status": "00029",
        "message": "REJECTED_TRANSACTION",
        "successTime": "2024-07-01 18:34:31"
    }
}