ReceivedDebit オブジェクトを使用した資金移動

プラットフォーム向け金融口座の外で開始された特定のプロセスでは、金融口座から資金が引き出されます。これには以下が含まれます。

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

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

ReceivedDebit を取得する

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

curl https://api.stripe.com/v1/treasury/received_debits/{{RECEIVED_DEBIT_ID}} \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -H "Stripe-Account: 
{{CONNECTED_ACCOUNT_ID}}
"

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

{
  "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 オブジェクト を取得します。

curl -G https://api.stripe.com/v1/treasury/received_debits \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -H "Stripe-Account: 
{{CONNECTED_ACCOUNT_ID}}
" \
  -d financial_account=
"{{FINANCIAL_ACCOUNT_ID}}" \
  -d limit=1 \
  -d ending_before={{RECEIVED_DEBIT_ID}}

ReceivedDebit をテストする

プラットフォーム向け金融口座は ReceivedDebit オブジェクトのテストエンドポイントを提供します。テスト環境では、POST /v1/test_helpers/treasury/received_debits を使用して、ReceivedDebit の作成をシミュレートします。本番環境では ReceivedDebit オブジェクトを作成できないため、このエンドポイントを使用することで、第三者が ReceivedDebit の作成を開始した場合の資金フローをテストできます。financial_account を送金元の金融口座の ID に設定します。network を ach に設定し、オプションとして source_details.aba パラメーターに ACH の金融住所の詳細を指定します。本番環境と同様に、ReceivedDebits のテストは、利用可能な資金が不十分な場合に失敗します。

ReceivedDebit Webhook

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

• ReceivedDebit 作成時の treasury.received_debit.created。