Cardの更新

PATCHhttps://api.omise.co/customers/:id/cards/:card_id

カード名義人、有効期限、請求先住所、郵便番号を含むカード詳細を更新します。すべての更新パラメータはオプションです。

---

🔑API認証情報

▼

---

リクエストパラメータ

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

▼

`id`STRING(required)

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

Example:"cust_test_5xuy4w91xqz7d1w9u0t"

Constraints:Must be a valid customer ID

`card_id`STRING(required)

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

Example:"card_test_5xuy4w91xqz7d1w9u0t"

Constraints:Must be a valid card ID, Card must belong to the customer

追加 - 3フィールドカード情報の更新

▼

追加 - 2フィールド請求先住所の更新

▼

---

レスポンス

200

Cardが正常に更新されました

更新された情報を含むCardオブジェクトが返されます。

更新可能なフィールド:

• name - カード名義人
• expiration_month - Card有効期限月
• expiration_year - Card有効期限年
• city - 請求先都市
• postal_code - 請求先郵便番号

更新不可のフィールド:

• カード番号（代わりに新しいカードを作成してください）
• Cardブランド
• 発行銀行
• Fingerprint

400

不正なリクエスト

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

一般的な原因:

• 無効な有効期限月（1-12の範囲外）
• 過去の有効期限
• 無効な年の形式

401

認証されていません

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

一般的な原因:

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

404

見つかりません

CustomerまたはCardが見つかりません。

一般的な原因:

• Customer IDが存在しません
• Card IDが存在しません
• Cardが指定された顧客に属していません

---

コードサンプル

cURL

curl https://api.omise.co/customers/cust_test_5xuy4w91xqz7d1w9u0t/cards/card_test_5xuy4w91xqz7d1w9u0t \
  -X PATCH \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "name=JOHN DOE" \
  -d "expiration_month=12" \
  -d "expiration_year=2026"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

card = Omise::Card.update(
  'card_test_5xuy4w91xqz7d1w9u0t',
  {
    customer_id: 'cust_test_5xuy4w91xqz7d1w9u0t',
    name: 'JOHN DOE',
    expiration_month: 12,
    expiration_year: 2026
  }
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

customer = omise.Customer.retrieve('cust_test_5xuy4w91xqz7d1w9u0t')
card = customer.update_card('card_test_5xuy4w91xqz7d1w9u0t',
    name='JOHN DOE',
    expiration_month=12,
    expiration_year=2026
)

Node.js

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

const card = await omise.customers.updateCard(
  'cust_test_5xuy4w91xqz7d1w9u0t',
  'card_test_5xuy4w91xqz7d1w9u0t',
  {
    name: 'JOHN DOE',
    expiration_month: 12,
    expiration_year: 2026
  }
);

PHP

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

$customer = OmiseCustomer::retrieve('cust_test_5xuy4w91xqz7d1w9u0t');
$card = $customer->updateCard('card_test_5xuy4w91xqz7d1w9u0t', [
    'name' => 'JOHN DOE',
    'expiration_month' => 12,
    'expiration_year' => 2026
]);

Java

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

Card card = client.customer("cust_test_5xuy4w91xqz7d1w9u0t")
    .card("card_test_5xuy4w91xqz7d1w9u0t")
    .update()
    .name("JOHN DOE")
    .expirationMonth(12)
    .expirationYear(2026)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var card = await client.Customers.UpdateCard(
    "cust_test_5xuy4w91xqz7d1w9u0t",
    "card_test_5xuy4w91xqz7d1w9u0t",
    new UpdateCardRequest
    {
        Name = "JOHN DOE",
        ExpirationMonth = 12,
        ExpirationYear = 2026
    }
);

Go

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

card, _ := client.Cards().UpdateCard(
    "cust_test_5xuy4w91xqz7d1w9u0t",
    "card_test_5xuy4w91xqz7d1w9u0t",
    &operations.UpdateCard{
        Name:            "JOHN DOE",
        ExpirationMonth: 12,
        ExpirationYear:  2026,
    },
)

---

エラーと結果コード

一般的なエラーコード

Code	Description	Resolution
bad_request	無効なパラメータ	有効期限と月の値を確認してください
authentication_failure	無効なAPI key	secret keyが正しいことを確認してください
not_found	CustomerまたはCardが見つかりません	IDが存在し、カードが顧客に属していることを確認してください
invalid_parameters	無効な有効期限	日付が将来であることを確認してください

更新可能なCardフィールド

Field	Description
name	更新されたカード名義人
expiration_month	更新された有効期限月（1-12）
expiration_year	更新された有効期限年（YYYY）
city	更新された請求先都市
postal_code	更新された請求先郵便番号

---

試してみる

必須 - 2項目

▼

id(必須)

card_id(必須)

追加 - 5項目

▼