สร้างลิงก์

POSThttps://api.omise.co/links

สร้างลิงก์การชำระเงินใหม่ด้วยพารามิเตอร์ที่ระบุ ลิงก์สามารถแชร์ได้ผ่านแพลตฟอร์มใดก็ได้และสามารถกำหนดค่าสำหรับการใช้งานครั้งเดียวหรือหลายครั้ง

---

🔑ข้อมูลยืนยันตัวตน API

▼

---

พารามิเตอร์คำขอ

Required - 4 fieldsพารามิเตอร์ที่จำเป็น

▼

`amount`INTEGER(required)

จำนวนเงินการชำระเงินในหน่วยสกุลเงินที่เล็กที่สุด (สตางค์สำหรับ THB, เซนต์สำหรับ USD) ใช้ 0 เพื่ออนุญาตให้ลูกค้าระบุจำนวนเงินได้

Example:100000

Constraints:ขั้นต่ำ: 0

`currency`STRING(required)

รหัสสกุลเงิน ISO 4217 สามตัวอักษรเป็นตัวพิมพ์เล็ก

Example:"thb"

Values:thb, jpy, sgd, myr, usd

`title`STRING(required)

ชื่อลิงก์ที่แสดงให้ลูกค้าเห็นบนหน้าการชำระเงิน

Example:"Invoice #12345 Payment"

`description`STRING(required)

รายละเอียดลิงก์และบริบทเพิ่มเติมที่แสดงให้ลูกค้าเห็น

Example:"Monthly subscription payment for January 2025"

Recommended - 1 fieldพารามิเตอร์ที่แนะนำ

▼

Additional - 1 fieldพารามิเตอร์เพิ่มเติม

▼

---

การตอบกลับ

200

สร้างสำเร็จ

สร้างลิงก์สำเร็จแล้ว ส่งคืนออบเจ็กต์ลิงก์ที่สมบูรณ์พร้อมด้วย payment_uri ที่สามารถแชร์ให้กับลูกค้าได้

ฟิลด์การตอบกลับหลัก:

• payment_uri - URL ที่แชร์ได้สำหรับลูกค้าในการชำระเงิน
• used - ระบุว่าลิงก์ใช้ครั้งเดียวถูกใช้แล้วหรือไม่
• multiple - ระบุว่าลิงก์อนุญาตให้ชำระเงินหลายครั้งหรือไม่
• charges - รายการของค่าธรรมเนียมที่ทำด้วยลิงก์นี้

400

คำขอไม่ถูกต้อง

การตรวจสอบคำขอล้มเหลว ตรวจสอบข้อความแสดงข้อผิดพลาดสำหรับรายละเอียด

สาเหตุทั่วไป:

• ฟิลด์ที่จำเป็นหายไป (amount, currency, title, description)
• รหัสสกุลเงินไม่ถูกต้อง
• จำนวนเงินไม่ถูกต้อง (ค่าติดลบ)
• รูปแบบข้อมูลไม่ถูกต้อง

401

ไม่ได้รับอนุญาต

การยืนยันตัวตนล้มเหลว API key ไม่ถูกต้องหรือหายไป

สาเหตุทั่วไป:

• ส่วนหัว Authorization หายไป
• secret key ไม่ถูกต้อง
• ใช้ public key แทน secret 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	คำอธิบาย	วิธีแก้ไข
bad_request	พารามิเตอร์หายไปหรือไม่ถูกต้อง	ตรวจสอบว่าฟิลด์ที่จำเป็นทั้งหมดถูกระบุแล้ว
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ของคุณถูกต้อง
invalid_amount	การตรวจสอบจำนวนเงินล้มเหลว	ตรวจสอบว่าจำนวนเงินเป็น 0 หรือจำนวนเต็มบวก
invalid_currency	สกุลเงินที่ไม่รองรับ	ใช้รหัสสกุลเงินที่รองรับ (thb, jpy, sgd, myr, usd)

ฟิลด์สถานะของลิงก์

Field	คำอธิบาย
used	สถานะการใช้งานลิงก์ครั้งเดียว (เป็น true ถ้าถูกใช้แล้ว)
multiple	ว่าลิงก์อนุญาตให้ใช้หลายครั้งหรือไม่
payment_uri	URL ที่แชร์ได้สำหรับการชำระเงินของลูกค้า

---

ลองใช้งาน

จำเป็น - 4 ฟิลด์

▼

amount(จำเป็น)

currency(จำเป็น)

title(จำเป็น)

description(จำเป็น)

แนะนำ - 1 ฟิลด์

▼

เพิ่มเติม - 1 ฟิลด์

▼