Links API

Important Update: As of August 20, 2024, the Link feature on Dashboard v2 is unavailable for new accounts, though existing accounts retain full access. We strongly recommend all users transition to our advanced Payment Links+ APIs, which offer enhanced functionality and represent the future of our payment processing capabilities. Read through our Payment Links+ API guide and embrace the future of seamless transactions today!

Create and retrieve payment request website links. Generated links can be shared on any platform and can be set to be used once or multiple times.

Attributes

Name	Type	Description
object	string	The string `link`.
id	string	The link identifier matching `/link(_test)?_[0-9a-z]+/`.
livemode	boolean	Whether this is a live (`true`) or test (`false`) link.
location	string	API path to retrieve the current `link` object.
amount	integer	Link amount in smallest unit of link currency.
charges	list	List of charges.
created	string	UTC datetime of link creation in ISO 8601 format (`YYYY-MM-DDThh:mm:ssZ`).
currency	string	Currency for link as three-letter ISO 4217 code.
deleted	boolean	Whether link is deleted.
description	string	Link description.
merchant_name	string	The name of the sub-merchant who created the payment link. Note: This field is applicable only if the merchant uses the Payfac solution. To enroll in Payfac, contact Opn Support
merchant_uid	string	The ID of the sub-merchant who created the payment link. Note: This field is applicable only if the merchant uses the Payfac solution. To enroll in Payfac, contact Opn Support
multiple	boolean	Whether link is able to be used more than once.
payment_uri	string	URI of link for use by payer.
title	string	Link title.
used	boolean	Whether single-use link (`multiple=false`) was used.

Example

JSON Response

{
  "object": "link",
  "id": "link_test_no1t4tnemucod0e51mo",
  "livemode": false,
  "deleted": false,
  "location": "/links/link_test_no1t4tnemucod0e51mo",
  "amount": 7440,
  "currency": "thb",
  "used": false,
  "multiple": false,
  "title": "Hot Latte",
  "description": "A warm cup of coffee",
  "charges": {
    "object": "list",
    "from": "1970-01-01T00:00:00Z",
    "to": "2019-07-23T01:15:07Z",
    "offset": 0,
    "limit": 20,
    "total": 0,
    "order": "chronological",
    "location": "/links/link_test_no1t4tnemucod0e51mo/charges",
    "data": [

    ]
  },
  "payment_uri": "https://link.omise.co/8D7B9C06",
  "created": "2019-07-23T01:15:07Z"
}

Create a link

- POST https://api.omise.co/links

Creates and returns a new link.

Request Parameters

Name	Type	Description
amount	integer	(required) Link amount in smallest unit of link currency.
currency	string	(required) Currency for link as three-letter ISO 4217 code.
description	string	(required) Link description.
title	string	(required) Link title.
multiple	boolean	(optional, one of: `true`, `false`) Whether link is able to be used more than once. Default: `false`.

Example

curl https://api.omise.co/links \
  -u $OMISE_SECRET_KEY: \
  -d "amount=10000" \
  -d "currency=thb" \
  -d "title=Hot Latte" \
  -d "description=A warm cup of coffee" \
  -d "multiple=true"

<?php

$link = OmiseLink::create(array(
  'amount'      => 99900,
  'currency'    => 'thb',
  'title'       => 'Hot Latte',
  'description' => 'A warm cup of coffee',
  'multiple'    => true
));

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

const link = await omise.links.create({
  amount: 10000,
  currency: 'thb',
  title: 'Hot Latte',
  description: 'A warm cup of coffee',
  multiple: true,
});
console.log(link);

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

link = Omise::Link.create({
  amount: 99900,
  currency: "thb",
  title: "Hot Latte",
  description: "A warm cup of coffee",
  multiple: true,
})

var link = await Client.Links.Create(new CreateLinkRequest
{
    Amount = 2000,
    Currency = "thb",
    Title = "that shirt.",
    Description = "that shirt.",
    Multiple = true,
});

Console.WriteLine($"payment link: ({link.Multiple}) {link.PaymentURI}");

Link link = client.links().create(new Link.Create()
        .amount(99900)
        .currency("thb")
        .title("Hot Latte")
        .description("A warm cup of coffee")
        .multiple(true));
assertEquals(99900, link.getAmount());

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

link = omise.Link.create(
    amount=100000,
    currency="thb",
    title="Hot Latte",
    description="A warm cup of coffee",
    multiple=True,
)

client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.Link{}
err := client.Do(result, &operations.CreateLink{
	Amount:      99900,
	Currency:    "thb",
	Title:       "Hot Latte",
	Description: "A warm cup of coffee",
	Multiple:    true,
})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Link.create(
  amount:      10000,
  currency:    "thb",
  title:       "Hot Latte",
  description: "A warm cup of coffee",
  multiple:    true
)

