Checkout - flow

The Standard Checkout integration allows you to generate a unique, secure payment URL that your customers can use to complete their transactions on the Alexpay-hosted payment page. This is the quickest and simplest way to start accepting payments with minimal backend implementation.

  1. Initialize the Payment: Make a server-side POST request to the payment initialization endpoint:

  2. Redirect the Customer: Upon a successful request, we’ll return a unique link for the payment page. Redirect your customer to this page to complete their payment.

  3. After the Payment: Once the payment is completed, the customer will be redirected back to your provided redirectUrl. You can use this event to confirm the transaction and update your records.

Step 1: Initialize the Payment

Send a server‑side POST request to the payment initialization endpoint.

POST /v1/payment/init

Name
Type
Description

secret-key

string

Your Alexpay secret key

public-key

string

Your Alexpay public-key

//mobile money method
{
    "currency": "GHS",
    "country": "GH",
    "narration": "payment for XYZ",
   "method": "mobilemoney",
    "amount": 10,
   "webhook_url": "{{webhook_url}}",
    "redirect_url": ""
}

Request body

  • currency (string): The currency for the payment

  • country (string): The country for the payment.

  • narration (string): Description or reason for the payment.

  • method (string): The payment method to be used.

  • amount (number): The amount of the payment.

  • reference (string, optional): A unique reference for the transaction. If not provided, the system will generate a unique reference value.

  • webhook_url (string): A URL where notifications about the payment status will be sent.

  • redirect_url (sting):

Step 2: Redirect the Customer

Upon a successful request, we’ll return a paymentLink for the payment page.Redirect the customer to this URL in your browser or mobile app.

Response

Step 3: After the Payment

Once the customer completes the payment on the Alexpay checkout page:

  1. Customer Redirect: The customer is redirected to the redirectUrl you provided in the initialization request.

  2. Query Payment Status: Your server should call the Payment Status endpoint to confirm the final state of the transaction (e.g., success, failed, pending).

  3. Receive Webhook Notification: Alexpay automatically sends a webhook to your configured webhook URL whenever the transaction status changes.

Last updated