チャージを支払い済みとしてマーク

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

テストチャージを支払い済みとしてマークします。このエンドポイントは主にテストと照合目的で使用され、特定の決済方法のサポートは限定的です。

---

リクエストパラメータ

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

▼

`id`STRING(required)

支払い済みとしてマークするチャージID。手動ステータス更新の対象となるテストチャージである必要があります。

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

Constraints:chrg_test_で始まる必要があります, チャージが適格なステータスである必要があります, 決済方法ごとにサポートは限定的

---

レスポンス

200

支払い済みマーク成功

チャージステータスがsuccessfulに更新され、支払い済みとしてマークされました。

主要フィールドの変更:

• status - successfulに変更
• paid - trueに設定
• paid_at - 現在のタイムスタンプに設定
• transaction - トランザクションIDが作成

400

不正なリクエスト

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

一般的な原因:

• 無効なチャージID形式
• チャージが手動支払いの対象外
• 本番チャージを使用（テストチャージのみサポート）

401

認証エラー

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

一般的な原因:

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

404

見つかりません

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

一般的な原因:

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

5xx

サーバーエラー

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

対処方法:

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

---

コードサンプル

cURL

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Node.js

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

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

PHP

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

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

Java

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

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

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

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

Go

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

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

---

エラーと結果コード

一般的なエラーコード

コード	説明	解決方法
not_found	チャージIDが存在しない	チャージIDが正しいか確認
not_eligible	チャージを支払い済みとしてマークできない	チャージステータスと決済方法を確認
already_paid	チャージは既に支払い済み	アクション不要
not_test_charge	テストチャージのみサポート	テストキーとテストチャージを使用

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

id(必須)

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