JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Web Execute

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

Request

Response

API Endpoints

Production Link

POST

{{host}}/api/{{uri}}/merchants/mandates/webExecute

                      jpupi-routing-id
                      *
                      

String

Mandatory

Header value should be same as of originalMerchantRequestId sent in request body

Body

                      amount
                      *
                      

String

Mandatory

Amount for which mandate is to be executed.

Constraints:Amount in two decimals. Decimals are mandatory.

                      collectRequestExpiryMinutes
                      *
                      

String

Mandatory

Minutes for which request is valid

Format:A number between 1 to 64800, both inclusive, in String format.

                      merchantRequestId
                      *
                      

String

Mandatory

Merchant generated unique id for Mandate Execution.

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

                      notificationMerchantRequestId
                      
                      

String

Conditional

merchantRequestId used during notification. Used for linking notification and execution.

Condition: Not required in case of 1st Execution with 5 minutes of mandate creation.

                      refCategory
                      
                      

String

optional

Details for refUrl, whether it is 01 (advertisement), 02(Invoice)

                      refUrl
                      
                      

String

optional

Invoice as sent by merchant or reference to the mandate in the form of url.

                      remarks
                      
                      

String

optional

Mandate Execute Summary.

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

                      umn
                      *
                      

String

Mandatory

umn returned for create mandate.

                      iat
                      *
                      

String

Mandatory

Current Epoch Unix timestamp string. Has to be of 13 digit in Milliseconds.

Example: 1496918882000.

                      originalMerchantRequestId
                      
                      

String

Optional But Mandatory For New Integration

Merchant request of the original create mandate request.

                      udfParameters
                      
                      

Stringified JSON

Optional

Merchant Defined Parameters

Example: "{\"udf1\":\"value1\",\"udf2\":\"value2\",…}"

Note: Few special characters are not allowed. Regex for the characters which are not allowed : ^[^/#-()*!%~`]+$

                      purpose
                      
                      

String

Conditional

For ONETIME MANDATE, purpose=01
For SBMD, purpose=77

                      mutualFundDetails
                      
                      

json String

optional

Contains details of Mutual Funds.

                      memberId
                      *
                      

String

Mandatory

Member Id with ICCL or ARN_RIA with RTA.

                      userId
                      *
                      

String

Mandatory

Client Id with ICCL or USER_CODE with RTA.

                      mfPartner
                      *
                      

String

Mandatory

One of the below.
NSE, BSE, KFIN, CAMS.

                      folioNumber
                      
                      

String

optional

Folio Number of the MF, used for RTA reporting. Mandatory for RTA reporting.

                      orderNumber
                      *
                      

String

Mandatory

Unique order number of each MF.

                      amount
                      *
                      

String

Mandatory

Individual MF amount within the array of MF being purchased.

(Amount in two decimals. Decimals are mandatory).

                      schemeCode
                      
                      

String

optional

Scheme Code of the MF, used for RTA reporting. Mandatory for RTA reporting.

                      amcCode
                      
                      

String

optional

AMC Code of the MF, used for RTA reporting. Mandatory for RTA reporting.

                      panNumber
                      
                      

String

optional

PAN Number of the user, used for RTA reporting. Mandatory for RTA reporting.

                      investmentType
                      *
                      

String

Mandatory

One of the following: LUMPSUM, SIP.

                      ihNumber
                      
                      

String

Optional

In-house Number of the SIP.

                      applicationNumber
                      
                      

String

Optional

Application Number (Partner Reference Number)- ITRN.

                      splitSettlementDetails
                      
                      

json String

optional

Split Settlement details of merchant and partners for this transactions.

                      splitType
                      *
                      

String

Mandatory

The type of split for this transaction. Can be AMOUNT, PERCENTAGE, DEFAULT, LATER.

                      merchantSplit
                      
                      

String

optional

Split share for merchant pool account.

                      partnersSplit
                      
                      

String

conditional

List of partners for which the split needs to be divided with the value.

                      partnerId
                      *
                      

String

Mandatory

The LSP id provided by the bank.

                      value
                      *
                      

String

Mandatory

Split share for LSP account. Decimal Value.

Response Body

                      status
                      *
                      

String

Mandatory

Status of the API.

Values:SUCCESS, FAILURE

                      responseCode
                      *
                      

String

Mandatory

PSP response code for the API.

Values: Refer Codes Guide in Resource Section.

                      responseMessage
                      *
                      

String

Mandatory

PSP response message for the API.

Values: Refer Codes Guide in Resource Section.

                      payload
                      *
                      

json

Mandatory

                      amount
                      *
                      

String

Mandatory

Amount for which merchant requested the mandate

Values:As passed in request.

                      expiry
                      *
                      

String

Mandatory

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.

                      gatewayResponseCode
                      *
                      

String

Mandatory

Response code returned by gateway for the transaction.

Values:00

                      gatewayResponseMessage
                      *
                      

String

Mandatory

Response message returned by gateway for the transaction.

                      gatewayResponseStatus
                      *
                      

String

Mandatory

Response status returned by gateway.

Values:SUCCESS,FAILURE,PENDING

                      gatewayTransactionId
                      *
                      

String

Mandatory

UPI request id returned by gateway for the transaction

Values:As passed for upiRequestId in request.

                      merchantChannelId
                      *
                      

String

Mandatory

Unique id for the channel via which request is made.

Values:As passed in request.

                      merchantId
                      *
                      

String

Mandatory

Unique id for merchant.

Values:As passed in request.

                      merchantRequestId
                      *
                      

String

Mandatory

Merchant generated unique id for collect request.

Constraint: Max 35 characters & Alphanumeric.

                      notificationMerchantRequestId
                      *
                      

String

Mandatory

As passed in the request.

Values:35 character alphanumeric unique id.

                      orgMandateId
                      *
                      

String

Mandatory

gatewayMandateId returned in create mandate

Values:As passed for gatewayMandateId in webMandate request.

                      payeeMcc
                      *
                      

String

Mandatory

MCC code of the merchant

Values:4121

                      refCategory
                      *
                      

String

Mandatory

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

                      refUrl
                      *
                      

String

Mandatory

Reference url for the mandate. It will be same value if passed in request else it will be a default url.

                      remarks
                      *
                      

String

Mandatory

Any mandate summary. If pssed in request, it will be same in response else a default value is send.

                      transactionTimestamp
                      *
                      

String

Mandatory

Timestamp of when txn request was triggered

Format:(YYYY-MM-DDTHH:MM:SS+05:30)

                      umn
                      *
                      

String

Mandatory

umn returned in create mandate callback

Values:As passed in request.

                      udfParameters
                      
                      

Stringified JSON

optional

Merchant Defined Parameters

Example: "{\"udf1\":\"value1\",\"udf2\":\"value2\",…}"