API Explorer
MPGS Direct Integration
Create Payment

MPGS Create Payment

Test URL


Live URL


This API will be used to authenticate payments on MPGS. cardNumber and cardSecurity are encrypted using AES encryption then the cypher is base64 encoded.You can find libraries to encrypt on Github

200 Success Response Schema

Field NameField TypeField Descriptions
statusboolResponse status
codenumberResponse code
messagestringResponse message
dataobjectResponse data
secureResstringThis HTML content should be shown to the customer. This will have a value if gatewayRecommendation value is AUTHENTICATION_REQUIRED
gatewayRecommendationstringIndicate if it is 3D secure or not. Possible values: AUTHENTICATION_REQUIRED, AUTHENTICATION_NOT_REQUIRED

Example Request


In the example below, please remember to replace the variables enclosed within curly brackets {{ }} with the actual values.

Signature Formula
Example Request
curl --request POST \
     --url https://uat-unt.finserve.africa/mpgs-direct-integration/api/v3.1/authenticatePayment \
     --header 'Authorization: {{token}}' \
     --header 'content-type: application/json' \
     --data '
            "transactionReference": "TRANREF0000001"

Example Response

Example Response
    "status": true,
    "code": 200,
    "message": "Payment Creation Successful",
    "data": {
        "result": "SUCCESS",
        "checkoutMode": "WEBSITE",
        "session": "SESSION0002493464501E41219786F4",
        "apiOperation": "CREATE_SESSION",
        "id": null,
        "successIndicator": "d19e211361a74de3",
        "payment_link": null