DocumentationCommerceConfiguration Guide

Payment configuration paths reference

Last update: Wed May 17 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Experienced
  • Admin
  • Developer

These configuration values are available in the Admin in Stores > Settings > Configuration > Sales > Payment Methods.

The magento app:config:dump command writes these values to the shared configuration file, app/etc/config.php, which should be in source control. To optionally override any configuration settings or to set sensitive settings, see Use environment variables to override configuration settings. This topic does not list sensitive and system-specific values.

The settings are further organized by payment method.

PayPal paths

Name
Config path
Commerce only?
Encrypted?
Enable this Solution
payment/payflowpro/active
Enable In-Context Checkout Experience
payment/paypal_express/in_context
Enable PayPal Credit
payment/payflow_express_bml/active
Enable PayPal Credit
payment/paypal_express_bml/active
Display
payment/paypal_express_bml/homepage_display
Position
payment/paypal_express_bml/homepage_position
Size
payment/paypal_express_bml/homepage_size
Display
payment/paypal_express_bml/categorypage_display
Position
payment/paypal_express_bml/categorypage_position
Size
payment/paypal_express_bml/categorypage_size
Display
payment/paypal_express_bml/productpage_display
Position
payment/paypal_express_bml/productpage_position
Size
payment/paypal_express_bml/productpage_size
Display
payment/paypal_express_bml/checkout_display
Position
payment/paypal_express_bml/checkout_position
Size
payment/paypal_express_bml/checkout_size
Display on Product Details Page
payment/payflow_express/visible_on_product
Display on Shopping Cart
payment/payflow_express/visible_on_cart
Payment Applicable From
payment/payflow_express/allowspecific
Countries Payment Applicable From
payment/payflow_express/specificcountry
Enable SSL verification
payment/payflow_express/verify_peer
Transfer Cart Line Items
payment/payflow_express/line_items_enabled
Skip Order Review Step
payment/paypal_express/skip_order_review_step
Transfer Cart Line Items
payment/paypal_express/line_items_enabled
Transfer Shipping Options
payment/paypal_express/transfer_shipping_options
Shortcut Buttons Flavor
paypal/wpp/button_flavor
Enable PayPal Guest Checkout
payment/paypal_express/solution_type
Require Customer’s Billing Address
payment/paypal_express/require_billing_address
Billing Agreement Signup
payment/paypal_express/allow_ba_signup
Enabled
payment/paypal_billing_agreement/active
Title
payment/paypal_billing_agreement/title
Sort Order
payment/paypal_billing_agreement/sort_order
Payment Action
payment/paypal_billing_agreement/payment_action
Payment Applicable From
payment/paypal_billing_agreement/allowspecific
Countries Payment Applicable From
payment/paypal_billing_agreement/specificcountry
Enable SSL verification
payment/paypal_billing_agreement/verify_peer
Transfer Cart Line Items
payment/paypal_billing_agreement/line_items_enabled
Allow in Billing Agreement Wizard
payment/paypal_billing_agreement/allow_billing_agreement_wizard
Enable Automatic Fetching
paypal/fetch_reports/active
Schedule
paypal/fetch_reports/schedule
Time of Day
paypal/fetch_reports/time
PayPal Product Logo
paypal/style/logo
Page Style
paypal/style/page_style
Header Image URL
paypal/style/paypal_hdrimg
Header Background Color
paypal/style/paypal_hdrbackcolor
Header Border Color
paypal/style/paypal_hdrbordercolor
Page Background Color
paypal/style/paypal_payflowcolor
Enable this Solution
payment/paypal_express/active
Sort Order PayPal Credit
payment/paypal_express_bml/sort_order
Title
payment/paypal_express/title
Sort Order
payment/paypal_express/sort_order
Payment Action
payment/paypal_express/payment_action
Display on Product Details Page
payment/paypal_express/visible_on_product
Authorization Honor Period (days)
payment/paypal_express/authorization_honor_period
Order Valid Period (days)
payment/paypal_express/order_valid_period
Number of Child Authorizations
payment/paypal_express/child_authorization_number
Display on Shopping Cart
payment/paypal_express/visible_on_cart
Payment Applicable From
payment/paypal_express/allowspecific
Countries Payment Applicable From
payment/paypal_express/specificcountry
Enable SSL verification
payment/paypal_express/verify_peer
Scheduled Fetching
payment_all_paypal/express_checkout/settings_ec/settings_ec_advanced/express_checkout_settlement_report/heading_schedule
PayPal Merchant Pages Style
payment_all_paypal/express_checkout/settings_ec/settings_ec_advanced/express_checkout_frontend/paypal_pages

