Update Card Status - Field Descriptions
The following page details each of the fields that can be used in the request and received in the response when using the Update Card Status endpoint.
Request Fields
The following table describes fields that can be included in the body of the request when updating a card status.
| Field | Description | Minimum Length | Maximum Length | Type | Mandatory |
|---|---|---|---|---|---|
| cardStatusCode | The new status of the card (two character alphanumeric CardStatusCode). You only need to include this field if you're not using the status field. | 2 | 2 | Integer | Yes (if Status is not included) |
| status | The new status of the card (string description). You only need to include this field if you're not using the cardStatusCode field. | 0 | 255 | String | Yes (if cardStatusCode is not included) |
| updatedBy | The user updating the card status. | 0 | 1000 | String | No |
| description | Captures the context of the card status update. | 0 | 1000 | String | No |
| validityDate | The date when the card will be valid. Format YYYY-MM. | 0 | 7 | date-time | No |
Response Fields
The following table describes fields that included in the response after successfully updating a card status
| Field | Description |
|---|---|
| status | The description of the current status of the card, based on the cardStatusCode field. |
| cardStatusCode | The two-digit status code of the card. |
| updated | The date when the status of the card was changed. Format DD-MM-YYYY. |
| updatedBy | The name of the person responsible for the status change. |
| description | The description entered in the description field of the request. |
Updated 16 days ago