パラメータ(基本動作)
フィールド名はローワーキャメルケースで記載する必要があります。
HTTP GETメソッドであるため、値を"
(ダブルクォーテーション)で囲む必要はありません。
フィールド 赤字は必須 ※は条件付き必須 | 許容する値 | 備考 | 省略時の値 |
---|---|---|---|
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+オンライン)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 | |
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 を指定するとURLに自動で付与されるため指定の必要なし(例: productQuantities=2 ) | |
auth | 真偽(true /false ) | オーソリ クレジット決済でのみ有効 与信枠の確保のみ行うなら利用 (別途、売上処理かキャンセル処理が必要) | false |
captureAt | 半角英数 YYYY-MM-DD T hh: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 | 半角数(ハイフンなし) | 電話番号 送信した場合、入力済みの欄を表示 ※リンクフォーム設定で電話番号を必須にしている場合のみ | |
phoneNumberCountryCode | 半角数 | 電話番号の国コード 送信した場合、入力済みの国コードを表示 ※リンクフォーム設定で電話番号を必須にしている場合のみ | |
requirePhoneNumber | 半真偽(true /false ) | true 指定で電話番号の入力欄を表示(入力必須) | |
cvvAuthorize | 真偽(true /false ) | true 指定で、セキュリティコード認証の実行クレジット決済のみ有効 なおセキュリティコードは本サービスで保存しておらず、APIやCSVへの recurring リクエスト時には認証を行いません | false |
hideCvv | 真偽(true /false ) | false 指定でセキュリティコード認証欄を非表示化クレジット決済のみ、かつ審査時にセキュリティコード認証を「必須」と指定されていない場合のみ有効 | false |
hideRecurringCheckbox | 真偽(true /false ) | typeをrecurring に指定した場合のリンクフォームに「個人情報の同意」のチェックボックスを表示するかどうか指定可能な値(意味): true (非表示にする)false (表示する) | false |
hidePrivacyLink | 真偽(true /false ) | リンクフォームに表示される「個人情報の取り扱いについて」のリンクを表示するかどうか 指定可能な値(意味): true (非表示にする)false (表示する) | false |
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 指定時必須 |