レポートの提供と照合公開プレビュー
連結アカウントに 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 を選択してください。
Financing Transactions APIを使用して、Capitalに特有の詳細な取引情報を含めます。
Capital 取引の監視
次の取引タイプは、マーチャントキャッシュアドバンスやローンを含む、連結アカウントの融資に関連しています:
- 入金:
payout
- 返済:
payment
- 差戻し:
reversal
入金
各資金供給には、タイプがpayout
の資金調達取引 オブジェクトがあります。入金資金調達取引が作成されると、Stripe は capital.financing_transaction.created Webhook を送信します。ACH資金が連結アカウントの銀行口座に到着するまでに数営業日かかることがあります。
Webhook イベントをリッスンし、受信時にカスタム入金レポートを更新して、連結アカウントの外部銀行口座に送信された融資金額を表示します。
返済
UIに源泉徴収取引を表示するには:
- Retrieve Financing Transactions を行い、取引タイプでフィルタリングします。
Stripe-Account
ヘッダーに連結アカウントのアカウントIDを指定します。
資金調達取引リストを正常に取得すると、次のようなレスポンスが返されます。
{ "object": "list", "url": "/v1/capital/financing_transactions?financing_offer=financingoffer_1NAdVWJQ3aJgxqz5nh90Zqrs&charge=ch_1HoZftJQ3aJgxqz50EbvL8zU", "has_more": false, "data": [ { "id": "cptxn_1NAdVWJQ3aJgxqz5FSScvJaF", "object": "capital.financing_transaction", "account": "acct_1HLGiXJQ3aJgxqz5", "created_at": 1684780258, "details": { "advance_amount": 10000, "currency": "usd", "fee_amount": 1000, "linked_payment": "ch_1HoZftJQ3aJgxqz50EbvL8zU", "reason": "automatic_withholding", "total_amount": 11000, "transaction": { "charge": "ch_1HoZftJQ3aJgxqz50EbvL8zU" } }, "financing_offer": "financingoffer_1NAdVWJQ3aJgxqz5nh90Zqrs", "livemode": true, "type": "payment", "user_facing_description": "Paydown of your loan" }, {...}, {...} ] }
レスポンスには、当該の返済の結果、未返済の融資金額がどのようになったかを示す情報が含まれています。"details.
の理由で返済が行われた場合は、details.
フィールドに元の Stripe の支払いの参照も含まれます。
差戻し
各差戻しには、タイプ reversal
の 資金調達取引 オブジェクトがあります。差戻しは、ACH 取引の失敗、融資のキャンセル、または手動差し戻しリクエストにより発生する可能性があります。差戻し取引の提供には 2 つの目的があります。
- これらはキャンセルされた融資を示すことがあります。元の資金供給をレポートに含めた場合は、すべての差戻しを含めてください。このようにして、連結アカウントは両方の取引が相殺されることを確認できます。
- これらは以前に保留された資金を連結アカウントの残高に返すことができます。レポートから差戻しを除外すると、レポートが不正確な融資を反映する可能性があるため、連結アカウントの照合に問題が生じる可能性があります。
デスティネーション支払い
プラットフォームが デスティネーション支払いを使用して決済処理し、プラットフォームで発生した元の請求とファイナンス取引の返済を照合したい場合は、資金調達取引 のdetails.
フィールドで請求 ID を抽出します。これは、連結アカウントへの自動 送金の結果として発生した決済 ID に設定されます。
{ "id": "cptxn_1NBJQR2eZvKYlo2CBUy2GQ1S", "object": "capital.financing_transaction", "details": { "reason": "automatic_withholding", "transaction": { "charge": "py_1NBJI62c99H72o8MUEN0fIZx" }, ... }, "type": "payment", ... }
その後、Retrieve Charge API を使用して請求オブジェクトを取得できます。
{ "id": "py_1NBJI62c99H72o8MUEN0fIZx", "object": "charge", "source_transfer": "tr_3NBJGW2eZvKYlo2C1jQOxNwF", ... }
これはデスティネーション支払いであるため、source_
は送金 IDで入力されます。Retrieve Transfer APIを使用して送金オブジェクトを取得します。
{ "id": "tr_3NBJGW2eZvKYlo2C1jQOxNwF", "object": "transfer", "source_transaction": "ch_3NBJGW2eZvKYlo2C17oDFajw", ... }
source_
フィールドは、プラットフォームで行われた Charge (支払い) の ID を含み、連結アカウントへの Transfer (送金) をトリガーします。
レポートの提供
プラットフォームの UI にある融資取引またはそれに相当するモデルのリストに返済を表示できます。以下に例を示します。
- 既存のレポート:連結アカウントの個別取引 (プラットフォーム手数料やインターチェンジフィーを含む)を表示する既存のレポートに、源泉徴収額を追加することを検討してください。
- 新規レポート:新規レポートでは、特定の期間のすべての源泉徴収額を表示します。これにより、連結アカウントは、販売処理のうちどれだけが融資に充当されているかを確認できます。入金レポートでは、源泉徴収された合計金額を含めることをお勧めします。これにより、連結アカウントは、源泉徴収分 (および請求するプラットフォーム手数料) を差し引いた総売上処理額を照合し、外部銀行口座で確認される入金額に到達できます。
アドホックレポートの提供
テスト
サンドボックス を使用して、連結アカウント向けの様々な状態の融資オファーを作成できます。
テストシナリオを作成するには:
テスト環境にsandboxを作成します。
Capital ダッシュボードを通じてテストオファーを生成します。
オファーを配信済みとして更新し、承認をシミュレートします。
資金の承認と支払いにより自動入金をテストします。
入金または返済をテストします。特定の状況下でのみStripeによって開始されるため、差戻しをテストすることはできません。
- 入金:
- オファー承認後に自動入金が発生することを確認します。
capital.
Webhook を監視します。financing_ transaction. created - 入金取引がレポートに表示されることを確認します。
- 返済:
- テスト用決済の処理による自動源泉徴収をテストします。
- Capital ダッシュボードを通じて手動返済をシミュレーションします。
- 分割払い取引がレポート導入に表示されることを確認します。
- 入金:
取引詳細がレポートインターフェースに正しく表示されることを確認します。
取引通知のWebhook処理を確認します。
アカウントリンクまたは埋め込みコンポーネントをテストします (実装されている場合)。
取引の消し込みプロセスを検証してください。
テスト後、すべての適格な連結アカウントに対して自動オファーを有効にする前に、手動で本番オファーを送信してレポートを確認します。詳細については、Testingを参照してください。