Developers
Ingresar a la plataforma

Listar categorías de comercio

GET/api/public/v1/merchant-categories

Devuelve una página en formato HAL de las categorías de comercio disponibles para la empresa de la API key, que son las que se usan para clasificar sus transacciones y restringir presupuestos. Si la empresa tiene categorías propias configuradas, se devuelven sólo esas; si no, el catálogo general. Incluye tanto categorías de transacciones (PURCHASE) como de kilometraje (MILEAGE). Sólo se aplican page y size; sort se ignora. Disponible en clusters de México.

Autorización

apiKeyScheme
X-API-KEY<token>

En: header

Parámetros de consulta

page?integer

Número de página a devolver, comenzando en 0.

Formatoint32
Rango0 <= value
size?integer

Cantidad de elementos por página. Por defecto 20; un valor mayor al máximo de la operación (500 salvo que se indique otro) se recorta a ese máximo.

Formatoint32
sort?array<>

Criterios de ordenamiento, en orden de prioridad. Cada criterio se envía con índice: sort[0].property=<campo>&sort[0].direction=ASC|DESC.

Criterios de ordenamiento, enviados como sort[0].property y sort[0].direction (ASC o DESC). Sin ordenamiento explícito, el orden de los resultados no está garantizado.

property?string
direction?string

Valor en

  • "ASC"
  • "DESC"
excludeCount?boolean

Si es true, omite el cálculo del total de resultados para responder más rápido.

Cuerpo de la respuesta

application/vnd.hal+json

application/json

application/json

curl -X GET "https://example.com/api/public/v1/merchant-categories"
{  "_embedded": {    "merchantCategories": [      {        "uniqueCode": "0590843e-1d92-4d51-82c6-4a22a6b8be82",        "name": "Restaurantes"      }    ]  },  "_links": {    "property1": {      "href": "string",      "hreflang": "string",      "title": "string",      "type": "string",      "deprecation": "string",      "profile": "string",      "name": "string",      "templated": true    },    "property2": {      "href": "string",      "hreflang": "string",      "title": "string",      "type": "string",      "deprecation": "string",      "profile": "string",      "name": "string",      "templated": true    }  },  "page": {    "size": 0,    "totalElements": 0,    "totalPages": 0,    "number": 0  }}