Attributes
- idstring
Unique identifier for the object.
- objectstring
String representing the object’s type. Objects of the same type share the same value.
- card_
logonullable stringExpandable The file for the card logo to use with physical bundles that support card logos. Must have a
purpose
value ofissuing_
.logo - carrier_
textnullable object Hash containing carrier text, for use with physical bundles that support carrier text.
- createdtimestamp
Time at which the object was created. Measured in seconds since the Unix epoch.
- livemodeboolean
Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - lookup_
keynullable string A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
- metadataobject
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.
- namenullable string
Friendly display name.
- physical_
bundlestringExpandable The physical bundle object belonging to this personalization design.
- preferencesobject
Hash containing information on whether this personalization design is used to create cards when one is not specified.
- rejection_
reasonsobject Hash containing reasons why the personalization design was rejected.
- statusenum
Whether this personalization design can be used to create cards.
Possible enum valuesactive
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.
{ "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"}
Creates a personalization design object.
Parameters
- physical_
bundlestringRequired The physical bundle object belonging to this personalization design.
- card_
logostring The file for the card logo, for use with physical bundles that support card logos. Must have a
purpose
value ofissuing_
.logo - carrier_
textobject Hash containing carrier text, for use with physical bundles that support carrier text.
- lookup_
keystring A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
- metadataobject
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
. - namestring
Friendly display name.
- preferencesobject
Information on whether this personalization design is used to create cards when one is not specified.
- transfer_
lookup_ keyboolean 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.
{ "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"}
Updates a card personalization object.
Parameters
- card_
logostring The file for the card logo, for use with physical bundles that support card logos. Must have a
purpose
value ofissuing_
.logo - carrier_
textobject Hash containing carrier text, for use with physical bundles that support carrier text.
- lookup_
keystring A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
- metadataobject
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
. - namestring
Friendly display name. Providing an empty string will set the field to null.
- physical_
bundlestring The physical bundle object belonging to this personalization design.
- preferencesobject
Information on whether this personalization design is used to create cards when one is not specified.
- transfer_
lookup_ keyboolean 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 updated 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": { "order_id": "6735" }, "name": "My personalization design name", "physical_bundle": "ics_Oiw9ahglMfql0U", "preferences": { "is_default": false }, "rejection_reasons": { "card_logo": [], "carrier_text": [] }, "status": "review"}
Retrieves a personalization design object.
Parameters
No parameters.
Returns
Returns 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"}
Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Parameters
- lookup_
keysarray of strings Only return personalization designs with the given lookup keys.
- preferencesobject
Only return personalization designs with the given preferences.
- statusenum
Only return personalization designs with the given status.
Possible enum valuesactive
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.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data
property that contains an array of up to limit
cards, starting after card starting_
. Each entry in the array is a separate personalization design object. If no more cards are available, the resulting array will be empty.
{ "object": "list", "url": "/v1/issuing/personalization_designs", "has_more": false, "data": [ { "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" } {...} {...} ],}