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

Web Collect 360

This API will be used to send collect notification to respective PSP App of the user.

Mutual Fund Use case:

Mutual Fund information using which the file to be shared with ICCL needs to be created to be passed in this API as a JSON (Refer request params & API format below).

TPV Use case:

For TPV (Third Party Validation) payerAccountHashes needs to be passed in the request body and the same will be passed back in response along with corresponding values. PayerAccountHashes will be taken as an array so that merchants can send multiple account hashes which will be verified against the account details selected by user shared by NPCI.

PSP will reject the request if the customer makes the payment with a different account details and send a failure callback to the merchant.

Split Settlement Use case:

Merchants must enter the split settlement details in the API calls whenever they want to split the payment and process multiple split settlements. Fields in this object (SplitSettlement) are both required and optional. Merchants can utilize these fields to settle to your vendors/partners by numerous categories, such as AMOUNT, PERCENTAGE, DEFAULT, and LATER, with the maximum flexibility possible.

GST Use case: For Stock & GST Merchants

Validity of a payerVpa can be verified using the Verify VPA API.
The payeeVpa should be a valid PSP generated vpa for the merchant.
If refUrl is passed in request, refCategory becomes essential for the API to work. So it's either both as combination or none.

Request

Response

API Endpoints

Production Link

POST

{{host}}/api/{{uri}}/merchants/transactions/webCollect360

                      jpupi-routing-id
                      *
                      

String

Mandatory

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

Body

                      merchantRequestId 
                      *
                      

String

Mandatory

Merchant generated unique id for the transaction.

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

                      payerVpa	
                      *
                      

String

Mandatory

Vpa on which collect request should be triggered.

Example: something@handle.

Constraint: VPA should only contain a-z, 0-9, . (dot), - (hyphen).

                      payerName
                      
                      

String

Optional

Name of the payer.

Constraint: String as returned in the Verify VPA API.

                      payeeVpa
                      *
                      

String

Mandatory

VPA of the merchant to be used for payment.

Example: testmerchant@handle.

Constraint: VPA should only contain a-z, 0-9, . (dot), - (hyphen).

                      collectRequestExpiryMinutes
                      *
                      

String

Mandatory

Minutes for which request is valid.

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

                      amount
                      *
                      

String

Mandatory

Amount of collect request to be sent.

Constraints: Amount in two decimals. Decimals are mandatory.

                      remarks
                      *
                      

String

Mandatory

Any transaction summary.

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

                      purpose
                      
                      

String

optional

Defines the purpose code of the transaction.

Constraints: Refer purpose code list.

                      initiationMode
                      
                      

String

optional

Defines the initiation mode of the transaction.

Constraints:Refer initiation mode list.

                      refUrl
                      
                      

String

optional

Invoice as sent by merchant in the form of url.

                      refCategory
                      
                      

String

optional

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

                      iat
                      *
                      

String

Mandatory

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

