レポートの提供と照合非公開プレビュー
連結アカウントに Capital レポートを提供し、既存のレポートで Capital 取引を照合する方法を学習します。
プライベートプレビュー
プラットフォーム向け Capital はプライベートプレビュー中です。アクセス登録 が可能です。
このガイドの用途:
- Capital レポートの提供:連結アカウントに Capital 取引レポートを提供します。これらのレポートを使用して、未払い残高、決済履歴、融資契約などのデータを表示できます。連結アカウントに複数の方法でレポートを提供できます。
- Capital 取引を含む既存レポートの照合:プラットフォームの UI で連結アカウントにレポートをすでに提供している場合は、Stripe API を使用してそれらの既存レポートで Capital 取引データを同期します。
融資オファーには、入金、返済、差戻しの三種類の取引があります。Stripe APIを使用したレポート提供 をご希望の場合、これらの取引について以下で詳しく説明します。
レポート提供のオプション
連結アカウントに Capital レポートを複数の方法で提供でき、複数のオプションを使用できます。
メール | 連結アカウントは、オファー承認と入金支払い、および週次決済進捗更新についてメールを通じて通知を受け取ります。これらの共同ブランドのメールには、連結アカウントを別のStripeホストのCapitalページにリダイレクトするリンクが含まれており、そこで彼らは自分のCapital取引と決済進捗を確認できます。このページには、標準的な決済処理の詳細(元の請求額、プラットフォーム手数料および処理手数料、返金、または不審請求の申し立てなど)は含まれていません。 アカウント登録中に Stripeがあなたの代わりにメールを送信する ことを選択した場合、これを自動的に行います。 |
埋め込みコンポーネント | プラットフォームのUIにCapital 融資コンポーネントを埋め込みます。これにより、連結アカウントがプラットフォームの UI で直接アクセスできる取引レポートを表示できます。このコンポーネントには、標準的な決済処理情報(支払い、返金、または不審請求の申し立てなど)は含まれていません。 このコンポーネントを実装するには、Capital 融資を参照してください。 |
API | Financing Transactions APIを使用して、詳細な決済データ (支払い、返金、または不審請求の申し立てなどの標準的な決済処理情報を含む) とともに Capital 取引を監視および表示します。独自のカスタムレポートインターフェースを構築することもできます。 これらのAPIを使用するには、このガイドを続けてお読みください。 |
はじめに
APIを使用してレポートを提供したい場合は、次のタイプの取引を確認してください:
入金 | Stripe は (金融パートナーと共に)、融資契約の条件に従って、承認され受け入れられた融資オファーの入金資金を連結アカウントに自動的に配分します。Capital 資金供給は、連結アカウントの通常の入金とは独立しています。これらの入金を促進するために、プラットフォームからの追加のアクションは必要ありません。 |
返済 | 融資金額の支払いに使用される決済。3 つのタイプの返済取引が利用可能です。
Capital の源泉徴収は、決済処理と同時に発生し、Connect ボリューム手数料とプラットフォームアプリ手数料は、全額請求額に基づいて計算されます。連結アカウントに送金される最終的な金額は、元の決済金額からプラットフォームアプリ手数料と Capital の源泉徴収を差し引いたものです。たとえば、連結アカウントが 15% の源泉徴収率の融資オファーを受け入れます。1日に100 USDの決済を 5 回受け入れた場合、プラットフォームアプリ手数料と Capital の源泉徴収を差し引いた後の総入金額は405 USDです。 |
差戻し | Stripe は以下の状況で入金または返済取引を差戻しする場合があります。
|
資金提供取引 API または 取引残高 APIを使用して取引を取得できます。
始めるには、API を選択してください。
取引残高 APIを使用する既存の統合がある場合は、この導入オプションを使用してください。ほとんどの取引タイプを返しますが、連結アカウントの融資オファーなどの追加情報は含まれません。
Capital 取引の監視
次の取引残高タイプ は、マーチャントキャッシュアドバンスやローンを含む、連結アカウントの融資に関連しています。
- 入金:
financing_
payout - 返済:
financing_
paydown - 差戻し:
financing_
またはpayout_ reversal financing_
paydown_ reversal
入金
各入金取引には、タイプfinancing_
の取引残高オブジェクトがあります。プラットフォームの UI にある取引残高またはそれに相当するモデルのリストに入金を表示できます。
返済
各入金取引には、タイプfinancing_
の取引残高オブジェクトがあります。プラットフォームの UI で源泉徴収取引を表示するには:
- 取引残高を取得 を行い、取引タイプでフィルタリングします。
Stripe-Account
ヘッダーに連結アカウントのアカウント ID を指定します。
以下に例を示します。
取引残高のリストの取得に成功すると、次のようなレスポンスを受け取ります。
{ "object": "list", "data": [ { "id": "txn_abcdef123456", "object": "balance_transaction", "amount": -1550, "available_on": 123456789, "created": 123456789, "currency": "usd", "description": "Withheld funds from py_abcdef123456 to pay down flex loan flxln_abcdef123456", "exchange_rate": null, "fee": 0, "fee_details": [], "net": -1550, "reporting_category": "financing_paydown", "source": "cptxn_abcdef123456", "status": "available", "type": "financing_paydown" }, ... ], "has_more": false, "url": "/v1/balance_transactions" }
この返済が Stripe 決済での Capital 源泉徴収により発生した場合、レスポンスの description
フィールドはこの Stripe 決済を参照します。例えば、返済には「ローンflxln_
の返済のため、ch_
から資金を源泉徴収」という説明が含まれる場合があります。
取引残高のソースフィールドを展開することで、該当する資金調達取引オブジェクトを取得できます。
展開すると、source
フィールドに融資取引の詳細が表示されます:
{ "object": "list", "data": [ { "id": "txn_abcdef123456", "object": "balance_transaction", "source": { "id": "cptxn_1NAyja2eZvKYlo2CGPcd8FIX", "object": "capital.financing_transaction", "account": "acct_1032D82eZvKYlo2C", "created_at": 1684861854, "details": { "advance_amount": 10000, "currency": "usd", "fee_amount": 1000, "linked_payment": "ch_1032Rp2eZvKYlo2Cv6jPGmkF", "reason": "automatic_withholding", "total_amount": 11000, "transaction": { "charge": "ch_1032Rp2eZvKYlo2Cv6jPGmkF" } }, ... }, "status": "available", "type": "financing_paydown" }, ... ], "has_more": false, "url": "/v1/balance_transactions" }
差戻し
各差戻し取引には、タイプが financing_
またはfinancing_
の 取引残高オブジェクトがあります。差戻しは、ACH 取引の失敗、融資のキャンセル、または手動差し戻しリクエストにより発生する可能性があります。差戻し取引の提供には 2 つの目的があります。
- これらはキャンセルされた融資を示すことがあります。元の資金供給をレポートに含めた場合は、すべての差戻しを含めてください。このようにして、連結アカウントは両方の取引が相殺されることを確認できます。
- これらは以前に保留された資金を連結アカウントの残高に返すことができます。
レポートから差戻しを除外すると、レポートが不正確な融資を反映する可能性があるため、連結アカウントの照合に問題が生じる可能性があります。
レポートの提供
プラットフォームのUIにある取引残高のリストや同等のモデルに返済を表示できます。以下に例を示します。
既存のレポート:連結アカウントの個別取引(プラットフォーム手数料やインターチェンジフィーを含む)を示す既存のレポートについては、レポートに源泉徴収額を追加することを検討してください。新規レポート:新規レポートでは、特定の期間のすべての源泉徴収額を表示します。これにより、連結アカウントは、販売処理のうちどれだけが融資に充当されているかを確認できます。入金レポートでは、源泉徴収された合計金額を含めることをお勧めします。これにより、連結アカウントは、源泉徴収(および請求するプラットフォーム手数料)を差し引いた総入金販売処理を照合し、外部銀行口座で期待される入金額を算出できます。
詳細については、入金の消し込みを参照してください。
テスト
サンドボックス を使用して、連結アカウント向けの様々な状態の融資オファーを作成できます。
テストシナリオを作成するには:
テスト環境にsandboxを作成します。
Capital ダッシュボードを通じてテストオファーを生成します。
オファーを配信済みとして更新し、承認をシミュレートします。
資金の承認と支払いにより自動入金をテストします。
入金または返済をテストします。特定の状況下でのみStripeによって開始されるため、差戻しをテストすることはできません。
- Payouts
- オファー承認後の自動入金の発生確認
- `capital.financing_transaction.created Webhook の監視
- 入金取引がレポートに表示されることを確認
- 返済
- テスト決済の処理による自動源泉徴収のテスト
- Capital ダッシュボードを通じた手動返済のシミュレート
- 返済取引がレポート導入に表示されることを確認します
- Payouts
取引詳細がレポートインターフェースに正しく表示されることを確認します。
取引通知のWebhook処理を確認します。
実装されている場合は、アカウントリンクまたは埋め込みコンポーネントをテストします。
取引の消し込みプロセスを検証してください。
テスト後、すべての適格な連結アカウントに対して自動オファーを有効にする前に、手動で本番オファーを送信してレポートを確認します。詳細については、Testingを参照してください。