a1pay
  • Introduction
  • Request Authentication
  • User Login
  • User Signup
  • List User's Transactions
  • Initialize Payment
  • List User's Cards
  • Query a Transaction
  • Requery a Transaction
  • Charge Card
  • OTP Validation
  • Accept Payment Using A1Pay
    • Introduction
    • Initialize Payment
    • Query Status With Your Reference
    • Query Status With A1Pay Reference
    • Sample Integration Codes
Powered by GitBook
On this page
  1. Accept Payment Using A1Pay

Query Status With Your Reference

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

Get Transaction Status

GET https://a1pay.net/api/query/statuswithmyreference

Get transaction status using your unique transaction reference

Query Parameters

Name
Type
Description

transactionRef

string

Your unique transaction reference

merchantId

string

Your Merchant ID provided to you at registration

Headers

Name
Type
Description

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@a1pay.net",
      "PayerName": "SOLOMON GRUNDY",
      "PaymentReference_Local": "A1PAYREFERENCE",
      "PaymentReference_Switch": "SWITCHREFERENCE",
      "ResponseCode": "00",
      "ResponseDescription": "Approved By Financial Institution",
      "TransactionDate": "02/06/2018",
      "TransactionType": "School Fees"
    }
}

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 A1Pay for future reference.

PreviousInitialize PaymentNextQuery Status With A1Pay Reference

Last updated 4 years ago