Skip to main content

Get Merchants

You can search for merchant titles and codes using this service. This is useful for looking up a merchantCode value to use in the other Partners API services.

No Authentication Required

This endpoint does not require the Authorization header.

Request

curl --location --request GET '<BASE_URL>/merchants?title=Fakir&page=1&size=10'
--header 'Content-Type: application/json'

Request Parameters

ParameterTypeRequired
Description
titleStringNoSearches by merchant title (partial match).
pageIntegerNoUsed for pagination. The default value and minimum value is 1.
sizeIntegerNoUsed for pagination. The default value is 10. Min 1 - Max 200

Response

200 OK
{
"content": [
{
"code": "FKR001",
"title": "Fakir"
}
],
"totalPages": 1,
"totalElements": 1,
"size": 10,
"page": 1,
"empty": false
}

Response Fields

FieldTypeDescription
codeStringMerchant code
titleStringMerchant title