View Source Stripe.Issuing.Card (stripity_stripe v3.1.1)

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.

retrieve(card, params \\ %{}, opts \\ [])

Retrieves an Issuing Card object.

return_card(card, params \\ %{}, opts \\ [])

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

ship_card(card, params \\ %{}, opts \\ [])

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

update(card, params \\ %{}, opts \\ [])

Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Link to this section Types

address()

@type address() :: %{
  optional(:city) => binary(),
  optional(:country) => binary(),
  optional(:line1) => binary(),
  optional(:line2) => binary(),
  optional(:postal_code) => binary(),
  optional(:state) => binary()
}

The address that the card is shipped to.

created()

@type created() :: %{
  optional(:gt) => integer(),
  optional(:gte) => integer(),
  optional(:lt) => integer(),
  optional(:lte) => integer()
}

customs()

@type customs() :: %{optional(:eori_number) => binary()}

Customs information for the shipment.

pin()

@type pin() :: %{optional(:encrypted_number) => binary()}

The desired new PIN for this card.

shipping()

@type shipping() :: %{
  optional(:address) => address(),
  optional(:customs) => customs(),
  optional(:name) => binary(),
  optional(:phone_number) => binary(),
  optional(:require_signature) => boolean(),
  optional(:service) => :express | :priority | :standard,
  optional(:type) => :bulk | :individual
}

The address where the card will be shipped.

spending_controls()

@type spending_controls() :: %{
  optional(:allowed_categories) => [
    :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
  ],
  optional(:blocked_categories) => [
    :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
  ],
  optional(:spending_limits) => [spending_limits()]
}

Rules that control spending for this card. Refer to our documentation for more details.

spending_limits()

@type spending_limits() :: %{
  optional(:amount) => integer(),
  optional(:categories) => [
    :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
  ],
  optional(:interval) =>
    :all_time | :daily | :monthly | :per_authorization | :weekly | :yearly
}

t()

@type t() :: %Stripe.Issuing.Card{
  brand: binary(),
  cancellation_reason: binary() | nil,
  cardholder: Stripe.Issuing.Cardholder.t(),
  created: integer(),
  currency: binary(),
  cvc: binary(),
  exp_month: integer(),
  exp_year: integer(),
  financial_account: binary() | nil,
  id: binary(),
  last4: binary(),
  livemode: boolean(),
  metadata: term(),
  number: binary(),
  object: binary(),
  replaced_by: (binary() | t()) | nil,
  replacement_for: (binary() | t()) | nil,
  replacement_reason: binary() | nil,
  shipping: term() | nil,
  spending_controls: term(),
  status: binary(),
  type: binary(),
  wallets: term() | nil
}

The issuing.card type.

brand The brand of the card.
cancellation_reason The reason why the card was canceled.
cardholder
created Time at which the object was created. Measured in seconds since the Unix epoch.
currency Three-letter ISO currency code, in lowercase. Supported currencies are usd in the US, eur in the EU, and gbp in the UK.
cvc 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. Additionally, it's only available via the "Retrieve a card" endpoint, not via "List all cards" or any other endpoint.
exp_month The expiration month of the card.
exp_year The expiration year of the card.
financial_account The financial account this card is attached to.
id Unique identifier for the object.
last4 The last 4 digits of the card number.
livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
metadata 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.
number 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. Additionally, it's only available via the "Retrieve a card" endpoint, not via "List all cards" or any other endpoint.
object String representing the object's type. Objects of the same type share the same value.
replaced_by The latest card that replaces this card, if any.
replacement_for The card this card replaces, if any.
replacement_reason The reason why the previous card needed to be replaced.
shipping Where and how the card will be shipped.
spending_controls
status Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to inactive.
type The type of the card.
wallets Information relating to digital wallets (like Apple Pay and Google Pay).

Link to this section Functions

create(params \\ %{}, opts \\ [])

@spec create(
  params :: %{
    optional(:cardholder) => binary(),
    optional(:currency) => binary(),
    optional(:expand) => [binary()],
    optional(:financial_account) => binary(),
    optional(:metadata) => %{optional(binary()) => binary()},
    optional(:replacement_for) => binary(),
    optional(:replacement_reason) => :damaged | :expired | :lost | :stolen,
    optional(:shipping) => shipping(),
    optional(:spending_controls) => spending_controls(),
    optional(:status) => :active | :inactive,
    optional(:type) => :physical | :virtual
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Creates an Issuing Card object.

Details

Method: post
Path: /v1/issuing/cards

deliver_card(card, params \\ %{}, opts \\ [])

@spec deliver_card(
  card :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

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

Details

Method: post
Path: /v1/test_helpers/issuing/cards/{card}/shipping/deliver

fail_card(card, params \\ %{}, opts \\ [])

@spec fail_card(
  card :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

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

Details

Method: post
Path: /v1/test_helpers/issuing/cards/{card}/shipping/fail

list(params \\ %{}, opts \\ [])

@spec list(
  params :: %{
    optional(:cardholder) => binary(),
    optional(:created) => created() | integer(),
    optional(:ending_before) => binary(),
    optional(:exp_month) => integer(),
    optional(:exp_year) => integer(),
    optional(:expand) => [binary()],
    optional(:last4) => binary(),
    optional(:limit) => integer(),
    optional(:starting_after) => binary(),
    optional(:status) => :active | :canceled | :inactive,
    optional(:type) => :physical | :virtual
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

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.

Details

Method: get
Path: /v1/issuing/cards

retrieve(card, params \\ %{}, opts \\ [])

@spec retrieve(
  card :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieves an Issuing Card object.

Details

Method: get
Path: /v1/issuing/cards/{card}

return_card(card, params \\ %{}, opts \\ [])

@spec return_card(
  card :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

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

Details

Method: post
Path: /v1/test_helpers/issuing/cards/{card}/shipping/return

ship_card(card, params \\ %{}, opts \\ [])

@spec ship_card(
  card :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

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

Details

Method: post
Path: /v1/test_helpers/issuing/cards/{card}/shipping/ship

update(card, params \\ %{}, opts \\ [])

@spec update(
  card :: binary(),
  params :: %{
    optional(:cancellation_reason) => :lost | :stolen,
    optional(:expand) => [binary()],
    optional(:metadata) => %{optional(binary()) => binary()} | binary(),
    optional(:pin) => pin(),
    optional(:spending_controls) => spending_controls(),
    optional(:status) => :active | :canceled | :inactive
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Details

Method: post
Path: /v1/issuing/cards/{card}

Settings View Source Stripe.Issuing.Card (stripity_stripe v3.1.1)

Link to this section Summary

Types

Functions

Link to this section Types

address()

created()

customs()

pin()

shipping()

spending_controls()

spending_limits()

t()

Link to this section Functions

create(params \\ %{}, opts \\ [])

Details

deliver_card(card, params \\ %{}, opts \\ [])

Details

fail_card(card, params \\ %{}, opts \\ [])

Details

list(params \\ %{}, opts \\ [])

Details

retrieve(card, params \\ %{}, opts \\ [])

Details

return_card(card, params \\ %{}, opts \\ [])

Details

ship_card(card, params \\ %{}, opts \\ [])

Details

update(card, params \\ %{}, opts \\ [])

Details

View Source Stripe.Issuing.Card (stripity_stripe v3.1.1)