Execute Status

This API retrieves the status of a UPI AutoPay debit transaction, including its execution details and reference numbers.

API Details

ParameterValue
MethodPOST
Endpoint/mandate-execute-status
Base URL{{BASE_URL}}
Content-Typeapplication/json

Authentication

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

ParameterLocationTypeMandatoryDescription
clientIdRequest BodyStringYesMerchant Client ID provided in the WowPe Dashboard.
secretKeyRequest BodyStringYesMerchant Secret Key provided in the WowPe Dashboard.

Request Header

HeaderValue
Content-Typeapplication/json

Request Parameters

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

ParameterTypeMandatoryDescription
debitIdStringYesUnique 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

ParameterTypeDescription
statusCodeNumberIndicates the API operation status. 0 = Failed, 1 = Succeeded, 2 = Pending.
messageStringProvides the response message for the debit transaction.
debitIdStringUnique reference associated with the debit transaction.
amountStringDebit amount, returned as a decimal string.
notifyStatusStringNotification status: NotSent, Pending, Success, or Failed.
txnStatusStringDebit transaction status: NotInitiated, Pending, Success, or Failed.
executeRefString / NullExecution request reference, when available.
yppReferenceNumberString / NullProvider reference number, when available.
rrnString / NullBank reference number used for transaction tracing.
executionDateTimeStringScheduled or recorded execution date and time.
executedDateTimeString / NullActual date and time of debit execution, when available.

Error Handling

Status CodeDescriptionAction
0API operation failed.Check the response message and review the request parameters.
2Transaction 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 debitId that 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.
  • rrn is the bank reference number used for transaction tracing. Preserve it as a string.
  • yppReferenceNumber may 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 -R1 or -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.