Update card status
POST/cards/:cardId/status
Use this endpoint to change the status of the card. This is typically used to apply a temporary block (e.g. in the event of a lost card).
This endpoint:
- Changes card status (active, blocked, etc.)
- Maintains card history
- Triggers necessary notifications
- Updates related systems
Request
Path Parameters
The ID of the card to update
- application/json
Body
required
Card status update data
Possible values: [ACTIVE
, BLOCKED
]
The new status to set for the card (only ACTIVE or BLOCKED allowed)
Responses
- 201
- 400
- 403
- 404
The card status was successfully updated.
- application/json
- Schema
- Example (from schema)
Schema
data
object
The ID of the card
The system card reference number
Possible values: [ACTIVE
, BLOCKED
, SUSPENDED
, CANCELLED
]
The status of the card
Whether the operation was successful
{
"traceId": "string",
"message": "string",
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"referenceNumber": "CARD-REF-12345",
"status": "BLOCKED",
"success": true
}
}
Invalid request payload. This can happen if required fields are missing or have invalid formats.
- application/json
- Schema
- Example (from schema)
Schema
{
"traceId": "string",
"message": "string"
}
The API key is invalid or the client does not have sufficient permissions.
- application/json
- Schema
- Example (from schema)
Schema
{
"traceId": "string",
"message": "string"
}
One of the specified resources was not found. Does not apply for empty result set.
- application/json
- Schema
- Example (from schema)
Schema
{
"traceId": "string",
"message": "string"
}