Pay-Doc Pay-Doc
  • Home
  • 利用ガイド
  • APIリファレンス
  • FAQ
  • 更新履歴
  • 旧システムからの移行
  • お問い合わせ
Login
Pay-Doc Pay-Doc
Login
Pay-Doc Pay-Doc
  • Home
  • 利用ガイド
  • APIリファレンス
  • FAQ
  • 更新履歴
  • 旧システムからの移行
  • お問い合わせ
loading
  1. Home
  2. 利用ガイド
  3. 実装ガイド
  4. リンクフォーム – 概要
  5. パラメータ(定期課金/分割払い)
Updated on 2025年4月23日

利用ガイド

  • Folder icon closed Folder open iconはじめに(利用方法)
    • 免責事項
    • 利用方法
    • 初期設定
    • 利用可能な決済手段
    • 管理画面の使い方
    • 決済フォームの種類
    • トークンとは
    • 処理と課金の種類
    • 処理結果の通知と取得
    • 【重要】リカーリング時の注意点
    • 制限機能
    • 用語集
    • 開発後の動作検証
  • Folder icon closed Folder open icon実装ガイド
    • ウィジェット – 概要
      • 設置 – (HTML/JavaScript)
      • パラメータ(基本動作)
      • パラメータ(定期課金)
      • パラメータ(分割払い)
    • リンクフォーム – 概要
      • パラメータ(基本動作)
      • パラメータ(定期課金/分割払い)
    • インラインフォーム – 概要
      • 設置 – (HTML)
      • 設置 – (JavaScript)
      • パラメータ
  • Folder icon closed Folder open icon決済手段別 実装ガイド
    • 銀行振込 – 概要
      • 銀行振込 – 特徴
      • 銀行振込 – 要注意なパラメータ
      • 銀行振込 – APIへのリクエスト
    • コンビニ決済 – 概要
      • コンビニ決済 – 特徴
      • コンビニ決済 – 要注意なパラメータ
      • コンビニ決済 – APIへのリクエスト
    • オンライン決済 – 概要
      • オンライン決済 – 特徴
      • オンライン決済 – 要注意なパラメータ
      • オンライン決済 – APIへのリクエスト
    • Paidy – 概要
      • Paidy – 特徴
      • Paidy – 要注意なパラメータ
  • Folder icon closed Folder open icon各種機能詳細
    • 定期課金
      • リトライ
      • 停止・再開
    • 消費者によるお支払い方法の更新
      • 支払い情報の確認・変更画面
      • 1.消費者の利用フロー
      • 2.加盟店さまの設定
      • 3.消費者へのURLの共有方法
    • CSVデータのダウンロード
    • CSV課金
    • 商品
    • 処理結果のメール通知
      • テンプレートの種類
      • パラメータ
      • 応用的なパラメータの利用方法
    • ウェブフック
  • Folder icon closed Folder open icon3-Dセキュア
    • 3‐Dセキュア – 概要
    • 加盟店さまの設定・実装
    • デフォルトの3-Dセキュア実行ルール

パラメータ(定期課金/分割払い)

基本動作については別途パラメータ解説ページがあり、左メニューから閲覧可能です。

フィールド名はローワーキャメルケースで記載する必要があります。
HTTP GETメソッドであるため、値を"(ダブルクォーテーション)で囲む必要はありません。

定期課金

リンクフォームで定期課金登録をする際に、定期課金の挙動を指定するパラメータです。

フィールド
赤字は必須
※は条件付き必須
許容する値備考省略時の値
period
※
半角英数期課金の間隔

指定可能な値(意味):
daily(毎日)
weekly(毎週)
monthly(毎月)
bimonthly(隔月)
quarterly(3ヶ月)
semiannually(6ヶ月)
annually(毎年)
※…基本動作でtype=subscription指定なら必須

さらに詳細な指定(意味):
PxD(x日周期)
PxW(x週間周期)
PxM(xヶ月周期)
PxY(x年周期)
subscriptionId
半角英数継続中の定期課金IDを指定することで、登録されたカード情報を変更
data-checkout="token"の指定が必須、data-app-id以外のパラメータは不要

指定可能な値: アプリケーショントークンに紐付いたストアに作成されている定期課金のID
initialAmount半角数定期課金の初回金額
startIn半角英数定期課金の2回目の課金が行われるまでの期間

指定可能な値(意味):
PxD(x日後)
PxW(x週間後)
PxM(xヶ月後)
PxY(x年後)
periodに従う
startDayOfMonth半角英数
(1〜31)
定期課金の2回目の課金が行われる日付

startInとの組み合わせも可能
例:
startDayOfMonth=20&startIn=P2M
翌月の20日

startIn未設定の場合は、
当月の該当日以前であれば当月にも課金され、
該当日以降であれば翌月の該当日に課金されます
periodに従う
subscriptionRetryInterval半角英数定期課金が失敗したときのリトライ間隔
P1D以上かつ定期課金サイクルより短くないとエラー

指定可能な値(意味):
PxD(x日)
PxW(x週間)
PxM(xか月)
定期課金の周期÷リトライ回数の間隔
(余り切捨)
terminationMode半角英定期課金の停止リクエストを受理したとき、実際に自動課金のステータスをsupended(一時停止)に変更するタイミング

メールやwebhookの通知も同期するため、定期課金の停止申請後も次回課金日まで会員権利を維持したい場合に利用

指定可能な値(意味):
immediate(即時)
on_next_payment(次回課金日)
immediate
表記ルールについては免責事項を参照してください

分割払い

リンクフォームで消費者に分割払いを選択させたい場合に、指定するパラメータです。

フィールド許容する値備考省略時の値
allowCardInstallments真偽(true/false)true指定で、分割払いの回数を選択するドロップダウンメニューを表示
クレジットカードが指定または選択され、
checkout=paymentかつ、
type=subscription以外を指定し、
契約上分割払いが可能な場合のみ有効
false
cardInstallmentOptions半角数allowCardInstallments=true の時、ドロップダウンメニューでの選択肢を制御

選択可能な値(カンマ区切り):
1, 3, 5, 6, 10, 12, 15, 18, 20, 24, revolving
全て
表記ルールについては免責事項を参照してください
Share this Doc

パラメータ(定期課金/分割払い)

Or copy link

Clipboard Icon
CONTENTS

© All Rights Reserved by UNIVA Paycast Limited.