Retrieve Chain Transfer

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

Retrieve a specific chain by its identifier. Returns the chain object which includes the associated charge and transfer details.

---

🔑API認証情報

▼

---

リクエストパラメータ

Required - 1 fieldRequired Parameters

▼

`chain_id`STRING(required)

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

Example:"acch_test_5xuy4w91xqz7d1w9u0t"

Constraints:Must be a valid chain ID

---

レスポンス

200

取得成功

chainが正常に取得されました。課金と振込の詳細を含む完全なchainオブジェクトを返します。

レスポンスに含まれる内容:

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

401

認証されていません

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

一般的な原因:

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

404

Not found

指定されたIDのchainが見つかりません。

一般的な原因:

• 無効なchain ID形式
• chainが存在しない
• chainが別のアカウントに属している
• 本番環境のchain IDに対してテストキーを使用している（またはその逆）

---

コードサンプル

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	chainが見つかりません	chain IDが正しく、存在することを確認してください
invalid_chain_id	不正なchain ID	IDがacch(test)?[0-9a-z]+の形式に一致することを確認してください

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

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

---

試してみる

必須 - 1項目

▼

chain_id(必須)