The Katapult Test Developer Hub

Welcome to the Katapult Test developer hub. You'll find comprehensive guides and documentation to help you start working with Katapult Test as quickly as possible, as well as support if you get stuck. Let's jump right in!

Overview

In this guide you will learn how to integrate Katpault with Magento in order to provide a no credit, lease-to-own payment option for your customers.

Before Getting Started

Before beginning your integration, please review the following:

  • Online Checkout Flow
  • Your current checkout process to understand how Katapult will impact operations and customers.
  • Leasable Items
  • Deployment Checklist
  • Confirm all your products have SKUs & item descriptions. Katapult needs these details for an order to be successful. Products without a SKU may result in a failed checkout, typically resulting in the customer being unable to move past the customer validation screen.
  • You should review how attributes are being utilized and if they are being used to collect any additional fees or taxes on orders.
  • Fixed product taxes should also be noted, as they might not pass through correctly on the lease.

Once your agreement has been completed, you will receive an email with your sandbox login credentials and tokens. If you have not received your tokens, please reach out to [email protected].

Supported Versions
2.1.X
2.2.X
2.3.X

Installation

📘

Best Practice

Install the extension in your sandbox or staging environment before pushing it live.
Keep a copy of your Magento store and database to ensure you can revert to the previous version before installing the extension.

Step 1. Download the extension provided by your integration team.

Step 2. Uncompress the archive on your computer // provide link to magento here//

Step 3. Copy the files to the app/code folder of your Magento 2 installation.

Step 4. Open your terminal and go to the Magento 2 root. Run from there the following command:

php bin/magento setup:upgrade

Configuring Katapult Payment Method

Step 1. login in to your Magento Admin portal
Step 2. Stores > Configuration > Sales > Payment Methods > Other Payment OptionsKatapult

Enable payment method

  • Enable Katapult
  • Enable Test Mode
  • Enable log
  • Test Public Token: Tokens supplied by Katapult
  • Test Private Token: Tokens supplied by Katapult
  • Use Test JS Domain https://sandbox.katapult.com/
  • Minimum order amount allowed: Value provided in your integration onboarding email

If these changes do not take effect immediately:

Step 3. Go to Admin Panel > System > Cache Management
Step 4. Flush Magento Cache
Step 5. Sign out.
Step 6. Sign back in to reset permissions.

Have more questions or need help? Email [email protected]

Attribute Update

Step 1. To update items as leasable go to Catalog > Products > find the product(s) that is leasable
Step 2. Go to edit > Find ‘Leasable with Katapult’ > change to Yes - save and update cache
Step 3. Go to Admin Panel > System > Cache Management
Step 4. Flush Magento Cache

Testing

Merchant Testing
We recommend that your team completes thorough testing. You can find our recommended testing scenarios here. However, you will need to tailor your testing plan specific to your setup and processes.

Katapult Testing
After completing the installation and configuration, we will coordinate testing with your team. Katapult will need to complete testing in your development environment before going live in production.

Deployment

Once testing is completed, we will coordinate training and a go live date. Contact your account manager or reach out to [email protected] to coordinate a go live date.

Production Configuration
Once testing is completed Katapult will coordinate providing production tokens and deployment.

  • Disable Test Mode
  • Enable log
  • Live Public Token: Tokens supplied by Katapult
  • Live Private Token: Tokens supplied by Katapult
  • Use Production JS Domain www.katapult.com
  • Minimum order amount allowed: Value provided in your integration onboarding email

Updated about a month ago

Magento


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.