Chargeを失敗としてマーク

POSThttps://api.omise.co/charges/:id/mark_as_failed

テストChargeを失敗としてマークします。このエンドポイントは、主にテストと調整目的で使用され、特定の支払い方法に対する限定的なサポートがあります。

---

🔑API認証情報

▼

---

リクエストパラメータ

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

▼

`id`STRING(required)

失敗としてマークするCharge IDです。手動ステータス更新の対象となるテストChargeである必要があります。

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

Constraints:chrg_test_で始まる必要があります, Chargeは対象のstatusである必要があります, 支払い方法ごとに限定的なサポート

---

レスポンス

200

正常に失敗としてマークされました

Chargeのstatusがfailedに更新されました。

主要フィールドの変更:

• status - failedに変更
• failure_code - 適切な失敗コードに設定
• failure_message - 説明的な失敗メッセージ

400

不正なリクエスト

リクエストの検証に失敗しました。

一般的な原因:

• 無効なCharge ID形式
• Chargeは手動失敗の対象ではありません
• 本番Chargeを使用しています（テストChargeのみサポート）

401

認証されていません

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

一般的な原因:

• Authorizationヘッダーが欠落しています
• 無効なsecret key
• secret keyの代わりにpublic keyを使用しています

404

見つかりません

Charge IDが存在しません。

一般的な原因:

• 誤ったCharge ID
• 異なるアカウントのCharge
• 本番Chargeにテストkeyを使用している（またはその逆）

---

コードサンプル

cURL

curl https://api.omise.co/charges/chrg_test_5xuy4w91xqz7d1w9u0t/mark_as_failed \
  -X POST \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

charge = Omise::Charge.mark_failed('chrg_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

charge = omise.Charge.mark_failed('chrg_test_5xuy4w91xqz7d1w9u0t')

Node.js

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

const charge = await omise.charges.markFailed('chrg_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$charge = OmiseCharge::retrieve('chrg_test_5xuy4w91xqz7d1w9u0t');
$charge->markFailed();

Java

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

Charge charge = client.charges().markFailed("chrg_test_5xuy4w91xqz7d1w9u0t")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var charge = await client.Charges.MarkFailed("chrg_test_5xuy4w91xqz7d1w9u0t");

Go

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

charge, _ := client.MarkChargeFailed("chrg_test_5xuy4w91xqz7d1w9u0t", nil)

---

エラーと結果コード

一般的なエラーコード

Code	Description	Resolution
not_found	Charge IDが存在しません	Charge IDが正しいことを確認してください
not_eligible	Chargeを失敗としてマークできません	Chargeのstatusと支払い方法を確認してください
already_failed	Chargeは既に失敗しています	アクションは不要です
not_test_charge	テストChargeのみサポートされています	テストkeyとテストChargeを使用してください

---

試してみる

必須 - 1項目

▼

id(必須)