Pay-Doc Pay-Doc
  • Home
  • 利用ガイド
  • APIリファレンス
  • FAQ
  • 更新履歴
  • 旧システムからの移行
  • お問い合わせ
Login
Pay-Doc Pay-Doc
Login
Pay-Doc Pay-Doc
  • Home
  • 利用ガイド
  • APIリファレンス
  • FAQ
  • 更新履歴
  • 旧システムからの移行
  • お問い合わせ
loading
  1. Home
  2. APIリファレンス
  3. 決済設定
  4. 決済設定 – 概要
Updated on 2025年4月15日

APIリファレンス

  • Folder icon closed Folder open icon一般
    • API連携、SDKについて
    • 認証
    • APIの制限
    • レスポンス
    • ページネーション
    • メタデータ
    • ポーリング
    • 冪等なリクエスト
    • 通貨と為替レート
  • Folder icon closed Folder open iconトランザクショントークン
    • トランザクショントークン – 概要
    • トランザクショントークン – リクエスト
      • トランザクショントークン – CREATE
      • トランザクショントークン – GET
      • トランザクショントークン – LIST
      • トランザクショントークン – UPDATE
      • トランザクショントークン – DELETE
      • トランザクショントークン – イシュアトークン(3-Dセキュア) – GET
  • Folder icon closed Folder open icon課金
    • 課金 – 概要
    • 課金 – リクエスト
      • 課金 – CREATE
      • 課金 – GET
      • 課金 – GET(銀行振込)
      • 課金 – LIST
      • 課金 – UPDATE
      • キャプチャ – CREATE
      • イシュアトークン – GET
      • 課金 – イシュアトークン(3-Dセキュア) – GET
  • Folder icon closed Folder open icon定期課金
    • 定期課金 – 概要
    • 定期課金 – リクエスト
      • 定期課金 – CREATE
      • 定期課金 – GET
      • 定期課金 – LIST
      • 定期課金 – UPDATE
      • 定期課金 – CANCEL
      • 定期課金 – 課金 – LIST
      • 支払い – 概要
      • 支払い – GET
      • 支払い – LIST
  • Folder icon closed Folder open icon返金
    • 返金 – 概要
    • 返金 – リクエスト
      • 返金 – CREATE
      • 返金 – GET
      • 返金 – LIST
      • 返金 – UPDATE
  • Folder icon closed Folder open iconキャンセル
    • キャンセル – 概要
    • キャンセル – リクエスト
      • キャンセル – CREATE
      • キャンセル – GET
      • キャンセル – LIST
      • キャンセル – UPDATE
  • Folder icon closed Folder open iconトランザクション
    • トランザクション – 概要
    • トランザクション – リクエスト
      • トランザクション – LIST
  • Folder icon closed Folder open icon加盟店
    • 加盟店 – 概要
    • 加盟店 – リクエスト
      • 加盟店 – GET
  • Folder icon closed Folder open icon店舗
    • 店舗 – 概要
    • 店舗 – リクエスト
      • 店舗 – GET
      • 店舗 – LIST
      • カスタマーUUID
  • Folder icon closed Folder open icon決済設定
    • 決済設定 – 概要
    • 決済設定 – リクエスト
      • 決済設定 – GET
  • Folder icon closed Folder open iconウェブフック
    • ウェブフック – 概要
    • ウェブフック – リクエスト
      • ウェブフック – GET
      • ウェブフック – UPDATE
  • Folder icon closed Folder open iconエラーコード
    • エラーコード – 概要
  • Folder icon closed Folder open icon3-DセキュアをAPIで実装する
    • 3-Dセキュア認証の処理の流れ
    • 実装方法
    • 追加されるパラメータ
    • 3-Dセキュア認証情報を自社で取得している場合の対応

決済設定 – 概要

リンクフォーム / ウィジェットが表示されると、パラメータで指定されたアプリケーショントークンに関連した店舗の決済設定を取得する為に自動的にAPIにリクエストを行います。
決済設定は、リンクフォーム / ウィジェットを動作する為に必要な様々な設定情報の集合です。

決済設定オブジェクト

