Create a Link

POSThttps://api.omise.co/links

Create a new payment link with the specified parameters. Links can be shared across any platform and configured for single-use or multiple-use.

---

🔑API Credentials

▼

---

Request Parameters

Required - 4 fieldsRequired Parameters

▼

`amount`INTEGER(required)

Payment amount in smallest currency unit (satangs for THB, cents for USD). Use 0 to allow customer-specified amounts.

Example:100000

Constraints:Minimum: 0

`currency`STRING(required)

ISO 4217 three-letter currency code in lowercase.

Example:"thb"

Values:thb, jpy, sgd, myr, usd

`title`STRING(required)

Link name displayed to customers on the payment page.

Example:"Invoice #12345 Payment"

`description`STRING(required)

Link details and additional context shown to customers.

Example:"Monthly subscription payment for January 2025"

Recommended - 1 fieldRecommended Parameters

▼

Additional - 1 fieldAdditional Parameters

▼

---

Responses

200

Successful creation

Link created successfully. Returns a complete link object with a payment_uri that can be shared with customers.

Key response fields:

• payment_uri - Shareable URL for customers to make payment
• used - Indicates if single-use link has been consumed
• multiple - Indicates if link allows multiple payments
• charges - List of charges made with this link

400

Bad request

Request validation failed. Check the error message for details.

Common causes:

• Missing required fields (amount, currency, title, description)
• Invalid currency code
• Invalid amount (negative value)
• Invalid data format

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid secret key
• Using public key instead of secret key
• Incorrect HTTP Basic Auth format

---

Code samples

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",
})

---

Error and result codes

Common Error Codes

Code	Description	Resolution
bad_request	Missing or invalid parameters	Check all required fields are provided
authentication_failure	Invalid API key	Verify your secret key is correct
invalid_amount	Amount validation failed	Ensure amount is 0 or positive integer
invalid_currency	Unsupported currency	Use supported currency codes (thb, jpy, sgd, myr, usd)

Link Status Fields

Field	Description
used	Single-use link consumption status (true if used)
multiple	Whether link allows multiple uses
payment_uri	Shareable URL for customer payment

---

Try it out

Required - 4 fields

▼

amount(Required)

currency(Required)

title(Required)

description(Required)

Recommended - 1 fields

▼

Additional - 1 fields

▼