Basic Usage
This is the minimum configuration required, without any additional styling, callbacks, or field element placement in HTML markup.
window.Netvalve.initTokenFields({ formSelector: '#payment-form', fields: { cardNumber: { containerSelector: '#card-number-container' }, cardCvv: { containerSelector: '#cvv-container' }, cardExpiry: { containerSelector: '#expiry-container' } } });
Required Fields
formId
(string) ORformSelector
payButtonId
(string) if theonSubmitPayment
callback is providedfields
(if<netvalve-cardnumber>
,<netvalve-cvv>
and<netvalve-expiry>
have not been placed in the HTML markup)
Allowed Properties and Methods
Property | Type | Required | Description | Format / Example |
---|---|---|---|---|
| string | Y* | Provide the form element id. |
|
| string | Y * |
| |
| string | Y * | The submit button element id |
|
| object | Y * | A configuration object for each field. See Field Config below. | { cardNumber: {}, cardCVV: {}, cardExpiry: {} } |
| object | N | Object of css styles. Applies to all fields. Note: css properties are not camelcase. Example: use | { 'font-weight': 'bold' } |
| object | N | Object of css styles. Applies to all field inputs. Note: css properties are not camelcase. Example: use | { border: '2px solid red', 'font-weight': 'bold' } |
| object | N | Applies to all field input placeholders. Note css properties are not camelcase. Example: use | { color: 'black', 'font-weight': 'bold' } |
| string | N | The initial height of the iframe before the form’s input styles are calculated and applied to the form. Default is |
|
| boolean | N | If the form has a submit handler function that processes the form, this property ensures it receives the submit event | true |
| function | N | The callback function invoked after all fields have been encrypted and the payment token ready. | (paymentToken) => { // form submit // logic // goes here } |
| function | N | The callback function invoked for each field after validation occurs (success and fail). | (fieldData) => { // check field // validation // succcess // or // fail } |
Field Configuration
This applies to the individual field objects under the fields
property, see above.
{ cardNumber: {}, // Field Configuration cardCvv: {}, // Field Configuration cardExpiry: {} // Field Configuration }
Property | Type | Required | Description | Format / Example |
---|---|---|---|---|
| string | Y* | A CSS selector for the div container where the field element will be rendered. |
|
| object | N | Object of css styles. Overrides the global/parent | { 'font-weight': 'bold' } |
Example Advanced Implementation
window.Netvalve.initTokenFields({ formSelector: '#checkout .payment-form form', payButtonId: 'submit-button', inputStyles: { 'font-size': '16px', padding: '8px', 'border-radius': '4px', border: '1px solid #ccc' }, invalidStyles: { border: '1px solid red' }, fields: { cardNumber: { containerSelector: '#card-number-container', inputStyles: { 'letter-spacing': '1px' } }, cardCvv: { containerSelector: '#cvv-container' }, cardExpiry: { containerSelector: '#expiry-container' } }, onValidate: (fieldMessage) => { console.log('Field validation:', fieldMessage); }, onSubmitPayment: (paymentToken) => { // Send token to your server console.log('Payment token:', paymentToken); } });