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

Update Sub Merchant

This api updates a sub merchant with the given subMerchantId and subMerchantChannelId. Atleast one optional field has to be passed along with 2 mandatory fields.

Request

Response

API Endpoints

Production Link

POST

http://{{host}}/api/{uri}/merchants/sub/update

                      Content-Type
                      
                      

string

application/json

                      x-merchant-signature
                      
                      

string

This is a signature over combination of headers, payload. Refer Signature Calculation section for more details.

                      x-merchant-id
                      
                      

string

Will be shared while onboarding.

                      x-merchant-channel-id
                      
                      

string

Will be shared while onboarding.

                      Accept
                      
                      

string

application/json

                      x-timestamp
                      
                      

string

This is an epoch unix timestamp string. For example, 1496918882000. It can be used by us to invalidate older requests.

                      x-sub-merchant-id	
                      *
                      

String

Mandatory

Provided during on-boarding. To be passed in the apis if it needs to be invoked in sub merchant mode.

                      x-sub-merchant-channel-id	
                      *
                      

String

Mandatory

Provided during on-boarding. To be passed in the apis if it needs to be invoked in sub merchant mode.

Body

                      subMerchantId
                      *
                      

String

Mandatory

Merchant generated sub-merchant id value
Constraints: Alphanumeric string. Maximum length is 256.

                      subMerchantChannelId
                      *
                      

String

Mandatory

Sub-merchant channel id
Constraints: Alphanumeric string. Maximum length is 256.

mcc

String

optional

Mcc code of the sub-merchant
Constraints: Numeric String.(4)

                      enabled
                      
                      

String

optional

Tells whether the sub-merchant is enabled or not
Constraints: True/False

                      callbackUrls
                      
                      

String

optional

Callback Urls needs to be configured for each event
Constraints: Stringified Array of JSON objects. Each Json object has type and url params. Refer Server Callbacks section for allowed value of type.

                      merchantName
                      
                      

String

Optional

Name of sub-merchant
Constraints: Alphanumeric string. Maximum length is 100.

                      marketingName
                      
                      

String

optional

Market name of the sub-merchant
Constraints: Alphanumeric string. Maximum length is 50.

                      city
                      
                      

String

Optional

City of sub-merchantAlphanumeric string. Maximum length is 50.

                      address
                      
                      

String

Optional

Address of sub-merchant
Constraints: Alphanumeric string. Maximum length is 200.

                      state
                      
                      

String

Optional

State of sub-merchant
Constraints: Alphanumeric string. Maximum length is 50.

                      pinCode
                      
                      

String

optional

Pincode of sub-merchant
Constraints: Numeric String.(6)

                      mobileNumber
                      
                      

String

Optional

Mobile number of sub-merchant
Constraints: Numeric String.(10)

                      ownerName
                      
                      

String

optional

Owner of sub-merchant firm
Constraints: Alphanumeric string. Maximum length is 50.

                      partner1
                      
                      

String

optional

Partner name of sub-merchant firm
Constraints: Alphanumeric string. Maximum length is 50.

                      partner2
                      
                      

String

optional

Partner name of sub-merchant firm
Constraints: Alphanumeric string. Maximum length is 50.

                      mccDescription
                      
                      

String

optional

Description of mcc
Constraints: Alphanumeric string.

                      gstin
                      
                      

String

optional

GSTIN
Constraints: Alphanumeric string.

                      panNumber
                      
                      

String

optional

PAN Number of sub-merchant
Constraints: Alphanumeric string.(10)

sid

String

optional

Store id for sub-merchant
Constraints: Alphanumeric string. Maximum length is 20.

tid

String

optional

Terminal identifier for sub-merchant
Constraints: Alphanumeric string. Maximum length is 20.

                      merchantType
                      
                      

String

optional

Merchant type for sub-merchant
Constraints: SMALL,LARGE.

                      merchantGenre
                      
                      

String

optional

Genre of sub-merchant
Constraints: ONLINE, OFFLINE.

                      onBoardingType
                      
                      

String

optional

Onboarding type of sub-merchant
Constraints: BANK, AGGREGATOR

                      brand
                      
                      

String

optional

Brand name of sub-merchant
Constraints: Alphanumeric string. Maximum length is 99.

                      legal
                      
                      

String

optional

Legal name for sub-merchant
Constraints: Alphanumeric string. Maximum length is 99.

                      franchise
                      
                      

String

optional

Franchise name of merchant
Constraints: Alphanumeric string. Maximum length is 99.

                      type
                      
                      

String

optional

Ownership type of sub-merchant
Constraints: PROPRIETARY,PARTNERSHIP,PRIVATE,PUBLIC,OTHERS.

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

mid

String

optional

Merchant identifier for sub-merchant.
Constraints: Alphanumeric string. Maximum length is 20.

                      iat
                      *
                      

String

Mandatory

Timestamp to be used in JWS.
Constraints: As passed in the request body.

                      configurations
                      
                      

JSON string

optional

Array of JSON objects to provide custom configurations for every submerchant. Each Json object has config, value and action (wherever applicable) keys. Only the flags passed in the request will be updated rest will remain same.

Note: Possible values for ACTION: ADD or REMOVE. It should be passed only in cases where the value is a list.

Response Body

                      status
                      *
                      

String

Mandatory

Status of the API.
Values: SUCCESS, FAILURE.

                      responseCode
                      *
                      

String

Mandatory

SUCCESS if call succeeded. Otherwise shows the error code.
Values: Refer error code section.

                      responseMessage
                      *
                      

String

Mandatory

SUCCESS if call succeeded. Otherwise shows verbose error.
Values: Refer error code section.

                      payload
                      *
                      

String

Mandatory

                      merchantId
                      *
                      

String

Mandatory

Unique id for merchant.
Values: As passed in request.

                      merchantChannelId
                      *
                      

String

Mandatory

Unique id for the channel via which request is made.
Values: As passed in request.

                      subMerchantId
                      *
                      

String

Mandatory

Merchant generated sub-merchant id value
Values: As passed in request.

                      subMerchantChannelId
                      *
                      

String

Mandatory

Sub-merchant channel id
Values: As passed in request.

                      vpa
                      *
                      

String

Mandatory

VPA for the sub-merchant
Values: As passed in request.

                      maskedAccountNumber
                      *
                      

String

Mandatory

Masked account number for the sub-merchant
Values: XXXX123456.

                      ifsc
                      *
                      

String

Mandatory

Ifsc code of the sub-merchant current bank account

Values: As passed in request.

                      mcc
                      *
                      

String

Mandatory

Mcc code of the sub-merchant
Values: As passed in request.

                      enabled
                      *
                      

String

Mandatory

Tells whether the sub-merchant is enabled or not
Values: By default it is false. Initiate update sub-merchant to enable it.

                      callbackUrls
                      *
                      

String

Mandatory

Callback Urls needs to be configured for each event
Values: As passed in request.

                      udfParameters
                      *
                      

JSON

Mandatory

Stringified json for udf parameters.

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