Create a Payment Link

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

Create a new payment link from a template.

---

Request Parameters

Required - 4 fieldsRequired Parameters

▼

`template_id`INTEGER(required)

ID of the template to use for creating the link. Retrieve from the List Templates endpoint.

Example:"123"

`team_id`INTEGER(required)

Your team ID. Find this in your Omise Dashboard settings.

Example:"456"

`name`STRING(required)

Name/title of the payment link shown to customers.

Example:"Premium Subscription"

`amount`INTEGER(required)

Amount in smallest currency unit (e.g., satangs for THB, cents for USD).

Example:"299900"

Recommended - 2 fieldsRecommended Parameters

▼

`currency`STRING(optional)

Three-letter ISO currency code. Defaults to template currency.

Example:"thb"

Default:"Template default"

`multiple_usage`BOOLEAN(optional)

Allow multiple payments on this link.

Default:"false"

Additional - 3 fieldsAdditional Parameters

▼

---

Responses

200

Successful creation

Returns the created payment link object with payment 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

Bad request

Invalid parameters or missing required fields.

401

Unauthorized

Invalid or missing API key.

---

Code samples

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

▼

Try it out

Required - 4 fields

▼

template_id(Required)

team_id(Required)

name(Required)

amount(Required)

Recommended - 2 fields

▼

Additional - 2 fields

▼

Your IP: ...Loading...