curl https://api.omise.co/links \
  -u $OMISE_SECRET_KEY: \
  -d "amount=10000" \
  -d "currency=thb" \
  -d "title=Hot Latte" \
  -d "description=A warm cup of coffee"

<?php

$link = OmiseLink::create(array(
  'amount'      => 99900,
  'currency'    => 'thb',
  'title'       => 'Hot Latte',
  'description' => 'A warm cup of coffee'
));

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

const link = await omise.links.create({
  amount: 10000,
  currency: 'thb',
  title: 'Hot Latte',
  description: 'A warm cup of coffee',
});
console.log(link);

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

link = Omise::Link.create({
  amount: 99900,
  currency: "thb",
  title: "Hot Latte",
  description: "A warm cup of coffee",
})

var link = await Client.Links.Create(new CreateLinkRequest
{
    Amount = 2000,
    Currency = "thb",
    Title = "that shirt.",
    Description = "that shirt.",
});

Console.WriteLine($"payment link: {link.PaymentURI}");

Link link = client.links().create(new Link.Create()
        .amount(99900)
        .currency("thb")
        .title("Hot Latte")
        .description("A warm cup of coffee"));
assertEquals(99900, link.getAmount());

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

link = omise.Link.create(
    amount=100000, currency="thb", title="Hot Latte", description="A warm cup of coffee"
)

client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.Link{}
err := client.Do(result, &operations.CreateLink{
	Amount:      99900,
	Currency:    "thb",
	Title:       "Hot Latte",
	Description: "A warm cup of coffee",
})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Link.create(
  amount:      10000,
  currency:    "thb",
  title:       "Hot Latte",
  description: "A warm cup of coffee"
)

Destroy a link

- DELETE https://api.omise.co/links/{id}

Destroys the link matching :id.

Example

Destroy a link

curl
python

curl https://api.omise.co/links/link_test_5g022xwp823yimkbzdl \
  -X DELETE \
  -u $OMISE_SECRET_KEY:

import omise

omise.api_secret = 'skey_test_4xsjvwfnvb2g0l81sjz'

link = omise.Link.retrieve('link_test_5dsoxxan7gxrqihu8rs')
link.destroy()
link.destroyed # => true

List links

- GET https://api.omise.co/links

Returns a list of links belonging to your account.

Request Parameters

Name	Type	Description
from	string	(optional, default: `1970-01-01T00:00:00Z`) Earliest UTC datetime for returned records in ISO 8601 format (`YYYY-MM-DDThh:mm:ssZ`).
limit	integer	(optional, default: `20`) Number of records returned.
offset	integer	(optional, default: `0`) Offset of the first record returned (i.e. how many records to skip from the beginning).
order	string	(optional, default: `chronological`, one of: `chronological`, `reverse_chronological`) Order of records returned.
to	string	(optional) Latest UTC datetime for returned records in ISO 8601 format (`YYYY-MM-DDThh:mm:ssZ`).

Example

curl https://api.omise.co/links \
  -u $OMISE_SECRET_KEY:

<?php

$links = OmiseLink::retrieve();

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

const link = await omise.links.list();
console.log(link);

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

links = Omise::Link.list

var links = await Client.Links.GetList(order: Ordering.ReverseChronological);
Console.WriteLine($"total links: {links.Total}");

ScopedList<Link> links = client.links().list();
System.out.printf("returned links: %d", links.getData().size());
System.out.printf("total no. of links: %d", links.getTotal());

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

links = omise.Link.retrieve()

client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.CardList{}
err := client.Do(result, &operations.ListLinks{})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Link.list

Retrieve a link

- GET https://api.omise.co/links/{id}

Returns the link matching :id.

Example

curl https://api.omise.co/links/link_test_5g022xwp823yimkbzdl \
  -u $OMISE_SECRET_KEY:

<?php

$link = OmiseLink::retrieve('link_test_55s7xparb9djkecqkd4');

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

const link = await omise.links.retrieve('link_test_no1t4tnemucod0e51mo');
console.log(link);

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

link = Omise::Link.retrieve("link_test_55s7xparb9djkecqkd4")

var link = await Client.Links.Get("link_test_56bkhnfd97h7eieu0hx");
Console.WriteLine($"link paid?: {link.Used} {link.Charges.FirstOrDefault()?.Id})");

Link link = client.links().get("link_test_55s7xparb9djkecqkd4");
System.out.printf("link was used?: %s", link.isUsed());

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

link = omise.Link.retrieve("link_test_no1t4tnemucod0e51mo")

client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.CardList{}
err := client.Do(result, &operations.RetrieveLink{
	LinkID: "link_test_no1t4tnemucod0e51mo",
})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Link.retrieve("link_test_55s7xparb9djkecqkd4")

Links API

Attributes

Example

JSON Response

Create a link

Request Parameters

Example

Create a multiple-use link

Create a single-use link

Destroy a link

Example

Destroy a link

List links

Request Parameters

Example

List all links

Retrieve a link

Example

Retrieve a link