VTEX · Schema

PaymentConfiguration

Payment Configuration object.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
requiresAuthenticationForPreAuthorizedPaymentOption boolean Determines whether pre-authorized payments require authentication.
allowInstallmentsMerge boolean By default (when `false`), on a multi-seller purchase is on the run, a simple intersection with installments options configured by every seller will be available. When `true`, this option allows a mor
blockPaymentSession boolean Indicates whether shoppers can add credit cards in your store's `My Account` section.
View JSON Schema on GitHub

JSON Schema

vtex-paymentconfiguration-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PaymentConfiguration",
  "title": "PaymentConfiguration",
  "description": "Payment Configuration object.",
  "required": [
    "requiresAuthenticationForPreAuthorizedPaymentOption"
  ],
  "type": "object",
  "properties": {
    "requiresAuthenticationForPreAuthorizedPaymentOption": {
      "type": "boolean",
      "description": "Determines whether pre-authorized payments require authentication."
    },
    "allowInstallmentsMerge": {
      "type": "boolean",
      "description": "By default (when `false`), on a multi-seller purchase is on the run, a simple intersection with installments options configured by every seller will be available. When `true`, this option allows a more complex but flexible installment option, since it considers max installments of every seller configuration, even if those don't match. Installment values \u200b\u200bmay not be equal in this case."
    },
    "blockPaymentSession": {
      "type": "boolean",
      "description": "Indicates whether shoppers can add credit cards in your store's `My Account` section."
    }
  },
  "example": {
    "requiresAuthenticationForPreAuthorizedPaymentOption": false,
    "allowInstallmentsMerge": false,
    "blockPaymentSession": false
  }
}