チャージを更新

PATCHhttps://api.omise.co/charges/:id

既存のチャージの説明とメタデータを更新します。チャージ作成後に変更できるのはこの2つのフィールドのみです。

---

リクエストパラメータ

必須 - 1項目必須パラメータ

▼

`id`STRING(required)

更新するチャージID。アカウントの有効なチャージである必要があります。

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

Constraints:chrg_で始まる必要があります

追加 - 2項目追加パラメータ

▼

---

レスポンス

200

更新成功

チャージが正常に更新されました。更新されたフィールドを含む完全なチャージオブジェクトを返します。

更新されるフィールド:

• description - 新しい説明（提供された場合）
• metadata - 新しいメタデータオブジェクト（提供された場合）
• 他のすべてのフィールドは変更されません

400

不正なリクエスト

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

一般的な原因:

• メタデータが15,000文字を超えている
• 無効なメタデータ形式
• 更新するフィールドが提供されていない

401

認証エラー

認証に失敗しました。無効または欠落したAPIキー。

一般的な原因:

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

404

見つかりません

チャージIDが存在しません。

一般的な原因:

• 不正なチャージID
• 別のアカウントのチャージ
• 本番チャージにテストキーを使用（またはその逆）

5xx

サーバーエラー

サーバー側でエラーが発生しました。まれですが、適切に処理してください。

対処方法:

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

---

コードサンプル

cURL

curl https://api.omise.co/charges/chrg_test_5xuy4w91xqz7d1w9u0t \
  -X PATCH \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "description=Order #1234 - Shipped" \
  -d "metadata[status]=shipped"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

charge = Omise::Charge.update('chrg_test_5xuy4w91xqz7d1w9u0t', {
  description: 'Order #1234 - Shipped',
  metadata: { status: 'shipped', tracking: 'TH123456789' }
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

charge = omise.Charge.update(
    'chrg_test_5xuy4w91xqz7d1w9u0t',
    description='Order #1234 - Shipped',
    metadata={'status': 'shipped', 'tracking': 'TH123456789'}
)

Node.js

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

const charge = await omise.charges.update('chrg_test_5xuy4w91xqz7d1w9u0t', {
  description: 'Order #1234 - Shipped',
  metadata: { status: 'shipped', tracking: 'TH123456789' }
});

PHP

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

$charge = OmiseCharge::retrieve('chrg_test_5xuy4w91xqz7d1w9u0t');
$charge->update(array(
    'description' => 'Order #1234 - Shipped',
    'metadata' => array('status' => 'shipped', 'tracking' => 'TH123456789')
));

Java

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

Map<String, String> metadata = new HashMap<>();
metadata.put("status", "shipped");
metadata.put("tracking", "TH123456789");

Charge charge = client.charges().update("chrg_test_5xuy4w91xqz7d1w9u0t")
    .description("Order #1234 - Shipped")
    .metadata(metadata)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var charge = await client.Charges.Update("chrg_test_5xuy4w91xqz7d1w9u0t", new UpdateChargeRequest {
    Description = "Order #1234 - Shipped",
    Metadata = new Dictionary<string, object> {
        { "status", "shipped" },
        { "tracking", "TH123456789" }
    }
});

Go

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

charge, _ := client.UpdateCharge("chrg_test_5xuy4w91xqz7d1w9u0t", &operations.UpdateCharge{
    Description: "Order #1234 - Shipped",
    Metadata: map[string]interface{}{
        "status":   "shipped",
        "tracking": "TH123456789",
    },
})

---

エラーと結果コード

更新可能なフィールド

フィールド	更新可能?	備考
description	はい	内部使用のテキスト説明
metadata	はい	カスタムキーバリューデータ（完全に置換）
amount	いいえ	作成後は変更不可
currency	いいえ	作成後は変更不可
status	いいえ	capture/reverseなどで変更
card	いいえ	決済方法は変更不可

メタデータの動作

アクション	結果	重要な注意
メタデータを更新	オブジェクト全体を置換	保持したいすべてのキーを含める必要があります
メタデータを省略	変更なし	既存のメタデータは保持
空のメタデータ	すべてのメタデータをクリア	すべての既存データが削除

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

id(必須)

追加 - 2項目

▼

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