Create referral code

Limit: 1 requests per second

POST /v1/referral/create

Scope: Only each builder’s admin can create the referral code for accounts that are related to the builder_id

POST /v1/referral/create

Create referral code

cURL

curl --request POST \
  --url https://api.orderly.org/v1/referral/create \
  --header 'Content-Type: application/json' \
  --header 'orderly-account-id: <orderly-account-id>' \
  --header 'orderly-key: <orderly-key>' \
  --header 'orderly-signature: <orderly-signature>' \
  --header 'orderly-timestamp: <orderly-timestamp>' \
  --data '
{
  "account_id": "<string>",
  "referral_code": "<string>",
  "max_rebate_rate": 123,
  "referrer_rebate_rate": 123,
  "referee_rebate_rate": 123
}
'

200

{
  "success": true,
  "timestamp": 1702989203989
}

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

max_rebate_rate · number · required

the referral code’s rebate rate (max 1)

referrer_rebate_rate · number · required

rebate rate of referrer

referee_rebate_rate · number · required

rebate rate of 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