API For Affiliate

Get affiliate statistics

get

Retrieves aggregated affiliate performance statistics, including referral counts, current level, commission totals, and amounts already processed (withdrawn, converted, or transferred).

Authorizations
api-keystringRequired
Responses
chevron-right
200

Successful response

application/json

Affiliate statistics response payload.

successbooleanOptional

Indicates whether the request was successful.

messagestringOptional

Human-readable response message.

get
/client/v1/affiliate/stats

Get affiliate levels

get

Returns the complete list of affiliate levels, including each level's title, commission rate, and the purchase threshold required to reach the next level.

Authorizations
api-keystringRequired
Responses
chevron-right
200

Successful response

application/json

Affiliate levels response payload.

successbooleanOptional

Indicates whether the request was successful.

messagestringOptional

Human-readable response message.

get
/client/v1/affiliate/all-level

List referred users

get

Returns a paginated list of users referred through the affiliate program, including basic identity fields and the invite code used.

Authorizations
api-keystringRequired
Query parameters
limitintegerOptional

Maximum number of items to return per page. Default: 30

pageintegerOptional

Requested page number (1-based). Default: 1

Responses
chevron-right
200

Successful response

application/json

Referred users list response payload.

successbooleanOptional

Indicates whether the request was successful.

messagestringOptional

Human-readable response message.

get
/client/v1/affiliate/list-referred-user

List commissions

get

Returns a paginated list of commission records generated from referred users, including amount, rate, payment method, validation status, and creation time.

Authorizations
api-keystringRequired
Query parameters
limitintegerOptional

Maximum number of items to return per page. Default: 30

pageintegerOptional

Requested page number (1-based). Default: 1

Responses
chevron-right
200

Successful response

application/json

Commissions list response payload.

successbooleanOptional

Indicates whether the request was successful.

messagestringOptional

Human-readable response message.

get
/client/v1/affiliate/list-commission

List conversions

get

Returns a paginated list of commission conversion records, showing the commission amount used and the resulting value received, along with the conversion timestamp.

Authorizations
api-keystringRequired
Query parameters
limitintegerOptional

Maximum number of items to return per page. Default: 30

pageintegerOptional

Requested page number (1-based). Default: 1

Responses
chevron-right
200

Successful response

application/json

Conversions list response payload.

successbooleanOptional

Indicates whether the request was successful.

messagestringOptional

Human-readable response message.

get
/client/v1/affiliate/list-conversion

List invite codes

get

Returns a paginated list of affiliate invite codes, including code metadata, activation status, and timestamps.

Authorizations
api-keystringRequired
Query parameters
limitintegerOptional

Maximum number of items to return per page. Default: 30

pageintegerOptional

Requested page number (1-based). Default: 1

Responses
chevron-right
200

Successful response

application/json

Invite codes list response payload.

successbooleanOptional

Indicates whether the request was successful.

messagestringOptional

Human-readable response message.

get
/client/v1/affiliate/list-invite-code

List withdrawals

get

Returns a paginated list of affiliate withdrawal requests, including payout details, destination wallet information, status, and creation time.

Authorizations
api-keystringRequired
Query parameters
limitintegerOptional

Maximum number of items to return per page. Default: 30

pageintegerOptional

Requested page number (1-based). Default: 1

Responses
chevron-right
200

Successful response

application/json

Withdrawals list response payload.

successbooleanOptional

Indicates whether the request was successful.

messagestringOptional

Human-readable response message.

get
/client/v1/affiliate/list-withdrawn

List wallet transfers

get

Returns a paginated list of commission transfers to wallet balance, including amount, processing status, and creation time.

Authorizations
api-keystringRequired
Query parameters
limitintegerOptional

Maximum number of items to return per page. Default: 30

pageintegerOptional

Requested page number (1-based). Default: 1

Responses
chevron-right
200

Successful response

application/json

Wallet transfers list response payload.

successbooleanOptional

Indicates whether the request was successful.

messagestringOptional

Human-readable response message.

get
/client/v1/affiliate/list-transfer-to-wallet

Last updated

Was this helpful?