Transaction Status Verification

In some situations, the merchant might wish to confirm the status of the transaction. This document resource describes the process of retrieving the transaction details (status inclusive)

Whenever we get the final transaction status from the processor (telecom/bank etc), we'll send the notifications to your designated callback URLs and these requests will be retried using the exponential back-off strategy. This guarantees that even when your URL is unreachable OR the http request fails, there will be automated retries at different intervals. Our belief is that; if we don't have the final status yet, checking status from the merchant side doesn't help. However, if status check is crucial for your workflow, please note the following.

1. Status check requests will be denied if they're done less than 2 minutes from the time the transaction was initiated.

2. We recommend that an interval of 5 minutes is implemented between status check requests for the same transaction.

Get Transaction Status

GET https://gwapisdbx.ellypayapp.com/data/transaction/verify/{reference}

Returns the transaction details and the parameter data.transaction_status holds the current status of the transaction. Replace {reference} with the merchant reference that was used prior when initiating the transaction.

Headers

Name	Type	Description
public-key*	String	The merchant account Public Key

Sample Transaction Status Request

curl https://gwapisdbx.ellypayapp.com/data/transaction/verify/MCTREFT2WMNWZ23SBN6Y \
   -H "Accept: application/json" \
   -H "x-api-version: 1" \
   -H "public-key: your-public-key"

200: Request Successful

{
    "code": 200,
    "status": "success",
    "message": "Request completed successfully.",
    "data": {
        "id": 20760,
        "merchant_reference": "MCTREFT2WMNWZ23SBN6Y",
        "internal_reference": "ELPREFA65BGTFR7NGUXM",
        "transaction_type": "PAYOUT",
        "request_currency": "UGX",
        "transaction_amount": 10000,
        "transaction_currency": "UGX",
        "transaction_charge": 1000,
        "transaction_account": "256777000001",
        "charge_customer": false,
        "total_debit": 11000,
        "provider_code": "mtn_momo_ug",
        "request_amount": 10000,
        "customer_name": "JOHN DOE",
        "transaction_status": "COMPLETED",
        "status_message": "Transaction Completed Successfully"
    }
}

404: Transaction Not Found

{
    "code": 404,
    "status": "error",
    "message": "Transaction with reference: MCTREF2BUBWGEVDZ47DQFH1 Not Found. Contact Support",
    "data": {}
}

403: Request before 2mins grace period

{
    "code": 403,
    "status": "error",
    "message": "Status check denied. Try again after 2 minutes.",
    "data": {}
}

429: Violation of recommended interval

{
    "code": 429,
    "status": "error",
    "message": "Request Failed. Too many requests in a short time.",
    "data": {}
}

Transaction Status Descriptions

Transaction Status	Description
PENDING	The transaction has been logged on the EllyPay platform, awaiting escalation to the last mile processor (telecom, bank etc)
PROCESSING	The transaction is currently being processed and the EllyPay platform is waiting for the final status from the last mile processor
FAILED	The transaction is failed. Reason for failure will always be in the data.status_message parameter.
COMPLETED	The transaction was processed successfully.
CANCELLED	The transaction was cancelled - either by the customer or an admin process