Personalization Designs

A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line.

Was this section helpful? Yes No

Create a personalization design

POST / v1 / issuing / personalization_designs

Update a personalization design

POST / v1 / issuing / personalization_designs /:id

Retrieve a personalization design

GET / v1 / issuing / personalization_designs /:id

List all personalization designs

GET / v1 / issuing / personalization_designs

Activate a testmode personalization design

POST / v1 / test_helpers / issuing / personalization_designs /:id / activate

Deactivate a testmode personalization design

POST / v1 / test_helpers / issuing / personalization_designs /:id / deactivate

Reject a testmode personalization design

POST / v1 / test_helpers / issuing / personalization_designs /:id / reject

The Personalization Design object

Attributes

• id string Unique identifier for the object.
• object string, value is "issuing.personalization_design" String representing the object’s type. Objects of the same type share the same value.
• card _ logo nullable string Expandable The file for the card logo to use with physical bundles that support card logos. Must have a purpose value of issuing_logo. Image must be in PNG format with dimensions of 1000px by 200px. It must be a binary (black and white) image containing a black logo on a white background. We don’t accept grayscale.
• carrier _ text nullable object Hash containing carrier text, for use with physical bundles that support carrier text.
• created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
• livemode boolean If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
• lookup _ key nullable string A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
• metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
• name nullable string Friendly display name.
• physical _ bundle string Expandable The physical bundle object belonging to this personalization design.
• preferences object Hash containing information on whether this personalization design is used to create cards when one is not specified.
• rejection _ reasons object Hash containing reasons why the personalization design was rejected.
• status enum Whether this personalization design can be used to create cards. Possible enum values active Personalization design can be used to create cards that fulfill immediately. inactive Personalization design cannot be used to create cards because it was deactivated. rejected Personalization design cannot be used to create cards because it was rejected by design review. review Personalization design can be used to create cards but cards will only be fulfilled once the personalization design is activated.

The Personalization Design object

{ "id": "ipcd_Oiw9GXcFRE81LZ", "object": "issuing.personalization_design", "livemode": true, "card_logo": "file_1LzR9L2eZvKYlo2CelTpcvKu", "carrier_text": null, "lookup_key": "my_card_design_lookup_key", "metadata": {}, "name": "My personalization design name", "physical_bundle": "ics_Oiw9ahglMfql0U", "preferences": { "is_default": false }, "rejection_reasons": { "card_logo": [], "carrier_text": [] }, "status": "review"}

Create a personalization design

POST / v1 / issuing / personalization_designs

Creates a personalization design object.

Parameters

• physical _ bundle string Required The physical bundle object belonging to this personalization design.
• card _ logo string The file for the card logo, for use with physical bundles that support card logos. Must have a purpose value of issuing_logo.
• carrier _ text object Hash containing carrier text, for use with physical bundles that support carrier text.
• lookup _ key string A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters. The maximum length is 200 characters.
• metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
• name string Friendly display name. The maximum length is 200 characters.
• preferences object Information on whether this personalization design is used to create cards when one is not specified.
• transfer _ lookup _ key boolean If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.

Returns

Returns the created personalization design object.

Response

{ "id": "ipcd_Oiw9GXcFRE81LZ", "object": "issuing.personalization_design", "livemode": true, "card_logo": "file_1LzR9L2eZvKYlo2CelTpcvKu", "carrier_text": null, "lookup_key": "my_card_design_lookup_key", "metadata": {}, "name": "My personalization design name", "physical_bundle": "ics_Oiw9ahglMfql0U", "preferences": { "is_default": false }, "rejection_reasons": { "card_logo": [], "carrier_text": [] }, "status": "review"}