Skip to main content

10. Ref code order list

Ref code order list

This API is used to query the list of referral code orders for an account. By calling this API, you can obtain a list of orders associated with an affiliate referral code, including commission details, order status, and other information.

GET
/openapi/refcode/order/list
Request
NameTypeRequiredDescription
pagenumbernoDefault: 1. Minimum: 1.
page_sizenumbernoDefault: 10 ; Max: 100 ; Min: 1
created_startnumbernoStart time (unix timestamp, inclusive)
created_endnumbernoEnd time (unix timestamp, exclusive)
ref_codestringnoAlliance invitation code
directionstringnoDirection: DESC|ASC Default: DESC
settle_statusnumbernoSettlement status: 1-Incomplete, 2-Completed

Request

{
"page": 1,
"page_size": 10,
"direction": "DESC"
}
Response
NameTypeDescription
codeintBusiness status code
msgstringBusiness message
dataArrayResponse data object
ref_codestringAlliance invitation code
commission_ratefloat64Commission rate
settle_statusint8Settlement status, 1: Incomplete, 2: Completed
created_atint64Creation time
updated_atint64Update time
commissionfloat64Commission amount
order_amount_in_usdtfloat64Order amount in USDT
order_nostringOrder number
query_codestringQuery code
statusint8Order status, 1: Pending transfer, 2: Transferred, 3: Exchanging, 4: Completed, 7: Frozen, 8: Expired, 9: Abandoned
send_chainstringSend chain
send_coinstringSend coin
send_amountfloat64Send amount
totalintTotal number of records
total_commissionfloat64Total commission amount

Example Response

{
"code": 0,
"msg": "success",
"data": [
{
"ref_code": "Ut****P8",
"commission_rate": 0.41,
"settle_status": 2,
"created_at": 1774253898,
"updated_at": 1774254091,
"commission": 0.06,
"order_amount_in_usdt": 30.41,
"order_no": "KB****jL",
"query_code": "ENU*****IT6",
"status": 4,
"send_chain": "TRON",
"send_coin": "TRX",
"send_amount": 98.845005
}
],
"total": 1,
"total_commission": 0.06
}