Retrieves the current account balance, based on the authentication that was used to make the request.\n For a sample request, see Accounting for negative balances.
" }, { "info": { "name": "GetBalanceHistory", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/balance/history", "params": [ { "name": "created", "value": "", "type": "query" }, { "name": "currency", "value": "", "type": "query", "description": "Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "payout", "value": "", "type": "query", "description": "For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID." }, { "name": "source", "value": "", "type": "query", "description": "Only returns the original transaction." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list." }, { "name": "type", "value": "", "type": "query", "description": "Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, `obligation_outbound`, `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "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 transactions appearing first.
\n\nNote that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
Retrieves the balance transaction with the given ID.
\n\nNote that this endpoint previously used the path /v1/balance/history/:id.
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 transactions appearing first.
\n\nNote that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
Retrieves the balance transaction with the given ID.
\n\nNote that this endpoint previously used the path /v1/balance/history/:id.
Returns a list of transactions that updated the customer’s balances.
" }, { "info": { "name": "Stripe Post Customers Customer Balance Transactions", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/customers/:customer/balance_transactions", "params": [ { "name": "customer", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Creates an immutable transaction that updates the customer’s credit balance.
" }, { "info": { "name": "Stripe Get Customers Customer Balance Transactions Transaction", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/balance_transactions/:transaction", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "transaction", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves a specific customer balance transaction that updated the customer’s balances.
" }, { "info": { "name": "Stripe Post Customers Customer Balance Transactions Transaction", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/customers/:customer/balance_transactions/:transaction", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "transaction", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Most credit balance transaction fields are immutable, but you may update its description and metadata.
Retrieves a customer’s cash balance.
" }, { "info": { "name": "Stripe Post Customers Customer Cash Balance", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/customers/:customer/cash_balance", "params": [ { "name": "customer", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Changes the settings on a customer’s cash balance.
" }, { "info": { "name": "Stripe Get Customers Customer Cash Balance Transactions", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/cash_balance_transactions", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns a list of transactions that modified the customer’s cash balance.
" }, { "info": { "name": "Stripe Get Customers Customer Cash Balance Transactions Transaction", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/cash_balance_transactions/:transaction", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "transaction", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves a specific cash balance transaction, which updated the customer’s cash balance.
" }, { "info": { "name": "Stripe Post Payment Intents Apply Customer Balance", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/payment_intents/:intent/apply_customer_balance", "params": [ { "name": "intent", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Manually reconcile the remaining amount for a customer_balance PaymentIntent.