Interface: PaymentFormController
Methods
addEventHandlers()
addEventHandlers(
handlers):void
Add event handlers to the form
Parameters
| Parameter | Type | Description |
|---|---|---|
handlers | PaymentFormEventHandlers | The event handlers to add |
Returns
void
mount()
mount(
config,handlers?):void
Initialize the payment form with the payment script
Parameters
| Parameter | Type | Description |
|---|---|---|
config | PaymentFormConfig | Configuration for the form |
handlers? | PaymentFormEventHandlers | Event handlers for form events |
Returns
void
removeHandlers()
removeHandlers():
void
Remove all event handlers currently registered via mount
Returns
void
reset()
reset():
void
Reset the form fields
Returns
void
setFieldType()
setFieldType(
name,type):void
Set the field type for a field
Parameters
| Parameter | Type | Description |
|---|---|---|
name | SpreedlyField | The name of the field |
type | SpreedlyFieldType | The type of the field |
Returns
void
setLabel()
setLabel(
name,label):void
Set the label for a field
Parameters
| Parameter | Type | Description |
|---|---|---|
name | SpreedlyField | The name of the field |
label | string | The label for the field |
Returns
void
setNumberFormat()
setNumberFormat(
format):void
Set the number format for the form
Parameters
| Parameter | Type | Description |
|---|---|---|
format | "plainFormat" | "prettyFormat" | "maskedFormat" | The number format |
Returns
void
setPlaceholder()
setPlaceholder(
name,placeholder):void
Set the placeholder for a field
Parameters
| Parameter | Type | Description |
|---|---|---|
name | SpreedlyField | The name of the field |
placeholder | string | The placeholder for the field |
Returns
void
setStyle()
setStyle(
name,style):void
Set the style for a field
Parameters
| Parameter | Type | Description |
|---|---|---|
name | SpreedlyField | The name of the field |
style | string | The css string to apply to the field |
Returns
void
submit()
submit(
options):Promise<PaymentMethod>
Submit the tokenized payment method to Recharge, will not tokenize the card data again if tokenize has already been called
Parameters
| Parameter | Type | Description |
|---|---|---|
options | PaymentMethodFormOptions | Payment method options including billing address |
Returns
Promise<PaymentMethod>
Result of the submission
tokenize()
tokenize(
cardDetails):void
Tokenize the current card data This triggers the payment script to create a payment method token
Parameters
| Parameter | Type | Description |
|---|---|---|
cardDetails | CardDetailsFirstNameLastName | CardDetailsFullName | Card holder name and expiration |
Returns
void
unmount()
unmount():
void
Clean up and remove event handlers
Returns
void