Customerの取得

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

保存されたカード、メール、説明、metadataを含む、Customerに関する完全な情報を取得します。

---

🔑API認証情報

▼

---

リクエストパラメータ

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

▼

`id`STRING(required)

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

Example:"cust_test_5xuy4w91xqz7d1w9u0t"

Constraints:Must be a valid customer ID

---

レスポンス

200

Customerが正常に取得されました

保存されたカードを含むすべての詳細とともにCustomerオブジェクトが返されます。

Customerオブジェクトに含まれるもの:

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

401

認証されていません

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

一般的な原因:

• Authorizationヘッダーが不足しています
• 無効なsecret key
• secret keyではなくpublic keyを使用しています
• HTTP Basic Auth形式が正しくありません

404

見つかりません

Customer IDが見つかりません。

一般的な原因:

• Customer IDが存在しません
• Customerが削除されています
• 正しくないCustomer ID形式

---

コードサンプル

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)

---

エラーと結果コード

一般的なエラーコード

Code	Description	Resolution
authentication_failure	無効なAPI key	secret keyが正しいことを確認してください
not_found	Customerが見つかりません	Customer IDが存在することを確認してください
bad_request	無効なCustomer ID形式	IDがcust_で始まることを確認してください

Customerレスポンスフィールド

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

---

お試しください

必須 - 1項目

▼

id(必須)