Get Transaction Status

{{URL}}/api/cps/v1/getTransactionStatus

This endpoint is used to get the status of a transaction.

AUTHORIZATION

Username	Password
Username	{{USERNAME}}
Password	{{SECRETKEY}}

BODY PARAMS

{
  "transactionReference": "sm23oyr1122"
}

Request Parameters

Name	Type	Description	Optional Mandatory
transactionReference	String	Unique transaction reference ID	true

Example Request

var raw = "{
  "transactionReference": "sm23oyr1122"
}";

var requestOptions = {
  method: 'POST',
  body: raw,
  redirect: 'follow'
};

fetch("{{URL}}/api/cps/v1/getTransactionStatus", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

Response Parameters

Name	Type	Description	Optional Mandatory
amount	Number	Transaction Amount	true
paymentReference	String	Payment reference id	true
transactionDate	String	Transaction date	true
fees	Number	Transaction charge fee	true
currency	String	Transaction currency	true
responseCode	Number	Status code of request	true
responseDescription	Number	Status description of request	true

Example Response

{
  "amount": "2.03",
  "paymentReference": "sm23oyr1122",
  "transactionDate": "06/10/2023 00:28",
  "currency": "NGN",
  "fees": 0.03,
  "channel": "CARD",
  "responseCode": "00",
  "responseDescription": "Transaction Successful"
}

Did you find this page helpful?