Attributes for the Card Hosted Payments Component

Review the attributes for the Card Hosted Payments component.

Required Editions
Available in: Salesforce Billing Winter ‘20 and later

All attributes have a Default value of False and Access value of Global.

NameTypeDescription
paymentProviderStringDefines the source for processing payments. The cardPaymentMethod component requires that this attribute has a value of SalesforceBilling.
transactionTypeStringThe action that the component performs when users select the component’s button. Accepts values of SavePaymentCard or PaymentSale.
transactionParamsObjectAccepts values of amount, accountId, and gatewayId.
emailRequiredBooleanSpecifies whether the Email field is required.
cardHolderNameRequiredBooleanSpecifies whether the Card Holder Name field is required.
cardTypeRequiredBooleanSpecifies whether the Card Type field is required.
expiryMonthRequiredBooleanSpecifies whether the Expiration Month field is required.
expiryYearRequiredBooleanSpecifies whether the Expiration Year field is required.
cvvRequiredBooleanSpecifies whether the CVV field is required.
firstNameRequiredBooleanSpecifies whether the First Name field is required.
lastNameRequiredBooleanSpecifies whether the Last Name field is required.
addressLine1RequiredBooleanSpecifies whether the Address Line 1 field is required.
addressLine2RequiredBooleanSpecifies whether the Address Line 2 field is required.
cityRequiredBooleanSpecifies whether the City field is required.
stateRequiredBooleanSpecifies whether the State field is required.
countryRequiredBooleanSpecifies whether the Country field is required.
postalCodeRequiredBooleanSpecifies whether the Postal Code field is required.
hideCardHolderNameBooleanSpecifies whether the Cardholder Name field is hidden.
hideCardTypeBooleanSpecifies whether the Card Type field is hidden.
hideExpiryMonthBooleanSpecifies whether the Expiration Month field is hidden.
hideExpiryYearBooleanSpecifies whether the Expiration Year field is hidden.
hideCvvBooleanSpecifies whether the CVV field is hidden.
hideSaveForFutureBooleanSpecifies whether the Save for Future field is hidden.
hideAutoPayBooleanSpecifies whether the AutoPay field is hidden.
hideFirstNameBooleanSpecifies whether the First Name field is hidden.
hideLastNameBooleanSpecifies whether the Last Name field is hidden.
hideEmailBooleanSpecifies whether the Email field is hidden.
hideAddressLine1BooleanSpecifies whether the Address Line 1 field is hidden.
hideAddressLine2BooleanSpecifies whether the Address Line 2 field is hidden.
hideCityBooleanSpecifies whether the City field is hidden.
hideStateBooleanSpecifies whether the State field is hidden.
hideCountryBooleanSpecifies whether the Country field is hidden.
hidePostalCodeBooleanSpecifies whether the Postal Code field is hidden.
creditCardInformationLabelBooleanLabel for the Credit Card Information section.
addressInformationLabelBooleanLabel for the Address Information section.
payButtonLabelStringLabel for the Pay button.
cardHolderNameLabelStringLabel for the cardHolderName field.
cardTypeLabelStringLabel for the cardType field.
cardNumberLabelStringLabel for the cardNumber field.
expiryMonthLabelStringLabel for the expiryMonth field.
expiryYearLabelStringLabel for the expiryYear field.
cvvLabelStringLabel for the CVV field.
saveForFutureLabelStringLabel for the saveForFuture field.
autoPayLabelStringLabel for the AutoPay field.
firstNameLabelStringLabel for the firstName field.
lastNameLAbelStringLabel for the lastName field.
emailLabelStringLabel for the email field.
addressLine1LabelStringLabel for the addressLine1 field.
addressLine2LabelStringLabel for the addressLine2 field.
cityLabelStringLabel for the city field.
stateLabelStringLabel for the state field.
countryLabelStringLabel for the country field.
postalCodeLabelStringLabel for the postalCode field.
hideAddressSectionStringSpecifies whether the address section is hidden.
clearFormDataStringClears the component’s form data.