リンクされたアカウント作成

POSThttps://api.omise.co/linked_accounts

支払い方法登録を開始するための新しいリンクされたアカウントを作成します。レスポンスには、アカウント保有者が登録プロセスを完了できるregistration_uriが含まれます。

---

リクエストパラメータ

必須 - 2フィールド必須パラメータ

▼

`type`STRING(required)

リンクされたアカウントのタイプ。利用可能なタイプは支払い方法によって異なります（例：タイの銀行向けのdirect_debit_kbank、direct_debit_scb、direct_debit_bbl）。

Example:"direct_debit_kbank"

`return_uri`STRING(required)

登録プロセス完了後にアカウント保有者をリダイレクトするURI。

Example:"https://example.com/linked-accounts/complete"

オプション - 2フィールドオプションパラメータ

▼

---

レスポンス

200

リンクされたアカウントが正常に作成されました

リンクされたアカウントが作成されました。アカウント保有者をregistration_uriにリダイレクトして登録を完了させてください。

リンクされたアカウントオブジェクトのフィールド:

• object - 常に "linked_account"
• id - リンクされたアカウントID（lacct_*）。データベースに保存してください。
• livemode - 本番またはテストモードのリンクされたアカウントかどうか
• status - アカウントステータス：failed、expired、pending、successful、またはdeleted
• type - リンクされたアカウントのタイプ
• last_digits - リンクされたアカウント識別子の下数桁（該当する場合）
• registration_uri - アカウント保有者が登録を完了するURI
• return_uri - 登録後のリダイレクトURI
• expires_at - 登録リンクの有効期限
• created_at - リンクされたアカウント作成タイムスタンプ
• registered_at - 登録完了時刻（保留中の場合はnull）
• failure_code - 登録失敗時のエラーコード（失敗していない場合はnull）
• failure_message - 登録失敗時のエラーメッセージ（失敗していない場合はnull）
• metadata - カスタムキー値データ

400

不正なリクエスト

リクエストの検証に失敗しました。詳細はエラーメッセージを確認してください。

一般的な原因:

• 必須パラメータが不足（typeまたはreturn_uri）
• 無効なtype値
• 無効なreturn_uri形式
• 無効なcitizen_id形式
• メタデータが15,000文字を超えている

401

認証エラー

認証に失敗しました。無効または不足しているAPIキー。

一般的な原因:

• Authorizationヘッダーがない
• 無効なシークレットキー
• シークレットキーの代わりにパブリックキーを使用している
• 不正なHTTP Basic Auth形式

422

処理不可能なエンティティ

リクエストは有効でしたが、処理できませんでした。

一般的な原因:

• アカウントでリンクされたアカウントタイプが有効になっていない
• アカウント制限に達した
• 地域で支払い方法が利用できない

5xx

サーバーエラー

サーバー側でエラーが発生しました。まれですが、適切に処理する必要があります。

対処方法:

• 指数バックオフでリクエストをリトライ
• status.omise.coでサービスインシデントを確認
• 詳細なガイダンスについてはエラー処理を参照

---

コードサンプル

cURL

curl https://api.omise.co/linked_accounts \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "type=direct_debit_kbank" \
  -d "return_uri=https://example.com/linked-accounts/complete"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

linked_account = Omise::LinkedAccount.create({
  type: 'direct_debit_kbank',
  return_uri: 'https://example.com/linked-accounts/complete'
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

linked_account = omise.LinkedAccount.create(
    type='direct_debit_kbank',
    return_uri='https://example.com/linked-accounts/complete'
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const linkedAccount = await omise.linkedAccounts.create({
  type: 'direct_debit_kbank',
  return_uri: 'https://example.com/linked-accounts/complete'
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$linked_account = OmiseLinkedAccount::create([
    'type' => 'direct_debit_kbank',
    'return_uri' => 'https://example.com/linked-accounts/complete'
]);

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

LinkedAccount linkedAccount = client.linkedAccounts().create()
    .type("direct_debit_kbank")
    .returnUri("https://example.com/linked-accounts/complete")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var linkedAccount = await client.LinkedAccounts.Create(new CreateLinkedAccountRequest
{
    Type = "direct_debit_kbank",
    ReturnUri = "https://example.com/linked-accounts/complete"
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

linkedAccount, _ := client.LinkedAccounts().Create(&operations.CreateLinkedAccount{
    Type:      "direct_debit_kbank",
    ReturnUri: "https://example.com/linked-accounts/complete",
})

---

エラーと結果コード

一般的なエラーコード

コード	説明	解決策
bad_request	パラメータが不足または無効	typeとreturn_uriが有効か確認
authentication_failure	無効なAPIキー	シークレットキーが正しいか確認
invalid_linked_account_type	タイプがサポートされていない	利用可能なリンクされたアカウントタイプを確認
not_enabled	機能が有効になっていない	サポートに連絡してリンクされたアカウントを有効化

リンクされたアカウントのステータス値

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

リンクされたアカウントのフィールド

フィールド	説明
id	リンクされたアカウントID（データベースに保存）
type	リンクされたアカウントのタイプ
status	リンクされたアカウントの現在のステータス
registration_uri	アカウント保有者が登録を完了するURL
return_uri	登録後のリダイレクトURL
last_digits	アカウント識別子の下数桁
expires_at	登録リンクの有効期限
registered_at	登録完了時刻
failure_code	登録失敗時のエラーコード
failure_message	人間が読めるエラーメッセージ
metadata	カスタムキー値データ
created_at	リンクされたアカウント作成タイムスタンプ

---

🔑API認証情報

▼

試してみる

必須 - 2項目

▼

type(必須)

return_uri(必須)

追加 - 2項目

▼

あなたのIP: ...読み込み中...