Configuration Options
This is a complete list of Checkout.js configuration options.
Checkout Details
checkout: { ... }
JavaScript keys | Description | Default |
---|---|---|
totalValue REQUIRED | The payment value displayed in the payment lightbox. | 0 |
currency REQUIRED | The payment currency displayed in the payment lightbox. | USD |
description REQUIRED | Description for checkout | n/a |
items REQUIRED | Payment items details: [ {title: '45 Units', price: 100}, {title: '...', price: ... }, ] | |
recurring | Recurring Options: { billing_cycle: 'month', recurring: true, num_of_payments: 3, start_cycle: new Date().toISOString().split('T')[0] } Possible values for billing_cycle 'day' = Daily 'week' = Weekly 'bi-weekly' = Bi-weekly 'month' = Monthly Installments # num_of_payments - Total number of recurring payments for this subscription. Set num_of_payments: null to schedule payments in perpetuity. Boolean value for recurring. The billing start_cycle is a date from which the billing cycle begins. It marks the starting point for calculating charges or fees associated with the product or service. Fortamt start_cycle (YYYY-MM-DD). | { billing_cycle: null, recurring: false, num_of_payments: null, start_cycle: null } |
customerEmail REQUIRED | The email of the customer. | |
customerFirstName REQUIRED | The First Name of the customer. | |
customerLastName REQUIRED | The First Name of the customer. | |
companyName | The Name of the company | |
phone_number | The Phone Number of the company. This field must contain only numeric input, no other symbols are allowed |
Style Details
style: { ... }
Customize the button
- By default, your 'Pay' button uses the same branding and call to action as configured in the script below.
However, you can:
- Set brand colors, shapes, and fonts to match your website
- Customize your button’s call to action


Button Colors | Hex Code |
---|---|
Blue | # 1D30DD |
Green | # 00b660 |
widgetContainerSelector: 'wrapper-pay-buttons',
style: {
buttonClass: 'btn green-btn btn-block no-overflow',
buttonColor: '#00b660',
buttonLabelColor: '#ffffff',
buttonLabel: 'Pay with US Bank Account'
},
lightBox: {
title: 'Title Pay',
subtitle: 'Sub Title Pay',
logoUrl: "https://your.webSite.com/img/logo.png",
formButtonLabel: 'PAY',
show_cart_summary: false
JavaScript keys | Description | Default |
---|---|---|
buttonColor | HEX value of your chosen button color. | # 00b660 |
buttonLabelColor | HEX value of your chosen button text color. | # ffffff |
buttonLabel | String value that sets the text inside the widget button. | Pay Now |
buttonClass | The .class of the element acting as the parent for the widget button. | Bootstrap class btn btn-block btn-primary |
LightBox Details (Cart Summary)
lightBox: { ... }
JavaScript keys | Description | Default |
---|---|---|
title | The title of your payment form. | |
subtitle | The subtitle of your payment form. | |
logoUrl | The URL of your logo beginning with https. | |
formButtonLabel | String value that sets the text inside the lightbox form's submit button. | |
show_cart_summary | When making a payment via Checkout.js, the 'cart summary' box does not appear by default (i.e., 'false' is the default selection). This parameter is configurable, and you can enable the 'cart summary' to appear by setting its value to 'true.' | false |
redirectUrl | URL for success action. Please insert your redirect URL here. In case of a successful transaction the check info will be sent there. Below you can see the parameters of the check data. check_id number description status paymentToken amount | |
cancelUrl | URL for cancel action |
Updated 5 months ago