Retrieve balance settings

Retrieves balance settings for a given connected account. Related guide: Making API calls for connected accounts

Parameters

No parameters.

Returns

Returns a balance settings object for the account specified in the request.

GET /v1/balance_settings

Server-side language

curl https://api.stripe.com/v1/balance_settings \
  -u "sk_test_Hrs6SAo...0bZXSN3f6ELNsk_test_Hrs6SAopgFPF0bZXSN3f6ELN:" \
  -H "Stripe-Account: {{CONNECTED_ACCOUNT_ID}}"

Response

{
  "object": "balance_settings",
  "payments": {
    "debit_negative_balances": true,
    "payouts": {
      "minimum_balance_by_currency": {
        "usd": 1500,
        "cad": 8000
      },
      "schedule": {
        "interval": "weekly",
        "weekly_payout_days": [
          "monday",
          "wednesday"
        ]
      },
      "statement_descriptor": null,
      "status": "enabled"
    },
    "settlement_timing": {
      "delay_days_override": 3,
      "delay_days": 3
    }
  }
}

External Bank Accounts

External bank accounts are financial accounts associated with a Stripe platform’s connected accounts for the purpose of transferring funds to or from the connected account’s Stripe balance.

Endpoints

POST/v1/accounts/:id/external_accounts

POST/v1/accounts/:id/external_accounts/:id

GET/v1/accounts/:id/external_accounts/:id

GET/v1/accounts/:id/external_accounts

DELETE/v1/accounts/:id/external_accounts/:id

External Account Cards

External account cards are debit cards associated with a Stripe platform’s connected accounts for the purpose of transferring funds to or from the connected accounts Stripe balance.

Endpoints

POST/v1/accounts/:id/external_accounts

POST/v1/accounts/:id/external_accounts/:id

GET/v1/accounts/:id/external_accounts/:id

GET/v1/accounts/:id/external_accounts

DELETE/v1/accounts/:id/external_accounts/:id

Person

This is an object representing a person associated with a Stripe account.

A platform can only access a subset of data in a person for an account where account.controller.requirement_collection is stripe, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.

See the Standard onboarding or Express onboarding documentation for information about prefilling information and account onboarding steps. Learn more about handling identity verification with the API.

Endpoints

POST/v1/accounts/:id/persons

POST/v1/accounts/:id/persons/:id

GET/v1/accounts/:id/persons/:id

GET/v1/accounts/:id/persons

DELETE/v1/accounts/:id/persons/:id

Top-ups

To top up your Stripe balance, you create a top-up object. You can retrieve individual top-ups, as well as list all top-ups. Top-ups are identified by a unique, random ID.

Related guide: Topping up your platform account

Endpoints

POST/v1/topups/:id/cancel