Notify Status

This API retrieves the status of a pre-debit notification for an existing debit, along with its associated transaction status and reference details.

API Details

Parameter	Value
Method	POST
Endpoint	/mandate-notify-status
Base URL	{{BASE_URL}}
Content-Type	application/json

Authentication

Include the following credentials in the JSON request body. These credentials are available in the WowPe Dashboard.

Parameter	Location	Type	Mandatory	Description
clientId	Request Body	String	Yes	Merchant Client ID provided in the WowPe Dashboard.
secretKey	Request Body	String	Yes	Merchant Secret Key provided in the WowPe Dashboard.

Request Header

Header	Value
Content-Type	application/json

Request Parameters

The following parameter is required in addition to the authentication credentials.

Parameter	Type	Mandatory	Description
debitId	String	Yes	Unique reference of the debit for which the notification status is being checked.

Sample Request

JSON

{
  "clientId": "YOUR_CLIENT_ID",
  "secretKey": "YOUR_SECRET_KEY",
  "debitId": "ORDMANUAL01-D1"
}

cURL Request

Bash

curl --request POST '{{BASE_URL}}/mandate-notify-status' \
  --header 'Content-Type: application/json' \
  --data '{
    "clientId": "YOUR_CLIENT_ID",
    "secretKey": "YOUR_SECRET_KEY",
    "debitId": "ORDMANUAL01-D1"
  }'

Replace {{BASE_URL}} with the applicable WowPe API environment URL and use your merchant credentials securely.

Sample Response

Success Response

JSON

{
  "statusCode": 1,
  "message": "Mandate Operation Successful",
  "debitId": "ORDMANUAL01-D1",
  "amount": "99.00",
  "notifyStatus": "Success",
  "txnStatus": "NotInitiated",
  "executeRef": null,
  "yppReferenceNumber": null,
  "rrn": null,
  "executionDateTime": "2026-11-05T10:00:00",
  "executedDateTime": null
}

Response Parameters

Parameter	Type	Description
statusCode	Number	Indicates the API operation status. 0 = Failed, 1 = Succeeded, 2 = Pending.
message	String	Provides the response message for the notification operation.
debitId	String	Debit reference associated with the notification.
amount	String	Debit amount, returned as a decimal string.
notifyStatus	String	Notification status: NotSent, Pending, Success, or Failed.
txnStatus	String	Debit transaction status: NotInitiated, Pending, Success, or Failed.
executeRef	String / Null	Execution request reference, when available.
yppReferenceNumber	String / Null	Provider reference number, when available.
rrn	String / Null	Bank reference number used for transaction tracing.
executionDateTime	String	Scheduled date and time for debit execution.
executedDateTime	String / Null	Actual date and time of debit execution, when available.

Error Handling

Status Code	Description	Action
0	API operation failed.	Check the response message and review the request parameters.
2	API operation is pending.	Use the relevant status API to track the operation outcome.

If a request times out or its outcome is unknown, check the existing operation before submitting another request.

Important Notes

• Use the same debitId that was submitted in the Pre-debit Notify API.
• notifyStatus: "Success" indicates that the pre-debit notification was successful. It does not mean the debit was completed.
• In the sample response, txnStatus: "NotInitiated" indicates that the debit has not yet been initiated.
• Use the Execute Status API to track the debit outcome.
• Fields such as executeRef, yppReferenceNumber, rrn, and executedDateTime may be null or unavailable until the corresponding transaction details are generated.
• Preserve rrn as a string when storing or processing the reference.

What's Next

Use the Execute Status API to track the debit transaction and confirm whether the payment has been successfully completed.