There are a two groups of tables within Stripe Sigma’s schema that contain suitable data for you to report on your account’s balance activity. The Payment Tables section contains tables that represent funds that flow between your customers and Stripe account, such as charges or refunds. Information about transfers of your Stripe account balance to your bank account (payouts) are listed within the Transfer Tables section.
balance_transactions table is our recommended starting point for accounting purposes. Its biggest advantage over using separate tables (such as
refunds) is that it provides a ledger-style record of every type of transaction that comes into, or flows out of, your Stripe account’s balance. Balance transactions are used to generate the most frequently used reports and greatly simplify how you report on financial activity. Some common types of balance transactions include:
Each balance transaction row represents an individual Balance_transaction object that, once created, does not change. For instance, when a charge is created, a corresponding balance transaction of type
charge is also created. If this charge is refunded at any time, a separate balance transaction of type
refund is also created––the original balance transaction is not modified. Similarly, when a payout is sent to your bank account (represented as a transfer), a balance transaction for it is also created.
The following example query uses this table to retrieve some information about the five most recent balance transactions.
select date_format(created, '%Y-%m-%d') as day, id, amount, currency, source_id, type from balance_transactions order by day desc limit 5
The most common financial summaries can be calculated by joining the
balance_transactions table with other tables containing the appropriate information. Some of our query templates (such as Daily report, and Monthly summary and balance) work by joining this table to others.
Balance transaction fee details
Fee information about each individual balance transaction is provided in the
balance_transaction_fee_details table. Joining this table to
balance_transactions in the manner below allows you to return fee information for each balance transaction.
The following query joins the
balance_transaction_fee_details tables together. Each balance transaction item returned includes the amount, fee, type of fee applied, and a description of the fee.
select date_format(date_trunc('day', balance_transactions.created), '%Y-%m-%d') as day, balance_transactions.id, balance_transactions.amount, balance_transactions.fee, balance_transaction_fee_details.type from balance_transactions inner join balance_transaction_fee_details on balance_transaction_fee_details.balance_transaction_id=balance_transactions.id order by day desc limit 5
charges table contains data about Charge objects. This table is best suited for queries that focus on charge-specific information rather than for accounting or reconciliatory purposes. It also supplements accounting reports with additional customer data. For example, The Payment card mix template query uses the
charges table to report on the different types of cards your customers have used.
You can join the
charges table to a number of others to retrieve more information with your queries.
The following example uses the
charges table to report on failed charges, returning the card brand and type, as well as the failure code and message.
select date_format(date_trunc('day', created), '%Y-%m-%d') as day, id, card_brand, failure_code, failure_message from charges where status = 'failed' order by day desc limit 5
|2018-09-19||ch_6RTJC4KHyDDiUFw||Visa||card_declined||Your card was declined.|
|2018-09-19||ch_YXmQhaCDHhmBpAT||MasterCard||card_declined||Your card does not support this type of purchase.|
|2018-09-19||ch_MFAwTW0zPmbXiu5||Visa||card_declined||Your card has insufficient funds.|
|2018-09-19||ch_mCqTdVqr3xKqeg4||Visa||card_declined||Your card was declined.|
|2018-09-19||ch_VgWoaaJGAXR4VAH||MasterCard||card_declined||Your card was declined.|
Data about Customer objects is contained in the
customers table (this is not part of the Payment Tables group). This can be used if you’re creating charges using customers (e.g., with saved payment information). It is also useful if you’re making use of subscriptions.
The following example retrieves a list of failed charges. The ID and email address for each customer is retrieved.
select date_format(date_trunc('day', charges.created), '%Y-%m-%d') as day, customers.id, customers.email, charges.id from charges inner join customers on customers.id=charges.customer_id where charges.status = 'failed' order by day desc limit 5
Charges and refunds are separate objects within the API. When a charge is refunded, a Refund object is created. This data is available within the
refunds table and provides in-depth information about refunds that have been performed. Similar to reporting on charges, a best practice is to start with information about balance transactions. If necessary, you can then gather additional details using the
refunds table can be joined to the
charges tables to further explore refund data.
The following example joins the
refunds tables together using the
balance_transactions.id columns. Each balance transaction item returned is a refund, displaying the associated charge ID, and amount. Only balance transactions created after a certain date are returned (and limited).
select date_format(date_trunc('day', balance_transactions.created), '%Y-%m-%d') as day, balance_transactions.source_id, refunds.charge_id, balance_transactions.amount, from balance_transactions inner join refunds on refunds.balance_transaction_id=balance_transactions.id where balance_transactions.type = 'refund' order by day desc limit 5
Partial capture refunds
If you’re using auth and capture and capture only some of the authorized amount, these are represented by both charges and refunds. When a charge is authorized, a
charge and associated balance transaction for the full amount is created. After a partial capture has been completed, the un-captured amount is released and represented by a
refund with a
reason field of
partial_capture, and an associated balance transaction.
For instance, if you authorize a $10 charge but only capture $7, a
charge is first created for $10. A
refund with the reason
partial_capture is then created for the remaining $3.
This should be taken into account if your business is performing auth and capture charges and you’re creating reports to review customer refund rates. Without consideration, auth and capture can misrepresent the number of refunds on your account. Use the refund’s
reason field to filter out partial capture refunds when retrieving payment information.
select balance_transactions.id, balance_transactions.amount from balance_transactions inner join refunds on refunds.id=balance_transactions.source_id where reason != 'partial_capture' limit 5
disputes table contains data about all disputes on your account. Each row represents a Dispute object, created when a charge is disputed. Each dispute also includes any available data about any dispute evidence that may have been submitted.
The following example provides some preliminary information about the five most recent disputes that were lost. It joins the
charges tables together using the
charges.id columns. Along with a dispute ID, each row contains an associated charge ID, the amount, and what the outcome of the ZIP and CVC checks were.
select date_format(date_trunc('day', disputes.created), '%Y-%m-%d') as day, disputes.id, disputes.charge_id, disputes.amount, charges.card_address_zip_check as zip, charges.card_cvc_check as cvc from disputes inner join charges on charges.id=disputes.charge_id where disputes.status = 'lost' and disputes.reason = 'fraudulent' order by day desc limit 5
Using Stripe Sigma to create reports about your disputes can help you identify the types of payments that can otherwise be prevented using Radar.
Transfers and payouts
transfers table contains data about payouts made from your Stripe balance to your bank account. You can use this table to reconcile each payout with the specific charges, refunds, and adjustments that it’s made up of, as long as you’re using automatic payouts.
For Connect platforms, this table also includes data about transfers of funds to connected Stripe accounts.
If you are performing payouts manually, the amount in each payout to your bank account is arbitrary. As such, it cannot be reconciled to specific balance transactions and only reflects the amount you requested to pay out to your bank account.
The following example joins the
transfers tables together. This returns a list of charges and refunds, the payout they relate to, and the date that the payout was scheduled to arrive into your bank account.
select date_format(date_trunc('day', balance_transactions.created), '%Y-%m-%d') as bt_created, balance_transactions.source_id, balance_transactions.type, balance_transactions.net as net_amount, balance_transactions.automatic_transfer_id as transfer_id, date_format(date_trunc('day', transfers.date), '%Y-%m-%d') as transfer_date from balance_transactions inner join transfers on balance_transactions.automatic_transfer_id=transfers.id where balance_transactions.type = 'charge' and balance_transactions.type != 'refund' order by bt_created desc limit 5
A payout (or transfer to a connected Stripe account) that has been created manually can be reversed if it has not yet been paid out, with any funds returned to your account’s available balance. These are represented as Transfer_reversal objects and reside in the
Transfer reversals only apply to payouts and transfers that have been created manually––automatic payouts cannot be reversed.