Get Card Details

Retrieves information about a specific card using the card number

The Get Card Details API retrieves information about a specific card using its unique card number. It returns details such as card identifiers, status, series, customer information, and any configured custom or extended fields. This API is read-only and does not update card information.

👍

Note

For 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 methodGET
AuthenticationBasic
Pagination supported?NO
Rate limitYES
Batch supportNO

Example request

curl --location 'https://eu.api.capillarytech.com/v2/card?format=json&number=from1m1n1000000000100too' \
--header 'Authorization: Basic =' \
--header 'Cookie: _cfuvid=Ke4hAFMfCGK4gDMjnzYbiJhhGLrie234r1j56zvpTfc-1756899809255-0.0.1.1-604800000' \
--data ''

Query parameters

FieldTypeRequiredDescription
numberstringYesCard number to retrieve details.

Example response

{
    "cardId": 904249,
    "issuedDate": "2025-06-13T08:19:33Z",
    "createdDate": "2025-06-13",
    "expiryDays": 1000,
    "seriesName": "card series create new",
    "customerId": 564590100,
    "maxActiveCards": 5,
    "entityCode": "rutuja_capillary",
    "cardExternalId": "externalId44",
    "customFields": {},
    "type": "DIGITAL",
    "cardNumber": "from1m1n1000000000100too",
    "seriesId": 169,
    "seriesCode": "Test094",
    "orgId": 100737,
    "entityId": 75155373,
    "statusInfo": {
        "reason": "",
        "createdBy": 904249,
        "actions": [],
        "autoUpdateTime": "2025-06-13",
        "createdOn": "2025-06-13T08:19:33Z",
        "entityId": 904249,
        "id": 27976955,
        "isActive": true,
        "labelId": 494,
        "label": "ACTIVE",
        "status": "ACTIVE"
    },
    "id": 904249,
    "activeAndDigital": true,
    "transactionNotAllowed": true,
    "expiryDate": "2028-03-09T00:00:00Z",
    "warnings": []
}

Response Parameters

ParameterTypeDescription
cardIdintUnique identifier for the card.
issuedDatestringDate and time when the card was issued.
createdDatestringDate when the card was created.
expiryDaysintNumber of days after issuance when the card will expire.
seriesNamestringName of the card series.
customerIdintUnique identifier of the customer associated with the card.
maxActiveCardsintMaximum number of active cards allowed.
entityCodestringCode of the entity associated with the card.
cardExternalIdstringExternal identifier for the card.
customFieldsobjectCustom field data as key-value pairs.
typestringType of card (e.g., DIGITAL).
cardNumberstringCard number assigned.
seriesIdintUnique identifier of the card series.
seriesCodestringCode of the card series.
orgIdintOrganization identifier.
entityIdintEntity identifier linked to the card.
statusInfoobjectStatus details of the card.
— reasonstringReason for the current status (if any).
— createdByintIdentifier of the user who created this status entry.
— actionsarrayList of actions related to status updates.
— autoUpdateTimestringDate when status was automatically updated.
— createdOnstringDate and time when the status was created.
— entityIdintEntity identifier related to this status.
— idintUnique identifier for the status entry.
— isActivebooleantrue if active; false if inactive.
— labelIdintIdentifier for the status label.
— labelstringLabel description of the status (e.g., ACTIVE).
— statusstringStatus code (e.g., ACTIVE).
idintUnique identifier for the card object.
activeAndDigitalbooleanIndicates if the card is both active and digital.
transactionNotAllowedbooleanIndicates if transactions are disallowed on this card.
expiryDatestringExpiry date and time of the card (ISO 8601 format).
warningsarrayList of warnings, if any.
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!