レポートのカテゴリーとタイプ
BalanceTransaction オブジェクトのカテゴリーと、その違いを理解します。
BalanceTransaction オブジェクトの reporting_ フィールドの詳細、および type や他のカテゴリとの違いを説明します。このトピックの内容は以下のとおりです。
新しいカテゴリ分類を導入する理由
BalanceTransaction オブジェクトの reporting_ フィールドは、多くの財務およびレポート作成に有益なグループ化を提供することにより、type フィールドの機能を向上します。次のセクションでは、新しいフィールドのメリットについて説明します。
type=adjustment のより詳細な内訳
reporting_ 属性は、type=adjustment が設定された取引残高を、不審請求の申請、不審請求の申請の差戻し、返金の失敗など、数種類のカテゴリーに分類します。さらに、いくつかのタイプの手数料と Connect プラットフォーム手数料の返金は、reporting_ で明示的に分類されるようになりました。
部分キャプチャの差戻しに使用される個別のカテゴリ
支払いのオーソリとキャプチャーを別々に行い、キャプチャー金額が初期のオーソリ額より低い場合、オーソリ全額に関する取引残高と、キャプチャーされなかった部分の差戻しに対応する取引残高の 2 つが表示されます (2 つの取引残高を合計すると、キャプチャーされた部分の支払いとなります)。
キャプチャされなかった部分を差戻す取引残高には type=refund が設定され、しばらくしてから販売の一部を返金したかのように見えます。これらのオブジェクトを個別に処理できるようにするために (多くの場合、個別の返金ではなく、最初の販売額に対して計算します)、オブジェクトに別個のレポートカテゴリ partial_ のラベルを付けます。
複数のタイプを共通のカテゴリに統合する
type フィールドを使用すると、カードベースの支払いから発生する取引残高は type=charge で表され、その他の支払い方法で行われた取引残高は type=payment で表されます。同様に、カードとカード以外の支払い方法で行われた返金と失敗は、それぞれ refund と payment_ という異なるタイプで表されます。
これらの区別により、一般的なレポートタスクの多くで不必要に手間がかかることがわかりました。そのため、reporting_ は、次のように、これら (およびその他の) タイプのグループを単純化します。
| 取引残高タイプ | レポートカテゴリ |
|---|---|
charge、payment | charge |
refund、payment_ | refund |
payout_、payout_ | payout_ |
transfer、recipient_ | transfer |
transfer_、transfer_、recipient_、recipient_ | transfer_ |
より分かりやすいカテゴリ名
分かりやすくするために、以下のとおり、いくつかの取引残高タイプの名前を変更しました。
| 取引残高タイプ | レポートカテゴリ |
|---|---|
application_ | platform_ |
application_ | platform_ |
stripe_ | fee |
reserve_ | connect_ |
reserved_ | risk_ |
レポートカテゴリのリファレンス
このリファレンスでは、レポートカテゴリの 4 つのグループについて説明します。
- 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.
- 取引残高タイプ:
charge,payment, orvalidation - 月次レポートのセクション: Payments (cards), Payments (other)
- 取引残高タイプ:
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 - 取引残高タイプ:
payment_failure_ refund - 月次レポートのセクション: Other Adjustments
- 取引残高タイプ:
disputeWhen a customer disputes a charge, Stripe deducts the disputed amount from your balance.
- 取引残高タイプ:
adjustmentoradjusted_for_ overdraft_ transaction - 月次レポートのセクション: Disputes
- 取引残高タイプ:
dispute_reversal When you win a dispute, the disputed amount is returned to your balance.
- 取引残高タイプ:
adjustment - 月次レポートのセクション: Dispute Reversals
- 取引残高タイプ:
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 - 取引残高タイプ:
refund - 月次レポートのセクション: Payments (cards)
- 取引残高タイプ:
refundPayments you’ve refunded to your customers. (Does not include charge failures or partial capture reversals, which are listed separately.)
- 取引残高タイプ:
refundorpayment_refund - 月次レポートのセクション: Refunds (cards), Refunds (other)
- 取引残高タイプ:
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).
- 取引残高タイプ:
refund_failure - 月次レポートのセクション: Other Adjustments
- 取引残高タイプ:
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.
- 取引残高タイプ:
anticipation_repayment - 月次レポートのセクション: Anticipation Repayments
- 取引残高タイプ:
climate_order_ purchase Funds used to purchase carbon removal units from Frontier Climate.
- 取引残高タイプ:
climate_ororder_ purchase climate_reservation_ purchase - 月次レポートのセクション: Other Adjustments
- 取引残高タイプ:
climate_order_ refund Funds refunded to your balance when a Climate Order is canceled.
- 取引残高タイプ:
climate_ororder_ refund climate_reservation_ refund - 月次レポートのセクション: Other Adjustments
- 取引残高タイプ:
contributionFunds contributed via Stripe to a cause (currently Stripe Climate).
- 取引残高タイプ:
contribution - 月次レポートのセクション: Other Adjustments
- 取引残高タイプ:
fee- 取引残高タイプ:
stripe_fee - 月次レポートのセクション: Other Adjustments
- 取引残高タイプ:
other_adjustment Miscellaneous adjustments to your Stripe balance.
- 取引残高タイプ:
adjustment,obligation_, oroutbound obligation_reversal_ inbound - 月次レポートのセクション: Other Adjustments
- 取引残高タイプ:
payment_network_ reserve_ hold Funds that a payment network holds in reserve (e.g. to mitigate risk).
- 取引残高タイプ:
payment_network_ reserve_ hold - 月次レポートのセクション: Other Adjustments
- 取引残高タイプ:
payment_network_ reserve_ release Funds that a payment network releases from a reserve.
- 取引残高タイプ:
payment_network_ reserve_ release - 月次レポートのセクション: Other Adjustments
- 取引残高タイプ:
payoutPayouts from your Stripe balance to your bank account.
- 取引残高タイプ:
payout - 月次レポートのセクション: Payouts and Transfers
- 取引残高タイプ:
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.
- 取引残高タイプ:
payout_orcancel payout_failure - 月次レポートのセクション: Payouts and Transfers: Failures and Refunds
- 取引残高タイプ:
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.
- 取引残高タイプ:
reserved_funds - 月次レポートのセクション: Other Adjustments
- 取引残高タイプ:
taxTaxes collected by Stripe to be remitted to the appropriate local governments. Typically, this is a tax on Stripe fees.
- 取引残高タイプ:
tax_fee - 月次レポートのセクション: Other Adjustments
- 取引残高タイプ:
topupFunds you transferred into your Stripe balance from your bank account. Learn more.
- 取引残高タイプ:
topup - 月次レポートのセクション: Other Adjustments
- 取引残高タイプ:
topup_reversal If an initially successful top-up fails or is cancelled, the credit to your Stripe balance is reversed. Learn more.
- 取引残高タイプ:
topup_reversal - 月次レポートのセクション: Other Adjustments
- 取引残高タイプ:
unreconciled_customer_ funds When a customer has unreconciled funds within Stripe for more than ninety days, Stripe transfers those funds to your balance.
- 取引残高タイプ:
transferred_to_ balance_ transaction - 月次レポートのセクション: Other Adjustments
- 取引残高タイプ:
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 - 取引残高タイプ:
issuing_authorization_ hold - 月次レポートのセクション: Other Adjustments
- 取引残高タイプ:
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 - 取引残高タイプ:
issuing_authorization_ release - 月次レポートのセクション: Other Adjustments
- 取引残高タイプ:
issuing_disbursement Credits to your balance for rewards, discounts, and other miscellaneous adjustments.
- 取引残高タイプ:
issuing_disbursement - 月次レポートのセクション: Other Adjustments
- 取引残高タイプ:
issuing_dispute When you dispute an Issuing transaction and funds return to your Stripe balance.
- 取引残高タイプ:
issuing_dispute - 月次レポートのセクション: Other Adjustments
- 取引残高タイプ:
issuing_dispute_ fraud_ liability_ debit Funds deducted from your account to cover fraud loss liability
- 取引残高タイプ:
issuing_dispute_ fraud_ liability_ debit - 月次レポートのセクション: Other Adjustments
- 取引残高タイプ:
issuing_dispute_ provisional_ credit Provisional Credit granted to Issuing balance
- 取引残高タイプ:
issuing_dispute_ provisional_ credit - 月次レポートのセクション: Other Adjustments
- 取引残高タイプ:
issuing_dispute_ provisional_ credit_ reversal Previous Provisional Credit being reversed from Issuing balance
- 取引残高タイプ:
issuing_dispute_ provisional_ credit_ reversal - 月次レポートのセクション: Other Adjustments
- 取引残高タイプ:
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 - 取引残高タイプ:
issuing_transaction - 月次レポートのセクション: Other Adjustments
- 取引残高タイプ:
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.
- 取引残高タイプ:
advance - 月次レポートのセクション: Other Adjustments
- 取引残高タイプ:
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.
- 取引残高タイプ:
advance_funding - 月次レポートのセクション: Other Adjustments
- 取引残高タイプ:
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.
- 取引残高タイプ:
connect_collection_ transfer - 月次レポートのセクション: Reflected in "Reserve" section
- 取引残高タイプ:
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 - 取引残高タイプ:
reserve_transaction - 月次レポートのセクション: Reflected in "Reserve" section
- 取引残高タイプ:
platform_earning Earnings you’ve generated by collecting platform fees via Stripe Connect charges.
- 取引残高タイプ:
application_fee - 月次レポートのセクション: Application Revenue
- 取引残高タイプ:
platform_earning_ refund Platform fees that you have returned to your connected accounts.
- 取引残高タイプ:
application_fee_ refund - 月次レポートのセクション: Application Revenue Returned
- 取引残高タイプ:
transferFunds sent from your balance to the balance of your connected accounts.
- 取引残高タイプ:
transferorrecipient_transfer - 月次レポートのセクション: Payouts and Transfers
- 取引残高タイプ:
transfer_reversal Transfers to your connected accounts that have been cancelled.
- 取引残高タイプ:
transfer_,cancel transfer_,refund recipient_, ortransfer_ cancel recipient_transfer_ failure - 月次レポートのセクション: Payouts and Transfers: Failures and Refunds
- 取引残高タイプ: