Lets you update an existing card details such as card status label, status, custom fields, and extended field values of a card.
NoteFor detailed information about the APIs and for hands-on testing, refer to the API overview documentation and step-by-step guide on making your first API call.
Prerequisites
- Basic Authentication
- Default access group
Resource information
| HTTP method | GET |
|---|---|
| Authentication | Basic |
| Pagination supported? | NO |
| Rate limit | YES |
| Batch support | NO |
Request Parameters
Parameter | Data Type | Description |
|---|---|---|
cardNumber* | String | Unique card number to be updated. |
seriesId | Integer | Unique identifier of the card series. |
statusLabel | String | New status label to set for the card. Allowed values: NOT_ISSUED, ACTIVE, SUSPENDED, DELETED, EXPIRED, ISSUED. |
statusInfo | Object | Additional status details. |
- reason | String | Reason for updating the card status. |
mappedEntity | Object | Information about the entity mapped to the card. |
- type | String | Type of entity (e.g., |
- value | String | Name or value of the entity. |
- id | Integer | Unique identifier of the entity. |
customFields | Object | Custom fields associated with the card. |
- type | String | Type of the custom field. |
- value | String | Value of the custom field. |
extendedFields | Object | Extended fields for additional metadata. |
- card_requested_by | String | Value indicating who requested the card. |
Response Parameter
| Parameter (parameters marked by * are mandatory) | DataType | Description |
|---|---|---|
| cardId* | int | Unique identifier for the card. |
| customerId | int | Unique identifier for the customer linked to the card. |
| extendedFields | object | Key-value pairs for additional custom fields. |
| — card_requested_by | string | User who requested the card. |
| customFields | object | Additional custom field data as key-value pairs. |
| mappedEntity | object | Information about the entity mapped to the card. |
| — type | string | Type of the entity (e.g., TILL). |
| — value | string | Value of the mapped entity (e.g., till name). |
| — id | int | Unique identifier of the mapped entity. |
| cardNumber | string | Card number assigned. |
| seriesId | int | Unique identifier for the card series. |
| orgId | int | Organization identifier. |
| entityId | int | Entity identifier linked to the card. |
| statusLabelInfo | object | Information about the card's status label. |
| — createdOn | string | Date when the status label was created. |
| — description | string | Description of the status label. |
| — entityStatusId | int | Identifier for the entity status. |
| — id | int | Unique identifier for the status label. |
| — isActive | boolean | Indicates if the status label is active. |
| — label | string | Label description (e.g., ACTIVE). |
| — orgId | int | Organization identifier. |
| — updatedOn | string | Date when the status label was last updated. |
| — status | string | Status value (e.g., ACTIVE). |
| — type | string | Type of entity the status label belongs to (e.g., CARD). |
| — actions | object | Actions related to the status label. |
| — default | boolean | Indicates if this is the default status label. |
| statusInfo | object | Additional status-related information. |
| — reason | string | Reason for the current status change. |
| — actions | array | List of actions related to status changes. |
| transactionNotAllowed | boolean | Indicates if transactions are disallowed on this card. |
| activeAndDigital | boolean | Indicates if the card is both active and digital. |
| warnings | array | List of warnings, if any. |
| — status | boolean | Warning status. |
| — code | int | Warning code. |
| — message | string | Warning message description. |