ソースの取得

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

既存のソースに関する情報を取得します。タイプ、金額、QRコードデータ、チャージステータスなどが含まれます。

---

リクエストパラメータ

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

▼

`id`STRING(required)

取得するソースID。src_で始まり、test_またはlive_と一意の識別子が続きます。

Example:"src_test_5xuy4w91xqz7d1w9u0t"

Constraints:有効なソースIDである必要があります, パターン: src_(test|live)_[0-9a-z]+

---

レスポンス

200

取得成功

ソースが正常に取得されました。すべての詳細を含むソースオブジェクトを返します。

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

• id - ソース識別子
• type - 決済手段タイプ
• flow - 決済フロー（offline、redirect、app_redirect）
• amount - ソース金額
• currency - 通貨コード
• charge_status - ソースで作成されたチャージのステータス（unknown、pending、successful、failed、expired）
• scannable_code - 該当する場合のQRコードデータ
• references - 該当する場合の決済参照情報
• created_at - ソース作成タイムスタンプ（ISO 8601）

401

認証エラー

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

主な原因:

• Authorizationヘッダーが不足
• 無効な公開キー
• HTTP Basic Auth形式が正しくない

404

見つかりません

ソースが見つかりません。指定されたソースIDが存在しません。

主な原因:

• 無効なソースID形式
• ソースIDがアカウントに存在しない
• テストキーで本番ソースにアクセス（またはその逆）
• ソースIDのタイプミス

5xx

サーバーエラー

サーバー側でエラーが発生しました。まれなケースですが、適切に処理する必要があります。

対処方法:

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

---

コードサンプル

cURL

curl https://api.omise.co/sources/src_test_5xuy4w91xqz7d1w9u0t \
  -u pkey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'pkey_test_5xuy4w91xqz7d1w9u0t'

source = Omise::Source.retrieve('src_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_public = 'pkey_test_5xuy4w91xqz7d1w9u0t'

source = omise.Source.retrieve('src_test_5xuy4w91xqz7d1w9u0t')

Node.js

const omise = require('omise')({
  publicKey: 'pkey_test_5xuy4w91xqz7d1w9u0t'
});

const source = await omise.sources.retrieve('src_test_5xuy4w91xqz7d1w9u0t');

PHP

<?php
define('OMISE_PUBLIC_KEY', 'pkey_test_5xuy4w91xqz7d1w9u0t');

$source = OmiseSource::retrieve('src_test_5xuy4w91xqz7d1w9u0t');

Java

Client client = new Client.Builder()
    .publicKey("pkey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Source source = client.sources().get("src_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("pkey_test_5xuy4w91xqz7d1w9u0t");

var source = await client.Sources.Get("src_test_5xuy4w91xqz7d1w9u0t");

Go

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

source, _ := client.Sources().Get("src_test_5xuy4w91xqz7d1w9u0t")

---

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

一般的なエラーコード

コード	説明	解決方法
authentication_failure	無効なAPIキー	公開キーが正しいか確認
not_found	ソースが見つからない	ソースIDが有効で存在するか確認

チャージステータス値

ステータス	説明
unknown	このソースでまだチャージが作成されていない
pending	顧客のアクション待ち
successful	決済が正常に完了
failed	決済失敗
expired	完了前に決済期限切れ

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

id(必須)

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