Chargeを期限切れにする

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

まだ承認されていない保留中のChargeを手動で期限切れにします。リダイレクトベースのフローを持つ特定の支払い方法にのみ適用されます。

---

🔑API認証情報

▼

---

リクエストパラメータ

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

▼

`id`STRING(required)

期限切れにするCharge IDです。まだ承認されていない保留中のChargeである必要があります。サポートされている支払いsource（Alipay CN/HK、DANA、GCash、KakaoPay、PayPay、Touch 'n Go）でのみ機能します。

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

Constraints:chrg_で始まる必要があります, Chargeのstatusはpendingである必要があります, サポートされているsourceを介して作成されている必要があります

---

レスポンス

200

正常に期限切れになりました

Chargeが期限切れとしてマークされました。顧客は支払いを完了できなくなりました。

期限切れ後の主要フィールドの変更:

• status - pendingからexpiredに変更
• expired - falseからtrueに変更
• expired_at - 現在のタイムスタンプに設定

400

不正なリクエスト

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

一般的な原因:

• 無効なCharge ID形式
• Chargeは期限切れの対象ではありません

401

認証されていません

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

一般的な原因:

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

404

見つかりません

Charge IDが存在しません。

一般的な原因:

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

422

処理できないエンティティ

Chargeを期限切れにできません。

一般的な原因:

• Chargeがpendingではありません（既にsuccessful、failed、またはexpired）
• Chargeは既に承認されています
• 手動期限切れがサポートされていない支払い方法です
• サポートされているsourceの代わりにcardで作成されたCharge

---

コードサンプル

cURL

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Node.js

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

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

PHP

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

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

Java

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

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

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

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

Go

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

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

---

エラーと結果コード

一般的なエラーコード

Code	Description	Resolution
not_found	Charge IDが存在しません	Charge IDが正しいことを確認してください
not_pending	Chargeがpendingではありません	pendingのChargeのみを期限切れにできます
already_expired	Chargeは既に期限切れです	アクションは不要です
not_expirable	サポートされていない支払い方法です	サポートされているsourceを確認してください
already_authorized	Chargeは既に承認されています	承認済みのChargeは期限切れにできません

サポートされている支払い方法

Payment Method	Supported	Notes
Alipay CN	Yes	保留中のChargeを期限切れにできます
Alipay HK	Yes	保留中のChargeを期限切れにできます
DANA	Yes	保留中のChargeを期限切れにできます
GCash	Yes	保留中のChargeを期限切れにできます
KakaoPay	Yes	保留中のChargeを期限切れにできます
PayPay	Yes	保留中のChargeを期限切れにできます
Touch 'n Go	Yes	保留中のChargeを期限切れにできます
Credit Card	No	カードは異なるフローを持ちます
PromptPay	No	PromptPayは自動的に期限切れになります

---

試してみる

必須 - 1項目

▼

id(必須)