Example: 1496918882000.

                      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 : ^[^/#-()*!%~`]+$

                      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 below; LUMPSUM, SIP.

                      ihNumber
                      
                      

String

optional

In-house Number of the SIP.

                      applicationNumber
                      
                      

String

optional

Application Number (Partner Reference Number)- ITRN.

                      payerAccountHashes
                      
                      

Array Of String

optional

Hashed value of accounts to be passed by merchant for TPV.

Hashing logic:

payerAccountHash = sha256( account Number + first 4 digit of account IFSC)
From account Number the leading zeros should be removed and then the hash should be calculated.
Eg: Account No. = 0000123456789 & IFSC = ABCD0000345

Hash will be calculated on 123456789ABCD.

                      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.

                      Split
                      
                      

jSON String

Optional

Split details of GST merchants .

                      name
                      
                      

String

Optional

One of the below:
GST Split name
PURCHASE,CASHBACK, DISCOUNT, GST, CGST, SGST, CESS, IGST, GSTINCENTIVE, TIPS, CONFEE, DISCPCT, CONPCT & GSTPCT.

UPI International Split name
BASEAMOUNT,BASECURR,FX&MKUP.

                      value
                      
                      

String

Optional

Appropriate split value according to split name.

                      invoiceName
                      
                      

String

Optional

Invoice name of the order.

                      invoiceNum
                      
                      

String

Optional

Invoice number of the order.

                      invoiceDate
                      
                      

String

Optional

Date of the invoice of the order.

                      Geocode
                      
                      

String

Optional

Geographical code from where the txn was initiated.

Response Body

                      status
                      *
                      

String

Mandatory

PSP status of the API.

Example:- Values: SUCCESS | FAILURE

                      responseCode
                      *
                      

Mandatory

String

PSP response code for the API.

Values: Refer Codes Guide in Resource Section.

                      responseMessage
                      *
                      

Mandatory

String

PSP response message for the API.

Values: Refer Codes Guide in Resource Section.

                      payload
                      *
                      

Json

Mandatory

                      merchantId
                      *
                      

String

Mandatory

Unique id for the merchant as passed in request headers.

                      merchantChannelId
                      *
                      

String

Mandatory

Unique id for the merchant channel as passed in request headers.

                      merchantRequestId
                      *
                      

String

Mandatory

Merchant generated unique id for collect request.

Constraint: Max 35 characters & Alphanumeric.

                      amount
                      *
                      

String

Mandatory

Amount for transaction.
Constraint: Amount in two decimals. Decimals are mandatory.

                      payerVpa
                      *
                      

String

Mandatory

Vpa on which collect request was triggered.

                      payerName
                      
                      

String

Optional

Name of the payer to whom collect request was sent.

                      payeeVpa
                      *
                      

String

Mandatory

VPA of the merchant to be used for payment.

                      payeeMcc
                      *
                      

Numeric

Mandatory

Merchant Category Code of the payee merchant.

                      refUrl
                      
                      

String

Optional

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

                      remarks
                      *
                      

String

Mandatory

Remarks sent by merchant for the collect request.

                      transactionTimestamp
                      *
                      

String

Mandatory

Timestamp of when collect request was triggered.

Format: YYYY-MM-DDTHH:MM:SS+05:30.

                      expiryTimestamp
                      *
                      

String

Mandatory

Timestamp of when the collect request will expire.

Format: YYYY-MM-DDTHH:MM:SS+05:30.

                      gatewayTransactionId
                      *
                      

String

Mandatory

UPI request id returned by gateway for the transaction.

                      gatewayReferenceId
                      *
                      

String

Mandatory

Reference id returned by the gateway.

                      gatewayResponseStatus
                      *
                      

String

Mandatory

Response status returned by gateway.

Values: SUCCESS | FAILURE.

                      gatewayResponseCode
                      *
                      

String

Mandatory

Response code returned by gateway for the transaction.

Values: 00, Any valid NPCI error code

                      gatewayResponseMessage
                      *
                      

String

Mandatory

Response message returned by gateway for the transaction.

                      mutualFundDetails
                      
                      

Json String

optional

Contains details of Mutual Funds (as passed in the request).

                      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;
Values: 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. Oder Number in ICCL or APPL_NO in RTA.

                      amount
                      *
                      

String

Mandatory

Individual MF amount within the array of MF being purchased.

Constraint: 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 below;

Values:LUMPSUM, SIP.

                      payerAccountHashes
                      
                      

Array Of String

optional

As passed in the request body.

                      splitSettlementDetails
                      
                      

json String

optional

Split Settlement details of merchant and partners for this transactions.

                      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.

                      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.

                      subMerchantId
                      
                      

String

Optional

Unique id for subMerchant. Only if present as a subMerchant.

                      subMerchantChannelId
                      
                      

String

Optional

Unique id for the channel via which request is made. Only if present as a subMerchant.

                      udfParameters
                      
                      

stringified JSON

optional

Udf parameters as passed in the request.
Example: "{\"udf1\":\"value1\",\"udf2\":\"value2\",…}"

Have questions?
Need help? Contact support
LLM? Read llms.txt