Get a List of Merchants

This API retrieves a list of merchants based on optional query parameters.

Endpoint Information

• Request Header: X-BH-TOKEN: ******

• Request Method: GET

• Request Path: /v2/merchants

• Authorization Required: Yes

Query Parameters

• merchantName: (string) The name of the merchant (optional).

• email: (string) The email of the merchant (optional).

• currentPage: (int) The current page number (optional).

• pageSize: (int) The number of results per page (default is 10, maximum is 1000).

Response Structure

The response will include the following fields:

{
    "code": 200,
    "msg": "SUCCESS",
    "data": {
        "currentPage": 1,                  // (number: current page number)
        "size": 10,                         // (number: number of results per page)
        "total": 100,                       // (number: total number of results)
        "data": [                           // (array: list of merchants)
            {    
                "merchantId": 1,            // (number: id of the merchant)
                "country": "Mexico",        // (string: name of the country)
                "merchantName": "Rrturo Tellez", // (string: name of the merchant)
                "email": "[email protected]", // (string: email of the merchant)
                "merchantType": 1,          // (number: merchant type [1: INDIVIDUAL, 2: BUSINESS])
                "status": 1,                 // (enum: status of the merchant [1: authenticating, 2: normal, 3: authentication failed, 4: incomplete])
                "remark": "",                // (string: Remark)
                "createTime": "1737452292000", // (string: timestamp of the create time (milliseconds))
                "updateTime": "1737452344000" // (string: timestamp of the update time (milliseconds))
            }
        ]
    }
}

Example Response

{
    "code": 200,
    "msg": "SUCCESS",
    "data": {
        "currentPage": 1,
        "size": 10,
        "total": 100,
        "data": [
            {
                "merchantId": 1,
                "country": "Mexico",
                "merchantName": "Rrturo Tellez",
                "email": "[email protected]",
                "merchantType": 2,
                "remark": "",
                "createTime": "1737452292000",
                "updateTime": "1737452344000"
            },
            {
                "merchantId": 2,
                "country": "Argentina",
                "merchantName": "Tom",
                "email": "[email protected]",
                "merchantType": 1,
                "remark": "",
                "createTime": "1737452292001",
                "updateTime": "1737452344001"
            }
            // Additional merchants may be included
        ]
    }
}

Notes

• The currentPage field indicates the page of results currently being returned.

• The size field shows the number of results returned per page.

• The total field indicates the total number of merchants available based on the query.

• Each merchant object includes relevant details, such as ID, country, name, email, type, and timestamps for creation and updates.