Skip to main content

Technical Overview of the Checkout Integration

If you want to use PlanPay to create lay-by payment plans for your customers, you need to integrate your checkout with the PlanPay platform. Here are the steps to build a checkout with PlanPay:

  1. When a customer is ready to checkout on your platform, securely request a checkout session using PlanPay's Checkout API. Include the hold/cart/order ID in the merchantOrderId field to help with reconciliation later on. This can be done by your website or a third-party developer on your behalf.
  2. PlanPay will store and tokenize this checkout information to prevent tampering and will return a unique checkout ID to identify the checkout session. Use the PlanPay widget on your website with the generated checkout ID to allow the customer to preview their order and adjust their payment plan within the parameters you have set.
  3. The customer will be redirected to PlanPay to sign-up or sign-in, confirm their order settings, add or select a payment option, and confirm the checkout settings. They will confirm the payment of their first installment to complete their checkout, and a plan will be created.
  4. After the customer completes the checkout process, they will be redirected back to the designated page. As an additional precaution, the Checkout API can be used to query the deposit status, inventory hold (if applicable), and display any messages to the customer. The merchantOrderId can also be optionally updated with an appropriate order ID from the system for accurate tracking in the PlanPay customer and merchant portals.

We're excited to see your integrations! To help you visualize the checkout workflow, we've provided a flow diagram below.

Checkout Workflow​

info

The PlanCreated webhook can be used to confirm the order and finalize it in the event that the redirect fails or as an alternative to the redirect.