Discounting API

APIs that allow Platforms to create target discount schedules.

Create a discounted fee rate for an account

post

Create a discounted fee rate for an account

Authorizations

Path parameters

idOrKeystringRequired

Account ID or Key of the account to add discounted fee rate to

Body

target_fee_ratenumberOptionalExample: 0.05

Responses

200

OK

application/json

400

Invalid discount rate" {message:discountRateValidation}

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Account not found

application/json

409

Discounted fee rate already exists for this account. To modify it, please use the update api endpoint.

application/json

500

Internal error

application/json

post

HTTPcURLJavaScriptPython

POST /v0/platform/accounts/{idOrKey}/discount_rate HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "target_fee_rate": 0.05
}

{
  "account_id": "36cc991e-d4r5-422c-8248-ac356e800fc1",
  "created_at": "2023-12-31T23:59:59Z",
  "removed_at": "2023-12-31T23:59:59Z",
  "target_fee_rate": 0.05
}

Get the discounted fee rate for an account

get

Get the discounted fee rate for an account

Authorizations

Path parameters

idOrKeystringRequired

Account ID or Key of the account to get discount rate for

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Account not found

application/json

500

Internal error

application/json

get

HTTPcURLJavaScriptPython

GET /v0/platform/accounts/{idOrKey}/discount_rate HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer JWT
Accept: */*

{
  "account_id": "36cc991e-d4r5-422c-8248-ac356e800fc1",
  "created_at": "2023-12-31T23:59:59Z",
  "removed_at": "2023-12-31T23:59:59Z",
  "target_fee_rate": 0.05
}

Update a discounted fee rate for an account

patch

Update a discounted fee rate for an account. If the discount rate already exists, it will be updated. A TargetFeeRate of 0.1 means no discount.

Authorizations

Path parameters

idOrKeystringRequired

Account ID or Key of the account to update discounted fee rate for

Body

target_fee_ratenumberOptionalExample: 0.05

Responses

200

OK

application/json

304

Discount rate is already set to the requested value

application/json

400

Invalid discount rate" {message:discountRateValidation}

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Account not found

application/json

500

Internal error

application/json

patch

HTTPcURLJavaScriptPython

PATCH /v0/platform/accounts/{idOrKey}/discount_rate HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "target_fee_rate": 0.05
}

{
  "account_id": "36cc991e-d4r5-422c-8248-ac356e800fc1",
  "created_at": "2023-12-31T23:59:59Z",
  "removed_at": "2023-12-31T23:59:59Z",
  "target_fee_rate": 0.05
}