Creates an Issuing Card
object.
Parameters
- currencystringRequired
The currency for the card.
- typeenumRequired
The type of card to issue. Possible values are
physical
orvirtual
.Possible enum valuesphysical
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.
- cardholderstringRequired
The Cardholder object with which the card will be associated.
- 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
. - statusenum
Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to
inactive
.Possible enum valuesactive
The card can approve authorizations. If the card is linked to a cardholder with past-due requirements, you may be unable to change the card’s status to ‘active’.
inactive
The card will decline authorizations with the
card_
reason.inactive
More parameters
- personalization_
designstring The personalization design object belonging to this card.
- pinobject
The desired PIN for this card.
- pin.
encrypted_ numberstring The card’s desired new PIN, encrypted under Stripe’s public key.
- replacement_
forstring The card this is meant to be a replacement for (if any).
- replacement_
reasonenum If
replacement_
is specified, this should indicate why that card is being replaced.for Possible enum valuesdamaged
The physical card has been damaged and cannot be used at terminals. This reason is only valid for cards of type
physical
.expired
The expiration date has passed or is imminent.
lost
The card was lost. This status is only valid if the card it replaces is marked as lost.
stolen
The card was stolen. This status is only valid if the card it replaces is marked as stolen.
- second_
linestring The second line to print on the card. Max length: 24 characters.
- shippingobject
The address where the card will be shipped.
- shipping.
addressobjectRequired The address that the card is shipped to.
- shipping.
address. citystringRequired City, district, suburb, town, or village.
- shipping.
address. countrystringRequired Two-letter country code (ISO 3166-1 alpha-2).
- shipping.
address. line1stringRequired Address line 1 (e.g., street, PO Box, or company name).
- shipping.
address. postal_ codestringRequired ZIP or postal code.
- shipping.
address. line2string Address line 2 (e.g., apartment, suite, unit, or building).
- shipping.
address. statestring State, county, province, or region.
- shipping.
namestringRequired The name printed on the shipping label when shipping the card.
- shipping.
address_ validationobject Address validation settings.
- shipping.
address_validation. modeenumRequired The address validation capabilities to use.
Possible enum valuesdisabled
The card will be shipped without validating or normalizing the shipping address.
normalization_
only The card will be shipped with the normalized address without validation. Undeliverable addresses won’t be blocked.
validation_
and_ normalization The card will be shipped with the normalized, validated address. Undeliverable addresses will be blocked.
- shipping.
customsobject Customs information for the shipment.
- shipping.
customs. eori_ numberstring The Economic Operators Registration and Identification (EORI) number to use for Customs. Required for bulk shipments to Europe.
- shipping.
phone_ numberstring Phone number of the recipient of the shipment.
- shipping.
require_ signatureboolean Whether a signature is required for card delivery.
- shipping.
serviceenum Shipment service.
Possible enum valuesexpress
Cards arrive in 4 business days.
priority
Cards arrive in 2-3 business days.
standard
Cards arrive in 5-8 business days.
- shipping.
typeenum Packaging options.
Possible enum valuesbulk
Cards are grouped and mailed together.
individual
Cards are sent individually in an envelope.
- spending_
controlsobject Rules that control spending for this card. Refer to our documentation for more details.
- spending_controls.
allowed_ categoriesarray of strings Array of strings containing categories of authorizations to allow. All other categories will be blocked. Cannot be set with
blocked_
.categories - spending_controls.
allowed_ merchant_ countriesarray of strings Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g.
US
). Cannot be set withblocked_
. Provide an empty value to unset this control.merchant_ countries - spending_controls.
blocked_ categoriesarray of strings Array of strings containing categories of authorizations to decline. All other categories will be allowed. Cannot be set with
allowed_
.categories - spending_controls.
blocked_ merchant_ countriesarray of strings Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g.
US
). Cannot be set withallowed_
. Provide an empty value to unset this control.merchant_ countries - spending_controls.
spending_ limitsarray of objects Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its
replacement_
card and that card’sfor replacement_
card, up the chain).for - spending_controls.
spending_limits. amountintegerRequired Maximum amount allowed to spend per interval.
- spending_controls.
spending_limits. intervalenumRequired Interval (or event) to which the amount applies.
Possible enum valuesall_
time Limit applies to all transactions.
daily
Limit applies to a day, starting at midnight UTC.
monthly
Limit applies to a month, starting on the 1st at midnight UTC.
per_
authorization Limit applies to each authorization.
weekly
Limit applies to a week, starting on Sunday at midnight UTC.
yearly
Limit applies to a year, starting on January 1st at midnight UTC.
- spending_controls.
spending_limits. categoriesarray of strings Array of strings containing categories this limit applies to. Omitting this field will apply the limit to all categories.
Returns
Returns an Issuing Card
object if creation succeeds.
{ "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 }}