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. 決済設定 – リクエスト
  5. 決済設定 – GET
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セキュア認証情報を自社で取得している場合の対応

決済設定 – GET

決済設定オブジェクトに対するGETリクエストには以下が必要です。(括弧内は入力箇所)
このリクエストはウィジェットを開いた際に自動的に送られ、店舗の支払いのための設定を確認することができます。
リンクフォーム / ウィジェットを開かなくても、アプリトークン / シークレット を指定して下記リクエストを送ることで確認可能です。

  • アプリトークン(Headerの{jwt}部分)

リクエスト

CommandとHeader

curl --request GET \
--url https://api.univapay.com/checkout_info \
--header 'Authorization: Bearer {jwt}'

記述例

curl --request GET \
--url https://api.univapay.com/checkout_info \
--header 'Authorization: Bearer {jwt}'

レスポンス

下記は記述例でリクエストした場合の例です。

CodeとHeader

  • Code:200
  • Header:Content-Type: application/json

Body

{
    "mode": "test",
    "recurring_token_privilege": "infinite",
    "name": "管理画面ガイド_TEST店舗",
    "card_configuration": {
        "enabled": true,
        "debit_enabled": true,
        "prepaid_enabled": true,
        "debit_authorization_enabled": true,
        "prepaid_authorization_enabled": true,
        "only_direct_currency": false,
        "forbidden_card_brands": null,
        "allowed_countries_by_ip": null,
        "foreign_cards_allowed": true,
        "fail_on_new_email": null,
        "card_limit": null,
        "allow_empty_cvv": false,
        "allow_direct_token_creation": true,
        "three_ds_required": false,
        "three_ds_address_required": true
    },
    "subscription_configuration": {
        "enabled": true
    },
    "installments_configuration": {
        "enabled": true,
        "card_processor": {
            "revolving": true,
            "fixed_cycle": true
        },
        "supported_payment_types": [
            "card",
            "konbini",
            "apple_pay",
            "paidy",
            "bank_transfer"
        ],
        "min_charge_amount": null,
        "max_payout_period": "P100Y",
        "only_with_processor": true
    },
    "subscription_plan_configuration": {
        "enabled": true,
        "fixed_cycle": true,
        "fixed_cycle_amount": true,
        "supported_payment_types": [
            "card",
            "konbini",
            "apple_pay",
            "paidy",
            "bank_transfer"
        ],
        "min_charge_amount": null,
        "max_payout_period": "P100Y"
    },
    "checkout_configuration": {
        "ec_email": {
            "enabled": true
        },
        "ec_products": {
            "enabled": true
        }
    },
    "qr_scan_configuration": {
        "enabled": true,
        "forbidden_qr_scan_gateways": null
    },
    "convenience_configuration": {
        "enabled": true,
        "expiration": "PT720H",
        "expiration_time_shift": {
            "value": "13:00:00+09:00",
            "enabled": false
        }
    },
    "paidy_configuration": {
        "enabled": true
    },
    "paidy_public_key": "pk_test_9bta9fm2cbvpcscddhr7qrnkkb",
    "logo_image": null,
    "theme": {
        "colors": {
            "main_background": "#FFFFFF",
            "secondary_background": "#F5F8FC",
            "main_color": "#4C5F85",
            "main_text": "#FFFFFF",
            "primary_text": "#4C5F85",
            "secondary_text": "#4C5F85",
            "base_text": "#4C5F85"
        }
    },
    "recurring_card_charge_cvv_confirmation": {
        "enabled": true,
        "threshold": [
            {
                "amount": 10000,
                "amount_formatted": 10000,
                "currency": "JPY"
            }
        ]
    },
    "online_configuration": {
        "enabled": false
    },
    "bank_transfer_configuration": {
        "enabled": true,
        "match_amount": "disabled",
        "expiration": "PT168H",
        "expiration_time_shift": {
            "value": "11:00:00+09:00",
            "enabled": true
        },
        "virtual_bank_accounts_threshold": 5,
        "virtual_bank_accounts_fetch_count": 10,
        "default_extension_period": "PT24H",
        "maximum_extension_period": "PT720H",
        "automatic_extension_enabled": false,
        "charge_request_notification_enabled": true,
        "charge_request_canceled_notification_enabled": true,
        "charge_expired_notification_enabled": true,
        "deposit_received_notification_enabled": true,
        "deposit_insufficient_notification_enabled": true,
        "deposit_exceeded_notification_enabled": true,
        "extension_notification_enabled": true,
        "remind_notification_period": "PT72H",
        "remind_notification_enabled": true
    },
    "supported_brands": [
        {
            "payment_type": "konbini",
            "brand": "sunkus",
            "dynamic_info": false,
            "support_auth_capture": true,
            "requires_full_name": false,
            "requires_cvv": false,
            "countries_allowed": null,
            "supported_currencies": [
                "JPY"
            ],
            "cvv_auth": false,
            "installment_capable": false
        },
        {
            "payment_type": "online",
            "brand": "alipay_plus_online",
            "online_brand": "alipay_plus_online",
            "dynamic_info": true,
            "support_auth_capture": true,
            "requires_full_name": false,
            "requires_cvv": false,
            "countries_allowed": null,
            "supported_currencies": [
                "JPY"
            ],
            "cvv_auth": false,
            "installment_capable": false
        },
        {
            "payment_type": "konbini",
            "brand": "yamazaki_daily_store",
            "dynamic_info": false,
            "support_auth_capture": true,
            "requires_full_name": false,
            "requires_cvv": false,
            "countries_allowed": null,
            "supported_currencies": [
                "JPY"
            ],
            "cvv_auth": false,
            "installment_capable": false
        },
        {
            "payment_type": "konbini",
            "brand": "family_mart",
            "dynamic_info": false,
            "support_auth_capture": true,
            "requires_full_name": false,
            "requires_cvv": false,
            "countries_allowed": null,
            "supported_currencies": [
                "JPY"
            ],
            "cvv_auth": false,
            "installment_capable": false
        },
        {
            "payment_type": "konbini",
            "brand": "mini_stop",
            "dynamic_info": false,
            "support_auth_capture": true,
            "requires_full_name": false,
            "requires_cvv": false,
            "countries_allowed": null,
            "supported_currencies": [
                "JPY"
            ],
            "cvv_auth": false,
            "installment_capable": false
        },
        {
            "payment_type": "konbini",
            "brand": "pay_easy",
            "dynamic_info": false,
            "support_auth_capture": true,
            "requires_full_name": false,
            "requires_cvv": false,
            "countries_allowed": null,
            "supported_currencies": [
                "JPY"
            ],
            "cvv_auth": false,
            "installment_capable": false
        },
        {
            "payment_type": "online",
            "brand": "alipay_online",
            "online_brand": "alipay_online",
            "dynamic_info": false,
            "support_auth_capture": true,
            "requires_full_name": false,
            "requires_cvv": false,
            "countries_allowed": null,
            "supported_currencies": [
                "JPY"
            ],
            "cvv_auth": false,
            "installment_capable": false
        },
        {
            "payment_type": "konbini",
            "brand": "circle_k",
            "dynamic_info": false,
            "support_auth_capture": true,
            "requires_full_name": false,
            "requires_cvv": false,
            "countries_allowed": null,
            "supported_currencies": [
                "JPY"
            ],
            "cvv_auth": false,
            "installment_capable": false
        },
        {
            "payment_type": "card",
            "brand": "mastercard",
            "card_brand": "mastercard",
            "dynamic_info": false,
            "support_auth_capture": true,
            "requires_full_name": false,
            "requires_cvv": true,
            "countries_allowed": null,
            "supported_currencies": [
                "JPY"
            ],
            "cvv_auth": true,
            "installment_capable": false
        },
        {
            "payment_type": "konbini",
            "brand": "seven_eleven",
            "dynamic_info": false,
            "support_auth_capture": true,
            "requires_full_name": false,
            "requires_cvv": false,
            "countries_allowed": null,
            "supported_currencies": [
                "JPY"
            ],
            "cvv_auth": false,
            "installment_capable": false
        },
        {
            "payment_type": "konbini",
            "brand": "seico_mart",
            "dynamic_info": false,
            "support_auth_capture": true,
            "requires_full_name": false,
            "requires_cvv": false,
            "countries_allowed": null,
            "supported_currencies": [
                "JPY"
            ],
            "cvv_auth": false,
            "installment_capable": false
        },
        {
            "payment_type": "online",
            "brand": "d_barai_online",
            "online_brand": "d_barai_online",
            "dynamic_info": false,
            "support_auth_capture": true,
            "requires_full_name": false,
            "requires_cvv": false,
            "countries_allowed": null,
            "supported_currencies": [
                "JPY"
            ],
            "cvv_auth": false,
            "installment_capable": false
        },
        {
            "payment_type": "konbini",
            "brand": "daily_yamazaki",
            "dynamic_info": false,
            "support_auth_capture": true,
            "requires_full_name": false,
            "requires_cvv": false,
            "countries_allowed": null,
            "supported_currencies": [
                "JPY"
            ],
            "cvv_auth": false,
            "installment_capable": false
        },
        {
            "payment_type": "konbini",
            "brand": "lawson",
            "dynamic_info": false,
            "support_auth_capture": true,
            "requires_full_name": false,
            "requires_cvv": false,
            "countries_allowed": null,
            "supported_currencies": [
                "JPY"
            ],
            "cvv_auth": false,
            "installment_capable": false
        },
        {
            "payment_type": "card",
            "brand": "jcb",
            "card_brand": "jcb",
            "dynamic_info": false,
            "support_auth_capture": true,
            "requires_full_name": false,
            "requires_cvv": true,
            "countries_allowed": null,
            "supported_currencies": [
                "JPY"
            ],
            "cvv_auth": true,
            "installment_capable": true
        },
        {
            "payment_type": "card",
            "brand": "visa",
            "card_brand": "visa",
            "dynamic_info": false,
            "support_auth_capture": true,
            "requires_full_name": false,
            "requires_cvv": true,
            "countries_allowed": null,
            "supported_currencies": [
                "JPY"
            ],
            "cvv_auth": true,
            "installment_capable": true
        },
        {
            "payment_type": "paidy",
            "brand": "paidy",
            "dynamic_info": false,
            "support_auth_capture": true,
            "requires_full_name": false,
            "requires_cvv": false,
            "countries_allowed": null,
            "supported_currencies": [
                "JPY"
            ],
            "cvv_auth": false,
            "installment_capable": false
        },
        {
            "payment_type": "card",
            "brand": "diners_club",
            "card_brand": "diners_club",
            "dynamic_info": false,
            "support_auth_capture": false,
            "requires_full_name": false,
            "requires_cvv": true,
            "countries_allowed": null,
            "supported_currencies": [
                "JPY"
            ],
            "cvv_auth": true,
            "installment_capable": false
        },
        {
            "payment_type": "card",
            "brand": "american_express",
            "card_brand": "american_express",
            "dynamic_info": false,
            "support_auth_capture": false,
            "requires_full_name": false,
            "requires_cvv": true,
            "countries_allowed": null,
            "supported_currencies": [
                "JPY"
            ],
            "cvv_auth": true,
            "installment_capable": false
        },
        {
            "payment_type": "online",
            "brand": "pay_pay_online",
            "online_brand": "pay_pay_online",
            "dynamic_info": false,
            "support_auth_capture": true,
            "requires_full_name": false,
            "requires_cvv": false,
            "countries_allowed": null,
            "supported_currencies": [
                "JPY"
            ],
            "cvv_auth": false,
            "installment_capable": false
        },
        {
            "payment_type": "bank_transfer",
            "brand": "aozora_bank",
            "dynamic_info": false,
            "support_auth_capture": false,
            "requires_full_name": false,
            "requires_cvv": false,
            "countries_allowed": null,
            "supported_currencies": [
                "JPY"
            ],
            "cvv_auth": false,
            "installment_capable": false
        },
        {
            "payment_type": "online",
            "brand": "we_chat_online",
            "online_brand": "we_chat_online",
            "dynamic_info": true,
            "support_auth_capture": true,
            "requires_full_name": false,
            "requires_cvv": false,
            "countries_allowed": null,
            "supported_currencies": [
                "JPY"
            ],
            "cvv_auth": false,
            "installment_capable": false
        }
    ]
}
Share this Doc

決済設定 – GET

Or copy link

Clipboard Icon
CONTENTS

© All Rights Reserved by UNIVA Paycast Limited.