<forms:paymentmethod>
AJAX
ajax:delayedload ajax:event ajax:navigation ajax:region
Data
data:calendar data:column data:eventrepeater data:postrepeater data:productbrandrepeater data:productcategoryrepeater data:productrepeater data:repeater data:table data:template data:tree
Forms
forms:address forms:captcha forms:checkbox forms:checkboxgroup forms:codeeditor forms:combobox forms:datepicker forms:dialogbox forms:editbox forms:fileupload forms:form forms:hidden forms:money forms:officeuseregion forms:option forms:password forms:paymentmethod
DESCRIPTION
ATTRIBUTES
amount
autoFocus
completeCart
dataColumn
disabled
height
id
invoiceCompany
isManual
name
onChange
paymentMethod
productId
productTitle
recurring
recurringAmount
recurringInterval
recurringIntervalNumber
saveState
showPaymentFormOnZeroValue
transformations
validations
width
onSuccessServer
EXAMPLES
Custom Product Payment Form
forms:radiobutton forms:radiobuttongroup forms:row forms:searchbox forms:signature forms:slider forms:spinbox forms:submitbutton forms:submitimage forms:submitlink forms:successcontent forms:textarea forms:timepicker
Layout
layout:gallery layout:productgallery layout:rotator layout:stepper layout:stepperpanel layout:tablist layout:tablistitem
Logic
logic:dependency logic:else logic:if logic:include logic:parse logic:variable
Navigation
navigation:breadcrumbs navigation:item navigation:primary navigation:secondary
Personalisation
personalisation:firstname personalisation:fullname personalisation:lastname personalisation:other
Standard
standard:embed standard:icon standard:image standard:link standard:script standard:tooltip standard:video
Templates
templates:button templates:card templates:column templates:fancybox templates:faq templates:flexlayout templates:header templates:row templates:section templates:styles templates:teammember templates:testimonial
Regions
regions:content regions:contentadditional regions:security regions:togglable
Third Party
thirdparty:googlemap thirdparty:googlemapmarker

`<forms:paymentmethod />`

Creates a payment method control to be used at the end of a Form.

Related Tutorials

Attributes

- `amount`
float
The amount to be processed
- `autoFocus`
bool
Auto Focus

If true, this control will attempt to focus itself after the page has loaded. Note that only one element may be focused on the page at a time.
Default = false
- `completeCart`
bool
Determines if the control should add the event handler to complete the cart on the form
- `dataColumn`
Sets the data column

The datacolumn links the form item to a key used when getting or saving from a component (as defined by the parent form).
- `disabled`
bool
Disable Input

Disables the input, preventing user interaction
- `height`
string
Height

Sets the height of the element. The default units are pixels. include the percentage symbol % to user percentage values.
- `id`
string
Most form items need a unique id so that they can submit data to the server. No two form items may have the same id. For situations where multiple form items submit to the same field, see the name attribute. Id's that begin with contact_ will automatically save Contact information to the Contact database as long as the user has entered enough identifying information (ideally Name and Email). Check the Contact Fields page for correct field names.
- `invoiceCompany`
bool
Set to true if you have a preference of invoicing a company
- `isManual`
bool
Determines if the control is used for a manual receipt
- `name`
string
Sets the name of the form item. Most of the time, the id attribute will suffice. However, with form items that post multiple values into an array, each item will need to have the same name, followed by []. For example three controls with name="data[]", will all post into 'data'.
Radio buttons belonging to the same group will have to share the same name.
- `onChange`
string
JavaScript to be executed when the selected payment method is changed
- `paymentMethod`
If a payment method is specified, do not allow the user to choose
- `productId`
int
Specify to add a product to the cart
- `productTitle`
string
Specify to add a product to the cart
- `recurring`
bool
When true, forces the recurring billing form to show
- `recurringAmount`
float
The recurring amount to be processed
- `recurringInterval`
string
The recurring interval/frequency

