Skip to main content
POST
Create referral code

Headers

orderly-timestamp
string
required

Timestamp of the signed request in milliseconds.

orderly-account-id
string
required

Account ID of the authenticated account.

orderly-key
string
required

Public orderly key used to sign the request.

orderly-signature
string
required

Signature of the request payload generated with the orderly key.

Body

application/json
account_id
string
required

the account id of the referrer

referral_code
string
required

the referral code that admin wants to create

bonus_max_rebate_rate
number
required

The referral code's maximum bonus rebate rate (max 1).

bonus_referrer_rebate_rate
number
required

Bonus rebate rate of the referrer.

bonus_referee_rebate_rate
number
required

Bonus rebate rate of the referee.

Response

200 - application/json

OK

success
boolean
required

Indicates whether the request was successful.

Example:

true

timestamp
integer

Server timestamp in milliseconds.

Example:

1702989203989