リンクの削除

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

そのリンクを通じた支払いを防ぐために支払いリンクを削除します。削除されると、支払いURLは顧客からアクセスできなくなります。リンクに関連付けられた既存の課金は保持されます。

---

リクエストパラメータ

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

▼

`link_id`STRING(required)

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

Example:"link_test_5xuy4w91xqz7d1w9u0t"

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

---

レスポンス

200

削除成功

リンクが正常に削除されました。deletedフラグがtrueに設定された削除されたリンクオブジェクトを返します。

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

• object - 常に "link" を返す
• id - 削除されたリンクの識別子
• deleted - 削除成功を示すtrueに設定
• livemode - 本番環境かテスト環境かのインジケーター

400

不正なリクエスト

リクエストの検証に失敗しました。詳細はエラーメッセージを確認してください。

一般的な原因:

• リンクは既に削除済み
• 保留中の操作によりリンクを削除できない
• 無効なリクエスト形式

401

認証エラー

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

一般的な原因:

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

404

見つかりません

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

一般的な原因:

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

5xx

サーバーエラー

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

対処方法:

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

---

コードサンプル

cURL

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Node.js

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

const result = await omise.links.destroy('link_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$link = OmiseLink::retrieve('link_test_5xuy4w91xqz7d1w9u0t');
$link->destroy();

Java

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

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

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var result = await client.Links.Destroy("link_test_5xuy4w91xqz7d1w9u0t");

Go

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

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

---

エラーと結果コード

一般的なエラーコード

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

重要な注意事項

トピック	説明
削除は永続的	削除されたリンクは復元できません
課金は保持	リンクを通じて行われた既存の課金はアカウントに残ります
支払いURL無効化	顧客は支払いページにアクセスできなくなります
Webhooks	削除時に link.deleted イベントがトリガーされます

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

link_id(必須)

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