パラメータ（基本動作）

ウィジェットの基本動作を制御するパラメータです。

定期課金、分割払い、デザインについては別途パラメータ解説ページがあり、左メニューから閲覧可能です。（デザイン用パラメータは、「ウィジェットの設置」ページに記載）

フィールド名について

• data-で始まる、ケバブケース（kebab-case）で記載のフィールド名はHTML用
• 2行目にローワーキャメルケース（lowerCamelCase）で記載のフィールド名はJavaScript用
• いずれかしか記載のないものは、いずれかのみで利用可能

フィールド 赤字は必須 ※は条件付き必須	許容する値	備考	省略時の値
data-app-id appId	半角英数	該当店舗のアプリケーションID 初期設定で作成したもの インラインフォームで利用可
data-checkout checkout	半角英	処理の内容 指定可能な値（意味）： token（トークンのみ作成し課金しない） payment（トークンを作成し課金する） ※括弧とその中の文字は値として不要 token,paymentはインラインフォームで利用可
data-payment-methods paymentMethods	半角英	フォームで選択できる支払い方法の詳細 カンマ区切りで複数指定可 指定可能な値（意味）： card（クレジットカード） konbini（コンビニ決済またはPay-easy） paidy（ペイディ） pay_pay_online（PayPayオンライン） we_chat_online（WeChatPayオンライン） alipay_online（Alipayオンライン） alipay_plus_online（Alipay+オンライン） bank_transfer（銀行振込） ※online指定で末尾に_onlineのつくものを一括指定 各決済手段が利用可能な設定なら、ブランドで更に絞込み可能。 下記パラメータを利用するなら、card, konbiniは指定不要。 クレジット： visa,mastercard,jcb american_express,diners_club unionpay,maestro,discover コンビニ： seven_eleven,family_mart,lawson mini_stop,seico_mart,pay_easy daily_yamazaki,yamazaki_daily_store
data-amount amount	半角数	課金額 回数無制限の定期課金の場合は初回の額 分割払いおよび回数制限付き定期課金の場合は合計額 日本円以外で実際に流通する補助通貨がある場合、最小の補助通貨の額で指定（例：USD9.00の時はcent基準の900） インラインフォームで利用可
data-currency currency	半角英	通貨 ISO 4217基準で記述 インラインフォームで利用可
data-token-type tokenType	半角英	作成するトランザクショントークンの種類 指定可能な値（意味）： one_time（一度だけ課金可） recurring（繰り返し課金可） subscription（定期課金） インラインフォームで利用可	one_time
data-product-codes productCodes	半角英数	管理画面で事前に設定した商品コード 未設定の値でエラー カンマ区切りで複数指定可 ※複数商品の利用方法や注意点はこちら amount等、商品に含む情報指定時はそちらを優先 ※商品に含まれない情報は他パラメータで併用する必要がある（以下例） ・初回0円の定期課金商品利用：data-cvv-authorize ・仮売上：data-capture インラインフォームで利用可
data-name name	半角英数	処理の完了時に、formのsubmit時やJavaScriptコールバック時に適用される「トークン」のフィールド名 ウェブフックやAPIからの結果取得時には適用されない 未指定時のフィールド名： トランザクショントークンのみ作成 univapayTokenId 定期課金作成 univapaySubscriptionId 課金作成 univapayChargeId	左欄参照
data-capture capture	真偽（true/false）	クレジットカードの処理時に「キャプチャ」を行うか falseを指定すると「オーソリ」を行う コンビニ決済／銀行振込の処理時には、値を不問でdata-capture-at,captureAtを有効にする インラインフォームで利用可	true
data-capture-at captureAt	半角英数 YYYYMMDD または YYMMDDThhmmss	クレジットでauth="true"なら、この指定日に自動的にキャプチャ実行（1h後〜7D以内） コンビニ決済／銀行振込の場合、支払い期限日時 注意： コンビニ決済で支払いの有効期限を「日時単位」で指定したい場合は、data-payment-methods/paymentMethodsを以下のみに限定 — family_mart,lawson,mini_stop daily_yamazaki,yamazaki_daily_store （セブン・イレブン、セイコーマート、Pay-Easyは時間指定無効のため除外） クレジット：日付のみ指定で指定日の9:00 コンビニ決済／銀行振込：指定日の24:00 当日で時間未指定はエラー インラインフォームで利用可	しない
data-expiration-period expirationPeriod	半角英数	フォームでの申込処理から支払い（振込）までの有効期限 ISO8601 duration text で記述 銀行振込／コンビニ決済で有効 指定可能な値（意味）： PxD（x日後） PxM（xか月後） インラインフォームで利用可	P30D
data-expiration-time-shift expirationTimeShift	半角数（記号は:,+） hh:mm:ss[+09:00]	銀行振込／コンビニ決済で有効な、フォームでの申込処理から支払い（振込）までの有効期限のうち、時間の部分 data-expiration-periodがP1D以上の指定が必要 「セブンイレブン」「セイコーマート/他支払（サークルK/サンクス/ペイジー）」は時刻指定が不可で、指定日の24:00まで受付 末尾に世界標準時間との誤差を入力（日本の場合は[+09:00]） インラインフォームで利用可
data-email email	半角英数	メールアドレス 送信した場合、入力済みの欄を表示 インラインフォームで利用可
data-address address	真偽（true/false）	配送先住所 trueで入力欄（郵便番号、都道府県、市区町村、丁目・番地、マンション名・部屋番号）を表示 インラインフォームで利用可	false
data-shipping-address-country-code shippingAddressCountryCode	ISO 3166-2に記載されている国コード	配送先住所の国 送信した場合、入力済みの欄を表示 送信しなければ空欄表示 data-address="true"、 address:trueなら動作 インラインフォームで利用可
data-shipping-address-zip shippingAddressZip	制限なし	配送先住所の郵便番号 送信した場合、入力済みの欄を表示 送信しなければ空欄表示 data-address="true"、 address:trueなら動作 インラインフォームで利用可
data-shipping-address-state shippingAddressState	制限なし	配送先住所の都道府県 送信した場合、入力済みの欄を表示 送信しなければ空欄表示 data-address="true"、 address:trueなら動作 インラインフォームで利用可
data-shipping-address-city shippingAddressCity	制限なし	配送先住所の市区町村 送信した場合、入力済みの欄を表示 送信しなければ空欄表示 data-address="true"、 address:trueなら動作 インラインフォームで利用可
data-shipping-address-line1 shippingAddressLine1	制限なし	配送先住所の丁目・号・番地 送信した場合、入力済みの欄を表示 送信しなければ空欄表示 data-address="true"、 address:trueなら動作 インラインフォームで利用可
data-shipping-address-line2 shippingAddressLine2	制限なし	配送先住所のマンション名・部屋番号 送信した場合、入力済みの欄を表示 送信しなければ空欄表示 data-address="true"、 address:trueなら動作 インラインフォームで利用可
data-require-name requireName	真偽（true/false）	true指定で、氏名の入力欄を表示（入力必須） Paidy、コンビニ決済、銀行振込では既存のため無効	false
data-require-email requireEmail	真偽（true/false）	true指定で、メールアドレスの入力欄を表示（入力必須） クレジットカード、コンビニ決済では既存のため無効	false
data-require-phone-number requirePhoneNumber	真偽（true/false）	true指定で、電話番号の入力欄を表示（入力必須） インラインフォームで利用可	false
data-phone-number phoneNumber	半角数（ハイフンなし）	電話番号 送信した場合、入力済みの欄を表示 ※電話番号を必須にしている場合のみ
data-require-billing-address requireBillingAddress	真偽（true/false）	true指定で、請求先住所の入力欄を表示（入力必須）	false
data-cvv-authorize cvvAuthorize	真偽（true/false）	true指定で、セキュリティコード認証の実行 クレジット決済のみ有効 カード情報の登録のみ：data-checkout="token"、data-token-type="recurring" を指定 初回0円の定期課金を作成：data-checkout="payment"、data-token-type="subscription"（または"recurring" ） を指定 なおセキュリティコードは本サービスで保存していません インラインフォームで利用可	false
data-show-cvv showCvv	真偽（true/false）	false指定でセキュリティコード認証欄を非表示化 クレジット決済のみ、かつ審査時にセキュリティコード認証を「必須」と指定されていない場合のみ有効 インラインフォームで利用可	true
data-locale locale	半角英	表示される言語 auto（ブラウザ依存）,en-us（米国英語）,ja-jp（日本語）,zh-tw（台湾繁体字）,zh-cn（中国簡体字）,en（英国英語）,ja（日本語）,zh（中国語簡体字）,ko（韓国語）,th（タイ語）,ru（ロシア語） インラインフォームで利用可
data-univapay-reference-id univapayReferenceId	半角英数	リファレンスID CSV課金時の検索キー data-token-type="recurrring"なら有効 インラインフォームで利用可
data-univapay-customer-id univapayCustomerId	半角英数 （UUID）	UUID形式で定義したカスタマーID クレジットカード決済でのみ有効 このフィールドを初回の決済時に設定しておくと、リカーリングトークンの作成を消費者に任意選択させるチェックボックスを表示 用途： 次回以降、カスタマーIDをパラメータに持つタグ（コード）でウィジェットを表示した場合、過去に同加盟店で利用したクレジットカード情報を選択して決済することが可能 token type="one_time" を指定するか、指定を省略した場合で、チェックがなければone_timeトークンを、チェックされればrecurringトークンを、それぞれ作成 token type="recurring" 指定でチェック必須 インラインフォームで利用可
data-auto-submit autoSubmit	真偽（true/false）	true指定で、完了ボタンを押下しフォームを閉じた時にformで指定したURLページに自動で消費者を遷移させるのと同時に、HTTP GETメソッドで以下を送信 トランザクショントークン（data-checkout-type=“token”指定時には univapayTokenId） 決済番号（data-checkout-type=“payment” 指定時には univapayChargeId 、data-token-type=“subscription” 指定時には univapaySubscriptionId）	false
data-auto-close autoClose	真偽（true/false）	true指定で、処理の完了後にウィジェットが自動的に閉じる	false
data-remove-checkout-button-after-charge removeCheckoutButtonAfterCharge	真偽（true/false）	true指定で、処理の完了後もウィジェットの起動ボタン表示を維持 false指定で消去	true
data-usage-limit usageLimit	半角英	作成したrecurrringタイプのトークンに対する課金の制限期間 期間中に1度だけの課金が許容される 変更不可（新しいトークン作成が必要） 指定可能な値： daily, weekly, monthly, annually インラインフォームで利用可
data-show-logo showLogo	真偽（true/false）	ウィジェットに店舗のロゴを表示するかどうか ※幅が5px以下の場合にロゴは非表示	true
data-timeout timeout	半角数	指定した秒数が経過するとウィジェットを閉じてタイムアウトのエラー画面を表示
data-auto-close-on-error autoCloseOnError	真偽（true/false）	data-timeoutを指定した場合 タイムアウトのエラー画面を表示してから約3秒後にその画面を自動で閉じる
data-hide-recurring-checkbox hideRecurringCheckbox	真偽（true/false）	data-token-typeをrecurringに指定した場合のウィジェットに「個人情報の同意」のチェックボックスを表示するかどうか 指定可能な値（意味）： true（非表示にする） false（表示する） インラインフォームで利用可	false
data-hide-privacy-link hidePrivacyLink	真偽（true/false）	ウィジェットに表示される「個人情報の取り扱いについて」のリンクを表示するかどうか 指定可能な値（意味）： true（非表示にする） false（表示する） インラインフォームで利用可	false
data-custom-field-hoo customFieldHoo	半角英	hoo部分の指定次第で、追加の入力欄を表示 指定可能な値（意味）： labels（入力欄のラベル） types（select/stringで選択肢／入力欄） required（true/falseで必須／任意） options（typeがselectなら必須、;区切りで選択肢） keys （メタデータのキー）
data-metadata metadata	半角英	消費者やオーダーを個別に識別する場合などに使える「メタデータ」 既存フィールドと重複しないよう注意 フィールド名はケバブケースで記述 例：data-metadata=”foo-bar:"baz" と指定した場合、追加されるメタデータは{“foo-bar”:"baz"} 1つのフィールドに対して複数の値を指定したい場合は「\,」で、複数のフィールドに同じ値を指定したい場合には「,」区切りで記述
data-hoo	半角英	任意の用途で利用できる、任意のフィールド 既存フィールドと重複しないよう注意 フィールド名はローワーキャメルケースで記述 例：data-hoo-bar=”baz" と指定した場合、追加される任意データは{“hooBar”:"baz"} ※JavaScriptでは利用不可