Payment Method Configurations API
Payment Method Configurations API を使用すると、連結アカウントの所有者は、それぞれの設定ページから決済手段をオプトイン/オプトアウトできます。連結アカウントで有効になっている決済手段を確認して、決済手段を推薦し、関連する決済タイプを表示するように設定できます。
API を使用して自社用の決済手段の設定 UI を構築するか、決済手段の設定の埋め込みコンポーネントを使用できます。
ベータ
The embedded payment method settings component allows connected accounts to configure the payment methods they offer at checkout without the need to access the Stripe Dashboard. Request access and learn how to integrate with Payment Method Configurations.
プラットフォームレベルのデフォルト状態を設定する
Stripe ダッシュボードの連結アカウントの決済手段を管理するページで、個々の決済手段に対するプラットフォームレベルのデフォルトを設定します。
ダッシュボード で右上隅にある歯車のアイコンをクリックし、製品の設定ページを開きます。支払いセクション内の決済手段リンクをクリックします。
プラットフォームは、プラットフォームと連結アカウントの決済手段を設定できます。お客様のアカウントの設定は、直接の支払いトラフィックに適用されます。たとえば、自社で構築済みの決済ページからプラットフォームの月額手数料をユーザーに請求する場合、お客様のアカウントの設定でそれらの決済を管理します。
連結アカウントの設定では、プラットフォーム上の連結アカウントが受け付けることができる決済手段を管理できます。
プラットフォーム上のすべての連結アカウントに対してデフォルト状態を設定するには、連結アカウントの下にある設定の編集リンクをクリックします。
決済手段ごとに、ドロップダウンを使用して希望の設定を選択します。
- Off by default: 連結アカウントは、決済手段の有効と無効を切り替えることができます。デフォルトは無効です。
- Blocked: すべての連結アカウントの決済手段を無効にします。連結アカウントの所有者がオプトインすることはできません。
- On by default: 連結アカウントは、決済手段の有効と無効を切り替えることができます。デフォルトは有効です。
注
By default, Stripe enables a few commonly used payment methods such as Cards, Apple Pay, and Google Pay.
連結アカウントに対する可用性および表示設定を決定する
連結アカウント ID を指定して Payment Method Configurations API を使用することで、特定の連結アカウントに関する決済手段の現在の状況を読み取ります。連結アカウントに複数の設定がある場合は、Connect 設定のアプリケーションの client_id
で結果を絞り込むことができます。
{ "object": "list", "data": [ { "id":
, "object": "payment_method_configuration", "name": "Default", "active": true, "is_default": true, "livemode": false, "application":"{{PAYMENT_METHOD_CONFIGURATION_ID}}", "acss_debit": { "available": false, "display_preference": { "overridable": true, "preference": "off", "value": "off" } }, "affirm": { "available": false, "display_preference": { "overridable": true, "preference": "off", "value": "off" } }, "afterpay_clearpay": { "available": false, "display_preference": { "overridable": true, "preference": "off", "value": "off" } }, ... additional payment methods } ], "has_more": false, "url": "/v1/payment_method_configurations" }"{{CLIENT_APPLICATION_ID}}"
成功すると、返されるリストには各決済手が表示され、可用性と表示設定を示す 2 つのパラメーターが含まれます。
available
は、ケイパビリティ の値 (active
、inactive
、pending
またはunrequested
) とdisplay_preference
の値の組み合わせです。購入時にこの決済手段を買い手に表示するかどうかを確認するには available フィールドを使用できます。available が
true
の場合、その決済手段のケイパビリティは有効であり、display_preference
は on です。available がfalse
の場合は、その決済手段に有効なケイパビリティがないか、display_preference
が off であり、買い手の購入時にこの決済手段は表示されません。実装を簡素化して、その他の機能を利用するには、購入時にこのパラメーターを自動的に読み取り、適切な決済手段を買い手に表示する動的な決済手段を使用します。display_preference
には、overridable
、preference
、value
の 3 つのコンポーネントがあります。overridable
は読み取り専用であり、上記で設定したデフォルトを連結アカウントの設定で上書きできるかどうかを示します。preference
は書き込み可能であり、連結アカウントの設定を保存します。value
は読み取り専用で、有効なdisplay_preference
値を反映します。
注
連結アカウントの国に関連する決済手段のみが API レスポンスで表示され、設定可能です。各国のサポート状況をご確認ください。
連結アカウントが設定を編集するときに、display_preference を更新する
連結アカウントの所有者が決済手段を有効または無効にするときに、お客様は display_preference
の preference
属性を更新できます。これにより、その決済手段に対する連結アカウントの所有者の設定が保管されて、決済手段を買い手に表示するかどうかの判断に使用されます。
{ "id":
, "object": "payment_method_configuration", "name": "Default", "active": true, "is_default": true, "livemode": false, "application":"{{PAYMENT_METHOD_CONFIGURATION_ID}}", "acss_debit": { "available": false, "display_preference": { "overridable": true, "preference": "off", "value": "off" } }, "affirm": { "available": true, "display_preference": { "overridable": true, "preference": "on", "value": "on" } }, "afterpay_clearpay": { "available": false, "display_preference": { "overridable": true, "preference": "off", "value": "off" } }, ... additional payment methods }"{{CLIENT_APPLICATION_ID}}"
決済時に利用可能な決済手段を表示する
決済手段はダッシュボードで管理できます。Stripe は取引額、通貨、決済フローなどの要素に基づいて、適切な決済手段が返されるように処理します。そうすることによって、決済フローでは available
が true
になっている決済手段のみを買い手に表示できます。
決済ページをレンダリングする前に、連結アカウントの利用可能な決済手段を事前に取得する場合は、Payment Method Configurations API を呼び出して、決済手段のリストを取得します。available
が true
に設定されている手段を使用します。
カードタイプの決済手段に対応する
Apple Pay や Link などの一部の決済手段は、PaymentIntent に単独の決済手段タイプとして含まれていないため、card
が指定されるときにのみ確定されます。Payment Method Configurations API を使用すると、連結アカウントの所有者がこれらの特定の決済手段をオプトインまたはオプトアウトして、UI に表示されないように設定できます。
連結アカウントの所有者に決済手段をマーケティングする
対象を絞ったマーケティングメッセージを使用して、連結アカウントの所有者に、まだオプトインしていない利用可能な特定の決済手段へのオプトインを促します。
GET メソッドを呼び出して決済手段の構成のステータスを取得し、決済手段を宣伝するタイミングを決定します。display_preference
値を読み取ることで、連結アカウントの所有者が以前に構成を操作したかどうかを判断できます。display_preference
の preference
が none
の場合、連結アカウントの所有者はデフォルトの構成を変更していません。preference
値が on
または off
の場合、連結アカウントの所有者は構成を操作しているとわかるため、お客様がマーケティングメッセージを抑制するかどうかの判断材料になります。