linkの作成

POSThttps://api.omise.co/links

指定されたパラメータで新しいpayment linkを作成します。linkはあらゆるプラットフォームで共有でき、単回使用または複数回使用に設定できます。

---

🔑API認証情報

▼

---

リクエストパラメータ

Required - 4 fieldsRequired Parameters

▼

`amount`INTEGER(required)

最小通貨単位での決済金額（THBの場合はサタン、USDの場合はセント）。顧客指定金額を許可する場合は0を使用します。

Example:100000

Constraints:最小: 0

`currency`STRING(required)

ISO 4217の3文字通貨コード（小文字）。

Example:"thb"

Values:thb, jpy, sgd, myr, usd

`title`STRING(required)

決済ページで顧客に表示されるlink名。

Example:"Invoice #12345 Payment"

`description`STRING(required)

linkの詳細と顧客に表示される追加コンテキスト。

Example:"Monthly subscription payment for January 2025"

Recommended - 1 fieldRecommended Parameters

▼

Additional - 1 fieldAdditional Parameters

▼

---

レスポンス

200

成功した作成

linkが正常に作成されました。顧客と共有できるpayment_uriを含む完全なlinkオブジェクトを返します。

主なレスポンスフィールド:

• payment_uri - 顧客が支払いを行うための共有可能なURL
• used - 単回使用linkが消費されたかどうかを示します
• multiple - linkが複数回の支払いを許可するかどうかを示します
• charges - このlinkで行われたchargeのリスト

400

Bad request

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

一般的な原因:

• 必須フィールドが欠落している（amount、currency、title、description）
• 無効な通貨コード
• 無効な金額（負の値）
• 無効なデータ形式

401

認証されていません

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

一般的な原因:

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

---

コードサンプル

cURL

curl https://api.omise.co/links \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "amount=100000" \
  -d "currency=thb" \
  -d "title=Invoice #12345 Payment" \
  -d "description=Monthly subscription payment for January 2025"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

link = Omise::Link.create({
  amount: 100000,
  currency: 'thb',
  title: 'Invoice #12345 Payment',
  description: 'Monthly subscription payment for January 2025'
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

link = omise.Link.create(
    amount=100000,
    currency='thb',
    title='Invoice #12345 Payment',
    description='Monthly subscription payment for January 2025'
)

Node.js

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

const link = await omise.links.create({
  amount: 100000,
  currency: 'thb',
  title: 'Invoice #12345 Payment',
  description: 'Monthly subscription payment for January 2025'
});

PHP

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

$link = OmiseLink::create([
    'amount' => 100000,
    'currency' => 'thb',
    'title' => 'Invoice #12345 Payment',
    'description' => 'Monthly subscription payment for January 2025'
]);

Java

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

Link link = client.links().create()
    .amount(100000L)
    .currency("thb")
    .title("Invoice #12345 Payment")
    .description("Monthly subscription payment for January 2025")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var link = await client.Links.Create(new CreateLinkRequest
{
    Amount = 100000,
    Currency = "thb",
    Title = "Invoice #12345 Payment",
    Description = "Monthly subscription payment for January 2025"
});

Go

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

link, _ := client.Links().Create(&operations.CreateLink{
    Amount:      100000,
    Currency:    "thb",
    Title:       "Invoice #12345 Payment",
    Description: "Monthly subscription payment for January 2025",
})

---

エラーおよび結果コード

一般的なエラーコード

Code	Description	Resolution
bad_request	パラメータが欠落または無効	すべての必須フィールドが提供されているか確認してください
authentication_failure	無効なAPIキー	secret keyが正しいことを確認してください
invalid_amount	金額の検証に失敗	金額が0または正の整数であることを確認してください
invalid_currency	サポートされていない通貨	サポートされている通貨コードを使用してください（thb、jpy、sgd、myr、usd）

linkステータスフィールド

Field	Description
used	単回使用linkの消費ステータス（使用済みの場合true）
multiple	linkが複数回使用を許可するかどうか
payment_uri	顧客支払い用の共有可能なURL

---

試してみる

必須 - 4項目

▼

amount(必須)

currency(必須)

title(必須)

description(必須)

推奨 - 1項目

▼

追加 - 1項目

▼