List all cards

Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Parameters

  • cardholderstring

    Only return cards belonging to the Cardholder with the provided ID.

  • typeenum

    Only return cards that have the given type. One of virtual or physical.

    Possible enum values
    physical

    A physical card will be printed and shipped. It can be used at physical terminals.

    virtual

    No physical card will be printed. The card can be used online and can be added to digital wallets.

More parameters

  • createdobject

  • ending_beforestring

  • exp_monthinteger

  • exp_yearinteger

  • last4string

  • limitinteger

  • starting_afterstring

  • statusenum

Returns

A object 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 Issuing Card object. If no more cards are available, the resulting array will be empty.

GET /v1/issuing/cards
const stripe = require('stripe')('sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc');
const cards = await stripe.issuing.cards.list({
limit: 3,
});
Response
{
"object": "list",
"url": "/v1/issuing/cards",
"has_more": false,
"data": [
{
"id": "ic_1MvSieLkdIwHu7ixn6uuO0Xu",
"object": "issuing.card",
"brand": "Visa",
"cancellation_reason": null,
"cardholder": {
"id": "ich_1MsKAB2eZvKYlo2C3eZ2BdvK",
"object": "issuing.cardholder",
"billing": {
"address": {
"city": "Anytown",
"country": "US",
"line1": "123 Main Street",
"line2": null,
"postal_code": "12345",
"state": "CA"
}
},
"company": null,
"created": 1680415995,
"email": null,
"individual": null,
"livemode": false,
"metadata": {},
"name": "John Doe",
"phone_number": null,
"requirements": {
"disabled_reason": "requirements.past_due",
"past_due": [
"individual.card_issuing.user_terms_acceptance.ip",
"individual.card_issuing.user_terms_acceptance.date",
"individual.first_name",
"individual.last_name"
]
},
"spending_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "individual"
},
"created": 1681163868,
"currency": "usd",
"exp_month": 8,
"exp_year": 2024,
"last4": "4242",
"livemode": false,
"metadata": {},
"replaced_by": null,
"replacement_for": null,
"replacement_reason": null,
"shipping": null,
"spending_controls": {
"allowed_categories": null,
"blocked_categories": null,
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "virtual",
"wallets": {
"apple_pay": {
"eligible": false,
"ineligible_reason": "missing_cardholder_contact"
},
"google_pay": {
"eligible": false,
"ineligible_reason": "missing_cardholder_contact"
},
"primary_account_identifier": null
}
}
{...}
{...}
],
}

Deliver a testmode cardTest helper

Updates the shipping status of the specified Issuing Card object to delivered.

Parameters

No parameters.

Returns

Returns an updated Issuing Card object.

POST /v1/test_helpers/issuing/cards/:id/shipping/deliver
const stripe = require('stripe')('sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc');
const card = await stripe.testHelpers.issuing.cards.deliverCard(
'ic_1MvSieLkdIwHu7ixn6uuO0Xu'
);
Response
{
"id": "ic_1MvSieLkdIwHu7ixn6uuO0Xu",
"object": "issuing.card",
"brand": "Visa",
"cancellation_reason": null,
"cardholder": {
"id": "ich_1MsKAB2eZvKYlo2C3eZ2BdvK",
"object": "issuing.cardholder",
"billing": {
"address": {
"city": "Anytown",
"country": "US",
"line1": "123 Main Street",
"line2": null,
"postal_code": "12345",
"state": "CA"
}
},
"company": null,
"created": 1680415995,
"email": null,
"individual": null,
"livemode": false,
"metadata": {},
"name": "John Doe",
"phone_number": null,
"requirements": {
"disabled_reason": "requirements.past_due",
"past_due": [
"individual.card_issuing.user_terms_acceptance.ip",
"individual.card_issuing.user_terms_acceptance.date",
"individual.first_name",
"individual.last_name"
]
},
"spending_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "individual"
},
"created": 1681163868,
"currency": "usd",
"exp_month": 8,
"exp_year": 2024,
"last4": "4242",
"livemode": false,
"metadata": {},
"replaced_by": null,
"replacement_for": null,
"replacement_reason": null,
"shipping": {
"address": {
"city": "San Francisco",
"country": "US",
"line1": "1234 Main Street",
"postal_code": "94111",
"state": "CA"
},
"carrier": "usps",
"eta": 1655362799,
"name": "Jenny Rosen",
"service": "standard",
"status": "delivered",
"type": "individual"
},
"spending_controls": {
"allowed_categories": null,
"blocked_categories": null,
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "physical",
"wallets": {
"apple_pay": {
"eligible": false,
"ineligible_reason": "missing_cardholder_contact"
},
"google_pay": {
"eligible": false,
"ineligible_reason": "missing_cardholder_contact"
},
"primary_account_identifier": null
}
}

Fail a testmode cardTest helper

Updates the shipping status of the specified Issuing Card object to failure.

Parameters

No parameters.

Returns

Returns an updated Issuing Card object.

POST /v1/test_helpers/issuing/cards/:id/shipping/fail
const stripe = require('stripe')('sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc');
const card = await stripe.testHelpers.issuing.cards.failCard(
'ic_1MvSieLkdIwHu7ixn6uuO0Xu'
);
Response
{
"id": "ic_1MvSieLkdIwHu7ixn6uuO0Xu",
"object": "issuing.card",
"brand": "Visa",
"cancellation_reason": null,
"cardholder": {
"id": "ich_1MsKAB2eZvKYlo2C3eZ2BdvK",
"object": "issuing.cardholder",
"billing": {
"address": {
"city": "Anytown",
"country": "US",
"line1": "123 Main Street",
"line2": null,
"postal_code": "12345",
"state": "CA"
}
},
"company": null,
"created": 1680415995,
"email": null,
"individual": null,
"livemode": false,
"metadata": {},
"name": "John Doe",
"phone_number": null,
"requirements": {
"disabled_reason": "requirements.past_due",
"past_due": [
"individual.card_issuing.user_terms_acceptance.ip",
"individual.card_issuing.user_terms_acceptance.date",
"individual.first_name",
"individual.last_name"
]
},
"spending_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "individual"
},
"created": 1681163868,
"currency": "usd",
"exp_month": 8,
"exp_year": 2024,
"last4": "4242",
"livemode": false,
"metadata": {},
"replaced_by": null,
"replacement_for": null,
"replacement_reason": null,
"shipping": {
"address": {
"city": "San Francisco",
"country": "US",
"line1": "1234 Main Street",
"postal_code": "94111",
"state": "CA"
},
"carrier": "usps",
"eta": 1655362799,
"name": "Jenny Rosen",
"service": "standard",
"status": "failed",
"type": "individual"
},
"spending_controls": {
"allowed_categories": null,
"blocked_categories": null,
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "physical",
"wallets": {
"apple_pay": {
"eligible": false,
"ineligible_reason": "missing_cardholder_contact"
},
"google_pay": {
"eligible": false,
"ineligible_reason": "missing_cardholder_contact"
},
"primary_account_identifier": null
}
}

Return a testmode cardTest helper

Updates the shipping status of the specified Issuing Card object to returned.

Parameters

No parameters.

Returns

Returns an updated Issuing Card object.

POST /v1/test_helpers/issuing/cards/:id/shipping/return
const stripe = require('stripe')('sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc');
const card = await stripe.testHelpers.issuing.cards.returnCard(
'ic_1MvSieLkdIwHu7ixn6uuO0Xu'
);
Response
{
"id": "ic_1MvSieLkdIwHu7ixn6uuO0Xu",
"object": "issuing.card",
"brand": "Visa",
"cancellation_reason": null,
"cardholder": {
"id": "ich_1MsKAB2eZvKYlo2C3eZ2BdvK",
"object": "issuing.cardholder",
"billing": {
"address": {
"city": "Anytown",
"country": "US",
"line1": "123 Main Street",
"line2": null,
"postal_code": "12345",
"state": "CA"
}
},
"company": null,
"created": 1680415995,
"email": null,
"individual": null,
"livemode": false,
"metadata": {},
"name": "John Doe",
"phone_number": null,
"requirements": {
"disabled_reason": "requirements.past_due",
"past_due": [
"individual.card_issuing.user_terms_acceptance.ip",
"individual.card_issuing.user_terms_acceptance.date",
"individual.first_name",
"individual.last_name"
]
},
"spending_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "individual"
},
"created": 1681163868,
"currency": "usd",
"exp_month": 8,
"exp_year": 2024,
"last4": "4242",
"livemode": false,
"metadata": {},
"replaced_by": null,
"replacement_for": null,
"replacement_reason": null,
"shipping": {
"address": {
"city": "San Francisco",
"country": "US",
"line1": "1234 Main Street",
"postal_code": "94111",
"state": "CA"
},
"carrier": "usps",
"eta": 1655362799,
"name": "Jenny Rosen",
"service": "standard",
"status": "returned",
"type": "individual"
},
"spending_controls": {
"allowed_categories": null,
"blocked_categories": null,
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "physical",
"wallets": {
"apple_pay": {
"eligible": false,
"ineligible_reason": "missing_cardholder_contact"
},
"google_pay": {
"eligible": false,
"ineligible_reason": "missing_cardholder_contact"
},
"primary_account_identifier": null
}
}

Ship a testmode cardTest helper

Updates the shipping status of the specified Issuing Card object to shipped.

Parameters

No parameters.

Returns

Returns an updated Issuing Card object.

POST /v1/test_helpers/issuing/cards/:id/shipping/ship
const stripe = require('stripe')('sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc');
const card = await stripe.testHelpers.issuing.cards.shipCard(
'ic_1MvSieLkdIwHu7ixn6uuO0Xu'
);
Response
{
"id": "ic_1MvSieLkdIwHu7ixn6uuO0Xu",
"object": "issuing.card",
"brand": "Visa",
"cancellation_reason": null,
"cardholder": {
"id": "ich_1MsKAB2eZvKYlo2C3eZ2BdvK",
"object": "issuing.cardholder",
"billing": {
"address": {
"city": "Anytown",
"country": "US",
"line1": "123 Main Street",
"line2": null,
"postal_code": "12345",
"state": "CA"
}
},
"company": null,
"created": 1680415995,
"email": null,
"individual": null,
"livemode": false,
"metadata": {},
"name": "John Doe",
"phone_number": null,
"requirements": {
"disabled_reason": "requirements.past_due",
"past_due": [
"individual.card_issuing.user_terms_acceptance.ip",
"individual.card_issuing.user_terms_acceptance.date",
"individual.first_name",
"individual.last_name"
]
},
"spending_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "individual"
},
"created": 1681163868,
"currency": "usd",
"exp_month": 8,
"exp_year": 2024,
"last4": "4242",
"livemode": false,
"metadata": {},
"replaced_by": null,
"replacement_for": null,
"replacement_reason": null,
"shipping": {
"address": {
"city": "San Francisco",
"country": "US",
"line1": "1234 Main Street",
"postal_code": "94111",
"state": "CA"
},
"carrier": "usps",
"eta": 1655362799,
"name": "Jenny Rosen",
"service": "standard",
"status": "shipped",
"type": "individual"
},
"spending_controls": {
"allowed_categories": null,
"blocked_categories": null,
"spending_limits": [],
"spending_limits_currency": null
},
"status": "active",
"type": "physical",
"wallets": {
"apple_pay": {
"eligible": false,
"ineligible_reason": "missing_cardholder_contact"
},
"google_pay": {
"eligible": false,
"ineligible_reason": "missing_cardholder_contact"
},
"primary_account_identifier": null
}
}
Stripe Shell
Test mode
Welcome to the Stripe Shell! Stripe Shell is a browser-based shell with the Stripe CLI pre-installed. Log in to your Stripe account and press Control + Backtick (`) on your keyboard to start managing your Stripe resources in test mode. - View supported Stripe commands: - Find webhook events: - Listen for webhook events: - Call Stripe APIs: stripe [api resource] [operation] (e.g., )
The Stripe Shell is best experienced on desktop.
$