Request Status

Retrieve the status of a mandate modification request using its merchant mandate reference and request reference. Use this API to track pending revocation requests and verify their outcome.

API Details

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

Authentication

Include the following credentials in the JSON request body:

Parameter / Header	Location	Type	Mandatory	Description
clientId	JSON body	String	Yes	Merchant client ID from the WowPe Dashboard.
secretKey	JSON body	String	Yes	Merchant secret key from the WowPe Dashboard. Keep it on your server.
Content-Type	Header	String	Yes	application/json

Both credential fields must be included in every request.

Request Parameters

The authentication fields above are required in addition to the following parameters:

Parameter	Type	Mandatory	Description
orderId	String	Yes	Merchant mandate reference.
requestRef	String	Yes for revocation status lookup	Request reference returned when the revocation request was submitted.

Sample Request

Request Body

id="x8k2pv"

{
  "clientId": "YOUR_CLIENT_ID",
  "secretKey": "YOUR_SECRET_KEY",
  "orderId": "ORD10001",
  "requestRef": "MM261110113012345678"
}

cURL Request

id="n5w3qa"

curl --request POST '{{BASE_URL}}/mandate-request-status' \
  --header 'Content-Type: application/json' \
  --data-binary '@mandate-request-status.json'

Sample Response

Illustrative response from the supplied integration guide; not a verified UAT capture.

id="r7m4yc"

{
  "statusCode": 1,
  "message": "Success",
  "orderId": "ORD10001",
  "requestRef": "MM261110113012345678",
  "requestType": "REVOKE",
  "requestStatus": "Success",
  "umn": "722710901d824182a759192d859e8c7e@ptyes",
  "amount": "99.00"
}

Response Parameters

Parameter	Type	Description
statusCode	Number	Operation status: 0 = Failed, 1 = Succeeded, 2 = Pending. Interpret the business-status fields separately.
message	String	Operation or plan message. It is not a substitute for the relevant status field.
orderId	String	Merchant mandate reference.
requestRef	String	Modification request reference used for status lookup.
requestType	String	Requested operation. The sample shows REVOKE.
requestStatus	String	Request outcome. The sample shows Success; the complete list of possible values is not specified.
umn	String	Returned unique mandate identifier.
amount	String	Amount returned as a decimal string in the example.

Error Handling

Condition	Handling
statusCode: 0	Operation failed. Inspect the message and any operation-specific status fields.
statusCode: 2	Operation is pending. Use the applicable status endpoint to check the outcome.
Timeout or unknown outcome	Check the existing operation before submitting another mutation.

The supplied integration guide does not define endpoint-specific HTTP status mappings or a complete error response structure. Confirm these in UAT before documenting them.

Important Notes

• Include the common authentication fields, orderId (String), and the returned requestRef (String).
• The requestType field identifies the requested operation, while requestStatus indicates its outcome.
• The sample response shows a successful revocation request. It does not indicate a successful debit.
• The complete list of possible requestStatus values is not specified in the supplied integration guide.
• After a successful revocation request, use the Mandate Details API to verify that mandateStatus is Revoked.
• The integration guide also mentions creation-status lookup using an empty requestRef. However, whether this should be sent as an omitted field, an empty string, or null is not confirmed. Verify the expected request format with the API team before implementing this flow.

What's Next

Use the Mandate Details API to confirm the resulting mandate state.

For a completed revocation, verify that mandateStatus is Revoked.