PayPal Payments Pro

Name
Config path
Commerce only?
Encrypted?
API Authentication Methods
paypal/wpp/api_authentication
API Uses Proxy
paypal/wpp/use_proxy
Scheduled Fetching
payment_all_paypal/payments_pro_hosted_solution/pphs_settings/pphs_settings_advanced/pphs_settlement_report/heading_schedule
Scheduled Fetching
payment_all_paypal/payments_pro_hosted_solution_without_bml/pphs_settings/pphs_settings_advanced/pphs_settlement_report/heading_schedule

Payments Pro Hosted Solution (United Kingdom)

These options are available only if you chose the United Kingdom as the merchant country.

Name
Config path
Commerce only?
Encrypted?
Enable this Solution
payment/hosted_pro/active
Title
payment/hosted_pro/title
Sort Order
payment/hosted_pro/sort_order
Payment Action
payment/hosted_pro/payment_action
Display Express Checkout in the Payment Information step
payment/hosted_pro/display_ec
Payment Applicable From
payment/hosted_pro/allowspecific
Countries Payment Applicable From
payment/hosted_pro/specificcountry
Enable SSL verification
payment/hosted_pro/verify_peer

PayPal Payflow Pro

Name
Config path
Commerce only?
Encrypted?
Vault Enabled
payment/payflowpro_cc_vault/active
Title
payment/payflowpro/title
Vault Title
payment/payflowpro_cc_vault/title
Sort Order
payment/payflowpro/sort_order
Payment Action
payment/payflowpro/payment_action
Allowed Credit Card Types
payment/payflowpro/cctypes
Payment Applicable From
payment/payflowpro/allowspecific
Countries Payment Applicable From
payment/payflowpro/specificcountry
Enable SSL verification
payment/payflowpro/verify_peer
Require CVV Entry
payment/payflowpro/useccv
Reject Transaction if:
payment_all_paypal/paypal_payflowpro/settings_paypal_payflow/settings_paypal_payflow_advanced/paypal_payflow_avs_check/heading_avs_settings
AVS Street Does Not Match
payment/payflowpro/avs_street
AVS Zip Does Not Match
payment/payflowpro/avs_zip
International AVS Indicator Does Not Match
payment/payflowpro/avs_international
Card Security Code Does Not Match
payment/payflowpro/avs_security_code
Vendor
payment/payflowpro/vendor
Use Proxy
payment/payflowpro/use_proxy
Title
payment/payflow_express/title
Sort Order
payment/payflow_express/sort_order
Payment Action
payment/payflow_express/payment_action
Scheduled Fetching
payment_all_paypal/paypal_payflowpro/settings_paypal_payflow/settings_paypal_payflow_advanced/paypal_payflow_settlement_report/heading_schedule
PayPal Merchant Pages Style
payment_all_paypal/payflow_link/settings_payflow_link/settings_payflow_link_advanced/payflow_link_frontend/paypal_pages
Partner
payment/payflow_advanced/partner
Vendor
payment/payflow_advanced/vendor
Use Proxy
payment/payflow_advanced/use_proxy
Enable this Solution
payment/payflow_advanced/active
Title
payment/payflow_advanced/title
Sort Order
payment/payflow_advanced/sort_order
Payment Action
payment/payflow_advanced/payment_action
Payment Applicable From
payment/payflow_advanced/allowspecific
Countries Payment Applicable From
payment/payflow_advanced/specificcountry
Enable SSL verification
payment/payflow_advanced/verify_peer
CVV Entry is Editable
payment/payflow_advanced/csc_editable
Require CVV Entry
payment/payflow_advanced/csc_required
Send Email Confirmation
payment/payflow_advanced/email_confirmation
Name
Config path
Commerce only?
Encrypted?
Partner
payment/payflow_link/partner
Vendor
payment/payflow_link/vendor
Enable Payflow Link
payment/payflow_link/active
Enable Express Checkout
payment/payflow_express/active
Sort Order PayPal Credit
payment/payflow_express_bml/sort_order
Payment Applicable From
payment/payflow_link/allowspecific
Countries Payment Applicable From
payment/payflow_link/specificcountry
Enable SSL verification
payment/payflow_link/verify_peer
CVV Entry is Editable
payment/payflow_link/csc_editable
Require CVV Entry
payment/payflow_link/csc_required
Send Email Confirmation
payment/payflow_link/email_confirmation
Scheduled Fetching
payment_all_paypal/payflow_link/settings_payflow_link/settings_payflow_link_advanced/payflow_link_settlement_report/heading_schedule
Title
payment/payflow_link/title
Sort Order
payment/payflow_link/sort_order
Payment Action
payment/payflow_link/payment_action

