This API retrieves the status of a UPI AutoPay debit transaction, including its execution details and reference numbers.
API Details
| Parameter | Value |
|---|---|
| Method | POST |
| Endpoint | /mandate-execute-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 transaction for which the status is being checked. |
Sample Request
{
"clientId": "YOUR_CLIENT_ID",
"secretKey": "YOUR_SECRET_KEY",
"debitId": "ORDMANUAL01-D0"
}
cURL Request
curl --request POST '{{BASE_URL}}/mandate-execute-status' \
--header 'Content-Type: application/json' \
--data '{
"clientId": "YOUR_CLIENT_ID",
"secretKey": "YOUR_SECRET_KEY",
"debitId": "ORDMANUAL01-D0"
}'
Replace {{BASE_URL}} with the applicable WowPe API environment URL and use your merchant credentials securely.
Sample Response
Success Response
{
"statusCode": 1,
"message": "Your transaction is successful",
"debitId": "ORDMANUAL01-D0",
"amount": "1.00",
"notifyStatus": "NotSent",
"txnStatus": "Success",
"executeRef": "ME261101101630696642",
"yppReferenceNumber": "",
"rrn": "630107361748",
"executionDateTime": "2026-11-01T10:16:30",
"executedDateTime": "2026-11-01T10:16:30"
}
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 debit transaction. |
debitId | String | Unique reference associated with the debit transaction. |
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 or recorded execution date and time. |
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 | Transaction status is pending. | Check the transaction status again to track the outcome. |
If a request times out or its outcome is unknown, check the existing transaction before submitting another debit request.
Important Notes
- Use the same
debitIdthat was submitted when initiating or scheduling the debit. txnStatus: "Success"confirms that the debit transaction was successful.txnStatus: "Pending"indicates that the payment outcome has not yet been confirmed.rrnis the bank reference number used for transaction tracing. Preserve it as a string.yppReferenceNumbermay be returned as null or an empty string. Neither value indicates payment success or failure.- For automatic plans and standalone schedules, use the debit IDs returned by the respective APIs.
- The system may generate retry identifiers with suffixes such as
-R1or-R2. Use the identifiers returned by the API rather than generating retry IDs yourself.
What's Next
Once the transaction status is established, record the final debit outcome and its reference details. To configure recurring collections independently of an automatic plan, proceed to the Create Schedule API.
