Retrieve a personalization design

Retrieves a personalization design object.

Parameters

No parameters.

Returns

Returns the personalization design object.

GET /v1/issuing/personalization_designs/:id

Server-side language

curl https://api.stripe.com/v1/issuing/personalization_designs/ipcd_Oiw9GXcFRE81LZ \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"

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"
}

List all personalization designs

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 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.

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_after. Each entry in the array is a separate personalization design object. If no more cards are available, the resulting array will be empty.

GET /v1/issuing/personalization_designs

Server-side language

curl -G https://api.stripe.com/v1/issuing/personalization_designs \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d limit=3

Response

{
  "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"
    }
    {...}
    {...}
  ],
}

Activate a testmode personalization designTest helper

Updates the status of the specified testmode personalization design object to active.

Parameters

No parameters.

Returns

Returns the updated personalization design object.

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

Server-side language

curl -X POST https://api.stripe.com/v1/test_helpers/issuing/personalization_designs/ipcd_Oiw9GXcFRE81LZ/activate \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"

Response

{
  "id": "ipcd_Oiw9GXcFRE81LZ",
  "object": "issuing.personalization_design",
  "livemode": false,
  "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": "active"
}

Deactivate a testmode personalization designTest helper

Updates the status of the specified testmode personalization design object to inactive.

Parameters

No parameters.

Returns

Returns the updated personalization design object.

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

Server-side language

curl -X POST https://api.stripe.com/v1/test_helpers/issuing/personalization_designs/ipcd_Oiw9GXcFRE81LZ/deactivate \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"

Response

{
  "id": "ipcd_Oiw9GXcFRE81LZ",
  "object": "issuing.personalization_design",
  "livemode": false,
  "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": "inactive"
}

Reject a testmode personalization designTest helper

Updates the status of the specified testmode personalization design object to rejected.

Parameters

rejection_reasonsobjectRequired
The reason(s) the personalization design was rejected.

Returns

Returns the updated personalization design object.

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

Server-side language

curl https://api.stripe.com/v1/test_helpers/issuing/personalization_designs/ipcd_Oiw9GXcFRE81LZ/reject \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d "rejection_reasons[card_logo][]"=network_name \
  -d "rejection_reasons[card_logo][]"=inappropriate \
  -d "rejection_reasons[carrier_text][]"=other

Response

{
  "id": "ipcd_Oiw9GXcFRE81LZ",
  "object": "issuing.personalization_design",
  "livemode": false,
  "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": [
      "network_name",
      "inappropriate"
    ],
    "carrier_text": [
      "other"
    ]
  },
  "status": "rejected"
}

Retrieve a personalization design

Parameters

Returns

List all personalization designs

Parameters

lookup_keysarray of strings

preferencesobject

statusenum

More parametersExpand all

ending_beforestring

limitinteger

starting_afterstring

Returns

Activate a testmode personalization designTest helper

Parameters

Returns

Deactivate a testmode personalization designTest helper

Parameters

Returns

Reject a testmode personalization designTest helper

Parameters

rejection_reasonsobjectRequired

Returns

More parameters