Discounting API
APIs that allow Platforms to create target discount schedules.
Create a discounted fee rate for an account
Account ID or Key of the account to add discounted fee rate to
0.05OK
Invalid discount rate" {message:discountRateValidation}
Unauthorized
Forbidden
Account not found
Discounted fee rate already exists for this account. To modify it, please use the update api endpoint.
Internal error
POST /v0/platform/accounts/{idOrKey}/discount_rate HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer YOUR_SECRET_TOKEN
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
Account ID or Key of the account to get discount rate for
OK
Unauthorized
Forbidden
Account not found
Internal error
GET /v0/platform/accounts/{idOrKey}/discount_rate HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer YOUR_SECRET_TOKEN
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. If the discount rate already exists, it will be updated. A TargetFeeRate of 0.1 means no discount.
Account ID or Key of the account to update discounted fee rate for
0.05OK
Discount rate is already set to the requested value
Invalid discount rate" {message:discountRateValidation}
Unauthorized
Forbidden
Account not found
Internal error
PATCH /v0/platform/accounts/{idOrKey}/discount_rate HTTP/1.1
Host: api.alluvial.finance
Authorization: Bearer YOUR_SECRET_TOKEN
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
}Last updated
Was this helpful?