linkの取得

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

識別子による特定のpayment linkの詳細を取得します。chargeの履歴と使用ステータスを含む完全なlinkオブジェクトを返します。

---

🔑API認証情報

▼

---

リクエストパラメータ

Required - 1 fieldRequired Parameters

▼

`link_id`STRING(required)

パターン/link(_test)?_[0-9a-z]+/に一致するlink識別子。これはURLパスで提供されます。

Example:"link_test_5xuy4w91xqz7d1w9u0t"

Constraints:有効なlink IDである必要があります

---

レスポンス

200

成功した取得

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

レスポンスに含まれるもの:

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

401

認証されていません

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

一般的な原因:

• Authorizationヘッダーが欠落している
• 無効なsecret key
• secret keyの代わりにpublic keyを使用している
• HTTP Basic Auth形式が正しくない

404

Not found

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

一般的な原因:

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

---

コードサンプル

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

---

エラーおよび結果コード

一般的なエラーコード

Code	Description	Resolution
authentication_failure	無効なAPIキー	secret keyが正しいことを確認してください
not_found	linkが見つからない	link IDが正しく存在することを確認してください
invalid_link_id	不正なlink ID	IDがlink(test)?[0-9a-z]+形式と一致することを確認してください

linkオブジェクトフィールド

Field	Type	Description
object	string	常に「link」を返します
id	string	一意のlink識別子
livemode	boolean	本番環境とテスト環境の識別子
payment_uri	string	共有可能な支払いURL
amount	integer	最小通貨単位でのトランザクション値
currency	string	ISO通貨コード
used	boolean	単回使用linkの消費ステータス
multiple	boolean	再利用可能フラグ
title	string	linkタイトル
description	string	linkの説明
charges	list	関連する支払いトランザクション
created_at	string	作成タイムスタンプ（ISO 8601）

---

試してみる

必須 - 1項目

▼

link_id(必須)