GET/cards/block-reasons

Get Block / Cancellation Reasons

Returns the allowed block / card cancellation reasons for the dropdown.

These values are used as BlockReason on POST /cards/{cardId}/block.

bash

curl -X GET "{{API_BASE_URL}}/cards/block-reasons" \
  -H "session-token: {{sessionToken}}" \
  -H "Accept: application/json"

Headers

Field	Type	Required	Possible values	Description
`session-token`	string	Required	—	SessionToken obtained from the Create GMA Session endpoint. All secured endpoints require this header.

Additional info

Field	Type	Required	Possible values	Description
`401 — Missing session`	object	Optional	—	Missing broker session.

Example

{
  "ResponseCode": 401,
  "ResponseMessage": "Unauthorized",
  "ResponseData": null
}

{
  "ResponseCode": 401,
  "ResponseMessage": "Unauthorized",
  "ResponseData": null
}

Response

Field	Type	Possible values	Description
`ResponseCode`	integer	200 \| 201 \| 204 \| 301 \| 400 \| 401 \| 403 \| 404 \| 410 \| 422 \| 500 \| 503	API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).
`ResponseMessage`	string	Success \| Created \| NoContent \| BadRequest \| Unauthorized \| Forbidden \| NotFound \| Gone \| UnprocessableContent \| ServerError \| ResourceMoved \| ServiceUnAvailable \| UnProcessableEntity	Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.
`ResponseData`	array	Please refer to below example for response body	Allowed block / cancellation reasons.
`ResponseData[].value`	string	LOST \| STOLEN \| FRAUD \| CUSTOMER_REQUESTED_CLOSE	Reason code to send as `BlockReason`.
`ResponseData[].label`	string	—	Display label for the dropdown.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": [
    {
      "value": "LOST",
      "label": "Lost"
    },
    {
      "value": "STOLEN",
      "label": "Stolen"
    },
    {
      "value": "FRAUD",
      "label": "Fraud"
    },
    {
      "value": "CUSTOMER_REQUESTED_CLOSE",
      "label": "Customer requested close"
    }
  ]
}

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": [
    {
      "value": "LOST",
      "label": "Lost"
    },
    {
      "value": "STOLEN",
      "label": "Stolen"
    },
    {
      "value": "FRAUD",
      "label": "Fraud"
    },
    {
      "value": "CUSTOMER_REQUESTED_CLOSE",
      "label": "Customer requested close"
    }
  ]
}

Requires `session-token: {SessionToken}` from Create GMA Session. Use the same client IP as authentication.