チャージを取得

GEThttps://api.omise.co/charges/:id

既存のチャージの詳細を取得します。ステータス、決済方法、取引詳細を含むチャージの完全な情報を返します。

---

リクエストパラメータ

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

▼

`id`STRING(required)

取得するチャージID。アカウントの有効なチャージIDである必要があります。

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

Constraints:chrg_で始まる必要があります, テストチャージ: chrg_test_, 本番チャージ: chrg_live_

---

レスポンス

200

取得成功

すべてのフィールドを含む完全なチャージオブジェクトを返します。

レスポンスに含まれる項目:

• status - pending、successful、failed、expired、またはreversed
• amount - 最小通貨単位でのチャージ金額
• paid - 支払いが完了したかどうか
• authorized - チャージが承認されているかどうか
• card / source - 決済方法の詳細
• refunds - 返金のリスト（存在する場合）
• failure_code / failure_message - 失敗した場合のエラー詳細

401

認証エラー

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

一般的な原因:

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

404

見つかりません

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

一般的な原因:

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

5xx

サーバーエラー

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

対処方法:

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

---

コードサンプル

cURL

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Node.js

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

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

PHP

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

$charge = OmiseCharge::retrieve('chrg_test_5xuy4w91xqz7d1w9u0t');

Java

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

Charge charge = client.charges().get("chrg_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

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

Go

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

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

---

エラーと結果コード

チャージステータス値

ステータス	説明	次のステップ
pending	顧客のアクション待ち	Webhookを待つか定期的にポーリング
successful	決済完了	注文を履行
failed	決済失敗	failure_codeとfailure_messageを確認
expired	チャージ期限切れ	新しいチャージを作成
reversed	事前承認がキャンセル	資金は移動していません

ブールフラグ

フィールド	説明	ユースケース
paid	支払い完了	履行前に確認
authorized	資金が承認済み	事前承認ステータス
capturable	事前承認をキャプチャ可能	キャプチャ前に確認
refundable	返金を作成可能	返金前に確認
reversible	事前承認を取り消し可能	取り消し前に確認

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

id(必須)

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