put https://{host}/v2/card/bulk
Lets you update details of existing cards in bulk. You can update details such as card status label, and custom/extended field values.
Request Body Parameter
| Parameter | Data Type | Description |
|---|---|---|
| cardNumber* | String | Unique card number to be updated. |
| statusLabel | String | New status label to set for the card. Allowed values: NOT_ISSUED, ACTIVE, ISSUED, SUSPENDED, DELETED, EXPIRED. |
| extendedFields | Object | Extended fields for additional metadata. |
| - custom_card_name | String | Custom name to associate with the card. |
| - vehicle_number | String | Vehicle number linked to the card. |
| - card_requested_by | String | Value indicating who requested the card. |
| mappedEntity | Object | Information about the entity mapped to the card. |
| - type | String | Type of entity (e.g., TILL). |
| - value | String | Name or value of the entity. |
| customFields | Object | Custom fields associated with the card. |
| - vehicle_type | String | Type of vehicle linked to the card (e.g., Car, Bike, Cycle). |
Response Body Parameters
| Parameter (parameters marked by * are mandatory) | DataType | Description |
|---|---|---|
| response* | array | List of card update responses. |
| — entityId | object | Card details object. |
| — — cardId | int | Unique identifier for the card. |
| — — customerId | int | Unique identifier for the customer linked to the card. |
| — — extendedFields | object | Additional key-value fields. |
| — — — custom_card_name | string | Custom card name. |
| — — — vehicle_number | string | Vehicle number linked to the card. |
| — — customFields | object | Custom fields as key-value pairs. |
| — — — vehicle_type | string | Type of vehicle (e.g., Car, Bike, Cycle). |
| — — mappedEntity | object | Information about the mapped entity. |
| — — — type | string | Type of entity (e.g., TILL). |
| — — — value | string | Value of the mapped entity. |
| — — — id | int | Unique identifier for the mapped entity. |
| — — cardNumber | string | Card number. |
| — — orgId | int | Unique identifier for the organization. |
| — — entityId | int | Unique identifier linked to the card. |
| — — statusLabel | string | Status label of the card (e.g., ACTIVE, SUSPENDED). |
| — — statusLabelInfo | object | Detailed information about the status label. |
| — — — createdOn | string | Date when the status label was created. |
| — — — description | string | Description of the status label. |
| — — — entityStatusId | int | Unique identifier for entity status. |
| — — — id | int | Unique identifier for the status label. |
| — — — isActive | boolean | Indicates whether the status label is active. |
| — — — label | string | Label description. |
| — — — orgId | int | Unique identifier for the organization. |
| — — — updatedOn | string | Date when the status label was last updated. |
| — — — status | string | Status value. |
| — — — type | string | Type of entity status label (e.g., CARD). |
| — — — actions | object | Actions related to the status label. |
| — — — default | boolean | Indicates whether this is the default label. |
| — — activeAndDigital | boolean | Indicates whether the card is active and digital. |
| — — transactionNotAllowed | boolean | Indicates whether transactions are allowed on this card. |
| errors | array | List of error objects related to the update. |
| — status | boolean | Status of the error. |
| — message | string | Description of the error. |
| — code | int | Unique identifier for the error code. |
| warnings | array | List of warnings related to the update. |
| — status | boolean | Status of the warning. |
| — message | string | Description of the warning. |
| — code | int | Unique identifier for the warning code. |
| totalCount* | int | Total number of processed card records. |
| failureCount | int | Number of failed card updates. |