week, month, year
- `recurringIntervalNumber`
int
The recurring interval/frequency number

Eg - recurringintervalnumber="2" recurringinterval="week" will bill every 2 weeks
- `saveState`
bool
Restore state on reload

Whether the value of the input persists when the page is revisited.
Default = false
- `showPaymentFormOnZeroValue`
bool
Should a payment form be shown when there is no value in the cart

If set to false, then a button showing "Confirm Order" will be displayed.
Used when products are added to the cart upon form submission.
- `transformations`
Value Transformations

Sets the value transformations to be applied to the value of the form item as a comma separated string.
- `validations`
Validations

Sets the validations to be applied to the value of the form item as a comma separated string.

Eg: validations="mandatory"

When no validations attribute value is set, the form item is optional.
- `width`
string
Width

Sets the width of the element. The default units are pixels. include the percentage symbol % to user percentage values.
- `onSuccessServer`
callable
Called after payment was successfully taken or the cart completed

Tutorials

It is often a requirement of non-profits and membership organisations to accept donations on their website.

1) Build a Form

The form contains a <forms:paymentmethod> control and calls a function donate() on submit.

<forms:form id="donation_form" onsubmitredirect="/commerce/order/success/?sale_id=[? $sale_id ?]" contactmode="store" onsubmitserver="donate($this.getValuesForComponent())"> <forms:row label="Full Name"> <forms:editbox id="contact_first_name" width="100" datacolumn="contact_first_name" validations="mandatory" /> <forms:editbox id="contact_last_name" width="120" datacolumn="contact_last_name" validations="mandatory" /> </forms:row> <forms:row label="E-Mail Address"> <forms:editbox id="contact_email" width="200" datacolumn="contact_email" validations="mandatory" /> </forms:row> <forms:address validations="mandatory" /> <forms:row label="Contact Phone"> <forms:editbox id="contact_phone" validations="mandatory" /> </forms:row> <forms:row description="Indicate the amount to donate" label="Donation Amount"> <forms:money id="donation_amount" width="100" datacolumn="donation_amount" validations="mandatory" align="left" /> </forms:row> <br /> <forms:paymentmethod showpaymentformonzerovalue="true" /> </forms:form>

2) Server Code

In your page's Source > PHP tab, this is where the donate() function is declared. 
You can add items to the cart here with a custom amount.

<?php function donate($arrValues) { \Components\Commerce\Carts\Current::removeAllItems(); if(!isset($arrValues['donation_amount']) || !intval($arrValues['donation_amount'])) { $pException = new \Framework\Exceptions\Validation(); $pException->setTitle('You must enter an amount and type of donation!'); throw $pException; } $strDonationTitle = 'Donation'; $arrProduct = ['product_id' => null, 'product_title' => $strDonationTitle, 'product_price' => $arrValues['donation_amount'], 'product_tax_percent' => 0]; \Components\Commerce\Carts\Current::addProduct($arrProduct); } ?>

Examples

Custom Product Payment Form

Demonstrates a form that generates a Sale Invoice of a custom product

HTML:

 <forms:form recordsubmissions="true" contactmode="store" id="buy_ebook" method="ajax"> <forms:row label="First Name" type="two_column"> <forms:editbox id="contact_first_name" validations="mandatory" /> </forms:row> <forms:row label="Last Name" type="two_column"> <forms:editbox id="contact_last_name" validations="mandatory" /> </forms:row> <forms:row label="Email Address" type="two_column"> <forms:editbox id="contact_email" validations="mandatory,email" transformations="tolower" /> </forms:row> <forms:row type="one_column" label=" "> <forms:paymentmethod amount="19.99" producttitle="E-book Sample" /> </forms:row> <forms:successcontent> <p style="text-align: center;"> Your order has been submitted. You will receive an e-mail shortly with a copy of your order along with payment information. </p> <p style="text-align: center;">Reference ID: [? $sale_id ?]</p> </forms:successcontent> </forms:form>