Check transaction status

This endpoint is used to check the status of a payment transaction for refund and payout by its unique identifier. It allows users to retrieve detailed information about a specific transaction.

GET: /v1/payment/:payment_ref

Params

Name	Type	Description
payment_ref	string	The unique identifier of the transaction you want to check.

Headers

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

Response

The response will be in JSON format and will have the following schema:

{
    "status": "success",
    "code": 200,
    "message": "Transaction check completed successfully.",
    "data": {
        "id": "011fcbbf-567***************",
        "amount": 26,
        "charge": 25,
        "environment": "live",
        "type": "payout",
        "method": "mobilemoney",
        "status": "successful",
        "currency": "ZMW",
        "reference": "PY_14f562f9044c4*********",
        "narration": "testing",
        "provider_transaction_id": "011fcbbf-567e-470b-8d21-***********",
        "redirect_url": "",
        "operator": "MTN",
        "customer_details": "",
        "customer": null,
        "business_id": "79ef173f-3b4d-46ee-8c3e-",
        "refunds": [],
        "_": {},
        "is_disbursed": "true",
        "is_fraud_resolved": "false",
        "created_at": "2025-08-26T15:41:42.803503Z",
        "updated_at": "2025-08-26T15:45:30.475315Z"
    }
}