Query payment status

The payment-originating merchant will implement this API function as a web service with the following parameters.

A sample query request to CPG is also provided

NB: It's optional to query for payment status using either beepTransactionID or payerTransactionID in NG (Nigeria), GH (Ghana) & ZM (Zambia).

Request

Parameter	Type	Description	Required
function	string	Function being invoked	yes
countryCode	string	Country ISO code letter, i.e., `KE`,`GH`,`TZ`	yes
payload	object
payload.credentials	object
payload.credentials.username	string	The user name you created on sign-in	yes
payload.credentials.password	string	The Password you created on sign-in	yes
payload.packet	array
payload.packet.beepTransactionID	string	Account number payment is being made. If it’s a mobile number, it should begin with a country code, e.g., 2547xxxxxxxx	no
payload.packet.payerTransactionID	string	The unique `transactionID` generated by the bank for this transaction.	yes

{
  	"function": "BEEP.queryPaymentStatus",
    "countryCode": "NG",
    "payload": {
        "credentials": {
             "username": "testuser",
            "password": "testpass" 
        },
        "packet": [
            {
                "payerTransactionID": "9b3e6093-5f2e-4aa8-8c8d-a9ced56b6097",
                "beepTransactionID": "387566457040408576"
            }
        ]
    }
}

Response

{
	"authStatus": {
		"authStatusCode": 131,
		"authStatusDescription": "Authentication was successful"
	},
	"results": [{
		"statusCode": 178,
		"statusDescription": "The transaction is pending acknowledgement from the client",
		"payerTransactionID": "yourUniqueID",
		"beepTransactionID": "ourUniqueID",
		"MSISDN": "25470000000",
		"payerClientCode": "SANDBOX",
		"receiptNumber": "[\"\"]",
		"receiverNarration": "[\"\"]",
		"totalRecordsPendingQuery": 0,
		"totalRecordsPendingAck": 0,
		"paymentExtraData": "{}"
	}]
}

Transaction status codes returned from the BEEP.pushPaymentStatus.

statusCode	statusDescription
148	Transaction delivered i.e. posted to 3rd party for processing
178	Pending transaction on queryPaymentStatus
183	Payment accepted i.e. Success
180	Payment Rejected i.e. Failed
217	Payment manually Accepted
216	Payment manually Rejected
219	Payment escalated