Retrieve Card Block Reasons By Requested‑By

Retrieves a list of card blocking reason codes for a given user role.

URL test:

    https://test.lightcms.io/cms/v1/enumeration/cardblockreasonbyrequestedby

Method:

GET

Path items:

/enumeration/cardblockreasonbyrequestedby

Parameters:

Parameter	Location	Type	Example	Description	Required
x‑cms‑role	header	string	BANK,ACCOUNT_OWNER,HOLDER	Comma‑separated list of role codes (e.g., BANK, ACCOUNT_OWNER, HOLDER)	Yes

Example:

    curl -X GET "https://test.lightcms.io/cms/v1/enumeration/cardblockreasonbyrequestedby" \
         -H 'accept: */*' \
         -H 'x-cms-role: BANK,ACCOUNT_OWNER,HOLDER'

Responses:

200 - OK

Status Code: 200 OK

[
  {
    "role": "HOLDER",
    "blockReasons": [
      "HOLDER_REQUEST"
    ]
  },
  {
    "role": "BANK",
    "blockReasons": [
      "BANK_REQUEST",
      "REGULATORY"
    ]
  }
]

Parameter	Location	Type	Description
role	root	string	Role code for which the block reasons are listed.
blockReasons	root	array	Array of block‑reason codes applicable to the role.

403 - Forbidden

Status Code: 403 Forbidden

{
  "details": [
    "Invalid role in x-cms-role header: BANK,ACCOUNT_OWNER,HOLDER"
  ],
  "errorMessage": "Invalid header authentication data"
}

Parameter	Location	Type	Description
details	root	array	List of validation error messages.
errorMessage	root	string	Human‑readable description of the error.

500 - Internal error

Status Code: 500 Internal error

{
  "timestamp": "2025-07-22T13:09:02.348+02:00",
  "status": 500,
  "error": "Internal Server Error",
  "path": "/cms/v1/enumeration/cardblockreasonbyrequestedby"
}

Parameter	Location	Type	Description
timestamp	root	string	ISO‑8601 timestamp when the error occurred.
status	root	integer	HTTP status code (500).
error	root	string	Short description of the error.
path	root	string	The request path that caused the error.