Zero Subtotal Checkout paths

Name
Config path
Commerce only?
Encrypted?
Enabled
payment/free/active
Title
payment/free/title
New Order Status
payment/free/order_status
Automatically Invoice All Items
payment/free/payment_action
Payment from Applicable Countries
payment/free/allowspecific
Payment from Specific Countries
payment/free/specificcountry
Sort Order
payment/free/sort_order

Cash on Delivery Payment paths

Name
Config path
Commerce only?
Encrypted?
Enabled
payment/cashondelivery/active
Title
payment/cashondelivery/title
New Order Status
payment/cashondelivery/order_status
Payment from Applicable Countries
payment/cashondelivery/allowspecific
Payment from Specific Countries
payment/cashondelivery/specificcountry
Instructions
payment/cashondelivery/instructions
Minimum Order Total
payment/cashondelivery/min_order_total
Maximum Order Total
payment/cashondelivery/max_order_total
Sort Order
payment/cashondelivery/sort_order

Bank Transfer Payment paths

Name
Config path
Commerce only?
Encrypted?
Enabled
payment/banktransfer/active
Title
payment/banktransfer/title
New Order Status
payment/banktransfer/order_status
Payment from Applicable Countries
payment/banktransfer/allowspecific
Payment from Specific Countries
payment/banktransfer/specificcountry
Instructions
payment/banktransfer/instructions
Minimum Order Total
payment/banktransfer/min_order_total
Maximum Order Total
payment/banktransfer/max_order_total
Sort Order
payment/banktransfer/sort_order

Check or Money Order paths

Name
Config path
Commerce only?
Encrypted?
Enabled
payment/checkmo/active
Title
payment/checkmo/title
New Order Status
payment/checkmo/order_status
Payment from Applicable Countries
payment/checkmo/allowspecific
Payment from Specific Countries
payment/checkmo/specificcountry
Make Check Payable to
payment/checkmo/payable_to
Minimum Order Total
payment/checkmo/min_order_total
Maximum Order Total
payment/checkmo/max_order_total
Sort Order
payment/checkmo/sort_order

Purchase Order paths

Name
Config path
Commerce only?
Encrypted?
Enabled
payment/purchaseorder/active
Title
payment/purchaseorder/title
New Order Status
payment/purchaseorder/order_status
Payment from Applicable Countries
payment/purchaseorder/allowspecific
Payment from Specific Countries
payment/purchaseorder/specificcountry
Minimum Order Total
payment/purchaseorder/min_order_total
Maximum Order Total
payment/purchaseorder/max_order_total
Sort Order
payment/purchaseorder/sort_order

International paths

INFO
The available paths are determined by your choice of Merchant country.
/fragments/en/docs/commerce-operations/configuration-guide/paths/config-reference-payment/fragment-0
/fragments/en/docs/commerce-operations/configuration-guide/paths/config-reference-payment/fragment-1
386822bd-e32c-40a8-81c2-ed90ad1e198c