追加されるパラメータ

3-Dセキュア認証を実行するためのパラメータとその説明は以下です。

本サービスで設計されている、3-Dセキュア認証が実行される場合とそのタイミングについて、便宜上「既存ルール」としています。詳細は「デフォルトの3-Dセキュア実行ルール」のページを参照してください。

トランザクショントークンオブジェクトで追加されるデータ

フィールド	データ型	備考	リクエスト時指定可
data.three_ds.enabled	boolean	このトランザクショントークンで3D-セキュアを実行するかどうか トークンタイプがrecurringの場合のみtrueを指定可 未指定時、既存ルールに応じてtrueまたはfalseのいずれかに指定されます。 この値をfalseに指定すると、後で課金を作成する際に3-Dセキュア認証がトリガーされる可能性があります。	〇
data.three_ds.status	string	有効時の3D-セキュアのステータス pending、awaiting、successful、failed、errorのいずれか	×
data.three_ds.redirect_endpoint	string (URL)	顧客が3D-セキュア認証から戻る際のリダイレクトエンドポイント 未指定時、デフォルトの完了ページを表示し、元のウェブサイトに手動で戻るよう求められます。 指定すると、顧客はGET httpメソッドで指定されたエンドポイントにリダイレクトされます。 すべてのメタデータ（課金作成時に指定されたもの、作成後に更新された追加メタデータは含まない）とunivapayTokenIdは、クエリパラメータの一部として自動的に送信されます。 任意でエンドポイントURLにクエリパラメータを追加することができます。	〇
data.three_ds.redirect_id	string (UUID)	リダイレクトリクエストの一意な識別子 リダイレクトURLが正常に指定された場合当システム側で入力されます。	×

課金・定期課金オブジェクトで追加されるデータ

フィールド	データ型	備考	リクエスト時指定可
three_ds.redirect_id	string (UUID)	リダイレクトリクエストの一意な識別子 リダイレクトURLが正常に指定された場合当システム側で入力されます。	×
three_ds.redirect_endpoint	string (URL)	3DS認証後に顧客をリダイレクトするURL 顧客はGET httpメソッドで指定されたエンドポイントにリダイレクトされます。 univapayChargeIdとunivapayTokenIdに加えて、すべてのメタデータ（課金作成時に指定されたもの、作成後に更新されたメタデータは含まない）が自動的にクエリパラメータの一部として送信されます。 任意でエンドポイントURLに追加のクエリパラメータを追加することができます。	〇
three_ds.mode	string	課金の3D-セキュア認証の種類 normal、require、force、skipのいずれか デフォルトではnormalが指定されます。 トランザクショントークン作成時に3-Dセキュア認証が完了している場合、3-Dセキュア認証はスキップされ、そうでない場合は3-Dセキュア認証が必要となります。 requireを指定するとトランザクショントークンですでに3-Dセキュア認証が完了していても、3D-セキュア認証を要求します。 この時、3-Dセキュアのリスクベース認証によっては本人認証が要求されず決済が完了になる可能性があります。 forceを指定するとトランザクショントークンですでに3-Dセキュア認証が完了していても、強制的に3-Dセキュア認証を行います。 この時チャレンジ認証が強制的に行われ、本人認証が必要になります。 skipを指定すると3-Dセキュア認証をスキップします。 これは、消費者が3-Dセキュアを実行できない特定のケースでのみ使用します。 使用するにはアプリトークンのシークレットが必要です。 このオプションを有効にするには、サポートにお問い合わせください。	〇