Categorias e tipos de relatórios
Saiba mais sobre as categorias em objetos BalanceTransaction e suas distinções.
Saiba mais sobre o campo reporting_ nos objetos BalanceTransaction e qual a diferença para o campo type e outras categorias. Este tópico abrange:
Por que introduzir uma nova categorização?
O campo reporting_ do objeto BalanceTransaction melhora o campo type, trazendo agrupamentos mais úteis para a maioria das finalidades financeiras e de relatórios. As seguintes seções explicam as vantagens do novo campo.
Mais detalhes de type=adjustment
O atributo reporting_ separa as transações de saldo com type=adjustment em várias categorias, como contestações, anulações de contestações e reembolsos malsucedidos. Além disso, vários tipos de tarifas e reembolsos de tarifas de plataforma Connect agora são explicitamente categorizadas com o reporting_.
Uma categoria separada de anulações de captura parcial
Se estiver autorizando e capturando pagamentos separadamente e capturar um valor inferior à autorização inicial, você verá duas transações de saldo: uma para o valor total da autorização e outro anulando a parte não capturada. A soma das duas transações de saldo resulta na parte capturada da cobrança.
A transação de saldo que anula a parte não capturada tem type=refund, assim como se você tivesse reembolsado uma parte de uma venda em um momento posterior. Para permitir o tratamento separado desses dois objetos — talvez compensando-os no valor da venda inicial, em vez de como um reembolso separado — eles são rotulados com a categoria distinta de relatórios partial_.
Consolide vários tipos em categorias comuns
Com o campo type, as transações de saldo resultantes de cobranças no cartão são representadas com type=charge, enquanto aquelas feitas com outras formas de pagamento são representadas com type=payment. Reembolsos e falhas de cartões também são separados dos de outras formas de pagamento, com os tipos refund e payment_, respectivamente.
Constatamos que essas distinções complicavam várias tarefas comuns de relatórios e, por isso, reporting_ simplifica esses (e outros) grupos de tipos, assim:
| Tipos de transação de saldo | Categoria de relatório |
|---|---|
charge, payment | charge |
refund, payment_ | refund |
payout_, payout_ | payout_ |
transfer, recipient_ | transfer |
transfer_, transfer_, recipient_, recipient_ | transfer_ |
Nomes de categorias mais descritivos
Renomeamos vários tipos de transação de saldo para maior clareza:
| Tipo de transação de saldo | Categoria de relatório |
|---|---|
application_ | platform_ |
application_ | platform_ |
stripe_ | fee |
reserve_ | connect_ |
reserved_ | risk_ |
Referência sobre categorias de relatórios
Essa referência abrange quatro grupos de categorias de relatórios:
- Payments-related reporting categories
- Balance-related reporting categories
- Issuing-related reporting categories
- Connect-related reporting categories
Payments-related reporting categories
These reporting categories are related to creating and refunding charges as part of processing payments.
chargeCharges include payments from cards and from other payment methods. If you are separately authorizing and capturing payments, only the captured charges will be included here.
- Tipos de transação de saldo:
charge,payment, orvalidation - Seções no relatório mensal:Payments (cards), Payments (other)
- Tipos de transação de saldo:
charge_failure ACH, direct debit, and other asynchronous payment methods remain in a pending state until they either succeed or fail. You will see a pending balance transaction with the reporting category
chargeappear when the payment is created in a pending state. Acharge_will appear if the pending payment later fails.failure - Tipos de transação de saldo:
payment_failure_ refund - Seções no relatório mensal:Other Adjustments
- Tipos de transação de saldo:
disputeWhen a customer disputes a charge, Stripe deducts the disputed amount from your balance.
- Tipos de transação de saldo:
adjustmentoradjusted_for_ overdraft_ transaction - Seções no relatório mensal:Disputes
- Tipos de transação de saldo:
dispute_reversal When you win a dispute, the disputed amount is returned to your balance.
- Tipos de transação de saldo:
adjustment - Seções no relatório mensal:Dispute Reversals
- Tipos de transação de saldo:
partial_capture_ reversal If you are separately authorizing and capturing payments, and you capture an amount less than the initial authorization, you will see a
chargefor the full authorization amount, and apartial_for the uncaptured portion.capture_ reversal - Tipos de transação de saldo:
refund - Seções no relatório mensal:Payments (cards)
- Tipos de transação de saldo:
refundPayments you’ve refunded to your customers. (Does not include charge failures or partial capture reversals, which are listed separately.)
- Tipos de transação de saldo:
refundorpayment_refund - Seções no relatório mensal:Refunds (cards), Refunds (other)
- Tipos de transação de saldo:
refund_failure Created when a credit card charge refund fails, and Stripe returns the funds to your balance.
This may occur if your customer’s bank or card issuer is unable to correctly process a refund (e.g., due to a closed bank account or a problem with the card).
- Tipos de transação de saldo:
refund_failure - Seções no relatório mensal:Other Adjustments
- Tipos de transação de saldo:
Balance-related reporting categories
These reporting categories are related to changes that affect your Stripe balance, such as payouts, fees, and top-ups.
anticipation_repayment Repayments made to service an anticipation loan in Brazil. These repayments go to the financial institution to whom you have sold your receivables.
- Tipos de transação de saldo:
anticipation_repayment - Seções no relatório mensal:Anticipation Repayments
- Tipos de transação de saldo:
climate_order_ purchase Funds used to purchase carbon removal units from Frontier Climate.
- Tipos de transação de saldo:
climate_ororder_ purchase climate_reservation_ purchase - Seções no relatório mensal:Other Adjustments
- Tipos de transação de saldo:
climate_order_ refund Funds refunded to your balance when a Climate Order is canceled.
- Tipos de transação de saldo:
climate_ororder_ refund climate_reservation_ refund - Seções no relatório mensal:Other Adjustments
- Tipos de transação de saldo:
contributionFunds contributed via Stripe to a cause (currently Stripe Climate).
- Tipos de transação de saldo:
contribution - Seções no relatório mensal:Other Adjustments
- Tipos de transação de saldo:
fee- Tipos de transação de saldo:
stripe_fee - Seções no relatório mensal:Other Adjustments
- Tipos de transação de saldo:
other_adjustment Miscellaneous adjustments to your Stripe balance.
- Tipos de transação de saldo:
adjustment,obligation_, oroutbound obligation_reversal_ inbound - Seções no relatório mensal:Other Adjustments
- Tipos de transação de saldo:
payment_network_ reserve_ hold Funds that a payment network holds in reserve (e.g. to mitigate risk).
- Tipos de transação de saldo:
payment_network_ reserve_ hold - Seções no relatório mensal:Other Adjustments
- Tipos de transação de saldo:
payment_network_ reserve_ release Funds that a payment network releases from a reserve.
- Tipos de transação de saldo:
payment_network_ reserve_ release - Seções no relatório mensal:Other Adjustments
- Tipos de transação de saldo:
payoutPayouts from your Stripe balance to your bank account.
- Tipos de transação de saldo:
payout - Seções no relatório mensal:Payouts and Transfers
- Tipos de transação de saldo:
payout_reversal Funds returned to your balance if a payout fails after it is initially created (e.g., due to an invalid account number or a cancellation). Learn more.
- Tipos de transação de saldo:
payout_orcancel payout_failure - Seções no relatório mensal:Payouts and Transfers: Failures and Refunds
- Tipos de transação de saldo:
risk_reserved_ funds When Stripe holds your funds in reserve to mitigate risk, two balance transactions are created: one to debit the funds from your balance, and a second to credit the funds back to your balance at the end of the reserve period.
- Tipos de transação de saldo:
reserved_funds - Seções no relatório mensal:Other Adjustments
- Tipos de transação de saldo:
taxTaxes collected by Stripe to be remitted to the appropriate local governments. Typically, this is a tax on Stripe fees.
- Tipos de transação de saldo:
tax_fee - Seções no relatório mensal:Other Adjustments
- Tipos de transação de saldo:
topupFunds you transferred into your Stripe balance from your bank account. Learn more.
- Tipos de transação de saldo:
topup - Seções no relatório mensal:Other Adjustments
- Tipos de transação de saldo:
topup_reversal If an initially successful top-up fails or is cancelled, the credit to your Stripe balance is reversed. Learn more.
- Tipos de transação de saldo:
topup_reversal - Seções no relatório mensal:Other Adjustments
- Tipos de transação de saldo:
unreconciled_customer_ funds When a customer has unreconciled funds within Stripe for more than ninety days, Stripe transfers those funds to your balance.
- Tipos de transação de saldo:
transferred_to_ balance_ transaction - Seções no relatório mensal:Other Adjustments
- Tipos de transação de saldo:
Issuing-related reporting categories
These reporting categories are created as part of using the Issuing API.
issuing_authorization_ hold When an issued card is used to make a purchase, an authorization is created. If the authorization is approved, a balance transaction is created with the type
issuing_to hold the authorized amount in reserve from your account balance, until the authorization is either captured or voided. Some merchants can also update an authorization to request an additional amount (e.g., to extend a hotel booking or add a tip), and this is also represented as a balance transaction with the typeauthorization_ hold issuing_.authorization_ hold - Tipos de transação de saldo:
issuing_authorization_ hold - Seções no relatório mensal:Other Adjustments
- Tipos de transação de saldo:
issuing_authorization_ release When an authorized purchase, made with an issued card, is captured by the merchant, the funds previously held for the authorization (
issuing_) are released with aauthorization_ hold issuing_balance transaction. Simultaneously, an issuing transaction is created, and the purchase amount is deducted from your Stripe balance in another balance transaction with the typeauthorization_ release issuing_.transaction - Tipos de transação de saldo:
issuing_authorization_ release - Seções no relatório mensal:Other Adjustments
- Tipos de transação de saldo:
issuing_disbursement Credits to your balance for rewards, discounts, and other miscellaneous adjustments.
- Tipos de transação de saldo:
issuing_disbursement - Seções no relatório mensal:Other Adjustments
- Tipos de transação de saldo:
issuing_dispute When you dispute an Issuing transaction and funds return to your Stripe balance.
- Tipos de transação de saldo:
issuing_dispute - Seções no relatório mensal:Other Adjustments
- Tipos de transação de saldo:
issuing_dispute_ fraud_ liability_ debit Funds deducted from your account to cover fraud loss liability
- Tipos de transação de saldo:
issuing_dispute_ fraud_ liability_ debit - Seções no relatório mensal:Other Adjustments
- Tipos de transação de saldo:
issuing_dispute_ provisional_ credit Provisional Credit granted to Issuing balance
- Tipos de transação de saldo:
issuing_dispute_ provisional_ credit - Seções no relatório mensal:Other Adjustments
- Tipos de transação de saldo:
issuing_dispute_ provisional_ credit_ reversal Previous Provisional Credit being reversed from Issuing balance
- Tipos de transação de saldo:
issuing_dispute_ provisional_ credit_ reversal - Seções no relatório mensal:Other Adjustments
- Tipos de transação de saldo:
issuing_transaction When an authorized purchase, made with an issued card, has been authorized and captured by the merchant, an issuing transaction is created, and the purchase amount is deducted from your Stripe balance with a
issuing_balance transaction.transaction - Tipos de transação de saldo:
issuing_transaction - Seções no relatório mensal:Other Adjustments
- Tipos de transação de saldo:
Connect-related reporting categories
These reporting categories are related to using the Connect API and related APIs, such as instant payouts.
advanceIncrementing available funds for instant payouts. This occurs when you create an instant payout and the requested payout amount is greater than your connected account’s available balance. Funds are added to your available balance and removed from your pending balance to cover the difference.
- Tipos de transação de saldo:
advance - Seções no relatório mensal:Other Adjustments
- Tipos de transação de saldo:
advance_funding Decrementing pending funds for instant payouts. This occurs when you create an instant payout and the requested payout amount is greater than your connected account’s available balance. Funds are added to your available balance and removed from your pending balance to cover the difference.
- Tipos de transação de saldo:
advance_funding - Seções no relatório mensal:Other Adjustments
- Tipos de transação de saldo:
connect_collection_ transfer If one of your connected accounts has a negative balance for 180 days, Stripe transfers a portion of your balance, to zero out that account’s balance. Learn more.
- Tipos de transação de saldo:
connect_collection_ transfer - Seções no relatório mensal:Reflected in "Reserve" section
- Tipos de transação de saldo:
connect_reserved_ funds If one of your connected accounts’ balances becomes negative, Stripe temporarily reserves a portion of your balance to ensure that funds can be covered.
If one of your connected accounts’ previously negative balance becomes less negative due to activity on account, another
reserve_is created to release a corresponding portion of the funds held in reserve. Learn more.transaction - Tipos de transação de saldo:
reserve_transaction - Seções no relatório mensal:Reflected in "Reserve" section
- Tipos de transação de saldo:
platform_earning Earnings you’ve generated by collecting platform fees via Stripe Connect charges.
- Tipos de transação de saldo:
application_fee - Seções no relatório mensal:Application Revenue
- Tipos de transação de saldo:
platform_earning_ refund Platform fees that you have returned to your connected accounts.
- Tipos de transação de saldo:
application_fee_ refund - Seções no relatório mensal:Application Revenue Returned
- Tipos de transação de saldo:
transferFunds sent from your balance to the balance of your connected accounts.
- Tipos de transação de saldo:
transferorrecipient_transfer - Seções no relatório mensal:Payouts and Transfers
- Tipos de transação de saldo:
transfer_reversal Transfers to your connected accounts that have been cancelled.
- Tipos de transação de saldo:
transfer_,cancel transfer_,refund recipient_, ortransfer_ cancel recipient_transfer_ failure - Seções no relatório mensal:Payouts and Transfers: Failures and Refunds
- Tipos de transação de saldo: