入金の詳細は、特定の入金の詳細を表示します。その UI は、ユーザーが入金をクリックしたときに入金組み込みコンポーネントが表示するオーバーレイに相当します。
このコンポーネントを使用すると、UI から直接入金詳細オーバーレイを表示できます。たとえば、入金組み込みコンポーネントを使用する代わりに、カスタム入金リストから呼び出すことができます。
アカウントセッションを作成する際は、components
パラメーターでpayout_details
を指定して入金詳細を有効にします。
curl https://api.stripe.com/v1/account_sessions \
-u "sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
-d account="{{CONNECTED_ACCOUNT_ID}}"
\
-d "components[payout_details][enabled]"=true
アカウントセッションを作成して ConnectJS を初期化すると、フロントエンドに入金詳細コンポーネントを表示できます。
const payoutDetails = stripeConnectInstance.create('payout-details');
payoutDetails.setPayout('{{PAYOUT_ID}}');
payoutDetails.setOnClose(() => {
payoutDetails.remove();
});
container.appendChild(payoutDetails);
サポートされているパラメーター
この埋め込みコンポーネントは、次のパラメーターに対応します。
メソッド | タイプ | 説明 | |
---|
setPayout | string | 表示する入金の ID。連結アカウントへの入金である必要があります。有効な ID を指定しない場合、組み込みコンポーネントは何も表示されません。ID を確認するには、入金のリストを取得します。 | 必須 |
setOnClose | () => void | ユーザーがオーバーレイを閉じたときにこのイベントを送信します。 | |
このコンポーネントの閉じる動作を有効にするには、setOnClose
を呼び出して close
イベントをリッスンします。