リンクの取得

GEThttps://api.omise.co/links/:link_id

識別子で特定の支払いリンクの詳細を取得します。課金履歴と使用状態を含む完全なリンクオブジェクトを返します。

---

リクエストパラメータ

必須 - 1フィールド必須パラメータ

▼

`link_id`STRING(required)

パターン /link(_test)?_[0-9a-z]+/ に一致するリンク識別子。URLパスで指定します。

Example:"link_test_5xuy4w91xqz7d1w9u0t"

Constraints:有効なリンクIDである必要があります

---

レスポンス

200

取得成功

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

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

• payment_uri - 顧客支払い用の共有可能なURL
• used - 単回使用リンクが消費されたかどうか
• charges - このリンクで行われたすべての課金のリスト
• amount - 最小通貨単位での支払い金額
• currency - 通貨コード
• title - 顧客に表示されるリンクタイトル
• description - リンクの説明と詳細

401

認証エラー

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

一般的な原因:

• Authorizationヘッダーの欠落
• 無効なシークレットキー
• シークレットキーの代わりにパブリックキーを使用
• 不正なHTTP Basic Auth形式

404

見つかりません

指定されたIDのリンクが見つかりません。

一般的な原因:

• 無効なリンクID形式
• リンクが存在しない
• リンクが別のアカウントに属している
• ライブリンクIDでテストキーを使用（またはその逆）

5xx

サーバーエラー

サーバー側でエラーが発生しました。これらは稀ですが、適切に処理する必要があります。

対処方法:

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

---

コードサンプル

cURL

curl https://api.omise.co/links/link_test_5xuy4w91xqz7d1w9u0t \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

link = Omise::Link.retrieve('link_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

link = omise.Link.retrieve('link_test_5xuy4w91xqz7d1w9u0t')

Node.js

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

const link = await omise.links.retrieve('link_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$link = OmiseLink::retrieve('link_test_5xuy4w91xqz7d1w9u0t');

Java

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

Link link = client.links().get("link_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var link = await client.Links.Get("link_test_5xuy4w91xqz7d1w9u0t");

Go

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

link, _ := client.Links().Get("link_test_5xuy4w91xqz7d1w9u0t")

---

エラーと結果コード

一般的なエラーコード

コード	説明	解決方法
authentication_failure	無効なAPIキー	シークレットキーが正しいことを確認
not_found	リンクが見つかりません	リンクIDが正しく存在することを確認
invalid_link_id	不正なリンクID	IDがフォーマット link(test)?[0-9a-z]+ に一致することを確認

リンクオブジェクトフィールド

フィールド	型	説明
object	string	常に "link" を返す
id	string	一意のリンク識別子
livemode	boolean	本番環境かテスト環境かのインジケーター
location	string	リンクオブジェクトを取得するためのAPIパス
amount	integer	最小通貨単位でのトランザクション値
charges	list	関連する支払いトランザクション
currency	string	3文字のISO 4217通貨コード
deleted	boolean	リンクが削除されたかどうか
deleted_at	string	削除タイムスタンプ（ISO 8601）、削除されていない場合はnull
description	string	リンクの説明
merchant_name	string	サブマーチャント名（Payfacのみ）
merchant_uid	string	サブマーチャント識別子（Payfacのみ）
multiple	boolean	リンクが複数回使用できるかどうか
payment_uri	string	顧客用の共有可能な支払いURL
title	string	顧客に表示されるリンクタイトル
used	boolean	単回使用リンクが消費されたかどうか
used_at	string	使用タイムスタンプ（ISO 8601）、使用されていない場合はnull
created_at	string	作成タイムスタンプ（ISO 8601）

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

link_id(必須)

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