Get a category

GET 
/categories/:id

Get a category

Request

Path Parameters

id integerrequired

Possible values: >= 1

The category ID

Query Parameters

language string

Default value: en

ISO 639-1 language code for category translation, get supported languages from /languages

Responses

200

Categories response

application/json

Schema

Schema

id integer

ID of the category

mainCategory

object

Main category

id integer

ID of the main category

name string

Translated name

subCategory

object

Sub-category

id integer

ID of the sub-category

name string

Translated name

Example (from schema)

{
  "id": 0,
  "mainCategory": {
    "id": 0,
    "name": "string"
  },
  "subCategory": {
    "id": 0,
    "name": "string"
  }
}

401

Unauthorized client

403

Insufficient scope for accessing this resource

application/json

Schema

Schema

errors

object[]

required

Errors

Array [

source stringrequired

Possible values: non-empty and <= 100 characters

The application name that generated this error.

reasonCode stringrequired

Possible values: non-empty and <= 100 characters

A unique constant identifying the error case encountered during request processing.

• BAD_REQUEST - Malformed request, please advice the description and details fields for more information
• FORBIDDEN - Insufficient scope to access the resource
• INTERNAL_SERVER_ERROR - Unexpected server error
• METHOD_NOT_ALLOWED - Method not allowed
• UNSUPPORTED_MEDIA_TYPE - Unsupported media type
• SERVICE_UNAVAILABLE - Service is unavailable

description stringrequired

Possible values: >= 10 characters and <= 1000 characters

Short description of the reasonCode field.

recoverable booleanrequired

Indicates whether this error will always be returned for this request, or retrying could change the outcome.

details string

Possible values: <= 5000 characters

Where appropriate, indicates detailed information about data received and calculated during request processing, to help the user with diagnosing errors.

]

Example (from schema)

{
  "errors": [
    {
      "source": "Doconomy",
      "reasonCode": "BAD_REQUEST",
      "description": "cardTransactions[0].mcc must match \\\"[0-9]{1,4}\\\"",
      "recoverable": false,
      "details": "string"
    }
  ]
}

405

Method not allowed

application/json

Schema

Schema

errors

object[]

required

Errors

Array [

source stringrequired

Possible values: non-empty and <= 100 characters

The application name that generated this error.

reasonCode stringrequired

Possible values: non-empty and <= 100 characters

A unique constant identifying the error case encountered during request processing.

• BAD_REQUEST - Malformed request, please advice the description and details fields for more information
• FORBIDDEN - Insufficient scope to access the resource
• INTERNAL_SERVER_ERROR - Unexpected server error
• METHOD_NOT_ALLOWED - Method not allowed
• UNSUPPORTED_MEDIA_TYPE - Unsupported media type
• SERVICE_UNAVAILABLE - Service is unavailable

description stringrequired

Possible values: >= 10 characters and <= 1000 characters

Short description of the reasonCode field.

recoverable booleanrequired

Indicates whether this error will always be returned for this request, or retrying could change the outcome.

details string

Possible values: <= 5000 characters

Where appropriate, indicates detailed information about data received and calculated during request processing, to help the user with diagnosing errors.

]

Example (from schema)

{
  "errors": [
    {
      "source": "Doconomy",
      "reasonCode": "BAD_REQUEST",
      "description": "cardTransactions[0].mcc must match \\\"[0-9]{1,4}\\\"",
      "recoverable": false,
      "details": "string"
    }
  ]
}

429

Too many requests, check the headers X-RateLimit-Limit-second and X-RateLimit-Remaining-second

500

Unexpected server error

application/json

Schema

Schema

errors

object[]

required

Errors

Array [

source stringrequired

Possible values: non-empty and <= 100 characters

The application name that generated this error.

reasonCode stringrequired

Possible values: non-empty and <= 100 characters

A unique constant identifying the error case encountered during request processing.

• BAD_REQUEST - Malformed request, please advice the description and details fields for more information
• FORBIDDEN - Insufficient scope to access the resource
• INTERNAL_SERVER_ERROR - Unexpected server error
• METHOD_NOT_ALLOWED - Method not allowed
• UNSUPPORTED_MEDIA_TYPE - Unsupported media type
• SERVICE_UNAVAILABLE - Service is unavailable

description stringrequired

Possible values: >= 10 characters and <= 1000 characters

Short description of the reasonCode field.

recoverable booleanrequired

Indicates whether this error will always be returned for this request, or retrying could change the outcome.

details string

Possible values: <= 5000 characters

Where appropriate, indicates detailed information about data received and calculated during request processing, to help the user with diagnosing errors.

]

Example (from schema)

{
  "errors": [
    {
      "source": "Doconomy",
      "reasonCode": "BAD_REQUEST",
      "description": "cardTransactions[0].mcc must match \\\"[0-9]{1,4}\\\"",
      "recoverable": false,
      "details": "string"
    }
  ]
}

default

Default response

Response Headers

• X-RateLimit-Limit-second

  integer

  Request limit per second

• X-RateLimit-Remaining-second

  integer

  Number of requests left for the time window

Loading...