Checkout Flow Guide

Documentation Index

Fetch the complete documentation index at: https://docs.afriex.com/llms.txt

Use this file to discover all available pages before exploring further.

​

Overview

Afriex Checkout is a hosted payment experience that allows customers to complete payments using supported methods such as Bank Transfer and Mobile Money. After a merchant creates a checkout session through the API, the customer is redirected to the hosted checkout page to complete payment.

​

Before You Begin

A checkout session must already be created by the merchant or application. The hosted checkout page displays the payment amount, available payment methods, session timer, and payment instructions.

​

Select a Payment Method

The customer sees the available payment methods on the checkout page. Available methods may include:

• Bank Transfer
• Mobile Money

The customer:

• Reviews the payment amount
• Selects a preferred payment method

The checkout session also displays an expiration timer. After selecting a method, the customer follows one of the two payment paths below.

​

Pay by Bank Transfer

When Bank Transfer is selected, Afriex displays one-time bank transfer details for the payment. The page displays:

• Amount to pay
• Bank name
• Account number
• Account name
• Copy account number action
• Payment instructions
• Session expiration timer

Customer actions:

1. Open a banking app, internet banking, or USSD.
2. Transfer the exact amount shown.
3. Return to the checkout page.
4. Wait for automatic payment confirmation.

​

Pay by Mobile Money

When Mobile Money is selected, the customer enters their mobile money details. The page displays:

• Network selector
• Account holder name field
• Mobile money phone number field
• Pay now button

Customer actions:

1. Select a mobile money network.
2. Enter the account holder name.
3. Enter the mobile money phone number.
4. Click Pay now.

Afriex sends a payment authorization prompt to the customer’s phone.

​

Approve the Payment on Your Phone

After the customer clicks Pay now, the checkout page enters a pending state while waiting for payment authorization. The customer:

• Checks their phone
• Approves the mobile money payment prompt
• Waits for the checkout page to update automatically

The session timer continues while Afriex waits for confirmation from the network or payment provider.

​

Payment Outcomes

Regardless of the payment method, the checkout session ends in one of two outcomes.

​

Successful Payment

When payment is confirmed, the customer sees a success message. At this stage:

• The payment has been confirmed
• The customer sees a success confirmation
• The customer is redirected back to the merchant’s redirect URL automatically

​

Failed Payment

If payment cannot be confirmed, the customer sees a failed payment screen. Possible failure reasons include:

• Incorrect transfer amount
• Declined mobile money authorization
• Expired checkout session
• Network or payment provider issue
• Payment could not be confirmed

The customer may:

• Contact support
• Return to the merchant
• Retry payment if the merchant provides a new checkout session

​

Checkout Session Expiration

Checkout sessions have an expiration timer. Customers should complete payment before the session expires. If the session expires, the customer may need to restart checkout or request a new checkout session.

​

Redirect Behavior

After a successful or failed payment, Afriex redirects the customer back to the merchant application depending on the checkout configuration. When payment is confirmed, Afriex also fires a CHECKOUT_SESSION.CREATED webhook to your configured callback URL, so your system can reconcile the payment independently of the redirect.

​

Notes for Merchants

• Customers should pay the exact amount shown on the checkout page.
• Checkout sessions should be tested in sandbox before going live.
• The redirect URL should be configured correctly so customers return to the merchant application after payment.

​

Related