Update Setting

PUT https://api.sfox.com/v1/enterprise/monetization/settings/:id

This endpoint allows Partners to update the monetization amount of existing monetization settings. For example, you would use this endpoint to increase or decrease the monetization amount of a specific monetization setting. Once updated, all future orders or transactions will be charged the new monetization amount.

Path Parameters

Name	Type	Description
id required	number	The monetization ID of the setting to be updated

Body Parameters

Name	Type	Description
new_monetization_amount required	number	The updated monetization amount. Must be > 0.

Responses

200 OK

Setting Updated

{
    "data": {
        "monetization_id": 1310717,
        "monetization_feature": "Spot Trading",
        "monetization_feature_code": "SPOT_TRADE",
        "monetization_method": "Fee Rate",
        "monetization_method_code": "FEE_RATE",
        "monetization_amount": 0.01,
        "user_id": "client25",
        "currency_code": null,
        "security_pair_raw": null,
        "date_updated": "2023-06-07T21:49:22.000Z"
    }
}

422 Unprocessable Content

Invalid amount, format, or ID

{
    "error": "new_monetization_amount must be greater than 0"
}

{
    "error": "new_monetization_amount must be a number"
}

{
    "error": "Invalid monetization ID."
}

403 Forbidden

No permission

{
    "error": "You do not have RFQ monetization permission"
}

{
    "error": "You do not have FEE_RATE monetization permission for RFQ"
}

Response Body

Key	Description
monetization_id	Unique ID for this monetization setting
monetization_feature	Feature the fee will apply to
monetization_feature_code	API readable monetization feature
monetization_method	Monetization method of the setting
monetization_method_code	API readable monetization method
monetization_amount	Monetization amount in decimal format
user_id	User Id of the user that the fee is specified for
currency_code	Currency that the fee is specified for
currency_pair	Currency pair that the fee is specifed for
date_updated	Datetime the fee was created or updated

Example Requests

Shell

curl -X PUT \
  -H 'Content-type: application/json' \
  -H 'Authorization: Bearer <ENTERPRISE_API_KEY>' \
  --data '{ "new_monetization_amount": 0.01}'  \
  'https://api.sfox.com/v1/enterprise/monetization/settings/1310717'

JavaScript

const axios = require('axios');

const config = {
  method: 'put',
  url: 'https://api.sfox.com/v1/enterprise/monetization/settings/1310717',
  headers: {
    "Content-Type": "application/json",
    'Authorization': `Bearer ${process.env.ENTERPRISE_API_KEY}`
  },
  data: {
    new_monetization_amount: 0.01
  }
}

axios(config)
  .then((response) => {
    console.log(response.status);
    console.log(response.data);
  })
  .catch((error) => {
    console.error(error.response.status);
    console.error(error.response.data);
  });

Python

import requests 
import os

data = requests.put(
  "https://api.sfox.com/v1/enterprise/monetization/settings/1310717",
  headers={
    "Authorization": f"Bearer {os.environ['ENTERPRISE_API_KEY']}"
  },
  json={
    "new_monetization_amount": 0.01
  }
)
print(data.status_code)
print(data.json())