Search routes

Search major documentation and API reference routes.

Getting Started

Transaction Types

Afropay supports Direct Integration and Hosted Checkout integration models.

Direct Integration

Best when you want full control over payment UX in web or mobile applications.

  1. 1

    Create Transaction via API

    Your application submits transaction details to Afropay endpoints.

  2. 2

    Customer Receives Prompt

    Customer gets a USSD/payment request on their device.

  3. 3

    Customer Authorizes

    Customer enters PIN and confirms the payment.

  4. 4

    Webhook Notification

    Afropay sends the final payment status to your callback endpoint.

Checkout Page Integration

Best for quick setup when you prefer redirecting users to a hosted checkout flow.

  1. 1

    Create Checkout Transaction

    Create a checkout transaction using the Checkout API.

  2. 2

    Redirect Your Customer

    Redirect your customer to the payment URL returned in the API response.

  3. 3

    Customer Chooses and Authorizes

    The customer chooses a payment method and authorizes the payment.

  4. 4

    Webhook Is Sent

    A webhook is sent to your configured callback URL with the payment status.