📄️ Technical Overview of the Checkout Integration
Learn about the technical aspects of integrating PlanPay's checkout into your website for creating lay-by payment plans. Securely request a checkout session using PlanPay's Checkout API, store and tokenize checkout information, use the PlanPay widget to allow customers to preview and adjust their order, complete the checkout process, and verify deposit status with the Checkout API.
📄️ Create a PlanPay Checkout Using the Checkout API
Learn how to create a PlanPay checkout via API request using the sandbox endpoint. Follow the Checkout API Schema tables to fill in required properties and use the provided instructions to include an Authorization header. Customize your checkout with optional properties listed in the schema tables.
📄️ Loading the PlanPay Checkout Widget
Learn how to load the PlanPay checkout widget onto your website using the obtained checkout ID. Choose between loading the widget with @planpay/web or with legacy vanilla JavaScript and HTML markup.
📄️ Optimizing the PlanPay Checkout Experience
Learn how to optimize PlanPay checkout widget using. Transfer user details from your website to the planpay widget, and control button appearance.
📄️ Testing Your Checkout Integration
Learn how to test your PlanPay checkout integration as a developer. Simulate a customer checkout process to verify that your integration is working as expected and identify any issues before launching to your customers.
📄️ Completing Your PlanPay Checkout Integration
Congratulations! You have successfully integrated PlanPay into your website. Learn about the next steps, including meeting with your PlanPay account manager, running tests to confirm your integration is working correctly, and obtaining production API keys to start making real production checkouts and plans with PlanPay.
📄️ Checkout Verification Process
Learn how to verify checkout completion and deposit status to ensure that inventory is not allocated until the payment has been accepted by PlanPay. Protect your business from malicious users exploiting the system with our secure checkout verification process. Follow our API guide to make a back-end call to the PlanPay Checkout API using your API key.
📄️ Updating Merchant Order ID (Optional)
Learn how to update the merchantOrderId after order completion in the PlanPay checkout workflow.