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

List All Sub Merchants

This api lists all sub-merchants for the requested merchant.

Request

Response

API Endpoints

Production Link

POST

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

                      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

                      limit
                      *
                      

Numeric

Mandatory

Number of sub-merchants to be returned

                      offset
                      *
                      

Numeric

Mandatory

Offset value to be considered while listing

                      enabled
                      
                      

String

optional

Denotes if the sub-merchant is enabled or not
Constraints: true, false

                      iat
                      *
                      

String

Mandatory

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

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

                      subMerchants
                      *
                      

String

Mandatory

Array of sub-merchant Information
Values: See sample response.

                      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.

                      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.

                      subMerchantsCount
                      *
                      

Numeric

Mandatory

Total number of sub-merchants configured for the aggregator.
Values: Numeric.

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