アカウントのケイパビリティ
連結アカウントについてリクエストするケイパビリティによって、そのアカウントについて収集する必要がある情報が決まります。アカウント登録をできるだけ簡単にするには、必要なケイパビリティのみをリクエストします。リクエストするケイパビリティが多いほど、収集しなければならない情報が多くなります。
まず、プラットフォームプロフィールを完成させて、プラットフォームに適したケイパビリティを確認します。
注
ほとんどのケイパビリティは、リクエストすると永続的に有効になります。削除やリクエスト解除を行うと、永続ケイパビリティはエラーを返します。
サポートされているケイパビリティ
以下は、利用可能なケイパビリティの一覧です。項目をクリックすると表示を展開または圧縮できます。
transfers
カード支払い
アメリカの税務申告
支払い方法
インドの国際支払い
複数のケイパビリティ
一般的に、1 つの連結アカウントに対して複数のケイパビリティがリクエストされますが、その際は以下の点を考慮する必要があります。
- ケイパビリティは互いに独立して動作します。
- 連結アカウントに
card_payments
とtransfers
の両方が設定され、そのいずれか一方のstatus
がinactive
であると、両方のケイパビリティが無効になります。 - 連結アカウントのケイパビリティは、アカウントのライフサイクル内はいつでもリクエストまたはリクエスト解除できます。
また、ケイパビリティを使用すると、同時に複数の目的で情報を収集できるため、ユーザーは同じ情報を繰り返し送信するように求められることがありません。たとえば、必要な納税情報とリクエストされたケイパビリティに必要な情報の両方を収集できます。transfers
ケイパビリティが設定されたユーザーをアカウント登録する際に、このユーザーが IRS の 1099-MISC 納税申告書 (アメリカの連邦納税申告書) を提出する必要がある場合は、両方の情報を同時に収集できます。
ケイパビリティを持つアカウントを作成する
ケイパビリティは Account (アカウント) オブジェクトに設定されます。使用可能なケイパビリティのリストを確認するには、list_capabilities エンドポイントを使用します。
アカウントの作成とケイパビリティのリクエストは、さまざまな設定の連結アカウントごとに異なります。
- Stripe ダッシュボードの全機能を利用できるアカウント (Standard アカウントを含む) でケイパビリティは自動的にリクエストされます。
- Express ダッシュボードにアクセスできるアカウント (Express アカウントを含む) の場合、アカウントの作成時にケイパビリティをリクエストすることも、アカウント登録の設定を使用して、リクエスト済みケイパビリティを自動化することもできます。
- Stripe がオンラインで提供するダッシュボードにアクセスできない連結アカウント (Custom アカウントを含む) を作成する場合は、ケイパビリティをリクエストする必要があります。
情報要件はケイパビリティによって異なりますが、多くの場合、本人確認や支払いタイプ固有のその他の情報に関連しています。
連結アカウントが正常に作成されたら、その要件を表示できます。
レスポンスの requirements
ハッシュをチェックして必要な情報を確認します。payouts_enabled
と charges_enabled
の値は、アカウントで入金と支払いが有効であるかどうかを示します。
ケイパビリティの詳細
アカウント作成の基本事項は上記で説明されています。ただし情報要件のプレビューや既存アカウントのケイパビリティの管理が必要になる場合があります。以降のセクションでは、 Capabilities API を使用してこれらを実行する方法を説明します。
情報要件をプレビューする
特定のケイパビリティがリクエストされる 「前」 または 「後」 に、ユーザからどのような情報が必要かをプレビューできます。
ケイパビリティをリクエストすると、account.updated
Webhook が起動し、アカウントの要件が変更される場合があります。最初に要件をプレビューし、アカウントに必要な情報を収集してからケイパビリティをリクエストすると、アカウントの支払いと入金をより迅速に有効にできます。また、事前に情報が収集されているため、アカウントが無効にされる可能性も回避できます。
以下は、特定のアカウントの card_payments
ケイパビリティの要件を表示した例です。
応答では、requirements
ハッシュをチェックして、必要な情報を確認します。
{ "id": "card_payments", "object": "capability", "account":
, "requested": false, "requested_at": null, "requirements": { "past_due": [], "currently_due": ["company.tax_id", ...], "eventually_due": [...], "disabled_reason": ..., "current_deadline": ..., }, "status": "unrequested" }"{{CONNECTED_ACCOUNT_ID}}"
status
の値は、ケイパビリティが requested
されているかどうかを示します。リクエストされている場合、アカウントの要件が有効になります。
これらの手順は、リクエストする前にケイパビリティの要件をプレビューする方法を示していますが、同じエンドポイントを使用して、ケイパビリティの現在の要件を確認できます。これにより、ケイパビリティの要件の内容、および要件の変更を常に把握することができます。
ケイパビリティのリクエストと解除
大半のアカウントの作成後に、追加のケイパビリティのリクエスト、および既存のケイパビリティの削除ができます。ケイパビリティをリクエストするには、アカウントを更新して、ケイパビリティの requested
値を true
に設定します。リクエストが成功すると、API のレスポンスで requested: true
が返されます。Standard アカウントなど、Stripe ダッシュボードの全機能を利用できる連結アカウントのケイパビリティをリクエストすることはできません。
ケイパビリティのリクエストを取り消すには、アカウントを更新して、ケイパビリティの requested
値を false
に設定します。ケイパビリティが削除できない場合は、この呼び出しでエラーが返されます。呼び出しが成功すると、API のレスポンスで requested: false
が返されます。
ダッシュボードからもアカウントのケイパビリティの追加や削除ができます。ケイパビリティを削除できない場合は、その削除 ボタンが無効化されています。
以下の例では、特定の連結アカウントの transfers
ケイパビリティをリクエストしています。
次の例では、特定の 1 つの連結アカウントに対して複数のケイパビリティをリクエストしています。