Mpgs Query Payment

Test URL

POSThttps://uat.finserve.africa/mpgs-direct-integration/api/v3.1/transactionStatus

Live URL

POSThttps://api-unt.finserve.africa/mpgs-direct-integration/api/v3.1/transactionStatus

This API will query the status of a transaction.

200 Success Response Schema

Field Name	Field Type	Field Descriptions
`status`	`bool`	Response status
`code`	`number`	Response code
`message`	`string`	Response message
`data`	`object`	Response data
`transactionReference`	`string`	Transaction reference
`orderReference`	`string`	The order reference
`paymentTransactionId`	`string`	Payment transaction id
`amount`	`number`	Transaction amount
`charge`	`number`	Transaction charge
`actualAmount`	`number`	Transaction actual amount
`refundedAmount`	`number`	Refunded amount
`stage`	`string`	Transaction stage e.g., REFUND
`state`	`string`	Transaction status e.g., SUCCESS
`cardScheme`	`string`	The card scheme

Example Request

⚠️

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

Signature Formula

transactionReference+orderReference

Example Request

curl --request POST \
     --url https://uat-unt.finserve.africa/mpgs-direct-integration/api/v3.1/transactionStatus \
     --header 'Authorization: {{token}}' \
     --header 'content-type: application/json' \
     --data '
            {
                "transactionReference": "TRANREF0000001",
                "orderReference": "OR8982982928299"
            }
'

Example Response

{
    "status": true,
    "code": 0,
    "message": "Transaction was successful",
    "data": {
        "transactionReference": "TRANREF0000001",
        "orderReference": "OR8982982928299",
        "paymentTransactionId": "1",
        "cardNumber": "512345xxxxxx0008",
        "amount": 100.56,
        "charge": 3.52,
        "actualAmount": 104.08,
        "refundedAmount": 0.0,
        "cardScheme": "MASTERCARD",
        "stage": "PAYMENT",
        "state": "SUCCESS",
        "transactionReceipt": "328523195675"
    }
}

Create Payment Refund Payment