Retrieve Payout Request

Submission URL: https://openapi.basicex.com/v2/payouts/${orderNo}

Request Method: GET

Content-Type: application/json

Request Parameters

Field	Required	Type	Description
orderNo	Yes	String	BasicEx system order number or merchant order number

Note: When querying payout orders, either the platform order number or the merchant order number can be used.

Request Example

/payouts/40820230828132719168665956761737

or

/payouts/EQWEQWRRRRWEQ

Response Parameters

Field	Type	Description
merOrderNo	String	Merchant's merchant order number
orderNo	String	BasicEx system order number
targetType	String	Payout object type: * BasicEx Wallet ID: BEID * External wallet address: ADDRESS
target	String	Payout object (BasicEx Wallet ID/External Wallet Address)
actualAmount	BigDecimal	Payout order amount Not in integer, needs to be processed separately from the request field, e.g., 2.00
currency	String	Cryptocurrency type, e.g., USDT, BTC, etc. View the currency list
network	String	Transfer network, supports TRC20, ERC20, Polygon, BSC
description	String	Description of the payout order, e.g., "Salary"
tradeFinishTime	LocalDateTime	Time of transaction completion
metadata	Map	Additional data, returned as is
status	String	Current status of the payout order (paid: processing, completed: completed, failed: failed).
transactionId	String	Blockchain transaction ID

Response Example:

Upon a successful order request, the response code is 0000.

{
	"code": "0000",
	"message": "",
	"data": {
		"merOrderNo": "WEQEQRRTTTCASFAGAG",
		"orderNo": "40820230826154330118137839206582",
		"targetType": "ADDRESS",
		"target": "TLeozhe6ozXW88vKnvkfF3Xmo9JrnbNfpZ",
		"actualAmount": "10.00",
		"currency": "USDT",
		"network": "TRC20",
		"description": "TEST_PAYOUT_API",
		"tradeFinishTime": 2023-08-26 17:43:38,
		"metadata": null,
		"status": "paid",
		"transactionId": "36917fed30a61a6a41a3299a9cdcc4bb1ee15c4ff3a3d5998b9ba6d62d2da89a"
	}
}