Stripe: Create a test-mode authorization
Stripe testHelpers.postTestHelpersIssuingAuthorizations: arguments, response, policy and SDK examples.
← Test helpers operations · Get started
Operation stripe.posttesthelpersissuingauthorizations
Provider route: POST /v1/test_helpers/issuing/authorizations. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { StripeIntegration } from "@alter-ai/stripe";
async function execute(input: Parameters<StripeIntegration["testHelpers"]["postTestHelpersIssuingAuthorizations"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.testHelpers.postTestHelpersIssuingAuthorizations(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_stripe import StripeIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.test_helpers.post_test_helpers_issuing_authorizations(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
headers | object | Optional | Additional keys: not allowed |
headers.Idempotency-Key | string | Optional | Minimum length: 1 Maximum length: 255 |
body | object | Required within parent | Additional keys: not allowed |
body.amount | integer | Optional | The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the card’s currency, and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). |
body.amount_details | object | Optional | Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). |
body.amount_details.atm_fee | integer | Optional | |
body.amount_details.cashback_amount | integer | Optional | |
body.authorization_method | string | Optional | How the card details were provided. Defaults to online. One of: chip, contactless, keyed_in, online, swipe |
body.card | string | Required within parent | Card associated with this authorization. Maximum length: 5000 |
body.currency | string | Optional | The currency of the authorization. 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). Format: currency |
body.expand | array | Optional | Specifies which fields in the response should be expanded. |
body.expand[] | string | Each item | Maximum length: 5000 |
body.fleet | Model | Optional | Expand Create a test-mode authorization — request body — body fleet |
body.fraud_disputability_likelihood | string | Optional | Probability that this transaction can be disputed in the event of fraud. Assessed by comparing the characteristics of the authorization to card network rules. One of: neutral, unknown, very_likely, very_unlikely |
body.fuel | Model | Optional | Expand Create a test-mode authorization — request body — body fuel |
body.is_amount_controllable | boolean | Optional | If set `true`, you may provide [amount](https://docs.stripe.com/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. |
body.merchant_amount | integer | Optional | The total amount to attempt to authorize. This amount is in the provided merchant currency, and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). |
body.merchant_currency | string | Optional | The currency of the authorization. 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). Format: currency |
body.merchant_data | Model | Optional | Expand Create a test-mode authorization — request body — body merchant data |
body.network_data | object | Optional | Details about the authorization, such as identifiers, set by the card network. |
body.network_data.acquiring_institution_id | string | Optional | Maximum length: 5000 |
body.risk_assessment | object | Optional | Stripe’s assessment of the fraud risk for this authorization. |
body.risk_assessment.card_testing_risk | object | Optional | |
body.risk_assessment.card_testing_risk.invalid_account_number_decline_rate_past_hour | integer | Optional | |
body.risk_assessment.card_testing_risk.invalid_credentials_decline_rate_past_hour | integer | Optional | |
body.risk_assessment.card_testing_risk.level | string | Required within parent | One of: elevated, highest, low, normal, not_assessed, unknown |
body.risk_assessment.fraud_risk | object | Optional | |
body.risk_assessment.fraud_risk.level | string | Required within parent | One of: elevated, highest, low, normal, not_assessed, unknown |
body.risk_assessment.fraud_risk.score | number | Optional | |
body.risk_assessment.merchant_dispute_risk | object | Optional | |
body.risk_assessment.merchant_dispute_risk.dispute_rate | integer | Optional | |
body.risk_assessment.merchant_dispute_risk.level | string | Required within parent | One of: elevated, highest, low, normal, not_assessed, unknown |
body.verification_data | object | Optional | Verifications that Stripe performed on information that the cardholder provided to the merchant. |
body.verification_data.address_line1_check | string | Optional | One of: match, mismatch, not_provided |
body.verification_data.address_postal_code_check | string | Optional | One of: match, mismatch, not_provided |
body.verification_data.authentication_exemption | object | Optional | |
body.verification_data.authentication_exemption.claimed_by | string | Required within parent | One of: acquirer, issuer |
body.verification_data.authentication_exemption.type | string | Required within parent | One of: low_value_transaction, transaction_risk_analysis, unknown |
body.verification_data.cvc_check | string | Optional | One of: match, mismatch, not_provided |
body.verification_data.expiry_check | string | Optional | One of: match, mismatch, not_provided |
body.verification_data.three_d_secure | object | Optional | |
body.verification_data.three_d_secure.result | string | Required within parent | One of: attempt_acknowledged, authenticated, failed, required |
body.wallet | string | Optional | The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized. One of: apple_pay, google_pay, samsung_pay |
Referenced models: Create a test-mode authorization — request body — body fleet, Create a test-mode authorization — request body — body fuel, Create a test-mode authorization — request body — body merchant data
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Update an authorization — response body |
Referenced models: Update an authorization — response body
Schemas
Section titled “Schemas”707 more schemas are linked from the tables above, on the schema pages.
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 |
Update a transaction — response body — amount details value atm fee, cashback amount
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
atm_fee | JSON | Optional | |
atm_fee (anyOf 1) | JSON | Alternative | |
atm_fee (anyOf 1) (anyOf 1) | integer | Alternative | The fee charged by the ATM for the cash withdrawal. |
atm_fee (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
atm_fee (anyOf 2) | null | Alternative | |
cashback_amount | JSON | Optional | |
cashback_amount (anyOf 1) | JSON | Alternative | |
cashback_amount (anyOf 1) (anyOf 1) | integer | Alternative | The amount of cash requested by the cardholder. |
cashback_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
cashback_amount (anyOf 2) | null | Alternative |
Update an authorization — response body — fraud challenges array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
channel | string | Required within parent | The method by which the fraud challenge was delivered to the cardholder. Known values: sms |
status | string | Required within parent | The status of the fraud challenge. Known values: expired, pending, rejected, undeliverable, verified |
undeliverable_reason | JSON | Optional | |
undeliverable_reason (anyOf 1) | string | Alternative | If the challenge is not deliverable, the reason why. Known values: no_phone_number, unsupported_phone_number |
undeliverable_reason (anyOf 2) | null | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: stripe.posttesthelpersissuingauthorizations. Catalog operation: PostTestHelpersIssuingAuthorizations. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Pinned headers: {"Stripe-Version": "2026-09-30.endive"}