Skip to content
Last updated

Technical Diagrams

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

Checkout workflow

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

Pay in instalments

Full payment

Checkout initialisation

Card capture &
Payment selection

Process payment

Complete order

KYC check

Configure plan

Process payment

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

April APIApril Checkout UICustomer Checkout PageCustomerApril APIApril Checkout UICustomer Checkout PageCustomerNavigate to the checkout pageLoad checkout.js scriptAprilCheckout.init()AprilCheckout.render()Load assets for checkoutCheck if returning customerLoad saved cardsReturn requested assetsDisplay checkout formCustomer selects payment typeEnter credit card information

Full payment

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

April APIApril Checkout UICustomer Checkout PageCustomerApril APIApril Checkout UICustomer Checkout PageCustomerClick place orderRequest submitSubmit card detailsTokenise card & process paymentReturn payment tokenReturn payment token

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

April APIApril Checkout UICustomer Checkout PageCustomerApril APIApril Checkout UICustomer Checkout PageCustomeralt[Customer had not been KYC'ed][Customer has been KYC'ed]Enters credit card informationEnters Email and Phone numberEnters Date of birthDo KYC checkRequest configure pay planConfigure pay planSubmit card and payment plan detailsTokenise card & process payment planReturn payment tokenReturn payment token

KYC check

April 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 April 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.

April APIApril Checkout UICustomer Checkout PageCustomerApril APIApril Checkout UICustomer Checkout PageCustomerloop[Try simple KYC verification at least 2 times]loop[Try ID KYC verification at least 2 times]alt[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]Enters 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 verificationRequest configure pay planRequest configure pay planPrompt for ID document infoProvide updated ID document infoSubmit updated ID document infoDo ID document verificationKYC verification failedKYC verification failedDisplay KYC failed

Configure Payment Plan

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

April APIApril Checkout UICustomer Checkout PageCustomerApril APIApril Checkout UICustomer Checkout PageCustomeralt[Valid pay plan][Invalid pay plan]Select pay plan configurationSubmit pay planRequest configure pay plan

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 April API secured by the merchant’s secret API key.

April APIE-commerce backend serversCustomer Checkout PageCustomerApril APIE-commerce backend serversCustomer Checkout PageCustomerSubmit complete orderCreate orderReturn orderIdMake payment using orderId & payment tokenReturn transactionIdComplete checkoutDisplay completion message

Virtual terminal workflows

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

Activation flow

April APIApril activation UICustomer Checkout PageCustomerApril APIApril activation UICustomer Checkout PageCustomeralt[Pass ID KYC verification][Fail ID KYC verification]alt[Pass Simple KYC verification][Fail Simple KYC verification]Requests 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 activation

Payment flow

Customer phoneApril APIPoint of sale systemCashierCustomerCustomer phoneApril APIPoint of sale systemCashierCustomerHands 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 failure


Return to documentation home.