メインコンテンツへスキップ
バージョン: 最新版

Payment Links+ API

Payment LinksとPayment Links+の違い

Omiseは2種類のPayment Links製品を提供しています：

機能Payment LinksPayment Links+
APIサーバーhttps://api.omise.co/linkshttps://linksplus-api.omise.co
テンプレートなしあり - 再利用可能なテンプレートを作成
カスタムWebhookアカウントレベルのみリンクごとにカスタムWebhook設定可能
チーム管理なしあり - team_idベース
ドキュメントPayment Links APIこのページ

標準のOmise API（api.omise.co）を使用している場合は、Payment Links APIをご覧ください。

専用のLinks+ APIを使用して、プログラムでPayment Links+を作成・管理します。このAPIは、テンプレートベースのリンク作成、カスタムWebhook、高度な機能を提供します。

ベースURL​

https://linksplus-api.omise.co

認証​

すべてのリクエストには、HTTP Basic AuthまたはBearerトークンを使用したシークレットキーによる認証が必要です。

# Basic Authを使用
curl https://linksplus-api.omise.co/external/links \
  -u skey_test_xxx:

# Bearerトークンを使用
curl https://linksplus-api.omise.co/external/links \
  -H "Authorization: Bearer skey_test_xxx"

APIエンドポイント​

リンク​

メソッドエンドポイント説明
POST/external/links決済リンクを作成
GET/external/links/:link_id決済リンクを取得
GET/external/:team_id/links決済リンク一覧

テンプレート​

メソッドエンドポイント説明
GET/external/templates/:template_idテンプレートを取得
GET/external/:team_id/templatesテンプレート一覧

Webhook​

Payment Links+は、1回の決済につき最大3つのWebhookエンドポイントをサポートしています：

  1. システムWebhook - アカウントレベルで設定
  2. ダッシュボードWebhook - Omiseダッシュボードで設定
  3. カスタムWebhook - custom_webhookパラメータでリンクごとに指定

Webhookペイロード​

決済が完了すると、設定されたすべてのWebhookが決済イベントを受信します：

{
  "event": "payment.completed",
  "link_id": 789,
  "payment": {
    "id": "chrg_test_xxx",
    "amount": 100000,
    "currency": "thb",
    "status": "successful"
  },
  "timestamp": "2026-02-14T10:35:00Z"
}
HTTPS必須

カスタムWebhook URLはHTTPSを使用する必要があります。HTTP URLは拒否されます。

レスポンスコード​

コード説明
200 OKリクエスト成功
400 Bad Request無効なパラメータまたは必須項目の欠落
401 Unauthorized無効または欠落しているAPIキー
404 Not Foundリソースが見つかりません
500 Internal Server Errorサーバーエラー、後で再試行してください

関連リソース​