Skip to main content

Status Check

The StatusCheck API provides merchants with the capability to inquire about the status of a specific transaction when they do not receive a proper response message. This API requires the following parameters to be included in the request:

Request Parameters

  • Transaction ID: A unique identifier assigned to the transaction in question.
  • Merchant Code: An identifier that represents the merchant initiating the transaction.
  • Total Amount: The total amount associated with the transaction.
Response Body Format
{
  "transactionId": "su07",
  "merchantCode": "supervendor",
  "totalAmount": "100"
}

For dev please use the following url: https://dev-api.citypay.ekbana.net/api/v2/payment/StatusCheck
For production please use the following url: https://uat-api.citypay.ekbana.net/api/v2/payment/StatusCheck

The API response includes a parameter indicating the status of the transaction. The possible statuses are:

1.Pending: The transaction is still in progress and has not been completed yet.

Response format
{
  "transactionId": "su07",
  "merchantCode": "supervendor",
  "totalAmount": "100"
}

2.Success:

Response format
{
    "merchantCode": "supervendor",
    "transactionId": "su07",
    "totalAmount": "100",
    "referenceId": "01HP3GRRJ50D650M8JH6N07M21",
    "status": "Success"
}

3.Failure

Response format
{
    "merchantCode": "supervendor",
    "transactionId": "su07",
    "totalAmount": "100",
    "referenceId": "234HP3GR345MDJH56GJD54M21",
    "status": "Failure"
}

Merchants can use this API to programmatically check the status of transactions and take appropriate actions based on the returned status. This enhances transaction monitoring, enables timely issue resolution, and contributes to a smoother payment processing experience for both the merchants and their customers.