チャージを取り消し

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

事前承認されたチャージを取り消して、決済をキャプチャせずに顧客の資金のホールドを解除します。capture=falseで作成されたチャージでのみ機能します。

---

リクエストパラメータ

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

▼

`id`STRING(required)

取り消すチャージID。キャプチャされていない事前承認チャージ（status: successful、capture: false、reversible: true）である必要があります。

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

Constraints:chrg_で始まる必要があります, 事前承認（capture: false）である必要があります, 取り消し可能である必要があります, 7日間の承認ウィンドウ内

---

レスポンス

200

取り消し成功

事前承認がキャンセルされました。資金が顧客に返金されました。

取り消し後の主要フィールドの変更:

• status - successfulからreversedに変更
• reversed - falseからtrueに変更
• reversed_at - 現在のタイムスタンプに設定
• reversible - trueからfalseに変更
• capturable - trueからfalseに変更

400

不正なリクエスト

無効なパラメータまたはチャージを取り消せません。

一般的な原因:

• チャージは既にキャプチャ済み（代わりに返金を使用）
• 無効なチャージID形式
• チャージが事前承認ではない

401

認証エラー

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

一般的な原因:

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

404

見つかりません

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

一般的な原因:

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

422

処理不可能なエンティティ

チャージを取り消せません。

一般的な原因:

• チャージは既に取り消し済み
• チャージは既にキャプチャ済み（キャプチャ済みチャージは取り消せません）
• チャージが取り消し可能ではない（期限切れまたは不正なステータス）
• 承認が期限切れ（7日間を超過）

5xx

サーバーエラー

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

対処方法:

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

---

コードサンプル

cURL

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Node.js

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

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

PHP

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

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

Java

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

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

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

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

Go

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

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

---

エラーと結果コード

一般的なエラーコード

コード	説明	解決方法
not_found	チャージIDが存在しない	チャージIDが正しいか確認
already_reversed	チャージは既に取り消し済み	アクション不要
already_captured	チャージはキャプチャ済み（返金を使用）	キャプチャ済みチャージは取り消せません
not_reversible	チャージを取り消せない	reversibleフィールドがtrueか確認
authorization_expired	事前承認が期限切れ（7日超）	期限切れの承認は取り消せません

取り消しの要件

フィールド	必要な値	説明
status	successful	承認済みである必要があります
capture	false	事前承認である必要があります
reversible	true	取り消し対象である必要があります
reversed	false	まだ取り消されていない
経過時間	< 7日	承認ウィンドウ内

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

id(必須)

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