Chargeを支払済としてマーク

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

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

---

🔑API認証情報

▼

---

リクエストパラメータ

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

▼

`id`STRING(required)

支払済としてマークするcharge ID。手動でステータス更新が可能なテストchargeである必要があります。

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

Constraints:chrg_test_で始まる必要があります, Chargeは適格なステータスである必要があります, 決済方法ごとにサポートが制限されています

---

レスポンス

200

支払済としてマーク成功

Chargeのステータスが成功に更新され、支払済としてマークされました。

主なフィールドの変更:

• status - successfulに変更されます
• paid - trueに設定されます
• paid_at - 現在のタイムスタンプに設定されます
• transaction - Transaction IDが作成されます

400

不正なリクエスト

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

一般的な原因:

• 無効なcharge IDフォーマット
• 手動支払いに適格でないcharge
• 本番chargeの使用(テストchargeのみサポート)

401

認証されていません

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

一般的な原因:

• 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_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)

---

エラーコードと結果コード

一般的なエラーコード

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

---

試してみる

必須 - 1項目

▼

id(必須)