リンクフォームのURLを直接呼び出す
サイドバーメニューの「店舗」から決済フォームを作成したい店舗にアクセスし、メニュー内の「決済フォーム」「リンクフォーム設定」をクリックします。ECリンクフォーム設定ページの「URLコード」をクリックすると、URL生成ツールにアクセスできます。
設定例：
まず、「金額」に任意の金額を設定します。
例えば、金額を500に設定すると、このパラメータが自動的にURLに追加されます。
その後、生成されたURLをそのまま利用することもできますが、状況に応じてパラメータを数値に置き換えて動的に編集することも可能です。
例えば、先の金額の入力に「500」と入力すると、URLでは次のように表示されます。
&amount=500WebサイトからこのURLを呼び出し、500を別の金額に置き換えることで、新しい金額でフォームが表示されます。
※ご注意点
作成されたURLをそのまま利用すると、金額を書き換えてアクセスすることが可能になる為、ご注意ください。
ご利用の際は違うURLへ遷移させた後、リダイレクトさせるなどユーザーがそのままURLを取得できない方法をご利用ください。
決済完了後の処理
決済完了後、トランザクションのIDは送信時にフォームに追加されます。
トークン登録のみの場合は univapayTokenId 、都度課金の場合には追加で univapayChargeId 、定期課金の場合にはさらに univapaySubscriptionIdもそれぞれinput要素として追加されます。autoRedirectを指定することで、決済完了後には指定したURLに自動で遷移します。
&autoRedirect=true利用可能パラメータ
URLの末尾に&amount=500のようにパラメータを指定することでリンクフォームをカスタマイズすることができます。
下記が利用可能パラメータの一覧です。
| Parameters | |
| currency | string (currency code) 課金金額の通貨を指定します。 必須: いいえ 指定可能な値: 通貨コード |
| amount | number このパラメータでは、ワンタイム課金の場合に課金金額を指定します。定期課金の場合は、１回の支払いで課金する金額を指定します。 分割払いの定期課金の場合は、すべての支払の合計金額を指定します。 補助通貨を使用する通貨の場合、補助通貨を含んだ金額を指定するよう注意してください。 例：9.50 USD の場合は 950 と表記します。 必須：はい(金額を指定しない場合はtokenOnlyを指定する必要があります) 指定可能な値: 正の整数 |
| planAmount | number このパラメータでは、分割払い / 回数指定定期課金で定期課金の合計金額を指定します。 補助通貨を使用する通貨の場合、補助通貨を含んだ金額を指定するよう注意してください。 例：9.50 USD の場合は 950 と表記します。 必須：いいえ 指定可能な値：正の整数 |
| type | string このパラメータでは、作成するトランザクショントークンの種類を指定します、デフォルトは one_time。 必須: いいえ (デフォルト値は one_time) 指定可能な値: one_time, recurring, subscription |
| tokenOnly | boolean amountを指定しない場合、このパラメータをtrueに指定することでカード登録のみのリンクフォームを作成します。 CVV認証が必須の加盟店はcvvAuthorizeも併せて指定する必要があります。 必須: いいえ (デフォルトはfalse) 指定可能な値: true |
| cvvAuthorize | boolean このパラメータでtrue を指定した場合、 認証リクエストを行います。認証リクエストが失敗した場合は、トークンは作成されません。 tokenOnly=true かつ tokenType=recurring である場合のみ有効です。 必須: いいえ (デフォルト値は false ) 指定可能な値: true |
| paymentMethods[] | string 決済フォームで利用できる決済手段を1つのみ選択します。 ※複数表示させる場合はPaymentMethodsで指定してください。値はカンマで区切ります。 必須：いいえ 指定可能な値: card, konbini, paidy, online, pay_pay_online, we_chat_online, alipay_online, alipay_plus_online, bank_transfer ※各決済手段が利用可能な設定の場合、ブランドで更にフィルタリングすることができます。 下記パラメータを利用する場合、card, konbiniは指定不要です。 クレジット： visa,mastercard,maestro,diners_club,discover,jcb,unionpay,american_express コンビニ：seven_eleven,family_mart,lawson,mini_stop,seico_mart,pay_easy,circle_k,sunkus,daily_yamazaki,yamazaki_daily_store |
| appId | string (TOKEN) このパラメータでは、支払いを行うストアで発行したアプリケーショントークンを指定します。 必須: はい 指定可能な値: 有効なアプリケーショントークン |
| hideCvv | boolean CVVなしを許可されているストアで、このパラメータを true に設定すると、リンクフォームでCVV 入力欄が表示されなくなります。 必須: いいえ (デフォルトは false) 指定可能な値: true |
| auth | boolean 課金が作成される場合、このパラメータを true に指定することで、キャプチャを行わずオーソリのみを行うようにします。 その際、課金は手動でキャプチャするか、captureAt パラメータを指定することで自動的にキャプチャすることができます。 必須: いいえ (デフォルトは false) 指定可能な値: true |
| captureAt | string auth パラメータを true を指定したうえでこのパラメータを設定した場合、ここで指定した日時に課金が自動的にキャプチャされます。 クレジット:キャプチャの日時は仮売上から1時間後かつ7日以内である必要があります。 ※「セブンイレブン」「セイコーマート/他支払（サークルK/サンクス/ペイジー）」は時刻指定が利用できないため、時刻は無視されその日までという扱いになります。 ※コンビニ，銀行振込の期限日時指定は、サポートを終了しました。 今後は、 expirationPeriod / expirationTimeShift / bankTransferExpirationPeriod / bankTransferExpirationTimeShift / convenienceStoreExpirationPeriod / convenienceStoreExpirationTimeShiftをご利用ください。必須: いいえ 指定可能な値: ISO8601 形式の日時 |
| allowCardInstallments | boolean このパラメータでtrue を指定した場合、分割払いのプルダウンセレクトを表示します。 amountが指定されている かつ token type がone_timeか recurring である場合のみ有効です。 カード会社の分割払いが可能な接続先である場合のみ有効です。 必須: いいえ (デフォルト値は false ) 指定可能な値: true |
| period | string 定期課金の課金の間隔を指定します。 必須: いいえ(トークンタイプが subscription の場合、デフォルトはmonthly) 指定可能な値: daily（毎日）, weekly（毎週）, biweekly（隔週）, monthly（毎月）, bimonthly（隔月）, quarterly（3ヶ月）, semiannually（6ヶ月）, annually（毎年）, ISO8601 duration text の間隔… P●D(〇日毎),P●W(〇週間毎),P●M(〇か月毎),P●Y(〇年毎) |
| initialAmount | number 分割払いプランではない定期課金の場合、初回の支払いの金額を指定します。 必須: いいえ 指定可能な値: 正の整数 |
| startIn | string 定期課金の2回目の課金が行われるまでの期間。（初回課金は定期課金の作成時に行われます。） 必須: いいえ 指定可能な値: ISO8601 duration text。 例：P●D、P●M（P1D、P5D、P0M、P1M） |
| startDayOfMonth | number 定期課金の2回目の課金が行われる日付。（初回課金は定期課金の作成時に行われます。） subscriptionStartInと組み合わせることも可能です。 （例： subscriptionStartDayOfMonth: 20 subscriptionStartIn: “P1M” と設定した場合、2回目の課金は翌月の20日に行われます。） subscriptionStartInが設定されていない場合、当月（その日付が過ぎていれば翌月）の設定した日付（もしくは末日）に定期課金が開始されます。 （例：2022/10/13にこのパラメータで5を設定した場合、2022/11/5に定期課金が開始されます。）subscriptionStartが設定されていない場合のみ動作します。 必須: いいえ 指定可能な値:1から31までの整数 |
| terminationMode | string 定期課金の停止リクエストを送信した場合に、停止するタイミングを指定します。 immediateを指定すると即時に停止し、on_next_paymentを指定すると次回の支払直前に停止します。 必須：いいえ(デフォルトはimmediate) 指定可能な値: immediate もしくは on_next_payment |
| subscriptionId | string 定期課金の作成ではなく、指定された定期課金に適用可能なトランザクショントークンを作成します。 必須：いいえ 指定可能な値: アプリケーショントークンに紐付いたストアに作成されている定期課金のID |
| successRedirectUrl | string 決済成功時のリダイレクトURL 必須：いいえ 指定可能な値: 任意のURL |
| failureRedirectUrl | string 決済失敗時のリダイレクトURL 必須：いいえ 指定可能な値: 任意のURL |
| pendingRedirectUrl | string 決済処理待ち時のリダイレクトURLがタイムアウトするなどで正常に結果を判断できなかった場合、このURLにリダイレクトします。 必須：いいえ 指定可能な値: 任意のURL |
| autoRedirect | boolean このパラメータをtrueに指定すると、決済処理完了後、ユーザーが完了ボタンなどで操作しなくても自動でリダイレクトします。 必須: いいえ (デフォルト値は false ) 指定可能な値: true |
| productCodes | string 商品コードの指定を行い、商品に紐づいた情報を基に決済を行います。 このパラメータを指定する場合は、app-id,checkoutを指定する必要があります。 仮売上を行いたい場合はcaptureを併用して指定してください。 ※商品に含まれる情報をパラメータで別途指定すると商品の情報より優先されますのでご注意ください。 商品に含まれない情報であればその他パラメータで併用可能です。 ※初回0円の定期課金を作成する際はcvv-authorizeの指定が必要です。 複数の商品を同時に指定する場合は「,」(カンマ)で区切ってください。 ※商品タイプの組み合わせは、通常課金と通常課金、もしくは通常課金と定期課金のみ対応しています。複数の定期課金商品を同時に指定することはできません。 必須:いいえ 指定可能な値:事前に作成した商品の商品コード |
| name | string このパラメータに名前を指定すると、決済フォームを開いたときに名前のフィールドに初期値として入力されます。 必須：いいえ |
| emailAddress | string このパラメータにメールアドレスを指定すると、決済フォームを開いたときにメールアドレスのフィールドに初期値として入力されます。 必須：いいえ |
| hidePrefilledEmail | boolean このパラメータをtrueに指定すると、決済フォームのメールアドレス入力欄を非表示にします。 ※emailAddressでメールアドレスが指定されている必要があります 必須：いいえ |
| phoneNumber | string このパラメータに電話番号を指定すると、決済フォームを開いたときに電話番号のフィールドに初期値として入力されます。 必須：いいえ |
| successRedirectUrl | string 決済成功時のリダイレクトURL 必須：いいえ |
| failureRedirectUrl | string 決済失敗時のリダイレクトURL 必須：いいえ |
| pendingRedirectUrl | string 決済処理待ち時のリダイレクトURLタイムアウトするなどで正常に結果を判断できなかった場合、このURLにリダイレクトします。 必須：いいえ |
| autoRedirect | boolean このパラメータをtrueに指定すると、決済処理完了後、ユーザーが完了ボタンなどで操作しなくても自動でリダイレクトします。 必須: いいえ (デフォルト値は false ) 指定可能な値: true |
| showRedirectMetadata | boolean このパラメータをtrueに指定すると、付与されたメタデータを、リダイレクト先のURLに表示します。 必須：いいえ(デフォルトはfalse) 指定可能な値：true |
| expirationPeriod | string このパラメータで期間を指定すると、決済が行われてから振込をするまでの期間を設定できます。 銀行振込/コンビニ決済で有効です。 必須: いいえ(デフォルトは銀行振込：1週間、コンビニ決済：30日) 指定可能な値: ISO8601 duration text。 例：P●D、P●M（P1D、P5D、P0M、P1M） |
| expirationTimeShift | string このパラメータで時間を指定すると、振込期限の時間を設定できます。 銀行振込/コンビニ決済で有効です。 ※このパラメータで時間を指定する場合、expirationPeriodは1日以上を指定してください。 ※「セブンイレブン」「セイコーマート/他支払（サークルK/サンクス/ペイジー）」は時刻指定が利用できないため、本パラメータは無視されます。 必須: いいえ(デフォルトは銀行振込：23:59:59、コンビニ決済：決済が行われた時間) 指定可能な値: URLエンコードした値またはISO8601（例：12:00:00+09:00） |
| bankTransferExpirationPeriod | string このパラメータで時間を指定すると、銀行振込の振込期限（日にち）を設定できます。 必須: いいえ(デフォルトは1週間) 指定可能な値: ISO8601 duration text 例：P●D、P●M（P1D、P5D、P0M、P1M） |
| bankTransferExpirationTimeShift | string このパラメータで時間を指定すると、銀行振込の振込期限（時間）を設定できます。 ※このパラメータで時間を指定する場合、expirationPeriodは1日以上を指定してください。 ※「セブンイレブン」「セイコーマート/他支払（サークルK/サンクス/ペイジー）」は時刻指定が利用できないため、本パラメータは無視されます。 必須: いいえ(デフォルトは23:59:59) 指定可能な値: URLエンコードした値またはISO8601（例：12:00:00+09:00） |
| convenienceStoreExpirationPeriod | string このパラメータで時間を指定すると、コンビニのお支払い期限（日にち）を設定できます。 必須: いいえ(デフォルトは30日) 指定可能な値: ISO8601 duration text 例：P●D、P●M（P1D、P5D、P0M、P1M） |
| convenienceStoreExpirationTimeShift | string このパラメータで時間を指定すると、コンビニのお支払い期限（時間）を設定できます。 ※このパラメータで時間を指定する場合、expirationPeriodは1日以上を指定してください。 ※「セブンイレブン」「セイコーマート/他支払（サークルK/サンクス/ペイジー）」は時刻指定が利用できないため、本パラメータは無視されます。 必須: いいえ(デフォルトは決済が行われた時間) 指定可能な値: URLエンコードした値またはISO8601（例：12:00:00+09:00） |
| customFieldKeys[] | string メタデータのキーを指定します。指定した順でタイトルがそれぞれ対応します。 必須: いいえ |
| customFieldLabels[] | string 表示させる入力欄/選択肢のタイトルを指定できます。 必須: いいえ |
| customFieldTypes[] | string そのカスタムフィールドが選択肢か入力欄かを指定します。 必須: いいえ 指定可能な値：selectもしくはstring |
| customFieldRequired[] | boolean そのカスタムフィールドが必須かどうかを指定します。 必須: いいえ(デフォルトはfalse) 指定可能な値：true,false |
| customFieldOptions[] | string カスタムフィールドが選択肢の場合、 “;”で区切ることで選択肢の内容を指定します。 “,”で区切ることで次の選択肢の内容を指定します。 必須: いいえ |