To ensure PCI compliance, we cannot accept raw credit card numbers directly in the API call. Instead, you can use the CardConnect Hosted iFrame Tokenizer to securely collect credit card information. This approach ensures sensitive data is handled in a PCI-compliant manner.
Here’s how you can proceed:
- Use the CardConnect iFrame:
- Integrate the CardConnect Hosted iFrame Tokenizer into your application to collect credit card details securely.
- The iFrame will tokenize the credit card information and return a token and expiry date.
- Documentation: Hosted iFrame Tokenizer
- Here is an example custom form.
- Send Token in API Call:
- Once you have the `token` and `expiry`, include them in the BookQuote API call as part of the payload. This ensures that no sensitive credit card data is transmitted or stored in your system.
- Why We Cannot Take CC Numbers Directly:
- Accepting raw credit card numbers in API calls would violate PCI DSS (Payment Card Industry Data Security Standard) requirements, as it exposes sensitive data to potential security risks. Using the iFrame ensures that your system remains out of PCI scope.
For a working example of the iFrame, you can refer to the CardConnect iFrame Demo.
Note: At this time, only CardConnect/Paystri is supported. Stripe and Authorize.Net are not supported.
Enter the token obtained from the /token endpoint. Use the format: Bearer
Book a Quote
Optional, Sends the Booking Confirmation when converting to a customer
Optional, If the Customer Portal is enabled, sends the create portal account email
Optional, Add to MaidCentral campaigns, if enabled, default is true
Optional, Triggers applied Keap, Zapier, if enabled, default is true
Required
List Scopes of Work to book and create job(s)
The date in which the first job is to be scheduled, defaults to 9:00 AM, pass a timespan with the date to schedule the fob at a different time
Optional, To be included with the first job
Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 6
Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 5
Optional, List of Teams to schedule the job Valid options are supplied via /api/Lead/Teams
Valid options are supplied via /api/Lead/ScopeGroups
Optional, to override the calculated price for this Frequency/Scope
Optional, List of Rate Mods/Adjustments, including discounts Valid options are supplied via /api/Lead/RateModifications?scopeId=
Quantity of the rate modification, must not be 0
Valid options are supplied via /api/Lead/BillingTerms; default is credit card
Optional, the card connect token from Tokenizer IFrame
Optional, the card connect expiry from Tokenizer IFrame, assoiciated with the token
Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 3
Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 4
Book a Quote
Optional, Sends the Booking Confirmation when converting to a customer
Optional, If the Customer Portal is enabled, sends the create portal account email
Optional, Add to MaidCentral campaigns, if enabled, default is true
Optional, Triggers applied Keap, Zapier, if enabled, default is true
Required
List Scopes of Work to book and create job(s)
The date in which the first job is to be scheduled, defaults to 9:00 AM, pass a timespan with the date to schedule the fob at a different time
Optional, To be included with the first job
Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 6
Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 5
Optional, List of Teams to schedule the job Valid options are supplied via /api/Lead/Teams
Valid options are supplied via /api/Lead/ScopeGroups
Optional, to override the calculated price for this Frequency/Scope
Optional, List of Rate Mods/Adjustments, including discounts Valid options are supplied via /api/Lead/RateModifications?scopeId=
Quantity of the rate modification, must not be 0
Valid options are supplied via /api/Lead/BillingTerms; default is credit card
Optional, the card connect token from Tokenizer IFrame
Optional, the card connect expiry from Tokenizer IFrame, assoiciated with the token
Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 3
Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 4
Book a Quote
Optional, Sends the Booking Confirmation when converting to a customer
Optional, If the Customer Portal is enabled, sends the create portal account email
Optional, Add to MaidCentral campaigns, if enabled, default is true
Optional, Triggers applied Keap, Zapier, if enabled, default is true
Required
List Scopes of Work to book and create job(s)
The date in which the first job is to be scheduled, defaults to 9:00 AM, pass a timespan with the date to schedule the fob at a different time
Optional, To be included with the first job
Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 6
Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 5
Optional, List of Teams to schedule the job Valid options are supplied via /api/Lead/Teams
Valid options are supplied via /api/Lead/ScopeGroups
Optional, to override the calculated price for this Frequency/Scope
Optional, List of Rate Mods/Adjustments, including discounts Valid options are supplied via /api/Lead/RateModifications?scopeId=
Quantity of the rate modification, must not be 0
Valid options are supplied via /api/Lead/BillingTerms; default is credit card
Optional, the card connect token from Tokenizer IFrame
Optional, the card connect expiry from Tokenizer IFrame, assoiciated with the token
Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 3
Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 4
Book a Quote
Optional, Sends the Booking Confirmation when converting to a customer
Optional, If the Customer Portal is enabled, sends the create portal account email
Optional, Add to MaidCentral campaigns, if enabled, default is true
Optional, Triggers applied Keap, Zapier, if enabled, default is true
Required
List Scopes of Work to book and create job(s)
The date in which the first job is to be scheduled, defaults to 9:00 AM, pass a timespan with the date to schedule the fob at a different time
Optional, To be included with the first job
Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 6
Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 5
Optional, List of Teams to schedule the job Valid options are supplied via /api/Lead/Teams
Valid options are supplied via /api/Lead/ScopeGroups
Optional, to override the calculated price for this Frequency/Scope
Optional, List of Rate Mods/Adjustments, including discounts Valid options are supplied via /api/Lead/RateModifications?scopeId=
Quantity of the rate modification, must not be 0
Valid options are supplied via /api/Lead/BillingTerms; default is credit card
Optional, the card connect token from Tokenizer IFrame
Optional, the card connect expiry from Tokenizer IFrame, assoiciated with the token
Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 3
Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 4
Book a Quote
Optional, Sends the Booking Confirmation when converting to a customer
Optional, If the Customer Portal is enabled, sends the create portal account email
Optional, Add to MaidCentral campaigns, if enabled, default is true
Optional, Triggers applied Keap, Zapier, if enabled, default is true
Required
List Scopes of Work to book and create job(s)
The date in which the first job is to be scheduled, defaults to 9:00 AM, pass a timespan with the date to schedule the fob at a different time
Optional, To be included with the first job
Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 6
Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 5
Optional, List of Teams to schedule the job Valid options are supplied via /api/Lead/Teams
Valid options are supplied via /api/Lead/ScopeGroups
Optional, to override the calculated price for this Frequency/Scope
Optional, List of Rate Mods/Adjustments, including discounts Valid options are supplied via /api/Lead/RateModifications?scopeId=
Quantity of the rate modification, must not be 0
Valid options are supplied via /api/Lead/BillingTerms; default is credit card
Optional, the card connect token from Tokenizer IFrame
Optional, the card connect expiry from Tokenizer IFrame, assoiciated with the token
Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 3
Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 4
Book a Quote
Optional, Sends the Booking Confirmation when converting to a customer
Optional, If the Customer Portal is enabled, sends the create portal account email
Optional, Add to MaidCentral campaigns, if enabled, default is true
Optional, Triggers applied Keap, Zapier, if enabled, default is true
Required
List Scopes of Work to book and create job(s)
The date in which the first job is to be scheduled, defaults to 9:00 AM, pass a timespan with the date to schedule the fob at a different time
Optional, To be included with the first job
Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 6
Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 5
Optional, List of Teams to schedule the job Valid options are supplied via /api/Lead/Teams
Valid options are supplied via /api/Lead/ScopeGroups
Optional, to override the calculated price for this Frequency/Scope
Optional, List of Rate Mods/Adjustments, including discounts Valid options are supplied via /api/Lead/RateModifications?scopeId=
Quantity of the rate modification, must not be 0
Valid options are supplied via /api/Lead/BillingTerms; default is credit card
Optional, the card connect token from Tokenizer IFrame
Optional, the card connect expiry from Tokenizer IFrame, assoiciated with the token
Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 3
Optional, Valid options are supplied via /api/Lead/Tags with CategoryId = 4
Successful Response
The ID of the Lead
The ID of the Quote
If Booked, the ID of the Customer
If Booked, the ID of the Home
MaidCentral URL for the Partner
The URL to the Online Quoting Form
The URL to the Online Quoting Form to book immediately
If Booked, the Customer Portal Invite URL
The name of the Customer Source
The name of the Billing Terms
The ID of the Scope Group
The name of the Scope Group
List of Scopes of Work
The name of the Scope
List of Frequencies and costs
Quote by Scope and Frequency
If true, this scope/frequency is booked
If true, this scope/frequency is marked as Interested
The name of the Frequency
The minimum cost of this frequency
The adjusted cost, (using rounding settings)
The calculated cost
The amount of time in minutes for this scope/frequency to perform the work
The total recurring cost, including RateModifications
The total first job cost, including RateModifications
The total recurring hours, including RateModifications
The total first job hours, including RateModifications
List of Rate Modifications and costs
How the price is calculated for this frequency
Represents question and answer saved
The type of question (select list, multiple select list, text, number, etc.)
The ID of the Lead
The ID of the Quote
If Booked, the ID of the Customer
If Booked, the ID of the Home
MaidCentral URL for the Partner
The URL to the Online Quoting Form
The URL to the Online Quoting Form to book immediately
If Booked, the Customer Portal Invite URL
The name of the Customer Source
The name of the Billing Terms
The ID of the Scope Group
The name of the Scope Group
List of Scopes of Work
The name of the Scope
List of Frequencies and costs
Quote by Scope and Frequency
If true, this scope/frequency is booked
If true, this scope/frequency is marked as Interested
The name of the Frequency
The minimum cost of this frequency
The adjusted cost, (using rounding settings)
The calculated cost
The amount of time in minutes for this scope/frequency to perform the work
The total recurring cost, including RateModifications
The total first job cost, including RateModifications
The total recurring hours, including RateModifications
The total first job hours, including RateModifications
List of Rate Modifications and costs
How the price is calculated for this frequency
Represents question and answer saved
The type of question (select list, multiple select list, text, number, etc.)
The ID of the Lead
The ID of the Quote
If Booked, the ID of the Customer
If Booked, the ID of the Home
MaidCentral URL for the Partner
The URL to the Online Quoting Form
The URL to the Online Quoting Form to book immediately
If Booked, the Customer Portal Invite URL
The name of the Customer Source
The name of the Billing Terms
The ID of the Scope Group
The name of the Scope Group
List of Scopes of Work
The name of the Scope
List of Frequencies and costs
Quote by Scope and Frequency
If true, this scope/frequency is booked
If true, this scope/frequency is marked as Interested
The name of the Frequency
The minimum cost of this frequency
The adjusted cost, (using rounding settings)
The calculated cost
The amount of time in minutes for this scope/frequency to perform the work
The total recurring cost, including RateModifications
The total first job cost, including RateModifications
The total recurring hours, including RateModifications
The total first job hours, including RateModifications
List of Rate Modifications and costs
How the price is calculated for this frequency
Represents question and answer saved
The type of question (select list, multiple select list, text, number, etc.)
The ID of the Lead
The ID of the Quote
If Booked, the ID of the Customer
If Booked, the ID of the Home
MaidCentral URL for the Partner
The URL to the Online Quoting Form
The URL to the Online Quoting Form to book immediately
If Booked, the Customer Portal Invite URL
The name of the Customer Source
The name of the Billing Terms
The ID of the Scope Group
The name of the Scope Group
List of Scopes of Work
The name of the Scope
List of Frequencies and costs
Quote by Scope and Frequency
If true, this scope/frequency is booked
If true, this scope/frequency is marked as Interested
The name of the Frequency
The minimum cost of this frequency
The adjusted cost, (using rounding settings)
The calculated cost
The amount of time in minutes for this scope/frequency to perform the work
The total recurring cost, including RateModifications
The total first job cost, including RateModifications
The total recurring hours, including RateModifications
The total first job hours, including RateModifications
List of Rate Modifications and costs
How the price is calculated for this frequency
Represents question and answer saved
The type of question (select list, multiple select list, text, number, etc.)
The ID of the Lead
The ID of the Quote
If Booked, the ID of the Customer
If Booked, the ID of the Home
MaidCentral URL for the Partner
The URL to the Online Quoting Form
The URL to the Online Quoting Form to book immediately
If Booked, the Customer Portal Invite URL
The name of the Customer Source
The name of the Billing Terms
The ID of the Scope Group
The name of the Scope Group
List of Scopes of Work
The name of the Scope
List of Frequencies and costs
Quote by Scope and Frequency
If true, this scope/frequency is booked
If true, this scope/frequency is marked as Interested
The name of the Frequency
The minimum cost of this frequency
The adjusted cost, (using rounding settings)
The calculated cost
The amount of time in minutes for this scope/frequency to perform the work
The total recurring cost, including RateModifications
The total first job cost, including RateModifications
The total recurring hours, including RateModifications
The total first job hours, including RateModifications
List of Rate Modifications and costs
How the price is calculated for this frequency
Represents question and answer saved
The type of question (select list, multiple select list, text, number, etc.)