バージョン: 最新版

Linked Accounts API

Linked Accounts APIを使用すると、プラットフォームの接続されたサブアカウントを管理できます。リンクされたアカウントは、プラットフォームを通じて決済を処理するマーチャント、販売者、またはサービスプロバイダーを表します。

概要

リンクされたアカウントにより以下が可能になります：

マーチャントアカウントの接続 - 決済処理のためにプラットフォームに接続
サブアカウントの管理 - マーケットプレイスの販売者やサービスプロバイダー向け
決済の分割 - プラットフォームとリンクされたアカウント間で
アカウントステータスの追跡 - 認証状態を監視
リンクされたアカウントの検索とフィルタリング - 様々な条件で

リンクされたアカウントのタイプ

個人アカウント

個人のマーチャントやサービスプロバイダー向けの個人アカウント。含まれるもの：

氏名と連絡先情報
支払い用の銀行口座詳細
認証ステータス

法人アカウント

法人または事業向けアカウント。含まれるもの：

会社名と登録詳細
税務識別番号
支払い用の銀行口座詳細
認証ステータス

リンクされたアカウントのライフサイクル

接続 - マーチャントがプラットフォームにアカウントを接続
認証 - アカウントが認証を受ける（自動または手動）
アクティブ - アカウントで決済処理と支払い受取が可能
停止 - アカウントが一時的に無効化（再有効化可能）
切断 - アカウントがプラットフォームから削除

アカウントステータス

リンクされたアカウントには以下のステータス値があります：

ステータス	説明
`pending`	アカウントが作成され、登録が進行中
`successful`	登録が正常に完了
`failed`	登録に失敗（failure_codeとfailure_messageを確認）
`expired`	完了前に登録リンクが期限切れ
`deleted`	アカウントが削除された

アカウントの機能

各リンクされたアカウントには異なる機能が有効になっている場合があります：

機能	説明
`card_payments`	カード決済を受け付けることができる
`transfers`	支払いを受け取ることができる
`refunds`	返金を処理できる

認証

すべてのリンクされたアカウントのエンドポイントには、認証のためにシークレットキーが必要です。クライアントサイドのコードでシークレットキーを公開しないでください。

利用可能なエンドポイント

メソッド	エンドポイント	説明
POST	`/linked_accounts`	新しいリンクされたアカウントを作成
GET	`/linked_accounts`	すべてのリンクされたアカウントを一覧表示
GET	`/linked_accounts/:id`	特定のリンクされたアカウントを取得
GET	`/linked_accounts/search`	リンクされたアカウントを検索
DELETE	`/linked_accounts/:id`	リンクされたアカウントを削除

一般的なユースケース

マーケットプレイスプラットフォーム

決済処理と収益の自動分配のために販売者アカウントを接続。

SaaSプラットフォーム

ソフトウェアプラットフォームを使用する事業者のマーチャントアカウントを管理。

アグリゲーターサービス

プラットフォーム下で複数のサービスプロバイダーをオンボードし管理。

フランチャイズネットワーク

フランチャイズ店舗の決済を接続・管理。

ベストプラクティス

接続後は速やかにアカウントを認証
リンクされたアカウントIDをデータベースに保存
アカウントステータスの変更を監視
認証失敗を適切に処理
分類用にメタデータを使用（merchant_type、regionなど）
アカウントステータス更新を受信するためにwebhookを実装
コンプライアンスのためにアカウント活動を定期的にレビュー

セキュリティに関する考慮事項

アクセス制御 - シークレットキー認証を使用
データ暗号化 - 機密データは保存時に暗号化
監査証跡 - すべてのアカウント変更を追跡
コンプライアンス - アカウントはKYC認証を受ける
不正防止 - 不審な活動を監視

概要​

リンクされたアカウントのタイプ​

個人アカウント​

法人アカウント​

リンクされたアカウントのライフサイクル​

アカウントステータス​

アカウントの機能​

認証​

利用可能なエンドポイント​

一般的なユースケース​

マーケットプレイスプラットフォーム​

SaaSプラットフォーム​

アグリゲーターサービス​

フランチャイズネットワーク​

ベストプラクティス​

セキュリティに関する考慮事項​

関連リソース​

概要