Links API

Links API สามารถใช้เพื่อสร้างและเรียกข้อมูลรับชำระเงินในรายการที่เป็นการส่งผ่านลิงก์ ลิงก์ที่ระบบสร้างขึ้นสามารถแชร์ให้กับผู้ซื้อได้ผ่านหลากหลายช่องทาง และยังสามารถกำหนดให้เป็นลิงก์แบบใช้งานได้เพียงครั้งเดียวหรือแบบที่สามารถใช้งานได้ไม่จำกัดจำนวนครั้ง

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
created_at 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.

deleted_at string

UTC datetime of the deletion of the link in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

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.

used_at string

UTC datetime of the usage of the link in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). Single-use links only.

Example

  • JSON Response

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

  • Create a multiple-use link

  • Create a single-use link

Destroy a link

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

Destroys the link matching :id.

Example

  • Destroy a link

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

  • List all links

Retrieve a link

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

Returns the link matching :id.

Example

  • Retrieve a link

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