顧客を取得

GEThttps://api.omise.co/customers/:id

保存されたカード、メール、説明、メタデータを含む顧客の完全な情報を取得します。

---

リクエストパラメータ

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

▼

`id`STRING(required)

取得する顧客ID（cust_で始まる必要があります）。

Example:"cust_test_5xuy4w91xqz7d1w9u0t"

Constraints:有効な顧客IDである必要があります

---

レスポンス

200

顧客が正常に取得されました

保存されたカードを含むすべての詳細を持つ顧客オブジェクトが返されます。

顧客オブジェクトに含まれる情報:

• id - 顧客ID
• email - 顧客のメールアドレス
• description - 顧客名または説明
• default_card - デフォルトの支払いカードのID
• cards - すべての保存されたカードを含むリストオブジェクト
• metadata - カスタムキーと値のデータ
• created_at - 作成のISO 8601タイムスタンプ

401

認証エラー

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

一般的な原因:

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

404

見つかりません

顧客IDが見つかりません。

一般的な原因:

• 顧客IDが存在しない
• 顧客が削除済み
• 顧客ID形式が正しくない

5xx

サーバーエラー

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

対処方法:

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

---

コードサンプル

cURL

curl https://api.omise.co/customers/cust_test_5xuy4w91xqz7d1w9u0t \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

customer = Omise::Customer.retrieve('cust_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

customer = omise.Customer.retrieve('cust_test_5xuy4w91xqz7d1w9u0t')

Node.js

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

const customer = await omise.customers.retrieve('cust_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$customer = OmiseCustomer::retrieve('cust_test_5xuy4w91xqz7d1w9u0t');

Java

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

Customer customer = client.customers().get("cust_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var customer = await client.Customers.Get("cust_test_5xuy4w91xqz7d1w9u0t");

Go

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

customer, _ := client.Customers().Retrieve("cust_test_5xuy4w91xqz7d1w9u0t", nil)

---

エラーと結果コード

一般的なエラーコード

コード	説明	解決策
authentication_failure	無効なAPIキー	シークレットキーが正しいか確認
not_found	顧客が見つからない	顧客IDが存在するか確認
bad_request	無効な顧客ID形式	IDがcust_で始まるか確認

顧客レスポンスフィールド

フィールド	説明
id	顧客ID (cust_*)
email	顧客のメールアドレス
description	顧客名または説明
default_card	デフォルトの支払いカードのID
cards	すべての保存されたカードを含むリストオブジェクト
cards.data	カードオブジェクトの配列
cards.total	保存されたカードの総数
metadata	カスタムキーと値のデータ
created_at	顧客作成タイムスタンプ

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

id(必須)

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