Stripe がホストする受取人の作成公開プレビュー

Stripe がホストするウェブフォームを使用して受取人情報を収集します。受取人の情報は、各受取人の機能、国、支払い方法に基づいて動的に表示されます。

Account Links API を使用して、情報収集用の Stripe のオンライフォームへのリンクをプログラムで生成します。フォームは、ビジネス名、ブランドカラー、アイコンによってカスタマイズ可能で、受取人の会社形態、国、決済手段に基づいて動的に表示されます。受取人はオンラインフォームに入力し、入金情報 (銀行口座や銀行コードなど) などの必要な詳細を Stripe に直接送信できます。

サポートされているブラウザー

Stripe のホスティング収集は、デスクトップとモバイルのブラウザーに対応しています。

• Chrome と Firefox の最新の 20 個のメジャーバージョン
• Safari と Edge の最新の 2 つのメジャーバージョン
• iOS 上のモバイル Safari の最新の 2 つのメジャーバージョン
• iframe 環境ではありません

収集フォームをカスタマイズする

Stripe のオンラインフォームをカスタマイズするには、ダッシュボードのビジネスブランドの設定ページに移動して、ビジネス名、カラー、アイコンを追加します。

受取人を作成する

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

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

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

これらのフィールドとリクエストされた入金手段を追加した後、API レスポンスに必要な追加情報が Stripe で決定されます。この情報は、受取人が入金を受け取れるようにするために必要な情報で、お客様が送信する必要があります。

共有可能なリンクを作成する

Account Link API を使用して、共有リンクを作成します。このリンクを受取人に送信すると、受取人は収集フォームにアクセスして、必要な情報を直接 Stripe に送信できます。AccountLink の URL は 1 回のみ使用可能で、生成後 10 分で有効期限が切れます。受取人が 10 分経過後に AccountLink をクリックした場合は、セキュリティ上の理由から refresh.url にリダイレクトされます。受取人が情報を入力すると、AccountLink は return.url にリダイレクトされます。

新しい共有可能なリンクを作成するには、以下のパラメーターを含めます。

• account:受取人のアカウント ID (Accounts v2 API を使用して取得します)
• use_case.type:受取人の情報を初めて収集する場合は、account_onboarding を指定します。
• use_case.account_onboarding.configurations: recipient に設定します。
• use_case.account_onboarding.return_url:AccountLink がすでにアクセスされたか、有効期限が切れているか、無効であるときに、Stripe はこのページに受取人をリダイレクトします。
• use_case.account_onboarding.refresh_url:受取人が情報収集フォームを完了または終了したときに、Stripe がリダイレクトするページ。

次のリクエストで、受取人の情報を初めて収集する目的で AccountLink を作成します。

curl -X POST https://api.stripe.com/v2/core/account_links \
  -H "Authorization: Bearer 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
" \
  -H "Stripe-Version: 2025-03-31.preview" \
  --json '{
    "account": "{{ACCOUNT_ID}}",
    "use_case": {
        "type": "account_onboarding",
        "account_onboarding": {
            "configurations": [
                "recipient"
            ],
            "return_url": "https://example.com/return",
            "refresh_url": "https://example.com/reauth"
        }
    }
  }'

受取人をこの URL にリダイレクトする前に、アプリケーションで受取人を認証します。

受取人小切手の確認 UK only

イギリスの受取人に送金する前に受取人確認にを行う必要があります。この確認は、銀行口座の作成時に行うか、API コールで行います。

/v2/payment_methods/gb_bank_accounts へのリクエストで次のパラメーターを指定します。

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

curl -X POST https://api.stripe.com/v2/core/vault/gb_bank_accounts \
  -H "Authorization: Bearer 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
" \
  -H "Stripe-Version: 2025-06-30.preview" \
  -H "Stripe-Context: 
{{CONTEXT}}
" \
  --json '{
    "sort_code": "108800",
    "account_number": "00012345",
    "confirmation_of_payee": {
        "initiate": true
    }
  }'

次に、レスポンスの例を示します。

{
  "id": "gbba_123",
  "object": "payment_methods.gb_bank_account",
  "bank_account_type": "checking",
  "bank_name": "Test Bank",
  "created": "2023-05-15T16:29:15.738Z",
  "deactivated": false,
  "last4": "2345",
  "sort_code": "108800",
  "confirmation_of_payee": {
    "result": {
      "created": "2024-10-18T19:19:31.000Z",
      "match_result": "mismatch",
      "matched": {
        "business_type": null,
        "name": ""
      },
      "message": "The provided information does not match the information the bank has on file for this account.",
      "provided": {
        "business_type": "business",
        "name": "John Smith"
      }
    },
    "status": "awaiting_acknowledgement"
  },
}

受取人の確認結果が一致する場合、すぐにこの送金先に資金を送金できます。結果が部分的に一致する場合、結果が一致しない場合、またはサービスを利用できない場合は、最初に次の結果を確認する必要があります。

curl -X POST https://api.stripe.com/v2/core/vault/gb_bank_accounts/gbba_1234/acknowledge_confirmation_of_payee \
  -H "Authorization: Bearer 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
" \
  -H "Stripe-Version: 2025-06-30.preview" \
  -H "Stripe-Context: 
{{CONTEXT}}
"

確認の前に、これらの銀行口座を見直して正しい送金先であることを確認してください。送金先と一致していない銀行口座は、ダッシュボードで確認することもできます。

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

受取人が入金を受け付けるには、受取人および対象の入金手段に関する情報を収集する必要があります。ダッシュボードまたは Accounts v2 API を使用して、受取人が入金を受け付ける準備ができているかどうかを確認できます。

既存の受取人を更新する

Account Links API を使用して別の共有可能なリンクを作成すると、受取人は Stripe がホストするフォームで自分の情報を更新できるようなります。

新しい共有可能なリンクを作成するには、以下を含めます。

• account:受取人のアカウント ID (Accounts v2 API を使用して取得します)
• use_case.type: account_update を指定します。
• use_case.account_onboarding.configurations: recipient に設定します。
• use_case.account_onboarding.return_url:AccountLink がすでにアクセスされたか、有効期限が切れているか、無効であるときに、Stripe はこのページに受取人をリダイレクトします。
• use_case.account_onboarding.refresh_url: 受取人が情報収集フォームを完了または終了したときに、Stripe はこのページに受取人をリダイレクトします。

curl -X POST https://api.stripe.com/v2/core/account_links \
  -H "Authorization: Bearer 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
" \
  -H "Stripe-Version: 2025-03-31.preview" \
  --json '{
    "account": "{{ACCOUNT_ID}}",
    "use_case": {
        "type": "account_update",
        "account_onboarding": {
            "configurations": [
                "recipient"
            ],
            "return_url": "https://example.com/return",
            "refresh_url": "https://example.com/reauth"
        }
    }
  }'

受取人の作成に使用した AccountLink と同様、URL は 1 回のみ使用可能で、10 分後に期限切れになります。受取人が 10 分を超えて AccountLink をクリックした場合は、セキュリティ上の理由から refresh.url にリダイレクトされます。