Links API (リンク型決済)

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

Attributes

Name Type Description
object string

固定値link

id string

/link(_test)?_[0-9a-z]+/に一致する LINK_ID

livemode boolean

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

location string

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

amount integer

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

charges list

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

created_at string

ISO 8601 形式 (YYYY-MM-DDThh:mm:ssZ)でリンクが作成されたUTC日時。

currency string

3文字で示される料金リクエストのクオート通貨ISO 4217コード。

deleted boolean

リンクが削除されたかどうか。

deleted_at string

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

description string

リンクの説明。

merchant_name string

決済リンクを作成したサブマーチャントの名前です。

注: このフィールドは、加盟店がプラットフォーム向けソリューションを導入している場合にのみ適用されます。プラットフォーム向けソリューションのご利用については、サポートまでお問い合わせください。

merchant_uid string

決済リンクを作成したサブマーチャントのIDです。

注: このフィールドは、加盟店がプラットフォーム向けソリューションを導入している場合にのみ適用されます。プラットフォーム向けソリューションのご利用については、サポートまでお問い合わせください。

multiple boolean

リンクを複数回使用できるかどうか。

payment_uri string

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

title string

Linkのタイトル。

used boolean

リンクが使用されたかどうか。

used_at string

ISO 8601形式(YYYY-MM-DDThh:mm:ssZ)でのリンク使用日時。

Example

  • JSON Response

Linkを作成

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

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

Request Parameters

Name Type Description
amount integer

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

currency string

(必須) 3文字で示される料金リクエストのクオート通貨ISO 4217コード。

description string

(必須) リンクの説明。

title string

(必須) Linkのタイトル。

multiple boolean

(任意, one of: true, false) リンクを複数回使用できるかどうか。

Example

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

  • 1回限りのLinkを作成

リンクを破棄する

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

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

Example

  • リンクを破棄する

全てのLinkの取得

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

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

Request Parameters

Name Type Description
from string

(任意, default: 1970-01-01T00:00:00Z) ISO 8601 形式(YYYY-MM-DDThh:mm:ssZ)で返されたレコードの最新のUTC日時。

limit integer

(任意, default: 20) 返されるレコードの数。

offset integer

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

order string

(任意, default: chronological, one of: chronological, reverse_chronological) listのオーダーがchronological (古い順) or reverse_chronological (新しい順)で返されます。エントリがない場合は nullとなります。

to string

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

Example

  • Linkを作成

Links を取得

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

Returns the link matching :id.

Example

  • Linksを取得

Omiseは、お客様のウェブサイト全般における利便性を向上するためにクッキーを利用し、お客様のアクセス、閲覧履歴に関する情報を収集します。 当社のウェブサイトを閲覧し続けることにより、お客様は当社のプライバシーポリシーに同意することとします。 詳細はこちら