Technical Diagrams

Find technical diagrams, including workflow diagrams, on this page.

Checkout workflow

The Limepay checkout process can be divided into a sequence of steps which all happen within the Limepay iFrame.

Pay in instalments
Full payment
Configure plan
KYC check
Process payment
Process payment
Checkout initialisation
Card capture &
Payment selection
Complete order

Each individual step is its own process, and each must be completed before advancing to the next step. Detailed sequence diagrams of each step can be found below.

Checkout initialisation

CustomerCustomer Checkout PageLimepay Checkout UILimepay APINavigate to the checkout pageLoad checkout.js scriptLimepay.init()Limepay.render()Load assets for checkoutCheck if returning customerLoad saved cardsReturn requested assetsDisplay checkout formCustomer selects payment typeEnter credit card informationCustomerCustomer Checkout PageLimepay Checkout UILimepay API

Full payment

When a customer elects to pay the full amount at checkout, the process is relatively straightforward.

CustomerCustomer Checkout PageLimepay Checkout UILimepay APIClick place orderRequest submitSubmit card detailsTokenise card & process paymentReturn payment tokenReturn payment tokenCustomerCustomer Checkout PageLimepay Checkout UILimepay API

Pay in instalments

When a customer elects to pay in instalments, there are a number of additional sub-steps which are completed within the pay in instalments sequence.

Instalments payments overview

CustomerCustomer Checkout PageLimepay Checkout UILimepay APIEnters credit card informationEnters Email and Phone numberEnters Date of birthDo KYC checkRequest configure pay planalt[Customer had not been KYC'ed][Customer has been KYC'ed]Configure pay planSubmit card and payment plan detailsTokenise card & process payment planReturn payment tokenReturn payment tokenCustomerCustomer Checkout PageLimepay Checkout UILimepay API

KYC check

Limepay performs a lightweight KYC check on customers electing to pay in instalments as part of its responsible lending practices. Customers paying in instalments for the first time through Limepay will have to complete a short ID form, while the check should be imperceptible for customers who have used this option before.

More information about KYC checks, including a detailed description, can be found in the Know Your Customer (KYC) checks documentation pages.

CustomerCustomer Checkout PageLimepay Checkout UILimepay APIEnters credit card informationEnters Email and Phone numberEnters Date of birthSubmit KYC infoDo silent KYC verificationRequest configure pay planRequest configure pay planRequest configure pay planRequest configure pay planPrompt for Basic KYC infoProvide updated KYC infoSubmit updated KYC infoDo KYC verificationloop[Try simple KYC verification at least 2 times]Request configure pay planRequest configure pay planPrompt for ID document infoProvide updated ID document infoSubmit updated ID document infoDo ID document verificationloop[Try ID KYC verification at least 2 times]KYC verification failedKYC verification failedDisplay KYC failedalt[Pass ID KYC verification][Fail ID KYC verification]alt[Pass simple KYC verification][Fail simple KYC verification]alt[Pass silent KYC verification][Fail silent KYC verification]CustomerCustomer Checkout PageLimepay Checkout UILimepay API

Configure Payment Plan

At this step the customer adjusts the instalments payment plan - amounts and dates - to their preference.

CustomerCustomer Checkout PageLimepay Checkout UILimepay APISelect pay plan configurationSubmit pay planRequest configure pay planalt[Valid pay plan][Invalid pay plan]CustomerCustomer Checkout PageLimepay Checkout UILimepay API

Order Completion

After the customer has entered their information and agreed to a payment method and/or plan, the order is completed through e-commerce backend servers and Limepay API secured by the merchant’s secret API key.

CustomerCustomer Checkout PageE-commerce backend serversLimepay APISubmit complete orderCreate orderReturn orderIdMake payment using orderId & payment tokenReturn transactionIdComplete checkoutDisplay completion messageCustomerCustomer Checkout PageE-commerce backend serversLimepay API

Virtual terminal workflows

When using Virtual Terminal, the activation and payment flows have been separated to enable pre-registration of customers.

Activation flow

CustomerCustomer Checkout PageLimepay activation UILimepay APIRequests Email and Phone numberEnters Email and Phone numberSends activation codes to email and phoneEnter activation codesRequests KYC Info (Names, Date of Birth and address)Enters KYC InfoSubmit KYC infoDo KYC verificationNotify success and activatedNotify success and activatedPrompt for ID document infoProvide updated ID document infoSubmit updated ID document infoDo ID document verificationNotify success and activatedNotify success and activatedNotify failure of activationNotify failure of activationalt[Pass ID KYC verification][Fail ID KYC verification]alt[Pass Simple KYC verification][Fail Simple KYC verification]CustomerCustomer Checkout PageLimepay activation UILimepay API

Payment flow

CustomerCashierPoint of sale systemLimepay APICustomer phoneHands over items to be scannedRequests mobile numberProvides mobile numberEnters mobile number, clicks send paymentCreates order requestSMS invoice to MobileNotifies customer of invoice SMS messageClicks link and makes paymentPolls API for payment completionReturns payment statusNotifies Cashier of payment success or failureNotifies customer of payment success or failureCustomerCashierPoint of sale systemLimepay APICustomer phone


Return to documentation home.

Copyright © April Solutions 2023. All right reserved.