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

## API Version: default


## **Web Execute** 



This api will be used for executing the mandate by Merchant to the Payer.

## Endpoints:
- Production: {{host}}/api/{{uri}}/merchants/mandates/webExecute

## 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:
### Basic Params:

#### amount:
- Description: Amount for which mandate is to be executed.

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

#### collectRequestExpiryMinutes:
- Description: Minutes for which request is valid

**Format:** A number between 1 to 64800, both inclusive, in String format.
- Tags: String, Mandatory

#### merchantRequestId:
- Description: Merchant generated unique id for Mandate Execution.

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

#### notificationMerchantRequestId:
- Description: merchantRequestId used during notification. Used for linking notification and execution. 

**Condition:**  Not required in case of 1st Execution with 5 minutes of mandate creation.
- Tags: String, Conditional

#### refCategory:
- Description: Details for refUrl, whether it is 01 (advertisement), 02(Invoice)
- Tags: String, optional

#### refUrl:
- Description: Invoice as sent by merchant or reference to the mandate in the form of url.
- Tags: String, optional

#### remarks:
- Description: Mandate Execute Summary.**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 for create mandate.
- 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

#### purpose:
- Description: For **ONETIME**  MANDATE, **purpose** =**01** For **SBMD** , **purpose=77** 
- Tags: String, Conditional
### Mutual funds params:

#### mutualFundDetails:
- Description: Contains details of Mutual Funds.
- Value:
  - **MemberId**:
    - Description: Member Id with ICCL or ARN_RIA with RTA.
    - Tags: String, Mandatory
  - **UserId**:
    - Description: Client Id with ICCL or USER_CODE with RTA.
    - Tags: String, Mandatory
  - **MfPartner**:
    - Description: One of the below.NSE, BSE, KFIN, CAMS.
    - Tags: String, Mandatory
  - **FolioNumber**:
    - Description: Folio Number of the MF, used for RTA reporting. Mandatory for RTA reporting.
    - Tags: String, optional
  - **OrderNumber**:
    - Description: Unique order number of each MF.
    - Tags: String, Mandatory
  - **Amount**:
    - Description: Individual MF amount within the array of MF being purchased.
      
      (Amount in two decimals. Decimals are mandatory).
    - Tags: String, Mandatory
  - **SchemeCode**:
    - Description: Scheme Code of the MF, used for RTA reporting. Mandatory for RTA reporting.
    - Tags: String, optional
  - **AmcCode**:
    - Description: AMC Code of the MF, used for RTA reporting. Mandatory for RTA reporting.
    - Tags: String, optional
  - **PanNumber**:
    - Description: PAN Number of the user, used for RTA reporting. Mandatory for RTA reporting.
    - Tags: String, optional
  - **InvestmentType**:
    - Description: One of the following: LUMPSUM, SIP.
    - Tags: String, Mandatory
  - **IhNumber**:
    - Description: In-house Number of the SIP.
    - Tags: String, Optional
  - **ApplicationNumber**:
    - Description: Application Number (Partner Reference Number)- ITRN.
    - Tags: String, Optional
- Tags: json String, optional
### Split Settlement Params:

#### splitSettlementDetails:
- Description: Split Settlement details of merchant and partners for this transactions.
- Value:
  - **SplitType**:
    - Description: The type of split for this transaction. Can be AMOUNT,  PERCENTAGE, DEFAULT, LATER.
    - Tags: String, Mandatory
  - **MerchantSplit**:
    - Description: Split share for merchant pool account.
    - Tags: String, optional
- Tags: json String, optional

#### partnersSplit:
- Description: List of partners for which the split needs to be divided with the value.
- Value:
  - **PartnerId**:
    - Description: The LSP id provided by the bank.
    - Tags: String, Mandatory
  - **Value**:
    - Description: Split share for LSP account. Decimal Value.
    - Tags: String, Mandatory
- Tags: String, conditional
## 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 merchant requested the mandate
      
      **Values:** As passed in request.
    - Tags: String, Mandatory
  - **Expiry**:
    - Description: Minutes for which request is valid
      
      **Format:** Timestamp in YYYY-MM-DDTHH:MM:SS+05:30 format, request timestamp plus expiry minutes passed in request.
    - Tags: String, Mandatory
  - **GatewayResponseCode**:
    - Description: Response code returned by gateway for the transaction.
      
      **Values:** 00
    - Tags: String, Mandatory
  - **GatewayResponseMessage**:
    - Description: Response message returned by gateway for the transaction.
    - Tags: String, Mandatory
  - **GatewayResponseStatus**:
    - Description: Response status returned by gateway.
      
      **Values:** SUCCESS,FAILURE,PENDING
    - Tags: String, Mandatory
  - **GatewayTransactionId**:
    - Description: UPI request id returned by gateway for the transaction
      
      **Values:** As passed for upiRequestId 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
  - **NotificationMerchantRequestId**:
    - Description: As passed in the request.
      
      **Values:** 35 character alphanumeric unique id.
    - Tags: String, Mandatory
  - **OrgMandateId**:
    - Description: gatewayMandateId returned in create mandate
      
      **Values:** As passed for gatewayMandateId in webMandate request.
    - Tags: String, Mandatory
  - **PayeeMcc**:
    - Description: MCC code of the merchant
      
      **Values:** 4121
    - Tags: String, Mandatory
  - **RefCategory**:
    - Description: Details for refUrl, whether it is 01 (advertisement), 02(Invoice). It will be same value if passed in request, else a default value of "00" is sent.
      
      **Values:** Numeric String
    - Tags: String, Mandatory
  - **RefUrl**:
    - Description: Reference url for the mandate. It will be same value if passed in request else it will be a default url.
    - Tags: String, Mandatory
  - **Remarks**:
    - Description: Any mandate summary. If pssed in request, it will be same in response else a default value is send.
    - Tags: String, Mandatory
  - **TransactionTimestamp**:
    - Description: Timestamp of when txn request was triggered
      
      **Format:** (YYYY-MM-DDTHH:MM:SS+05:30)
    - Tags: String, Mandatory
  - **Umn**:
    - Description: umn returned in create mandate callback
      
      **Values:** As passed in request.
    - Tags: String, Mandatory
- Tags: json, Mandatory

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

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