顧客のCard一覧取得

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

特定の顧客に紐付けられたすべてのカードのページネーションされたリストを、オプションの並び順指定で取得します。

---

🔑API認証情報

▼

---

リクエストパラメータ

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

▼

`id`STRING(required)

Customer ID（cust_で始まる有効なCustomer IDである必要があります）。

Example:"cust_test_5xuy4w91xqz7d1w9u0t"

Constraints:Must be a valid customer ID

追加 - 3フィールドページネーションと並べ替え

▼

---

レスポンス

200

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

Cardオブジェクトとページネーション情報を含むListオブジェクト。

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

• id - Card ID (card_*)
• brand - Cardブランド（Visa、MasterCard、JCBなど）
• last_digits - カード番号の下4桁
• name - カード名義人
• expiration_month - Card有効期限月（1-12）
• expiration_year - Card有効期限年（YYYY）
• bank - 発行銀行名
• fingerprint - 一意のCard識別子（重複検出用）

400

不正なリクエスト

無効なパラメータが提供されました。

一般的な原因:

• 無効なlimit値（100を超えています）
• 負のoffset値
• 無効なorder値

401

認証されていません

認証に失敗しました。無効または欠落しているAPI keyです。

一般的な原因:

• Authorizationヘッダーが欠落しています
• 無効なsecret key
• secret keyの代わりにpublic keyを使用しています
• HTTP Basic Authの形式が正しくありません

404

見つかりません

Customerが見つかりません。

一般的な原因:

• Customer IDが存在しません
• Customerは削除されています

---

コードサンプル

cURL

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

cards = Omise::Card.list({
  customer_id: 'cust_test_5xuy4w91xqz7d1w9u0t'
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Node.js

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

const cards = await omise.customers.listCards('cust_test_5xuy4w91xqz7d1w9u0t', {
  limit: 20,
  offset: 0
});

PHP

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

$customer = OmiseCustomer::retrieve('cust_test_5xuy4w91xqz7d1w9u0t');
$cards = $customer['cards'];

Java

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

ScopedList<Card> cards = client.customer("cust_test_5xuy4w91xqz7d1w9u0t")
    .cards()
    .list()
    .limit(20L)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var cards = await client.Customers.ListCards("cust_test_5xuy4w91xqz7d1w9u0t", new ListRequest
{
    Limit = 20,
    Offset = 0
});

Go

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

cards, _ := client.Cards().ListCards("cust_test_5xuy4w91xqz7d1w9u0t", &operations.ListCards{
    List: operations.List{
        Limit:  20,
        Offset: 0,
    },
})

---

エラーと結果コード

一般的なエラーコード

Code	Description	Resolution
bad_request	無効なパラメータ	limitとoffsetの値を確認してください
authentication_failure	無効なAPI key	secret keyが正しいことを確認してください
not_found	Customerが見つかりません	customer IDが存在することを確認してください

Cardフィールド

Field	Description
id	Card ID (card_*)
brand	Cardブランド（Visa、MasterCardなど）
last_digits	カード番号の下4桁
name	カード名義人
expiration_month	有効期限月（1-12）
expiration_year	有効期限年（YYYY）
bank	発行銀行名
country	Card発行国
fingerprint	重複検出用の一意の識別子

---

試してみる

必須 - 1項目

▼

id(必須)

追加 - 3項目

▼