Stripe: Test helpers schemas

← Test helpers operations · All schemas

Create a test clock — response body

Field	Type	Presence	Description and constraints
$	object	Root	A test clock enables deterministic control over objects in testmode. With a test clock, you can create objects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances, you can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time.
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
deletes_after	JSON	Required within parent
deletes_after (anyOf 1)	integer	Alternative	Time at which this clock is scheduled to auto delete. Format: unix-time
deletes_after (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
frozen_time	JSON	Required within parent
frozen_time (anyOf 1)	integer	Alternative	Time at which all objects belonging to this clock are frozen. Format: unix-time
frozen_time (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
name	JSON	Optional
name (anyOf 1)	string	Alternative	The custom name supplied at creation. Maximum length: 5000
name (anyOf 2)	null	Alternative
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: test_helpers.test_clock
status	string	Required within parent	The status of the Test Clock. Known values: advancing, internal_failure, ready
status_details	Model	Required within parent	Expand Create a test clock — response body — status details

Referenced models: Create a test clock — response body — status details

Create a test clock — response body — status details

Field	Type	Presence	Description and constraints
$	object	Root
advancing	Model	Optional	Expand Create a test clock — response body — status details advancing

Referenced models: Create a test clock — response body — status details advancing

Create a test clock — response body — status details advancing

Field	Type	Presence	Description and constraints
$	object	Root
target_frozen_time	JSON	Required within parent
target_frozen_time (anyOf 1)	integer	Alternative	The `frozen_time` that the Test Clock is advancing towards. Format: unix-time
target_frozen_time (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create a test-mode authorization — request body — body fleet

Field	Type	Presence	Description and constraints
$	object	Root	Fleet-specific information for authorizations using Fleet cards.
cardholder_prompt_data	object	Optional
cardholder_prompt_data.driver_id	string	Optional	Maximum length: 5000
cardholder_prompt_data.odometer	integer	Optional
cardholder_prompt_data.unspecified_id	string	Optional	Maximum length: 5000
cardholder_prompt_data.user_id	string	Optional	Maximum length: 5000
cardholder_prompt_data.vehicle_number	string	Optional	Maximum length: 5000
purchase_type	string	Optional	One of: fuel_and_non_fuel_purchase, fuel_purchase, non_fuel_purchase Maximum length: 5000
reported_breakdown	object	Optional
reported_breakdown.fuel	object	Optional
reported_breakdown.fuel.gross_amount_decimal	string	Optional	Format: decimal
reported_breakdown.non_fuel	object	Optional
reported_breakdown.non_fuel.gross_amount_decimal	string	Optional	Format: decimal
reported_breakdown.tax	object	Optional
reported_breakdown.tax.local_amount_decimal	string	Optional	Format: decimal
reported_breakdown.tax.national_amount_decimal	string	Optional	Format: decimal
service_type	string	Optional	One of: full_service, non_fuel_transaction, self_service Maximum length: 5000

Create a test-mode authorization — request body — body fuel

Field	Type	Presence	Description and constraints
$	object	Root	Information about fuel that was purchased with this transaction.
industry_product_code	string	Optional	Maximum length: 5000
quantity_decimal	string	Optional	Format: decimal
type	string	Optional	One of: diesel, other, unleaded_plus, unleaded_regular, unleaded_super Maximum length: 5000
unit	string	Optional	One of: charging_minute, imperial_gallon, kilogram, kilowatt_hour, liter, other, pound, us_gallon Maximum length: 5000
unit_cost_decimal	string	Optional	Format: decimal

Create a test-mode authorization — request body — body merchant data

Field	Type	Presence	Description and constraints
$	object	Root	Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.
category	string	Optional	One of: ac_refrigeration_repair, accounting_bookkeeping_services, advertising_services, agricultural_cooperative, airlines_air_carriers, airports_flying_fields, ambulance_services, amusement_parks_carnivals, antique_reproductions, antique_shops, aquariums, architectural_surveying_services, art_dealers_and_galleries, artists_supply_and_craft_shops, auto_and_home_supply_stores, auto_body_repair_shops, auto_paint_shops, auto_service_shops, automated_cash_disburse, automated_fuel_dispensers, automobile_associations, automotive_parts_and_accessories_stores, automotive_tire_stores, bail_and_bond_payments, bakeries, bands_orchestras, barber_and_beauty_shops, betting_casino_gambling, bicycle_shops, billiard_pool_establishments, boat_dealers, boat_rentals_and_leases, book_stores, books_periodicals_and_newspapers, bowling_alleys, bus_lines, business_secretarial_schools, buying_shopping_services, cable_satellite_and_other_pay_television_and_radio, camera_and_photographic_supply_stores, candy_nut_and_confectionery_stores, car_and_truck_dealers_new_used, car_and_truck_dealers_used_only, car_rental_agencies, car_washes, carpentry_services, carpet_upholstery_cleaning, caterers, charitable_and_social_service_organizations_fundraising, chemicals_and_allied_products, child_care_services, childrens_and_infants_wear_stores, chiropodists_podiatrists, chiropractors, cigar_stores_and_stands, civic_social_fraternal_associations, cleaning_and_maintenance, clothing_rental, colleges_universities, commercial_equipment, commercial_footwear, commercial_photography_art_and_graphics, commuter_transport_and_ferries, computer_network_services, computer_programming, computer_repair, computer_software_stores, computers_peripherals_and_software, concrete_work_services, construction_materials, consulting_public_relations, correspondence_schools, cosmetic_stores, counseling_services, country_clubs, courier_services, court_costs, credit_reporting_agencies, cruise_lines, dairy_products_stores, dance_hall_studios_schools, dating_escort_services, dentists_orthodontists, department_stores, detective_agencies, digital_goods_applications, digital_goods_games, digital_goods_large_volume, digital_goods_media, direct_marketing_catalog_merchant, direct_marketing_combination_catalog_and_retail_merchant, direct_marketing_inbound_telemarketing, direct_marketing_insurance_services, direct_marketing_other, direct_marketing_outbound_telemarketing, direct_marketing_subscription, direct_marketing_travel, discount_stores, doctors, door_to_door_sales, drapery_window_covering_and_upholstery_stores, drinking_places, drug_stores_and_pharmacies, drugs_drug_proprietaries_and_druggist_sundries, dry_cleaners, durable_goods, duty_free_stores, eating_places_restaurants, educational_services, electric_razor_stores, electric_vehicle_charging, electrical_parts_and_equipment, electrical_services, electronics_repair_shops, electronics_stores, elementary_secondary_schools, emergency_services_gcas_visa_use_only, employment_temp_agencies, equipment_rental, exterminating_services, family_clothing_stores, fast_food_restaurants, financial_institutions, fines_government_administrative_entities, fireplace_fireplace_screens_and_accessories_stores, floor_covering_stores, florists, florists_supplies_nursery_stock_and_flowers, freezer_and_locker_meat_provisioners, fuel_dealers_non_automotive, funeral_services_crematories, furniture_home_furnishings_and_equipment_stores_except_appliances, furniture_repair_refinishing, furriers_and_fur_shops, general_services, gift_card_novelty_and_souvenir_shops, glass_paint_and_wallpaper_stores, glassware_crystal_stores, golf_courses_public, government_licensed_horse_dog_racing_us_region_only, government_licensed_online_casions_online_gambling_us_region_only, government_owned_lotteries_non_us_region, government_owned_lotteries_us_region_only, government_services, grocery_stores_supermarkets, hardware_equipment_and_supplies, hardware_stores, health_and_beauty_spas, hearing_aids_sales_and_supplies, heating_plumbing_a_c, hobby_toy_and_game_shops, home_supply_warehouse_stores, hospitals, hotels_motels_and_resorts, household_appliance_stores, industrial_supplies, information_retrieval_services, insurance_default, insurance_underwriting_premiums, intra_company_purchases, jewelry_stores_watches_clocks_and_silverware_stores, landscaping_services, laundries, laundry_cleaning_services, legal_services_attorneys, luggage_and_leather_goods_stores, lumber_building_materials_stores, manual_cash_disburse, marinas_service_and_supplies, marketplaces, masonry_stonework_and_plaster, massage_parlors, medical_and_dental_labs, medical_dental_ophthalmic_and_hospital_equipment_and_supplies, medical_services, membership_organizations, mens_and_boys_clothing_and_accessories_stores, mens_womens_clothing_stores, metal_service_centers, miscellaneous_apparel_and_accessory_shops, miscellaneous_auto_dealers, miscellaneous_business_services, miscellaneous_food_stores, miscellaneous_general_merchandise, miscellaneous_general_services, miscellaneous_home_furnishing_specialty_stores, miscellaneous_publishing_and_printing, miscellaneous_recreation_services, miscellaneous_repair_shops, miscellaneous_specialty_retail, mobile_home_dealers, motion_picture_theaters, motor_freight_carriers_and_trucking, motor_homes_dealers, motor_vehicle_supplies_and_new_parts, motorcycle_shops_and_dealers, motorcycle_shops_dealers, music_stores_musical_instruments_pianos_and_sheet_music, news_dealers_and_newsstands, non_fi_money_orders, non_fi_stored_value_card_purchase_load, nondurable_goods, nurseries_lawn_and_garden_supply_stores, nursing_personal_care, office_and_commercial_furniture, opticians_eyeglasses, optometrists_ophthalmologist, orthopedic_goods_prosthetic_devices, osteopaths, package_stores_beer_wine_and_liquor, paints_varnishes_and_supplies, parking_lots_garages, passenger_railways, pawn_shops, pet_shops_pet_food_and_supplies, petroleum_and_petroleum_products, photo_developing, photographic_photocopy_microfilm_equipment_and_supplies, photographic_studios, picture_video_production, piece_goods_notions_and_other_dry_goods, plumbing_heating_equipment_and_supplies, political_organizations, postal_services_government_only, precious_stones_and_metals_watches_and_jewelry, professional_services, public_warehousing_and_storage, quick_copy_repro_and_blueprint, railroads, real_estate_agents_and_managers_rentals, record_stores, recreational_vehicle_rentals, religious_goods_stores, religious_organizations, roofing_siding_sheet_metal, secretarial_support_services, security_brokers_dealers, service_stations, sewing_needlework_fabric_and_piece_goods_stores, shoe_repair_hat_cleaning, shoe_stores, small_appliance_repair, snowmobile_dealers, special_trade_services, specialty_cleaning, sporting_goods_stores, sporting_recreation_camps, sports_and_riding_apparel_stores, sports_clubs_fields, stamp_and_coin_stores, stationary_office_supplies_printing_and_writing_paper, stationery_stores_office_and_school_supply_stores, swimming_pools_sales, t_ui_travel_germany, tailors_alterations, tax_payments_government_agencies, tax_preparation_services, taxicabs_limousines, telecommunication_equipment_and_telephone_sales, telecommunication_services, telegraph_services, tent_and_awning_shops, testing_laboratories, theatrical_ticket_agencies, timeshares, tire_retreading_and_repair, tolls_bridge_fees, tourist_attractions_and_exhibits, towing_services, trailer_parks_campgrounds, transportation_services, travel_agencies_tour_operators, truck_stop_iteration, truck_utility_trailer_rentals, typesetting_plate_making_and_related_services, typewriter_stores, u_s_federal_government_agencies_or_departments, uniforms_commercial_clothing, used_merchandise_and_secondhand_stores, utilities, variety_stores, veterinary_services, video_amusement_game_supplies, video_game_arcades, video_tape_rental_stores, vocational_trade_schools, watch_jewelry_repair, welding_repair, wholesale_clubs, wig_and_toupee_stores, wires_money_orders, womens_accessory_and_specialty_shops, womens_ready_to_wear_stores, wrecking_and_salvage_yards Maximum length: 5000
city	string	Optional	Maximum length: 5000
country	string	Optional	Maximum length: 5000
name	string	Optional	Maximum length: 5000
network_id	string	Optional	Maximum length: 5000
postal_code	string	Optional	Maximum length: 5000
state	string	Optional	Maximum length: 5000
terminal_id	string	Optional	Maximum length: 5000
url	string	Optional	Maximum length: 5000

Create a test-mode force capture — request body — body purchase details

Field	Type	Presence	Description and constraints
$	object	Root	Additional purchase information that is optionally provided by the merchant.
fleet	Model	Optional	Expand Create a test-mode force capture — request body — body purchase details fleet
flight	Model	Optional	Expand Create a test-mode force capture — request body — body purchase details flight
fuel	Model	Optional	Expand Create a test-mode force capture — request body — body purchase details fuel
lodging	object	Optional
lodging.check_in_at	integer	Optional	Format: unix-time
lodging.nights	integer	Optional
receipt	array	Optional
receipt[]	object	Each item
receipt[].description	string	Optional	Maximum length: 26
receipt[].quantity	string	Optional	Format: decimal
receipt[].total	integer	Optional
receipt[].unit_cost	integer	Optional
reference	string	Optional	Maximum length: 5000

Referenced models: Create a test-mode force capture — request body — body purchase details fleet, Create a test-mode force capture — request body — body purchase details flight, Create a test-mode force capture — request body — body purchase details fuel

Create a test-mode force capture — request body — body purchase details fleet

Field	Type	Presence	Description and constraints
$	object	Root
cardholder_prompt_data	object	Optional
cardholder_prompt_data.driver_id	string	Optional	Maximum length: 5000
cardholder_prompt_data.odometer	integer	Optional
cardholder_prompt_data.unspecified_id	string	Optional	Maximum length: 5000
cardholder_prompt_data.user_id	string	Optional	Maximum length: 5000
cardholder_prompt_data.vehicle_number	string	Optional	Maximum length: 5000
purchase_type	string	Optional	One of: fuel_and_non_fuel_purchase, fuel_purchase, non_fuel_purchase Maximum length: 5000
reported_breakdown	object	Optional
reported_breakdown.fuel	object	Optional
reported_breakdown.fuel.gross_amount_decimal	string	Optional	Format: decimal
reported_breakdown.non_fuel	object	Optional
reported_breakdown.non_fuel.gross_amount_decimal	string	Optional	Format: decimal
reported_breakdown.tax	object	Optional
reported_breakdown.tax.local_amount_decimal	string	Optional	Format: decimal
reported_breakdown.tax.national_amount_decimal	string	Optional	Format: decimal
service_type	string	Optional	One of: full_service, non_fuel_transaction, self_service Maximum length: 5000

Create a test-mode force capture — request body — body purchase details flight

Field	Type	Presence	Description and constraints
$	object	Root
departure_at	integer	Optional	Format: unix-time
passenger_name	string	Optional	Maximum length: 5000
refundable	boolean	Optional
segments	array	Optional
segments[]	object	Each item
segments[].arrival_airport_code	string	Optional	Maximum length: 3
segments[].carrier	string	Optional	Maximum length: 5000
segments[].departure_airport_code	string	Optional	Maximum length: 3
segments[].flight_number	string	Optional	Maximum length: 5000
segments[].service_class	string	Optional	Maximum length: 5000
segments[].stopover_allowed	boolean	Optional
travel_agency	string	Optional	Maximum length: 5000

Create a test-mode force capture — request body — body purchase details fuel

Field	Type	Presence	Description and constraints
$	object	Root
industry_product_code	string	Optional	Maximum length: 5000
quantity_decimal	string	Optional	Format: decimal
type	string	Optional	One of: diesel, other, unleaded_plus, unleaded_regular, unleaded_super Maximum length: 5000
unit	string	Optional	One of: charging_minute, imperial_gallon, kilogram, kilowatt_hour, liter, other, pound, us_gallon Maximum length: 5000
unit_cost_decimal	string	Optional	Format: decimal

Delete a test clock — response body

Field	Type	Presence	Description and constraints
$	object	Root
deleted	boolean	Required within parent	Always true for a deleted object Known values: True
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: test_helpers.test_clock

Fail a testmode card — response body

Field	Type	Presence	Description and constraints
$	object	Root	You can [create physical or virtual cards](https://docs.stripe.com/issuing) that are issued to cardholders.
brand	string	Required within parent	The brand of the card. Maximum length: 5000
cancellation_reason	JSON	Optional
cancellation_reason (anyOf 1)	string	Alternative	The reason why the card was canceled. Known values: design_rejected, fulfillment_error, lost, stolen
cancellation_reason (anyOf 2)	null	Alternative
cardholder	Model	Required within parent	Expand Create a cardholder — response body
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency	string	Required within parent	Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK. Format: currency
cvc	string	Optional	The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://docs.stripe.com/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://docs.stripe.com/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. Maximum length: 5000
exp_month	JSON	Required within parent
exp_month (anyOf 1)	integer	Alternative	The expiration month of the card.
exp_month (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
exp_year	JSON	Required within parent
exp_year (anyOf 1)	integer	Alternative	The expiration year of the card.
exp_year (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
financial_account	JSON	Optional
financial_account (anyOf 1)	string	Alternative	The financial account this card is attached to. Maximum length: 5000
financial_account (anyOf 2)	null	Alternative
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
last4	string	Required within parent	The last 4 digits of the card number. Maximum length: 5000
latest_fraud_warning	JSON	Optional
latest_fraud_warning (anyOf 1)	JSON	Alternative	Stripe’s assessment of whether this card’s details have been compromised. If this property isn't null, cancel and reissue the card to prevent fraudulent activity risk.
latest_fraud_warning (anyOf 1) (anyOf 1)	Model	Alternative	Expand Fail a testmode card — response body — latest fraud warning value started at, type
latest_fraud_warning (anyOf 2)	null	Alternative
lifecycle_controls	JSON	Optional
lifecycle_controls (anyOf 1)	JSON	Alternative	Rules that control the lifecycle of this card, such as automatic cancellation. Refer to our [documentation](/issuing/controls/lifecycle-controls) for more details.
lifecycle_controls (anyOf 1) (anyOf 1)	Model	Alternative	Expand Fail a testmode card — response body — lifecycle controls value cancel after
lifecycle_controls (anyOf 2)	null	Alternative
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadata	object	Required within parent	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field
metadata.*	string	Additional keys	Maximum length: 500
number	string	Optional	The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://docs.stripe.com/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://docs.stripe.com/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. Maximum length: 5000
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: issuing.card
personalization_design	JSON	Optional
personalization_design (anyOf 1)	JSON	Alternative	The personalization design object belonging to this card.
personalization_design (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
personalization_design (anyOf 1) (anyOf 2)	Model	Alternative	Expand Create a personalization design — response body
personalization_design (anyOf 2)	null	Alternative
replaced_by	JSON	Optional
replaced_by (anyOf 1)	JSON	Alternative	The latest card that replaces this card, if any.
replaced_by (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
replaced_by (anyOf 1) (anyOf 2)	Model	Alternative	Expand Fail a testmode card — response body
replaced_by (anyOf 2)	null	Alternative
replacement_for	JSON	Optional
replacement_for (anyOf 1)	JSON	Alternative	The card this card replaces, if any.
replacement_for (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
replacement_for (anyOf 1) (anyOf 2)	Model	Alternative	Expand Fail a testmode card — response body
replacement_for (anyOf 2)	null	Alternative
replacement_reason	JSON	Optional
replacement_reason (anyOf 1)	string	Alternative	The reason why the previous card needed to be replaced. Known values: damaged, expired, fulfillment_error, lost, stolen
replacement_reason (anyOf 2)	null	Alternative
second_line	JSON	Optional
second_line (anyOf 1)	string	Alternative	Text separate from cardholder name, printed on the card. Maximum length: 5000
second_line (anyOf 2)	null	Alternative
shipping	JSON	Optional
shipping (anyOf 1)	JSON	Alternative	Where and how the card will be shipped.
shipping (anyOf 1) (anyOf 1)	Model	Alternative	Expand Fail a testmode card — response body — shipping / Where and how the card will be shipped / service: express, priority, standard, type: bulk, individual
shipping (anyOf 2)	null	Alternative
spending_controls	Model	Required within parent	Expand Fail a testmode card — response body — spending controls
status	string	Required within parent	Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`. Known values: active, canceled, inactive
type	string	Required within parent	The type of the card. Known values: physical, virtual
wallets	JSON	Optional
wallets (anyOf 1)	JSON	Alternative	Information relating to digital wallets (like Apple Pay and Google Pay).
wallets (anyOf 1) (anyOf 1)	Model	Alternative	Expand Fail a testmode card — response body — wallets value apple pay, google pay, primary account identifier
wallets (anyOf 2)	null	Alternative

Referenced models: Fail a testmode card — response body, Create a cardholder — response body, Create a personalization design — response body, Fail a testmode card — response body — spending controls, Fail a testmode card — response body — latest fraud warning value started at, type, Fail a testmode card — response body — lifecycle controls value cancel after, Fail a testmode card — response body — shipping / Where and how the card will be shipped / service: express, priority, standard, type: bulk, individual, Fail a testmode card — response body — wallets value apple pay, google pay, primary account identifier

Fail a testmode card — response body — latest fraud warning value started at, type

Field	Type	Presence	Description and constraints
$	object	Root
started_at	JSON	Optional
started_at (anyOf 1)	JSON	Alternative
started_at (anyOf 1) (anyOf 1)	integer	Alternative	Timestamp of the most recent fraud warning. Format: unix-time
started_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
started_at (anyOf 2)	null	Alternative
type	JSON	Optional
type (anyOf 1)	string	Alternative	The type of fraud warning that most recently took place on this card. This field updates with every new fraud warning, so the value changes over time. If populated, cancel and reissue the card. Known values: card_testing_exposure, fraud_dispute_filed, third_party_reported, user_indicated_fraud
type (anyOf 2)	null	Alternative

Fail a testmode card — response body — lifecycle controls value cancel after

Field	Type	Presence	Description and constraints
$	object	Root
cancel_after	Model	Required within parent	Expand Fail a testmode card — response body — lifecycle controls value cancel after cancel after

Referenced models: Fail a testmode card — response body — lifecycle controls value cancel after cancel after

Fail a testmode card — response body — lifecycle controls value cancel after cancel after

Field	Type	Presence	Description and constraints
$	object	Root
payment_count	JSON	Required within parent
payment_count (anyOf 1)	integer	Alternative	The card is automatically cancelled when it makes this number of non-zero payment authorizations and transactions. The count includes penny authorizations, but doesn't include non-payment actions, such as authorization advice.
payment_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Fail a testmode card — response body — shipping / Where and how the card will be shipped / service: express, priority, standard, type: bulk, individual

Field	Type	Presence	Description and constraints
$	object	Root
address	Model	Required within parent	Expand Create a Location — response body — address
address_validation	JSON	Optional
address_validation (anyOf 1)	JSON	Alternative	Address validation details for the shipment.
address_validation (anyOf 1) (anyOf 1)	Model	Alternative	Expand Fail a testmode card — response body — shipping / Where and how the card will be shipped / service: express, priority, standard, type: bulk, individual address validation Address validation details for the shipment mode: disabled, normalization only, validation and normalization
address_validation (anyOf 2)	null	Alternative
business_name	JSON	Optional
business_name (anyOf 1)	string	Alternative	The name of the business at the shipping address, used on the shipping label to ensure delivery when the card is shipped to a cardholder's workplace. Maximum length: 5000
business_name (anyOf 2)	null	Alternative
carrier	JSON	Optional
carrier (anyOf 1)	string	Alternative	The delivery company that shipped a card. Known values: correos, dhl, fedex, royal_mail, usps
carrier (anyOf 2)	null	Alternative
customs	JSON	Optional
customs (anyOf 1)	JSON	Alternative	Additional information that may be required for clearing customs.
customs (anyOf 1) (anyOf 1)	Model	Alternative	Expand Fail a testmode card — response body — shipping / Where and how the card will be shipped / service: express, priority, standard, type: bulk, individual customs value eori number
customs (anyOf 2)	null	Alternative
eta	JSON	Optional
eta (anyOf 1)	JSON	Alternative
eta (anyOf 1) (anyOf 1)	integer	Alternative	A unix timestamp representing a best estimate of when the card will be delivered. Format: unix-time
eta (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
eta (anyOf 2)	null	Alternative
name	string	Required within parent	Recipient name. Maximum length: 5000
phone_number	JSON	Optional
phone_number (anyOf 1)	string	Alternative	The phone number of the receiver of the shipment. Our courier partners will use this number to contact you in the event of card delivery issues. For individual shipments to the EU/UK, if this field is empty, we will provide them with the phone number provided when the cardholder was initially created. Maximum length: 5000
phone_number (anyOf 2)	null	Alternative
require_signature	JSON	Optional
require_signature (anyOf 1)	boolean	Alternative	Whether a signature is required for card delivery. This feature is only supported for US users. Standard shipping service does not support signature on delivery. The default value for standard shipping service is false and for express and priority services is true.
require_signature (anyOf 2)	null	Alternative
service	string	Required within parent	Shipment service, such as `standard` or `express`. Known values: express, priority, standard
status	JSON	Optional
status (anyOf 1)	string	Alternative	The delivery status of the card. Known values: canceled, delivered, failure, pending, returned, shipped, submitted
status (anyOf 2)	null	Alternative
tracking_number	JSON	Optional
tracking_number (anyOf 1)	string	Alternative	A tracking number for a card shipment. Maximum length: 5000
tracking_number (anyOf 2)	null	Alternative
tracking_url	JSON	Optional
tracking_url (anyOf 1)	string	Alternative	A link to the shipping carrier's site where you can view detailed information about a card shipment. Maximum length: 5000
tracking_url (anyOf 2)	null	Alternative
type	string	Required within parent	Packaging options. Known values: bulk, individual

Referenced models: Create a Location — response body — address, Fail a testmode card — response body — shipping / Where and how the card will be shipped / service: express, priority, standard, type: bulk, individual address validation Address validation details for the shipment mode: disabled, normalization only, validation and normalization, Fail a testmode card — response body — shipping / Where and how the card will be shipped / service: express, priority, standard, type: bulk, individual customs value eori number

Fail a testmode card — response body — shipping / Where and how the card will be shipped / service: express, priority, standard, type: bulk, individual address validation Address validation details for the shipment mode: disabled, normalization only, validation and normalization

Field	Type	Presence	Description and constraints
$	object	Root
mode	string	Required within parent	The address validation capabilities to use. Known values: disabled, normalization_only, validation_and_normalization
normalized_address	JSON	Optional
normalized_address (anyOf 1)	JSON	Alternative	The normalized shipping address.
normalized_address (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a Location — response body — address
normalized_address (anyOf 2)	null	Alternative
result	JSON	Optional
result (anyOf 1)	string	Alternative	The validation result for the shipping address. Known values: indeterminate, likely_deliverable, likely_undeliverable
result (anyOf 2)	null	Alternative

Referenced models: Create a Location — response body — address

Fail a testmode card — response body — shipping / Where and how the card will be shipped / service: express, priority, standard, type: bulk, individual customs value eori number

Field	Type	Presence	Description and constraints
$	object	Root
eori_number	JSON	Optional
eori_number (anyOf 1)	string	Alternative	A registration number used for customs in Europe. See [https://www.gov.uk/eori](https://www.gov.uk/eori) for the UK and [https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en](https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en) for the EU. Maximum length: 5000
eori_number (anyOf 2)	null	Alternative

Fail a testmode card — response body — spending controls

Field	Type	Presence	Description and constraints
$	object	Root
allowed_card_presences	JSON	Optional
allowed_card_presences (anyOf 1)	array	Alternative	Array of card presence statuses from which authorizations will be allowed. Possible options are `present`, `not_present`. All other statuses will be blocked. Cannot be set with `blocked_card_presences`. Provide an empty value to unset this control.
allowed_card_presences (anyOf 1)[]	string	Each item	Known values: not_present, present
allowed_card_presences (anyOf 2)	null	Alternative
allowed_categories	JSON	Optional
allowed_categories (anyOf 1)	array	Alternative	Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.
allowed_categories (anyOf 1)[]	string	Each item	Known values: ac_refrigeration_repair, accounting_bookkeeping_services, advertising_services, agricultural_cooperative, airlines_air_carriers, airports_flying_fields, ambulance_services, amusement_parks_carnivals, antique_reproductions, antique_shops, aquariums, architectural_surveying_services, art_dealers_and_galleries, artists_supply_and_craft_shops, auto_and_home_supply_stores, auto_body_repair_shops, auto_paint_shops, auto_service_shops, automated_cash_disburse, automated_fuel_dispensers, automobile_associations, automotive_parts_and_accessories_stores, automotive_tire_stores, bail_and_bond_payments, bakeries, bands_orchestras, barber_and_beauty_shops, betting_casino_gambling, bicycle_shops, billiard_pool_establishments, boat_dealers, boat_rentals_and_leases, book_stores, books_periodicals_and_newspapers, bowling_alleys, bus_lines, business_secretarial_schools, buying_shopping_services, cable_satellite_and_other_pay_television_and_radio, camera_and_photographic_supply_stores, candy_nut_and_confectionery_stores, car_and_truck_dealers_new_used, car_and_truck_dealers_used_only, car_rental_agencies, car_washes, carpentry_services, carpet_upholstery_cleaning, caterers, charitable_and_social_service_organizations_fundraising, chemicals_and_allied_products, child_care_services, childrens_and_infants_wear_stores, chiropodists_podiatrists, chiropractors, cigar_stores_and_stands, civic_social_fraternal_associations, cleaning_and_maintenance, clothing_rental, colleges_universities, commercial_equipment, commercial_footwear, commercial_photography_art_and_graphics, commuter_transport_and_ferries, computer_network_services, computer_programming, computer_repair, computer_software_stores, computers_peripherals_and_software, concrete_work_services, construction_materials, consulting_public_relations, correspondence_schools, cosmetic_stores, counseling_services, country_clubs, courier_services, court_costs, credit_reporting_agencies, cruise_lines, dairy_products_stores, dance_hall_studios_schools, dating_escort_services, dentists_orthodontists, department_stores, detective_agencies, digital_goods_applications, digital_goods_games, digital_goods_large_volume, digital_goods_media, direct_marketing_catalog_merchant, direct_marketing_combination_catalog_and_retail_merchant, direct_marketing_inbound_telemarketing, direct_marketing_insurance_services, direct_marketing_other, direct_marketing_outbound_telemarketing, direct_marketing_subscription, direct_marketing_travel, discount_stores, doctors, door_to_door_sales, drapery_window_covering_and_upholstery_stores, drinking_places, drug_stores_and_pharmacies, drugs_drug_proprietaries_and_druggist_sundries, dry_cleaners, durable_goods, duty_free_stores, eating_places_restaurants, educational_services, electric_razor_stores, electric_vehicle_charging, electrical_parts_and_equipment, electrical_services, electronics_repair_shops, electronics_stores, elementary_secondary_schools, emergency_services_gcas_visa_use_only, employment_temp_agencies, equipment_rental, exterminating_services, family_clothing_stores, fast_food_restaurants, financial_institutions, fines_government_administrative_entities, fireplace_fireplace_screens_and_accessories_stores, floor_covering_stores, florists, florists_supplies_nursery_stock_and_flowers, freezer_and_locker_meat_provisioners, fuel_dealers_non_automotive, funeral_services_crematories, furniture_home_furnishings_and_equipment_stores_except_appliances, furniture_repair_refinishing, furriers_and_fur_shops, general_services, gift_card_novelty_and_souvenir_shops, glass_paint_and_wallpaper_stores, glassware_crystal_stores, golf_courses_public, government_licensed_horse_dog_racing_us_region_only, government_licensed_online_casions_online_gambling_us_region_only, government_owned_lotteries_non_us_region, government_owned_lotteries_us_region_only, government_services, grocery_stores_supermarkets, hardware_equipment_and_supplies, hardware_stores, health_and_beauty_spas, hearing_aids_sales_and_supplies, heating_plumbing_a_c, hobby_toy_and_game_shops, home_supply_warehouse_stores, hospitals, hotels_motels_and_resorts, household_appliance_stores, industrial_supplies, information_retrieval_services, insurance_default, insurance_underwriting_premiums, intra_company_purchases, jewelry_stores_watches_clocks_and_silverware_stores, landscaping_services, laundries, laundry_cleaning_services, legal_services_attorneys, luggage_and_leather_goods_stores, lumber_building_materials_stores, manual_cash_disburse, marinas_service_and_supplies, marketplaces, masonry_stonework_and_plaster, massage_parlors, medical_and_dental_labs, medical_dental_ophthalmic_and_hospital_equipment_and_supplies, medical_services, membership_organizations, mens_and_boys_clothing_and_accessories_stores, mens_womens_clothing_stores, metal_service_centers, miscellaneous, miscellaneous_apparel_and_accessory_shops, miscellaneous_auto_dealers, miscellaneous_business_services, miscellaneous_food_stores, miscellaneous_general_merchandise, miscellaneous_general_services, miscellaneous_home_furnishing_specialty_stores, miscellaneous_publishing_and_printing, miscellaneous_recreation_services, miscellaneous_repair_shops, miscellaneous_specialty_retail, mobile_home_dealers, motion_picture_theaters, motor_freight_carriers_and_trucking, motor_homes_dealers, motor_vehicle_supplies_and_new_parts, motorcycle_shops_and_dealers, motorcycle_shops_dealers, music_stores_musical_instruments_pianos_and_sheet_music, news_dealers_and_newsstands, non_fi_money_orders, non_fi_stored_value_card_purchase_load, nondurable_goods, nurseries_lawn_and_garden_supply_stores, nursing_personal_care, office_and_commercial_furniture, opticians_eyeglasses, optometrists_ophthalmologist, orthopedic_goods_prosthetic_devices, osteopaths, package_stores_beer_wine_and_liquor, paints_varnishes_and_supplies, parking_lots_garages, passenger_railways, pawn_shops, pet_shops_pet_food_and_supplies, petroleum_and_petroleum_products, photo_developing, photographic_photocopy_microfilm_equipment_and_supplies, photographic_studios, picture_video_production, piece_goods_notions_and_other_dry_goods, plumbing_heating_equipment_and_supplies, political_organizations, postal_services_government_only, precious_stones_and_metals_watches_and_jewelry, professional_services, public_warehousing_and_storage, quick_copy_repro_and_blueprint, railroads, real_estate_agents_and_managers_rentals, record_stores, recreational_vehicle_rentals, religious_goods_stores, religious_organizations, roofing_siding_sheet_metal, secretarial_support_services, security_brokers_dealers, service_stations, sewing_needlework_fabric_and_piece_goods_stores, shoe_repair_hat_cleaning, shoe_stores, small_appliance_repair, snowmobile_dealers, special_trade_services, specialty_cleaning, sporting_goods_stores, sporting_recreation_camps, sports_and_riding_apparel_stores, sports_clubs_fields, stamp_and_coin_stores, stationary_office_supplies_printing_and_writing_paper, stationery_stores_office_and_school_supply_stores, swimming_pools_sales, t_ui_travel_germany, tailors_alterations, tax_payments_government_agencies, tax_preparation_services, taxicabs_limousines, telecommunication_equipment_and_telephone_sales, telecommunication_services, telegraph_services, tent_and_awning_shops, testing_laboratories, theatrical_ticket_agencies, timeshares, tire_retreading_and_repair, tolls_bridge_fees, tourist_attractions_and_exhibits, towing_services, trailer_parks_campgrounds, transportation_services, travel_agencies_tour_operators, truck_stop_iteration, truck_utility_trailer_rentals, typesetting_plate_making_and_related_services, typewriter_stores, u_s_federal_government_agencies_or_departments, uniforms_commercial_clothing, used_merchandise_and_secondhand_stores, utilities, variety_stores, veterinary_services, video_amusement_game_supplies, video_game_arcades, video_tape_rental_stores, vocational_trade_schools, watch_jewelry_repair, welding_repair, wholesale_clubs, wig_and_toupee_stores, wires_money_orders, womens_accessory_and_specialty_shops, womens_ready_to_wear_stores, wrecking_and_salvage_yards
allowed_categories (anyOf 2)	null	Alternative
allowed_merchant_countries	JSON	Optional
allowed_merchant_countries (anyOf 1)	array	Alternative	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 with `blocked_merchant_countries`. Provide an empty value to unset this control.
allowed_merchant_countries (anyOf 1)[]	string	Each item	Maximum length: 5000
allowed_merchant_countries (anyOf 2)	null	Alternative
blocked_card_presences	JSON	Optional
blocked_card_presences (anyOf 1)	array	Alternative	Array of card presence statuses from which authorizations will be declined. Possible options are `present`, `not_present`. Cannot be set with `allowed_card_presences`. Provide an empty value to unset this control.
blocked_card_presences (anyOf 1)[]	string	Each item	Known values: not_present, present
blocked_card_presences (anyOf 2)	null	Alternative
blocked_categories	JSON	Optional
blocked_categories (anyOf 1)	array	Alternative	Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.
blocked_categories (anyOf 1)[]	string	Each item	Known values: ac_refrigeration_repair, accounting_bookkeeping_services, advertising_services, agricultural_cooperative, airlines_air_carriers, airports_flying_fields, ambulance_services, amusement_parks_carnivals, antique_reproductions, antique_shops, aquariums, architectural_surveying_services, art_dealers_and_galleries, artists_supply_and_craft_shops, auto_and_home_supply_stores, auto_body_repair_shops, auto_paint_shops, auto_service_shops, automated_cash_disburse, automated_fuel_dispensers, automobile_associations, automotive_parts_and_accessories_stores, automotive_tire_stores, bail_and_bond_payments, bakeries, bands_orchestras, barber_and_beauty_shops, betting_casino_gambling, bicycle_shops, billiard_pool_establishments, boat_dealers, boat_rentals_and_leases, book_stores, books_periodicals_and_newspapers, bowling_alleys, bus_lines, business_secretarial_schools, buying_shopping_services, cable_satellite_and_other_pay_television_and_radio, camera_and_photographic_supply_stores, candy_nut_and_confectionery_stores, car_and_truck_dealers_new_used, car_and_truck_dealers_used_only, car_rental_agencies, car_washes, carpentry_services, carpet_upholstery_cleaning, caterers, charitable_and_social_service_organizations_fundraising, chemicals_and_allied_products, child_care_services, childrens_and_infants_wear_stores, chiropodists_podiatrists, chiropractors, cigar_stores_and_stands, civic_social_fraternal_associations, cleaning_and_maintenance, clothing_rental, colleges_universities, commercial_equipment, commercial_footwear, commercial_photography_art_and_graphics, commuter_transport_and_ferries, computer_network_services, computer_programming, computer_repair, computer_software_stores, computers_peripherals_and_software, concrete_work_services, construction_materials, consulting_public_relations, correspondence_schools, cosmetic_stores, counseling_services, country_clubs, courier_services, court_costs, credit_reporting_agencies, cruise_lines, dairy_products_stores, dance_hall_studios_schools, dating_escort_services, dentists_orthodontists, department_stores, detective_agencies, digital_goods_applications, digital_goods_games, digital_goods_large_volume, digital_goods_media, direct_marketing_catalog_merchant, direct_marketing_combination_catalog_and_retail_merchant, direct_marketing_inbound_telemarketing, direct_marketing_insurance_services, direct_marketing_other, direct_marketing_outbound_telemarketing, direct_marketing_subscription, direct_marketing_travel, discount_stores, doctors, door_to_door_sales, drapery_window_covering_and_upholstery_stores, drinking_places, drug_stores_and_pharmacies, drugs_drug_proprietaries_and_druggist_sundries, dry_cleaners, durable_goods, duty_free_stores, eating_places_restaurants, educational_services, electric_razor_stores, electric_vehicle_charging, electrical_parts_and_equipment, electrical_services, electronics_repair_shops, electronics_stores, elementary_secondary_schools, emergency_services_gcas_visa_use_only, employment_temp_agencies, equipment_rental, exterminating_services, family_clothing_stores, fast_food_restaurants, financial_institutions, fines_government_administrative_entities, fireplace_fireplace_screens_and_accessories_stores, floor_covering_stores, florists, florists_supplies_nursery_stock_and_flowers, freezer_and_locker_meat_provisioners, fuel_dealers_non_automotive, funeral_services_crematories, furniture_home_furnishings_and_equipment_stores_except_appliances, furniture_repair_refinishing, furriers_and_fur_shops, general_services, gift_card_novelty_and_souvenir_shops, glass_paint_and_wallpaper_stores, glassware_crystal_stores, golf_courses_public, government_licensed_horse_dog_racing_us_region_only, government_licensed_online_casions_online_gambling_us_region_only, government_owned_lotteries_non_us_region, government_owned_lotteries_us_region_only, government_services, grocery_stores_supermarkets, hardware_equipment_and_supplies, hardware_stores, health_and_beauty_spas, hearing_aids_sales_and_supplies, heating_plumbing_a_c, hobby_toy_and_game_shops, home_supply_warehouse_stores, hospitals, hotels_motels_and_resorts, household_appliance_stores, industrial_supplies, information_retrieval_services, insurance_default, insurance_underwriting_premiums, intra_company_purchases, jewelry_stores_watches_clocks_and_silverware_stores, landscaping_services, laundries, laundry_cleaning_services, legal_services_attorneys, luggage_and_leather_goods_stores, lumber_building_materials_stores, manual_cash_disburse, marinas_service_and_supplies, marketplaces, masonry_stonework_and_plaster, massage_parlors, medical_and_dental_labs, medical_dental_ophthalmic_and_hospital_equipment_and_supplies, medical_services, membership_organizations, mens_and_boys_clothing_and_accessories_stores, mens_womens_clothing_stores, metal_service_centers, miscellaneous, miscellaneous_apparel_and_accessory_shops, miscellaneous_auto_dealers, miscellaneous_business_services, miscellaneous_food_stores, miscellaneous_general_merchandise, miscellaneous_general_services, miscellaneous_home_furnishing_specialty_stores, miscellaneous_publishing_and_printing, miscellaneous_recreation_services, miscellaneous_repair_shops, miscellaneous_specialty_retail, mobile_home_dealers, motion_picture_theaters, motor_freight_carriers_and_trucking, motor_homes_dealers, motor_vehicle_supplies_and_new_parts, motorcycle_shops_and_dealers, motorcycle_shops_dealers, music_stores_musical_instruments_pianos_and_sheet_music, news_dealers_and_newsstands, non_fi_money_orders, non_fi_stored_value_card_purchase_load, nondurable_goods, nurseries_lawn_and_garden_supply_stores, nursing_personal_care, office_and_commercial_furniture, opticians_eyeglasses, optometrists_ophthalmologist, orthopedic_goods_prosthetic_devices, osteopaths, package_stores_beer_wine_and_liquor, paints_varnishes_and_supplies, parking_lots_garages, passenger_railways, pawn_shops, pet_shops_pet_food_and_supplies, petroleum_and_petroleum_products, photo_developing, photographic_photocopy_microfilm_equipment_and_supplies, photographic_studios, picture_video_production, piece_goods_notions_and_other_dry_goods, plumbing_heating_equipment_and_supplies, political_organizations, postal_services_government_only, precious_stones_and_metals_watches_and_jewelry, professional_services, public_warehousing_and_storage, quick_copy_repro_and_blueprint, railroads, real_estate_agents_and_managers_rentals, record_stores, recreational_vehicle_rentals, religious_goods_stores, religious_organizations, roofing_siding_sheet_metal, secretarial_support_services, security_brokers_dealers, service_stations, sewing_needlework_fabric_and_piece_goods_stores, shoe_repair_hat_cleaning, shoe_stores, small_appliance_repair, snowmobile_dealers, special_trade_services, specialty_cleaning, sporting_goods_stores, sporting_recreation_camps, sports_and_riding_apparel_stores, sports_clubs_fields, stamp_and_coin_stores, stationary_office_supplies_printing_and_writing_paper, stationery_stores_office_and_school_supply_stores, swimming_pools_sales, t_ui_travel_germany, tailors_alterations, tax_payments_government_agencies, tax_preparation_services, taxicabs_limousines, telecommunication_equipment_and_telephone_sales, telecommunication_services, telegraph_services, tent_and_awning_shops, testing_laboratories, theatrical_ticket_agencies, timeshares, tire_retreading_and_repair, tolls_bridge_fees, tourist_attractions_and_exhibits, towing_services, trailer_parks_campgrounds, transportation_services, travel_agencies_tour_operators, truck_stop_iteration, truck_utility_trailer_rentals, typesetting_plate_making_and_related_services, typewriter_stores, u_s_federal_government_agencies_or_departments, uniforms_commercial_clothing, used_merchandise_and_secondhand_stores, utilities, variety_stores, veterinary_services, video_amusement_game_supplies, video_game_arcades, video_tape_rental_stores, vocational_trade_schools, watch_jewelry_repair, welding_repair, wholesale_clubs, wig_and_toupee_stores, wires_money_orders, womens_accessory_and_specialty_shops, womens_ready_to_wear_stores, wrecking_and_salvage_yards
blocked_categories (anyOf 2)	null	Alternative
blocked_merchant_countries	JSON	Optional
blocked_merchant_countries (anyOf 1)	array	Alternative	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 with `allowed_merchant_countries`. Provide an empty value to unset this control.
blocked_merchant_countries (anyOf 1)[]	string	Each item	Maximum length: 5000
blocked_merchant_countries (anyOf 2)	null	Alternative
spending_limits	JSON	Optional
spending_limits (anyOf 1)	array	Alternative	Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain).
spending_limits (anyOf 1)[]	Model	Each item	Expand Fail a testmode card — response body — spending controls spending limits array item
spending_limits (anyOf 2)	null	Alternative
spending_limits_currency	JSON	Optional
spending_limits_currency (anyOf 1)	string	Alternative	Currency of the amounts within `spending_limits`. Always the same as the currency of the card. Format: currency
spending_limits_currency (anyOf 2)	null	Alternative

Referenced models: Fail a testmode card — response body — spending controls spending limits array item

Fail a testmode card — response body — spending controls spending limits array item

Field	Type	Presence	Description and constraints
$	object	Root
amount	JSON	Required within parent
amount (anyOf 1)	integer	Alternative	Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
categories	JSON	Optional
categories (anyOf 1)	array	Alternative	Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.
categories (anyOf 1)[]	string	Each item	Known values: ac_refrigeration_repair, accounting_bookkeeping_services, advertising_services, agricultural_cooperative, airlines_air_carriers, airports_flying_fields, ambulance_services, amusement_parks_carnivals, antique_reproductions, antique_shops, aquariums, architectural_surveying_services, art_dealers_and_galleries, artists_supply_and_craft_shops, auto_and_home_supply_stores, auto_body_repair_shops, auto_paint_shops, auto_service_shops, automated_cash_disburse, automated_fuel_dispensers, automobile_associations, automotive_parts_and_accessories_stores, automotive_tire_stores, bail_and_bond_payments, bakeries, bands_orchestras, barber_and_beauty_shops, betting_casino_gambling, bicycle_shops, billiard_pool_establishments, boat_dealers, boat_rentals_and_leases, book_stores, books_periodicals_and_newspapers, bowling_alleys, bus_lines, business_secretarial_schools, buying_shopping_services, cable_satellite_and_other_pay_television_and_radio, camera_and_photographic_supply_stores, candy_nut_and_confectionery_stores, car_and_truck_dealers_new_used, car_and_truck_dealers_used_only, car_rental_agencies, car_washes, carpentry_services, carpet_upholstery_cleaning, caterers, charitable_and_social_service_organizations_fundraising, chemicals_and_allied_products, child_care_services, childrens_and_infants_wear_stores, chiropodists_podiatrists, chiropractors, cigar_stores_and_stands, civic_social_fraternal_associations, cleaning_and_maintenance, clothing_rental, colleges_universities, commercial_equipment, commercial_footwear, commercial_photography_art_and_graphics, commuter_transport_and_ferries, computer_network_services, computer_programming, computer_repair, computer_software_stores, computers_peripherals_and_software, concrete_work_services, construction_materials, consulting_public_relations, correspondence_schools, cosmetic_stores, counseling_services, country_clubs, courier_services, court_costs, credit_reporting_agencies, cruise_lines, dairy_products_stores, dance_hall_studios_schools, dating_escort_services, dentists_orthodontists, department_stores, detective_agencies, digital_goods_applications, digital_goods_games, digital_goods_large_volume, digital_goods_media, direct_marketing_catalog_merchant, direct_marketing_combination_catalog_and_retail_merchant, direct_marketing_inbound_telemarketing, direct_marketing_insurance_services, direct_marketing_other, direct_marketing_outbound_telemarketing, direct_marketing_subscription, direct_marketing_travel, discount_stores, doctors, door_to_door_sales, drapery_window_covering_and_upholstery_stores, drinking_places, drug_stores_and_pharmacies, drugs_drug_proprietaries_and_druggist_sundries, dry_cleaners, durable_goods, duty_free_stores, eating_places_restaurants, educational_services, electric_razor_stores, electric_vehicle_charging, electrical_parts_and_equipment, electrical_services, electronics_repair_shops, electronics_stores, elementary_secondary_schools, emergency_services_gcas_visa_use_only, employment_temp_agencies, equipment_rental, exterminating_services, family_clothing_stores, fast_food_restaurants, financial_institutions, fines_government_administrative_entities, fireplace_fireplace_screens_and_accessories_stores, floor_covering_stores, florists, florists_supplies_nursery_stock_and_flowers, freezer_and_locker_meat_provisioners, fuel_dealers_non_automotive, funeral_services_crematories, furniture_home_furnishings_and_equipment_stores_except_appliances, furniture_repair_refinishing, furriers_and_fur_shops, general_services, gift_card_novelty_and_souvenir_shops, glass_paint_and_wallpaper_stores, glassware_crystal_stores, golf_courses_public, government_licensed_horse_dog_racing_us_region_only, government_licensed_online_casions_online_gambling_us_region_only, government_owned_lotteries_non_us_region, government_owned_lotteries_us_region_only, government_services, grocery_stores_supermarkets, hardware_equipment_and_supplies, hardware_stores, health_and_beauty_spas, hearing_aids_sales_and_supplies, heating_plumbing_a_c, hobby_toy_and_game_shops, home_supply_warehouse_stores, hospitals, hotels_motels_and_resorts, household_appliance_stores, industrial_supplies, information_retrieval_services, insurance_default, insurance_underwriting_premiums, intra_company_purchases, jewelry_stores_watches_clocks_and_silverware_stores, landscaping_services, laundries, laundry_cleaning_services, legal_services_attorneys, luggage_and_leather_goods_stores, lumber_building_materials_stores, manual_cash_disburse, marinas_service_and_supplies, marketplaces, masonry_stonework_and_plaster, massage_parlors, medical_and_dental_labs, medical_dental_ophthalmic_and_hospital_equipment_and_supplies, medical_services, membership_organizations, mens_and_boys_clothing_and_accessories_stores, mens_womens_clothing_stores, metal_service_centers, miscellaneous, miscellaneous_apparel_and_accessory_shops, miscellaneous_auto_dealers, miscellaneous_business_services, miscellaneous_food_stores, miscellaneous_general_merchandise, miscellaneous_general_services, miscellaneous_home_furnishing_specialty_stores, miscellaneous_publishing_and_printing, miscellaneous_recreation_services, miscellaneous_repair_shops, miscellaneous_specialty_retail, mobile_home_dealers, motion_picture_theaters, motor_freight_carriers_and_trucking, motor_homes_dealers, motor_vehicle_supplies_and_new_parts, motorcycle_shops_and_dealers, motorcycle_shops_dealers, music_stores_musical_instruments_pianos_and_sheet_music, news_dealers_and_newsstands, non_fi_money_orders, non_fi_stored_value_card_purchase_load, nondurable_goods, nurseries_lawn_and_garden_supply_stores, nursing_personal_care, office_and_commercial_furniture, opticians_eyeglasses, optometrists_ophthalmologist, orthopedic_goods_prosthetic_devices, osteopaths, package_stores_beer_wine_and_liquor, paints_varnishes_and_supplies, parking_lots_garages, passenger_railways, pawn_shops, pet_shops_pet_food_and_supplies, petroleum_and_petroleum_products, photo_developing, photographic_photocopy_microfilm_equipment_and_supplies, photographic_studios, picture_video_production, piece_goods_notions_and_other_dry_goods, plumbing_heating_equipment_and_supplies, political_organizations, postal_services_government_only, precious_stones_and_metals_watches_and_jewelry, professional_services, public_warehousing_and_storage, quick_copy_repro_and_blueprint, railroads, real_estate_agents_and_managers_rentals, record_stores, recreational_vehicle_rentals, religious_goods_stores, religious_organizations, roofing_siding_sheet_metal, secretarial_support_services, security_brokers_dealers, service_stations, sewing_needlework_fabric_and_piece_goods_stores, shoe_repair_hat_cleaning, shoe_stores, small_appliance_repair, snowmobile_dealers, special_trade_services, specialty_cleaning, sporting_goods_stores, sporting_recreation_camps, sports_and_riding_apparel_stores, sports_clubs_fields, stamp_and_coin_stores, stationary_office_supplies_printing_and_writing_paper, stationery_stores_office_and_school_supply_stores, swimming_pools_sales, t_ui_travel_germany, tailors_alterations, tax_payments_government_agencies, tax_preparation_services, taxicabs_limousines, telecommunication_equipment_and_telephone_sales, telecommunication_services, telegraph_services, tent_and_awning_shops, testing_laboratories, theatrical_ticket_agencies, timeshares, tire_retreading_and_repair, tolls_bridge_fees, tourist_attractions_and_exhibits, towing_services, trailer_parks_campgrounds, transportation_services, travel_agencies_tour_operators, truck_stop_iteration, truck_utility_trailer_rentals, typesetting_plate_making_and_related_services, typewriter_stores, u_s_federal_government_agencies_or_departments, uniforms_commercial_clothing, used_merchandise_and_secondhand_stores, utilities, variety_stores, veterinary_services, video_amusement_game_supplies, video_game_arcades, video_tape_rental_stores, vocational_trade_schools, watch_jewelry_repair, welding_repair, wholesale_clubs, wig_and_toupee_stores, wires_money_orders, womens_accessory_and_specialty_shops, womens_ready_to_wear_stores, wrecking_and_salvage_yards
categories (anyOf 2)	null	Alternative
interval	string	Required within parent	Interval (or event) to which the amount applies. Known values: all_time, daily, monthly, per_authorization, weekly, yearly

Fail a testmode card — response body — wallets value apple pay, google pay, primary account identifier

Field	Type	Presence	Description and constraints
$	object	Root
apple_pay	Model	Required within parent	Expand Fail a testmode card — response body — wallets value apple pay, google pay, primary account identifier apple pay
google_pay	Model	Required within parent	Expand Fail a testmode card — response body — wallets value apple pay, google pay, primary account identifier google pay
primary_account_identifier	JSON	Optional
primary_account_identifier (anyOf 1)	string	Alternative	Unique identifier for a card used with digital wallets Maximum length: 5000
primary_account_identifier (anyOf 2)	null	Alternative

Referenced models: Fail a testmode card — response body — wallets value apple pay, google pay, primary account identifier apple pay, Fail a testmode card — response body — wallets value apple pay, google pay, primary account identifier google pay

Fail a testmode card — response body — wallets value apple pay, google pay, primary account identifier apple pay

Field	Type	Presence	Description and constraints
$	object	Root
eligible	boolean	Required within parent	Apple Pay Eligibility
ineligible_reason	JSON	Optional
ineligible_reason (anyOf 1)	string	Alternative	Reason the card is ineligible for Apple Pay Known values: missing_agreement, missing_cardholder_contact, unsupported_region
ineligible_reason (anyOf 2)	null	Alternative

Fail a testmode card — response body — wallets value apple pay, google pay, primary account identifier google pay

Field	Type	Presence	Description and constraints
$	object	Root
eligible	boolean	Required within parent	Google Pay Eligibility
ineligible_reason	JSON	Optional
ineligible_reason (anyOf 1)	string	Alternative	Reason the card is ineligible for Google Pay Known values: missing_agreement, missing_cardholder_contact, unsupported_region
ineligible_reason (anyOf 2)	null	Alternative

Fund a test mode cash balance — response body

Field	Type	Presence	Description and constraints
$	object	Root	Customers with certain payments enabled have a cash balance, representing funds that were paid by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions represent when funds are moved into or out of this balance. This includes funding by the customer, allocation to payments, and refunds to the customer.
adjusted_for_overdraft	Model	Optional	Expand Fund a test mode cash balance — response body — adjusted for overdraft
applied_to_payment	Model	Optional	Expand Fund a test mode cash balance — response body — applied to payment
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency	string	Required within parent	Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Maximum length: 5000
customer	JSON	Required within parent	The customer whose available cash balance changed as a result of this transaction.
customer (anyOf 1)	string	Alternative	Maximum length: 5000
customer (anyOf 2)	Model	Alternative	Expand Create a customer — response body
customer_account	JSON	Optional
customer_account (anyOf 1)	string	Alternative	The ID of an Account representing a customer whose available cash balance changed as a result of this transaction. Maximum length: 5000
customer_account (anyOf 2)	null	Alternative
ending_balance	JSON	Required within parent
ending_balance (anyOf 1)	integer	Alternative	The total available cash balance for the specified currency after this transaction was applied. Represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
ending_balance (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
funded	Model	Optional	Expand Fund a test mode cash balance — response body — funded
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
net_amount	JSON	Required within parent
net_amount (anyOf 1)	integer	Alternative	The amount by which the cash balance changed, represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance.
net_amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: customer_cash_balance_transaction
refunded_from_payment	Model	Optional	Expand Fund a test mode cash balance — response body — refunded from payment
transferred_to_balance	Model	Optional	Expand Fund a test mode cash balance — response body — transferred to balance
type	string	Required within parent	The type of the cash balance transaction. New types may be added in future. See [Customer Balance](https://docs.stripe.com/payments/customer-balance#types) to learn more about these types. Known values: adjusted_for_overdraft, applied_to_payment, funded, funding_reversed, refunded_from_payment, return_canceled, return_initiated, transferred_to_balance, unapplied_from_payment
unapplied_from_payment	Model	Optional	Expand Fund a test mode cash balance — response body — unapplied from payment

Referenced models: Create a customer — response body, Fund a test mode cash balance — response body — adjusted for overdraft, Fund a test mode cash balance — response body — applied to payment, Fund a test mode cash balance — response body — funded, Fund a test mode cash balance — response body — refunded from payment, Fund a test mode cash balance — response body — transferred to balance, Fund a test mode cash balance — response body — unapplied from payment

Fund a test mode cash balance — response body — adjusted for overdraft

Field	Type	Presence	Description and constraints
$	object	Root
balance_transaction	JSON	Required within parent	The [Balance Transaction](https://docs.stripe.com/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance.
balance_transaction (anyOf 1)	string	Alternative	Maximum length: 5000
balance_transaction (anyOf 2)	Model	Alternative	Expand Retrieve a balance transaction — balance get Balance History Id — response body
linked_transaction	JSON	Required within parent	The [Cash Balance Transaction](https://docs.stripe.com/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds.
linked_transaction (anyOf 1)	string	Alternative	Maximum length: 5000
linked_transaction (anyOf 2)	Model	Alternative	Expand Fund a test mode cash balance — response body

Referenced models: Retrieve a balance transaction — balance get Balance History Id — response body, Fund a test mode cash balance — response body

Fund a test mode cash balance — response body — applied to payment

Field	Type	Presence	Description and constraints
$	object	Root
payment_intent	JSON	Required within parent	The [Payment Intent](https://docs.stripe.com/api/payment_intents/object) that funds were applied to.
payment_intent (anyOf 1)	string	Alternative	Maximum length: 5000
payment_intent (anyOf 2)	Model	Alternative	Expand Cancel a Payment Intent — response body

Referenced models: Cancel a Payment Intent — response body

Fund a test mode cash balance — response body — funded

Field	Type	Presence	Description and constraints
$	object	Root
bank_transfer	Model	Required within parent	Expand Fund a test mode cash balance — response body — funded bank transfer

Referenced models: Fund a test mode cash balance — response body — funded bank transfer

Fund a test mode cash balance — response body — funded bank transfer

Field	Type	Presence	Description and constraints
$	object	Root
eu_bank_transfer	Model	Optional	Expand Fund a test mode cash balance — response body — funded bank transfer eu bank transfer
gb_bank_transfer	Model	Optional	Expand Fund a test mode cash balance — response body — funded bank transfer gb bank transfer
jp_bank_transfer	Model	Optional	Expand Fund a test mode cash balance — response body — funded bank transfer jp bank transfer
reference	JSON	Optional
reference (anyOf 1)	string	Alternative	The user-supplied reference field on the bank transfer. Maximum length: 5000
reference (anyOf 2)	null	Alternative
type	string	Required within parent	The funding method type used to fund the customer balance. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. Known values: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, us_bank_transfer
us_bank_transfer	Model	Optional	Expand Fund a test mode cash balance — response body — funded bank transfer us bank transfer

Referenced models: Fund a test mode cash balance — response body — funded bank transfer eu bank transfer, Fund a test mode cash balance — response body — funded bank transfer gb bank transfer, Fund a test mode cash balance — response body — funded bank transfer jp bank transfer, Fund a test mode cash balance — response body — funded bank transfer us bank transfer

Fund a test mode cash balance — response body — funded bank transfer eu bank transfer

Field	Type	Presence	Description and constraints
$	object	Root
bic	JSON	Optional
bic (anyOf 1)	string	Alternative	The BIC of the bank of the sender of the funding. Maximum length: 5000
bic (anyOf 2)	null	Alternative
iban_last4	JSON	Optional
iban_last4 (anyOf 1)	string	Alternative	The last 4 digits of the IBAN of the sender of the funding. Maximum length: 5000
iban_last4 (anyOf 2)	null	Alternative
sender_name	JSON	Optional
sender_name (anyOf 1)	string	Alternative	The full name of the sender, as supplied by the sending bank. Maximum length: 5000
sender_name (anyOf 2)	null	Alternative

Fund a test mode cash balance — response body — funded bank transfer gb bank transfer

Field	Type	Presence	Description and constraints
$	object	Root
account_number_last4	JSON	Optional
account_number_last4 (anyOf 1)	string	Alternative	The last 4 digits of the account number of the sender of the funding. Maximum length: 5000
account_number_last4 (anyOf 2)	null	Alternative
sender_name	JSON	Optional
sender_name (anyOf 1)	string	Alternative	The full name of the sender, as supplied by the sending bank. Maximum length: 5000
sender_name (anyOf 2)	null	Alternative
sort_code	JSON	Optional
sort_code (anyOf 1)	string	Alternative	The sort code of the bank of the sender of the funding Maximum length: 5000
sort_code (anyOf 2)	null	Alternative

Fund a test mode cash balance — response body — funded bank transfer jp bank transfer

Field	Type	Presence	Description and constraints
$	object	Root
sender_bank	JSON	Optional
sender_bank (anyOf 1)	string	Alternative	The name of the bank of the sender of the funding. Maximum length: 5000
sender_bank (anyOf 2)	null	Alternative
sender_branch	JSON	Optional
sender_branch (anyOf 1)	string	Alternative	The name of the bank branch of the sender of the funding. Maximum length: 5000
sender_branch (anyOf 2)	null	Alternative
sender_name	JSON	Optional
sender_name (anyOf 1)	string	Alternative	The full name of the sender, as supplied by the sending bank. Maximum length: 5000
sender_name (anyOf 2)	null	Alternative

Fund a test mode cash balance — response body — funded bank transfer us bank transfer

Field	Type	Presence	Description and constraints
$	object	Root
network	string	Optional	The banking network used for this funding. Known values: ach, domestic_wire_us, swift
sender_name	JSON	Optional
sender_name (anyOf 1)	string	Alternative	The full name of the sender, as supplied by the sending bank. Maximum length: 5000
sender_name (anyOf 2)	null	Alternative

Fund a test mode cash balance — response body — refunded from payment

Field	Type	Presence	Description and constraints
$	object	Root
refund	JSON	Required within parent	The [Refund](https://docs.stripe.com/api/refunds/object) that moved these funds into the customer's cash balance.
refund (anyOf 1)	string	Alternative	Maximum length: 5000
refund (anyOf 2)	Model	Alternative	Expand Cancel a refund — response body

Referenced models: Cancel a refund — response body

Fund a test mode cash balance — response body — transferred to balance

Field	Type	Presence	Description and constraints
$	object	Root
balance_transaction	JSON	Required within parent	The [Balance Transaction](https://docs.stripe.com/api/balance_transactions/object) that corresponds to funds transferred to your Stripe balance.
balance_transaction (anyOf 1)	string	Alternative	Maximum length: 5000
balance_transaction (anyOf 2)	Model	Alternative	Expand Retrieve a balance transaction — balance get Balance History Id — response body

Referenced models: Retrieve a balance transaction — balance get Balance History Id — response body

Fund a test mode cash balance — response body — unapplied from payment

Field	Type	Presence	Description and constraints
$	object	Root
payment_intent	JSON	Required within parent	The [Payment Intent](https://docs.stripe.com/api/payment_intents/object) that funds were unapplied from.
payment_intent (anyOf 1)	string	Alternative	Maximum length: 5000
payment_intent (anyOf 2)	Model	Alternative	Expand Cancel a Payment Intent — response body

Referenced models: Cancel a Payment Intent — response body

Test mode: Update an Outbound Payment — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
expand	array	Optional	Specifies which fields in the response should be expanded.
expand[]	string	Each item	Maximum length: 5000
tracking_details	object	Required within parent	Details about network-specific tracking information.
tracking_details.ach	object	Optional
tracking_details.ach.trace_id	string	Required within parent	Maximum length: 5000
tracking_details.type	string	Required within parent	One of: ach, us_domestic_wire
tracking_details.us_domestic_wire	object	Optional
tracking_details.us_domestic_wire.chips	string	Optional	Maximum length: 5000
tracking_details.us_domestic_wire.imad	string	Optional	Maximum length: 5000
tracking_details.us_domestic_wire.omad	string	Optional	Maximum length: 5000