---
page_source: https://juspay.io/in/docs/upi-merchant-stack/docs/mandates/web-notify
page_title: Web Notify
---

## API Version: default


## **Web Notify** 



This api will be used for notifying the Payer by the Merchant prior to the execution.## Endpoints:
- Production: {{host}}/api/{{uri}}/merchants/mandates/webNotify

## Request Type: 
POST

## Headers:

#### jpupi-routing-id:
Header value should be same as of **originalMerchantRequestId**  sent in request body
- Tags: String, Mandatory
## Sample Code Snippets:
### Code Snippets:

#### Shell Code Snippet:

```shell
{"success":false,"message":"No Data found for the given path"}
```

### Sample Request and Response:

#### Request:
```json
{"success":false,"message":"No Data found for the given path"}
```

#### Response:
```json
{"success":false,"message":"No Data found for the given path"}
```

## Body Parameters:
### Request parameters:

#### amount:
- Description: Amount for which customer is notified for execution.

Constraints:Amount in two decimals. Decimals are mandatory.
- Value: value
- Tags: String, Mandatory

#### mandateExecutionTimestamp:
- Description: Mandate execution timestamp (Future Timestamp on which mandate will be executed)

Format:String with proper date format (YYYY-MM-DDTHH:MM:SS+05:30)
- Tags: String, Mandatory

#### merchantRequestId:
- Description: Merchant generated unique id for for the Notification.

**Constraint:** Max 35 characters alphanumeric, can also contain hyphen(-), dot(.) & underscore(_)
- Tags: String, Mandatory

#### remarks:
- Description: Remarks sent by merchant for notify mandate

**Constraint:** The transaction note must be alphanumeric, with a **minimum length of 1 character and a maximum length of 50**  characters.
- Tags: String, optional

#### umn:
- Description: umn returned in create mandate callback

Constraints:35 character alphanumeric unique id.
- Tags: String, Mandatory

#### iat:
- Description: Current Epoch Unix timestamp string. Has to be of 13 digit in Milliseconds.

Example: 1496918882000.
- Tags: String, Mandatory

#### originalMerchantRequestId:
- Description: Merchant request of the **original create mandate request.** 
- Tags: String, Optional But Mandatory For New Integration

#### udfParameters:
- Description: Merchant Defined Parameters

Example: "{\"udf1\":\"value1\",\"udf2\":\"value2\",…}"**Note** : Few special characters are not allowed. Regex for the characters which are not allowed : **^[^/#-()*!%~`]+$** 
- Tags: Stringified JSON, Optional
## API Responses:
### 200:

#### status:
- Description: Status of the API.

**Values:** SUCCESS, FAILURE
- Tags: String, Mandatory

#### responseCode:
- Description: PSP response code for the API.

**Values:** Refer Codes Guide in Resource Section.
- Tags: String, Mandatory

#### responseMessage:
- Description: PSP response message for the API.

**Values:** Refer Codes Guide in Resource Section.
- Tags: String, Mandatory

#### payload:
- Value:
  - **Amount**:
    - Description: Amount for which customer is notified for execution.
      
      **Values:** As passed in request
    - Tags: String, Mandatory
  - **GatewayResponseCode**:
    - Description: Response code returned by gateway for the notification.
    - Tags: String, Mandatory
  - **GatewayResponseMessage**:
    - Description: Response message returned by gateway for the notification.
    - Tags: String, Mandatory
  - **GatewayResponseStatus**:
    - Description: Response status returned by gateway.
      
      **Values:** PENDING, FAILURE
    - Tags: String, Mandatory
  - **GateWayTransactionId**:
    - Description: upiRequestId as passed in request
    - Tags: String, Mandatory
  - **MerchantChannelId**:
    - Description: Unique id for the channel via which request is made.
      
      **Values:** As passed in request.
    - Tags: String, Mandatory
  - **MerchantId**:
    - Description: Unique id for merchant.
      
      **Values:** As passed in request.
    - Tags: String, Mandatory
  - **MerchantRequestId**:
    - Description: Merchant generated unique id for collect request.
      
      **Constraint** : Max 35 characters & Alphanumeric.
    - Tags: String, Mandatory
  - **NextExecution**:
    - Description: Mandate execution timestamp (Future Timestamp on which mandate will be executed)
      
      **Values:** As passed in request
    - Tags: String, Mandatory
  - **OrgMandateId**:
    - Description: gatewayMandateId returned in create mandate
      
      **Values:** As passed for gatewayMandateId in webMandate request.
    - Tags: String, Mandatory
  - **Remarks**:
    - Description: Any mandate notification summary. If pssed in request, it will be same in response else a default value is send.
    - Tags: String, Mandatory
  - **Umn**:
    - Description: umn returned in create mandate callback
      
      **Values:** As passed in request
    - Tags: String, Mandatory
  - **SeqNumber**:
    - Description: Sequence Number of Mandate execution
    - Tags: String, optional
- Tags: json, Mandatory

#### udfParameters:
- Description: Merchant Defined Parameters

Example: "{\"udf1\":\"value1\",\"udf2\":\"value2\",…}"
- Tags: Stringified JSON, optional