ReceivedDebit オブジェクトを使用して Treasury で送金

外部の口座保有者が Treasury の金融口座から資金を引き出す方法をご紹介します。

Stripe Treasury の外部で開始された一部のプロセスでは、Treasury 金融口座から資金が引き出されます。これには以下が含まれます。

Stripe Issuing 経由でカードの資金を使用する
ACH デビットを使用して、金融口座から資金を引き出し、外部口座に追加する
トップアップを使用して、プラットフォームの金融口座から資金を引き出し、そのプラットフォームの Stripe Payments 残高に追加する

このような資金を移動すると、ReceivedDebit オブジェクトが作成されます。ご自身で直接 ReceivedDebits を作成することはなく、Webhook を使用して ReceivedDebit オブジェクトが作成されるのを監視します。アカウントに十分な資金がなければ、ほとんどの場合 ReceivedDebit は失敗します。

ReceivedDebit を取得する

GET /v1/treasury/received_debits/{{RECEIVED_DEBIT_ID}} を使用して、関連付けられた ID の ReceivedDebit を取得します。

成功すると、関連付けられた ID の ReceivedDebit オブジェクトがレスポンスで返されます。レスポンスの一部のパラメーターには、expand[] パラメーターに値として追加した場合にのみ返される追加情報があります。次のレスポンス例で、拡張できるフィールドには、「Expandable」コメントが付いています。オブジェクトレスポンスの拡張の詳細については、レスポンスを拡張するをご覧ください。

JSON (コメント付き)
{
  "id": "{{RECEIVED_DEBIT_ID}}",
  "object": "received_debit",
  "livemode": Boolean,
  "created": Timestamp,
  // The FinancialAccount funds have been pulled from
  "financial_account": "{{FINANCIAL_ACCOUNT_ID}}", // Expandable
  "amount": 1000,
  "currency": "usd",
  "description": "Testing",

ReceivedDebit をリストする

GET /v1/treasury/received_debits を使用して特定の金融口座のすべての ReceivedDebits を取得します。financial_account パラメーターには金融口座 ID を指定する必要があります。標準のリストパラメーターまたは status で結果をフィルタリングできます。

{
  // Standard list parameters
  "limit", "starting_after", "ending_before",
  // Filter by FinancialAccount (Required)
  "financial_account": "{{FINANCIAL_ACCOUNT_ID}}",
  // Filter by status
  "status": "succeeded" | "failed"
}

以下のリクエストは、特定された金融口座に対する指定された ReceivedDebit 以前に発生した、最後の成功した ReceivedDebit オブジェクトを取得します。

ReceivedDebit をテストする

Stripe Treasury は、ReceivedDebit オブジェクトのテスト用エンドポイントを提供しています。POST /v1/test_helpers/treasury/received_debits を使用し、テスト環境で ReceivedDebit の作成をシミュレーションします。本番環境では ReceivedDebit オブジェクトを作成することはできないため、このエンドポイントを使用することにより、サードパーティーが ReceivedDebit の作成を開始した場合の資金の流れをテストすることができます。financial_account を送金元の金融口座の ID に設定します。network を ach に設定し、オプションとして source_details.aba パラメーターに ABA 財務アドレスの詳細を入力します。本番環境と同様に、テスト環境でも、資金不足の場合には ReceivedDebits が失敗します。

ReceivedDebit の Webhook

Stripe は、以下の ReceivedDebit イベントを Webhook エンドポイントに送信します。

ReceivedDebit 作成時の treasury.received_debit.created。