Links API (リンク型決済)

Links (リンク)APIを使用すると、決済リクエストのウェブサイトリンクを 作成および取得できます。 生成されたリンクはどのプラットフォームでも共 有でき、1回のみ、また複数回使用するように設定できます。

Attribute

Name Type Description
object string

link と返ることで、このJSONレスポンスがLinksの内容に関連することを示す。

id object_id

Link のID。

livemode boolean

本番モード (true) あるいはテストモード(false) link。

location string

現在のlinkオブジェクトを取得するためのAPIパス。

amount integer

指定された通貨において最小単位、かつ正の整数で表される金額。(例:100サターンは1タイバーツ) サポート通過コード一覧

charges list

チャージオブジェクトのリスト。

created datetime

ISO 8601 形式(YYYY-MM-DDThh:mm:ssZ)でlink作成の協定世界時(UTC)。

currency string

小文字3桁の国際識別コードで、ISO 4217規格 によって定義された通貨(サポート通貨コード一覧)。

deleted boolean

linkが削除されたかどうか。

description string

解読可能なlinkの説明。

multiple boolean

true(複数回利用できるLink)false(一度だけ利用できるLink)。

payment_uri string

顧客がカード詳細を入力するための決済ページのURL。

title string

Linkのタイトル。

used boolean

true(使用済みのLinks)、false(利用可能なLinks)。

Example

  • Json Response

全てのLinkの取得

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

linkに属するすべての お客様のアカウントオブジェクトの list を返します。

Request Parameter

Name Type Description
offset integer

(optional、default:0) 返される最初のレコードのオフセット(先頭からスキップするレコードの数)。

limit integer

(optional, default: 20, maximum: 100) 返されたレコード数。

from datetime

(optional, default: 1970-01-01T00:00:00Z) ISO 8601 形式の返されたレコードの最初のUTC日付と時刻(YYYY-MM-DDThh:mm:ssZ)。

to datetime

(optional, default: current UTC datetime) ISO 8601 形式で返されたレコードの最新のUTC日付と時刻(YYYY-MM-DDThh:mm:ssZ)。

order string

(optional, default: chronological) chronological(最初のものから最新のもの)または reverse_chronological (最新のものから最初のもの)のリストのオーダーが返されます。

Example

  • Linkを作成

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

Returns a list of all charge objects belonging to a link.

Request Parameter

Name Type Description
offset integer

(optional、default:0) 返される最初のレコードのオフセット(先頭からスキップするレコードの数)。

limit integer

(optional, default: 20, maximum: 100) 返されたレコード数。

from datetime

(optional, default: 1970-01-01T00:00:00Z) ISO 8601 形式の返されたレコードの最初のUTC日付と時刻(YYYY-MM-DDThh:mm:ssZ)。

to datetime

(optional, default: current UTC datetime) ISO 8601 形式で返されたレコードの最新のUTC日付と時刻(YYYY-MM-DDThh:mm:ssZ)。

order string

(optional, default: chronological) chronological(最初のものから最新のもの)または reverse_chronological (最新のものから最初のもの)のリストのオーダーが返されます。

Example

  • List all charges for a link

Linkを作成

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

新しいLinkオブジェクトを返します。

Request Parameter

Name Type Description
amount integer

(必須)0以上の符号なし整数を金額として指定、通貨ごとのamountの最小・最大値

currency string

(必須) 3桁のISO通貨コード、サポート通貨コード一覧

title string

(必須) Linkのタイトル。

description string

(必須) Linkについての説明。

multiple boolean

(任意) Linkを複数回に利用するかどうか指定します。 複数回利用しない場合、falseとして設定します。

Example

  • 1回限りのLinkを作成

  • 複数回利用できるLinkを作成

Links を取得

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

Example

  • Linksを取得

リンクを破棄する

- DELETE https://api.omise.co/links/LINK_ID

LINK_IDに適応するリンクを破棄もしくは無効化します。

Example

  • リンクを破棄する