v2: Query Status with your Reference

The endpoint described here allows you to query transaction status with the payment reference you provided at payment initialization.

Query Transaction Status

GET https://app.collecta.com.ng/query/statuswithmyreference

Query Transaction Status with your unique reference

Query Parameters

NameTypeDescription

transactionRef

string

Your unique transaction reference

merchantId

boolean

Your merchant ID provided to you at registration

Headers

NameTypeDescription

Hash

string

SHA256 of Amount in two decimal places + MerchantID + SecretKey

{
    "status": "success",
    "data": 
    {
      "AmountPaid": "100000.00",
      "FriendlyMessage": "Transaction completed successfully",
      "FurtherExplanation": null,
      "IsSuccessful": true,
      "PayerEmail": "email@collecta.net",
      "PayerName": "SOLOMON GRUNDY",
      "PaymentReference_Local": "COLLECTAREFERENCE",
      "PaymentReference_Switch": "SWITCHREFERENCE",
      "ResponseCode": "00",
      "ResponseDescription": "Approved By Financial Institution",
      "TransactionDate": "02/06/2018",
      "TransactionType": "Goods Purchase"
    }
}

JSON of status and data. data will carry transaction response object if call is successful, if not, it will carry a string representation of the error message. Even if status is success, always look out for the IsSuccessful property of the data object which must be true to show that the transaction is fully successful.

Always look out for the IsSuccessful property of the data object in the response. A status=success alone is not enough to determine that your transaction is successful

Its always a good practice to log all responses from Collecta for future reference.

Last updated