Get Merchants

POST 
/api/v1/merchants/list

Retrieve a list of all merchants

Request

application/json

Body

required

limit Limit

Default value: 10

Maximum number of records to return.

offset Offset

The offset from where to start fetching wallets.

filters object

textFilter Textfilter

Text search by title or mcc code

sortBy MerchantSortField[]

Possible values: [TITLE, POPULARITY]

orderBy SortOrder[]

Possible values: [ASC, DESC]

Responses

200

Successful Response

application/json

Schema

Schema

items object[]required
Array of merchant objects.
Array [
id object required
anyOf
MOD1
string
MOD2
string
name Name
title Titlerequired
popularityRate Popularityraterequired
groupOrder Grouporderrequired
mccCode Mcccoderequired
binsCount Binscountrequired
]
totalCount Totalcountrequired

Total number of merchants corresponding to the filters.

Example (from schema)

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "title": "string",
      "popularityRate": 0,
      "groupOrder": 0,
      "mccCode": "string",
      "binsCount": 0
    }
  ],
  "totalCount": 0
}

422

Validation Error

application/json

Schema

Schema

detail object[]
Array [
loc object[]required
Array [
anyOf
MOD1
string
MOD2
integer
]
msg Messagerequired
type Error Typerequired
]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...