REreap-global
Card

Retrieve card design

Changed on
get/card-design/{cardDesignID}

Request

Path parameters

cardDesignIDstring uuid required

Headers

Accept-Versionstring required

Specifies the API version to use for this request.

Response

Return card design

idstring required

The unique identifier of the approved card design group.

namestring required

The name of the card design.

stockboolean required

Indicates whether there is available stock of blank physical cards in the warehouse, ready to be personalized with cardholder details. This is a boolean value:

true: Stock is available.

false: Stock is depleted, and you may need to contact your relationship manager to initiate the manufacturing of additional blank cards.

defaultboolean required

Indicates whether this card design is the default option.

If this design is marked as default, and the POST /cards endpoint is called without specifying a value in the cardDesignID field, the default design will automatically be assigned to the card.

embossNameSupportedboolean required

Indicates whether this card design supports the secondaryCardName field during card manufacturing and personalization.

true: This card design allows the secondaryCardName during physical card manufacturing and personalization.

false: This card design does not support the secondaryCardName during physical card manufacturing and personalization.

physicalArtworkUrlstring nullable

The URL of the physical card artwork for this card design. null when the design has no physical artwork. The URL changes when the artwork is replaced.

virtualArtworkUrlstring nullable

The URL of the virtual card artwork for this card design. null when the design has no virtual artwork. The URL changes when the artwork is replaced.

Changes

  • beb4b8d4eb01Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status