POST /v1/test_helpers/issuing/transactions/create_force_capture

Allows the user to capture an arbitrary amount, also known as a forced capture.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
merchant_data Object No

Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.

merchant_data.category String No

Possible values:

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

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.

expand[] Array No

Specifies which fields in the response should be expanded.

purchase_details Object No

Additional purchase information that is optionally provided by the merchant.

purchase_details.flight Object No
purchase_details.flight.travel_agency String No
purchase_details.flight.departure_at Integer No
purchase_details.flight.passenger_name String No
purchase_details.flight.segments[] Array No
purchase_details.flight.segments[].service_class String No
purchase_details.flight.segments[].flight_number String No
purchase_details.flight.segments[].stopover_allowed Boolean No
purchase_details.flight.segments[].arrival_airport_code String No
purchase_details.flight.segments[].departure_airport_code String No
purchase_details.flight.segments[].carrier String No
purchase_details.flight.refundable Boolean No
purchase_details.fuel Object No
purchase_details.fuel.industry_product_code String No
purchase_details.fuel.type String No

Possible values:

  • "unleaded_super"
  • "unleaded_regular"
  • "other"
  • "unleaded_plus"
  • "diesel"
purchase_details.fuel.unit_cost_decimal String No
purchase_details.fuel.quantity_decimal String No
purchase_details.fuel.unit String No

Possible values:

  • "us_gallon"
  • "other"
  • "charging_minute"
  • "imperial_gallon"
  • "kilogram"
  • "kilowatt_hour"
  • "liter"
  • "pound"
purchase_details.reference String No
purchase_details.fleet Object No
purchase_details.fleet.purchase_type String No

Possible values:

  • "fuel_purchase"
  • "non_fuel_purchase"
  • "fuel_and_non_fuel_purchase"
purchase_details.fleet.cardholder_prompt_data Object No
purchase_details.fleet.cardholder_prompt_data.unspecified_id String No
purchase_details.fleet.cardholder_prompt_data.driver_id String No
purchase_details.fleet.cardholder_prompt_data.vehicle_number String No
purchase_details.fleet.cardholder_prompt_data.user_id String No
purchase_details.fleet.cardholder_prompt_data.odometer Integer No
purchase_details.fleet.reported_breakdown Object No
purchase_details.fleet.reported_breakdown.tax Object No
purchase_details.fleet.reported_breakdown.tax.local_amount_decimal String No
purchase_details.fleet.reported_breakdown.tax.national_amount_decimal String No
purchase_details.fleet.reported_breakdown.non_fuel Object No
purchase_details.fleet.reported_breakdown.non_fuel.gross_amount_decimal String No
purchase_details.fleet.reported_breakdown.fuel Object No
purchase_details.fleet.reported_breakdown.fuel.gross_amount_decimal String No
purchase_details.fleet.service_type String No

Possible values:

  • "full_service"
  • "self_service"
  • "non_fuel_transaction"
purchase_details.lodging Object No
purchase_details.lodging.check_in_at Integer No
purchase_details.lodging.nights Integer No
purchase_details.receipt[] Array No
purchase_details.receipt[].description String No
purchase_details.receipt[].quantity String No
purchase_details.receipt[].unit_cost Integer No
purchase_details.receipt[].total Integer No
card String Yes

Card associated with this transaction.

currency String No

The currency of the capture. If not provided, defaults to the currency of the card. Three-letter ISO currency code, in lowercase. Must be a supported currency.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.