Check Disbursement Status

Tip

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

Brief Description

• The business party can actively query the payment results.

Request URL

• /api/queryPayOutResult

Request Method

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

Header

Name	required	type	desc
merchantNo	Yes	String	Merchant number assigned by Vexora.

Request Body Parameters

Name	required	type	desc
tradeNo	Yes	String	Transactions requested by the business party
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",
    "sign": "00000000000"
}

Successful Response Example

Parameter	Required	Type	Description
msg	Yes	String	Request result (when returning success, it only indicates that the request was successful and cannot be used for merchant-side logic judgment)
code	Yes	String	Request response code (when returning 0000, it only indicates that the request was successful and cannot be used for merchant-side logic judgment). For specific error codes, please refer to the business error code enumeration.
timestamp	Yes	Integer	Transaction time
success	Yes	Boolean	Whether the query request was processed successfully. Use data.status to determine the final transaction state.
data	Yes	Object	Return object
data.platFormTradeNo	Yes	String	vexora transaction number
data.tradeNo	Yes	String	Merchant transaction number returned in the payout query result.
data.amount	Yes	Float	Transaction 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
data.successTime	No	String	Transaction success time (Kenya time)

Successful Response Example

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