Chargeを取得

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

既存のChargeの詳細を取得します。ステータス、決済方法、トランザクションの詳細を含むChargeの完全な情報を返します。

---

🔑API認証情報

▼

---

リクエストパラメータ

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

▼

`id`STRING(required)

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

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

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

---

レスポンス

200

取得成功

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

レスポンスに含まれる内容:

• status - pending、successful、failed、expired、またはreversed
• amount - 最小通貨単位でのCharge金額
• paid - 支払いが完了しているかどうか
• authorized - Chargeが認証されているかどうか
• card / source - 決済方法の詳細
• refunds - refundのリスト(ある場合)
• failure_code / failure_message - 失敗時のエラー詳細

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 \
  -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)

---

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

Chargeのステータス値

Status	Description	Next Steps
pending	顧客のアクション待ち	webhookを待つか、定期的にポーリングしてください
successful	支払い完了	注文を処理してください
failed	支払い失敗	failure_codeとfailure_messageを確認してください
expired	Chargeが期限切れ	新しいchargeを作成してください
reversed	事前認証がキャンセル	資金は移動されていません

Boolean フラグ

Field	Description	Use Case
paid	支払い完了	注文処理前に確認
authorized	資金が認証済み	事前認証のステータス
capturable	事前認証をキャプチャ可能	キャプチャ前に確認
refundable	refundを作成可能	refund前に確認
reversible	事前認証をreverse可能	reverse前に確認

---

試してみる

必須 - 1項目

▼

id(必須)