Add Card Number to a Card Series

put https://{host}/v2/card/bulk?format=json

Sample cURL

curl --location --request PUT 'https://eu.api.capillarytech.com/v2/card/bulk?format=json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic U2FudC5wXzEpiMmVhMGFhYWI1ZThmODg5ZTAzNGE2NjA5NTIwM2FlNw==' \
--header 'Cookie: _cfuvid=LvoffYWnKNroiGI4mcPHub.st6yK1dPDHOW3wI1lEls-1751478744816-0.0.1.1-604800000' \
--data '[
    {
        "cardNumber": "24234234324345345345",
        "statusLabel": "ACTIVE",
        "extendedFields": {
            "custom_card_name": "TOM",
            "vehicle_number": "KA01B2020"
        },
        "mappedEntity": {
            "type": "TILL",
            "value": "rutuja_capillary"
        },
        "customFields": {
            "vehicle_type": "Bike"
        }
    },
    {
        "cardNumber": "Test09000000000012end",
        "statusLabel": "ACTIVE",
        "extendedFields": {
            "custom_card_name": "SOM",
            "vehicle_number": "KA01B2021",
            "card_requested_by": "rutuja_capillary"
        },
        "mappedEntity": {
            "type": "TILL",
            "value": "rutuja_capillary"
        },
        "customFields": {
            "vehicle_type": "Car"
        }
    },
    {
        "cardNumber": "Test09000000000004end",
        "statusLabel": "SUSPENDED",
        "extendedFields": {
            "custom_card_name": "DOM",
            "vehicle_number": "KA01B2019"
        },
        "mappedEntity": {
            "type": "TILL",
            "value": "rutuja_capillary"
        },
        "customFields": {
            "vehicle_type": "Cycle"
        }
    }
]'

Request Body Parameters

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 assigned to the card.
- vehicle_number	String	Vehicle number associated with 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 Parameters

Parameter	Data Type	Description
response	Array	List containing the result of each individual card update request.
- entityId	Object	Object containing details of the card entity after the update attempt.
-- cardId	Integer	Unique identifier of the card.
-- customerId	Integer	Unique identifier of the customer linked to the card.
-- extendedFields	Object	Additional metadata fields associated with the card.
--- custom_card_name	String	Custom name assigned to the card.
--- vehicle_number	String	Vehicle number associated with the card.
--- card_requested_by	String	Name of the user or system that requested the card.
-- customFields	Object	Custom fields containing additional card attributes.
--- vehicle_type	String	Type of vehicle associated with the card (e.g., `Car`, `Bike`, `Cycle`).
-- mappedEntity	Object	Information about the entity to which the card is mapped.
--- type	String	Type of the mapped entity (e.g., `TILL`).
--- value	String	Value or name of the mapped entity.
--- id	Integer	Unique identifier of the mapped entity (if present).
-- cardNumber	String	Unique card number.
-- orgId	Integer	Unique identifier of the organization.
-- entityId	Integer	Unique identifier of the card entity within the organization.
-- statusLabel	String	Current status label of the card (e.g., `ACTIVE`, `SUSPENDED`).
-- statusLabelInfo	Object	Detailed information about the current status of the card.
--- createdOn	String	Date when the current status was created.
--- updatedOn	String	Date when the status was last updated.
--- description	String	Description of the current status.
--- entityStatusId	Integer	Unique identifier of the entity status record.
--- id	Integer	Unique identifier of the status entry.
--- isActive	Boolean	Indicates whether the current status is active.
--- label	String	Status label value.
--- status	String	Current status value of the card.
--- type	String	Type of entity status (e.g., `CARD`).
--- actions	Object	Supported actions for this status (generally empty).
--- default	Boolean	Indicates if this is the default status.
-- activeAndDigital	Boolean	Indicates whether the card is both active and digital.
-- transactionNotAllowed	Boolean	Indicates if transactions are currently blocked on this card.
errors	Array	List of error objects if the update failed.
- status	Boolean	Status flag for the error.
- code	Integer	Unique error code.
- message	String	Descriptive error message.
warnings	Array	List of warning objects, if applicable.
- status	Boolean	Status flag for the warning.
- code	Integer	Unique warning code.
- message	String	Descriptive warning message.
totalCount	Integer	Total number of records processed in this request.
failureCount	Integer	Number of records that failed during processing.

Language

Credentials

Basic

base64

URL

Click Try It! to start a request and see the response here!