Configuration

Order Lines (Cart)

Providing the contents of the Shopper's cart on the Merchant site allows Connect to determine what items in the cart are leasable and which are not.

Cart (order)

Providing delivery costs and cart item information for the order is required. An order Id is optional, but desired. See the confirmation call back section regarding providing order number and delivery date information to Connect after the checkout process has completed.

Key	Type	Required	Description
`orderId`	string	Optional	`orderId: "5423344523",` The merchant identifier for the order. Your internal reference to the order, that has been generated during order creation.
`deliveryCost`	number	Required	`deliveryCost: 10.99` The total delivery fees/shipping charges for the full order.
`items`	array	Required	`items: []`

Cart (item details)

Providing the unique order line information below allows Connect to determine which items are leasable and present the proper lease-to-own pricing to the Shopper.

Key	Type	Required	Description
`brand`	string	Required	`brand: "Apple",` The brand or manufacturer of the line item.
`description`	string	Required	`description: "iPhone SE 64GB Midnight",` A human readable description of the line item.
`category`	string	Required	`category: "Cell Phones",` A human readable description of the item category.
`identifier`	string	Required	`identifier: "MMX53LL/A",` A unique identifier or SKU for the line item.
`imgUrl`	string	Optional	`imgUrl: "",` The URL to a thumbnail image for the line item. If an URL is not provided, the default Merchant logo will be used.
`unitPrice`	number	Required	`unitPrice: 429.00,` The price for each quantity of the line item.
`tax`	number	Required	`tax: 31.10,` The total sales tax to be collected for all the items in the cart.
`quantity`	number	Required	`quantity: 1,` The total quantity of the line item being purchased.
`condition`	string	Required	`condition: "new",` The condition of the line item(s) being purchased. Allowed values; `"new"`, `"used"`, `"refurbished"`
`deliveryDate`	string	Optional	`deliveryDate: "2023-08-30"` The date that shopper will receive the line item(s). `YYYY-MM-DD`

Connect prefill

Payment card

Connect prefill can populate the payment card information on your checkout page when you share payment field information. See the Experience guide to observe the payment card field prefill capabilities in action.

Using the querySelector() type, a Merchant can allow Connect to "find" (select) the siteConfig elements below and prefill the fields with our virtual card numbers. This creates a seamless checkout experience on your site.

Key	Type	Required	Description
`cardNumber`	string	Optional	`cardNumber: "#card-number-selector",` Use this query selector to allow Connect to prefill a credit card number field with the card number of the Progressive Leasing Virtual Card on the Merchant checkout page.
`cvv`	string	Optional	`cvv: "#cvv-selector",` Use this query selector to allow Connect to prefill a CVV number field with the CVV of the Progressive Leasing Virtual Card on the Merchant checkout page.
`expiration`	string	Optional	`expiration: "#expiration-selector",` Use this query selector to allow Connect to prefill the expiration date field with the expiration date of the Progressive Leasing Virtual Card on the Merchant checkout page.
`name`	string	Optional	`name: "#name-on-card-selector",` Use this query selector to allow Connect to prefill a combined Shopper first and last name field with the name on the Progressive Leasing Virtual Card on the Merchant checkout page.
`address`	string	Optional	`address: "#address-on-card-selector",` Use this query selector to allow Connect to prefill the billing street address on the Merchant checkout page with the address associated with the Progressive Leasing Virtual Card.
`city`	string	Optional	`city: "#city-on-card-selector",` Use this query selector to allow Connect to prefill the billing city on the Merchant checkout page with the address associated with the Progressive Leasing Virtual Card.
`state`	string	Optional	`state: "#state-on-card-selector",` Use this query selector to allow Connect to prefill the billing state on the Merchant checkout page with the address associated with the Progressive Leasing Virtual Card.
`zip`	string	Optional	`zip: "#zip-selector"` Use this query selector to allow Connect to prefill the billing billing zip code on the Merchant checkout page with the address associated with the Progressive Leasing Virtual Card.

Shopper information

When personal data is input by a Shopper on the Merchant site pages, providing this information to Connect prefill allows Connect to prefill the lease application fields as part of the experience, creating a streamlined application flow for the Shopper.

Key	Type	Required	Description
`id`	string	Optional	`Id: "32355323456",` The merchant identifier for the Shopper.
`firstName`	string	Required	`firstName: "John",` The first name of the Shopper.
`lastName`	string	Required	`lastName: "Doe",` The last name of the Shopper.
`email`	string	Required	`email: "[email protected]",`The email address of the Shopper.
`phone`	string	Required	`phone: "5555555554",` The phone number of the Shopper.
`address.shipping`	address	Required	This is the shipping address of the Shopper. See address.
`address.billing`	address	Required	This is the billing address of the Shopper. See address.

Address

Key	Type	Required	Description
`line1`	string	Required	`line1: "123 Main Street",` The street address, line 1.
`line2`	string	Optional	`line2: "Apt. 206",` The street address, line 2.
`city`	string	Required	`city: "No Where",` The city.
`state`	string	Required	`state: "UT",` The state.
`zip`	string	Required	`zip: "84555",` The zip or postal code.
`country`	string	Optional	`country: "United States",` The country.

customer: {
                id: "32355323456",
                firstName: "John",
                lastName: "Doe",
                email: "[email protected]",
                phone: "5555555554",
                address: {
                    shipping: {
                        line1: "123 Main Street",
                        city: "No Where",
                        state: "UT",
                        zip: "84555"
                    },
                    billing: {
                    line1: "321 South Street",
                        city: "Some Where",
                        state: "UT",
                        zip: "85444"
                    }
                }
            },

Callbacks

The below callbacks are used to relay state to the application implementing Connect.

Success

A successful checkout indicates that the Shopper's lease-to-own experience with Connect has completed and they will finalize checkout on the merchant site using the virtual card generated for the lease.

Callback URLs are also provided for the merchant to submit updates to Connect to add an order number and/or expected delivery date to the lease, in cases where they were not able to be provided with the required cart information.

Key	Type	Required	Description
`id`	string	Optional	Unique identifier assigned to the Shopper's lease agreement.
`deliveryConfirmationUrl`	string	Optional	If a delivery date for the Shopper's items was not provided at checkout, the onSuccess callback provides a `deliveryConfirmationUrl` Use the one-time url to provide updated delivery information, such as the expected delivery date. deliveryConfirmationUrl payload: `{ "deliveryDate": "2023-09-22T20:43:16.101Z" }`
`orderConfirmationUrl`	string	Optional	If a order number for the Shopper's items was not provided at checkout, the onSuccess callback provides a `orderConfirmationUrl`. Use the one-time url to provide updated order details information, such as an order ID. orderConfirmationUrl payload: `{ "orderId": "string" }`

Cancel

The onCancel callback will be executed when the shopper exits Connect prior to completing the lease-to-own experience.

Failure

The onFailure callback will be executed when an unrecoverable error occurs during the Connect lease-to-own experience.

Key	Description
`errorMessage`	message to indicate the cause of the error