アカウントのケイパビリティ
アカウントに対して有効にできるケイパビリティと、それを使用する際に満たす必要がある要件についてご紹介します。
連結アカウントについてリクエストするケイパビリティによって、そのアカウントについて収集する必要がある情報が決まります。アカウント登録をできるだけ簡単にするには、必要なケイパビリティのみをリクエストします。リクエストするケイパビリティが多いほど、収集しなければならない情報が多くなります。
まず、プラットフォームプロフィールを完成させて、プラットフォームに適したケイパビリティを確認します。
注
一部のケイパビリティは、リクエストすると永続的に有効になります。削除やリクエスト解除を行うと、永続ケイパビリティはエラーを返します。
アカウントの作成後、追加のケイパビリティをリクエストし、既存の非永続的なケイパビリティを削除することができます。他のプラットフォームが管理する連結アカウントの場合は、ケイパビリティのリクエストを解除できません。
サポートされているケイパビリティ
以下は、利用可能なケイパビリティの一覧です。項目をクリックすると表示を展開または圧縮できます。
transfers
カード支払い
アメリカの税務申告
支払い方法
インドの国際支払い
複数のケイパビリティ
一般的に、1 つの連結アカウントに対して複数のケイパビリティがリクエストされますが、その際は以下の点を考慮する必要があります。
- ケイパビリティは互いに独立して動作します。
- 連結アカウントに
card_
とpayments transfers
の両方が設定され、そのいずれか一方のstatus
がinactive
であると、両方のケイパビリティが無効になります。 - 連結アカウントのケイパビリティは、アカウントのライフサイクル内はいつでもリクエストまたはリクエスト解除できます。
また、ケイパビリティを使用すると、同時に複数の目的で情報を収集できます。たとえば、必要な納税情報とリクエストされたケイパビリティに必要な情報の両方を収集できます。transfers
ケイパビリティが設定された連結アカウント登録する際に、そのアカウントが IRS の 1099-MISC 納税申告書 (アメリカの連邦税申告書) を提出する必要がある場合は、両方の情報を同時に収集できます。
ケイパビリティを持つアカウントを作成する
ケイパビリティは Account (アカウント) オブジェクトに設定されます。Account で使用可能なケイパビリティのリストを取得するには、list_capabilities エンドポイントを使用します。
アカウントの作成とケイパビリティのリクエストは、さまざまな設定の連結アカウントごとに異なります。
- Standard アカウントなど Stripe ダッシュボードの全機能にアクセスできる連結アカウントの場合、一部のケイパビリティが国に応じて自動的にリクエストされます。他のケイパビリティをリクエストすることもできます。
- Express ダッシュボードにアクセスできる連結アカウント (Express アカウントを含む) の場合、ケイパビリティをリクエストすることも、アカウント登録の設定を使用して、ケイパビリティのリクエストを自動化することもできます。
- Stripe がホストするダッシュボードに連結アカウント (Custom アカウントを含む) がアクセスできない場合は、そのアカウントのケイパビリティをリクエストする必要があります。
情報要件はケイパビリティによって異なりますが、多くの場合、本人確認や支払いタイプ固有のその他の情報に関連しています。
連結アカウントが正常に作成されたら、その要件の リストを取得 できます。
レスポンスの requirements
ハッシュには必要情報が記載されています。payouts_
と charges_
の値は、アカウントで入金と支払いが有効になっているかどうかを表します。
既存の連結アカウントのケイパビリティ
以降のセクションでは、ケイパビリティ API を使用して、既存の連結アカウントの情報要件をプレビューしたり、ケイパビリティを管理する方法を説明します。
情報要件をプレビューする
特定のケイパビリティをリクエストする前後に、連結アカウントでどのような情報が必要かをプレビューできます。
ケイパビリティをリクエストすると、account.
Webhook が起動し、アカウントの要件が変更される可能性があります。要件を直ちに有効にしてアカウントを無効化しないようにするには、ケイパビリティをリクエストする前に要件をプレビューし、必要な情報を収集します。
以下は、特定のアカウントの card_
ケイパビリティの要件を リスト化 した例です。
応答では、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
から true
に設定します。リクエストが成功すると、API はレスポンスで requested: true
を返します。
アカウントのケイパビリティのリクエストを取り消すには、アカウントを更新 して、ケイパビリティの値を requested
から false
に設定します。ケイパビリティが削除できない場合は、この呼び出しでエラーが返されます。呼び出しが成功すると、API はレスポンスで requested: false
を返します。
ダッシュボードからもアカウントのケイパビリティの追加や削除ができます。ケイパビリティを削除できない場合は、その削除 ボタンが無効化されています。
以下の例では、特定の連結アカウントの transfers
ケイパビリティをリクエストしています。
次の例では、特定の 1 つの連結アカウントに対して複数のケイパビリティをリクエストしています。