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

Add Sub Merchant

This api creates a new sub-merchant with the given account number and vpa.

Request

Response

API Endpoints

Production Link

POST

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

                      Content-Type
                      
                      

string

application/json

                      x-version
                      
                      

string

                      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.

                      vpa
                      *
                      

String

Mandatory

VPA for the sub-merchant.
Constraints: Special characters allowed(.-@). Maximum length is 25.
Format: submerchant@handle

                      accountNumber
                      
                      

String

optional

Current account number for the sub-merchant.
Constraints: Numeric string. Maximum length is 30. Account number and ifsc both fields should be passed. If not passed, parent aggregator's value will be replicated.

                      ifsc
                      
                      

String

Optional

IFSC code of the sub-merchant current bank account.
Constraints: Alphanumeric string. Maximum length is 11(format: AAAA0000000). If not passed, parent aggregator's value will be replicated.

                      mcc
                      *
                      

String

Mandatory

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

                      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. If not passed, parent aggregator's values will be replicated.

                      merchantName
                      *
                      

String

Mandatory

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

                      marketingName
                      *
                      

String

Mandatory

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

                      city
                      *
                      

String

Mandatory

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

                      address
                      *
                      

String

Mandatory

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

                      state
                      *
                      

String

Mandatory

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

                      pinCode
                      *
                      

String

Mandatory

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

                      mobileNumber
                      *
                      

String

mandatory

Mobile number of sub-merchant.
Constraints: Numeric String (12 Digits)
Example: 919123467890

                      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

Mandatory

Description of mcc.
Constraints: Alphanumeric string. Maximum length is 255.

                      gstin
                      
                      

String

optional

GSTIN of the sub-merchant.
Constraints: Alphanumeric string. Maximum length is 20.
Example: 29GGGGG1314R9Z6

                      panNumber
                      
                      

String

optional

PAN Number of sub-merchant.
Constraints: Alphanumeric string (Exact 10 Characters).
Example: AAAAA0000A

                      mid
                      *
                      

String

Mandatory

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

                      sid
                      *
                      

String

Mandatory

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

                      tid
                      *
                      

String

Mandatory

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

                      merchantType
                      *
                      

String

Mandatory

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

                      merchantGenre
                      *
                      

String

Mandatory

Genre of the sub-merchant.
Values: ONLINE, OFFLINE

                      onBoardingType
                      *
                      

String

Mandatory

Onboarding type of sub-merchant.
Values: BANK, AGGREGATOR

                      brand
                      *
                      

String

Mandatory

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

                      legal
                      *
                      

String

Mandatory

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

                      franchise
                      *
                      

String

Mandatory

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

                      type
                      *
                      

String

Mandatory

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

                      enabled
                      
                      

String

optional

Denotes if the sub-merchant is enabled or not.
Values: true or false.

                      iat
                      *
                      

String

Mandatory

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

                      udfParameters
                      
                      

JSON String

Optional

Stringified JSON for udf parameters

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

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

                      Configurations
                      
                      

JSON String

optional

Array of JSON objects to provide custom configurations for every submerchant. Each Json object has config, and value keys and their respective values.

Note: The value of these configs (when passed in the request) will be given preference over parent’s config/flag value.

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 String

Mandatory

Stringified json for udf parameters.

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