Balance Report
Balance Report
The Balance Report is a comprehensive monthly financial statement that tracks all balance-affecting events for a merchant. It is generated in two formats: a detailed CSV file containing every individual transaction event, and a summarized CSV file with aggregated totals and country-level breakdowns. The report provides a complete view of the merchant's balance position including confirmed transactions, settled amounts, reserves, and all financial adjustments for the reporting period.
Balance Report Detailed
The Balance Report Detailed is a comprehensive CSV file that provides a granular, transaction-by-transaction audit trail of all balance-affecting events. Each row represents a specific balance event with columns for date, country, currency, reference type, payment hash, merchant payment code, merchant refund code, event type, payment type code, instalments, instalment, amount, and settlement code. The detailed report serves as the complete source of truth for reconciliation and audit purposes.
Balance Report Detailed Sample
| Field | Format | Description | Example | Edge Cases |
|---|---|---|---|---|
| DATE | DateTime string (YYYY-MM-DD HH:MM:SS) | Date and time when the balance event occurred. | 2024-02-15 14:30:15 | Always populated; timezone follows merchant configuration. |
| COUNTRY | String (full country name) | Country name where the transaction was processed. | Brazil, Mexico, Argentina | Always populated; uses full name, not abbreviation. |
| CURRENCY | 3-letter ISO currency code | ISO 4217 currency code for the transaction. | USD, BRL, EUR | Always populated; represents external/original currency. |
| REFERENCE_TYPE | String enumeration (PAYMENT, REFUND, etc.) | Type of entity that triggered the balance event. | PAYMENT, REFUND, CHARGEBACK | Always populated; determines which reference_id to use. |
| PAYMENT_HASH | Hexadecimal string (48 characters) | Unique EBANX payment hash identifier for the original payment. | 54154bb...444a4ac | Always populated for payment-related events; empty for non-payment entries. |
| MERCHANT_PAYMENT_CODE | String (merchant-defined) | Merchant-provided payment code identifier. | INV-2024-001, ORDER-12345 | Can be empty if merchant doesn't provide it. |
| MERCHANT_REFUND_CODE | String (merchant-defined) | Merchant-provided refund code identifier. | REF-2024-001, empty string | Only populated for refund events; empty for other event types. |
| EVENT_TYPE | String enumeration (PAYMENT_CONFIRMED, etc.) | Specific type of balance event that occurred. | PAYMENT_CONFIRMED, FEE_PAYMENT_TOTAL | Always populated; determines balance increase/decrease. |
| PAYMENT_TYPE_CODE | String (payment type code) | Payment method code used for the transaction. | creditcard, pix, boleto | Can be empty for non-payment events. |
| INSTALMENTS | Integer | Total number of instalments for the payment. | 1, 3, 12 | Always at least 1; only relevant for credit card payments. |
| INSTALMENT | Integer or empty string | Current instalment number (for instalment-specific events). | 1, 2, 3, or empty string | Empty for non-instalment events; 0 converted to empty string. |
| AMOUNT | Decimal number with sign (+/-) | Monetary amount of the balance event. | 100.00, -50.00, -0.01 | Sign indicates balance impact: positive increases, negative decreases. |
| SETTLEMENT_CODE | String (settlement code pattern) or empty | Settlement code if the event is part of a settlement. | SET-BR-240915-001, empty string | Empty for confirmed but not yet settled events. |
Balance Report Summarised
Summary
This summary tab provides an overview of the monthly balance period, displaying four main financial tables.
Balance Report Summarised Sample
Transactions (USD)
The Transactions table shows initial balance, confirmed payments/refunds/chargebacks/reversals, settled amounts, and final balance.
| Field | Format | Description | Example | Edge Cases |
|---|---|---|---|---|
| Initial Balance by the end of (Month) | Decimal number with 2 decimal places | Starting balance from the previous reporting period. | 0.00, 100.00 | Zero for the first reporting period; carried forward from the previous month's final balance. |
| Payments in (Month) | Decimal number with 2 decimal places (positive) | Total confirmed payment amounts processed during the reporting period. Sum of all PAYMENT_CONFIRMED events where the event date is within the current period. | 10.00, 40.00 | Always positive or zero; represents gross payment amounts before fees. |
| Refunds in (Month) | Decimal number with 2 decimal places (negative) | Total refund amounts processed during the reporting period. Sum of all REFUND_CONFIRMED events where the event date is within the current period. | -10.00, -5.00 | Always negative or zero; displayed as negative to indicate balance reduction. |
| Chargebacks in (Month) | Decimal number with 2 decimal places (negative) | Total chargeback amounts processed during the reporting period. Sum of all CHARGEBACK_NOTIFIED events where the event date is within the current period. | -20.00, -10.00 | Always negative or zero; reduces merchant balance. |
| Reversals in (Month) | Decimal number with 2 decimal places (positive) | Total chargeback reversal amounts processed during the reporting period. Sum of all REVERSAL_NOTIFIED events where the event date is within the current period. | 10.00, 5.00 | Always positive or zero; adds back to merchant balance. |
| Settled in (Month) (w/o fees discounts) | Decimal number with 2 decimal places (can be +/-) | Total amounts settled during the period excluding fees and discounts. Sum of all settled events (payments, refunds, etc.) excluding fee events. | -10.00, -22.23 | Negative indicates a net debit from the balance; includes payout transfers. |
| Final Balance by the end of (Month) | Decimal number with 2 decimal places (can be +/-) | Ending balance after all confirmed and settled transactions. Initial Balance + Payments + Refunds + Chargebacks + Reversals + Settled. | 0.00, 20.00 | Can be negative if debits exceed credits; becomes the next period's initial balance. |
Accumulated Reserves (USD)
The Accumulated Reserves table displays reserve movements including initial balance, accumulated amounts, settled reserves, and final reserve balance.
| Field | Format | Description | Example | Edge Cases |
|---|---|---|---|---|
| Initial Balance by the end of (Month) | Decimal number with 2 decimal places | Starting reserve balance from the previous reporting period. | 0.00, 0.10 | Zero if no rolling reserve is configured; always non-negative. |
| Accumulated in (Month) | Decimal number with 2 decimal places (positive) | Reserve amounts accumulated during the reporting period. Sum of all ROLLING_RESERVE_DEBIT_SETTLED events in the current period. | 0.00, 0.10 | Zero if no reserves were accumulated; always non-negative. |
| Settled in (Month) (w/o fees discounts) | Decimal number with 2 decimal places (can be +/-) | Reserve amounts released/settled during the period. Sum of all ROLLING_RESERVE_CREDIT_SETTLED events in the current period. | 0.00 | Negative when reserves are released; zero if no reserve movements. |
| Final Balance by the end of (Month) | Decimal number with 2 decimal places | Ending reserve balance after all reserve movements. Initial Reserve Balance + Accumulated - Settled. | 0.00, 0.10 | Always non-negative; represents funds held in reserve. |
Total (USD)
The Total table combines transactions and reserves to show the complete financial position.
| Field | Format | Description | Example | Edge Cases |
|---|---|---|---|---|
| Initial Balance by the end of (Month) | Decimal number with 2 decimal places | Combined starting balance (transactions + reserves) from the previous reporting period. Sum of initial_processed_balance + initial_reserve_balance from the previous period. | 0.00, 100.00, 100.10 | Zero for the first reporting period; carried forward from the previous month's final total balance. |
| Processed in (Month) | Decimal number with 2 decimal places (can be +/-) | Total confirmed transactions (payments, refunds, etc.) plus accumulated reserves during the reporting period. total_amount = Payments + Refunds + Chargebacks + Reversals + Accumulated Reserves. | 10.00, 20.00, 38.60 | Can be negative if refunds/chargebacks exceed payments; represents all balance movements before settlement. |
| Settled in (Month) (w/o fees discounts) | Decimal number with 2 decimal places (can be +/-) | Total settled amounts (transactions + reserves) excluding fees and discounts. total_settled_amount = Transaction Settled Amount + Reserve Settled Amount. | -10.00, 0.00 | Negative when funds are transferred out; zero if no settlements occurred; excludes fees. |
| Final Balance by the end of (Month) | Decimal number with 2 decimal places | Ending total balance after all movements (transactions, reserves, and settlements). Initial Total Balance + Processed in Month + Settled in Month. | 0.00, 20.00, 8.58 | Can be negative if the merchant owes EBANX; becomes the next period's initial balance. |
Settled (USD)
The Settled table breaks down all settled amounts by type including payment fees, refund costs, chargeback fees, reversals, payouts, rolling reserves, other entries, and the net settled amount.
| Field | Format | Description | Example | Edge Cases |
|---|---|---|---|---|
| Total processed | Decimal number with 2 decimal places (positive) | Total payment amount processed during settlement period (gross payment amount before fees). Sum of all PAYMENT_SETTLED events in the period. | 10.00, 100.00 | Always positive or zero; represents gross settled payments before fee deduction. |
| Payment fee | Decimal number with 2 decimal places (negative) | Processing fees charged on payments. Sum of all FEE_PAYMENT_TOTAL events in the period. | -0.01, -10.00 | Always negative or zero; does not change settled_net_amount directly. |
| Refund cost | Decimal number with 2 decimal places (negative) | Cost of refunds processed. Sum of all REFUND_SETTLED events in the period. | 0.00, -10.00 | Always negative or zero; represents refund amounts returned to customers. |
| Refund fee | Decimal number with 2 decimal places (negative) | Fees charged for processing refunds. Sum of all FEE_REFUND_TOTAL events in the period. | 0.00, -2.00 | Always negative or zero; does not change settled_net_amount directly. |
| Chargeback cost | Decimal number with 2 decimal places (negative) | Cost of chargebacks. Sum of all CHARGEBACK_SETTLED events in the period. | 0.00, -20.00 | Always negative or zero; represents amounts lost to chargebacks. |
| Chargeback fee | Decimal number with 2 decimal places (negative) | Fees for chargeback processing. Sum of all FEE_CHARGEBACK_TOTAL events in the period. | 0.00, -15.00 | Always negative or zero; does not change settled_net_amount directly. |
| Reversal | Decimal number with 2 decimal places (positive) | Chargeback reversal amounts. Sum of all REVERSAL_SETTLED events in the period. | 0.00, 10.00 | Always positive or zero; represents amounts recovered from won disputes. |
| Payout | Decimal number with 2 decimal places (negative) | Payout transfer amounts. Sum of all PAYOUT_TRANSFER_SETTLED events in the period. | 0.00, -100.00 | Always negative or zero; represents funds transferred out via payout system. |
| Rolling reserve | Decimal number with 2 decimal places (can be +/-) | Reserve amounts held/released. Sum of all ROLLING_RESERVE debit and credit events in the period. | -0.10, 10.00 | Negative when reserves are held; positive when reserves are released. |
| Other entries | Decimal number with 2 decimal places (can be +/-) | Miscellaneous settlement entries. Sum of all SETTLEMENT_ENTRY_SETTLED events in the period. | 12.34, -5.00 | Can be positive (credits) or negative (debits). |
| Net amount | Decimal number with 2 decimal places (can be +/-) | Final net amount after all adjustments. Sum of all settled amounts in this table. | 9.99, 22.23 | Can be negative if debits exceed credits; represents the actual cash flow impact. |
Detailed Summary
This detailed summary tab provides a country-by-country breakdown of all balance movements during the reporting period. For each country, the tab displays initial and final balances, confirmed transactions (payments, refunds, chargebacks, reversals), settled transactions with FX variations and estimation corrections, settled fees by transaction type, credit and debit entries, and bucket results showing the net change for the period. All amounts are shown in both local currency and USD, with EUR amounts included for applicable countries, providing a multi-currency view of the merchant's financial position.
The Detailed Summary tab is organized as a vertical layout per country. The sections below describe the rows in order as they appear in the report.
Initial Balance by the end of (last month) - transactions
This row shows the starting transaction balance carried forward from the previous reporting period.
Confirmed and settled transactions
The following fields describe all confirmed and settled transaction activity during the current reporting period:
| Field | Format | Description | Example | Edge Cases |
|---|---|---|---|---|
| confirmed_payments | Decimal number with 2 decimal places (positive) | Total confirmed payment amounts during the reporting period. Sum of all PAYMENT_CONFIRMED events where the event date is within the current period. | 10.00, 40.00 | Always positive or zero; represents gross payment amounts before fees. |
| confirmed_refunds | Decimal number with 2 decimal places (negative) | Total confirmed refund amounts during the reporting period. Sum of all REFUND_CONFIRMED events in the period. | -10.00, -5.00 | Always negative or zero; reduces balance; also increments not_settled_refunds. |
| confirmed_chargebacks | Decimal number with 2 decimal places (negative) | Total confirmed chargeback amounts during the reporting period. Sum of all CHARGEBACK_NOTIFIED events in the period. | -20.00, -10.00 | Always negative or zero; reduces balance; also increments not_settled_chargebacks. |
| settled_gross_amount | Decimal number with 2 decimal places (negative) | Gross settled payment amount (net amount after fees). Sum of all PAYMENT_SETTLED events; includes fee deduction. | -10.00, -100.00 | Negative when funds are transferred out; represents payment amount after fee deduction. |
| payments_fx_variation | Decimal number with 2 decimal places (can be +/-) | Foreign exchange variation for payments between confirmation and settlement. Sum of all PAYMENT_SETTLED_FX_VARIATION events. | 0.19, -1.00 | Can be positive (FX gain) or negative (FX loss); only for cross-border transactions. |
| settled_refunds | Decimal number with 2 decimal places (positive) | Settled refund amounts during the reporting period. Sum of all REFUND_SETTLED events. | 10.00, 5.00 | Positive when refund is settled; also decrements not_settled_refunds. |
| refunds_fx_variation | Decimal number with 2 decimal places (can be +/-) | Foreign exchange variation for refunds between confirmation and settlement. Sum of all REFUND_SETTLED_FX_VARIATION events. | 5.78, -1.00 | Can be positive or negative; only applies to cross-border refunds. |
| settled_chargebacks | Decimal number with 2 decimal places (positive) | Settled chargeback amounts during the reporting period. Sum of all CHARGEBACK_SETTLED events. | 20.00, 10.00 | Positive when chargeback is settled; also decrements not_settled_chargebacks. |
| chargebacks_estimation_correction | Decimal number with 2 decimal places (can be +/-) | Correction for chargeback estimation differences between notification and settlement. Sum of all CHARGEBACK_ESTIMATION_CORRECTION events. | -5.97, 3.00 | Can be positive (favoring merchant) or negative (additional cost). |
| settled_chargeback_reversals | Decimal number with 2 decimal places (negative) | Settled chargeback reversal amounts during the reporting period. Sum of all REVERSAL_SETTLED events. | -10.00, -5.00 | Negative (credit to merchant) when reversal is settled; decrements not_settled_reversals. |
| reversals_estimation_correction | Decimal number with 2 decimal places (can be +/-) | Correction for reversal estimation differences between notification and settlement. Sum of all REVERSAL_ESTIMATION_CORRECTION events. | 5.97, -4.00 | Can be positive or negative; decrements not_settled_reversals. |
| settled_payout_transfers_cost | Decimal number with 2 decimal places (positive) | Settled payout transfer amounts during the reporting period. Sum of all PAYOUT_TRANSFER_SETTLED events. | 5.00, 10.00 | Positive when payout is settled; represents cost to merchant. |
(current month) balance Final balance by the end of (current month)
These rows show the calculated balance and final balance for the current period. The following fields describe the fees, adjustments, and final result:
| Field | Format | Description | Example | Edge Cases |
|---|---|---|---|---|
| settled_payments_fees | Decimal number with 2 decimal places (negative) | Settled payment processing fees during the reporting period. Sum of all FEE_PAYMENT_TOTAL events in the period. | -0.01, -10.00 | Always negative or zero; does not change settled_net_amount directly. |
| settled_refunds_fees | Decimal number with 2 decimal places (negative) | Settled refund processing fees during the reporting period. Sum of all FEE_REFUND_TOTAL events in the period. | -0.01, -5.00 | Always negative or zero; only applied when refunds are settled. |
| settled_chargebacks_fees | Decimal number with 2 decimal places (negative) | Settled chargeback processing fees during the reporting period. Sum of all FEE_CHARGEBACK_TOTAL events in the period. | -15.00, -20.00 | Always negative or zero; charged per chargeback event. |
| settled_payouts_fees | Decimal number with 2 decimal places (negative) | Settled payout processing fees during the reporting period. Sum of all FEE_PAYOUT_TOTAL events in the period. | -0.50, -5.00 | Always negative or zero; only applied when payouts are processed. |
| other_settlement_credits | Decimal number with 2 decimal places (positive) | Miscellaneous settlement credit entries during the reporting period. Sum of all CREDIT_ENTRY_SETTLED events in the period. | 12.34, 50.00 | Always positive or zero; used for manual adjustments and corrections. |
| other_settlement_debits | Decimal number with 2 decimal places (negative) | Miscellaneous settlement debit entries during the reporting period. Sum of all DEBIT_ENTRY_SETTLED events in the period. | -5.00, -25.00 | Always negative or zero; used for manual adjustments and corrections. |
| result | Decimal number with 2 decimal places (can be +/-) | Final calculated result after all balance adjustments for the current month. Balance + Settled Fees (payments, etc.) + Other Credits + Other Debits. | -43.03, 8.58 | Can be negative if fees/debits exceed credits; represents the period's financial impact. |
Still need help?
We hope this article was helpful. If you still have questions, you can explore the following options:
- Merchant support: Contact our support team at sales.engineering@ebanx.com for assistance.
- Not a partner yet? Please complete the Merchant Signup Form, and our commercial team will reach out to you.