​
Confirm Transaction Status

This API is used to verify payment status. It’s important to verify all transactions before updating your customer about the status of their payment to ensure accurate and timely information.

​
Request parameter

Request
curl --request GET \
  --url https://adapter.cepta.co/api/v1/pay/confirm-status?TransactionRef=exampleRef \
  --header 'Authorization: <SECRET_KEY>' \
  --header 'Content-Type: application/json' \

Ensure secure handling of md (merchant data) and token to maintain transaction integrity.

​
Confirm transaction API Response

A sample response of what to expect when a call is made to confirm API status

Success response
{
  "status": true,
  "message": "Transaction status retrieved successfully.",
  "data": {
    "responseCode": "00",
    "responseDescription": "Transaction completed successfully.",
    "transactionReference": "exampleRef",
    "amount": 100.00,
    "remittanceAmount": 95.00,
    "customerName": "John Doe",
    "bank": "Bank of Example",
    "status": "Completed",
    "submitTimeUtc": "2024-11-29T12:30:00.000Z",
    "clientReferenceInformation": "Client123",
    "accountName": "John Doe",
    "accountNo": "123456****",
    "maskedPan": "4111********1111",
    "cardExpiry": "12/25",
    "transactionId": "TRX12345",
    "completedTimeUtc": "2024-11-29T12:45:00.000Z",
    "errors": []
  }
}

​
Handling successful API response.

When a transaction has been initiated successfully, the API returns response data that can be used to update the customer about the current stage of their transaction.

Below is the list of responses you can expect and their usage:

​
status
boolean

Indicates if the request was successful.

​
message
string

Descriptive message about the result.

​
data
object

Contains detailed transaction status.

​
responseCode
string

Response code from the payment processor

​
responseDescription
string

Description of the response

​
tokenExpiryDate
string (ISO 8601)

Expiry date of the token.

​
transactionReference
string

Reference of the queried transaction.

​
transactionRef
string

Reference of the validated transaction

​
amount
number

Transaction amount.

​
remittanceAmount
number

Amount remitted after charges or deductions

​
customerName
string

Name of the customer.

​
bank
string

Bank involved in the transaction.

​
status
string

Status of the transaction

​
submitTimeUtc
string (ISO 8601)

UTC time when the transaction was submitted

​
clientReferenceInformation
string

Client reference information related to the transaction.

​
accountName
string

Client reference information related to the transaction.

​
accountNo
string

Account number used, partially masked.

​
maskedPan
string

Masked card number (PAN).

​
cardExpiry
string

Expiry date of the card used.

​
transactionId
string

Unique transaction identifier.

​
completedTimeUtc
string (ISO 8601)

UTC time when the transaction was completed

​
errors
array

Array of error objects, if any.

​
errorCode
string

Specific error code, if applicable.

​
message
string

Description of the error.

​
Handling failed API response

When your response message is returned as a failed response, the response.data will return an array containing details of the error. You can show this to your customer to notify them of what went wrong.

Below is a sample failed response data:

Failed response
{
  "status": false,
  "message": "Transaction not found.",
  "data": {
    "errors": [
      {
        "errorCode": "TRANSACTION_NOT_FOUND",
        "message": "No transaction found for the provided reference."
      }
    ]
  }
}
Validate Transaction OTPOverview