チェーン送金を取得

GEThttps://api.omise.co/chains/:chain_id

識別子を使用して特定のチェーンを取得します。関連する課金と送金の詳細を含むチェーンオブジェクトを返します。

---

🔑API認証情報

▼

---

リクエストパラメータ

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

▼

`chain_id`STRING(required)

パターン /acch(_test)?_[0-9a-z]+/ に一致するチェーン識別子。URLパスで指定します。

Example:"acch_test_5xuy4w91xqz7d1w9u0t"

Constraints:有効なチェーンIDである必要があります

---

レスポンス

200

取得成功

チェーンの取得に成功しました。課金と送金の詳細を含む完全なチェーンオブジェクトを返します。

レスポンスに含まれる情報:

• id - チェーン識別子
• key - サブマーチャントの認証キー
• email - サブマーチャントアカウントのメールアドレス
• revoked - チェーンアクセスが取り消されたかどうか
• created_at - 作成タイムスタンプ

401

認証エラー

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

一般的な原因:

• Authorizationヘッダーの欠落
• 無効なシークレットキー
• シークレットキーの代わりにパブリックキーを使用
• HTTP Basic Auth形式の誤り

404

見つかりません

指定されたIDのチェーンが見つかりません。

一般的な原因:

• 無効なチェーンID形式
• チェーンが存在しない
• チェーンが別のアカウントに属している
• ライブチェーンIDでテストキーを使用（またはその逆）

5xx

サーバーエラー

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

対処方法:

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

---

コードサンプル

cURL

curl https://api.omise.co/chains/acch_test_5xuy4w91xqz7d1w9u0t \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

chain = Omise::Chain.retrieve('acch_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

chain = omise.Chain.retrieve('acch_test_5xuy4w91xqz7d1w9u0t')

Node.js

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

const chain = await omise.chains.retrieve('acch_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$chain = OmiseChain::retrieve('acch_test_5xuy4w91xqz7d1w9u0t');

Java

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

Chain chain = client.chains().get("acch_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var chain = await client.Chains.Get("acch_test_5xuy4w91xqz7d1w9u0t");

Go

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

chain, _ := client.Chains().Get("acch_test_5xuy4w91xqz7d1w9u0t")

---

エラーと結果コード

一般的なエラーコード

コード	説明	解決策
authentication_failure	無効なAPIキー	シークレットキーが正しいか確認
not_found	チェーンが見つからない	チェーンIDが正しく存在するか確認
invalid_chain_id	不正なチェーンID	IDが acch(test)?[0-9a-z]+ 形式に一致するか確認

チェーンオブジェクトのフィールド

フィールド	型	説明
object	string	常に"chain"を返します
id	string	一意のチェーン識別子
key	string	サブマーチャントの代わりにアクションを実行するための認証キー
email	string	サブマーチャントアカウントのメールアドレス
livemode	boolean	本番環境とテスト環境のインジケーター
revoked	boolean	チェーンアクセスが取り消されたかどうかを示す
created_at	string	作成タイムスタンプ（ISO 8601）

---

試してみる

必須 - 1項目

▼

chain_id(必須)

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