Body
List Specific Sub Merchant Info
This api gives the information of the requested submerchant .
Request
Response
API Endpoints
Production Link
POST
http://{{host}}/api/{uri}/merchants/sub/info
Headers
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.
Parameters
subMerchantId
*
String
Mandatory
Merchant generated sub-merchant id value
Alphanumeric string. Maximum length is 256.
subMerchantChannelId
*
string
Mandatory
Sub-merchant channel id
Alphanumeric string. Maximum length is 256.
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 : ^[^/#-()*!%~`]+$
iat
*
String
Mandatory
Timestamp to be used in JWS.
Constraints: As passed in the request body
200 : Success
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
merchantId of the sub-merchant
Values: As passed while creation.
subMerchantChannelId
*
String
Mandatory
channelId for the sub-merchant
Values: As passed while creation.
vpa
*
String
Mandatory
VPA for the sub-merchant
Values: As passed while creation.
maskedAccountNumber
*
String
Mandatory
Masked account number for the sub-merchant
Values: As passed while creation.
ifsc
*
String
Mandatory
ifsc code of the sub-merchant current bank account
Values: As passed while creation.
mcc
*
String
Mandatory
mcc code of the sub-merchant
Values: As passed while creation.
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 that are configured for each event
Values: As passed while creation.
udfParameters
*
JSON
Mandatory
Stringified json for udf parameters.
Have questions?
- Need help? Contact support
- LLM? Read llms.txt