Initiate payment

The endpoint /v1/payment/init is a POST request that initiates a payment. The request body should be in raw format and include the following parameters:

POST /v1/payment/init

Headers

Name	Type	Description
secret-key	string	Your Alexpay secret key
public-key	string	Your Alexpay public-key

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):

Request

For example, you can make a post request to the endpoint above and pass in the raw json data below to create a one-off transaction.

//mobile money method
{
    "currency": "GHS",
    "country": "GH",
    "narration": "payment for XYZ",
   "method": "mobilemoney",
    "amount": 10,
   "webhook_url": "{{webhook_url}}",
    "redirect_url": ""
}
//card payment method
{
    "amount": 5123,
    "country": "GH",
    "currency": "GHS",
    "method": "card",
    "narration": "payment for xyz",
    "operator": "mpgs",
    "redirect_success_url": "https://alexpay-mpgs.vercel.app/api/confirm",
    "redirect_failed_url":"https://alexpay-mpgs.vercel.app/api/failed",
    "webhook_url": "https://webhook.site/13e8283c-0ea0-4d1c-818d-64c747b79635",
    "integration_type": "DIRECT_API"

}

Response

{
    "status": "success",
    "code": 200,
    "message": "success",
    "data": {
        "payment_link": "",
        "reference": "",
        "payment_id": "",
        "status": "pending"
    }
}