API reference
Balance Settings
Options for customizing account balances and payout settings for a Stripe platform’s connected accounts.
https://api.knoxapi.comUpdate balance settings
POST/v1/balance_settings
Updates balance settings for a given connected account. Related guide: Making API calls for connected accounts
Body parameters
expandarray of stringsSpecifies which fields in the response should be expanded.
paymentsobjectSettings that apply to the Payments Balance.
Show 3 child parameters
debit_negative_balancesbooleanpayoutsobjectShow 4 child parameters
automatic_transfer_rules_by_currencyobjectminimum_balance_by_currencyobjectscheduleobjectChild parameters are listed in the OpenAPI document.
statement_descriptorstring
settlement_timingobjectShow 2 child parameters
delay_days_overrideintegerstart_of_dayobjectChild parameters are listed in the OpenAPI document.
Returns
The balance_settings object.
curl -X POST https://api.knoxapi.com/v1/balance_settings \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('POST', '/v1/balance_settings');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("post", "/v1/balance_settings")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:post, '/v1/balance_settings'){
"object": "balance_settings",
"payments": {
"debit_negative_balances": null,
"payouts": {
"minimum_balance_by_currency": null,
"schedule": {
"interval": null
},
"statement_descriptor": null,
"status": "disabled",
"automatic_transfer_rules_by_currency": null
},
"settlement_timing": {
"delay_days": 1647351405,
"start_of_day": {
"hour": 3208676,
"minutes": 1064901855,
"timezone": "timezone"
}
}
}
}Retrieve balance settings
GET/v1/balance_settings
Retrieves balance settings for a given connected account. Related guide: Making API calls for connected accounts
Query parameters
expandarray of stringsSpecifies which fields in the response should be expanded.
Returns
The balance_settings object.
curl https://api.knoxapi.com/v1/balance_settings \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('GET', '/v1/balance_settings');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("get", "/v1/balance_settings")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:get, '/v1/balance_settings'){
"object": "balance_settings",
"payments": {
"debit_negative_balances": null,
"payouts": {
"minimum_balance_by_currency": null,
"schedule": {
"interval": null
},
"statement_descriptor": null,
"status": "disabled",
"automatic_transfer_rules_by_currency": null
},
"settlement_timing": {
"delay_days": 1647351405,
"start_of_day": {
"hour": 3208676,
"minutes": 1064901855,
"timezone": "timezone"
}
}
}
}Operations and schemas come from the pinned Stripe OpenAPI specification (MIT); response examples from its fixtures. Nested object definitions and enums are in the complete specification.