Tokenの取得

GEThttps://vault.omise.co/tokens/:id

既存のTokenに関する情報（使用状況と関連するカードの詳細を含む）を取得します。

---

🔑API認証情報

▼

---

リクエストパラメータ

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

▼

`id`STRING(required)

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

Example:"tokn_test_5xuy4w91xqz7d1w9u0t"

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

---

レスポンス

200

取得成功

Tokenが正常に取得されました。カードの詳細を含むTokenオブジェクトを返します。

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

• id - Token識別子
• used - Tokenが使用されたかどうか（未使用の場合はfalse、使用済みの場合はtrue）
• charge_status - Tokenで作成された課金のステータス（未使用の場合はnull）
• card - サニタイズされた情報を含むcardオブジェクト
• card.brand - カードブランド（Visa、Mastercard、JCBなど）
• card.last_digits - カード番号の下4桁
• card.fingerprint - 一意のカード識別子
• card.security_code_check - CVVが検証されたかどうか

401

認証されていません

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

よくある原因:

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

404

見つかりません

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

よくある原因:

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

---

コードサンプル

cURL

curl https://vault.omise.co/tokens/tokn_test_5xuy4w91xqz7d1w9u0t \
  -u pkey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'pkey_test_5xuy4w91xqz7d1w9u0t'

token = Omise::Token.retrieve('tokn_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_public = 'pkey_test_5xuy4w91xqz7d1w9u0t'

token = omise.Token.retrieve('tokn_test_5xuy4w91xqz7d1w9u0t')

Node.js

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

const token = await omise.tokens.retrieve('tokn_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$token = OmiseToken::retrieve('tokn_test_5xuy4w91xqz7d1w9u0t');

Java

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

Token token = client.tokens().get("tokn_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("pkey_test_5xuy4w91xqz7d1w9u0t");

var token = await client.Tokens.Get("tokn_test_5xuy4w91xqz7d1w9u0t");

Go

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

token, _ := client.Tokens().Get("tokn_test_5xuy4w91xqz7d1w9u0t")

---

エラーと結果コード

一般的なエラーコード

コード	説明	解決方法
authentication_failure	無効なAPIキー	公開鍵が正しいことを確認してください
not_found	Tokenが見つかりません	Token IDが有効で存在することを確認してください

Tokenステータス

フィールド	値	説明
used	false	Tokenは未使用で利用可能
used	true	Tokenは使用済みで再利用できません
charge_status	null	Tokenはまだ使用されていません
charge_status	successful	Tokenは成功した課金に使用されました
charge_status	failed	Tokenは使用されましたが課金に失敗しました
charge_status	pending	Tokenは使用され、課金は保留中です

---

試してみる

必須 - 1項目

▼

id(必須)