フィールドデータ型備考
modestringウィジェットに設定されたアプリケーショントークンのモード
namestringストア名
logo_imagestringストアのロゴ画像のURL
recurring_token_privilegestringこのストアのリカーリングトークンの権限。none (なし), bounded (制限付き), infinite (無制限) のいずれか。
card_configuration.enabledbooleanカードが利用可能か
card_configuration.debit_enabledbooleanデビットカードが利用可能か
card_configuration.prepaid_enabledbooleanプリペイドカードが利用可能か
card_configuration.forbidden_card_brandsarray[string]このストアでの使用が許可されていないカードブランドのリスト
card_configuration.allowed_countries_by_iparray[string]IPアドレスが課金を許可されていない国のリスト
card_configuration.foreign_cards_allowedboolean外国のカードを許可するかどうか。
外国のカードとは、その国がストアの国と同じではないカードを指す
card_configuration.fail_on_new_emailboolean以前に特定のメールアドレスで使用されたカードを許可するかどうか
trueの場合、別のメールアドレスで使用されているカードは拒否される
card_configuration.allow_empty_cvvbooleanカード払いのCVVチェックを有効にするかどうか
card_configuration.card_limit.amountnumber定義された期間、カードごとに利用を制限する金額
card_configuration.card_limit.currencystring (ISO-4217)amountが定義されている通貨
card_configuration.card_limit.durationstring (ISO-8601)定義された期間、カードごとに利用を制限する金額
qr_scan_configuration.enabledbooleanQRコードが支払方法として利用可能かどうか
qr_scan_configuration.forbidden_qr_scan_gatewaysarray[string]QRコード決済の処理に使用されない決済ゲートウェイのリスト
convenience_configuration.enabledbooleanコンビニがペイメント方法として利用可能かどうか
theme.colors.main_backgroundstring (HexColor)入力欄背景。入力フォームが表示されるエリアの背景色。デフォルトは #fafafa
theme.colors.secondary_backgroundstring (HexColor)ロゴとタイトルが含まれるエリアの背景色。デフォルトは #ee7a00
theme.colors.main_colorstring (HexColor)ヘッダーと下部のボタンの背景色。デフォルトは #fafafa
theme.colors.primary_textstring (HexColor)タイトル(デフォルトはストア名)の文字色。デフォルトは #fafafa
theme.colors.secondary_textstring (HexColor)(指定がある場合は)ウィジェットのタイトル下部に表示される説明文の文字色。デフォルトは #222222
theme.colors.base_textstring (HexColor)上記で指定されない他のテキストの文字色。デフォルトは #000000
recurring_card_charge_cvv_confirmation.enabledbooleanリカーリングトークンを使用するときに、このストアにCVV確認が必要かどうか
recurring_card_charge_cvv_confirmation.thresholdarray[MoneyAmount]CVV確認せずに課金可能な、ストアのデフォルト通貨での最大金額
supported_brandsarray[SupportedBrand]利用可能な決済ブランド

MoneyAmount

フィールドデータ型備考
amountnumber小数点以下の金額
currencystring (ISO-4217)ISO-4217形式の通貨

SupportedBrand

フィールドデータ型備考
brandstring対応しているブラント
payment_typeにより、次のいずれか
card: visa, mastercard, american_express, jcb, diners_club, unionpay, discover, maestro
qr_merchant: alipay_merchant_qr, alipay_connect_mpm, pay_pay_merchant, we_chat_mpm
online: alipay_online, alipay_plus_online, pay_pay_online, we_chat_online,dbarai_online
bank_transfer: aozora_bank
paidy: paidy
payment_typestring次のいずれか card, qr_merchant, online, bank_transfer, paidy
support_auth_captureboolean仮売上のキャプチャが許可されているか
requires_full_nameboolean名前を必須にしているか
support_dynamic_descriptorbooleanダイナミックディスクリプタ―が利用可能か
requires_cvvbooleanセキュリティコードが必須か
countries_allowedarray[string]許可されている国
supported_currenciesarray[string]許可された通貨
cvv_authbooleanセキュリティコード認証を行うか
dynamic_infoboolean分割払いが利用可能か
Share this Doc

決済設定 – 概要

Or copy link

Clipboard Icon
CONTENTS

© All Rights Reserved by UNIVA Paycast Limited.