決済リンクを作成

POSThttps://linksplus-api.omise.co/external/links

テンプレートから新しい決済リンクを作成します。

---

リクエストパラメータ

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

▼

`template_id`INTEGER(required)

リンク作成に使用するテンプレートのID。テンプレート一覧エンドポイントから取得してください。

Example:"123"

`team_id`INTEGER(required)

チームID。Omiseダッシュボードの設定で確認できます。

Example:"456"

`name`STRING(required)

顧客に表示される決済リンクの名前/タイトル。

Example:"Premium Subscription"

`amount`INTEGER(required)

最小通貨単位での金額（例：THBはサタン、USDはセント）。

Example:"299900"

推奨 - 2項目推奨パラメータ

▼

`currency`STRING(optional)

3文字のISO通貨コード。デフォルトはテンプレートの通貨。

Example:"thb"

Default:"テンプレートのデフォルト"

`multiple_usage`BOOLEAN(optional)

このリンクで複数回の支払いを許可します。

Default:"false"

追加 - 3項目追加パラメータ

▼

---

レスポンス

200

作成成功

決済URLを含む作成された決済リンクオブジェクトを返します。

{
  "id": 789,
  "name": "Premium Subscription",
  "amount": 299900,
  "currency": "thb",
  "status": "active",
  "payment_url": "https://pay.omise.co/links/abc123",
  "multiple_usage": false,
  "created_at": "2026-02-14T10:30:00Z",
  "template_id": 123,
  "team_id": 456
}

400

不正なリクエスト

無効なパラメータまたは必須項目の欠落。

401

認証エラー

無効または欠落しているAPIキー。

---

コードサンプル

cURL

curl -X POST https://linksplus-api.omise.co/external/links \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "template_id": 123,
    "team_id": 456,
    "name": "Premium Subscription",
    "amount": 299900,
    "currency": "thb"
  }'

Node.js

const response = await fetch('https://linksplus-api.omise.co/external/links', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    template_id: 123,
    team_id: 456,
    name: 'Premium Subscription',
    amount: 299900,
    currency: 'thb'
  })
});

const link = await response.json();
console.log('Payment URL:', link.payment_url);

Python

import requests

response = requests.post(
    'https://linksplus-api.omise.co/external/links',
    headers={
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'template_id': 123,
        'team_id': 456,
        'name': 'Premium Subscription',
        'amount': 299900,
        'currency': 'thb'
    }
)

link = response.json()
print(f"Payment URL: {link['payment_url']}")

---

🔐Payment Links+ API Credentials

▼

試してみる

必須 - 4項目

▼

template_id(必須)

team_id(必須)

name(必須)

amount(必須)

推奨 - 2項目

▼

追加 - 2項目

▼

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