Introduction

This API support Merchant query sub-merchant list.

API Description

Request Method:POST

Request Path:open/api/merchant/list

Parameters

Request parameters

Parameter	Mandatory	Sign	Type	Length	Remarks
appId	Y	Y	string	64	AppId is unique for merchant
sign	Y	Y	string	128	Sign Check on About the sign
pageNo	Y	Y	int	12	Page No
pageSize	Y	Y	int	12	Page Size
subMerchantName	N	Y	string	32	Merchant name (fuzzy search)
subMerchantNo	N	Y	string	64	Sub-merchant number
externalSubMerchantNo	N	Y	string	32	External sub-merchant number

Request Example

{
    "appId": "TEST000001",
    "pageNo": 1,
    "pageSize": 20,
    "subMerchantName": "Test Merchant",
    "subMerchantNo": "300017425425788420221",
    "externalSubMerchantNo": "test_000002",
    "sign": "978E318BD09ABEB805898CD59EA318F6C6D5784F14A3FF41CCF60DE333C9364EA8B563393F3C0D8CB5BDE5FB5D25EAD4F19D95B8F4D36D3FFEAFD84031FC8677"
}

Description of Response Parameters

Parameter	Type	Details
success	boolean	Success
error	boolean	Error
code	long	Response code
msg	string	Response message
traceId	string	Trace id
model	object	Response details

Description of Model Parameters

Parameter	Mandatory	Type	Description
pageNo	N	int	Page number
pageSize	N	int	Number of items per page
sumRow	N	int	Total number of items
sumPage	N	int	Total number of pages
lastPage	N	boolean	Whether it is the last page
data	N	object	Data

Model Data

Parameter Name	Mandatory	Type	Description
externalSubMerchantNo	Y	string	External sub-merchant number
subMerchantNo	Y	string	Sub-merchant number
subMerchantName	N	string	Sub-merchant name
businessType	N	string	1. Online 2. Offline 3. Both
officialWebsiteAddress	N	string	Official website address
companyRegisteredName	N	string	Registered name of the company entity
entityRegistrationNumber	N	string	Registration number of the entity
registrationDate	N	string	Registration date
registeredBusinessAddress	N	string	Registered company address (Country/State/City/Street Address)
email	N	string	Company email address
businessRange	N	string	Business model
slidingPoint	N	double	Slippage percentage
slidingFixedValue	N	double	Fixed slippage value
deductionMethod	N	string	Deduction method: INNER_BUCKLE (internal), OUTER_BUCKLE (external)
payWayCode	N	string	payWayCode
autoWithdrawStatus	N	boolean	Whether auto-withdrawal is enabled
autoWithdrawAmountLimit	N	double	Auto-withdrawal amount (in dollar, two decimal places)
bankFormInfo	N	object	Bank withdrawal form information

Response Example

{
    "code": "0",
    "msg": "success",
    "model": {
        "pageNo": 1,
        "pageSize": 20,
        "sumRow": 1,
        "data": [
            {
                "subMerchantNo": "300017425425788420221",
                "externalSubMerchantNo": "test_000002",
                "subMerchantName": "Test Merchant",
                "businessType": "Online",
                "officialWebsiteAddress": "https://testmerchant.com",
                "companyRegisteredName": "Test Company Ltd.",
                "entityRegistrationNumber": "1234567890",
                "registrationDate": "2025-01-01",
                "registeredBusinessAddress": null,
                "email": "[email protected]",
                "businessRange": "E-commerce",
                "slidingPoint": 0.05,
                "slidingFixedValue": 5,
                "deductionMethod": "INNER_BUCKLE",
                "payWayCode": "USDT",
                "autoWithdrawStatus": true,
                "autoWithdrawAmountLimit": 1000,
                "bankFormInfo": {
                    "drawNetwork": "TRX",
                    "drawAddress": "0xa6459EF31C68DCF46cC603C526526DB1C6eE4fD1"
                }
            }
        ],
        "sumPage": 1,
        "startIndex": 0,
        "lastPage": true
    },
    "traceId": "67e228f2e23dd7de8d0247f3cc53ef3d",
    "success": true,
    "error": false
}