# -*- coding: utf-8 -*- # File generated from our OpenAPI spec from stripe import util from stripe.api_resources.abstract import ( APIResourceTestHelpers, ListableAPIResource, UpdateableAPIResource, ) from stripe.api_resources.expandable_field import ExpandableField from stripe.api_resources.list_object import ListObject from stripe.request_options import RequestOptions from stripe.stripe_object import StripeObject from stripe.util import class_method_variant from typing import ClassVar, Dict, List, Optional, cast, overload from typing_extensions import ( Literal, NotRequired, Type, TypedDict, Unpack, TYPE_CHECKING, ) from urllib.parse import quote_plus if TYPE_CHECKING: from stripe.api_resources.balance_transaction import BalanceTransaction from stripe.api_resources.issuing.authorization import Authorization from stripe.api_resources.issuing.card import Card from stripe.api_resources.issuing.cardholder import Cardholder from stripe.api_resources.issuing.dispute import Dispute from stripe.api_resources.issuing.token import Token class Transaction( ListableAPIResource["Transaction"], UpdateableAPIResource["Transaction"], ): """ Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving your Stripe account, such as a completed purchase or refund, is represented by an Issuing `Transaction` object. Related guide: [Issued card transactions](https://stripe.com/docs/issuing/purchases/transactions) """ OBJECT_NAME: ClassVar[ Literal["issuing.transaction"] ] = "issuing.transaction" class AmountDetails(StripeObject): atm_fee: Optional[int] """ The fee charged by the ATM for the cash withdrawal. """ cashback_amount: Optional[int] """ The amount of cash requested by the cardholder. """ class MerchantData(StripeObject): category: str """ A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values. """ category_code: str """ The merchant category code for the seller's business """ city: Optional[str] """ City where the seller is located """ country: Optional[str] """ Country where the seller is located """ name: Optional[str] """ Name of the seller """ network_id: str """ Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant. """ postal_code: Optional[str] """ Postal code where the seller is located """ state: Optional[str] """ State where the seller is located """ terminal_id: Optional[str] """ An ID assigned by the seller to the location of the sale. """ url: Optional[str] """ URL provided by the merchant on a 3DS request """ class NetworkData(StripeObject): authorization_code: Optional[str] """ A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter "S", followed by a six-digit number. For example, "S498162". Please note that the code is not guaranteed to be unique across authorizations. """ processing_date: Optional[str] """ The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network. """ transaction_id: Optional[str] """ Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions. """ class PurchaseDetails(StripeObject): class Flight(StripeObject): class Segment(StripeObject): arrival_airport_code: Optional[str] """ The three-letter IATA airport code of the flight's destination. """ carrier: Optional[str] """ The airline carrier code. """ departure_airport_code: Optional[str] """ The three-letter IATA airport code that the flight departed from. """ flight_number: Optional[str] """ The flight number. """ service_class: Optional[str] """ The flight's service class. """ stopover_allowed: Optional[bool] """ Whether a stopover is allowed on this flight. """ departure_at: Optional[int] """ The time that the flight departed. """ passenger_name: Optional[str] """ The name of the passenger. """ refundable: Optional[bool] """ Whether the ticket is refundable. """ segments: Optional[List[Segment]] """ The legs of the trip. """ travel_agency: Optional[str] """ The travel agency that issued the ticket. """ _inner_class_types = {"segments": Segment} class Fuel(StripeObject): type: str """ The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`. """ unit: str """ The units for `volume_decimal`. One of `us_gallon` or `liter`. """ unit_cost_decimal: str """ The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. """ volume_decimal: Optional[str] """ The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places. """ class Lodging(StripeObject): check_in_at: Optional[int] """ The time of checking into the lodging. """ nights: Optional[int] """ The number of nights stayed at the lodging. """ class Receipt(StripeObject): description: Optional[str] """ The description of the item. The maximum length of this field is 26 characters. """ quantity: Optional[float] """ The quantity of the item. """ total: Optional[int] """ The total for this line item in cents. """ unit_cost: Optional[int] """ The unit cost of the item in cents. """ flight: Optional[Flight] """ Information about the flight that was purchased with this transaction. """ fuel: Optional[Fuel] """ Information about fuel that was purchased with this transaction. """ lodging: Optional[Lodging] """ Information about lodging that was purchased with this transaction. """ receipt: Optional[List[Receipt]] """ The line items in the purchase. """ reference: Optional[str] """ A merchant-specific order number. """ _inner_class_types = { "flight": Flight, "fuel": Fuel, "lodging": Lodging, "receipt": Receipt, } class Treasury(StripeObject): received_credit: Optional[str] """ The Treasury [ReceivedCredit](https://stripe.com/docs/api/treasury/received_credits) representing this Issuing transaction if it is a refund """ received_debit: Optional[str] """ The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) representing this Issuing transaction if it is a capture """ class ListParams(RequestOptions): card: NotRequired["str"] """ Only return transactions that belong to the given card. """ cardholder: NotRequired["str"] """ Only return transactions that belong to the given cardholder. """ created: NotRequired["Transaction.ListParamsCreated|int"] """ Only return transactions that were created during the given date interval. """ ending_before: NotRequired["str"] """ A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. """ expand: NotRequired["List[str]"] """ Specifies which fields in the response should be expanded. """ limit: NotRequired["int"] """ A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. """ starting_after: NotRequired["str"] """ A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. """ type: NotRequired["Literal['capture', 'refund']"] """ Only return transactions that have the given type. One of `capture` or `refund`. """ class ListParamsCreated(TypedDict): gt: NotRequired["int"] """ Minimum value to filter by (exclusive) """ gte: NotRequired["int"] """ Minimum value to filter by (inclusive) """ lt: NotRequired["int"] """ Maximum value to filter by (exclusive) """ lte: NotRequired["int"] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): expand: NotRequired["List[str]"] """ Specifies which fields in the response should be expanded. """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ class RetrieveParams(RequestOptions): expand: NotRequired["List[str]"] """ Specifies which fields in the response should be expanded. """ class CreateForceCaptureParams(RequestOptions): amount: int """ The total amount to attempt to capture. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ card: str """ Card associated with this transaction. """ currency: NotRequired["str"] """ The currency of the capture. If not provided, defaults to the currency of the card. 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). """ expand: NotRequired["List[str]"] """ Specifies which fields in the response should be expanded. """ merchant_data: NotRequired[ "Transaction.CreateForceCaptureParamsMerchantData" ] """ Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened. """ purchase_details: NotRequired[ "Transaction.CreateForceCaptureParamsPurchaseDetails" ] """ Additional purchase information that is optionally provided by the merchant. """ class CreateForceCaptureParamsPurchaseDetails(TypedDict): flight: NotRequired[ "Transaction.CreateForceCaptureParamsPurchaseDetailsFlight" ] """ Information about the flight that was purchased with this transaction. """ fuel: NotRequired[ "Transaction.CreateForceCaptureParamsPurchaseDetailsFuel" ] """ Information about fuel that was purchased with this transaction. """ lodging: NotRequired[ "Transaction.CreateForceCaptureParamsPurchaseDetailsLodging" ] """ Information about lodging that was purchased with this transaction. """ receipt: NotRequired[ "List[Transaction.CreateForceCaptureParamsPurchaseDetailsReceipt]" ] """ The line items in the purchase. """ reference: NotRequired["str"] """ A merchant-specific order number. """ class CreateForceCaptureParamsPurchaseDetailsReceipt(TypedDict): description: NotRequired["str"] quantity: NotRequired["str"] total: NotRequired["int"] unit_cost: NotRequired["int"] class CreateForceCaptureParamsPurchaseDetailsLodging(TypedDict): check_in_at: NotRequired["int"] """ The time of checking into the lodging. """ nights: NotRequired["int"] """ The number of nights stayed at the lodging. """ class CreateForceCaptureParamsPurchaseDetailsFuel(TypedDict): type: NotRequired[ "Literal['diesel', 'other', 'unleaded_plus', 'unleaded_regular', 'unleaded_super']" ] """ The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`. """ unit: NotRequired["Literal['liter', 'us_gallon']"] """ The units for `volume_decimal`. One of `us_gallon` or `liter`. """ unit_cost_decimal: NotRequired["str"] """ The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. """ volume_decimal: NotRequired["str"] """ The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places. """ class CreateForceCaptureParamsPurchaseDetailsFlight(TypedDict): departure_at: NotRequired["int"] """ The time that the flight departed. """ passenger_name: NotRequired["str"] """ The name of the passenger. """ refundable: NotRequired["bool"] """ Whether the ticket is refundable. """ segments: NotRequired[ "List[Transaction.CreateForceCaptureParamsPurchaseDetailsFlightSegment]" ] """ The legs of the trip. """ travel_agency: NotRequired["str"] """ The travel agency that issued the ticket. """ class CreateForceCaptureParamsPurchaseDetailsFlightSegment(TypedDict): arrival_airport_code: NotRequired["str"] """ The three-letter IATA airport code of the flight's destination. """ carrier: NotRequired["str"] """ The airline carrier code. """ departure_airport_code: NotRequired["str"] """ The three-letter IATA airport code that the flight departed from. """ flight_number: NotRequired["str"] """ The flight number. """ service_class: NotRequired["str"] """ The flight's service class. """ stopover_allowed: NotRequired["bool"] """ Whether a stopover is allowed on this flight. """ class CreateForceCaptureParamsMerchantData(TypedDict): category: NotRequired[ "Literal['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']" ] """ A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values. """ city: NotRequired["str"] """ City where the seller is located """ country: NotRequired["str"] """ Country where the seller is located """ name: NotRequired["str"] """ Name of the seller """ network_id: NotRequired["str"] """ Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant. """ postal_code: NotRequired["str"] """ Postal code where the seller is located """ state: NotRequired["str"] """ State where the seller is located """ terminal_id: NotRequired["str"] """ An ID assigned by the seller to the location of the sale. """ url: NotRequired["str"] """ URL provided by the merchant on a 3DS request """ class CreateUnlinkedRefundParams(RequestOptions): amount: int """ The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ card: str """ Card associated with this unlinked refund transaction. """ currency: NotRequired["str"] """ The currency of the unlinked refund. If not provided, defaults to the currency of the card. 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). """ expand: NotRequired["List[str]"] """ Specifies which fields in the response should be expanded. """ merchant_data: NotRequired[ "Transaction.CreateUnlinkedRefundParamsMerchantData" ] """ Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened. """ purchase_details: NotRequired[ "Transaction.CreateUnlinkedRefundParamsPurchaseDetails" ] """ Additional purchase information that is optionally provided by the merchant. """ class CreateUnlinkedRefundParamsPurchaseDetails(TypedDict): flight: NotRequired[ "Transaction.CreateUnlinkedRefundParamsPurchaseDetailsFlight" ] """ Information about the flight that was purchased with this transaction. """ fuel: NotRequired[ "Transaction.CreateUnlinkedRefundParamsPurchaseDetailsFuel" ] """ Information about fuel that was purchased with this transaction. """ lodging: NotRequired[ "Transaction.CreateUnlinkedRefundParamsPurchaseDetailsLodging" ] """ Information about lodging that was purchased with this transaction. """ receipt: NotRequired[ "List[Transaction.CreateUnlinkedRefundParamsPurchaseDetailsReceipt]" ] """ The line items in the purchase. """ reference: NotRequired["str"] """ A merchant-specific order number. """ class CreateUnlinkedRefundParamsPurchaseDetailsReceipt(TypedDict): description: NotRequired["str"] quantity: NotRequired["str"] total: NotRequired["int"] unit_cost: NotRequired["int"] class CreateUnlinkedRefundParamsPurchaseDetailsLodging(TypedDict): check_in_at: NotRequired["int"] """ The time of checking into the lodging. """ nights: NotRequired["int"] """ The number of nights stayed at the lodging. """ class CreateUnlinkedRefundParamsPurchaseDetailsFuel(TypedDict): type: NotRequired[ "Literal['diesel', 'other', 'unleaded_plus', 'unleaded_regular', 'unleaded_super']" ] """ The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`. """ unit: NotRequired["Literal['liter', 'us_gallon']"] """ The units for `volume_decimal`. One of `us_gallon` or `liter`. """ unit_cost_decimal: NotRequired["str"] """ The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. """ volume_decimal: NotRequired["str"] """ The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places. """ class CreateUnlinkedRefundParamsPurchaseDetailsFlight(TypedDict): departure_at: NotRequired["int"] """ The time that the flight departed. """ passenger_name: NotRequired["str"] """ The name of the passenger. """ refundable: NotRequired["bool"] """ Whether the ticket is refundable. """ segments: NotRequired[ "List[Transaction.CreateUnlinkedRefundParamsPurchaseDetailsFlightSegment]" ] """ The legs of the trip. """ travel_agency: NotRequired["str"] """ The travel agency that issued the ticket. """ class CreateUnlinkedRefundParamsPurchaseDetailsFlightSegment(TypedDict): arrival_airport_code: NotRequired["str"] """ The three-letter IATA airport code of the flight's destination. """ carrier: NotRequired["str"] """ The airline carrier code. """ departure_airport_code: NotRequired["str"] """ The three-letter IATA airport code that the flight departed from. """ flight_number: NotRequired["str"] """ The flight number. """ service_class: NotRequired["str"] """ The flight's service class. """ stopover_allowed: NotRequired["bool"] """ Whether a stopover is allowed on this flight. """ class CreateUnlinkedRefundParamsMerchantData(TypedDict): category: NotRequired[ "Literal['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']" ] """ A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values. """ city: NotRequired["str"] """ City where the seller is located """ country: NotRequired["str"] """ Country where the seller is located """ name: NotRequired["str"] """ Name of the seller """ network_id: NotRequired["str"] """ Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant. """ postal_code: NotRequired["str"] """ Postal code where the seller is located """ state: NotRequired["str"] """ State where the seller is located """ terminal_id: NotRequired["str"] """ An ID assigned by the seller to the location of the sale. """ url: NotRequired["str"] """ URL provided by the merchant on a 3DS request """ class RefundParams(RequestOptions): expand: NotRequired["List[str]"] """ Specifies which fields in the response should be expanded. """ refund_amount: NotRequired["int"] """ The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ amount: int """ The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ amount_details: Optional[AmountDetails] """ Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). """ authorization: Optional[ExpandableField["Authorization"]] """ The `Authorization` object that led to this transaction. """ balance_transaction: Optional[ExpandableField["BalanceTransaction"]] """ ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction. """ card: ExpandableField["Card"] """ The card used to make this transaction. """ cardholder: Optional[ExpandableField["Cardholder"]] """ The cardholder to whom this transaction belongs. """ created: int """ Time at which the object was created. Measured in seconds since the Unix epoch. """ currency: str """ 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). """ dispute: Optional[ExpandableField["Dispute"]] """ If you've disputed the transaction, the ID of the dispute. """ id: str """ Unique identifier for the object. """ livemode: bool """ Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. """ merchant_amount: int """ The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency. """ merchant_currency: str """ The currency with which the merchant is taking payment. """ merchant_data: MerchantData metadata: Dict[str, str] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ network_data: Optional[NetworkData] """ Details about the transaction, such as processing dates, set by the card network. """ object: Literal["issuing.transaction"] """ String representing the object's type. Objects of the same type share the same value. """ purchase_details: Optional[PurchaseDetails] """ Additional purchase information that is optionally provided by the merchant. """ token: Optional[ExpandableField["Token"]] """ [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null. """ treasury: Optional[Treasury] """ [Treasury](https://stripe.com/docs/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts """ type: Literal["capture", "refund"] """ The nature of the transaction. """ wallet: Optional[Literal["apple_pay", "google_pay", "samsung_pay"]] """ The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. """ @classmethod def list( cls, api_key: Optional[str] = None, stripe_version: Optional[str] = None, stripe_account: Optional[str] = None, **params: Unpack[ "Transaction.ListParams" ] # pyright: ignore[reportGeneralTypeIssues] ) -> ListObject["Transaction"]: """ Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first. """ result = cls._static_request( "get", cls.class_url(), api_key=api_key, stripe_version=stripe_version, stripe_account=stripe_account, params=params, ) if not isinstance(result, ListObject): raise TypeError( "Expected list object from API, got %s" % (type(result).__name__) ) return result @classmethod def modify( cls, id: str, **params: Unpack["Transaction.ModifyParams"] ) -> "Transaction": """ Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. """ url = "%s/%s" % (cls.class_url(), quote_plus(id)) return cast( "Transaction", cls._static_request("post", url, params=params), ) @classmethod def retrieve( cls, id: str, **params: Unpack["Transaction.RetrieveParams"] ) -> "Transaction": """ Retrieves an Issuing Transaction object. """ instance = cls(id, **params) instance.refresh() return instance class TestHelpers(APIResourceTestHelpers["Transaction"]): _resource_cls: Type["Transaction"] @classmethod def create_force_capture( cls, api_key: Optional[str] = None, stripe_version: Optional[str] = None, stripe_account: Optional[str] = None, **params: Unpack[ "Transaction.CreateForceCaptureParams" ] # pyright: ignore[reportGeneralTypeIssues] ) -> "Transaction": """ Allows the user to capture an arbitrary amount, also known as a forced capture. """ return cast( "Transaction", cls._static_request( "post", "/v1/test_helpers/issuing/transactions/create_force_capture", api_key=api_key, stripe_version=stripe_version, stripe_account=stripe_account, params=params, ), ) @classmethod def create_unlinked_refund( cls, api_key: Optional[str] = None, stripe_version: Optional[str] = None, stripe_account: Optional[str] = None, **params: Unpack[ "Transaction.CreateUnlinkedRefundParams" ] # pyright: ignore[reportGeneralTypeIssues] ) -> "Transaction": """ Allows the user to refund an arbitrary amount, also known as a unlinked refund. """ return cast( "Transaction", cls._static_request( "post", "/v1/test_helpers/issuing/transactions/create_unlinked_refund", api_key=api_key, stripe_version=stripe_version, stripe_account=stripe_account, params=params, ), ) @classmethod def _cls_refund( cls, transaction: str, api_key: Optional[str] = None, stripe_version: Optional[str] = None, stripe_account: Optional[str] = None, **params: Unpack[ "Transaction.RefundParams" ] # pyright: ignore[reportGeneralTypeIssues] ) -> "Transaction": """ Refund a test-mode Transaction. """ return cast( "Transaction", cls._static_request( "post", "/v1/test_helpers/issuing/transactions/{transaction}/refund".format( transaction=util.sanitize_id(transaction) ), api_key=api_key, stripe_version=stripe_version, stripe_account=stripe_account, params=params, ), ) @overload @staticmethod def refund( transaction: str, api_key: Optional[str] = None, stripe_version: Optional[str] = None, stripe_account: Optional[str] = None, **params: Unpack[ "Transaction.RefundParams" ] # pyright: ignore[reportGeneralTypeIssues] ) -> "Transaction": """ Refund a test-mode Transaction. """ ... @overload def refund( self, idempotency_key: Optional[str] = None, **params: Unpack[ "Transaction.RefundParams" ] # pyright: ignore[reportGeneralTypeIssues] ) -> "Transaction": """ Refund a test-mode Transaction. """ ... @class_method_variant("_cls_refund") def refund( # pyright: ignore[reportGeneralTypeIssues] self, idempotency_key: Optional[str] = None, **params: Unpack[ "Transaction.RefundParams" ] # pyright: ignore[reportGeneralTypeIssues] ) -> "Transaction": """ Refund a test-mode Transaction. """ return cast( "Transaction", self.resource._request( "post", "/v1/test_helpers/issuing/transactions/{transaction}/refund".format( transaction=util.sanitize_id(self.resource.get("id")) ), idempotency_key=idempotency_key, params=params, ), ) @property def test_helpers(self): return self.TestHelpers(self) _inner_class_types = { "amount_details": AmountDetails, "merchant_data": MerchantData, "network_data": NetworkData, "purchase_details": PurchaseDetails, "treasury": Treasury, } Transaction.TestHelpers._resource_cls = Transaction