How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Stripe Balance API

This is an object representing your Stripe balance. You can retrieve it to see the balance currently on your Stripe account. You can also retrieve the balance history, which contains a list of transactions that contributed to the balance (charges, payouts, and so forth).

Stripe Balance API is one of 159 APIs that Stripe publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Balances, History, and Transaction. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 14 operations across 11 paths, and defines 32 schemas. It is described by OpenAPI 3.2.0, at version 2023-10-16.

Requests are made against a single base URL, https://api.stripe.com/.

14 operations 11 paths 32 schemas 10 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2023-10-16
Server
https://api.stripe.com/
Authentication
HTTP Basic, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

Stripe Balance API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (auth-scheme) (bearerAuth). By default, every request must be authenticated.

  • basicAuth — Basic HTTP authentication. Allowed headers-- Authorization: Basic | Authorization: Basic
  • bearerAuth — Bearer HTTP authentication. Allowed headers-- Authorization: Bearer

Paths & Operations 14

Across 11 paths, the API surfaces 14 operations — 10 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Balance 14
GET
/v1/balance
Retrieves the current account balance, based on the authentication that was used to make the request. For a sample request, see Accounting for negative balances .
GetBalance 1 param body → 200default
GET
/v1/balance/history
Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transa…
GetBalanceHistory 9 params body → 200default
GET
/v1/balance/history/{id}
Retrieves the balance transaction with the given ID. Note that this endpoint previously used the path /v1/balance/history/:id .
GetBalanceHistoryId 2 params body → 200default
GET
/v1/balance_transactions
Stripe Get Balance Transactions
getBalanceTransactions 9 params body → 200default
GET
/v1/balance_transactions/{id}
Stripe Get Balance Transactions Id
getBalanceTransactionsId 2 params body → 200default
GET
/v1/customers/{customer}/balance_transactions
Stripe Get Customers Customer Balance Transactions
getCustomersCustomerBalanceTransactions 5 params body → 200default
POST
/v1/customers/{customer}/balance_transactions
Stripe Post Customers Customer Balance Transactions
postCustomersCustomerBalanceTransactions 1 param body → 200default
GET
/v1/customers/{customer}/balance_transactions/{transaction}
Stripe Get Customers Customer Balance Transactions Transaction
getCustomersCustomerBalanceTransactionsTransaction 3 params body → 200default
POST
/v1/customers/{customer}/balance_transactions/{transaction}
Stripe Post Customers Customer Balance Transactions Transaction
postCustomersCustomerBalanceTransactionsTransaction 2 params body → 200default
GET
/v1/customers/{customer}/cash_balance
Stripe Get Customers Customer Cash Balance
getCustomersCustomerCashBalance 2 params body → 200default
POST
/v1/customers/{customer}/cash_balance
Stripe Post Customers Customer Cash Balance
postCustomersCustomerCashBalance 1 param body → 200default
GET
/v1/customers/{customer}/cash_balance_transactions
Stripe Get Customers Customer Cash Balance Transactions
getCustomersCustomerCashBalanceTransactions 5 params body → 200default
GET
/v1/customers/{customer}/cash_balance_transactions/{transaction}
Stripe Get Customers Customer Cash Balance Transactions Transaction
getCustomersCustomerCashBalanceTransactionsTransaction 3 params body → 200default
POST
/v1/payment_intents/{intent}/apply_customer_balance
Stripe Post Payment Intents Apply Customer Balance
postPaymentIntentsIntentApplyCustomerBalance 1 param body → 200default

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are subscription (43 properties), payment_method (43 properties), payment_intent (39 properties), card (28 properties). Each schema is shown below with its type and property counts.

customer
object
This object represents a customer of your business. Use it to create recurring charges and track payments that belong to the same customer. Related guide: [Sav…
28 properties 4 required
balance
object
This is an object representing your Stripe balance. You can retrieve it to see the balance currently on your Stripe account. You can also retrieve the balance…
7 properties 4 required
GetCustomersCustomerBalanceTransactionsRequest
object
CustomerCashBalanceTransactionList
object
4 properties 4 required
payment_method
object
PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) t…
43 properties 6 required
subscription
object
Subscriptions allow you to charge a customer on a recurring basis. Related guide: [Creating subscriptions](https://stripe.com/docs/billing/subscriptions/creati…
43 properties 16 required
payment_intent
object
A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each orde…
39 properties 10 required
GetBalanceTransactionsRequest
object
deleted_customer
object
3 properties 3 required
GetCustomersCustomerCashBalanceTransactionsRequest
object
PostCustomersCustomerBalanceTransactionsRequest
object
5 properties 2 required
card
object
You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer t…
28 properties 7 required
GetCustomersCustomerBalanceTransactionsTransactionRequest
object
GetBalanceTransactionsIdRequest
object
tax_id
object
You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers) or account. Customer and account tax IDs get displayed on related in…
9 properties 6 required
PostPaymentIntentsIntentApplyCustomerBalanceRequest
object
3 properties
PostCustomersCustomerCashBalanceRequest
object
2 properties
CustomerBalanceTransactionList
object
4 properties 4 required
GetBalanceRequest
object
GetBalanceHistoryIdRequest
object
GetCustomersCustomerCashBalanceTransactionsTransactionRequest
object
error
object
An error response from the Stripe API
1 property 1 required
customer_cash_balance_transaction
object
Customers with certain payments enabled have a cash balance, representing funds that were paid by the customer to a merchant, but have not yet been allocated t…
15 properties 9 required
bank_account
object
These bank accounts are payment methods on Customer objects. On the other hand [External Accounts](https://stripe.com/docs/apiexternalaccounts) are transfer de…
19 properties 6 required
balance_transaction
object
Balance transactions represent funds moving through your Stripe account. Stripe creates them for every type of transaction that enters or leaves your Stripe ac…
15 properties 12 required
customer_balance_transaction
object
Each customer has a [Balance](https://stripe.com/docs/api/customers/objectcustomerobject-balance) value, which denotes a debit or credit that's automatically a…
13 properties 9 required
GetCustomersCustomerCashBalanceRequest
object
GetBalanceHistoryRequest
object
BalanceTransactionsList
object
4 properties 4 required
PostCustomersCustomerBalanceTransactionsTransactionRequest
object
3 properties
discount
object
A discount represents the actual application of a [coupon](https://stripe.com/docs/apicoupons) or [promotion code](https://stripe.com/docs/apipromotioncodes).…
11 properties 4 required
cash_balance
object
A customer's Cash balance represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment…
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stripe-balance-api-openapi.yml Raw ↑

Other APIs Stripe publishes across the network.

Stripe Accounts API
Stripe Billing API
Stripe Charges API
Stripe Checkout API
Stripe Climate API
Stripe Country API
Stripe Coupons API
Stripe Credit Notes API
Stripe Customers API
Stripe Disputes API
Stripe Ephemeral Keys API
Stripe Events API
Where this information came from

This is an independent, third-party profile of Stripe Balance API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.