List All Chains

GEThttps://api.omise.co/chains

Returns a paginated collection of sub-merchant chain accounts. Chains represent sub-merchants who have authorized another account to create charges and perform actions on their behalf.

---

🔑API認証情報

▼

---

リクエストパラメータ

Additional - 5 fieldsAdditional Parameters

▼

---

レスポンス

200

取得成功

chainリストが正常に取得されました。メタデータを含むページネーション済みのリストを返します。

レスポンスの構造:

• object - 常に「list」を返します
• data - chainオブジェクトの配列
• limit - ページごとのレコード数
• offset - スキップされたレコード数
• total - フィルタに一致するchainの総数

401

認証されていません

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

一般的な原因:

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

---

コードサンプル

cURL

curl https://api.omise.co/chains \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -G \
  -d "limit=20" \
  -d "offset=0"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

chains = Omise::Chain.list(
  limit: 20,
  offset: 0
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

chains = omise.Chain.list(
    limit=20,
    offset=0
)

Node.js

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

const chains = await omise.chains.list({
  limit: 20,
  offset: 0
});

PHP

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

$chains = OmiseChain::retrieve([
    'limit' => 20,
    'offset' => 0
]);

Java

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

ScopedList<Chain> chains = client.chains().list()
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var chains = await client.Chains.GetList(new ListOptions
{
    Limit = 20,
    Offset = 0
});

Go

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

chains, _ := client.Chains().List(&omise.ListParams{
    Limit:  20,
    Offset: 0,
})

---

エラーと結果コード

一般的なエラーコード

コード	説明	解決方法
bad_request	パラメータの不足または無効	パラメータの値と形式を確認してください
authentication_failure	無効なAPIキー	シークレットキーが正しいことを確認してください
invalid_date_format	日付形式の検証に失敗しました	ISO 8601形式（YYYY-MM-DDTHH:MM:SSZ）を使用してください

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

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

---

試してみる

追加 - 5項目

▼