Sourceの取得

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

既存のSourceに関する情報（タイプ、金額、QRコードデータ、課金ステータスを含む）を取得します。

---

🔑API認証情報

▼

---

リクエストパラメータ

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

▼

`id`STRING(required)

取得するSource ID。src_で始まり、その後にtest_またはlive_と一意の識別子が続く必要があります。

Example:"src_test_5xuy4w91xqz7d1w9u0t"

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

---

レスポンス

200

取得成功

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

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

• id - Source識別子
• type - 決済方法のタイプ
• flow - 決済フロー（offline、redirect、app_redirect）
• amount - Sourceの金額
• currency - 通貨コード
• charge_status - Sourceで作成された課金のステータス（unknown、pending、successful、failed、expired）
• scannable_code - 該当する場合のQRコードデータ
• references - 該当する場合の決済リファレンス

401

認証されていません

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

よくある原因:

• Authorizationヘッダーの欠落
• 無効な公開鍵
• HTTP Basic認証の形式が正しくない

404

見つかりません

Sourceが見つかりません。指定されたSource IDは存在しません。

よくある原因:

• Source IDの形式が無効
• Source IDがアカウントに存在しない
• テストキーを使用して本番環境のSourceにアクセスしようとしている（またはその逆）
• Source IDのタイプミス

---

コードサンプル

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	Sourceが見つかりません	Source IDが有効で存在することを確認してください

課金ステータス値

ステータス	説明
unknown	このSourceで課金はまだ作成されていません
pending	顧客のアクション待ちです
successful	決済が正常に完了しました
failed	決済に失敗しました
expired	完了前に決済の有効期限が切れました

---

試してみる

必須 - 1項目

▼

id(必須)