リンクフォーム – 概要
このページは「初期設定」が完了していることを前提に作成しています。
リンクフォームは、APIに対してHTTP GETメソッドで決済の詳細を送信することで、決済フォームのリソースを生成し、そこ消費者を遷移させ、決済後にリダイレクトすることができます。
加盟店さまの多くは、管理画面から店舗内にリンクフォームの設定をし、短縮URLをメール送信するか、サイト内に<a>タグとして設置する運用をすると想定しています。
そのため、原則的に不要と認識していますが、ここでは、APIの挙動を解説します。
プログラムの記述ができる方にとっては、リンクフォームを選択して動的にタグを書き出すことは、タグが長くなるだけで何のメリットもありません。
動的にタグ出力をするのであれば、メリットの多いウィジェットを採用することを強く推奨します。
リンクフォームは、技術や予算の都合上、動的なタグ出力を行えない方を対象する機能とご認識ください。
リンクフォームの役割
リンクフォームは、以下の役割を果たします。
支払い方法の選択
消費者に、希望の支払い方法をクリック（またはタップ）で選択させます。
この選択画面で表示される選択肢は、リンクフォームのタグの記述内容に依存します。なお、支払い方法を単一に指定した場合、この選択画面は省略されます。
必須情報の入力
選択された「支払い方法」毎に予め設定されいる必須情報を、消費者に入力させます。
入力欄はタグの記述内容によって、追加することも可能です。
詳しくはこちら
APIのURL
https://checkout.univapay.com/forms/<各店舗のフォームID>各店舗のフォームIDは、管理画面の店舗＞店舗名をクリック＞決済フォームタブ＞リンクフォーム設定＞URLコード
から確認してください。forms/から?appIDの間に記載されています。
例）https://checkout.univapay.com/forms/0a000ebb-caa0-00bf-ad0e-0de0e000fbe0?appId=xxx…
各種パラメータを?hoo=111&bar=222&baz=333…のように続けて記述したものを表示し、消費者の遷移を促してください。
タグのジェネレータ
管理画面の店舗＞店舗名をクリック＞決済フォームタブ＞リンクフォーム設定＞URLコード
で、各種設定を反映した、タグの生成が可能です。
管理画面から行える設定
管理画面の店舗＞店舗名をクリック＞決済フォームタブ＞リンクフォーム設定＞設定
で、リンクフォームの各種設定が可能です。
以下は、事前に管理画面から動作を設定できる内容です。
決済方法（ON／OFF）
以下は、タグで値を指定すれば、そちらを優先し、元の設定を無視します。
- クレジットカード
- コンビニ
- 銀行振込
- 他、オンラインモバイルの各銘柄
お客様情報（ON／OFF）
以下は、タグ設置時にの指定に関わらず、設定が優先されます。
- 名前を必須にする
- カナを必須にする
- メールアドレスを必須にする
- 電話番号を必須にする
- 住所を必須にする
言語（ドロップダウンメニュー）
言語は、タグで値を指定すれば、そちらを優先し、元の設定を無視します。
カスタムの入力欄
カスタムの入力欄は、タグで何かしらの値を指定すれば、そちらを優先し、元の設定を無視します。
リダイレクトURL
リダイレクトURLは、タグで何かしらの値を指定すれば、そちらを優先し、元の設定を無視します。
以下の処理ステータス毎に、別のURLを指定できます。
- 成功
- 処理待ち
- 失敗
テーマ
テーマの設定は、タグでの指定で変更することはできません。全てのフォームで統一されます。
- タイトル（ON／OFF）
- 店舗名の表示
- ロゴの表示
- テーマ（ラジオボタン）
- ライト
- ダーク
- カスタマイズ（カラーコード）
- ヘッダー
- ボタン
- 背景
- 内容の背景（カラム内側の色）
完了後の処理
処理の完了後は、パラメータによる指定通りに、消費者をリダイレクトします。
ウィジェットのようにリダイレクト時に結果をHTTP GETやSubmitで送信したり、JavaScriptのコールバックはできません。
一方で成功時と失敗時、それぞれのリダイレクト先は指定でき、追加したメタデータをHTTP GETメソッドで送信（消費者の遷移と同時に）できます。
したがって、処理後の画面遷移を制御することは可能ではありますが、送信先のURLは消費者からも可視であるため、処理結果の判定や、サービスを受ける権利の付与は行わない事を推奨します。
また、誤ってサービスを履行したり、物品を発送した場合でも、当社では一切の責任を負いかねます。
結果判定には、消費者から不可視の「GETによる取得」か、「ウェブフック」を用いることを推奨します。
消費者の支払いフロー
リンクフォームを利用した場合の決済手段ごとの支払いフローは、下記の画像付き資料を参照してください。
