stripe_get_balance

Pack: stripe_connect · Endpoint: https://gateway.pipeworx.io/stripe_connect/mcp

Get the current Stripe account balance.

Parameters

NameTypeRequiredDescription
_apiKeystringyesStripe secret or restricted API key (sk_…)

Example call

Arguments

{
  "_apiKey": "your-stripe_connect-api-key"
}

curl

curl -X POST https://gateway.pipeworx.io/stripe_connect/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"stripe_get_balance","arguments":{"_apiKey":"your-stripe_connect-api-key"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('stripe_get_balance', {
  "_apiKey": "your-stripe_connect-api-key"
});

Response shape

FieldTypeDescription
objectstringObject type (balance)
availablearrayAvailable balance by currency
connect_reservedarrayConnect reserved balance by currency
livemodebooleanLive mode
pendingarrayPending balance by currency
Full JSON Schema
{
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "description": "Object type (balance)"
    },
    "available": {
      "type": "array",
      "description": "Available balance by currency",
      "items": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer",
            "description": "Amount in cents"
          },
          "currency": {
            "type": "string",
            "description": "Currency code"
          },
          "source_types": {
            "type": "object",
            "description": "Balance by source type"
          }
        }
      }
    },
    "connect_reserved": {
      "type": "array",
      "description": "Connect reserved balance by currency",
      "items": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer",
            "description": "Amount in cents"
          },
          "currency": {
            "type": "string",
            "description": "Currency code"
          }
        }
      }
    },
    "livemode": {
      "type": "boolean",
      "description": "Live mode"
    },
    "pending": {
      "type": "array",
      "description": "Pending balance by currency",
      "items": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer",
            "description": "Amount in cents"
          },
          "currency": {
            "type": "string",
            "description": "Currency code"
          },
          "source_types": {
            "type": "object",
            "description": "Pending balance by source type"
          }
        }
      }
    }
  }
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "stripe_connect": {
      "url": "https://gateway.pipeworx.io/stripe_connect/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

Regenerated from source · build May 9, 2026