パラメータ（基本動作）
| フィールド 赤字は必須 ※は条件付き必須 | 許容する値 | 備考 | 省略時の値 |
|---|---|---|---|
| appId | 半角英数 | 該当店舗のアプリケーションID 初期設定で作成したもの | |
| checkout ※ | 半角英 | 処理の内容 指定可能な値（意味）： token（トークンのみ作成し課金しない）payment（トークンを作成し課金する）qr（トークンのみ作成しQR表示）※… productCodes送信時に必須 | payment |
| paymentMethods | 半角英 | フォームで選択できる支払い方法 カンマ区切りで複数指定可 単数のみ指定の場合はフィールド名末尾に []の追加が必須指定可能な値（意味）： card（クレジットカード）konbini（コンビニ決済またはPay-easy）paidy（Paidy）bank_transfer（銀行振込）pay_pay_online（PayPayオンライン）we_chat_online（WeChatPayオンライン）alipay_online（Alipayオンライン）alipay_plus_online（Alipay+オンライン）d_barai_online（ｄ払いオンライン）online（オンラインモバイル全て）各決済手段が利用可能な設定なら、ブランドで更に絞込み可能。 下記パラメータを利用するなら、 card, konbiniは指定不要。クレジット： visa,mastercard,jcbamerican_express,diners_clubunionpay,maestro,discoverコンビニ： seven_eleven,family_mart,lawsonmini_stop,seico_mart,pay_easydaily_yamazaki,yamazaki_daily_store | |
| amount ※ | 半角数 | 課金額 課金額 回数無制限の定期課金の場合は初回の額 分割払いおよび回数制限付き定期課金の場合は合計額 ※… tokenOnly=trueなら省略可日本円以外で実際に流通する補助通貨がある場合、最小の補助通貨の額を指定（USD9.00の時はcent基準の 900） | |
| currency | 半角英 | 通貨 ISO 4217基準で記述 | jpy |
| type | 半角英 | 作成するトランザクショントークンの種類 指定可能な値（意味）： one_time（一度だけ課金可）recurring（繰り返し課金可）subscription（定期課金） | one_time |
| tokenOnly | 真偽（true/false） | トークン化のみで課金しないtrueならamountを無視 | false |
| productCodes | 半角英数 | 管理画面で事前に設定した商品コード 未設定の値でエラー カンマ区切りで複数指定可 ※複数商品の利用方法や注意点はこちら amount等、商品に含む情報指定時はそちらを優先※商品に含まれない情報は他パラメータで併用する必要がある ・初回0円の定期課金商品利用： data-cvv-authorize・仮売上： data-capture | |
| productQuantities | 半角数 | 商品の数productCodesを指定した場合に指定※管理画面で productCodesを指定すると自動でURLに付与されるカンマ区切りで商品コードを複数指定している場合、商品の数もカンマ区切りで指定 例：） productQuantities=1,2 | |
| auth | 真偽（true/false） | オーソリ クレジット決済でのみ有効 与信枠の確保のみ行うなら利用 （別途、売上処理かキャンセル処理が必要） | false |
| captureAt | 半角英数 YYYY-MM-DD Thh:mm:ss.ssssZ | クレジットでauth="true"なら、この指定日に自動的にキャプチャ実行（1h後〜7D以内） | |
| expirationPeriod | 半角英数 | フォームでの申込処理から支払い（振込）までの有効期限 銀行振込／コンビニ決済で有効 指定可能な値（意味）： PxD（x日後）PxM（xヶ月後） | P30D |
| expirationTimeShift | 半角数（記号は:,+）hh:mm:ss+09:00URLエンコードも可 | 銀行振込／コンビニ決済で有効な、フォームでの申込処理から支払い（振込）までの有効期限のうち、時間の部分data-expiration-periodがP1D以上の指定が必要「セブンイレブン」「セイコーマート/他支払（サークルK/サンクス/ペイジー）」は時刻指定が不可で、指定日の24:00まで受付 末尾に世界標準時間との誤差を入力（日本の場合は +09:00） | |
| name | テキスト（制限なし） | 名前 送信した場合、入力済みの欄を表示 ※リンクフォーム設定で名前を必須にしている場合のみ | |
| nameKana | テキスト（制限なし） | 名前のカナ 送信した場合、入力済みの欄を表示 ※リンクフォーム設定でカナを必須にしている場合のみ | |
| cardholder | 半角英 | カード名義 送信した場合、入力済みの欄を表示 | |
| emailAddress ※ | 半角英数（メールアドレスとして有効な記号を含む） | メールアドレス 送信した場合、入力済みの欄を表示 ※… hidePrefilledEmail=trueなら必須 | |
| hidePrefilledEmail | 真偽（true/false） | フォームの「メールアドレス」欄を非表示 | false |
| phoneNumber | 半角数（ハイフンなし） | 電話番号（15桁以下） 送信した場合、入力済みの欄を表示 ※3-Dセキュア認証を利用する場合 または リンクフォーム設定で電話番号を必須にしている場合のみ | |
| phoneNumberCountryCode | 半角数 | 電話番号の国コード 送信した場合、入力済みの国コードを表示 ※3-Dセキュア認証を利用する場合 または リンクフォーム設定で電話番号を必須にしている場合のみ | |
| requirePhoneNumber | 半真偽（true/false） | true指定で電話番号の入力欄を表示（入力必須）※クレジットで3-Dセキュア認証を利用する場合、デフォルトはtrue | false※ |
| cvvAuthorize | 真偽（true/false） | true指定で、セキュリティコード認証の実行クレジット決済のみ有効 なおセキュリティコードは本サービスで保存しておらず、APIやCSVへの recurringリクエスト時には認証を行いません | false |
| hideCvv | 真偽（true/false） | true指定でセキュリティコード認証欄を非表示化クレジット決済のみ、かつ審査時にセキュリティコード認証を「必須」と指定されていない場合のみ有効 | false |
| hideRecurringCheckbox | 真偽（true/false） | typeをrecurringに指定した場合のリンクフォームに「個人情報の同意」のチェックボックスを表示するかどうか指定可能な値（意味）： true（非表示にする）false（表示する） | false |
| hidePrivacyLink | 真偽（true/false） | リンクフォームに表示される「個人情報の取り扱いについて」のリンクを表示するかどうか 指定可能な値（意味）： true（非表示にする）false（表示する） | false |
| univapayCustomerId | 半角英数（UUID） | UUID形式で定義したカスタマーID クレジットカード決済でのみ有効 このフィールドを初回の決済時に設定しておくと、リカーリングトークンの作成を消費者に任意選択させるチェックボックスを表示 ※１ 用途： 次回以降、カスタマーIDをパラメータに持つタグ（コード）でリンクフォームを表示した場合、過去に同加盟店で利用したクレジットカード情報を選択して決済することが可能 univapayCustomerId指定時のトークンタイプについて・ one_time 指定か省略の場合チェック（※１）なしで one_timeトークンを作成チェック（※１）ありで recurringトークンを作成・ recurring 指定の場合チェック（※１）必須で recurringトークンを作成※リンクフォーム作成時の注意点 リンクフォーム作成時にカスタマーIDを指定するにはメタデータのキーを univapay-customer-idと指定する必要あり | |
| successRedirectUrl | 半角英数（URLとして有効な記号を含む） | 決済成功時のリダイレクトURL | |
| failureRedirectUrl | 半角英数（URLとして有効な記号を含む） | 決済失敗時のリダイレクトURL | |
| pendingRedirectUrl | 半角英数（URLとして有効な記号を含む） | 決済処理待ちでタイムアウトした場合のリダイレクトURL | |
| autoRedirect | 真偽（true/false） | true指定で決済完了時に自動リダイレクト | false |
| showRedirectMetadata | 真偽（true/false） | true指定で、付与されたメタデータをリダイレクト先のURL末尾に付加します。 | false |
| customFieldKeys[] ※ | テキスト（制限なし） | 決済情報のメタデータの「キー」欄に記録 複数指定可能（カンマ区切り） ※customField関連のフィールド指定時必須 | |
| customFieldLabels[] ※ | テキスト（制限なし） | フォームにカスタム入力欄を挿入 入力欄のラベルはこの値が出力される ※customField関連のフィールド指定時必須 | |
| customFieldTypes[] ※ | 半角英 | カスタム入力欄のタイプ 指定可能な値（和訳）： select（選択）string（テキスト入力）※括弧とその中の文字は値として不要 ※customField関連のフィールド指定時必須 | |
| customFieldRequired[] ※ | 真偽（true/false） | カスタム入力欄を必須化 ※customField関連のフィールド指定時必須 | |
| customFieldOptions[] ※ | テキスト（制限なし） | カスタム入力欄が選択肢の場合の選択肢 複数指定可能（カンマ区切り） ※ customFieldTypes[]=select指定時必須 |
フィールド名はローワーキャメルケースで記載する必要があります。
HTTP GETメソッドであるため、値を"（ダブルクォーテーション）で囲む必要はありません。
