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

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

Use the Account Links API to programmatically generate links to collect information with Stripe-hosted forms, which renders dynamically based on the capabilities, country, and payment methods for each recipient, and that you can customize with your business name, brand colors, and icon. Your recipients complete the hosted form and submit required details, including payout credentials (for example, bank account and routing number) directly to Stripe.

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

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

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

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

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

受取人を作成する

Use the Accounts v2 API to create your recipient. You must provide the following parameters to create the Account ID:

Using the Accounts v2 API, you must specify your intended payout methods because some methods require additional information about your recipient to be enabled. The methods you enable using the capabilities parameter determine information that you need to collect for your recipient (for example, configuration.recipient.capabilities.bank_accounts.local for a US recipient requires you to submit an account and routing number).

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

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

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

Create a shareable link using the Account Link API. You send this link to your recipient, who then has access to the collection form to submit required information directly to Stripe. Each AccountLink URL expires 10 minutes after generation and can be used only once. If your recipient clicks the AccountLink after the 10 minute window, they’re redirected to the refresh.url for security reasons. After your recipient provides their information, the AccountLink redirects to the return.url.

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

• account: The recipient’s account ID, which you can get using the Accounts v2 API
• use_case.type:受取人の情報を初めて収集する場合は、account_onboarding を指定します。
• use_case.account_onboarding.configurations: recipient に設定します。
• use_case.account_onboarding.return_url: The page Stripe redirects the recipient to when the AccountLink has already been visited, has expired, or is otherwise invalid.
• use_case.account_onboarding.refresh_url:受取人が情報収集フォームを完了または終了したときに、Stripe がリダイレクトするページ。

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

curl -X POST https://api.stripe.com/v2/core/account_links \
  -H "Authorization: Bearer 
{{YOUR_API_KEY}}
" \
  -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 へのリクエストで次のパラメーターを指定します。

curl -X POST https://api.stripe.com/v2/core/vault/gb_bank_accounts \
  -H "Authorization: Bearer 
{{YOUR_API_KEY}}
" \
  -H "Stripe-Version: 2025-03-31.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 
{{YOUR_API_KEY}}
" \
  -H "Stripe-Version: 2025-03-31.preview" \
  -H "Stripe-Context: 
{{CONTEXT}}
"

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

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

For a recipient to accept payouts, you must collect information about the recipient and the intended payout methods. You can determine if a recipient is ready to accept payouts using the Dashboard or the Accounts v2 API.

既存の受取人を更新する

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

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

• account: The recipient’s account ID, which you can get using the Accounts v2 API
• use_case.type: account_update を指定します。
• use_case.account_onboarding.configurations: recipient に設定します。
• use_case.account_onboarding.return_url: The page Stripe redirects the recipient to after the AccountLink has already been visited, has expired, or is otherwise invalid.
• use_case.account_onboarding.refresh_url: 受取人が情報収集フォームを完了または終了したときに、Stripe はこのページに受取人をリダイレクトします。

curl -X POST https://api.stripe.com/v2/core/account_links \
  -H "Authorization: Bearer 
{{YOUR_API_KEY}}
" \
  -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"
        }
    }
  }'

Similar to the AccountLink used to create the recipient, the URL expires after 10 minutes and can be used only once. If your recipient clicks the AccountLink beyond the 10 minute window, we redirect them to the refresh.url for security reasons.