API を使用して受取人を作成公開プレビュー

Stripe API を使用して受取人をアカウント登録する方法をご紹介します。

受取人が受取人と入金手段の詳細を収集するための情報収集フローを構築し、その情報を API を介して Stripe に渡します。ビジネスは、受取人とのすべてのやり取りと、受取人を確認するために必要なすべての情報を収集する責任を負うものとします。検証要件は、世界中の法律や規制の変更に合わせて更新されます。入金の失敗を回避するために、アカウント登録要件を定期的に確認して更新することを計画します。

入金を受け取る受取人を作成するには、以下を作成する必要があります。

Accounts v2 API で有効な受取人
USBankAccount API v2 で有効化された入金手段

情報を収集するフォームを作成する

入金を行うには、受取人から情報を収集する必要があります。受取人が情報を送信できるようにメソッドまたはフォームを作成し、API を使用して Stripe に送信します。

確認要件は法的要件や規制要件によって異なるため、収集する必要がある情報は変更される可能性があります。将来、パラメーターが追加される可能性を考慮して、アプリケーションロジックを設計します。

受取人を作成する

Accounts v2 API を使用して受取人を作成します。アカウント ID を作成するには、次のパラメーターを指定する必要があります。

必要な情報	パラメータ
受取人の国	`identity.country`
受取人の業種	`identity.entity_type`
受取人のメールアドレス	`contact_email`
アカウントの表示名。これは、Stripe ダッシュボードと、アカウントに送信するすべての請求書に表示されます。	`display_name`
有効にする入金手段	`configuration.recipient.capabilities`

プライベートプレビュー

アメリカ以外のユーザーへの入金はプライベートプレビュー版です。アクセスについて関心がある場合は、

メールアドレスを入力します。

一部の方法では、有効にする前に受取人に関する情報を追加する必要があり、Accounts v2 API を使用して目的の入金手段を指定しなければなりません。capabilities パラメーターを使用して有効にする方法では、受取人のために収集する情報が決定されます。たとえば、アメリカの受取人の configuration.recipient.capabilities.bank_accounts.local は、アカウントとルーティング番号を送信する必要があります。

入金方法	API パラメーター	説明
地方銀行	`configuration.recipient.capabilities.bank_accounts.local`	アカウントが ACH や FPS などの地元銀行ネットワーク経由で OutboundPayments を受信できるようにします。
銀行電信送金	`configuration.recipient.capabilities.bank_accounts.wire`	アカウントが Fedwire や SWIFT などの電信ネットワーク経由で OutboundPayments を受信できるようにします。
カード	`configuration.recipient.capabilities.cards`	アカウントが Visa Direct や Mastercard Send などのデビットカードネットワーク経由で OutboundPayments を受信できるようにします。

受取人は、複数の入金手段を有効にできます。受取人は、すべての国ですべての入金手段を利用できるわけではありません。国別の利用可能な入金手段の一覧をご覧ください。

これらのフィールドとリクエストされた入金手段を追加した後、API レスポンスに必要な追加情報が Stripe で決定されます。この情報は、受取人が入金を受け取れるようにするために必要な情報で、お客様が送信する必要があります。これらの要件を受け取るには、include 配列に requirements、configuration.recipient、および identity を含めます。それ以外の場合、Stripe は実際の値に関係なく null レスポンスを返します。

アカウントを作成、取得、または更新する場合、include パラメーターで指定した場合のみ、特定のフィールドが応答に入力されます。フィールドを指定しなかった場合は、実際の値に関係なく、レスポンスに null として表示されます。

受取人をアクティブ化するために必要なフィールドを決定する

Accounts v2 API からのレスポンスを使用して requirements.entries を調べ、Stripe に送信する必要があるフィールドを決定します。restricts_capabilities フィールドを持つ entries は、受取人が入金を受け付けるために必要です。

{
 "id": "acct_1R9UxIQlxdq9VtNU",
 "object": "v2.core.account",
 "applied_configurations": [
   "recipient"
 ],
 "configuration": {
   "customer": null,
   "merchant": null,
   "recipient": {
     "capabilities": {
       "bank_accounts": {
         "local": {
           "requested": true,
           "status": "restricted",
           "status_details": [
             {
               "code": "requirements_past_due",
               "resolution": "provide_info"
             }
           ]
         },
         "wire": null
       },
       "cards": null,

受取人情報を Stripe に送信する

送信する必要のある追加フィールドを決定したら、Accounts v2 API を使用して必要な情報を送信します。

受取人が有効になっていることを確認する

Accounts v2 API を使用してアカウントを取得し、リクエストした機能の status を調べます。お客様が指定した入金手段で受取人が入金を受け取るには、status が active である必要があります。

受取人の入金手段を作成する

USBankAccount v2 API を使用して、Stripe に入金手段の詳細を送信し、受取人への入金を有効にします。

USBankAccounts は、ACH または電信送金で支払いを受け取ることができます。電信送金の場合は、fedwire_routing_number を含めます。追加料金が適用されます。詳細については、料金体系を参照してください。

このリクエストの Stripe-Context ヘッダーは、受取人のアカウント ID である必要があります。

入金手段としてデビットカードを使用することも可能です。ただし、受取人はデビットカード情報を直接 Stripe に送信する必要があります。デビットカードによる入金を有効にする場合は、Account Links v2 API を使用して、ユーザーがデビットカードの認証情報を送信するための共有フォームを作成します。

受取人のすべての入金手段を表示します。

受取人のために作成されたすべての入金手段を表示します。Payout Methods API v2 を呼び出して、受取人 ID を入力します。

このリクエストの Stripe-Context ヘッダーは、受取人のアカウント ID である必要があります。

レスポンスには、受取人が保持している PayoutMethod オブジェクトのリストが含まれます。PayoutMethod ID を使用して、OutboundPayments API で入金を作成します。詳しくは、送金をご覧ください。