API reference

Balance Settings

Options for customizing account balances and payout settings for a Stripe platform’s connected accounts.

Knox answers these operations with the same requests and responses as Stripe's API. Authenticate with your secret key, Authorization: Bearer sk_test_..., from your server, and send form-encoded bodies. Test mode only: live processing is currently disabled.

Base URL
https://api.knoxapi.com

Update 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 strings

    Specifies which fields in the response should be expanded.

  • paymentsobject

    Settings that apply to the Payments Balance.

    Show 3 child parameters
    • debit_negative_balancesboolean
    • payoutsobject
      Show 4 child parameters
      • automatic_transfer_rules_by_currencyobject
      • minimum_balance_by_currencyobject
      • scheduleobject

        Child parameters are listed in the OpenAPI document.

      • statement_descriptorstring
    • settlement_timingobject
      Show 2 child parameters
      • delay_days_overrideinteger
      • start_of_dayobject

        Child parameters are listed in the OpenAPI document.

Returns

The balance_settings object.

POST /v1/balance_settings
curl -X POST https://api.knoxapi.com/v1/balance_settings \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "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 strings

    Specifies which fields in the response should be expanded.

Returns

The balance_settings object.

GET /v1/balance_settings
curl https://api.knoxapi.com/v1/balance_settings \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "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.